From 68dc0fe8c03d8c01bc66998a7e2920d21dee7fcb Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 22 Oct 2020 09:58:11 -0700 Subject: [PATCH] chore: update smithy models as of 10/16 (#1579) --- .../aws-models/acm-pca.2017-08-22.json | 797 +- .../aws-models/acm.2015-12-08.json | 384 +- .../alexa-for-business.2017-11-09.json | 2304 +- .../aws-models/amplify.2017-07-25.json | 1578 +- .../aws-models/api-gateway.2015-07-09.json | 4058 +-- .../apigatewaymanagementapi.2018-11-29.json | 26 +- .../aws-models/apigatewayv2.2018-11-29.json | 4777 +-- .../aws-models/appconfig.2019-10-09.json | 846 +- .../aws-models/appflow.2020-08-23.json | 6109 ++++ .../application-auto-scaling.2016-02-06.json | 720 +- ...lication-discovery-service.2015-11-01.json | 480 +- .../application-insights.2018-11-25.json | 826 +- .../aws-models/appstream.2016-12-01.json | 1436 +- .../aws-models/appsync.2017-07-25.json | 1202 +- .../aws-models/athena.2017-05-18.json | 844 +- .../auto-scaling-plans.2018-01-06.json | 414 +- .../aws-models/auto-scaling.2011-01-01.json | 2098 +- .../aws-models/backup.2018-11-15.json | 1709 +- .../aws-models/batch.2016-08-10.json | 1579 +- .../aws-models/budgets.2016-10-20.json | 2249 +- .../aws-models/chime.2018-05-01.json | 1652 +- .../aws-models/cloud9.2017-09-23.json | 309 +- .../aws-models/clouddirectory.2017-01-11.json | 2204 +- .../aws-models/cloudformation.2010-05-15.json | 2906 +- .../aws-models/cloudfront.2020-05-31.json | 3124 +- .../aws-models/cloudhsm-v2.2017-04-28.json | 294 +- .../aws-models/cloudhsm.2014-05-30.json | 262 +- .../cloudsearch-domain.2013-01-01.json | 156 +- .../aws-models/cloudsearch.2013-01-01.json | 518 +- .../aws-models/cloudtrail.2013-11-01.json | 588 +- .../cloudwatch-events.2015-10-07.json | 949 +- .../cloudwatch-logs.2014-03-28.json | 931 +- .../aws-models/cloudwatch.2010-08-01.json | 1386 +- .../aws-models/codeartifact.2018-09-22.json | 1474 +- .../aws-models/codebuild.2016-10-06.json | 2168 +- .../aws-models/codecommit.2015-04-13.json | 1882 +- .../aws-models/codedeploy.2014-10-06.json | 1558 +- .../codeguru-reviewer.2019-09-19.json | 668 +- .../aws-models/codepipeline.2015-07-09.json | 1134 +- .../codestar-connections.2019-12-01.json | 214 +- .../codestar-notifications.2019-10-15.json | 294 +- .../aws-models/codestar.2017-04-19.json | 448 +- .../cognito-identity-provider.2016-04-18.json | 3141 +- .../cognito-identity.2014-06-30.json | 440 +- .../aws-models/cognito-sync.2014-06-30.json | 248 +- .../aws-models/comprehend.2017-11-27.json | 2601 +- .../comprehendmedical.2018-10-30.json | 586 +- .../compute-optimizer.2019-11-01.json | 548 +- .../aws-models/config-service.2014-11-12.json | 2172 +- .../aws-models/connect.2017-08-08.json | 5684 ++-- .../connectparticipant.2018-09-07.json | 196 +- ...t-and-usage-report-service.2017-01-06.json | 147 +- .../aws-models/cost-explorer.2017-10-25.json | 2927 +- .../aws-models/data-pipeline.2012-10-29.json | 374 +- ...database-migration-service.2016-01-01.json | 2957 +- .../aws-models/dataexchange.2017-07-25.json | 1168 +- .../aws-models/datasync.2018-11-09.json | 1009 +- .../aws-models/dax.2017-04-19.json | 566 +- .../aws-models/detective.2018-10-26.json | 166 +- .../aws-models/device-farm.2015-06-23.json | 2320 +- .../aws-models/direct-connect.2012-10-25.json | 1092 +- .../directory-service.2015-04-16.json | 1604 +- .../aws-models/dlm.2018-01-12.json | 354 +- .../aws-models/docdb.2014-10-31.json | 1824 +- .../dynamodb-streams.2012-08-10.json | 234 +- .../aws-models/dynamodb.2012-08-10.json | 1711 +- .../aws-models/ebs.2019-11-02.json | 350 +- .../ec2-instance-connect.2018-04-02.json | 14 +- .../aws-models/ec2.2016-11-15.json | 27193 ++++++++-------- .../aws-models/ecr.2015-09-21.json | 958 +- .../aws-models/ecs.2014-11-13.json | 2922 +- .../aws-models/efs.2015-02-01.json | 534 +- .../aws-models/eks.2017-11-01.json | 955 +- .../elastic-beanstalk.2010-12-01.json | 1544 +- .../elastic-inference.2017-07-25.json | 54 +- .../elastic-load-balancing-v2.2015-12-01.json | 1240 +- .../elastic-load-balancing.2012-06-01.json | 542 +- .../elastic-transcoder.2012-09-25.json | 1254 +- .../aws-models/elasticache.2015-02-02.json | 3771 ++- .../elasticsearch-service.2015-01-01.json | 1325 +- .../aws-models/emr.2009-03-31.json | 2360 +- .../aws-models/eventbridge.2015-10-07.json | 949 +- .../aws-models/firehose.2015-08-04.json | 1538 +- .../aws-models/fms.2018-01-01.json | 544 +- .../aws-models/forecast.2018-06-26.json | 976 +- .../aws-models/forecastquery.2018-06-26.json | 45 +- .../aws-models/frauddetector.2019-11-15.json | 1438 +- .../aws-models/fsx.2018-03-01.json | 1109 +- .../aws-models/gamelift.2015-10-01.json | 2795 +- .../aws-models/glacier.2012-06-01.json | 920 +- .../global-accelerator.2018-08-08.json | 450 +- .../aws-models/glue.2017-03-31.json | 5520 ++-- .../aws-models/greengrass.2017-06-07.json | 2409 +- .../aws-models/guardduty.2017-11-28.json | 2107 +- .../aws-models/health.2016-08-04.json | 575 +- .../aws-models/honeycode.2020-03-01.json | 66 +- .../aws-models/iam.2010-05-08.json | 2928 +- .../aws-models/identitystore.2020-06-15.json | 669 + .../aws-models/imagebuilder.2019-12-02.json | 1980 +- .../aws-models/inspector.2016-02-16.json | 978 +- ...iot-1click-devices-service.2018-05-14.json | 228 +- .../iot-1click-projects.2018-05-14.json | 260 +- .../aws-models/iot-data-plane.2015-05-28.json | 28 +- .../iot-events-data.2018-10-23.json | 160 +- .../aws-models/iot-events.2018-07-27.json | 584 +- .../iot-jobs-data-plane.2017-09-29.json | 166 +- .../aws-models/iot.2015-05-28.json | 7071 ++-- .../aws-models/iotanalytics.2017-11-27.json | 916 +- .../iotsecuretunneling.2018-10-05.json | 182 +- .../aws-models/iotsitewise.2019-12-02.json | 2040 +- .../aws-models/iotthingsgraph.2018-09-06.json | 510 +- .../aws-models/ivs.2020-07-14.json | 651 +- .../aws-models/kafka.2018-11-14.json | 1662 +- .../aws-models/kendra.2019-02-03.json | 1409 +- .../kinesis-analytics-v2.2018-05-23.json | 1830 +- .../kinesis-analytics.2015-08-14.json | 766 +- ...nesis-video-archived-media.2017-09-30.json | 186 +- .../kinesis-video-media.2017-09-30.json | 44 +- .../kinesis-video-signaling.2019-12-04.json | 26 +- .../aws-models/kinesis-video.2017-09-30.json | 358 +- .../aws-models/kinesis.2013-12-02.json | 945 +- .../aws-models/kms.2014-11-01.json | 898 +- .../aws-models/lakeformation.2017-03-31.json | 259 +- .../aws-models/lambda.2015-03-31.json | 1888 +- ...lex-model-building-service.2017-04-19.json | 1939 +- .../lex-runtime-service.2016-11-28.json | 642 +- .../license-manager.2018-08-01.json | 492 +- .../aws-models/lightsail.2016-11-28.json | 3834 +-- .../machine-learning.2014-12-12.json | 1422 +- .../aws-models/macie.2017-12-19.json | 106 +- .../aws-models/macie2.2020-01-01.json | 2967 +- .../managedblockchain.2018-09-24.json | 595 +- .../marketplace-catalog.2018-09-17.json | 313 +- ...etplace-commerce-analytics.2015-07-01.json | 42 +- ...tplace-entitlement-service.2017-01-11.json | 32 +- .../marketplace-metering.2016-01-14.json | 52 +- .../aws-models/mediaconnect.2018-11-14.json | 1722 +- .../aws-models/mediaconvert.2017-08-29.json | 6592 ++-- .../aws-models/medialive.2017-10-14.json | 7872 +++-- .../mediapackage-vod.2018-11-07.json | 692 +- .../aws-models/mediapackage.2017-10-12.json | 1663 +- .../mediastore-data.2017-09-01.json | 85 +- .../aws-models/mediastore.2017-09-01.json | 142 +- .../aws-models/mediatailor.2018-04-23.json | 370 +- .../aws-models/migration-hub.2017-05-31.json | 302 +- .../migrationhub-config.2019-06-30.json | 62 +- .../aws-models/mobile.2017-07-01.json | 134 +- .../sdk-codegen/aws-models/mq.2017-11-27.json | 1484 +- .../aws-models/mturk.2017-01-17.json | 1128 +- .../aws-models/neptune.2014-10-31.json | 2694 +- .../aws-models/networkmanager.2019-07-05.json | 528 +- .../aws-models/opsworks.2013-02-18.json | 2602 +- .../aws-models/opsworkscm.2016-11-01.json | 582 +- .../aws-models/organizations.2016-11-28.json | 1019 +- .../aws-models/outposts.2019-12-03.json | 88 +- .../personalize-events.2018-03-22.json | 282 +- .../personalize-runtime.2018-05-22.json | 69 +- .../aws-models/personalize.2018-05-22.json | 1515 +- .../sdk-codegen/aws-models/pi.2018-02-27.json | 204 +- .../aws-models/pinpoint-email.2018-07-26.json | 818 +- .../pinpoint-sms-voice.2018-09-05.json | 164 +- .../aws-models/pinpoint.2016-12-01.json | 5125 +-- .../aws-models/polly.2016-06-10.json | 332 +- .../aws-models/pricing.2017-10-15.json | 92 +- .../aws-models/qldb-session.2019-07-11.json | 110 +- .../aws-models/qldb.2019-01-02.json | 422 +- .../aws-models/quicksight.2018-04-01.json | 4422 ++- .../aws-models/ram.2018-01-04.json | 802 +- .../aws-models/rds.2014-10-31.json | 6857 ++-- .../aws-models/redshift-data.2019-12-20.json | 1399 + .../aws-models/redshift.2012-12-01.json | 2977 +- .../aws-models/rekognition.2016-06-27.json | 2138 +- ...esource-groups-tagging-api.2017-01-26.json | 214 +- .../resource-groups.2017-11-27.json | 348 +- .../aws-models/robomaker.2018-06-29.json | 5681 ++-- .../route-53-domains.2014-05-15.json | 450 +- .../aws-models/route-53.2013-04-01.json | 1422 +- .../route53resolver.2018-04-01.json | 1956 +- .../aws-models/s3-control.2018-08-20.json | 1292 +- .../sdk-codegen/aws-models/s3.2006-03-01.json | 5655 ++-- .../aws-models/s3outposts.2017-07-25.json | 498 + .../sagemaker-a2i-runtime.2019-11-07.json | 102 +- .../sagemaker-runtime.2017-05-13.json | 110 +- .../aws-models/sagemaker.2017-07-24.json | 8564 ++--- .../aws-models/savingsplans.2019-06-28.json | 551 +- .../aws-models/schemas.2019-12-02.json | 827 +- .../secrets-manager.2017-10-17.json | 610 +- .../aws-models/securityhub.2018-10-26.json | 8427 ++++- ...rlessapplicationrepository.2017-09-08.json | 895 +- .../service-catalog.2015-12-10.json | 3071 +- .../aws-models/service-quotas.2019-06-24.json | 390 +- .../servicediscovery.2017-03-14.json | 728 +- .../aws-models/ses.2010-12-01.json | 1014 +- .../aws-models/sesv2.2019-09-27.json | 1281 +- .../aws-models/sfn.2016-11-23.json | 977 +- .../aws-models/shield.2016-06-02.json | 174 +- .../aws-models/signer.2017-08-25.json | 390 +- .../aws-models/sms.2016-10-24.json | 1866 +- .../aws-models/snowball.2016-06-30.json | 878 +- .../aws-models/sns.2010-03-31.json | 254 +- .../aws-models/sqs.2012-11-05.json | 428 +- .../aws-models/ssm.2014-11-06.json | 7090 ++-- .../aws-models/sso-admin.2020-07-20.json | 2839 ++ .../aws-models/sso-oidc.2019-06-10.json | 227 +- .../aws-models/sso.2019-06-10.json | 100 +- .../storage-gateway.2013-06-30.json | 2649 +- .../aws-models/sts.2011-06-15.json | 303 +- .../aws-models/support.2013-04-15.json | 414 +- .../aws-models/swf.2012-01-25.json | 2432 +- .../aws-models/synthetics.2017-10-11.json | 438 +- .../aws-models/textract.2018-06-27.json | 294 +- .../timestream-query.2018-11-01.json | 651 + .../timestream-write.2018-11-01.json | 1652 + .../transcribe-streaming.2017-10-26.json | 207 +- .../aws-models/transcribe.2017-10-26.json | 1642 +- .../aws-models/transfer.2018-11-05.json | 922 +- .../aws-models/translate.2017-07-01.json | 328 +- .../aws-models/waf-regional.2016-11-28.json | 1064 +- .../aws-models/waf.2015-08-24.json | 1052 +- .../aws-models/wafv2.2019-07-29.json | 1200 +- .../aws-models/workdocs.2016-05-01.json | 1666 +- .../aws-models/worklink.2018-09-25.json | 308 +- .../aws-models/workmail.2017-10-01.json | 2588 +- .../workmailmessageflow.2019-05-01.json | 2 +- .../aws-models/workspaces.2015-04-08.json | 1587 +- .../aws-models/xray.2016-04-12.json | 1366 +- 226 files changed, 196571 insertions(+), 145131 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/appflow.2020-08-23.json create mode 100644 codegen/sdk-codegen/aws-models/identitystore.2020-06-15.json create mode 100644 codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json create mode 100644 codegen/sdk-codegen/aws-models/s3outposts.2017-07-25.json create mode 100644 codegen/sdk-codegen/aws-models/sso-admin.2020-07-20.json create mode 100644 codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json create mode 100644 codegen/sdk-codegen/aws-models/timestream-write.2018-11-01.json diff --git a/codegen/sdk-codegen/aws-models/acm-pca.2017-08-22.json b/codegen/sdk-codegen/aws-models/acm-pca.2017-08-22.json index 49e16454851f..adbfe4d716ba 100644 --- a/codegen/sdk-codegen/aws-models/acm-pca.2017-08-22.json +++ b/codegen/sdk-codegen/aws-models/acm-pca.2017-08-22.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.acmpca#DeletePermission" }, + { + "target": "com.amazonaws.acmpca#DeletePolicy" + }, { "target": "com.amazonaws.acmpca#DescribeCertificateAuthority" }, @@ -63,6 +66,9 @@ { "target": "com.amazonaws.acmpca#GetCertificateAuthorityCsr" }, + { + "target": "com.amazonaws.acmpca#GetPolicy" + }, { "target": "com.amazonaws.acmpca#ImportCertificateAuthorityCertificate" }, @@ -78,6 +84,9 @@ { "target": "com.amazonaws.acmpca#ListTags" }, + { + "target": "com.amazonaws.acmpca#PutPolicy" + }, { "target": "com.amazonaws.acmpca#RestoreCertificateAuthority" }, @@ -105,35 +114,51 @@ "name": "acm-pca" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the ACM Private CA API Reference. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing private certificate authorities (CA) for your organization.

\n\t\t

The documentation for each action shows the Query API request parameters and the XML\n\t\t\tresponse. Alternatively, you can use one of the AWS SDKs to access an API that's\n\t\t\ttailored to the programming language or platform that you're using. For more\n\t\t\tinformation, see AWS\n\t\t\tSDKs.

\n\t\t \n\t\t\t

Each ACM Private CA API action has a throttling limit which determines the number of times\n\t\t\t\tthe action can be called per second. For more information, see API Rate Limits in ACM Private CA\n\t\t\t\tin the ACM Private CA user guide.

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

\n\t\t \n\t\t

This is the ACM Private CA API Reference. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing private certificate authorities (CA) for your organization.

\n\t\t

The documentation for each action shows the Query API request parameters and the XML\n\t\t\tresponse. Alternatively, you can use one of the AWS SDKs to access an API that's\n\t\t\ttailored to the programming language or platform that you're using. For more\n\t\t\tinformation, see AWS\n\t\t\tSDKs.

\n\t\t \n\t\t\t

Each ACM Private CA API action has a quota that determines the number of times the action\n\t\t\t\tcan be called per second. For more information, see API Rate Quotas in ACM Private CA\n\t\t\t\tin the ACM Private CA user guide.

\n\t\t ", "smithy.api#title": "AWS Certificate Manager Private Certificate Authority" } }, + "com.amazonaws.acmpca#ASN1PrintableString64": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "[a-zA-Z0-9'()+-.?:/= ]*" + } + }, "com.amazonaws.acmpca#ASN1Subject": { "type": "structure", "members": { - "CommonName": { + "Organization": { "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

Fully qualified domain name (FQDN) associated with the certificate subject.

" + "smithy.api#documentation": "

Legal name of the organization with which the certificate subject is affiliated.\n\t\t

" } }, - "Initials": { - "target": "com.amazonaws.acmpca#String5", + "OrganizationalUnit": { + "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the\n\t\t\tfirst letter of the SurName.

" + "smithy.api#documentation": "

A subdivision or unit of the organization (such as sales or finance) with which the\n\t\t\tcertificate subject is affiliated.

" } }, - "Title": { - "target": "com.amazonaws.acmpca#String64", + "Locality": { + "target": "com.amazonaws.acmpca#String128", "traits": { - "smithy.api#documentation": "

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the\n\t\t\tcertificate subject.

" + "smithy.api#documentation": "

The locality (such as a city or town) in which the certificate subject is\n\t\t\tlocated.

" } }, - "GivenName": { - "target": "com.amazonaws.acmpca#String16", + "Country": { + "target": "com.amazonaws.acmpca#CountryCodeString", "traits": { - "smithy.api#documentation": "

First name.

" + "smithy.api#documentation": "

Two-digit code that specifies the country in which the certificate subject\n\t\t\tlocated.

" + } + }, + "Pseudonym": { + "target": "com.amazonaws.acmpca#String128", + "traits": { + "smithy.api#documentation": "

Typically a shortened version of a longer GivenName.\n\t\t\tFor example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,\n\t\t\tLiz, or Eliza.

" } }, "State": { @@ -148,46 +173,40 @@ "smithy.api#documentation": "

Family name. In the US and the UK, for example, the surname of an individual is\n\t\t\tordered last. In Asian cultures the surname is typically ordered first.

" } }, - "SerialNumber": { - "target": "com.amazonaws.acmpca#String64", - "traits": { - "smithy.api#documentation": "

The certificate serial number.

" - } - }, - "Country": { - "target": "com.amazonaws.acmpca#CountryCodeString", + "DistinguishedNameQualifier": { + "target": "com.amazonaws.acmpca#ASN1PrintableString64", "traits": { - "smithy.api#documentation": "

Two-digit code that specifies the country in which the certificate subject\n\t\t\tlocated.

" + "smithy.api#documentation": "

Disambiguating information for the certificate subject.

" } }, - "Organization": { + "CommonName": { "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

Legal name of the organization with which the certificate subject is affiliated.\n\t\t

" + "smithy.api#documentation": "

Fully qualified domain name (FQDN) associated with the certificate subject.

" } }, - "Pseudonym": { - "target": "com.amazonaws.acmpca#String128", + "SerialNumber": { + "target": "com.amazonaws.acmpca#ASN1PrintableString64", "traits": { - "smithy.api#documentation": "

Typically a shortened version of a longer GivenName.\n\t\t\tFor example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,\n\t\t\tLiz, or Eliza.

" + "smithy.api#documentation": "

The certificate serial number.

" } }, - "OrganizationalUnit": { + "Title": { "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

A subdivision or unit of the organization (such as sales or finance) with which the\n\t\t\tcertificate subject is affiliated.

" + "smithy.api#documentation": "

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the\n\t\t\tcertificate subject.

" } }, - "DistinguishedNameQualifier": { - "target": "com.amazonaws.acmpca#DistinguishedNameQualifierString", + "GivenName": { + "target": "com.amazonaws.acmpca#String16", "traits": { - "smithy.api#documentation": "

Disambiguating information for the certificate subject.

" + "smithy.api#documentation": "

First name.

" } }, - "Locality": { - "target": "com.amazonaws.acmpca#String128", + "Initials": { + "target": "com.amazonaws.acmpca#String5", "traits": { - "smithy.api#documentation": "

The locality (such as a city or town) in which the certificate subject is\n\t\t\tlocated.

" + "smithy.api#documentation": "

Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the\n\t\t\tfirst letter of the SurName.

" } }, "GenerationQualifier": { @@ -201,6 +220,16 @@ "smithy.api#documentation": "

Contains information about the certificate subject. The certificate can be one issued\n\t\t\tby your private certificate authority (CA) or it can be your private CA certificate. The\n\t\t\t\tSubject field in the certificate identifies the\n\t\t\tentity that owns or controls the public key in the certificate. The entity can be a\n\t\t\tuser, computer, device, or service. The Subject must\n\t\t\tcontain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished\n\t\t\tnames (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique\n\t\t\tfor each entity, but your private CA can issue more than one certificate with the same\n\t\t\tDN to the same entity.

" } }, + "com.amazonaws.acmpca#AWSPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + }, + "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + } + }, "com.amazonaws.acmpca#AccountId": { "type": "string", "traits": { @@ -249,7 +278,7 @@ "min": 5, "max": 200 }, - "smithy.api#pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*" + "smithy.api#pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=,.@-]+)*" } }, "com.amazonaws.acmpca#AuditReportId": { @@ -308,58 +337,58 @@ "com.amazonaws.acmpca#CertificateAuthority": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.acmpca#CertificateAuthorityStatus", + "FailureReason": { + "target": "com.amazonaws.acmpca#FailureReason", "traits": { - "smithy.api#documentation": "

Status of your private CA.

" + "smithy.api#documentation": "

Reason the request to create your private CA failed.

" } }, - "CreatedAt": { + "LastStateChangeAt": { "target": "com.amazonaws.acmpca#TStamp", "traits": { - "smithy.api#documentation": "

Date and time at which your private CA was created.

" + "smithy.api#documentation": "

Date and time at which your private CA was last updated.

" } }, - "Arn": { - "target": "com.amazonaws.acmpca#Arn", + "OwnerAccount": { + "target": "com.amazonaws.acmpca#AccountId", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) for your private certificate authority (CA). The format is\n\t\t\t\t\t\n 12345678-1234-1234-1234-123456789012\n .

" + "smithy.api#documentation": "

The AWS account ID that owns the certificate authority.

" } }, - "NotAfter": { + "RestorableUntil": { "target": "com.amazonaws.acmpca#TStamp", "traits": { - "smithy.api#documentation": "

Date and time after which your private CA certificate is not valid.

" + "smithy.api#documentation": "

The period during which a deleted CA can be restored. For more information, see the\n\t\t\t\tPermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

" } }, - "Serial": { - "target": "com.amazonaws.acmpca#String", + "RevocationConfiguration": { + "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

Serial number of your private CA.

" + "smithy.api#documentation": "

Information about the certificate revocation list (CRL) created and maintained by your\n\t\t\tprivate CA.

" } }, - "RestorableUntil": { - "target": "com.amazonaws.acmpca#TStamp", + "Arn": { + "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The period during which a deleted CA can be restored. For more information, see the\n\t\t\t\tPermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) for your private certificate authority (CA). The format is\n\t\t\t\t\t\n 12345678-1234-1234-1234-123456789012\n .

" } }, - "LastStateChangeAt": { - "target": "com.amazonaws.acmpca#TStamp", + "Serial": { + "target": "com.amazonaws.acmpca#String", "traits": { - "smithy.api#documentation": "

Date and time at which your private CA was last updated.

" + "smithy.api#documentation": "

Serial number of your private CA.

" } }, - "FailureReason": { - "target": "com.amazonaws.acmpca#FailureReason", + "Status": { + "target": "com.amazonaws.acmpca#CertificateAuthorityStatus", "traits": { - "smithy.api#documentation": "

Reason the request to create your private CA failed.

" + "smithy.api#documentation": "

Status of your private CA.

" } }, - "RevocationConfiguration": { - "target": "com.amazonaws.acmpca#RevocationConfiguration", + "Type": { + "target": "com.amazonaws.acmpca#CertificateAuthorityType", "traits": { - "smithy.api#documentation": "

Information about the certificate revocation list (CRL) created and maintained by your\n\t\t\tprivate CA.

" + "smithy.api#documentation": "

Type of your private CA.

" } }, "NotBefore": { @@ -368,10 +397,16 @@ "smithy.api#documentation": "

Date and time before which your private CA certificate is not valid.

" } }, - "Type": { - "target": "com.amazonaws.acmpca#CertificateAuthorityType", + "NotAfter": { + "target": "com.amazonaws.acmpca#TStamp", "traits": { - "smithy.api#documentation": "

Type of your private CA.

" + "smithy.api#documentation": "

Date and time after which your private CA certificate is not valid.

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

Date and time at which your private CA was created.

" } }, "CertificateAuthorityConfiguration": { @@ -382,23 +417,16 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about your private certificate authority (CA). Your private CA can\n\t\t\tissue and revoke X.509 digital certificates. Digital certificates verify that the entity\n\t\t\tnamed in the certificate Subject field owns or controls\n\t\t\tthe public key contained in the Subject Public Key Info\n\t\t\tfield. Call the CreateCertificateAuthority action to create your\n\t\t\tprivate CA. You must then call the GetCertificateAuthorityCertificate\n\t\t\taction to retrieve a private CA certificate signing request (CSR). Sign the CSR with\n\t\t\tyour ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed\n\t\t\tcertificate into AWS Certificate Manager (ACM).

" + "smithy.api#documentation": "

Contains information about your private certificate authority (CA). Your private CA\n\t\t\tcan issue and revoke X.509 digital certificates. Digital certificates verify that the\n\t\t\tentity named in the certificate Subject field owns or\n\t\t\tcontrols the public key contained in the Subject Public Key\n\t\t\t\tInfo field. Call the CreateCertificateAuthority action to create your private CA. You must then\n\t\t\tcall the GetCertificateAuthorityCertificate action to retrieve a private CA\n\t\t\tcertificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises\n\t\t\troot or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed\n\t\t\tcertificate into AWS Certificate Manager (ACM).

" } }, "com.amazonaws.acmpca#CertificateAuthorityConfiguration": { "type": "structure", "members": { - "KeyAlgorithm": { - "target": "com.amazonaws.acmpca#KeyAlgorithm", - "traits": { - "smithy.api#documentation": "

Type of the public key algorithm and size, in bits, of the key pair that your CA creates\n\t\t\twhen it issues a certificate. When you create a subordinate CA, you must use a key\n\t\t\talgorithm supported by the parent CA.

", - "smithy.api#required": {} - } - }, "SigningAlgorithm": { "target": "com.amazonaws.acmpca#SigningAlgorithm", "traits": { - "smithy.api#documentation": "

Name of the algorithm your private CA uses to sign certificate requests.

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

Name of the algorithm your private CA uses to sign certificate requests.

\n\t\t

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign certificates when they are issued.

", "smithy.api#required": {} } }, @@ -408,10 +436,17 @@ "smithy.api#documentation": "

Structure that contains X.500 distinguished name information for your private\n\t\t\tCA.

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

Type of the public key algorithm and size, in bits, of the key pair that your CA\n\t\t\tcreates when it issues a certificate. When you create a subordinate CA, you must use a\n\t\t\tkey algorithm supported by the parent CA.

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

Contains configuration information for your private certificate authority (CA). This\n\t\t\tincludes information about the class of public key algorithm and the key pair that your\n\t\t\tprivate CA creates when it issues a certificate. It also includes the signature\n\t\t\talgorithm that it uses when issuing certificates, and its X.500 distinguished name. You\n\t\t\tmust specify this information when you call the CreateCertificateAuthority action.

" + "smithy.api#documentation": "

Contains configuration information for your private certificate authority (CA). This\n\t\t\tincludes information about the class of public key algorithm and the key pair that your\n\t\t\tprivate CA creates when it issues a certificate. It also includes the signature\n\t\t\talgorithm that it uses when issuing certificates, and its X.500 distinguished name. You\n\t\t\tmust specify this information when you call the CreateCertificateAuthority action.

" } }, "com.amazonaws.acmpca#CertificateAuthorityStatus": { @@ -515,6 +550,10 @@ "com.amazonaws.acmpca#CountryCodeString": { "type": "string", "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, "smithy.api#pattern": "[A-Za-z]{2}" } }, @@ -541,7 +580,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a root or subordinate private certificate authority (CA). You must specify the CA\n\t\t\tconfiguration, the certificate revocation list (CRL) configuration, the CA type, and an\n\t\t\toptional idempotency token to avoid accidental creation of multiple CAs. The CA\n\t\t\tconfiguration specifies the name of the algorithm and key size to be used to create the\n\t\t\tCA private key, the type of signing algorithm that the CA uses, and X.500 subject\n\t\t\tinformation. The CRL configuration specifies the CRL expiration period in days (the\n\t\t\tvalidity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME\n\t\t\talias for the S3 bucket that is included in certificates issued by the CA. If\n\t\t\tsuccessful, this action returns the Amazon Resource Name (ARN) of the CA.

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

Creates a root or subordinate private certificate authority (CA). You must specify the\n\t\t\tCA configuration, the certificate revocation list (CRL) configuration, the CA type, and\n\t\t\tan optional idempotency token to avoid accidental creation of multiple CAs. The CA\n\t\t\tconfiguration specifies the name of the algorithm and key size to be used to create the\n\t\t\tCA private key, the type of signing algorithm that the CA uses, and X.500 subject\n\t\t\tinformation. The CRL configuration specifies the CRL expiration period in days (the\n\t\t\tvalidity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME\n\t\t\talias for the S3 bucket that is included in certificates issued by the CA. If\n\t\t\tsuccessful, this action returns the Amazon Resource Name (ARN) of the CA.

\n\t\t

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your\n\t\t\tCRLs.

\n\t\t \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n ", "smithy.api#idempotent": {} } }, @@ -574,17 +613,17 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an audit report that lists every time that your CA private key is used. The report\n\t\t\tis saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the\n\t\t\tprivate key.

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

Creates an audit report that lists every time that your CA private key is used. The\n\t\t\treport is saved in the Amazon S3 bucket that you specify on input. \n\t\t\t\n\t\t\tThe IssueCertificate and RevokeCertificate actions use\n\t\t\tthe private key.

\n\t\t \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n \n\t\t \n\t\t

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your Audit\n\t\t\t\tReports.

", "smithy.api#idempotent": {} } }, "com.amazonaws.acmpca#CreateCertificateAuthorityAuditReportRequest": { "type": "structure", "members": { - "CertificateAuthorityArn": { - "target": "com.amazonaws.acmpca#Arn", + "S3BucketName": { + "target": "com.amazonaws.acmpca#S3BucketName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

\n\t\t

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .

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

The name of the S3 bucket that will contain the audit report.

", "smithy.api#required": {} } }, @@ -595,10 +634,10 @@ "smithy.api#required": {} } }, - "S3BucketName": { - "target": "com.amazonaws.acmpca#String", + "CertificateAuthorityArn": { + "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket that will contain the audit report.

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

The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

\n\t\t

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .

", "smithy.api#required": {} } } @@ -607,16 +646,16 @@ "com.amazonaws.acmpca#CreateCertificateAuthorityAuditReportResponse": { "type": "structure", "members": { - "AuditReportId": { - "target": "com.amazonaws.acmpca#AuditReportId", + "S3Key": { + "target": "com.amazonaws.acmpca#S3Key", "traits": { - "smithy.api#documentation": "

An alphanumeric string that contains a report identifier.

" + "smithy.api#documentation": "

The key that uniquely identifies the report file in\n\t\t\tyour S3 bucket.

" } }, - "S3Key": { - "target": "com.amazonaws.acmpca#String", + "AuditReportId": { + "target": "com.amazonaws.acmpca#AuditReportId", "traits": { - "smithy.api#documentation": "

The key that uniquely identifies the report file in\n\t\t\tyour S3 bucket.

" + "smithy.api#documentation": "

An alphanumeric string that contains a report identifier.

" } } } @@ -624,17 +663,16 @@ "com.amazonaws.acmpca#CreateCertificateAuthorityRequest": { "type": "structure", "members": { - "RevocationConfiguration": { - "target": "com.amazonaws.acmpca#RevocationConfiguration", + "Tags": { + "target": "com.amazonaws.acmpca#TagList", "traits": { - "smithy.api#documentation": "

Contains a Boolean value that you can use to enable a certification revocation list\n\t\t\t(CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an\n\t\t\toptional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For\n\t\t\tmore information, see the CrlConfiguration structure.

" + "smithy.api#documentation": "

Key-value pairs that will be attached to the new private CA. You can associate up to\n\t\t\t50 tags with a private CA. For information using tags with IAM to manage permissions,\n\t\t\tsee Controlling Access Using IAM Tags.

" } }, - "CertificateAuthorityType": { - "target": "com.amazonaws.acmpca#CertificateAuthorityType", + "IdempotencyToken": { + "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

The type of the certificate authority.

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

Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. For a given token, ACM Private CA\n\t\t\tcreates exactly one CA. If you issue a subsequent call using the same token, ACM Private CA\n\t\t\treturns the ARN of the existing CA and takes no further action. If you change the\n\t\t\tidempotency token across multiple calls, ACM Private CA creates a unique CA for each unique\n\t\t\ttoken.

" } }, "CertificateAuthorityConfiguration": { @@ -644,16 +682,17 @@ "smithy.api#required": {} } }, - "IdempotencyToken": { - "target": "com.amazonaws.acmpca#IdempotencyToken", + "CertificateAuthorityType": { + "target": "com.amazonaws.acmpca#CertificateAuthorityType", "traits": { - "smithy.api#documentation": "

Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after\n\t\t\tfive minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency\n\t\t\ttoken within a five minute period, ACM Private CA recognizes that you are requesting only one\n\t\t\tcertificate. As a result, ACM Private CA issues only one. If you change the idempotency token for\n\t\t\teach call, however, ACM Private CA recognizes that you are requesting multiple\n\t\t\tcertificates.

" + "smithy.api#documentation": "

The type of the certificate authority.

", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.acmpca#TagList", + "RevocationConfiguration": { + "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

Key-value pairs that will be attached to the new private CA. You can associate up to\n\t\t\t50 tags with a private CA. For information using tags with

\n\t\t

IAM to manage permissions, see Controlling Access Using IAM Tags.

" + "smithy.api#documentation": "

Contains a Boolean value that you can use to enable a certification revocation list\n\t\t\t(CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an\n\t\t\toptional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For\n\t\t\tmore information, see the CrlConfiguration structure.\n\t\t

" } } } @@ -695,7 +734,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns permissions from a private CA to a designated AWS service. Services are\n\t\t\tspecified by their service principals and can be given permission to create and retrieve\n\t\t\tcertificates on a private CA. Services can also be given permission to list the active\n\t\t\tpermissions that the private CA has granted. For ACM to automatically renew your\n\t\t\tprivate CA's certificates, you must assign all possible permissions from the CA to the\n\t\t\tACM service principal.

\n\t\t

At this time, you can only assign permissions to ACM (acm.amazonaws.com).\n\t\t\tPermissions can be revoked with the DeletePermission action and listed\n\t\t\twith the ListPermissions action.

" + "smithy.api#documentation": "

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com). These permissions allow ACM to issue and\n\t\t\trenew ACM certificates that reside in the same AWS account as the CA.

\n\t\t

You can list current permissions with the ListPermissions action and\n\t\t\trevoke them with the DeletePermission action.

\n\t\t

\n About Permissions\n

\n " } }, "com.amazonaws.acmpca#CreatePermissionRequest": { @@ -708,6 +747,12 @@ "smithy.api#required": {} } }, + "SourceAccount": { + "target": "com.amazonaws.acmpca#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the calling account.

" + } + }, "Principal": { "target": "com.amazonaws.acmpca#Principal", "traits": { @@ -715,16 +760,10 @@ "smithy.api#required": {} } }, - "SourceAccount": { - "target": "com.amazonaws.acmpca#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the calling account.

" - } - }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN\n\t\t\tby calling the ListCertificateAuthorities action. This must have the\n\t\t\tfollowing form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the\n\t\t\tARN by calling the ListCertificateAuthorities action. This must have the following form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

", "smithy.api#required": {} } } @@ -733,10 +772,12 @@ "com.amazonaws.acmpca#CrlConfiguration": { "type": "structure", "members": { - "CustomCname": { - "target": "com.amazonaws.acmpca#String253", + "Enabled": { + "target": "com.amazonaws.acmpca#Boolean", "traits": { - "smithy.api#documentation": "

Name inserted into the certificate CRL Distribution\n\t\t\t\tPoints extension that enables the use of an alias for the CRL\n\t\t\tdistribution point. Use this value if you don't want the name of your S3 bucket to be\n\t\t\tpublic.

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

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.\n\t\t\tYou can use this value to enable certificate revocation for a new CA when you call the\n\t\t\t\tCreateCertificateAuthority action or for an existing CA when you call the\n\t\t\t\tUpdateCertificateAuthority action.

", + "smithy.api#required": {} } }, "ExpirationInDays": { @@ -746,23 +787,21 @@ "smithy.api#documentation": "

Number of days until a certificate expires.

" } }, - "Enabled": { - "target": "com.amazonaws.acmpca#Boolean", + "CustomCname": { + "target": "com.amazonaws.acmpca#String253", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You\n\t\t\tcan use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call\n\t\t\tthe UpdateCertificateAuthority action.

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

Name inserted into the certificate CRL Distribution\n\t\t\t\tPoints extension that enables the use of an alias for the CRL\n\t\t\tdistribution point. Use this value if you don't want the name of your S3 bucket to be\n\t\t\tpublic.

" } }, "S3BucketName": { "target": "com.amazonaws.acmpca#String3To255", "traits": { - "smithy.api#documentation": "

Name of the S3 bucket that contains the CRL. If you do not provide a value for the\n\t\t\t\tCustomCname argument, the name of your S3 bucket\n\t\t\tis placed into the CRL Distribution Points extension of\n\t\t\tthe issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that\n\t\t\tallows ACM Private CA to write the CRL to your bucket.

" + "smithy.api#documentation": "

Name of the S3 bucket that contains the CRL. If you do not provide a value for the\n\t\t\t\tCustomCname argument, the name of your S3 bucket\n\t\t\tis placed into the CRL Distribution Points extension of\n\t\t\tthe issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that\n\t\t\tallows ACM Private CA to write the CRL to your bucket.

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

Contains configuration information for a certificate revocation list (CRL). Your\n\t\t\tprivate certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You\n\t\t\tcan enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA\n\t\t\twrites CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by\n\t\t\tspecifying a value for the CustomCname parameter. Your\n\t\t\tprivate CA copies the CNAME or the S3 bucket name to the CRL\n\t\t\t\tDistribution Points extension of each certificate it issues. Your S3\n\t\t\tbucket policy must give write permission to ACM Private CA.

\n\t\t

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next\n\t\t\tupdate or when a certificate is revoked. When a certificate is revoked, it is recorded\n\t\t\tin the next CRL that is generated and in the next audit report. Only time valid\n\t\t\tcertificates are listed in the CRL. Expired certificates are not included.

\n\t\t

CRLs contain the following fields:

\n\t\t \n\t\t

Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the\n\t\t\tfollowing OpenSSL command to list a CRL.

\n\t\t

\n openssl crl -inform DER -text -in crl_path\n\t\t\t-noout\n

" + "smithy.api#documentation": "

Contains configuration information for a certificate revocation list (CRL). Your\n\t\t\tprivate certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You\n\t\t\tcan enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA\n\t\t\twrites CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by\n\t\t\tspecifying a value for the CustomCname parameter. Your\n\t\t\tprivate CA copies the CNAME or the S3 bucket name to the CRL\n\t\t\t\tDistribution Points extension of each certificate it issues. Your S3\n\t\t\tbucket policy must give write permission to ACM Private CA.

\n\t\t

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your\n\t\t\tCRLs.

\n\t\t

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next\n\t\t\tupdate or when a certificate is revoked. When a certificate is revoked, it is recorded\n\t\t\tin the next CRL that is generated and in the next audit report. Only time valid\n\t\t\tcertificates are listed in the CRL. Expired certificates are not included.

\n\t\t

CRLs contain the following fields:

\n\t\t \n\t\t

Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the\n\t\t\tfollowing OpenSSL command to list a CRL.

\n\t\t

\n openssl crl -inform DER -text -in crl_path\n\t\t\t-noout\n

" } }, "com.amazonaws.acmpca#CsrBlob": { @@ -797,24 +836,24 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a private certificate authority (CA). You must provide the Amazon Resource\n\t\t\tName (ARN) of the private CA that you want to delete. You can find the ARN by calling\n\t\t\tthe ListCertificateAuthorities action.

\n\t\t \n\t\t\t

Deleting a CA will invalidate other CAs and certificates below it in your CA\n\t\t\t\thierarchy.

\n\t\t \n\t\t

Before you can delete a CA that you have created and activated, you must disable it.\n\t\t\tTo do this, call the UpdateCertificateAuthority action and set the\n\t\t\t\tCertificateAuthorityStatus parameter to\n\t\t\t\tDISABLED.

\n\t\t

Additionally, you can delete a CA if you are waiting for it to be created (that is,\n\t\t\tthe status of the CA is CREATING). You can also delete it if the CA has\n\t\t\tbeen created but you haven't yet imported the signed certificate into ACM Private CA (that is,\n\t\t\tthe status of the CA is PENDING_CERTIFICATE).

\n\t\t

When you successfully call DeleteCertificateAuthority, the CA's\n\t\t\tstatus changes to DELETED. However, the CA won't be permanently deleted\n\t\t\tuntil the restoration period has passed. By default, if you do not set the\n\t\t\t\tPermanentDeletionTimeInDays parameter, the CA remains restorable for 30\n\t\t\tdays. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the\n\t\t\trestoration window of a private CA in the DELETED state. To restore an\n\t\t\teligible CA, call the RestoreCertificateAuthority action.

" + "smithy.api#documentation": "

Deletes a private certificate authority (CA). You must provide the Amazon Resource\n\t\t\tName (ARN) of the private CA that you want to delete. You can find the ARN by calling\n\t\t\tthe ListCertificateAuthorities action.

\n\t\t \n\t\t\t

Deleting a CA will invalidate other CAs and certificates below it in your CA\n\t\t\t\thierarchy.

\n\t\t \n\t\t

Before you can delete a CA that you have created and activated, you must disable it.\n\t\t\tTo do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

\n\t\t

Additionally, you can delete a CA if you are waiting for it to be created (that is,\n\t\t\tthe status of the CA is CREATING). You can also delete it if the CA has\n\t\t\tbeen created but you haven't yet imported the signed certificate into ACM Private CA (that is,\n\t\t\tthe status of the CA is PENDING_CERTIFICATE).

\n\t\t

When you successfully call DeleteCertificateAuthority, the CA's status changes to\n\t\t\tDELETED. However, the CA won't be permanently deleted until the restoration\n\t\t\tperiod has passed. By default, if you do not set the\n\t\t\t\tPermanentDeletionTimeInDays parameter, the CA remains restorable for 30\n\t\t\tdays. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the\n\t\t\trestoration window of a private CA in the DELETED state. To restore an\n\t\t\teligible CA, call the RestoreCertificateAuthority action.

" } }, "com.amazonaws.acmpca#DeleteCertificateAuthorityRequest": { "type": "structure", "members": { - "PermanentDeletionTimeInDays": { - "target": "com.amazonaws.acmpca#PermanentDeletionTimeInDays", - "traits": { - "smithy.api#documentation": "

The number of days to make a CA restorable after it has been deleted. This can be\n\t\t\tanywhere from 7 to 30 days, with 30 being the default.

" - } - }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The number of days to make a CA restorable after it has been deleted. This can be\n\t\t\tanywhere from 7 to 30 days, with 30 being the default.

" + } } } }, @@ -838,25 +877,25 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes permissions that a private CA assigned to a designated AWS service. Permissions\n\t\t\tcan be created with the CreatePermission action and listed with the\n\t\t\t\tListPermissions action.

" + "smithy.api#documentation": "

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal\n\t\t\t(acm.amazonaws.com).

\n\t\t

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame AWS account as the CA. If you revoke these permissions, ACM will no longer\n\t\t\trenew the affected certificates automatically.

\n\t\t

Permissions can be granted with the CreatePermission action and\n\t\t\tlisted with the ListPermissions action.

\n\t\t

\n About Permissions\n

\n " } }, "com.amazonaws.acmpca#DeletePermissionRequest": { "type": "structure", "members": { - "CertificateAuthorityArn": { - "target": "com.amazonaws.acmpca#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find\n\t\t\tthe CA's ARN by calling the ListCertificateAuthorities action. This\n\t\t\tmust have the following form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

", - "smithy.api#required": {} - } - }, "SourceAccount": { "target": "com.amazonaws.acmpca#AccountId", "traits": { "smithy.api#documentation": "

The AWS account that calls this action.

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

The Amazon Resource Number (ARN) of the private CA that issued the permissions. You\n\t\t\tcan find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

", + "smithy.api#required": {} + } + }, "Principal": { "target": "com.amazonaws.acmpca#Principal", "traits": { @@ -866,6 +905,47 @@ } } }, + "com.amazonaws.acmpca#DeletePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.acmpca#DeletePolicyRequest" + }, + "errors": [ + { + "target": "com.amazonaws.acmpca#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.acmpca#InvalidArnException" + }, + { + "target": "com.amazonaws.acmpca#InvalidStateException" + }, + { + "target": "com.amazonaws.acmpca#LockoutPreventedException" + }, + { + "target": "com.amazonaws.acmpca#RequestFailedException" + }, + { + "target": "com.amazonaws.acmpca#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the resource-based policy attached to a private CA. Deletion will remove any\n\t\t\taccess that the policy has granted. If there is no policy attached to the private CA,\n\t\t\tthis action will return successful.

\n\t\t

If you delete a policy that was applied through AWS Resource Access Manager (RAM), \n\t\t\tthe CA will be removed from all shares in which it was included.

\n\t\t

The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you delete\n\t\t\tthe policy.

\n\t\t

The current policy can be shown with GetPolicy and updated with PutPolicy.

\n\t\t

\n About Policies\n

\n " + } + }, + "com.amazonaws.acmpca#DeletePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.acmpca#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You\n\t\t\tcan find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form\n\t\t\t\tarn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.acmpca#DescribeCertificateAuthority": { "type": "operation", "input": { @@ -883,7 +963,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists information about your private certificate authority (CA). You specify the\n\t\t\tprivate CA on input by its ARN (Amazon Resource Name). The output contains the status of\n\t\t\tyour CA. This can be any of the following:

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

Lists information about your private certificate authority (CA) or one that has been\n\t\t\tshared with you. You specify the private CA on input by its ARN (Amazon Resource Name).\n\t\t\tThe output contains the status of your CA. This can be any of the following:

\n\t\t " } }, "com.amazonaws.acmpca#DescribeCertificateAuthorityAuditReport": { @@ -906,7 +986,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is\n\t\t\tcreated every time the certificate authority (CA) private key is used. The private key\n\t\t\tis used when you call the IssueCertificate action or the RevokeCertificate action.

" + "smithy.api#documentation": "

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created\n\t\t\tevery time the certificate authority (CA) private key is used. The private key is used\n\t\t\twhen you call the IssueCertificate action or the\n\t\t\t\tRevokeCertificate action.

" } }, "com.amazonaws.acmpca#DescribeCertificateAuthorityAuditReportRequest": { @@ -915,7 +995,7 @@ "AuditReportId": { "target": "com.amazonaws.acmpca#AuditReportId", "traits": { - "smithy.api#documentation": "

The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

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

The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

", "smithy.api#required": {} } }, @@ -931,20 +1011,14 @@ "com.amazonaws.acmpca#DescribeCertificateAuthorityAuditReportResponse": { "type": "structure", "members": { - "AuditReportStatus": { - "target": "com.amazonaws.acmpca#AuditReportStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether report creation is in progress, has succeeded, or has failed.

" - } - }, "S3BucketName": { - "target": "com.amazonaws.acmpca#String", + "target": "com.amazonaws.acmpca#S3BucketName", "traits": { "smithy.api#documentation": "

Name of the S3 bucket that contains the report.

" } }, "S3Key": { - "target": "com.amazonaws.acmpca#String", + "target": "com.amazonaws.acmpca#S3Key", "traits": { "smithy.api#documentation": "

S3 key that uniquely identifies the report file in\n\t\t\tyour S3 bucket.

" } @@ -954,6 +1028,12 @@ "traits": { "smithy.api#documentation": "

The date and time at which the report was created.

" } + }, + "AuditReportStatus": { + "target": "com.amazonaws.acmpca#AuditReportStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether report creation is in progress, has succeeded, or has failed.

" + } } } }, @@ -963,7 +1043,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

", "smithy.api#required": {} } } @@ -975,21 +1055,11 @@ "CertificateAuthority": { "target": "com.amazonaws.acmpca#CertificateAuthority", "traits": { - "smithy.api#documentation": "

A CertificateAuthority structure that contains information about\n\t\t\tyour private CA.

" + "smithy.api#documentation": "

A CertificateAuthority structure that contains information about your private\n\t\t\tCA.

" } } } }, - "com.amazonaws.acmpca#DistinguishedNameQualifierString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "[a-zA-Z0-9'()+-.?:/= ]*" - } - }, "com.amazonaws.acmpca#FailureReason": { "type": "string", "traits": { @@ -1035,7 +1105,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a certificate from your private CA. The ARN of the certificate is returned when\n\t\t\tyou call the IssueCertificate action. You must specify both the ARN of\n\t\t\tyour private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it\n\t\t\tis in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that\n\t\t\tcontains information about all of the certificates issued and revoked by your private\n\t\t\tCA.

" + "smithy.api#documentation": "

Retrieves a certificate from your private CA or one that has been shared with you. The\n\t\t\tARN of the certificate is returned when you call the IssueCertificate action. You\n\t\t\tmust specify both the ARN of your private CA and the ARN of the issued certificate when\n\t\t\tcalling the GetCertificate action. You can retrieve the\n\t\t\tcertificate if it is in the ISSUED state. You can call\n\t\t\tthe CreateCertificateAuthorityAuditReport action to create a report that\n\t\t\tcontains information about all of the certificates issued and revoked by your private\n\t\t\tCA.

" } }, "com.amazonaws.acmpca#GetCertificateAuthorityCertificate": { @@ -1058,7 +1128,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the certificate and certificate chain for your private certificate authority\n\t\t\t(CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not\n\t\t\tinclude the CA certificate. Each certificate in the chain signs the one before it.

" + "smithy.api#documentation": "

Retrieves the certificate and certificate chain for your private certificate authority\n\t\t\t(CA) or one that has been shared with you. Both the certificate and the chain are base64\n\t\t\tPEM-encoded. The chain does not include the CA certificate. Each certificate in the\n\t\t\tchain signs the one before it.

" } }, "com.amazonaws.acmpca#GetCertificateAuthorityCertificateRequest": { @@ -1079,7 +1149,7 @@ "CertificateChain": { "target": "com.amazonaws.acmpca#CertificateChain", "traits": { - "smithy.api#documentation": "

Base64-encoded certificate chain that includes any intermediate certificates and chains up\n\t\t\tto root on-premises certificate that you used to sign your private CA certificate. The\n\t\t\tchain does not include your private CA certificate. If this is a root CA, the value will\n\t\t\tbe null.

" + "smithy.api#documentation": "

Base64-encoded certificate chain that includes any intermediate certificates and\n\t\t\tchains up to root on-premises certificate that you used to sign your private CA\n\t\t\tcertificate. The chain does not include your private CA certificate. If this is a root\n\t\t\tCA, the value will be null.

" } }, "Certificate": { @@ -1116,7 +1186,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the certificate signing request (CSR) for your private certificate authority (CA).\n\t\t\tThe CSR is created when you call the CreateCertificateAuthority\n\t\t\taction. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then\n\t\t\timport the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a\n\t\t\tbase64 PEM-encoded string.

" + "smithy.api#documentation": "

Retrieves the certificate signing request (CSR) for your private certificate authority\n\t\t\t(CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or\n\t\t\ton-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA\n\t\t\tby calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a\n\t\t\tbase64 PEM-encoded string.

" } }, "com.amazonaws.acmpca#GetCertificateAuthorityCsrRequest": { @@ -1125,7 +1195,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

", "smithy.api#required": {} } } @@ -1142,38 +1212,87 @@ } } }, - "com.amazonaws.acmpca#GetCertificateRequest": { + "com.amazonaws.acmpca#GetCertificateRequest": { + "type": "structure", + "members": { + "CertificateArn": { + "target": "com.amazonaws.acmpca#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the issued certificate. The ARN contains the certificate serial number and\n\t\t\tmust be in the following form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245\n \n\t\t

", + "smithy.api#required": {} + } + }, + "CertificateAuthorityArn": { + "target": "com.amazonaws.acmpca#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.acmpca#GetCertificateResponse": { + "type": "structure", + "members": { + "CertificateChain": { + "target": "com.amazonaws.acmpca#CertificateChain", + "traits": { + "smithy.api#documentation": "

The base64 PEM-encoded certificate chain that chains up to the on-premises root CA\n\t\t\tcertificate that you used to sign your private CA certificate.

" + } + }, + "Certificate": { + "target": "com.amazonaws.acmpca#CertificateBody", + "traits": { + "smithy.api#documentation": "

The base64 PEM-encoded certificate specified by the CertificateArn\n\t\t\tparameter.

" + } + } + } + }, + "com.amazonaws.acmpca#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.acmpca#GetPolicyRequest" + }, + "output": { + "target": "com.amazonaws.acmpca#GetPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.acmpca#InvalidArnException" + }, + { + "target": "com.amazonaws.acmpca#InvalidStateException" + }, + { + "target": "com.amazonaws.acmpca#RequestFailedException" + }, + { + "target": "com.amazonaws.acmpca#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the resource-based policy attached to a private CA. If either the private CA\n\t\t\tresource or the policy cannot be found, this action returns a\n\t\t\t\tResourceNotFoundException.

\n\t\t

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

\n\t\t

\n About Policies\n

\n " + } + }, + "com.amazonaws.acmpca#GetPolicyRequest": { "type": "structure", "members": { - "CertificateArn": { - "target": "com.amazonaws.acmpca#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the issued certificate. The ARN contains the certificate serial number and\n\t\t\tmust be in the following form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245\n \n\t\t

", - "smithy.api#required": {} - } - }, - "CertificateAuthorityArn": { + "ResourceArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Number (ARN) of the private CA that will have its policy\n\t\t\tretrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.\n\t\t\t\n\t\t

", "smithy.api#required": {} } } } }, - "com.amazonaws.acmpca#GetCertificateResponse": { + "com.amazonaws.acmpca#GetPolicyResponse": { "type": "structure", "members": { - "CertificateChain": { - "target": "com.amazonaws.acmpca#CertificateChain", - "traits": { - "smithy.api#documentation": "

The base64 PEM-encoded certificate chain that chains up to the on-premises root CA\n\t\t\tcertificate that you used to sign your private CA certificate.

" - } - }, - "Certificate": { - "target": "com.amazonaws.acmpca#CertificateBody", + "Policy": { + "target": "com.amazonaws.acmpca#AWSPolicy", "traits": { - "smithy.api#documentation": "

The base64 PEM-encoded certificate specified by the CertificateArn\n\t\t\tparameter.

" + "smithy.api#documentation": "

The policy attached to the private CA as a JSON document.

" } } } @@ -1223,30 +1342,30 @@ } ], "traits": { - "smithy.api#documentation": "

Imports a signed\n\t\t\tprivate CA certificate into ACM Private CA. This action is used when you are using a chain of\n\t\t\ttrust whose root is located outside ACM Private CA. Before you can call this action, the\n\t\t\tfollowing preparations must in place:

\n\t\t\n\t\t
    \n
  1. \n

    In ACM Private CA, call the CreateCertificateAuthority action to create the private\n\t\t\t\t\tCA that that you plan to back with the imported certificate.

    \n
    2. \n
  2. \n

    Call the GetCertificateAuthorityCsr action to generate a certificate signing\n\t\t\t\t\trequest (CSR).

    \n
    3. \n
  3. \n

    Sign the CSR using a root or intermediate CA hosted either by an on-premises PKI hierarchy or\n\t\t\t\t\ta commercial CA..

    \n
    4. \n
  4. \n

    Create a\n\t\t\t\t\tcertificate chain and copy the signed certificate and the certificate chain to your\n\t\t\t\t\tworking directory.

    \n
    5. \n
\t\t\n\t\t\n\t\t

The following requirements apply when you import a CA certificate.

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

Imports a signed private CA certificate into ACM Private CA. This action is used when you are\n\t\t\tusing a chain of trust whose root is located outside ACM Private CA. Before you can call this\n\t\t\taction, the following preparations must in place:

\n\t\t
    \n
  1. \n\t\t\t\t

    In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that\n\t\t\t\t\tthat you plan to back with the imported certificate.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Call the GetCertificateAuthorityCsr action to generate a certificate signing\n\t\t\t\t\trequest (CSR).

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Sign the CSR using a root or intermediate CA hosted by either an on-premises\n\t\t\t\t\tPKI hierarchy or by a commercial CA.

    \n\t\t\t
    4. \n
  4. \n\t\t\t\t

    Create a certificate chain and copy the signed certificate and the certificate\n\t\t\t\t\tchain to your working directory.

    \n\t\t\t
    5. \n
\n\t\t

The following requirements apply when you import a CA certificate.

\n\t\t \n\t\t

\n Enforcement of Critical Constraints\n

\n\t\t

ACM Private CA allows the following extensions to be marked critical in the imported CA\n\t\t\tcertificate or chain.

\n\t\t \n\t\t

ACM Private CA rejects the following extensions when they are marked critical in an imported CA\n\t\t\tcertificate or chain.

\n\t\t " } }, "com.amazonaws.acmpca#ImportCertificateAuthorityCertificateRequest": { "type": "structure", "members": { - "CertificateChain": { - "target": "com.amazonaws.acmpca#CertificateChainBlob", + "Certificate": { + "target": "com.amazonaws.acmpca#CertificateBodyBlob", "traits": { - "smithy.api#documentation": "

A PEM-encoded file that contains all of your certificates, other than the certificate you're\n\t\t\timporting, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root\n\t\t\tcertificate is the last in the chain, and each certificate in the chain signs the one\n\t\t\tpreceding.

\n\t\t

This parameter must be supplied when you import a subordinate CA. When you import a\n\t\t\troot CA, there is no chain.

" + "smithy.api#documentation": "

The PEM-encoded certificate for a private CA. This may be a self-signed certificate in\n\t\t\tthe case of a root CA, or it may be signed by another CA that you control.

", + "smithy.api#required": {} } }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

", "smithy.api#required": {} } }, - "Certificate": { - "target": "com.amazonaws.acmpca#CertificateBodyBlob", + "CertificateChain": { + "target": "com.amazonaws.acmpca#CertificateChainBlob", "traits": { - "smithy.api#documentation": "

The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the\n\t\t\tcase of a root CA, or it may be signed by another CA that you control.

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

A PEM-encoded file that contains all of your certificates, other than the certificate\n\t\t\tyou're importing, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root\n\t\t\tcertificate is the last in the chain, and each certificate in the chain signs the one\n\t\t\tpreceding.

\n\t\t

This parameter must be supplied when you import a subordinate CA. When you import a\n\t\t\troot CA, there is no chain.

" } } } @@ -1293,7 +1412,7 @@ } }, "traits": { - "smithy.api#documentation": "

The token specified in the NextToken argument is not valid. Use the token\n\t\t\treturned from your previous call to ListCertificateAuthorities.

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

The token specified in the NextToken argument is not valid. Use the token\n\t\t\treturned from your previous call to ListCertificateAuthorities.

", "smithy.api#error": "client" } }, @@ -1305,7 +1424,7 @@ } }, "traits": { - "smithy.api#documentation": "

The S3 bucket policy is not valid. The policy must give ACM Private CA rights to read from\n\t\t\tand write to the bucket and find the bucket location.

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

The resource policy is invalid or is missing a required statement. For general information about \n\t\t\tIAM policy and statement structure, see Overview \n\t\t\t\tof JSON Policies.

", "smithy.api#error": "client" } }, @@ -1329,7 +1448,7 @@ } }, "traits": { - "smithy.api#documentation": "

The private CA is in a state during which a report or certificate cannot be\n\t\t\tgenerated.

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

The state of the private CA does not allow this action to occur.

", "smithy.api#error": "client" } }, @@ -1374,52 +1493,52 @@ } ], "traits": { - "smithy.api#documentation": "

Uses your private certificate authority (CA) to issue a client certificate. This action\n\t\t\treturns the Amazon Resource Name (ARN) of the certificate. You can retrieve the\n\t\t\tcertificate by calling the GetCertificate action and specifying the\n\t\t\tARN.

\n\t\t \n\t\t\t

You cannot use the ACM ListCertificateAuthorities action\n\t\t\t\tto retrieve the ARNs of the certificates that you issue by using ACM Private CA.

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

Uses your private certificate authority\n\t\t\t(CA), or one that\n\t\t\thas been shared with you, to issue a client certificate. This action returns the Amazon\n\t\t\tResource Name (ARN) of the certificate. You can retrieve the certificate by calling the\n\t\t\t\tGetCertificate action and specifying the ARN.

\n\t\t \n\t\t\t

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the\n\t\t\t\tcertificates that you issue by using ACM Private CA.

\n\t\t ", "smithy.api#idempotent": {} } }, "com.amazonaws.acmpca#IssueCertificateRequest": { "type": "structure", "members": { - "CertificateAuthorityArn": { - "target": "com.amazonaws.acmpca#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

", - "smithy.api#required": {} - } - }, "Csr": { "target": "com.amazonaws.acmpca#CsrBlob", "traits": { - "smithy.api#documentation": "

The certificate signing request (CSR) for the certificate you want to issue. You can\n\t\t\tuse the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

\n\t\t

\n\t\t\t openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem\n\t\t\t\t-out csr/test_cert_.csr\n\t\t

\n\t\t

If you have a configuration file, you can use the following OpenSSL command. The\n\t\t\t\tusr_cert block in the configuration file contains your X509 version 3\n\t\t\textensions.

\n\t\t

\n openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048\n\t\t\t\t-days -365 -keyout private/test_cert_priv_key.pem -out\n\t\t\tcsr/test_cert_.csr\n

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

The certificate signing request (CSR) for the certificate you want to issue. You can\n\t\t\tuse the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

\n\t\t

\n\t\t\t openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem\n\t\t\t\t-out csr/test_cert_.csr\n\t\t

\n\t\t

If you have a configuration file, you can use the following OpenSSL command. The\n\t\t\t\tusr_cert block in the configuration file contains your X509 version 3\n\t\t\textensions.

\n\t\t

\n openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048\n\t\t\t\t-days -365 -keyout private/test_cert_priv_key.pem -out\n\t\t\tcsr/test_cert_.csr\n

\n\t\t

Note: A CSR must provide either a subject name or a\n\t\t\t\tsubject alternative name or the request will be rejected.\n\t\t

", "smithy.api#required": {} } }, - "TemplateArn": { + "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

Specifies a custom configuration template to use when issuing a certificate. If this\n\t\t\tparameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1\n\t\t\ttemplate.

\n\t\t

The following service-owned TemplateArn values are supported by ACM Private CA:

\n\t\t \n\t\t

For more information, see Using\n\t\t\t\tTemplates.

" - } - }, - "Validity": { - "target": "com.amazonaws.acmpca#Validity", - "traits": { - "smithy.api#documentation": "

The type of the validity period.

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour.\n\t\t\tTherefore, if you call IssueCertificate multiple times\n\t\t\twith the same idempotency token within 5 minutes, ACM Private CA recognizes that you are\n\t\t\trequesting only one certificate and will issue only one. If you change the idempotency\n\t\t\ttoken for each call, PCA recognizes that you are requesting multiple\n\t\t\tcertificates.

" + "smithy.api#documentation": "

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after\n\t\t\tone hour. Therefore, if you call IssueCertificate\n\t\t\tmultiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that\n\t\t\tyou are requesting only one certificate and will issue only one. If you change the\n\t\t\tidempotency token for each call, PCA recognizes that you are requesting multiple\n\t\t\tcertificates.

" } }, "SigningAlgorithm": { "target": "com.amazonaws.acmpca#SigningAlgorithm", "traits": { - "smithy.api#documentation": "

The name of the algorithm that will be used to sign the certificate to be\n\t\t\tissued.

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

The name of the algorithm that will be used to sign the certificate to be issued.

\n\t\t

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR.

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

Information describing the validity period of the certificate.

\n\t\t

When issuing a certificate, ACM Private CA sets the \"Not Before\" date in the validity field to\n\t\t\tdate and time minus 60 minutes. This is intended to compensate for time inconsistencies\n\t\t\tacross systems of 60 minutes or less.

\n\t\t

The validity period configured on a certificate must not exceed the limit set by its\n\t\t\tparents in the CA hierarchy.

", "smithy.api#required": {} } + }, + "TemplateArn": { + "target": "com.amazonaws.acmpca#Arn", + "traits": { + "smithy.api#documentation": "

Specifies a custom configuration template to use when issuing a certificate. If this\n\t\t\tparameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1\n\t\t\ttemplate. For CA certificates, you should choose the shortest path length that meets\n\t\t\tyour needs. The path length is indicated by the PathLenN portion of\n\t\t\tthe ARN, where N is the CA depth.

\n\t\t

Note: The CA depth configured on a subordinate CA certificate must not exceed the\n\t\t\tlimit set by its parents in the CA hierarchy.

\n\t\t

The following service-owned TemplateArn values are supported by ACM Private CA:

\n\t\t \n\t\t

For more information, see Using Templates.

" + } } } }, @@ -1465,7 +1584,7 @@ } }, "traits": { - "smithy.api#documentation": "

An ACM Private CA limit has been exceeded. See the exception message returned to determine the\n\t\t\tlimit that was exceeded.

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

An ACM Private CA quota has been exceeded. See the exception message returned to determine the\n\t\t\tquota that was exceeded.

", "smithy.api#error": "client" } }, @@ -1483,7 +1602,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

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

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1506,6 +1625,12 @@ "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n\t\t\tresponse with truncated results. Set it to the value of the NextToken\n\t\t\tparameter from the response you just received.

" } + }, + "ResourceOwner": { + "target": "com.amazonaws.acmpca#ResourceOwner", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the returned set of certificate authorities based on\n\t\t\ttheir owner. The default is SELF.

" + } } } }, @@ -1552,7 +1677,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the permissions, if any, that have been assigned by a private CA. Permissions can\n\t\t\tbe granted with the CreatePermission action and revoked with the DeletePermission action.

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

List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com).

\n\t\t

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame AWS account as the CA.

\n\t\t

Permissions can be granted with the CreatePermission action and\n\t\t\trevoked with the DeletePermission action.

\n\t\t

\n About Permissions\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1564,22 +1689,22 @@ "com.amazonaws.acmpca#ListPermissionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.acmpca#NextToken", - "traits": { - "smithy.api#documentation": "

When paginating results, use this parameter in a subsequent request after you receive\n\t\t\ta response with truncated results. Set it to the value of NextToken from the response you just received.

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

When paginating results, use this parameter to specify the maximum number of items to\n\t\t\treturn in the response. If additional items exist beyond the number you specify, the\n\t\t\t\tNextToken element is sent in the response. Use this\n\t\t\t\tNextToken value in a subsequent request to retrieve\n\t\t\tadditional items.

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

When paginating results, use this parameter in a subsequent request after you receive\n\t\t\ta response with truncated results. Set it to the value of NextToken from the response you just received.

" + } + }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by\n\t\t\tcalling the ListCertificateAuthorities action. This must be of the\n\t\t\tform:\n\t\t\t\tarn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n\t\t\tYou can get a private CA's ARN by running the ListCertificateAuthorities action.

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

The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by\n\t\t\tcalling the ListCertificateAuthorities action. This must be of the form:\n\t\t\t\tarn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n\t\t\tYou can get a private CA's ARN by running the ListCertificateAuthorities action.

", "smithy.api#required": {} } } @@ -1588,17 +1713,17 @@ "com.amazonaws.acmpca#ListPermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.acmpca#PermissionList", - "traits": { - "smithy.api#documentation": "

Summary information about each permission assigned by the specified private CA,\n\t\t\tincluding the action enabled, the policy provided, and the time of creation.

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

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.\n\t\t

" } + }, + "Permissions": { + "target": "com.amazonaws.acmpca#PermissionList", + "traits": { + "smithy.api#documentation": "

Summary information about each permission assigned by the specified private CA,\n\t\t\tincluding the action enabled, the policy provided, and the time of creation.

" + } } } }, @@ -1622,7 +1747,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags, if any, that are associated with your private CA. Tags are labels that you\n\t\t\tcan use to identify and organize your CAs. Each tag consists of a key and an optional\n\t\t\tvalue. Call the TagCertificateAuthority action to add one or more tags\n\t\t\tto your CA. Call the UntagCertificateAuthority action to remove tags.

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

Lists the tags, if any, that are associated with your private CA or one that has been\n\t\t\tshared with you. Tags are labels that you can use to identify and organize your CAs.\n\t\t\tEach tag consists of a key and an optional value. Call the TagCertificateAuthority\n\t\t\taction to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1649,7 +1774,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

", "smithy.api#required": {} } } @@ -1658,18 +1783,30 @@ "com.amazonaws.acmpca#ListTagsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.acmpca#NextToken", - "traits": { - "smithy.api#documentation": "

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.\n\t\t

" - } - }, "Tags": { "target": "com.amazonaws.acmpca#TagList", "traits": { "smithy.api#documentation": "

The tags associated with your private CA.

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

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.\n\t\t

" + } + } + } + }, + "com.amazonaws.acmpca#LockoutPreventedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.acmpca#String" } + }, + "traits": { + "smithy.api#documentation": "

The current action was prevented because it would lock the caller out from performing\n\t\t\tsubsequent actions. Verify that the specified parameters would not result in the caller\n\t\t\tbeing denied access to the resource.

", + "smithy.api#error": "client" } }, "com.amazonaws.acmpca#MalformedCSRException": { @@ -1728,16 +1865,10 @@ "com.amazonaws.acmpca#Permission": { "type": "structure", "members": { - "Principal": { - "target": "com.amazonaws.acmpca#String", - "traits": { - "smithy.api#documentation": "

The AWS service or entity that holds the permission. At this time, the only valid\n\t\t\tprincipal is acm.amazonaws.com.

" - } - }, - "CertificateAuthorityArn": { - "target": "com.amazonaws.acmpca#Arn", + "SourceAccount": { + "target": "com.amazonaws.acmpca#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA from which the permission was\n\t\t\tissued.

" + "smithy.api#documentation": "

The ID of the account that assigned the permission.

" } }, "CreatedAt": { @@ -1746,10 +1877,10 @@ "smithy.api#documentation": "

The time at which the permission was created.

" } }, - "SourceAccount": { - "target": "com.amazonaws.acmpca#String", + "Principal": { + "target": "com.amazonaws.acmpca#Principal", "traits": { - "smithy.api#documentation": "

The ID of the account that assigned the permission.

" + "smithy.api#documentation": "

The AWS service or entity that holds the permission. At this time, the only valid\n\t\t\tprincipal is acm.amazonaws.com.

" } }, "Actions": { @@ -1758,15 +1889,21 @@ "smithy.api#documentation": "

The private CA actions that can be performed by the designated AWS service.

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

The Amazon Resource Number (ARN) of the private CA from which the permission was\n\t\t\tissued.

" + } + }, "Policy": { - "target": "com.amazonaws.acmpca#String", + "target": "com.amazonaws.acmpca#AWSPolicy", "traits": { "smithy.api#documentation": "

The name of the policy that is associated with the permission.

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

Permissions designate which private CA actions can be performed by an AWS service or\n\t\t\tentity. In order for ACM to automatically renew private certificates, you must give\n\t\t\tthe ACM service principal all available permissions (IssueCertificate,\n\t\t\t\tGetCertificate, and ListPermissions). Permissions can be\n\t\t\tassigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.

" + "smithy.api#documentation": "

Permissions designate which private CA actions can be performed by an AWS service or\n\t\t\tentity. In order for ACM to automatically renew private certificates, you must give\n\t\t\tthe ACM service principal all available permissions (IssueCertificate,\n\t\t\t\tGetCertificate, and ListPermissions). Permissions can be\n\t\t\tassigned with the CreatePermission action,\n\t\t\tremoved with the DeletePermission action, and\n\t\t\tlisted with the ListPermissions action.

" } }, "com.amazonaws.acmpca#PermissionAlreadyExistsException": { @@ -1811,6 +1948,57 @@ "smithy.api#pattern": "^[^*]+$" } }, + "com.amazonaws.acmpca#PutPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.acmpca#PutPolicyRequest" + }, + "errors": [ + { + "target": "com.amazonaws.acmpca#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.acmpca#InvalidArnException" + }, + { + "target": "com.amazonaws.acmpca#InvalidPolicyException" + }, + { + "target": "com.amazonaws.acmpca#InvalidStateException" + }, + { + "target": "com.amazonaws.acmpca#LockoutPreventedException" + }, + { + "target": "com.amazonaws.acmpca#RequestFailedException" + }, + { + "target": "com.amazonaws.acmpca#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a resource-based policy to a private CA.

\n\t\t

A policy can also be applied by sharing a private CA through AWS Resource Access Manager\n\t\t\t(RAM).

\n\t\t

The policy can be displayed with GetPolicy and removed with DeletePolicy.

\n\t\t\n\t\t\t

\n About Policies\n

\n " + } + }, + "com.amazonaws.acmpca#PutPolicyRequest": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.acmpca#AWSPolicy", + "traits": { + "smithy.api#documentation": "

The path and filename of a JSON-formatted IAM policy to attach to the specified private CA\n\t\t\tresource. If this policy does not contain all required statements or if it includes any\n\t\t\tstatement that is not allowed, the PutPolicy action returns an InvalidPolicyException.\n\t\t\tFor information about IAM policy and statement structure, see Overview \n\t\t\t\tof JSON Policies.

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

The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of\n\t\t\tthe CA can be found by calling the ListCertificateAuthorities action.

\n\t\t

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.acmpca#RequestAlreadyProcessedException": { "type": "structure", "members": { @@ -1855,10 +2043,25 @@ } }, "traits": { - "smithy.api#documentation": "

A resource such as a private CA, S3 bucket, certificate, or audit report cannot be\n\t\t\tfound.

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

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be\n\t\t\tfound.

", "smithy.api#error": "client" } }, + "com.amazonaws.acmpca#ResourceOwner": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELF", + "name": "SELF" + }, + { + "value": "OTHER_ACCOUNTS", + "name": "OTHER_ACCOUNTS" + } + ] + } + }, "com.amazonaws.acmpca#RestoreCertificateAuthority": { "type": "operation", "input": { @@ -1876,7 +2079,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores a certificate authority (CA) that is in the DELETED state. You can\n\t\t\trestore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30\n\t\t\tdays. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at\n\t\t\tany time in a 30 day period. You can check the time remaining in the restoration period\n\t\t\tof a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set\n\t\t\tto its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to\n\t\t\t\tACTIVE, call the UpdateCertificateAuthority action.\n\t\t\tIf the private CA was in the PENDING_CERTIFICATE state at deletion, you\n\t\t\tmust use the ImportCertificateAuthorityCertificate action to import a\n\t\t\tcertificate authority into the private CA before it can be activated. You cannot restore\n\t\t\ta CA after the restoration period has ended.

" + "smithy.api#documentation": "

Restores a certificate authority (CA) that is in the DELETED state. You\n\t\t\tcan restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days.\n\t\t\tIf you did not specify a PermanentDeletionTimeInDays\n\t\t\tvalue, by default you can restore the CA at any time in a 30 day period. You can check\n\t\t\tthe time remaining in the restoration period of a private CA in the DELETED\n\t\t\tstate by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to\n\t\t\tits pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to\n\t\t\t\tACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the\n\t\t\t\tPENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate\n\t\t\tauthority into the private CA before it can be activated. You cannot restore a CA after\n\t\t\tthe restoration period has ended.

" } }, "com.amazonaws.acmpca#RestoreCertificateAuthorityRequest": { @@ -1885,7 +2088,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

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

Certificate revocation information used by the CreateCertificateAuthority\n\t\t\tand UpdateCertificateAuthority actions. Your private certificate\n\t\t\tauthority (CA) can create and maintain a certificate revocation list (CRL). A CRL\n\t\t\tcontains information about certificates revoked by your CA. For more information, see\n\t\t\t\tRevokeCertificate.

" + "smithy.api#documentation": "

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA)\n\t\t\tcan create and maintain a certificate revocation list (CRL). A CRL contains information\n\t\t\tabout certificates revoked by your CA. For more information, see RevokeCertificate.

" } }, "com.amazonaws.acmpca#RevocationReason": { @@ -1979,12 +2182,19 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate\n\t\t\trevocation list (CRL) when you create or update your private CA, information about the\n\t\t\trevoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket\n\t\t\tthat you specify. For more information about revocation, see the CrlConfiguration structure. ACM Private CA also writes revocation information to\n\t\t\tthe audit report. For more information, see CreateCertificateAuthorityAuditReport.

\n\t\t \n\t\t\t

You cannot revoke a root CA self-signed certificate.

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

Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate\n\t\t\trevocation list (CRL) when you create or update your private CA, information about the\n\t\t\trevoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket\n\t\t\tthat you specify. A CRL is typically updated approximately 30 minutes after a\n\t\t\tcertificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes\n\t\t\tfurther attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the\n\t\t\tmetrics CRLGenerated and MisconfiguredCRLBucket. For more\n\t\t\tinformation, see Supported CloudWatch Metrics.

\n\t\t \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n \n\t\t

ACM Private CA also writes revocation information to the audit report. For more information,\n\t\t\tsee CreateCertificateAuthorityAuditReport.

\n\t\t \n\t\t\t

You cannot revoke a root CA self-signed certificate.

\n\t\t " } }, "com.amazonaws.acmpca#RevokeCertificateRequest": { "type": "structure", "members": { + "CertificateSerial": { + "target": "com.amazonaws.acmpca#String128", + "traits": { + "smithy.api#documentation": "

Serial number of the certificate to be revoked. This must be in hexadecimal format.\n\t\t\tYou can retrieve the serial number by calling GetCertificate with the Amazon\n\t\t\tResource Name (ARN) of the certificate you want and the ARN of your private CA. The\n\t\t\t\tGetCertificate action retrieves the certificate in\n\t\t\tthe PEM format. You can use the following OpenSSL command to list the certificate in\n\t\t\ttext format and copy the hexadecimal serial number.

\n\t\t

\n openssl x509 -in file_path -text -noout\n

\n\t\t

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API\n\t\t\t\tReference.

", + "smithy.api#required": {} + } + }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { @@ -1998,13 +2208,24 @@ "smithy.api#documentation": "

Specifies why you revoked the certificate.

", "smithy.api#required": {} } - }, - "CertificateSerial": { - "target": "com.amazonaws.acmpca#String128", - "traits": { - "smithy.api#documentation": "

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can\n\t\t\tretrieve the serial number by calling GetCertificate with the Amazon\n\t\t\tResource Name (ARN) of the certificate you want and the ARN of your private CA. The\n\t\t\t\tGetCertificate action retrieves the certificate in\n\t\t\tthe PEM format. You can use the following OpenSSL command to list the certificate in\n\t\t\ttext format and copy the hexadecimal serial number.

\n\t\t

\n openssl x509 -in file_path -text -noout\n

\n\t\t

You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API\n\t\t\t\tReference.

", - "smithy.api#required": {} - } + } + } + }, + "com.amazonaws.acmpca#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.acmpca#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 } } }, @@ -2120,22 +2341,22 @@ "com.amazonaws.acmpca#Tag": { "type": "structure", "members": { + "Value": { + "target": "com.amazonaws.acmpca#TagValue", + "traits": { + "smithy.api#documentation": "

Value of the tag.

" + } + }, "Key": { "target": "com.amazonaws.acmpca#TagKey", "traits": { "smithy.api#documentation": "

Key (name) of the tag.

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

Value of the tag.

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

Tags are labels that you can use to identify and organize your private CAs. Each tag\n\t\t\tconsists of a key and an optional value. You can associate up to 50 tags with a private\n\t\t\tCA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.

" + "smithy.api#documentation": "

Tags are labels that you can use to identify and organize your private CAs. Each tag\n\t\t\tconsists of a key and an optional value. You can associate up to 50 tags with a private\n\t\t\tCA. To add one or more tags to a private CA, call the TagCertificateAuthority\n\t\t\taction. To remove a tag, call the UntagCertificateAuthority action.

" } }, "com.amazonaws.acmpca#TagCertificateAuthority": { @@ -2161,7 +2382,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to your private CA. Tags are labels that you can use to identify and\n\t\t\torganize your AWS resources. Each tag consists of a key and an optional value. You\n\t\t\tspecify the private CA on input by its Amazon Resource Name (ARN). You specify the tag\n\t\t\tby using a key-value pair. You can apply a tag to just one private CA if you want to\n\t\t\tidentify a specific characteristic of that CA, or you can apply the same tag to multiple\n\t\t\tprivate CAs if you want to filter for a common relationship among those CAs. To remove\n\t\t\tone or more tags, use the UntagCertificateAuthority action. Call the\n\t\t\t\tListTags action to see what tags are associated with your CA.

" + "smithy.api#documentation": "

Adds one or more tags to your private CA. Tags are labels that you can use to identify\n\t\t\tand organize your AWS resources. Each tag consists of a key and an optional value. You\n\t\t\tspecify the private CA on input by its Amazon Resource Name (ARN). You specify the tag\n\t\t\tby using a key-value pair. You can apply a tag to just one private CA if you want to\n\t\t\tidentify a specific characteristic of that CA, or you can apply the same tag to multiple\n\t\t\tprivate CAs if you want to filter for a common relationship among those CAs. To remove\n\t\t\tone or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are\n\t\t\tassociated with your CA.

" } }, "com.amazonaws.acmpca#TagCertificateAuthorityRequest": { @@ -2170,7 +2391,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

", "smithy.api#required": {} } }, @@ -2247,23 +2468,23 @@ } ], "traits": { - "smithy.api#documentation": "

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do\n\t\t\tnot specify the value portion of the tag when calling this action, the tag will be\n\t\t\tremoved regardless of value. If you specify a value, the tag is removed only if it is\n\t\t\tassociated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to\n\t\t\tsee what tags are associated with your CA.

" + "smithy.api#documentation": "

Remove one or more tags from your private CA. A tag consists of a key-value pair. If\n\t\t\tyou do not specify the value portion of the tag when calling this action, the tag will\n\t\t\tbe removed regardless of value. If you specify a value, the tag is removed only if it is\n\t\t\tassociated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are\n\t\t\tassociated with your CA.

" } }, "com.amazonaws.acmpca#UntagCertificateAuthorityRequest": { "type": "structure", "members": { - "CertificateAuthorityArn": { - "target": "com.amazonaws.acmpca#Arn", + "Tags": { + "target": "com.amazonaws.acmpca#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

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

List of tags to be removed from the CA.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.acmpca#TagList", + "CertificateAuthorityArn": { + "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

List of tags to be removed from the CA.

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n\t\t

\n\t\t\t arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n\t\t

", "smithy.api#required": {} } } @@ -2295,7 +2516,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status or configuration of a private certificate authority (CA). Your\n\t\t\tprivate CA must be in the ACTIVE or DISABLED state before you\n\t\t\tcan update it. You can disable a private CA that is in the ACTIVE state or\n\t\t\tmake a CA that is in the DISABLED state active again.

" + "smithy.api#documentation": "

Updates the status or configuration of a private certificate authority (CA). Your\n\t\t\tprivate CA must be in the ACTIVE or DISABLED state before you\n\t\t\tcan update it. You can disable a private CA that is in the ACTIVE state or\n\t\t\tmake a CA that is in the DISABLED state active again.

\n\t\t \n

Both PCA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Configure\n Access to ACM Private CA.

\n " } }, "com.amazonaws.acmpca#UpdateCertificateAuthorityRequest": { @@ -2325,24 +2546,24 @@ "com.amazonaws.acmpca#Validity": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.acmpca#ValidityPeriodType", + "Value": { + "target": "com.amazonaws.acmpca#PositiveLong", "traits": { - "smithy.api#documentation": "

Specifies whether the Value parameter represents days, months, or\n\t\t\tyears.

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

A long integer interpreted according to the value of Type, below.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.acmpca#PositiveLong", + "Type": { + "target": "com.amazonaws.acmpca#ValidityPeriodType", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

Time period.

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

Determines how ACM Private CA interprets the Value parameter,\n\t\t\tan integer. Supported validity types include those listed below. Type definitions with\n\t\t\tvalues include a sample input value and the resulting output.

\n\t\t

\n END_DATE: The specific date and time when the certificate will expire,\n\t\t\texpressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When\n\t\t\tUTCTime is used, if the year field (YY) is greater than or equal to 50, the year is\n\t\t\tinterpreted as 19YY. If the year field is less than 50, the year is interpreted as\n\t\t\t20YY.

\n\n\t\t \n\n\t\t

\n ABSOLUTE: The specific date and time when the certificate will expire,\n\t\t\texpressed in seconds since the Unix Epoch.

\n\n\t\t \n\t\t

\n DAYS, MONTHS, YEARS: The relative time from the\n\t\t\tmoment of issuance until the certificate will expire, expressed in days, months, or\n\t\t\tyears.

\n\t\t

Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

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

Length of time for which the certificate issued by your private certificate authority (CA),\n\t\t\tor by the private CA itself, is valid in days, months, or years. You can issue a\n\t\t\tcertificate by calling the IssueCertificate action.

" + "smithy.api#documentation": "

Validity specifies the period of time during which a certificate is valid. Validity can be\n\t\t\texpressed as an explicit date and time when the certificate expires, or as a span of\n\t\t\ttime after issuance, stated in days, months, or years. For more information, see Validity in RFC\n\t\t\t5280.

\n\t\t

You can issue a certificate by calling the IssueCertificate action.

" } }, "com.amazonaws.acmpca#ValidityPeriodType": { diff --git a/codegen/sdk-codegen/aws-models/acm.2015-12-08.json b/codegen/sdk-codegen/aws-models/acm.2015-12-08.json index a7f1229ff45f..2061a0075973 100644 --- a/codegen/sdk-codegen/aws-models/acm.2015-12-08.json +++ b/codegen/sdk-codegen/aws-models/acm.2015-12-08.json @@ -128,28 +128,40 @@ "com.amazonaws.acm#CertificateDetail": { "type": "structure", "members": { - "RenewalEligibility": { - "target": "com.amazonaws.acm#RenewalEligibility", + "KeyAlgorithm": { + "target": "com.amazonaws.acm#KeyAlgorithm", "traits": { - "smithy.api#documentation": "

Specifies whether the certificate is eligible for renewal. At this time, only exported\n private certificates can be renewed with the RenewCertificate\n command.

" + "smithy.api#documentation": "

The algorithm that was used to generate the public-private key pair.

" } }, - "SignatureAlgorithm": { - "target": "com.amazonaws.acm#String", + "KeyUsages": { + "target": "com.amazonaws.acm#KeyUsageList", "traits": { - "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" + "smithy.api#documentation": "

A list of Key Usage X.509 v3 extension objects. Each object is a string value that\n identifies the purpose of the public key contained in the certificate. Possible extension\n values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

" } }, - "InUseBy": { - "target": "com.amazonaws.acm#InUseList", + "FailureReason": { + "target": "com.amazonaws.acm#FailureReason", "traits": { - "smithy.api#documentation": "

A list of ARNs for the AWS resources that are using the certificate. A certificate can\n be used by multiple AWS resources.

" + "smithy.api#documentation": "

The reason the certificate request failed. This value exists only when the certificate\n status is FAILED. For more information, see Certificate Request\n Failed in the AWS Certificate Manager User Guide.

" } }, - "RevokedAt": { + "RenewalSummary": { + "target": "com.amazonaws.acm#RenewalSummary", + "traits": { + "smithy.api#documentation": "

Contains information about the status of ACM's managed renewal for the certificate. This field\n exists only when the certificate type is AMAZON_ISSUED.

" + } + }, + "SubjectAlternativeNames": { + "target": "com.amazonaws.acm#DomainList", + "traits": { + "smithy.api#documentation": "

One or more domain names (subject alternative names) included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.

" + } + }, + "NotAfter": { "target": "com.amazonaws.acm#TStamp", "traits": { - "smithy.api#documentation": "

The time at which the certificate was revoked. This value exists only when the certificate\n status is REVOKED.

" + "smithy.api#documentation": "

The time after which the certificate is not valid.

" } }, "Options": { @@ -158,28 +170,28 @@ "smithy.api#documentation": "

Value that specifies whether to add the certificate to a transparency log. Certificate\n transparency makes it possible to detect SSL certificates that have been mistakenly or\n maliciously issued. A browser might respond to certificate that has not been logged by showing\n an error message. The logs are cryptographically secure.

" } }, - "ImportedAt": { - "target": "com.amazonaws.acm#TStamp", + "Status": { + "target": "com.amazonaws.acm#CertificateStatus", "traits": { - "smithy.api#documentation": "

The date and time at which the certificate was imported. This value exists only when the\n certificate type is IMPORTED.

" + "smithy.api#documentation": "

The status of the certificate.

" } }, - "CertificateAuthorityArn": { - "target": "com.amazonaws.acm#Arn", + "ExtendedKeyUsages": { + "target": "com.amazonaws.acm#ExtendedKeyUsageList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued\n the certificate. This has the following format:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n

" + "smithy.api#documentation": "

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a\n purpose for which the certificate public key can be used and consists of a name and an object\n identifier (OID).

" } }, - "Serial": { + "Issuer": { "target": "com.amazonaws.acm#String", "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" + "smithy.api#documentation": "

The name of the certificate authority that issued and signed the certificate.

" } }, - "Issuer": { - "target": "com.amazonaws.acm#String", + "DomainName": { + "target": "com.amazonaws.acm#DomainNameString", "traits": { - "smithy.api#documentation": "

The name of the certificate authority that issued and signed the certificate.

" + "smithy.api#documentation": "

The fully qualified domain name for the certificate, such as www.example.com or\n example.com.

" } }, "CreatedAt": { @@ -188,100 +200,88 @@ "smithy.api#documentation": "

The time at which the certificate was requested. This value exists only when the\n certificate type is AMAZON_ISSUED.

" } }, - "DomainValidationOptions": { - "target": "com.amazonaws.acm#DomainValidationList", - "traits": { - "smithy.api#documentation": "

Contains information about the initial validation of each domain name that occurs as a\n result of the RequestCertificate request. This field exists only when the\n certificate type is AMAZON_ISSUED.

" - } - }, - "Subject": { - "target": "com.amazonaws.acm#String", + "InUseBy": { + "target": "com.amazonaws.acm#InUseList", "traits": { - "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" + "smithy.api#documentation": "

A list of ARNs for the AWS resources that are using the certificate. A certificate can\n be used by multiple AWS resources.

" } }, - "RevocationReason": { - "target": "com.amazonaws.acm#RevocationReason", + "CertificateArn": { + "target": "com.amazonaws.acm#Arn", "traits": { - "smithy.api#documentation": "

The reason the certificate was revoked. This value exists only when the certificate status\n is REVOKED.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see\n Amazon Resource Names (ARNs) and AWS\n Service Namespaces in the AWS General Reference.

" } }, - "SubjectAlternativeNames": { - "target": "com.amazonaws.acm#DomainList", + "Type": { + "target": "com.amazonaws.acm#CertificateType", "traits": { - "smithy.api#documentation": "

One or more domain names (subject alternative names) included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.

" + "smithy.api#documentation": "

The source of the certificate. For certificates provided by ACM, this value is\n AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide\n managed renewal for\n imported certificates. For more information about the differences between certificates that\n you import and those that ACM provides, see Importing Certificates in the\n AWS Certificate Manager User Guide.

" } }, - "IssuedAt": { + "NotBefore": { "target": "com.amazonaws.acm#TStamp", "traits": { - "smithy.api#documentation": "

The time at which the certificate was issued. This value exists only when the certificate\n type is AMAZON_ISSUED.

" + "smithy.api#documentation": "

The time before which the certificate is not valid.

" } }, - "KeyAlgorithm": { - "target": "com.amazonaws.acm#KeyAlgorithm", + "ImportedAt": { + "target": "com.amazonaws.acm#TStamp", "traits": { - "smithy.api#documentation": "

The algorithm that was used to generate the public-private key pair.

" + "smithy.api#documentation": "

The date and time at which the certificate was imported. This value exists only when the\n certificate type is IMPORTED.

" } }, - "DomainName": { - "target": "com.amazonaws.acm#DomainNameString", + "CertificateAuthorityArn": { + "target": "com.amazonaws.acm#Arn", "traits": { - "smithy.api#documentation": "

The fully qualified domain name for the certificate, such as www.example.com or\n example.com.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued\n the certificate. This has the following format:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n

" } }, - "KeyUsages": { - "target": "com.amazonaws.acm#KeyUsageList", + "Serial": { + "target": "com.amazonaws.acm#String", "traits": { - "smithy.api#documentation": "

A list of Key Usage X.509 v3 extension objects. Each object is a string value that\n identifies the purpose of the public key contained in the certificate. Possible extension\n values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

" + "smithy.api#documentation": "

The serial number of the certificate.

" } }, - "CertificateArn": { - "target": "com.amazonaws.acm#Arn", + "DomainValidationOptions": { + "target": "com.amazonaws.acm#DomainValidationList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see\n Amazon Resource Names (ARNs) and AWS\n Service Namespaces in the AWS General Reference.

" + "smithy.api#documentation": "

Contains information about the initial validation of each domain name that occurs as a\n result of the RequestCertificate request. This field exists only when the\n certificate type is AMAZON_ISSUED.

" } }, - "NotBefore": { - "target": "com.amazonaws.acm#TStamp", + "Subject": { + "target": "com.amazonaws.acm#String", "traits": { - "smithy.api#documentation": "

The time before which the certificate is not valid.

" + "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" } }, - "ExtendedKeyUsages": { - "target": "com.amazonaws.acm#ExtendedKeyUsageList", + "SignatureAlgorithm": { + "target": "com.amazonaws.acm#String", "traits": { - "smithy.api#documentation": "

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a\n purpose for which the certificate public key can be used and consists of a name and an object\n identifier (OID).

" + "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" } }, - "NotAfter": { + "RevokedAt": { "target": "com.amazonaws.acm#TStamp", "traits": { - "smithy.api#documentation": "

The time after which the certificate is not valid.

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

The status of the certificate.

" + "smithy.api#documentation": "

The time at which the certificate was revoked. This value exists only when the certificate\n status is REVOKED.

" } }, - "RenewalSummary": { - "target": "com.amazonaws.acm#RenewalSummary", + "RenewalEligibility": { + "target": "com.amazonaws.acm#RenewalEligibility", "traits": { - "smithy.api#documentation": "

Contains information about the status of ACM's managed renewal for the certificate. This field\n exists only when the certificate type is AMAZON_ISSUED.

" + "smithy.api#documentation": "

Specifies whether the certificate is eligible for renewal. At this time, only exported\n private certificates can be renewed with the RenewCertificate\n command.

" } }, - "Type": { - "target": "com.amazonaws.acm#CertificateType", + "IssuedAt": { + "target": "com.amazonaws.acm#TStamp", "traits": { - "smithy.api#documentation": "

The source of the certificate. For certificates provided by ACM, this value is\n AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide\n managed renewal for\n imported certificates. For more information about the differences between certificates that\n you import and those that ACM provides, see Importing Certificates in the\n AWS Certificate Manager User Guide.

" + "smithy.api#documentation": "

The time at which the certificate was issued. This value exists only when the certificate\n type is AMAZON_ISSUED.

" } }, - "FailureReason": { - "target": "com.amazonaws.acm#FailureReason", + "RevocationReason": { + "target": "com.amazonaws.acm#RevocationReason", "traits": { - "smithy.api#documentation": "

The reason the certificate request failed. This value exists only when the certificate\n status is FAILED. For more information, see Certificate Request\n Failed in the AWS Certificate Manager User Guide.

" + "smithy.api#documentation": "

The reason the certificate was revoked. This value exists only when the certificate status\n is REVOKED.

" } } }, @@ -338,7 +338,7 @@ "sdkId": "ACM", "arnNamespace": "acm", "cloudFormationName": "CertificateManager", - "cloudTrailEventSource": "certificatemanager.amazon.com" + "cloudTrailEventSource": "acm.amazonaws.com" }, "aws.auth#sigv4": { "name": "acm" @@ -582,10 +582,10 @@ "com.amazonaws.acm#DomainValidation": { "type": "structure", "members": { - "ResourceRecord": { - "target": "com.amazonaws.acm#ResourceRecord", + "ValidationMethod": { + "target": "com.amazonaws.acm#ValidationMethod", "traits": { - "smithy.api#documentation": "

Contains the CNAME record that you add to your DNS database for domain validation. For\n more information, see Use DNS to Validate Domain Ownership.

\n

Note: The CNAME information that you need does not include the name of your domain. If you\n include\u2028 your domain name in the DNS database CNAME record, validation fails.\u2028 For example, if\n the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only\n \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.

" + "smithy.api#documentation": "

Specifies the domain validation method.

" } }, "DomainName": { @@ -595,16 +595,10 @@ "smithy.api#required": {} } }, - "ValidationDomain": { - "target": "com.amazonaws.acm#DomainNameString", - "traits": { - "smithy.api#documentation": "

The domain name that ACM used to send domain validation emails.

" - } - }, - "ValidationMethod": { - "target": "com.amazonaws.acm#ValidationMethod", + "ValidationStatus": { + "target": "com.amazonaws.acm#DomainStatus", "traits": { - "smithy.api#documentation": "

Specifies the domain validation method.

" + "smithy.api#documentation": "

The validation status of the domain name. This can be one of the following values:

\n\n " } }, "ValidationEmails": { @@ -613,10 +607,16 @@ "smithy.api#documentation": "

A list of email addresses that ACM used to send domain validation emails.

" } }, - "ValidationStatus": { - "target": "com.amazonaws.acm#DomainStatus", + "ResourceRecord": { + "target": "com.amazonaws.acm#ResourceRecord", "traits": { - "smithy.api#documentation": "

The validation status of the domain name. This can be one of the following values:

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

Contains the CNAME record that you add to your DNS database for domain validation. For\n more information, see Use DNS to Validate Domain Ownership.

\n

Note: The CNAME information that you need does not include the name of your domain. If you\n include\u2028 your domain name in the DNS database CNAME record, validation fails.\u2028 For example, if\n the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only\n \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.

" + } + }, + "ValidationDomain": { + "target": "com.amazonaws.acm#DomainNameString", + "traits": { + "smithy.api#documentation": "

The domain name that ACM used to send domain validation emails.

" } } }, @@ -696,17 +696,17 @@ "com.amazonaws.acm#ExportCertificateRequest": { "type": "structure", "members": { - "CertificateArn": { - "target": "com.amazonaws.acm#Arn", + "Passphrase": { + "target": "com.amazonaws.acm#PassphraseBlob", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:

\n

\n arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012\n

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

Passphrase to associate with the encrypted exported private key. If you want to later\n decrypt the private key, you must have the passphrase. You can use the following OpenSSL\n command to decrypt a private key:

\n

\n openssl rsa -in encrypted_key.pem -out decrypted_key.pem\n

", "smithy.api#required": {} } }, - "Passphrase": { - "target": "com.amazonaws.acm#PassphraseBlob", + "CertificateArn": { + "target": "com.amazonaws.acm#Arn", "traits": { - "smithy.api#documentation": "

Passphrase to associate with the encrypted exported private key. If you want to later\n decrypt the private key, you must have the passphrase. You can use the following OpenSSL\n command to decrypt a private key:

\n

\n openssl rsa -in encrypted_key.pem -out decrypted_key.pem\n

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

An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:

\n

\n arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012\n

", "smithy.api#required": {} } } @@ -721,34 +721,34 @@ "smithy.api#documentation": "

The base64 PEM-encoded certificate.

" } }, - "PrivateKey": { - "target": "com.amazonaws.acm#PrivateKey", - "traits": { - "smithy.api#documentation": "

The encrypted private key associated with the public key in the certificate. The key is\n output in PKCS #8 format and is base64 PEM-encoded.

" - } - }, "CertificateChain": { "target": "com.amazonaws.acm#CertificateChain", "traits": { "smithy.api#documentation": "

The base64 PEM-encoded certificate chain. This does not include the certificate that you\n are exporting.

" } + }, + "PrivateKey": { + "target": "com.amazonaws.acm#PrivateKey", + "traits": { + "smithy.api#documentation": "

The encrypted private key associated with the public key in the certificate. The key is\n output in PKCS #8 format and is base64 PEM-encoded.

" + } } } }, "com.amazonaws.acm#ExtendedKeyUsage": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.acm#ExtendedKeyUsageName", - "traits": { - "smithy.api#documentation": "

The name of an Extended Key Usage value.

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

An object identifier (OID) for the extension value. OIDs are strings of numbers separated\n by periods. The following OIDs are defined in RFC 3280 and RFC 5280.

\n\n " } + }, + "Name": { + "target": "com.amazonaws.acm#ExtendedKeyUsageName", + "traits": { + "smithy.api#documentation": "

The name of an Extended Key Usage value.

" + } } }, "traits": { @@ -886,6 +886,10 @@ "value": "PCA_ACCESS_DENIED", "name": "PCA_ACCESS_DENIED" }, + { + "value": "SLR_NOT_FOUND", + "name": "SLR_NOT_FOUND" + }, { "value": "OTHER", "name": "OTHER" @@ -896,18 +900,18 @@ "com.amazonaws.acm#Filters": { "type": "structure", "members": { - "keyUsage": { - "target": "com.amazonaws.acm#KeyUsageFilterList", - "traits": { - "smithy.api#documentation": "

Specify one or more KeyUsage extension values.

" - } - }, "keyTypes": { "target": "com.amazonaws.acm#KeyAlgorithmList", "traits": { "smithy.api#documentation": "

Specify one or more algorithms that can be used to generate key pairs.

\n

Default filtering returns only RSA_2048 certificates. To return other\n certificate types, provide the desired type signatures in a comma-separated list. For example,\n \"keyTypes\": [\"RSA_2048,RSA_4096\"] returns both RSA_2048 and\n RSA_4096 certificates.

" } }, + "keyUsage": { + "target": "com.amazonaws.acm#KeyUsageFilterList", + "traits": { + "smithy.api#documentation": "

Specify one or more KeyUsage extension values.

" + } + }, "extendedKeyUsage": { "target": "com.amazonaws.acm#ExtendedKeyUsageFilterList", "traits": { @@ -957,17 +961,17 @@ "com.amazonaws.acm#GetCertificateResponse": { "type": "structure", "members": { - "CertificateChain": { - "target": "com.amazonaws.acm#CertificateChain", - "traits": { - "smithy.api#documentation": "

Certificates forming the requested certificate's chain of trust. The chain consists of the\n certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.

" - } - }, "Certificate": { "target": "com.amazonaws.acm#CertificateBody", "traits": { "smithy.api#documentation": "

The ACM-issued certificate corresponding to the ARN specified as input.

" } + }, + "CertificateChain": { + "target": "com.amazonaws.acm#CertificateChain", + "traits": { + "smithy.api#documentation": "

Certificates forming the requested certificate's chain of trust. The chain consists of the\n certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.

" + } } } }, @@ -1016,6 +1020,12 @@ "com.amazonaws.acm#ImportCertificateRequest": { "type": "structure", "members": { + "CertificateChain": { + "target": "com.amazonaws.acm#CertificateChainBlob", + "traits": { + "smithy.api#documentation": "

The PEM encoded certificate chain.

" + } + }, "CertificateArn": { "target": "com.amazonaws.acm#Arn", "traits": { @@ -1029,12 +1039,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.acm#TagList", - "traits": { - "smithy.api#documentation": "

One or more resource tags to associate with the imported certificate.

\n

Note: You cannot apply tags when reimporting a certificate.

" - } - }, "Certificate": { "target": "com.amazonaws.acm#CertificateBodyBlob", "traits": { @@ -1042,10 +1046,10 @@ "smithy.api#required": {} } }, - "CertificateChain": { - "target": "com.amazonaws.acm#CertificateChainBlob", + "Tags": { + "target": "com.amazonaws.acm#TagList", "traits": { - "smithy.api#documentation": "

The PEM encoded certificate chain.

" + "smithy.api#documentation": "

One or more resource tags to associate with the imported certificate.

\n

Note: You cannot apply tags when reimporting a certificate.

" } } } @@ -1297,6 +1301,12 @@ "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response. If additional items exist beyond the number you specify, the\n NextToken element is sent in the response. Use this NextToken\n value in a subsequent request to retrieve additional items.

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

Use this parameter only when paginating results and only in a subsequent request after you\n receive a response with truncated results. Set it to the value of NextToken from\n the response you just received.

" + } + }, "CertificateStatuses": { "target": "com.amazonaws.acm#CertificateStatuses", "traits": { @@ -1308,29 +1318,23 @@ "traits": { "smithy.api#documentation": "

Filter the certificate list. For more information, see the Filters\n structure.

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

Use this parameter only when paginating results and only in a subsequent request after you\n receive a response with truncated results. Set it to the value of NextToken from\n the response you just received.

" - } } } }, "com.amazonaws.acm#ListCertificatesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.acm#NextToken", - "traits": { - "smithy.api#documentation": "

When the list is truncated, this value is present and contains the value to use for the\n NextToken parameter in a subsequent pagination request.

" - } - }, "CertificateSummaryList": { "target": "com.amazonaws.acm#CertificateSummaryList", "traits": { "smithy.api#documentation": "

A list of ACM certificates.

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

When the list is truncated, this value is present and contains the value to use for the\n NextToken parameter in a subsequent pagination request.

" + } } } }, @@ -1554,16 +1558,10 @@ "com.amazonaws.acm#RenewalSummary": { "type": "structure", "members": { - "RenewalStatusReason": { - "target": "com.amazonaws.acm#FailureReason", - "traits": { - "smithy.api#documentation": "

The reason that a renewal request was unsuccessful.

" - } - }, - "RenewalStatus": { - "target": "com.amazonaws.acm#RenewalStatus", + "UpdatedAt": { + "target": "com.amazonaws.acm#TStamp", "traits": { - "smithy.api#documentation": "

The status of ACM's managed renewal of the certificate.

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

The time at which the renewal summary was last updated.

", "smithy.api#required": {} } }, @@ -1574,10 +1572,16 @@ "smithy.api#required": {} } }, - "UpdatedAt": { - "target": "com.amazonaws.acm#TStamp", + "RenewalStatusReason": { + "target": "com.amazonaws.acm#FailureReason", "traits": { - "smithy.api#documentation": "

The time at which the renewal summary was last updated.

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

The reason that a renewal request was unsuccessful.

" + } + }, + "RenewalStatus": { + "target": "com.amazonaws.acm#RenewalStatus", + "traits": { + "smithy.api#documentation": "

The status of ACM's managed renewal of the certificate.

", "smithy.api#required": {} } } @@ -1624,53 +1628,53 @@ "com.amazonaws.acm#RequestCertificateRequest": { "type": "structure", "members": { - "DomainValidationOptions": { - "target": "com.amazonaws.acm#DomainValidationOptionList", + "DomainName": { + "target": "com.amazonaws.acm#DomainNameString", "traits": { - "smithy.api#documentation": "

The domain name that you want ACM to use to send you emails so that you can validate\n domain ownership.

" + "smithy.api#documentation": "

Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with\n an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects\n several sites in the same domain. For example, *.example.com protects www.example.com,\n site.example.com, and images.example.com.

\n\n

The first domain name you enter cannot exceed 64 octets, including periods. Each\n subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.

", + "smithy.api#required": {} } }, - "IdempotencyToken": { - "target": "com.amazonaws.acm#IdempotencyToken", + "SubjectAlternativeNames": { + "target": "com.amazonaws.acm#DomainList", "traits": { - "smithy.api#documentation": "

Customer chosen string that can be used to distinguish between calls to\n RequestCertificate. Idempotency tokens time out after one hour. Therefore, if\n you call RequestCertificate multiple times with the same idempotency token within\n one hour, ACM recognizes that you are requesting only one certificate and will issue only\n one. If you change the idempotency token for each call, ACM recognizes that you are\n requesting multiple certificates.

" + "smithy.api#documentation": "

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM\n certificate. For example, add the name www.example.net to a certificate for which the\n DomainName field is www.example.com if users can reach your site by using\n either name. The maximum number of domain names that you can add to an ACM certificate is\n 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must\n request a quota increase. For more information, see Quotas.

\n\n

The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple\n labels separated by periods. No label can be longer than 63 octets. Consider the following\n examples:

\n\n " } }, - "ValidationMethod": { - "target": "com.amazonaws.acm#ValidationMethod", + "DomainValidationOptions": { + "target": "com.amazonaws.acm#DomainValidationOptionList", "traits": { - "smithy.api#documentation": "

The method you want to use if you are requesting a public certificate to validate that you\n own or control domain. You can validate with DNS or validate with\n email. We recommend that you use DNS validation.

" + "smithy.api#documentation": "

The domain name that you want ACM to use to send you emails so that you can validate\n domain ownership.

" } }, - "Options": { - "target": "com.amazonaws.acm#CertificateOptions", + "ValidationMethod": { + "target": "com.amazonaws.acm#ValidationMethod", "traits": { - "smithy.api#documentation": "

Currently, you can use this parameter to specify whether to add the certificate to a\n certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS\n certificates that have been mistakenly or maliciously issued. Certificates that have not been\n logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.

" + "smithy.api#documentation": "

The method you want to use if you are requesting a public certificate to validate that you\n own or control domain. You can validate with DNS or validate with\n email. We recommend that you use DNS validation.

" } }, - "Tags": { - "target": "com.amazonaws.acm#TagList", + "CertificateAuthorityArn": { + "target": "com.amazonaws.acm#Arn", "traits": { - "smithy.api#documentation": "

One or more resource tags to associate with the certificate.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used\n to issue the certificate. If you do not provide an ARN and you are trying to request a private\n certificate, ACM will attempt to issue a public certificate. For more information about\n private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:

\n\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n

" } }, - "DomainName": { - "target": "com.amazonaws.acm#DomainNameString", + "IdempotencyToken": { + "target": "com.amazonaws.acm#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with\n an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects\n several sites in the same domain. For example, *.example.com protects www.example.com,\n site.example.com, and images.example.com.

\n\n

The first domain name you enter cannot exceed 64 octets, including periods. Each\n subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.

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

Customer chosen string that can be used to distinguish between calls to\n RequestCertificate. Idempotency tokens time out after one hour. Therefore, if\n you call RequestCertificate multiple times with the same idempotency token within\n one hour, ACM recognizes that you are requesting only one certificate and will issue only\n one. If you change the idempotency token for each call, ACM recognizes that you are\n requesting multiple certificates.

" } }, - "CertificateAuthorityArn": { - "target": "com.amazonaws.acm#Arn", + "Options": { + "target": "com.amazonaws.acm#CertificateOptions", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used\n to issue the certificate. If you do not provide an ARN and you are trying to request a private\n certificate, ACM will attempt to issue a public certificate. For more information about\n private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:

\n\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n

" + "smithy.api#documentation": "

Currently, you can use this parameter to specify whether to add the certificate to a\n certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS\n certificates that have been mistakenly or maliciously issued. Certificates that have not been\n logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.

" } }, - "SubjectAlternativeNames": { - "target": "com.amazonaws.acm#DomainList", + "Tags": { + "target": "com.amazonaws.acm#TagList", "traits": { - "smithy.api#documentation": "

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM\n certificate. For example, add the name www.example.net to a certificate for which the\n DomainName field is www.example.com if users can reach your site by using\n either name. The maximum number of domain names that you can add to an ACM certificate is\n 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must\n request a quota increase. For more information, see Quotas.

\n\n

The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple\n labels separated by periods. No label can be longer than 63 octets. Consider the following\n examples:

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

One or more resource tags to associate with the certificate.

" } } } @@ -1781,17 +1785,17 @@ "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.acm#RecordType", + "Name": { + "target": "com.amazonaws.acm#String", "traits": { - "smithy.api#documentation": "

The type of DNS record. Currently this can be CNAME.

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

The name of the DNS record to create in your domain. This is supplied by ACM.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.acm#String", + "Type": { + "target": "com.amazonaws.acm#RecordType", "traits": { - "smithy.api#documentation": "

The name of the DNS record to create in your domain. This is supplied by ACM.

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

The type of DNS record. Currently this can be CNAME.

", "smithy.api#required": {} } } @@ -1856,18 +1860,18 @@ "com.amazonaws.acm#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.acm#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

" - } - }, "Key": { "target": "com.amazonaws.acm#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

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

The value of the tag.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/alexa-for-business.2017-11-09.json b/codegen/sdk-codegen/aws-models/alexa-for-business.2017-11-09.json index 523aed64b605..88e04ac27be2 100644 --- a/codegen/sdk-codegen/aws-models/alexa-for-business.2017-11-09.json +++ b/codegen/sdk-codegen/aws-models/alexa-for-business.2017-11-09.json @@ -73,17 +73,17 @@ "smithy.api#documentation": "

The description of the address book.

" } }, - "Name": { - "target": "com.amazonaws.alexaforbusiness#AddressBookName", - "traits": { - "smithy.api#documentation": "

The name of the address book.

" - } - }, "AddressBookArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { "smithy.api#documentation": "

The ARN of the address book.

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

The name of the address book.

" + } } }, "traits": { @@ -405,7 +405,7 @@ "sdkId": "Alexa For Business", "arnNamespace": "a4b", "cloudFormationName": "AlexaForBusiness", - "cloudTrailEventSource": "awsmoneypennyresourcemanagement.amazonaws.com" + "cloudTrailEventSource": "alexaforbusiness.amazonaws.com" }, "aws.auth#sigv4": { "name": "a4b" @@ -599,16 +599,16 @@ "com.amazonaws.alexaforbusiness#AssociateDeviceWithRoomRequest": { "type": "structure", "members": { - "RoomArn": { + "DeviceArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the room with which to associate the device. Required.

" + "smithy.api#documentation": "

The ARN of the device to associate to a room. Required.

" } }, - "DeviceArn": { + "RoomArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the device to associate to a room. Required.

" + "smithy.api#documentation": "

The ARN of the room with which to associate the device. Required.

" } } } @@ -637,16 +637,16 @@ "com.amazonaws.alexaforbusiness#AssociateSkillGroupWithRoomRequest": { "type": "structure", "members": { - "SkillGroupArn": { + "RoomArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the skill group to associate with a room. Required.

" + "smithy.api#documentation": "

The ARN of the room with which to associate the skill group. Required.

" } }, - "RoomArn": { + "SkillGroupArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the room with which to associate the skill group. Required.

" + "smithy.api#documentation": "

The ARN of the skill group to associate with a room. Required.

" } } } @@ -681,18 +681,18 @@ "com.amazonaws.alexaforbusiness#AssociateSkillWithSkillGroupRequest": { "type": "structure", "members": { - "SkillGroupArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the skill group to associate the skill to. Required.

" - } - }, "SkillId": { "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { "smithy.api#documentation": "

The unique identifier of the skill.

", "smithy.api#required": {} } + }, + "SkillGroupArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the skill group to associate the skill to. Required.

" + } } } }, @@ -813,16 +813,16 @@ "com.amazonaws.alexaforbusiness#BusinessReport": { "type": "structure", "members": { - "FailureCode": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportFailureCode", + "Status": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportStatus", "traits": { - "smithy.api#documentation": "

The failure code.

" + "smithy.api#documentation": "

The status of the report generation execution (RUNNING, SUCCEEDED, or\n FAILED).

" } }, - "S3Location": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportS3Location", + "FailureCode": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportFailureCode", "traits": { - "smithy.api#documentation": "

The S3 location of the output reports.

" + "smithy.api#documentation": "

The failure code.

" } }, "DeliveryTime": { @@ -837,10 +837,10 @@ "smithy.api#documentation": "

The download link where a user can download the report.

" } }, - "Status": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportStatus", + "S3Location": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportS3Location", "traits": { - "smithy.api#documentation": "

The status of the report generation execution (RUNNING, SUCCEEDED, or\n FAILED).

" + "smithy.api#documentation": "

The S3 location of the output reports.

" } } }, @@ -939,17 +939,17 @@ "com.amazonaws.alexaforbusiness#BusinessReportS3Location": { "type": "structure", "members": { - "BucketName": { - "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", - "traits": { - "smithy.api#documentation": "

The S3 bucket name of the output reports.

" - } - }, "Path": { "target": "com.amazonaws.alexaforbusiness#BusinessReportS3Path", "traits": { "smithy.api#documentation": "

The path of the business report.

" } + }, + "BucketName": { + "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", + "traits": { + "smithy.api#documentation": "

The S3 bucket name of the output reports.

" + } } }, "traits": { @@ -962,10 +962,10 @@ "com.amazonaws.alexaforbusiness#BusinessReportSchedule": { "type": "structure", "members": { - "ScheduleName": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleName", + "S3BucketName": { + "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", "traits": { - "smithy.api#documentation": "

The name identifier of the schedule.

" + "smithy.api#documentation": "

The S3 bucket name of the output reports.

" } }, "ContentRange": { @@ -974,16 +974,10 @@ "smithy.api#documentation": "

The content range of the reports.

" } }, - "S3BucketName": { - "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", - "traits": { - "smithy.api#documentation": "

The S3 bucket name of the output reports.

" - } - }, - "Recurrence": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportRecurrence", + "S3KeyPrefix": { + "target": "com.amazonaws.alexaforbusiness#S3KeyPrefix", "traits": { - "smithy.api#documentation": "

The recurrence of the reports.

" + "smithy.api#documentation": "

The S3 key where the report is delivered.

" } }, "LastBusinessReport": { @@ -992,12 +986,6 @@ "smithy.api#documentation": "

The details of the last business report delivery for a specified time\n interval.

" } }, - "S3KeyPrefix": { - "target": "com.amazonaws.alexaforbusiness#S3KeyPrefix", - "traits": { - "smithy.api#documentation": "

The S3 key where the report is delivered.

" - } - }, "ScheduleArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -1009,6 +997,18 @@ "traits": { "smithy.api#documentation": "

The format of the generated report (individual CSV files or zipped files of\n individual files).

" } + }, + "Recurrence": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportRecurrence", + "traits": { + "smithy.api#documentation": "

The recurrence of the reports.

" + } + }, + "ScheduleName": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleName", + "traits": { + "smithy.api#documentation": "

The name identifier of the schedule.

" + } } }, "traits": { @@ -1156,22 +1156,16 @@ "com.amazonaws.alexaforbusiness#ConferenceProvider": { "type": "structure", "members": { - "IPDialIn": { - "target": "com.amazonaws.alexaforbusiness#IPDialIn", - "traits": { - "smithy.api#documentation": "

The IP endpoint and protocol for calling.

" - } - }, - "Type": { - "target": "com.amazonaws.alexaforbusiness#ConferenceProviderType", + "Arn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The type of conference providers.

" + "smithy.api#documentation": "

The ARN of the newly created conference provider.

" } }, - "Name": { - "target": "com.amazonaws.alexaforbusiness#ConferenceProviderName", + "PSTNDialIn": { + "target": "com.amazonaws.alexaforbusiness#PSTNDialIn", "traits": { - "smithy.api#documentation": "

The name of the conference provider.

" + "smithy.api#documentation": "

The information for PSTN conferencing.

" } }, "MeetingSetting": { @@ -1180,16 +1174,22 @@ "smithy.api#documentation": "

The meeting settings for the conference provider.

" } }, - "PSTNDialIn": { - "target": "com.amazonaws.alexaforbusiness#PSTNDialIn", + "IPDialIn": { + "target": "com.amazonaws.alexaforbusiness#IPDialIn", "traits": { - "smithy.api#documentation": "

The information for PSTN conferencing.

" + "smithy.api#documentation": "

The IP endpoint and protocol for calling.

" } }, - "Arn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "Name": { + "target": "com.amazonaws.alexaforbusiness#ConferenceProviderName", "traits": { - "smithy.api#documentation": "

The ARN of the newly created conference provider.

" + "smithy.api#documentation": "

The name of the conference provider.

" + } + }, + "Type": { + "target": "com.amazonaws.alexaforbusiness#ConferenceProviderType", + "traits": { + "smithy.api#documentation": "

The type of conference providers.

" } } }, @@ -1281,10 +1281,16 @@ "com.amazonaws.alexaforbusiness#Contact": { "type": "structure", "members": { - "PhoneNumber": { - "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", + "FirstName": { + "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The phone number of the contact. The phone number type defaults to WORK. You can\n either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which\n lets you specify the phone number type and multiple numbers.

" + "smithy.api#documentation": "

The first name of the contact, used to call the contact on the device.

" + } + }, + "PhoneNumbers": { + "target": "com.amazonaws.alexaforbusiness#PhoneNumberList", + "traits": { + "smithy.api#documentation": "

The list of phone numbers for the contact.

" } }, "SipAddresses": { @@ -1293,10 +1299,10 @@ "smithy.api#documentation": "

The list of SIP addresses for the contact.

" } }, - "DisplayName": { - "target": "com.amazonaws.alexaforbusiness#ContactName", + "PhoneNumber": { + "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", "traits": { - "smithy.api#documentation": "

The name of the contact to display on the console.

" + "smithy.api#documentation": "

The phone number of the contact. The phone number type defaults to WORK. You can\n either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which\n lets you specify the phone number type and multiple numbers.

" } }, "ContactArn": { @@ -1305,22 +1311,16 @@ "smithy.api#documentation": "

The ARN of the contact.

" } }, - "LastName": { + "DisplayName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The last name of the contact, used to call the contact on the device.

" + "smithy.api#documentation": "

The name of the contact to display on the console.

" } }, - "FirstName": { + "LastName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The first name of the contact, used to call the contact on the device.

" - } - }, - "PhoneNumbers": { - "target": "com.amazonaws.alexaforbusiness#PhoneNumberList", - "traits": { - "smithy.api#documentation": "

The list of phone numbers for the contact.

" + "smithy.api#documentation": "

The last name of the contact, used to call the contact on the device.

" } } }, @@ -1331,22 +1331,16 @@ "com.amazonaws.alexaforbusiness#ContactData": { "type": "structure", "members": { - "PhoneNumber": { - "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number of the contact. The phone number type defaults to WORK. You can\n specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you\n specify the phone number type and multiple numbers.

" - } - }, - "DisplayName": { - "target": "com.amazonaws.alexaforbusiness#ContactName", + "PhoneNumbers": { + "target": "com.amazonaws.alexaforbusiness#PhoneNumberList", "traits": { - "smithy.api#documentation": "

The name of the contact to display on the console.

" + "smithy.api#documentation": "

The list of phone numbers for the contact.

" } }, - "LastName": { + "FirstName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The last name of the contact, used to call the contact on the device.

" + "smithy.api#documentation": "

The first name of the contact, used to call the contact on the device.

" } }, "SipAddresses": { @@ -1355,22 +1349,28 @@ "smithy.api#documentation": "

The list of SIP addresses for the contact.

" } }, - "ContactArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "PhoneNumber": { + "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", "traits": { - "smithy.api#documentation": "

The ARN of the contact.

" + "smithy.api#documentation": "

The phone number of the contact. The phone number type defaults to WORK. You can\n specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you\n specify the phone number type and multiple numbers.

" } }, - "PhoneNumbers": { - "target": "com.amazonaws.alexaforbusiness#PhoneNumberList", + "DisplayName": { + "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The list of phone numbers for the contact.

" + "smithy.api#documentation": "

The name of the contact to display on the console.

" } }, - "FirstName": { + "ContactArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the contact.

" + } + }, + "LastName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The first name of the contact, used to call the contact on the device.

" + "smithy.api#documentation": "

The last name of the contact, used to call the contact on the device.

" } } }, @@ -1449,12 +1449,6 @@ "com.amazonaws.alexaforbusiness#CreateAddressBookRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.alexaforbusiness#AddressBookDescription", - "traits": { - "smithy.api#documentation": "

The description of the address book.

" - } - }, "ClientRequestToken": { "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", "traits": { @@ -1462,6 +1456,12 @@ "smithy.api#idempotencyToken": {} } }, + "Description": { + "target": "com.amazonaws.alexaforbusiness#AddressBookDescription", + "traits": { + "smithy.api#documentation": "

The description of the address book.

" + } + }, "Name": { "target": "com.amazonaws.alexaforbusiness#AddressBookName", "traits": { @@ -1508,10 +1508,11 @@ "smithy.api#documentation": "

The S3 key where the report is delivered.

" } }, - "S3BucketName": { - "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", + "ClientRequestToken": { + "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The S3 bucket name of the output reports. If this isn't specified, the report can be\n retrieved from a download link by calling ListBusinessReportSchedule.

" + "smithy.api#documentation": "

The client request token.

", + "smithy.api#idempotencyToken": {} } }, "ContentRange": { @@ -1521,17 +1522,23 @@ "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", + "ScheduleName": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleName", "traits": { - "smithy.api#documentation": "

The client request token.

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

The name identifier of the schedule.

" } }, - "Recurrence": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportRecurrence", + "Format": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportFormat", "traits": { - "smithy.api#documentation": "

The recurrence of the reports. If this isn't specified, the report will only be\n delivered one time when the API is called.

" + "smithy.api#documentation": "

The format of the generated report (individual CSV files or zipped files of\n individual files).

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", + "traits": { + "smithy.api#documentation": "

The S3 bucket name of the output reports. If this isn't specified, the report can be\n retrieved from a download link by calling ListBusinessReportSchedule.

" } }, "Tags": { @@ -1540,17 +1547,10 @@ "smithy.api#documentation": "

The tags for the business report schedule.

" } }, - "ScheduleName": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleName", + "Recurrence": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportRecurrence", "traits": { - "smithy.api#documentation": "

The name identifier of the schedule.

" - } - }, - "Format": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportFormat", - "traits": { - "smithy.api#documentation": "

The format of the generated report (individual CSV files or zipped files of\n individual files).

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

The recurrence of the reports. If this isn't specified, the report will only be\n delivered one time when the API is called.

" } } } @@ -1586,32 +1586,25 @@ "com.amazonaws.alexaforbusiness#CreateConferenceProviderRequest": { "type": "structure", "members": { - "IPDialIn": { - "target": "com.amazonaws.alexaforbusiness#IPDialIn", - "traits": { - "smithy.api#documentation": "

The IP endpoint and protocol for calling.

" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

The request token of the client.

", - "smithy.api#idempotencyToken": {} - } - }, "PSTNDialIn": { "target": "com.amazonaws.alexaforbusiness#PSTNDialIn", "traits": { "smithy.api#documentation": "

The information for PSTN conferencing.

" } }, - "MeetingSetting": { - "target": "com.amazonaws.alexaforbusiness#MeetingSetting", + "ConferenceProviderType": { + "target": "com.amazonaws.alexaforbusiness#ConferenceProviderType", "traits": { - "smithy.api#documentation": "

The meeting settings for the conference provider.

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

Represents a type within a list of predefined types.

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

The IP endpoint and protocol for calling.

" + } + }, "ConferenceProviderName": { "target": "com.amazonaws.alexaforbusiness#ConferenceProviderName", "traits": { @@ -1619,12 +1612,19 @@ "smithy.api#required": {} } }, - "ConferenceProviderType": { - "target": "com.amazonaws.alexaforbusiness#ConferenceProviderType", + "MeetingSetting": { + "target": "com.amazonaws.alexaforbusiness#MeetingSetting", "traits": { - "smithy.api#documentation": "

Represents a type within a list of predefined types.

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

The meeting settings for the conference provider.

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

The request token of the client.

", + "smithy.api#idempotencyToken": {} + } } } }, @@ -1662,26 +1662,18 @@ "com.amazonaws.alexaforbusiness#CreateContactRequest": { "type": "structure", "members": { - "FirstName": { - "target": "com.amazonaws.alexaforbusiness#ContactName", - "traits": { - "smithy.api#documentation": "

The first name of the contact that is used to call the contact on the\n device.

", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique, user-specified identifier for this request that ensures\n idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, "PhoneNumbers": { "target": "com.amazonaws.alexaforbusiness#PhoneNumberList", "traits": { "smithy.api#documentation": "

The list of phone numbers for the contact.

" } }, + "SipAddresses": { + "target": "com.amazonaws.alexaforbusiness#SipAddressList", + "traits": { + "smithy.api#documentation": "

The list of SIP addresses for the contact.

" + } + }, "LastName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { @@ -1700,10 +1692,18 @@ "smithy.api#documentation": "

The phone number of the contact in E.164 format. The phone number type defaults to\n WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers,\n which lets you specify the phone number type and multiple numbers.

" } }, - "SipAddresses": { - "target": "com.amazonaws.alexaforbusiness#SipAddressList", + "ClientRequestToken": { + "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The list of SIP addresses for the contact.

" + "smithy.api#documentation": "

A unique, user-specified identifier for this request that ensures\n idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "FirstName": { + "target": "com.amazonaws.alexaforbusiness#ContactName", + "traits": { + "smithy.api#documentation": "

The first name of the contact that is used to call the contact on the\n device.

", + "smithy.api#required": {} } } } @@ -1722,17 +1722,17 @@ "com.amazonaws.alexaforbusiness#CreateEndOfMeetingReminder": { "type": "structure", "members": { - "ReminderType": { - "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderType", + "ReminderAtMinutes": { + "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderMinutesList", "traits": { - "smithy.api#documentation": "

The type of sound that users hear during the end of meeting reminder.

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

A range of 3 to 15 minutes that determines when the reminder begins.

", "smithy.api#required": {} } }, - "ReminderAtMinutes": { - "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderMinutesList", + "ReminderType": { + "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderType", "traits": { - "smithy.api#documentation": "

A range of 3 to 15 minutes that determines when the reminder begins.

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

The type of sound that users hear during the end of meeting reminder.

", "smithy.api#required": {} } }, @@ -1777,13 +1777,6 @@ "smithy.api#documentation": "

The description of the gateway group.

" } }, - "Name": { - "target": "com.amazonaws.alexaforbusiness#GatewayGroupName", - "traits": { - "smithy.api#documentation": "

The name of the gateway group.

", - "smithy.api#required": {} - } - }, "ClientRequestToken": { "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", "traits": { @@ -1791,6 +1784,13 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.alexaforbusiness#GatewayGroupName", + "traits": { + "smithy.api#documentation": "

The name of the gateway group.

", + "smithy.api#required": {} + } } } }, @@ -1808,17 +1808,17 @@ "com.amazonaws.alexaforbusiness#CreateInstantBooking": { "type": "structure", "members": { - "DurationInMinutes": { - "target": "com.amazonaws.alexaforbusiness#Minutes", + "Enabled": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

Duration between 15 and 240 minutes at increments of 15 that determines how long to book\n an available room when a meeting is started with Alexa.

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

Whether instant booking is enabled or not.

", "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "DurationInMinutes": { + "target": "com.amazonaws.alexaforbusiness#Minutes", "traits": { - "smithy.api#documentation": "

Whether instant booking is enabled or not.

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

Duration between 15 and 240 minutes at increments of 15 that determines how long to book\n an available room when a meeting is started with Alexa.

", "smithy.api#required": {} } } @@ -1830,12 +1830,6 @@ "com.amazonaws.alexaforbusiness#CreateMeetingRoomConfiguration": { "type": "structure", "members": { - "InstantBooking": { - "target": "com.amazonaws.alexaforbusiness#CreateInstantBooking", - "traits": { - "smithy.api#documentation": "

Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.

" - } - }, "RequireCheckIn": { "target": "com.amazonaws.alexaforbusiness#CreateRequireCheckIn", "traits": { @@ -1848,6 +1842,12 @@ "smithy.api#documentation": "

Whether room utilization metrics are enabled or not.

" } }, + "InstantBooking": { + "target": "com.amazonaws.alexaforbusiness#CreateInstantBooking", + "traits": { + "smithy.api#documentation": "

Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.

" + } + }, "EndOfMeetingReminder": { "target": "com.amazonaws.alexaforbusiness#CreateEndOfMeetingReminder" } @@ -1888,28 +1888,11 @@ "com.amazonaws.alexaforbusiness#CreateNetworkProfileRequest": { "type": "structure", "members": { - "EapMethod": { - "target": "com.amazonaws.alexaforbusiness#NetworkEapMethod", - "traits": { - "smithy.api#documentation": "

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is\n supported.

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

Detailed information about a device's network profile.

" - } - }, - "TrustAnchors": { - "target": "com.amazonaws.alexaforbusiness#TrustAnchorList", - "traits": { - "smithy.api#documentation": "

The root certificates of your authentication server that is installed on your devices\n and used to trust your authentication server during EAP negotiation.

" - } - }, - "NextPassword": { - "target": "com.amazonaws.alexaforbusiness#NextWiFiPassword", + "SecurityType": { + "target": "com.amazonaws.alexaforbusiness#NetworkSecurityType", "traits": { - "smithy.api#documentation": "

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously\n transmitted to the device and is used when the password of the network changes to\n NextPassword.

" + "smithy.api#documentation": "

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK,\n WEP, or OPEN.

", + "smithy.api#required": {} } }, "Ssid": { @@ -1919,19 +1902,19 @@ "smithy.api#required": {} } }, - "SecurityType": { - "target": "com.amazonaws.alexaforbusiness#NetworkSecurityType", - "traits": { - "smithy.api#documentation": "

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK,\n WEP, or OPEN.

", - "smithy.api#required": {} - } - }, "CertificateAuthorityArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { "smithy.api#documentation": "

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager\n (ACM). This is used to issue certificates to the devices.

" } }, + "ClientRequestToken": { + "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, "CurrentPassword": { "target": "com.amazonaws.alexaforbusiness#CurrentWiFiPassword", "traits": { @@ -1945,11 +1928,28 @@ "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", + "Description": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileDescription", "traits": { - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Detailed information about a device's network profile.

" + } + }, + "TrustAnchors": { + "target": "com.amazonaws.alexaforbusiness#TrustAnchorList", + "traits": { + "smithy.api#documentation": "

The root certificates of your authentication server that is installed on your devices\n and used to trust your authentication server during EAP negotiation.

" + } + }, + "NextPassword": { + "target": "com.amazonaws.alexaforbusiness#NextWiFiPassword", + "traits": { + "smithy.api#documentation": "

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously\n transmitted to the device and is used when the password of the network changes to\n NextPassword.

" + } + }, + "EapMethod": { + "target": "com.amazonaws.alexaforbusiness#NetworkEapMethod", + "traits": { + "smithy.api#documentation": "

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is\n supported.

" } } } @@ -1991,89 +1991,89 @@ "com.amazonaws.alexaforbusiness#CreateProfileRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.alexaforbusiness#TagList", + "MeetingRoomConfiguration": { + "target": "com.amazonaws.alexaforbusiness#CreateMeetingRoomConfiguration", "traits": { - "smithy.api#documentation": "

The tags for the profile.

" + "smithy.api#documentation": "

The meeting room settings of a room profile.

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", + "Locale": { + "target": "com.amazonaws.alexaforbusiness#DeviceLocale", "traits": { - "smithy.api#documentation": "

The user-specified token that is used during the creation of a profile.

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

The locale of the room profile. (This is currently only available to a limited preview audience.)

" } }, - "ProfileName": { - "target": "com.amazonaws.alexaforbusiness#ProfileName", + "Timezone": { + "target": "com.amazonaws.alexaforbusiness#Timezone", "traits": { - "smithy.api#documentation": "

The name of a room profile.

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

The time zone used by a room profile.

", "smithy.api#required": {} } }, - "TemperatureUnit": { - "target": "com.amazonaws.alexaforbusiness#TemperatureUnit", + "MaxVolumeLimit": { + "target": "com.amazonaws.alexaforbusiness#MaxVolumeLimit", "traits": { - "smithy.api#documentation": "

The temperature unit to be used by devices in the profile.

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

The maximum volume limit for a room profile.

" } }, - "MeetingRoomConfiguration": { - "target": "com.amazonaws.alexaforbusiness#CreateMeetingRoomConfiguration", + "ProfileName": { + "target": "com.amazonaws.alexaforbusiness#ProfileName", "traits": { - "smithy.api#documentation": "

The meeting room settings of a room profile.

" + "smithy.api#documentation": "

The name of a room profile.

", + "smithy.api#required": {} } }, - "Address": { - "target": "com.amazonaws.alexaforbusiness#Address", + "DistanceUnit": { + "target": "com.amazonaws.alexaforbusiness#DistanceUnit", "traits": { - "smithy.api#documentation": "

The valid address for the room.

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

The distance unit to be used by devices in the profile.

", "smithy.api#required": {} } }, - "PSTNEnabled": { + "SetupModeDisabled": { "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

Whether PSTN calling is enabled.

" + "smithy.api#documentation": "

Whether room profile setup is enabled.

" } }, - "Timezone": { - "target": "com.amazonaws.alexaforbusiness#Timezone", + "TemperatureUnit": { + "target": "com.amazonaws.alexaforbusiness#TemperatureUnit", "traits": { - "smithy.api#documentation": "

The time zone used by a room profile.

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

The temperature unit to be used by devices in the profile.

", "smithy.api#required": {} } }, - "Locale": { - "target": "com.amazonaws.alexaforbusiness#DeviceLocale", + "ClientRequestToken": { + "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The locale of the room profile. (This is currently only available to a limited preview audience.)

" + "smithy.api#documentation": "

The user-specified token that is used during the creation of a profile.

", + "smithy.api#idempotencyToken": {} } }, - "MaxVolumeLimit": { - "target": "com.amazonaws.alexaforbusiness#MaxVolumeLimit", + "WakeWord": { + "target": "com.amazonaws.alexaforbusiness#WakeWord", "traits": { - "smithy.api#documentation": "

The maximum volume limit for a room profile.

" + "smithy.api#documentation": "

A wake word for Alexa, Echo, Amazon, or a computer.

", + "smithy.api#required": {} } }, - "SetupModeDisabled": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "Tags": { + "target": "com.amazonaws.alexaforbusiness#TagList", "traits": { - "smithy.api#documentation": "

Whether room profile setup is enabled.

" + "smithy.api#documentation": "

The tags for the profile.

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

The distance unit to be used by devices in the profile.

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

The valid address for the room.

", "smithy.api#required": {} } }, - "WakeWord": { - "target": "com.amazonaws.alexaforbusiness#WakeWord", + "PSTNEnabled": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

A wake word for Alexa, Echo, Amazon, or a computer.

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

Whether PSTN calling is enabled.

" } } } @@ -2140,11 +2140,16 @@ "smithy.api#documentation": "

The calendar ARN for the room.

" } }, - "RoomName": { - "target": "com.amazonaws.alexaforbusiness#RoomName", + "Description": { + "target": "com.amazonaws.alexaforbusiness#RoomDescription", "traits": { - "smithy.api#documentation": "

The name for the room.

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

The description for the room.

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

The profile ARN for the room. This is required.

" } }, "ClientRequestToken": { @@ -2154,16 +2159,11 @@ "smithy.api#idempotencyToken": {} } }, - "ProfileArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The profile ARN for the room. This is required.

" - } - }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#RoomDescription", + "RoomName": { + "target": "com.amazonaws.alexaforbusiness#RoomName", "traits": { - "smithy.api#documentation": "

The description for the room.

" + "smithy.api#documentation": "

The name for the room.

", + "smithy.api#required": {} } }, "Tags": { @@ -2211,19 +2211,6 @@ "com.amazonaws.alexaforbusiness#CreateSkillGroupRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.alexaforbusiness#SkillGroupDescription", - "traits": { - "smithy.api#documentation": "

The description for the skill group.

" - } - }, - "SkillGroupName": { - "target": "com.amazonaws.alexaforbusiness#SkillGroupName", - "traits": { - "smithy.api#documentation": "

The name for the skill group.

", - "smithy.api#required": {} - } - }, "ClientRequestToken": { "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", "traits": { @@ -2236,6 +2223,19 @@ "traits": { "smithy.api#documentation": "

The tags for the skill group.

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

The description for the skill group.

" + } + }, + "SkillGroupName": { + "target": "com.amazonaws.alexaforbusiness#SkillGroupName", + "traits": { + "smithy.api#documentation": "

The name for the skill group.

", + "smithy.api#required": {} + } } } }, @@ -2276,17 +2276,10 @@ "com.amazonaws.alexaforbusiness#CreateUserRequest": { "type": "structure", "members": { - "UserId": { - "target": "com.amazonaws.alexaforbusiness#user_UserId", - "traits": { - "smithy.api#documentation": "

The ARN for the user.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.alexaforbusiness#TagList", + "Email": { + "target": "com.amazonaws.alexaforbusiness#Email", "traits": { - "smithy.api#documentation": "

The tags for the user.

" + "smithy.api#documentation": "

The email address for the user.

" } }, "ClientRequestToken": { @@ -2302,10 +2295,11 @@ "smithy.api#documentation": "

The first name for the user.

" } }, - "Email": { - "target": "com.amazonaws.alexaforbusiness#Email", + "UserId": { + "target": "com.amazonaws.alexaforbusiness#user_UserId", "traits": { - "smithy.api#documentation": "

The email address for the user.

" + "smithy.api#documentation": "

The ARN for the user.

", + "smithy.api#required": {} } }, "LastName": { @@ -2313,6 +2307,12 @@ "traits": { "smithy.api#documentation": "

The last name for the user.

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

The tags for the user.

" + } } } }, @@ -2556,17 +2556,17 @@ "com.amazonaws.alexaforbusiness#DeleteDeviceUsageDataRequest": { "type": "structure", "members": { - "DeviceArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "DeviceUsageType": { + "target": "com.amazonaws.alexaforbusiness#DeviceUsageType", "traits": { - "smithy.api#documentation": "

The ARN of the device.

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

The type of usage data to delete.

", "smithy.api#required": {} } }, - "DeviceUsageType": { - "target": "com.amazonaws.alexaforbusiness#DeviceUsageType", + "DeviceArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The type of usage data to delete.

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

The ARN of the device.

", "smithy.api#required": {} } } @@ -2738,11 +2738,10 @@ "com.amazonaws.alexaforbusiness#DeleteRoomSkillParameterRequest": { "type": "structure", "members": { - "SkillId": { - "target": "com.amazonaws.alexaforbusiness#SkillId", + "RoomArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ID of the skill from which to remove the room skill parameter details.

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

The ARN of the room from which to remove the room skill parameter details.

" } }, "ParameterKey": { @@ -2752,10 +2751,11 @@ "smithy.api#required": {} } }, - "RoomArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "SkillId": { + "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { - "smithy.api#documentation": "

The ARN of the room from which to remove the room skill parameter details.

" + "smithy.api#documentation": "

The ID of the skill from which to remove the room skill parameter details.

", + "smithy.api#required": {} } } } @@ -2787,18 +2787,18 @@ "com.amazonaws.alexaforbusiness#DeleteSkillAuthorizationRequest": { "type": "structure", "members": { + "RoomArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The room that the skill is authorized for.

" + } + }, "SkillId": { "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { "smithy.api#documentation": "

The unique identifier of a skill.

", "smithy.api#required": {} } - }, - "RoomArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The room that the skill is authorized for.

" - } } } }, @@ -2864,18 +2864,18 @@ "com.amazonaws.alexaforbusiness#DeleteUserRequest": { "type": "structure", "members": { + "UserArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the user to delete in the organization. Required.

" + } + }, "EnrollmentId": { "target": "com.amazonaws.alexaforbusiness#EnrollmentId", "traits": { "smithy.api#documentation": "

The ARN of the user's enrollment in the organization. Required.

", "smithy.api#required": {} } - }, - "UserArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the user to delete in the organization. Required.

" - } } } }, @@ -2886,16 +2886,10 @@ "com.amazonaws.alexaforbusiness#DeveloperInfo": { "type": "structure", "members": { - "Email": { - "target": "com.amazonaws.alexaforbusiness#Email", - "traits": { - "smithy.api#documentation": "

The email of the developer.

" - } - }, - "DeveloperName": { - "target": "com.amazonaws.alexaforbusiness#DeveloperName", + "Url": { + "target": "com.amazonaws.alexaforbusiness#Url", "traits": { - "smithy.api#documentation": "

The name of the developer.

" + "smithy.api#documentation": "

The website of the developer.

" } }, "PrivacyPolicy": { @@ -2904,10 +2898,16 @@ "smithy.api#documentation": "

The URL of the privacy policy.

" } }, - "Url": { - "target": "com.amazonaws.alexaforbusiness#Url", + "Email": { + "target": "com.amazonaws.alexaforbusiness#Email", "traits": { - "smithy.api#documentation": "

The website of the developer.

" + "smithy.api#documentation": "

The email of the developer.

" + } + }, + "DeveloperName": { + "target": "com.amazonaws.alexaforbusiness#DeveloperName", + "traits": { + "smithy.api#documentation": "

The name of the developer.

" } } }, @@ -2933,52 +2933,52 @@ "smithy.api#documentation": "

The serial number of a device.

" } }, - "DeviceStatus": { - "target": "com.amazonaws.alexaforbusiness#DeviceStatus", + "DeviceStatusInfo": { + "target": "com.amazonaws.alexaforbusiness#DeviceStatusInfo", "traits": { - "smithy.api#documentation": "

The status of a device. If the status is not READY, check the DeviceStatusInfo value\n for details.

" + "smithy.api#documentation": "

Detailed information about a device's status.

" } }, - "DeviceName": { - "target": "com.amazonaws.alexaforbusiness#DeviceName", + "NetworkProfileInfo": { + "target": "com.amazonaws.alexaforbusiness#DeviceNetworkProfileInfo", "traits": { - "smithy.api#documentation": "

The name of a device.

" + "smithy.api#documentation": "

Detailed information about a device's network profile.

" } }, - "MacAddress": { - "target": "com.amazonaws.alexaforbusiness#MacAddress", + "SoftwareVersion": { + "target": "com.amazonaws.alexaforbusiness#SoftwareVersion", "traits": { - "smithy.api#documentation": "

The MAC address of a device.

" + "smithy.api#documentation": "

The software version of a device.

" } }, - "DeviceStatusInfo": { - "target": "com.amazonaws.alexaforbusiness#DeviceStatusInfo", + "DeviceType": { + "target": "com.amazonaws.alexaforbusiness#DeviceType", "traits": { - "smithy.api#documentation": "

Detailed information about a device's status.

" + "smithy.api#documentation": "

The type of a device.

" } }, - "RoomArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "DeviceName": { + "target": "com.amazonaws.alexaforbusiness#DeviceName", "traits": { - "smithy.api#documentation": "

The room ARN of a device.

" + "smithy.api#documentation": "

The name of a device.

" } }, - "DeviceType": { - "target": "com.amazonaws.alexaforbusiness#DeviceType", + "MacAddress": { + "target": "com.amazonaws.alexaforbusiness#MacAddress", "traits": { - "smithy.api#documentation": "

The type of a device.

" + "smithy.api#documentation": "

The MAC address of a device.

" } }, - "SoftwareVersion": { - "target": "com.amazonaws.alexaforbusiness#SoftwareVersion", + "RoomArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The software version of a device.

" + "smithy.api#documentation": "

The room ARN of a device.

" } }, - "NetworkProfileInfo": { - "target": "com.amazonaws.alexaforbusiness#DeviceNetworkProfileInfo", + "DeviceStatus": { + "target": "com.amazonaws.alexaforbusiness#DeviceStatus", "traits": { - "smithy.api#documentation": "

Detailed information about a device's network profile.

" + "smithy.api#documentation": "

The status of a device. If the status is not READY, check the DeviceStatusInfo value\n for details.

" } } }, @@ -2989,28 +2989,16 @@ "com.amazonaws.alexaforbusiness#DeviceData": { "type": "structure", "members": { - "RoomName": { - "target": "com.amazonaws.alexaforbusiness#DeviceRoomName", - "traits": { - "smithy.api#documentation": "

The name of the room associated with a device.

" - } - }, - "RoomArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The room ARN associated with a device.

" - } - }, - "DeviceStatusInfo": { - "target": "com.amazonaws.alexaforbusiness#DeviceStatusInfo", + "MacAddress": { + "target": "com.amazonaws.alexaforbusiness#MacAddress", "traits": { - "smithy.api#documentation": "

Detailed information about a device's status.

" + "smithy.api#documentation": "

The MAC address of a device.

" } }, - "DeviceName": { - "target": "com.amazonaws.alexaforbusiness#DeviceName", + "CreatedTime": { + "target": "com.amazonaws.alexaforbusiness#DeviceDataCreatedTime", "traits": { - "smithy.api#documentation": "

The name of a device.

" + "smithy.api#documentation": "

The time (in epoch) when the device data was created.

" } }, "DeviceStatus": { @@ -3019,34 +3007,28 @@ "smithy.api#documentation": "

The status of a device.

" } }, - "DeviceArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of a device.

" - } - }, - "NetworkProfileName": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", + "RoomName": { + "target": "com.amazonaws.alexaforbusiness#DeviceRoomName", "traits": { - "smithy.api#documentation": "

The name of the network profile associated with a device.

" + "smithy.api#documentation": "

The name of the room associated with a device.

" } }, - "DeviceType": { - "target": "com.amazonaws.alexaforbusiness#DeviceType", + "DeviceName": { + "target": "com.amazonaws.alexaforbusiness#DeviceName", "traits": { - "smithy.api#documentation": "

The type of a device.

" + "smithy.api#documentation": "

The name of a device.

" } }, - "SoftwareVersion": { - "target": "com.amazonaws.alexaforbusiness#SoftwareVersion", + "RoomArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The software version of a device.

" + "smithy.api#documentation": "

The room ARN associated with a device.

" } }, - "CreatedTime": { - "target": "com.amazonaws.alexaforbusiness#DeviceDataCreatedTime", + "DeviceStatusInfo": { + "target": "com.amazonaws.alexaforbusiness#DeviceStatusInfo", "traits": { - "smithy.api#documentation": "

The time (in epoch) when the device data was created.

" + "smithy.api#documentation": "

Detailed information about a device's status.

" } }, "DeviceSerialNumber": { @@ -3055,10 +3037,10 @@ "smithy.api#documentation": "

The serial number of a device.

" } }, - "MacAddress": { - "target": "com.amazonaws.alexaforbusiness#MacAddress", + "DeviceArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The MAC address of a device.

" + "smithy.api#documentation": "

The ARN of a device.

" } }, "NetworkProfileArn": { @@ -3066,6 +3048,24 @@ "traits": { "smithy.api#documentation": "

The ARN of the network profile associated with a device.

" } + }, + "SoftwareVersion": { + "target": "com.amazonaws.alexaforbusiness#SoftwareVersion", + "traits": { + "smithy.api#documentation": "

The software version of a device.

" + } + }, + "DeviceType": { + "target": "com.amazonaws.alexaforbusiness#DeviceType", + "traits": { + "smithy.api#documentation": "

The type of a device.

" + } + }, + "NetworkProfileName": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", + "traits": { + "smithy.api#documentation": "

The name of the network profile associated with a device.

" + } } }, "traits": { @@ -3084,10 +3084,10 @@ "com.amazonaws.alexaforbusiness#DeviceEvent": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.alexaforbusiness#DeviceEventType", + "Value": { + "target": "com.amazonaws.alexaforbusiness#DeviceEventValue", "traits": { - "smithy.api#documentation": "

The type of device event.

" + "smithy.api#documentation": "

The value of the event.

" } }, "Timestamp": { @@ -3096,10 +3096,10 @@ "smithy.api#documentation": "

The time (in epoch) when the event occurred.

" } }, - "Value": { - "target": "com.amazonaws.alexaforbusiness#DeviceEventValue", + "Type": { + "target": "com.amazonaws.alexaforbusiness#DeviceEventType", "traits": { - "smithy.api#documentation": "

The value of the event.

" + "smithy.api#documentation": "

The type of device event.

" } } }, @@ -3156,6 +3156,12 @@ "com.amazonaws.alexaforbusiness#DeviceNetworkProfileInfo": { "type": "structure", "members": { + "CertificateArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the certificate associated with a device.

" + } + }, "NetworkProfileArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -3167,12 +3173,6 @@ "traits": { "smithy.api#documentation": "

The time (in epoch) when the certificate expires.

" } - }, - "CertificateArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the certificate associated with a device.

" - } } }, "traits": { @@ -3243,17 +3243,17 @@ "com.amazonaws.alexaforbusiness#DeviceStatusDetail": { "type": "structure", "members": { - "Feature": { - "target": "com.amazonaws.alexaforbusiness#Feature", - "traits": { - "smithy.api#documentation": "

The list of available features on the device.

" - } - }, "Code": { "target": "com.amazonaws.alexaforbusiness#DeviceStatusDetailCode", "traits": { "smithy.api#documentation": "

The device status detail code.

" } + }, + "Feature": { + "target": "com.amazonaws.alexaforbusiness#Feature", + "traits": { + "smithy.api#documentation": "

The list of available features on the device.

" + } } }, "traits": { @@ -3344,18 +3344,18 @@ "com.amazonaws.alexaforbusiness#DeviceStatusInfo": { "type": "structure", "members": { - "ConnectionStatusUpdatedTime": { - "target": "com.amazonaws.alexaforbusiness#ConnectionStatusUpdatedTime", - "traits": { - "smithy.api#documentation": "

The time (in epoch) when the device connection status changed.

" - } - }, "ConnectionStatus": { "target": "com.amazonaws.alexaforbusiness#ConnectionStatus", "traits": { "smithy.api#documentation": "

The latest available information about the connection status of a device.

" } }, + "ConnectionStatusUpdatedTime": { + "target": "com.amazonaws.alexaforbusiness#ConnectionStatusUpdatedTime", + "traits": { + "smithy.api#documentation": "

The time (in epoch) when the device connection status changed.

" + } + }, "DeviceStatusDetails": { "target": "com.amazonaws.alexaforbusiness#DeviceStatusDetails", "traits": { @@ -3477,18 +3477,18 @@ "com.amazonaws.alexaforbusiness#DisassociateSkillFromSkillGroupRequest": { "type": "structure", "members": { + "SkillGroupArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The unique identifier of a skill. Required.

" + } + }, "SkillId": { "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { "smithy.api#documentation": "

The ARN of a skill group to associate to a skill.

", "smithy.api#required": {} } - }, - "SkillGroupArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The unique identifier of a skill. Required.

" - } } } }, @@ -3552,16 +3552,16 @@ "com.amazonaws.alexaforbusiness#DisassociateSkillGroupFromRoomRequest": { "type": "structure", "members": { - "SkillGroupArn": { + "RoomArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the skill group to disassociate from a room. Required.

" + "smithy.api#documentation": "

The ARN of the room from which the skill group is to be disassociated.\n Required.

" } }, - "RoomArn": { + "SkillGroupArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the room from which the skill group is to be disassociated.\n Required.

" + "smithy.api#documentation": "

The ARN of the skill group to disassociate from a room. Required.

" } } } @@ -3628,6 +3628,12 @@ "com.amazonaws.alexaforbusiness#EndOfMeetingReminder": { "type": "structure", "members": { + "ReminderAtMinutes": { + "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderMinutesList", + "traits": { + "smithy.api#documentation": "

A range of 3 to 15 minutes that determines when the reminder begins.

" + } + }, "Enabled": { "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { @@ -3639,12 +3645,6 @@ "traits": { "smithy.api#documentation": "

The type of sound that users hear during the end of meeting reminder.

" } - }, - "ReminderAtMinutes": { - "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderMinutesList", - "traits": { - "smithy.api#documentation": "

A range of 3 to 15 minutes that determines when the reminder begins.

" - } } }, "traits": { @@ -3785,17 +3785,17 @@ "com.amazonaws.alexaforbusiness#Filter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.alexaforbusiness#FilterValueList", + "Key": { + "target": "com.amazonaws.alexaforbusiness#FilterKey", "traits": { - "smithy.api#documentation": "

The values of a filter.

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

The key of a filter.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.alexaforbusiness#FilterKey", + "Values": { + "target": "com.amazonaws.alexaforbusiness#FilterValueList", "traits": { - "smithy.api#documentation": "

The key of a filter.

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

The values of a filter.

", "smithy.api#required": {} } } @@ -3882,10 +3882,10 @@ "com.amazonaws.alexaforbusiness#Gateway": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "SoftwareVersion": { + "target": "com.amazonaws.alexaforbusiness#GatewayVersion", "traits": { - "smithy.api#documentation": "

The ARN of the gateway.

" + "smithy.api#documentation": "

The software version of the gateway. The gateway automatically updates its software\n version during normal operation.

" } }, "Description": { @@ -3900,10 +3900,10 @@ "smithy.api#documentation": "

The ARN of the gateway group that the gateway is associated to.

" } }, - "SoftwareVersion": { - "target": "com.amazonaws.alexaforbusiness#GatewayVersion", + "Arn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The software version of the gateway. The gateway automatically updates its software\n version during normal operation.

" + "smithy.api#documentation": "

The ARN of the gateway.

" } }, "Name": { @@ -3930,18 +3930,18 @@ "com.amazonaws.alexaforbusiness#GatewayGroup": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.alexaforbusiness#GatewayGroupDescription", - "traits": { - "smithy.api#documentation": "

The description of the gateway group.

" - } - }, "Name": { "target": "com.amazonaws.alexaforbusiness#GatewayGroupName", "traits": { "smithy.api#documentation": "

The name of the gateway group.

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

The description of the gateway group.

" + } + }, "Arn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -3981,10 +3981,10 @@ "com.amazonaws.alexaforbusiness#GatewayGroupSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.alexaforbusiness#GatewayGroupName", + "Description": { + "target": "com.amazonaws.alexaforbusiness#GatewayGroupDescription", "traits": { - "smithy.api#documentation": "

The name of the gateway group.

" + "smithy.api#documentation": "

The description of the gateway group.

" } }, "Arn": { @@ -3993,10 +3993,10 @@ "smithy.api#documentation": "

The ARN of the gateway group.

" } }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#GatewayGroupDescription", + "Name": { + "target": "com.amazonaws.alexaforbusiness#GatewayGroupName", "traits": { - "smithy.api#documentation": "

The description of the gateway group.

" + "smithy.api#documentation": "

The name of the gateway group.

" } } }, @@ -4023,10 +4023,10 @@ "com.amazonaws.alexaforbusiness#GatewaySummary": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.alexaforbusiness#GatewayDescription", + "SoftwareVersion": { + "target": "com.amazonaws.alexaforbusiness#GatewayVersion", "traits": { - "smithy.api#documentation": "

The description of the gateway.

" + "smithy.api#documentation": "

The software version of the gateway. The gateway automatically updates its software\n version during normal operation.

" } }, "Arn": { @@ -4047,10 +4047,10 @@ "smithy.api#documentation": "

The name of the gateway.

" } }, - "SoftwareVersion": { - "target": "com.amazonaws.alexaforbusiness#GatewayVersion", + "Description": { + "target": "com.amazonaws.alexaforbusiness#GatewayDescription", "traits": { - "smithy.api#documentation": "

The software version of the gateway. The gateway automatically updates its software\n version during normal operation.

" + "smithy.api#documentation": "

The description of the gateway.

" } } }, @@ -4368,10 +4368,10 @@ "com.amazonaws.alexaforbusiness#GetInvitationConfigurationResponse": { "type": "structure", "members": { - "ContactEmail": { - "target": "com.amazonaws.alexaforbusiness#Email", + "OrganizationName": { + "target": "com.amazonaws.alexaforbusiness#OrganizationName", "traits": { - "smithy.api#documentation": "

The email ID of the organization or individual contact that the enrolled user can use.\n

" + "smithy.api#documentation": "

The name of the organization sending the enrollment invite to a user.

" } }, "PrivateSkillIds": { @@ -4380,10 +4380,10 @@ "smithy.api#documentation": "

The list of private skill IDs that you want to recommend to the user to enable in the\n invitation.

" } }, - "OrganizationName": { - "target": "com.amazonaws.alexaforbusiness#OrganizationName", + "ContactEmail": { + "target": "com.amazonaws.alexaforbusiness#Email", "traits": { - "smithy.api#documentation": "

The name of the organization sending the enrollment invite to a user.

" + "smithy.api#documentation": "

The email ID of the organization or individual contact that the enrolled user can use.\n

" } } } @@ -4529,13 +4529,6 @@ "com.amazonaws.alexaforbusiness#GetRoomSkillParameterRequest": { "type": "structure", "members": { - "ParameterKey": { - "target": "com.amazonaws.alexaforbusiness#RoomSkillParameterKey", - "traits": { - "smithy.api#documentation": "

The room skill parameter key for which to get details. Required.

", - "smithy.api#required": {} - } - }, "SkillId": { "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { @@ -4548,6 +4541,13 @@ "traits": { "smithy.api#documentation": "

The ARN of the room from which to get the room skill parameter details.

" } + }, + "ParameterKey": { + "target": "com.amazonaws.alexaforbusiness#RoomSkillParameterKey", + "traits": { + "smithy.api#documentation": "

The room skill parameter key for which to get details. Required.

", + "smithy.api#required": {} + } } } }, @@ -4604,17 +4604,17 @@ "com.amazonaws.alexaforbusiness#IPDialIn": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.alexaforbusiness#Endpoint", + "CommsProtocol": { + "target": "com.amazonaws.alexaforbusiness#CommsProtocol", "traits": { - "smithy.api#documentation": "

The IP address.

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

The protocol, including SIP, SIPS, and H323.

", "smithy.api#required": {} } }, - "CommsProtocol": { - "target": "com.amazonaws.alexaforbusiness#CommsProtocol", + "Endpoint": { + "target": "com.amazonaws.alexaforbusiness#Endpoint", "traits": { - "smithy.api#documentation": "

The protocol, including SIP, SIPS, and H323.

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

The IP address.

", "smithy.api#required": {} } } @@ -4766,17 +4766,17 @@ "com.amazonaws.alexaforbusiness#ListBusinessReportSchedulesResponse": { "type": "structure", "members": { - "BusinessReportSchedules": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleList", - "traits": { - "smithy.api#documentation": "

The schedule of the reports.

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

The token used to list the remaining schedules from the previous API call.

" } + }, + "BusinessReportSchedules": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleList", + "traits": { + "smithy.api#documentation": "

The schedule of the reports.

" + } } } }, @@ -4800,17 +4800,17 @@ "com.amazonaws.alexaforbusiness#ListConferenceProvidersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", - "traits": { - "smithy.api#documentation": "

The tokens used for pagination.

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

The maximum number of conference providers to be returned, per paginated\n calls.

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

The tokens used for pagination.

" + } } } }, @@ -4856,22 +4856,16 @@ "com.amazonaws.alexaforbusiness#ListDeviceEventsRequest": { "type": "structure", "members": { - "EventType": { - "target": "com.amazonaws.alexaforbusiness#DeviceEventType", - "traits": { - "smithy.api#documentation": "

The event type to filter device events. If EventType isn't specified, this returns a\n list of all device events in reverse chronological order. If EventType is specified, this\n returns a list of device events for that EventType in reverse chronological order.\n

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

The maximum number of results to include in the response. The default value is 50. If\n more results exist than the specified MaxResults value, a token is included in the response\n so that the remaining results can be retrieved.

" } }, - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", + "EventType": { + "target": "com.amazonaws.alexaforbusiness#DeviceEventType", "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response only includes\n results beyond the token, up to the value specified by MaxResults. When the end of results\n is reached, the response has a value of null.

" + "smithy.api#documentation": "

The event type to filter device events. If EventType isn't specified, this returns a\n list of all device events in reverse chronological order. If EventType is specified, this\n returns a list of device events for that EventType in reverse chronological order.\n

" } }, "DeviceArn": { @@ -4880,6 +4874,12 @@ "smithy.api#documentation": "

The ARN of a device.

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

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response only includes\n results beyond the token, up to the value specified by MaxResults. When the end of results\n is reached, the response has a value of null.

" + } } } }, @@ -4920,34 +4920,34 @@ "com.amazonaws.alexaforbusiness#ListGatewayGroupsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to paginate though multiple pages of gateway group summaries.

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

The maximum number of gateway group summaries to return. The default is 50.

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

The token used to paginate though multiple pages of gateway group summaries.

" + } } } }, "com.amazonaws.alexaforbusiness#ListGatewayGroupsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to paginate though multiple pages of gateway group summaries.

" - } - }, "GatewayGroups": { "target": "com.amazonaws.alexaforbusiness#GatewayGroupSummaries", "traits": { "smithy.api#documentation": "

The gateway groups in the list.

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

The token used to paginate though multiple pages of gateway group summaries.

" + } } } }, @@ -4971,6 +4971,12 @@ "com.amazonaws.alexaforbusiness#ListGatewaysRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.alexaforbusiness#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of gateway summaries to return. The default is 50.

" + } + }, "NextToken": { "target": "com.amazonaws.alexaforbusiness#NextToken", "traits": { @@ -4982,12 +4988,6 @@ "traits": { "smithy.api#documentation": "

The gateway group ARN for which to list gateways.

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

The maximum number of gateway summaries to return. The default is 50.

" - } } } }, @@ -5028,12 +5028,24 @@ "com.amazonaws.alexaforbusiness#ListSkillsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.alexaforbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

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

The ARN of the skill group for which to list enabled skills.

" } }, + "MaxResults": { + "target": "com.amazonaws.alexaforbusiness#SkillListMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" + } + }, "SkillType": { "target": "com.amazonaws.alexaforbusiness#SkillTypeFilter", "traits": { @@ -5045,18 +5057,6 @@ "traits": { "smithy.api#documentation": "

Whether the skill is enabled under the user's account.

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

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.alexaforbusiness#SkillListMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" - } } } }, @@ -5148,6 +5148,12 @@ "com.amazonaws.alexaforbusiness#ListSkillsStoreSkillsByCategoryRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.alexaforbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

The tokens used for pagination.

" + } + }, "CategoryId": { "target": "com.amazonaws.alexaforbusiness#CategoryId", "traits": { @@ -5155,12 +5161,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", - "traits": { - "smithy.api#documentation": "

The tokens used for pagination.

" - } - }, "MaxResults": { "target": "com.amazonaws.alexaforbusiness#SkillListMaxResults", "traits": { @@ -5172,17 +5172,17 @@ "com.amazonaws.alexaforbusiness#ListSkillsStoreSkillsByCategoryResponse": { "type": "structure", "members": { - "SkillsStoreSkills": { - "target": "com.amazonaws.alexaforbusiness#SkillsStoreSkillList", - "traits": { - "smithy.api#documentation": "

The skill store skills.

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

The tokens used for pagination.

" } + }, + "SkillsStoreSkills": { + "target": "com.amazonaws.alexaforbusiness#SkillsStoreSkillList", + "traits": { + "smithy.api#documentation": "

The skill store skills.

" + } } } }, @@ -5235,17 +5235,17 @@ "com.amazonaws.alexaforbusiness#ListSmartHomeAppliancesResponse": { "type": "structure", "members": { - "SmartHomeAppliances": { - "target": "com.amazonaws.alexaforbusiness#SmartHomeApplianceList", - "traits": { - "smithy.api#documentation": "

The smart home appliances.

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

The tokens used for pagination.

" } + }, + "SmartHomeAppliances": { + "target": "com.amazonaws.alexaforbusiness#SmartHomeApplianceList", + "traits": { + "smithy.api#documentation": "

The smart home appliances.

" + } } } }, @@ -5274,6 +5274,13 @@ "com.amazonaws.alexaforbusiness#ListTagsRequest": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specified resource for which to list tags.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.alexaforbusiness#NextToken", "traits": { @@ -5285,13 +5292,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" } - }, - "Arn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specified resource for which to list tags.

", - "smithy.api#required": {} - } } } }, @@ -5345,18 +5345,6 @@ "com.amazonaws.alexaforbusiness#MeetingRoomConfiguration": { "type": "structure", "members": { - "InstantBooking": { - "target": "com.amazonaws.alexaforbusiness#InstantBooking", - "traits": { - "smithy.api#documentation": "

Settings to automatically book the room if available for a configured duration when\n joining a meeting with Alexa.

" - } - }, - "RoomUtilizationMetricsEnabled": { - "target": "com.amazonaws.alexaforbusiness#Boolean", - "traits": { - "smithy.api#documentation": "

Whether room utilization metrics are enabled or not.

" - } - }, "RequireCheckIn": { "target": "com.amazonaws.alexaforbusiness#RequireCheckIn", "traits": { @@ -5368,6 +5356,18 @@ "traits": { "smithy.api#documentation": "

Settings for the end of meeting reminder feature that are applied to a room profile. The\n end of meeting reminder enables Alexa to remind users when a meeting is ending.

" } + }, + "RoomUtilizationMetricsEnabled": { + "target": "com.amazonaws.alexaforbusiness#Boolean", + "traits": { + "smithy.api#documentation": "

Whether room utilization metrics are enabled or not.

" + } + }, + "InstantBooking": { + "target": "com.amazonaws.alexaforbusiness#InstantBooking", + "traits": { + "smithy.api#documentation": "

Settings to automatically book the room if available for a configured duration when\n joining a meeting with Alexa.

" + } } }, "traits": { @@ -5421,28 +5421,28 @@ "com.amazonaws.alexaforbusiness#NetworkProfile": { "type": "structure", "members": { - "TrustAnchors": { - "target": "com.amazonaws.alexaforbusiness#TrustAnchorList", + "CertificateAuthorityArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The root certificates of your authentication server, which is installed on your devices\n and used to trust your authentication server during EAP negotiation.

" + "smithy.api#documentation": "

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager\n (ACM). This is used to issue certificates to the devices.

" } }, - "EapMethod": { - "target": "com.amazonaws.alexaforbusiness#NetworkEapMethod", + "SecurityType": { + "target": "com.amazonaws.alexaforbusiness#NetworkSecurityType", "traits": { - "smithy.api#documentation": "

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is\n supported.

" + "smithy.api#documentation": "

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK,\n WEP, or OPEN.

" } }, - "NextPassword": { - "target": "com.amazonaws.alexaforbusiness#NextWiFiPassword", + "TrustAnchors": { + "target": "com.amazonaws.alexaforbusiness#TrustAnchorList", "traits": { - "smithy.api#documentation": "

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously\n transmitted to the device and is used when the password of the network changes to\n NextPassword.

" + "smithy.api#documentation": "

The root certificates of your authentication server, which is installed on your devices\n and used to trust your authentication server during EAP negotiation.

" } }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileDescription", + "NextPassword": { + "target": "com.amazonaws.alexaforbusiness#NextWiFiPassword", "traits": { - "smithy.api#documentation": "

Detailed information about a device's network profile.

" + "smithy.api#documentation": "

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously\n transmitted to the device and is used when the password of the network changes to\n NextPassword.

" } }, "CurrentPassword": { @@ -5451,34 +5451,34 @@ "smithy.api#documentation": "

The current password of the Wi-Fi network.

" } }, - "NetworkProfileName": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", + "Ssid": { + "target": "com.amazonaws.alexaforbusiness#NetworkSsid", "traits": { - "smithy.api#documentation": "

The name of the network profile associated with a device.

" + "smithy.api#documentation": "

The SSID of the Wi-Fi network.

" } }, - "NetworkProfileArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "EapMethod": { + "target": "com.amazonaws.alexaforbusiness#NetworkEapMethod", "traits": { - "smithy.api#documentation": "

The ARN of the network profile associated with a device.

" + "smithy.api#documentation": "

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is\n supported.

" } }, - "SecurityType": { - "target": "com.amazonaws.alexaforbusiness#NetworkSecurityType", + "NetworkProfileArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK,\n WEP, or OPEN.

" + "smithy.api#documentation": "

The ARN of the network profile associated with a device.

" } }, - "Ssid": { - "target": "com.amazonaws.alexaforbusiness#NetworkSsid", + "Description": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileDescription", "traits": { - "smithy.api#documentation": "

The SSID of the Wi-Fi network.

" + "smithy.api#documentation": "

Detailed information about a device's network profile.

" } }, - "CertificateAuthorityArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "NetworkProfileName": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", "traits": { - "smithy.api#documentation": "

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager\n (ACM). This is used to issue certificates to the devices.

" + "smithy.api#documentation": "

The name of the network profile associated with a device.

" } } }, @@ -5489,28 +5489,28 @@ "com.amazonaws.alexaforbusiness#NetworkProfileData": { "type": "structure", "members": { - "Ssid": { - "target": "com.amazonaws.alexaforbusiness#NetworkSsid", + "EapMethod": { + "target": "com.amazonaws.alexaforbusiness#NetworkEapMethod", "traits": { - "smithy.api#documentation": "

The SSID of the Wi-Fi network.

" + "smithy.api#documentation": "

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is\n supported.

" } }, - "NetworkProfileArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "NetworkProfileName": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", "traits": { - "smithy.api#documentation": "

The ARN of the network profile associated with a device.

" + "smithy.api#documentation": "

The name of the network profile associated with a device.

" } }, - "EapMethod": { - "target": "com.amazonaws.alexaforbusiness#NetworkEapMethod", + "Ssid": { + "target": "com.amazonaws.alexaforbusiness#NetworkSsid", "traits": { - "smithy.api#documentation": "

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is\n supported.

" + "smithy.api#documentation": "

The SSID of the Wi-Fi network.

" } }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileDescription", + "CertificateAuthorityArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

Detailed information about a device's network profile.

" + "smithy.api#documentation": "

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager\n (ACM). This is used to issue certificates to the devices.

" } }, "SecurityType": { @@ -5519,16 +5519,16 @@ "smithy.api#documentation": "

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK,\n WEP, or OPEN.

" } }, - "CertificateAuthorityArn": { + "NetworkProfileArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager\n (ACM). This is used to issue certificates to the devices.

" + "smithy.api#documentation": "

The ARN of the network profile associated with a device.

" } }, - "NetworkProfileName": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", + "Description": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileDescription", "traits": { - "smithy.api#documentation": "

The name of the network profile associated with a device.

" + "smithy.api#documentation": "

Detailed information about a device's network profile.

" } } }, @@ -5674,13 +5674,6 @@ "com.amazonaws.alexaforbusiness#PSTNDialIn": { "type": "structure", "members": { - "OneClickPinDelay": { - "target": "com.amazonaws.alexaforbusiness#OneClickPinDelay", - "traits": { - "smithy.api#documentation": "

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

", - "smithy.api#required": {} - } - }, "PhoneNumber": { "target": "com.amazonaws.alexaforbusiness#OutboundPhoneNumber", "traits": { @@ -5688,10 +5681,10 @@ "smithy.api#required": {} } }, - "CountryCode": { - "target": "com.amazonaws.alexaforbusiness#CountryCode", + "OneClickPinDelay": { + "target": "com.amazonaws.alexaforbusiness#OneClickPinDelay", "traits": { - "smithy.api#documentation": "

The zip code.

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

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

", "smithy.api#required": {} } }, @@ -5701,6 +5694,13 @@ "smithy.api#documentation": "

The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

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

The zip code.

", + "smithy.api#required": {} + } } }, "traits": { @@ -5710,17 +5710,17 @@ "com.amazonaws.alexaforbusiness#PhoneNumber": { "type": "structure", "members": { - "Number": { - "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", + "Type": { + "target": "com.amazonaws.alexaforbusiness#PhoneNumberType", "traits": { - "smithy.api#documentation": "

The raw value of the phone number.

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

The type of the phone number.

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.alexaforbusiness#PhoneNumberType", + "Number": { + "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", "traits": { - "smithy.api#documentation": "

The type of the phone number.

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

The raw value of the phone number.

", "smithy.api#required": {} } } @@ -5776,34 +5776,34 @@ "com.amazonaws.alexaforbusiness#Profile": { "type": "structure", "members": { - "Timezone": { - "target": "com.amazonaws.alexaforbusiness#Timezone", + "DistanceUnit": { + "target": "com.amazonaws.alexaforbusiness#DistanceUnit", "traits": { - "smithy.api#documentation": "

The time zone of a room profile.

" + "smithy.api#documentation": "

The distance unit of a room profile.

" } }, - "IsDefault": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "AddressBookArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

Retrieves if the profile is default or not.

" + "smithy.api#documentation": "

The ARN of the address book.

" } }, - "Locale": { - "target": "com.amazonaws.alexaforbusiness#DeviceLocale", + "MeetingRoomConfiguration": { + "target": "com.amazonaws.alexaforbusiness#MeetingRoomConfiguration", "traits": { - "smithy.api#documentation": "

The locale of a room profile. (This is currently available only to a limited preview\n audience.)

" + "smithy.api#documentation": "

Meeting room settings of a room profile.

" } }, - "WakeWord": { - "target": "com.amazonaws.alexaforbusiness#WakeWord", + "ProfileName": { + "target": "com.amazonaws.alexaforbusiness#ProfileName", "traits": { - "smithy.api#documentation": "

The wake word of a room profile.

" + "smithy.api#documentation": "

The name of a room profile.

" } }, - "ProfileArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "SetupModeDisabled": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

The ARN of a room profile.

" + "smithy.api#documentation": "

The setup mode of a room profile.

" } }, "TemperatureUnit": { @@ -5812,52 +5812,52 @@ "smithy.api#documentation": "

The temperature unit of a room profile.

" } }, - "ProfileName": { - "target": "com.amazonaws.alexaforbusiness#ProfileName", + "PSTNEnabled": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

The name of a room profile.

" + "smithy.api#documentation": "

The PSTN setting of a room profile.

" } }, - "MaxVolumeLimit": { - "target": "com.amazonaws.alexaforbusiness#MaxVolumeLimit", + "Locale": { + "target": "com.amazonaws.alexaforbusiness#DeviceLocale", "traits": { - "smithy.api#documentation": "

The max volume limit of a room profile.

" + "smithy.api#documentation": "

The locale of a room profile. (This is currently available only to a limited preview\n audience.)

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

Meeting room settings of a room profile.

" + "smithy.api#documentation": "

The address of a room profile.

" } }, - "AddressBookArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "MaxVolumeLimit": { + "target": "com.amazonaws.alexaforbusiness#MaxVolumeLimit", "traits": { - "smithy.api#documentation": "

The ARN of the address book.

" + "smithy.api#documentation": "

The max volume limit of a room profile.

" } }, - "DistanceUnit": { - "target": "com.amazonaws.alexaforbusiness#DistanceUnit", + "IsDefault": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

The distance unit of a room profile.

" + "smithy.api#documentation": "

Retrieves if the profile is default or not.

" } }, - "SetupModeDisabled": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "Timezone": { + "target": "com.amazonaws.alexaforbusiness#Timezone", "traits": { - "smithy.api#documentation": "

The setup mode of a room profile.

" + "smithy.api#documentation": "

The time zone of a room profile.

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

The address of a room profile.

" + "smithy.api#documentation": "

The wake word of a room profile.

" } }, - "PSTNEnabled": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "ProfileArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The PSTN setting of a room profile.

" + "smithy.api#documentation": "

The ARN of a room profile.

" } } }, @@ -5868,10 +5868,10 @@ "com.amazonaws.alexaforbusiness#ProfileData": { "type": "structure", "members": { - "ProfileName": { - "target": "com.amazonaws.alexaforbusiness#ProfileName", + "IsDefault": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

The name of a room profile.

" + "smithy.api#documentation": "

Retrieves if the profile data is default or not.

" } }, "ProfileArn": { @@ -5880,34 +5880,28 @@ "smithy.api#documentation": "

The ARN of a room profile.

" } }, - "Locale": { - "target": "com.amazonaws.alexaforbusiness#DeviceLocale", - "traits": { - "smithy.api#documentation": "

The locale of a room profile. (This is currently available only to a limited preview\n audience.)

" - } - }, - "Timezone": { - "target": "com.amazonaws.alexaforbusiness#Timezone", + "TemperatureUnit": { + "target": "com.amazonaws.alexaforbusiness#TemperatureUnit", "traits": { - "smithy.api#documentation": "

The time zone of a room profile.

" + "smithy.api#documentation": "

The temperature unit of a room profile.

" } }, - "IsDefault": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "ProfileName": { + "target": "com.amazonaws.alexaforbusiness#ProfileName", "traits": { - "smithy.api#documentation": "

Retrieves if the profile data is default or not.

" + "smithy.api#documentation": "

The name of a room profile.

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

The address of a room profile.

" + "smithy.api#documentation": "

The time zone of a room profile.

" } }, - "TemperatureUnit": { - "target": "com.amazonaws.alexaforbusiness#TemperatureUnit", + "Locale": { + "target": "com.amazonaws.alexaforbusiness#DeviceLocale", "traits": { - "smithy.api#documentation": "

The temperature unit of a room profile.

" + "smithy.api#documentation": "

The locale of a room profile. (This is currently available only to a limited preview\n audience.)

" } }, "DistanceUnit": { @@ -5921,6 +5915,12 @@ "traits": { "smithy.api#documentation": "

The wake word of a room profile.

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

The address of a room profile.

" + } } }, "traits": { @@ -6008,6 +6008,12 @@ "com.amazonaws.alexaforbusiness#PutInvitationConfigurationRequest": { "type": "structure", "members": { + "ContactEmail": { + "target": "com.amazonaws.alexaforbusiness#Email", + "traits": { + "smithy.api#documentation": "

The email ID of the organization or individual contact that the enrolled user can use.\n

" + } + }, "OrganizationName": { "target": "com.amazonaws.alexaforbusiness#OrganizationName", "traits": { @@ -6020,12 +6026,6 @@ "traits": { "smithy.api#documentation": "

The list of private skill IDs that you want to recommend to the user to enable in the\n invitation.

" } - }, - "ContactEmail": { - "target": "com.amazonaws.alexaforbusiness#Email", - "traits": { - "smithy.api#documentation": "

The email ID of the organization or individual contact that the enrolled user can use.\n

" - } } } }, @@ -6059,17 +6059,17 @@ "smithy.api#documentation": "

The ARN of the room associated with the room skill parameter. Required.

" } }, - "RoomSkillParameter": { - "target": "com.amazonaws.alexaforbusiness#RoomSkillParameter", + "SkillId": { + "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { - "smithy.api#documentation": "

The updated room skill parameter. Required.

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

The ARN of the skill associated with the room skill parameter. Required.

", "smithy.api#required": {} } }, - "SkillId": { - "target": "com.amazonaws.alexaforbusiness#SkillId", + "RoomSkillParameter": { + "target": "com.amazonaws.alexaforbusiness#RoomSkillParameter", "traits": { - "smithy.api#documentation": "

The ARN of the skill associated with the room skill parameter. Required.

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

The updated room skill parameter. Required.

", "smithy.api#required": {} } } @@ -6102,13 +6102,6 @@ "com.amazonaws.alexaforbusiness#PutSkillAuthorizationRequest": { "type": "structure", "members": { - "SkillId": { - "target": "com.amazonaws.alexaforbusiness#SkillId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a skill.

", - "smithy.api#required": {} - } - }, "RoomArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -6121,6 +6114,13 @@ "smithy.api#documentation": "

The authorization result specific to OAUTH code grant output. \"Code” must be\n populated in the AuthorizationResult map to establish the authorization.

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

The unique identifier of a skill.

", + "smithy.api#required": {} + } } } }, @@ -6168,13 +6168,6 @@ "com.amazonaws.alexaforbusiness#RegisterAVSDeviceRequest": { "type": "structure", "members": { - "AmazonId": { - "target": "com.amazonaws.alexaforbusiness#AmazonId", - "traits": { - "smithy.api#documentation": "

The device type ID for your AVS device generated by Amazon when the OEM creates a new\n product on Amazon's Developer Console.

", - "smithy.api#required": {} - } - }, "RoomArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -6207,6 +6200,13 @@ "traits": { "smithy.api#documentation": "

The key generated by the OEM that uniquely identifies a specified instance of your\n AVS device.

" } + }, + "AmazonId": { + "target": "com.amazonaws.alexaforbusiness#AmazonId", + "traits": { + "smithy.api#documentation": "

The device type ID for your AVS device generated by Amazon when the OEM creates a new\n product on Amazon's Developer Console.

", + "smithy.api#required": {} + } } } }, @@ -6319,17 +6319,17 @@ "com.amazonaws.alexaforbusiness#ResolveRoomRequest": { "type": "structure", "members": { - "SkillId": { - "target": "com.amazonaws.alexaforbusiness#SkillId", + "UserId": { + "target": "com.amazonaws.alexaforbusiness#UserId", "traits": { - "smithy.api#documentation": "

The ARN of the skill that was requested. Required.

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

The ARN of the user. Required.

", "smithy.api#required": {} } }, - "UserId": { - "target": "com.amazonaws.alexaforbusiness#UserId", + "SkillId": { + "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { - "smithy.api#documentation": "

The ARN of the user. Required.

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

The ARN of the skill that was requested. Required.

", "smithy.api#required": {} } } @@ -6338,10 +6338,10 @@ "com.amazonaws.alexaforbusiness#ResolveRoomResponse": { "type": "structure", "members": { - "RoomName": { - "target": "com.amazonaws.alexaforbusiness#RoomName", + "RoomSkillParameters": { + "target": "com.amazonaws.alexaforbusiness#RoomSkillParameters", "traits": { - "smithy.api#documentation": "

The name of the room from which the skill request was invoked.

" + "smithy.api#documentation": "

Response to get the room profile request. Required.

" } }, "RoomArn": { @@ -6350,10 +6350,10 @@ "smithy.api#documentation": "

The ARN of the room from which the skill request was invoked.

" } }, - "RoomSkillParameters": { - "target": "com.amazonaws.alexaforbusiness#RoomSkillParameters", + "RoomName": { + "target": "com.amazonaws.alexaforbusiness#RoomName", "traits": { - "smithy.api#documentation": "

Response to get the room profile request. Required.

" + "smithy.api#documentation": "

The name of the room from which the skill request was invoked.

" } } } @@ -6373,11 +6373,11 @@ "com.amazonaws.alexaforbusiness#ResourceInUseException": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.alexaforbusiness#ClientRequestToken" - }, "Message": { "target": "com.amazonaws.alexaforbusiness#ErrorMessage" + }, + "ClientRequestToken": { + "target": "com.amazonaws.alexaforbusiness#ClientRequestToken" } }, "traits": { @@ -6444,18 +6444,6 @@ "com.amazonaws.alexaforbusiness#Room": { "type": "structure", "members": { - "RoomArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of a room.

" - } - }, - "ProviderCalendarId": { - "target": "com.amazonaws.alexaforbusiness#ProviderCalendarId", - "traits": { - "smithy.api#documentation": "

The provider calendar ARN of a room.

" - } - }, "Description": { "target": "com.amazonaws.alexaforbusiness#RoomDescription", "traits": { @@ -6468,11 +6456,23 @@ "smithy.api#documentation": "

The profile ARN of a room.

" } }, + "ProviderCalendarId": { + "target": "com.amazonaws.alexaforbusiness#ProviderCalendarId", + "traits": { + "smithy.api#documentation": "

The provider calendar ARN of a room.

" + } + }, "RoomName": { "target": "com.amazonaws.alexaforbusiness#RoomName", "traits": { "smithy.api#documentation": "

The name of a room.

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

The ARN of a room.

" + } } }, "traits": { @@ -6482,10 +6482,10 @@ "com.amazonaws.alexaforbusiness#RoomData": { "type": "structure", "members": { - "ProfileName": { - "target": "com.amazonaws.alexaforbusiness#ProfileName", + "Description": { + "target": "com.amazonaws.alexaforbusiness#RoomDescription", "traits": { - "smithy.api#documentation": "

The profile name of a room.

" + "smithy.api#documentation": "

The description of a room.

" } }, "RoomName": { @@ -6506,17 +6506,17 @@ "smithy.api#documentation": "

The provider calendar ARN of a room.

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

The description of a room.

" - } - }, "ProfileArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { "smithy.api#documentation": "

The profile ARN of a room.

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

The profile name of a room.

" + } } }, "traits": { @@ -6637,10 +6637,10 @@ "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response only includes\n results beyond the token, up to the value specified by MaxResults.

" } }, - "Filters": { - "target": "com.amazonaws.alexaforbusiness#FilterList", + "MaxResults": { + "target": "com.amazonaws.alexaforbusiness#MaxResults", "traits": { - "smithy.api#documentation": "

The filters to use to list a specified set of address books. The supported filter key\n is AddressBookName.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that the remaining\n results can be retrieved.

" } }, "SortCriteria": { @@ -6649,10 +6649,10 @@ "smithy.api#documentation": "

The sort order to use in listing the specified set of address books. The supported\n sort key is AddressBookName.

" } }, - "MaxResults": { - "target": "com.amazonaws.alexaforbusiness#MaxResults", + "Filters": { + "target": "com.amazonaws.alexaforbusiness#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that the remaining\n results can be retrieved.

" + "smithy.api#documentation": "

The filters to use to list a specified set of address books. The supported filter key\n is AddressBookName.

" } } } @@ -6706,18 +6706,18 @@ "smithy.api#documentation": "

The sort order to use in listing the specified set of contacts. The supported sort\n keys are DisplayName, FirstName, and LastName.

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

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response only includes\n results beyond the token, up to the value specified by MaxResults.

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

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that the remaining\n results can be retrieved.

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

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response only includes\n results beyond the token, up to the value specified by MaxResults.

" + } + }, "Filters": { "target": "com.amazonaws.alexaforbusiness#FilterList", "traits": { @@ -6729,10 +6729,10 @@ "com.amazonaws.alexaforbusiness#SearchContactsResponse": { "type": "structure", "members": { - "Contacts": { - "target": "com.amazonaws.alexaforbusiness#ContactDataList", + "TotalCount": { + "target": "com.amazonaws.alexaforbusiness#TotalCount", "traits": { - "smithy.api#documentation": "

The contacts that meet the specified set of filter criteria, in sort order.

" + "smithy.api#documentation": "

The total number of contacts returned.

" } }, "NextToken": { @@ -6741,10 +6741,10 @@ "smithy.api#documentation": "

The token returned to indicate that there is more data available.

" } }, - "TotalCount": { - "target": "com.amazonaws.alexaforbusiness#TotalCount", + "Contacts": { + "target": "com.amazonaws.alexaforbusiness#ContactDataList", "traits": { - "smithy.api#documentation": "

The total number of contacts returned.

" + "smithy.api#documentation": "

The contacts that meet the specified set of filter criteria, in sort order.

" } } } @@ -6769,6 +6769,12 @@ "com.amazonaws.alexaforbusiness#SearchDevicesRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.alexaforbusiness#FilterList", + "traits": { + "smithy.api#documentation": "

The filters to use to list a specified set of devices. Supported filter keys are\n DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber,\n UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName,\n NetworkProfileArn, Feature, and FailureCode.

" + } + }, "SortCriteria": { "target": "com.amazonaws.alexaforbusiness#SortList", "traits": { @@ -6786,12 +6792,6 @@ "traits": { "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" } - }, - "Filters": { - "target": "com.amazonaws.alexaforbusiness#FilterList", - "traits": { - "smithy.api#documentation": "

The filters to use to list a specified set of devices. Supported filter keys are\n DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber,\n UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName,\n NetworkProfileArn, Feature, and FailureCode.

" - } } } }, @@ -6838,10 +6838,10 @@ "com.amazonaws.alexaforbusiness#SearchNetworkProfilesRequest": { "type": "structure", "members": { - "SortCriteria": { - "target": "com.amazonaws.alexaforbusiness#SortList", + "NextToken": { + "target": "com.amazonaws.alexaforbusiness#NextToken", "traits": { - "smithy.api#documentation": "

The sort order to use to list the specified set of network profiles. Valid sort criteria\n includes NetworkProfileName, Ssid, and SecurityType.

" + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" } }, "Filters": { @@ -6850,10 +6850,10 @@ "smithy.api#documentation": "

The filters to use to list a specified set of network profiles. Valid filters are\n NetworkProfileName, Ssid, and SecurityType.

" } }, - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", + "SortCriteria": { + "target": "com.amazonaws.alexaforbusiness#SortList", "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" + "smithy.api#documentation": "

The sort order to use to list the specified set of network profiles. Valid sort criteria\n includes NetworkProfileName, Ssid, and SecurityType.

" } }, "MaxResults": { @@ -6867,10 +6867,10 @@ "com.amazonaws.alexaforbusiness#SearchNetworkProfilesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", + "NetworkProfiles": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileDataList", "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" + "smithy.api#documentation": "

The network profiles that meet the specified set of filter criteria, in sort order. It\n is a list of NetworkProfileData objects.

" } }, "TotalCount": { @@ -6879,10 +6879,10 @@ "smithy.api#documentation": "

The total number of network profiles returned.

" } }, - "NetworkProfiles": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileDataList", + "NextToken": { + "target": "com.amazonaws.alexaforbusiness#NextToken", "traits": { - "smithy.api#documentation": "

The network profiles that meet the specified set of filter criteria, in sort order. It\n is a list of NetworkProfileData objects.

" + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" } } } @@ -6907,16 +6907,16 @@ "com.amazonaws.alexaforbusiness#SearchProfilesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.alexaforbusiness#FilterList", + "NextToken": { + "target": "com.amazonaws.alexaforbusiness#NextToken", "traits": { - "smithy.api#documentation": "

The filters to use to list a specified set of room profiles. Supported filter keys\n are ProfileName and Address. Required.

" + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" } }, - "SortCriteria": { - "target": "com.amazonaws.alexaforbusiness#SortList", + "Filters": { + "target": "com.amazonaws.alexaforbusiness#FilterList", "traits": { - "smithy.api#documentation": "

The sort order to use in listing the specified set of room profiles. Supported sort\n keys are ProfileName and Address.

" + "smithy.api#documentation": "

The filters to use to list a specified set of room profiles. Supported filter keys\n are ProfileName and Address. Required.

" } }, "MaxResults": { @@ -6925,10 +6925,10 @@ "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" } }, - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", + "SortCriteria": { + "target": "com.amazonaws.alexaforbusiness#SortList", "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" + "smithy.api#documentation": "

The sort order to use in listing the specified set of room profiles. Supported sort\n keys are ProfileName and Address.

" } } } @@ -6936,6 +6936,12 @@ "com.amazonaws.alexaforbusiness#SearchProfilesResponse": { "type": "structure", "members": { + "Profiles": { + "target": "com.amazonaws.alexaforbusiness#ProfileDataList", + "traits": { + "smithy.api#documentation": "

The profiles that meet the specified set of filter criteria, in sort order.

" + } + }, "NextToken": { "target": "com.amazonaws.alexaforbusiness#NextToken", "traits": { @@ -6947,12 +6953,6 @@ "traits": { "smithy.api#documentation": "

The total number of room profiles returned.

" } - }, - "Profiles": { - "target": "com.amazonaws.alexaforbusiness#ProfileDataList", - "traits": { - "smithy.api#documentation": "

The profiles that meet the specified set of filter criteria, in sort order.

" - } } } }, @@ -6976,10 +6976,10 @@ "com.amazonaws.alexaforbusiness#SearchRoomsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.alexaforbusiness#MaxResults", + "SortCriteria": { + "target": "com.amazonaws.alexaforbusiness#SortList", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" + "smithy.api#documentation": "

The sort order to use in listing the specified set of rooms. The supported sort keys\n are RoomName and ProfileName.

" } }, "Filters": { @@ -6988,16 +6988,16 @@ "smithy.api#documentation": "

The filters to use to list a specified set of rooms. The supported filter keys are\n RoomName and ProfileName.

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

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" } }, - "SortCriteria": { - "target": "com.amazonaws.alexaforbusiness#SortList", + "NextToken": { + "target": "com.amazonaws.alexaforbusiness#NextToken", "traits": { - "smithy.api#documentation": "

The sort order to use in listing the specified set of rooms. The supported sort keys\n are RoomName and ProfileName.

" + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.

" } } } @@ -7011,17 +7011,17 @@ "smithy.api#documentation": "

The token returned to indicate that there is more data available.

" } }, - "TotalCount": { - "target": "com.amazonaws.alexaforbusiness#TotalCount", - "traits": { - "smithy.api#documentation": "

The total number of rooms returned.

" - } - }, "Rooms": { "target": "com.amazonaws.alexaforbusiness#RoomDataList", "traits": { "smithy.api#documentation": "

The rooms that meet the specified set of filter criteria, in sort order.

" } + }, + "TotalCount": { + "target": "com.amazonaws.alexaforbusiness#TotalCount", + "traits": { + "smithy.api#documentation": "

The total number of rooms returned.

" + } } } }, @@ -7045,16 +7045,16 @@ "com.amazonaws.alexaforbusiness#SearchSkillGroupsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.alexaforbusiness#FilterList", + "MaxResults": { + "target": "com.amazonaws.alexaforbusiness#MaxResults", "traits": { - "smithy.api#documentation": "

The filters to use to list a specified set of skill groups. The supported filter key\n is SkillGroupName.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" } }, - "SortCriteria": { - "target": "com.amazonaws.alexaforbusiness#SortList", + "Filters": { + "target": "com.amazonaws.alexaforbusiness#FilterList", "traits": { - "smithy.api#documentation": "

The sort order to use in listing the specified set of skill groups. The supported\n sort key is SkillGroupName.

" + "smithy.api#documentation": "

The filters to use to list a specified set of skill groups. The supported filter key\n is SkillGroupName.

" } }, "NextToken": { @@ -7063,10 +7063,10 @@ "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.\n Required.

" } }, - "MaxResults": { - "target": "com.amazonaws.alexaforbusiness#MaxResults", + "SortCriteria": { + "target": "com.amazonaws.alexaforbusiness#SortList", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved.

" + "smithy.api#documentation": "

The sort order to use in listing the specified set of skill groups. The supported\n sort key is SkillGroupName.

" } } } @@ -7074,6 +7074,12 @@ "com.amazonaws.alexaforbusiness#SearchSkillGroupsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.alexaforbusiness#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned to indicate that there is more data available.

" + } + }, "TotalCount": { "target": "com.amazonaws.alexaforbusiness#TotalCount", "traits": { @@ -7085,12 +7091,6 @@ "traits": { "smithy.api#documentation": "

The skill groups that meet the filter criteria, in sort order.

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

The token returned to indicate that there is more data available.

" - } } } }, @@ -7114,16 +7114,10 @@ "com.amazonaws.alexaforbusiness#SearchUsersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.alexaforbusiness#NextToken", - "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.\n Required.

" - } - }, - "SortCriteria": { - "target": "com.amazonaws.alexaforbusiness#SortList", + "Filters": { + "target": "com.amazonaws.alexaforbusiness#FilterList", "traits": { - "smithy.api#documentation": "

The sort order to use in listing the filtered set of users. Required. Supported sort\n keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

" + "smithy.api#documentation": "

The filters to use for listing a specific set of users. Required. Supported filter\n keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

" } }, "MaxResults": { @@ -7132,10 +7126,16 @@ "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than\n the specified MaxResults value, a token is included in the response so that\n the remaining results can be retrieved. Required.

" } }, - "Filters": { - "target": "com.amazonaws.alexaforbusiness#FilterList", + "SortCriteria": { + "target": "com.amazonaws.alexaforbusiness#SortList", "traits": { - "smithy.api#documentation": "

The filters to use for listing a specific set of users. Required. Supported filter\n keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

" + "smithy.api#documentation": "

The sort order to use in listing the filtered set of users. Required. Supported sort\n keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

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

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by MaxResults.\n Required.

" } } } @@ -7186,19 +7186,6 @@ "com.amazonaws.alexaforbusiness#SendAnnouncementRequest": { "type": "structure", "members": { - "TimeToLiveInSeconds": { - "target": "com.amazonaws.alexaforbusiness#TimeToLiveInSeconds", - "traits": { - "smithy.api#documentation": "

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the\n announcement is not delivered.

" - } - }, - "Content": { - "target": "com.amazonaws.alexaforbusiness#Content", - "traits": { - "smithy.api#documentation": "

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

", - "smithy.api#required": {} - } - }, "ClientRequestToken": { "target": "com.amazonaws.alexaforbusiness#ClientRequestToken", "traits": { @@ -7213,6 +7200,19 @@ "smithy.api#documentation": "

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

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

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the\n announcement is not delivered.

" + } + }, + "Content": { + "target": "com.amazonaws.alexaforbusiness#Content", + "traits": { + "smithy.api#documentation": "

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

", + "smithy.api#required": {} + } } } }, @@ -7283,17 +7283,17 @@ "com.amazonaws.alexaforbusiness#SipAddress": { "type": "structure", "members": { - "Uri": { - "target": "com.amazonaws.alexaforbusiness#SipUri", + "Type": { + "target": "com.amazonaws.alexaforbusiness#SipType", "traits": { - "smithy.api#documentation": "

The URI for the SIP address.

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

The type of the SIP address.

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.alexaforbusiness#SipType", + "Uri": { + "target": "com.amazonaws.alexaforbusiness#SipUri", "traits": { - "smithy.api#documentation": "

The type of the SIP address.

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

The URI for the SIP address.

", "smithy.api#required": {} } } @@ -7340,46 +7340,40 @@ "com.amazonaws.alexaforbusiness#SkillDetails": { "type": "structure", "members": { - "BulletPoints": { - "target": "com.amazonaws.alexaforbusiness#BulletPoints", - "traits": { - "smithy.api#documentation": "

The details about what the skill supports organized as bullet points.

" - } - }, - "SkillTypes": { - "target": "com.amazonaws.alexaforbusiness#SkillTypes", + "DeveloperInfo": { + "target": "com.amazonaws.alexaforbusiness#DeveloperInfo", "traits": { - "smithy.api#documentation": "

The types of skills.

" + "smithy.api#documentation": "

The details about the developer that published the skill.

" } }, - "NewInThisVersionBulletPoints": { - "target": "com.amazonaws.alexaforbusiness#NewInThisVersionBulletPoints", + "GenericKeywords": { + "target": "com.amazonaws.alexaforbusiness#GenericKeywords", "traits": { - "smithy.api#documentation": "

The updates added in bullet points.

" + "smithy.api#documentation": "

The generic keywords associated with the skill that can be used to find a\n skill.

" } }, - "ReleaseDate": { - "target": "com.amazonaws.alexaforbusiness#ReleaseDate", + "ProductDescription": { + "target": "com.amazonaws.alexaforbusiness#ProductDescription", "traits": { - "smithy.api#documentation": "

The date when the skill was released.

" + "smithy.api#documentation": "

The description of the product.

" } }, - "DeveloperInfo": { - "target": "com.amazonaws.alexaforbusiness#DeveloperInfo", + "SkillTypes": { + "target": "com.amazonaws.alexaforbusiness#SkillTypes", "traits": { - "smithy.api#documentation": "

The details about the developer that published the skill.

" + "smithy.api#documentation": "

The types of skills.

" } }, - "ProductDescription": { - "target": "com.amazonaws.alexaforbusiness#ProductDescription", + "Reviews": { + "target": "com.amazonaws.alexaforbusiness#Reviews", "traits": { - "smithy.api#documentation": "

The description of the product.

" + "smithy.api#documentation": "

\n This member has been deprecated.\n

\n

The list of reviews for the skill, including Key and Value pair.

" } }, - "Reviews": { - "target": "com.amazonaws.alexaforbusiness#Reviews", + "EndUserLicenseAgreement": { + "target": "com.amazonaws.alexaforbusiness#EndUserLicenseAgreement", "traits": { - "smithy.api#documentation": "

\n This member has been deprecated.\n

\n

The list of reviews for the skill, including Key and Value pair.

" + "smithy.api#documentation": "

The URL of the end user license agreement.

" } }, "InvocationPhrase": { @@ -7388,16 +7382,22 @@ "smithy.api#documentation": "

The phrase used to trigger the skill.

" } }, - "GenericKeywords": { - "target": "com.amazonaws.alexaforbusiness#GenericKeywords", + "ReleaseDate": { + "target": "com.amazonaws.alexaforbusiness#ReleaseDate", "traits": { - "smithy.api#documentation": "

The generic keywords associated with the skill that can be used to find a\n skill.

" + "smithy.api#documentation": "

The date when the skill was released.

" } }, - "EndUserLicenseAgreement": { - "target": "com.amazonaws.alexaforbusiness#EndUserLicenseAgreement", + "BulletPoints": { + "target": "com.amazonaws.alexaforbusiness#BulletPoints", "traits": { - "smithy.api#documentation": "

The URL of the end user license agreement.

" + "smithy.api#documentation": "

The details about what the skill supports organized as bullet points.

" + } + }, + "NewInThisVersionBulletPoints": { + "target": "com.amazonaws.alexaforbusiness#NewInThisVersionBulletPoints", + "traits": { + "smithy.api#documentation": "

The updates added in bullet points.

" } } }, @@ -7408,18 +7408,18 @@ "com.amazonaws.alexaforbusiness#SkillGroup": { "type": "structure", "members": { - "SkillGroupName": { - "target": "com.amazonaws.alexaforbusiness#SkillGroupName", - "traits": { - "smithy.api#documentation": "

The name of a skill group.

" - } - }, "SkillGroupArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { "smithy.api#documentation": "

The ARN of a skill group.

" } }, + "SkillGroupName": { + "target": "com.amazonaws.alexaforbusiness#SkillGroupName", + "traits": { + "smithy.api#documentation": "

The name of a skill group.

" + } + }, "Description": { "target": "com.amazonaws.alexaforbusiness#SkillGroupDescription", "traits": { @@ -7434,12 +7434,6 @@ "com.amazonaws.alexaforbusiness#SkillGroupData": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.alexaforbusiness#SkillGroupDescription", - "traits": { - "smithy.api#documentation": "

The description of a skill group.

" - } - }, "SkillGroupArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -7451,6 +7445,12 @@ "traits": { "smithy.api#documentation": "

The skill group name of a skill group.

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

The description of a skill group.

" + } } }, "traits": { @@ -7533,16 +7533,10 @@ "smithy.api#documentation": "

The ARN of the skill summary.

" } }, - "EnablementType": { - "target": "com.amazonaws.alexaforbusiness#EnablementType", - "traits": { - "smithy.api#documentation": "

Whether the skill is enabled under the user's account, or if it requires linking to be\n used.

" - } - }, - "SupportsLinking": { - "target": "com.amazonaws.alexaforbusiness#Boolean2", + "SkillName": { + "target": "com.amazonaws.alexaforbusiness#SkillName", "traits": { - "smithy.api#documentation": "

Linking support for a skill.

" + "smithy.api#documentation": "

The name of the skill.

" } }, "SkillType": { @@ -7551,10 +7545,16 @@ "smithy.api#documentation": "

Whether the skill is publicly available or is a private skill.

" } }, - "SkillName": { - "target": "com.amazonaws.alexaforbusiness#SkillName", + "EnablementType": { + "target": "com.amazonaws.alexaforbusiness#EnablementType", "traits": { - "smithy.api#documentation": "

The name of the skill.

" + "smithy.api#documentation": "

Whether the skill is enabled under the user's account, or if it requires linking to be\n used.

" + } + }, + "SupportsLinking": { + "target": "com.amazonaws.alexaforbusiness#Boolean2", + "traits": { + "smithy.api#documentation": "

Linking support for a skill.

" } } }, @@ -7616,16 +7616,16 @@ "com.amazonaws.alexaforbusiness#SkillsStoreSkill": { "type": "structure", "members": { - "IconUrl": { - "target": "com.amazonaws.alexaforbusiness#IconUrl", + "SkillId": { + "target": "com.amazonaws.alexaforbusiness#SkillId", "traits": { - "smithy.api#documentation": "

The URL where the skill icon resides.

" + "smithy.api#documentation": "

The ARN of the skill.

" } }, - "SkillName": { - "target": "com.amazonaws.alexaforbusiness#SkillName", + "SkillDetails": { + "target": "com.amazonaws.alexaforbusiness#SkillDetails", "traits": { - "smithy.api#documentation": "

The name of the skill.

" + "smithy.api#documentation": "

Information about the skill.

" } }, "SampleUtterances": { @@ -7640,22 +7640,22 @@ "smithy.api#documentation": "

Linking support for a skill.

" } }, - "SkillId": { - "target": "com.amazonaws.alexaforbusiness#SkillId", + "IconUrl": { + "target": "com.amazonaws.alexaforbusiness#IconUrl", "traits": { - "smithy.api#documentation": "

The ARN of the skill.

" + "smithy.api#documentation": "

The URL where the skill icon resides.

" } }, - "ShortDescription": { - "target": "com.amazonaws.alexaforbusiness#ShortDescription", + "SkillName": { + "target": "com.amazonaws.alexaforbusiness#SkillName", "traits": { - "smithy.api#documentation": "

Short description about the skill.

" + "smithy.api#documentation": "

The name of the skill.

" } }, - "SkillDetails": { - "target": "com.amazonaws.alexaforbusiness#SkillDetails", + "ShortDescription": { + "target": "com.amazonaws.alexaforbusiness#ShortDescription", "traits": { - "smithy.api#documentation": "

Information about the skill.

" + "smithy.api#documentation": "

Short description about the skill.

" } } }, @@ -7672,10 +7672,10 @@ "com.amazonaws.alexaforbusiness#SmartHomeAppliance": { "type": "structure", "members": { - "FriendlyName": { - "target": "com.amazonaws.alexaforbusiness#ApplianceFriendlyName", + "ManufacturerName": { + "target": "com.amazonaws.alexaforbusiness#ApplianceManufacturerName", "traits": { - "smithy.api#documentation": "

The friendly name of the smart home appliance.

" + "smithy.api#documentation": "

The name of the manufacturer of the smart home appliance.

" } }, "Description": { @@ -7684,10 +7684,10 @@ "smithy.api#documentation": "

The description of the smart home appliance.

" } }, - "ManufacturerName": { - "target": "com.amazonaws.alexaforbusiness#ApplianceManufacturerName", + "FriendlyName": { + "target": "com.amazonaws.alexaforbusiness#ApplianceFriendlyName", "traits": { - "smithy.api#documentation": "

The name of the manufacturer of the smart home appliance.

" + "smithy.api#documentation": "

The friendly name of the smart home appliance.

" } } }, @@ -7765,17 +7765,17 @@ "com.amazonaws.alexaforbusiness#Ssml": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.alexaforbusiness#SsmlValue", + "Locale": { + "target": "com.amazonaws.alexaforbusiness#Locale", "traits": { - "smithy.api#documentation": "

The value of the SSML message in the correct SSML format. The audio tag is not supported.

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

The locale of the SSML message. Currently, en-US is supported.

", "smithy.api#required": {} } }, - "Locale": { - "target": "com.amazonaws.alexaforbusiness#Locale", + "Value": { + "target": "com.amazonaws.alexaforbusiness#SsmlValue", "traits": { - "smithy.api#documentation": "

The locale of the SSML message. Currently, en-US is supported.

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

The value of the SSML message in the correct SSML format. The audio tag is not supported.

", "smithy.api#required": {} } } @@ -7826,6 +7826,13 @@ "com.amazonaws.alexaforbusiness#StartDeviceSyncRequest": { "type": "structure", "members": { + "Features": { + "target": "com.amazonaws.alexaforbusiness#Features", + "traits": { + "smithy.api#documentation": "

Request structure to start the device sync. Required.

", + "smithy.api#required": {} + } + }, "RoomArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -7837,13 +7844,6 @@ "traits": { "smithy.api#documentation": "

The ARN of the device to sync. Required.

" } - }, - "Features": { - "target": "com.amazonaws.alexaforbusiness#Features", - "traits": { - "smithy.api#documentation": "

Request structure to start the device sync. Required.

", - "smithy.api#required": {} - } } } }, @@ -7887,17 +7887,17 @@ "com.amazonaws.alexaforbusiness#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.alexaforbusiness#TagValue", + "Key": { + "target": "com.amazonaws.alexaforbusiness#TagKey", "traits": { - "smithy.api#documentation": "

The value of a tag. Tag values are case sensitive and can be null.

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

The key of a tag. Tag keys are case-sensitive.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.alexaforbusiness#TagKey", + "Value": { + "target": "com.amazonaws.alexaforbusiness#TagValue", "traits": { - "smithy.api#documentation": "

The key of a tag. Tag keys are case-sensitive.

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

The value of a tag. Tag values are case sensitive and can be null.

", "smithy.api#required": {} } } @@ -7948,17 +7948,17 @@ "com.amazonaws.alexaforbusiness#TagResourceRequest": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "Tags": { + "target": "com.amazonaws.alexaforbusiness#TagList", "traits": { - "smithy.api#documentation": "

The ARN of the resource to which to add metadata tags. Required.

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

The tags to be added to the specified resource. Do not provide system tags. Required.\n

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.alexaforbusiness#TagList", + "Arn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The tags to be added to the specified resource. Do not provide system tags. Required.\n

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

The ARN of the resource to which to add metadata tags. Required.

", "smithy.api#required": {} } } @@ -7996,17 +7996,17 @@ "com.amazonaws.alexaforbusiness#Text": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.alexaforbusiness#TextValue", + "Locale": { + "target": "com.amazonaws.alexaforbusiness#Locale", "traits": { - "smithy.api#documentation": "

The value of the text message.

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

The locale of the text message. Currently, en-US is supported.

", "smithy.api#required": {} } }, - "Locale": { - "target": "com.amazonaws.alexaforbusiness#Locale", + "Value": { + "target": "com.amazonaws.alexaforbusiness#TextValue", "traits": { - "smithy.api#documentation": "

The locale of the text message. Currently, en-US is supported.

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

The value of the text message.

", "smithy.api#required": {} } } @@ -8112,17 +8112,17 @@ "com.amazonaws.alexaforbusiness#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.alexaforbusiness#TagKeyList", + "Arn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The tags to be removed from the specified resource. Do not provide system tags.\n Required.

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

The ARN of the resource from which to remove metadata tags. Required.

", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "TagKeys": { + "target": "com.amazonaws.alexaforbusiness#TagKeyList", "traits": { - "smithy.api#documentation": "

The ARN of the resource from which to remove metadata tags. Required.

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

The tags to be removed from the specified resource. Do not provide system tags.\n Required.

", "smithy.api#required": {} } } @@ -8164,18 +8164,18 @@ "smithy.api#documentation": "

The updated name of the room.

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

The updated description of the room.

" - } - }, "AddressBookArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { "smithy.api#documentation": "

The ARN of the room to update.

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

The updated description of the room.

" + } } } }, @@ -8206,23 +8206,23 @@ "com.amazonaws.alexaforbusiness#UpdateBusinessReportScheduleRequest": { "type": "structure", "members": { - "ScheduleArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "Format": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportFormat", "traits": { - "smithy.api#documentation": "

The ARN of the business report schedule.

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

The format of the generated report (individual CSV files or zipped files of\n individual files).

" } }, - "Recurrence": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportRecurrence", + "ScheduleName": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleName", "traits": { - "smithy.api#documentation": "

The recurrence of the reports.

" + "smithy.api#documentation": "

The name identifier of the schedule.

" } }, - "Format": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportFormat", + "ScheduleArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The format of the generated report (individual CSV files or zipped files of\n individual files).

" + "smithy.api#documentation": "

The ARN of the business report schedule.

", + "smithy.api#required": {} } }, "S3KeyPrefix": { @@ -8231,16 +8231,16 @@ "smithy.api#documentation": "

The S3 key where the report is delivered.

" } }, - "S3BucketName": { - "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", + "Recurrence": { + "target": "com.amazonaws.alexaforbusiness#BusinessReportRecurrence", "traits": { - "smithy.api#documentation": "

The S3 location of the output reports.

" + "smithy.api#documentation": "

The recurrence of the reports.

" } }, - "ScheduleName": { - "target": "com.amazonaws.alexaforbusiness#BusinessReportScheduleName", + "S3BucketName": { + "target": "com.amazonaws.alexaforbusiness#CustomerS3BucketName", "traits": { - "smithy.api#documentation": "

The name identifier of the schedule.

" + "smithy.api#documentation": "

The S3 location of the output reports.

" } } } @@ -8269,6 +8269,18 @@ "com.amazonaws.alexaforbusiness#UpdateConferenceProviderRequest": { "type": "structure", "members": { + "IPDialIn": { + "target": "com.amazonaws.alexaforbusiness#IPDialIn", + "traits": { + "smithy.api#documentation": "

The IP endpoint and protocol for calling.

" + } + }, + "PSTNDialIn": { + "target": "com.amazonaws.alexaforbusiness#PSTNDialIn", + "traits": { + "smithy.api#documentation": "

The information for PSTN conferencing.

" + } + }, "ConferenceProviderArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { @@ -8276,12 +8288,6 @@ "smithy.api#required": {} } }, - "IPDialIn": { - "target": "com.amazonaws.alexaforbusiness#IPDialIn", - "traits": { - "smithy.api#documentation": "

The IP endpoint and protocol for calling.

" - } - }, "MeetingSetting": { "target": "com.amazonaws.alexaforbusiness#MeetingSetting", "traits": { @@ -8295,12 +8301,6 @@ "smithy.api#documentation": "

The type of the conference provider.

", "smithy.api#required": {} } - }, - "PSTNDialIn": { - "target": "com.amazonaws.alexaforbusiness#PSTNDialIn", - "traits": { - "smithy.api#documentation": "

The information for PSTN conferencing.

" - } } } }, @@ -8331,47 +8331,47 @@ "com.amazonaws.alexaforbusiness#UpdateContactRequest": { "type": "structure", "members": { + "ContactArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the contact to update.

", + "smithy.api#required": {} + } + }, "SipAddresses": { "target": "com.amazonaws.alexaforbusiness#SipAddressList", "traits": { "smithy.api#documentation": "

The list of SIP addresses for the contact.

" } }, - "FirstName": { + "DisplayName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The updated first name of the contact.

" + "smithy.api#documentation": "

The updated display name of the contact.

" } }, - "PhoneNumbers": { - "target": "com.amazonaws.alexaforbusiness#PhoneNumberList", + "PhoneNumber": { + "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", "traits": { - "smithy.api#documentation": "

The list of phone numbers for the contact.

" + "smithy.api#documentation": "

The updated phone number of the contact. The phone number type defaults to WORK. You\n can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers,\n which lets you specify the phone number type and multiple numbers.

" } }, - "LastName": { + "FirstName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The updated last name of the contact.

" + "smithy.api#documentation": "

The updated first name of the contact.

" } }, - "DisplayName": { + "LastName": { "target": "com.amazonaws.alexaforbusiness#ContactName", "traits": { - "smithy.api#documentation": "

The updated display name of the contact.

" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.alexaforbusiness#RawPhoneNumber", - "traits": { - "smithy.api#documentation": "

The updated phone number of the contact. The phone number type defaults to WORK. You\n can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers,\n which lets you specify the phone number type and multiple numbers.

" + "smithy.api#documentation": "

The updated last name of the contact.

" } }, - "ContactArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "PhoneNumbers": { + "target": "com.amazonaws.alexaforbusiness#PhoneNumberList", "traits": { - "smithy.api#documentation": "

The ARN of the contact to update.

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

The list of phone numbers for the contact.

" } } } @@ -8427,10 +8427,10 @@ "com.amazonaws.alexaforbusiness#UpdateEndOfMeetingReminder": { "type": "structure", "members": { - "ReminderAtMinutes": { - "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderMinutesList", + "Enabled": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

Updates settings for the end of meeting reminder feature that are applied to a room\n profile. The end of meeting reminder enables Alexa to remind users when a meeting is\n ending.

" + "smithy.api#documentation": "

Whether an end of meeting reminder is enabled or not.

" } }, "ReminderType": { @@ -8439,10 +8439,10 @@ "smithy.api#documentation": "

The type of sound that users hear during the end of meeting reminder.

" } }, - "Enabled": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "ReminderAtMinutes": { + "target": "com.amazonaws.alexaforbusiness#EndOfMeetingReminderMinutesList", "traits": { - "smithy.api#documentation": "

Whether an end of meeting reminder is enabled or not.

" + "smithy.api#documentation": "

Updates settings for the end of meeting reminder feature that are applied to a room\n profile. The end of meeting reminder enables Alexa to remind users when a meeting is\n ending.

" } } }, @@ -8493,11 +8493,10 @@ "com.amazonaws.alexaforbusiness#UpdateGatewayGroupRequest": { "type": "structure", "members": { - "GatewayGroupArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "Description": { + "target": "com.amazonaws.alexaforbusiness#GatewayGroupDescription", "traits": { - "smithy.api#documentation": "

The ARN of the gateway group to update.

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

The updated description of the gateway group.

" } }, "Name": { @@ -8506,10 +8505,11 @@ "smithy.api#documentation": "

The updated name of the gateway group.

" } }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#GatewayGroupDescription", + "GatewayGroupArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The updated description of the gateway group.

" + "smithy.api#documentation": "

The ARN of the gateway group to update.

", + "smithy.api#required": {} } } } @@ -8521,11 +8521,10 @@ "com.amazonaws.alexaforbusiness#UpdateGatewayRequest": { "type": "structure", "members": { - "GatewayArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "Description": { + "target": "com.amazonaws.alexaforbusiness#GatewayDescription", "traits": { - "smithy.api#documentation": "

The ARN of the gateway to update.

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

The updated description of the gateway.

" } }, "SoftwareVersion": { @@ -8540,10 +8539,11 @@ "smithy.api#documentation": "

The updated name of the gateway.

" } }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#GatewayDescription", + "GatewayArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The updated description of the gateway.

" + "smithy.api#documentation": "

The ARN of the gateway to update.

", + "smithy.api#required": {} } } } @@ -8575,18 +8575,6 @@ "com.amazonaws.alexaforbusiness#UpdateMeetingRoomConfiguration": { "type": "structure", "members": { - "EndOfMeetingReminder": { - "target": "com.amazonaws.alexaforbusiness#UpdateEndOfMeetingReminder", - "traits": { - "smithy.api#documentation": "

Settings for the end of meeting reminder feature that are applied to a room profile. The\n end of meeting reminder enables Alexa to remind users when a meeting is ending.

" - } - }, - "RequireCheckIn": { - "target": "com.amazonaws.alexaforbusiness#UpdateRequireCheckIn", - "traits": { - "smithy.api#documentation": "

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" - } - }, "RoomUtilizationMetricsEnabled": { "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { @@ -8598,6 +8586,18 @@ "traits": { "smithy.api#documentation": "

Settings to automatically book an available room available for a configured duration\n when joining a meeting with Alexa.

" } + }, + "RequireCheckIn": { + "target": "com.amazonaws.alexaforbusiness#UpdateRequireCheckIn", + "traits": { + "smithy.api#documentation": "

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

" + } + }, + "EndOfMeetingReminder": { + "target": "com.amazonaws.alexaforbusiness#UpdateEndOfMeetingReminder", + "traits": { + "smithy.api#documentation": "

Settings for the end of meeting reminder feature that are applied to a room profile. The\n end of meeting reminder enables Alexa to remind users when a meeting is ending.

" + } } }, "traits": { @@ -8636,28 +8636,28 @@ "com.amazonaws.alexaforbusiness#UpdateNetworkProfileRequest": { "type": "structure", "members": { - "TrustAnchors": { - "target": "com.amazonaws.alexaforbusiness#TrustAnchorList", + "CertificateAuthorityArn": { + "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { - "smithy.api#documentation": "

The root certificate(s) of your authentication server that will be installed on your\n devices and used to trust your authentication server during EAP negotiation.

" + "smithy.api#documentation": "

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager\n (ACM). This is used to issue certificates to the devices.

" } }, - "NextPassword": { - "target": "com.amazonaws.alexaforbusiness#NextWiFiPassword", + "CurrentPassword": { + "target": "com.amazonaws.alexaforbusiness#CurrentWiFiPassword", "traits": { - "smithy.api#documentation": "

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously\n transmitted to the device and is used when the password of the network changes to\n NextPassword.

" + "smithy.api#documentation": "

The current password of the Wi-Fi network.

" } }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileDescription", + "TrustAnchors": { + "target": "com.amazonaws.alexaforbusiness#TrustAnchorList", "traits": { - "smithy.api#documentation": "

Detailed information about a device's network profile.

" + "smithy.api#documentation": "

The root certificate(s) of your authentication server that will be installed on your\n devices and used to trust your authentication server during EAP negotiation.

" } }, - "NetworkProfileName": { - "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", + "NextPassword": { + "target": "com.amazonaws.alexaforbusiness#NextWiFiPassword", "traits": { - "smithy.api#documentation": "

The name of the network profile associated with a device.

" + "smithy.api#documentation": "

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously\n transmitted to the device and is used when the password of the network changes to\n NextPassword.

" } }, "NetworkProfileArn": { @@ -8667,16 +8667,16 @@ "smithy.api#required": {} } }, - "CertificateAuthorityArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", + "Description": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileDescription", "traits": { - "smithy.api#documentation": "

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager\n (ACM). This is used to issue certificates to the devices.

" + "smithy.api#documentation": "

Detailed information about a device's network profile.

" } }, - "CurrentPassword": { - "target": "com.amazonaws.alexaforbusiness#CurrentWiFiPassword", + "NetworkProfileName": { + "target": "com.amazonaws.alexaforbusiness#NetworkProfileName", "traits": { - "smithy.api#documentation": "

The current password of the Wi-Fi network.

" + "smithy.api#documentation": "

The name of the network profile associated with a device.

" } } } @@ -8711,22 +8711,28 @@ "com.amazonaws.alexaforbusiness#UpdateProfileRequest": { "type": "structure", "members": { - "ProfileName": { - "target": "com.amazonaws.alexaforbusiness#ProfileName", + "Timezone": { + "target": "com.amazonaws.alexaforbusiness#Timezone", "traits": { - "smithy.api#documentation": "

The updated name for the room profile.

" + "smithy.api#documentation": "

The updated timezone for the room profile.

" } }, - "DistanceUnit": { - "target": "com.amazonaws.alexaforbusiness#DistanceUnit", + "MeetingRoomConfiguration": { + "target": "com.amazonaws.alexaforbusiness#UpdateMeetingRoomConfiguration", "traits": { - "smithy.api#documentation": "

The updated distance unit for the room profile.

" + "smithy.api#documentation": "

The updated meeting room settings of a room profile.

" } }, - "TemperatureUnit": { - "target": "com.amazonaws.alexaforbusiness#TemperatureUnit", + "ProfileName": { + "target": "com.amazonaws.alexaforbusiness#ProfileName", "traits": { - "smithy.api#documentation": "

The updated temperature unit for the room profile.

" + "smithy.api#documentation": "

The updated name for the room profile.

" + } + }, + "MaxVolumeLimit": { + "target": "com.amazonaws.alexaforbusiness#MaxVolumeLimit", + "traits": { + "smithy.api#documentation": "

The updated maximum volume limit for the room profile.

" } }, "Locale": { @@ -8735,22 +8741,22 @@ "smithy.api#documentation": "

The updated locale for the room profile. (This is currently only available to a limited preview audience.)

" } }, - "MeetingRoomConfiguration": { - "target": "com.amazonaws.alexaforbusiness#UpdateMeetingRoomConfiguration", + "SetupModeDisabled": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

The updated meeting room settings of a room profile.

" + "smithy.api#documentation": "

Whether the setup mode of the profile is enabled.

" } }, - "Timezone": { - "target": "com.amazonaws.alexaforbusiness#Timezone", + "WakeWord": { + "target": "com.amazonaws.alexaforbusiness#WakeWord", "traits": { - "smithy.api#documentation": "

The updated timezone for the room profile.

" + "smithy.api#documentation": "

The updated wake word for the room profile.

" } }, - "IsDefault": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "TemperatureUnit": { + "target": "com.amazonaws.alexaforbusiness#TemperatureUnit", "traits": { - "smithy.api#documentation": "

Sets the profile as default if selected. If this is missing, no update is done to the\n default status.

" + "smithy.api#documentation": "

The updated temperature unit for the room profile.

" } }, "ProfileArn": { @@ -8759,16 +8765,16 @@ "smithy.api#documentation": "

The ARN of the room profile to update. Required.

" } }, - "MaxVolumeLimit": { - "target": "com.amazonaws.alexaforbusiness#MaxVolumeLimit", + "IsDefault": { + "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { - "smithy.api#documentation": "

The updated maximum volume limit for the room profile.

" + "smithy.api#documentation": "

Sets the profile as default if selected. If this is missing, no update is done to the\n default status.

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

The updated address for the room profile.

" + "smithy.api#documentation": "

The updated distance unit for the room profile.

" } }, "PSTNEnabled": { @@ -8777,16 +8783,10 @@ "smithy.api#documentation": "

Whether the PSTN setting of the room profile is enabled.

" } }, - "WakeWord": { - "target": "com.amazonaws.alexaforbusiness#WakeWord", - "traits": { - "smithy.api#documentation": "

The updated wake word for the room profile.

" - } - }, - "SetupModeDisabled": { - "target": "com.amazonaws.alexaforbusiness#Boolean", + "Address": { + "target": "com.amazonaws.alexaforbusiness#Address", "traits": { - "smithy.api#documentation": "

Whether the setup mode of the profile is enabled.

" + "smithy.api#documentation": "

The updated address for the room profile.

" } } } @@ -8798,17 +8798,17 @@ "com.amazonaws.alexaforbusiness#UpdateRequireCheckIn": { "type": "structure", "members": { - "ReleaseAfterMinutes": { - "target": "com.amazonaws.alexaforbusiness#Minutes", - "traits": { - "smithy.api#documentation": "

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

" - } - }, "Enabled": { "target": "com.amazonaws.alexaforbusiness#Boolean", "traits": { "smithy.api#documentation": "

Whether require check in is enabled or not.

" } + }, + "ReleaseAfterMinutes": { + "target": "com.amazonaws.alexaforbusiness#Minutes", + "traits": { + "smithy.api#documentation": "

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

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

The updated profile ARN for the room.

" } }, - "RoomArn": { - "target": "com.amazonaws.alexaforbusiness#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the room to update.

" - } - }, "ProviderCalendarId": { "target": "com.amazonaws.alexaforbusiness#ProviderCalendarId", "traits": { @@ -8867,6 +8861,12 @@ "traits": { "smithy.api#documentation": "

The updated name for the room.

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

The ARN of the room to update.

" + } } } }, @@ -8900,10 +8900,10 @@ "com.amazonaws.alexaforbusiness#UpdateSkillGroupRequest": { "type": "structure", "members": { - "SkillGroupName": { - "target": "com.amazonaws.alexaforbusiness#SkillGroupName", + "Description": { + "target": "com.amazonaws.alexaforbusiness#SkillGroupDescription", "traits": { - "smithy.api#documentation": "

The updated name for the skill group.

" + "smithy.api#documentation": "

The updated description for the skill group.

" } }, "SkillGroupArn": { @@ -8912,10 +8912,10 @@ "smithy.api#documentation": "

The ARN of the skill group to update.

" } }, - "Description": { - "target": "com.amazonaws.alexaforbusiness#SkillGroupDescription", + "SkillGroupName": { + "target": "com.amazonaws.alexaforbusiness#SkillGroupName", "traits": { - "smithy.api#documentation": "

The updated description for the skill group.

" + "smithy.api#documentation": "

The updated name for the skill group.

" } } } @@ -8951,10 +8951,10 @@ "smithy.api#documentation": "

The enrollment ARN of a user.

" } }, - "FirstName": { - "target": "com.amazonaws.alexaforbusiness#user_FirstName", + "EnrollmentStatus": { + "target": "com.amazonaws.alexaforbusiness#EnrollmentStatus", "traits": { - "smithy.api#documentation": "

The first name of a user.

" + "smithy.api#documentation": "

The enrollment status of a user.

" } }, "LastName": { @@ -8963,17 +8963,17 @@ "smithy.api#documentation": "

The last name of a user.

" } }, - "EnrollmentStatus": { - "target": "com.amazonaws.alexaforbusiness#EnrollmentStatus", - "traits": { - "smithy.api#documentation": "

The enrollment status of a user.

" - } - }, "UserArn": { "target": "com.amazonaws.alexaforbusiness#Arn", "traits": { "smithy.api#documentation": "

The ARN of a user.

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

The first name of a user.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json b/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json index f3cab9e118aa..70f4dad095bc 100644 --- a/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json @@ -185,25 +185,23 @@ "com.amazonaws.amplify#App": { "type": "structure", "members": { - "platform": { - "target": "com.amazonaws.amplify#Platform", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The platform for the Amplify app.

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

The unique ID of the Amplify app.

", "smithy.api#required": {} } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "autoBranchCreationPatterns": { + "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { - "smithy.api#documentation": "

Enables basic authorization for the Amplify app's branches.

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

Describes the automated branch creation glob patterns for the Amplify app.

" } }, - "name": { - "target": "com.amazonaws.amplify#Name", + "customRules": { + "target": "com.amazonaws.amplify#CustomRules", "traits": { - "smithy.api#documentation": "

The name for the Amplify app.

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

Describes the custom redirect and rewrite rules for the Amplify app.

" } }, "environmentVariables": { @@ -213,30 +211,22 @@ "smithy.api#required": {} } }, - "autoBranchCreationPatterns": { - "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", - "traits": { - "smithy.api#documentation": "

Describes the automated branch creation glob patterns for the Amplify app.

" - } - }, - "updateTime": { - "target": "com.amazonaws.amplify#UpdateTime", + "autoBranchCreationConfig": { + "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { - "smithy.api#documentation": "

Updates the date and time for the Amplify app.

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

Describes the automated branch creation configuration for the Amplify app.

" } }, - "appArn": { - "target": "com.amazonaws.amplify#AppArn", + "iamServiceRoleArn": { + "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amplify app.

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

The AWS Identity and Access Management (IAM) service role for the Amazon Resource\n Name (ARN) of the Amplify app.

" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "enableAutoBranchCreation": { + "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Describes the content of the build specification (build spec) for the Amplify app.\n

" + "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" } }, "defaultDomain": { @@ -246,36 +236,46 @@ "smithy.api#required": {} } }, - "createTime": { - "target": "com.amazonaws.amplify#CreateTime", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

Creates a date and time for the Amplify app.

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

Enables basic authorization for the Amplify app's branches.

", "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "enableBranchAutoBuild": { + "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { - "smithy.api#documentation": "

The unique ID of the Amplify app.

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

Enables the auto-building of branches for the Amplify app.

", "smithy.api#required": {} } }, - "enableAutoBranchCreation": { - "target": "com.amazonaws.amplify#EnableAutoBranchCreation", + "repository": { + "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" + "smithy.api#documentation": "

The repository for the Amplify app.

", + "smithy.api#required": {} } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "platform": { + "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app.

" + "smithy.api#documentation": "

The platform for the Amplify app.

", + "smithy.api#required": {} } }, - "enableBranchAutoDeletion": { - "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", + "description": { + "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "

Automatically disconnect a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

The description for the Amplify app.

", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "com.amazonaws.amplify#UpdateTime", + "traits": { + "smithy.api#documentation": "

Updates the date and time for the Amplify app.

", + "smithy.api#required": {} } }, "tags": { @@ -284,49 +284,49 @@ "smithy.api#documentation": "

The tag for the Amplify app.

" } }, - "enableBranchAutoBuild": { - "target": "com.amazonaws.amplify#EnableBranchAutoBuild", + "productionBranch": { + "target": "com.amazonaws.amplify#ProductionBranch", "traits": { - "smithy.api#documentation": "

Enables the auto-building of branches for the Amplify app.

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

Describes the information about a production branch of the Amplify app.

" } }, - "repository": { - "target": "com.amazonaws.amplify#Repository", + "appArn": { + "target": "com.amazonaws.amplify#AppArn", "traits": { - "smithy.api#documentation": "

The repository for the Amplify app.

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

The Amazon Resource Name (ARN) of the Amplify app.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.amplify#Description", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The description for the Amplify app.

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

Describes the content of the build specification (build spec) for the Amplify app.\n

" } }, - "productionBranch": { - "target": "com.amazonaws.amplify#ProductionBranch", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

Describes the information about a production branch of the Amplify app.

" + "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app.

" } }, - "autoBranchCreationConfig": { - "target": "com.amazonaws.amplify#AutoBranchCreationConfig", + "name": { + "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

Describes the automated branch creation configuration for the Amplify app.

" + "smithy.api#documentation": "

The name for the Amplify app.

", + "smithy.api#required": {} } }, - "customRules": { - "target": "com.amazonaws.amplify#CustomRules", + "enableBranchAutoDeletion": { + "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { - "smithy.api#documentation": "

Describes the custom redirect and rewrite rules for the Amplify app.

" + "smithy.api#documentation": "

Automatically disconnect a branch in the Amplify Console when you delete a branch\n from your Git repository.

" } }, - "iamServiceRoleArn": { - "target": "com.amazonaws.amplify#ServiceRoleArn", + "createTime": { + "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for the Amazon Resource\n Name (ARN) of the Amplify app.

" + "smithy.api#documentation": "

Creates a date and time for the Amplify app.

", + "smithy.api#required": {} } } }, @@ -440,16 +440,16 @@ "com.amazonaws.amplify#AutoBranchCreationConfig": { "type": "structure", "members": { - "pullRequestEnvironmentName": { - "target": "com.amazonaws.amplify#PullRequestEnvironmentName", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The Amplify environment name for the pull request.

" + "smithy.api#documentation": "

The environment variables for the autocreated branch.

" } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "enableAutoBuild": { + "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "

Enables basic authorization for the autocreated branch.

" + "smithy.api#documentation": "

Enables auto building for the autocreated branch.

" } }, "framework": { @@ -458,40 +458,46 @@ "smithy.api#documentation": "

The framework for the autocreated branch.

" } }, - "enablePullRequestPreview": { - "target": "com.amazonaws.amplify#EnablePullRequestPreview", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

Enables pull request preview for the autocreated branch.

" + "smithy.api#documentation": "

The basic authorization credentials for the autocreated branch.

" } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "stage": { + "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "

The environment variables for the autocreated branch.

" + "smithy.api#documentation": "

Describes the current stage for the autocreated branch.

" } }, - "enableAutoBuild": { - "target": "com.amazonaws.amplify#EnableAutoBuild", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

Enables auto building for the autocreated branch.

" + "smithy.api#documentation": "

The build specification (build spec) for the autocreated branch.

" } }, - "stage": { - "target": "com.amazonaws.amplify#Stage", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

Describes the current stage for the autocreated branch.

" + "smithy.api#documentation": "

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "enablePullRequestPreview": { + "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for the autocreated branch.

" + "smithy.api#documentation": "

Enables pull request preview for the autocreated branch.

" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "pullRequestEnvironmentName": { + "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for the autocreated branch.

" + "smithy.api#documentation": "

The Amplify environment name for the pull request.

" + } + }, + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", + "traits": { + "smithy.api#documentation": "

Enables basic authorization for the autocreated branch.

" } } }, @@ -542,10 +548,11 @@ "com.amazonaws.amplify#BackendEnvironment": { "type": "structure", "members": { - "deploymentArtifacts": { - "target": "com.amazonaws.amplify#DeploymentArtifacts", + "createTime": { + "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

The name of deployment artifacts.

" + "smithy.api#documentation": "

The creation date and time for a backend environment that is part of an Amplify app.\n

", + "smithy.api#required": {} } }, "backendEnvironmentArn": { @@ -555,13 +562,6 @@ "smithy.api#required": {} } }, - "environmentName": { - "target": "com.amazonaws.amplify#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name for a backend environment that is part of an Amplify app.

", - "smithy.api#required": {} - } - }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { @@ -569,17 +569,23 @@ "smithy.api#required": {} } }, - "createTime": { - "target": "com.amazonaws.amplify#CreateTime", + "stackName": { + "target": "com.amazonaws.amplify#StackName", "traits": { - "smithy.api#documentation": "

The creation date and time for a backend environment that is part of an Amplify app.\n

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

The AWS CloudFormation stack name of a backend environment.

" + } + }, + "environmentName": { + "target": "com.amazonaws.amplify#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name for a backend environment that is part of an Amplify app.

", "smithy.api#required": {} } }, - "stackName": { - "target": "com.amazonaws.amplify#StackName", + "deploymentArtifacts": { + "target": "com.amazonaws.amplify#DeploymentArtifacts", "traits": { - "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" + "smithy.api#documentation": "

The name of deployment artifacts.

" } } }, @@ -628,84 +634,74 @@ "com.amazonaws.amplify#Branch": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "enableAutoBuild": { + "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "

The name for the branch that is part of an Amplify app.

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

Enables auto-building on push for a branch of an Amplify app.

", "smithy.api#required": {} } }, - "pullRequestEnvironmentName": { - "target": "com.amazonaws.amplify#PullRequestEnvironmentName", - "traits": { - "smithy.api#documentation": "

The Amplify environment name for the pull request.

" - } - }, - "thumbnailUrl": { - "target": "com.amazonaws.amplify#ThumbnailUrl", - "traits": { - "smithy.api#documentation": "

The thumbnail URL for the branch of an Amplify app.

" - } - }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { "smithy.api#documentation": "

The tag for the branch of an Amplify app.

" } }, - "activeJobId": { - "target": "com.amazonaws.amplify#ActiveJobId", + "totalNumberOfJobs": { + "target": "com.amazonaws.amplify#TotalNumberOfJobs", "traits": { - "smithy.api#documentation": "

The ID of the active job for a branch of an Amplify app.

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

The total number of jobs that are part of an Amplify app.

", "smithy.api#required": {} } }, - "ttl": { - "target": "com.amazonaws.amplify#TTL", + "sourceBranch": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The content Time to Live (TTL) for the website in seconds.

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

The source branch if the branch is a pull request branch.

" } }, - "enableAutoBuild": { - "target": "com.amazonaws.amplify#EnableAutoBuild", + "thumbnailUrl": { + "target": "com.amazonaws.amplify#ThumbnailUrl", "traits": { - "smithy.api#documentation": "

Enables auto-building on push for a branch of an Amplify app.

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

The thumbnail URL for the branch of an Amplify app.

" } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "pullRequestEnvironmentName": { + "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { - "smithy.api#documentation": "

Enables basic authorization for a branch of an Amplify app.

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

The Amplify environment name for the pull request.

" } }, - "updateTime": { - "target": "com.amazonaws.amplify#UpdateTime", + "destinationBranch": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The last updated date and time for a branch that is part of an Amplify app.

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

The destination branch if the branch is a pull request branch.

" + } + }, + "activeJobId": { + "target": "com.amazonaws.amplify#ActiveJobId", + "traits": { + "smithy.api#documentation": "

The ID of the active job for a branch of an Amplify app.

", "smithy.api#required": {} } }, - "framework": { - "target": "com.amazonaws.amplify#Framework", + "stage": { + "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "

The framework for a branch of an Amplify app.

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

The current stage for the branch that is part of an Amplify app.

", "smithy.api#required": {} } }, - "destinationBranch": { - "target": "com.amazonaws.amplify#BranchName", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

The destination branch if the branch is a pull request branch.

" + "smithy.api#documentation": "

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

" } }, - "stage": { - "target": "com.amazonaws.amplify#Stage", + "associatedResources": { + "target": "com.amazonaws.amplify#AssociatedResources", "traits": { - "smithy.api#documentation": "

The current stage for the branch that is part of an Amplify app.

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

A list of custom resources that are linked to this branch.

" } }, "createTime": { @@ -721,16 +717,32 @@ "smithy.api#documentation": "

The build specification (build spec) content for the branch of an Amplify app.\n

" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "updateTime": { + "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for a branch of an Amplify app.

" + "smithy.api#documentation": "

The last updated date and time for a branch that is part of an Amplify app.

", + "smithy.api#required": {} } }, - "associatedResources": { - "target": "com.amazonaws.amplify#AssociatedResources", + "framework": { + "target": "com.amazonaws.amplify#Framework", "traits": { - "smithy.api#documentation": "

A list of custom resources that are linked to this branch.

" + "smithy.api#documentation": "

The framework for a branch of an Amplify app.

", + "smithy.api#required": {} + } + }, + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", + "traits": { + "smithy.api#documentation": "

Enables basic authorization for a branch of an Amplify app.

", + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.amplify#DisplayName", + "traits": { + "smithy.api#documentation": "

The display name for the branch. This is used as the default domain prefix.

", + "smithy.api#required": {} } }, "description": { @@ -740,16 +752,16 @@ "smithy.api#required": {} } }, - "backendEnvironmentArn": { - "target": "com.amazonaws.amplify#BackendEnvironmentArn", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The basic authorization credentials for a branch of an Amplify app.

" } }, - "displayName": { - "target": "com.amazonaws.amplify#DisplayName", + "customDomains": { + "target": "com.amazonaws.amplify#CustomDomains", "traits": { - "smithy.api#documentation": "

The display name for the branch. This is used as the default domain prefix.

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

The custom domains for a branch of an Amplify app.

", "smithy.api#required": {} } }, @@ -760,26 +772,20 @@ "smithy.api#required": {} } }, - "enablePullRequestPreview": { - "target": "com.amazonaws.amplify#EnablePullRequestPreview", + "enableNotification": { + "target": "com.amazonaws.amplify#EnableNotification", "traits": { - "smithy.api#documentation": "

Enables pull request preview for the branch.

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

Enables notifications for a branch that is part of an Amplify app.

", "smithy.api#required": {} } }, - "totalNumberOfJobs": { - "target": "com.amazonaws.amplify#TotalNumberOfJobs", + "enablePullRequestPreview": { + "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { - "smithy.api#documentation": "

The total number of jobs that are part of an Amplify app.

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

Enables pull request preview for the branch.

", "smithy.api#required": {} } }, - "sourceBranch": { - "target": "com.amazonaws.amplify#BranchName", - "traits": { - "smithy.api#documentation": "

The source branch if the branch is a pull request branch.

" - } - }, "branchArn": { "target": "com.amazonaws.amplify#BranchArn", "traits": { @@ -787,19 +793,25 @@ "smithy.api#required": {} } }, - "customDomains": { - "target": "com.amazonaws.amplify#CustomDomains", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The custom domains for a branch of an Amplify app.

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

The name for the branch that is part of an Amplify app.

", "smithy.api#required": {} } }, - "enableNotification": { - "target": "com.amazonaws.amplify#EnableNotification", + "ttl": { + "target": "com.amazonaws.amplify#TTL", "traits": { - "smithy.api#documentation": "

Enables notifications for a branch that is part of an Amplify app.

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

The content Time to Live (TTL) for the website in seconds.

", "smithy.api#required": {} } + }, + "backendEnvironmentArn": { + "target": "com.amazonaws.amplify#BackendEnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + } } }, "traits": { @@ -928,34 +940,16 @@ "com.amazonaws.amplify#CreateAppRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.amplify#TagMap", - "traits": { - "smithy.api#documentation": "

The tag for an Amplify app.

" - } - }, - "repository": { - "target": "com.amazonaws.amplify#Repository", - "traits": { - "smithy.api#documentation": "

The repository for an Amplify app.

" - } - }, - "enableBranchAutoBuild": { - "target": "com.amazonaws.amplify#EnableBranchAutoBuild", - "traits": { - "smithy.api#documentation": "

Enables the auto building of branches for an Amplify app.

" - } - }, - "enableBranchAutoDeletion": { - "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", + "enableAutoBranchCreation": { + "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

The credentials for basic authorization for an Amplify app.

" + "smithy.api#documentation": "

Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.

" } }, "description": { @@ -964,28 +958,34 @@ "smithy.api#documentation": "

The description for an Amplify app.

" } }, + "platform": { + "target": "com.amazonaws.amplify#Platform", + "traits": { + "smithy.api#documentation": "

The platform or framework for an Amplify app.

" + } + }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { "smithy.api#documentation": "

The personal access token for a third-party source control system for an Amplify app.\n The personal access token is used to create a webhook and a read-only deploy key. The\n token is not stored.

" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "repository": { + "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" + "smithy.api#documentation": "

The repository for an Amplify app.

" } }, - "enableAutoBranchCreation": { - "target": "com.amazonaws.amplify#EnableAutoBranchCreation", + "enableBranchAutoBuild": { + "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" + "smithy.api#documentation": "

Enables the auto building of branches for an Amplify app.

" } }, - "iamServiceRoleArn": { - "target": "com.amazonaws.amplify#ServiceRoleArn", + "tags": { + "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" + "smithy.api#documentation": "

The tag for an Amplify app.

" } }, "oauthToken": { @@ -1000,29 +1000,28 @@ "smithy.api#documentation": "

The automated branch creation glob patterns for the Amplify app.

" } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "customRules": { + "target": "com.amazonaws.amplify#CustomRules", "traits": { - "smithy.api#documentation": "

The environment variables map for an Amplify app.

" + "smithy.api#documentation": "

The custom rewrite and redirect rules for an Amplify app.

" } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.

" + "smithy.api#documentation": "

The environment variables map for an Amplify app.

" } }, - "name": { - "target": "com.amazonaws.amplify#Name", + "iamServiceRoleArn": { + "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

The name for the Amplify app.

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

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" } }, - "platform": { - "target": "com.amazonaws.amplify#Platform", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The platform or framework for an Amplify app.

" + "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" } }, "autoBranchCreationConfig": { @@ -1031,10 +1030,23 @@ "smithy.api#documentation": "

The automated branch creation configuration for the Amplify app.

" } }, - "customRules": { - "target": "com.amazonaws.amplify#CustomRules", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The custom rewrite and redirect rules for an Amplify app.

" + "smithy.api#documentation": "

The credentials for basic authorization for an Amplify app.

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

The name for the Amplify app.

", + "smithy.api#required": {} + } + }, + "enableBranchAutoDeletion": { + "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", + "traits": { + "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" } } }, @@ -1090,12 +1102,6 @@ "com.amazonaws.amplify#CreateBackendEnvironmentRequest": { "type": "structure", "members": { - "stackName": { - "target": "com.amazonaws.amplify#StackName", - "traits": { - "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" - } - }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { @@ -1104,17 +1110,23 @@ "smithy.api#required": {} } }, + "environmentName": { + "target": "com.amazonaws.amplify#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name for the backend environment.

", + "smithy.api#required": {} + } + }, "deploymentArtifacts": { "target": "com.amazonaws.amplify#DeploymentArtifacts", "traits": { "smithy.api#documentation": "

The name of deployment artifacts.

" } }, - "environmentName": { - "target": "com.amazonaws.amplify#EnvironmentName", + "stackName": { + "target": "com.amazonaws.amplify#StackName", "traits": { - "smithy.api#documentation": "

The name for the backend environment.

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

The AWS CloudFormation stack name of a backend environment.

" } } }, @@ -1177,10 +1189,10 @@ "com.amazonaws.amplify#CreateBranchRequest": { "type": "structure", "members": { - "enablePullRequestPreview": { - "target": "com.amazonaws.amplify#EnablePullRequestPreview", + "enableNotification": { + "target": "com.amazonaws.amplify#EnableNotification", "traits": { - "smithy.api#documentation": "

Enables pull request preview for this branch.

" + "smithy.api#documentation": "

Enables notifications for the branch.

" } }, "enableBasicAuth": { @@ -1189,12 +1201,10 @@ "smithy.api#documentation": "

Enables basic authorization for the branch.

" } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

" } }, "stage": { @@ -1203,22 +1213,24 @@ "smithy.api#documentation": "

Describes the current stage for the branch.

" } }, - "enableNotification": { - "target": "com.amazonaws.amplify#EnableNotification", + "enablePullRequestPreview": { + "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { - "smithy.api#documentation": "

Enables notifications for the branch.

" + "smithy.api#documentation": "

Enables pull request preview for this branch.

" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for the branch.

" + "smithy.api#documentation": "

The environment variables for the branch.

" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for the branch.

" + "smithy.api#documentation": "

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ttl": { @@ -1227,10 +1239,34 @@ "smithy.api#documentation": "

The content Time To Live (TTL) for the website in seconds.

" } }, - "pullRequestEnvironmentName": { - "target": "com.amazonaws.amplify#PullRequestEnvironmentName", + "tags": { + "target": "com.amazonaws.amplify#TagMap", + "traits": { + "smithy.api#documentation": "

The tag for the branch.

" + } + }, + "framework": { + "target": "com.amazonaws.amplify#Framework", + "traits": { + "smithy.api#documentation": "

The framework for the branch.

" + } + }, + "backendEnvironmentArn": { + "target": "com.amazonaws.amplify#BackendEnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

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

The description for the branch.

" + } + }, + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The Amplify environment name for the pull request.

" + "smithy.api#documentation": "

The basic authorization credentials for the branch.

" } }, "branchName": { @@ -1240,28 +1276,16 @@ "smithy.api#required": {} } }, - "backendEnvironmentArn": { - "target": "com.amazonaws.amplify#BackendEnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" - } - }, - "framework": { - "target": "com.amazonaws.amplify#Framework", - "traits": { - "smithy.api#documentation": "

The framework for the branch.

" - } - }, - "tags": { - "target": "com.amazonaws.amplify#TagMap", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The tag for the branch.

" + "smithy.api#documentation": "

The build specification (build spec) for the branch.

" } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "enableAutoBuild": { + "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "

The environment variables for the branch.

" + "smithy.api#documentation": "

Enables auto building for the branch.

" } }, "displayName": { @@ -1270,16 +1294,10 @@ "smithy.api#documentation": "

The display name for a branch. This is used as the default domain prefix.

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

The description for the branch.

" - } - }, - "enableAutoBuild": { - "target": "com.amazonaws.amplify#EnableAutoBuild", + "pullRequestEnvironmentName": { + "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { - "smithy.api#documentation": "

Enables auto building for the branch.

" + "smithy.api#documentation": "

The Amplify environment name for the pull request.

" } } }, @@ -1344,12 +1362,6 @@ "smithy.api#required": {} } }, - "fileMap": { - "target": "com.amazonaws.amplify#FileMap", - "traits": { - "smithy.api#documentation": "

An optional file map that contains the file name as the key and the file content md5\n hash as the value. If this argument is provided, the service will generate a unique\n upload URL per file. Otherwise, the service will only generate a single upload URL for\n the zipped files.

" - } - }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { @@ -1357,6 +1369,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "fileMap": { + "target": "com.amazonaws.amplify#FileMap", + "traits": { + "smithy.api#documentation": "

An optional file map that contains the file name as the key and the file content md5\n hash as the value. If this argument is provided, the service will generate a unique\n upload URL per file. Otherwise, the service will only generate a single upload URL for\n the zipped files.

" + } } }, "traits": { @@ -1372,17 +1390,17 @@ "smithy.api#documentation": "

The job ID for this deployment. will supply to start deployment api.

" } }, - "fileUploadUrls": { - "target": "com.amazonaws.amplify#FileUploadUrls", + "zipUploadUrl": { + "target": "com.amazonaws.amplify#UploadUrl", "traits": { - "smithy.api#documentation": "

When the fileMap argument is provided in the request,\n fileUploadUrls will contain a map of file names to upload URLs.

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

When the fileMap argument is not provided in the request, this\n zipUploadUrl is returned.

", "smithy.api#required": {} } }, - "zipUploadUrl": { - "target": "com.amazonaws.amplify#UploadUrl", + "fileUploadUrls": { + "target": "com.amazonaws.amplify#FileUploadUrls", "traits": { - "smithy.api#documentation": "

When the fileMap argument is not provided in the request, this\n zipUploadUrl is returned.

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

When the fileMap argument is provided in the request,\n fileUploadUrls will contain a map of file names to upload URLs.

", "smithy.api#required": {} } } @@ -1431,23 +1449,17 @@ "com.amazonaws.amplify#CreateDomainAssociationRequest": { "type": "structure", "members": { - "autoSubDomainIAMRole": { - "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", - "traits": { - "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" - } - }, - "enableAutoSubDomain": { - "target": "com.amazonaws.amplify#EnableAutoSubDomain", + "domainName": { + "target": "com.amazonaws.amplify#DomainName", "traits": { - "smithy.api#documentation": "

Enables the automated creation of subdomains for branches.

" + "smithy.api#documentation": "

The domain name for the domain association.

", + "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "subDomainSettings": { + "target": "com.amazonaws.amplify#SubDomainSettings", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The setting for the subdomain.

", "smithy.api#required": {} } }, @@ -1457,18 +1469,24 @@ "smithy.api#documentation": "

Sets the branch patterns for automatic subdomain creation.

" } }, - "domainName": { - "target": "com.amazonaws.amplify#DomainName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The domain name for the domain association.

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

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "subDomainSettings": { - "target": "com.amazonaws.amplify#SubDomainSettings", + "enableAutoSubDomain": { + "target": "com.amazonaws.amplify#EnableAutoSubDomain", "traits": { - "smithy.api#documentation": "

The setting for the subdomain.

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

Enables the automated creation of subdomains for branches.

" + } + }, + "autoSubDomainIAMRole": { + "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", + "traits": { + "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" } } }, @@ -1534,6 +1552,14 @@ "com.amazonaws.amplify#CreateWebhookRequest": { "type": "structure", "members": { + "appId": { + "target": "com.amazonaws.amplify#AppId", + "traits": { + "smithy.api#documentation": "

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { @@ -1546,14 +1572,6 @@ "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

", "smithy.api#required": {} } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", - "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -1599,10 +1617,10 @@ "com.amazonaws.amplify#CustomRule": { "type": "structure", "members": { - "source": { - "target": "com.amazonaws.amplify#Source", + "target": { + "target": "com.amazonaws.amplify#Target", "traits": { - "smithy.api#documentation": "

The source pattern for a URL rewrite or redirect rule.

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

The target pattern for a URL rewrite or redirect rule.

", "smithy.api#required": {} } }, @@ -1615,13 +1633,13 @@ "status": { "target": "com.amazonaws.amplify#Status", "traits": { - "smithy.api#documentation": "

The status code for a URL rewrite or redirect rule.

" + "smithy.api#documentation": "

The status code for a URL rewrite or redirect rule.

\n \n
\n
200
\n
\n

Represents a 200 rewrite rule.

\n
\n
301
\n
\n

Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

\n
\n
302
\n
\n

Represents a 302 temporary redirect rule.

\n
\n
404
\n
\n

Represents a 404 redirect rule.

\n
\n
404-200
\n
\n

Represents a 404 rewrite rule.

\n
\n
" } }, - "target": { - "target": "com.amazonaws.amplify#Target", + "source": { + "target": "com.amazonaws.amplify#Source", "traits": { - "smithy.api#documentation": "

The target pattern for a URL rewrite or redirect rule.

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

The source pattern for a URL rewrite or redirect rule.

", "smithy.api#required": {} } } @@ -1828,18 +1846,18 @@ "com.amazonaws.amplify#DeleteBranchRequest": { "type": "structure", "members": { - "appId": { - "target": "com.amazonaws.amplify#AppId", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The name for the branch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1970,14 +1988,6 @@ "com.amazonaws.amplify#DeleteJobRequest": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.amplify#JobId", - "traits": { - "smithy.api#documentation": "

The unique ID for the job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { @@ -1993,6 +2003,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "jobId": { + "target": "com.amazonaws.amplify#JobId", + "traits": { + "smithy.api#documentation": "

The unique ID for the job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -2121,50 +2139,44 @@ "com.amazonaws.amplify#DomainAssociation": { "type": "structure", "members": { - "enableAutoSubDomain": { - "target": "com.amazonaws.amplify#EnableAutoSubDomain", + "certificateVerificationDNSRecord": { + "target": "com.amazonaws.amplify#CertificateVerificationDNSRecord", "traits": { - "smithy.api#documentation": "

Enables the automated creation of subdomains for branches.

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

The DNS record for certificate verification.

" } }, - "statusReason": { - "target": "com.amazonaws.amplify#StatusReason", + "domainStatus": { + "target": "com.amazonaws.amplify#DomainStatus", "traits": { - "smithy.api#documentation": "

The reason for the current status of the domain association.

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

The current status of the domain association.

", "smithy.api#required": {} } }, - "certificateVerificationDNSRecord": { - "target": "com.amazonaws.amplify#CertificateVerificationDNSRecord", - "traits": { - "smithy.api#documentation": "

The DNS record for certificate verification.

" - } - }, - "domainAssociationArn": { - "target": "com.amazonaws.amplify#DomainAssociationArn", + "enableAutoSubDomain": { + "target": "com.amazonaws.amplify#EnableAutoSubDomain", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the domain association.

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

Enables the automated creation of subdomains for branches.

", "smithy.api#required": {} } }, - "autoSubDomainCreationPatterns": { - "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", + "autoSubDomainIAMRole": { + "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", "traits": { - "smithy.api#documentation": "

Sets branch patterns for automatic subdomain creation.

" + "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" } }, - "domainStatus": { - "target": "com.amazonaws.amplify#DomainStatus", + "subDomains": { + "target": "com.amazonaws.amplify#SubDomains", "traits": { - "smithy.api#documentation": "

The current status of the domain association.

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

The subdomains for the domain association.

", "smithy.api#required": {} } }, - "autoSubDomainIAMRole": { - "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", + "domainAssociationArn": { + "target": "com.amazonaws.amplify#DomainAssociationArn", "traits": { - "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the domain association.

", + "smithy.api#required": {} } }, "domainName": { @@ -2174,12 +2186,18 @@ "smithy.api#required": {} } }, - "subDomains": { - "target": "com.amazonaws.amplify#SubDomains", + "statusReason": { + "target": "com.amazonaws.amplify#StatusReason", "traits": { - "smithy.api#documentation": "

The subdomains for the domain association.

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

The reason for the current status of the domain association.

", "smithy.api#required": {} } + }, + "autoSubDomainCreationPatterns": { + "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", + "traits": { + "smithy.api#documentation": "

Sets branch patterns for automatic subdomain creation.

" + } } }, "traits": { @@ -2306,6 +2324,12 @@ "smithy.api#box": {} } }, + "com.amazonaws.amplify#EnablePerformanceMode": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.amplify#EnablePullRequestPreview": { "type": "boolean", "traits": { @@ -2430,6 +2454,12 @@ "com.amazonaws.amplify#GenerateAccessLogsRequest": { "type": "structure", "members": { + "startTime": { + "target": "com.amazonaws.amplify#StartTime", + "traits": { + "smithy.api#documentation": "

The time at which the logs should start. The time range specified is inclusive of the\n start time.

" + } + }, "endTime": { "target": "com.amazonaws.amplify#EndTime", "traits": { @@ -2450,12 +2480,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "startTime": { - "target": "com.amazonaws.amplify#StartTime", - "traits": { - "smithy.api#documentation": "

The time at which the logs should start. The time range specified is inclusive of the\n start time.

" - } } }, "traits": { @@ -2587,17 +2611,17 @@ "com.amazonaws.amplify#GetArtifactUrlResult": { "type": "structure", "members": { - "artifactUrl": { - "target": "com.amazonaws.amplify#ArtifactUrl", + "artifactId": { + "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "

The presigned URL for the artifact.

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

The unique ID for an artifact.

", "smithy.api#required": {} } }, - "artifactId": { - "target": "com.amazonaws.amplify#ArtifactId", + "artifactUrl": { + "target": "com.amazonaws.amplify#ArtifactUrl", "traits": { - "smithy.api#documentation": "

The unique ID for an artifact.

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

The presigned URL for the artifact.

", "smithy.api#required": {} } } @@ -2640,18 +2664,18 @@ "com.amazonaws.amplify#GetBackendEnvironmentRequest": { "type": "structure", "members": { - "appId": { - "target": "com.amazonaws.amplify#AppId", + "environmentName": { + "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The unique id for an Amplify app.

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

The name for the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "environmentName": { - "target": "com.amazonaws.amplify#EnvironmentName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The name for the backend environment.

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

The unique id for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2710,18 +2734,18 @@ "com.amazonaws.amplify#GetBranchRequest": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The name for the branch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2776,18 +2800,18 @@ "com.amazonaws.amplify#GetDomainAssociationRequest": { "type": "structure", "members": { - "domainName": { - "target": "com.amazonaws.amplify#DomainName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The name of the domain.

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

The unique id for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "domainName": { + "target": "com.amazonaws.amplify#DomainName", "traits": { - "smithy.api#documentation": "

The unique id for an Amplify app.

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

The name of the domain.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2849,6 +2873,14 @@ "com.amazonaws.amplify#GetJobRequest": { "type": "structure", "members": { + "appId": { + "target": "com.amazonaws.amplify#AppId", + "traits": { + "smithy.api#documentation": "

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { @@ -2864,14 +2896,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", - "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -2970,17 +2994,17 @@ "com.amazonaws.amplify#Job": { "type": "structure", "members": { - "steps": { - "target": "com.amazonaws.amplify#Steps", + "summary": { + "target": "com.amazonaws.amplify#JobSummary", "traits": { - "smithy.api#documentation": "

The execution steps for an execution job, for an Amplify app.

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

Describes the summary for an execution job for an Amplify app.

", "smithy.api#required": {} } }, - "summary": { - "target": "com.amazonaws.amplify#JobSummary", + "steps": { + "target": "com.amazonaws.amplify#Steps", "traits": { - "smithy.api#documentation": "

Describes the summary for an execution job for an Amplify app.

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

The execution steps for an execution job, for an Amplify app.

", "smithy.api#required": {} } } @@ -3060,27 +3084,6 @@ "com.amazonaws.amplify#JobSummary": { "type": "structure", "members": { - "startTime": { - "target": "com.amazonaws.amplify#StartTime", - "traits": { - "smithy.api#documentation": "

The start date and time for the job.

", - "smithy.api#required": {} - } - }, - "commitId": { - "target": "com.amazonaws.amplify#CommitId", - "traits": { - "smithy.api#documentation": "

The commit ID from a third-party repository provider for the job.

", - "smithy.api#required": {} - } - }, - "jobType": { - "target": "com.amazonaws.amplify#JobType", - "traits": { - "smithy.api#documentation": "

The type for the job. If the value is RELEASE, the job was manually\n released from its source by using the StartJob API. If the value is\n RETRY, the job was manually retried using the StartJob\n API. If the value is WEB_HOOK, the job was automatically triggered by\n webhooks.

", - "smithy.api#required": {} - } - }, "jobArn": { "target": "com.amazonaws.amplify#JobArn", "traits": { @@ -3101,10 +3104,10 @@ "smithy.api#required": {} } }, - "jobId": { - "target": "com.amazonaws.amplify#JobId", + "startTime": { + "target": "com.amazonaws.amplify#StartTime", "traits": { - "smithy.api#documentation": "

The unique ID for the job.

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

The start date and time for the job.

", "smithy.api#required": {} } }, @@ -3121,6 +3124,27 @@ "smithy.api#documentation": "

The commit date and time for the job.

", "smithy.api#required": {} } + }, + "jobId": { + "target": "com.amazonaws.amplify#JobId", + "traits": { + "smithy.api#documentation": "

The unique ID for the job.

", + "smithy.api#required": {} + } + }, + "jobType": { + "target": "com.amazonaws.amplify#JobType", + "traits": { + "smithy.api#documentation": "

The type for the job. If the value is RELEASE, the job was manually\n released from its source by using the StartJob API. If the value is\n RETRY, the job was manually retried using the StartJob\n API. If the value is WEB_HOOK, the job was automatically triggered by\n webhooks.

", + "smithy.api#required": {} + } + }, + "commitId": { + "target": "com.amazonaws.amplify#CommitId", + "traits": { + "smithy.api#documentation": "

The commit ID from a third-party repository provider for the job.

", + "smithy.api#required": {} + } } }, "traits": { @@ -3223,18 +3247,18 @@ "com.amazonaws.amplify#ListAppsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n

" - } - }, "apps": { "target": "com.amazonaws.amplify#Apps", "traits": { "smithy.api#documentation": "

A list of Amplify apps.

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

A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n

" + } } }, "traits": { @@ -3275,6 +3299,13 @@ "com.amazonaws.amplify#ListArtifactsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n

", + "smithy.api#httpQuery": "nextToken" + } + }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { @@ -3290,11 +3321,12 @@ "smithy.api#httpQuery": "maxResults" } }, - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", + "jobId": { + "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n

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

The unique ID for a job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "appId": { @@ -3304,14 +3336,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "jobId": { - "target": "com.amazonaws.amplify#JobId", - "traits": { - "smithy.api#documentation": "

The unique ID for a job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -3370,11 +3394,11 @@ "com.amazonaws.amplify#ListBackendEnvironmentsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.amplify#MaxResults", + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments.

", + "smithy.api#httpQuery": "nextToken" } }, "appId": { @@ -3385,19 +3409,19 @@ "smithy.api#required": {} } }, + "maxResults": { + "target": "com.amazonaws.amplify#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of records to list in a single response.

", + "smithy.api#httpQuery": "maxResults" + } + }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { "smithy.api#documentation": "

The name of the backend environment

", "smithy.api#httpQuery": "environmentName" } - }, - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments.

", - "smithy.api#httpQuery": "nextToken" - } } }, "traits": { @@ -3407,18 +3431,18 @@ "com.amazonaws.amplify#ListBackendEnvironmentsResult": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" + } + }, "backendEnvironments": { "target": "com.amazonaws.amplify#BackendEnvironments", "traits": { "smithy.api#documentation": "

The list of backend environments for an Amplify app.

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

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" - } } }, "traits": { @@ -3456,14 +3480,6 @@ "com.amazonaws.amplify#ListBranchesRequest": { "type": "structure", "members": { - "appId": { - "target": "com.amazonaws.amplify#AppId", - "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { @@ -3477,6 +3493,14 @@ "smithy.api#documentation": "

The maximum number of records to list in a single response.

", "smithy.api#httpQuery": "maxResults" } + }, + "appId": { + "target": "com.amazonaws.amplify#AppId", + "traits": { + "smithy.api#documentation": "

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -3486,18 +3510,18 @@ "com.amazonaws.amplify#ListBranchesResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" - } - }, "branches": { "target": "com.amazonaws.amplify#Branches", "traits": { "smithy.api#documentation": "

A list of branches for an Amplify app.

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

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" + } } }, "traits": { @@ -3535,11 +3559,12 @@ "com.amazonaws.amplify#ListDomainAssociationsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing apps from the start. If non-null, a\n pagination token is returned in a result. Pass its value in here to list more projects.\n

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

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "maxResults": { @@ -3549,12 +3574,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

A pagination token. Set to null to start listing apps from the start. If non-null, a\n pagination token is returned in a result. Pass its value in here to list more projects.\n

", + "smithy.api#httpQuery": "nextToken" } } }, @@ -3565,18 +3589,18 @@ "com.amazonaws.amplify#ListDomainAssociationsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token. If non-null, a pagination token is returned in a result. Pass its\n value in another request to retrieve more entries.

" - } - }, "domainAssociations": { "target": "com.amazonaws.amplify#DomainAssociations", "traits": { "smithy.api#documentation": "

A list of domain associations.

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

A pagination token. If non-null, a pagination token is returned in a result. Pass its\n value in another request to retrieve more entries.

" + } } }, "traits": { @@ -3617,14 +3641,6 @@ "com.amazonaws.amplify#ListJobsRequest": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", - "traits": { - "smithy.api#documentation": "

The name for a branch.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { @@ -3633,6 +3649,13 @@ "smithy.api#required": {} } }, + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n

", + "smithy.api#httpQuery": "nextToken" + } + }, "maxResults": { "target": "com.amazonaws.amplify#MaxResults", "traits": { @@ -3640,11 +3663,12 @@ "smithy.api#httpQuery": "maxResults" } }, - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n

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

The name for a branch.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -3655,18 +3679,18 @@ "com.amazonaws.amplify#ListJobsResult": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. If non-null the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" + } + }, "jobSummaries": { "target": "com.amazonaws.amplify#JobSummaries", "traits": { "smithy.api#documentation": "

The result structure for the list job result request.

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

A pagination token. If non-null the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" - } } }, "traits": { @@ -3765,6 +3789,13 @@ "com.amazonaws.amplify#ListWebhooksRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.amplify#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of records to list in a single response.

", + "smithy.api#httpQuery": "maxResults" + } + }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { @@ -3773,13 +3804,6 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.amplify#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of records to list in a single response.

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { @@ -3795,18 +3819,18 @@ "com.amazonaws.amplify#ListWebhooksResult": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" + } + }, "webhooks": { "target": "com.amazonaws.amplify#Webhooks", "traits": { "smithy.api#documentation": "

A list of webhooks.

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

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" - } } }, "traits": { @@ -3876,7 +3900,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 1000 }, "smithy.api#sensitive": {} } @@ -3895,16 +3919,10 @@ "com.amazonaws.amplify#ProductionBranch": { "type": "structure", "members": { - "thumbnailUrl": { - "target": "com.amazonaws.amplify#ThumbnailUrl", - "traits": { - "smithy.api#documentation": "

The thumbnail URL for the production branch.

" - } - }, - "status": { - "target": "com.amazonaws.amplify#Status", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The status of the production branch.

" + "smithy.api#documentation": "

The branch name for the production branch.

" } }, "lastDeployTime": { @@ -3913,10 +3931,16 @@ "smithy.api#documentation": "

The last deploy time of the production branch.

" } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "status": { + "target": "com.amazonaws.amplify#Status", "traits": { - "smithy.api#documentation": "

The branch name for the production branch.

" + "smithy.api#documentation": "

The status of the production branch.

" + } + }, + "thumbnailUrl": { + "target": "com.amazonaws.amplify#ThumbnailUrl", + "traits": { + "smithy.api#documentation": "

The thumbnail URL for the production branch.

" } } }, @@ -4079,10 +4103,12 @@ "com.amazonaws.amplify#StartDeploymentRequest": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.amplify#JobId", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The job ID for this deployment, generated by the create deployment request.

" + "smithy.api#documentation": "

The name for the branch, for the job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "sourceUrl": { @@ -4099,12 +4125,10 @@ "smithy.api#required": {} } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "jobId": { + "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The job ID for this deployment, generated by the create deployment request.

" } } }, @@ -4164,18 +4188,10 @@ "com.amazonaws.amplify#StartJobRequest": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.amplify#JobId", - "traits": { - "smithy.api#documentation": "

The unique ID for an existing job. This is required if the value of\n jobType is RETRY.

" - } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "commitMessage": { + "target": "com.amazonaws.amplify#CommitMessage", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The commit message from a third-party repository provider for the job.

" } }, "jobReason": { @@ -4184,10 +4200,10 @@ "smithy.api#documentation": "

A descriptive reason for starting this job.

" } }, - "commitMessage": { - "target": "com.amazonaws.amplify#CommitMessage", + "commitId": { + "target": "com.amazonaws.amplify#CommitId", "traits": { - "smithy.api#documentation": "

The commit message from a third-party repository provider for the job.

" + "smithy.api#documentation": "

The commit ID from a third-party repository provider for the job.

" } }, "commitTime": { @@ -4196,6 +4212,20 @@ "smithy.api#documentation": "

The commit date and time for the job.

" } }, + "appId": { + "target": "com.amazonaws.amplify#AppId", + "traits": { + "smithy.api#documentation": "

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.amplify#JobId", + "traits": { + "smithy.api#documentation": "

The unique ID for an existing job. This is required if the value of\n jobType is RETRY.

" + } + }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { @@ -4210,12 +4240,6 @@ "smithy.api#documentation": "

Describes the type for the job. The job type RELEASE starts a new job\n with the latest change from the specified branch. This value is available only for apps\n that are connected to a repository. The job type RETRY retries an existing\n job. If the job type value is RETRY, the jobId is also\n required.

", "smithy.api#required": {} } - }, - "commitId": { - "target": "com.amazonaws.amplify#CommitId", - "traits": { - "smithy.api#documentation": "

The commit ID from a third-party repository provider for the job.

" - } } }, "traits": { @@ -4261,23 +4285,22 @@ "com.amazonaws.amplify#Step": { "type": "structure", "members": { - "context": { - "target": "com.amazonaws.amplify#Context", + "logUrl": { + "target": "com.amazonaws.amplify#LogUrl", "traits": { - "smithy.api#documentation": "

The context for the current step. Includes a build image if the step is build.\n

" + "smithy.api#documentation": "

The URL to the logs for the execution step.

" } }, - "startTime": { - "target": "com.amazonaws.amplify#StartTime", + "testConfigUrl": { + "target": "com.amazonaws.amplify#TestConfigUrl", "traits": { - "smithy.api#documentation": "

The start date and time of the execution step.

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

The URL to the test configuration for the execution step.

" } }, - "stepName": { - "target": "com.amazonaws.amplify#StepName", + "status": { + "target": "com.amazonaws.amplify#JobStatus", "traits": { - "smithy.api#documentation": "

The name of the execution step.

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

The status of the execution step.

", "smithy.api#required": {} } }, @@ -4288,47 +4311,48 @@ "smithy.api#required": {} } }, - "artifactsUrl": { - "target": "com.amazonaws.amplify#ArtifactsUrl", + "screenshots": { + "target": "com.amazonaws.amplify#Screenshots", "traits": { - "smithy.api#documentation": "

The URL to the artifact for the execution step.

" + "smithy.api#documentation": "

The list of screenshot URLs for the execution step, if relevant.

" } }, - "statusReason": { - "target": "com.amazonaws.amplify#StatusReason", + "testArtifactsUrl": { + "target": "com.amazonaws.amplify#TestArtifactsUrl", "traits": { - "smithy.api#documentation": "

The reason for the current step status.

" + "smithy.api#documentation": "

The URL to the test artifact for the execution step.

" } }, - "status": { - "target": "com.amazonaws.amplify#JobStatus", + "startTime": { + "target": "com.amazonaws.amplify#StartTime", "traits": { - "smithy.api#documentation": "

The status of the execution step.

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

The start date and time of the execution step.

", "smithy.api#required": {} } }, - "logUrl": { - "target": "com.amazonaws.amplify#LogUrl", + "context": { + "target": "com.amazonaws.amplify#Context", "traits": { - "smithy.api#documentation": "

The URL to the logs for the execution step.

" + "smithy.api#documentation": "

The context for the current step. Includes a build image if the step is build.\n

" } }, - "testConfigUrl": { - "target": "com.amazonaws.amplify#TestConfigUrl", + "statusReason": { + "target": "com.amazonaws.amplify#StatusReason", "traits": { - "smithy.api#documentation": "

The URL to the test configuration for the execution step.

" + "smithy.api#documentation": "

The reason for the current step status.

" } }, - "screenshots": { - "target": "com.amazonaws.amplify#Screenshots", + "artifactsUrl": { + "target": "com.amazonaws.amplify#ArtifactsUrl", "traits": { - "smithy.api#documentation": "

The list of screenshot URLs for the execution step, if relevant.

" + "smithy.api#documentation": "

The URL to the artifact for the execution step.

" } }, - "testArtifactsUrl": { - "target": "com.amazonaws.amplify#TestArtifactsUrl", + "stepName": { + "target": "com.amazonaws.amplify#StepName", "traits": { - "smithy.api#documentation": "

The URL to the test artifact for the execution step.

" + "smithy.api#documentation": "

The name of the execution step.

", + "smithy.api#required": {} } } }, @@ -4435,10 +4459,10 @@ "com.amazonaws.amplify#SubDomain": { "type": "structure", "members": { - "dnsRecord": { - "target": "com.amazonaws.amplify#DNSRecord", + "subDomainSetting": { + "target": "com.amazonaws.amplify#SubDomainSetting", "traits": { - "smithy.api#documentation": "

The DNS record for the subdomain.

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

Describes the settings for the subdomain.

", "smithy.api#required": {} } }, @@ -4449,10 +4473,10 @@ "smithy.api#required": {} } }, - "subDomainSetting": { - "target": "com.amazonaws.amplify#SubDomainSetting", + "dnsRecord": { + "target": "com.amazonaws.amplify#DNSRecord", "traits": { - "smithy.api#documentation": "

Describes the settings for the subdomain.

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

The DNS record for the subdomain.

", "smithy.api#required": {} } } @@ -4464,17 +4488,17 @@ "com.amazonaws.amplify#SubDomainSetting": { "type": "structure", "members": { - "prefix": { - "target": "com.amazonaws.amplify#DomainPrefix", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The prefix setting for the subdomain.

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

The branch name setting for the subdomain.

", "smithy.api#required": {} } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "prefix": { + "target": "com.amazonaws.amplify#DomainPrefix", "traits": { - "smithy.api#documentation": "

The branch name setting for the subdomain.

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

The prefix setting for the subdomain.

", "smithy.api#required": {} } } @@ -4581,18 +4605,18 @@ "com.amazonaws.amplify#TagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.amplify#ResourceArn", + "tags": { + "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use to tag a resource.

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

The tags used to tag the resource.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.amplify#TagMap", + "resourceArn": { + "target": "com.amazonaws.amplify#ResourceArn", "traits": { - "smithy.api#documentation": "

The tags used to tag the resource.

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

The Amazon Resource Name (ARN) to use to tag a resource.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -4715,14 +4739,6 @@ "com.amazonaws.amplify#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.amplify#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to use to untag a resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { @@ -4730,6 +4746,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tagKeys": { + "target": "com.amazonaws.amplify#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to use to untag a resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } }, "traits": { @@ -4777,46 +4801,70 @@ "com.amazonaws.amplify#UpdateAppRequest": { "type": "structure", "members": { + "accessToken": { + "target": "com.amazonaws.amplify#AccessToken", + "traits": { + "smithy.api#documentation": "

The personal access token for a third-party source control system for an Amplify app.\n The token is used to create webhook and a read-only deploy key. The token is not stored.\n

" + } + }, + "enableBranchAutoDeletion": { + "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", + "traits": { + "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + } + }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "

Enables branch auto-building for an Amplify app.

" + "smithy.api#documentation": "

Enables branch auto-building for an Amplify app.

" + } + }, + "repository": { + "target": "com.amazonaws.amplify#Repository", + "traits": { + "smithy.api#documentation": "

The name of the repository for an Amplify app

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

The description for an Amplify app.

" } }, - "repository": { - "target": "com.amazonaws.amplify#Repository", + "name": { + "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

The name of the repository for an Amplify app

" + "smithy.api#documentation": "

The name for an Amplify app.

" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "iamServiceRoleArn": { + "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for an Amplify app.

" + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" } }, - "accessToken": { - "target": "com.amazonaws.amplify#AccessToken", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The personal access token for a third-party source control system for an Amplify app.\n The token is used to create webhook and a read-only deploy key. The token is not stored.\n

" + "smithy.api#documentation": "

The environment variables for an Amplify app.

" } }, - "enableAutoBranchCreation": { - "target": "com.amazonaws.amplify#EnableAutoBranchCreation", + "autoBranchCreationConfig": { + "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" + "smithy.api#documentation": "

The automated branch creation configuration for the Amplify app.

" } }, - "description": { - "target": "com.amazonaws.amplify#Description", + "customRules": { + "target": "com.amazonaws.amplify#CustomRules", "traits": { - "smithy.api#documentation": "

The description for an Amplify app.

" + "smithy.api#documentation": "

The custom redirect and rewrite rules for an Amplify app.

" } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "autoBranchCreationPatterns": { + "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { - "smithy.api#documentation": "

Enables basic authorization for an Amplify app.

" + "smithy.api#documentation": "

Describes the automated branch creation glob patterns for the Amplify app.

" } }, "oauthToken": { @@ -4831,28 +4879,28 @@ "smithy.api#documentation": "

The platform for an Amplify app.

" } }, - "iamServiceRoleArn": { - "target": "com.amazonaws.amplify#ServiceRoleArn", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" + "smithy.api#documentation": "

The basic authorization credentials for an Amplify app.

" } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

The environment variables for an Amplify app.

" + "smithy.api#documentation": "

Enables basic authorization for an Amplify app.

" } }, - "autoBranchCreationPatterns": { - "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", + "enableAutoBranchCreation": { + "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Describes the automated branch creation glob patterns for the Amplify app.

" + "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" } }, - "customRules": { - "target": "com.amazonaws.amplify#CustomRules", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The custom redirect and rewrite rules for an Amplify app.

" + "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" } }, "appId": { @@ -4862,30 +4910,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "autoBranchCreationConfig": { - "target": "com.amazonaws.amplify#AutoBranchCreationConfig", - "traits": { - "smithy.api#documentation": "

The automated branch creation configuration for the Amplify app.

" - } - }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", - "traits": { - "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" - } - }, - "name": { - "target": "com.amazonaws.amplify#Name", - "traits": { - "smithy.api#documentation": "

The name for an Amplify app.

" - } - }, - "enableBranchAutoDeletion": { - "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", - "traits": { - "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" - } } }, "traits": { @@ -4950,74 +4974,72 @@ "smithy.api#documentation": "

Enables notifications for the branch.

" } }, - "enablePullRequestPreview": { - "target": "com.amazonaws.amplify#EnablePullRequestPreview", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

Enables pull request preview for this branch.

" + "smithy.api#documentation": "

The environment variables for the branch.

" } }, - "stage": { - "target": "com.amazonaws.amplify#Stage", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

Describes the current stage for the branch.

" + "smithy.api#documentation": "

Enables basic authorization for the branch.

" } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The build specification (build spec) for the branch.

" } }, - "displayName": { - "target": "com.amazonaws.amplify#DisplayName", + "ttl": { + "target": "com.amazonaws.amplify#TTL", "traits": { - "smithy.api#documentation": "

The display name for a branch. This is used as the default domain prefix.

" + "smithy.api#documentation": "

The content Time to Live (TTL) for the website in seconds.

" } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "backendEnvironmentArn": { + "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" } }, - "pullRequestEnvironmentName": { - "target": "com.amazonaws.amplify#PullRequestEnvironmentName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The Amplify environment name for the pull request.

" + "smithy.api#documentation": "

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ttl": { - "target": "com.amazonaws.amplify#TTL", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "

The content Time to Live (TTL) for the website in seconds.

" + "smithy.api#documentation": "

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.

" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "framework": { + "target": "com.amazonaws.amplify#Framework", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for the branch.

" + "smithy.api#documentation": "

The framework for the branch.

" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "enablePullRequestPreview": { + "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for the branch.

" + "smithy.api#documentation": "

Enables pull request preview for this branch.

" } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "stage": { + "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "

The environment variables for the branch.

" + "smithy.api#documentation": "

Describes the current stage for the branch.

" } }, - "backendEnvironmentArn": { - "target": "com.amazonaws.amplify#BackendEnvironmentArn", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The basic authorization credentials for the branch.

" } }, "enableAutoBuild": { @@ -5026,16 +5048,18 @@ "smithy.api#documentation": "

Enables auto building for the branch.

" } }, - "framework": { - "target": "com.amazonaws.amplify#Framework", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The framework for the branch.

" + "smithy.api#documentation": "

The name for the branch.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "pullRequestEnvironmentName": { + "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { - "smithy.api#documentation": "

Enables basic authorization for the branch.

" + "smithy.api#documentation": "

The Amplify environment name for the pull request.

" } }, "description": { @@ -5043,6 +5067,12 @@ "traits": { "smithy.api#documentation": "

The description for the branch.

" } + }, + "displayName": { + "target": "com.amazonaws.amplify#DisplayName", + "traits": { + "smithy.api#documentation": "

The display name for a branch. This is used as the default domain prefix.

" + } } }, "traits": { @@ -5101,10 +5131,12 @@ "com.amazonaws.amplify#UpdateDomainAssociationRequest": { "type": "structure", "members": { - "enableAutoSubDomain": { - "target": "com.amazonaws.amplify#EnableAutoSubDomain", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

Enables the automated creation of subdomains for branches.

" + "smithy.api#documentation": "

The unique ID for an Amplify app.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "autoSubDomainCreationPatterns": { @@ -5113,18 +5145,10 @@ "smithy.api#documentation": "

Sets the branch patterns for automatic subdomain creation.

" } }, - "autoSubDomainIAMRole": { - "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", - "traits": { - "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" - } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "enableAutoSubDomain": { + "target": "com.amazonaws.amplify#EnableAutoSubDomain", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

Enables the automated creation of subdomains for branches.

" } }, "subDomainSettings": { @@ -5141,6 +5165,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "autoSubDomainIAMRole": { + "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", + "traits": { + "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" + } } }, "traits": { @@ -5202,10 +5232,12 @@ "com.amazonaws.amplify#UpdateWebhookRequest": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "webhookId": { + "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

" + "smithy.api#documentation": "

The unique ID for a webhook.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "description": { @@ -5214,12 +5246,10 @@ "smithy.api#documentation": "

The description for a webhook.

" } }, - "webhookId": { - "target": "com.amazonaws.amplify#WebhookId", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The unique ID for a webhook.

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

The name for a branch that is part of an Amplify app.

" } } }, @@ -5260,10 +5290,10 @@ "com.amazonaws.amplify#Webhook": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.amplify#Description", + "webhookArn": { + "target": "com.amazonaws.amplify#WebhookArn", "traits": { - "smithy.api#documentation": "

The description for a webhook.

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

The Amazon Resource Name (ARN) for the webhook.

", "smithy.api#required": {} } }, @@ -5274,38 +5304,38 @@ "smithy.api#required": {} } }, - "createTime": { - "target": "com.amazonaws.amplify#CreateTime", + "webhookUrl": { + "target": "com.amazonaws.amplify#WebhookUrl", "traits": { - "smithy.api#documentation": "

The create date and time for a webhook.

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

The URL of the webhook.

", "smithy.api#required": {} } }, - "updateTime": { - "target": "com.amazonaws.amplify#UpdateTime", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

Updates the date and time for a webhook.

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

The name for a branch that is part of an Amplify app.

", "smithy.api#required": {} } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "description": { + "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

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

The description for a webhook.

", "smithy.api#required": {} } }, - "webhookArn": { - "target": "com.amazonaws.amplify#WebhookArn", + "updateTime": { + "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the webhook.

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

Updates the date and time for a webhook.

", "smithy.api#required": {} } }, - "webhookUrl": { - "target": "com.amazonaws.amplify#WebhookUrl", + "createTime": { + "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

The URL of the webhook.

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

The create date and time for a webhook.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json b/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json index c2db527245cd..3994c2f27d5e 100644 --- a/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json +++ b/codegen/sdk-codegen/aws-models/api-gateway.2015-07-09.json @@ -32,16 +32,16 @@ "com.amazonaws.apigateway#AccessLogSettings": { "type": "structure", "members": { - "format": { + "destinationArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

" } }, - "destinationArn": { + "format": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

" + "smithy.api#documentation": "

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

" } } }, @@ -52,28 +52,28 @@ "com.amazonaws.apigateway#Account": { "type": "structure", "members": { - "features": { - "target": "com.amazonaws.apigateway#ListOfString", + "apiKeyVersion": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of \"UsagePlans\".

" + "smithy.api#documentation": "

The version of the API keys used for the account.

" } }, - "apiKeyVersion": { + "cloudwatchRoleArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The version of the API keys used for the account.

" + "smithy.api#documentation": "

The ARN of an Amazon CloudWatch role for the current Account.

" } }, - "throttleSettings": { - "target": "com.amazonaws.apigateway#ThrottleSettings", + "features": { + "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

Specifies the API request limits configured for the current Account.

" + "smithy.api#documentation": "

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of \"UsagePlans\".

" } }, - "cloudwatchRoleArn": { - "target": "com.amazonaws.apigateway#String", + "throttleSettings": { + "target": "com.amazonaws.apigateway#ThrottleSettings", "traits": { - "smithy.api#documentation": "

The ARN of an Amazon CloudWatch role for the current Account.

" + "smithy.api#documentation": "

Specifies the API request limits configured for the current Account.

" } } }, @@ -84,28 +84,16 @@ "com.amazonaws.apigateway#ApiKey": { "type": "structure", "members": { - "name": { + "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The name of the API Key.

" - } - }, - "stageKeys": { - "target": "com.amazonaws.apigateway#ListOfString", - "traits": { - "smithy.api#documentation": "

A list of Stage resources that are associated with the ApiKey resource.

" - } - }, - "createdDate": { - "target": "com.amazonaws.apigateway#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the API Key was created.

" + "smithy.api#documentation": "

The identifier of the API Key.

" } }, - "id": { + "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The identifier of the API Key.

" + "smithy.api#documentation": "

The name of the API Key.

" } }, "customerId": { @@ -114,16 +102,10 @@ "smithy.api#documentation": "

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.apigateway#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the API Key was last updated.

" - } - }, - "enabled": { - "target": "com.amazonaws.apigateway#Boolean", + "stageKeys": { + "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

Specifies whether the API Key can be used by callers.

" + "smithy.api#documentation": "

A list of Stage resources that are associated with the ApiKey resource.

" } }, "tags": { @@ -132,17 +114,35 @@ "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" } }, + "enabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the API Key can be used by callers.

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

The description of the API Key.

" } }, + "lastUpdatedDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the API Key was last updated.

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

The value of the API Key.

" } + }, + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the API Key was created.

" + } } }, "traits": { @@ -152,16 +152,16 @@ "com.amazonaws.apigateway#ApiKeyIds": { "type": "structure", "members": { - "ids": { + "warnings": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

A list of all the ApiKey identifiers.

" + "smithy.api#documentation": "

A list of warning messages.

" } }, - "warnings": { + "ids": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

A list of warning messages.

" + "smithy.api#documentation": "

A list of all the ApiKey identifiers.

" } } }, @@ -226,18 +226,18 @@ "com.amazonaws.apigateway#ApiStage": { "type": "structure", "members": { - "stage": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

API stage name of the associated API stage in a usage plan.

" - } - }, "throttle": { "target": "com.amazonaws.apigateway#MapOfApiStageThrottleSettings", "traits": { "smithy.api#documentation": "

Map containing method level throttling information for API stage in a usage plan.

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

API stage name of the associated API stage in a usage plan.

" + } + }, "apiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -252,10 +252,10 @@ "com.amazonaws.apigateway#Authorizer": { "type": "structure", "members": { - "name": { + "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The name of the authorizer.

" + "smithy.api#documentation": "

The identifier for the authorizer resource.

" } }, "authorizerCredentials": { @@ -264,28 +264,34 @@ "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

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

The identity source for which authorization is requested.

" - } - }, "type": { "target": "com.amazonaws.apigateway#AuthorizerType", "traits": { "smithy.api#documentation": "

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

" } }, + "providerARNs": { + "target": "com.amazonaws.apigateway#ListOfARNs", + "traits": { + "smithy.api#documentation": "

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

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

The identity source for which authorization is requested.

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

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

" } }, - "providerARNs": { - "target": "com.amazonaws.apigateway#ListOfARNs", + "authorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigateway#NullableInteger", "traits": { - "smithy.api#documentation": "

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

" + "smithy.api#documentation": "

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

" } }, "authType": { @@ -300,16 +306,10 @@ "smithy.api#documentation": "

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

" } }, - "authorizerResultTtlInSeconds": { - "target": "com.amazonaws.apigateway#NullableInteger", - "traits": { - "smithy.api#documentation": "

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

" - } - }, - "id": { + "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The identifier for the authorizer resource.

" + "smithy.api#documentation": "

[Required] The name of the authorizer.

" } } }, @@ -729,7 +729,7 @@ "sdkId": "API Gateway", "arnNamespace": "apigateway", "cloudFormationName": "ApiGateway", - "cloudTrailEventSource": "controlplane.backplane.amazonaws.com" + "cloudTrailEventSource": "apigateway.amazonaws.com" }, "aws.auth#sigv4": { "name": "apigateway" @@ -877,22 +877,16 @@ "com.amazonaws.apigateway#CanarySettings": { "type": "structure", "members": { - "stageVariableOverrides": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

" - } - }, "useStageCache": { "target": "com.amazonaws.apigateway#Boolean", "traits": { "smithy.api#documentation": "

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

" } }, - "percentTraffic": { - "target": "com.amazonaws.apigateway#Double", + "stageVariableOverrides": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

The percent (0-100) of traffic diverted to a canary deployment.

" + "smithy.api#documentation": "

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

" } }, "deploymentId": { @@ -900,6 +894,12 @@ "traits": { "smithy.api#documentation": "

The ID of the canary deployment.

" } + }, + "percentTraffic": { + "target": "com.amazonaws.apigateway#Double", + "traits": { + "smithy.api#documentation": "

The percent (0-100) of traffic diverted to a canary deployment.

" + } } }, "traits": { @@ -909,10 +909,16 @@ "com.amazonaws.apigateway#ClientCertificate": { "type": "structure", "members": { - "createdDate": { - "target": "com.amazonaws.apigateway#Timestamp", + "description": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The timestamp when the client certificate was created.

" + "smithy.api#documentation": "

The description of the client certificate.

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

The identifier of the client certificate.

" } }, "pemEncodedCertificate": { @@ -933,16 +939,10 @@ "smithy.api#documentation": "

The timestamp when the client certificate will expire.

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

The description of the client certificate.

" - } - }, - "clientCertificateId": { - "target": "com.amazonaws.apigateway#String", + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier of the client certificate.

" + "smithy.api#documentation": "

The timestamp when the client certificate was created.

" } } }, @@ -1055,12 +1055,12 @@ "com.amazonaws.apigateway#CreateApiKeyRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "title": { "target": "com.amazonaws.apigateway#String" }, @@ -1070,34 +1070,28 @@ "smithy.api#documentation": "

The name of the ApiKey.

" } }, - "stageKeys": { - "target": "com.amazonaws.apigateway#ListOfStageKeys", - "traits": { - "smithy.api#documentation": "

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

" - } - }, - "description": { - "target": "com.amazonaws.apigateway#String", + "generateDistinctId": { + "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

The description of the ApiKey.

" + "smithy.api#documentation": "

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

" } }, - "customerId": { - "target": "com.amazonaws.apigateway#String", + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

" + "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" } }, - "generateDistinctId": { + "enabled": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

" + "smithy.api#documentation": "

Specifies whether the ApiKey can be used by callers.

" } }, - "tags": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "description": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" + "smithy.api#documentation": "

The description of the ApiKey.

" } }, "value": { @@ -1106,10 +1100,16 @@ "smithy.api#documentation": "

Specifies a value of the API key.

" } }, - "enabled": { - "target": "com.amazonaws.apigateway#Boolean", + "stageKeys": { + "target": "com.amazonaws.apigateway#ListOfStageKeys", "traits": { - "smithy.api#documentation": "

Specifies whether the ApiKey can be used by callers.

" + "smithy.api#documentation": "

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

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

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

" } } }, @@ -1154,6 +1154,20 @@ "com.amazonaws.apigateway#CreateAuthorizerRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -1164,20 +1178,12 @@ "smithy.api#required": {} } }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", + "providerARNs": { + "target": "com.amazonaws.apigateway#ListOfARNs", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

" } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "type": { "target": "com.amazonaws.apigateway#AuthorizerType", "traits": { @@ -1191,22 +1197,16 @@ "smithy.api#documentation": "

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

" } }, - "authorizerResultTtlInSeconds": { - "target": "com.amazonaws.apigateway#NullableInteger", - "traits": { - "smithy.api#documentation": "

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

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

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

" } }, - "identitySource": { - "target": "com.amazonaws.apigateway#String", + "authorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigateway#NullableInteger", "traits": { - "smithy.api#documentation": "

The identity source for which authorization is requested.

" + "smithy.api#documentation": "

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

" } }, "authorizerUri": { @@ -1221,10 +1221,10 @@ "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

" } }, - "providerARNs": { - "target": "com.amazonaws.apigateway#ListOfARNs", + "identitySource": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

" + "smithy.api#documentation": "

The identity source for which authorization is requested.

" } } }, @@ -1272,6 +1272,9 @@ "name": { "target": "com.amazonaws.apigateway#String" }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -1280,26 +1283,23 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "stage": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

" + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#required": {} } }, - "restApiId": { + "stage": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

" } }, "basePath": { @@ -1356,9 +1356,6 @@ "com.amazonaws.apigateway#CreateDeploymentRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, @@ -1368,6 +1365,9 @@ "name": { "target": "com.amazonaws.apigateway#String" }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -1376,10 +1376,16 @@ "smithy.api#required": {} } }, - "tracingEnabled": { + "stageDescription": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The description of the Stage resource for the Deployment resource to create.

" + } + }, + "cacheClusterEnabled": { "target": "com.amazonaws.apigateway#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether active tracing with X-ray is enabled for the Stage.

" + "smithy.api#documentation": "

Enables a cache cluster for the Stage resource specified in the input.

" } }, "canarySettings": { @@ -1400,28 +1406,22 @@ "smithy.api#documentation": "

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

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

The description of the Stage resource for the Deployment resource to create.

" - } - }, - "cacheClusterEnabled": { + "tracingEnabled": { "target": "com.amazonaws.apigateway#NullableBoolean", "traits": { - "smithy.api#documentation": "

Enables a cache cluster for the Stage resource specified in the input.

" + "smithy.api#documentation": "

Specifies whether active tracing with X-ray is enabled for the Stage.

" } }, - "stageName": { + "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The name of the Stage resource for the Deployment resource to create.

" + "smithy.api#documentation": "

The description for the Deployment resource to create.

" } }, - "description": { + "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The description for the Deployment resource to create.

" + "smithy.api#documentation": "

The name of the Stage resource for the Deployment resource to create.

" } } }, @@ -1468,8 +1468,8 @@ "com.amazonaws.apigateway#CreateDocumentationPartRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "restApiId": { "target": "com.amazonaws.apigateway#String", @@ -1479,15 +1479,15 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, "title": { "target": "com.amazonaws.apigateway#String" }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "properties": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -1546,12 +1546,6 @@ "com.amazonaws.apigateway#CreateDocumentationVersionRequest": { "type": "structure", "members": { - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -1560,18 +1554,18 @@ "smithy.api#required": {} } }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "stageName": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The stage name to be associated with the new documentation snapshot.

" - } - }, "documentationVersion": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -1584,6 +1578,12 @@ "traits": { "smithy.api#documentation": "

A description about the new documentation snapshot.

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

The stage name to be associated with the new documentation snapshot.

" + } } }, "traits": { @@ -1624,40 +1624,40 @@ "com.amazonaws.apigateway#CreateDomainNameRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, "title": { "target": "com.amazonaws.apigateway#String" }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "certificatePrivateKey": { - "target": "com.amazonaws.apigateway#String", + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

" + "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" } }, - "certificateChain": { - "target": "com.amazonaws.apigateway#String", + "securityPolicy": { + "target": "com.amazonaws.apigateway#SecurityPolicy", "traits": { - "smithy.api#documentation": "

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

" + "smithy.api#documentation": "

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

" } }, - "regionalCertificateName": { + "certificateArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

" + "smithy.api#documentation": "

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

" } }, - "tags": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "certificateName": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" + "smithy.api#documentation": "

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

" } }, "certificateBody": { @@ -1666,17 +1666,19 @@ "smithy.api#documentation": "

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

" } }, - "certificateName": { + "certificatePrivateKey": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

" + "smithy.api#documentation": "

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

" } }, - "domainName": { + "mutualTlsAuthentication": { + "target": "com.amazonaws.apigateway#MutualTlsAuthenticationInput" + }, + "regionalCertificateName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The name of the DomainName resource.

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

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

" } }, "endpointConfiguration": { @@ -1685,16 +1687,17 @@ "smithy.api#documentation": "

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

" } }, - "securityPolicy": { - "target": "com.amazonaws.apigateway#SecurityPolicy", + "domainName": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

" + "smithy.api#documentation": "

[Required] The name of the DomainName resource.

", + "smithy.api#required": {} } }, - "certificateArn": { + "certificateChain": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

" + "smithy.api#documentation": "

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

" } }, "regionalCertificateArn": { @@ -1748,13 +1751,11 @@ "com.amazonaws.apigateway#CreateModelRequest": { "type": "structure", "members": { - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The RestApi identifier under which the Model will be created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" }, "name": { "target": "com.amazonaws.apigateway#String", @@ -1766,11 +1767,19 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { - "target": "com.amazonaws.apigateway#String" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The RestApi identifier under which the Model will be created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "description": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The description of the model.

" + } }, "contentType": { "target": "com.amazonaws.apigateway#String", @@ -1784,12 +1793,6 @@ "traits": { "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

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

The description of the model.

" - } } }, "traits": { @@ -1833,20 +1836,9 @@ "com.amazonaws.apigateway#CreateRequestValidatorRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "title": { "target": "com.amazonaws.apigateway#String" }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, @@ -1856,17 +1848,28 @@ "smithy.api#documentation": "

The name of the to-be-created RequestValidator.

" } }, - "validateRequestBody": { - "target": "com.amazonaws.apigateway#Boolean", + "restApiId": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

" + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "validateRequestParameters": { "target": "com.amazonaws.apigateway#Boolean", "traits": { "smithy.api#documentation": "

A Boolean flag to indicate whether to validate request parameters, true, or not false.

" } + }, + "validateRequestBody": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#documentation": "

A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

" + } } }, "traits": { @@ -1913,6 +1916,9 @@ "com.amazonaws.apigateway#CreateResourceRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -1924,12 +1930,6 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -1938,8 +1938,11 @@ "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" }, "pathPart": { "target": "com.amazonaws.apigateway#String", @@ -1987,9 +1990,6 @@ "com.amazonaws.apigateway#CreateRestApiRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "name": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2003,16 +2003,13 @@ "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "version": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

A version identifier for the API.

" - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "binaryMediaTypes": { - "target": "com.amazonaws.apigateway#ListOfString", + "minimumCompressionSize": { + "target": "com.amazonaws.apigateway#NullableInteger", "traits": { - "smithy.api#documentation": "

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

" + "smithy.api#documentation": "

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

" } }, "apiKeySource": { @@ -2027,22 +2024,28 @@ "smithy.api#documentation": "

The ID of the RestApi that you want to clone from.

" } }, - "endpointConfiguration": { - "target": "com.amazonaws.apigateway#EndpointConfiguration", + "version": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The endpoint configuration of this RestApi showing the endpoint types of the API.

" + "smithy.api#documentation": "

A version identifier for the API.

" } }, - "minimumCompressionSize": { - "target": "com.amazonaws.apigateway#NullableInteger", + "binaryMediaTypes": { + "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

" + "smithy.api#documentation": "

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

" } }, - "description": { - "target": "com.amazonaws.apigateway#String", + "endpointConfiguration": { + "target": "com.amazonaws.apigateway#EndpointConfiguration", "traits": { - "smithy.api#documentation": "

The description of the RestApi.

" + "smithy.api#documentation": "

The endpoint configuration of this RestApi showing the endpoint types of the API.

" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" } }, "policy": { @@ -2051,10 +2054,10 @@ "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration." } }, - "tags": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "description": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" + "smithy.api#documentation": "

The description of the RestApi.

" } } }, @@ -2102,17 +2105,14 @@ "com.amazonaws.apigateway#CreateStageRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "title": { "target": "com.amazonaws.apigateway#String" }, "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "restApiId": { "target": "com.amazonaws.apigateway#String", @@ -2122,34 +2122,26 @@ "smithy.api#required": {} } }, - "tracingEnabled": { - "target": "com.amazonaws.apigateway#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether active tracing with X-ray is enabled for the Stage.

" - } - }, - "cacheClusterSize": { - "target": "com.amazonaws.apigateway#CacheClusterSize", - "traits": { - "smithy.api#documentation": "

The stage's cache cluster size.

" - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "canarySettings": { - "target": "com.amazonaws.apigateway#CanarySettings", + "variables": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

The canary deployment settings of this stage.

" + "smithy.api#documentation": "

A map that defines the stage variables for the new Stage resource. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" } }, - "cacheClusterEnabled": { - "target": "com.amazonaws.apigateway#Boolean", + "stageName": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

Whether cache clustering is enabled for the stage.

" + "smithy.api#documentation": "

[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", + "smithy.api#required": {} } }, - "variables": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "description": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for the new Stage resource. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + "smithy.api#documentation": "

The description of the Stage resource.

" } }, "tags": { @@ -2158,24 +2150,35 @@ "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" } }, - "description": { - "target": "com.amazonaws.apigateway#String", + "tracingEnabled": { + "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

The description of the Stage resource.

" + "smithy.api#documentation": "

Specifies whether active tracing with X-ray is enabled for the Stage.

" } }, - "stageName": { + "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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

[Required] The identifier of the Deployment resource for the Stage resource.

", "smithy.api#required": {} } }, - "deploymentId": { - "target": "com.amazonaws.apigateway#String", + "cacheClusterSize": { + "target": "com.amazonaws.apigateway#CacheClusterSize", "traits": { - "smithy.api#documentation": "

[Required] The identifier of the Deployment resource for the Stage resource.

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

The stage's cache cluster size.

" + } + }, + "canarySettings": { + "target": "com.amazonaws.apigateway#CanarySettings", + "traits": { + "smithy.api#documentation": "

The canary deployment settings of this stage.

" + } + }, + "cacheClusterEnabled": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#documentation": "

Whether cache clustering is enabled for the stage.

" } }, "documentationVersion": { @@ -2263,25 +2266,25 @@ "com.amazonaws.apigateway#CreateUsagePlanKeyRequest": { "type": "structure", "members": { + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "title": { "target": "com.amazonaws.apigateway#String" }, - "usagePlanId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "keyType": { "target": "com.amazonaws.apigateway#String", @@ -2305,6 +2308,12 @@ "com.amazonaws.apigateway#CreateUsagePlanRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "name": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2315,30 +2324,12 @@ "title": { "target": "com.amazonaws.apigateway#String" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "throttle": { - "target": "com.amazonaws.apigateway#ThrottleSettings", - "traits": { - "smithy.api#documentation": "

The throttling limits of the usage plan.

" - } - }, "tags": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" } }, - "apiStages": { - "target": "com.amazonaws.apigateway#ListOfApiStage", - "traits": { - "smithy.api#documentation": "

The associated API stages of the usage plan.

" - } - }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2350,6 +2341,18 @@ "traits": { "smithy.api#documentation": "

The quota of the usage plan.

" } + }, + "throttle": { + "target": "com.amazonaws.apigateway#ThrottleSettings", + "traits": { + "smithy.api#documentation": "

The throttling limits of the usage plan.

" + } + }, + "apiStages": { + "target": "com.amazonaws.apigateway#ListOfApiStage", + "traits": { + "smithy.api#documentation": "

The associated API stages of the usage plan.

" + } } }, "traits": { @@ -2387,6 +2390,9 @@ "com.amazonaws.apigateway#CreateVpcLinkRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "name": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2394,22 +2400,12 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "title": { "target": "com.amazonaws.apigateway#String" }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "targetArns": { - "target": "com.amazonaws.apigateway#ListOfString", - "traits": { - "smithy.api#documentation": "

[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

", - "smithy.api#required": {} - } - }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2421,6 +2417,13 @@ "traits": { "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

" } + }, + "targetArns": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "

[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2455,11 +2458,8 @@ "com.amazonaws.apigateway#DeleteApiKeyRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "apiKey": { "target": "com.amazonaws.apigateway#String", @@ -2469,11 +2469,14 @@ "smithy.api#required": {} } }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -2514,32 +2517,32 @@ "com.amazonaws.apigateway#DeleteAuthorizerRequest": { "type": "structure", "members": { + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "authorizerId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier of the Authorizer resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "restApiId": { + "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of the Authorizer resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" } }, @@ -2581,6 +2584,12 @@ "com.amazonaws.apigateway#DeleteBasePathMappingRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "name": { "target": "com.amazonaws.apigateway#String" }, @@ -2595,9 +2604,6 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "basePath": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2605,9 +2611,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -2651,6 +2654,12 @@ "name": { "target": "com.amazonaws.apigateway#String" }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "clientCertificateId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2658,12 +2667,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -2710,24 +2713,24 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "deploymentId": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier of the Deployment resource to delete.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "restApiId": { + "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of the Deployment resource to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -2767,6 +2770,12 @@ "com.amazonaws.apigateway#DeleteDocumentationPartRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2775,18 +2784,6 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "documentationPartId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -2794,7 +2791,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + } }, "traits": { "smithy.api#documentation": "

Deletes an existing documentation part of an API.

" @@ -2833,33 +2836,33 @@ "com.amazonaws.apigateway#DeleteDocumentationVersionRequest": { "type": "structure", "members": { - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "documentationVersion": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The version identifier of a to-be-deleted documentation snapshot.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "restApiId": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "documentationVersion": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The version identifier of a to-be-deleted documentation snapshot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "template": { "target": "com.amazonaws.apigateway#Boolean" - }, - "name": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -2897,8 +2900,13 @@ "com.amazonaws.apigateway#DeleteDomainNameRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "domainName": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The name of the DomainName resource to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "title": { "target": "com.amazonaws.apigateway#String" @@ -2906,16 +2914,11 @@ "name": { "target": "com.amazonaws.apigateway#String" }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" - }, - "domainName": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The name of the DomainName resource to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -2956,14 +2959,6 @@ "com.amazonaws.apigateway#DeleteGatewayResponseRequest": { "type": "structure", "members": { - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -2978,11 +2973,19 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { - "target": "com.amazonaws.apigateway#String" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "name": { "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -3020,28 +3023,34 @@ "com.amazonaws.apigateway#DeleteIntegrationRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "httpMethod": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a delete integration request's HTTP method.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "restApiId": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] Specifies a delete integration request's HTTP method.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3049,12 +3058,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "name": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -3095,20 +3098,12 @@ "com.amazonaws.apigateway#DeleteIntegrationResponseRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "resourceId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] Specifies a delete integration response request's resource identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "title": { "target": "com.amazonaws.apigateway#String" }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3125,11 +3120,16 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] Specifies a delete integration response request's resource identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "restApiId": { "target": "com.amazonaws.apigateway#String", @@ -3138,6 +3138,9 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -3175,19 +3178,16 @@ "com.amazonaws.apigateway#DeleteMethodRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "restApiId": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The Resource identifier for the Method resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "name": { + "target": "com.amazonaws.apigateway#String" }, "httpMethod": { "target": "com.amazonaws.apigateway#String", @@ -3200,16 +3200,19 @@ "title": { "target": "com.amazonaws.apigateway#String" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "resourceId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The Resource identifier for the Method resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -3250,21 +3253,13 @@ "com.amazonaws.apigateway#DeleteMethodResponseRequest": { "type": "structure", "members": { - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "httpMethod": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The HTTP verb of the Method resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "statusCode": { - "target": "com.amazonaws.apigateway#StatusCode", - "traits": { - "smithy.api#documentation": "

[Required] The status code identifier for the MethodResponse resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3280,19 +3275,27 @@ "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The status code identifier for the MethodResponse resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The HTTP verb of the Method resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -3333,13 +3336,8 @@ "com.amazonaws.apigateway#DeleteModelRequest": { "type": "structure", "members": { - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "modelName": { "target": "com.amazonaws.apigateway#String", @@ -3349,15 +3347,20 @@ "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "title": { "target": "com.amazonaws.apigateway#String" }, "name": { "target": "com.amazonaws.apigateway#String" }, + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "template": { "target": "com.amazonaws.apigateway#Boolean" } @@ -3400,12 +3403,15 @@ "com.amazonaws.apigateway#DeleteRequestValidatorRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3414,12 +3420,6 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3427,6 +3427,9 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -3467,12 +3470,9 @@ "com.amazonaws.apigateway#DeleteResourceRequest": { "type": "structure", "members": { - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3481,11 +3481,11 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "title": { + "target": "com.amazonaws.apigateway#String" }, "resourceId": { "target": "com.amazonaws.apigateway#String", @@ -3494,6 +3494,9 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -3531,6 +3534,15 @@ "com.amazonaws.apigateway#DeleteRestApiRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3539,15 +3551,6 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "name": { "target": "com.amazonaws.apigateway#String" } @@ -3587,10 +3590,7 @@ "com.amazonaws.apigateway#DeleteStageRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, "stageName": { @@ -3601,7 +3601,10 @@ "smithy.api#required": {} } }, - "name": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { "target": "com.amazonaws.apigateway#String" }, "restApiId": { @@ -3612,8 +3615,8 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -3682,33 +3685,33 @@ "com.amazonaws.apigateway#DeleteUsagePlanKeyRequest": { "type": "structure", "members": { - "keyId": { + "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The Id of the UsagePlanKey resource to be deleted.

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

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "title": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, - "usagePlanId": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "keyId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

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

[Required] The Id of the UsagePlanKey resource to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -3718,6 +3721,9 @@ "com.amazonaws.apigateway#DeleteUsagePlanRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "name": { "target": "com.amazonaws.apigateway#String" }, @@ -3729,14 +3735,11 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "title": { + "target": "com.amazonaws.apigateway#String" }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -3774,18 +3777,18 @@ "com.amazonaws.apigateway#DeleteVpcLinkRequest": { "type": "structure", "members": { - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "vpcLinkId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3802,16 +3805,10 @@ "com.amazonaws.apigateway#Deployment": { "type": "structure", "members": { - "createdDate": { - "target": "com.amazonaws.apigateway#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the deployment resource was created.

" - } - }, - "apiSummary": { - "target": "com.amazonaws.apigateway#PathToMapOfMethodSnapshot", + "description": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A summary of the RestApi at the date and time that the deployment resource was created.

" + "smithy.api#documentation": "

The description for the deployment resource.

" } }, "id": { @@ -3820,10 +3817,16 @@ "smithy.api#documentation": "

The identifier for the deployment resource.

" } }, - "description": { - "target": "com.amazonaws.apigateway#String", + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", "traits": { - "smithy.api#documentation": "

The description for the deployment resource.

" + "smithy.api#documentation": "

The date and time that the deployment resource was created.

" + } + }, + "apiSummary": { + "target": "com.amazonaws.apigateway#PathToMapOfMethodSnapshot", + "traits": { + "smithy.api#documentation": "

A summary of the RestApi at the date and time that the deployment resource was created.

" } } }, @@ -3834,18 +3837,18 @@ "com.amazonaws.apigateway#DeploymentCanarySettings": { "type": "structure", "members": { - "stageVariableOverrides": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

" - } - }, "useStageCache": { "target": "com.amazonaws.apigateway#Boolean", "traits": { "smithy.api#documentation": "

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

" } }, + "stageVariableOverrides": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

" + } + }, "percentTraffic": { "target": "com.amazonaws.apigateway#Double", "traits": { @@ -3928,6 +3931,18 @@ "com.amazonaws.apigateway#DocumentationPartLocation": { "type": "structure", "members": { + "method": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

" + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#DocumentationPartLocationStatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

" + } + }, "path": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -3941,23 +3956,11 @@ "smithy.api#required": {} } }, - "statusCode": { - "target": "com.amazonaws.apigateway#DocumentationPartLocationStatusCode", - "traits": { - "smithy.api#documentation": "

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

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

The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.

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

The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

" - } } }, "traits": { @@ -4050,12 +4053,6 @@ "com.amazonaws.apigateway#DocumentationVersion": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The description of the API documentation snapshot.

" - } - }, "createdDate": { "target": "com.amazonaws.apigateway#Timestamp", "traits": { @@ -4067,6 +4064,12 @@ "traits": { "smithy.api#documentation": "

The version identifier of the API documentation snapshot.

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

The description of the API documentation snapshot.

" + } } }, "traits": { @@ -4098,46 +4101,34 @@ "com.amazonaws.apigateway#DomainName": { "type": "structure", "members": { - "regionalDomainName": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

" - } - }, - "certificateName": { + "distributionDomainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

" + "smithy.api#documentation": "

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

" } }, - "distributionHostedZoneId": { - "target": "com.amazonaws.apigateway#String", + "mutualTlsAuthentication": { + "target": "com.amazonaws.apigateway#MutualTlsAuthentication", "traits": { - "smithy.api#documentation": "

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

" } }, - "domainName": { + "domainNameStatusMessage": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The custom domain name as an API host name, for example, my-api.example.com.

" - } - }, - "securityPolicy": { - "target": "com.amazonaws.apigateway#SecurityPolicy", - "traits": { - "smithy.api#documentation": "

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

" + "smithy.api#documentation": "

An optional text message containing detailed information about status of the DomainName migration.

" } }, - "domainNameStatusMessage": { + "regionalDomainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

An optional text message containing detailed information about status of the DomainName migration.

" + "smithy.api#documentation": "

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

" } }, - "regionalCertificateArn": { + "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

" + "smithy.api#documentation": "

The custom domain name as an API host name, for example, my-api.example.com.

" } }, "certificateArn": { @@ -4164,16 +4155,34 @@ "smithy.api#documentation": "

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

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

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

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

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" } }, - "distributionDomainName": { + "securityPolicy": { + "target": "com.amazonaws.apigateway#SecurityPolicy", + "traits": { + "smithy.api#documentation": "

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

" + } + }, + "domainNameStatus": { + "target": "com.amazonaws.apigateway#DomainNameStatus", + "traits": { + "smithy.api#documentation": "

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

" + } + }, + "certificateName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

" + "smithy.api#documentation": "

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

" } }, "tags": { @@ -4182,10 +4191,10 @@ "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" } }, - "domainNameStatus": { - "target": "com.amazonaws.apigateway#DomainNameStatus", + "distributionHostedZoneId": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

" + "smithy.api#documentation": "

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" } } }, @@ -4277,13 +4286,6 @@ "com.amazonaws.apigateway#ExportResponse": { "type": "structure", "members": { - "body": { - "target": "com.amazonaws.apigateway#Blob", - "traits": { - "smithy.api#documentation": "

The binary blob response to GetExport, which contains the export.

", - "smithy.api#httpPayload": {} - } - }, "contentType": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -4291,6 +4293,13 @@ "smithy.api#httpHeader": "Content-Type" } }, + "body": { + "target": "com.amazonaws.apigateway#Blob", + "traits": { + "smithy.api#documentation": "

The binary blob response to GetExport, which contains the export.

", + "smithy.api#httpPayload": {} + } + }, "contentDisposition": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -4334,8 +4343,8 @@ "com.amazonaws.apigateway#FlushStageAuthorizersCacheRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "stageName": { "target": "com.amazonaws.apigateway#String", @@ -4345,11 +4354,8 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "restApiId": { "target": "com.amazonaws.apigateway#String", @@ -4359,8 +4365,11 @@ "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -4398,6 +4407,9 @@ "com.amazonaws.apigateway#FlushStageCacheRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -4406,6 +4418,14 @@ "smithy.api#required": {} } }, + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.apigateway#String" }, @@ -4414,17 +4434,6 @@ }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -4434,24 +4443,12 @@ "com.amazonaws.apigateway#GatewayResponse": { "type": "structure", "members": { - "responseType": { - "target": "com.amazonaws.apigateway#GatewayResponseType", - "traits": { - "smithy.api#documentation": "

The response type of the associated GatewayResponse. Valid values are

" - } - }, "defaultResponse": { "target": "com.amazonaws.apigateway#Boolean", "traits": { "smithy.api#documentation": "

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

" } }, - "responseParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

" - } - }, "responseTemplates": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { @@ -4463,12 +4460,24 @@ "traits": { "smithy.api#documentation": "

The HTTP status code for this GatewayResponse.

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

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

\n
\n For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway\n \n
\n

Example: Get a Gateway Response of a given response type

\n
Request
\n

This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.

\n 
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1\nHost: beta-apigateway.us-east-1.amazonaws.com\nContent-Type: application/json\nX-Amz-Date: 20170503T202516Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a\nCache-Control: no-cache\nPostman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45\n
\n

The response type is specified as a URL path.

\n
Response
\n

The successful operation returns the 200 OK status code and a payload similar to the following:

\n 
{\n  \"_links\": {\n    \"curies\": {\n      \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\",\n      \"name\": \"gatewayresponse\",\n      \"templated\": true\n    },\n    \"self\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n    },\n    \"gatewayresponse:delete\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n    },\n    \"gatewayresponse:put\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n      \"templated\": true\n    },\n    \"gatewayresponse:update\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n    }\n  },\n  \"defaultResponse\": false,\n  \"responseParameters\": {\n    \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\",\n    \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\",\n    \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\",\n    \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\"\n  },\n  \"responseTemplates\": {\n    \"application/json\": \"{\\n     \\\"message\\\": $context.error.messageString,\\n     \\\"type\\\":  \\\"$context.error.responseType\\\",\\n     \\\"stage\\\":  \\\"$context.stage\\\",\\n     \\\"resourcePath\\\":  \\\"$context.resourcePath\\\",\\n     \\\"stageVariables.a\\\":  \\\"$stageVariables.a\\\",\\n     \\\"statusCode\\\": \\\"'404'\\\"\\n}\"\n  },\n  \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\",\n  \"statusCode\": \"404\"\n}
\n

\n
\n\n
\n
\n Customize Gateway Responses\n
" - } - }, + }, + "responseType": { + "target": "com.amazonaws.apigateway#GatewayResponseType", + "traits": { + "smithy.api#documentation": "

The response type of the associated GatewayResponse. Valid values are

" + } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

\n
\n For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway\n \n
\n

Example: Get a Gateway Response of a given response type

\n
Request
\n

This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.

\n 
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1\nHost: beta-apigateway.us-east-1.amazonaws.com\nContent-Type: application/json\nX-Amz-Date: 20170503T202516Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a\nCache-Control: no-cache\nPostman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45\n
\n

The response type is specified as a URL path.

\n
Response
\n

The successful operation returns the 200 OK status code and a payload similar to the following:

\n 
{\n  \"_links\": {\n    \"curies\": {\n      \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\",\n      \"name\": \"gatewayresponse\",\n      \"templated\": true\n    },\n    \"self\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n    },\n    \"gatewayresponse:delete\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n    },\n    \"gatewayresponse:put\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n      \"templated\": true\n    },\n    \"gatewayresponse:update\": {\n      \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n    }\n  },\n  \"defaultResponse\": false,\n  \"responseParameters\": {\n    \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\",\n    \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\",\n    \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\",\n    \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\"\n  },\n  \"responseTemplates\": {\n    \"application/json\": \"{\\n     \\\"message\\\": $context.error.messageString,\\n     \\\"type\\\":  \\\"$context.error.responseType\\\",\\n     \\\"stage\\\":  \\\"$context.stage\\\",\\n     \\\"resourcePath\\\":  \\\"$context.resourcePath\\\",\\n     \\\"stageVariables.a\\\":  \\\"$stageVariables.a\\\",\\n     \\\"statusCode\\\": \\\"'404'\\\"\\n}\"\n  },\n  \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\",\n  \"statusCode\": \"404\"\n}
\n

\n
\n\n
\n
\n Customize Gateway Responses\n
" + } + }, "com.amazonaws.apigateway#GatewayResponseType": { "type": "string", "traits": { @@ -4609,9 +4618,6 @@ "com.amazonaws.apigateway#GenerateClientCertificateRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "title": { "target": "com.amazonaws.apigateway#String" }, @@ -4621,17 +4627,20 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "description": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The description of the ClientCertificate.

" - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "tags": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { "smithy.api#documentation": "

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

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

The description of the ClientCertificate.

" + } } }, "traits": { @@ -4669,17 +4678,17 @@ "com.amazonaws.apigateway#GetAccountRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -4717,20 +4726,6 @@ "com.amazonaws.apigateway#GetApiKeyRequest": { "type": "structure", "members": { - "apiKey": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The identifier of the ApiKey resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "name": { "target": "com.amazonaws.apigateway#String" }, @@ -4743,6 +4738,20 @@ }, "template": { "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "apiKey": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The identifier of the ApiKey resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -4774,18 +4783,20 @@ "method": "GET", "uri": "/apikeys", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetApiKeysRequest": { "type": "structure", "members": { - "nameQuery": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The name of queried API keys.

", - "smithy.api#httpQuery": "name" - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "position": { "target": "com.amazonaws.apigateway#String", @@ -4801,12 +4812,6 @@ "smithy.api#httpQuery": "customerId" } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "includeValues": { "target": "com.amazonaws.apigateway#NullableBoolean", "traits": { @@ -4814,9 +4819,19 @@ "smithy.api#httpQuery": "includeValues" } }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "title": { "target": "com.amazonaws.apigateway#String" }, + "nameQuery": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The name of queried API keys.

", + "smithy.api#httpQuery": "name" + } + }, "limit": { "target": "com.amazonaws.apigateway#NullableInteger", "traits": { @@ -4863,31 +4878,31 @@ "com.amazonaws.apigateway#GetAuthorizerRequest": { "type": "structure", "members": { - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "authorizerId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier of the Authorizer resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "restApiId": { + "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of the Authorizer resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "name": { "target": "com.amazonaws.apigateway#String" } @@ -4930,15 +4945,6 @@ "com.amazonaws.apigateway#GetAuthorizersRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "limit": { "target": "com.amazonaws.apigateway#NullableInteger", "traits": { @@ -4949,13 +4955,6 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "position": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

", - "smithy.api#httpQuery": "position" - } - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -4963,6 +4962,22 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" + } } }, "traits": { @@ -5000,31 +5015,31 @@ "com.amazonaws.apigateway#GetBasePathMappingRequest": { "type": "structure", "members": { - "domainName": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "basePath": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The domain name of the BasePathMapping resource to be described.

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

[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "basePath": { + "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

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

[Required] The domain name of the BasePathMapping resource to be described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" } @@ -5058,22 +5073,28 @@ "method": "GET", "uri": "/domainnames/{domainName}/basepathmappings", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetBasePathMappingsRequest": { "type": "structure", "members": { - "limit": { - "target": "com.amazonaws.apigateway#NullableInteger", + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "position": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -5082,21 +5103,21 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "title": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "position": { - "target": "com.amazonaws.apigateway#String", + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

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

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "smithy.api#httpQuery": "limit" } + }, + "name": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -5134,12 +5155,6 @@ "com.amazonaws.apigateway#GetClientCertificateRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -5151,8 +5166,14 @@ "smithy.api#required": {} } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" + }, + "name": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -5184,27 +5205,36 @@ "method": "GET", "uri": "/clientcertificates", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetClientCertificatesRequest": { "type": "structure", "members": { - "title": { + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "smithy.api#httpQuery": "limit" + } + }, + "name": { "target": "com.amazonaws.apigateway#String" }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, - "limit": { - "target": "com.amazonaws.apigateway#NullableInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", - "smithy.api#httpQuery": "limit" - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "position": { "target": "com.amazonaws.apigateway#String", @@ -5212,9 +5242,6 @@ "smithy.api#documentation": "

The current pagination position in the paged result set.

", "smithy.api#httpQuery": "position" } - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -5255,14 +5282,13 @@ "com.amazonaws.apigateway#GetDeploymentRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The identifier of the Deployment resource to get information about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "embed": { "target": "com.amazonaws.apigateway#ListOfString", @@ -5271,6 +5297,18 @@ "smithy.api#httpQuery": "embed" } }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -5278,17 +5316,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "deploymentId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The identifier of the Deployment resource to get information about.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -5307,6 +5334,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#ServiceUnavailableException" }, @@ -5323,19 +5353,20 @@ "method": "GET", "uri": "/restapis/{restApiId}/deployments", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetDeploymentsRequest": { "type": "structure", "members": { - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "limit": { "target": "com.amazonaws.apigateway#NullableInteger", @@ -5347,11 +5378,16 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "title": { - "target": "com.amazonaws.apigateway#String" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "position": { "target": "com.amazonaws.apigateway#String", @@ -5360,8 +5396,8 @@ "smithy.api#httpQuery": "position" } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -5398,7 +5434,7 @@ "com.amazonaws.apigateway#GetDocumentationPartRequest": { "type": "structure", "members": { - "documentationPartId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", @@ -5406,13 +5442,16 @@ "smithy.api#required": {} } }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "title": { + "target": "com.amazonaws.apigateway#String" }, - "restApiId": { + "documentationPartId": { "target": "com.amazonaws.apigateway#String", "traits": { "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", @@ -5422,9 +5461,6 @@ }, "name": { "target": "com.amazonaws.apigateway#String" - }, - "title": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -5464,8 +5500,23 @@ "com.amazonaws.apigateway#GetDocumentationPartsRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "smithy.api#httpQuery": "limit" + } }, "type": { "target": "com.amazonaws.apigateway#DocumentationPartType", @@ -5474,9 +5525,6 @@ "smithy.api#httpQuery": "type" } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "nameQuery": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -5484,23 +5532,13 @@ "smithy.api#httpQuery": "name" } }, - "position": { + "path": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

", - "smithy.api#httpQuery": "position" - } - }, - "limit": { - "target": "com.amazonaws.apigateway#NullableInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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

The path of API entities of the to-be-retrieved documentation parts.

", + "smithy.api#httpQuery": "path" } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "locationStatus": { "target": "com.amazonaws.apigateway#LocationStatusType", "traits": { @@ -5511,20 +5549,18 @@ "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "path": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The path of API entities of the to-be-retrieved documentation parts.

", - "smithy.api#httpQuery": "path" - } + "title": { + "target": "com.amazonaws.apigateway#String" }, - "restApiId": { + "position": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" } + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -5561,13 +5597,8 @@ "com.amazonaws.apigateway#GetDocumentationVersionRequest": { "type": "structure", "members": { - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "title": { + "target": "com.amazonaws.apigateway#String" }, "template": { "target": "com.amazonaws.apigateway#Boolean" @@ -5580,12 +5611,17 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.apigateway#String" } @@ -5627,12 +5663,14 @@ "com.amazonaws.apigateway#GetDocumentationVersionsRequest": { "type": "structure", "members": { - "restApiId": { - "target": "com.amazonaws.apigateway#String", + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "smithy.api#httpQuery": "limit" } }, "name": { @@ -5645,21 +5683,19 @@ "smithy.api#httpQuery": "position" } }, - "limit": { - "target": "com.amazonaws.apigateway#NullableInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", - "smithy.api#httpQuery": "limit" - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "title": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -5700,18 +5736,15 @@ "com.amazonaws.apigateway#GetDomainNameRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "name": { "target": "com.amazonaws.apigateway#String" }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -5719,6 +5752,9 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -5750,12 +5786,24 @@ "method": "GET", "uri": "/domainnames", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetDomainNamesRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "position": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -5775,12 +5823,6 @@ }, "title": { "target": "com.amazonaws.apigateway#String" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -5824,16 +5866,24 @@ "com.amazonaws.apigateway#GetExportRequest": { "type": "structure", "members": { + "exportType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "parameters": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { "smithy.api#documentation": "

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

" } }, - "restApiId": { + "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The name of the Stage that will be exported.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5845,18 +5895,10 @@ "smithy.api#httpHeader": "Accept" } }, - "exportType": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "stageName": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The name of the Stage that will be exported.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5897,8 +5939,13 @@ "com.amazonaws.apigateway#GetGatewayResponseRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "template": { "target": "com.amazonaws.apigateway#Boolean" @@ -5911,18 +5958,13 @@ "smithy.api#required": {} } }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" } }, @@ -5964,35 +6006,35 @@ "com.amazonaws.apigateway#GetGatewayResponsesRequest": { "type": "structure", "members": { - "limit": { - "target": "com.amazonaws.apigateway#NullableInteger", + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", "traits": { "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

", "smithy.api#httpQuery": "limit" } }, - "restApiId": { + "position": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

", + "smithy.api#httpQuery": "position" } }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "position": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

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

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "template": { @@ -6034,20 +6076,17 @@ "com.amazonaws.apigateway#GetIntegrationRequest": { "type": "structure", "members": { - "restApiId": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] Specifies a get integration request's resource identifier

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -6056,19 +6095,22 @@ "smithy.api#required": {} } }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "resourceId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a get integration request's resource identifier

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -6106,28 +6148,31 @@ "com.amazonaws.apigateway#GetIntegrationResponseRequest": { "type": "structure", "members": { - "statusCode": { - "target": "com.amazonaws.apigateway#StatusCode", + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "httpMethod": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a get integration response request's status code.

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

[Required] Specifies a get integration response request's HTTP method.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "resourceId": { - "target": "com.amazonaws.apigateway#String", + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "

[Required] Specifies a get integration response request's resource identifier.

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

[Required] Specifies a get integration response request's status code.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -6136,19 +6181,16 @@ "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, - "httpMethod": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a get integration response request's HTTP method.

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

[Required] Specifies a get integration response request's resource identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "name": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -6186,23 +6228,17 @@ "com.amazonaws.apigateway#GetMethodRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "name": { + "target": "com.amazonaws.apigateway#String" }, - "resourceId": { + "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The Resource identifier for the Method resource.

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

[Required] Specifies the method request's HTTP method type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -6211,16 +6247,22 @@ "smithy.api#required": {} } }, - "name": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { "target": "com.amazonaws.apigateway#String" }, - "httpMethod": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies the method request's HTTP method type.

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

[Required] The Resource identifier for the Method resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -6258,14 +6300,23 @@ "com.amazonaws.apigateway#GetMethodResponseRequest": { "type": "structure", "members": { - "resourceId": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The Resource identifier for the MethodResponse resource.

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

[Required] The HTTP verb of the Method resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { @@ -6274,22 +6325,16 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "httpMethod": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The HTTP verb of the Method resource.

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

[Required] The Resource identifier for the MethodResponse resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "restApiId": { "target": "com.amazonaws.apigateway#String", @@ -6298,9 +6343,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -6338,16 +6380,8 @@ "com.amazonaws.apigateway#GetModelRequest": { "type": "structure", "members": { - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The RestApi identifier under which the Model exists.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "flatten": { "target": "com.amazonaws.apigateway#Boolean", @@ -6364,12 +6398,20 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The RestApi identifier under which the Model exists.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "title": { "target": "com.amazonaws.apigateway#String" }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "name": { "target": "com.amazonaws.apigateway#String" } @@ -6412,30 +6454,30 @@ "com.amazonaws.apigateway#GetModelTemplateRequest": { "type": "structure", "members": { - "modelName": { + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The name of the model for which to generate a template.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "restApiId": { + "modelName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The name of the model for which to generate a template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "name": { "target": "com.amazonaws.apigateway#String" @@ -6473,12 +6515,29 @@ "method": "GET", "uri": "/restapis/{restApiId}/models", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetModelsRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "limit": { "target": "com.amazonaws.apigateway#NullableInteger", "traits": { @@ -6489,9 +6548,6 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "title": { "target": "com.amazonaws.apigateway#String" }, @@ -6502,16 +6558,8 @@ "smithy.api#httpQuery": "position" } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -6549,33 +6597,33 @@ "com.amazonaws.apigateway#GetRequestValidatorRequest": { "type": "structure", "members": { - "requestValidatorId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The identifier of the RequestValidator to be retrieved.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, "name": { "target": "com.amazonaws.apigateway#String" }, - "title": { - "target": "com.amazonaws.apigateway#String" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "restApiId": { + "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of the RequestValidator to be retrieved.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -6616,9 +6664,6 @@ "com.amazonaws.apigateway#GetRequestValidatorsRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "title": { "target": "com.amazonaws.apigateway#String" }, @@ -6632,23 +6677,26 @@ "smithy.api#httpQuery": "limit" } }, - "position": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

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

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "restApiId": { + "position": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" } + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" } }, "traits": { @@ -6686,18 +6734,18 @@ "com.amazonaws.apigateway#GetResourceRequest": { "type": "structure", "members": { - "restApiId": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier for the Resource resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, "embed": { @@ -6710,16 +6758,16 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "resourceId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier for the Resource resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -6754,34 +6802,32 @@ "method": "GET", "uri": "/restapis/{restApiId}/resources", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetResourcesRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, "title": { "target": "com.amazonaws.apigateway#String" }, - "embed": { - "target": "com.amazonaws.apigateway#ListOfString", + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", "traits": { - "smithy.api#documentation": "

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

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

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "smithy.api#httpQuery": "limit" } }, "position": { @@ -6791,15 +6837,23 @@ "smithy.api#httpQuery": "position" } }, - "limit": { - "target": "com.amazonaws.apigateway#NullableInteger", + "embed": { + "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

", + "smithy.api#httpQuery": "embed" } }, - "name": { - "target": "com.amazonaws.apigateway#String" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -6837,18 +6891,12 @@ "com.amazonaws.apigateway#GetRestApiRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -6856,6 +6904,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -6887,12 +6941,25 @@ "method": "GET", "uri": "/restapis", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetRestApisRequest": { "type": "structure", "members": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" + } + }, "name": { "target": "com.amazonaws.apigateway#String" }, @@ -6903,18 +6970,11 @@ "smithy.api#httpQuery": "limit" } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "title": { "target": "com.amazonaws.apigateway#String" }, - "position": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

", - "smithy.api#httpQuery": "position" - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "template": { "target": "com.amazonaws.apigateway#Boolean" @@ -7026,11 +7086,11 @@ "com.amazonaws.apigateway#GetSdkTypeRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "name": { + "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "title": { + "target": "com.amazonaws.apigateway#String" }, "id": { "target": "com.amazonaws.apigateway#String", @@ -7040,11 +7100,11 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "name": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -7078,12 +7138,22 @@ "com.amazonaws.apigateway#GetSdkTypesRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "name": { + "position": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" + } + }, + "title": { "target": "com.amazonaws.apigateway#String" }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "limit": { "target": "com.amazonaws.apigateway#NullableInteger", "traits": { @@ -7091,17 +7161,7 @@ "smithy.api#httpQuery": "limit" } }, - "position": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

", - "smithy.api#httpQuery": "position" - } - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" } }, @@ -7140,6 +7200,15 @@ "com.amazonaws.apigateway#GetStageRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7151,15 +7220,6 @@ "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7204,15 +7264,8 @@ "com.amazonaws.apigateway#GetStagesRequest": { "type": "structure", "members": { - "deploymentId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The stages' deployment identifiers.

", - "smithy.api#httpQuery": "deploymentId" - } - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "restApiId": { "target": "com.amazonaws.apigateway#String", @@ -7222,14 +7275,21 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "title": { "target": "com.amazonaws.apigateway#String" }, "name": { "target": "com.amazonaws.apigateway#String" + }, + "deploymentId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The stages' deployment identifiers.

", + "smithy.api#httpQuery": "deploymentId" + } } }, "traits": { @@ -7273,12 +7333,6 @@ "com.amazonaws.apigateway#GetTagsRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, @@ -7292,13 +7346,8 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "resourceArn": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The ARN of a resource that can be tagged.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "title": { + "target": "com.amazonaws.apigateway#String" }, "position": { "target": "com.amazonaws.apigateway#String", @@ -7306,6 +7355,17 @@ "smithy.api#documentation": "

(Not currently supported) The current pagination position in the paged result set.

", "smithy.api#httpQuery": "position" } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "resourceArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The ARN of a resource that can be tagged.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -7340,6 +7400,12 @@ "method": "GET", "uri": "/usageplans/{usagePlanId}/usage", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, @@ -7408,12 +7474,6 @@ "com.amazonaws.apigateway#GetUsagePlanKeyRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "keyId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7425,7 +7485,7 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, "usagePlanId": { @@ -7435,6 +7495,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -7469,21 +7535,23 @@ "method": "GET", "uri": "/usageplans/{usagePlanId}/keys", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetUsagePlanKeysRequest": { "type": "structure", "members": { - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, - "limit": { - "target": "com.amazonaws.apigateway#NullableInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", - "smithy.api#httpQuery": "limit" - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "nameQuery": { "target": "com.amazonaws.apigateway#String", @@ -7492,9 +7560,16 @@ "smithy.api#httpQuery": "name" } }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, + "limit": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "smithy.api#httpQuery": "limit" + } + }, "position": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7512,9 +7587,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -7524,6 +7596,9 @@ "com.amazonaws.apigateway#GetUsagePlanRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7535,14 +7610,11 @@ "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "title": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "name": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -7580,33 +7652,30 @@ "method": "GET", "uri": "/usageplans", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetUsagePlansRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "position": { + "keyId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

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

The identifier of the API key associated with the usage plans.

", + "smithy.api#httpQuery": "keyId" } }, - "keyId": { + "position": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The identifier of the API key associated with the usage plans.

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

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" } }, "name": { @@ -7618,6 +7687,15 @@ "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", "smithy.api#httpQuery": "limit" } + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -7627,13 +7705,6 @@ "com.amazonaws.apigateway#GetUsageRequest": { "type": "structure", "members": { - "position": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The current pagination position in the paged result set.

", - "smithy.api#httpQuery": "position" - } - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -7653,6 +7724,9 @@ "smithy.api#required": {} } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7664,14 +7738,11 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "keyId": { + "position": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The Id of the API key associated with the resultant usage data.

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

The current pagination position in the paged result set.

", + "smithy.api#httpQuery": "position" } }, "limit": { @@ -7681,6 +7752,13 @@ "smithy.api#httpQuery": "limit" } }, + "keyId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The Id of the API key associated with the resultant usage data.

", + "smithy.api#httpQuery": "keyId" + } + }, "name": { "target": "com.amazonaws.apigateway#String" } @@ -7720,6 +7798,12 @@ "com.amazonaws.apigateway#GetVpcLinkRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -7731,12 +7815,6 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "title": { "target": "com.amazonaws.apigateway#String" } @@ -7770,21 +7848,21 @@ "method": "GET", "uri": "/vpclinks", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "position", + "outputToken": "position", + "items": "items", + "pageSize": "limit" } } }, "com.amazonaws.apigateway#GetVpcLinksRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "position": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7792,15 +7870,21 @@ "smithy.api#httpQuery": "position" } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "limit": { "target": "com.amazonaws.apigateway#NullableInteger", "traits": { "smithy.api#documentation": "

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", "smithy.api#httpQuery": "limit" } + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" } }, "traits": { @@ -7847,8 +7931,15 @@ "com.amazonaws.apigateway#ImportApiKeysRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" + "failOnWarnings": { + "target": "com.amazonaws.apigateway#Boolean", + "traits": { + "smithy.api#documentation": "

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

", + "smithy.api#httpQuery": "failonwarnings" + } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "format": { "target": "com.amazonaws.apigateway#ApiKeysFormat", @@ -7858,21 +7949,14 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "failOnWarnings": { - "target": "com.amazonaws.apigateway#Boolean", - "traits": { - "smithy.api#documentation": "

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

", - "smithy.api#httpQuery": "failonwarnings" - } - }, "title": { "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -7915,9 +7999,6 @@ "com.amazonaws.apigateway#ImportDocumentationPartsRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -7926,9 +8007,6 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "failOnWarnings": { "target": "com.amazonaws.apigateway#Boolean", "traits": { @@ -7936,6 +8014,12 @@ "smithy.api#httpQuery": "failonwarnings" } }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, @@ -7991,20 +8075,23 @@ "com.amazonaws.apigateway#ImportRestApiRequest": { "type": "structure", "members": { - "failOnWarnings": { - "target": "com.amazonaws.apigateway#Boolean", + "parameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

A query parameter to indicate whether to rollback the API creation (true) or not (false)\n when a warning is encountered. The default value is false.

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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

\n

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

\n

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

\n

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

\n

For example, the AWS CLI command to exclude documentation from the imported API is:

\n 
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
\n

The AWS CLI command to set the regional endpoint on the imported API is:

\n 
aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
" } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "parameters": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "failOnWarnings": { + "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

\n

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

\n

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

\n

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

\n

For example, the AWS CLI command to exclude documentation from the imported API is:

\n 
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
\n

The AWS CLI command to set the regional endpoint on the imported API is:

\n 
aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
" + "smithy.api#documentation": "

A query parameter to indicate whether to rollback the API creation (true) or not (false)\n when a warning is encountered. The default value is false.

", + "smithy.api#httpQuery": "failonwarnings" } }, "name": { @@ -8012,9 +8099,6 @@ }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -8027,22 +8111,16 @@ "com.amazonaws.apigateway#Integration": { "type": "structure", "members": { - "cacheNamespace": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

" - } - }, - "httpMethod": { - "target": "com.amazonaws.apigateway#String", + "tlsConfig": { + "target": "com.amazonaws.apigateway#TlsConfig", "traits": { - "smithy.api#documentation": "

Specifies the integration's HTTP method type.

" + "smithy.api#documentation": "

Specifies the TLS configuration for an integration.

" } }, - "type": { - "target": "com.amazonaws.apigateway#IntegrationType", + "requestParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

Specifies an API method integration type. The valid value is one of the following:

\n \n

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

" + "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" } }, "timeoutInMillis": { @@ -8057,16 +8135,16 @@ "smithy.api#documentation": "

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

\n" } }, - "connectionType": { - "target": "com.amazonaws.apigateway#ConnectionType", + "cacheNamespace": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

" + "smithy.api#documentation": "

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

" } }, - "requestParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "httpMethod": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

" } }, "requestTemplates": { @@ -8075,34 +8153,34 @@ "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

" } }, - "cacheKeyParameters": { - "target": "com.amazonaws.apigateway#ListOfString", - "traits": { - "smithy.api#documentation": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

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

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

" } }, - "passthroughBehavior": { + "connectionType": { + "target": "com.amazonaws.apigateway#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

" + } + }, + "credentials": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "
\n

\n Specifies how the method request body of an unmapped content type will be passed through the integration request\n to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration\n or the content type does not match any of the mapped content types, as specified in requestTemplates.\n The valid value is one of the following:\n

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

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\\*:user/\\*. To use resource-based permissions on supported AWS services, specify null.

" } }, - "tlsConfig": { - "target": "com.amazonaws.apigateway#TlsConfig", + "type": { + "target": "com.amazonaws.apigateway#IntegrationType", "traits": { - "smithy.api#documentation": "

Specifies the TLS configuration for an integration.

" + "smithy.api#documentation": "

Specifies an API method integration type. The valid value is one of the following:

\n \n

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

" } }, - "credentials": { + "passthroughBehavior": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\\*:user/\\*. To use resource-based permissions on supported AWS services, specify null.

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

\n Specifies how the method request body of an unmapped content type will be passed through the integration request\n to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration\n or the content type does not match any of the mapped content types, as specified in requestTemplates.\n The valid value is one of the following:\n

\n \n
" } }, "contentHandling": { @@ -8116,6 +8194,12 @@ "traits": { "smithy.api#documentation": "

Specifies the integration's responses.

\n
\n

\n

Example: Get integration responses of a method

\n
Request
\n

\n 
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20160607T191449Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}\n
\n
Response
\n

The successful response returns 200 OK status and a payload as follows:

\n 
{\n  \"_links\": {\n    \"curies\": {\n      \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\",\n      \"name\": \"integrationresponse\",\n      \"templated\": true\n    },\n    \"self\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\",\n      \"title\": \"200\"\n    },\n    \"integrationresponse:delete\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n    },\n    \"integrationresponse:update\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n    }\n  },\n  \"responseParameters\": {\n    \"method.response.header.Content-Type\": \"'application/xml'\"\n  },\n  \"responseTemplates\": {\n    \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\"\n  },\n  \"statusCode\": \"200\"\n}
\n

\n
\n
\n Creating an API\n
" } + }, + "cacheKeyParameters": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

" + } } }, "traits": { @@ -8125,22 +8209,16 @@ "com.amazonaws.apigateway#IntegrationResponse": { "type": "structure", "members": { - "responseParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the back end.\n The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

" - } - }, "responseTemplates": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { "smithy.api#documentation": "

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

" } }, - "statusCode": { - "target": "com.amazonaws.apigateway#StatusCode", + "contentHandling": { + "target": "com.amazonaws.apigateway#ContentHandlingStrategy", "traits": { - "smithy.api#documentation": "

Specifies the status code that is used to map the integration response to an existing MethodResponse.

" + "smithy.api#documentation": "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

\n \n

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" } }, "selectionPattern": { @@ -8149,10 +8227,16 @@ "smithy.api#documentation": "

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

" } }, - "contentHandling": { - "target": "com.amazonaws.apigateway#ContentHandlingStrategy", + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

\n \n

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the back end.\n The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

" + } + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", + "traits": { + "smithy.api#documentation": "

Specifies the status code that is used to map the integration response to an existing MethodResponse.

" } } }, @@ -8483,16 +8567,16 @@ "com.amazonaws.apigateway#Method": { "type": "structure", "members": { - "requestParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToBoolean", + "apiKeyRequired": { + "target": "com.amazonaws.apigateway#NullableBoolean", "traits": { - "smithy.api#documentation": "

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

" + "smithy.api#documentation": "

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

" } }, - "authorizationType": { + "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

" + "smithy.api#documentation": "

The identifier of a RequestValidator for request validation.

" } }, "httpMethod": { @@ -8501,28 +8585,16 @@ "smithy.api#documentation": "

The method's HTTP verb.

" } }, - "methodResponses": { - "target": "com.amazonaws.apigateway#MapOfMethodResponse", - "traits": { - "smithy.api#documentation": "

Gets a method response associated with a given HTTP status code.

\n
\n

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

\n

Example: Get a 200 OK response of a GET method

\n
Request
\n

\n 
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nContent-Length: 117\nX-Amz-Date: 20160613T215008Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n
Response
\n

The successful response returns a 200 OK status code and a payload similar to the following:

\n 
{\n  \"_links\": {\n    \"curies\": {\n      \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n      \"name\": \"methodresponse\",\n      \"templated\": true\n    },\n    \"self\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\",\n      \"title\": \"200\"\n    },\n    \"methodresponse:delete\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\"\n    },\n    \"methodresponse:update\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\"\n    }\n  },\n  \"responseModels\": {\n    \"application/json\": \"Empty\"\n  },\n  \"responseParameters\": {\n    \"method.response.header.operator\": false,\n    \"method.response.header.operand_2\": false,\n    \"method.response.header.operand_1\": false\n  },\n  \"statusCode\": \"200\"\n}
\n

\n
\n
\n AWS CLI\n
" - } - }, - "requestValidatorId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The identifier of a RequestValidator for request validation.

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

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

" } }, - "methodIntegration": { - "target": "com.amazonaws.apigateway#Integration", + "requestParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToBoolean", "traits": { - "smithy.api#documentation": "

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

\n
\n

\n

Example:

\n
Request
\n

\n 
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nContent-Length: 117\nX-Amz-Date: 20160613T213210Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n
Response
\n

The successful response returns a 200 OK status code and a payload similar to the following:

\n 
{\n  \"_links\": {\n    \"curies\": [\n      {\n        \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\",\n        \"name\": \"integration\",\n        \"templated\": true\n      },\n      {\n        \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\",\n        \"name\": \"integrationresponse\",\n        \"templated\": true\n      }\n    ],\n    \"self\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n    },\n    \"integration:delete\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n    },\n    \"integration:responses\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\",\n      \"name\": \"200\",\n      \"title\": \"200\"\n    },\n    \"integration:update\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n    },\n    \"integrationresponse:put\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}\",\n      \"templated\": true\n    }\n  },\n  \"cacheKeyParameters\": [],\n  \"cacheNamespace\": \"0cjtch\",\n  \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\",\n  \"httpMethod\": \"POST\",\n  \"passthroughBehavior\": \"WHEN_NO_MATCH\",\n  \"requestTemplates\": {\n    \"application/json\": \"{\\n    \\\"a\\\":  \\\"$input.params('operand1')\\\",\\n    \\\"b\\\":  \\\"$input.params('operand2')\\\", \\n    \\\"op\\\": \\\"$input.params('operator')\\\"   \\n}\"\n  },\n  \"type\": \"AWS\",\n  \"uri\": \"arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations\",\n  \"_embedded\": {\n    \"integration:responses\": {\n      \"_links\": {\n        \"self\": {\n          \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\",\n          \"name\": \"200\",\n          \"title\": \"200\"\n        },\n        \"integrationresponse:delete\": {\n          \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\"\n        },\n        \"integrationresponse:update\": {\n          \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\"\n        }\n      },\n      \"responseParameters\": {\n        \"method.response.header.operator\": \"integration.response.body.op\",\n        \"method.response.header.operand_2\": \"integration.response.body.b\",\n        \"method.response.header.operand_1\": \"integration.response.body.a\"\n      },\n      \"responseTemplates\": {\n        \"application/json\": \"#set($res = $input.path('$'))\\n{\\n    \\\"result\\\": \\\"$res.a, $res.b, $res.op => $res.c\\\",\\n  \\\"a\\\" : \\\"$res.a\\\",\\n  \\\"b\\\" : \\\"$res.b\\\",\\n  \\\"op\\\" : \\\"$res.op\\\",\\n  \\\"c\\\" : \\\"$res.c\\\"\\n}\"\n      },\n      \"selectionPattern\": \"\",\n      \"statusCode\": \"200\"\n    }\n  }\n}
\n

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

" } }, "operationName": { @@ -8531,10 +8603,10 @@ "smithy.api#documentation": "

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

" } }, - "apiKeyRequired": { - "target": "com.amazonaws.apigateway#NullableBoolean", + "requestModels": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

" + "smithy.api#documentation": "

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

" } }, "authorizationScopes": { @@ -8543,10 +8615,22 @@ "smithy.api#documentation": "

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

" } }, - "requestModels": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "methodIntegration": { + "target": "com.amazonaws.apigateway#Integration", "traits": { - "smithy.api#documentation": "

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

" + "smithy.api#documentation": "

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

\n
\n

\n

Example:

\n
Request
\n

\n 
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nContent-Length: 117\nX-Amz-Date: 20160613T213210Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n
Response
\n

The successful response returns a 200 OK status code and a payload similar to the following:

\n 
{\n  \"_links\": {\n    \"curies\": [\n      {\n        \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\",\n        \"name\": \"integration\",\n        \"templated\": true\n      },\n      {\n        \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\",\n        \"name\": \"integrationresponse\",\n        \"templated\": true\n      }\n    ],\n    \"self\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n    },\n    \"integration:delete\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n    },\n    \"integration:responses\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\",\n      \"name\": \"200\",\n      \"title\": \"200\"\n    },\n    \"integration:update\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n    },\n    \"integrationresponse:put\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}\",\n      \"templated\": true\n    }\n  },\n  \"cacheKeyParameters\": [],\n  \"cacheNamespace\": \"0cjtch\",\n  \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\",\n  \"httpMethod\": \"POST\",\n  \"passthroughBehavior\": \"WHEN_NO_MATCH\",\n  \"requestTemplates\": {\n    \"application/json\": \"{\\n    \\\"a\\\":  \\\"$input.params('operand1')\\\",\\n    \\\"b\\\":  \\\"$input.params('operand2')\\\", \\n    \\\"op\\\": \\\"$input.params('operator')\\\"   \\n}\"\n  },\n  \"type\": \"AWS\",\n  \"uri\": \"arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations\",\n  \"_embedded\": {\n    \"integration:responses\": {\n      \"_links\": {\n        \"self\": {\n          \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\",\n          \"name\": \"200\",\n          \"title\": \"200\"\n        },\n        \"integrationresponse:delete\": {\n          \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\"\n        },\n        \"integrationresponse:update\": {\n          \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\"\n        }\n      },\n      \"responseParameters\": {\n        \"method.response.header.operator\": \"integration.response.body.op\",\n        \"method.response.header.operand_2\": \"integration.response.body.b\",\n        \"method.response.header.operand_1\": \"integration.response.body.a\"\n      },\n      \"responseTemplates\": {\n        \"application/json\": \"#set($res = $input.path('$'))\\n{\\n    \\\"result\\\": \\\"$res.a, $res.b, $res.op => $res.c\\\",\\n  \\\"a\\\" : \\\"$res.a\\\",\\n  \\\"b\\\" : \\\"$res.b\\\",\\n  \\\"op\\\" : \\\"$res.op\\\",\\n  \\\"c\\\" : \\\"$res.c\\\"\\n}\"\n      },\n      \"selectionPattern\": \"\",\n      \"statusCode\": \"200\"\n    }\n  }\n}
\n

\n
\n
\n AWS CLI\n
" + } + }, + "methodResponses": { + "target": "com.amazonaws.apigateway#MapOfMethodResponse", + "traits": { + "smithy.api#documentation": "

Gets a method response associated with a given HTTP status code.

\n
\n

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

\n

Example: Get a 200 OK response of a GET method

\n
Request
\n

\n 
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nContent-Length: 117\nX-Amz-Date: 20160613T215008Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n
Response
\n

The successful response returns a 200 OK status code and a payload similar to the following:

\n 
{\n  \"_links\": {\n    \"curies\": {\n      \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n      \"name\": \"methodresponse\",\n      \"templated\": true\n    },\n    \"self\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\",\n      \"title\": \"200\"\n    },\n    \"methodresponse:delete\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\"\n    },\n    \"methodresponse:update\": {\n      \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\"\n    }\n  },\n  \"responseModels\": {\n    \"application/json\": \"Empty\"\n  },\n  \"responseParameters\": {\n    \"method.response.header.operator\": false,\n    \"method.response.header.operand_2\": false,\n    \"method.response.header.operand_1\": false\n  },\n  \"statusCode\": \"200\"\n}
\n

\n
\n
\n AWS CLI\n
" + } + }, + "authorizationType": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

" } } }, @@ -8557,6 +8641,12 @@ "com.amazonaws.apigateway#MethodResponse": { "type": "structure", "members": { + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToBoolean", + "traits": { + "smithy.api#documentation": "

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

" + } + }, "responseModels": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { @@ -8568,31 +8658,25 @@ "traits": { "smithy.api#documentation": "

The method response's status code.

" } - }, - "responseParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToBoolean", - "traits": { - "smithy.api#documentation": "

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

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

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

\n
\n

\n

Example: A MethodResponse instance of an API

\n
Request
\n

The example request retrieves a MethodResponse of the 200 status code.

\n 
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20160603T222952Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n
Response
\n

The successful response returns 200 OK status and a payload as follows:

\n 
{\n  \"_links\": {\n    \"curies\": {\n      \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n      \"name\": \"methodresponse\",\n      \"templated\": true\n    },\n    \"self\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\",\n      \"title\": \"200\"\n    },\n    \"methodresponse:delete\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n    },\n    \"methodresponse:update\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n    }\n  },\n  \"responseModels\": {\n    \"application/json\": \"Empty\"\n  },\n  \"responseParameters\": {\n    \"method.response.header.Content-Type\": false\n  },\n  \"statusCode\": \"200\"\n}
\n

\n
\n
\n Method, IntegrationResponse, Integration\n Creating an API\n
" + "smithy.api#documentation": "

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

\n
\n

\n

Example: A MethodResponse instance of an API

\n
Request
\n

The example request retrieves a MethodResponse of the 200 status code.

\n 
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20160603T222952Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n
Response
\n

The successful response returns 200 OK status and a payload as follows:

\n 
{\n  \"_links\": {\n    \"curies\": {\n      \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n      \"name\": \"methodresponse\",\n      \"templated\": true\n    },\n    \"self\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\",\n      \"title\": \"200\"\n    },\n    \"methodresponse:delete\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n    },\n    \"methodresponse:update\": {\n      \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n    }\n  },\n  \"responseModels\": {\n    \"application/json\": \"Empty\"\n  },\n  \"responseParameters\": {\n    \"method.response.header.Content-Type\": false\n  },\n  \"statusCode\": \"200\"\n}
\n

\n
\n
\n Method, IntegrationResponse, Integration\n Creating an API\n
" } }, "com.amazonaws.apigateway#MethodSetting": { "type": "structure", "members": { - "requireAuthorizationForCacheControl": { + "cacheDataEncrypted": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

" + "smithy.api#documentation": "

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

" } }, - "loggingLevel": { - "target": "com.amazonaws.apigateway#String", + "throttlingBurstLimit": { + "target": "com.amazonaws.apigateway#Integer", "traits": { - "smithy.api#documentation": "

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

" + "smithy.api#documentation": "

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

" } }, "dataTraceEnabled": { @@ -8601,28 +8685,28 @@ "smithy.api#documentation": "

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

" } }, - "cacheDataEncrypted": { - "target": "com.amazonaws.apigateway#Boolean", + "unauthorizedCacheControlHeaderStrategy": { + "target": "com.amazonaws.apigateway#UnauthorizedCacheControlHeaderStrategy", "traits": { - "smithy.api#documentation": "

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

" + "smithy.api#documentation": "

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

" } }, - "cachingEnabled": { + "requireAuthorizationForCacheControl": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

" + "smithy.api#documentation": "

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

" } }, - "metricsEnabled": { - "target": "com.amazonaws.apigateway#Boolean", + "loggingLevel": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

" + "smithy.api#documentation": "

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

" } }, - "throttlingBurstLimit": { - "target": "com.amazonaws.apigateway#Integer", + "cachingEnabled": { + "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

" + "smithy.api#documentation": "

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

" } }, "cacheTtlInSeconds": { @@ -8631,16 +8715,16 @@ "smithy.api#documentation": "

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

" } }, - "throttlingRateLimit": { - "target": "com.amazonaws.apigateway#Double", + "metricsEnabled": { + "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

" + "smithy.api#documentation": "

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

" } }, - "unauthorizedCacheControlHeaderStrategy": { - "target": "com.amazonaws.apigateway#UnauthorizedCacheControlHeaderStrategy", + "throttlingRateLimit": { + "target": "com.amazonaws.apigateway#Double", "traits": { - "smithy.api#documentation": "

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

" + "smithy.api#documentation": "

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

" } } }, @@ -8651,17 +8735,17 @@ "com.amazonaws.apigateway#MethodSnapshot": { "type": "structure", "members": { - "authorizationType": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

" - } - }, "apiKeyRequired": { "target": "com.amazonaws.apigateway#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the method requires a valid ApiKey.

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

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

" + } } }, "traits": { @@ -8671,22 +8755,22 @@ "com.amazonaws.apigateway#Model": { "type": "structure", "members": { - "id": { + "schema": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The identifier for the model resource.

" + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

" } }, - "name": { + "contentType": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The name of the model. Must be an alphanumeric string.

" + "smithy.api#documentation": "

The content-type for the model.

" } }, - "contentType": { + "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The content-type for the model.

" + "smithy.api#documentation": "

The name of the model. Must be an alphanumeric string.

" } }, "description": { @@ -8695,10 +8779,10 @@ "smithy.api#documentation": "

The description of the model.

" } }, - "schema": { + "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

" + "smithy.api#documentation": "

The identifier for the model resource.

" } } }, @@ -8728,6 +8812,52 @@ "smithy.api#documentation": "

Represents a collection of Model resources.

\n
\n Method, MethodResponse, Models and Mappings\n
" } }, + "com.amazonaws.apigateway#MutualTlsAuthentication": { + "type": "structure", + "members": { + "truststoreVersion": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.

" + } + }, + "truststoreWarnings": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "

A list of warnings that API Gateway returns while processing your truststore. Invalid\n certificates produce warnings. Mutual TLS is still enabled, but some clients might not\n be able to access your API. To resolve warnings, upload a new truststore to S3, and then\n update you domain name to use the new version.

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

An Amazon S3 URL that specifies the truststore for mutual TLS authentication,\n for example s3://bucket-name/key-name.\n The truststore can contain certificates from public or private certificate authorities.\n To update the truststore, upload a new version to S3, and then update your custom domain\n name to use the new version. To update the truststore, you must have permissions to\n access the S3 object.

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

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.

" + } + }, + "com.amazonaws.apigateway#MutualTlsAuthenticationInput": { + "type": "structure", + "members": { + "truststoreVersion": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.

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

An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication,\n for example,\n s3://bucket-name/key-name.\n The truststore can contain certificates from public or private certificate authorities.\n To update the truststore, upload a new version to S3, and then update your custom domain\n name to use the new version. To update the truststore, you must have permissions to\n access the S3 object.

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

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.

" + } + }, "com.amazonaws.apigateway#NotFoundException": { "type": "structure", "members": { @@ -8781,22 +8911,16 @@ "com.amazonaws.apigateway#PatchOperation": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see Using JSON for Parameters.

" - } - }, "op": { "target": "com.amazonaws.apigateway#Op", "traits": { "smithy.api#documentation": "

An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

" } }, - "from": { + "value": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with \"op\":\"copy\", \"from\":\"/canarySettings/deploymentId\" and \"path\":\"/deploymentId\".

" + "smithy.api#documentation": "

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see Using JSON for Parameters.

" } }, "path": { @@ -8804,6 +8928,12 @@ "traits": { "smithy.api#documentation": "

The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {\"name\":\"value\"}, the path for this property is /name. If the name property value is a JSON object (e.g., {\"name\": {\"child/name\": \"child-value\"}}), the path for the child/name property will be /name/child~1name. Any slash (\"/\") character appearing in path names must be escaped with \"~1\", as shown in the example above. Each op operation can have only one path associated with it.

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

The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with \"op\":\"copy\", \"from\":\"/canarySettings/deploymentId\" and \"path\":\"/deploymentId\".

" + } } }, "traits": { @@ -8859,20 +8989,15 @@ "com.amazonaws.apigateway#PutGatewayResponseRequest": { "type": "structure", "members": { - "responseType": { - "target": "com.amazonaws.apigateway#GatewayResponseType", - "traits": { - "smithy.api#documentation": "

[Required]

The response type of the associated GatewayResponse. Valid values are

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -8881,16 +9006,15 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "title": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, - "responseTemplates": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "responseType": { + "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

" + "smithy.api#documentation": "

[Required]

The response type of the associated GatewayResponse. Valid values are

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "statusCode": { @@ -8904,6 +9028,12 @@ "traits": { "smithy.api#documentation": "

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

" } + }, + "responseTemplates": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

" + } } }, "traits": { @@ -8947,18 +9077,18 @@ "com.amazonaws.apigateway#PutIntegrationRequest": { "type": "structure", "members": { - "resourceId": { + "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a put integration request's resource ID.

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

[Required] Specifies a put integration request's HTTP method.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, "restApiId": { @@ -8969,42 +9099,24 @@ "smithy.api#required": {} } }, - "httpMethod": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a put integration request's HTTP method.

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

[Required] Specifies a put integration request's resource ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "timeoutInMillis": { - "target": "com.amazonaws.apigateway#NullableInteger", - "traits": { - "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

" - } - }, - "contentHandling": { - "target": "com.amazonaws.apigateway#ContentHandlingStrategy", - "traits": { - "smithy.api#documentation": "

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

\n \n

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

" - } - }, - "requestParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" - } - }, - "credentials": { + "uri": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

Specifies whether credentials are required for a put integration.

" + "smithy.api#documentation": "

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

\n" } }, "passthroughBehavior": { @@ -9025,39 +9137,35 @@ "smithy.api#documentation": "

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

" } }, - "cacheKeyParameters": { - "target": "com.amazonaws.apigateway#ListOfString", + "requestParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

" + "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" } }, - "type": { - "target": "com.amazonaws.apigateway#IntegrationType", + "integrationHttpMethod": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a put integration input's type.

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

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

", + "smithy.api#jsonName": "httpMethod" } }, - "tlsConfig": { - "target": "com.amazonaws.apigateway#TlsConfig" - }, - "uri": { + "cacheNamespace": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

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

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

" } }, - "integrationHttpMethod": { - "target": "com.amazonaws.apigateway#String", + "cacheKeyParameters": { + "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

", - "smithy.api#jsonName": "httpMethod" + "smithy.api#documentation": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

" } }, - "cacheNamespace": { + "credentials": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

" + "smithy.api#documentation": "

Specifies whether credentials are required for a put integration.

" } }, "connectionType": { @@ -9065,6 +9173,28 @@ "traits": { "smithy.api#documentation": "

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

" } + }, + "timeoutInMillis": { + "target": "com.amazonaws.apigateway#NullableInteger", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

" + } + }, + "tlsConfig": { + "target": "com.amazonaws.apigateway#TlsConfig" + }, + "contentHandling": { + "target": "com.amazonaws.apigateway#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

\n \n

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

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

[Required] Specifies a put integration input's type.

", + "smithy.api#required": {} + } } }, "traits": { @@ -9111,6 +9241,9 @@ "com.amazonaws.apigateway#PutIntegrationResponseRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { @@ -9119,17 +9252,20 @@ "smithy.api#required": {} } }, - "resourceId": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a put integration response request's resource identifier.

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

[Required] Specifies a put integration response request's HTTP method.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -9138,34 +9274,16 @@ "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "httpMethod": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies a put integration response request's HTTP method.

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

[Required] Specifies a put integration response request's resource identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "responseParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the back end.\n The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

" - } - }, - "responseTemplates": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

Specifies a put integration response's templates.

" - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "selectionPattern": { "target": "com.amazonaws.apigateway#String", @@ -9178,6 +9296,18 @@ "traits": { "smithy.api#documentation": "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

\n \n

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the back end.\n The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

" + } + }, + "responseTemplates": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

Specifies a put integration response's templates.

" + } } }, "traits": { @@ -9224,21 +9354,18 @@ "com.amazonaws.apigateway#PutMethodRequest": { "type": "structure", "members": { - "restApiId": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The Resource identifier for the new Method resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "resourceId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The Resource identifier for the new Method resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9246,6 +9373,15 @@ "template": { "target": "com.amazonaws.apigateway#Boolean" }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -9254,16 +9390,10 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "requestModels": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "requestParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToBoolean", "traits": { - "smithy.api#documentation": "

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

" + "smithy.api#documentation": "

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

" } }, "operationName": { @@ -9278,11 +9408,16 @@ "smithy.api#documentation": "

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

" } }, - "authorizationType": { + "requestModels": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

" + } + }, + "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

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

The identifier of a RequestValidator for validating the method request.

" } }, "apiKeyRequired": { @@ -9297,16 +9432,11 @@ "smithy.api#documentation": "

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

" } }, - "requestValidatorId": { + "authorizationType": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The identifier of a RequestValidator for validating the method request.

" - } - }, - "requestParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToBoolean", - "traits": { - "smithy.api#documentation": "

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

" + "smithy.api#documentation": "

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

", + "smithy.api#required": {} } } }, @@ -9354,16 +9484,8 @@ "com.amazonaws.apigateway#PutMethodResponseRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "resourceId": { "target": "com.amazonaws.apigateway#String", @@ -9373,20 +9495,14 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "statusCode": { - "target": "com.amazonaws.apigateway#StatusCode", + "restApiId": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The method response's status code.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, @@ -9398,10 +9514,18 @@ "smithy.api#required": {} } }, - "responseParameters": { - "target": "com.amazonaws.apigateway#MapOfStringToBoolean", + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

" + "smithy.api#documentation": "

[Required] The method response's status code.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "responseModels": { @@ -9409,6 +9533,12 @@ "traits": { "smithy.api#documentation": "

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

" } + }, + "responseParameters": { + "target": "com.amazonaws.apigateway#MapOfStringToBoolean", + "traits": { + "smithy.api#documentation": "

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

" + } } }, "traits": { @@ -9470,20 +9600,29 @@ "com.amazonaws.apigateway#PutRestApiRequest": { "type": "structure", "members": { - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "parameters": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "failOnWarnings": { + "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

" + "smithy.api#documentation": "

A query parameter to indicate whether to rollback the API update (true) or not (false)\n when a warning is encountered. The default value is false.

", + "smithy.api#httpQuery": "failonwarnings" } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "mode": { "target": "com.amazonaws.apigateway#PutMode", @@ -9492,23 +9631,14 @@ "smithy.api#httpQuery": "mode" } }, - "failOnWarnings": { - "target": "com.amazonaws.apigateway#Boolean", - "traits": { - "smithy.api#documentation": "

A query parameter to indicate whether to rollback the API update (true) or not (false)\n when a warning is encountered. The default value is false.

", - "smithy.api#httpQuery": "failonwarnings" - } + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", + "parameters": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

" } - }, - "name": { - "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -9537,18 +9667,18 @@ "com.amazonaws.apigateway#QuotaSettings": { "type": "structure", "members": { - "period": { - "target": "com.amazonaws.apigateway#QuotaPeriodType", - "traits": { - "smithy.api#documentation": "

The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".

" - } - }, "limit": { "target": "com.amazonaws.apigateway#Integer", "traits": { "smithy.api#documentation": "

The maximum number of requests that can be made in a given time period.

" } }, + "period": { + "target": "com.amazonaws.apigateway#QuotaPeriodType", + "traits": { + "smithy.api#documentation": "

The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".

" + } + }, "offset": { "target": "com.amazonaws.apigateway#Integer", "traits": { @@ -9617,10 +9747,10 @@ "com.amazonaws.apigateway#Resource": { "type": "structure", "members": { - "id": { + "path": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The resource's identifier.

" + "smithy.api#documentation": "

The full path for this resource.

" } }, "resourceMethods": { @@ -9635,16 +9765,16 @@ "smithy.api#documentation": "

The parent resource's identifier.

" } }, - "path": { + "pathPart": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The full path for this resource.

" + "smithy.api#documentation": "

The last path segment for this resource.

" } }, - "pathPart": { + "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The last path segment for this resource.

" + "smithy.api#documentation": "

The resource's identifier.

" } } }, @@ -9677,22 +9807,10 @@ "com.amazonaws.apigateway#RestApi": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The API's description.

" - } - }, - "policy": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration." - } - }, - "endpointConfiguration": { - "target": "com.amazonaws.apigateway#EndpointConfiguration", + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", "traits": { - "smithy.api#documentation": "

The endpoint configuration of this RestApi showing the endpoint types of the API.

" + "smithy.api#documentation": "

The timestamp when the API was created.

" } }, "apiKeySource": { @@ -9701,10 +9819,16 @@ "smithy.api#documentation": "

The source of the API key for metering requests according to a usage plan. Valid values are:

" } }, - "name": { - "target": "com.amazonaws.apigateway#String", + "warnings": { + "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

The API's name.

" + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

" + } + }, + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" } }, "version": { @@ -9713,22 +9837,22 @@ "smithy.api#documentation": "

A version identifier for the API.

" } }, - "tags": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "endpointConfiguration": { + "target": "com.amazonaws.apigateway#EndpointConfiguration", "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" + "smithy.api#documentation": "

The endpoint configuration of this RestApi showing the endpoint types of the API.

" } }, - "warnings": { - "target": "com.amazonaws.apigateway#ListOfString", + "name": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

" + "smithy.api#documentation": "

The API's name.

" } }, - "createdDate": { - "target": "com.amazonaws.apigateway#Timestamp", + "policy": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The timestamp when the API was created.

" + "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration." } }, "id": { @@ -9748,6 +9872,12 @@ "traits": { "smithy.api#documentation": "

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

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

The API's description.

" + } } }, "traits": { @@ -9779,16 +9909,16 @@ "com.amazonaws.apigateway#SdkConfigurationProperty": { "type": "structure", "members": { - "defaultValue": { + "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The default value of an SdkType configuration property.

" + "smithy.api#documentation": "

The name of a an SdkType configuration property.

" } }, - "description": { + "defaultValue": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The description of an SdkType configuration property.

" + "smithy.api#documentation": "

The default value of an SdkType configuration property.

" } }, "required": { @@ -9797,16 +9927,16 @@ "smithy.api#documentation": "

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

" } }, - "name": { + "friendlyName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The name of a an SdkType configuration property.

" + "smithy.api#documentation": "

The user-friendly name of an SdkType configuration property.

" } }, - "friendlyName": { + "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The user-friendly name of an SdkType configuration property.

" + "smithy.api#documentation": "

The description of an SdkType configuration property.

" } } }, @@ -9817,11 +9947,11 @@ "com.amazonaws.apigateway#SdkResponse": { "type": "structure", "members": { - "contentDisposition": { - "target": "com.amazonaws.apigateway#String", + "body": { + "target": "com.amazonaws.apigateway#Blob", "traits": { - "smithy.api#documentation": "

The content-disposition header value in the HTTP response.

", - "smithy.api#httpHeader": "Content-Disposition" + "smithy.api#documentation": "

The binary blob response to GetSdk, which contains the generated SDK.

", + "smithy.api#httpPayload": {} } }, "contentType": { @@ -9831,11 +9961,11 @@ "smithy.api#httpHeader": "Content-Type" } }, - "body": { - "target": "com.amazonaws.apigateway#Blob", + "contentDisposition": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The binary blob response to GetSdk, which contains the generated SDK.

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

The content-disposition header value in the HTTP response.

", + "smithy.api#httpHeader": "Content-Disposition" } } }, @@ -9846,10 +9976,10 @@ "com.amazonaws.apigateway#SdkType": { "type": "structure", "members": { - "friendlyName": { - "target": "com.amazonaws.apigateway#String", + "configurationProperties": { + "target": "com.amazonaws.apigateway#ListOfSdkConfigurationProperty", "traits": { - "smithy.api#documentation": "

The user-friendly name of an SdkType instance.

" + "smithy.api#documentation": "

A list of configuration properties of an SdkType.

" } }, "description": { @@ -9858,16 +9988,16 @@ "smithy.api#documentation": "

The description of an SdkType.

" } }, - "configurationProperties": { - "target": "com.amazonaws.apigateway#ListOfSdkConfigurationProperty", + "id": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A list of configuration properties of an SdkType.

" + "smithy.api#documentation": "

The identifier of an SdkType instance.

" } }, - "id": { + "friendlyName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The identifier of an SdkType instance.

" + "smithy.api#documentation": "

The user-friendly name of an SdkType instance.

" } } }, @@ -9925,16 +10055,10 @@ "com.amazonaws.apigateway#Stage": { "type": "structure", "members": { - "deploymentId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

The identifier of the Deployment that the stage points to.

" - } - }, - "description": { + "webAclArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The stage's description.

" + "smithy.api#documentation": "

The ARN of the WebAcl associated with the Stage.

" } }, "stageName": { @@ -9943,22 +10067,22 @@ "smithy.api#documentation": "

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

" } }, - "tags": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "createdDate": { + "target": "com.amazonaws.apigateway#Timestamp", "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" + "smithy.api#documentation": "

The timestamp when the stage was created.

" } }, - "cacheClusterStatus": { - "target": "com.amazonaws.apigateway#CacheClusterStatus", + "lastUpdatedDate": { + "target": "com.amazonaws.apigateway#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the cache cluster for the stage, if enabled.

" + "smithy.api#documentation": "

The timestamp when the stage last updated.

" } }, - "clientCertificateId": { + "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The identifier of a client certificate for an API stage.

" + "smithy.api#documentation": "

The identifier of the Deployment that the stage points to.

" } }, "cacheClusterEnabled": { @@ -9967,46 +10091,46 @@ "smithy.api#documentation": "

Specifies whether a cache cluster is enabled for the stage.

" } }, - "canarySettings": { - "target": "com.amazonaws.apigateway#CanarySettings", + "description": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

Settings for the canary deployment in this stage.

" + "smithy.api#documentation": "

The stage's description.

" } }, - "variables": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "accessLogSettings": { + "target": "com.amazonaws.apigateway#AccessLogSettings", "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for a Stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

" + "smithy.api#documentation": "

Settings for logging access in this stage.

" } }, - "cacheClusterSize": { - "target": "com.amazonaws.apigateway#CacheClusterSize", + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The size of the cache cluster for the stage, if enabled.

" + "smithy.api#documentation": "

The identifier of a client certificate for an API stage.

" } }, - "accessLogSettings": { - "target": "com.amazonaws.apigateway#AccessLogSettings", + "canarySettings": { + "target": "com.amazonaws.apigateway#CanarySettings", "traits": { - "smithy.api#documentation": "

Settings for logging access in this stage.

" + "smithy.api#documentation": "

Settings for the canary deployment in this stage.

" } }, - "documentationVersion": { - "target": "com.amazonaws.apigateway#String", + "variables": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

The version of the associated API documentation.

" + "smithy.api#documentation": "

A map that defines the stage variables for a Stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.apigateway#Timestamp", + "cacheClusterStatus": { + "target": "com.amazonaws.apigateway#CacheClusterStatus", "traits": { - "smithy.api#documentation": "

The timestamp when the stage last updated.

" + "smithy.api#documentation": "

The status of the cache cluster for the stage, if enabled.

" } }, - "createdDate": { - "target": "com.amazonaws.apigateway#Timestamp", + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

The timestamp when the stage was created.

" + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" } }, "tracingEnabled": { @@ -10015,10 +10139,16 @@ "smithy.api#documentation": "

Specifies whether active tracing with X-ray is enabled for the Stage.

" } }, - "webAclArn": { + "cacheClusterSize": { + "target": "com.amazonaws.apigateway#CacheClusterSize", + "traits": { + "smithy.api#documentation": "

The size of the cache cluster for the stage, if enabled.

" + } + }, + "documentationVersion": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The ARN of the WebAcl associated with the Stage.

" + "smithy.api#documentation": "

The version of the associated API documentation.

" } }, "methodSettings": { @@ -10035,16 +10165,16 @@ "com.amazonaws.apigateway#StageKey": { "type": "structure", "members": { - "stageName": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The stage name associated with the stage key.

" + "smithy.api#documentation": "

The string identifier of the associated RestApi.

" } }, - "restApiId": { + "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The string identifier of the associated RestApi.

" + "smithy.api#documentation": "

The stage name associated with the stage key.

" } } }, @@ -10113,15 +10243,18 @@ "com.amazonaws.apigateway#TagResourceRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "resourceArn": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -10130,9 +10263,6 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "tags": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { @@ -10207,16 +10337,16 @@ "com.amazonaws.apigateway#TestInvokeAuthorizerRequest": { "type": "structure", "members": { - "additionalContext": { + "stageVariables": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

[Optional] A key-value map of additional context variables.

" + "smithy.api#documentation": "

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" } }, - "pathWithQueryString": { + "body": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" + "smithy.api#documentation": "

[Optional] The simulated request body of an incoming invocation request.

" } }, "headers": { @@ -10225,16 +10355,16 @@ "smithy.api#documentation": "

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

" } }, - "body": { + "pathWithQueryString": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Optional] The simulated request body of an incoming invocation request.

" + "smithy.api#documentation": "

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" } }, - "stageVariables": { + "additionalContext": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" + "smithy.api#documentation": "

[Optional] A key-value map of additional context variables.

" } }, "restApiId": { @@ -10245,6 +10375,12 @@ "smithy.api#required": {} } }, + "multiValueHeaders": { + "target": "com.amazonaws.apigateway#MapOfStringToList", + "traits": { + "smithy.api#documentation": "

[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

" + } + }, "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -10252,12 +10388,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "multiValueHeaders": { - "target": "com.amazonaws.apigateway#MapOfStringToList", - "traits": { - "smithy.api#documentation": "

[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

" - } } }, "traits": { @@ -10267,19 +10397,22 @@ "com.amazonaws.apigateway#TestInvokeAuthorizerResponse": { "type": "structure", "members": { - "log": { + "principalId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The API Gateway execution log for the test authorizer request.

" + "smithy.api#documentation": "

The principal identity returned by the Authorizer

" } }, - "authorization": { - "target": "com.amazonaws.apigateway#MapOfStringToList" + "latency": { + "target": "com.amazonaws.apigateway#Long", + "traits": { + "smithy.api#documentation": "

The execution latency of the test authorizer request.

" + } }, - "principalId": { - "target": "com.amazonaws.apigateway#String", + "claims": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

The principal identity returned by the Authorizer

" + "smithy.api#documentation": "

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

" } }, "policy": { @@ -10294,16 +10427,13 @@ "smithy.api#documentation": "

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

" } }, - "claims": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

" - } + "authorization": { + "target": "com.amazonaws.apigateway#MapOfStringToList" }, - "latency": { - "target": "com.amazonaws.apigateway#Long", + "log": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The execution latency of the test authorizer request.

" + "smithy.api#documentation": "

The API Gateway execution log for the test authorizer request.

" } } }, @@ -10345,12 +10475,16 @@ "com.amazonaws.apigateway#TestInvokeMethodRequest": { "type": "structure", "members": { - "restApiId": { + "headers": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

A key-value map of headers to simulate an incoming invocation request.

" + } + }, + "pathWithQueryString": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" } }, "resourceId": { @@ -10361,28 +10495,30 @@ "smithy.api#required": {} } }, - "multiValueHeaders": { - "target": "com.amazonaws.apigateway#MapOfStringToList", + "clientCertificateId": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The headers as a map from string to list of values to simulate an incoming invocation request.

" + "smithy.api#documentation": "

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

" } }, - "stageVariables": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "restApiId": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "body": { - "target": "com.amazonaws.apigateway#String", + "multiValueHeaders": { + "target": "com.amazonaws.apigateway#MapOfStringToList", "traits": { - "smithy.api#documentation": "

The simulated request body of an incoming invocation request.

" + "smithy.api#documentation": "

The headers as a map from string to list of values to simulate an incoming invocation request.

" } }, - "clientCertificateId": { - "target": "com.amazonaws.apigateway#String", + "stageVariables": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

" + "smithy.api#documentation": "

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" } }, "httpMethod": { @@ -10393,16 +10529,10 @@ "smithy.api#required": {} } }, - "pathWithQueryString": { + "body": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" - } - }, - "headers": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

A key-value map of headers to simulate an incoming invocation request.

" + "smithy.api#documentation": "

The simulated request body of an incoming invocation request.

" } } }, @@ -10413,16 +10543,10 @@ "com.amazonaws.apigateway#TestInvokeMethodResponse": { "type": "structure", "members": { - "headers": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

The headers of the HTTP response.

" - } - }, - "log": { - "target": "com.amazonaws.apigateway#String", + "latency": { + "target": "com.amazonaws.apigateway#Long", "traits": { - "smithy.api#documentation": "

The API Gateway execution log for the test invoke request.

" + "smithy.api#documentation": "

The execution latency of the test invoke request.

" } }, "status": { @@ -10443,10 +10567,16 @@ "smithy.api#documentation": "

The headers of the HTTP response as a map from string to list of values.

" } }, - "latency": { - "target": "com.amazonaws.apigateway#Long", + "log": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The execution latency of the test invoke request.

" + "smithy.api#documentation": "

The API Gateway execution log for the test invoke request.

" + } + }, + "headers": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

The headers of the HTTP response.

" } } }, @@ -10491,14 +10621,14 @@ "com.amazonaws.apigateway#TooManyRequestsException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.apigateway#String" - }, "retryAfterSeconds": { "target": "com.amazonaws.apigateway#String", "traits": { "smithy.api#httpHeader": "Retry-After" } + }, + "message": { + "target": "com.amazonaws.apigateway#String" } }, "traits": { @@ -10573,22 +10703,11 @@ "com.amazonaws.apigateway#UntagResourceRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "title": { "target": "com.amazonaws.apigateway#String" }, - "tagKeys": { - "target": "com.amazonaws.apigateway#ListOfString", - "traits": { - "smithy.api#documentation": "

[Required] The Tag keys to delete.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "name": { "target": "com.amazonaws.apigateway#String" @@ -10600,6 +10719,17 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "tagKeys": { + "target": "com.amazonaws.apigateway#ListOfString", + "traits": { + "smithy.api#documentation": "

[Required] The Tag keys to delete.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } }, "traits": { @@ -10640,15 +10770,15 @@ "com.amazonaws.apigateway#UpdateAccountRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, "title": { "target": "com.amazonaws.apigateway#String" }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -10700,12 +10830,6 @@ "com.amazonaws.apigateway#UpdateApiKeyRequest": { "type": "structure", "members": { - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "apiKey": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -10720,6 +10844,12 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -10765,31 +10895,31 @@ "com.amazonaws.apigateway#UpdateAuthorizerRequest": { "type": "structure", "members": { - "restApiId": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of the Authorizer resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "authorizerId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier of the Authorizer resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "title": { "target": "com.amazonaws.apigateway#String" }, @@ -10841,6 +10971,12 @@ "com.amazonaws.apigateway#UpdateBasePathMappingRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "basePath": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -10849,12 +10985,6 @@ "smithy.api#required": {} } }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -10866,7 +10996,7 @@ "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, "patchOperations": { @@ -10914,9 +11044,15 @@ "com.amazonaws.apigateway#UpdateClientCertificateRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.apigateway#String" + }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "clientCertificateId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -10925,15 +11061,9 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "title": { "target": "com.amazonaws.apigateway#String" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -10982,34 +11112,34 @@ "com.amazonaws.apigateway#UpdateDeploymentRequest": { "type": "structure", "members": { - "deploymentId": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The replacement identifier for the Deployment resource to change information about.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "restApiId": { + "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

The replacement identifier for the Deployment resource to change information about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11060,34 +11190,34 @@ "com.amazonaws.apigateway#UpdateDocumentationPartRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "documentationPartId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier of the to-be-updated documentation part.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "name": { "target": "com.amazonaws.apigateway#String" }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "restApiId": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "documentationPartId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of the to-be-updated documentation part.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11135,14 +11265,11 @@ "com.amazonaws.apigateway#UpdateDocumentationVersionRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "documentationVersion": { "target": "com.amazonaws.apigateway#String", @@ -11160,7 +11287,10 @@ "smithy.api#required": {} } }, - "name": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { "target": "com.amazonaws.apigateway#String" }, "patchOperations": { @@ -11211,18 +11341,15 @@ "com.amazonaws.apigateway#UpdateDomainNameRequest": { "type": "structure", "members": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "name": { "target": "com.amazonaws.apigateway#String" }, "title": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -11231,6 +11358,9 @@ "smithy.api#required": {} } }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11276,10 +11406,15 @@ "com.amazonaws.apigateway#UpdateGatewayResponseRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "restApiId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, "responseType": { @@ -11290,19 +11425,14 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", @@ -11352,10 +11482,10 @@ "com.amazonaws.apigateway#UpdateIntegrationRequest": { "type": "structure", "members": { - "httpMethod": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Represents an update integration request's HTTP method.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11363,10 +11493,10 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "restApiId": { + "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] Represents an update integration request's HTTP method.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11377,9 +11507,6 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -11388,6 +11515,9 @@ "smithy.api#required": {} } }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11436,25 +11566,20 @@ "com.amazonaws.apigateway#UpdateIntegrationResponseRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "statusCode": { - "target": "com.amazonaws.apigateway#StatusCode", - "traits": { - "smithy.api#documentation": "

[Required] Specifies an update integration response request's status code.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" }, - "httpMethod": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] Specifies an update integration response request's HTTP method.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -11463,22 +11588,27 @@ "smithy.api#required": {} } }, - "restApiId": { - "target": "com.amazonaws.apigateway#String", + "statusCode": { + "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] Specifies an update integration response request's status code.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { + "title": { "target": "com.amazonaws.apigateway#String" }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "httpMethod": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] Specifies an update integration response request's HTTP method.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", @@ -11528,8 +11658,11 @@ "com.amazonaws.apigateway#UpdateMethodRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "title": { + "target": "com.amazonaws.apigateway#String" }, "httpMethod": { "target": "com.amazonaws.apigateway#String", @@ -11539,31 +11672,28 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, - "restApiId": { + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The Resource identifier for the Method resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "resourceId": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The Resource identifier for the Method resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11615,23 +11745,6 @@ "com.amazonaws.apigateway#UpdateMethodResponseRequest": { "type": "structure", "members": { - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "resourceId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The Resource identifier for the MethodResponse resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -11651,6 +11764,17 @@ "smithy.api#required": {} } }, + "resourceId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The Resource identifier for the MethodResponse resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -11659,6 +11783,12 @@ "smithy.api#required": {} } }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11707,6 +11837,15 @@ "com.amazonaws.apigateway#UpdateModelRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, "modelName": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -11715,14 +11854,8 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "restApiId": { "target": "com.amazonaws.apigateway#String", @@ -11732,9 +11865,6 @@ "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11783,31 +11913,31 @@ "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "restApiId": { + "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of RequestValidator to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "title": { "target": "com.amazonaws.apigateway#String" }, - "requestValidatorId": { + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier of RequestValidator to be updated.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -11856,33 +11986,33 @@ "com.amazonaws.apigateway#UpdateResourceRequest": { "type": "structure", "members": { - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, - "resourceId": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The identifier of the Resource resource.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "restApiId": { + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The identifier of the Resource resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" + "template": { + "target": "com.amazonaws.apigateway#Boolean" }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", @@ -11932,18 +12062,6 @@ "com.amazonaws.apigateway#UpdateRestApiRequest": { "type": "structure", "members": { - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -11952,6 +12070,18 @@ "smithy.api#required": {} } }, + "name": { + "target": "com.amazonaws.apigateway#String" + }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -12000,34 +12130,34 @@ "com.amazonaws.apigateway#UpdateStageRequest": { "type": "structure", "members": { - "title": { - "target": "com.amazonaws.apigateway#String" - }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" - }, "name": { "target": "com.amazonaws.apigateway#String" }, - "stageName": { + "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The name of the Stage resource to change information about.

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

[Required] The string identifier of the associated RestApi.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "template": { - "target": "com.amazonaws.apigateway#Boolean" - }, - "restApiId": { + "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

[Required] The string identifier of the associated RestApi.

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

[Required] The name of the Stage resource to change information about.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "template": { + "target": "com.amazonaws.apigateway#Boolean" + }, + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, + "title": { + "target": "com.amazonaws.apigateway#String" + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -12107,13 +12237,8 @@ "com.amazonaws.apigateway#UpdateUsagePlanRequest": { "type": "structure", "members": { - "usagePlanId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The Id of the to-be-updated usage plan.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "name": { + "target": "com.amazonaws.apigateway#String" }, "title": { "target": "com.amazonaws.apigateway#String" @@ -12121,12 +12246,17 @@ "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The Id of the to-be-updated usage plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -12141,18 +12271,13 @@ "com.amazonaws.apigateway#UpdateUsageRequest": { "type": "structure", "members": { - "usagePlanId": { - "target": "com.amazonaws.apigateway#String", - "traits": { - "smithy.api#documentation": "

[Required] The Id of the usage plan associated with the usage data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "title": { + "target": "com.amazonaws.apigateway#String" }, "templateSkipList": { "target": "com.amazonaws.apigateway#ListOfString" }, - "title": { + "name": { "target": "com.amazonaws.apigateway#String" }, "keyId": { @@ -12163,12 +12288,17 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.apigateway#String" - }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, + "usagePlanId": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

[Required] The Id of the usage plan associated with the usage data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { @@ -12217,6 +12347,9 @@ "com.amazonaws.apigateway#UpdateVpcLinkRequest": { "type": "structure", "members": { + "templateSkipList": { + "target": "com.amazonaws.apigateway#ListOfString" + }, "template": { "target": "com.amazonaws.apigateway#Boolean" }, @@ -12228,14 +12361,11 @@ "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.apigateway#String" - }, "name": { "target": "com.amazonaws.apigateway#String" }, - "templateSkipList": { - "target": "com.amazonaws.apigateway#ListOfString" + "title": { + "target": "com.amazonaws.apigateway#String" }, "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", @@ -12251,10 +12381,10 @@ "com.amazonaws.apigateway#Usage": { "type": "structure", "members": { - "endDate": { + "startDate": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The ending date of the usage data.

" + "smithy.api#documentation": "

The starting date of the usage data.

" } }, "usagePlanId": { @@ -12263,10 +12393,10 @@ "smithy.api#documentation": "

The plan Id associated with this usage data.

" } }, - "startDate": { + "endDate": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The starting date of the usage data.

" + "smithy.api#documentation": "

The ending date of the usage data.

" } }, "items": { @@ -12291,16 +12421,22 @@ "com.amazonaws.apigateway#UsagePlan": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

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

The identifier of a UsagePlan resource.

" } }, - "throttle": { - "target": "com.amazonaws.apigateway#ThrottleSettings", + "quota": { + "target": "com.amazonaws.apigateway#QuotaSettings", "traits": { - "smithy.api#documentation": "

The request throttle limits of a usage plan.

" + "smithy.api#documentation": "

The maximum number of permitted requests per a given unit time interval.

" } }, "name": { @@ -12321,23 +12457,17 @@ "smithy.api#documentation": "

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

" } }, - "quota": { - "target": "com.amazonaws.apigateway#QuotaSettings", - "traits": { - "smithy.api#documentation": "

The maximum number of permitted requests per a given unit time interval.

" - } - }, - "tags": { - "target": "com.amazonaws.apigateway#MapOfStringToString", - "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

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

The description of a usage plan.

" } + }, + "throttle": { + "target": "com.amazonaws.apigateway#ThrottleSettings", + "traits": { + "smithy.api#documentation": "

The request throttle limits of a usage plan.

" + } } }, "traits": { @@ -12353,12 +12483,6 @@ "smithy.api#documentation": "

The name of a usage plan key.

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

The value of a usage plan key.

" - } - }, "id": { "target": "com.amazonaws.apigateway#String", "traits": { @@ -12370,6 +12494,12 @@ "traits": { "smithy.api#documentation": "

The type of a usage plan key. Currently, the valid key type is API_KEY.

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

The value of a usage plan key.

" + } } }, "traits": { @@ -12423,22 +12553,22 @@ "com.amazonaws.apigateway#VpcLink": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.apigateway#String", + "targetArns": { + "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

" + "smithy.api#documentation": "

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

" } }, - "name": { - "target": "com.amazonaws.apigateway#String", + "tags": { + "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "

The name used to label and identify the VPC link.

" + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" } }, - "description": { + "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The description of the VPC link.

" + "smithy.api#documentation": "

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

" } }, "statusMessage": { @@ -12447,10 +12577,10 @@ "smithy.api#documentation": "

A description about the VPC link status.

" } }, - "targetArns": { - "target": "com.amazonaws.apigateway#ListOfString", + "name": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

" + "smithy.api#documentation": "

The name used to label and identify the VPC link.

" } }, "status": { @@ -12459,10 +12589,10 @@ "smithy.api#documentation": "

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

" } }, - "tags": { - "target": "com.amazonaws.apigateway#MapOfStringToString", + "description": { + "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

" + "smithy.api#documentation": "

The description of the VPC link.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/apigatewaymanagementapi.2018-11-29.json b/codegen/sdk-codegen/aws-models/apigatewaymanagementapi.2018-11-29.json index d25a6ec0238b..06bafac5b963 100644 --- a/codegen/sdk-codegen/aws-models/apigatewaymanagementapi.2018-11-29.json +++ b/codegen/sdk-codegen/aws-models/apigatewaymanagementapi.2018-11-29.json @@ -46,7 +46,7 @@ "traits": { "aws.api#service": { "sdkId": "ApiGatewayManagementApi", - "arnNamespace": "execute-api", + "arnNamespace": "apigateway", "cloudFormationName": "ApiGatewayManagementApi", "cloudTrailEventSource": "apigatewaymanagementapi.amazonaws.com" }, @@ -163,18 +163,18 @@ "smithy.api#jsonName": "identity" } }, - "ConnectedAt": { + "LastActiveAt": { "target": "com.amazonaws.apigatewaymanagementapi#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The time in ISO 8601 format for when the connection was established.

", - "smithy.api#jsonName": "connectedAt" + "smithy.api#documentation": "

The time in ISO 8601 format for when the connection was last active.

", + "smithy.api#jsonName": "lastActiveAt" } }, - "LastActiveAt": { + "ConnectedAt": { "target": "com.amazonaws.apigatewaymanagementapi#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The time in ISO 8601 format for when the connection was last active.

", - "smithy.api#jsonName": "lastActiveAt" + "smithy.api#documentation": "

The time in ISO 8601 format for when the connection was established.

", + "smithy.api#jsonName": "connectedAt" } } } @@ -191,19 +191,19 @@ "com.amazonaws.apigatewaymanagementapi#Identity": { "type": "structure", "members": { - "SourceIp": { + "UserAgent": { "target": "com.amazonaws.apigatewaymanagementapi#__string", "traits": { - "smithy.api#documentation": "

The source IP address of the TCP connection making the request to API Gateway.

", - "smithy.api#jsonName": "sourceIp", + "smithy.api#documentation": "

The User Agent of the API caller.

", + "smithy.api#jsonName": "userAgent", "smithy.api#required": {} } }, - "UserAgent": { + "SourceIp": { "target": "com.amazonaws.apigatewaymanagementapi#__string", "traits": { - "smithy.api#documentation": "

The User Agent of the API caller.

", - "smithy.api#jsonName": "userAgent", + "smithy.api#documentation": "

The source IP address of the TCP connection making the request to API Gateway.

", + "smithy.api#jsonName": "sourceIp", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/apigatewayv2.2018-11-29.json b/codegen/sdk-codegen/aws-models/apigatewayv2.2018-11-29.json index 0ad603ad8fdd..0ff64cc7d366 100644 --- a/codegen/sdk-codegen/aws-models/apigatewayv2.2018-11-29.json +++ b/codegen/sdk-codegen/aws-models/apigatewayv2.2018-11-29.json @@ -47,19 +47,19 @@ "com.amazonaws.apigatewayv2#AccessLogSettings": { "type": "structure", "members": { - "DestinationArn": { - "target": "com.amazonaws.apigatewayv2#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs log group to receive access logs.

", - "smithy.api#jsonName": "destinationArn" - } - }, "Format": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", "traits": { "smithy.api#documentation": "

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

", "smithy.api#jsonName": "format" } + }, + "DestinationArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs log group to receive access logs.

", + "smithy.api#jsonName": "destinationArn" + } } }, "traits": { @@ -69,19 +69,11 @@ "com.amazonaws.apigatewayv2#Api": { "type": "structure", "members": { - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The timestamp when the API was created.

", - "smithy.api#jsonName": "createdDate" - } - }, - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The name of the API.

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

A version identifier for the API.

", + "smithy.api#jsonName": "version" } }, "ApiEndpoint": { @@ -91,13 +83,6 @@ "smithy.api#jsonName": "apiEndpoint" } }, - "Version": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", - "traits": { - "smithy.api#documentation": "

A version identifier for the API.

", - "smithy.api#jsonName": "version" - } - }, "Warnings": { "target": "com.amazonaws.apigatewayv2#__listOf__string", "traits": { @@ -105,11 +90,12 @@ "smithy.api#jsonName": "warnings" } }, - "ApiKeySelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", - "smithy.api#jsonName": "apiKeySelectionExpression" + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, "ApiId": { @@ -119,27 +105,32 @@ "smithy.api#jsonName": "apiId" } }, - "RouteSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

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

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" } }, - "ProtocolType": { - "target": "com.amazonaws.apigatewayv2#ProtocolType", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The API protocol.

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

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The description of the API.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" } }, "ImportInfo": { @@ -149,6 +140,27 @@ "smithy.api#jsonName": "importInfo" } }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, "DisableSchemaValidation": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -156,18 +168,20 @@ "smithy.api#jsonName": "disableSchemaValidation" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

A collection of tags associated with the API.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression", + "smithy.api#required": {} } }, - "CorsConfiguration": { - "target": "com.amazonaws.apigatewayv2#Cors", + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", "traits": { - "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "corsConfiguration" + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType", + "smithy.api#required": {} } } }, @@ -350,6 +364,9 @@ { "target": "com.amazonaws.apigatewayv2#ReimportApi" }, + { + "target": "com.amazonaws.apigatewayv2#ResetAuthorizersCache" + }, { "target": "com.amazonaws.apigatewayv2#TagResource" }, @@ -411,19 +428,19 @@ "com.amazonaws.apigatewayv2#ApiMapping": { "type": "structure", "members": { - "ApiId": { + "ApiMappingId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The API mapping identifier.

", + "smithy.api#jsonName": "apiMappingId" } }, - "ApiMappingId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The API mapping identifier.

", - "smithy.api#jsonName": "apiMappingId" + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId", + "smithy.api#required": {} } }, "ApiMappingKey": { @@ -464,7 +481,7 @@ "com.amazonaws.apigatewayv2#AuthorizationType": { "type": "string", "traits": { - "smithy.api#documentation": "

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

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

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", "smithy.api#enum": [ { "value": "NONE", @@ -488,11 +505,40 @@ "com.amazonaws.apigatewayv2#Authorizer": { "type": "structure", "members": { - "AuthorizerUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", - "smithy.api#jsonName": "authorizerUri" + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" } }, "AuthorizerId": { @@ -502,54 +548,39 @@ "smithy.api#jsonName": "authorizerId" } }, - "AuthorizerResultTtlInSeconds": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

Authorizer caching is not currently supported. Don't specify this value for authorizers.

", - "smithy.api#jsonName": "authorizerResultTtlInSeconds" + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" } }, "AuthorizerCredentialsArn": { "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

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

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", "smithy.api#jsonName": "authorizerCredentialsArn" } }, - "IdentityValidationExpression": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", - "smithy.api#jsonName": "identityValidationExpression" - } - }, "AuthorizerType": { "target": "com.amazonaws.apigatewayv2#AuthorizerType", "traits": { - "smithy.api#documentation": "

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

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

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", "smithy.api#jsonName": "authorizerType" } }, - "IdentitySource": { - "target": "com.amazonaws.apigatewayv2#IdentitySourceList", - "traits": { - "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example \"$request.header.Authorization\".

", - "smithy.api#jsonName": "identitySource" - } - }, - "JwtConfiguration": { - "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "jwtConfiguration" + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" } }, - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The name of the authorizer.

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

The validation expression does not apply to the REQUEST authorizer.

", + "smithy.api#jsonName": "identityValidationExpression" } } }, @@ -560,7 +591,7 @@ "com.amazonaws.apigatewayv2#AuthorizerType": { "type": "string", "traits": { - "smithy.api#documentation": "

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

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

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", "smithy.api#enum": [ { "value": "REQUEST", @@ -642,13 +673,6 @@ "com.amazonaws.apigatewayv2#Cors": { "type": "structure", "members": { - "AllowMethods": { - "target": "com.amazonaws.apigatewayv2#CorsMethodList", - "traits": { - "smithy.api#documentation": "

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "allowMethods" - } - }, "MaxAge": { "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetweenMinus1And86400", "traits": { @@ -683,6 +707,13 @@ "smithy.api#documentation": "

Represents a collection of allowed headers. Supported only for HTTP APIs.

", "smithy.api#jsonName": "allowHeaders" } + }, + "AllowMethods": { + "target": "com.amazonaws.apigatewayv2#CorsMethodList", + "traits": { + "smithy.api#documentation": "

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "allowMethods" + } } }, "traits": { @@ -781,11 +812,12 @@ "com.amazonaws.apigatewayv2#CreateApiMappingRequest": { "type": "structure", "members": { - "ApiMappingKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "The API mapping key.", - "smithy.api#jsonName": "apiMappingKey" + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage", + "smithy.api#required": {} } }, "DomainName": { @@ -796,6 +828,13 @@ "smithy.api#required": {} } }, + "ApiMappingKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "The API mapping key.", + "smithy.api#jsonName": "apiMappingKey" + } + }, "ApiId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -803,14 +842,6 @@ "smithy.api#jsonName": "apiId", "smithy.api#required": {} } - }, - "Stage": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The API stage.

", - "smithy.api#jsonName": "stage", - "smithy.api#required": {} - } } }, "traits": { @@ -853,18 +884,25 @@ "com.amazonaws.apigatewayv2#CreateApiRequest": { "type": "structure", "members": { - "CorsConfiguration": { - "target": "com.amazonaws.apigatewayv2#Cors", + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

", - "smithy.api#jsonName": "corsConfiguration" + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" } }, - "CredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "credentialsArn" + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" + } + }, + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" } }, "Version": { @@ -874,13 +912,6 @@ "smithy.api#jsonName": "version" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The description of the API.

", - "smithy.api#jsonName": "description" - } - }, "RouteKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -888,18 +919,19 @@ "smithy.api#jsonName": "routeKey" } }, - "Target": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", "traits": { - "smithy.api#documentation": "

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "target" + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

", + "smithy.api#jsonName": "corsConfiguration" } }, - "DisableSchemaValidation": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", "traits": { - "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "disableSchemaValidation" + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType", + "smithy.api#required": {} } }, "Tags": { @@ -917,11 +949,18 @@ "smithy.api#required": {} } }, - "ApiKeySelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", - "smithy.api#jsonName": "apiKeySelectionExpression" + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "credentialsArn" } }, "RouteSelectionExpression": { @@ -931,12 +970,11 @@ "smithy.api#jsonName": "routeSelectionExpression" } }, - "ProtocolType": { - "target": "com.amazonaws.apigatewayv2#ProtocolType", + "Target": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

The API protocol.

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "target" } } }, @@ -947,46 +985,46 @@ "com.amazonaws.apigatewayv2#CreateApiResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The name of the API.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" } }, - "ProtocolType": { - "target": "com.amazonaws.apigatewayv2#ProtocolType", + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API protocol.

", - "smithy.api#jsonName": "protocolType" + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" } }, - "RouteSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", - "smithy.api#jsonName": "routeSelectionExpression" + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" } }, - "ApiEndpoint": { - "target": "com.amazonaws.apigatewayv2#__string", + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", "traits": { - "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", - "smithy.api#jsonName": "apiEndpoint" + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" } }, - "DisableSchemaValidation": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", "traits": { - "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "disableSchemaValidation" + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" } }, - "ImportInfo": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "importInfo" + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" } }, "Description": { @@ -1017,32 +1055,46 @@ "smithy.api#jsonName": "apiKeySelectionExpression" } }, - "Version": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", "traits": { - "smithy.api#documentation": "

A version identifier for the API.

", - "smithy.api#jsonName": "version" + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" } }, - "CorsConfiguration": { - "target": "com.amazonaws.apigatewayv2#Cors", + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "corsConfiguration" + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

A collection of tags associated with the API.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" } }, - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The timestamp when the API was created.

", - "smithy.api#jsonName": "createdDate" + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" } } } @@ -1081,35 +1133,32 @@ "com.amazonaws.apigatewayv2#CreateAuthorizerRequest": { "type": "structure", "members": { - "AuthorizerType": { - "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

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

This parameter is not used.

", + "smithy.api#jsonName": "identityValidationExpression" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

The API identifier.

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

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerCredentialsArn" } }, - "IdentityValidationExpression": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", "traits": { - "smithy.api#documentation": "

This parameter is not used.

", - "smithy.api#jsonName": "identityValidationExpression" + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" } }, - "IdentitySource": { - "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT )from inbound requests. Currently only header-based and query parameter-based selections are supported, for example \"$request.header.Authorization\".

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

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" } }, "JwtConfiguration": { @@ -1119,33 +1168,50 @@ "smithy.api#jsonName": "jwtConfiguration" } }, - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", "traits": { - "smithy.api#documentation": "

The name of the authorizer.

", - "smithy.api#jsonName": "name", + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType", "smithy.api#required": {} } }, - "AuthorizerResultTtlInSeconds": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", "traits": { - "smithy.api#documentation": "

Authorizer caching is not currently supported. Don't specify this value for authorizers.

", - "smithy.api#jsonName": "authorizerResultTtlInSeconds" + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource", + "smithy.api#required": {} } }, - "AuthorizerUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", - "smithy.api#jsonName": "authorizerUri" + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AuthorizerCredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

", - "smithy.api#jsonName": "authorizerCredentialsArn" + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } } }, @@ -1156,11 +1222,11 @@ "com.amazonaws.apigatewayv2#CreateAuthorizerResponse": { "type": "structure", "members": { - "IdentityValidationExpression": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", - "smithy.api#jsonName": "identityValidationExpression" + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" } }, "AuthorizerId": { @@ -1170,27 +1236,27 @@ "smithy.api#jsonName": "authorizerId" } }, - "AuthorizerResultTtlInSeconds": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", - "traits": { - "smithy.api#documentation": "

Authorizer caching is not currently supported. Don't specify this value for authorizers.

", - "smithy.api#jsonName": "authorizerResultTtlInSeconds" - } - }, - "AuthorizerUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", "traits": { - "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", - "smithy.api#jsonName": "authorizerUri" + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" } }, "AuthorizerCredentialsArn": { "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

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

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", "smithy.api#jsonName": "authorizerCredentialsArn" } }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, "Name": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { @@ -1198,26 +1264,40 @@ "smithy.api#jsonName": "name" } }, - "IdentitySource": { - "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example \"$request.header.Authorization\".

", - "smithy.api#jsonName": "identitySource" + "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", + "smithy.api#jsonName": "identityValidationExpression" } }, - "JwtConfiguration": { - "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "jwtConfiguration" + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" } }, "AuthorizerType": { "target": "com.amazonaws.apigatewayv2#AuthorizerType", "traits": { - "smithy.api#documentation": "

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

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

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", "smithy.api#jsonName": "authorizerType" } + }, + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", + "traits": { + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" + } + }, + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" + } } } }, @@ -1255,8 +1335,16 @@ "com.amazonaws.apigatewayv2#CreateDeploymentRequest": { "type": "structure", "members": { - "StageName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { "smithy.api#documentation": "

The name of the Stage resource for the Deployment resource to create.

", "smithy.api#jsonName": "stageName" @@ -1268,14 +1356,6 @@ "smithy.api#documentation": "

The description for the deployment resource.

", "smithy.api#jsonName": "description" } - }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -1292,18 +1372,11 @@ "smithy.api#jsonName": "autoDeployed" } }, - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The date and time when the Deployment resource was created.

", - "smithy.api#jsonName": "createdDate" - } - }, - "DeploymentStatusMessage": { - "target": "com.amazonaws.apigatewayv2#__string", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", - "smithy.api#jsonName": "deploymentStatusMessage" + "smithy.api#documentation": "

The description for the deployment.

", + "smithy.api#jsonName": "description" } }, "DeploymentId": { @@ -1320,11 +1393,18 @@ "smithy.api#jsonName": "deploymentStatus" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The description for the deployment.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The date and time when the Deployment resource was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" } } } @@ -1366,12 +1446,18 @@ "com.amazonaws.apigatewayv2#CreateDomainNameRequest": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

The domain name.

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

The collection of tags associated with a domain name.

", + "smithy.api#jsonName": "tags" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthenticationInput", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" } }, "DomainNameConfigurations": { @@ -1381,11 +1467,12 @@ "smithy.api#jsonName": "domainNameConfigurations" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "DomainName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", "traits": { - "smithy.api#documentation": "

The collection of tags associated with a domain name.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The domain name.

", + "smithy.api#jsonName": "domainName", + "smithy.api#required": {} } } }, @@ -1396,13 +1483,6 @@ "com.amazonaws.apigatewayv2#CreateDomainNameResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", - "traits": { - "smithy.api#documentation": "

The collection of tags associated with a domain name.

", - "smithy.api#jsonName": "tags" - } - }, "DomainNameConfigurations": { "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", "traits": { @@ -1423,6 +1503,20 @@ "smithy.api#documentation": "

The API mapping selection expression.

", "smithy.api#jsonName": "apiMappingSelectionExpression" } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags associated with a domain name.

", + "smithy.api#jsonName": "tags" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } } } }, @@ -1460,11 +1554,18 @@ "com.amazonaws.apigatewayv2#CreateIntegrationRequest": { "type": "structure", "members": { - "IntegrationUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", - "smithy.api#jsonName": "integrationUri" + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" } }, "ApiId": { @@ -1475,6 +1576,27 @@ "smithy.api#required": {} } }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfigInput", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" + } + }, "ConnectionId": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", "traits": { @@ -1489,25 +1611,18 @@ "smithy.api#jsonName": "requestTemplates" } }, - "CredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", - "traits": { - "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", - "smithy.api#jsonName": "credentialsArn" - } - }, - "PayloadFormatVersion": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", - "smithy.api#jsonName": "payloadFormatVersion" + "smithy.api#documentation": "

The template selection expression for the integration.

", + "smithy.api#jsonName": "templateSelectionExpression" } }, - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

The description of the integration.

", + "smithy.api#jsonName": "description" } }, "IntegrationMethod": { @@ -1517,18 +1632,12 @@ "smithy.api#jsonName": "integrationMethod" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The description of the integration.

", - "smithy.api#jsonName": "description" - } - }, - "ConnectionType": { - "target": "com.amazonaws.apigatewayv2#ConnectionType", + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", "traits": { - "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", - "smithy.api#jsonName": "connectionType" + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType", + "smithy.api#required": {} } }, "PassthroughBehavior": { @@ -1538,40 +1647,32 @@ "smithy.api#jsonName": "passthroughBehavior" } }, - "IntegrationType": { - "target": "com.amazonaws.apigatewayv2#IntegrationType", - "traits": { - "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "integrationType", - "smithy.api#required": {} - } - }, - "TlsConfig": { - "target": "com.amazonaws.apigatewayv2#TlsConfigInput", + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { - "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "tlsConfig" + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

", + "smithy.api#jsonName": "requestParameters" } }, - "TemplateSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", "traits": { - "smithy.api#documentation": "

The template selection expression for the integration.

", - "smithy.api#jsonName": "templateSelectionExpression" + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" } }, - "TimeoutInMillis": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", "traits": { - "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", - "smithy.api#jsonName": "timeoutInMillis" + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" } }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" } } }, @@ -1613,11 +1714,19 @@ "com.amazonaws.apigatewayv2#CreateIntegrationResponseRequest": { "type": "structure", "members": { - "TemplateSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { - "smithy.api#documentation": "

The template selection expression for the integration response. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "templateSelectionExpression" + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey", + "smithy.api#required": {} + } + }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" } }, "ApiId": { @@ -1628,6 +1737,13 @@ "smithy.api#required": {} } }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } + }, "ResponseTemplates": { "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { @@ -1635,19 +1751,11 @@ "smithy.api#jsonName": "responseTemplates" } }, - "IntegrationResponseKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", - "traits": { - "smithy.api#documentation": "

The integration response key.

", - "smithy.api#jsonName": "integrationResponseKey", - "smithy.api#required": {} - } - }, - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

The template selection expression for the integration response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" } }, "IntegrationId": { @@ -1657,13 +1765,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", - "traits": { - "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

", - "smithy.api#jsonName": "responseParameters" - } } }, "traits": { @@ -1673,6 +1774,20 @@ "com.amazonaws.apigatewayv2#CreateIntegrationResponseResponse": { "type": "structure", "members": { + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#jsonName": "integrationResponseId" + } + }, "IntegrationResponseKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -1687,20 +1802,6 @@ "smithy.api#jsonName": "templateSelectionExpression" } }, - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", - "traits": { - "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", - "smithy.api#jsonName": "responseParameters" - } - }, - "IntegrationResponseId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The integration response ID.

", - "smithy.api#jsonName": "integrationResponseId" - } - }, "ResponseTemplates": { "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { @@ -1708,11 +1809,11 @@ "smithy.api#jsonName": "responseTemplates" } }, - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { - "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" } } } @@ -1720,27 +1821,6 @@ "com.amazonaws.apigatewayv2#CreateIntegrationResult": { "type": "structure", "members": { - "IntegrationId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

Represents the identifier of an integration.

", - "smithy.api#jsonName": "integrationId" - } - }, - "CredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", - "traits": { - "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", - "smithy.api#jsonName": "credentialsArn" - } - }, - "IntegrationUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", - "traits": { - "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", - "smithy.api#jsonName": "integrationUri" - } - }, "RequestTemplates": { "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { @@ -1748,53 +1828,53 @@ "smithy.api#jsonName": "requestTemplates" } }, - "IntegrationResponseSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", "traits": { - "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", - "smithy.api#jsonName": "integrationResponseSelectionExpression" + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" } }, - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" } }, - "TimeoutInMillis": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", - "smithy.api#jsonName": "timeoutInMillis" + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" } }, - "ConnectionId": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "connectionId" + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" } }, - "IntegrationType": { - "target": "com.amazonaws.apigatewayv2#IntegrationType", + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "integrationType" + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" } }, - "TlsConfig": { - "target": "com.amazonaws.apigatewayv2#TlsConfig", + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "tlsConfig" + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" } }, - "ConnectionType": { - "target": "com.amazonaws.apigatewayv2#ConnectionType", + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { - "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", - "smithy.api#jsonName": "connectionType" + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

", + "smithy.api#jsonName": "requestParameters" } }, "IntegrationMethod": { @@ -1811,6 +1891,13 @@ "smithy.api#jsonName": "description" } }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, "ApiGatewayManaged": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -1818,32 +1905,53 @@ "smithy.api#jsonName": "apiGatewayManaged" } }, - "PayloadFormatVersion": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", - "smithy.api#jsonName": "payloadFormatVersion" + "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" } }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" } }, - "TemplateSelectionExpression": { + "IntegrationResponseSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "templateSelectionExpression" + "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", + "smithy.api#jsonName": "integrationResponseSelectionExpression" } }, - "PassthroughBehavior": { - "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", "traits": { - "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", - "smithy.api#jsonName": "passthroughBehavior" + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfig", + "traits": { + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" + } + }, + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" } } } @@ -1882,22 +1990,6 @@ "com.amazonaws.apigatewayv2#CreateModelRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "ContentType": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", "traits": { @@ -1919,6 +2011,22 @@ "smithy.api#documentation": "

The description of the model.

", "smithy.api#jsonName": "description" } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -1928,13 +2036,6 @@ "com.amazonaws.apigatewayv2#CreateModelResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", - "smithy.api#jsonName": "name" - } - }, "ModelId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -1942,13 +2043,6 @@ "smithy.api#jsonName": "modelId" } }, - "ContentType": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", - "traits": { - "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", - "smithy.api#jsonName": "contentType" - } - }, "Description": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { @@ -1956,12 +2050,26 @@ "smithy.api#jsonName": "description" } }, + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "traits": { + "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" + } + }, "Schema": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", "traits": { "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", "smithy.api#jsonName": "schema" } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name" + } } } }, @@ -1999,19 +2107,18 @@ "com.amazonaws.apigatewayv2#CreateRouteRequest": { "type": "structure", "members": { - "RouteKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The route key for the route.

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

The target for the route.

", + "smithy.api#jsonName": "target" } }, - "OperationName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { - "smithy.api#documentation": "

The operation name for the route.

", - "smithy.api#jsonName": "operationName" + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" } }, "ApiId": { @@ -2022,18 +2129,25 @@ "smithy.api#required": {} } }, - "ModelSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "modelSelectionExpression" + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" } }, - "AuthorizerId": { - "target": "com.amazonaws.apigatewayv2#Id", + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", - "smithy.api#jsonName": "authorizerId" + "smithy.api#documentation": "

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

The authorization scopes supported by this route.

", + "smithy.api#jsonName": "authorizationScopes" } }, "RequestParameters": { @@ -2043,6 +2157,13 @@ "smithy.api#jsonName": "requestParameters" } }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, "RouteResponseSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -2053,36 +2174,23 @@ "AuthorizationType": { "target": "com.amazonaws.apigatewayv2#AuthorizationType", "traits": { - "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

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

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", "smithy.api#jsonName": "authorizationType" } }, - "ApiKeyRequired": { - "target": "com.amazonaws.apigatewayv2#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "apiKeyRequired" - } - }, - "AuthorizationScopes": { - "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", - "traits": { - "smithy.api#documentation": "

The authorization scopes supported by this route.

", - "smithy.api#jsonName": "authorizationScopes" - } - }, - "Target": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { - "smithy.api#documentation": "

The target for the route.

", - "smithy.api#jsonName": "target" + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey", + "smithy.api#required": {} } }, - "RequestModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestModels" + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" } } }, @@ -2131,6 +2239,14 @@ "smithy.api#jsonName": "responseParameters" } }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "RouteResponseKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -2146,14 +2262,6 @@ "smithy.api#jsonName": "responseModels" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "RouteId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -2177,11 +2285,11 @@ "com.amazonaws.apigatewayv2#CreateRouteResponseResponse": { "type": "structure", "members": { - "ResponseModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", "traits": { - "smithy.api#documentation": "

Represents the response models of a route response.

", - "smithy.api#jsonName": "responseModels" + "smithy.api#documentation": "

Represents the response parameters of a route response.

", + "smithy.api#jsonName": "responseParameters" } }, "RouteResponseId": { @@ -2191,11 +2299,11 @@ "smithy.api#jsonName": "routeResponseId" } }, - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#RouteParameters", + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

Represents the response parameters of a route response.

", - "smithy.api#jsonName": "responseParameters" + "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" } }, "RouteResponseKey": { @@ -2205,11 +2313,11 @@ "smithy.api#jsonName": "routeResponseKey" } }, - "ModelSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { - "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "modelSelectionExpression" + "smithy.api#documentation": "

Represents the response models of a route response.

", + "smithy.api#jsonName": "responseModels" } } } @@ -2217,18 +2325,11 @@ "com.amazonaws.apigatewayv2#CreateRouteResult": { "type": "structure", "members": { - "Target": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The target for the route.

", - "smithy.api#jsonName": "target" - } - }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#RouteParameters", + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" } }, "AuthorizerId": { @@ -2238,6 +2339,13 @@ "smithy.api#jsonName": "authorizerId" } }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, "RouteId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -2245,25 +2353,18 @@ "smithy.api#jsonName": "routeId" } }, - "RequestModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", - "traits": { - "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestModels" - } - }, - "ApiGatewayManaged": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", - "smithy.api#jsonName": "apiGatewayManaged" + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" } }, - "OperationName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { - "smithy.api#documentation": "

The operation name for the route.

", - "smithy.api#jsonName": "operationName" + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" } }, "ApiKeyRequired": { @@ -2273,39 +2374,46 @@ "smithy.api#jsonName": "apiKeyRequired" } }, - "AuthorizationScopes": { - "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", "traits": { - "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", - "smithy.api#jsonName": "authorizationScopes" + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" } }, - "RouteKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The route key for the route.

", - "smithy.api#jsonName": "routeKey" + "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "RouteResponseSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { - "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "routeResponseSelectionExpression" + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" } }, - "ModelSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", "traits": { - "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "modelSelectionExpression" + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "smithy.api#jsonName": "authorizationScopes" } }, - "AuthorizationType": { - "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

", - "smithy.api#jsonName": "authorizationType" + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" } } } @@ -2344,18 +2452,25 @@ "com.amazonaws.apigatewayv2#CreateStageRequest": { "type": "structure", "members": { - "StageVariables": { - "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", - "smithy.api#jsonName": "stageVariables" + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

The description for the API stage.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" } }, "StageName": { @@ -2366,18 +2481,18 @@ "smithy.api#required": {} } }, - "DeploymentId": { - "target": "com.amazonaws.apigatewayv2#Id", + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", "traits": { - "smithy.api#documentation": "

The deployment identifier of the API stage.

", - "smithy.api#jsonName": "deploymentId" + "smithy.api#documentation": "

The default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" } }, - "AccessLogSettings": { - "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", "traits": { - "smithy.api#documentation": "

Settings for logging access in this stage.

", - "smithy.api#jsonName": "accessLogSettings" + "smithy.api#documentation": "

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" } }, "RouteSettings": { @@ -2387,25 +2502,18 @@ "smithy.api#jsonName": "routeSettings" } }, - "DefaultRouteSettings": { - "target": "com.amazonaws.apigatewayv2#RouteSettings", - "traits": { - "smithy.api#documentation": "

The default route settings for the stage.

", - "smithy.api#jsonName": "defaultRouteSettings" - } - }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" } }, - "AutoDeploy": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", - "smithy.api#jsonName": "autoDeploy" + "smithy.api#documentation": "

The deployment identifier of the API stage.

", + "smithy.api#jsonName": "deploymentId" } }, "ApiId": { @@ -2416,11 +2524,11 @@ "smithy.api#required": {} } }, - "ClientCertificateId": { - "target": "com.amazonaws.apigatewayv2#Id", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "clientCertificateId" + "smithy.api#documentation": "

The description for the API stage.

", + "smithy.api#jsonName": "description" } } }, @@ -2431,13 +2539,6 @@ "com.amazonaws.apigatewayv2#CreateStageResponse": { "type": "structure", "members": { - "RouteSettings": { - "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", - "traits": { - "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", - "smithy.api#jsonName": "routeSettings" - } - }, "CreatedDate": { "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { @@ -2445,32 +2546,46 @@ "smithy.api#jsonName": "createdDate" } }, - "DeploymentId": { + "ClientCertificateId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", - "smithy.api#jsonName": "deploymentId" + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" } }, - "LastUpdatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The timestamp when the stage was last updated.

", - "smithy.api#jsonName": "lastUpdatedDate" + "smithy.api#documentation": "

The description of the stage.

", + "smithy.api#jsonName": "description" } }, - "ApiGatewayManaged": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", "traits": { - "smithy.api#documentation": "

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

", - "smithy.api#jsonName": "apiGatewayManaged" + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" } }, - "AutoDeploy": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", - "smithy.api#jsonName": "autoDeploy" + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName" + } + }, + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "traits": { + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" } }, "LastDeploymentStatusMessage": { @@ -2494,39 +2609,32 @@ "smithy.api#jsonName": "tags" } }, - "AccessLogSettings": { - "target": "com.amazonaws.apigatewayv2#AccessLogSettings", - "traits": { - "smithy.api#documentation": "

Settings for logging access in this stage.

", - "smithy.api#jsonName": "accessLogSettings" - } - }, - "StageName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "LastUpdatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The name of the stage.

", - "smithy.api#jsonName": "stageName" + "smithy.api#documentation": "

The timestamp when the stage was last updated.

", + "smithy.api#jsonName": "lastUpdatedDate" } }, - "StageVariables": { - "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", - "smithy.api#jsonName": "stageVariables" + "smithy.api#documentation": "

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "ClientCertificateId": { + "DeploymentId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "clientCertificateId" + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The description of the stage.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" } } } @@ -2597,6 +2705,13 @@ "com.amazonaws.apigatewayv2#CreateVpcLinkResponse": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

Tags for the VPC link.

", + "smithy.api#jsonName": "tags" + } + }, "VpcLinkStatus": { "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", "traits": { @@ -2618,6 +2733,13 @@ "smithy.api#jsonName": "name" } }, + "SecurityGroupIds": { + "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", + "smithy.api#jsonName": "securityGroupIds" + } + }, "CreatedDate": { "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { @@ -2625,13 +2747,6 @@ "smithy.api#jsonName": "createdDate" } }, - "VpcLinkId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The ID of the VPC link.

", - "smithy.api#jsonName": "vpcLinkId" - } - }, "SubnetIds": { "target": "com.amazonaws.apigatewayv2#SubnetIdList", "traits": { @@ -2639,26 +2754,19 @@ "smithy.api#jsonName": "subnetIds" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", - "traits": { - "smithy.api#documentation": "

Tags for the VPC link.

", - "smithy.api#jsonName": "tags" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", - "smithy.api#jsonName": "securityGroupIds" - } - }, "VpcLinkStatusMessage": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", "smithy.api#jsonName": "vpcLinkStatusMessage" } + }, + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#jsonName": "vpcLinkId" + } } } }, @@ -2687,18 +2795,18 @@ "com.amazonaws.apigatewayv2#DeleteAccessLogSettingsRequest": { "type": "structure", "members": { - "StageName": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiId": { + "StageName": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2811,18 +2919,18 @@ "com.amazonaws.apigatewayv2#DeleteAuthorizerRequest": { "type": "structure", "members": { - "ApiId": { + "AuthorizerId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The authorizer identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AuthorizerId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The authorizer identifier.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2889,18 +2997,18 @@ "com.amazonaws.apigatewayv2#DeleteDeploymentRequest": { "type": "structure", "members": { - "ApiId": { + "DeploymentId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The deployment ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DeploymentId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The deployment ID.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3147,26 +3255,26 @@ "com.amazonaws.apigatewayv2#DeleteRouteRequestParameterRequest": { "type": "structure", "members": { - "RouteId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route ID.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RequestParameterKey": { + "RouteId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route request parameter key.

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

The route ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiId": { + "RequestParameterKey": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The route request parameter key.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3198,26 +3306,26 @@ "com.amazonaws.apigatewayv2#DeleteRouteResponseRequest": { "type": "structure", "members": { - "RouteResponseId": { + "RouteId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route response ID.

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

The route ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiId": { + "RouteResponseId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The route response ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RouteId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route ID.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3363,13 +3471,6 @@ "com.amazonaws.apigatewayv2#Deployment": { "type": "structure", "members": { - "DeploymentStatus": { - "target": "com.amazonaws.apigatewayv2#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", - "smithy.api#jsonName": "deploymentStatus" - } - }, "AutoDeployed": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -3377,6 +3478,13 @@ "smithy.api#jsonName": "autoDeployed" } }, + "DeploymentStatus": { + "target": "com.amazonaws.apigatewayv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", + "smithy.api#jsonName": "deploymentStatus" + } + }, "DeploymentId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -3384,11 +3492,11 @@ "smithy.api#jsonName": "deploymentId" } }, - "DeploymentStatusMessage": { - "target": "com.amazonaws.apigatewayv2#__string", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", - "smithy.api#jsonName": "deploymentStatusMessage" + "smithy.api#documentation": "

The description for the deployment.

", + "smithy.api#jsonName": "description" } }, "CreatedDate": { @@ -3398,11 +3506,11 @@ "smithy.api#jsonName": "createdDate" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The description for the deployment.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" } } }, @@ -3433,11 +3541,11 @@ "com.amazonaws.apigatewayv2#DomainName": { "type": "structure", "members": { - "ApiMappingSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", "traits": { - "smithy.api#documentation": "

The API mapping selection expression.

", - "smithy.api#jsonName": "apiMappingSelectionExpression" + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" } }, "DomainName": { @@ -3455,11 +3563,18 @@ "smithy.api#jsonName": "tags" } }, - "DomainNameConfigurations": { - "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "ApiMappingSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The domain name configurations.

", - "smithy.api#jsonName": "domainNameConfigurations" + "smithy.api#documentation": "

The API mapping selection expression.

", + "smithy.api#jsonName": "apiMappingSelectionExpression" + } + }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" } } }, @@ -3470,25 +3585,11 @@ "com.amazonaws.apigatewayv2#DomainNameConfiguration": { "type": "structure", "members": { - "ApiGatewayDomainName": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

A domain name for the API.

", - "smithy.api#jsonName": "apiGatewayDomainName" - } - }, - "HostedZoneId": { + "DomainNameStatusMessage": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Route 53 Hosted Zone ID of the endpoint.

", - "smithy.api#jsonName": "hostedZoneId" - } - }, - "EndpointType": { - "target": "com.amazonaws.apigatewayv2#EndpointType", - "traits": { - "smithy.api#documentation": "

The endpoint type.

", - "smithy.api#jsonName": "endpointType" + "smithy.api#documentation": "

An optional text message containing detailed information about status of the domain name migration.

", + "smithy.api#jsonName": "domainNameStatusMessage" } }, "SecurityPolicy": { @@ -3498,11 +3599,18 @@ "smithy.api#jsonName": "securityPolicy" } }, - "CertificateUploadDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "CertificateArn": { + "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

", - "smithy.api#jsonName": "certificateUploadDate" + "smithy.api#documentation": "

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

", + "smithy.api#jsonName": "certificateArn" + } + }, + "EndpointType": { + "target": "com.amazonaws.apigatewayv2#EndpointType", + "traits": { + "smithy.api#documentation": "

The endpoint type.

", + "smithy.api#jsonName": "endpointType" } }, "CertificateName": { @@ -3512,11 +3620,11 @@ "smithy.api#jsonName": "certificateName" } }, - "DomainNameStatusMessage": { + "HostedZoneId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

An optional text message containing detailed information about status of the domain name migration.

", - "smithy.api#jsonName": "domainNameStatusMessage" + "smithy.api#documentation": "

The Amazon Route 53 Hosted Zone ID of the endpoint.

", + "smithy.api#jsonName": "hostedZoneId" } }, "DomainNameStatus": { @@ -3526,18 +3634,25 @@ "smithy.api#jsonName": "domainNameStatus" } }, - "CertificateArn": { - "target": "com.amazonaws.apigatewayv2#Arn", + "CertificateUploadDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

", - "smithy.api#jsonName": "certificateArn" + "smithy.api#documentation": "

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

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

The domain name configuration.

" - } - }, + }, + "ApiGatewayDomainName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

A domain name for the API.

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

The domain name configuration.

" + } + }, "com.amazonaws.apigatewayv2#DomainNameConfigurations": { "type": "list", "member": { @@ -3609,19 +3724,11 @@ "com.amazonaws.apigatewayv2#ExportApiRequest": { "type": "structure", "members": { - "ExportVersion": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

", - "smithy.api#httpQuery": "exportVersion" - } - }, - "OutputType": { - "target": "com.amazonaws.apigatewayv2#__string", + "IncludeExtensions": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The output type of the exported definition file. Valid values are JSON and YAML.

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

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

", + "smithy.api#httpQuery": "includeExtensions" } }, "StageName": { @@ -3639,13 +3746,6 @@ "smithy.api#required": {} } }, - "IncludeExtensions": { - "target": "com.amazonaws.apigatewayv2#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

", - "smithy.api#httpQuery": "includeExtensions" - } - }, "Specification": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -3653,6 +3753,21 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "OutputType": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The output type of the exported definition file. Valid values are JSON and YAML.

", + "smithy.api#httpQuery": "outputType", + "smithy.api#required": {} + } + }, + "ExportVersion": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

", + "smithy.api#httpQuery": "exportVersion" + } } } }, @@ -3729,18 +3844,18 @@ "com.amazonaws.apigatewayv2#GetApiMappingRequest": { "type": "structure", "members": { - "DomainName": { + "ApiMappingId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The domain name.

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

The API mapping identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiMappingId": { + "DomainName": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API mapping identifier.

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

The domain name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3750,18 +3865,25 @@ "com.amazonaws.apigatewayv2#GetApiMappingResponse": { "type": "structure", "members": { - "ApiMappingId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The API mapping identifier.

", - "smithy.api#jsonName": "apiMappingId" + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId" } }, - "ApiId": { + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage" + } + }, + "ApiMappingId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#jsonName": "apiId" + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#jsonName": "apiMappingId" } }, "ApiMappingKey": { @@ -3770,13 +3892,6 @@ "smithy.api#documentation": "

The API mapping key.

", "smithy.api#jsonName": "apiMappingKey" } - }, - "Stage": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The API stage.

", - "smithy.api#jsonName": "stage" - } } } }, @@ -3818,13 +3933,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "MaxResults": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", - "smithy.api#httpQuery": "maxResults" - } - }, "DomainName": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -3832,6 +3940,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -3870,13 +3985,6 @@ "com.amazonaws.apigatewayv2#GetApiResponse": { "type": "structure", "members": { - "ImportInfo": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", - "traits": { - "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "importInfo" - } - }, "Description": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { @@ -3891,32 +3999,39 @@ "smithy.api#jsonName": "routeSelectionExpression" } }, - "ProtocolType": { - "target": "com.amazonaws.apigatewayv2#ProtocolType", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The API protocol.

", - "smithy.api#jsonName": "protocolType" + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "DisableSchemaValidation": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "disableSchemaValidation" + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" } }, - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The name of the API.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" } }, - "ApiEndpoint": { - "target": "com.amazonaws.apigatewayv2#__string", + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", - "smithy.api#jsonName": "apiEndpoint" + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" } }, "CreatedDate": { @@ -3926,6 +4041,13 @@ "smithy.api#jsonName": "createdDate" } }, + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, "Version": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { @@ -3933,6 +4055,13 @@ "smithy.api#jsonName": "version" } }, + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", + "traits": { + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" + } + }, "CorsConfiguration": { "target": "com.amazonaws.apigatewayv2#Cors", "traits": { @@ -3940,32 +4069,32 @@ "smithy.api#jsonName": "corsConfiguration" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#Id", + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The API ID.

", - "smithy.api#jsonName": "apiId" + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", "traits": { - "smithy.api#documentation": "

A collection of tags associated with the API.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" } }, - "Warnings": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", - "smithy.api#jsonName": "warnings" + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" } }, - "ApiKeySelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", - "smithy.api#jsonName": "apiKeySelectionExpression" + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" } } } @@ -4020,19 +4149,19 @@ "com.amazonaws.apigatewayv2#GetApisResponse": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.apigatewayv2#__listOfApi", - "traits": { - "smithy.api#documentation": "

The elements from this collection.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", "smithy.api#jsonName": "nextToken" } + }, + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfApi", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } } } }, @@ -4085,67 +4214,81 @@ "com.amazonaws.apigatewayv2#GetAuthorizerResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", "traits": { - "smithy.api#documentation": "

The name of the authorizer.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType" } }, "AuthorizerCredentialsArn": { "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

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

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", "smithy.api#jsonName": "authorizerCredentialsArn" } }, - "AuthorizerUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", - "smithy.api#jsonName": "authorizerUri" + "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", + "smithy.api#jsonName": "identityValidationExpression" } }, - "AuthorizerId": { - "target": "com.amazonaws.apigatewayv2#Id", + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The authorizer identifier.

", - "smithy.api#jsonName": "authorizerId" + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" } }, - "IdentityValidationExpression": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The validation expression does not apply to the REQUEST authorizer.

", - "smithy.api#jsonName": "identityValidationExpression" + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name" + } + }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" } }, "AuthorizerResultTtlInSeconds": { "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", "traits": { - "smithy.api#documentation": "

Authorizer caching is not currently supported. Don't specify this value for authorizers.

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

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", "smithy.api#jsonName": "authorizerResultTtlInSeconds" } }, "IdentitySource": { "target": "com.amazonaws.apigatewayv2#IdentitySourceList", "traits": { - "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example \"$request.header.Authorization\".

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

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", "smithy.api#jsonName": "identitySource" } }, - "AuthorizerType": { - "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

", - "smithy.api#jsonName": "authorizerType" - } - }, - "JwtConfiguration": { - "target": "com.amazonaws.apigatewayv2#JWTConfiguration", - "traits": { - "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "jwtConfiguration" + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#jsonName": "authorizerId" } } } @@ -4181,18 +4324,18 @@ "com.amazonaws.apigatewayv2#GetAuthorizersRequest": { "type": "structure", "members": { - "MaxResults": { + "NextToken": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" } }, - "NextToken": { + "MaxResults": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

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

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" } }, "ApiId": { @@ -4273,13 +4416,6 @@ "com.amazonaws.apigatewayv2#GetDeploymentResponse": { "type": "structure", "members": { - "DeploymentId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The identifier for the deployment.

", - "smithy.api#jsonName": "deploymentId" - } - }, "CreatedDate": { "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { @@ -4287,13 +4423,6 @@ "smithy.api#jsonName": "createdDate" } }, - "DeploymentStatus": { - "target": "com.amazonaws.apigatewayv2#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", - "smithy.api#jsonName": "deploymentStatus" - } - }, "AutoDeployed": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -4301,11 +4430,18 @@ "smithy.api#jsonName": "autoDeployed" } }, - "DeploymentStatusMessage": { - "target": "com.amazonaws.apigatewayv2#__string", + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", - "smithy.api#jsonName": "deploymentStatusMessage" + "smithy.api#documentation": "

The identifier for the deployment.

", + "smithy.api#jsonName": "deploymentId" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.apigatewayv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

", + "smithy.api#jsonName": "deploymentStatus" } }, "Description": { @@ -4314,6 +4450,13 @@ "smithy.api#documentation": "

The description for the deployment.

", "smithy.api#jsonName": "description" } + }, + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" + } } } }, @@ -4348,11 +4491,12 @@ "com.amazonaws.apigatewayv2#GetDeploymentsRequest": { "type": "structure", "members": { - "NextToken": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

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

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "MaxResults": { @@ -4362,12 +4506,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "ApiId": { + "NextToken": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -4446,11 +4589,11 @@ "smithy.api#jsonName": "domainNameConfigurations" } }, - "DomainName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", "traits": { - "smithy.api#documentation": "

The name of the DomainName resource.

", - "smithy.api#jsonName": "domainName" + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" } }, "ApiMappingSelectionExpression": { @@ -4459,6 +4602,13 @@ "smithy.api#documentation": "

The API mapping selection expression.

", "smithy.api#jsonName": "apiMappingSelectionExpression" } + }, + "DomainName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And512", + "traits": { + "smithy.api#documentation": "

The name of the DomainName resource.

", + "smithy.api#jsonName": "domainName" + } } } }, @@ -4512,19 +4662,19 @@ "com.amazonaws.apigatewayv2#GetDomainNamesResponse": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.apigatewayv2#__listOfDomainName", - "traits": { - "smithy.api#documentation": "

The elements from this collection.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", "smithy.api#jsonName": "nextToken" } + }, + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfDomainName", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } } } }, @@ -4556,18 +4706,18 @@ "com.amazonaws.apigatewayv2#GetIntegrationRequest": { "type": "structure", "members": { - "IntegrationId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The integration ID.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiId": { + "IntegrationId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The integration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4610,18 +4760,18 @@ "smithy.api#required": {} } }, - "IntegrationId": { + "IntegrationResponseId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The integration ID.

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

The integration response ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "IntegrationResponseId": { + "IntegrationId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The integration response ID.

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

The integration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4631,13 +4781,6 @@ "com.amazonaws.apigatewayv2#GetIntegrationResponseResponse": { "type": "structure", "members": { - "IntegrationResponseId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The integration response ID.

", - "smithy.api#jsonName": "integrationResponseId" - } - }, "ResponseTemplates": { "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { @@ -4659,19 +4802,26 @@ "smithy.api#jsonName": "integrationResponseKey" } }, - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", - "traits": { - "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", - "smithy.api#jsonName": "responseParameters" - } - }, "ContentHandlingStrategy": { "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", "traits": { "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", "smithy.api#jsonName": "contentHandlingStrategy" } + }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#jsonName": "integrationResponseId" + } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" + } } } }, @@ -4713,13 +4863,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "MaxResults": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", - "smithy.api#httpQuery": "maxResults" - } - }, "IntegrationId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -4735,57 +4878,57 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.apigatewayv2#GetIntegrationResponsesResponse": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.apigatewayv2#__listOfIntegrationResponse", - "traits": { - "smithy.api#documentation": "

The elements from this collection.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", "smithy.api#jsonName": "nextToken" } + }, + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfIntegrationResponse", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } } } }, "com.amazonaws.apigatewayv2#GetIntegrationResult": { "type": "structure", "members": { - "IntegrationType": { - "target": "com.amazonaws.apigatewayv2#IntegrationType", - "traits": { - "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "integrationType" - } - }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { - "smithy.api#documentation": "

Represents the description of an integration.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

", + "smithy.api#jsonName": "requestParameters" } }, - "PassthroughBehavior": { - "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", - "smithy.api#jsonName": "passthroughBehavior" + "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "IntegrationMethod": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "IntegrationResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", - "smithy.api#jsonName": "integrationMethod" + "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", + "smithy.api#jsonName": "integrationResponseSelectionExpression" } }, "TemplateSelectionExpression": { @@ -4802,32 +4945,39 @@ "smithy.api#jsonName": "connectionType" } }, - "ApiGatewayManaged": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", - "smithy.api#jsonName": "apiGatewayManaged" + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" } }, - "TimeoutInMillis": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", "traits": { - "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", - "smithy.api#jsonName": "timeoutInMillis" + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" } }, - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" } }, - "TlsConfig": { - "target": "com.amazonaws.apigatewayv2#TlsConfig", + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "tlsConfig" + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" + } + }, + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" } }, "RequestTemplates": { @@ -4837,6 +4987,13 @@ "smithy.api#jsonName": "requestTemplates" } }, + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "traits": { + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" + } + }, "IntegrationUri": { "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { @@ -4844,13 +5001,6 @@ "smithy.api#jsonName": "integrationUri" } }, - "ConnectionId": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", - "traits": { - "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "connectionId" - } - }, "CredentialsArn": { "target": "com.amazonaws.apigatewayv2#Arn", "traits": { @@ -4858,32 +5008,39 @@ "smithy.api#jsonName": "credentialsArn" } }, - "IntegrationResponseSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", - "smithy.api#jsonName": "integrationResponseSelectionExpression" + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" } }, - "IntegrationId": { - "target": "com.amazonaws.apigatewayv2#Id", + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfig", "traits": { - "smithy.api#documentation": "

Represents the identifier of an integration.

", - "smithy.api#jsonName": "integrationId" + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" } }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" } }, - "PayloadFormatVersion": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", "traits": { - "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", - "smithy.api#jsonName": "payloadFormatVersion" + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

Represents the description of an integration.

", + "smithy.api#jsonName": "description" } } } @@ -4927,18 +5084,18 @@ "smithy.api#required": {} } }, - "NextToken": { + "MaxResults": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

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

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" } }, - "MaxResults": { + "NextToken": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -5018,13 +5175,6 @@ "smithy.api#jsonName": "name" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The description of the model.

", - "smithy.api#jsonName": "description" - } - }, "ContentType": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", "traits": { @@ -5032,19 +5182,26 @@ "smithy.api#jsonName": "contentType" } }, - "Schema": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", - "traits": { - "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", - "smithy.api#jsonName": "schema" - } - }, "ModelId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { "smithy.api#documentation": "

The model identifier.

", "smithy.api#jsonName": "modelId" } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" + } } } }, @@ -5137,6 +5294,14 @@ "com.amazonaws.apigatewayv2#GetModelsRequest": { "type": "structure", "members": { + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -5150,14 +5315,6 @@ "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

", "smithy.api#httpQuery": "nextToken" } - }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -5254,26 +5411,26 @@ "com.amazonaws.apigatewayv2#GetRouteResponseRequest": { "type": "structure", "members": { - "RouteResponseId": { + "RouteId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route response ID.

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

The route ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RouteId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route ID.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiId": { + "RouteResponseId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The route response ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5283,13 +5440,6 @@ "com.amazonaws.apigatewayv2#GetRouteResponseResponse": { "type": "structure", "members": { - "ModelSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "modelSelectionExpression" - } - }, "ResponseModels": { "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { @@ -5304,6 +5454,13 @@ "smithy.api#jsonName": "routeResponseKey" } }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

Represents the response parameters of a route response.

", + "smithy.api#jsonName": "responseParameters" + } + }, "RouteResponseId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -5311,11 +5468,11 @@ "smithy.api#jsonName": "routeResponseId" } }, - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#RouteParameters", + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

Represents the response parameters of a route response.

", - "smithy.api#jsonName": "responseParameters" + "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" } } } @@ -5351,11 +5508,12 @@ "com.amazonaws.apigatewayv2#GetRouteResponsesRequest": { "type": "structure", "members": { - "MaxResults": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

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

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "RouteId": { @@ -5373,12 +5531,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "ApiId": { + "MaxResults": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" } } } @@ -5386,37 +5543,44 @@ "com.amazonaws.apigatewayv2#GetRouteResponsesResponse": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.apigatewayv2#__listOfRouteResponse", - "traits": { - "smithy.api#documentation": "

The elements from this collection.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", "smithy.api#jsonName": "nextToken" } + }, + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfRouteResponse", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

", + "smithy.api#jsonName": "items" + } } } }, "com.amazonaws.apigatewayv2#GetRouteResult": { "type": "structure", "members": { - "ApiGatewayManaged": { + "ApiKeyRequired": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", - "smithy.api#jsonName": "apiGatewayManaged" + "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" } }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#RouteParameters", + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", "traits": { - "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, "AuthorizationScopes": { @@ -5426,46 +5590,39 @@ "smithy.api#jsonName": "authorizationScopes" } }, - "Target": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "RouteResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The target for the route.

", - "smithy.api#jsonName": "target" + "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "routeResponseSelectionExpression" } }, - "RequestModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { - "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestModels" + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" } }, - "RouteId": { + "AuthorizerId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The route ID.

", - "smithy.api#jsonName": "routeId" + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" } }, - "RouteResponseSelectionExpression": { + "ModelSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The route response selection expression for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "routeResponseSelectionExpression" + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" } }, - "AuthorizerId": { + "RouteId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", - "smithy.api#jsonName": "authorizerId" - } - }, - "RouteKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", - "traits": { - "smithy.api#documentation": "

The route key for the route.

", - "smithy.api#jsonName": "routeKey" + "smithy.api#documentation": "

The route ID.

", + "smithy.api#jsonName": "routeId" } }, "OperationName": { @@ -5475,25 +5632,25 @@ "smithy.api#jsonName": "operationName" } }, - "ApiKeyRequired": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { - "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "apiKeyRequired" + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" } }, - "ModelSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "modelSelectionExpression" + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" } }, - "AuthorizationType": { - "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", "traits": { - "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

", - "smithy.api#jsonName": "authorizationType" + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" } } } @@ -5529,12 +5686,11 @@ "com.amazonaws.apigatewayv2#GetRoutesRequest": { "type": "structure", "members": { - "ApiId": { + "NextToken": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", + "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { @@ -5544,11 +5700,12 @@ "smithy.api#httpQuery": "maxResults" } }, - "NextToken": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

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

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -5600,18 +5757,18 @@ "com.amazonaws.apigatewayv2#GetStageRequest": { "type": "structure", "members": { - "StageName": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiId": { + "StageName": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5621,6 +5778,13 @@ "com.amazonaws.apigatewayv2#GetStageResponse": { "type": "structure", "members": { + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" + } + }, "ApiGatewayManaged": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -5628,11 +5792,11 @@ "smithy.api#jsonName": "apiGatewayManaged" } }, - "AutoDeploy": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", - "smithy.api#jsonName": "autoDeploy" + "smithy.api#documentation": "

The timestamp when the stage was created.

", + "smithy.api#jsonName": "createdDate" } }, "LastUpdatedDate": { @@ -5642,18 +5806,25 @@ "smithy.api#jsonName": "lastUpdatedDate" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The description of the stage.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName" } }, - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", "traits": { - "smithy.api#documentation": "

The timestamp when the stage was created.

", - "smithy.api#jsonName": "createdDate" + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" + } + }, + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" } }, "DefaultRouteSettings": { @@ -5663,11 +5834,11 @@ "smithy.api#jsonName": "defaultRouteSettings" } }, - "DeploymentId": { - "target": "com.amazonaws.apigatewayv2#Id", + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", "traits": { - "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", - "smithy.api#jsonName": "deploymentId" + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" } }, "LastDeploymentStatusMessage": { @@ -5677,18 +5848,18 @@ "smithy.api#jsonName": "lastDeploymentStatusMessage" } }, - "AccessLogSettings": { - "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

Settings for logging access in this stage.

", - "smithy.api#jsonName": "accessLogSettings" + "smithy.api#documentation": "

The description of the stage.

", + "smithy.api#jsonName": "description" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" } }, "ClientCertificateId": { @@ -5698,25 +5869,11 @@ "smithy.api#jsonName": "clientCertificateId" } }, - "StageName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The name of the stage.

", - "smithy.api#jsonName": "stageName" - } - }, - "StageVariables": { - "target": "com.amazonaws.apigatewayv2#StageVariablesMap", - "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", - "smithy.api#jsonName": "stageVariables" - } - }, - "RouteSettings": { - "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", - "smithy.api#jsonName": "routeSettings" + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" } } } @@ -5752,19 +5909,19 @@ "com.amazonaws.apigatewayv2#GetStagesRequest": { "type": "structure", "members": { - "ApiId": { + "MaxResults": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The maximum number of elements to be returned for this resource.

", + "smithy.api#httpQuery": "maxResults" } }, - "MaxResults": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The maximum number of elements to be returned for this resource.

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

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "NextToken": { @@ -5891,6 +6048,34 @@ "com.amazonaws.apigatewayv2#GetVpcLinkResponse": { "type": "structure", "members": { + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#jsonName": "vpcLinkId" + } + }, + "VpcLinkVersion": { + "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", + "traits": { + "smithy.api#documentation": "

The version of the VPC link.

", + "smithy.api#jsonName": "vpcLinkVersion" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the VPC link was created.

", + "smithy.api#jsonName": "createdDate" + } + }, + "VpcLinkStatusMessage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatusMessage" + } + }, "SecurityGroupIds": { "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", "traits": { @@ -5912,20 +6097,6 @@ "smithy.api#jsonName": "name" } }, - "VpcLinkStatusMessage": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", - "smithy.api#jsonName": "vpcLinkStatusMessage" - } - }, - "VpcLinkId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The ID of the VPC link.

", - "smithy.api#jsonName": "vpcLinkId" - } - }, "Tags": { "target": "com.amazonaws.apigatewayv2#Tags", "traits": { @@ -5939,20 +6110,6 @@ "smithy.api#documentation": "

The status of the VPC link.

", "smithy.api#jsonName": "vpcLinkStatus" } - }, - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The timestamp when the VPC link was created.

", - "smithy.api#jsonName": "createdDate" - } - }, - "VpcLinkVersion": { - "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", - "traits": { - "smithy.api#documentation": "

The version of the VPC link.

", - "smithy.api#jsonName": "vpcLinkVersion" - } } } }, @@ -6003,19 +6160,19 @@ "com.amazonaws.apigatewayv2#GetVpcLinksResponse": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.apigatewayv2#__listOfVpcLink", - "traits": { - "smithy.api#documentation": "

A collection of VPC links.

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

The next page of elements from this collection. Not valid for the last element of the collection.

", "smithy.api#jsonName": "nextToken" } + }, + "Items": { + "target": "com.amazonaws.apigatewayv2#__listOfVpcLink", + "traits": { + "smithy.api#documentation": "

A collection of VPC links.

", + "smithy.api#jsonName": "items" + } } } }, @@ -6068,13 +6225,6 @@ "com.amazonaws.apigatewayv2#ImportApiRequest": { "type": "structure", "members": { - "Basepath": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

", - "smithy.api#httpQuery": "basepath" - } - }, "Body": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -6089,6 +6239,13 @@ "smithy.api#documentation": "

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

", "smithy.api#httpQuery": "failOnWarnings" } + }, + "Basepath": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

", + "smithy.api#httpQuery": "basepath" + } } }, "traits": { @@ -6098,13 +6255,6 @@ "com.amazonaws.apigatewayv2#ImportApiResponse": { "type": "structure", "members": { - "ApiKeySelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", - "smithy.api#jsonName": "apiKeySelectionExpression" - } - }, "Name": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { @@ -6112,27 +6262,6 @@ "smithy.api#jsonName": "name" } }, - "Version": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", - "traits": { - "smithy.api#documentation": "

A version identifier for the API.

", - "smithy.api#jsonName": "version" - } - }, - "ImportInfo": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", - "traits": { - "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "importInfo" - } - }, - "Warnings": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", - "traits": { - "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", - "smithy.api#jsonName": "warnings" - } - }, "CreatedDate": { "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { @@ -6140,25 +6269,32 @@ "smithy.api#jsonName": "createdDate" } }, - "CorsConfiguration": { - "target": "com.amazonaws.apigatewayv2#Cors", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "corsConfiguration" + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", "traits": { - "smithy.api#documentation": "

A collection of tags associated with the API.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#Id", + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The API ID.

", - "smithy.api#jsonName": "apiId" + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" } }, "DisableSchemaValidation": { @@ -6168,11 +6304,11 @@ "smithy.api#jsonName": "disableSchemaValidation" } }, - "ApiEndpoint": { - "target": "com.amazonaws.apigatewayv2#__string", + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", "traits": { - "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", - "smithy.api#jsonName": "apiEndpoint" + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" } }, "Description": { @@ -6182,23 +6318,58 @@ "smithy.api#jsonName": "description" } }, - "RouteSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", - "smithy.api#jsonName": "routeSelectionExpression" + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" } }, - "ProtocolType": { - "target": "com.amazonaws.apigatewayv2#ProtocolType", + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The API protocol.

", - "smithy.api#jsonName": "protocolType" + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" } - } - } - }, - "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600": { + }, + "Warnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The warning messages reported when failonwarnings is turned on during API import.

", + "smithy.api#jsonName": "warnings" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" + } + }, + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + } + } + }, + "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600": { "type": "integer", "traits": { "smithy.api#documentation": "

An integer with a value between [0-3600].

", @@ -6231,11 +6402,11 @@ "com.amazonaws.apigatewayv2#Integration": { "type": "structure", "members": { - "PayloadFormatVersion": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "TlsConfig": { + "target": "com.amazonaws.apigatewayv2#TlsConfig", "traits": { - "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", - "smithy.api#jsonName": "payloadFormatVersion" + "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "tlsConfig" } }, "TimeoutInMillis": { @@ -6245,46 +6416,53 @@ "smithy.api#jsonName": "timeoutInMillis" } }, - "TlsConfig": { - "target": "com.amazonaws.apigatewayv2#TlsConfig", + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", "traits": { - "smithy.api#documentation": "

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "tlsConfig" + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" } }, - "ConnectionType": { - "target": "com.amazonaws.apigatewayv2#ConnectionType", + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", "traits": { - "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", - "smithy.api#jsonName": "connectionType" + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

Represents the description of an integration.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" } }, - "CredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", - "smithy.api#jsonName": "credentialsArn" + "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "IntegrationId": { - "target": "com.amazonaws.apigatewayv2#Id", + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

Represents the identifier of an integration.

", - "smithy.api#jsonName": "integrationId" + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" } }, - "IntegrationType": { - "target": "com.amazonaws.apigatewayv2#IntegrationType", + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", "traits": { - "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "integrationType" + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", + "traits": { + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" } }, "IntegrationResponseSelectionExpression": { @@ -6294,18 +6472,25 @@ "smithy.api#jsonName": "integrationResponseSelectionExpression" } }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, "RequestParameters": { "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name. Supported only for WebSocket APIs.

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

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

", "smithy.api#jsonName": "requestParameters" } }, - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" } }, "TemplateSelectionExpression": { @@ -6315,46 +6500,39 @@ "smithy.api#jsonName": "templateSelectionExpression" } }, - "IntegrationUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", - "traits": { - "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", - "smithy.api#jsonName": "integrationUri" - } - }, - "ConnectionId": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "connectionId" + "smithy.api#documentation": "

Represents the description of an integration.

", + "smithy.api#jsonName": "description" } }, - "RequestTemplates": { - "target": "com.amazonaws.apigatewayv2#TemplateMap", + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestTemplates" + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" } }, - "PassthroughBehavior": { - "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "PayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", - "smithy.api#jsonName": "passthroughBehavior" + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" } }, - "IntegrationMethod": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", "traits": { - "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", - "smithy.api#jsonName": "integrationMethod" + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" } }, - "ApiGatewayManaged": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", - "smithy.api#jsonName": "apiGatewayManaged" + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" } } }, @@ -6377,6 +6555,21 @@ "com.amazonaws.apigatewayv2#IntegrationResponse": { "type": "structure", "members": { + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expressions for the integration response.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey", + "smithy.api#required": {} + } + }, "ResponseTemplates": { "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { @@ -6384,6 +6577,13 @@ "smithy.api#jsonName": "responseTemplates" } }, + "IntegrationResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The integration response ID.

", + "smithy.api#jsonName": "integrationResponseId" + } + }, "ResponseParameters": { "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { @@ -6391,34 +6591,12 @@ "smithy.api#jsonName": "responseParameters" } }, - "TemplateSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

The template selection expressions for the integration response.

", - "smithy.api#jsonName": "templateSelectionExpression" - } - }, "ContentHandlingStrategy": { "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", "traits": { "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", "smithy.api#jsonName": "contentHandlingStrategy" } - }, - "IntegrationResponseId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The integration response ID.

", - "smithy.api#jsonName": "integrationResponseId" - } - }, - "IntegrationResponseKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", - "traits": { - "smithy.api#documentation": "

The integration response key.

", - "smithy.api#jsonName": "integrationResponseKey", - "smithy.api#required": {} - } } }, "traits": { @@ -6456,19 +6634,19 @@ "com.amazonaws.apigatewayv2#JWTConfiguration": { "type": "structure", "members": { - "Audience": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", - "traits": { - "smithy.api#documentation": "

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "audience" - } - }, "Issuer": { "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { "smithy.api#documentation": "

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}\n . Required for the JWT authorizer type. Supported only for HTTP APIs.

", "smithy.api#jsonName": "issuer" } + }, + "Audience": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "audience" + } } }, "traits": { @@ -6498,19 +6676,18 @@ "com.amazonaws.apigatewayv2#Model": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "ContentType": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", "traits": { - "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

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

The content-type for the model, for example, \"application/json\".

", + "smithy.api#jsonName": "contentType" } }, - "Schema": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", - "smithy.api#jsonName": "schema" + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" } }, "ModelId": { @@ -6520,18 +6697,19 @@ "smithy.api#jsonName": "modelId" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The description of the model.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, - "ContentType": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", "traits": { - "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", - "smithy.api#jsonName": "contentType" + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" } } }, @@ -6539,11 +6717,56 @@ "smithy.api#documentation": "

Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

" } }, - "com.amazonaws.apigatewayv2#NextToken": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

" - } + "com.amazonaws.apigatewayv2#MutualTlsAuthentication": { + "type": "structure", + "members": { + "TruststoreWarnings": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

", + "smithy.api#jsonName": "truststoreWarnings" + } + }, + "TruststoreUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", + "smithy.api#jsonName": "truststoreUri" + } + }, + "TruststoreVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", + "smithy.api#jsonName": "truststoreVersion" + } + } + } + }, + "com.amazonaws.apigatewayv2#MutualTlsAuthenticationInput": { + "type": "structure", + "members": { + "TruststoreUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", + "smithy.api#jsonName": "truststoreUri" + } + }, + "TruststoreVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", + "smithy.api#jsonName": "truststoreVersion" + } + } + } + }, + "com.amazonaws.apigatewayv2#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The next page of elements from this collection. Not valid for the last element of the collection.

" + } }, "com.amazonaws.apigatewayv2#NotFoundException": { "type": "structure", @@ -6654,14 +6877,6 @@ "com.amazonaws.apigatewayv2#ReimportApiRequest": { "type": "structure", "members": { - "Body": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The OpenAPI definition. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "body", - "smithy.api#required": {} - } - }, "FailOnWarnings": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -6669,6 +6884,14 @@ "smithy.api#httpQuery": "failOnWarnings" } }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Basepath": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -6676,11 +6899,11 @@ "smithy.api#httpQuery": "basepath" } }, - "ApiId": { + "Body": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The OpenAPI definition. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "body", "smithy.api#required": {} } } @@ -6692,11 +6915,11 @@ "com.amazonaws.apigatewayv2#ReimportApiResponse": { "type": "structure", "members": { - "ImportInfo": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "importInfo" + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" } }, "DisableSchemaValidation": { @@ -6706,46 +6929,39 @@ "smithy.api#jsonName": "disableSchemaValidation" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", - "traits": { - "smithy.api#documentation": "

A collection of tags associated with the API.

", - "smithy.api#jsonName": "tags" - } - }, - "ApiKeySelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", - "smithy.api#jsonName": "apiKeySelectionExpression" + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#Id", + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The API ID.

", - "smithy.api#jsonName": "apiId" + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", "traits": { - "smithy.api#documentation": "

The description of the API.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" } }, - "RouteSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", - "smithy.api#jsonName": "routeSelectionExpression" + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "ProtocolType": { - "target": "com.amazonaws.apigatewayv2#ProtocolType", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

The API protocol.

", - "smithy.api#jsonName": "protocolType" + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" } }, "CreatedDate": { @@ -6755,11 +6971,18 @@ "smithy.api#jsonName": "createdDate" } }, - "ApiEndpoint": { - "target": "com.amazonaws.apigatewayv2#__string", + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", - "smithy.api#jsonName": "apiEndpoint" + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", + "traits": { + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" } }, "Warnings": { @@ -6776,33 +6999,82 @@ "smithy.api#jsonName": "name" } }, - "CorsConfiguration": { - "target": "com.amazonaws.apigatewayv2#Cors", + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "corsConfiguration" + "smithy.api#documentation": "

The API ID.

", + "smithy.api#jsonName": "apiId" } }, - "Version": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", "traits": { - "smithy.api#documentation": "

A version identifier for the API.

", - "smithy.api#jsonName": "version" + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" } } } }, - "com.amazonaws.apigatewayv2#Route": { + "com.amazonaws.apigatewayv2#ResetAuthorizersCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.apigatewayv2#ResetAuthorizersCacheRequest" + }, + "errors": [ + { + "target": "com.amazonaws.apigatewayv2#NotFoundException" + }, + { + "target": "com.amazonaws.apigatewayv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v2/apis/{ApiId}/stages/{StageName}/cache/authorizers", + "code": 204 + } + } + }, + "com.amazonaws.apigatewayv2#ResetAuthorizersCacheRequest": { "type": "structure", "members": { - "RouteKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route key for the route.

", - "smithy.api#jsonName": "routeKey", + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apigatewayv2#Route": { + "type": "structure", + "members": { "Target": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { @@ -6817,39 +7089,18 @@ "smithy.api#jsonName": "apiKeyRequired" } }, - "AuthorizerId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", - "smithy.api#jsonName": "authorizerId" - } - }, - "RouteId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The route ID.

", - "smithy.api#jsonName": "routeId" - } - }, - "OperationName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", - "traits": { - "smithy.api#documentation": "

The operation name for the route.

", - "smithy.api#jsonName": "operationName" - } - }, - "RequestModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", "traits": { - "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestModels" + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" } }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#RouteParameters", + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", "traits": { - "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "smithy.api#jsonName": "authorizationScopes" } }, "ModelSelectionExpression": { @@ -6859,13 +7110,6 @@ "smithy.api#jsonName": "modelSelectionExpression" } }, - "AuthorizationType": { - "target": "com.amazonaws.apigatewayv2#AuthorizationType", - "traits": { - "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

", - "smithy.api#jsonName": "authorizationType" - } - }, "RouteResponseSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -6873,11 +7117,12 @@ "smithy.api#jsonName": "routeResponseSelectionExpression" } }, - "AuthorizationScopes": { - "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { - "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", - "smithy.api#jsonName": "authorizationScopes" + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey", + "smithy.api#required": {} } }, "ApiGatewayManaged": { @@ -6886,21 +7131,56 @@ "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

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

Represents a route.

" - } - }, - "com.amazonaws.apigatewayv2#RouteModels": { - "type": "map", - "key": { - "target": "com.amazonaws.apigatewayv2#__string" - }, - "value": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128" - }, - "traits": { + }, + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "RouteId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#jsonName": "routeId" + } + }, + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

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

Represents a route.

" + } + }, + "com.amazonaws.apigatewayv2#RouteModels": { + "type": "map", + "key": { + "target": "com.amazonaws.apigatewayv2#__string" + }, + "value": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128" + }, + "traits": { "smithy.api#documentation": "

The route models.

" } }, @@ -6919,11 +7199,11 @@ "com.amazonaws.apigatewayv2#RouteResponse": { "type": "structure", "members": { - "RouteResponseId": { - "target": "com.amazonaws.apigatewayv2#Id", + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { - "smithy.api#documentation": "

Represents the identifier of a route response.

", - "smithy.api#jsonName": "routeResponseId" + "smithy.api#documentation": "

Represents the response models of a route response.

", + "smithy.api#jsonName": "responseModels" } }, "ModelSelectionExpression": { @@ -6933,6 +7213,14 @@ "smithy.api#jsonName": "modelSelectionExpression" } }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

Represents the route response key of a route response.

", + "smithy.api#jsonName": "routeResponseKey", + "smithy.api#required": {} + } + }, "ResponseParameters": { "target": "com.amazonaws.apigatewayv2#RouteParameters", "traits": { @@ -6940,19 +7228,11 @@ "smithy.api#jsonName": "responseParameters" } }, - "ResponseModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", - "traits": { - "smithy.api#documentation": "

Represents the response models of a route response.

", - "smithy.api#jsonName": "responseModels" - } - }, - "RouteResponseKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "RouteResponseId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

Represents the route response key of a route response.

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

Represents the identifier of a route response.

", + "smithy.api#jsonName": "routeResponseId" } } }, @@ -6963,11 +7243,11 @@ "com.amazonaws.apigatewayv2#RouteSettings": { "type": "structure", "members": { - "DetailedMetricsEnabled": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "ThrottlingBurstLimit": { + "target": "com.amazonaws.apigatewayv2#__integer", "traits": { - "smithy.api#documentation": "

Specifies whether detailed metrics are enabled.

", - "smithy.api#jsonName": "detailedMetricsEnabled" + "smithy.api#documentation": "

Specifies the throttling burst limit.

", + "smithy.api#jsonName": "throttlingBurstLimit" } }, "ThrottlingRateLimit": { @@ -6984,19 +7264,19 @@ "smithy.api#jsonName": "loggingLevel" } }, - "ThrottlingBurstLimit": { - "target": "com.amazonaws.apigatewayv2#__integer", - "traits": { - "smithy.api#documentation": "

Specifies the throttling burst limit.

", - "smithy.api#jsonName": "throttlingBurstLimit" - } - }, "DataTraceEnabled": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { "smithy.api#documentation": "

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

", "smithy.api#jsonName": "dataTraceEnabled" } + }, + "DetailedMetricsEnabled": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether detailed metrics are enabled.

", + "smithy.api#jsonName": "detailedMetricsEnabled" + } } }, "traits": { @@ -7055,6 +7335,13 @@ "com.amazonaws.apigatewayv2#Stage": { "type": "structure", "members": { + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" + } + }, "Description": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { @@ -7062,11 +7349,19 @@ "smithy.api#jsonName": "description" } }, - "ClientCertificateId": { - "target": "com.amazonaws.apigatewayv2#Id", + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "clientCertificateId" + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName", + "smithy.api#required": {} + } + }, + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "traits": { + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" } }, "LastUpdatedDate": { @@ -7076,39 +7371,18 @@ "smithy.api#jsonName": "lastUpdatedDate" } }, - "LastDeploymentStatusMessage": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", - "smithy.api#jsonName": "lastDeploymentStatusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", - "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", - "smithy.api#jsonName": "tags" - } - }, - "DefaultRouteSettings": { - "target": "com.amazonaws.apigatewayv2#RouteSettings", - "traits": { - "smithy.api#documentation": "

Default route settings for the stage.

", - "smithy.api#jsonName": "defaultRouteSettings" - } - }, - "DeploymentId": { - "target": "com.amazonaws.apigatewayv2#Id", + "AccessLogSettings": { + "target": "com.amazonaws.apigatewayv2#AccessLogSettings", "traits": { - "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", - "smithy.api#jsonName": "deploymentId" + "smithy.api#documentation": "

Settings for logging access in this stage.

", + "smithy.api#jsonName": "accessLogSettings" } }, - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", "traits": { - "smithy.api#documentation": "

The timestamp when the stage was created.

", - "smithy.api#jsonName": "createdDate" + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" } }, "ApiGatewayManaged": { @@ -7125,33 +7399,39 @@ "smithy.api#jsonName": "autoDeploy" } }, - "StageVariables": { - "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", - "smithy.api#jsonName": "stageVariables" + "smithy.api#documentation": "

The timestamp when the stage was created.

", + "smithy.api#jsonName": "createdDate" } }, - "StageName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The name of the stage.

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

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", + "smithy.api#jsonName": "lastDeploymentStatusMessage" } }, - "RouteSettings": { - "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", - "smithy.api#jsonName": "routeSettings" + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" } }, - "AccessLogSettings": { - "target": "com.amazonaws.apigatewayv2#AccessLogSettings", + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", "traits": { - "smithy.api#documentation": "

Settings for logging access in this stage.

", - "smithy.api#jsonName": "accessLogSettings" + "smithy.api#documentation": "

Default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "clientCertificateId" } } }, @@ -7268,6 +7548,13 @@ "com.amazonaws.apigatewayv2#TagResourceRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + }, "ResourceArn": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -7275,13 +7562,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", - "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", - "smithy.api#jsonName": "tags" - } } }, "traits": { @@ -7484,14 +7764,6 @@ "com.amazonaws.apigatewayv2#UpdateApiMappingRequest": { "type": "structure", "members": { - "ApiId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#jsonName": "apiId", - "smithy.api#required": {} - } - }, "DomainName": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -7500,13 +7772,6 @@ "smithy.api#required": {} } }, - "Stage": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The API stage.

", - "smithy.api#jsonName": "stage" - } - }, "ApiMappingKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -7514,6 +7779,13 @@ "smithy.api#jsonName": "apiMappingKey" } }, + "Stage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The API stage.

", + "smithy.api#jsonName": "stage" + } + }, "ApiMappingId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -7521,6 +7793,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId", + "smithy.api#required": {} + } } }, "traits": { @@ -7530,6 +7810,13 @@ "com.amazonaws.apigatewayv2#UpdateApiMappingResponse": { "type": "structure", "members": { + "ApiMappingId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The API mapping identifier.

", + "smithy.api#jsonName": "apiMappingId" + } + }, "Stage": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { @@ -7537,13 +7824,6 @@ "smithy.api#jsonName": "stage" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#jsonName": "apiId" - } - }, "ApiMappingKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -7551,11 +7831,11 @@ "smithy.api#jsonName": "apiMappingKey" } }, - "ApiMappingId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The API mapping identifier.

", - "smithy.api#jsonName": "apiMappingId" + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#jsonName": "apiId" } } } @@ -7563,6 +7843,35 @@ "com.amazonaws.apigatewayv2#UpdateApiRequest": { "type": "structure", "members": { + "ApiKeySelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", + "smithy.api#jsonName": "apiKeySelectionExpression" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "target" + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" + } + }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "CorsConfiguration": { "target": "com.amazonaws.apigatewayv2#Cors", "traits": { @@ -7584,13 +7893,6 @@ "smithy.api#jsonName": "version" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The description of the API.

", - "smithy.api#jsonName": "description" - } - }, "RouteKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -7598,27 +7900,6 @@ "smithy.api#jsonName": "routeKey" } }, - "Target": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", - "traits": { - "smithy.api#documentation": "

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "target" - } - }, - "RouteSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", - "smithy.api#jsonName": "routeSelectionExpression" - } - }, - "ApiKeySelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

", - "smithy.api#jsonName": "apiKeySelectionExpression" - } - }, "Name": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { @@ -7633,12 +7914,18 @@ "smithy.api#jsonName": "disableSchemaValidation" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The API identifier.

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

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" + } + }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" } } }, @@ -7649,13 +7936,6 @@ "com.amazonaws.apigatewayv2#UpdateApiResponse": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The description of the API.

", - "smithy.api#jsonName": "description" - } - }, "ApiKeySelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -7663,46 +7943,53 @@ "smithy.api#jsonName": "apiKeySelectionExpression" } }, - "ImportInfo": { - "target": "com.amazonaws.apigatewayv2#__listOf__string", + "RouteSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "importInfo" + "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", + "smithy.api#jsonName": "routeSelectionExpression" } }, - "DisableSchemaValidation": { + "ApiGatewayManaged": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "disableSchemaValidation" + "smithy.api#documentation": "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "ApiEndpoint": { - "target": "com.amazonaws.apigatewayv2#__string", + "DisableExecuteApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", - "smithy.api#jsonName": "apiEndpoint" + "smithy.api#documentation": "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", + "smithy.api#jsonName": "disableExecuteApiEndpoint" } }, - "ProtocolType": { - "target": "com.amazonaws.apigatewayv2#ProtocolType", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The API protocol.

", - "smithy.api#jsonName": "protocolType" + "smithy.api#documentation": "

The description of the API.

", + "smithy.api#jsonName": "description" } }, - "RouteSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

", - "smithy.api#jsonName": "routeSelectionExpression" + "smithy.api#documentation": "

The timestamp when the API was created.

", + "smithy.api#jsonName": "createdDate" } }, - "CorsConfiguration": { - "target": "com.amazonaws.apigatewayv2#Cors", + "Version": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "corsConfiguration" + "smithy.api#documentation": "

A version identifier for the API.

", + "smithy.api#jsonName": "version" + } + }, + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", + "traits": { + "smithy.api#documentation": "

A collection of tags associated with the API.

", + "smithy.api#jsonName": "tags" } }, "Warnings": { @@ -7712,13 +7999,6 @@ "smithy.api#jsonName": "warnings" } }, - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The name of the API.

", - "smithy.api#jsonName": "name" - } - }, "ApiId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -7726,25 +8006,46 @@ "smithy.api#jsonName": "apiId" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", + "ProtocolType": { + "target": "com.amazonaws.apigatewayv2#ProtocolType", "traits": { - "smithy.api#documentation": "

A collection of tags associated with the API.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The API protocol.

", + "smithy.api#jsonName": "protocolType" } }, - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "CorsConfiguration": { + "target": "com.amazonaws.apigatewayv2#Cors", "traits": { - "smithy.api#documentation": "

The timestamp when the API was created.

", - "smithy.api#jsonName": "createdDate" + "smithy.api#documentation": "

A CORS configuration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "corsConfiguration" } }, - "Version": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

A version identifier for the API.

", - "smithy.api#jsonName": "version" + "smithy.api#documentation": "

The name of the API.

", + "smithy.api#jsonName": "name" + } + }, + "ApiEndpoint": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

", + "smithy.api#jsonName": "apiEndpoint" + } + }, + "DisableSchemaValidation": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "disableSchemaValidation" + } + }, + "ImportInfo": { + "target": "com.amazonaws.apigatewayv2#__listOf__string", + "traits": { + "smithy.api#documentation": "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "importInfo" } } } @@ -7783,31 +8084,10 @@ "com.amazonaws.apigatewayv2#UpdateAuthorizerRequest": { "type": "structure", "members": { - "IdentitySource": { - "target": "com.amazonaws.apigatewayv2#IdentitySourceList", - "traits": { - "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example \"$request.header.Authorization\".

", - "smithy.api#jsonName": "identitySource" - } - }, - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The name of the authorizer.

", - "smithy.api#jsonName": "name" - } - }, - "JwtConfiguration": { - "target": "com.amazonaws.apigatewayv2#JWTConfiguration", - "traits": { - "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "jwtConfiguration" - } - }, "AuthorizerType": { "target": "com.amazonaws.apigatewayv2#AuthorizerType", "traits": { - "smithy.api#documentation": "

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

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

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", "smithy.api#jsonName": "authorizerType" } }, @@ -7819,18 +8099,11 @@ "smithy.api#required": {} } }, - "IdentityValidationExpression": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

This parameter is not used.

", - "smithy.api#jsonName": "identityValidationExpression" - } - }, - "AuthorizerCredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", + "IdentitySource": { + "target": "com.amazonaws.apigatewayv2#IdentitySourceList", "traits": { - "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

", - "smithy.api#jsonName": "authorizerCredentialsArn" + "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", + "smithy.api#jsonName": "identitySource" } }, "AuthorizerId": { @@ -7844,16 +8117,58 @@ "AuthorizerResultTtlInSeconds": { "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", "traits": { - "smithy.api#documentation": "

Authorizer caching is not currently supported. Don't specify this value for authorizers.

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

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", "smithy.api#jsonName": "authorizerResultTtlInSeconds" } }, + "JwtConfiguration": { + "target": "com.amazonaws.apigatewayv2#JWTConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "jwtConfiguration" + } + }, + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.

", + "smithy.api#jsonName": "authorizerCredentialsArn" + } + }, "AuthorizerUri": { "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", "smithy.api#jsonName": "authorizerUri" } + }, + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "traits": { + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "IdentityValidationExpression": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

This parameter is not used.

", + "smithy.api#jsonName": "identityValidationExpression" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the authorizer.

", + "smithy.api#jsonName": "name" + } + }, + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } } }, "traits": { @@ -7863,18 +8178,25 @@ "com.amazonaws.apigatewayv2#UpdateAuthorizerResponse": { "type": "structure", "members": { + "EnableSimpleResponses": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "smithy.api#jsonName": "enableSimpleResponses" + } + }, "IdentitySource": { "target": "com.amazonaws.apigatewayv2#IdentitySourceList", "traits": { - "smithy.api#documentation": "

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example \"$request.header.Authorization\".

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

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

", "smithy.api#jsonName": "identitySource" } }, - "AuthorizerUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "AuthorizerType": { + "target": "com.amazonaws.apigatewayv2#AuthorizerType", "traits": { - "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", - "smithy.api#jsonName": "authorizerUri" + "smithy.api#documentation": "

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

", + "smithy.api#jsonName": "authorizerType" } }, "Name": { @@ -7891,25 +8213,25 @@ "smithy.api#jsonName": "identityValidationExpression" } }, - "AuthorizerCredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.

", - "smithy.api#jsonName": "authorizerCredentialsArn" + "smithy.api#documentation": "

The authorizer identifier.

", + "smithy.api#jsonName": "authorizerId" } }, - "AuthorizerResultTtlInSeconds": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", + "AuthorizerUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

Authorizer caching is not currently supported. Don't specify this value for authorizers.

", - "smithy.api#jsonName": "authorizerResultTtlInSeconds" + "smithy.api#documentation": "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerUri" } }, - "AuthorizerId": { - "target": "com.amazonaws.apigatewayv2#Id", + "AuthorizerResultTtlInSeconds": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween0And3600", "traits": { - "smithy.api#documentation": "

The authorizer identifier.

", - "smithy.api#jsonName": "authorizerId" + "smithy.api#documentation": "

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

", + "smithy.api#jsonName": "authorizerResultTtlInSeconds" } }, "JwtConfiguration": { @@ -7919,11 +8241,18 @@ "smithy.api#jsonName": "jwtConfiguration" } }, - "AuthorizerType": { - "target": "com.amazonaws.apigatewayv2#AuthorizerType", + "AuthorizerPayloadFormatVersion": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

", - "smithy.api#jsonName": "authorizerType" + "smithy.api#documentation": "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", + "smithy.api#jsonName": "authorizerPayloadFormatVersion" + } + }, + "AuthorizerCredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

", + "smithy.api#jsonName": "authorizerCredentialsArn" } } } @@ -7962,18 +8291,18 @@ "com.amazonaws.apigatewayv2#UpdateDeploymentRequest": { "type": "structure", "members": { - "DeploymentId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The deployment ID.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApiId": { + "DeploymentId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The deployment ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7993,13 +8322,6 @@ "com.amazonaws.apigatewayv2#UpdateDeploymentResponse": { "type": "structure", "members": { - "DeploymentId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The identifier for the deployment.

", - "smithy.api#jsonName": "deploymentId" - } - }, "Description": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { @@ -8007,6 +8329,13 @@ "smithy.api#jsonName": "description" } }, + "DeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", + "smithy.api#jsonName": "deploymentStatusMessage" + } + }, "DeploymentStatus": { "target": "com.amazonaws.apigatewayv2#DeploymentStatus", "traits": { @@ -8014,6 +8343,13 @@ "smithy.api#jsonName": "deploymentStatus" } }, + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier for the deployment.

", + "smithy.api#jsonName": "deploymentId" + } + }, "AutoDeployed": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -8027,13 +8363,6 @@ "smithy.api#documentation": "

The date and time when the Deployment resource was created.

", "smithy.api#jsonName": "createdDate" } - }, - "DeploymentStatusMessage": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

May contain additional feedback on the status of an API deployment.

", - "smithy.api#jsonName": "deploymentStatusMessage" - } } } }, @@ -8071,6 +8400,13 @@ "com.amazonaws.apigatewayv2#UpdateDomainNameRequest": { "type": "structure", "members": { + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthenticationInput", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + }, "DomainNameConfigurations": { "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", "traits": { @@ -8094,13 +8430,6 @@ "com.amazonaws.apigatewayv2#UpdateDomainNameResponse": { "type": "structure", "members": { - "DomainNameConfigurations": { - "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", - "traits": { - "smithy.api#documentation": "

The domain name configurations.

", - "smithy.api#jsonName": "domainNameConfigurations" - } - }, "Tags": { "target": "com.amazonaws.apigatewayv2#Tags", "traits": { @@ -8108,6 +8437,20 @@ "smithy.api#jsonName": "tags" } }, + "MutualTlsAuthentication": { + "target": "com.amazonaws.apigatewayv2#MutualTlsAuthentication", + "traits": { + "smithy.api#documentation": "

The mutual TLS authentication configuration for a custom domain name.

", + "smithy.api#jsonName": "mutualTlsAuthentication" + } + }, + "DomainNameConfigurations": { + "target": "com.amazonaws.apigatewayv2#DomainNameConfigurations", + "traits": { + "smithy.api#documentation": "

The domain name configurations.

", + "smithy.api#jsonName": "domainNameConfigurations" + } + }, "ApiMappingSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -8158,11 +8501,11 @@ "com.amazonaws.apigatewayv2#UpdateIntegrationRequest": { "type": "structure", "members": { - "PayloadFormatVersion": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "TimeoutInMillis": { + "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", "traits": { - "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", - "smithy.api#jsonName": "payloadFormatVersion" + "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", + "smithy.api#jsonName": "timeoutInMillis" } }, "TlsConfig": { @@ -8172,11 +8515,11 @@ "smithy.api#jsonName": "tlsConfig" } }, - "TimeoutInMillis": { - "target": "com.amazonaws.apigatewayv2#IntegerWithLengthBetween50And30000", + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

", - "smithy.api#jsonName": "timeoutInMillis" + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" } }, "Description": { @@ -8186,41 +8529,53 @@ "smithy.api#jsonName": "description" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", "traits": { - "smithy.api#documentation": "

The API identifier.

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

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" } }, "IntegrationType": { "target": "com.amazonaws.apigatewayv2#IntegrationType", "traits": { - "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

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

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", "smithy.api#jsonName": "integrationType" } }, - "CredentialsArn": { - "target": "com.amazonaws.apigatewayv2#Arn", + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", - "smithy.api#jsonName": "credentialsArn" + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" } }, - "IntegrationId": { - "target": "com.amazonaws.apigatewayv2#__string", + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { - "smithy.api#documentation": "

The integration ID.

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" } }, - "ConnectionType": { - "target": "com.amazonaws.apigatewayv2#ConnectionType", + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", "traits": { - "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", - "smithy.api#jsonName": "connectionType" + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" + } + }, + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

", + "smithy.api#jsonName": "requestParameters" } }, "ContentHandlingStrategy": { @@ -8230,6 +8585,14 @@ "smithy.api#jsonName": "contentHandlingStrategy" } }, + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "TemplateSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -8237,46 +8600,33 @@ "smithy.api#jsonName": "templateSelectionExpression" } }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", - "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" - } - }, - "IntegrationUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", - "traits": { - "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", - "smithy.api#jsonName": "integrationUri" - } - }, - "IntegrationMethod": { + "PayloadFormatVersion": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", - "smithy.api#jsonName": "integrationMethod" + "smithy.api#documentation": "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "smithy.api#jsonName": "payloadFormatVersion" } }, - "PassthroughBehavior": { - "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "CredentialsArn": { + "target": "com.amazonaws.apigatewayv2#Arn", "traits": { - "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", - "smithy.api#jsonName": "passthroughBehavior" + "smithy.api#documentation": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

", + "smithy.api#jsonName": "credentialsArn" } }, - "RequestTemplates": { - "target": "com.amazonaws.apigatewayv2#TemplateMap", + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestTemplates" + "smithy.api#documentation": "

The integration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ConnectionId": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "ConnectionType": { + "target": "com.amazonaws.apigatewayv2#ConnectionType", "traits": { - "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "connectionId" + "smithy.api#documentation": "

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

", + "smithy.api#jsonName": "connectionType" } } }, @@ -8318,11 +8668,18 @@ "com.amazonaws.apigatewayv2#UpdateIntegrationResponseRequest": { "type": "structure", "members": { - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name}\n or integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.

", - "smithy.api#jsonName": "responseParameters" + "smithy.api#documentation": "

The template selection expression for the integration response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, + "IntegrationResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The integration response key.

", + "smithy.api#jsonName": "integrationResponseKey" } }, "ResponseTemplates": { @@ -8332,17 +8689,17 @@ "smithy.api#jsonName": "responseTemplates" } }, - "TemplateSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { - "smithy.api#documentation": "

The template selection expression for the integration response. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "templateSelectionExpression" + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name}\n or integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" } }, - "ApiId": { + "IntegrationId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The API identifier.

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

The integration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8362,20 +8719,13 @@ "smithy.api#jsonName": "contentHandlingStrategy" } }, - "IntegrationId": { + "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The integration ID.

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

The API identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "IntegrationResponseKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", - "traits": { - "smithy.api#documentation": "

The integration response key.

", - "smithy.api#jsonName": "integrationResponseKey" - } } }, "traits": { @@ -8385,20 +8735,6 @@ "com.amazonaws.apigatewayv2#UpdateIntegrationResponseResponse": { "type": "structure", "members": { - "TemplateSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

The template selection expressions for the integration response.

", - "smithy.api#jsonName": "templateSelectionExpression" - } - }, - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", - "traits": { - "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", - "smithy.api#jsonName": "responseParameters" - } - }, "IntegrationResponseKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -8406,6 +8742,13 @@ "smithy.api#jsonName": "integrationResponseKey" } }, + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "traits": { + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" + } + }, "ResponseTemplates": { "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { @@ -8413,6 +8756,13 @@ "smithy.api#jsonName": "responseTemplates" } }, + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

The template selection expressions for the integration response.

", + "smithy.api#jsonName": "templateSelectionExpression" + } + }, "IntegrationResponseId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -8420,11 +8770,11 @@ "smithy.api#jsonName": "integrationResponseId" } }, - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", "traits": { - "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

", + "smithy.api#jsonName": "responseParameters" } } } @@ -8432,18 +8782,25 @@ "com.amazonaws.apigatewayv2#UpdateIntegrationResult": { "type": "structure", "members": { - "ContentHandlingStrategy": { - "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", + "IntegrationResponseSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", - "smithy.api#jsonName": "contentHandlingStrategy" + "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", + "smithy.api#jsonName": "integrationResponseSelectionExpression" } }, - "ApiGatewayManaged": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "IntegrationSubtype": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", - "smithy.api#jsonName": "apiGatewayManaged" + "smithy.api#documentation": "

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

", + "smithy.api#jsonName": "integrationSubtype" + } + }, + "IntegrationUri": { + "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "traits": { + "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", + "smithy.api#jsonName": "integrationUri" } }, "CredentialsArn": { @@ -8453,46 +8810,60 @@ "smithy.api#jsonName": "credentialsArn" } }, - "IntegrationResponseSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "RequestTemplates": { + "target": "com.amazonaws.apigatewayv2#TemplateMap", "traits": { - "smithy.api#documentation": "

The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

", - "smithy.api#jsonName": "integrationResponseSelectionExpression" + "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestTemplates" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "IntegrationId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

Represents the description of an integration.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

Represents the identifier of an integration.

", + "smithy.api#jsonName": "integrationId" } }, - "RequestTemplates": { - "target": "com.amazonaws.apigatewayv2#TemplateMap", + "ConnectionId": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", "traits": { - "smithy.api#documentation": "

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestTemplates" + "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", + "smithy.api#jsonName": "connectionId" } }, - "IntegrationType": { - "target": "com.amazonaws.apigatewayv2#IntegrationType", + "TemplateSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "integrationType" + "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "templateSelectionExpression" } }, - "IntegrationUri": { - "target": "com.amazonaws.apigatewayv2#UriWithLengthBetween1And2048", + "ApiGatewayManaged": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", - "smithy.api#jsonName": "integrationUri" + "smithy.api#documentation": "

Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "ConnectionId": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And1024", + "IntegrationMethod": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

", - "smithy.api#jsonName": "connectionId" + "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", + "smithy.api#jsonName": "integrationMethod" + } + }, + "PassthroughBehavior": { + "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", + "traits": { + "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", + "smithy.api#jsonName": "passthroughBehavior" + } + }, + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "traits": { + "smithy.api#documentation": "

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

", + "smithy.api#jsonName": "requestParameters" } }, "TlsConfig": { @@ -8516,20 +8887,6 @@ "smithy.api#jsonName": "payloadFormatVersion" } }, - "PassthroughBehavior": { - "target": "com.amazonaws.apigatewayv2#PassthroughBehavior", - "traits": { - "smithy.api#documentation": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

", - "smithy.api#jsonName": "passthroughBehavior" - } - }, - "IntegrationMethod": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", - "traits": { - "smithy.api#documentation": "

Specifies the integration's HTTP method type.

", - "smithy.api#jsonName": "integrationMethod" - } - }, "ConnectionType": { "target": "com.amazonaws.apigatewayv2#ConnectionType", "traits": { @@ -8537,25 +8894,25 @@ "smithy.api#jsonName": "connectionType" } }, - "TemplateSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The template selection expression for the integration. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "templateSelectionExpression" + "smithy.api#documentation": "

Represents the description of an integration.

", + "smithy.api#jsonName": "description" } }, - "IntegrationId": { - "target": "com.amazonaws.apigatewayv2#Id", + "IntegrationType": { + "target": "com.amazonaws.apigatewayv2#IntegrationType", "traits": { - "smithy.api#documentation": "

Represents the identifier of an integration.

", - "smithy.api#jsonName": "integrationId" + "smithy.api#documentation": "

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "integrationType" } }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#IntegrationParameters", + "ContentHandlingStrategy": { + "target": "com.amazonaws.apigatewayv2#ContentHandlingStrategy", "traits": { - "smithy.api#documentation": "

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

", + "smithy.api#jsonName": "contentHandlingStrategy" } } } @@ -8602,6 +8959,13 @@ "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" + } + }, "ModelId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -8610,13 +8974,6 @@ "smithy.api#required": {} } }, - "Schema": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", - "traits": { - "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", - "smithy.api#jsonName": "schema" - } - }, "Name": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { @@ -8624,19 +8981,19 @@ "smithy.api#jsonName": "name" } }, + "Schema": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", + "traits": { + "smithy.api#documentation": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

", + "smithy.api#jsonName": "schema" + } + }, "ContentType": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", "traits": { "smithy.api#documentation": "

The content-type for the model, for example, \"application/json\".

", "smithy.api#jsonName": "contentType" } - }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The description of the model.

", - "smithy.api#jsonName": "description" - } } }, "traits": { @@ -8646,6 +9003,20 @@ "com.amazonaws.apigatewayv2#UpdateModelResponse": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", + "smithy.api#jsonName": "name" + } + }, + "ModelId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#jsonName": "modelId" + } + }, "Schema": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And32K", "traits": { @@ -8653,13 +9024,6 @@ "smithy.api#jsonName": "schema" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

The description of the model.

", - "smithy.api#jsonName": "description" - } - }, "ContentType": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And256", "traits": { @@ -8667,18 +9031,11 @@ "smithy.api#jsonName": "contentType" } }, - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The name of the model. Must be alphanumeric.

", - "smithy.api#jsonName": "name" - } - }, - "ModelId": { - "target": "com.amazonaws.apigatewayv2#Id", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The model identifier.

", - "smithy.api#jsonName": "modelId" + "smithy.api#documentation": "

The description of the model.

", + "smithy.api#jsonName": "description" } } } @@ -8717,13 +9074,6 @@ "com.amazonaws.apigatewayv2#UpdateRouteRequest": { "type": "structure", "members": { - "RequestModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", - "traits": { - "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestModels" - } - }, "RequestParameters": { "target": "com.amazonaws.apigatewayv2#RouteParameters", "traits": { @@ -8734,16 +9084,36 @@ "AuthorizationType": { "target": "com.amazonaws.apigatewayv2#AuthorizationType", "traits": { - "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

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

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", "smithy.api#jsonName": "authorizationType" } }, - "RouteId": { - "target": "com.amazonaws.apigatewayv2#__string", + "OperationName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The route ID.

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

The operation name for the route.

", + "smithy.api#jsonName": "operationName" + } + }, + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" + } + }, + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "traits": { + "smithy.api#documentation": "

The authorization scopes supported by this route.

", + "smithy.api#jsonName": "authorizationScopes" + } + }, + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" } }, "AuthorizerId": { @@ -8753,14 +9123,6 @@ "smithy.api#jsonName": "authorizerId" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The API identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "RouteResponseSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -8768,13 +9130,6 @@ "smithy.api#jsonName": "routeResponseSelectionExpression" } }, - "Target": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", - "traits": { - "smithy.api#documentation": "

The target for the route.

", - "smithy.api#jsonName": "target" - } - }, "ModelSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -8782,32 +9137,34 @@ "smithy.api#jsonName": "modelSelectionExpression" } }, - "AuthorizationScopes": { - "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The authorization scopes supported by this route.

", - "smithy.api#jsonName": "authorizationScopes" + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ApiKeyRequired": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "apiKeyRequired" + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "RouteKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The route key for the route.

", - "smithy.api#jsonName": "routeKey" + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" } }, - "OperationName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { - "smithy.api#documentation": "

The operation name for the route.

", - "smithy.api#jsonName": "operationName" + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" } } }, @@ -8849,6 +9206,14 @@ "com.amazonaws.apigatewayv2#UpdateRouteResponseRequest": { "type": "structure", "members": { + "RouteId": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

The route ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ModelSelectionExpression": { "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { @@ -8856,21 +9221,28 @@ "smithy.api#jsonName": "modelSelectionExpression" } }, - "RouteResponseKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "ResponseModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", "traits": { - "smithy.api#documentation": "

The route response key.

", - "smithy.api#jsonName": "routeResponseKey" + "smithy.api#documentation": "

The response models for the route response.

", + "smithy.api#jsonName": "responseModels" } }, - "RouteId": { + "RouteResponseId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The route ID.

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

The route response ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "RouteResponseKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", + "traits": { + "smithy.api#documentation": "

The route response key.

", + "smithy.api#jsonName": "routeResponseKey" + } + }, "ApiId": { "target": "com.amazonaws.apigatewayv2#__string", "traits": { @@ -8879,27 +9251,12 @@ "smithy.api#required": {} } }, - "ResponseModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", - "traits": { - "smithy.api#documentation": "

The response models for the route response.

", - "smithy.api#jsonName": "responseModels" - } - }, "ResponseParameters": { "target": "com.amazonaws.apigatewayv2#RouteParameters", "traits": { "smithy.api#documentation": "

The route response parameters.

", "smithy.api#jsonName": "responseParameters" } - }, - "RouteResponseId": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The route response ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -8916,20 +9273,6 @@ "smithy.api#jsonName": "responseModels" } }, - "ModelSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "modelSelectionExpression" - } - }, - "ResponseParameters": { - "target": "com.amazonaws.apigatewayv2#RouteParameters", - "traits": { - "smithy.api#documentation": "

Represents the response parameters of a route response.

", - "smithy.api#jsonName": "responseParameters" - } - }, "RouteResponseKey": { "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { @@ -8937,65 +9280,72 @@ "smithy.api#jsonName": "routeResponseKey" } }, + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", + "traits": { + "smithy.api#documentation": "

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" + } + }, "RouteResponseId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { "smithy.api#documentation": "

Represents the identifier of a route response.

", "smithy.api#jsonName": "routeResponseId" } + }, + "ResponseParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", + "traits": { + "smithy.api#documentation": "

Represents the response parameters of a route response.

", + "smithy.api#jsonName": "responseParameters" + } } } }, "com.amazonaws.apigatewayv2#UpdateRouteResult": { "type": "structure", "members": { - "AuthorizationType": { - "target": "com.amazonaws.apigatewayv2#AuthorizationType", + "AuthorizationScopes": { + "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", "traits": { - "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

", - "smithy.api#jsonName": "authorizationType" + "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "smithy.api#jsonName": "authorizationScopes" } }, - "ApiKeyRequired": { + "ApiGatewayManaged": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "apiKeyRequired" - } - }, - "RequestParameters": { - "target": "com.amazonaws.apigatewayv2#RouteParameters", - "traits": { - "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestParameters" + "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", + "smithy.api#jsonName": "apiGatewayManaged" } }, - "RequestModels": { - "target": "com.amazonaws.apigatewayv2#RouteModels", + "ModelSelectionExpression": { + "target": "com.amazonaws.apigatewayv2#SelectionExpression", "traits": { - "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "requestModels" + "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "modelSelectionExpression" } }, - "Target": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "AuthorizationType": { + "target": "com.amazonaws.apigatewayv2#AuthorizationType", "traits": { - "smithy.api#documentation": "

The target for the route.

", - "smithy.api#jsonName": "target" + "smithy.api#documentation": "

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

", + "smithy.api#jsonName": "authorizationType" } }, - "AuthorizerId": { - "target": "com.amazonaws.apigatewayv2#Id", + "ApiKeyRequired": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", - "smithy.api#jsonName": "authorizerId" + "smithy.api#documentation": "

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "apiKeyRequired" } }, - "RouteId": { - "target": "com.amazonaws.apigatewayv2#Id", + "RouteKey": { + "target": "com.amazonaws.apigatewayv2#SelectionKey", "traits": { - "smithy.api#documentation": "

The route ID.

", - "smithy.api#jsonName": "routeId" + "smithy.api#documentation": "

The route key for the route.

", + "smithy.api#jsonName": "routeKey" } }, "RouteResponseSelectionExpression": { @@ -9005,13 +9355,6 @@ "smithy.api#jsonName": "routeResponseSelectionExpression" } }, - "ModelSelectionExpression": { - "target": "com.amazonaws.apigatewayv2#SelectionExpression", - "traits": { - "smithy.api#documentation": "

The model selection expression for the route. Supported only for WebSocket APIs.

", - "smithy.api#jsonName": "modelSelectionExpression" - } - }, "OperationName": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64", "traits": { @@ -9019,25 +9362,39 @@ "smithy.api#jsonName": "operationName" } }, - "RouteKey": { - "target": "com.amazonaws.apigatewayv2#SelectionKey", + "RequestParameters": { + "target": "com.amazonaws.apigatewayv2#RouteParameters", "traits": { - "smithy.api#documentation": "

The route key for the route.

", - "smithy.api#jsonName": "routeKey" + "smithy.api#documentation": "

The request parameters for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestParameters" } }, - "ApiGatewayManaged": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "RouteId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

", - "smithy.api#jsonName": "apiGatewayManaged" + "smithy.api#documentation": "

The route ID.

", + "smithy.api#jsonName": "routeId" } }, - "AuthorizationScopes": { - "target": "com.amazonaws.apigatewayv2#AuthorizationScopes", + "RequestModels": { + "target": "com.amazonaws.apigatewayv2#RouteModels", + "traits": { + "smithy.api#documentation": "

The request models for the route. Supported only for WebSocket APIs.

", + "smithy.api#jsonName": "requestModels" + } + }, + "AuthorizerId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

", + "smithy.api#jsonName": "authorizerId" + } + }, + "Target": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", - "smithy.api#jsonName": "authorizationScopes" + "smithy.api#documentation": "

The target for the route.

", + "smithy.api#jsonName": "target" } } } @@ -9076,11 +9433,11 @@ "com.amazonaws.apigatewayv2#UpdateStageRequest": { "type": "structure", "members": { - "ClientCertificateId": { - "target": "com.amazonaws.apigatewayv2#Id", + "DefaultRouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettings", "traits": { - "smithy.api#documentation": "

The identifier of a client certificate for a Stage.

", - "smithy.api#jsonName": "clientCertificateId" + "smithy.api#documentation": "

The default route settings for the stage.

", + "smithy.api#jsonName": "defaultRouteSettings" } }, "RouteSettings": { @@ -9097,18 +9454,20 @@ "smithy.api#jsonName": "accessLogSettings" } }, - "AutoDeploy": { - "target": "com.amazonaws.apigatewayv2#__boolean", + "ApiId": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", - "smithy.api#jsonName": "autoDeploy" + "smithy.api#documentation": "

The API identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "StageName": { + "target": "com.amazonaws.apigatewayv2#__string", "traits": { - "smithy.api#documentation": "

The description for the API stage.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "StageVariables": { @@ -9118,19 +9477,11 @@ "smithy.api#jsonName": "stageVariables" } }, - "StageName": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DefaultRouteSettings": { - "target": "com.amazonaws.apigatewayv2#RouteSettings", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The default route settings for the stage.

", - "smithy.api#jsonName": "defaultRouteSettings" + "smithy.api#documentation": "

The description for the API stage.

", + "smithy.api#jsonName": "description" } }, "DeploymentId": { @@ -9140,12 +9491,18 @@ "smithy.api#jsonName": "deploymentId" } }, - "ApiId": { - "target": "com.amazonaws.apigatewayv2#__string", + "AutoDeploy": { + "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { - "smithy.api#documentation": "

The API identifier.

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

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

", + "smithy.api#jsonName": "autoDeploy" + } + }, + "ClientCertificateId": { + "target": "com.amazonaws.apigatewayv2#Id", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a Stage.

", + "smithy.api#jsonName": "clientCertificateId" } } }, @@ -9163,13 +9520,6 @@ "smithy.api#jsonName": "apiGatewayManaged" } }, - "RouteSettings": { - "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", - "traits": { - "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", - "smithy.api#jsonName": "routeSettings" - } - }, "AutoDeploy": { "target": "com.amazonaws.apigatewayv2#__boolean", "traits": { @@ -9177,25 +9527,32 @@ "smithy.api#jsonName": "autoDeploy" } }, - "DeploymentId": { - "target": "com.amazonaws.apigatewayv2#Id", + "StageVariables": { + "target": "com.amazonaws.apigatewayv2#StageVariablesMap", "traits": { - "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", - "smithy.api#jsonName": "deploymentId" + "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", + "smithy.api#jsonName": "stageVariables" } }, - "CreatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "Description": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The timestamp when the stage was created.

", - "smithy.api#jsonName": "createdDate" + "smithy.api#documentation": "

The description of the stage.

", + "smithy.api#jsonName": "description" } }, - "LastUpdatedDate": { - "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "StageName": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { - "smithy.api#documentation": "

The timestamp when the stage was last updated.

", - "smithy.api#jsonName": "lastUpdatedDate" + "smithy.api#documentation": "

The name of the stage.

", + "smithy.api#jsonName": "stageName" + } + }, + "RouteSettings": { + "target": "com.amazonaws.apigatewayv2#RouteSettingsMap", + "traits": { + "smithy.api#documentation": "

Route settings for the stage, by routeKey.

", + "smithy.api#jsonName": "routeSettings" } }, "AccessLogSettings": { @@ -9205,20 +9562,6 @@ "smithy.api#jsonName": "accessLogSettings" } }, - "LastDeploymentStatusMessage": { - "target": "com.amazonaws.apigatewayv2#__string", - "traits": { - "smithy.api#documentation": "

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", - "smithy.api#jsonName": "lastDeploymentStatusMessage" - } - }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", - "traits": { - "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", - "smithy.api#jsonName": "tags" - } - }, "DefaultRouteSettings": { "target": "com.amazonaws.apigatewayv2#RouteSettings", "traits": { @@ -9233,25 +9576,39 @@ "smithy.api#jsonName": "clientCertificateId" } }, - "Description": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "DeploymentId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

The description of the stage.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

", + "smithy.api#jsonName": "deploymentId" } }, - "StageVariables": { - "target": "com.amazonaws.apigatewayv2#StageVariablesMap", + "LastUpdatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

", - "smithy.api#jsonName": "stageVariables" + "smithy.api#documentation": "

The timestamp when the stage was last updated.

", + "smithy.api#jsonName": "lastUpdatedDate" } }, - "StageName": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

The name of the stage.

", - "smithy.api#jsonName": "stageName" + "smithy.api#documentation": "

The collection of tags. Each tag element is associated with a given resource.

", + "smithy.api#jsonName": "tags" + } + }, + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.apigatewayv2#__string", + "traits": { + "smithy.api#documentation": "

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

", + "smithy.api#jsonName": "lastDeploymentStatusMessage" + } + }, + "CreatedDate": { + "target": "com.amazonaws.apigatewayv2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The timestamp when the stage was created.

", + "smithy.api#jsonName": "createdDate" } } } @@ -9310,11 +9667,18 @@ "com.amazonaws.apigatewayv2#UpdateVpcLinkResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "Tags": { + "target": "com.amazonaws.apigatewayv2#Tags", "traits": { - "smithy.api#documentation": "

The name of the VPC link.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

Tags for the VPC link.

", + "smithy.api#jsonName": "tags" + } + }, + "SubnetIds": { + "target": "com.amazonaws.apigatewayv2#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

", + "smithy.api#jsonName": "subnetIds" } }, "VpcLinkVersion": { @@ -9324,13 +9688,6 @@ "smithy.api#jsonName": "vpcLinkVersion" } }, - "VpcLinkStatusMessage": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", - "traits": { - "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", - "smithy.api#jsonName": "vpcLinkStatusMessage" - } - }, "CreatedDate": { "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { @@ -9338,13 +9695,6 @@ "smithy.api#jsonName": "createdDate" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", - "smithy.api#jsonName": "securityGroupIds" - } - }, "VpcLinkStatus": { "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", "traits": { @@ -9352,13 +9702,6 @@ "smithy.api#jsonName": "vpcLinkStatus" } }, - "Tags": { - "target": "com.amazonaws.apigatewayv2#Tags", - "traits": { - "smithy.api#documentation": "

Tags for the VPC link.

", - "smithy.api#jsonName": "tags" - } - }, "VpcLinkId": { "target": "com.amazonaws.apigatewayv2#Id", "traits": { @@ -9366,11 +9709,25 @@ "smithy.api#jsonName": "vpcLinkId" } }, - "SubnetIds": { - "target": "com.amazonaws.apigatewayv2#SubnetIdList", + "SecurityGroupIds": { + "target": "com.amazonaws.apigatewayv2#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of subnet IDs to include in the VPC link.

", - "smithy.api#jsonName": "subnetIds" + "smithy.api#documentation": "

A list of security group IDs for the VPC link.

", + "smithy.api#jsonName": "securityGroupIds" + } + }, + "Name": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", + "traits": { + "smithy.api#documentation": "

The name of the VPC link.

", + "smithy.api#jsonName": "name" + } + }, + "VpcLinkStatusMessage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "traits": { + "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatusMessage" } } } @@ -9384,19 +9741,11 @@ "com.amazonaws.apigatewayv2#VpcLink": { "type": "structure", "members": { - "VpcLinkId": { - "target": "com.amazonaws.apigatewayv2#Id", - "traits": { - "smithy.api#documentation": "

The ID of the VPC link.

", - "smithy.api#jsonName": "vpcLinkId", - "smithy.api#required": {} - } - }, - "VpcLinkStatus": { - "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", + "VpcLinkStatusMessage": { + "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", "traits": { - "smithy.api#documentation": "

The status of the VPC link.

", - "smithy.api#jsonName": "vpcLinkStatus" + "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatusMessage" } }, "SecurityGroupIds": { @@ -9415,6 +9764,13 @@ "smithy.api#required": {} } }, + "VpcLinkVersion": { + "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", + "traits": { + "smithy.api#documentation": "

The version of the VPC link.

", + "smithy.api#jsonName": "vpcLinkVersion" + } + }, "Name": { "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And128", "traits": { @@ -9423,11 +9779,12 @@ "smithy.api#required": {} } }, - "VpcLinkStatusMessage": { - "target": "com.amazonaws.apigatewayv2#StringWithLengthBetween0And1024", + "VpcLinkId": { + "target": "com.amazonaws.apigatewayv2#Id", "traits": { - "smithy.api#documentation": "

A message summarizing the cause of the status of the VPC link.

", - "smithy.api#jsonName": "vpcLinkStatusMessage" + "smithy.api#documentation": "

The ID of the VPC link.

", + "smithy.api#jsonName": "vpcLinkId", + "smithy.api#required": {} } }, "Tags": { @@ -9437,19 +9794,19 @@ "smithy.api#jsonName": "tags" } }, - "VpcLinkVersion": { - "target": "com.amazonaws.apigatewayv2#VpcLinkVersion", - "traits": { - "smithy.api#documentation": "

The version of the VPC link.

", - "smithy.api#jsonName": "vpcLinkVersion" - } - }, "CreatedDate": { "target": "com.amazonaws.apigatewayv2#__timestampIso8601", "traits": { "smithy.api#documentation": "

The timestamp when the VPC link was created.

", "smithy.api#jsonName": "createdDate" } + }, + "VpcLinkStatus": { + "target": "com.amazonaws.apigatewayv2#VpcLinkStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC link.

", + "smithy.api#jsonName": "vpcLinkStatus" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json b/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json index 5d2c24c20b70..79f4c182daee 100644 --- a/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json +++ b/codegen/sdk-codegen/aws-models/appconfig.2019-10-09.json @@ -138,7 +138,7 @@ "sdkId": "AppConfig", "arnNamespace": "appconfig", "cloudFormationName": "AppConfig", - "cloudTrailEventSource": "blue.services.amazonaws.com" + "cloudTrailEventSource": "appconfig.amazonaws.com" }, "aws.auth#sigv4": { "name": "appconfig" @@ -157,17 +157,17 @@ "smithy.api#documentation": "

The application name.

" } }, - "Id": { - "target": "com.amazonaws.appconfig#Id", - "traits": { - "smithy.api#documentation": "

The application ID.

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

The description of the application.

" } + }, + "Id": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "

The application ID.

" + } } } }, @@ -180,17 +180,17 @@ "com.amazonaws.appconfig#Applications": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appconfig#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.

" - } - }, "Items": { "target": "com.amazonaws.appconfig#ApplicationList", "traits": { "smithy.api#documentation": "

The elements from this collection.

" } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#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.

" + } } } }, @@ -237,13 +237,6 @@ "com.amazonaws.appconfig#Configuration": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.appconfig#Blob", - "traits": { - "smithy.api#documentation": "

The content of the configuration or the configuration data.

", - "smithy.api#httpPayload": {} - } - }, "ContentType": { "target": "com.amazonaws.appconfig#String", "traits": { @@ -251,6 +244,13 @@ "smithy.api#httpHeader": "Content-Type" } }, + "Content": { + "target": "com.amazonaws.appconfig#Blob", + "traits": { + "smithy.api#documentation": "

The content of the configuration or the configuration data.

", + "smithy.api#httpPayload": {} + } + }, "ConfigurationVersion": { "target": "com.amazonaws.appconfig#Version", "traits": { @@ -269,16 +269,10 @@ "smithy.api#documentation": "

The application ID.

" } }, - "Name": { - "target": "com.amazonaws.appconfig#Name", - "traits": { - "smithy.api#documentation": "

The name of the configuration profile.

" - } - }, - "Validators": { - "target": "com.amazonaws.appconfig#ValidatorList", + "LocationUri": { + "target": "com.amazonaws.appconfig#Uri", "traits": { - "smithy.api#documentation": "

A list of methods for validating the configuration.

" + "smithy.api#documentation": "

The URI location of the configuration.

" } }, "RetrievalRoleArn": { @@ -287,10 +281,16 @@ "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" } }, - "LocationUri": { - "target": "com.amazonaws.appconfig#Uri", + "Name": { + "target": "com.amazonaws.appconfig#Name", "traits": { - "smithy.api#documentation": "

The URI location of the configuration.

" + "smithy.api#documentation": "

The name of the configuration profile.

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

The configuration profile description.

" } }, "Id": { @@ -299,10 +299,10 @@ "smithy.api#documentation": "

The configuration profile ID.

" } }, - "Description": { - "target": "com.amazonaws.appconfig#Description", + "Validators": { + "target": "com.amazonaws.appconfig#ValidatorList", "traits": { - "smithy.api#documentation": "

The configuration profile description.

" + "smithy.api#documentation": "

A list of methods for validating the configuration.

" } } } @@ -310,22 +310,16 @@ "com.amazonaws.appconfig#ConfigurationProfileSummary": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.appconfig#Id", - "traits": { - "smithy.api#documentation": "

The application ID.

" - } - }, "ValidatorTypes": { "target": "com.amazonaws.appconfig#ValidatorTypeList", "traits": { "smithy.api#documentation": "

The types of validators in the configuration profile.

" } }, - "Name": { - "target": "com.amazonaws.appconfig#Name", + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The name of the configuration profile.

" + "smithy.api#documentation": "

The application ID.

" } }, "LocationUri": { @@ -334,6 +328,12 @@ "smithy.api#documentation": "

The URI location of the configuration.

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

The name of the configuration profile.

" + } + }, "Id": { "target": "com.amazonaws.appconfig#Id", "traits": { @@ -354,17 +354,17 @@ "com.amazonaws.appconfig#ConfigurationProfiles": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appconfig#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.

" - } - }, "Items": { "target": "com.amazonaws.appconfig#ConfigurationProfileSummaryList", "traits": { "smithy.api#documentation": "

The elements from this collection.

" } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#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.

" + } } } }, @@ -416,17 +416,17 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.appconfig#TagMap", - "traits": { - "smithy.api#documentation": "

Metadata to assign to the application. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.

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

A description of the application.

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

Metadata to assign to the application. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.

" + } } } }, @@ -467,12 +467,6 @@ "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" } }, - "Validators": { - "target": "com.amazonaws.appconfig#ValidatorList", - "traits": { - "smithy.api#documentation": "

A list of methods for validating the configuration.

" - } - }, "Name": { "target": "com.amazonaws.appconfig#Name", "traits": { @@ -494,17 +488,23 @@ "smithy.api#documentation": "

Metadata to assign to the configuration profile. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define.

" } }, + "LocationUri": { + "target": "com.amazonaws.appconfig#Uri", + "traits": { + "smithy.api#documentation": "

A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM\n Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the\n document name in the format ssm-document:// or the Amazon\n Resource Name (ARN). For a parameter, specify either the parameter name in the format\n ssm-parameter:// or the ARN. For an Amazon S3 object,\n specify the URI in the following format: s3:///\n . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

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

A description of the configuration profile.

" } }, - "LocationUri": { - "target": "com.amazonaws.appconfig#Uri", + "Validators": { + "target": "com.amazonaws.appconfig#ValidatorList", "traits": { - "smithy.api#documentation": "

A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM\n Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the\n document name in the format ssm-document:// or the Amazon\n Resource Name (ARN). For a parameter, specify either the parameter name in the format\n ssm-parameter:// or the ARN. For an Amazon S3 object,\n specify the URI in the following format: s3:///\n . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

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

A list of methods for validating the configuration.

" } } } @@ -551,12 +551,6 @@ "smithy.api#documentation": "

The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

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

Metadata to assign to the deployment strategy. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define.

" - } - }, "Name": { "target": "com.amazonaws.appconfig#Name", "traits": { @@ -564,6 +558,12 @@ "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.appconfig#Description", + "traits": { + "smithy.api#documentation": "

A description of the deployment strategy.

" + } + }, "ReplicateTo": { "target": "com.amazonaws.appconfig#ReplicateTo", "traits": { @@ -571,12 +571,10 @@ "smithy.api#required": {} } }, - "DeploymentDurationInMinutes": { - "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", + "Tags": { + "target": "com.amazonaws.appconfig#TagMap", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

Total amount of time for a deployment to last.

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

Metadata to assign to the deployment strategy. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define.

" } }, "GrowthType": { @@ -585,10 +583,12 @@ "smithy.api#documentation": "

The algorithm used to define how percentage grows over time. AWS AppConfig supports the\n following growth types:

\n

\n Linear: For this type, AppConfig processes the\n deployment by dividing the total number of targets by the value specified for Step\n percentage. For example, a linear deployment that uses a Step\n percentage of 10 deploys the configuration to 10 percent of the hosts. After\n those deployments are complete, the system deploys the configuration to the next 10\n percent. This continues until 100% of the targets have successfully received the\n configuration.

\n\n

\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:

\n

\n 2*(2^0)\n

\n

\n 2*(2^1)\n

\n

\n 2*(2^2)\n

\n

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.

" } }, - "Description": { - "target": "com.amazonaws.appconfig#Description", + "DeploymentDurationInMinutes": { + "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

A description of the deployment strategy.

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

Total amount of time for a deployment to last.

", + "smithy.api#required": {} } } } @@ -624,10 +624,12 @@ "com.amazonaws.appconfig#CreateEnvironmentRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.appconfig#TagMap", + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

Metadata to assign to the environment. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.

" + "smithy.api#documentation": "

The application ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Monitors": { @@ -642,18 +644,16 @@ "smithy.api#documentation": "

A description of the environment.

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

A name for the environment.

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

Metadata to assign to the environment. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.

" } }, - "ApplicationId": { - "target": "com.amazonaws.appconfig#Id", + "Name": { + "target": "com.amazonaws.appconfig#Name", "traits": { - "smithy.api#documentation": "

The application ID.

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

A name for the environment.

", "smithy.api#required": {} } } @@ -699,14 +699,6 @@ "com.amazonaws.appconfig#CreateHostedConfigurationVersionRequest": { "type": "structure", "members": { - "LatestVersionNumber": { - "target": "com.amazonaws.appconfig#Integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

An optional locking token used to prevent race conditions from overwriting configuration\n updates when creating a new version. To ensure your data is not overwritten when creating\n multiple hosted configuration versions in rapid succession, specify the version of the\n latest hosted configuration version.

", - "smithy.api#httpHeader": "Latest-Version-Number" - } - }, "Content": { "target": "com.amazonaws.appconfig#Blob", "traits": { @@ -715,6 +707,22 @@ "smithy.api#required": {} } }, + "ConfigurationProfileId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "

The configuration profile ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

An optional locking token used to prevent race conditions from overwriting configuration\n updates when creating a new version. To ensure your data is not overwritten when creating\n multiple hosted configuration versions in rapid succession, specify the version of the\n latest hosted configuration version.

", + "smithy.api#httpHeader": "Latest-Version-Number" + } + }, "Description": { "target": "com.amazonaws.appconfig#Description", "traits": { @@ -730,14 +738,6 @@ "smithy.api#required": {} } }, - "ConfigurationProfileId": { - "target": "com.amazonaws.appconfig#Id", - "traits": { - "smithy.api#documentation": "

The configuration profile ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { @@ -904,18 +904,18 @@ "com.amazonaws.appconfig#DeleteEnvironmentRequest": { "type": "structure", "members": { - "EnvironmentId": { + "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the environment you want to delete.

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

The application ID that includes the environment you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "EnvironmentId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The application ID that includes the environment you want to delete.

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

The ID of the environment you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -950,10 +950,10 @@ "com.amazonaws.appconfig#DeleteHostedConfigurationVersionRequest": { "type": "structure", "members": { - "ApplicationId": { + "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The application ID.

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

The configuration profile ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -966,10 +966,10 @@ "smithy.api#required": {} } }, - "ConfigurationProfileId": { + "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The configuration profile ID.

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

The application ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -979,22 +979,34 @@ "com.amazonaws.appconfig#Deployment": { "type": "structure", "members": { - "DeploymentStrategyId": { - "target": "com.amazonaws.appconfig#Id", + "StartedAt": { + "target": "com.amazonaws.appconfig#Iso8601DateTime", "traits": { - "smithy.api#documentation": "

The ID of the deployment strategy that was deployed.

" + "smithy.api#documentation": "

The time the deployment started.

" } }, - "ApplicationId": { + "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the application that was deployed.

" + "smithy.api#documentation": "

The ID of the configuration profile that was deployed.

" } }, - "ConfigurationLocationUri": { - "target": "com.amazonaws.appconfig#Uri", + "PercentageComplete": { + "target": "com.amazonaws.appconfig#Percentage", "traits": { - "smithy.api#documentation": "

Information about the source location of the configuration.

" + "smithy.api#documentation": "

The percentage of targets for which the deployment is available.

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

The state of the deployment.

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

The description of the deployment.

" } }, "GrowthType": { @@ -1003,16 +1015,22 @@ "smithy.api#documentation": "

The algorithm used to define how percentage grew over time.

" } }, - "PercentageComplete": { - "target": "com.amazonaws.appconfig#Percentage", + "ConfigurationLocationUri": { + "target": "com.amazonaws.appconfig#Uri", "traits": { - "smithy.api#documentation": "

The percentage of targets for which the deployment is available.

" + "smithy.api#documentation": "

Information about the source location of the configuration.

" } }, - "State": { - "target": "com.amazonaws.appconfig#DeploymentState", + "DeploymentStrategyId": { + "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The state of the deployment.

" + "smithy.api#documentation": "

The ID of the deployment strategy that was deployed.

" + } + }, + "ConfigurationVersion": { + "target": "com.amazonaws.appconfig#Version", + "traits": { + "smithy.api#documentation": "

The configuration version that was deployed.

" } }, "EventLog": { @@ -1021,28 +1039,28 @@ "smithy.api#documentation": "

A list containing all events related to a deployment. The most recent events are\n displayed first.

" } }, - "ConfigurationVersion": { - "target": "com.amazonaws.appconfig#Version", + "EnvironmentId": { + "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The configuration version that was deployed.

" + "smithy.api#documentation": "

The ID of the environment that was deployed.

" } }, - "Description": { - "target": "com.amazonaws.appconfig#Description", + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The description of the deployment.

" + "smithy.api#documentation": "

The ID of the application that was deployed.

" } }, - "ConfigurationProfileId": { - "target": "com.amazonaws.appconfig#Id", + "ConfigurationName": { + "target": "com.amazonaws.appconfig#Name", "traits": { - "smithy.api#documentation": "

The ID of the configuration profile that was deployed.

" + "smithy.api#documentation": "

The name of the configuration.

" } }, - "DeploymentDurationInMinutes": { - "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", + "DeploymentNumber": { + "target": "com.amazonaws.appconfig#Integer", "traits": { - "smithy.api#documentation": "

Total amount of time the deployment lasted.

" + "smithy.api#documentation": "

The sequence number of the deployment.

" } }, "FinalBakeTimeInMinutes": { @@ -1051,16 +1069,10 @@ "smithy.api#documentation": "

The amount of time AppConfig monitored for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" } }, - "StartedAt": { + "CompletedAt": { "target": "com.amazonaws.appconfig#Iso8601DateTime", "traits": { - "smithy.api#documentation": "

The time the deployment started.

" - } - }, - "DeploymentNumber": { - "target": "com.amazonaws.appconfig#Integer", - "traits": { - "smithy.api#documentation": "

The sequence number of the deployment.

" + "smithy.api#documentation": "

The time the deployment completed.

" } }, "GrowthFactor": { @@ -1069,52 +1081,40 @@ "smithy.api#documentation": "

The percentage of targets to receive a deployed configuration during each\n interval.

" } }, - "CompletedAt": { - "target": "com.amazonaws.appconfig#Iso8601DateTime", + "DeploymentDurationInMinutes": { + "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

The time the deployment completed.

" + "smithy.api#documentation": "

Total amount of time the deployment lasted.

" } - }, - "ConfigurationName": { - "target": "com.amazonaws.appconfig#Name", + } + } + }, + "com.amazonaws.appconfig#DeploymentEvent": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.appconfig#Description", "traits": { - "smithy.api#documentation": "

The name of the configuration.

" + "smithy.api#documentation": "

A description of the deployment event. Descriptions include, but are not limited to, the\n user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts\n that received the deployment, or in the case of an internal error, a recommendation to\n attempt a new deployment.

" } }, - "EnvironmentId": { - "target": "com.amazonaws.appconfig#Id", + "EventType": { + "target": "com.amazonaws.appconfig#DeploymentEventType", "traits": { - "smithy.api#documentation": "

The ID of the environment that was deployed.

" + "smithy.api#documentation": "

The type of deployment event. Deployment event types include the start, stop, or\n completion of a deployment; a percentage update; the start or stop of a bake period; the\n start or completion of a rollback.

" } - } - } - }, - "com.amazonaws.appconfig#DeploymentEvent": { - "type": "structure", - "members": { + }, "OccurredAt": { "target": "com.amazonaws.appconfig#Iso8601DateTime", "traits": { "smithy.api#documentation": "

The date and time the event occurred.

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

A description of the deployment event. Descriptions include, but are not limited to, the\n user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts\n that received the deployment, or in the case of an internal error, a recommendation to\n attempt a new deployment.

" - } - }, "TriggeredBy": { "target": "com.amazonaws.appconfig#TriggeredBy", "traits": { "smithy.api#documentation": "

The entity that triggered the deployment event. Events can be triggered by a user, AWS\n AppConfig, an Amazon CloudWatch alarm, or an internal error.

" } - }, - "EventType": { - "target": "com.amazonaws.appconfig#DeploymentEventType", - "traits": { - "smithy.api#documentation": "

The type of deployment event. Deployment event types include the start, stop, or\n completion of a deployment; a percentage update; the start or stop of a bake period; the\n start or completion of a rollback.

" - } } }, "traits": { @@ -1215,18 +1215,6 @@ "com.amazonaws.appconfig#DeploymentStrategy": { "type": "structure", "members": { - "GrowthType": { - "target": "com.amazonaws.appconfig#GrowthType", - "traits": { - "smithy.api#documentation": "

The algorithm used to define how percentage grew over time.

" - } - }, - "DeploymentDurationInMinutes": { - "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", - "traits": { - "smithy.api#documentation": "

Total amount of time the deployment lasted.

" - } - }, "ReplicateTo": { "target": "com.amazonaws.appconfig#ReplicateTo", "traits": { @@ -1245,16 +1233,22 @@ "smithy.api#documentation": "

The description of the deployment strategy.

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

The name of the deployment strategy.

" + } + }, "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { "smithy.api#documentation": "

The amount of time AppConfig monitored for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" } }, - "Name": { - "target": "com.amazonaws.appconfig#Name", + "DeploymentDurationInMinutes": { + "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

The name of the deployment strategy.

" + "smithy.api#documentation": "

Total amount of time the deployment lasted.

" } }, "GrowthFactor": { @@ -1262,6 +1256,12 @@ "traits": { "smithy.api#documentation": "

The percentage of targets that received a deployed configuration during each\n interval.

" } + }, + "GrowthType": { + "target": "com.amazonaws.appconfig#GrowthType", + "traits": { + "smithy.api#documentation": "

The algorithm used to define how percentage grew over time.

" + } } } }, @@ -1280,16 +1280,10 @@ "com.amazonaws.appconfig#DeploymentSummary": { "type": "structure", "members": { - "FinalBakeTimeInMinutes": { - "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", - "traits": { - "smithy.api#documentation": "

The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" - } - }, - "GrowthFactor": { - "target": "com.amazonaws.appconfig#Percentage", + "ConfigurationVersion": { + "target": "com.amazonaws.appconfig#Version", "traits": { - "smithy.api#documentation": "

The percentage of targets to receive a deployed configuration during each\n interval.

" + "smithy.api#documentation": "

The version of the configuration.

" } }, "DeploymentNumber": { @@ -1298,22 +1292,16 @@ "smithy.api#documentation": "

The sequence number of the deployment.

" } }, - "CompletedAt": { - "target": "com.amazonaws.appconfig#Iso8601DateTime", + "State": { + "target": "com.amazonaws.appconfig#DeploymentState", "traits": { - "smithy.api#documentation": "

Time the deployment completed.

" + "smithy.api#documentation": "

The state of the deployment.

" } }, - "DeploymentDurationInMinutes": { + "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

Total amount of time the deployment lasted.

" - } - }, - "GrowthType": { - "target": "com.amazonaws.appconfig#GrowthType", - "traits": { - "smithy.api#documentation": "

The algorithm used to define how percentage grows over time.

" + "smithy.api#documentation": "

The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" } }, "PercentageComplete": { @@ -1322,28 +1310,40 @@ "smithy.api#documentation": "

The percentage of targets for which the deployment is available.

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

The name of the configuration.

" + } + }, "StartedAt": { "target": "com.amazonaws.appconfig#Iso8601DateTime", "traits": { "smithy.api#documentation": "

Time the deployment started.

" } }, - "ConfigurationName": { - "target": "com.amazonaws.appconfig#Name", + "CompletedAt": { + "target": "com.amazonaws.appconfig#Iso8601DateTime", "traits": { - "smithy.api#documentation": "

The name of the configuration.

" + "smithy.api#documentation": "

Time the deployment completed.

" } }, - "ConfigurationVersion": { - "target": "com.amazonaws.appconfig#Version", + "GrowthFactor": { + "target": "com.amazonaws.appconfig#Percentage", "traits": { - "smithy.api#documentation": "

The version of the configuration.

" + "smithy.api#documentation": "

The percentage of targets to receive a deployed configuration during each\n interval.

" } }, - "State": { - "target": "com.amazonaws.appconfig#DeploymentState", + "DeploymentDurationInMinutes": { + "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

The state of the deployment.

" + "smithy.api#documentation": "

Total amount of time the deployment lasted.

" + } + }, + "GrowthType": { + "target": "com.amazonaws.appconfig#GrowthType", + "traits": { + "smithy.api#documentation": "

The algorithm used to define how percentage grows over time.

" } } }, @@ -1354,17 +1354,17 @@ "com.amazonaws.appconfig#Deployments": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appconfig#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.

" - } - }, "Items": { "target": "com.amazonaws.appconfig#DeploymentList", "traits": { "smithy.api#documentation": "

The elements from this collection.

" } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#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.

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

The application ID.

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

The description of the environment.

" - } - }, - "State": { - "target": "com.amazonaws.appconfig#EnvironmentState", + "Monitors": { + "target": "com.amazonaws.appconfig#MonitorList", "traits": { - "smithy.api#documentation": "

The state of the environment. An environment can be in one of the following states:\n READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or\n ROLLED_BACK\n

" + "smithy.api#documentation": "

Amazon CloudWatch alarms monitored during the deployment.

" } }, "Id": { @@ -1410,10 +1404,16 @@ "smithy.api#documentation": "

The environment ID.

" } }, - "Monitors": { - "target": "com.amazonaws.appconfig#MonitorList", + "Description": { + "target": "com.amazonaws.appconfig#Description", "traits": { - "smithy.api#documentation": "

Amazon CloudWatch alarms monitored during the deployment.

" + "smithy.api#documentation": "

The description of the environment.

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

The state of the environment. An environment can be in one of the following states:\n READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or\n ROLLED_BACK\n

" } } } @@ -1450,17 +1450,17 @@ "com.amazonaws.appconfig#Environments": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.appconfig#EnvironmentList", - "traits": { - "smithy.api#documentation": "

The elements from this collection.

" - } - }, "NextToken": { "target": "com.amazonaws.appconfig#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.

" } + }, + "Items": { + "target": "com.amazonaws.appconfig#EnvironmentList", + "traits": { + "smithy.api#documentation": "

The elements from this collection.

" + } } } }, @@ -1567,18 +1567,18 @@ "com.amazonaws.appconfig#GetConfigurationProfileRequest": { "type": "structure", "members": { - "ConfigurationProfileId": { + "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the configuration profile you want to get.

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

The ID of the application that includes the configuration profile you want to\n get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the application that includes the configuration profile you want to\n get.

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

The ID of the configuration profile you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1596,12 +1596,11 @@ "smithy.api#required": {} } }, - "Configuration": { - "target": "com.amazonaws.appconfig#StringWithLengthBetween1And64", + "ClientConfigurationVersion": { + "target": "com.amazonaws.appconfig#Version", "traits": { - "smithy.api#documentation": "

The configuration to get. Specify either the configuration name or the configuration\n ID.

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

The configuration version returned in the most recent GetConfiguration\n response.

\n \n

AWS AppConfig uses the value of the ClientConfigurationVersion parameter\n to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.

\n

To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.

\n \n

For more information about working with configurations, see Retrieving the Configuration in the\n AWS AppConfig User Guide.

", + "smithy.api#httpQuery": "client_configuration_version" } }, "ClientId": { @@ -1620,11 +1619,12 @@ "smithy.api#required": {} } }, - "ClientConfigurationVersion": { - "target": "com.amazonaws.appconfig#Version", + "Configuration": { + "target": "com.amazonaws.appconfig#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

The configuration version returned in the most recent GetConfiguration\n response.

\n \n

AWS AppConfig uses the value of the ClientConfigurationVersion parameter\n to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.

\n

To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.

\n \n

For more information about working with configurations, see Retrieving the Configuration in the\n AWS AppConfig User Guide.

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

The configuration to get. Specify either the configuration name or the configuration\n ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -1816,18 +1816,18 @@ "smithy.api#required": {} } }, - "ApplicationId": { - "target": "com.amazonaws.appconfig#Id", + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", "traits": { - "smithy.api#documentation": "

The application ID.

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

The version.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "VersionNumber": { - "target": "com.amazonaws.appconfig#Integer", + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The version.

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

The application ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1861,13 +1861,6 @@ "com.amazonaws.appconfig#HostedConfigurationVersion": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.appconfig#StringWithLengthBetween1And255", - "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, "Description": { "target": "com.amazonaws.appconfig#Description", "traits": { @@ -1882,11 +1875,18 @@ "smithy.api#httpHeader": "Configuration-Profile-Id" } }, - "VersionNumber": { - "target": "com.amazonaws.appconfig#Integer", + "Content": { + "target": "com.amazonaws.appconfig#Blob", "traits": { - "smithy.api#documentation": "

The configuration version.

", - "smithy.api#httpHeader": "Version-Number" + "smithy.api#documentation": "

The content of the configuration or the configuration data.

", + "smithy.api#httpPayload": {} + } + }, + "ContentType": { + "target": "com.amazonaws.appconfig#StringWithLengthBetween1And255", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

", + "smithy.api#httpHeader": "Content-Type" } }, "ApplicationId": { @@ -1896,11 +1896,11 @@ "smithy.api#httpHeader": "Application-Id" } }, - "Content": { - "target": "com.amazonaws.appconfig#Blob", + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", "traits": { - "smithy.api#documentation": "

The content of the configuration or the configuration data.

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

The configuration version.

", + "smithy.api#httpHeader": "Version-Number" } } } @@ -1908,16 +1908,10 @@ "com.amazonaws.appconfig#HostedConfigurationVersionSummary": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.appconfig#Description", - "traits": { - "smithy.api#documentation": "

A description of the configuration.

" - } - }, - "ApplicationId": { + "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The application ID.

" + "smithy.api#documentation": "

The configuration profile ID.

" } }, "VersionNumber": { @@ -1926,16 +1920,22 @@ "smithy.api#documentation": "

The configuration version.

" } }, + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "

The application ID.

" + } + }, "ContentType": { "target": "com.amazonaws.appconfig#StringWithLengthBetween1And255", "traits": { "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

" } }, - "ConfigurationProfileId": { - "target": "com.amazonaws.appconfig#Id", + "Description": { + "target": "com.amazonaws.appconfig#Description", "traits": { - "smithy.api#documentation": "

The configuration profile ID.

" + "smithy.api#documentation": "

A description of the configuration.

" } } }, @@ -1952,16 +1952,16 @@ "com.amazonaws.appconfig#HostedConfigurationVersions": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appconfig#NextToken", + "Items": { + "target": "com.amazonaws.appconfig#HostedConfigurationVersionSummaryList", "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": "

The elements from this collection.

" } }, - "Items": { - "target": "com.amazonaws.appconfig#HostedConfigurationVersionSummaryList", + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", "traits": { - "smithy.api#documentation": "

The elements from this collection.

" + "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } } } @@ -2027,6 +2027,13 @@ "com.amazonaws.appconfig#ListApplicationsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", + "smithy.api#httpQuery": "next_token" + } + }, "MaxResults": { "target": "com.amazonaws.appconfig#MaxResults", "traits": { @@ -2034,13 +2041,6 @@ "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that\n you can specify in a subsequent call to get the next set of results.

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

A token to start the list. Use this token to get the next set of results.

", - "smithy.api#httpQuery": "next_token" - } } } }, @@ -2088,13 +2088,6 @@ "smithy.api#httpQuery": "max_results" } }, - "NextToken": { - "target": "com.amazonaws.appconfig#NextToken", - "traits": { - "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", - "smithy.api#httpQuery": "next_token" - } - }, "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { @@ -2102,6 +2095,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", + "smithy.api#httpQuery": "next_token" + } } } }, @@ -2138,13 +2138,6 @@ "com.amazonaws.appconfig#ListDeploymentStrategiesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appconfig#NextToken", - "traits": { - "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", - "smithy.api#httpQuery": "next_token" - } - }, "MaxResults": { "target": "com.amazonaws.appconfig#MaxResults", "traits": { @@ -2152,6 +2145,13 @@ "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that\n you can specify in a subsequent call to get the next set of results.

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

A token to start the list. Use this token to get the next set of results.

", + "smithy.api#httpQuery": "next_token" + } } } }, @@ -2199,13 +2199,6 @@ "smithy.api#httpQuery": "max_results" } }, - "NextToken": { - "target": "com.amazonaws.appconfig#NextToken", - "traits": { - "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", - "smithy.api#httpQuery": "next_token" - } - }, "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { @@ -2221,6 +2214,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", + "smithy.api#httpQuery": "next_token" + } } } }, @@ -2268,6 +2268,13 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", + "smithy.api#httpQuery": "next_token" + } + }, "MaxResults": { "target": "com.amazonaws.appconfig#MaxResults", "traits": { @@ -2275,13 +2282,6 @@ "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that\n you can specify in a subsequent call to get the next set of results.

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

A token to start the list. Use this token to get the next set of results.

", - "smithy.api#httpQuery": "next_token" - } } } }, @@ -2321,21 +2321,29 @@ "com.amazonaws.appconfig#ListHostedConfigurationVersionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appconfig#NextToken", + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

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

The application ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ApplicationId": { + "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The application ID.

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

The configuration profile ID.

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

A token to start the list. Use this token to get the next set of results.

", + "smithy.api#httpQuery": "next_token" + } + }, "MaxResults": { "target": "com.amazonaws.appconfig#MaxResults", "traits": { @@ -2343,14 +2351,6 @@ "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that\n you can specify in a subsequent call to get the next set of results.

", "smithy.api#httpQuery": "max_results" } - }, - "ConfigurationProfileId": { - "target": "com.amazonaws.appconfig#Id", - "traits": { - "smithy.api#documentation": "

The configuration profile ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -2416,17 +2416,17 @@ "com.amazonaws.appconfig#Monitor": { "type": "structure", "members": { - "AlarmArn": { - "target": "com.amazonaws.appconfig#Arn", - "traits": { - "smithy.api#documentation": "

ARN of the Amazon CloudWatch alarm.

" - } - }, "AlarmRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { "smithy.api#documentation": "

ARN of an IAM role for AppConfig to monitor AlarmArn.

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

ARN of the Amazon CloudWatch alarm.

" + } } }, "traits": { @@ -2466,17 +2466,17 @@ "com.amazonaws.appconfig#PayloadTooLargeException": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.appconfig#Float" + "Message": { + "target": "com.amazonaws.appconfig#String" }, "Size": { "target": "com.amazonaws.appconfig#Float" }, - "Message": { - "target": "com.amazonaws.appconfig#String" - }, "Measure": { "target": "com.amazonaws.appconfig#BytesMeasure" + }, + "Limit": { + "target": "com.amazonaws.appconfig#Float" } }, "traits": { @@ -2601,13 +2601,6 @@ "smithy.api#required": {} } }, - "ConfigurationVersion": { - "target": "com.amazonaws.appconfig#Version", - "traits": { - "smithy.api#documentation": "

The configuration version to deploy.

", - "smithy.api#required": {} - } - }, "DeploymentStrategyId": { "target": "com.amazonaws.appconfig#DeploymentStrategyId", "traits": { @@ -2622,10 +2615,17 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.appconfig#Description", + "Tags": { + "target": "com.amazonaws.appconfig#TagMap", "traits": { - "smithy.api#documentation": "

A description of the deployment.

" + "smithy.api#documentation": "

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.

" + } + }, + "ConfigurationVersion": { + "target": "com.amazonaws.appconfig#Version", + "traits": { + "smithy.api#documentation": "

The configuration version to deploy.

", + "smithy.api#required": {} } }, "EnvironmentId": { @@ -2636,10 +2636,10 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.appconfig#TagMap", + "Description": { + "target": "com.amazonaws.appconfig#Description", "traits": { - "smithy.api#documentation": "

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.

" + "smithy.api#documentation": "

A description of the deployment.

" } } } @@ -2874,14 +2874,6 @@ "com.amazonaws.appconfig#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.appconfig#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to delete.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.appconfig#Arn", "traits": { @@ -2889,6 +2881,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TagKeys": { + "target": "com.amazonaws.appconfig#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to delete.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -2976,45 +2976,45 @@ "com.amazonaws.appconfig#UpdateConfigurationProfileRequest": { "type": "structure", "members": { + "Validators": { + "target": "com.amazonaws.appconfig#ValidatorList", + "traits": { + "smithy.api#documentation": "

A list of methods for validating the configuration.

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

The name of the configuration profile.

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

A description of the configuration profile.

" + } + }, "RetrievalRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" } }, - "ApplicationId": { + "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The application ID.

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

The ID of the configuration profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ConfigurationProfileId": { + "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the configuration profile.

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

The application ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Description": { - "target": "com.amazonaws.appconfig#Description", - "traits": { - "smithy.api#documentation": "

A description of the configuration profile.

" - } - }, - "Validators": { - "target": "com.amazonaws.appconfig#ValidatorList", - "traits": { - "smithy.api#documentation": "

A list of methods for validating the configuration.

" - } } } }, @@ -3049,16 +3049,18 @@ "com.amazonaws.appconfig#UpdateDeploymentStrategyRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.appconfig#Description", + "FinalBakeTimeInMinutes": { + "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

A description of the deployment strategy.

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

The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" } }, - "GrowthType": { - "target": "com.amazonaws.appconfig#GrowthType", + "GrowthFactor": { + "target": "com.amazonaws.appconfig#GrowthFactor", "traits": { - "smithy.api#documentation": "

The algorithm used to define how percentage grows over time. AWS AppConfig supports the\n following growth types:

\n

\n Linear: For this type, AppConfig processes the\n deployment by increments of the growth factor evenly distributed over the deployment time.\n For example, a linear deployment that uses a growth factor of 20 initially makes the\n configuration available to 20 percent of the targets. After 1/5th of the deployment time\n has passed, the system updates the percentage to 40 percent. This continues until 100% of\n the targets are set to receive the deployed configuration.

\n\n

\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:

\n

\n 2*(2^0)\n

\n

\n 2*(2^1)\n

\n

\n 2*(2^2)\n

\n

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.

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

The percentage of targets to receive a deployed configuration during each\n interval.

" } }, "DeploymentDurationInMinutes": { @@ -3076,18 +3078,16 @@ "smithy.api#required": {} } }, - "FinalBakeTimeInMinutes": { - "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", + "GrowthType": { + "target": "com.amazonaws.appconfig#GrowthType", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" + "smithy.api#documentation": "

The algorithm used to define how percentage grows over time. AWS AppConfig supports the\n following growth types:

\n

\n Linear: For this type, AppConfig processes the\n deployment by increments of the growth factor evenly distributed over the deployment time.\n For example, a linear deployment that uses a growth factor of 20 initially makes the\n configuration available to 20 percent of the targets. After 1/5th of the deployment time\n has passed, the system updates the percentage to 40 percent. This continues until 100% of\n the targets are set to receive the deployed configuration.

\n\n

\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:

\n

\n 2*(2^0)\n

\n

\n 2*(2^1)\n

\n

\n 2*(2^2)\n

\n

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.

" } }, - "GrowthFactor": { - "target": "com.amazonaws.appconfig#GrowthFactor", + "Description": { + "target": "com.amazonaws.appconfig#Description", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The percentage of targets to receive a deployed configuration during each\n interval.

" + "smithy.api#documentation": "

A description of the deployment strategy.

" } } } @@ -3135,6 +3135,14 @@ "smithy.api#documentation": "

Amazon CloudWatch alarms to monitor during the deployment process.

" } }, + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "

The application ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "EnvironmentId": { "target": "com.amazonaws.appconfig#Id", "traits": { @@ -3148,14 +3156,6 @@ "traits": { "smithy.api#documentation": "

The name of the environment.

" } - }, - "ApplicationId": { - "target": "com.amazonaws.appconfig#Id", - "traits": { - "smithy.api#documentation": "

The application ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -3196,14 +3196,6 @@ "com.amazonaws.appconfig#ValidateConfigurationRequest": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.appconfig#Id", - "traits": { - "smithy.api#documentation": "

The application ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { @@ -3219,6 +3211,14 @@ "smithy.api#httpQuery": "configuration_version", "smithy.api#required": {} } + }, + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "

The application ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, diff --git a/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json b/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json new file mode 100644 index 000000000000..cc389bab79af --- /dev/null +++ b/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json @@ -0,0 +1,6109 @@ +{ + "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.appflow#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "arn:aws:.*:.*:[0-9]+:.*" + } + }, + "com.amazonaws.appflow#AccessKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#AccessToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#AccountName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#AggregationConfig": { + "type": "structure", + "members": { + "aggregationType": { + "target": "com.amazonaws.appflow#AggregationType", + "traits": { + "smithy.api#documentation": "

\n Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated. \n

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

\nThe aggregation settings that you can use to customize the output format of your flow data. \n

" + } + }, + "com.amazonaws.appflow#AggregationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "None", + "name": "NONE" + }, + { + "value": "SingleFile", + "name": "SINGLE_FILE" + } + ] + } + }, + "com.amazonaws.appflow#AmplitudeConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BETWEEN", + "name": "BETWEEN" + } + ] + } + }, + "com.amazonaws.appflow#AmplitudeConnectorProfileCredentials": { + "type": "structure", + "members": { + "secretKey": { + "target": "com.amazonaws.appflow#SecretKey", + "traits": { + "smithy.api#documentation": "

\n The Secret Access Key portion of the credentials.\n

", + "smithy.api#required": {} + } + }, + "apiKey": { + "target": "com.amazonaws.appflow#ApiKey", + "traits": { + "smithy.api#documentation": "

\n A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.\n

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

\n The connector-specific credentials required when using Amplitude.\n

" + } + }, + "com.amazonaws.appflow#AmplitudeConnectorProfileProperties": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector-specific profile properties required when using Amplitude.\n

" + } + }, + "com.amazonaws.appflow#AmplitudeMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amplitude.\n

" + } + }, + "com.amazonaws.appflow#AmplitudeSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\nThe object specified in the Amplitude flow source.\n

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

\n The properties that are applied when Amplitude is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#ApiKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#ApiSecretKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#ApiToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#ApplicationKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#AuthCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#Boolean": { + "type": "boolean" + }, + "com.amazonaws.appflow#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#BucketPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.appflow#ClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#ClientSecret": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.appflow#ConnectionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Public", + "name": "PUBLIC" + }, + { + "value": "Private", + "name": "PRIVATE" + } + ] + } + }, + "com.amazonaws.appflow#ConnectorAuthenticationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n An error occurred when authenticating with the connector endpoint.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.appflow#ConnectorConfiguration": { + "type": "structure", + "members": { + "canUseAsSource": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specifies whether the connector can be used as a source.\n

" + } + }, + "connectorMetadata": { + "target": "com.amazonaws.appflow#ConnectorMetadata", + "traits": { + "smithy.api#documentation": "

\nSpecifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.\n

" + } + }, + "canUseAsDestination": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nSpecifies whether the connector can be used as a destination.\n

" + } + }, + "supportedDestinationConnectors": { + "target": "com.amazonaws.appflow#ConnectorTypeList", + "traits": { + "smithy.api#documentation": "

\nLists the connectors that are available for use as destinations.\n

" + } + }, + "supportedTriggerTypes": { + "target": "com.amazonaws.appflow#TriggerTypeList", + "traits": { + "smithy.api#documentation": "

\nSpecifies the supported trigger types for the flow. \n

" + } + }, + "isPrivateLinkEnabled": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nSpecifies if PrivateLink is enabled for that connector.\n

" + } + }, + "isPrivateLinkEndpointUrlRequired": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nSpecifies if a PrivateLink endpoint URL is required.\n

" + } + }, + "supportedSchedulingFrequencies": { + "target": "com.amazonaws.appflow#SchedulingFrequencyTypeList", + "traits": { + "smithy.api#documentation": "

\n Specifies the supported flow frequency for that connector.\n

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

\nThe configuration settings related to a given connector.\n

" + } + }, + "com.amazonaws.appflow#ConnectorConfigurationsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#ConnectorType" + }, + "value": { + "target": "com.amazonaws.appflow#ConnectorConfiguration" + } + }, + "com.amazonaws.appflow#ConnectorEntity": { + "type": "structure", + "members": { + "hasNestedEntities": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nSpecifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = \"the_current_entity_name_with_hasNestedEntities_true\", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.\n

" + } + }, + "label": { + "target": "com.amazonaws.appflow#Label", + "traits": { + "smithy.api#documentation": "

\nThe label applied to the connector entity.\n

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

\nThe name of the connector entity.\n

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

\nThe high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.\n\n

" + } + }, + "com.amazonaws.appflow#ConnectorEntityField": { + "type": "structure", + "members": { + "destinationProperties": { + "target": "com.amazonaws.appflow#DestinationFieldProperties", + "traits": { + "smithy.api#documentation": "

\n The properties applied to a field when the connector is being used as a destination.\n

" + } + }, + "identifier": { + "target": "com.amazonaws.appflow#Identifier", + "traits": { + "smithy.api#documentation": "

\nThe unique identifier of the connector field.\n

", + "smithy.api#required": {} + } + }, + "label": { + "target": "com.amazonaws.appflow#Label", + "traits": { + "smithy.api#documentation": "

\nThe label applied to a connector entity field.\n

" + } + }, + "supportedFieldTypeDetails": { + "target": "com.amazonaws.appflow#SupportedFieldTypeDetails", + "traits": { + "smithy.api#documentation": "

\n Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.\n

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

\n A description of the connector entity field.\n

" + } + }, + "sourceProperties": { + "target": "com.amazonaws.appflow#SourceFieldProperties", + "traits": { + "smithy.api#documentation": "

\n The properties that can be applied to a field when the connector is being used as a source.\n

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

\nDescribes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.\n

" + } + }, + "com.amazonaws.appflow#ConnectorEntityFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorEntityField" + } + }, + "com.amazonaws.appflow#ConnectorEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorEntity" + } + }, + "com.amazonaws.appflow#ConnectorEntityMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#Group" + }, + "value": { + "target": "com.amazonaws.appflow#ConnectorEntityList" + } + }, + "com.amazonaws.appflow#ConnectorMetadata": { + "type": "structure", + "members": { + "Snowflake": { + "target": "com.amazonaws.appflow#SnowflakeMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Snowflake.\n

" + } + }, + "Slack": { + "target": "com.amazonaws.appflow#SlackMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Slack.\n

" + } + }, + "Redshift": { + "target": "com.amazonaws.appflow#RedshiftMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amazon Redshift.\n

" + } + }, + "Marketo": { + "target": "com.amazonaws.appflow#MarketoMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Marketo.\n

" + } + }, + "Datadog": { + "target": "com.amazonaws.appflow#DatadogMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Datadog.\n

" + } + }, + "Veeva": { + "target": "com.amazonaws.appflow#VeevaMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Veeva.\n

" + } + }, + "EventBridge": { + "target": "com.amazonaws.appflow#EventBridgeMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amazon EventBridge.\n

" + } + }, + "Trendmicro": { + "target": "com.amazonaws.appflow#TrendmicroMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Trend Micro.\n

" + } + }, + "ServiceNow": { + "target": "com.amazonaws.appflow#ServiceNowMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to ServiceNow.\n

" + } + }, + "Zendesk": { + "target": "com.amazonaws.appflow#ZendeskMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Zendesk.\n

" + } + }, + "Dynatrace": { + "target": "com.amazonaws.appflow#DynatraceMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Dynatrace.\n

" + } + }, + "Amplitude": { + "target": "com.amazonaws.appflow#AmplitudeMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amplitude.\n

" + } + }, + "GoogleAnalytics": { + "target": "com.amazonaws.appflow#GoogleAnalyticsMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Google Analytics.\n

" + } + }, + "S3": { + "target": "com.amazonaws.appflow#S3Metadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amazon S3.\n

" + } + }, + "InforNexus": { + "target": "com.amazonaws.appflow#InforNexusMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Infor Nexus.\n

" + } + }, + "Salesforce": { + "target": "com.amazonaws.appflow#SalesforceMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Salesforce.\n

" + } + }, + "Singular": { + "target": "com.amazonaws.appflow#SingularMetadata", + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Singular.\n

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

\n A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.\n

" + } + }, + "com.amazonaws.appflow#ConnectorOAuthRequest": { + "type": "structure", + "members": { + "authCode": { + "target": "com.amazonaws.appflow#AuthCode", + "traits": { + "smithy.api#documentation": "

\n The code provided by the connector when it has been authenticated via the connected app.\n

" + } + }, + "redirectUri": { + "target": "com.amazonaws.appflow#RedirectUri", + "traits": { + "smithy.api#documentation": "

\n The URL to which the authentication server redirects the browser after authorization has been granted.\n

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

\n Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.\n

" + } + }, + "com.amazonaws.appflow#ConnectorOperator": { + "type": "structure", + "members": { + "Slack": { + "target": "com.amazonaws.appflow#SlackConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Slack source fields.\n

" + } + }, + "InforNexus": { + "target": "com.amazonaws.appflow#InforNexusConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Infor Nexus source fields.\n

" + } + }, + "Zendesk": { + "target": "com.amazonaws.appflow#ZendeskConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Zendesk source fields.\n

" + } + }, + "Dynatrace": { + "target": "com.amazonaws.appflow#DynatraceConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Dynatrace source fields.\n

" + } + }, + "S3": { + "target": "com.amazonaws.appflow#S3ConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Amazon S3 source fields.\n

" + } + }, + "Singular": { + "target": "com.amazonaws.appflow#SingularConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Singular source fields.\n

" + } + }, + "Salesforce": { + "target": "com.amazonaws.appflow#SalesforceConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Salesforce source fields.\n

" + } + }, + "Trendmicro": { + "target": "com.amazonaws.appflow#TrendmicroConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Trend Micro source fields.\n

" + } + }, + "ServiceNow": { + "target": "com.amazonaws.appflow#ServiceNowConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided ServiceNow source fields.\n

" + } + }, + "Amplitude": { + "target": "com.amazonaws.appflow#AmplitudeConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Amplitude source fields.\n

" + } + }, + "GoogleAnalytics": { + "target": "com.amazonaws.appflow#GoogleAnalyticsConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Google Analytics source fields.\n

" + } + }, + "Datadog": { + "target": "com.amazonaws.appflow#DatadogConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Datadog source fields.\n

" + } + }, + "Veeva": { + "target": "com.amazonaws.appflow#VeevaConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Veeva source fields.\n

" + } + }, + "Marketo": { + "target": "com.amazonaws.appflow#MarketoConnectorOperator", + "traits": { + "smithy.api#documentation": "

\n The operation to be performed on the provided Marketo source fields.\n

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

\nThe operation to be performed on the provided source fields.\n

" + } + }, + "com.amazonaws.appflow#ConnectorProfile": { + "type": "structure", + "members": { + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.\n

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

\n The Amazon Resource Name (ARN) of the connector profile credentials.\n

" + } + }, + "connectorProfileArn": { + "target": "com.amazonaws.appflow#ConnectorProfileArn", + "traits": { + "smithy.api#documentation": "

\nThe Amazon Resource Name (ARN) of the connector profile.\n

" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n The type of connector, such as Salesforce, Amplitude, and so on.\n

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\n Specifies when the connector profile was last updated.\n

" + } + }, + "connectorProfileProperties": { + "target": "com.amazonaws.appflow#ConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\nThe connector-specific properties of the profile configuration.\n

" + } + }, + "connectionMode": { + "target": "com.amazonaws.appflow#ConnectionMode", + "traits": { + "smithy.api#documentation": "

\n Indicates the connection mode and if it is public or private.\n

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

\n Specifies when the connector profile was created.\n

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

\n Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.\n

" + } + }, + "com.amazonaws.appflow#ConnectorProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "arn:aws:kms:.*:[0-9]+:.*" + } + }, + "com.amazonaws.appflow#ConnectorProfileConfig": { + "type": "structure", + "members": { + "connectorProfileProperties": { + "target": "com.amazonaws.appflow#ConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties of the profile configuration.\n

", + "smithy.api#required": {} + } + }, + "connectorProfileCredentials": { + "target": "com.amazonaws.appflow#ConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required by each connector.\n

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

\n Defines the connector-specific configuration and credentials for the connector profile.\n

" + } + }, + "com.amazonaws.appflow#ConnectorProfileCredentials": { + "type": "structure", + "members": { + "Datadog": { + "target": "com.amazonaws.appflow#DatadogConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Datadog.\n

" + } + }, + "Marketo": { + "target": "com.amazonaws.appflow#MarketoConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Marketo.\n

" + } + }, + "Redshift": { + "target": "com.amazonaws.appflow#RedshiftConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Amazon Redshift.\n

" + } + }, + "Dynatrace": { + "target": "com.amazonaws.appflow#DynatraceConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Dynatrace.\n

" + } + }, + "InforNexus": { + "target": "com.amazonaws.appflow#InforNexusConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Infor Nexus.\n

" + } + }, + "Zendesk": { + "target": "com.amazonaws.appflow#ZendeskConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Zendesk.\n

" + } + }, + "Trendmicro": { + "target": "com.amazonaws.appflow#TrendmicroConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Trend Micro.\n

" + } + }, + "Slack": { + "target": "com.amazonaws.appflow#SlackConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Slack.\n

" + } + }, + "Salesforce": { + "target": "com.amazonaws.appflow#SalesforceConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Salesforce.\n

" + } + }, + "Snowflake": { + "target": "com.amazonaws.appflow#SnowflakeConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Snowflake.\n

" + } + }, + "Singular": { + "target": "com.amazonaws.appflow#SingularConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Singular.\n

" + } + }, + "GoogleAnalytics": { + "target": "com.amazonaws.appflow#GoogleAnalyticsConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Google Analytics.\n

" + } + }, + "ServiceNow": { + "target": "com.amazonaws.appflow#ServiceNowConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using ServiceNow.\n

" + } + }, + "Amplitude": { + "target": "com.amazonaws.appflow#AmplitudeConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Amplitude.\n

" + } + }, + "Veeva": { + "target": "com.amazonaws.appflow#VeevaConnectorProfileCredentials", + "traits": { + "smithy.api#documentation": "

\n The connector-specific credentials required when using Veeva.\n

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

\n The connector-specific credentials required by a connector.\n

" + } + }, + "com.amazonaws.appflow#ConnectorProfileDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorProfile" + } + }, + "com.amazonaws.appflow#ConnectorProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[\\w/!@#+=.-]+" + } + }, + "com.amazonaws.appflow#ConnectorProfileNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorProfileName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.appflow#ConnectorProfileProperties": { + "type": "structure", + "members": { + "GoogleAnalytics": { + "target": "com.amazonaws.appflow#GoogleAnalyticsConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required Google Analytics.\n

" + } + }, + "ServiceNow": { + "target": "com.amazonaws.appflow#ServiceNowConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by serviceNow.\n

" + } + }, + "Amplitude": { + "target": "com.amazonaws.appflow#AmplitudeConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Amplitude.\n

" + } + }, + "Trendmicro": { + "target": "com.amazonaws.appflow#TrendmicroConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Trend Micro.\n

" + } + }, + "Slack": { + "target": "com.amazonaws.appflow#SlackConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Slack.\n

" + } + }, + "Veeva": { + "target": "com.amazonaws.appflow#VeevaConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Veeva.\n

" + } + }, + "Marketo": { + "target": "com.amazonaws.appflow#MarketoConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Marketo.\n

" + } + }, + "Datadog": { + "target": "com.amazonaws.appflow#DatadogConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Datadog.\n

" + } + }, + "Redshift": { + "target": "com.amazonaws.appflow#RedshiftConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Amazon Redshift.\n

" + } + }, + "Singular": { + "target": "com.amazonaws.appflow#SingularConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Singular.\n

" + } + }, + "InforNexus": { + "target": "com.amazonaws.appflow#InforNexusConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Infor Nexus.\n

" + } + }, + "Zendesk": { + "target": "com.amazonaws.appflow#ZendeskConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Zendesk.\n

" + } + }, + "Snowflake": { + "target": "com.amazonaws.appflow#SnowflakeConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\nThe connector-specific properties required by Snowflake.\n

" + } + }, + "Dynatrace": { + "target": "com.amazonaws.appflow#DynatraceConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Dynatrace.\n

" + } + }, + "Salesforce": { + "target": "com.amazonaws.appflow#SalesforceConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

\n The connector-specific properties required by Salesforce.\n

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

\n The connector-specific profile properties required by each connector.\n

" + } + }, + "com.amazonaws.appflow#ConnectorServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n An error occurred when retrieving data from the connector endpoint.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appflow#ConnectorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Salesforce", + "name": "SALESFORCE" + }, + { + "value": "Singular", + "name": "SINGULAR" + }, + { + "value": "Slack", + "name": "SLACK" + }, + { + "value": "Redshift", + "name": "REDSHIFT" + }, + { + "value": "S3", + "name": "S3" + }, + { + "value": "Marketo", + "name": "MARKETO" + }, + { + "value": "Googleanalytics", + "name": "GOOGLEANALYTICS" + }, + { + "value": "Zendesk", + "name": "ZENDESK" + }, + { + "value": "Servicenow", + "name": "SERVICENOW" + }, + { + "value": "Datadog", + "name": "DATADOG" + }, + { + "value": "Trendmicro", + "name": "TRENDMICRO" + }, + { + "value": "Snowflake", + "name": "SNOWFLAKE" + }, + { + "value": "Dynatrace", + "name": "DYNATRACE" + }, + { + "value": "Infornexus", + "name": "INFORNEXUS" + }, + { + "value": "Amplitude", + "name": "AMPLITUDE" + }, + { + "value": "Veeva", + "name": "VEEVA" + }, + { + "value": "EventBridge", + "name": "EVENTBRIDGE" + } + ] + } + }, + "com.amazonaws.appflow#ConnectorTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.appflow#CreateConnectorProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#CreateConnectorProfileRequest" + }, + "output": { + "target": "com.amazonaws.appflow#CreateConnectorProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/create-connector-profile", + "code": 200 + } + } + }, + "com.amazonaws.appflow#CreateConnectorProfileRequest": { + "type": "structure", + "members": { + "connectionMode": { + "target": "com.amazonaws.appflow#ConnectionMode", + "traits": { + "smithy.api#documentation": "

\n Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet.\n

", + "smithy.api#required": {} + } + }, + "kmsArn": { + "target": "com.amazonaws.appflow#KMSArn", + "traits": { + "smithy.api#documentation": "

\n The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n

" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\nThe type of connector, such as Salesforce, Amplitude, and so on.\n

", + "smithy.api#required": {} + } + }, + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. The name is unique for each ConnectorProfile in your AWS account.\n

", + "smithy.api#required": {} + } + }, + "connectorProfileConfig": { + "target": "com.amazonaws.appflow#ConnectorProfileConfig", + "traits": { + "smithy.api#documentation": "

\nDefines the connector-specific configuration and credentials.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#CreateConnectorProfileResponse": { + "type": "structure", + "members": { + "connectorProfileArn": { + "target": "com.amazonaws.appflow#ConnectorProfileArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the connector profile.\n

" + } + } + } + }, + "com.amazonaws.appflow#CreateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#CreateFlowRequest" + }, + "output": { + "target": "com.amazonaws.appflow#CreateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#ConnectorServerException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nEnables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.\n \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/create-flow", + "code": 200 + } + } + }, + "com.amazonaws.appflow#CreateFlowRequest": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.appflow#FlowDescription", + "traits": { + "smithy.api#documentation": "

\n A description of the flow you want to create. \n

" + } + }, + "triggerConfig": { + "target": "com.amazonaws.appflow#TriggerConfig", + "traits": { + "smithy.api#documentation": "

\n The trigger settings that determine how and when the flow runs.\n

", + "smithy.api#required": {} + } + }, + "kmsArn": { + "target": "com.amazonaws.appflow#KMSArn", + "traits": { + "smithy.api#documentation": "

\n The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n

" + } + }, + "destinationFlowConfigList": { + "target": "com.amazonaws.appflow#DestinationFlowConfigList", + "traits": { + "smithy.api#documentation": "

\nThe configuration that controls how Amazon AppFlow places data in the destination connector.\n

", + "smithy.api#required": {} + } + }, + "sourceFlowConfig": { + "target": "com.amazonaws.appflow#SourceFlowConfig", + "traits": { + "smithy.api#documentation": "

\nThe configuration that controls how Amazon AppFlow retrieves data from the source connector.\n

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

\nThe tags used to organize, track, or control access for your flow. \n

" + } + }, + "tasks": { + "target": "com.amazonaws.appflow#Tasks", + "traits": { + "smithy.api#documentation": "

\n A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n

", + "smithy.api#required": {} + } + }, + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\nThe specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#CreateFlowResponse": { + "type": "structure", + "members": { + "flowStatus": { + "target": "com.amazonaws.appflow#FlowStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates the current status of the flow.\n

" + } + }, + "flowArn": { + "target": "com.amazonaws.appflow#FlowArn", + "traits": { + "smithy.api#documentation": "

\nThe flow's Amazon Resource Name (ARN).\n

" + } + } + } + }, + "com.amazonaws.appflow#CreatedBy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#DataPullMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Incremental", + "name": "INCREMENTAL" + }, + { + "value": "Complete", + "name": "COMPLETE" + } + ] + } + }, + "com.amazonaws.appflow#DatabaseUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#DatadogConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#DatadogConnectorProfileCredentials": { + "type": "structure", + "members": { + "applicationKey": { + "target": "com.amazonaws.appflow#ApplicationKey", + "traits": { + "smithy.api#documentation": "

\n Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API. \n

", + "smithy.api#required": {} + } + }, + "apiKey": { + "target": "com.amazonaws.appflow#ApiKey", + "traits": { + "smithy.api#documentation": "

\n A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.\n

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

\n The connector-specific credentials required by Datadog.\n

" + } + }, + "com.amazonaws.appflow#DatadogConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Datadog resource.\n

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

\n The connector-specific profile properties required by Datadog.\n

" + } + }, + "com.amazonaws.appflow#DatadogMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Datadog.\n

" + } + }, + "com.amazonaws.appflow#DatadogSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Datadog flow source.\n

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

\n The properties that are applied when Datadog is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#Date": { + "type": "timestamp" + }, + "com.amazonaws.appflow#DeleteConnectorProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DeleteConnectorProfileRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DeleteConnectorProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Enables you to delete an existing connector profile.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-connector-profile", + "code": 200 + } + } + }, + "com.amazonaws.appflow#DeleteConnectorProfileRequest": { + "type": "structure", + "members": { + "forceDelete": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nIndicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.\n

" + } + }, + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. The name is unique for each ConnectorProfile in your account.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#DeleteConnectorProfileResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appflow#DeleteFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DeleteFlowRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DeleteFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time. \n \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-flow", + "code": 200 + } + } + }, + "com.amazonaws.appflow#DeleteFlowRequest": { + "type": "structure", + "members": { + "forceDelete": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.\n

" + } + }, + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#DeleteFlowResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appflow#DescribeConnectorEntity": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DescribeConnectorEntityRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DescribeConnectorEntityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#ConnectorServerException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nProvides details regarding the entity used with the connector, with a description of the data model for each entity. \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-connector-entity", + "code": 200 + } + } + }, + "com.amazonaws.appflow#DescribeConnectorEntityRequest": { + "type": "structure", + "members": { + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.\n

" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n The type of connector application, such as Salesforce, Amplitude, and so on.\n

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

\n The entity name for that connector.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#DescribeConnectorEntityResponse": { + "type": "structure", + "members": { + "connectorEntityFields": { + "target": "com.amazonaws.appflow#ConnectorEntityFieldList", + "traits": { + "smithy.api#documentation": "

\n Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#DescribeConnectorProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DescribeConnectorProfilesRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DescribeConnectorProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result.

\n

If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-connector-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appflow#DescribeConnectorProfilesRequest": { + "type": "structure", + "members": { + "connectorProfileNames": { + "target": "com.amazonaws.appflow#ConnectorProfileNameList", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.\n

" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n The type of connector, such as Salesforce, Amplitude, and so on.\n

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

\n Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).\n

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

\nThe pagination token for the next page of data.\n

" + } + } + } + }, + "com.amazonaws.appflow#DescribeConnectorProfilesResponse": { + "type": "structure", + "members": { + "connectorProfileDetails": { + "target": "com.amazonaws.appflow#ConnectorProfileDetailList", + "traits": { + "smithy.api#documentation": "

\nReturns information about the connector profiles associated with the flow.\n

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

\n The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.\n

" + } + } + } + }, + "com.amazonaws.appflow#DescribeConnectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DescribeConnectorsRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DescribeConnectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow.\n If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page. \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-connectors", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.appflow#DescribeConnectorsRequest": { + "type": "structure", + "members": { + "connectorTypes": { + "target": "com.amazonaws.appflow#ConnectorTypeList", + "traits": { + "smithy.api#documentation": "

\n The type of connector, such as Salesforce, Amplitude, and so on.\n

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

\nThe pagination token for the next page of data.\n

" + } + } + } + }, + "com.amazonaws.appflow#DescribeConnectorsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.appflow#NextToken", + "traits": { + "smithy.api#documentation": "

\nThe pagination token for the next page of data.\n

" + } + }, + "connectorConfigurations": { + "target": "com.amazonaws.appflow#ConnectorConfigurationsMap", + "traits": { + "smithy.api#documentation": "

\n The configuration that is applied to the connectors used in the flow.\n

" + } + } + } + }, + "com.amazonaws.appflow#DescribeFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DescribeFlowRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DescribeFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Provides a description of the specified flow.\n \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-flow", + "code": 200 + } + } + }, + "com.amazonaws.appflow#DescribeFlowExecutionRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DescribeFlowExecutionRecordsRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DescribeFlowExecutionRecordsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nFetches the execution history of the flow.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-flow-execution-records", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appflow#DescribeFlowExecutionRecordsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.appflow#MaxResults", + "traits": { + "smithy.api#documentation": "

\n Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).\n

" + } + }, + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

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

\nThe pagination token for the next page of data.\n

" + } + } + } + }, + "com.amazonaws.appflow#DescribeFlowExecutionRecordsResponse": { + "type": "structure", + "members": { + "flowExecutions": { + "target": "com.amazonaws.appflow#FlowExecutionList", + "traits": { + "smithy.api#documentation": "

\nReturns a list of all instances when this flow was run.\n

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

\n The pagination token for the next page of data.\n

" + } + } + } + }, + "com.amazonaws.appflow#DescribeFlowRequest": { + "type": "structure", + "members": { + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#DescribeFlowResponse": { + "type": "structure", + "members": { + "sourceFlowConfig": { + "target": "com.amazonaws.appflow#SourceFlowConfig", + "traits": { + "smithy.api#documentation": "

\n The configuration that controls how Amazon AppFlow retrieves data from the source connector.\n

" + } + }, + "triggerConfig": { + "target": "com.amazonaws.appflow#TriggerConfig", + "traits": { + "smithy.api#documentation": "

\n The trigger settings that determine how and when the flow runs.\n

" + } + }, + "lastUpdatedBy": { + "target": "com.amazonaws.appflow#UpdatedBy", + "traits": { + "smithy.api#documentation": "

\nSpecifies the user name of the account that performed the most recent update. \n

" + } + }, + "destinationFlowConfigList": { + "target": "com.amazonaws.appflow#DestinationFlowConfigList", + "traits": { + "smithy.api#documentation": "

\n The configuration that controls how Amazon AppFlow transfers data to the destination connector.\n

" + } + }, + "flowStatusMessage": { + "target": "com.amazonaws.appflow#FlowStatusMessage", + "traits": { + "smithy.api#documentation": "

\n Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows. \n

" + } + }, + "kmsArn": { + "target": "com.amazonaws.appflow#KMSArn", + "traits": { + "smithy.api#documentation": "

\n The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\n Specifies when the flow was last updated.\n

" + } + }, + "lastRunExecutionDetails": { + "target": "com.amazonaws.appflow#ExecutionDetails", + "traits": { + "smithy.api#documentation": "

\nDescribes the details of the most recent flow run.\n

" + } + }, + "flowStatus": { + "target": "com.amazonaws.appflow#FlowStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates the current status of the flow.\n

" + } + }, + "tasks": { + "target": "com.amazonaws.appflow#Tasks", + "traits": { + "smithy.api#documentation": "

\n A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n

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

\nSpecifies when the flow was created.\n

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

\n The ARN of the user who created the flow.\n

" + } + }, + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

" + } + }, + "flowArn": { + "target": "com.amazonaws.appflow#FlowArn", + "traits": { + "smithy.api#documentation": "

\n The flow's Amazon Resource Name (ARN).\n

" + } + }, + "description": { + "target": "com.amazonaws.appflow#FlowDescription", + "traits": { + "smithy.api#documentation": "

\n A description of the flow.\n

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

\n The tags used to organize, track, or control access for your flow. \n

" + } + } + } + }, + "com.amazonaws.appflow#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "[\\s\\w/!@#+=.-]*" + } + }, + "com.amazonaws.appflow#DestinationConnectorProperties": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.appflow#S3DestinationProperties", + "traits": { + "smithy.api#documentation": "

\n The properties required to query Amazon S3.\n

" + } + }, + "Redshift": { + "target": "com.amazonaws.appflow#RedshiftDestinationProperties", + "traits": { + "smithy.api#documentation": "

\n The properties required to query Amazon Redshift.\n

" + } + }, + "Salesforce": { + "target": "com.amazonaws.appflow#SalesforceDestinationProperties", + "traits": { + "smithy.api#documentation": "

\n The properties required to query Salesforce.\n

" + } + }, + "EventBridge": { + "target": "com.amazonaws.appflow#EventBridgeDestinationProperties", + "traits": { + "smithy.api#documentation": "

\n The properties required to query Amazon EventBridge.\n

" + } + }, + "Snowflake": { + "target": "com.amazonaws.appflow#SnowflakeDestinationProperties", + "traits": { + "smithy.api#documentation": "

\n The properties required to query Snowflake.\n

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

\n This stores the information that is required to query a particular connector.\n

" + } + }, + "com.amazonaws.appflow#DestinationField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.appflow#DestinationFieldProperties": { + "type": "structure", + "members": { + "isCreatable": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specifies if the destination field can be created by the current user.\n

" + } + }, + "isUpsertable": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.\n

" + } + }, + "isNullable": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specifies if the destination field can have a null value.\n

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

\n The properties that can be applied to a field when connector is being used as a destination.\n

" + } + }, + "com.amazonaws.appflow#DestinationFlowConfig": { + "type": "structure", + "members": { + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. This name must be unique for each connector profile in the AWS account.\n

" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n The type of connector, such as Salesforce, Amplitude, and so on.\n

", + "smithy.api#required": {} + } + }, + "destinationConnectorProperties": { + "target": "com.amazonaws.appflow#DestinationConnectorProperties", + "traits": { + "smithy.api#documentation": "

\n This stores the information that is required to query a particular connector.\n

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

\n Contains information about the configuration of destination connectors present in the flow. \n

" + } + }, + "com.amazonaws.appflow#DestinationFlowConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#DestinationFlowConfig" + } + }, + "com.amazonaws.appflow#DynatraceConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#DynatraceConnectorProfileCredentials": { + "type": "structure", + "members": { + "apiToken": { + "target": "com.amazonaws.appflow#ApiToken", + "traits": { + "smithy.api#documentation": "

\n The API tokens used by Dynatrace API to authenticate various API calls. \n

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

\n The connector-specific profile credentials required by Dynatrace.\n

" + } + }, + "com.amazonaws.appflow#DynatraceConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Dynatrace resource.\n

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

\n The connector-specific profile properties required by Dynatrace.\n

" + } + }, + "com.amazonaws.appflow#DynatraceMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Dynatrace.\n

" + } + }, + "com.amazonaws.appflow#DynatraceSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Dynatrace flow source.\n

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

\n The properties that are applied when Dynatrace is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#EntitiesPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[\\s\\w/!@#+=.-]*" + } + }, + "com.amazonaws.appflow#ErrorHandlingConfig": { + "type": "structure", + "members": { + "bucketPrefix": { + "target": "com.amazonaws.appflow#BucketPrefix", + "traits": { + "smithy.api#documentation": "

\nSpecifies the Amazon S3 bucket prefix.\n

" + } + }, + "bucketName": { + "target": "com.amazonaws.appflow#BucketName", + "traits": { + "smithy.api#documentation": "

\nSpecifies the name of the Amazon S3 bucket.\n

" + } + }, + "failOnFirstDestinationError": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nSpecifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.\n

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

\n The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.\n \n

" + } + }, + "com.amazonaws.appflow#ErrorInfo": { + "type": "structure", + "members": { + "executionMessage": { + "target": "com.amazonaws.appflow#ExecutionMessage", + "traits": { + "smithy.api#documentation": "

\nSpecifies the error message that appears if a flow fails.\n

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

\nSpecifies the failure count for the attempted flow.\n

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

\nProvides details in the event of a failed flow, including the failure count and the related error messages.\n

" + } + }, + "com.amazonaws.appflow#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "[\\s\\w/!@#+=.-]*" + } + }, + "com.amazonaws.appflow#EventBridgeDestinationProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Amazon EventBridge flow destination.\n

", + "smithy.api#required": {} + } + }, + "errorHandlingConfig": { + "target": "com.amazonaws.appflow#ErrorHandlingConfig" + } + }, + "traits": { + "smithy.api#documentation": "

\n The properties that are applied when Amazon EventBridge is being used as a destination.\n

" + } + }, + "com.amazonaws.appflow#EventBridgeMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amazon EventBridge.\n

" + } + }, + "com.amazonaws.appflow#ExecutionDetails": { + "type": "structure", + "members": { + "mostRecentExecutionStatus": { + "target": "com.amazonaws.appflow#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

\n Specifies the status of the most recent flow run.\n

" + } + }, + "mostRecentExecutionTime": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\n Specifies the time of the most recent flow run.\n

" + } + }, + "mostRecentExecutionMessage": { + "target": "com.amazonaws.appflow#MostRecentExecutionMessage", + "traits": { + "smithy.api#documentation": "

\n Describes the details of the most recent flow run.\n

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

\n Describes the details of the flow run, including the timestamp, status, and message.\n

" + } + }, + "com.amazonaws.appflow#ExecutionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#ExecutionMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "[\\s\\w/!@#+=.-]*" + } + }, + "com.amazonaws.appflow#ExecutionRecord": { + "type": "structure", + "members": { + "executionStatus": { + "target": "com.amazonaws.appflow#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

\nSpecifies the flow run status and whether it is in progress, has completed successfully, or has failed.\n

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\n Specifies the time of the most recent update.\n

" + } + }, + "executionId": { + "target": "com.amazonaws.appflow#ExecutionId", + "traits": { + "smithy.api#documentation": "

\nSpecifies the identifier of the given flow run.\n

" + } + }, + "executionResult": { + "target": "com.amazonaws.appflow#ExecutionResult", + "traits": { + "smithy.api#documentation": "

\nDescribes the result of the given flow run.\n

" + } + }, + "startedAt": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\nSpecifies the start time of the flow run.\n

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

\nSpecifies information about the past flow run instances for a given flow.\n

" + } + }, + "com.amazonaws.appflow#ExecutionResult": { + "type": "structure", + "members": { + "bytesProcessed": { + "target": "com.amazonaws.appflow#Long", + "traits": { + "smithy.api#documentation": "

\n The total number of bytes processed by the flow run.\n

" + } + }, + "errorInfo": { + "target": "com.amazonaws.appflow#ErrorInfo", + "traits": { + "smithy.api#documentation": "

\nProvides any error message information related to the flow run.\n

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

\n The total number of bytes written as a result of the flow run.\n

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

\nThe number of records processed in the flow run.\n

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

\nSpecifies the end result of the flow run.\n

" + } + }, + "com.amazonaws.appflow#ExecutionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InProgress", + "name": "INPROGRESS" + }, + { + "value": "Successful", + "name": "SUCCESSFUL" + }, + { + "value": "Error", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.appflow#FieldType": { + "type": "string" + }, + "com.amazonaws.appflow#FieldTypeDetails": { + "type": "structure", + "members": { + "filterOperators": { + "target": "com.amazonaws.appflow#FilterOperatorList", + "traits": { + "smithy.api#documentation": "

\nThe list of operators supported by a field.\n

", + "smithy.api#required": {} + } + }, + "supportedValues": { + "target": "com.amazonaws.appflow#SupportedValueList", + "traits": { + "smithy.api#documentation": "

\n The list of values that a field can contain. For example, a Boolean fieldType can have two values: \"true\" and \"false\". \n

" + } + }, + "fieldType": { + "target": "com.amazonaws.appflow#FieldType", + "traits": { + "smithy.api#documentation": "

\nThe type of field, such as string, integer, date, and so on.\n

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

\n Contains details regarding the supported field type and the operators that can be applied for filtering.\n

" + } + }, + "com.amazonaws.appflow#FileType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "JSON", + "name": "JSON" + }, + { + "value": "PARQUET", + "name": "PARQUET" + } + ] + } + }, + "com.amazonaws.appflow#FilterOperatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#Operator" + } + }, + "com.amazonaws.appflow#FlowArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "arn:aws:appflow:.*:[0-9]+:.*" + } + }, + "com.amazonaws.appflow#FlowDefinition": { + "type": "structure", + "members": { + "lastUpdatedBy": { + "target": "com.amazonaws.appflow#UpdatedBy", + "traits": { + "smithy.api#documentation": "

\n Specifies the account user name that most recently updated the flow. \n

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\n Specifies when the flow was last updated.\n

" + } + }, + "lastRunExecutionDetails": { + "target": "com.amazonaws.appflow#ExecutionDetails", + "traits": { + "smithy.api#documentation": "

\n Describes the details of the most recent flow run.\n

" + } + }, + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

" + } + }, + "description": { + "target": "com.amazonaws.appflow#FlowDescription", + "traits": { + "smithy.api#documentation": "

\n A user-entered description of the flow.\n

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

\n The ARN of the user who created the flow.\n

" + } + }, + "flowArn": { + "target": "com.amazonaws.appflow#FlowArn", + "traits": { + "smithy.api#documentation": "

\n The flow's Amazon Resource Name (ARN).\n

" + } + }, + "sourceConnectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.\n

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

\nThe tags used to organize, track, or control access for your flow. \n

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

\n Specifies when the flow was created.\n

" + } + }, + "destinationConnectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.\n

" + } + }, + "triggerType": { + "target": "com.amazonaws.appflow#TriggerType", + "traits": { + "smithy.api#documentation": "

\n Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.\n

" + } + }, + "flowStatus": { + "target": "com.amazonaws.appflow#FlowStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates the current status of the flow.\n

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

\nThe properties of the flow, such as its source, destination, trigger type, and so on.\n

" + } + }, + "com.amazonaws.appflow#FlowDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "[\\w!@#\\-.?,\\s]*" + } + }, + "com.amazonaws.appflow#FlowExecutionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ExecutionRecord" + } + }, + "com.amazonaws.appflow#FlowList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#FlowDefinition" + } + }, + "com.amazonaws.appflow#FlowName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[a-zA-Z0-9][\\w!@#.-]+" + } + }, + "com.amazonaws.appflow#FlowStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Active", + "name": "ACTIVE" + }, + { + "value": "Deprecated", + "name": "DEPRECATED" + }, + { + "value": "Deleted", + "name": "DELETED" + }, + { + "value": "Draft", + "name": "DRAFT" + }, + { + "value": "Errored", + "name": "ERRORED" + }, + { + "value": "Suspended", + "name": "SUSPENDED" + } + ] + } + }, + "com.amazonaws.appflow#FlowStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "[\\s\\w/!@#+=.-]*" + } + }, + "com.amazonaws.appflow#GoogleAnalyticsConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + } + ] + } + }, + "com.amazonaws.appflow#GoogleAnalyticsConnectorProfileCredentials": { + "type": "structure", + "members": { + "clientSecret": { + "target": "com.amazonaws.appflow#ClientSecret", + "traits": { + "smithy.api#documentation": "

\n The client secret used by the oauth client to authenticate to the authorization server. \n

", + "smithy.api#required": {} + } + }, + "oAuthRequest": { + "target": "com.amazonaws.appflow#ConnectorOAuthRequest", + "traits": { + "smithy.api#documentation": "

\n The oauth requirement needed to request security tokens from the connector endpoint.\n

" + } + }, + "clientId": { + "target": "com.amazonaws.appflow#ClientId", + "traits": { + "smithy.api#documentation": "

\n The identifier for the desired client.\n

", + "smithy.api#required": {} + } + }, + "refreshToken": { + "target": "com.amazonaws.appflow#RefreshToken", + "traits": { + "smithy.api#documentation": "

\n The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.\n

" + } + }, + "accessToken": { + "target": "com.amazonaws.appflow#AccessToken", + "traits": { + "smithy.api#documentation": "

\nThe credentials used to access protected Google Analytics resources.\n

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

\n The connector-specific profile credentials required by Google Analytics.\n

" + } + }, + "com.amazonaws.appflow#GoogleAnalyticsConnectorProfileProperties": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector-specific profile properties required by Google Analytics.\n

" + } + }, + "com.amazonaws.appflow#GoogleAnalyticsMetadata": { + "type": "structure", + "members": { + "oAuthScopes": { + "target": "com.amazonaws.appflow#OAuthScopeList", + "traits": { + "smithy.api#documentation": "

\n The desired authorization scope for the Google Analytics account.\n

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

\n The connector metadata specific to Google Analytics.\n

" + } + }, + "com.amazonaws.appflow#GoogleAnalyticsSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Google Analytics flow source.\n

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

\n The properties that are applied when Google Analytics is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#Group": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#InforNexusConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#InforNexusConnectorProfileCredentials": { + "type": "structure", + "members": { + "secretAccessKey": { + "target": "com.amazonaws.appflow#Key", + "traits": { + "smithy.api#documentation": "

\n The secret key used to sign requests.\n

", + "smithy.api#required": {} + } + }, + "accessKeyId": { + "target": "com.amazonaws.appflow#AccessKeyId", + "traits": { + "smithy.api#documentation": "

\n The Access Key portion of the credentials.\n

", + "smithy.api#required": {} + } + }, + "datakey": { + "target": "com.amazonaws.appflow#Key", + "traits": { + "smithy.api#documentation": "

\n The encryption keys used to encrypt data.\n

", + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.appflow#Username", + "traits": { + "smithy.api#documentation": "

\n The identifier for the user.\n

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

\n The connector-specific profile credentials required by Infor Nexus.\n

" + } + }, + "com.amazonaws.appflow#InforNexusConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Infor Nexus resource.\n

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

\n The connector-specific profile properties required by Infor Nexus.\n

" + } + }, + "com.amazonaws.appflow#InforNexusMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Infor Nexus.\n

" + } + }, + "com.amazonaws.appflow#InforNexusSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Infor Nexus flow source.\n

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

\n The properties that are applied when Infor Nexus is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#InstanceUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n An internal service error occurred during the processing of your request. Try again later.\n

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.appflow#KMSArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "arn:aws:kms:.*:[0-9]+:.*" + } + }, + "com.amazonaws.appflow#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#Label": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.appflow#ListConnectorEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#ListConnectorEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.appflow#ListConnectorEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#ConnectorServerException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity. \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-connector-entities", + "code": 200 + } + } + }, + "com.amazonaws.appflow#ListConnectorEntitiesRequest": { + "type": "structure", + "members": { + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n The type of connector, such as Salesforce, Amplitude, and so on.\n

" + } + }, + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account, and is used to query the downstream connector.\n

" + } + }, + "entitiesPath": { + "target": "com.amazonaws.appflow#EntitiesPath", + "traits": { + "smithy.api#documentation": "

\n This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.\n

" + } + } + } + }, + "com.amazonaws.appflow#ListConnectorEntitiesResponse": { + "type": "structure", + "members": { + "connectorEntityMap": { + "target": "com.amazonaws.appflow#ConnectorEntityMap", + "traits": { + "smithy.api#documentation": "

\n The response of ListConnectorEntities lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#ListFlows": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#ListFlowsRequest" + }, + "output": { + "target": "com.amazonaws.appflow#ListFlowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nLists all of the flows associated with your account.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-flows", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appflow#ListFlowsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.appflow#MaxResults", + "traits": { + "smithy.api#documentation": "

\n Specifies the maximum number of items that should be returned in the result set.\n

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

\n The pagination token for next page of data.\n

" + } + } + } + }, + "com.amazonaws.appflow#ListFlowsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.appflow#NextToken", + "traits": { + "smithy.api#documentation": "

\nThe pagination token for next page of data.\n

" + } + }, + "flows": { + "target": "com.amazonaws.appflow#FlowList", + "traits": { + "smithy.api#documentation": "

\nThe list of flows associated with your account.\n

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

\nRetrieves the tags that are associated with a specified flow.\n

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appflow#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appflow#ARN", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the specified flow. \n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.appflow#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags used to organize, track, or control access for your flow. \n

" + } + } + } + }, + "com.amazonaws.appflow#Long": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.appflow#MarketoConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#MarketoConnectorProfileCredentials": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.appflow#ClientId", + "traits": { + "smithy.api#documentation": "

\n The identifier for the desired client.\n

", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.appflow#ClientSecret", + "traits": { + "smithy.api#documentation": "

\n The client secret used by the oauth client to authenticate to the authorization server. \n

", + "smithy.api#required": {} + } + }, + "accessToken": { + "target": "com.amazonaws.appflow#AccessToken", + "traits": { + "smithy.api#documentation": "

\n The credentials used to access protected Marketo resources.\n

" + } + }, + "oAuthRequest": { + "target": "com.amazonaws.appflow#ConnectorOAuthRequest", + "traits": { + "smithy.api#documentation": "

\n The oauth requirement needed to request security tokens from the connector endpoint.\n

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

\n The connector-specific profile credentials required by Marketo.\n

" + } + }, + "com.amazonaws.appflow#MarketoConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Marketo resource.\n

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

\n The connector-specific profile properties required when using Marketo.\n

" + } + }, + "com.amazonaws.appflow#MarketoMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Marketo.\n

" + } + }, + "com.amazonaws.appflow#MarketoSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Marketo flow source.\n

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

\n The properties that are applied when Marketo is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.appflow#MostRecentExecutionMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "[\\w!@#\\-.?,\\s]*" + } + }, + "com.amazonaws.appflow#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#OAuthScope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "[\\w]*" + } + }, + "com.amazonaws.appflow#OAuthScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#OAuthScope" + } + }, + "com.amazonaws.appflow#Object": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#Operator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "NOT_EQUAL_TO", + "name": "NOT_EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#OperatorPropertiesKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VALUE", + "name": "VALUE" + }, + { + "value": "VALUES", + "name": "VALUES" + }, + { + "value": "DATA_TYPE", + "name": "DATA_TYPE" + }, + { + "value": "UPPER_BOUND", + "name": "UPPER_BOUND" + }, + { + "value": "LOWER_BOUND", + "name": "LOWER_BOUND" + }, + { + "value": "SOURCE_DATA_TYPE", + "name": "SOURCE_DATA_TYPE" + }, + { + "value": "DESTINATION_DATA_TYPE", + "name": "DESTINATION_DATA_TYPE" + }, + { + "value": "VALIDATION_ACTION", + "name": "VALIDATION_ACTION" + }, + { + "value": "MASK_VALUE", + "name": "MASK_VALUE" + }, + { + "value": "MASK_LENGTH", + "name": "MASK_LENGTH" + }, + { + "value": "TRUNCATE_LENGTH", + "name": "TRUNCATE_LENGTH" + }, + { + "value": "MATH_OPERATION_FIELDS_ORDER", + "name": "MATH_OPERATION_FIELDS_ORDER" + }, + { + "value": "CONCAT_FORMAT", + "name": "CONCAT_FORMAT" + }, + { + "value": "SUBFIELD_CATEGORY_MAP", + "name": "SUBFIELD_CATEGORY_MAP" + } + ] + } + }, + "com.amazonaws.appflow#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#PrefixConfig": { + "type": "structure", + "members": { + "prefixType": { + "target": "com.amazonaws.appflow#PrefixType", + "traits": { + "smithy.api#documentation": "

\n Determines the level of granularity that's included in the prefix.\n

" + } + }, + "prefixFormat": { + "target": "com.amazonaws.appflow#PrefixFormat", + "traits": { + "smithy.api#documentation": "

\nDetermines the format of the prefix, and whether it applies to the file name, file path, or both.\n

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

\nDetermines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date. \n

" + } + }, + "com.amazonaws.appflow#PrefixFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "YEAR", + "name": "YEAR" + }, + { + "value": "MONTH", + "name": "MONTH" + }, + { + "value": "DAY", + "name": "DAY" + }, + { + "value": "HOUR", + "name": "HOUR" + }, + { + "value": "MINUTE", + "name": "MINUTE" + } + ] + } + }, + "com.amazonaws.appflow#PrefixType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FILENAME", + "name": "FILENAME" + }, + { + "value": "PATH", + "name": "PATH" + }, + { + "value": "PATH_AND_FILENAME", + "name": "PATH_AND_FILENAME" + } + ] + } + }, + "com.amazonaws.appflow#PrivateLinkServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#Property": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".+" + } + }, + "com.amazonaws.appflow#RedirectUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#RedshiftConnectorProfileCredentials": { + "type": "structure", + "members": { + "username": { + "target": "com.amazonaws.appflow#Username", + "traits": { + "smithy.api#documentation": "

\n The name of the user.\n

", + "smithy.api#required": {} + } + }, + "password": { + "target": "com.amazonaws.appflow#Password", + "traits": { + "smithy.api#documentation": "

\n The password that corresponds to the user name.\n

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

\n The connector-specific profile credentials required when using Amazon Redshift.\n

" + } + }, + "com.amazonaws.appflow#RedshiftConnectorProfileProperties": { + "type": "structure", + "members": { + "bucketPrefix": { + "target": "com.amazonaws.appflow#BucketPrefix", + "traits": { + "smithy.api#documentation": "

\n The object key for the destination bucket in which Amazon AppFlow places the files.\n

" + } + }, + "bucketName": { + "target": "com.amazonaws.appflow#BucketName", + "traits": { + "smithy.api#documentation": "

\n A name for the associated Amazon S3 bucket. \n

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.appflow#RoleArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role.\n

", + "smithy.api#required": {} + } + }, + "databaseUrl": { + "target": "com.amazonaws.appflow#DatabaseUrl", + "traits": { + "smithy.api#documentation": "

\nThe JDBC URL of the Amazon Redshift cluster.\n

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

\n The connector-specific profile properties when using Amazon Redshift.\n

" + } + }, + "com.amazonaws.appflow#RedshiftDestinationProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Amazon Redshift flow destination.\n

", + "smithy.api#required": {} + } + }, + "errorHandlingConfig": { + "target": "com.amazonaws.appflow#ErrorHandlingConfig", + "traits": { + "smithy.api#documentation": "

\n The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.\n

" + } + }, + "intermediateBucketName": { + "target": "com.amazonaws.appflow#BucketName", + "traits": { + "smithy.api#documentation": "

\n The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.\n

", + "smithy.api#required": {} + } + }, + "bucketPrefix": { + "target": "com.amazonaws.appflow#BucketPrefix", + "traits": { + "smithy.api#documentation": "

\n The object key for the bucket in which Amazon AppFlow places the destination files.\n

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

\n The properties that are applied when Amazon Redshift is being used as a destination.\n

" + } + }, + "com.amazonaws.appflow#RedshiftMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amazon Redshift.\n

" + } + }, + "com.amazonaws.appflow#RefreshToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#Region" + } + }, + "com.amazonaws.appflow#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n The resource specified in the request (such as the source or destination connector profile) is not found.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.appflow#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "arn:aws:iam:.*:[0-9]+:.*" + } + }, + "com.amazonaws.appflow#S3ConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "NOT_EQUAL_TO", + "name": "NOT_EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#S3DestinationProperties": { + "type": "structure", + "members": { + "s3OutputFormatConfig": { + "target": "com.amazonaws.appflow#S3OutputFormatConfig" + }, + "bucketPrefix": { + "target": "com.amazonaws.appflow#BucketPrefix", + "traits": { + "smithy.api#documentation": "

\n The object key for the destination bucket in which Amazon AppFlow places the files.\n

" + } + }, + "bucketName": { + "target": "com.amazonaws.appflow#BucketName", + "traits": { + "smithy.api#documentation": "

\n The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.\n

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

\n The properties that are applied when Amazon S3 is used as a destination.\n

" + } + }, + "com.amazonaws.appflow#S3Metadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Amazon S3.\n

" + } + }, + "com.amazonaws.appflow#S3OutputFormatConfig": { + "type": "structure", + "members": { + "fileType": { + "target": "com.amazonaws.appflow#FileType", + "traits": { + "smithy.api#documentation": "

\nIndicates the file type that Amazon AppFlow places in the Amazon S3 bucket.\n

" + } + }, + "prefixConfig": { + "target": "com.amazonaws.appflow#PrefixConfig", + "traits": { + "smithy.api#documentation": "

\n Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date. \n

" + } + }, + "aggregationConfig": { + "target": "com.amazonaws.appflow#AggregationConfig" + } + }, + "traits": { + "smithy.api#documentation": "

\nThe configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.\n

" + } + }, + "com.amazonaws.appflow#S3SourceProperties": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.appflow#BucketName", + "traits": { + "smithy.api#documentation": "

\n The Amazon S3 bucket name where the source files are stored. \n

", + "smithy.api#required": {} + } + }, + "bucketPrefix": { + "target": "com.amazonaws.appflow#BucketPrefix", + "traits": { + "smithy.api#documentation": "

\n The object key for the Amazon S3 bucket in which the source files are stored.\n

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

\n The properties that are applied when Amazon S3 is being used as the flow source.\n

" + } + }, + "com.amazonaws.appflow#SalesforceConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "NOT_EQUAL_TO", + "name": "NOT_EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#SalesforceConnectorProfileCredentials": { + "type": "structure", + "members": { + "accessToken": { + "target": "com.amazonaws.appflow#AccessToken", + "traits": { + "smithy.api#documentation": "

\n The credentials used to access protected Salesforce resources.\n

" + } + }, + "refreshToken": { + "target": "com.amazonaws.appflow#RefreshToken", + "traits": { + "smithy.api#documentation": "

\n The credentials used to acquire new access tokens. \n

" + } + }, + "oAuthRequest": { + "target": "com.amazonaws.appflow#ConnectorOAuthRequest", + "traits": { + "smithy.api#documentation": "

\n The oauth requirement needed to request security tokens from the connector endpoint.\n

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

\n The connector-specific profile credentials required when using Salesforce.\n

" + } + }, + "com.amazonaws.appflow#SalesforceConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Salesforce resource.\n

" + } + }, + "isSandboxEnvironment": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the connector profile applies to a sandbox or production environment. \n

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

\n The connector-specific profile properties required when using Salesforce.\n

" + } + }, + "com.amazonaws.appflow#SalesforceDestinationProperties": { + "type": "structure", + "members": { + "errorHandlingConfig": { + "target": "com.amazonaws.appflow#ErrorHandlingConfig", + "traits": { + "smithy.api#documentation": "

\n The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.\n

" + } + }, + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Salesforce flow destination.\n

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

\n The properties that are applied when Salesforce is being used as a destination.\n

" + } + }, + "com.amazonaws.appflow#SalesforceMetadata": { + "type": "structure", + "members": { + "oAuthScopes": { + "target": "com.amazonaws.appflow#OAuthScopeList", + "traits": { + "smithy.api#documentation": "

\n The desired authorization scope for the Salesforce account.\n

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

\n The connector metadata specific to Salesforce.\n

" + } + }, + "com.amazonaws.appflow#SalesforceSourceProperties": { + "type": "structure", + "members": { + "includeDeletedRecords": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Indicates whether Amazon AppFlow includes deleted files in the flow run.\n

" + } + }, + "enableDynamicFieldUpdate": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nThe flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.\n

" + } + }, + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Salesforce flow source.\n

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

\n The properties that are applied when Salesforce is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#SandstoneConfigurationServiceLambda": { + "type": "service", + "version": "2020-08-23", + "operations": [ + { + "target": "com.amazonaws.appflow#CreateConnectorProfile" + }, + { + "target": "com.amazonaws.appflow#CreateFlow" + }, + { + "target": "com.amazonaws.appflow#DeleteConnectorProfile" + }, + { + "target": "com.amazonaws.appflow#DeleteFlow" + }, + { + "target": "com.amazonaws.appflow#DescribeConnectorEntity" + }, + { + "target": "com.amazonaws.appflow#DescribeConnectorProfiles" + }, + { + "target": "com.amazonaws.appflow#DescribeConnectors" + }, + { + "target": "com.amazonaws.appflow#DescribeFlow" + }, + { + "target": "com.amazonaws.appflow#DescribeFlowExecutionRecords" + }, + { + "target": "com.amazonaws.appflow#ListConnectorEntities" + }, + { + "target": "com.amazonaws.appflow#ListFlows" + }, + { + "target": "com.amazonaws.appflow#ListTagsForResource" + }, + { + "target": "com.amazonaws.appflow#StartFlow" + }, + { + "target": "com.amazonaws.appflow#StopFlow" + }, + { + "target": "com.amazonaws.appflow#TagResource" + }, + { + "target": "com.amazonaws.appflow#UntagResource" + }, + { + "target": "com.amazonaws.appflow#UpdateConnectorProfile" + }, + { + "target": "com.amazonaws.appflow#UpdateFlow" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Appflow", + "arnNamespace": "appflow", + "cloudFormationName": "Appflow", + "cloudTrailEventSource": "appflow.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "appflow" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types, and errors.

\n \n

Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift.

\n \n\n \n

Use the following links to get started on the Amazon AppFlow API:

\n \n \n \n

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide.

\n

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as auth-code and redirecturi) with the connector-specific ConnectorProfileProperties when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the \n Authorize Apps with OAuth\n documentation.

", + "smithy.api#title": "Amazon Appflow" + } + }, + "com.amazonaws.appflow#ScheduleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.appflow#ScheduleFrequencyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BYMINUTE", + "name": "BYMINUTE" + }, + { + "value": "HOURLY", + "name": "HOURLY" + }, + { + "value": "DAILY", + "name": "DAILY" + }, + { + "value": "WEEKLY", + "name": "WEEKLY" + }, + { + "value": "MONTHLY", + "name": "MONTHLY" + }, + { + "value": "ONCE", + "name": "ONCE" + } + ] + } + }, + "com.amazonaws.appflow#ScheduledTriggerProperties": { + "type": "structure", + "members": { + "scheduleStartTime": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\nSpecifies the scheduled start time for a schedule-triggered flow.\n

" + } + }, + "scheduleEndTime": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

\n Specifies the scheduled end time for a schedule-triggered flow.\n

" + } + }, + "scheduleExpression": { + "target": "com.amazonaws.appflow#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

\n The scheduling expression that determines when and how often the rule runs.\n

", + "smithy.api#required": {} + } + }, + "dataPullMode": { + "target": "com.amazonaws.appflow#DataPullMode", + "traits": { + "smithy.api#documentation": "

\n Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.\n

" + } + }, + "timezone": { + "target": "com.amazonaws.appflow#Timezone", + "traits": { + "smithy.api#documentation": "

\nSpecifies the time zone used when referring to the date and time of a scheduled-triggered flow. \n

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

\n Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.\n

" + } + }, + "com.amazonaws.appflow#SchedulingFrequencyTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ScheduleFrequencyType" + } + }, + "com.amazonaws.appflow#SecretKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#ServiceNowConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "NOT_EQUAL_TO", + "name": "NOT_EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#ServiceNowConnectorProfileCredentials": { + "type": "structure", + "members": { + "password": { + "target": "com.amazonaws.appflow#Password", + "traits": { + "smithy.api#documentation": "

\n The password that corresponds to the user name.\n

", + "smithy.api#required": {} + } + }, + "username": { + "target": "com.amazonaws.appflow#Username", + "traits": { + "smithy.api#documentation": "

\n The name of the user.\n

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

\n The connector-specific profile credentials required when using ServiceNow.\n

" + } + }, + "com.amazonaws.appflow#ServiceNowConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the ServiceNow resource.\n

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

\n The connector-specific profile properties required when using ServiceNow.\n

" + } + }, + "com.amazonaws.appflow#ServiceNowMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to ServiceNow.\n

" + } + }, + "com.amazonaws.appflow#ServiceNowSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the ServiceNow flow source.\n

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

\n The properties that are applied when ServiceNow is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\nThe request would cause a service quota (such as the number of flows) to be exceeded.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.appflow#SingularConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#SingularConnectorProfileCredentials": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.appflow#ApiKey", + "traits": { + "smithy.api#documentation": "

A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.\n

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

\n The connector-specific profile credentials required when using Singular.\n

" + } + }, + "com.amazonaws.appflow#SingularConnectorProfileProperties": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector-specific profile properties required when using Singular.\n

" + } + }, + "com.amazonaws.appflow#SingularMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Singular.\n

" + } + }, + "com.amazonaws.appflow#SingularSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Singular flow source.\n

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

\n The properties that are applied when Singular is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#SlackConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#SlackConnectorProfileCredentials": { + "type": "structure", + "members": { + "clientSecret": { + "target": "com.amazonaws.appflow#ClientSecret", + "traits": { + "smithy.api#documentation": "

\n The client secret used by the oauth client to authenticate to the authorization server. \n

", + "smithy.api#required": {} + } + }, + "accessToken": { + "target": "com.amazonaws.appflow#AccessToken", + "traits": { + "smithy.api#documentation": "

\n The credentials used to access protected Slack resources.\n

" + } + }, + "clientId": { + "target": "com.amazonaws.appflow#ClientId", + "traits": { + "smithy.api#documentation": "

\n The identifier for the client.\n

", + "smithy.api#required": {} + } + }, + "oAuthRequest": { + "target": "com.amazonaws.appflow#ConnectorOAuthRequest", + "traits": { + "smithy.api#documentation": "

\n The oauth requirement needed to request security tokens from the connector endpoint.\n

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

\n The connector-specific profile credentials required when using Slack.\n

" + } + }, + "com.amazonaws.appflow#SlackConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Slack resource.\n

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

\n The connector-specific profile properties required when using Slack.\n

" + } + }, + "com.amazonaws.appflow#SlackMetadata": { + "type": "structure", + "members": { + "oAuthScopes": { + "target": "com.amazonaws.appflow#OAuthScopeList", + "traits": { + "smithy.api#documentation": "

\nThe desired authorization scope for the Slack account.\n

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

\n The connector metadata specific to Slack.\n

" + } + }, + "com.amazonaws.appflow#SlackSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Slack flow source.\n

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

\n The properties that are applied when Slack is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#SnowflakeConnectorProfileCredentials": { + "type": "structure", + "members": { + "password": { + "target": "com.amazonaws.appflow#Password", + "traits": { + "smithy.api#documentation": "

\nThe password that corresponds to the user name.\n

", + "smithy.api#required": {} + } + }, + "username": { + "target": "com.amazonaws.appflow#Username", + "traits": { + "smithy.api#documentation": "

\n The name of the user.\n

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

\n The connector-specific profile credentials required when using Snowflake.\n

" + } + }, + "com.amazonaws.appflow#SnowflakeConnectorProfileProperties": { + "type": "structure", + "members": { + "region": { + "target": "com.amazonaws.appflow#Region", + "traits": { + "smithy.api#documentation": "

\nThe AWS Region of the Snowflake account.\n

" + } + }, + "bucketName": { + "target": "com.amazonaws.appflow#BucketName", + "traits": { + "smithy.api#documentation": "

\n The name of the Amazon S3 bucket associated with Snowflake.\n

", + "smithy.api#required": {} + } + }, + "bucketPrefix": { + "target": "com.amazonaws.appflow#BucketPrefix", + "traits": { + "smithy.api#documentation": "

\n The bucket path that refers to the Amazon S3 bucket associated with Snowflake.\n

" + } + }, + "privateLinkServiceName": { + "target": "com.amazonaws.appflow#PrivateLinkServiceName", + "traits": { + "smithy.api#documentation": "

\nThe Snowflake Private Link service name to be used for private data transfers.\n

" + } + }, + "accountName": { + "target": "com.amazonaws.appflow#AccountName", + "traits": { + "smithy.api#documentation": "

\nThe name of the account.\n

" + } + }, + "stage": { + "target": "com.amazonaws.appflow#Stage", + "traits": { + "smithy.api#documentation": "

\n The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema>.\n

", + "smithy.api#required": {} + } + }, + "warehouse": { + "target": "com.amazonaws.appflow#Warehouse", + "traits": { + "smithy.api#documentation": "

\nThe name of the Snowflake warehouse.\n

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

\n The connector-specific profile properties required when using Snowflake.\n

" + } + }, + "com.amazonaws.appflow#SnowflakeDestinationProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Snowflake flow destination.\n

", + "smithy.api#required": {} + } + }, + "errorHandlingConfig": { + "target": "com.amazonaws.appflow#ErrorHandlingConfig", + "traits": { + "smithy.api#documentation": "

\n The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.\n

" + } + }, + "bucketPrefix": { + "target": "com.amazonaws.appflow#BucketPrefix", + "traits": { + "smithy.api#documentation": "

\n The object key for the destination bucket in which Amazon AppFlow places the files.\n

" + } + }, + "intermediateBucketName": { + "target": "com.amazonaws.appflow#BucketName", + "traits": { + "smithy.api#documentation": "

\n The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.\n

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

\n The properties that are applied when Snowflake is being used as a destination.\n

" + } + }, + "com.amazonaws.appflow#SnowflakeMetadata": { + "type": "structure", + "members": { + "supportedRegions": { + "target": "com.amazonaws.appflow#RegionList", + "traits": { + "smithy.api#documentation": "

\nSpecifies the supported AWS Regions when using Snowflake.\n

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

\n The connector metadata specific to Snowflake.\n

" + } + }, + "com.amazonaws.appflow#SourceConnectorProperties": { + "type": "structure", + "members": { + "ServiceNow": { + "target": "com.amazonaws.appflow#ServiceNowSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying ServiceNow.\n

" + } + }, + "Trendmicro": { + "target": "com.amazonaws.appflow#TrendmicroSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Trend Micro.\n

" + } + }, + "S3": { + "target": "com.amazonaws.appflow#S3SourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Amazon S3.\n

" + } + }, + "Salesforce": { + "target": "com.amazonaws.appflow#SalesforceSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Salesforce.\n

" + } + }, + "Veeva": { + "target": "com.amazonaws.appflow#VeevaSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Veeva.\n

" + } + }, + "Dynatrace": { + "target": "com.amazonaws.appflow#DynatraceSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Dynatrace.\n

" + } + }, + "InforNexus": { + "target": "com.amazonaws.appflow#InforNexusSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Infor Nexus.\n

" + } + }, + "Zendesk": { + "target": "com.amazonaws.appflow#ZendeskSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Zendesk.\n

" + } + }, + "Amplitude": { + "target": "com.amazonaws.appflow#AmplitudeSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Amplitude.\n

" + } + }, + "Slack": { + "target": "com.amazonaws.appflow#SlackSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Slack.\n

" + } + }, + "Datadog": { + "target": "com.amazonaws.appflow#DatadogSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Datadog.\n

" + } + }, + "Singular": { + "target": "com.amazonaws.appflow#SingularSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Singular.\n

" + } + }, + "Marketo": { + "target": "com.amazonaws.appflow#MarketoSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Marketo.\n

" + } + }, + "GoogleAnalytics": { + "target": "com.amazonaws.appflow#GoogleAnalyticsSourceProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required for querying Google Analytics.\n

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

\n Specifies the information that is required to query a particular connector.\n

" + } + }, + "com.amazonaws.appflow#SourceFieldProperties": { + "type": "structure", + "members": { + "isRetrievable": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\nIndicates whether the field can be returned in a search result. \n

" + } + }, + "isQueryable": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

\n Indicates if the field can be queried.\n

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

\n The properties that can be applied to a field when the connector is being used as a source.\n

" + } + }, + "com.amazonaws.appflow#SourceFields": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#String" + } + }, + "com.amazonaws.appflow#SourceFlowConfig": { + "type": "structure", + "members": { + "sourceConnectorProperties": { + "target": "com.amazonaws.appflow#SourceConnectorProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the information that is required to query a particular source connector.\n

", + "smithy.api#required": {} + } + }, + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile. This name must be unique for each connector profile in the AWS account.\n

" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

\n The type of connector, such as Salesforce, Amplitude, and so on.\n

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

\n Contains information about the configuration of the source connector used in the flow. \n

" + } + }, + "com.amazonaws.appflow#Stage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#StartFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#StartFlowRequest" + }, + "output": { + "target": "com.amazonaws.appflow#StartFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\nActivates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.\n \n

", + "smithy.api#http": { + "method": "POST", + "uri": "/start-flow", + "code": 200 + } + } + }, + "com.amazonaws.appflow#StartFlowRequest": { + "type": "structure", + "members": { + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#StartFlowResponse": { + "type": "structure", + "members": { + "flowStatus": { + "target": "com.amazonaws.appflow#FlowStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates the current status of the flow.\n \n

" + } + }, + "flowArn": { + "target": "com.amazonaws.appflow#FlowArn", + "traits": { + "smithy.api#documentation": "

\n The flow's Amazon Resource Name (ARN).\n

" + } + } + } + }, + "com.amazonaws.appflow#StopFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#StopFlowRequest" + }, + "output": { + "target": "com.amazonaws.appflow#StopFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nDeactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/stop-flow", + "code": 200 + } + } + }, + "com.amazonaws.appflow#StopFlowRequest": { + "type": "structure", + "members": { + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#StopFlowResponse": { + "type": "structure", + "members": { + "flowStatus": { + "target": "com.amazonaws.appflow#FlowStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates the current status of the flow.\n

" + } + }, + "flowArn": { + "target": "com.amazonaws.appflow#FlowArn", + "traits": { + "smithy.api#documentation": "

\n The flow's Amazon Resource Name (ARN).\n

" + } + } + } + }, + "com.amazonaws.appflow#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.appflow#SupportedFieldTypeDetails": { + "type": "structure", + "members": { + "v1": { + "target": "com.amazonaws.appflow#FieldTypeDetails", + "traits": { + "smithy.api#documentation": "

\n The initial supported version for fieldType. If this is later changed to a different version, v2 will be introduced.\n

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

\n Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues.\n

" + } + }, + "com.amazonaws.appflow#SupportedValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#Value" + } + }, + "com.amazonaws.appflow#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.appflow#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.appflow#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#TagKey" + }, + "value": { + "target": "com.amazonaws.appflow#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.appflow#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.appflow#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Applies a tag to the specified flow.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appflow#TagResourceRequest": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.appflow#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags used to organize, track, or control access for your flow. \n

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.appflow#ARN", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the flow that you want to tag.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appflow#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[\\s\\w+-=\\.:/@]*" + } + }, + "com.amazonaws.appflow#Task": { + "type": "structure", + "members": { + "taskType": { + "target": "com.amazonaws.appflow#TaskType", + "traits": { + "smithy.api#documentation": "

\nSpecifies the particular task implementation that Amazon AppFlow performs.\n

", + "smithy.api#required": {} + } + }, + "sourceFields": { + "target": "com.amazonaws.appflow#SourceFields", + "traits": { + "smithy.api#documentation": "

\nThe source fields to which a particular task is applied.\n

", + "smithy.api#required": {} + } + }, + "taskProperties": { + "target": "com.amazonaws.appflow#TaskPropertiesMap", + "traits": { + "smithy.api#documentation": "

\n A map used to store task-related information. The execution service looks for particular information based on the TaskType.\n

" + } + }, + "destinationField": { + "target": "com.amazonaws.appflow#DestinationField", + "traits": { + "smithy.api#documentation": "

\n A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.\n

" + } + }, + "connectorOperator": { + "target": "com.amazonaws.appflow#ConnectorOperator", + "traits": { + "smithy.api#documentation": "

\nThe operation to be performed on the provided source fields.\n

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

\n A class for modeling different type of tasks. Task implementation varies based on the TaskType.\n

" + } + }, + "com.amazonaws.appflow#TaskPropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#OperatorPropertiesKeys" + }, + "value": { + "target": "com.amazonaws.appflow#Property" + } + }, + "com.amazonaws.appflow#TaskType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Arithmetic", + "name": "ARITHMETIC" + }, + { + "value": "Filter", + "name": "FILTER" + }, + { + "value": "Map", + "name": "MAP" + }, + { + "value": "Mask", + "name": "MASK" + }, + { + "value": "Merge", + "name": "MERGE" + }, + { + "value": "Truncate", + "name": "TRUNCATE" + }, + { + "value": "Validate", + "name": "VALIDATE" + } + ] + } + }, + "com.amazonaws.appflow#Tasks": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#Task" + } + }, + "com.amazonaws.appflow#Timezone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.appflow#TrendmicroConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#TrendmicroConnectorProfileCredentials": { + "type": "structure", + "members": { + "apiSecretKey": { + "target": "com.amazonaws.appflow#ApiSecretKey", + "traits": { + "smithy.api#documentation": "

\n The Secret Access Key portion of the credentials.\n

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

\n The connector-specific profile credentials required when using Trend Micro.\n

" + } + }, + "com.amazonaws.appflow#TrendmicroConnectorProfileProperties": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector-specific profile properties required when using Trend Micro.\n

" + } + }, + "com.amazonaws.appflow#TrendmicroMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Trend Micro.\n

" + } + }, + "com.amazonaws.appflow#TrendmicroSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Trend Micro flow source.\n

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

\n The properties that are applied when using Trend Micro as a flow source.\n

" + } + }, + "com.amazonaws.appflow#TriggerConfig": { + "type": "structure", + "members": { + "triggerType": { + "target": "com.amazonaws.appflow#TriggerType", + "traits": { + "smithy.api#documentation": "

\n Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.\n

", + "smithy.api#required": {} + } + }, + "triggerProperties": { + "target": "com.amazonaws.appflow#TriggerProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.\n

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

\n The trigger settings that determine how and when Amazon AppFlow runs the specified flow.\n\n \n

" + } + }, + "com.amazonaws.appflow#TriggerProperties": { + "type": "structure", + "members": { + "Scheduled": { + "target": "com.amazonaws.appflow#ScheduledTriggerProperties", + "traits": { + "smithy.api#documentation": "

\n Specifies the configuration details of a schedule-triggered flow as defined by the user. \n

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

\n Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.\n

" + } + }, + "com.amazonaws.appflow#TriggerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Scheduled", + "name": "SCHEDULED" + }, + { + "value": "Event", + "name": "EVENT" + }, + { + "value": "OnDemand", + "name": "ONDEMAND" + } + ] + } + }, + "com.amazonaws.appflow#TriggerTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#TriggerType" + } + }, + "com.amazonaws.appflow#UnsupportedOperationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n The requested operation is not supported for the current flow.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appflow#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.appflow#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Removes a tag from the specified flow.\n

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appflow#UntagResourceRequest": { + "type": "structure", + "members": { + "tagKeys": { + "target": "com.amazonaws.appflow#TagKeyList", + "traits": { + "smithy.api#documentation": "

\nThe tag keys associated with the tag that you want to remove from your flow.\n

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.appflow#ARN", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the flow that you want to untag.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appflow#UpdateConnectorProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#UpdateConnectorProfileRequest" + }, + "output": { + "target": "com.amazonaws.appflow#UpdateConnectorProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates a given connector profile associated with your account.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/update-connector-profile", + "code": 200 + } + } + }, + "com.amazonaws.appflow#UpdateConnectorProfileRequest": { + "type": "structure", + "members": { + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "

\n The name of the connector profile and is unique for each ConnectorProfile in the AWS Account.\n

", + "smithy.api#required": {} + } + }, + "connectorProfileConfig": { + "target": "com.amazonaws.appflow#ConnectorProfileConfig", + "traits": { + "smithy.api#documentation": "

\n Defines the connector-specific profile configuration and credentials.\n

", + "smithy.api#required": {} + } + }, + "connectionMode": { + "target": "com.amazonaws.appflow#ConnectionMode", + "traits": { + "smithy.api#documentation": "

\n Indicates the connection mode and if it is public or private.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#UpdateConnectorProfileResponse": { + "type": "structure", + "members": { + "connectorProfileArn": { + "target": "com.amazonaws.appflow#ConnectorProfileArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the connector profile.\n

" + } + } + } + }, + "com.amazonaws.appflow#UpdateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#UpdateFlowRequest" + }, + "output": { + "target": "com.amazonaws.appflow#UpdateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#ConnectorServerException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates an existing flow.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/update-flow", + "code": 200 + } + } + }, + "com.amazonaws.appflow#UpdateFlowRequest": { + "type": "structure", + "members": { + "tasks": { + "target": "com.amazonaws.appflow#Tasks", + "traits": { + "smithy.api#documentation": "

\n A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n

", + "smithy.api#required": {} + } + }, + "destinationFlowConfigList": { + "target": "com.amazonaws.appflow#DestinationFlowConfigList", + "traits": { + "smithy.api#documentation": "

\n The configuration that controls how Amazon AppFlow transfers data to the destination connector.\n

", + "smithy.api#required": {} + } + }, + "sourceFlowConfig": { + "target": "com.amazonaws.appflow#SourceFlowConfig" + }, + "triggerConfig": { + "target": "com.amazonaws.appflow#TriggerConfig", + "traits": { + "smithy.api#documentation": "

\n The trigger settings that determine how and when the flow runs.\n

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appflow#FlowDescription", + "traits": { + "smithy.api#documentation": "

\n A description of the flow.\n

" + } + }, + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

\n The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#UpdateFlowResponse": { + "type": "structure", + "members": { + "flowStatus": { + "target": "com.amazonaws.appflow#FlowStatus", + "traits": { + "smithy.api#documentation": "

Indicates the current status of the flow.\n

" + } + } + } + }, + "com.amazonaws.appflow#UpdatedBy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\nThe request has invalid or missing parameters.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appflow#Value": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.appflow#VeevaConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "NOT_EQUAL_TO", + "name": "NOT_EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#VeevaConnectorProfileCredentials": { + "type": "structure", + "members": { + "username": { + "target": "com.amazonaws.appflow#Username", + "traits": { + "smithy.api#documentation": "

\n The name of the user.\n

", + "smithy.api#required": {} + } + }, + "password": { + "target": "com.amazonaws.appflow#Password", + "traits": { + "smithy.api#documentation": "

\n The password that corresponds to the user name.\n

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

\n The connector-specific profile credentials required when using Veeva.\n

" + } + }, + "com.amazonaws.appflow#VeevaConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Veeva resource.\n

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

\n The connector-specific profile properties required when using Veeva.\n

" + } + }, + "com.amazonaws.appflow#VeevaMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

\n The connector metadata specific to Veeva.\n

" + } + }, + "com.amazonaws.appflow#VeevaSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Veeva flow source.\n

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

\n The properties that are applied when using Veeva as a flow source.\n

" + } + }, + "com.amazonaws.appflow#Warehouse": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "[\\s\\w/!@#+=.-]*" + } + }, + "com.amazonaws.appflow#ZendeskConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#ZendeskConnectorProfileCredentials": { + "type": "structure", + "members": { + "clientSecret": { + "target": "com.amazonaws.appflow#ClientSecret", + "traits": { + "smithy.api#documentation": "

\n The client secret used by the oauth client to authenticate to the authorization server. \n

", + "smithy.api#required": {} + } + }, + "oAuthRequest": { + "target": "com.amazonaws.appflow#ConnectorOAuthRequest", + "traits": { + "smithy.api#documentation": "

\n The oauth requirement needed to request security tokens from the connector endpoint.\n

" + } + }, + "clientId": { + "target": "com.amazonaws.appflow#ClientId", + "traits": { + "smithy.api#documentation": "

\n The identifier for the desired client.\n

", + "smithy.api#required": {} + } + }, + "accessToken": { + "target": "com.amazonaws.appflow#AccessToken", + "traits": { + "smithy.api#documentation": "

\n The credentials used to access protected Zendesk resources.\n

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

\n The connector-specific profile credentials required when using Zendesk.\n

" + } + }, + "com.amazonaws.appflow#ZendeskConnectorProfileProperties": { + "type": "structure", + "members": { + "instanceUrl": { + "target": "com.amazonaws.appflow#InstanceUrl", + "traits": { + "smithy.api#documentation": "

\n The location of the Zendesk resource.\n

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

\n The connector-specific profile properties required when using Zendesk.\n

" + } + }, + "com.amazonaws.appflow#ZendeskMetadata": { + "type": "structure", + "members": { + "oAuthScopes": { + "target": "com.amazonaws.appflow#OAuthScopeList", + "traits": { + "smithy.api#documentation": "

\n The desired authorization scope for the Zendesk account.\n

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

\n The connector metadata specific to Zendesk.\n

" + } + }, + "com.amazonaws.appflow#ZendeskSourceProperties": { + "type": "structure", + "members": { + "object": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

\n The object specified in the Zendesk flow source.\n

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

\n The properties that are applied when using Zendesk as a flow source.\n

" + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/application-auto-scaling.2016-02-06.json b/codegen/sdk-codegen/aws-models/application-auto-scaling.2016-02-06.json index 4ed6adfbd0af..177dcc681773 100644 --- a/codegen/sdk-codegen/aws-models/application-auto-scaling.2016-02-06.json +++ b/codegen/sdk-codegen/aws-models/application-auto-scaling.2016-02-06.json @@ -51,17 +51,17 @@ "com.amazonaws.applicationautoscaling#Alarm": { "type": "structure", "members": { - "AlarmARN": { + "AlarmName": { "target": "com.amazonaws.applicationautoscaling#ResourceId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

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

The name of the alarm.

", "smithy.api#required": {} } }, - "AlarmName": { + "AlarmARN": { "target": "com.amazonaws.applicationautoscaling#ResourceId", "traits": { - "smithy.api#documentation": "

The name of the alarm.

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

The Amazon Resource Name (ARN) of the alarm.

", "smithy.api#required": {} } } @@ -122,7 +122,7 @@ "name": "application-autoscaling" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n \n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n \n\n \n

To learn more about Application Auto Scaling, including information about granting IAM users required\n permissions for Application Auto Scaling actions, see the Application Auto Scaling\n User Guide.

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

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n \n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n \n\n \n

To learn more about Application Auto Scaling, including information about granting IAM users required\n permissions for Application Auto Scaling actions, see the Application Auto Scaling User\n Guide.

", "smithy.api#title": "Application Auto Scaling" } }, @@ -148,10 +148,10 @@ "com.amazonaws.applicationautoscaling#CustomizedMetricSpecification": { "type": "structure", "members": { - "Statistic": { - "target": "com.amazonaws.applicationautoscaling#MetricStatistic", + "Namespace": { + "target": "com.amazonaws.applicationautoscaling#MetricNamespace", "traits": { - "smithy.api#documentation": "

The statistic of the metric.

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

The namespace of the metric.

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

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" } }, - "Unit": { - "target": "com.amazonaws.applicationautoscaling#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit of the metric.

" - } - }, "MetricName": { "target": "com.amazonaws.applicationautoscaling#MetricName", "traits": { @@ -174,12 +168,18 @@ "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.applicationautoscaling#MetricNamespace", + "Statistic": { + "target": "com.amazonaws.applicationautoscaling#MetricStatistic", "traits": { - "smithy.api#documentation": "

The namespace of the metric.

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

The statistic of the metric.

", "smithy.api#required": {} } + }, + "Unit": { + "target": "com.amazonaws.applicationautoscaling#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit of the metric.

" + } } }, "traits": { @@ -215,31 +215,31 @@ "com.amazonaws.applicationautoscaling#DeleteScalingPolicyRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "PolicyName": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The name of the scaling policy.

", "smithy.api#required": {} } }, - "PolicyName": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The name of the scaling policy.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } } @@ -278,10 +278,10 @@ "com.amazonaws.applicationautoscaling#DeleteScheduledActionRequest": { "type": "structure", "members": { - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "ScheduledActionName": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The name of the scheduled action.

", "smithy.api#required": {} } }, @@ -292,17 +292,17 @@ "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, - "ScheduledActionName": { + "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The name of the scheduled action.

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

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } } @@ -341,24 +341,24 @@ "com.amazonaws.applicationautoscaling#DeregisterScalableTargetRequest": { "type": "structure", "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } } @@ -403,11 +403,10 @@ "com.amazonaws.applicationautoscaling#DescribeScalableTargetsRequest": { "type": "structure", "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -416,22 +415,23 @@ "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" } }, - "ResourceIds": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

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

The token for the next set of results.

" } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceIds": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

\n " } } } @@ -488,16 +488,22 @@ "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesRequest": { "type": "structure", "members": { + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " + } + }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

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

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "MaxResults": { + "target": "com.amazonaws.applicationautoscaling#MaxResults", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

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

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" } }, "NextToken": { @@ -512,12 +518,6 @@ "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } - }, - "MaxResults": { - "target": "com.amazonaws.applicationautoscaling#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" - } } } }, @@ -576,29 +576,22 @@ "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "PolicyNames": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The names of the scaling policies to describe.

" } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

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

The token for the next set of results.

" } }, - "PolicyNames": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The names of the scaling policies to describe.

" + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -607,10 +600,17 @@ "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" } }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } } } @@ -667,6 +667,18 @@ "com.amazonaws.applicationautoscaling#DescribeScheduledActionsRequest": { "type": "structure", "members": { + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

\n " + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationautoscaling#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of scheduled action results. This value can be between\n 1 and 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" + } + }, "ScheduledActionNames": { "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", "traits": { @@ -676,13 +688,7 @@ "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "NextToken": { @@ -697,12 +703,6 @@ "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } - }, - "MaxResults": { - "target": "com.amazonaws.applicationautoscaling#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of scheduled action results. This value can be between\n 1 and 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" - } } } }, @@ -812,17 +812,17 @@ "com.amazonaws.applicationautoscaling#MetricDimension": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.applicationautoscaling#MetricDimensionValue", + "Name": { + "target": "com.amazonaws.applicationautoscaling#MetricDimensionName", "traits": { - "smithy.api#documentation": "

The value of the dimension.

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

The name of the dimension.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.applicationautoscaling#MetricDimensionName", + "Value": { + "target": "com.amazonaws.applicationautoscaling#MetricDimensionValue", "traits": { - "smithy.api#documentation": "

The name of the dimension.

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

The value of the dimension.

", "smithy.api#required": {} } } @@ -949,6 +949,10 @@ { "value": "CassandraWriteCapacityUtilization", "name": "CassandraWriteCapacityUtilization" + }, + { + "value": "KafkaBrokerStorageUtilization", + "name": "KafkaBrokerStorageUtilization" } ] } @@ -1003,18 +1007,18 @@ "com.amazonaws.applicationautoscaling#PredefinedMetricSpecification": { "type": "structure", "members": { + "ResourceLabel": { + "target": "com.amazonaws.applicationautoscaling#ResourceLabel", + "traits": { + "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group attached to the Spot Fleet request or ECS service.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format is\n app///targetgroup//,\n where:

\n \n

This is an example:\n app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

\n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + } + }, "PredefinedMetricType": { "target": "com.amazonaws.applicationautoscaling#MetricType", "traits": { "smithy.api#documentation": "

The metric type. The ALBRequestCountPerTarget metric type applies only to\n Spot Fleet requests and ECS services.

", "smithy.api#required": {} } - }, - "ResourceLabel": { - "target": "com.amazonaws.applicationautoscaling#ResourceLabel", - "traits": { - "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group attached to the Spot Fleet request or ECS service.

\n\n

Elastic Load Balancing sends data about your load balancers to Amazon CloudWatch. CloudWatch collects\n the data and specifies the format to use to access the data. The format is\n app///targetgroup//,\n where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" - } } }, "traits": { @@ -1056,36 +1060,24 @@ "com.amazonaws.applicationautoscaling#PutScalingPolicyRequest": { "type": "structure", "members": { - "PolicyType": { - "target": "com.amazonaws.applicationautoscaling#PolicyType", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The policy type. This parameter is required if you are creating a scaling policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, or Amazon Keyspaces (for\n Apache Cassandra).

\n

For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", + "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", - "smithy.api#required": {} - } - }, - "TargetTrackingScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized\n metrics.

\n

This parameter is required if you are creating a policy and the policy type is\n TargetTrackingScaling.

" - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, - "StepScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration", + "PolicyType": { + "target": "com.amazonaws.applicationautoscaling#PolicyType", "traits": { - "smithy.api#documentation": "

A step scaling policy.

\n

This parameter is required if you are creating a policy and the policy type is\n StepScaling.

" + "smithy.api#documentation": "

The policy type. This parameter is required if you are creating a scaling policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for\n Apache Cassandra), or Amazon MSK.

\n

For more information, see Target\n Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

" } }, "PolicyName": { @@ -1101,24 +1093,36 @@ "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

A step scaling policy.

\n

This parameter is required if you are creating a policy and the policy type is\n StepScaling.

" + } + }, + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized\n metrics.

\n

This parameter is required if you are creating a policy and the policy type is\n TargetTrackingScaling.

" + } } } }, "com.amazonaws.applicationautoscaling#PutScalingPolicyResponse": { "type": "structure", "members": { + "Alarms": { + "target": "com.amazonaws.applicationautoscaling#Alarms", + "traits": { + "smithy.api#documentation": "

The CloudWatch alarms created for the target tracking scaling policy.

" + } + }, "PolicyARN": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resulting scaling policy.

", "smithy.api#required": {} } - }, - "Alarms": { - "target": "com.amazonaws.applicationautoscaling#Alarms", - "traits": { - "smithy.api#documentation": "

The CloudWatch alarms created for the target tracking scaling policy.

" - } } } }, @@ -1154,36 +1158,36 @@ "com.amazonaws.applicationautoscaling#PutScheduledActionRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time for the recurring schedule to end.

" - } - }, "StartTime": { "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { "smithy.api#documentation": "

The date and time for this scheduled action to start.

" } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "Schedule": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n \n

At expressions are useful for one-time schedules. Specify the time in UTC.

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

\n

For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, - "Schedule": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ScalableTargetAction": { + "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", "traits": { - "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n \n

At expressions are useful for one-time schedules. Specify the time in UTC.

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

\n

For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" + } + }, + "ScheduledActionName": { + "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled action. This name must be unique among all other scheduled\n actions on the specified scalable target.

", + "smithy.api#required": {} } }, "ServiceNamespace": { @@ -1193,17 +1197,17 @@ "smithy.api#required": {} } }, - "ScheduledActionName": { - "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The name of the scheduled action. This name must be unique among all other scheduled\n actions on the specified scalable target.

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

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, - "ScalableTargetAction": { - "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", + "EndTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" + "smithy.api#documentation": "

The date and time for the recurring schedule to end.

" } } } @@ -1235,55 +1239,55 @@ } ], "traits": { - "smithy.api#documentation": "

Registers or updates a scalable target.

\n

A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable\n targets are uniquely identified by the combination of resource ID, scalable dimension, and\n namespace.

\n

When you register a new scalable target, you must specify values for minimum and maximum\n capacity. Application Auto Scaling scaling policies will not scale capacity to values that are outside of\n this range.

\n

After you register a scalable target, you do not need to register it again to use other\n Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service\n namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can\n deregister it by using DeregisterScalableTarget.

\n

To update a scalable target, specify the parameters that you want to change. Include the\n parameters that identify the scalable target: resource ID, scalable dimension, and\n namespace. Any parameters that you don't specify are not changed by this update request.

" + "smithy.api#documentation": "

Registers or updates a scalable target.

\n

A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable\n targets are uniquely identified by the combination of resource ID, scalable dimension, and\n namespace.

\n

When you register a new scalable target, you must specify values for minimum and maximum\n capacity. Current capacity will be adjusted within the specified range when scaling starts.\n Application Auto Scaling scaling policies will not scale capacity to values that are outside of this\n range.

\n

After you register a scalable target, you do not need to register it again to use other\n Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service\n namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can\n deregister it by using DeregisterScalableTarget.

\n

To update a scalable target, specify the parameters that you want to change. Include the\n parameters that identify the scalable target: resource ID, scalable dimension, and\n namespace. Any parameters that you don't specify are not changed by this update request.

" } }, "com.amazonaws.applicationautoscaling#RegisterScalableTargetRequest": { "type": "structure", "members": { - "MinCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "SuspendedState": { + "target": "com.amazonaws.applicationautoscaling#SuspendedState", "traits": { - "smithy.api#documentation": "

The minimum value that you plan to scale in to. When a scaling policy is in effect,\n Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to\n changing demand.

\n

This parameter is required if you are registering a scalable target. For certain\n resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency,\n Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all\n other resources, the minimum value allowed is 1.

" + "smithy.api#documentation": "

An embedded object that contains attributes and attribute values that are used to\n suspend and resume automatic scaling. Setting the value of an attribute to\n true suspends the specified scaling activities. Setting it to\n false (default) resumes the specified scaling activities.

\n

\n Suspension Outcomes\n

\n \n

For more information, see Suspending and Resuming Scaling in the Application Auto Scaling User\n Guide.

" } }, - "MaxCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The maximum value that you plan to scale out to. When a scaling policy is in effect,\n Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to\n changing demand.

\n

This parameter is required if you are registering a scalable target.

" + "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, - "SuspendedState": { - "target": "com.amazonaws.applicationautoscaling#SuspendedState", + "MaxCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", "traits": { - "smithy.api#documentation": "

An embedded object that contains attributes and attribute values that are used to\n suspend and resume automatic scaling. Setting the value of an attribute to\n true suspends the specified scaling activities. Setting it to\n false (default) resumes the specified scaling activities.

\n

\n Suspension Outcomes\n

\n \n

For more information, see Suspending and Resuming Scaling in the Application Auto Scaling User\n Guide.

" + "smithy.api#documentation": "

The maximum value that you plan to scale out to. When a scaling policy is in effect,\n Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to\n changing demand.

\n

This parameter is required if you are registering a scalable target.

\n

Although you can specify a large maximum capacity, note that service quotas may impose\n lower limits. Each service has its own default quotas for the maximum capacity of the\n resource. If you want to specify a higher limit, you can request an increase. For more\n information, consult the documentation for that service. For information about the default\n quotas for each service, see Service Endpoints and\n Quotas in the Amazon Web Services General Reference.

" } }, - "RoleARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "MinCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", "traits": { - "smithy.api#documentation": "

This parameter is required for services that do not support service-linked roles (such\n as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the\n scalable target on your behalf.

\n

If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which\n it creates if it does not yet exist. For more information, see Application Auto Scaling IAM Roles.

" + "smithy.api#documentation": "

The minimum value that you plan to scale in to. When a scaling policy is in effect,\n Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to\n changing demand.

\n

This parameter is required if you are registering a scalable target. For certain\n resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot\n Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other\n resources, the minimum value allowed is 1.

" } }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "RoleARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

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

This parameter is required for services that do not support service-linked roles (such as\n Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable\n target on your behalf.

\n

If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which\n it creates if it does not yet exist. For more information, see Application Auto Scaling IAM Roles.

" } } } @@ -1381,6 +1385,10 @@ "value": "comprehend:document-classifier-endpoint:DesiredInferenceUnits", "name": "ComprehendDocClassifierEndpointInferenceUnits" }, + { + "value": "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits", + "name": "ComprehendEntityRecognizerEndpointInferenceUnits" + }, { "value": "lambda:function:ProvisionedConcurrency", "name": "LambdaFunctionProvisionedConcurrency" @@ -1392,6 +1400,10 @@ { "value": "cassandra:table:WriteCapacityUnits", "name": "CassandraTableWriteCapacityUnits" + }, + { + "value": "kafka:broker-storage:VolumeSize", + "name": "KafkaBrokerStorageVolumeSize" } ] } @@ -1399,55 +1411,55 @@ "com.amazonaws.applicationautoscaling#ScalableTarget": { "type": "structure", "members": { - "SuspendedState": { - "target": "com.amazonaws.applicationautoscaling#SuspendedState" - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "RoleARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

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

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your\n behalf.

", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", + "MaxCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scalable target was created.

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

The maximum value to scale to in response to a scale-out activity.

", "smithy.api#required": {} } }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "MinCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

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

The minimum value to scale to in response to a scale-in activity.

", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "CreationTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The Unix timestamp for when the scalable target was created.

", "smithy.api#required": {} } }, - "RoleARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your\n behalf.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, - "MinCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The minimum value to scale to in response to a scale-in activity.

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

The namespace of the AWS service that provides the resource, or a\n custom-resource.

", "smithy.api#required": {} } }, - "MaxCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "SuspendedState": { + "target": "com.amazonaws.applicationautoscaling#SuspendedState" + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The maximum value to scale to in response to a scale-out activity.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } } @@ -1459,16 +1471,16 @@ "com.amazonaws.applicationautoscaling#ScalableTargetAction": { "type": "structure", "members": { - "MinCapacity": { + "MaxCapacity": { "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", "traits": { - "smithy.api#documentation": "

The minimum capacity.

\n

For Lambda provisioned concurrency, the minimum value allowed is 0. For all other\n resources, the minimum value allowed is 1.

" + "smithy.api#documentation": "

The maximum capacity.

\n

Although you can specify a large maximum capacity, note that service quotas may impose\n lower limits. Each service has its own default quotas for the maximum capacity of the\n resource. If you want to specify a higher limit, you can request an increase. For more\n information, consult the documentation for that service. For information about the default\n quotas for each service, see Service Endpoints and\n Quotas in the Amazon Web Services General Reference.

" } }, - "MaxCapacity": { + "MinCapacity": { "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", "traits": { - "smithy.api#documentation": "

The maximum capacity.

" + "smithy.api#documentation": "

The minimum capacity.

\n

For certain resources, the minimum value allowed is 0. This includes Lambda provisioned\n concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources.\n For all other resources, the minimum value allowed is 1.

" } } }, @@ -1491,78 +1503,78 @@ "com.amazonaws.applicationautoscaling#ScalingActivity": { "type": "structure", "members": { - "StatusCode": { - "target": "com.amazonaws.applicationautoscaling#ScalingActivityStatusCode", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

Indicates the status of the scaling activity.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, - "Details": { - "target": "com.amazonaws.applicationautoscaling#XmlString", + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The details about the scaling activity.

" + "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scaling activity ended.

" + "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.applicationautoscaling#XmlString", + "ActivityId": { + "target": "com.amazonaws.applicationautoscaling#ResourceId", "traits": { - "smithy.api#documentation": "

A simple description of what action the scaling activity intends to accomplish.

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

The unique identifier of the scaling activity.

", "smithy.api#required": {} } }, - "StatusMessage": { - "target": "com.amazonaws.applicationautoscaling#XmlString", + "EndTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

A simple message about the current status of the scaling activity.

" + "smithy.api#documentation": "

The Unix timestamp for when the scaling activity ended.

" } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "Cause": { + "target": "com.amazonaws.applicationautoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

A simple description of what caused the scaling activity to happen.

", "smithy.api#required": {} } }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "StartTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

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

The Unix timestamp for when the scaling activity began.

", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "Details": { + "target": "com.amazonaws.applicationautoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

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

The details about the scaling activity.

" } }, - "Cause": { - "target": "com.amazonaws.applicationautoscaling#XmlString", + "StatusCode": { + "target": "com.amazonaws.applicationautoscaling#ScalingActivityStatusCode", "traits": { - "smithy.api#documentation": "

A simple description of what caused the scaling activity to happen.

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

Indicates the status of the scaling activity.

", "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", + "Description": { + "target": "com.amazonaws.applicationautoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scaling activity began.

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

A simple description of what action the scaling activity intends to accomplish.

", "smithy.api#required": {} } }, - "ActivityId": { - "target": "com.amazonaws.applicationautoscaling#ResourceId", + "StatusMessage": { + "target": "com.amazonaws.applicationautoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The unique identifier of the scaling activity.

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

A simple message about the current status of the scaling activity.

" } } }, @@ -1616,30 +1628,29 @@ "com.amazonaws.applicationautoscaling#ScalingPolicy": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "Alarms": { + "target": "com.amazonaws.applicationautoscaling#Alarms", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

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

The CloudWatch alarms associated with the scaling policy.

" } }, - "PolicyARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "StepScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scaling policy.

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

A step scaling policy.

" } }, - "TargetTrackingScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

A target tracking scaling policy.

" + "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

", + "smithy.api#required": {} } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "CreationTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The Unix timestamp for when the scaling policy was created.

", "smithy.api#required": {} } }, @@ -1650,42 +1661,43 @@ "smithy.api#required": {} } }, - "Alarms": { - "target": "com.amazonaws.applicationautoscaling#Alarms", + "PolicyARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The CloudWatch alarms associated with the scaling policy.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scaling policy.

", + "smithy.api#required": {} } }, - "StepScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration", + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

A step scaling policy.

" + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", + "smithy.api#required": {} } }, - "PolicyName": { - "target": "com.amazonaws.applicationautoscaling#PolicyName", + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", "traits": { - "smithy.api#documentation": "

The name of the scaling policy.

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

A target tracking scaling policy.

" } }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "PolicyName": { + "target": "com.amazonaws.applicationautoscaling#PolicyName", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

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

The name of the scaling policy.

", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scaling policy was created.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

Represents a scaling policy to use with Application Auto Scaling.

" + "smithy.api#documentation": "

Represents a scaling policy to use with Application Auto Scaling.

\n

For more information about configuring scaling policies for a specific service, see Getting started with Application Auto Scaling in the Application Auto Scaling User Guide.

" } }, "com.amazonaws.applicationautoscaling#ScalingSuspended": { @@ -1697,13 +1709,19 @@ "com.amazonaws.applicationautoscaling#ScheduledAction": { "type": "structure", "members": { - "ScheduledActionARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "ScheduledActionName": { + "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduled action.

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

The name of the scheduled action.

", "smithy.api#required": {} } }, + "EndTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time that the action is scheduled to end.

" + } + }, "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { @@ -1711,55 +1729,49 @@ "smithy.api#required": {} } }, - "Schedule": { + "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n \n

At expressions are useful for one-time schedules. Specify the time in UTC.

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

\n

For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.

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

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n " - } - }, - "ScheduledActionName": { - "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", + "CreationTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The name of the scheduled action.

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

The date and time that the scheduled action was created.

", "smithy.api#required": {} } }, - "CreationTime": { + "StartTime": { "target": "com.amazonaws.applicationautoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The date and time that the scheduled action was created.

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

The date and time that the action is scheduled to begin.

" } }, - "ScalableTargetAction": { - "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n " } }, - "EndTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", + "Schedule": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The date and time that the action is scheduled to end.

" + "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n \n

At expressions are useful for one-time schedules. Specify the time in UTC.

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

\n

For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.

", + "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", + "ScalableTargetAction": { + "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", "traits": { - "smithy.api#documentation": "

The date and time that the action is scheduled to begin.

" + "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" } }, - "ResourceId": { + "ScheduledActionARN": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

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

The Amazon Resource Name (ARN) of the scheduled action.

", "smithy.api#required": {} } } @@ -1831,6 +1843,10 @@ { "value": "cassandra", "name": "CASSANDRA" + }, + { + "value": "kafka", + "name": "KAFKA" } ] } @@ -1838,11 +1854,10 @@ "com.amazonaws.applicationautoscaling#StepAdjustment": { "type": "structure", "members": { - "ScalingAdjustment": { - "target": "com.amazonaws.applicationautoscaling#ScalingAdjustment", + "MetricIntervalLowerBound": { + "target": "com.amazonaws.applicationautoscaling#MetricScale", "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n

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

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" } }, "MetricIntervalUpperBound": { @@ -1851,10 +1866,11 @@ "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

" } }, - "MetricIntervalLowerBound": { - "target": "com.amazonaws.applicationautoscaling#MetricScale", + "ScalingAdjustment": { + "target": "com.amazonaws.applicationautoscaling#ScalingAdjustment", "traits": { - "smithy.api#documentation": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity. For\n exact capacity, you must specify a positive value.

", + "smithy.api#required": {} } } }, @@ -1871,22 +1887,16 @@ "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration": { "type": "structure", "members": { - "Cooldown": { - "target": "com.amazonaws.applicationautoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scaling activity to take\n effect.

\n

With scale-out policies, the intention is to continuously (but not excessively) scale\n out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to\n calculate the cooldown time. While the cooldown period is in effect, capacity added by the\n initiating scale-out activity is calculated as part of the desired capacity for the next\n scale-out activity. For example, when an alarm triggers a step scaling policy to increase\n the capacity by 2, the scaling activity completes successfully, and a cooldown period\n starts. If the alarm triggers again during the cooldown period but at a more aggressive\n step adjustment of 3, the previous increase of 2 is considered part of the current\n capacity. Therefore, only 1 is added to the capacity.

\n

With scale-in policies, the intention is to scale in conservatively to protect your\n application’s availability, so scale-in activities are blocked until the cooldown period\n has expired. However, if another alarm triggers a scale-out activity during the cooldown\n period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case,\n the cooldown period for the scale-in activity stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " - } - }, - "StepAdjustments": { - "target": "com.amazonaws.applicationautoscaling#StepAdjustments", + "AdjustmentType": { + "target": "com.amazonaws.applicationautoscaling#AdjustmentType", "traits": { - "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

At least one step adjustment is required if you are adding a new step scaling policy\n configuration.

" + "smithy.api#documentation": "

Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a\n percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

\n AdjustmentType is required if you are adding a new step scaling policy\n configuration.

" } }, - "AdjustmentType": { - "target": "com.amazonaws.applicationautoscaling#AdjustmentType", + "Cooldown": { + "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a percentage of the current capacity.

\n

\n AdjustmentType is required if you are adding a new step scaling policy\n configuration.

" + "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scaling activity to take effect.

\n

With scale-out policies, the intention is to continuously (but not excessively) scale out.\n After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the\n cooldown time. The scaling policy won't increase the desired capacity again unless either a\n larger scale out is triggered or the cooldown period ends. While the cooldown period is in\n effect, capacity added by the initiating scale-out activity is calculated as part of the\n desired capacity for the next scale-out activity. For example, when an alarm triggers a step\n scaling policy to increase the capacity by 2, the scaling activity completes successfully, and\n a cooldown period starts. If the alarm triggers again during the cooldown period but at a more\n aggressive step adjustment of 3, the previous increase of 2 is considered part of the current\n capacity. Therefore, only 1 is added to the capacity.

\n

With scale-in policies, the intention is to scale in conservatively to protect your\n application’s availability, so scale-in activities are blocked until the cooldown period has\n expired. However, if another alarm triggers a scale-out activity during the cooldown period\n after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the\n cooldown period for the scale-in activity stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " } }, "MetricAggregationType": { @@ -1895,10 +1905,16 @@ "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. Valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

" } }, + "StepAdjustments": { + "target": "com.amazonaws.applicationautoscaling#StepAdjustments", + "traits": { + "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

At least one step adjustment is required if you are adding a new step scaling policy\n configuration.

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

The minimum value to scale by when scaling by percentages. For example, suppose that you\n create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling\n policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2\n tasks.

\n

Valid only if the adjustment type is PercentChangeInCapacity.

" + "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Amazon ECS service by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling\n policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2\n tasks.

" } } }, @@ -1915,16 +1931,16 @@ "smithy.api#documentation": "

Whether scale in by a target tracking scaling policy or a step scaling policy is\n suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity\n when a scaling policy is triggered. The default is false.

" } }, - "ScheduledScalingSuspended": { + "DynamicScalingOutSuspended": { "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", "traits": { - "smithy.api#documentation": "

Whether scheduled scaling is suspended. Set the value to true if you don't\n want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is\n false.

" + "smithy.api#documentation": "

Whether scale out by a target tracking scaling policy or a step scaling policy is\n suspended. Set the value to true if you don't want Application Auto Scaling to add capacity\n when a scaling policy is triggered. The default is false.

" } }, - "DynamicScalingOutSuspended": { + "ScheduledScalingSuspended": { "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", "traits": { - "smithy.api#documentation": "

Whether scale out by a target tracking scaling policy or a step scaling policy is\n suspended. Set the value to true if you don't want Application Auto Scaling to add capacity\n when a scaling policy is triggered. The default is false.

" + "smithy.api#documentation": "

Whether scheduled scaling is suspended. Set the value to true if you don't\n want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is\n false.

" } } }, @@ -1935,16 +1951,11 @@ "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration": { "type": "structure", "members": { - "ScaleOutCooldown": { - "target": "com.amazonaws.applicationautoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scale-out activity to take\n effect.

\n

With the scale-out cooldown period, the intention is to\n continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using\n a target tracking scaling policy, it starts to calculate the cooldown time. While the\n scale-out cooldown period is in effect, the capacity added by the initiating scale-out\n activity is calculated as part of the desired capacity for the next scale-out\n activity.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " - } - }, - "CustomizedMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#CustomizedMetricSpecification", + "TargetValue": { + "target": "com.amazonaws.applicationautoscaling#MetricScale", "traits": { - "smithy.api#documentation": "

A customized metric. You can specify either a predefined metric or a customized\n metric.

" + "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

", + "smithy.api#required": {} } }, "PredefinedMetricSpecification": { @@ -1953,23 +1964,28 @@ "smithy.api#documentation": "

A predefined metric. You can specify either a predefined metric or a customized\n metric.

" } }, - "ScaleInCooldown": { - "target": "com.amazonaws.applicationautoscaling#Cooldown", + "DisableScaleIn": { + "target": "com.amazonaws.applicationautoscaling#DisableScaleIn", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start.

\n

With the scale-in cooldown period, the intention is to scale in\n conservatively to protect your application’s availability, so scale-in activities are\n blocked until the cooldown period has expired. However, if another alarm triggers a\n scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target\n immediately. In this case, the scale-in cooldown period stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

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

Indicates whether scale in by the target tracking scaling policy is disabled. If the\n value is true, scale in is disabled and the target tracking scaling policy\n won't remove capacity from the scalable target. Otherwise, scale in is enabled and the\n target tracking scaling policy can remove capacity from the scalable target. The default\n value is false.

" } }, - "TargetValue": { - "target": "com.amazonaws.applicationautoscaling#MetricScale", + "CustomizedMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#CustomizedMetricSpecification", "traits": { - "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

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

A customized metric. You can specify either a predefined metric or a customized\n metric.

" } }, - "DisableScaleIn": { - "target": "com.amazonaws.applicationautoscaling#DisableScaleIn", + "ScaleInCooldown": { + "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

Indicates whether scale in by the target tracking scaling policy is disabled. If the\n value is true, scale in is disabled and the target tracking scaling policy\n won't remove capacity from the scalable target. Otherwise, scale in is enabled and the\n target tracking scaling policy can remove capacity from the scalable target. The default\n value is false.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start.

\n

With the scale-in cooldown period, the intention is to scale in\n conservatively to protect your application’s availability, so scale-in activities are blocked\n until the cooldown period has expired. However, if another alarm triggers a scale-out activity\n during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case,\n the scale-in cooldown period stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.applicationautoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scale-out activity to take\n effect.

\n

With the scale-out cooldown period, the intention is to continuously\n (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target\n tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't\n increase the desired capacity again unless either a larger scale out is triggered or the\n cooldown period ends. While the cooldown period is in effect, the capacity added by the\n initiating scale-out activity is calculated as part of the desired capacity for the next\n scale-out activity.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " } } }, diff --git a/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json b/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json index 30b57184f95e..d8255afba489 100644 --- a/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json +++ b/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json @@ -114,7 +114,7 @@ "sdkId": "Application Discovery Service", "arnNamespace": "discovery", "cloudFormationName": "ApplicationDiscoveryService", - "cloudTrailEventSource": "V2015_11_01.awsposeidon.amazonaws.com" + "cloudTrailEventSource": "applicationdiscoveryservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "discovery" @@ -189,6 +189,18 @@ "smithy.api#documentation": "

The agent or connector ID.

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

Type of agent.

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

Agent's first registration timestamp in UTC.

" + } + }, "connectorId": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { @@ -201,34 +213,22 @@ "smithy.api#documentation": "

Status of the collection process for an agent or connector.

" } }, - "agentNetworkInfoList": { - "target": "com.amazonaws.applicationdiscoveryservice#AgentNetworkInfoList", - "traits": { - "smithy.api#documentation": "

Network details about the host where the agent or connector resides.

" - } - }, "health": { "target": "com.amazonaws.applicationdiscoveryservice#AgentStatus", "traits": { "smithy.api#documentation": "

The health of the agent or connector.

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

Agent's first registration timestamp in UTC.

" - } - }, - "agentType": { + "version": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { - "smithy.api#documentation": "

Type of agent.

" + "smithy.api#documentation": "

The agent or connector version.

" } }, - "version": { - "target": "com.amazonaws.applicationdiscoveryservice#String", + "agentNetworkInfoList": { + "target": "com.amazonaws.applicationdiscoveryservice#AgentNetworkInfoList", "traits": { - "smithy.api#documentation": "

The agent or connector version.

" + "smithy.api#documentation": "

Network details about the host where the agent or connector resides.

" } } }, @@ -550,22 +550,16 @@ "smithy.api#documentation": "

The configuration ID for the item to tag. You can specify a list of keys and\n values.

" } }, - "value": { - "target": "com.amazonaws.applicationdiscoveryservice#TagValue", - "traits": { - "smithy.api#documentation": "

A value on which to filter. For example key = serverType and\n value = web server.

" - } - }, "configurationType": { "target": "com.amazonaws.applicationdiscoveryservice#ConfigurationItemType", "traits": { "smithy.api#documentation": "

A type of IT asset to tag.

" } }, - "key": { - "target": "com.amazonaws.applicationdiscoveryservice#TagKey", + "value": { + "target": "com.amazonaws.applicationdiscoveryservice#TagValue", "traits": { - "smithy.api#documentation": "

A type of tag on which to filter. For example,\n serverType.

" + "smithy.api#documentation": "

A value on which to filter. For example key = serverType and\n value = web server.

" } }, "timeOfCreation": { @@ -573,6 +567,12 @@ "traits": { "smithy.api#documentation": "

The time the configuration tag was created in Coordinated Universal Time\n (UTC).

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

A type of tag on which to filter. For example,\n serverType.

" + } } }, "traits": { @@ -616,22 +616,10 @@ "com.amazonaws.applicationdiscoveryservice#ContinuousExportDescription": { "type": "structure", "members": { - "dataSource": { - "target": "com.amazonaws.applicationdiscoveryservice#DataSource", - "traits": { - "smithy.api#documentation": "

The type of data collector used to gather this data (currently only offered for\n AGENT).

" - } - }, - "startTime": { - "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", - "traits": { - "smithy.api#documentation": "

The timestamp representing when the continuous export was started.

" - } - }, - "stopTime": { - "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", + "schemaStorageConfig": { + "target": "com.amazonaws.applicationdiscoveryservice#SchemaStorageConfig", "traits": { - "smithy.api#documentation": "

The timestamp that represents when this continuous export was stopped.

" + "smithy.api#documentation": "

An object which describes how the data is stored.

\n " } }, "statusDetail": { @@ -640,16 +628,16 @@ "smithy.api#documentation": "

Contains information about any errors that have occurred. This data type can have the\n following values:

\n\n " } }, - "s3Bucket": { - "target": "com.amazonaws.applicationdiscoveryservice#S3Bucket", + "dataSource": { + "target": "com.amazonaws.applicationdiscoveryservice#DataSource", "traits": { - "smithy.api#documentation": "

The name of the s3 bucket where the export data parquet files are stored.

" + "smithy.api#documentation": "

The type of data collector used to gather this data (currently only offered for\n AGENT).

" } }, - "schemaStorageConfig": { - "target": "com.amazonaws.applicationdiscoveryservice#SchemaStorageConfig", + "s3Bucket": { + "target": "com.amazonaws.applicationdiscoveryservice#S3Bucket", "traits": { - "smithy.api#documentation": "

An object which describes how the data is stored.

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

The name of the s3 bucket where the export data parquet files are stored.

" } }, "status": { @@ -663,6 +651,18 @@ "traits": { "smithy.api#documentation": "

The unique ID assigned to this export.

" } + }, + "startTime": { + "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", + "traits": { + "smithy.api#documentation": "

The timestamp representing when the continuous export was started.

" + } + }, + "stopTime": { + "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", + "traits": { + "smithy.api#documentation": "

The timestamp that represents when this continuous export was stopped.

" + } } }, "traits": { @@ -832,6 +832,13 @@ "com.amazonaws.applicationdiscoveryservice#CustomerAgentInfo": { "type": "structure", "members": { + "shutdownAgents": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "

Number of discovery agents with status SHUTDOWN.

", + "smithy.api#required": {} + } + }, "totalAgents": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { @@ -860,13 +867,6 @@ "smithy.api#required": {} } }, - "unknownAgents": { - "target": "com.amazonaws.applicationdiscoveryservice#Integer", - "traits": { - "smithy.api#documentation": "

Number of unknown discovery agents.

", - "smithy.api#required": {} - } - }, "unhealthyAgents": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { @@ -874,10 +874,10 @@ "smithy.api#required": {} } }, - "shutdownAgents": { + "unknownAgents": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

Number of discovery agents with status SHUTDOWN.

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

Number of unknown discovery agents.

", "smithy.api#required": {} } } @@ -896,24 +896,24 @@ "smithy.api#required": {} } }, - "healthyConnectors": { + "totalConnectors": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

Number of healthy discovery connectors.

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

Total number of discovery connectors.

", "smithy.api#required": {} } }, - "totalConnectors": { + "shutdownConnectors": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

Total number of discovery connectors.

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

Number of discovery connectors with status SHUTDOWN,

", "smithy.api#required": {} } }, - "shutdownConnectors": { + "healthyConnectors": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

Number of discovery connectors with status SHUTDOWN,

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

Number of healthy discovery connectors.

", "smithy.api#required": {} } }, @@ -1257,18 +1257,18 @@ "com.amazonaws.applicationdiscoveryservice#DescribeContinuousExportsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.applicationdiscoveryservice#NextToken", - "traits": { - "smithy.api#documentation": "

The token from the previous call to DescribeExportTasks.

" - } - }, "exportIds": { "target": "com.amazonaws.applicationdiscoveryservice#ContinuousExportIds", "traits": { "smithy.api#documentation": "

The unique IDs assigned to the exports.

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

The token from the previous call to DescribeExportTasks.

" + } + }, "maxResults": { "target": "com.amazonaws.applicationdiscoveryservice#DescribeContinuousExportsMaxResults", "traits": { @@ -1280,17 +1280,17 @@ "com.amazonaws.applicationdiscoveryservice#DescribeContinuousExportsResponse": { "type": "structure", "members": { - "descriptions": { - "target": "com.amazonaws.applicationdiscoveryservice#ContinuousExportDescriptions", - "traits": { - "smithy.api#documentation": "

A list of continuous export descriptions.

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

The token from the previous call to DescribeExportTasks.

" } + }, + "descriptions": { + "target": "com.amazonaws.applicationdiscoveryservice#ContinuousExportDescriptions", + "traits": { + "smithy.api#documentation": "

A list of continuous export descriptions.

" + } } } }, @@ -1336,17 +1336,17 @@ "smithy.api#documentation": "

A list of continuous export IDs to search for.

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

The token from the previous call to describe-export-tasks.

" - } - }, "maxResults": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#documentation": "

A number between 1 and 100 specifying the maximum number of continuous export\n descriptions returned.

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

The token from the previous call to describe-export-tasks.

" + } } } }, @@ -1405,18 +1405,18 @@ "smithy.api#documentation": "

One or more filters.

\n " } }, - "exportIds": { - "target": "com.amazonaws.applicationdiscoveryservice#ExportIds", - "traits": { - "smithy.api#documentation": "

One or more unique identifiers used to query the status of an export request.

" - } - }, "maxResults": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#documentation": "

The maximum number of volume results returned by DescribeExportTasks in\n paginated output. When this parameter is used, DescribeExportTasks only returns\n maxResults results in a single page along with a nextToken\n response element.

" } }, + "exportIds": { + "target": "com.amazonaws.applicationdiscoveryservice#ExportIds", + "traits": { + "smithy.api#documentation": "

One or more unique identifiers used to query the status of an export request.

" + } + }, "nextToken": { "target": "com.amazonaws.applicationdiscoveryservice#NextToken", "traits": { @@ -1428,17 +1428,17 @@ "com.amazonaws.applicationdiscoveryservice#DescribeExportTasksResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.applicationdiscoveryservice#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeExportTasks request. When the results of a\n DescribeExportTasks request exceed maxResults, this value can be\n used to retrieve the next page of results. This value is null when there are no more results\n to return.

" - } - }, "exportsInfo": { "target": "com.amazonaws.applicationdiscoveryservice#ExportsInfo", "traits": { "smithy.api#documentation": "

Contains one or more sets of export request details. When the status of a request is\n SUCCEEDED, the response includes a URL for an Amazon S3 bucket where you can\n view the data in a CSV file.

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

The nextToken value to include in a future\n DescribeExportTasks request. When the results of a\n DescribeExportTasks request exceed maxResults, this value can be\n used to retrieve the next page of results. This value is null when there are no more results\n to return.

" + } } } }, @@ -1495,18 +1495,18 @@ "com.amazonaws.applicationdiscoveryservice#DescribeImportTasksRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.applicationdiscoveryservice#NextToken", - "traits": { - "smithy.api#documentation": "

The token to request a specific page of results.

" - } - }, "maxResults": { "target": "com.amazonaws.applicationdiscoveryservice#DescribeImportTasksMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results that you want this request to return, up to 100.

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

The token to request a specific page of results.

" + } + }, "filters": { "target": "com.amazonaws.applicationdiscoveryservice#DescribeImportTasksFilterList", "traits": { @@ -1518,17 +1518,17 @@ "com.amazonaws.applicationdiscoveryservice#DescribeImportTasksResponse": { "type": "structure", "members": { - "tasks": { - "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskList", - "traits": { - "smithy.api#documentation": "

A returned array of import tasks that match any applied filters, up to the specified\n number of maximum results.

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

The token to request the next page of results.

" } + }, + "tasks": { + "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskList", + "traits": { + "smithy.api#documentation": "

A returned array of import tasks that match any applied filters, up to the specified\n number of maximum results.

" + } } } }, @@ -1768,10 +1768,11 @@ "smithy.api#documentation": "

A URL for an Amazon S3 bucket where you can review the exported data. The URL is\n displayed only if the export succeeded.

" } }, - "requestedEndTime": { - "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", + "statusMessage": { + "target": "com.amazonaws.applicationdiscoveryservice#ExportStatusMessage", "traits": { - "smithy.api#documentation": "

The endTime used in the StartExportTask request. If no\n endTime was requested, this result does not appear in\n ExportInfo.

" + "smithy.api#documentation": "

A status message provided for API callers.

", + "smithy.api#required": {} } }, "exportId": { @@ -1781,13 +1782,6 @@ "smithy.api#required": {} } }, - "statusMessage": { - "target": "com.amazonaws.applicationdiscoveryservice#ExportStatusMessage", - "traits": { - "smithy.api#documentation": "

A status message provided for API callers.

", - "smithy.api#required": {} - } - }, "exportRequestTime": { "target": "com.amazonaws.applicationdiscoveryservice#ExportRequestTime", "traits": { @@ -1795,17 +1789,16 @@ "smithy.api#required": {} } }, - "requestedStartTime": { + "requestedEndTime": { "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { - "smithy.api#documentation": "

The value of startTime parameter in the StartExportTask\n request. If no startTime was requested, this result does not appear in\n ExportInfo.

" + "smithy.api#documentation": "

The endTime used in the StartExportTask request. If no\n endTime was requested, this result does not appear in\n ExportInfo.

" } }, - "exportStatus": { - "target": "com.amazonaws.applicationdiscoveryservice#ExportStatus", + "requestedStartTime": { + "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { - "smithy.api#documentation": "

The status of the data export job.

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

The value of startTime parameter in the StartExportTask\n request. If no startTime was requested, this result does not appear in\n ExportInfo.

" } }, "isTruncated": { @@ -1813,6 +1806,13 @@ "traits": { "smithy.api#documentation": "

If true, the export of agent information exceeded the size limit for a single export\n and the exported data is incomplete for the requested time range. To address this, select a\n smaller time range for the export by using startDate and\n endDate.

" } + }, + "exportStatus": { + "target": "com.amazonaws.applicationdiscoveryservice#ExportStatus", + "traits": { + "smithy.api#documentation": "

The status of the data export job.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1860,17 +1860,17 @@ "smithy.api#required": {} } }, - "condition": { - "target": "com.amazonaws.applicationdiscoveryservice#Condition", + "values": { + "target": "com.amazonaws.applicationdiscoveryservice#FilterValues", "traits": { - "smithy.api#documentation": "

A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS,\n CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as\n though concatenated by AND. If you specify multiple values for a\n particular filter, the system differentiates the values using OR. Calling\n either DescribeConfigurations or ListConfigurations\n returns attributes of matching configuration items.

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

A string value on which to filter. For example, if you choose the\n destinationServer.osVersion filter name, you could specify Ubuntu\n for the value.

", "smithy.api#required": {} } }, - "values": { - "target": "com.amazonaws.applicationdiscoveryservice#FilterValues", + "condition": { + "target": "com.amazonaws.applicationdiscoveryservice#Condition", "traits": { - "smithy.api#documentation": "

A string value on which to filter. For example, if you choose the\n destinationServer.osVersion filter name, you could specify Ubuntu\n for the value.

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

A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS,\n CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as\n though concatenated by AND. If you specify multiple values for a\n particular filter, the system differentiates the values using OR. Calling\n either DescribeConfigurations or ListConfigurations\n returns attributes of matching configuration items.

", "smithy.api#required": {} } } @@ -1936,28 +1936,22 @@ "com.amazonaws.applicationdiscoveryservice#GetDiscoverySummaryResponse": { "type": "structure", "members": { - "serversMappedtoTags": { - "target": "com.amazonaws.applicationdiscoveryservice#Long", - "traits": { - "smithy.api#documentation": "

The number of servers mapped to tags.

" - } - }, - "serversMappedToApplications": { + "servers": { "target": "com.amazonaws.applicationdiscoveryservice#Long", "traits": { - "smithy.api#documentation": "

The number of servers mapped to applications.

" + "smithy.api#documentation": "

The number of servers discovered.

" } }, - "servers": { + "serversMappedtoTags": { "target": "com.amazonaws.applicationdiscoveryservice#Long", "traits": { - "smithy.api#documentation": "

The number of servers discovered.

" + "smithy.api#documentation": "

The number of servers mapped to tags.

" } }, - "applications": { + "serversMappedToApplications": { "target": "com.amazonaws.applicationdiscoveryservice#Long", "traits": { - "smithy.api#documentation": "

The number of applications discovered.

" + "smithy.api#documentation": "

The number of servers mapped to applications.

" } }, "connectorSummary": { @@ -1971,6 +1965,12 @@ "traits": { "smithy.api#documentation": "

Details about discovered agents, including agent status and health.

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

The number of applications discovered.

" + } } } }, @@ -2041,10 +2041,22 @@ "com.amazonaws.applicationdiscoveryservice#ImportTask": { "type": "structure", "members": { - "importDeletedTime": { + "status": { + "target": "com.amazonaws.applicationdiscoveryservice#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import task. An import can have the status of\n IMPORT_COMPLETE and still have some records fail to import from the overall\n request. More information can be found in the downloadable archive defined in the\n errorsAndFailedEntriesZip field, or in the Migration Hub management\n console.

" + } + }, + "importCompletionTime": { "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { - "smithy.api#documentation": "

The time that the import task request was deleted, presented in the Unix time stamp\n format.

" + "smithy.api#documentation": "

The time that the import task request finished, presented in the Unix time stamp\n format.

" + } + }, + "applicationImportSuccess": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "

The total number of application records in the import file that were successfully\n imported.

" } }, "name": { @@ -2053,16 +2065,16 @@ "smithy.api#documentation": "

A descriptive name for an import task. You can use this name to filter future requests\n related to this import task, such as identifying applications and servers that were included\n in this import task. We recommend that you use a meaningful name for each import task.

" } }, - "serverImportFailure": { - "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "importUrl": { + "target": "com.amazonaws.applicationdiscoveryservice#ImportURL", "traits": { - "smithy.api#documentation": "

The total number of server records in the import file that failed to be imported.

" + "smithy.api#documentation": "

The URL for your import file that you've uploaded to Amazon S3.

" } }, - "serverImportSuccess": { - "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "importDeletedTime": { + "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { - "smithy.api#documentation": "

The total number of server records in the import file that were successfully\n imported.

" + "smithy.api#documentation": "

The time that the import task request was deleted, presented in the Unix time stamp\n format.

" } }, "clientRequestToken": { @@ -2071,34 +2083,28 @@ "smithy.api#documentation": "

A unique token used to prevent the same import request from occurring more than once. If\n you didn't provide a token, a token was automatically generated when the import task request\n was sent.

" } }, - "importRequestTime": { - "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", - "traits": { - "smithy.api#documentation": "

The time that the import task request was made, presented in the Unix time stamp\n format.

" - } - }, - "applicationImportSuccess": { + "serverImportSuccess": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

The total number of application records in the import file that were successfully\n imported.

" + "smithy.api#documentation": "

The total number of server records in the import file that were successfully\n imported.

" } }, - "importUrl": { - "target": "com.amazonaws.applicationdiscoveryservice#ImportURL", + "importRequestTime": { + "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { - "smithy.api#documentation": "

The URL for your import file that you've uploaded to Amazon S3.

" + "smithy.api#documentation": "

The time that the import task request was made, presented in the Unix time stamp\n format.

" } }, - "status": { - "target": "com.amazonaws.applicationdiscoveryservice#ImportStatus", + "applicationImportFailure": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

The status of the import task. An import can have the status of\n IMPORT_COMPLETE and still have some records fail to import from the overall\n request. More information can be found in the downloadable archive defined in the\n errorsAndFailedEntriesZip field, or in the Migration Hub management\n console.

" + "smithy.api#documentation": "

The total number of application records in the import file that failed to be\n imported.

" } }, - "importCompletionTime": { - "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", + "serverImportFailure": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

The time that the import task request finished, presented in the Unix time stamp\n format.

" + "smithy.api#documentation": "

The total number of server records in the import file that failed to be imported.

" } }, "errorsAndFailedEntriesZip": { @@ -2107,12 +2113,6 @@ "smithy.api#documentation": "

A link to a compressed archive folder (in the ZIP format) that contains an error log and a\n file of failed records. You can use these two files to quickly identify records that failed,\n why they failed, and correct those records. Afterward, you can upload the corrected file to\n your Amazon S3 bucket and create another import task request.

\n\n

This field also includes authorization information so you can confirm the authenticity of\n the compressed archive before you download it.

\n\n

If some records failed to be imported we recommend that you correct the records in the\n failed entries file and then imports that failed entries file. This prevents you from having\n to correct and update the larger original file and attempt importing it again.

" } }, - "applicationImportFailure": { - "target": "com.amazonaws.applicationdiscoveryservice#Integer", - "traits": { - "smithy.api#documentation": "

The total number of application records in the import file that failed to be\n imported.

" - } - }, "importTaskId": { "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskIdentifier", "traits": { @@ -2127,17 +2127,17 @@ "com.amazonaws.applicationdiscoveryservice#ImportTaskFilter": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskFilterName", - "traits": { - "smithy.api#documentation": "

The name, status, or import task ID for a specific import task.

" - } - }, "values": { "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskFilterValueList", "traits": { "smithy.api#documentation": "

An array of strings that you can provide to match against a specific name, status, or\n import task ID to filter the results for your import task queries.

" } + }, + "name": { + "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskFilterName", + "traits": { + "smithy.api#documentation": "

The name, status, or import task ID for a specific import task.

" + } } }, "traits": { @@ -2275,6 +2275,12 @@ "com.amazonaws.applicationdiscoveryservice#ListConfigurationsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.applicationdiscoveryservice#NextToken", + "traits": { + "smithy.api#documentation": "

Token to retrieve the next set of results. For example, if a previous call to\n ListConfigurations returned 100 items, but you set\n ListConfigurationsRequest$maxResults to 10, you received a set of 10 results\n along with a token. Use that token in this query to get the next set of 10.

" + } + }, "maxResults": { "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { @@ -2287,12 +2293,6 @@ "smithy.api#documentation": "

Certain filter criteria return output that can be sorted in ascending or descending\n order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the AWS Application Discovery\n Service User Guide.

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

Token to retrieve the next set of results. For example, if a previous call to\n ListConfigurations returned 100 items, but you set\n ListConfigurationsRequest$maxResults to 10, you received a set of 10 results\n along with a token. Use that token in this query to get the next set of 10.

" - } - }, "configurationType": { "target": "com.amazonaws.applicationdiscoveryservice#ConfigurationItemType", "traits": { @@ -2357,22 +2357,16 @@ "com.amazonaws.applicationdiscoveryservice#ListServerNeighborsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.applicationdiscoveryservice#Integer", - "traits": { - "smithy.api#documentation": "

Maximum number of results to return in a single page of output.

" - } - }, "neighborConfigurationIds": { "target": "com.amazonaws.applicationdiscoveryservice#ConfigurationIdList", "traits": { "smithy.api#documentation": "

List of configuration IDs to test for one-hop-away.

" } }, - "portInformationNeeded": { - "target": "com.amazonaws.applicationdiscoveryservice#Boolean", + "maxResults": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { - "smithy.api#documentation": "

Flag to indicate if port and protocol information is needed as part of the\n response.

" + "smithy.api#documentation": "

Maximum number of results to return in a single page of output.

" } }, "nextToken": { @@ -2387,6 +2381,12 @@ "smithy.api#documentation": "

Configuration ID of the server for which neighbors are being listed.

", "smithy.api#required": {} } + }, + "portInformationNeeded": { + "target": "com.amazonaws.applicationdiscoveryservice#Boolean", + "traits": { + "smithy.api#documentation": "

Flag to indicate if port and protocol information is needed as part of the\n response.

" + } } } }, @@ -2423,13 +2423,6 @@ "com.amazonaws.applicationdiscoveryservice#NeighborConnectionDetail": { "type": "structure", "members": { - "connectionsCount": { - "target": "com.amazonaws.applicationdiscoveryservice#Long", - "traits": { - "smithy.api#documentation": "

The number of open network connections with the neighboring server.

", - "smithy.api#required": {} - } - }, "destinationServerId": { "target": "com.amazonaws.applicationdiscoveryservice#ConfigurationId", "traits": { @@ -2437,6 +2430,12 @@ "smithy.api#required": {} } }, + "transportProtocol": { + "target": "com.amazonaws.applicationdiscoveryservice#String", + "traits": { + "smithy.api#documentation": "

The network protocol used for the connection.

" + } + }, "sourceServerId": { "target": "com.amazonaws.applicationdiscoveryservice#ConfigurationId", "traits": { @@ -2444,17 +2443,18 @@ "smithy.api#required": {} } }, - "transportProtocol": { - "target": "com.amazonaws.applicationdiscoveryservice#String", - "traits": { - "smithy.api#documentation": "

The network protocol used for the connection.

" - } - }, "destinationPort": { "target": "com.amazonaws.applicationdiscoveryservice#BoxedInteger", "traits": { "smithy.api#documentation": "

The destination network port for the connection.

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

The number of open network connections with the neighboring server.

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

The name of the s3 bucket where the export data parquet files are stored.

" } }, - "schemaStorageConfig": { - "target": "com.amazonaws.applicationdiscoveryservice#SchemaStorageConfig", - "traits": { - "smithy.api#documentation": "

A dictionary which describes how the data is stored.

\n " - } - }, "dataSource": { "target": "com.amazonaws.applicationdiscoveryservice#DataSource", "traits": { @@ -2633,6 +2627,12 @@ "smithy.api#documentation": "

The timestamp representing when the continuous export was started.

" } }, + "schemaStorageConfig": { + "target": "com.amazonaws.applicationdiscoveryservice#SchemaStorageConfig", + "traits": { + "smithy.api#documentation": "

A dictionary which describes how the data is stored.

\n " + } + }, "exportId": { "target": "com.amazonaws.applicationdiscoveryservice#ConfigurationsExportId", "traits": { @@ -2728,12 +2728,6 @@ "com.amazonaws.applicationdiscoveryservice#StartExportTaskRequest": { "type": "structure", "members": { - "startTime": { - "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", - "traits": { - "smithy.api#documentation": "

The start timestamp for exported data from the single Application Discovery Agent\n selected in the filters. If no value is specified, data is exported starting from the first\n data collected by the agent.

" - } - }, "endTime": { "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { @@ -2751,6 +2745,12 @@ "traits": { "smithy.api#documentation": "

The file format for the returned export data. Default value is CSV.\n Note:\n The\n GRAPHML\n option has been deprecated.\n

" } + }, + "startTime": { + "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", + "traits": { + "smithy.api#documentation": "

The start timestamp for exported data from the single Application Discovery Agent\n selected in the filters. If no value is specified, data is exported starting from the first\n data collected by the agent.

" + } } } }, @@ -2800,6 +2800,13 @@ "com.amazonaws.applicationdiscoveryservice#StartImportTaskRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskName", + "traits": { + "smithy.api#documentation": "

A descriptive name for this request. You can use this name to filter future requests\n related to this import task, such as identifying applications and servers that were included\n in this import task. We recommend that you use a meaningful name for each import task.

", + "smithy.api#required": {} + } + }, "importUrl": { "target": "com.amazonaws.applicationdiscoveryservice#ImportURL", "traits": { @@ -2813,13 +2820,6 @@ "smithy.api#documentation": "

Optional. A unique token that you can provide to prevent the same import request from\n occurring more than once. If you don't provide a token, a token is automatically\n generated.

\n\n

Sending more than one StartImportTask request with the same client request\n token will return information about the original import task with that client request\n token.

", "smithy.api#idempotencyToken": {} } - }, - "name": { - "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskName", - "traits": { - "smithy.api#documentation": "

A descriptive name for this request. You can use this name to filter future requests\n related to this import task, such as identifying applications and servers that were included\n in this import task. We recommend that you use a meaningful name for each import task.

", - "smithy.api#required": {} - } } } }, @@ -2887,16 +2887,16 @@ "com.amazonaws.applicationdiscoveryservice#StopContinuousExportResponse": { "type": "structure", "members": { - "startTime": { + "stopTime": { "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { - "smithy.api#documentation": "

Timestamp that represents when this continuous export started collecting\n data.

" + "smithy.api#documentation": "

Timestamp that represents when this continuous export was stopped.

" } }, - "stopTime": { + "startTime": { "target": "com.amazonaws.applicationdiscoveryservice#TimeStamp", "traits": { - "smithy.api#documentation": "

Timestamp that represents when this continuous export was stopped.

" + "smithy.api#documentation": "

Timestamp that represents when this continuous export started collecting\n data.

" } } } @@ -2990,17 +2990,17 @@ "com.amazonaws.applicationdiscoveryservice#TagFilter": { "type": "structure", "members": { - "values": { - "target": "com.amazonaws.applicationdiscoveryservice#FilterValues", + "name": { + "target": "com.amazonaws.applicationdiscoveryservice#FilterName", "traits": { - "smithy.api#documentation": "

Values for the tag filter.

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

A name of the tag filter.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.applicationdiscoveryservice#FilterName", + "values": { + "target": "com.amazonaws.applicationdiscoveryservice#FilterValues", "traits": { - "smithy.api#documentation": "

A name of the tag filter.

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

Values for the tag filter.

", "smithy.api#required": {} } } @@ -3077,6 +3077,13 @@ "com.amazonaws.applicationdiscoveryservice#UpdateApplicationRequest": { "type": "structure", "members": { + "configurationId": { + "target": "com.amazonaws.applicationdiscoveryservice#ApplicationId", + "traits": { + "smithy.api#documentation": "

Configuration ID of the application to be updated.

", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { @@ -3088,13 +3095,6 @@ "traits": { "smithy.api#documentation": "

New description of the application to be updated.

" } - }, - "configurationId": { - "target": "com.amazonaws.applicationdiscoveryservice#ApplicationId", - "traits": { - "smithy.api#documentation": "

Configuration ID of the application to be updated.

", - "smithy.api#required": {} - } } } }, diff --git a/codegen/sdk-codegen/aws-models/application-insights.2018-11-25.json b/codegen/sdk-codegen/aws-models/application-insights.2018-11-25.json index 625b46bd46fe..2eabfb793fc1 100644 --- a/codegen/sdk-codegen/aws-models/application-insights.2018-11-25.json +++ b/codegen/sdk-codegen/aws-models/application-insights.2018-11-25.json @@ -44,29 +44,29 @@ "com.amazonaws.applicationinsights#ApplicationComponent": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.applicationinsights#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

" - } - }, "ComponentName": { "target": "com.amazonaws.applicationinsights#ComponentName", "traits": { "smithy.api#documentation": "

The name of the component.

" } }, - "Monitor": { - "target": "com.amazonaws.applicationinsights#Monitor", - "traits": { - "smithy.api#documentation": "

Indicates whether the application component is monitored.

" - } - }, "Tier": { "target": "com.amazonaws.applicationinsights#Tier", "traits": { "smithy.api#documentation": "

The stack tier of the application component.

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

The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

" + } + }, + "Monitor": { + "target": "com.amazonaws.applicationinsights#Monitor", + "traits": { + "smithy.api#documentation": "

Indicates whether the application component is monitored.

" + } } }, "traits": { @@ -82,18 +82,6 @@ "com.amazonaws.applicationinsights#ApplicationInfo": { "type": "structure", "members": { - "OpsItemSNSTopicArn": { - "target": "com.amazonaws.applicationinsights#OpsItemSNSTopicArn", - "traits": { - "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications\n for opsItem updates.\n

" - } - }, - "LifeCycle": { - "target": "com.amazonaws.applicationinsights#LifeCycle", - "traits": { - "smithy.api#documentation": "

The lifecycle of the application.

" - } - }, "ResourceGroupName": { "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { @@ -117,6 +105,18 @@ "traits": { "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" } + }, + "OpsItemSNSTopicArn": { + "target": "com.amazonaws.applicationinsights#OpsItemSNSTopicArn", + "traits": { + "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications\n for opsItem updates.\n

" + } + }, + "LifeCycle": { + "target": "com.amazonaws.applicationinsights#LifeCycle", + "traits": { + "smithy.api#documentation": "

The lifecycle of the application.

" + } } }, "traits": { @@ -200,24 +200,6 @@ "com.amazonaws.applicationinsights#ConfigurationEvent": { "type": "structure", "members": { - "EventDetail": { - "target": "com.amazonaws.applicationinsights#ConfigurationEventDetail", - "traits": { - "smithy.api#documentation": "

\n The details of the event in plain text. \n

" - } - }, - "MonitoredResourceARN": { - "target": "com.amazonaws.applicationinsights#ConfigurationEventMonitoredResourceARN", - "traits": { - "smithy.api#documentation": "

\n The resource monitored by Application Insights.\n

" - } - }, - "EventStatus": { - "target": "com.amazonaws.applicationinsights#ConfigurationEventStatus", - "traits": { - "smithy.api#documentation": "

\n The status of the configuration update event. Possible values include INFO, WARN, and ERROR.\n

" - } - }, "EventResourceName": { "target": "com.amazonaws.applicationinsights#ConfigurationEventResourceName", "traits": { @@ -235,6 +217,24 @@ "traits": { "smithy.api#documentation": "

\n The timestamp of the event. \n

" } + }, + "EventDetail": { + "target": "com.amazonaws.applicationinsights#ConfigurationEventDetail", + "traits": { + "smithy.api#documentation": "

\n The details of the event in plain text. \n

" + } + }, + "MonitoredResourceARN": { + "target": "com.amazonaws.applicationinsights#ConfigurationEventMonitoredResourceARN", + "traits": { + "smithy.api#documentation": "

\n The resource monitored by Application Insights.\n

" + } + }, + "EventStatus": { + "target": "com.amazonaws.applicationinsights#ConfigurationEventStatus", + "traits": { + "smithy.api#documentation": "

\n The status of the configuration update event. Possible values include INFO, WARN, and ERROR.\n

" + } } }, "traits": { @@ -323,6 +323,12 @@ "com.amazonaws.applicationinsights#CreateApplicationRequest": { "type": "structure", "members": { + "CWEMonitorEnabled": { + "target": "com.amazonaws.applicationinsights#CWEMonitorEnabled", + "traits": { + "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" + } + }, "OpsCenterEnabled": { "target": "com.amazonaws.applicationinsights#OpsCenterEnabled", "traits": { @@ -335,12 +341,6 @@ "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to\n receive notifications for updates to the opsItem.\n

" } }, - "Tags": { - "target": "com.amazonaws.applicationinsights#TagList", - "traits": { - "smithy.api#documentation": "

List of tags to add to the application.\n tag key (Key) and an associated tag value (Value). The maximum\n length of a tag key is 128 characters. The maximum length of a tag value is 256\n characters.

" - } - }, "ResourceGroupName": { "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { @@ -348,10 +348,10 @@ "smithy.api#required": {} } }, - "CWEMonitorEnabled": { - "target": "com.amazonaws.applicationinsights#CWEMonitorEnabled", + "Tags": { + "target": "com.amazonaws.applicationinsights#TagList", "traits": { - "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" + "smithy.api#documentation": "

List of tags to add to the application.\n tag key (Key) and an associated tag value (Value). The maximum\n length of a tag key is 128 characters. The maximum length of a tag value is 256\n characters.

" } } } @@ -396,13 +396,6 @@ "com.amazonaws.applicationinsights#CreateComponentRequest": { "type": "structure", "members": { - "ResourceList": { - "target": "com.amazonaws.applicationinsights#ResourceList", - "traits": { - "smithy.api#documentation": "

The list of resource ARNs that belong to the component.

", - "smithy.api#required": {} - } - }, "ComponentName": { "target": "com.amazonaws.applicationinsights#ComponentName", "traits": { @@ -416,6 +409,13 @@ "smithy.api#documentation": "

The name of the resource group.

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

The list of resource ARNs that belong to the component.

", + "smithy.api#required": {} + } } } }, @@ -452,6 +452,20 @@ "com.amazonaws.applicationinsights#CreateLogPatternRequest": { "type": "structure", "members": { + "Pattern": { + "target": "com.amazonaws.applicationinsights#LogPatternRegex", + "traits": { + "smithy.api#documentation": "

The log pattern.

", + "smithy.api#required": {} + } + }, + "PatternSetName": { + "target": "com.amazonaws.applicationinsights#LogPatternSetName", + "traits": { + "smithy.api#documentation": "

The name of the log pattern set.

", + "smithy.api#required": {} + } + }, "Rank": { "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { @@ -472,37 +486,23 @@ "smithy.api#documentation": "

The name of the resource group.

", "smithy.api#required": {} } - }, - "PatternSetName": { - "target": "com.amazonaws.applicationinsights#LogPatternSetName", - "traits": { - "smithy.api#documentation": "

The name of the log pattern set.

", - "smithy.api#required": {} - } - }, - "Pattern": { - "target": "com.amazonaws.applicationinsights#LogPatternRegex", - "traits": { - "smithy.api#documentation": "

The log pattern.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.applicationinsights#CreateLogPatternResponse": { "type": "structure", "members": { - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", - "traits": { - "smithy.api#documentation": "

The name of the resource group.

" - } - }, "LogPattern": { "target": "com.amazonaws.applicationinsights#LogPattern", "traits": { "smithy.api#documentation": "

The successfully created log pattern.

" } + }, + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

" + } } } }, @@ -623,6 +623,13 @@ "com.amazonaws.applicationinsights#DeleteLogPatternRequest": { "type": "structure", "members": { + "PatternSetName": { + "target": "com.amazonaws.applicationinsights#LogPatternSetName", + "traits": { + "smithy.api#documentation": "

The name of the log pattern set.

", + "smithy.api#required": {} + } + }, "PatternName": { "target": "com.amazonaws.applicationinsights#LogPatternName", "traits": { @@ -636,13 +643,6 @@ "smithy.api#documentation": "

The name of the resource group.

", "smithy.api#required": {} } - }, - "PatternSetName": { - "target": "com.amazonaws.applicationinsights#LogPatternSetName", - "traits": { - "smithy.api#documentation": "

The name of the log pattern set.

", - "smithy.api#required": {} - } } } }, @@ -768,13 +768,6 @@ "com.amazonaws.applicationinsights#DescribeComponentConfigurationRecommendationRequest": { "type": "structure", "members": { - "ComponentName": { - "target": "com.amazonaws.applicationinsights#ComponentName", - "traits": { - "smithy.api#documentation": "

The name of the component.

", - "smithy.api#required": {} - } - }, "Tier": { "target": "com.amazonaws.applicationinsights#Tier", "traits": { @@ -788,6 +781,13 @@ "smithy.api#documentation": "

The name of the resource group.

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

The name of the component.

", + "smithy.api#required": {} + } } } }, @@ -805,17 +805,17 @@ "com.amazonaws.applicationinsights#DescribeComponentConfigurationRequest": { "type": "structure", "members": { - "ComponentName": { - "target": "com.amazonaws.applicationinsights#ComponentName", + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { - "smithy.api#documentation": "

The name of the component.

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

The name of the resource group.

", "smithy.api#required": {} } }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "ComponentName": { + "target": "com.amazonaws.applicationinsights#ComponentName", "traits": { - "smithy.api#documentation": "

The name of the resource group.

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

The name of the component.

", "smithy.api#required": {} } } @@ -824,10 +824,10 @@ "com.amazonaws.applicationinsights#DescribeComponentConfigurationResponse": { "type": "structure", "members": { - "Tier": { - "target": "com.amazonaws.applicationinsights#Tier", + "ComponentConfiguration": { + "target": "com.amazonaws.applicationinsights#ComponentConfiguration", "traits": { - "smithy.api#documentation": "

The tier of the application component. Supported tiers include\n DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB,\n SQL_SERVER, and DEFAULT\n

" + "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the configuration.

" } }, "Monitor": { @@ -836,10 +836,10 @@ "smithy.api#documentation": "

Indicates whether the application component is monitored.

" } }, - "ComponentConfiguration": { - "target": "com.amazonaws.applicationinsights#ComponentConfiguration", + "Tier": { + "target": "com.amazonaws.applicationinsights#Tier", "traits": { - "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the configuration.

" + "smithy.api#documentation": "

The tier of the application component. Supported tiers include\n DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB,\n SQL_SERVER, and DEFAULT\n

" } } } @@ -866,14 +866,14 @@ "com.amazonaws.applicationinsights#DescribeComponentResponse": { "type": "structure", "members": { - "ApplicationComponent": { - "target": "com.amazonaws.applicationinsights#ApplicationComponent" - }, "ResourceList": { "target": "com.amazonaws.applicationinsights#ResourceList", "traits": { "smithy.api#documentation": "

The list of resource ARNs that belong to the component.

" } + }, + "ApplicationComponent": { + "target": "com.amazonaws.applicationinsights#ApplicationComponent" } } }, @@ -903,6 +903,13 @@ "com.amazonaws.applicationinsights#DescribeLogPatternRequest": { "type": "structure", "members": { + "PatternSetName": { + "target": "com.amazonaws.applicationinsights#LogPatternSetName", + "traits": { + "smithy.api#documentation": "

The name of the log pattern set.

", + "smithy.api#required": {} + } + }, "PatternName": { "target": "com.amazonaws.applicationinsights#LogPatternName", "traits": { @@ -916,30 +923,23 @@ "smithy.api#documentation": "

The name of the resource group.

", "smithy.api#required": {} } - }, - "PatternSetName": { - "target": "com.amazonaws.applicationinsights#LogPatternSetName", - "traits": { - "smithy.api#documentation": "

The name of the log pattern set.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.applicationinsights#DescribeLogPatternResponse": { "type": "structure", "members": { - "LogPattern": { - "target": "com.amazonaws.applicationinsights#LogPattern", - "traits": { - "smithy.api#documentation": "

The successfully created log pattern.

" - } - }, "ResourceGroupName": { "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { "smithy.api#documentation": "

The name of the resource group.

" } + }, + "LogPattern": { + "target": "com.amazonaws.applicationinsights#LogPattern", + "traits": { + "smithy.api#documentation": "

The successfully created log pattern.

" + } } } }, @@ -1172,7 +1172,7 @@ "sdkId": "Application Insights", "arnNamespace": "applicationinsights", "cloudFormationName": "ApplicationInsights", - "cloudTrailEventSource": "ec2windowsbarley.amazonaws.com" + "cloudTrailEventSource": "applicationinsights.amazonaws.com" }, "aws.auth#sigv4": { "name": "applicationinsights" @@ -1317,17 +1317,17 @@ "com.amazonaws.applicationinsights#ListApplicationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.applicationinsights#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token used to retrieve the next page of results. This value is null\n when there are no more results to return.

" - } - }, "ApplicationInfoList": { "target": "com.amazonaws.applicationinsights#ApplicationInfoList", "traits": { "smithy.api#documentation": "

The list of applications.

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

The token used to retrieve the next page of results. This value is null\n when there are no more results to return.

" + } } } }, @@ -1362,8 +1362,14 @@ "com.amazonaws.applicationinsights#ListComponentsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.applicationinsights#MaxEntities", + "NextToken": { + "target": "com.amazonaws.applicationinsights#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationinsights#MaxEntities", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" } @@ -1374,12 +1380,6 @@ "smithy.api#documentation": "

The name of the resource group.

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

The token to request the next page of results.

" - } } } }, @@ -1431,28 +1431,22 @@ "com.amazonaws.applicationinsights#ListConfigurationHistoryRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.applicationinsights#MaxEntities", - "traits": { - "smithy.api#documentation": "

The maximum number of results returned by ListConfigurationHistory in\n paginated output. When this parameter is used, ListConfigurationHistory\n returns only MaxResults in a single page along with a NextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListConfigurationHistory request with the returned\n NextToken value. If this parameter is not used, then\n ListConfigurationHistory returns all results.

" - } - }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", - "traits": { - "smithy.api#documentation": "

Resource group to which the application belongs.

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

The NextToken value returned from a previous paginated ListConfigurationHistory request where\n 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\n value is null when there are no more results to return.

" } }, - "EventStatus": { - "target": "com.amazonaws.applicationinsights#ConfigurationEventStatus", + "StartTime": { + "target": "com.amazonaws.applicationinsights#StartTime", "traits": { - "smithy.api#documentation": "

The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

" + "smithy.api#documentation": "

The start time of the event.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationinsights#MaxEntities", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by ListConfigurationHistory in\n paginated output. When this parameter is used, ListConfigurationHistory\n returns only MaxResults in a single page along with a NextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListConfigurationHistory request with the returned\n NextToken value. If this parameter is not used, then\n ListConfigurationHistory returns all results.

" } }, "EndTime": { @@ -1461,10 +1455,16 @@ "smithy.api#documentation": "

The end time of the event.

" } }, - "StartTime": { - "target": "com.amazonaws.applicationinsights#StartTime", + "EventStatus": { + "target": "com.amazonaws.applicationinsights#ConfigurationEventStatus", "traits": { - "smithy.api#documentation": "

The start time of the event.

" + "smithy.api#documentation": "

The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

" + } + }, + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

Resource group to which the application belongs.

" } } } @@ -1472,17 +1472,17 @@ "com.amazonaws.applicationinsights#ListConfigurationHistoryResponse": { "type": "structure", "members": { - "EventList": { - "target": "com.amazonaws.applicationinsights#ConfigurationEventList", - "traits": { - "smithy.api#documentation": "

The list of configuration events and their corresponding details.

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

The NextToken value to include in a future\n ListConfigurationHistory request. When the results of a\n ListConfigurationHistory request exceed MaxResults, this value\n can be used to retrieve the next page of results. This value is null when\n there are no more results to return.

" } + }, + "EventList": { + "target": "com.amazonaws.applicationinsights#ConfigurationEventList", + "traits": { + "smithy.api#documentation": "

The list of configuration events and their corresponding details.

" + } } } }, @@ -1517,6 +1517,12 @@ "com.amazonaws.applicationinsights#ListLogPatternSetsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.applicationinsights#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, "MaxResults": { "target": "com.amazonaws.applicationinsights#MaxEntities", "traits": { @@ -1529,12 +1535,6 @@ "smithy.api#documentation": "

The name of the resource group.

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

The token to request the next page of results.

" - } } } }, @@ -1547,17 +1547,17 @@ "smithy.api#documentation": "

The name of the resource group.

" } }, - "LogPatternSets": { - "target": "com.amazonaws.applicationinsights#LogPatternSetList", - "traits": { - "smithy.api#documentation": "

The list of log pattern sets.

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

The token used to retrieve the next page of results. This value is null\n when there are no more results to return.

" } + }, + "LogPatternSets": { + "target": "com.amazonaws.applicationinsights#LogPatternSetList", + "traits": { + "smithy.api#documentation": "

The list of log pattern sets.

" + } } } }, @@ -1592,6 +1592,12 @@ "com.amazonaws.applicationinsights#ListLogPatternsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.applicationinsights#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, "ResourceGroupName": { "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { @@ -1610,18 +1616,18 @@ "traits": { "smithy.api#documentation": "

The name of the log pattern set.

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

The token to request the next page of results.

" - } } } }, "com.amazonaws.applicationinsights#ListLogPatternsResponse": { "type": "structure", "members": { + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

" + } + }, "NextToken": { "target": "com.amazonaws.applicationinsights#PaginationToken", "traits": { @@ -1633,12 +1639,6 @@ "traits": { "smithy.api#documentation": "

The list of log patterns.

" } - }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", - "traits": { - "smithy.api#documentation": "

The name of the resource group.

" - } } } }, @@ -1673,34 +1673,34 @@ "com.amazonaws.applicationinsights#ListProblemsRequest": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.applicationinsights#StartTime", + "NextToken": { + "target": "com.amazonaws.applicationinsights#PaginationToken", "traits": { - "smithy.api#documentation": "

The time when the problem was detected, in epoch\n seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.

" + "smithy.api#documentation": "

The token to request the next page of results.

" } }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "MaxResults": { + "target": "com.amazonaws.applicationinsights#MaxEntities", "traits": { - "smithy.api#documentation": "

The name of the resource group.

" + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" } }, - "EndTime": { - "target": "com.amazonaws.applicationinsights#EndTime", + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { - "smithy.api#documentation": "

The time when the problem ended, in epoch seconds. If not specified, problems within the\n past seven days are returned.

" + "smithy.api#documentation": "

The name of the resource group.

" } }, - "NextToken": { - "target": "com.amazonaws.applicationinsights#PaginationToken", + "StartTime": { + "target": "com.amazonaws.applicationinsights#StartTime", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" + "smithy.api#documentation": "

The time when the problem was detected, in epoch\n seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.

" } }, - "MaxResults": { - "target": "com.amazonaws.applicationinsights#MaxEntities", + "EndTime": { + "target": "com.amazonaws.applicationinsights#EndTime", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" + "smithy.api#documentation": "

The time when the problem ended, in epoch seconds. If not specified, problems within the\n past seven days are returned.

" } } } @@ -1787,10 +1787,10 @@ "com.amazonaws.applicationinsights#LogPattern": { "type": "structure", "members": { - "PatternSetName": { - "target": "com.amazonaws.applicationinsights#LogPatternSetName", + "PatternName": { + "target": "com.amazonaws.applicationinsights#LogPatternName", "traits": { - "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contains at many as 30 characters, and it cannot\n be empty. The characters can be Unicode letters, digits or one of the following symbols: period, dash, underscore.

" + "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contains at many as 50 characters, and it cannot\n be empty. The characters can be Unicode letters, digits or one of the following symbols: period, dash, underscore.

" } }, "Rank": { @@ -1805,10 +1805,10 @@ "smithy.api#documentation": "

A regular expression that defines the log pattern. A log pattern can contains at many as 50 characters, and it cannot\n be empty.

" } }, - "PatternName": { - "target": "com.amazonaws.applicationinsights#LogPatternName", + "PatternSetName": { + "target": "com.amazonaws.applicationinsights#LogPatternSetName", "traits": { - "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contains at many as 50 characters, and it cannot\n be empty. The characters can be Unicode letters, digits or one of the following symbols: period, dash, underscore.

" + "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contains at many as 30 characters, and it cannot\n be empty. The characters can be Unicode letters, digits or one of the following symbols: period, dash, underscore.

" } } }, @@ -1891,208 +1891,208 @@ "com.amazonaws.applicationinsights#Observation": { "type": "structure", "members": { - "CloudWatchEventSource": { - "target": "com.amazonaws.applicationinsights#CloudWatchEventSource", + "LineTime": { + "target": "com.amazonaws.applicationinsights#LineTime", "traits": { - "smithy.api#documentation": "

The source of the CloudWatch Event.

" + "smithy.api#documentation": "

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

" } }, - "CloudWatchEventDetailType": { - "target": "com.amazonaws.applicationinsights#CloudWatchEventDetailType", + "HealthService": { + "target": "com.amazonaws.applicationinsights#HealthService", "traits": { - "smithy.api#documentation": "

The detail type of the CloudWatch Event-based observation, for example, EC2\n Instance State-change Notification.

" + "smithy.api#documentation": "

The service to which the AWS Health Event belongs, such as EC2.

" } }, - "XRayNodeName": { - "target": "com.amazonaws.applicationinsights#XRayNodeName", + "CodeDeployState": { + "target": "com.amazonaws.applicationinsights#CodeDeployState", "traits": { - "smithy.api#documentation": "

\n The name of the X-Ray node.\n

" + "smithy.api#documentation": "

\n The status of the CodeDeploy deployment, for example SUCCESS or FAILURE. \n

" } }, - "Id": { - "target": "com.amazonaws.applicationinsights#ObservationId", + "CodeDeployDeploymentId": { + "target": "com.amazonaws.applicationinsights#CodeDeployDeploymentId", "traits": { - "smithy.api#documentation": "

The ID of the observation type.

" + "smithy.api#documentation": "

The deployment ID of the CodeDeploy-based observation related to the detected problem.

" } }, - "SourceARN": { - "target": "com.amazonaws.applicationinsights#SourceARN", + "XRayFaultPercent": { + "target": "com.amazonaws.applicationinsights#XRayFaultPercent", "traits": { - "smithy.api#documentation": "

The source resource ARN of the observation.

" + "smithy.api#documentation": "

\n The X-Ray request fault percentage for this node.\n

" } }, - "CodeDeployApplication": { - "target": "com.amazonaws.applicationinsights#CodeDeployApplication", + "HealthEventArn": { + "target": "com.amazonaws.applicationinsights#HealthEventArn", "traits": { - "smithy.api#documentation": "

\n The CodeDeploy application to which the deployment belongs.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Health Event-based observation.

" } }, - "HealthEventDescription": { - "target": "com.amazonaws.applicationinsights#HealthEventDescription", + "MetricName": { + "target": "com.amazonaws.applicationinsights#MetricName", "traits": { - "smithy.api#documentation": "

The description of the AWS Health event provided by the service, such as Amazon EC2.

" + "smithy.api#documentation": "

The name of the observation metric.

" } }, - "HealthEventTypeCategory": { - "target": "com.amazonaws.applicationinsights#HealthEventTypeCategory", + "XRayRequestCount": { + "target": "com.amazonaws.applicationinsights#XRayRequestCount", "traits": { - "smithy.api#documentation": "

The category of the AWS Health event, such as issue.

" + "smithy.api#documentation": "

\n The X-Ray request count for this node.\n

" } }, - "XRayThrottlePercent": { - "target": "com.amazonaws.applicationinsights#XRayThrottlePercent", + "CloudWatchEventDetailType": { + "target": "com.amazonaws.applicationinsights#CloudWatchEventDetailType", "traits": { - "smithy.api#documentation": "

\n The X-Ray request throttle percentage for this node.\n

" + "smithy.api#documentation": "

The detail type of the CloudWatch Event-based observation, for example, EC2\n Instance State-change Notification.

" } }, - "Value": { - "target": "com.amazonaws.applicationinsights#Value", + "SourceType": { + "target": "com.amazonaws.applicationinsights#SourceType", "traits": { - "smithy.api#documentation": "

The value of the source observation metric.

" + "smithy.api#documentation": "

The source type of the observation.

" } }, - "LogFilter": { - "target": "com.amazonaws.applicationinsights#LogFilter", + "XRayErrorPercent": { + "target": "com.amazonaws.applicationinsights#XRayErrorPercent", "traits": { - "smithy.api#documentation": "

The log filter of the observation.

" + "smithy.api#documentation": "

\n The X-Ray request error percentage for this node.\n

" } }, - "CodeDeployDeploymentGroup": { - "target": "com.amazonaws.applicationinsights#CodeDeployDeploymentGroup", + "HealthEventTypeCategory": { + "target": "com.amazonaws.applicationinsights#HealthEventTypeCategory", "traits": { - "smithy.api#documentation": "

\n The deployment group to which the CodeDeploy deployment belongs.\n

" + "smithy.api#documentation": "

The category of the AWS Health event, such as issue.

" } }, - "CodeDeployInstanceGroupId": { - "target": "com.amazonaws.applicationinsights#CodeDeployInstanceGroupId", + "XRayRequestAverageLatency": { + "target": "com.amazonaws.applicationinsights#XRayRequestAverageLatency", "traits": { - "smithy.api#documentation": "

\n The instance group to which the CodeDeploy instance belongs. \n

" + "smithy.api#documentation": "

\n The X-Ray node request average latency for this node.\n

" } }, - "CloudWatchEventId": { - "target": "com.amazonaws.applicationinsights#CloudWatchEventId", + "MetricNamespace": { + "target": "com.amazonaws.applicationinsights#MetricNamespace", "traits": { - "smithy.api#documentation": "

The ID of the CloudWatch Event-based observation related to the detected problem.

" + "smithy.api#documentation": "

The namespace of the observation metric.

" } }, - "Unit": { - "target": "com.amazonaws.applicationinsights#Unit", + "Ec2State": { + "target": "com.amazonaws.applicationinsights#Ec2State", "traits": { - "smithy.api#documentation": "

The unit of the source observation metric.

" + "smithy.api#documentation": "

\n The state of the instance, such as STOPPING or TERMINATING.\n

" } }, - "EndTime": { - "target": "com.amazonaws.applicationinsights#EndTime", + "CloudWatchEventId": { + "target": "com.amazonaws.applicationinsights#CloudWatchEventId", "traits": { - "smithy.api#documentation": "

The time when the observation ended, in epoch seconds.

" + "smithy.api#documentation": "

The ID of the CloudWatch Event-based observation related to the detected problem.

" } }, - "LogText": { - "target": "com.amazonaws.applicationinsights#LogText", + "XRayThrottlePercent": { + "target": "com.amazonaws.applicationinsights#XRayThrottlePercent", "traits": { - "smithy.api#documentation": "

The log text of the observation.

" + "smithy.api#documentation": "

\n The X-Ray request throttle percentage for this node.\n

" } }, - "Ec2State": { - "target": "com.amazonaws.applicationinsights#Ec2State", + "StartTime": { + "target": "com.amazonaws.applicationinsights#StartTime", "traits": { - "smithy.api#documentation": "

\n The state of the instance, such as STOPPING or TERMINATING.\n

" + "smithy.api#documentation": "

The time when the observation was first detected, in epoch seconds.

" } }, - "LogGroup": { - "target": "com.amazonaws.applicationinsights#LogGroup", + "Value": { + "target": "com.amazonaws.applicationinsights#Value", "traits": { - "smithy.api#documentation": "

The log group name.

" + "smithy.api#documentation": "

The value of the source observation metric.

" } }, - "XRayRequestAverageLatency": { - "target": "com.amazonaws.applicationinsights#XRayRequestAverageLatency", + "XRayNodeType": { + "target": "com.amazonaws.applicationinsights#XRayNodeType", "traits": { - "smithy.api#documentation": "

\n The X-Ray node request average latency for this node.\n

" + "smithy.api#documentation": "

\n The type of the X-Ray node.

" } }, - "HealthEventTypeCode": { - "target": "com.amazonaws.applicationinsights#HealthEventTypeCode", + "SourceARN": { + "target": "com.amazonaws.applicationinsights#SourceARN", "traits": { - "smithy.api#documentation": "

The type of the AWS Health event, for example,\n AWS_EC2_POWER_CONNECTIVITY_ISSUE.

" + "smithy.api#documentation": "

The source resource ARN of the observation.

" } }, - "CodeDeployDeploymentId": { - "target": "com.amazonaws.applicationinsights#CodeDeployDeploymentId", + "LogText": { + "target": "com.amazonaws.applicationinsights#LogText", "traits": { - "smithy.api#documentation": "

The deployment ID of the CodeDeploy-based observation related to the detected problem.

" + "smithy.api#documentation": "

The log text of the observation.

" } }, - "MetricName": { - "target": "com.amazonaws.applicationinsights#MetricName", + "Id": { + "target": "com.amazonaws.applicationinsights#ObservationId", "traits": { - "smithy.api#documentation": "

The name of the observation metric.

" + "smithy.api#documentation": "

The ID of the observation type.

" } }, - "HealthService": { - "target": "com.amazonaws.applicationinsights#HealthService", + "HealthEventDescription": { + "target": "com.amazonaws.applicationinsights#HealthEventDescription", "traits": { - "smithy.api#documentation": "

The service to which the AWS Health Event belongs, such as EC2.

" + "smithy.api#documentation": "

The description of the AWS Health event provided by the service, such as Amazon EC2.

" } }, - "LineTime": { - "target": "com.amazonaws.applicationinsights#LineTime", + "HealthEventTypeCode": { + "target": "com.amazonaws.applicationinsights#HealthEventTypeCode", "traits": { - "smithy.api#documentation": "

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

" + "smithy.api#documentation": "

The type of the AWS Health event, for example,\n AWS_EC2_POWER_CONNECTIVITY_ISSUE.

" } }, - "HealthEventArn": { - "target": "com.amazonaws.applicationinsights#HealthEventArn", + "XRayNodeName": { + "target": "com.amazonaws.applicationinsights#XRayNodeName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Health Event-based observation.

" + "smithy.api#documentation": "

\n The name of the X-Ray node.\n

" } }, - "CodeDeployState": { - "target": "com.amazonaws.applicationinsights#CodeDeployState", + "EndTime": { + "target": "com.amazonaws.applicationinsights#EndTime", "traits": { - "smithy.api#documentation": "

\n The status of the CodeDeploy deployment, for example SUCCESS or FAILURE. \n

" + "smithy.api#documentation": "

The time when the observation ended, in epoch seconds.

" } }, - "XRayNodeType": { - "target": "com.amazonaws.applicationinsights#XRayNodeType", + "Unit": { + "target": "com.amazonaws.applicationinsights#Unit", "traits": { - "smithy.api#documentation": "

\n The type of the X-Ray node.

" + "smithy.api#documentation": "

The unit of the source observation metric.

" } }, - "SourceType": { - "target": "com.amazonaws.applicationinsights#SourceType", + "CodeDeployApplication": { + "target": "com.amazonaws.applicationinsights#CodeDeployApplication", "traits": { - "smithy.api#documentation": "

The source type of the observation.

" + "smithy.api#documentation": "

\n The CodeDeploy application to which the deployment belongs.\n

" } }, - "XRayRequestCount": { - "target": "com.amazonaws.applicationinsights#XRayRequestCount", + "LogFilter": { + "target": "com.amazonaws.applicationinsights#LogFilter", "traits": { - "smithy.api#documentation": "

\n The X-Ray request count for this node.\n

" + "smithy.api#documentation": "

The log filter of the observation.

" } }, - "StartTime": { - "target": "com.amazonaws.applicationinsights#StartTime", + "CodeDeployInstanceGroupId": { + "target": "com.amazonaws.applicationinsights#CodeDeployInstanceGroupId", "traits": { - "smithy.api#documentation": "

The time when the observation was first detected, in epoch seconds.

" + "smithy.api#documentation": "

\n The instance group to which the CodeDeploy instance belongs. \n

" } }, - "XRayErrorPercent": { - "target": "com.amazonaws.applicationinsights#XRayErrorPercent", + "CloudWatchEventSource": { + "target": "com.amazonaws.applicationinsights#CloudWatchEventSource", "traits": { - "smithy.api#documentation": "

\n The X-Ray request error percentage for this node.\n

" + "smithy.api#documentation": "

The source of the CloudWatch Event.

" } }, - "MetricNamespace": { - "target": "com.amazonaws.applicationinsights#MetricNamespace", + "LogGroup": { + "target": "com.amazonaws.applicationinsights#LogGroup", "traits": { - "smithy.api#documentation": "

The namespace of the observation metric.

" + "smithy.api#documentation": "

The log group name.

" } }, - "XRayFaultPercent": { - "target": "com.amazonaws.applicationinsights#XRayFaultPercent", + "CodeDeployDeploymentGroup": { + "target": "com.amazonaws.applicationinsights#CodeDeployDeploymentGroup", "traits": { - "smithy.api#documentation": "

\n The X-Ray request fault percentage for this node.\n

" + "smithy.api#documentation": "

\n The deployment group to which the CodeDeploy deployment belongs.\n

" } } }, @@ -2137,28 +2137,22 @@ "com.amazonaws.applicationinsights#Problem": { "type": "structure", "members": { - "AffectedResource": { - "target": "com.amazonaws.applicationinsights#AffectedResource", - "traits": { - "smithy.api#documentation": "

The resource affected by the problem.

" - } - }, - "Insights": { - "target": "com.amazonaws.applicationinsights#Insights", + "Title": { + "target": "com.amazonaws.applicationinsights#Title", "traits": { - "smithy.api#documentation": "

A detailed analysis of the problem using machine learning.

" + "smithy.api#documentation": "

The name of the problem.

" } }, - "Feedback": { - "target": "com.amazonaws.applicationinsights#Feedback", + "SeverityLevel": { + "target": "com.amazonaws.applicationinsights#SeverityLevel", "traits": { - "smithy.api#documentation": "

Feedback provided by the user about the problem.

" + "smithy.api#documentation": "

A measure of the level of impact of the problem.

" } }, - "EndTime": { - "target": "com.amazonaws.applicationinsights#EndTime", + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { - "smithy.api#documentation": "

The time when the problem ended, in epoch seconds.

" + "smithy.api#documentation": "

The name of the resource group affected by the problem.

" } }, "Status": { @@ -2167,34 +2161,40 @@ "smithy.api#documentation": "

The status of the problem.

" } }, - "Title": { - "target": "com.amazonaws.applicationinsights#Title", + "EndTime": { + "target": "com.amazonaws.applicationinsights#EndTime", "traits": { - "smithy.api#documentation": "

The name of the problem.

" + "smithy.api#documentation": "

The time when the problem ended, in epoch seconds.

" } }, - "StartTime": { - "target": "com.amazonaws.applicationinsights#StartTime", + "Id": { + "target": "com.amazonaws.applicationinsights#ProblemId", "traits": { - "smithy.api#documentation": "

The time when the problem started, in epoch seconds.

" + "smithy.api#documentation": "

The ID of the problem.

" } }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "Insights": { + "target": "com.amazonaws.applicationinsights#Insights", "traits": { - "smithy.api#documentation": "

The name of the resource group affected by the problem.

" + "smithy.api#documentation": "

A detailed analysis of the problem using machine learning.

" } }, - "Id": { - "target": "com.amazonaws.applicationinsights#ProblemId", + "Feedback": { + "target": "com.amazonaws.applicationinsights#Feedback", "traits": { - "smithy.api#documentation": "

The ID of the problem.

" + "smithy.api#documentation": "

Feedback provided by the user about the problem.

" } }, - "SeverityLevel": { - "target": "com.amazonaws.applicationinsights#SeverityLevel", + "StartTime": { + "target": "com.amazonaws.applicationinsights#StartTime", "traits": { - "smithy.api#documentation": "

A measure of the level of impact of the problem.

" + "smithy.api#documentation": "

The time when the problem started, in epoch seconds.

" + } + }, + "AffectedResource": { + "target": "com.amazonaws.applicationinsights#AffectedResource", + "traits": { + "smithy.api#documentation": "

The resource affected by the problem.

" } } }, @@ -2339,17 +2339,17 @@ "com.amazonaws.applicationinsights#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.applicationinsights#TagKey", + "Value": { + "target": "com.amazonaws.applicationinsights#TagValue", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

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

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want an\n application to have a specific tag value, don't specify a value for this parameter.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.applicationinsights#TagValue", + "Key": { + "target": "com.amazonaws.applicationinsights#TagKey", "traits": { - "smithy.api#documentation": "

The optional part of a key-value pair that defines a tag. The maximum length of a tag\n value is 256 characters. The minimum length is 0 characters. If you don't want an\n application to have a specific tag value, don't specify a value for this parameter.

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

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

", "smithy.api#required": {} } } @@ -2417,17 +2417,17 @@ "com.amazonaws.applicationinsights#TagResourceRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.applicationinsights#AmazonResourceName", + "Tags": { + "target": "com.amazonaws.applicationinsights#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.

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

A list of tags that to add to the application. A tag consists of a required\n tag key (Key) and an associated tag value (Value). The maximum\n length of a tag key is 128 characters. The maximum length of a tag value is 256\n characters.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.applicationinsights#TagList", + "ResourceARN": { + "target": "com.amazonaws.applicationinsights#AmazonResourceName", "traits": { - "smithy.api#documentation": "

A list of tags that to add to the application. A tag consists of a required\n tag key (Key) and an associated tag value (Value). The maximum\n length of a tag key is 128 characters. The maximum length of a tag value is 256\n characters.

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

The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.

", "smithy.api#required": {} } } @@ -2491,14 +2491,14 @@ "com.amazonaws.applicationinsights#TooManyTagsException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.applicationinsights#ExceptionMessage" + }, "ResourceName": { "target": "com.amazonaws.applicationinsights#AmazonResourceName", "traits": { "smithy.api#documentation": "

The name of the resource with too many tags.

" } - }, - "Message": { - "target": "com.amazonaws.applicationinsights#ExceptionMessage" } }, "traits": { @@ -2579,35 +2579,35 @@ "com.amazonaws.applicationinsights#UpdateApplicationRequest": { "type": "structure", "members": { - "CWEMonitorEnabled": { - "target": "com.amazonaws.applicationinsights#CWEMonitorEnabled", - "traits": { - "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" - } - }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", - "traits": { - "smithy.api#documentation": "

The name of the resource group.

", - "smithy.api#required": {} - } - }, "OpsCenterEnabled": { "target": "com.amazonaws.applicationinsights#OpsCenterEnabled", "traits": { "smithy.api#documentation": "

\n When set to true, creates opsItems for any problems detected on an application.\n

" } }, + "OpsItemSNSTopicArn": { + "target": "com.amazonaws.applicationinsights#OpsItemSNSTopicArn", + "traits": { + "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to\n receive notifications for updates to the opsItem.

" + } + }, "RemoveSNSTopic": { "target": "com.amazonaws.applicationinsights#RemoveSNSTopic", "traits": { "smithy.api#documentation": "

\n Disassociates the SNS topic from the opsItem created for detected problems.

" } }, - "OpsItemSNSTopicArn": { - "target": "com.amazonaws.applicationinsights#OpsItemSNSTopicArn", + "CWEMonitorEnabled": { + "target": "com.amazonaws.applicationinsights#CWEMonitorEnabled", "traits": { - "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to\n receive notifications for updates to the opsItem.

" + "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" + } + }, + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

", + "smithy.api#required": {} } } } @@ -2675,12 +2675,6 @@ "com.amazonaws.applicationinsights#UpdateComponentConfigurationRequest": { "type": "structure", "members": { - "Tier": { - "target": "com.amazonaws.applicationinsights#Tier", - "traits": { - "smithy.api#documentation": "

The tier of the application component. Supported tiers include DOT_NET_WORKER,\n DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT.

" - } - }, "ComponentName": { "target": "com.amazonaws.applicationinsights#ComponentName", "traits": { @@ -2688,13 +2682,6 @@ "smithy.api#required": {} } }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", - "traits": { - "smithy.api#documentation": "

The name of the resource group.

", - "smithy.api#required": {} - } - }, "Monitor": { "target": "com.amazonaws.applicationinsights#Monitor", "traits": { @@ -2706,6 +2693,19 @@ "traits": { "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the configuration. For\n more information about the JSON format, see Working with JSON.\n You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete\n format of the component configuration file, see Component Configuration.

" } + }, + "Tier": { + "target": "com.amazonaws.applicationinsights#Tier", + "traits": { + "smithy.api#documentation": "

The tier of the application component. Supported tiers include DOT_NET_WORKER,\n DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT.

" + } + }, + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

", + "smithy.api#required": {} + } } } }, @@ -2716,19 +2716,6 @@ "com.amazonaws.applicationinsights#UpdateComponentRequest": { "type": "structure", "members": { - "NewComponentName": { - "target": "com.amazonaws.applicationinsights#NewComponentName", - "traits": { - "smithy.api#documentation": "

The new name of the component.

" - } - }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", - "traits": { - "smithy.api#documentation": "

The name of the resource group.

", - "smithy.api#required": {} - } - }, "ComponentName": { "target": "com.amazonaws.applicationinsights#ComponentName", "traits": { @@ -2741,6 +2728,19 @@ "traits": { "smithy.api#documentation": "

The list of resource ARNs that belong to the component.

" } + }, + "NewComponentName": { + "target": "com.amazonaws.applicationinsights#NewComponentName", + "traits": { + "smithy.api#documentation": "

The new name of the component.

" + } + }, + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

", + "smithy.api#required": {} + } } } }, @@ -2777,24 +2777,23 @@ "com.amazonaws.applicationinsights#UpdateLogPatternRequest": { "type": "structure", "members": { - "Pattern": { - "target": "com.amazonaws.applicationinsights#LogPatternRegex", + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { - "smithy.api#documentation": "

The log pattern.

" + "smithy.api#documentation": "

The name of the resource group.

", + "smithy.api#required": {} } }, - "PatternSetName": { - "target": "com.amazonaws.applicationinsights#LogPatternSetName", + "Rank": { + "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { - "smithy.api#documentation": "

The name of the log pattern set.

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

Rank of the log pattern.

" } }, - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "Pattern": { + "target": "com.amazonaws.applicationinsights#LogPatternRegex", "traits": { - "smithy.api#documentation": "

The name of the resource group.

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

The log pattern.

" } }, "PatternName": { @@ -2804,10 +2803,11 @@ "smithy.api#required": {} } }, - "Rank": { - "target": "com.amazonaws.applicationinsights#LogPatternRank", + "PatternSetName": { + "target": "com.amazonaws.applicationinsights#LogPatternSetName", "traits": { - "smithy.api#documentation": "

Rank of the log pattern.

" + "smithy.api#documentation": "

The name of the log pattern set.

", + "smithy.api#required": {} } } } @@ -2815,17 +2815,17 @@ "com.amazonaws.applicationinsights#UpdateLogPatternResponse": { "type": "structure", "members": { - "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName", - "traits": { - "smithy.api#documentation": "

The name of the resource group.

" - } - }, "LogPattern": { "target": "com.amazonaws.applicationinsights#LogPattern", "traits": { "smithy.api#documentation": "

The successfully created log pattern.

" } + }, + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

" + } } } }, 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 3c7de6d6187f..57e19283ac64 100644 --- a/codegen/sdk-codegen/aws-models/appstream.2016-12-01.json +++ b/codegen/sdk-codegen/aws-models/appstream.2016-12-01.json @@ -32,18 +32,18 @@ "com.amazonaws.appstream#AccessEndpoint": { "type": "structure", "members": { + "VpceId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "

The identifier (ID) of the VPC in which the interface endpoint is used.

" + } + }, "EndpointType": { "target": "com.amazonaws.appstream#AccessEndpointType", "traits": { "smithy.api#documentation": "

The type of interface endpoint.

", "smithy.api#required": {} } - }, - "VpceId": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The identifier (ID) of the VPC in which the interface endpoint is used.

" - } } }, "traits": { @@ -122,34 +122,28 @@ "com.amazonaws.appstream#Application": { "type": "structure", "members": { - "LaunchParameters": { + "Name": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The arguments that are passed to the application at launch.

" + "smithy.api#documentation": "

The name of the application.

" } }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", + "Metadata": { + "target": "com.amazonaws.appstream#Metadata", "traits": { - "smithy.api#documentation": "

The application name to display.

" + "smithy.api#documentation": "

Additional attributes that describe the application.

" } }, - "Name": { + "DisplayName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the application.

" + "smithy.api#documentation": "

The application name to display.

" } }, - "LaunchPath": { + "LaunchParameters": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The path to the application executable in the instance.

" - } - }, - "Metadata": { - "target": "com.amazonaws.appstream#Metadata", - "traits": { - "smithy.api#documentation": "

Additional attributes that describe the application.

" + "smithy.api#documentation": "

The arguments that are passed to the application at launch.

" } }, "Enabled": { @@ -163,6 +157,12 @@ "traits": { "smithy.api#documentation": "

The URL for the application icon. This URL might be time-limited.

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

The path to the application executable in the instance.

" + } } }, "traits": { @@ -193,18 +193,18 @@ "com.amazonaws.appstream#ApplicationSettingsResponse": { "type": "structure", "members": { - "SettingsGroup": { - "target": "com.amazonaws.appstream#SettingsGroup", - "traits": { - "smithy.api#documentation": "

The path prefix for the S3 bucket where users’ persistent application settings are stored.

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

The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region. \n

" } }, + "SettingsGroup": { + "target": "com.amazonaws.appstream#SettingsGroup", + "traits": { + "smithy.api#documentation": "

The path prefix for the S3 bucket where users’ persistent application settings are stored.

" + } + }, "Enabled": { "target": "com.amazonaws.appstream#Boolean", "traits": { @@ -234,7 +234,7 @@ "com.amazonaws.appstream#Arn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" + "smithy.api#pattern": "^arn:aws(?:\\-cn|\\-iso\\-b|\\-iso|\\-us\\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$" } }, "com.amazonaws.appstream#ArnList": { @@ -344,6 +344,9 @@ "target": "com.amazonaws.appstream#BatchAssociateUserStackResult" }, "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, { "target": "com.amazonaws.appstream#OperationNotPermittedException" } @@ -383,6 +386,14 @@ "output": { "target": "com.amazonaws.appstream#BatchDisassociateUserStackResult" }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], "traits": { "smithy.api#documentation": "

Disassociates the specified users from the specified stacks.

" } @@ -437,10 +448,11 @@ "com.amazonaws.appstream#ComputeCapacityStatus": { "type": "structure", "members": { - "InUse": { + "Desired": { "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The number of instances in use for streaming.

" + "smithy.api#documentation": "

The desired number of streaming instances.

", + "smithy.api#required": {} } }, "Available": { @@ -449,11 +461,10 @@ "smithy.api#documentation": "

The number of currently available instances that can be used to stream\n sessions.

" } }, - "Desired": { + "InUse": { "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The desired number of streaming instances.

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

The number of instances in use for streaming.

" } }, "Running": { @@ -515,10 +526,17 @@ "com.amazonaws.appstream#CopyImageRequest": { "type": "structure", "members": { - "SourceImageName": { + "DestinationRegion": { + "target": "com.amazonaws.appstream#RegionName", + "traits": { + "smithy.api#documentation": "

The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

", + "smithy.api#required": {} + } + }, + "DestinationImageName": { "target": "com.amazonaws.appstream#Name", "traits": { - "smithy.api#documentation": "

The name of the image to copy.

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

The name that the image will have when it is copied to the destination.

", "smithy.api#required": {} } }, @@ -528,17 +546,10 @@ "smithy.api#documentation": "

The description that the image will have when it is copied to the destination.

" } }, - "DestinationImageName": { + "SourceImageName": { "target": "com.amazonaws.appstream#Name", "traits": { - "smithy.api#documentation": "

The name that the image will have when it is copied to the destination.

", - "smithy.api#required": {} - } - }, - "DestinationRegion": { - "target": "com.amazonaws.appstream#RegionName", - "traits": { - "smithy.api#documentation": "

The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

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

The name of the image to copy.

", "smithy.api#required": {} } } @@ -567,11 +578,20 @@ { "target": "com.amazonaws.appstream#InvalidAccountStatusException" }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, { "target": "com.amazonaws.appstream#LimitExceededException" }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, { "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" } ], "traits": { @@ -581,6 +601,12 @@ "com.amazonaws.appstream#CreateDirectoryConfigRequest": { "type": "structure", "members": { + "ServiceAccountCredentials": { + "target": "com.amazonaws.appstream#ServiceAccountCredentials", + "traits": { + "smithy.api#documentation": "

The credentials for the service account used by the fleet or image builder to connect to the directory.

" + } + }, "DirectoryName": { "target": "com.amazonaws.appstream#DirectoryName", "traits": { @@ -594,13 +620,6 @@ "smithy.api#documentation": "

The distinguished names of the organizational units for computer accounts.

", "smithy.api#required": {} } - }, - "ServiceAccountCredentials": { - "target": "com.amazonaws.appstream#ServiceAccountCredentials", - "traits": { - "smithy.api#documentation": "

The credentials for the service account used by the fleet or image builder to connect to the directory.

", - "smithy.api#required": {} - } } } }, @@ -645,6 +664,9 @@ { "target": "com.amazonaws.appstream#OperationNotPermittedException" }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, { "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" }, @@ -662,35 +684,47 @@ "com.amazonaws.appstream#CreateFleetRequest": { "type": "structure", "members": { - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", + "Name": { + "target": "com.amazonaws.appstream#Name", "traits": { - "smithy.api#documentation": "

Enables or disables default internet access for the fleet.

" + "smithy.api#documentation": "

A unique name for the fleet.

", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.appstream#Description", + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" } }, - "ComputeCapacity": { - "target": "com.amazonaws.appstream#ComputeCapacity", + "StreamView": { + "target": "com.amazonaws.appstream#StreamView", "traits": { - "smithy.api#documentation": "

The desired capacity for the fleet.

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

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

\n \n

The default value is APP.

" } }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", "traits": { - "smithy.api#documentation": "

The VPC configuration for the fleet.

" + "smithy.api#documentation": "

Enables or disables default internet access for the fleet.

" } }, - "FleetType": { - "target": "com.amazonaws.appstream#FleetType", + "IdleDisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The fleet type.

\n
\n
ALWAYS_ON
\n
\n

Provides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.

\n
\n
ON_DEMAND
\n
\n

Provide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.

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

The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n they try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.

\n

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

\n \n

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

\n " + } + }, + "DomainJoinInfo": { + "target": "com.amazonaws.appstream#DomainJoinInfo", + "traits": { + "smithy.api#documentation": "

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "

The fleet name to display.

" } }, "DisconnectTimeoutInSeconds": { @@ -699,17 +733,17 @@ "smithy.api#documentation": "

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

\n

Specify a value between 60 and 360000.

" } }, - "Name": { - "target": "com.amazonaws.appstream#Name", + "FleetType": { + "target": "com.amazonaws.appstream#FleetType", "traits": { - "smithy.api#documentation": "

A unique name for the fleet.

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

The fleet type.

\n
\n
ALWAYS_ON
\n
\n

Provides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.

\n
\n
ON_DEMAND
\n
\n

Provide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.

\n
\n
" } }, - "DomainJoinInfo": { - "target": "com.amazonaws.appstream#DomainJoinInfo", + "ComputeCapacity": { + "target": "com.amazonaws.appstream#ComputeCapacity", "traits": { - "smithy.api#documentation": "

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

" + "smithy.api#documentation": "

The desired capacity for the fleet.

", + "smithy.api#required": {} } }, "ImageName": { @@ -718,35 +752,35 @@ "smithy.api#documentation": "

The name of the image used to create the fleet.

" } }, - "MaxUserDurationInSeconds": { - "target": "com.amazonaws.appstream#Integer", + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", "traits": { - "smithy.api#documentation": "

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 360000.

" + "smithy.api#documentation": "

The VPC configuration for the fleet.

" } }, - "IdleDisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", + "Description": { + "target": "com.amazonaws.appstream#Description", "traits": { - "smithy.api#documentation": "

The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n they try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.

\n

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

\n \n

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

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

The description to display.

" } }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", + "InstanceType": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The fleet name to display.

" + "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

\n ", + "smithy.api#required": {} } }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", + "Tags": { + "target": "com.amazonaws.appstream#Tags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + "smithy.api#documentation": "

The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

\n \n

If you do not specify a value, the value is set to an empty string.

\n \n

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

\n

_ . : / = + \\ - @

\n \n

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" } }, - "InstanceType": { - "target": "com.amazonaws.appstream#String", + "MaxUserDurationInSeconds": { + "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

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

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 360000.

" } }, "ImageArn": { @@ -754,12 +788,6 @@ "traits": { "smithy.api#documentation": "

The ARN of the public, private, or shared image to use.

" } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "

The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

\n \n

If you do not specify a value, the value is set to an empty string.

\n \n

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

\n

_ . : / = + \\ - @

\n \n

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" - } } } }, @@ -804,6 +832,9 @@ { "target": "com.amazonaws.appstream#OperationNotPermittedException" }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, { "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" }, @@ -821,65 +852,65 @@ "com.amazonaws.appstream#CreateImageBuilderRequest": { "type": "structure", "members": { - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", + "ImageArn": { + "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

Enables or disables default internet access for the image builder.

" + "smithy.api#documentation": "

The ARN of the public, private, or shared image to use.

" } }, - "InstanceType": { - "target": "com.amazonaws.appstream#String", + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", "traits": { - "smithy.api#documentation": "

The instance type to use when launching the image builder. The following instance types are available:

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

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

" } }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", + "Tags": { + "target": "com.amazonaws.appstream#Tags", "traits": { - "smithy.api#documentation": "

The VPC configuration for the image builder. You can specify only one subnet.

" + "smithy.api#documentation": "

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

\n \n

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

\n

_ . : / = + \\ - @

\n \n

If you do not specify a value, the value is set to an empty string.

\n \n

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" } }, "IamRoleArn": { "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" } }, - "Description": { - "target": "com.amazonaws.appstream#Description", + "ImageName": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

The name of the image used to create the image builder.

" } }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", + "InstanceType": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The image builder name to display.

" + "smithy.api#documentation": "

The instance type to use when launching the image builder. The following instance types are available:

\n ", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", + "Description": { + "target": "com.amazonaws.appstream#Description", "traits": { - "smithy.api#documentation": "

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

\n \n

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

\n

_ . : / = + \\ - @

\n \n

If you do not specify a value, the value is set to an empty string.

\n \n

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + "smithy.api#documentation": "

The description to display.

" } }, - "ImageName": { - "target": "com.amazonaws.appstream#String", + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", "traits": { - "smithy.api#documentation": "

The name of the image used to create the image builder.

" + "smithy.api#documentation": "

The VPC configuration for the image builder. You can specify only one subnet.

" } }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

" + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "

Enables or disables default internet access for the image builder.

" } }, - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", "traits": { - "smithy.api#documentation": "

The ARN of the public, private, or shared image to use.

" + "smithy.api#documentation": "

The image builder name to display.

" } }, "AppstreamAgentVersion": { @@ -937,18 +968,18 @@ "com.amazonaws.appstream#CreateImageBuilderStreamingURLRequest": { "type": "structure", "members": { + "Validity": { + "target": "com.amazonaws.appstream#Long", + "traits": { + "smithy.api#documentation": "

The time that the streaming URL will be valid, in seconds. \n Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

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

The name of the image builder.

", "smithy.api#required": {} } - }, - "Validity": { - "target": "com.amazonaws.appstream#Long", - "traits": { - "smithy.api#documentation": "

The time that the streaming URL will be valid, in seconds. \n Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

" - } } } }, @@ -1007,16 +1038,22 @@ "com.amazonaws.appstream#CreateStackRequest": { "type": "structure", "members": { - "RedirectURL": { - "target": "com.amazonaws.appstream#RedirectURL", + "StorageConnectors": { + "target": "com.amazonaws.appstream#StorageConnectorList", "traits": { - "smithy.api#documentation": "

The URL that users are redirected to after their streaming session ends.

" + "smithy.api#documentation": "

The storage connectors to enable.

" } }, - "UserSettings": { - "target": "com.amazonaws.appstream#UserSettingList", + "ApplicationSettings": { + "target": "com.amazonaws.appstream#ApplicationSettings", "traits": { - "smithy.api#documentation": "

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

" + "smithy.api#documentation": "

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

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

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

\n \n

If you do not specify a value, the value is set to an empty string.

\n \n

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

\n

_ . : / = + \\ - @

\n \n

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" } }, "DisplayName": { @@ -1025,23 +1062,23 @@ "smithy.api#documentation": "

The stack name to display.

" } }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", + "Name": { + "target": "com.amazonaws.appstream#Name", "traits": { - "smithy.api#documentation": "

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" + "smithy.api#documentation": "

The name of the stack.

", + "smithy.api#required": {} } }, - "EmbedHostDomains": { - "target": "com.amazonaws.appstream#EmbedHostDomains", + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", "traits": { - "smithy.api#documentation": "

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" + "smithy.api#documentation": "

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" } }, - "Name": { - "target": "com.amazonaws.appstream#Name", + "RedirectURL": { + "target": "com.amazonaws.appstream#RedirectURL", "traits": { - "smithy.api#documentation": "

The name of the stack.

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

The URL that users are redirected to after their streaming session ends.

" } }, "FeedbackURL": { @@ -1050,22 +1087,16 @@ "smithy.api#documentation": "

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

" } }, - "StorageConnectors": { - "target": "com.amazonaws.appstream#StorageConnectorList", - "traits": { - "smithy.api#documentation": "

The storage connectors to enable.

" - } - }, - "ApplicationSettings": { - "target": "com.amazonaws.appstream#ApplicationSettings", + "UserSettings": { + "target": "com.amazonaws.appstream#UserSettingList", "traits": { - "smithy.api#documentation": "

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

" + "smithy.api#documentation": "

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

" } }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", + "EmbedHostDomains": { + "target": "com.amazonaws.appstream#EmbedHostDomains", "traits": { - "smithy.api#documentation": "

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

\n \n

If you do not specify a value, the value is set to an empty string.

\n \n

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

\n

_ . : / = + \\ - @

\n \n

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + "smithy.api#documentation": "

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" } }, "Description": { @@ -1116,17 +1147,17 @@ "com.amazonaws.appstream#CreateStreamingURLRequest": { "type": "structure", "members": { - "FleetName": { + "StackName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the fleet.

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

The name of the stack.

", "smithy.api#required": {} } }, - "Validity": { - "target": "com.amazonaws.appstream#Long", + "ApplicationId": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The time that the streaming URL will be valid, in seconds.\n Specify a value between 1 and 604800 seconds. The default is 60 seconds.

" + "smithy.api#documentation": "

The name of the application to launch after the session starts. This is the name that you specified\n as Name in the Image Assistant.

" } }, "SessionContext": { @@ -1135,6 +1166,12 @@ "smithy.api#documentation": "

The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

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

The time that the streaming URL will be valid, in seconds.\n Specify a value between 1 and 604800 seconds. The default is 60 seconds.

" + } + }, "UserId": { "target": "com.amazonaws.appstream#StreamingUrlUserId", "traits": { @@ -1142,16 +1179,10 @@ "smithy.api#required": {} } }, - "ApplicationId": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The name of the application to launch after the session starts. This is the name that you specified\n as Name in the Image Assistant.

" - } - }, - "StackName": { + "FleetName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the stack.

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

The name of the fleet.

", "smithy.api#required": {} } } @@ -1160,17 +1191,17 @@ "com.amazonaws.appstream#CreateStreamingURLResult": { "type": "structure", "members": { - "StreamingURL": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The URL to start the AppStream 2.0 streaming session.

" - } - }, "Expires": { "target": "com.amazonaws.appstream#Timestamp", "traits": { "smithy.api#documentation": "

The elapsed time, in seconds after the Unix epoch, when this URL expires.

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

The URL to start the AppStream 2.0 streaming session.

" + } } } }, @@ -1204,17 +1235,17 @@ "com.amazonaws.appstream#CreateUsageReportSubscriptionResult": { "type": "structure", "members": { - "Schedule": { - "target": "com.amazonaws.appstream#UsageReportSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for generating usage reports.

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

The Amazon S3 bucket where generated reports are stored.

\n \n

If you enabled on-instance session scripts and Amazon S3 logging for your session script\n configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is\n unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0\n uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, \n when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

" } + }, + "Schedule": { + "target": "com.amazonaws.appstream#UsageReportSchedule", + "traits": { + "smithy.api#documentation": "

The schedule for generating usage reports.

" + } } } }, @@ -1250,17 +1281,10 @@ "com.amazonaws.appstream#CreateUserRequest": { "type": "structure", "members": { - "FirstName": { + "LastName": { "target": "com.amazonaws.appstream#UserAttributeValue", "traits": { - "smithy.api#documentation": "

The first name, or given name, of the user.

" - } - }, - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#documentation": "

The email address of the user.

\n \n \n

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.

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

The last name, or surname, of the user.

" } }, "AuthenticationType": { @@ -1270,10 +1294,11 @@ "smithy.api#required": {} } }, - "LastName": { - "target": "com.amazonaws.appstream#UserAttributeValue", + "UserName": { + "target": "com.amazonaws.appstream#Username", "traits": { - "smithy.api#documentation": "

The last name, or surname, of the user.

" + "smithy.api#documentation": "

The email address of the user.

\n \n \n

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.

\n ", + "smithy.api#required": {} } }, "MessageAction": { @@ -1281,6 +1306,12 @@ "traits": { "smithy.api#documentation": "

The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

\n \n \n

The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

\n " } + }, + "FirstName": { + "target": "com.amazonaws.appstream#UserAttributeValue", + "traits": { + "smithy.api#documentation": "

The first name, or given name, of the user.

" + } } } }, @@ -1458,17 +1489,17 @@ "com.amazonaws.appstream#DeleteImagePermissionsRequest": { "type": "structure", "members": { - "SharedAccountId": { - "target": "com.amazonaws.appstream#AwsAccountId", + "Name": { + "target": "com.amazonaws.appstream#Name", "traits": { - "smithy.api#documentation": "

The 12-digit identifier of the AWS account for which to delete image permissions.

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

The name of the private image.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.appstream#Name", + "SharedAccountId": { + "target": "com.amazonaws.appstream#AwsAccountId", "traits": { - "smithy.api#documentation": "

The name of the private image.

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

The 12-digit identifier of the AWS account for which to delete image permissions.

", "smithy.api#required": {} } } @@ -1634,17 +1665,17 @@ "smithy.api#documentation": "

The directory names.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" - } - }, "MaxResults": { "target": "com.amazonaws.appstream#Integer", "traits": { "smithy.api#documentation": "

The maximum size of each page of results.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, @@ -1685,34 +1716,34 @@ "com.amazonaws.appstream#DescribeFleetsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" - } - }, "Names": { "target": "com.amazonaws.appstream#StringList", "traits": { "smithy.api#documentation": "

The names of the fleets to describe.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, "com.amazonaws.appstream#DescribeFleetsResult": { "type": "structure", "members": { - "Fleets": { - "target": "com.amazonaws.appstream#FleetList", - "traits": { - "smithy.api#documentation": "

Information about the fleets.

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

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } + }, + "Fleets": { + "target": "com.amazonaws.appstream#FleetList", + "traits": { + "smithy.api#documentation": "

Information about the fleets.

" + } } } }, @@ -1798,6 +1829,12 @@ "com.amazonaws.appstream#DescribeImagePermissionsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.appstream#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum size of each page of results.

" + } + }, "Name": { "target": "com.amazonaws.appstream#Name", "traits": { @@ -1811,12 +1848,6 @@ "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

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

The maximum size of each page of results.

" - } - }, "SharedAwsAccountIds": { "target": "com.amazonaws.appstream#AwsAccountIdList", "traits": { @@ -1828,6 +1859,12 @@ "com.amazonaws.appstream#DescribeImagePermissionsResult": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + }, "SharedImagePermissionsList": { "target": "com.amazonaws.appstream#SharedImagePermissionsList", "traits": { @@ -1839,12 +1876,6 @@ "traits": { "smithy.api#documentation": "

The name of the private image.

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

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" - } } } }, @@ -1886,10 +1917,10 @@ "com.amazonaws.appstream#DescribeImagesRequest": { "type": "structure", "members": { - "Arns": { - "target": "com.amazonaws.appstream#ArnList", + "Names": { + "target": "com.amazonaws.appstream#StringList", "traits": { - "smithy.api#documentation": "

The ARNs of the public, private, and shared images to describe.

" + "smithy.api#documentation": "

The names of the public or private images to describe.

" } }, "Type": { @@ -1898,10 +1929,10 @@ "smithy.api#documentation": "

The type of image (public, private, or shared) to describe.

" } }, - "Names": { - "target": "com.amazonaws.appstream#StringList", + "Arns": { + "target": "com.amazonaws.appstream#ArnList", "traits": { - "smithy.api#documentation": "

The names of the public or private images to describe.

" + "smithy.api#documentation": "

The ARNs of the public, private, and shared images to describe.

" } }, "MaxResults": { @@ -1921,17 +1952,17 @@ "com.amazonaws.appstream#DescribeImagesResult": { "type": "structure", "members": { - "Images": { - "target": "com.amazonaws.appstream#ImageList", - "traits": { - "smithy.api#documentation": "

Information about the images.

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

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } + }, + "Images": { + "target": "com.amazonaws.appstream#ImageList", + "traits": { + "smithy.api#documentation": "

Information about the images.

" + } } } }, @@ -1955,32 +1986,32 @@ "com.amazonaws.appstream#DescribeSessionsRequest": { "type": "structure", "members": { + "UserId": { + "target": "com.amazonaws.appstream#UserId", + "traits": { + "smithy.api#documentation": "

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

" + } + }, "AuthenticationType": { "target": "com.amazonaws.appstream#AuthenticationType", "traits": { "smithy.api#documentation": "

The authentication method. Specify API for a user\n authenticated using a streaming URL or SAML for a SAML federated user. \n The default is to authenticate users using a streaming URL.

" } }, - "FleetName": { + "StackName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the fleet. This value is case-sensitive.

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

The name of the stack. This value is case-sensitive.

", "smithy.api#required": {} } }, - "StackName": { + "FleetName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the stack. This value is case-sensitive.

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

The name of the fleet. This value is case-sensitive.

", "smithy.api#required": {} } }, - "UserId": { - "target": "com.amazonaws.appstream#UserId", - "traits": { - "smithy.api#documentation": "

The user identifier.

" - } - }, "NextToken": { "target": "com.amazonaws.appstream#String", "traits": { @@ -2032,17 +2063,17 @@ "com.amazonaws.appstream#DescribeStacksRequest": { "type": "structure", "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "

The names of the stacks to describe.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" } + }, + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "

The names of the stacks to describe.

" + } } } }, @@ -2086,17 +2117,17 @@ "com.amazonaws.appstream#DescribeUsageReportSubscriptionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" - } - }, "MaxResults": { "target": "com.amazonaws.appstream#Integer", "traits": { "smithy.api#documentation": "

The maximum size of each page of results.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, @@ -2128,6 +2159,9 @@ "errors": [ { "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" } ], "traits": { @@ -2137,22 +2171,22 @@ "com.amazonaws.appstream#DescribeUserStackAssociationsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.appstream#String", + "MaxResults": { + "target": "com.amazonaws.appstream#MaxResults", "traits": { - "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + "smithy.api#documentation": "

The maximum size of each page of results.

" } }, - "UserName": { - "target": "com.amazonaws.appstream#Username", + "NextToken": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The email address of the user who is associated with the stack.

\n \n \n

Users' email addresses are case-sensitive.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" } }, - "MaxResults": { - "target": "com.amazonaws.appstream#MaxResults", + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", "traits": { - "smithy.api#documentation": "

The maximum size of each page of results.

" + "smithy.api#documentation": "

The authentication type for the user who is associated with the stack. You must specify USERPOOL.

" } }, "StackName": { @@ -2161,10 +2195,10 @@ "smithy.api#documentation": "

The name of the stack that is associated with the user.

" } }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", + "UserName": { + "target": "com.amazonaws.appstream#Username", "traits": { - "smithy.api#documentation": "

The authentication type for the user who is associated with the stack. You must specify USERPOOL.

" + "smithy.api#documentation": "

The email address of the user who is associated with the stack.

\n \n \n

Users' email addresses are case-sensitive.

\n " } } } @@ -2209,6 +2243,13 @@ "com.amazonaws.appstream#DescribeUsersRequest": { "type": "structure", "members": { + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", + "traits": { + "smithy.api#documentation": "

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

", + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.appstream#Integer", "traits": { @@ -2220,30 +2261,23 @@ "traits": { "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" } - }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", - "traits": { - "smithy.api#documentation": "

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.appstream#DescribeUsersResult": { "type": "structure", "members": { - "Users": { - "target": "com.amazonaws.appstream#UserList", - "traits": { - "smithy.api#documentation": "

Information about users in the user pool.

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

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } + }, + "Users": { + "target": "com.amazonaws.appstream#UserList", + "traits": { + "smithy.api#documentation": "

Information about users in the user pool.

" + } } } }, @@ -2259,12 +2293,6 @@ "com.amazonaws.appstream#DirectoryConfig": { "type": "structure", "members": { - "ServiceAccountCredentials": { - "target": "com.amazonaws.appstream#ServiceAccountCredentials", - "traits": { - "smithy.api#documentation": "

The credentials for the service account used by the fleet or image builder to connect to the directory.

" - } - }, "DirectoryName": { "target": "com.amazonaws.appstream#DirectoryName", "traits": { @@ -2278,6 +2306,12 @@ "smithy.api#documentation": "

The time the directory configuration was created.

" } }, + "ServiceAccountCredentials": { + "target": "com.amazonaws.appstream#ServiceAccountCredentials", + "traits": { + "smithy.api#documentation": "

The credentials for the service account used by the fleet or image builder to connect to the directory.

" + } + }, "OrganizationalUnitDistinguishedNames": { "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", "traits": { @@ -2324,17 +2358,17 @@ "com.amazonaws.appstream#DisableUserRequest": { "type": "structure", "members": { - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", + "UserName": { + "target": "com.amazonaws.appstream#Username", "traits": { - "smithy.api#documentation": "

The authentication type for the user. You must specify USERPOOL.

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

The email address of the user.

\n \n \n

Users' email addresses are case-sensitive.

\n ", "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.appstream#Username", + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", "traits": { - "smithy.api#documentation": "

The email address of the user.

\n \n \n

Users' email addresses are case-sensitive.

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

The authentication type for the user. You must specify USERPOOL.

", "smithy.api#required": {} } } @@ -2356,6 +2390,9 @@ { "target": "com.amazonaws.appstream#ConcurrentModificationException" }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, { "target": "com.amazonaws.appstream#ResourceInUseException" }, @@ -2370,17 +2407,17 @@ "com.amazonaws.appstream#DisassociateFleetRequest": { "type": "structure", "members": { - "FleetName": { + "StackName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the fleet.

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

The name of the stack.

", "smithy.api#required": {} } }, - "StackName": { + "FleetName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the stack.

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

The name of the fleet.

", "smithy.api#required": {} } } @@ -2412,17 +2449,17 @@ "com.amazonaws.appstream#DomainJoinInfo": { "type": "structure", "members": { - "DirectoryName": { - "target": "com.amazonaws.appstream#DirectoryName", - "traits": { - "smithy.api#documentation": "

The fully qualified name of the directory (for example, corp.example.com).

" - } - }, "OrganizationalUnitDistinguishedName": { "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedName", "traits": { "smithy.api#documentation": "

The distinguished name of the organizational unit for computer accounts.

" } + }, + "DirectoryName": { + "target": "com.amazonaws.appstream#DirectoryName", + "traits": { + "smithy.api#documentation": "

The fully qualified name of the directory (for example, corp.example.com).

" + } } }, "traits": { @@ -2437,7 +2474,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 10 + "max": 50 } } }, @@ -2553,28 +2590,10 @@ "com.amazonaws.appstream#Fleet": { "type": "structure", "members": { - "DisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "

The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

\n

Specify a value between 60 and 360000.

" - } - }, - "MaxUserDurationInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 360000.

" - } - }, - "FleetErrors": { - "target": "com.amazonaws.appstream#FleetErrors", - "traits": { - "smithy.api#documentation": "

The fleet errors.

" - } - }, - "DisplayName": { + "Description": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The fleet name to display.

" + "smithy.api#documentation": "

The description to display.

" } }, "VpcConfig": { @@ -2583,10 +2602,17 @@ "smithy.api#documentation": "

The VPC configuration for the fleet.

" } }, - "Description": { + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the fleet was created.

" + } + }, + "InstanceType": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

\n ", + "smithy.api#required": {} } }, "Arn": { @@ -2596,16 +2622,10 @@ "smithy.api#required": {} } }, - "ImageName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The name of the image used to create the fleet.

" - } - }, - "FleetType": { - "target": "com.amazonaws.appstream#FleetType", + "DisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The fleet type.

\n
\n
ALWAYS_ON
\n
\n

Provides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.

\n
\n
ON_DEMAND
\n
\n

Provide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.

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

The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

\n

Specify a value between 60 and 360000.

" } }, "State": { @@ -2615,10 +2635,10 @@ "smithy.api#required": {} } }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", + "FleetType": { + "target": "com.amazonaws.appstream#FleetType", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + "smithy.api#documentation": "

The fleet type.

\n
\n
ALWAYS_ON
\n
\n

Provides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.

\n
\n
ON_DEMAND
\n
\n

Provide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.

\n
\n
" } }, "ComputeCapacityStatus": { @@ -2628,17 +2648,28 @@ "smithy.api#required": {} } }, - "ImageArn": { + "FleetErrors": { + "target": "com.amazonaws.appstream#FleetErrors", + "traits": { + "smithy.api#documentation": "

The fleet errors.

" + } + }, + "IamRoleArn": { "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the public, private, or shared image.

" + "smithy.api#documentation": "

The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" } }, - "Name": { - "target": "com.amazonaws.appstream#String", + "StreamView": { + "target": "com.amazonaws.appstream#StreamView", "traits": { - "smithy.api#documentation": "

The name of the fleet.

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

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

\n \n

The default value is APP.

" + } + }, + "MaxUserDurationInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 360000.

" } }, "DomainJoinInfo": { @@ -2647,23 +2678,29 @@ "smithy.api#documentation": "

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

" } }, - "IdleDisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", + "Name": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.

\n

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

\n \n \n

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

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

The name of the fleet.

", + "smithy.api#required": {} } }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", + "ImageName": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The time the fleet was created.

" + "smithy.api#documentation": "

The name of the image used to create the fleet.

" } }, - "InstanceType": { + "ImageArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the public, private, or shared image.

" + } + }, + "DisplayName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

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

The fleet name to display.

" } }, "EnableDefaultInternetAccess": { @@ -2671,6 +2708,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether default internet access is enabled for the fleet.

" } + }, + "IdleDisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "

The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.

\n

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

\n \n \n

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

\n " + } } }, "traits": { @@ -2713,17 +2756,17 @@ "com.amazonaws.appstream#FleetError": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, "ErrorCode": { "target": "com.amazonaws.appstream#FleetErrorCode", "traits": { "smithy.api#documentation": "

The error code.

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

The error message.

" + } } }, "traits": { @@ -2905,16 +2948,22 @@ "com.amazonaws.appstream#Image": { "type": "structure", "members": { - "ImagePermissions": { - "target": "com.amazonaws.appstream#ImagePermissions", + "AppstreamAgentVersion": { + "target": "com.amazonaws.appstream#AppstreamAgentVersion", "traits": { - "smithy.api#documentation": "

The permissions to provide to the destination AWS account for the specified image.

" + "smithy.api#documentation": "

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

" } }, - "Visibility": { - "target": "com.amazonaws.appstream#VisibilityType", + "Platform": { + "target": "com.amazonaws.appstream#PlatformType", "traits": { - "smithy.api#documentation": "

Indicates whether the image is public or private.

" + "smithy.api#documentation": "

The operating system platform of the image.

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

The ARN of the image.

" } }, "StateChangeReason": { @@ -2923,6 +2972,12 @@ "smithy.api#documentation": "

The reason why the last state change occurred.

" } }, + "ImagePermissions": { + "target": "com.amazonaws.appstream#ImagePermissions", + "traits": { + "smithy.api#documentation": "

The permissions to provide to the destination AWS account for the specified image.

" + } + }, "DisplayName": { "target": "com.amazonaws.appstream#String", "traits": { @@ -2935,22 +2990,17 @@ "smithy.api#documentation": "

The ARN of the image from which this image was created.

" } }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the image was created.

" - } - }, - "Description": { + "Name": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

The name of the image.

", + "smithy.api#required": {} } }, - "Platform": { - "target": "com.amazonaws.appstream#PlatformType", + "PublicBaseImageReleasedDate": { + "target": "com.amazonaws.appstream#Timestamp", "traits": { - "smithy.api#documentation": "

The operating system platform of the image.

" + "smithy.api#documentation": "

The release date of the public base image. \n For private images, this date is the release date of the base image from which the image was created.

" } }, "Applications": { @@ -2959,35 +3009,34 @@ "smithy.api#documentation": "

The applications associated with the image.

" } }, - "Arn": { - "target": "com.amazonaws.appstream#Arn", + "ImageBuilderName": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The ARN of the image.

" + "smithy.api#documentation": "

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

" } }, - "AppstreamAgentVersion": { - "target": "com.amazonaws.appstream#AppstreamAgentVersion", + "State": { + "target": "com.amazonaws.appstream#ImageState", "traits": { - "smithy.api#documentation": "

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

" + "smithy.api#documentation": "

The image starts in the PENDING state. If image creation succeeds, the\n state is AVAILABLE. If image creation fails, the state is FAILED.

" } }, - "Name": { - "target": "com.amazonaws.appstream#String", + "Visibility": { + "target": "com.amazonaws.appstream#VisibilityType", "traits": { - "smithy.api#documentation": "

The name of the image.

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

Indicates whether the image is public or private.

" } }, - "ImageBuilderName": { - "target": "com.amazonaws.appstream#String", + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

" + "smithy.api#documentation": "

The time the image was created.

" } }, - "State": { - "target": "com.amazonaws.appstream#ImageState", + "Description": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The image starts in the PENDING state. If image creation succeeds, the\n state is AVAILABLE. If image creation fails, the state is FAILED.

" + "smithy.api#documentation": "

The description to display.

" } }, "ImageBuilderSupported": { @@ -2995,12 +3044,6 @@ "traits": { "smithy.api#documentation": "

Indicates whether an image builder can be launched from this image.

" } - }, - "PublicBaseImageReleasedDate": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "

The release date of the public base image. \n For private images, this date is the release date of the base image from which the image was created.

" - } } }, "traits": { @@ -3010,28 +3053,35 @@ "com.amazonaws.appstream#ImageBuilder": { "type": "structure", "members": { - "Arn": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "

The name of the image builder.

", + "smithy.api#required": {} + } + }, + "ImageArn": { "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the image builder.

" + "smithy.api#documentation": "

The ARN of the image from which this builder was created.

" } }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", + "Platform": { + "target": "com.amazonaws.appstream#PlatformType", "traits": { - "smithy.api#documentation": "

The VPC configuration of the image builder.

" + "smithy.api#documentation": "

The operating system platform of the image builder.

" } }, - "ImageBuilderErrors": { - "target": "com.amazonaws.appstream#ResourceErrors", + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", "traits": { - "smithy.api#documentation": "

The image builder errors.

" + "smithy.api#documentation": "

The time stamp when the image builder was created.

" } }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", "traits": { - "smithy.api#documentation": "

Enables or disables default internet access for the image builder.

" + "smithy.api#documentation": "

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

" } }, "DisplayName": { @@ -3043,41 +3093,37 @@ "InstanceType": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The instance type for the image builder. The following instance types are available:

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

The instance type for the image builder. The following instance types are available:

\n " } }, - "DomainJoinInfo": { - "target": "com.amazonaws.appstream#DomainJoinInfo", + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", "traits": { - "smithy.api#documentation": "

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

" + "smithy.api#documentation": "

The VPC configuration of the image builder.

" } }, - "Name": { - "target": "com.amazonaws.appstream#String", + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The name of the image builder.

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

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" } }, - "Platform": { - "target": "com.amazonaws.appstream#PlatformType", + "StateChangeReason": { + "target": "com.amazonaws.appstream#ImageBuilderStateChangeReason", "traits": { - "smithy.api#documentation": "

The operating system platform of the image builder.

" + "smithy.api#documentation": "

The reason why the last state change occurred.

" } }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", + "DomainJoinInfo": { + "target": "com.amazonaws.appstream#DomainJoinInfo", "traits": { - "smithy.api#documentation": "

The time stamp when the image builder was created.

" + "smithy.api#documentation": "

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

" } }, - "NetworkAccessConfiguration": { - "target": "com.amazonaws.appstream#NetworkAccessConfiguration" - }, - "StateChangeReason": { - "target": "com.amazonaws.appstream#ImageBuilderStateChangeReason", + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", "traits": { - "smithy.api#documentation": "

The reason why the last state change occurred.

" + "smithy.api#documentation": "

Enables or disables default internet access for the image builder.

" } }, "AppstreamAgentVersion": { @@ -3086,16 +3132,16 @@ "smithy.api#documentation": "

The version of the AppStream 2.0 agent that is currently being used by the image builder.

" } }, - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", + "Description": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The ARN of the image from which this builder was created.

" + "smithy.api#documentation": "

The description to display.

" } }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", + "Arn": { + "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

" + "smithy.api#documentation": "

The ARN for the image builder.

" } }, "State": { @@ -3104,17 +3150,14 @@ "smithy.api#documentation": "

The state of the image builder.

" } }, - "Description": { - "target": "com.amazonaws.appstream#String", + "ImageBuilderErrors": { + "target": "com.amazonaws.appstream#ResourceErrors", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

The image builder errors.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" - } + "NetworkAccessConfiguration": { + "target": "com.amazonaws.appstream#NetworkAccessConfiguration" } }, "traits": { @@ -3173,17 +3216,17 @@ "com.amazonaws.appstream#ImageBuilderStateChangeReason": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.appstream#ImageBuilderStateChangeReasonCode", - "traits": { - "smithy.api#documentation": "

The state change reason code.

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

The state change reason message.

" } + }, + "Code": { + "target": "com.amazonaws.appstream#ImageBuilderStateChangeReasonCode", + "traits": { + "smithy.api#documentation": "

The state change reason code.

" + } } }, "traits": { @@ -3788,7 +3831,7 @@ "sdkId": "AppStream", "arnNamespace": "appstream", "cloudFormationName": "AppStream", - "cloudTrailEventSource": "photon.amazonaws.com" + "cloudTrailEventSource": "appstream.amazonaws.com" }, "aws.auth#sigv4": { "name": "appstream" @@ -3832,6 +3875,19 @@ } } }, + "com.amazonaws.appstream#RequestLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.appstream#ResourceAlreadyExistsException": { "type": "structure", "members": { @@ -3848,10 +3904,10 @@ "com.amazonaws.appstream#ResourceError": { "type": "structure", "members": { - "ErrorTimestamp": { - "target": "com.amazonaws.appstream#Timestamp", + "ErrorCode": { + "target": "com.amazonaws.appstream#FleetErrorCode", "traits": { - "smithy.api#documentation": "

The time the error occurred.

" + "smithy.api#documentation": "

The error code.

" } }, "ErrorMessage": { @@ -3860,10 +3916,10 @@ "smithy.api#documentation": "

The error message.

" } }, - "ErrorCode": { - "target": "com.amazonaws.appstream#FleetErrorCode", + "ErrorTimestamp": { + "target": "com.amazonaws.appstream#Timestamp", "traits": { - "smithy.api#documentation": "

The error code.

" + "smithy.api#documentation": "

The time the error occurred.

" } } }, @@ -3882,7 +3938,8 @@ "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#length": { - "min": 1 + "min": 1, + "max": 2048 } } }, @@ -3963,36 +4020,37 @@ "com.amazonaws.appstream#Session": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.appstream#SessionState", + "NetworkAccessConfiguration": { + "target": "com.amazonaws.appstream#NetworkAccessConfiguration", "traits": { - "smithy.api#documentation": "

The current state of the streaming session.

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

The network details for the streaming session.

" } }, - "StartTime": { - "target": "com.amazonaws.appstream#Timestamp", + "UserId": { + "target": "com.amazonaws.appstream#UserId", "traits": { - "smithy.api#documentation": "

The time when a streaming instance is dedicated for the user.

" + "smithy.api#documentation": "

The identifier of the user for whom the session was created.

", + "smithy.api#required": {} } }, - "MaxExpirationTime": { - "target": "com.amazonaws.appstream#Timestamp", + "Id": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

" + "smithy.api#documentation": "

The identifier of the streaming session.

", + "smithy.api#required": {} } }, - "NetworkAccessConfiguration": { - "target": "com.amazonaws.appstream#NetworkAccessConfiguration", + "State": { + "target": "com.amazonaws.appstream#SessionState", "traits": { - "smithy.api#documentation": "

The network details for the streaming session.

" + "smithy.api#documentation": "

The current state of the streaming session.

", + "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.appstream#String", + "MaxExpirationTime": { + "target": "com.amazonaws.appstream#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier of the streaming session.

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

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

" } }, "ConnectionState": { @@ -4001,16 +4059,16 @@ "smithy.api#documentation": "

Specifies whether a user is connected to the streaming session.

" } }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", + "StartTime": { + "target": "com.amazonaws.appstream#Timestamp", "traits": { - "smithy.api#documentation": "

The authentication method. The user is authenticated using a streaming URL\n (API) or SAML 2.0 federation (SAML).

" + "smithy.api#documentation": "

The time when a streaming instance is dedicated for the user.

" } }, - "UserId": { - "target": "com.amazonaws.appstream#UserId", + "FleetName": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The identifier of the user for whom the session was created.

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

The name of the fleet for the streaming session.

", "smithy.api#required": {} } }, @@ -4021,11 +4079,10 @@ "smithy.api#required": {} } }, - "FleetName": { - "target": "com.amazonaws.appstream#String", + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", "traits": { - "smithy.api#documentation": "

The name of the fleet for the streaming session.

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

The authentication method. The user is authenticated using a streaming URL\n (API) or SAML 2.0 federation (SAML).

" } } }, @@ -4117,18 +4174,6 @@ "com.amazonaws.appstream#Stack": { "type": "structure", "members": { - "StorageConnectors": { - "target": "com.amazonaws.appstream#StorageConnectorList", - "traits": { - "smithy.api#documentation": "

The storage connectors to enable.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the stack was created.

" - } - }, "Name": { "target": "com.amazonaws.appstream#String", "traits": { @@ -4136,22 +4181,16 @@ "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the stack.

" - } - }, "FeedbackURL": { "target": "com.amazonaws.appstream#FeedbackURL", "traits": { "smithy.api#documentation": "

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

" } }, - "Description": { - "target": "com.amazonaws.appstream#String", + "EmbedHostDomains": { + "target": "com.amazonaws.appstream#EmbedHostDomains", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" } }, "UserSettings": { @@ -4172,16 +4211,10 @@ "smithy.api#documentation": "

The persistent application settings for users of the stack.

" } }, - "EmbedHostDomains": { - "target": "com.amazonaws.appstream#EmbedHostDomains", - "traits": { - "smithy.api#documentation": "

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" - } - }, - "RedirectURL": { - "target": "com.amazonaws.appstream#RedirectURL", + "DisplayName": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The URL that users are redirected to after their streaming session ends.

" + "smithy.api#documentation": "

The stack name to display.

" } }, "AccessEndpoints": { @@ -4190,10 +4223,34 @@ "smithy.api#documentation": "

The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" } }, - "DisplayName": { + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the stack was created.

" + } + }, + "Description": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The stack name to display.

" + "smithy.api#documentation": "

The description to display.

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

The ARN of the stack.

" + } + }, + "RedirectURL": { + "target": "com.amazonaws.appstream#RedirectURL", + "traits": { + "smithy.api#documentation": "

The URL that users are redirected to after their streaming session ends.

" + } + }, + "StorageConnectors": { + "target": "com.amazonaws.appstream#StorageConnectorList", + "traits": { + "smithy.api#documentation": "

The storage connectors to enable.

" } } }, @@ -4261,17 +4318,17 @@ "com.amazonaws.appstream#StackError": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, "ErrorCode": { "target": "com.amazonaws.appstream#StackErrorCode", "traits": { "smithy.api#documentation": "

The error code.

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

The error message.

" + } } }, "traits": { @@ -4335,6 +4392,9 @@ { "target": "com.amazonaws.appstream#OperationNotPermittedException" }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, { "target": "com.amazonaws.appstream#ResourceNotAvailableException" }, @@ -4505,6 +4565,13 @@ "com.amazonaws.appstream#StorageConnector": { "type": "structure", "members": { + "ConnectorType": { + "target": "com.amazonaws.appstream#StorageConnectorType", + "traits": { + "smithy.api#documentation": "

The type of storage connector.

", + "smithy.api#required": {} + } + }, "Domains": { "target": "com.amazonaws.appstream#DomainList", "traits": { @@ -4516,13 +4583,6 @@ "traits": { "smithy.api#documentation": "

The ARN of the storage connector.

" } - }, - "ConnectorType": { - "target": "com.amazonaws.appstream#StorageConnectorType", - "traits": { - "smithy.api#documentation": "

The type of storage connector.

", - "smithy.api#required": {} - } } }, "traits": { @@ -4558,6 +4618,21 @@ ] } }, + "com.amazonaws.appstream#StreamView": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "APP", + "name": "APP" + }, + { + "value": "DESKTOP", + "name": "DESKTOP" + } + ] + } + }, "com.amazonaws.appstream#StreamingUrlUserId": { "type": "string", "traits": { @@ -4707,17 +4782,17 @@ "com.amazonaws.appstream#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.appstream#Arn", + "TagKeys": { + "target": "com.amazonaws.appstream#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The tag keys for the tags to disassociate.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.appstream#TagKeyList", + "ResourceArn": { + "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The tag keys for the tags to disassociate.

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

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } } @@ -4739,6 +4814,12 @@ { "target": "com.amazonaws.appstream#ConcurrentModificationException" }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, { "target": "com.amazonaws.appstream#ResourceInUseException" }, @@ -4753,18 +4834,18 @@ "com.amazonaws.appstream#UpdateDirectoryConfigRequest": { "type": "structure", "members": { - "OrganizationalUnitDistinguishedNames": { - "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", - "traits": { - "smithy.api#documentation": "

The distinguished names of the organizational units for computer accounts.

" - } - }, "ServiceAccountCredentials": { "target": "com.amazonaws.appstream#ServiceAccountCredentials", "traits": { "smithy.api#documentation": "

The credentials for the service account used by the fleet or image builder to connect to the directory.

" } }, + "OrganizationalUnitDistinguishedNames": { + "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", + "traits": { + "smithy.api#documentation": "

The distinguished names of the organizational units for computer accounts.

" + } + }, "DirectoryName": { "target": "com.amazonaws.appstream#DirectoryName", "traits": { @@ -4815,6 +4896,9 @@ { "target": "com.amazonaws.appstream#OperationNotPermittedException" }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, { "target": "com.amazonaws.appstream#ResourceInUseException" }, @@ -4832,40 +4916,35 @@ "com.amazonaws.appstream#UpdateFleetRequest": { "type": "structure", "members": { - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the public, private, or shared image to use.

" - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", + "IdleDisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

Enables or disables default internet access for the fleet.

" + "smithy.api#documentation": "

The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.

\n

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

\n \n \n

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

\n " } }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", "traits": { - "smithy.api#documentation": "

The VPC configuration for the fleet.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", + "DeleteVpcConfig": { + "target": "com.amazonaws.appstream#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

\n \n

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

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

Deletes the VPC association for the specified fleet.

" } }, - "AttributesToDelete": { - "target": "com.amazonaws.appstream#FleetAttributes", + "DisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The fleet attributes to delete.

" + "smithy.api#documentation": "

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

\n

Specify a value between 60 and 360000.

" } }, - "Description": { - "target": "com.amazonaws.appstream#Description", + "Name": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

A unique name for the fleet.

" } }, "DomainJoinInfo": { @@ -4874,53 +4953,52 @@ "smithy.api#documentation": "

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

" } }, - "Name": { - "target": "com.amazonaws.appstream#String", + "ComputeCapacity": { + "target": "com.amazonaws.appstream#ComputeCapacity", "traits": { - "smithy.api#documentation": "

A unique name for the fleet.

" + "smithy.api#documentation": "

The desired capacity for the fleet.

" } }, - "MaxUserDurationInSeconds": { - "target": "com.amazonaws.appstream#Integer", + "InstanceType": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 360000.

" + "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

\n " } }, - "DisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", + "Description": { + "target": "com.amazonaws.appstream#Description", "traits": { - "smithy.api#documentation": "

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

\n

Specify a value between 60 and 360000.

" + "smithy.api#documentation": "

The description to display.

" } }, - "DeleteVpcConfig": { - "target": "com.amazonaws.appstream#Boolean", + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Deletes the VPC association for the specified fleet.

" + "smithy.api#documentation": "

Enables or disables default internet access for the fleet.

" } }, - "ImageName": { - "target": "com.amazonaws.appstream#String", + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", "traits": { - "smithy.api#documentation": "

The name of the image used to create the fleet.

" + "smithy.api#documentation": "

The VPC configuration for the fleet.

" } }, - "ComputeCapacity": { - "target": "com.amazonaws.appstream#ComputeCapacity", + "AttributesToDelete": { + "target": "com.amazonaws.appstream#FleetAttributes", "traits": { - "smithy.api#documentation": "

The desired capacity for the fleet.

" + "smithy.api#documentation": "

The fleet attributes to delete.

" } }, - "IdleDisconnectTimeoutInSeconds": { + "MaxUserDurationInSeconds": { "target": "com.amazonaws.appstream#Integer", "traits": { - "smithy.api#documentation": "

The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.

\n

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

\n \n \n

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

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

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

\n

Specify a value between 600 and 360000.

" } }, - "InstanceType": { + "ImageName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

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

The name of the image used to create the fleet.

" } }, "DisplayName": { @@ -4928,6 +5006,18 @@ "traits": { "smithy.api#documentation": "

The fleet name to display.

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

The ARN of the public, private, or shared image to use.

" + } + }, + "StreamView": { + "target": "com.amazonaws.appstream#StreamView", + "traits": { + "smithy.api#documentation": "

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

\n \n

The default value is APP.

" + } } } }, @@ -5039,10 +5129,16 @@ "com.amazonaws.appstream#UpdateStackRequest": { "type": "structure", "members": { - "UserSettings": { - "target": "com.amazonaws.appstream#UserSettingList", + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", "traits": { - "smithy.api#documentation": "

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

" + "smithy.api#documentation": "

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "

The stack name to display.

" } }, "ApplicationSettings": { @@ -5051,16 +5147,16 @@ "smithy.api#documentation": "

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

" } }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", + "Description": { + "target": "com.amazonaws.appstream#Description", "traits": { - "smithy.api#documentation": "

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" + "smithy.api#documentation": "

The description to display.

" } }, - "EmbedHostDomains": { - "target": "com.amazonaws.appstream#EmbedHostDomains", + "FeedbackURL": { + "target": "com.amazonaws.appstream#FeedbackURL", "traits": { - "smithy.api#documentation": "

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" + "smithy.api#documentation": "

The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

" } }, "AttributesToDelete": { @@ -5069,16 +5165,17 @@ "smithy.api#documentation": "

The stack attributes to delete.

" } }, - "Description": { - "target": "com.amazonaws.appstream#Description", + "Name": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The description to display.

" + "smithy.api#documentation": "

The name of the stack.

", + "smithy.api#required": {} } }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", + "EmbedHostDomains": { + "target": "com.amazonaws.appstream#EmbedHostDomains", "traits": { - "smithy.api#documentation": "

The stack name to display.

" + "smithy.api#documentation": "

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" } }, "StorageConnectors": { @@ -5087,10 +5184,16 @@ "smithy.api#documentation": "

The storage connectors to enable.

" } }, - "FeedbackURL": { - "target": "com.amazonaws.appstream#FeedbackURL", + "UserSettings": { + "target": "com.amazonaws.appstream#UserSettingList", "traits": { - "smithy.api#documentation": "

The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

" + "smithy.api#documentation": "

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

" + } + }, + "RedirectURL": { + "target": "com.amazonaws.appstream#RedirectURL", + "traits": { + "smithy.api#documentation": "

The URL that users are redirected to after their streaming session ends.

" } }, "DeleteStorageConnectors": { @@ -5099,19 +5202,6 @@ "smithy.api#deprecated": {}, "smithy.api#documentation": "

Deletes the storage connectors currently enabled for the stack.

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

The name of the stack.

", - "smithy.api#required": {} - } - }, - "RedirectURL": { - "target": "com.amazonaws.appstream#RedirectURL", - "traits": { - "smithy.api#documentation": "

The URL that users are redirected to after their streaming session ends.

" - } } } }, @@ -5159,12 +5249,6 @@ "com.amazonaws.appstream#UsageReportSubscription": { "type": "structure", "members": { - "LastGeneratedReportDate": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the last usage report was generated.

" - } - }, "Schedule": { "target": "com.amazonaws.appstream#UsageReportSchedule", "traits": { @@ -5177,6 +5261,12 @@ "smithy.api#documentation": "

The errors that were returned if usage reports couldn't be generated.

" } }, + "LastGeneratedReportDate": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the last usage report was generated.

" + } + }, "S3BucketName": { "target": "com.amazonaws.appstream#String", "traits": { @@ -5197,17 +5287,10 @@ "com.amazonaws.appstream#User": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the user in the user pool is enabled.

" - } - }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", "traits": { - "smithy.api#documentation": "

The authentication type for the user.

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

The date and time the user was created in the user pool.

" } }, "UserName": { @@ -5222,10 +5305,11 @@ "smithy.api#documentation": "

The status of the user in the user pool. The status can be one of the following:

\n " } }, - "FirstName": { - "target": "com.amazonaws.appstream#UserAttributeValue", + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", "traits": { - "smithy.api#documentation": "

The first name, or given name, of the user.

" + "smithy.api#documentation": "

The authentication type for the user.

", + "smithy.api#required": {} } }, "Arn": { @@ -5234,16 +5318,22 @@ "smithy.api#documentation": "

The ARN of the user.

" } }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", + "LastName": { + "target": "com.amazonaws.appstream#UserAttributeValue", "traits": { - "smithy.api#documentation": "

The date and time the user was created in the user pool.

" + "smithy.api#documentation": "

The last name, or surname, of the user.

" } }, - "LastName": { + "FirstName": { "target": "com.amazonaws.appstream#UserAttributeValue", "traits": { - "smithy.api#documentation": "

The last name, or surname, of the user.

" + "smithy.api#documentation": "

The first name, or given name, of the user.

" + } + }, + "Enabled": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the user in the user pool is enabled.

" } } }, @@ -5267,7 +5357,7 @@ "traits": { "smithy.api#length": { "min": 2, - "max": 32 + "max": 128 } } }, @@ -5313,11 +5403,10 @@ "com.amazonaws.appstream#UserStackAssociation": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.appstream#String", + "SendEmailNotification": { + "target": "com.amazonaws.appstream#Boolean", "traits": { - "smithy.api#documentation": "

The name of the stack that is associated with the user.

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

Specifies whether a welcome email is sent to a user after the user is created in the user pool.

" } }, "AuthenticationType": { @@ -5327,10 +5416,11 @@ "smithy.api#required": {} } }, - "SendEmailNotification": { - "target": "com.amazonaws.appstream#Boolean", + "StackName": { + "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

Specifies whether a welcome email is sent to a user after the user is created in the user pool.

" + "smithy.api#documentation": "

The name of the stack that is associated with the user.

", + "smithy.api#required": {} } }, "UserName": { @@ -5348,18 +5438,18 @@ "com.amazonaws.appstream#UserStackAssociationError": { "type": "structure", "members": { - "UserStackAssociation": { - "target": "com.amazonaws.appstream#UserStackAssociation", - "traits": { - "smithy.api#documentation": "

Information about the user and associated stack.

" - } - }, "ErrorCode": { "target": "com.amazonaws.appstream#UserStackAssociationErrorCode", "traits": { "smithy.api#documentation": "

The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.

" } }, + "UserStackAssociation": { + "target": "com.amazonaws.appstream#UserStackAssociation", + "traits": { + "smithy.api#documentation": "

Information about the user and associated stack.

" + } + }, "ErrorMessage": { "target": "com.amazonaws.appstream#String", "traits": { @@ -5383,6 +5473,10 @@ "value": "USER_NAME_NOT_FOUND", "name": "USER_NAME_NOT_FOUND" }, + { + "value": "DIRECTORY_NOT_FOUND", + "name": "DIRECTORY_NOT_FOUND" + }, { "value": "INTERNAL_ERROR", "name": "INTERNAL_ERROR" @@ -5441,17 +5535,17 @@ "com.amazonaws.appstream#VpcConfig": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.appstream#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The identifiers of the security groups for the fleet or image builder.

" - } - }, "SubnetIds": { "target": "com.amazonaws.appstream#SubnetIdList", "traits": { "smithy.api#documentation": "

The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.

" } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.appstream#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of the security groups for the fleet or image builder.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json b/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json index 2aac361304b4..2c43c9ea19b8 100644 --- a/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/appsync.2017-07-25.json @@ -162,7 +162,7 @@ "sdkId": "AppSync", "arnNamespace": "appsync", "cloudFormationName": "AppSync", - "cloudTrailEventSource": "controlplane.deepdish.amazonaws.com" + "cloudTrailEventSource": "appsync.amazonaws.com" }, "aws.auth#sigv4": { "name": "appsync" @@ -197,17 +197,17 @@ "smithy.api#documentation": "

The Amazon Cognito user pool configuration.

" } }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "

The OpenID Connect configuration.

" - } - }, "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { "smithy.api#documentation": "

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

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

The OpenID Connect configuration.

" + } } }, "traits": { @@ -223,28 +223,22 @@ "com.amazonaws.appsync#ApiCache": { "type": "structure", "members": { - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "

Caching behavior.

\n " - } - }, "status": { "target": "com.amazonaws.appsync#ApiCacheStatus", "traits": { "smithy.api#documentation": "

The cache instance status.

\n " } }, - "type": { - "target": "com.amazonaws.appsync#ApiCacheType", + "atRestEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

The cache instance type.

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

At rest encryption flag for cache. This setting cannot be updated after creation.

" } }, - "ttl": { - "target": "com.amazonaws.appsync#Long", + "type": { + "target": "com.amazonaws.appsync#ApiCacheType", "traits": { - "smithy.api#documentation": "

TTL in seconds for cache entries.

\n

Valid values are between 1 and 3600 seconds.

" + "smithy.api#documentation": "

The cache instance type. Valid values are

\n \n

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

\n

The following legacy instance types are avaible, but their use is discouraged:

\n " } }, "transitEncryptionEnabled": { @@ -253,10 +247,16 @@ "smithy.api#documentation": "

Transit encryption flag when connecting to cache. This setting cannot be updated after\n creation.

" } }, - "atRestEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", "traits": { - "smithy.api#documentation": "

At rest encryption flag for cache. This setting cannot be updated after creation.

" + "smithy.api#documentation": "

Caching behavior.

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

TTL in seconds for cache entries.

\n

Valid values are between 1 and 3600 seconds.

" } } }, @@ -382,10 +382,10 @@ "smithy.api#documentation": "

The API key ID.

" } }, - "expires": { + "deletes": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The time after which the API key expires. The date is represented as seconds since the\n epoch, rounded down to the nearest hour.

" + "smithy.api#documentation": "

The time after which the API key is deleted. The date is represented as seconds since the\n epoch, rounded down to the nearest hour.

" } }, "description": { @@ -393,10 +393,16 @@ "traits": { "smithy.api#documentation": "

A description of the purpose of the API key.

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

The time after which the API key expires. The date is represented as seconds since the\n epoch, rounded down to the nearest hour.

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

Describes an API key.

\n

Customers invoke AWS AppSync GraphQL API operations with API keys as an identity\n mechanism. There are two key versions:

\n

\n da1: This version was introduced at launch in November\n 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB\n TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that\n date.

\n \n

\n da2: This version was introduced in February 2018 when\n AppSync added support to extend key expiration.

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

Describes an API key.

\n

Customers invoke AWS AppSync GraphQL API operations with API keys as an identity\n mechanism. There are two key versions:

\n

\n da1: This version was introduced at launch in November\n 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB\n TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that\n date.

\n \n

\n da2: This version was introduced in February 2018 when\n AppSync added support to extend key expiration.

\n " } }, "com.amazonaws.appsync#ApiKeyLimitExceededException": { @@ -502,16 +508,16 @@ "com.amazonaws.appsync#AwsIamConfig": { "type": "structure", "members": { - "signingRegion": { + "signingServiceName": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The signing region for AWS IAM authorization.

" + "smithy.api#documentation": "

The signing service name for AWS IAM authorization.

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

The signing service name for AWS IAM authorization.

" + "smithy.api#documentation": "

The signing region for AWS IAM authorization.

" } } }, @@ -573,23 +579,23 @@ "com.amazonaws.appsync#CognitoUserPoolConfig": { "type": "structure", "members": { - "appIdClientRegex": { + "userPoolId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.

" + "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#required": {} } }, - "awsRegion": { + "appIdClientRegex": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The AWS Region in which the user pool was created.

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

A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.

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

The user pool ID.

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

The AWS Region in which the user pool was created.

", "smithy.api#required": {} } } @@ -686,45 +692,45 @@ "com.amazonaws.appsync#CreateApiCacheRequest": { "type": "structure", "members": { - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", + "transitEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

Caching behavior.

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

Transit encryption flag when connecting to cache. This setting cannot be updated after\n creation.

" } }, - "type": { - "target": "com.amazonaws.appsync#ApiCacheType", + "apiId": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The cache instance type.

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

The GraphQL API Id.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "atRestEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", + "ttl": { + "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

At rest encryption flag for cache. This setting cannot be updated after creation.

" + "smithy.api#documentation": "

TTL in seconds for cache entries.

\n

Valid values are between 1 and 3600 seconds.

", + "smithy.api#required": {} } }, - "apiId": { - "target": "com.amazonaws.appsync#String", + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", "traits": { - "smithy.api#documentation": "

The GraphQL API Id.

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

Caching behavior.

\n ", "smithy.api#required": {} } }, - "transitEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", + "type": { + "target": "com.amazonaws.appsync#ApiCacheType", "traits": { - "smithy.api#documentation": "

Transit encryption flag when connecting to cache. This setting cannot be updated after\n creation.

" + "smithy.api#documentation": "

The cache instance type. Valid values are

\n \n

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

\n

The following legacy instance types are avaible, but their use is discouraged:

\n ", + "smithy.api#required": {} } }, - "ttl": { - "target": "com.amazonaws.appsync#Long", + "atRestEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

TTL in seconds for cache entries.

\n

Valid values are between 1 and 3600 seconds.

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

At rest encryption flag for cache. This setting cannot be updated after creation.

" } } }, @@ -789,6 +795,14 @@ "com.amazonaws.appsync#CreateApiKeyRequest": { "type": "structure", "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The ID for your GraphQL API.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "expires": { "target": "com.amazonaws.appsync#Long", "traits": { @@ -800,14 +814,6 @@ "traits": { "smithy.api#documentation": "

A description of the purpose of the API key.

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

The ID for your GraphQL API.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -859,11 +865,22 @@ "com.amazonaws.appsync#CreateDataSourceRequest": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.appsync#DataSourceType", + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", "traits": { - "smithy.api#documentation": "

The type of the DataSource.

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

Amazon DynamoDB settings.

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

Amazon Elasticsearch Service settings.

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

HTTP endpoint settings.

" } }, "relationalDatabaseConfig": { @@ -872,10 +889,11 @@ "smithy.api#documentation": "

Relational database settings.

" } }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "name": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

AWS Lambda settings.

" + "smithy.api#documentation": "

A user-supplied name for the DataSource.

", + "smithy.api#required": {} } }, "description": { @@ -884,10 +902,11 @@ "smithy.api#documentation": "

A description of the DataSource.

" } }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "type": { + "target": "com.amazonaws.appsync#DataSourceType", "traits": { - "smithy.api#documentation": "

Amazon DynamoDB settings.

" + "smithy.api#documentation": "

The type of the DataSource.

", + "smithy.api#required": {} } }, "serviceRoleArn": { @@ -896,10 +915,10 @@ "smithy.api#documentation": "

The AWS IAM service role ARN for the data source. The system assumes this role when\n accessing the data source.

" } }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { - "smithy.api#documentation": "

HTTP endpoint settings.

" + "smithy.api#documentation": "

AWS Lambda settings.

" } }, "apiId": { @@ -909,19 +928,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "

A user-supplied name for the DataSource.

", - "smithy.api#required": {} - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "

Amazon Elasticsearch Service settings.

" - } } } }, @@ -970,24 +976,23 @@ "com.amazonaws.appsync#CreateFunctionRequest": { "type": "structure", "members": { - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The Function response mapping template.

" + "smithy.api#documentation": "

The Function\n DataSource name.

", + "smithy.api#required": {} } }, - "functionVersion": { - "target": "com.amazonaws.appsync#String", + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The version of the request mapping template. Currently the supported value\n is 2018-05-29.

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

The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.

" } }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The Function\n DataSource name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Function response mapping template.

" } }, "name": { @@ -1011,10 +1016,10 @@ "smithy.api#required": {} } }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", + "functionVersion": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.

", + "smithy.api#documentation": "

The version of the request mapping template. Currently the supported value\n is 2018-05-29.

", "smithy.api#required": {} } } @@ -1071,12 +1076,30 @@ "com.amazonaws.appsync#CreateGraphqlApiRequest": { "type": "structure", "members": { + "logConfig": { + "target": "com.amazonaws.appsync#LogConfig", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration.

" + } + }, + "additionalAuthenticationProviders": { + "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", + "traits": { + "smithy.api#documentation": "

A list of additional authentication providers for the GraphqlApi\n API.

" + } + }, "tags": { "target": "com.amazonaws.appsync#TagMap", "traits": { "smithy.api#documentation": "

A TagMap object.

" } }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig", + "traits": { + "smithy.api#documentation": "

The OpenID Connect configuration.

" + } + }, "name": { "target": "com.amazonaws.appsync#String", "traits": { @@ -1084,12 +1107,6 @@ "smithy.api#required": {} } }, - "logConfig": { - "target": "com.amazonaws.appsync#LogConfig", - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration.

" - } - }, "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { @@ -1108,18 +1125,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Cognito user pool configuration.

" } - }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "

The OpenID Connect configuration.

" - } - }, - "additionalAuthenticationProviders": { - "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", - "traits": { - "smithy.api#documentation": "

A list of additional authentication providers for the GraphqlApi\n API.

" - } } } }, @@ -1168,58 +1173,57 @@ "com.amazonaws.appsync#CreateResolverRequest": { "type": "structure", "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The ID for the GraphQL API for which the resolver is being created.

", + "smithy.api#documentation": "

The name of the Type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", + "cachingConfig": { + "target": "com.amazonaws.appsync#CachingConfig", "traits": { - "smithy.api#documentation": "

The name of the data source for which the resolver is being created.

" + "smithy.api#documentation": "

The caching configuration for the resolver.

" } }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", + "apiId": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The name of the field to attach the resolver to.

", + "smithy.api#documentation": "

The ID for the GraphQL API for which the resolver is being created.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "responseMappingTemplate": { + "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The mapping template to be used for responses from the data source.

" + "smithy.api#documentation": "

The mapping template to be used for requests.

\n

A resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).

\n

VTL request mapping templates are optional when using a Lambda data source. For all\n other data sources, VTL request and response mapping templates are required.

" } }, - "cachingConfig": { - "target": "com.amazonaws.appsync#CachingConfig", + "syncConfig": { + "target": "com.amazonaws.appsync#SyncConfig", "traits": { - "smithy.api#documentation": "

The caching configuration for the resolver.

" + "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned datasource.

" } }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The mapping template to be used for requests.

\n

A resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).

", + "smithy.api#documentation": "

The name of the field to attach the resolver to.

", "smithy.api#required": {} } }, - "syncConfig": { - "target": "com.amazonaws.appsync#SyncConfig", + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned datasource.

" + "smithy.api#documentation": "

The name of the data source for which the resolver is being created.

" } }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The name of the Type.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The mapping template to be used for responses from the data source.

" } }, "kind": { @@ -1322,16 +1326,16 @@ "com.amazonaws.appsync#DataSource": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.appsync#DataSourceType", + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", "traits": { - "smithy.api#documentation": "

The type of the data source.

\n " + "smithy.api#documentation": "

Amazon DynamoDB settings.

" } }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "dataSourceArn": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Relational database settings.

" + "smithy.api#documentation": "

The data source ARN.

" } }, "elasticsearchConfig": { @@ -1340,46 +1344,46 @@ "smithy.api#documentation": "

Amazon Elasticsearch Service settings.

" } }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", "traits": { - "smithy.api#documentation": "

AWS Lambda settings.

" + "smithy.api#documentation": "

HTTP endpoint settings.

" } }, - "serviceRoleArn": { + "description": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The AWS IAM service role ARN for the data source. The system assumes this role when\n accessing the data source.

" + "smithy.api#documentation": "

The description of the data source.

" } }, - "description": { - "target": "com.amazonaws.appsync#String", + "name": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The description of the data source.

" + "smithy.api#documentation": "

The name of the data source.

" } }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "serviceRoleArn": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Amazon DynamoDB settings.

" + "smithy.api#documentation": "

The AWS IAM service role ARN for the data source. The system assumes this role when\n accessing the data source.

" } }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", "traits": { - "smithy.api#documentation": "

HTTP endpoint settings.

" + "smithy.api#documentation": "

Relational database settings.

" } }, - "dataSourceArn": { - "target": "com.amazonaws.appsync#String", + "type": { + "target": "com.amazonaws.appsync#DataSourceType", "traits": { - "smithy.api#documentation": "

The data source ARN.

" + "smithy.api#documentation": "

The type of the data source.

\n " } }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { - "smithy.api#documentation": "

The name of the data source.

" + "smithy.api#documentation": "

AWS Lambda settings.

" } } }, @@ -1530,18 +1534,18 @@ "com.amazonaws.appsync#DeleteApiKeyRequest": { "type": "structure", "members": { - "apiId": { + "id": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The API ID.

", + "smithy.api#documentation": "

The ID for the API key.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "id": { + "apiId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ID for the API key.

", + "smithy.api#documentation": "

The API ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1645,18 +1649,18 @@ "com.amazonaws.appsync#DeleteFunctionRequest": { "type": "structure", "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", + "functionId": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The GraphQL API ID.

", + "smithy.api#documentation": "

The Function ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "functionId": { - "target": "com.amazonaws.appsync#ResourceName", + "apiId": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Function ID.

", + "smithy.api#documentation": "

The GraphQL API ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1847,18 +1851,18 @@ "com.amazonaws.appsync#DeltaSyncConfig": { "type": "structure", "members": { - "deltaSyncTableName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The Delta Sync table name.

" - } - }, "baseTableTTL": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "

The number of minutes an Item is stored in the datasource.

" } }, + "deltaSyncTableName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The Delta Sync table name.

" + } + }, "deltaSyncTableTTL": { "target": "com.amazonaws.appsync#Long", "traits": { @@ -1873,35 +1877,35 @@ "com.amazonaws.appsync#DynamodbDataSourceConfig": { "type": "structure", "members": { - "awsRegion": { - "target": "com.amazonaws.appsync#String", + "deltaSyncConfig": { + "target": "com.amazonaws.appsync#DeltaSyncConfig", "traits": { - "smithy.api#documentation": "

The AWS Region.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The DeltaSyncConfig for a versioned datasource.

" } }, - "useCallerCredentials": { + "versioned": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

Set to TRUE to use Amazon Cognito credentials with this data source.

" + "smithy.api#documentation": "

Set to TRUE to use Conflict Detection and Resolution with this data source.

" } }, - "versioned": { - "target": "com.amazonaws.appsync#Boolean", + "tableName": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Set to TRUE to use Conflict Detection and Resolution with this data source.

" + "smithy.api#documentation": "

The table name.

", + "smithy.api#required": {} } }, - "deltaSyncConfig": { - "target": "com.amazonaws.appsync#DeltaSyncConfig", + "useCallerCredentials": { + "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

The DeltaSyncConfig for a versioned datasource.

" + "smithy.api#documentation": "

Set to TRUE to use Amazon Cognito credentials with this data source.

" } }, - "tableName": { + "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The table name.

", + "smithy.api#documentation": "

The AWS Region.

", "smithy.api#required": {} } } @@ -1913,17 +1917,17 @@ "com.amazonaws.appsync#ElasticsearchDataSourceConfig": { "type": "structure", "members": { - "endpoint": { + "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The endpoint.

", + "smithy.api#documentation": "

The AWS Region.

", "smithy.api#required": {} } }, - "awsRegion": { + "endpoint": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The AWS Region.

", + "smithy.api#documentation": "

The endpoint.

", "smithy.api#required": {} } } @@ -2014,22 +2018,16 @@ "com.amazonaws.appsync#FunctionConfiguration": { "type": "structure", "members": { - "functionId": { + "functionArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

A unique ID representing the Function object.

" + "smithy.api#documentation": "

The ARN of the Function object.

" } }, - "functionVersion": { + "description": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The version of the request mapping template. Currently only the 2018-05-29 version of\n the template is supported.

" - } - }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "

The Function response mapping template.

" + "smithy.api#documentation": "

The Function description.

" } }, "name": { @@ -2044,10 +2042,10 @@ "smithy.api#documentation": "

The name of the DataSource.

" } }, - "functionArn": { + "functionId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ARN of the Function object.

" + "smithy.api#documentation": "

A unique ID representing the Function object.

" } }, "requestMappingTemplate": { @@ -2056,10 +2054,16 @@ "smithy.api#documentation": "

The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.

" } }, - "description": { + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "

The Function response mapping template.

" + } + }, + "functionVersion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Function description.

" + "smithy.api#documentation": "

The version of the request mapping template. Currently only the 2018-05-29 version of\n the template is supported.

" } } }, @@ -2180,18 +2184,18 @@ "com.amazonaws.appsync#GetDataSourceRequest": { "type": "structure", "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", + "name": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The API ID.

", + "smithy.api#documentation": "

The name of the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", + "apiId": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#documentation": "

The API ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2240,18 +2244,18 @@ "com.amazonaws.appsync#GetFunctionRequest": { "type": "structure", "members": { - "functionId": { - "target": "com.amazonaws.appsync#ResourceName", + "apiId": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Function ID.

", + "smithy.api#documentation": "

The GraphQL API ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "apiId": { - "target": "com.amazonaws.appsync#String", + "functionId": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The GraphQL API ID.

", + "smithy.api#documentation": "

The Function ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2361,13 +2365,6 @@ "com.amazonaws.appsync#GetIntrospectionSchemaRequest": { "type": "structure", "members": { - "includeDirectives": { - "target": "com.amazonaws.appsync#BooleanValue", - "traits": { - "smithy.api#documentation": "

A flag that specifies whether the schema introspection should contain directives.

", - "smithy.api#httpQuery": "includeDirectives" - } - }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { @@ -2383,6 +2380,13 @@ "smithy.api#httpQuery": "format", "smithy.api#required": {} } + }, + "includeDirectives": { + "target": "com.amazonaws.appsync#BooleanValue", + "traits": { + "smithy.api#documentation": "

A flag that specifies whether the schema introspection should contain directives.

", + "smithy.api#httpQuery": "includeDirectives" + } } } }, @@ -2429,14 +2433,6 @@ "com.amazonaws.appsync#GetResolverRequest": { "type": "structure", "members": { - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "

The resolver type name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "fieldName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { @@ -2452,6 +2448,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "

The resolver type name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -2513,17 +2517,17 @@ "com.amazonaws.appsync#GetSchemaCreationStatusResponse": { "type": "structure", "members": { - "details": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

Detailed information about the status of the schema creation operation.

" - } - }, "status": { "target": "com.amazonaws.appsync#SchemaStatus", "traits": { "smithy.api#documentation": "

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When\n the schema is in the ACTIVE state, you can add data.

" } + }, + "details": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

Detailed information about the status of the schema creation operation.

" + } } } }, @@ -2564,6 +2568,14 @@ "com.amazonaws.appsync#GetTypeRequest": { "type": "structure", "members": { + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "

The type format: SDL or JSON.

", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { @@ -2579,14 +2591,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "

The type format: SDL or JSON.

", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } } } }, @@ -2617,58 +2621,46 @@ "com.amazonaws.appsync#GraphqlApi": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.appsync#TagMap", - "traits": { - "smithy.api#documentation": "

The tags.

" - } - }, - "xrayEnabled": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#documentation": "

A flag representing whether X-Ray tracing is enabled for this\n GraphqlApi.

" - } - }, "logConfig": { "target": "com.amazonaws.appsync#LogConfig", "traits": { "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration.

" } }, - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", + "uris": { + "target": "com.amazonaws.appsync#MapOfStringToString", "traits": { - "smithy.api#documentation": "

The authentication type.

" + "smithy.api#documentation": "

The URIs.

" } }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", + "userPoolConfig": { + "target": "com.amazonaws.appsync#UserPoolConfig", "traits": { - "smithy.api#documentation": "

The API name.

" + "smithy.api#documentation": "

The Amazon Cognito user pool configuration.

" } }, - "arn": { - "target": "com.amazonaws.appsync#String", + "additionalAuthenticationProviders": { + "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", "traits": { - "smithy.api#documentation": "

The ARN.

" + "smithy.api#documentation": "

A list of additional authentication providers for the GraphqlApi\n API.

" } }, - "uris": { - "target": "com.amazonaws.appsync#MapOfStringToString", + "arn": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The URIs.

" + "smithy.api#documentation": "

The ARN.

" } }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#UserPoolConfig", + "apiId": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Amazon Cognito user pool configuration.

" + "smithy.api#documentation": "

The API ID.

" } }, - "apiId": { + "wafWebAclArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The API ID.

" + "smithy.api#documentation": "

The ARN of the AWS WAF ACL associated with this\n GraphqlApi if one exists.

" } }, "openIDConnectConfig": { @@ -2677,10 +2669,28 @@ "smithy.api#documentation": "

The OpenID Connect configuration.

" } }, - "additionalAuthenticationProviders": { - "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", + "name": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

A list of additional authentication providers for the GraphqlApi\n API.

" + "smithy.api#documentation": "

The API name.

" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap", + "traits": { + "smithy.api#documentation": "

The tags.

" + } + }, + "xrayEnabled": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#documentation": "

A flag representing whether X-Ray tracing is enabled for this\n GraphqlApi.

" + } + }, + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "

The authentication type.

" } } }, @@ -2697,17 +2707,17 @@ "com.amazonaws.appsync#HttpDataSourceConfig": { "type": "structure", "members": { - "endpoint": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The HTTP URL endpoint. You can either specify the domain name or IP, and port\n combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS\n AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS\n endpoints.

" - } - }, "authorizationConfig": { "target": "com.amazonaws.appsync#AuthorizationConfig", "traits": { "smithy.api#documentation": "

The authorization config in case the HTTP endpoint requires authorization.

" } + }, + "endpoint": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The HTTP URL endpoint. You can either specify the domain name or IP, and port\n combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS\n AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS\n endpoints.

" + } } }, "traits": { @@ -2792,7 +2802,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the API keys for a given API.

\n \n

API keys are deleted automatically sometime after they expire. However, they may\n still be included in the response until they have actually been deleted. You can safely\n call DeleteApiKey to manually delete a key before it's automatically\n deleted.

\n ", + "smithy.api#documentation": "

Lists the API keys for a given API.

\n \n

API keys are deleted automatically 60 days after they expire. However, they may\n still be included in the response until they have actually been deleted. You can safely\n call DeleteApiKey to manually delete a key before it's automatically\n deleted.

\n ", "smithy.api#http": { "method": "GET", "uri": "/apis/{apiId}/apikeys", @@ -2803,6 +2813,13 @@ "com.amazonaws.appsync#ListApiKeysRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "nextToken" + } + }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { @@ -2817,13 +2834,6 @@ "smithy.api#documentation": "

The maximum number of results you want the request to return.

", "smithy.api#httpQuery": "maxResults" } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", - "smithy.api#httpQuery": "nextToken" - } } } }, @@ -2878,6 +2888,13 @@ "com.amazonaws.appsync#ListDataSourcesRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results you want the request to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { @@ -2892,13 +2909,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

", - "smithy.api#httpQuery": "maxResults" - } } } }, @@ -2953,11 +2963,11 @@ "com.amazonaws.appsync#ListFunctionsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The maximum number of results you want the request to return.

", + "smithy.api#httpQuery": "maxResults" } }, "apiId": { @@ -2968,11 +2978,11 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -2980,17 +2990,17 @@ "com.amazonaws.appsync#ListFunctionsResponse": { "type": "structure", "members": { - "functions": { - "target": "com.amazonaws.appsync#Functions", - "traits": { - "smithy.api#documentation": "

A list of Function objects.

" - } - }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } + }, + "functions": { + "target": "com.amazonaws.appsync#Functions", + "traits": { + "smithy.api#documentation": "

A list of Function objects.

" + } } } }, @@ -3123,18 +3133,25 @@ "com.amazonaws.appsync#ListResolversByFunctionRequest": { "type": "structure", "members": { - "functionId": { + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results you want the request to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "apiId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Function ID.

", + "smithy.api#documentation": "

The API ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "apiId": { + "functionId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The API ID.

", + "smithy.api#documentation": "

The Function ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3145,13 +3162,6 @@ "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

", "smithy.api#httpQuery": "nextToken" } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

", - "smithy.api#httpQuery": "maxResults" - } } } }, @@ -3175,11 +3185,11 @@ "com.amazonaws.appsync#ListResolversRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The maximum number of results you want the request to return.

", + "smithy.api#httpQuery": "maxResults" } }, "typeName": { @@ -3198,11 +3208,11 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -3210,17 +3220,17 @@ "com.amazonaws.appsync#ListResolversResponse": { "type": "structure", "members": { - "resolvers": { - "target": "com.amazonaws.appsync#Resolvers", - "traits": { - "smithy.api#documentation": "

The Resolver objects.

" - } - }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "

An identifier to be passed in the next request to this operation to return the next set\n of items in the list.

" } + }, + "resolvers": { + "target": "com.amazonaws.appsync#Resolvers", + "traits": { + "smithy.api#documentation": "

The Resolver objects.

" + } } } }, @@ -3322,13 +3332,6 @@ "com.amazonaws.appsync#ListTypesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { @@ -3345,6 +3348,13 @@ "smithy.api#required": {} } }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results you want the request to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { @@ -3374,6 +3384,13 @@ "com.amazonaws.appsync#LogConfig": { "type": "structure", "members": { + "cloudWatchLogsRoleArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in\n your account.

", + "smithy.api#required": {} + } + }, "fieldLogLevel": { "target": "com.amazonaws.appsync#FieldLogLevel", "traits": { @@ -3386,13 +3403,6 @@ "traits": { "smithy.api#documentation": "

Set to TRUE to exclude sections that contain information such as headers, context, and\n evaluated mapping templates, regardless of logging level.

" } - }, - "cloudWatchLogsRoleArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in\n your account.

", - "smithy.api#required": {} - } } }, "traits": { @@ -3445,16 +3455,17 @@ "com.amazonaws.appsync#OpenIDConnectConfig": { "type": "structure", "members": { - "authTTL": { - "target": "com.amazonaws.appsync#Long", + "issuer": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The number of milliseconds a token is valid after being authenticated.

" + "smithy.api#documentation": "

The issuer for the OpenID Connect configuration. The issuer returned by discovery must\n exactly match the value of iss in the ID token.

", + "smithy.api#required": {} } }, - "iatTTL": { + "authTTL": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The number of milliseconds a token is valid after being issued to a user.

" + "smithy.api#documentation": "

The number of milliseconds a token is valid after being authenticated.

" } }, "clientId": { @@ -3463,11 +3474,10 @@ "smithy.api#documentation": "

The client identifier of the Relying party at the OpenID identity provider. This\n identifier is typically obtained when the Relying party is registered with the OpenID\n identity provider. You can specify a regular expression so the AWS AppSync can validate\n against multiple client identifiers at a time.

" } }, - "issuer": { - "target": "com.amazonaws.appsync#String", + "iatTTL": { + "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The issuer for the OpenID Connect configuration. The issuer returned by discovery must\n exactly match the value of iss in the ID token.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of milliseconds a token is valid after being issued to a user.

" } } }, @@ -3517,10 +3527,10 @@ "com.amazonaws.appsync#RdsHttpEndpointConfig": { "type": "structure", "members": { - "databaseName": { + "schema": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Logical database name.

" + "smithy.api#documentation": "

Logical schema name.

" } }, "awsRegion": { @@ -3529,22 +3539,22 @@ "smithy.api#documentation": "

AWS Region for RDS HTTP endpoint.

" } }, - "dbClusterIdentifier": { + "awsSecretStoreArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Amazon RDS cluster ARN.

" + "smithy.api#documentation": "

AWS secret store ARN for database credentials.

" } }, - "schema": { + "databaseName": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Logical schema name.

" + "smithy.api#documentation": "

Logical database name.

" } }, - "awsSecretStoreArn": { + "dbClusterIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

AWS secret store ARN for database credentials.

" + "smithy.api#documentation": "

Amazon RDS cluster ARN.

" } } }, @@ -3555,17 +3565,17 @@ "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig": { "type": "structure", "members": { - "rdsHttpEndpointConfig": { - "target": "com.amazonaws.appsync#RdsHttpEndpointConfig", - "traits": { - "smithy.api#documentation": "

Amazon RDS HTTP endpoint settings.

" - } - }, "relationalDatabaseSourceType": { "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", "traits": { "smithy.api#documentation": "

Source type for the relational database.

\n " } + }, + "rdsHttpEndpointConfig": { + "target": "com.amazonaws.appsync#RdsHttpEndpointConfig", + "traits": { + "smithy.api#documentation": "

Amazon RDS HTTP endpoint settings.

" + } } }, "traits": { @@ -3586,22 +3596,22 @@ "com.amazonaws.appsync#Resolver": { "type": "structure", "members": { - "syncConfig": { - "target": "com.amazonaws.appsync#SyncConfig", + "resolverArn": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned datasource.

" + "smithy.api#documentation": "

The resolver ARN.

" } }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", + "pipelineConfig": { + "target": "com.amazonaws.appsync#PipelineConfig", "traits": { - "smithy.api#documentation": "

The resolver type name.

" + "smithy.api#documentation": "

The PipelineConfig.

" } }, - "cachingConfig": { - "target": "com.amazonaws.appsync#CachingConfig", + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The caching configuration for the resolver.

" + "smithy.api#documentation": "

The request mapping template.

" } }, "dataSourceName": { @@ -3610,40 +3620,40 @@ "smithy.api#documentation": "

The resolver data source name.

" } }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", + "kind": { + "target": "com.amazonaws.appsync#ResolverKind", "traits": { - "smithy.api#documentation": "

The response mapping template.

" + "smithy.api#documentation": "

The resolver type.

\n " } }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", + "syncConfig": { + "target": "com.amazonaws.appsync#SyncConfig", "traits": { - "smithy.api#documentation": "

The request mapping template.

" + "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned datasource.

" } }, - "fieldName": { + "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The resolver field name.

" + "smithy.api#documentation": "

The resolver type name.

" } }, - "resolverArn": { - "target": "com.amazonaws.appsync#String", + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The resolver ARN.

" + "smithy.api#documentation": "

The response mapping template.

" } }, - "pipelineConfig": { - "target": "com.amazonaws.appsync#PipelineConfig", + "cachingConfig": { + "target": "com.amazonaws.appsync#CachingConfig", "traits": { - "smithy.api#documentation": "

The PipelineConfig.

" + "smithy.api#documentation": "

The caching configuration for the resolver.

" } }, - "kind": { - "target": "com.amazonaws.appsync#ResolverKind", + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The resolver type.

\n " + "smithy.api#documentation": "

The resolver field name.

" } } }, @@ -3760,13 +3770,6 @@ "com.amazonaws.appsync#StartSchemaCreationRequest": { "type": "structure", "members": { - "definition": { - "target": "com.amazonaws.appsync#Blob", - "traits": { - "smithy.api#documentation": "

The schema definition, in GraphQL schema language format.

", - "smithy.api#required": {} - } - }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { @@ -3774,6 +3777,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "definition": { + "target": "com.amazonaws.appsync#Blob", + "traits": { + "smithy.api#documentation": "

The schema definition, in GraphQL schema language format.

", + "smithy.api#required": {} + } } } }, @@ -3800,17 +3810,17 @@ "smithy.api#documentation": "

The Conflict Resolution strategy to perform in the event of a conflict.

\n " } }, - "lambdaConflictHandlerConfig": { - "target": "com.amazonaws.appsync#LambdaConflictHandlerConfig", - "traits": { - "smithy.api#documentation": "

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict\n Handler.

" - } - }, "conflictDetection": { "target": "com.amazonaws.appsync#ConflictDetectionType", "traits": { "smithy.api#documentation": "

The Conflict Detection strategy to use.

\n " } + }, + "lambdaConflictHandlerConfig": { + "target": "com.amazonaws.appsync#LambdaConflictHandlerConfig", + "traits": { + "smithy.api#documentation": "

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict\n Handler.

" + } } }, "traits": { @@ -3896,18 +3906,18 @@ "com.amazonaws.appsync#TagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.appsync#ResourceArn", + "tags": { + "target": "com.amazonaws.appsync#TagMap", "traits": { - "smithy.api#documentation": "

The GraphqlApi ARN.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A TagMap object.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.appsync#TagMap", + "resourceArn": { + "target": "com.amazonaws.appsync#ResourceArn", "traits": { - "smithy.api#documentation": "

A TagMap object.

", + "smithy.api#documentation": "

The GraphqlApi ARN.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -3930,18 +3940,6 @@ "com.amazonaws.appsync#Type": { "type": "structure", "members": { - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The type definition.

" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The type description.

" - } - }, "format": { "target": "com.amazonaws.appsync#TypeDefinitionFormat", "traits": { @@ -3954,11 +3952,23 @@ "smithy.api#documentation": "

The type name.

" } }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The type definition.

" + } + }, "arn": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "

The type ARN.

" } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The type description.

" + } } }, "traits": { @@ -4039,14 +4049,6 @@ "com.amazonaws.appsync#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.appsync#TagKeyList", - "traits": { - "smithy.api#documentation": "

A list of TagKey objects.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.appsync#ResourceArn", "traits": { @@ -4054,6 +4056,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tagKeys": { + "target": "com.amazonaws.appsync#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of TagKey objects.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -4098,6 +4108,13 @@ "com.amazonaws.appsync#UpdateApiCacheRequest": { "type": "structure", "members": { + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", + "traits": { + "smithy.api#documentation": "

Caching behavior.

\n ", + "smithy.api#required": {} + } + }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { @@ -4109,14 +4126,7 @@ "type": { "target": "com.amazonaws.appsync#ApiCacheType", "traits": { - "smithy.api#documentation": "

The cache instance type.

\n ", - "smithy.api#required": {} - } - }, - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "

Caching behavior.

\n ", + "smithy.api#documentation": "

The cache instance type. Valid values are

\n \n

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

\n

The following legacy instance types are avaible, but their use is discouraged:

\n ", "smithy.api#required": {} } }, @@ -4175,7 +4185,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an API key.

", + "smithy.api#documentation": "

Updates an API key. The key can be updated while it is not deleted.

", "smithy.api#http": { "method": "POST", "uri": "/apis/{apiId}/apikeys/{id}", @@ -4186,30 +4196,30 @@ "com.amazonaws.appsync#UpdateApiKeyRequest": { "type": "structure", "members": { - "expires": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#documentation": "

The time from update time after which the API key expires. The date is represented as\n seconds since the epoch. For more information, see .

" - } - }, - "apiId": { + "id": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ID for the GraphQL API.

", + "smithy.api#documentation": "

The API key ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "expires": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#documentation": "

The time from update time after which the API key expires. The date is represented as\n seconds since the epoch. For more information, see .

" + } + }, "description": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "

A description of the purpose of the API key.

" } }, - "id": { + "apiId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The API key ID.

", + "smithy.api#documentation": "

The ID for the GraphQL API.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4264,12 +4274,6 @@ "com.amazonaws.appsync#UpdateDataSourceRequest": { "type": "structure", "members": { - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", - "traits": { - "smithy.api#documentation": "

The new Amazon DynamoDB configuration.

" - } - }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { @@ -4278,23 +4282,22 @@ "smithy.api#required": {} } }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", "traits": { - "smithy.api#documentation": "

The new relational database configuration.

" + "smithy.api#documentation": "

The new HTTP endpoint configuration.

" } }, - "type": { - "target": "com.amazonaws.appsync#DataSourceType", + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", "traits": { - "smithy.api#documentation": "

The new data source type.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The new Amazon DynamoDB configuration.

" } }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "elasticsearchConfig": { + "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", "traits": { - "smithy.api#documentation": "

The new AWS Lambda configuration.

" + "smithy.api#documentation": "

The new Elasticsearch Service configuration.

" } }, "serviceRoleArn": { @@ -4303,6 +4306,25 @@ "smithy.api#documentation": "

The new service role ARN for the data source.

" } }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "traits": { + "smithy.api#documentation": "

The new AWS Lambda configuration.

" + } + }, + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "traits": { + "smithy.api#documentation": "

The new relational database configuration.

" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceType", + "traits": { + "smithy.api#documentation": "

The new data source type.

", + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.appsync#String", "traits": { @@ -4316,18 +4338,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", - "traits": { - "smithy.api#documentation": "

The new HTTP endpoint configuration.

" - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "

The new Elasticsearch Service configuration.

" - } } } }, @@ -4376,32 +4386,10 @@ "com.amazonaws.appsync#UpdateFunctionRequest": { "type": "structure", "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The GraphQL API ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The Function description.

" - } - }, "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "

The Function name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.

" } }, "dataSourceName": { @@ -4419,10 +4407,10 @@ "smithy.api#required": {} } }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", + "description": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Function request mapping template.

" + "smithy.api#documentation": "

The Function description.

" } }, "functionVersion": { @@ -4431,6 +4419,27 @@ "smithy.api#documentation": "

The version of the request mapping template. Currently the supported value\n is 2018-05-29.

", "smithy.api#required": {} } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The GraphQL API ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "

The Function name.

", + "smithy.api#required": {} + } + }, + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "

The Function request mapping template.

" + } } } }, @@ -4485,16 +4494,31 @@ "com.amazonaws.appsync#UpdateGraphqlApiRequest": { "type": "structure", "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "

The new authentication type for the GraphqlApi object.

" + } + }, "logConfig": { "target": "com.amazonaws.appsync#LogConfig", "traits": { "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration for the GraphqlApi object.

" } }, - "additionalAuthenticationProviders": { - "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", + "name": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

A list of additional authentication providers for the GraphqlApi\n API.

" + "smithy.api#documentation": "

The new name for the GraphqlApi object.

", + "smithy.api#required": {} } }, "xrayEnabled": { @@ -4503,16 +4527,10 @@ "smithy.api#documentation": "

A flag indicating whether to enable X-Ray tracing for the\n GraphqlApi.

" } }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#UserPoolConfig", - "traits": { - "smithy.api#documentation": "

The new Amazon Cognito user pool configuration for the GraphqlApi\n object.

" - } - }, - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", + "additionalAuthenticationProviders": { + "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", "traits": { - "smithy.api#documentation": "

The new authentication type for the GraphqlApi object.

" + "smithy.api#documentation": "

A list of additional authentication providers for the GraphqlApi\n API.

" } }, "openIDConnectConfig": { @@ -4521,19 +4539,10 @@ "smithy.api#documentation": "

The OpenID Connect configuration for the GraphqlApi object.

" } }, - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The new name for the GraphqlApi object.

", - "smithy.api#required": {} - } - }, - "apiId": { - "target": "com.amazonaws.appsync#String", + "userPoolConfig": { + "target": "com.amazonaws.appsync#UserPoolConfig", "traits": { - "smithy.api#documentation": "

The API ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The new Amazon Cognito user pool configuration for the GraphqlApi\n object.

" } } } @@ -4583,29 +4592,36 @@ "com.amazonaws.appsync#UpdateResolverRequest": { "type": "structure", "members": { - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", "traits": { - "smithy.api#documentation": "

The new request mapping template.

", + "smithy.api#documentation": "

The new field name.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "pipelineConfig": { + "target": "com.amazonaws.appsync#PipelineConfig", + "traits": { + "smithy.api#documentation": "

The PipelineConfig.

" + } + }, "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { "smithy.api#documentation": "

The resolver type.

\n " } }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The new data source name.

" + "smithy.api#documentation": "

The new response mapping template.

" } }, - "pipelineConfig": { - "target": "com.amazonaws.appsync#PipelineConfig", + "cachingConfig": { + "target": "com.amazonaws.appsync#CachingConfig", "traits": { - "smithy.api#documentation": "

The PipelineConfig.

" + "smithy.api#documentation": "

The caching configuration for the resolver.

" } }, "syncConfig": { @@ -4622,6 +4638,12 @@ "smithy.api#required": {} } }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "

The new data source name.

" + } + }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { @@ -4630,24 +4652,10 @@ "smithy.api#required": {} } }, - "responseMappingTemplate": { + "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The new response mapping template.

" - } - }, - "cachingConfig": { - "target": "com.amazonaws.appsync#CachingConfig", - "traits": { - "smithy.api#documentation": "

The caching configuration for the resolver.

" - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "

The new field name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The new request mapping template.

\n

A resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).

\n

VTL request mapping templates are optional when using a Lambda data source. For all\n other data sources, VTL request and response mapping templates are required.

" } } } @@ -4707,6 +4715,12 @@ "smithy.api#required": {} } }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The new definition.

" + } + }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { @@ -4722,12 +4736,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The new definition.

" - } } } }, @@ -4745,30 +4753,30 @@ "com.amazonaws.appsync#UserPoolConfig": { "type": "structure", "members": { - "appIdClientRegex": { - "target": "com.amazonaws.appsync#String", + "defaultAction": { + "target": "com.amazonaws.appsync#DefaultAction", "traits": { - "smithy.api#documentation": "

A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.

" + "smithy.api#documentation": "

The action that you want your GraphQL API to take when a request that uses Amazon\n Cognito user pool authentication doesn't match the Amazon Cognito user pool\n configuration.

", + "smithy.api#required": {} } }, - "awsRegion": { + "userPoolId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The AWS Region in which the user pool was created.

", + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } }, - "defaultAction": { - "target": "com.amazonaws.appsync#DefaultAction", + "appIdClientRegex": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The action that you want your GraphQL API to take when a request that uses Amazon\n Cognito user pool authentication doesn't match the Amazon Cognito user pool\n configuration.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.

" } }, - "userPoolId": { + "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#documentation": "

The AWS Region in which the user pool was created.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/athena.2017-05-18.json b/codegen/sdk-codegen/aws-models/athena.2017-05-18.json index 6c93f2d470ec..c6bd8b5c13f0 100644 --- a/codegen/sdk-codegen/aws-models/athena.2017-05-18.json +++ b/codegen/sdk-codegen/aws-models/athena.2017-05-18.json @@ -123,7 +123,7 @@ "sdkId": "Athena", "arnNamespace": "athena", "cloudFormationName": "Athena", - "cloudTrailEventSource": "webservice.athena.amazonaws.com" + "cloudTrailEventSource": "athena.amazonaws.com" }, "aws.auth#sigv4": { "name": "athena" @@ -226,17 +226,17 @@ "com.amazonaws.athena#BatchGetQueryExecutionOutput": { "type": "structure", "members": { - "UnprocessedQueryExecutionIds": { - "target": "com.amazonaws.athena#UnprocessedQueryExecutionIdList", - "traits": { - "smithy.api#documentation": "

Information about the query executions that failed to run.

" - } - }, "QueryExecutions": { "target": "com.amazonaws.athena#QueryExecutionList", "traits": { "smithy.api#documentation": "

Information about a query execution.

" } + }, + "UnprocessedQueryExecutionIds": { + "target": "com.amazonaws.athena#UnprocessedQueryExecutionIdList", + "traits": { + "smithy.api#documentation": "

Information about the query executions that failed to run.

" + } } } }, @@ -271,18 +271,18 @@ "com.amazonaws.athena#Column": { "type": "structure", "members": { - "Comment": { - "target": "com.amazonaws.athena#CommentString", - "traits": { - "smithy.api#documentation": "

Optional information about the column.

" - } - }, "Type": { "target": "com.amazonaws.athena#TypeString", "traits": { "smithy.api#documentation": "

The data type of the column.

" } }, + "Comment": { + "target": "com.amazonaws.athena#CommentString", + "traits": { + "smithy.api#documentation": "

Optional information about the column.

" + } + }, "Name": { "target": "com.amazonaws.athena#NameString", "traits": { @@ -298,10 +298,10 @@ "com.amazonaws.athena#ColumnInfo": { "type": "structure", "members": { - "Scale": { - "target": "com.amazonaws.athena#Integer", + "Nullable": { + "target": "com.amazonaws.athena#ColumnNullable", "traits": { - "smithy.api#documentation": "

For DECIMAL data types, specifies the total number of digits in the\n fractional part of the value. Defaults to 0.

" + "smithy.api#documentation": "

Indicates the column's nullable status.

" } }, "TableName": { @@ -310,54 +310,54 @@ "smithy.api#documentation": "

The table name for the query results.

" } }, - "CaseSensitive": { - "target": "com.amazonaws.athena#Boolean", + "Precision": { + "target": "com.amazonaws.athena#Integer", "traits": { - "smithy.api#documentation": "

Indicates whether values in the column are case-sensitive.

" + "smithy.api#documentation": "

For DECIMAL data types, specifies the total number of digits, up to 38.\n For performance reasons, we recommend up to 18 digits.

" } }, - "CatalogName": { + "Type": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The catalog to which the query results belong.

" + "smithy.api#documentation": "

The data type of the column.

", + "smithy.api#required": {} } }, - "Name": { + "CatalogName": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The name of the column.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The catalog to which the query results belong.

" } }, - "Type": { + "Label": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The data type of the column.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A column label.

" } }, - "Nullable": { - "target": "com.amazonaws.athena#ColumnNullable", + "Name": { + "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

Indicates the column's nullable status.

" + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} } }, - "Label": { + "SchemaName": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

A column label.

" + "smithy.api#documentation": "

The schema name (database name) to which the query results belong.

" } }, - "Precision": { + "Scale": { "target": "com.amazonaws.athena#Integer", "traits": { - "smithy.api#documentation": "

For DECIMAL data types, specifies the total number of digits, up to 38.\n For performance reasons, we recommend up to 18 digits.

" + "smithy.api#documentation": "

For DECIMAL data types, specifies the total number of digits in the\n fractional part of the value. Defaults to 0.

" } }, - "SchemaName": { - "target": "com.amazonaws.athena#String", + "CaseSensitive": { + "target": "com.amazonaws.athena#Boolean", "traits": { - "smithy.api#documentation": "

The schema name (database name) to which the query results belong.

" + "smithy.api#documentation": "

Indicates whether values in the column are case-sensitive.

" } } }, @@ -429,6 +429,18 @@ "com.amazonaws.athena#CreateDataCatalogInput": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.athena#DescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the data catalog to be created.

" + } + }, + "Tags": { + "target": "com.amazonaws.athena#TagList", + "traits": { + "smithy.api#documentation": "

A list of comma separated tags to add to the data catalog that is created.

" + } + }, "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { @@ -448,18 +460,6 @@ "traits": { "smithy.api#documentation": "

Specifies the Lambda function or functions to use for creating the data catalog. This\n is a mapping whose values depend on the catalog type.

\n " } - }, - "Tags": { - "target": "com.amazonaws.athena#TagList", - "traits": { - "smithy.api#documentation": "

A list of comma separated tags to add to the data catalog that is created.

" - } - }, - "Description": { - "target": "com.amazonaws.athena#DescriptionString", - "traits": { - "smithy.api#documentation": "

A description of the data catalog to be created.

" - } } } }, @@ -491,23 +491,18 @@ "com.amazonaws.athena#CreateNamedQueryInput": { "type": "structure", "members": { - "WorkGroup": { - "target": "com.amazonaws.athena#WorkGroupName", - "traits": { - "smithy.api#documentation": "

The name of the workgroup in which the named query is being created.

" - } - }, - "Description": { - "target": "com.amazonaws.athena#DescriptionString", + "Name": { + "target": "com.amazonaws.athena#NameString", "traits": { - "smithy.api#documentation": "

The query description.

" + "smithy.api#documentation": "

The query name.

", + "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.athena#IdempotencyToken", + "Database": { + "target": "com.amazonaws.athena#DatabaseString", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another CreateNamedQuery request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

This token is listed as not required because AWS SDKs (for example the AWS SDK for\n Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS\n CLI, you must provide this token or the action will fail.

\n ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The database to which the query belongs.

", + "smithy.api#required": {} } }, "QueryString": { @@ -517,18 +512,23 @@ "smithy.api#required": {} } }, - "Database": { - "target": "com.amazonaws.athena#DatabaseString", + "Description": { + "target": "com.amazonaws.athena#DescriptionString", "traits": { - "smithy.api#documentation": "

The database to which the query belongs.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The query description.

" } }, - "Name": { - "target": "com.amazonaws.athena#NameString", + "ClientRequestToken": { + "target": "com.amazonaws.athena#IdempotencyToken", "traits": { - "smithy.api#documentation": "

The query name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another CreateNamedQuery request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

This token is listed as not required because AWS SDKs (for example the AWS SDK for\n Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS\n CLI, you must provide this token or the action will fail.

\n ", + "smithy.api#idempotencyToken": {} + } + }, + "WorkGroup": { + "target": "com.amazonaws.athena#WorkGroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup in which the named query is being created.

" } } } @@ -567,16 +567,17 @@ "com.amazonaws.athena#CreateWorkGroupInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.athena#TagList", + "Name": { + "target": "com.amazonaws.athena#WorkGroupName", "traits": { - "smithy.api#documentation": "

A list of comma separated tags to add to the workgroup that is created.

" + "smithy.api#documentation": "

The workgroup name.

", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.athena#WorkGroupDescriptionString", + "Tags": { + "target": "com.amazonaws.athena#TagList", "traits": { - "smithy.api#documentation": "

The workgroup description.

" + "smithy.api#documentation": "

A list of comma separated tags to add to the workgroup that is created.

" } }, "Configuration": { @@ -585,11 +586,10 @@ "smithy.api#documentation": "

The configuration for the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption configuration, if any, used for encrypting\n query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the\n limit for the amount of bytes scanned (cutoff) per query, if it is specified, and\n whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the\n WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, - "Name": { - "target": "com.amazonaws.athena#WorkGroupName", + "Description": { + "target": "com.amazonaws.athena#WorkGroupDescriptionString", "traits": { - "smithy.api#documentation": "

The workgroup name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The workgroup description.

" } } } @@ -601,19 +601,6 @@ "com.amazonaws.athena#DataCatalog": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.athena#DescriptionString", - "traits": { - "smithy.api#documentation": "

An optional description of the data catalog.

" - } - }, - "Name": { - "target": "com.amazonaws.athena#CatalogNameString", - "traits": { - "smithy.api#documentation": "

The name of the data catalog. The catalog name must be unique for the AWS account and\n can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

", - "smithy.api#required": {} - } - }, "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { @@ -626,6 +613,19 @@ "traits": { "smithy.api#documentation": "

Specifies the Lambda function or functions to use for the data catalog. This is a\n mapping whose values depend on the catalog type.

\n " } + }, + "Description": { + "target": "com.amazonaws.athena#DescriptionString", + "traits": { + "smithy.api#documentation": "

An optional description of the data catalog.

" + } + }, + "Name": { + "target": "com.amazonaws.athena#CatalogNameString", + "traits": { + "smithy.api#documentation": "

The name of the data catalog. The catalog name must be unique for the AWS account and\n can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

", + "smithy.api#required": {} + } } }, "traits": { @@ -635,17 +635,17 @@ "com.amazonaws.athena#DataCatalogSummary": { "type": "structure", "members": { - "CatalogName": { - "target": "com.amazonaws.athena#CatalogNameString", - "traits": { - "smithy.api#documentation": "

The name of the data catalog.

" - } - }, "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { "smithy.api#documentation": "

The data catalog type.

" } + }, + "CatalogName": { + "target": "com.amazonaws.athena#CatalogNameString", + "traits": { + "smithy.api#documentation": "

The name of the data catalog.

" + } } }, "traits": { @@ -680,12 +680,6 @@ "com.amazonaws.athena#Database": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.athena#ParametersMap", - "traits": { - "smithy.api#documentation": "

A set of custom key/value pairs.

" - } - }, "Name": { "target": "com.amazonaws.athena#NameString", "traits": { @@ -698,6 +692,12 @@ "traits": { "smithy.api#documentation": "

An optional description of the database.

" } + }, + "Parameters": { + "target": "com.amazonaws.athena#ParametersMap", + "traits": { + "smithy.api#documentation": "

A set of custom key/value pairs.

" + } } }, "traits": { @@ -834,18 +834,18 @@ "com.amazonaws.athena#DeleteWorkGroupInput": { "type": "structure", "members": { - "RecursiveDeleteOption": { - "target": "com.amazonaws.athena#BoxedBoolean", - "traits": { - "smithy.api#documentation": "

The option to delete the workgroup and its contents even if the workgroup contains any\n named queries.

" - } - }, "WorkGroup": { "target": "com.amazonaws.athena#WorkGroupName", "traits": { "smithy.api#documentation": "

The unique name of the workgroup to delete.

", "smithy.api#required": {} } + }, + "RecursiveDeleteOption": { + "target": "com.amazonaws.athena#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

The option to delete the workgroup and its contents even if the workgroup contains any\n named queries.

" + } } } }, @@ -993,17 +993,17 @@ "com.amazonaws.athena#GetDatabaseInput": { "type": "structure", "members": { - "DatabaseName": { - "target": "com.amazonaws.athena#NameString", + "CatalogName": { + "target": "com.amazonaws.athena#CatalogNameString", "traits": { - "smithy.api#documentation": "

The name of the database to return.

", + "smithy.api#documentation": "

The name of the data catalog that contains the database to return.

", "smithy.api#required": {} } }, - "CatalogName": { - "target": "com.amazonaws.athena#CatalogNameString", + "DatabaseName": { + "target": "com.amazonaws.athena#NameString", "traits": { - "smithy.api#documentation": "

The name of the data catalog that contains the database to return.

", + "smithy.api#documentation": "

The name of the database to return.

", "smithy.api#required": {} } } @@ -1134,10 +1134,10 @@ "com.amazonaws.athena#GetQueryResultsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.athena#Token", + "MaxResults": { + "target": "com.amazonaws.athena#MaxQueryResults", "traits": { - "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

The maximum number of results (rows) to return in this request.

" } }, "QueryExecutionId": { @@ -1147,10 +1147,10 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.athena#MaxQueryResults", + "NextToken": { + "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

The maximum number of results (rows) to return in this request.

" + "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" } } } @@ -1158,12 +1158,6 @@ "com.amazonaws.athena#GetQueryResultsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.athena#Token", - "traits": { - "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" - } - }, "ResultSet": { "target": "com.amazonaws.athena#ResultSet", "traits": { @@ -1175,6 +1169,12 @@ "traits": { "smithy.api#documentation": "

The number of rows inserted with a CREATE TABLE AS SELECT statement.

" } + }, + "NextToken": { + "target": "com.amazonaws.athena#Token", + "traits": { + "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" + } } } }, @@ -1204,6 +1204,13 @@ "com.amazonaws.athena#GetTableMetadataInput": { "type": "structure", "members": { + "DatabaseName": { + "target": "com.amazonaws.athena#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database that contains the table metadata to return.

", + "smithy.api#required": {} + } + }, "CatalogName": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { @@ -1217,13 +1224,6 @@ "smithy.api#documentation": "

The name of the table for which metadata is returned.

", "smithy.api#required": {} } - }, - "DatabaseName": { - "target": "com.amazonaws.athena#NameString", - "traits": { - "smithy.api#documentation": "

The name of the database that contains the table metadata to return.

", - "smithy.api#required": {} - } } } }, @@ -1422,11 +1422,10 @@ "com.amazonaws.athena#ListDatabasesInput": { "type": "structure", "members": { - "CatalogName": { - "target": "com.amazonaws.athena#CatalogNameString", + "MaxResults": { + "target": "com.amazonaws.athena#MaxDatabasesCount", "traits": { - "smithy.api#documentation": "

The name of the data catalog that contains the databases to return.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the maximum number of results to return.

" } }, "NextToken": { @@ -1435,10 +1434,11 @@ "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" } }, - "MaxResults": { - "target": "com.amazonaws.athena#MaxDatabasesCount", + "CatalogName": { + "target": "com.amazonaws.athena#CatalogNameString", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of results to return.

" + "smithy.api#documentation": "

The name of the data catalog that contains the databases to return.

", + "smithy.api#required": {} } } } @@ -1446,17 +1446,17 @@ "com.amazonaws.athena#ListDatabasesOutput": { "type": "structure", "members": { - "DatabaseList": { - "target": "com.amazonaws.athena#DatabaseList", - "traits": { - "smithy.api#documentation": "

A list of databases from a data catalog.

" - } - }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.

" } + }, + "DatabaseList": { + "target": "com.amazonaws.athena#DatabaseList", + "traits": { + "smithy.api#documentation": "

A list of databases from a data catalog.

" + } } } }, @@ -1488,6 +1488,12 @@ "com.amazonaws.athena#ListNamedQueriesInput": { "type": "structure", "members": { + "WorkGroup": { + "target": "com.amazonaws.athena#WorkGroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup from which the named queries are being returned. If a\n workgroup is not specified, the saved queries for the primary workgroup are\n returned.

" + } + }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { @@ -1499,29 +1505,23 @@ "traits": { "smithy.api#documentation": "

The maximum number of queries to return in this request.

" } - }, - "WorkGroup": { - "target": "com.amazonaws.athena#WorkGroupName", - "traits": { - "smithy.api#documentation": "

The name of the workgroup from which the named queries are being returned. If a\n workgroup is not specified, the saved queries for the primary workgroup are\n returned.

" - } } } }, "com.amazonaws.athena#ListNamedQueriesOutput": { "type": "structure", "members": { - "NamedQueryIds": { - "target": "com.amazonaws.athena#NamedQueryIdList", - "traits": { - "smithy.api#documentation": "

The list of unique query IDs.

" - } - }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" } + }, + "NamedQueryIds": { + "target": "com.amazonaws.athena#NamedQueryIdList", + "traits": { + "smithy.api#documentation": "

The list of unique query IDs.

" + } } } }, @@ -1553,6 +1553,12 @@ "com.amazonaws.athena#ListQueryExecutionsInput": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.athena#MaxQueryExecutionsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of query executions to return in this request.

" + } + }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { @@ -1564,29 +1570,23 @@ "traits": { "smithy.api#documentation": "

The name of the workgroup from which queries are being returned. If a workgroup is not\n specified, a list of available query execution IDs for the queries in the primary\n workgroup is returned.

" } - }, - "MaxResults": { - "target": "com.amazonaws.athena#MaxQueryExecutionsCount", - "traits": { - "smithy.api#documentation": "

The maximum number of query executions to return in this request.

" - } } } }, "com.amazonaws.athena#ListQueryExecutionsOutput": { "type": "structure", "members": { - "QueryExecutionIds": { - "target": "com.amazonaws.athena#QueryExecutionIdList", - "traits": { - "smithy.api#documentation": "

The unique IDs of each query execution as an array of strings.

" - } - }, "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { "smithy.api#documentation": "

A token to be used by the next request if this request is truncated.

" } + }, + "QueryExecutionIds": { + "target": "com.amazonaws.athena#QueryExecutionIdList", + "traits": { + "smithy.api#documentation": "

The unique IDs of each query execution as an array of strings.

" + } } } }, @@ -1622,6 +1622,12 @@ "com.amazonaws.athena#ListTableMetadataInput": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.athena#MaxTableMetadataCount", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of results to return.

" + } + }, "DatabaseName": { "target": "com.amazonaws.athena#NameString", "traits": { @@ -1629,24 +1635,18 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.athena#Token", - "traits": { - "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.athena#MaxTableMetadataCount", - "traits": { - "smithy.api#documentation": "

Specifies the maximum number of results to return.

" - } - }, "Expression": { "target": "com.amazonaws.athena#ExpressionString", "traits": { "smithy.api#documentation": "

A regex filter that pattern-matches table names. If no expression is supplied,\n metadata for all tables are listed.

" } }, + "NextToken": { + "target": "com.amazonaws.athena#Token", + "traits": { + "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.

" + } + }, "CatalogName": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { @@ -1659,17 +1659,17 @@ "com.amazonaws.athena#ListTableMetadataOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.athena#Token", - "traits": { - "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.

" - } - }, "TableMetadataList": { "target": "com.amazonaws.athena#TableMetadataList", "traits": { "smithy.api#documentation": "

A list of table metadata.

" } + }, + "NextToken": { + "target": "com.amazonaws.athena#Token", + "traits": { + "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.

" + } } } }, @@ -1711,35 +1711,35 @@ "smithy.api#documentation": "

The maximum number of results to be returned per request that lists the tags for the\n resource.

" } }, + "NextToken": { + "target": "com.amazonaws.athena#Token", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results for\n this request, where the request lists the tags for the resource with the specified\n ARN.

" + } + }, "ResourceARN": { "target": "com.amazonaws.athena#AmazonResourceName", "traits": { "smithy.api#documentation": "

Lists the tags for the resource with the specified ARN.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.athena#Token", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results for\n this request, where the request lists the tags for the resource with the specified\n ARN.

" - } } } }, "com.amazonaws.athena#ListTagsForResourceOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.athena#Token", - "traits": { - "smithy.api#documentation": "

A token to be used by the next request if this request is truncated.

" - } - }, "Tags": { "target": "com.amazonaws.athena#TagList", "traits": { "smithy.api#documentation": "

The list of tags associated with the specified resource.

" } + }, + "NextToken": { + "target": "com.amazonaws.athena#Token", + "traits": { + "smithy.api#documentation": "

A token to be used by the next request if this request is truncated.

" + } } } }, @@ -1771,17 +1771,17 @@ "com.amazonaws.athena#ListWorkGroupsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.athena#Token", - "traits": { - "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" - } - }, "MaxResults": { "target": "com.amazonaws.athena#MaxWorkGroupsCount", "traits": { "smithy.api#documentation": "

The maximum number of workgroups to return in this request.

" } + }, + "NextToken": { + "target": "com.amazonaws.athena#Token", + "traits": { + "smithy.api#documentation": "

A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n NextToken from the response object of the previous page call.

" + } } } }, @@ -1911,6 +1911,25 @@ "com.amazonaws.athena#NamedQuery": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.athena#DescriptionString", + "traits": { + "smithy.api#documentation": "

The query description.

" + } + }, + "WorkGroup": { + "target": "com.amazonaws.athena#WorkGroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup that contains the named query.

" + } + }, + "Database": { + "target": "com.amazonaws.athena#DatabaseString", + "traits": { + "smithy.api#documentation": "

The database to which the query belongs.

", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.athena#NameString", "traits": { @@ -1930,25 +1949,6 @@ "smithy.api#documentation": "

The SQL query statements that comprise the query.

", "smithy.api#required": {} } - }, - "Description": { - "target": "com.amazonaws.athena#DescriptionString", - "traits": { - "smithy.api#documentation": "

The query description.

" - } - }, - "Database": { - "target": "com.amazonaws.athena#DatabaseString", - "traits": { - "smithy.api#documentation": "

The database to which the query belongs.

", - "smithy.api#required": {} - } - }, - "WorkGroup": { - "target": "com.amazonaws.athena#WorkGroupName", - "traits": { - "smithy.api#documentation": "

The name of the workgroup that contains the named query.

" - } } }, "traits": { @@ -1997,6 +1997,24 @@ "com.amazonaws.athena#QueryExecution": { "type": "structure", "members": { + "StatementType": { + "target": "com.amazonaws.athena#StatementType", + "traits": { + "smithy.api#documentation": "

The type of query statement that was run. DDL indicates DDL query\n statements. DML indicates DML (Data Manipulation Language) query\n statements, such as CREATE TABLE AS SELECT. UTILITY indicates\n query statements other than DDL and DML, such as SHOW CREATE TABLE, or\n DESCRIBE .

" + } + }, + "Query": { + "target": "com.amazonaws.athena#QueryString", + "traits": { + "smithy.api#documentation": "

The SQL query statements which the query execution ran.

" + } + }, + "WorkGroup": { + "target": "com.amazonaws.athena#WorkGroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup in which the query ran.

" + } + }, "Statistics": { "target": "com.amazonaws.athena#QueryExecutionStatistics", "traits": { @@ -2009,24 +2027,12 @@ "smithy.api#documentation": "

The database in which the query execution occurred.

" } }, - "Query": { - "target": "com.amazonaws.athena#QueryString", - "traits": { - "smithy.api#documentation": "

The SQL query statements which the query execution ran.

" - } - }, "Status": { "target": "com.amazonaws.athena#QueryExecutionStatus", "traits": { "smithy.api#documentation": "

The completion date, current state, submission time, and state change reason (if\n applicable) for the query execution.

" } }, - "WorkGroup": { - "target": "com.amazonaws.athena#WorkGroupName", - "traits": { - "smithy.api#documentation": "

The name of the workgroup in which the query ran.

" - } - }, "ResultConfiguration": { "target": "com.amazonaws.athena#ResultConfiguration", "traits": { @@ -2038,12 +2044,6 @@ "traits": { "smithy.api#documentation": "

The unique identifier for each query execution.

" } - }, - "StatementType": { - "target": "com.amazonaws.athena#StatementType", - "traits": { - "smithy.api#documentation": "

The type of query statement that was run. DDL indicates DDL query\n statements. DML indicates DML (Data Manipulation Language) query\n statements, such as CREATE TABLE AS SELECT. UTILITY indicates\n query statements other than DDL and DML, such as SHOW CREATE TABLE, or\n DESCRIBE

.

" - } } }, "traits": { @@ -2053,17 +2053,17 @@ "com.amazonaws.athena#QueryExecutionContext": { "type": "structure", "members": { - "Database": { - "target": "com.amazonaws.athena#DatabaseString", - "traits": { - "smithy.api#documentation": "

The name of the database used in the query execution.

" - } - }, "Catalog": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "

The name of the data catalog used in the query execution.

" } + }, + "Database": { + "target": "com.amazonaws.athena#DatabaseString", + "traits": { + "smithy.api#documentation": "

The name of the database used in the query execution.

" + } } }, "traits": { @@ -2121,46 +2121,46 @@ "com.amazonaws.athena#QueryExecutionStatistics": { "type": "structure", "members": { - "DataManifestLocation": { - "target": "com.amazonaws.athena#String", + "EngineExecutionTimeInMillis": { + "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The location and file name of a data manifest file. The manifest file is saved to the\n Athena query results location in Amazon S3. The manifest file tracks files that the\n query wrote to Amazon S3. If the query fails, the manifest file also tracks files that\n the query intended to write. The manifest is useful for identifying orphaned files\n resulting from a failed query. For more information, see Working with Query Results, Output Files, and\n Query History in the Amazon Athena User Guide.

" + "smithy.api#documentation": "

The number of milliseconds that the query took to execute.

" } }, - "QueryQueueTimeInMillis": { + "TotalExecutionTimeInMillis": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically add the query\n back to the queue.

" + "smithy.api#documentation": "

The number of milliseconds that Athena took to run the query.

" } }, - "ServiceProcessingTimeInMillis": { + "QueryQueueTimeInMillis": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The number of milliseconds that Athena took to finalize and publish the query results\n after the query engine finished running the query.

" + "smithy.api#documentation": "

The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically add the query\n back to the queue.

" } }, - "TotalExecutionTimeInMillis": { - "target": "com.amazonaws.athena#Long", + "DataManifestLocation": { + "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The number of milliseconds that Athena took to run the query.

" + "smithy.api#documentation": "

The location and file name of a data manifest file. The manifest file is saved to the\n Athena query results location in Amazon S3. The manifest file tracks files that the\n query wrote to Amazon S3. If the query fails, the manifest file also tracks files that\n the query intended to write. The manifest is useful for identifying orphaned files\n resulting from a failed query. For more information, see Working with Query Results, Output Files, and\n Query History in the Amazon Athena User Guide.

" } }, - "QueryPlanningTimeInMillis": { + "DataScannedInBytes": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The number of milliseconds that Athena took to plan the query processing flow. This\n includes the time spent retrieving table partitions from the data source. Note that\n because the query engine performs the query planning, query planning time is a subset of\n engine processing time.

" + "smithy.api#documentation": "

The number of bytes in the data that was queried.

" } }, - "DataScannedInBytes": { + "QueryPlanningTimeInMillis": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The number of bytes in the data that was queried.

" + "smithy.api#documentation": "

The number of milliseconds that Athena took to plan the query processing flow. This\n includes the time spent retrieving table partitions from the data source. Note that\n because the query engine performs the query planning, query planning time is a subset of\n engine processing time.

" } }, - "EngineExecutionTimeInMillis": { + "ServiceProcessingTimeInMillis": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The number of milliseconds that the query took to execute.

" + "smithy.api#documentation": "

The number of milliseconds that Athena took to finalize and publish the query results\n after the query engine finished running the query.

" } } }, @@ -2171,18 +2171,6 @@ "com.amazonaws.athena#QueryExecutionStatus": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.athena#QueryExecutionState", - "traits": { - "smithy.api#documentation": "

The state of query execution. QUEUED indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as resources are\n available. RUNNING indicates that the query is in execution phase.\n SUCCEEDED indicates that the query completed without errors.\n FAILED indicates that the query experienced an error and did not\n complete processing. CANCELLED indicates that a user input interrupted\n query execution.

\n \n

Athena automatically retries your queries in cases of certain transient errors. As\n a result, you may see the query state transition from RUNNING or\n FAILED to QUEUED.

\n " - } - }, - "CompletionDateTime": { - "target": "com.amazonaws.athena#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the query completed.

" - } - }, "SubmissionDateTime": { "target": "com.amazonaws.athena#Date", "traits": { @@ -2194,6 +2182,18 @@ "traits": { "smithy.api#documentation": "

Further detail about the status of the query.

" } + }, + "State": { + "target": "com.amazonaws.athena#QueryExecutionState", + "traits": { + "smithy.api#documentation": "

The state of query execution. QUEUED indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as resources are\n available. RUNNING indicates that the query is in execution phase.\n SUCCEEDED indicates that the query completed without errors.\n FAILED indicates that the query experienced an error and did not\n complete processing. CANCELLED indicates that a user input interrupted\n query execution.

\n \n

Athena automatically retries your queries in cases of certain transient errors. As\n a result, you may see the query state transition from RUNNING or\n FAILED to QUEUED.

\n " + } + }, + "CompletionDateTime": { + "target": "com.amazonaws.athena#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the query completed.

" + } } }, "traits": { @@ -2212,11 +2212,11 @@ "com.amazonaws.athena#ResourceNotFoundException": { "type": "structure", "members": { - "ResourceName": { - "target": "com.amazonaws.athena#AmazonResourceName" - }, "Message": { "target": "com.amazonaws.athena#ErrorMessage" + }, + "ResourceName": { + "target": "com.amazonaws.athena#AmazonResourceName" } }, "traits": { @@ -2227,17 +2227,17 @@ "com.amazonaws.athena#ResultConfiguration": { "type": "structure", "members": { - "EncryptionConfiguration": { - "target": "com.amazonaws.athena#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option used (for\n example, SSE-KMS or CSE-KMS) and key information. This is a\n client-side setting. If workgroup settings override client-side settings, then the query\n uses the encryption configuration that is specified for the workgroup, and also uses the\n location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" - } - }, "OutputLocation": { "target": "com.amazonaws.athena#String", "traits": { "smithy.api#documentation": "

The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error\n that no output location is provided. For more information, see Query Results. If\n workgroup settings override client-side settings, then the query uses the settings\n specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.athena#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option used (for\n example, SSE-KMS or CSE-KMS) and key information. This is a\n client-side setting. If workgroup settings override client-side settings, then the query\n uses the encryption configuration that is specified for the workgroup, and also uses the\n location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + } } }, "traits": { @@ -2247,28 +2247,28 @@ "com.amazonaws.athena#ResultConfigurationUpdates": { "type": "structure", "members": { - "EncryptionConfiguration": { - "target": "com.amazonaws.athena#EncryptionConfiguration", + "RemoveEncryptionConfiguration": { + "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

The encryption configuration for the query results.

" + "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified encryption configuration\n (also known as the client-side setting) for queries in this workgroup should be ignored\n and set to null. If set to \"false\" or not set, and a value is present in the\n EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the\n EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the\n new value. For more information, see Workgroup Settings Override\n Client-Side Settings.

" } }, - "RemoveOutputLocation": { - "target": "com.amazonaws.athena#BoxedBoolean", + "OutputLocation": { + "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the OutputLocation in\n ResultConfigurationUpdates (the client-side setting), the OutputLocation in the\n workgroup's ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

" + "smithy.api#documentation": "

The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. For more information, see Query Results If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the workgroup.\n The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration\n (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, - "RemoveEncryptionConfiguration": { + "RemoveOutputLocation": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified encryption configuration\n (also known as the client-side setting) for queries in this workgroup should be ignored\n and set to null. If set to \"false\" or not set, and a value is present in the\n EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the\n EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the\n new value. For more information, see Workgroup Settings Override\n Client-Side Settings.

" + "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the OutputLocation in\n ResultConfigurationUpdates (the client-side setting), the OutputLocation in the\n workgroup's ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

" } }, - "OutputLocation": { - "target": "com.amazonaws.athena#String", + "EncryptionConfiguration": { + "target": "com.amazonaws.athena#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. For more information, see Query Results If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the workgroup.\n The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration\n (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The encryption configuration for the query results.

" } } }, @@ -2279,17 +2279,17 @@ "com.amazonaws.athena#ResultSet": { "type": "structure", "members": { - "ResultSetMetadata": { - "target": "com.amazonaws.athena#ResultSetMetadata", - "traits": { - "smithy.api#documentation": "

The metadata that describes the column structure and data types of a table of query\n results.

" - } - }, "Rows": { "target": "com.amazonaws.athena#RowList", "traits": { "smithy.api#documentation": "

The rows in the table.

" } + }, + "ResultSetMetadata": { + "target": "com.amazonaws.athena#ResultSetMetadata", + "traits": { + "smithy.api#documentation": "

The metadata that describes the column structure and data types of a table of query\n results.

" + } } }, "traits": { @@ -2357,18 +2357,6 @@ "com.amazonaws.athena#StartQueryExecutionInput": { "type": "structure", "members": { - "QueryExecutionContext": { - "target": "com.amazonaws.athena#QueryExecutionContext", - "traits": { - "smithy.api#documentation": "

The database within which the query executes.

" - } - }, - "ResultConfiguration": { - "target": "com.amazonaws.athena#ResultConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies information about where and how to save the results of the query execution.\n If the query runs in a workgroup, then workgroup's settings may override query settings.\n This affects the query results location. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" - } - }, "QueryString": { "target": "com.amazonaws.athena#QueryString", "traits": { @@ -2388,6 +2376,18 @@ "traits": { "smithy.api#documentation": "

The name of the workgroup in which the query is being started.

" } + }, + "QueryExecutionContext": { + "target": "com.amazonaws.athena#QueryExecutionContext", + "traits": { + "smithy.api#documentation": "

The database within which the query executes.

" + } + }, + "ResultConfiguration": { + "target": "com.amazonaws.athena#ResultConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies information about where and how to save the results of the query execution.\n If the query runs in a workgroup, then workgroup's settings may override query settings.\n This affects the query results location. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + } } } }, @@ -2465,22 +2465,17 @@ "com.amazonaws.athena#TableMetadata": { "type": "structure", "members": { - "TableType": { - "target": "com.amazonaws.athena#TableTypeString", - "traits": { - "smithy.api#documentation": "

The type of table. In Athena, only EXTERNAL_TABLE is supported.

" - } - }, - "PartitionKeys": { - "target": "com.amazonaws.athena#ColumnList", + "Name": { + "target": "com.amazonaws.athena#NameString", "traits": { - "smithy.api#documentation": "

A list of the partition keys in the table.

" + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} } }, - "Parameters": { - "target": "com.amazonaws.athena#ParametersMap", + "CreateTime": { + "target": "com.amazonaws.athena#Timestamp", "traits": { - "smithy.api#documentation": "

A set of custom key/value pairs for table properties.

" + "smithy.api#documentation": "

The time that the table was created.

" } }, "LastAccessTime": { @@ -2489,23 +2484,28 @@ "smithy.api#documentation": "

The last time the table was accessed.

" } }, + "PartitionKeys": { + "target": "com.amazonaws.athena#ColumnList", + "traits": { + "smithy.api#documentation": "

A list of the partition keys in the table.

" + } + }, "Columns": { "target": "com.amazonaws.athena#ColumnList", "traits": { "smithy.api#documentation": "

A list of the columns in the table.

" } }, - "Name": { - "target": "com.amazonaws.athena#NameString", + "Parameters": { + "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

The name of the table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A set of custom key/value pairs for table properties.

" } }, - "CreateTime": { - "target": "com.amazonaws.athena#Timestamp", + "TableType": { + "target": "com.amazonaws.athena#TableTypeString", "traits": { - "smithy.api#documentation": "

The time that the table was created.

" + "smithy.api#documentation": "

The type of table. In Athena, only EXTERNAL_TABLE is supported.

" } } }, @@ -2651,11 +2651,11 @@ "com.amazonaws.athena#TooManyRequestsException": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.athena#ThrottleReason" - }, "Message": { "target": "com.amazonaws.athena#ErrorMessage" + }, + "Reason": { + "target": "com.amazonaws.athena#ThrottleReason" } }, "traits": { @@ -2676,10 +2676,10 @@ "com.amazonaws.athena#UnprocessedNamedQueryId": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.athena#ErrorMessage", + "NamedQueryId": { + "target": "com.amazonaws.athena#NamedQueryId", "traits": { - "smithy.api#documentation": "

The error message returned when the processing request for the named query failed, if\n applicable.

" + "smithy.api#documentation": "

The unique identifier of the named query.

" } }, "ErrorCode": { @@ -2688,10 +2688,10 @@ "smithy.api#documentation": "

The error code returned when the processing request for the named query failed, if\n applicable.

" } }, - "NamedQueryId": { - "target": "com.amazonaws.athena#NamedQueryId", + "ErrorMessage": { + "target": "com.amazonaws.athena#ErrorMessage", "traits": { - "smithy.api#documentation": "

The unique identifier of the named query.

" + "smithy.api#documentation": "

The error message returned when the processing request for the named query failed, if\n applicable.

" } } }, @@ -2708,18 +2708,18 @@ "com.amazonaws.athena#UnprocessedQueryExecutionId": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.athena#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code returned when the query execution failed to process, if\n applicable.

" - } - }, "ErrorMessage": { "target": "com.amazonaws.athena#ErrorMessage", "traits": { "smithy.api#documentation": "

The error message returned when the query execution failed to process, if\n applicable.

" } }, + "ErrorCode": { + "target": "com.amazonaws.athena#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code returned when the query execution failed to process, if\n applicable.

" + } + }, "QueryExecutionId": { "target": "com.amazonaws.athena#QueryExecutionId", "traits": { @@ -2763,17 +2763,17 @@ "com.amazonaws.athena#UntagResourceInput": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.athena#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.athena#AmazonResourceName", "traits": { - "smithy.api#documentation": "

A comma-separated list of one or more tag keys whose tags are to be removed from the\n specified resource.

", + "smithy.api#documentation": "

Specifies the ARN of the resource from which tags are to be removed.

", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.athena#AmazonResourceName", + "TagKeys": { + "target": "com.amazonaws.athena#TagKeyList", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the resource from which tags are to be removed.

", + "smithy.api#documentation": "

A comma-separated list of one or more tag keys whose tags are to be removed from the\n specified resource.

", "smithy.api#required": {} } } @@ -2806,6 +2806,12 @@ "com.amazonaws.athena#UpdateDataCatalogInput": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.athena#DescriptionString", + "traits": { + "smithy.api#documentation": "

New or modified text that describes the data catalog.

" + } + }, "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { @@ -2813,24 +2819,18 @@ "smithy.api#required": {} } }, + "Parameters": { + "target": "com.amazonaws.athena#ParametersMap", + "traits": { + "smithy.api#documentation": "

Specifies the Lambda function or functions to use for updating the data catalog. This\n is a mapping whose values depend on the catalog type.

\n " + } + }, "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { "smithy.api#documentation": "

The name of the data catalog to update. The catalog name must be unique for the AWS\n account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen\n characters.

", "smithy.api#required": {} } - }, - "Description": { - "target": "com.amazonaws.athena#DescriptionString", - "traits": { - "smithy.api#documentation": "

New or modified text that describes the data catalog.

" - } - }, - "Parameters": { - "target": "com.amazonaws.athena#ParametersMap", - "traits": { - "smithy.api#documentation": "

Specifies the Lambda function or functions to use for updating the data catalog. This\n is a mapping whose values depend on the catalog type.

\n " - } } } }, @@ -2867,6 +2867,13 @@ "smithy.api#documentation": "

The workgroup state that will be updated for the given workgroup.

" } }, + "WorkGroup": { + "target": "com.amazonaws.athena#WorkGroupName", + "traits": { + "smithy.api#documentation": "

The specified workgroup that will be updated.

", + "smithy.api#required": {} + } + }, "Description": { "target": "com.amazonaws.athena#WorkGroupDescriptionString", "traits": { @@ -2878,13 +2885,6 @@ "traits": { "smithy.api#documentation": "

The workgroup configuration that will be updated for the given workgroup.

" } - }, - "WorkGroup": { - "target": "com.amazonaws.athena#WorkGroupName", - "traits": { - "smithy.api#documentation": "

The specified workgroup that will be updated.

", - "smithy.api#required": {} - } } } }, @@ -2895,11 +2895,10 @@ "com.amazonaws.athena#WorkGroup": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.athena#WorkGroupName", + "Description": { + "target": "com.amazonaws.athena#WorkGroupDescriptionString", "traits": { - "smithy.api#documentation": "

The workgroup name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The workgroup description.

" } }, "CreationTime": { @@ -2908,10 +2907,11 @@ "smithy.api#documentation": "

The date and time the workgroup was created.

" } }, - "State": { - "target": "com.amazonaws.athena#WorkGroupState", + "Name": { + "target": "com.amazonaws.athena#WorkGroupName", "traits": { - "smithy.api#documentation": "

The state of the workgroup: ENABLED or DISABLED.

" + "smithy.api#documentation": "

The workgroup name.

", + "smithy.api#required": {} } }, "Configuration": { @@ -2920,10 +2920,10 @@ "smithy.api#documentation": "

The configuration of the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption configuration, if any, used for query results;\n whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup\n settings override client-side settings; and the data usage limits for the amount of data\n scanned per query or per workgroup. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, - "Description": { - "target": "com.amazonaws.athena#WorkGroupDescriptionString", + "State": { + "target": "com.amazonaws.athena#WorkGroupState", "traits": { - "smithy.api#documentation": "

The workgroup description.

" + "smithy.api#documentation": "

The state of the workgroup: ENABLED or DISABLED.

" } } }, @@ -2934,16 +2934,16 @@ "com.amazonaws.athena#WorkGroupConfiguration": { "type": "structure", "members": { - "BytesScannedCutoffPerQuery": { - "target": "com.amazonaws.athena#BytesScannedCutoffValue", + "EnforceWorkGroupConfiguration": { + "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

The upper data usage limit (cutoff) for the amount of bytes a single query in a\n workgroup is allowed to scan.

" + "smithy.api#documentation": "

If set to \"true\", the settings for the workgroup override client-side settings. If set\n to \"false\", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

" } }, - "RequesterPaysEnabled": { - "target": "com.amazonaws.athena#BoxedBoolean", + "ResultConfiguration": { + "target": "com.amazonaws.athena#ResultConfiguration", "traits": { - "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to reference\n Amazon S3 Requester Pays buckets in queries. If set to false, workgroup\n members cannot query data from Requester Pays buckets, and queries that retrieve data\n from Requester Pays buckets cause an error. The default is false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.

" + "smithy.api#documentation": "

The configuration for the workgroup, which includes the location in Amazon S3 where\n query results are stored and the encryption option, if any, used for query results. To\n run the query, you must specify the query results location using one of the ways: either\n in the workgroup using this setting, or for individual queries (client-side), using\n ResultConfiguration$OutputLocation. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Query\n Results.

" } }, "PublishCloudWatchMetricsEnabled": { @@ -2952,16 +2952,16 @@ "smithy.api#documentation": "

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

" } }, - "EnforceWorkGroupConfiguration": { - "target": "com.amazonaws.athena#BoxedBoolean", + "BytesScannedCutoffPerQuery": { + "target": "com.amazonaws.athena#BytesScannedCutoffValue", "traits": { - "smithy.api#documentation": "

If set to \"true\", the settings for the workgroup override client-side settings. If set\n to \"false\", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

" + "smithy.api#documentation": "

The upper data usage limit (cutoff) for the amount of bytes a single query in a\n workgroup is allowed to scan.

" } }, - "ResultConfiguration": { - "target": "com.amazonaws.athena#ResultConfiguration", + "RequesterPaysEnabled": { + "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

The configuration for the workgroup, which includes the location in Amazon S3 where\n query results are stored and the encryption option, if any, used for query results. To\n run the query, you must specify the query results location using one of the ways: either\n in the workgroup using this setting, or for individual queries (client-side), using\n ResultConfiguration$OutputLocation. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Query\n Results.

" + "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to reference\n Amazon S3 Requester Pays buckets in queries. If set to false, workgroup\n members cannot query data from Requester Pays buckets, and queries that retrieve data\n from Requester Pays buckets cause an error. The default is false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.

" } } }, @@ -2972,28 +2972,28 @@ "com.amazonaws.athena#WorkGroupConfigurationUpdates": { "type": "structure", "members": { - "PublishCloudWatchMetricsEnabled": { - "target": "com.amazonaws.athena#BoxedBoolean", + "BytesScannedCutoffPerQuery": { + "target": "com.amazonaws.athena#BytesScannedCutoffValue", "traits": { - "smithy.api#documentation": "

Indicates whether this workgroup enables publishing metrics to Amazon\n CloudWatch.

" + "smithy.api#documentation": "

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is\n allowed to scan.

" } }, - "ResultConfigurationUpdates": { - "target": "com.amazonaws.athena#ResultConfigurationUpdates", + "RequesterPaysEnabled": { + "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

The result configuration information about the queries in this workgroup that will be\n updated. Includes the updated results location and an updated option for encrypting\n query results.

" + "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to specify Amazon\n S3 Requester Pays buckets in queries. If set to false, workgroup members\n cannot query data from Requester Pays buckets, and queries that retrieve data from\n Requester Pays buckets cause an error. The default is false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.

" } }, - "RequesterPaysEnabled": { + "PublishCloudWatchMetricsEnabled": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to specify Amazon\n S3 Requester Pays buckets in queries. If set to false, workgroup members\n cannot query data from Requester Pays buckets, and queries that retrieve data from\n Requester Pays buckets cause an error. The default is false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.

" + "smithy.api#documentation": "

Indicates whether this workgroup enables publishing metrics to Amazon\n CloudWatch.

" } }, - "BytesScannedCutoffPerQuery": { - "target": "com.amazonaws.athena#BytesScannedCutoffValue", + "ResultConfigurationUpdates": { + "target": "com.amazonaws.athena#ResultConfigurationUpdates", "traits": { - "smithy.api#documentation": "

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is\n allowed to scan.

" + "smithy.api#documentation": "

The result configuration information about the queries in this workgroup that will be\n updated. Includes the updated results location and an updated option for encrypting\n query results.

" } }, "EnforceWorkGroupConfiguration": { @@ -3046,18 +3046,6 @@ "com.amazonaws.athena#WorkGroupSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.athena#Date", - "traits": { - "smithy.api#documentation": "

The workgroup creation date and time.

" - } - }, - "Name": { - "target": "com.amazonaws.athena#WorkGroupName", - "traits": { - "smithy.api#documentation": "

The name of the workgroup.

" - } - }, "Description": { "target": "com.amazonaws.athena#WorkGroupDescriptionString", "traits": { @@ -3069,6 +3057,18 @@ "traits": { "smithy.api#documentation": "

The state of the workgroup.

" } + }, + "CreationTime": { + "target": "com.amazonaws.athena#Date", + "traits": { + "smithy.api#documentation": "

The workgroup creation date and time.

" + } + }, + "Name": { + "target": "com.amazonaws.athena#WorkGroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/auto-scaling-plans.2018-01-06.json b/codegen/sdk-codegen/aws-models/auto-scaling-plans.2018-01-06.json index 42065cec53fa..e3862318b18e 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling-plans.2018-01-06.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling-plans.2018-01-06.json @@ -57,7 +57,7 @@ "sdkId": "Auto Scaling Plans", "arnNamespace": "autoscaling-plans", "cloudFormationName": "AutoScalingPlans", - "cloudTrailEventSource": "frontend.scaling_planner.anyscale.autoscaling.amazonaws.com" + "cloudTrailEventSource": "autoscalingplans.amazonaws.com" }, "aws.auth#sigv4": { "name": "autoscaling-plans" @@ -70,17 +70,17 @@ "com.amazonaws.autoscalingplans#ApplicationSource": { "type": "structure", "members": { - "TagFilters": { - "target": "com.amazonaws.autoscalingplans#TagFilters", - "traits": { - "smithy.api#documentation": "

A set of tags (up to 50).

" - } - }, "CloudFormationStackARN": { "target": "com.amazonaws.autoscalingplans#XmlString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

" } + }, + "TagFilters": { + "target": "com.amazonaws.autoscalingplans#TagFilters", + "traits": { + "smithy.api#documentation": "

A set of tags (up to 50).

" + } } }, "traits": { @@ -141,6 +141,13 @@ "com.amazonaws.autoscalingplans#CreateScalingPlanRequest": { "type": "structure", "members": { + "ApplicationSource": { + "target": "com.amazonaws.autoscalingplans#ApplicationSource", + "traits": { + "smithy.api#documentation": "

A CloudFormation stack or set of tags. You can create one scaling plan per application\n source.

", + "smithy.api#required": {} + } + }, "ScalingPlanName": { "target": "com.amazonaws.autoscalingplans#ScalingPlanName", "traits": { @@ -154,13 +161,6 @@ "smithy.api#documentation": "

The scaling instructions.

", "smithy.api#required": {} } - }, - "ApplicationSource": { - "target": "com.amazonaws.autoscalingplans#ApplicationSource", - "traits": { - "smithy.api#documentation": "

A CloudFormation stack or set of tags. You can create one scaling plan per application\n source.

", - "smithy.api#required": {} - } } } }, @@ -179,24 +179,23 @@ "com.amazonaws.autoscalingplans#CustomizedLoadMetricSpecification": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.autoscalingplans#MetricNamespace", + "Dimensions": { + "target": "com.amazonaws.autoscalingplans#MetricDimensions", "traits": { - "smithy.api#documentation": "

The namespace of the metric.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your customized load metric specification.

" } }, - "Statistic": { - "target": "com.amazonaws.autoscalingplans#MetricStatistic", + "Unit": { + "target": "com.amazonaws.autoscalingplans#MetricUnit", "traits": { - "smithy.api#documentation": "

The statistic of the metric. Currently, the value must always be Sum.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unit of the metric.

" } }, - "Dimensions": { - "target": "com.amazonaws.autoscalingplans#MetricDimensions", + "Namespace": { + "target": "com.amazonaws.autoscalingplans#MetricNamespace", "traits": { - "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your customized load metric specification.

" + "smithy.api#documentation": "

The namespace of the metric.

", + "smithy.api#required": {} } }, "MetricName": { @@ -206,10 +205,11 @@ "smithy.api#required": {} } }, - "Unit": { - "target": "com.amazonaws.autoscalingplans#MetricUnit", + "Statistic": { + "target": "com.amazonaws.autoscalingplans#MetricStatistic", "traits": { - "smithy.api#documentation": "

The unit of the metric.

" + "smithy.api#documentation": "

The statistic of the metric. Currently, the value must always be Sum.\n

", + "smithy.api#required": {} } } }, @@ -220,10 +220,11 @@ "com.amazonaws.autoscalingplans#CustomizedScalingMetricSpecification": { "type": "structure", "members": { - "Dimensions": { - "target": "com.amazonaws.autoscalingplans#MetricDimensions", + "Statistic": { + "target": "com.amazonaws.autoscalingplans#MetricStatistic", "traits": { - "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your customized scaling metric specification.

" + "smithy.api#documentation": "

The statistic of the metric.

", + "smithy.api#required": {} } }, "Unit": { @@ -232,13 +233,6 @@ "smithy.api#documentation": "

The unit of the metric.

" } }, - "Namespace": { - "target": "com.amazonaws.autoscalingplans#MetricNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the metric.

", - "smithy.api#required": {} - } - }, "MetricName": { "target": "com.amazonaws.autoscalingplans#MetricName", "traits": { @@ -246,12 +240,18 @@ "smithy.api#required": {} } }, - "Statistic": { - "target": "com.amazonaws.autoscalingplans#MetricStatistic", + "Namespace": { + "target": "com.amazonaws.autoscalingplans#MetricNamespace", "traits": { - "smithy.api#documentation": "

The statistic of the metric.

", + "smithy.api#documentation": "

The namespace of the metric.

", "smithy.api#required": {} } + }, + "Dimensions": { + "target": "com.amazonaws.autoscalingplans#MetricDimensions", + "traits": { + "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your customized scaling metric specification.

" + } } }, "traits": { @@ -261,17 +261,17 @@ "com.amazonaws.autoscalingplans#Datapoint": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.autoscalingplans#MetricScale", - "traits": { - "smithy.api#documentation": "

The value of the data point.

" - } - }, "Timestamp": { "target": "com.amazonaws.autoscalingplans#TimestampType", "traits": { "smithy.api#documentation": "

The time stamp for the data point in UTC format.

" } + }, + "Value": { + "target": "com.amazonaws.autoscalingplans#MetricScale", + "traits": { + "smithy.api#documentation": "

The value of the data point.

" + } } }, "traits": { @@ -313,17 +313,17 @@ "com.amazonaws.autoscalingplans#DeleteScalingPlanRequest": { "type": "structure", "members": { - "ScalingPlanName": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanName", + "ScalingPlanVersion": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", "traits": { - "smithy.api#documentation": "

The name of the scaling plan.

", + "smithy.api#documentation": "

The version number of the scaling plan.

", "smithy.api#required": {} } }, - "ScalingPlanVersion": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", + "ScalingPlanName": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanName", "traits": { - "smithy.api#documentation": "

The version number of the scaling plan.

", + "smithy.api#documentation": "

The name of the scaling plan.

", "smithy.api#required": {} } } @@ -362,11 +362,10 @@ "com.amazonaws.autoscalingplans#DescribeScalingPlanResourcesRequest": { "type": "structure", "members": { - "ScalingPlanName": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanName", + "NextToken": { + "target": "com.amazonaws.autoscalingplans#NextToken", "traits": { - "smithy.api#documentation": "

The name of the scaling plan.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next set of results.

" } }, "ScalingPlanVersion": { @@ -382,10 +381,11 @@ "smithy.api#documentation": "

The maximum number of scalable resources to return. The value must be between\n 1 and 50. The default value is 50.

" } }, - "NextToken": { - "target": "com.amazonaws.autoscalingplans#NextToken", + "ScalingPlanName": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanName", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" + "smithy.api#documentation": "

The name of the scaling plan.

", + "smithy.api#required": {} } } } @@ -436,12 +436,6 @@ "com.amazonaws.autoscalingplans#DescribeScalingPlansRequest": { "type": "structure", "members": { - "ScalingPlanVersion": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", - "traits": { - "smithy.api#documentation": "

The version number of the scaling plan. If you specify a scaling plan version, you must\n also specify a scaling plan name.

" - } - }, "ApplicationSources": { "target": "com.amazonaws.autoscalingplans#ApplicationSources", "traits": { @@ -454,10 +448,10 @@ "smithy.api#documentation": "

The names of the scaling plans (up to 10). If you specify application sources, you\n cannot specify scaling plan names.

" } }, - "MaxResults": { - "target": "com.amazonaws.autoscalingplans#MaxResults", + "ScalingPlanVersion": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", "traits": { - "smithy.api#documentation": "

The maximum number of scalable resources to return. This value can be between\n 1 and 50. The default value is 50.

" + "smithy.api#documentation": "

The version number of the scaling plan. If you specify a scaling plan version, you must\n also specify a scaling plan name.

" } }, "NextToken": { @@ -465,23 +459,29 @@ "traits": { "smithy.api#documentation": "

The token for the next set of results.

" } + }, + "MaxResults": { + "target": "com.amazonaws.autoscalingplans#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of scalable resources to return. This value can be between\n 1 and 50. The default value is 50.

" + } } } }, "com.amazonaws.autoscalingplans#DescribeScalingPlansResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscalingplans#NextToken", - "traits": { - "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" - } - }, "ScalingPlans": { "target": "com.amazonaws.autoscalingplans#ScalingPlans", "traits": { "smithy.api#documentation": "

Information about the scaling plans.

" } + }, + "NextToken": { + "target": "com.amazonaws.autoscalingplans#NextToken", + "traits": { + "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" + } } } }, @@ -553,6 +553,20 @@ "smithy.api#required": {} } }, + "ServiceNamespace": { + "target": "com.amazonaws.autoscalingplans#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the AWS service.

", + "smithy.api#required": {} + } + }, + "ScalingPlanVersion": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", + "traits": { + "smithy.api#documentation": "

The version number of the scaling plan.

", + "smithy.api#required": {} + } + }, "ScalableDimension": { "target": "com.amazonaws.autoscalingplans#ScalableDimension", "traits": { @@ -567,17 +581,10 @@ "smithy.api#required": {} } }, - "ScalingPlanVersion": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", - "traits": { - "smithy.api#documentation": "

The version number of the scaling plan.

", - "smithy.api#required": {} - } - }, - "ForecastDataType": { - "target": "com.amazonaws.autoscalingplans#ForecastDataType", + "ResourceId": { + "target": "com.amazonaws.autoscalingplans#XmlString", "traits": { - "smithy.api#documentation": "

The type of forecast data to get.

\n ", + "smithy.api#documentation": "

The ID of the resource. This string consists of the resource type and unique identifier.\n

\n ", "smithy.api#required": {} } }, @@ -588,17 +595,10 @@ "smithy.api#required": {} } }, - "ServiceNamespace": { - "target": "com.amazonaws.autoscalingplans#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the AWS service.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.autoscalingplans#XmlString", + "ForecastDataType": { + "target": "com.amazonaws.autoscalingplans#ForecastDataType", "traits": { - "smithy.api#documentation": "

The ID of the resource. This string consists of the resource type and unique identifier.\n

\n ", + "smithy.api#documentation": "

The type of forecast data to get.

\n ", "smithy.api#required": {} } } @@ -687,17 +687,17 @@ "com.amazonaws.autoscalingplans#MetricDimension": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.autoscalingplans#MetricDimensionName", + "Value": { + "target": "com.amazonaws.autoscalingplans#MetricDimensionValue", "traits": { - "smithy.api#documentation": "

The name of the dimension.

", + "smithy.api#documentation": "

The value of the dimension.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.autoscalingplans#MetricDimensionValue", + "Name": { + "target": "com.amazonaws.autoscalingplans#MetricDimensionName", "traits": { - "smithy.api#documentation": "

The value of the dimension.

", + "smithy.api#documentation": "

The name of the dimension.

", "smithy.api#required": {} } } @@ -800,18 +800,18 @@ "com.amazonaws.autoscalingplans#PredefinedLoadMetricSpecification": { "type": "structure", "members": { + "ResourceLabel": { + "target": "com.amazonaws.autoscalingplans#ResourceLabel", + "traits": { + "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group for an Application Load Balancer attached to the Auto Scaling group.

\n

The format is\n app///targetgroup//,\n where:

\n " + } + }, "PredefinedLoadMetricType": { "target": "com.amazonaws.autoscalingplans#LoadMetricType", "traits": { "smithy.api#documentation": "

The metric type.

", "smithy.api#required": {} } - }, - "ResourceLabel": { - "target": "com.amazonaws.autoscalingplans#ResourceLabel", - "traits": { - "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group for an Application Load Balancer attached to the Auto Scaling group.

\n

The format is\n app///targetgroup//,\n where:

\n " - } } }, "traits": { @@ -947,17 +947,16 @@ "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.autoscalingplans#ResourceIdMaxLen1600", + "PredictiveScalingMaxCapacityBehavior": { + "target": "com.amazonaws.autoscalingplans#PredictiveScalingMaxCapacityBehavior", "traits": { - "smithy.api#documentation": "

The ID of the resource. This string consists of the resource type and unique\n identifier.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity specified for the resource. The default value is\n SetForecastCapacityToMaxCapacity.

\n

The following are possible values:

\n \n

Only valid when configuring predictive scaling.

" } }, - "ScheduledActionBufferTime": { - "target": "com.amazonaws.autoscalingplans#ScheduledActionBufferTime", + "CustomizedLoadMetricSpecification": { + "target": "com.amazonaws.autoscalingplans#CustomizedLoadMetricSpecification", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to buffer the run time of scheduled scaling actions when\n scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer\n time is 5 minutes, then the run time of the corresponding scheduled scaling action will be\n 9:55 AM. The intention is to give resources time to be provisioned. For example, it can\n take a few minutes to launch an EC2 instance. The actual amount of time required depends on\n several factors, such as the size of the instance and whether there are startup scripts to\n complete.

\n

The value must be less than the forecast interval duration of 3600 seconds (60 minutes).\n The default is 300 seconds.

\n

Only valid when configuring predictive scaling.

" + "smithy.api#documentation": "

The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring\n predictive scaling, and cannot be used otherwise.

" } }, "ServiceNamespace": { @@ -967,48 +966,49 @@ "smithy.api#required": {} } }, - "PredictiveScalingMaxCapacityBehavior": { - "target": "com.amazonaws.autoscalingplans#PredictiveScalingMaxCapacityBehavior", + "ResourceId": { + "target": "com.amazonaws.autoscalingplans#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity specified for the resource. The default value is\n SetForecastCapacityToMaxCapacity.

\n

The following are possible values:

\n \n

Only valid when configuring predictive scaling.

" + "smithy.api#documentation": "

The ID of the resource. This string consists of the resource type and unique\n identifier.

\n ", + "smithy.api#required": {} } }, - "CustomizedLoadMetricSpecification": { - "target": "com.amazonaws.autoscalingplans#CustomizedLoadMetricSpecification", + "PredefinedLoadMetricSpecification": { + "target": "com.amazonaws.autoscalingplans#PredefinedLoadMetricSpecification", "traits": { - "smithy.api#documentation": "

The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring\n predictive scaling, and cannot be used otherwise.

" + "smithy.api#documentation": "

The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring\n predictive scaling, and cannot be used otherwise.

" } }, - "ScalingPolicyUpdateBehavior": { - "target": "com.amazonaws.autoscalingplans#ScalingPolicyUpdateBehavior", + "ScheduledActionBufferTime": { + "target": "com.amazonaws.autoscalingplans#ScheduledActionBufferTime", "traits": { - "smithy.api#documentation": "

Controls whether a resource's externally created scaling policies are kept or replaced.

\n

The default value is KeepExternalPolicies. If the parameter is set to\n ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling\n are deleted and new target tracking scaling policies created.

\n

Only valid when configuring dynamic scaling.

\n

Condition: The number of existing policies to be replaced must be less than or equal to\n 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies\n and does not create new ones.

" + "smithy.api#documentation": "

The amount of time, in seconds, to buffer the run time of scheduled scaling actions when\n scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer\n time is 5 minutes, then the run time of the corresponding scheduled scaling action will be\n 9:55 AM. The intention is to give resources time to be provisioned. For example, it can\n take a few minutes to launch an EC2 instance. The actual amount of time required depends on\n several factors, such as the size of the instance and whether there are startup scripts to\n complete.

\n

The value must be less than the forecast interval duration of 3600 seconds (60 minutes).\n The default is 300 seconds.

\n

Only valid when configuring predictive scaling.

" } }, - "TargetTrackingConfigurations": { - "target": "com.amazonaws.autoscalingplans#TargetTrackingConfigurations", + "PredictiveScalingMode": { + "target": "com.amazonaws.autoscalingplans#PredictiveScalingMode", "traits": { - "smithy.api#documentation": "

The structure that defines new target tracking configurations (up to 10). Each of these\n structures includes a specific scaling metric and a target value for the metric, along with\n various parameters to use with dynamic scaling.

\n

With predictive scaling and dynamic scaling, the resource scales based on the target\n tracking configuration that provides the largest capacity for both scale in and scale out.

\n

Condition: The scaling metric must be unique across target tracking\n configurations.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The predictive scaling mode. The default value is ForecastAndScale.\n Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions\n based on the capacity forecast.

" } }, - "ScalableDimension": { - "target": "com.amazonaws.autoscalingplans#ScalableDimension", + "PredictiveScalingMaxCapacityBuffer": { + "target": "com.amazonaws.autoscalingplans#ResourceCapacity", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the resource.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The size of the capacity buffer to use when the forecast capacity is close to or exceeds\n the maximum capacity. The value is specified as a percentage relative to the forecast\n capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if\n the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum\n capacity is 55.

\n

Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to\n SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

\n

The range is 1-100.

" } }, - "PredefinedLoadMetricSpecification": { - "target": "com.amazonaws.autoscalingplans#PredefinedLoadMetricSpecification", + "MaxCapacity": { + "target": "com.amazonaws.autoscalingplans#ResourceCapacity", "traits": { - "smithy.api#documentation": "

The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring\n predictive scaling, and cannot be used otherwise.

" + "smithy.api#documentation": "

The maximum capacity of the resource. The exception to this upper limit is if you\n specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

", + "smithy.api#required": {} } }, - "PredictiveScalingMaxCapacityBuffer": { - "target": "com.amazonaws.autoscalingplans#ResourceCapacity", + "TargetTrackingConfigurations": { + "target": "com.amazonaws.autoscalingplans#TargetTrackingConfigurations", "traits": { - "smithy.api#documentation": "

The size of the capacity buffer to use when the forecast capacity is close to or exceeds\n the maximum capacity. The value is specified as a percentage relative to the forecast\n capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if\n the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum\n capacity is 55.

\n

Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to\n SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

\n

The range is 1-100.

" + "smithy.api#documentation": "

The structure that defines new target tracking configurations (up to 10). Each of these\n structures includes a specific scaling metric and a target value for the metric, along with\n various parameters to use with dynamic scaling.

\n

With predictive scaling and dynamic scaling, the resource scales based on the target\n tracking configuration that provides the largest capacity for both scale in and scale out.

\n

Condition: The scaling metric must be unique across target tracking\n configurations.

", + "smithy.api#required": {} } }, "DisableDynamicScaling": { @@ -1017,17 +1017,17 @@ "smithy.api#documentation": "

Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is\n enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target\n tracking configurations.

\n

The default is enabled (false).

" } }, - "PredictiveScalingMode": { - "target": "com.amazonaws.autoscalingplans#PredictiveScalingMode", + "ScalableDimension": { + "target": "com.amazonaws.autoscalingplans#ScalableDimension", "traits": { - "smithy.api#documentation": "

The predictive scaling mode. The default value is ForecastAndScale.\n Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions\n based on the capacity forecast.

" + "smithy.api#documentation": "

The scalable dimension associated with the resource.

\n ", + "smithy.api#required": {} } }, - "MaxCapacity": { - "target": "com.amazonaws.autoscalingplans#ResourceCapacity", + "ScalingPolicyUpdateBehavior": { + "target": "com.amazonaws.autoscalingplans#ScalingPolicyUpdateBehavior", "traits": { - "smithy.api#documentation": "

The maximum capacity of the resource. The exception to this upper limit is if you\n specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Controls whether a resource's externally created scaling policies are kept or replaced.

\n

The default value is KeepExternalPolicies. If the parameter is set to\n ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling\n are deleted and new target tracking scaling policies created.

\n

Only valid when configuring dynamic scaling.

\n

Condition: The number of existing policies to be replaced must be less than or equal to\n 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies\n and does not create new ones.

" } } }, @@ -1110,25 +1110,22 @@ "smithy.api#required": {} } }, - "ScalingPlanVersion": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", + "StatusStartTime": { + "target": "com.amazonaws.autoscalingplans#TimestampType", "traits": { - "smithy.api#documentation": "

The version number of the scaling plan.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Unix time stamp when the scaling plan entered the current status.

" } }, - "ScalingPlanName": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanName", + "StatusMessage": { + "target": "com.amazonaws.autoscalingplans#XmlString", "traits": { - "smithy.api#documentation": "

The name of the scaling plan.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A simple message about the current status of the scaling plan.

" } }, - "ApplicationSource": { - "target": "com.amazonaws.autoscalingplans#ApplicationSource", + "CreationTime": { + "target": "com.amazonaws.autoscalingplans#TimestampType", "traits": { - "smithy.api#documentation": "

The application source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Unix time stamp when the scaling plan was created.

" } }, "StatusCode": { @@ -1138,22 +1135,25 @@ "smithy.api#required": {} } }, - "StatusStartTime": { - "target": "com.amazonaws.autoscalingplans#TimestampType", + "ScalingPlanName": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanName", "traits": { - "smithy.api#documentation": "

The Unix time stamp when the scaling plan entered the current status.

" + "smithy.api#documentation": "

The name of the scaling plan.

", + "smithy.api#required": {} } }, - "StatusMessage": { - "target": "com.amazonaws.autoscalingplans#XmlString", + "ApplicationSource": { + "target": "com.amazonaws.autoscalingplans#ApplicationSource", "traits": { - "smithy.api#documentation": "

A simple message about the current status of the scaling plan.

" + "smithy.api#documentation": "

The application source.

", + "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.autoscalingplans#TimestampType", + "ScalingPlanVersion": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", "traits": { - "smithy.api#documentation": "

The Unix time stamp when the scaling plan was created.

" + "smithy.api#documentation": "

The version number of the scaling plan.

", + "smithy.api#required": {} } } }, @@ -1180,11 +1180,10 @@ "com.amazonaws.autoscalingplans#ScalingPlanResource": { "type": "structure", "members": { - "ScalingPlanName": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanName", + "ScalingPolicies": { + "target": "com.amazonaws.autoscalingplans#ScalingPolicies", "traits": { - "smithy.api#documentation": "

The name of the scaling plan.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The scaling policies.

" } }, "ScalingStatusMessage": { @@ -1193,24 +1192,24 @@ "smithy.api#documentation": "

A simple message about the current scaling status of the resource.

" } }, - "ResourceId": { - "target": "com.amazonaws.autoscalingplans#ResourceIdMaxLen1600", + "ScalingStatusCode": { + "target": "com.amazonaws.autoscalingplans#ScalingStatusCode", "traits": { - "smithy.api#documentation": "

The ID of the resource. This string consists of the resource type and unique\n identifier.

\n ", + "smithy.api#documentation": "

The scaling status of the resource.

\n ", "smithy.api#required": {} } }, - "ServiceNamespace": { - "target": "com.amazonaws.autoscalingplans#ServiceNamespace", + "ScalingPlanName": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanName", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service.

", + "smithy.api#documentation": "

The name of the scaling plan.

", "smithy.api#required": {} } }, - "ScalingPlanVersion": { - "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", + "ResourceId": { + "target": "com.amazonaws.autoscalingplans#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The version number of the scaling plan.

", + "smithy.api#documentation": "

The ID of the resource. This string consists of the resource type and unique\n identifier.

\n ", "smithy.api#required": {} } }, @@ -1221,17 +1220,18 @@ "smithy.api#required": {} } }, - "ScalingStatusCode": { - "target": "com.amazonaws.autoscalingplans#ScalingStatusCode", + "ServiceNamespace": { + "target": "com.amazonaws.autoscalingplans#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The scaling status of the resource.

\n ", + "smithy.api#documentation": "

The namespace of the AWS service.

", "smithy.api#required": {} } }, - "ScalingPolicies": { - "target": "com.amazonaws.autoscalingplans#ScalingPolicies", + "ScalingPlanVersion": { + "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", "traits": { - "smithy.api#documentation": "

The scaling policies.

" + "smithy.api#documentation": "

The version number of the scaling plan.

", + "smithy.api#required": {} } } }, @@ -1305,6 +1305,13 @@ "com.amazonaws.autoscalingplans#ScalingPolicy": { "type": "structure", "members": { + "PolicyType": { + "target": "com.amazonaws.autoscalingplans#PolicyType", + "traits": { + "smithy.api#documentation": "

The type of scaling policy.

", + "smithy.api#required": {} + } + }, "TargetTrackingConfiguration": { "target": "com.amazonaws.autoscalingplans#TargetTrackingConfiguration", "traits": { @@ -1317,13 +1324,6 @@ "smithy.api#documentation": "

The name of the scaling policy.

", "smithy.api#required": {} } - }, - "PolicyType": { - "target": "com.amazonaws.autoscalingplans#PolicyType", - "traits": { - "smithy.api#documentation": "

The type of scaling policy.

", - "smithy.api#required": {} - } } }, "traits": { @@ -1435,16 +1435,16 @@ "com.amazonaws.autoscalingplans#TargetTrackingConfiguration": { "type": "structure", "members": { - "ScaleOutCooldown": { + "EstimatedInstanceWarmup": { "target": "com.amazonaws.autoscalingplans#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale-out activity completes before another\n scale-out activity can start. This value is not used if the scalable resource is an Auto\n Scaling group.

\n

While the cooldown period is in effect, the capacity that has been added by the previous\n scale-out event that initiated the cooldown is calculated as part of the desired capacity\n for the next scale out. The intention is to continuously (but not excessively) scale\n out.

" + "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

" } }, - "EstimatedInstanceWarmup": { + "ScaleOutCooldown": { "target": "com.amazonaws.autoscalingplans#Cooldown", "traits": { - "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale-out activity completes before another\n scale-out activity can start. This value is not used if the scalable resource is an Auto\n Scaling group.

\n

While the cooldown period is in effect, the capacity that has been added by the previous\n scale-out event that initiated the cooldown is calculated as part of the desired capacity\n for the next scale out. The intention is to continuously (but not excessively) scale\n out.

" } }, "TargetValue": { @@ -1454,10 +1454,10 @@ "smithy.api#required": {} } }, - "DisableScaleIn": { - "target": "com.amazonaws.autoscalingplans#DisableScaleIn", + "CustomizedScalingMetricSpecification": { + "target": "com.amazonaws.autoscalingplans#CustomizedScalingMetricSpecification", "traits": { - "smithy.api#documentation": "

Indicates whether scale in by the target tracking scaling policy is disabled. If the\n value is true, scale in is disabled and the target tracking scaling policy\n doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the\n target tracking scaling policy can remove capacity from the scalable resource.

\n

The default value is false.

" + "smithy.api#documentation": "

A customized metric. You can specify either a predefined metric or a customized metric.\n

" } }, "ScaleInCooldown": { @@ -1466,10 +1466,10 @@ "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another scale\n in activity can start. This value is not used if the scalable resource is an Auto Scaling\n group.

\n

The cooldown period is used to block subsequent scale in requests until it has expired.\n The intention is to scale in conservatively to protect your application's availability.\n However, if another alarm triggers a scale-out policy during the cooldown period after a\n scale-in, AWS Auto Scaling scales out your scalable target immediately.

" } }, - "CustomizedScalingMetricSpecification": { - "target": "com.amazonaws.autoscalingplans#CustomizedScalingMetricSpecification", + "DisableScaleIn": { + "target": "com.amazonaws.autoscalingplans#DisableScaleIn", "traits": { - "smithy.api#documentation": "

A customized metric. You can specify either a predefined metric or a customized metric.\n

" + "smithy.api#documentation": "

Indicates whether scale in by the target tracking scaling policy is disabled. If the\n value is true, scale in is disabled and the target tracking scaling policy\n doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the\n target tracking scaling policy can remove capacity from the scalable resource.

\n

The default value is false.

" } }, "PredefinedScalingMetricSpecification": { @@ -1521,12 +1521,6 @@ "com.amazonaws.autoscalingplans#UpdateScalingPlanRequest": { "type": "structure", "members": { - "ScalingInstructions": { - "target": "com.amazonaws.autoscalingplans#ScalingInstructions", - "traits": { - "smithy.api#documentation": "

The scaling instructions.

" - } - }, "ScalingPlanVersion": { "target": "com.amazonaws.autoscalingplans#ScalingPlanVersion", "traits": { @@ -1546,6 +1540,12 @@ "traits": { "smithy.api#documentation": "

A CloudFormation stack or set of tags.

" } + }, + "ScalingInstructions": { + "target": "com.amazonaws.autoscalingplans#ScalingInstructions", + "traits": { + "smithy.api#documentation": "

The scaling instructions.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json index 1c5e1ca1a96f..ccb579dcbb8d 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json @@ -51,18 +51,18 @@ "com.amazonaws.autoscaling#ActivitiesType": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + }, "Activities": { "target": "com.amazonaws.autoscaling#Activities", "traits": { "smithy.api#documentation": "

The scaling activities. Activities are sorted by start time. Activities still in\n progress are described first.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } } } }, @@ -76,16 +76,31 @@ "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "Cause": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

The end time of the activity.

" + "smithy.api#documentation": "

The reason the activity began.

", + "smithy.api#required": {} } }, - "StatusMessage": { + "ActivityId": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The ID of the activity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A friendly, more verbose description of the activity.

" + } + }, + "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

A friendly, more verbose description of the activity status.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} } }, "StatusCode": { @@ -95,10 +110,10 @@ "smithy.api#required": {} } }, - "Details": { - "target": "com.amazonaws.autoscaling#XmlString", + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The details about the activity.

" + "smithy.api#documentation": "

The end time of the activity.

" } }, "Progress": { @@ -107,31 +122,16 @@ "smithy.api#documentation": "

A value between 0 and 100 that indicates the progress of the activity.

" } }, - "Cause": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

The reason the activity began.

", - "smithy.api#required": {} - } - }, - "Description": { + "Details": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

A friendly, more verbose description of the activity.

" + "smithy.api#documentation": "

The details about the activity.

" } }, - "AutoScalingGroupName": { + "StatusMessage": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ActivityId": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The ID of the activity.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A friendly, more verbose description of the activity status.

" } } }, @@ -179,17 +179,17 @@ "com.amazonaws.autoscaling#Alarm": { "type": "structure", "members": { - "AlarmARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" - } - }, "AlarmName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "

The name of the alarm.

" } + }, + "AlarmARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" + } } }, "traits": { @@ -296,17 +296,17 @@ "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType": { "type": "structure", "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.

", "smithy.api#required": {} } }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.

", + "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } } @@ -339,17 +339,17 @@ "com.amazonaws.autoscaling#AttachLoadBalancersType": { "type": "structure", "members": { - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", + "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", "smithy.api#required": {} } } @@ -358,22 +358,29 @@ "com.amazonaws.autoscaling#AutoScalingGroup": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.autoscaling#TagDescriptionList", + "CreatedTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The tags for the group.

" + "smithy.api#documentation": "

The date and time the group was created.

", + "smithy.api#required": {} } }, - "EnabledMetrics": { - "target": "com.amazonaws.autoscaling#EnabledMetrics", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The metrics enabled for the group.

" + "smithy.api#documentation": "

The name of the associated launch configuration.

" } }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { - "smithy.api#documentation": "

One or more subnet IDs, if applicable, separated by commas.

" + "smithy.api#documentation": "

One or more load balancers associated with the group.

" + } + }, + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service.

\n

Valid Range: Minimum value of 0.

" } }, "MixedInstancesPolicy": { @@ -382,17 +389,35 @@ "smithy.api#documentation": "

The mixed instances policy for the group.

" } }, - "HealthCheckType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. If you configure an Auto Scaling group to use ELB health checks, it\n considers the instance unhealthy if it fails either the EC2 status checks or the load\n balancer health checks.

", + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups for your load balancer.

" + } + }, + "Instances": { + "target": "com.amazonaws.autoscaling#Instances", + "traits": { + "smithy.api#documentation": "

The EC2 instances associated with the group.

" + } + }, + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

The duration of the default cooldown period, in seconds.

", "smithy.api#required": {} } }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "Tags": { + "target": "com.amazonaws.autoscaling#TagDescriptionList", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service.

\n

Valid Range: Minimum value of 0.

" + "smithy.api#documentation": "

The tags for the group.

" + } + }, + "HealthCheckGracePeriod": { + "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service.

" } }, "SuspendedProcesses": { @@ -408,23 +433,10 @@ "smithy.api#required": {} } }, - "ServiceLinkedRoleARN": { + "AutoScalingGroupARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf.

" - } - }, - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", - "traits": { - "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time the group was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling group.

" } }, "MaxSize": { @@ -434,37 +446,28 @@ "smithy.api#required": {} } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", "traits": { - "smithy.api#documentation": "

The launch template for the group.

" + "smithy.api#documentation": "

One or more subnet IDs, if applicable, separated by commas.

" } }, - "PlacementGroup": { + "Status": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any.

" - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired size of the group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.

" } }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "PlacementGroup": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The minimum size of the group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any.

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The launch template for the group.

" } }, "TerminationPolicies": { @@ -473,53 +476,50 @@ "smithy.api#documentation": "

The termination policies for the group.

" } }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups for your load balancer.

" - } - }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "HealthCheckType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The name of the associated launch configuration.

" + "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. If you configure an Auto Scaling group to use ELB health checks, it\n considers the instance unhealthy if it fails either the EC2 status checks or the load\n balancer health checks.

", + "smithy.api#required": {} } }, - "AutoScalingGroupARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling group.

" + "smithy.api#documentation": "

The desired size of the group.

", + "smithy.api#required": {} } }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "

One or more load balancers associated with the group.

" + "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

" } }, - "Status": { + "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} } }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service.

" + "smithy.api#documentation": "

The minimum size of the group.

", + "smithy.api#required": {} } }, - "DefaultCooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The duration of the default cooldown period, in seconds.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf.

" } }, - "Instances": { - "target": "com.amazonaws.autoscaling#Instances", + "EnabledMetrics": { + "target": "com.amazonaws.autoscaling#EnabledMetrics", "traits": { - "smithy.api#documentation": "

The EC2 instances associated with the group.

" + "smithy.api#documentation": "

The metrics enabled for the group.

" } } }, @@ -560,17 +560,17 @@ "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" } }, - "AutoScalingGroupNames": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", - "traits": { - "smithy.api#documentation": "

The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By\n default, you can only specify up to 50 names. You can optionally increase this limit\n using the MaxRecords parameter.

\n

If you omit this parameter, all Auto Scaling groups are described.

" - } - }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" } + }, + "AutoScalingGroupNames": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", + "traits": { + "smithy.api#documentation": "

The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By\n default, you can only specify up to 50 names. You can optionally increase this limit\n using the MaxRecords parameter.

\n

If you omit this parameter, all Auto Scaling groups are described.

" + } } } }, @@ -583,69 +583,67 @@ "com.amazonaws.autoscaling#AutoScalingGroupsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - }, "AutoScalingGroups": { "target": "com.amazonaws.autoscaling#AutoScalingGroups", "traits": { "smithy.api#documentation": "

The groups.

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } } } }, "com.amazonaws.autoscaling#AutoScalingInstanceDetails": { "type": "structure", "members": { - "ProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The launch template for the instance.

" } }, - "HealthStatus": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The last reported health status of this instance. \"Healthy\" means that the instance is\n healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy\n and Amazon EC2 Auto Scaling should terminate and replace it.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The launch configuration used to launch the instance. This value is not available if\n you attached the instance to the Auto Scaling group.

" } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The instance type of the EC2 instance.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#documentation": "

The name of the Auto Scaling group for the instance.

", "smithy.api#required": {} } }, - "LifecycleState": { + "HealthStatus": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The lifecycle state for the instance.

", + "smithy.api#documentation": "

The last reported health status of this instance. \"Healthy\" means that the instance is\n healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy\n and Amazon EC2 Auto Scaling should terminate and replace it.

", "smithy.api#required": {} } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template for the instance.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "ProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group for the instance.

", + "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", "smithy.api#required": {} } }, - "AvailabilityZone": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "LifecycleState": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The Availability Zone for the instance.

", + "smithy.api#documentation": "

The lifecycle state for the instance.

", "smithy.api#required": {} } }, @@ -655,16 +653,18 @@ "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" } }, - "InstanceType": { + "AvailabilityZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The instance type of the EC2 instance.

" + "smithy.api#documentation": "

The Availability Zone for the instance.

", + "smithy.api#required": {} } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "

The launch configuration used to launch the instance. This value is not available if\n you attached the instance to the Auto Scaling group.

" + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} } } }, @@ -681,17 +681,17 @@ "com.amazonaws.autoscaling#AutoScalingInstancesType": { "type": "structure", "members": { - "AutoScalingInstances": { - "target": "com.amazonaws.autoscaling#AutoScalingInstances", - "traits": { - "smithy.api#documentation": "

The instances.

" - } - }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" } + }, + "AutoScalingInstances": { + "target": "com.amazonaws.autoscaling#AutoScalingInstances", + "traits": { + "smithy.api#documentation": "

The instances.

" + } } } }, @@ -882,7 +882,7 @@ "sdkId": "Auto Scaling", "arnNamespace": "autoscaling", "cloudFormationName": "AutoScaling", - "cloudTrailEventSource": "version_2011_01_01.csls.fws.amazon.com" + "cloudTrailEventSource": "autoscaling.amazonaws.com" }, "aws.auth#sigv4": { "name": "autoscaling" @@ -937,17 +937,17 @@ "com.amazonaws.autoscaling#BatchDeleteScheduledActionType": { "type": "structure", "members": { - "ScheduledActionNames": { - "target": "com.amazonaws.autoscaling#ScheduledActionNames", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The names of the scheduled actions to delete. The maximum number allowed is 50.\n

", + "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "ScheduledActionNames": { + "target": "com.amazonaws.autoscaling#ScheduledActionNames", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#documentation": "

The names of the scheduled actions to delete. The maximum number allowed is 50.\n

", "smithy.api#required": {} } } @@ -1050,22 +1050,16 @@ "com.amazonaws.autoscaling#BlockDeviceMapping": { "type": "structure", "members": { - "VirtualName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the virtual device (for example, ephemeral0).

\n

You can specify either VirtualName or Ebs, but not\n both.

" - } - }, "NoDevice": { "target": "com.amazonaws.autoscaling#NoDevice", "traits": { "smithy.api#documentation": "

Setting this value to true suppresses the specified device included in\n the block device mapping of the AMI.

\n

If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

\n

If you specify NoDevice, you cannot specify Ebs.

" } }, - "Ebs": { - "target": "com.amazonaws.autoscaling#Ebs", + "VirtualName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when an instance is\n launched.

\n

You can specify either VirtualName or Ebs, but not\n both.

" + "smithy.api#documentation": "

The name of the virtual device (for example, ephemeral0).

\n

You can specify either VirtualName or Ebs, but not\n both.

" } }, "DeviceName": { @@ -1074,6 +1068,12 @@ "smithy.api#documentation": "

The device name exposed to the EC2 instance (for example, /dev/sdh or\n xvdh). For more information, see Device Naming on Linux\n Instances in the Amazon EC2 User Guide for Linux\n Instances.

", "smithy.api#required": {} } + }, + "Ebs": { + "target": "com.amazonaws.autoscaling#Ebs", + "traits": { + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when an instance is\n launched.

\n

You can specify either VirtualName or Ebs, but not\n both.

" + } } }, "traits": { @@ -1162,24 +1162,23 @@ "com.amazonaws.autoscaling#CompleteLifecycleActionType": { "type": "structure", "members": { - "LifecycleActionToken": { - "target": "com.amazonaws.autoscaling#LifecycleActionToken", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

A universally unique identifier (UUID) that identifies a specific lifecycle action\n associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you\n specified when you created the lifecycle hook.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} } }, - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the instance.

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "LifecycleActionToken": { + "target": "com.amazonaws.autoscaling#LifecycleActionToken", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A universally unique identifier (UUID) that identifies a specific lifecycle action\n associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you\n specified when you created the lifecycle hook.

" } }, "LifecycleActionResult": { @@ -1189,10 +1188,11 @@ "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the instance.

" + "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#required": {} } } } @@ -1229,115 +1229,115 @@ "com.amazonaws.autoscaling#CreateAutoScalingGroupType": { "type": "structure", "members": { - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The minimum size of the group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more\n information, see Service-Linked\n Roles in the Amazon EC2 Auto Scaling User Guide.

" } }, - "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

The maximum size of the group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n ", + "smithy.api#required": {} } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { - "smithy.api#documentation": "

Parameters used to specify the launch template and version to use when an instance is\n launched.

\n

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API\n Reference.

\n

You can alternatively associate a launch template to the Auto Scaling group by using the\n MixedInstancesPolicy parameter.

\n

You must specify one of the following parameters in your request:\n LaunchConfigurationName, LaunchTemplate,\n InstanceId, or MixedInstancesPolicy.

" + "smithy.api#documentation": "

A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load\n Balancers and Network Load Balancers, specify a list of target groups using the\n TargetGroupARNs property instead.

\n

For more information, see Using a Load Balancer\n with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" } }, - "Tags": { - "target": "com.amazonaws.autoscaling#Tags", + "LifecycleHookSpecificationList": { + "target": "com.amazonaws.autoscaling#LifecycleHookSpecifications", "traits": { - "smithy.api#documentation": "

One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches.

\n

Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the\n tags in a launch template but use caution. If the launch template specifies an instance\n tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value\n of that instance tag with the value specified by the Auto Scaling group.

\n

For more information, see Tagging Auto Scaling Groups and\n Instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

One or more lifecycle hooks.

" } }, - "TerminationPolicies": { - "target": "com.amazonaws.autoscaling#TerminationPolicies", + "AvailabilityZones": { + "target": "com.amazonaws.autoscaling#AvailabilityZones", "traits": { - "smithy.api#documentation": "

One or more termination policies used to select the instance to terminate. These\n policies are executed in the order that they are listed.

\n

For more information, see Controlling Which\n Instances Auto Scaling Terminates During Scale In in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

One or more Availability Zones for the group. This parameter is optional if you\n specify one or more subnets for VPCZoneIdentifier.

\n

Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into EC2-Classic.

" } }, - "HealthCheckType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. The default value is EC2. If you configure an Auto Scaling\n group to use ELB health checks, it considers the instance unhealthy if it fails either\n the EC2 status checks or the load balancer health checks.

\n

For more information, see Health Checks for Auto Scaling\n Instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

\n

For more information about preventing instances from terminating on scale in, see\n Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" } }, - "DefaultCooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300.

\n

This setting applies when using simple scaling policies, but not when using other\n scaling policies or scheduled scaling. For more information, see Scaling Cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The ID of the instance used to create a launch configuration for the group. To get the\n instance ID, use the Amazon EC2 DescribeInstances API operation.

\n

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and\n associates it with the group. This launch configuration derives its attributes from the\n specified instance, except for the block device mapping.

\n

You must specify one of the following parameters in your request:\n LaunchConfigurationName, LaunchTemplate,\n InstanceId, or MixedInstancesPolicy.

" } }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group at the time of its\n creation and the capacity it attempts to maintain. It can scale beyond this capacity if\n you configure automatic scaling.

\n

This number must be greater than or equal to the minimum size of the group and less\n than or equal to the maximum size of the group. If you do not specify a desired\n capacity, the default is the minimum size of the group.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.\n Instances are registered as targets in a target group, and traffic is routed to the\n target group.

\n

For more information, see Using a Load Balancer\n with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" } }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. During this time, any health check\n failures for the instance are ignored. The default value is 0.

\n

For more information, see Health\n Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

A comma-separated list of subnet IDs for your virtual private cloud (VPC).

\n

If you specify VPCZoneIdentifier with AvailabilityZones, the\n subnets that you specify for this parameter must reside in those Availability\n Zones.

\n

Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into a VPC.

" } }, - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { - "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

\n

For more information about preventing instances from terminating on scale in, see\n Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null.

\n

This parameter is optional, but if you specify a value for it, you must specify a\n value of at least 604,800 seconds (7 days). To clear a previously set value, specify a\n new value of 0.

\n

For more information, see Replacing Auto Scaling\n Instances Based on Maximum Instance Lifetime in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group. This name must be unique per Region per account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the launch configuration to use when an instance is launched. To get the\n launch configuration name, use the DescribeLaunchConfigurations API\n operation. New launch configurations can be created with the CreateLaunchConfiguration API.

\n

You must specify one of the following parameters in your request:\n LaunchConfigurationName, LaunchTemplate,\n InstanceId, or MixedInstancesPolicy.

" } }, - "ServiceLinkedRoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "TerminationPolicies": { + "target": "com.amazonaws.autoscaling#TerminationPolicies", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more\n information, see Service-Linked\n Roles in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

One or more termination policies used to select the instance to terminate. These\n policies are executed in the order that they are listed.

\n

For more information, see Controlling Which\n Instances Auto Scaling Terminates During Scale In in the\n Amazon EC2 Auto Scaling User Guide.

" } }, - "AvailabilityZones": { - "target": "com.amazonaws.autoscaling#AvailabilityZones", + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

One or more Availability Zones for the group. This parameter is optional if you\n specify one or more subnets for VPCZoneIdentifier.

\n

Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into EC2-Classic.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300.

\n

This setting applies when using simple scaling policies, but not when using other\n scaling policies or scheduled scaling. For more information, see Scaling Cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "HealthCheckType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The name of the launch configuration to use when an instance is launched. To get the\n launch configuration name, use the DescribeLaunchConfigurations API\n operation. New launch configurations can be created with the CreateLaunchConfiguration API.

\n

You must specify one of the following parameters in your request:\n LaunchConfigurationName, LaunchTemplate,\n InstanceId, or MixedInstancesPolicy.

" + "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. The default value is EC2. If you configure an Auto Scaling\n group to use ELB health checks, it considers the instance unhealthy if it fails either\n the EC2 status checks or the load balancer health checks.

\n

For more information, see Health Checks for Auto Scaling\n Instances in the Amazon EC2 Auto Scaling User Guide.

" } }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load\n Balancers and Network Load Balancers, specify a list of target groups using the\n TargetGroupARNs property instead.

\n

For more information, see Using a Load Balancer\n with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The name of the Auto Scaling group. This name must be unique per Region per account.

", + "smithy.api#required": {} } }, - "LifecycleHookSpecificationList": { - "target": "com.amazonaws.autoscaling#LifecycleHookSpecifications", + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { - "smithy.api#documentation": "

One or more lifecycle hooks.

" + "smithy.api#documentation": "

The minimum size of the group.

", + "smithy.api#required": {} } }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "Tags": { + "target": "com.amazonaws.autoscaling#Tags", "traits": { - "smithy.api#documentation": "

The maximum size of the group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches.

\n

Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the\n tags in a launch template but use caution. If the launch template specifies an instance\n tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value\n of that instance tag with the value specified by the Auto Scaling group.

\n

For more information, see Tagging Auto Scaling Groups and\n Instances in the Amazon EC2 Auto Scaling User Guide.

" } }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "HealthCheckGracePeriod": { + "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null.

\n

This parameter is optional, but if you specify a value for it, you must specify a\n value of at least 604,800 seconds (7 days). To clear a previously set value, specify a\n new value of 0.

\n

For more information, see Replacing Auto Scaling\n Instances Based on Maximum Instance Lifetime in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. During this time, any health check\n failures for the instance are ignored. The default value is 0.

\n

For more information, see Health\n Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

" } }, "MixedInstancesPolicy": { @@ -1346,22 +1346,22 @@ "smithy.api#documentation": "

An embedded object that specifies a mixed instances policy. The required parameters\n must be specified. If optional parameters are unspecified, their default values are\n used.

\n

The policy includes parameters that not only define the distribution of On-Demand\n Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the\n Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the\n parameters that specify the instance configuration information—the launch template and\n instance types.

\n \n

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and\n Auto Scaling Groups with Multiple\n Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.

\n

You must specify one of the following parameters in your request:\n LaunchConfigurationName, LaunchTemplate,\n InstanceId, or MixedInstancesPolicy.

" } }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", + "PlacementGroup": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

A comma-separated list of subnet IDs for your virtual private cloud (VPC).

\n

If you specify VPCZoneIdentifier with AvailabilityZones, the\n subnets that you specify for this parameter must reside in those Availability\n Zones.

\n

Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into a VPC.

" + "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "

The ID of the instance used to create a launch configuration for the group. To get the\n instance ID, use the Amazon EC2 DescribeInstances API operation.

\n

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and\n associates it with the group. This launch configuration derives its attributes from the\n specified instance, except for the block device mapping.

\n

You must specify one of the following parameters in your request:\n LaunchConfigurationName, LaunchTemplate,\n InstanceId, or MixedInstancesPolicy.

" + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group at the time of its\n creation and the capacity it attempts to maintain. It can scale beyond this capacity if\n you configure automatic scaling.

\n

This number must be greater than or equal to the minimum size of the group and less\n than or equal to the maximum size of the group. If you do not specify a desired\n capacity, the default is the minimum size of the group.

" } }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.\n Instances are registered as targets in a target group, and traffic is routed to the\n target group.

\n

For more information, see Using a Load Balancer\n with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Parameters used to specify the launch template and version to use when an instance is\n launched.

\n

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API\n Reference.

\n

You can alternatively associate a launch template to the Auto Scaling group by using the\n MixedInstancesPolicy parameter.

\n

You must specify one of the following parameters in your request:\n LaunchConfigurationName, LaunchTemplate,\n InstanceId, or MixedInstancesPolicy.

" } } } @@ -1385,38 +1385,26 @@ "traits": { "smithy.api#documentation": "

Creates a launch configuration.

\n

If you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Amazon EC2 Auto Scaling Service\n Quotas in the Amazon EC2 Auto Scaling User Guide.

\n

For more information, see Launch\n Configurations in the Amazon EC2 Auto Scaling User Guide.

" } - }, - "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { - "type": "structure", - "members": { - "IamInstanceProfile": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", - "traits": { - "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.

\n

For more information, see IAM Role for Applications That Run\n on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "RamdiskId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of the RAM disk to select.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.autoscaling#BlockDeviceMappings", + }, + "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "

A block device mapping, which specifies the block devices for the instance. You can\n specify virtual devices and EBS volumes. For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.

" + "smithy.api#documentation": "

The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.

\n

To create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.

\n

For more information, see Create a Launch\n Configuration Using an EC2 Instance in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you do not specify InstanceId, you must specify both\n ImageId and InstanceType.

" } }, - "KernelId": { + "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

" + "smithy.api#documentation": "

Specifies the instance type of the EC2 instance.

\n

For information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n

\n

If you do not specify InstanceId, you must specify\n InstanceType.

" } }, - "MetadataOptions": { - "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", + "AssociatePublicIpAddress": { + "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", "traits": { - "smithy.api#documentation": "

The metadata options for the instances. For more information, see Instance Metadata and User Data in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether\n to assign a public IP address to the group's instances. If you specify\n true, each instance in the Auto Scaling group receives a unique public IP address.\n For more information, see Launching Auto Scaling Instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify this parameter, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n \n

If the instance is launched into a default subnet, the default is to assign a\n public IP address, unless you disabled the option to assign a public IP address on\n the subnet. If the instance is launched into a nondefault subnet, the default is not\n to assign a public IP address, unless you enabled the option to assign a public IP\n address on the subnet.

\n " } }, "EbsOptimized": { @@ -1425,40 +1413,34 @@ "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-Optimized\n Instances in the Amazon EC2 User Guide for Linux\n Instances.

\n

The default value is false.

" } }, - "ClassicLinkVPCId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

This parameter can only be used if you are launching EC2-Classic instances.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "InstanceMonitoring": { + "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "

The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.

\n

To create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.

\n

For more information, see Create a Launch\n Configuration Using an EC2 Instance in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you do not specify InstanceId, you must specify both\n ImageId and InstanceType.

" + "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

The default value is true (enabled).

\n \n

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

\n " } }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", + "PlacementTenancy": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "

For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether\n to assign a public IP address to the group's instances. If you specify\n true, each instance in the Auto Scaling group receives a unique public IP address.\n For more information, see Launching Auto Scaling Instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify this parameter, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n \n

If the instance is launched into a default subnet, the default is to assign a\n public IP address, unless you disabled the option to assign a public IP address on\n the subnet. If the instance is launched into a nondefault subnet, the default is not\n to assign a public IP address, unless you enabled the option to assign a public IP\n address on the subnet.

\n " + "smithy.api#documentation": "

The tenancy of the instance. An instance with dedicated tenancy runs on\n isolated, single-tenant hardware and can only be launched into a VPC.

\n

To launch dedicated instances into a shared tenancy VPC (a VPC with the instance\n placement tenancy attribute set to default), you must set the value of this\n parameter to dedicated.

\n

If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n

For more information, see Instance Placement\n Tenancy in the Amazon EC2 Auto Scaling User Guide.

\n

Valid Values: default | dedicated\n

" } }, - "ClassicLinkVPCSecurityGroups": { - "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", + "SpotPrice": { + "target": "com.amazonaws.autoscaling#SpotPrice", "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify the ClassicLinkVPCId parameter, you must specify this\n parameter.

" + "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Launching Spot\n Instances in Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

When you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.

\n " } }, - "PlacementTenancy": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "RamdiskId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The tenancy of the instance. An instance with dedicated tenancy runs on\n isolated, single-tenant hardware and can only be launched into a VPC.

\n

To launch dedicated instances into a shared tenancy VPC (a VPC with the instance\n placement tenancy attribute set to default), you must set the value of this\n parameter to dedicated.

\n

If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n

For more information, see Instance Placement\n Tenancy in the Amazon EC2 Auto Scaling User Guide.

\n

Valid Values: default | dedicated\n

" + "smithy.api#documentation": "

The ID of the RAM disk to select.

" } }, - "SecurityGroups": { - "target": "com.amazonaws.autoscaling#SecurityGroups", + "MetadataOptions": { + "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", "traits": { - "smithy.api#documentation": "

A list that contains the security groups to assign to the instances in the Auto Scaling\n group.

\n

[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud\n User Guide.

\n

[EC2-Classic] Specify either the security group names or the security group IDs. For\n more information, see Amazon EC2 Security\n Groups in the Amazon EC2 User Guide for Linux\n Instances.

" + "smithy.api#documentation": "

The metadata options for the instances. For more information, see Instance Metadata and User Data in the\n Amazon EC2 User Guide for Linux Instances.

" } }, "LaunchConfigurationName": { @@ -1468,16 +1450,28 @@ "smithy.api#required": {} } }, - "SpotPrice": { - "target": "com.amazonaws.autoscaling#SpotPrice", + "ImageId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Launching Spot\n Instances in Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

When you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.

\n " + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you do not specify InstanceId, you must specify\n ImageId.

" } }, - "UserData": { - "target": "com.amazonaws.autoscaling#XmlStringUserData", + "BlockDeviceMappings": { + "target": "com.amazonaws.autoscaling#BlockDeviceMappings", "traits": { - "smithy.api#documentation": "

The Base64-encoded user data to make available to the launched EC2 instances. For more\n information, see Instance Metadata and User\n Data in the Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

A block device mapping, which specifies the block devices for the instance. You can\n specify virtual devices and EBS volumes. For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", + "traits": { + "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.

\n

For more information, see IAM Role for Applications That Run\n on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "ClassicLinkVPCId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

This parameter can only be used if you are launching EC2-Classic instances.

" } }, "KeyName": { @@ -1486,22 +1480,28 @@ "smithy.api#documentation": "

The name of the key pair. For more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.

" } }, - "ImageId": { + "UserData": { + "target": "com.amazonaws.autoscaling#XmlStringUserData", + "traits": { + "smithy.api#documentation": "

The Base64-encoded user data to make available to the launched EC2 instances. For more\n information, see Instance Metadata and User\n Data in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "KernelId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you do not specify InstanceId, you must specify\n ImageId.

" + "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

" } }, - "InstanceMonitoring": { - "target": "com.amazonaws.autoscaling#InstanceMonitoring", + "ClassicLinkVPCSecurityGroups": { + "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

The default value is true (enabled).

\n \n

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

\n " + "smithy.api#documentation": "

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify the ClassicLinkVPCId parameter, you must specify this\n parameter.

" } }, - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "SecurityGroups": { + "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "

Specifies the instance type of the EC2 instance.

\n

For information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n

\n

If you do not specify InstanceId, you must specify\n InstanceType.

" + "smithy.api#documentation": "

A list that contains the security groups to assign to the instances in the Auto Scaling\n group.

\n

[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud\n User Guide.

\n

[EC2-Classic] Specify either the security group names or the security group IDs. For\n more information, see Amazon EC2 Security\n Groups in the Amazon EC2 User Guide for Linux\n Instances.

" } } } @@ -1544,37 +1544,37 @@ "com.amazonaws.autoscaling#CustomizedMetricSpecification": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.autoscaling#MetricNamespace", + "Statistic": { + "target": "com.amazonaws.autoscaling#MetricStatistic", "traits": { - "smithy.api#documentation": "

The namespace of the metric.

", + "smithy.api#documentation": "

The statistic of the metric.

", "smithy.api#required": {} } }, - "Dimensions": { - "target": "com.amazonaws.autoscaling#MetricDimensions", + "MetricName": { + "target": "com.amazonaws.autoscaling#MetricName", "traits": { - "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" + "smithy.api#documentation": "

The name of the metric.

", + "smithy.api#required": {} } }, - "Unit": { - "target": "com.amazonaws.autoscaling#MetricUnit", + "Dimensions": { + "target": "com.amazonaws.autoscaling#MetricDimensions", "traits": { - "smithy.api#documentation": "

The unit of the metric.

" + "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" } }, - "Statistic": { - "target": "com.amazonaws.autoscaling#MetricStatistic", + "Namespace": { + "target": "com.amazonaws.autoscaling#MetricNamespace", "traits": { - "smithy.api#documentation": "

The statistic of the metric.

", + "smithy.api#documentation": "

The namespace of the metric.

", "smithy.api#required": {} } }, - "MetricName": { - "target": "com.amazonaws.autoscaling#MetricName", + "Unit": { + "target": "com.amazonaws.autoscaling#MetricUnit", "traits": { - "smithy.api#documentation": "

The name of the metric.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unit of the metric.

" } } }, @@ -1605,18 +1605,18 @@ "com.amazonaws.autoscaling#DeleteAutoScalingGroupType": { "type": "structure", "members": { + "ForceDelete": { + "target": "com.amazonaws.autoscaling#ForceDelete", + "traits": { + "smithy.api#documentation": "

Specifies that the group is to be deleted along with all instances associated with the\n group, without waiting for all instances to be terminated. This parameter also deletes\n any lifecycle actions associated with the group.

" + } + }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } - }, - "ForceDelete": { - "target": "com.amazonaws.autoscaling#ForceDelete", - "traits": { - "smithy.api#documentation": "

Specifies that the group is to be deleted along with all instances associated with the\n group, without waiting for all instances to be terminated. This parameter also deletes\n any lifecycle actions associated with the group.

" - } } } }, @@ -1661,17 +1661,17 @@ "com.amazonaws.autoscaling#DeleteLifecycleHookType": { "type": "structure", "members": { - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#documentation": "

The name of the lifecycle hook.

", "smithy.api#required": {} } } @@ -1730,17 +1730,17 @@ "com.amazonaws.autoscaling#DeletePolicyType": { "type": "structure", "members": { - "AutoScalingGroupName": { + "PolicyName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the policy.

", + "smithy.api#required": {} } }, - "PolicyName": { + "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the policy.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the Auto Scaling group.

" } } } @@ -1762,17 +1762,17 @@ "com.amazonaws.autoscaling#DeleteScheduledActionType": { "type": "structure", "members": { - "AutoScalingGroupName": { + "ScheduledActionName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#documentation": "

The name of the action to delete.

", "smithy.api#required": {} } }, - "ScheduledActionName": { + "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the action to delete.

", + "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } } @@ -1824,28 +1824,28 @@ "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { "type": "structure", "members": { - "NumberOfAutoScalingGroups": { - "target": "com.amazonaws.autoscaling#NumberOfAutoScalingGroups", - "traits": { - "smithy.api#documentation": "

The current number of groups for your AWS account.

" - } - }, "NumberOfLaunchConfigurations": { "target": "com.amazonaws.autoscaling#NumberOfLaunchConfigurations", "traits": { "smithy.api#documentation": "

The current number of launch configurations for your AWS account.

" } }, + "MaxNumberOfLaunchConfigurations": { + "target": "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations", + "traits": { + "smithy.api#documentation": "

The maximum number of launch configurations allowed for your AWS account. The default\n is 200 launch configurations per AWS Region.

" + } + }, "MaxNumberOfAutoScalingGroups": { "target": "com.amazonaws.autoscaling#MaxNumberOfAutoScalingGroups", "traits": { "smithy.api#documentation": "

The maximum number of groups allowed for your AWS account. The default is 200 groups\n per AWS Region.

" } }, - "MaxNumberOfLaunchConfigurations": { - "target": "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations", + "NumberOfAutoScalingGroups": { + "target": "com.amazonaws.autoscaling#NumberOfAutoScalingGroups", "traits": { - "smithy.api#documentation": "

The maximum number of launch configurations allowed for your AWS account. The default\n is 200 launch configurations per AWS Region.

" + "smithy.api#documentation": "

The current number of groups for your AWS account.

" } } } @@ -2015,6 +2015,12 @@ "com.amazonaws.autoscaling#DescribeInstanceRefreshesType": { "type": "structure", "members": { + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + } + }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { @@ -2022,10 +2028,10 @@ "smithy.api#required": {} } }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", + "InstanceRefreshIds": { + "target": "com.amazonaws.autoscaling#InstanceRefreshIds", "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + "smithy.api#documentation": "

One or more instance refresh IDs.

" } }, "NextToken": { @@ -2033,12 +2039,6 @@ "traits": { "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" } - }, - "InstanceRefreshIds": { - "target": "com.amazonaws.autoscaling#InstanceRefreshIds", - "traits": { - "smithy.api#documentation": "

One or more instance refresh IDs.

" - } } } }, @@ -2124,18 +2124,18 @@ "com.amazonaws.autoscaling#DescribeLifecycleHooksType": { "type": "structure", "members": { + "LifecycleHookNames": { + "target": "com.amazonaws.autoscaling#LifecycleHookNames", + "traits": { + "smithy.api#documentation": "

The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle\n hooks are described.

" + } + }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } - }, - "LifecycleHookNames": { - "target": "com.amazonaws.autoscaling#LifecycleHookNames", - "traits": { - "smithy.api#documentation": "

The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle\n hooks are described.

" - } } } }, @@ -2159,6 +2159,12 @@ "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { "type": "structure", "members": { + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" + } + }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { @@ -2171,29 +2177,23 @@ "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" - } } } }, "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsResponse": { "type": "structure", "members": { - "LoadBalancerTargetGroups": { - "target": "com.amazonaws.autoscaling#LoadBalancerTargetGroupStates", - "traits": { - "smithy.api#documentation": "

Information about the target groups.

" - } - }, "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" } + }, + "LoadBalancerTargetGroups": { + "target": "com.amazonaws.autoscaling#LoadBalancerTargetGroupStates", + "traits": { + "smithy.api#documentation": "

Information about the target groups.

" + } } } }, @@ -2213,16 +2213,10 @@ "traits": { "smithy.api#documentation": "

Describes the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load\n Balancers or Network Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.

" } - }, - "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, + }, + "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { + "type": "structure", + "members": { "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { @@ -2230,6 +2224,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { @@ -2272,17 +2272,17 @@ "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer": { "type": "structure", "members": { - "Metrics": { - "target": "com.amazonaws.autoscaling#MetricCollectionTypes", - "traits": { - "smithy.api#documentation": "

One or more metrics.

" - } - }, "Granularities": { "target": "com.amazonaws.autoscaling#MetricGranularityTypes", "traits": { "smithy.api#documentation": "

The granularities for the metrics.

" } + }, + "Metrics": { + "target": "com.amazonaws.autoscaling#MetricCollectionTypes", + "traits": { + "smithy.api#documentation": "

One or more metrics.

" + } } } }, @@ -2333,12 +2333,6 @@ "com.amazonaws.autoscaling#DescribeNotificationConfigurationsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { @@ -2350,6 +2344,12 @@ "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

" } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } } } }, @@ -2391,28 +2391,28 @@ "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, "PolicyNames": { "target": "com.amazonaws.autoscaling#PolicyNames", "traits": { "smithy.api#documentation": "

The names of one or more policies. If you omit this parameter, all policies are\n described. If a group name is provided, the results are limited to that group. This list\n is limited to 50 items. If you specify an unknown policy name, it is ignored with no\n error.

" } }, + "PolicyTypes": { + "target": "com.amazonaws.autoscaling#PolicyTypes", + "traits": { + "smithy.api#documentation": "

One or more policy types. The valid values are SimpleScaling,\n StepScaling, and TargetTrackingScaling.

" + } + }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "

The maximum number of items to be returned with each call. The default value is\n 50 and the maximum value is 100.

" } }, - "PolicyTypes": { - "target": "com.amazonaws.autoscaling#PolicyTypes", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

One or more policy types. The valid values are SimpleScaling,\n StepScaling, and TargetTrackingScaling.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

" } } } @@ -2446,16 +2446,16 @@ "com.amazonaws.autoscaling#DescribeScalingActivitiesType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" } }, - "ActivityIds": { - "target": "com.amazonaws.autoscaling#ActivityIds", + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If\n you omit this parameter, all activities for the past six weeks are described. If unknown\n activities are requested, they are ignored with no error. If you specify an Auto Scaling group,\n the results are limited to that group.

" + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" } }, "AutoScalingGroupName": { @@ -2464,10 +2464,10 @@ "smithy.api#documentation": "

The name of the Auto Scaling group.

" } }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", + "ActivityIds": { + "target": "com.amazonaws.autoscaling#ActivityIds", "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" + "smithy.api#documentation": "

The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If\n you omit this parameter, all activities for the past six weeks are described. If unknown\n activities are requested, they are ignored with no error. If you specify an Auto Scaling group,\n the results are limited to that group.

" } } } @@ -2515,22 +2515,22 @@ "com.amazonaws.autoscaling#DescribeScheduledActionsType": { "type": "structure", "members": { - "ScheduledActionNames": { - "target": "com.amazonaws.autoscaling#ScheduledActionNames", + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { - "smithy.api#documentation": "

The names of one or more scheduled actions. You can specify up to 50 actions. If you\n omit this parameter, all scheduled actions are described. If you specify an unknown\n scheduled action, it is ignored with no error.

" + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" } }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

" } }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + "smithy.api#documentation": "

The latest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.

" } }, "StartTime": { @@ -2539,16 +2539,16 @@ "smithy.api#documentation": "

The earliest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" } }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "ScheduledActionNames": { + "target": "com.amazonaws.autoscaling#ScheduledActionNames", "traits": { - "smithy.api#documentation": "

The latest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.

" + "smithy.api#documentation": "

The names of one or more scheduled actions. You can specify up to 50 actions. If you\n omit this parameter, all scheduled actions are described. If you specify an unknown\n scheduled action, it is ignored with no error.

" } } } @@ -2588,17 +2588,17 @@ "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" } }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, "Filters": { "target": "com.amazonaws.autoscaling#Filters", "traits": { "smithy.api#documentation": "

One or more filters to scope the tags to return. The maximum number of filters per\n filter type (for example, auto-scaling-group) is 1000.

" } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } } } }, @@ -2744,17 +2744,17 @@ "com.amazonaws.autoscaling#DetachLoadBalancersType": { "type": "structure", "members": { - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", + "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", "smithy.api#required": {} } } @@ -2801,10 +2801,10 @@ "com.amazonaws.autoscaling#Ebs": { "type": "structure", "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination", + "VolumeSize": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeSize", "traits": { - "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\n default value is true.

" + "smithy.api#documentation": "

The volume size, in Gibibytes (GiB).

\n

This can be a number from 1-1,024 for standard, 4-16,384 for\n io1, 1-16,384 for gp2, and 500-16,384 for st1\n and sc1. If you specify a snapshot, the volume size must be equal to or\n larger than the snapshot size.

\n

Default: If you create a volume from a snapshot and you don't specify a volume size,\n the default is the snapshot size.

\n

You must specify either a VolumeSize or a SnapshotId. If you\n specify both SnapshotId and VolumeSize, the volume size must\n be equal or greater than the size of the snapshot.

" } }, "Encrypted": { @@ -2813,16 +2813,10 @@ "smithy.api#documentation": "

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see\n Supported Instance Types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.

\n \n

If you are creating a volume from a snapshot, you cannot specify an encryption\n value. Volumes that are created from encrypted snapshots are automatically\n encrypted, and volumes that are created from unencrypted snapshots are automatically\n unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used\n for EBS encryption, but you can specify a custom CMK when you create the snapshot.\n The ability to encrypt a snapshot during copying also allows you to apply a new CMK\n to an already-encrypted snapshot. Volumes restored from the\n resulting copy are only accessible using the new CMK.

\n

Enabling encryption by default results in all EBS volumes being encrypted with\n the AWS managed CMK or a customer managed CMK, whether or not the snapshot was\n encrypted.

\n \n

For more information, see Using Encryption with EBS-Backed\n AMIs in the Amazon EC2 User Guide for Linux Instances\n and Required\n CMK Key Policy for Use with Encrypted Volumes in the\n Amazon EC2 Auto Scaling User Guide.

" } }, - "VolumeSize": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeSize", - "traits": { - "smithy.api#documentation": "

The volume size, in Gibibytes (GiB).

\n

This can be a number from 1-1,024 for standard, 4-16,384 for\n io1, 1-16,384 for gp2, and 500-16,384 for st1\n and sc1. If you specify a snapshot, the volume size must be equal to or\n larger than the snapshot size.

\n

Default: If you create a volume from a snapshot and you don't specify a volume size,\n the default is the snapshot size.

\n

You must specify either a VolumeSize or a SnapshotId. If you\n specify both SnapshotId and VolumeSize, the volume size must\n be equal or greater than the size of the snapshot.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", + "DeleteOnTermination": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination", "traits": { - "smithy.api#documentation": "

The volume type, which can be standard for Magnetic, io1 for\n Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for\n Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see\n Amazon\n EBS Volume Types in the Amazon EC2 User Guide for Linux\n Instances.

\n

Valid Values: standard | io1 | gp2 |\n st1 | sc1\n

" + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\n default value is true.

" } }, "SnapshotId": { @@ -2836,6 +2830,12 @@ "traits": { "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for the volume. The\n maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS\n Volume Types in the Amazon EC2 User Guide for Linux Instances.

\n

Required when the volume type is io1. (Not used with\n standard, gp2, st1, or sc1\n volumes.)

" } + }, + "VolumeType": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", + "traits": { + "smithy.api#documentation": "

The volume type, which can be standard for Magnetic, io1 for\n Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for\n Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see\n Amazon\n EBS Volume Types in the Amazon EC2 User Guide for Linux\n Instances.

\n

Valid Values: standard | io1 | gp2 |\n st1 | sc1\n

" + } } }, "traits": { @@ -2872,18 +2872,18 @@ "smithy.api#required": {} } }, + "Metrics": { + "target": "com.amazonaws.autoscaling#Metrics", + "traits": { + "smithy.api#documentation": "

Specifies which group-level metrics to start collecting. You can specify one or more\n of the following metrics:

\n \n

The instance weighting feature supports the following additional metrics:

\n \n

If you omit this parameter, all metrics are enabled.

" + } + }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } - }, - "Metrics": { - "target": "com.amazonaws.autoscaling#Metrics", - "traits": { - "smithy.api#documentation": "

Specifies which group-level metrics to start collecting. You can specify one or more\n of the following metrics:

\n \n

The instance weighting feature supports the following additional metrics:

\n \n

If you omit this parameter, all metrics are enabled.

" - } } } }, @@ -2944,6 +2944,13 @@ "com.amazonaws.autoscaling#EnterStandbyQuery": { "type": "structure", "members": { + "ShouldDecrementDesiredCapacity": { + "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", + "traits": { + "smithy.api#documentation": "

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of\n instances moved to Standby mode.

", + "smithy.api#required": {} + } + }, "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { @@ -2956,13 +2963,6 @@ "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } - }, - "ShouldDecrementDesiredCapacity": { - "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", - "traits": { - "smithy.api#documentation": "

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of\n instances moved to Standby mode.

", - "smithy.api#required": {} - } } } }, @@ -2992,24 +2992,18 @@ "com.amazonaws.autoscaling#ExecutePolicyType": { "type": "structure", "members": { - "MetricValue": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The metric value to compare to BreachThreshold. This enables you to\n execute a policy of type StepScaling and determine which step adjustment to\n use. For example, if the breach threshold is 50 and you want to use a step adjustment\n with a lower bound of 0 and an upper bound of 10, you can set the metric value to\n 59.

\n

If you specify a metric value that doesn't correspond to a step adjustment for the\n policy, the call returns an error.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" - } - }, - "HonorCooldown": { - "target": "com.amazonaws.autoscaling#HonorCooldown", - "traits": { - "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

" } }, + "BreachThreshold": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The breach threshold for the alarm.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" + } + }, "PolicyName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { @@ -3017,10 +3011,16 @@ "smithy.api#required": {} } }, - "BreachThreshold": { + "HonorCooldown": { + "target": "com.amazonaws.autoscaling#HonorCooldown", + "traits": { + "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MetricValue": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { - "smithy.api#documentation": "

The breach threshold for the alarm.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" + "smithy.api#documentation": "

The metric value to compare to BreachThreshold. This enables you to\n execute a policy of type StepScaling and determine which step adjustment to\n use. For example, if the breach threshold is 50 and you want to use a step adjustment\n with a lower bound of 0 and an upper bound of 10, you can set the metric value to\n 59.

\n

If you specify a metric value that doesn't correspond to a step adjustment for the\n policy, the call returns an error.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" } } } @@ -3056,18 +3056,18 @@ "com.amazonaws.autoscaling#ExitStandbyQuery": { "type": "structure", "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" + } + }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } - }, - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" - } } } }, @@ -3080,18 +3080,18 @@ "smithy.api#documentation": "

The error code.

" } }, + "ErrorMessage": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The error message accompanying the error code.

" + } + }, "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "

The name of the scheduled action.

", "smithy.api#required": {} } - }, - "ErrorMessage": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The error message accompanying the error code.

" - } } }, "traits": { @@ -3163,31 +3163,36 @@ "com.amazonaws.autoscaling#Instance": { "type": "structure", "members": { - "ProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The launch template for the instance.

" } }, - "HealthStatus": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The last reported health status of the instance. \"Healthy\" means that the instance is\n healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy\n and that Amazon EC2 Auto Scaling should terminate and replace it.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The launch configuration associated with the instance.

" } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#documentation": "

The instance type of the EC2 instance.

" + } + }, + "HealthStatus": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

The last reported health status of the instance. \"Healthy\" means that the instance is\n healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy\n and that Amazon EC2 Auto Scaling should terminate and replace it.

", "smithy.api#required": {} } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "ProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "

The launch template for the instance.

" + "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", + "smithy.api#required": {} } }, "LifecycleState": { @@ -3197,29 +3202,24 @@ "smithy.api#required": {} } }, - "AvailabilityZone": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which the instance is running.

", - "smithy.api#required": {} - } - }, "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" } }, - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "

The instance type of the EC2 instance.

" + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} } }, - "LaunchConfigurationName": { + "AvailabilityZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The launch configuration associated with the instance.

" + "smithy.api#documentation": "

The Availability Zone in which the instance is running.

", + "smithy.api#required": {} } } }, @@ -3276,12 +3276,6 @@ "com.amazonaws.autoscaling#InstanceMetadataOptions": { "type": "structure", "members": { - "HttpTokens": { - "target": "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState", - "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" - } - }, "HttpPutResponseHopLimit": { "target": "com.amazonaws.autoscaling#InstanceMetadataHttpPutResponseHopLimit", "traits": { @@ -3293,6 +3287,12 @@ "traits": { "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " } + }, + "HttpTokens": { + "target": "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" + } } }, "traits": { @@ -3322,28 +3322,22 @@ "com.amazonaws.autoscaling#InstanceRefresh": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time at which the instance refresh ended.

" - } - }, "PercentageComplete": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { "smithy.api#documentation": "

The percentage of the instance refresh that is complete. For each instance\n replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the\n instance's health status changes to healthy and the specified warm-up time passes, the\n instance is considered updated and added to the percentage complete.

" } }, - "InstancesToUpdate": { - "target": "com.amazonaws.autoscaling#InstancesToUpdate", + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The number of instances remaining to update before the instance refresh is\n complete.

" + "smithy.api#documentation": "

The date and time at which the instance refresh ended.

" } }, - "InstanceRefreshId": { + "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The instance refresh ID.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

" } }, "StartTime": { @@ -3352,22 +3346,28 @@ "smithy.api#documentation": "

The date and time at which the instance refresh began.

" } }, + "StatusReason": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

Provides more details about the current status of the instance refresh.

" + } + }, "Status": { "target": "com.amazonaws.autoscaling#InstanceRefreshStatus", "traits": { "smithy.api#documentation": "

The current status for the instance refresh operation:

\n " } }, - "StatusReason": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "InstanceRefreshId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Provides more details about the current status of the instance refresh.

" + "smithy.api#documentation": "

The instance refresh ID.

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "InstancesToUpdate": { + "target": "com.amazonaws.autoscaling#InstancesToUpdate", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" + "smithy.api#documentation": "

The number of instances remaining to update before the instance refresh is\n complete.

" } } }, @@ -3440,10 +3440,10 @@ "com.amazonaws.autoscaling#InstancesDistribution": { "type": "structure", "members": { - "SpotAllocationStrategy": { - "target": "com.amazonaws.autoscaling#XmlString", + "SpotInstancePools": { + "target": "com.amazonaws.autoscaling#SpotInstancePools", "traits": { - "smithy.api#documentation": "

Indicates how to allocate instances across Spot Instance pools.

\n

If the allocation strategy is lowest-price, the Auto Scaling group launches\n instances using the Spot pools with the lowest price, and evenly allocates your\n instances across the number of Spot pools that you specify. If the allocation strategy\n is capacity-optimized, the Auto Scaling group launches instances using Spot pools\n that are optimally chosen based on the available Spot capacity.

\n

The default Spot allocation strategy for calls that you make through the API, the AWS\n CLI, or the AWS SDKs is lowest-price. The default Spot allocation strategy\n for the AWS Management Console is capacity-optimized.

\n

Valid values: lowest-price | capacity-optimized\n

" + "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the Overrides array of\n LaunchTemplate. Default if not set is 2.

\n

Used only when the Spot allocation strategy is lowest-price.

\n

Valid Range: Minimum value of 1. Maximum value of 20.

" } }, "SpotMaxPrice": { @@ -3458,16 +3458,10 @@ "smithy.api#documentation": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is provisioned first as your group scales.

\n

Default if not set is 0. If you leave it set to 0, On-Demand Instances are launched as\n a percentage of the Auto Scaling group's desired capacity, per the\n OnDemandPercentageAboveBaseCapacity setting.

\n \n

An update to this setting means a gradual replacement of instances to maintain the\n specified number of On-Demand Instances for your base capacity. When replacing\n instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones.

\n " } }, - "OnDemandPercentageAboveBaseCapacity": { - "target": "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity", - "traits": { - "smithy.api#documentation": "

Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity.

\n

Default if not set is 100. If you leave it set to 100, the percentages are 100% for\n On-Demand Instances and 0% for Spot Instances.

\n \n

An update to this setting means a gradual replacement of instances to maintain the\n percentage of On-Demand Instances for your additional capacity above the base\n capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before\n terminating the old ones.

\n \n

Valid Range: Minimum value of 0. Maximum value of 100.

" - } - }, - "SpotInstancePools": { - "target": "com.amazonaws.autoscaling#SpotInstancePools", + "SpotAllocationStrategy": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the Overrides array of\n LaunchTemplate. Default if not set is 2.

\n

Used only when the Spot allocation strategy is lowest-price.

\n

Valid Range: Minimum value of 1. Maximum value of 20.

" + "smithy.api#documentation": "

Indicates how to allocate instances across Spot Instance pools.

\n

If the allocation strategy is lowest-price, the Auto Scaling group launches\n instances using the Spot pools with the lowest price, and evenly allocates your\n instances across the number of Spot pools that you specify. If the allocation strategy\n is capacity-optimized, the Auto Scaling group launches instances using Spot pools\n that are optimally chosen based on the available Spot capacity.

\n

The default Spot allocation strategy for calls that you make through the API, the AWS\n CLI, or the AWS SDKs is lowest-price. The default Spot allocation strategy\n for the AWS Management Console is capacity-optimized.

\n

Valid values: lowest-price | capacity-optimized\n

" } }, "OnDemandAllocationStrategy": { @@ -3475,6 +3469,12 @@ "traits": { "smithy.api#documentation": "

Indicates how to allocate instance types to fulfill On-Demand capacity.

\n

The only valid value is prioritized, which is also the default value.\n This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The\n first instance type in the array is prioritized higher than the last. If all your\n On-Demand capacity cannot be fulfilled using your highest priority instance, then the\n Auto Scaling groups launches the remaining capacity using the second priority instance type, and\n so on.

" } + }, + "OnDemandPercentageAboveBaseCapacity": { + "target": "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity", + "traits": { + "smithy.api#documentation": "

Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity.

\n

Default if not set is 100. If you leave it set to 100, the percentages are 100% for\n On-Demand Instances and 0% for Spot Instances.

\n \n

An update to this setting means a gradual replacement of instances to maintain the\n percentage of On-Demand Instances for your additional capacity above the base\n capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before\n terminating the old ones.

\n \n

Valid Range: Minimum value of 0. Maximum value of 100.

" + } } }, "traits": { @@ -3519,47 +3519,16 @@ "com.amazonaws.autoscaling#LaunchConfiguration": { "type": "structure", "members": { - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The instance type for the instances.

\n

For information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n

", - "smithy.api#required": {} - } - }, - "ClassicLinkVPCSecurityGroups": { - "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", - "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.

\n

For more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.autoscaling#SecurityGroups", - "traits": { - "smithy.api#documentation": "

A list that contains the security groups to assign to the instances in the Auto Scaling\n group.

\n

For more information, see Security Groups for Your\n VPC in the Amazon Virtual Private Cloud User\n Guide.

" - } - }, - "LaunchConfigurationARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the launch configuration.

" - } - }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", - "traits": { - "smithy.api#documentation": "

For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP\n address to the group's instances.

\n

For more information, see Launching Auto Scaling Instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "InstanceMonitoring": { - "target": "com.amazonaws.autoscaling#InstanceMonitoring", + "IamInstanceProfile": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", "traits": { - "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

For more information, see Configure Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.

\n

For more information, see IAM Role for Applications That Run\n on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

" } }, - "PlacementTenancy": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "BlockDeviceMappings": { + "target": "com.amazonaws.autoscaling#BlockDeviceMappings", "traits": { - "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.

\n

For more information, see Instance Placement\n Tenancy in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

A block device mapping, which specifies the block devices for the instance.

\n

For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.

" } }, "MetadataOptions": { @@ -3568,11 +3537,16 @@ "smithy.api#documentation": "

The metadata options for the instances. For more information, see Instance Metadata and User Data in the\n Amazon EC2 User Guide for Linux Instances.

" } }, - "LaunchConfigurationName": { + "RamdiskId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the launch configuration.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the RAM disk associated with the AMI.

" + } + }, + "KernelId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

" } }, "SpotPrice": { @@ -3581,10 +3555,10 @@ "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price.

\n

For more information, see Launching Spot\n Instances in Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.

" } }, - "RamdiskId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "UserData": { + "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk associated with the AMI.

" + "smithy.api#documentation": "

The Base64-encoded user data to make available to the launched EC2 instances.

\n

For more information, see Instance Metadata and User\n Data in the Amazon EC2 User Guide for Linux Instances.

" } }, "KeyName": { @@ -3600,34 +3574,41 @@ "smithy.api#required": {} } }, - "IamInstanceProfile": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.

\n

For more information, see IAM Role for Applications That Run\n on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The instance type for the instances.

\n

For information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n

", + "smithy.api#required": {} } }, - "UserData": { - "target": "com.amazonaws.autoscaling#XmlStringUserData", + "InstanceMonitoring": { + "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "

The Base64-encoded user data to make available to the launched EC2 instances.

\n

For more information, see Instance Metadata and User\n Data in the Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

For more information, see Configure Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

" } }, - "KernelId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "LaunchConfigurationARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the launch configuration.

" } }, - "EbsOptimized": { - "target": "com.amazonaws.autoscaling#EbsOptimized", + "AssociatePublicIpAddress": { + "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", "traits": { - "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false).

\n

For more information, see Amazon EBS-Optimized\n Instances in the Amazon EC2 User Guide for Linux\n Instances.

" + "smithy.api#documentation": "

For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP\n address to the group's instances.

\n

For more information, see Launching Auto Scaling Instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.

" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.autoscaling#BlockDeviceMappings", + "ClassicLinkVPCSecurityGroups": { + "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "

A block device mapping, which specifies the block devices for the instance.

\n

For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.

" + "smithy.api#documentation": "

The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.

\n

For more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.autoscaling#SecurityGroups", + "traits": { + "smithy.api#documentation": "

A list that contains the security groups to assign to the instances in the Auto Scaling\n group.

\n

For more information, see Security Groups for Your\n VPC in the Amazon Virtual Private Cloud User\n Guide.

" } }, "CreatedTime": { @@ -3637,11 +3618,30 @@ "smithy.api#required": {} } }, + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the launch configuration.

", + "smithy.api#required": {} + } + }, "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

\n

For more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" } + }, + "PlacementTenancy": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "traits": { + "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.

\n

For more information, see Instance Placement\n Tenancy in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.autoscaling#EbsOptimized", + "traits": { + "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false).

\n

For more information, see Amazon EBS-Optimized\n Instances in the Amazon EC2 User Guide for Linux\n Instances.

" + } } }, "traits": { @@ -3675,17 +3675,17 @@ "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" } }, - "LaunchConfigurationNames": { - "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", - "traits": { - "smithy.api#documentation": "

The launch configuration names. If you omit this parameter, all launch configurations\n are described.

" - } - }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" } + }, + "LaunchConfigurationNames": { + "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", + "traits": { + "smithy.api#documentation": "

The launch configuration names. If you omit this parameter, all launch configurations\n are described.

" + } } } }, @@ -3716,17 +3716,17 @@ "com.amazonaws.autoscaling#LaunchTemplate": { "type": "structure", "members": { - "Overrides": { - "target": "com.amazonaws.autoscaling#Overrides", - "traits": { - "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch template.\n Currently, the only supported override is instance type. You can specify between 1 and\n 20 instance types.

\n

If not provided, Amazon EC2 Auto Scaling will use the instance type specified in the launch template\n to launch instances.

" - } - }, "LaunchTemplateSpecification": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request.

" } + }, + "Overrides": { + "target": "com.amazonaws.autoscaling#Overrides", + "traits": { + "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch template.\n Currently, the only supported override is instance type. You can specify between 1 and\n 20 instance types.

\n

If not provided, Amazon EC2 Auto Scaling will use the instance type specified in the launch template\n to launch instances.

" + } } }, "traits": { @@ -3804,12 +3804,6 @@ "com.amazonaws.autoscaling#LifecycleHook": { "type": "structure", "members": { - "NotificationTargetARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.

" - } - }, "RoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { @@ -3822,22 +3816,22 @@ "smithy.api#documentation": "

The name of the lifecycle hook.

" } }, - "DefaultResult": { - "target": "com.amazonaws.autoscaling#LifecycleActionResult", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. The possible values are CONTINUE and\n ABANDON.

" + "smithy.api#documentation": "

The name of the Auto Scaling group for the lifecycle hook.

" } }, - "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "DefaultResult": { + "target": "com.amazonaws.autoscaling#LifecycleActionResult", "traits": { - "smithy.api#documentation": "

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the\n notification target.

" + "smithy.api#documentation": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. The possible values are CONTINUE and\n ABANDON.

" } }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "NotificationTargetARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult parameter.

" + "smithy.api#documentation": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.

" } }, "GlobalTimeout": { @@ -3846,16 +3840,22 @@ "smithy.api#documentation": "

The maximum time, in seconds, that an instance can remain in a\n Pending:Wait or Terminating:Wait state. The maximum is\n 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.

" } }, + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult parameter.

" + } + }, "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { "smithy.api#documentation": "

The state of the EC2 instance to which to attach the lifecycle hook. The following are\n possible values:

\n " } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "NotificationMetadata": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group for the lifecycle hook.

" + "smithy.api#documentation": "

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the\n notification target.

" } } }, @@ -3878,29 +3878,23 @@ "com.amazonaws.autoscaling#LifecycleHookSpecification": { "type": "structure", "members": { - "NotificationTargetARN": { - "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.

" - } - }, - "LifecycleTransition": { - "target": "com.amazonaws.autoscaling#LifecycleTransition", + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { - "smithy.api#documentation": "

The state of the EC2 instance to which you want to attach the lifecycle hook. The\n valid values are:

\n ", + "smithy.api#documentation": "

The name of the lifecycle hook.

", "smithy.api#required": {} } }, - "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { - "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" + "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times\n out.

\n

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult parameter. You can prevent the lifecycle hook from timing\n out by calling RecordLifecycleActionHeartbeat.

" } }, - "RoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "NotificationTargetARN": { + "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

" + "smithy.api#documentation": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.

" } }, "DefaultResult": { @@ -3909,17 +3903,23 @@ "smithy.api#documentation": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. The valid values are CONTINUE and\n ABANDON. The default value is ABANDON.

" } }, - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "RoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

" } }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "NotificationMetadata": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times\n out.

\n

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult parameter. You can prevent the lifecycle hook from timing\n out by calling RecordLifecycleActionHeartbeat.

" + "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" + } + }, + "LifecycleTransition": { + "target": "com.amazonaws.autoscaling#LifecycleTransition", + "traits": { + "smithy.api#documentation": "

The state of the EC2 instance to which you want to attach the lifecycle hook. The\n valid values are:

\n ", + "smithy.api#required": {} } } }, @@ -4052,17 +4052,17 @@ "com.amazonaws.autoscaling#LoadBalancerTargetGroupState": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The state of the target group.

\n " - } - }, "LoadBalancerTargetGroupARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

" } + }, + "State": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The state of the target group.

\n " + } } }, "traits": { @@ -4122,17 +4122,17 @@ "com.amazonaws.autoscaling#MetricDimension": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.autoscaling#MetricDimensionName", + "Value": { + "target": "com.amazonaws.autoscaling#MetricDimensionValue", "traits": { - "smithy.api#documentation": "

The name of the dimension.

", + "smithy.api#documentation": "

The value of the dimension.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.autoscaling#MetricDimensionValue", + "Name": { + "target": "com.amazonaws.autoscaling#MetricDimensionName", "traits": { - "smithy.api#documentation": "

The value of the dimension.

", + "smithy.api#documentation": "

The name of the dimension.

", "smithy.api#required": {} } } @@ -4269,17 +4269,17 @@ "com.amazonaws.autoscaling#MixedInstancesPolicy": { "type": "structure", "members": { - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplate", - "traits": { - "smithy.api#documentation": "

The launch template and instance types (overrides).

\n

Required when creating a mixed instances policy.

" - } - }, "InstancesDistribution": { "target": "com.amazonaws.autoscaling#InstancesDistribution", "traits": { "smithy.api#documentation": "

The instances distribution to use.

\n

If you leave this parameter unspecified, the value for each parameter in\n InstancesDistribution uses a default value.

" } + }, + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplate", + "traits": { + "smithy.api#documentation": "

The launch template and instance types (overrides).

\n

Required when creating a mixed instances policy.

" + } } }, "traits": { @@ -4307,17 +4307,17 @@ "smithy.api#documentation": "

The name of the Auto Scaling group.

" } }, - "NotificationType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

One of the following event notification types:

\n " - } - }, "TopicARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS)\n topic.

" } + }, + "NotificationType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

One of the following event notification types:

\n " + } } }, "traits": { @@ -4390,17 +4390,17 @@ "com.amazonaws.autoscaling#PolicyARNType": { "type": "structure", "members": { - "PolicyARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" - } - }, "Alarms": { "target": "com.amazonaws.autoscaling#Alarms", "traits": { "smithy.api#documentation": "

The CloudWatch alarms created for the target tracking scaling policy.

" } + }, + "PolicyARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" + } } }, "traits": { @@ -4428,18 +4428,18 @@ "com.amazonaws.autoscaling#PredefinedMetricSpecification": { "type": "structure", "members": { + "ResourceLabel": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a\n target group attached to the Auto Scaling group.

\n

Elastic Load Balancing sends data about your load balancers to Amazon CloudWatch. CloudWatch collects\n the data and specifies the format to use to access the data. The format is\n app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id\n , where

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group,\n use the DescribeTargetGroups API operation.

" + } + }, "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#MetricType", "traits": { "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

\n ", "smithy.api#required": {} } - }, - "ResourceLabel": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a\n target group attached to the Auto Scaling group.

\n

Elastic Load Balancing sends data about your load balancers to Amazon CloudWatch. CloudWatch collects\n the data and specifies the format to use to access the data. The format is\n app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id\n , where

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group,\n use the DescribeTargetGroups API operation.

" - } } }, "traits": { @@ -4526,17 +4526,10 @@ "com.amazonaws.autoscaling#PutLifecycleHookType": { "type": "structure", "members": { - "NotificationTargetARN": { - "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance\n is in the transition state for the lifecycle hook. This target can be either an SQS\n queue or an SNS topic.

\n

If you specify an empty string, this overrides the current ARN.

\n

This operation uses the JSON format when sending notifications to an Amazon SQS queue,\n and an email key-value pair format when sending notifications to an Amazon SNS\n topic.

\n

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".

" - } - }, - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "RoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

\n

Required for new lifecycle hooks, but optional when updating existing hooks.

" } }, "AutoScalingGroupName": { @@ -4546,16 +4539,23 @@ "smithy.api#required": {} } }, - "LifecycleTransition": { - "target": "com.amazonaws.autoscaling#LifecycleTransition", + "DefaultResult": { + "target": "com.amazonaws.autoscaling#LifecycleActionResult", "traits": { - "smithy.api#documentation": "

The instance state to which you want to attach the lifecycle hook. The valid values\n are:

\n \n

Required for new lifecycle hooks, but optional when updating existing hooks.

" + "smithy.api#documentation": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. This parameter can be either CONTINUE\n or ABANDON. The default value is ABANDON.

" } }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).

\n

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult parameter. You can prevent the lifecycle hook from timing\n out by calling the RecordLifecycleActionHeartbeat API.

" + "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#required": {} + } + }, + "NotificationTargetARN": { + "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance\n is in the transition state for the lifecycle hook. This target can be either an SQS\n queue or an SNS topic.

\n

If you specify an empty string, this overrides the current ARN.

\n

This operation uses the JSON format when sending notifications to an Amazon SQS queue,\n and an email key-value pair format when sending notifications to an Amazon SNS\n topic.

\n

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".

" } }, "NotificationMetadata": { @@ -4564,16 +4564,16 @@ "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" } }, - "DefaultResult": { - "target": "com.amazonaws.autoscaling#LifecycleActionResult", + "LifecycleTransition": { + "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { - "smithy.api#documentation": "

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. This parameter can be either CONTINUE\n or ABANDON. The default value is ABANDON.

" + "smithy.api#documentation": "

The instance state to which you want to attach the lifecycle hook. The valid values\n are:

\n \n

Required for new lifecycle hooks, but optional when updating existing hooks.

" } }, - "RoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

\n

Required for new lifecycle hooks, but optional when updating existing hooks.

" + "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).

\n

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult parameter. You can prevent the lifecycle hook from timing\n out by calling the RecordLifecycleActionHeartbeat API.

" } } } @@ -4608,17 +4608,17 @@ "smithy.api#required": {} } }, - "TopicARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "NotificationTypes": { + "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS)\n topic.

", + "smithy.api#documentation": "

The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.

", "smithy.api#required": {} } }, - "NotificationTypes": { - "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", + "TopicARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS)\n topic.

", "smithy.api#required": {} } } @@ -4650,84 +4650,84 @@ "com.amazonaws.autoscaling#PutScalingPolicyType": { "type": "structure", "members": { - "AdjustmentType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

Required if the policy type is StepScaling or SimpleScaling.\n For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} } }, - "StepAdjustments": { - "target": "com.amazonaws.autoscaling#StepAdjustments", + "TargetTrackingConfiguration": { + "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", "traits": { - "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

Required if the policy type is StepScaling. (Not used with any other\n policy type.)

" + "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized\n metrics.

\n

The following predefined metrics are available:

\n \n

If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel parameter with the\n PredefinedMetricSpecification.

\n

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is TargetTrackingScaling.

" } }, - "PolicyType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "MinAdjustmentStep": { + "target": "com.amazonaws.autoscaling#MinAdjustmentStep", "traits": { - "smithy.api#documentation": "

One of the following policy types:

\n " + "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" } }, - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", + "PolicyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. If not provided, the default is to use the value from the default cooldown\n period for the Auto Scaling group.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

" + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "ScalingAdjustment": { + "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a positive value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

" } }, - "MetricAggregationType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "EstimatedInstanceWarmup": { + "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", "traits": { - "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

\n

Valid only if the policy type is StepScaling.

" + "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. If not provided, the default is to use the value from the default cooldown\n period for the Auto Scaling group.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

" } }, - "Cooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", + "PolicyType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds. When a cooldown period is\n specified here, it overrides the default cooldown period defined for the Auto Scaling\n group.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

One of the following policy types:

\n " } }, - "MinAdjustmentStep": { - "target": "com.amazonaws.autoscaling#MinAdjustmentStep", + "MetricAggregationType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" + "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

\n

Valid only if the policy type is StepScaling.

" } }, - "TargetTrackingConfiguration": { - "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", + "MinAdjustmentMagnitude": { + "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", "traits": { - "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized\n metrics.

\n

The following predefined metrics are available:

\n \n

If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel parameter with the\n PredefinedMetricSpecification.

\n

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is TargetTrackingScaling.

" + "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.

\n

Valid only if the policy type is StepScaling or\n SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User\n Guide.

\n \n

Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude to a value that is at least as large as your\n largest instance weight.

\n " } }, - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", + "Enabled": { + "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a positive value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

" + "smithy.api#documentation": "

Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disabling a\n Scaling Policy for an Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.

" } }, - "PolicyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "Cooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The name of the policy.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds. When a cooldown period is\n specified here, it overrides the default cooldown period defined for the Auto Scaling\n group.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, - "MinAdjustmentMagnitude": { - "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", + "StepAdjustments": { + "target": "com.amazonaws.autoscaling#StepAdjustments", "traits": { - "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.

\n

Valid only if the policy type is StepScaling or\n SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User\n Guide.

\n \n

Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude to a value that is at least as large as your\n largest instance weight.

\n " + "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

Required if the policy type is StepScaling. (Not used with any other\n policy type.)

" } }, - "Enabled": { - "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", + "AdjustmentType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disabling a\n Scaling Policy for an Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

Required if the policy type is StepScaling or SimpleScaling.\n For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

" } } } @@ -4755,10 +4755,10 @@ "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { "type": "structure", "members": { - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "

The recurring schedule for this action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" } }, "EndTime": { @@ -4767,10 +4767,22 @@ "smithy.api#documentation": "

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the\n action after this time.

" } }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.

" + } + }, + "Recurrence": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The recurring schedule for this action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" + } + }, + "Time": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

This parameter is no longer used.

" } }, "MinSize": { @@ -4786,29 +4798,17 @@ "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.

" - } - }, "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { "smithy.api#documentation": "

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" } }, - "Time": { - "target": "com.amazonaws.autoscaling#TimestampType", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

This parameter is no longer used.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} } } } @@ -4843,6 +4843,13 @@ "smithy.api#documentation": "

The ID of the instance.

" } }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, "LifecycleHookName": { "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { @@ -4855,13 +4862,6 @@ "traits": { "smithy.api#documentation": "

A token that uniquely identifies a specific lifecycle action associated with an\n instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when\n you created the lifecycle hook.

" } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } } } }, @@ -4877,17 +4877,17 @@ "com.amazonaws.autoscaling#RefreshPreferences": { "type": "structure", "members": { - "MinHealthyPercentage": { - "target": "com.amazonaws.autoscaling#IntPercent", - "traits": { - "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must remain healthy during an instance\n refresh to allow the operation to continue, as a percentage of the desired capacity of\n the Auto Scaling group (rounded up to the nearest integer). The default is 90.\n

" - } - }, "InstanceWarmup": { "target": "com.amazonaws.autoscaling#RefreshInstanceWarmup", "traits": { "smithy.api#documentation": "

The number of seconds until a newly launched instance is configured and ready to use.\n During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The\n default is to use the value for the health check grace period defined for the\n group.

" } + }, + "MinHealthyPercentage": { + "target": "com.amazonaws.autoscaling#IntPercent", + "traits": { + "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must remain healthy during an instance\n refresh to allow the operation to continue, as a percentage of the desired capacity of\n the Auto Scaling group (rounded up to the nearest integer). The default is 90.\n

" + } } }, "traits": { @@ -5044,22 +5044,16 @@ "com.amazonaws.autoscaling#ScalingPolicy": { "type": "structure", "members": { - "Alarms": { - "target": "com.amazonaws.autoscaling#Alarms", - "traits": { - "smithy.api#documentation": "

The CloudWatch alarms related to the policy.

" - } - }, - "PolicyType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "ScalingAdjustment": { + "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target Tracking\n Scaling Policies and Step and Simple Scaling\n Policies in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

" } }, - "StepAdjustments": { - "target": "com.amazonaws.autoscaling#StepAdjustments", + "EstimatedInstanceWarmup": { + "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", "traits": { - "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

" + "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics.

" } }, "MetricAggregationType": { @@ -5068,10 +5062,10 @@ "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.

" } }, - "Cooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", + "StepAdjustments": { + "target": "com.amazonaws.autoscaling#StepAdjustments", "traits": { - "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds.

" + "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

" } }, "AutoScalingGroupName": { @@ -5080,40 +5074,46 @@ "smithy.api#documentation": "

The name of the Auto Scaling group.

" } }, - "TargetTrackingConfiguration": { - "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", + "Cooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

A target tracking scaling policy.

" + "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds.

" } }, - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", + "PolicyType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics.

" + "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target Tracking\n Scaling Policies and Step and Simple Scaling\n Policies in the Amazon EC2 Auto Scaling User Guide.

" } }, - "AdjustmentType": { + "PolicyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

" + "smithy.api#documentation": "

The name of the scaling policy.

" } }, - "PolicyARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "MinAdjustmentStep": { + "target": "com.amazonaws.autoscaling#MinAdjustmentStep", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" + "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" } }, - "PolicyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "TargetTrackingConfiguration": { + "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", "traits": { - "smithy.api#documentation": "

The name of the scaling policy.

" + "smithy.api#documentation": "

A target tracking scaling policy.

" } }, - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", + "Enabled": { + "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

" + "smithy.api#documentation": "

Indicates whether the policy is enabled (true) or disabled\n (false).

" + } + }, + "PolicyARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" } }, "MinAdjustmentMagnitude": { @@ -5122,16 +5122,16 @@ "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.

" } }, - "Enabled": { - "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", + "Alarms": { + "target": "com.amazonaws.autoscaling#Alarms", "traits": { - "smithy.api#documentation": "

Indicates whether the policy is enabled (true) or disabled\n (false).

" + "smithy.api#documentation": "

The CloudWatch alarms related to the policy.

" } }, - "MinAdjustmentStep": { - "target": "com.amazonaws.autoscaling#MinAdjustmentStep", + "AdjustmentType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" + "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

" } } }, @@ -5148,18 +5148,18 @@ "com.amazonaws.autoscaling#ScalingProcessQuery": { "type": "structure", "members": { - "ScalingProcesses": { - "target": "com.amazonaws.autoscaling#ProcessNames", - "traits": { - "smithy.api#documentation": "

One or more of the following processes:

\n \n

If you omit this parameter, all processes are specified.

" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } + }, + "ScalingProcesses": { + "target": "com.amazonaws.autoscaling#ProcessNames", + "traits": { + "smithy.api#documentation": "

One or more of the following processes:

\n \n

If you omit this parameter, all processes are specified.

" + } } } }, @@ -5189,46 +5189,46 @@ "com.amazonaws.autoscaling#ScheduledUpdateGroupAction": { "type": "structure", "members": { - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

" } }, - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" + "smithy.api#documentation": "

The date and time in UTC for this action to start. For example,\n \"2019-06-01T00:00:00Z\".\n

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "Time": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" + "smithy.api#documentation": "

This parameter is no longer used.

" } }, - "ScheduledActionName": { + "Recurrence": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the scheduled action.

" + "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" } }, - "ScheduledActionARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduled action.

" + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" } }, - "Time": { + "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

This parameter is no longer used.

" + "smithy.api#documentation": "

The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\".\n

" } }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" + "smithy.api#documentation": "

The name of the scheduled action.

" } }, "MinSize": { @@ -5237,16 +5237,16 @@ "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" } }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "ScheduledActionARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The date and time in UTC for this action to start. For example,\n \"2019-06-01T00:00:00Z\".\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduled action.

" } }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "

The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\".\n

" + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" } } }, @@ -5257,47 +5257,47 @@ "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest": { "type": "structure", "members": { - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" + "smithy.api#documentation": "

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the\n action after this time.

" } }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" } }, - "ScheduledActionName": { + "Recurrence": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the scaling action.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" } }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" } }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the\n action after this time.

" + "smithy.api#documentation": "

The name of the scaling action.

", + "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { - "smithy.api#documentation": "

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

\n

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" + "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" } }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" + "smithy.api#documentation": "

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

\n

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" } } }, @@ -5356,6 +5356,13 @@ "com.amazonaws.autoscaling#SetDesiredCapacityType": { "type": "structure", "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, "HonorCooldown": { "target": "com.amazonaws.autoscaling#HonorCooldown", "traits": { @@ -5368,13 +5375,6 @@ "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain.

", "smithy.api#required": {} } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } } } }, @@ -5395,12 +5395,6 @@ "com.amazonaws.autoscaling#SetInstanceHealthQuery": { "type": "structure", "members": { - "ShouldRespectGracePeriod": { - "target": "com.amazonaws.autoscaling#ShouldRespectGracePeriod", - "traits": { - "smithy.api#documentation": "

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.

\n \n

For more information about the health check grace\n period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API\n Reference.

" - } - }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { @@ -5414,6 +5408,12 @@ "smithy.api#documentation": "

The health status of the instance. Set to Healthy to have the instance\n remain in service. Set to Unhealthy to have the instance be out of service.\n Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

", "smithy.api#required": {} } + }, + "ShouldRespectGracePeriod": { + "target": "com.amazonaws.autoscaling#ShouldRespectGracePeriod", + "traits": { + "smithy.api#documentation": "

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.

\n \n

For more information about the health check grace\n period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API\n Reference.

" + } } } }, @@ -5451,17 +5451,17 @@ "smithy.api#required": {} } }, - "ProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#ProtectedFromScaleIn", + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", + "smithy.api#documentation": "

One or more instance IDs.

", "smithy.api#required": {} } }, - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", + "ProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#ProtectedFromScaleIn", "traits": { - "smithy.api#documentation": "

One or more instance IDs.

", + "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", "smithy.api#required": {} } } @@ -5537,28 +5537,29 @@ "smithy.api#documentation": "

Set of preferences associated with the instance refresh request.

\n

If not provided, the default values are used. For MinHealthyPercentage,\n the default value is 90. For InstanceWarmup, the default is to\n use the value specified for the health check grace period for the Auto Scaling group.

\n

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API\n Reference.

" } }, + "Strategy": { + "target": "com.amazonaws.autoscaling#RefreshStrategy", + "traits": { + "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

\n

A rolling update is an update that is applied to all instances in an Auto Scaling group until\n all instances have been updated. A rolling update can fail due to failed health checks\n or if instances are on standby or are protected from scale in. If the rolling update\n process fails, any instances that were already replaced are not rolled back to their\n previous configuration.

" + } + }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } - }, - "Strategy": { - "target": "com.amazonaws.autoscaling#RefreshStrategy", - "traits": { - "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

\n

A rolling update is an update that is applied to all instances in an Auto Scaling group until\n all instances have been updated. A rolling update can fail due to failed health checks\n or if instances are on standby or are protected from scale in. If the rolling update\n process fails, any instances that were already replaced are not rolled back to their\n previous configuration.

" - } } } }, "com.amazonaws.autoscaling#StepAdjustment": { "type": "structure", "members": { - "MetricIntervalLowerBound": { - "target": "com.amazonaws.autoscaling#MetricScale", + "ScalingAdjustment": { + "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

", + "smithy.api#required": {} } }, "MetricIntervalUpperBound": { @@ -5567,11 +5568,10 @@ "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

" } }, - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", + "MetricIntervalLowerBound": { + "target": "com.amazonaws.autoscaling#MetricScale", "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" } } }, @@ -5631,16 +5631,17 @@ "com.amazonaws.autoscaling#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.autoscaling#TagValue", + "ResourceId": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The tag value.

" + "smithy.api#documentation": "

The name of the group.

" } }, - "ResourceType": { - "target": "com.amazonaws.autoscaling#XmlString", + "Key": { + "target": "com.amazonaws.autoscaling#TagKey", "traits": { - "smithy.api#documentation": "

The type of resource. The only supported value is\n auto-scaling-group.

" + "smithy.api#documentation": "

The tag key.

", + "smithy.api#required": {} } }, "PropagateAtLaunch": { @@ -5649,17 +5650,16 @@ "smithy.api#documentation": "

Determines whether the tag is added to new instances as they are launched in the\n group.

" } }, - "Key": { - "target": "com.amazonaws.autoscaling#TagKey", + "Value": { + "target": "com.amazonaws.autoscaling#TagValue", "traits": { - "smithy.api#documentation": "

The tag key.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tag value.

" } }, - "ResourceId": { + "ResourceType": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The name of the group.

" + "smithy.api#documentation": "

The type of resource. The only supported value is\n auto-scaling-group.

" } } }, @@ -5670,18 +5670,6 @@ "com.amazonaws.autoscaling#TagDescription": { "type": "structure", "members": { - "PropagateAtLaunch": { - "target": "com.amazonaws.autoscaling#PropagateAtLaunch", - "traits": { - "smithy.api#documentation": "

Determines whether the tag is added to new instances as they are launched in the\n group.

" - } - }, - "Key": { - "target": "com.amazonaws.autoscaling#TagKey", - "traits": { - "smithy.api#documentation": "

The tag key.

" - } - }, "ResourceId": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { @@ -5699,6 +5687,18 @@ "traits": { "smithy.api#documentation": "

The type of resource. The only supported value is\n auto-scaling-group.

" } + }, + "Key": { + "target": "com.amazonaws.autoscaling#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "PropagateAtLaunch": { + "target": "com.amazonaws.autoscaling#PropagateAtLaunch", + "traits": { + "smithy.api#documentation": "

Determines whether the tag is added to new instances as they are launched in the\n group.

" + } } }, "traits": { @@ -5740,17 +5740,17 @@ "com.amazonaws.autoscaling#TagsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - }, "Tags": { "target": "com.amazonaws.autoscaling#TagDescriptionList", "traits": { "smithy.api#documentation": "

One or more tags.

" } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } } } }, @@ -5763,30 +5763,30 @@ "com.amazonaws.autoscaling#TargetTrackingConfiguration": { "type": "structure", "members": { - "DisableScaleIn": { - "target": "com.amazonaws.autoscaling#DisableScaleIn", - "traits": { - "smithy.api#documentation": "

Indicates whether scaling in by the target tracking scaling policy is disabled. If\n scaling in is disabled, the target tracking scaling policy doesn't remove instances from\n the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\n the Auto Scaling group. The default is false.

" - } - }, - "PredefinedMetricSpecification": { - "target": "com.amazonaws.autoscaling#PredefinedMetricSpecification", - "traits": { - "smithy.api#documentation": "

A predefined metric. You must specify either a predefined metric or a customized\n metric.

" - } - }, "CustomizedMetricSpecification": { "target": "com.amazonaws.autoscaling#CustomizedMetricSpecification", "traits": { "smithy.api#documentation": "

A customized metric. You must specify either a predefined metric or a customized\n metric.

" } }, + "DisableScaleIn": { + "target": "com.amazonaws.autoscaling#DisableScaleIn", + "traits": { + "smithy.api#documentation": "

Indicates whether scaling in by the target tracking scaling policy is disabled. If\n scaling in is disabled, the target tracking scaling policy doesn't remove instances from\n the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\n the Auto Scaling group. The default is false.

" + } + }, "TargetValue": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { "smithy.api#documentation": "

The target value for the metric.

", "smithy.api#required": {} } + }, + "PredefinedMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredefinedMetricSpecification", + "traits": { + "smithy.api#documentation": "

A predefined metric. You must specify either a predefined metric or a customized\n metric.

" + } } }, "traits": { @@ -5864,41 +5864,34 @@ "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { "type": "structure", "members": { - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain.

\n

This number must be greater than or equal to the minimum size of the group and less\n than or equal to the maximum size of the group.

" - } - }, - "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "AvailabilityZones": { + "target": "com.amazonaws.autoscaling#AvailabilityZones", "traits": { - "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

One or more Availability Zones for the group.

" } }, - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

\n

For more information about preventing instances from terminating on scale in, see\n Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The name of the launch configuration. If you specify\n LaunchConfigurationName in your update request, you can't specify\n LaunchTemplate or MixedInstancesPolicy.

" } }, - "HealthCheckType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. If you configure an Auto Scaling group to use ELB health checks, it\n considers the instance unhealthy if it fails either the EC2 status checks or the load\n balancer health checks.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. For more information, see Service-Linked\n Roles in the Amazon EC2 Auto Scaling User Guide.

" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A comma-separated list of subnet IDs for virtual private cloud (VPC).

\n

If you specify VPCZoneIdentifier with AvailabilityZones, the\n subnets that you specify for this parameter must reside in those Availability\n Zones.

" } }, - "ServiceLinkedRoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "MixedInstancesPolicy": { + "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. For more information, see Service-Linked\n Roles in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

An embedded object that specifies a mixed instances policy.

\n

In your call to UpdateAutoScalingGroup, you can make changes to the\n policy that is specified. All optional parameters are left unchanged if not\n specified.

\n \n

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and\n Auto Scaling Groups with Multiple\n Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.

" } }, "TerminationPolicies": { @@ -5907,64 +5900,71 @@ "smithy.api#documentation": "

A standalone termination policy or a list of termination policies used to select the\n instance to terminate. The policies are executed in the order that they are\n listed.

\n

For more information, see Controlling Which\n Instances Auto Scaling Terminates During Scale In in the\n Amazon EC2 Auto Scaling User Guide.

" } }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { - "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null.

\n

This parameter is optional, but if you specify a value for it, you must specify a\n value of at least 604,800 seconds (7 days). To clear a previously set value, specify a\n new value of 0.

\n

For more information, see Replacing Auto Scaling\n Instances Based on Maximum Instance Lifetime in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.

" } }, - "AvailabilityZones": { - "target": "com.amazonaws.autoscaling#AvailabilityZones", + "HealthCheckType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

One or more Availability Zones for the group.

" + "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. If you configure an Auto Scaling group to use ELB health checks, it\n considers the instance unhealthy if it fails either the EC2 status checks or the load\n balancer health checks.

" } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The name of the launch configuration. If you specify\n LaunchConfigurationName in your update request, you can't specify\n LaunchTemplate or MixedInstancesPolicy.

" + "smithy.api#documentation": "

The launch template and version to use to specify the updates. If you specify\n LaunchTemplate in your update request, you can't specify\n LaunchConfigurationName or MixedInstancesPolicy.

\n

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API\n Reference.

" } }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { - "smithy.api#documentation": "

An embedded object that specifies a mixed instances policy.

\n

In your call to UpdateAutoScalingGroup, you can make changes to the\n policy that is specified. All optional parameters are left unchanged if not\n specified.

\n \n

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and\n Auto Scaling Groups with Multiple\n Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.

" + "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" } }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "PlacementGroup": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. The default value is\n 0.

\n

For more information, see Health\n Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" } }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null.

\n

This parameter is optional, but if you specify a value for it, you must specify a\n value of at least 604,800 seconds (7 days). To clear a previously set value, specify a\n new value of 0.

\n

For more information, see Replacing Auto Scaling\n Instances Based on Maximum Instance Lifetime in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300.

\n

This setting applies when using simple scaling policies, but not when using other\n scaling policies or scheduled scaling. For more information, see Scaling Cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n " + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} } }, - "DefaultCooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", + "HealthCheckGracePeriod": { + "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300.

\n

This setting applies when using simple scaling policies, but not when using other\n scaling policies or scheduled scaling. For more information, see Scaling Cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. The default value is\n 0.

\n

For more information, see Health\n Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

\n

Required if you are adding an ELB health check.

" } }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "

A comma-separated list of subnet IDs for virtual private cloud (VPC).

\n

If you specify VPCZoneIdentifier with AvailabilityZones, the\n subnets that you specify for this parameter must reside in those Availability\n Zones.

" + "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

\n

For more information about preventing instances from terminating on scale in, see\n Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "

The launch template and version to use to specify the updates. If you specify\n LaunchTemplate in your update request, you can't specify\n LaunchConfigurationName or MixedInstancesPolicy.

\n

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API\n Reference.

" + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain.

\n

This number must be greater than or equal to the minimum size of the group and less\n than or equal to the maximum size of the group.

" + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n " } } } diff --git a/codegen/sdk-codegen/aws-models/backup.2018-11-15.json b/codegen/sdk-codegen/aws-models/backup.2018-11-15.json index 75f81a11c8bb..a6d68a77fb49 100644 --- a/codegen/sdk-codegen/aws-models/backup.2018-11-15.json +++ b/codegen/sdk-codegen/aws-models/backup.2018-11-15.json @@ -38,16 +38,36 @@ "smithy.api#pattern": "^[0-9]{12}$" } }, - "com.amazonaws.backup#AlreadyExistsException": { + "com.amazonaws.backup#AdvancedBackupSetting": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.backup#string" - }, - "Code": { - "target": "com.amazonaws.backup#string" + "BackupOptions": { + "target": "com.amazonaws.backup#BackupOptions", + "traits": { + "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.

\n

Valid value: \"WindowsVSS”:“enabled\". If enabled, creates a VSS Windows backup;\n otherwise, creates a regular backup.

\n

If you specify an invalid option, you get an InvalidParameterValueException\n exception.

\n

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows\n Backup.

" + } }, - "Arn": { + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of AWS resource to be backed up. For VSS Windows backups, the only supported\n resource type is Amazon EC2.

\n

Valid values: EC2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of backup options for each resource type.

" + } + }, + "com.amazonaws.backup#AdvancedBackupSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#AdvancedBackupSetting" + } + }, + "com.amazonaws.backup#AlreadyExistsException": { + "type": "structure", + "members": { + "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" @@ -59,13 +79,19 @@ "smithy.api#documentation": "

" } }, + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, - "Type": { + "Arn": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" @@ -80,58 +106,58 @@ "com.amazonaws.backup#BackupJob": { "type": "structure", "members": { - "CompletionDate": { - "target": "com.amazonaws.backup#timestamp", + "PercentDone": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The date and time a job to create a backup job is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" } }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "BackupOptions": { + "target": "com.amazonaws.backup#BackupOptions", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.

\n

Valid value: \"WindowsVSS”:“enabled\". If enabled, creates a VSS Windows backup;\n otherwise, creates a regular backup. If you specify an invalid option, you get an\n InvalidParameterValueException exception.

" } }, - "StartBy": { - "target": "com.amazonaws.backup#timestamp", + "StatusMessage": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job\n must be started before it is canceled. The value is calculated by adding the start window\n to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2\n hours, the StartBy time would be 8:00 PM on the date specified. The value of\n StartBy is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

A detailed message explaining the status of the job to back up a resource.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", + "BackupType": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + "smithy.api#documentation": "

Represents the type of backup for a backup job.

" } }, - "State": { - "target": "com.amazonaws.backup#BackupJobState", + "AccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

The current state of a resource recovery point.

" + "smithy.api#documentation": "

The account ID that owns the backup job.

" } }, - "CreationDate": { + "ExpectedCompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The date and time a backup job is created, in Unix format and Coordinated Universal Time\n (UTC). The value of CreationDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time a job to back up resources is expected to be completed, in Unix format\n and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is\n accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January\n 26, 2018 12:11:30.087 AM.

" } }, - "CreatedBy": { - "target": "com.amazonaws.backup#RecoveryPointCreator", + "BackupJobId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Contains identifying information about the creation of a backup job, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan used to create it.

" + "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" } }, - "BackupVaultArn": { - "target": "com.amazonaws.backup#ARN", + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + "smithy.api#documentation": "

The date and time a backup job is created, in Unix format and Coordinated Universal Time\n (UTC). The value of CreationDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", + "CompletionDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

A detailed message explaining the status of the job to back up a resource.

" + "smithy.api#documentation": "

The date and time a job to create a backup job is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "BytesTransferred": { @@ -140,34 +166,40 @@ "smithy.api#documentation": "

The size in bytes transferred to a backup vault at the time that the job status was\n queried.

" } }, - "BackupJobId": { - "target": "com.amazonaws.backup#string", + "StartBy": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" + "smithy.api#documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job\n must be started before it is canceled. The value is calculated by adding the start window\n to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2\n hours, the StartBy time would be 8:00 PM on the date specified. The value of\n StartBy is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, - "ExpectedCompletionDate": { - "target": "com.amazonaws.backup#timestamp", + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The date and time a job to back up resources is expected to be completed, in Unix format\n and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is\n accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January\n 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, - "PercentDone": { - "target": "com.amazonaws.backup#string", + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, - "AccountId": { - "target": "com.amazonaws.backup#AccountId", + "CreatedBy": { + "target": "com.amazonaws.backup#RecoveryPointCreator", "traits": { - "smithy.api#documentation": "

The account ID that owns the backup job.

" + "smithy.api#documentation": "

Contains identifying information about the creation of a backup job, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan used to create it.

" } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "State": { + "target": "com.amazonaws.backup#BackupJobState", "traits": { - "smithy.api#documentation": "

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + "smithy.api#documentation": "

The current state of a resource recovery point.

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" } }, "ResourceArn": { @@ -176,6 +208,12 @@ "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" } }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

" + } + }, "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { @@ -238,9 +276,36 @@ "target": "com.amazonaws.backup#BackupJob" } }, + "com.amazonaws.backup#BackupOptionKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + } + }, + "com.amazonaws.backup#BackupOptionValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + } + }, + "com.amazonaws.backup#BackupOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.backup#BackupOptionKey" + }, + "value": { + "target": "com.amazonaws.backup#BackupOptionValue" + } + }, "com.amazonaws.backup#BackupPlan": { "type": "structure", "members": { + "AdvancedBackupSettings": { + "target": "com.amazonaws.backup#AdvancedBackupSettings", + "traits": { + "smithy.api#documentation": "

Contains a list of BackupOptions for each resource type.

" + } + }, "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { @@ -263,17 +328,23 @@ "com.amazonaws.backup#BackupPlanInput": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.backup#BackupRulesInput", + "BackupPlanName": { + "target": "com.amazonaws.backup#BackupPlanName", "traits": { - "smithy.api#documentation": "

An array of BackupRule objects, each of which specifies a scheduled task\n that is used to back up a selection of resources.

", + "smithy.api#documentation": "

The optional display name of a backup plan.

", "smithy.api#required": {} } }, - "BackupPlanName": { - "target": "com.amazonaws.backup#BackupPlanName", + "AdvancedBackupSettings": { + "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

The optional display name of a backup plan.

", + "smithy.api#documentation": "

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows VSS backup jobs.

" + } + }, + "Rules": { + "target": "com.amazonaws.backup#BackupRulesInput", + "traits": { + "smithy.api#documentation": "

An array of BackupRule objects, each of which specifies a scheduled task\n that is used to back up a selection of resources.

", "smithy.api#required": {} } } @@ -326,10 +397,10 @@ "com.amazonaws.backup#BackupPlansListMember": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.backup#string", + "BackupPlanArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "CreationDate": { @@ -344,16 +415,22 @@ "smithy.api#documentation": "

The display name of a saved backup plan.

" } }, - "BackupPlanArn": { - "target": "com.amazonaws.backup#ARN", + "LastExecutionDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + "smithy.api#documentation": "

The last time a job to back up resources was run with this rule. A date and time, in\n Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, - "LastExecutionDate": { - "target": "com.amazonaws.backup#timestamp", + "VersionId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

" + } + }, + "AdvancedBackupSettings": { + "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

The last time a job to back up resources was executed with this rule. A date and time,\n in Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

Contains a list of BackupOptions for a resource type.

" } }, "DeletionDate": { @@ -362,16 +439,16 @@ "smithy.api#documentation": "

The date and time a backup plan is deleted, in Unix format and Coordinated Universal\n Time (UTC). The value of DeletionDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "BackupPlanId": { + "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } }, - "CreatorRequestId": { + "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } } }, @@ -382,23 +459,16 @@ "com.amazonaws.backup#BackupRule": { "type": "structure", "members": { - "TargetBackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", - "smithy.api#required": {} - } - }, - "CompletionWindowMinutes": { - "target": "com.amazonaws.backup#WindowMinutes", + "RecoveryPointTags": { + "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.

" + "smithy.api#documentation": "

An array of key-value pair strings that are assigned to resources that are associated\n with this rule when restored from backup.

" } }, - "ScheduleExpression": { - "target": "com.amazonaws.backup#CronExpression", + "CopyActions": { + "target": "com.amazonaws.backup#CopyActions", "traits": { - "smithy.api#documentation": "

A CRON expression specifying when AWS Backup initiates a backup job.

" + "smithy.api#documentation": "

An array of CopyAction objects, which contains the details of the copy operation.

" } }, "Lifecycle": { @@ -407,35 +477,42 @@ "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" } }, - "RuleId": { - "target": "com.amazonaws.backup#string", + "RuleName": { + "target": "com.amazonaws.backup#BackupRuleName", "traits": { - "smithy.api#documentation": "

Uniquely identifies a rule that is used to schedule the backup of a selection of\n resources.

" + "smithy.api#documentation": "

An optional display name for a backup rule.

", + "smithy.api#required": {} } }, - "RecoveryPointTags": { - "target": "com.amazonaws.backup#Tags", + "StartWindowMinutes": { + "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "

An array of key-value pair strings that are assigned to resources that are associated\n with this rule when restored from backup.

" + "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

" } }, - "StartWindowMinutes": { + "CompletionWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

" + "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.

" } }, - "RuleName": { - "target": "com.amazonaws.backup#BackupRuleName", + "TargetBackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

An optional display name for a backup rule.

", + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", "smithy.api#required": {} } }, - "CopyActions": { - "target": "com.amazonaws.backup#CopyActions", + "ScheduleExpression": { + "target": "com.amazonaws.backup#CronExpression", "traits": { - "smithy.api#documentation": "

An array of CopyAction objects, which contains the details of the copy operation.

" + "smithy.api#documentation": "

A CRON expression specifying when AWS Backup initiates a backup job.

" + } + }, + "RuleId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a rule that is used to schedule the backup of a selection of\n resources.

" } } }, @@ -446,12 +523,6 @@ "com.amazonaws.backup#BackupRuleInput": { "type": "structure", "members": { - "RecoveryPointTags": { - "target": "com.amazonaws.backup#Tags", - "traits": { - "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair.

" - } - }, "RuleName": { "target": "com.amazonaws.backup#BackupRuleName", "traits": { @@ -459,16 +530,10 @@ "smithy.api#required": {} } }, - "StartWindowMinutes": { - "target": "com.amazonaws.backup#WindowMinutes", - "traits": { - "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

" - } - }, - "ScheduleExpression": { - "target": "com.amazonaws.backup#CronExpression", + "RecoveryPointTags": { + "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

A CRON expression specifying when AWS Backup initiates a backup job.

" + "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair.

" } }, "CopyActions": { @@ -477,16 +542,28 @@ "smithy.api#documentation": "

An array of CopyAction objects, which contains the details of the copy operation.

" } }, + "Lifecycle": { + "target": "com.amazonaws.backup#Lifecycle", + "traits": { + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup will transition and expire backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" + } + }, "CompletionWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.

" } }, - "Lifecycle": { - "target": "com.amazonaws.backup#Lifecycle", + "StartWindowMinutes": { + "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup will transition and expire backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" + "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.backup#CronExpression", + "traits": { + "smithy.api#documentation": "

A CRON expression specifying when AWS Backup initiates a backup job.

" } }, "TargetBackupVaultName": { @@ -522,10 +599,11 @@ "com.amazonaws.backup#BackupSelection": { "type": "structure", "members": { - "ListOfTags": { - "target": "com.amazonaws.backup#ListOfTags", + "SelectionName": { + "target": "com.amazonaws.backup#BackupSelectionName", "traits": { - "smithy.api#documentation": "

An array of conditions used to specify a set of resources to assign to a backup plan;\n for example, \"STRINGEQUALS\": {\"ec2:ResourceTag/Department\":\n \"accounting\".

" + "smithy.api#documentation": "

The display name of a resource selection document.

", + "smithy.api#required": {} } }, "Resources": { @@ -537,15 +615,14 @@ "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target\n resource; for example, arn:aws:iam::123456789012:role/S3Access.

", + "smithy.api#documentation": "

The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target\n resource; for example, arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, - "SelectionName": { - "target": "com.amazonaws.backup#BackupSelectionName", + "ListOfTags": { + "target": "com.amazonaws.backup#ListOfTags", "traits": { - "smithy.api#documentation": "

The display name of a resource selection document.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of conditions used to specify a set of resources to assign to a backup plan;\n for example, \"StringEquals\": {\"ec2:ResourceTag/Department\":\n \"accounting\".

" } } }, @@ -568,22 +645,22 @@ "com.amazonaws.backup#BackupSelectionsListMember": { "type": "structure", "members": { - "BackupPlanId": { + "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

Uniquely identifies a request to assign a set of resources to a backup plan.

" } }, - "CreatorRequestId": { + "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, - "SelectionId": { + "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to assign a set of resources to a backup plan.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } }, "SelectionName": { @@ -691,12 +768,6 @@ "com.amazonaws.backup#BackupVaultListMember": { "type": "structure", "members": { - "CreatorRequestId": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" - } - }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -721,6 +792,12 @@ "smithy.api#documentation": "

The number of recovery points that are stored in a backup vault.

" } }, + "CreatorRequestId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" + } + }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { @@ -735,7 +812,7 @@ "com.amazonaws.backup#BackupVaultName": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]{2,50}$" } }, "com.amazonaws.backup#Boolean": { @@ -773,7 +850,7 @@ "ConditionType": { "target": "com.amazonaws.backup#ConditionType", "traits": { - "smithy.api#documentation": "

An operation, such as STRINGEQUALS, that is applied to a key-value pair\n used to filter resources in a selection.

", + "smithy.api#documentation": "

An operation, such as StringEquals, that is applied to a key-value pair\n used to filter resources in a selection.

", "smithy.api#required": {} } }, @@ -793,7 +870,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains an array of triplets made up of a condition type (such as\n STRINGEQUALS), a key, and a value. Conditions are used to filter resources\n in a selection that is assigned to a backup plan.

" + "smithy.api#documentation": "

Contains an array of triplets made up of a condition type (such as\n StringEquals), a key, and a value. Conditions are used to filter resources\n in a selection that is assigned to a backup plan.

" } }, "com.amazonaws.backup#ConditionKey": { @@ -816,15 +893,15 @@ "com.amazonaws.backup#CopyAction": { "type": "structure", "members": { + "Lifecycle": { + "target": "com.amazonaws.backup#Lifecycle" + }, "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for\n the copied backup. For example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", "smithy.api#required": {} } - }, - "Lifecycle": { - "target": "com.amazonaws.backup#Lifecycle" } }, "traits": { @@ -840,22 +917,28 @@ "com.amazonaws.backup#CopyJob": { "type": "structure", "members": { - "CompletionDate": { + "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The\n value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The\n value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, + "DestinationRecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a destination recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "State": { - "target": "com.amazonaws.backup#CopyJobState", + "AccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

The current state of a copy job.

" + "smithy.api#documentation": "

The account ID that owns the copy job.

" } }, - "SourceRecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "State": { + "target": "com.amazonaws.backup#CopyJobState", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a source recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

The current state of a copy job.

" } }, "DestinationBackupVaultArn": { @@ -870,31 +953,37 @@ "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The\n value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" - } - }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { "smithy.api#documentation": "

Specifies the IAM role ARN used to copy the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, + "SourceRecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a source recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + } + }, "CreatedBy": { "target": "com.amazonaws.backup#RecoveryPointCreator" }, - "DestinationRecoveryPointArn": { + "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a destination recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

The AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an\n Amazon Relational Database Service (Amazon RDS) database.

" } }, - "AccountId": { - "target": "com.amazonaws.backup#AccountId", + "CompletionDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The account ID that owns the copy job.

" + "smithy.api#documentation": "

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The\n value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A detailed message explaining the status of the job to copy a resource.

" } }, "BackupSizeInBytes": { @@ -909,22 +998,10 @@ "smithy.api#documentation": "

Uniquely identifies a copy job.

" } }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

A detailed message explaining the status of the job to copy a resource.

" - } - }, - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

The AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an\n Amazon Relational Database Service (Amazon RDS) database.

" - } - }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource to be copied; \n for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon\n Relational Database Service (Amazon RDS) database.

" + "smithy.api#documentation": "

The type of AWS resource to be copied; \n for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon\n Relational Database Service (Amazon RDS) database.

" } } }, @@ -987,7 +1064,7 @@ } ], "traits": { - "smithy.api#documentation": "

Backup plans are documents that contain information that AWS Backup uses to schedule\n tasks that create recovery points of resources.

\n

If you call CreateBackupPlan with a plan that already exists, an\n AlreadyExistsException is returned.

", + "smithy.api#documentation": "

Creates a backup plan using a backup plan name and backup rules. A backup plan is a\n document that contains information that AWS Backup uses to schedule tasks that create\n recovery points for resources.

\n

If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.

", "smithy.api#http": { "method": "PUT", "uri": "/backup/plans", @@ -999,6 +1076,12 @@ "com.amazonaws.backup#CreateBackupPlanInput": { "type": "structure", "members": { + "BackupPlanTags": { + "target": "com.amazonaws.backup#Tags", + "traits": { + "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair. The specified tags are assigned to all backups\n created with this plan.

" + } + }, "BackupPlan": { "target": "com.amazonaws.backup#BackupPlanInput", "traits": { @@ -1006,16 +1089,10 @@ "smithy.api#required": {} } }, - "BackupPlanTags": { - "target": "com.amazonaws.backup#Tags", - "traits": { - "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair. The specified tags are assigned to all backups\n created with this plan.

" - } - }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Identifies the request and allows failed requests to be retried without the risk of\n executing the operation twice. If the request includes a CreatorRequestId that\n matches an existing backup plan, that plan is returned. This parameter is optional.

" + "smithy.api#documentation": "

Identifies the request and allows failed requests to be retried without the risk of\n running\n the operation twice. If the request includes a CreatorRequestId that matches\n an existing backup plan, that plan is returned. This parameter is optional.

" } } } @@ -1023,22 +1100,28 @@ "com.amazonaws.backup#CreateBackupPlanOutput": { "type": "structure", "members": { + "AdvancedBackupSettings": { + "target": "com.amazonaws.backup#AdvancedBackupSettings", + "traits": { + "smithy.api#documentation": "

A list of BackupOptions settings for a resource type. This option is only available for Windows VSS backup jobs.

" + } + }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a backup plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "VersionId": { + "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. They cannot be edited.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, - "BackupPlanId": { + "VersionId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. They cannot be edited.

" } }, "BackupPlanArn": { @@ -1075,7 +1158,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a JSON document that specifies a set of resources to assign to a backup plan.\n Resources can be included by specifying patterns for a ListOfTags and selected\n Resources.

\n

For example, consider the following patterns:

\n \n

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes\n that are tagged as \"department=finance\", \"importance=critical\",\n in addition to an EBS volume with the specified volume Id.

\n

Resources and conditions are additive in that all resources that match the pattern are\n selected. This shouldn't be confused with a logical AND, where all conditions must match.\n The matching patterns are logically 'put together using the OR\n operator. In other words, all patterns that match are selected for backup.

", + "smithy.api#documentation": "

Creates a JSON document that specifies a set of resources to assign to a backup plan.\n Resources can be included by specifying patterns for a ListOfTags and selected\n Resources.

\n

For example, consider the following patterns:

\n \n

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes\n that are tagged as \"department=finance\", \"importance=critical\",\n in addition to an EBS volume with the specified volume ID.

\n

Resources and conditions are additive in that all resources that match the pattern are\n selected. This shouldn't be confused with a logical AND, where all conditions must match.\n The matching patterns are logically put together using the OR operator.\n In other words, all patterns that match are selected for backup.

", "smithy.api#http": { "method": "PUT", "uri": "/backup/plans/{BackupPlanId}/selections", @@ -1090,21 +1173,21 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } }, - "BackupPlanId": { - "target": "com.amazonaws.backup#string", + "BackupSelection": { + "target": "com.amazonaws.backup#BackupSelection", "traits": { - "smithy.api#documentation": "

Uniquely identifies the backup plan to be associated with the selection of\n resources.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Specifies the body of a request to assign a set of resources to a backup plan.

", "smithy.api#required": {} } }, - "BackupSelection": { - "target": "com.amazonaws.backup#BackupSelection", + "BackupPlanId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Specifies the body of a request to assign a set of resources to a backup plan.

", + "smithy.api#documentation": "

Uniquely identifies the backup plan to be associated with the selection of\n resources.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -1113,16 +1196,16 @@ "com.amazonaws.backup#CreateBackupSelectionOutput": { "type": "structure", "members": { - "SelectionId": { + "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, - "BackupPlanId": { + "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

" } }, "CreationDate": { @@ -1171,12 +1254,10 @@ "com.amazonaws.backup#CreateBackupVaultInput": { "type": "structure", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "BackupVaultTags": { + "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Metadata that you can assign to help organize the resources that you create. Each tag is\n a key-value pair.

" } }, "EncryptionKeyArn": { @@ -1185,16 +1266,18 @@ "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, - "CreatorRequestId": { - "target": "com.amazonaws.backup#string", + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "BackupVaultTags": { - "target": "com.amazonaws.backup#Tags", + "CreatorRequestId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Metadata that you can assign to help organize the resources that you create. Each tag is\n a key-value pair.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } } } @@ -1202,12 +1285,6 @@ "com.amazonaws.backup#CreateBackupVaultOutput": { "type": "structure", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

" - } - }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -1219,6 +1296,12 @@ "traits": { "smithy.api#documentation": "

The date and time a backup vault is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

" + } } } }, @@ -1379,7 +1462,7 @@ "sdkId": "Backup", "arnNamespace": "backup", "cloudFormationName": "Backup", - "cloudTrailEventSource": "cryo.services.amazonaws.com" + "cloudTrailEventSource": "backup.amazonaws.com" }, "aws.auth#sigv4": { "name": "backup" @@ -1439,28 +1522,28 @@ "com.amazonaws.backup#DeleteBackupPlanOutput": { "type": "structure", "members": { - "BackupPlanArn": { - "target": "com.amazonaws.backup#ARN", + "VersionId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.

" } }, - "DeletionDate": { - "target": "com.amazonaws.backup#timestamp", + "BackupPlanId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The date and time a backup plan is deleted, in Unix format and Coordinated Universal\n Time (UTC). The value of DeletionDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, - "VersionId": { - "target": "com.amazonaws.backup#string", + "DeletionDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version Ids cannot be edited.

" + "smithy.api#documentation": "

The date and time a backup plan is deleted, in Unix format and Coordinated Universal\n Time (UTC). The value of DeletionDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "BackupPlanId": { - "target": "com.amazonaws.backup#string", + "BackupPlanArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } } } @@ -1496,18 +1579,18 @@ "com.amazonaws.backup#DeleteBackupSelectionInput": { "type": "structure", "members": { - "BackupPlanId": { + "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

", + "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "SelectionId": { + "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

", + "smithy.api#documentation": "

Uniquely identifies a backup plan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1698,8 +1781,11 @@ "com.amazonaws.backup#DependencyFailureException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.backup#string" + "Context": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

" + } }, "Type": { "target": "com.amazonaws.backup#string", @@ -1710,11 +1796,8 @@ "Code": { "target": "com.amazonaws.backup#string" }, - "Context": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } + "Message": { + "target": "com.amazonaws.backup#string" } }, "traits": { @@ -1748,7 +1831,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata associated with creating a backup of a resource.

", + "smithy.api#documentation": "

Returns backup job details for the specified BackupJobId.

", "smithy.api#http": { "method": "GET", "uri": "/backup-jobs/{BackupJobId}", @@ -1773,40 +1856,34 @@ "com.amazonaws.backup#DescribeBackupJobOutput": { "type": "structure", "members": { - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" - } - }, - "StartBy": { - "target": "com.amazonaws.backup#timestamp", + "CreatedBy": { + "target": "com.amazonaws.backup#RecoveryPointCreator", "traits": { - "smithy.api#documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job\n must be started before it is canceled. The value is calculated by adding the start window\n to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2\n hours, the StartBy time would be 8:00 PM on the date specified. The value of\n StartBy is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

Contains identifying information about the creation of a backup job, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan that is used to create it.

" } }, - "BackupJobId": { - "target": "com.amazonaws.backup#string", + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" + "smithy.api#documentation": "

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" } }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

A detailed message explaining the status of the job to back up a resource.

" + "smithy.api#documentation": "

The date and time that a backup job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "CompletionDate": { - "target": "com.amazonaws.backup#timestamp", + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The date and time that a job to create a backup job is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", + "BackupSizeInBytes": { + "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the\n resource type.

" + "smithy.api#documentation": "

The size, in bytes, of a backup.

" } }, "ExpectedCompletionDate": { @@ -1815,46 +1892,52 @@ "smithy.api#documentation": "

The date and time that a job to back up resources is expected to be completed, in Unix\n format and Coordinated Universal Time (UTC). The value of\n ExpectedCompletionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, - "BackupSizeInBytes": { - "target": "com.amazonaws.backup#Long", - "traits": { - "smithy.api#documentation": "

The size, in bytes, of a backup.

" - } - }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", + "CompletionDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + "smithy.api#documentation": "

The date and time that a job to create a backup job is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "BackupType": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + "smithy.api#documentation": "

Represents the actual backup type selected for a backup job. For example, if a\n successful WindowsVSS backup was taken, BackupType returns “WindowsVSS”. If\n BackupType is empty, then it is a regular backup.

" } }, - "CreatedBy": { - "target": "com.amazonaws.backup#RecoveryPointCreator", + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Contains identifying information about the creation of a backup job, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan that is used to create it.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "BytesTransferred": { - "target": "com.amazonaws.backup#Long", + "BackupOptions": { + "target": "com.amazonaws.backup#BackupOptions", "traits": { - "smithy.api#documentation": "

The size in bytes transferred to a backup vault at the time that the job status was\n queried.

" + "smithy.api#documentation": "

Represents the options specified as part of backup plan or on-demand backup job.

" } }, - "BackupVaultArn": { + "StartBy": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job\n must be started before it is canceled. The value is calculated by adding the start window\n to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2\n hours, the StartBy time would be 8:00 PM on the date specified. The value of\n StartBy is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, + "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the\n resource type.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A detailed message explaining the status of the job to back up a resource.

" } }, "AccountId": { @@ -1863,16 +1946,22 @@ "smithy.api#documentation": "

Returns the account ID that owns the backup job.

" } }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", + "PercentDone": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The date and time that a backup job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

Contains an estimated percentage that is complete of a job at the time the job status\n was queried.

" } }, - "PercentDone": { + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + } + }, + "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Contains an estimated percentage that is complete of a job at the time the job status\n was queried.

" + "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" } }, "State": { @@ -1880,6 +1969,12 @@ "traits": { "smithy.api#documentation": "

The current state of a resource recovery point.

" } + }, + "BytesTransferred": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The size in bytes transferred to a backup vault at the time that the job status was\n queried.

" + } } } }, @@ -1931,22 +2026,16 @@ "com.amazonaws.backup#DescribeBackupVaultOutput": { "type": "structure", "members": { - "NumberOfRecoveryPoints": { - "target": "com.amazonaws.backup#Long2", - "traits": { - "smithy.api#documentation": "

The number of recovery points that are stored in a backup vault.

" - } - }, - "BackupVaultName": { - "target": "com.amazonaws.backup#string", + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, - "BackupVaultArn": { + "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, "CreationDate": { @@ -1955,16 +2044,22 @@ "smithy.api#documentation": "

The date and time that a backup vault is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "EncryptionKeyArn": { - "target": "com.amazonaws.backup#ARN", + "NumberOfRecoveryPoints": { + "target": "com.amazonaws.backup#Long2", "traits": { - "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + "smithy.api#documentation": "

The number of recovery points that are stored in a backup vault.

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

" } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } } } @@ -2073,18 +2168,18 @@ "com.amazonaws.backup#DescribeProtectedResourceOutput": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" - } - }, "LastBackupTime": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time that a resource was last backed up, in Unix format and Coordinated\n Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, + "ResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" + } + }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { @@ -2149,28 +2244,28 @@ "com.amazonaws.backup#DescribeRecoveryPointOutput": { "type": "structure", "members": { - "Lifecycle": { - "target": "com.amazonaws.backup#Lifecycle", + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than\n the “transition to cold after days” setting. The “transition to cold after days” setting\n cannot be changed after a backup has been transitioned to cold.

" + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, - "BackupSizeInBytes": { - "target": "com.amazonaws.backup#Long", + "LastRestoreTime": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The size, in bytes, of a backup.

" + "smithy.api#documentation": "

The date and time that a recovery point was last restored, in Unix format and\n Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, - "BackupVaultArn": { - "target": "com.amazonaws.backup#ARN", + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + "smithy.api#documentation": "

The type of AWS resource to save as a recovery point; for example, an Amazon Elastic\n Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)\n database.

" } }, - "Status": { - "target": "com.amazonaws.backup#RecoveryPointStatus", + "StorageClass": { + "target": "com.amazonaws.backup#StorageClass", "traits": { - "smithy.api#documentation": "

A status code specifying the state of the recovery point.

\n \n

A partial status indicates that the recovery point was not successfully re-created\n and must be retried.

\n " + "smithy.api#documentation": "

Specifies the storage class of the recovery point. Valid values are WARM or\n COLD.

" } }, "CreationDate": { @@ -2179,22 +2274,16 @@ "smithy.api#documentation": "

The date and time that a recovery point is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "EncryptionKeyArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

The server-side encryption key used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.backup#StorageClass", + "CompletionDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Specifies the storage class of the recovery point. Valid values are WARM or\n COLD.

" + "smithy.api#documentation": "

The date and time that a job to create a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, - "CreatedBy": { - "target": "com.amazonaws.backup#RecoveryPointCreator", + "Status": { + "target": "com.amazonaws.backup#RecoveryPointStatus", "traits": { - "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan used to create it.

" + "smithy.api#documentation": "

A status code specifying the state of the recovery point.

\n \n

A partial status indicates that the recovery point was not successfully re-created\n and must be retried.

\n " } }, "BackupVaultName": { @@ -2203,34 +2292,40 @@ "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

" } }, - "LastRestoreTime": { - "target": "com.amazonaws.backup#timestamp", + "CreatedBy": { + "target": "com.amazonaws.backup#RecoveryPointCreator", "traits": { - "smithy.api#documentation": "

The date and time that a recovery point was last restored, in Unix format and\n Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan used to create it.

" } }, - "CompletionDate": { - "target": "com.amazonaws.backup#timestamp", + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The date and time that a job to create a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", + "BackupSizeInBytes": { + "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + "smithy.api#documentation": "

The size, in bytes, of a backup.

" } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The type of AWS resource to save as a recovery point; for example, an Amazon Elastic\n Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)\n database.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "RecoveryPointArn": { + "Lifecycle": { + "target": "com.amazonaws.backup#Lifecycle", + "traits": { + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than\n the “transition to cold after days” setting. The “transition to cold after days” setting\n cannot be changed after a backup has been transitioned to cold.

" + } + }, + "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

The server-side encryption key used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, "ResourceArn": { @@ -2267,7 +2362,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the current service opt-in settings for the Region. If the service has a value\n set to true, AWS Backup attempts to protect that service's resources in this\n Region, when included in an on-demand backup or scheduled backup plan. If the value is set\n to false for a service, AWS Backup does not attempt to protect that service's\n resources in this Region.

", + "smithy.api#documentation": "

Returns the current service opt-in settings for the Region. If the service has a value\n set to true, AWS Backup tries to protect that service's resources in this\n Region, when included in an on-demand backup or scheduled backup plan. If the value is set\n to false for a service, AWS Backup does not try to protect that service's\n resources in this Region.

", "smithy.api#http": { "method": "GET", "uri": "/account-settings", @@ -2285,7 +2380,7 @@ "ResourceTypeOptInPreference": { "target": "com.amazonaws.backup#ResourceTypeOptInPreference", "traits": { - "smithy.api#documentation": "

Returns a list of all services along with the opt-in preferences in the region.

" + "smithy.api#documentation": "

Returns a list of all services along with the opt-in preferences in the Region.

" } } } @@ -2341,22 +2436,22 @@ "com.amazonaws.backup#DescribeRestoreJobOutput": { "type": "structure", "members": { - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "PercentDone": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Returns metadata associated with a restore job listed by resource type.

" + "smithy.api#documentation": "

Contains an estimated percentage that is complete of a job at the time the job status\n was queried.

" } }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", + "Status": { + "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { - "smithy.api#documentation": "

The date and time that a restore job is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

Status code specifying the state of the job that is initiated by AWS Backup to restore a\n recovery point.

" } }, "CompletionDate": { @@ -2365,34 +2460,28 @@ "smithy.api#documentation": "

The date and time that a job to restore a recovery point is completed, in Unix format\n and Coordinated Universal Time (UTC). The value of CompletionDate is accurate\n to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, - "Status": { - "target": "com.amazonaws.backup#RestoreJobStatus", - "traits": { - "smithy.api#documentation": "

Status code specifying the state of the job that is initiated by AWS Backup to restore a\n recovery point.

" - } - }, "CreatedResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point\n is being restored. The format of the ARN depends on the resource type of the backed-up\n resource.

" } }, - "BackupSizeInBytes": { - "target": "com.amazonaws.backup#Long", + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" + "smithy.api#documentation": "

Returns metadata associated with a restore job listed by resource type.

" } }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, - "PercentDone": { - "target": "com.amazonaws.backup#string", + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Contains an estimated percentage that is complete of a job at the time the job status\n was queried.

" + "smithy.api#documentation": "

The date and time that a restore job is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "AccountId": { @@ -2407,10 +2496,10 @@ "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" } }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", + "BackupSizeInBytes": { + "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

A message showing the status of a job to restore a recovery point.

" + "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" } }, "ExpectedCompletionTimeMinutes": { @@ -2418,6 +2507,12 @@ "traits": { "smithy.api#documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to\n take.

" } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A message showing the status of a job to restore a recovery point.

" + } } } }, @@ -2499,7 +2594,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the body of a backup plan in JSON format, in addition to plan metadata.

", + "smithy.api#documentation": "

Returns BackupPlan details for the specified BackupPlanId.\n Returns the body of a\n backup plan in JSON format, in addition to plan metadata.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans/{BackupPlanId}", @@ -2643,10 +2738,22 @@ "com.amazonaws.backup#GetBackupPlanOutput": { "type": "structure", "members": { + "BackupPlan": { + "target": "com.amazonaws.backup#BackupPlan", + "traits": { + "smithy.api#documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

" + } + }, + "DeletionDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a backup plan is deleted, in Unix format and Coordinated\n Universal Time (UTC). The value of DeletionDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } }, "BackupPlanId": { @@ -2655,6 +2762,12 @@ "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, + "LastExecutionDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The last time a job to back up resources was run with this backup plan. A date and time,\n in Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, "VersionId": { "target": "com.amazonaws.backup#string", "traits": { @@ -2667,22 +2780,10 @@ "smithy.api#documentation": "

The date and time that a backup plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "DeletionDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that a backup plan is deleted, in Unix format and Coordinated\n Universal Time (UTC). The value of DeletionDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" - } - }, - "LastExecutionDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The last time a job to back up resources was executed with this backup plan. A date and\n time, in Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" - } - }, - "BackupPlan": { - "target": "com.amazonaws.backup#BackupPlan", + "AdvancedBackupSettings": { + "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

" + "smithy.api#documentation": "

Contains a list of BackupOptions for each resource type. The list is\n populated only if the advanced option is set for the backup plan.

" } }, "BackupPlanArn": { @@ -2755,28 +2856,28 @@ "smithy.api#documentation": "

The date and time a backup selection is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "SelectionId": { - "target": "com.amazonaws.backup#string", + "BackupSelection": { + "target": "com.amazonaws.backup#BackupSelection", "traits": { - "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

" + "smithy.api#documentation": "

Specifies the body of a request to assign a set of resources to a backup plan.

" } }, - "CreatorRequestId": { + "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of executing the operation twice.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, - "BackupPlanId": { + "SelectionId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

Uniquely identifies the body of a request to assign a set of resources to a backup\n plan.

" } }, - "BackupSelection": { - "target": "com.amazonaws.backup#BackupSelection", + "CreatorRequestId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Specifies the body of a request to assign a set of resources to a backup plan.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } } } @@ -2829,18 +2930,18 @@ "com.amazonaws.backup#GetBackupVaultAccessPolicyOutput": { "type": "structure", "members": { - "BackupVaultArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" - } - }, "Policy": { "target": "com.amazonaws.backup#IAMPolicy", "traits": { "smithy.api#documentation": "

The backup vault access policy document in JSON format.

" } }, + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + } + }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { @@ -2897,6 +2998,12 @@ "com.amazonaws.backup#GetBackupVaultNotificationsOutput": { "type": "structure", "members": { + "BackupVaultEvents": { + "target": "com.amazonaws.backup#BackupVaultEvents", + "traits": { + "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup\n vault.

" + } + }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -2909,12 +3016,6 @@ "smithy.api#documentation": "

An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS)\n topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

" } }, - "BackupVaultEvents": { - "target": "com.amazonaws.backup#BackupVaultEvents", - "traits": { - "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup\n vault.

" - } - }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { @@ -2982,19 +3083,19 @@ "RestoreMetadata": { "target": "com.amazonaws.backup#Metadata", "traits": { - "smithy.api#documentation": "

The set of metadata key-value pairs that describes the original configuration of the\n backed-up resource. These values vary depending on the service that is being\n restored.

" + "smithy.api#documentation": "

The set of metadata key-value pairs that describe the original configuration of the\n backed-up resource. These values vary depending on the service that is being\n restored.

" } }, - "BackupVaultArn": { + "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "RecoveryPointArn": { + "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } } } @@ -3065,18 +3166,18 @@ "com.amazonaws.backup#InvalidRequestException": { "type": "structure", "members": { + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, - "Message": { - "target": "com.amazonaws.backup#string" - }, - "Code": { - "target": "com.amazonaws.backup#string" - }, "Context": { "target": "com.amazonaws.backup#string", "traits": { @@ -3115,18 +3216,18 @@ "com.amazonaws.backup#LimitExceededException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, - "Message": { - "target": "com.amazonaws.backup#string" - }, "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Code": { + "target": "com.amazonaws.backup#string" + }, "Context": { "target": "com.amazonaws.backup#string", "traits": { @@ -3156,7 +3257,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata about your backup jobs.

", + "smithy.api#documentation": "

Returns a list of existing backup jobs for an authenticated account.

", "smithy.api#http": { "method": "GET", "uri": "/backup-jobs", @@ -3173,13 +3274,6 @@ "com.amazonaws.backup#ListBackupJobsInput": { "type": "structure", "members": { - "ByAccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

", - "smithy.api#httpQuery": "accountId" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { @@ -3187,18 +3281,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "ByCreatedAfter": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs that were created after the specified date.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "ByResourceArn": { - "target": "com.amazonaws.backup#ARN", + "ByAccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

Returns only backup jobs that match the specified resource Amazon Resource Name\n (ARN).

", - "smithy.api#httpQuery": "resourceArn" + "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

", + "smithy.api#httpQuery": "accountId" } }, "ByState": { @@ -3215,11 +3302,18 @@ "smithy.api#httpQuery": "maxResults" } }, - "ByResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "ByResourceArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", - "smithy.api#httpQuery": "resourceType" + "smithy.api#documentation": "

Returns only backup jobs that match the specified resource Amazon Resource Name\n (ARN).

", + "smithy.api#httpQuery": "resourceArn" + } + }, + "ByBackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n AWS Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", + "smithy.api#httpQuery": "backupVaultName" } }, "ByCreatedBefore": { @@ -3229,11 +3323,18 @@ "smithy.api#httpQuery": "createdBefore" } }, - "ByBackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "ByCreatedAfter": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n AWS Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", - "smithy.api#httpQuery": "backupVaultName" + "smithy.api#documentation": "

Returns only backup jobs that were created after the specified date.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "ByResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", + "smithy.api#httpQuery": "resourceType" } } } @@ -3241,17 +3342,17 @@ "com.amazonaws.backup#ListBackupJobsOutput": { "type": "structure", "members": { - "BackupJobs": { - "target": "com.amazonaws.backup#BackupJobsList", - "traits": { - "smithy.api#documentation": "

An array of structures containing metadata about your backup jobs returned in JSON\n format.

" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } + }, + "BackupJobs": { + "target": "com.amazonaws.backup#BackupJobsList", + "traits": { + "smithy.api#documentation": "

An array of structures containing metadata about your backup jobs returned in JSON\n format.

" + } } } }, @@ -3294,19 +3395,19 @@ "com.amazonaws.backup#ListBackupPlanTemplatesInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -3367,6 +3468,13 @@ "com.amazonaws.backup#ListBackupPlanVersionsInput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" + } + }, "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { @@ -3381,13 +3489,6 @@ "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } - }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" - } } } }, @@ -3431,7 +3532,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs),\n plan IDs, creation and deletion dates, version IDs, plan names, and creator request\n IDs.

", + "smithy.api#documentation": "

Returns a list of existing backup plans for an authenticated account. The list is\n populated only if the advanced option is set for the backup plan. The list contains\n information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates,\n version IDs, plan names, and creator request IDs.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans", @@ -3448,13 +3549,6 @@ "com.amazonaws.backup#ListBackupPlansInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { @@ -3462,6 +3556,13 @@ "smithy.api#httpQuery": "maxResults" } }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" + } + }, "IncludeDeleted": { "target": "com.amazonaws.backup#Boolean", "traits": { @@ -3474,17 +3575,17 @@ "com.amazonaws.backup#ListBackupPlansOutput": { "type": "structure", "members": { - "BackupPlansList": { - "target": "com.amazonaws.backup#BackupPlansList", - "traits": { - "smithy.api#documentation": "

An array of backup plan list items containing metadata about your saved backup\n plans.

" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } + }, + "BackupPlansList": { + "target": "com.amazonaws.backup#BackupPlansList", + "traits": { + "smithy.api#documentation": "

An array of backup plan list items containing metadata about your saved backup\n plans.

" + } } } }, @@ -3609,19 +3710,19 @@ "com.amazonaws.backup#ListBackupVaultsInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -3675,6 +3776,13 @@ "com.amazonaws.backup#ListCopyJobsInput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return maxResults number of items, \n NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "smithy.api#httpQuery": "nextToken" + } + }, "ByAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { @@ -3682,18 +3790,18 @@ "smithy.api#httpQuery": "accountId" } }, - "ByResourceArn": { - "target": "com.amazonaws.backup#ARN", + "ByCreatedAfter": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

", - "smithy.api#httpQuery": "resourceArn" + "smithy.api#documentation": "

Returns only copy jobs that were created after the specified date.

", + "smithy.api#httpQuery": "createdAfter" } }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", + "ByCreatedBefore": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

Returns only copy jobs that were created before the specified date.

", + "smithy.api#httpQuery": "createdBefore" } }, "ByState": { @@ -3703,11 +3811,11 @@ "smithy.api#httpQuery": "state" } }, - "ByCreatedAfter": { - "target": "com.amazonaws.backup#timestamp", + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

Returns only copy jobs that were created after the specified date.

", - "smithy.api#httpQuery": "createdAfter" + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" } }, "ByResourceType": { @@ -3717,18 +3825,11 @@ "smithy.api#httpQuery": "resourceType" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return maxResults number of items, \n NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "ByCreatedBefore": { - "target": "com.amazonaws.backup#timestamp", + "ByResourceArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Returns only copy jobs that were created before the specified date.

", - "smithy.api#httpQuery": "createdBefore" + "smithy.api#documentation": "

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

", + "smithy.api#httpQuery": "resourceArn" } }, "ByDestinationVaultArn": { @@ -3816,17 +3917,17 @@ "com.amazonaws.backup#ListProtectedResourcesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" - } - }, "Results": { "target": "com.amazonaws.backup#ProtectedResourcesList", "traits": { "smithy.api#documentation": "

An array of resources successfully backed up by AWS Backup including the time the\n resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource\n type.

" } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + } } } }, @@ -3859,17 +3960,38 @@ "uri": "/backup-vaults/{BackupVaultName}/recovery-points", "code": 200 }, - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput": { - "type": "structure", - "members": { + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput": { + "type": "structure", + "members": { + "ByResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Returns only recovery points that match the specified resource type.

", + "smithy.api#httpQuery": "resourceType" + } + }, + "ByCreatedBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only recovery points that were created before the specified timestamp.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { @@ -3899,33 +4021,12 @@ "smithy.api#httpQuery": "backupPlanId" } }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" - } - }, "ByCreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

Returns only recovery points that were created after the specified timestamp.

", "smithy.api#httpQuery": "createdAfter" } - }, - "ByCreatedBefore": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only recovery points that were created before the specified timestamp.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "ByResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

Returns only recovery points that match the specified resource type.

", - "smithy.api#httpQuery": "resourceType" - } } } }, @@ -3986,13 +4087,6 @@ "com.amazonaws.backup#ListRecoveryPointsByResourceInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" - } - }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -4007,6 +4101,13 @@ "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -4067,6 +4168,13 @@ "com.amazonaws.backup#ListRestoreJobsInput": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { @@ -4074,13 +4182,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "ByAccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

", - "smithy.api#httpQuery": "accountId" - } - }, "ByCreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { @@ -4095,11 +4196,11 @@ "smithy.api#httpQuery": "status" } }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", + "ByAccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

", + "smithy.api#httpQuery": "accountId" } }, "ByCreatedBefore": { @@ -4195,17 +4296,17 @@ "com.amazonaws.backup#ListTagsOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.backup#Tags", - "traits": { - "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources you\n create. Each tag is a key-value pair.

" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } + }, + "Tags": { + "target": "com.amazonaws.backup#Tags", + "traits": { + "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources you\n create. Each tag is a key-value pair.

" + } } } }, @@ -4249,19 +4350,19 @@ "com.amazonaws.backup#MissingParameterValueException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.backup#string" }, - "Message": { + "Code": { "target": "com.amazonaws.backup#string" }, - "Type": { + "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, - "Context": { + "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" @@ -4276,12 +4377,6 @@ "com.amazonaws.backup#ProtectedResource": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume\n or an Amazon Relational Database Service (Amazon RDS) database.

" - } - }, "LastBackupTime": { "target": "com.amazonaws.backup#timestamp", "traits": { @@ -4293,6 +4388,12 @@ "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume\n or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

" + } } }, "traits": { @@ -4412,40 +4513,34 @@ "com.amazonaws.backup#RecoveryPointByBackupVault": { "type": "structure", "members": { - "BackupSizeInBytes": { - "target": "com.amazonaws.backup#Long", - "traits": { - "smithy.api#documentation": "

The size, in bytes, of a backup.

" - } - }, - "BackupVaultArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" - } - }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "CalculatedLifecycle": { + "target": "com.amazonaws.backup#CalculatedLifecycle", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" } }, - "CompletionDate": { + "LastRestoreTime": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time a recovery point was last restored, in Unix format and Coordinated\n Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block\n Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)\n database.

" + "smithy.api#documentation": "

The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block\n Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)\n database. For VSS Windows backups, the only supported resource type is Amazon EC2.

" } }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + } + }, + "IsEncrypted": { + "target": "com.amazonaws.backup#Boolean2", + "traits": { + "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is\n encrypted, or FALSE if the recovery point is not encrypted.

" } }, "Status": { @@ -4454,40 +4549,46 @@ "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" } }, - "EncryptionKeyArn": { + "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" } }, - "ResourceArn": { + "BackupSizeInBytes": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The size, in bytes, of a backup.

" + } + }, + "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" + "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, - "CalculatedLifecycle": { - "target": "com.amazonaws.backup#CalculatedLifecycle", + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "LastRestoreTime": { + "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The date and time a recovery point was last restored, in Unix format and Coordinated\n Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, - "IsEncrypted": { - "target": "com.amazonaws.backup#Boolean2", + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is\n encrypted, or FALSE if the recovery point is not encrypted.

" + "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "CreatedBy": { @@ -4496,10 +4597,10 @@ "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan that is used to create it.

" } }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, "Lifecycle": { @@ -4534,29 +4635,29 @@ "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" - } - }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" } }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" - } - }, "BackupSizeBytes": { "target": "com.amazonaws.backup#Long", "traits": { "smithy.api#documentation": "

The size, in bytes, of a backup.

" } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + } + }, + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + } } }, "traits": { @@ -4572,16 +4673,10 @@ "com.amazonaws.backup#RecoveryPointCreator": { "type": "structure", "members": { - "BackupRuleId": { + "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of\n resources.

" - } - }, - "BackupPlanArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, "BackupPlanVersion": { @@ -4590,10 +4685,16 @@ "smithy.api#documentation": "

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at\n most 1,024 bytes long. They cannot be edited.

" } }, - "BackupPlanId": { + "BackupRuleId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of\n resources.

" + } + }, + "BackupPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } } }, @@ -4633,9 +4734,6 @@ "com.amazonaws.backup#ResourceNotFoundException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, "Message": { "target": "com.amazonaws.backup#string" }, @@ -4645,6 +4743,9 @@ "smithy.api#documentation": "

" } }, + "Code": { + "target": "com.amazonaws.backup#string" + }, "Context": { "target": "com.amazonaws.backup#string", "traits": { @@ -4716,71 +4817,59 @@ }, "com.amazonaws.backup#RestoreJobsListMember": { "type": "structure", - "members": { - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" - } - }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time a restore job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" - } - }, - "Status": { - "target": "com.amazonaws.backup#RestoreJobStatus", - "traits": { - "smithy.api#documentation": "

A status code specifying the state of the job initiated by AWS Backup to restore a\n recovery point.

" - } - }, + "members": { "CreatedResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + } + }, "CompletionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "RestoreJobId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" } }, - "BackupSizeInBytes": { - "target": "com.amazonaws.backup#Long", + "Status": { + "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { - "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" + "smithy.api#documentation": "

A status code specifying the state of the job initiated by AWS Backup to restore a\n recovery point.

" } }, - "ExpectedCompletionTimeMinutes": { + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.

" + } + }, + "BackupSizeInBytes": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to\n take.

" + "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" } }, - "AccountId": { - "target": "com.amazonaws.backup#AccountId", + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The account ID that owns the restore job.

" + "smithy.api#documentation": "

The date and time a restore job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "RestoreJobId": { + "PercentDone": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" + "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" } }, "StatusMessage": { @@ -4789,10 +4878,22 @@ "smithy.api#documentation": "

A detailed message explaining the status of the job to restore a recovery point.

" } }, - "PercentDone": { - "target": "com.amazonaws.backup#string", + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + } + }, + "ExpectedCompletionTimeMinutes": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to\n take.

" + } + }, + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the restore job.

" } } }, @@ -4809,15 +4910,15 @@ "smithy.api#documentation": "

" } }, - "Message": { - "target": "com.amazonaws.backup#string" - }, "Context": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" } }, + "Message": { + "target": "com.amazonaws.backup#string" + }, "Code": { "target": "com.amazonaws.backup#string" } @@ -4853,7 +4954,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a job to create a one-time backup of the specified resource.

", + "smithy.api#documentation": "

Starts an on-demand backup job for the specified resource.

", "smithy.api#http": { "method": "PUT", "uri": "/backup-jobs", @@ -4865,22 +4966,10 @@ "com.amazonaws.backup#StartBackupJobInput": { "type": "structure", "members": { - "Lifecycle": { - "target": "com.amazonaws.backup#Lifecycle", + "BackupOptions": { + "target": "com.amazonaws.backup#BackupOptions", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup will transition and expire backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" - } - }, - "StartWindowMinutes": { - "target": "com.amazonaws.backup#WindowMinutes", - "traits": { - "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

" - } - }, - "CompleteWindowMinutes": { - "target": "com.amazonaws.backup#WindowMinutes", - "traits": { - "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.

" + "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.

\n

Valid value: \"WindowsVSS”:“enabled\". If enabled, creates a VSS Windows backup;\n otherwise, creates a regular backup.

" } }, "IamRoleArn": { @@ -4896,11 +4985,22 @@ "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair.

" } }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartBackupJob.

" + } + }, + "Lifecycle": { + "target": "com.amazonaws.backup#Lifecycle", + "traits": { + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup will transition and expire backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" + } + }, + "StartWindowMinutes": { + "target": "com.amazonaws.backup#WindowMinutes", + "traits": { + "smithy.api#documentation": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

" } }, "ResourceArn": { @@ -4910,10 +5010,17 @@ "smithy.api#required": {} } }, - "IdempotencyToken": { - "target": "com.amazonaws.backup#string", + "CompleteWindowMinutes": { + "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartBackupJob.

" + "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", + "smithy.api#required": {} } } } @@ -4921,6 +5028,12 @@ "com.amazonaws.backup#StartBackupJobOutput": { "type": "structure", "members": { + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a backup job is started, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -4932,12 +5045,6 @@ "traits": { "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" } - }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that a backup job is started, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" - } } } }, @@ -4979,12 +5086,8 @@ "com.amazonaws.backup#StartCopyJobInput": { "type": "structure", "members": { - "SourceBackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical source container where backups are stored. \n Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. \n They consist of lowercase letters, numbers, and hyphens.

", - "smithy.api#required": {} - } + "Lifecycle": { + "target": "com.amazonaws.backup#Lifecycle" }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", @@ -4992,10 +5095,10 @@ "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartCopyJob.

" } }, - "DestinationBackupVaultArn": { - "target": "com.amazonaws.backup#ARN", + "SourceBackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", + "smithy.api#documentation": "

The name of a logical source container where backups are stored. \n Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. \n They consist of lowercase letters, numbers, and hyphens.

", "smithy.api#required": {} } }, @@ -5006,32 +5109,36 @@ "smithy.api#required": {} } }, + "DestinationBackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", + "smithy.api#required": {} + } + }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", "smithy.api#required": {} } - }, - "Lifecycle": { - "target": "com.amazonaws.backup#Lifecycle" } } }, "com.amazonaws.backup#StartCopyJobOutput": { "type": "structure", "members": { - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that a copy job is started, in Unix format and Coordinated Universal Time (UTC). \n The value of CreationDate is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" - } - }, "CopyJobId": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

Uniquely identifies a copy job.

" } + }, + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a copy job is started, in Unix format and Coordinated Universal Time (UTC). \n The value of CreationDate is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } } } }, @@ -5070,6 +5177,18 @@ "com.amazonaws.backup#StartRestoreJobInput": { "type": "structure", "members": { + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Starts a job to restore a recovery point for one of the following resources:

\n " + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartRestoreJob.

" + } + }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -5077,12 +5196,6 @@ "smithy.api#required": {} } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

Starts a job to restore a recovery point for one of the following resources:

\n " - } - }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { @@ -5090,16 +5203,10 @@ "smithy.api#required": {} } }, - "IdempotencyToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartRestoreJob.

" - } - }, "Metadata": { "target": "com.amazonaws.backup#Metadata", "traits": { - "smithy.api#documentation": "

A set of metadata key-value pairs. Contains information, such as a resource name,\n required to restore a recovery point.

\n

You can get configuration metadata about a resource at the time it was backed up by\n calling GetRecoveryPointRestoreMetadata. However, values in addition to those\n provided by GetRecoveryPointRestoreMetadata might be required to restore a\n resource. For example, you might need to provide a new resource name if the original\n already exists.

\n

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

\n ", + "smithy.api#documentation": "

A set of metadata key-value pairs. Contains information, such as a resource name,\n required to restore a recovery point.

\n

You can get configuration metadata about a resource at the time it was backed up by\n calling GetRecoveryPointRestoreMetadata. However, values in addition to those\n provided by GetRecoveryPointRestoreMetadata might be required to restore a\n resource. For example, you might need to provide a new resource name if the original\n already exists.

\n

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

\n ", "smithy.api#required": {} } } @@ -5226,13 +5333,6 @@ "com.amazonaws.backup#TagResourceInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.backup#Tags", - "traits": { - "smithy.api#documentation": "

Key-value pairs that are used to help organize your resources. You can assign your own\n metadata to the resources you create.

", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -5240,6 +5340,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.backup#Tags", + "traits": { + "smithy.api#documentation": "

Key-value pairs that are used to help organize your resources. You can assign your own\n metadata to the resources you create.

", + "smithy.api#required": {} + } } } }, @@ -5330,7 +5437,7 @@ } ], "traits": { - "smithy.api#documentation": "

Replaces the body of a saved backup plan identified by its backupPlanId\n with the input document in JSON format. The new version is uniquely identified by a\n VersionId.

", + "smithy.api#documentation": "

Updates an existing backup plan identified by its backupPlanId\n with the input document in JSON format. The new version is uniquely identified by a\n VersionId.

", "smithy.api#http": { "method": "POST", "uri": "/backup/plans/{BackupPlanId}", @@ -5342,18 +5449,18 @@ "com.amazonaws.backup#UpdateBackupPlanInput": { "type": "structure", "members": { - "BackupPlanId": { - "target": "com.amazonaws.backup#string", + "BackupPlan": { + "target": "com.amazonaws.backup#BackupPlanInput", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

", "smithy.api#required": {} } }, - "BackupPlan": { - "target": "com.amazonaws.backup#BackupPlanInput", + "BackupPlanId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

", + "smithy.api#documentation": "

Uniquely identifies a backup plan.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -5368,16 +5475,16 @@ "smithy.api#documentation": "

Uniquely identifies a backup plan.

" } }, - "BackupPlanArn": { - "target": "com.amazonaws.backup#ARN", + "AdvancedBackupSettings": { + "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + "smithy.api#documentation": "

Contains a list of BackupOptions for each resource type.

" } }, - "VersionId": { - "target": "com.amazonaws.backup#string", + "BackupPlanArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version Ids cannot be edited.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" } }, "CreationDate": { @@ -5385,6 +5492,12 @@ "traits": { "smithy.api#documentation": "

The date and time a backup plan is updated, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } + }, + "VersionId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version Ids cannot be edited.

" + } } } }, @@ -5423,6 +5536,14 @@ "com.amazonaws.backup#UpdateRecoveryPointLifecycleInput": { "type": "structure", "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -5436,24 +5557,16 @@ "traits": { "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" } - }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.backup#UpdateRecoveryPointLifecycleOutput": { "type": "structure", "members": { - "CalculatedLifecycle": { - "target": "com.amazonaws.backup#CalculatedLifecycle", + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" } }, "Lifecycle": { @@ -5462,16 +5575,16 @@ "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" } }, - "BackupVaultArn": { + "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "CalculatedLifecycle": { + "target": "com.amazonaws.backup#CalculatedLifecycle", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" } } } @@ -5493,7 +5606,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the current service opt-in settings for the Region. If the service has a value\n set to true, AWS Backup attempts to protect that service's resources in this\n Region, when included in an on-demand backup or scheduled backup plan. If the value is set\n to false for a service, AWS Backup does not attempt to protect that service's\n resources in this Region.

", + "smithy.api#documentation": "

Updates the current service opt-in settings for the Region. If the service has a value\n set to true, AWS Backup tries to protect that service's resources in this\n Region, when included in an on-demand backup or scheduled backup plan. If the value is set\n to false for a service, AWS Backup does not try to protect that service's\n resources in this Region.

", "smithy.api#http": { "method": "PUT", "uri": "/account-settings", @@ -5507,7 +5620,7 @@ "ResourceTypeOptInPreference": { "target": "com.amazonaws.backup#ResourceTypeOptInPreference", "traits": { - "smithy.api#documentation": "

Updates the list of services along with the opt-in preferences for the region.

" + "smithy.api#documentation": "

Updates the list of services along with the opt-in preferences for the Region.

" } } } 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 2e84c42b1633..170f70c84d92 100644 --- a/codegen/sdk-codegen/aws-models/batch.2016-08-10.json +++ b/codegen/sdk-codegen/aws-models/batch.2016-08-10.json @@ -66,15 +66,24 @@ { "target": "com.amazonaws.batch#ListJobs" }, + { + "target": "com.amazonaws.batch#ListTagsForResource" + }, { "target": "com.amazonaws.batch#RegisterJobDefinition" }, { "target": "com.amazonaws.batch#SubmitJob" }, + { + "target": "com.amazonaws.batch#TagResource" + }, { "target": "com.amazonaws.batch#TerminateJob" }, + { + "target": "com.amazonaws.batch#UntagResource" + }, { "target": "com.amazonaws.batch#UpdateComputeEnvironment" }, @@ -93,7 +102,7 @@ "name": "batch" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for\n developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the\n undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to\n users of traditional batch computing software. This service can efficiently provision resources in response to jobs\n submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.

\n

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing\n workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution\n based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing\n software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational\n complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run\n their batch jobs in the AWS Cloud.

", + "smithy.api#documentation": "

AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for\n developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the\n undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar\n to users of traditional batch computing software. This service can efficiently provision resources in response to\n jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results\n quickly.

\n

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing\n workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution\n based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch\n computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces\n operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and\n engineers to run their batch jobs in the AWS Cloud.

", "smithy.api#title": "AWS Batch", "smithy.api#xmlNamespace": { "uri": "http://batch.amazonaws.com/doc/2016-08-10/" @@ -144,13 +153,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.

" - } - }, - "statusSummary": { - "target": "com.amazonaws.batch#ArrayJobStatusSummary", - "traits": { - "smithy.api#documentation": "

A summary of the number of array job children in each available job status. This parameter is returned for\n parent array jobs.

" + "smithy.api#documentation": "

The job index within the array that is associated with this job. This parameter is returned for array job\n children.

" } }, "size": { @@ -158,6 +161,12 @@ "traits": { "smithy.api#documentation": "

The size of the array job. This parameter is returned for parent array jobs.

" } + }, + "statusSummary": { + "target": "com.amazonaws.batch#ArrayJobStatusSummary", + "traits": { + "smithy.api#documentation": "

A summary of the number of array job children in each available job status. This parameter is returned for\n parent array jobs.

" + } } }, "traits": { @@ -167,16 +176,16 @@ "com.amazonaws.batch#ArrayPropertiesSummary": { "type": "structure", "members": { - "index": { + "size": { "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 size of the array job. This parameter is returned for parent array jobs.

" } }, - "size": { + "index": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The size of the array job. This parameter is returned for parent array jobs.

" + "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.

" } } }, @@ -187,40 +196,40 @@ "com.amazonaws.batch#AttemptContainerDetail": { "type": "structure", "members": { - "containerInstanceArn": { + "reason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.

" + "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped\n container.

" } }, - "networkInterfaces": { - "target": "com.amazonaws.batch#NetworkInterfaceList", + "logStreamName": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The network interfaces associated with the job attempt.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is\n /aws/batch/job. Each container attempt receives a log stream name when they reach the\n RUNNING status.

" } }, - "exitCode": { - "target": "com.amazonaws.batch#Integer", + "taskArn": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The exit code for the job attempt. A non-zero exit code is considered a failure.

" + "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\n task ARN when they reach the STARTING status.

" } }, - "taskArn": { + "containerInstanceArn": { "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 container instance that hosts the job attempt.

" } }, - "reason": { - "target": "com.amazonaws.batch#String", + "networkInterfaces": { + "target": "com.amazonaws.batch#NetworkInterfaceList", "traits": { - "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped\n container.

" + "smithy.api#documentation": "

The network interfaces associated with the job attempt.

" } }, - "logStreamName": { - "target": "com.amazonaws.batch#String", + "exitCode": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is\n /aws/batch/job. Each container attempt receives a log stream name when they reach the\n RUNNING status.

" + "smithy.api#documentation": "

The exit code for the job attempt. A non-zero exit code is considered a failure.

" } } }, @@ -231,16 +240,22 @@ "com.amazonaws.batch#AttemptDetail": { "type": "structure", "members": { + "stoppedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the\n RUNNING state to a terminal state, such as SUCCEEDED or\n FAILED).

" + } + }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "

The Unix timestamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned\n from the STARTING state to the RUNNING state).

" + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the\n STARTING state to the RUNNING state).

" } }, "statusReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the job attempt.

" + "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the job\n attempt.

" } }, "container": { @@ -248,12 +263,6 @@ "traits": { "smithy.api#documentation": "

Details about the container in this job attempt.

" } - }, - "stoppedAt": { - "target": "com.amazonaws.batch#Long", - "traits": { - "smithy.api#documentation": "

The Unix timestamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned\n from the RUNNING state to a terminal state, such as SUCCEEDED or\n FAILED).

" - } } }, "traits": { @@ -381,7 +390,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or\n RUNNABLE state are cancelled. Jobs that have progressed to STARTING or\n RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these\n jobs must be terminated with the TerminateJob operation.

", + "smithy.api#documentation": "

Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or\n RUNNABLE state are cancelled. Jobs that have progressed to STARTING or\n RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled);\n these jobs must be terminated with the TerminateJob operation.

", "smithy.api#http": { "method": "POST", "uri": "/v1/canceljob", @@ -402,7 +411,7 @@ "reason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future\n DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity\n logs.

", + "smithy.api#documentation": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future\n DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity\n logs.

", "smithy.api#required": {} } } @@ -420,7 +429,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 is not 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\n that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -428,10 +437,11 @@ "com.amazonaws.batch#ComputeEnvironmentDetail": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.batch#CEState", + "computeEnvironmentArn": { + "target": "com.amazonaws.batch#String", "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 does not 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 Amazon Resource Name (ARN) of the compute environment.

", + "smithy.api#required": {} } }, "computeResources": { @@ -440,11 +450,10 @@ "smithy.api#documentation": "

The compute resources defined for the compute environment.

" } }, - "ecsClusterArn": { - "target": "com.amazonaws.batch#String", + "status": { + "target": "com.amazonaws.batch#CEStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The current status of the compute environment (for example, CREATING or\n VALID).

" } }, "type": { @@ -453,12 +462,6 @@ "smithy.api#documentation": "

The type of the compute environment.

" } }, - "status": { - "target": "com.amazonaws.batch#CEStatus", - "traits": { - "smithy.api#documentation": "

The current status of the compute environment (for example, CREATING or VALID).

" - } - }, "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { @@ -466,23 +469,35 @@ "smithy.api#required": {} } }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags applied to the compute environment.

" + } + }, "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.

" } }, - "statusReason": { + "ecsClusterArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the compute\n environment.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

", + "smithy.api#required": {} } }, - "computeEnvironmentArn": { + "state": { + "target": "com.amazonaws.batch#CEState", + "traits": { + "smithy.api#documentation": "

The state of the compute environment. The valid values are ENABLED or\n 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\n scale its instances out or in automatically, based on the job queue demand.

\n

If the state is DISABLED, then the AWS Batch scheduler does not 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.

" + } + }, + "statusReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the compute environment.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the compute\n environment.

" } } }, @@ -515,7 +530,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.

" } }, "com.amazonaws.batch#ComputeEnvironmentOrders": { @@ -527,106 +542,106 @@ "com.amazonaws.batch#ComputeResource": { "type": "structure", "members": { - "securityGroupIds": { + "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security\n groups must be specified, either in securityGroupIds or using a launch template referenced in\n launchTemplate. If security groups are specified using both securityGroupIds and\n launchTemplate, the values in securityGroupIds will be used.

" + "smithy.api#documentation": "

The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the\n Amazon VPC User Guide.

", + "smithy.api#required": {} } }, - "subnets": { - "target": "com.amazonaws.batch#StringList", + "minvCpus": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon\n VPC User Guide.

", + "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

", "smithy.api#required": {} } }, - "spotIamFleetRole": { - "target": "com.amazonaws.batch#String", + "type": { + "target": "com.amazonaws.batch#CRType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.\n This role is required if the allocation\n strategy set to BEST_FIT or if the allocation strategy is not specified. For more\n information, see Amazon EC2 Spot Fleet\n Role in the AWS Batch User Guide.

" + "smithy.api#documentation": "

The type of compute environment: EC2 or SPOT.

", + "smithy.api#required": {} } }, - "instanceTypes": { - "target": "com.amazonaws.batch#StringList", + "instanceRole": { + "target": "com.amazonaws.batch#String", "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 pick instance types (from the C, M,\n and R instance families) on the fly that match the demand of your job queues.

", + "smithy.api#documentation": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS Instance\n Role in the AWS Batch User Guide.

", "smithy.api#required": {} } }, - "desiredvCpus": { + "maxvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment.

" + "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

", + "smithy.api#required": {} } }, - "launchTemplate": { - "target": "com.amazonaws.batch#LaunchTemplateSpecification", + "bidPercentage": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The launch template to use for your compute resources. Any other compute resource parameters that you specify in\n a CreateComputeEnvironment API operation override the same parameters in the launch template. You\n must specify either the launch template ID or launch template name in the request, but not both. For more\n information, see Launch Template\n Support in the AWS Batch User Guide.

" + "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\n must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price\n and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the\n On-Demand price.

" } }, - "maxvCpus": { + "desiredvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment.

" } }, - "ec2KeyPair": { + "placementGroup": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 key pair that is used for instances launched in the compute environment.

" + "smithy.api#documentation": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node\n parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it\n with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a\n single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide\n for Linux Instances.

" } }, - "imageId": { + "ec2KeyPair": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

" + "smithy.api#documentation": "

The Amazon EC2 key pair that is used for instances launched in the compute environment.

" } }, - "placementGroup": { + "spotIamFleetRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for\n Linux Instances.

" - } - }, - "type": { - "target": "com.amazonaws.batch#CRType", - "traits": { - "smithy.api#documentation": "

The type of compute environment: EC2 or SPOT.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.\n This role is required if the allocation\n strategy set to BEST_FIT or if the allocation strategy is not specified. For more\n information, see Amazon EC2 Spot\n Fleet Role in the AWS Batch User Guide.

" } }, - "tags": { - "target": "com.amazonaws.batch#TagsMap", + "launchTemplate": { + "target": "com.amazonaws.batch#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these\n 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\" }.

" + "smithy.api#documentation": "

The launch template to use for your compute resources. Any other compute resource parameters that you specify\n in a CreateComputeEnvironment API operation override the same parameters in the launch template.\n You must specify either the launch template ID or launch template name in the request, but not both. For more\n information, see Launch Template\n Support in the AWS Batch User Guide.

" } }, "allocationStrategy": { "target": "com.amazonaws.batch#CRAllocationStrategy", "traits": { - "smithy.api#documentation": "

The allocation strategy to use for the compute resource in case not enough instances of the best fitting\n instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits. If this is\n not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for\n additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. If you\n are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified.\n BEST_FIT_PROGRESSIVE will select additional instance types that are large enough to meet the\n requirements of the jobs in the queue, with a preference for instance types with a lower cost per vCPU.\n SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select\n additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference\n for instance types that are less likely to be interrupted. For more information, see Allocation Strategies in the\n AWS Batch User Guide.

" + "smithy.api#documentation": "

The allocation strategy to use for the compute resource in case not enough instances of the best fitting\n instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits. If\n this is not specified, the default is BEST_FIT, which will use only the best fitting instance type,\n waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit\n scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified.\n BEST_FIT_PROGRESSIVE will select additional instance types that are large enough to meet the\n requirements of the jobs in the queue, with a preference for instance types with a lower cost per vCPU.\n SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select\n additional instance types that are large enough to meet the requirements of the jobs in the queue, with a\n preference for instance types that are less likely to be interrupted. For more information, see Allocation Strategies in\n the AWS Batch User Guide.

" } }, - "minvCpus": { - "target": "com.amazonaws.batch#Integer", + "instanceTypes": { + "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

", + "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\n family (such as c5.8xlarge). You can also choose optimal to pick instance types (from\n the C, M, and R instance families) on the fly that match the demand of your job queues.

", "smithy.api#required": {} } }, - "bidPercentage": { - "target": "com.amazonaws.batch#Integer", + "tags": { + "target": "com.amazonaws.batch#TagsMap", "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.

" + "smithy.api#documentation": "

Key-value pair tags to be applied to 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\"\n }. These tags can not be updated or removed\n after the compute environment has been created; any changes require creating a new compute environment and\n removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API\n operation.

" } }, - "instanceRole": { + "imageId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS Instance\n Role in the AWS Batch User Guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security\n groups must be specified, either in securityGroupIds or using a launch template referenced in\n launchTemplate. If security groups are specified using both securityGroupIds and\n launchTemplate, the values in securityGroupIds will be used.

" } } }, @@ -637,10 +652,10 @@ "com.amazonaws.batch#ComputeResourceUpdate": { "type": "structure", "members": { - "maxvCpus": { + "desiredvCpus": { "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 desired number of Amazon EC2 vCPUS in the compute environment.

" } }, "minvCpus": { @@ -649,10 +664,10 @@ "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

" } }, - "desiredvCpus": { + "maxvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment.

" + "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

" } } }, @@ -663,10 +678,10 @@ "com.amazonaws.batch#ContainerDetail": { "type": "structure", "members": { - "jobRoleArn": { - "target": "com.amazonaws.batch#String", + "linuxParameters": { + "target": "com.amazonaws.batch#LinuxParameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the job upon execution.

" + "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as details for device mappings.

" } }, "exitCode": { @@ -675,34 +690,22 @@ "smithy.api#documentation": "

The exit code to return upon completion.

" } }, - "mountPoints": { - "target": "com.amazonaws.batch#MountPoints", - "traits": { - "smithy.api#documentation": "

The mount points for data volumes in your container.

" - } - }, - "taskArn": { + "jobRoleArn": { "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) associated with the job upon execution.

" } }, - "user": { + "reason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The user name to use inside the container.

" - } - }, - "linuxParameters": { - "target": "com.amazonaws.batch#LinuxParameters", - "traits": { - "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as details for device mappings.

" + "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped\n container.

" } }, "memory": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The number of MiB of memory reserved for the job.

" + "smithy.api#documentation": "

The number of MiB of memory reserved for the job. This is a required parameter.

" } }, "image": { @@ -711,34 +714,52 @@ "smithy.api#documentation": "

The image used to start the container.

" } }, + "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.

" + } + }, + "readonlyRootFilesystem": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file system.

" + } + }, "environment": { "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables to pass to a container.

\n \n

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

\n " + "smithy.api#documentation": "

The environment variables to pass to a container.

\n \n

Environment variables must not start with AWS_BATCH; this naming\n convention is reserved for variables that are set by the AWS Batch service.

\n " } }, - "privileged": { - "target": "com.amazonaws.batch#Boolean", + "resourceRequirements": { + "target": "com.amazonaws.batch#ResourceRequirements", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host container instance (similar\n to the root user).

" + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. Currently, the only supported resource is\n GPU.

" } }, - "logStreamName": { - "target": "com.amazonaws.batch#String", + "secrets": { + "target": "com.amazonaws.batch#SecretList", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is\n /aws/batch/job. Each container attempt receives a log stream name when they reach the\n RUNNING status.

" + "smithy.api#documentation": "

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the\n Amazon Elastic Container Service Developer Guide.

" } }, - "instanceType": { + "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The instance type of the underlying host infrastructure of a multi-node parallel job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.

" } }, - "containerInstanceArn": { - "target": "com.amazonaws.batch#String", + "ulimits": { + "target": "com.amazonaws.batch#Ulimits", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container instance on which the container is running.

" + "smithy.api#documentation": "

A list of ulimit values to set in the container.

" + } + }, + "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\n run. By default, containers use the same logging driver that the Docker daemon uses. However the\n container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter\n in the container definition. To use a different logging driver for a container, the log system must be configured\n properly on the container instance (or on a different log server for remote logging options). For more information\n 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\n Amazon ECS 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\n that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed\n on that 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 " } }, "command": { @@ -747,49 +768,61 @@ "smithy.api#documentation": "

The command that is passed to the container.

" } }, - "networkInterfaces": { - "target": "com.amazonaws.batch#NetworkInterfaceList", + "vcpus": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The network interfaces associated with the job.

" + "smithy.api#documentation": "

The number of VCPUs allocated for the job. This is a required parameter.

" } }, - "resourceRequirements": { - "target": "com.amazonaws.batch#ResourceRequirements", + "containerInstanceArn": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The type and amount of a resource to assign to a container. Currently, the only supported resource is\n GPU.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container instance on which the container is running.

" } }, - "vcpus": { - "target": "com.amazonaws.batch#Integer", + "volumes": { + "target": "com.amazonaws.batch#Volumes", "traits": { - "smithy.api#documentation": "

The number of VCPUs allocated for the job.

" + "smithy.api#documentation": "

A list of volumes associated with the job.

" } }, - "ulimits": { - "target": "com.amazonaws.batch#Ulimits", + "networkInterfaces": { + "target": "com.amazonaws.batch#NetworkInterfaceList", "traits": { - "smithy.api#documentation": "

A list of ulimit values to set in the container.

" + "smithy.api#documentation": "

The network interfaces associated with the job.

" } }, - "reason": { + "logStreamName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped\n container.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is\n /aws/batch/job. Each container attempt receives a log stream name when they reach the\n RUNNING status.

" } }, - "readonlyRootFilesystem": { - "target": "com.amazonaws.batch#Boolean", + "instanceType": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file system.

" + "smithy.api#documentation": "

The instance type of the underlying host infrastructure of a multi-node parallel job.

" } }, - "volumes": { - "target": "com.amazonaws.batch#Volumes", + "privileged": { + "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "

A list of volumes associated with the job.

" + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host container instance\n (similar to the root user).

" } - } - }, + }, + "user": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The user name to use inside the container.

" + } + }, + "mountPoints": { + "target": "com.amazonaws.batch#MountPoints", + "traits": { + "smithy.api#documentation": "

The mount points for data volumes in your container.

" + } + } + }, "traits": { "smithy.api#documentation": "

An object representing the details of a container that is part of a job.

" } @@ -800,37 +833,37 @@ "command": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker image or the job\n definition.

" - } - }, - "instanceType": { - "target": "com.amazonaws.batch#String", - "traits": { - "smithy.api#documentation": "

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container\n jobs.

" + "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker image or the job\n definition.

" } }, "vcpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The number of vCPUs to reserve for the container. This value overrides the value set in the job\n definition.

" + "smithy.api#documentation": "

The number of vCPUs to reserve for the container. This value overrides the value set in the job\n definition.

" } }, - "resourceRequirements": { - "target": "com.amazonaws.batch#ResourceRequirements", + "memory": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The type and amount of a resource to assign to a container. This value overrides the value set in the job\n definition. Currently, the only supported resource is GPU.

" + "smithy.api#documentation": "

The number of MiB of memory reserved for the job. This value overrides the value set in the job\n definition.

" } }, "environment": { "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment variables, which are added to\n the container at launch, or you can override the existing environment variables from the Docker image or the job\n definition.

\n \n

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

\n " + "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment variables, which are added to\n the container at launch, or you can override the existing environment variables from the Docker image or the job\n definition.

\n \n

Environment variables must not start with AWS_BATCH; this naming\n convention is reserved for variables that are set by the AWS Batch service.

\n " } }, - "memory": { - "target": "com.amazonaws.batch#Integer", + "resourceRequirements": { + "target": "com.amazonaws.batch#ResourceRequirements", + "traits": { + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. This value overrides the value set in the job\n definition. Currently, the only supported resource is GPU.

" + } + }, + "instanceType": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The number of MiB of memory reserved for the job. This value overrides the value set in the job\n definition.

" + "smithy.api#documentation": "

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container\n jobs.

" } } }, @@ -853,102 +886,120 @@ "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as details for device mappings.

" } }, - "vcpus": { - "target": "com.amazonaws.batch#Integer", + "mountPoints": { + "target": "com.amazonaws.batch#MountPoints", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The mount points for data volumes in your container. This parameter maps to Volumes in the\n Create a container section of the Docker Remote API and the --volume option to docker run.

" + } + }, + "secrets": { + "target": "com.amazonaws.batch#SecretList", + "traits": { + "smithy.api#documentation": "

The secrets for the container. For more information, see Specifying Sensitive Data in the\n Amazon Elastic Container Service Developer Guide.

" } }, "user": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user option to docker run.

" + "smithy.api#documentation": "

The user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user option to docker run.

" } }, - "mountPoints": { - "target": "com.amazonaws.batch#MountPoints", + "memory": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The mount points for data volumes in your container. This parameter maps to Volumes in the\n Create a container section of the Docker Remote API and the --volume option to docker run.

" + "smithy.api#documentation": "

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory\n specified here, the container is killed. 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. This is required but can be specified\n in several places for multi-node parallel (MNP) jobs; it must be specified for each node at least\n once.

\n \n

If you are trying to maximize your resource utilization by providing your jobs as much memory as possible\n for a particular instance type, see Memory\n Management in the AWS Batch User Guide.

\n " } }, - "privileged": { - "target": "com.amazonaws.batch#Boolean", + "environment": { + "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host container instance (similar\n to the root user). This parameter maps to Privileged in the\n Create a container section of the Docker Remote API and the --privileged option to\n docker run.

" + "smithy.api#documentation": "

The environment variables to pass to a container. This parameter maps to Env in the\n Create a container section of the Docker Remote API and the --env option to docker run.

\n \n

We do not recommend using plaintext environment variables for sensitive information, such as credential\n data.

\n \n \n

Environment variables must not start with AWS_BATCH; this naming\n convention is reserved for variables that are set by the AWS Batch service.

\n " } }, - "image": { + "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker\n Hub registry are available by default. Other repositories are specified with\n \n repository-url/image:tag\n .\n Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of\n the Docker Remote API and the IMAGE parameter of docker\n run.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.

" } }, - "environment": { - "target": "com.amazonaws.batch#EnvironmentVariables", + "vcpus": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The environment variables to pass to a container. This parameter maps to Env in the\n Create a container section of the Docker Remote API and the --env option to docker run.

\n \n

We do not recommend using plaintext environment variables for sensitive information, such as credential\n data.

\n \n \n

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

\n " + "smithy.api#documentation": "

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\n but can be specified in several places for multi-node parallel (MNP) jobs; it must be specified for each node at\n least once.

" } }, - "instanceType": { - "target": "com.amazonaws.batch#String", + "readonlyRootFilesystem": { + "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "

The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job\n must use the same instance type. This parameter is not valid for single-node container jobs.

" + "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file system. This parameter\n maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and\n the --read-only option to docker run.

" } }, - "volumes": { - "target": "com.amazonaws.batch#Volumes", + "logConfiguration": { + "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "

A list of data volumes used in a job.

" + "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\n run. By default, containers use the same logging driver that the Docker daemon uses. However the\n container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter\n in the container definition. To use a different logging driver for a container, the log system must be configured\n properly on the container instance (or on a different log server for remote logging options). For more information\n 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).

\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\n that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed\n on that 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 " } }, - "command": { - "target": "com.amazonaws.batch#StringList", + "resourceRequirements": { + "target": "com.amazonaws.batch#ResourceRequirements", "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 type and amount of a resource to assign to a container. Currently, the only supported resource is\n GPU.

" } }, "ulimits": { "target": "com.amazonaws.batch#Ulimits", "traits": { - "smithy.api#documentation": "

A list of ulimits to set in the container. This parameter maps to Ulimits in the\n Create a container section of the Docker Remote API and the --ulimit option to docker run.

" + "smithy.api#documentation": "

A list of ulimits to set in the container. This parameter maps to Ulimits in the\n Create a container section of the Docker Remote API and the --ulimit option to docker run.

" } }, - "readonlyRootFilesystem": { - "target": "com.amazonaws.batch#Boolean", + "volumes": { + "target": "com.amazonaws.batch#Volumes", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file system. This parameter\n maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and\n the --read-only option to docker run.

" + "smithy.api#documentation": "

A list of data volumes used in a job.

" } }, - "resourceRequirements": { - "target": "com.amazonaws.batch#ResourceRequirements", + "instanceType": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The type and amount of a resource to assign to a container. Currently, the only supported resource is\n GPU.

" + "smithy.api#documentation": "

The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job\n must use the same instance type. This parameter is not valid for single-node container jobs.

" } }, - "memory": { - "target": "com.amazonaws.batch#Integer", + "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\n docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

" + } + }, + "image": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker\n Hub registry are available by default. Other repositories are specified with\n \n repository-url/image:tag\n .\n Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons,\n periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section\n of the Docker Remote API and the IMAGE parameter of docker\n run.

\n " + } + }, + "privileged": { + "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory\n specified here, the container is killed. 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 are trying to maximize your resource utilization by providing your jobs as much memory as possible for a\n particular instance type, see Memory\n Management in the AWS Batch User Guide.

\n " + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host container instance\n (similar to the root user). This parameter maps to Privileged in the\n Create a container section of the Docker Remote API and the --privileged option to\n docker run.

" } } }, "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 is launched as part of a\n job.

" } }, "com.amazonaws.batch#ContainerSummary": { "type": "structure", "members": { - "exitCode": { - "target": "com.amazonaws.batch#Integer", + "reason": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The exit code to return upon completion.

" + "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped\n container.

" } }, - "reason": { - "target": "com.amazonaws.batch#String", + "exitCode": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped\n container.

" + "smithy.api#documentation": "

The exit code to return upon completion.

" } } }, @@ -973,7 +1024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments.

\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 to use Amazon EC2 On-Demand Instances or Spot Instances in\n your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the\n Spot Instance price is below a specified 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 compute resources. This provides more compute\n resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS\n 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 does not upgrade the AMIs in a compute environment after it is created (for example, when a newer\n version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating\n system (including updates and security patches) and any additional application software or utilities that you\n install on the compute resources. To use a new AMI for your AWS Batch jobs:

\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 old compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the old compute environment.

    \n
    5. \n
\n ", + "smithy.api#documentation": "

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments.

\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 to use Amazon EC2 On-Demand Instances or Spot Instances\n in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch\n when the Spot Instance price is below a specified 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 compute resources. This provides more compute\n resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS\n 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.\n Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon\n ECS Container Instance in the Amazon Elastic Container Service Developer Guide.

\n \n

AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer\n version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating\n system (including updates and security patches) and any additional application software or utilities that you\n install on the compute resources. To use a new AMI for your AWS Batch jobs:

\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 old compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the old compute environment.

    \n
    5. \n
\n ", "smithy.api#http": { "method": "POST", "uri": "/v1/createcomputeenvironment", @@ -984,38 +1035,44 @@ "com.amazonaws.batch#CreateComputeEnvironmentRequest": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.batch#CEState", + "serviceRole": { + "target": "com.amazonaws.batch#String", "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 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\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\n service role when you create compute environments.

\n ", + "smithy.api#required": {} } }, - "serviceRole": { + "computeEnvironmentName": { "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 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 name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.

", "smithy.api#required": {} } }, - "computeResources": { - "target": "com.amazonaws.batch#ComputeResource", + "state": { + "target": "com.amazonaws.batch#CEState", "traits": { - "smithy.api#documentation": "

Details of the compute resources managed by the compute environment. This parameter is required for managed\n compute environments. For more information, see Compute Environments in the\n AWS Batch User Guide.

" + "smithy.api#documentation": "

The state of the compute environment. If the state is ENABLED, then the compute environment\n accepts jobs from a queue and can scale out automatically based on queues.

" } }, - "computeEnvironmentName": { - "target": "com.amazonaws.batch#String", + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags that you apply to the compute environment to help you categorize and organize your resources. Each\n tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General\n Reference.

\n \n

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags do not\n propagate to the underlying compute resources.

" } }, "type": { "target": "com.amazonaws.batch#CEType", "traits": { - "smithy.api#documentation": "

The type of the compute environment. For more information, see Compute Environments in the\n AWS Batch User Guide.

", + "smithy.api#documentation": "

The type of the compute environment. For more information, see Compute Environments in the\n AWS Batch User Guide.

", "smithy.api#required": {} } + }, + "computeResources": { + "target": "com.amazonaws.batch#ComputeResource", + "traits": { + "smithy.api#documentation": "

Details of the compute resources managed by the compute environment. This parameter is required for managed\n compute environments. For more information, see Compute Environments in the\n AWS Batch User Guide.

" + } } } }, @@ -1053,7 +1110,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the\n queue and assign an order of preference for the compute environments.

\n

You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs\n onto its associated compute environments. For example, if a compute environment is associated with more than one job\n queue, the job queue with a higher priority is given preference for scheduling jobs to that compute\n environment.

", + "smithy.api#documentation": "

Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to\n the queue and assign an order of preference for the compute environments.

\n

You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs\n onto its associated compute environments. For example, if a compute environment is associated with more than one\n job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute\n environment.

", "smithy.api#http": { "method": "POST", "uri": "/v1/createjobqueue", @@ -1064,32 +1121,38 @@ "com.amazonaws.batch#CreateJobQueueRequest": { "type": "structure", "members": { - "jobQueueName": { - "target": "com.amazonaws.batch#String", + "priority": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The name 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\n is determined in descending order, for example, a job queue with a priority value of 10 is given\n scheduling preference over a job queue with a priority value of 1.

", "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 execute a given job. Compute environments must be\n in 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.

", + "smithy.api#documentation": "

The set of compute environments mapped to a job queue and their order relative to each other. The job\n scheduler uses this parameter to determine which compute environment should execute a given job. Compute\n environments must be in the VALID state before you can associate them with a job queue. You can\n associate up to three compute environments with a job queue.

", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#JQState", "traits": { - "smithy.api#documentation": "

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.

" + "smithy.api#documentation": "

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the\n job queue state is DISABLED, new jobs cannot be added to the queue, but jobs already in the queue can\n finish.

" } }, - "priority": { - "target": "com.amazonaws.batch#Integer", + "jobQueueName": { + "target": "com.amazonaws.batch#String", "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 name of the job queue.

", "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.

" + } } } }, @@ -1170,7 +1233,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 is 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 terminated when you delete a job queue.

\n

It is not necessary to disassociate compute environments from a queue before submitting a\n DeleteJobQueue request.

", "smithy.api#http": { "method": "POST", "uri": "/v1/deletejobqueue", @@ -1225,7 +1288,7 @@ "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

", + "smithy.api#documentation": "

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to\n deregister.

", "smithy.api#required": {} } } @@ -1252,7 +1315,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes one or more of your compute environments.

\n

If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment\n operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances\n into.

", + "smithy.api#documentation": "

Describes one or more of your compute environments.

\n

If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment\n operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances\n into.

", "smithy.api#http": { "method": "POST", "uri": "/v1/describecomputeenvironments", @@ -1277,13 +1340,13 @@ "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 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 is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.\n When this parameter is used, DescribeComputeEnvironments only returns maxResults results in\n a single page along with a nextToken response element. The remaining results of the initial request can\n be seen by sending another DescribeComputeEnvironments request with the returned nextToken\n value. This value can be between 1 and 100. If this parameter is not used, then\n DescribeComputeEnvironments returns up to 100 results and a nextToken\n value if applicable.

" + "smithy.api#documentation": "

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated\n output. When this parameter is used, DescribeComputeEnvironments only returns maxResults\n results in a single page along with a nextToken response element. The remaining results of the\n initial request can be seen by sending another DescribeComputeEnvironments request with the returned\n nextToken value. This value can be between 1 and 100. If this\n parameter is not used, then DescribeComputeEnvironments returns up to 100 results\n and a nextToken value if applicable.

" } } } @@ -1291,17 +1354,17 @@ "com.amazonaws.batch#DescribeComputeEnvironmentsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.batch#String", - "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future DescribeComputeEnvironments request. When\n the results of a DescribeJobDefinitions request exceed maxResults, this value can be used\n to retrieve the next page of results. This value is null when there are no more results to\n return.

" - } - }, "computeEnvironments": { "target": "com.amazonaws.batch#ComputeEnvironmentDetailList", "traits": { "smithy.api#documentation": "

The list of compute environments.

" } + }, + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future DescribeComputeEnvironments request. When\n the results of a DescribeJobDefinitions request exceed maxResults, this value can be\n used to retrieve the next page of results. This value is null when there are no more results to\n return.

" + } } } }, @@ -1322,7 +1385,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only\n return job definitions that match that status.

", + "smithy.api#documentation": "

Describes a list of job definitions. You can specify a status (such as ACTIVE) to\n only return job definitions that match that status.

", "smithy.api#http": { "method": "POST", "uri": "/v1/describejobdefinitions", @@ -1344,18 +1407,6 @@ "smithy.api#documentation": "

The status with which to filter job definitions.

" } }, - "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 retrieve the next items in a list and not for other programmatic purposes.

\n " - } - }, - "maxResults": { - "target": "com.amazonaws.batch#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this\n parameter is used, DescribeJobDefinitions only returns maxResults results in a single page\n along with a nextToken response element. The remaining results of the initial request can be seen by\n sending another DescribeJobDefinitions request with the returned nextToken value. This\n value can be between 1 and 100. If this parameter is not used, then\n DescribeJobDefinitions returns up to 100 results and a nextToken value\n if applicable.

" - } - }, "jobDefinitions": { "target": "com.amazonaws.batch#StringList", "traits": { @@ -1367,6 +1418,18 @@ "traits": { "smithy.api#documentation": "

The name of the job definition to describe.

" } + }, + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated DescribeJobDefinitions\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 " + } + }, + "maxResults": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this\n parameter is used, DescribeJobDefinitions only returns maxResults results in a single\n page along with a nextToken response element. The remaining results of the initial request can be\n seen by sending another DescribeJobDefinitions request with the returned nextToken\n value. This value can be between 1 and 100. If this parameter is not used, then\n DescribeJobDefinitions returns up to 100 results and a nextToken\n value if applicable.

" + } } } }, @@ -1376,7 +1439,7 @@ "nextToken": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future DescribeJobDefinitions request. When the\n results of a DescribeJobDefinitions request exceed maxResults, this value can be used to\n retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

The nextToken value to include in a future DescribeJobDefinitions request. When the\n results of a DescribeJobDefinitions request exceed maxResults, this value can be used to\n retrieve the next page of results. This value is null when there are no more results to\n return.

" } }, "jobDefinitions": { @@ -1420,12 +1483,6 @@ "com.amazonaws.batch#DescribeJobQueuesRequest": { "type": "structure", "members": { - "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 retrieve the next items in a list and not for other programmatic purposes.

\n " - } - }, "jobQueues": { "target": "com.amazonaws.batch#StringList", "traits": { @@ -1435,7 +1492,13 @@ "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results returned by DescribeJobQueues in paginated output. When this\n parameter is used, DescribeJobQueues only returns maxResults results in a single page along\n with a nextToken response element. The remaining results of the initial request can be seen by sending\n another DescribeJobQueues request with the returned nextToken value. This value can be\n between 1 and 100. If this parameter is not used, then DescribeJobQueues\n returns up to 100 results and a nextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of results returned by DescribeJobQueues in paginated output. When this\n parameter is used, DescribeJobQueues only returns maxResults results in a single page\n along with a nextToken response element. The remaining results of the initial request can be seen by\n sending another DescribeJobQueues request with the returned nextToken value. This value\n can be between 1 and 100. If this parameter is not used, then\n DescribeJobQueues returns up to 100 results and a nextToken value if\n applicable.

" + } + }, + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated DescribeJobQueues 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\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 " } } } @@ -1446,7 +1509,7 @@ "nextToken": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future DescribeJobQueues request. When the results\n of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the\n next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

The nextToken value to include in a future DescribeJobQueues request. When the\n results of a DescribeJobQueues request exceed maxResults, this value can be used to\n retrieve the next page of results. This value is null when there are no more results to\n return.

" } }, "jobQueues": { @@ -1508,6 +1571,12 @@ "com.amazonaws.batch#Device": { "type": "structure", "members": { + "containerPath": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The path inside the container at which to expose the host device. By default the hostPath value\n is used.

" + } + }, "hostPath": { "target": "com.amazonaws.batch#String", "traits": { @@ -1518,13 +1587,7 @@ "permissions": { "target": "com.amazonaws.batch#DeviceCgroupPermissions", "traits": { - "smithy.api#documentation": "

The explicit permissions to provide to the container for the device. By default, the container has permissions\n for read, write, and mknod for the device.

" - } - }, - "containerPath": { - "target": "com.amazonaws.batch#String", - "traits": { - "smithy.api#documentation": "

The path inside the container at which to expose the host device. By default the hostPath value is\n used.

" + "smithy.api#documentation": "

The explicit permissions to provide to the container for the device. By default, the container has permissions\n for read, write, and mknod for the device.

" } } }, @@ -1575,12 +1638,12 @@ "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.

" + "smithy.api#documentation": "

The path on the host container instance that is presented to the container. If this parameter is empty, then\n the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data\n volume persists at the specified location on the host container instance until you delete it manually. If the\n source path location does not exist on the host container instance, the Docker daemon creates it. If the location\n does exist, the contents of the source path folder are exported.

" } } }, "traits": { - "smithy.api#documentation": "

Determine whether your data volume persists on the host container instance and where it is stored. If this\n parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed\n to persist after the containers associated with it stop running.

" + "smithy.api#documentation": "

Determine whether your data volume persists on the host container instance and where it is stored. If this\n parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not\n guaranteed to persist after the containers associated with it stop running.

" } }, "com.amazonaws.batch#Integer": { @@ -1635,22 +1698,16 @@ "com.amazonaws.batch#JobDefinition": { "type": "structure", "members": { - "nodeProperties": { - "target": "com.amazonaws.batch#NodeProperties", - "traits": { - "smithy.api#documentation": "

An object with various properties specific to multi-node parallel jobs.

" - } - }, "timeout": { "target": "com.amazonaws.batch#JobTimeout", "traits": { - "smithy.api#documentation": "

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout\n duration after which AWS Batch terminates your jobs if they have not finished.

" + "smithy.api#documentation": "

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout\n duration after which AWS Batch terminates your jobs if they have not finished.

" } }, - "retryStrategy": { - "target": "com.amazonaws.batch#RetryStrategy", + "parameters": { + "target": "com.amazonaws.batch#ParametersMap", "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs that are submitted with this job definition.

" + "smithy.api#documentation": "

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding\n parameter defaults from the job definition. For more information about specifying parameters, see Job Definition\n Parameters in the AWS Batch User Guide.

" } }, "jobDefinitionName": { @@ -1660,10 +1717,16 @@ "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.batch#String", + "containerProperties": { + "target": "com.amazonaws.batch#ContainerProperties", "traits": { - "smithy.api#documentation": "

The type of job definition.

", + "smithy.api#documentation": "

An object with various properties specific to container-based jobs.

" + } + }, + "revision": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The revision of the job definition.

", "smithy.api#required": {} } }, @@ -1674,29 +1737,35 @@ "smithy.api#required": {} } }, - "parameters": { - "target": "com.amazonaws.batch#ParametersMap", + "retryStrategy": { + "target": "com.amazonaws.batch#RetryStrategy", "traits": { - "smithy.api#documentation": "

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding\n parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters\n in the AWS Batch User Guide.

" + "smithy.api#documentation": "

The retry strategy to use for failed jobs that are submitted with this job definition.

" } }, - "status": { + "type": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The status of the job definition.

" + "smithy.api#documentation": "

The type of job definition.

", + "smithy.api#required": {} } }, - "containerProperties": { - "target": "com.amazonaws.batch#ContainerProperties", + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

An object with various properties specific to container-based jobs.

" + "smithy.api#documentation": "

The tags applied to the job definition.

" } }, - "revision": { - "target": "com.amazonaws.batch#Integer", + "status": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The revision of the job definition.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The status of the job definition.

" + } + }, + "nodeProperties": { + "target": "com.amazonaws.batch#NodeProperties", + "traits": { + "smithy.api#documentation": "

An object with various properties specific to multi-node parallel jobs.

" } } }, @@ -1754,31 +1823,16 @@ "com.amazonaws.batch#JobDetail": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.batch#String", - "traits": { - "smithy.api#documentation": "

The name of the job.

", - "smithy.api#required": {} - } - }, - "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.

" - } - }, - "jobDefinition": { - "target": "com.amazonaws.batch#String", + "dependsOn": { + "target": "com.amazonaws.batch#JobDependencyList", "traits": { - "smithy.api#documentation": "

The job definition that is used by this job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of job IDs on which this job depends.

" } }, - "status": { - "target": "com.amazonaws.batch#JobStatus", + "container": { + "target": "com.amazonaws.batch#ContainerDetail", "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#required": {} + "smithy.api#documentation": "

An object representing the details of the container that is associated with the job.

" } }, "arrayProperties": { @@ -1787,22 +1841,43 @@ "smithy.api#documentation": "

The array properties of the job, if it is an array job.

" } }, - "container": { - "target": "com.amazonaws.batch#ContainerDetail", + "nodeProperties": { + "target": "com.amazonaws.batch#NodeProperties", "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 node properties of a multi-node parallel job.

" } }, - "statusReason": { + "jobQueue": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job queue with which the job is associated.

", + "smithy.api#required": {} } }, - "createdAt": { + "stoppedAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "

The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent\n array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob\n was called). For array child jobs, this is when the child job was spawned by its parent and entered the\n PENDING state.

" + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the\n RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

" + } + }, + "startedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the\n STARTING state to the RUNNING state). This parameter is not provided for\n child jobs of array jobs or multi-node parallel jobs.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The name of the job.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags applied to the job.

" } }, "timeout": { @@ -1811,23 +1886,34 @@ "smithy.api#documentation": "

The timeout configuration for the job.

" } }, + "parameters": { + "target": "com.amazonaws.batch#ParametersMap", + "traits": { + "smithy.api#documentation": "

Additional parameters passed to the job that replace parameter substitution placeholders or override any\n corresponding parameter defaults from the job definition.

" + } + }, + "createdAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,\n this is when the job entered the SUBMITTED state (at the time SubmitJob\n was called). For array child jobs, this is when the child job was spawned by its parent and entered the\n PENDING state.

" + } + }, "retryStrategy": { "target": "com.amazonaws.batch#RetryStrategy", "traits": { "smithy.api#documentation": "

The retry strategy to use for this job if an attempt fails.

" } }, - "attempts": { - "target": "com.amazonaws.batch#AttemptDetails", + "jobArn": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A list of job attempts associated with this job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

" } }, - "startedAt": { - "target": "com.amazonaws.batch#Long", + "statusReason": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from\n the STARTING state to the RUNNING state).

", - "smithy.api#required": {} + "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the job.

" } }, "jobId": { @@ -1837,36 +1923,31 @@ "smithy.api#required": {} } }, - "parameters": { - "target": "com.amazonaws.batch#ParametersMap", + "nodeDetails": { + "target": "com.amazonaws.batch#NodeDetails", "traits": { - "smithy.api#documentation": "

Additional parameters passed to the job that replace parameter substitution placeholders or override any\n corresponding parameter defaults from the job definition.

" + "smithy.api#documentation": "

An object representing the details of a node that is associated with a multi-node parallel job.

" } }, - "stoppedAt": { - "target": "com.amazonaws.batch#Long", + "status": { + "target": "com.amazonaws.batch#JobStatus", "traits": { - "smithy.api#documentation": "

The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from\n the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

" + "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\n in the troubleshooting section of the AWS Batch User Guide.

\n ", + "smithy.api#required": {} } }, - "nodeProperties": { - "target": "com.amazonaws.batch#NodeProperties", + "attempts": { + "target": "com.amazonaws.batch#AttemptDetails", "traits": { - "smithy.api#documentation": "

An object representing the node properties of a multi-node parallel job.

" + "smithy.api#documentation": "

A list of job attempts associated with this job.

" } }, - "jobQueue": { + "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job queue with which the job is associated.

", + "smithy.api#documentation": "

The job definition that is used by this job.

", "smithy.api#required": {} } - }, - "dependsOn": { - "target": "com.amazonaws.batch#JobDependencyList", - "traits": { - "smithy.api#documentation": "

A list of job IDs on which this job depends.

" - } } }, "traits": { @@ -1882,17 +1963,24 @@ "com.amazonaws.batch#JobQueueDetail": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.batch#JQState", + "priority": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

Describes the ability of the queue to accept new jobs.

", + "smithy.api#documentation": "

The priority of the job queue.

", "smithy.api#required": {} } }, - "priority": { - "target": "com.amazonaws.batch#Integer", + "jobQueueArn": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The priority of the job queue.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job queue.

", + "smithy.api#required": {} + } + }, + "jobQueueName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The name of the job queue.

", "smithy.api#required": {} } }, @@ -1908,24 +1996,23 @@ "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the job queue.

" } }, - "jobQueueArn": { - "target": "com.amazonaws.batch#String", + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job queue.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags applied to the job queue.

" } }, - "jobQueueName": { - "target": "com.amazonaws.batch#String", + "computeEnvironmentOrder": { + "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#documentation": "

The name of the job queue.

", + "smithy.api#documentation": "

The compute environments that are attached to the job queue and the order in which job placement is preferred.\n Compute environments are selected for job placement in ascending order.

", "smithy.api#required": {} } }, - "computeEnvironmentOrder": { - "target": "com.amazonaws.batch#ComputeEnvironmentOrders", + "state": { + "target": "com.amazonaws.batch#JQState", "traits": { - "smithy.api#documentation": "

The compute environments that are attached to the job queue and the order in which job placement is preferred.\n Compute environments are selected for job placement in ascending order.

", + "smithy.api#documentation": "

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it is\n able to accept jobs. If the job queue state is DISABLED, new jobs cannot be added to the queue, but jobs\n already in the queue can finish.

", "smithy.api#required": {} } } @@ -1984,10 +2071,16 @@ "smithy.api#documentation": "

The current status for the job.

" } }, - "createdAt": { - "target": "com.amazonaws.batch#Long", + "arrayProperties": { + "target": "com.amazonaws.batch#ArrayPropertiesSummary", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the job\n entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs,\n this is when the child job was spawned by its parent and entered the PENDING state.

" + "smithy.api#documentation": "

The array properties of the job, if it is an array job.

" + } + }, + "jobArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

" } }, "statusReason": { @@ -1996,38 +2089,32 @@ "smithy.api#documentation": "

A short, human-readable string to provide additional details about the current status of the job.

" } }, - "nodeProperties": { - "target": "com.amazonaws.batch#NodePropertiesSummary", + "jobName": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The node properties for a single node in a job summary list.

" + "smithy.api#documentation": "

The name of the job.

", + "smithy.api#required": {} } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the job was started (when the job transitioned from the STARTING state\n to the RUNNING state).

" + "smithy.api#documentation": "

The Unix timestamp for when the job was started (when the job transitioned from the STARTING\n state to the RUNNING state).

" } }, - "jobId": { - "target": "com.amazonaws.batch#String", + "nodeProperties": { + "target": "com.amazonaws.batch#NodePropertiesSummary", "traits": { - "smithy.api#documentation": "

The ID of the job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The node properties for a single node in a job summary list.

" } }, - "jobName": { + "jobId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the job.

", + "smithy.api#documentation": "

The ID of the job.

", "smithy.api#required": {} } }, - "arrayProperties": { - "target": "com.amazonaws.batch#ArrayPropertiesSummary", - "traits": { - "smithy.api#documentation": "

The array properties of the job, if it is an array job.

" - } - }, "container": { "target": "com.amazonaws.batch#ContainerSummary", "traits": { @@ -2037,7 +2124,13 @@ "stoppedAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state\n to a terminal state, such as SUCCEEDED or FAILED).

" + "smithy.api#documentation": "

The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state\n to a terminal state, such as SUCCEEDED or FAILED).

" + } + }, + "createdAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the\n job entered the SUBMITTED state (at the time SubmitJob was called). For array child\n jobs, this is when the child job was spawned by its parent and entered the PENDING state.

" } } }, @@ -2057,7 +2150,7 @@ "attemptDurationSeconds": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The time duration in seconds (measured from the job attempt's startedAt timestamp) after which\n AWS Batch terminates your jobs if they have not finished.

" + "smithy.api#documentation": "

The time duration in seconds (measured from the job attempt's startedAt timestamp) after which\n AWS Batch terminates your jobs if they have not finished.

" } } }, @@ -2068,16 +2161,16 @@ "com.amazonaws.batch#KeyValuePair": { "type": "structure", "members": { - "value": { + "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The value of the key-value pair. For environment variables, this is the value of the environment\n variable.

" + "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the environment\n variable.

" } }, - "name": { + "value": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the environment variable.

" + "smithy.api#documentation": "

The value of the key-value pair. For environment variables, this is the value of the environment\n variable.

" } } }, @@ -2088,36 +2181,66 @@ "com.amazonaws.batch#LaunchTemplateSpecification": { "type": "structure", "members": { - "launchTemplateId": { + "launchTemplateName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

" + "smithy.api#documentation": "

The name of the launch template.

" } }, "version": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The version number of the launch template.

\n

Default: The default version of the launch template.

" + "smithy.api#documentation": "

The version number of the launch template, $Latest, or $Default.

\n

If the value is $Latest, the latest version of the launch template is used. If the value is\n $Default, the default version of the launch template is used.

\n

Default: $Default.

" } }, - "launchTemplateName": { + "launchTemplateId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the launch template.

" + "smithy.api#documentation": "

The ID of the launch template.

" } } }, "traits": { - "smithy.api#documentation": "

An object representing a launch template associated with a compute resource. You must specify either the launch\n template ID or launch template name in the request, but not both.

" + "smithy.api#documentation": "

An object representing a launch template associated with a compute resource. You must specify either the\n launch template ID or launch template name in the request, but not both.

" } }, "com.amazonaws.batch#LinuxParameters": { "type": "structure", "members": { + "initProcessEnabled": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

If true, run an init process inside the container that forwards signals and reaps processes. This\n parameter maps to the --init option to docker run.\n This parameter requires version 1.25 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

" + } + }, + "maxSwap": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the\n --memory-swap option to docker run where the value\n would be the sum of the container memory plus the maxSwap value.

\n

If a maxSwap value of 0 is specified, the container will not use swap. Accepted\n values are 0 or any positive integer. If the maxSwap parameter is omitted, the container\n will use the swap configuration for the container instance it is running on. A maxSwap value must be\n set for the swappiness parameter to be used.

" + } + }, + "sharedMemorySize": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the\n --shm-size option to docker run.

" + } + }, + "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 will cause swapping to not happen unless absolutely necessary. A swappiness value of\n 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter is not specified, a default value\n of 60 is used. If a value is not specified for maxSwap then this parameter is ignored.\n This parameter maps to the --memory-swappiness option to docker\n run.

" + } + }, "devices": { "target": "com.amazonaws.batch#DevicesList", "traits": { - "smithy.api#documentation": "

Any host devices to expose to the container. This parameter maps to Devices in the\n Create a container section of the Docker Remote API and the --device option to docker run.

" + "smithy.api#documentation": "

Any host devices to expose to the container. This parameter maps to Devices in the\n Create a container section of the Docker Remote API and the --device option to docker run.

" + } + }, + "tmpfs": { + "target": "com.amazonaws.batch#TmpfsList", + "traits": { + "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the\n --tmpfs option to docker run.

" } } }, @@ -2142,7 +2265,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of AWS Batch jobs.

\n

You must specify only one of the following:

\n \n

You can filter the results by job status with the jobStatus parameter. If you do not specify a\n status, only RUNNING jobs are returned.

", + "smithy.api#documentation": "

Returns a list of AWS Batch jobs.

\n

You must specify only one of the following:

\n \n

You can filter the results by job status with the jobStatus parameter. If you do not specify a\n status, only RUNNING jobs are returned.

", "smithy.api#http": { "method": "POST", "uri": "/v1/listjobs", @@ -2158,40 +2281,40 @@ "com.amazonaws.batch#ListJobsRequest": { "type": "structure", "members": { - "arrayJobId": { - "target": "com.amazonaws.batch#String", + "jobStatus": { + "target": "com.amazonaws.batch#JobStatus", "traits": { - "smithy.api#documentation": "

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the\n specified array.

" + "smithy.api#documentation": "

The job status with which to filter jobs in the specified queue. If you do not specify a status, only\n RUNNING jobs are returned.

" } }, "multiNodeJobId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all\n nodes that are associated with the specified job.

" + "smithy.api#documentation": "

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists\n all nodes that are associated with the specified job.

" } }, - "maxResults": { - "target": "com.amazonaws.batch#Integer", + "jobQueue": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The maximum number of results returned by ListJobs in paginated output. When this parameter is\n used, ListJobs only returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial request can be seen by sending another\n ListJobs request with the returned nextToken value. This value can be between\n 1 and 100. If this parameter is not used, then ListJobs returns up to\n 100 results and a nextToken value if applicable.

" + "smithy.api#documentation": "

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

" } }, - "jobStatus": { - "target": "com.amazonaws.batch#JobStatus", + "arrayJobId": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The job status with which to filter jobs in the specified queue. If you do not specify a status, only\n RUNNING jobs are returned.

" + "smithy.api#documentation": "

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within\n the specified array.

" } }, - "jobQueue": { - "target": "com.amazonaws.batch#String", + "maxResults": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

" + "smithy.api#documentation": "

The maximum number of results returned by ListJobs in paginated output. When this parameter is\n used, ListJobs only returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial request can be seen by sending\n another ListJobs request with the returned nextToken value. This value can be between\n 1 and 100. If this parameter is not used, then ListJobs returns up to\n 100 results and a nextToken value if applicable.

" } }, "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 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\n 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 " } } } @@ -2199,33 +2322,147 @@ "com.amazonaws.batch#ListJobsResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListJobs request. When the results of a\n ListJobs request exceed maxResults, this value can be used to retrieve the next page\n of results. This value is null when there are no more results to return.

" + } + }, "jobSummaryList": { "target": "com.amazonaws.batch#JobSummaryList", "traits": { "smithy.api#documentation": "

A list of job summaries that match the request.

", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.batch#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.batch#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" }, - "nextToken": { + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

List the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.batch#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future ListJobs request. When the results of a\n ListJobs request exceed maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } }, - "com.amazonaws.batch#Long": { - "type": "long" + "com.amazonaws.batch#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + } }, - "com.amazonaws.batch#MountPoint": { + "com.amazonaws.batch#LogConfiguration": { "type": "structure", "members": { - "readOnly": { - "target": "com.amazonaws.batch#Boolean", + "options": { + "target": "com.amazonaws.batch#LogConfigurationOptionsMap", + "traits": { + "smithy.api#documentation": "

The configuration options to send to the log driver. This parameter requires version 1.19 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

" + } + }, + "secretOptions": { + "target": "com.amazonaws.batch#SecretList", "traits": { - "smithy.api#documentation": "

If this value is true, the container has read-only access to the volume; otherwise, the container\n can write to the volume. The default value is false.

" + "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the\n AWS Batch User Guide.

" } }, + "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
\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 \n

If you have a custom driver that is not listed earlier that you would like to work with the Amazon ECS container\n agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that\n driver. We encourage you to submit pull requests for changes that you would like to have included. However,\n Amazon Web Services does not currently support running modified copies of this 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": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Log configuration options to send to a custom log driver for the container.

" + } + }, + "com.amazonaws.batch#LogConfigurationOptionsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.batch#String" + }, + "value": { + "target": "com.amazonaws.batch#String" + } + }, + "com.amazonaws.batch#LogDriver": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "json-file", + "name": "JSON_FILE" + }, + { + "value": "syslog", + "name": "SYSLOG" + }, + { + "value": "journald", + "name": "JOURNALD" + }, + { + "value": "gelf", + "name": "GELF" + }, + { + "value": "fluentd", + "name": "FLUENTD" + }, + { + "value": "awslogs", + "name": "AWSLOGS" + }, + { + "value": "splunk", + "name": "SPLUNK" + } + ] + } + }, + "com.amazonaws.batch#Long": { + "type": "long" + }, + "com.amazonaws.batch#MountPoint": { + "type": "structure", + "members": { "containerPath": { "target": "com.amazonaws.batch#String", "traits": { @@ -2237,10 +2474,16 @@ "traits": { "smithy.api#documentation": "

The name of the volume to mount.

" } + }, + "readOnly": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

If this value is true, the container has read-only access to the volume; otherwise, the container\n can write to the volume. The default value is false.

" + } } }, "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 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.

" } }, "com.amazonaws.batch#MountPoints": { @@ -2252,16 +2495,16 @@ "com.amazonaws.batch#NetworkInterface": { "type": "structure", "members": { - "ipv6Address": { + "attachmentId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The private IPv6 address for the network interface.

" + "smithy.api#documentation": "

The attachment ID for the network interface.

" } }, - "attachmentId": { + "ipv6Address": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The attachment ID for the network interface.

" + "smithy.api#documentation": "

The private IPv6 address for the network interface.

" } }, "privateIpv4Address": { @@ -2293,7 +2536,7 @@ "nodeIndex": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node with\n the AWS_BATCH_JOB_NODE_INDEX environment variable.

" + "smithy.api#documentation": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node\n with the AWS_BATCH_JOB_NODE_INDEX environment variable.

" } } }, @@ -2304,44 +2547,44 @@ "com.amazonaws.batch#NodeOverrides": { "type": "structure", "members": { - "numNodes": { - "target": "com.amazonaws.batch#Integer", - "traits": { - "smithy.api#documentation": "

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are\n specified in the job definition. To use this override:

\n " - } - }, "nodePropertyOverrides": { "target": "com.amazonaws.batch#NodePropertyOverrides", "traits": { "smithy.api#documentation": "

The node property overrides for the job.

" } + }, + "numNodes": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are\n specified in the job definition. To use this override:

\n " + } } }, "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 is used in a SubmitJob API\n operation.

" } }, "com.amazonaws.batch#NodeProperties": { "type": "structure", "members": { - "nodeRangeProperties": { - "target": "com.amazonaws.batch#NodeRangeProperties", + "numNodes": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

A list of node ranges and their properties associated with a multi-node parallel job.

", + "smithy.api#documentation": "

The number of nodes associated with a multi-node parallel job.

", "smithy.api#required": {} } }, - "mainNode": { - "target": "com.amazonaws.batch#Integer", + "nodeRangeProperties": { + "target": "com.amazonaws.batch#NodeRangeProperties", "traits": { - "smithy.api#documentation": "

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer\n than the number of nodes.

", + "smithy.api#documentation": "

A list of node ranges and their properties associated with a multi-node parallel job.

", "smithy.api#required": {} } }, - "numNodes": { + "mainNode": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The number of nodes associated with a multi-node parallel job.

", + "smithy.api#documentation": "

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer\n than the number of nodes.

", "smithy.api#required": {} } } @@ -2353,22 +2596,22 @@ "com.amazonaws.batch#NodePropertiesSummary": { "type": "structure", "members": { - "isMainNode": { - "target": "com.amazonaws.batch#Boolean", + "numNodes": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

Specifies whether the current node is the main node for a multi-node parallel job.

" + "smithy.api#documentation": "

The number of nodes associated with a multi-node parallel job.

" } }, "nodeIndex": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node with\n the AWS_BATCH_JOB_NODE_INDEX environment variable.

" + "smithy.api#documentation": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node\n with the AWS_BATCH_JOB_NODE_INDEX environment variable.

" } }, - "numNodes": { - "target": "com.amazonaws.batch#Integer", + "isMainNode": { + "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "

The number of nodes associated with a multi-node parallel job.

" + "smithy.api#documentation": "

Specifies whether the current node is the main node for a multi-node parallel job.

" } } }, @@ -2382,7 +2625,7 @@ "targetNodes": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The range of nodes, using node index values, with which to override. A range of 0:3 indicates nodes\n with index values of 0 through 3. If the starting range value is omitted (:n),\n then 0 is used to start the range. If the ending range value is omitted (n:), then the\n highest possible node index is used to end the range.

", + "smithy.api#documentation": "

The range of nodes, using node index values, with which to override. A range of 0:3 indicates\n nodes with index values of 0 through 3. If the starting range value is omitted\n (:n), then 0 is used to start the range. If the ending range value is omitted\n (n:), then the highest possible node index is used to end the range.

", "smithy.api#required": {} } }, @@ -2394,7 +2637,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 is used in a SubmitJob API\n operation.

" } }, "com.amazonaws.batch#NodePropertyOverrides": { @@ -2412,18 +2655,18 @@ "com.amazonaws.batch#NodeRangeProperty": { "type": "structure", "members": { - "container": { - "target": "com.amazonaws.batch#ContainerProperties", - "traits": { - "smithy.api#documentation": "

The container details for the node range.

" - } - }, "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 nest node\n ranges, for example 0:10 and 4:5, in which case the 4:5 range 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\n 0 is used to start the range. If the ending range value is omitted (n:), then the\n highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes\n (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the\n 0:10 properties.

", "smithy.api#required": {} } + }, + "container": { + "target": "com.amazonaws.batch#ContainerProperties", + "traits": { + "smithy.api#documentation": "

The container details for the node range.

" + } } }, "traits": { @@ -2470,45 +2713,51 @@ "nodeProperties": { "target": "com.amazonaws.batch#NodeProperties", "traits": { - "smithy.api#documentation": "

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a\n job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the\n AWS Batch User Guide. If the job definition's type parameter is\n container, then you must specify either containerProperties or\n nodeProperties.

" + "smithy.api#documentation": "

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a\n job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the\n AWS Batch User Guide. If the job definition's type parameter is\n container, then you must specify either containerProperties or\n nodeProperties.

" } }, - "containerProperties": { - "target": "com.amazonaws.batch#ContainerProperties", + "timeout": { + "target": "com.amazonaws.batch#JobTimeout", "traits": { - "smithy.api#documentation": "

An object with various properties specific to single-node container-based jobs. If the job definition's\n type parameter is container, then you must specify either containerProperties\n or nodeProperties.

" + "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 is not retried. The minimum value\n for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob\n operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the\n Amazon Elastic Container Service Developer Guide.

" } }, - "retryStrategy": { - "target": "com.amazonaws.batch#RetryStrategy", + "parameters": { + "target": "com.amazonaws.batch#ParametersMap", "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 is not retried.

" + "smithy.api#documentation": "

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a\n key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter\n defaults from the job definition.

" } }, - "type": { - "target": "com.amazonaws.batch#JobDefinitionType", - "traits": { - "smithy.api#documentation": "

The type of job definition.

", - "smithy.api#required": {} + "containerProperties": { + "target": "com.amazonaws.batch#ContainerProperties", + "traits": { + "smithy.api#documentation": "

An object with various properties specific to single-node container-based jobs. If the job definition's\n type parameter is container, then you must specify either\n containerProperties or nodeProperties.

" } }, - "parameters": { - "target": "com.amazonaws.batch#ParametersMap", + "retryStrategy": { + "target": "com.amazonaws.batch#RetryStrategy", "traits": { - "smithy.api#documentation": "

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a\n key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults\n from the job definition.

" + "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 is not retried.

" } }, "jobDefinitionName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.

", + "smithy.api#documentation": "

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.

", "smithy.api#required": {} } }, - "timeout": { - "target": "com.amazonaws.batch#JobTimeout", + "type": { + "target": "com.amazonaws.batch#JobDefinitionType", + "traits": { + "smithy.api#documentation": "

The type of job definition.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", "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 is not retried. The minimum value\n for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob\n operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the\n Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The tags that you apply to the job definition 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.

" } } } @@ -2523,17 +2772,17 @@ "smithy.api#required": {} } }, - "jobDefinitionName": { + "jobDefinitionArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the job definition.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job definition.

", "smithy.api#required": {} } }, - "jobDefinitionArn": { + "jobDefinitionName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job definition.

", + "smithy.api#documentation": "

The name of the job definition.

", "smithy.api#required": {} } } @@ -2542,23 +2791,23 @@ "com.amazonaws.batch#ResourceRequirement": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.batch#String", + "type": { + "target": "com.amazonaws.batch#ResourceType", "traits": { - "smithy.api#documentation": "

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job should not exceed the number of available GPUs on the compute resource that the job is launched on.

", + "smithy.api#documentation": "

The type of resource to assign to a container. Currently, the only supported resource type is\n GPU.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.batch#ResourceType", + "value": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The type of resource to assign to a container. Currently, the only supported resource type is\n GPU.

", + "smithy.api#documentation": "

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job should not exceed the number of available GPUs on the compute resource that the job is launched on.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The type and amount of a resource to assign to a container. Currently, the only supported resource type is\n GPU.

" + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. Currently, the only supported resource type is\n GPU.

" } }, "com.amazonaws.batch#ResourceRequirements": { @@ -2584,7 +2833,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 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\n of attempts as the value.

" } } }, @@ -2592,6 +2841,34 @@ "smithy.api#documentation": "

The retry strategy associated with a job.

" } }, + "com.amazonaws.batch#Secret": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The name of the secret.

", + "smithy.api#required": {} + } + }, + "valueFrom": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the\n full ARN of the parameter in the AWS Systems Manager Parameter Store.

\n \n

If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can\n use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full\n ARN must be specified.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing the secret to expose to your container. Secrets can be exposed to a container in the\n following ways:

\n \n

For more information, see Specifying Sensitive Data in the\n Amazon Elastic Container Service Developer Guide.

" + } + }, + "com.amazonaws.batch#SecretList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#Secret" + } + }, "com.amazonaws.batch#ServerException": { "type": "structure", "members": { @@ -2631,7 +2908,7 @@ } ], "traits": { - "smithy.api#documentation": "

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override\n parameters defined in the job definition.

", + "smithy.api#documentation": "

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override\n parameters defined in the job definition.

", "smithy.api#http": { "method": "POST", "uri": "/v1/submitjob", @@ -2642,67 +2919,73 @@ "com.amazonaws.batch#SubmitJobRequest": { "type": "structure", "members": { - "arrayProperties": { - "target": "com.amazonaws.batch#ArrayProperties", + "nodeOverrides": { + "target": "com.amazonaws.batch#NodeOverrides", "traits": { - "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and\n 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the\n AWS Batch User Guide.

" + "smithy.api#documentation": "

A list of node overrides in JSON format that specify the node range to target and the container overrides for\n that node range.

" } }, - "retryStrategy": { - "target": "com.amazonaws.batch#RetryStrategy", + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy\n is specified here, it overrides the retry strategy defined in the job definition.

" + "smithy.api#documentation": "

The tags that you apply to the job request 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.

" } }, "dependsOn": { "target": "com.amazonaws.batch#JobDependencyList", "traits": { - "smithy.api#documentation": "

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a\n SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job\n completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job\n ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each\n dependency to complete before it can begin.

" - } - }, - "parameters": { - "target": "com.amazonaws.batch#ParametersMap", - "traits": { - "smithy.api#documentation": "

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job\n definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request\n override any corresponding parameter defaults from the job definition.

" + "smithy.api#documentation": "

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a\n SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job\n completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a\n job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of\n each dependency to complete before it can begin.

" } }, "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 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\n new environment variables to it with an environment override.

" } }, - "nodeOverrides": { - "target": "com.amazonaws.batch#NodeOverrides", + "jobQueue": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A list of node overrides in JSON format that specify the node range to target and the container overrides for\n that node range.

" + "smithy.api#documentation": "

The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the\n queue.

", + "smithy.api#required": {} } }, - "jobQueue": { + "jobName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the\n queue.

", + "smithy.api#documentation": "

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and\n lowercase), numbers, hyphens, and underscores are allowed.

", "smithy.api#required": {} } }, - "jobName": { + "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.

", + "smithy.api#documentation": "

The job definition used by this job. This value can be one of name, name:revision,\n or the Amazon Resource Name (ARN) for the job definition. If\n name is specified without a revision then the latest active revision is\n used.

", "smithy.api#required": {} } }, "timeout": { "target": "com.amazonaws.batch#JobTimeout", "traits": { - "smithy.api#documentation": "

The timeout configuration for this SubmitJob operation. You can specify a timeout duration\n after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is\n not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration\n specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job.\n For more information, see Job\n Timeouts in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The timeout configuration for this SubmitJob operation. You can specify a timeout duration\n after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is\n not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout\n configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as\n the parent job. For more information, see Job Timeouts in the\n Amazon Elastic Container Service Developer Guide.

" } }, - "jobDefinition": { - "target": "com.amazonaws.batch#String", + "parameters": { + "target": "com.amazonaws.batch#ParametersMap", "traits": { - "smithy.api#documentation": "

The job definition used by this job. This value can be one of name, name:revision, or\n the Amazon Resource Name (ARN) for the job definition. If\n name is specified without a revision then the latest active revision is used.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the\n job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob\n request override any corresponding parameter defaults from the job definition.

" + } + }, + "retryStrategy": { + "target": "com.amazonaws.batch#RetryStrategy", + "traits": { + "smithy.api#documentation": "

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry\n strategy is specified here, it overrides the retry strategy defined in the job definition.

" + } + }, + "arrayProperties": { + "target": "com.amazonaws.batch#ArrayProperties", + "traits": { + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and\n 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the\n AWS Batch User Guide.

" } } } @@ -2723,6 +3006,106 @@ "smithy.api#documentation": "

The name of the job.

", "smithy.api#required": {} } + }, + "jobArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the job.

" + } + } + } + }, + "com.amazonaws.batch#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.batch#TagKeysList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.batch#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.batch#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a\n resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags\n associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.batch#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which to add tags. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags that you apply to the resource 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#required": {} + } + } + } + }, + "com.amazonaws.batch#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.batch#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.batch#TagrisTagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.batch#TagKey" + }, + "value": { + "target": "com.amazonaws.batch#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 } } }, @@ -2752,7 +3135,7 @@ } ], "traits": { - "smithy.api#documentation": "

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are\n terminated, which causes them to transition to FAILED. Jobs that have not progressed to the\n STARTING state are cancelled.

", + "smithy.api#documentation": "

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are\n terminated, which causes them to transition to FAILED. Jobs that have not progressed to the\n STARTING state are cancelled.

", "smithy.api#http": { "method": "POST", "uri": "/v1/terminatejob", @@ -2766,7 +3149,7 @@ "reason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future\n DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity\n logs.

", + "smithy.api#documentation": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future\n DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity\n logs.

", "smithy.api#required": {} } }, @@ -2783,29 +3166,63 @@ "type": "structure", "members": {} }, - "com.amazonaws.batch#Ulimit": { + "com.amazonaws.batch#Tmpfs": { "type": "structure", "members": { - "hardLimit": { - "target": "com.amazonaws.batch#Integer", + "containerPath": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The hard limit for the ulimit type.

", + "smithy.api#documentation": "

The absolute file path in the container where the tmpfs volume is to be mounted.

", "smithy.api#required": {} } }, - "softLimit": { + "mountOptions": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" |\n \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" |\n \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" |\n \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" |\n \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" |\n \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" |\n \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" |\n \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"

" + } + }, + "size": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The soft limit for the ulimit type.

", + "smithy.api#documentation": "

The size (in MiB) of the tmpfs volume.

", "smithy.api#required": {} } - }, + } + }, + "traits": { + "smithy.api#documentation": "

The container path, mount options, and size of the tmpfs mount.

" + } + }, + "com.amazonaws.batch#TmpfsList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#Tmpfs" + } + }, + "com.amazonaws.batch#Ulimit": { + "type": "structure", + "members": { "name": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#documentation": "

The type of the ulimit.

", "smithy.api#required": {} } + }, + "hardLimit": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The hard limit for the ulimit type.

", + "smithy.api#required": {} + } + }, + "softLimit": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The soft limit for the ulimit type.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2818,6 +3235,56 @@ "target": "com.amazonaws.batch#Ulimit" } }, + "com.amazonaws.batch#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.batch#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes specified tags from an AWS Batch resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.batch#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.batch#TagKeysList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to be removed.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.batch#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.batch#UpdateComputeEnvironment": { "type": "operation", "input": { @@ -2846,10 +3313,16 @@ "com.amazonaws.batch#UpdateComputeEnvironmentRequest": { "type": "structure", "members": { + "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\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\n service role when you create compute environments.

\n " + } + }, "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\n environment.

" } }, "computeEnvironment": { @@ -2859,16 +3332,10 @@ "smithy.api#required": {} } }, - "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 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 " - } - }, "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.

" } } } @@ -2876,16 +3343,16 @@ "com.amazonaws.batch#UpdateComputeEnvironmentResponse": { "type": "structure", "members": { - "computeEnvironmentName": { + "computeEnvironmentArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the compute environment.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the compute environment.

" } }, - "computeEnvironmentArn": { + "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the compute environment.

" + "smithy.api#documentation": "

The name of the compute environment.

" } } } @@ -2921,13 +3388,13 @@ "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 execute a given\n job.

" + "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 execute a given\n job.

" } }, "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\n is determined in descending order, for example, a job queue with a priority value of 10 is given\n scheduling preference over a job queue with a priority value of 1.

" } }, "jobQueue": { @@ -2940,7 +3407,7 @@ "state": { "target": "com.amazonaws.batch#JQState", "traits": { - "smithy.api#documentation": "

Describes the queue's ability to accept new jobs.

" + "smithy.api#documentation": "

Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it is able to\n accept jobs. If the job queue state is DISABLED, new jobs cannot be added to the queue, but jobs already\n in the queue can finish.

" } } } @@ -2965,16 +3432,16 @@ "com.amazonaws.batch#Volume": { "type": "structure", "members": { - "host": { - "target": "com.amazonaws.batch#Host", + "name": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The contents of the host parameter determine whether your data volume persists on the host\n container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path\n for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop\n running.

" + "smithy.api#documentation": "

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are\n allowed. This name is referenced in the sourceVolume\n parameter of container definition mountPoints.

" } }, - "name": { - "target": "com.amazonaws.batch#String", + "host": { + "target": "com.amazonaws.batch#Host", "traits": { - "smithy.api#documentation": "

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume\n parameter of container definition mountPoints.

" + "smithy.api#documentation": "

The contents of the host parameter determine whether your data volume persists on the host\n container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host\n path for your data volume. However, the data is not guaranteed to persist after the containers associated with it\n stop running.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json b/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json index efc920b8aed8..26c37f1244b0 100644 --- a/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json +++ b/codegen/sdk-codegen/aws-models/budgets.2016-10-20.json @@ -36,6 +36,9 @@ { "target": "com.amazonaws.budgets#CreateBudget" }, + { + "target": "com.amazonaws.budgets#CreateBudgetAction" + }, { "target": "com.amazonaws.budgets#CreateNotification" }, @@ -45,6 +48,9 @@ { "target": "com.amazonaws.budgets#DeleteBudget" }, + { + "target": "com.amazonaws.budgets#DeleteBudgetAction" + }, { "target": "com.amazonaws.budgets#DeleteNotification" }, @@ -54,6 +60,18 @@ { "target": "com.amazonaws.budgets#DescribeBudget" }, + { + "target": "com.amazonaws.budgets#DescribeBudgetAction" + }, + { + "target": "com.amazonaws.budgets#DescribeBudgetActionHistories" + }, + { + "target": "com.amazonaws.budgets#DescribeBudgetActionsForAccount" + }, + { + "target": "com.amazonaws.budgets#DescribeBudgetActionsForBudget" + }, { "target": "com.amazonaws.budgets#DescribeBudgetPerformanceHistory" }, @@ -66,9 +84,15 @@ { "target": "com.amazonaws.budgets#DescribeSubscribersForNotification" }, + { + "target": "com.amazonaws.budgets#ExecuteBudgetAction" + }, { "target": "com.amazonaws.budgets#UpdateBudget" }, + { + "target": "com.amazonaws.budgets#UpdateBudgetAction" + }, { "target": "com.amazonaws.budgets#UpdateNotification" }, @@ -101,7 +125,7 @@ "traits": { "smithy.api#documentation": "

You are not authorized to use this operation with the given parameters.

", "smithy.api#error": "client", - "smithy.api#httpError": 401 + "smithy.api#httpError": 403 } }, "com.amazonaws.budgets#AccountId": { @@ -115,292 +139,561 @@ "smithy.api#pattern": "\\d{12}" } }, - "com.amazonaws.budgets#Budget": { + "com.amazonaws.budgets#Action": { "type": "structure", "members": { - "CostTypes": { - "target": "com.amazonaws.budgets#CostTypes", + "Definition": { + "target": "com.amazonaws.budgets#Definition", "traits": { - "smithy.api#documentation": "

The types of costs that are included in this COST budget.

\n\t\t

\n USAGE, RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets do not have CostTypes.

" + "smithy.api#documentation": "

\n\t\t\tWhere you specify all of the type-specific parameters.\n\t\t

", + "smithy.api#required": {} } }, - "TimeUnit": { - "target": "com.amazonaws.budgets#TimeUnit", + "ApprovalModel": { + "target": "com.amazonaws.budgets#ApprovalModel", "traits": { - "smithy.api#documentation": "

The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets.

", + "smithy.api#documentation": "

\n\t\t\tThis specifies if the action needs manual or automatic approval.\n\t\t

", "smithy.api#required": {} } }, - "CostFilters": { - "target": "com.amazonaws.budgets#CostFilters", + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", "traits": { - "smithy.api#documentation": "

The cost filters, such as service or tag, that are applied to a budget.

\n\t\t

AWS Budgets supports the following services as a filter for RI budgets:

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tA system-generated universally unique identifier (UUID) for the action.\n\t\t

", + "smithy.api#required": {} } }, - "CalculatedSpend": { - "target": "com.amazonaws.budgets#CalculatedSpend", + "Subscribers": { + "target": "com.amazonaws.budgets#Subscribers", "traits": { - "smithy.api#documentation": "

The actual and forecasted cost or usage that the budget tracks.

" + "smithy.api#required": {} } }, - "LastUpdatedTime": { - "target": "com.amazonaws.budgets#GenericTimestamp", + "ActionType": { + "target": "com.amazonaws.budgets#ActionType", "traits": { - "smithy.api#documentation": "

The last time that you updated this budget.

" + "smithy.api#documentation": "

\n\t\t\tThe type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.\n\t\t

", + "smithy.api#required": {} } }, - "PlannedBudgetLimits": { - "target": "com.amazonaws.budgets#PlannedBudgetLimits", + "ExecutionRoleArn": { + "target": "com.amazonaws.budgets#RoleArn", "traits": { - "smithy.api#documentation": "

A map containing multiple BudgetLimit, including current or future limits.

\n\t\t

\n PlannedBudgetLimits is available for cost or usage budget and supports monthly and quarterly TimeUnit.

\n\t\t

For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

\n\t\t

For quarterly budgets, provide 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.

\n\t\t

If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

\n\t\t

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

\n\t\t

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

\n\t\t

\n DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.

" + "smithy.api#documentation": "

\n\t\t\tThe role passed for action execution and reversion. Roles and actions must be in the same account.\n\t\t

", + "smithy.api#required": {} } }, - "BudgetName": { - "target": "com.amazonaws.budgets#BudgetName", + "Status": { + "target": "com.amazonaws.budgets#ActionStatus", "traits": { - "smithy.api#documentation": "

The name of a budget. The name must be unique within an account. The : and \\ characters aren't allowed in BudgetName.

", + "smithy.api#documentation": "

\n\t\t\tThe status of action.\n\t\t

", "smithy.api#required": {} } }, - "BudgetLimit": { - "target": "com.amazonaws.budgets#Spend", + "NotificationType": { + "target": "com.amazonaws.budgets#NotificationType", "traits": { - "smithy.api#documentation": "

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

\n\t\t

\n BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

" + "smithy.api#required": {} } }, - "TimePeriod": { - "target": "com.amazonaws.budgets#TimePeriod", + "ActionThreshold": { + "target": "com.amazonaws.budgets#ActionThreshold", "traits": { - "smithy.api#documentation": "

The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.

\n\t\t

If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

\n\t\t

You can change either date with the UpdateBudget operation.

\n\t\t

After the end date, AWS deletes the budget and all associated notifications and subscribers.

" + "smithy.api#documentation": "

\n\t\t\tThe trigger threshold of the action.\n\t\t

", + "smithy.api#required": {} } }, - "BudgetType": { - "target": "com.amazonaws.budgets#BudgetType", + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "

Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

\n\t\t

This is the ARN pattern for a budget:

\n\t\t

\n arn:aws:budgetservice::AccountId:budget/budgetName\n

" + "smithy.api#documentation": "

\n\t\t\tA budget action resource.\n\t\t

" } }, - "com.amazonaws.budgets#BudgetName": { - "type": "string", + "com.amazonaws.budgets#ActionHistories": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#ActionHistory" + }, "traits": { - "smithy.api#documentation": "

A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.

", "smithy.api#length": { - "min": 1, + "min": 0, "max": 100 - }, - "smithy.api#pattern": "[^:\\\\]+" + } } }, - "com.amazonaws.budgets#BudgetPerformanceHistory": { + "com.amazonaws.budgets#ActionHistory": { "type": "structure", "members": { - "BudgetName": { - "target": "com.amazonaws.budgets#BudgetName" - }, - "BudgetedAndActualAmountsList": { - "target": "com.amazonaws.budgets#BudgetedAndActualAmountsList", + "Status": { + "target": "com.amazonaws.budgets#ActionStatus", "traits": { - "smithy.api#documentation": "

A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.

" + "smithy.api#documentation": "

\n\t\t\tThe status of action at the time of the event.\n\t\t

", + "smithy.api#required": {} } }, - "TimeUnit": { - "target": "com.amazonaws.budgets#TimeUnit" + "EventType": { + "target": "com.amazonaws.budgets#EventType", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThis distinguishes between whether the events are triggered by the user or generated by the system.\n\t\t

", + "smithy.api#required": {} + } }, - "CostFilters": { - "target": "com.amazonaws.budgets#CostFilters", + "ActionHistoryDetails": { + "target": "com.amazonaws.budgets#ActionHistoryDetails", "traits": { - "smithy.api#documentation": "

The history of the cost filters for a budget during the specified time period.

" + "smithy.api#documentation": "

\n\t\t\tThe description of details of the event.\n\t\t

", + "smithy.api#required": {} } }, - "CostTypes": { - "target": "com.amazonaws.budgets#CostTypes", + "Timestamp": { + "target": "com.amazonaws.budgets#GenericTimestamp", "traits": { - "smithy.api#documentation": "

The history of the cost types for a budget during the specified time period.

" + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe historical records for a budget action.\n\t\t

" + } + }, + "com.amazonaws.budgets#ActionHistoryDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.budgets#Action", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe budget action resource.\n\t\t

", + "smithy.api#required": {} } }, - "BudgetType": { - "target": "com.amazonaws.budgets#BudgetType" + "Message": { + "target": "com.amazonaws.budgets#GenericString", + "traits": { + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "

A history of the state of a budget at the end of the budget's specified time period.

" + "smithy.api#documentation": "

\n\t\t\tThe description of details of the event.\n\t\t

" } }, - "com.amazonaws.budgets#BudgetType": { + "com.amazonaws.budgets#ActionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "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.budgets#ActionStatus": { "type": "string", "traits": { - "smithy.api#documentation": "

The type of a budget. It must be one of the following types:

\n\t\t

\n COST, USAGE, RI_UTILIZATION, or RI_COVERAGE.

", "smithy.api#enum": [ { - "value": "USAGE", - "name": "Usage" + "value": "STANDBY", + "name": "Standby" }, { - "value": "COST", - "name": "Cost" + "value": "PENDING", + "name": "Pending" }, { - "value": "RI_UTILIZATION", - "name": "RIUtilization" + "value": "EXECUTION_IN_PROGRESS", + "name": "Execution_In_Progress" }, { - "value": "RI_COVERAGE", - "name": "RICoverage" + "value": "EXECUTION_SUCCESS", + "name": "Execution_Success" }, { - "value": "SAVINGS_PLANS_UTILIZATION", - "name": "SPUtilization" + "value": "EXECUTION_FAILURE", + "name": "Execution_Failure" }, { - "value": "SAVINGS_PLANS_COVERAGE", - "name": "SPCoverage" + "value": "REVERSE_IN_PROGRESS", + "name": "Reverse_In_Progress" + }, + { + "value": "REVERSE_SUCCESS", + "name": "Reverse_Success" + }, + { + "value": "REVERSE_FAILURE", + "name": "Reverse_Failure" + }, + { + "value": "RESET_IN_PROGRESS", + "name": "Reset_In_Progress" + }, + { + "value": "RESET_FAILURE", + "name": "Reset_Failure" } ] } }, - "com.amazonaws.budgets#BudgetedAndActualAmounts": { - "type": "structure", - "members": { - "ActualAmount": { - "target": "com.amazonaws.budgets#Spend", - "traits": { - "smithy.api#documentation": "

Your actual costs or usage for a budget period.

" - } - }, - "BudgetedAmount": { - "target": "com.amazonaws.budgets#Spend", - "traits": { - "smithy.api#documentation": "

The amount of cost or usage that you created the budget for.

" - } - }, - "TimePeriod": { - "target": "com.amazonaws.budgets#TimePeriod", - "traits": { - "smithy.api#documentation": "

The time period covered by this budget comparison.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The amount of cost or usage that you created the budget for, compared to your actual costs or usage.

" - } - }, - "com.amazonaws.budgets#BudgetedAndActualAmountsList": { - "type": "list", - "member": { - "target": "com.amazonaws.budgets#BudgetedAndActualAmounts" - } - }, - "com.amazonaws.budgets#Budgets": { - "type": "list", - "member": { - "target": "com.amazonaws.budgets#Budget" - }, + "com.amazonaws.budgets#ActionSubType": { + "type": "string", "traits": { - "smithy.api#documentation": "

A list of budgets.

" + "smithy.api#enum": [ + { + "value": "STOP_EC2_INSTANCES", + "name": "STOP_EC2" + }, + { + "value": "STOP_RDS_INSTANCES", + "name": "STOP_RDS" + } + ] } }, - "com.amazonaws.budgets#CalculatedSpend": { + "com.amazonaws.budgets#ActionThreshold": { "type": "structure", "members": { - "ForecastedSpend": { - "target": "com.amazonaws.budgets#Spend", + "ActionThresholdValue": { + "target": "com.amazonaws.budgets#NotificationThreshold", "traits": { - "smithy.api#documentation": "

The amount of cost, usage, or RI units that you are forecasted to use.

" + "smithy.api#required": {} } }, - "ActualSpend": { - "target": "com.amazonaws.budgets#Spend", + "ActionThresholdType": { + "target": "com.amazonaws.budgets#ThresholdType", "traits": { - "smithy.api#documentation": "

The amount of cost, usage, or RI units that you have used.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, or RI units, and the forecastedSpend tracks how much you are predicted to spend if your current usage remains steady.

\n\t\t

For example, if it is the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.

" + "smithy.api#documentation": "

\n\t\t\tThe trigger threshold of the action.\n\t\t

" } }, - "com.amazonaws.budgets#ComparisonOperator": { + "com.amazonaws.budgets#ActionType": { "type": "string", "traits": { - "smithy.api#documentation": "

The comparison operator of a notification. Currently the service supports the following operators:

\n\t\t

\n GREATER_THAN, LESS_THAN, EQUAL_TO\n

", "smithy.api#enum": [ { - "value": "GREATER_THAN", - "name": "GREATER_THAN" + "value": "APPLY_IAM_POLICY", + "name": "IAM" }, { - "value": "LESS_THAN", - "name": "LESS_THAN" + "value": "APPLY_SCP_POLICY", + "name": "SCP" }, { - "value": "EQUAL_TO", - "name": "EQUAL_TO" + "value": "RUN_SSM_DOCUMENTS", + "name": "SSM" } ] } }, - "com.amazonaws.budgets#CostFilters": { - "type": "map", - "key": { - "target": "com.amazonaws.budgets#GenericString" - }, - "value": { - "target": "com.amazonaws.budgets#DimensionValues" + "com.amazonaws.budgets#Actions": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#Action" }, "traits": { - "smithy.api#documentation": "

A map that represents the cost filters that are applied to the budget.

" + "smithy.api#length": { + "min": 0, + "max": 100 + } } }, - "com.amazonaws.budgets#CostTypes": { + "com.amazonaws.budgets#ApprovalModel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AUTOMATIC", + "name": "AUTO" + }, + { + "value": "MANUAL", + "name": "MANUAL" + } + ] + } + }, + "com.amazonaws.budgets#Budget": { "type": "structure", "members": { - "IncludeUpfront": { - "target": "com.amazonaws.budgets#NullableBoolean", + "CalculatedSpend": { + "target": "com.amazonaws.budgets#CalculatedSpend", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes upfront RI costs.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

The actual and forecasted cost or usage that the budget tracks.

" } }, - "IncludeSubscription": { - "target": "com.amazonaws.budgets#NullableBoolean", + "PlannedBudgetLimits": { + "target": "com.amazonaws.budgets#PlannedBudgetLimits", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes subscriptions.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

A map containing multiple BudgetLimit, including current or future limits.

\n\t\t

\n PlannedBudgetLimits is available for cost or usage budget and supports monthly and quarterly TimeUnit.

\n\t\t

For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

\n\t\t

For quarterly budgets, provide 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.

\n\t\t

If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

\n\t\t

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

\n\t\t

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

\n\t\t

\n DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.

" } }, - "IncludeCredit": { - "target": "com.amazonaws.budgets#NullableBoolean", + "TimeUnit": { + "target": "com.amazonaws.budgets#TimeUnit", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes credits.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

The length of time until a budget resets the actual and forecasted spend.

", + "smithy.api#required": {} } }, - "IncludeDiscount": { - "target": "com.amazonaws.budgets#NullableBoolean", + "TimePeriod": { + "target": "com.amazonaws.budgets#TimePeriod", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes discounts.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.

\n\t\t

If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

\n\t\t

You can change either date with the UpdateBudget operation.

\n\t\t

After the end date, AWS deletes the budget and all associated notifications and subscribers.

" } }, - "IncludeRefund": { - "target": "com.amazonaws.budgets#NullableBoolean", + "BudgetType": { + "target": "com.amazonaws.budgets#BudgetType", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes refunds.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

", + "smithy.api#required": {} } }, - "IncludeRecurring": { - "target": "com.amazonaws.budgets#NullableBoolean", + "BudgetLimit": { + "target": "com.amazonaws.budgets#Spend", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes recurring fees such as monthly RI fees.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

\n\t\t

\n BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

" } }, - "UseAmortized": { + "CostFilters": { + "target": "com.amazonaws.budgets#CostFilters", + "traits": { + "smithy.api#documentation": "

The cost filters, such as service or tag, that are applied to a budget.

\n\t\t

AWS Budgets supports the following services as a filter for RI budgets:

\n\t\t " + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#documentation": "

The name of a budget. The name must be unique within an account. The : and \\ characters aren't allowed in BudgetName.

", + "smithy.api#required": {} + } + }, + "CostTypes": { + "target": "com.amazonaws.budgets#CostTypes", + "traits": { + "smithy.api#documentation": "

The types of costs that are included in this COST budget.

\n\t\t

\n USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.budgets#GenericTimestamp", + "traits": { + "smithy.api#documentation": "

The last time that you updated this budget.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

\n\t\t

This is the ARN pattern for a budget:

\n\t\t

\n arn:aws:budgets::AccountId:budget/budgetName\n

" + } + }, + "com.amazonaws.budgets#BudgetName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "[^:\\\\]+" + } + }, + "com.amazonaws.budgets#BudgetPerformanceHistory": { + "type": "structure", + "members": { + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName" + }, + "BudgetedAndActualAmountsList": { + "target": "com.amazonaws.budgets#BudgetedAndActualAmountsList", + "traits": { + "smithy.api#documentation": "

A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.

" + } + }, + "BudgetType": { + "target": "com.amazonaws.budgets#BudgetType" + }, + "CostTypes": { + "target": "com.amazonaws.budgets#CostTypes", + "traits": { + "smithy.api#documentation": "

The history of the cost types for a budget during the specified time period.

" + } + }, + "TimeUnit": { + "target": "com.amazonaws.budgets#TimeUnit" + }, + "CostFilters": { + "target": "com.amazonaws.budgets#CostFilters", + "traits": { + "smithy.api#documentation": "

The history of the cost filters for a budget during the specified time period.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A history of the state of a budget at the end of the budget's specified time period.

" + } + }, + "com.amazonaws.budgets#BudgetType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The type of a budget. It must be one of the following types:

\n\t\t

\n COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.

", + "smithy.api#enum": [ + { + "value": "USAGE", + "name": "Usage" + }, + { + "value": "COST", + "name": "Cost" + }, + { + "value": "RI_UTILIZATION", + "name": "RIUtilization" + }, + { + "value": "RI_COVERAGE", + "name": "RICoverage" + }, + { + "value": "SAVINGS_PLANS_UTILIZATION", + "name": "SPUtilization" + }, + { + "value": "SAVINGS_PLANS_COVERAGE", + "name": "SPCoverage" + } + ] + } + }, + "com.amazonaws.budgets#BudgetedAndActualAmounts": { + "type": "structure", + "members": { + "TimePeriod": { + "target": "com.amazonaws.budgets#TimePeriod", + "traits": { + "smithy.api#documentation": "

The time period covered by this budget comparison.

" + } + }, + "BudgetedAmount": { + "target": "com.amazonaws.budgets#Spend", + "traits": { + "smithy.api#documentation": "

The amount of cost or usage that you created the budget for.

" + } + }, + "ActualAmount": { + "target": "com.amazonaws.budgets#Spend", + "traits": { + "smithy.api#documentation": "

Your actual costs or usage for a budget period.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The amount of cost or usage that you created the budget for, compared to your actual costs or usage.

" + } + }, + "com.amazonaws.budgets#BudgetedAndActualAmountsList": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#BudgetedAndActualAmounts" + } + }, + "com.amazonaws.budgets#Budgets": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#Budget" + }, + "traits": { + "smithy.api#documentation": "

A list of budgets.

" + } + }, + "com.amazonaws.budgets#CalculatedSpend": { + "type": "structure", + "members": { + "ActualSpend": { + "target": "com.amazonaws.budgets#Spend", + "traits": { + "smithy.api#documentation": "

The amount of cost, usage, RI units, or Savings Plans units that you have used.

", + "smithy.api#required": {} + } + }, + "ForecastedSpend": { + "target": "com.amazonaws.budgets#Spend", + "traits": { + "smithy.api#documentation": "

The amount of cost, usage, RI units, or Savings Plans units that you are forecasted to use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much you are predicted to spend based on your historical usage profile.

\n\t\t

For example, if it is the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.

" + } + }, + "com.amazonaws.budgets#ComparisonOperator": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The comparison operator of a notification. Currently the service supports the following operators:

\n\t\t

\n GREATER_THAN, LESS_THAN, EQUAL_TO\n

", + "smithy.api#enum": [ + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + } + ] + } + }, + "com.amazonaws.budgets#CostFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.budgets#GenericString" + }, + "value": { + "target": "com.amazonaws.budgets#DimensionValues" + }, + "traits": { + "smithy.api#documentation": "

A map that represents the cost filters that are applied to the budget.

" + } + }, + "com.amazonaws.budgets#CostTypes": { + "type": "structure", + "members": { + "IncludeDiscount": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget uses the amortized rate.

\n\t\t

The default value is false.

" + "smithy.api#documentation": "

Specifies whether a budget includes discounts.

\n\t\t

The default value is true.

" + } + }, + "IncludeCredit": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget includes credits.

\n\t\t

The default value is true.

" + } + }, + "IncludeRefund": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget includes refunds.

\n\t\t

The default value is true.

" + } + }, + "IncludeUpfront": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget includes upfront RI costs.

\n\t\t

The default value is true.

" + } + }, + "UseBlended": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget uses a blended rate.

\n\t\t

The default value is false.

" } }, "IncludeOtherSubscription": { @@ -409,110 +702,616 @@ "smithy.api#documentation": "

Specifies whether a budget includes non-RI subscription costs.

\n\t\t

The default value is true.

" } }, + "IncludeTax": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget includes taxes.

\n\t\t

The default value is true.

" + } + }, + "UseAmortized": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget uses the amortized rate.

\n\t\t

The default value is false.

" + } + }, + "IncludeRecurring": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget includes recurring fees such as monthly RI fees.

\n\t\t

The default value is true.

" + } + }, "IncludeSupport": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes support subscription fees.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes support subscription fees.

\n\t\t

The default value is true.

" + } + }, + "IncludeSubscription": { + "target": "com.amazonaws.budgets#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a budget includes subscriptions.

\n\t\t

The default value is true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The types of cost that are included in a COST budget, such as tax and subscriptions.

\n\t\t

\n USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

" + } + }, + "com.amazonaws.budgets#CreateBudget": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#CreateBudgetRequest" + }, + "output": { + "target": "com.amazonaws.budgets#CreateBudgetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#CreationLimitExceededException" + }, + { + "target": "com.amazonaws.budgets#DuplicateRecordException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a budget and, if included, notifications and subscribers.

\n\t\t \n\t\t\t

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n\t\t " + } + }, + "com.amazonaws.budgets#CreateBudgetAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#CreateBudgetActionRequest" + }, + "output": { + "target": "com.amazonaws.budgets#CreateBudgetActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#CreationLimitExceededException" + }, + { + "target": "com.amazonaws.budgets#DuplicateRecordException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates a budget action.\n

" + } + }, + "com.amazonaws.budgets#CreateBudgetActionRequest": { + "type": "structure", + "members": { + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } + }, + "NotificationType": { + "target": "com.amazonaws.budgets#NotificationType", + "traits": { + "smithy.api#required": {} + } + }, + "ActionThreshold": { + "target": "com.amazonaws.budgets#ActionThreshold", + "traits": { + "smithy.api#required": {} + } + }, + "Subscribers": { + "target": "com.amazonaws.budgets#Subscribers", + "traits": { + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } + }, + "ActionType": { + "target": "com.amazonaws.budgets#ActionType", + "traits": { + "smithy.api#documentation": "

\n The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.\n

", + "smithy.api#required": {} + } + }, + "ApprovalModel": { + "target": "com.amazonaws.budgets#ApprovalModel", + "traits": { + "smithy.api#documentation": "

\n This specifies if the action needs manual or automatic approval.\n

", + "smithy.api#required": {} + } + }, + "Definition": { + "target": "com.amazonaws.budgets#Definition", + "traits": { + "smithy.api#required": {} + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.budgets#RoleArn", + "traits": { + "smithy.api#documentation": "

\n The role passed for action execution and reversion. Roles and actions must be in the same account.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.budgets#CreateBudgetActionResponse": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } + }, + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", + "traits": { + "smithy.api#documentation": "

\n A system-generated universally unique identifier (UUID) for the action.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.budgets#CreateBudgetRequest": { + "type": "structure", + "members": { + "NotificationsWithSubscribers": { + "target": "com.amazonaws.budgets#NotificationWithSubscribersList", + "traits": { + "smithy.api#documentation": "

A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.

" + } + }, + "Budget": { + "target": "com.amazonaws.budgets#Budget", + "traits": { + "smithy.api#documentation": "

The budget object that you want to create.

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#documentation": "

The accountId that is associated with the budget.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request of CreateBudget

" + } + }, + "com.amazonaws.budgets#CreateBudgetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Response of CreateBudget

" + } + }, + "com.amazonaws.budgets#CreateNotification": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#CreateNotificationRequest" + }, + "output": { + "target": "com.amazonaws.budgets#CreateNotificationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#CreationLimitExceededException" + }, + { + "target": "com.amazonaws.budgets#DuplicateRecordException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a notification. You must create the budget before you create the associated notification.

" + } + }, + "com.amazonaws.budgets#CreateNotificationRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#documentation": "

The accountId that is associated with the budget that you want to create a notification for.

", + "smithy.api#required": {} + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#documentation": "

The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.

", + "smithy.api#required": {} + } + }, + "Subscribers": { + "target": "com.amazonaws.budgets#Subscribers", + "traits": { + "smithy.api#documentation": "

A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.

", + "smithy.api#required": {} + } + }, + "Notification": { + "target": "com.amazonaws.budgets#Notification", + "traits": { + "smithy.api#documentation": "

The notification that you want to create.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request of CreateNotification

" + } + }, + "com.amazonaws.budgets#CreateNotificationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Response of CreateNotification

" + } + }, + "com.amazonaws.budgets#CreateSubscriber": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#CreateSubscriberRequest" + }, + "output": { + "target": "com.amazonaws.budgets#CreateSubscriberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#CreationLimitExceededException" + }, + { + "target": "com.amazonaws.budgets#DuplicateRecordException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

" + } + }, + "com.amazonaws.budgets#CreateSubscriberRequest": { + "type": "structure", + "members": { + "Notification": { + "target": "com.amazonaws.budgets#Notification", + "traits": { + "smithy.api#documentation": "

The notification that you want to create a subscriber for.

", + "smithy.api#required": {} + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#documentation": "

The name of the budget that you want to subscribe to. Budget names must be unique within an account.

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#documentation": "

The accountId that is associated with the budget that you want to create a subscriber for.

", + "smithy.api#required": {} + } + }, + "Subscriber": { + "target": "com.amazonaws.budgets#Subscriber", + "traits": { + "smithy.api#documentation": "

The subscriber that you want to associate with a budget notification.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request of CreateSubscriber

" + } + }, + "com.amazonaws.budgets#CreateSubscriberResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Response of CreateSubscriber

" + } + }, + "com.amazonaws.budgets#CreationLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.budgets#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've exceeded the notification or subscriber limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 405 + } + }, + "com.amazonaws.budgets#Definition": { + "type": "structure", + "members": { + "IamActionDefinition": { + "target": "com.amazonaws.budgets#IamActionDefinition", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe AWS Identity and Access Management (IAM) action definition details.\n\t\t

" } }, - "UseBlended": { - "target": "com.amazonaws.budgets#NullableBoolean", + "SsmActionDefinition": { + "target": "com.amazonaws.budgets#SsmActionDefinition", "traits": { - "smithy.api#documentation": "

Specifies whether a budget uses a blended rate.

\n\t\t

The default value is false.

" + "smithy.api#documentation": "

\n\t\t\tThe AWS Systems Manager (SSM) action definition details.\n\t\t

" } }, - "IncludeTax": { - "target": "com.amazonaws.budgets#NullableBoolean", + "ScpActionDefinition": { + "target": "com.amazonaws.budgets#ScpActionDefinition", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes taxes.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

\n\t\t\tThe service control policies (SCPs) action definition details.\n\t\t

" } } }, "traits": { - "smithy.api#documentation": "

The types of cost that are included in a COST budget, such as tax and subscriptions.

\n\t\t

\n USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes.

" + "smithy.api#documentation": "

\n\t\t\tSpecifies all of the type-specific parameters.\n\t\t

" } }, - "com.amazonaws.budgets#CreateBudget": { + "com.amazonaws.budgets#DeleteBudget": { "type": "operation", "input": { - "target": "com.amazonaws.budgets#CreateBudgetRequest" + "target": "com.amazonaws.budgets#DeleteBudgetRequest" }, "output": { - "target": "com.amazonaws.budgets#CreateBudgetResponse" + "target": "com.amazonaws.budgets#DeleteBudgetResponse" }, "errors": [ { "target": "com.amazonaws.budgets#AccessDeniedException" }, { - "target": "com.amazonaws.budgets#CreationLimitExceededException" + "target": "com.amazonaws.budgets#InternalErrorException" }, { - "target": "com.amazonaws.budgets#DuplicateRecordException" + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a budget. You can delete your budget at any time.

\n\t\t \n\t\t\t

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

\n\t\t " + } + }, + "com.amazonaws.budgets#DeleteBudgetAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#DeleteBudgetActionRequest" + }, + "output": { + "target": "com.amazonaws.budgets#DeleteBudgetActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" }, { "target": "com.amazonaws.budgets#InternalErrorException" }, { "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ResourceLockedException" } ], "traits": { - "smithy.api#documentation": "

Creates a budget and, if included, notifications and subscribers.

\n\t\t \n\t\t\t

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n\t\t " + "smithy.api#documentation": "

\n Deletes a budget action.\n

" } }, - "com.amazonaws.budgets#CreateBudgetRequest": { + "com.amazonaws.budgets#DeleteBudgetActionRequest": { "type": "structure", "members": { - "NotificationsWithSubscribers": { - "target": "com.amazonaws.budgets#NotificationWithSubscribersList", + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "

A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.

" + "smithy.api#required": {} } }, - "Budget": { - "target": "com.amazonaws.budgets#Budget", + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", "traits": { - "smithy.api#documentation": "

The budget object that you want to create.

", + "smithy.api#documentation": "

\n A system-generated universally unique identifier (UUID) for the action.\n

", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.budgets#DeleteBudgetActionResponse": { + "type": "structure", + "members": { + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.budgets#Action", + "traits": { + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.budgets#DeleteBudgetRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#documentation": "

The accountId that is associated with the budget that you want to delete.

", + "smithy.api#required": {} + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#documentation": "

The name of the budget that you want to delete.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Request of CreateBudget

" + "smithy.api#documentation": "

Request of DeleteBudget

" } }, - "com.amazonaws.budgets#CreateBudgetResponse": { + "com.amazonaws.budgets#DeleteBudgetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of CreateBudget

" + "smithy.api#documentation": "

Response of DeleteBudget

" } }, - "com.amazonaws.budgets#CreateNotification": { + "com.amazonaws.budgets#DeleteNotification": { "type": "operation", "input": { - "target": "com.amazonaws.budgets#CreateNotificationRequest" + "target": "com.amazonaws.budgets#DeleteNotificationRequest" }, "output": { - "target": "com.amazonaws.budgets#CreateNotificationResponse" + "target": "com.amazonaws.budgets#DeleteNotificationResponse" }, "errors": [ { "target": "com.amazonaws.budgets#AccessDeniedException" }, { - "target": "com.amazonaws.budgets#CreationLimitExceededException" + "target": "com.amazonaws.budgets#InternalErrorException" }, { - "target": "com.amazonaws.budgets#DuplicateRecordException" + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a notification.

\n\t\t \n\t\t\t

Deleting a notification also deletes the subscribers that are associated with the notification.

\n\t\t " + } + }, + "com.amazonaws.budgets#DeleteNotificationRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#documentation": "

The accountId that is associated with the budget whose notification you want to delete.

", + "smithy.api#required": {} + } + }, + "Notification": { + "target": "com.amazonaws.budgets#Notification", + "traits": { + "smithy.api#documentation": "

The notification that you want to delete.

", + "smithy.api#required": {} + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#documentation": "

The name of the budget whose notification you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request of DeleteNotification

" + } + }, + "com.amazonaws.budgets#DeleteNotificationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Response of DeleteNotification

" + } + }, + "com.amazonaws.budgets#DeleteSubscriber": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#DeleteSubscriberRequest" + }, + "output": { + "target": "com.amazonaws.budgets#DeleteSubscriberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" }, { "target": "com.amazonaws.budgets#InternalErrorException" @@ -525,72 +1324,121 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a notification. You must create the budget before you create the associated notification.

" + "smithy.api#documentation": "

Deletes a subscriber.

\n\t\t \n\t\t\t

Deleting the last subscriber to a notification also deletes the notification.

\n\t\t " } }, - "com.amazonaws.budgets#CreateNotificationRequest": { + "com.amazonaws.budgets#DeleteSubscriberRequest": { "type": "structure", "members": { - "Subscribers": { - "target": "com.amazonaws.budgets#Subscribers", + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "

A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.

", + "smithy.api#documentation": "

The name of the budget whose subscriber you want to delete.

", "smithy.api#required": {} } }, "Notification": { "target": "com.amazonaws.budgets#Notification", "traits": { - "smithy.api#documentation": "

The notification that you want to create.

", + "smithy.api#documentation": "

The notification whose subscriber you want to delete.

", "smithy.api#required": {} } }, - "BudgetName": { - "target": "com.amazonaws.budgets#BudgetName", + "Subscriber": { + "target": "com.amazonaws.budgets#Subscriber", "traits": { - "smithy.api#documentation": "

The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.

", + "smithy.api#documentation": "

The subscriber that you want to delete.

", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget that you want to create a notification for.

", + "smithy.api#documentation": "

The accountId that is associated with the budget whose subscriber you want to delete.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Request of CreateNotification

" + "smithy.api#documentation": "

Request of DeleteSubscriber

" } }, - "com.amazonaws.budgets#CreateNotificationResponse": { + "com.amazonaws.budgets#DeleteSubscriberResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of CreateNotification

" + "smithy.api#documentation": "

Response of DeleteSubscriber

" } }, - "com.amazonaws.budgets#CreateSubscriber": { + "com.amazonaws.budgets#DescribeBudget": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#DescribeBudgetRequest" + }, + "output": { + "target": "com.amazonaws.budgets#DescribeBudgetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a budget.

\n\t\t \n\t\t\t

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n\t\t " + } + }, + "com.amazonaws.budgets#DescribeBudgetAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#DescribeBudgetActionRequest" + }, + "output": { + "target": "com.amazonaws.budgets#DescribeBudgetActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Describes a budget action detail.\n

" + } + }, + "com.amazonaws.budgets#DescribeBudgetActionHistories": { "type": "operation", "input": { - "target": "com.amazonaws.budgets#CreateSubscriberRequest" + "target": "com.amazonaws.budgets#DescribeBudgetActionHistoriesRequest" }, "output": { - "target": "com.amazonaws.budgets#CreateSubscriberResponse" + "target": "com.amazonaws.budgets#DescribeBudgetActionHistoriesResponse" }, "errors": [ { "target": "com.amazonaws.budgets#AccessDeniedException" }, { - "target": "com.amazonaws.budgets#CreationLimitExceededException" - }, - { - "target": "com.amazonaws.budgets#DuplicateRecordException" + "target": "com.amazonaws.budgets#InternalErrorException" }, { - "target": "com.amazonaws.budgets#InternalErrorException" + "target": "com.amazonaws.budgets#InvalidNextTokenException" }, { "target": "com.amazonaws.budgets#InvalidParameterException" @@ -600,127 +1448,118 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

" + "smithy.api#documentation": "

\n Describes a budget action history detail.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ActionHistories", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.budgets#CreateSubscriberRequest": { + "com.amazonaws.budgets#DescribeBudgetActionHistoriesRequest": { "type": "structure", "members": { - "Notification": { - "target": "com.amazonaws.budgets#Notification", + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The notification that you want to create a subscriber for.

", "smithy.api#required": {} } }, - "Subscriber": { - "target": "com.amazonaws.budgets#Subscriber", + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", "traits": { - "smithy.api#documentation": "

The subscriber that you want to associate with a budget notification.

", + "smithy.api#documentation": "

\n A system-generated universally unique identifier (UUID) for the action.\n

", "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.budgets#AccountId", - "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget that you want to create a subscriber for.

", - "smithy.api#required": {} - } + "MaxResults": { + "target": "com.amazonaws.budgets#MaxResults" + }, + "TimePeriod": { + "target": "com.amazonaws.budgets#TimePeriod" + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" }, "BudgetName": { "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "

The name of the budget that you want to subscribe to. Budget names must be unique within an account.

", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Request of CreateSubscriber

" - } - }, - "com.amazonaws.budgets#CreateSubscriberResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Response of CreateSubscriber

" } }, - "com.amazonaws.budgets#CreationLimitExceededException": { + "com.amazonaws.budgets#DescribeBudgetActionHistoriesResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.budgets#errorMessage" + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" + }, + "ActionHistories": { + "target": "com.amazonaws.budgets#ActionHistories", + "traits": { + "smithy.api#documentation": "

\n The historical record of the budget action resource.\n

", + "smithy.api#required": {} + } } - }, - "traits": { - "smithy.api#documentation": "

You've exceeded the notification or subscriber limit.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 } }, - "com.amazonaws.budgets#DeleteBudget": { - "type": "operation", - "input": { - "target": "com.amazonaws.budgets#DeleteBudgetRequest" - }, - "output": { - "target": "com.amazonaws.budgets#DeleteBudgetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.budgets#AccessDeniedException" - }, - { - "target": "com.amazonaws.budgets#InternalErrorException" + "com.amazonaws.budgets#DescribeBudgetActionRequest": { + "type": "structure", + "members": { + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.budgets#InvalidParameterException" + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", + "traits": { + "smithy.api#documentation": "

\n A system-generated universally unique identifier (UUID) for the action.\n

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.budgets#NotFoundException" + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } } - ], - "traits": { - "smithy.api#documentation": "

Deletes a budget. You can delete your budget at any time.

\n\t\t \n\t\t\t

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

\n\t\t " } }, - "com.amazonaws.budgets#DeleteBudgetRequest": { + "com.amazonaws.budgets#DescribeBudgetActionResponse": { "type": "structure", "members": { + "Action": { + "target": "com.amazonaws.budgets#Action", + "traits": { + "smithy.api#documentation": "

\n A budget action resource.\n

", + "smithy.api#required": {} + } + }, "BudgetName": { "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "

The name of the budget that you want to delete.

", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget that you want to delete.

", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Request of DeleteBudget

" } }, - "com.amazonaws.budgets#DeleteBudgetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Response of DeleteBudget

" - } - }, - "com.amazonaws.budgets#DeleteNotification": { + "com.amazonaws.budgets#DescribeBudgetActionsForAccount": { "type": "operation", "input": { - "target": "com.amazonaws.budgets#DeleteNotificationRequest" + "target": "com.amazonaws.budgets#DescribeBudgetActionsForAccountRequest" }, "output": { - "target": "com.amazonaws.budgets#DeleteNotificationResponse" + "target": "com.amazonaws.budgets#DescribeBudgetActionsForAccountResponse" }, "errors": [ { @@ -730,59 +1569,61 @@ "target": "com.amazonaws.budgets#InternalErrorException" }, { - "target": "com.amazonaws.budgets#InvalidParameterException" + "target": "com.amazonaws.budgets#InvalidNextTokenException" }, { - "target": "com.amazonaws.budgets#NotFoundException" + "target": "com.amazonaws.budgets#InvalidParameterException" } ], "traits": { - "smithy.api#documentation": "

Deletes a notification.

\n\t\t \n\t\t\t

Deleting a notification also deletes the subscribers that are associated with the notification.

\n\t\t " + "smithy.api#documentation": "

\n Describes all of the budget actions for an account.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Actions", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.budgets#DeleteNotificationRequest": { + "com.amazonaws.budgets#DescribeBudgetActionsForAccountRequest": { "type": "structure", "members": { - "BudgetName": { - "target": "com.amazonaws.budgets#BudgetName", - "traits": { - "smithy.api#documentation": "

The name of the budget whose notification you want to delete.

", - "smithy.api#required": {} - } + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" }, - "Notification": { - "target": "com.amazonaws.budgets#Notification", - "traits": { - "smithy.api#documentation": "

The notification that you want to delete.

", - "smithy.api#required": {} - } + "MaxResults": { + "target": "com.amazonaws.budgets#MaxResults" }, "AccountId": { "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget whose notification you want to delete.

", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Request of DeleteNotification

" } }, - "com.amazonaws.budgets#DeleteNotificationResponse": { + "com.amazonaws.budgets#DescribeBudgetActionsForAccountResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Response of DeleteNotification

" + "members": { + "Actions": { + "target": "com.amazonaws.budgets#Actions", + "traits": { + "smithy.api#documentation": "

\n A list of the budget action resources information.\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" + } } }, - "com.amazonaws.budgets#DeleteSubscriber": { + "com.amazonaws.budgets#DescribeBudgetActionsForBudget": { "type": "operation", "input": { - "target": "com.amazonaws.budgets#DeleteSubscriberRequest" + "target": "com.amazonaws.budgets#DescribeBudgetActionsForBudgetRequest" }, "output": { - "target": "com.amazonaws.budgets#DeleteSubscriberResponse" + "target": "com.amazonaws.budgets#DescribeBudgetActionsForBudgetResponse" }, "errors": [ { @@ -791,6 +1632,9 @@ { "target": "com.amazonaws.budgets#InternalErrorException" }, + { + "target": "com.amazonaws.budgets#InvalidNextTokenException" + }, { "target": "com.amazonaws.budgets#InvalidParameterException" }, @@ -799,76 +1643,51 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a subscriber.

\n\t\t \n\t\t\t

Deleting the last subscriber to a notification also deletes the notification.

\n\t\t " + "smithy.api#documentation": "

\n Describes all of the budget actions for a budget.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Actions", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.budgets#DeleteSubscriberRequest": { + "com.amazonaws.budgets#DescribeBudgetActionsForBudgetRequest": { "type": "structure", "members": { - "Notification": { - "target": "com.amazonaws.budgets#Notification", - "traits": { - "smithy.api#documentation": "

The notification whose subscriber you want to delete.

", - "smithy.api#required": {} - } - }, "BudgetName": { "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "

The name of the budget whose subscriber you want to delete.

", "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.budgets#MaxResults" + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" + }, "AccountId": { "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget whose subscriber you want to delete.

", - "smithy.api#required": {} - } - }, - "Subscriber": { - "target": "com.amazonaws.budgets#Subscriber", - "traits": { - "smithy.api#documentation": "

The subscriber that you want to delete.

", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Request of DeleteSubscriber

" } }, - "com.amazonaws.budgets#DeleteSubscriberResponse": { + "com.amazonaws.budgets#DescribeBudgetActionsForBudgetResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Response of DeleteSubscriber

" - } - }, - "com.amazonaws.budgets#DescribeBudget": { - "type": "operation", - "input": { - "target": "com.amazonaws.budgets#DescribeBudgetRequest" - }, - "output": { - "target": "com.amazonaws.budgets#DescribeBudgetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.budgets#AccessDeniedException" - }, - { - "target": "com.amazonaws.budgets#InternalErrorException" - }, - { - "target": "com.amazonaws.budgets#InvalidParameterException" + "members": { + "Actions": { + "target": "com.amazonaws.budgets#Actions", + "traits": { + "smithy.api#documentation": "

\n A list of the budget action resources information.\n

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.budgets#NotFoundException" + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" } - ], - "traits": { - "smithy.api#documentation": "

Describes a budget.

\n\t\t \n\t\t\t

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n\t\t " } }, "com.amazonaws.budgets#DescribeBudgetPerformanceHistory": { @@ -906,26 +1725,26 @@ "com.amazonaws.budgets#DescribeBudgetPerformanceHistoryRequest": { "type": "structure", "members": { - "BudgetName": { - "target": "com.amazonaws.budgets#BudgetName", + "MaxResults": { + "target": "com.amazonaws.budgets#MaxResults" + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", "traits": { "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.budgets#GenericString" - }, - "MaxResults": { - "target": "com.amazonaws.budgets#MaxResults" - }, "TimePeriod": { "target": "com.amazonaws.budgets#TimePeriod", "traits": { "smithy.api#documentation": "

Retrieves how often the budget went into an ALARM state for the specified time period.

" } }, - "AccountId": { - "target": "com.amazonaws.budgets#AccountId", + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", "traits": { "smithy.api#required": {} } @@ -935,14 +1754,14 @@ "com.amazonaws.budgets#DescribeBudgetPerformanceHistoryResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.budgets#GenericString" - }, "BudgetPerformanceHistory": { "target": "com.amazonaws.budgets#BudgetPerformanceHistory", "traits": { - "smithy.api#documentation": "

The history of how often the budget has gone into an ALARM state.

\n\t\t

For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.

" + "smithy.api#documentation": "

The history of how often the budget has gone into an ALARM state.

\n

For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.

" } + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString" } } }, @@ -1011,7 +1830,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the budgets that are associated with an account.

\n\t\t \n\t\t\t

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n\t\t " + "smithy.api#documentation": "

Lists the budgets that are associated with an account.

\n\t\t \n\t\t\t

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n\t\t ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Budgets", + "pageSize": "MaxResults" + } } }, "com.amazonaws.budgets#DescribeBudgetsRequest": { @@ -1024,16 +1849,16 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.budgets#GenericString", + "MaxResults": { + "target": "com.amazonaws.budgets#MaxResults", "traits": { - "smithy.api#documentation": "

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" + "smithy.api#documentation": "

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

" } }, - "MaxResults": { - "target": "com.amazonaws.budgets#MaxResults", + "NextToken": { + "target": "com.amazonaws.budgets#GenericString", "traits": { - "smithy.api#documentation": "

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

" + "smithy.api#documentation": "

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" } } }, @@ -1044,17 +1869,17 @@ "com.amazonaws.budgets#DescribeBudgetsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.budgets#GenericString", - "traits": { - "smithy.api#documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" - } - }, "Budgets": { "target": "com.amazonaws.budgets#Budgets", "traits": { "smithy.api#documentation": "

A list of budgets.

" } + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString", + "traits": { + "smithy.api#documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" + } } }, "traits": { @@ -1090,7 +1915,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the notifications that are associated with a budget.

" + "smithy.api#documentation": "

Lists the notifications that are associated with a budget.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Notifications", + "pageSize": "MaxResults" + } } }, "com.amazonaws.budgets#DescribeNotificationsForBudgetRequest": { @@ -1109,18 +1940,18 @@ "smithy.api#documentation": "

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

" } }, - "NextToken": { - "target": "com.amazonaws.budgets#GenericString", - "traits": { - "smithy.api#documentation": "

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" - } - }, "BudgetName": { "target": "com.amazonaws.budgets#BudgetName", "traits": { "smithy.api#documentation": "

The name of the budget whose notifications you want descriptions of.

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString", + "traits": { + "smithy.api#documentation": "

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" + } } }, "traits": { @@ -1130,17 +1961,17 @@ "com.amazonaws.budgets#DescribeNotificationsForBudgetResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.budgets#GenericString", - "traits": { - "smithy.api#documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" - } - }, "Notifications": { "target": "com.amazonaws.budgets#Notifications", "traits": { "smithy.api#documentation": "

A list of notifications that are associated with a budget.

" } + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString", + "traits": { + "smithy.api#documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" + } } }, "traits": { @@ -1176,19 +2007,18 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the subscribers that are associated with a notification.

" + "smithy.api#documentation": "

Lists the subscribers that are associated with a notification.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscribers", + "pageSize": "MaxResults" + } } }, "com.amazonaws.budgets#DescribeSubscribersForNotificationRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.budgets#AccountId", - "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget whose subscribers you want descriptions of.

", - "smithy.api#required": {} - } - }, "Notification": { "target": "com.amazonaws.budgets#Notification", "traits": { @@ -1196,13 +2026,6 @@ "smithy.api#required": {} } }, - "BudgetName": { - "target": "com.amazonaws.budgets#BudgetName", - "traits": { - "smithy.api#documentation": "

The name of the budget whose subscribers you want descriptions of.

", - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.budgets#GenericString", "traits": { @@ -1214,6 +2037,20 @@ "traits": { "smithy.api#documentation": "

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

" } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#documentation": "

The name of the budget whose subscribers you want descriptions of.

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#documentation": "

The accountId that is associated with the budget whose subscribers you want descriptions of.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1223,17 +2060,17 @@ "com.amazonaws.budgets#DescribeSubscribersForNotificationResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.budgets#GenericString", - "traits": { - "smithy.api#documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" - } - }, "Subscribers": { "target": "com.amazonaws.budgets#Subscribers", "traits": { "smithy.api#documentation": "

A list of subscribers that are associated with a notification.

" } + }, + "NextToken": { + "target": "com.amazonaws.budgets#GenericString", + "traits": { + "smithy.api#documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" + } } }, "traits": { @@ -1256,7 +2093,148 @@ "traits": { "smithy.api#documentation": "

The budget name already exists. Budget names must be unique within an account.

", "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.budgets#EventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SYSTEM", + "name": "System" + }, + { + "value": "CREATE_ACTION", + "name": "CreateAction" + }, + { + "value": "DELETE_ACTION", + "name": "DeleteAction" + }, + { + "value": "UPDATE_ACTION", + "name": "UpdateAction" + }, + { + "value": "EXECUTE_ACTION", + "name": "ExecuteAction" + } + ] + } + }, + "com.amazonaws.budgets#ExecuteBudgetAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#ExecuteBudgetActionRequest" + }, + "output": { + "target": "com.amazonaws.budgets#ExecuteBudgetActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ResourceLockedException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Executes a budget action.\n

" + } + }, + "com.amazonaws.budgets#ExecuteBudgetActionRequest": { + "type": "structure", + "members": { + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } + }, + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", + "traits": { + "smithy.api#documentation": "

\n A system-generated universally unique identifier (UUID) for the action.\n

", + "smithy.api#required": {} + } + }, + "ExecutionType": { + "target": "com.amazonaws.budgets#ExecutionType", + "traits": { + "smithy.api#documentation": "

\n The type of execution.\n

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.budgets#ExecuteBudgetActionResponse": { + "type": "structure", + "members": { + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", + "traits": { + "smithy.api#documentation": "

\n A system-generated universally unique identifier (UUID) for the action.\n

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } + }, + "ExecutionType": { + "target": "com.amazonaws.budgets#ExecutionType", + "traits": { + "smithy.api#documentation": "

\n The type of execution.\n

", + "smithy.api#required": {} + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.budgets#ExecutionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "APPROVE_BUDGET_ACTION", + "name": "ApproveBudgetAction" + }, + { + "value": "RETRY_BUDGET_ACTION", + "name": "RetryBudgetAction" + }, + { + "value": "REVERSE_BUDGET_ACTION", + "name": "ReverseBudgetAction" + }, + { + "value": "RESET_BUDGET_ACTION", + "name": "ResetBudgetAction" + } + ] } }, "com.amazonaws.budgets#ExpiredNextTokenException": { @@ -1289,6 +2267,83 @@ "smithy.api#documentation": "

A generic time stamp. In Java, it is transformed to a Date object.

" } }, + "com.amazonaws.budgets#Group": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 640 + }, + "smithy.api#pattern": "^([\\u0021-\\u007F]+\\u002F)?[\\w+=,.@-]+$" + } + }, + "com.amazonaws.budgets#Groups": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#Group" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.budgets#IamActionDefinition": { + "type": "structure", + "members": { + "PolicyArn": { + "target": "com.amazonaws.budgets#PolicyArn", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe Amazon Resource Name (ARN) of the policy to be attached.\n\t\t

", + "smithy.api#required": {} + } + }, + "Users": { + "target": "com.amazonaws.budgets#Users", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA list of users to be attached. There must be at least one user.\n\t\t

" + } + }, + "Groups": { + "target": "com.amazonaws.budgets#Groups", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA list of groups to be attached. There must be at least one group.\n\t\t

" + } + }, + "Roles": { + "target": "com.amazonaws.budgets#Roles", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA list of roles to be attached. There must be at least one role.\n\t\t

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe AWS Identity and Access Management (IAM) action definition details.\n\t\t

" + } + }, + "com.amazonaws.budgets#InstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^i-(\\w{8}|\\w{17})$|^[a-zA-Z]([\\w-]{0,61}\\w)?$" + } + }, + "com.amazonaws.budgets#InstanceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#InstanceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.budgets#InternalErrorException": { "type": "structure", "members": { @@ -1349,17 +2404,16 @@ "traits": { "smithy.api#documentation": "

We can’t locate the resource that you specified.

", "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#httpError": 404 } }, "com.amazonaws.budgets#Notification": { "type": "structure", "members": { - "ComparisonOperator": { - "target": "com.amazonaws.budgets#ComparisonOperator", + "NotificationState": { + "target": "com.amazonaws.budgets#NotificationState", "traits": { - "smithy.api#documentation": "

The comparison that is used for this notification.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

" } }, "ThresholdType": { @@ -1368,29 +2422,30 @@ "smithy.api#documentation": "

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

" } }, - "NotificationState": { - "target": "com.amazonaws.budgets#NotificationState", + "NotificationType": { + "target": "com.amazonaws.budgets#NotificationType", "traits": { - "smithy.api#documentation": "

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

" + "smithy.api#documentation": "

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

", + "smithy.api#required": {} } }, "Threshold": { "target": "com.amazonaws.budgets#NotificationThreshold", "traits": { - "smithy.api#documentation": "

The threshold that is associated with a notification. Thresholds are always a percentage.

", + "smithy.api#documentation": "

The threshold that is associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

", "smithy.api#required": {} } - }, - "NotificationType": { - "target": "com.amazonaws.budgets#NotificationType", + }, + "ComparisonOperator": { + "target": "com.amazonaws.budgets#ComparisonOperator", "traits": { - "smithy.api#documentation": "

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

", + "smithy.api#documentation": "

The comparison that is used for this notification.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A notification that is associated with a budget. A budget can have up to five notifications.

\n\t\t

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

\n\t\t

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

\n\t\t " + "smithy.api#documentation": "

A notification that is associated with a budget. A budget can have up to ten notifications.

\n\t\t

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

\n\t\t

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

\n\t\t " } }, "com.amazonaws.budgets#NotificationState": { @@ -1411,10 +2466,10 @@ "com.amazonaws.budgets#NotificationThreshold": { "type": "double", "traits": { - "smithy.api#documentation": "

The threshold of a notification. It must be a number between 0 and 1,000,000,000.

", + "smithy.api#documentation": "

The threshold of a notification.

", "smithy.api#range": { "min": 0, - "max": 1000000000 + "max": 40000000000 } } }, @@ -1437,17 +2492,17 @@ "com.amazonaws.budgets#NotificationWithSubscribers": { "type": "structure", "members": { - "Notification": { - "target": "com.amazonaws.budgets#Notification", + "Subscribers": { + "target": "com.amazonaws.budgets#Subscribers", "traits": { - "smithy.api#documentation": "

The notification that is associated with a budget.

", + "smithy.api#documentation": "

A list of subscribers who are subscribed to this notification.

", "smithy.api#required": {} } }, - "Subscribers": { - "target": "com.amazonaws.budgets#Subscribers", + "Notification": { + "target": "com.amazonaws.budgets#Notification", "traits": { - "smithy.api#documentation": "

A list of subscribers who are subscribed to this notification.

", + "smithy.api#documentation": "

The notification that is associated with a budget.

", "smithy.api#required": {} } } @@ -1465,7 +2520,7 @@ "smithy.api#documentation": "

A list of notifications, each with a list of subscribers.

", "smithy.api#length": { "min": 0, - "max": 5 + "max": 10 } } }, @@ -1504,28 +2559,154 @@ "target": "com.amazonaws.budgets#Spend" } }, - "com.amazonaws.budgets#Spend": { + "com.amazonaws.budgets#PolicyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 25, + "max": 684 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::(\\d{12}|aws):policy(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" + } + }, + "com.amazonaws.budgets#PolicyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 130 + }, + "smithy.api#pattern": "^p-[0-9a-zA-Z_]{8,128}$" + } + }, + "com.amazonaws.budgets#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 20 + }, + "smithy.api#pattern": "^\\w{2}-\\w+(-\\w+)?-\\d$" + } + }, + "com.amazonaws.budgets#ResourceLockedException": { "type": "structure", "members": { - "Amount": { - "target": "com.amazonaws.budgets#NumericValue", + "Message": { + "target": "com.amazonaws.budgets#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was received and recognized by the server, but the server rejected that\n particular method for the requested resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 423 + } + }, + "com.amazonaws.budgets#Role": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 576 + }, + "smithy.api#pattern": "^([\\u0021-\\u007F]+\\u002F)?[\\w+=,.@-]+$" + } + }, + "com.amazonaws.budgets#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 618 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::\\d{12}:role(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" + } + }, + "com.amazonaws.budgets#Roles": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#Role" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.budgets#ScpActionDefinition": { + "type": "structure", + "members": { + "PolicyId": { + "target": "com.amazonaws.budgets#PolicyId", "traits": { - "smithy.api#documentation": "

The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.

", + "smithy.api#documentation": "

\n\t\t\tThe policy ID attached.\n\t\t

", "smithy.api#required": {} } }, + "TargetIds": { + "target": "com.amazonaws.budgets#TargetIds", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA list of target IDs.\n\t\t

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe service control policies (SCP) action definition details.\n\t\t

" + } + }, + "com.amazonaws.budgets#Spend": { + "type": "structure", + "members": { "Unit": { "target": "com.amazonaws.budgets#UnitValue", "traits": { "smithy.api#documentation": "

The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.

", "smithy.api#required": {} } + }, + "Amount": { + "target": "com.amazonaws.budgets#NumericValue", + "traits": { + "smithy.api#documentation": "

The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.

", + "smithy.api#required": {} + } } }, "traits": { "smithy.api#documentation": "

The amount of cost or usage that is measured for a budget.

\n\t\t

For example, a Spend for 3 GB of S3 usage would have the following parameters:

\n\t\t " } }, + "com.amazonaws.budgets#SsmActionDefinition": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.budgets#Region", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe Region to run the SSM document.\n\t\t

", + "smithy.api#required": {} + } + }, + "InstanceIds": { + "target": "com.amazonaws.budgets#InstanceIds", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe EC2 and RDS instance IDs.\n\t\t

", + "smithy.api#required": {} + } + }, + "ActionSubType": { + "target": "com.amazonaws.budgets#ActionSubType", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe action subType.\n\t\t

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe AWS Systems Manager (SSM) action definition details.\n\t\t

" + } + }, "com.amazonaws.budgets#Subscriber": { "type": "structure", "members": { @@ -1589,10 +2770,32 @@ ] } }, + "com.amazonaws.budgets#TargetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 68 + }, + "smithy.api#pattern": "^(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)|(\\d{12})" + } + }, + "com.amazonaws.budgets#TargetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#TargetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.budgets#ThresholdType": { "type": "string", "traits": { - "smithy.api#documentation": "

The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.

", + "smithy.api#documentation": "

The type of threshold for a notification.

", "smithy.api#enum": [ { "value": "PERCENTAGE", @@ -1686,6 +2889,114 @@ "smithy.api#documentation": "

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.

\n\t\t \n\t\t\t

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n\t\t " } }, + "com.amazonaws.budgets#UpdateBudgetAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.budgets#UpdateBudgetActionRequest" + }, + "output": { + "target": "com.amazonaws.budgets#UpdateBudgetActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.budgets#AccessDeniedException" + }, + { + "target": "com.amazonaws.budgets#InternalErrorException" + }, + { + "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ResourceLockedException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates a budget action.\n

" + } + }, + "com.amazonaws.budgets#UpdateBudgetActionRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } + }, + "ActionId": { + "target": "com.amazonaws.budgets#ActionId", + "traits": { + "smithy.api#documentation": "

\n A system-generated universally unique identifier (UUID) for the action.\n

", + "smithy.api#required": {} + } + }, + "ApprovalModel": { + "target": "com.amazonaws.budgets#ApprovalModel", + "traits": { + "smithy.api#documentation": "

\n This specifies if the action needs manual or automatic approval.\n

" + } + }, + "NotificationType": { + "target": "com.amazonaws.budgets#NotificationType" + }, + "ActionThreshold": { + "target": "com.amazonaws.budgets#ActionThreshold" + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } + }, + "Subscribers": { + "target": "com.amazonaws.budgets#Subscribers" + }, + "Definition": { + "target": "com.amazonaws.budgets#Definition" + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.budgets#RoleArn", + "traits": { + "smithy.api#documentation": "

\n The role passed for action execution and reversion. Roles and actions must be in the same account.\n

" + } + } + } + }, + "com.amazonaws.budgets#UpdateBudgetActionResponse": { + "type": "structure", + "members": { + "NewAction": { + "target": "com.amazonaws.budgets#Action", + "traits": { + "smithy.api#documentation": "

\n The updated action resource information.\n

", + "smithy.api#required": {} + } + }, + "BudgetName": { + "target": "com.amazonaws.budgets#BudgetName", + "traits": { + "smithy.api#required": {} + } + }, + "OldAction": { + "target": "com.amazonaws.budgets#Action", + "traits": { + "smithy.api#documentation": "

\n The previous action resource information.\n

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", + "traits": { + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.budgets#UpdateBudgetRequest": { "type": "structure", "members": { @@ -1747,17 +3058,17 @@ "com.amazonaws.budgets#UpdateNotificationRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.budgets#AccountId", + "OldNotification": { + "target": "com.amazonaws.budgets#Notification", "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget whose notification you want to update.

", + "smithy.api#documentation": "

The previous notification that is associated with a budget.

", "smithy.api#required": {} } }, - "OldNotification": { + "NewNotification": { "target": "com.amazonaws.budgets#Notification", "traits": { - "smithy.api#documentation": "

The previous notification that is associated with a budget.

", + "smithy.api#documentation": "

The updated notification to be associated with a budget.

", "smithy.api#required": {} } }, @@ -1768,10 +3079,10 @@ "smithy.api#required": {} } }, - "NewNotification": { - "target": "com.amazonaws.budgets#Notification", + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The updated notification to be associated with a budget.

", + "smithy.api#documentation": "

The accountId that is associated with the budget whose notification you want to update.

", "smithy.api#required": {} } } @@ -1826,17 +3137,17 @@ "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.budgets#AccountId", + "Notification": { + "target": "com.amazonaws.budgets#Notification", "traits": { - "smithy.api#documentation": "

The accountId that is associated with the budget whose subscriber you want to update.

", + "smithy.api#documentation": "

The notification whose subscriber you want to update.

", "smithy.api#required": {} } }, - "Notification": { - "target": "com.amazonaws.budgets#Notification", + "NewSubscriber": { + "target": "com.amazonaws.budgets#Subscriber", "traits": { - "smithy.api#documentation": "

The notification whose subscriber you want to update.

", + "smithy.api#documentation": "

The updated subscriber that is associated with a budget notification.

", "smithy.api#required": {} } }, @@ -1847,10 +3158,10 @@ "smithy.api#required": {} } }, - "NewSubscriber": { - "target": "com.amazonaws.budgets#Subscriber", + "AccountId": { + "target": "com.amazonaws.budgets#AccountId", "traits": { - "smithy.api#documentation": "

The updated subscriber that is associated with a budget notification.

", + "smithy.api#documentation": "

The accountId that is associated with the budget whose subscriber you want to update.

", "smithy.api#required": {} } } @@ -1866,6 +3177,28 @@ "smithy.api#documentation": "

Response of UpdateSubscriber

" } }, + "com.amazonaws.budgets#User": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 576 + }, + "smithy.api#pattern": "^([\\u0021-\\u007F]+\\u002F)?[\\w+=,.@-]+$" + } + }, + "com.amazonaws.budgets#Users": { + "type": "list", + "member": { + "target": "com.amazonaws.budgets#User" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.budgets#errorMessage": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/chime.2018-05-01.json b/codegen/sdk-codegen/aws-models/chime.2018-05-01.json index a03556938f74..8c05b09a3b52 100644 --- a/codegen/sdk-codegen/aws-models/chime.2018-05-01.json +++ b/codegen/sdk-codegen/aws-models/chime.2018-05-01.json @@ -54,26 +54,31 @@ "smithy.api#documentation": "

The default license for the Amazon Chime account.

" } }, - "AwsAccountId": { - "target": "com.amazonaws.chime#String", + "SigninDelegateGroups": { + "target": "com.amazonaws.chime#SigninDelegateGroupList", "traits": { - "smithy.api#documentation": "

The AWS account ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The sign-in delegate groups associated with the account.

" } }, - "AccountType": { - "target": "com.amazonaws.chime#AccountType", + "SupportedLicenses": { + "target": "com.amazonaws.chime#LicenseList", "traits": { - "smithy.api#documentation": "

The Amazon Chime account type. For more information\n about different account types, see Managing Your Amazon Chime Accounts in the\n Amazon\n Chime Administration Guide.

" + "smithy.api#documentation": "

Supported licenses for the Amazon Chime account.

" } }, - "AccountId": { + "AwsAccountId": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The AWS account ID.

", "smithy.api#required": {} } }, + "CreatedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The Amazon Chime account creation timestamp, in ISO 8601 format.

" + } + }, "Name": { "target": "com.amazonaws.chime#String", "traits": { @@ -81,22 +86,17 @@ "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", - "traits": { - "smithy.api#documentation": "

The Amazon Chime account creation timestamp, in ISO 8601 format.

" - } - }, - "SupportedLicenses": { - "target": "com.amazonaws.chime#LicenseList", + "AccountId": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

Supported licenses for the Amazon Chime account.

" + "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#required": {} } }, - "SigninDelegateGroups": { - "target": "com.amazonaws.chime#SigninDelegateGroupList", + "AccountType": { + "target": "com.amazonaws.chime#AccountType", "traits": { - "smithy.api#documentation": "

The sign-in delegate groups associated with the account.

" + "smithy.api#documentation": "

The Amazon Chime account type. For more information\n about different account types, see Managing Your Amazon Chime Accounts in the\n Amazon\n Chime Administration Guide.

" } } }, @@ -252,10 +252,11 @@ "com.amazonaws.chime#AssociatePhoneNumberWithUserRequest": { "type": "structure", "members": { - "E164PhoneNumber": { - "target": "com.amazonaws.chime#E164PhoneNumber", + "UserId": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The phone number, in E.164 format.

", + "smithy.api#documentation": "

The user ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -267,11 +268,10 @@ "smithy.api#required": {} } }, - "UserId": { - "target": "com.amazonaws.chime#String", + "E164PhoneNumber": { + "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { - "smithy.api#documentation": "

The user ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The phone number, in E.164 format.

", "smithy.api#required": {} } } @@ -370,6 +370,13 @@ "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorGroupRequest": { "type": "structure", "members": { + "E164PhoneNumbers": { + "target": "com.amazonaws.chime#E164PhoneNumberList", + "traits": { + "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", + "smithy.api#required": {} + } + }, "VoiceConnectorGroupId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -383,13 +390,6 @@ "traits": { "smithy.api#documentation": "

If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

" } - }, - "E164PhoneNumbers": { - "target": "com.amazonaws.chime#E164PhoneNumberList", - "traits": { - "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", - "smithy.api#required": {} - } } } }, @@ -508,18 +508,18 @@ "com.amazonaws.chime#Attendee": { "type": "structure", "members": { - "AttendeeId": { - "target": "com.amazonaws.chime#GuidString", - "traits": { - "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

" - } - }, "JoinToken": { "target": "com.amazonaws.chime#JoinTokenString", "traits": { "smithy.api#documentation": "

The join token used by the Amazon Chime SDK attendee.

" } }, + "AttendeeId": { + "target": "com.amazonaws.chime#GuidString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

" + } + }, "ExternalUserId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { @@ -713,18 +713,18 @@ "smithy.api#required": {} } }, - "AccountId": { + "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The room ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RoomId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The room ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -848,13 +848,6 @@ "com.amazonaws.chime#BatchSuspendUserRequest": { "type": "structure", "members": { - "UserIdList": { - "target": "com.amazonaws.chime#UserIdList", - "traits": { - "smithy.api#documentation": "

The request containing the user IDs to suspend.

", - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -862,6 +855,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "UserIdList": { + "target": "com.amazonaws.chime#UserIdList", + "traits": { + "smithy.api#documentation": "

The request containing the user IDs to suspend.

", + "smithy.api#required": {} + } } } }, @@ -919,13 +919,6 @@ "com.amazonaws.chime#BatchUnsuspendUserRequest": { "type": "structure", "members": { - "UserIdList": { - "target": "com.amazonaws.chime#UserIdList", - "traits": { - "smithy.api#documentation": "

The request containing the user IDs to unsuspend.

", - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -933,6 +926,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "UserIdList": { + "target": "com.amazonaws.chime#UserIdList", + "traits": { + "smithy.api#documentation": "

The request containing the user IDs to unsuspend.

", + "smithy.api#required": {} + } } } }, @@ -1096,10 +1096,10 @@ "smithy.api#documentation": "

When true, the bot is stopped from running in your account.

" } }, - "SecurityToken": { - "target": "com.amazonaws.chime#SensitiveString", + "UpdatedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The security token used to authenticate Amazon Chime with the outgoing event endpoint.

" + "smithy.api#documentation": "

The updated bot timestamp, in ISO 8601 format.

" } }, "CreatedTimestamp": { @@ -1108,10 +1108,16 @@ "smithy.api#documentation": "

The bot creation timestamp, in ISO 8601 format.

" } }, - "BotType": { - "target": "com.amazonaws.chime#BotType", + "BotId": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The bot type.

" + "smithy.api#documentation": "

The bot ID.

" + } + }, + "BotEmail": { + "target": "com.amazonaws.chime#SensitiveString", + "traits": { + "smithy.api#documentation": "

The bot email address.

" } }, "UserId": { @@ -1126,22 +1132,16 @@ "smithy.api#documentation": "

The bot display name.

" } }, - "UpdatedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", - "traits": { - "smithy.api#documentation": "

The updated bot timestamp, in ISO 8601 format.

" - } - }, - "BotId": { - "target": "com.amazonaws.chime#String", + "BotType": { + "target": "com.amazonaws.chime#BotType", "traits": { - "smithy.api#documentation": "

The bot ID.

" + "smithy.api#documentation": "

The bot type.

" } }, - "BotEmail": { + "SecurityToken": { "target": "com.amazonaws.chime#SensitiveString", "traits": { - "smithy.api#documentation": "

The bot email address.

" + "smithy.api#documentation": "

The security token used to authenticate Amazon Chime with the outgoing event endpoint.

" } } }, @@ -1417,10 +1417,10 @@ "com.amazonaws.chime#CreateAttendeeError": { "type": "structure", "members": { - "ErrorCode": { + "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The error code.

" + "smithy.api#documentation": "

The error message.

" } }, "ExternalUserId": { @@ -1429,10 +1429,10 @@ "smithy.api#documentation": "

The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.

" } }, - "ErrorMessage": { + "ErrorCode": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The error message.

" + "smithy.api#documentation": "

The error code.

" } } }, @@ -1443,6 +1443,12 @@ "com.amazonaws.chime#CreateAttendeeRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.chime#AttendeeTagList", + "traits": { + "smithy.api#documentation": "

The tag key-value pairs.

" + } + }, "ExternalUserId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { @@ -1457,30 +1463,24 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.chime#AttendeeTagList", - "traits": { - "smithy.api#documentation": "

The tag key-value pairs.

" - } } } }, "com.amazonaws.chime#CreateAttendeeRequestItem": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.chime#AttendeeTagList", + "traits": { + "smithy.api#documentation": "

The tag key-value pairs.

" + } + }, "ExternalUserId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { "smithy.api#documentation": "

The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.

", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.chime#AttendeeTagList", - "traits": { - "smithy.api#documentation": "

The tag key-value pairs.

" - } } }, "traits": { @@ -1633,18 +1633,16 @@ "smithy.api#documentation": "

The tag key-value pairs.

" } }, - "MediaRegion": { - "target": "com.amazonaws.chime#String", + "NotificationsConfiguration": { + "target": "com.amazonaws.chime#MeetingNotificationConfiguration", "traits": { - "smithy.api#documentation": "

The Region in which to create the meeting. Default: us-east-1.

\n

Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

" + "smithy.api#documentation": "

The configuration for resource targets to receive notifications when meeting and attendee events occur.

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.chime#ClientRequestToken", + "ExternalMeetingId": { + "target": "com.amazonaws.chime#ExternalMeetingIdType", "traits": { - "smithy.api#documentation": "

The unique identifier for the client request. Use a different token for different meetings.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The external meeting ID.

" } }, "MeetingHostId": { @@ -1653,16 +1651,18 @@ "smithy.api#documentation": "

Reserved.

" } }, - "NotificationsConfiguration": { - "target": "com.amazonaws.chime#MeetingNotificationConfiguration", + "MediaRegion": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The configuration for resource targets to receive notifications when meeting and attendee events occur.

" + "smithy.api#documentation": "

The Region in which to create the meeting. Default: us-east-1.

\n

Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

" } }, - "ExternalMeetingId": { - "target": "com.amazonaws.chime#ExternalMeetingIdType", + "ClientRequestToken": { + "target": "com.amazonaws.chime#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The external meeting ID.

" + "smithy.api#documentation": "

The unique identifier for the client request. Use a different token for different meetings.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } } } @@ -1724,42 +1724,42 @@ "NotificationsConfiguration": { "target": "com.amazonaws.chime#MeetingNotificationConfiguration" }, - "ClientRequestToken": { - "target": "com.amazonaws.chime#ClientRequestToken", + "MeetingHostId": { + "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { - "smithy.api#documentation": "

The unique identifier for the client request. Use a different token for different meetings.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Reserved.

" } }, - "ExternalMeetingId": { - "target": "com.amazonaws.chime#ExternalMeetingIdType", + "Tags": { + "target": "com.amazonaws.chime#MeetingTagList", "traits": { - "smithy.api#documentation": "

The external meeting ID.

" + "smithy.api#documentation": "

The tag key-value pairs.

" } }, - "Attendees": { - "target": "com.amazonaws.chime#CreateMeetingWithAttendeesRequestItemList", + "ExternalMeetingId": { + "target": "com.amazonaws.chime#ExternalMeetingIdType", "traits": { - "smithy.api#documentation": "

The request containing the attendees to create.

" + "smithy.api#documentation": "

The external meeting ID.

" } }, "MediaRegion": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The Region in which to create the meeting. Default: us-east-1.

\n

Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

" + "smithy.api#documentation": "

The Region in which to create the meeting. Default: us-east-1.

\n

Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

" } }, - "MeetingHostId": { - "target": "com.amazonaws.chime#ExternalUserIdType", + "ClientRequestToken": { + "target": "com.amazonaws.chime#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Reserved.

" + "smithy.api#documentation": "

The unique identifier for the client request. Use a different token for different meetings.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.chime#MeetingTagList", + "Attendees": { + "target": "com.amazonaws.chime#CreateMeetingWithAttendeesRequestItemList", "traits": { - "smithy.api#documentation": "

The tag key-value pairs.

" + "smithy.api#documentation": "

The request containing the attendees to create.

" } } } @@ -1772,7 +1772,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 10 } } }, @@ -1785,14 +1785,14 @@ "smithy.api#documentation": "

If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

" } }, + "Meeting": { + "target": "com.amazonaws.chime#Meeting" + }, "Attendees": { "target": "com.amazonaws.chime#AttendeeList", "traits": { "smithy.api#documentation": "

The attendee information, including attendees IDs and join tokens.

" } - }, - "Meeting": { - "target": "com.amazonaws.chime#Meeting" } } }, @@ -1842,17 +1842,17 @@ "com.amazonaws.chime#CreatePhoneNumberOrderRequest": { "type": "structure", "members": { - "E164PhoneNumbers": { - "target": "com.amazonaws.chime#E164PhoneNumberList", + "ProductType": { + "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { - "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", + "smithy.api#documentation": "

The phone number product type.

", "smithy.api#required": {} } }, - "ProductType": { - "target": "com.amazonaws.chime#PhoneNumberProductType", + "E164PhoneNumbers": { + "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { - "smithy.api#documentation": "

The phone number product type.

", + "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", "smithy.api#required": {} } } @@ -1912,11 +1912,10 @@ "com.amazonaws.chime#CreateProxySessionRequest": { "type": "structure", "members": { - "Capabilities": { - "target": "com.amazonaws.chime#CapabilityList", + "GeoMatchParams": { + "target": "com.amazonaws.chime#GeoMatchParams", "traits": { - "smithy.api#documentation": "

The proxy session capabilities.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The country and area code for the proxy phone number.

" } }, "NumberSelectionBehavior": { @@ -1925,22 +1924,25 @@ "smithy.api#documentation": "

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

" } }, - "Name": { - "target": "com.amazonaws.chime#ProxySessionNameString", + "Capabilities": { + "target": "com.amazonaws.chime#CapabilityList", "traits": { - "smithy.api#documentation": "

The name of the proxy session.

" + "smithy.api#documentation": "

The proxy session capabilities.

", + "smithy.api#required": {} } }, - "GeoMatchParams": { - "target": "com.amazonaws.chime#GeoMatchParams", + "ExpiryMinutes": { + "target": "com.amazonaws.chime#PositiveInteger", "traits": { - "smithy.api#documentation": "

The country and area code for the proxy phone number.

" + "smithy.api#documentation": "

The number of minutes allowed for the proxy session.

" } }, - "GeoMatchLevel": { - "target": "com.amazonaws.chime#GeoMatchLevel", + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString128", "traits": { - "smithy.api#documentation": "

The preference for matching the country or area code of the proxy phone number with that of the first participant.

" + "smithy.api#documentation": "

The Amazon Chime voice connector ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ParticipantPhoneNumbers": { @@ -1950,18 +1952,16 @@ "smithy.api#required": {} } }, - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString128", + "GeoMatchLevel": { + "target": "com.amazonaws.chime#GeoMatchLevel", "traits": { - "smithy.api#documentation": "

The Amazon Chime voice connector ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The preference for matching the country or area code of the proxy phone number with that of the first participant.

" } }, - "ExpiryMinutes": { - "target": "com.amazonaws.chime#PositiveInteger", + "Name": { + "target": "com.amazonaws.chime#ProxySessionNameString", "traits": { - "smithy.api#documentation": "

The number of minutes allowed for the proxy session.

" + "smithy.api#documentation": "

The name of the proxy session.

" } } } @@ -2114,6 +2114,13 @@ "com.amazonaws.chime#CreateRoomRequest": { "type": "structure", "members": { + "ClientRequestToken": { + "target": "com.amazonaws.chime#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the request.

", + "smithy.api#idempotencyToken": {} + } + }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -2128,13 +2135,6 @@ "smithy.api#documentation": "

The room name.

", "smithy.api#required": {} } - }, - "ClientRequestToken": { - "target": "com.amazonaws.chime#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

The idempotency token for the request.

", - "smithy.api#idempotencyToken": {} - } } } }, @@ -2195,12 +2195,10 @@ "com.amazonaws.chime#CreateUserRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.chime#NonEmptyString", + "UserType": { + "target": "com.amazonaws.chime#UserType", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The user type.

" } }, "Email": { @@ -2209,10 +2207,12 @@ "smithy.api#documentation": "

The user's email address.

" } }, - "UserType": { - "target": "com.amazonaws.chime#UserType", + "AccountId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The user type.

" + "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Username": { @@ -2349,12 +2349,6 @@ "com.amazonaws.chime#CreateVoiceConnectorRequest": { "type": "structure", "members": { - "AwsRegion": { - "target": "com.amazonaws.chime#VoiceConnectorAwsRegion", - "traits": { - "smithy.api#documentation": "

The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1.

" - } - }, "RequireEncryption": { "target": "com.amazonaws.chime#Boolean", "traits": { @@ -2368,6 +2362,12 @@ "smithy.api#documentation": "

The name of the Amazon Chime Voice Connector.

", "smithy.api#required": {} } + }, + "AwsRegion": { + "target": "com.amazonaws.chime#VoiceConnectorAwsRegion", + "traits": { + "smithy.api#documentation": "

The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1.

" + } } } }, @@ -2385,16 +2385,16 @@ "com.amazonaws.chime#Credential": { "type": "structure", "members": { - "Password": { + "Username": { "target": "com.amazonaws.chime#SensitiveString", "traits": { - "smithy.api#documentation": "

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

" + "smithy.api#documentation": "

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII\n format.

" } }, - "Username": { + "Password": { "target": "com.amazonaws.chime#SensitiveString", "traits": { - "smithy.api#documentation": "

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII\n format.

" + "smithy.api#documentation": "

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

" } } }, @@ -2411,6 +2411,13 @@ "com.amazonaws.chime#DNISEmergencyCallingConfiguration": { "type": "structure", "members": { + "EmergencyPhoneNumber": { + "target": "com.amazonaws.chime#E164PhoneNumber", + "traits": { + "smithy.api#documentation": "

The DNIS phone number to route emergency calls to, in E.164 format.

", + "smithy.api#required": {} + } + }, "CallingCountry": { "target": "com.amazonaws.chime#Alpha2CountryCode", "traits": { @@ -2423,13 +2430,6 @@ "traits": { "smithy.api#documentation": "

The DNIS phone number to route test emergency calls to, in E.164 format.

" } - }, - "EmergencyPhoneNumber": { - "target": "com.amazonaws.chime#E164PhoneNumber", - "traits": { - "smithy.api#documentation": "

The DNIS phone number to route emergency calls to, in E.164 format.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2606,18 +2606,18 @@ "com.amazonaws.chime#DeleteEventsConfigurationRequest": { "type": "structure", "members": { - "BotId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The bot ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AccountId": { + "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The bot ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2867,18 +2867,18 @@ "smithy.api#required": {} } }, - "AccountId": { + "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The room ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RoomId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The room ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3467,18 +3467,18 @@ "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorGroupRequest": { "type": "structure", "members": { - "VoiceConnectorGroupId": { - "target": "com.amazonaws.chime#NonEmptyString", + "E164PhoneNumbers": { + "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector group ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", "smithy.api#required": {} } }, - "E164PhoneNumbers": { - "target": "com.amazonaws.chime#E164PhoneNumberList", + "VoiceConnectorGroupId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", + "smithy.api#documentation": "

The Amazon Chime Voice Connector group ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -3498,13 +3498,6 @@ "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorRequest": { "type": "structure", "members": { - "E164PhoneNumbers": { - "target": "com.amazonaws.chime#E164PhoneNumberList", - "traits": { - "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", - "smithy.api#required": {} - } - }, "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -3512,6 +3505,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "E164PhoneNumbers": { + "target": "com.amazonaws.chime#E164PhoneNumberList", + "traits": { + "smithy.api#documentation": "

List of phone numbers, in E.164 format.

", + "smithy.api#required": {} + } } } }, @@ -3687,6 +3687,10 @@ "value": "Throttled", "name": "Throttled" }, + { + "value": "Throttling", + "name": "Throttling" + }, { "value": "Unauthorized", "name": "Unauthorized" @@ -3715,17 +3719,17 @@ "smithy.api#documentation": "

Lambda function ARN that allows a bot to receive outgoing events.

" } }, - "OutboundEventsHTTPSEndpoint": { - "target": "com.amazonaws.chime#SensitiveString", - "traits": { - "smithy.api#documentation": "

HTTPS endpoint that allows a bot to receive outgoing events.

" - } - }, "BotId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "

The bot ID.

" } + }, + "OutboundEventsHTTPSEndpoint": { + "target": "com.amazonaws.chime#SensitiveString", + "traits": { + "smithy.api#documentation": "

HTTPS endpoint that allows a bot to receive outgoing events.

" + } } }, "traits": { @@ -3755,11 +3759,11 @@ "com.amazonaws.chime#ForbiddenException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.chime#String" - }, "Code": { "target": "com.amazonaws.chime#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chime#String" } }, "traits": { @@ -4048,18 +4052,18 @@ "com.amazonaws.chime#GetBotRequest": { "type": "structure", "members": { - "BotId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The bot ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AccountId": { + "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The bot ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4429,17 +4433,17 @@ "com.amazonaws.chime#GetPhoneNumberSettingsResponse": { "type": "structure", "members": { - "CallingNameUpdatedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", - "traits": { - "smithy.api#documentation": "

The updated outbound calling name timestamp, in ISO 8601 format.

" - } - }, "CallingName": { "target": "com.amazonaws.chime#CallingName", "traits": { "smithy.api#documentation": "

The default outbound calling name for the account.

" } + }, + "CallingNameUpdatedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The updated outbound calling name timestamp, in ISO 8601 format.

" + } } } }, @@ -4486,18 +4490,18 @@ "com.amazonaws.chime#GetProxySessionRequest": { "type": "structure", "members": { - "ProxySessionId": { + "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { - "smithy.api#documentation": "

The proxy session ID.

", + "smithy.api#documentation": "

The Amazon Chime voice connector ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "VoiceConnectorId": { + "ProxySessionId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { - "smithy.api#documentation": "

The Amazon Chime voice connector ID.

", + "smithy.api#documentation": "

The proxy session ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4700,18 +4704,18 @@ "com.amazonaws.chime#GetUserRequest": { "type": "structure", "members": { - "UserId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The user ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AccountId": { + "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The user ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5392,18 +5396,6 @@ "com.amazonaws.chime#Invite": { "type": "structure", "members": { - "EmailStatus": { - "target": "com.amazonaws.chime#EmailStatus", - "traits": { - "smithy.api#documentation": "

The status of the invite email.

" - } - }, - "Status": { - "target": "com.amazonaws.chime#InviteStatus", - "traits": { - "smithy.api#documentation": "

The status of the invite.

" - } - }, "InviteId": { "target": "com.amazonaws.chime#String", "traits": { @@ -5415,6 +5407,18 @@ "traits": { "smithy.api#documentation": "

The email address to which the invite is sent.

" } + }, + "Status": { + "target": "com.amazonaws.chime#InviteStatus", + "traits": { + "smithy.api#documentation": "

The status of the invite.

" + } + }, + "EmailStatus": { + "target": "com.amazonaws.chime#EmailStatus", + "traits": { + "smithy.api#documentation": "

The status of the invite email.

" + } } }, "traits": { @@ -5489,14 +5493,6 @@ "com.amazonaws.chime#InviteUsersRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.chime#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "UserType": { "target": "com.amazonaws.chime#UserType", "traits": { @@ -5509,6 +5505,14 @@ "smithy.api#documentation": "

The user email addresses to which to send the email invitation.

", "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -5616,18 +5620,18 @@ "com.amazonaws.chime#ListAccountsRequest": { "type": "structure", "members": { - "UserEmail": { - "target": "com.amazonaws.chime#EmailAddress", - "traits": { - "smithy.api#documentation": "

User email address with which to filter results.

", - "smithy.api#httpQuery": "user-email" + "NextToken": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" } }, - "Name": { - "target": "com.amazonaws.chime#AccountName", + "UserEmail": { + "target": "com.amazonaws.chime#EmailAddress", "traits": { - "smithy.api#documentation": "

Amazon Chime account name prefix with which to filter results.

", - "smithy.api#httpQuery": "name" + "smithy.api#documentation": "

User email address with which to filter results.

", + "smithy.api#httpQuery": "user-email" } }, "MaxResults": { @@ -5637,11 +5641,11 @@ "smithy.api#httpQuery": "max-results" } }, - "NextToken": { - "target": "com.amazonaws.chime#String", + "Name": { + "target": "com.amazonaws.chime#AccountName", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

Amazon Chime account name prefix with which to filter results.

", + "smithy.api#httpQuery": "name" } } } @@ -5706,18 +5710,18 @@ "com.amazonaws.chime#ListAttendeeTagsRequest": { "type": "structure", "members": { - "AttendeeId": { + "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { - "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

", + "smithy.api#documentation": "

The Amazon Chime SDK meeting ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MeetingId": { + "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { - "smithy.api#documentation": "

The Amazon Chime SDK meeting ID.

", + "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5790,6 +5794,13 @@ "smithy.api#httpQuery": "max-results" } }, + "NextToken": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" + } + }, "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { @@ -5797,13 +5808,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.chime#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#httpQuery": "next-token" - } } } }, @@ -5872,6 +5876,14 @@ "com.amazonaws.chime#ListBotsRequest": { "type": "structure", "members": { + "AccountId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { @@ -5885,14 +5897,6 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", "smithy.api#httpQuery": "next-token" } - }, - "AccountId": { - "target": "com.amazonaws.chime#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -6100,36 +6104,36 @@ "com.amazonaws.chime#ListPhoneNumberOrdersRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.chime#ResultMax", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call.

", - "smithy.api#httpQuery": "max-results" - } - }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", "smithy.api#httpQuery": "next-token" } + }, + "MaxResults": { + "target": "com.amazonaws.chime#ResultMax", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call.

", + "smithy.api#httpQuery": "max-results" + } } } }, "com.amazonaws.chime#ListPhoneNumberOrdersResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.chime#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, "PhoneNumberOrders": { "target": "com.amazonaws.chime#PhoneNumberOrderList", "traits": { "smithy.api#documentation": "

The phone number order details.

" } + }, + "NextToken": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } } } }, @@ -6178,18 +6182,25 @@ "com.amazonaws.chime#ListPhoneNumbersRequest": { "type": "structure", "members": { - "FilterValue": { + "Status": { + "target": "com.amazonaws.chime#PhoneNumberStatus", + "traits": { + "smithy.api#documentation": "

The phone number status.

", + "smithy.api#httpQuery": "status" + } + }, + "NextToken": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The value to use for the filter.

", - "smithy.api#httpQuery": "filter-value" + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" } }, - "FilterName": { - "target": "com.amazonaws.chime#PhoneNumberAssociationName", + "MaxResults": { + "target": "com.amazonaws.chime#ResultMax", "traits": { - "smithy.api#documentation": "

The filter to use to limit the number of results.

", - "smithy.api#httpQuery": "filter-name" + "smithy.api#documentation": "

The maximum number of results to return in a single call.

", + "smithy.api#httpQuery": "max-results" } }, "ProductType": { @@ -6199,25 +6210,18 @@ "smithy.api#httpQuery": "product-type" } }, - "Status": { - "target": "com.amazonaws.chime#PhoneNumberStatus", - "traits": { - "smithy.api#documentation": "

The phone number status.

", - "smithy.api#httpQuery": "status" - } - }, - "MaxResults": { - "target": "com.amazonaws.chime#ResultMax", + "FilterValue": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call.

", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "

The value to use for the filter.

", + "smithy.api#httpQuery": "filter-value" } }, - "NextToken": { - "target": "com.amazonaws.chime#String", + "FilterName": { + "target": "com.amazonaws.chime#PhoneNumberAssociationName", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

The filter to use to limit the number of results.

", + "smithy.api#httpQuery": "filter-name" } } } @@ -6225,17 +6229,17 @@ "com.amazonaws.chime#ListPhoneNumbersResponse": { "type": "structure", "members": { - "PhoneNumbers": { - "target": "com.amazonaws.chime#PhoneNumberList", - "traits": { - "smithy.api#documentation": "

The phone number details.

" - } - }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" } + }, + "PhoneNumbers": { + "target": "com.amazonaws.chime#PhoneNumberList", + "traits": { + "smithy.api#documentation": "

The phone number details.

" + } } } }, @@ -6301,6 +6305,13 @@ "smithy.api#httpQuery": "status" } }, + "NextToken": { + "target": "com.amazonaws.chime#NextTokenString", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" + } + }, "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { @@ -6308,30 +6319,23 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.chime#NextTokenString", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#httpQuery": "next-token" - } } } }, "com.amazonaws.chime#ListProxySessionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.chime#NextTokenString", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, "ProxySessions": { "target": "com.amazonaws.chime#ProxySessions", "traits": { "smithy.api#documentation": "

The proxy session details.

" } + }, + "NextToken": { + "target": "com.amazonaws.chime#NextTokenString", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } } } }, @@ -6391,11 +6395,12 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.chime#ResultMax", + "RoomId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call.

", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "

The room ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "NextToken": { @@ -6405,12 +6410,11 @@ "smithy.api#httpQuery": "next-token" } }, - "RoomId": { - "target": "com.amazonaws.chime#NonEmptyString", + "MaxResults": { + "target": "com.amazonaws.chime#ResultMax", "traits": { - "smithy.api#documentation": "

The room ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to return in a single call.

", + "smithy.api#httpQuery": "max-results" } } } @@ -6418,17 +6422,17 @@ "com.amazonaws.chime#ListRoomMembershipsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.chime#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, "RoomMemberships": { "target": "com.amazonaws.chime#RoomMembershipList", "traits": { "smithy.api#documentation": "

The room membership details.

" } + }, + "NextToken": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } } } }, @@ -6480,13 +6484,6 @@ "com.amazonaws.chime#ListRoomsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.chime#ResultMax", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call.

", - "smithy.api#httpQuery": "max-results" - } - }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -6495,11 +6492,11 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.chime#String", + "MaxResults": { + "target": "com.amazonaws.chime#ResultMax", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

The maximum number of results to return in a single call.

", + "smithy.api#httpQuery": "max-results" } }, "MemberId": { @@ -6508,6 +6505,13 @@ "smithy.api#documentation": "

The member ID (user ID or bot ID).

", "smithy.api#httpQuery": "member-id" } + }, + "NextToken": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" + } } } }, @@ -6651,6 +6655,13 @@ "smithy.api#httpQuery": "user-email" } }, + "MaxResults": { + "target": "com.amazonaws.chime#ProfileServiceMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. Defaults to 100.

", + "smithy.api#httpQuery": "max-results" + } + }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -6665,13 +6676,6 @@ "smithy.api#documentation": "

The user type.

", "smithy.api#httpQuery": "user-type" } - }, - "MaxResults": { - "target": "com.amazonaws.chime#ProfileServiceMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. Defaults to 100.

", - "smithy.api#httpQuery": "max-results" - } } } }, @@ -6898,17 +6902,17 @@ "com.amazonaws.chime#ListVoiceConnectorsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.chime#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, "VoiceConnectors": { "target": "com.amazonaws.chime#VoiceConnectorList", "traits": { "smithy.api#documentation": "

The details of the Amazon Chime Voice Connectors.

" } + }, + "NextToken": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } } } }, @@ -6994,46 +6998,46 @@ "com.amazonaws.chime#MediaPlacement": { "type": "structure", "members": { - "ScreenViewingUrl": { + "SignalingUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The screen viewing URL.

" + "smithy.api#documentation": "

The signaling URL.

" } }, - "AudioFallbackUrl": { + "ScreenSharingUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The audio fallback URL.

" + "smithy.api#documentation": "

The screen sharing URL.

" } }, - "TurnControlUrl": { + "AudioHostUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The turn control URL.

" + "smithy.api#documentation": "

The audio host URL.

" } }, - "ScreenDataUrl": { + "ScreenViewingUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The screen data URL.

" + "smithy.api#documentation": "

The screen viewing URL.

" } }, - "ScreenSharingUrl": { + "ScreenDataUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The screen sharing URL.

" + "smithy.api#documentation": "

The screen data URL.

" } }, - "AudioHostUrl": { + "TurnControlUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The audio host URL.

" + "smithy.api#documentation": "

The turn control URL.

" } }, - "SignalingUrl": { + "AudioFallbackUrl": { "target": "com.amazonaws.chime#UriType", "traits": { - "smithy.api#documentation": "

The signaling URL.

" + "smithy.api#documentation": "

The audio fallback URL.

" } } }, @@ -7044,10 +7048,10 @@ "com.amazonaws.chime#Meeting": { "type": "structure", "members": { - "ExternalMeetingId": { - "target": "com.amazonaws.chime#ExternalMeetingIdType", + "MediaRegion": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The external meeting ID.

" + "smithy.api#documentation": "

The Region in which to create the meeting. Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

" } }, "MediaPlacement": { @@ -7062,10 +7066,10 @@ "smithy.api#documentation": "

The Amazon Chime SDK meeting ID.

" } }, - "MediaRegion": { - "target": "com.amazonaws.chime#String", + "ExternalMeetingId": { + "target": "com.amazonaws.chime#ExternalMeetingIdType", "traits": { - "smithy.api#documentation": "

The Region in which to create the meeting. Available values: ap-northeast-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

" + "smithy.api#documentation": "

The external meeting ID.

" } } }, @@ -7126,34 +7130,34 @@ "com.amazonaws.chime#Member": { "type": "structure", "members": { - "Email": { - "target": "com.amazonaws.chime#SensitiveString", + "MemberType": { + "target": "com.amazonaws.chime#MemberType", "traits": { - "smithy.api#documentation": "

The member email address.

" + "smithy.api#documentation": "

The member type.

" } }, - "MemberId": { - "target": "com.amazonaws.chime#NonEmptyString", + "FullName": { + "target": "com.amazonaws.chime#SensitiveString", "traits": { - "smithy.api#documentation": "

The member ID (user ID or bot ID).

" + "smithy.api#documentation": "

The member name.

" } }, - "AccountId": { + "MemberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

" + "smithy.api#documentation": "

The member ID (user ID or bot ID).

" } }, - "FullName": { + "Email": { "target": "com.amazonaws.chime#SensitiveString", "traits": { - "smithy.api#documentation": "

The member name.

" + "smithy.api#documentation": "

The member email address.

" } }, - "MemberType": { - "target": "com.amazonaws.chime#MemberType", + "AccountId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The member type.

" + "smithy.api#documentation": "

The Amazon Chime account ID.

" } } }, @@ -7170,17 +7174,17 @@ "smithy.api#documentation": "

The error code.

" } }, - "MemberId": { - "target": "com.amazonaws.chime#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The member ID.

" - } - }, "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "

The error message.

" } + }, + "MemberId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The member ID.

" + } } }, "traits": { @@ -7384,17 +7388,17 @@ "com.amazonaws.chime#Origination": { "type": "structure", "members": { - "Routes": { - "target": "com.amazonaws.chime#OriginationRouteList", - "traits": { - "smithy.api#documentation": "

The call distribution properties defined for your SIP hosts. Valid range: Minimum value\n of 1. Maximum value of 20.

" - } - }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "

When origination settings are disabled, inbound calls are not enabled for your Amazon\n Chime Voice Connector.

" } + }, + "Routes": { + "target": "com.amazonaws.chime#OriginationRouteList", + "traits": { + "smithy.api#documentation": "

The call distribution properties defined for your SIP hosts. Valid range: Minimum value\n of 1. Maximum value of 20.

" + } } }, "traits": { @@ -7416,12 +7420,6 @@ "smithy.api#documentation": "

The priority associated with the host, with 1 being the highest priority. Higher\n priority hosts are attempted first.

" } }, - "Port": { - "target": "com.amazonaws.chime#Port", - "traits": { - "smithy.api#documentation": "

The designated origination route port. Defaults to 5060.

" - } - }, "Host": { "target": "com.amazonaws.chime#String", "traits": { @@ -7433,6 +7431,12 @@ "traits": { "smithy.api#documentation": "

The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

" } + }, + "Port": { + "target": "com.amazonaws.chime#Port", + "traits": { + "smithy.api#documentation": "

The designated origination route port. Defaults to 5060.

" + } } }, "traits": { @@ -7521,22 +7525,16 @@ "com.amazonaws.chime#PhoneNumber": { "type": "structure", "members": { - "CreatedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", - "traits": { - "smithy.api#documentation": "

The phone number creation timestamp, in ISO 8601 format.

" - } - }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "

The updated phone number timestamp, in ISO 8601 format.

" } }, - "Type": { - "target": "com.amazonaws.chime#PhoneNumberType", + "CreatedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The phone number type.

" + "smithy.api#documentation": "

The phone number creation timestamp, in ISO 8601 format.

" } }, "CallingName": { @@ -7545,28 +7543,34 @@ "smithy.api#documentation": "

The outbound calling name associated with the phone number.

" } }, + "Type": { + "target": "com.amazonaws.chime#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The phone number type.

" + } + }, "PhoneNumberId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "

The phone number ID.

" } }, - "Associations": { - "target": "com.amazonaws.chime#PhoneNumberAssociationList", + "DeletionTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The phone number associations.

" + "smithy.api#documentation": "

The deleted phone number timestamp, in ISO 8601 format.

" } }, - "E164PhoneNumber": { - "target": "com.amazonaws.chime#E164PhoneNumber", + "Capabilities": { + "target": "com.amazonaws.chime#PhoneNumberCapabilities", "traits": { - "smithy.api#documentation": "

The phone number, in E.164 format.

" + "smithy.api#documentation": "

The phone number capabilities.

" } }, - "ProductType": { - "target": "com.amazonaws.chime#PhoneNumberProductType", + "Status": { + "target": "com.amazonaws.chime#PhoneNumberStatus", "traits": { - "smithy.api#documentation": "

The phone number product type.

" + "smithy.api#documentation": "

The phone number status.

" } }, "CallingNameStatus": { @@ -7575,22 +7579,22 @@ "smithy.api#documentation": "

The outbound calling name status.

" } }, - "Capabilities": { - "target": "com.amazonaws.chime#PhoneNumberCapabilities", + "ProductType": { + "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { - "smithy.api#documentation": "

The phone number capabilities.

" + "smithy.api#documentation": "

The phone number product type.

" } }, - "Status": { - "target": "com.amazonaws.chime#PhoneNumberStatus", + "Associations": { + "target": "com.amazonaws.chime#PhoneNumberAssociationList", "traits": { - "smithy.api#documentation": "

The phone number status.

" + "smithy.api#documentation": "

The phone number associations.

" } }, - "DeletionTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", + "E164PhoneNumber": { + "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { - "smithy.api#documentation": "

The deleted phone number timestamp, in ISO 8601 format.

" + "smithy.api#documentation": "

The phone number, in E.164 format.

" } } }, @@ -7607,17 +7611,17 @@ "smithy.api#documentation": "

The timestamp of the phone number association, in ISO 8601 format.

" } }, - "Value": { - "target": "com.amazonaws.chime#String", - "traits": { - "smithy.api#documentation": "

Contains the ID for the entity specified in Name.

" - } - }, "Name": { "target": "com.amazonaws.chime#PhoneNumberAssociationName", "traits": { "smithy.api#documentation": "

Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice\n Connector ID, or Amazon Chime Voice Connector group ID.

" } + }, + "Value": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

Contains the ID for the entity specified in Name.

" + } } }, "traits": { @@ -7668,28 +7672,28 @@ "smithy.api#documentation": "

Allows or denies inbound SMS messaging for the specified phone number.

" } }, - "InboundCall": { + "OutboundSMS": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { - "smithy.api#documentation": "

Allows or denies inbound calling for the specified phone number.

" + "smithy.api#documentation": "

Allows or denies outbound SMS messaging for the specified phone number.

" } }, - "OutboundSMS": { + "InboundMMS": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { - "smithy.api#documentation": "

Allows or denies outbound SMS messaging for the specified phone number.

" + "smithy.api#documentation": "

Allows or denies inbound MMS messaging for the specified phone number.

" } }, - "OutboundMMS": { + "InboundCall": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { - "smithy.api#documentation": "

Allows or denies outbound MMS messaging for the specified phone number.

" + "smithy.api#documentation": "

Allows or denies inbound calling for the specified phone number.

" } }, - "InboundMMS": { + "OutboundMMS": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { - "smithy.api#documentation": "

Allows or denies inbound MMS messaging for the specified phone number.

" + "smithy.api#documentation": "

Allows or denies outbound MMS messaging for the specified phone number.

" } } }, @@ -7706,17 +7710,17 @@ "smithy.api#documentation": "

The phone number ID for which the action failed.

" } }, - "ErrorCode": { - "target": "com.amazonaws.chime#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code.

" - } - }, "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "

The error message.

" } + }, + "ErrorCode": { + "target": "com.amazonaws.chime#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

" + } } }, "traits": { @@ -7760,16 +7764,10 @@ "smithy.api#documentation": "

The updated phone number order timestamp, in ISO 8601 format.

" } }, - "CreatedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", - "traits": { - "smithy.api#documentation": "

The phone number order creation timestamp, in ISO 8601 format.

" - } - }, - "ProductType": { - "target": "com.amazonaws.chime#PhoneNumberProductType", + "Status": { + "target": "com.amazonaws.chime#PhoneNumberOrderStatus", "traits": { - "smithy.api#documentation": "

The phone number order product type.

" + "smithy.api#documentation": "

The status of the phone number order.

" } }, "PhoneNumberOrderId": { @@ -7778,10 +7776,16 @@ "smithy.api#documentation": "

The phone number order ID.

" } }, - "Status": { - "target": "com.amazonaws.chime#PhoneNumberOrderStatus", + "ProductType": { + "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { - "smithy.api#documentation": "

The status of the phone number order.

" + "smithy.api#documentation": "

The phone number order product type.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The phone number order creation timestamp, in ISO 8601 format.

" } } }, @@ -7925,6 +7929,12 @@ "smithy.api#documentation": "

The phone number to route calls to after a proxy session expires.

" } }, + "PhoneNumberCountries": { + "target": "com.amazonaws.chime#StringList", + "traits": { + "smithy.api#documentation": "

The countries for proxy phone numbers to be selected from.

" + } + }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { @@ -7936,12 +7946,6 @@ "traits": { "smithy.api#documentation": "

The default number of minutes allowed for proxy sessions.

" } - }, - "PhoneNumberCountries": { - "target": "com.amazonaws.chime#StringList", - "traits": { - "smithy.api#documentation": "

The countries for proxy phone numbers to be selected from.

" - } } }, "traits": { @@ -7957,22 +7961,22 @@ "smithy.api#documentation": "

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

" } }, - "Name": { - "target": "com.amazonaws.chime#String128", + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString128", "traits": { - "smithy.api#documentation": "

The name of the proxy session.

" + "smithy.api#documentation": "

The Amazon Chime voice connector ID.

" } }, - "UpdatedTimestamp": { + "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The updated timestamp, in ISO 8601 format.

" + "smithy.api#documentation": "

The created timestamp, in ISO 8601 format.

" } }, - "Status": { - "target": "com.amazonaws.chime#ProxySessionStatus", + "Name": { + "target": "com.amazonaws.chime#String128", "traits": { - "smithy.api#documentation": "

The status of the proxy session.

" + "smithy.api#documentation": "

The name of the proxy session.

" } }, "GeoMatchLevel": { @@ -7981,28 +7985,22 @@ "smithy.api#documentation": "

The preference for matching the country or area code of the proxy phone number with that of the first participant.

" } }, - "ProxySessionId": { - "target": "com.amazonaws.chime#NonEmptyString128", - "traits": { - "smithy.api#documentation": "

The proxy session ID.

" - } - }, - "ExpiryMinutes": { - "target": "com.amazonaws.chime#PositiveInteger", + "EndedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The number of minutes allowed for the proxy session.

" + "smithy.api#documentation": "

The ended timestamp, in ISO 8601 format.

" } }, - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString128", + "UpdatedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Chime voice connector ID.

" + "smithy.api#documentation": "

The updated timestamp, in ISO 8601 format.

" } }, - "Participants": { - "target": "com.amazonaws.chime#Participants", + "Capabilities": { + "target": "com.amazonaws.chime#CapabilityList", "traits": { - "smithy.api#documentation": "

The proxy session participants.

" + "smithy.api#documentation": "

The proxy session capabilities.

" } }, "GeoMatchParams": { @@ -8011,22 +8009,28 @@ "smithy.api#documentation": "

The country and area code for the proxy phone number.

" } }, - "Capabilities": { - "target": "com.amazonaws.chime#CapabilityList", + "Participants": { + "target": "com.amazonaws.chime#Participants", "traits": { - "smithy.api#documentation": "

The proxy session capabilities.

" + "smithy.api#documentation": "

The proxy session participants.

" } }, - "EndedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", + "ExpiryMinutes": { + "target": "com.amazonaws.chime#PositiveInteger", "traits": { - "smithy.api#documentation": "

The ended timestamp, in ISO 8601 format.

" + "smithy.api#documentation": "

The number of minutes allowed for the proxy session.

" } }, - "CreatedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", + "Status": { + "target": "com.amazonaws.chime#ProxySessionStatus", "traits": { - "smithy.api#documentation": "

The created timestamp, in ISO 8601 format.

" + "smithy.api#documentation": "

The status of the proxy session.

" + } + }, + "ProxySessionId": { + "target": "com.amazonaws.chime#NonEmptyString128", + "traits": { + "smithy.api#documentation": "

The proxy session ID.

" } } }, @@ -8121,18 +8125,18 @@ "smithy.api#documentation": "

HTTPS endpoint that allows the bot to receive outgoing events.

" } }, - "AccountId": { + "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The bot ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "BotId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The bot ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8341,13 +8345,6 @@ "com.amazonaws.chime#PutVoiceConnectorLoggingConfigurationRequest": { "type": "structure", "members": { - "LoggingConfiguration": { - "target": "com.amazonaws.chime#LoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The logging configuration details to add.

", - "smithy.api#required": {} - } - }, "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -8355,6 +8352,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "LoggingConfiguration": { + "target": "com.amazonaws.chime#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The logging configuration details to add.

", + "smithy.api#required": {} + } } } }, @@ -8412,18 +8416,18 @@ "com.amazonaws.chime#PutVoiceConnectorOriginationRequest": { "type": "structure", "members": { - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString", + "Origination": { + "target": "com.amazonaws.chime#Origination", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The origination setting details to add.

", "smithy.api#required": {} } }, - "Origination": { - "target": "com.amazonaws.chime#Origination", + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The origination setting details to add.

", + "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -8486,17 +8490,10 @@ "com.amazonaws.chime#PutVoiceConnectorProxyRequest": { "type": "structure", "members": { - "Disabled": { - "target": "com.amazonaws.chime#Boolean", - "traits": { - "smithy.api#documentation": "

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

" - } - }, - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString128", + "PhoneNumberPoolCountries": { + "target": "com.amazonaws.chime#CountryList", "traits": { - "smithy.api#documentation": "

The Amazon Chime voice connector ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The countries for proxy phone numbers to be selected from.

", "smithy.api#required": {} } }, @@ -8507,17 +8504,24 @@ "smithy.api#required": {} } }, + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString128", + "traits": { + "smithy.api#documentation": "

The Amazon Chime voice connector ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "FallBackPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "

The phone number to route calls to after a proxy session expires.

" } }, - "PhoneNumberPoolCountries": { - "target": "com.amazonaws.chime#CountryList", + "Disabled": { + "target": "com.amazonaws.chime#Boolean", "traits": { - "smithy.api#documentation": "

The countries for proxy phone numbers to be selected from.

", - "smithy.api#required": {} + "smithy.api#documentation": "

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

" } } } @@ -8576,18 +8580,18 @@ "com.amazonaws.chime#PutVoiceConnectorStreamingConfigurationRequest": { "type": "structure", "members": { - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString", + "StreamingConfiguration": { + "target": "com.amazonaws.chime#StreamingConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The streaming configuration details to add.

", "smithy.api#required": {} } }, - "StreamingConfiguration": { - "target": "com.amazonaws.chime#StreamingConfiguration", + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The streaming configuration details to add.

", + "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -8706,18 +8710,18 @@ "com.amazonaws.chime#PutVoiceConnectorTerminationRequest": { "type": "structure", "members": { - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString", + "Termination": { + "target": "com.amazonaws.chime#Termination", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The termination setting details to add.

", "smithy.api#required": {} } }, - "Termination": { - "target": "com.amazonaws.chime#Termination", + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The termination setting details to add.

", + "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -9011,18 +9015,18 @@ "com.amazonaws.chime#ResetPersonalPINRequest": { "type": "structure", "members": { - "UserId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The user ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AccountId": { + "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The user ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9146,17 +9150,17 @@ "com.amazonaws.chime#RetentionSettings": { "type": "structure", "members": { - "RoomRetentionSettings": { - "target": "com.amazonaws.chime#RoomRetentionSettings", - "traits": { - "smithy.api#documentation": "

The chat room retention settings.

" - } - }, "ConversationRetentionSettings": { "target": "com.amazonaws.chime#ConversationRetentionSettings", "traits": { "smithy.api#documentation": "

The chat conversation retention settings.

" } + }, + "RoomRetentionSettings": { + "target": "com.amazonaws.chime#RoomRetentionSettings", + "traits": { + "smithy.api#documentation": "

The chat room retention settings.

" + } } }, "traits": { @@ -9166,22 +9170,22 @@ "com.amazonaws.chime#Room": { "type": "structure", "members": { - "CreatedTimestamp": { - "target": "com.amazonaws.chime#Iso8601Timestamp", - "traits": { - "smithy.api#documentation": "

The room creation timestamp, in ISO 8601 format.

" - } - }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Chime account ID.

" } }, - "UpdatedTimestamp": { + "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The room update timestamp, in ISO 8601 format.

" + "smithy.api#documentation": "

The room creation timestamp, in ISO 8601 format.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the room creator.

" } }, "Name": { @@ -9196,10 +9200,10 @@ "smithy.api#documentation": "

The room ID.

" } }, - "CreatedBy": { - "target": "com.amazonaws.chime#NonEmptyString", + "UpdatedTimestamp": { + "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The identifier of the room creator.

" + "smithy.api#documentation": "

The room update timestamp, in ISO 8601 format.

" } } }, @@ -9216,19 +9220,16 @@ "com.amazonaws.chime#RoomMembership": { "type": "structure", "members": { - "Role": { - "target": "com.amazonaws.chime#RoomMembershipRole", + "RoomId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The membership role.

" + "smithy.api#documentation": "

The room ID.

" } }, - "Member": { - "target": "com.amazonaws.chime#Member" - }, - "RoomId": { + "InvitedBy": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The room ID.

" + "smithy.api#documentation": "

The identifier of the user that invited the room member.

" } }, "UpdatedTimestamp": { @@ -9237,10 +9238,13 @@ "smithy.api#documentation": "

The room membership update timestamp, in ISO 8601 format.

" } }, - "InvitedBy": { - "target": "com.amazonaws.chime#NonEmptyString", + "Member": { + "target": "com.amazonaws.chime#Member" + }, + "Role": { + "target": "com.amazonaws.chime#RoomMembershipRole", "traits": { - "smithy.api#documentation": "

The identifier of the user that invited the room member.

" + "smithy.api#documentation": "

The membership role.

" } } }, @@ -9326,13 +9330,6 @@ "com.amazonaws.chime#SearchAvailablePhoneNumbersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.chime#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#httpQuery": "next-token" - } - }, "TollFreePrefix": { "target": "com.amazonaws.chime#TollFreePrefix", "traits": { @@ -9340,25 +9337,25 @@ "smithy.api#httpQuery": "toll-free-prefix" } }, - "Country": { + "NextToken": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The country used to filter results.

", - "smithy.api#httpQuery": "country" + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" } }, - "City": { + "AreaCode": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The city used to filter results.

", - "smithy.api#httpQuery": "city" + "smithy.api#documentation": "

The area code used to filter results.

", + "smithy.api#httpQuery": "area-code" } }, - "State": { + "City": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The state used to filter results.

", - "smithy.api#httpQuery": "state" + "smithy.api#documentation": "

The city used to filter results.

", + "smithy.api#httpQuery": "city" } }, "MaxResults": { @@ -9368,11 +9365,18 @@ "smithy.api#httpQuery": "max-results" } }, - "AreaCode": { + "State": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The area code used to filter results.

", - "smithy.api#httpQuery": "area-code" + "smithy.api#documentation": "

The state used to filter results.

", + "smithy.api#httpQuery": "state" + } + }, + "Country": { + "target": "com.amazonaws.chime#String", + "traits": { + "smithy.api#documentation": "

The country used to filter results.

", + "smithy.api#httpQuery": "country" } } } @@ -9403,11 +9407,11 @@ "com.amazonaws.chime#ServiceFailureException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.chime#ErrorCode" - }, "Message": { "target": "com.amazonaws.chime#String" + }, + "Code": { + "target": "com.amazonaws.chime#ErrorCode" } }, "traits": { @@ -9419,11 +9423,11 @@ "com.amazonaws.chime#ServiceUnavailableException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.chime#String" - }, "Code": { "target": "com.amazonaws.chime#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chime#String" } }, "traits": { @@ -9462,17 +9466,17 @@ "smithy.api#required": {} } }, - "Disabled": { - "target": "com.amazonaws.chime#Boolean", - "traits": { - "smithy.api#documentation": "

When true, media streaming to Amazon Kinesis is turned off.

" - } - }, "StreamingNotificationTargets": { "target": "com.amazonaws.chime#StreamingNotificationTargetList", "traits": { "smithy.api#documentation": "

The streaming notification targets.

" } + }, + "Disabled": { + "target": "com.amazonaws.chime#Boolean", + "traits": { + "smithy.api#documentation": "

When true, media streaming to Amazon Kinesis is turned off.

" + } } }, "traits": { @@ -9527,17 +9531,17 @@ "com.amazonaws.chime#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.chime#TagValue", + "Key": { + "target": "com.amazonaws.chime#TagKey", "traits": { - "smithy.api#documentation": "

The value of the tag.

", + "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.chime#TagKey", + "Value": { + "target": "com.amazonaws.chime#TagValue", "traits": { - "smithy.api#documentation": "

The key of the tag.

", + "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } } @@ -9597,18 +9601,18 @@ "smithy.api#required": {} } }, - "AttendeeId": { - "target": "com.amazonaws.chime#GuidString", + "Tags": { + "target": "com.amazonaws.chime#AttendeeTagList", "traits": { - "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The tag key-value pairs.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.chime#AttendeeTagList", + "AttendeeId": { + "target": "com.amazonaws.chime#GuidString", "traits": { - "smithy.api#documentation": "

The tag key-value pairs.

", + "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -9803,16 +9807,10 @@ "com.amazonaws.chime#Termination": { "type": "structure", "members": { - "CallingRegions": { - "target": "com.amazonaws.chime#CallingRegionList", - "traits": { - "smithy.api#documentation": "

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

" - } - }, - "DefaultPhoneNumber": { - "target": "com.amazonaws.chime#E164PhoneNumber", + "CidrAllowedList": { + "target": "com.amazonaws.chime#StringList", "traits": { - "smithy.api#documentation": "

The default caller ID phone number.

" + "smithy.api#documentation": "

The IP addresses allowed to make calls, in CIDR format. Required.

" } }, "Disabled": { @@ -9827,10 +9825,16 @@ "smithy.api#documentation": "

The limit on calls per second. Max value based on account service quota. Default value\n of 1.

" } }, - "CidrAllowedList": { - "target": "com.amazonaws.chime#StringList", + "DefaultPhoneNumber": { + "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { - "smithy.api#documentation": "

The IP addresses allowed to make calls, in CIDR format. Required.

" + "smithy.api#documentation": "

The default caller ID phone number.

" + } + }, + "CallingRegions": { + "target": "com.amazonaws.chime#CallingRegionList", + "traits": { + "smithy.api#documentation": "

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

" } } }, @@ -10251,7 +10255,7 @@ "sdkId": "Chime", "arnNamespace": "chime", "cloudFormationName": "Chime", - "cloudTrailEventSource": "ucbuzzconsoleservice.amazonaws.com" + "cloudTrailEventSource": "chime.amazonaws.com" }, "aws.auth#sigv4": { "name": "chime" @@ -10264,11 +10268,11 @@ "com.amazonaws.chime#UnauthorizedClientException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.chime#ErrorCode" - }, "Message": { "target": "com.amazonaws.chime#String" + }, + "Code": { + "target": "com.amazonaws.chime#ErrorCode" } }, "traits": { @@ -10340,18 +10344,18 @@ "smithy.api#required": {} } }, - "AttendeeId": { + "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { - "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

", + "smithy.api#documentation": "

The Amazon Chime SDK meeting ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MeetingId": { + "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { - "smithy.api#documentation": "

The Amazon Chime SDK meeting ID.

", + "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10648,14 +10652,6 @@ "com.amazonaws.chime#UpdateBotRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.chime#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -10669,6 +10665,14 @@ "traits": { "smithy.api#documentation": "

When true, stops the specified bot from running in your account.

" } + }, + "AccountId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -10720,17 +10724,17 @@ "com.amazonaws.chime#UpdateGlobalSettingsRequest": { "type": "structure", "members": { - "BusinessCalling": { - "target": "com.amazonaws.chime#BusinessCallingSettings", + "VoiceConnector": { + "target": "com.amazonaws.chime#VoiceConnectorSettings", "traits": { - "smithy.api#documentation": "

The Amazon Chime Business Calling settings.

", + "smithy.api#documentation": "

The Amazon Chime Voice Connector settings.

", "smithy.api#required": {} } }, - "VoiceConnector": { - "target": "com.amazonaws.chime#VoiceConnectorSettings", + "BusinessCalling": { + "target": "com.amazonaws.chime#BusinessCallingSettings", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector settings.

", + "smithy.api#documentation": "

The Amazon Chime Business Calling settings.

", "smithy.api#required": {} } } @@ -10785,12 +10789,6 @@ "smithy.api#documentation": "

The product type.

" } }, - "CallingName": { - "target": "com.amazonaws.chime#CallingName", - "traits": { - "smithy.api#documentation": "

The outbound calling name associated with the phone number.

" - } - }, "PhoneNumberId": { "target": "com.amazonaws.chime#String", "traits": { @@ -10798,18 +10796,18 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "CallingName": { + "target": "com.amazonaws.chime#CallingName", + "traits": { + "smithy.api#documentation": "

The outbound calling name associated with the phone number.

" + } } } }, "com.amazonaws.chime#UpdatePhoneNumberRequestItem": { "type": "structure", "members": { - "ProductType": { - "target": "com.amazonaws.chime#PhoneNumberProductType", - "traits": { - "smithy.api#documentation": "

The product type to update.

" - } - }, "PhoneNumberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -10817,6 +10815,12 @@ "smithy.api#required": {} } }, + "ProductType": { + "target": "com.amazonaws.chime#PhoneNumberProductType", + "traits": { + "smithy.api#documentation": "

The product type to update.

" + } + }, "CallingName": { "target": "com.amazonaws.chime#CallingName", "traits": { @@ -10942,13 +10946,6 @@ "smithy.api#required": {} } }, - "Capabilities": { - "target": "com.amazonaws.chime#CapabilityList", - "traits": { - "smithy.api#documentation": "

The proxy session capabilities.

", - "smithy.api#required": {} - } - }, "ExpiryMinutes": { "target": "com.amazonaws.chime#PositiveInteger", "traits": { @@ -10962,6 +10959,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Capabilities": { + "target": "com.amazonaws.chime#CapabilityList", + "traits": { + "smithy.api#documentation": "

The proxy session capabilities.

", + "smithy.api#required": {} + } } } }, @@ -11073,18 +11077,18 @@ "smithy.api#documentation": "

The role of the member.

" } }, - "AccountId": { + "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The room ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RoomId": { + "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The room ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11105,14 +11109,6 @@ "com.amazonaws.chime#UpdateRoomRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.chime#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -11126,6 +11122,14 @@ "traits": { "smithy.api#documentation": "

The room name.

" } + }, + "AccountId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -11191,18 +11195,6 @@ "smithy.api#required": {} } }, - "LicenseType": { - "target": "com.amazonaws.chime#License", - "traits": { - "smithy.api#documentation": "

The user license type to update. This must be a supported license type for the Amazon\n Chime account that the user belongs to.

" - } - }, - "AlexaForBusinessMetadata": { - "target": "com.amazonaws.chime#AlexaForBusinessMetadata", - "traits": { - "smithy.api#documentation": "

The Alexa for Business metadata.

" - } - }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { @@ -11216,22 +11208,29 @@ "traits": { "smithy.api#documentation": "

The user type.

" } + }, + "LicenseType": { + "target": "com.amazonaws.chime#License", + "traits": { + "smithy.api#documentation": "

The user license type to update. This must be a supported license type for the Amazon\n Chime account that the user belongs to.

" + } + }, + "AlexaForBusinessMetadata": { + "target": "com.amazonaws.chime#AlexaForBusinessMetadata", + "traits": { + "smithy.api#documentation": "

The Alexa for Business metadata.

" + } } } }, "com.amazonaws.chime#UpdateUserRequestItem": { "type": "structure", "members": { - "LicenseType": { - "target": "com.amazonaws.chime#License", - "traits": { - "smithy.api#documentation": "

The user license type.

" - } - }, - "UserType": { - "target": "com.amazonaws.chime#UserType", + "UserId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The user type.

" + "smithy.api#documentation": "

The user ID.

", + "smithy.api#required": {} } }, "AlexaForBusinessMetadata": { @@ -11240,11 +11239,16 @@ "smithy.api#documentation": "

The Alexa for Business metadata.

" } }, - "UserId": { - "target": "com.amazonaws.chime#NonEmptyString", + "LicenseType": { + "target": "com.amazonaws.chime#License", "traits": { - "smithy.api#documentation": "

The user ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user license type.

" + } + }, + "UserType": { + "target": "com.amazonaws.chime#UserType", + "traits": { + "smithy.api#documentation": "

The user type.

" } } }, @@ -11315,10 +11319,10 @@ "com.amazonaws.chime#UpdateUserSettingsRequest": { "type": "structure", "members": { - "UserId": { + "AccountId": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The user ID.

", + "smithy.api#documentation": "

The Amazon Chime account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11330,10 +11334,10 @@ "smithy.api#required": {} } }, - "AccountId": { + "UserId": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

", + "smithy.api#documentation": "

The user ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11433,18 +11437,18 @@ "smithy.api#required": {} } }, - "VoiceConnectorGroupId": { - "target": "com.amazonaws.chime#NonEmptyString", + "Name": { + "target": "com.amazonaws.chime#VoiceConnectorGroupName", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector group ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The name of the Amazon Chime Voice Connector group.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.chime#VoiceConnectorGroupName", + "VoiceConnectorGroupId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the Amazon Chime Voice Connector group.

", + "smithy.api#documentation": "

The Amazon Chime Voice Connector group ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -11464,6 +11468,14 @@ "com.amazonaws.chime#UpdateVoiceConnectorRequest": { "type": "structure", "members": { + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.chime#VoiceConnectorName", "traits": { @@ -11477,14 +11489,6 @@ "smithy.api#documentation": "

When enabled, requires encryption for the Amazon Chime Voice Connector.

", "smithy.api#required": {} } - }, - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -11511,16 +11515,17 @@ "com.amazonaws.chime#User": { "type": "structure", "members": { - "InvitedOn": { - "target": "com.amazonaws.chime#Iso8601Timestamp", + "UserId": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

Date and time when the user is invited to the Amazon Chime account, in ISO 8601\n format.

" + "smithy.api#documentation": "

The user ID.

", + "smithy.api#required": {} } }, - "DisplayName": { - "target": "com.amazonaws.chime#SensitiveString", + "InvitedOn": { + "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The display name of the user.

" + "smithy.api#documentation": "

Date and time when the user is invited to the Amazon Chime account, in ISO 8601\n format.

" } }, "RegisteredOn": { @@ -11529,10 +11534,10 @@ "smithy.api#documentation": "

Date and time when the user is registered, in ISO 8601 format.

" } }, - "PersonalPIN": { - "target": "com.amazonaws.chime#String", + "DisplayName": { + "target": "com.amazonaws.chime#SensitiveString", "traits": { - "smithy.api#documentation": "

The user's personal meeting PIN.

" + "smithy.api#documentation": "

The display name of the user.

" } }, "UserRegistrationStatus": { @@ -11541,23 +11546,22 @@ "smithy.api#documentation": "

The user registration status.

" } }, - "AccountId": { + "PersonalPIN": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The Amazon Chime account ID.

" + "smithy.api#documentation": "

The user's personal meeting PIN.

" } }, - "UserId": { - "target": "com.amazonaws.chime#String", + "AlexaForBusinessMetadata": { + "target": "com.amazonaws.chime#AlexaForBusinessMetadata", "traits": { - "smithy.api#documentation": "

The user ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Alexa for Business metadata.

" } }, - "LicenseType": { - "target": "com.amazonaws.chime#License", + "UserType": { + "target": "com.amazonaws.chime#UserType", "traits": { - "smithy.api#documentation": "

The license type for the user.

" + "smithy.api#documentation": "

The user type.

" } }, "PrimaryProvisionedNumber": { @@ -11566,28 +11570,28 @@ "smithy.api#documentation": "

The primary phone number associated with the user.

" } }, - "PrimaryEmail": { - "target": "com.amazonaws.chime#EmailAddress", + "UserInvitationStatus": { + "target": "com.amazonaws.chime#InviteStatus", "traits": { - "smithy.api#documentation": "

The primary email address of the user.

" + "smithy.api#documentation": "

The user invite status.

" } }, - "AlexaForBusinessMetadata": { - "target": "com.amazonaws.chime#AlexaForBusinessMetadata", + "PrimaryEmail": { + "target": "com.amazonaws.chime#EmailAddress", "traits": { - "smithy.api#documentation": "

The Alexa for Business metadata.

" + "smithy.api#documentation": "

The primary email address of the user.

" } }, - "UserType": { - "target": "com.amazonaws.chime#UserType", + "AccountId": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The user type.

" + "smithy.api#documentation": "

The Amazon Chime account ID.

" } }, - "UserInvitationStatus": { - "target": "com.amazonaws.chime#InviteStatus", + "LicenseType": { + "target": "com.amazonaws.chime#License", "traits": { - "smithy.api#documentation": "

The user invite status.

" + "smithy.api#documentation": "

The license type for the user.

" } } }, @@ -11610,10 +11614,10 @@ "com.amazonaws.chime#UserError": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.chime#String", + "UserId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The error message.

" + "smithy.api#documentation": "

The user ID for which the action failed.

" } }, "ErrorCode": { @@ -11622,10 +11626,10 @@ "smithy.api#documentation": "

The error code.

" } }, - "UserId": { - "target": "com.amazonaws.chime#NonEmptyString", + "ErrorMessage": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The user ID for which the action failed.

" + "smithy.api#documentation": "

The error message.

" } } }, @@ -11690,12 +11694,6 @@ "com.amazonaws.chime#VoiceConnector": { "type": "structure", "members": { - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

" - } - }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { @@ -11708,16 +11706,22 @@ "smithy.api#documentation": "

The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

" } }, + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

" + } + }, "RequireEncryption": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "

Designates whether encryption is required for the Amazon Chime Voice Connector.

" } }, - "AwsRegion": { - "target": "com.amazonaws.chime#VoiceConnectorAwsRegion", + "OutboundHostName": { + "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

" + "smithy.api#documentation": "

The outbound host name for the Amazon Chime Voice Connector.

" } }, "Name": { @@ -11726,10 +11730,10 @@ "smithy.api#documentation": "

The name of the Amazon Chime Voice Connector.

" } }, - "OutboundHostName": { - "target": "com.amazonaws.chime#String", + "AwsRegion": { + "target": "com.amazonaws.chime#VoiceConnectorAwsRegion", "traits": { - "smithy.api#documentation": "

The outbound host name for the Amazon Chime Voice Connector.

" + "smithy.api#documentation": "

The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

" } } }, @@ -11761,16 +11765,10 @@ "smithy.api#documentation": "

The Amazon Chime Voice Connector group ID.

" } }, - "UpdatedTimestamp": { + "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.

" - } - }, - "Name": { - "target": "com.amazonaws.chime#VoiceConnectorGroupName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Chime Voice Connector group.

" + "smithy.api#documentation": "

The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

" } }, "VoiceConnectorItems": { @@ -11779,10 +11777,16 @@ "smithy.api#documentation": "

The Amazon Chime Voice Connectors to which to route inbound calls.

" } }, - "CreatedTimestamp": { + "Name": { + "target": "com.amazonaws.chime#VoiceConnectorGroupName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Chime Voice Connector group.

" + } + }, + "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

" + "smithy.api#documentation": "

The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.

" } } }, @@ -11808,17 +11812,17 @@ "com.amazonaws.chime#VoiceConnectorItem": { "type": "structure", "members": { - "Priority": { - "target": "com.amazonaws.chime#VoiceConnectorItemPriority", + "VoiceConnectorId": { + "target": "com.amazonaws.chime#NonEmptyString", "traits": { - "smithy.api#documentation": "

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

", + "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", "smithy.api#required": {} } }, - "VoiceConnectorId": { - "target": "com.amazonaws.chime#NonEmptyString", + "Priority": { + "target": "com.amazonaws.chime#VoiceConnectorItemPriority", "traits": { - "smithy.api#documentation": "

The Amazon Chime Voice Connector ID.

", + "smithy.api#documentation": "

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json b/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json index 2278a48ebba6..77d4cadebc23 100644 --- a/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json +++ b/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json @@ -78,7 +78,7 @@ "sdkId": "Cloud9", "arnNamespace": "cloud9", "cloudFormationName": "Cloud9", - "cloudTrailEventSource": "AWSCloud9WorkspaceManagement.amazon.com" + "cloudTrailEventSource": "cloud9.amazonaws.com" }, "aws.auth#sigv4": { "name": "cloud9" @@ -100,14 +100,14 @@ "com.amazonaws.cloud9#BadRequestException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloud9#String" + "code": { + "target": "com.amazonaws.cloud9#Integer" }, "className": { "target": "com.amazonaws.cloud9#String" }, - "code": { - "target": "com.amazonaws.cloud9#Integer" + "message": { + "target": "com.amazonaws.cloud9#String" } }, "traits": { @@ -133,7 +133,7 @@ "smithy.api#pattern": "[\\x20-\\x7E]{10,128}" } }, - "com.amazonaws.cloud9#ConflictException": { + "com.amazonaws.cloud9#ConcurrentAccessException": { "type": "structure", "members": { "message": { @@ -146,11 +146,44 @@ "target": "com.amazonaws.cloud9#String" } }, + "traits": { + "smithy.api#documentation": "

A concurrent access issue occurred.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloud9#ConflictException": { + "type": "structure", + "members": { + "className": { + "target": "com.amazonaws.cloud9#String" + }, + "code": { + "target": "com.amazonaws.cloud9#Integer" + }, + "message": { + "target": "com.amazonaws.cloud9#String" + } + }, "traits": { "smithy.api#documentation": "

A conflict occurred.

", "smithy.api#error": "client" } }, + "com.amazonaws.cloud9#ConnectionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONNECT_SSH", + "name": "CONNECT_SSH" + }, + { + "value": "CONNECT_SSM", + "name": "CONNECT_SSM" + } + ] + } + }, "com.amazonaws.cloud9#CreateEnvironmentEC2": { "type": "operation", "input": { @@ -190,41 +223,42 @@ "com.amazonaws.cloud9#CreateEnvironmentEC2Request": { "type": "structure", "members": { - "clientRequestToken": { - "target": "com.amazonaws.cloud9#ClientRequestToken", + "ownerArn": { + "target": "com.amazonaws.cloud9#UserArn", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.

\n

For more information, see Client Tokens in the Amazon EC2 API Reference.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

" } }, - "tags": { - "target": "com.amazonaws.cloud9#TagList", + "instanceType": { + "target": "com.amazonaws.cloud9#InstanceType", "traits": { - "smithy.api#documentation": "

An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

" + "smithy.api#documentation": "

The type of instance to connect to the environment (for example, t2.micro).

", + "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cloud9#EnvironmentDescription", + "name": { + "target": "com.amazonaws.cloud9#EnvironmentName", "traits": { - "smithy.api#documentation": "

The description of the environment to create.

" + "smithy.api#documentation": "

The name of the environment to create.

\n

This name is visible to other AWS IAM users in the same AWS account.

", + "smithy.api#required": {} } }, - "automaticStopTimeMinutes": { - "target": "com.amazonaws.cloud9#AutomaticStopTimeMinutes", + "clientRequestToken": { + "target": "com.amazonaws.cloud9#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The number of minutes until the running instance is shut down after the environment has last been used.

" + "smithy.api#documentation": "

A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.

\n

For more information, see Client Tokens in the Amazon EC2 API Reference.

" } }, - "name": { - "target": "com.amazonaws.cloud9#EnvironmentName", + "description": { + "target": "com.amazonaws.cloud9#EnvironmentDescription", "traits": { - "smithy.api#documentation": "

The name of the environment to create.

\n

This name is visible to other AWS IAM users in the same AWS account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the environment to create.

" } }, - "ownerArn": { - "target": "com.amazonaws.cloud9#UserArn", + "automaticStopTimeMinutes": { + "target": "com.amazonaws.cloud9#AutomaticStopTimeMinutes", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

" + "smithy.api#documentation": "

The number of minutes until the running instance is shut down after the environment has last been used.

" } }, "subnetId": { @@ -233,11 +267,16 @@ "smithy.api#documentation": "

The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

" } }, - "instanceType": { - "target": "com.amazonaws.cloud9#InstanceType", + "tags": { + "target": "com.amazonaws.cloud9#TagList", "traits": { - "smithy.api#documentation": "

The type of instance to connect to the environment (for example, t2.micro).

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

" + } + }, + "connectionType": { + "target": "com.amazonaws.cloud9#ConnectionType", + "traits": { + "smithy.api#documentation": "

The connection type used for connecting to an Amazon EC2 environment.

" } } } @@ -480,10 +519,10 @@ "com.amazonaws.cloud9#DescribeEnvironmentMembershipsRequest": { "type": "structure", "members": { - "permissions": { - "target": "com.amazonaws.cloud9#PermissionsList", + "environmentId": { + "target": "com.amazonaws.cloud9#EnvironmentId", "traits": { - "smithy.api#documentation": "

The type of environment member permissions to get information about. Available values include:

\n \n

If no value is specified, information about all environment members are returned.

" + "smithy.api#documentation": "

The ID of the environment to get environment member information about.

" } }, "maxResults": { @@ -492,22 +531,22 @@ "smithy.api#documentation": "

The maximum number of environment members to get information about.

" } }, - "userArn": { - "target": "com.amazonaws.cloud9#UserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

" - } - }, "nextToken": { "target": "com.amazonaws.cloud9#String", "traits": { "smithy.api#documentation": "

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" } }, - "environmentId": { - "target": "com.amazonaws.cloud9#EnvironmentId", + "permissions": { + "target": "com.amazonaws.cloud9#PermissionsList", "traits": { - "smithy.api#documentation": "

The ID of the environment to get environment member information about.

" + "smithy.api#documentation": "

The type of environment member permissions to get information about. Available values include:

\n \n

If no value is specified, information about all environment members are returned.

" + } + }, + "userArn": { + "target": "com.amazonaws.cloud9#UserArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

" } } } @@ -579,17 +618,17 @@ "com.amazonaws.cloud9#DescribeEnvironmentStatusResult": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloud9#String", - "traits": { - "smithy.api#documentation": "

Any informational message about the status of the environment.

" - } - }, "status": { "target": "com.amazonaws.cloud9#EnvironmentStatus", "traits": { "smithy.api#documentation": "

The status of the environment. Available values include:

\n " } + }, + "message": { + "target": "com.amazonaws.cloud9#String", + "traits": { + "smithy.api#documentation": "

Any informational message about the status of the environment.

" + } } } }, @@ -654,10 +693,16 @@ "com.amazonaws.cloud9#Environment": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.cloud9#String", + "connectionType": { + "target": "com.amazonaws.cloud9#ConnectionType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment.

" + "smithy.api#documentation": "

The connection type used for connecting to an Amazon EC2 environment.

" + } + }, + "type": { + "target": "com.amazonaws.cloud9#EnvironmentType", + "traits": { + "smithy.api#documentation": "

The type of environment. Valid values include the following:

\n " } }, "lifecycle": { @@ -666,34 +711,34 @@ "smithy.api#documentation": "

The state of the environment in its creation or deletion lifecycle.

" } }, - "type": { - "target": "com.amazonaws.cloud9#EnvironmentType", + "id": { + "target": "com.amazonaws.cloud9#EnvironmentId", "traits": { - "smithy.api#documentation": "

The type of environment. Valid values include the following:

\n " + "smithy.api#documentation": "

The ID of the environment.

" } }, - "description": { - "target": "com.amazonaws.cloud9#EnvironmentDescription", + "ownerArn": { + "target": "com.amazonaws.cloud9#String", "traits": { - "smithy.api#documentation": "

The description for the environment.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment owner.

" } }, - "name": { - "target": "com.amazonaws.cloud9#EnvironmentName", + "description": { + "target": "com.amazonaws.cloud9#EnvironmentDescription", "traits": { - "smithy.api#documentation": "

The name of the environment.

" + "smithy.api#documentation": "

The description for the environment.

" } }, - "ownerArn": { + "arn": { "target": "com.amazonaws.cloud9#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment owner.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment.

" } }, - "id": { - "target": "com.amazonaws.cloud9#EnvironmentId", + "name": { + "target": "com.amazonaws.cloud9#EnvironmentName", "traits": { - "smithy.api#documentation": "

The ID of the environment.

" + "smithy.api#documentation": "

The name of the environment.

" } } }, @@ -732,6 +777,12 @@ "com.amazonaws.cloud9#EnvironmentLifecycle": { "type": "structure", "members": { + "reason": { + "target": "com.amazonaws.cloud9#String", + "traits": { + "smithy.api#documentation": "

Any informational message about the lifecycle state of the environment.

" + } + }, "status": { "target": "com.amazonaws.cloud9#EnvironmentLifecycleStatus", "traits": { @@ -743,12 +794,6 @@ "traits": { "smithy.api#documentation": "

If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.

" } - }, - "reason": { - "target": "com.amazonaws.cloud9#String", - "traits": { - "smithy.api#documentation": "

Any informational message about the lifecycle state of the environment.

" - } } }, "traits": { @@ -791,12 +836,24 @@ "com.amazonaws.cloud9#EnvironmentMember": { "type": "structure", "members": { + "permissions": { + "target": "com.amazonaws.cloud9#Permissions", + "traits": { + "smithy.api#documentation": "

The type of environment member permissions associated with this environment member. Available values include:

\n " + } + }, "userId": { "target": "com.amazonaws.cloud9#String", "traits": { "smithy.api#documentation": "

The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.

" } }, + "userArn": { + "target": "com.amazonaws.cloud9#UserArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment member.

" + } + }, "lastAccess": { "target": "com.amazonaws.cloud9#Timestamp", "traits": { @@ -808,18 +865,6 @@ "traits": { "smithy.api#documentation": "

The ID of the environment for the environment member.

" } - }, - "userArn": { - "target": "com.amazonaws.cloud9#UserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment member.

" - } - }, - "permissions": { - "target": "com.amazonaws.cloud9#Permissions", - "traits": { - "smithy.api#documentation": "

The type of environment member permissions associated with this environment member. Available values include:

\n " - } } }, "traits": { @@ -894,14 +939,14 @@ "com.amazonaws.cloud9#ForbiddenException": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.cloud9#Integer" + "message": { + "target": "com.amazonaws.cloud9#String" }, "className": { "target": "com.amazonaws.cloud9#String" }, - "message": { - "target": "com.amazonaws.cloud9#String" + "code": { + "target": "com.amazonaws.cloud9#Integer" } }, "traits": { @@ -925,12 +970,12 @@ "com.amazonaws.cloud9#InternalServerErrorException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloud9#String" - }, "code": { "target": "com.amazonaws.cloud9#Integer" }, + "message": { + "target": "com.amazonaws.cloud9#String" + }, "className": { "target": "com.amazonaws.cloud9#String" } @@ -946,11 +991,11 @@ "className": { "target": "com.amazonaws.cloud9#String" }, - "code": { - "target": "com.amazonaws.cloud9#Integer" - }, "message": { "target": "com.amazonaws.cloud9#String" + }, + "code": { + "target": "com.amazonaws.cloud9#Integer" } }, "traits": { @@ -1018,17 +1063,17 @@ "com.amazonaws.cloud9#ListEnvironmentsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cloud9#String", - "traits": { - "smithy.api#documentation": "

If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" - } - }, "environmentIds": { "target": "com.amazonaws.cloud9#EnvironmentIdList", "traits": { "smithy.api#documentation": "

The list of environment identifiers.

" } + }, + "nextToken": { + "target": "com.amazonaws.cloud9#String", + "traits": { + "smithy.api#documentation": "

If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + } } } }, @@ -1109,10 +1154,10 @@ "code": { "target": "com.amazonaws.cloud9#Integer" }, - "className": { + "message": { "target": "com.amazonaws.cloud9#String" }, - "message": { + "className": { "target": "com.amazonaws.cloud9#String" } }, @@ -1161,17 +1206,17 @@ "com.amazonaws.cloud9#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.cloud9#TagValue", + "Key": { + "target": "com.amazonaws.cloud9#TagKey", "traits": { - "smithy.api#documentation": "

The value part of a tag.

", + "smithy.api#documentation": "

The name part of a tag.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.cloud9#TagKey", + "Value": { + "target": "com.amazonaws.cloud9#TagValue", "traits": { - "smithy.api#documentation": "

The name part of a tag.

", + "smithy.api#documentation": "

The value part of a tag.

", "smithy.api#required": {} } } @@ -1225,6 +1270,9 @@ { "target": "com.amazonaws.cloud9#BadRequestException" }, + { + "target": "com.amazonaws.cloud9#ConcurrentAccessException" + }, { "target": "com.amazonaws.cloud9#InternalServerErrorException" }, @@ -1274,14 +1322,14 @@ "com.amazonaws.cloud9#TooManyRequestsException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloud9#String" - }, "className": { "target": "com.amazonaws.cloud9#String" }, "code": { "target": "com.amazonaws.cloud9#Integer" + }, + "message": { + "target": "com.amazonaws.cloud9#String" } }, "traits": { @@ -1301,6 +1349,9 @@ { "target": "com.amazonaws.cloud9#BadRequestException" }, + { + "target": "com.amazonaws.cloud9#ConcurrentAccessException" + }, { "target": "com.amazonaws.cloud9#InternalServerErrorException" }, @@ -1315,17 +1366,17 @@ "com.amazonaws.cloud9#UntagResourceRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.cloud9#EnvironmentArn", + "TagKeys": { + "target": "com.amazonaws.cloud9#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.

", + "smithy.api#documentation": "

The tag names of the tags to remove from the given AWS Cloud9 development environment.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.cloud9#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.cloud9#EnvironmentArn", "traits": { - "smithy.api#documentation": "

The tag names of the tags to remove from the given AWS Cloud9 development environment.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.

", "smithy.api#required": {} } } @@ -1410,13 +1461,6 @@ "com.amazonaws.cloud9#UpdateEnvironmentMembershipRequest": { "type": "structure", "members": { - "userArn": { - "target": "com.amazonaws.cloud9#UserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment member whose settings you want to change.

", - "smithy.api#required": {} - } - }, "permissions": { "target": "com.amazonaws.cloud9#MemberPermissions", "traits": { @@ -1430,6 +1474,13 @@ "smithy.api#documentation": "

The ID of the environment for the environment member whose settings you want to change.

", "smithy.api#required": {} } + }, + "userArn": { + "target": "com.amazonaws.cloud9#UserArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment member whose settings you want to change.

", + "smithy.api#required": {} + } } } }, @@ -1447,11 +1498,10 @@ "com.amazonaws.cloud9#UpdateEnvironmentRequest": { "type": "structure", "members": { - "environmentId": { - "target": "com.amazonaws.cloud9#EnvironmentId", + "name": { + "target": "com.amazonaws.cloud9#EnvironmentName", "traits": { - "smithy.api#documentation": "

The ID of the environment to change settings.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A replacement name for the environment.

" } }, "description": { @@ -1460,10 +1510,11 @@ "smithy.api#documentation": "

Any new or replacement description for the environment.

" } }, - "name": { - "target": "com.amazonaws.cloud9#EnvironmentName", + "environmentId": { + "target": "com.amazonaws.cloud9#EnvironmentId", "traits": { - "smithy.api#documentation": "

A replacement name for the environment.

" + "smithy.api#documentation": "

The ID of the environment to change settings.

", + "smithy.api#required": {} } } } diff --git a/codegen/sdk-codegen/aws-models/clouddirectory.2017-01-11.json b/codegen/sdk-codegen/aws-models/clouddirectory.2017-01-11.json index 6099cc90e6d4..8a0c3ce67caf 100644 --- a/codegen/sdk-codegen/aws-models/clouddirectory.2017-01-11.json +++ b/codegen/sdk-codegen/aws-models/clouddirectory.2017-01-11.json @@ -91,13 +91,6 @@ "com.amazonaws.clouddirectory#AddFacetToObjectRequest": { "type": "structure", "members": { - "SchemaFacet": { - "target": "com.amazonaws.clouddirectory#SchemaFacet", - "traits": { - "smithy.api#documentation": "

Identifiers for the facet that you are adding to the object. See SchemaFacet for details.

", - "smithy.api#required": {} - } - }, "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -105,10 +98,11 @@ "smithy.api#required": {} } }, - "ObjectAttributeList": { - "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", + "SchemaFacet": { + "target": "com.amazonaws.clouddirectory#SchemaFacet", "traits": { - "smithy.api#documentation": "

Attributes on the facet that you are adding to the object.

" + "smithy.api#documentation": "

Identifiers for the facet that you are adding to the object. See SchemaFacet for details.

", + "smithy.api#required": {} } }, "DirectoryArn": { @@ -118,6 +112,12 @@ "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } + }, + "ObjectAttributeList": { + "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", + "traits": { + "smithy.api#documentation": "

Attributes on the facet that you are adding to the object.

" + } } } }, @@ -333,7 +333,7 @@ "sdkId": "CloudDirectory", "arnNamespace": "clouddirectory", "cloudFormationName": "CloudDirectory", - "cloudTrailEventSource": "v20170111.clouddirectory.amazonaws.com" + "cloudTrailEventSource": "clouddirectory.amazonaws.com" }, "aws.auth#sigv4": { "name": "clouddirectory" @@ -392,18 +392,18 @@ "com.amazonaws.clouddirectory#ApplySchemaRequest": { "type": "structure", "members": { - "PublishedSchemaArn": { + "DirectoryArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

Published schema Amazon Resource Name (ARN) that needs to be copied. For more\n information, see arns.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n into which the schema is copied. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, - "DirectoryArn": { + "PublishedSchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n into which the schema is copied. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

Published schema Amazon Resource Name (ARN) that needs to be copied. For more\n information, see arns.

", "smithy.api#required": {} } } @@ -490,11 +490,10 @@ "com.amazonaws.clouddirectory#AttachObjectRequest": { "type": "structure", "members": { - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "ParentReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) that is associated with the Directory\n where both objects reside. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The parent object reference.

", "smithy.api#required": {} } }, @@ -505,17 +504,18 @@ "smithy.api#required": {} } }, - "ChildReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The child object reference to be attached to the object.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) that is associated with the Directory\n where both objects reside. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, - "ParentReference": { + "ChildReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The parent object reference.

", + "smithy.api#documentation": "

The child object reference to be attached to the object.

", "smithy.api#required": {} } } @@ -581,14 +581,6 @@ "com.amazonaws.clouddirectory#AttachPolicyRequest": { "type": "structure", "members": { - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where both objects reside. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} - } - }, "PolicyReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -602,6 +594,14 @@ "smithy.api#documentation": "

The reference that identifies the object to which the policy will be\n attached.

", "smithy.api#required": {} } + }, + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where both objects reside. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} + } } } }, @@ -675,17 +675,17 @@ "smithy.api#required": {} } }, - "TargetReference": { + "IndexReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

A reference to the object that you are attaching to the index.

", + "smithy.api#documentation": "

A reference to the index that you are attaching the object to.

", "smithy.api#required": {} } }, - "IndexReference": { + "TargetReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

A reference to the index that you are attaching the object to.

", + "smithy.api#documentation": "

A reference to the object that you are attaching to the index.

", "smithy.api#required": {} } } @@ -754,10 +754,10 @@ "com.amazonaws.clouddirectory#AttachTypedLinkRequest": { "type": "structure", "members": { - "TypedLinkFacet": { - "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", + "Attributes": { + "target": "com.amazonaws.clouddirectory#AttributeNameAndValueList", "traits": { - "smithy.api#documentation": "

Identifies the typed link facet that is associated with the typed link.

", + "smithy.api#documentation": "

A set of attributes that are associated with the typed link.

", "smithy.api#required": {} } }, @@ -768,18 +768,18 @@ "smithy.api#required": {} } }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "TypedLinkFacet": { + "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the directory where you want to attach the typed\n link.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

Identifies the typed link facet that is associated with the typed link.

", "smithy.api#required": {} } }, - "Attributes": { - "target": "com.amazonaws.clouddirectory#AttributeNameAndValueList", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

A set of attributes that are associated with the typed link.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the directory where you want to attach the typed\n link.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -806,10 +806,10 @@ "com.amazonaws.clouddirectory#AttributeKey": { "type": "structure", "members": { - "FacetName": { - "target": "com.amazonaws.clouddirectory#FacetName", + "Name": { + "target": "com.amazonaws.clouddirectory#AttributeName", "traits": { - "smithy.api#documentation": "

The name of the facet that the attribute exists within.

", + "smithy.api#documentation": "

The name of the attribute.

", "smithy.api#required": {} } }, @@ -820,10 +820,10 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.clouddirectory#AttributeName", + "FacetName": { + "target": "com.amazonaws.clouddirectory#FacetName", "traits": { - "smithy.api#documentation": "

The name of the attribute.

", + "smithy.api#documentation": "

The name of the facet that the attribute exists within.

", "smithy.api#required": {} } } @@ -835,17 +835,17 @@ "com.amazonaws.clouddirectory#AttributeKeyAndValue": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.clouddirectory#AttributeKey", + "Value": { + "target": "com.amazonaws.clouddirectory#TypedAttributeValue", "traits": { - "smithy.api#documentation": "

The key of the attribute.

", + "smithy.api#documentation": "

The value of the attribute.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.clouddirectory#TypedAttributeValue", + "Key": { + "target": "com.amazonaws.clouddirectory#AttributeKey", "traits": { - "smithy.api#documentation": "

The value of the attribute.

", + "smithy.api#documentation": "

The key of the attribute.

", "smithy.api#required": {} } } @@ -879,17 +879,17 @@ "com.amazonaws.clouddirectory#AttributeNameAndValue": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.clouddirectory#TypedAttributeValue", + "AttributeName": { + "target": "com.amazonaws.clouddirectory#AttributeName", "traits": { - "smithy.api#documentation": "

The value for the typed link.

", + "smithy.api#documentation": "

The attribute name of the typed link.

", "smithy.api#required": {} } }, - "AttributeName": { - "target": "com.amazonaws.clouddirectory#AttributeName", + "Value": { + "target": "com.amazonaws.clouddirectory#TypedAttributeValue", "traits": { - "smithy.api#documentation": "

The attribute name of the typed link.

", + "smithy.api#documentation": "

The value for the typed link.

", "smithy.api#required": {} } } @@ -913,10 +913,10 @@ "com.amazonaws.clouddirectory#BatchAddFacetToObject": { "type": "structure", "members": { - "ObjectAttributeList": { - "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", + "SchemaFacet": { + "target": "com.amazonaws.clouddirectory#SchemaFacet", "traits": { - "smithy.api#documentation": "

The attributes to set on the object.

", + "smithy.api#documentation": "

Represents the facet being added to the object.

", "smithy.api#required": {} } }, @@ -927,10 +927,10 @@ "smithy.api#required": {} } }, - "SchemaFacet": { - "target": "com.amazonaws.clouddirectory#SchemaFacet", + "ObjectAttributeList": { + "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", "traits": { - "smithy.api#documentation": "

Represents the facet being added to the object.

", + "smithy.api#documentation": "

The attributes to set on the object.

", "smithy.api#required": {} } } @@ -949,6 +949,13 @@ "com.amazonaws.clouddirectory#BatchAttachObject": { "type": "structure", "members": { + "ChildReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

The child object reference that is to be attached to the object.

", + "smithy.api#required": {} + } + }, "LinkName": { "target": "com.amazonaws.clouddirectory#LinkName", "traits": { @@ -962,13 +969,6 @@ "smithy.api#documentation": "

The parent object reference.

", "smithy.api#required": {} } - }, - "ChildReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

The child object reference that is to be attached to the object.

", - "smithy.api#required": {} - } } }, "traits": { @@ -992,17 +992,17 @@ "com.amazonaws.clouddirectory#BatchAttachPolicy": { "type": "structure", "members": { - "ObjectReference": { + "PolicyReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The reference that identifies the object to which the policy will be\n attached.

", + "smithy.api#documentation": "

The reference that is associated with the policy object.

", "smithy.api#required": {} } }, - "PolicyReference": { + "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The reference that is associated with the policy object.

", + "smithy.api#documentation": "

The reference that identifies the object to which the policy will be\n attached.

", "smithy.api#required": {} } } @@ -1057,10 +1057,10 @@ "com.amazonaws.clouddirectory#BatchAttachTypedLink": { "type": "structure", "members": { - "SourceObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "Attributes": { + "target": "com.amazonaws.clouddirectory#AttributeNameAndValueList", "traits": { - "smithy.api#documentation": "

Identifies the source object that the typed link will attach to.

", + "smithy.api#documentation": "

A set of attributes that are associated with the typed link.

", "smithy.api#required": {} } }, @@ -1071,17 +1071,17 @@ "smithy.api#required": {} } }, - "TypedLinkFacet": { - "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", + "SourceObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

Identifies the typed link facet that is associated with the typed link.

", + "smithy.api#documentation": "

Identifies the source object that the typed link will attach to.

", "smithy.api#required": {} } }, - "Attributes": { - "target": "com.amazonaws.clouddirectory#AttributeNameAndValueList", + "TypedLinkFacet": { + "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", "traits": { - "smithy.api#documentation": "

A set of attributes that are associated with the typed link.

", + "smithy.api#documentation": "

Identifies the typed link facet that is associated with the typed link.

", "smithy.api#required": {} } } @@ -1114,22 +1114,16 @@ "smithy.api#required": {} } }, - "ParentReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

A reference to the parent object that contains the index object.

" - } - }, "BatchReferenceName": { "target": "com.amazonaws.clouddirectory#BatchReferenceName", "traits": { "smithy.api#documentation": "

The batch reference name. See Transaction Support for more information.

" } }, - "LinkName": { - "target": "com.amazonaws.clouddirectory#LinkName", + "ParentReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The name of the link between the parent object and the index object.

" + "smithy.api#documentation": "

A reference to the parent object that contains the index object.

" } }, "IsUnique": { @@ -1138,6 +1132,12 @@ "smithy.api#documentation": "

Indicates whether the attribute that is being indexed has unique values or\n not.

", "smithy.api#required": {} } + }, + "LinkName": { + "target": "com.amazonaws.clouddirectory#LinkName", + "traits": { + "smithy.api#documentation": "

The name of the link between the parent object and the index object.

" + } } }, "traits": { @@ -1161,16 +1161,10 @@ "com.amazonaws.clouddirectory#BatchCreateObject": { "type": "structure", "members": { - "ParentReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

If specified, the parent reference to which this object will be attached.

" - } - }, - "SchemaFacet": { - "target": "com.amazonaws.clouddirectory#SchemaFacetList", + "ObjectAttributeList": { + "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", "traits": { - "smithy.api#documentation": "

A list of FacetArns that will be associated with the object. For more\n information, see arns.

", + "smithy.api#documentation": "

An attribute map, which contains an attribute ARN as the key and attribute value as\n the map value.

", "smithy.api#required": {} } }, @@ -1186,12 +1180,18 @@ "smithy.api#documentation": "

The batch reference name. See Transaction Support for more information.

" } }, - "ObjectAttributeList": { - "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", + "SchemaFacet": { + "target": "com.amazonaws.clouddirectory#SchemaFacetList", "traits": { - "smithy.api#documentation": "

An attribute map, which contains an attribute ARN as the key and attribute value as\n the map value.

", + "smithy.api#documentation": "

A list of FacetArns that will be associated with the object. For more\n information, see arns.

", "smithy.api#required": {} } + }, + "ParentReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

If specified, the parent reference to which this object will be attached.

" + } } }, "traits": { @@ -1273,13 +1273,6 @@ "com.amazonaws.clouddirectory#BatchDetachObject": { "type": "structure", "members": { - "LinkName": { - "target": "com.amazonaws.clouddirectory#LinkName", - "traits": { - "smithy.api#documentation": "

The name of the link.

", - "smithy.api#required": {} - } - }, "BatchReferenceName": { "target": "com.amazonaws.clouddirectory#BatchReferenceName", "traits": { @@ -1292,6 +1285,13 @@ "smithy.api#documentation": "

Parent reference from which the object with the specified link name is\n detached.

", "smithy.api#required": {} } + }, + "LinkName": { + "target": "com.amazonaws.clouddirectory#LinkName", + "traits": { + "smithy.api#documentation": "

The name of the link.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1315,17 +1315,17 @@ "com.amazonaws.clouddirectory#BatchDetachPolicy": { "type": "structure", "members": { - "ObjectReference": { + "PolicyReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

Reference that identifies the object whose policy object will be detached.

", + "smithy.api#documentation": "

Reference that identifies the policy object.

", "smithy.api#required": {} } }, - "PolicyReference": { + "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

Reference that identifies the policy object.

", + "smithy.api#documentation": "

Reference that identifies the object whose policy object will be detached.

", "smithy.api#required": {} } } @@ -1366,17 +1366,17 @@ "com.amazonaws.clouddirectory#BatchGetLinkAttributes": { "type": "structure", "members": { - "AttributeNames": { - "target": "com.amazonaws.clouddirectory#AttributeNameList", + "TypedLinkSpecifier": { + "target": "com.amazonaws.clouddirectory#TypedLinkSpecifier", "traits": { - "smithy.api#documentation": "

A list of attribute names whose values will be retrieved.

", + "smithy.api#documentation": "

Allows a typed link specifier to be accepted as input.

", "smithy.api#required": {} } }, - "TypedLinkSpecifier": { - "target": "com.amazonaws.clouddirectory#TypedLinkSpecifier", + "AttributeNames": { + "target": "com.amazonaws.clouddirectory#AttributeNameList", "traits": { - "smithy.api#documentation": "

Allows a typed link specifier to be accepted as input.

", + "smithy.api#documentation": "

A list of attribute names whose values will be retrieved.

", "smithy.api#required": {} } } @@ -1409,17 +1409,17 @@ "smithy.api#required": {} } }, - "AttributeNames": { - "target": "com.amazonaws.clouddirectory#AttributeNameList", + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

List of attribute names whose values will be retrieved.

", + "smithy.api#documentation": "

Reference that identifies the object whose attributes will be retrieved.

", "smithy.api#required": {} } }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "AttributeNames": { + "target": "com.amazonaws.clouddirectory#AttributeNameList", "traits": { - "smithy.api#documentation": "

Reference that identifies the object whose attributes will be retrieved.

", + "smithy.api#documentation": "

List of attribute names whose values will be retrieved.

", "smithy.api#required": {} } } @@ -1480,13 +1480,6 @@ "com.amazonaws.clouddirectory#BatchListAttachedIndices": { "type": "structure", "members": { - "TargetReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

A reference to the object that has indices attached.

", - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { @@ -1498,6 +1491,13 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } + }, + "TargetReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

A reference to the object that has indices attached.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1527,36 +1527,36 @@ "com.amazonaws.clouddirectory#BatchListIncomingTypedLinks": { "type": "structure", "members": { - "FilterAttributeRanges": { - "target": "com.amazonaws.clouddirectory#TypedLinkAttributeRangeList", - "traits": { - "smithy.api#documentation": "

Provides range filters for multiple attributes. When providing ranges to typed link\n selection, any inexact ranges must be specified at the end. Any attributes that do not have a\n range specified are presumed to match the entire range.

" - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "FilterTypedLink": { "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", "traits": { "smithy.api#documentation": "

Filters are interpreted in the order of the attributes on the typed link facet, not the\n order in which they are supplied to any API calls.

" } }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } + }, "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { "smithy.api#documentation": "

The reference that identifies the object whose attributes will be listed.

", "smithy.api#required": {} } + }, + "FilterAttributeRanges": { + "target": "com.amazonaws.clouddirectory#TypedLinkAttributeRangeList", + "traits": { + "smithy.api#documentation": "

Provides range filters for multiple attributes. When providing ranges to typed link\n selection, any inexact ranges must be specified at the end. Any attributes that do not have a\n range specified are presumed to match the entire range.

" + } } }, "traits": { @@ -1586,30 +1586,30 @@ "com.amazonaws.clouddirectory#BatchListIndex": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, + "RangesOnIndexedValues": { + "target": "com.amazonaws.clouddirectory#ObjectAttributeRangeList", + "traits": { + "smithy.api#documentation": "

Specifies the ranges of indexed values that you want to query.

" + } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } + }, "IndexReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { "smithy.api#documentation": "

The reference to the index to list.

", "smithy.api#required": {} } - }, - "RangesOnIndexedValues": { - "target": "com.amazonaws.clouddirectory#ObjectAttributeRangeList", - "traits": { - "smithy.api#documentation": "

Specifies the ranges of indexed values that you want to query.

" - } } }, "traits": { @@ -1619,17 +1619,17 @@ "com.amazonaws.clouddirectory#BatchListIndexResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "IndexAttachments": { "target": "com.amazonaws.clouddirectory#IndexAttachmentList", "traits": { "smithy.api#documentation": "

The objects and indexed values attached to the index.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } }, "traits": { @@ -1639,29 +1639,29 @@ "com.amazonaws.clouddirectory#BatchListObjectAttributes": { "type": "structure", "members": { - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

Reference of the object whose attributes need to be listed.

", - "smithy.api#required": {} - } - }, "FacetFilter": { "target": "com.amazonaws.clouddirectory#SchemaFacet", "traits": { "smithy.api#documentation": "

Used to filter the list of object attributes that are associated with a certain\n facet.

" } }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } + }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The pagination token.

" + "smithy.api#documentation": "

Reference of the object whose attributes need to be listed.

", + "smithy.api#required": {} } } }, @@ -1672,17 +1672,17 @@ "com.amazonaws.clouddirectory#BatchListObjectAttributesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "Attributes": { "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", "traits": { "smithy.api#documentation": "

The attributes map that is associated with the object. AttributeArn is the\n key; attribute value is the value.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } }, "traits": { @@ -1719,17 +1719,17 @@ "com.amazonaws.clouddirectory#BatchListObjectChildrenResponse": { "type": "structure", "members": { - "Children": { - "target": "com.amazonaws.clouddirectory#LinkNameToObjectIdentifierMap", - "traits": { - "smithy.api#documentation": "

The children structure, which is a map with the key as the LinkName and\n ObjectIdentifier as the value.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "Children": { + "target": "com.amazonaws.clouddirectory#LinkNameToObjectIdentifierMap", + "traits": { + "smithy.api#documentation": "

The children structure, which is a map with the key as the LinkName and\n ObjectIdentifier as the value.

" + } } }, "traits": { @@ -1792,11 +1792,11 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults" - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults" } } }, @@ -1814,6 +1814,12 @@ "com.amazonaws.clouddirectory#BatchListObjectPolicies": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } + }, "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -1821,12 +1827,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { @@ -1861,19 +1861,6 @@ "com.amazonaws.clouddirectory#BatchListOutgoingTypedLinks": { "type": "structure", "members": { - "FilterTypedLink": { - "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", - "traits": { - "smithy.api#documentation": "

Filters are interpreted in the order of the attributes defined on the typed link facet,\n not the order they are supplied to any API calls.

" - } - }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

The reference that identifies the object whose attributes will be listed.

", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { @@ -1886,11 +1873,24 @@ "smithy.api#documentation": "

Provides range filters for multiple attributes. When providing ranges to typed link\n selection, any inexact ranges must be specified at the end. Any attributes that do not have a\n range specified are presumed to match the entire range.

" } }, + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

The reference that identifies the object whose attributes will be listed.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "FilterTypedLink": { + "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", + "traits": { + "smithy.api#documentation": "

Filters are interpreted in the order of the attributes defined on the typed link facet,\n not the order they are supplied to any API calls.

" + } } }, "traits": { @@ -1920,6 +1920,12 @@ "com.amazonaws.clouddirectory#BatchListPolicyAttachments": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to retrieve.

" + } + }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { @@ -1932,12 +1938,6 @@ "smithy.api#documentation": "

The reference that identifies the policy object.

", "smithy.api#required": {} } - }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to retrieve.

" - } } }, "traits": { @@ -1947,17 +1947,17 @@ "com.amazonaws.clouddirectory#BatchListPolicyAttachmentsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "ObjectIdentifiers": { "target": "com.amazonaws.clouddirectory#ObjectIdentifierList", "traits": { "smithy.api#documentation": "

A list of ObjectIdentifiers to which the policy is attached.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } }, "traits": { @@ -1967,12 +1967,6 @@ "com.amazonaws.clouddirectory#BatchLookupPolicy": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to retrieve.

" - } - }, "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -1985,6 +1979,12 @@ "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to retrieve.

" + } } }, "traits": { @@ -1994,17 +1994,17 @@ "com.amazonaws.clouddirectory#BatchLookupPolicyResponse": { "type": "structure", "members": { - "PolicyToPathList": { - "target": "com.amazonaws.clouddirectory#PolicyToPathList", - "traits": { - "smithy.api#documentation": "

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and\n PolicyType. For more\n information, see Policies.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "PolicyToPathList": { + "target": "com.amazonaws.clouddirectory#PolicyToPathList", + "traits": { + "smithy.api#documentation": "

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and\n PolicyType. For more\n information, see Policies.

" + } } }, "traits": { @@ -2057,17 +2057,17 @@ "com.amazonaws.clouddirectory#BatchReadException": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.clouddirectory#BatchReadExceptionType", - "traits": { - "smithy.api#documentation": "

A type of exception, such as InvalidArnException.

" - } - }, "Message": { "target": "com.amazonaws.clouddirectory#ExceptionMessage", "traits": { "smithy.api#documentation": "

An exception message that is associated with the failure.

" } + }, + "Type": { + "target": "com.amazonaws.clouddirectory#BatchReadExceptionType", + "traits": { + "smithy.api#documentation": "

A type of exception, such as InvalidArnException.

" + } } }, "traits": { @@ -2136,25 +2136,22 @@ "com.amazonaws.clouddirectory#BatchReadOperation": { "type": "structure", "members": { - "ListOutgoingTypedLinks": { - "target": "com.amazonaws.clouddirectory#BatchListOutgoingTypedLinks", + "ListObjectParentPaths": { + "target": "com.amazonaws.clouddirectory#BatchListObjectParentPaths", "traits": { - "smithy.api#documentation": "

Returns a paginated list of all the outgoing TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" + "smithy.api#documentation": "

Retrieves all available parent paths for any object type such as node, leaf node,\n policy node, and index node objects. For more information about objects, see Directory Structure.

" } }, - "ListObjectParents": { - "target": "com.amazonaws.clouddirectory#BatchListObjectParents" - }, - "ListIndex": { - "target": "com.amazonaws.clouddirectory#BatchListIndex", + "ListObjectChildren": { + "target": "com.amazonaws.clouddirectory#BatchListObjectChildren", "traits": { - "smithy.api#documentation": "

Lists objects attached to the specified index.

" + "smithy.api#documentation": "

Returns a paginated list of child objects that are associated with a given\n object.

" } }, - "ListIncomingTypedLinks": { - "target": "com.amazonaws.clouddirectory#BatchListIncomingTypedLinks", + "LookupPolicy": { + "target": "com.amazonaws.clouddirectory#BatchLookupPolicy", "traits": { - "smithy.api#documentation": "

Returns a paginated list of all the incoming TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" + "smithy.api#documentation": "

Lists all policies from the root of the Directory to the object\n specified. If there are no policies present, an empty list is returned. If policies are\n present, and if some objects don't have the policies attached, it returns the ObjectIdentifier\n for such objects. If policies are present, it returns ObjectIdentifier, policyId, and\n policyType. Paths that don't lead to the root from the target object are ignored. For more\n information, see Policies.

" } }, "ListObjectPolicies": { @@ -2163,58 +2160,61 @@ "smithy.api#documentation": "

Returns policies attached to an object in pagination fashion.

" } }, - "ListObjectAttributes": { - "target": "com.amazonaws.clouddirectory#BatchListObjectAttributes", + "GetObjectAttributes": { + "target": "com.amazonaws.clouddirectory#BatchGetObjectAttributes", "traits": { - "smithy.api#documentation": "

Lists all attributes that are associated with an object.

" + "smithy.api#documentation": "

Retrieves attributes within a facet that are associated with an object.

" } }, - "GetLinkAttributes": { - "target": "com.amazonaws.clouddirectory#BatchGetLinkAttributes", + "GetObjectInformation": { + "target": "com.amazonaws.clouddirectory#BatchGetObjectInformation", "traits": { - "smithy.api#documentation": "

Retrieves attributes that are associated with a typed link.

" + "smithy.api#documentation": "

Retrieves metadata about an object.

" } }, - "LookupPolicy": { - "target": "com.amazonaws.clouddirectory#BatchLookupPolicy", + "ListIndex": { + "target": "com.amazonaws.clouddirectory#BatchListIndex", "traits": { - "smithy.api#documentation": "

Lists all policies from the root of the Directory to the object\n specified. If there are no policies present, an empty list is returned. If policies are\n present, and if some objects don't have the policies attached, it returns the ObjectIdentifier\n for such objects. If policies are present, it returns ObjectIdentifier, policyId, and\n policyType. Paths that don't lead to the root from the target object are ignored. For more\n information, see Policies.

" + "smithy.api#documentation": "

Lists objects attached to the specified index.

" } }, - "ListObjectChildren": { - "target": "com.amazonaws.clouddirectory#BatchListObjectChildren", + "ListObjectParents": { + "target": "com.amazonaws.clouddirectory#BatchListObjectParents" + }, + "GetLinkAttributes": { + "target": "com.amazonaws.clouddirectory#BatchGetLinkAttributes", "traits": { - "smithy.api#documentation": "

Returns a paginated list of child objects that are associated with a given\n object.

" + "smithy.api#documentation": "

Retrieves attributes that are associated with a typed link.

" } }, - "GetObjectInformation": { - "target": "com.amazonaws.clouddirectory#BatchGetObjectInformation", + "ListPolicyAttachments": { + "target": "com.amazonaws.clouddirectory#BatchListPolicyAttachments", "traits": { - "smithy.api#documentation": "

Retrieves metadata about an object.

" + "smithy.api#documentation": "

Returns all of the ObjectIdentifiers to which a given policy is attached.

" } }, - "ListAttachedIndices": { - "target": "com.amazonaws.clouddirectory#BatchListAttachedIndices", + "ListObjectAttributes": { + "target": "com.amazonaws.clouddirectory#BatchListObjectAttributes", "traits": { - "smithy.api#documentation": "

Lists indices attached to an object.

" + "smithy.api#documentation": "

Lists all attributes that are associated with an object.

" } }, - "ListPolicyAttachments": { - "target": "com.amazonaws.clouddirectory#BatchListPolicyAttachments", + "ListOutgoingTypedLinks": { + "target": "com.amazonaws.clouddirectory#BatchListOutgoingTypedLinks", "traits": { - "smithy.api#documentation": "

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + "smithy.api#documentation": "

Returns a paginated list of all the outgoing TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" } }, - "GetObjectAttributes": { - "target": "com.amazonaws.clouddirectory#BatchGetObjectAttributes", + "ListAttachedIndices": { + "target": "com.amazonaws.clouddirectory#BatchListAttachedIndices", "traits": { - "smithy.api#documentation": "

Retrieves attributes within a facet that are associated with an object.

" + "smithy.api#documentation": "

Lists indices attached to an object.

" } }, - "ListObjectParentPaths": { - "target": "com.amazonaws.clouddirectory#BatchListObjectParentPaths", + "ListIncomingTypedLinks": { + "target": "com.amazonaws.clouddirectory#BatchListIncomingTypedLinks", "traits": { - "smithy.api#documentation": "

Retrieves all available parent paths for any object type such as node, leaf node,\n policy node, and index node objects. For more information about objects, see Directory Structure.

" + "smithy.api#documentation": "

Returns a paginated list of all the incoming TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" } } }, @@ -2231,17 +2231,17 @@ "com.amazonaws.clouddirectory#BatchReadOperationResponse": { "type": "structure", "members": { - "SuccessfulResponse": { - "target": "com.amazonaws.clouddirectory#BatchReadSuccessfulResponse", - "traits": { - "smithy.api#documentation": "

Identifies which operation in a batch has succeeded.

" - } - }, "ExceptionResponse": { "target": "com.amazonaws.clouddirectory#BatchReadException", "traits": { "smithy.api#documentation": "

Identifies which operation in a batch has failed.

" } + }, + "SuccessfulResponse": { + "target": "com.amazonaws.clouddirectory#BatchReadSuccessfulResponse", + "traits": { + "smithy.api#documentation": "

Identifies which operation in a batch has succeeded.

" + } } }, "traits": { @@ -2257,6 +2257,13 @@ "com.amazonaws.clouddirectory#BatchReadRequest": { "type": "structure", "members": { + "ConsistencyLevel": { + "target": "com.amazonaws.clouddirectory#ConsistencyLevel", + "traits": { + "smithy.api#documentation": "

Represents the manner and timing in which the successful write or update of an object\n is reflected in a subsequent read operation of that same object.

", + "smithy.api#httpHeader": "x-amz-consistency-level" + } + }, "DirectoryArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { @@ -2265,13 +2272,6 @@ "smithy.api#required": {} } }, - "ConsistencyLevel": { - "target": "com.amazonaws.clouddirectory#ConsistencyLevel", - "traits": { - "smithy.api#documentation": "

Represents the manner and timing in which the successful write or update of an object\n is reflected in a subsequent read operation of that same object.

", - "smithy.api#httpHeader": "x-amz-consistency-level" - } - }, "Operations": { "target": "com.amazonaws.clouddirectory#BatchReadOperationList", "traits": { @@ -2295,28 +2295,22 @@ "com.amazonaws.clouddirectory#BatchReadSuccessfulResponse": { "type": "structure", "members": { - "ListObjectAttributes": { - "target": "com.amazonaws.clouddirectory#BatchListObjectAttributesResponse", - "traits": { - "smithy.api#documentation": "

Lists all attributes that are associated with an object.

" - } - }, - "ListIncomingTypedLinks": { - "target": "com.amazonaws.clouddirectory#BatchListIncomingTypedLinksResponse", + "GetObjectInformation": { + "target": "com.amazonaws.clouddirectory#BatchGetObjectInformationResponse", "traits": { - "smithy.api#documentation": "

Returns a paginated list of all the incoming TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" + "smithy.api#documentation": "

Retrieves metadata about an object.

" } }, - "GetObjectAttributes": { - "target": "com.amazonaws.clouddirectory#BatchGetObjectAttributesResponse", + "ListObjectChildren": { + "target": "com.amazonaws.clouddirectory#BatchListObjectChildrenResponse", "traits": { - "smithy.api#documentation": "

Retrieves attributes within a facet that are associated with an object.

" + "smithy.api#documentation": "

Returns a paginated list of child objects that are associated with a given\n object.

" } }, - "ListIndex": { - "target": "com.amazonaws.clouddirectory#BatchListIndexResponse", + "LookupPolicy": { + "target": "com.amazonaws.clouddirectory#BatchLookupPolicyResponse", "traits": { - "smithy.api#documentation": "

Lists objects attached to the specified index.

" + "smithy.api#documentation": "

Lists all policies from the root of the Directory to the object\n specified. If there are no policies present, an empty list is returned. If policies are\n present, and if some objects don't have the policies attached, it returns the ObjectIdentifier\n for such objects. If policies are present, it returns ObjectIdentifier, policyId, and\n policyType. Paths that don't lead to the root from the target object are ignored. For more\n information, see Policies.

" } }, "ListObjectPolicies": { @@ -2325,37 +2319,37 @@ "smithy.api#documentation": "

Returns policies attached to an object in pagination fashion.

" } }, - "GetLinkAttributes": { - "target": "com.amazonaws.clouddirectory#BatchGetLinkAttributesResponse", + "ListPolicyAttachments": { + "target": "com.amazonaws.clouddirectory#BatchListPolicyAttachmentsResponse", "traits": { - "smithy.api#documentation": "

The list of attributes to retrieve from the typed link.

" + "smithy.api#documentation": "

Returns all of the ObjectIdentifiers to which a given policy is attached.

" } }, - "ListObjectChildren": { - "target": "com.amazonaws.clouddirectory#BatchListObjectChildrenResponse", + "ListObjectParentPaths": { + "target": "com.amazonaws.clouddirectory#BatchListObjectParentPathsResponse", "traits": { - "smithy.api#documentation": "

Returns a paginated list of child objects that are associated with a given\n object.

" + "smithy.api#documentation": "

Retrieves all available parent paths for any object type such as node, leaf node,\n policy node, and index node objects. For more information about objects, see Directory Structure.

" } }, - "LookupPolicy": { - "target": "com.amazonaws.clouddirectory#BatchLookupPolicyResponse", + "GetObjectAttributes": { + "target": "com.amazonaws.clouddirectory#BatchGetObjectAttributesResponse", "traits": { - "smithy.api#documentation": "

Lists all policies from the root of the Directory to the object\n specified. If there are no policies present, an empty list is returned. If policies are\n present, and if some objects don't have the policies attached, it returns the ObjectIdentifier\n for such objects. If policies are present, it returns ObjectIdentifier, policyId, and\n policyType. Paths that don't lead to the root from the target object are ignored. For more\n information, see Policies.

" + "smithy.api#documentation": "

Retrieves attributes within a facet that are associated with an object.

" } }, - "GetObjectInformation": { - "target": "com.amazonaws.clouddirectory#BatchGetObjectInformationResponse", + "ListIndex": { + "target": "com.amazonaws.clouddirectory#BatchListIndexResponse", "traits": { - "smithy.api#documentation": "

Retrieves metadata about an object.

" + "smithy.api#documentation": "

Lists objects attached to the specified index.

" } }, "ListObjectParents": { "target": "com.amazonaws.clouddirectory#BatchListObjectParentsResponse" }, - "ListObjectParentPaths": { - "target": "com.amazonaws.clouddirectory#BatchListObjectParentPathsResponse", + "ListOutgoingTypedLinks": { + "target": "com.amazonaws.clouddirectory#BatchListOutgoingTypedLinksResponse", "traits": { - "smithy.api#documentation": "

Retrieves all available parent paths for any object type such as node, leaf node,\n policy node, and index node objects. For more information about objects, see Directory Structure.

" + "smithy.api#documentation": "

Returns a paginated list of all the outgoing TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" } }, "ListAttachedIndices": { @@ -2364,16 +2358,22 @@ "smithy.api#documentation": "

Lists indices attached to an object.

" } }, - "ListPolicyAttachments": { - "target": "com.amazonaws.clouddirectory#BatchListPolicyAttachmentsResponse", + "ListIncomingTypedLinks": { + "target": "com.amazonaws.clouddirectory#BatchListIncomingTypedLinksResponse", "traits": { - "smithy.api#documentation": "

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + "smithy.api#documentation": "

Returns a paginated list of all the incoming TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" } }, - "ListOutgoingTypedLinks": { - "target": "com.amazonaws.clouddirectory#BatchListOutgoingTypedLinksResponse", + "ListObjectAttributes": { + "target": "com.amazonaws.clouddirectory#BatchListObjectAttributesResponse", "traits": { - "smithy.api#documentation": "

Returns a paginated list of all the outgoing TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

" + "smithy.api#documentation": "

Lists all attributes that are associated with an object.

" + } + }, + "GetLinkAttributes": { + "target": "com.amazonaws.clouddirectory#BatchGetLinkAttributesResponse", + "traits": { + "smithy.api#documentation": "

The list of attributes to retrieve from the typed link.

" } } }, @@ -2387,17 +2387,17 @@ "com.amazonaws.clouddirectory#BatchRemoveFacetFromObject": { "type": "structure", "members": { - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "SchemaFacet": { + "target": "com.amazonaws.clouddirectory#SchemaFacet", "traits": { - "smithy.api#documentation": "

A reference to the object whose facet will be removed.

", + "smithy.api#documentation": "

The facet to remove from the object.

", "smithy.api#required": {} } }, - "SchemaFacet": { - "target": "com.amazonaws.clouddirectory#SchemaFacet", + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The facet to remove from the object.

", + "smithy.api#documentation": "

A reference to the object whose facet will be removed.

", "smithy.api#required": {} } } @@ -2416,17 +2416,17 @@ "com.amazonaws.clouddirectory#BatchUpdateLinkAttributes": { "type": "structure", "members": { - "AttributeUpdates": { - "target": "com.amazonaws.clouddirectory#LinkAttributeUpdateList", + "TypedLinkSpecifier": { + "target": "com.amazonaws.clouddirectory#TypedLinkSpecifier", "traits": { - "smithy.api#documentation": "

The attributes update structure.

", + "smithy.api#documentation": "

Allows a typed link specifier to be accepted as input.

", "smithy.api#required": {} } }, - "TypedLinkSpecifier": { - "target": "com.amazonaws.clouddirectory#TypedLinkSpecifier", + "AttributeUpdates": { + "target": "com.amazonaws.clouddirectory#LinkAttributeUpdateList", "traits": { - "smithy.api#documentation": "

Allows a typed link specifier to be accepted as input.

", + "smithy.api#documentation": "

The attributes update structure.

", "smithy.api#required": {} } } @@ -2445,17 +2445,17 @@ "com.amazonaws.clouddirectory#BatchUpdateObjectAttributes": { "type": "structure", "members": { - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "AttributeUpdates": { + "target": "com.amazonaws.clouddirectory#ObjectAttributeUpdateList", "traits": { - "smithy.api#documentation": "

Reference that identifies the object.

", + "smithy.api#documentation": "

Attributes update structure.

", "smithy.api#required": {} } }, - "AttributeUpdates": { - "target": "com.amazonaws.clouddirectory#ObjectAttributeUpdateList", + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

Attributes update structure.

", + "smithy.api#documentation": "

Reference that identifies the object.

", "smithy.api#required": {} } } @@ -2524,12 +2524,12 @@ "com.amazonaws.clouddirectory#BatchWriteException": { "type": "structure", "members": { - "Index": { - "target": "com.amazonaws.clouddirectory#BatchOperationIndex" - }, "Type": { "target": "com.amazonaws.clouddirectory#BatchWriteExceptionType" }, + "Index": { + "target": "com.amazonaws.clouddirectory#BatchOperationIndex" + }, "Message": { "target": "com.amazonaws.clouddirectory#ExceptionMessage" } @@ -2621,94 +2621,94 @@ "com.amazonaws.clouddirectory#BatchWriteOperation": { "type": "structure", "members": { - "UpdateLinkAttributes": { - "target": "com.amazonaws.clouddirectory#BatchUpdateLinkAttributes", + "AddFacetToObject": { + "target": "com.amazonaws.clouddirectory#BatchAddFacetToObject", "traits": { - "smithy.api#documentation": "

Updates a given object's attributes.

" + "smithy.api#documentation": "

A batch operation that adds a facet to an object.

" } }, - "AttachObject": { - "target": "com.amazonaws.clouddirectory#BatchAttachObject", + "DeleteObject": { + "target": "com.amazonaws.clouddirectory#BatchDeleteObject", "traits": { - "smithy.api#documentation": "

Attaches an object to a Directory.

" + "smithy.api#documentation": "

Deletes an object in a Directory.

" } }, - "CreateIndex": { - "target": "com.amazonaws.clouddirectory#BatchCreateIndex", + "UpdateObjectAttributes": { + "target": "com.amazonaws.clouddirectory#BatchUpdateObjectAttributes", "traits": { - "smithy.api#documentation": "

Creates an index object. See Indexing and search for more information.

" + "smithy.api#documentation": "

Updates a given object's attributes.

" } }, - "DetachFromIndex": { - "target": "com.amazonaws.clouddirectory#BatchDetachFromIndex", + "CreateObject": { + "target": "com.amazonaws.clouddirectory#BatchCreateObject", "traits": { - "smithy.api#documentation": "

Detaches the specified object from the specified index.

" + "smithy.api#documentation": "

Creates an object.

" } }, - "DetachTypedLink": { - "target": "com.amazonaws.clouddirectory#BatchDetachTypedLink", + "CreateIndex": { + "target": "com.amazonaws.clouddirectory#BatchCreateIndex", "traits": { - "smithy.api#documentation": "

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

" + "smithy.api#documentation": "

Creates an index object. See Indexing and search for more information.

" } }, - "AttachTypedLink": { - "target": "com.amazonaws.clouddirectory#BatchAttachTypedLink", + "AttachPolicy": { + "target": "com.amazonaws.clouddirectory#BatchAttachPolicy", "traits": { - "smithy.api#documentation": "

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

" + "smithy.api#documentation": "

Attaches a policy object to a regular object. An object can have a limited number of attached\n policies.

" } }, - "RemoveFacetFromObject": { - "target": "com.amazonaws.clouddirectory#BatchRemoveFacetFromObject", + "AttachObject": { + "target": "com.amazonaws.clouddirectory#BatchAttachObject", "traits": { - "smithy.api#documentation": "

A batch operation that removes a facet from an object.

" + "smithy.api#documentation": "

Attaches an object to a Directory.

" } }, - "AddFacetToObject": { - "target": "com.amazonaws.clouddirectory#BatchAddFacetToObject", + "DetachFromIndex": { + "target": "com.amazonaws.clouddirectory#BatchDetachFromIndex", "traits": { - "smithy.api#documentation": "

A batch operation that adds a facet to an object.

" + "smithy.api#documentation": "

Detaches the specified object from the specified index.

" } }, - "AttachToIndex": { - "target": "com.amazonaws.clouddirectory#BatchAttachToIndex", + "UpdateLinkAttributes": { + "target": "com.amazonaws.clouddirectory#BatchUpdateLinkAttributes", "traits": { - "smithy.api#documentation": "

Attaches the specified object to the specified index.

" + "smithy.api#documentation": "

Updates a given object's attributes.

" } }, - "CreateObject": { - "target": "com.amazonaws.clouddirectory#BatchCreateObject", + "DetachPolicy": { + "target": "com.amazonaws.clouddirectory#BatchDetachPolicy", "traits": { - "smithy.api#documentation": "

Creates an object.

" + "smithy.api#documentation": "

Detaches a policy from a Directory.

" } }, - "AttachPolicy": { - "target": "com.amazonaws.clouddirectory#BatchAttachPolicy", + "DetachObject": { + "target": "com.amazonaws.clouddirectory#BatchDetachObject", "traits": { - "smithy.api#documentation": "

Attaches a policy object to a regular object. An object can have a limited number of attached\n policies.

" + "smithy.api#documentation": "

Detaches an object from a Directory.

" } }, - "DetachPolicy": { - "target": "com.amazonaws.clouddirectory#BatchDetachPolicy", + "RemoveFacetFromObject": { + "target": "com.amazonaws.clouddirectory#BatchRemoveFacetFromObject", "traits": { - "smithy.api#documentation": "

Detaches a policy from a Directory.

" + "smithy.api#documentation": "

A batch operation that removes a facet from an object.

" } }, - "DeleteObject": { - "target": "com.amazonaws.clouddirectory#BatchDeleteObject", + "AttachTypedLink": { + "target": "com.amazonaws.clouddirectory#BatchAttachTypedLink", "traits": { - "smithy.api#documentation": "

Deletes an object in a Directory.

" + "smithy.api#documentation": "

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

" } }, - "UpdateObjectAttributes": { - "target": "com.amazonaws.clouddirectory#BatchUpdateObjectAttributes", + "DetachTypedLink": { + "target": "com.amazonaws.clouddirectory#BatchDetachTypedLink", "traits": { - "smithy.api#documentation": "

Updates a given object's attributes.

" + "smithy.api#documentation": "

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

" } }, - "DetachObject": { - "target": "com.amazonaws.clouddirectory#BatchDetachObject", + "AttachToIndex": { + "target": "com.amazonaws.clouddirectory#BatchAttachToIndex", "traits": { - "smithy.api#documentation": "

Detaches an object from a Directory.

" + "smithy.api#documentation": "

Attaches the specified object to the specified index.

" } } }, @@ -2725,94 +2725,94 @@ "com.amazonaws.clouddirectory#BatchWriteOperationResponse": { "type": "structure", "members": { - "AttachPolicy": { - "target": "com.amazonaws.clouddirectory#BatchAttachPolicyResponse", + "DetachFromIndex": { + "target": "com.amazonaws.clouddirectory#BatchDetachFromIndexResponse", "traits": { - "smithy.api#documentation": "

Attaches a policy object to a regular object. An object can have a limited number of attached\n policies.

" + "smithy.api#documentation": "

Detaches the specified object from the specified index.

" } }, - "DetachTypedLink": { - "target": "com.amazonaws.clouddirectory#BatchDetachTypedLinkResponse", + "UpdateObjectAttributes": { + "target": "com.amazonaws.clouddirectory#BatchUpdateObjectAttributesResponse", "traits": { - "smithy.api#documentation": "

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

" + "smithy.api#documentation": "

Updates a given object’s attributes.

" } }, - "CreateObject": { - "target": "com.amazonaws.clouddirectory#BatchCreateObjectResponse", + "DetachObject": { + "target": "com.amazonaws.clouddirectory#BatchDetachObjectResponse", "traits": { - "smithy.api#documentation": "

Creates an object in a Directory.

" + "smithy.api#documentation": "

Detaches an object from a Directory.

" } }, - "DetachPolicy": { - "target": "com.amazonaws.clouddirectory#BatchDetachPolicyResponse", + "UpdateLinkAttributes": { + "target": "com.amazonaws.clouddirectory#BatchUpdateLinkAttributesResponse", "traits": { - "smithy.api#documentation": "

Detaches a policy from a Directory.

" + "smithy.api#documentation": "

Represents the output of a BatchWrite response operation.

" } }, - "AttachTypedLink": { - "target": "com.amazonaws.clouddirectory#BatchAttachTypedLinkResponse", + "AttachObject": { + "target": "com.amazonaws.clouddirectory#BatchAttachObjectResponse", "traits": { - "smithy.api#documentation": "

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

" + "smithy.api#documentation": "

Attaches an object to a Directory.

" } }, - "RemoveFacetFromObject": { - "target": "com.amazonaws.clouddirectory#BatchRemoveFacetFromObjectResponse", + "DetachPolicy": { + "target": "com.amazonaws.clouddirectory#BatchDetachPolicyResponse", "traits": { - "smithy.api#documentation": "

The result of a batch remove facet from object operation.

" + "smithy.api#documentation": "

Detaches a policy from a Directory.

" } }, - "DetachObject": { - "target": "com.amazonaws.clouddirectory#BatchDetachObjectResponse", + "DeleteObject": { + "target": "com.amazonaws.clouddirectory#BatchDeleteObjectResponse", "traits": { - "smithy.api#documentation": "

Detaches an object from a Directory.

" + "smithy.api#documentation": "

Deletes an object in a Directory.

" } }, - "CreateIndex": { - "target": "com.amazonaws.clouddirectory#BatchCreateIndexResponse", + "DetachTypedLink": { + "target": "com.amazonaws.clouddirectory#BatchDetachTypedLinkResponse", "traits": { - "smithy.api#documentation": "

Creates an index object. See Indexing and search for more information.

" + "smithy.api#documentation": "

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

" } }, - "AttachObject": { - "target": "com.amazonaws.clouddirectory#BatchAttachObjectResponse", + "AttachToIndex": { + "target": "com.amazonaws.clouddirectory#BatchAttachToIndexResponse", "traits": { - "smithy.api#documentation": "

Attaches an object to a Directory.

" + "smithy.api#documentation": "

Attaches the specified object to the specified index.

" } }, - "DeleteObject": { - "target": "com.amazonaws.clouddirectory#BatchDeleteObjectResponse", + "CreateObject": { + "target": "com.amazonaws.clouddirectory#BatchCreateObjectResponse", "traits": { - "smithy.api#documentation": "

Deletes an object in a Directory.

" + "smithy.api#documentation": "

Creates an object in a Directory.

" } }, - "DetachFromIndex": { - "target": "com.amazonaws.clouddirectory#BatchDetachFromIndexResponse", + "AttachTypedLink": { + "target": "com.amazonaws.clouddirectory#BatchAttachTypedLinkResponse", "traits": { - "smithy.api#documentation": "

Detaches the specified object from the specified index.

" + "smithy.api#documentation": "

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

" } }, - "AddFacetToObject": { - "target": "com.amazonaws.clouddirectory#BatchAddFacetToObjectResponse", + "AttachPolicy": { + "target": "com.amazonaws.clouddirectory#BatchAttachPolicyResponse", "traits": { - "smithy.api#documentation": "

The result of an add facet to object batch operation.

" + "smithy.api#documentation": "

Attaches a policy object to a regular object. An object can have a limited number of attached\n policies.

" } }, - "UpdateObjectAttributes": { - "target": "com.amazonaws.clouddirectory#BatchUpdateObjectAttributesResponse", + "RemoveFacetFromObject": { + "target": "com.amazonaws.clouddirectory#BatchRemoveFacetFromObjectResponse", "traits": { - "smithy.api#documentation": "

Updates a given object’s attributes.

" + "smithy.api#documentation": "

The result of a batch remove facet from object operation.

" } }, - "UpdateLinkAttributes": { - "target": "com.amazonaws.clouddirectory#BatchUpdateLinkAttributesResponse", + "CreateIndex": { + "target": "com.amazonaws.clouddirectory#BatchCreateIndexResponse", "traits": { - "smithy.api#documentation": "

Represents the output of a BatchWrite response operation.

" + "smithy.api#documentation": "

Creates an index object. See Indexing and search for more information.

" } }, - "AttachToIndex": { - "target": "com.amazonaws.clouddirectory#BatchAttachToIndexResponse", + "AddFacetToObject": { + "target": "com.amazonaws.clouddirectory#BatchAddFacetToObjectResponse", "traits": { - "smithy.api#documentation": "

Attaches the specified object to the specified index.

" + "smithy.api#documentation": "

The result of an add facet to object batch operation.

" } } }, @@ -2970,13 +2970,6 @@ "smithy.api#required": {} } }, - "AppliedSchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the published schema in the Directory. Once a published\n schema is copied into the directory, it has its own ARN, which is referred to applied schema\n ARN. For more information, see arns.

", - "smithy.api#required": {} - } - }, "DirectoryArn": { "target": "com.amazonaws.clouddirectory#DirectoryArn", "traits": { @@ -2990,6 +2983,13 @@ "smithy.api#documentation": "

The root object node of the created directory.

", "smithy.api#required": {} } + }, + "AppliedSchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the published schema in the Directory. Once a published\n schema is copied into the directory, it has its own ARN, which is referred to applied schema\n ARN. For more information, see arns.

", + "smithy.api#required": {} + } } } }, @@ -3045,24 +3045,30 @@ "com.amazonaws.clouddirectory#CreateFacetRequest": { "type": "structure", "members": { - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The schema ARN in which the new Facet will be created. For more\n information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} - } - }, "FacetStyle": { "target": "com.amazonaws.clouddirectory#FacetStyle", "traits": { "smithy.api#documentation": "

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

" } }, + "ObjectType": { + "target": "com.amazonaws.clouddirectory#ObjectType", + "traits": { + "smithy.api#documentation": "

Specifies whether a given object created from this facet is of type node, leaf node,\n policy or index.

\n \n \n \n " + } + }, "Name": { "target": "com.amazonaws.clouddirectory#FacetName", "traits": { - "smithy.api#documentation": "

The name of the Facet, which is unique for a given schema.

", + "smithy.api#documentation": "

The name of the Facet, which is unique for a given schema.

", + "smithy.api#required": {} + } + }, + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The schema ARN in which the new Facet will be created. For more\n information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -3071,12 +3077,6 @@ "traits": { "smithy.api#documentation": "

The attributes that are associated with the Facet.

" } - }, - "ObjectType": { - "target": "com.amazonaws.clouddirectory#ObjectType", - "traits": { - "smithy.api#documentation": "

Specifies whether a given object created from this facet is of type node, leaf node,\n policy or index.

\n \n \n \n " - } } } }, @@ -3139,10 +3139,10 @@ "com.amazonaws.clouddirectory#CreateIndexRequest": { "type": "structure", "members": { - "OrderedIndexedAttributeList": { - "target": "com.amazonaws.clouddirectory#AttributeKeyList", + "IsUnique": { + "target": "com.amazonaws.clouddirectory#Bool", "traits": { - "smithy.api#documentation": "

Specifies the attributes that should be indexed on. Currently only a single attribute\n is supported.

", + "smithy.api#documentation": "

Indicates whether the attribute that is being indexed has unique values or\n not.

", "smithy.api#required": {} } }, @@ -3166,10 +3166,10 @@ "smithy.api#required": {} } }, - "IsUnique": { - "target": "com.amazonaws.clouddirectory#Bool", + "OrderedIndexedAttributeList": { + "target": "com.amazonaws.clouddirectory#AttributeKeyList", "traits": { - "smithy.api#documentation": "

Indicates whether the attribute that is being indexed has unique values or\n not.

", + "smithy.api#documentation": "

Specifies the attributes that should be indexed on. Currently only a single attribute\n is supported.

", "smithy.api#required": {} } } @@ -3241,12 +3241,10 @@ "com.amazonaws.clouddirectory#CreateObjectRequest": { "type": "structure", "members": { - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "ObjectAttributeList": { + "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n in which the object will be created. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} + "smithy.api#documentation": "

The attribute map whose attribute ARN contains the key and attribute value as the map\n value.

" } }, "LinkName": { @@ -3261,17 +3259,19 @@ "smithy.api#documentation": "

If specified, the parent reference to which this object will be attached.

" } }, - "SchemaFacets": { - "target": "com.amazonaws.clouddirectory#SchemaFacetList", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n in which the object will be created. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, - "ObjectAttributeList": { - "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", + "SchemaFacets": { + "target": "com.amazonaws.clouddirectory#SchemaFacetList", "traits": { - "smithy.api#documentation": "

The attribute map whose attribute ARN contains the key and attribute value as the map\n value.

" + "smithy.api#documentation": "

A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

", + "smithy.api#required": {} } } } @@ -3402,13 +3402,6 @@ "com.amazonaws.clouddirectory#CreateTypedLinkFacetRequest": { "type": "structure", "members": { - "Facet": { - "target": "com.amazonaws.clouddirectory#TypedLinkFacet", - "traits": { - "smithy.api#documentation": "

\n Facet structure that is associated with the typed link\n facet.

", - "smithy.api#required": {} - } - }, "SchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { @@ -3416,6 +3409,13 @@ "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } + }, + "Facet": { + "target": "com.amazonaws.clouddirectory#TypedLinkFacet", + "traits": { + "smithy.api#documentation": "

\n Facet structure that is associated with the typed link\n facet.

", + "smithy.api#required": {} + } } } }, @@ -3619,18 +3619,18 @@ "com.amazonaws.clouddirectory#DeleteObjectRequest": { "type": "structure", "members": { - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

A reference that identifies the object.

", "smithy.api#required": {} } }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

A reference that identifies the object.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } } @@ -3753,13 +3753,6 @@ "com.amazonaws.clouddirectory#DeleteTypedLinkFacetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.clouddirectory#TypedLinkName", - "traits": { - "smithy.api#documentation": "

The unique name of the typed link facet.

", - "smithy.api#required": {} - } - }, "SchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { @@ -3767,6 +3760,13 @@ "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.clouddirectory#TypedLinkName", + "traits": { + "smithy.api#documentation": "

The unique name of the typed link facet.

", + "smithy.api#required": {} + } } } }, @@ -3910,10 +3910,10 @@ "com.amazonaws.clouddirectory#DetachObjectRequest": { "type": "structure", "members": { - "LinkName": { - "target": "com.amazonaws.clouddirectory#LinkName", + "ParentReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The link name associated with the object that needs to be detached.

", + "smithy.api#documentation": "

The parent reference from which the object with the specified link name is\n detached.

", "smithy.api#required": {} } }, @@ -3925,10 +3925,10 @@ "smithy.api#required": {} } }, - "ParentReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "LinkName": { + "target": "com.amazonaws.clouddirectory#LinkName", "traits": { - "smithy.api#documentation": "

The parent reference from which the object with the specified link name is\n detached.

", + "smithy.api#documentation": "

The link name associated with the object that needs to be detached.

", "smithy.api#required": {} } } @@ -3994,13 +3994,6 @@ "com.amazonaws.clouddirectory#DetachPolicyRequest": { "type": "structure", "members": { - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

Reference that identifies the object whose policy object will be detached.

", - "smithy.api#required": {} - } - }, "PolicyReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -4015,6 +4008,13 @@ "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } + }, + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

Reference that identifies the object whose policy object will be detached.

", + "smithy.api#required": {} + } } } }, @@ -4088,16 +4088,10 @@ "com.amazonaws.clouddirectory#Directory": { "type": "structure", "members": { - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#DirectoryArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the directory. For more\n information, see arns.

" - } - }, - "CreationDateTime": { - "target": "com.amazonaws.clouddirectory#Date", + "Name": { + "target": "com.amazonaws.clouddirectory#DirectoryName", "traits": { - "smithy.api#documentation": "

The date and time when the directory was created.

" + "smithy.api#documentation": "

The name of the directory.

" } }, "State": { @@ -4106,10 +4100,16 @@ "smithy.api#documentation": "

The state of the directory. Can be either Enabled, Disabled, or Deleted.

" } }, - "Name": { - "target": "com.amazonaws.clouddirectory#DirectoryName", + "CreationDateTime": { + "target": "com.amazonaws.clouddirectory#Date", "traits": { - "smithy.api#documentation": "

The name of the directory.

" + "smithy.api#documentation": "

The date and time when the directory was created.

" + } + }, + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#DirectoryArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the directory. For more\n information, see arns.

" } } }, @@ -4355,17 +4355,17 @@ "smithy.api#documentation": "

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

" } }, - "FacetStyle": { - "target": "com.amazonaws.clouddirectory#FacetStyle", - "traits": { - "smithy.api#documentation": "

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

" - } - }, "Name": { "target": "com.amazonaws.clouddirectory#FacetName", "traits": { "smithy.api#documentation": "

The name of the Facet.

" } + }, + "FacetStyle": { + "target": "com.amazonaws.clouddirectory#FacetStyle", + "traits": { + "smithy.api#documentation": "

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

" + } } }, "traits": { @@ -4388,16 +4388,11 @@ "com.amazonaws.clouddirectory#FacetAttribute": { "type": "structure", "members": { - "RequiredBehavior": { - "target": "com.amazonaws.clouddirectory#RequiredAttributeBehavior", - "traits": { - "smithy.api#documentation": "

The required behavior of the FacetAttribute.

" - } - }, - "AttributeDefinition": { - "target": "com.amazonaws.clouddirectory#FacetAttributeDefinition", + "Name": { + "target": "com.amazonaws.clouddirectory#AttributeName", "traits": { - "smithy.api#documentation": "

A facet attribute consists of either a definition or a reference. This structure\n contains the attribute definition. See Attribute References for more information.

" + "smithy.api#documentation": "

The name of the facet attribute.

", + "smithy.api#required": {} } }, "AttributeReference": { @@ -4406,11 +4401,16 @@ "smithy.api#documentation": "

An attribute reference that is associated with the attribute. See Attribute References for more information.

" } }, - "Name": { - "target": "com.amazonaws.clouddirectory#AttributeName", + "AttributeDefinition": { + "target": "com.amazonaws.clouddirectory#FacetAttributeDefinition", "traits": { - "smithy.api#documentation": "

The name of the facet attribute.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A facet attribute consists of either a definition or a reference. This structure\n contains the attribute definition. See Attribute References for more information.

" + } + }, + "RequiredBehavior": { + "target": "com.amazonaws.clouddirectory#RequiredAttributeBehavior", + "traits": { + "smithy.api#documentation": "

The required behavior of the FacetAttribute.

" } } }, @@ -4421,13 +4421,6 @@ "com.amazonaws.clouddirectory#FacetAttributeDefinition": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.clouddirectory#FacetAttributeType", - "traits": { - "smithy.api#documentation": "

The type of the attribute.

", - "smithy.api#required": {} - } - }, "DefaultValue": { "target": "com.amazonaws.clouddirectory#TypedAttributeValue", "traits": { @@ -4445,6 +4438,13 @@ "traits": { "smithy.api#documentation": "

Whether the attribute is mutable or not.

" } + }, + "Type": { + "target": "com.amazonaws.clouddirectory#FacetAttributeType", + "traits": { + "smithy.api#documentation": "

The type of the attribute.

", + "smithy.api#required": {} + } } }, "traits": { @@ -4460,17 +4460,17 @@ "com.amazonaws.clouddirectory#FacetAttributeReference": { "type": "structure", "members": { - "TargetAttributeName": { - "target": "com.amazonaws.clouddirectory#AttributeName", + "TargetFacetName": { + "target": "com.amazonaws.clouddirectory#FacetName", "traits": { - "smithy.api#documentation": "

The target attribute name that is associated with the facet reference. See Attribute References for more information.

", + "smithy.api#documentation": "

The target facet name that is associated with the facet reference. See Attribute References for more information.

", "smithy.api#required": {} } }, - "TargetFacetName": { - "target": "com.amazonaws.clouddirectory#FacetName", + "TargetAttributeName": { + "target": "com.amazonaws.clouddirectory#AttributeName", "traits": { - "smithy.api#documentation": "

The target facet name that is associated with the facet reference. See Attribute References for more information.

", + "smithy.api#documentation": "

The target attribute name that is associated with the facet reference. See Attribute References for more information.

", "smithy.api#required": {} } } @@ -4513,17 +4513,17 @@ "com.amazonaws.clouddirectory#FacetAttributeUpdate": { "type": "structure", "members": { - "Attribute": { - "target": "com.amazonaws.clouddirectory#FacetAttribute", - "traits": { - "smithy.api#documentation": "

The attribute to update.

" - } - }, "Action": { "target": "com.amazonaws.clouddirectory#UpdateActionType", "traits": { "smithy.api#documentation": "

The action to perform when updating the attribute.

" } + }, + "Attribute": { + "target": "com.amazonaws.clouddirectory#FacetAttribute", + "traits": { + "smithy.api#documentation": "

The attribute to update.

" + } } }, "traits": { @@ -4854,10 +4854,11 @@ "com.amazonaws.clouddirectory#GetLinkAttributesRequest": { "type": "structure", "members": { - "AttributeNames": { - "target": "com.amazonaws.clouddirectory#AttributeNameList", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

A list of attribute names whose values will be retrieved.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -4867,11 +4868,10 @@ "smithy.api#documentation": "

The consistency level at which to retrieve the attributes on a typed link.

" } }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "AttributeNames": { + "target": "com.amazonaws.clouddirectory#AttributeNameList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

A list of attribute names whose values will be retrieved.

", "smithy.api#required": {} } }, @@ -4944,11 +4944,11 @@ "com.amazonaws.clouddirectory#GetObjectAttributesRequest": { "type": "structure", "members": { - "AttributeNames": { - "target": "com.amazonaws.clouddirectory#AttributeNameList", + "ConsistencyLevel": { + "target": "com.amazonaws.clouddirectory#ConsistencyLevel", "traits": { - "smithy.api#documentation": "

List of attribute names whose values will be retrieved.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The consistency level at which to retrieve the attributes on an object.

", + "smithy.api#httpHeader": "x-amz-consistency-level" } }, "DirectoryArn": { @@ -4966,18 +4966,18 @@ "smithy.api#required": {} } }, - "SchemaFacet": { - "target": "com.amazonaws.clouddirectory#SchemaFacet", + "AttributeNames": { + "target": "com.amazonaws.clouddirectory#AttributeNameList", "traits": { - "smithy.api#documentation": "

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

", + "smithy.api#documentation": "

List of attribute names whose values will be retrieved.

", "smithy.api#required": {} } }, - "ConsistencyLevel": { - "target": "com.amazonaws.clouddirectory#ConsistencyLevel", + "SchemaFacet": { + "target": "com.amazonaws.clouddirectory#SchemaFacet", "traits": { - "smithy.api#documentation": "

The consistency level at which to retrieve the attributes on an object.

", - "smithy.api#httpHeader": "x-amz-consistency-level" + "smithy.api#documentation": "

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

", + "smithy.api#required": {} } } } @@ -5039,6 +5039,14 @@ "com.amazonaws.clouddirectory#GetObjectInformationRequest": { "type": "structure", "members": { + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the directory being retrieved.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} + } + }, "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -5052,31 +5060,23 @@ "smithy.api#documentation": "

The consistency level at which to retrieve the object information.

", "smithy.api#httpHeader": "x-amz-consistency-level" } - }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the directory being retrieved.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} - } } } }, "com.amazonaws.clouddirectory#GetObjectInformationResponse": { "type": "structure", "members": { - "SchemaFacets": { - "target": "com.amazonaws.clouddirectory#SchemaFacetList", - "traits": { - "smithy.api#documentation": "

The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.

" - } - }, "ObjectIdentifier": { "target": "com.amazonaws.clouddirectory#ObjectIdentifier", "traits": { "smithy.api#documentation": "

The ObjectIdentifier of the specified object.

" } + }, + "SchemaFacets": { + "target": "com.amazonaws.clouddirectory#SchemaFacetList", + "traits": { + "smithy.api#documentation": "

The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.

" + } } } }, @@ -5199,18 +5199,18 @@ "com.amazonaws.clouddirectory#GetTypedLinkFacetInformationRequest": { "type": "structure", "members": { - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "Name": { + "target": "com.amazonaws.clouddirectory#TypedLinkName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The unique name of the typed link facet.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.clouddirectory#TypedLinkName", + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The unique name of the typed link facet.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } } @@ -5243,17 +5243,17 @@ "com.amazonaws.clouddirectory#IndexAttachment": { "type": "structure", "members": { - "IndexedAttributes": { - "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", - "traits": { - "smithy.api#documentation": "

The indexed attribute values.

" - } - }, "ObjectIdentifier": { "target": "com.amazonaws.clouddirectory#ObjectIdentifier", "traits": { "smithy.api#documentation": "

In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

" } + }, + "IndexedAttributes": { + "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", + "traits": { + "smithy.api#documentation": "

The indexed attribute values.

" + } } }, "traits": { @@ -5399,17 +5399,17 @@ "com.amazonaws.clouddirectory#LinkAttributeAction": { "type": "structure", "members": { - "AttributeUpdateValue": { - "target": "com.amazonaws.clouddirectory#TypedAttributeValue", - "traits": { - "smithy.api#documentation": "

The value that you want to update to.

" - } - }, "AttributeActionType": { "target": "com.amazonaws.clouddirectory#UpdateActionType", "traits": { "smithy.api#documentation": "

A type that can be either UPDATE_OR_CREATE or DELETE.

" } + }, + "AttributeUpdateValue": { + "target": "com.amazonaws.clouddirectory#TypedAttributeValue", + "traits": { + "smithy.api#documentation": "

The value that you want to update to.

" + } } }, "traits": { @@ -5419,17 +5419,17 @@ "com.amazonaws.clouddirectory#LinkAttributeUpdate": { "type": "structure", "members": { - "AttributeAction": { - "target": "com.amazonaws.clouddirectory#LinkAttributeAction", - "traits": { - "smithy.api#documentation": "

The action to perform as part of the attribute update.

" - } - }, "AttributeKey": { "target": "com.amazonaws.clouddirectory#AttributeKey", "traits": { "smithy.api#documentation": "

The key of the attribute being updated.

" } + }, + "AttributeAction": { + "target": "com.amazonaws.clouddirectory#LinkAttributeAction", + "traits": { + "smithy.api#documentation": "

The action to perform as part of the attribute update.

" + } } }, "traits": { @@ -5525,18 +5525,18 @@ "com.amazonaws.clouddirectory#ListAppliedSchemaArnsRequest": { "type": "structure", "members": { - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" + } + }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { @@ -5620,12 +5620,6 @@ "com.amazonaws.clouddirectory#ListAttachedIndicesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "TargetReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -5633,6 +5627,20 @@ "smithy.api#required": {} } }, + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the directory.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } + }, "ConsistencyLevel": { "target": "com.amazonaws.clouddirectory#ConsistencyLevel", "traits": { @@ -5645,14 +5653,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } - }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the directory.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} - } } } }, @@ -5724,34 +5724,34 @@ "com.amazonaws.clouddirectory#ListDevelopmentSchemaArnsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, "com.amazonaws.clouddirectory#ListDevelopmentSchemaArnsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "SchemaArns": { "target": "com.amazonaws.clouddirectory#Arns", "traits": { "smithy.api#documentation": "

The ARNs of retrieved development schemas.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, @@ -5803,10 +5803,10 @@ "com.amazonaws.clouddirectory#ListDirectoriesRequest": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.clouddirectory#DirectoryState", + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { - "smithy.api#documentation": "

The state of the directories in the list. Can be either Enabled, Disabled, or\n Deleted.

" + "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, "NextToken": { @@ -5815,10 +5815,10 @@ "smithy.api#documentation": "

The pagination token.

" } }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", + "state": { + "target": "com.amazonaws.clouddirectory#DirectoryState", "traits": { - "smithy.api#documentation": "

The maximum number of results to retrieve.

" + "smithy.api#documentation": "

The state of the directories in the list. Can be either Enabled, Disabled, or\n Deleted.

" } } } @@ -5826,18 +5826,18 @@ "com.amazonaws.clouddirectory#ListDirectoriesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "Directories": { "target": "com.amazonaws.clouddirectory#DirectoryList", "traits": { "smithy.api#documentation": "

Lists all directories that are associated with your account in pagination\n fashion.

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, @@ -5895,11 +5895,16 @@ "com.amazonaws.clouddirectory#ListFacetAttributesRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.clouddirectory#FacetName", + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", "traits": { - "smithy.api#documentation": "

The name of the facet whose attributes will be retrieved.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The pagination token.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, "SchemaArn": { @@ -5910,16 +5915,11 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", + "Name": { + "target": "com.amazonaws.clouddirectory#FacetName", "traits": { - "smithy.api#documentation": "

The maximum number of results to retrieve.

" + "smithy.api#documentation": "

The name of the facet whose attributes will be retrieved.

", + "smithy.api#required": {} } } } @@ -5927,17 +5927,17 @@ "com.amazonaws.clouddirectory#ListFacetAttributesResponse": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.clouddirectory#FacetAttributeList", - "traits": { - "smithy.api#documentation": "

The attributes attached to the facet.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "Attributes": { + "target": "com.amazonaws.clouddirectory#FacetAttributeList", + "traits": { + "smithy.api#documentation": "

The attributes attached to the facet.

" + } } } }, @@ -5992,12 +5992,6 @@ "com.amazonaws.clouddirectory#ListFacetNamesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { @@ -6011,23 +6005,29 @@ "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, "com.amazonaws.clouddirectory#ListFacetNamesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "FacetNames": { "target": "com.amazonaws.clouddirectory#FacetNameList", "traits": { "smithy.api#documentation": "

The names of facets that exist within the schema.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, @@ -6083,12 +6083,6 @@ "com.amazonaws.clouddirectory#ListIncomingTypedLinksRequest": { "type": "structure", "members": { - "FilterAttributeRanges": { - "target": "com.amazonaws.clouddirectory#TypedLinkAttributeRangeList", - "traits": { - "smithy.api#documentation": "

Provides range filters for multiple attributes. When providing ranges to typed link\n selection, any inexact ranges must be specified at the end. Any attributes that do not have a\n range specified are presumed to match the entire range.

" - } - }, "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -6096,16 +6090,24 @@ "smithy.api#required": {} } }, - "ConsistencyLevel": { - "target": "com.amazonaws.clouddirectory#ConsistencyLevel", + "FilterTypedLink": { + "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", "traits": { - "smithy.api#documentation": "

The consistency level to execute the request at.

" + "smithy.api#documentation": "

Filters are interpreted in the order of the attributes on the typed link facet, not the\n order in which they are supplied to any API calls.

" } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The pagination token.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the directory where you want to list the typed\n links.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} + } + }, + "FilterAttributeRanges": { + "target": "com.amazonaws.clouddirectory#TypedLinkAttributeRangeList", + "traits": { + "smithy.api#documentation": "

Provides range filters for multiple attributes. When providing ranges to typed link\n selection, any inexact ranges must be specified at the end. Any attributes that do not have a\n range specified are presumed to match the entire range.

" } }, "MaxResults": { @@ -6114,18 +6116,16 @@ "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, - "FilterTypedLink": { - "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", + "ConsistencyLevel": { + "target": "com.amazonaws.clouddirectory#ConsistencyLevel", "traits": { - "smithy.api#documentation": "

Filters are interpreted in the order of the attributes on the typed link facet, not the\n order in which they are supplied to any API calls.

" + "smithy.api#documentation": "

The consistency level to execute the request at.

" } }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the directory where you want to list the typed\n links.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} + "smithy.api#documentation": "

The pagination token.

" } } } @@ -6133,17 +6133,17 @@ "com.amazonaws.clouddirectory#ListIncomingTypedLinksResponse": { "type": "structure", "members": { - "LinkSpecifiers": { - "target": "com.amazonaws.clouddirectory#TypedLinkSpecifierList", - "traits": { - "smithy.api#documentation": "

Returns one or more typed link specifiers as output.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "LinkSpecifiers": { + "target": "com.amazonaws.clouddirectory#TypedLinkSpecifierList", + "traits": { + "smithy.api#documentation": "

Returns one or more typed link specifiers as output.

" + } } } }, @@ -6213,12 +6213,27 @@ "smithy.api#documentation": "

The pagination token.

" } }, + "IndexReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

The reference to the index to list.

", + "smithy.api#required": {} + } + }, "RangesOnIndexedValues": { "target": "com.amazonaws.clouddirectory#ObjectAttributeRangeList", "traits": { "smithy.api#documentation": "

Specifies the ranges of indexed values that you want to query.

" } }, + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the directory that the index exists in.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} + } + }, "ConsistencyLevel": { "target": "com.amazonaws.clouddirectory#ConsistencyLevel", "traits": { @@ -6231,38 +6246,23 @@ "traits": { "smithy.api#documentation": "

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

" } - }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the directory that the index exists in.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} - } - }, - "IndexReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

The reference to the index to list.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.clouddirectory#ListIndexResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "IndexAttachments": { "target": "com.amazonaws.clouddirectory#IndexAttachmentList", "traits": { "smithy.api#documentation": "

The objects and indexed values attached to the index.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, @@ -6311,12 +6311,6 @@ "com.amazonaws.clouddirectory#ListManagedSchemaArnsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "SchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { @@ -6328,6 +6322,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, @@ -6405,12 +6405,10 @@ "com.amazonaws.clouddirectory#ListObjectAttributesRequest": { "type": "structure", "members": { - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" } }, "ConsistencyLevel": { @@ -6420,11 +6418,10 @@ "smithy.api#httpHeader": "x-amz-consistency-level" } }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "FacetFilter": { + "target": "com.amazonaws.clouddirectory#SchemaFacet", "traits": { - "smithy.api#documentation": "

The reference that identifies the object whose attributes will be listed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Used to filter the list of object attributes that are associated with a certain\n facet.

" } }, "NextToken": { @@ -6433,16 +6430,19 @@ "smithy.api#documentation": "

The pagination token.

" } }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" + "smithy.api#documentation": "

The reference that identifies the object whose attributes will be listed.

", + "smithy.api#required": {} } }, - "FacetFilter": { - "target": "com.amazonaws.clouddirectory#SchemaFacet", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

Used to filter the list of object attributes that are associated with a certain\n facet.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} } } } @@ -6450,17 +6450,17 @@ "com.amazonaws.clouddirectory#ListObjectAttributesResponse": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", - "traits": { - "smithy.api#documentation": "

Attributes map that is associated with the object. AttributeArn is the\n key, and attribute value is the value.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "Attributes": { + "target": "com.amazonaws.clouddirectory#AttributeKeyAndValueList", + "traits": { + "smithy.api#documentation": "

Attributes map that is associated with the object. AttributeArn is the\n key, and attribute value is the value.

" + } } } }, @@ -6521,17 +6521,17 @@ "com.amazonaws.clouddirectory#ListObjectChildrenRequest": { "type": "structure", "members": { - "ConsistencyLevel": { - "target": "com.amazonaws.clouddirectory#ConsistencyLevel", + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", "traits": { - "smithy.api#documentation": "

Represents the manner and timing in which the successful write or update of an object\n is reflected in a subsequent read operation of that same object.

", - "smithy.api#httpHeader": "x-amz-consistency-level" + "smithy.api#documentation": "

The pagination token.

" } }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The reference that identifies the object for which child objects are being\n listed.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -6541,17 +6541,17 @@ "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", + "ConsistencyLevel": { + "target": "com.amazonaws.clouddirectory#ConsistencyLevel", "traits": { - "smithy.api#documentation": "

The pagination token.

" + "smithy.api#documentation": "

Represents the manner and timing in which the successful write or update of an object\n is reflected in a subsequent read operation of that same object.

", + "smithy.api#httpHeader": "x-amz-consistency-level" } }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The reference that identifies the object for which child objects are being\n listed.

", "smithy.api#required": {} } } @@ -6628,6 +6628,19 @@ "com.amazonaws.clouddirectory#ListObjectParentPathsRequest": { "type": "structure", "members": { + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

The reference that identifies the object whose parent paths are listed.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } + }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { @@ -6641,19 +6654,6 @@ "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } - }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

The reference that identifies the object whose parent paths are listed.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } } } }, @@ -6731,17 +6731,17 @@ "com.amazonaws.clouddirectory#ListObjectParentsRequest": { "type": "structure", "members": { - "ConsistencyLevel": { - "target": "com.amazonaws.clouddirectory#ConsistencyLevel", + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", "traits": { - "smithy.api#documentation": "

Represents the manner and timing in which the successful write or update of an object\n is reflected in a subsequent read operation of that same object.

", - "smithy.api#httpHeader": "x-amz-consistency-level" + "smithy.api#documentation": "

The pagination token.

" } }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The reference that identifies the object for which parent objects are being\n listed.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -6751,23 +6751,23 @@ "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "IncludeAllLinksToEachParent": { "target": "com.amazonaws.clouddirectory#Bool", "traits": { "smithy.api#documentation": "

When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.

" } }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "ConsistencyLevel": { + "target": "com.amazonaws.clouddirectory#ConsistencyLevel", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where the object resides. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

Represents the manner and timing in which the successful write or update of an object\n is reflected in a subsequent read operation of that same object.

", + "smithy.api#httpHeader": "x-amz-consistency-level" + } + }, + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

The reference that identifies the object for which parent objects are being\n listed.

", "smithy.api#required": {} } } @@ -6776,10 +6776,10 @@ "com.amazonaws.clouddirectory#ListObjectParentsResponse": { "type": "structure", "members": { - "ParentLinks": { - "target": "com.amazonaws.clouddirectory#ObjectIdentifierAndLinkNameList", + "Parents": { + "target": "com.amazonaws.clouddirectory#ObjectIdentifierToLinkNameMap", "traits": { - "smithy.api#documentation": "

Returns a list of parent reference and LinkName Tuples.

" + "smithy.api#documentation": "

The parent structure, which is a map with key as the ObjectIdentifier and\n LinkName as the value.

" } }, "NextToken": { @@ -6788,10 +6788,10 @@ "smithy.api#documentation": "

The pagination token.

" } }, - "Parents": { - "target": "com.amazonaws.clouddirectory#ObjectIdentifierToLinkNameMap", + "ParentLinks": { + "target": "com.amazonaws.clouddirectory#ObjectIdentifierAndLinkNameList", "traits": { - "smithy.api#documentation": "

The parent structure, which is a map with key as the ObjectIdentifier and\n LinkName as the value.

" + "smithy.api#documentation": "

Returns a list of parent reference and LinkName Tuples.

" } } } @@ -6858,19 +6858,6 @@ "smithy.api#required": {} } }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

Reference that identifies the object for which policies will be listed.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" - } - }, "ConsistencyLevel": { "target": "com.amazonaws.clouddirectory#ConsistencyLevel", "traits": { @@ -6878,11 +6865,24 @@ "smithy.api#httpHeader": "x-amz-consistency-level" } }, + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

Reference that identifies the object for which policies will be listed.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" + } } } }, @@ -6955,11 +6955,16 @@ "com.amazonaws.clouddirectory#ListOutgoingTypedLinksRequest": { "type": "structure", "members": { - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the directory where you want to list the typed\n links.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The pagination token.

" + } + }, + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

A reference that identifies the object whose attributes will be listed.

", "smithy.api#required": {} } }, @@ -6969,35 +6974,30 @@ "smithy.api#documentation": "

The consistency level to execute the request at.

" } }, + "FilterAttributeRanges": { + "target": "com.amazonaws.clouddirectory#TypedLinkAttributeRangeList", + "traits": { + "smithy.api#documentation": "

Provides range filters for multiple attributes. When providing ranges to typed link\n selection, any inexact ranges must be specified at the end. Any attributes that do not have a\n range specified are presumed to match the entire range.

" + } + }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

A reference that identifies the object whose attributes will be listed.

", - "smithy.api#required": {} - } - }, "FilterTypedLink": { "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", "traits": { "smithy.api#documentation": "

Filters are interpreted in the order of the attributes defined on the typed link facet,\n not the order they are supplied to any API calls.

" } }, - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, - "FilterAttributeRanges": { - "target": "com.amazonaws.clouddirectory#TypedLinkAttributeRangeList", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

Provides range filters for multiple attributes. When providing ranges to typed link\n selection, any inexact ranges must be specified at the end. Any attributes that do not have a\n range specified are presumed to match the entire range.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the directory where you want to list the typed\n links.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} } } } @@ -7076,10 +7076,17 @@ "com.amazonaws.clouddirectory#ListPolicyAttachmentsRequest": { "type": "structure", "members": { - "PolicyReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { - "smithy.api#documentation": "

The reference that identifies the policy object.

", + "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" + } + }, + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where objects reside. For more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -7089,10 +7096,11 @@ "smithy.api#documentation": "

The pagination token.

" } }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", + "PolicyReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" + "smithy.api#documentation": "

The reference that identifies the policy object.

", + "smithy.api#required": {} } }, "ConsistencyLevel": { @@ -7101,31 +7109,23 @@ "smithy.api#documentation": "

Represents the manner and timing in which the successful write or update of an object\n is reflected in a subsequent read operation of that same object.

", "smithy.api#httpHeader": "x-amz-consistency-level" } - }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory\n where objects reside. For more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} - } } } }, "com.amazonaws.clouddirectory#ListPolicyAttachmentsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "ObjectIdentifiers": { "target": "com.amazonaws.clouddirectory#ObjectIdentifierList", "traits": { "smithy.api#documentation": "

A list of ObjectIdentifiers to which the policy is attached.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, @@ -7180,10 +7180,10 @@ "com.amazonaws.clouddirectory#ListPublishedSchemaArnsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The pagination token.

" + "smithy.api#documentation": "

The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" } }, "MaxResults": { @@ -7192,10 +7192,10 @@ "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", "traits": { - "smithy.api#documentation": "

The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" + "smithy.api#documentation": "

The pagination token.

" } } } @@ -7203,17 +7203,17 @@ "com.amazonaws.clouddirectory#ListPublishedSchemaArnsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "SchemaArns": { "target": "com.amazonaws.clouddirectory#Arns", "traits": { "smithy.api#documentation": "

The ARNs of published schemas.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token.

" + } } } }, @@ -7268,6 +7268,13 @@ "com.amazonaws.clouddirectory#ListTagsForResourceRequest": { "type": "structure", "members": { + "ResourceArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for\n directories.

", + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.clouddirectory#TagsNumberResults", "traits": { @@ -7279,30 +7286,23 @@ "traits": { "smithy.api#documentation": "

The pagination token. This is for future use. Currently pagination is not supported for\n tagging.

" } - }, - "ResourceArn": { - "target": "com.amazonaws.clouddirectory#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for\n directories.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.clouddirectory#ListTagsForResourceResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#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.

" - } - }, "Tags": { "target": "com.amazonaws.clouddirectory#TagList", "traits": { "smithy.api#documentation": "

A list of tag key value pairs that are associated with the response.

" } + }, + "NextToken": { + "target": "com.amazonaws.clouddirectory#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.

" + } } } }, @@ -7360,18 +7360,20 @@ "com.amazonaws.clouddirectory#ListTypedLinkFacetAttributesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.clouddirectory#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, "MaxResults": { "target": "com.amazonaws.clouddirectory#NumberResults", "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve.

" } }, + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.clouddirectory#TypedLinkName", "traits": { @@ -7379,12 +7381,10 @@ "smithy.api#required": {} } }, - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "NextToken": { + "target": "com.amazonaws.clouddirectory#NextToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", - "smithy.api#required": {} + "smithy.api#documentation": "

The pagination token.

" } } } @@ -7392,17 +7392,17 @@ "com.amazonaws.clouddirectory#ListTypedLinkFacetAttributesResponse": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.clouddirectory#TypedLinkAttributeDefinitionList", - "traits": { - "smithy.api#documentation": "

An ordered set of attributes associate with the typed link.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "Attributes": { + "target": "com.amazonaws.clouddirectory#TypedLinkAttributeDefinitionList", + "traits": { + "smithy.api#documentation": "

An ordered set of attributes associate with the typed link.

" + } } } }, @@ -7457,6 +7457,12 @@ "com.amazonaws.clouddirectory#ListTypedLinkFacetNamesRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to retrieve.

" + } + }, "SchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { @@ -7465,12 +7471,6 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to retrieve.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { @@ -7482,17 +7482,17 @@ "com.amazonaws.clouddirectory#ListTypedLinkFacetNamesResponse": { "type": "structure", "members": { - "FacetNames": { - "target": "com.amazonaws.clouddirectory#TypedLinkNameList", - "traits": { - "smithy.api#documentation": "

The names of typed link facets that exist within the schema.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "FacetNames": { + "target": "com.amazonaws.clouddirectory#TypedLinkNameList", + "traits": { + "smithy.api#documentation": "

The names of typed link facets that exist within the schema.

" + } } } }, @@ -7550,12 +7550,6 @@ "com.amazonaws.clouddirectory#LookupPolicyRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" - } - }, "DirectoryArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { @@ -7564,6 +7558,12 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.clouddirectory#NumberResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

" + } + }, "ObjectReference": { "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { @@ -7582,17 +7582,17 @@ "com.amazonaws.clouddirectory#LookupPolicyResponse": { "type": "structure", "members": { - "PolicyToPathList": { - "target": "com.amazonaws.clouddirectory#PolicyToPathList", - "traits": { - "smithy.api#documentation": "

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and\n PolicyType. For more\n information, see Policies.

" - } - }, "NextToken": { "target": "com.amazonaws.clouddirectory#NextToken", "traits": { "smithy.api#documentation": "

The pagination token.

" } + }, + "PolicyToPathList": { + "target": "com.amazonaws.clouddirectory#PolicyToPathList", + "traits": { + "smithy.api#documentation": "

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and\n PolicyType. For more\n information, see Policies.

" + } } } }, @@ -7666,17 +7666,17 @@ "com.amazonaws.clouddirectory#ObjectAttributeAction": { "type": "structure", "members": { - "ObjectAttributeActionType": { - "target": "com.amazonaws.clouddirectory#UpdateActionType", - "traits": { - "smithy.api#documentation": "

A type that can be either Update or Delete.

" - } - }, "ObjectAttributeUpdateValue": { "target": "com.amazonaws.clouddirectory#TypedAttributeValue", "traits": { "smithy.api#documentation": "

The value that you want to update to.

" } + }, + "ObjectAttributeActionType": { + "target": "com.amazonaws.clouddirectory#UpdateActionType", + "traits": { + "smithy.api#documentation": "

A type that can be either Update or Delete.

" + } } }, "traits": { @@ -7686,17 +7686,17 @@ "com.amazonaws.clouddirectory#ObjectAttributeRange": { "type": "structure", "members": { - "AttributeKey": { - "target": "com.amazonaws.clouddirectory#AttributeKey", - "traits": { - "smithy.api#documentation": "

The key of the attribute that the attribute range covers.

" - } - }, "Range": { "target": "com.amazonaws.clouddirectory#TypedAttributeValueRange", "traits": { "smithy.api#documentation": "

The range of attribute values being selected.

" } + }, + "AttributeKey": { + "target": "com.amazonaws.clouddirectory#AttributeKey", + "traits": { + "smithy.api#documentation": "

The key of the attribute that the attribute range covers.

" + } } }, "traits": { @@ -7712,17 +7712,17 @@ "com.amazonaws.clouddirectory#ObjectAttributeUpdate": { "type": "structure", "members": { - "ObjectAttributeAction": { - "target": "com.amazonaws.clouddirectory#ObjectAttributeAction", - "traits": { - "smithy.api#documentation": "

The action to perform as part of the attribute update.

" - } - }, "ObjectAttributeKey": { "target": "com.amazonaws.clouddirectory#AttributeKey", "traits": { "smithy.api#documentation": "

The key of the attribute being updated.

" } + }, + "ObjectAttributeAction": { + "target": "com.amazonaws.clouddirectory#ObjectAttributeAction", + "traits": { + "smithy.api#documentation": "

The action to perform as part of the attribute update.

" + } } }, "traits": { @@ -7867,16 +7867,16 @@ "smithy.api#documentation": "

The type of policy that can be associated with PolicyAttachment.

" } }, - "ObjectIdentifier": { + "PolicyId": { "target": "com.amazonaws.clouddirectory#ObjectIdentifier", "traits": { - "smithy.api#documentation": "

The ObjectIdentifier that is associated with\n PolicyAttachment.

" + "smithy.api#documentation": "

The ID of PolicyAttachment.

" } }, - "PolicyId": { + "ObjectIdentifier": { "target": "com.amazonaws.clouddirectory#ObjectIdentifier", "traits": { - "smithy.api#documentation": "

The ID of PolicyAttachment.

" + "smithy.api#documentation": "

The ObjectIdentifier that is associated with\n PolicyAttachment.

" } } }, @@ -7893,17 +7893,17 @@ "com.amazonaws.clouddirectory#PolicyToPath": { "type": "structure", "members": { - "Path": { - "target": "com.amazonaws.clouddirectory#PathString", - "traits": { - "smithy.api#documentation": "

The path that is referenced from the root.

" - } - }, "Policies": { "target": "com.amazonaws.clouddirectory#PolicyAttachmentList", "traits": { "smithy.api#documentation": "

List of policy objects.

" } + }, + "Path": { + "target": "com.amazonaws.clouddirectory#PathString", + "traits": { + "smithy.api#documentation": "

The path that is referenced from the root.

" + } } }, "traits": { @@ -7971,11 +7971,10 @@ "smithy.api#documentation": "

The new name under which the schema will be published. If this is not provided, the\n development schema is considered.

" } }, - "DevelopmentSchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "Version": { + "target": "com.amazonaws.clouddirectory#Version", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the development schema. For\n more information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

", "smithy.api#required": {} } }, @@ -7985,10 +7984,11 @@ "smithy.api#documentation": "

The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.

" } }, - "Version": { - "target": "com.amazonaws.clouddirectory#Version", + "DevelopmentSchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the development schema. For\n more information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } } @@ -8162,18 +8162,18 @@ "smithy.api#required": {} } }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "SchemaFacet": { + "target": "com.amazonaws.clouddirectory#SchemaFacet", "traits": { - "smithy.api#documentation": "

The ARN of the directory in which the object resides.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The facet to remove. See SchemaFacet for details.

", "smithy.api#required": {} } }, - "SchemaFacet": { - "target": "com.amazonaws.clouddirectory#SchemaFacet", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The facet to remove. See SchemaFacet for details.

", + "smithy.api#documentation": "

The ARN of the directory in which the object resides.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } } @@ -8227,17 +8227,17 @@ "com.amazonaws.clouddirectory#Rule": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.clouddirectory#RuleType", - "traits": { - "smithy.api#documentation": "

The type of attribute validation rule.

" - } - }, "Parameters": { "target": "com.amazonaws.clouddirectory#RuleParameterMap", "traits": { "smithy.api#documentation": "

The minimum and maximum parameters that are associated with the rule.

" } + }, + "Type": { + "target": "com.amazonaws.clouddirectory#RuleType", + "traits": { + "smithy.api#documentation": "

The type of attribute validation rule.

" + } } }, "traits": { @@ -8507,29 +8507,29 @@ "smithy.api#documentation": "

A string data value.

" } }, - "NumberValue": { - "target": "com.amazonaws.clouddirectory#NumberAttributeValue", - "traits": { - "smithy.api#documentation": "

A number data value.

" - } - }, "BinaryValue": { "target": "com.amazonaws.clouddirectory#BinaryAttributeValue", "traits": { "smithy.api#documentation": "

A binary data value.

" } }, - "DatetimeValue": { - "target": "com.amazonaws.clouddirectory#DatetimeAttributeValue", - "traits": { - "smithy.api#documentation": "

A date and time value.

" - } - }, "BooleanValue": { "target": "com.amazonaws.clouddirectory#BooleanAttributeValue", "traits": { "smithy.api#documentation": "

A Boolean data value.

" } + }, + "NumberValue": { + "target": "com.amazonaws.clouddirectory#NumberAttributeValue", + "traits": { + "smithy.api#documentation": "

A number data value.

" + } + }, + "DatetimeValue": { + "target": "com.amazonaws.clouddirectory#DatetimeAttributeValue", + "traits": { + "smithy.api#documentation": "

A date and time value.

" + } } }, "traits": { @@ -8546,16 +8546,16 @@ "smithy.api#required": {} } }, - "StartValue": { + "EndValue": { "target": "com.amazonaws.clouddirectory#TypedAttributeValue", "traits": { - "smithy.api#documentation": "

The value to start the range at.

" + "smithy.api#documentation": "

The attribute value to terminate the range at.

" } }, - "EndValue": { + "StartValue": { "target": "com.amazonaws.clouddirectory#TypedAttributeValue", "traits": { - "smithy.api#documentation": "

The attribute value to terminate the range at.

" + "smithy.api#documentation": "

The value to start the range at.

" } }, "EndMode": { @@ -8579,25 +8579,12 @@ "smithy.api#documentation": "

The default value of the attribute (if configured).

" } }, - "Name": { - "target": "com.amazonaws.clouddirectory#AttributeName", - "traits": { - "smithy.api#documentation": "

The unique name of the typed link attribute.

", - "smithy.api#required": {} - } - }, "Rules": { "target": "com.amazonaws.clouddirectory#RuleMap", "traits": { "smithy.api#documentation": "

Validation rules that are attached to the attribute definition.

" } }, - "IsImmutable": { - "target": "com.amazonaws.clouddirectory#Bool", - "traits": { - "smithy.api#documentation": "

Whether the attribute is mutable or not.

" - } - }, "Type": { "target": "com.amazonaws.clouddirectory#FacetAttributeType", "traits": { @@ -8611,6 +8598,19 @@ "smithy.api#documentation": "

The required behavior of the TypedLinkAttributeDefinition.

", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.clouddirectory#AttributeName", + "traits": { + "smithy.api#documentation": "

The unique name of the typed link attribute.

", + "smithy.api#required": {} + } + }, + "IsImmutable": { + "target": "com.amazonaws.clouddirectory#Bool", + "traits": { + "smithy.api#documentation": "

Whether the attribute is mutable or not.

" + } } }, "traits": { @@ -8653,10 +8653,10 @@ "com.amazonaws.clouddirectory#TypedLinkFacet": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.clouddirectory#TypedLinkAttributeDefinitionList", + "IdentityAttributeOrder": { + "target": "com.amazonaws.clouddirectory#AttributeNameList", "traits": { - "smithy.api#documentation": "

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

", + "smithy.api#documentation": "

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

", "smithy.api#required": {} } }, @@ -8667,10 +8667,10 @@ "smithy.api#required": {} } }, - "IdentityAttributeOrder": { - "target": "com.amazonaws.clouddirectory#AttributeNameList", + "Attributes": { + "target": "com.amazonaws.clouddirectory#TypedLinkAttributeDefinitionList", "traits": { - "smithy.api#documentation": "

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

", + "smithy.api#documentation": "

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

", "smithy.api#required": {} } } @@ -8722,17 +8722,17 @@ "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName": { "type": "structure", "members": { - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "TypedLinkName": { + "target": "com.amazonaws.clouddirectory#TypedLinkName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", + "smithy.api#documentation": "

The unique name of the typed link facet.

", "smithy.api#required": {} } }, - "TypedLinkName": { - "target": "com.amazonaws.clouddirectory#TypedLinkName", + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The unique name of the typed link facet.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", "smithy.api#required": {} } } @@ -8744,10 +8744,10 @@ "com.amazonaws.clouddirectory#TypedLinkSpecifier": { "type": "structure", "members": { - "TypedLinkFacet": { - "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", + "SourceObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", "traits": { - "smithy.api#documentation": "

Identifies the typed link facet that is associated with the typed link.

", + "smithy.api#documentation": "

Identifies the source object that the typed link will attach to.

", "smithy.api#required": {} } }, @@ -8765,10 +8765,10 @@ "smithy.api#required": {} } }, - "SourceObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", + "TypedLinkFacet": { + "target": "com.amazonaws.clouddirectory#TypedLinkSchemaAndFacetName", "traits": { - "smithy.api#documentation": "

Identifies the source object that the typed link will attach to.

", + "smithy.api#documentation": "

Identifies the typed link facet that is associated with the typed link.

", "smithy.api#required": {} } } @@ -8842,17 +8842,17 @@ "com.amazonaws.clouddirectory#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "TagKeys": { + "target": "com.amazonaws.clouddirectory#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for\n directories.

", + "smithy.api#documentation": "

Keys of the tag that need to be removed from the resource.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.clouddirectory#TagKeyList", + "ResourceArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

Keys of the tag that need to be removed from the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for\n directories.

", "smithy.api#required": {} } } @@ -8932,6 +8932,13 @@ "com.amazonaws.clouddirectory#UpdateFacetRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.clouddirectory#FacetName", + "traits": { + "smithy.api#documentation": "

The name of the facet.

", + "smithy.api#required": {} + } + }, "ObjectType": { "target": "com.amazonaws.clouddirectory#ObjectType", "traits": { @@ -8951,13 +8958,6 @@ "traits": { "smithy.api#documentation": "

List of attributes that need to be updated in a given schema Facet.\n Each attribute is followed by AttributeAction, which specifies the type of update\n operation to perform.

" } - }, - "Name": { - "target": "com.amazonaws.clouddirectory#FacetName", - "traits": { - "smithy.api#documentation": "

The name of the facet.

", - "smithy.api#required": {} - } } } }, @@ -9014,10 +9014,11 @@ "com.amazonaws.clouddirectory#UpdateLinkAttributesRequest": { "type": "structure", "members": { - "AttributeUpdates": { - "target": "com.amazonaws.clouddirectory#LinkAttributeUpdateList", + "DirectoryArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The attributes update structure.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed Links.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -9028,11 +9029,10 @@ "smithy.api#required": {} } }, - "DirectoryArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "AttributeUpdates": { + "target": "com.amazonaws.clouddirectory#LinkAttributeUpdateList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed Links.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The attributes update structure.

", "smithy.api#required": {} } } @@ -9094,13 +9094,6 @@ "com.amazonaws.clouddirectory#UpdateObjectAttributesRequest": { "type": "structure", "members": { - "ObjectReference": { - "target": "com.amazonaws.clouddirectory#ObjectReference", - "traits": { - "smithy.api#documentation": "

The reference that identifies the object.

", - "smithy.api#required": {} - } - }, "AttributeUpdates": { "target": "com.amazonaws.clouddirectory#ObjectAttributeUpdateList", "traits": { @@ -9115,6 +9108,13 @@ "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } + }, + "ObjectReference": { + "target": "com.amazonaws.clouddirectory#ObjectReference", + "traits": { + "smithy.api#documentation": "

The reference that identifies the object.

", + "smithy.api#required": {} + } } } }, @@ -9172,18 +9172,18 @@ "com.amazonaws.clouddirectory#UpdateSchemaRequest": { "type": "structure", "members": { - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "Name": { + "target": "com.amazonaws.clouddirectory#SchemaName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the development schema. For more information, see\n arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The name of the schema.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.clouddirectory#SchemaName", + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The name of the schema.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the development schema. For more information, see\n arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } } @@ -9255,10 +9255,11 @@ "com.amazonaws.clouddirectory#UpdateTypedLinkFacetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.clouddirectory#TypedLinkName", + "SchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The unique name of the typed link facet.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", + "smithy.api#httpHeader": "x-amz-data-partition", "smithy.api#required": {} } }, @@ -9269,18 +9270,17 @@ "smithy.api#required": {} } }, - "IdentityAttributeOrder": { - "target": "com.amazonaws.clouddirectory#AttributeNameList", + "Name": { + "target": "com.amazonaws.clouddirectory#TypedLinkName", "traits": { - "smithy.api#documentation": "

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed\n links considers the order that the attributes are defined on the typed link facet. When\n providing ranges to a typed link selection, any inexact ranges must be specified at the end.\n Any attributes that do not have a range specified are presumed to match the entire range.\n Filters are interpreted in the order of the attributes on the typed link facet, not the order\n in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

", + "smithy.api#documentation": "

The unique name of the typed link facet.

", "smithy.api#required": {} } }, - "SchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "IdentityAttributeOrder": { + "target": "com.amazonaws.clouddirectory#AttributeNameList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is associated with the schema. For more\n information, see arns.

", - "smithy.api#httpHeader": "x-amz-data-partition", + "smithy.api#documentation": "

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed\n links considers the order that the attributes are defined on the typed link facet. When\n providing ranges to a typed link selection, any inexact ranges must be specified at the end.\n Any attributes that do not have a range specified are presumed to match the entire range.\n Filters are interpreted in the order of the attributes on the typed link facet, not the order\n in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

", "smithy.api#required": {} } } @@ -9339,17 +9339,17 @@ "com.amazonaws.clouddirectory#UpgradeAppliedSchemaRequest": { "type": "structure", "members": { - "DirectoryArn": { + "PublishedSchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the directory to which the upgraded schema will be applied.

", + "smithy.api#documentation": "

The revision of the published schema to upgrade the directory to.

", "smithy.api#required": {} } }, - "PublishedSchemaArn": { + "DirectoryArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The revision of the published schema to upgrade the directory to.

", + "smithy.api#documentation": "

The ARN for the directory to which the upgraded schema will be applied.

", "smithy.api#required": {} } }, @@ -9364,16 +9364,16 @@ "com.amazonaws.clouddirectory#UpgradeAppliedSchemaResponse": { "type": "structure", "members": { - "DirectoryArn": { + "UpgradedSchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the directory that is returned as part of the response.

" + "smithy.api#documentation": "

The ARN of the upgraded schema that is returned as part of the response.

" } }, - "UpgradedSchemaArn": { + "DirectoryArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the upgraded schema that is returned as part of the response.

" + "smithy.api#documentation": "

The ARN of the directory that is returned as part of the response.

" } } } @@ -9427,31 +9427,31 @@ "com.amazonaws.clouddirectory#UpgradePublishedSchemaRequest": { "type": "structure", "members": { - "MinorVersion": { - "target": "com.amazonaws.clouddirectory#Version", + "PublishedSchemaArn": { + "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

", + "smithy.api#documentation": "

The ARN of the published schema to be upgraded.

", "smithy.api#required": {} } }, - "PublishedSchemaArn": { + "DevelopmentSchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the published schema to be upgraded.

", + "smithy.api#documentation": "

The ARN of the development schema with the changes used for the upgrade.

", "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.clouddirectory#Bool", + "MinorVersion": { + "target": "com.amazonaws.clouddirectory#Version", "traits": { - "smithy.api#documentation": "

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

" + "smithy.api#documentation": "

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

", + "smithy.api#required": {} } }, - "DevelopmentSchemaArn": { - "target": "com.amazonaws.clouddirectory#Arn", + "DryRun": { + "target": "com.amazonaws.clouddirectory#Bool", "traits": { - "smithy.api#documentation": "

The ARN of the development schema with the changes used for the upgrade.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

" } } } 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 605d33b6e500..2972536e05f6 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json @@ -38,17 +38,17 @@ "com.amazonaws.cloudformation#AccountGateResult": { "type": "structure", "members": { - "StatusReason": { - "target": "com.amazonaws.cloudformation#AccountGateStatusReason", - "traits": { - "smithy.api#documentation": "

The reason for the account gate status assigned to this account and Region for the\n stack set operation.

" - } - }, "Status": { "target": "com.amazonaws.cloudformation#AccountGateStatus", "traits": { "smithy.api#documentation": "

The status of the account gate function.

\n " } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#AccountGateStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the account gate status assigned to this account and Region for the\n stack set operation.

" + } } }, "traits": { @@ -203,18 +203,18 @@ "com.amazonaws.cloudformation#CancelUpdateStackInput": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique identifier for this CancelUpdateStack request. Specify this\n token if you plan to retry requests so that AWS CloudFormation knows that you're not\n attempting to cancel an update on a stack with the same name. You might retry\n CancelUpdateStack requests to ensure that AWS CloudFormation successfully\n received them.

" - } - }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack.

", "smithy.api#required": {} } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for this CancelUpdateStack request. Specify this\n token if you plan to retry requests so that AWS CloudFormation knows that you're not\n attempting to cancel an update on a stack with the same name. You might retry\n CancelUpdateStack requests to ensure that AWS CloudFormation successfully\n received them.

" + } } }, "traits": { @@ -376,16 +376,16 @@ "com.amazonaws.cloudformation#ChangeSetSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.cloudformation#ChangeSetStatus", + "CreationTime": { + "target": "com.amazonaws.cloudformation#CreationTime", "traits": { - "smithy.api#documentation": "

The state of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.

" + "smithy.api#documentation": "

The start time when the change set was created, in UTC.

" } }, - "StatusReason": { - "target": "com.amazonaws.cloudformation#ChangeSetStatusReason", + "ExecutionStatus": { + "target": "com.amazonaws.cloudformation#ExecutionStatus", "traits": { - "smithy.api#documentation": "

A description of the change set's status. For example, if your change set is in the\n FAILED state, AWS CloudFormation shows the error message.

" + "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the\n change set. If you can’t execute the change set, the status indicates why. For example, a\n change set might be in an UNAVAILABLE state because AWS CloudFormation is\n still creating it or in an OBSOLETE state because the stack was already\n updated.

" } }, "Description": { @@ -394,16 +394,16 @@ "smithy.api#documentation": "

Descriptive information about the change set.

" } }, - "ChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

The ID of the change set.

" + "smithy.api#documentation": "

The name of the stack with which the change set is associated.

" } }, - "ExecutionStatus": { - "target": "com.amazonaws.cloudformation#ExecutionStatus", + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the\n change set. If you can’t execute the change set, the status indicates why. For example, a\n change set might be in an UNAVAILABLE state because AWS CloudFormation is\n still creating it or in an OBSOLETE state because the stack was already\n updated.

" + "smithy.api#documentation": "

The ID of the stack with which the change set is associated.

" } }, "ChangeSetName": { @@ -412,22 +412,22 @@ "smithy.api#documentation": "

The name of the change set.

" } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "ChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "

The name of the stack with which the change set is associated.

" + "smithy.api#documentation": "

The ID of the change set.

" } }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "StatusReason": { + "target": "com.amazonaws.cloudformation#ChangeSetStatusReason", "traits": { - "smithy.api#documentation": "

The ID of the stack with which the change set is associated.

" + "smithy.api#documentation": "

A description of the change set's status. For example, if your change set is in the\n FAILED state, AWS CloudFormation shows the error message.

" } }, - "CreationTime": { - "target": "com.amazonaws.cloudformation#CreationTime", + "Status": { + "target": "com.amazonaws.cloudformation#ChangeSetStatus", "traits": { - "smithy.api#documentation": "

The start time when the change set was created, in UTC.

" + "smithy.api#documentation": "

The state of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.

" } } }, @@ -692,7 +692,7 @@ "sdkId": "CloudFormation", "arnNamespace": "cloudformation", "cloudFormationName": "CloudFormation", - "cloudTrailEventSource": "activities.aws21.amzn" + "cloudTrailEventSource": "cloudformation.amazonaws.com" }, "aws.auth#sigv4": { "name": "cloudformation" @@ -725,29 +725,29 @@ "com.amazonaws.cloudformation#ContinueUpdateRollbackInput": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "

The name or the unique ID of the stack that you want to continue rolling\n back.

\n \n

Don't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).

\n ", - "smithy.api#required": {} - } - }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's\n credentials to make calls on your behalf. AWS CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n AWS CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, AWS CloudFormation uses the role that was previously\n associated with the stack. If no role is available, AWS CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for this ContinueUpdateRollback request. Specify\n this token if you plan to retry requests so that AWS CloudFormation knows that you're not\n attempting to continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that AWS CloudFormation\n successfully received them.

" + } + }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { "smithy.api#documentation": "

A list of the logical IDs of the resources that AWS CloudFormation skips during the\n continue update rollback operation. You can specify only resources that are in the\n UPDATE_FAILED state because a rollback failed. You can't specify resources\n that are in the UPDATE_FAILED state for other reasons, for example, because an\n update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

\n \n

Specify this property to skip rolling back resources that AWS CloudFormation can't\n successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the\n status of the specified resources to UPDATE_COMPLETE and continues to roll\n back the stack. After the rollback is complete, the state of the skipped resources will\n be inconsistent with the state of the resources in the stack template. Before performing\n another stack update, you must update the stack or resources to be consistent with each\n other. If you don't, subsequent stack updates might fail, and the stack will become\n unrecoverable.

\n \n

Specify the minimum number of resources required to successfully roll back your\n stack. For example, a failed resource update might cause dependent resources to fail. In\n this case, it might not be necessary to skip the dependent resources.

\n

To skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of\n a stack resource (Type: AWS::CloudFormation::Stack) in the\n ResourcesToSkip list, then its corresponding embedded stack must be in one\n of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or\n DELETE_FAILED.

\n \n

Don't confuse a child stack's name with its corresponding logical ID defined in\n the parent stack. For an example of a continue update rollback operation with nested\n stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.

\n " } }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

A unique identifier for this ContinueUpdateRollback request. Specify\n this token if you plan to retry requests so that AWS CloudFormation knows that you're not\n attempting to continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that AWS CloudFormation\n successfully received them.

" + "smithy.api#documentation": "

The name or the unique ID of the stack that you want to continue rolling\n back.

\n \n

Don't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).

\n ", + "smithy.api#required": {} } } }, @@ -788,28 +788,30 @@ "com.amazonaws.cloudformation#CreateChangeSetInput": { "type": "structure", "members": { - "ResourcesToImport": { - "target": "com.amazonaws.cloudformation#ResourcesToImport", + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

The resources to import into your stack.

" + "smithy.api#documentation": "

The name or the unique ID of the stack for which you are creating a change set. AWS\n CloudFormation generates the change set by comparing this stack's information with the\n information that you submit, such as a modified template or different parameter input\n values.

", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { - "smithy.api#documentation": "

Key-value pairs to associate with this stack. AWS CloudFormation also propagates\n these tags to resources in the stack. You can specify a maximum of 50 tags.

" + "smithy.api#documentation": "

The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.

\n

A change set name can contain only alphanumeric, case sensitive characters and\n hyphens. It must start with an alphabetic character and cannot exceed 128\n characters.

", + "smithy.api#required": {} } }, - "RollbackConfiguration": { - "target": "com.amazonaws.cloudformation#RollbackConfiguration", + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" + "smithy.api#documentation": "

Key-value pairs to associate with this stack. AWS CloudFormation also propagates\n these tags to resources in the stack. You can specify a maximum of 50 tags.

" } }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", + "ChangeSetType": { + "target": "com.amazonaws.cloudformation#ChangeSetType", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for AWS CloudFormation to create the stack.

\n " + "smithy.api#documentation": "

The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.

\n

If you create a change set for a new stack, AWS Cloudformation creates a stack with a\n unique stack ID, but no template or resources. The stack will be in the \n REVIEW_IN_PROGRESS\n state until you execute the change\n set.

\n

By default, AWS CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the\n CREATE type to create a change set for an existing stack.

" } }, "NotificationARNs": { @@ -818,17 +820,10 @@ "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS)\n topics that AWS CloudFormation associates with the stack. To remove all associated\n notification topics, specify an empty list.

" } }, - "TemplateURL": { - "target": "com.amazonaws.cloudformation#TemplateURL", - "traits": { - "smithy.api#documentation": "

The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation\n generates the change set by comparing this template with the stack that you\n specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetName", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.

\n

A change set name can contain only alphanumeric, case sensitive characters and\n hyphens. It must start with an alphabetic character and cannot exceed 128\n characters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description to help you identify this change set.

" } }, "RoleARN": { @@ -837,53 +832,58 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the\n role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n AWS CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, AWS CloudFormation uses the role that was previously\n associated with the stack. If no role is available, AWS CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", + "ClientToken": { + "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "

A structure that contains the body of the revised template, with a minimum length of\n 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by\n comparing this template with the template of the stack that you specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" + "smithy.api#documentation": "

A unique identifier for this CreateChangeSet request. Specify this token\n if you plan to retry requests so that AWS CloudFormation knows that you're not attempting\n to create another change set with the same name. You might retry\n CreateChangeSet requests to ensure that AWS CloudFormation successfully\n received them.

" } }, - "UsePreviousTemplate": { - "target": "com.amazonaws.cloudformation#UsePreviousTemplate", + "ResourceTypes": { + "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

Whether to reuse the template that is associated with the stack to create the change\n set.

" + "smithy.api#documentation": "

The template resource types that you have permissions to work with if you execute\n this change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating,\n the stack update fails. By default, AWS CloudFormation grants permissions to all resource\n types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in\n IAM policies for AWS CloudFormation. For more information, see Controlling Access with\n AWS Identity and Access Management in the AWS CloudFormation User\n Guide.

" } }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", + "TemplateURL": { + "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the\n change set. For more information, see the Parameter data type.

" + "smithy.api#documentation": "

The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation\n generates the change set by comparing this template with the stack that you\n specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" } }, - "ResourceTypes": { - "target": "com.amazonaws.cloudformation#ResourceTypes", + "ResourcesToImport": { + "target": "com.amazonaws.cloudformation#ResourcesToImport", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with if you execute\n this change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating,\n the stack update fails. By default, AWS CloudFormation grants permissions to all resource\n types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in\n IAM policies for AWS CloudFormation. For more information, see Controlling Access with\n AWS Identity and Access Management in the AWS CloudFormation User\n Guide.

" + "smithy.api#documentation": "

The resources to import into your stack.

" } }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A description to help you identify this change set.

" + "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the\n change set. For more information, see the Parameter data type.

" } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "UsePreviousTemplate": { + "target": "com.amazonaws.cloudformation#UsePreviousTemplate", "traits": { - "smithy.api#documentation": "

The name or the unique ID of the stack for which you are creating a change set. AWS\n CloudFormation generates the change set by comparing this stack's information with the\n information that you submit, such as a modified template or different parameter input\n values.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Whether to reuse the template that is associated with the stack to create the change\n set.

" } }, - "ClientToken": { - "target": "com.amazonaws.cloudformation#ClientToken", + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

A unique identifier for this CreateChangeSet request. Specify this token\n if you plan to retry requests so that AWS CloudFormation knows that you're not attempting\n to create another change set with the same name. You might retry\n CreateChangeSet requests to ensure that AWS CloudFormation successfully\n received them.

" + "smithy.api#documentation": "

A structure that contains the body of the revised template, with a minimum length of\n 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by\n comparing this template with the template of the stack that you specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" } }, - "ChangeSetType": { - "target": "com.amazonaws.cloudformation#ChangeSetType", + "RollbackConfiguration": { + "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.

\n

If you create a change set for a new stack, AWS Cloudformation creates a stack with a\n unique stack ID, but no template or resources. The stack will be in the \n REVIEW_IN_PROGRESS\n state until you execute the change\n set.

\n

By default, AWS CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the\n CREATE type to create a change set for an existing stack.

" + "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for AWS CloudFormation to create the stack.

\n " } } }, @@ -940,16 +940,28 @@ "com.amazonaws.cloudformation#CreateStackInput": { "type": "structure", "members": { - "StackPolicyBody": { - "target": "com.amazonaws.cloudformation#StackPolicyBody", + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the AWS CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's\n credentials to make calls on your behalf. AWS CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n AWS CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, AWS CloudFormation uses the role that was previously\n associated with the stack. If no role is available, AWS CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.

" + "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the\n stack. For more information, see the Parameter data\n type.

" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.cloudformation#ResourceTypes", + "traits": { + "smithy.api#documentation": "

The template resource types that you have permissions to work with for this create\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all AWS resource), Custom::* (for all\n custom resources), Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a\n particular AWS service), and\n AWS::service_name::resource_logical_ID\n (for a specific AWS resource).

\n

If the list of resource types doesn't include a resource that you're creating, the\n stack creation fails. By default, AWS CloudFormation grants permissions to all resource\n types. AWS Identity and Access Management (IAM) uses this parameter for AWS\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for AWS CloudFormation to create the stack.

\n " } }, "StackName": { @@ -959,52 +971,40 @@ "smithy.api#required": {} } }, - "StackPolicyURL": { - "target": "com.amazonaws.cloudformation#StackPolicyURL", - "traits": { - "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" - } - }, "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. This must be one of:\n DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.

\n

Default: ROLLBACK\n

" } }, - "NotificationARNs": { - "target": "com.amazonaws.cloudformation#NotificationARNs", - "traits": { - "smithy.api#documentation": "

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You\n can find your SNS topic ARNs using the SNS console or your Command Line Interface\n (CLI).

" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for AWS CloudFormation to create the stack.

\n " - } - }, "EnableTerminationProtection": { "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { "smithy.api#documentation": "

Whether to enable termination protection on the specified stack. If a user attempts\n to delete a stack with termination protection enabled, the operation fails and the stack\n remains unchanged. For more information, see Protecting a Stack From Being\n Deleted in the AWS CloudFormation User Guide. Termination protection is\n disabled on stacks by default.

\n

For nested stacks,\n termination protection is set on the root stack and cannot be changed directly on the\n nested stack.

" } }, + "DisableRollback": { + "target": "com.amazonaws.cloudformation#DisableRollback", + "traits": { + "smithy.api#documentation": "

Set to true to disable rollback of the stack if stack creation failed.\n You can specify either DisableRollback or OnFailure, but not\n both.

\n

Default: false\n

" + } + }, "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { "smithy.api#documentation": "

The amount of time that can pass before the stack status becomes CREATE_FAILED; if\n DisableRollback is not set or is set to false, the stack will\n be rolled back.

" } }, - "DisableRollback": { - "target": "com.amazonaws.cloudformation#DisableRollback", + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Set to true to disable rollback of the stack if stack creation failed.\n You can specify either DisableRollback or OnFailure, but not\n both.

\n

Default: false\n

" + "smithy.api#documentation": "

A unique identifier for this CreateStack request. Specify this token if\n you plan to retry requests so that AWS CloudFormation knows that you're not attempting to\n create a stack with the same name. You might retry CreateStack requests to\n ensure that AWS CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", + "TemplateURL": { + "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's\n credentials to make calls on your behalf. AWS CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n AWS CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, AWS CloudFormation uses the role that was previously\n associated with the stack. If no role is available, AWS CloudFormation uses a temporary\n session that is generated from your user credentials.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max\n size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to\n the Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.

" } }, "Tags": { @@ -1019,28 +1019,28 @@ "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" } }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the\n stack. For more information, see the Parameter data\n type.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.

" } }, - "ResourceTypes": { - "target": "com.amazonaws.cloudformation#ResourceTypes", + "StackPolicyBody": { + "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with for this create\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all AWS resource), Custom::* (for all\n custom resources), Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a\n particular AWS service), and\n AWS::service_name::resource_logical_ID\n (for a specific AWS resource).

\n

If the list of resource types doesn't include a resource that you're creating, the\n stack creation fails. By default, AWS CloudFormation grants permissions to all resource\n types. AWS Identity and Access Management (IAM) uses this parameter for AWS\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" + "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the AWS CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", + "NotificationARNs": { + "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "

A unique identifier for this CreateStack request. Specify this token if\n you plan to retry requests so that AWS CloudFormation knows that you're not attempting to\n create a stack with the same name. You might retry CreateStack requests to\n ensure that AWS CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You\n can find your SNS topic ARNs using the SNS console or your Command Line Interface\n (CLI).

" } }, - "TemplateURL": { - "target": "com.amazonaws.cloudformation#TemplateURL", + "StackPolicyURL": { + "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max\n size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to\n the Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.

" + "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" } } }, @@ -1083,18 +1083,16 @@ "com.amazonaws.cloudformation#CreateStackInstancesInput": { "type": "structure", "members": { - "Regions": { - "target": "com.amazonaws.cloudformation#RegionList", + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The names of one or more Regions where you want to create stack instances using the\n specified AWS account(s).

", - "smithy.api#required": {} + "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" } }, - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", + "ParameterOverrides": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to create stack instances\n from.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of stack set parameters whose values you want to override in the selected\n stack instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how AWS CloudFormation sets parameter values during stack instance operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

" } }, "OperationId": { @@ -1104,10 +1102,11 @@ "smithy.api#idempotencyToken": {} } }, - "Accounts": { - "target": "com.amazonaws.cloudformation#AccountList", + "Regions": { + "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the\n specified Region(s) for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

The names of one or more Regions where you want to create stack instances using the\n specified AWS account(s).

", + "smithy.api#required": {} } }, "DeploymentTargets": { @@ -1116,16 +1115,17 @@ "smithy.api#documentation": "

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

The name or unique ID of the stack set that you want to create stack instances\n from.

", + "smithy.api#required": {} } }, - "ParameterOverrides": { - "target": "com.amazonaws.cloudformation#Parameters", + "Accounts": { + "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

A list of stack set parameters whose values you want to override in the selected\n stack instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how AWS CloudFormation sets parameter values during stack instance operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

" + "smithy.api#documentation": "

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the\n specified Region(s) for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } } } @@ -1181,41 +1181,47 @@ "com.amazonaws.cloudformation#CreateStackSetInput": { "type": "structure", "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes. For more information, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" + "smithy.api#documentation": "

The name to associate with the stack set. The name must be unique in the Region where\n you create your stack set.

\n \n

A stack name can contain only alphanumeric characters (case-sensitive) and\n hyphens. It must start with an alphabetic character and can't be longer than 128\n characters.

\n ", + "smithy.api#required": {} } }, - "ExecutionRoleName": { - "target": "com.amazonaws.cloudformation#ExecutionRoleName", + "PermissionModel": { + "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "

The name of the IAM execution role to use to create the stack set. If you do not specify\n an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role\n for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.\n \n

" + "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

\n " } }, - "AdministrationRoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Prerequisites:\n Granting Permissions for Stack Set Operations in the\n AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n AWS CloudFormation also propagates these tags to supported resources that are created in\n the stacks. A maximum number of 50 tags can be specified.

\n

If you specify tags as part of a CreateStackSet action, AWS\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you don't, the entire CreateStackSet action fails with an access\n denied error, and the stack set is not created.

" } }, - "AutoDeployment": { - "target": "com.amazonaws.cloudformation#AutoDeployment", + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

" + "smithy.api#documentation": "

The input parameters for the stack set template.

" } }, - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

The name to associate with the stack set. The name must be unique in the Region where\n you create your stack set.

\n \n

A stack name can contain only alphanumeric characters (case-sensitive) and\n hyphens. It must start with an alphabetic character and can't be longer than 128\n characters.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes. For more information, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" } }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The input parameters for the stack set template.

" + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for AWS CloudFormation to create the stack set and related stack\n instances.

\n " + } + }, + "TemplateURL": { + "target": "com.amazonaws.cloudformation#TemplateURL", + "traits": { + "smithy.api#documentation": "

The location of the file that contains the template body. The URL must point to a\n template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more\n information, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" } }, "Description": { @@ -1224,16 +1230,16 @@ "smithy.api#documentation": "

A description of the stack set. You can use the description to identify the stack\n set's purpose or other important information.

" } }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", + "ExecutionRoleName": { + "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n AWS CloudFormation also propagates these tags to supported resources that are created in\n the stacks. A maximum number of 50 tags can be specified.

\n

If you specify tags as part of a CreateStackSet action, AWS\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you don't, the entire CreateStackSet action fails with an access\n denied error, and the stack set is not created.

" + "smithy.api#documentation": "

The name of the IAM execution role to use to create the stack set. If you do not specify\n an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role\n for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.\n \n

" } }, - "TemplateURL": { - "target": "com.amazonaws.cloudformation#TemplateURL", + "AutoDeployment": { + "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "

The location of the file that contains the template body. The URL must point to a\n template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more\n information, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" + "smithy.api#documentation": "

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

" } }, "ClientRequestToken": { @@ -1243,16 +1249,10 @@ "smithy.api#idempotencyToken": {} } }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for AWS CloudFormation to create the stack set and related stack\n instances.

\n " - } - }, - "PermissionModel": { - "target": "com.amazonaws.cloudformation#PermissionModels", + "AdministrationRoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

\n " + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Prerequisites:\n Granting Permissions for Stack Set Operations in the\n AWS CloudFormation User Guide.

" } } } @@ -1304,18 +1304,18 @@ "com.amazonaws.cloudformation#DeleteChangeSetInput": { "type": "structure", "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "

If you specified the name of a change set to delete, specify the stack name or ID\n (ARN) that is associated with it.

" + } + }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the change set that you want to\n delete.

", "smithy.api#required": {} } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "

If you specified the name of a change set to delete, specify the stack name or ID\n (ARN) that is associated with it.

" - } } }, "traits": { @@ -1352,12 +1352,6 @@ "smithy.api#documentation": "

A unique identifier for this DeleteStack request. Specify this token if\n you plan to retry requests so that AWS CloudFormation knows that you're not attempting to\n delete a stack with the same name. You might retry DeleteStack requests to\n ensure that AWS CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's\n credentials to make calls on your behalf.

\n

If you don't specify a value, AWS CloudFormation uses the role that was previously\n associated with the stack. If no role is available, AWS CloudFormation uses a temporary\n session that is generated from your user credentials.

" - } - }, "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { @@ -1370,6 +1364,12 @@ "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack.

", "smithy.api#required": {} } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's\n credentials to make calls on your behalf.

\n

If you don't specify a value, AWS CloudFormation uses the role that was previously\n associated with the stack. If no role is available, AWS CloudFormation uses a temporary\n session that is generated from your user credentials.

" + } } }, "traits": { @@ -1408,50 +1408,50 @@ "com.amazonaws.cloudformation#DeleteStackInstancesInput": { "type": "structure", "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to delete stack instances\n for.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" } }, - "Regions": { - "target": "com.amazonaws.cloudformation#RegionList", + "RetainStacks": { + "target": "com.amazonaws.cloudformation#RetainStacks", "traits": { - "smithy.api#documentation": "

The Regions where you want to delete stack set instances.

", + "smithy.api#documentation": "

Removes the stack instances from the specified stack set, but doesn't delete the\n stacks. You can't reassociate a retained stack or add an existing, saved stack to a new\n stack set.

\n

For more information, see Stack set operation options.

", "smithy.api#required": {} } }, - "Accounts": { - "target": "com.amazonaws.cloudformation#AccountList", + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

If you don't specify an operation ID, the SDK generates one automatically.

\n

The operation ID also functions as an idempotency token, to ensure that AWS\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You can retry stack set operation requests to ensure that AWS\n CloudFormation successfully received them.

\n

Repeating this stack set operation with a new operation ID retries all stack\n instances whose status is OUTDATED.

", + "smithy.api#idempotencyToken": {} } }, - "RetainStacks": { - "target": "com.amazonaws.cloudformation#RetainStacks", + "Regions": { + "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

Removes the stack instances from the specified stack set, but doesn't delete the\n stacks. You can't reassociate a retained stack or add an existing, saved stack to a new\n stack set.

\n

For more information, see Stack set operation options.

", + "smithy.api#documentation": "

The Regions where you want to delete stack set instances.

", "smithy.api#required": {} } }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", - "traits": { - "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" - } - }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { "smithy.api#documentation": "

[Service-managed permissions] The AWS Organizations accounts from which to delete stack instances.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", + "Accounts": { + "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

If you don't specify an operation ID, the SDK generates one automatically.

\n

The operation ID also functions as an idempotency token, to ensure that AWS\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You can retry stack set operation requests to ensure that AWS\n CloudFormation successfully received them.

\n

Repeating this stack set operation with a new operation ID retries all stack\n instances whose status is OUTDATED.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

[Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + } + }, + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "

The name or unique ID of the stack set that you want to delete stack instances\n for.

", + "smithy.api#required": {} } } } @@ -1563,16 +1563,10 @@ "com.amazonaws.cloudformation#DeregisterTypeInput": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#PrivateTypeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", + "VersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The name of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

" } }, "Type": { @@ -1581,10 +1575,16 @@ "smithy.api#documentation": "

The kind of type.

\n

Currently the only valid value is RESOURCE.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } }, - "VersionId": { - "target": "com.amazonaws.cloudformation#TypeVersionId", + "Arn": { + "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } } } @@ -1627,17 +1627,17 @@ "com.amazonaws.cloudformation#DescribeAccountLimitsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of limits.\n If no additional page exists, this value is null.

" - } - }, "AccountLimits": { "target": "com.amazonaws.cloudformation#AccountLimitList", "traits": { "smithy.api#documentation": "

An account limit structure that contain a list of AWS CloudFormation account limits\n and their values.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of limits.\n If no additional page exists, this value is null.

" + } } }, "traits": { @@ -1664,13 +1664,6 @@ "com.amazonaws.cloudformation#DescribeChangeSetInput": { "type": "structure", "members": { - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", - "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the change set that you want to\n describe.

", - "smithy.api#required": {} - } - }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { @@ -1682,6 +1675,13 @@ "traits": { "smithy.api#documentation": "

A string (provided by the DescribeChangeSet response output) that\n identifies the next page of information that you want to retrieve.

" } + }, + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the change set that you want to\n describe.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1691,10 +1691,16 @@ "com.amazonaws.cloudformation#DescribeChangeSetOutput": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", + "CreationTime": { + "target": "com.amazonaws.cloudformation#CreationTime", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that describes the input parameters and\n their values used to create the change set. For more information, see the Parameter data type.

" + "smithy.api#documentation": "

The start time when the change set was created, in UTC.

" + } + }, + "NotificationARNs": { + "target": "com.amazonaws.cloudformation#NotificationARNs", + "traits": { + "smithy.api#documentation": "

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be\n associated with the stack if you execute the change set.

" } }, "Changes": { @@ -1703,46 +1709,40 @@ "smithy.api#documentation": "

A list of Change structures that describes the resources AWS\n CloudFormation changes if you execute the change set.

" } }, - "Status": { - "target": "com.amazonaws.cloudformation#ChangeSetStatus", + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The current status of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.

" + "smithy.api#documentation": "

If you execute the change set, the list of capabilities that were explicitly\n acknowledged when the change set was created.

" } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "ChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "

The name of the stack that is associated with the change set.

" + "smithy.api#documentation": "

The ARN of the change set.

" } }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "

The ARN of the stack that is associated with the change set.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.cloudformation#CreationTime", + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

The start time when the change set was created, in UTC.

" + "smithy.api#documentation": "

A list of Parameter structures that describes the input parameters and\n their values used to create the change set. For more information, see the Parameter data type.

" } }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { - "smithy.api#documentation": "

Information about the change set.

" + "smithy.api#documentation": "

The name of the change set.

" } }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", + "ExecutionStatus": { + "target": "com.amazonaws.cloudformation#ExecutionStatus", "traits": { - "smithy.api#documentation": "

If you execute the change set, the list of capabilities that were explicitly\n acknowledged when the change set was created.

" + "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the\n change set. If you can’t execute the change set, the status indicates why. For example, a\n change set might be in an UNAVAILABLE state because AWS CloudFormation is\n still creating it or in an OBSOLETE state because the stack was already\n updated.

" } }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If you execute the change set, the tags that will be associated with the\n stack.

" + "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of changes. If\n there is no additional page, this value is null.

" } }, "RollbackConfiguration": { @@ -1751,40 +1751,40 @@ "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" } }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetName", - "traits": { - "smithy.api#documentation": "

The name of the change set.

" - } - }, "StatusReason": { "target": "com.amazonaws.cloudformation#ChangeSetStatusReason", "traits": { "smithy.api#documentation": "

A description of the change set's status. For example, if your attempt to create a\n change set failed, AWS CloudFormation shows the error message.

" } }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of changes. If\n there is no additional page, this value is null.

" + "smithy.api#documentation": "

If you execute the change set, the tags that will be associated with the\n stack.

" } }, - "NotificationARNs": { - "target": "com.amazonaws.cloudformation#NotificationARNs", + "Status": { + "target": "com.amazonaws.cloudformation#ChangeSetStatus", "traits": { - "smithy.api#documentation": "

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be\n associated with the stack if you execute the change set.

" + "smithy.api#documentation": "

The current status of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.

" } }, - "ChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The ARN of the change set.

" + "smithy.api#documentation": "

Information about the change set.

" } }, - "ExecutionStatus": { - "target": "com.amazonaws.cloudformation#ExecutionStatus", + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the\n change set. If you can’t execute the change set, the status indicates why. For example, a\n change set might be in an UNAVAILABLE state because AWS CloudFormation is\n still creating it or in an OBSOLETE state because the stack was already\n updated.

" + "smithy.api#documentation": "

The name of the stack that is associated with the change set.

" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "

The ARN of the stack that is associated with the change set.

" } } }, @@ -1819,11 +1819,16 @@ "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput": { "type": "structure", "members": { - "Timestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "StackDriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "

Time at which the stack drift detection operation was initiated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected configuration.

\n " + } + }, + "DetectionStatusReason": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionStatusReason", + "traits": { + "smithy.api#documentation": "

The reason the stack drift detection operation has its current status.

" } }, "DetectionStatus": { @@ -1833,23 +1838,17 @@ "smithy.api#required": {} } }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "Timestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the stack.

", + "smithy.api#documentation": "

Time at which the stack drift detection operation was initiated.

", "smithy.api#required": {} } }, - "StackDriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", - "traits": { - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected configuration.

\n " - } - }, - "StackDriftDetectionId": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

AWS CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long,\n may vary.

", + "smithy.api#documentation": "

The ID of the stack.

", "smithy.api#required": {} } }, @@ -1859,10 +1858,11 @@ "smithy.api#documentation": "

Total number of stack resources that have drifted. This is NULL until the drift\n detection operation reaches a status of DETECTION_COMPLETE. This value will be\n 0 for stacks whose drift status is IN_SYNC.

" } }, - "DetectionStatusReason": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionStatusReason", + "StackDriftDetectionId": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { - "smithy.api#documentation": "

The reason the stack drift detection operation has its current status.

" + "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

AWS CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long,\n may vary.

", + "smithy.api#required": {} } } } @@ -1887,17 +1887,17 @@ "com.amazonaws.cloudformation#DescribeStackEventsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

A string that identifies the next page of events that you want to retrieve.

" - } - }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:

\n \n

Default: There is no default value.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string that identifies the next page of events that you want to retrieve.

" + } } }, "traits": { @@ -1907,17 +1907,17 @@ "com.amazonaws.cloudformation#DescribeStackEventsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of events.\n If no additional page exists, this value is null.

" - } - }, "StackEvents": { "target": "com.amazonaws.cloudformation#StackEvents", "traits": { "smithy.api#documentation": "

A list of StackEvents structures.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of events.\n If no additional page exists, this value is null.

" + } } }, "traits": { @@ -1954,17 +1954,17 @@ "smithy.api#required": {} } }, - "StackInstanceAccount": { - "target": "com.amazonaws.cloudformation#Account", + "StackInstanceRegion": { + "target": "com.amazonaws.cloudformation#Region", "traits": { - "smithy.api#documentation": "

The ID of an AWS account that's associated with this stack instance.

", + "smithy.api#documentation": "

The name of a Region that's associated with this stack instance.

", "smithy.api#required": {} } }, - "StackInstanceRegion": { - "target": "com.amazonaws.cloudformation#Region", + "StackInstanceAccount": { + "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

The name of a Region that's associated with this stack instance.

", + "smithy.api#documentation": "

The ID of an AWS account that's associated with this stack instance.

", "smithy.api#required": {} } } @@ -2013,6 +2013,12 @@ "com.amazonaws.cloudformation#DescribeStackResourceDriftsInput": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.cloudformation#BoxedMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" + } + }, "StackResourceDriftStatusFilters": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { @@ -2025,12 +2031,6 @@ "smithy.api#documentation": "

A string that identifies the next page of stack resource drift results.

" } }, - "MaxResults": { - "target": "com.amazonaws.cloudformation#BoxedMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" - } - }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { @@ -2043,18 +2043,18 @@ "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call\n DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results,\n NextToken is set to null.

" + } + }, "StackResourceDrifts": { "target": "com.amazonaws.cloudformation#StackResourceDrifts", "traits": { "smithy.api#documentation": "

Drift information for the resources that have been checked for drift in the specified\n stack. This includes actual and expected configuration values for resources where AWS CloudFormation\n detects drift.

\n

For a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that have not yet been checked for\n drift are not included. Resources that do not currently support drift detection are not\n checked, and so not included. For a list of resources that support drift detection, see\n Resources that Support Drift Detection.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call\n DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results,\n NextToken is set to null.

" - } } } }, @@ -2109,18 +2109,18 @@ "com.amazonaws.cloudformation#DescribeStackResourcesInput": { "type": "structure", "members": { - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by AWS CloudFormation.

\n

For example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass\n the EC2 InstanceId to DescribeStackResources to find which stack\n the instance belongs to and what other resources are part of the stack.

\n

Required: Conditional. If you do not specify PhysicalResourceId, you\n must specify StackName.

\n

Default: There is no default value.

" - } - }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#documentation": "

The logical name of the resource as specified in the template.

\n

Default: There is no default value.

" } }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by AWS CloudFormation.

\n

For example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass\n the EC2 InstanceId to DescribeStackResources to find which stack\n the instance belongs to and what other resources are part of the stack.

\n

Required: Conditional. If you do not specify PhysicalResourceId, you\n must specify StackName.

\n

Default: There is no default value.

" + } + }, "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { @@ -2256,17 +2256,17 @@ "com.amazonaws.cloudformation#DescribeStacksInput": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:

\n \n

Default: There is no default value.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "

A string that identifies the next page of stacks that you want to retrieve.

" } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:

\n \n

Default: There is no default value.

" + } } }, "traits": { @@ -2276,17 +2276,17 @@ "com.amazonaws.cloudformation#DescribeStacksOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of stacks.\n If no additional page exists, this value is null.

" - } - }, "Stacks": { "target": "com.amazonaws.cloudformation#Stacks", "traits": { "smithy.api#documentation": "

A list of stack structures.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of stacks.\n If no additional page exists, this value is null.

" + } } }, "traits": { @@ -2317,18 +2317,6 @@ "com.amazonaws.cloudformation#DescribeTypeInput": { "type": "structure", "members": { - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "

The name of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" - } - }, - "Arn": { - "target": "com.amazonaws.cloudformation#TypeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" - } - }, "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { @@ -2340,28 +2328,46 @@ "traits": { "smithy.api#documentation": "

The kind of type.

\n

Currently the only valid value is RESOURCE.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } + }, + "Arn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + } } } }, "com.amazonaws.cloudformation#DescribeTypeOutput": { "type": "structure", "members": { - "DeprecatedStatus": { - "target": "com.amazonaws.cloudformation#DeprecatedStatus", + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The deprecation status of the type.

\n

Valid values include:

\n " + "smithy.api#documentation": "

The kind of type.

\n

Currently the only valid value is RESOURCE.

" } }, - "SourceUrl": { + "DefaultVersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", + "traits": { + "smithy.api#documentation": "

The ID of the default version of the type. The default version is used when the type version is not specified.

\n

To set the default version of a type, use \n SetTypeDefaultVersion\n .

" + } + }, + "DocumentationUrl": { "target": "com.amazonaws.cloudformation#OptionalSecureUrl", "traits": { - "smithy.api#documentation": "

The URL of the source code for the type.

" + "smithy.api#documentation": "

The URL of a page providing detailed documentation for this type.

" } }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "ExecutionRoleArn": { + "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { - "smithy.api#documentation": "

The description of the registered type.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an\n \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. CloudFormation then\n assumes that execution role to provide your resource type with the appropriate\n credentials.

" } }, "Arn": { @@ -2370,22 +2376,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type.

" } }, - "DocumentationUrl": { - "target": "com.amazonaws.cloudformation#OptionalSecureUrl", + "ProvisioningType": { + "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "

The URL of a page providing detailed documentation for this type.

" + "smithy.api#documentation": "

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

\n " } }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The name of the registered type.

" + "smithy.api#documentation": "

The description of the registered type.

" } }, - "Schema": { - "target": "com.amazonaws.cloudformation#TypeSchema", + "LoggingConfig": { + "target": "com.amazonaws.cloudformation#LoggingConfig", "traits": { - "smithy.api#documentation": "

The schema that defines the type.

\n

For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

" + "smithy.api#documentation": "

Contains logging configuration information for a type.

" } }, "LastUpdated": { @@ -2394,52 +2400,46 @@ "smithy.api#documentation": "

When the specified type version was registered.

" } }, - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "

The kind of type.

\n

Currently the only valid value is RESOURCE.

" - } - }, - "TimeCreated": { - "target": "com.amazonaws.cloudformation#Timestamp", + "IsDefaultVersion": { + "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

When the specified type version was registered.

" + "smithy.api#documentation": "

Whether the specified type version is set as the default version.

" } }, - "ProvisioningType": { - "target": "com.amazonaws.cloudformation#ProvisioningType", + "Visibility": { + "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

\n " + "smithy.api#documentation": "

The scope at which the type is visible and usable in CloudFormation operations.

\n

Valid values include:

\n " } }, - "ExecutionRoleArn": { - "target": "com.amazonaws.cloudformation#RoleARN2", + "SourceUrl": { + "target": "com.amazonaws.cloudformation#OptionalSecureUrl", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an\n \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. CloudFormation then\n assumes that execution role to provide your resource type with the appropriate\n credentials.

" + "smithy.api#documentation": "

The URL of the source code for the type.

" } }, - "Visibility": { - "target": "com.amazonaws.cloudformation#Visibility", + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The scope at which the type is visible and usable in CloudFormation operations.

\n

Valid values include:

\n " + "smithy.api#documentation": "

The name of the registered type.

" } }, - "LoggingConfig": { - "target": "com.amazonaws.cloudformation#LoggingConfig", + "DeprecatedStatus": { + "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { - "smithy.api#documentation": "

Contains logging configuration information for a type.

" + "smithy.api#documentation": "

The deprecation status of the type.

\n

Valid values include:

\n " } }, - "IsDefaultVersion": { - "target": "com.amazonaws.cloudformation#IsDefaultVersion", + "Schema": { + "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "

Whether the specified type version is set as the default version.

" + "smithy.api#documentation": "

The schema that defines the type.

\n

For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

" } }, - "DefaultVersionId": { - "target": "com.amazonaws.cloudformation#TypeVersionId", + "TimeCreated": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the default version of the type. The default version is used when the type version is not specified.

\n

To set the default version of a type, use \n SetTypeDefaultVersion\n .

" + "smithy.api#documentation": "

When the specified type version was registered.

" } } } @@ -2477,28 +2477,28 @@ "com.amazonaws.cloudformation#DescribeTypeRegistrationOutput": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "

The description of the type registration request.

" - } - }, "ProgressStatus": { "target": "com.amazonaws.cloudformation#RegistrationStatus", "traits": { "smithy.api#documentation": "

The current status of the type registration request.

" } }, + "TypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type being registered.

\n

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

" + } + }, "TypeVersionArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this specific version of the type being registered.

\n

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

" } }, - "TypeArn": { - "target": "com.amazonaws.cloudformation#TypeArn", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type being registered.

\n

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

" + "smithy.api#documentation": "

The description of the type registration request.

" } } } @@ -2569,17 +2569,17 @@ "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

The name of the stack to which the resource belongs.

", + "smithy.api#documentation": "

The logical name of the resource for which to return drift information.

", "smithy.api#required": {} } }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

The logical name of the resource for which to return drift information.

", + "smithy.api#documentation": "

The name of the stack to which the resource belongs.

", "smithy.api#required": {} } } @@ -2623,13 +2623,6 @@ "com.amazonaws.cloudformation#DetectStackSetDriftInput": { "type": "structure", "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetNameOrId", - "traits": { - "smithy.api#documentation": "

The name of the stack set on which to perform the drift detection operation.

", - "smithy.api#required": {} - } - }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { @@ -2637,6 +2630,13 @@ "smithy.api#idempotencyToken": {} } }, + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetNameOrId", + "traits": { + "smithy.api#documentation": "

The name of the stack set on which to perform the drift detection operation.

", + "smithy.api#required": {} + } + }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences" } @@ -2800,12 +2800,6 @@ "com.amazonaws.cloudformation#ExecuteChangeSetInput": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique identifier for this ExecuteChangeSet request. Specify this\n token if you plan to retry requests so that AWS CloudFormation knows that you're not\n attempting to execute a change set to update a stack with the same name. You might retry\n ExecuteChangeSet requests to ensure that AWS CloudFormation successfully\n received them.

" - } - }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { @@ -2818,6 +2812,12 @@ "smithy.api#documentation": "

The name or ARN of the change set that you want use to update the specified\n stack.

", "smithy.api#required": {} } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for this ExecuteChangeSet request. Specify this\n token if you plan to retry requests so that AWS CloudFormation knows that you're not\n attempting to execute a change set to update a stack with the same name. You might retry\n ExecuteChangeSet requests to ensure that AWS CloudFormation successfully\n received them.

" + } } }, "traits": { @@ -2875,18 +2875,18 @@ "com.amazonaws.cloudformation#Export": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.cloudformation#ExportName", - "traits": { - "smithy.api#documentation": "

The name of exported output value. Use this name and the Fn::ImportValue\n function to import the associated value into other stacks. The name is defined in the\n Export field in the associated stack's Outputs\n section.

" - } - }, "Value": { "target": "com.amazonaws.cloudformation#ExportValue", "traits": { "smithy.api#documentation": "

The value of the exported output, such as a resource physical ID. This value is\n defined in the Export field in the associated stack's Outputs\n section.

" } }, + "Name": { + "target": "com.amazonaws.cloudformation#ExportName", + "traits": { + "smithy.api#documentation": "

The name of exported output value. Use this name and the Fn::ImportValue\n function to import the associated value into other stacks. The name is defined in the\n Export field in the associated stack's Outputs\n section.

" + } + }, "ExportingStackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { @@ -2998,10 +2998,10 @@ "com.amazonaws.cloudformation#GetTemplateInput": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { - "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:

\n \n

Default: There is no default value.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation\n returns the associated template. If you specify a name, you must also specify the\n StackName.

" } }, "TemplateStage": { @@ -3010,10 +3010,10 @@ "smithy.api#documentation": "

For templates that include transforms, the stage of the template that AWS\n CloudFormation returns. To get the user-submitted template, specify Original.\n To get the template after AWS CloudFormation has processed all transforms, specify\n Processed.

\n

If the template doesn't include transforms, Original and\n Processed return the same template. By default, AWS CloudFormation\n specifies Original.

" } }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation\n returns the associated template. If you specify a name, you must also specify the\n StackName.

" + "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which are not\n always interchangeable:

\n \n

Default: There is no default value.

" } } }, @@ -3024,17 +3024,17 @@ "com.amazonaws.cloudformation#GetTemplateOutput": { "type": "structure", "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "

Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

\n

AWS CloudFormation returns the same template that was used when the stack was\n created.

" - } - }, "StagesAvailable": { "target": "com.amazonaws.cloudformation#StageList", "traits": { "smithy.api#documentation": "

The stage of the template that you can retrieve. For stacks, the\n Original and Processed templates are always available. For\n change sets, the Original template is always available. After AWS\n CloudFormation finishes creating the change set, the Processed template\n becomes available.

" } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "

Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

\n

AWS CloudFormation returns the same template that was used when the stack was\n created.

" + } } }, "traits": { @@ -3061,16 +3061,10 @@ "com.amazonaws.cloudformation#GetTemplateSummaryInput": { "type": "structure", "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" - } - }, - "TemplateURL": { - "target": "com.amazonaws.cloudformation#TemplateURL", + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max\n size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about\n templates, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" + "smithy.api#documentation": "

The name or the stack ID that is associated with the stack, which are not always\n interchangeable. For running stacks, you can specify either the stack's name or its unique\n stack ID. For deleted stack, you must specify the unique stack ID.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } }, "StackSetName": { @@ -3079,10 +3073,16 @@ "smithy.api#documentation": "

The name or unique ID of the stack set from which the stack was created.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "TemplateURL": { + "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

The name or the stack ID that is associated with the stack, which are not always\n interchangeable. For running stacks, you can specify either the stack's name or its unique\n stack ID. For deleted stack, you must specify the unique stack ID.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max\n size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about\n templates, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } } }, @@ -3093,6 +3093,18 @@ "com.amazonaws.cloudformation#GetTemplateSummaryOutput": { "type": "structure", "members": { + "Parameters": { + "target": "com.amazonaws.cloudformation#ParameterDeclarations", + "traits": { + "smithy.api#documentation": "

A list of parameter declarations that describe various properties for each\n parameter.

" + } + }, + "DeclaredTransforms": { + "target": "com.amazonaws.cloudformation#TransformsList", + "traits": { + "smithy.api#documentation": "

A list of the transforms that are declared in the template.

" + } + }, "ResourceIdentifierSummaries": { "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", "traits": { @@ -3105,22 +3117,16 @@ "smithy.api#documentation": "

The AWS template format version, which identifies the capabilities of the\n template.

" } }, - "Metadata": { - "target": "com.amazonaws.cloudformation#Metadata", - "traits": { - "smithy.api#documentation": "

The value that is defined for the Metadata property of the\n template.

" - } - }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "

The value that is defined in the Description property of the\n template.

" } }, - "DeclaredTransforms": { - "target": "com.amazonaws.cloudformation#TransformsList", + "CapabilitiesReason": { + "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { - "smithy.api#documentation": "

A list of the transforms that are declared in the template.

" + "smithy.api#documentation": "

The list of resources that generated the values in the Capabilities\n response element.

" } }, "ResourceTypes": { @@ -3135,16 +3141,10 @@ "smithy.api#documentation": "

The capabilities found within the template. If your template contains IAM resources,\n you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when\n you use the CreateStack or UpdateStack actions with\n your template; otherwise, those actions return an InsufficientCapabilities error.

\n

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" } }, - "CapabilitiesReason": { - "target": "com.amazonaws.cloudformation#CapabilitiesReason", - "traits": { - "smithy.api#documentation": "

The list of resources that generated the values in the Capabilities\n response element.

" - } - }, - "Parameters": { - "target": "com.amazonaws.cloudformation#ParameterDeclarations", + "Metadata": { + "target": "com.amazonaws.cloudformation#Metadata", "traits": { - "smithy.api#documentation": "

A list of parameter declarations that describe various properties for each\n parameter.

" + "smithy.api#documentation": "

The value that is defined for the Metadata property of the\n template.

" } } }, @@ -3343,18 +3343,18 @@ "com.amazonaws.cloudformation#ListChangeSetsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

A string (provided by the ListChangeSets response output) that\n identifies the next page of change sets that you want to retrieve.

" - } - }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the stack for which you want to list\n change sets.

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string (provided by the ListChangeSets response output) that\n identifies the next page of change sets that you want to retrieve.

" + } } }, "traits": { @@ -3412,17 +3412,17 @@ "com.amazonaws.cloudformation#ListExportsOutput": { "type": "structure", "members": { - "Exports": { - "target": "com.amazonaws.cloudformation#Exports", - "traits": { - "smithy.api#documentation": "

The output for the ListExports action.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "

If the output exceeds 100 exported output values, a string that identifies the next\n page of exports. If there is no additional page, this value is null.

" } + }, + "Exports": { + "target": "com.amazonaws.cloudformation#Exports", + "traits": { + "smithy.api#documentation": "

The output for the ListExports action.

" + } } } }, @@ -3446,35 +3446,35 @@ "com.amazonaws.cloudformation#ListImportsInput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string (provided by the ListImports response output) that\n identifies the next page of stacks that are importing the specified exported output value.\n

" + } + }, "ExportName": { "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#documentation": "

The name of the exported output value. AWS CloudFormation returns the stack names\n that are importing this value.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

A string (provided by the ListImports response output) that\n identifies the next page of stacks that are importing the specified exported output value.\n

" - } } } }, "com.amazonaws.cloudformation#ListImportsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

A string that identifies the next page of exports. If there is no additional page,\n this value is null.

" - } - }, "Imports": { "target": "com.amazonaws.cloudformation#Imports", "traits": { "smithy.api#documentation": "

A list of stack names that are importing the specified exported output value.\n

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

A string that identifies the next page of exports. If there is no additional page,\n this value is null.

" + } } } }, @@ -3492,40 +3492,40 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about stack instances that are associated with the\n specified stack set. You can filter for stack instances that are associated with a specific\n AWS account name or Region, or that have a specific status.

" - } - }, + "smithy.api#documentation": "

Returns summary information about stack instances that are associated with the\n specified stack set. You can filter for stack instances that are associated with a specific\n AWS account name or Region, or that have a specific status.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, "com.amazonaws.cloudformation#ListStackInstancesInput": { "type": "structure", "members": { - "StackInstanceAccount": { - "target": "com.amazonaws.cloudformation#Account", - "traits": { - "smithy.api#documentation": "

The name of the AWS account that you want to list stack instances for.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.cloudformation#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" - } - }, "Filters": { "target": "com.amazonaws.cloudformation#StackInstanceFilters", "traits": { "smithy.api#documentation": "

The status that stack instances are filtered by.

" } }, + "StackInstanceRegion": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "

The name of the Region where you want to list stack instances.

" + } + }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "

If the previous request didn't return all of the remaining results, the response's\n NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.

" } }, - "StackInstanceRegion": { - "target": "com.amazonaws.cloudformation#Region", + "StackInstanceAccount": { + "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

The name of the Region where you want to list stack instances.

" + "smithy.api#documentation": "

The name of the AWS account that you want to list stack instances for.

" } }, "StackSetName": { @@ -3534,23 +3534,29 @@ "smithy.api#documentation": "

The name or unique ID of the stack set that you want to list stack instances\n for.

", "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" + } } } }, "com.amazonaws.cloudformation#ListStackInstancesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to\n null.

" - } - }, "Summaries": { "target": "com.amazonaws.cloudformation#StackInstanceSummaries", "traits": { "smithy.api#documentation": "

A list of StackInstanceSummary structures that contain information about\n the specified stack instances.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to\n null.

" + } } } }, @@ -3595,17 +3601,17 @@ "com.amazonaws.cloudformation#ListStackResourcesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of stack\n resources. If no additional page exists, this value is null.

" - } - }, "StackResourceSummaries": { "target": "com.amazonaws.cloudformation#StackResourceSummaries", "traits": { "smithy.api#documentation": "

A list of StackResourceSummary structures.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of stack\n resources. If no additional page exists, this value is null.

" + } } }, "traits": { @@ -3629,18 +3635,18 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about the results of a stack set operation.

" + "smithy.api#documentation": "

Returns summary information about the results of a stack set operation.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } } }, "com.amazonaws.cloudformation#ListStackSetOperationResultsInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.cloudformation#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" - } - }, "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { @@ -3648,17 +3654,23 @@ "smithy.api#required": {} } }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

The ID of the stack set operation.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "

If the previous request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set\n of results, call ListStackSetOperationResults again and assign that token to\n the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to\n null.

" } }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", + "MaxResults": { + "target": "com.amazonaws.cloudformation#MaxResults", "traits": { - "smithy.api#documentation": "

The ID of the stack set operation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" } } } @@ -3694,16 +3706,22 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about operations performed on a stack set.

" + "smithy.api#documentation": "

Returns summary information about operations performed on a stack set.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } } }, "com.amazonaws.cloudformation#ListStackSetOperationsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", + "MaxResults": { + "target": "com.amazonaws.cloudformation#MaxResults", "traits": { - "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call ListStackSetOperations again and assign that token\n to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to\n null.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" } }, "StackSetName": { @@ -3713,10 +3731,10 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.cloudformation#MaxResults", + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call ListStackSetOperations again and assign that token\n to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to\n null.

" } } } @@ -3724,17 +3742,17 @@ "com.amazonaws.cloudformation#ListStackSetOperationsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the request doesn't return all results, NextToken is set to a token.\n To retrieve the next set of results, call ListOperationResults again and\n assign that token to the request object's NextToken parameter. If there are no\n remaining results, NextToken is set to null.

" - } - }, "Summaries": { "target": "com.amazonaws.cloudformation#StackSetOperationSummaries", "traits": { "smithy.api#documentation": "

A list of StackSetOperationSummary structures that contain summary\n information about operations for the specified stack set.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the request doesn't return all results, NextToken is set to a token.\n To retrieve the next set of results, call ListOperationResults again and\n assign that token to the request object's NextToken parameter. If there are no\n remaining results, NextToken is set to null.

" + } } } }, @@ -3747,24 +3765,30 @@ "target": "com.amazonaws.cloudformation#ListStackSetsOutput" }, "traits": { - "smithy.api#documentation": "

Returns summary information about stack sets that are associated with the\n user.

" + "smithy.api#documentation": "

Returns summary information about stack sets that are associated with the\n user.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } } }, "com.amazonaws.cloudformation#ListStackSetsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call ListStackSets again and assign that token to the\n request object's NextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to\n null.

" - } - }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.

" } }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call ListStackSets again and assign that token to the\n request object's NextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to\n null.

" + } + }, "Status": { "target": "com.amazonaws.cloudformation#StackSetStatus", "traits": { @@ -3776,17 +3800,17 @@ "com.amazonaws.cloudformation#ListStackSetsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to\n null.

" - } - }, "Summaries": { "target": "com.amazonaws.cloudformation#StackSetSummaries", "traits": { "smithy.api#documentation": "

A list of StackSetSummary structures that contain information about the\n user's stack sets.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call ListStackInstances\n again and assign that token to the request object's NextToken parameter. If\n the request returns all results, NextToken is set to\n null.

" + } } } }, @@ -3830,17 +3854,17 @@ "com.amazonaws.cloudformation#ListStacksOutput": { "type": "structure", "members": { - "StackSummaries": { - "target": "com.amazonaws.cloudformation#StackSummaries", - "traits": { - "smithy.api#documentation": "

A list of StackSummary structures containing information about the\n specified stacks.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of stacks.\n If no additional page exists, this value is null.

" } + }, + "StackSummaries": { + "target": "com.amazonaws.cloudformation#StackSummaries", + "traits": { + "smithy.api#documentation": "

A list of StackSummary structures containing information about the\n specified stacks.

" + } } }, "traits": { @@ -3873,10 +3897,10 @@ "com.amazonaws.cloudformation#ListTypeRegistrationsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", + "MaxResults": { + "target": "com.amazonaws.cloudformation#MaxResults", "traits": { - "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" } }, "TypeArn": { @@ -3891,10 +3915,10 @@ "smithy.api#documentation": "

The kind of type.

\n

Currently the only valid value is RESOURCE.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } }, - "RegistrationStatusFilter": { - "target": "com.amazonaws.cloudformation#RegistrationStatus", + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

The current status of the type registration request.

\n

The default is IN_PROGRESS.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" } }, "TypeName": { @@ -3903,10 +3927,10 @@ "smithy.api#documentation": "

The name of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } }, - "MaxResults": { - "target": "com.amazonaws.cloudformation#MaxResults", + "RegistrationStatusFilter": { + "target": "com.amazonaws.cloudformation#RegistrationStatus", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + "smithy.api#documentation": "

The current status of the type registration request.

\n

The default is IN_PROGRESS.

" } } } @@ -3914,17 +3938,17 @@ "com.amazonaws.cloudformation#ListTypeRegistrationsOutput": { "type": "structure", "members": { - "RegistrationTokenList": { - "target": "com.amazonaws.cloudformation#RegistrationTokenList", - "traits": { - "smithy.api#documentation": "

A list of type registration tokens.

\n

Use \n DescribeTypeRegistration\n to return detailed information about a type registration request.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

" } + }, + "RegistrationTokenList": { + "target": "com.amazonaws.cloudformation#RegistrationTokenList", + "traits": { + "smithy.api#documentation": "

A list of type registration tokens.

\n

Use \n DescribeTypeRegistration\n to return detailed information about a type registration request.

" + } } } }, @@ -3954,10 +3978,10 @@ "com.amazonaws.cloudformation#ListTypeVersionsInput": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#PrivateTypeArn", + "DeprecatedStatus": { + "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The deprecation status of the type versions that you want to get summary information about.

\n

Valid values include:

\n \n

The default is LIVE.

" } }, "TypeName": { @@ -3966,10 +3990,16 @@ "smithy.api#documentation": "

The name of the type for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } }, - "DeprecatedStatus": { - "target": "com.amazonaws.cloudformation#DeprecatedStatus", + "Arn": { + "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The deprecation status of the type versions that you want to get summary information about.

\n

Valid values include:

\n \n

The default is LIVE.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" } }, "Type": { @@ -3983,12 +4013,6 @@ "traits": { "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" } - }, - "MaxResults": { - "target": "com.amazonaws.cloudformation#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" - } } } }, @@ -4035,16 +4059,16 @@ "com.amazonaws.cloudformation#ListTypesInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", + "Visibility": { + "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

The scope at which the type is visible and usable in CloudFormation operations.

\n

Valid values include:

\n \n

The default is PRIVATE.

" } }, - "ProvisioningType": { - "target": "com.amazonaws.cloudformation#ProvisioningType", + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

\n " + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" } }, "MaxResults": { @@ -4059,10 +4083,10 @@ "smithy.api#documentation": "

The deprecation status of the types that you want to get summary information about.

\n

Valid values include:

\n " } }, - "Visibility": { - "target": "com.amazonaws.cloudformation#Visibility", + "ProvisioningType": { + "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "

The scope at which the type is visible and usable in CloudFormation operations.

\n

Valid values include:

\n \n

The default is PRIVATE.

" + "smithy.api#documentation": "

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

\n " } } } @@ -4070,17 +4094,17 @@ "com.amazonaws.cloudformation#ListTypesOutput": { "type": "structure", "members": { - "TypeSummaries": { - "target": "com.amazonaws.cloudformation#TypeSummaries", - "traits": { - "smithy.api#documentation": "

A list of TypeSummary structures that contain information about the specified types.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

" } + }, + "TypeSummaries": { + "target": "com.amazonaws.cloudformation#TypeSummaries", + "traits": { + "smithy.api#documentation": "

A list of TypeSummary structures that contain information about the specified types.

" + } } } }, @@ -4334,29 +4358,29 @@ "com.amazonaws.cloudformation#Output": { "type": "structure", "members": { + "ExportName": { + "target": "com.amazonaws.cloudformation#ExportName", + "traits": { + "smithy.api#documentation": "

The name of the export associated with the output.

" + } + }, "OutputValue": { "target": "com.amazonaws.cloudformation#OutputValue", "traits": { "smithy.api#documentation": "

The value associated with the output.

" } }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "

User defined description associated with the output.

" + } + }, "OutputKey": { "target": "com.amazonaws.cloudformation#OutputKey", "traits": { "smithy.api#documentation": "

The key associated with the output.

" } - }, - "ExportName": { - "target": "com.amazonaws.cloudformation#ExportName", - "traits": { - "smithy.api#documentation": "

The name of the export associated with the output.

" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "

User defined description associated with the output.

" - } } }, "traits": { @@ -4378,12 +4402,6 @@ "com.amazonaws.cloudformation#Parameter": { "type": "structure", "members": { - "ParameterKey": { - "target": "com.amazonaws.cloudformation#ParameterKey", - "traits": { - "smithy.api#documentation": "

The key associated with the parameter. If you don't specify a key and value for a\n particular parameter, AWS CloudFormation uses the default value that is specified in your\n template.

" - } - }, "ResolvedValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { @@ -4396,6 +4414,12 @@ "smithy.api#documentation": "

The input value associated with the parameter.

" } }, + "ParameterKey": { + "target": "com.amazonaws.cloudformation#ParameterKey", + "traits": { + "smithy.api#documentation": "

The key associated with the parameter. If you don't specify a key and value for a\n particular parameter, AWS CloudFormation uses the default value that is specified in your\n template.

" + } + }, "UsePreviousValue": { "target": "com.amazonaws.cloudformation#UsePreviousValue", "traits": { @@ -4424,10 +4448,10 @@ "com.amazonaws.cloudformation#ParameterDeclaration": { "type": "structure", "members": { - "ParameterConstraints": { - "target": "com.amazonaws.cloudformation#ParameterConstraints", + "ParameterType": { + "target": "com.amazonaws.cloudformation#ParameterType", "traits": { - "smithy.api#documentation": "

The criteria that AWS CloudFormation uses to validate parameter values.

" + "smithy.api#documentation": "

The type of parameter.

" } }, "Description": { @@ -4436,10 +4460,10 @@ "smithy.api#documentation": "

The description that is associate with the parameter.

" } }, - "ParameterType": { - "target": "com.amazonaws.cloudformation#ParameterType", + "ParameterKey": { + "target": "com.amazonaws.cloudformation#ParameterKey", "traits": { - "smithy.api#documentation": "

The type of parameter.

" + "smithy.api#documentation": "

The name that is associated with the parameter.

" } }, "NoEcho": { @@ -4448,16 +4472,16 @@ "smithy.api#documentation": "

Flag that indicates whether the parameter value is shown as plain text in logs and in\n the AWS Management Console.

" } }, - "DefaultValue": { - "target": "com.amazonaws.cloudformation#ParameterValue", + "ParameterConstraints": { + "target": "com.amazonaws.cloudformation#ParameterConstraints", "traits": { - "smithy.api#documentation": "

The default value of the parameter.

" + "smithy.api#documentation": "

The criteria that AWS CloudFormation uses to validate parameter values.

" } }, - "ParameterKey": { - "target": "com.amazonaws.cloudformation#ParameterKey", + "DefaultValue": { + "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { - "smithy.api#documentation": "

The name that is associated with the parameter.

" + "smithy.api#documentation": "

The default value of the parameter.

" } } }, @@ -4517,17 +4541,17 @@ "com.amazonaws.cloudformation#PhysicalResourceIdContextKeyValuePair": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.cloudformation#Value", + "Key": { + "target": "com.amazonaws.cloudformation#Key", "traits": { - "smithy.api#documentation": "

The resource context value.

", + "smithy.api#documentation": "

The resource context key.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.cloudformation#Key", + "Value": { + "target": "com.amazonaws.cloudformation#Value", "traits": { - "smithy.api#documentation": "

The resource context key.

", + "smithy.api#documentation": "

The resource context value.

", "smithy.api#required": {} } } @@ -4552,31 +4576,31 @@ "com.amazonaws.cloudformation#PropertyDifference": { "type": "structure", "members": { - "PropertyPath": { - "target": "com.amazonaws.cloudformation#PropertyPath", + "ActualValue": { + "target": "com.amazonaws.cloudformation#PropertyValue", "traits": { - "smithy.api#documentation": "

The fully-qualified path to the resource property.

", + "smithy.api#documentation": "

The actual property value of the resource property.

", "smithy.api#required": {} } }, - "ExpectedValue": { - "target": "com.amazonaws.cloudformation#PropertyValue", + "DifferenceType": { + "target": "com.amazonaws.cloudformation#DifferenceType", "traits": { - "smithy.api#documentation": "

The expected property value of the resource property, as defined in the stack\n template and any values specified as template parameters.

", + "smithy.api#documentation": "

The type of property difference.

\n ", "smithy.api#required": {} } }, - "ActualValue": { - "target": "com.amazonaws.cloudformation#PropertyValue", + "PropertyPath": { + "target": "com.amazonaws.cloudformation#PropertyPath", "traits": { - "smithy.api#documentation": "

The actual property value of the resource property.

", + "smithy.api#documentation": "

The fully-qualified path to the resource property.

", "smithy.api#required": {} } }, - "DifferenceType": { - "target": "com.amazonaws.cloudformation#DifferenceType", + "ExpectedValue": { + "target": "com.amazonaws.cloudformation#PropertyValue", "traits": { - "smithy.api#documentation": "

The type of property difference.

\n ", + "smithy.api#documentation": "

The expected property value of the resource property, as defined in the stack\n template and any values specified as template parameters.

", "smithy.api#required": {} } } @@ -4643,46 +4667,46 @@ "com.amazonaws.cloudformation#RecordHandlerProgressInput": { "type": "structure", "members": { - "BearerToken": { - "target": "com.amazonaws.cloudformation#ClientToken", + "OperationStatus": { + "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

", "smithy.api#required": {} } }, - "CurrentOperationStatus": { - "target": "com.amazonaws.cloudformation#OperationStatus", + "StatusMessage": { + "target": "com.amazonaws.cloudformation#StatusMessage", "traits": { "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" } }, - "ErrorCode": { - "target": "com.amazonaws.cloudformation#HandlerErrorCode", + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", + "ResourceModel": { + "target": "com.amazonaws.cloudformation#ResourceModel", "traits": { "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" } }, - "OperationStatus": { + "CurrentOperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" } }, - "ResourceModel": { - "target": "com.amazonaws.cloudformation#ResourceModel", + "BearerToken": { + "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" + "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

", + "smithy.api#required": {} } }, - "StatusMessage": { - "target": "com.amazonaws.cloudformation#StatusMessage", + "ErrorCode": { + "target": "com.amazonaws.cloudformation#HandlerErrorCode", "traits": { "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" } @@ -4726,16 +4750,11 @@ "com.amazonaws.cloudformation#RegisterTypeInput": { "type": "structure", "members": { - "ExecutionRoleArn": { - "target": "com.amazonaws.cloudformation#RoleARN2", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider. If your resource type calls AWS APIs in any of its handlers, you must create an\n \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource provider handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource provider handler, thereby supplying your resource provider with the appropriate credentials.

" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#RequestToken", + "SchemaHandlerPackage": { + "target": "com.amazonaws.cloudformation#S3Url", "traits": { - "smithy.api#documentation": "

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of a type from the same registeration request, even if the request is submitted multiple times.

" + "smithy.api#documentation": "

A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.

\n

For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.

\n \n

As part of registering a resource provider type, CloudFormation must be able to access the S3\n bucket which contains the schema handler package for that resource provider. For\n more information, see IAM Permissions for Registering a Resource Provider in the\n AWS CloudFormation User Guide.

\n ", + "smithy.api#required": {} } }, "TypeName": { @@ -4745,10 +4764,16 @@ "smithy.api#required": {} } }, - "LoggingConfig": { - "target": "com.amazonaws.cloudformation#LoggingConfig", + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#RequestToken", "traits": { - "smithy.api#documentation": "

Specifies logging configuration information for a type.

" + "smithy.api#documentation": "

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of a type from the same registeration request, even if the request is submitted multiple times.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.cloudformation#RoleARN2", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider. If your resource type calls AWS APIs in any of its handlers, you must create an\n \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource provider handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource provider handler, thereby supplying your resource provider with the appropriate credentials.

" } }, "Type": { @@ -4757,11 +4782,10 @@ "smithy.api#documentation": "

The kind of type.

\n

Currently, the only valid value is RESOURCE.

" } }, - "SchemaHandlerPackage": { - "target": "com.amazonaws.cloudformation#S3Url", + "LoggingConfig": { + "target": "com.amazonaws.cloudformation#LoggingConfig", "traits": { - "smithy.api#documentation": "

A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.

\n

For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.

\n \n

As part of registering a resource provider type, CloudFormation must be able to access the S3\n bucket which contains the schema handler package for that resource provider. For\n more information, see IAM Permissions for Registering a Resource Provider in the\n AWS CloudFormation User Guide.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies logging configuration information for a type.

" } } } @@ -4901,16 +4925,10 @@ "com.amazonaws.cloudformation#ResourceChange": { "type": "structure", "members": { - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "

The resource's physical ID (resource name). Resources that you are adding don't have\n physical IDs because they haven't been created.

" - } - }, - "Replacement": { - "target": "com.amazonaws.cloudformation#Replacement", + "Scope": { + "target": "com.amazonaws.cloudformation#Scope", "traits": { - "smithy.api#documentation": "

For the Modify action, indicates whether AWS CloudFormation will replace\n the resource by creating a new one and deleting the old one. This value depends on the\n value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the\n RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always\n and the Evaluation field is Dynamic, Replacement is\n Conditionally.

\n

If you have multiple changes with different RequiresRecreation values,\n the Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact,\n followed by Conditionally, and then Never.

" + "smithy.api#documentation": "

For the Modify action, indicates which resource attribute is triggering\n this update, such as a change in the resource attribute's Metadata,\n Properties, or Tags.

" } }, "Action": { @@ -4925,10 +4943,16 @@ "smithy.api#documentation": "

The type of AWS CloudFormation resource, such as\n AWS::S3::Bucket.

" } }, - "Scope": { - "target": "com.amazonaws.cloudformation#Scope", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

For the Modify action, indicates which resource attribute is triggering\n this update, such as a change in the resource attribute's Metadata,\n Properties, or Tags.

" + "smithy.api#documentation": "

The resource's logical ID, which is defined in the stack's template.

" + } + }, + "Replacement": { + "target": "com.amazonaws.cloudformation#Replacement", + "traits": { + "smithy.api#documentation": "

For the Modify action, indicates whether AWS CloudFormation will replace\n the resource by creating a new one and deleting the old one. This value depends on the\n value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the\n RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always\n and the Evaluation field is Dynamic, Replacement is\n Conditionally.

\n

If you have multiple changes with different RequiresRecreation values,\n the Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact,\n followed by Conditionally, and then Never.

" } }, "Details": { @@ -4937,10 +4961,10 @@ "smithy.api#documentation": "

For the Modify action, a list of ResourceChangeDetail\n structures that describes the changes that AWS CloudFormation will make to the resource.\n

" } }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

The resource's logical ID, which is defined in the stack's template.

" + "smithy.api#documentation": "

The resource's physical ID (resource name). Resources that you are adding don't have\n physical IDs because they haven't been created.

" } } }, @@ -4951,18 +4975,6 @@ "com.amazonaws.cloudformation#ResourceChangeDetail": { "type": "structure", "members": { - "ChangeSource": { - "target": "com.amazonaws.cloudformation#ChangeSource", - "traits": { - "smithy.api#documentation": "

The group to which the CausingEntity value belongs. There are five\n entity groups:

\n " - } - }, - "CausingEntity": { - "target": "com.amazonaws.cloudformation#CausingEntity", - "traits": { - "smithy.api#documentation": "

The identity of the entity that triggered this change. This entity is a member of the\n group that is specified by the ChangeSource field. For example, if you\n modified the value of the KeyPairName parameter, the\n CausingEntity is the name of the parameter\n (KeyPairName).

\n

If the ChangeSource value is DirectModification, no value\n is given for CausingEntity.

" - } - }, "Target": { "target": "com.amazonaws.cloudformation#ResourceTargetDefinition", "traits": { @@ -4974,6 +4986,18 @@ "traits": { "smithy.api#documentation": "

Indicates whether AWS CloudFormation can determine the target value, and whether the\n target value will change before you execute a change set.

\n

For Static evaluations, AWS CloudFormation can determine that the target\n value will change, and its value. For example, if you directly modify the\n InstanceType property of an EC2 instance, AWS CloudFormation knows that\n this property value will change, and its value, so this is a Static\n evaluation.

\n

For Dynamic evaluations, cannot determine the target value because it\n depends on the result of an intrinsic function, such as a Ref or\n Fn::GetAtt intrinsic function, when the stack is updated. For example, if\n your template includes a reference to a resource that is conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the\n resource is recreated. If the resource is recreated, it will have a new physical ID, so all\n references to that resource will also be updated.

" } + }, + "ChangeSource": { + "target": "com.amazonaws.cloudformation#ChangeSource", + "traits": { + "smithy.api#documentation": "

The group to which the CausingEntity value belongs. There are five\n entity groups:

\n " + } + }, + "CausingEntity": { + "target": "com.amazonaws.cloudformation#CausingEntity", + "traits": { + "smithy.api#documentation": "

The identity of the entity that triggered this change. This entity is a member of the\n group that is specified by the ChangeSource field. For example, if you\n modified the value of the KeyPairName parameter, the\n CausingEntity is the name of the parameter\n (KeyPairName).

\n

If the ChangeSource value is DirectModification, no value\n is given for CausingEntity.

" + } } }, "traits": { @@ -5028,12 +5052,6 @@ "com.amazonaws.cloudformation#ResourceIdentifierSummary": { "type": "structure", "members": { - "LogicalResourceIds": { - "target": "com.amazonaws.cloudformation#LogicalResourceIds", - "traits": { - "smithy.api#documentation": "

The logical IDs of the target resources of the specified ResourceType, as\n defined in the import template.

" - } - }, "ResourceIdentifiers": { "target": "com.amazonaws.cloudformation#ResourceIdentifiers", "traits": { @@ -5045,6 +5063,12 @@ "traits": { "smithy.api#documentation": "

The template resource type of the target resources, such as\n AWS::S3::Bucket.

" } + }, + "LogicalResourceIds": { + "target": "com.amazonaws.cloudformation#LogicalResourceIds", + "traits": { + "smithy.api#documentation": "

The logical IDs of the target resources of the specified ResourceType, as\n defined in the import template.

" + } } }, "traits": { @@ -5196,6 +5220,13 @@ "com.amazonaws.cloudformation#ResourceToImport": { "type": "structure", "members": { + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the AWS CloudFormation User Guide.

", + "smithy.api#required": {} + } + }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { @@ -5209,13 +5240,6 @@ "smithy.api#documentation": "

A key-value pair that identifies the target resource. The key is an identifier property\n (for example, BucketName for AWS::S3::Bucket resources) and the\n value is the actual property value (for example, MyS3Bucket).

", "smithy.api#required": {} } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the AWS CloudFormation User Guide.

", - "smithy.api#required": {} - } } }, "traits": { @@ -5304,17 +5328,17 @@ "com.amazonaws.cloudformation#RollbackConfiguration": { "type": "structure", "members": { - "RollbackTriggers": { - "target": "com.amazonaws.cloudformation#RollbackTriggers", - "traits": { - "smithy.api#documentation": "

The triggers to monitor during stack creation or update actions.

\n

By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them\n to any subsequent update operations for the stack, unless you specify otherwise. If you do\n specify rollback triggers for this parameter, those triggers replace any list of triggers\n previously specified for the stack. This means:

\n \n

If a specified trigger is missing, the entire stack operation fails and is rolled\n back.

" - } - }, "MonitoringTimeInMinutes": { "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", "traits": { "smithy.api#documentation": "

The amount of time, in minutes, during which CloudFormation should monitor all the\n rollback triggers after the stack creation or update operation deploys all necessary\n resources.

\n

The default is 0 minutes.

\n

If you specify a monitoring period but do not specify any rollback triggers,\n CloudFormation still waits the specified period of time before cleaning up old resources\n after update operations. You can use this monitoring period to perform any manual stack\n validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

\n

If you specify 0 for this parameter, CloudFormation still monitors the specified\n rollback triggers during stack creation and update operations. Then, for update operations,\n it begins disposing of old resources immediately once the operation completes.

" } + }, + "RollbackTriggers": { + "target": "com.amazonaws.cloudformation#RollbackTriggers", + "traits": { + "smithy.api#documentation": "

The triggers to monitor during stack creation or update actions.

\n

By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them\n to any subsequent update operations for the stack, unless you specify otherwise. If you do\n specify rollback triggers for this parameter, those triggers replace any list of triggers\n previously specified for the stack. This means:

\n \n

If a specified trigger is missing, the entire stack operation fails and is rolled\n back.

" + } } }, "traits": { @@ -5324,17 +5348,17 @@ "com.amazonaws.cloudformation#RollbackTrigger": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.cloudformation#Type", + "Arn": { + "target": "com.amazonaws.cloudformation#Arn", "traits": { - "smithy.api#documentation": "

The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rollback trigger.

\n

If a specified trigger is missing, the entire stack operation fails and is rolled\n back.

", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.cloudformation#Arn", + "Type": { + "target": "com.amazonaws.cloudformation#Type", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rollback trigger.

\n

If a specified trigger is missing, the entire stack operation fails and is rolled\n back.

", + "smithy.api#documentation": "

The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

", "smithy.api#required": {} } } @@ -5382,12 +5406,6 @@ "com.amazonaws.cloudformation#SetStackPolicyInput": { "type": "structure", "members": { - "StackPolicyBody": { - "target": "com.amazonaws.cloudformation#StackPolicyBody", - "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the AWS CloudFormation User Guide. You can specify either\n the StackPolicyBody or the StackPolicyURL parameter, but not\n both.

" - } - }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { @@ -5400,8 +5418,14 @@ "smithy.api#documentation": "

The name or unique stack ID that you want to associate a policy with.

", "smithy.api#required": {} } - } - }, + }, + "StackPolicyBody": { + "target": "com.amazonaws.cloudformation#StackPolicyBody", + "traits": { + "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the AWS CloudFormation User Guide. You can specify either\n the StackPolicyBody or the StackPolicyURL parameter, but not\n both.

" + } + } + }, "traits": { "smithy.api#documentation": "

The input for the SetStackPolicy action.

" } @@ -5430,10 +5454,10 @@ "com.amazonaws.cloudformation#SetTypeDefaultVersionInput": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#PrivateTypeArn", + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The kind of type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } }, "TypeName": { @@ -5442,16 +5466,16 @@ "smithy.api#documentation": "

The name of the type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } }, - "VersionId": { - "target": "com.amazonaws.cloudformation#TypeVersionId", + "Arn": { + "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } }, - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", + "VersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The kind of type.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

" } } } @@ -5472,31 +5496,31 @@ "com.amazonaws.cloudformation#SignalResourceInput": { "type": "structure", "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "UniqueId": { + "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", "traits": { - "smithy.api#documentation": "

The stack name or unique stack ID that includes the resource that you want to\n signal.

", + "smithy.api#documentation": "

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling\n groups, specify the instance ID that you are signaling as the unique ID. If you send\n multiple signals to a single resource (such as signaling a wait condition), each signal\n requires a different unique ID.

", "smithy.api#required": {} } }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", + "Status": { + "target": "com.amazonaws.cloudformation#ResourceSignalStatus", "traits": { - "smithy.api#documentation": "

The logical ID of the resource that you want to signal. The logical ID is the name of\n the resource that given in the template.

", + "smithy.api#documentation": "

The status of the signal, which is either success or failure. A failure signal causes\n AWS CloudFormation to immediately fail the stack creation or update.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.cloudformation#ResourceSignalStatus", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

The status of the signal, which is either success or failure. A failure signal causes\n AWS CloudFormation to immediately fail the stack creation or update.

", + "smithy.api#documentation": "

The logical ID of the resource that you want to signal. The logical ID is the name of\n the resource that given in the template.

", "smithy.api#required": {} } }, - "UniqueId": { - "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling\n groups, specify the instance ID that you are signaling as the unique ID. If you send\n multiple signals to a single resource (such as signaling a wait condition), each signal\n requires a different unique ID.

", + "smithy.api#documentation": "

The stack name or unique stack ID that includes the resource that you want to\n signal.

", "smithy.api#required": {} } } @@ -5508,28 +5532,34 @@ "com.amazonaws.cloudformation#Stack": { "type": "structure", "members": { - "Outputs": { - "target": "com.amazonaws.cloudformation#Outputs", - "traits": { - "smithy.api#documentation": "

A list of output structures.

" - } - }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { "smithy.api#documentation": "

A list of Parameter structures.

" } }, - "RollbackConfiguration": { - "target": "com.amazonaws.cloudformation#RollbackConfiguration", + "ParentId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" } }, - "DeletionTime": { - "target": "com.amazonaws.cloudformation#DeletionTime", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The time the stack was deleted.

" + "smithy.api#documentation": "

A user-defined description associated with the stack.

" + } + }, + "RootId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" + } + }, + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackDriftInformation", + "traits": { + "smithy.api#documentation": "

Information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" } }, "RoleARN": { @@ -5538,10 +5568,17 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that is associated with the stack. During a stack operation, AWS CloudFormation uses this\n role's credentials to make calls on your behalf.

" } }, - "EnableTerminationProtection": { - "target": "com.amazonaws.cloudformation#EnableTerminationProtection", + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

Whether termination protection is enabled for the stack.

\n

For nested stacks,\n termination protection is set on the root stack and cannot be changed directly on the\n nested stack. For more information, see Protecting a Stack From Being\n Deleted in the AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

Unique identifier of the stack.

" + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "

The name associated with the stack.

", + "smithy.api#required": {} } }, "DisableRollback": { @@ -5550,6 +5587,12 @@ "smithy.api#documentation": "

Boolean to enable or disable rollback on stack creation failures:

\n " } }, + "NotificationARNs": { + "target": "com.amazonaws.cloudformation#NotificationARNs", + "traits": { + "smithy.api#documentation": "

SNS topic ARNs to which stack related events are published.

" + } + }, "CreationTime": { "target": "com.amazonaws.cloudformation#CreationTime", "traits": { @@ -5569,79 +5612,60 @@ "smithy.api#documentation": "

Success/failure message associated with the stack status.

" } }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "

The capabilities allowed in the stack.

" - } - }, - "StackStatus": { - "target": "com.amazonaws.cloudformation#StackStatus", + "ChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "

Current status of the stack.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unique ID of the change set.

" } }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

A user-defined description associated with the stack.

" + "smithy.api#documentation": "

A list of Tags that specify information about the stack.

" } }, - "RootId": { - "target": "com.amazonaws.cloudformation#StackId", + "RollbackConfiguration": { + "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" } }, - "ParentId": { - "target": "com.amazonaws.cloudformation#StackId", + "TimeoutInMinutes": { + "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

The amount of time within which stack creation should complete.

" } }, - "NotificationARNs": { - "target": "com.amazonaws.cloudformation#NotificationARNs", + "EnableTerminationProtection": { + "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { - "smithy.api#documentation": "

SNS topic ARNs to which stack related events are published.

" + "smithy.api#documentation": "

Whether termination protection is enabled for the stack.

\n

For nested stacks,\n termination protection is set on the root stack and cannot be changed directly on the\n nested stack. For more information, see Protecting a Stack From Being\n Deleted in the AWS CloudFormation User Guide.

" } }, - "ChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", + "Outputs": { + "target": "com.amazonaws.cloudformation#Outputs", "traits": { - "smithy.api#documentation": "

The unique ID of the change set.

" + "smithy.api#documentation": "

A list of output structures.

" } }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", + "DeletionTime": { + "target": "com.amazonaws.cloudformation#DeletionTime", "traits": { - "smithy.api#documentation": "

A list of Tags that specify information about the stack.

" + "smithy.api#documentation": "

The time the stack was deleted.

" } }, - "TimeoutInMinutes": { - "target": "com.amazonaws.cloudformation#TimeoutMinutes", + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The amount of time within which stack creation should complete.

" + "smithy.api#documentation": "

The capabilities allowed in the stack.

" } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "StackStatus": { + "target": "com.amazonaws.cloudformation#StackStatus", "traits": { - "smithy.api#documentation": "

The name associated with the stack.

", + "smithy.api#documentation": "

Current status of the stack.

", "smithy.api#required": {} } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "

Unique identifier of the stack.

" - } - }, - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackDriftInformation", - "traits": { - "smithy.api#documentation": "

Information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" - } } }, "traits": { @@ -5703,18 +5727,18 @@ "com.amazonaws.cloudformation#StackDriftInformationSummary": { "type": "structure", "members": { + "LastCheckTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

Most recent time when a drift detection operation was initiated on the stack, or any\n of its individual resources that support drift detection.

" + } + }, "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template\n configuration.

\n ", "smithy.api#required": {} } - }, - "LastCheckTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "

Most recent time when a drift detection operation was initiated on the stack, or any\n of its individual resources that support drift detection.

" - } } }, "traits": { @@ -5747,35 +5771,23 @@ "com.amazonaws.cloudformation#StackEvent": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

The token passed to the operation that generated this event.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" - } - }, - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", - "traits": { - "smithy.api#documentation": "

Success/failure message associated with the resource.

" - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", + "EventId": { + "target": "com.amazonaws.cloudformation#EventId", "traits": { - "smithy.api#documentation": "

The logical name of the resource specified in the template.

" + "smithy.api#documentation": "

The unique ID of this event.

", + "smithy.api#required": {} } }, - "ResourceProperties": { - "target": "com.amazonaws.cloudformation#ResourceProperties", + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { - "smithy.api#documentation": "

BLOB of the properties used to create the resource.

" + "smithy.api#documentation": "

Current status of the resource.

" } }, - "Timestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

Time the status was updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name or unique identifier associated with the physical instance of the\n resource.

" } }, "StackName": { @@ -5792,17 +5804,29 @@ "smithy.api#required": {} } }, - "EventId": { - "target": "com.amazonaws.cloudformation#EventId", + "Timestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The unique ID of this event.

", + "smithy.api#documentation": "

Time the status was updated.

", "smithy.api#required": {} } }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

Current status of the resource.

" + "smithy.api#documentation": "

The logical name of the resource specified in the template.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

The token passed to the operation that generated this event.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + } + }, + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "traits": { + "smithy.api#documentation": "

Success/failure message associated with the resource.

" } }, "ResourceType": { @@ -5811,10 +5835,10 @@ "smithy.api#documentation": "

Type of resource. (For more information, go to AWS\n Resource Types Reference in the AWS CloudFormation User Guide.)

" } }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "ResourceProperties": { + "target": "com.amazonaws.cloudformation#ResourceProperties", "traits": { - "smithy.api#documentation": "

The name or unique identifier associated with the physical instance of the\n resource.

" + "smithy.api#documentation": "

BLOB of the properties used to create the resource.

" } } }, @@ -5834,28 +5858,28 @@ "com.amazonaws.cloudformation#StackInstance": { "type": "structure", "members": { - "Region": { - "target": "com.amazonaws.cloudformation#Region", + "OrganizationalUnitId": { + "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { - "smithy.api#documentation": "

The name of the AWS Region that the stack instance is associated with.

" + "smithy.api#documentation": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" } }, - "DriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", + "Status": { + "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template\n and parameter configuration of the stack set to which it belongs.

\n " + "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated\n stack set.

\n " } }, - "ParameterOverrides": { - "target": "com.amazonaws.cloudformation#Parameters", + "StackInstanceStatus": { + "target": "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus", "traits": { - "smithy.api#documentation": "

A list of parameters from the stack set template whose values have been overridden in\n this stack instance.

" + "smithy.api#documentation": "

The detailed status of the stack instance.

" } }, - "StatusReason": { - "target": "com.amazonaws.cloudformation#Reason", + "Region": { + "target": "com.amazonaws.cloudformation#Region", "traits": { - "smithy.api#documentation": "

The explanation for the specific status code that is assigned to this stack\n instance.

" + "smithy.api#documentation": "

The name of the AWS Region that the stack instance is associated with.

" } }, "StackId": { @@ -5864,22 +5888,28 @@ "smithy.api#documentation": "

The ID of the stack instance.

" } }, - "LastDriftCheckTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "ParameterOverrides": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance on which drift\n detection has not yet been performed.

" + "smithy.api#documentation": "

A list of parameters from the stack set template whose values have been overridden in\n this stack instance.

" } }, - "Status": { - "target": "com.amazonaws.cloudformation#StackInstanceStatus", + "StatusReason": { + "target": "com.amazonaws.cloudformation#Reason", "traits": { - "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated\n stack set.

\n " + "smithy.api#documentation": "

The explanation for the specific status code that is assigned to this stack\n instance.

" } }, - "OrganizationalUnitId": { - "target": "com.amazonaws.cloudformation#OrganizationalUnitId", + "DriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" + "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template\n and parameter configuration of the stack set to which it belongs.

\n " + } + }, + "LastDriftCheckTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance on which drift\n detection has not yet been performed.

" } }, "StackSetId": { @@ -5893,12 +5923,6 @@ "traits": { "smithy.api#documentation": "

[Self-managed permissions] The name of the AWS account that the stack instance is associated with.

" } - }, - "StackInstanceStatus": { - "target": "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus", - "traits": { - "smithy.api#documentation": "

The detailed status of the stack instance.

" - } } }, "traits": { @@ -6033,16 +6057,16 @@ "com.amazonaws.cloudformation#StackInstanceSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.cloudformation#StackInstanceStatus", + "StackInstanceStatus": { + "target": "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus", "traits": { - "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated\n stack set.

\n " + "smithy.api#documentation": "

The detailed status of the stack instance.

" } }, - "StatusReason": { - "target": "com.amazonaws.cloudformation#Reason", + "Region": { + "target": "com.amazonaws.cloudformation#Region", "traits": { - "smithy.api#documentation": "

The explanation for the specific status code assigned to this stack\n instance.

" + "smithy.api#documentation": "

The name of the AWS Region that the stack instance is associated with.

" } }, "LastDriftCheckTimestamp": { @@ -6051,46 +6075,46 @@ "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance on which drift\n detection has not yet been performed.

" } }, - "OrganizationalUnitId": { - "target": "com.amazonaws.cloudformation#OrganizationalUnitId", + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" + "smithy.api#documentation": "

The ID of the stack instance.

" } }, - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", + "DriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set that the stack instance is associated\n with.

" + "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template\n and parameter configuration of the stack set to which it belongs.

\n " } }, - "Account": { - "target": "com.amazonaws.cloudformation#Account", + "OrganizationalUnitId": { + "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The name of the AWS account that the stack instance is associated with.

" + "smithy.api#documentation": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" } }, - "StackInstanceStatus": { - "target": "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus", + "Account": { + "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

The detailed status of the stack instance.

" + "smithy.api#documentation": "

[Self-managed permissions] The name of the AWS account that the stack instance is associated with.

" } }, - "DriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", "traits": { - "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template\n and parameter configuration of the stack set to which it belongs.

\n " + "smithy.api#documentation": "

The name or unique ID of the stack set that the stack instance is associated\n with.

" } }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "StatusReason": { + "target": "com.amazonaws.cloudformation#Reason", "traits": { - "smithy.api#documentation": "

The ID of the stack instance.

" + "smithy.api#documentation": "

The explanation for the specific status code assigned to this stack\n instance.

" } }, - "Region": { - "target": "com.amazonaws.cloudformation#Region", + "Status": { + "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "

The name of the AWS Region that the stack instance is associated with.

" + "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated\n stack set.

\n " } } }, @@ -6149,49 +6173,54 @@ "com.amazonaws.cloudformation#StackResource": { "type": "structure", "members": { - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { - "smithy.api#documentation": "

The logical name of the resource specified in the template.

", + "smithy.api#documentation": "

Current status of the resource.

", "smithy.api#required": {} } }, - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

Success/failure message associated with the resource.

" + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by AWS CloudFormation.

" } }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

User defined description associated with the resource.

" + "smithy.api#documentation": "

The name associated with the stack.

" } }, - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" + "smithy.api#documentation": "

Unique identifier of the stack.

" } }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by AWS CloudFormation.

" + "smithy.api#documentation": "

Type of resource. (For more information, go to AWS\n Resource Types Reference in the AWS CloudFormation User Guide.)

", + "smithy.api#required": {} } }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

Current status of the resource.

", - "smithy.api#required": {} + "smithy.api#documentation": "

User defined description associated with the resource.

" } }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { - "smithy.api#documentation": "

Type of resource. (For more information, go to AWS\n Resource Types Reference in the AWS CloudFormation User Guide.)

", - "smithy.api#required": {} + "smithy.api#documentation": "

Success/failure message associated with the resource.

" + } + }, + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", + "traits": { + "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" } }, "Timestamp": { @@ -6201,16 +6230,11 @@ "smithy.api#required": {} } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "

The name associated with the stack.

" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

Unique identifier of the stack.

" + "smithy.api#documentation": "

The logical name of the resource specified in the template.

", + "smithy.api#required": {} } } }, @@ -6221,36 +6245,36 @@ "com.amazonaws.cloudformation#StackResourceDetail": { "type": "structure", "members": { - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", + "LastUpdatedTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" + "smithy.api#documentation": "

Time the status was updated.

", + "smithy.api#required": {} } }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

Unique identifier of the stack.

" + "smithy.api#documentation": "

User defined description associated with the resource.

" } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { - "smithy.api#documentation": "

The name associated with the stack.

" + "smithy.api#documentation": "

Current status of the resource.

", + "smithy.api#required": {} } }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", "traits": { - "smithy.api#documentation": "

The logical name of the resource specified in the template.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Success/failure message associated with the resource.

" } }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "Metadata": { + "target": "com.amazonaws.cloudformation#Metadata", "traits": { - "smithy.api#documentation": "

Time the status was updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The content of the Metadata attribute declared for the resource. For\n more information, see Metadata\n Attribute in the AWS CloudFormation User Guide.

" } }, "PhysicalResourceId": { @@ -6259,16 +6283,17 @@ "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by AWS CloudFormation.

" } }, - "Metadata": { - "target": "com.amazonaws.cloudformation#Metadata", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

The content of the Metadata attribute declared for the resource. For\n more information, see Metadata\n Attribute in the AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

The logical name of the resource specified in the template.

", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", "traits": { - "smithy.api#documentation": "

User defined description associated with the resource.

" + "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" } }, "ResourceType": { @@ -6278,17 +6303,16 @@ "smithy.api#required": {} } }, - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

Success/failure message associated with the resource.

" + "smithy.api#documentation": "

Unique identifier of the stack.

" } }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

Current status of the resource.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name associated with the stack.

" } } }, @@ -6299,62 +6323,55 @@ "com.amazonaws.cloudformation#StackResourceDrift": { "type": "structure", "members": { - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "

The logical name of the resource specified in the template.

", - "smithy.api#required": {} - } - }, - "PhysicalResourceIdContext": { - "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs are not enough\n to uniquely identify that resource. Each context key-value pair specifies a unique resource\n that contains the targeted resource.

" + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by AWS CloudFormation.

" } }, - "ActualProperties": { + "ExpectedProperties": { "target": "com.amazonaws.cloudformation#Properties", "traits": { - "smithy.api#documentation": "

A JSON structure containing the actual property values of the stack\n resource.

\n

For resources whose StackResourceDriftStatus is DELETED,\n this structure will not be present.

" + "smithy.api#documentation": "

A JSON structure containing the expected property values of the stack resource, as\n defined in the stack template and any values specified as template parameters.

\n

For resources whose StackResourceDriftStatus is DELETED,\n this structure will not be present.

" } }, - "StackResourceDriftStatus": { - "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", + "Timestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected\n configuration

\n ", + "smithy.api#documentation": "

Time at which AWS CloudFormation performed drift detection on the stack resource.

", "smithy.api#required": {} } }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", + "ActualProperties": { + "target": "com.amazonaws.cloudformation#Properties", "traits": { - "smithy.api#documentation": "

The type of the resource.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A JSON structure containing the actual property values of the stack\n resource.

\n

For resources whose StackResourceDriftStatus is DELETED,\n this structure will not be present.

" } }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a\n resource supported by AWS CloudFormation.

" + "smithy.api#documentation": "

The ID of the stack.

", + "smithy.api#required": {} } }, - "Timestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "PhysicalResourceIdContext": { + "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { - "smithy.api#documentation": "

Time at which AWS CloudFormation performed drift detection on the stack resource.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs are not enough\n to uniquely identify that resource. Each context key-value pair specifies a unique resource\n that contains the targeted resource.

" } }, - "ExpectedProperties": { - "target": "com.amazonaws.cloudformation#Properties", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

A JSON structure containing the expected property values of the stack resource, as\n defined in the stack template and any values specified as template parameters.

\n

For resources whose StackResourceDriftStatus is DELETED,\n this structure will not be present.

" + "smithy.api#documentation": "

The logical name of the resource specified in the template.

", + "smithy.api#required": {} } }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

The ID of the stack.

", + "smithy.api#documentation": "

The type of the resource.

", "smithy.api#required": {} } }, @@ -6363,6 +6380,13 @@ "traits": { "smithy.api#documentation": "

A collection of the resource properties whose actual values differ from their\n expected values. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED.\n

" } + }, + "StackResourceDriftStatus": { + "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", + "traits": { + "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected\n configuration

\n ", + "smithy.api#required": {} + } } }, "traits": { @@ -6393,18 +6417,18 @@ "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { "type": "structure", "members": { - "LastCheckTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "

When AWS CloudFormation last checked if the resource had drifted from its expected\n configuration.

" - } - }, "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected\n configuration

\n ", "smithy.api#required": {} } + }, + "LastCheckTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

When AWS CloudFormation last checked if the resource had drifted from its expected\n configuration.

" + } } }, "traits": { @@ -6461,29 +6485,16 @@ "com.amazonaws.cloudformation#StackResourceSummary": { "type": "structure", "members": { - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", - "traits": { - "smithy.api#documentation": "

Success/failure message associated with the resource.

" - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "

The logical name of the resource specified in the template.

", - "smithy.api#required": {} - } - }, "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of the\n resource.

" } }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", "traits": { - "smithy.api#documentation": "

Time the status was updated.

", + "smithy.api#documentation": "

Current status of the resource.

", "smithy.api#required": {} } }, @@ -6494,16 +6505,29 @@ "smithy.api#required": {} } }, + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "traits": { + "smithy.api#documentation": "

Success/failure message associated with the resource.

" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

Time the status was updated.

", + "smithy.api#required": {} + } + }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformationSummary", "traits": { "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" } }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

Current status of the resource.

", + "smithy.api#documentation": "

The logical name of the resource specified in the template.

", "smithy.api#required": {} } } @@ -6521,64 +6545,34 @@ "com.amazonaws.cloudformation#StackSet": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.cloudformation#StackSetStatus", - "traits": { - "smithy.api#documentation": "

The status of the stack set.

" - } - }, - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "

The name that's associated with the stack set.

" - } - }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { "smithy.api#documentation": "

The name of the IAM execution role used to create or update the stack set.

\n

Use customized execution roles to control which stack resources users and groups can\n include in their stack sets.\n

" } }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "

A description of the stack set that you specify when the stack set is created or\n updated.

" - } - }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the IAM role used to create or update the stack\n set.

\n

Use customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the AWS CloudFormation User Guide.

" } }, - "OrganizationalUnitIds": { - "target": "com.amazonaws.cloudformation#OrganizationalUnitIdList", - "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" - } - }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { "smithy.api#documentation": "

A list of tags that specify information about the stack set. A maximum number of 50\n tags can be specified.

" } }, - "StackSetDriftDetectionDetails": { - "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", - "traits": { - "smithy.api#documentation": "

Detailed information about the drift status of the stack set.

\n

For stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations currently in\n progress is not included.

" - } - }, - "PermissionModel": { - "target": "com.amazonaws.cloudformation#PermissionModels", + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created.

\n " + "smithy.api#documentation": "

The name that's associated with the stack set.

" } }, - "AutoDeployment": { - "target": "com.amazonaws.cloudformation#AutoDeployment", + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

" + "smithy.api#documentation": "

A list of input parameters for a stack set.

" } }, "StackSetId": { @@ -6587,10 +6581,16 @@ "smithy.api#documentation": "

The ID of the stack set.

" } }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The capabilities that are allowed in the stack set. Some stack set templates might\n include resources that can affect permissions in your AWS account—for example, by creating\n new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.\n

" + "smithy.api#documentation": "

A description of the stack set that you specify when the stack set is created or\n updated.

" + } + }, + "AutoDeployment": { + "target": "com.amazonaws.cloudformation#AutoDeployment", + "traits": { + "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

" } }, "StackSetARN": { @@ -6599,10 +6599,10 @@ "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the stack set.

" } }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

A list of input parameters for a stack set.

" + "smithy.api#documentation": "

The capabilities that are allowed in the stack set. Some stack set templates might\n include resources that can affect permissions in your AWS account—for example, by creating\n new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.\n

" } }, "TemplateBody": { @@ -6610,6 +6610,30 @@ "traits": { "smithy.api#documentation": "

The structure that contains the body of the template that was used to create or\n update the stack set.

" } + }, + "OrganizationalUnitIds": { + "target": "com.amazonaws.cloudformation#OrganizationalUnitIdList", + "traits": { + "smithy.api#documentation": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" + } + }, + "PermissionModel": { + "target": "com.amazonaws.cloudformation#PermissionModels", + "traits": { + "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created.

\n " + } + }, + "StackSetDriftDetectionDetails": { + "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", + "traits": { + "smithy.api#documentation": "

Detailed information about the drift status of the stack set.

\n

For stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations currently in\n progress is not included.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#StackSetStatus", + "traits": { + "smithy.api#documentation": "

The status of the stack set.

" + } } }, "traits": { @@ -6622,16 +6646,10 @@ "com.amazonaws.cloudformation#StackSetDriftDetectionDetails": { "type": "structure", "members": { - "TotalStackInstancesCount": { - "target": "com.amazonaws.cloudformation#TotalStackInstancesCount", - "traits": { - "smithy.api#documentation": "

The total number of stack instances belonging to this stack set.

\n

The total number of stack instances is equal to the total of:

\n " - } - }, - "DriftedStackInstancesCount": { - "target": "com.amazonaws.cloudformation#DriftedStackInstancesCount", + "DriftDetectionStatus": { + "target": "com.amazonaws.cloudformation#StackSetDriftDetectionStatus", "traits": { - "smithy.api#documentation": "

The number of stack instances that have drifted from the expected template and parameter\n configuration of the stack set. A stack instance is considered to have drifted if one or\n more of the resources in the associated stack do not match their expected\n configuration.

" + "smithy.api#documentation": "

The status of the stack set drift detection operation.

\n " } }, "InSyncStackInstancesCount": { @@ -6640,16 +6658,10 @@ "smithy.api#documentation": "

The number of stack instances which match the expected template and parameter\n configuration of the stack set.

" } }, - "DriftDetectionStatus": { - "target": "com.amazonaws.cloudformation#StackSetDriftDetectionStatus", - "traits": { - "smithy.api#documentation": "

The status of the stack set drift detection operation.

\n " - } - }, - "DriftStatus": { - "target": "com.amazonaws.cloudformation#StackSetDriftStatus", + "TotalStackInstancesCount": { + "target": "com.amazonaws.cloudformation#TotalStackInstancesCount", "traits": { - "smithy.api#documentation": "

Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its\n stack instances have drifted from their expected template and parameter\n configuration.

\n " + "smithy.api#documentation": "

The total number of stack instances belonging to this stack set.

\n

The total number of stack instances is equal to the total of:

\n " } }, "InProgressStackInstancesCount": { @@ -6658,10 +6670,10 @@ "smithy.api#documentation": "

The number of stack instances that are currently being checked for drift.

" } }, - "FailedStackInstancesCount": { - "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", + "DriftedStackInstancesCount": { + "target": "com.amazonaws.cloudformation#DriftedStackInstancesCount", "traits": { - "smithy.api#documentation": "

The number of stack instances for which the drift detection operation failed.

" + "smithy.api#documentation": "

The number of stack instances that have drifted from the expected template and parameter\n configuration of the stack set. A stack instance is considered to have drifted if one or\n more of the resources in the associated stack do not match their expected\n configuration.

" } }, "LastDriftCheckTimestamp": { @@ -6669,6 +6681,18 @@ "traits": { "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n set. This value will be NULL for any stack set on which drift detection has\n not yet been performed.

" } + }, + "DriftStatus": { + "target": "com.amazonaws.cloudformation#StackSetDriftStatus", + "traits": { + "smithy.api#documentation": "

Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its\n stack instances have drifted from their expected template and parameter\n configuration.

\n " + } + }, + "FailedStackInstancesCount": { + "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", + "traits": { + "smithy.api#documentation": "

The number of stack instances for which the drift detection operation failed.

" + } } }, "traits": { @@ -6762,28 +6786,16 @@ "com.amazonaws.cloudformation#StackSetOperation": { "type": "structure", "members": { - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "

The ID of the stack set.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#StackSetOperationStatus", - "traits": { - "smithy.api#documentation": "

The status of the operation.

\n " - } - }, - "RetainStacks": { - "target": "com.amazonaws.cloudformation#RetainStacksNullable", + "AdministrationRoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

For stack set operations of action type DELETE, specifies whether to\n remove the stack instances from the specified stack set, but doesn't delete the stacks. You\n can't reassociate a retained stack, or add an existing, saved stack to a new stack\n set.

" + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the IAM role used to perform this stack set\n operation.

\n

Use customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the AWS CloudFormation User Guide.

" } }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "ExecutionRoleName": { + "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The preferences for how AWS CloudFormation performs this stack set\n operation.

" + "smithy.api#documentation": "

The name of the IAM execution role used to create or update the stack set.

\n

Use customized execution roles to control which stack resources users and groups can\n include in their stack sets.\n

" } }, "EndTimestamp": { @@ -6798,28 +6810,40 @@ "smithy.api#documentation": "

[Service-managed permissions] The AWS Organizations accounts affected by the stack operation.

" } }, - "ExecutionRoleName": { - "target": "com.amazonaws.cloudformation#ExecutionRoleName", - "traits": { - "smithy.api#documentation": "

The name of the IAM execution role used to create or update the stack set.

\n

Use customized execution roles to control which stack resources users and groups can\n include in their stack sets.\n

" - } - }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "

The unique ID of a stack set operation.

" } }, + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "

The ID of the stack set.

" + } + }, + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "traits": { + "smithy.api#documentation": "

The preferences for how AWS CloudFormation performs this stack set\n operation.

" + } + }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { "smithy.api#documentation": "

Detailed information about the drift status of the stack set. This includes information\n about drift operations currently being performed on the stack set.

\n

this information will only be present for stack set operations whose Action\n type is DETECT_DRIFT.

\n

For more information, see Detecting Unmanaged\n Changes in Stack Sets in the AWS CloudFormation User Guide.

" } }, - "Action": { - "target": "com.amazonaws.cloudformation#StackSetOperationAction", + "Status": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The type of stack set operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack set\n instances that are associated with the specified stack set. Update operations affect both\n the stack set itself, as well as all associated stack set\n instances.

" + "smithy.api#documentation": "

The status of the operation.

\n " + } + }, + "RetainStacks": { + "target": "com.amazonaws.cloudformation#RetainStacksNullable", + "traits": { + "smithy.api#documentation": "

For stack set operations of action type DELETE, specifies whether to\n remove the stack instances from the specified stack set, but doesn't delete the stacks. You\n can't reassociate a retained stack, or add an existing, saved stack to a new stack\n set.

" } }, "CreationTimestamp": { @@ -6828,10 +6852,10 @@ "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because AWS CloudFormation needs to perform preparatory work for the\n operation, such as dispatching the work to the requested Regions, before actually creating\n the first stacks.

" } }, - "AdministrationRoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", + "Action": { + "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the IAM role used to perform this stack set\n operation.

\n

Use customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

The type of stack set operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack set\n instances that are associated with the specified stack set. Update operations affect both\n the stack set itself, as well as all associated stack set\n instances.

" } } }, @@ -6867,16 +6891,10 @@ "smithy.api#documentation": "

The maximum number of accounts in which to perform this operation at one time. This\n is dependent on the value of\n FailureToleranceCount. MaxConcurrentCount is at most one more\n than the FailureToleranceCount.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

" } }, - "RegionOrder": { - "target": "com.amazonaws.cloudformation#RegionList", - "traits": { - "smithy.api#documentation": "

The order of the Regions in where you want to perform the stack operation.

" - } - }, - "FailureToleranceCount": { - "target": "com.amazonaws.cloudformation#FailureToleranceCount", + "MaxConcurrentPercentage": { + "target": "com.amazonaws.cloudformation#MaxConcurrentPercentage", "traits": { - "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before AWS\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n AWS CloudFormation doesn't attempt the operation in any subsequent Regions.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).

" + "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one\n time.

\n

When calculating the number of accounts based on the specified percentage, AWS\n CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number as one\n instead.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

" } }, "FailureTolerancePercentage": { @@ -6885,10 +6903,16 @@ "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail\n before AWS CloudFormation stops the operation in that Region. If the operation is stopped\n in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent\n Regions.

\n

When calculating the number of accounts based on the specified percentage, AWS\n CloudFormation rounds down to the next whole number.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

" } }, - "MaxConcurrentPercentage": { - "target": "com.amazonaws.cloudformation#MaxConcurrentPercentage", + "FailureToleranceCount": { + "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { - "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one\n time.

\n

When calculating the number of accounts based on the specified percentage, AWS\n CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number as one\n instead.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

" + "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before AWS\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n AWS CloudFormation doesn't attempt the operation in any subsequent Regions.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).

" + } + }, + "RegionOrder": { + "target": "com.amazonaws.cloudformation#RegionList", + "traits": { + "smithy.api#documentation": "

The order of the Regions in where you want to perform the stack operation.

" } } }, @@ -6927,28 +6951,16 @@ "com.amazonaws.cloudformation#StackSetOperationResultSummary": { "type": "structure", "members": { - "AccountGateResult": { - "target": "com.amazonaws.cloudformation#AccountGateResult", - "traits": { - "smithy.api#documentation": "

The results of the account gate function AWS CloudFormation invokes, if present,\n before proceeding with stack set operations in an account

" - } - }, "StatusReason": { "target": "com.amazonaws.cloudformation#Reason", "traits": { "smithy.api#documentation": "

The reason for the assigned result status.

" } }, - "Region": { - "target": "com.amazonaws.cloudformation#Region", - "traits": { - "smithy.api#documentation": "

The name of the AWS Region for this operation result.

" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", + "AccountGateResult": { + "target": "com.amazonaws.cloudformation#AccountGateResult", "traits": { - "smithy.api#documentation": "

The result status of the stack set operation for the given account in the given\n Region.

\n " + "smithy.api#documentation": "

The results of the account gate function AWS CloudFormation invokes, if present,\n before proceeding with stack set operations in an account

" } }, "Account": { @@ -6957,11 +6969,23 @@ "smithy.api#documentation": "

[Self-managed permissions] The name of the AWS account for this operation result.

" } }, + "Status": { + "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", + "traits": { + "smithy.api#documentation": "

The result status of the stack set operation for the given account in the given\n Region.

\n " + } + }, "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" } + }, + "Region": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "

The name of the AWS Region for this operation result.

" + } } }, "traits": { @@ -7002,34 +7026,34 @@ "com.amazonaws.cloudformation#StackSetOperationSummary": { "type": "structure", "members": { + "EndTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the stack set operation ended, across all accounts and Regions\n specified. Note that this doesn't necessarily mean that the stack set operation was\n successful, or even attempted, in each account or Region.

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because AWS CloudFormation needs to perform preparatory work for the\n operation, such as dispatching the work to the requested Regions, before actually creating\n the first stacks.

" + } + }, "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { "smithy.api#documentation": "

The type of operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack\n instances that are associated with the specified stack set. Update operations affect both\n the stack set itself as well as all associated stack set\n instances.

" } }, - "Status": { - "target": "com.amazonaws.cloudformation#StackSetOperationStatus", - "traits": { - "smithy.api#documentation": "

The overall status of the operation.

\n " - } - }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#documentation": "

The unique ID of the stack set operation.

" } }, - "CreationTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because AWS CloudFormation needs to perform preparatory work for the\n operation, such as dispatching the work to the requested Regions, before actually creating\n the first stacks.

" - } - }, - "EndTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", + "Status": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The time at which the stack set operation ended, across all accounts and Regions\n specified. Note that this doesn't necessarily mean that the stack set operation was\n successful, or even attempted, in each account or Region.

" + "smithy.api#documentation": "

The overall status of the operation.

\n " } } }, @@ -7059,10 +7083,22 @@ "com.amazonaws.cloudformation#StackSetSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.cloudformation#StackSetStatus", + "LastDriftCheckTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the stack set.

" + "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n set. This value will be NULL for any stack set on which drift detection has\n not yet been performed.

" + } + }, + "DriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", + "traits": { + "smithy.api#documentation": "

Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its\n stack instances have drifted from their expected template and parameter\n configuration.

\n " + } + }, + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "

The ID of the stack set.

" } }, "AutoDeployment": { @@ -7077,34 +7113,22 @@ "smithy.api#documentation": "

A description of the stack set that you specify when the stack set is created or\n updated.

" } }, - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "

The ID of the stack set.

" - } - }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created.

\n " } }, - "LastDriftCheckTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n set. This value will be NULL for any stack set on which drift detection has\n not yet been performed.

" - } - }, "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#documentation": "

The name of the stack set.

" } }, - "DriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", + "Status": { + "target": "com.amazonaws.cloudformation#StackSetStatus", "traits": { - "smithy.api#documentation": "

Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its\n stack instances have drifted from their expected template and parameter\n configuration.

\n " + "smithy.api#documentation": "

The status of the stack set.

" } } }, @@ -7225,67 +7249,61 @@ "com.amazonaws.cloudformation#StackSummary": { "type": "structure", "members": { - "StackStatusReason": { - "target": "com.amazonaws.cloudformation#StackStatusReason", - "traits": { - "smithy.api#documentation": "

Success/Failure message associated with the stack status.

" - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", + "StackStatus": { + "target": "com.amazonaws.cloudformation#StackStatus", "traits": { - "smithy.api#documentation": "

The name associated with the stack.

", + "smithy.api#documentation": "

The current status of the stack.

", "smithy.api#required": {} } }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", + "DeletionTime": { + "target": "com.amazonaws.cloudformation#DeletionTime", "traits": { - "smithy.api#documentation": "

Unique stack identifier.

" + "smithy.api#documentation": "

The time the stack was deleted.

" } }, - "LastUpdatedTime": { - "target": "com.amazonaws.cloudformation#LastUpdatedTime", + "RootId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

The time the stack was last updated. This field will only be returned if the stack\n has been updated at least once.

" + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" } }, - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", + "ParentId": { + "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

Summarizes information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" } }, - "CreationTime": { - "target": "com.amazonaws.cloudformation#CreationTime", + "StackStatusReason": { + "target": "com.amazonaws.cloudformation#StackStatusReason", "traits": { - "smithy.api#documentation": "

The time the stack was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Success/Failure message associated with the stack status.

" } }, - "ParentId": { + "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n direct parent of this stack. For the first level of nested stacks, the root stack is also\n the parent stack.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

Unique stack identifier.

" } }, - "RootId": { - "target": "com.amazonaws.cloudformation#StackId", + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Working with Nested Stacks in the\n AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

The name associated with the stack.

", + "smithy.api#required": {} } }, - "StackStatus": { - "target": "com.amazonaws.cloudformation#StackStatus", + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", "traits": { - "smithy.api#documentation": "

The current status of the stack.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Summarizes information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.

" } }, - "DeletionTime": { - "target": "com.amazonaws.cloudformation#DeletionTime", + "CreationTime": { + "target": "com.amazonaws.cloudformation#CreationTime", "traits": { - "smithy.api#documentation": "

The time the stack was deleted.

" + "smithy.api#documentation": "

The time the stack was created.

", + "smithy.api#required": {} } }, "TemplateDescription": { @@ -7293,6 +7311,12 @@ "traits": { "smithy.api#documentation": "

The template description of the template used to create the stack.

" } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudformation#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "

The time the stack was last updated. This field will only be returned if the stack\n has been updated at least once.

" + } } }, "traits": { @@ -7382,17 +7406,17 @@ "com.amazonaws.cloudformation#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.cloudformation#TagValue", + "Key": { + "target": "com.amazonaws.cloudformation#TagKey", "traits": { - "smithy.api#documentation": "

\n Required. A string containing the value for this tag. You can specify\n a maximum of 256 characters for a tag value.

", + "smithy.api#documentation": "

\n Required. A string used to identify this tag. You can specify a\n maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the\n reserved prefix: aws:.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.cloudformation#TagKey", + "Value": { + "target": "com.amazonaws.cloudformation#TagValue", "traits": { - "smithy.api#documentation": "

\n Required. A string used to identify this tag. You can specify a\n maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the\n reserved prefix: aws:.

", + "smithy.api#documentation": "

\n Required. A string containing the value for this tag. You can specify\n a maximum of 256 characters for a tag value.

", "smithy.api#required": {} } } @@ -7445,10 +7469,10 @@ "com.amazonaws.cloudformation#TemplateParameter": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "NoEcho": { + "target": "com.amazonaws.cloudformation#NoEcho", "traits": { - "smithy.api#documentation": "

User defined description associated with the parameter.

" + "smithy.api#documentation": "

Flag indicating whether the parameter should be displayed as plain text in logs and\n UIs.

" } }, "ParameterKey": { @@ -7457,17 +7481,17 @@ "smithy.api#documentation": "

The name associated with the parameter.

" } }, - "NoEcho": { - "target": "com.amazonaws.cloudformation#NoEcho", - "traits": { - "smithy.api#documentation": "

Flag indicating whether the parameter should be displayed as plain text in logs and\n UIs.

" - } - }, "DefaultValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { "smithy.api#documentation": "

The default value associated with the parameter.

" } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "

User defined description associated with the parameter.

" + } } }, "traits": { @@ -7600,16 +7624,10 @@ "com.amazonaws.cloudformation#TypeSummary": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "

The kind of type.

" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", + "DefaultVersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The name of the type.

" + "smithy.api#documentation": "

The ID of the default version of the type. The default version is used when the type version is not specified.

\n

To set the default version of a type, use \n SetTypeDefaultVersion\n .

" } }, "Description": { @@ -7618,16 +7636,16 @@ "smithy.api#documentation": "

The description of the type.

" } }, - "DefaultVersionId": { - "target": "com.amazonaws.cloudformation#TypeVersionId", + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The ID of the default version of the type. The default version is used when the type version is not specified.

\n

To set the default version of a type, use \n SetTypeDefaultVersion\n .

" + "smithy.api#documentation": "

The name of the type.

" } }, - "LastUpdated": { - "target": "com.amazonaws.cloudformation#Timestamp", + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

When the current default version of the type was registered.

" + "smithy.api#documentation": "

The kind of type.

" } }, "TypeArn": { @@ -7635,6 +7653,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type.

" } + }, + "LastUpdated": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

When the current default version of the type was registered.

" + } } }, "traits": { @@ -7660,16 +7684,16 @@ "com.amazonaws.cloudformation#TypeVersionSummary": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#TypeArn", + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type version.

" + "smithy.api#documentation": "

The kind of type.

" } }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", + "IsDefaultVersion": { + "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

The name of the type.

" + "smithy.api#documentation": "

Whether the specified type version is set as the default version.

" } }, "Description": { @@ -7678,28 +7702,28 @@ "smithy.api#documentation": "

The description of the type version.

" } }, - "VersionId": { - "target": "com.amazonaws.cloudformation#TypeVersionId", + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

" + "smithy.api#documentation": "

The name of the type.

" } }, - "TimeCreated": { - "target": "com.amazonaws.cloudformation#Timestamp", + "Arn": { + "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

When the version was registered.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type version.

" } }, - "IsDefaultVersion": { - "target": "com.amazonaws.cloudformation#IsDefaultVersion", + "VersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

Whether the specified type version is set as the default version.

" + "smithy.api#documentation": "

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

" } }, - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", + "TimeCreated": { + "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The kind of type.

" + "smithy.api#documentation": "

When the version was registered.

" } } }, @@ -7729,44 +7753,7 @@ }, "com.amazonaws.cloudformation#UpdateStackInput": { "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "

The name or unique stack ID of the stack to update.

", - "smithy.api#required": {} - } - }, - "StackPolicyDuringUpdateURL": { - "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", - "traits": { - "smithy.api#documentation": "

Location of a file containing the temporary overriding stack policy. The URL must\n point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack.\n You can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack\n policy during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.

" - } - }, - "StackPolicyBody": { - "target": "com.amazonaws.cloudformation#StackPolicyBody", - "traits": { - "smithy.api#documentation": "

Structure containing a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.

\n

You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.

" - } - }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. (For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.)

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" - } - }, - "ResourceTypes": { - "target": "com.amazonaws.cloudformation#ResourceTypes", - "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with for this update\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource that you're updating, the\n stack update fails. By default, AWS CloudFormation grants permissions to all resource\n types. AWS Identity and Access Management (IAM) uses this parameter for AWS\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" - } - }, - "RollbackConfiguration": { - "target": "com.amazonaws.cloudformation#RollbackConfiguration", - "traits": { - "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" - } - }, + "members": { "UsePreviousTemplate": { "target": "com.amazonaws.cloudformation#UsePreviousTemplate", "traits": { @@ -7779,28 +7766,41 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role\n that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's\n credentials to make calls on your behalf. AWS CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n AWS CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, AWS CloudFormation uses the role that was previously\n associated with the stack. If no role is available, AWS CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, + "StackPolicyURL": { + "target": "com.amazonaws.cloudformation#StackPolicyURL", + "traits": { + "smithy.api#documentation": "

Location of a file containing the updated stack policy. The URL must point to a\n policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.

" + } + }, + "NotificationARNs": { + "target": "com.amazonaws.cloudformation#NotificationARNs", + "traits": { + "smithy.api#documentation": "

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS\n CloudFormation associates with the stack. Specify an empty list to remove all notification\n topics.

" + } + }, "StackPolicyDuringUpdateBody": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateBody", "traits": { "smithy.api#documentation": "

Structure containing the temporary overriding stack policy body. You can specify\n either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack\n policy during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.

" } }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the\n stack. For more information, see the Parameter data\n type.

" + "smithy.api#documentation": "

The name or unique stack ID of the stack to update.

", + "smithy.api#required": {} } }, - "StackPolicyURL": { - "target": "com.amazonaws.cloudformation#StackPolicyURL", + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

Location of a file containing the updated stack policy. The URL must point to a\n policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.

" + "smithy.api#documentation": "

Key-value pairs to associate with this stack. AWS CloudFormation also propagates\n these tags to supported resources in the stack. You can specify a maximum number of 50\n tags.

\n

If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's\n tags. If you specify an empty value, AWS CloudFormation removes all associated\n tags.

" } }, - "NotificationARNs": { - "target": "com.amazonaws.cloudformation#NotificationARNs", + "RollbackConfiguration": { + "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS\n CloudFormation associates with the stack. Specify an empty list to remove all notification\n topics.

" + "smithy.api#documentation": "

The rollback triggers for AWS CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.

" } }, "TemplateURL": { @@ -7809,22 +7809,46 @@ "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that\n is located in an Amazon S3 bucket. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" } }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for this UpdateStack request. Specify this token if\n you plan to retry requests so that AWS CloudFormation knows that you're not attempting to\n update a stack with the same name. You might retry UpdateStack requests to\n ensure that AWS CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + } + }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for AWS CloudFormation to update the stack.

\n " } }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", + "StackPolicyDuringUpdateURL": { + "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "

A unique identifier for this UpdateStack request. Specify this token if\n you plan to retry requests so that AWS CloudFormation knows that you're not attempting to\n update a stack with the same name. You might retry UpdateStack requests to\n ensure that AWS CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

Location of a file containing the temporary overriding stack policy. The URL must\n point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack.\n You can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack\n policy during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.

" } }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", + "ResourceTypes": { + "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

Key-value pairs to associate with this stack. AWS CloudFormation also propagates\n these tags to supported resources in the stack. You can specify a maximum number of 50\n tags.

\n

If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's\n tags. If you specify an empty value, AWS CloudFormation removes all associated\n tags.

" + "smithy.api#documentation": "

The template resource types that you have permissions to work with for this update\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource that you're updating, the\n stack update fails. By default, AWS CloudFormation grants permissions to all resource\n types. AWS Identity and Access Management (IAM) uses this parameter for AWS\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the\n stack. For more information, see the Parameter data\n type.

" + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. (For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.)

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" + } + }, + "StackPolicyBody": { + "target": "com.amazonaws.cloudformation#StackPolicyBody", + "traits": { + "smithy.api#documentation": "

Structure containing a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.

\n

You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.

" } } }, @@ -7867,36 +7891,37 @@ "com.amazonaws.cloudformation#UpdateStackInstancesInput": { "type": "structure", "members": { - "ParameterOverrides": { - "target": "com.amazonaws.cloudformation#Parameters", + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { - "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how AWS CloudFormation sets parameter values during stack instance update\n operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to\n update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.

" + "smithy.api#documentation": "

The name or unique ID of the stack set associated with the stack instances.

", + "smithy.api#required": {} } }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "Regions": { + "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

The names of one or more Regions in which you want to update parameter values for\n stack instances. The overridden parameter values will be applied to all stack instances in\n the specified accounts and Regions.

", + "smithy.api#required": {} } }, - "DeploymentTargets": { - "target": "com.amazonaws.cloudformation#DeploymentTargets", + "ParameterOverrides": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how AWS CloudFormation sets parameter values during stack instance update\n operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to\n update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.

" } }, - "Regions": { - "target": "com.amazonaws.cloudformation#RegionList", + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The names of one or more Regions in which you want to update parameter values for\n stack instances. The overridden parameter values will be applied to all stack instances in\n the specified accounts and Regions.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that AWS\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that AWS\n CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.\n

", + "smithy.api#idempotencyToken": {} } }, - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetNameOrId", + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set associated with the stack instances.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" } }, "Accounts": { @@ -7905,11 +7930,10 @@ "smithy.api#documentation": "

[Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values\n for stack instances. The overridden parameter values will be applied to all stack instances\n in the specified accounts and Regions.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", + "DeploymentTargets": { + "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that AWS\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that AWS\n CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.\n

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

[Service-managed permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } } } @@ -7974,16 +7998,17 @@ "com.amazonaws.cloudformation#UpdateStackSetInput": { "type": "structure", "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", + "Description": { + "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes. For more information, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" + "smithy.api#documentation": "

A brief description of updates that you are making.

" } }, - "PermissionModel": { - "target": "com.amazonaws.cloudformation#PermissionModels", + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

\n " + "smithy.api#documentation": "

The name or unique ID of the stack set that you want to update.

", + "smithy.api#required": {} } }, "OperationId": { @@ -7993,34 +8018,22 @@ "smithy.api#idempotencyToken": {} } }, - "Accounts": { - "target": "com.amazonaws.cloudformation#AccountList", - "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you\n must also specify the Regions in which to update stack set instances.

\n

To update all the stack instances associated with this stack set,\n do not specify the Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, AWS CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts\n and Regions. If the stack set update does not include changes to the template or\n parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while\n leaving all other stack instances with their existing stack instance status.

" - } - }, - "AutoDeployment": { - "target": "com.amazonaws.cloudformation#AutoDeployment", - "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

\n

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", + "UsePreviousTemplate": { + "target": "com.amazonaws.cloudformation#UsePreviousTemplate", "traits": { - "smithy.api#documentation": "

A brief description of updates that you are making.

" + "smithy.api#documentation": "

Use the existing template that's associated with the stack set that you're\n updating.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" } }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n AWS CloudFormation also propagates these tags to supported resources that are created in\n the stacks. You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:

\n \n

If you specify new tags as part of an UpdateStackSet action, AWS\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you omit tags that are currently associated with the stack set from the list of tags you\n specify, AWS CloudFormation assumes that you want to remove those tags from the stack set,\n and checks to see if you have permission to untag resources. If you don't have the\n necessary permission(s), the entire UpdateStackSet action fails with an\n access denied error, and the stack set is not updated.

" + "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes. For more information, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" } }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", + "AdministrationRoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for AWS CloudFormation to update the stack set and its associated stack\n instances.

\n " + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Granting\n Permissions for Stack Set Operations in the\n AWS CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the stack set, you\n must specify a customized administrator role, even if it is the same customized\n administrator role used with this stack set previously.

" } }, "TemplateURL": { @@ -8029,23 +8042,16 @@ "smithy.api#documentation": "

The location of the file that contains the template body. The URL must point to a\n template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more\n information, see Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" } }, - "ExecutionRoleName": { - "target": "com.amazonaws.cloudformation#ExecutionRoleName", - "traits": { - "smithy.api#documentation": "

The name of the IAM execution role to use to update the stack set. If you do not specify\n an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role\n for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.\n

\n

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack.\n If you do not specify a customized execution role, AWS CloudFormation performs the update using the role\n previously associated with the stack set, so long as you have permissions to perform\n operations on the stack set.

" - } - }, - "AdministrationRoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Granting\n Permissions for Stack Set Operations in the\n AWS CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the stack set, you\n must specify a customized administrator role, even if it is the same customized\n administrator role used with this stack set previously.

" + "smithy.api#documentation": "

A list of input parameters for the stack set template.

" } }, - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", + "ExecutionRoleName": { + "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the IAM execution role to use to update the stack set. If you do not specify\n an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role\n for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.\n

\n

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack.\n If you do not specify a customized execution role, AWS CloudFormation performs the update using the role\n previously associated with the stack set, so long as you have permissions to perform\n operations on the stack set.

" } }, "Regions": { @@ -8054,22 +8060,22 @@ "smithy.api#documentation": "

The Regions in which to update associated stack instances. If you specify Regions, you\n must also specify accounts in which to update stack set instances.

\n

To update all the stack instances associated with this stack set,\n do not specify the Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, AWS CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts\n and Regions. If the stack set update does not include changes to the template or\n parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while\n leaving all other stack instances with their existing stack instance status.

" } }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

A list of input parameters for the stack set template.

" + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for AWS CloudFormation to update the stack set and its associated stack\n instances.

\n " } }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "AutoDeployment": { + "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

\n

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

" } }, - "UsePreviousTemplate": { - "target": "com.amazonaws.cloudformation#UsePreviousTemplate", + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Use the existing template that's associated with the stack set that you're\n updating.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Preferences for how AWS CloudFormation performs this stack set operation.

" } }, "DeploymentTargets": { @@ -8077,6 +8083,24 @@ "traits": { "smithy.api#documentation": "

[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.

\n

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

\n

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

" } + }, + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", + "traits": { + "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n AWS CloudFormation also propagates these tags to supported resources that are created in\n the stacks. You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:

\n \n

If you specify new tags as part of an UpdateStackSet action, AWS\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you omit tags that are currently associated with the stack set from the list of tags you\n specify, AWS CloudFormation assumes that you want to remove those tags from the stack set,\n and checks to see if you have permission to untag resources. If you don't have the\n necessary permission(s), the entire UpdateStackSet action fails with an\n access denied error, and the stack set is not updated.

" + } + }, + "Accounts": { + "target": "com.amazonaws.cloudformation#AccountList", + "traits": { + "smithy.api#documentation": "

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you\n must also specify the Regions in which to update stack set instances.

\n

To update all the stack instances associated with this stack set,\n do not specify the Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, AWS CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts\n and Regions. If the stack set update does not include changes to the template or\n parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while\n leaving all other stack instances with their existing stack instance status.

" + } + }, + "PermissionModel": { + "target": "com.amazonaws.cloudformation#PermissionModels", + "traits": { + "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

\n " + } } } }, @@ -8106,17 +8130,17 @@ "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { "type": "structure", "members": { - "EnableTerminationProtection": { - "target": "com.amazonaws.cloudformation#EnableTerminationProtection", + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

Whether to enable termination protection on the specified stack.

", + "smithy.api#documentation": "

The name or unique ID of the stack for which you want to set termination\n protection.

", "smithy.api#required": {} } }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", + "EnableTerminationProtection": { + "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack for which you want to set termination\n protection.

", + "smithy.api#documentation": "

Whether to enable termination protection on the specified stack.

", "smithy.api#required": {} } } @@ -8163,17 +8187,17 @@ "com.amazonaws.cloudformation#ValidateTemplateInput": { "type": "structure", "members": { - "TemplateURL": { - "target": "com.amazonaws.cloudformation#TemplateURL", - "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max\n size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to\n Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If\n both are passed, only TemplateBody is used.

" - } - }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If\n both are passed, only TemplateBody is used.

" } + }, + "TemplateURL": { + "target": "com.amazonaws.cloudformation#TemplateURL", + "traits": { + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max\n size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to\n Template Anatomy\n in the AWS CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If\n both are passed, only TemplateBody is used.

" + } } }, "traits": { @@ -8183,6 +8207,12 @@ "com.amazonaws.cloudformation#ValidateTemplateOutput": { "type": "structure", "members": { + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "

The capabilities found within the template. If your template contains IAM resources,\n you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when\n you use the CreateStack or UpdateStack actions with\n your template; otherwise, those actions return an InsufficientCapabilities error.

\n

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" + } + }, "Parameters": { "target": "com.amazonaws.cloudformation#TemplateParameters", "traits": { @@ -8195,23 +8225,17 @@ "smithy.api#documentation": "

The list of resources that generated the values in the Capabilities\n response element.

" } }, - "DeclaredTransforms": { - "target": "com.amazonaws.cloudformation#TransformsList", - "traits": { - "smithy.api#documentation": "

A list of the transforms that are declared in the template.

" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "

The capabilities found within the template. If your template contains IAM resources,\n you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when\n you use the CreateStack or UpdateStack actions with\n your template; otherwise, those actions return an InsufficientCapabilities error.

\n

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" - } - }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { "smithy.api#documentation": "

The description found within the template.

" } + }, + "DeclaredTransforms": { + "target": "com.amazonaws.cloudformation#TransformsList", + "traits": { + "smithy.api#documentation": "

A list of the transforms that are declared in the template.

" + } } }, "traits": { 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 2b41e648d173..c7ae188fefa7 100644 --- a/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json +++ b/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json @@ -45,6 +45,12 @@ "com.amazonaws.cloudfront#ActiveTrustedSigners": { "type": "structure", "members": { + "Items": { + "target": "com.amazonaws.cloudfront#SignerList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one Signer complex type for each trusted \n\t\t\tsigner that is specified in the TrustedSigners complex type.

" + } + }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { @@ -52,12 +58,6 @@ "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#SignerList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one Signer complex type for each trusted \n\t\t\tsigner that is specified in the TrustedSigners complex type.

" - } - }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { @@ -139,15 +139,15 @@ "smithy.api#required": {} } }, - "CachedMethods": { - "target": "com.amazonaws.cloudfront#CachedMethods" - }, "Items": { "target": "com.amazonaws.cloudfront#MethodsList", "traits": { "smithy.api#documentation": "

A complex type that contains the HTTP methods that you want CloudFront to process and forward \n\t\t\tto your origin.

", "smithy.api#required": {} } + }, + "CachedMethods": { + "target": "com.amazonaws.cloudfront#CachedMethods" } }, "traits": { @@ -192,17 +192,30 @@ "com.amazonaws.cloudfront#CacheBehavior": { "type": "structure", "members": { - "DefaultTTL": { + "PathPattern": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The pattern (for example, images/*.jpg) that specifies which requests to \n\t\t\tapply the behavior to. When CloudFront receives a viewer request, the requested path is compared \n\t\t\twith path patterns in the order in which cache behaviors are listed in the \n\t\t\tdistribution.

\n\t\t \n\t\t\t

You can optionally include a slash (/) at the beginning of the path \n\t\t\t\tpattern. For example, /images/*.jpg. CloudFront behavior is the same with or without \n\t\t\t\tthe leading /.

\n\t\t \n\t\t

The path pattern for the default cache behavior is * and cannot be \n\t\t\tchanged. If the request for an object does not match the path pattern for any cache behaviors, \n\t\t\tCloudFront applies the behavior in the default cache behavior.

\n\t\t

For more information, see Path \n\t\t\t\tPattern in the Amazon CloudFront Developer Guide.

", + "smithy.api#required": {} + } + }, + "SmoothStreaming": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue; if not, specify false. If you specify true for \n\t\t\t\tSmoothStreaming, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern.

" + } + }, + "MaxTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin adds HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } }, - "OriginRequestPolicyId": { + "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to this cache behavior.\n\t\t\tFor more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to this cache behavior. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, "ForwardedValues": { @@ -212,24 +225,20 @@ "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field. For more information, see Working with policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

" } }, - "FieldLevelEncryptionId": { - "target": "com.amazonaws.cloudfront#string", + "LambdaFunctionAssociations": { + "target": "com.amazonaws.cloudfront#LambdaFunctionAssociations", "traits": { - "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for this cache behavior.

" + "smithy.api#documentation": "

A complex type that contains zero or more Lambda function associations for a cache \n\t\t\tbehavior.

" } }, - "SmoothStreaming": { - "target": "com.amazonaws.cloudfront#boolean", + "OriginRequestPolicyId": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue; if not, specify false. If you specify true for \n\t\t\t\tSmoothStreaming, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern.

" + "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to this cache behavior.\n\t\t\tFor more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, - "MinTTL": { - "target": "com.amazonaws.cloudfront#long", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see \n\t\t\t\tManaging How Long Content Stays in an Edge Cache (Expiration) in the \n\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

You must specify 0 for MinTTL if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers, if you specify 1 \n\t\t\tfor Quantity and * for Name).

" - } + "AllowedMethods": { + "target": "com.amazonaws.cloudfront#AllowedMethods" }, "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", @@ -238,53 +247,50 @@ "smithy.api#required": {} } }, - "MaxTTL": { - "target": "com.amazonaws.cloudfront#long", + "Compress": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin adds HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true; if not, specify false. For more information, see Serving Compressed Files in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, - "TrustedSigners": { - "target": "com.amazonaws.cloudfront#TrustedSigners", + "TargetOriginId": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to \n\t\t\tcreate signed URLs for private content.

\n\t\t

If you want to require signed URLs in requests for objects in the target origin that \n\t\t\tmatch the PathPattern for this cache behavior, specify true for \n\t\t\t\tEnabled, and specify the applicable values for Quantity and \n\t\t\t\tItems. For more information, see Serving Private Content\n\t\t\twith Signed URLs and Signed Cookies in the Amazon CloudFront Developer Guide.\n\t\t

\n\t\t

If you don’t want to require signed URLs in requests for objects that match\n\t\t\tPathPattern, specify false for Enabled and \n\t\t\t\t0 for Quantity. Omit Items.

\n\t\t

To add, change, or remove one or more trusted signers, change Enabled to\n\t\t\ttrue (if it’s currently false), change Quantity\n\t\t\tas applicable, and specify all of the trusted signers that you want to include in the\n\t\t\tupdated distribution.

", + "smithy.api#documentation": "

The value of ID for the origin that you want CloudFront to route requests to\n\t\t\twhen they match this cache behavior.

", "smithy.api#required": {} } }, - "AllowedMethods": { - "target": "com.amazonaws.cloudfront#AllowedMethods" - }, - "TargetOriginId": { + "FieldLevelEncryptionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of ID for the origin that you want CloudFront to route requests to\n\t\t\twhen they match this cache behavior.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for this cache behavior.

" } }, - "Compress": { - "target": "com.amazonaws.cloudfront#boolean", + "MinTTL": { + "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true; if not, specify false. For more information, see Serving Compressed Files in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see \n\t\t\t\tManaging How Long Content Stays in an Edge Cache (Expiration) in the \n\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

You must specify 0 for MinTTL if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers, if you specify 1 \n\t\t\tfor Quantity and * for Name).

" } }, - "CachePolicyId": { + "RealtimeLogConfigArn": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to this cache behavior. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this\n\t\t\tcache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

" } }, - "PathPattern": { - "target": "com.amazonaws.cloudfront#string", + "TrustedSigners": { + "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "

The pattern (for example, images/*.jpg) that specifies which requests to \n\t\t\tapply the behavior to. When CloudFront receives a viewer request, the requested path is compared \n\t\t\twith path patterns in the order in which cache behaviors are listed in the \n\t\t\tdistribution.

\n\t\t \n\t\t\t

You can optionally include a slash (/) at the beginning of the path \n\t\t\t\tpattern. For example, /images/*.jpg. CloudFront behavior is the same with or without \n\t\t\t\tthe leading /.

\n\t\t \n\t\t

The path pattern for the default cache behavior is * and cannot be \n\t\t\tchanged. If the request for an object does not match the path pattern for any cache behaviors, \n\t\t\tCloudFront applies the behavior in the default cache behavior.

\n\t\t

For more information, see Path \n\t\t\t\tPattern in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to \n\t\t\tcreate signed URLs for private content.

\n\t\t

If you want to require signed URLs in requests for objects in the target origin that \n\t\t\tmatch the PathPattern for this cache behavior, specify true for \n\t\t\t\tEnabled, and specify the applicable values for Quantity and \n\t\t\t\tItems. For more information, see Serving Private Content\n\t\t\twith Signed URLs and Signed Cookies in the Amazon CloudFront Developer Guide.\n\t\t

\n\t\t

If you don’t want to require signed URLs in requests for objects that match\n\t\t\tPathPattern, specify false for Enabled and \n\t\t\t\t0 for Quantity. Omit Items.

\n\t\t

To add, change, or remove one or more trusted signers, change Enabled to\n\t\t\ttrue (if it’s currently false), change Quantity\n\t\t\tas applicable, and specify all of the trusted signers that you want to include in the\n\t\t\tupdated distribution.

", "smithy.api#required": {} } }, - "LambdaFunctionAssociations": { - "target": "com.amazonaws.cloudfront#LambdaFunctionAssociations", + "DefaultTTL": { + "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more Lambda function associations for a cache \n\t\t\tbehavior.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } } }, @@ -304,18 +310,18 @@ "com.amazonaws.cloudfront#CacheBehaviors": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.cloudfront#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

Optional: A complex type that contains cache behaviors for this distribution. If \n\t\t\t\tQuantity is 0, you can omit Items.

" - } - }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

The number of cache behaviors for this distribution.

", "smithy.api#required": {} } + }, + "Items": { + "target": "com.amazonaws.cloudfront#CacheBehaviorList", + "traits": { + "smithy.api#documentation": "

Optional: A complex type that contains cache behaviors for this distribution. If \n\t\t\t\tQuantity is 0, you can omit Items.

" + } } }, "traits": { @@ -325,13 +331,6 @@ "com.amazonaws.cloudfront#CachePolicy": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.cloudfront#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when the cache policy was last modified.

", - "smithy.api#required": {} - } - }, "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -345,6 +344,13 @@ "smithy.api#documentation": "

The cache policy configuration.

", "smithy.api#required": {} } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cache policy was last modified.

", + "smithy.api#required": {} + } } }, "traits": { @@ -367,17 +373,23 @@ "com.amazonaws.cloudfront#CachePolicyConfig": { "type": "structure", "members": { - "MinTTL": { - "target": "com.amazonaws.cloudfront#long", + "ParametersInCacheKeyAndForwardedToOrigin": { + "target": "com.amazonaws.cloudfront#ParametersInCacheKeyAndForwardedToOrigin", "traits": { - "smithy.api#documentation": "

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The HTTP headers, cookies, and URL query strings to include in the cache key. The\n\t\t\tvalues included in the cache key are automatically included in requests that CloudFront sends\n\t\t\tto the origin.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

A unique name to identify the cache policy.

", "smithy.api#required": {} } }, - "MaxTTL": { + "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that objects stay in the CloudFront cache\n\t\t\tbefore CloudFront sends another request to the origin to see if the object has been updated.\n\t\t\tCloudFront uses this value only when the origin sends Cache-Control or\n\t\t\tExpires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default value for this field is 31536000 seconds (one year). If the value of\n\t\t\tMinTTL or DefaultTTL is more than 31536000 seconds, then the\n\t\t\tdefault value for this field is the same as the value of DefaultTTL.

" + "smithy.api#documentation": "

The default amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. CloudFront uses this value as the object’s time to live (TTL) only when the origin\n\t\t\tdoes not send Cache-Control or Expires\n\t\t\theaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default value for this field is 86400 seconds (one day). If the value of\n\t\t\tMinTTL is more than 86400 seconds, then the default value for this field is\n\t\t\tthe same as the value of MinTTL.

" } }, "Comment": { @@ -386,23 +398,17 @@ "smithy.api#documentation": "

A comment to describe the cache policy.

" } }, - "Name": { - "target": "com.amazonaws.cloudfront#string", + "MinTTL": { + "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

A unique name to identify the cache policy.

", + "smithy.api#documentation": "

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, - "ParametersInCacheKeyAndForwardedToOrigin": { - "target": "com.amazonaws.cloudfront#ParametersInCacheKeyAndForwardedToOrigin", - "traits": { - "smithy.api#documentation": "

The HTTP headers, cookies, and URL query strings to include in the cache key. The\n\t\t\tvalues included in the cache key are automatically included in requests that CloudFront sends\n\t\t\tto the origin.

" - } - }, - "DefaultTTL": { + "MaxTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The default amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. CloudFront uses this value as the object’s time to live (TTL) only when the origin\n\t\t\tdoes not send Cache-Control or Expires\n\t\t\theaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default value for this field is 86400 seconds (one day). If the value of\n\t\t\tMinTTL is more than 86400 seconds, then the default value for this field is\n\t\t\tthe same as the value of MinTTL.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that objects stay in the CloudFront cache\n\t\t\tbefore CloudFront sends another request to the origin to see if the object has been updated.\n\t\t\tCloudFront uses this value only when the origin sends Cache-Control or\n\t\t\tExpires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default value for this field is 31536000 seconds (one year). If the value of\n\t\t\tMinTTL or DefaultTTL is more than 31536000 seconds, then the\n\t\t\tdefault value for this field is the same as the value of DefaultTTL.

" } } }, @@ -432,15 +438,15 @@ "com.amazonaws.cloudfront#CachePolicyCookiesConfig": { "type": "structure", "members": { + "Cookies": { + "target": "com.amazonaws.cloudfront#CookieNames" + }, "CookieBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyCookieBehavior", "traits": { "smithy.api#documentation": "

Determines whether any cookies in viewer requests are included in the cache key and\n\t\t\tautomatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:

\n\t\t ", "smithy.api#required": {} } - }, - "Cookies": { - "target": "com.amazonaws.cloudfront#CookieNames" } }, "traits": { @@ -494,12 +500,6 @@ "com.amazonaws.cloudfront#CachePolicyList": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing cache policies where you left off.

" - } - }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { @@ -507,6 +507,12 @@ "smithy.api#required": {} } }, + "Items": { + "target": "com.amazonaws.cloudfront#CachePolicySummaryList", + "traits": { + "smithy.api#documentation": "

Contains the cache policies in the list.

" + } + }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { @@ -514,10 +520,10 @@ "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#CachePolicySummaryList", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Contains the cache policies in the list.

" + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing cache policies where you left off.

" } } }, @@ -547,18 +553,18 @@ "com.amazonaws.cloudfront#CachePolicyQueryStringsConfig": { "type": "structure", "members": { - "QueryStrings": { - "target": "com.amazonaws.cloudfront#QueryStringNames", - "traits": { - "smithy.api#documentation": "

Contains the specific query strings in viewer requests that either \n are\n or \n are\n\t\t\tnot\n included in the cache key and automatically included in\n\t\t\trequests that CloudFront sends to the origin. The behavior depends on whether the\n\t\t\tQueryStringBehavior field in the CachePolicyQueryStringsConfig\n\t\t\ttype is set to whitelist (the listed query strings \n are\n included) or allExcept (the listed\n\t\t\tquery strings \n are not\n included,\n\t\t\tbut all other query strings are).

" - } - }, "QueryStringBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyQueryStringBehavior", "traits": { "smithy.api#documentation": "

Determines whether any URL query strings in viewer requests are included in the cache key\n\t\t\tand automatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:

\n\t\t ", "smithy.api#required": {} } + }, + "QueryStrings": { + "target": "com.amazonaws.cloudfront#QueryStringNames", + "traits": { + "smithy.api#documentation": "

Contains the specific query strings in viewer requests that either \n are\n or \n are\n\t\t\tnot\n included in the cache key and automatically included in\n\t\t\trequests that CloudFront sends to the origin. The behavior depends on whether the\n\t\t\tQueryStringBehavior field in the CachePolicyQueryStringsConfig\n\t\t\ttype is set to whitelist (the listed query strings \n are\n included) or allExcept (the listed\n\t\t\tquery strings \n are not\n included,\n\t\t\tbut all other query strings are).

" + } } }, "traits": { @@ -568,17 +574,17 @@ "com.amazonaws.cloudfront#CachePolicySummary": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.cloudfront#CachePolicyType", + "CachePolicy": { + "target": "com.amazonaws.cloudfront#CachePolicy", "traits": { - "smithy.api#documentation": "

The type of cache policy, either managed (created by AWS) or\n\t\t\tcustom (created in this AWS account).

", + "smithy.api#documentation": "

The cache policy.

", "smithy.api#required": {} } }, - "CachePolicy": { - "target": "com.amazonaws.cloudfront#CachePolicy", + "Type": { + "target": "com.amazonaws.cloudfront#CachePolicyType", "traits": { - "smithy.api#documentation": "

The cache policy.

", + "smithy.api#documentation": "

The type of cache policy, either managed (created by AWS) or\n\t\t\tcustom (created in this AWS account).

", "smithy.api#required": {} } } @@ -612,17 +618,17 @@ "com.amazonaws.cloudfront#CachedMethods": { "type": "structure", "members": { - "Quantity": { - "target": "com.amazonaws.cloudfront#integer", + "Items": { + "target": "com.amazonaws.cloudfront#MethodsList", "traits": { - "smithy.api#documentation": "

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are \n\t\t\t\t2 (for caching responses to GET and HEAD requests) \n\t\t\tand 3 (for caching responses to GET, HEAD, and \n\t\t\t\tOPTIONS requests).

", + "smithy.api#documentation": "

A complex type that contains the HTTP methods that you want CloudFront to cache responses \n\t\t\tto.

", "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#MethodsList", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

A complex type that contains the HTTP methods that you want CloudFront to cache responses \n\t\t\tto.

", + "smithy.api#documentation": "

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are \n\t\t\t\t2 (for caching responses to GET and HEAD requests) \n\t\t\tand 3 (for caching responses to GET, HEAD, and \n\t\t\t\tOPTIONS requests).

", "smithy.api#required": {} } } @@ -663,10 +669,10 @@ "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity": { "type": "structure", "members": { - "Id": { + "S3CanonicalUserId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID for the origin access identity, for example, E74FTE3AJFJ256A. \n\t\t

", + "smithy.api#documentation": "

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin \n\t\t\taccess identity read permission to an object in Amazon S3.

", "smithy.api#required": {} } }, @@ -676,10 +682,10 @@ "smithy.api#documentation": "

The current configuration information for the identity.

" } }, - "S3CanonicalUserId": { + "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin \n\t\t\taccess identity read permission to an object in Amazon S3.

", + "smithy.api#documentation": "

The ID for the origin access identity, for example, E74FTE3AJFJ256A. \n\t\t

", "smithy.api#required": {} } } @@ -704,17 +710,17 @@ "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig": { "type": "structure", "members": { - "Comment": { + "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Any comments you want to include about the origin access identity.

", + "smithy.api#documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

\n\t\t

If the value of CallerReference is new (regardless of the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig object), a new origin access identity is \n\t\t\tcreated.

\n\t\t

If the CallerReference is a value already sent in a previous identity \n\t\t\trequest, and the content of the CloudFrontOriginAccessIdentityConfig is identical \n\t\t\tto the original request (ignoring white space), the response includes the same information \n\t\t\treturned to the original request.

\n\t\t

If the CallerReference is a value you already sent in a previous request \n\t\t\tto create an identity, but the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig is different from the original request, \n\t\t\tCloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", "smithy.api#required": {} } }, - "CallerReference": { + "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

\n\t\t

If the value of CallerReference is new (regardless of the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig object), a new origin access identity is \n\t\t\tcreated.

\n\t\t

If the CallerReference is a value already sent in a previous identity \n\t\t\trequest, and the content of the CloudFrontOriginAccessIdentityConfig is identical \n\t\t\tto the original request (ignoring white space), the response includes the same information \n\t\t\treturned to the original request.

\n\t\t

If the CallerReference is a value you already sent in a previous request \n\t\t\tto create an identity, but the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig is different from the original request, \n\t\t\tCloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "smithy.api#documentation": "

Any comments you want to include about the origin access identity.

", "smithy.api#required": {} } } @@ -739,11 +745,10 @@ "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityList": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.cloudfront#integer", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The maximum number of origin access identities you want in the response body. \n\t\t

", - "smithy.api#required": {} + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\torigin access identities where they left off.

" } }, "Items": { @@ -759,10 +764,10 @@ "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.cloudfront#string", + "MaxItems": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).

", + "smithy.api#documentation": "

The maximum number of origin access identities you want in the response body. \n\t\t

", "smithy.api#required": {} } }, @@ -773,10 +778,11 @@ "smithy.api#required": {} } }, - "NextMarker": { + "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\torigin access identities where they left off.

" + "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).

", + "smithy.api#required": {} } } }, @@ -847,12 +853,18 @@ { "target": "com.amazonaws.cloudfront#CreateInvalidation" }, + { + "target": "com.amazonaws.cloudfront#CreateMonitoringSubscription" + }, { "target": "com.amazonaws.cloudfront#CreateOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#CreatePublicKey" }, + { + "target": "com.amazonaws.cloudfront#CreateRealtimeLogConfig" + }, { "target": "com.amazonaws.cloudfront#CreateStreamingDistribution" }, @@ -874,12 +886,18 @@ { "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionProfile" }, + { + "target": "com.amazonaws.cloudfront#DeleteMonitoringSubscription" + }, { "target": "com.amazonaws.cloudfront#DeleteOriginRequestPolicy" }, { "target": "com.amazonaws.cloudfront#DeletePublicKey" }, + { + "target": "com.amazonaws.cloudfront#DeleteRealtimeLogConfig" + }, { "target": "com.amazonaws.cloudfront#DeleteStreamingDistribution" }, @@ -916,6 +934,9 @@ { "target": "com.amazonaws.cloudfront#GetInvalidation" }, + { + "target": "com.amazonaws.cloudfront#GetMonitoringSubscription" + }, { "target": "com.amazonaws.cloudfront#GetOriginRequestPolicy" }, @@ -928,6 +949,9 @@ { "target": "com.amazonaws.cloudfront#GetPublicKeyConfig" }, + { + "target": "com.amazonaws.cloudfront#GetRealtimeLogConfig" + }, { "target": "com.amazonaws.cloudfront#GetStreamingDistribution" }, @@ -949,6 +973,9 @@ { "target": "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyId" }, + { + "target": "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfig" + }, { "target": "com.amazonaws.cloudfront#ListDistributionsByWebACLId" }, @@ -967,6 +994,9 @@ { "target": "com.amazonaws.cloudfront#ListPublicKeys" }, + { + "target": "com.amazonaws.cloudfront#ListRealtimeLogConfigs" + }, { "target": "com.amazonaws.cloudfront#ListStreamingDistributions" }, @@ -1000,6 +1030,9 @@ { "target": "com.amazonaws.cloudfront#UpdatePublicKey" }, + { + "target": "com.amazonaws.cloudfront#UpdateRealtimeLogConfig" + }, { "target": "com.amazonaws.cloudfront#UpdateStreamingDistribution" } @@ -1031,10 +1064,10 @@ "com.amazonaws.cloudfront#ContentTypeProfile": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.cloudfront#string", + "Format": { + "target": "com.amazonaws.cloudfront#Format", "traits": { - "smithy.api#documentation": "

The content type for a field-level encryption content type-profile mapping.

", + "smithy.api#documentation": "

The format for a field-level encryption content type-profile mapping.

", "smithy.api#required": {} } }, @@ -1044,10 +1077,10 @@ "smithy.api#documentation": "

The profile ID for a field-level encryption content type-profile mapping.

" } }, - "Format": { - "target": "com.amazonaws.cloudfront#Format", + "ContentType": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The format for a field-level encryption content type-profile mapping.

", + "smithy.api#documentation": "

The content type for a field-level encryption content type-profile mapping.

", "smithy.api#required": {} } } @@ -1089,18 +1122,18 @@ "com.amazonaws.cloudfront#ContentTypeProfiles": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.cloudfront#ContentTypeProfileList", - "traits": { - "smithy.api#documentation": "

Items in a field-level encryption content type-profile mapping.

" - } - }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

The number of field-level encryption content type-profile mappings.

", "smithy.api#required": {} } + }, + "Items": { + "target": "com.amazonaws.cloudfront#ContentTypeProfileList", + "traits": { + "smithy.api#documentation": "

Items in a field-level encryption content type-profile mapping.

" + } } }, "traits": { @@ -1119,18 +1152,18 @@ "com.amazonaws.cloudfront#CookieNames": { "type": "structure", "members": { + "Items": { + "target": "com.amazonaws.cloudfront#CookieNameList", + "traits": { + "smithy.api#documentation": "

A list of cookie names.

" + } + }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

The number of cookie names in the Items list.

", "smithy.api#required": {} } - }, - "Items": { - "target": "com.amazonaws.cloudfront#CookieNameList", - "traits": { - "smithy.api#documentation": "

A list of cookie names.

" - } } }, "traits": { @@ -1140,22 +1173,22 @@ "com.amazonaws.cloudfront#CookiePreference": { "type": "structure", "members": { + "WhitelistedNames": { + "target": "com.amazonaws.cloudfront#CookieNames", + "traits": { + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

Required if you specify whitelist for the value of Forward. \n\t\t\tA complex type that specifies how many different cookies you want CloudFront to forward to the \n\t\t\torigin for this cache behavior and, if you want to forward selected cookies, the names of \n\t\t\tthose cookies.

\n\t\t

If you specify all or none for the value of Forward, omit \n\t\t\t\tWhitelistedNames. If you change the value of Forward from \n\t\t\twhitelist to all or none and you don't delete the WhitelistedNames \n\t\t\telement and its child elements, CloudFront deletes them automatically.

\n\t\t

For the current limit on the number of cookie names that you can whitelist for each \n\t\t\tcache behavior, see \n\t\t\t\tCloudFront Limits in the AWS General Reference.

" + } + }, "Forward": { "target": "com.amazonaws.cloudfront#ItemSelection", "traits": { "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use origin\n\t\t\trequest policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

Specifies which cookies to forward to the origin for this cache behavior: all, none, or \n\t\t\tthe list of cookies specified in the WhitelistedNames complex type.

\n\t\t

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an \n\t\t\tAmazon S3 origin, specify none for the Forward element.

", "smithy.api#required": {} } - }, - "WhitelistedNames": { - "target": "com.amazonaws.cloudfront#CookieNames", - "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

Required if you specify whitelist for the value of Forward. \n\t\t\tA complex type that specifies how many different cookies you want CloudFront to forward to the \n\t\t\torigin for this cache behavior and, if you want to forward selected cookies, the names of \n\t\t\tthose cookies.

\n\t\t

If you specify all or none for the value of Forward, omit \n\t\t\t\tWhitelistedNames. If you change the value of Forward from \n\t\t\twhitelist to all or none and you don't delete the WhitelistedNames \n\t\t\telement and its child elements, CloudFront deletes them automatically.

\n\t\t

For the current limit on the number of cookie names that you can whitelist for each \n\t\t\tcache behavior, see \n\t\t\t\tCloudFront Limits in the AWS General Reference.

" - } } }, "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use CookiesConfig in a\n\t\t\tcache policy. See CreateCachePolicy.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tCookiesConfig in an origin request policy. See\n\t\t\tCreateOriginRequestPolicy.

\n\t\t

A complex type that specifies whether you want CloudFront to forward cookies to the origin \n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see \n\t\t\tCaching Content \n\t\t\t\tBased on Cookies in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use CookiesConfig in a\n\t\t\tcache policy. See CachePolicy.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tCookiesConfig in an origin request policy. See\n\t\t\tOriginRequestPolicy.

\n\t\t

A complex type that specifies whether you want CloudFront to forward cookies to the origin \n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see \n\t\t\tCaching Content \n\t\t\t\tBased on Cookies in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#CreateCachePolicy": { @@ -1193,7 +1226,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a cache policy.

\n\t\t

After you create a cache policy, you can attach it to one or more cache behaviors. When it’s\n\t\t\tattached to a cache behavior, the cache policy determines the following:

\n\t\t \n\t\t

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tCreateOriginRequestPolicy.

\n\t\t

For more information about cache policies, see Controlling the cache key in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

Creates a cache policy.

\n\t\t

After you create a cache policy, you can attach it to one or more cache behaviors. When it’s\n\t\t\tattached to a cache behavior, the cache policy determines the following:

\n\t\t \n\t\t

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.

\n\t\t

For more information about cache policies, see Controlling the cache key in the\n\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/cache-policy", @@ -1217,11 +1250,11 @@ "com.amazonaws.cloudfront#CreateCachePolicyResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", + "CachePolicy": { + "target": "com.amazonaws.cloudfront#CachePolicy", "traits": { - "smithy.api#documentation": "

The current version of the cache policy.

", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "

A cache policy.

", + "smithy.api#httpPayload": {} } }, "Location": { @@ -1231,11 +1264,11 @@ "smithy.api#httpHeader": "Location" } }, - "CachePolicy": { - "target": "com.amazonaws.cloudfront#CachePolicy", + "ETag": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A cache policy.

", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

The current version of the cache policy.

", + "smithy.api#httpHeader": "ETag" } } } @@ -1293,11 +1326,11 @@ "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentityResult": { "type": "structure", "members": { - "ETag": { + "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the origin access identity created.

", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "

The fully qualified URI of the new origin access identity just created.

", + "smithy.api#httpHeader": "Location" } }, "CloudFrontOriginAccessIdentity": { @@ -1307,11 +1340,11 @@ "smithy.api#httpPayload": {} } }, - "Location": { + "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The fully qualified URI of the new origin access identity just created.

", - "smithy.api#httpHeader": "Location" + "smithy.api#documentation": "

The current version of the origin access identity created.

", + "smithy.api#httpHeader": "ETag" } } }, @@ -1504,6 +1537,13 @@ "com.amazonaws.cloudfront#CreateDistributionResult": { "type": "structure", "members": { + "Location": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The fully qualified URI of the new distribution resource just created.

", + "smithy.api#httpHeader": "Location" + } + }, "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { @@ -1517,13 +1557,6 @@ "smithy.api#documentation": "

The current version of the distribution created.

", "smithy.api#httpHeader": "ETag" } - }, - "Location": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The fully qualified URI of the new distribution resource just created.

", - "smithy.api#httpHeader": "Location" - } } }, "traits": { @@ -1718,6 +1751,13 @@ "com.amazonaws.cloudfront#CreateDistributionWithTagsResult": { "type": "structure", "members": { + "Location": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The fully qualified URI of the new distribution resource just created.

", + "smithy.api#httpHeader": "Location" + } + }, "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { @@ -1731,13 +1771,6 @@ "smithy.api#documentation": "

The current version of the distribution created.

", "smithy.api#httpHeader": "ETag" } - }, - "Location": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The fully qualified URI of the new distribution resource just created.

", - "smithy.api#httpHeader": "Location" - } } }, "traits": { @@ -1810,19 +1843,19 @@ "smithy.api#httpHeader": "Location" } }, - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "ETag" - } - }, "FieldLevelEncryption": { "target": "com.amazonaws.cloudfront#FieldLevelEncryption", "traits": { "smithy.api#documentation": "

Returned when you create a new field-level encryption configuration.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "ETag" + } } } }, @@ -1885,11 +1918,11 @@ "com.amazonaws.cloudfront#CreateFieldLevelEncryptionProfileResult": { "type": "structure", "members": { - "FieldLevelEncryptionProfile": { - "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", + "Location": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Returned when you create a new field-level encryption profile.

", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

The fully qualified URI of the new profile resource just created.

", + "smithy.api#httpHeader": "Location" } }, "ETag": { @@ -1899,11 +1932,11 @@ "smithy.api#httpHeader": "ETag" } }, - "Location": { - "target": "com.amazonaws.cloudfront#string", + "FieldLevelEncryptionProfile": { + "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", "traits": { - "smithy.api#documentation": "

The fully qualified URI of the new profile resource just created.

", - "smithy.api#httpHeader": "Location" + "smithy.api#documentation": "

Returned when you create a new field-level encryption profile.

", + "smithy.api#httpPayload": {} } } } @@ -1994,6 +2027,64 @@ "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, + "com.amazonaws.cloudfront#CreateMonitoringSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#CreateMonitoringSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#CreateMonitoringSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchDistribution" + } + ], + "traits": { + "smithy.api#documentation": "

Enables additional CloudWatch metrics for the specified CloudFront distribution. The\n\t\t\tadditional metrics incur an additional cost.

\n\t\t

For more information, see Viewing additional CloudFront distribution metrics in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#CreateMonitoringSubscriptionRequest": { + "type": "structure", + "members": { + "MonitoringSubscription": { + "target": "com.amazonaws.cloudfront#MonitoringSubscription", + "traits": { + "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The ID of the distribution that you are enabling metrics for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudfront#CreateMonitoringSubscriptionResult": { + "type": "structure", + "members": { + "MonitoringSubscription": { + "target": "com.amazonaws.cloudfront#MonitoringSubscription", + "traits": { + "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

", + "smithy.api#httpPayload": {} + } + } + } + }, "com.amazonaws.cloudfront#CreateOriginRequestPolicy": { "type": "operation", "input": { @@ -2029,7 +2120,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an origin request policy.

\n\t\t

After you create an origin request policy, you can attach it to one or more cache behaviors.\n\t\t\tWhen it’s attached to a cache behavior, the origin request policy determines the values\n\t\t\tthat CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends\n\t\t\tto the origin includes the following:

\n\t\t \n\t\t

CloudFront sends a request when it can’t find a valid object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CreateCachePolicy.

\n\t\t

For more information about origin request policies, see Controlling origin requests in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

Creates an origin request policy.

\n\t\t

After you create an origin request policy, you can attach it to one or more cache behaviors.\n\t\t\tWhen it’s attached to a cache behavior, the origin request policy determines the values\n\t\t\tthat CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends\n\t\t\tto the origin includes the following:

\n\t\t \n\t\t

CloudFront sends a request when it can’t find a valid object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.

\n\t\t

For more information about origin request policies, see Controlling origin requests in the\n\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-request-policy", @@ -2053,6 +2144,13 @@ "com.amazonaws.cloudfront#CreateOriginRequestPolicyResult": { "type": "structure", "members": { + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the origin request policy.

", + "smithy.api#httpHeader": "ETag" + } + }, "OriginRequestPolicy": { "target": "com.amazonaws.cloudfront#OriginRequestPolicy", "traits": { @@ -2066,13 +2164,6 @@ "smithy.api#documentation": "

The fully qualified URI of the origin request policy just created.

", "smithy.api#httpHeader": "Location" } - }, - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The current version of the origin request policy.

", - "smithy.api#httpHeader": "ETag" - } } } }, @@ -2127,73 +2218,145 @@ "smithy.api#httpHeader": "Location" } }, - "PublicKey": { - "target": "com.amazonaws.cloudfront#PublicKey", - "traits": { - "smithy.api#documentation": "

Returned when you add a public key.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the public key. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } + }, + "PublicKey": { + "target": "com.amazonaws.cloudfront#PublicKey", + "traits": { + "smithy.api#documentation": "

Returned when you add a public key.

", + "smithy.api#httpPayload": {} + } } } }, - "com.amazonaws.cloudfront#CreateStreamingDistribution": { + "com.amazonaws.cloudfront#CreateRealtimeLogConfig": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#CreateStreamingDistributionRequest" + "target": "com.amazonaws.cloudfront#CreateRealtimeLogConfigRequest" }, "output": { - "target": "com.amazonaws.cloudfront#CreateStreamingDistributionResult" + "target": "com.amazonaws.cloudfront#CreateRealtimeLogConfigResult" }, "errors": [ - { - "target": "com.amazonaws.cloudfront#AccessDenied" - }, - { - "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" - }, - { - "target": "com.amazonaws.cloudfront#InconsistentQuantities" - }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { - "target": "com.amazonaws.cloudfront#InvalidOrigin" - }, - { - "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" - }, - { - "target": "com.amazonaws.cloudfront#MissingBody" - }, - { - "target": "com.amazonaws.cloudfront#StreamingDistributionAlreadyExists" - }, - { - "target": "com.amazonaws.cloudfront#TooManyStreamingDistributionCNAMEs" - }, - { - "target": "com.amazonaws.cloudfront#TooManyStreamingDistributions" - }, - { - "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" + "target": "com.amazonaws.cloudfront#RealtimeLogConfigAlreadyExists" }, { - "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" + "target": "com.amazonaws.cloudfront#TooManyRealtimeLogConfigs" } ], "traits": { - "smithy.api#documentation": "

Creates a new RTMP distribution. An RTMP distribution is similar to a web distribution, \n\t\t\tbut an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol \n\t\t\t(RTMP) instead of serving files using HTTP.

\n\t\t

To create a new distribution, submit a POST request to the \n\t\t\t\tCloudFront API version/distribution resource. The request body must include a \n\t\t\tdocument with a StreamingDistributionConfig element. The response echoes \n\t\t\tthe StreamingDistributionConfig element and returns other information about the \n\t\t\tRTMP distribution.

\n\t\t

To get the status of your request, use the GET \n\t\t\t\tStreamingDistribution API action. When the value of Enabled is \n\t\t\t\ttrue and the value of Status is Deployed, your \n\t\t\tdistribution is ready. A distribution usually deploys in less than 15 minutes.

\n\t\t

For more information about web distributions, see Working with RTMP Distributions in the \n\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t \n\t\t\t

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to \n\t\t\t\tthe format of the XML document that you include in the request body when you create or \n\t\t\t\tupdate a web distribution or an RTMP distribution, and when you invalidate objects. With \n\t\t\t\tprevious versions of the API, we discovered that it was too easy to accidentally delete one \n\t\t\t\tor more values for an element that accepts multiple values, for example, CNAMEs and trusted \n\t\t\t\tsigners. Our changes for the 2012-05-05 release are intended to prevent these accidental \n\t\t\t\tdeletions and to notify you when there's a mismatch between the number of values you say \n\t\t\t\tyou're specifying in the Quantity element and the number of values \n\t\t\t\tspecified.

\n\t\t ", + "smithy.api#documentation": "

Creates a real-time log configuration.

\n\t\t

After you create a real-time log configuration, you can attach it to one or more cache\n\t\t\tbehaviors to send real-time log data to the specified Amazon Kinesis data stream.

\n\t\t

For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", - "uri": "/2020-05-31/streaming-distribution", + "uri": "/2020-05-31/realtime-log-config", + "code": 201 + } + } + }, + "com.amazonaws.cloudfront#CreateRealtimeLogConfigRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

A unique name to identify this real-time log configuration.

", + "smithy.api#required": {} + } + }, + "SamplingRate": { + "target": "com.amazonaws.cloudfront#long", + "traits": { + "smithy.api#documentation": "

The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. You must\n\t\t\tprovide an integer between 1 and 100, inclusive.

", + "smithy.api#required": {} + } + }, + "EndPoints": { + "target": "com.amazonaws.cloudfront#EndPointList", + "traits": { + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.

", + "smithy.api#required": {} + } + }, + "Fields": { + "target": "com.amazonaws.cloudfront#FieldList", + "traits": { + "smithy.api#documentation": "

A list of fields to include in each real-time log record.

\n\t\t

For more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudfront#CreateRealtimeLogConfigResult": { + "type": "structure", + "members": { + "RealtimeLogConfig": { + "target": "com.amazonaws.cloudfront#RealtimeLogConfig", + "traits": { + "smithy.api#documentation": "

A real-time log configuration.

" + } + } + } + }, + "com.amazonaws.cloudfront#CreateStreamingDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#CreateStreamingDistributionRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#CreateStreamingDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#InconsistentQuantities" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidOrigin" + }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" + }, + { + "target": "com.amazonaws.cloudfront#MissingBody" + }, + { + "target": "com.amazonaws.cloudfront#StreamingDistributionAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#TooManyStreamingDistributionCNAMEs" + }, + { + "target": "com.amazonaws.cloudfront#TooManyStreamingDistributions" + }, + { + "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" + }, + { + "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new RTMP distribution. An RTMP distribution is similar to a web distribution, \n\t\t\tbut an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol \n\t\t\t(RTMP) instead of serving files using HTTP.

\n\t\t

To create a new distribution, submit a POST request to the \n\t\t\t\tCloudFront API version/distribution resource. The request body must include a \n\t\t\tdocument with a StreamingDistributionConfig element. The response echoes \n\t\t\tthe StreamingDistributionConfig element and returns other information about the \n\t\t\tRTMP distribution.

\n\t\t

To get the status of your request, use the GET \n\t\t\t\tStreamingDistribution API action. When the value of Enabled is \n\t\t\t\ttrue and the value of Status is Deployed, your \n\t\t\tdistribution is ready. A distribution usually deploys in less than 15 minutes.

\n\t\t

For more information about web distributions, see Working with RTMP Distributions in the \n\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t \n\t\t\t

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to \n\t\t\t\tthe format of the XML document that you include in the request body when you create or \n\t\t\t\tupdate a web distribution or an RTMP distribution, and when you invalidate objects. With \n\t\t\t\tprevious versions of the API, we discovered that it was too easy to accidentally delete one \n\t\t\t\tor more values for an element that accepts multiple values, for example, CNAMEs and trusted \n\t\t\t\tsigners. Our changes for the 2012-05-05 release are intended to prevent these accidental \n\t\t\t\tdeletions and to notify you when there's a mismatch between the number of values you say \n\t\t\t\tyou're specifying in the Quantity element and the number of values \n\t\t\t\tspecified.

\n\t\t ", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/streaming-distribution", "code": 201 } } @@ -2217,13 +2380,6 @@ "com.amazonaws.cloudfront#CreateStreamingDistributionResult": { "type": "structure", "members": { - "Location": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The fully qualified URI of the new streaming distribution resource just created.

", - "smithy.api#httpHeader": "Location" - } - }, "StreamingDistribution": { "target": "com.amazonaws.cloudfront#StreamingDistribution", "traits": { @@ -2231,6 +2387,13 @@ "smithy.api#httpPayload": {} } }, + "Location": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The fully qualified URI of the new streaming distribution resource just created.

", + "smithy.api#httpHeader": "Location" + } + }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -2320,13 +2483,6 @@ "com.amazonaws.cloudfront#CreateStreamingDistributionWithTagsResult": { "type": "structure", "members": { - "StreamingDistribution": { - "target": "com.amazonaws.cloudfront#StreamingDistribution", - "traits": { - "smithy.api#documentation": "

The streaming distribution's information.

", - "smithy.api#httpPayload": {} - } - }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -2334,6 +2490,13 @@ "smithy.api#httpHeader": "Location" } }, + "StreamingDistribution": { + "target": "com.amazonaws.cloudfront#StreamingDistribution", + "traits": { + "smithy.api#documentation": "

The streaming distribution's information.

", + "smithy.api#httpPayload": {} + } + }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -2349,6 +2512,12 @@ "com.amazonaws.cloudfront#CustomErrorResponse": { "type": "structure", "members": { + "ResponseCode": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The HTTP status code that you want CloudFront to return to the viewer along with the custom \n\t\t\terror page. There are a variety of reasons that you might want CloudFront to return a status code \n\t\t\tdifferent from the status code that your origin returned to CloudFront, for example:

\n\t\t \n\t\t

If you specify a value for ResponseCode, you must also specify a value for\n\t\t\tResponsePagePath.

" + } + }, "ErrorCode": { "target": "com.amazonaws.cloudfront#integer", "traits": { @@ -2356,22 +2525,16 @@ "smithy.api#required": {} } }, - "ErrorCachingMinTTL": { - "target": "com.amazonaws.cloudfront#long", - "traits": { - "smithy.api#documentation": "

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status \n\t\t\tcode specified in ErrorCode. When this time period has elapsed, CloudFront queries your \n\t\t\torigin to see whether the problem that caused the error has been resolved and the requested \n\t\t\tobject is now available.

\n\t\t

For more information, see Customizing \n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.

" - } - }, - "ResponseCode": { + "ResponsePagePath": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The HTTP status code that you want CloudFront to return to the viewer along with the custom \n\t\t\terror page. There are a variety of reasons that you might want CloudFront to return a status code \n\t\t\tdifferent from the status code that your origin returned to CloudFront, for example:

\n\t\t \n\t\t

If you specify a value for ResponseCode, you must also specify a value for\n\t\t\tResponsePagePath.

" + "smithy.api#documentation": "

The path to the custom error page that you want CloudFront to return to a viewer when your \n\t\t\torigin returns the HTTP status code specified by ErrorCode, for example, \n\t\t\t\t/4xx-errors/403-forbidden.html. If you want to store your objects and your \n\t\t\tcustom error pages in different locations, your distribution must include a cache behavior for \n\t\t\twhich the following is true:

\n\t\t \n\t\t

If you specify a value for ResponsePagePath, you must also specify a value\n\t\t\tfor ResponseCode.

\n\t\t

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom \n\t\t\terror pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the \n\t\t\tfiles that you want to return to viewers because the origin server is unavailable.

" } }, - "ResponsePagePath": { - "target": "com.amazonaws.cloudfront#string", + "ErrorCachingMinTTL": { + "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The path to the custom error page that you want CloudFront to return to a viewer when your \n\t\t\torigin returns the HTTP status code specified by ErrorCode, for example, \n\t\t\t\t/4xx-errors/403-forbidden.html. If you want to store your objects and your \n\t\t\tcustom error pages in different locations, your distribution must include a cache behavior for \n\t\t\twhich the following is true:

\n\t\t \n\t\t

If you specify a value for ResponsePagePath, you must also specify a value\n\t\t\tfor ResponseCode.

\n\t\t

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom \n\t\t\terror pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the \n\t\t\tfiles that you want to return to viewers because the origin server is unavailable.

" + "smithy.api#documentation": "

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status \n\t\t\tcode specified in ErrorCode. When this time period has elapsed, CloudFront queries your \n\t\t\torigin to see whether the problem that caused the error has been resolved and the requested \n\t\t\tobject is now available.

\n\t\t

For more information, see Customizing \n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.

" } } }, @@ -2391,18 +2554,18 @@ "com.amazonaws.cloudfront#CustomErrorResponses": { "type": "structure", "members": { + "Items": { + "target": "com.amazonaws.cloudfront#CustomErrorResponseList", + "traits": { + "smithy.api#documentation": "

A complex type that contains a CustomErrorResponse element for each HTTP \n\t\t\tstatus code for which you want to specify a custom error page and/or a caching duration. \n\t\t

" + } + }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

The number of HTTP status codes for which you want to specify a custom error page \n\t\t\tand/or a caching duration. If Quantity is 0, you can omit \n\t\t\t\tItems.

", "smithy.api#required": {} } - }, - "Items": { - "target": "com.amazonaws.cloudfront#CustomErrorResponseList", - "traits": { - "smithy.api#documentation": "

A complex type that contains a CustomErrorResponse element for each HTTP \n\t\t\tstatus code for which you want to specify a custom error page and/or a caching duration. \n\t\t

" - } } }, "traits": { @@ -2433,10 +2596,10 @@ "com.amazonaws.cloudfront#CustomOriginConfig": { "type": "structure", "members": { - "OriginProtocolPolicy": { - "target": "com.amazonaws.cloudfront#OriginProtocolPolicy", + "HTTPSPort": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values\n\t\t\tare:

\n\t\t ", + "smithy.api#documentation": "

The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the\n\t\t\torigin listens on.

", "smithy.api#required": {} } }, @@ -2447,17 +2610,17 @@ "smithy.api#required": {} } }, - "HTTPSPort": { + "OriginKeepaliveTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the\n\t\t\torigin listens on.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum\n\t\t\ttimeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify\n\t\t\totherwise) is 5 seconds.

\n\t\t

For more information, see Origin Keep-alive Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, - "OriginKeepaliveTimeout": { - "target": "com.amazonaws.cloudfront#integer", + "OriginProtocolPolicy": { + "target": "com.amazonaws.cloudfront#OriginProtocolPolicy", "traits": { - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum\n\t\t\ttimeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify\n\t\t\totherwise) is 5 seconds.

\n\t\t

For more information, see Origin Keep-alive Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values\n\t\t\tare:

\n\t\t ", + "smithy.api#required": {} } }, "OriginSslProtocols": { @@ -2480,24 +2643,30 @@ "com.amazonaws.cloudfront#DefaultCacheBehavior": { "type": "structure", "members": { - "CachePolicyId": { + "OriginRequestPolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to the default cache behavior.\n\t\t\tFor more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to the default cache\n\t\t\tbehavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, - "TrustedSigners": { - "target": "com.amazonaws.cloudfront#TrustedSigners", + "FieldLevelEncryptionId": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to\n\t\t\tcreate signed URLs for private content.

\n\t\t

If you want to require signed URLs in requests for objects in the target origin that\n\t\t\tmatch the PathPattern for this cache behavior, specify true\n\t\t\tfor Enabled, and specify the applicable values for Quantity\n\t\t\tand Items. For more information, see Serving Private Content\n\t\t\twith Signed URLs and Signed Cookies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you don’t want to require signed URLs in requests for objects that match\n\t\t\t\tPathPattern, specify false for Enabled and \n\t\t\t\t0 for Quantity. Omit Items.

\n\t\t

To add, change, or remove one or more trusted signers, change Enabled to\n\t\t\ttrue (if it’s currently false), change Quantity\n\t\t\tas applicable, and specify all of the trusted signers that you want to include in the\n\t\t\tupdated distribution.

", + "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for the default cache behavior.

" + } + }, + "ViewerProtocolPolicy": { + "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", + "traits": { + "smithy.api#documentation": "

The protocol that viewers can use to access the files in the origin specified by \n\t\t\t\tTargetOriginId when a request matches the path pattern in \n\t\t\t\tPathPattern. You can specify the following options:

\n\t\t \n\t\t

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

\n\t\t \n\t\t\t

The only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects’ cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\tManaging Cache\n\t\t\t\tExpiration in the \n\t\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t ", "smithy.api#required": {} } }, - "MinTTL": { + "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

\n\t\t

You must specify 0 for MinTTL if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers, if you specify 1 \n\t\t\tfor Quantity and * for Name).

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } }, "MaxTTL": { @@ -2507,14 +2676,31 @@ "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin adds HTTP headers such as \n\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } }, - "Compress": { + "SmoothStreaming": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true; if not, specify false. For more information, \n\t\t\tsee Serving Compressed Files in \n\t\t\tthe Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue; if not, specify false. If you specify true for \n\t\t\t\tSmoothStreaming, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern.

" } }, - "AllowedMethods": { - "target": "com.amazonaws.cloudfront#AllowedMethods" + "TrustedSigners": { + "target": "com.amazonaws.cloudfront#TrustedSigners", + "traits": { + "smithy.api#documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to\n\t\t\tcreate signed URLs for private content.

\n\t\t

If you want to require signed URLs in requests for objects in the target origin that\n\t\t\tmatch the PathPattern for this cache behavior, specify true\n\t\t\tfor Enabled, and specify the applicable values for Quantity\n\t\t\tand Items. For more information, see Serving Private Content\n\t\t\twith Signed URLs and Signed Cookies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you don’t want to require signed URLs in requests for objects that match\n\t\t\t\tPathPattern, specify false for Enabled and \n\t\t\t\t0 for Quantity. Omit Items.

\n\t\t

To add, change, or remove one or more trusted signers, change Enabled to\n\t\t\ttrue (if it’s currently false), change Quantity\n\t\t\tas applicable, and specify all of the trusted signers that you want to include in the\n\t\t\tupdated distribution.

", + "smithy.api#required": {} + } + }, + "RealtimeLogConfigArn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this\n\t\t\tcache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

" + } + }, + "MinTTL": { + "target": "com.amazonaws.cloudfront#long", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

\n\t\t

You must specify 0 for MinTTL if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers, if you specify 1 \n\t\t\tfor Quantity and * for Name).

" + } }, "LambdaFunctionAssociations": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociations", @@ -2522,10 +2708,10 @@ "smithy.api#documentation": "

A complex type that contains zero or more Lambda function associations for a cache \n\t\t\tbehavior.

" } }, - "OriginRequestPolicyId": { + "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to the default cache\n\t\t\tbehavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to the default cache behavior.\n\t\t\tFor more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, "TargetOriginId": { @@ -2542,31 +2728,14 @@ "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin request\n\t\t\tpolicy instead of this field. For more information, see Working with policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to include values in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

" } }, - "DefaultTTL": { - "target": "com.amazonaws.cloudfront#long", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" - } - }, - "FieldLevelEncryptionId": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for the default cache behavior.

" - } - }, - "ViewerProtocolPolicy": { - "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", - "traits": { - "smithy.api#documentation": "

The protocol that viewers can use to access the files in the origin specified by \n\t\t\t\tTargetOriginId when a request matches the path pattern in \n\t\t\t\tPathPattern. You can specify the following options:

\n\t\t \n\t\t

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

\n\t\t \n\t\t\t

The only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects’ cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\tManaging Cache\n\t\t\t\tExpiration in the \n\t\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t ", - "smithy.api#required": {} - } - }, - "SmoothStreaming": { + "Compress": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue; if not, specify false. If you specify true for \n\t\t\t\tSmoothStreaming, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern.

" + "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true; if not, specify false. For more information, \n\t\t\tsee Serving Compressed Files in \n\t\t\tthe Amazon CloudFront Developer Guide.

" } + }, + "AllowedMethods": { + "target": "com.amazonaws.cloudfront#AllowedMethods" } }, "traits": { @@ -2837,57 +3006,99 @@ } } }, - "com.amazonaws.cloudfront#DeleteOriginRequestPolicy": { + "com.amazonaws.cloudfront#DeleteMonitoringSubscription": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#DeleteOriginRequestPolicyRequest" + "target": "com.amazonaws.cloudfront#DeleteMonitoringSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#DeleteMonitoringSubscriptionResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { - "target": "com.amazonaws.cloudfront#IllegalDelete" - }, - { - "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" - }, - { - "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" - }, - { - "target": "com.amazonaws.cloudfront#OriginRequestPolicyInUse" - }, - { - "target": "com.amazonaws.cloudfront#PreconditionFailed" + "target": "com.amazonaws.cloudfront#NoSuchDistribution" } ], "traits": { - "smithy.api#documentation": "

Deletes an origin request policy.

\n\t\t

You cannot delete an origin request policy if it’s attached to any cache behaviors. First\n\t\t\tupdate your distributions to remove the origin request policy from all cache behaviors,\n\t\t\tthen delete the origin request policy.

\n\t\t

To delete an origin request policy, you must provide the policy’s identifier and version. To\n\t\t\tget the identifier, you can use ListOriginRequestPolicies or\n\t\t\tGetOriginRequestPolicy.

", + "smithy.api#documentation": "

Disables additional CloudWatch metrics for the specified CloudFront distribution.

", "smithy.api#http": { "method": "DELETE", - "uri": "/2020-05-31/origin-request-policy/{Id}", - "code": 204 + "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", + "code": 200 } } }, - "com.amazonaws.cloudfront#DeleteOriginRequestPolicyRequest": { + "com.amazonaws.cloudfront#DeleteMonitoringSubscriptionRequest": { "type": "structure", "members": { - "Id": { + "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the origin request policy that you are deleting. To get the\n\t\t\tidentifier, you can use ListOriginRequestPolicies.

", + "smithy.api#documentation": "

The ID of the distribution that you are disabling metrics for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + } + } + }, + "com.amazonaws.cloudfront#DeleteMonitoringSubscriptionResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.cloudfront#DeleteOriginRequestPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#DeleteOriginRequestPolicyRequest" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" }, + { + "target": "com.amazonaws.cloudfront#IllegalDelete" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" + }, + { + "target": "com.amazonaws.cloudfront#OriginRequestPolicyInUse" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an origin request policy.

\n\t\t

You cannot delete an origin request policy if it’s attached to any cache behaviors. First\n\t\t\tupdate your distributions to remove the origin request policy from all cache behaviors,\n\t\t\tthen delete the origin request policy.

\n\t\t

To delete an origin request policy, you must provide the policy’s identifier and version. To\n\t\t\tget the identifier, you can use ListOriginRequestPolicies or\n\t\t\tGetOriginRequestPolicy.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2020-05-31/origin-request-policy/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.cloudfront#DeleteOriginRequestPolicyRequest": { + "type": "structure", + "members": { "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The version of the origin request policy that you are deleting. The version is the origin\n\t\t\trequest policy’s ETag value, which you can get using\n\t\t\tListOriginRequestPolicies, GetOriginRequestPolicy, or\n\t\t\tGetOriginRequestPolicyConfig.

", "smithy.api#httpHeader": "If-Match" } + }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the origin request policy that you are deleting. To get the\n\t\t\tidentifier, you can use ListOriginRequestPolicies.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -2942,6 +3153,48 @@ } } }, + "com.amazonaws.cloudfront#DeleteRealtimeLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#DeleteRealtimeLogConfigRequest" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" + }, + { + "target": "com.amazonaws.cloudfront#RealtimeLogConfigInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a real-time log configuration.

\n\t\t

You cannot delete a real-time log configuration if it’s attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the real-time log configuration from all cache\n\t\t\tbehaviors, then delete the real-time log configuration.

\n\t\t

To delete a real-time log configuration, you can provide the configuration’s name or its\n\t\t\tAmazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront\n\t\t\tuses the name to identify the real-time log configuration to delete.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/delete-realtime-log-config", + "code": 204 + } + } + }, + "com.amazonaws.cloudfront#DeleteRealtimeLogConfigRequest": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration to delete.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The name of the real-time log configuration to delete.

" + } + } + } + }, "com.amazonaws.cloudfront#DeleteStreamingDistribution": { "type": "operation", "input": { @@ -2999,24 +3252,10 @@ "com.amazonaws.cloudfront#Distribution": { "type": "structure", "members": { - "DomainName": { + "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.cloudfront#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time the distribution was last modified.

", - "smithy.api#required": {} - } - }, - "ActiveTrustedSigners": { - "target": "com.amazonaws.cloudfront#ActiveTrustedSigners", - "traits": { - "smithy.api#documentation": "

CloudFront automatically adds this element to the response only if you've set up the \n\t\t\tdistribution to serve private content with signed URLs. The element lists the key pair IDs \n\t\t\tthat CloudFront is aware of for each trusted signer. The Signer child element lists the \n\t\t\tAWS account number of the trusted signer (or an empty Self element if the \n\t\t\tsigner is you). The Signer element also includes the IDs of any active key pairs \n\t\t\tassociated with the trusted signer's AWS account. If no KeyPairId element \n\t\t\tappears for a Signer, that signer can't create working signed URLs.

", + "smithy.api#documentation": "

This response element indicates the current status of the distribution. When the status \n\t\t\tis Deployed, the distribution's information is fully propagated to all CloudFront edge \n\t\t\tlocations.

", "smithy.api#required": {} } }, @@ -3033,10 +3272,10 @@ "smithy.api#documentation": "

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions.

\n\t\t

For more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with AWS services in China.

" } }, - "ARN": { - "target": "com.amazonaws.cloudfront#string", + "ActiveTrustedSigners": { + "target": "com.amazonaws.cloudfront#ActiveTrustedSigners", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your AWS account ID.

", + "smithy.api#documentation": "

CloudFront automatically adds this element to the response only if you've set up the \n\t\t\tdistribution to serve private content with signed URLs. The element lists the key pair IDs \n\t\t\tthat CloudFront is aware of for each trusted signer. The Signer child element lists the \n\t\t\tAWS account number of the trusted signer (or an empty Self element if the \n\t\t\tsigner is you). The Signer element also includes the IDs of any active key pairs \n\t\t\tassociated with the trusted signer's AWS account. If no KeyPairId element \n\t\t\tappears for a Signer, that signer can't create working signed URLs.

", "smithy.api#required": {} } }, @@ -3047,10 +3286,17 @@ "smithy.api#required": {} } }, - "Status": { + "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

This response element indicates the current status of the distribution. When the status \n\t\t\tis Deployed, the distribution's information is fully propagated to all CloudFront edge \n\t\t\tlocations.

", + "smithy.api#documentation": "

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your AWS account ID.

", "smithy.api#required": {} } }, @@ -3060,6 +3306,13 @@ "smithy.api#documentation": "

The current configuration information for the distribution. Send a GET \n\t\t\trequest to the /CloudFront API version/distribution ID/config \n\t\t\tresource.

", "smithy.api#required": {} } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the distribution was last modified.

", + "smithy.api#required": {} + } } }, "traits": { @@ -3082,30 +3335,22 @@ "com.amazonaws.cloudfront#DistributionConfig": { "type": "structure", "members": { - "ViewerCertificate": { - "target": "com.amazonaws.cloudfront#ViewerCertificate", - "traits": { - "smithy.api#documentation": "

A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

" - } - }, - "Origins": { - "target": "com.amazonaws.cloudfront#Origins", + "Restrictions": { + "target": "com.amazonaws.cloudfront#Restrictions", "traits": { - "smithy.api#documentation": "

A complex type that contains information about origins for this distribution. \n\t\t

", - "smithy.api#required": {} + "smithy.api#documentation": "

A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.

" } }, - "Logging": { - "target": "com.amazonaws.cloudfront#LoggingConfig", + "WebACLId": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex type that controls whether access logs are written for the \n\t\t\tdistribution.

\n\t\t

For more information about logging, see Access \n\t\t\t\tLogs in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A unique identifier that specifies the AWS WAF web ACL, if any, to associate\n\t\t\twith this distribution. To specify a web ACL created using the latest version of AWS\n\t\t\tWAF, use the ACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using AWS WAF Classic, use the ACL ID, for example\n\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.

\n\t\t

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS \n\t\t\trequests that are forwarded to CloudFront, and lets you control access to your content. Based on \n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or the \n\t\t\tvalues of query strings, CloudFront responds to requests either with the requested content or with \n\t\t\tan HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page \n\t\t\twhen a request is blocked. For more information about AWS WAF, see the AWS WAF \n\t\t\t\tDeveloper Guide.

" } }, - "Comment": { - "target": "com.amazonaws.cloudfront#CommentType", + "HttpVersion": { + "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { - "smithy.api#documentation": "

Any comments you want to include about the distribution.

\n\t\t

If you don't want to specify a comment, include an empty Comment \n\t\t\telement.

\n\t\t

To delete an existing comment, update the distribution configuration and include an \n\t\t\tempty Comment element.

\n\t\t

To add or change a comment, update the distribution configuration and specify the new \n\t\t\tcomment.

", - "smithy.api#required": {} + "smithy.api#documentation": "

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate \n\t\t\twith CloudFront. The default value for new web distributions is http2. Viewers that don't support \n\t\t\tHTTP/2 automatically use an earlier HTTP version.

\n\t\t

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must \n\t\t\tsupport Server Name Identification (SNI).

\n\t\t

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. \n\t\t\tYou can improve performance by optimizing for HTTP/2. For more information, do an Internet \n\t\t\tsearch for \"http/2 optimization.\"

" } }, "DefaultRootObject": { @@ -3114,16 +3359,22 @@ "smithy.api#documentation": "

The object that you want CloudFront to request from your origin (for example, \n\t\t\t\tindex.html) when a viewer requests the root URL for your distribution \n\t\t\t\t(http://www.example.com) instead of an object in your distribution \n\t\t\t\t(http://www.example.com/product-description.html). Specifying a default root \n\t\t\tobject avoids exposing the contents of your distribution.

\n\t\t

Specify only the object name, for example, index.html. Don't add a \n\t\t\t\t/ before the object name.

\n\t\t

If you don't want to specify a default root object when you create a distribution, \n\t\t\tinclude an empty DefaultRootObject element.

\n\t\t

To delete the default root object from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty DefaultRootObject \n\t\t\telement.

\n\t\t

To replace the default root object, update the distribution configuration and specify \n\t\t\tthe new object.

\n\t\t

For more information about the default root object, see Creating a Default Root Object in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, - "HttpVersion": { - "target": "com.amazonaws.cloudfront#HttpVersion", + "CustomErrorResponses": { + "target": "com.amazonaws.cloudfront#CustomErrorResponses", "traits": { - "smithy.api#documentation": "

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate \n\t\t\twith CloudFront. The default value for new web distributions is http2. Viewers that don't support \n\t\t\tHTTP/2 automatically use an earlier HTTP version.

\n\t\t

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must \n\t\t\tsupport Server Name Identification (SNI).

\n\t\t

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. \n\t\t\tYou can improve performance by optimizing for HTTP/2. For more information, do an Internet \n\t\t\tsearch for \"http/2 optimization.\"

" + "smithy.api#documentation": "

A complex type that controls the following:

\n\t\t \n\t\t

For more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, - "PriceClass": { - "target": "com.amazonaws.cloudfront#PriceClass", + "OriginGroups": { + "target": "com.amazonaws.cloudfront#OriginGroups", "traits": { - "smithy.api#documentation": "

The price class that corresponds with the maximum price that you want to pay for CloudFront \n\t\t\tservice. If you specify PriceClass_All, CloudFront responds to requests for your \n\t\t\tobjects from all CloudFront edge locations.

\n\t\t

If you specify a price class other than PriceClass_All, CloudFront serves your \n\t\t\tobjects from the CloudFront edge location that has the lowest latency among the edge locations in \n\t\t\tyour price class. Viewers who are in or near regions that are excluded from your specified \n\t\t\tprice class may encounter slower performance.

\n\t\t

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the \n\t\t\tAmazon CloudFront Developer Guide. For information about CloudFront pricing, including how price \n\t\t\tclasses (such as Price Class 100) map to CloudFront regions, see \n\t\t\tAmazon CloudFront Pricing. \n\t\t\tFor price class information, scroll down to see the table at the bottom of the page.

" + "smithy.api#documentation": "

A complex type that contains information about origin groups for this \n\t\t\tdistribution.

" + } + }, + "Logging": { + "target": "com.amazonaws.cloudfront#LoggingConfig", + "traits": { + "smithy.api#documentation": "

A complex type that controls whether access logs are written for the \n\t\t\tdistribution.

\n\t\t

For more information about logging, see Access \n\t\t\t\tLogs in the Amazon CloudFront Developer Guide.

" } }, "CacheBehaviors": { @@ -3132,41 +3383,43 @@ "smithy.api#documentation": "

A complex type that contains zero or more CacheBehavior elements. \n\t\t

" } }, - "WebACLId": { - "target": "com.amazonaws.cloudfront#string", + "Comment": { + "target": "com.amazonaws.cloudfront#CommentType", "traits": { - "smithy.api#documentation": "

A unique identifier that specifies the AWS WAF web ACL, if any, to associate\n\t\t\twith this distribution. To specify a web ACL created using the latest version of AWS\n\t\t\tWAF, use the ACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using AWS WAF Classic, use the ACL ID, for example\n\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.

\n\t\t

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS \n\t\t\trequests that are forwarded to CloudFront, and lets you control access to your content. Based on \n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or the \n\t\t\tvalues of query strings, CloudFront responds to requests either with the requested content or with \n\t\t\tan HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page \n\t\t\twhen a request is blocked. For more information about AWS WAF, see the AWS WAF \n\t\t\t\tDeveloper Guide.

" + "smithy.api#documentation": "

Any comments you want to include about the distribution.

\n\t\t

If you don't want to specify a comment, include an empty Comment \n\t\t\telement.

\n\t\t

To delete an existing comment, update the distribution configuration and include an \n\t\t\tempty Comment element.

\n\t\t

To add or change a comment, update the distribution configuration and specify the new \n\t\t\tcomment.

", + "smithy.api#required": {} } }, - "Aliases": { - "target": "com.amazonaws.cloudfront#Aliases", + "Origins": { + "target": "com.amazonaws.cloudfront#Origins", "traits": { - "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.

" + "smithy.api#documentation": "

A complex type that contains information about origins for this distribution. \n\t\t

", + "smithy.api#required": {} } }, - "CustomErrorResponses": { - "target": "com.amazonaws.cloudfront#CustomErrorResponses", + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A complex type that controls the following:

\n\t\t \n\t\t

For more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

From this field, you can enable or disable the selected distribution.

", + "smithy.api#required": {} } }, - "OriginGroups": { - "target": "com.amazonaws.cloudfront#OriginGroups", + "ViewerCertificate": { + "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { - "smithy.api#documentation": "

A complex type that contains information about origin groups for this \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

" } }, - "Restrictions": { - "target": "com.amazonaws.cloudfront#Restrictions", + "IsIPV6Enabled": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.

" + "smithy.api#documentation": "

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution, specify true. If you specify false, CloudFront responds to \n\t\t\tIPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. \n\t\t\tThis allows viewers to submit a second request, for an IPv4 address for your distribution.

\n\t\t

In general, you should enable IPv6 if you have users on IPv6 networks who want to \n\t\t\taccess your content. However, if you're using signed URLs or signed cookies to restrict access \n\t\t\tto your content, and if you're using a custom policy that includes the IpAddress \n\t\t\tparameter to restrict the IP addresses that can access your content, don't enable IPv6. If \n\t\t\tyou want to restrict access to some content by IP address and not restrict access to other \n\t\t\tcontent (or restrict access but not by IP address), you can create two distributions. For more \n\t\t\tinformation, see \n\t\t\tCreating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer \n\t\t\t\tGuide.

\n\t\t

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront \n\t\t\tdistribution, you need to create a second alias resource record set when both of the following \n\t\t\tare true:

\n\t\t \n\t\t

For more information, see Routing Traffic \n\t\t\t\tto an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 \n\t\t\t\tDeveloper Guide.

\n\t\t

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS \n\t\t\tservice, you don't need to make any changes. A CNAME record will route traffic to your \n\t\t\tdistribution regardless of the IP address format of the viewer request.

" } }, - "Enabled": { - "target": "com.amazonaws.cloudfront#boolean", + "PriceClass": { + "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

From this field, you can enable or disable the selected distribution.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The price class that corresponds with the maximum price that you want to pay for CloudFront \n\t\t\tservice. If you specify PriceClass_All, CloudFront responds to requests for your \n\t\t\tobjects from all CloudFront edge locations.

\n\t\t

If you specify a price class other than PriceClass_All, CloudFront serves your \n\t\t\tobjects from the CloudFront edge location that has the lowest latency among the edge locations in \n\t\t\tyour price class. Viewers who are in or near regions that are excluded from your specified \n\t\t\tprice class may encounter slower performance.

\n\t\t

For more information about price classes, see Choosing the Price Class\n\t\t\tfor a CloudFront Distribution in the Amazon CloudFront Developer Guide. For\n\t\t\tinformation about CloudFront pricing, including how price classes (such as Price Class 100)\n\t\t\tmap to CloudFront regions, see Amazon CloudFront\n\t\t\tPricing.

" } }, "DefaultCacheBehavior": { @@ -3183,10 +3436,10 @@ "smithy.api#required": {} } }, - "IsIPV6Enabled": { - "target": "com.amazonaws.cloudfront#boolean", + "Aliases": { + "target": "com.amazonaws.cloudfront#Aliases", "traits": { - "smithy.api#documentation": "

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution, specify true. If you specify false, CloudFront responds to \n\t\t\tIPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. \n\t\t\tThis allows viewers to submit a second request, for an IPv4 address for your distribution.

\n\t\t

In general, you should enable IPv6 if you have users on IPv6 networks who want to \n\t\t\taccess your content. However, if you're using signed URLs or signed cookies to restrict access \n\t\t\tto your content, and if you're using a custom policy that includes the IpAddress \n\t\t\tparameter to restrict the IP addresses that can access your content, don't enable IPv6. If \n\t\t\tyou want to restrict access to some content by IP address and not restrict access to other \n\t\t\tcontent (or restrict access but not by IP address), you can create two distributions. For more \n\t\t\tinformation, see \n\t\t\tCreating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer \n\t\t\t\tGuide.

\n\t\t

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront \n\t\t\tdistribution, you need to create a second alias resource record set when both of the following \n\t\t\tare true:

\n\t\t \n\t\t

For more information, see Routing Traffic \n\t\t\t\tto an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 \n\t\t\t\tDeveloper Guide.

\n\t\t

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS \n\t\t\tservice, you don't need to make any changes. A CNAME record will route traffic to your \n\t\t\tdistribution regardless of the IP address format of the viewer request.

" + "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.

" } } }, @@ -3197,17 +3450,17 @@ "com.amazonaws.cloudfront#DistributionConfigWithTags": { "type": "structure", "members": { - "DistributionConfig": { - "target": "com.amazonaws.cloudfront#DistributionConfig", + "Tags": { + "target": "com.amazonaws.cloudfront#Tags", "traits": { - "smithy.api#documentation": "

A distribution configuration.

", + "smithy.api#documentation": "

A complex type that contains zero or more Tag elements.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.cloudfront#Tags", + "DistributionConfig": { + "target": "com.amazonaws.cloudfront#DistributionConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more Tag elements.

", + "smithy.api#documentation": "

A distribution configuration.

", "smithy.api#required": {} } } @@ -3219,17 +3472,18 @@ "com.amazonaws.cloudfront#DistributionIdList": { "type": "structure", "members": { - "Quantity": { + "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The total number of distribution IDs returned in the response.

", + "smithy.api#documentation": "

The maximum number of distribution IDs requested.

", "smithy.api#required": {} } }, - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", + "IsTruncated": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing distribution IDs where you left off.

" + "smithy.api#documentation": "

A flag that indicates whether more distribution IDs remain to be listed. If your\n\t\t\tresults were truncated, you can make a subsequent request using the Marker\n\t\t\trequest field to retrieve more distribution IDs in the list.

", + "smithy.api#required": {} } }, "Items": { @@ -3245,18 +3499,17 @@ "smithy.api#required": {} } }, - "IsTruncated": { - "target": "com.amazonaws.cloudfront#boolean", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more distribution IDs remain to be listed. If your\n\t\t\tresults were truncated, you can make a subsequent request using the Marker\n\t\t\trequest field to retrieve more distribution IDs in the list.

", + "smithy.api#documentation": "

The total number of distribution IDs returned in the response.

", "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.cloudfront#integer", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The maximum number of distribution IDs requested.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing distribution IDs where you left off.

" } } }, @@ -3276,18 +3529,10 @@ "com.amazonaws.cloudfront#DistributionList": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.cloudfront#integer", - "traits": { - "smithy.api#documentation": "

The value you provided for the MaxItems request parameter.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.cloudfront#boolean", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more distributions remain to be listed. If your results \n\t\t\twere truncated, you can make a follow-up pagination request using the Marker \n\t\t\trequest parameter to retrieve more distributions in the list.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\tdistributions where they left off.

" } }, "Items": { @@ -3296,10 +3541,11 @@ "smithy.api#documentation": "

A complex type that contains one DistributionSummary element for each \n\t\t\tdistribution that was created by the current AWS account.

" } }, - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", + "IsTruncated": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\tdistributions where they left off.

" + "smithy.api#documentation": "

A flag that indicates whether more distributions remain to be listed. If your results \n\t\t\twere truncated, you can make a follow-up pagination request using the Marker \n\t\t\trequest parameter to retrieve more distributions in the list.

", + "smithy.api#required": {} } }, "Marker": { @@ -3309,6 +3555,13 @@ "smithy.api#required": {} } }, + "MaxItems": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

The value you provided for the MaxItems request parameter.

", + "smithy.api#required": {} + } + }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { @@ -3337,24 +3590,39 @@ "com.amazonaws.cloudfront#DistributionSummary": { "type": "structure", "members": { - "ARN": { + "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your AWS account ID.

", + "smithy.api#documentation": "

The Web ACL Id (if any) associated with the distribution.

", "smithy.api#required": {} } }, - "Id": { + "Aliases": { + "target": "com.amazonaws.cloudfront#Aliases", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.

", + "smithy.api#required": {} + } + }, + "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the distribution. For example: \n\t\t\tEDFDVBD632BHDS5.

", + "smithy.api#documentation": "

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

", "smithy.api#required": {} } }, - "OriginGroups": { - "target": "com.amazonaws.cloudfront#OriginGroups", + "ViewerCertificate": { + "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { - "smithy.api#documentation": "

A complex type that contains information about origin groups for this \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

", + "smithy.api#required": {} + } + }, + "IsIPV6Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution.

", + "smithy.api#required": {} } }, "DefaultCacheBehavior": { @@ -3364,6 +3632,20 @@ "smithy.api#required": {} } }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The identifier for the distribution. For example: \n\t\t\tEDFDVBD632BHDS5.

", + "smithy.api#required": {} + } + }, + "CustomErrorResponses": { + "target": "com.amazonaws.cloudfront#CustomErrorResponses", + "traits": { + "smithy.api#documentation": "

A complex type that contains zero or more CustomErrorResponses \n\t\t\telements.

", + "smithy.api#required": {} + } + }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { @@ -3371,10 +3653,23 @@ "smithy.api#required": {} } }, - "CustomErrorResponses": { - "target": "com.amazonaws.cloudfront#CustomErrorResponses", + "OriginGroups": { + "target": "com.amazonaws.cloudfront#OriginGroups", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about origin groups for this \n\t\t\tdistribution.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current status of the distribution. When the status is Deployed, the \n\t\t\tdistribution's information is propagated to all CloudFront edge locations.

", + "smithy.api#required": {} + } + }, + "CacheBehaviors": { + "target": "com.amazonaws.cloudfront#CacheBehaviors", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more CustomErrorResponses \n\t\t\telements.

", + "smithy.api#documentation": "

A complex type that contains zero or more CacheBehavior \n\t\t\telements.

", "smithy.api#required": {} } }, @@ -3385,13 +3680,6 @@ "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.cloudfront#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time the distribution was last modified.

", - "smithy.api#required": {} - } - }, "Origins": { "target": "com.amazonaws.cloudfront#Origins", "traits": { @@ -3399,13 +3687,6 @@ "smithy.api#required": {} } }, - "CacheBehaviors": { - "target": "com.amazonaws.cloudfront#CacheBehaviors", - "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more CacheBehavior \n\t\t\telements.

", - "smithy.api#required": {} - } - }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { @@ -3420,30 +3701,10 @@ "smithy.api#required": {} } }, - "IsIPV6Enabled": { - "target": "com.amazonaws.cloudfront#boolean", - "traits": { - "smithy.api#documentation": "

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution.

", - "smithy.api#required": {} - } - }, - "ViewerCertificate": { - "target": "com.amazonaws.cloudfront#ViewerCertificate", - "traits": { - "smithy.api#documentation": "

A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

", - "smithy.api#required": {} - } - }, - "AliasICPRecordals": { - "target": "com.amazonaws.cloudfront#AliasICPRecordals", - "traits": { - "smithy.api#documentation": "

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions.

\n\t\t

For more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with AWS services in China.

" - } - }, - "Status": { + "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current status of the distribution. When the status is Deployed, the \n\t\t\tdistribution's information is propagated to all CloudFront edge locations.

", + "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your AWS account ID.

", "smithy.api#required": {} } }, @@ -3454,24 +3715,16 @@ "smithy.api#required": {} } }, - "WebACLId": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The Web ACL Id (if any) associated with the distribution.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.cloudfront#string", + "AliasICPRecordals": { + "target": "com.amazonaws.cloudfront#AliasICPRecordals", "traits": { - "smithy.api#documentation": "

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

", - "smithy.api#required": {} + "smithy.api#documentation": "

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions.

\n\t\t

For more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with AWS services in China.

" } }, - "Aliases": { - "target": "com.amazonaws.cloudfront#Aliases", + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.

", + "smithy.api#documentation": "

The date and time the distribution was last modified.

", "smithy.api#required": {} } } @@ -3492,18 +3745,18 @@ "com.amazonaws.cloudfront#EncryptionEntities": { "type": "structure", "members": { + "Items": { + "target": "com.amazonaws.cloudfront#EncryptionEntityList", + "traits": { + "smithy.api#documentation": "

An array of field patterns in a field-level encryption content type-profile mapping.

" + } + }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

Number of field pattern items in a field-level encryption content type-profile mapping.

", "smithy.api#required": {} } - }, - "Items": { - "target": "com.amazonaws.cloudfront#EncryptionEntityList", - "traits": { - "smithy.api#documentation": "

An array of field patterns in a field-level encryption content type-profile mapping.

" - } } }, "traits": { @@ -3513,10 +3766,10 @@ "com.amazonaws.cloudfront#EncryptionEntity": { "type": "structure", "members": { - "ProviderId": { + "PublicKeyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The provider associated with the public key being used for encryption. This value must also be provided with the private key\n\t\tfor applications to be able to decrypt data.

", + "smithy.api#documentation": "

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match\n\t\t\tthe patterns.

", "smithy.api#required": {} } }, @@ -3527,10 +3780,10 @@ "smithy.api#required": {} } }, - "PublicKeyId": { + "ProviderId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match\n\t\t\tthe patterns.

", + "smithy.api#documentation": "

The provider associated with the public key being used for encryption. This value must also be provided with the private key\n\t\tfor applications to be able to decrypt data.

", "smithy.api#required": {} } } @@ -3548,6 +3801,33 @@ } } }, + "com.amazonaws.cloudfront#EndPoint": { + "type": "structure", + "members": { + "KinesisStreamConfig": { + "target": "com.amazonaws.cloudfront#KinesisStreamConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending\n\t\t\treal-time log data.

" + } + }, + "StreamType": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The type of data stream where you are sending real-time log data. The only valid value is\n\t\t\tKinesis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data in a real-time log configuration.

" + } + }, + "com.amazonaws.cloudfront#EndPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#EndPoint" + } + }, "com.amazonaws.cloudfront#EventType": { "type": "string", "traits": { @@ -3570,13 +3850,6 @@ "com.amazonaws.cloudfront#FieldLevelEncryption": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.cloudfront#timestamp", - "traits": { - "smithy.api#documentation": "

The last time the field-level encryption configuration was changed.

", - "smithy.api#required": {} - } - }, "FieldLevelEncryptionConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { @@ -3590,6 +3863,13 @@ "smithy.api#documentation": "

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain\n\t\tselected data fields to be encrypted by specific public keys.

", "smithy.api#required": {} } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "

The last time the field-level encryption configuration was changed.

", + "smithy.api#required": {} + } } }, "traits": { @@ -3599,6 +3879,12 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionConfig": { "type": "structure", "members": { + "ContentTypeProfileConfig": { + "target": "com.amazonaws.cloudfront#ContentTypeProfileConfig", + "traits": { + "smithy.api#documentation": "

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default \n\t\t\tin a request if a query argument doesn't specify a profile to use.

" + } + }, "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -3617,12 +3903,6 @@ "traits": { "smithy.api#documentation": "

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a \n\t\t\tquery argument in a request.

" } - }, - "ContentTypeProfileConfig": { - "target": "com.amazonaws.cloudfront#ContentTypeProfileConfig", - "traits": { - "smithy.api#documentation": "

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default \n\t\t\tin a request if a query argument doesn't specify a profile to use.

" - } } }, "traits": { @@ -3658,11 +3938,10 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionList": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.cloudfront#integer", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The maximum number of elements you want in the response body.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your configurations where you left off.

" } }, "Quantity": { @@ -3672,16 +3951,17 @@ "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#FieldLevelEncryptionSummaryList", + "MaxItems": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

An array of field-level encryption items.

" + "smithy.api#documentation": "

The maximum number of elements you want in the response body.

", + "smithy.api#required": {} } }, - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", + "Items": { + "target": "com.amazonaws.cloudfront#FieldLevelEncryptionSummaryList", "traits": { - "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your configurations where you left off.

" + "smithy.api#documentation": "

An array of field-level encryption items.

" } } }, @@ -3692,10 +3972,10 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionProfile": { "type": "structure", "members": { - "FieldLevelEncryptionProfileConfig": { - "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", + "Id": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

", + "smithy.api#documentation": "

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain\n\t\t\tselected data fields to be encrypted by specific public keys.

", "smithy.api#required": {} } }, @@ -3706,10 +3986,10 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.cloudfront#string", + "FieldLevelEncryptionProfileConfig": { + "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { - "smithy.api#documentation": "

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain\n\t\t\tselected data fields to be encrypted by specific public keys.

", + "smithy.api#documentation": "

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

", "smithy.api#required": {} } } @@ -3734,17 +4014,17 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig": { "type": "structure", "members": { - "EncryptionEntities": { - "target": "com.amazonaws.cloudfront#EncryptionEntities", + "CallerReference": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and\n\t\t\tfield patterns for specifying which fields to encrypt with this key.

", + "smithy.api#documentation": "

A unique number that ensures that the request can't be replayed.

", "smithy.api#required": {} } }, - "CallerReference": { - "target": "com.amazonaws.cloudfront#string", + "EncryptionEntities": { + "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { - "smithy.api#documentation": "

A unique number that ensures that the request can't be replayed.

", + "smithy.api#documentation": "

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and\n\t\t\tfield patterns for specifying which fields to encrypt with this key.

", "smithy.api#required": {} } }, @@ -3782,16 +4062,17 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionProfileList": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your profiles where you left off.

" + "smithy.api#documentation": "

The number of field-level encryption profiles.

", + "smithy.api#required": {} } }, - "Quantity": { + "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of field-level encryption profiles.

", + "smithy.api#documentation": "

The maximum number of field-level encryption profiles you want in the response body.

", "smithy.api#required": {} } }, @@ -3801,11 +4082,10 @@ "smithy.api#documentation": "

The field-level encryption profile items.

" } }, - "MaxItems": { - "target": "com.amazonaws.cloudfront#integer", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The maximum number of field-level encryption profiles you want in the response body.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your profiles where you left off.

" } } }, @@ -3829,13 +4109,6 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionProfileSummary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

ID for the field-level encryption profile summary.

", - "smithy.api#required": {} - } - }, "EncryptionEntities": { "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { @@ -3843,13 +4116,6 @@ "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.cloudfront#timestamp", - "traits": { - "smithy.api#documentation": "

The time when the the field-level encryption profile summary was last updated.

", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -3862,6 +4128,20 @@ "traits": { "smithy.api#documentation": "

An optional comment for the field-level encryption profile summary.

" } + }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

ID for the field-level encryption profile summary.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "

The time when the the field-level encryption profile summary was last updated.

", + "smithy.api#required": {} + } } }, "traits": { @@ -3880,17 +4160,10 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionSummary": { "type": "structure", "members": { - "Comment": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

An optional comment about the field-level encryption item.

" - } - }, - "Id": { - "target": "com.amazonaws.cloudfront#string", + "QueryArgProfileConfig": { + "target": "com.amazonaws.cloudfront#QueryArgProfileConfig", "traits": { - "smithy.api#documentation": "

The unique ID of a field-level encryption item.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n\t\t\tA summary of a query argument-profile mapping.\n\t\t

" } }, "ContentTypeProfileConfig": { @@ -3899,18 +4172,25 @@ "smithy.api#documentation": "

\n\t\t\tA summary of a content type-profile mapping.\n\t\t

" } }, - "QueryArgProfileConfig": { - "target": "com.amazonaws.cloudfront#QueryArgProfileConfig", - "traits": { - "smithy.api#documentation": "

\n\t\t\tA summary of a query argument-profile mapping.\n\t\t

" - } - }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { "smithy.api#documentation": "

The last time that the summary of field-level encryption items was modified.

", "smithy.api#required": {} } + }, + "Comment": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

An optional comment about the field-level encryption item.

" + } + }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique ID of a field-level encryption item.

", + "smithy.api#required": {} + } } }, "traits": { @@ -3920,9 +4200,18 @@ "com.amazonaws.cloudfront#FieldLevelEncryptionSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.cloudfront#FieldLevelEncryptionSummary", + "target": "com.amazonaws.cloudfront#FieldLevelEncryptionSummary", + "traits": { + "smithy.api#xmlName": "FieldLevelEncryptionSummary" + } + } + }, + "com.amazonaws.cloudfront#FieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#xmlName": "FieldLevelEncryptionSummary" + "smithy.api#xmlName": "Field" } } }, @@ -3976,12 +4265,6 @@ "smithy.api#required": {} } }, - "QueryStringCacheKeys": { - "target": "com.amazonaws.cloudfront#QueryStringCacheKeys", - "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send query strings to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that contains information about the query string parameters that you \n\t\t\twant CloudFront to use for caching for this cache behavior.

" - } - }, "QueryString": { "target": "com.amazonaws.cloudfront#boolean", "traits": { @@ -3994,6 +4277,12 @@ "traits": { "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include headers in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send headers to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that specifies the Headers, if any, that you want CloudFront to forward to the \n\t\t\torigin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches \n\t\t\tseparate versions of a specified object that is based on the header values in viewer requests.

\n\t\t

For more information, see \n\t\t\tCaching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

" } + }, + "QueryStringCacheKeys": { + "target": "com.amazonaws.cloudfront#QueryStringCacheKeys", + "traits": { + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send query strings to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that contains information about the query string parameters that you \n\t\t\twant CloudFront to use for caching for this cache behavior.

" + } } }, "traits": { @@ -4003,10 +4292,10 @@ "com.amazonaws.cloudfront#GeoRestriction": { "type": "structure", "members": { - "Quantity": { - "target": "com.amazonaws.cloudfront#integer", + "RestrictionType": { + "target": "com.amazonaws.cloudfront#GeoRestrictionType", "traits": { - "smithy.api#documentation": "

When geo restriction is enabled, this is the number of countries in your \n\t\t\t\twhitelist or blacklist. Otherwise, when it is not enabled, \n\t\t\t\tQuantity is 0, and you can omit Items.

", + "smithy.api#documentation": "

The method that you want to use to restrict distribution of your content by \n\t\t\tcountry:

\n\t\t ", "smithy.api#required": {} } }, @@ -4016,10 +4305,10 @@ "smithy.api#documentation": "

A complex type that contains a Location element for each country in which \n\t\t\tyou want CloudFront either to distribute your content (whitelist) or not distribute \n\t\t\tyour content (blacklist).

\n\t\t

The Location element is a two-letter, uppercase country code for a country \n\t\t\tthat you want to include in your blacklist or whitelist. Include one \n\t\t\t\tLocation element for each country.

\n\t\t

CloudFront and MaxMind both use ISO 3166 country codes. For the \n\t\t\tcurrent list of countries and the corresponding codes, see ISO 3166-1-alpha-2 \n\t\t\tcode on the International Organization for Standardization website. You \n\t\t\tcan also refer to the country list on the CloudFront console, which includes both country names and \n\t\t\tcodes.

" } }, - "RestrictionType": { - "target": "com.amazonaws.cloudfront#GeoRestrictionType", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The method that you want to use to restrict distribution of your content by \n\t\t\tcountry:

\n\t\t ", + "smithy.api#documentation": "

When geo restriction is enabled, this is the number of countries in your \n\t\t\t\twhitelist or blacklist. Otherwise, when it is not enabled, \n\t\t\t\tQuantity is 0, and you can omit Items.

", "smithy.api#required": {} } } @@ -4110,19 +4399,19 @@ "com.amazonaws.cloudfront#GetCachePolicyConfigResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The current version of the cache policy.

", - "smithy.api#httpHeader": "ETag" - } - }, "CachePolicyConfig": { "target": "com.amazonaws.cloudfront#CachePolicyConfig", "traits": { "smithy.api#documentation": "

The cache policy configuration.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the cache policy.

", + "smithy.api#httpHeader": "ETag" + } } } }, @@ -4142,19 +4431,19 @@ "com.amazonaws.cloudfront#GetCachePolicyResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The current version of the cache policy.

", - "smithy.api#httpHeader": "ETag" - } - }, "CachePolicy": { "target": "com.amazonaws.cloudfront#CachePolicy", "traits": { "smithy.api#documentation": "

The cache policy.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the cache policy.

", + "smithy.api#httpHeader": "ETag" + } } } }, @@ -4227,19 +4516,19 @@ "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult": { "type": "structure", "members": { - "CloudFrontOriginAccessIdentityConfig": { - "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", - "traits": { - "smithy.api#documentation": "

The origin access identity's configuration information.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } + }, + "CloudFrontOriginAccessIdentityConfig": { + "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", + "traits": { + "smithy.api#documentation": "

The origin access identity's configuration information.

", + "smithy.api#httpPayload": {} + } } }, "traits": { @@ -4391,19 +4680,19 @@ "com.amazonaws.cloudfront#GetDistributionResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The current version of the distribution's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "ETag" - } - }, "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { "smithy.api#documentation": "

The distribution's information.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the distribution's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "ETag" + } } }, "traits": { @@ -4476,19 +4765,19 @@ "com.amazonaws.cloudfront#GetFieldLevelEncryptionConfigResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "ETag" - } - }, "FieldLevelEncryptionConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { "smithy.api#documentation": "

Return the field-level encryption configuration information.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "ETag" + } } } }, @@ -4590,19 +4879,19 @@ "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileResult": { "type": "structure", "members": { - "FieldLevelEncryptionProfile": { - "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", - "traits": { - "smithy.api#documentation": "

Return the field-level encryption profile information.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } + }, + "FieldLevelEncryptionProfile": { + "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", + "traits": { + "smithy.api#documentation": "

Return the field-level encryption profile information.

", + "smithy.api#httpPayload": {} + } } } }, @@ -4669,18 +4958,18 @@ "com.amazonaws.cloudfront#GetInvalidationRequest": { "type": "structure", "members": { - "Id": { + "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the invalidation request, for example, \n\t\t\tIDFDVBD632BHDS5.

", + "smithy.api#documentation": "

The distribution's ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DistributionId": { + "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution's ID.

", + "smithy.api#documentation": "

The identifier for the invalidation request, for example, \n\t\t\tIDFDVBD632BHDS5.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4705,6 +4994,56 @@ "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, + "com.amazonaws.cloudfront#GetMonitoringSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetMonitoringSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetMonitoringSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchDistribution" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about whether additional CloudWatch metrics are enabled for the specified\n\t\t\tCloudFront distribution.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetMonitoringSubscriptionRequest": { + "type": "structure", + "members": { + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The ID of the distribution that you are getting metrics information for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudfront#GetMonitoringSubscriptionResult": { + "type": "structure", + "members": { + "MonitoringSubscription": { + "target": "com.amazonaws.cloudfront#MonitoringSubscription", + "traits": { + "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

", + "smithy.api#httpPayload": {} + } + } + } + }, "com.amazonaws.cloudfront#GetOriginRequestPolicy": { "type": "operation", "input": { @@ -4771,19 +5110,19 @@ "com.amazonaws.cloudfront#GetOriginRequestPolicyConfigResult": { "type": "structure", "members": { - "OriginRequestPolicyConfig": { - "target": "com.amazonaws.cloudfront#OriginRequestPolicyConfig", - "traits": { - "smithy.api#documentation": "

The origin request policy configuration.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the origin request policy.

", "smithy.api#httpHeader": "ETag" } + }, + "OriginRequestPolicyConfig": { + "target": "com.amazonaws.cloudfront#OriginRequestPolicyConfig", + "traits": { + "smithy.api#documentation": "

The origin request policy configuration.

", + "smithy.api#httpPayload": {} + } } } }, @@ -4917,18 +5256,71 @@ "com.amazonaws.cloudfront#GetPublicKeyResult": { "type": "structure", "members": { + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "ETag" + } + }, "PublicKey": { "target": "com.amazonaws.cloudfront#PublicKey", "traits": { "smithy.api#documentation": "

Return the public key.

", "smithy.api#httpPayload": {} } + } + } + }, + "com.amazonaws.cloudfront#GetRealtimeLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetRealtimeLogConfigRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetRealtimeLogConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#InvalidArgument" }, - "ETag": { + { + "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a real-time log configuration.

\n\t\t

To get a real-time log configuration, you can provide the configuration’s name or its Amazon\n\t\t\tResource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the\n\t\t\tname to identify the real-time log configuration to get.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/get-realtime-log-config", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetRealtimeLogConfigRequest": { + "type": "structure", + "members": { + "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the public key. For example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "

The name of the real-time log configuration to get.

" + } + }, + "ARN": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration to get.

" + } + } + } + }, + "com.amazonaws.cloudfront#GetRealtimeLogConfigResult": { + "type": "structure", + "members": { + "RealtimeLogConfig": { + "target": "com.amazonaws.cloudfront#RealtimeLogConfig", + "traits": { + "smithy.api#documentation": "

A real-time log configuration.

" } } } @@ -5040,19 +5432,19 @@ "com.amazonaws.cloudfront#GetStreamingDistributionResult": { "type": "structure", "members": { - "StreamingDistribution": { - "target": "com.amazonaws.cloudfront#StreamingDistribution", - "traits": { - "smithy.api#documentation": "

The streaming distribution's information.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the streaming distribution's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } + }, + "StreamingDistribution": { + "target": "com.amazonaws.cloudfront#StreamingDistribution", + "traits": { + "smithy.api#documentation": "

The streaming distribution's information.

", + "smithy.api#httpPayload": {} + } } }, "traits": { @@ -5071,18 +5463,18 @@ "com.amazonaws.cloudfront#Headers": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.cloudfront#HeaderList", - "traits": { - "smithy.api#documentation": "

A list of HTTP header names.

" - } - }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

The number of header names in the Items list.

", "smithy.api#required": {} } + }, + "Items": { + "target": "com.amazonaws.cloudfront#HeaderList", + "traits": { + "smithy.api#documentation": "

A list of HTTP header names.

" + } } }, "traits": { @@ -5472,10 +5864,10 @@ "com.amazonaws.cloudfront#Invalidation": { "type": "structure", "members": { - "Id": { + "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the invalidation request. For example: \n\t\t\tIDFDVBD632BHDS5.

", + "smithy.api#documentation": "

The status of the invalidation request. When the invalidation batch is finished, the \n\t\t\tstatus is Completed.

", "smithy.api#required": {} } }, @@ -5486,17 +5878,17 @@ "smithy.api#required": {} } }, - "CreateTime": { - "target": "com.amazonaws.cloudfront#timestamp", + "Id": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The date and time the invalidation request was first made.

", + "smithy.api#documentation": "

The identifier for the invalidation request. For example: \n\t\t\tIDFDVBD632BHDS5.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.cloudfront#string", + "CreateTime": { + "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

The status of the invalidation request. When the invalidation batch is finished, the \n\t\t\tstatus is Completed.

", + "smithy.api#documentation": "

The date and time the invalidation request was first made.

", "smithy.api#required": {} } } @@ -5508,17 +5900,17 @@ "com.amazonaws.cloudfront#InvalidationBatch": { "type": "structure", "members": { - "Paths": { - "target": "com.amazonaws.cloudfront#Paths", + "CallerReference": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the objects that you want to invalidate. \n\t\t\tFor more information, see Specifying the Objects \n\t\t\t\tto Invalidate in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

A value that you specify to uniquely identify an invalidation request. CloudFront uses the \n\t\t\tvalue to prevent you from accidentally resubmitting an identical request. Whenever you create \n\t\t\ta new invalidation request, you must specify a new value for CallerReference and \n\t\t\tchange other values in the request as applicable. One way to ensure that the value of \n\t\t\t\tCallerReference is unique is to use a timestamp, for example, \n\t\t\t\t20120301090000.

\n\t\t

If you make a second invalidation request with the same value for \n\t\t\t\tCallerReference, and if the rest of the request is the same, CloudFront doesn't \n\t\t\tcreate a new invalidation request. Instead, CloudFront returns information about the invalidation \n\t\t\trequest that you previously created with the same CallerReference.

\n\t\t

If CallerReference is a value you already sent in a previous invalidation \n\t\t\tbatch request but the content of any Path is different from the original request, \n\t\t\tCloudFront returns an InvalidationBatchAlreadyExists error.

", "smithy.api#required": {} } }, - "CallerReference": { - "target": "com.amazonaws.cloudfront#string", + "Paths": { + "target": "com.amazonaws.cloudfront#Paths", "traits": { - "smithy.api#documentation": "

A value that you specify to uniquely identify an invalidation request. CloudFront uses the \n\t\t\tvalue to prevent you from accidentally resubmitting an identical request. Whenever you create \n\t\t\ta new invalidation request, you must specify a new value for CallerReference and \n\t\t\tchange other values in the request as applicable. One way to ensure that the value of \n\t\t\t\tCallerReference is unique is to use a timestamp, for example, \n\t\t\t\t20120301090000.

\n\t\t

If you make a second invalidation request with the same value for \n\t\t\t\tCallerReference, and if the rest of the request is the same, CloudFront doesn't \n\t\t\tcreate a new invalidation request. Instead, CloudFront returns information about the invalidation \n\t\t\trequest that you previously created with the same CallerReference.

\n\t\t

If CallerReference is a value you already sent in a previous invalidation \n\t\t\tbatch request but the content of any Path is different from the original request, \n\t\t\tCloudFront returns an InvalidationBatchAlreadyExists error.

", + "smithy.api#documentation": "

A complex type that contains information about the objects that you want to invalidate. \n\t\t\tFor more information, see Specifying the Objects \n\t\t\t\tto Invalidate in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } } @@ -5530,11 +5922,10 @@ "com.amazonaws.cloudfront#InvalidationList": { "type": "structure", "members": { - "IsTruncated": { - "target": "com.amazonaws.cloudfront#boolean", + "Items": { + "target": "com.amazonaws.cloudfront#InvalidationSummaryList", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more invalidation batch requests remain to be listed. If \n\t\t\tyour results were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker request parameter to retrieve more invalidation batches in the \n\t\t\tlist.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A complex type that contains one InvalidationSummary element for each \n\t\t\tinvalidation batch created by the current AWS account.

" } }, "Marker": { @@ -5544,30 +5935,31 @@ "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#InvalidationSummaryList", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex type that contains one InvalidationSummary element for each \n\t\t\tinvalidation batch created by the current AWS account.

" + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value that you can use for the Marker request parameter to continue listing \n\t\t\tyour invalidation batches where they left off.

" } }, - "MaxItems": { + "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The value that you provided for the MaxItems request parameter.

", + "smithy.api#documentation": "

The number of invalidation batches that were created by the current AWS account. \n\t\t

", "smithy.api#required": {} } }, - "Quantity": { + "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of invalidation batches that were created by the current AWS account. \n\t\t

", + "smithy.api#documentation": "

The value that you provided for the MaxItems request parameter.

", "smithy.api#required": {} } }, - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", + "IsTruncated": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value that you can use for the Marker request parameter to continue listing \n\t\t\tyour invalidation batches where they left off.

" + "smithy.api#documentation": "

A flag that indicates whether more invalidation batch requests remain to be listed. If \n\t\t\tyour results were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker request parameter to retrieve more invalidation batches in the \n\t\t\tlist.

", + "smithy.api#required": {} } } }, @@ -5578,10 +5970,10 @@ "com.amazonaws.cloudfront#InvalidationSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.cloudfront#string", + "CreateTime": { + "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

The status of an invalidation request.

", + "smithy.api#documentation": "

The time that an invalidation request was created.

", "smithy.api#required": {} } }, @@ -5592,10 +5984,10 @@ "smithy.api#required": {} } }, - "CreateTime": { - "target": "com.amazonaws.cloudfront#timestamp", + "Status": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The time that an invalidation request was created.

", + "smithy.api#documentation": "

The status of an invalidation request.

", "smithy.api#required": {} } } @@ -5659,6 +6051,28 @@ "smithy.api#documentation": "

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

\n\t\t

For more information, see \n\t\t\tActiveTrustedSigners.

" } }, + "com.amazonaws.cloudfront#KinesisStreamConfig": { + "type": "structure", + "members": { + "StreamARN": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time\n\t\t\tlog data.

", + "smithy.api#required": {} + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that\n\t\t\tCloudFront can use to send real-time log data to your Kinesis data stream.

\n\t\t

For more information the IAM role, see Real-time log configuration IAM role in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending\n\t\t\treal-time log data.

" + } + }, "com.amazonaws.cloudfront#LambdaFunctionARN": { "type": "string" }, @@ -5671,17 +6085,17 @@ "smithy.api#documentation": "

A flag that allows a Lambda function to have read access to the body content. For more information, \n\t\t\tsee Accessing the Request Body by Choosing the \n\t\t\t\tInclude Body Option in the Amazon CloudFront Developer Guide.

" } }, - "EventType": { - "target": "com.amazonaws.cloudfront#EventType", + "LambdaFunctionARN": { + "target": "com.amazonaws.cloudfront#LambdaFunctionARN", "traits": { - "smithy.api#documentation": "

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

\n\t\t ", + "smithy.api#documentation": "

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias \n\t\t\tor $LATEST.

", "smithy.api#required": {} } }, - "LambdaFunctionARN": { - "target": "com.amazonaws.cloudfront#LambdaFunctionARN", + "EventType": { + "target": "com.amazonaws.cloudfront#EventType", "traits": { - "smithy.api#documentation": "

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias \n\t\t\tor $LATEST.

", + "smithy.api#documentation": "

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

\n\t\t ", "smithy.api#required": {} } } @@ -5751,13 +6165,6 @@ "com.amazonaws.cloudfront#ListCachePoliciesRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcache policies. The response includes cache policies in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

", - "smithy.api#httpQuery": "Marker" - } - }, "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -5771,6 +6178,13 @@ "smithy.api#documentation": "

A filter to return only the specified kinds of cache policies. Valid values\n\t\t\tare:

\n\t\t ", "smithy.api#httpQuery": "Type" } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcache policies. The response includes cache policies in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

", + "smithy.api#httpQuery": "Marker" + } } } }, @@ -5811,18 +6225,18 @@ "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesRequest": { "type": "structure", "members": { - "MaxItems": { + "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The maximum number of origin access identities you want in the response body. \n\t\t

", - "smithy.api#httpQuery": "MaxItems" + "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).

", + "smithy.api#httpQuery": "Marker" } }, - "Marker": { + "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).

", - "smithy.api#httpQuery": "Marker" + "smithy.api#documentation": "

The maximum number of origin access identities you want in the response body. \n\t\t

", + "smithy.api#httpQuery": "MaxItems" } } }, @@ -5905,13 +6319,6 @@ "smithy.api#httpQuery": "Marker" } }, - "MaxItems": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The maximum number of distribution IDs that you want in the response.

", - "smithy.api#httpQuery": "MaxItems" - } - }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -5919,6 +6326,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "MaxItems": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The maximum number of distribution IDs that you want in the response.

", + "smithy.api#httpQuery": "MaxItems" + } } } }, @@ -5965,13 +6379,6 @@ "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyIdRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

", - "smithy.api#httpQuery": "Marker" - } - }, "OriginRequestPolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -5986,6 +6393,13 @@ "smithy.api#documentation": "

The maximum number of distribution IDs that you want in the response.

", "smithy.api#httpQuery": "MaxItems" } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

", + "smithy.api#httpQuery": "Marker" + } } } }, @@ -6001,6 +6415,68 @@ } } }, + "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfigRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of distributions that have a cache behavior that’s associated with the specified\n\t\t\treal-time log configuration.

\n\t\t

You can specify the real-time log configuration by its name or its Amazon Resource Name\n\t\t\t(ARN). You must provide at least one. If you provide both, CloudFront uses the name to\n\t\t\tidentify the real-time log configuration to list distributions for.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/distributionsByRealtimeLogConfig", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfigRequest": { + "type": "structure", + "members": { + "RealtimeLogConfigArn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration whose associated\n\t\t\tdistributions you want to list.

" + } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The response includes distributions in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

" + } + }, + "RealtimeLogConfigName": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The name of the real-time log configuration whose associated distributions you want to\n\t\t\tlist.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The maximum number of distributions that you want in the response.

" + } + } + } + }, + "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfigResult": { + "type": "structure", + "members": { + "DistributionList": { + "target": "com.amazonaws.cloudfront#DistributionList", + "traits": { + "smithy.api#httpPayload": {} + } + } + } + }, "com.amazonaws.cloudfront#ListDistributionsByWebACLId": { "type": "operation", "input": { @@ -6029,6 +6505,13 @@ "com.amazonaws.cloudfront#ListDistributionsByWebACLIdRequest": { "type": "structure", "members": { + "MaxItems": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The maximum number of distributions that you want CloudFront to return in the response body. \n\t\t\tThe maximum and default values are both 100.

", + "smithy.api#httpQuery": "MaxItems" + } + }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -6043,13 +6526,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "MaxItems": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The maximum number of distributions that you want CloudFront to return in the response body. \n\t\t\tThe maximum and default values are both 100.

", - "smithy.api#httpQuery": "MaxItems" - } } }, "traits": { @@ -6074,18 +6550,18 @@ "com.amazonaws.cloudfront#ListDistributionsRequest": { "type": "structure", "members": { - "MaxItems": { + "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The maximum number of distributions you want in the response body.

", - "smithy.api#httpQuery": "MaxItems" + "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of \n\t\t\tdistributions. The results include distributions in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tdistribution on that page).

", + "smithy.api#httpQuery": "Marker" } }, - "Marker": { + "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of \n\t\t\tdistributions. The results include distributions in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tdistribution on that page).

", - "smithy.api#httpQuery": "Marker" + "smithy.api#documentation": "

The maximum number of distributions you want in the response body.

", + "smithy.api#httpQuery": "MaxItems" } } }, @@ -6133,18 +6609,18 @@ "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigsRequest": { "type": "structure", "members": { - "Marker": { + "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker to the value of the \n\t\t\tNextMarker from the current page's response (which is also the ID of the last configuration on that page).

", - "smithy.api#httpQuery": "Marker" + "smithy.api#documentation": "

The maximum number of field-level encryption configurations you want in the response body.

", + "smithy.api#httpQuery": "MaxItems" } }, - "MaxItems": { + "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The maximum number of field-level encryption configurations you want in the response body.

", - "smithy.api#httpQuery": "MaxItems" + "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker to the value of the \n\t\t\tNextMarker from the current page's response (which is also the ID of the last configuration on that page).

", + "smithy.api#httpQuery": "Marker" } } } @@ -6245,6 +6721,14 @@ "com.amazonaws.cloudfront#ListInvalidationsRequest": { "type": "structure", "members": { + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The distribution's ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -6258,14 +6742,6 @@ "smithy.api#documentation": "

Use this parameter when paginating results to indicate where to begin in your list of \n\t\t\tinvalidation batches. Because the results are returned in decreasing order from most recent to \n\t\t\toldest, the most recent results are on the first page, the second page will contain earlier \n\t\t\tresults, and so on. To get the next page of results, set Marker to the value of \n\t\t\tthe NextMarker from the current page's response. This value is the same as the ID \n\t\t\tof the last invalidation batch on that page.

", "smithy.api#httpQuery": "Marker" } - }, - "DistributionId": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The distribution's ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -6318,6 +6794,13 @@ "com.amazonaws.cloudfront#ListOriginRequestPoliciesRequest": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin request policies. The response includes origin request policies in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field’s value to the\n\t\t\tvalue of NextMarker from the current page’s response.

", + "smithy.api#httpQuery": "Marker" + } + }, "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -6326,17 +6809,10 @@ } }, "Type": { - "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", - "traits": { - "smithy.api#documentation": "

A filter to return only the specified kinds of origin request policies. Valid values\n\t\t\tare:

\n\t\t ", - "smithy.api#httpQuery": "Type" - } - }, - "Marker": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin request policies. The response includes origin request policies in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field’s value to the\n\t\t\tvalue of NextMarker from the current page’s response.

", - "smithy.api#httpQuery": "Marker" + "smithy.api#documentation": "

A filter to return only the specified kinds of origin request policies. Valid values\n\t\t\tare:

\n\t\t ", + "smithy.api#httpQuery": "Type" } } } @@ -6378,29 +6854,77 @@ "com.amazonaws.cloudfront#ListPublicKeysRequest": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker to the value of the \n\t\t\tNextMarker from the current page's response (which is also the ID of the last public key on that page).

", + "smithy.api#httpQuery": "Marker" + } + }, "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The maximum number of public keys you want in the response body.

", "smithy.api#httpQuery": "MaxItems" } + } + } + }, + "com.amazonaws.cloudfront#ListPublicKeysResult": { + "type": "structure", + "members": { + "PublicKeyList": { + "target": "com.amazonaws.cloudfront#PublicKeyList", + "traits": { + "smithy.api#documentation": "

Returns a list of all public keys that have been added to CloudFront for this account.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.cloudfront#ListRealtimeLogConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListRealtimeLogConfigsRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListRealtimeLogConfigsResult" + }, + "traits": { + "smithy.api#documentation": "

Gets a list of real-time log configurations.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/realtime-log-config", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#ListRealtimeLogConfigsRequest": { + "type": "structure", + "members": { + "MaxItems": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The maximum number of real-time log configurations that you want in the response.

", + "smithy.api#httpQuery": "MaxItems" + } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker to the value of the \n\t\t\tNextMarker from the current page's response (which is also the ID of the last public key on that page).

", + "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of real-time\n\t\t\tlog configurations. The response includes real-time log configurations in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field’s value to the\n\t\t\tvalue of NextMarker from the current page’s response.

", "smithy.api#httpQuery": "Marker" } } } }, - "com.amazonaws.cloudfront#ListPublicKeysResult": { + "com.amazonaws.cloudfront#ListRealtimeLogConfigsResult": { "type": "structure", "members": { - "PublicKeyList": { - "target": "com.amazonaws.cloudfront#PublicKeyList", + "RealtimeLogConfigs": { + "target": "com.amazonaws.cloudfront#RealtimeLogConfigs", "traits": { - "smithy.api#documentation": "

Returns a list of all public keys that have been added to CloudFront for this account.

", + "smithy.api#documentation": "

A list of real-time log configurations.

", "smithy.api#httpPayload": {} } } @@ -6431,18 +6955,18 @@ "com.amazonaws.cloudfront#ListStreamingDistributionsRequest": { "type": "structure", "members": { - "MaxItems": { + "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value that you provided for the MaxItems request parameter.

", - "smithy.api#httpQuery": "MaxItems" + "smithy.api#documentation": "

The value that you provided for the Marker request parameter.

", + "smithy.api#httpQuery": "Marker" } }, - "Marker": { + "MaxItems": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value that you provided for the Marker request parameter.

", - "smithy.api#httpQuery": "Marker" + "smithy.api#documentation": "

The value that you provided for the MaxItems request parameter.

", + "smithy.api#httpQuery": "MaxItems" } } }, @@ -6540,17 +7064,17 @@ "com.amazonaws.cloudfront#LoggingConfig": { "type": "structure", "members": { - "IncludeCookies": { - "target": "com.amazonaws.cloudfront#boolean", + "Bucket": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Specifies whether you want CloudFront to include cookies in access logs, specify \n\t\t\t\ttrue for IncludeCookies. If you choose to include cookies in logs, \n\t\t\tCloudFront logs all cookies regardless of how you configure the cache behaviors for this \n\t\t\tdistribution. If you don't want to include cookies when you create a distribution or if you \n\t\t\twant to disable include cookies for an existing distribution, specify false for \n\t\t\t\tIncludeCookies.

", + "smithy.api#documentation": "

The Amazon S3 bucket to store the access logs in, for example, \n\t\t\t\tmyawslogbucket.s3.amazonaws.com.

", "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.cloudfront#string", + "IncludeCookies": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket to store the access logs in, for example, \n\t\t\t\tmyawslogbucket.s3.amazonaws.com.

", + "smithy.api#documentation": "

Specifies whether you want CloudFront to include cookies in access logs, specify \n\t\t\t\ttrue for IncludeCookies. If you choose to include cookies in logs, \n\t\t\tCloudFront logs all cookies regardless of how you configure the cache behaviors for this \n\t\t\tdistribution. If you don't want to include cookies when you create a distribution or if you \n\t\t\twant to disable include cookies for an existing distribution, specify false for \n\t\t\t\tIncludeCookies.

", "smithy.api#required": {} } }, @@ -6648,6 +7172,20 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#MonitoringSubscription": { + "type": "structure", + "members": { + "RealtimeMetricsSubscriptionConfig": { + "target": "com.amazonaws.cloudfront#RealtimeMetricsSubscriptionConfig", + "traits": { + "smithy.api#documentation": "

A subscription configuration for additional CloudWatch metrics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

" + } + }, "com.amazonaws.cloudfront#NoSuchCachePolicy": { "type": "structure", "members": { @@ -6765,6 +7303,19 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

The real-time log configuration does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.cloudfront#NoSuchResource": { "type": "structure", "members": { @@ -6794,6 +7345,18 @@ "com.amazonaws.cloudfront#Origin": { "type": "structure", "members": { + "ConnectionTimeout": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

The number of seconds that CloudFront waits when trying to establish a connection to the origin.\n\t\t\tThe minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you\n\t\t\tdon’t specify otherwise) is 10 seconds.

\n\t\t

For more information, see Origin Connection Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.

" + } + }, + "ConnectionAttempts": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

The number of times that CloudFront attempts to connect to the origin. The minimum number\n is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

\n

For a custom origin (including an Amazon S3 bucket that’s configured with static\n website hosting), this value also specifies the number of times that CloudFront attempts to\n get a response from the origin, in the case of an Origin Response Timeout.

\n

For more information, see Origin Connection Attempts in the\n\t\t\tAmazon CloudFront Developer Guide.

" + } + }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -6807,24 +7370,12 @@ "smithy.api#documentation": "

Use this type to specify an origin that is an Amazon S3 bucket that is \n not\n configured with static website hosting. To specify\n\t\t\tany other type of origin, including an Amazon S3 bucket that is configured with static\n\t\t\twebsite hosting, use the CustomOriginConfig type instead.

" } }, - "CustomOriginConfig": { - "target": "com.amazonaws.cloudfront#CustomOriginConfig", - "traits": { - "smithy.api#documentation": "

Use this type to specify an origin that is a content container or HTTP server,\n\t\t\tincluding an Amazon S3 bucket that is configured with static website hosting. To specify an\n\t\t\tAmazon S3 bucket that is \n not\n configured\n\t\t\twith static website hosting, use the S3OriginConfig type instead.

" - } - }, "OriginPath": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from\n\t\t\tthe origin.

\n\t\t

For more information, see Origin Path in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, - "ConnectionAttempts": { - "target": "com.amazonaws.cloudfront#integer", - "traits": { - "smithy.api#documentation": "

The number of times that CloudFront attempts to connect to the origin. The minimum number\n is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

\n

For a custom origin (including an Amazon S3 bucket that’s configured with static\n website hosting), this value also specifies the number of times that CloudFront attempts to\n get a response from the origin, in the case of an Origin Response Timeout.

\n

For more information, see Origin Connection Attempts in the\n\t\t\tAmazon CloudFront Developer Guide.

" - } - }, "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -6838,10 +7389,10 @@ "smithy.api#documentation": "

A list of HTTP header names and values that CloudFront adds to requests it sends to the\n\t\t\torigin.

\n\t\t

For more information, see Adding Custom Headers to Origin Requests in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, - "ConnectionTimeout": { - "target": "com.amazonaws.cloudfront#integer", + "CustomOriginConfig": { + "target": "com.amazonaws.cloudfront#CustomOriginConfig", "traits": { - "smithy.api#documentation": "

The number of seconds that CloudFront waits when trying to establish a connection to the origin.\n\t\t\tThe minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you\n\t\t\tdon’t specify otherwise) is 10 seconds.

\n\t\t

For more information, see Origin Connection Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Use this type to specify an origin that is a content container or HTTP server,\n\t\t\tincluding an Amazon S3 bucket that is configured with static website hosting. To specify an\n\t\t\tAmazon S3 bucket that is \n not\n configured\n\t\t\twith static website hosting, use the S3OriginConfig type instead.

" } } }, @@ -6852,17 +7403,17 @@ "com.amazonaws.cloudfront#OriginCustomHeader": { "type": "structure", "members": { - "HeaderValue": { + "HeaderName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value for the header that you specified in the HeaderName \n\t\t\tfield.

", + "smithy.api#documentation": "

The name of a header that you want CloudFront to send to your origin. For more information, see\n\t\t\tAdding Custom\n\t\t\tHeaders to Origin Requests in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, - "HeaderName": { + "HeaderValue": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The name of a header that you want CloudFront to send to your origin. For more information, see\n\t\t\tAdding Custom\n\t\t\tHeaders to Origin Requests in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The value for the header that you specified in the HeaderName \n\t\t\tfield.

", "smithy.api#required": {} } } @@ -6890,17 +7441,17 @@ "smithy.api#required": {} } }, - "Members": { - "target": "com.amazonaws.cloudfront#OriginGroupMembers", + "FailoverCriteria": { + "target": "com.amazonaws.cloudfront#OriginGroupFailoverCriteria", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the origins in an origin group.

", + "smithy.api#documentation": "

A complex type that contains information about the failover criteria for an origin group.

", "smithy.api#required": {} } }, - "FailoverCriteria": { - "target": "com.amazonaws.cloudfront#OriginGroupFailoverCriteria", + "Members": { + "target": "com.amazonaws.cloudfront#OriginGroupMembers", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the failover criteria for an origin group.

", + "smithy.api#documentation": "

A complex type that contains information about the origins in an origin group.

", "smithy.api#required": {} } } @@ -7066,7 +7617,7 @@ } }, "traits": { - "smithy.api#documentation": "

An origin request policy.

\n\t\t

When it’s attached to a cache behavior, the origin request policy determines the values that\n\t\t\tCloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to\n\t\t\tthe origin includes the following:

\n\t\t \n\t\t

CloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCreateCachePolicy.

" + "smithy.api#documentation": "

An origin request policy.

\n\t\t

When it’s attached to a cache behavior, the origin request policy determines the values that\n\t\t\tCloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to\n\t\t\tthe origin includes the following:

\n\t\t \n\t\t

CloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCachePolicy.

" } }, "com.amazonaws.cloudfront#OriginRequestPolicyAlreadyExists": { @@ -7085,10 +7636,17 @@ "com.amazonaws.cloudfront#OriginRequestPolicyConfig": { "type": "structure", "members": { - "CookiesConfig": { - "target": "com.amazonaws.cloudfront#OriginRequestPolicyCookiesConfig", + "QueryStringsConfig": { + "target": "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringsConfig", "traits": { - "smithy.api#documentation": "

The cookies from viewer requests to include in origin requests.

", + "smithy.api#documentation": "

The URL query strings from viewer requests to include in origin requests.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

A unique name to identify the origin request policy.

", "smithy.api#required": {} } }, @@ -7105,23 +7663,16 @@ "smithy.api#documentation": "

A comment to describe the origin request policy.

" } }, - "QueryStringsConfig": { - "target": "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringsConfig", - "traits": { - "smithy.api#documentation": "

The URL query strings from viewer requests to include in origin requests.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.cloudfront#string", + "CookiesConfig": { + "target": "com.amazonaws.cloudfront#OriginRequestPolicyCookiesConfig", "traits": { - "smithy.api#documentation": "

A unique name to identify the origin request policy.

", + "smithy.api#documentation": "

The cookies from viewer requests to include in origin requests.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

An origin request policy configuration.

\n\t\t

This configuration determines the values that CloudFront includes in requests that it sends to the\n\t\t\torigin. Each request that CloudFront sends to the origin includes the following:

\n\t\t \n\t\t

CloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCreateCachePolicy.

" + "smithy.api#documentation": "

An origin request policy configuration.

\n\t\t

This configuration determines the values that CloudFront includes in requests that it sends to the\n\t\t\torigin. Each request that CloudFront sends to the origin includes the following:

\n\t\t \n\t\t

CloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCachePolicy.

" } }, "com.amazonaws.cloudfront#OriginRequestPolicyCookieBehavior": { @@ -7180,15 +7731,15 @@ "com.amazonaws.cloudfront#OriginRequestPolicyHeadersConfig": { "type": "structure", "members": { + "Headers": { + "target": "com.amazonaws.cloudfront#Headers" + }, "HeaderBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyHeaderBehavior", "traits": { "smithy.api#documentation": "

Determines whether any HTTP headers are included in requests that CloudFront sends to the origin.\n\t\t\tValid values are:

\n\t\t ", "smithy.api#required": {} } - }, - "Headers": { - "target": "com.amazonaws.cloudfront#Headers" } }, "traits": { @@ -7218,6 +7769,12 @@ "smithy.api#required": {} } }, + "Items": { + "target": "com.amazonaws.cloudfront#OriginRequestPolicySummaryList", + "traits": { + "smithy.api#documentation": "

Contains the origin request policies in the list.

" + } + }, "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -7230,12 +7787,6 @@ "smithy.api#documentation": "

The maximum number of origin request policies requested.

", "smithy.api#required": {} } - }, - "Items": { - "target": "com.amazonaws.cloudfront#OriginRequestPolicySummaryList", - "traits": { - "smithy.api#documentation": "

Contains the origin request policies in the list.

" - } } }, "traits": { @@ -7261,18 +7812,18 @@ "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringsConfig": { "type": "structure", "members": { - "QueryStrings": { - "target": "com.amazonaws.cloudfront#QueryStringNames", - "traits": { - "smithy.api#documentation": "

Contains a list of the query strings in viewer requests that are included in requests that\n\t\t\tCloudFront sends to the origin.

" - } - }, "QueryStringBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringBehavior", "traits": { "smithy.api#documentation": "

Determines whether any URL query strings in viewer requests are included in requests that\n\t\t\tCloudFront sends to the origin. Valid values are:

\n\t\t ", "smithy.api#required": {} } + }, + "QueryStrings": { + "target": "com.amazonaws.cloudfront#QueryStringNames", + "traits": { + "smithy.api#documentation": "

Contains a list of the query strings in viewer requests that are included in requests that\n\t\t\tCloudFront sends to the origin.

" + } } }, "traits": { @@ -7282,17 +7833,17 @@ "com.amazonaws.cloudfront#OriginRequestPolicySummary": { "type": "structure", "members": { - "OriginRequestPolicy": { - "target": "com.amazonaws.cloudfront#OriginRequestPolicy", + "Type": { + "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", "traits": { - "smithy.api#documentation": "

The origin request policy.

", + "smithy.api#documentation": "

The type of origin request policy, either managed (created by AWS) or\n\t\t\tcustom (created in this AWS account).

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", + "OriginRequestPolicy": { + "target": "com.amazonaws.cloudfront#OriginRequestPolicy", "traits": { - "smithy.api#documentation": "

The type of origin request policy, either managed (created by AWS) or\n\t\t\tcustom (created in this AWS account).

", + "smithy.api#documentation": "

The origin request policy.

", "smithy.api#required": {} } } @@ -7326,17 +7877,17 @@ "com.amazonaws.cloudfront#OriginSslProtocols": { "type": "structure", "members": { - "Quantity": { - "target": "com.amazonaws.cloudfront#integer", + "Items": { + "target": "com.amazonaws.cloudfront#SslProtocolsList", "traits": { - "smithy.api#documentation": "

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an \n\t\t\tHTTPS connection with this origin.

", + "smithy.api#documentation": "

A list that contains allowed SSL/TLS protocols for this distribution.

", "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#SslProtocolsList", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

A list that contains allowed SSL/TLS protocols for this distribution.

", + "smithy.api#documentation": "

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an \n\t\t\tHTTPS connection with this origin.

", "smithy.api#required": {} } } @@ -7348,17 +7899,17 @@ "com.amazonaws.cloudfront#Origins": { "type": "structure", "members": { - "Quantity": { - "target": "com.amazonaws.cloudfront#integer", + "Items": { + "target": "com.amazonaws.cloudfront#OriginList", "traits": { - "smithy.api#documentation": "

The number of origins or origin groups for this distribution.

", + "smithy.api#documentation": "

A complex type that contains origins or origin groups for this distribution.

", "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#OriginList", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

A complex type that contains origins or origin groups for this distribution.

", + "smithy.api#documentation": "

The number of origins or origin groups for this distribution.

", "smithy.api#required": {} } } @@ -7370,13 +7921,6 @@ "com.amazonaws.cloudfront#ParametersInCacheKeyAndForwardedToOrigin": { "type": "structure", "members": { - "CookiesConfig": { - "target": "com.amazonaws.cloudfront#CachePolicyCookiesConfig", - "traits": { - "smithy.api#documentation": "

An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and automatically included in requests that CloudFront sends to\n\t\t\tthe origin.

", - "smithy.api#required": {} - } - }, "QueryStringsConfig": { "target": "com.amazonaws.cloudfront#CachePolicyQueryStringsConfig", "traits": { @@ -7387,20 +7931,33 @@ "EnableAcceptEncodingGzip": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that determines whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.

\n\t\t

If this field is true \n and the viewer request includes the\n\t\t\tAccept-Encoding header, then CloudFront normalizes the value of the viewer’s\n\t\t\tAccept-Encoding header to one of the following:

\n\t\t \n\t\t

CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront\n\t\t\tsends to the origin.

\n\t\t

If this field is false, then CloudFront treats the Accept-Encoding\n\t\t\theader the same as any other HTTP header in the viewer request. By default, it’s not\n\t\t\tincluded in the cache key and it’s not included in origin requests. You can manually add\n\t\t\tAccept-Encoding to the headers whitelist like any other HTTP header.

\n\t\t

When this field is true, you should not whitelist the\n\t\t\tAccept-Encoding header in the cache policy or in an origin request policy\n\t\t\tattached to the same cache behavior.

\n\t\t

For more information, see Cache compressed objects in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.

\n\t\t

This field is related to the EnableAcceptEncodingBrotli field. If one or\n\t\t\tboth of these fields is true \n and the viewer request\n\t\t\tincludes the Accept-Encoding header, then CloudFront does the following:

\n\t\t \n\t\t

For more information, see Cache compressed objects in the\n Amazon CloudFront Developer Guide.

\n\t\t

If you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.

\n\t\t

If both of these fields are false, then CloudFront treats the\n\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it’s not included in the cache key and it’s not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.

", + "smithy.api#required": {} + } + }, + "CookiesConfig": { + "target": "com.amazonaws.cloudfront#CachePolicyCookiesConfig", + "traits": { + "smithy.api#documentation": "

An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and automatically included in requests that CloudFront sends to\n\t\t\tthe origin.

", "smithy.api#required": {} } }, "HeadersConfig": { "target": "com.amazonaws.cloudfront#CachePolicyHeadersConfig", "traits": { - "smithy.api#documentation": "

An object that determines whether any HTTP headers (and if so, which headers) are\n\t\t\tincluded in the cache key and automatically included in requests that CloudFront sends to the\n\t\t\torigin.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An object that determines whether any HTTP headers (and if so, which headers) are\n\t\t\tincluded in the cache key and automatically included in requests that CloudFront sends to the\n\t\t\torigin.

", + "smithy.api#required": {} + } + }, + "EnableAcceptEncodingBrotli": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.

\n\t\t

This field is related to the EnableAcceptEncodingGzip field. If one or\n\t\t\tboth of these fields is true \n and the viewer request\n\t\t\tincludes the Accept-Encoding header, then CloudFront does the following:

\n\t\t \n\t\t

For more information, see Cache compressed objects in the\n Amazon CloudFront Developer Guide.

\n

If you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.

\n\t\t

If both of these fields are false, then CloudFront treats the\n\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it’s not included in the cache key and it’s not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.

" } } }, "traits": { - "smithy.api#documentation": "

This object determines the values that CloudFront includes in the cache key. These values can\n\t\t\tinclude HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an\n\t\t\tobject in its cache that it can return to the viewer.

\n\t\t

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tCreateOriginRequestPolicy.

" + "smithy.api#documentation": "

This object determines the values that CloudFront includes in the cache key. These values can\n\t\t\tinclude HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an\n\t\t\tobject in its cache that it can return to the viewer.

\n\t\t

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.

" } }, "com.amazonaws.cloudfront#PathList": { @@ -7415,18 +7972,18 @@ "com.amazonaws.cloudfront#Paths": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.cloudfront#PathList", - "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the paths that you want to invalidate.

" - } - }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

The number of invalidation paths specified for the objects that you want to invalidate.

", "smithy.api#required": {} } + }, + "Items": { + "target": "com.amazonaws.cloudfront#PathList", + "traits": { + "smithy.api#documentation": "

A complex type that contains a list of the paths that you want to invalidate.

" + } } }, "traits": { @@ -7465,13 +8022,6 @@ "com.amazonaws.cloudfront#PublicKey": { "type": "structure", "members": { - "PublicKeyConfig": { - "target": "com.amazonaws.cloudfront#PublicKeyConfig", - "traits": { - "smithy.api#documentation": "

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

", - "smithy.api#required": {} - } - }, "CreatedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { @@ -7485,6 +8035,13 @@ "smithy.api#documentation": "

A unique ID assigned to a public key you've added to CloudFront.

", "smithy.api#required": {} } + }, + "PublicKeyConfig": { + "target": "com.amazonaws.cloudfront#PublicKeyConfig", + "traits": { + "smithy.api#documentation": "

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

", + "smithy.api#required": {} + } } }, "traits": { @@ -7507,6 +8064,13 @@ "com.amazonaws.cloudfront#PublicKeyConfig": { "type": "structure", "members": { + "CallerReference": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

A unique number that ensures that the request can't be replayed.

", + "smithy.api#required": {} + } + }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -7526,13 +8090,6 @@ "smithy.api#documentation": "

The name for a public key you add to CloudFront to use with features like field-level encryption.

", "smithy.api#required": {} } - }, - "CallerReference": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

A unique number that ensures that the request can't be replayed.

", - "smithy.api#required": {} - } } }, "traits": { @@ -7555,10 +8112,11 @@ "com.amazonaws.cloudfront#PublicKeyList": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your public keys where you left off.

" + "smithy.api#documentation": "

The number of public keys you added to CloudFront to use with features like field-level\n\t\t\tencryption.

", + "smithy.api#required": {} } }, "MaxItems": { @@ -7568,17 +8126,16 @@ "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#PublicKeySummaryList", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An array of information about a public key you add to CloudFront to use with features like field-level encryption.

" + "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your public keys where you left off.

" } }, - "Quantity": { - "target": "com.amazonaws.cloudfront#integer", + "Items": { + "target": "com.amazonaws.cloudfront#PublicKeySummaryList", "traits": { - "smithy.api#documentation": "

The number of public keys you added to CloudFront to use with features like field-level\n\t\t\tencryption.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of information about a public key you add to CloudFront to use with features like field-level encryption.

" } } }, @@ -7589,24 +8146,23 @@ "com.amazonaws.cloudfront#PublicKeySummary": { "type": "structure", "members": { - "Name": { + "EncodedKey": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

\n\t\t\tName for public key information summary.\n\t\t

", + "smithy.api#documentation": "

\n\t\t\tEncoded key for public key information summary.\n\t\t

", "smithy.api#required": {} } }, - "CreatedTime": { - "target": "com.amazonaws.cloudfront#timestamp", + "Comment": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

\n\t\t\tCreation time for public key information summary.\n\t\t

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n\t\t\tComment for public key information summary.\n\t\t

" } }, - "EncodedKey": { + "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

\n\t\t\tEncoded key for public key information summary.\n\t\t

", + "smithy.api#documentation": "

\n\t\t\tName for public key information summary.\n\t\t

", "smithy.api#required": {} } }, @@ -7617,10 +8173,11 @@ "smithy.api#required": {} } }, - "Comment": { - "target": "com.amazonaws.cloudfront#string", + "CreatedTime": { + "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tComment for public key information summary.\n\t\t

" + "smithy.api#documentation": "

\n\t\t\tCreation time for public key information summary.\n\t\t

", + "smithy.api#required": {} } } }, @@ -7640,17 +8197,17 @@ "com.amazonaws.cloudfront#QueryArgProfile": { "type": "structure", "members": { - "ProfileId": { + "QueryArg": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

ID of profile to use for field-level encryption query argument-profile mapping

", + "smithy.api#documentation": "

Query argument for field-level encryption query argument-profile mapping.

", "smithy.api#required": {} } }, - "QueryArg": { + "ProfileId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Query argument for field-level encryption query argument-profile mapping.

", + "smithy.api#documentation": "

ID of profile to use for field-level encryption query argument-profile mapping

", "smithy.api#required": {} } } @@ -7705,18 +8262,18 @@ "com.amazonaws.cloudfront#QueryArgProfiles": { "type": "structure", "members": { + "Items": { + "target": "com.amazonaws.cloudfront#QueryArgProfileList", + "traits": { + "smithy.api#documentation": "

Number of items for query argument-profile mapping for field-level encryption.

" + } + }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

Number of profiles for query argument-profile mapping for field-level encryption.

", "smithy.api#required": {} } - }, - "Items": { - "target": "com.amazonaws.cloudfront#QueryArgProfileList", - "traits": { - "smithy.api#documentation": "

Number of items for query argument-profile mapping for field-level encryption.

" - } } }, "traits": { @@ -7741,7 +8298,7 @@ } }, "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include query strings in the cache key, use\n\t\t\tQueryStringsConfig in a cache policy. See\n\t\t\tCreateCachePolicy.

\n\t\t

If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse QueryStringsConfig in an origin request policy. See\n\t\t\tCreateOriginRequestPolicy.

\n\t\t

A complex type that contains information about the query string parameters that you want\n\t\t\tCloudFront to use for caching for a cache behavior.\n\t\t

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include query strings in the cache key, use\n\t\t\tQueryStringsConfig in a cache policy. See\n\t\t\tCachePolicy.

\n\t\t

If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse QueryStringsConfig in an origin request policy. See\n\t\t\tOriginRequestPolicy.

\n\t\t

A complex type that contains information about the query string parameters that you want\n\t\t\tCloudFront to use for caching for a cache behavior.\n\t\t

" } }, "com.amazonaws.cloudfront#QueryStringCacheKeysList": { @@ -7756,18 +8313,18 @@ "com.amazonaws.cloudfront#QueryStringNames": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.cloudfront#QueryStringNamesList", - "traits": { - "smithy.api#documentation": "

A list of query string names.

" - } - }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { "smithy.api#documentation": "

The number of query string names in the Items list.

", "smithy.api#required": {} } + }, + "Items": { + "target": "com.amazonaws.cloudfront#QueryStringNamesList", + "traits": { + "smithy.api#documentation": "

A list of query string names.

" + } } }, "traits": { @@ -7783,6 +8340,152 @@ } } }, + "com.amazonaws.cloudfront#RealtimeLogConfig": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The unique name of this real-time log configuration.

", + "smithy.api#required": {} + } + }, + "SamplingRate": { + "target": "com.amazonaws.cloudfront#long", + "traits": { + "smithy.api#documentation": "

The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. The\n\t\t\tsampling rate is an integer between 1 and 100, inclusive.

", + "smithy.api#required": {} + } + }, + "Fields": { + "target": "com.amazonaws.cloudfront#FieldList", + "traits": { + "smithy.api#documentation": "

A list of fields that are included in each real-time log record. In an API response, the\n\t\t\tfields are provided in the same order in which they are sent to the Amazon Kinesis data\n\t\t\tstream.

\n\t\t

For more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#required": {} + } + }, + "EndPoints": { + "target": "com.amazonaws.cloudfront#EndPointList", + "traits": { + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data for this real-time log configuration.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this real-time log configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A real-time log configuration.

" + } + }, + "com.amazonaws.cloudfront#RealtimeLogConfigAlreadyExists": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

A real-time log configuration with this name already exists. You must provide a unique name.\n\t\t\tTo modify an existing real-time log configuration, use\n\t\t\tUpdateRealtimeLogConfig.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudfront#RealtimeLogConfigInUse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

Cannot delete the real-time log configuration because it is attached to one or more cache\n\t\t\tbehaviors.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudfront#RealtimeLogConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#RealtimeLogConfig" + } + }, + "com.amazonaws.cloudfront#RealtimeLogConfigs": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value that you should use in the Marker field of a subsequent\n\t\t\trequest to continue listing real-time log configurations where you left off.

" + } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

This parameter indicates where this list of real-time log configurations begins. This list\n\t\t\tincludes real-time log configurations that occur after the marker.

", + "smithy.api#required": {} + } + }, + "Items": { + "target": "com.amazonaws.cloudfront#RealtimeLogConfigList", + "traits": { + "smithy.api#documentation": "

Contains the list of real-time log configurations.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more real-time log configurations than are contained\n\t\t\tin this list.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

The maximum number of real-time log configurations requested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of real-time log configurations.

" + } + }, + "com.amazonaws.cloudfront#RealtimeMetricsSubscriptionConfig": { + "type": "structure", + "members": { + "RealtimeMetricsSubscriptionStatus": { + "target": "com.amazonaws.cloudfront#RealtimeMetricsSubscriptionStatus", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether additional CloudWatch metrics are enabled for a given\n\t\t\tCloudFront distribution.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A subscription configuration for additional CloudWatch metrics.

" + } + }, + "com.amazonaws.cloudfront#RealtimeMetricsSubscriptionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, "com.amazonaws.cloudfront#ResourceARN": { "type": "string", "traits": { @@ -7807,17 +8510,17 @@ "com.amazonaws.cloudfront#S3Origin": { "type": "structure", "members": { - "OriginAccessIdentity": { + "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The CloudFront origin access identity to associate with the distribution. Use an origin \n\t\t\taccess identity to configure the distribution so that end users can only access objects in an \n\t\t\tAmazon S3 bucket through CloudFront.

\n\t\t

If you want end users to be able to access objects using either the CloudFront URL or the \n\t\t\tAmazon S3 URL, specify an empty OriginAccessIdentity element.

\n\t\t

To delete the origin access identity from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty OriginAccessIdentity \n\t\t\telement.

\n\t\t

To replace the origin access identity, update the distribution configuration and \n\t\t\tspecify the new origin access identity.

\n\t\t

For more information, see Using an Origin Access \n\t\t\t\tIdentity to Restrict Access to Your Amazon S3 Content in the \n\t\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The DNS name of the Amazon S3 origin.

", "smithy.api#required": {} } }, - "DomainName": { + "OriginAccessIdentity": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The DNS name of the Amazon S3 origin.

", + "smithy.api#documentation": "

The CloudFront origin access identity to associate with the distribution. Use an origin \n\t\t\taccess identity to configure the distribution so that end users can only access objects in an \n\t\t\tAmazon S3 bucket through CloudFront.

\n\t\t

If you want end users to be able to access objects using either the CloudFront URL or the \n\t\t\tAmazon S3 URL, specify an empty OriginAccessIdentity element.

\n\t\t

To delete the origin access identity from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty OriginAccessIdentity \n\t\t\telement.

\n\t\t

To replace the origin access identity, update the distribution configuration and \n\t\t\tspecify the new origin access identity.

\n\t\t

For more information, see Using an Origin Access \n\t\t\t\tIdentity to Restrict Access to Your Amazon S3 Content in the \n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } } @@ -7850,6 +8553,9 @@ }, { "value": "vip" + }, + { + "value": "static-ip" } ] } @@ -7951,30 +8657,17 @@ "com.amazonaws.cloudfront#StreamingDistribution": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.cloudfront#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the distribution was last modified.

" - } - }, - "StreamingDistributionConfig": { - "target": "com.amazonaws.cloudfront#StreamingDistributionConfig", + "ActiveTrustedSigners": { + "target": "com.amazonaws.cloudfront#ActiveTrustedSigners", "traits": { - "smithy.api#documentation": "

The current configuration information for the RTMP distribution.

", + "smithy.api#documentation": "

A complex type that lists the AWS accounts, if any, that you included in the \n\t\t\t\tTrustedSigners complex type for this distribution. These are the accounts that \n\t\t\tyou want to allow to create signed URLs for private content.

\n\t\t

The Signer complex type lists the AWS account number of the trusted \n\t\t\tsigner or self if the signer is the AWS account that created the distribution. \n\t\t\tThe Signer element also includes the IDs of any active CloudFront key pairs that are \n\t\t\tassociated with the trusted signer's AWS account. If no KeyPairId element \n\t\t\tappears for a Signer, that signer can't create signed URLs.

\n\t\t

For more information, see Serving Private \n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The identifier for the RTMP distribution. For example: \n\t\t\tEGTXBD79EXAMPLE.

", + "smithy.api#documentation": "

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

", "smithy.api#required": {} } }, @@ -7985,10 +8678,16 @@ "smithy.api#required": {} } }, - "ActiveTrustedSigners": { - "target": "com.amazonaws.cloudfront#ActiveTrustedSigners", + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

A complex type that lists the AWS accounts, if any, that you included in the \n\t\t\t\tTrustedSigners complex type for this distribution. These are the accounts that \n\t\t\tyou want to allow to create signed URLs for private content.

\n\t\t

The Signer complex type lists the AWS account number of the trusted \n\t\t\tsigner or self if the signer is the AWS account that created the distribution. \n\t\t\tThe Signer element also includes the IDs of any active CloudFront key pairs that are \n\t\t\tassociated with the trusted signer's AWS account. If no KeyPairId element \n\t\t\tappears for a Signer, that signer can't create signed URLs.

\n\t\t

For more information, see Serving Private \n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The date and time that the distribution was last modified.

" + } + }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The identifier for the RTMP distribution. For example: \n\t\t\tEGTXBD79EXAMPLE.

", "smithy.api#required": {} } }, @@ -7998,6 +8697,13 @@ "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where \n\t\t\t123456789012 is your AWS account ID.

", "smithy.api#required": {} } + }, + "StreamingDistributionConfig": { + "target": "com.amazonaws.cloudfront#StreamingDistributionConfig", + "traits": { + "smithy.api#documentation": "

The current configuration information for the RTMP distribution.

", + "smithy.api#required": {} + } } }, "traits": { @@ -8020,31 +8726,24 @@ "com.amazonaws.cloudfront#StreamingDistributionConfig": { "type": "structure", "members": { - "Aliases": { - "target": "com.amazonaws.cloudfront#Aliases", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.

" - } - }, - "TrustedSigners": { - "target": "com.amazonaws.cloudfront#TrustedSigners", + "S3Origin": { + "target": "com.amazonaws.cloudfront#S3Origin", "traits": { - "smithy.api#documentation": "

A complex type that specifies any AWS accounts that you want to permit to create signed \n\t\t\tURLs for private content. If you want the distribution to use signed URLs, include this \n\t\t\telement; if you want the distribution to use public URLs, remove this element. For more \n\t\t\tinformation, see Serving Private Content through \n\t\t\t\tCloudFront in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.

", "smithy.api#required": {} } }, - "CallerReference": { + "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be \n\t\t\treplayed.

\n\t\t

If the value of CallerReference is new (regardless of the content of the \n\t\t\tStreamingDistributionConfig object), CloudFront creates a new distribution.

\n\t\t

If CallerReference is a value that you already sent in a previous request to \n\t\t\tcreate a distribution, CloudFront returns a DistributionAlreadyExists error.

", + "smithy.api#documentation": "

Any comments you want to include about the streaming distribution.

", "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.cloudfront#boolean", + "PriceClass": { + "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

Whether the streaming distribution is enabled to accept user requests for \n\t\t\tcontent.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A complex type that contains information about price class for this streaming \n\t\t\tdistribution.

" } }, "Logging": { @@ -8053,23 +8752,30 @@ "smithy.api#documentation": "

A complex type that controls whether access logs are written for the streaming \n\t\t\tdistribution.

" } }, - "S3Origin": { - "target": "com.amazonaws.cloudfront#S3Origin", + "Aliases": { + "target": "com.amazonaws.cloudfront#Aliases", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.

" } }, - "PriceClass": { - "target": "com.amazonaws.cloudfront#PriceClass", + "TrustedSigners": { + "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "

A complex type that contains information about price class for this streaming \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that specifies any AWS accounts that you want to permit to create signed \n\t\t\tURLs for private content. If you want the distribution to use signed URLs, include this \n\t\t\telement; if you want the distribution to use public URLs, remove this element. For more \n\t\t\tinformation, see Serving Private Content through \n\t\t\t\tCloudFront in the Amazon CloudFront Developer Guide.

", + "smithy.api#required": {} } }, - "Comment": { + "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Any comments you want to include about the streaming distribution.

", + "smithy.api#documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be \n\t\t\treplayed.

\n\t\t

If the value of CallerReference is new (regardless of the content of the \n\t\t\tStreamingDistributionConfig object), CloudFront creates a new distribution.

\n\t\t

If CallerReference is a value that you already sent in a previous request to \n\t\t\tcreate a distribution, CloudFront returns a DistributionAlreadyExists error.

", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

Whether the streaming distribution is enabled to accept user requests for \n\t\t\tcontent.

", "smithy.api#required": {} } } @@ -8103,11 +8809,10 @@ "com.amazonaws.cloudfront#StreamingDistributionList": { "type": "structure", "members": { - "IsTruncated": { - "target": "com.amazonaws.cloudfront#boolean", + "Items": { + "target": "com.amazonaws.cloudfront#StreamingDistributionSummaryList", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more streaming distributions remain to be listed. If your \n\t\t\tresults were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker request parameter to retrieve more distributions in the list.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A complex type that contains one StreamingDistributionSummary element for \n\t\t\teach distribution that was created by the current AWS account.

" } }, "Marker": { @@ -8117,30 +8822,31 @@ "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.cloudfront#integer", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value you provided for the MaxItems request parameter.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\tRTMP distributions where they left off.

" } }, - "Items": { - "target": "com.amazonaws.cloudfront#StreamingDistributionSummaryList", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

A complex type that contains one StreamingDistributionSummary element for \n\t\t\teach distribution that was created by the current AWS account.

" + "smithy.api#documentation": "

The number of streaming distributions that were created by the current AWS account. \n\t\t

", + "smithy.api#required": {} } }, - "Quantity": { + "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of streaming distributions that were created by the current AWS account. \n\t\t

", + "smithy.api#documentation": "

The value you provided for the MaxItems request parameter.

", "smithy.api#required": {} } }, - "NextMarker": { - "target": "com.amazonaws.cloudfront#string", + "IsTruncated": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\tRTMP distributions where they left off.

" + "smithy.api#documentation": "

A flag that indicates whether more streaming distributions remain to be listed. If your \n\t\t\tresults were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker request parameter to retrieve more distributions in the list.

", + "smithy.api#required": {} } } }, @@ -8164,52 +8870,52 @@ "com.amazonaws.cloudfront#StreamingDistributionSummary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.cloudfront#string", + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

The identifier for the distribution, for example, EDFDVBD632BHDS5.

", + "smithy.api#documentation": "

The date and time the distribution was last modified.

", "smithy.api#required": {} } }, - "ARN": { - "target": "com.amazonaws.cloudfront#string", + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the streaming distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your AWS account ID.

", + "smithy.api#documentation": "

Whether the distribution is enabled to accept end user requests for content.

", "smithy.api#required": {} } }, - "Status": { + "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Indicates the current status of the distribution. When the status is \n\t\t\tDeployed, the distribution's information is fully propagated throughout the \n\t\t\tAmazon CloudFront system.

", + "smithy.api#documentation": "

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

", "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.cloudfront#timestamp", + "PriceClass": { + "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

The date and time the distribution was last modified.

", + "smithy.api#documentation": "

A complex type that contains information about price class for this streaming \n\t\t\tdistribution.

", "smithy.api#required": {} } }, - "Aliases": { - "target": "com.amazonaws.cloudfront#Aliases", + "TrustedSigners": { + "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.

", + "smithy.api#documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to \n\t\t\tcreate signed URLs for private content. If you want to require signed URLs in requests for \n\t\t\tobjects in the target origin that match the PathPattern for this cache behavior, \n\t\t\tspecify true for Enabled, and specify the applicable values for \n\t\t\t\tQuantity and Items.If you don't want to require signed URLs in \n\t\t\trequests for objects that match PathPattern, specify false for \n\t\t\t\tEnabled and 0 for Quantity. Omit Items. \n\t\t\tTo add, change, or remove one or more trusted signers, change Enabled to \n\t\t\t\ttrue (if it's currently false), change Quantity as \n\t\t\tapplicable, and specify all of the trusted signers that you want to include in the updated \n\t\t\tdistribution.

\n\t\t

For more information, see Serving Private \n\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, - "PriceClass": { - "target": "com.amazonaws.cloudfront#PriceClass", + "Id": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A complex type that contains information about price class for this streaming \n\t\t\tdistribution.

", + "smithy.api#documentation": "

The identifier for the distribution, for example, EDFDVBD632BHDS5.

", "smithy.api#required": {} } }, - "Comment": { + "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The comment originally specified when this distribution was created.

", + "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the streaming distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your AWS account ID.

", "smithy.api#required": {} } }, @@ -8220,24 +8926,24 @@ "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.cloudfront#boolean", + "Comment": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Whether the distribution is enabled to accept end user requests for content.

", + "smithy.api#documentation": "

The comment originally specified when this distribution was created.

", "smithy.api#required": {} } }, - "TrustedSigners": { - "target": "com.amazonaws.cloudfront#TrustedSigners", + "Aliases": { + "target": "com.amazonaws.cloudfront#Aliases", "traits": { - "smithy.api#documentation": "

A complex type that specifies the AWS accounts, if any, that you want to allow to \n\t\t\tcreate signed URLs for private content. If you want to require signed URLs in requests for \n\t\t\tobjects in the target origin that match the PathPattern for this cache behavior, \n\t\t\tspecify true for Enabled, and specify the applicable values for \n\t\t\t\tQuantity and Items.If you don't want to require signed URLs in \n\t\t\trequests for objects that match PathPattern, specify false for \n\t\t\t\tEnabled and 0 for Quantity. Omit Items. \n\t\t\tTo add, change, or remove one or more trusted signers, change Enabled to \n\t\t\t\ttrue (if it's currently false), change Quantity as \n\t\t\tapplicable, and specify all of the trusted signers that you want to include in the updated \n\t\t\tdistribution.

\n\t\t

For more information, see Serving Private \n\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.

", "smithy.api#required": {} } }, - "DomainName": { + "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

", + "smithy.api#documentation": "

Indicates the current status of the distribution. When the status is \n\t\t\tDeployed, the distribution's information is fully propagated throughout the \n\t\t\tAmazon CloudFront system.

", "smithy.api#required": {} } } @@ -8258,13 +8964,6 @@ "com.amazonaws.cloudfront#StreamingLoggingConfig": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, \n\t\t\tmyprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include \n\t\t\tan empty Prefix element in the Logging element.

", - "smithy.api#required": {} - } - }, "Bucket": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -8278,6 +8977,13 @@ "smithy.api#documentation": "

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't \n\t\t\twant to enable logging when you create a streaming distribution or if you want to disable \n\t\t\tlogging for an existing streaming distribution, specify false for \n\t\t\t\tEnabled, and specify empty Bucket and Prefix \n\t\t\telements. If you specify false for Enabled but you specify values \n\t\t\tfor Bucket and Prefix, the values are automatically deleted. \n\t\t

", "smithy.api#required": {} } + }, + "Prefix": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, \n\t\t\tmyprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include \n\t\t\tan empty Prefix element in the Logging element.

", + "smithy.api#required": {} + } } }, "traits": { @@ -8853,6 +9559,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#TooManyRealtimeLogConfigs": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

You have reached the maximum number of real-time log configurations for this AWS account.\n\t\t\tFor more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudfront#TooManyStreamingDistributionCNAMEs": { "type": "structure", "members": { @@ -8908,11 +9627,10 @@ "com.amazonaws.cloudfront#TrustedSigners": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.cloudfront#boolean", + "Items": { + "target": "com.amazonaws.cloudfront#AwsAccountNumberList", "traits": { - "smithy.api#documentation": "

Specifies whether you want to require viewers to use signed URLs to access the files \n\t\t\tspecified by PathPattern and TargetOriginId.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n Optional: A complex type that contains trusted signers \n\t\t\tfor this cache behavior. If Quantity is 0, you can omit \n\t\t\t\tItems.

" } }, "Quantity": { @@ -8922,10 +9640,11 @@ "smithy.api#required": {} } }, - "Items": { - "target": "com.amazonaws.cloudfront#AwsAccountNumberList", + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

\n Optional: A complex type that contains trusted signers \n\t\t\tfor this cache behavior. If Quantity is 0, you can omit \n\t\t\t\tItems.

" + "smithy.api#documentation": "

Specifies whether you want to require viewers to use signed URLs to access the files \n\t\t\tspecified by PathPattern and TargetOriginId.

", + "smithy.api#required": {} } } }, @@ -8964,14 +9683,6 @@ "com.amazonaws.cloudfront#UntagResourceRequest": { "type": "structure", "members": { - "Resource": { - "target": "com.amazonaws.cloudfront#ResourceARN", - "traits": { - "smithy.api#documentation": "

An ARN of a CloudFront resource.

", - "smithy.api#httpQuery": "Resource", - "smithy.api#required": {} - } - }, "TagKeys": { "target": "com.amazonaws.cloudfront#TagKeys", "traits": { @@ -8979,6 +9690,14 @@ "smithy.api#httpPayload": {}, "smithy.api#required": {} } + }, + "Resource": { + "target": "com.amazonaws.cloudfront#ResourceARN", + "traits": { + "smithy.api#documentation": "

An ARN of a CloudFront resource.

", + "smithy.api#httpQuery": "Resource", + "smithy.api#required": {} + } } }, "traits": { @@ -9040,6 +9759,14 @@ "com.amazonaws.cloudfront#UpdateCachePolicyRequest": { "type": "structure", "members": { + "CachePolicyConfig": { + "target": "com.amazonaws.cloudfront#CachePolicyConfig", + "traits": { + "smithy.api#documentation": "

A cache policy configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -9054,33 +9781,25 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "CachePolicyConfig": { - "target": "com.amazonaws.cloudfront#CachePolicyConfig", - "traits": { - "smithy.api#documentation": "

A cache policy configuration.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.cloudfront#UpdateCachePolicyResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The current version of the cache policy.

", - "smithy.api#httpHeader": "ETag" - } - }, "CachePolicy": { "target": "com.amazonaws.cloudfront#CachePolicy", "traits": { "smithy.api#documentation": "

A cache policy.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the cache policy.

", + "smithy.api#httpHeader": "ETag" + } } } }, @@ -9130,11 +9849,12 @@ "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentityRequest": { "type": "structure", "members": { - "IfMatch": { - "target": "com.amazonaws.cloudfront#string", + "CloudFrontOriginAccessIdentityConfig": { + "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tidentity's configuration. For example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "If-Match" + "smithy.api#documentation": "

The identity's configuration information.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } }, "Id": { @@ -9145,12 +9865,11 @@ "smithy.api#required": {} } }, - "CloudFrontOriginAccessIdentityConfig": { - "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", - "traits": { - "smithy.api#documentation": "

The identity's configuration information.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tidentity's configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "If-Match" } } }, @@ -9161,19 +9880,19 @@ "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentityResult": { "type": "structure", "members": { - "CloudFrontOriginAccessIdentity": { - "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity", - "traits": { - "smithy.api#documentation": "

The origin access identity's information.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } + }, + "CloudFrontOriginAccessIdentity": { + "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity", + "traits": { + "smithy.api#documentation": "

The origin access identity's information.

", + "smithy.api#httpPayload": {} + } } }, "traits": { @@ -9349,12 +10068,11 @@ "com.amazonaws.cloudfront#UpdateDistributionRequest": { "type": "structure", "members": { - "DistributionConfig": { - "target": "com.amazonaws.cloudfront#DistributionConfig", + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution's configuration information.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "If-Match" } }, "Id": { @@ -9365,11 +10083,12 @@ "smithy.api#required": {} } }, - "IfMatch": { - "target": "com.amazonaws.cloudfront#string", + "DistributionConfig": { + "target": "com.amazonaws.cloudfront#DistributionConfig", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "If-Match" + "smithy.api#documentation": "

The distribution's configuration information.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } } }, @@ -9380,19 +10099,19 @@ "com.amazonaws.cloudfront#UpdateDistributionResult": { "type": "structure", "members": { - "Distribution": { - "target": "com.amazonaws.cloudfront#Distribution", - "traits": { - "smithy.api#documentation": "

The distribution's information.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } + }, + "Distribution": { + "target": "com.amazonaws.cloudfront#Distribution", + "traits": { + "smithy.api#documentation": "

The distribution's information.

", + "smithy.api#httpPayload": {} + } } }, "traits": { @@ -9454,12 +10173,11 @@ "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfigRequest": { "type": "structure", "members": { - "FieldLevelEncryptionConfig": { - "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Request to update a field-level encryption configuration.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the configuration identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "If-Match" } }, "Id": { @@ -9470,11 +10188,12 @@ "smithy.api#required": {} } }, - "IfMatch": { - "target": "com.amazonaws.cloudfront#string", + "FieldLevelEncryptionConfig": { + "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the configuration identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "If-Match" + "smithy.api#documentation": "

Request to update a field-level encryption configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } } } @@ -9482,19 +10201,19 @@ "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfigResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when updating the configuration. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "ETag" - } - }, "FieldLevelEncryption": { "target": "com.amazonaws.cloudfront#FieldLevelEncryption", "traits": { "smithy.api#documentation": "

Return the results of updating the configuration.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The value of the ETag header that you received when updating the configuration. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "ETag" + } } } }, @@ -9556,13 +10275,6 @@ "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionProfileRequest": { "type": "structure", "members": { - "IfMatch": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the profile identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "If-Match" - } - }, "FieldLevelEncryptionProfileConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { @@ -9578,25 +10290,32 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the profile identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "If-Match" + } } } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionProfileResult": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The result of the field-level encryption profile request.

", - "smithy.api#httpHeader": "ETag" - } - }, "FieldLevelEncryptionProfile": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfile", "traits": { "smithy.api#documentation": "

Return the results of updating the profile.

", "smithy.api#httpPayload": {} } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The result of the field-level encryption profile request.

", + "smithy.api#httpHeader": "ETag" + } } } }, @@ -9655,6 +10374,13 @@ "com.amazonaws.cloudfront#UpdateOriginRequestPolicyRequest": { "type": "structure", "members": { + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The version of the origin request policy that you are updating. The version is returned in\n\t\t\tthe origin request policy’s ETag field in the response to\n\t\t\tGetOriginRequestPolicyConfig.

", + "smithy.api#httpHeader": "If-Match" + } + }, "OriginRequestPolicyConfig": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyConfig", "traits": { @@ -9663,13 +10389,6 @@ "smithy.api#required": {} } }, - "IfMatch": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The version of the origin request policy that you are updating. The version is returned in\n\t\t\tthe origin request policy’s ETag field in the response to\n\t\t\tGetOriginRequestPolicyConfig.

", - "smithy.api#httpHeader": "If-Match" - } - }, "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -9742,12 +10461,11 @@ "com.amazonaws.cloudfront#UpdatePublicKeyRequest": { "type": "structure", "members": { - "PublicKeyConfig": { - "target": "com.amazonaws.cloudfront#PublicKeyConfig", + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Request to update public key information.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the public key to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "If-Match" } }, "Id": { @@ -9758,11 +10476,12 @@ "smithy.api#required": {} } }, - "IfMatch": { - "target": "com.amazonaws.cloudfront#string", + "PublicKeyConfig": { + "target": "com.amazonaws.cloudfront#PublicKeyConfig", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the public key to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "If-Match" + "smithy.api#documentation": "

Request to update public key information.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } } } @@ -9786,6 +10505,77 @@ } } }, + "com.amazonaws.cloudfront#UpdateRealtimeLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#UpdateRealtimeLogConfigRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#UpdateRealtimeLogConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a real-time log configuration.

\n\t\t

When you update a real-time log configuration, all the parameters are updated with the\n\t\t\tvalues provided in the request. You cannot update some parameters independent of others.\n\t\t\tTo update a real-time log configuration:

\n\t\t
    \n
  1. \n\t\t\t\t

    Call GetRealtimeLogConfig to get the current real-time log\n\t\t\t\t\tconfiguration.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Locally modify the parameters in the real-time log configuration that you want\n\t\t\t\t\tto update.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Call this API (UpdateRealtimeLogConfig) by providing the entire\n\t\t\t\t\treal-time log configuration, including the parameters that you modified and\n\t\t\t\t\tthose that you didn’t.

    \n\t\t\t
    4. \n
\n\t\t

You cannot update a real-time log configuration’s Name or\n\t\t\tARN.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/realtime-log-config", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#UpdateRealtimeLogConfigRequest": { + "type": "structure", + "members": { + "Fields": { + "target": "com.amazonaws.cloudfront#FieldList", + "traits": { + "smithy.api#documentation": "

A list of fields to include in each real-time log record.

\n\t\t

For more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.

" + } + }, + "EndPoints": { + "target": "com.amazonaws.cloudfront#EndPointList", + "traits": { + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.

" + } + }, + "SamplingRate": { + "target": "com.amazonaws.cloudfront#long", + "traits": { + "smithy.api#documentation": "

The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. You must\n\t\t\tprovide an integer between 1 and 100, inclusive.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The name for this real-time log configuration.

" + } + }, + "ARN": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for this real-time log configuration.

" + } + } + } + }, + "com.amazonaws.cloudfront#UpdateRealtimeLogConfigResult": { + "type": "structure", + "members": { + "RealtimeLogConfig": { + "target": "com.amazonaws.cloudfront#RealtimeLogConfig", + "traits": { + "smithy.api#documentation": "

A real-time log configuration.

" + } + } + } + }, "com.amazonaws.cloudfront#UpdateStreamingDistribution": { "type": "operation", "input": { @@ -9847,13 +10637,6 @@ "com.amazonaws.cloudfront#UpdateStreamingDistributionRequest": { "type": "structure", "members": { - "IfMatch": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tstreaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", - "smithy.api#httpHeader": "If-Match" - } - }, "StreamingDistributionConfig": { "target": "com.amazonaws.cloudfront#StreamingDistributionConfig", "traits": { @@ -9862,6 +10645,13 @@ "smithy.api#required": {} } }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tstreaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#httpHeader": "If-Match" + } + }, "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -9878,19 +10668,19 @@ "com.amazonaws.cloudfront#UpdateStreamingDistributionResult": { "type": "structure", "members": { - "StreamingDistribution": { - "target": "com.amazonaws.cloudfront#StreamingDistribution", - "traits": { - "smithy.api#documentation": "

The streaming distribution's information.

", - "smithy.api#httpPayload": {} - } - }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } + }, + "StreamingDistribution": { + "target": "com.amazonaws.cloudfront#StreamingDistribution", + "traits": { + "smithy.api#documentation": "

The streaming distribution's information.

", + "smithy.api#httpPayload": {} + } } }, "traits": { @@ -9900,6 +10690,24 @@ "com.amazonaws.cloudfront#ViewerCertificate": { "type": "structure", "members": { + "ACMCertificateArn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in AWS Certificate Manager (ACM), provide the Amazon Resource\n\t\t\tName (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US\n\t\t\tEast (N. Virginia) Region (us-east-1).

\n\t\t

If you specify an ACM certificate ARN, you must also specify values for\n\t\t\tMinimumProtocolVerison and SSLSupportMethod.\n

" + } + }, + "MinimumProtocolVersion": { + "target": "com.amazonaws.cloudfront#MinimumProtocolVersion", + "traits": { + "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify the security policy that you want CloudFront to use for HTTPS connections with\n\t\t\tviewers. The security policy determines two settings:

\n\t\t \n\t\t

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and\n\t\t\tCloudFront in the Amazon CloudFront Developer Guide.

\n\t\t \n\t\t\t

On the CloudFront console, this setting is called Security\n\t\t\t\tPolicy.

\n\t\t \n\t\t

When you’re using SNI only (you set SSLSupportMethod to sni-only),\n\t\t\tyou must specify TLSv1 or higher.\n

\n\t\t

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net (you set\n\t\t\tCloudFrontDefaultCertificate to true), CloudFront automatically sets\n\t\t\tthe security policy to TLSv1 regardless of the value that you set\n\t\t\there.

" + } + }, + "CloudFrontDefaultCertificate": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net, set this field to true.

\n\t\t

If the distribution uses Aliases (alternate domain names or CNAMEs), set\n\t\t\tthis field to false and specify values for the following fields:

\n\t\t " + } + }, "Certificate": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -9910,7 +10718,7 @@ "SSLSupportMethod": { "target": "com.amazonaws.cloudfront#SSLSupportMethod", "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs), specify\n\t\t\twhich viewers the distribution accepts HTTPS connections from.

\n\t\t \n\t\t

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net, don’t set a value for this field.

" + "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs), specify\n\t\t\twhich viewers the distribution accepts HTTPS connections from.

\n\t\t \n\t\t

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net, don’t set a value for this field.

" } }, "CertificateSource": { @@ -9925,24 +10733,6 @@ "traits": { "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in AWS\n\t\t\tIdentity and Access Management (AWS IAM), provide the ID of the IAM\n\t\t\tcertificate.

\n\t\t

If you specify an IAM certificate ID, you must also specify values for\n\t\t\tMinimumProtocolVerison and SSLSupportMethod. \n

" } - }, - "ACMCertificateArn": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in AWS Certificate Manager (ACM), provide the Amazon Resource\n\t\t\tName (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US\n\t\t\tEast (N. Virginia) Region (us-east-1).

\n\t\t

If you specify an ACM certificate ARN, you must also specify values for\n\t\t\tMinimumProtocolVerison and SSLSupportMethod.\n

" - } - }, - "CloudFrontDefaultCertificate": { - "target": "com.amazonaws.cloudfront#boolean", - "traits": { - "smithy.api#documentation": "

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net, set this field to true.

\n\t\t

If the distribution uses Aliases (alternate domain names or CNAMEs), set\n\t\t\tthis field to false and specify values for the following fields:

\n\t\t " - } - }, - "MinimumProtocolVersion": { - "target": "com.amazonaws.cloudfront#MinimumProtocolVersion", - "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify the security policy that you want CloudFront to use for HTTPS connections with\n\t\t\tviewers. The security policy determines two settings:

\n\t\t \n\t\t

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and\n\t\t\tCloudFront in the Amazon CloudFront Developer Guide.

\n\t\t \n\t\t\t

On the CloudFront console, this setting is called Security\n\t\t\t\tPolicy.

\n\t\t \n\t\t

When you’re using SNI only (you set SSLSupportMethod to sni-only),\n\t\t\tyou must specify TLSv1 or higher.\n

\n\t\t

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net (you set\n\t\t\tCloudFrontDefaultCertificate to true), CloudFront automatically sets\n\t\t\tthe security policy to TLSv1 regardless of the value that you set\n\t\t\there.

" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cloudhsm-v2.2017-04-28.json b/codegen/sdk-codegen/aws-models/cloudhsm-v2.2017-04-28.json index 34bcba5f32ab..e1ce5aa7b2fd 100644 --- a/codegen/sdk-codegen/aws-models/cloudhsm-v2.2017-04-28.json +++ b/codegen/sdk-codegen/aws-models/cloudhsm-v2.2017-04-28.json @@ -32,12 +32,6 @@ "com.amazonaws.cloudhsmv2#Backup": { "type": "structure", "members": { - "SourceRegion": { - "target": "com.amazonaws.cloudhsmv2#Region", - "traits": { - "smithy.api#documentation": "

The AWS Region that contains the source backup from which the new backup was\n copied.

" - } - }, "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { @@ -51,16 +45,22 @@ "smithy.api#documentation": "

The date and time when the backup was copied from a source backup.

" } }, - "DeleteTimestamp": { - "target": "com.amazonaws.cloudhsmv2#Timestamp", + "SourceRegion": { + "target": "com.amazonaws.cloudhsmv2#Region", "traits": { - "smithy.api#documentation": "

The date and time when the backup will be permanently deleted.

" + "smithy.api#documentation": "

The AWS Region that contains the source backup from which the new backup was\n copied.

" } }, - "ClusterId": { + "SourceCluster": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { - "smithy.api#documentation": "

The identifier (ID) of the cluster that was backed up.

" + "smithy.api#documentation": "

The identifier (ID) of the cluster containing the source backup from which the new\n backup was copied.

" + } + }, + "CreateTimestamp": { + "target": "com.amazonaws.cloudhsmv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the backup was created.

" } }, "SourceBackup": { @@ -69,28 +69,28 @@ "smithy.api#documentation": "

The identifier (ID) of the source backup from which the new backup was\n copied.

" } }, - "CreateTimestamp": { - "target": "com.amazonaws.cloudhsmv2#Timestamp", + "BackupState": { + "target": "com.amazonaws.cloudhsmv2#BackupState", "traits": { - "smithy.api#documentation": "

The date and time when the backup was created.

" + "smithy.api#documentation": "

The state of the backup.

" } }, - "TagList": { - "target": "com.amazonaws.cloudhsmv2#TagList", + "ClusterId": { + "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { - "smithy.api#documentation": "

The list of tags for the backup.

" + "smithy.api#documentation": "

The identifier (ID) of the cluster that was backed up.

" } }, - "SourceCluster": { - "target": "com.amazonaws.cloudhsmv2#ClusterId", + "DeleteTimestamp": { + "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier (ID) of the cluster containing the source backup from which the new\n backup was copied.

" + "smithy.api#documentation": "

The date and time when the backup will be permanently deleted.

" } }, - "BackupState": { - "target": "com.amazonaws.cloudhsmv2#BackupState", + "TagList": { + "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { - "smithy.api#documentation": "

The state of the backup.

" + "smithy.api#documentation": "

The list of tags for the backup.

" } } }, @@ -193,7 +193,7 @@ "sdkId": "CloudHSM V2", "arnNamespace": "cloudhsm", "cloudFormationName": "CloudHSMV2", - "cloudTrailEventSource": "service.api.baldr.amazonaws.com" + "cloudTrailEventSource": "cloudhsmv2.amazonaws.com" }, "aws.auth#sigv4": { "name": "cloudhsm" @@ -222,22 +222,16 @@ "com.amazonaws.cloudhsmv2#Certificates": { "type": "structure", "members": { - "ClusterCsr": { - "target": "com.amazonaws.cloudhsmv2#Cert", - "traits": { - "smithy.api#documentation": "

The cluster's certificate signing request (CSR). The CSR exists only when the cluster's\n state is UNINITIALIZED.

" - } - }, "HsmCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "

The HSM certificate issued (signed) by the HSM hardware.

" } }, - "ManufacturerHardwareCertificate": { + "ClusterCsr": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { - "smithy.api#documentation": "

The HSM hardware certificate issued (signed) by the hardware manufacturer.

" + "smithy.api#documentation": "

The cluster's certificate signing request (CSR). The CSR exists only when the cluster's\n state is UNINITIALIZED.

" } }, "ClusterCertificate": { @@ -246,6 +240,12 @@ "smithy.api#documentation": "

The cluster certificate issued (signed) by the issuing certificate authority (CA) of\n the cluster's owner.

" } }, + "ManufacturerHardwareCertificate": { + "target": "com.amazonaws.cloudhsmv2#Cert", + "traits": { + "smithy.api#documentation": "

The HSM hardware certificate issued (signed) by the hardware manufacturer.

" + } + }, "AwsHardwareCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { @@ -332,40 +332,28 @@ "com.amazonaws.cloudhsmv2#Cluster": { "type": "structure", "members": { - "Certificates": { - "target": "com.amazonaws.cloudhsmv2#Certificates", - "traits": { - "smithy.api#documentation": "

Contains one or more certificates or a certificate signing request (CSR).

" - } - }, - "BackupPolicy": { - "target": "com.amazonaws.cloudhsmv2#BackupPolicy", - "traits": { - "smithy.api#documentation": "

The cluster's backup policy.

" - } - }, - "ClusterId": { - "target": "com.amazonaws.cloudhsmv2#ClusterId", + "HsmType": { + "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { - "smithy.api#documentation": "

The cluster's identifier (ID).

" + "smithy.api#documentation": "

The type of HSM that the cluster contains.

" } }, - "State": { - "target": "com.amazonaws.cloudhsmv2#ClusterState", + "VpcId": { + "target": "com.amazonaws.cloudhsmv2#VpcId", "traits": { - "smithy.api#documentation": "

The cluster's state.

" + "smithy.api#documentation": "

The identifier (ID) of the virtual private cloud (VPC) that contains the\n cluster.

" } }, - "Hsms": { - "target": "com.amazonaws.cloudhsmv2#Hsms", + "PreCoPassword": { + "target": "com.amazonaws.cloudhsmv2#PreCoPassword", "traits": { - "smithy.api#documentation": "

Contains information about the HSMs in the cluster.

" + "smithy.api#documentation": "

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

" } }, - "VpcId": { - "target": "com.amazonaws.cloudhsmv2#VpcId", + "TagList": { + "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { - "smithy.api#documentation": "

The identifier (ID) of the virtual private cloud (VPC) that contains the\n cluster.

" + "smithy.api#documentation": "

The list of tags for the cluster.

" } }, "SourceBackupId": { @@ -380,34 +368,40 @@ "smithy.api#documentation": "

The identifier (ID) of the cluster's security group.

" } }, - "TagList": { - "target": "com.amazonaws.cloudhsmv2#TagList", + "Hsms": { + "target": "com.amazonaws.cloudhsmv2#Hsms", "traits": { - "smithy.api#documentation": "

The list of tags for the cluster.

" + "smithy.api#documentation": "

Contains information about the HSMs in the cluster.

" } }, - "PreCoPassword": { - "target": "com.amazonaws.cloudhsmv2#PreCoPassword", + "Certificates": { + "target": "com.amazonaws.cloudhsmv2#Certificates", "traits": { - "smithy.api#documentation": "

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

" + "smithy.api#documentation": "

Contains one or more certificates or a certificate signing request (CSR).

" } }, - "SubnetMapping": { - "target": "com.amazonaws.cloudhsmv2#ExternalSubnetMapping", + "ClusterId": { + "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { - "smithy.api#documentation": "

A map from availability zone to the cluster’s subnet in that availability zone.

" + "smithy.api#documentation": "

The cluster's identifier (ID).

" } }, - "StateMessage": { - "target": "com.amazonaws.cloudhsmv2#StateMessage", + "State": { + "target": "com.amazonaws.cloudhsmv2#ClusterState", "traits": { - "smithy.api#documentation": "

A description of the cluster's state.

" + "smithy.api#documentation": "

The cluster's state.

" } }, - "HsmType": { - "target": "com.amazonaws.cloudhsmv2#HsmType", + "SubnetMapping": { + "target": "com.amazonaws.cloudhsmv2#ExternalSubnetMapping", "traits": { - "smithy.api#documentation": "

The type of HSM that the cluster contains.

" + "smithy.api#documentation": "

A map from availability zone to the cluster’s subnet in that availability zone.

" + } + }, + "BackupPolicy": { + "target": "com.amazonaws.cloudhsmv2#BackupPolicy", + "traits": { + "smithy.api#documentation": "

The cluster's backup policy.

" } }, "CreateTimestamp": { @@ -415,6 +409,12 @@ "traits": { "smithy.api#documentation": "

The date and time when the cluster was created.

" } + }, + "StateMessage": { + "target": "com.amazonaws.cloudhsmv2#StateMessage", + "traits": { + "smithy.api#documentation": "

A description of the cluster's state.

" + } } }, "traits": { @@ -511,10 +511,11 @@ "com.amazonaws.cloudhsmv2#CopyBackupToRegionRequest": { "type": "structure", "members": { - "TagList": { - "target": "com.amazonaws.cloudhsmv2#TagList", + "BackupId": { + "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { - "smithy.api#documentation": "

Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

" + "smithy.api#documentation": "

The ID of the backup that will be copied to the destination region.

", + "smithy.api#required": {} } }, "DestinationRegion": { @@ -524,11 +525,10 @@ "smithy.api#required": {} } }, - "BackupId": { - "target": "com.amazonaws.cloudhsmv2#BackupId", + "TagList": { + "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { - "smithy.api#documentation": "

The ID of the backup that will be copied to the destination region.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

" } } } @@ -579,29 +579,29 @@ "com.amazonaws.cloudhsmv2#CreateClusterRequest": { "type": "structure", "members": { - "SourceBackupId": { - "target": "com.amazonaws.cloudhsmv2#BackupId", - "traits": { - "smithy.api#documentation": "

The identifier (ID) of the cluster backup to restore. Use this value to restore the\n cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

" - } - }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "

Tags to apply to the CloudHSM cluster during creation.

" } }, - "SubnetIds": { - "target": "com.amazonaws.cloudhsmv2#SubnetIds", + "HsmType": { + "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { - "smithy.api#documentation": "

The identifiers (IDs) of the subnets where you are creating the cluster. You must\n specify at least one subnet. If you specify multiple subnets, they must meet the following\n criteria:

\n ", + "smithy.api#documentation": "

The type of HSM to use in the cluster. Currently the only allowed value is\n hsm1.medium.

", "smithy.api#required": {} } }, - "HsmType": { - "target": "com.amazonaws.cloudhsmv2#HsmType", + "SourceBackupId": { + "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { - "smithy.api#documentation": "

The type of HSM to use in the cluster. Currently the only allowed value is\n hsm1.medium.

", + "smithy.api#documentation": "

The identifier (ID) of the cluster backup to restore. Use this value to restore the\n cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.cloudhsmv2#SubnetIds", + "traits": { + "smithy.api#documentation": "

The identifiers (IDs) of the subnets where you are creating the cluster. You must\n specify at least one subnet. If you specify multiple subnets, they must meet the following\n criteria:

\n ", "smithy.api#required": {} } } @@ -650,11 +650,10 @@ "com.amazonaws.cloudhsmv2#CreateHsmRequest": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.cloudhsmv2#ExternalAz", + "IpAddress": { + "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { - "smithy.api#documentation": "

The Availability Zone where you are creating the HSM. To find the cluster's\n Availability Zones, use DescribeClusters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The HSM's IP address. If you specify an IP address, use an available address from the\n subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify\n an IP address, one is chosen for you from that subnet.

" } }, "ClusterId": { @@ -664,10 +663,11 @@ "smithy.api#required": {} } }, - "IpAddress": { - "target": "com.amazonaws.cloudhsmv2#IpAddress", + "AvailabilityZone": { + "target": "com.amazonaws.cloudhsmv2#ExternalAz", "traits": { - "smithy.api#documentation": "

The HSM's IP address. If you specify an IP address, use an available address from the\n subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify\n an IP address, one is chosen for you from that subnet.

" + "smithy.api#documentation": "

The Availability Zone where you are creating the HSM. To find the cluster's\n Availability Zones, use DescribeClusters.

", + "smithy.api#required": {} } } } @@ -822,16 +822,17 @@ "com.amazonaws.cloudhsmv2#DeleteHsmRequest": { "type": "structure", "members": { - "EniIp": { - "target": "com.amazonaws.cloudhsmv2#IpAddress", + "ClusterId": { + "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { - "smithy.api#documentation": "

The IP address of the elastic network interface (ENI) of the HSM that you are\n deleting.

" + "smithy.api#documentation": "

The identifier (ID) of the cluster that contains the HSM that you are\n deleting.

", + "smithy.api#required": {} } }, - "EniId": { - "target": "com.amazonaws.cloudhsmv2#EniId", + "EniIp": { + "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { - "smithy.api#documentation": "

The identifier (ID) of the elastic network interface (ENI) of the HSM that you are\n deleting.

" + "smithy.api#documentation": "

The IP address of the elastic network interface (ENI) of the HSM that you are\n deleting.

" } }, "HsmId": { @@ -840,11 +841,10 @@ "smithy.api#documentation": "

The identifier (ID) of the HSM that you are deleting.

" } }, - "ClusterId": { - "target": "com.amazonaws.cloudhsmv2#ClusterId", + "EniId": { + "target": "com.amazonaws.cloudhsmv2#EniId", "traits": { - "smithy.api#documentation": "

The identifier (ID) of the cluster that contains the HSM that you are\n deleting.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The identifier (ID) of the elastic network interface (ENI) of the HSM that you are\n deleting.

" } } } @@ -980,10 +980,10 @@ "com.amazonaws.cloudhsmv2#DescribeClustersRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.cloudhsmv2#Filters", + "MaxResults": { + "target": "com.amazonaws.cloudhsmv2#MaxSize", "traits": { - "smithy.api#documentation": "

One or more filters to limit the items returned in the response.

\n

Use the clusterIds filter to return only the specified clusters. Specify\n clusters by their cluster identifier (ID).

\n

Use the vpcIds filter to return only the clusters in the specified virtual\n private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

\n

Use the states filter to return only clusters that match the specified\n state.

" + "smithy.api#documentation": "

The maximum number of clusters to return in the response. When there are more clusters\n than the number you specify, the response contains a NextToken value.

" } }, "NextToken": { @@ -992,10 +992,10 @@ "smithy.api#documentation": "

The NextToken value that you received in the previous response. Use this\n value to get more clusters.

" } }, - "MaxResults": { - "target": "com.amazonaws.cloudhsmv2#MaxSize", + "Filters": { + "target": "com.amazonaws.cloudhsmv2#Filters", "traits": { - "smithy.api#documentation": "

The maximum number of clusters to return in the response. When there are more clusters\n than the number you specify, the response contains a NextToken value.

" + "smithy.api#documentation": "

One or more filters to limit the items returned in the response.

\n

Use the clusterIds filter to return only the specified clusters. Specify\n clusters by their cluster identifier (ID).

\n

Use the vpcIds filter to return only the clusters in the specified virtual\n private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

\n

Use the states filter to return only clusters that match the specified\n state.

" } } } @@ -1026,18 +1026,18 @@ "smithy.api#documentation": "

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

" } }, - "CreateTimestamp": { - "target": "com.amazonaws.cloudhsmv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when both the source backup was created.

" - } - }, "SourceBackup": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the source backup from which the new backup was copied.

" } }, + "CreateTimestamp": { + "target": "com.amazonaws.cloudhsmv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when both the source backup was created.

" + } + }, "SourceRegion": { "target": "com.amazonaws.cloudhsmv2#Region", "traits": { @@ -1088,12 +1088,6 @@ "com.amazonaws.cloudhsmv2#Hsm": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.cloudhsmv2#SubnetId", - "traits": { - "smithy.api#documentation": "

The subnet that contains the HSM's elastic network interface (ENI).

" - } - }, "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { @@ -1101,34 +1095,40 @@ "smithy.api#required": {} } }, - "StateMessage": { - "target": "com.amazonaws.cloudhsmv2#String", - "traits": { - "smithy.api#documentation": "

A description of the HSM's state.

" - } - }, "EniId": { "target": "com.amazonaws.cloudhsmv2#EniId", "traits": { "smithy.api#documentation": "

The identifier (ID) of the HSM's elastic network interface (ENI).

" } }, + "SubnetId": { + "target": "com.amazonaws.cloudhsmv2#SubnetId", + "traits": { + "smithy.api#documentation": "

The subnet that contains the HSM's elastic network interface (ENI).

" + } + }, "State": { "target": "com.amazonaws.cloudhsmv2#HsmState", "traits": { "smithy.api#documentation": "

The HSM's state.

" } }, + "AvailabilityZone": { + "target": "com.amazonaws.cloudhsmv2#ExternalAz", + "traits": { + "smithy.api#documentation": "

The Availability Zone that contains the HSM.

" + } + }, "EniIp": { "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { "smithy.api#documentation": "

The IP address of the HSM's elastic network interface (ENI).

" } }, - "AvailabilityZone": { - "target": "com.amazonaws.cloudhsmv2#ExternalAz", + "StateMessage": { + "target": "com.amazonaws.cloudhsmv2#String", "traits": { - "smithy.api#documentation": "

The Availability Zone that contains the HSM.

" + "smithy.api#documentation": "

A description of the HSM's state.

" } }, "ClusterId": { @@ -1219,13 +1219,6 @@ "com.amazonaws.cloudhsmv2#InitializeClusterRequest": { "type": "structure", "members": { - "SignedCert": { - "target": "com.amazonaws.cloudhsmv2#Cert", - "traits": { - "smithy.api#documentation": "

The cluster certificate issued (signed) by your issuing certificate authority (CA). The\n certificate must be in PEM format and can contain a maximum of 5000 characters.

", - "smithy.api#required": {} - } - }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { @@ -1239,6 +1232,13 @@ "smithy.api#documentation": "

The issuing certificate of the issuing certificate authority (CA) that issued (signed)\n the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the\n root certificate. The certificate must be in PEM format and can contain a\n maximum of 5000 characters.

", "smithy.api#required": {} } + }, + "SignedCert": { + "target": "com.amazonaws.cloudhsmv2#Cert", + "traits": { + "smithy.api#documentation": "

The cluster certificate issued (signed) by your issuing certificate authority (CA). The\n certificate must be in PEM format and can contain a maximum of 5000 characters.

", + "smithy.api#required": {} + } } } }, @@ -1311,18 +1311,18 @@ "smithy.api#documentation": "

The NextToken value that you received in the previous response. Use this\n value to get more tags.

" } }, + "MaxResults": { + "target": "com.amazonaws.cloudhsmv2#MaxSize", + "traits": { + "smithy.api#documentation": "

The maximum number of tags to return in the response. When there are more tags than the\n number you specify, the response contains a NextToken value.

" + } + }, "ResourceId": { "target": "com.amazonaws.cloudhsmv2#ResourceId", "traits": { "smithy.api#documentation": "

The cluster identifier (ID) for the cluster whose tags you are getting. To find the\n cluster ID, use DescribeClusters.

", "smithy.api#required": {} } - }, - "MaxResults": { - "target": "com.amazonaws.cloudhsmv2#MaxSize", - "traits": { - "smithy.api#documentation": "

The maximum number of tags to return in the response. When there are more tags than the\n number you specify, the response contains a NextToken value.

" - } } } }, diff --git a/codegen/sdk-codegen/aws-models/cloudhsm.2014-05-30.json b/codegen/sdk-codegen/aws-models/cloudhsm.2014-05-30.json index 773fa36b6165..68fae99641e9 100644 --- a/codegen/sdk-codegen/aws-models/cloudhsm.2014-05-30.json +++ b/codegen/sdk-codegen/aws-models/cloudhsm.2014-05-30.json @@ -236,17 +236,17 @@ "com.amazonaws.cloudhsm#CloudHsmInternalException": { "type": "structure", "members": { - "retryable": { - "target": "com.amazonaws.cloudhsm#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates if the action can be retried.

" - } - }, "message": { "target": "com.amazonaws.cloudhsm#String", "traits": { "smithy.api#documentation": "

Additional information about the error.

" } + }, + "retryable": { + "target": "com.amazonaws.cloudhsm#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if the action can be retried.

" + } } }, "traits": { @@ -276,17 +276,17 @@ "com.amazonaws.cloudhsm#CloudHsmServiceException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloudhsm#String", - "traits": { - "smithy.api#documentation": "

Additional information about the error.

" - } - }, "retryable": { "target": "com.amazonaws.cloudhsm#Boolean", "traits": { "smithy.api#documentation": "

Indicates if the action can be retried.

" } + }, + "message": { + "target": "com.amazonaws.cloudhsm#String", + "traits": { + "smithy.api#documentation": "

Additional information about the error.

" + } } }, "traits": { @@ -387,14 +387,6 @@ "smithy.api#xmlName": "SyslogIp" } }, - "IamRoleArn": { - "target": "com.amazonaws.cloudhsm#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your\n behalf.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "IamRoleArn" - } - }, "EniIp": { "target": "com.amazonaws.cloudhsm#IpAddress", "traits": { @@ -409,6 +401,21 @@ "smithy.api#xmlName": "ExternalId" } }, + "ClientToken": { + "target": "com.amazonaws.cloudhsm#ClientToken", + "traits": { + "smithy.api#documentation": "

A user-defined token to ensure idempotence. Subsequent calls to this operation with the\n same token will be ignored.

", + "smithy.api#xmlName": "ClientToken" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.cloudhsm#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your\n behalf.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "IamRoleArn" + } + }, "SshKey": { "target": "com.amazonaws.cloudhsm#SshKey", "traits": { @@ -423,13 +430,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "SubscriptionType" } - }, - "ClientToken": { - "target": "com.amazonaws.cloudhsm#ClientToken", - "traits": { - "smithy.api#documentation": "

A user-defined token to ensure idempotence. Subsequent calls to this operation with the\n same token will be ignored.

", - "smithy.api#xmlName": "ClientToken" - } } }, "traits": { @@ -477,18 +477,18 @@ "com.amazonaws.cloudhsm#CreateLunaClientRequest": { "type": "structure", "members": { + "Label": { + "target": "com.amazonaws.cloudhsm#ClientLabel", + "traits": { + "smithy.api#documentation": "

The label for the client.

" + } + }, "Certificate": { "target": "com.amazonaws.cloudhsm#Certificate", "traits": { "smithy.api#documentation": "

The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used\n by this client.

", "smithy.api#required": {} } - }, - "Label": { - "target": "com.amazonaws.cloudhsm#ClientLabel", - "traits": { - "smithy.api#documentation": "

The label for the client.

" - } } }, "traits": { @@ -717,6 +717,12 @@ "smithy.api#documentation": "

The serial number of the high-availability partition group.

" } }, + "HsmsPendingRegistration": { + "target": "com.amazonaws.cloudhsm#HsmList", + "traits": { + "smithy.api#documentation": "

" + } + }, "HsmsPendingDeletion": { "target": "com.amazonaws.cloudhsm#HsmList", "traits": { @@ -735,6 +741,12 @@ "smithy.api#documentation": "

The date and time the high-availability partition group was last modified.

" } }, + "State": { + "target": "com.amazonaws.cloudhsm#CloudHsmObjectState", + "traits": { + "smithy.api#documentation": "

The state of the high-availability partition group.

" + } + }, "HapgArn": { "target": "com.amazonaws.cloudhsm#HapgArn", "traits": { @@ -746,18 +758,6 @@ "traits": { "smithy.api#documentation": "

" } - }, - "HsmsPendingRegistration": { - "target": "com.amazonaws.cloudhsm#HsmList", - "traits": { - "smithy.api#documentation": "

" - } - }, - "State": { - "target": "com.amazonaws.cloudhsm#CloudHsmObjectState", - "traits": { - "smithy.api#documentation": "

The state of the high-availability partition group.

" - } } }, "traits": { @@ -810,40 +810,49 @@ "com.amazonaws.cloudhsm#DescribeHsmResponse": { "type": "structure", "members": { - "SubscriptionStartDate": { - "target": "com.amazonaws.cloudhsm#Timestamp", + "SoftwareVersion": { + "target": "com.amazonaws.cloudhsm#String", "traits": { - "smithy.api#documentation": "

The subscription start date.

" + "smithy.api#documentation": "

The HSM software version.

" } }, - "VendorName": { - "target": "com.amazonaws.cloudhsm#String", + "Partitions": { + "target": "com.amazonaws.cloudhsm#PartitionList", "traits": { - "smithy.api#documentation": "

The name of the HSM vendor.

" + "smithy.api#documentation": "

The list of partitions on the HSM.

" } }, - "SubnetId": { - "target": "com.amazonaws.cloudhsm#SubnetId", + "SshKeyLastUpdated": { + "target": "com.amazonaws.cloudhsm#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier of the subnet that the HSM is in.

" + "smithy.api#documentation": "

The date and time that the SSH key was last updated.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.cloudhsm#IamRoleArn", + "ServerCertLastUpdated": { + "target": "com.amazonaws.cloudhsm#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role assigned to the HSM.

" + "smithy.api#documentation": "

The date and time that the server certificate was last updated.

" + } + }, + "SubscriptionEndDate": { + "target": "com.amazonaws.cloudhsm#Timestamp", + "traits": { + "smithy.api#documentation": "

The subscription end date.

" } }, + "SubscriptionType": { + "target": "com.amazonaws.cloudhsm#SubscriptionType" + }, "StatusDetails": { "target": "com.amazonaws.cloudhsm#String", "traits": { "smithy.api#documentation": "

Contains additional information about the status of the HSM.

" } }, - "EniId": { - "target": "com.amazonaws.cloudhsm#EniId", + "IamRoleArn": { + "target": "com.amazonaws.cloudhsm#IamRoleArn", "traits": { - "smithy.api#documentation": "

The identifier of the elastic network interface (ENI) attached to the HSM.

" + "smithy.api#documentation": "

The ARN of the IAM role assigned to the HSM.

" } }, "VpcId": { @@ -858,34 +867,22 @@ "smithy.api#documentation": "

The Availability Zone that the HSM is in.

" } }, - "SshKeyLastUpdated": { - "target": "com.amazonaws.cloudhsm#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the SSH key was last updated.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.cloudhsm#SshKey", - "traits": { - "smithy.api#documentation": "

The public SSH key.

" - } - }, - "SoftwareVersion": { - "target": "com.amazonaws.cloudhsm#String", + "Status": { + "target": "com.amazonaws.cloudhsm#HsmStatus", "traits": { - "smithy.api#documentation": "

The HSM software version.

" + "smithy.api#documentation": "

The status of the HSM.

" } }, - "ServerCertLastUpdated": { - "target": "com.amazonaws.cloudhsm#Timestamp", + "EniId": { + "target": "com.amazonaws.cloudhsm#EniId", "traits": { - "smithy.api#documentation": "

The date and time that the server certificate was last updated.

" + "smithy.api#documentation": "

The identifier of the elastic network interface (ENI) attached to the HSM.

" } }, - "SubscriptionEndDate": { - "target": "com.amazonaws.cloudhsm#Timestamp", + "EniIp": { + "target": "com.amazonaws.cloudhsm#IpAddress", "traits": { - "smithy.api#documentation": "

The subscription end date.

" + "smithy.api#documentation": "

The IP address assigned to the HSM's ENI.

" } }, "HsmArn": { @@ -894,8 +891,11 @@ "smithy.api#documentation": "

The ARN of the HSM.

" } }, - "SubscriptionType": { - "target": "com.amazonaws.cloudhsm#SubscriptionType" + "SubnetId": { + "target": "com.amazonaws.cloudhsm#SubnetId", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet that the HSM is in.

" + } }, "HsmType": { "target": "com.amazonaws.cloudhsm#String", @@ -903,34 +903,34 @@ "smithy.api#documentation": "

The HSM model type.

" } }, - "ServerCertUri": { - "target": "com.amazonaws.cloudhsm#String", + "SerialNumber": { + "target": "com.amazonaws.cloudhsm#HsmSerialNumber", "traits": { - "smithy.api#documentation": "

The URI of the certificate server.

" + "smithy.api#documentation": "

The serial number of the HSM.

" } }, - "Partitions": { - "target": "com.amazonaws.cloudhsm#PartitionList", + "SshPublicKey": { + "target": "com.amazonaws.cloudhsm#SshKey", "traits": { - "smithy.api#documentation": "

The list of partitions on the HSM.

" + "smithy.api#documentation": "

The public SSH key.

" } }, - "Status": { - "target": "com.amazonaws.cloudhsm#HsmStatus", + "SubscriptionStartDate": { + "target": "com.amazonaws.cloudhsm#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the HSM.

" + "smithy.api#documentation": "

The subscription start date.

" } }, - "EniIp": { - "target": "com.amazonaws.cloudhsm#IpAddress", + "VendorName": { + "target": "com.amazonaws.cloudhsm#String", "traits": { - "smithy.api#documentation": "

The IP address assigned to the HSM's ENI.

" + "smithy.api#documentation": "

The name of the HSM vendor.

" } }, - "SerialNumber": { - "target": "com.amazonaws.cloudhsm#HsmSerialNumber", + "ServerCertUri": { + "target": "com.amazonaws.cloudhsm#String", "traits": { - "smithy.api#documentation": "

The serial number of the HSM.

" + "smithy.api#documentation": "

The URI of the certificate server.

" } } }, @@ -981,10 +981,10 @@ "com.amazonaws.cloudhsm#DescribeLunaClientResponse": { "type": "structure", "members": { - "Label": { - "target": "com.amazonaws.cloudhsm#Label", + "ClientArn": { + "target": "com.amazonaws.cloudhsm#ClientArn", "traits": { - "smithy.api#documentation": "

The label of the client.

" + "smithy.api#documentation": "

The ARN of the client.

" } }, "CertificateFingerprint": { @@ -993,18 +993,18 @@ "smithy.api#documentation": "

The certificate fingerprint.

" } }, - "ClientArn": { - "target": "com.amazonaws.cloudhsm#ClientArn", - "traits": { - "smithy.api#documentation": "

The ARN of the client.

" - } - }, "LastModifiedTimestamp": { "target": "com.amazonaws.cloudhsm#Timestamp", "traits": { "smithy.api#documentation": "

The date and time the client was last modified.

" } }, + "Label": { + "target": "com.amazonaws.cloudhsm#Label", + "traits": { + "smithy.api#documentation": "

The label of the client.

" + } + }, "Certificate": { "target": "com.amazonaws.cloudhsm#Certificate", "traits": { @@ -1083,16 +1083,16 @@ "smithy.api#documentation": "

The type of credentials.

" } }, - "ConfigCred": { + "ConfigFile": { "target": "com.amazonaws.cloudhsm#String", "traits": { - "smithy.api#documentation": "

The certificate file containing the server.pem files of the HSMs.

" + "smithy.api#documentation": "

The chrystoki.conf configuration file.

" } }, - "ConfigFile": { + "ConfigCred": { "target": "com.amazonaws.cloudhsm#String", "traits": { - "smithy.api#documentation": "

The chrystoki.conf configuration file.

" + "smithy.api#documentation": "

The certificate file containing the server.pem files of the HSMs.

" } } } @@ -1535,13 +1535,6 @@ "com.amazonaws.cloudhsm#ModifyHsmRequest": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.cloudhsm#SubnetId", - "traits": { - "smithy.api#documentation": "

The new identifier of the subnet that the HSM is in. The new subnet must be in the same\n Availability Zone as the current subnet.

", - "smithy.api#xmlName": "SubnetId" - } - }, "ExternalId": { "target": "com.amazonaws.cloudhsm#ExternalId", "traits": { @@ -1549,13 +1542,6 @@ "smithy.api#xmlName": "ExternalId" } }, - "EniIp": { - "target": "com.amazonaws.cloudhsm#IpAddress", - "traits": { - "smithy.api#documentation": "

The new IP address for the elastic network interface (ENI) attached to the\n HSM.

\n

If the HSM is moved to a different subnet, and an IP address is not specified, an IP\n address will be randomly chosen from the CIDR range of the new subnet.

", - "smithy.api#xmlName": "EniIp" - } - }, "HsmArn": { "target": "com.amazonaws.cloudhsm#HsmArn", "traits": { @@ -1564,6 +1550,13 @@ "smithy.api#xmlName": "HsmArn" } }, + "SubnetId": { + "target": "com.amazonaws.cloudhsm#SubnetId", + "traits": { + "smithy.api#documentation": "

The new identifier of the subnet that the HSM is in. The new subnet must be in the same\n Availability Zone as the current subnet.

", + "smithy.api#xmlName": "SubnetId" + } + }, "IamRoleArn": { "target": "com.amazonaws.cloudhsm#IamRoleArn", "traits": { @@ -1571,6 +1564,13 @@ "smithy.api#xmlName": "IamRoleArn" } }, + "EniIp": { + "target": "com.amazonaws.cloudhsm#IpAddress", + "traits": { + "smithy.api#documentation": "

The new IP address for the elastic network interface (ENI) attached to the\n HSM.

\n

If the HSM is moved to a different subnet, and an IP address is not specified, an IP\n address will be randomly chosen from the CIDR range of the new subnet.

", + "smithy.api#xmlName": "EniIp" + } + }, "SyslogIp": { "target": "com.amazonaws.cloudhsm#IpAddress", "traits": { @@ -1762,17 +1762,17 @@ "com.amazonaws.cloudhsm#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.cloudhsm#TagValue", + "Key": { + "target": "com.amazonaws.cloudhsm#TagKey", "traits": { - "smithy.api#documentation": "

The value of the tag.

", + "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.cloudhsm#TagKey", + "Value": { + "target": "com.amazonaws.cloudhsm#TagValue", "traits": { - "smithy.api#documentation": "

The key of the tag.

", + "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cloudsearch-domain.2013-01-01.json b/codegen/sdk-codegen/aws-models/cloudsearch-domain.2013-01-01.json index c08e1007013b..ebb4c0849d25 100644 --- a/codegen/sdk-codegen/aws-models/cloudsearch-domain.2013-01-01.json +++ b/codegen/sdk-codegen/aws-models/cloudsearch-domain.2013-01-01.json @@ -51,7 +51,7 @@ "sdkId": "CloudSearch Domain", "arnNamespace": "cloudsearch", "cloudFormationName": "CloudSearchDomain", - "cloudTrailEventSource": "service2013.cloudsearch.a9.com" + "cloudTrailEventSource": "cloudsearchdomain.amazonaws.com" }, "aws.auth#sigv4": { "name": "cloudsearch" @@ -206,16 +206,10 @@ "smithy.api#documentation": "

The maximum value found in the specified field in the result set.

\n

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" } }, - "stddev": { - "target": "com.amazonaws.cloudsearchdomain#Double", - "traits": { - "smithy.api#documentation": "

The standard deviation of the values in the specified field in the result set.

" - } - }, - "mean": { + "min": { "target": "com.amazonaws.cloudsearchdomain#String", "traits": { - "smithy.api#documentation": "

The average of the values found in the specified field in the result set.

\n

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" + "smithy.api#documentation": "

The minimum value found in the specified field in the result set.

\n

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" } }, "sumOfSquares": { @@ -224,28 +218,34 @@ "smithy.api#documentation": "

The sum of all field values in the result set squared.

" } }, - "sum": { - "target": "com.amazonaws.cloudsearchdomain#Double", - "traits": { - "smithy.api#documentation": "

The sum of the field values across the documents in the result set. null for date fields.

" - } - }, "count": { "target": "com.amazonaws.cloudsearchdomain#Long", "traits": { "smithy.api#documentation": "

The number of documents that contain a value in the specified field in the result set.

" } }, + "mean": { + "target": "com.amazonaws.cloudsearchdomain#String", + "traits": { + "smithy.api#documentation": "

The average of the values found in the specified field in the result set.

\n

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" + } + }, + "sum": { + "target": "com.amazonaws.cloudsearchdomain#Double", + "traits": { + "smithy.api#documentation": "

The sum of the field values across the documents in the result set. null for date fields.

" + } + }, "missing": { "target": "com.amazonaws.cloudsearchdomain#Long", "traits": { "smithy.api#documentation": "

The number of documents that do not contain a value in the specified field in the result set.

" } }, - "min": { - "target": "com.amazonaws.cloudsearchdomain#String", + "stddev": { + "target": "com.amazonaws.cloudsearchdomain#Double", "traits": { - "smithy.api#documentation": "

The minimum value found in the specified field in the result set.

\n

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" + "smithy.api#documentation": "

The standard deviation of the values in the specified field in the result set.

" } } }, @@ -427,40 +427,39 @@ "com.amazonaws.cloudsearchdomain#SearchRequest": { "type": "structure", "members": { - "stats": { - "target": "com.amazonaws.cloudsearchdomain#Stat", + "expr": { + "target": "com.amazonaws.cloudsearchdomain#Expr", "traits": { - "smithy.api#documentation": "

Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:

\n {\"FIELD-A\":{},\"FIELD-B\":{}}\n

There are currently no options supported for statistics.

", - "smithy.api#httpQuery": "stats" + "smithy.api#documentation": "

Defines one or more numeric expressions that can be used to sort results or specify search criteria. You can also specify expressions as return fields.

\n

You specify the expressions in JSON using the form {\"EXPRESSIONNAME\":\"EXPRESSION\"}. You can define and use multiple expressions in a search request. For example:

\n

\n {\"expression1\":\"_score*rating\", \"expression2\":\"(1/rank)*year\"}\n

\n

For information about the variables, operators, and functions you can use in expressions, see Writing Expressions\n in the Amazon CloudSearch Developer Guide.

", + "smithy.api#httpQuery": "expr" } }, - "query": { - "target": "com.amazonaws.cloudsearchdomain#Query", + "queryOptions": { + "target": "com.amazonaws.cloudsearchdomain#QueryOptions", "traits": { - "smithy.api#documentation": "

Specifies the search criteria for the request. How you specify the search\n criteria depends on the query parser used for the request and the parser options\n specified in the queryOptions parameter. By default,\n the simple query parser is used to process requests. To use\n the structured, lucene, or dismax query parser, \n you must also specify the queryParser parameter.

\n

For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.

", - "smithy.api#httpQuery": "q", - "smithy.api#required": {} + "smithy.api#documentation": "

Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form {\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.

\n \n

The options you can configure vary according to which parser you use:

\n ", + "smithy.api#httpQuery": "q.options" } }, - "queryParser": { - "target": "com.amazonaws.cloudsearchdomain#QueryParser", + "return": { + "target": "com.amazonaws.cloudsearchdomain#Return", "traits": { - "smithy.api#documentation": "

Specifies which\n query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch\n uses the simple query parser.

\n

Amazon CloudSearch supports four query parsers:

\n ", - "smithy.api#httpQuery": "q.parser" + "smithy.api#documentation": "

Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all\n return enabled fields (_all_fields). \n To return only the document IDs for the matching documents, \n specify _no_fields.\n To retrieve the relevance score calculated for each document, \n specify _score.

", + "smithy.api#httpQuery": "return" } }, - "start": { - "target": "com.amazonaws.cloudsearchdomain#Start", + "partial": { + "target": "com.amazonaws.cloudsearchdomain#Partial", "traits": { - "smithy.api#documentation": "

Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive.

\n

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", - "smithy.api#httpQuery": "start" + "smithy.api#documentation": "

Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.

", + "smithy.api#httpQuery": "partial" } }, - "cursor": { - "target": "com.amazonaws.cloudsearchdomain#Cursor", + "filterQuery": { + "target": "com.amazonaws.cloudsearchdomain#FilterQuery", "traits": { - "smithy.api#documentation": "

Retrieves a cursor value you can use to page through large result sets. \n Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or\n start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response.

\n

For more\n information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", - "smithy.api#httpQuery": "cursor" + "smithy.api#documentation": "

Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax.

\n

For more information about using filters, see Filtering Matching Documents\n in the Amazon CloudSearch Developer Guide.

", + "smithy.api#httpQuery": "fq" } }, "sort": { @@ -470,20 +469,6 @@ "smithy.api#httpQuery": "sort" } }, - "expr": { - "target": "com.amazonaws.cloudsearchdomain#Expr", - "traits": { - "smithy.api#documentation": "

Defines one or more numeric expressions that can be used to sort results or specify search criteria. You can also specify expressions as return fields.

\n

You specify the expressions in JSON using the form {\"EXPRESSIONNAME\":\"EXPRESSION\"}. You can define and use multiple expressions in a search request. For example:

\n

\n {\"expression1\":\"_score*rating\", \"expression2\":\"(1/rank)*year\"}\n

\n

For information about the variables, operators, and functions you can use in expressions, see Writing Expressions\n in the Amazon CloudSearch Developer Guide.

", - "smithy.api#httpQuery": "expr" - } - }, - "queryOptions": { - "target": "com.amazonaws.cloudsearchdomain#QueryOptions", - "traits": { - "smithy.api#documentation": "

Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form {\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.

\n \n

The options you can configure vary according to which parser you use:

\n ", - "smithy.api#httpQuery": "q.options" - } - }, "facet": { "target": "com.amazonaws.cloudsearchdomain#Facet", "traits": { @@ -498,6 +483,14 @@ "smithy.api#httpQuery": "size" } }, + "query": { + "target": "com.amazonaws.cloudsearchdomain#Query", + "traits": { + "smithy.api#documentation": "

Specifies the search criteria for the request. How you specify the search\n criteria depends on the query parser used for the request and the parser options\n specified in the queryOptions parameter. By default,\n the simple query parser is used to process requests. To use\n the structured, lucene, or dismax query parser, \n you must also specify the queryParser parameter.

\n

For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.

", + "smithy.api#httpQuery": "q", + "smithy.api#required": {} + } + }, "highlight": { "target": "com.amazonaws.cloudsearchdomain#Highlight", "traits": { @@ -505,25 +498,32 @@ "smithy.api#httpQuery": "highlight" } }, - "filterQuery": { - "target": "com.amazonaws.cloudsearchdomain#FilterQuery", + "start": { + "target": "com.amazonaws.cloudsearchdomain#Start", "traits": { - "smithy.api#documentation": "

Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax.

\n

For more information about using filters, see Filtering Matching Documents\n in the Amazon CloudSearch Developer Guide.

", - "smithy.api#httpQuery": "fq" + "smithy.api#documentation": "

Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive.

\n

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", + "smithy.api#httpQuery": "start" } }, - "return": { - "target": "com.amazonaws.cloudsearchdomain#Return", + "queryParser": { + "target": "com.amazonaws.cloudsearchdomain#QueryParser", "traits": { - "smithy.api#documentation": "

Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all\n return enabled fields (_all_fields). \n To return only the document IDs for the matching documents, \n specify _no_fields.\n To retrieve the relevance score calculated for each document, \n specify _score.

", - "smithy.api#httpQuery": "return" + "smithy.api#documentation": "

Specifies which\n query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch\n uses the simple query parser.

\n

Amazon CloudSearch supports four query parsers:

\n ", + "smithy.api#httpQuery": "q.parser" } }, - "partial": { - "target": "com.amazonaws.cloudsearchdomain#Partial", + "cursor": { + "target": "com.amazonaws.cloudsearchdomain#Cursor", "traits": { - "smithy.api#documentation": "

Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.

", - "smithy.api#httpQuery": "partial" + "smithy.api#documentation": "

Retrieves a cursor value you can use to page through large result sets. \n Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or\n start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response.

\n

For more\n information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", + "smithy.api#httpQuery": "cursor" + } + }, + "stats": { + "target": "com.amazonaws.cloudsearchdomain#Stat", + "traits": { + "smithy.api#documentation": "

Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:

\n {\"FIELD-A\":{},\"FIELD-B\":{}}\n

There are currently no options supported for statistics.

", + "smithy.api#httpQuery": "stats" } } }, @@ -661,6 +661,13 @@ "com.amazonaws.cloudsearchdomain#SuggestRequest": { "type": "structure", "members": { + "size": { + "target": "com.amazonaws.cloudsearchdomain#SuggestionsSize", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of suggestions to return.

", + "smithy.api#httpQuery": "size" + } + }, "query": { "target": "com.amazonaws.cloudsearchdomain#Query", "traits": { @@ -669,13 +676,6 @@ "smithy.api#required": {} } }, - "size": { - "target": "com.amazonaws.cloudsearchdomain#SuggestionsSize", - "traits": { - "smithy.api#documentation": "

Specifies the maximum number of suggestions to return.

", - "smithy.api#httpQuery": "size" - } - }, "suggester": { "target": "com.amazonaws.cloudsearchdomain#Suggester", "traits": { @@ -741,17 +741,17 @@ "smithy.api#documentation": "

The document ID of the suggested document.

" } }, - "score": { - "target": "com.amazonaws.cloudsearchdomain#Long", - "traits": { - "smithy.api#documentation": "

The relevance score of a suggested match.

" - } - }, "suggestion": { "target": "com.amazonaws.cloudsearchdomain#String", "traits": { "smithy.api#documentation": "

The string that matches the query string specified in the SuggestRequest.

" } + }, + "score": { + "target": "com.amazonaws.cloudsearchdomain#Long", + "traits": { + "smithy.api#documentation": "

The relevance score of a suggested match.

" + } } }, "traits": { 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 2611ddcdb846..bba611ca5126 100644 --- a/codegen/sdk-codegen/aws-models/cloudsearch.2013-01-01.json +++ b/codegen/sdk-codegen/aws-models/cloudsearch.2013-01-01.json @@ -117,7 +117,7 @@ "sdkId": "CloudSearch", "arnNamespace": "cloudsearch", "cloudFormationName": "CloudSearch", - "cloudTrailEventSource": "config2013.cloudsearch.a9.com" + "cloudTrailEventSource": "cloudsearch.amazonaws.com" }, "aws.auth#sigv4": { "name": "cloudsearch" @@ -184,16 +184,16 @@ "com.amazonaws.cloudsearch#AnalysisOptions": { "type": "structure", "members": { - "StemmingDictionary": { + "Stopwords": { "target": "com.amazonaws.cloudsearch#String", "traits": { - "smithy.api#documentation": "

A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

" + "smithy.api#documentation": "

A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

" } }, - "AlgorithmicStemming": { - "target": "com.amazonaws.cloudsearch#AlgorithmicStemming", + "JapaneseTokenizationDictionary": { + "target": "com.amazonaws.cloudsearch#String", "traits": { - "smithy.api#documentation": "

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

" + "smithy.api#documentation": "

A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

" } }, "Synonyms": { @@ -202,16 +202,16 @@ "smithy.api#documentation": "

A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

" } }, - "JapaneseTokenizationDictionary": { - "target": "com.amazonaws.cloudsearch#String", + "AlgorithmicStemming": { + "target": "com.amazonaws.cloudsearch#AlgorithmicStemming", "traits": { - "smithy.api#documentation": "

A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

" + "smithy.api#documentation": "

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

" } }, - "Stopwords": { + "StemmingDictionary": { "target": "com.amazonaws.cloudsearch#String", "traits": { - "smithy.api#documentation": "

A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

" + "smithy.api#documentation": "

A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

" } } }, @@ -387,16 +387,16 @@ "com.amazonaws.cloudsearch#AvailabilityOptionsStatus": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.cloudsearch#MultiAZ", + "Status": { + "target": "com.amazonaws.cloudsearch#OptionStatus", "traits": { - "smithy.api#documentation": "

The availability options configured for the domain.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.cloudsearch#OptionStatus", + "Options": { + "target": "com.amazonaws.cloudsearch#MultiAZ", "traits": { + "smithy.api#documentation": "

The availability options configured for the domain.

", "smithy.api#required": {} } } @@ -538,18 +538,18 @@ "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } }, - "SourceFields": { - "target": "com.amazonaws.cloudsearch#FieldNameCommaList", - "traits": { - "smithy.api#documentation": "

A list of source fields to map to the field.

" - } - }, "SearchEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the contents of the field are searchable.

" } }, + "SourceFields": { + "target": "com.amazonaws.cloudsearch#FieldNameCommaList", + "traits": { + "smithy.api#documentation": "

A list of source fields to map to the field.

" + } + }, "FacetEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { @@ -564,11 +564,8 @@ "com.amazonaws.cloudsearch#DateOptions": { "type": "structure", "members": { - "FacetEnabled": { - "target": "com.amazonaws.cloudsearch#Boolean", - "traits": { - "smithy.api#documentation": "

Whether facet information can be returned for the field.

" - } + "SourceField": { + "target": "com.amazonaws.cloudsearch#FieldName" }, "SearchEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", @@ -576,16 +573,22 @@ "smithy.api#documentation": "

Whether the contents of the field are searchable.

" } }, - "DefaultValue": { - "target": "com.amazonaws.cloudsearch#FieldValue", + "SortEnabled": { + "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." + "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" } }, - "SortEnabled": { + "FacetEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" + "smithy.api#documentation": "

Whether facet information can be returned for the field.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.cloudsearch#FieldValue", + "traits": { + "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." } }, "ReturnEnabled": { @@ -593,9 +596,6 @@ "traits": { "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } - }, - "SourceField": { - "target": "com.amazonaws.cloudsearch#FieldName" } }, "traits": { @@ -634,14 +634,14 @@ "com.amazonaws.cloudsearch#DefineAnalysisSchemeRequest": { "type": "structure", "members": { - "AnalysisScheme": { - "target": "com.amazonaws.cloudsearch#AnalysisScheme", + "DomainName": { + "target": "com.amazonaws.cloudsearch#DomainName", "traits": { "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.cloudsearch#DomainName", + "AnalysisScheme": { + "target": "com.amazonaws.cloudsearch#AnalysisScheme", "traits": { "smithy.api#required": {} } @@ -760,16 +760,16 @@ "com.amazonaws.cloudsearch#DefineIndexFieldRequest": { "type": "structure", "members": { - "IndexField": { - "target": "com.amazonaws.cloudsearch#IndexField", + "DomainName": { + "target": "com.amazonaws.cloudsearch#DomainName", "traits": { - "smithy.api#documentation": "

The index field and field options you want to configure.

", "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.cloudsearch#DomainName", + "IndexField": { + "target": "com.amazonaws.cloudsearch#IndexField", "traits": { + "smithy.api#documentation": "

The index field and field options you want to configure.

", "smithy.api#required": {} } } @@ -1054,16 +1054,16 @@ "com.amazonaws.cloudsearch#DeleteIndexFieldRequest": { "type": "structure", "members": { - "IndexFieldName": { - "target": "com.amazonaws.cloudsearch#DynamicFieldName", + "DomainName": { + "target": "com.amazonaws.cloudsearch#DomainName", "traits": { - "smithy.api#documentation": "

The name of the index field your want to remove from the domain's indexing options.

", "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.cloudsearch#DomainName", + "IndexFieldName": { + "target": "com.amazonaws.cloudsearch#DynamicFieldName", "traits": { + "smithy.api#documentation": "

The name of the index field your want to remove from the domain's indexing options.

", "smithy.api#required": {} } } @@ -1249,18 +1249,18 @@ "com.amazonaws.cloudsearch#DescribeAvailabilityOptionsRequest": { "type": "structure", "members": { - "Deployed": { - "target": "com.amazonaws.cloudsearch#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" - } - }, "DomainName": { "target": "com.amazonaws.cloudsearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain you want to describe.

", "smithy.api#required": {} } + }, + "Deployed": { + "target": "com.amazonaws.cloudsearch#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } } }, "traits": { @@ -1419,6 +1419,13 @@ "com.amazonaws.cloudsearch#DescribeExpressionsRequest": { "type": "structure", "members": { + "DomainName": { + "target": "com.amazonaws.cloudsearch#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain you want to describe.

", + "smithy.api#required": {} + } + }, "ExpressionNames": { "target": "com.amazonaws.cloudsearch#StandardNameList", "traits": { @@ -1430,13 +1437,6 @@ "traits": { "smithy.api#documentation": "

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" } - }, - "DomainName": { - "target": "com.amazonaws.cloudsearch#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain you want to describe.

", - "smithy.api#required": {} - } } }, "traits": { @@ -1490,18 +1490,18 @@ "smithy.api#documentation": "

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

" } }, + "Deployed": { + "target": "com.amazonaws.cloudsearch#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, "DomainName": { "target": "com.amazonaws.cloudsearch#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain you want to describe.

", "smithy.api#required": {} } - }, - "Deployed": { - "target": "com.amazonaws.cloudsearch#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" - } } }, "traits": { @@ -1701,11 +1701,11 @@ "com.amazonaws.cloudsearch#DisabledOperationException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.cloudsearch#ErrorMessage" - }, "Code": { "target": "com.amazonaws.cloudsearch#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.cloudsearch#ErrorMessage" } }, "traits": { @@ -1724,17 +1724,17 @@ "smithy.api#required": {} } }, - "FuzzyMatching": { - "target": "com.amazonaws.cloudsearch#SuggesterFuzzyMatching", - "traits": { - "smithy.api#documentation": "

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

" - } - }, "SortExpression": { "target": "com.amazonaws.cloudsearch#String", "traits": { "smithy.api#documentation": "

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest\n integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed\n for suggestions, so sort expressions cannot reference the _score value.\n To sort suggestions using a numeric field or existing expression, simply specify\n the name of the field or expression. If no expression is configured for the suggester, the\n suggestions are sorted with the closest matches listed first.

" } + }, + "FuzzyMatching": { + "target": "com.amazonaws.cloudsearch#SuggesterFuzzyMatching", + "traits": { + "smithy.api#documentation": "

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

" + } } }, "traits": { @@ -1828,23 +1828,32 @@ "com.amazonaws.cloudsearch#DomainStatus": { "type": "structure", "members": { - "RequiresIndexDocuments": { - "target": "com.amazonaws.cloudsearch#Boolean", + "SearchPartitionCount": { + "target": "com.amazonaws.cloudsearch#PartitionCount", "traits": { - "smithy.api#documentation": "

True if IndexDocuments needs to be called to activate the current domain configuration.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of partitions across which the search index is spread.

" } }, - "SearchInstanceType": { - "target": "com.amazonaws.cloudsearch#SearchInstanceType", + "SearchService": { + "target": "com.amazonaws.cloudsearch#ServiceEndpoint", "traits": { - "smithy.api#documentation": "

The instance type that is being used to process search requests.

" + "smithy.api#documentation": "

The service endpoint for requesting search results from a search domain.

" } }, - "Processing": { + "DomainId": { + "target": "com.amazonaws.cloudsearch#DomainId", + "traits": { + "smithy.api#required": {} + } + }, + "Limits": { + "target": "com.amazonaws.cloudsearch#Limits" + }, + "RequiresIndexDocuments": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

True if processing is being done to activate the current domain configuration.

" + "smithy.api#documentation": "

True if IndexDocuments needs to be called to activate the current domain configuration.

", + "smithy.api#required": {} } }, "Deleted": { @@ -1853,46 +1862,31 @@ "smithy.api#documentation": "

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

" } }, - "ARN": { - "target": "com.amazonaws.cloudsearch#ARN" - }, "SearchInstanceCount": { "target": "com.amazonaws.cloudsearch#InstanceCount", "traits": { "smithy.api#documentation": "

The number of search instances that are available to process search requests.

" } }, - "Created": { + "Processing": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

" - } - }, - "DomainId": { - "target": "com.amazonaws.cloudsearch#DomainId", - "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

True if processing is being done to activate the current domain configuration.

" } }, - "SearchService": { + "DocService": { "target": "com.amazonaws.cloudsearch#ServiceEndpoint", "traits": { - "smithy.api#documentation": "

The service endpoint for requesting search results from a search domain.

" + "smithy.api#documentation": "

The service endpoint for updating documents in a search domain.

" } }, - "Limits": { - "target": "com.amazonaws.cloudsearch#Limits" - }, - "SearchPartitionCount": { - "target": "com.amazonaws.cloudsearch#PartitionCount", - "traits": { - "smithy.api#documentation": "

The number of partitions across which the search index is spread.

" - } + "ARN": { + "target": "com.amazonaws.cloudsearch#ARN" }, - "DocService": { - "target": "com.amazonaws.cloudsearch#ServiceEndpoint", + "Created": { + "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

The service endpoint for updating documents in a search domain.

" + "smithy.api#documentation": "

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

" } }, "DomainName": { @@ -1900,6 +1894,12 @@ "traits": { "smithy.api#required": {} } + }, + "SearchInstanceType": { + "target": "com.amazonaws.cloudsearch#SearchInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type that is being used to process search requests.

" + } } }, "traits": { @@ -1930,12 +1930,6 @@ "smithy.api#documentation": "

Whether facet information can be returned for the field.

" } }, - "SourceFields": { - "target": "com.amazonaws.cloudsearch#FieldNameCommaList", - "traits": { - "smithy.api#documentation": "

A list of source fields to map to the field.

" - } - }, "SearchEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { @@ -1953,6 +1947,12 @@ "traits": { "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } + }, + "SourceFields": { + "target": "com.amazonaws.cloudsearch#FieldNameCommaList", + "traits": { + "smithy.api#documentation": "

A list of source fields to map to the field.

" + } } }, "traits": { @@ -1974,22 +1974,16 @@ "smithy.api#documentation": "

The name of the source field to map to the field.

" } }, - "SortEnabled": { - "target": "com.amazonaws.cloudsearch#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" - } - }, - "FacetEnabled": { + "ReturnEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether facet information can be returned for the field.

" + "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } }, - "ReturnEnabled": { + "SortEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" + "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" } }, "DefaultValue": { @@ -1997,6 +1991,12 @@ "traits": { "smithy.api#documentation": "

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

" } + }, + "FacetEnabled": { + "target": "com.amazonaws.cloudsearch#Boolean", + "traits": { + "smithy.api#documentation": "

Whether facet information can be returned for the field.

" + } } }, "traits": { @@ -2181,49 +2181,49 @@ "com.amazonaws.cloudsearch#IndexField": { "type": "structure", "members": { - "DoubleOptions": { - "target": "com.amazonaws.cloudsearch#DoubleOptions" - }, - "DoubleArrayOptions": { - "target": "com.amazonaws.cloudsearch#DoubleArrayOptions" - }, - "LatLonOptions": { - "target": "com.amazonaws.cloudsearch#LatLonOptions" - }, - "LiteralOptions": { - "target": "com.amazonaws.cloudsearch#LiteralOptions" - }, - "DateArrayOptions": { - "target": "com.amazonaws.cloudsearch#DateArrayOptions" - }, - "IndexFieldName": { - "target": "com.amazonaws.cloudsearch#DynamicFieldName", + "IndexFieldType": { + "target": "com.amazonaws.cloudsearch#IndexFieldType", "traits": { - "smithy.api#documentation": "

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.\n A dynamic field's name defines a pattern that begins or ends with a wildcard.\n Any document fields that don't map to a regular index field but do match a\t\n dynamic field's pattern are configured with the dynamic field's indexing options.\n

\n

Regular field names begin with a letter and can contain the following characters:\n a-z (lowercase), 0-9, and _ (underscore).\n Dynamic field names must begin or end with a wildcard (*).\n The wildcard can also be the only character in a dynamic field name.\n Multiple wildcards, and wildcards embedded within a string are not supported.\n

\n

The name score is reserved and cannot be used as a field name.\n To reference a document's ID, you can use the name _id.\n

", "smithy.api#required": {} } }, - "DateOptions": { - "target": "com.amazonaws.cloudsearch#DateOptions" - }, "IntOptions": { "target": "com.amazonaws.cloudsearch#IntOptions" }, - "TextOptions": { - "target": "com.amazonaws.cloudsearch#TextOptions" - }, "IntArrayOptions": { "target": "com.amazonaws.cloudsearch#IntArrayOptions" }, + "TextOptions": { + "target": "com.amazonaws.cloudsearch#TextOptions" + }, "TextArrayOptions": { "target": "com.amazonaws.cloudsearch#TextArrayOptions" }, - "IndexFieldType": { - "target": "com.amazonaws.cloudsearch#IndexFieldType", + "DateOptions": { + "target": "com.amazonaws.cloudsearch#DateOptions" + }, + "DoubleOptions": { + "target": "com.amazonaws.cloudsearch#DoubleOptions" + }, + "LatLonOptions": { + "target": "com.amazonaws.cloudsearch#LatLonOptions" + }, + "IndexFieldName": { + "target": "com.amazonaws.cloudsearch#DynamicFieldName", "traits": { + "smithy.api#documentation": "

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.\n A dynamic field's name defines a pattern that begins or ends with a wildcard.\n Any document fields that don't map to a regular index field but do match a\t\n dynamic field's pattern are configured with the dynamic field's indexing options.\n

\n

Regular field names begin with a letter and can contain the following characters:\n a-z (lowercase), 0-9, and _ (underscore).\n Dynamic field names must begin or end with a wildcard (*).\n The wildcard can also be the only character in a dynamic field name.\n Multiple wildcards, and wildcards embedded within a string are not supported.\n

\n

The name score is reserved and cannot be used as a field name.\n To reference a document's ID, you can use the name _id.\n

", "smithy.api#required": {} } }, + "DoubleArrayOptions": { + "target": "com.amazonaws.cloudsearch#DoubleArrayOptions" + }, + "LiteralOptions": { + "target": "com.amazonaws.cloudsearch#LiteralOptions" + }, + "DateArrayOptions": { + "target": "com.amazonaws.cloudsearch#DateArrayOptions" + }, "LiteralArrayOptions": { "target": "com.amazonaws.cloudsearch#LiteralArrayOptions" } @@ -2319,6 +2319,12 @@ "smithy.api#documentation": "

Whether the contents of the field are searchable.

" } }, + "SourceFields": { + "target": "com.amazonaws.cloudsearch#FieldNameCommaList", + "traits": { + "smithy.api#documentation": "

A list of source fields to map to the field.

" + } + }, "FacetEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { @@ -2331,12 +2337,6 @@ "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." } }, - "SourceFields": { - "target": "com.amazonaws.cloudsearch#FieldNameCommaList", - "traits": { - "smithy.api#documentation": "

A list of source fields to map to the field.

" - } - }, "ReturnEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { @@ -2357,6 +2357,12 @@ "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" } }, + "SourceField": { + "target": "com.amazonaws.cloudsearch#FieldName", + "traits": { + "smithy.api#documentation": "

The name of the source field to map to the field.

" + } + }, "FacetEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { @@ -2369,22 +2375,16 @@ "smithy.api#documentation": "

Whether the contents of the field are searchable.

" } }, - "DefaultValue": { - "target": "com.amazonaws.cloudsearch#Long", - "traits": { - "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document." - } - }, "ReturnEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } }, - "SourceField": { - "target": "com.amazonaws.cloudsearch#FieldName", + "DefaultValue": { + "target": "com.amazonaws.cloudsearch#Long", "traits": { - "smithy.api#documentation": "

The name of the source field to map to the field.

" + "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document." } } }, @@ -2427,18 +2427,6 @@ "com.amazonaws.cloudsearch#LatLonOptions": { "type": "structure", "members": { - "SortEnabled": { - "target": "com.amazonaws.cloudsearch#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.cloudsearch#FieldValue", - "traits": { - "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." - } - }, "ReturnEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { @@ -2451,6 +2439,12 @@ "smithy.api#documentation": "

Whether the contents of the field are searchable.

" } }, + "DefaultValue": { + "target": "com.amazonaws.cloudsearch#FieldValue", + "traits": { + "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." + } + }, "SourceField": { "target": "com.amazonaws.cloudsearch#FieldName" }, @@ -2459,6 +2453,12 @@ "traits": { "smithy.api#documentation": "

Whether facet information can be returned for the field.

" } + }, + "SortEnabled": { + "target": "com.amazonaws.cloudsearch#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" + } } }, "traits": { @@ -2468,11 +2468,11 @@ "com.amazonaws.cloudsearch#LimitExceededException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.cloudsearch#ErrorMessage" - }, "Code": { "target": "com.amazonaws.cloudsearch#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.cloudsearch#ErrorMessage" } }, "traits": { @@ -2484,14 +2484,14 @@ "com.amazonaws.cloudsearch#Limits": { "type": "structure", "members": { - "MaximumReplicationCount": { - "target": "com.amazonaws.cloudsearch#MaximumReplicationCount", + "MaximumPartitionCount": { + "target": "com.amazonaws.cloudsearch#MaximumPartitionCount", "traits": { "smithy.api#required": {} } }, - "MaximumPartitionCount": { - "target": "com.amazonaws.cloudsearch#MaximumPartitionCount", + "MaximumReplicationCount": { + "target": "com.amazonaws.cloudsearch#MaximumReplicationCount", "traits": { "smithy.api#required": {} } @@ -2535,6 +2535,12 @@ "smithy.api#documentation": "

Whether the contents of the field are searchable.

" } }, + "SourceFields": { + "target": "com.amazonaws.cloudsearch#FieldNameCommaList", + "traits": { + "smithy.api#documentation": "

A list of source fields to map to the field.

" + } + }, "FacetEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { @@ -2552,12 +2558,6 @@ "traits": { "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } - }, - "SourceFields": { - "target": "com.amazonaws.cloudsearch#FieldNameCommaList", - "traits": { - "smithy.api#documentation": "

A list of source fields to map to the field.

" - } } }, "traits": { @@ -2579,26 +2579,26 @@ "smithy.api#documentation": "

Whether facet information can be returned for the field.

" } }, + "SourceField": { + "target": "com.amazonaws.cloudsearch#FieldName" + }, "SearchEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the contents of the field are searchable.

" } }, - "SourceField": { - "target": "com.amazonaws.cloudsearch#FieldName" + "ReturnEnabled": { + "target": "com.amazonaws.cloudsearch#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" + } }, "DefaultValue": { "target": "com.amazonaws.cloudsearch#FieldValue", "traits": { "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." } - }, - "ReturnEnabled": { - "target": "com.amazonaws.cloudsearch#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" - } } }, "traits": { @@ -2653,25 +2653,26 @@ "com.amazonaws.cloudsearch#OptionStatus": { "type": "structure", "members": { - "CreationDate": { + "UpdateDate": { "target": "com.amazonaws.cloudsearch#UpdateTimestamp", "traits": { - "smithy.api#documentation": "

A timestamp for when this option was created.

", + "smithy.api#documentation": "

A timestamp for when this option was last updated.

", "smithy.api#required": {} } }, - "UpdateVersion": { - "target": "com.amazonaws.cloudsearch#UIntValue", - "traits": { - "smithy.api#documentation": "

A unique integer that indicates when this option was last updated.

" - } - }, "PendingDeletion": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { "smithy.api#documentation": "

Indicates that the option will be deleted once processing is complete.

" } }, + "CreationDate": { + "target": "com.amazonaws.cloudsearch#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

A timestamp for when this option was created.

", + "smithy.api#required": {} + } + }, "State": { "target": "com.amazonaws.cloudsearch#OptionState", "traits": { @@ -2679,11 +2680,10 @@ "smithy.api#required": {} } }, - "UpdateDate": { - "target": "com.amazonaws.cloudsearch#UpdateTimestamp", + "UpdateVersion": { + "target": "com.amazonaws.cloudsearch#UIntValue", "traits": { - "smithy.api#documentation": "

A timestamp for when this option was last updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique integer that indicates when this option was last updated.

" } } }, @@ -2763,17 +2763,17 @@ "smithy.api#documentation": "

The number of replicas you want to preconfigure for each index partition.

" } }, - "DesiredPartitionCount": { - "target": "com.amazonaws.cloudsearch#UIntValue", - "traits": { - "smithy.api#documentation": "

The number of partitions you want to preconfigure for your domain. Only valid when\n you select m2.2xlarge as the desired instance type.

" - } - }, "DesiredInstanceType": { "target": "com.amazonaws.cloudsearch#PartitionInstanceType", "traits": { "smithy.api#documentation": "

The instance type that you want to preconfigure for your domain. For example, search.m1.small.

" } + }, + "DesiredPartitionCount": { + "target": "com.amazonaws.cloudsearch#UIntValue", + "traits": { + "smithy.api#documentation": "

The number of partitions you want to preconfigure for your domain. Only valid when\n you select m2.2xlarge as the desired instance type.

" + } } }, "traits": { @@ -2846,14 +2846,14 @@ "com.amazonaws.cloudsearch#Suggester": { "type": "structure", "members": { - "SuggesterName": { - "target": "com.amazonaws.cloudsearch#StandardName", + "DocumentSuggesterOptions": { + "target": "com.amazonaws.cloudsearch#DocumentSuggesterOptions", "traits": { "smithy.api#required": {} } }, - "DocumentSuggesterOptions": { - "target": "com.amazonaws.cloudsearch#DocumentSuggesterOptions", + "SuggesterName": { + "target": "com.amazonaws.cloudsearch#StandardName", "traits": { "smithy.api#required": {} } @@ -2927,22 +2927,16 @@ "com.amazonaws.cloudsearch#TextArrayOptions": { "type": "structure", "members": { - "ReturnEnabled": { - "target": "com.amazonaws.cloudsearch#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" - } - }, "DefaultValue": { "target": "com.amazonaws.cloudsearch#FieldValue", "traits": { "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." } }, - "SourceFields": { - "target": "com.amazonaws.cloudsearch#FieldNameCommaList", + "ReturnEnabled": { + "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

A list of source fields to map to the field.

" + "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } }, "HighlightEnabled": { @@ -2956,6 +2950,12 @@ "traits": { "smithy.api#documentation": "

The name of an analysis scheme for a text-array field.

" } + }, + "SourceFields": { + "target": "com.amazonaws.cloudsearch#FieldNameCommaList", + "traits": { + "smithy.api#documentation": "

A list of source fields to map to the field.

" + } } }, "traits": { @@ -2965,23 +2965,26 @@ "com.amazonaws.cloudsearch#TextOptions": { "type": "structure", "members": { + "DefaultValue": { + "target": "com.amazonaws.cloudsearch#FieldValue", + "traits": { + "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." + } + }, "ReturnEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { "smithy.api#documentation": "

Whether the contents of the field can be returned in the search results.

" } }, - "SortEnabled": { + "HighlightEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" + "smithy.api#documentation": "

Whether highlights can be returned for the field.

" } }, - "DefaultValue": { - "target": "com.amazonaws.cloudsearch#FieldValue", - "traits": { - "smithy.api#documentation": "A value to use for the field if the field isn't specified for a document." - } + "SourceField": { + "target": "com.amazonaws.cloudsearch#FieldName" }, "AnalysisScheme": { "target": "com.amazonaws.cloudsearch#Word", @@ -2989,13 +2992,10 @@ "smithy.api#documentation": "

The name of an analysis scheme for a text field.

" } }, - "SourceField": { - "target": "com.amazonaws.cloudsearch#FieldName" - }, - "HighlightEnabled": { + "SortEnabled": { "target": "com.amazonaws.cloudsearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether highlights can be returned for the field.

" + "smithy.api#documentation": "

Whether the field can be used to sort the search results.

" } } }, @@ -3049,16 +3049,16 @@ "com.amazonaws.cloudsearch#UpdateAvailabilityOptionsRequest": { "type": "structure", "members": { - "MultiAZ": { - "target": "com.amazonaws.cloudsearch#Boolean", + "DomainName": { + "target": "com.amazonaws.cloudsearch#DomainName", "traits": { - "smithy.api#documentation": "

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

", "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.cloudsearch#DomainName", + "MultiAZ": { + "target": "com.amazonaws.cloudsearch#Boolean", "traits": { + "smithy.api#documentation": "

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

", "smithy.api#required": {} } } @@ -3119,17 +3119,17 @@ "com.amazonaws.cloudsearch#UpdateDomainEndpointOptionsRequest": { "type": "structure", "members": { - "DomainEndpointOptions": { - "target": "com.amazonaws.cloudsearch#DomainEndpointOptions", + "DomainName": { + "target": "com.amazonaws.cloudsearch#DomainName", "traits": { - "smithy.api#documentation": "

Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

", + "smithy.api#documentation": "

A string that represents the name of a domain.

", "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.cloudsearch#DomainName", + "DomainEndpointOptions": { + "target": "com.amazonaws.cloudsearch#DomainEndpointOptions", "traits": { - "smithy.api#documentation": "

A string that represents the name of a domain.

", + "smithy.api#documentation": "

Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

", "smithy.api#required": {} } } @@ -3247,16 +3247,16 @@ "com.amazonaws.cloudsearch#UpdateServiceAccessPoliciesRequest": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.cloudsearch#DomainName", + "AccessPolicies": { + "target": "com.amazonaws.cloudsearch#PolicyDocument", "traits": { + "smithy.api#documentation": "

The access rules you want to configure. These rules replace any existing rules.

", "smithy.api#required": {} } }, - "AccessPolicies": { - "target": "com.amazonaws.cloudsearch#PolicyDocument", + "DomainName": { + "target": "com.amazonaws.cloudsearch#DomainName", "traits": { - "smithy.api#documentation": "

The access rules you want to configure. These rules replace any existing rules.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json b/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json index cbf1a831552e..0e22eddbb285 100644 --- a/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json +++ b/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json @@ -74,18 +74,18 @@ "com.amazonaws.cloudtrail#AddTagsRequest": { "type": "structure", "members": { + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "

Contains a list of CloudTrail tags, up to a limit of 50

" + } + }, "ResourceId": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "

Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", "smithy.api#required": {} } - }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList", - "traits": { - "smithy.api#documentation": "

Contains a list of CloudTrail tags, up to a limit of 50

" - } } }, "traits": { @@ -204,7 +204,7 @@ "sdkId": "CloudTrail", "arnNamespace": "cloudtrail", "cloudFormationName": "CloudTrail", - "cloudTrailEventSource": "v20131101.cloudtrail.amazonaws.com" + "cloudTrailEventSource": "cloudtrail.amazonaws.com" }, "aws.auth#sigv4": { "name": "cloudtrail" @@ -332,13 +332,6 @@ "com.amazonaws.cloudtrail#CreateTrailRequest": { "type": "structure", "members": { - "S3BucketName": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

", - "smithy.api#required": {} - } - }, "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { @@ -351,26 +344,29 @@ "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" } }, - "CloudWatchLogsRoleArn": { + "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group \n to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

" } }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" + "smithy.api#documentation": "

Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. \n The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in \n AWS Organizations.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#String", + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The\n value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully\n specified ARN to a key, or a globally unique identifier.

\n

Examples:

\n " + "smithy.api#documentation": "

Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider\n creating trails that log events in all regions.

" } }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList" + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" + } }, "EnableLogFileValidation": { "target": "com.amazonaws.cloudtrail#Boolean", @@ -378,29 +374,33 @@ "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

\n " } }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", + "Name": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider\n creating trails that log events in all regions.

" + "smithy.api#documentation": "

Specifies the name of the trail. The name must meet the following requirements:

\n ", + "smithy.api#required": {} } }, - "CloudWatchLogsLogGroupArn": { + "CloudWatchLogsRoleArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group \n to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

" + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" } }, - "Name": { + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the trail. The name must meet the following requirements:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The\n value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully\n specified ARN to a key, or a globally unique identifier.

\n

Examples:

\n " } }, - "IsOrganizationTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. \n The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in \n AWS Organizations.

" + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

", + "smithy.api#required": {} } } }, @@ -411,22 +411,17 @@ "com.amazonaws.cloudtrail#CreateTrailResponse": { "type": "structure", "members": { - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail exists in one region or in all regions.

" - } - }, - "SnsTopicARN": { + "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" } }, - "S3BucketName": { + "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" } }, "CloudWatchLogsRoleArn": { @@ -435,11 +430,10 @@ "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" } }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" } }, "Name": { @@ -448,28 +442,28 @@ "smithy.api#documentation": "

Specifies the name of the trail.

" } }, - "IsOrganizationTrail": { + "IsMultiRegionTrail": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" + "smithy.api#documentation": "

Specifies whether the trail exists in one region or in all regions.

" } }, - "KmsKeyId": { + "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" } }, - "S3KeyPrefix": { + "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" + "smithy.api#documentation": "

Specifies the ARN of the trail that was created. The format of a trail ARN\n is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" } }, - "CloudWatchLogsLogGroupArn": { + "SnsTopicARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" } }, "IncludeGlobalServiceEvents": { @@ -478,16 +472,22 @@ "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" } }, - "LogFileValidationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" } }, - "TrailARN": { + "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail that was created. The format of a trail ARN\n is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" } } }, @@ -652,28 +652,28 @@ "com.amazonaws.cloudtrail#Event": { "type": "structure", "members": { - "Username": { + "ReadOnly": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

A user name or role name of the requester that called the API in the event returned.

" + "smithy.api#documentation": "

Information about whether the event is a write event or a read event.

" } }, - "ReadOnly": { - "target": "com.amazonaws.cloudtrail#String", + "Resources": { + "target": "com.amazonaws.cloudtrail#ResourceList", "traits": { - "smithy.api#documentation": "

Information about whether the event is a write event or a read event.

" + "smithy.api#documentation": "

A list of resources referenced by the event returned.

" } }, - "EventSource": { + "EventName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The AWS service that the request was made to.

" + "smithy.api#documentation": "

The name of the event returned.

" } }, - "CloudTrailEvent": { + "AccessKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

A JSON string that contains a representation of the event returned.

" + "smithy.api#documentation": "

The AWS access key ID that was used to sign the request. If the request was made \n with temporary security credentials, this is the access key ID of the temporary credentials.

" } }, "EventId": { @@ -682,28 +682,28 @@ "smithy.api#documentation": "

The CloudTrail ID of the event returned.

" } }, - "EventName": { - "target": "com.amazonaws.cloudtrail#String", + "EventTime": { + "target": "com.amazonaws.cloudtrail#Date", "traits": { - "smithy.api#documentation": "

The name of the event returned.

" + "smithy.api#documentation": "

The date and time of the event returned.

" } }, - "Resources": { - "target": "com.amazonaws.cloudtrail#ResourceList", + "Username": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

A list of resources referenced by the event returned.

" + "smithy.api#documentation": "

A user name or role name of the requester that called the API in the event returned.

" } }, - "AccessKeyId": { + "CloudTrailEvent": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The AWS access key ID that was used to sign the request. If the request was made \n with temporary security credentials, this is the access key ID of the temporary credentials.

" + "smithy.api#documentation": "

A JSON string that contains a representation of the event returned.

" } }, - "EventTime": { - "target": "com.amazonaws.cloudtrail#Date", + "EventSource": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The date and time of the event returned.

" + "smithy.api#documentation": "

The AWS service that the request was made to.

" } } }, @@ -725,12 +725,6 @@ "com.amazonaws.cloudtrail#EventSelector": { "type": "structure", "members": { - "DataResources": { - "target": "com.amazonaws.cloudtrail#DataResources", - "traits": { - "smithy.api#documentation": "

CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify \n up to 250 resources for an individual event selector, but the total number of data resources cannot exceed \n 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

\n

For more information, see Data Events and Limits in AWS CloudTrail \n in the AWS CloudTrail User Guide.

" - } - }, "ExcludeManagementEventSources": { "target": "com.amazonaws.cloudtrail#ExcludeManagementEventSources", "traits": { @@ -748,6 +742,12 @@ "traits": { "smithy.api#documentation": "

Specify if you want your event selector to include management events for your trail.

\n

\n For more information, see Management Events in the AWS CloudTrail User Guide.

\n \n

By default, the value is true.

" } + }, + "DataResources": { + "target": "com.amazonaws.cloudtrail#DataResources", + "traits": { + "smithy.api#documentation": "

CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify \n up to 250 resources for an individual event selector, but the total number of data resources cannot exceed \n 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

\n

For more information, see Data Events and Limits in AWS CloudTrail \n in the AWS CloudTrail User Guide.

" + } } }, "traits": { @@ -979,37 +979,37 @@ "com.amazonaws.cloudtrail#GetTrailStatusResponse": { "type": "structure", "members": { - "LatestCloudWatchLogsDeliveryError": { + "LatestNotificationError": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

" + "smithy.api#documentation": "

Displays any Amazon SNS error that CloudTrail encountered when attempting to send a\n notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.\n

" } }, - "TimeLoggingStopped": { - "target": "com.amazonaws.cloudtrail#String", + "LatestDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" + "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

" } }, - "TimeLoggingStarted": { + "LatestDeliveryError": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" + "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files\n to the designated bucket. For more information see the topic Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket and will\n not occur for timeouts. To resolve the issue, create a new bucket and call\n UpdateTrail to specify the new bucket, or fix the existing objects so that\n CloudTrail can again write to the bucket.

\n " } }, - "LatestNotificationAttemptTime": { + "LatestNotificationAttemptSucceeded": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "

This field is no longer in use.

" } }, - "LatestNotificationAttemptSucceeded": { - "target": "com.amazonaws.cloudtrail#String", + "LatestCloudWatchLogsDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", "traits": { - "smithy.api#documentation": "

This field is no longer in use.

" + "smithy.api#documentation": "

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" } }, - "LatestDeliveryAttemptSucceeded": { + "TimeLoggingStopped": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "

This field is no longer in use.

" @@ -1021,40 +1021,28 @@ "smithy.api#documentation": "

This field is no longer in use.

" } }, - "StartLoggingTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.

" - } - }, - "LatestDeliveryTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

" - } - }, - "LatestNotificationError": { + "LatestNotificationAttemptTime": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Displays any Amazon SNS error that CloudTrail encountered when attempting to send a\n notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.\n

" + "smithy.api#documentation": "

This field is no longer in use.

" } }, - "LatestCloudWatchLogsDeliveryTime": { + "StartLoggingTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { - "smithy.api#documentation": "

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" + "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.

" } }, - "LatestDigestDeliveryError": { + "TimeLoggingStarted": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest\n file to the designated bucket. For more information see the topic Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket and will\n not occur for timeouts. To resolve the issue, create a new bucket and call\n UpdateTrail to specify the new bucket, or fix the existing objects so that\n CloudTrail can again write to the bucket.

\n " + "smithy.api#documentation": "

This field is no longer in use.

" } }, - "StopLoggingTime": { - "target": "com.amazonaws.cloudtrail#Date", + "LatestCloudWatchLogsDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.

" + "smithy.api#documentation": "

Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

" } }, "IsLogging": { @@ -1063,10 +1051,16 @@ "smithy.api#documentation": "

Whether the CloudTrail is currently logging AWS API calls.

" } }, - "LatestDeliveryError": { + "LatestDigestDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

" + } + }, + "LatestDeliveryAttemptSucceeded": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files\n to the designated bucket. For more information see the topic Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket and will\n not occur for timeouts. To resolve the issue, create a new bucket and call\n UpdateTrail to specify the new bucket, or fix the existing objects so that\n CloudTrail can again write to the bucket.

\n " + "smithy.api#documentation": "

This field is no longer in use.

" } }, "LatestNotificationTime": { @@ -1075,10 +1069,16 @@ "smithy.api#documentation": "

Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

" } }, - "LatestDigestDeliveryTime": { + "LatestDigestDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest\n file to the designated bucket. For more information see the topic Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket and will\n not occur for timeouts. To resolve the issue, create a new bucket and call\n UpdateTrail to specify the new bucket, or fix the existing objects so that\n CloudTrail can again write to the bucket.

\n " + } + }, + "StopLoggingTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { - "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

" + "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.

" } } }, @@ -1569,6 +1569,12 @@ "com.amazonaws.cloudtrail#ListPublicKeysRequest": { "type": "structure", "members": { + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

" + } + }, "NextToken": { "target": "com.amazonaws.cloudtrail#String", "traits": { @@ -1580,12 +1586,6 @@ "traits": { "smithy.api#documentation": "

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

" } - }, - "StartTime": { - "target": "com.amazonaws.cloudtrail#Date", - "traits": { - "smithy.api#documentation": "

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

" - } } }, "traits": { @@ -1595,17 +1595,17 @@ "com.amazonaws.cloudtrail#ListPublicKeysResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, "PublicKeyList": { "target": "com.amazonaws.cloudtrail#PublicKeyList", "traits": { "smithy.api#documentation": "

Contains an array of PublicKey objects.

\n \n

The returned public keys may have validity time ranges that overlap.

\n " } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } } }, "traits": { @@ -1734,34 +1734,34 @@ "com.amazonaws.cloudtrail#ListTrailsResponse": { "type": "structure", "members": { - "Trails": { - "target": "com.amazonaws.cloudtrail#Trails", - "traits": { - "smithy.api#documentation": "

Returns the name, ARN, and home region of trails in the current account.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token does not appear, \n there are no more results to return. The token must be passed in with the same parameters as the previous call. \n For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with \n NextToken should include those same parameters.

" } + }, + "Trails": { + "target": "com.amazonaws.cloudtrail#Trails", + "traits": { + "smithy.api#documentation": "

Returns the name, ARN, and home region of trails in the current account.

" + } } } }, "com.amazonaws.cloudtrail#LookupAttribute": { "type": "structure", "members": { - "AttributeKey": { - "target": "com.amazonaws.cloudtrail#LookupAttributeKey", + "AttributeValue": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies an attribute on which to filter the events returned.

", + "smithy.api#documentation": "

Specifies a value for the specified AttributeKey.

", "smithy.api#required": {} } }, - "AttributeValue": { - "target": "com.amazonaws.cloudtrail#String", + "AttributeKey": { + "target": "com.amazonaws.cloudtrail#LookupAttributeKey", "traits": { - "smithy.api#documentation": "

Specifies a value for the specified AttributeKey.

", + "smithy.api#documentation": "

Specifies an attribute on which to filter the events returned.

", "smithy.api#required": {} } } @@ -1860,22 +1860,22 @@ "com.amazonaws.cloudtrail#LookupEventsRequest": { "type": "structure", "members": { - "LookupAttributes": { - "target": "com.amazonaws.cloudtrail#LookupAttributesList", + "NextToken": { + "target": "com.amazonaws.cloudtrail#NextToken", "traits": { - "smithy.api#documentation": "

Contains a list of lookup attributes. Currently the list can contain only one item.

" + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. \n For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } }, - "StartTime": { - "target": "com.amazonaws.cloudtrail#Date", + "LookupAttributes": { + "target": "com.amazonaws.cloudtrail#LookupAttributesList", "traits": { - "smithy.api#documentation": "

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

" + "smithy.api#documentation": "

Contains a list of lookup attributes. Currently the list can contain only one item.

" } }, - "NextToken": { - "target": "com.amazonaws.cloudtrail#NextToken", + "MaxResults": { + "target": "com.amazonaws.cloudtrail#MaxResults", "traits": { - "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. \n For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" + "smithy.api#documentation": "

The number of events to return. Possible values are 1 through 50. The default is 50.

" } }, "EventCategory": { @@ -1884,10 +1884,10 @@ "smithy.api#documentation": "

Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, \n if you do not specify insight as the value of EventCategory, no Insights events are returned.

" } }, - "MaxResults": { - "target": "com.amazonaws.cloudtrail#MaxResults", + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", "traits": { - "smithy.api#documentation": "

The number of events to return. Possible values are 1 through 50. The default is 50.

" + "smithy.api#documentation": "

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

" } }, "EndTime": { @@ -2017,28 +2017,28 @@ "com.amazonaws.cloudtrail#PublicKey": { "type": "structure", "members": { - "Fingerprint": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

The fingerprint of the public key.

" - } - }, "Value": { "target": "com.amazonaws.cloudtrail#ByteBuffer", "traits": { "smithy.api#documentation": "

The DER encoded public key value in PKCS#1 format.

" } }, + "ValidityStartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The starting time of validity of the public key.

" + } + }, "ValidityEndTime": { "target": "com.amazonaws.cloudtrail#Date", "traits": { "smithy.api#documentation": "

The ending time of validity of the public key.

" } }, - "ValidityStartTime": { - "target": "com.amazonaws.cloudtrail#Date", + "Fingerprint": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The starting time of validity of the public key.

" + "smithy.api#documentation": "

The fingerprint of the public key.

" } } }, @@ -2094,17 +2094,17 @@ "com.amazonaws.cloudtrail#PutEventSelectorsRequest": { "type": "structure", "members": { - "EventSelectors": { - "target": "com.amazonaws.cloudtrail#EventSelectors", + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.

", + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the\n string must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", "smithy.api#required": {} } }, - "TrailName": { - "target": "com.amazonaws.cloudtrail#String", + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", "traits": { - "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the\n string must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#documentation": "

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.

", "smithy.api#required": {} } } @@ -2113,17 +2113,17 @@ "com.amazonaws.cloudtrail#PutEventSelectorsResponse": { "type": "structure", "members": { - "EventSelectors": { - "target": "com.amazonaws.cloudtrail#EventSelectors", - "traits": { - "smithy.api#documentation": "

Specifies the event selectors configured for your trail.

" - } - }, "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "

Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN\n is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" } + }, + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the event selectors configured for your trail.

" + } } } }, @@ -2172,17 +2172,17 @@ "com.amazonaws.cloudtrail#PutInsightSelectorsRequest": { "type": "structure", "members": { - "TrailName": { - "target": "com.amazonaws.cloudtrail#String", + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", "traits": { - "smithy.api#documentation": "

The name of the CloudTrail trail for which you want to change or add Insights selectors.

", + "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

", "smithy.api#required": {} } }, - "InsightSelectors": { - "target": "com.amazonaws.cloudtrail#InsightSelectors", + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

", + "smithy.api#documentation": "

The name of the CloudTrail trail for which you want to change or add Insights selectors.

", "smithy.api#required": {} } } @@ -2191,17 +2191,17 @@ "com.amazonaws.cloudtrail#PutInsightSelectorsResponse": { "type": "structure", "members": { - "InsightSelectors": { - "target": "com.amazonaws.cloudtrail#InsightSelectors", - "traits": { - "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

" - } - }, "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.

" } + }, + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", + "traits": { + "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

" + } } } }, @@ -2345,17 +2345,17 @@ "com.amazonaws.cloudtrail#ResourceTag": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the resource.

" - } - }, "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList", "traits": { "smithy.api#documentation": "

A list of tags.

" } + }, + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the resource.

" + } } }, "traits": { @@ -2568,28 +2568,35 @@ "com.amazonaws.cloudtrail#Trail": { "type": "structure", "members": { - "TrailARN": { + "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" } }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", + "HomeRegion": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether the trail exists only in one region or exists in all regions.

" + "smithy.api#documentation": "

The region in which the trail was created.

" } }, - "HasCustomEventSelectors": { + "IsOrganizationTrail": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies if the trail has custom event selectors.

" + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" } }, - "Name": { + "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Name of the trail set by calling CreateTrail. The maximum length is 128\n characters.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + } + }, + "HasCustomEventSelectors": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies if the trail has custom event selectors.

" } }, "CloudWatchLogsRoleArn": { @@ -2598,41 +2605,40 @@ "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" } }, - "IsOrganizationTrail": { + "LogFileValidationEnabled": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" + "smithy.api#documentation": "

Specifies whether log file validation is enabled.

" } }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + "smithy.api#documentation": "

Specifies whether the trail exists only in one region or exists in all regions.

" } }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", + "SnsTopicARN": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Set to True to include AWS API calls from AWS global services such as IAM.\n Otherwise, False.

" + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications\n when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" } }, - "KmsKeyId": { + "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + "smithy.api#documentation": "

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

" } }, - "S3KeyPrefix": { + "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

" + "smithy.api#documentation": "

Name of the trail set by calling CreateTrail. The maximum length is 128\n characters.

" } }, - "HomeRegion": { + "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The region in which the trail was created.

" + "smithy.api#documentation": "

Specifies the ARN of the trail. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" } }, "HasInsightSelectors": { @@ -2647,22 +2653,16 @@ "smithy.api#documentation": "

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

" } }, - "SnsTopicARN": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications\n when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" - } - }, - "LogFileValidationEnabled": { + "IncludeGlobalServiceEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether log file validation is enabled.

" + "smithy.api#documentation": "

Set to True to include AWS API calls from AWS global services such as IAM.\n Otherwise, False.

" } }, - "CloudWatchLogsLogGroupArn": { + "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

" } } }, @@ -2689,22 +2689,22 @@ "com.amazonaws.cloudtrail#TrailInfo": { "type": "structure", "members": { - "TrailARN": { + "HomeRegion": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The ARN of a trail.

" + "smithy.api#documentation": "

The AWS region in which a trail was created.

" } }, - "Name": { + "TrailARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The name of a trail.

" + "smithy.api#documentation": "

The ARN of a trail.

" } }, - "HomeRegion": { + "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The AWS region in which a trail was created.

" + "smithy.api#documentation": "

The name of a trail.

" } } }, @@ -2877,6 +2877,19 @@ "com.amazonaws.cloudtrail#UpdateTrailRequest": { "type": "structure", "members": { + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:

\n \n

If Name is a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + }, "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { @@ -2889,22 +2902,16 @@ "smithy.api#documentation": "

Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, \n shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region \n where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider\n using trails that log events in all regions.

" } }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.cloudtrail#String", + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The\n value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully\n specified ARN to a key, or a globally unique identifier.

\n

Examples:

\n " + "smithy.api#documentation": "

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. \n The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in \n AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong\n to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be \n deleted from all member accounts in the organization.

" } }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", + "EnableLogFileValidation": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" + "smithy.api#documentation": "

Specifies whether log file validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

\n " } }, "CloudWatchLogsLogGroupArn": { @@ -2919,29 +2926,22 @@ "smithy.api#documentation": "

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

" } }, - "IncludeGlobalServiceEvents": { - "target": "com.amazonaws.cloudtrail#Boolean", + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" } }, - "EnableLogFileValidation": { - "target": "com.amazonaws.cloudtrail#Boolean", + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether log file validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

\n " + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The\n value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully\n specified ARN to a key, or a globally unique identifier.

\n

Examples:

\n " } }, - "IsOrganizationTrail": { + "IncludeGlobalServiceEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. \n The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in \n AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong\n to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be \n deleted from all member accounts in the organization.

" - } - }, - "Name": { - "target": "com.amazonaws.cloudtrail#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:

\n \n

If Name is a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" } } }, @@ -2952,16 +2952,17 @@ "com.amazonaws.cloudtrail#UpdateTrailResponse": { "type": "structure", "members": { - "CloudWatchLogsRoleArn": { + "SnsTopicName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" } }, - "IsOrganizationTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

\n \n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" } }, "Name": { @@ -2970,22 +2971,28 @@ "smithy.api#documentation": "

Specifies the name of the trail.

" } }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

" + } + }, "IncludeGlobalServiceEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" } }, - "LogFileValidationEnabled": { - "target": "com.amazonaws.cloudtrail#Boolean", + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" } }, - "S3BucketName": { + "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" } }, "SnsTopicARN": { @@ -2994,29 +3001,28 @@ "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications\n when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" } }, - "S3KeyPrefix": { - "target": "com.amazonaws.cloudtrail#String", + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" } }, - "SnsTopicName": { - "target": "com.amazonaws.cloudtrail#String", + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + "smithy.api#documentation": "

Specifies whether the trail exists in one region or in all regions.

" } }, - "CloudWatchLogsLogGroupArn": { + "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" } }, - "KmsKeyId": { + "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

\n \n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" } }, "TrailARN": { @@ -3024,12 +3030,6 @@ "traits": { "smithy.api#documentation": "

Specifies the ARN of the trail that was updated. The format of a trail ARN\n is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" } - }, - "IsMultiRegionTrail": { - "target": "com.amazonaws.cloudtrail#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the trail exists in one region or in all regions.

" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json b/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json index 1dd5682dabbb..0a86b2d064f3 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-events.2015-10-07.json @@ -132,7 +132,7 @@ "sdkId": "CloudWatch Events", "arnNamespace": "events", "cloudFormationName": "Events", - "cloudTrailEventSource": "v20151007.jetstream.amazon.com" + "cloudTrailEventSource": "cloudwatchevents.amazonaws.com" }, "aws.auth#sigv4": { "name": "events" @@ -230,10 +230,11 @@ "com.amazonaws.cloudwatchevents#AwsVpcConfiguration": { "type": "structure", "members": { - "AssignPublicIp": { - "target": "com.amazonaws.cloudwatchevents#AssignPublicIp", + "Subnets": { + "target": "com.amazonaws.cloudwatchevents#StringList", "traits": { - "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address.\n You can specify ENABLED only when LaunchType in\n EcsParameters is set to FARGATE.

" + "smithy.api#documentation": "

Specifies the subnets associated with the task. These subnets must all be in the same\n VPC. You can specify as many as 16 subnets.

", + "smithy.api#required": {} } }, "SecurityGroups": { @@ -242,11 +243,10 @@ "smithy.api#documentation": "

Specifies the security groups associated with the task. These security groups must all\n be in the same VPC. You can specify as many as five security groups. If you do not\n specify a security group, the default security group for the VPC is used.

" } }, - "Subnets": { - "target": "com.amazonaws.cloudwatchevents#StringList", + "AssignPublicIp": { + "target": "com.amazonaws.cloudwatchevents#AssignPublicIp", "traits": { - "smithy.api#documentation": "

Specifies the subnets associated with the task. These subnets must all be in the same\n VPC. You can specify as many as 16 subnets.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address.\n You can specify ENABLED only when LaunchType in\n EcsParameters is set to FARGATE.

" } } }, @@ -271,10 +271,11 @@ "com.amazonaws.cloudwatchevents#BatchParameters": { "type": "structure", "members": { - "ArrayProperties": { - "target": "com.amazonaws.cloudwatchevents#BatchArrayProperties", + "JobName": { + "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The\n array size can be between 2 and 10,000. If you specify array properties for a job, it\n becomes an array job. This parameter is used only if the target is an AWS Batch\n job.

" + "smithy.api#documentation": "

The name to use for this execution of the job, if the target is an AWS Batch\n job.

", + "smithy.api#required": {} } }, "JobDefinition": { @@ -284,11 +285,10 @@ "smithy.api#required": {} } }, - "JobName": { - "target": "com.amazonaws.cloudwatchevents#String", + "ArrayProperties": { + "target": "com.amazonaws.cloudwatchevents#BatchArrayProperties", "traits": { - "smithy.api#documentation": "

The name to use for this execution of the job, if the target is an AWS Batch\n job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The\n array size can be between 2 and 10,000. If you specify array properties for a job, it\n becomes an array job. This parameter is used only if the target is an AWS Batch\n job.

" } }, "RetryStrategy": { @@ -334,24 +334,24 @@ "com.amazonaws.cloudwatchevents#Condition": { "type": "structure", "members": { - "Type": { + "Value": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

Specifies the type of condition. Currently the only supported value is\n StringEquals.

", + "smithy.api#documentation": "

Specifies the value for the key. Currently, this must be the ID of the\n organization.

", "smithy.api#required": {} } }, - "Value": { + "Key": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

Specifies the value for the key. Currently, this must be the ID of the\n organization.

", + "smithy.api#documentation": "

Specifies the key for the condition. Currently the only supported key is\n aws:PrincipalOrgID.

", "smithy.api#required": {} } }, - "Key": { + "Type": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

Specifies the key for the condition. Currently the only supported key is\n aws:PrincipalOrgID.

", + "smithy.api#documentation": "

Specifies the type of condition. Currently the only supported value is\n StringEquals.

", "smithy.api#required": {} } } @@ -404,18 +404,18 @@ "smithy.api#documentation": "

If you are creating a partner event bus, this specifies the partner event source that\n the new event bus will be matched with.

" } }, + "Tags": { + "target": "com.amazonaws.cloudwatchevents#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the event bus.

" + } + }, "Name": { "target": "com.amazonaws.cloudwatchevents#EventBusName", "traits": { "smithy.api#documentation": "

The name of the new event bus.

\n

Event bus names cannot contain the / character. You can't use the name\n default for a custom event bus, as this name is already used for your\n account's default event bus.

\n

If this is a partner event bus, the name must exactly match the name of the partner\n event source that this event bus is matched to.

", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.cloudwatchevents#TagList", - "traits": { - "smithy.api#documentation": "

Tags to associate with the event bus.

" - } } } }, @@ -462,17 +462,17 @@ "com.amazonaws.cloudwatchevents#CreatePartnerEventSourceRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.cloudwatchevents#EventSourceName", + "Account": { + "target": "com.amazonaws.cloudwatchevents#AccountId", "traits": { - "smithy.api#documentation": "

The name of the partner event source. This name must be unique and must be in the\n format\n \n partner_name/event_namespace/event_name\n .\n The AWS account that wants to use this partner event source must create a partner event\n bus with a name that matches the name of the partner event source.

", + "smithy.api#documentation": "

The AWS account ID that is permitted to create a matching partner event bus for this\n partner event source.

", "smithy.api#required": {} } }, - "Account": { - "target": "com.amazonaws.cloudwatchevents#AccountId", + "Name": { + "target": "com.amazonaws.cloudwatchevents#EventSourceName", "traits": { - "smithy.api#documentation": "

The AWS account ID that is permitted to create a matching partner event bus for this\n partner event source.

", + "smithy.api#documentation": "

The name of the partner event source. This name must be unique and must be in the\n format\n \n partner_name/event_namespace/event_name\n .\n The AWS account that wants to use this partner event source must create a partner event\n bus with a name that matches the name of the partner event source.

", "smithy.api#required": {} } } @@ -489,6 +489,26 @@ } } }, + "com.amazonaws.cloudwatchevents#Database": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "([a-zA-Z0-9]+)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + } + }, + "com.amazonaws.cloudwatchevents#DbUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "([a-zA-Z0-9]+)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + } + }, "com.amazonaws.cloudwatchevents#DeactivateEventSource": { "type": "operation", "input": { @@ -527,6 +547,20 @@ } } }, + "com.amazonaws.cloudwatchevents#DeadLetterConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudwatchevents#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SQS queue specified as the target for the dead-letter queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

" + } + }, "com.amazonaws.cloudwatchevents#DeleteEventBus": { "type": "operation", "input": { @@ -621,6 +655,12 @@ "com.amazonaws.cloudwatchevents#DeleteRuleRequest": { "type": "structure", "members": { + "Force": { + "target": "com.amazonaws.cloudwatchevents#Boolean", + "traits": { + "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to delete the rule. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed\n rule by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" + } + }, "EventBusName": { "target": "com.amazonaws.cloudwatchevents#EventBusName", "traits": { @@ -633,12 +673,6 @@ "smithy.api#documentation": "

The name of the rule.

", "smithy.api#required": {} } - }, - "Force": { - "target": "com.amazonaws.cloudwatchevents#Boolean", - "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to delete the rule. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed\n rule by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" - } } } }, @@ -676,16 +710,16 @@ "com.amazonaws.cloudwatchevents#DescribeEventBusResponse": { "type": "structure", "members": { - "Name": { + "Arn": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The name of the event bus. Currently, this is always\n default.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account permitted to write events to the\n current account.

" } }, - "Arn": { + "Name": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account permitted to write events to the\n current account.

" + "smithy.api#documentation": "

The name of the event bus. Currently, this is always\n default.

" } }, "Policy": { @@ -734,10 +768,16 @@ "com.amazonaws.cloudwatchevents#DescribeEventSourceResponse": { "type": "structure", "members": { - "CreatedBy": { + "ExpirationTime": { + "target": "com.amazonaws.cloudwatchevents#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source will expire if you do not create a matching\n event bus.

" + } + }, + "Arn": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The name of the SaaS partner that created the event source.

" + "smithy.api#documentation": "

The ARN of the partner event source.

" } }, "Name": { @@ -746,16 +786,16 @@ "smithy.api#documentation": "

The name of the partner event source.

" } }, - "ExpirationTime": { + "CreationTime": { "target": "com.amazonaws.cloudwatchevents#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire if you do not create a matching\n event bus.

" + "smithy.api#documentation": "

The date and time that the event source was created.

" } }, - "Arn": { + "CreatedBy": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The ARN of the partner event source.

" + "smithy.api#documentation": "

The name of the SaaS partner that created the event source.

" } }, "State": { @@ -763,12 +803,6 @@ "traits": { "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching\n event bus for this event source, and that event bus is active. If it is PENDING, either\n you haven't yet created a matching event bus, or that event bus is deactivated. If it is\n DELETED, you have created a matching event bus, but the event source has since been\n deleted.

" } - }, - "CreationTime": { - "target": "com.amazonaws.cloudwatchevents#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the event source was created.

" - } } } }, @@ -847,40 +881,34 @@ "com.amazonaws.cloudwatchevents#DescribeRuleRequest": { "type": "structure", "members": { - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#EventBusName", - "traits": { - "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" - } - }, "Name": { "target": "com.amazonaws.cloudwatchevents#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

", "smithy.api#required": {} } + }, + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" + } } } }, "com.amazonaws.cloudwatchevents#DescribeRuleResponse": { "type": "structure", "members": { - "ScheduleExpression": { - "target": "com.amazonaws.cloudwatchevents#ScheduleExpression", - "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" - } - }, - "Name": { - "target": "com.amazonaws.cloudwatchevents#RuleName", + "State": { + "target": "com.amazonaws.cloudwatchevents#RuleState", "traits": { - "smithy.api#documentation": "

The name of the rule.

" + "smithy.api#documentation": "

Specifies whether the rule is enabled or disabled.

" } }, - "RoleArn": { - "target": "com.amazonaws.cloudwatchevents#RoleArn", + "ManagedBy": { + "target": "com.amazonaws.cloudwatchevents#ManagedBy", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, this field\n displays the principal name of the AWS service that created the rule.

" } }, "EventBusName": { @@ -889,16 +917,22 @@ "smithy.api#documentation": "

The event bus associated with the rule.

" } }, - "State": { - "target": "com.amazonaws.cloudwatchevents#RuleState", + "Description": { + "target": "com.amazonaws.cloudwatchevents#RuleDescription", "traits": { - "smithy.api#documentation": "

Specifies whether the rule is enabled or disabled.

" + "smithy.api#documentation": "

The description of the rule.

" } }, - "Arn": { - "target": "com.amazonaws.cloudwatchevents#RuleArn", + "RoleArn": { + "target": "com.amazonaws.cloudwatchevents#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudwatchevents#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

" } }, "EventPattern": { @@ -907,16 +941,16 @@ "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

" } }, - "ManagedBy": { - "target": "com.amazonaws.cloudwatchevents#ManagedBy", + "Arn": { + "target": "com.amazonaws.cloudwatchevents#RuleArn", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, this field\n displays the principal name of the AWS service that created the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" } }, - "Description": { - "target": "com.amazonaws.cloudwatchevents#RuleDescription", + "ScheduleExpression": { + "target": "com.amazonaws.cloudwatchevents#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The description of the rule.

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" } } } @@ -965,16 +999,16 @@ "com.amazonaws.cloudwatchevents#EcsParameters": { "type": "structure", "members": { - "Group": { - "target": "com.amazonaws.cloudwatchevents#String", + "NetworkConfiguration": { + "target": "com.amazonaws.cloudwatchevents#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

Specifies an ECS task group for the task. The maximum length is 255 characters.

" + "smithy.api#documentation": "

Use this structure if the ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and\n whether a public IP address is to be used. This structure is required if\n LaunchType is FARGATE because the awsvpc mode\n is required for Fargate tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use\n the awsvpc network mode, the task fails.

" } }, - "TaskCount": { - "target": "com.amazonaws.cloudwatchevents#LimitMin1", + "Group": { + "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is\n 1.

" + "smithy.api#documentation": "

Specifies an ECS task group for the task. The maximum length is 255 characters.

" } }, "PlatformVersion": { @@ -983,10 +1017,10 @@ "smithy.api#documentation": "

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For\n more information about valid platform versions, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

" } }, - "NetworkConfiguration": { - "target": "com.amazonaws.cloudwatchevents#NetworkConfiguration", + "TaskCount": { + "target": "com.amazonaws.cloudwatchevents#LimitMin1", "traits": { - "smithy.api#documentation": "

Use this structure if the ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and\n whether a public IP address is to be used. This structure is required if\n LaunchType is FARGATE because the awsvpc mode\n is required for Fargate tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use\n the awsvpc network mode, the task fails.

" + "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is\n 1.

" } }, "TaskDefinitionArn": { @@ -1057,16 +1091,16 @@ "com.amazonaws.cloudwatchevents#EventBus": { "type": "structure", "members": { - "Arn": { + "Name": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The ARN of the event bus.

" + "smithy.api#documentation": "

The name of the event bus.

" } }, - "Name": { + "Arn": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The name of the event bus.

" + "smithy.api#documentation": "

The ARN of the event bus.

" } }, "Policy": { @@ -1114,10 +1148,16 @@ "com.amazonaws.cloudwatchevents#EventSource": { "type": "structure", "members": { - "Name": { + "Arn": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The name of the event source.

" + "smithy.api#documentation": "

The ARN of the event source.

" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.cloudwatchevents#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" } }, "State": { @@ -1132,22 +1172,16 @@ "smithy.api#documentation": "

The name of the partner that created the event source.

" } }, - "CreationTime": { - "target": "com.amazonaws.cloudwatchevents#Timestamp", + "Name": { + "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The date and time the event source was created.

" + "smithy.api#documentation": "

The name of the event source.

" } }, - "ExpirationTime": { + "CreationTime": { "target": "com.amazonaws.cloudwatchevents#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" - } - }, - "Arn": { - "target": "com.amazonaws.cloudwatchevents#String", - "traits": { - "smithy.api#documentation": "

The ARN of the event source.

" + "smithy.api#documentation": "

The date and time the event source was created.

" } } }, @@ -1235,20 +1269,20 @@ "com.amazonaws.cloudwatchevents#HttpParameters": { "type": "structure", "members": { - "HeaderParameters": { - "target": "com.amazonaws.cloudwatchevents#HeaderParametersMap", - "traits": { - "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST \n API.

" - } - }, "PathParameterValues": { "target": "com.amazonaws.cloudwatchevents#PathParameterList", "traits": { "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API\n path wildcards (\"*\").

" } }, - "QueryStringParameters": { - "target": "com.amazonaws.cloudwatchevents#QueryStringParametersMap", + "HeaderParameters": { + "target": "com.amazonaws.cloudwatchevents#HeaderParametersMap", + "traits": { + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST \n API.

" + } + }, + "QueryStringParameters": { + "target": "com.amazonaws.cloudwatchevents#QueryStringParametersMap", "traits": { "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the \n API Gateway REST API.

" } @@ -1409,6 +1443,12 @@ "com.amazonaws.cloudwatchevents#ListEventBusesRequest": { "type": "structure", "members": { + "Limit": { + "target": "com.amazonaws.cloudwatchevents#LimitMax100", + "traits": { + "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" + } + }, "NamePrefix": { "target": "com.amazonaws.cloudwatchevents#EventBusName", "traits": { @@ -1420,29 +1460,23 @@ "traits": { "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

" } - }, - "Limit": { - "target": "com.amazonaws.cloudwatchevents#LimitMax100", - "traits": { - "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" - } } } }, "com.amazonaws.cloudwatchevents#ListEventBusesResponse": { "type": "structure", "members": { - "EventBuses": { - "target": "com.amazonaws.cloudwatchevents#EventBusList", - "traits": { - "smithy.api#documentation": "

This list of event buses.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudwatchevents#NextToken", "traits": { "smithy.api#documentation": "

A token you can use in a subsequent operation to retrieve the next set of\n results.

" } + }, + "EventBuses": { + "target": "com.amazonaws.cloudwatchevents#EventBusList", + "traits": { + "smithy.api#documentation": "

This list of event buses.

" + } } } }, @@ -1469,10 +1503,10 @@ "com.amazonaws.cloudwatchevents#ListEventSourcesRequest": { "type": "structure", "members": { - "NamePrefix": { - "target": "com.amazonaws.cloudwatchevents#EventSourceNamePrefix", + "NextToken": { + "target": "com.amazonaws.cloudwatchevents#NextToken", "traits": { - "smithy.api#documentation": "

Specifying this limits the results to only those partner event sources with names that\n start with the specified prefix.

" + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

" } }, "Limit": { @@ -1481,10 +1515,10 @@ "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" } }, - "NextToken": { - "target": "com.amazonaws.cloudwatchevents#NextToken", + "NamePrefix": { + "target": "com.amazonaws.cloudwatchevents#EventSourceNamePrefix", "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

" + "smithy.api#documentation": "

Specifying this limits the results to only those partner event sources with names that\n start with the specified prefix.

" } } } @@ -1532,12 +1566,6 @@ "com.amazonaws.cloudwatchevents#ListPartnerEventSourceAccountsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudwatchevents#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" - } - }, "EventSourceName": { "target": "com.amazonaws.cloudwatchevents#EventSourceName", "traits": { @@ -1545,6 +1573,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.cloudwatchevents#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" + } + }, "Limit": { "target": "com.amazonaws.cloudwatchevents#LimitMax100", "traits": { @@ -1593,6 +1627,12 @@ "com.amazonaws.cloudwatchevents#ListPartnerEventSourcesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.cloudwatchevents#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" + } + }, "NamePrefix": { "target": "com.amazonaws.cloudwatchevents#PartnerEventSourceNamePrefix", "traits": { @@ -1605,12 +1645,6 @@ "traits": { "smithy.api#documentation": "

pecifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" } - }, - "NextToken": { - "target": "com.amazonaws.cloudwatchevents#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" - } } } }, @@ -1654,22 +1688,16 @@ "com.amazonaws.cloudwatchevents#ListRuleNamesByTargetRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.cloudwatchevents#LimitMax100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudwatchevents#NextToken", "traits": { "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" } }, - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#EventBusName", + "Limit": { + "target": "com.amazonaws.cloudwatchevents#LimitMax100", "traits": { - "smithy.api#documentation": "

Limits the results to show only the rules associated with the specified event\n bus.

" + "smithy.api#documentation": "

The maximum number of results to return.

" } }, "TargetArn": { @@ -1678,6 +1706,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target resource.

", "smithy.api#required": {} } + }, + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#EventBusName", + "traits": { + "smithy.api#documentation": "

Limits the results to show only the rules associated with the specified event\n bus.

" + } } } }, @@ -1721,10 +1755,10 @@ "com.amazonaws.cloudwatchevents#ListRulesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudwatchevents#NextToken", + "Limit": { + "target": "com.amazonaws.cloudwatchevents#LimitMax100", "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" + "smithy.api#documentation": "

The maximum number of results to return.

" } }, "EventBusName": { @@ -1739,10 +1773,10 @@ "smithy.api#documentation": "

The prefix matching the rule name.

" } }, - "Limit": { - "target": "com.amazonaws.cloudwatchevents#LimitMax100", + "NextToken": { + "target": "com.amazonaws.cloudwatchevents#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" } } } @@ -1750,17 +1784,17 @@ "com.amazonaws.cloudwatchevents#ListRulesResponse": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.cloudwatchevents#RuleResponseList", - "traits": { - "smithy.api#documentation": "

The rules that match the specified criteria.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudwatchevents#NextToken", "traits": { "smithy.api#documentation": "

Indicates whether there are additional results to retrieve. If there are no more\n results, the value is null.

" } + }, + "Rules": { + "target": "com.amazonaws.cloudwatchevents#RuleResponseList", + "traits": { + "smithy.api#documentation": "

The rules that match the specified criteria.

" + } } } }, @@ -1830,18 +1864,6 @@ "com.amazonaws.cloudwatchevents#ListTargetsByRuleRequest": { "type": "structure", "members": { - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#EventBusName", - "traits": { - "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudwatchevents#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" - } - }, "Rule": { "target": "com.amazonaws.cloudwatchevents#RuleName", "traits": { @@ -1854,23 +1876,35 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatchevents#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" + } + }, + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" + } } } }, "com.amazonaws.cloudwatchevents#ListTargetsByRuleResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudwatchevents#NextToken", - "traits": { - "smithy.api#documentation": "

Indicates whether there are additional results to retrieve. If there are no more\n results, the value is null.

" - } - }, "Targets": { "target": "com.amazonaws.cloudwatchevents#TargetList", "traits": { "smithy.api#documentation": "

The targets assigned to the rule.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatchevents#NextToken", + "traits": { + "smithy.api#documentation": "

Indicates whether there are additional results to retrieve. If there are no more\n results, the value is null.

" + } } } }, @@ -1895,6 +1929,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.cloudwatchevents#MaximumEventAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 60, + "max": 86400 + } + } + }, + "com.amazonaws.cloudwatchevents#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 185 + } + } + }, "com.amazonaws.cloudwatchevents#MessageGroupId": { "type": "string" }, @@ -1946,16 +2000,16 @@ "com.amazonaws.cloudwatchevents#PartnerEventSource": { "type": "structure", "members": { - "Name": { + "Arn": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The name of the partner event source.

" + "smithy.api#documentation": "

The ARN of the partner event source.

" } }, - "Arn": { + "Name": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The ARN of the partner event source.

" + "smithy.api#documentation": "

The name of the partner event source.

" } } }, @@ -1972,10 +2026,10 @@ "smithy.api#documentation": "

The date and time the event source was created.

" } }, - "ExpirationTime": { - "target": "com.amazonaws.cloudwatchevents#Timestamp", + "State": { + "target": "com.amazonaws.cloudwatchevents#EventSourceState", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" + "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching\n event bus for this event source, and that event bus is active. If it is PENDING, either\n you haven't yet created a matching event bus, or that event bus is deactivated. If it is\n DELETED, you have created a matching event bus, but the event source has since been\n deleted.

" } }, "Account": { @@ -1984,10 +2038,10 @@ "smithy.api#documentation": "

The AWS account ID that the partner event source was offered to.

" } }, - "State": { - "target": "com.amazonaws.cloudwatchevents#EventSourceState", + "ExpirationTime": { + "target": "com.amazonaws.cloudwatchevents#Timestamp", "traits": { - "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching\n event bus for this event source, and that event bus is active. If it is PENDING, either\n you haven't yet created a matching event bus, or that event bus is deactivated. If it is\n DELETED, you have created a matching event bus, but the event source has since been\n deleted.

" + "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" } } }, @@ -2083,40 +2137,40 @@ "com.amazonaws.cloudwatchevents#PutEventsRequestEntry": { "type": "structure", "members": { - "Source": { + "DetailType": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The source of the event.

" + "smithy.api#documentation": "

Free-form string used to decide what fields to expect in the event\n detail.

" } }, - "Time": { - "target": "com.amazonaws.cloudwatchevents#EventTime", + "Detail": { + "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp\n is provided, the time stamp of the PutEvents call is used.

" + "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. The JSON string may contain\n fields and nested subobjects.

" } }, - "Resources": { - "target": "com.amazonaws.cloudwatchevents#EventResourceList", + "Source": { + "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + "smithy.api#documentation": "

The source of the event.

" } }, - "DetailType": { - "target": "com.amazonaws.cloudwatchevents#String", + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#NonPartnerEventBusName", "traits": { - "smithy.api#documentation": "

Free-form string used to decide what fields to expect in the event\n detail.

" + "smithy.api#documentation": "

The event bus that will receive the event. Only the rules that are associated with\n this event bus will be able to match the event.

" } }, - "Detail": { - "target": "com.amazonaws.cloudwatchevents#String", + "Time": { + "target": "com.amazonaws.cloudwatchevents#EventTime", "traits": { - "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. The JSON string may contain\n fields and nested subobjects.

" + "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp\n is provided, the time stamp of the PutEvents call is used.

" } }, - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#NonPartnerEventBusName", + "Resources": { + "target": "com.amazonaws.cloudwatchevents#EventResourceList", "traits": { - "smithy.api#documentation": "

The event bus that will receive the event. Only the rules that are associated with\n this event bus will be able to match the event.

" + "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" } } }, @@ -2139,23 +2193,29 @@ "com.amazonaws.cloudwatchevents#PutEventsResponse": { "type": "structure", "members": { - "FailedEntryCount": { - "target": "com.amazonaws.cloudwatchevents#Integer", - "traits": { - "smithy.api#documentation": "

The number of failed entries.

" - } - }, "Entries": { "target": "com.amazonaws.cloudwatchevents#PutEventsResultEntryList", "traits": { "smithy.api#documentation": "

The successfully and unsuccessfully ingested events results. If the ingestion was\n successful, the entry has the event ID in it. Otherwise, you can use the error code and\n error message to identify the problem with the entry.

" } + }, + "FailedEntryCount": { + "target": "com.amazonaws.cloudwatchevents#Integer", + "traits": { + "smithy.api#documentation": "

The number of failed entries.

" + } } } }, "com.amazonaws.cloudwatchevents#PutEventsResultEntry": { "type": "structure", "members": { + "ErrorMessage": { + "target": "com.amazonaws.cloudwatchevents#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the event submission failed.

" + } + }, "ErrorCode": { "target": "com.amazonaws.cloudwatchevents#ErrorCode", "traits": { @@ -2167,12 +2227,6 @@ "traits": { "smithy.api#documentation": "

The ID of the event.

" } - }, - "ErrorMessage": { - "target": "com.amazonaws.cloudwatchevents#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message that explains why the event submission failed.

" - } } }, "traits": { @@ -2220,6 +2274,18 @@ "com.amazonaws.cloudwatchevents#PutPartnerEventsRequestEntry": { "type": "structure", "members": { + "Resources": { + "target": "com.amazonaws.cloudwatchevents#EventResourceList", + "traits": { + "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + } + }, + "Source": { + "target": "com.amazonaws.cloudwatchevents#EventSourceName", + "traits": { + "smithy.api#documentation": "

The event source that is generating the evntry.

" + } + }, "Detail": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { @@ -2232,23 +2298,11 @@ "smithy.api#documentation": "

A free-form string used to decide what fields to expect in the event detail.

" } }, - "Source": { - "target": "com.amazonaws.cloudwatchevents#EventSourceName", - "traits": { - "smithy.api#documentation": "

The event source that is generating the evntry.

" - } - }, "Time": { "target": "com.amazonaws.cloudwatchevents#EventTime", "traits": { "smithy.api#documentation": "

The date and time of the event.

" } - }, - "Resources": { - "target": "com.amazonaws.cloudwatchevents#EventResourceList", - "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" - } } }, "traits": { @@ -2287,18 +2341,18 @@ "com.amazonaws.cloudwatchevents#PutPartnerEventsResultEntry": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.cloudwatchevents#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message that explains why the event submission failed.

" - } - }, "EventId": { "target": "com.amazonaws.cloudwatchevents#EventId", "traits": { "smithy.api#documentation": "

The ID of the event.

" } }, + "ErrorMessage": { + "target": "com.amazonaws.cloudwatchevents#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the event submission failed.

" + } + }, "ErrorCode": { "target": "com.amazonaws.cloudwatchevents#ErrorCode", "traits": { @@ -2342,24 +2396,24 @@ "com.amazonaws.cloudwatchevents#PutPermissionRequest": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.cloudwatchevents#Action", + "Principal": { + "target": "com.amazonaws.cloudwatchevents#Principal", "traits": { - "smithy.api#documentation": "

The action that you are enabling the other account to perform. Currently, this must\n be events:PutEvents.

", + "smithy.api#documentation": "

The 12-digit AWS account ID that you are permitting to put events to your default\n event bus. Specify \"*\" to permit any account to put events to your default event\n bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules\n that may match undesirable events. To create more secure rules, make sure that the event\n pattern for each rule contains an account field with a specific account ID\n from which to receive events. Rules with an account field do not match any events sent\n from other accounts.

", "smithy.api#required": {} } }, - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#NonPartnerEventBusName", + "StatementId": { + "target": "com.amazonaws.cloudwatchevents#StatementId", "traits": { - "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" + "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to.\n If you later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

", + "smithy.api#required": {} } }, - "Principal": { - "target": "com.amazonaws.cloudwatchevents#Principal", + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#NonPartnerEventBusName", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account ID that you are permitting to put events to your default\n event bus. Specify \"*\" to permit any account to put events to your default event\n bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules\n that may match undesirable events. To create more secure rules, make sure that the event\n pattern for each rule contains an account field with a specific account ID\n from which to receive events. Rules with an account field do not match any events sent\n from other accounts.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" } }, "Condition": { @@ -2368,10 +2422,10 @@ "smithy.api#documentation": "

This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain AWS organization. For more information\n about AWS Organizations, see What Is AWS\n Organizations in the AWS Organizations User\n Guide.

\n

If you specify Condition with an AWS organization ID, and specify \"*\" as\n the value for Principal, you grant permission to all the accounts in the\n named organization.

\n\n

The Condition is a JSON string which must contain Type,\n Key, and Value fields.

" } }, - "StatementId": { - "target": "com.amazonaws.cloudwatchevents#StatementId", + "Action": { + "target": "com.amazonaws.cloudwatchevents#Action", "traits": { - "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to.\n If you later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

", + "smithy.api#documentation": "

The action that you are enabling the other account to perform. Currently, this must\n be events:PutEvents.

", "smithy.api#required": {} } } @@ -2412,22 +2466,16 @@ "com.amazonaws.cloudwatchevents#PutRuleRequest": { "type": "structure", "members": { - "ScheduleExpression": { - "target": "com.amazonaws.cloudwatchevents#ScheduleExpression", - "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\" or \"rate(5\n minutes)\".

" - } - }, "State": { "target": "com.amazonaws.cloudwatchevents#RuleState", "traits": { "smithy.api#documentation": "

Indicates whether the rule is enabled or disabled.

" } }, - "Description": { - "target": "com.amazonaws.cloudwatchevents#RuleDescription", + "RoleArn": { + "target": "com.amazonaws.cloudwatchevents#RoleArn", "traits": { - "smithy.api#documentation": "

A description of the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } }, "EventPattern": { @@ -2436,22 +2484,22 @@ "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

" } }, - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#EventBusName", + "Description": { + "target": "com.amazonaws.cloudwatchevents#RuleDescription", "traits": { - "smithy.api#documentation": "

The event bus to associate with this rule. If you omit this, the default event bus is\n used.

" + "smithy.api#documentation": "

A description of the rule.

" } }, - "Tags": { - "target": "com.amazonaws.cloudwatchevents#TagList", + "ScheduleExpression": { + "target": "com.amazonaws.cloudwatchevents#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The list of key-value pairs to associate with the rule.

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\" or \"rate(5\n minutes)\".

" } }, - "RoleArn": { - "target": "com.amazonaws.cloudwatchevents#RoleArn", + "Tags": { + "target": "com.amazonaws.cloudwatchevents#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + "smithy.api#documentation": "

The list of key-value pairs to associate with the rule.

" } }, "Name": { @@ -2460,6 +2508,12 @@ "smithy.api#documentation": "

The name of the rule that you are creating or updating.

", "smithy.api#required": {} } + }, + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus to associate with this rule. If you omit this, the default event bus is\n used.

" + } } } }, @@ -2500,18 +2554,12 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they\n are already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n\n\n

Creating rules with built-in targets is supported only in the AWS Management\n Console. The built-in targets are EC2 CreateSnapshot API call, EC2\n RebootInstances API call, EC2 StopInstances API call, and\n EC2 TerminateInstances API call.

\n\n

For some target types, PutTargets provides target-specific parameters.\n If the target is a Kinesis data stream, you can optionally specify which shard the event\n goes to by using the KinesisParameters argument. To invoke a command on\n multiple EC2 instances with one rule, you can use the RunCommandParameters\n field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge \n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources,\n EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles\n that you specify in the RoleARN argument in PutTargets. For more information, \n see Authentication and Access Control in the Amazon EventBridge User\n Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's\n event bus as a target of the rules in your account. To send the matched events to the\n other account, specify that account's event bus as the Arn value when you\n run PutTargets. If your account sends events to another account, your\n account is charged for each sent event. Each event sent to another account is charged as\n a custom event. The account receiving the event is not charged. For more information,\n see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are\n not available with PutTarget if the target is an event bus of a\n different AWS account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the\n account ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon\n EventBridge User Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and\n optional parameters of a target. When a rule is triggered due to a matched\n event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must\n use JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or\n updated targets might not be immediately invoked. Allow a short period of time for\n changes to take effect.

\n\n

This action can partially fail if too many requests are made at the same time. If\n that happens, FailedEntryCount is non-zero in the response and each entry\n in FailedEntries provides the ID of the failed target and the error\n code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they\n are already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n\n\n

Creating rules with built-in targets is supported only in the AWS Management\n Console. The built-in targets are EC2 CreateSnapshot API call, EC2\n RebootInstances API call, EC2 StopInstances API call, and\n EC2 TerminateInstances API call.

\n\n

For some target types, PutTargets provides target-specific parameters.\n If the target is a Kinesis data stream, you can optionally specify which shard the event\n goes to by using the KinesisParameters argument. To invoke a command on\n multiple EC2 instances with one rule, you can use the RunCommandParameters\n field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge \n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources,\n EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles\n that you specify in the RoleARN argument in PutTargets. For more information, \n see Authentication and Access Control in the Amazon EventBridge User\n Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's\n event bus as a target of the rules in your account. To send the matched events to the\n other account, specify that account's event bus as the Arn value when you\n run PutTargets. If your account sends events to another account, your\n account is charged for each sent event. Each event sent to another account is charged as\n a custom event. The account receiving the event is not charged. For more information,\n see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are\n not available with PutTarget if the target is an event bus of a\n different AWS account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the\n account ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon\n EventBridge User Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and\n optional parameters of a target. When a rule is triggered due to a matched\n event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must\n use JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or\n updated targets might not be immediately invoked. Allow a short period of time for\n changes to take effect.

\n\n

This action can partially fail if too many requests are made at the same time. If\n that happens, FailedEntryCount is non-zero in the response and each entry\n in FailedEntries provides the ID of the failed target and the error\n code.

" } }, "com.amazonaws.cloudwatchevents#PutTargetsRequest": { "type": "structure", "members": { - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#EventBusName", - "traits": { - "smithy.api#documentation": "

The name of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" - } - }, "Rule": { "target": "com.amazonaws.cloudwatchevents#RuleName", "traits": { @@ -2519,6 +2567,12 @@ "smithy.api#required": {} } }, + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#EventBusName", + "traits": { + "smithy.api#documentation": "

The name of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + }, "Targets": { "target": "com.amazonaws.cloudwatchevents#TargetList", "traits": { @@ -2531,35 +2585,35 @@ "com.amazonaws.cloudwatchevents#PutTargetsResponse": { "type": "structure", "members": { - "FailedEntries": { - "target": "com.amazonaws.cloudwatchevents#PutTargetsResultEntryList", - "traits": { - "smithy.api#documentation": "

The failed target entries.

" - } - }, "FailedEntryCount": { "target": "com.amazonaws.cloudwatchevents#Integer", "traits": { "smithy.api#documentation": "

The number of failed entries.

" } + }, + "FailedEntries": { + "target": "com.amazonaws.cloudwatchevents#PutTargetsResultEntryList", + "traits": { + "smithy.api#documentation": "

The failed target entries.

" + } } } }, "com.amazonaws.cloudwatchevents#PutTargetsResultEntry": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.cloudwatchevents#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message that explains why the target addition failed.

" - } - }, "ErrorCode": { "target": "com.amazonaws.cloudwatchevents#ErrorCode", "traits": { "smithy.api#documentation": "

The error code that indicates why the target addition failed. If the value is\n ConcurrentModificationException, too many requests were made at the\n same time.

" } }, + "ErrorMessage": { + "target": "com.amazonaws.cloudwatchevents#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the target addition failed.

" + } + }, "TargetId": { "target": "com.amazonaws.cloudwatchevents#TargetId", "traits": { @@ -2606,6 +2660,62 @@ "smithy.api#pattern": "[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+" } }, + "com.amazonaws.cloudwatchevents#RedshiftDataParameters": { + "type": "structure", + "members": { + "SecretManagerArn": { + "target": "com.amazonaws.cloudwatchevents#RedshiftSecretManagerArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database.\n Required when authenticating using AWS Secrets Manager.

" + } + }, + "DbUser": { + "target": "com.amazonaws.cloudwatchevents#DbUser", + "traits": { + "smithy.api#documentation": "

The database user name. Required when authenticating using temporary credentials.

" + } + }, + "WithEvent": { + "target": "com.amazonaws.cloudwatchevents#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to send an event back to EventBridge after the SQL statement runs.

" + } + }, + "Sql": { + "target": "com.amazonaws.cloudwatchevents#Sql", + "traits": { + "smithy.api#documentation": "

The SQL statement text to run.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.cloudwatchevents#Database", + "traits": { + "smithy.api#documentation": "

The name of the database. Required when authenticating using temporary credentials.

", + "smithy.api#required": {} + } + }, + "StatementName": { + "target": "com.amazonaws.cloudwatchevents#StatementName", + "traits": { + "smithy.api#documentation": "

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Redshift cluster\n to invoke the Redshift Data API ExecuteStatement based on EventBridge events.

" + } + }, + "com.amazonaws.cloudwatchevents#RedshiftSecretManagerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + } + }, "com.amazonaws.cloudwatchevents#RemovePermission": { "type": "operation", "input": { @@ -2673,12 +2783,6 @@ "com.amazonaws.cloudwatchevents#RemoveTargetsRequest": { "type": "structure", "members": { - "Force": { - "target": "com.amazonaws.cloudwatchevents#Boolean", - "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored\n for rules that are not managed rules. You can check whether a rule is a managed rule by\n using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" - } - }, "Ids": { "target": "com.amazonaws.cloudwatchevents#TargetIdList", "traits": { @@ -2686,6 +2790,12 @@ "smithy.api#required": {} } }, + "Force": { + "target": "com.amazonaws.cloudwatchevents#Boolean", + "traits": { + "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored\n for rules that are not managed rules. You can check whether a rule is a managed rule by\n using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" + } + }, "Rule": { "target": "com.amazonaws.cloudwatchevents#RuleName", "traits": { @@ -2704,29 +2814,23 @@ "com.amazonaws.cloudwatchevents#RemoveTargetsResponse": { "type": "structure", "members": { - "FailedEntryCount": { - "target": "com.amazonaws.cloudwatchevents#Integer", - "traits": { - "smithy.api#documentation": "

The number of failed entries.

" - } - }, "FailedEntries": { "target": "com.amazonaws.cloudwatchevents#RemoveTargetsResultEntryList", "traits": { "smithy.api#documentation": "

The failed target entries.

" } + }, + "FailedEntryCount": { + "target": "com.amazonaws.cloudwatchevents#Integer", + "traits": { + "smithy.api#documentation": "

The number of failed entries.

" + } } } }, "com.amazonaws.cloudwatchevents#RemoveTargetsResultEntry": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.cloudwatchevents#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code that indicates why the target removal failed. If the value is\n ConcurrentModificationException, too many requests were made at the\n same time.

" - } - }, "TargetId": { "target": "com.amazonaws.cloudwatchevents#TargetId", "traits": { @@ -2738,6 +2842,12 @@ "traits": { "smithy.api#documentation": "

The error message that explains why the target removal failed.

" } + }, + "ErrorCode": { + "target": "com.amazonaws.cloudwatchevents#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that indicates why the target removal failed. If the value is\n ConcurrentModificationException, too many requests were made at the\n same time.

" + } } }, "traits": { @@ -2762,6 +2872,15 @@ "smithy.api#error": "client" } }, + "com.amazonaws.cloudwatchevents#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, "com.amazonaws.cloudwatchevents#ResourceNotFoundException": { "type": "structure", "members": { @@ -2774,6 +2893,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.cloudwatchevents#RetryPolicy": { + "type": "structure", + "members": { + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.cloudwatchevents#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, to continue to make retry attempts.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.cloudwatchevents#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "

The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A RetryPolicy object that includes information about the retry policy settings.

" + } + }, "com.amazonaws.cloudwatchevents#RoleArn": { "type": "string", "traits": { @@ -2786,16 +2925,10 @@ "com.amazonaws.cloudwatchevents#Rule": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.cloudwatchevents#RuleState", - "traits": { - "smithy.api#documentation": "

The state of the rule.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.cloudwatchevents#RoleArn", + "Description": { + "target": "com.amazonaws.cloudwatchevents#RuleDescription", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target\n invocation.

" + "smithy.api#documentation": "

The description of the rule.

" } }, "Arn": { @@ -2804,16 +2937,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" } }, + "RoleArn": { + "target": "com.amazonaws.cloudwatchevents#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target\n invocation.

" + } + }, "EventPattern": { "target": "com.amazonaws.cloudwatchevents#EventPattern", "traits": { "smithy.api#documentation": "

The event pattern of the rule. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

" } }, - "EventBusName": { - "target": "com.amazonaws.cloudwatchevents#EventBusName", + "ScheduleExpression": { + "target": "com.amazonaws.cloudwatchevents#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The event bus associated with the rule.

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" } }, "ManagedBy": { @@ -2822,16 +2961,10 @@ "smithy.api#documentation": "

If the rule was created on behalf of your account by an AWS service, this field\n displays the principal name of the service that created the rule.

" } }, - "Description": { - "target": "com.amazonaws.cloudwatchevents#RuleDescription", - "traits": { - "smithy.api#documentation": "

The description of the rule.

" - } - }, - "ScheduleExpression": { - "target": "com.amazonaws.cloudwatchevents#ScheduleExpression", + "State": { + "target": "com.amazonaws.cloudwatchevents#RuleState", "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" + "smithy.api#documentation": "

The state of the rule.

" } }, "Name": { @@ -2839,6 +2972,12 @@ "traits": { "smithy.api#documentation": "

The name of the rule.

" } + }, + "EventBusName": { + "target": "com.amazonaws.cloudwatchevents#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus associated with the rule.

" + } } }, "traits": { @@ -2989,6 +3128,15 @@ } } }, + "com.amazonaws.cloudwatchevents#Sql": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + }, "com.amazonaws.cloudwatchevents#SqsParameters": { "type": "structure", "members": { @@ -3013,6 +3161,15 @@ "smithy.api#pattern": "[a-zA-Z0-9-_]+" } }, + "com.amazonaws.cloudwatchevents#StatementName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, "com.amazonaws.cloudwatchevents#String": { "type": "string" }, @@ -3025,17 +3182,17 @@ "com.amazonaws.cloudwatchevents#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.cloudwatchevents#TagValue", + "Key": { + "target": "com.amazonaws.cloudwatchevents#TagKey", "traits": { - "smithy.api#documentation": "

The value for the specified tag key.

", + "smithy.api#documentation": "

A string you can use to assign a value. The combination of tag keys and values can\n help you organize and categorize your resources.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.cloudwatchevents#TagKey", + "Value": { + "target": "com.amazonaws.cloudwatchevents#TagValue", "traits": { - "smithy.api#documentation": "

A string you can use to assign a value. The combination of tag keys and values can\n help you organize and categorize your resources.

", + "smithy.api#documentation": "

The value for the specified tag key.

", "smithy.api#required": {} } } @@ -3126,54 +3283,46 @@ "com.amazonaws.cloudwatchevents#Target": { "type": "structure", "members": { - "Input": { - "target": "com.amazonaws.cloudwatchevents#TargetInput", - "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself\n is passed to the target. For more information, see The JavaScript Object Notation\n (JSON) Data Interchange Format.

" - } - }, - "InputPath": { - "target": "com.amazonaws.cloudwatchevents#TargetInputPath", - "traits": { - "smithy.api#documentation": "

The value of the JSONPath that is used for extracting part of the matched event\n when passing it to the target. You must use JSON dot notation, not bracket notation. For\n more information about JSON paths, see JSONPath.

" - } - }, "BatchParameters": { "target": "com.amazonaws.cloudwatchevents#BatchParameters", "traits": { "smithy.api#documentation": "

If the event target is an AWS Batch job, this contains the job definition, job\n name, and other parameters. For more information, see Jobs in the AWS Batch User\n Guide.

" } }, + "InputTransformer": { + "target": "com.amazonaws.cloudwatchevents#InputTransformer", + "traits": { + "smithy.api#documentation": "

Settings to enable you to provide custom input to a target based on certain event\n data. You can extract one or more key-value pairs from the event and then use that data\n to send customized input to the target.

" + } + }, "KinesisParameters": { "target": "com.amazonaws.cloudwatchevents#KinesisParameters", "traits": { "smithy.api#documentation": "

The custom parameter you can use to control the shard assignment, when the target\n is a Kinesis data stream. If you do not include this parameter, the default is to use\n the eventId as the partition key.

" } }, - "RoleArn": { - "target": "com.amazonaws.cloudwatchevents#RoleArn", + "EcsParameters": { + "target": "com.amazonaws.cloudwatchevents#EcsParameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the\n rule is triggered. If one rule triggers multiple targets, you can use a different IAM\n role for each target.

" + "smithy.api#documentation": "

Contains the Amazon ECS task definition and task count to be used, if the event\n target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task\n Definitions in the Amazon EC2 Container Service Developer\n Guide.

" } }, - "Id": { - "target": "com.amazonaws.cloudwatchevents#TargetId", + "SqsParameters": { + "target": "com.amazonaws.cloudwatchevents#SqsParameters", "traits": { - "smithy.api#documentation": "

The ID of the target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains the message group ID to use when the target is a FIFO queue.

\n

If you specify an SQS FIFO queue as a target, the queue must have content-based\n deduplication enabled.

" } }, - "InputTransformer": { - "target": "com.amazonaws.cloudwatchevents#InputTransformer", + "RedshiftDataParameters": { + "target": "com.amazonaws.cloudwatchevents#RedshiftDataParameters", "traits": { - "smithy.api#documentation": "

Settings to enable you to provide custom input to a target based on certain event\n data. You can extract one or more key-value pairs from the event and then use that data\n to send customized input to the target.

" + "smithy.api#documentation": "

Contains the Redshift Data API parameters to use when the target is a Redshift cluster.

\n

If you specify a Redshift Cluster as a Target, you can use this\n to specify parameters to invoke the Redshift Data API ExecuteStatement based on\n EventBridge events.

" } }, - "Arn": { - "target": "com.amazonaws.cloudwatchevents#TargetArn", + "HttpParameters": { + "target": "com.amazonaws.cloudwatchevents#HttpParameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST \n endpoint.

\n

If you specify an API Gateway REST API as a target, you can use this \n parameter to specify headers, path parameter, query string keys/values as part of your target \n invoking request.

" } }, "RunCommandParameters": { @@ -3182,22 +3331,48 @@ "smithy.api#documentation": "

Parameters used when you are using the rule to invoke Amazon EC2 Run\n Command.

" } }, - "HttpParameters": { - "target": "com.amazonaws.cloudwatchevents#HttpParameters", + "RoleArn": { + "target": "com.amazonaws.cloudwatchevents#RoleArn", "traits": { - "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST \n endpoint.

\n

If you specify an API Gateway REST API as a target, you can use this \n parameter to specify headers, path parameter, query string keys/values as part of your target \n invoking request.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the\n rule is triggered. If one rule triggers multiple targets, you can use a different IAM\n role for each target.

" } }, - "SqsParameters": { - "target": "com.amazonaws.cloudwatchevents#SqsParameters", + "InputPath": { + "target": "com.amazonaws.cloudwatchevents#TargetInputPath", "traits": { - "smithy.api#documentation": "

Contains the message group ID to use when the target is a FIFO queue.

\n

If you specify an SQS FIFO queue as a target, the queue must have content-based\n deduplication enabled.

" + "smithy.api#documentation": "

The value of the JSONPath that is used for extracting part of the matched event\n when passing it to the target. You must use JSON dot notation, not bracket notation. For\n more information about JSON paths, see JSONPath.

" } }, - "EcsParameters": { - "target": "com.amazonaws.cloudwatchevents#EcsParameters", + "RetryPolicy": { + "target": "com.amazonaws.cloudwatchevents#RetryPolicy", "traits": { - "smithy.api#documentation": "

Contains the Amazon ECS task definition and task count to be used, if the event\n target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task\n Definitions in the Amazon EC2 Container Service Developer\n Guide.

" + "smithy.api#documentation": "

The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

" + } + }, + "Input": { + "target": "com.amazonaws.cloudwatchevents#TargetInput", + "traits": { + "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself\n is passed to the target. For more information, see The JavaScript Object Notation\n (JSON) Data Interchange Format.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.cloudwatchevents#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

" + } + }, + "Arn": { + "target": "com.amazonaws.cloudwatchevents#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.cloudwatchevents#TargetId", + "traits": { + "smithy.api#documentation": "

The ID of the target.

", + "smithy.api#required": {} } } }, @@ -3298,17 +3473,17 @@ "com.amazonaws.cloudwatchevents#TestEventPatternRequest": { "type": "structure", "members": { - "Event": { - "target": "com.amazonaws.cloudwatchevents#String", + "EventPattern": { + "target": "com.amazonaws.cloudwatchevents#EventPattern", "traits": { - "smithy.api#documentation": "

The event, in JSON format, to test against the event pattern.

", + "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

", "smithy.api#required": {} } }, - "EventPattern": { - "target": "com.amazonaws.cloudwatchevents#EventPattern", + "Event": { + "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

", + "smithy.api#documentation": "

The event, in JSON format, to test against the event pattern.

", "smithy.api#required": {} } } @@ -3381,17 +3556,17 @@ "com.amazonaws.cloudwatchevents#UntagResourceRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.cloudwatchevents#Arn", + "TagKeys": { + "target": "com.amazonaws.cloudwatchevents#TagKeyList", "traits": { - "smithy.api#documentation": "

The ARN of the EventBridge resource from which you are removing tags.

", + "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.cloudwatchevents#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.cloudwatchevents#Arn", "traits": { - "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", + "smithy.api#documentation": "

The ARN of the EventBridge resource from which you are removing tags.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json b/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json index d0964c6a40dd..e3dec62c32d6 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json @@ -60,7 +60,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

\n

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. \n After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. \n This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

\n \n

\n Important: CloudWatch Logs supports only symmetric CMKs. Do not use an \n associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.

\n \n

Note that it can take up to 5 minutes for this operation to take effect.

\n

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an \n InvalidParameterException error.\n

" + "smithy.api#documentation": "

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

\n

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. \n After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. \n This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

\n \n

CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK\n with your log group. For more information, see Using Symmetric and Asymmetric\n Keys.

\n \n

It can take up to 5 minutes for this operation to take effect.

\n

If you attempt to associate a CMK with a log group but the CMK does not exist or the\n CMK is disabled, you receive an InvalidParameterException error.

" } }, "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest": { @@ -146,17 +146,16 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an export task, which allows you to efficiently export data from a\n log group to an Amazon S3 bucket.

\n

This is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.

\n

You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate out log data for each export task, you can specify a prefix to be used as\n the Amazon S3 key prefix for all exported objects.

\n

Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets \n encrypted with SSE-KMS is not supported.

" + "smithy.api#documentation": "

Creates an export task, which allows you to efficiently export data from a\n log group to an Amazon S3 bucket. When you perform a CreateExportTask\n operation, you must use credentials that have permission to write to the S3 bucket \n that you specify as the destination.

\n

This is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.

\n

You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate out log data for each export task, you can specify a prefix to be used as\n the Amazon S3 key prefix for all exported objects.

\n

Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets \n encrypted with SSE-KMS is not supported.

" } }, "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest": { "type": "structure", "members": { - "from": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "taskName": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", "traits": { - "smithy.api#documentation": "

The start time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not\n exported.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the export task.

" } }, "destination": { @@ -166,22 +165,18 @@ "smithy.api#required": {} } }, - "destinationPrefix": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", - "traits": { - "smithy.api#documentation": "

The prefix used as the start of the key for every object exported. If you don't\n specify a value, the default is exportedlogs.

" - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "from": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

Export only log streams that match the provided prefix. If you don't\n specify a value, no prefix filter is applied.

" + "smithy.api#documentation": "

The start time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not\n exported.

", + "smithy.api#required": {} } }, - "taskName": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", + "to": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the export task.

" + "smithy.api#documentation": "

The end time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not\n exported.

", + "smithy.api#required": {} } }, "logGroupName": { @@ -191,11 +186,16 @@ "smithy.api#required": {} } }, - "to": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", "traits": { - "smithy.api#documentation": "

The end time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not\n exported.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The prefix used as the start of the key for every object exported. If you don't\n specify a value, the default is exportedlogs.

" + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "

Export only log streams that match the provided prefix. If you don't\n specify a value, no prefix filter is applied.

" } } } @@ -234,17 +234,16 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a log group with the specified name.

\n

You can create up to 20,000 log groups per account.

\n

You must use the following guidelines when naming a log group:

\n \n

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. \n This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

\n

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will \n receive an InvalidParameterException error.\n

\n \n

\n Important: CloudWatch Logs supports only symmetric CMKs. Do not \n associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.

\n " + "smithy.api#documentation": "

Creates a log group with the specified name. You can create up to 20,000 log groups per account.

\n

You must use the following guidelines when naming a log group:

\n \n

When you create a log group, by default the log events in the log group never expire. To set\n a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.

\n

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. \n This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

\n

If you attempt to associate a CMK with the log group but the CMK does not exist or the\n CMK is disabled, you receive an InvalidParameterException error.

\n \n

CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with\n your log group. For more information, see Using Symmetric and Asymmetric\n Keys.

\n " } }, "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": { "type": "structure", "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The key-value pairs to use for the tags.

" } }, "kmsKeyId": { @@ -253,10 +252,11 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. \n For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

" } }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The key-value pairs to use for the tags.

" + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} } } } @@ -281,23 +281,23 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a log stream for the specified log group.

\n

There is no limit on the number of log streams that you can create for a log group. There is a limit \n of 50 TPS on CreateLogStream operations, after which transactions are throttled.

\n

You must use the following guidelines when naming a log stream:

\n " + "smithy.api#documentation": "

Creates a log stream for the specified log group. A log stream is a sequence of log events\n that originate from a single source, such as an application instance or a resource that is \n being monitored.

\n

There is no limit on the number of log streams that you can create for a log group. There is a limit \n of 50 TPS on CreateLogStream operations, after which transactions are throttled.

\n

You must use the following guidelines when naming a log stream:

\n " } }, "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest": { "type": "structure", "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", "traits": { - "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#documentation": "

The name of the log stream.

", "smithy.api#required": {} } }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#documentation": "

The name of the log group.

", "smithy.api#required": {} } } @@ -322,7 +322,7 @@ "type": "integer", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

" + "smithy.api#documentation": "

The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

\n

If you omit retentionInDays in a PutRetentionPolicy operation, \n the events in the log group are always retained and never expire.

" } }, "com.amazonaws.cloudwatchlogs#DefaultValue": { @@ -427,17 +427,17 @@ "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest": { "type": "structure", "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", "traits": { - "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#documentation": "

The name of the log stream.

", "smithy.api#required": {} } }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The name of the log stream.

", + "smithy.api#documentation": "

The name of the log group.

", "smithy.api#required": {} } } @@ -503,7 +503,10 @@ { "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" } - ] + ], + "traits": { + "smithy.api#documentation": "

Deletes a saved CloudWatch Logs Insights query definition. \n A query definition contains details about a saved CloudWatch Logs Insights query.

\n

Each DeleteQueryDefinition operation can delete one query definition.

\n

You must have the logs:DeleteQueryDefinition permission to be able to perform\n this operation.

" + } }, "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest": { "type": "structure", @@ -511,6 +514,7 @@ "queryDefinitionId": { "target": "com.amazonaws.cloudwatchlogs#QueryId", "traits": { + "smithy.api#documentation": "

The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the\n IDs of your saved query definitions.

", "smithy.api#required": {} } } @@ -520,7 +524,10 @@ "type": "structure", "members": { "success": { - "target": "com.amazonaws.cloudwatchlogs#Success" + "target": "com.amazonaws.cloudwatchlogs#Success", + "traits": { + "smithy.api#documentation": "

A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation\n failed.

" + } } } }, @@ -690,14 +697,14 @@ "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, "destinations": { "target": "com.amazonaws.cloudwatchlogs#Destinations", "traits": { "smithy.api#documentation": "

The destinations.

" } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" } } }, @@ -724,18 +731,6 @@ "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" - } - }, "taskId": { "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", "traits": { @@ -747,6 +742,18 @@ "traits": { "smithy.api#documentation": "

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

" } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" + } } } }, @@ -803,18 +810,18 @@ "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" - } - }, "logGroupNamePrefix": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { "smithy.api#documentation": "

The prefix to match.

" } }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" + } + }, "limit": { "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", "traits": { @@ -826,14 +833,14 @@ "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, "logGroups": { "target": "com.amazonaws.cloudwatchlogs#LogGroups", "traits": { - "smithy.api#documentation": "

The log groups.

" + "smithy.api#documentation": "

The log groups.

\n

If the retentionInDays value if not included for a log group, then that log group\n is set to have its events never expire.

" } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" } } }, @@ -869,10 +876,17 @@ "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest": { "type": "structure", "members": { - "orderBy": { - "target": "com.amazonaws.cloudwatchlogs#OrderBy", + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", "traits": { - "smithy.api#documentation": "

If the value is LogStreamName, the results are ordered by log stream name.\n If the value is LastEventTime, the results are ordered by the event time. \n The default value is LogStreamName.

\n

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

\n

lastEventTimestamp represents the time of the most recent log event in the log stream\n in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically\n updates in less than an hour from ingestion, but may take longer in some rare\n situations.

" + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} } }, "limit": { @@ -881,16 +895,16 @@ "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" } }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", + "orderBy": { + "target": "com.amazonaws.cloudwatchlogs#OrderBy", "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" + "smithy.api#documentation": "

If the value is LogStreamName, the results are ordered by log stream name.\n If the value is LastEventTime, the results are ordered by the event time. \n The default value is LogStreamName.

\n

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

\n

\n lastEventTimeStamp represents the time of the most recent log event in the\n log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency\n basis. It typically updates in less than an hour from ingestion, but in rare situations might\n take longer.

" } }, "logStreamNamePrefix": { "target": "com.amazonaws.cloudwatchlogs#LogStreamName", "traits": { - "smithy.api#documentation": "

The prefix to match.

\n

If orderBy is LastEventTime,you cannot specify this\n parameter.

" + "smithy.api#documentation": "

The prefix to match.

\n

If orderBy is LastEventTime, you cannot specify this\n parameter.

" } }, "descending": { @@ -898,13 +912,6 @@ "traits": { "smithy.api#documentation": "

If the value is true, results are returned in descending order. \n If the value is to false, results are returned in ascending order.\n The default value is false.

" } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } } } }, @@ -942,7 +949,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the specified metric filters.\n You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace.\n\n The results are ASCII-sorted by filter name.

", + "smithy.api#documentation": "

Lists the specified metric filters. You can list all of the metric filters or filter\n the results by log name, prefix, metric name, or metric namespace. The results are\n ASCII-sorted by filter name.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -954,28 +961,22 @@ "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" - } - }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { "smithy.api#documentation": "

The name of the log group.

" } }, - "metricName": { - "target": "com.amazonaws.cloudwatchlogs#MetricName", + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", "traits": { - "smithy.api#documentation": "

Filters results to include only those with the specified metric name. If you include this parameter in your request, you \n must also include the metricNamespace parameter.

" + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" } }, - "filterNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", + "metricName": { + "target": "com.amazonaws.cloudwatchlogs#MetricName", "traits": { - "smithy.api#documentation": "

The prefix to match.

" + "smithy.api#documentation": "

Filters results to include only those with the specified metric name. If you include this parameter in your request, you \n must also include the metricNamespace parameter.

" } }, "limit": { @@ -984,6 +985,12 @@ "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" } }, + "filterNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The prefix to match. CloudWatch Logs uses the value you set here\n only if you also include the logGroupName parameter in your request.

" + } + }, "metricNamespace": { "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", "traits": { @@ -995,14 +1002,14 @@ "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, "metricFilters": { "target": "com.amazonaws.cloudwatchlogs#MetricFilters", "traits": { "smithy.api#documentation": "

The metric filters.

" } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" } } }, @@ -1026,7 +1033,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all\n queries, or limit it to queries of a specific log group or queries with a certain status.

" + "smithy.api#documentation": "

Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have\n been executed recently in this account. You can request all queries or limit it to queries of\n a specific log group or queries with a certain status.

" } }, "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults": { @@ -1042,26 +1049,26 @@ "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults", "traits": { - "smithy.api#documentation": "

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, \n Complete, Failed, Running, and Scheduled.

" + "smithy.api#documentation": "

Limits the number of returned queries to the specified number.

" } }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { "smithy.api#documentation": "

Limits the returned queries to only those for the specified log group.

" } }, - "maxResults": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults", + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", "traits": { - "smithy.api#documentation": "

Limits the number of returned queries to the specified number.

" + "smithy.api#documentation": "

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, \n Complete, Failed, Running, and Scheduled.

" } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" } } }, @@ -1094,16 +1101,25 @@ { "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" } - ] + ], + "traits": { + "smithy.api#documentation": "

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

\n

You can use the queryDefinitionNamePrefix parameter to limit the results to only the\n query definitions that have names that start with a certain string.

" + } }, "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest": { "type": "structure", "members": { "queryDefinitionNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName" + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

" + } }, "maxResults": { - "target": "com.amazonaws.cloudwatchlogs#QueryListMaxResults" + "target": "com.amazonaws.cloudwatchlogs#QueryListMaxResults", + "traits": { + "smithy.api#documentation": "

Limits the number of returned query definitions to the specified number.

" + } }, "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken" @@ -1113,11 +1129,14 @@ "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse": { "type": "structure", "members": { + "queryDefinitions": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionList", + "traits": { + "smithy.api#documentation": "

The list of query definitions that match your request.

" + } + }, "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "queryDefinitions": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionList" } } }, @@ -1207,12 +1226,6 @@ "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" } }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" - } - }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { @@ -1225,6 +1238,12 @@ "traits": { "smithy.api#documentation": "

The prefix to match. If you don't specify a value, no prefix filter is applied.

" } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + } } } }, @@ -1245,10 +1264,10 @@ "com.amazonaws.cloudwatchlogs#Destination": { "type": "structure", "members": { - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", "traits": { - "smithy.api#documentation": "

The creation time of the destination, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

" + "smithy.api#documentation": "

The name of the destination.

" } }, "roleArn": { @@ -1257,16 +1276,22 @@ "smithy.api#documentation": "

A role for impersonation, used when delivering log events to the target.

" } }, - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", "traits": { - "smithy.api#documentation": "

The name of the destination.

" + "smithy.api#documentation": "

An IAM policy document that governs which AWS accounts can create subscription filters\n against this destination.

" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the destination, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

" } }, "targetArn": { "target": "com.amazonaws.cloudwatchlogs#TargetArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the physical target to where the log events are\n delivered (for example, a Kinesis stream).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the physical target where the log events are\n delivered (for example, a Kinesis stream).

" } }, "arn": { @@ -1274,12 +1299,6 @@ "traits": { "smithy.api#documentation": "

The ARN of this destination.

" } - }, - "accessPolicy": { - "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", - "traits": { - "smithy.api#documentation": "

An IAM policy document that governs which AWS accounts can create subscription filters\n against this destination.

" - } } }, "traits": { @@ -1400,10 +1419,10 @@ "com.amazonaws.cloudwatchlogs#ExportTask": { "type": "structure", "members": { - "destinationPrefix": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", - "traits": { - "smithy.api#documentation": "

The prefix that was used as the start of Amazon S3 key for every object exported.

" + "from": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.\n Events with a timestamp before this time are not exported.

" } }, "to": { @@ -1412,22 +1431,22 @@ "smithy.api#documentation": "

The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.\n Events with a timestamp later than this time are not exported.

" } }, - "from": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "destination": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", "traits": { - "smithy.api#documentation": "

The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.\n Events with a timestamp before this time are not exported.

" + "smithy.api#documentation": "

The name of the S3 bucket to which the log data was exported.

" } }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatus", + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", "traits": { - "smithy.api#documentation": "

The status of the export task.

" + "smithy.api#documentation": "

The prefix that was used as the start of Amazon S3 key for every object exported.

" } }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "executionInfo": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo", "traits": { - "smithy.api#documentation": "

The name of the log group from which logs data was exported.

" + "smithy.api#documentation": "

Execution information about the export task.

" } }, "taskName": { @@ -1436,16 +1455,10 @@ "smithy.api#documentation": "

The name of the export task.

" } }, - "executionInfo": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo", - "traits": { - "smithy.api#documentation": "

Execution info about the export task.

" - } - }, - "destination": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The name of Amazon S3 bucket to which the log data was exported.

" + "smithy.api#documentation": "

The name of the log group from which logs data was exported.

" } }, "taskId": { @@ -1453,6 +1466,12 @@ "traits": { "smithy.api#documentation": "

The ID of the export task.

" } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the export task.

" + } } }, "traits": { @@ -1595,7 +1614,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists log events from the specified log group. You can list all the log events or filter the results\n using a filter pattern, a time range, and the name of the log stream.

\n

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000\n log events), or all the events found within the time range that you specify. If the results\n include a token, then there are more log events available, and you can get additional results\n by specifying the token in a subsequent call.

", + "smithy.api#documentation": "

Lists log events from the specified log group. You can list all the log events or filter the results\n using a filter pattern, a time range, and the name of the log stream.

\n

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000\n log events) or all the events found within the time range that you specify. If the results\n include a token, then there are more log events available, and you can get additional results\n by specifying the token in a subsequent call. This operation can return empty results\n while there are more log events available through the token.

\n

The returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the PutLogEvents request.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -1606,22 +1625,13 @@ "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest": { "type": "structure", "members": { - "startTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp before this time are not returned.

" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of events to return. (You received this token from a previous call.)

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "interleaved": { + "target": "com.amazonaws.cloudwatchlogs#Interleaved", "traits": { - "smithy.api#documentation": "

The maximum number of events to return. The default is 10,000 events.

" + "smithy.api#deprecated": { + "message": "Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group." + }, + "smithy.api#documentation": "

If the value is true, the operation makes a best effort to provide responses that\n contain events from multiple log streams within the log group, interleaved in a single\n response. If the value is false, all the matched log events in the first log stream are\n searched first, then those in the next log stream, and so on. The default is false.

\n

\n Important: Starting on June 17, 2019, this parameter\n is ignored and the value is assumed to be true. The response from this operation always\n interleaves events from multiple log streams within a log group.

" } }, "endTime": { @@ -1637,19 +1647,16 @@ "smithy.api#required": {} } }, - "interleaved": { - "target": "com.amazonaws.cloudwatchlogs#Interleaved", + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", "traits": { - "smithy.api#deprecated": { - "message": "Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group." - }, - "smithy.api#documentation": "

If the value is true, the operation makes a best effort to provide responses that\n contain events from multiple log streams within the log group, interleaved in a single\n response. If the value is false, all the matched log events in the first log stream are\n searched first, then those in the next log stream, and so on. The default is false.

\n

\n IMPORTANT: Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be\n true. The response from this operation will always interleave events from multiple log streams within\n a log group.

" + "smithy.api#documentation": "

The maximum number of events to return. The default is 10,000 events.

" } }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", "traits": { - "smithy.api#documentation": "

The filter pattern to use. For more information, see Filter and Pattern Syntax.

\n

If not provided, all the events are matched.

" + "smithy.api#documentation": "

The token for the next set of events to return. (You received this token from a previous call.)

" } }, "logStreamNamePrefix": { @@ -1658,6 +1665,18 @@ "smithy.api#documentation": "

Filters the results to include only events from log streams that have names starting with this prefix.

\n

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for\n logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action\n returns an InvalidParameterException error.

" } }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "

The filter pattern to use. For more information, see Filter and Pattern Syntax.

\n

If not provided, all the events are matched.

" + } + }, + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp before this time are not returned.

\n

If you omit startTime and endTime the most recent log events\n are retrieved, to up 1 MB or 10,000 log events.

" + } + }, "logStreamNames": { "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", "traits": { @@ -1684,7 +1703,7 @@ "searchedLogStreams": { "target": "com.amazonaws.cloudwatchlogs#SearchedLogStreams", "traits": { - "smithy.api#documentation": "

Indicates which log streams have been searched and whether each has been searched completely.

" + "smithy.api#documentation": "

\n IMPORTANT Starting on May 15, 2020, \n this parameter will be deprecated. This parameter will be an empty list \n after the deprecation occurs.

\n

Indicates which log streams have been searched and whether each has been searched completely.

" } } } @@ -1702,7 +1721,7 @@ "com.amazonaws.cloudwatchlogs#FilterPattern": { "type": "string", "traits": { - "smithy.api#documentation": "

A symbolic description of how CloudWatch Logs should interpret the data in each log\n event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You\n use the filter pattern to specify what to look for in the log event message.

", + "smithy.api#documentation": "

A symbolic description of how CloudWatch Logs should interpret the data in each log\n event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You\n use the filter pattern to specify what to look for in the log event message.

", "smithy.api#length": { "min": 0, "max": 1024 @@ -1718,10 +1737,10 @@ "smithy.api#documentation": "

The name of the log stream to which this event belongs.

" } }, - "ingestionTime": { + "timestamp": { "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

The time the event was ingested, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" + "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC.

" } }, "message": { @@ -1730,16 +1749,16 @@ "smithy.api#documentation": "

The data contained in the log event.

" } }, - "eventId": { - "target": "com.amazonaws.cloudwatchlogs#EventId", + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the event.

" + "smithy.api#documentation": "

The time the event was ingested, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" } }, - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "eventId": { + "target": "com.amazonaws.cloudwatchlogs#EventId", "traits": { - "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC.

" + "smithy.api#documentation": "

The ID of the event.

" } } }, @@ -1773,7 +1792,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists log events from the specified log stream. You can list all the log events or \n filter using a time range.

\n\n

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). \n You can get additional log events by specifying one of the tokens in a subsequent call.

", + "smithy.api#documentation": "

Lists log events from the specified log stream. You can list all of the log events or\n filter using a time range.

\n\n

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). \n You can get additional log events by specifying one of the tokens in a subsequent call.\n This operation can return empty results while there are more log events available through the token.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextForwardToken", @@ -1785,16 +1804,22 @@ "com.amazonaws.cloudwatchlogs#GetLogEventsRequest": { "type": "structure", "members": { - "startFromHead": { - "target": "com.amazonaws.cloudwatchlogs#StartFromHead", + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

If the value is true, the earliest log events are returned first.\n If the value is false, the latest log events are returned first.\n The default value is false.

\n

If you are using nextToken in this operation, you must specify true for startFromHead.

" + "smithy.api#documentation": "

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included.\n Events with a timestamp earlier than this time are not included.

" } }, - "endTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", "traits": { - "smithy.api#documentation": "

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp equal to or later than this time are not\n included.

" + "smithy.api#documentation": "

The maximum number of log events returned. If you don't specify a value, the maximum is\n as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

\n

Using this token works only when you specify true for startFromHead.

" } }, "logStreamName": { @@ -1804,6 +1829,12 @@ "smithy.api#required": {} } }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp equal to or later than this time are not\n included.

" + } + }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { @@ -1811,22 +1842,10 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

\n

Using this token works only when you specify true for startFromHead.

" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of log events returned. If you don't specify a value, the maximum is\n as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

" - } - }, - "startTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "startFromHead": { + "target": "com.amazonaws.cloudwatchlogs#StartFromHead", "traits": { - "smithy.api#documentation": "

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included.\n Events with a timestamp earlier than this time are not included.

" + "smithy.api#documentation": "

If the value is true, the earliest log events are returned first.\n If the value is false, the latest log events are returned first.\n The default value is false.

\n

If you are using nextToken in this operation, you must specify true for startFromHead.

" } } } @@ -1837,19 +1856,19 @@ "nextBackwardToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of items in the backward direction. The token expires after 24 hours. This token will never be null. If you \n have reached the end of the stream, it will return the same token you passed in.

" + "smithy.api#documentation": "

The token for the next set of items in the backward direction. The token expires after\n 24 hours. This token is never null. If you have reached the end of the stream, it returns the\n same token you passed in.

" } }, - "events": { - "target": "com.amazonaws.cloudwatchlogs#OutputLogEvents", + "nextForwardToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", "traits": { - "smithy.api#documentation": "

The events.

" + "smithy.api#documentation": "

The token for the next set of items in the forward direction. The token expires after\n 24 hours. If you have reached the end of the stream, it returns the same token you passed\n in.

" } }, - "nextForwardToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", + "events": { + "target": "com.amazonaws.cloudwatchlogs#OutputLogEvents", "traits": { - "smithy.api#documentation": "

The token for the next set of items in the forward direction. The token expires after 24 hours. If you \n have reached the end of the stream, it will return the same token you passed in.

" + "smithy.api#documentation": "

The events.

" } } } @@ -1883,18 +1902,18 @@ "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest": { "type": "structure", "members": { - "time": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The time to set as the center of the query. If you specify time, the 8\n minutes before and 8 minutes after this time are searched. If you omit time, the\n past 15 minutes are queried.

\n

The time value is specified as epoch time, the number of seconds since\n January 1, 1970, 00:00:00 UTC.

" - } - }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { "smithy.api#documentation": "

The name of the log group to search.

", "smithy.api#required": {} } + }, + "time": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time to set as the center of the query. If you specify time, the 8\n minutes before and 8 minutes after this time are searched. If you omit time, the\n past 15 minutes are queried.

\n

The time value is specified as epoch time, the number of seconds since\n January 1, 1970, 00:00:00 UTC.

" + } } } }, @@ -1932,7 +1951,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all the fields and values of a single log event. All fields\n are retrieved, even if the original query that produced the logRecordPointer\n retrieved only a subset of fields. Fields are returned as field name/field value pairs.

\n

Additionally, the entire unparsed log event is returned within @message.

" + "smithy.api#documentation": "

Retrieves all of the fields and values of a single log event. All fields are retrieved,\n even if the original query that produced the logRecordPointer retrieved only a\n subset of fields. Fields are returned as field name/field value pairs.

\n

The full unparsed log event is returned within @message.

" } }, "com.amazonaws.cloudwatchlogs#GetLogRecordRequest": { @@ -1978,7 +1997,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the results from the specified query.

\n

Only the fields requested in the query are returned, along with a @ptr field which\n is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation\n to get the full log record.

\n

\n GetQueryResults\n does not start a query execution. To run a query, use StartQuery.

\n

If the value of the Status field in the output is Running, this operation \n returns only partial results. If you see a value of Scheduled or Running for the status, \n you can retry the operation later to see the final results.

" + "smithy.api#documentation": "

Returns the results from the specified query.

\n

Only the fields requested in the query are returned, along with a @ptr\n field, which is the identifier for the log record. You can use the value of @ptr\n in a GetLogRecord\n operation to get the full log record.

\n

\n GetQueryResults\n does not start a query execution. To run a query, use StartQuery.

\n

If the value of the Status field in the output is Running, this operation \n returns only partial results. If you see a value of Scheduled or Running for the status, \n you can retry the operation later to see the final results.

" } }, "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest": { @@ -2002,16 +2021,16 @@ "smithy.api#documentation": "

The log events that matched the query criteria during the most recent time it ran.

\n

The results value is an array of arrays. Each log event is one object in the\n top-level array. Each of these log event objects is an array of\n field/value pairs.

" } }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "statistics": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatistics", "traits": { - "smithy.api#documentation": "

The status of the most recent running of the query. Possible values are Cancelled, \n Complete, Failed, Running, Scheduled, \n Timeout, and Unknown.

\n

Queries time out after 15 minutes of execution. To avoid having your \n queries time out, reduce the time range being searched, or partition your \n query into a number of queries.

" + "smithy.api#documentation": "

Includes the number of log events scanned by the query, the number of log events that matched the \n query criteria, and the total number of bytes in the log events that were scanned. These values\n reflect the full raw results of the query.

" } }, - "statistics": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatistics", + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", "traits": { - "smithy.api#documentation": "

Includes the number of log events scanned by the query, the number of log events that matched the \n query criteria, and the total number of bytes in the log events that were scanned.

" + "smithy.api#documentation": "

The status of the most recent running of the query. Possible values are Cancelled, \n Complete, Failed, Running, Scheduled, \n Timeout, and Unknown.

\n

Queries time out after 15 minutes of execution. To avoid having your queries time out,\n reduce the time range being searched or partition your query into a number of queries.

" } } } @@ -2019,17 +2038,17 @@ "com.amazonaws.cloudwatchlogs#InputLogEvent": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

The raw event message.

", + "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC.

", "smithy.api#required": {} } }, - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", "traits": { - "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC.

", + "smithy.api#documentation": "

The raw event message.

", "smithy.api#required": {} } } @@ -2186,6 +2205,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.

" } }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the log group, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

" + } + }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { @@ -2198,8 +2223,11 @@ "smithy.api#documentation": "

The number of metric filters.

" } }, - "retentionInDays": { - "target": "com.amazonaws.cloudwatchlogs#Days" + "storedBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#documentation": "

The number of bytes stored.

" + } }, "arn": { "target": "com.amazonaws.cloudwatchlogs#Arn", @@ -2207,17 +2235,8 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group.

" } }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the log group, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.

" - } - }, - "storedBytes": { - "target": "com.amazonaws.cloudwatchlogs#StoredBytes", - "traits": { - "smithy.api#documentation": "

The number of bytes stored.

" - } + "retentionInDays": { + "target": "com.amazonaws.cloudwatchlogs#Days" } }, "traits": { @@ -2227,17 +2246,17 @@ "com.amazonaws.cloudwatchlogs#LogGroupField": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#Field", - "traits": { - "smithy.api#documentation": "

The name of a log field.

" - } - }, "percent": { "target": "com.amazonaws.cloudwatchlogs#Percentage", "traits": { "smithy.api#documentation": "

The percentage of log events queried that contained the field.

" } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#Field", + "traits": { + "smithy.api#documentation": "

The name of a log field.

" + } } }, "traits": { @@ -2287,12 +2306,6 @@ "com.amazonaws.cloudwatchlogs#LogStream": { "type": "structure", "members": { - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

" - } - }, "creationTime": { "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { @@ -2305,16 +2318,22 @@ "smithy.api#documentation": "

The time of the first event, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC.

" } }, - "lastIngestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", "traits": { - "smithy.api#documentation": "

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00\n UTC.

" + "smithy.api#documentation": "

The name of the log stream.

" } }, "lastEventTimestamp": { "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

The time of the most recent log event in the log stream in CloudWatch Logs. This number\n is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The\n lastEventTime value updates on an eventual consistency basis. It typically\n updates in less than an hour from ingestion, but may take longer in some rare\n situations.

" + "smithy.api#documentation": "

The time of the most recent log event in the log stream in CloudWatch Logs. This number\n is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The\n lastEventTime value updates on an eventual consistency basis. It typically\n updates in less than an hour from ingestion, but in rare situations might take\n longer.

" + } + }, + "uploadSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "

The sequence token.

" } }, "arn": { @@ -2323,10 +2342,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log stream.

" } }, - "uploadSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "lastIngestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { - "smithy.api#documentation": "

The sequence token.

" + "smithy.api#documentation": "

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00\n UTC.

" } }, "storedBytes": { @@ -2335,7 +2354,7 @@ "smithy.api#deprecated": { "message": "Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected." }, - "smithy.api#documentation": "

The number of bytes stored.

\n

\n IMPORTANT:On June 17, 2019, this parameter was deprecated for log streams, and is always\n reported as zero. This change applies only to log streams. The storedBytes parameter for log\n groups is not affected.

" + "smithy.api#documentation": "

The number of bytes stored.

\n

\n Important: On June 17, 2019, this parameter was\n deprecated for log streams, and is always reported as zero. This change applies only to log\n streams. The storedBytes parameter for log groups is not affected.

" } } }, @@ -2501,13 +2520,13 @@ "sdkId": "CloudWatch Logs", "arnNamespace": "logs", "cloudFormationName": "Logs", - "cloudTrailEventSource": "v20140328.logs.amazonaws.com" + "cloudTrailEventSource": "cloudwatchlogs.amazonaws.com" }, "aws.auth#sigv4": { "name": "logs" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the\n AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

\n

You can use CloudWatch Logs to:

\n ", + "smithy.api#documentation": "

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the\n AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

\n

You can use CloudWatch Logs to:

\n ", "smithy.api#title": "Amazon CloudWatch Logs", "smithy.api#xmlNamespace": { "uri": "http://monitoring.amazonaws.com/doc/2014-03-28/" @@ -2517,15 +2536,15 @@ "com.amazonaws.cloudwatchlogs#MalformedQueryException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - }, "queryCompileError": { "target": "com.amazonaws.cloudwatchlogs#QueryCompileError" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" } }, "traits": { - "smithy.api#documentation": "

The query string is not valid. Details about this error are displayed in a \n QueryCompileError object. For more information, see \n QueryCompileError\"/>.

\n

For more information about valid query syntax, see\n CloudWatch Logs Insights Query Syntax.

", + "smithy.api#documentation": "

The query string is not valid. Details about this error are displayed in a \n QueryCompileError object. For more information, see \n QueryCompileError.

\n

For more information about valid query syntax, see\n CloudWatch Logs Insights Query Syntax.

", "smithy.api#error": "client" } }, @@ -2541,12 +2560,6 @@ "smithy.api#documentation": "

The creation time of the metric filter, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.

" } }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the metric filter.

" - } - }, "metricTransformations": { "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", "traits": { @@ -2556,6 +2569,12 @@ "filterPattern": { "target": "com.amazonaws.cloudwatchlogs#FilterPattern" }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the metric filter.

" + } + }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { @@ -2576,17 +2595,17 @@ "smithy.api#documentation": "

The values extracted from the event data by the filter.

" } }, - "eventMessage": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "

The raw event data.

" - } - }, "eventNumber": { "target": "com.amazonaws.cloudwatchlogs#EventNumber", "traits": { "smithy.api#documentation": "

The event number.

" } + }, + "eventMessage": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "

The raw event data.

" + } } }, "traits": { @@ -2608,7 +2627,7 @@ "com.amazonaws.cloudwatchlogs#MetricName": { "type": "string", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch metric to which the monitored log information should be\n published. For example, you may publish to a metric called ErrorCount.

", + "smithy.api#documentation": "

The name of the CloudWatch metric to which the monitored log information should be\n published. For example, you might publish to a metric named ErrorCount.

", "smithy.api#length": { "min": 0, "max": 255 @@ -2629,13 +2648,6 @@ "com.amazonaws.cloudwatchlogs#MetricTransformation": { "type": "structure", "members": { - "metricNamespace": { - "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", - "traits": { - "smithy.api#documentation": "

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics\n that are similar. For more information, see Namespaces.

", - "smithy.api#required": {} - } - }, "defaultValue": { "target": "com.amazonaws.cloudwatchlogs#DefaultValue", "traits": { @@ -2649,6 +2661,13 @@ "smithy.api#required": {} } }, + "metricNamespace": { + "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", + "traits": { + "smithy.api#documentation": "

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics\n that are similar. For more information, see Namespaces.

", + "smithy.api#required": {} + } + }, "metricName": { "target": "com.amazonaws.cloudwatchlogs#MetricName", "traits": { @@ -2717,23 +2736,23 @@ "name": "LastEventTime" } ] - } - }, - "com.amazonaws.cloudwatchlogs#OutputLogEvent": { - "type": "structure", - "members": { - "ingestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the event was ingested, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" - } - }, + } + }, + "com.amazonaws.cloudwatchlogs#OutputLogEvent": { + "type": "structure", + "members": { "message": { "target": "com.amazonaws.cloudwatchlogs#EventMessage", "traits": { "smithy.api#documentation": "

The data contained in the log event.

" } }, + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the event was ingested, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.

" + } + }, "timestamp": { "target": "com.amazonaws.cloudwatchlogs#Timestamp", "traits": { @@ -2792,7 +2811,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

\n

A destination encapsulates a physical resource (such\n as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events\n for a different account, ingested using PutLogEvents.

\n

Through an access policy, a destination controls what is written to it.\n By default, PutDestination does not set any access policy with the destination,\n which means a cross-account user cannot call PutSubscriptionFilter against\n this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

" + "smithy.api#documentation": "

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

\n

A destination encapsulates a physical resource (such\n as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events\n for a different account, ingested using PutLogEvents.

\n

Through an access policy, a destination controls what is written to it.\n By default, PutDestination does not set any access policy with the destination,\n which means a cross-account user cannot call PutSubscriptionFilter against\n this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

\n

To perform a PutDestination operation, you must also have the \n iam:PassRole permission.

" } }, "com.amazonaws.cloudwatchlogs#PutDestinationPolicy": { @@ -2828,7 +2847,7 @@ "accessPolicy": { "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", "traits": { - "smithy.api#documentation": "

An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination.

", + "smithy.api#documentation": "

An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination. This can be up to 5120 bytes.

", "smithy.api#required": {} } } @@ -2837,6 +2856,13 @@ "com.amazonaws.cloudwatchlogs#PutDestinationRequest": { "type": "structure", "members": { + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon\n Kinesis PutRecord operation on the destination stream.

", + "smithy.api#required": {} + } + }, "targetArn": { "target": "com.amazonaws.cloudwatchlogs#TargetArn", "traits": { @@ -2850,13 +2876,6 @@ "smithy.api#documentation": "

A name for the destination.

", "smithy.api#required": {} } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon\n Kinesis PutRecord operation on the destination stream.

", - "smithy.api#required": {} - } } } }, @@ -2900,7 +2919,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uploads a batch of log events to the specified log stream.

\n

You must include the sequence token obtained from the response of the previous call. An\n upload in a newly created log stream does not require a sequence token. You can also get the\n sequence token in the expectedSequenceToken field from \n InvalidSequenceTokenException. If you call\n PutLogEvents twice within a narrow time period using the same value for\n sequenceToken, both calls may be successful, or one may be rejected.

\n

The batch of events must satisfy the following constraints:

\n \n

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key.

" + "smithy.api#documentation": "

Uploads a batch of log events to the specified log stream.

\n

You must include the sequence token obtained from the response of the previous call. An\n upload in a newly created log stream does not require a sequence token. You can also get the\n sequence token in the expectedSequenceToken field from\n InvalidSequenceTokenException. If you call PutLogEvents twice\n within a narrow time period using the same value for sequenceToken, both calls\n might be successful or one might be rejected.

\n

The batch of events must satisfy the following constraints:

\n \n

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key.

" } }, "com.amazonaws.cloudwatchlogs#PutLogEventsRequest": { @@ -2913,24 +2932,24 @@ "smithy.api#required": {} } }, - "logEvents": { - "target": "com.amazonaws.cloudwatchlogs#InputLogEvents", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The log events.

", + "smithy.api#documentation": "

The name of the log group.

", "smithy.api#required": {} } }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "logEvents": { + "target": "com.amazonaws.cloudwatchlogs#InputLogEvents", "traits": { - "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#documentation": "

The log events.

", "smithy.api#required": {} } }, "sequenceToken": { "target": "com.amazonaws.cloudwatchlogs#SequenceToken", "traits": { - "smithy.api#documentation": "

The sequence token obtained from the response of the previous PutLogEvents\n call. An upload in a newly created log stream does not require a sequence token. You can also\n get the sequence token using DescribeLogStreams. If you call\n PutLogEvents twice within a narrow time period using the same value for\n sequenceToken, both calls may be successful, or one may be rejected.

" + "smithy.api#documentation": "

The sequence token obtained from the response of the previous PutLogEvents\n call. An upload in a newly created log stream does not require a sequence token. You can also\n get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow\n time period using the same value for sequenceToken, both calls might be\n successful or one might be rejected.

" } } } @@ -2938,17 +2957,17 @@ "com.amazonaws.cloudwatchlogs#PutLogEventsResponse": { "type": "structure", "members": { - "rejectedLogEventsInfo": { - "target": "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo", - "traits": { - "smithy.api#documentation": "

The rejected events.

" - } - }, "nextSequenceToken": { "target": "com.amazonaws.cloudwatchlogs#SequenceToken", "traits": { "smithy.api#documentation": "

The next sequence token.

" } + }, + "rejectedLogEventsInfo": { + "target": "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo", + "traits": { + "smithy.api#documentation": "

The rejected events.

" + } } } }, @@ -2981,10 +3000,10 @@ "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest": { "type": "structure", "members": { - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", "traits": { - "smithy.api#documentation": "

A filter pattern for extracting metric data out of ingested log events.

", + "smithy.api#documentation": "

A name for the metric filter.

", "smithy.api#required": {} } }, @@ -2995,17 +3014,17 @@ "smithy.api#required": {} } }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", + "metricTransformations": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", "traits": { - "smithy.api#documentation": "

A name for the metric filter.

", + "smithy.api#documentation": "

A collection of information that defines how metric data gets emitted.

", "smithy.api#required": {} } }, - "metricTransformations": { - "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", "traits": { - "smithy.api#documentation": "

A collection of information that defines how metric data gets emitted.

", + "smithy.api#documentation": "

A filter pattern for extracting metric data out of ingested log events.

", "smithy.api#required": {} } } @@ -3029,26 +3048,37 @@ { "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" } - ] + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a query definition for CloudWatch Logs Insights. For \n more information, see Analyzing Log Data with CloudWatch Logs Insights.

\n \n

To update a query definition, specify its \n queryDefinitionId in your request. The values of name, queryString,\n and logGroupNames are changed to the values that you specify in your update\n operation. No current values are retained from the current query definition. For example, if\n you update a current query definition that includes log groups, and you don't specify the\n logGroupNames parameter in your update operation, the query definition changes\n to contain no log groups.

\n

You must have the logs:PutQueryDefinition permission to be able to perform\n this operation.

" + } }, "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest": { "type": "structure", "members": { - "logGroupNames": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNames" - }, "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId" + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

If you are updating a query definition, use this parameter to specify the ID of the query\n definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query\n definitions.

\n

If you are creating a query definition, do not specify this parameter. CloudWatch\n generates a unique ID for the new query definition and include it in the response to this\n operation.

" + } }, - "name": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

Use this parameter to include specific log groups as part of your query definition.

\n

If you are updating a query definition and you omit this parameter, then the updated\n definition will contain no log groups.

" } }, "queryString": { "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", "traits": { + "smithy.api#documentation": "

The query string to use for this definition. \n For more information, see CloudWatch Logs Insights Query Syntax.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

A name for the query definition. If you are saving a lot of query definitions, we\n recommend that you name them so that you can easily find the ones you want by using the first\n part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

", "smithy.api#required": {} } } @@ -3058,7 +3088,10 @@ "type": "structure", "members": { "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId" + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The ID of the query definition.

" + } } } }, @@ -3082,7 +3115,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a resource policy allowing other AWS services to put log events to this\n account, such as Amazon Route 53. An account can have up to 10 resource policies per region.

" + "smithy.api#documentation": "

Creates or updates a resource policy allowing other AWS services to put log events to\n this account, such as Amazon Route 53. An account can have up to 10 resource policies per AWS\n Region.

" } }, "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": { @@ -3091,7 +3124,7 @@ "policyDocument": { "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", "traits": { - "smithy.api#documentation": "

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.

\n

The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

\n

\n { \n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\", \n \"Effect\": \"Allow\", \n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n }, \n \"Action\":\"logs:PutLogEvents\", \n \"Resource\": \"logArn\"\n }\n ]\n} \n \n

" + "smithy.api#documentation": "

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.

\n

The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

\n

\n { \n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\", \n \"Effect\": \"Allow\", \n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n }, \n \"Action\":\"logs:PutLogEvents\", \n \"Resource\": \"logArn\"\n }\n ]\n} \n \n

" } }, "policyName": { @@ -3177,25 +3210,12 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a subscription filter and associates it with the specified log\n group. Subscription filters allow you to subscribe to a real-time stream of log events\n ingested through PutLogEvents and have them delivered to a specific\n destination. Currently, the supported destinations are:

\n \n

There can only be one subscription filter associated with a log group. If you are\n updating an existing filter, you must specify the correct name in filterName.\n Otherwise, the call fails because you cannot associate a second filter with a log\n group.

" + "smithy.api#documentation": "

Creates or updates a subscription filter and associates it with the specified log\n group. Subscription filters allow you to subscribe to a real-time stream of log events\n ingested through PutLogEvents and have them delivered to a specific\n destination. When log events are sent to the \n receiving service, they are Base64 encoded\n and compressed with the gzip format.

\n

The following destinations are supported for subscription filters:

\n \n

There can only be one subscription filter associated with a log group. If you are\n updating an existing filter, you must specify the correct name in filterName.\n Otherwise, the call fails because you cannot associate a second filter with a log\n group.

\n

To perform a PutSubscriptionFilter operation, you must also have the \n iam:PassRole permission.

" } }, "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest": { "type": "structure", "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group.

", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.

" - } - }, "destinationArn": { "target": "com.amazonaws.cloudwatchlogs#DestinationArn", "traits": { @@ -3203,6 +3223,12 @@ "smithy.api#required": {} } }, + "distribution": { + "target": "com.amazonaws.cloudwatchlogs#Distribution", + "traits": { + "smithy.api#documentation": "

The method used to distribute log data to the destination. By default, log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis stream.

" + } + }, "filterName": { "target": "com.amazonaws.cloudwatchlogs#FilterName", "traits": { @@ -3210,10 +3236,17 @@ "smithy.api#required": {} } }, - "distribution": { - "target": "com.amazonaws.cloudwatchlogs#Distribution", + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The method used to distribute log data to the destination. By default log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis stream.\n

" + "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#required": {} } }, "filterPattern": { @@ -3274,21 +3307,39 @@ "com.amazonaws.cloudwatchlogs#QueryDefinition": { "type": "structure", "members": { + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "

If this query definition contains a list of log groups that it is limited to, that list appears here.

" + } + }, "lastModified": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp" + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the query definition was most recently modified.

" + } }, "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId" - }, - "logGroupNames": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNames" + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "

The unique ID of the query definition.

" + } }, "name": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName" + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "

The name of the query definition.

" + } }, "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString" + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", + "traits": { + "smithy.api#documentation": "

The query string to use for this definition.\n For more information, see CloudWatch Logs Insights Query Syntax.

" + } } + }, + "traits": { + "smithy.api#documentation": "

This structure contains details about a saved CloudWatch Logs Insights query definition.

" } }, "com.amazonaws.cloudwatchlogs#QueryDefinitionList": { @@ -3328,16 +3379,10 @@ "com.amazonaws.cloudwatchlogs#QueryInfo": { "type": "structure", "members": { - "createTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this query was created.

" - } - }, - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", "traits": { - "smithy.api#documentation": "

The unique ID number of this query.

" + "smithy.api#documentation": "

The status of this query. Possible values are Cancelled,\n Complete, Failed, Running, Scheduled, and Unknown.

" } }, "queryString": { @@ -3346,10 +3391,10 @@ "smithy.api#documentation": "

The query string used in this query.

" } }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", "traits": { - "smithy.api#documentation": "

The status of this query. Possible values are Cancelled,\n Complete, Failed, Running, Scheduled, and Unknown.

" + "smithy.api#documentation": "

The unique ID number of this query.

" } }, "logGroupName": { @@ -3357,6 +3402,12 @@ "traits": { "smithy.api#documentation": "

The name of the log group scanned by this query.

" } + }, + "createTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this query was created.

" + } } }, "traits": { @@ -3388,10 +3439,10 @@ "com.amazonaws.cloudwatchlogs#QueryStatistics": { "type": "structure", "members": { - "recordsScanned": { + "recordsMatched": { "target": "com.amazonaws.cloudwatchlogs#StatsValue", "traits": { - "smithy.api#documentation": "

The total number of log events scanned during the query.

" + "smithy.api#documentation": "

The number of log events that matched the query string.

" } }, "bytesScanned": { @@ -3400,10 +3451,10 @@ "smithy.api#documentation": "

The total number of bytes in the log events scanned during the query.

" } }, - "recordsMatched": { + "recordsScanned": { "target": "com.amazonaws.cloudwatchlogs#StatsValue", "traits": { - "smithy.api#documentation": "

The number of log events that matched the query string.

" + "smithy.api#documentation": "

The total number of log events scanned during the query.

" } } }, @@ -3450,16 +3501,16 @@ "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo": { "type": "structure", "members": { - "tooOldLogEventEndIndex": { + "expiredLogEventEndIndex": { "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", "traits": { - "smithy.api#documentation": "

The log events that are too old.

" + "smithy.api#documentation": "

The expired log events.

" } }, - "expiredLogEventEndIndex": { + "tooOldLogEventEndIndex": { "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", "traits": { - "smithy.api#documentation": "

The expired log events.

" + "smithy.api#documentation": "

The log events that are too old.

" } }, "tooNewLogEventStartIndex": { @@ -3641,18 +3692,12 @@ } ], "traits": { - "smithy.api#documentation": "

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query, and the query string\n to use.

\n

For more information, see CloudWatch Logs Insights Query Syntax.

\n \n

Queries time out after 15 minutes of execution. If your queries are timing out, \n reduce the time range being searched, or partition your query into a number of queries.

" + "smithy.api#documentation": "

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group\n and time range to query and the query string to use.

\n

For more information, see CloudWatch Logs Insights Query Syntax.

\n \n

Queries time out after 15 minutes of execution. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.

" } }, "com.amazonaws.cloudwatchlogs#StartQueryRequest": { "type": "structure", "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "

The log group on which to perform the query.

\n

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but\n not both.

" - } - }, "queryString": { "target": "com.amazonaws.cloudwatchlogs#QueryString", "traits": { @@ -3660,11 +3705,10 @@ "smithy.api#required": {} } }, - "endTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", "traits": { - "smithy.api#documentation": "

The end of the time range to query. The range is inclusive, so the specified\n end time is included in the query. Specified as epoch\n time, the number of seconds since January 1, 1970, 00:00:00 UTC.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of log events to return in the query. If the query string uses the fields command,\n only the specified fields and their values are returned. The default is 1000.

" } }, "startTime": { @@ -3674,10 +3718,17 @@ "smithy.api#required": {} } }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The maximum number of log events to return in the query. If the query string uses the fields command,\n only the specified fields and their values are returned. The default is 1000.

" + "smithy.api#documentation": "

The log group on which to perform the query.

\n

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but\n not both.

" + } + }, + "endTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range to query. The range is inclusive, so the specified\n end time is included in the query. Specified as epoch\n time, the number of seconds since January 1, 1970, 00:00:00 UTC.

", + "smithy.api#required": {} } }, "logGroupNames": { @@ -3731,7 +3782,7 @@ "queryId": { "target": "com.amazonaws.cloudwatchlogs#QueryId", "traits": { - "smithy.api#documentation": "

The ID number of the query to stop. If necessary, you can use DescribeQueries\n to find this ID number.

", + "smithy.api#documentation": "

The ID number of the query to stop. To find this ID number, use\n DescribeQueries.

", "smithy.api#required": {} } } @@ -3760,28 +3811,22 @@ "com.amazonaws.cloudwatchlogs#SubscriptionFilter": { "type": "structure", "members": { - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, "distribution": { "target": "com.amazonaws.cloudwatchlogs#Distribution" }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, "filterName": { "target": "com.amazonaws.cloudwatchlogs#FilterName", "traits": { "smithy.api#documentation": "

The name of the subscription filter.

" } }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "

" - } - }, - "destinationArn": { - "target": "com.amazonaws.cloudwatchlogs#DestinationArn", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" + "smithy.api#documentation": "

The name of the log group.

" } }, "creationTime": { @@ -3790,10 +3835,16 @@ "smithy.api#documentation": "

The creation time of the subscription filter, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.

" } }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "destinationArn": { + "target": "com.amazonaws.cloudwatchlogs#DestinationArn", "traits": { - "smithy.api#documentation": "

The name of the log group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination.

" + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "

" } } }, @@ -3935,16 +3986,16 @@ "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest": { "type": "structure", "members": { - "logEventMessages": { - "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", "traits": { - "smithy.api#documentation": "

The log event messages to test.

", "smithy.api#required": {} } }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "logEventMessages": { + "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", "traits": { + "smithy.api#documentation": "

The log event messages to test.

", "smithy.api#required": {} } } @@ -4002,17 +4053,17 @@ "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.cloudwatchlogs#TagList", + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "

The tag keys. The corresponding tags are removed from the log group.

", + "smithy.api#documentation": "

The name of the log group.

", "smithy.api#required": {} } }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "tags": { + "target": "com.amazonaws.cloudwatchlogs#TagList", "traits": { - "smithy.api#documentation": "

The name of the log group.

", + "smithy.api#documentation": "

The tag keys. The corresponding tags are removed from the log group.

", "smithy.api#required": {} } } 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 227715aa90fb..8df9a0547e72 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json @@ -65,18 +65,6 @@ "com.amazonaws.cloudwatch#AlarmHistoryItem": { "type": "structure", "members": { - "HistoryData": { - "target": "com.amazonaws.cloudwatch#HistoryData", - "traits": { - "smithy.api#documentation": "

Data about the alarm, in JSON format.

" - } - }, - "Timestamp": { - "target": "com.amazonaws.cloudwatch#Timestamp", - "traits": { - "smithy.api#documentation": "

The time stamp for the alarm history item.

" - } - }, "HistorySummary": { "target": "com.amazonaws.cloudwatch#HistorySummary", "traits": { @@ -89,16 +77,28 @@ "smithy.api#documentation": "

The type of alarm history item.

" } }, + "AlarmType": { + "target": "com.amazonaws.cloudwatch#AlarmType", + "traits": { + "smithy.api#documentation": "

The type of alarm, either metric alarm or composite alarm.

" + } + }, + "HistoryData": { + "target": "com.amazonaws.cloudwatch#HistoryData", + "traits": { + "smithy.api#documentation": "

Data about the alarm, in JSON format.

" + } + }, "AlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { "smithy.api#documentation": "

The descriptive name for the alarm.

" } }, - "AlarmType": { - "target": "com.amazonaws.cloudwatch#AlarmType", + "Timestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The type of alarm, either metric alarm or composite alarm.

" + "smithy.api#documentation": "

The time stamp for the alarm history item.

" } } }, @@ -182,24 +182,6 @@ "com.amazonaws.cloudwatch#AnomalyDetector": { "type": "structure", "members": { - "StateValue": { - "target": "com.amazonaws.cloudwatch#AnomalyDetectorStateValue", - "traits": { - "smithy.api#documentation": "

The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA\n

" - } - }, - "Dimensions": { - "target": "com.amazonaws.cloudwatch#Dimensions", - "traits": { - "smithy.api#documentation": "

The metric dimensions associated with the anomaly detection model.

" - } - }, - "Namespace": { - "target": "com.amazonaws.cloudwatch#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the metric associated with the anomaly detection model.

" - } - }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { @@ -217,6 +199,24 @@ "traits": { "smithy.api#documentation": "

The configuration specifies details about how the \n\t\tanomaly detection model is to be trained, including time ranges to \n\t\texclude from use for training the model, and the time zone to use for \n\t\tthe metric.

" } + }, + "StateValue": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectorStateValue", + "traits": { + "smithy.api#documentation": "

The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA\n

" + } + }, + "Dimensions": { + "target": "com.amazonaws.cloudwatch#Dimensions", + "traits": { + "smithy.api#documentation": "

The metric dimensions associated with the anomaly detection model.

" + } + }, + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric associated with the anomaly detection model.

" + } } }, "traits": { @@ -226,17 +226,17 @@ "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration": { "type": "structure", "members": { - "MetricTimezone": { - "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone", - "traits": { - "smithy.api#documentation": "

The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.

\n\t\t

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.

" - } - }, "ExcludedTimeRanges": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorExcludedTimeRanges", "traits": { "smithy.api#documentation": "

An array of time ranges to exclude from use when the anomaly detection model is trained. Use\n\t\t\tthis to make sure that events that could cause unusual values for the metric, such as\n\t\t\tdeployments, aren't used when CloudWatch creates the model.

" } + }, + "MetricTimezone": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone", + "traits": { + "smithy.api#documentation": "

The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.

\n\t\t

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.

" + } } }, "traits": { @@ -327,10 +327,10 @@ "com.amazonaws.cloudwatch#CompositeAlarm": { "type": "structure", "members": { - "AlarmRule": { - "target": "com.amazonaws.cloudwatch#AlarmRule", + "AlarmArn": { + "target": "com.amazonaws.cloudwatch#AlarmArn", "traits": { - "smithy.api#documentation": "

The rule that this alarm uses to evaluate its alarm state.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" } }, "StateReasonData": { @@ -339,28 +339,28 @@ "smithy.api#documentation": "

An explanation for the alarm state, in JSON format.

" } }, - "StateValue": { - "target": "com.amazonaws.cloudwatch#StateValue", + "InsufficientDataActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The state value for the alarm.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" } }, - "AlarmArn": { - "target": "com.amazonaws.cloudwatch#AlarmArn", + "OKActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" } }, - "InsufficientDataActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", + "AlarmRule": { + "target": "com.amazonaws.cloudwatch#AlarmRule", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

The rule that this alarm uses to evaluate its alarm state.

" } }, - "ActionsEnabled": { - "target": "com.amazonaws.cloudwatch#ActionsEnabled", + "StateValue": { + "target": "com.amazonaws.cloudwatch#StateValue", "traits": { - "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state.

" + "smithy.api#documentation": "

The state value for the alarm.

" } }, "StateReason": { @@ -369,16 +369,22 @@ "smithy.api#documentation": "

An explanation for the alarm state, in text format.

" } }, - "AlarmName": { - "target": "com.amazonaws.cloudwatch#AlarmName", + "AlarmDescription": { + "target": "com.amazonaws.cloudwatch#AlarmDescription", "traits": { - "smithy.api#documentation": "

The name of the alarm.

" + "smithy.api#documentation": "

The description of the alarm.

" } }, - "OKActions": { + "ActionsEnabled": { + "target": "com.amazonaws.cloudwatch#ActionsEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state.

" + } + }, + "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" } }, "AlarmConfigurationUpdatedTimestamp": { @@ -393,16 +399,10 @@ "smithy.api#documentation": "

The time stamp of the last update to the alarm state.

" } }, - "AlarmActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", - "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" - } - }, - "AlarmDescription": { - "target": "com.amazonaws.cloudwatch#AlarmDescription", + "AlarmName": { + "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

The description of the alarm.

" + "smithy.api#documentation": "

The name of the alarm.

" } } }, @@ -450,12 +450,6 @@ "com.amazonaws.cloudwatch#DashboardEntry": { "type": "structure", "members": { - "Size": { - "target": "com.amazonaws.cloudwatch#Size", - "traits": { - "smithy.api#documentation": "

The size of the dashboard, in bytes.

" - } - }, "LastModified": { "target": "com.amazonaws.cloudwatch#LastModified", "traits": { @@ -473,6 +467,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" } + }, + "Size": { + "target": "com.amazonaws.cloudwatch#Size", + "traits": { + "smithy.api#documentation": "

The size of the dashboard, in bytes.

" + } } }, "traits": { @@ -485,11 +485,11 @@ "com.amazonaws.cloudwatch#DashboardInvalidInputError": { "type": "structure", "members": { - "dashboardValidationMessages": { - "target": "com.amazonaws.cloudwatch#DashboardValidationMessages" - }, "message": { "target": "com.amazonaws.cloudwatch#DashboardErrorMessage" + }, + "dashboardValidationMessages": { + "target": "com.amazonaws.cloudwatch#DashboardValidationMessages" } }, "traits": { @@ -526,17 +526,17 @@ "com.amazonaws.cloudwatch#DashboardValidationMessage": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.cloudwatch#Message", - "traits": { - "smithy.api#documentation": "

A message describing the error or warning.

" - } - }, "DataPath": { "target": "com.amazonaws.cloudwatch#DataPath", "traits": { "smithy.api#documentation": "

The data path related to the message.

" } + }, + "Message": { + "target": "com.amazonaws.cloudwatch#Message", + "traits": { + "smithy.api#documentation": "

A message describing the error or warning.

" + } } }, "traits": { @@ -555,22 +555,16 @@ "com.amazonaws.cloudwatch#Datapoint": { "type": "structure", "members": { - "Minimum": { - "target": "com.amazonaws.cloudwatch#DatapointValue", - "traits": { - "smithy.api#documentation": "

The minimum metric value for the data point.

" - } - }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { "smithy.api#documentation": "

The standard unit for the data point.

" } }, - "Sum": { + "Maximum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The sum of the metric values for the data point.

" + "smithy.api#documentation": "

The maximum metric value for the data point.

" } }, "Timestamp": { @@ -579,10 +573,10 @@ "smithy.api#documentation": "

The time stamp used for the data point.

" } }, - "ExtendedStatistics": { - "target": "com.amazonaws.cloudwatch#DatapointValueMap", + "Average": { + "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The percentile statistic for the data point.

" + "smithy.api#documentation": "

The average of the metric values that correspond to the data point.

" } }, "SampleCount": { @@ -591,16 +585,22 @@ "smithy.api#documentation": "

The number of metric values that contributed to the aggregate value of this\n\t\t\tdata point.

" } }, - "Maximum": { + "Minimum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The maximum metric value for the data point.

" + "smithy.api#documentation": "

The minimum metric value for the data point.

" } }, - "Average": { + "Sum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The average of the metric values that correspond to the data point.

" + "smithy.api#documentation": "

The sum of the metric values for the data point.

" + } + }, + "ExtendedStatistics": { + "target": "com.amazonaws.cloudwatch#DatapointValueMap", + "traits": { + "smithy.api#documentation": "

The percentile statistic for the data point.

" } } }, @@ -699,13 +699,6 @@ "com.amazonaws.cloudwatch#DeleteAnomalyDetectorInput": { "type": "structure", "members": { - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", - "traits": { - "smithy.api#documentation": "

The metric name associated with the anomaly detection model to delete.

", - "smithy.api#required": {} - } - }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { @@ -725,6 +718,13 @@ "smithy.api#documentation": "

The statistic associated with the anomaly detection model to delete.

", "smithy.api#required": {} } + }, + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", + "traits": { + "smithy.api#documentation": "

The metric name associated with the anomaly detection model to delete.

", + "smithy.api#required": {} + } } } }, @@ -840,6 +840,24 @@ "com.amazonaws.cloudwatch#DescribeAlarmHistoryInput": { "type": "structure", "members": { + "HistoryItemType": { + "target": "com.amazonaws.cloudwatch#HistoryItemType", + "traits": { + "smithy.api#documentation": "

The type of alarm histories to retrieve.

" + } + }, + "AlarmTypes": { + "target": "com.amazonaws.cloudwatch#AlarmTypes", + "traits": { + "smithy.api#documentation": "

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, \n\t\t\tonly metric alarms are returned.

" + } + }, + "EndDate": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "

The ending date to retrieve alarm history.

" + } + }, "MaxRecords": { "target": "com.amazonaws.cloudwatch#MaxRecords", "traits": { @@ -852,40 +870,22 @@ "smithy.api#documentation": "

The starting date to retrieve alarm history.

" } }, - "ScanBy": { - "target": "com.amazonaws.cloudwatch#ScanBy", - "traits": { - "smithy.api#documentation": "

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest\n\t\tevent history returned first, and specify TimestampAscending to have the oldest history returned first.

" - } - }, "AlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { "smithy.api#documentation": "

The name of the alarm.

" } }, - "EndDate": { - "target": "com.amazonaws.cloudwatch#Timestamp", - "traits": { - "smithy.api#documentation": "

The ending date to retrieve alarm history.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "

The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.

" } }, - "HistoryItemType": { - "target": "com.amazonaws.cloudwatch#HistoryItemType", - "traits": { - "smithy.api#documentation": "

The type of alarm histories to retrieve.

" - } - }, - "AlarmTypes": { - "target": "com.amazonaws.cloudwatch#AlarmTypes", + "ScanBy": { + "target": "com.amazonaws.cloudwatch#ScanBy", "traits": { - "smithy.api#documentation": "

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, \n\t\t\tonly metric alarms are returned.

" + "smithy.api#documentation": "

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest\n\t\tevent history returned first, and specify TimestampAscending to have the oldest history returned first.

" } } } @@ -944,36 +944,36 @@ "com.amazonaws.cloudwatch#DescribeAlarmsForMetricInput": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.cloudwatch#Namespace", + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The namespace of the metric.

", + "smithy.api#documentation": "

The name of the metric.

", "smithy.api#required": {} } }, - "Period": { - "target": "com.amazonaws.cloudwatch#Period", + "ExtendedStatistic": { + "target": "com.amazonaws.cloudwatch#ExtendedStatistic", "traits": { - "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" + "smithy.api#documentation": "

The percentile statistic for the metric. Specify a value between\n\t\t p0.0 and p100.

" } }, - "Dimensions": { - "target": "com.amazonaws.cloudwatch#Dimensions", + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The dimensions associated with the metric. If the metric has any associated\n\t\t\tdimensions, you must specify them in order for the call to succeed.

" + "smithy.api#documentation": "

The namespace of the metric.

", + "smithy.api#required": {} } }, - "Statistic": { - "target": "com.amazonaws.cloudwatch#Statistic", + "Dimensions": { + "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { - "smithy.api#documentation": "

The statistic for the metric, other than percentiles.\n\t\t For percentile statistics, use ExtendedStatistics.

" + "smithy.api#documentation": "

The dimensions associated with the metric. If the metric has any associated\n\t\t\tdimensions, you must specify them in order for the call to succeed.

" } }, - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", + "Period": { + "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The name of the metric.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" } }, "Unit": { @@ -982,10 +982,10 @@ "smithy.api#documentation": "

The unit for the metric.

" } }, - "ExtendedStatistic": { - "target": "com.amazonaws.cloudwatch#ExtendedStatistic", + "Statistic": { + "target": "com.amazonaws.cloudwatch#Statistic", "traits": { - "smithy.api#documentation": "

The percentile statistic for the metric. Specify a value between\n\t\t p0.0 and p100.

" + "smithy.api#documentation": "

The statistic for the metric, other than percentiles.\n\t\t For percentile statistics, use ExtendedStatistics.

" } } } @@ -1004,10 +1004,28 @@ "com.amazonaws.cloudwatch#DescribeAlarmsInput": { "type": "structure", "members": { - "AlarmTypes": { - "target": "com.amazonaws.cloudwatch#AlarmTypes", + "MaxRecords": { + "target": "com.amazonaws.cloudwatch#MaxRecords", "traits": { - "smithy.api#documentation": "

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, \n\t\tonly metric alarms are returned.

" + "smithy.api#documentation": "

The maximum number of alarm descriptions to retrieve.

" + } + }, + "AlarmNamePrefix": { + "target": "com.amazonaws.cloudwatch#AlarmNamePrefix", + "traits": { + "smithy.api#documentation": "

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.

\n\t\t

If this parameter\n\t\t\tis specified, you cannot specify AlarmNames.

" + } + }, + "ChildrenOfAlarmName": { + "target": "com.amazonaws.cloudwatch#AlarmName", + "traits": { + "smithy.api#documentation": "

If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.

\n\t\t

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.

\n\t\t \n

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " + } + }, + "ActionPrefix": { + "target": "com.amazonaws.cloudwatch#ActionPrefix", + "traits": { + "smithy.api#documentation": "

Use this parameter to filter the results of the operation to only those alarms that\n\t\tuse a certain alarm action. For example, you could specify the ARN of an SNS topic to find all\n\t\talarms that send notifications to that topic.

" } }, "NextToken": { @@ -1034,28 +1052,10 @@ "smithy.api#documentation": "

If you use this parameter and specify the name of a metric or composite alarm, the operation returns \n\t\t\tinformation about the \"parent\" alarms\n\t\t\tof the alarm you specify. These are the composite alarms that have AlarmRule\n\t\t\tparameters that reference \n\t\t\tthe alarm named in ParentsOfAlarmName. Information about the alarm that you specify in\n\t\t\tParentsOfAlarmName is not returned.

\n\t\t

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you receive a validation\n\t\t\terror.

\n\t\t \n

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " } }, - "ActionPrefix": { - "target": "com.amazonaws.cloudwatch#ActionPrefix", - "traits": { - "smithy.api#documentation": "

Use this parameter to filter the results of the operation to only those alarms that\n\t\tuse a certain alarm action. For example, you could specify the ARN of an SNS topic to find all\n\t\talarms that send notifications to that topic.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.cloudwatch#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of alarm descriptions to retrieve.

" - } - }, - "ChildrenOfAlarmName": { - "target": "com.amazonaws.cloudwatch#AlarmName", - "traits": { - "smithy.api#documentation": "

If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.

\n\t\t

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.

\n\t\t \n

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " - } - }, - "AlarmNamePrefix": { - "target": "com.amazonaws.cloudwatch#AlarmNamePrefix", + "AlarmTypes": { + "target": "com.amazonaws.cloudwatch#AlarmTypes", "traits": { - "smithy.api#documentation": "

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.

\n\t\t

If this parameter\n\t\t\tis specified, you cannot specify AlarmNames.

" + "smithy.api#documentation": "

Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, \n\t\tonly metric alarms are returned.

" } } } @@ -1063,12 +1063,6 @@ "com.amazonaws.cloudwatch#DescribeAlarmsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudwatch#NextToken", - "traits": { - "smithy.api#documentation": "

The token that marks the start of the next batch of returned results.

" - } - }, "MetricAlarms": { "target": "com.amazonaws.cloudwatch#MetricAlarms", "traits": { @@ -1080,6 +1074,12 @@ "traits": { "smithy.api#documentation": "

The information about any composite alarms returned by the operation.

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "

The token that marks the start of the next batch of returned results.

" + } } } }, @@ -1109,18 +1109,6 @@ "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.cloudwatch#MaxReturnedResultsCount", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.

\n\t\t\t

To retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.

" - } - }, - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", - "traits": { - "smithy.api#documentation": "

Limits the results to only the anomaly detection models that are associated with the\n\t\t\tspecified metric name. If there are multiple metrics with this name in different\n\t\t\tnamespaces that have anomaly detection models, they're all returned.

" - } - }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { @@ -1138,23 +1126,35 @@ "traits": { "smithy.api#documentation": "

Limits the results to only the anomaly detection models that\n\t\t\tare associated with the specified namespace.

" } + }, + "MaxResults": { + "target": "com.amazonaws.cloudwatch#MaxReturnedResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.

\n\t\t\t

To retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.

" + } + }, + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", + "traits": { + "smithy.api#documentation": "

Limits the results to only the anomaly detection models that are associated with the\n\t\t\tspecified metric name. If there are multiple metrics with this name in different\n\t\t\tnamespaces that have anomaly detection models, they're all returned.

" + } } } }, "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsOutput": { "type": "structure", "members": { - "AnomalyDetectors": { - "target": "com.amazonaws.cloudwatch#AnomalyDetectors", - "traits": { - "smithy.api#documentation": "

The list of anomaly detection models returned by the operation.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "

A token that you can use in a subsequent operation to \n\t\tretrieve the next set of results.

" } + }, + "AnomalyDetectors": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectors", + "traits": { + "smithy.api#documentation": "

The list of anomaly detection models returned by the operation.

" + } } } }, @@ -1200,17 +1200,17 @@ "com.amazonaws.cloudwatch#DescribeInsightRulesOutput": { "type": "structure", "members": { - "InsightRules": { - "target": "com.amazonaws.cloudwatch#InsightRules", - "traits": { - "smithy.api#documentation": "

The rules returned by the operation.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "

Reserved for future use.

" } + }, + "InsightRules": { + "target": "com.amazonaws.cloudwatch#InsightRules", + "traits": { + "smithy.api#documentation": "

The rules returned by the operation.

" + } } } }, @@ -1239,18 +1239,18 @@ "com.amazonaws.cloudwatch#DimensionFilter": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.cloudwatch#DimensionValue", - "traits": { - "smithy.api#documentation": "

The value of the dimension to be matched.

" - } - }, "Name": { "target": "com.amazonaws.cloudwatch#DimensionName", "traits": { "smithy.api#documentation": "

The dimension name to be matched.

", "smithy.api#required": {} } + }, + "Value": { + "target": "com.amazonaws.cloudwatch#DimensionValue", + "traits": { + "smithy.api#documentation": "

The value of the dimension to be matched.

" + } } }, "traits": { @@ -1528,12 +1528,6 @@ "com.amazonaws.cloudwatch#GetDashboardOutput": { "type": "structure", "members": { - "DashboardArn": { - "target": "com.amazonaws.cloudwatch#DashboardArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, "DashboardBody": { "target": "com.amazonaws.cloudwatch#DashboardBody", "traits": { @@ -1545,6 +1539,12 @@ "traits": { "smithy.api#documentation": "

The name of the dashboard.

" } + }, + "DashboardArn": { + "target": "com.amazonaws.cloudwatch#DashboardArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } } } }, @@ -1574,25 +1574,10 @@ "com.amazonaws.cloudwatch#GetInsightRuleReportInput": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.cloudwatch#Timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.cloudwatch#Timestamp", - "traits": { - "smithy.api#documentation": "

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", - "smithy.api#required": {} - } - }, - "RuleName": { - "target": "com.amazonaws.cloudwatch#InsightRuleName", + "Metrics": { + "target": "com.amazonaws.cloudwatch#InsightRuleMetricList", "traits": { - "smithy.api#documentation": "

The name of the rule that you want to see data from.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:

\n\t\t " } }, "MaxContributorCount": { @@ -1607,34 +1592,55 @@ "smithy.api#documentation": "

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

" } }, - "Metrics": { - "target": "com.amazonaws.cloudwatch#InsightRuleMetricList", - "traits": { - "smithy.api#documentation": "

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:

\n\t\t " - } - }, "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#documentation": "

The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

", "smithy.api#required": {} } + }, + "StartTime": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", + "smithy.api#required": {} + } + }, + "RuleName": { + "target": "com.amazonaws.cloudwatch#InsightRuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule that you want to see data from.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.cloudwatch#GetInsightRuleReportOutput": { "type": "structure", "members": { - "AggregationStatistic": { - "target": "com.amazonaws.cloudwatch#InsightRuleAggregationStatistic", + "MetricDatapoints": { + "target": "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints", "traits": { - "smithy.api#documentation": "

Specifies whether this rule aggregates contributor data by COUNT or SUM.

" + "smithy.api#documentation": "

A time series of metric data points that matches the time period in the rule request.

" } }, - "Contributors": { - "target": "com.amazonaws.cloudwatch#InsightRuleContributors", + "ApproximateUniqueCount": { + "target": "com.amazonaws.cloudwatch#InsightRuleUnboundLong", "traits": { - "smithy.api#documentation": "

An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values\n\t\tfor the keys counts as a unique contributor.

" + "smithy.api#documentation": "

An approximate count of the unique contributors found by this rule in this time period.

" + } + }, + "AggregationStatistic": { + "target": "com.amazonaws.cloudwatch#InsightRuleAggregationStatistic", + "traits": { + "smithy.api#documentation": "

Specifies whether this rule aggregates contributor data by COUNT or SUM.

" } }, "AggregateValue": { @@ -1643,10 +1649,10 @@ "smithy.api#documentation": "

The sum of the values from all individual contributors that match the rule.

" } }, - "MetricDatapoints": { - "target": "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints", + "Contributors": { + "target": "com.amazonaws.cloudwatch#InsightRuleContributors", "traits": { - "smithy.api#documentation": "

A time series of metric data points that matches the time period in the rule request.

" + "smithy.api#documentation": "

An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values\n\t\tfor the keys counts as a unique contributor.

" } }, "KeyLabels": { @@ -1654,12 +1660,6 @@ "traits": { "smithy.api#documentation": "

An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. \n\t\t\tIf the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.

" } - }, - "ApproximateUniqueCount": { - "target": "com.amazonaws.cloudwatch#InsightRuleUnboundLong", - "traits": { - "smithy.api#documentation": "

An approximate count of the unique contributors found by this rule in this time period.

" - } } } }, @@ -1688,30 +1688,23 @@ "com.amazonaws.cloudwatch#GetMetricDataInput": { "type": "structure", "members": { - "MetricDataQueries": { - "target": "com.amazonaws.cloudwatch#MetricDataQueries", + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Include this value, if it was returned by the previous call, to get the next set of data points.

" } }, - "StartTime": { - "target": "com.amazonaws.cloudwatch#Timestamp", + "MaxDatapoints": { + "target": "com.amazonaws.cloudwatch#GetMetricDataMaxDatapoints", "traits": { - "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n\t\t

The value specified is inclusive; results include data points with the specified time stamp.

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

\n\t\t

For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudwatch#NextToken", - "traits": { - "smithy.api#documentation": "

Include this value, if it was returned by the previous call, to get the next set of data points.

" + "smithy.api#documentation": "

The maximum number of data points the request should return before paginating. If you omit\n\t\t\tthis, the default of 100,800 is used.

" } }, - "MaxDatapoints": { - "target": "com.amazonaws.cloudwatch#GetMetricDataMaxDatapoints", + "StartTime": { + "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The maximum number of data points the request should return before paginating. If you omit\n\t\t\tthis, the default of 100,800 is used.

" + "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n\t\t

The value specified is inclusive; results include data points with the specified time stamp.

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

\n\t\t

For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.

", + "smithy.api#required": {} } }, "ScanBy": { @@ -1726,6 +1719,13 @@ "smithy.api#documentation": "

The time stamp indicating the latest data to be returned.

\n\t\t

The value specified is exclusive; results include data points up to the specified time stamp.

\n\t\t

For better performance, specify StartTime and EndTime\n\t\t\tvalues that align with the value of the metric's Period and sync up with\n\t\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\t\tis 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the EndTime.

", "smithy.api#required": {} } + }, + "MetricDataQueries": { + "target": "com.amazonaws.cloudwatch#MetricDataQueries", + "traits": { + "smithy.api#documentation": "

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

", + "smithy.api#required": {} + } } } }, @@ -1738,6 +1738,12 @@ "com.amazonaws.cloudwatch#GetMetricDataOutput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "

A token that marks the next batch of returned results.

" + } + }, "Messages": { "target": "com.amazonaws.cloudwatch#MetricDataResultMessages", "traits": { @@ -1749,12 +1755,6 @@ "traits": { "smithy.api#documentation": "

The metrics that are returned, including the metric name, namespace, and dimensions.

" } - }, - "NextToken": { - "target": "com.amazonaws.cloudwatch#NextToken", - "traits": { - "smithy.api#documentation": "

A token that marks the next batch of returned results.

" - } } } }, @@ -1787,63 +1787,63 @@ "com.amazonaws.cloudwatch#GetMetricStatisticsInput": { "type": "structure", "members": { - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", + "StartTime": { + "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the metric, with or without spaces.

", + "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.

\n\t

The value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

", "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.cloudwatch#Timestamp", + "Unit": { + "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

The time stamp that determines the last data point to return.

\n\t\t

The value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unit for a given metric. \n\t\t\tIf you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.

\n\t

The value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

", + "smithy.api#documentation": "

The time stamp that determines the last data point to return.

\n\t\t

The value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

", "smithy.api#required": {} } }, - "Dimensions": { - "target": "com.amazonaws.cloudwatch#Dimensions", + "ExtendedStatistics": { + "target": "com.amazonaws.cloudwatch#ExtendedStatistics", "traits": { - "smithy.api#documentation": "

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric.\n\t\t If a specific combination of dimensions was not published, you can't retrieve statistics for it.\n\t\t You must specify the same dimensions that were used when the metrics were created. For an example,\n\t\t see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

" + "smithy.api#documentation": "

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must \n\t\t\tspecify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not \n\t\t\tavailable for metrics when any of the metric values are negative numbers.

" } }, - "Period": { - "target": "com.amazonaws.cloudwatch#Period", + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t ", + "smithy.api#documentation": "

The namespace of the metric, with or without spaces.

", "smithy.api#required": {} } }, - "Unit": { - "target": "com.amazonaws.cloudwatch#StandardUnit", - "traits": { - "smithy.api#documentation": "

The unit for a given metric. \n\t\t\tIf you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" - } - }, "Statistics": { "target": "com.amazonaws.cloudwatch#Statistics", "traits": { "smithy.api#documentation": "

The metric statistics, other than percentile. For percentile statistics,\n\t\t use ExtendedStatistics. When calling GetMetricStatistics, you must \n\t\tspecify either Statistics or ExtendedStatistics, but not both.

" } }, - "Namespace": { - "target": "com.amazonaws.cloudwatch#Namespace", + "Dimensions": { + "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { - "smithy.api#documentation": "

The namespace of the metric, with or without spaces.

", + "smithy.api#documentation": "

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric.\n\t\t If a specific combination of dimensions was not published, you can't retrieve statistics for it.\n\t\t You must specify the same dimensions that were used when the metrics were created. For an example,\n\t\t see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

" + } + }, + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric, with or without spaces.

", "smithy.api#required": {} } }, - "ExtendedStatistics": { - "target": "com.amazonaws.cloudwatch#ExtendedStatistics", + "Period": { + "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must \n\t\t\tspecify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not \n\t\t\tavailable for metrics when any of the metric values are negative numbers.

" + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t ", + "smithy.api#required": {} } } } @@ -1880,18 +1880,18 @@ "com.amazonaws.cloudwatch#GetMetricWidgetImageInput": { "type": "structure", "members": { + "OutputFormat": { + "target": "com.amazonaws.cloudwatch#OutputFormat", + "traits": { + "smithy.api#documentation": "

The format of the resulting image. Only PNG images are supported.

\n\n\t\t

The default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:

\n\t\t\n\t\t

\n \n\t\t\t>\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n 6f0d4192-4d42-11e8-82c1-f539a07e0e3b\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t\n\t\t

The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an AWS SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.

" + } + }, "MetricWidget": { "target": "com.amazonaws.cloudwatch#MetricWidget", "traits": { "smithy.api#documentation": "

A JSON string that defines the bitmap graph to be retrieved. The string includes the \n\t\t\tmetrics to include in the graph, statistics, annotations, title, axis limits, and so on. \n\t\t\tYou can include only one MetricWidget parameter in each GetMetricWidgetImage call.

\n\t\t

For more information about the syntax of MetricWidget see \n\t\t\tGetMetricWidgetImage: Metric Widget Structure and Syntax.

\n\t\t\n\t\t

If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation\n\t\t\tpoint appears next to the graph legend.

", "smithy.api#required": {} } - }, - "OutputFormat": { - "target": "com.amazonaws.cloudwatch#OutputFormat", - "traits": { - "smithy.api#documentation": "

The format of the resulting image. Only PNG images are supported.

\n\n\t\t

The default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:

\n\t\t\n\t\t

\n \n\t\t\t>\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n 6f0d4192-4d42-11e8-82c1-f539a07e0e3b\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t\n\t\t

The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an AWS SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.

" - } } } }, @@ -2006,7 +2006,7 @@ "sdkId": "CloudWatch", "arnNamespace": "monitoring", "cloudFormationName": "CloudWatch", - "cloudTrailEventSource": "v2010_08_01.cloudwatch.amazonaws.com" + "cloudTrailEventSource": "cloudwatch.amazonaws.com" }, "aws.auth#sigv4": { "name": "monitoring" @@ -2056,10 +2056,10 @@ "com.amazonaws.cloudwatch#InsightRule": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.cloudwatch#InsightRuleState", + "Name": { + "target": "com.amazonaws.cloudwatch#InsightRuleName", "traits": { - "smithy.api#documentation": "

Indicates whether the rule is enabled or disabled.

", + "smithy.api#documentation": "

The name of the rule.

", "smithy.api#required": {} } }, @@ -2070,17 +2070,17 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.cloudwatch#InsightRuleName", + "Definition": { + "target": "com.amazonaws.cloudwatch#InsightRuleDefinition", "traits": { - "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#documentation": "

The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, \n\t\t\tthe value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\t\tRule Syntax.

", "smithy.api#required": {} } }, - "Definition": { - "target": "com.amazonaws.cloudwatch#InsightRuleDefinition", + "State": { + "target": "com.amazonaws.cloudwatch#InsightRuleState", "traits": { - "smithy.api#documentation": "

The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, \n\t\t\tthe value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\t\tRule Syntax.

", + "smithy.api#documentation": "

Indicates whether the rule is enabled or disabled.

", "smithy.api#required": {} } } @@ -2095,6 +2095,13 @@ "com.amazonaws.cloudwatch#InsightRuleContributor": { "type": "structure", "members": { + "ApproximateAggregateValue": { + "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", + "traits": { + "smithy.api#documentation": "

An approximation of the aggregate value that comes from this contributor.

", + "smithy.api#required": {} + } + }, "Keys": { "target": "com.amazonaws.cloudwatch#InsightRuleContributorKeys", "traits": { @@ -2108,13 +2115,6 @@ "smithy.api#documentation": "

An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.

", "smithy.api#required": {} } - }, - "ApproximateAggregateValue": { - "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", - "traits": { - "smithy.api#documentation": "

An approximation of the aggregate value that comes from this contributor.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2124,17 +2124,17 @@ "com.amazonaws.cloudwatch#InsightRuleContributorDatapoint": { "type": "structure", "members": { - "ApproximateValue": { - "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", + "Timestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The approximate value that this contributor added during this timestamp.

", + "smithy.api#documentation": "

The timestamp of the data point.

", "smithy.api#required": {} } }, - "Timestamp": { - "target": "com.amazonaws.cloudwatch#Timestamp", + "ApproximateValue": { + "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The timestamp of the data point.

", + "smithy.api#documentation": "

The approximate value that this contributor added during this timestamp.

", "smithy.api#required": {} } } @@ -2196,53 +2196,53 @@ "com.amazonaws.cloudwatch#InsightRuleMetricDatapoint": { "type": "structure", "members": { - "Minimum": { + "MaxContributorValue": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The minimum value from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" } }, - "SampleCount": { + "Maximum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The number of occurrences that matched the rule during this data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The maximum value from a single occurence from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" } }, - "UniqueContributors": { - "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", + "Timestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The number of unique contributors who published data during this timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The timestamp of the data point.

", + "smithy.api#required": {} } }, - "Maximum": { + "Sum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The maximum value from a single occurence from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The sum of the values from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" } }, - "Average": { + "Minimum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The average value from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The minimum value from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" } }, - "Timestamp": { - "target": "com.amazonaws.cloudwatch#Timestamp", + "UniqueContributors": { + "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The timestamp of the data point.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of unique contributors who published data during this timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" } }, - "Sum": { + "Average": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The sum of the values from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The average value from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" } }, - "MaxContributorValue": { + "SampleCount": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The number of occurrences that matched the rule during this data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" } } }, @@ -2475,34 +2475,34 @@ "com.amazonaws.cloudwatch#ListDashboardsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cloudwatch#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to indicate that there is more data available.

" - } - }, "DashboardNamePrefix": { "target": "com.amazonaws.cloudwatch#DashboardNamePrefix", "traits": { "smithy.api#documentation": "

If you specify this parameter, only\n\t\t\tthe dashboards with names starting with the specified string are listed. The maximum length is 255, and \n\t\t\tvalid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".\n\t\t\t \n\t\t

" } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to indicate that there is more data available.

" + } } } }, "com.amazonaws.cloudwatch#ListDashboardsOutput": { "type": "structure", "members": { - "DashboardEntries": { - "target": "com.amazonaws.cloudwatch#DashboardEntries", - "traits": { - "smithy.api#documentation": "

The list of matching dashboards.

" - } - }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "

The token that marks the start of the next batch of returned results.

" } + }, + "DashboardEntries": { + "target": "com.amazonaws.cloudwatch#DashboardEntries", + "traits": { + "smithy.api#documentation": "

The list of matching dashboards.

" + } } } }, @@ -2534,6 +2534,12 @@ "com.amazonaws.cloudwatch#ListMetricsInput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.

" + } + }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { @@ -2557,12 +2563,6 @@ "traits": { "smithy.api#documentation": "

The dimensions to filter against.

" } - }, - "NextToken": { - "target": "com.amazonaws.cloudwatch#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.

" - } } } }, @@ -2654,17 +2654,17 @@ "com.amazonaws.cloudwatch#MessageData": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.cloudwatch#MessageDataValue", - "traits": { - "smithy.api#documentation": "

The message text.

" - } - }, "Code": { "target": "com.amazonaws.cloudwatch#MessageDataCode", "traits": { "smithy.api#documentation": "

The error code or status code associated with the message.

" } + }, + "Value": { + "target": "com.amazonaws.cloudwatch#MessageDataValue", + "traits": { + "smithy.api#documentation": "

The message text.

" + } } }, "traits": { @@ -2686,17 +2686,17 @@ "smithy.api#documentation": "

The namespace of the metric.

" } }, - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric. This is a required field.

" - } - }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "

The dimensions for the metric.

" } + }, + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric. This is a required field.

" + } } }, "traits": { @@ -2706,118 +2706,112 @@ "com.amazonaws.cloudwatch#MetricAlarm": { "type": "structure", "members": { - "AlarmDescription": { - "target": "com.amazonaws.cloudwatch#AlarmDescription", + "TreatMissingData": { + "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

The description of the alarm.

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

" } }, - "StateValue": { - "target": "com.amazonaws.cloudwatch#StateValue", + "EvaluateLowSampleCountPercentile": { + "target": "com.amazonaws.cloudwatch#EvaluateLowSampleCountPercentile", "traits": { - "smithy.api#documentation": "

The state value for the alarm.

" + "smithy.api#documentation": "

Used only for alarms based on percentiles. If ignore, the alarm state does not change \n\t\t\tduring periods with too few data points to be statistically significant. If evaluate or this \n\t\t\tparameter is not used, the alarm is always evaluated and possibly changes state no matter \n\t\t\thow many data points are available.

" } }, - "InsufficientDataActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", - "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state \n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

" - } - }, - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", + "ExtendedStatistic": { + "target": "com.amazonaws.cloudwatch#ExtendedStatistic", "traits": { - "smithy.api#documentation": "

The name of the metric associated with the alarm, if this is an alarm\n\t\tbased on a single metric.

" + "smithy.api#documentation": "

The percentile statistic for the metric associated with the alarm. Specify a value between\n\t\t\tp0.0 and p100.

" } }, - "ThresholdMetricId": { - "target": "com.amazonaws.cloudwatch#MetricId", + "AlarmArn": { + "target": "com.amazonaws.cloudwatch#AlarmArn", "traits": { - "smithy.api#documentation": "

In an alarm based on an anomaly detection model, this is the ID of the \n\t\t\tANOMALY_DETECTION_BAND function \n\t\t\tused as the threshold for the alarm.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" } }, - "AlarmActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", + "ActionsEnabled": { + "target": "com.amazonaws.cloudwatch#ActionsEnabled", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state \n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state.

" } }, - "AlarmName": { - "target": "com.amazonaws.cloudwatch#AlarmName", + "DatapointsToAlarm": { + "target": "com.amazonaws.cloudwatch#DatapointsToAlarm", "traits": { - "smithy.api#documentation": "

The name of the alarm.

" + "smithy.api#documentation": "

The number of data points that must be breaching to trigger the alarm.

" } }, - "Period": { - "target": "com.amazonaws.cloudwatch#Period", + "Metrics": { + "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" + "smithy.api#documentation": "

An array of MetricDataQuery structures, used in an alarm based on a \n\t\t\tmetric math expression. Each structure either retrieves a \n\t\t\tmetric or performs a math expression.\n\t\t\t\n\t\t\tOne item in the Metrics array is the math expression that the alarm watches. \n\t\t\tThis expression by designated by having ReturnValue set to\n\t\t\ttrue.

" } }, - "EvaluationPeriods": { - "target": "com.amazonaws.cloudwatch#EvaluationPeriods", + "AlarmActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state \n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

" } }, - "StateReasonData": { - "target": "com.amazonaws.cloudwatch#StateReasonData", + "AlarmDescription": { + "target": "com.amazonaws.cloudwatch#AlarmDescription", "traits": { - "smithy.api#documentation": "

An explanation for the alarm state, in JSON format.

" + "smithy.api#documentation": "

The description of the alarm.

" } }, - "AlarmConfigurationUpdatedTimestamp": { - "target": "com.amazonaws.cloudwatch#Timestamp", + "Statistic": { + "target": "com.amazonaws.cloudwatch#Statistic", "traits": { - "smithy.api#documentation": "

The time stamp of the last update to the alarm configuration.

" + "smithy.api#documentation": "

The statistic for the metric associated with the alarm, other than percentile.\n\t\t For percentile statistics, use ExtendedStatistic.

" } }, - "StateReason": { - "target": "com.amazonaws.cloudwatch#StateReason", + "Unit": { + "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

An explanation for the alarm state, in text format.

" + "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" } }, - "AlarmArn": { - "target": "com.amazonaws.cloudwatch#AlarmArn", + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" + "smithy.api#documentation": "

The namespace of the metric associated with the alarm.

" } }, - "Dimensions": { - "target": "com.amazonaws.cloudwatch#Dimensions", + "OKActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The dimensions for the metric associated with the alarm.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

" } }, - "ActionsEnabled": { - "target": "com.amazonaws.cloudwatch#ActionsEnabled", + "StateReasonData": { + "target": "com.amazonaws.cloudwatch#StateReasonData", "traits": { - "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state.

" + "smithy.api#documentation": "

An explanation for the alarm state, in JSON format.

" } }, - "Namespace": { - "target": "com.amazonaws.cloudwatch#Namespace", + "InsufficientDataActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The namespace of the metric associated with the alarm.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state \n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

" } }, - "ExtendedStatistic": { - "target": "com.amazonaws.cloudwatch#ExtendedStatistic", + "ThresholdMetricId": { + "target": "com.amazonaws.cloudwatch#MetricId", "traits": { - "smithy.api#documentation": "

The percentile statistic for the metric associated with the alarm. Specify a value between\n\t\t\tp0.0 and p100.

" + "smithy.api#documentation": "

In an alarm based on an anomaly detection model, this is the ID of the \n\t\t\tANOMALY_DETECTION_BAND function \n\t\t\tused as the threshold for the alarm.

" } }, - "EvaluateLowSampleCountPercentile": { - "target": "com.amazonaws.cloudwatch#EvaluateLowSampleCountPercentile", + "StateValue": { + "target": "com.amazonaws.cloudwatch#StateValue", "traits": { - "smithy.api#documentation": "

Used only for alarms based on percentiles. If ignore, the alarm state does not change \n\t\t\tduring periods with too few data points to be statistically significant. If evaluate or this \n\t\t\tparameter is not used, the alarm is always evaluated and possibly changes state no matter \n\t\t\thow many data points are available.

" + "smithy.api#documentation": "

The state value for the alarm.

" } }, - "TreatMissingData": { - "target": "com.amazonaws.cloudwatch#TreatMissingData", + "ComparisonOperator": { + "target": "com.amazonaws.cloudwatch#ComparisonOperator", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

" + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified\n\t\t\tstatistic and threshold. The specified statistic value is used as the first operand.

" } }, "StateUpdatedTimestamp": { @@ -2826,46 +2820,52 @@ "smithy.api#documentation": "

The time stamp of the last update to the alarm state.

" } }, - "DatapointsToAlarm": { - "target": "com.amazonaws.cloudwatch#DatapointsToAlarm", + "Threshold": { + "target": "com.amazonaws.cloudwatch#Threshold", "traits": { - "smithy.api#documentation": "

The number of data points that must be breaching to trigger the alarm.

" + "smithy.api#documentation": "

The value to compare with the specified statistic.

" } }, - "Unit": { - "target": "com.amazonaws.cloudwatch#StandardUnit", + "AlarmName": { + "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" + "smithy.api#documentation": "

The name of the alarm.

" } }, - "ComparisonOperator": { - "target": "com.amazonaws.cloudwatch#ComparisonOperator", + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified\n\t\t\tstatistic and threshold. The specified statistic value is used as the first operand.

" + "smithy.api#documentation": "

The name of the metric associated with the alarm, if this is an alarm\n\t\tbased on a single metric.

" } }, - "Threshold": { - "target": "com.amazonaws.cloudwatch#Threshold", + "Period": { + "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The value to compare with the specified statistic.

" + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" } }, - "OKActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", + "StateReason": { + "target": "com.amazonaws.cloudwatch#StateReason", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

An explanation for the alarm state, in text format.

" } }, - "Metrics": { - "target": "com.amazonaws.cloudwatch#MetricDataQueries", + "EvaluationPeriods": { + "target": "com.amazonaws.cloudwatch#EvaluationPeriods", "traits": { - "smithy.api#documentation": "

An array of MetricDataQuery structures, used in an alarm based on a \n\t\t\tmetric math expression. Each structure either retrieves a \n\t\t\tmetric or performs a math expression.\n\t\t\t\n\t\t\tOne item in the Metrics array is the math expression that the alarm watches. \n\t\t\tThis expression by designated by having ReturnValue set to\n\t\t\ttrue.

" + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" } }, - "Statistic": { - "target": "com.amazonaws.cloudwatch#Statistic", + "AlarmConfigurationUpdatedTimestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The statistic for the metric associated with the alarm, other than percentile.\n\t\t For percentile statistics, use ExtendedStatistic.

" + "smithy.api#documentation": "

The time stamp of the last update to the alarm configuration.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.cloudwatch#Dimensions", + "traits": { + "smithy.api#documentation": "

The dimensions for the metric associated with the alarm.

" } } }, @@ -2894,22 +2894,22 @@ "com.amazonaws.cloudwatch#MetricDataQuery": { "type": "structure", "members": { - "Expression": { - "target": "com.amazonaws.cloudwatch#MetricExpression", + "MetricStat": { + "target": "com.amazonaws.cloudwatch#MetricStat", "traits": { - "smithy.api#documentation": "

The math expression to be performed on the returned data, if this object is performing a math expression. This expression\n\t\t\tcan use the Id of the other metrics to refer to those metrics, and can also use the Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" + "smithy.api#documentation": "

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric \n\t\t\tand not performing a math expression on returned data.

\n\t\t

Within one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" } }, - "Period": { - "target": "com.amazonaws.cloudwatch#Period", + "Label": { + "target": "com.amazonaws.cloudwatch#MetricLabel", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a \n\t\t\tperiod can be as short as one minute (60 seconds) and must be a multiple of 60. \n\t\t\tFor high-resolution metrics that are collected at intervals of less than one minute, \n\t\t\tthe period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics \n\t\t\tstored by a PutMetricData operation that includes a StorageResolution of 1 second.

" + "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.

" } }, - "ReturnData": { - "target": "com.amazonaws.cloudwatch#ReturnData", + "Expression": { + "target": "com.amazonaws.cloudwatch#MetricExpression", "traits": { - "smithy.api#documentation": "

When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tFalse. If you omit this, the default of True is\n\t\t\tused.

\n\t\t

When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all \n\t\tother metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

" + "smithy.api#documentation": "

The math expression to be performed on the returned data, if this object is performing a math expression. This expression\n\t\t\tcan use the Id of the other metrics to refer to those metrics, and can also use the Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" } }, "Id": { @@ -2919,16 +2919,16 @@ "smithy.api#required": {} } }, - "MetricStat": { - "target": "com.amazonaws.cloudwatch#MetricStat", + "ReturnData": { + "target": "com.amazonaws.cloudwatch#ReturnData", "traits": { - "smithy.api#documentation": "

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric \n\t\t\tand not performing a math expression on returned data.

\n\t\t

Within one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" + "smithy.api#documentation": "

When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tFalse. If you omit this, the default of True is\n\t\t\tused.

\n\t\t

When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all \n\t\tother metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

" } }, - "Label": { - "target": "com.amazonaws.cloudwatch#MetricLabel", + "Period": { + "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.

" + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a \n\t\t\tperiod can be as short as one minute (60 seconds) and must be a multiple of 60. \n\t\t\tFor high-resolution metrics that are collected at intervals of less than one minute, \n\t\t\tthe period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics \n\t\t\tstored by a PutMetricData operation that includes a StorageResolution of 1 second.

" } } }, @@ -2939,41 +2939,41 @@ "com.amazonaws.cloudwatch#MetricDataResult": { "type": "structure", "members": { - "StatusCode": { - "target": "com.amazonaws.cloudwatch#StatusCode", - "traits": { - "smithy.api#documentation": "

The status of the returned data. Complete indicates that all data points in the requested time range were returned. \n\t\t\tPartialData means that an incomplete set of data points were returned. \n\t\t\t\t\tYou can use the NextToken value that was returned and repeat your request to get more data points. \n\t\t\tNextToken is not returned if you are performing a math expression. InternalError \n\t\t\tindicates that an error occurred. Retry your request using NextToken, if present.

" - } - }, "Messages": { "target": "com.amazonaws.cloudwatch#MetricDataResultMessages", "traits": { "smithy.api#documentation": "

A list of messages with additional information about the data returned.

" } }, - "Timestamps": { - "target": "com.amazonaws.cloudwatch#Timestamps", - "traits": { - "smithy.api#documentation": "

The timestamps for the data points, formatted in Unix timestamp format. The number of\n\t\t\ttimestamps always matches the number of values and the value for Timestamps[x] is\n\t\t\tValues[x].

" - } - }, - "Id": { - "target": "com.amazonaws.cloudwatch#MetricId", - "traits": { - "smithy.api#documentation": "

The short name you specified to represent this metric.

" - } - }, "Label": { "target": "com.amazonaws.cloudwatch#MetricLabel", "traits": { "smithy.api#documentation": "

The human-readable label associated with the data.

" } }, + "StatusCode": { + "target": "com.amazonaws.cloudwatch#StatusCode", + "traits": { + "smithy.api#documentation": "

The status of the returned data. Complete indicates that all data points in the requested time range were returned. \n\t\t\tPartialData means that an incomplete set of data points were returned. \n\t\t\t\t\tYou can use the NextToken value that was returned and repeat your request to get more data points. \n\t\t\tNextToken is not returned if you are performing a math expression. InternalError \n\t\t\tindicates that an error occurred. Retry your request using NextToken, if present.

" + } + }, "Values": { "target": "com.amazonaws.cloudwatch#DatapointValues", "traits": { "smithy.api#documentation": "

The data points for the metric corresponding to Timestamps. The number of\n\t\t\tvalues always matches the number of timestamps and the timestamp for Values[x] is\n\t\t\tTimestamps[x].

" } + }, + "Id": { + "target": "com.amazonaws.cloudwatch#MetricId", + "traits": { + "smithy.api#documentation": "

The short name you specified to represent this metric.

" + } + }, + "Timestamps": { + "target": "com.amazonaws.cloudwatch#Timestamps", + "traits": { + "smithy.api#documentation": "

The timestamps for the data points, formatted in Unix timestamp format. The number of\n\t\t\ttimestamps always matches the number of values and the value for Timestamps[x] is\n\t\t\tValues[x].

" + } } }, "traits": { @@ -2995,10 +2995,10 @@ "com.amazonaws.cloudwatch#MetricDatum": { "type": "structure", "members": { - "Unit": { - "target": "com.amazonaws.cloudwatch#StandardUnit", + "Value": { + "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n\t\t

In \n\t\ta Get operation, this displays the unit that is used for the metric.

" + "smithy.api#documentation": "

The value for the metric.

\n\t\t

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.

" } }, "Values": { @@ -3007,16 +3007,16 @@ "smithy.api#documentation": "

Array of numbers representing the values for the metric during the period. Each unique value is listed just once\n\t\tin this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.\n\t\tYou can include up to 150 unique values in each PutMetricData action that specifies a Values array.

\n\t\t

Although the Values array accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

" } }, - "StorageResolution": { - "target": "com.amazonaws.cloudwatch#StorageResolution", + "Counts": { + "target": "com.amazonaws.cloudwatch#Counts", "traits": { - "smithy.api#documentation": "

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t

\n\t

This field is optional, if you do not specify it the default of 60 is used.

" + "smithy.api#documentation": "

Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis the number of times the corresponding value in the Values array occurred during the period.

\n\t\t

If you omit the Counts array, the default of 1 is used as the value for each count. If you\n\t\tinclude a Counts array, it must include the same amount of values as the Values array.

" } }, - "Dimensions": { - "target": "com.amazonaws.cloudwatch#Dimensions", + "Unit": { + "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

The dimensions associated with the metric.

" + "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n\t\t

In \n\t\ta Get operation, this displays the unit that is used for the metric.

" } }, "Timestamp": { @@ -3025,29 +3025,29 @@ "smithy.api#documentation": "

The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" } }, - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", + "Dimensions": { + "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { - "smithy.api#documentation": "

The name of the metric.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The dimensions associated with the metric.

" } }, - "StatisticValues": { - "target": "com.amazonaws.cloudwatch#StatisticSet", + "StorageResolution": { + "target": "com.amazonaws.cloudwatch#StorageResolution", "traits": { - "smithy.api#documentation": "

The statistical values for the metric.

" + "smithy.api#documentation": "

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t

\n\t

This field is optional, if you do not specify it the default of 60 is used.

" } }, - "Counts": { - "target": "com.amazonaws.cloudwatch#Counts", + "StatisticValues": { + "target": "com.amazonaws.cloudwatch#StatisticSet", "traits": { - "smithy.api#documentation": "

Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis the number of times the corresponding value in the Values array occurred during the period.

\n\t\t

If you omit the Counts array, the default of 1 is used as the value for each count. If you\n\t\tinclude a Counts array, it must include the same amount of values as the Values array.

" + "smithy.api#documentation": "

The statistical values for the metric.

" } }, - "Value": { - "target": "com.amazonaws.cloudwatch#DatapointValue", + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The value for the metric.

\n\t\t

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.

" + "smithy.api#documentation": "

The name of the metric.

", + "smithy.api#required": {} } } }, @@ -3088,17 +3088,17 @@ "com.amazonaws.cloudwatch#MetricStat": { "type": "structure", "members": { - "Metric": { - "target": "com.amazonaws.cloudwatch#Metric", + "Period": { + "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The metric to return, including the metric name, namespace, and dimensions.

", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t\t\t3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t\t ", "smithy.api#required": {} } }, - "Period": { - "target": "com.amazonaws.cloudwatch#Period", + "Metric": { + "target": "com.amazonaws.cloudwatch#Metric", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t\t\t3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t\t ", + "smithy.api#documentation": "

The metric to return, including the metric name, namespace, and dimensions.

", "smithy.api#required": {} } }, @@ -3167,22 +3167,16 @@ "com.amazonaws.cloudwatch#PartialFailure": { "type": "structure", "members": { - "ExceptionType": { - "target": "com.amazonaws.cloudwatch#ExceptionType", - "traits": { - "smithy.api#documentation": "

The type of error.

" - } - }, "FailureResource": { "target": "com.amazonaws.cloudwatch#FailureResource", "traits": { "smithy.api#documentation": "

The specified rule that could not be deleted.

" } }, - "FailureDescription": { - "target": "com.amazonaws.cloudwatch#FailureDescription", + "ExceptionType": { + "target": "com.amazonaws.cloudwatch#ExceptionType", "traits": { - "smithy.api#documentation": "

A description of the error.

" + "smithy.api#documentation": "

The type of error.

" } }, "FailureCode": { @@ -3190,6 +3184,12 @@ "traits": { "smithy.api#documentation": "

The code of the error.

" } + }, + "FailureDescription": { + "target": "com.amazonaws.cloudwatch#FailureDescription", + "traits": { + "smithy.api#documentation": "

A description of the error.

" + } } }, "traits": { @@ -3234,36 +3234,36 @@ "com.amazonaws.cloudwatch#PutAnomalyDetectorInput": { "type": "structure", "members": { - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", + "Stat": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", "traits": { - "smithy.api#documentation": "

The name of the metric to create the anomaly detection model for.

", + "smithy.api#documentation": "

The statistic to use for the metric and the anomaly detection model.

", "smithy.api#required": {} } }, - "Configuration": { - "target": "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.

\n\t\t

The configuration can also include the time zone to use for \n\t\t\tthe metric.

\n\t\t

You can in

" - } - }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "

The metric dimensions to create the anomaly detection model for.

" } }, - "Stat": { - "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The statistic to use for the metric and the anomaly detection model.

", + "smithy.api#documentation": "

The namespace of the metric to create the anomaly detection model for.

", "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.cloudwatch#Namespace", + "Configuration": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration", "traits": { - "smithy.api#documentation": "

The namespace of the metric to create the anomaly detection model for.

", + "smithy.api#documentation": "

The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.

\n\t\t

The configuration can also include the time zone to use for \n\t\t\tthe metric.

\n\t\t

You can in

" + } + }, + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric to create the anomaly detection model for.

", "smithy.api#required": {} } } @@ -3290,54 +3290,54 @@ "com.amazonaws.cloudwatch#PutCompositeAlarmInput": { "type": "structure", "members": { - "ActionsEnabled": { - "target": "com.amazonaws.cloudwatch#ActionsEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is \n\t\t\tTRUE.

" - } - }, - "AlarmRule": { - "target": "com.amazonaws.cloudwatch#AlarmRule", + "AlarmName": { + "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.

\n\t\t

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

\n\t\t

Functions can include the following:

\n\t\t \n\t\t

TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.

\n\t\t

Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.

\n\t\t

The following\n\t\t\tare some examples of AlarmRule:

\n\t\t \n\t\t

The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.

", + "smithy.api#documentation": "

The name for the composite alarm. This name must be unique within the Region.

", "smithy.api#required": {} } }, - "AlarmDescription": { - "target": "com.amazonaws.cloudwatch#AlarmDescription", - "traits": { - "smithy.api#documentation": "

The description for the composite alarm.

" - } - }, "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" } }, - "InsufficientDataActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", + "Tags": { + "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.

" } }, - "AlarmName": { - "target": "com.amazonaws.cloudwatch#AlarmName", + "AlarmRule": { + "target": "com.amazonaws.cloudwatch#AlarmRule", "traits": { - "smithy.api#documentation": "

The name for the composite alarm. This name must be unique within the Region.

", + "smithy.api#documentation": "

An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.

\n\t\t

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

\n\t\t

Functions can include the following:

\n\t\t \n\t\t

TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.

\n\t\t

Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.

\n\t\t

The following\n\t\t\tare some examples of AlarmRule:

\n\t\t \n\t\t

The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.

", "smithy.api#required": {} } }, "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" + } + }, + "AlarmDescription": { + "target": "com.amazonaws.cloudwatch#AlarmDescription", + "traits": { + "smithy.api#documentation": "

The description for the composite alarm.

" + } + }, + "ActionsEnabled": { + "target": "com.amazonaws.cloudwatch#ActionsEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is \n\t\t\tTRUE.

" } }, - "Tags": { - "target": "com.amazonaws.cloudwatch#TagList", + "InsufficientDataActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" } } } @@ -3365,17 +3365,17 @@ "com.amazonaws.cloudwatch#PutDashboardInput": { "type": "structure", "members": { - "DashboardBody": { - "target": "com.amazonaws.cloudwatch#DashboardBody", + "DashboardName": { + "target": "com.amazonaws.cloudwatch#DashboardName", "traits": { - "smithy.api#documentation": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.

\n\t\t

For more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.

", + "smithy.api#documentation": "

The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing\n\t\t\tits current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are \n\t\t\tA-Z, a-z, 0-9, \"-\", and \"_\". This parameter is required.

", "smithy.api#required": {} } }, - "DashboardName": { - "target": "com.amazonaws.cloudwatch#DashboardName", + "DashboardBody": { + "target": "com.amazonaws.cloudwatch#DashboardBody", "traits": { - "smithy.api#documentation": "

The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing\n\t\t\tits current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are \n\t\t\tA-Z, a-z, 0-9, \"-\", and \"_\". This parameter is required.

", + "smithy.api#documentation": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.

\n\t\t

For more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.

", "smithy.api#required": {} } } @@ -3418,12 +3418,6 @@ "com.amazonaws.cloudwatch#PutInsightRuleInput": { "type": "structure", "members": { - "RuleState": { - "target": "com.amazonaws.cloudwatch#InsightRuleState", - "traits": { - "smithy.api#documentation": "

The state of the rule. Valid values are ENABLED and DISABLED.

" - } - }, "RuleName": { "target": "com.amazonaws.cloudwatch#InsightRuleName", "traits": { @@ -3431,10 +3425,10 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.cloudwatch#TagList", + "RuleState": { + "target": "com.amazonaws.cloudwatch#InsightRuleState", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.

\n\t\t

To be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.

\n\t\t

If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.

" + "smithy.api#documentation": "

The state of the rule. Valid values are ENABLED and DISABLED.

" } }, "RuleDefinition": { @@ -3443,6 +3437,12 @@ "smithy.api#documentation": "

The definition of the rule, as a JSON object. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\tRule Syntax.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.cloudwatch#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.

\n\t\t

To be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.

\n\t\t

If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.

" + } } } }, @@ -3467,28 +3467,41 @@ "com.amazonaws.cloudwatch#PutMetricAlarmInput": { "type": "structure", "members": { - "Unit": { - "target": "com.amazonaws.cloudwatch#StandardUnit", + "DatapointsToAlarm": { + "target": "com.amazonaws.cloudwatch#DatapointsToAlarm", "traits": { - "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n\t\t

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n\t\t\t

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves predictably.

\n\t\t

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

" + "smithy.api#documentation": "

The number of data points that must be breaching to trigger the alarm. This is used only if you are setting \n\t\t\tan \"M out of N\" alarm. In that case, this value is the M. For more information, see \n\t\t\tEvaluating an Alarm in the\n\t\t\tAmazon CloudWatch User Guide.

" } }, - "Period": { - "target": "com.amazonaws.cloudwatch#Period", + "AlarmName": { + "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.

\n\t\t

\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod for each metric within the objects in the Metrics array.

\n\t\t

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

\n\t\t

An alarm's total current evaluation period can\n\t\tbe no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" + "smithy.api#documentation": "

The name for the alarm. This name must be unique within the Region.

", + "smithy.api#required": {} } }, - "ThresholdMetricId": { - "target": "com.amazonaws.cloudwatch#MetricId", + "Metrics": { + "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "

If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.

\n\t\t

For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.

\n\t\t

If your alarm uses this parameter, it cannot have Auto Scaling actions.

" + "smithy.api#documentation": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

Each item in the Metrics array either retrieves a metric or performs a math expression.

\n\t\t

One item in the Metrics array is the expression that the alarm watches. You designate this expression \n\t\t\tby setting ReturnValue to true for this object in the array. For more information, see MetricDataQuery.

\n\t\t

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe metrics you are using in your math expression as part of the Metrics array.

" } }, - "Threshold": { - "target": "com.amazonaws.cloudwatch#Threshold", + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

\n\t\t

This parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.

" + "smithy.api#documentation": "

The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the \n\t\t\tDimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall this information in the Metrics array.

" + } + }, + "Period": { + "target": "com.amazonaws.cloudwatch#Period", + "traits": { + "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.

\n\t\t

\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod for each metric within the objects in the Metrics array.

\n\t\t

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

\n\t\t

An alarm's total current evaluation period can\n\t\tbe no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" + } + }, + "AlarmActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", + "traits": { + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" } }, "ComparisonOperator": { @@ -3498,47 +3511,40 @@ "smithy.api#required": {} } }, - "EvaluateLowSampleCountPercentile": { - "target": "com.amazonaws.cloudwatch#EvaluateLowSampleCountPercentile", - "traits": { - "smithy.api#documentation": "

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

\n\t\t

Valid Values: evaluate | ignore\n

" - } - }, - "ExtendedStatistic": { - "target": "com.amazonaws.cloudwatch#ExtendedStatistic", + "ActionsEnabled": { + "target": "com.amazonaws.cloudwatch#ActionsEnabled", "traits": { - "smithy.api#documentation": "

The percentile statistic for the metric specified in MetricName. Specify a value \n\t\t\tbetween p0.0 and p100. When you call PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\t\tspecify either Statistic or ExtendedStatistic, but not both.

" + "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state. The default is \n\t\t\tTRUE.

" } }, - "DatapointsToAlarm": { - "target": "com.amazonaws.cloudwatch#DatapointsToAlarm", + "Tags": { + "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

The number of data points that must be breaching to trigger the alarm. This is used only if you are setting \n\t\t\tan \"M out of N\" alarm. In that case, this value is the M. For more information, see \n\t\t\tEvaluating an Alarm in the\n\t\t\tAmazon CloudWatch User Guide.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

" } }, - "TreatMissingData": { - "target": "com.amazonaws.cloudwatch#TreatMissingData", + "Threshold": { + "target": "com.amazonaws.cloudwatch#Threshold", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

" + "smithy.api#documentation": "

The value against which the specified statistic is compared.

\n\t\t

This parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.

" } }, - "Tags": { - "target": "com.amazonaws.cloudwatch#TagList", + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

" + "smithy.api#documentation": "

The namespace for the metric associated specified in MetricName.

" } }, - "AlarmName": { - "target": "com.amazonaws.cloudwatch#AlarmName", + "InsufficientDataActions": { + "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The name for the alarm. This name must be unique within the Region.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\t>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" } }, - "MetricName": { - "target": "com.amazonaws.cloudwatch#MetricName", + "TreatMissingData": { + "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the \n\t\t\tDimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall this information in the Metrics array.

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

" } }, "AlarmDescription": { @@ -3547,28 +3553,22 @@ "smithy.api#documentation": "

The description for the alarm.

" } }, - "ActionsEnabled": { - "target": "com.amazonaws.cloudwatch#ActionsEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state. The default is \n\t\t\tTRUE.

" - } - }, - "AlarmActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", + "Unit": { + "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" + "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n\t\t

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n\t\t\t

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves predictably.

\n\t\t

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

" } }, - "Dimensions": { - "target": "com.amazonaws.cloudwatch#Dimensions", + "Statistic": { + "target": "com.amazonaws.cloudwatch#Statistic", "traits": { - "smithy.api#documentation": "

The dimensions for the metric specified in MetricName.

" + "smithy.api#documentation": "

The statistic for the metric specified in MetricName, other than percentile.\n\t\t For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\tspecify either Statistic or ExtendedStatistic, but not both.

" } }, - "InsufficientDataActions": { - "target": "com.amazonaws.cloudwatch#ResourceList", + "ThresholdMetricId": { + "target": "com.amazonaws.cloudwatch#MetricId", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\t>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" + "smithy.api#documentation": "

If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.

\n\t\t

For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.

\n\t\t

If your alarm uses this parameter, it cannot have Auto Scaling actions.

" } }, "OKActions": { @@ -3577,12 +3577,6 @@ "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" } }, - "Namespace": { - "target": "com.amazonaws.cloudwatch#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace for the metric associated specified in MetricName.

" - } - }, "EvaluationPeriods": { "target": "com.amazonaws.cloudwatch#EvaluationPeriods", "traits": { @@ -3590,16 +3584,22 @@ "smithy.api#required": {} } }, - "Metrics": { - "target": "com.amazonaws.cloudwatch#MetricDataQueries", + "EvaluateLowSampleCountPercentile": { + "target": "com.amazonaws.cloudwatch#EvaluateLowSampleCountPercentile", "traits": { - "smithy.api#documentation": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

Each item in the Metrics array either retrieves a metric or performs a math expression.

\n\t\t

One item in the Metrics array is the expression that the alarm watches. You designate this expression \n\t\t\tby setting ReturnValue to true for this object in the array. For more information, see MetricDataQuery.

\n\t\t

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe metrics you are using in your math expression as part of the Metrics array.

" + "smithy.api#documentation": "

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

\n\t\t

Valid Values: evaluate | ignore\n

" } }, - "Statistic": { - "target": "com.amazonaws.cloudwatch#Statistic", + "Dimensions": { + "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { - "smithy.api#documentation": "

The statistic for the metric specified in MetricName, other than percentile.\n\t\t For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\tspecify either Statistic or ExtendedStatistic, but not both.

" + "smithy.api#documentation": "

The dimensions for the metric specified in MetricName.

" + } + }, + "ExtendedStatistic": { + "target": "com.amazonaws.cloudwatch#ExtendedStatistic", + "traits": { + "smithy.api#documentation": "

The percentile statistic for the metric specified in MetricName. Specify a value \n\t\t\tbetween p0.0 and p100. When you call PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\t\tspecify either Statistic or ExtendedStatistic, but not both.

" } } } @@ -3630,17 +3630,17 @@ "com.amazonaws.cloudwatch#PutMetricDataInput": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.cloudwatch#Namespace", + "MetricData": { + "target": "com.amazonaws.cloudwatch#MetricData", "traits": { - "smithy.api#documentation": "

The namespace for the metric data.

\n\t\t

To avoid conflicts\n\t\t\twith AWS service namespaces, you should not specify a namespace that begins with AWS/\n

", + "smithy.api#documentation": "

The data for the metric. The array can include no more than 20 metrics per call.

", "smithy.api#required": {} } }, - "MetricData": { - "target": "com.amazonaws.cloudwatch#MetricData", + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The data for the metric. The array can include no more than 20 metrics per call.

", + "smithy.api#documentation": "

The namespace for the metric data.

\n\t\t

To avoid conflicts\n\t\t\twith AWS service namespaces, you should not specify a namespace that begins with AWS/\n

", "smithy.api#required": {} } } @@ -3649,17 +3649,17 @@ "com.amazonaws.cloudwatch#Range": { "type": "structure", "members": { - "EndTime": { + "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", + "smithy.api#documentation": "

The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", "smithy.api#required": {} } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", + "smithy.api#documentation": "

The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.

", "smithy.api#required": {} } } @@ -3722,14 +3722,14 @@ "com.amazonaws.cloudwatch#ResourceNotFoundException": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.cloudwatch#ResourceId" + "Message": { + "target": "com.amazonaws.cloudwatch#FaultDescription" }, "ResourceType": { "target": "com.amazonaws.cloudwatch#ResourceType" }, - "Message": { - "target": "com.amazonaws.cloudwatch#FaultDescription" + "ResourceId": { + "target": "com.amazonaws.cloudwatch#ResourceId" } }, "traits": { @@ -3782,19 +3782,6 @@ "com.amazonaws.cloudwatch#SetAlarmStateInput": { "type": "structure", "members": { - "StateReason": { - "target": "com.amazonaws.cloudwatch#StateReason", - "traits": { - "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in text format.

", - "smithy.api#required": {} - } - }, - "StateReasonData": { - "target": "com.amazonaws.cloudwatch#StateReasonData", - "traits": { - "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in JSON format.

\n\t\t

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

" - } - }, "StateValue": { "target": "com.amazonaws.cloudwatch#StateValue", "traits": { @@ -3808,6 +3795,19 @@ "smithy.api#documentation": "

The name of the alarm.

", "smithy.api#required": {} } + }, + "StateReason": { + "target": "com.amazonaws.cloudwatch#StateReason", + "traits": { + "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in text format.

", + "smithy.api#required": {} + } + }, + "StateReasonData": { + "target": "com.amazonaws.cloudwatch#StateReasonData", + "traits": { + "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in JSON format.

\n\t\t

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

" + } } } }, @@ -3964,10 +3964,10 @@ "com.amazonaws.cloudwatch#StatisticSet": { "type": "structure", "members": { - "Minimum": { + "Sum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The minimum value of the sample set.

", + "smithy.api#documentation": "

The sum of values for the sample set.

", "smithy.api#required": {} } }, @@ -3978,17 +3978,17 @@ "smithy.api#required": {} } }, - "SampleCount": { + "Minimum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The number of samples used for the statistic set.

", + "smithy.api#documentation": "

The minimum value of the sample set.

", "smithy.api#required": {} } }, - "Sum": { + "SampleCount": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The sum of values for the sample set.

", + "smithy.api#documentation": "

The number of samples used for the statistic set.

", "smithy.api#required": {} } } @@ -4040,17 +4040,17 @@ "com.amazonaws.cloudwatch#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.cloudwatch#TagKey", + "Value": { + "target": "com.amazonaws.cloudwatch#TagValue", "traits": { - "smithy.api#documentation": "

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your \n\t\tresources.

", + "smithy.api#documentation": "

The value for the specified tag key.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.cloudwatch#TagValue", + "Key": { + "target": "com.amazonaws.cloudwatch#TagKey", "traits": { - "smithy.api#documentation": "

The value for the specified tag key.

", + "smithy.api#documentation": "

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your \n\t\tresources.

", "smithy.api#required": {} } } @@ -4191,17 +4191,17 @@ "com.amazonaws.cloudwatch#UntagResourceInput": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.cloudwatch#AmazonResourceName", + "TagKeys": { + "target": "com.amazonaws.cloudwatch#TagKeyList", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're removing tags from.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.cloudwatch#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", + "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're removing tags from.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json b/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json index 61fbb52ac0b5..19e1f4734965 100644 --- a/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json +++ b/codegen/sdk-codegen/aws-models/codeartifact.2018-09-22.json @@ -93,6 +93,12 @@ "com.amazonaws.codeartifact#AssetSummary": { "type": "structure", "members": { + "hashes": { + "target": "com.amazonaws.codeartifact#AssetHashes", + "traits": { + "smithy.api#documentation": "

\n The hashes of the asset.\n

" + } + }, "size": { "target": "com.amazonaws.codeartifact#LongOptional", "traits": { @@ -105,12 +111,6 @@ "smithy.api#documentation": "

\n The name of the asset.\n

", "smithy.api#required": {} } - }, - "hashes": { - "target": "com.amazonaws.codeartifact#AssetHashes", - "traits": { - "smithy.api#documentation": "

\n The hashes of the asset.\n

" - } } }, "traits": { @@ -166,11 +166,12 @@ "com.amazonaws.codeartifact#AssociateExternalConnectionRequest": { "type": "structure", "members": { - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" + "smithy.api#documentation": "

\n The name of the repository to which the external connection is added.\n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} } }, "domain": { @@ -181,12 +182,11 @@ "smithy.api#required": {} } }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The name of the repository to which the external connection is added.\n

", - "smithy.api#httpQuery": "repository", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" } }, "externalConnection": { @@ -329,7 +329,7 @@ "sdkId": "codeartifact", "arnNamespace": "codeartifact", "cloudFormationName": "Codeartifact", - "cloudTrailEventSource": "controlplane.codeartifact.amazonaws.com" + "cloudTrailEventSource": "codeartifact.amazonaws.com" }, "aws.auth#sigv4": { "name": "codeartifact" @@ -342,10 +342,10 @@ "com.amazonaws.codeartifact#ConflictException": { "type": "structure", "members": { - "resourceType": { - "target": "com.amazonaws.codeartifact#ResourceType", + "message": { + "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n The type of AWS resource.\n

" + "smithy.api#required": {} } }, "resourceId": { @@ -354,10 +354,10 @@ "smithy.api#documentation": "

\n The ID of the resource.\n

" } }, - "message": { - "target": "com.amazonaws.codeartifact#String", + "resourceType": { + "target": "com.amazonaws.codeartifact#ResourceType", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

\n The type of AWS resource.\n

" } } }, @@ -410,81 +410,81 @@ "com.amazonaws.codeartifact#CopyPackageVersionsRequest": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", + "versionRevisions": { + "target": "com.amazonaws.codeartifact#PackageVersionRevisionMap", "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the source and destination repositories.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} + "smithy.api#documentation": "

\n A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation\n succeeds if the specified versions in the source repository match the specified package version revision.\n

\n \n

\n You must specify versions or versionRevisions. You cannot specify both.\n

\n " } }, - "sourceRepository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

\n The name of the repository that contains the package versions to copy.\n

", - "smithy.api#httpQuery": "source-repository", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The name of the package that is copied.\n

", - "smithy.api#httpQuery": "package", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" } }, - "includeFromUpstream": { + "allowOverwrite": { "target": "com.amazonaws.codeartifact#BooleanOptional", "traits": { - "smithy.api#documentation": "

Set to true to copy packages from repositories that are upstream from the source\n repository to the destination repository. The default setting is false. For more information,\n see Working with\n upstream repositories.

" + "smithy.api#documentation": "

\n Set to true to overwrite a package version that already exists in the destination repository.\n If set to false and the package version already exists in the destination repository,\n the package version is returned in the failedVersions field of the response with \n an ALREADY_EXISTS error code.\n

" } }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" + "smithy.api#documentation": "

\n The format of the package that is copied. The valid package types are:\n

\n ", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} } }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", + "versions": { + "target": "com.amazonaws.codeartifact#PackageVersionList", "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" + "smithy.api#documentation": "

\n The versions of the package to copy.\n

\n \n

\n You must specify versions or versionRevisions. You cannot specify both.\n

\n " } }, - "allowOverwrite": { + "includeFromUpstream": { "target": "com.amazonaws.codeartifact#BooleanOptional", "traits": { - "smithy.api#documentation": "

\n Set to true to overwrite a package version that already exists in the destination repository.\n If set to false and the package version already exists in the destination repository,\n the package version is returned in the failedVersions field of the response with \n an ALREADY_EXISTS error code.\n

" + "smithy.api#documentation": "

Set to true to copy packages from repositories that are upstream from the source\n repository to the destination repository. The default setting is false. For more information,\n see Working with\n upstream repositories.

" } }, - "destinationRepository": { + "sourceRepository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The name of the repository into which package versions are copied.\n

", - "smithy.api#httpQuery": "destination-repository", + "smithy.api#documentation": "

\n The name of the repository that contains the package versions to copy.\n

", + "smithy.api#httpQuery": "source-repository", "smithy.api#required": {} } }, - "versions": { - "target": "com.amazonaws.codeartifact#PackageVersionList", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The versions of the package to copy.\n

\n \n

\n You must specify versions or versionRevisions. You cannot specify both.\n

\n " + "smithy.api#documentation": "

\n The name of the package that is copied.\n

", + "smithy.api#httpQuery": "package", + "smithy.api#required": {} } }, - "versionRevisions": { - "target": "com.amazonaws.codeartifact#PackageVersionRevisionMap", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation\n succeeds if the specified versions in the source repository match the specified package version revision.\n

\n \n

\n You must specify versions or versionRevisions. You cannot specify both.\n

\n " + "smithy.api#documentation": "

\n The name of the domain that contains the source and destination repositories.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} } }, - "format": { - "target": "com.amazonaws.codeartifact#PackageFormat", + "destinationRepository": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The format of the package that is copied. The valid package types are:\n

\n ", - "smithy.api#httpQuery": "format", + "smithy.api#documentation": "

\n The name of the repository into which package versions are copied.\n

", + "smithy.api#httpQuery": "destination-repository", "smithy.api#required": {} } } @@ -550,6 +550,12 @@ "com.amazonaws.codeartifact#CreateDomainRequest": { "type": "structure", "members": { + "encryptionKey": { + "target": "com.amazonaws.codeartifact#Arn", + "traits": { + "smithy.api#documentation": "

The encryption key for the domain. This is used to encrypt content stored in a domain.\n An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key\n alias ARN. To specify an encryptionKey, your IAM role must have\n kms:DescribeKey and kms:CreateGrant permissions on the encryption\n key that is used. For more information, see DescribeKey in the AWS Key Management Service API Reference\n and AWS KMS API Permissions\n Reference in the AWS Key Management Service Developer Guide.

\n \n

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your\n domain. For more information, see Using symmetric and asymmetric\n keys in the AWS Key Management Service Developer Guide.

\n " + } + }, "domain": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { @@ -557,12 +563,6 @@ "smithy.api#httpQuery": "domain", "smithy.api#required": {} } - }, - "encryptionKey": { - "target": "com.amazonaws.codeartifact#Arn", - "traits": { - "smithy.api#documentation": "

The encryption key for the domain. This is used to encrypt content stored in a domain.\n An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key\n alias ARN. To specify an encryptionKey, your IAM role must have\n kms:DescribeKey and kms:CreateGrant permissions on the encryption\n key that is used. For more information, see DescribeKey in the AWS Key Management Service API Reference\n and AWS KMS API Permissions\n Reference in the AWS Key Management Service Developer Guide.

\n \n

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your\n domain. For more information, see Using symmetric and asymmetric\n keys in the AWS Key Management Service Developer Guide.

\n " - } } } }, @@ -620,11 +620,11 @@ "com.amazonaws.codeartifact#CreateRepositoryRequest": { "type": "structure", "members": { - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

The name of the repository to create.

", - "smithy.api#httpQuery": "repository", + "smithy.api#documentation": "

\n The domain that contains the created repository.\n

", + "smithy.api#httpQuery": "domain", "smithy.api#required": {} } }, @@ -634,14 +634,6 @@ "smithy.api#documentation": "

\n A description of the created repository.\n

" } }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", - "traits": { - "smithy.api#documentation": "

\n The domain that contains the created repository.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} - } - }, "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { @@ -649,6 +641,14 @@ "smithy.api#httpQuery": "domain-owner" } }, + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to create.

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} + } + }, "upstreams": { "target": "com.amazonaws.codeartifact#UpstreamRepositoryList", "traits": { @@ -752,6 +752,13 @@ "smithy.api#httpQuery": "domain-owner" } }, + "policyRevision": { + "target": "com.amazonaws.codeartifact#PolicyRevision", + "traits": { + "smithy.api#documentation": "

\n The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which\n prevents others from overwriting your changes to the domain's resource policy.\n

", + "smithy.api#httpQuery": "policy-revision" + } + }, "domain": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { @@ -759,13 +766,6 @@ "smithy.api#httpQuery": "domain", "smithy.api#required": {} } - }, - "policyRevision": { - "target": "com.amazonaws.codeartifact#PolicyRevision", - "traits": { - "smithy.api#documentation": "

\n The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which\n prevents others from overwriting your changes to the domain's resource policy.\n

", - "smithy.api#httpQuery": "policy-revision" - } } } }, @@ -783,13 +783,6 @@ "com.amazonaws.codeartifact#DeleteDomainRequest": { "type": "structure", "members": { - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", - "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" - } - }, "domain": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { @@ -797,6 +790,13 @@ "smithy.api#httpQuery": "domain", "smithy.api#required": {} } + }, + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" + } } } }, @@ -851,20 +851,11 @@ "com.amazonaws.codeartifact#DeletePackageVersionsRequest": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", - "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the package to delete.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} - } - }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

\n The name of the repository that contains the package versions to delete.\n

", - "smithy.api#httpQuery": "repository", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" } }, "format": { @@ -882,11 +873,28 @@ "smithy.api#httpQuery": "domain-owner" } }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" + "smithy.api#documentation": "

\n The name of the repository that contains the package versions to delete.\n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} + } + }, + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", + "traits": { + "smithy.api#documentation": "

\n The name of the domain that contains the package to delete.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, + "package": { + "target": "com.amazonaws.codeartifact#PackageName", + "traits": { + "smithy.api#documentation": "

\n The name of the package with the versions to delete.\n

", + "smithy.api#httpQuery": "package", + "smithy.api#required": {} } }, "expectedStatus": { @@ -901,31 +909,23 @@ "smithy.api#documentation": "

\n An array of strings that specify the versions of the package to delete.\n

", "smithy.api#required": {} } - }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", - "traits": { - "smithy.api#documentation": "

\n The name of the package with the versions to delete.\n

", - "smithy.api#httpQuery": "package", - "smithy.api#required": {} - } } } }, "com.amazonaws.codeartifact#DeletePackageVersionsResult": { "type": "structure", "members": { - "failedVersions": { - "target": "com.amazonaws.codeartifact#PackageVersionErrorMap", - "traits": { - "smithy.api#documentation": "

\n A PackageVersionError object that contains a map of errors codes for the \n deleted package that failed. The possible error codes are:\n

\n " - } - }, "successfulVersions": { "target": "com.amazonaws.codeartifact#SuccessfulPackageVersionInfoMap", "traits": { "smithy.api#documentation": "

\n A list of the package versions that were successfully deleted.\n

" } + }, + "failedVersions": { + "target": "com.amazonaws.codeartifact#PackageVersionErrorMap", + "traits": { + "smithy.api#documentation": "

\n A PackageVersionError object that contains a map of errors codes for the \n deleted package that failed. The possible error codes are:\n

\n " + } } } }, @@ -1006,13 +1006,6 @@ "com.amazonaws.codeartifact#DeleteRepositoryPermissionsPolicyRequest": { "type": "structure", "members": { - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", - "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" - } - }, "repository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { @@ -1021,7 +1014,14 @@ "smithy.api#required": {} } }, - "policyRevision": { + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" + } + }, + "policyRevision": { "target": "com.amazonaws.codeartifact#PolicyRevision", "traits": { "smithy.api#documentation": "

\n The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which\n prevents others from accidentally overwriting your changes to the repository's resource policy.\n

", @@ -1052,6 +1052,14 @@ "com.amazonaws.codeartifact#DeleteRepositoryRequest": { "type": "structure", "members": { + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", + "traits": { + "smithy.api#documentation": "

\n The name of the domain that contains the repository to delete.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, "repository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { @@ -1066,14 +1074,6 @@ "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } - }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", - "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the repository to delete.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} - } } } }, @@ -1190,14 +1190,21 @@ "com.amazonaws.codeartifact#DescribePackageVersionRequest": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", + "packageVersion": { + "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the repository that contains the package version.\n

", - "smithy.api#httpQuery": "domain", + "smithy.api#documentation": "

\n A string that contains the package version (for example, 3.5.2).\n

", + "smithy.api#httpQuery": "version", "smithy.api#required": {} } }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" + } + }, "package": { "target": "com.amazonaws.codeartifact#PackageName", "traits": { @@ -1206,6 +1213,14 @@ "smithy.api#required": {} } }, + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", + "traits": { + "smithy.api#documentation": "

\n The name of the domain that contains the repository that contains the package version.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, "repository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { @@ -1214,20 +1229,6 @@ "smithy.api#required": {} } }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", - "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" - } - }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", - "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" - } - }, "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { @@ -1236,12 +1237,11 @@ "smithy.api#required": {} } }, - "packageVersion": { - "target": "com.amazonaws.codeartifact#PackageVersion", + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n A string that contains the package version (for example, 3.5.2).\n

", - "smithy.api#httpQuery": "version", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" } } } @@ -1384,6 +1384,14 @@ "com.amazonaws.codeartifact#DisassociateExternalConnectionRequest": { "type": "structure", "members": { + "externalConnection": { + "target": "com.amazonaws.codeartifact#ExternalConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the external connection to be removed from the repository.

", + "smithy.api#httpQuery": "external-connection", + "smithy.api#required": {} + } + }, "repository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { @@ -1399,14 +1407,6 @@ "smithy.api#httpQuery": "domain-owner" } }, - "externalConnection": { - "target": "com.amazonaws.codeartifact#ExternalConnectionName", - "traits": { - "smithy.api#documentation": "

The name of the external connection to be removed from the repository.

", - "smithy.api#httpQuery": "external-connection", - "smithy.api#required": {} - } - }, "domain": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { @@ -1468,11 +1468,20 @@ "com.amazonaws.codeartifact#DisposePackageVersionsRequest": { "type": "structure", "members": { - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" + "smithy.api#documentation": "

\n The name of the domain that contains the repository you want to dispose.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "

\n The name of the repository that contains the package versions you want to dispose.\n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} } }, "format": { @@ -1483,6 +1492,13 @@ "smithy.api#required": {} } }, + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" + } + }, "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { @@ -1490,25 +1506,17 @@ "smithy.api#httpQuery": "namespace" } }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", - "traits": { - "smithy.api#documentation": "

\n The name of the repository that contains the package versions you want to dispose.\n

", - "smithy.api#httpQuery": "repository", - "smithy.api#required": {} - } - }, "versionRevisions": { "target": "com.amazonaws.codeartifact#PackageVersionRevisionMap", "traits": { "smithy.api#documentation": "

\n The revisions of the package versions you want to dispose.\n

" } }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the repository you want to dispose.\n

", - "smithy.api#httpQuery": "domain", + "smithy.api#documentation": "

\n The name of the package with the versions you want to dispose.\n

", + "smithy.api#httpQuery": "package", "smithy.api#required": {} } }, @@ -1524,47 +1532,45 @@ "traits": { "smithy.api#documentation": "

\n The expected status of the package version to dispose. Valid values are:\n

\n " } - }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", - "traits": { - "smithy.api#documentation": "

\n The name of the package with the versions you want to dispose.\n

", - "smithy.api#httpQuery": "package", - "smithy.api#required": {} - } } } }, "com.amazonaws.codeartifact#DisposePackageVersionsResult": { "type": "structure", "members": { - "successfulVersions": { - "target": "com.amazonaws.codeartifact#SuccessfulPackageVersionInfoMap", - "traits": { - "smithy.api#documentation": "

\n A list of the package versions that were successfully disposed.\n

" - } - }, "failedVersions": { "target": "com.amazonaws.codeartifact#PackageVersionErrorMap", "traits": { "smithy.api#documentation": "

\n A PackageVersionError object that contains a map of errors codes for the \n disposed package versions that failed. The possible error codes are:\n

\n " } + }, + "successfulVersions": { + "target": "com.amazonaws.codeartifact#SuccessfulPackageVersionInfoMap", + "traits": { + "smithy.api#documentation": "

\n A list of the package versions that were successfully disposed.\n

" + } } } }, "com.amazonaws.codeartifact#DomainDescription": { "type": "structure", "members": { - "arn": { + "status": { + "target": "com.amazonaws.codeartifact#DomainStatus", + "traits": { + "smithy.api#documentation": "

The current status of a domain. The valid values are

\n " + } + }, + "encryptionKey": { "target": "com.amazonaws.codeartifact#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain.

" + "smithy.api#documentation": "

The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.

" } }, - "assetSizeBytes": { - "target": "com.amazonaws.codeartifact#Long", + "repositoryCount": { + "target": "com.amazonaws.codeartifact#Integer", "traits": { - "smithy.api#documentation": "

\n The total size of all assets in the domain.\n

" + "smithy.api#documentation": "

\n The number of repositories in the domain.\n

" } }, "owner": { @@ -1573,22 +1579,22 @@ "smithy.api#documentation": "

The AWS account ID that owns the domain.

" } }, - "repositoryCount": { - "target": "com.amazonaws.codeartifact#Integer", + "assetSizeBytes": { + "target": "com.amazonaws.codeartifact#Long", "traits": { - "smithy.api#documentation": "

\n The number of repositories in the domain.\n

" + "smithy.api#documentation": "

\n The total size of all assets in the domain.\n

" } }, - "status": { - "target": "com.amazonaws.codeartifact#DomainStatus", + "createdTime": { + "target": "com.amazonaws.codeartifact#Timestamp", "traits": { - "smithy.api#documentation": "

The current status of a domain. The valid values are

\n " + "smithy.api#documentation": "

\n A timestamp that represents the date and time the domain was created.\n

" } }, - "encryptionKey": { + "arn": { "target": "com.amazonaws.codeartifact#Arn", "traits": { - "smithy.api#documentation": "

The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain.

" } }, "name": { @@ -1596,12 +1602,6 @@ "traits": { "smithy.api#documentation": "

\n The name of the domain.\n

" } - }, - "createdTime": { - "target": "com.amazonaws.codeartifact#Timestamp", - "traits": { - "smithy.api#documentation": "

\n A timestamp that represents the date and time the domain was created.\n

" - } } }, "traits": { @@ -1636,16 +1636,10 @@ "com.amazonaws.codeartifact#DomainSummary": { "type": "structure", "members": { - "encryptionKey": { + "arn": { "target": "com.amazonaws.codeartifact#Arn", "traits": { - "smithy.api#documentation": "

\n The key used to encrypt the domain.\n

" - } - }, - "status": { - "target": "com.amazonaws.codeartifact#DomainStatus", - "traits": { - "smithy.api#documentation": "

\n A string that contains the status of the domain. The valid values are: \n

\n " + "smithy.api#documentation": "

\n The ARN of the domain.\n

" } }, "name": { @@ -1654,10 +1648,16 @@ "smithy.api#documentation": "

\n The name of the domain.\n

" } }, - "arn": { - "target": "com.amazonaws.codeartifact#Arn", + "status": { + "target": "com.amazonaws.codeartifact#DomainStatus", "traits": { - "smithy.api#documentation": "

\n The ARN of the domain.\n

" + "smithy.api#documentation": "

\n A string that contains the status of the domain. The valid values are: \n

\n " + } + }, + "owner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

" } }, "createdTime": { @@ -1666,10 +1666,10 @@ "smithy.api#documentation": "

\n A timestamp that contains the date and time the domain was created.\n

" } }, - "owner": { - "target": "com.amazonaws.codeartifact#AccountId", + "encryptionKey": { + "target": "com.amazonaws.codeartifact#Arn", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

" + "smithy.api#documentation": "

\n The key used to encrypt the domain.\n

" } } }, @@ -1740,6 +1740,14 @@ "com.amazonaws.codeartifact#GetAuthorizationTokenRequest": { "type": "structure", "members": { + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", + "traits": { + "smithy.api#documentation": "

\n The name of the domain that is in scope for the generated authorization token.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { @@ -1753,31 +1761,23 @@ "smithy.api#documentation": "

The time, in seconds, that the generated authorization token is valid.

", "smithy.api#httpQuery": "duration" } - }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", - "traits": { - "smithy.api#documentation": "

\n The name of the domain that is in scope for the generated authorization token.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} - } } } }, "com.amazonaws.codeartifact#GetAuthorizationTokenResult": { "type": "structure", "members": { - "expiration": { - "target": "com.amazonaws.codeartifact#Timestamp", - "traits": { - "smithy.api#documentation": "

\n A timestamp that specifies the date and time the authorization token expires.\n

" - } - }, "authorizationToken": { "target": "com.amazonaws.codeartifact#String", "traits": { "smithy.api#documentation": "

\n The returned authentication token.\n

" } + }, + "expiration": { + "target": "com.amazonaws.codeartifact#Timestamp", + "traits": { + "smithy.api#documentation": "

\n A timestamp that specifies the date and time the authorization token expires.\n

" + } } } }, @@ -1883,6 +1883,21 @@ "com.amazonaws.codeartifact#GetPackageVersionAssetRequest": { "type": "structure", "members": { + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", + "traits": { + "smithy.api#documentation": "

\n A format that specifies the type of the package version with the requested asset file. The valid values are:\n

\n ", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "packageVersionRevision": { + "target": "com.amazonaws.codeartifact#PackageVersionRevision", + "traits": { + "smithy.api#documentation": "

\n The name of the package version revision that contains the requested asset.\n

", + "smithy.api#httpQuery": "revision" + } + }, "packageVersion": { "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { @@ -1899,29 +1914,6 @@ "smithy.api#required": {} } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", - "traits": { - "smithy.api#documentation": "

\n The name of the package that contains the requested asset.\n

", - "smithy.api#httpQuery": "package", - "smithy.api#required": {} - } - }, - "packageVersionRevision": { - "target": "com.amazonaws.codeartifact#PackageVersionRevision", - "traits": { - "smithy.api#documentation": "

\n The name of the package version revision that contains the requested asset.\n

", - "smithy.api#httpQuery": "revision" - } - }, - "format": { - "target": "com.amazonaws.codeartifact#PackageFormat", - "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of the package version with the requested asset file. The valid values are:\n

\n ", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - }, "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { @@ -1929,11 +1921,12 @@ "smithy.api#httpQuery": "domain-owner" } }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" + "smithy.api#documentation": "

\n The name of the package that contains the requested asset.\n

", + "smithy.api#httpQuery": "package", + "smithy.api#required": {} } }, "asset": { @@ -1951,6 +1944,13 @@ "smithy.api#httpQuery": "repository", "smithy.api#required": {} } + }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" + } } } }, @@ -1964,6 +1964,13 @@ "smithy.api#httpHeader": "X-PackageVersionRevision" } }, + "assetName": { + "target": "com.amazonaws.codeartifact#AssetName", + "traits": { + "smithy.api#documentation": "

\n The name of the asset that is downloaded.\n

", + "smithy.api#httpHeader": "X-AssetName" + } + }, "packageVersion": { "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { @@ -1977,13 +1984,6 @@ "smithy.api#documentation": "

The binary file, or asset, that is downloaded.

", "smithy.api#httpPayload": {} } - }, - "assetName": { - "target": "com.amazonaws.codeartifact#AssetName", - "traits": { - "smithy.api#documentation": "

\n The name of the asset that is downloaded.\n

", - "smithy.api#httpHeader": "X-AssetName" - } } } }, @@ -2024,14 +2024,21 @@ "com.amazonaws.codeartifact#GetPackageVersionReadmeRequest": { "type": "structure", "members": { - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "packageVersion": { + "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { - "smithy.api#documentation": "

\n The name of the package version that contains the requested readme file.\n

", - "smithy.api#httpQuery": "package", + "smithy.api#documentation": "

\n A string that contains the package version (for example, 3.5.2).\n

", + "smithy.api#httpQuery": "version", "smithy.api#required": {} } }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" + } + }, "repository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { @@ -2040,28 +2047,14 @@ "smithy.api#required": {} } }, - "packageVersion": { - "target": "com.amazonaws.codeartifact#PackageVersion", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n A string that contains the package version (for example, 3.5.2).\n

", - "smithy.api#httpQuery": "version", + "smithy.api#documentation": "

\n The name of the package version that contains the requested readme file.\n

", + "smithy.api#httpQuery": "package", "smithy.api#required": {} } }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", - "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" - } - }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", - "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" - } - }, "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { @@ -2077,16 +2070,23 @@ "smithy.api#httpQuery": "domain", "smithy.api#required": {} } + }, + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" + } } } }, "com.amazonaws.codeartifact#GetPackageVersionReadmeResult": { "type": "structure", "members": { - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n " + "smithy.api#documentation": "

\n The name of the package that contains the returned readme file.\n

" } }, "readme": { @@ -2095,10 +2095,10 @@ "smithy.api#documentation": "

\n The text of the returned readme file.\n

" } }, - "versionRevision": { - "target": "com.amazonaws.codeartifact#PackageVersionRevision", + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

\n The current revision associated with the package version.\n

" + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n " } }, "format": { @@ -2107,10 +2107,10 @@ "smithy.api#documentation": "

\n The format of the package with the requested readme file. Valid format types are:\n

\n " } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "versionRevision": { + "target": "com.amazonaws.codeartifact#PackageVersionRevision", "traits": { - "smithy.api#documentation": "

\n The name of the package that contains the returned readme file.\n

" + "smithy.api#documentation": "

\n The current revision associated with the package version.\n

" } }, "version": { @@ -2158,6 +2158,14 @@ "com.amazonaws.codeartifact#GetRepositoryEndpointRequest": { "type": "structure", "members": { + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "

\n The name of the repository.\n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} + } + }, "domain": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { @@ -2180,14 +2188,6 @@ "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } - }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", - "traits": { - "smithy.api#documentation": "

\n The name of the repository.\n

", - "smithy.api#httpQuery": "repository", - "smithy.api#required": {} - } } } }, @@ -2239,11 +2239,12 @@ "com.amazonaws.codeartifact#GetRepositoryPermissionsPolicyRequest": { "type": "structure", "members": { - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" + "smithy.api#documentation": "

\n The name of the repository whose associated resource policy is to be retrieved.\n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} } }, "domain": { @@ -2254,12 +2255,11 @@ "smithy.api#required": {} } }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The name of the repository whose associated resource policy is to be retrieved.\n

", - "smithy.api#httpQuery": "repository", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" } } } @@ -2330,16 +2330,16 @@ "com.amazonaws.codeartifact#LicenseInfo": { "type": "structure", "members": { - "url": { + "name": { "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n The URL for license data.\n

" + "smithy.api#documentation": "

\n Name of the license.\n

" } }, - "name": { + "url": { "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n Name of the license.\n

" + "smithy.api#documentation": "

\n The URL for license data.\n

" } } }, @@ -2419,17 +2419,17 @@ "com.amazonaws.codeartifact#ListDomainsResult": { "type": "structure", "members": { - "domains": { - "target": "com.amazonaws.codeartifact#DomainSummaryList", - "traits": { - "smithy.api#documentation": "

\n The returned list of \n DomainSummary\n objects.\n

" - } - }, "nextToken": { "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

" } + }, + "domains": { + "target": "com.amazonaws.codeartifact#DomainSummaryList", + "traits": { + "smithy.api#documentation": "

\n The returned list of \n DomainSummary\n objects.\n

" + } } } }, @@ -2485,19 +2485,11 @@ "com.amazonaws.codeartifact#ListPackageVersionAssetsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", - "traits": { - "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", - "smithy.api#httpQuery": "next-token" - } - }, - "packageVersion": { - "target": "com.amazonaws.codeartifact#PackageVersion", + "maxResults": { + "target": "com.amazonaws.codeartifact#ListPackageVersionAssetsMaxResults", "traits": { - "smithy.api#documentation": "

\n A string that contains the package version (for example, 3.5.2).\n

", - "smithy.api#httpQuery": "version", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

", + "smithy.api#httpQuery": "max-results" } }, "domain": { @@ -2508,6 +2500,14 @@ "smithy.api#required": {} } }, + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "

\n The name of the repository that contains the package that contains the returned package version assets.\n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} + } + }, "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { @@ -2515,6 +2515,13 @@ "smithy.api#httpQuery": "domain-owner" } }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" + } + }, "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { @@ -2523,51 +2530,38 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.codeartifact#ListPackageVersionAssetsMaxResults", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "next-token" } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "packageVersion": { + "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { - "smithy.api#documentation": "

\n The name of the package that contains the returned package version assets.\n

", - "smithy.api#httpQuery": "package", + "smithy.api#documentation": "

\n A string that contains the package version (for example, 3.5.2).\n

", + "smithy.api#httpQuery": "version", "smithy.api#required": {} } }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The name of the repository that contains the package that contains the returned package version assets.\n

", - "smithy.api#httpQuery": "repository", + "smithy.api#documentation": "

\n The name of the package that contains the returned package version assets.\n

", + "smithy.api#httpQuery": "package", "smithy.api#required": {} } - }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", - "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" - } } } }, "com.amazonaws.codeartifact#ListPackageVersionAssetsResult": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.codeartifact#PackageVersion", - "traits": { - "smithy.api#documentation": "

\n The version of the package associated with the returned assets.\n

" - } - }, - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n " } }, "assets": { @@ -2576,10 +2570,16 @@ "smithy.api#documentation": "

\n The returned list of \n AssetSummary\n objects.\n

" } }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", + "version": { + "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n " + "smithy.api#documentation": "

\n The version of the package associated with the returned assets.\n

" + } + }, + "package": { + "target": "com.amazonaws.codeartifact#PackageName", + "traits": { + "smithy.api#documentation": "

\n The name of the package that contains the returned package version assets.\n

" } }, "format": { @@ -2588,16 +2588,16 @@ "smithy.api#documentation": "

\n The format of the package that contains the returned package version assets.\n

" } }, - "versionRevision": { - "target": "com.amazonaws.codeartifact#PackageVersionRevision", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

\n The current revision associated with the package version.\n

" + "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "versionRevision": { + "target": "com.amazonaws.codeartifact#PackageVersionRevision", "traits": { - "smithy.api#documentation": "

\n The name of the package that contains the returned package version assets.\n

" + "smithy.api#documentation": "

\n The current revision associated with the package version.\n

" } } } @@ -2639,22 +2639,35 @@ "com.amazonaws.codeartifact#ListPackageVersionDependenciesRequest": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

\n The domain that contains the repository that contains the requested package version dependencies.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "next-token" } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The name of the package versions' package.\n

", - "smithy.api#httpQuery": "package", + "smithy.api#documentation": "

\n The format of the package with the requested dependencies. The valid package types are:\n

\n ", + "smithy.api#httpQuery": "format", "smithy.api#required": {} } }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" + } + }, + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" + } + }, "packageVersion": { "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { @@ -2663,25 +2676,19 @@ "smithy.api#required": {} } }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", - "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" - } - }, - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

\n The name of the package versions' package.\n

", + "smithy.api#httpQuery": "package", + "smithy.api#required": {} } }, - "format": { - "target": "com.amazonaws.codeartifact#PackageFormat", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n The format of the package with the requested dependencies. The valid package types are:\n

\n ", - "smithy.api#httpQuery": "format", + "smithy.api#documentation": "

\n The domain that contains the repository that contains the requested package version dependencies.\n

", + "smithy.api#httpQuery": "domain", "smithy.api#required": {} } }, @@ -2692,35 +2699,16 @@ "smithy.api#httpQuery": "repository", "smithy.api#required": {} } - }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", - "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" - } } } }, "com.amazonaws.codeartifact#ListPackageVersionDependenciesResult": { "type": "structure", "members": { - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", - "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n " - } - }, - "format": { - "target": "com.amazonaws.codeartifact#PackageFormat", - "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of the package that contains the returned dependencies. The valid values are:\n

\n " - } - }, - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

" + "smithy.api#documentation": "

\n The name of the package that contains the returned package versions dependencies.\n

" } }, "dependencies": { @@ -2729,23 +2717,35 @@ "smithy.api#documentation": "

\n The returned list of \n PackageDependency\n objects.\n

" } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", - "traits": { - "smithy.api#documentation": "

\n The name of the package that contains the returned package versions dependencies.\n

" - } - }, "version": { "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { "smithy.api#documentation": "

\n The version of the package that is specified in the request.\n

" } }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n " + } + }, "versionRevision": { "target": "com.amazonaws.codeartifact#PackageVersionRevision", "traits": { "smithy.api#documentation": "

\n The current revision associated with the package version.\n

" } + }, + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", + "traits": { + "smithy.api#documentation": "

\n A format that specifies the type of the package that contains the returned dependencies. The valid values are:\n

\n " + } + }, + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

" + } } } }, @@ -2801,64 +2801,57 @@ "com.amazonaws.codeartifact#ListPackageVersionsRequest": { "type": "structure", "members": { - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The name of the repository that contains the package.\n

", - "smithy.api#httpQuery": "repository", + "smithy.api#documentation": "

\n The format of the returned packages. The valid package types are:\n

\n ", + "smithy.api#httpQuery": "format", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.codeartifact#PackageVersionStatus", - "traits": { - "smithy.api#documentation": "

\n A string that specifies the status of the package versions to include in the returned list. It can be one of the following:\n

\n ", - "smithy.api#httpQuery": "status" - } - }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the repository that contains the returned package versions.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

\n The name of the package for which you want to return a list of package versions.\n

", - "smithy.api#httpQuery": "package", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "next-token" } }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", + "maxResults": { + "target": "com.amazonaws.codeartifact#ListPackageVersionsMaxResults", "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

", + "smithy.api#httpQuery": "max-results" } }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" + "smithy.api#documentation": "

\n The name of the domain that contains the repository that contains the returned package versions.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} } }, - "format": { - "target": "com.amazonaws.codeartifact#PackageFormat", + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The format of the returned packages. The valid package types are:\n

\n ", - "smithy.api#httpQuery": "format", + "smithy.api#documentation": "

\n The name of the repository that contains the package.\n

", + "smithy.api#httpQuery": "repository", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

\n The name of the package for which you want to return a list of package versions.\n

", + "smithy.api#httpQuery": "package", + "smithy.api#required": {} } }, "sortBy": { @@ -2868,11 +2861,18 @@ "smithy.api#httpQuery": "sortBy" } }, - "maxResults": { - "target": "com.amazonaws.codeartifact#ListPackageVersionsMaxResults", + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" + } + }, + "status": { + "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { - "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "

\n A string that specifies the status of the package versions to include in the returned list. It can be one of the following:\n

\n ", + "smithy.api#httpQuery": "status" } } } @@ -2880,10 +2880,10 @@ "com.amazonaws.codeartifact#ListPackageVersionsResult": { "type": "structure", "members": { - "versions": { - "target": "com.amazonaws.codeartifact#PackageVersionSummaryList", + "defaultDisplayVersion": { + "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { - "smithy.api#documentation": "

\n The returned list of \n \n PackageVersionSummary\n \n objects.\n

" + "smithy.api#documentation": "

\n The default package version to display. This depends on the package format:\n

\n " } }, "format": { @@ -2892,22 +2892,22 @@ "smithy.api#documentation": "

\n A format of the package. Valid package format values are:\n

\n " } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

\n The name of the package.\n

" + "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" } }, - "defaultDisplayVersion": { - "target": "com.amazonaws.codeartifact#PackageVersion", + "versions": { + "target": "com.amazonaws.codeartifact#PackageVersionSummaryList", "traits": { - "smithy.api#documentation": "

\n The default package version to display. This depends on the package format:\n

\n " + "smithy.api#documentation": "

\n The returned list of \n \n PackageVersionSummary\n \n objects.\n

" } }, - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" + "smithy.api#documentation": "

\n The name of the package.\n

" } }, "namespace": { @@ -2977,25 +2977,19 @@ "smithy.api#httpQuery": "namespace" } }, - "format": { - "target": "com.amazonaws.codeartifact#PackageFormat", - "traits": { - "smithy.api#documentation": "

\n The format of the packages. The valid package types are:\n

\n ", - "smithy.api#httpQuery": "format" - } - }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" + "smithy.api#documentation": "

\n The name of the repository from which packages are to be listed.\n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "packagePrefix": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

\n A prefix used to filter returned repositories. Only repositories with names that start with \n repositoryPrefix are returned.\n

", + "smithy.api#httpQuery": "package-prefix" } }, "maxResults": { @@ -3005,19 +2999,25 @@ "smithy.api#httpQuery": "max-results" } }, - "packagePrefix": { - "target": "com.amazonaws.codeartifact#PackageName", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

\n A prefix used to filter returned repositories. Only repositories with names that start with \n repositoryPrefix are returned.\n

", - "smithy.api#httpQuery": "package-prefix" + "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "next-token" } }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The name of the repository from which packages are to be listed.\n

", - "smithy.api#httpQuery": "repository", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" + } + }, + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", + "traits": { + "smithy.api#documentation": "

\n The format of the packages. The valid package types are:\n

\n ", + "smithy.api#httpQuery": "format" } }, "domain": { @@ -3033,17 +3033,17 @@ "com.amazonaws.codeartifact#ListPackagesResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", - "traits": { - "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" - } - }, "packages": { "target": "com.amazonaws.codeartifact#PackageSummaryList", "traits": { "smithy.api#documentation": "

\n The list of returned \n PackageSummary\n \n objects.\n

" } + }, + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" + } } } }, @@ -3135,11 +3135,11 @@ "com.amazonaws.codeartifact#ListRepositoriesInDomainRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "repositoryPrefix": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

\n A prefix used to filter returned repositories. Only repositories with names that start with \n repositoryPrefix are returned.\n

", + "smithy.api#httpQuery": "repository-prefix" } }, "administratorAccount": { @@ -3149,11 +3149,12 @@ "smithy.api#httpQuery": "administrator-account" } }, - "maxResults": { - "target": "com.amazonaws.codeartifact#ListRepositoriesInDomainMaxResults", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "

\n The name of the domain that contains the returned list of repositories.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} } }, "domainOwner": { @@ -3163,19 +3164,18 @@ "smithy.api#httpQuery": "domain-owner" } }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the returned list of repositories.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "next-token" } }, - "repositoryPrefix": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "maxResults": { + "target": "com.amazonaws.codeartifact#ListRepositoriesInDomainMaxResults", "traits": { - "smithy.api#documentation": "

\n A prefix used to filter returned repositories. Only repositories with names that start with \n repositoryPrefix are returned.\n

", - "smithy.api#httpQuery": "repository-prefix" + "smithy.api#documentation": "

\n The maximum number of results to return per page.\n

", + "smithy.api#httpQuery": "max-results" } } } @@ -3183,17 +3183,17 @@ "com.amazonaws.codeartifact#ListRepositoriesInDomainResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", - "traits": { - "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" - } - }, "repositories": { "target": "com.amazonaws.codeartifact#RepositorySummaryList", "traits": { "smithy.api#documentation": "

\n The returned list of repositories.\n

" } + }, + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" + } } } }, @@ -3210,11 +3210,11 @@ "com.amazonaws.codeartifact#ListRepositoriesRequest": { "type": "structure", "members": { - "repositoryPrefix": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", "traits": { - "smithy.api#documentation": "

A prefix used to filter returned repositories. Only repositories with names that start\n with repositoryPrefix are returned.

", - "smithy.api#httpQuery": "repository-prefix" + "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", + "smithy.api#httpQuery": "next-token" } }, "maxResults": { @@ -3224,11 +3224,11 @@ "smithy.api#httpQuery": "max-results" } }, - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", + "repositoryPrefix": { + "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n

", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

A prefix used to filter returned repositories. Only repositories with names that start\n with repositoryPrefix are returned.

", + "smithy.api#httpQuery": "repository-prefix" } } } @@ -3236,17 +3236,17 @@ "com.amazonaws.codeartifact#ListRepositoriesResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codeartifact#PaginationToken", - "traits": { - "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" - } - }, "repositories": { "target": "com.amazonaws.codeartifact#RepositorySummaryList", "traits": { "smithy.api#documentation": "

\n The returned list of \n RepositorySummary\n \n objects.\n

" } + }, + "nextToken": { + "target": "com.amazonaws.codeartifact#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n If there are additional results, this is the token for the next set of results.\n

" + } } } }, @@ -3262,12 +3262,6 @@ "com.amazonaws.codeartifact#PackageDependency": { "type": "structure", "members": { - "versionRequirement": { - "target": "com.amazonaws.codeartifact#String", - "traits": { - "smithy.api#documentation": "

\n The required version, or version range, of the package that this package depends on. The version format\n is specific to the package type. For example, the following are possible valid required versions: 1.2.3,\n ^2.3.4, or 4.x.\n

" - } - }, "package": { "target": "com.amazonaws.codeartifact#PackageName", "traits": { @@ -3285,6 +3279,12 @@ "traits": { "smithy.api#documentation": "

The type of a package dependency. The possible values depend on the package type.\n Example types are compile, runtime, and test for Maven\n packages, and dev, prod, and optional for npm packages.

" } + }, + "versionRequirement": { + "target": "com.amazonaws.codeartifact#String", + "traits": { + "smithy.api#documentation": "

\n The required version, or version range, of the package that this package depends on. The version format\n is specific to the package type. For example, the following are possible valid required versions: 1.2.3,\n ^2.3.4, or 4.x.\n

" + } } }, "traits": { @@ -3339,18 +3339,18 @@ "com.amazonaws.codeartifact#PackageSummary": { "type": "structure", "members": { - "package": { - "target": "com.amazonaws.codeartifact#PackageName", - "traits": { - "smithy.api#documentation": "

\n The name of the package.\n

" - } - }, "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { "smithy.api#documentation": "

\n The format of the package. Valid values are:\n

\n " } }, + "package": { + "target": "com.amazonaws.codeartifact#PackageName", + "traits": { + "smithy.api#documentation": "

\n The name of the package.\n

" + } + }, "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { @@ -3381,22 +3381,16 @@ "com.amazonaws.codeartifact#PackageVersionDescription": { "type": "structure", "members": { - "summary": { - "target": "com.amazonaws.codeartifact#String", + "packageName": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n A summary of the package version. The summary is extracted from the package. The information in and \n detail level of the summary depends on the package version's format.\n

" + "smithy.api#documentation": "

\n The name of the requested package.\n

" } }, - "sourceCodeRepository": { + "homePage": { "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n The repository for the source code in the package version, or the source code used to build it.\n

" - } - }, - "version": { - "target": "com.amazonaws.codeartifact#PackageVersion", - "traits": { - "smithy.api#documentation": "

\n The version of the package.\n

" + "smithy.api#documentation": "

\n The homepage associated with the package. \n

" } }, "status": { @@ -3405,16 +3399,16 @@ "smithy.api#documentation": "

\n A string that contains the status of the package version. It can be one of the following:\n

\n " } }, - "licenses": { - "target": "com.amazonaws.codeartifact#LicenseInfoList", + "version": { + "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { - "smithy.api#documentation": "

\n Information about licenses associated with the package version.\n

" + "smithy.api#documentation": "

\n The version of the package.\n

" } }, - "homePage": { - "target": "com.amazonaws.codeartifact#String", + "revision": { + "target": "com.amazonaws.codeartifact#PackageVersionRevision", "traits": { - "smithy.api#documentation": "

\n The homepage associated with the package. \n

" + "smithy.api#documentation": "

\n The revision of the package version.\n

" } }, "namespace": { @@ -3423,28 +3417,28 @@ "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n " } }, - "packageName": { - "target": "com.amazonaws.codeartifact#PackageName", + "displayName": { + "target": "com.amazonaws.codeartifact#String255", "traits": { - "smithy.api#documentation": "

\n The name of the requested package.\n

" + "smithy.api#documentation": "

\n The name of the package that is displayed. The displayName varies depending \n on the package version's format. For example, if an npm package is named ui, \n is in the namespace vue, and has the format npm, then \n the displayName is @vue/ui.\n

" } }, - "format": { - "target": "com.amazonaws.codeartifact#PackageFormat", + "summary": { + "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n The format of the package version. The valid package formats are:\n

\n " + "smithy.api#documentation": "

\n A summary of the package version. The summary is extracted from the package. The information in and \n detail level of the summary depends on the package version's format.\n

" } }, - "revision": { - "target": "com.amazonaws.codeartifact#PackageVersionRevision", + "sourceCodeRepository": { + "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n The revision of the package version.\n

" + "smithy.api#documentation": "

\n The repository for the source code in the package version, or the source code used to build it.\n

" } }, - "displayName": { - "target": "com.amazonaws.codeartifact#String255", + "licenses": { + "target": "com.amazonaws.codeartifact#LicenseInfoList", "traits": { - "smithy.api#documentation": "

\n The name of the package that is displayed. The displayName varies depending \n on the package version's format. For example, if an npm package is named ui, \n is in the namespace vue, and has the format npm, then \n the displayName is @vue/ui.\n

" + "smithy.api#documentation": "

\n Information about licenses associated with the package version.\n

" } }, "publishedTime": { @@ -3452,6 +3446,12 @@ "traits": { "smithy.api#documentation": "

\n A timestamp that contains the date and time the package version was published.\n

" } + }, + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", + "traits": { + "smithy.api#documentation": "

\n The format of the package version. The valid package formats are:\n

\n " + } } }, "traits": { @@ -3588,13 +3588,6 @@ "com.amazonaws.codeartifact#PackageVersionSummary": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.codeartifact#PackageVersion", - "traits": { - "smithy.api#documentation": "

\n Information about a package version.\n

", - "smithy.api#required": {} - } - }, "status": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { @@ -3607,6 +3600,13 @@ "traits": { "smithy.api#documentation": "

\n The revision associated with a package version.\n

" } + }, + "version": { + "target": "com.amazonaws.codeartifact#PackageVersion", + "traits": { + "smithy.api#documentation": "

\n Information about a package version.\n

", + "smithy.api#required": {} + } } }, "traits": { @@ -3691,6 +3691,13 @@ "com.amazonaws.codeartifact#PutDomainPermissionsPolicyRequest": { "type": "structure", "members": { + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", + "traits": { + "smithy.api#documentation": "

\n The name of the domain on which to set the resource policy.\n

", + "smithy.api#required": {} + } + }, "policyRevision": { "target": "com.amazonaws.codeartifact#PolicyRevision", "traits": { @@ -3703,13 +3710,6 @@ "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

" } }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", - "traits": { - "smithy.api#documentation": "

\n The name of the domain on which to set the resource policy.\n

", - "smithy.api#required": {} - } - }, "policyDocument": { "target": "com.amazonaws.codeartifact#PolicyDocument", "traits": { @@ -3773,10 +3773,20 @@ "com.amazonaws.codeartifact#PutRepositoryPermissionsPolicyRequest": { "type": "structure", "members": { - "policyRevision": { - "target": "com.amazonaws.codeartifact#PolicyRevision", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n Sets the revision of the resource policy that specifies permissions to access the repository. \n This revision is used for optimistic locking, which prevents others from overwriting your \n changes to the repository's resource policy.\n

" + "smithy.api#documentation": "

\n The name of the domain containing the repository to set the resource policy on.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to set the resource policy on.

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} } }, "domainOwner": { @@ -3786,12 +3796,10 @@ "smithy.api#httpQuery": "domain-owner" } }, - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", + "policyRevision": { + "target": "com.amazonaws.codeartifact#PolicyRevision", "traits": { - "smithy.api#documentation": "

\n The name of the domain containing the repository to set the resource policy on.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} + "smithy.api#documentation": "

\n Sets the revision of the resource policy that specifies permissions to access the repository. \n This revision is used for optimistic locking, which prevents others from overwriting your \n changes to the repository's resource policy.\n

" } }, "policyDocument": { @@ -3800,14 +3808,6 @@ "smithy.api#documentation": "

A valid displayable JSON Aspen policy string to be set as the access control resource\n policy on the provided repository.

", "smithy.api#required": {} } - }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", - "traits": { - "smithy.api#documentation": "

The name of the repository to set the resource policy on.

", - "smithy.api#httpQuery": "repository", - "smithy.api#required": {} - } } } }, @@ -3825,12 +3825,24 @@ "com.amazonaws.codeartifact#RepositoryDescription": { "type": "structure", "members": { + "upstreams": { + "target": "com.amazonaws.codeartifact#UpstreamRepositoryInfoList", + "traits": { + "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" + } + }, "domainName": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { "smithy.api#documentation": "

\n The name of the domain that contains the repository.\n

" } }, + "externalConnections": { + "target": "com.amazonaws.codeartifact#RepositoryExternalConnectionInfoList", + "traits": { + "smithy.api#documentation": "

\n An array of external connections associated with the repository.\n

" + } + }, "description": { "target": "com.amazonaws.codeartifact#Description", "traits": { @@ -3849,18 +3861,6 @@ "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include \n dashes or spaces.\n

" } }, - "upstreams": { - "target": "com.amazonaws.codeartifact#UpstreamRepositoryInfoList", - "traits": { - "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" - } - }, - "externalConnections": { - "target": "com.amazonaws.codeartifact#RepositoryExternalConnectionInfoList", - "traits": { - "smithy.api#documentation": "

\n An array of external connections associated with the repository.\n

" - } - }, "arn": { "target": "com.amazonaws.codeartifact#Arn", "traits": { @@ -3881,6 +3881,12 @@ "com.amazonaws.codeartifact#RepositoryExternalConnectionInfo": { "type": "structure", "members": { + "externalConnectionName": { + "target": "com.amazonaws.codeartifact#ExternalConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the external connection associated with a repository.

" + } + }, "packageFormat": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { @@ -3892,12 +3898,6 @@ "traits": { "smithy.api#documentation": "

\n The status of the external connection of a repository. There is one valid value, Available.\n

" } - }, - "externalConnectionName": { - "target": "com.amazonaws.codeartifact#ExternalConnectionName", - "traits": { - "smithy.api#documentation": "

The name of the external connection associated with a repository.

" - } } }, "traits": { @@ -3923,16 +3923,16 @@ "com.amazonaws.codeartifact#RepositorySummary": { "type": "structure", "members": { - "administratorAccount": { - "target": "com.amazonaws.codeartifact#AccountId", + "arn": { + "target": "com.amazonaws.codeartifact#Arn", "traits": { - "smithy.api#documentation": "

\n The AWS account ID that manages the repository.\n

" + "smithy.api#documentation": "

The ARN of the repository.

" } }, - "name": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "domainName": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n The name of the repository.\n

" + "smithy.api#documentation": "

\n The name of the domain that contains the repository.\n

" } }, "domainOwner": { @@ -3941,16 +3941,10 @@ "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

" } }, - "arn": { - "target": "com.amazonaws.codeartifact#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the repository.

" - } - }, - "domainName": { - "target": "com.amazonaws.codeartifact#DomainName", + "administratorAccount": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The name of the domain that contains the repository.\n

" + "smithy.api#documentation": "

\n The AWS account ID that manages the repository.\n

" } }, "description": { @@ -3958,6 +3952,12 @@ "traits": { "smithy.api#documentation": "

\n The description of the repository.\n

" } + }, + "name": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "

\n The name of the repository.\n

" + } } }, "traits": { @@ -3973,10 +3973,10 @@ "com.amazonaws.codeartifact#ResourceNotFoundException": { "type": "structure", "members": { - "resourceId": { + "message": { "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n The ID of the resource.\n

" + "smithy.api#required": {} } }, "resourceType": { @@ -3985,10 +3985,10 @@ "smithy.api#documentation": "

\n The type of AWS resource.\n

" } }, - "message": { + "resourceId": { "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

\n The ID of the resource.\n

" } } }, @@ -4001,12 +4001,6 @@ "com.amazonaws.codeartifact#ResourcePolicy": { "type": "structure", "members": { - "document": { - "target": "com.amazonaws.codeartifact#PolicyDocument", - "traits": { - "smithy.api#documentation": "

\n The resource policy formatted in JSON.\n

" - } - }, "resourceArn": { "target": "com.amazonaws.codeartifact#Arn", "traits": { @@ -4018,6 +4012,12 @@ "traits": { "smithy.api#documentation": "

\n The current revision of the resource policy.\n

" } + }, + "document": { + "target": "com.amazonaws.codeartifact#PolicyDocument", + "traits": { + "smithy.api#documentation": "

\n The resource policy formatted in JSON.\n

" + } } }, "traits": { @@ -4066,16 +4066,16 @@ "smithy.api#documentation": "

\n The type of AWS resource.\n

" } }, - "message": { + "resourceId": { "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

\n The ID of the resource.\n

" } }, - "resourceId": { + "message": { "target": "com.amazonaws.codeartifact#String", "traits": { - "smithy.api#documentation": "

\n The ID of the resource.\n

" + "smithy.api#required": {} } } }, @@ -4100,17 +4100,17 @@ "com.amazonaws.codeartifact#SuccessfulPackageVersionInfo": { "type": "structure", "members": { - "revision": { - "target": "com.amazonaws.codeartifact#String", - "traits": { - "smithy.api#documentation": "

\n The revision of a package version.\n

" - } - }, "status": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { "smithy.api#documentation": "

\n The status of a package version. Valid statuses are:\n

\n " } + }, + "revision": { + "target": "com.amazonaws.codeartifact#String", + "traits": { + "smithy.api#documentation": "

\n The revision of a package version.\n

" + } } }, "traits": { @@ -4192,19 +4192,11 @@ "com.amazonaws.codeartifact#UpdatePackageVersionsStatusRequest": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.codeartifact#DomainName", - "traits": { - "smithy.api#documentation": "

\n The domain that contains the repository that contains the package versions with a status to be updated.\n

", - "smithy.api#httpQuery": "domain", - "smithy.api#required": {} - } - }, - "versions": { - "target": "com.amazonaws.codeartifact#PackageVersionList", + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "

\n An array of strings that specify the versions of the package with the statuses to update.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", + "smithy.api#httpQuery": "namespace" } }, "expectedStatus": { @@ -4213,19 +4205,11 @@ "smithy.api#documentation": "

The package version’s expected status before it is updated. If\n expectedStatus is provided, the package version's status is updated only if its\n status at the time UpdatePackageVersionsStatus is called matches\n expectedStatus.

" } }, - "package": { - "target": "com.amazonaws.codeartifact#PackageName", - "traits": { - "smithy.api#documentation": "

\n The name of the package with the version statuses to update.\n

", - "smithy.api#httpQuery": "package", - "smithy.api#required": {} - } - }, - "namespace": { - "target": "com.amazonaws.codeartifact#PackageNamespace", + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n

\n ", - "smithy.api#httpQuery": "namespace" + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" } }, "versionRevisions": { @@ -4234,6 +4218,13 @@ "smithy.api#documentation": "

A map of package versions and package version revisions. The map key is the\n package version (for example, 3.5.2), and the map value is the\n package version revision.

" } }, + "versions": { + "target": "com.amazonaws.codeartifact#PackageVersionList", + "traits": { + "smithy.api#documentation": "

\n An array of strings that specify the versions of the package with the statuses to update.\n

", + "smithy.api#required": {} + } + }, "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { @@ -4242,18 +4233,19 @@ "smithy.api#required": {} } }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" + "smithy.api#documentation": "

\n The domain that contains the repository that contains the package versions with a status to be updated.\n

", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} } }, - "repository": { - "target": "com.amazonaws.codeartifact#RepositoryName", + "package": { + "target": "com.amazonaws.codeartifact#PackageName", "traits": { - "smithy.api#documentation": "

\n The repository that contains the package versions with the status you want to update. \n

", - "smithy.api#httpQuery": "repository", + "smithy.api#documentation": "

\n The name of the package with the version statuses to update.\n

", + "smithy.api#httpQuery": "package", "smithy.api#required": {} } }, @@ -4263,6 +4255,14 @@ "smithy.api#documentation": "

\n The status you want to change the package version status to.\n

", "smithy.api#required": {} } + }, + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "

\n The repository that contains the package versions with the status you want to update. \n

", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} + } } } }, @@ -4326,6 +4326,19 @@ "com.amazonaws.codeartifact#UpdateRepositoryRequest": { "type": "structure", "members": { + "upstreams": { + "target": "com.amazonaws.codeartifact#UpstreamRepositoryList", + "traits": { + "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" + } + }, + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", + "smithy.api#httpQuery": "domain-owner" + } + }, "domain": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { @@ -4342,24 +4355,11 @@ "smithy.api#required": {} } }, - "domainOwner": { - "target": "com.amazonaws.codeartifact#AccountId", - "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

", - "smithy.api#httpQuery": "domain-owner" - } - }, "description": { "target": "com.amazonaws.codeartifact#Description", "traits": { "smithy.api#documentation": "

\n An updated repository description.\n

" } - }, - "upstreams": { - "target": "com.amazonaws.codeartifact#UpstreamRepositoryList", - "traits": { - "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" - } } } }, @@ -4418,17 +4418,17 @@ "com.amazonaws.codeartifact#ValidationException": { "type": "structure", "members": { - "reason": { - "target": "com.amazonaws.codeartifact#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "

\n \n

" - } - }, "message": { "target": "com.amazonaws.codeartifact#String", "traits": { "smithy.api#required": {} } + }, + "reason": { + "target": "com.amazonaws.codeartifact#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

\n \n

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/codebuild.2016-10-06.json b/codegen/sdk-codegen/aws-models/codebuild.2016-10-06.json index e236c41b63a2..10d505784dbf 100644 --- a/codegen/sdk-codegen/aws-models/codebuild.2016-10-06.json +++ b/codegen/sdk-codegen/aws-models/codebuild.2016-10-06.json @@ -187,17 +187,17 @@ "com.amazonaws.codebuild#BatchGetBuildBatchesOutput": { "type": "structure", "members": { - "buildBatchesNotFound": { - "target": "com.amazonaws.codebuild#BuildBatchIds", - "traits": { - "smithy.api#documentation": "

An array that contains the identifiers of any batch builds that are not found.

" - } - }, "buildBatches": { "target": "com.amazonaws.codebuild#BuildBatches", "traits": { "smithy.api#documentation": "

An array of BuildBatch objects that represent the retrieved batch\n builds.

" } + }, + "buildBatchesNotFound": { + "target": "com.amazonaws.codebuild#BuildBatchIds", + "traits": { + "smithy.api#documentation": "

An array that contains the identifiers of any batch builds that are not found.

" + } } } }, @@ -233,17 +233,17 @@ "com.amazonaws.codebuild#BatchGetBuildsOutput": { "type": "structure", "members": { - "builds": { - "target": "com.amazonaws.codebuild#Builds", - "traits": { - "smithy.api#documentation": "

Information about the requested builds.

" - } - }, "buildsNotFound": { "target": "com.amazonaws.codebuild#BuildIds", "traits": { "smithy.api#documentation": "

The IDs of builds for which information could not be found.

" } + }, + "builds": { + "target": "com.amazonaws.codebuild#Builds", + "traits": { + "smithy.api#documentation": "

Information about the requested builds.

" + } } } }, @@ -279,17 +279,17 @@ "com.amazonaws.codebuild#BatchGetProjectsOutput": { "type": "structure", "members": { - "projects": { - "target": "com.amazonaws.codebuild#Projects", - "traits": { - "smithy.api#documentation": "

Information about the requested build projects.

" - } - }, "projectsNotFound": { "target": "com.amazonaws.codebuild#ProjectNames", "traits": { "smithy.api#documentation": "

The names of build projects for which information could not be found.

" } + }, + "projects": { + "target": "com.amazonaws.codebuild#Projects", + "traits": { + "smithy.api#documentation": "

Information about the requested build projects.

" + } } } }, @@ -371,34 +371,34 @@ "com.amazonaws.codebuild#BatchGetReportsOutput": { "type": "structure", "members": { - "reportsNotFound": { - "target": "com.amazonaws.codebuild#ReportArns", - "traits": { - "smithy.api#documentation": "

\n An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.\n

" - } - }, "reports": { "target": "com.amazonaws.codebuild#Reports", "traits": { "smithy.api#documentation": "

\n The array of Report objects returned by BatchGetReports.\n

" } + }, + "reportsNotFound": { + "target": "com.amazonaws.codebuild#ReportArns", + "traits": { + "smithy.api#documentation": "

\n An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.\n

" + } } } }, "com.amazonaws.codebuild#BatchRestrictions": { "type": "structure", "members": { - "maximumBuildsAllowed": { - "target": "com.amazonaws.codebuild#WrapperInt", - "traits": { - "smithy.api#documentation": "

Specifies the maximum number of builds allowed.

" - } - }, "computeTypesAllowed": { "target": "com.amazonaws.codebuild#ComputeTypesAllowed", "traits": { "smithy.api#documentation": "

An array of strings that specify the compute types that are allowed for the batch\n build. See Build environment\n compute types in the AWS CodeBuild User Guide for these values.\n

" } + }, + "maximumBuildsAllowed": { + "target": "com.amazonaws.codebuild#WrapperInt", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of builds allowed.

" + } } }, "traits": { @@ -411,10 +411,10 @@ "com.amazonaws.codebuild#Build": { "type": "structure", "members": { - "logs": { - "target": "com.amazonaws.codebuild#LogsLocation", + "reportArns": { + "target": "com.amazonaws.codebuild#BuildReportArns", "traits": { - "smithy.api#documentation": "

Information about the build's logs in Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

An array of the ARNs associated with this build's reports.

" } }, "fileSystemLocations": { @@ -423,34 +423,28 @@ "smithy.api#documentation": "

\n An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object \n specifies the identifier, location, mountOptions, \n mountPoint, and type of a file system created using Amazon Elastic File System.\n

" } }, - "startTime": { - "target": "com.amazonaws.codebuild#Timestamp", - "traits": { - "smithy.api#documentation": "

When the build process started, expressed in Unix time format.

" - } - }, "serviceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of a service role used for this build.

" } }, - "encryptionKey": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "logs": { + "target": "com.amazonaws.codebuild#LogsLocation", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/alias-name\n ).

" + "smithy.api#documentation": "

Information about the build's logs in Amazon CloudWatch Logs.

" } }, - "environment": { - "target": "com.amazonaws.codebuild#ProjectEnvironment", + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

Information about the build environment for this build.

" + "smithy.api#documentation": "

When the build process started, expressed in Unix time format.

" } }, - "buildNumber": { - "target": "com.amazonaws.codebuild#WrapperLong", + "initiator": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The number of the build. For each project, the buildNumber of its first\n build is 1. The buildNumber of each subsequent build is\n incremented by 1. If a build is deleted, the buildNumber of\n other builds does not change.

" + "smithy.api#documentation": "

The entity that started the build. Valid values include:

\n " } }, "buildStatus": { @@ -459,46 +453,22 @@ "smithy.api#documentation": "

The current status of the build. Valid values include:

\n " } }, - "projectName": { + "sourceVersion": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

" - } - }, - "buildComplete": { - "target": "com.amazonaws.codebuild#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the build is complete. True if complete; otherwise, false.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.codebuild#VpcConfig", - "traits": { - "smithy.api#documentation": "

If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter\n that identifies the VPC ID and the list of security group IDs and subnet IDs. The\n security groups and subnets must belong to the same VPC. You must provide at least one\n security group and one subnet ID.

" - } - }, - "currentPhase": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

The current build phase.

" - } - }, - "networkInterface": { - "target": "com.amazonaws.codebuild#NetworkInterface", - "traits": { - "smithy.api#documentation": "

Describes a network interface.

" + "smithy.api#documentation": "

Any version identifier for the version of the source code to be built. If\n sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" } }, - "endTime": { - "target": "com.amazonaws.codebuild#Timestamp", + "timeoutInMinutes": { + "target": "com.amazonaws.codebuild#WrapperInt", "traits": { - "smithy.api#documentation": "

When the build process ended, expressed in Unix time format.

" + "smithy.api#documentation": "

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not\n get marked as completed.

" } }, - "queuedTimeoutInMinutes": { - "target": "com.amazonaws.codebuild#WrapperInt", + "arn": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build.

" } }, "id": { @@ -507,10 +477,16 @@ "smithy.api#documentation": "

The unique ID for the build.

" } }, - "arn": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "exportedEnvironmentVariables": { + "target": "com.amazonaws.codebuild#ExportedEnvironmentVariables", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build.

" + "smithy.api#documentation": "

A list of exported environment variables for this build.

" + } + }, + "buildBatchArn": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The ARN of the batch build that this build is a member of, if applicable.

" } }, "secondarySources": { @@ -519,16 +495,16 @@ "smithy.api#documentation": "

An array of ProjectSource objects.

" } }, - "timeoutInMinutes": { - "target": "com.amazonaws.codebuild#WrapperInt", + "endTime": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not\n get marked as completed.

" + "smithy.api#documentation": "

When the build process ended, expressed in Unix time format.

" } }, - "exportedEnvironmentVariables": { - "target": "com.amazonaws.codebuild#ExportedEnvironmentVariables", + "phases": { + "target": "com.amazonaws.codebuild#BuildPhases", "traits": { - "smithy.api#documentation": "

A list of exported environment variables for this build.

" + "smithy.api#documentation": "

Information about all previous build phases that are complete and information about\n any current build phase that is not yet complete.

" } }, "debugSession": { @@ -537,28 +513,40 @@ "smithy.api#documentation": "

Contains information about the debug session for this build.

" } }, - "resolvedSourceVersion": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "networkInterface": { + "target": "com.amazonaws.codebuild#NetworkInterface", "traits": { - "smithy.api#documentation": "

An identifier for the version of this build's source code.

\n " + "smithy.api#documentation": "

Describes a network interface.

" } }, - "buildBatchArn": { - "target": "com.amazonaws.codebuild#String", + "vpcConfig": { + "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

The ARN of the batch build that this build is a member of, if applicable.

" + "smithy.api#documentation": "

If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter\n that identifies the VPC ID and the list of security group IDs and subnet IDs. The\n security groups and subnets must belong to the same VPC. You must provide at least one\n security group and one subnet ID.

" } }, - "sourceVersion": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "artifacts": { + "target": "com.amazonaws.codebuild#BuildArtifacts", "traits": { - "smithy.api#documentation": "

Any version identifier for the version of the source code to be built. If\n sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

Information about the output artifacts for the build.

" } }, - "secondarySourceVersions": { - "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "queuedTimeoutInMinutes": { + "target": "com.amazonaws.codebuild#WrapperInt", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n " + "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" + } + }, + "cache": { + "target": "com.amazonaws.codebuild#ProjectCache", + "traits": { + "smithy.api#documentation": "

Information about the cache for the build.

" + } + }, + "buildComplete": { + "target": "com.amazonaws.codebuild#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the build is complete. True if complete; otherwise, false.

" } }, "secondaryArtifacts": { @@ -573,34 +561,46 @@ "smithy.api#documentation": "

Information about the source code to be built.

" } }, - "initiator": { + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the AWS CodeBuild project.

" + } + }, + "currentPhase": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The entity that started the build. Valid values include:

\n " + "smithy.api#documentation": "

The current build phase.

" } }, - "cache": { - "target": "com.amazonaws.codebuild#ProjectCache", + "resolvedSourceVersion": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about the cache for the build.

" + "smithy.api#documentation": "

An identifier for the version of this build's source code.

\n " } }, - "phases": { - "target": "com.amazonaws.codebuild#BuildPhases", + "secondarySourceVersions": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

Information about all previous build phases that are complete and information about\n any current build phase that is not yet complete.

" + "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n " } }, - "artifacts": { - "target": "com.amazonaws.codebuild#BuildArtifacts", + "buildNumber": { + "target": "com.amazonaws.codebuild#WrapperLong", "traits": { - "smithy.api#documentation": "

Information about the output artifacts for the build.

" + "smithy.api#documentation": "

The number of the build. For each project, the buildNumber of its first\n build is 1. The buildNumber of each subsequent build is\n incremented by 1. If a build is deleted, the buildNumber of\n other builds does not change.

" } }, - "reportArns": { - "target": "com.amazonaws.codebuild#BuildReportArns", + "environment": { + "target": "com.amazonaws.codebuild#ProjectEnvironment", "traits": { - "smithy.api#documentation": "

An array of the ARNs associated with this build's reports.

" + "smithy.api#documentation": "

Information about the build environment for this build.

" + } + }, + "encryptionKey": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } } }, @@ -611,28 +611,22 @@ "com.amazonaws.codebuild#BuildArtifacts": { "type": "structure", "members": { - "sha256sum": { + "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The SHA-256 hash of the build artifact.

\n

You can use this hash along with a checksum tool to confirm file integrity and\n authenticity.

\n \n

This value is available only if the build project's packaging value\n is set to ZIP.

\n " + "smithy.api#documentation": "

Information about the location of the build artifacts.

" } }, - "encryptionDisabled": { + "overrideArtifactName": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Information that tells you if encryption for build artifacts is disabled.

" + "smithy.api#documentation": "

If this flag is set, a name specified in the buildspec file overrides the artifact\n name. The name specified in a buildspec file is calculated at build time and uses the\n Shell Command Language. For example, you can append a date and time to your artifact\n name so that it is always unique.

" } }, - "md5sum": { + "sha256sum": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The MD5 hash of the build artifact.

\n

You can use this hash along with a checksum tool to confirm file integrity and\n authenticity.

\n \n

This value is available only if the build project's packaging value\n is set to ZIP.

\n " - } - }, - "overrideArtifactName": { - "target": "com.amazonaws.codebuild#WrapperBoolean", - "traits": { - "smithy.api#documentation": "

If this flag is set, a name specified in the buildspec file overrides the artifact\n name. The name specified in a buildspec file is calculated at build time and uses the\n Shell Command Language. For example, you can append a date and time to your artifact\n name so that it is always unique.

" + "smithy.api#documentation": "

The SHA-256 hash of the build artifact.

\n

You can use this hash along with a checksum tool to confirm file integrity and\n authenticity.

\n \n

This value is available only if the build project's packaging value\n is set to ZIP.

\n " } }, "artifactIdentifier": { @@ -641,10 +635,16 @@ "smithy.api#documentation": "

An identifier for this artifact definition.

" } }, - "location": { + "encryptionDisabled": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

Information that tells you if encryption for build artifacts is disabled.

" + } + }, + "md5sum": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Information about the location of the build artifacts.

" + "smithy.api#documentation": "

The MD5 hash of the build artifact.

\n

You can use this hash along with a checksum tool to confirm file integrity and\n authenticity.

\n \n

This value is available only if the build project's packaging value\n is set to ZIP.

\n " } } }, @@ -667,49 +667,37 @@ "com.amazonaws.codebuild#BuildBatch": { "type": "structure", "members": { - "source": { - "target": "com.amazonaws.codebuild#ProjectSource" - }, - "projectName": { + "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the batch build project.

" - } - }, - "phases": { - "target": "com.amazonaws.codebuild#BuildBatchPhases", - "traits": { - "smithy.api#documentation": "

An array of BuildBatchPhase objects the specify the phases of the\n batch build.

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, - "vpcConfig": { - "target": "com.amazonaws.codebuild#VpcConfig" + "buildBatchConfig": { + "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig" }, - "queuedTimeoutInMinutes": { - "target": "com.amazonaws.codebuild#WrapperInt", + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Specifies the amount of time, in minutes, that the batch build is allowed to be queued\n before it times out.

" + "smithy.api#documentation": "

The name of the batch build project.

" } }, - "fileSystemLocations": { - "target": "com.amazonaws.codebuild#ProjectFileSystemLocations", + "buildTimeoutInMinutes": { + "target": "com.amazonaws.codebuild#WrapperInt", "traits": { - "smithy.api#documentation": "

An array of ProjectFileSystemLocation objects for the batch build\n project. A ProjectFileSystemLocation object specifies the\n identifier, location, mountOptions,\n mountPoint, and type of a file system created using Amazon\n Elastic File System.

" + "smithy.api#documentation": "

Specifies the maximum amount of time, in minutes, that the build in a batch must be\n completed in.

" } }, - "logConfig": { - "target": "com.amazonaws.codebuild#LogsConfig" - }, - "endTime": { - "target": "com.amazonaws.codebuild#Timestamp", + "currentPhase": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The date and time that the batch build ended.

" + "smithy.api#documentation": "

The current phase of the batch build.

" } }, - "secondarySources": { - "target": "com.amazonaws.codebuild#ProjectSources", + "serviceRole": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of ProjectSource objects that define the sources for the batch\n build.

" + "smithy.api#documentation": "

The name of a service role used for builds in the batch.

" } }, "resolvedSourceVersion": { @@ -718,43 +706,43 @@ "smithy.api#documentation": "

The identifier of the resolved version of this batch build's source code.

\n " } }, - "buildTimeoutInMinutes": { - "target": "com.amazonaws.codebuild#WrapperInt", + "initiator": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Specifies the maximum amount of time, in minutes, that the build in a batch must be\n completed in.

" + "smithy.api#documentation": "

The entity that started the batch build. Valid values include:

\n " } }, - "secondarySourceVersions": { - "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "queuedTimeoutInMinutes": { + "target": "com.amazonaws.codebuild#WrapperInt", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n " + "smithy.api#documentation": "

Specifies the amount of time, in minutes, that the batch build is allowed to be queued\n before it times out.

" } }, - "currentPhase": { - "target": "com.amazonaws.codebuild#String", + "endTime": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

The current phase of the batch build.

" + "smithy.api#documentation": "

The date and time that the batch build ended.

" } }, - "encryptionKey": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "complete": { + "target": "com.amazonaws.codebuild#Boolean", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/alias-name\n ).

" + "smithy.api#documentation": "

Indicates if the batch build is complete.

" } }, - "environment": { - "target": "com.amazonaws.codebuild#ProjectEnvironment" + "vpcConfig": { + "target": "com.amazonaws.codebuild#VpcConfig" }, - "secondaryArtifacts": { - "target": "com.amazonaws.codebuild#BuildArtifactsList", + "sourceVersion": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of BuildArtifacts objects the define the build artifacts\n for this batch build.

" + "smithy.api#documentation": "

The identifier of the version of the source code to be built.

" } }, - "buildBatchNumber": { - "target": "com.amazonaws.codebuild#WrapperLong", + "secondarySourceVersions": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

The number of the batch build. For each project, the buildBatchNumber of its\n first batch build is 1. The buildBatchNumber of each subsequent\n batch build is incremented by 1. If a batch build is deleted, the\n buildBatchNumber of other batch builds does not change.

" + "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n " } }, "buildGroups": { @@ -763,64 +751,76 @@ "smithy.api#documentation": "

An array of BuildGroup objects that define the build groups for the\n batch build.

" } }, + "secondaryArtifacts": { + "target": "com.amazonaws.codebuild#BuildArtifactsList", + "traits": { + "smithy.api#documentation": "

An array of BuildArtifacts objects the define the build artifacts\n for this batch build.

" + } + }, "artifacts": { "target": "com.amazonaws.codebuild#BuildArtifacts", "traits": { "smithy.api#documentation": "

A BuildArtifacts object the defines the build artifacts for this batch build.

" } }, - "cache": { - "target": "com.amazonaws.codebuild#ProjectCache" - }, - "complete": { - "target": "com.amazonaws.codebuild#Boolean", + "buildBatchStatus": { + "target": "com.amazonaws.codebuild#StatusType", "traits": { - "smithy.api#documentation": "

Indicates if the batch build is complete.

" + "smithy.api#documentation": "

The status of the batch build.

" } }, - "startTime": { - "target": "com.amazonaws.codebuild#Timestamp", + "buildBatchNumber": { + "target": "com.amazonaws.codebuild#WrapperLong", "traits": { - "smithy.api#documentation": "

The date and time that the batch build started.

" + "smithy.api#documentation": "

The number of the batch build. For each project, the buildBatchNumber of its\n first batch build is 1. The buildBatchNumber of each subsequent\n batch build is incremented by 1. If a batch build is deleted, the\n buildBatchNumber of other batch builds does not change.

" } }, + "environment": { + "target": "com.amazonaws.codebuild#ProjectEnvironment" + }, "id": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { "smithy.api#documentation": "

The identifier of the batch build.

" } }, + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the batch build started.

" + } + }, "arn": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { "smithy.api#documentation": "

The ARN of the batch build.

" } }, - "serviceRole": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "phases": { + "target": "com.amazonaws.codebuild#BuildBatchPhases", "traits": { - "smithy.api#documentation": "

The name of a service role used for builds in the batch.

" + "smithy.api#documentation": "

An array of BuildBatchPhase objects the specify the phases of the\n batch build.

" } }, - "buildBatchConfig": { - "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig" + "logConfig": { + "target": "com.amazonaws.codebuild#LogsConfig" }, - "buildBatchStatus": { - "target": "com.amazonaws.codebuild#StatusType", - "traits": { - "smithy.api#documentation": "

The status of the batch build.

" - } + "cache": { + "target": "com.amazonaws.codebuild#ProjectCache" }, - "initiator": { - "target": "com.amazonaws.codebuild#String", + "secondarySources": { + "target": "com.amazonaws.codebuild#ProjectSources", "traits": { - "smithy.api#documentation": "

The entity that started the batch build. Valid values include:

\n " + "smithy.api#documentation": "

An array of ProjectSource objects that define the sources for the batch\n build.

" } }, - "sourceVersion": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "source": { + "target": "com.amazonaws.codebuild#ProjectSource" + }, + "fileSystemLocations": { + "target": "com.amazonaws.codebuild#ProjectFileSystemLocations", "traits": { - "smithy.api#documentation": "

The identifier of the version of the source code to be built.

" + "smithy.api#documentation": "

An array of ProjectFileSystemLocation objects for the batch build\n project. A ProjectFileSystemLocation object specifies the\n identifier, location, mountOptions,\n mountPoint, and type of a file system created using Amazon\n Elastic File System.

" } } }, @@ -857,22 +857,16 @@ "com.amazonaws.codebuild#BuildBatchPhase": { "type": "structure", "members": { - "phaseStatus": { - "target": "com.amazonaws.codebuild#StatusType", - "traits": { - "smithy.api#documentation": "

The current status of the batch build phase. Valid values include:

\n
\n
FAILED
\n
\n

The build phase failed.

\n
\n
FAULT
\n
\n

The build phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The build phase is still in progress.

\n
\n
QUEUED
\n
\n

The build has been submitted and is queued behind other submitted\n builds.

\n
\n
STOPPED
\n
\n

The build phase stopped.

\n
\n
SUCCEEDED
\n
\n

The build phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The build phase timed out.

\n
\n
" - } - }, - "phaseType": { - "target": "com.amazonaws.codebuild#BuildBatchPhaseType", + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the batch build phase. Valid values include:

\n
\n
COMBINE_ARTIFACTS
\n
\n

Build output artifacts are being combined and uploaded to the output\n location.

\n
\n
DOWNLOAD_BATCHSPEC
\n
\n

The batch build specification is being downloaded.

\n
\n
FAILED
\n
\n

One or more of the builds failed.

\n
\n
IN_PROGRESS
\n
\n

The batch build is in progress.

\n
\n
STOPPED
\n
\n

The batch build was stopped.

\n
\n
SUBMITTED
\n
\n

The btach build has been submitted.

\n
\n
SUCCEEDED
\n
\n

The batch build succeeded.

\n
\n
" + "smithy.api#documentation": "

When the batch build phase started, expressed in Unix time format.

" } }, - "startTime": { + "endTime": { "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

When the batch build phase started, expressed in Unix time format.

" + "smithy.api#documentation": "

When the batch build phase ended, expressed in Unix time format.

" } }, "durationInSeconds": { @@ -887,10 +881,16 @@ "smithy.api#documentation": "

Additional information about the batch build phase. Especially to help troubleshoot a\n failed btach build.

" } }, - "endTime": { - "target": "com.amazonaws.codebuild#Timestamp", + "phaseStatus": { + "target": "com.amazonaws.codebuild#StatusType", "traits": { - "smithy.api#documentation": "

When the batch build phase ended, expressed in Unix time format.

" + "smithy.api#documentation": "

The current status of the batch build phase. Valid values include:

\n
\n
FAILED
\n
\n

The build phase failed.

\n
\n
FAULT
\n
\n

The build phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The build phase is still in progress.

\n
\n
QUEUED
\n
\n

The build has been submitted and is queued behind other submitted\n builds.

\n
\n
STOPPED
\n
\n

The build phase stopped.

\n
\n
SUCCEEDED
\n
\n

The build phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The build phase timed out.

\n
\n
" + } + }, + "phaseType": { + "target": "com.amazonaws.codebuild#BuildBatchPhaseType", + "traits": { + "smithy.api#documentation": "

The name of the batch build phase. Valid values include:

\n
\n
COMBINE_ARTIFACTS
\n
\n

Build output artifacts are being combined and uploaded to the output\n location.

\n
\n
DOWNLOAD_BATCHSPEC
\n
\n

The batch build specification is being downloaded.

\n
\n
FAILED
\n
\n

One or more of the builds failed.

\n
\n
IN_PROGRESS
\n
\n

The batch build is in progress.

\n
\n
STOPPED
\n
\n

The batch build was stopped.

\n
\n
SUBMITTED
\n
\n

The btach build has been submitted.

\n
\n
SUCCEEDED
\n
\n

The batch build succeeded.

\n
\n
" } } }, @@ -954,6 +954,12 @@ "com.amazonaws.codebuild#BuildGroup": { "type": "structure", "members": { + "dependsOn": { + "target": "com.amazonaws.codebuild#Identifiers", + "traits": { + "smithy.api#documentation": "

An array of strings that contain the identifiers of the build groups that this build\n group depends on.

" + } + }, "currentBuildSummary": { "target": "com.amazonaws.codebuild#BuildSummary", "traits": { @@ -966,12 +972,6 @@ "smithy.api#documentation": "

An array of BuildSummary objects that contain summaries of previous\n build groups.

" } }, - "dependsOn": { - "target": "com.amazonaws.codebuild#Identifiers", - "traits": { - "smithy.api#documentation": "

An array of strings that contain the identifiers of the build groups that this build\n group depends on.

" - } - }, "ignoreFailure": { "target": "com.amazonaws.codebuild#Boolean", "traits": { @@ -1010,17 +1010,17 @@ "com.amazonaws.codebuild#BuildNotDeleted": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.codebuild#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the build that could not be successfully deleted.

" - } - }, "statusCode": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

Additional information about the build that could not be successfully deleted.

" } + }, + "id": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the build that could not be successfully deleted.

" + } } }, "traits": { @@ -1030,10 +1030,10 @@ "com.amazonaws.codebuild#BuildPhase": { "type": "structure", "members": { - "endTime": { - "target": "com.amazonaws.codebuild#Timestamp", + "durationInSeconds": { + "target": "com.amazonaws.codebuild#WrapperLong", "traits": { - "smithy.api#documentation": "

When the build phase ended, expressed in Unix time format.

" + "smithy.api#documentation": "

How long, in seconds, between the starting and ending times of the build's\n phase.

" } }, "contexts": { @@ -1042,6 +1042,12 @@ "smithy.api#documentation": "

Additional information about a build phase, especially to help troubleshoot a failed\n build.

" } }, + "startTime": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the build phase started, expressed in Unix time format.

" + } + }, "phaseType": { "target": "com.amazonaws.codebuild#BuildPhaseType", "traits": { @@ -1054,16 +1060,10 @@ "smithy.api#documentation": "

The current status of the build phase. Valid values include:

\n
\n
FAILED
\n
\n

The build phase failed.

\n
\n
FAULT
\n
\n

The build phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The build phase is still in progress.

\n
\n
QUEUED
\n
\n

The build has been submitted and is queued behind other submitted\n builds.

\n
\n
STOPPED
\n
\n

The build phase stopped.

\n
\n
SUCCEEDED
\n
\n

The build phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The build phase timed out.

\n
\n
" } }, - "startTime": { + "endTime": { "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

When the build phase started, expressed in Unix time format.

" - } - }, - "durationInSeconds": { - "target": "com.amazonaws.codebuild#WrapperLong", - "traits": { - "smithy.api#documentation": "

How long, in seconds, between the starting and ending times of the build's\n phase.

" + "smithy.api#documentation": "

When the build phase ended, expressed in Unix time format.

" } } }, @@ -1137,16 +1137,16 @@ "com.amazonaws.codebuild#BuildStatusConfig": { "type": "structure", "members": { - "context": { + "targetUrl": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Specifies the context of the build status CodeBuild sends to the source provider. The\n usage of this parameter depends on the source provider.

\n
\n
Bitbucket
\n
\n

This parameter is used for the name parameter in the\n Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

\n
\n
GitHub/GitHub Enterprise Server
\n
\n

This parameter is used for the context parameter in the\n GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

\n
\n
" + "smithy.api#documentation": "

Specifies the target url of the build status CodeBuild sends to the source provider. The\n usage of this parameter depends on the source provider.

\n
\n
Bitbucket
\n
\n

This parameter is used for the url parameter in the Bitbucket\n commit status. For more information, see build in the Bitbucket API documentation.

\n
\n
GitHub/GitHub Enterprise Server
\n
\n

This parameter is used for the target_url parameter in the\n GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

\n
\n
" } }, - "targetUrl": { + "context": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Specifies the target url of the build status CodeBuild sends to the source provider. The\n usage of this parameter depends on the source provider.

\n
\n
Bitbucket
\n
\n

This parameter is used for the url parameter in the Bitbucket\n commit status. For more information, see build in the Bitbucket API documentation.

\n
\n
GitHub/GitHub Enterprise Server
\n
\n

This parameter is used for the target_url parameter in the\n GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

\n
\n
" + "smithy.api#documentation": "

Specifies the context of the build status CodeBuild sends to the source provider. The\n usage of this parameter depends on the source provider.

\n
\n
Bitbucket
\n
\n

This parameter is used for the name parameter in the\n Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

\n
\n
GitHub/GitHub Enterprise Server
\n
\n

This parameter is used for the context parameter in the\n GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

\n
\n
" } } }, @@ -1163,6 +1163,12 @@ "com.amazonaws.codebuild#BuildSummary": { "type": "structure", "members": { + "buildStatus": { + "target": "com.amazonaws.codebuild#StatusType", + "traits": { + "smithy.api#documentation": "

The status of the build group.

\n
\n
FAILED
\n
\n

The build group failed.

\n
\n
FAULT
\n
\n

The build group faulted.

\n
\n
IN_PROGRESS
\n
\n

The build group is still in progress.

\n
\n
STOPPED
\n
\n

The build group stopped.

\n
\n
SUCCEEDED
\n
\n

The build group succeeded.

\n
\n
TIMED_OUT
\n
\n

The build group timed out.

\n
\n
" + } + }, "primaryArtifact": { "target": "com.amazonaws.codebuild#ResolvedArtifact", "traits": { @@ -1181,12 +1187,6 @@ "smithy.api#documentation": "

An array of ResolvedArtifact objects that represents the secondary build\n artifacts for the build group.

" } }, - "buildStatus": { - "target": "com.amazonaws.codebuild#StatusType", - "traits": { - "smithy.api#documentation": "

The status of the build group.

\n
\n
FAILED
\n
\n

The build group failed.

\n
\n
FAULT
\n
\n

The build group faulted.

\n
\n
IN_PROGRESS
\n
\n

The build group is still in progress.

\n
\n
STOPPED
\n
\n

The build group stopped.

\n
\n
SUCCEEDED
\n
\n

The build group succeeded.

\n
\n
TIMED_OUT
\n
\n

The build group timed out.

\n
\n
" - } - }, "requestedOn": { "target": "com.amazonaws.codebuild#Timestamp", "traits": { @@ -1251,12 +1251,6 @@ "com.amazonaws.codebuild#CloudWatchLogsConfig": { "type": "structure", "members": { - "groupName": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

The group name of the logs in Amazon CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

" - } - }, "streamName": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -1269,6 +1263,12 @@ "smithy.api#documentation": "

The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:

\n ", "smithy.api#required": {} } + }, + "groupName": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The group name of the logs in Amazon CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

" + } } }, "traits": { @@ -1427,58 +1427,52 @@ "com.amazonaws.codebuild#CodeCoverage": { "type": "structure", "members": { - "branchCoveragePercentage": { - "target": "com.amazonaws.codebuild#Percentage", + "expired": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

The percentage of branches that are covered by your tests.

" + "smithy.api#documentation": "

The date and time that the tests were run.

" } }, - "linesMissed": { + "branchesMissed": { "target": "com.amazonaws.codebuild#NonNegativeInt", "traits": { - "smithy.api#documentation": "

The number of lines that are not covered by your tests.

" + "smithy.api#documentation": "

The number of conditional branches that are not covered by your tests.

" } }, - "filePath": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "branchesCovered": { + "target": "com.amazonaws.codebuild#NonNegativeInt", "traits": { - "smithy.api#documentation": "

The path of the test report file.

" + "smithy.api#documentation": "

The number of conditional branches that are covered by your tests.

" } }, - "reportARN": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "linesMissed": { + "target": "com.amazonaws.codebuild#NonNegativeInt", "traits": { - "smithy.api#documentation": "

The ARN of the report.

" + "smithy.api#documentation": "

The number of lines that are not covered by your tests.

" } }, - "lineCoveragePercentage": { + "branchCoveragePercentage": { "target": "com.amazonaws.codebuild#Percentage", "traits": { - "smithy.api#documentation": "

The percentage of lines that are covered by your tests.

" - } - }, - "linesCovered": { - "target": "com.amazonaws.codebuild#NonNegativeInt", - "traits": { - "smithy.api#documentation": "

The number of lines that are covered by your tests.

" + "smithy.api#documentation": "

The percentage of branches that are covered by your tests.

" } }, - "expired": { - "target": "com.amazonaws.codebuild#Timestamp", + "filePath": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date and time that the tests were run.

" + "smithy.api#documentation": "

The path of the test report file.

" } }, - "branchesMissed": { + "linesCovered": { "target": "com.amazonaws.codebuild#NonNegativeInt", "traits": { - "smithy.api#documentation": "

The number of conditional branches that are not covered by your tests.

" + "smithy.api#documentation": "

The number of lines that are covered by your tests.

" } }, - "branchesCovered": { - "target": "com.amazonaws.codebuild#NonNegativeInt", + "reportARN": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The number of conditional branches that are covered by your tests.

" + "smithy.api#documentation": "

The ARN of the report.

" } }, "id": { @@ -1486,6 +1480,12 @@ "traits": { "smithy.api#documentation": "

The identifier of the code coverage report.

" } + }, + "lineCoveragePercentage": { + "target": "com.amazonaws.codebuild#Percentage", + "traits": { + "smithy.api#documentation": "

The percentage of lines that are covered by your tests.

" + } } }, "traits": { @@ -1495,12 +1495,6 @@ "com.amazonaws.codebuild#CodeCoverageReportSummary": { "type": "structure", "members": { - "linesCovered": { - "target": "com.amazonaws.codebuild#NonNegativeInt", - "traits": { - "smithy.api#documentation": "

The number of lines that are covered by your tests.

" - } - }, "lineCoveragePercentage": { "target": "com.amazonaws.codebuild#Percentage", "traits": { @@ -1513,6 +1507,12 @@ "smithy.api#documentation": "

The number of conditional branches that are covered by your tests.

" } }, + "linesMissed": { + "target": "com.amazonaws.codebuild#NonNegativeInt", + "traits": { + "smithy.api#documentation": "

The number of lines that are not covered by your tests.

" + } + }, "branchesMissed": { "target": "com.amazonaws.codebuild#NonNegativeInt", "traits": { @@ -1525,10 +1525,10 @@ "smithy.api#documentation": "

The percentage of branches that are covered by your tests.

" } }, - "linesMissed": { + "linesCovered": { "target": "com.amazonaws.codebuild#NonNegativeInt", "traits": { - "smithy.api#documentation": "

The number of lines that are not covered by your tests.

" + "smithy.api#documentation": "

The number of lines that are covered by your tests.

" } } }, @@ -1597,71 +1597,73 @@ "com.amazonaws.codebuild#CreateProjectInput": { "type": "structure", "members": { - "cache": { - "target": "com.amazonaws.codebuild#ProjectCache", + "badgeEnabled": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Stores recently used information so that it can be quickly accessed at a later\n time.

" + "smithy.api#documentation": "

Set this to true to generate a publicly accessible URL for your project's build\n badge.

" } }, - "logsConfig": { - "target": "com.amazonaws.codebuild#LogsConfig", + "serviceRole": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs\n uploaded to a specified S3 bucket, or both.

" + "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services\n on behalf of the AWS account.

", + "smithy.api#required": {} } }, - "artifacts": { - "target": "com.amazonaws.codebuild#ProjectArtifacts", + "logsConfig": { + "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Information about the build output artifacts for the build project.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs\n uploaded to a specified S3 bucket, or both.

" } }, - "tags": { - "target": "com.amazonaws.codebuild#TagList", + "buildBatchConfig": { + "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

A ProjectBuildBatchConfig object that defines the batch build options\n for the project.

" } }, - "secondarySourceVersions": { - "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "fileSystemLocations": { + "target": "com.amazonaws.codebuild#ProjectFileSystemLocations", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. If\n secondarySourceVersions is specified at the build level, then they take\n precedence over these secondarySourceVersions (at the project level).\n

" + "smithy.api#documentation": "

\n An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object\n specifies the identifier, location, mountOptions,\n mountPoint, and type of a file system created using Amazon Elastic File System.\n

" } }, - "encryptionKey": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "secondarySources": { + "target": "com.amazonaws.codebuild#ProjectSources", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/alias-name\n ).

" + "smithy.api#documentation": "

An array of ProjectSource objects.

" } }, - "sourceVersion": { - "target": "com.amazonaws.codebuild#String", + "queuedTimeoutInMinutes": { + "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the latest\n version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version takes\n precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" } }, - "description": { - "target": "com.amazonaws.codebuild#ProjectDescription", + "timeoutInMinutes": { + "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

A description that makes the build project easy to identify.

" + "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out\n any build that has not been marked as completed. The default is 60 minutes.

" } }, - "secondaryArtifacts": { - "target": "com.amazonaws.codebuild#ProjectArtifactsList", + "cache": { + "target": "com.amazonaws.codebuild#ProjectCache", "traits": { - "smithy.api#documentation": "

An array of ProjectArtifacts objects.

" + "smithy.api#documentation": "

Stores recently used information so that it can be quickly accessed at a later\n time.

" } }, - "secondarySources": { - "target": "com.amazonaws.codebuild#ProjectSources", + "name": { + "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

An array of ProjectSource objects.

" + "smithy.api#documentation": "

The name of the build project.

", + "smithy.api#required": {} } }, - "fileSystemLocations": { - "target": "com.amazonaws.codebuild#ProjectFileSystemLocations", + "artifacts": { + "target": "com.amazonaws.codebuild#ProjectArtifacts", "traits": { - "smithy.api#documentation": "

\n An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object\n specifies the identifier, location, mountOptions,\n mountPoint, and type of a file system created using Amazon Elastic File System.\n

" + "smithy.api#documentation": "

Information about the build output artifacts for the build project.

", + "smithy.api#required": {} } }, "source": { @@ -1677,49 +1679,47 @@ "smithy.api#documentation": "

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" } }, - "queuedTimeoutInMinutes": { - "target": "com.amazonaws.codebuild#TimeOut", + "sourceVersion": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the latest\n version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version takes\n precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" } }, - "environment": { - "target": "com.amazonaws.codebuild#ProjectEnvironment", + "encryptionKey": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about the build environment for the build project.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, - "timeoutInMinutes": { - "target": "com.amazonaws.codebuild#TimeOut", + "description": { + "target": "com.amazonaws.codebuild#ProjectDescription", "traits": { - "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out\n any build that has not been marked as completed. The default is 60 minutes.

" + "smithy.api#documentation": "

A description that makes the build project easy to identify.

" } }, - "name": { - "target": "com.amazonaws.codebuild#ProjectName", + "environment": { + "target": "com.amazonaws.codebuild#ProjectEnvironment", "traits": { - "smithy.api#documentation": "

The name of the build project.

", + "smithy.api#documentation": "

Information about the build environment for the build project.

", "smithy.api#required": {} } }, - "serviceRole": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "secondarySourceVersions": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services\n on behalf of the AWS account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of ProjectSourceVersion objects. If\n secondarySourceVersions is specified at the build level, then they take\n precedence over these secondarySourceVersions (at the project level).\n

" } }, - "badgeEnabled": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "tags": { + "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

Set this to true to generate a publicly accessible URL for your project's build\n badge.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" } }, - "buildBatchConfig": { - "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig", + "secondaryArtifacts": { + "target": "com.amazonaws.codebuild#ProjectArtifactsList", "traits": { - "smithy.api#documentation": "

A ProjectBuildBatchConfig object that defines the batch build options\n for the project.

" + "smithy.api#documentation": "

An array of ProjectArtifacts objects.

" } } } @@ -1761,6 +1761,12 @@ "com.amazonaws.codebuild#CreateReportGroupInput": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.codebuild#TagList", + "traits": { + "smithy.api#documentation": "

\n A list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + } + }, "type": { "target": "com.amazonaws.codebuild#ReportType", "traits": { @@ -1768,23 +1774,17 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.codebuild#ReportGroupName", + "exportConfig": { + "target": "com.amazonaws.codebuild#ReportExportConfig", "traits": { - "smithy.api#documentation": "

\n The name of the report group.\n

", + "smithy.api#documentation": "

\n A ReportExportConfig object that contains information about where the report group test results are exported.\n

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.codebuild#TagList", - "traits": { - "smithy.api#documentation": "

\n A list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" - } - }, - "exportConfig": { - "target": "com.amazonaws.codebuild#ReportExportConfig", + "name": { + "target": "com.amazonaws.codebuild#ReportGroupName", "traits": { - "smithy.api#documentation": "

\n A ReportExportConfig object that contains information about where the report group test results are exported.\n

", + "smithy.api#documentation": "

\n The name of the report group.\n

", "smithy.api#required": {} } } @@ -1830,6 +1830,12 @@ "com.amazonaws.codebuild#CreateWebhookInput": { "type": "structure", "members": { + "branchFilter": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

A regular expression used to determine which repository branches are built when a\n webhook is triggered. If the name of a branch matches the regular expression, then it is\n built. If branchFilter is empty, then all branches are built.

\n \n

It is recommended that you use filterGroups instead of\n branchFilter.

\n " + } + }, "buildType": { "target": "com.amazonaws.codebuild#WebhookBuildType", "traits": { @@ -1848,12 +1854,6 @@ "smithy.api#documentation": "

The name of the AWS CodeBuild project.

", "smithy.api#required": {} } - }, - "branchFilter": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

A regular expression used to determine which repository branches are built when a\n webhook is triggered. If the name of a branch matches the regular expression, then it is\n built. If branchFilter is empty, then all branches are built.

\n \n

It is recommended that you use filterGroups instead of\n branchFilter.

\n " - } } } }, @@ -1882,17 +1882,17 @@ "com.amazonaws.codebuild#DebugSession": { "type": "structure", "members": { - "sessionEnabled": { - "target": "com.amazonaws.codebuild#WrapperBoolean", - "traits": { - "smithy.api#documentation": "

Specifies if session debugging is enabled for this build.

" - } - }, "sessionTarget": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { "smithy.api#documentation": "

Contains the identifier of the Session Manager session used for the build. To work with\n the paused build, you open this session to examine, control, and resume the\n build.

" } + }, + "sessionEnabled": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

Specifies if session debugging is enabled for this build.

" + } } }, "traits": { @@ -1931,10 +1931,10 @@ "com.amazonaws.codebuild#DeleteBuildBatchOutput": { "type": "structure", "members": { - "statusCode": { - "target": "com.amazonaws.codebuild#String", + "buildsDeleted": { + "target": "com.amazonaws.codebuild#BuildIds", "traits": { - "smithy.api#documentation": "

The status code.

" + "smithy.api#documentation": "

An array of strings that contain the identifiers of the builds that were deleted.

" } }, "buildsNotDeleted": { @@ -1943,10 +1943,10 @@ "smithy.api#documentation": "

An array of BuildNotDeleted objects that specify the builds that could not be\n deleted.

" } }, - "buildsDeleted": { - "target": "com.amazonaws.codebuild#BuildIds", + "statusCode": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

An array of strings that contain the identifiers of the builds that were deleted.

" + "smithy.api#documentation": "

The status code.

" } } } @@ -2015,7 +2015,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n DeleteReportGroup: Deletes a report group. Before you delete a report group, you must\n delete its reports. Use ListReportsForReportGroup to\n get the reports in a report group. Use DeleteReport to delete the reports. If you call\n DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.\n

" + "smithy.api#documentation": "

Deletes a report group. Before you delete a report group, you must delete its reports.

" } }, "com.amazonaws.codebuild#DeleteReportGroupInput": { @@ -2024,9 +2024,15 @@ "arn": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n The ARN of the report group to delete.\n

", + "smithy.api#documentation": "

The ARN of the report group to delete.

", "smithy.api#required": {} } + }, + "deleteReports": { + "target": "com.amazonaws.codebuild#Boolean", + "traits": { + "smithy.api#documentation": "

If true, deletes any reports that belong to a report group before deleting\n the report group.

\n

If false, you must delete any reports in the report group. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call\n DeleteReportGroup for a report group that contains one or more reports,\n an exception is thrown.

" + } } } }, @@ -2191,47 +2197,47 @@ "com.amazonaws.codebuild#DescribeCodeCoveragesInput": { "type": "structure", "members": { - "minLineCoveragePercentage": { - "target": "com.amazonaws.codebuild#Percentage", - "traits": { - "smithy.api#documentation": "

The minimum line coverage percentage to report.

" - } - }, "maxResults": { "target": "com.amazonaws.codebuild#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return.

" } }, + "sortOrder": { + "target": "com.amazonaws.codebuild#SortOrderType", + "traits": { + "smithy.api#documentation": "

Specifies if the results are sorted in ascending or descending order.

" + } + }, "maxLineCoveragePercentage": { "target": "com.amazonaws.codebuild#Percentage", "traits": { "smithy.api#documentation": "

The maximum line coverage percentage to report.

" } }, - "reportArn": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "sortBy": { + "target": "com.amazonaws.codebuild#ReportCodeCoverageSortByType", "traits": { - "smithy.api#documentation": "

\n The ARN of the report for which test cases are returned.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies how the results are sorted. Possible values are:

\n
\n
FILE_PATH
\n
\n

The results are sorted by file path.

\n
\n
LINE_COVERAGE_PERCENTAGE
\n
\n

The results are sorted by the percentage of lines that are covered.

\n
\n
" } }, - "sortOrder": { - "target": "com.amazonaws.codebuild#SortOrderType", + "nextToken": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Specifies if the results are sorted in ascending or descending order.

" + "smithy.api#documentation": "

The nextToken value returned from a previous call to\n DescribeCodeCoverages. This specifies the next item to return. To\n return the beginning of the list, exclude this parameter.

" } }, - "sortBy": { - "target": "com.amazonaws.codebuild#ReportCodeCoverageSortByType", + "reportArn": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Specifies how the results are sorted. Possible values are:

\n
\n
FILE_PATH
\n
\n

The results are sorted by file path.

\n
\n
LINE_COVERAGE_PERCENTAGE
\n
\n

The results are sorted by the percentage of lines that are covered.

\n
\n
" + "smithy.api#documentation": "

\n The ARN of the report for which test cases are returned.\n

", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.codebuild#String", + "minLineCoveragePercentage": { + "target": "com.amazonaws.codebuild#Percentage", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous call to\n DescribeCodeCoverages. This specifies the next item to return. To\n return the beginning of the list, exclude this parameter.

" + "smithy.api#documentation": "

The minimum line coverage percentage to report.

" } } } @@ -2282,12 +2288,6 @@ "com.amazonaws.codebuild#DescribeTestCasesInput": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.codebuild#PageSize", - "traits": { - "smithy.api#documentation": "

\n The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in\n the list of returned TestCase objects. The default value is 100.\n

" - } - }, "reportArn": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -2295,16 +2295,22 @@ "smithy.api#required": {} } }, + "filter": { + "target": "com.amazonaws.codebuild#TestCaseFilter", + "traits": { + "smithy.api#documentation": "

\n A TestCaseFilter object used to filter the returned reports.\n

" + } + }, "nextToken": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

\n During a previous call, the maximum number of items that can be returned is the value specified in\n maxResults. If there more items in the list, then a unique string called a nextToken\n is returned. To get the next batch of items in the list, call this operation again, adding the next token\n to the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.\n

" } }, - "filter": { - "target": "com.amazonaws.codebuild#TestCaseFilter", + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", "traits": { - "smithy.api#documentation": "

\n A TestCaseFilter object used to filter the returned reports.\n

" + "smithy.api#documentation": "

\n The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in\n the list of returned TestCase objects. The default value is 100.\n

" } } } @@ -2312,17 +2318,17 @@ "com.amazonaws.codebuild#DescribeTestCasesOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

\n During a previous call, the maximum number of items that can be returned is the value specified in\n maxResults. If there more items in the list, then a unique string called a nextToken\n is returned. To get the next batch of items in the list, call this operation again, adding the next token\n to the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.\n

" - } - }, "testCases": { "target": "com.amazonaws.codebuild#TestCases", "traits": { "smithy.api#documentation": "

\n The returned list of test cases.\n

" } + }, + "nextToken": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

\n During a previous call, the maximum number of items that can be returned is the value specified in\n maxResults. If there more items in the list, then a unique string called a nextToken\n is returned. To get the next batch of items in the list, call this operation again, adding the next token\n to the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.\n

" + } } } }, @@ -2335,17 +2341,17 @@ "smithy.api#documentation": "

The name of the Docker image.

" } }, - "versions": { - "target": "com.amazonaws.codebuild#ImageVersions", - "traits": { - "smithy.api#documentation": "

A list of environment image versions.

" - } - }, "description": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

The description of the Docker image.

" } + }, + "versions": { + "target": "com.amazonaws.codebuild#ImageVersions", + "traits": { + "smithy.api#documentation": "

A list of environment image versions.

" + } } }, "traits": { @@ -2361,17 +2367,17 @@ "com.amazonaws.codebuild#EnvironmentLanguage": { "type": "structure", "members": { - "language": { - "target": "com.amazonaws.codebuild#LanguageType", - "traits": { - "smithy.api#documentation": "

The programming language for the Docker images.

" - } - }, "images": { "target": "com.amazonaws.codebuild#EnvironmentImages", "traits": { "smithy.api#documentation": "

The list of Docker images that are related by the specified programming\n language.

" } + }, + "language": { + "target": "com.amazonaws.codebuild#LanguageType", + "traits": { + "smithy.api#documentation": "

The programming language for the Docker images.

" + } } }, "traits": { @@ -2450,7 +2456,7 @@ "type": { "target": "com.amazonaws.codebuild#EnvironmentVariableType", "traits": { - "smithy.api#documentation": "

The type of environment variable. Valid values include:

\n " + "smithy.api#documentation": "

The type of environment variable. Valid values include:

\n " } }, "name": { @@ -2659,6 +2665,12 @@ "com.amazonaws.codebuild#ImportSourceCredentialsInput": { "type": "structure", "members": { + "shouldOverwrite": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

Set to false to prevent overwriting the repository source credentials.\n Set to true to overwrite the repository source credentials. The default\n value is true.

" + } + }, "serverType": { "target": "com.amazonaws.codebuild#ServerType", "traits": { @@ -2666,10 +2678,11 @@ "smithy.api#required": {} } }, - "username": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "authType": { + "target": "com.amazonaws.codebuild#AuthType", "traits": { - "smithy.api#documentation": "

The Bitbucket username when the authType is BASIC_AUTH. This parameter\n is not valid for other types of source providers or connections.

" + "smithy.api#documentation": "

The type of authentication used to connect to a GitHub, GitHub Enterprise, or\n Bitbucket repository. An OAUTH connection is not supported by the API and must be\n created using the AWS CodeBuild console.

", + "smithy.api#required": {} } }, "token": { @@ -2679,17 +2692,10 @@ "smithy.api#required": {} } }, - "authType": { - "target": "com.amazonaws.codebuild#AuthType", - "traits": { - "smithy.api#documentation": "

The type of authentication used to connect to a GitHub, GitHub Enterprise, or\n Bitbucket repository. An OAUTH connection is not supported by the API and must be\n created using the AWS CodeBuild console.

", - "smithy.api#required": {} - } - }, - "shouldOverwrite": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "username": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Set to false to prevent overwriting the repository source credentials.\n Set to true to overwrite the repository source credentials. The default\n value is true.

" + "smithy.api#documentation": "

The Bitbucket username when the authType is BASIC_AUTH. This parameter\n is not valid for other types of source providers or connections.

" } } } @@ -2862,6 +2868,12 @@ "com.amazonaws.codebuild#ListBuildBatchesForProjectInput": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + }, "nextToken": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -2874,10 +2886,10 @@ "smithy.api#documentation": "

Specifies the sort order of the returned items. Valid values include:

\n " } }, - "maxResults": { - "target": "com.amazonaws.codebuild#PageSize", + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" + "smithy.api#documentation": "

The name of the project.

" } }, "filter": { @@ -2885,12 +2897,6 @@ "traits": { "smithy.api#documentation": "

A BuildBatchFilter object that specifies the filters for the search.

" } - }, - "projectName": { - "target": "com.amazonaws.codebuild#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the project.

" - } } } }, @@ -2920,6 +2926,12 @@ "smithy.api#documentation": "

Specifies the sort order of the returned items. Valid values include:

\n " } }, + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + }, "nextToken": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -2931,12 +2943,6 @@ "traits": { "smithy.api#documentation": "

A BuildBatchFilter object that specifies the filters for the search.

" } - }, - "maxResults": { - "target": "com.amazonaws.codebuild#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } } } }, @@ -3007,6 +3013,13 @@ "com.amazonaws.codebuild#ListBuildsForProjectInput": { "type": "structure", "members": { + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the AWS CodeBuild project.

", + "smithy.api#required": {} + } + }, "sortOrder": { "target": "com.amazonaws.codebuild#SortOrderType", "traits": { @@ -3018,13 +3031,6 @@ "traits": { "smithy.api#documentation": "

During a previous call, if there are more than 100 items in the list, only the first\n 100 items are returned, along with a unique string called a\n nextToken. To get the next batch of items in the list, call\n this operation again, adding the next token to the call. To get all of the items in the\n list, keep calling this operation with each subsequent next token that is returned,\n until no more next tokens are returned.

" } - }, - "projectName": { - "target": "com.amazonaws.codebuild#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

", - "smithy.api#required": {} - } } } }, @@ -3048,17 +3054,17 @@ "com.amazonaws.codebuild#ListBuildsInput": { "type": "structure", "members": { - "sortOrder": { - "target": "com.amazonaws.codebuild#SortOrderType", - "traits": { - "smithy.api#documentation": "

The order to list build IDs. Valid values include:

\n " - } - }, "nextToken": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

During a previous call, if there are more than 100 items in the list, only the first\n 100 items are returned, along with a unique string called a\n nextToken. To get the next batch of items in the list, call\n this operation again, adding the next token to the call. To get all of the items in the\n list, keep calling this operation with each subsequent next token that is returned,\n until no more next tokens are returned.

" } + }, + "sortOrder": { + "target": "com.amazonaws.codebuild#SortOrderType", + "traits": { + "smithy.api#documentation": "

The order to list build IDs. Valid values include:

\n " + } } } }, @@ -3131,12 +3137,6 @@ "com.amazonaws.codebuild#ListProjectsInput": { "type": "structure", "members": { - "sortBy": { - "target": "com.amazonaws.codebuild#ProjectSortByType", - "traits": { - "smithy.api#documentation": "

The criterion to be used to list build project names. Valid values include:

\n \n

Use sortOrder to specify in what order to list the build project names\n based on the preceding criteria.

" - } - }, "nextToken": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { @@ -3148,6 +3148,12 @@ "traits": { "smithy.api#documentation": "

The order in which to list build projects. Valid values include:

\n \n

Use sortBy to specify the criterion to be used to list build project\n names.

" } + }, + "sortBy": { + "target": "com.amazonaws.codebuild#ProjectSortByType", + "traits": { + "smithy.api#documentation": "

The criterion to be used to list build project names. Valid values include:

\n \n

Use sortOrder to specify in what order to list the build project names\n based on the preceding criteria.

" + } } } }, @@ -3289,16 +3295,16 @@ "com.amazonaws.codebuild#ListReportsForReportGroupInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codebuild#String", + "filter": { + "target": "com.amazonaws.codebuild#ReportFilter", "traits": { - "smithy.api#documentation": "

\n During a previous call, the maximum number of items that can be returned is the value specified in\n maxResults. If there more items in the list, then a unique string called a nextToken\n is returned. To get the next batch of items in the list, call this operation again, adding the next token\n to the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.\n

" + "smithy.api#documentation": "

\n A ReportFilter object used to filter the returned reports.\n

" } }, - "sortOrder": { - "target": "com.amazonaws.codebuild#SortOrderType", + "nextToken": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

\n Use to specify whether the results are returned in ascending or descending order.\n

" + "smithy.api#documentation": "

\n During a previous call, the maximum number of items that can be returned is the value specified in\n maxResults. If there more items in the list, then a unique string called a nextToken\n is returned. To get the next batch of items in the list, call this operation again, adding the next token\n to the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.\n

" } }, "maxResults": { @@ -3314,10 +3320,10 @@ "smithy.api#required": {} } }, - "filter": { - "target": "com.amazonaws.codebuild#ReportFilter", + "sortOrder": { + "target": "com.amazonaws.codebuild#SortOrderType", "traits": { - "smithy.api#documentation": "

\n A ReportFilter object used to filter the returned reports.\n

" + "smithy.api#documentation": "

\n Use to specify whether the results are returned in ascending or descending order.\n

" } } } @@ -3342,6 +3348,12 @@ "com.amazonaws.codebuild#ListReportsInput": { "type": "structure", "members": { + "sortOrder": { + "target": "com.amazonaws.codebuild#SortOrderType", + "traits": { + "smithy.api#documentation": "

\n Specifies the sort order for the list of returned reports. Valid values are:\n

\n " + } + }, "maxResults": { "target": "com.amazonaws.codebuild#PageSize", "traits": { @@ -3359,29 +3371,23 @@ "traits": { "smithy.api#documentation": "

\n During a previous call, the maximum number of items that can be returned is the value specified in\n maxResults. If there more items in the list, then a unique string called a nextToken\n is returned. To get the next batch of items in the list, call this operation again, adding the next token\n to the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.\n

" } - }, - "sortOrder": { - "target": "com.amazonaws.codebuild#SortOrderType", - "traits": { - "smithy.api#documentation": "

\n Specifies the sort order for the list of returned reports. Valid values are:\n

\n " - } } } }, "com.amazonaws.codebuild#ListReportsOutput": { "type": "structure", "members": { - "reports": { - "target": "com.amazonaws.codebuild#ReportArns", - "traits": { - "smithy.api#documentation": "

\n The list of returned ARNs for the reports in the current AWS account.\n

" - } - }, "nextToken": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

\n During a previous call, the maximum number of items that can be returned is the value specified in\n maxResults. If there more items in the list, then a unique string called a nextToken\n is returned. To get the next batch of items in the list, call this operation again, adding the next token\n to the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.\n

" } + }, + "reports": { + "target": "com.amazonaws.codebuild#ReportArns", + "traits": { + "smithy.api#documentation": "

\n The list of returned ARNs for the reports in the current AWS account.\n

" + } } } }, @@ -3411,29 +3417,29 @@ "com.amazonaws.codebuild#ListSharedProjectsInput": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.codebuild#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of paginated shared build projects returned per response. Use\n nextToken to iterate pages in the list of returned Project\n objects. The default value is 100.

" - } - }, "sortOrder": { "target": "com.amazonaws.codebuild#SortOrderType", "traits": { "smithy.api#documentation": "

The order in which to list shared build projects. Valid values include:

\n " } }, - "sortBy": { - "target": "com.amazonaws.codebuild#SharedResourceSortByType", - "traits": { - "smithy.api#documentation": "

The criterion to be used to list build projects shared with the current AWS account\n or user. Valid values include:

\n " - } - }, "nextToken": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { "smithy.api#documentation": "

During a previous call, the maximum number of items that can be returned is the value\n specified in maxResults. If there more items in the list, then a unique\n string called a nextToken is returned. To get the next batch of\n items in the list, call this operation again, adding the next token to the call. To get\n all of the items in the list, keep calling this operation with each subsequent next\n token that is returned, until no more next tokens are returned.

" } + }, + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of paginated shared build projects returned per response. Use\n nextToken to iterate pages in the list of returned Project\n objects. The default value is 100.

" + } + }, + "sortBy": { + "target": "com.amazonaws.codebuild#SharedResourceSortByType", + "traits": { + "smithy.api#documentation": "

The criterion to be used to list build projects shared with the current AWS account\n or user. Valid values include:

\n " + } } } }, @@ -3480,12 +3486,6 @@ "com.amazonaws.codebuild#ListSharedReportGroupsInput": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.codebuild#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of paginated shared report groups per response. Use\n nextToken to iterate pages in the list of returned\n ReportGroup objects. The default value is 100.

" - } - }, "sortBy": { "target": "com.amazonaws.codebuild#SharedResourceSortByType", "traits": { @@ -3498,6 +3498,12 @@ "smithy.api#documentation": "

The order in which to list shared report groups. Valid values include:

\n " } }, + "maxResults": { + "target": "com.amazonaws.codebuild#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of paginated shared report groups per response. Use\n nextToken to iterate pages in the list of returned\n ReportGroup objects. The default value is 100.

" + } + }, "nextToken": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -3509,19 +3515,19 @@ "com.amazonaws.codebuild#ListSharedReportGroupsOutput": { "type": "structure", "members": { - "reportGroups": { - "target": "com.amazonaws.codebuild#ReportGroupArns", - "traits": { - "smithy.api#documentation": "

The list of ARNs for the report groups shared with the current AWS account or user.\n

" - } - }, "nextToken": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

During a previous call, the maximum number of items that can be returned is the value\n specified in maxResults. If there more items in the list, then a unique\n string called a nextToken is returned. To get the next batch of\n items in the list, call this operation again, adding the next token to the call. To get\n all of the items in the list, keep calling this operation with each subsequent next\n token that is returned, until no more next tokens are returned.

" } - } - } + }, + "reportGroups": { + "target": "com.amazonaws.codebuild#ReportGroupArns", + "traits": { + "smithy.api#documentation": "

The list of ARNs for the report groups shared with the current AWS account or user.\n

" + } + } + } }, "com.amazonaws.codebuild#ListSourceCredentials": { "type": "operation", @@ -3558,17 +3564,17 @@ "com.amazonaws.codebuild#LogsConfig": { "type": "structure", "members": { - "cloudWatchLogs": { - "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", - "traits": { - "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.

" - } - }, "s3Logs": { "target": "com.amazonaws.codebuild#S3LogsConfig", "traits": { "smithy.api#documentation": "

Information about logs built to an S3 bucket for a build project. S3 logs are not\n enabled by default.

" } + }, + "cloudWatchLogs": { + "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", + "traits": { + "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.

" + } } }, "traits": { @@ -3599,6 +3605,18 @@ "smithy.api#documentation": "

The URL to a build log in an S3 bucket.

" } }, + "groupName": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs group for the build logs.

" + } + }, + "streamName": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs stream for the build logs.

" + } + }, "cloudWatchLogsArn": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -3617,10 +3635,10 @@ "smithy.api#documentation": "

The ARN of S3 logs for a build project. Its format is\n arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more\n information, see Resources Defined by Amazon S3.

" } }, - "groupName": { - "target": "com.amazonaws.codebuild#String", + "cloudWatchLogs": { + "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs group for the build logs.

" + "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project.

" } }, "deepLink": { @@ -3628,18 +3646,6 @@ "traits": { "smithy.api#documentation": "

The URL to an individual build log in Amazon CloudWatch Logs.

" } - }, - "streamName": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs stream for the build logs.

" - } - }, - "cloudWatchLogs": { - "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", - "traits": { - "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project.

" - } } }, "traits": { @@ -3649,16 +3655,16 @@ "com.amazonaws.codebuild#NetworkInterface": { "type": "structure", "members": { - "networkInterfaceId": { + "subnetId": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" + "smithy.api#documentation": "

The ID of the subnet.

" } }, - "subnetId": { + "networkInterfaceId": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the subnet.

" + "smithy.api#documentation": "

The ID of the network interface.

" } } }, @@ -3767,70 +3773,58 @@ "com.amazonaws.codebuild#Project": { "type": "structure", "members": { - "badge": { - "target": "com.amazonaws.codebuild#ProjectBadge", - "traits": { - "smithy.api#documentation": "

Information about the build badge for the build project.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.codebuild#VpcConfig", - "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that AWS CodeBuild accesses.

" - } - }, "source": { "target": "com.amazonaws.codebuild#ProjectSource", "traits": { "smithy.api#documentation": "

Information about the build input source code for this build project.

" } }, - "name": { - "target": "com.amazonaws.codebuild#ProjectName", + "secondaryArtifacts": { + "target": "com.amazonaws.codebuild#ProjectArtifactsList", "traits": { - "smithy.api#documentation": "

The name of the build project.

" + "smithy.api#documentation": "

An array of ProjectArtifacts objects.

" } }, - "queuedTimeoutInMinutes": { - "target": "com.amazonaws.codebuild#TimeOut", + "sourceVersion": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" } }, - "lastModified": { - "target": "com.amazonaws.codebuild#Timestamp", + "encryptionKey": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

When the build project's settings were last modified, expressed in Unix time\n format.

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, - "logsConfig": { - "target": "com.amazonaws.codebuild#LogsConfig", + "description": { + "target": "com.amazonaws.codebuild#ProjectDescription", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an\n S3 bucket, or both.

" + "smithy.api#documentation": "

A description that makes the build project easy to identify.

" } }, - "cache": { - "target": "com.amazonaws.codebuild#ProjectCache", + "timeoutInMinutes": { + "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

Information about the cache for the build project.

" + "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any\n related build that did not get marked as completed. The default is 60 minutes.

" } }, - "tags": { - "target": "com.amazonaws.codebuild#TagList", + "environment": { + "target": "com.amazonaws.codebuild#ProjectEnvironment", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

Information about the build environment for this build project.

" } }, - "artifacts": { - "target": "com.amazonaws.codebuild#ProjectArtifacts", + "created": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

Information about the build output artifacts for the build project.

" + "smithy.api#documentation": "

When the build project was created, expressed in Unix time format.

" } }, - "secondarySourceVersions": { - "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "badge": { + "target": "com.amazonaws.codebuild#ProjectBadge", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. If\n secondarySourceVersions is specified at the build level, then they take\n over these secondarySourceVersions (at the project level).

" + "smithy.api#documentation": "

Information about the build badge for the build project.

" } }, "serviceRole": { @@ -3845,10 +3839,22 @@ "smithy.api#documentation": "

\n An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object\n specifies the identifier, location, mountOptions,\n mountPoint, and type of a file system created using Amazon Elastic File System.\n

" } }, - "arn": { - "target": "com.amazonaws.codebuild#String", + "logsConfig": { + "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build project.

" + "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an\n S3 bucket, or both.

" + } + }, + "lastModified": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

When the build project's settings were last modified, expressed in Unix time\n format.

" + } + }, + "buildBatchConfig": { + "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig", + "traits": { + "smithy.api#documentation": "

A ProjectBuildBatchConfig object that defines the batch build\n options for the project.

" } }, "secondarySources": { @@ -3857,58 +3863,58 @@ "smithy.api#documentation": "

An array of ProjectSource objects.

" } }, - "webhook": { - "target": "com.amazonaws.codebuild#Webhook", + "cache": { + "target": "com.amazonaws.codebuild#ProjectCache", "traits": { - "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about the cache for the build project.

" } }, - "buildBatchConfig": { - "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig", + "arn": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A ProjectBuildBatchConfig object that defines the batch build\n options for the project.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build project.

" } }, - "created": { - "target": "com.amazonaws.codebuild#Timestamp", + "name": { + "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

When the build project was created, expressed in Unix time format.

" + "smithy.api#documentation": "

The name of the build project.

" } }, - "timeoutInMinutes": { - "target": "com.amazonaws.codebuild#TimeOut", + "tags": { + "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any\n related build that did not get marked as completed. The default is 60 minutes.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" } }, - "description": { - "target": "com.amazonaws.codebuild#ProjectDescription", + "secondarySourceVersions": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

A description that makes the build project easy to identify.

" + "smithy.api#documentation": "

An array of ProjectSourceVersion objects. If\n secondarySourceVersions is specified at the build level, then they take\n over these secondarySourceVersions (at the project level).

" } }, - "secondaryArtifacts": { - "target": "com.amazonaws.codebuild#ProjectArtifactsList", + "artifacts": { + "target": "com.amazonaws.codebuild#ProjectArtifacts", "traits": { - "smithy.api#documentation": "

An array of ProjectArtifacts objects.

" + "smithy.api#documentation": "

Information about the build output artifacts for the build project.

" } }, - "sourceVersion": { - "target": "com.amazonaws.codebuild#String", + "queuedTimeoutInMinutes": { + "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" } }, - "encryptionKey": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "webhook": { + "target": "com.amazonaws.codebuild#Webhook", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/alias-name\n ).

" + "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" } }, - "environment": { - "target": "com.amazonaws.codebuild#ProjectEnvironment", + "vpcConfig": { + "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

Information about the build environment for this build project.

" + "smithy.api#documentation": "

Information about the VPC configuration that AWS CodeBuild accesses.

" } } }, @@ -3931,6 +3937,18 @@ "com.amazonaws.codebuild#ProjectArtifacts": { "type": "structure", "members": { + "path": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

Along with namespaceType and name, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to NONE, and name is set\n to MyArtifact.zip, the output artifact is stored in the output bucket at\n MyArtifacts/MyArtifact.zip.

" + } + }, + "encryptionDisabled": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

Set to true if you do not want your output artifacts encrypted. This option is valid\n only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an\n invalidInputException is thrown.

" + } + }, "type": { "target": "com.amazonaws.codebuild#ArtifactsType", "traits": { @@ -3950,16 +3968,16 @@ "smithy.api#documentation": "

If this flag is set, a name specified in the buildspec file overrides the artifact\n name. The name specified in a buildspec file is calculated at build time and uses the\n Shell Command Language. For example, you can append a date and time to your artifact\n name so that it is always unique.

" } }, - "name": { - "target": "com.amazonaws.codebuild#String", + "namespaceType": { + "target": "com.amazonaws.codebuild#ArtifactNamespace", "traits": { - "smithy.api#documentation": "

Along with path and namespaceType, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n \n

For example:

\n " + "smithy.api#documentation": "

Along with path and name, the pattern that AWS CodeBuild uses to\n determine the name and location to store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and name is\n set to MyArtifact.zip, the output artifact is stored in\n MyArtifacts//MyArtifact.zip.

" } }, - "path": { + "name": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Along with namespaceType and name, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to NONE, and name is set\n to MyArtifact.zip, the output artifact is stored in the output bucket at\n MyArtifacts/MyArtifact.zip.

" + "smithy.api#documentation": "

Along with path and namespaceType, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n \n

For example:

\n " } }, "packaging": { @@ -3968,18 +3986,6 @@ "smithy.api#documentation": "

The type of build output artifact to create:

\n " } }, - "encryptionDisabled": { - "target": "com.amazonaws.codebuild#WrapperBoolean", - "traits": { - "smithy.api#documentation": "

Set to true if you do not want your output artifacts encrypted. This option is valid\n only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an\n invalidInputException is thrown.

" - } - }, - "namespaceType": { - "target": "com.amazonaws.codebuild#ArtifactNamespace", - "traits": { - "smithy.api#documentation": "

Along with path and name, the pattern that AWS CodeBuild uses to\n determine the name and location to store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and name is\n set to MyArtifact.zip, the output artifact is stored in\n MyArtifacts/build-ID/MyArtifact.zip.

" - } - }, "location": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -4006,17 +4012,17 @@ "com.amazonaws.codebuild#ProjectBadge": { "type": "structure", "members": { - "badgeRequestUrl": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

The publicly-accessible URL through which you can access the build badge for your\n project.

\n

The publicly accessible URL through which you can access the build badge for your\n project.

" - } - }, "badgeEnabled": { "target": "com.amazonaws.codebuild#Boolean", "traits": { "smithy.api#documentation": "

Set this to true to generate a publicly accessible URL for your project's build\n badge.

" } + }, + "badgeRequestUrl": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The publicly-accessible URL through which you can access the build badge for your\n project.

\n

The publicly accessible URL through which you can access the build badge for your\n project.

" + } } }, "traits": { @@ -4026,18 +4032,6 @@ "com.amazonaws.codebuild#ProjectBuildBatchConfig": { "type": "structure", "members": { - "restrictions": { - "target": "com.amazonaws.codebuild#BatchRestrictions", - "traits": { - "smithy.api#documentation": "

A BatchRestrictions object that specifies the restrictions for the batch\n build.

" - } - }, - "serviceRole": { - "target": "com.amazonaws.codebuild#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the service role ARN for the batch build project.

" - } - }, "timeoutInMins": { "target": "com.amazonaws.codebuild#WrapperInt", "traits": { @@ -4049,6 +4043,18 @@ "traits": { "smithy.api#documentation": "

Specifies if the build artifacts for the batch build should be combined into a single\n artifact location.

" } + }, + "serviceRole": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the service role ARN for the batch build project.

" + } + }, + "restrictions": { + "target": "com.amazonaws.codebuild#BatchRestrictions", + "traits": { + "smithy.api#documentation": "

A BatchRestrictions object that specifies the restrictions for the batch\n build.

" + } } }, "traits": { @@ -4058,19 +4064,19 @@ "com.amazonaws.codebuild#ProjectCache": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.codebuild#CacheType", - "traits": { - "smithy.api#documentation": "

The type of cache used by the build project. Valid values include:

\n ", - "smithy.api#required": {} - } - }, "modes": { "target": "com.amazonaws.codebuild#ProjectCacheModes", "traits": { "smithy.api#documentation": "

If you use a LOCAL cache, the local cache mode. You can use one or more\n local cache modes at the same time.

\n \n " } }, + "type": { + "target": "com.amazonaws.codebuild#CacheType", + "traits": { + "smithy.api#documentation": "

The type of cache used by the build project. Valid values include:

\n ", + "smithy.api#required": {} + } + }, "location": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -4100,17 +4106,16 @@ "com.amazonaws.codebuild#ProjectEnvironment": { "type": "structure", "members": { - "computeType": { - "target": "com.amazonaws.codebuild#ComputeType", + "privilegedMode": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Information about the compute resources the build project uses. Available values\n include:

\n \n

If you use BUILD_GENERAL1_LARGE:

\n \n

For more information, see Build Environment\n Compute Types in the AWS CodeBuild User Guide.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Enables running the Docker daemon inside a Docker container. Set to true only if the\n build project is used to build Docker images. Otherwise, a build that attempts to\n interact with the Docker daemon fails. The default setting is false.

\n

You can initialize the Docker daemon during the install phase of your build by adding\n one of the following sets of commands to the install phase of your buildspec\n file:

\n

If the operating system's base image is Ubuntu Linux:

\n

\n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&\n

\n

\n - timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"\n

\n

If the operating system's base image is Alpine Linux and the previous command does not\n work, add the -t argument to timeout:

\n

\n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&\n

\n

\n - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"\n

" } }, - "imagePullCredentialsType": { - "target": "com.amazonaws.codebuild#ImagePullCredentialsType", + "certificate": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n \n

When you use a cross-account or private registry image, you must use SERVICE_ROLE\n credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.\n

" + "smithy.api#documentation": "

The certificate to use with this build project.

" } }, "type": { @@ -4120,17 +4125,18 @@ "smithy.api#required": {} } }, - "image": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "computeType": { + "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "

The image tag or image digest that identifies the Docker image to use for this build\n project. Use the following formats:

\n ", + "smithy.api#documentation": "

Information about the compute resources the build project uses. Available values\n include:

\n \n

If you use BUILD_GENERAL1_LARGE:

\n \n

For more information, see Build Environment\n Compute Types in the AWS CodeBuild User Guide.\n

", "smithy.api#required": {} } }, - "certificate": { - "target": "com.amazonaws.codebuild#String", + "image": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The certificate to use with this build project.

" + "smithy.api#documentation": "

The image tag or image digest that identifies the Docker image to use for this build\n project. Use the following formats:

\n ", + "smithy.api#required": {} } }, "registryCredential": { @@ -4139,17 +4145,17 @@ "smithy.api#documentation": "

The credentials for access to a private registry.

" } }, - "privilegedMode": { - "target": "com.amazonaws.codebuild#WrapperBoolean", - "traits": { - "smithy.api#documentation": "

Enables running the Docker daemon inside a Docker container. Set to true only if the\n build project is used to build Docker images. Otherwise, a build that attempts to\n interact with the Docker daemon fails. The default setting is false.

\n

You can initialize the Docker daemon during the install phase of your build by adding\n one of the following sets of commands to the install phase of your buildspec\n file:

\n

If the operating system's base image is Ubuntu Linux:

\n

\n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&\n

\n

\n - timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"\n

\n

If the operating system's base image is Alpine Linux and the previous command does not\n work, add the -t argument to timeout:

\n

\n - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&\n

\n

\n - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"\n

" - } - }, "environmentVariables": { "target": "com.amazonaws.codebuild#EnvironmentVariables", "traits": { "smithy.api#documentation": "

A set of environment variables to make available to builds for this build\n project.

" } + }, + "imagePullCredentialsType": { + "target": "com.amazonaws.codebuild#ImagePullCredentialsType", + "traits": { + "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n \n

When you use a cross-account or private registry image, you must use SERVICE_ROLE\n credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.\n

" + } } }, "traits": { @@ -4159,10 +4165,10 @@ "com.amazonaws.codebuild#ProjectFileSystemLocation": { "type": "structure", "members": { - "location": { + "identifier": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A string that specifies the location of the file system created by Amazon EFS. Its\n format is efs-dns-name:/directory-path. You can find the DNS name of file\n system when you view it in the AWS EFS console. The directory path is a path to a\n directory in the file system that CodeBuild mounts. For example, if the DNS name of a\n file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount\n directory is my-efs-mount-directory, then the location is\n fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

\n

The directory path in the format efs-dns-name:/directory-path is\n optional. If you do not specify a directory path, the location is only the DNS name and\n CodeBuild mounts the entire file system.

" + "smithy.api#documentation": "

The name used to access a file system created by Amazon EFS. CodeBuild creates an\n environment variable by appending the identifier in all capital letters to\n CODEBUILD_. For example, if you specify my-efs for\n identifier, a new environment variable is create named\n CODEBUILD_MY-EFS.

\n

The identifier is used to mount your file system.

" } }, "mountPoint": { @@ -4171,22 +4177,22 @@ "smithy.api#documentation": "

The location in the container where you mount the file system.

" } }, - "identifier": { - "target": "com.amazonaws.codebuild#String", + "type": { + "target": "com.amazonaws.codebuild#FileSystemType", "traits": { - "smithy.api#documentation": "

The name used to access a file system created by Amazon EFS. CodeBuild creates an\n environment variable by appending the identifier in all capital letters to\n CODEBUILD_. For example, if you specify my-efs for\n identifier, a new environment variable is create named\n CODEBUILD_MY-EFS.

\n

The identifier is used to mount your file system.

" + "smithy.api#documentation": "

The type of the file system. The one supported type is EFS.

" } }, - "mountOptions": { + "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The mount options for a file system created by AWS EFS. The default mount options\n used by CodeBuild are\n nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For\n more information, see Recommended NFS Mount\n Options.

" + "smithy.api#documentation": "

A string that specifies the location of the file system created by Amazon EFS. Its\n format is efs-dns-name:/directory-path. You can find the DNS name of file\n system when you view it in the AWS EFS console. The directory path is a path to a\n directory in the file system that CodeBuild mounts. For example, if the DNS name of a\n file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount\n directory is my-efs-mount-directory, then the location is\n fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

\n

The directory path in the format efs-dns-name:/directory-path is\n optional. If you do not specify a directory path, the location is only the DNS name and\n CodeBuild mounts the entire file system.

" } }, - "type": { - "target": "com.amazonaws.codebuild#FileSystemType", + "mountOptions": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The type of the file system. The one supported type is EFS.

" + "smithy.api#documentation": "

The mount options for a file system created by AWS EFS. The default mount options\n used by CodeBuild are\n nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For\n more information, see Recommended NFS Mount\n Options.

" } } }, @@ -4256,22 +4262,22 @@ "com.amazonaws.codebuild#ProjectSource": { "type": "structure", "members": { - "reportBuildStatus": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "sourceIdentifier": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Set to true to report the status of a build's start and finish to your source\n provider. This option is valid only when your source provider is GitHub, GitHub\n Enterprise, or Bitbucket. If this is set and you use a different source provider, an\n invalidInputException is thrown.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " + "smithy.api#documentation": "

An identifier for this project source.

" } }, - "buildspec": { - "target": "com.amazonaws.codebuild#String", + "insecureSsl": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

The buildspec file declaration to use for the builds in this build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

Enable this flag to ignore SSL warnings while connecting to the project source\n code.

" } }, - "location": { + "buildspec": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Information about the location of the source code to be built. Valid values\n include:

\n " + "smithy.api#documentation": "

The buildspec file declaration to use for the builds in this build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, "auth": { @@ -4280,16 +4286,10 @@ "smithy.api#documentation": "

Information about the authorization settings for AWS CodeBuild to access the source code to be\n built.

\n

This information is for the AWS CodeBuild console's use only. Your code should not get or set\n this information directly.

" } }, - "insecureSsl": { + "reportBuildStatus": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Enable this flag to ignore SSL warnings while connecting to the project source\n code.

" - } - }, - "gitSubmodulesConfig": { - "target": "com.amazonaws.codebuild#GitSubmodulesConfig", - "traits": { - "smithy.api#documentation": "

Information about the Git submodules configuration for the build project.

" + "smithy.api#documentation": "

Set to true to report the status of a build's start and finish to your source\n provider. This option is valid only when your source provider is GitHub, GitHub\n Enterprise, or Bitbucket. If this is set and you use a different source provider, an\n invalidInputException is thrown.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " } }, "buildStatusConfig": { @@ -4298,10 +4298,10 @@ "smithy.api#documentation": "

Contains information that defines how the build project reports the build status to\n the source provider. This option is only used when the source provider is\n GITHUB, GITHUB_ENTERPRISE, or\n BITBUCKET.

" } }, - "sourceIdentifier": { + "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

An identifier for this project source.

" + "smithy.api#documentation": "

Information about the location of the source code to be built. Valid values\n include:

\n " } }, "gitCloneDepth": { @@ -4310,6 +4310,12 @@ "smithy.api#documentation": "

Information about the Git clone depth for the build project.

" } }, + "gitSubmodulesConfig": { + "target": "com.amazonaws.codebuild#GitSubmodulesConfig", + "traits": { + "smithy.api#documentation": "

Information about the Git submodules configuration for the build project.

" + } + }, "type": { "target": "com.amazonaws.codebuild#SourceType", "traits": { @@ -4325,17 +4331,17 @@ "com.amazonaws.codebuild#ProjectSourceVersion": { "type": "structure", "members": { - "sourceVersion": { + "sourceIdentifier": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The source version for the corresponding source identifier. If specified, must be one\n of:

\n \n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

", + "smithy.api#documentation": "

An identifier for a source in the build project.

", "smithy.api#required": {} } }, - "sourceIdentifier": { + "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

An identifier for a source in the build project.

", + "smithy.api#documentation": "

The source version for the corresponding source identifier. If specified, must be one\n of:

\n \n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

", "smithy.api#required": {} } } @@ -4437,40 +4443,22 @@ "com.amazonaws.codebuild#Report": { "type": "structure", "members": { - "testSummary": { - "target": "com.amazonaws.codebuild#TestReportSummary", - "traits": { - "smithy.api#documentation": "

A TestReportSummary object that contains information about this test\n report.

" - } - }, - "status": { - "target": "com.amazonaws.codebuild#ReportStatusType", - "traits": { - "smithy.api#documentation": "

The status of this report.

" - } - }, - "type": { - "target": "com.amazonaws.codebuild#ReportType", - "traits": { - "smithy.api#documentation": "

The type of the report that was run.

\n
\n
CODE_COVERAGE
\n
\n

A code coverage report.

\n
\n
TEST
\n
\n

A test report.

\n
\n
" - } - }, "executionId": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

The ARN of the build run that generated this report.

" } }, - "truncated": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "expired": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

A boolean that specifies if this report run is truncated. The list of test cases is\n truncated after the maximum number of test cases is reached.

" + "smithy.api#documentation": "

The date and time a report expires. A report expires 30 days after it is created. An\n expired report is not available to view in CodeBuild.

" } }, - "arn": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "exportConfig": { + "target": "com.amazonaws.codebuild#ReportExportConfig", "traits": { - "smithy.api#documentation": "

The ARN of the report run.

" + "smithy.api#documentation": "

Information about where the raw data used to generate this report was exported.\n

" } }, "reportGroupArn": { @@ -4479,6 +4467,18 @@ "smithy.api#documentation": "

The ARN of the report group associated with this report.

" } }, + "testSummary": { + "target": "com.amazonaws.codebuild#TestReportSummary", + "traits": { + "smithy.api#documentation": "

A TestReportSummary object that contains information about this test\n report.

" + } + }, + "truncated": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

A boolean that specifies if this report run is truncated. The list of test cases is\n truncated after the maximum number of test cases is reached.

" + } + }, "created": { "target": "com.amazonaws.codebuild#Timestamp", "traits": { @@ -4491,22 +4491,28 @@ "smithy.api#documentation": "

A CodeCoverageReportSummary object that contains a code coverage summary for\n this report.

" } }, - "name": { - "target": "com.amazonaws.codebuild#String", + "status": { + "target": "com.amazonaws.codebuild#ReportStatusType", "traits": { - "smithy.api#documentation": "

The name of the report that was run.

" + "smithy.api#documentation": "

The status of this report.

" } }, - "expired": { - "target": "com.amazonaws.codebuild#Timestamp", + "type": { + "target": "com.amazonaws.codebuild#ReportType", "traits": { - "smithy.api#documentation": "

The date and time a report expires. A report expires 30 days after it is created. An\n expired report is not available to view in CodeBuild.

" + "smithy.api#documentation": "

The type of the report that was run.

\n
\n
CODE_COVERAGE
\n
\n

A code coverage report.

\n
\n
TEST
\n
\n

A test report.

\n
\n
" } }, - "exportConfig": { - "target": "com.amazonaws.codebuild#ReportExportConfig", + "arn": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about where the raw data used to generate this report was exported.\n

" + "smithy.api#documentation": "

The ARN of the report run.

" + } + }, + "name": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The name of the report that was run.

" } } }, @@ -4593,16 +4599,10 @@ "com.amazonaws.codebuild#ReportGroup": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.codebuild#ReportType", - "traits": { - "smithy.api#documentation": "

The type of the ReportGroup. The one valid value is TEST.\n

" - } - }, - "tags": { - "target": "com.amazonaws.codebuild#TagList", + "exportConfig": { + "target": "com.amazonaws.codebuild#ReportExportConfig", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this report group.

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + "smithy.api#documentation": "

Information about the destination where the raw data of this ReportGroup\n is exported.

" } }, "created": { @@ -4611,6 +4611,12 @@ "smithy.api#documentation": "

The date and time this ReportGroup was created.

" } }, + "name": { + "target": "com.amazonaws.codebuild#ReportGroupName", + "traits": { + "smithy.api#documentation": "

The name of a ReportGroup.

" + } + }, "arn": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { @@ -4623,16 +4629,16 @@ "smithy.api#documentation": "

The date and time this ReportGroup was last modified.

" } }, - "name": { - "target": "com.amazonaws.codebuild#ReportGroupName", + "tags": { + "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

The name of a ReportGroup.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this report group.

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" } }, - "exportConfig": { - "target": "com.amazonaws.codebuild#ReportExportConfig", + "type": { + "target": "com.amazonaws.codebuild#ReportType", "traits": { - "smithy.api#documentation": "

Information about the destination where the raw data of this ReportGroup\n is exported.

" + "smithy.api#documentation": "

The type of the ReportGroup. The one valid value is TEST.\n

" } } }, @@ -4872,12 +4878,6 @@ "com.amazonaws.codebuild#RetryBuildBatchInput": { "type": "structure", "members": { - "idempotencyToken": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuildBatch request. The token is included in the\n RetryBuildBatch request and is valid for five minutes. If you repeat\n the RetryBuildBatch request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" - } - }, "retryType": { "target": "com.amazonaws.codebuild#RetryBuildBatchType", "traits": { @@ -4889,6 +4889,12 @@ "traits": { "smithy.api#documentation": "

Specifies the identifier of the batch build to restart.

" } + }, + "idempotencyToken": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuildBatch request. The token is included in the\n RetryBuildBatch request and is valid for five minutes. If you repeat\n the RetryBuildBatch request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" + } } } }, @@ -4918,17 +4924,17 @@ "com.amazonaws.codebuild#RetryBuildInput": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.codebuild#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the identifier of the build to restart.

" - } - }, "idempotencyToken": { "target": "com.amazonaws.codebuild#String", "traits": { "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuild request. The token is included in the\n RetryBuild request and is valid for five minutes. If you repeat\n the RetryBuild request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" } + }, + "id": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the identifier of the build to restart.

" + } } } }, @@ -4943,12 +4949,6 @@ "com.amazonaws.codebuild#S3LogsConfig": { "type": "structure", "members": { - "encryptionDisabled": { - "target": "com.amazonaws.codebuild#WrapperBoolean", - "traits": { - "smithy.api#documentation": "

Set to true if you do not want your S3 build log output encrypted. By default S3\n build logs are encrypted.

" - } - }, "status": { "target": "com.amazonaws.codebuild#LogsConfigStatusType", "traits": { @@ -4956,6 +4956,12 @@ "smithy.api#required": {} } }, + "encryptionDisabled": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

Set to true if you do not want your S3 build log output encrypted. By default S3\n build logs are encrypted.

" + } + }, "location": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -4970,12 +4976,6 @@ "com.amazonaws.codebuild#S3ReportExportConfig": { "type": "structure", "members": { - "packaging": { - "target": "com.amazonaws.codebuild#ReportPackagingType", - "traits": { - "smithy.api#documentation": "

The type of build output artifact to create. Valid values include:

\n " - } - }, "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { @@ -4988,16 +4988,22 @@ "smithy.api#documentation": "

The name of the S3 bucket where the raw data of a report are exported.

" } }, + "path": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The path to the exported report's raw data results.

" + } + }, "encryptionDisabled": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { "smithy.api#documentation": "

A boolean value that specifies if the results of a report are encrypted.

" } }, - "path": { - "target": "com.amazonaws.codebuild#String", + "packaging": { + "target": "com.amazonaws.codebuild#ReportPackagingType", "traits": { - "smithy.api#documentation": "

The path to the exported report's raw data results.

" + "smithy.api#documentation": "

The type of build output artifact to create. Valid values include:

\n " } } }, @@ -5078,18 +5084,18 @@ "com.amazonaws.codebuild#SourceAuth": { "type": "structure", "members": { - "resource": { - "target": "com.amazonaws.codebuild#String", - "traits": { - "smithy.api#documentation": "

The resource value that applies to the specified authorization type.

" - } - }, "type": { "target": "com.amazonaws.codebuild#SourceAuthType", "traits": { "smithy.api#documentation": "\n

This data type is deprecated and is no longer accurate or used.

\n \n

The authorization type to use. The only valid value is OAUTH, which\n represents the OAuth authorization type.

", "smithy.api#required": {} } + }, + "resource": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

The resource value that applies to the specified authorization type.

" + } } }, "traits": { @@ -5110,6 +5116,12 @@ "com.amazonaws.codebuild#SourceCredentialsInfo": { "type": "structure", "members": { + "authType": { + "target": "com.amazonaws.codebuild#AuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication used by the credentials. Valid options are OAUTH,\n BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

" + } + }, "serverType": { "target": "com.amazonaws.codebuild#ServerType", "traits": { @@ -5121,12 +5133,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the token.

" } - }, - "authType": { - "target": "com.amazonaws.codebuild#AuthType", - "traits": { - "smithy.api#documentation": "

The type of authentication used by the credentials. Valid options are OAUTH,\n BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

" - } } }, "traits": { @@ -5220,16 +5226,22 @@ "com.amazonaws.codebuild#StartBuildBatchInput": { "type": "structure", "members": { - "encryptionKeyOverride": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "logsConfigOverride": { + "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/alias-name\n ).

" + "smithy.api#documentation": "

A LogsConfig object that override the log settings defined in the batch build\n project.

" } }, - "certificateOverride": { + "sourceAuthOverride": { + "target": "com.amazonaws.codebuild#SourceAuth", + "traits": { + "smithy.api#documentation": "

A SourceAuth object that overrides the one defined in the batch build\n project. This override applies only if the build project's source is BitBucket or\n GitHub.

" + } + }, + "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The name of a certificate for this batch build that overrides the one specified in the batch build\n project.

" + "smithy.api#documentation": "

The version of the batch build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon Simple Storage Service (Amazon S3)
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" } }, "buildspecOverride": { @@ -5238,16 +5250,22 @@ "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, - "sourceVersion": { - "target": "com.amazonaws.codebuild#String", + "queuedTimeoutInMinutesOverride": { + "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

The version of the batch build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon Simple Storage Service (Amazon S3)
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The number of minutes a batch build is allowed to be queued before it times out.

" } }, - "artifactsOverride": { - "target": "com.amazonaws.codebuild#ProjectArtifacts", + "secondarySourcesOverride": { + "target": "com.amazonaws.codebuild#ProjectSources", "traits": { - "smithy.api#documentation": "

An array of ProjectArtifacts objects that contains information about the\n build output artifact overrides for the build project.

" + "smithy.api#documentation": "

An array of ProjectSource objects that override the secondary sources\n defined in the batch build project.

" + } + }, + "sourceTypeOverride": { + "target": "com.amazonaws.codebuild#SourceType", + "traits": { + "smithy.api#documentation": "

The source input type that overrides the source input defined in the batch\n build project.

" } }, "idempotencyToken": { @@ -5256,10 +5274,16 @@ "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuildBatch request. The token is included in the\n StartBuildBatch request and is valid for five minutes. If you repeat\n the StartBuildBatch request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" } }, - "reportBuildBatchStatusOverride": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "certificateOverride": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Set to true to report to your source provider the status of a batch build's\n start and completion. If you use this option with a source provider other than GitHub,\n GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " + "smithy.api#documentation": "

The name of a certificate for this batch build that overrides the one specified in the batch build\n project.

" + } + }, + "sourceLocationOverride": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

A location that overrides, for this batch build, the source location defined in\n the batch build project.

" } }, "secondaryArtifactsOverride": { @@ -5268,59 +5292,52 @@ "smithy.api#documentation": "

An array of ProjectArtifacts objects that override the secondary artifacts\n defined in the batch build project.

" } }, - "insecureSslOverride": { + "reportBuildBatchStatusOverride": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Enable this flag to override the insecure SSL setting that is specified in the batch build\n project. The insecure SSL setting determines whether to ignore SSL warnings while\n connecting to the project source code. This override applies only if the build's source\n is GitHub Enterprise.

" - } - }, - "gitSubmodulesConfigOverride": { - "target": "com.amazonaws.codebuild#GitSubmodulesConfig", - "traits": { - "smithy.api#documentation": "

A GitSubmodulesConfig object that overrides the Git submodules configuration\n for this batch build.

" + "smithy.api#documentation": "

Set to true to report to your source provider the status of a batch build's\n start and completion. If you use this option with a source provider other than GitHub,\n GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " } }, - "buildBatchConfigOverride": { - "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig", + "imagePullCredentialsTypeOverride": { + "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

A BuildBatchConfigOverride object that contains batch build configuration\n overrides.

" + "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" } }, - "secondarySourcesVersionOverride": { - "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "imageOverride": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects that override the secondary source\n versions in the batch build project.

" + "smithy.api#documentation": "

The name of an image for this batch build that overrides the one specified in the batch\n build project.

" } }, - "secondarySourcesOverride": { - "target": "com.amazonaws.codebuild#ProjectSources", + "buildBatchConfigOverride": { + "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig", "traits": { - "smithy.api#documentation": "

An array of ProjectSource objects that override the secondary sources\n defined in the batch build project.

" + "smithy.api#documentation": "

A BuildBatchConfigOverride object that contains batch build configuration\n overrides.

" } }, - "gitCloneDepthOverride": { - "target": "com.amazonaws.codebuild#GitCloneDepth", + "privilegedModeOverride": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

The user-defined depth of history, with a minimum value of 0, that overrides, for this\n batch build only, any previous depth of history defined in the batch build project.

" + "smithy.api#documentation": "

Enable this flag to override privileged mode in the batch build project.

" } }, - "projectName": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "secondarySourcesVersionOverride": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

The name of the project.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of ProjectSourceVersion objects that override the secondary source\n versions in the batch build project.

" } }, - "sourceAuthOverride": { - "target": "com.amazonaws.codebuild#SourceAuth", + "environmentVariablesOverride": { + "target": "com.amazonaws.codebuild#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

A SourceAuth object that overrides the one defined in the batch build\n project. This override applies only if the build project's source is BitBucket or\n GitHub.

" + "smithy.api#documentation": "

An array of EnvironmentVariable objects that override, or add to, the\n environment variables defined in the batch build project.

" } }, - "registryCredentialOverride": { - "target": "com.amazonaws.codebuild#RegistryCredential", + "insecureSslOverride": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

A RegistryCredential object that overrides credentials for access to a\n private registry.

" + "smithy.api#documentation": "

Enable this flag to override the insecure SSL setting that is specified in the batch build\n project. The insecure SSL setting determines whether to ignore SSL warnings while\n connecting to the project source code. This override applies only if the build's source\n is GitHub Enterprise.

" } }, "buildTimeoutInMinutesOverride": { @@ -5329,34 +5346,23 @@ "smithy.api#documentation": "

Overrides the build timeout specified in the batch build project.

" } }, - "environmentTypeOverride": { - "target": "com.amazonaws.codebuild#EnvironmentType", - "traits": { - "smithy.api#documentation": "

A container type for this batch build that overrides the one specified in the batch build\n project.

" - } - }, - "computeTypeOverride": { - "target": "com.amazonaws.codebuild#ComputeType", - "traits": { - "smithy.api#documentation": "

The name of a compute type for this batch build that overrides the one specified in the\n batch build project.

" - } - }, - "privilegedModeOverride": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "serviceRoleOverride": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Enable this flag to override privileged mode in the batch build project.

" + "smithy.api#documentation": "

The name of a service role for this batch build that overrides the one specified in the\n batch build project.

" } }, - "imageOverride": { + "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of an image for this batch build that overrides the one specified in the batch\n build project.

" + "smithy.api#documentation": "

The name of the project.

", + "smithy.api#required": {} } }, - "serviceRoleOverride": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "registryCredentialOverride": { + "target": "com.amazonaws.codebuild#RegistryCredential", "traits": { - "smithy.api#documentation": "

The name of a service role for this batch build that overrides the one specified in the\n batch build project.

" + "smithy.api#documentation": "

A RegistryCredential object that overrides credentials for access to a\n private registry.

" } }, "cacheOverride": { @@ -5365,40 +5371,40 @@ "smithy.api#documentation": "

A ProjectCache object that specifies cache overrides.

" } }, - "imagePullCredentialsTypeOverride": { - "target": "com.amazonaws.codebuild#ImagePullCredentialsType", + "gitSubmodulesConfigOverride": { + "target": "com.amazonaws.codebuild#GitSubmodulesConfig", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" + "smithy.api#documentation": "

A GitSubmodulesConfig object that overrides the Git submodules configuration\n for this batch build.

" } }, - "queuedTimeoutInMinutesOverride": { - "target": "com.amazonaws.codebuild#TimeOut", + "gitCloneDepthOverride": { + "target": "com.amazonaws.codebuild#GitCloneDepth", "traits": { - "smithy.api#documentation": "

The number of minutes a batch build is allowed to be queued before it times out.

" + "smithy.api#documentation": "

The user-defined depth of history, with a minimum value of 0, that overrides, for this\n batch build only, any previous depth of history defined in the batch build project.

" } }, - "sourceLocationOverride": { - "target": "com.amazonaws.codebuild#String", + "computeTypeOverride": { + "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "

A location that overrides, for this batch build, the source location defined in\n the batch build project.

" + "smithy.api#documentation": "

The name of a compute type for this batch build that overrides the one specified in the\n batch build project.

" } }, - "logsConfigOverride": { - "target": "com.amazonaws.codebuild#LogsConfig", + "artifactsOverride": { + "target": "com.amazonaws.codebuild#ProjectArtifacts", "traits": { - "smithy.api#documentation": "

A LogsConfig object that override the log settings defined in the batch build\n project.

" + "smithy.api#documentation": "

An array of ProjectArtifacts objects that contains information about the\n build output artifact overrides for the build project.

" } }, - "sourceTypeOverride": { - "target": "com.amazonaws.codebuild#SourceType", + "environmentTypeOverride": { + "target": "com.amazonaws.codebuild#EnvironmentType", "traits": { - "smithy.api#documentation": "

The source input type that overrides the source input defined in the batch\n build project.

" + "smithy.api#documentation": "

A container type for this batch build that overrides the one specified in the batch build\n project.

" } }, - "environmentVariablesOverride": { - "target": "com.amazonaws.codebuild#EnvironmentVariables", + "encryptionKeyOverride": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that override, or add to, the\n environment variables defined in the batch build project.

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } } } @@ -5417,10 +5423,16 @@ "com.amazonaws.codebuild#StartBuildInput": { "type": "structure", "members": { - "logsConfigOverride": { - "target": "com.amazonaws.codebuild#LogsConfig", + "sourceLocationOverride": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Log settings for this build that override the log settings defined in the build\n project.

" + "smithy.api#documentation": "

A location that overrides, for this build, the source location for the one defined in\n the build project.

" + } + }, + "reportBuildStatusOverride": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

Set to true to report to your source provider the status of a build's start and\n completion. If you use this option with a source provider other than GitHub, GitHub\n Enterprise, or Bitbucket, an invalidInputException is thrown.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " } }, "queuedTimeoutInMinutesOverride": { @@ -5429,95 +5441,94 @@ "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" } }, - "reportBuildStatusOverride": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "logsConfigOverride": { + "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Set to true to report to your source provider the status of a build's start and\n completion. If you use this option with a source provider other than GitHub, GitHub\n Enterprise, or Bitbucket, an invalidInputException is thrown.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " + "smithy.api#documentation": "

Log settings for this build that override the log settings defined in the build\n project.

" } }, - "sourceVersion": { - "target": "com.amazonaws.codebuild#String", + "sourceAuthOverride": { + "target": "com.amazonaws.codebuild#SourceAuth", "traits": { - "smithy.api#documentation": "

The version of the build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon Simple Storage Service (Amazon S3)
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

An authorization type for this build that overrides the one defined in the build\n project. This override applies only if the build project's source is BitBucket or\n GitHub.

" } }, - "encryptionKeyOverride": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "idempotencyToken": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/alias-name\n ).

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuild request. The token is included in the StartBuild request and is valid for 5\n minutes. If you repeat the StartBuild request with the same token, but change a\n parameter, AWS CodeBuild returns a parameter mismatch error.

" } }, - "artifactsOverride": { - "target": "com.amazonaws.codebuild#ProjectArtifacts", + "gitSubmodulesConfigOverride": { + "target": "com.amazonaws.codebuild#GitSubmodulesConfig", "traits": { - "smithy.api#documentation": "

Build output artifact settings that override, for this build only, the latest ones\n already defined in the build project.

" + "smithy.api#documentation": "

Information about the Git submodules configuration for this build of an AWS CodeBuild build\n project.

" } }, - "gitCloneDepthOverride": { - "target": "com.amazonaws.codebuild#GitCloneDepth", + "certificateOverride": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The user-defined depth of history, with a minimum value of 0, that overrides, for this\n build only, any previous depth of history defined in the build project.

" + "smithy.api#documentation": "

The name of a certificate for this build that overrides the one specified in the build\n project.

" } }, - "secondaryArtifactsOverride": { - "target": "com.amazonaws.codebuild#ProjectArtifactsList", + "serviceRoleOverride": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of ProjectArtifacts objects.

" + "smithy.api#documentation": "

The name of a service role for this build that overrides the one specified in the\n build project.

" } }, - "projectName": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "buildspecOverride": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild build project to start running a build.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, - "secondarySourcesVersionOverride": { - "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "buildStatusConfigOverride": { + "target": "com.amazonaws.codebuild#BuildStatusConfig", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects that specify one or more\n versions of the project's secondary sources to be used for this build only.

" + "smithy.api#documentation": "

Contains information that defines how the build project reports the build status to\n the source provider. This option is only used when the source provider is\n GITHUB, GITHUB_ENTERPRISE, or\n BITBUCKET.

" } }, - "insecureSslOverride": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "environmentVariablesOverride": { + "target": "com.amazonaws.codebuild#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

Enable this flag to override the insecure SSL setting that is specified in the build\n project. The insecure SSL setting determines whether to ignore SSL warnings while\n connecting to the project source code. This override applies only if the build's source\n is GitHub Enterprise.

" + "smithy.api#documentation": "

A set of environment variables that overrides, for this build only, the latest ones\n already defined in the build project.

" } }, - "registryCredentialOverride": { - "target": "com.amazonaws.codebuild#RegistryCredential", + "imagePullCredentialsTypeOverride": { + "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

The credentials for access to a private registry.

" + "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" } }, - "sourceAuthOverride": { - "target": "com.amazonaws.codebuild#SourceAuth", + "sourceTypeOverride": { + "target": "com.amazonaws.codebuild#SourceType", "traits": { - "smithy.api#documentation": "

An authorization type for this build that overrides the one defined in the build\n project. This override applies only if the build project's source is BitBucket or\n GitHub.

" + "smithy.api#documentation": "

A source input type, for this build, that overrides the source input defined in the\n build project.

" } }, - "secondarySourcesOverride": { - "target": "com.amazonaws.codebuild#ProjectSources", + "timeoutInMinutesOverride": { + "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

An array of ProjectSource objects.

" + "smithy.api#documentation": "

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this\n build only, the latest setting already defined in the build project.

" } }, - "buildspecOverride": { - "target": "com.amazonaws.codebuild#String", + "debugSessionEnabled": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

Specifies if session debugging is enabled for this build. For more information, see\n Viewing a running build in Session Manager.

" } }, - "gitSubmodulesConfigOverride": { - "target": "com.amazonaws.codebuild#GitSubmodulesConfig", + "imageOverride": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about the Git submodules configuration for this build of an AWS CodeBuild build\n project.

" + "smithy.api#documentation": "

The name of an image for this build that overrides the one specified in the build\n project.

" } }, - "idempotencyToken": { + "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuild request. The token is included in the StartBuild request and is valid for 5\n minutes. If you repeat the StartBuild request with the same token, but change a\n parameter, AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

The version of the build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon Simple Storage Service (Amazon S3)
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" } }, "privilegedModeOverride": { @@ -5526,82 +5537,77 @@ "smithy.api#documentation": "

Enable this flag to override privileged mode in the build project.

" } }, - "cacheOverride": { - "target": "com.amazonaws.codebuild#ProjectCache", - "traits": { - "smithy.api#documentation": "

A ProjectCache object specified for this build that overrides the one defined in the\n build project.

" - } - }, - "computeTypeOverride": { - "target": "com.amazonaws.codebuild#ComputeType", + "secondaryArtifactsOverride": { + "target": "com.amazonaws.codebuild#ProjectArtifactsList", "traits": { - "smithy.api#documentation": "

The name of a compute type for this build that overrides the one specified in the\n build project.

" + "smithy.api#documentation": "

An array of ProjectArtifacts objects.

" } }, - "imageOverride": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "insecureSslOverride": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

The name of an image for this build that overrides the one specified in the build\n project.

" + "smithy.api#documentation": "

Enable this flag to override the insecure SSL setting that is specified in the build\n project. The insecure SSL setting determines whether to ignore SSL warnings while\n connecting to the project source code. This override applies only if the build's source\n is GitHub Enterprise.

" } }, - "debugSessionEnabled": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "cacheOverride": { + "target": "com.amazonaws.codebuild#ProjectCache", "traits": { - "smithy.api#documentation": "

Specifies if session debugging is enabled for this build. For more information, see\n Viewing a running build in Session Manager.

" + "smithy.api#documentation": "

A ProjectCache object specified for this build that overrides the one defined in the\n build project.

" } }, - "environmentTypeOverride": { - "target": "com.amazonaws.codebuild#EnvironmentType", + "secondarySourcesVersionOverride": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

A container type for this build that overrides the one specified in the build\n project.

" + "smithy.api#documentation": "

An array of ProjectSourceVersion objects that specify one or more\n versions of the project's secondary sources to be used for this build only.

" } }, - "imagePullCredentialsTypeOverride": { - "target": "com.amazonaws.codebuild#ImagePullCredentialsType", + "artifactsOverride": { + "target": "com.amazonaws.codebuild#ProjectArtifacts", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" + "smithy.api#documentation": "

Build output artifact settings that override, for this build only, the latest ones\n already defined in the build project.

" } }, - "timeoutInMinutesOverride": { - "target": "com.amazonaws.codebuild#TimeOut", + "gitCloneDepthOverride": { + "target": "com.amazonaws.codebuild#GitCloneDepth", "traits": { - "smithy.api#documentation": "

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this\n build only, the latest setting already defined in the build project.

" + "smithy.api#documentation": "

The user-defined depth of history, with a minimum value of 0, that overrides, for this\n build only, any previous depth of history defined in the build project.

" } }, - "serviceRoleOverride": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "registryCredentialOverride": { + "target": "com.amazonaws.codebuild#RegistryCredential", "traits": { - "smithy.api#documentation": "

The name of a service role for this build that overrides the one specified in the\n build project.

" + "smithy.api#documentation": "

The credentials for access to a private registry.

" } }, - "buildStatusConfigOverride": { - "target": "com.amazonaws.codebuild#BuildStatusConfig", + "projectName": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Contains information that defines how the build project reports the build status to\n the source provider. This option is only used when the source provider is\n GITHUB, GITHUB_ENTERPRISE, or\n BITBUCKET.

" + "smithy.api#documentation": "

The name of the AWS CodeBuild build project to start running a build.

", + "smithy.api#required": {} } }, - "certificateOverride": { - "target": "com.amazonaws.codebuild#String", + "secondarySourcesOverride": { + "target": "com.amazonaws.codebuild#ProjectSources", "traits": { - "smithy.api#documentation": "

The name of a certificate for this build that overrides the one specified in the build\n project.

" + "smithy.api#documentation": "

An array of ProjectSource objects.

" } }, - "sourceTypeOverride": { - "target": "com.amazonaws.codebuild#SourceType", + "encryptionKeyOverride": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

A source input type, for this build, that overrides the source input defined in the\n build project.

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, - "environmentVariablesOverride": { - "target": "com.amazonaws.codebuild#EnvironmentVariables", + "environmentTypeOverride": { + "target": "com.amazonaws.codebuild#EnvironmentType", "traits": { - "smithy.api#documentation": "

A set of environment variables that overrides, for this build only, the latest ones\n already defined in the build project.

" + "smithy.api#documentation": "

A container type for this build that overrides the one specified in the build\n project.

" } }, - "sourceLocationOverride": { - "target": "com.amazonaws.codebuild#String", + "computeTypeOverride": { + "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "

A location that overrides, for this build, the source location for the one defined in\n the build project.

" + "smithy.api#documentation": "

The name of a compute type for this build that overrides the one specified in the\n build project.

" } } } @@ -5781,16 +5787,10 @@ "com.amazonaws.codebuild#TestCase": { "type": "structure", "members": { - "reportArn": { - "target": "com.amazonaws.codebuild#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ARN of the report to which the test case belongs.

" - } - }, - "name": { - "target": "com.amazonaws.codebuild#String", + "durationInNanoSeconds": { + "target": "com.amazonaws.codebuild#WrapperLong", "traits": { - "smithy.api#documentation": "

The name of the test case.

" + "smithy.api#documentation": "

The number of nanoseconds it took to run this test case.

" } }, "status": { @@ -5799,16 +5799,16 @@ "smithy.api#documentation": "

The status returned by the test case after it was run. Valid statuses are\n SUCCEEDED, FAILED, ERROR,\n SKIPPED, and UNKNOWN.

" } }, - "durationInNanoSeconds": { - "target": "com.amazonaws.codebuild#WrapperLong", + "reportArn": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The number of nanoseconds it took to run this test case.

" + "smithy.api#documentation": "

The ARN of the report to which the test case belongs.

" } }, - "message": { + "testRawDataPath": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A message associated with a test case. For example, an error message or stack trace.\n

" + "smithy.api#documentation": "

The path to the raw data file that contains the test result.

" } }, "prefix": { @@ -5817,16 +5817,22 @@ "smithy.api#documentation": "

A string that is applied to a series of related test cases. CodeBuild generates the\n prefix. The prefix depends on the framework used to generate the tests.

" } }, - "testRawDataPath": { + "expired": { + "target": "com.amazonaws.codebuild#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time a test case expires. A test case expires 30 days after it is\n created. An expired test case is not available to view in CodeBuild.

" + } + }, + "message": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The path to the raw data file that contains the test result.

" + "smithy.api#documentation": "

A message associated with a test case. For example, an error message or stack trace.\n

" } }, - "expired": { - "target": "com.amazonaws.codebuild#Timestamp", + "name": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The date and time a test case expires. A test case expires 30 days after it is\n created. An expired test case is not available to view in CodeBuild.

" + "smithy.api#documentation": "

The name of the test case.

" } } }, @@ -5840,12 +5846,18 @@ "status": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The status used to filter test cases. Valid statuses are SUCCEEDED,\n FAILED, ERROR, SKIPPED, and\n UNKNOWN. A TestCaseFilter can have one status.

" + "smithy.api#documentation": "

The status used to filter test cases. A TestCaseFilter can have one\n status. Valid values are:

\n " + } + }, + "keyword": { + "target": "com.amazonaws.codebuild#String", + "traits": { + "smithy.api#documentation": "

A keyword that is used to filter on the name or the prefix\n of the test cases. Only test cases where the keyword is a substring of the\n name or the prefix will be returned.

" } } }, "traits": { - "smithy.api#documentation": "

A filter used to return specific types of test cases.

" + "smithy.api#documentation": "

A filter used to return specific types of test cases. In order to pass the filter, the\n report must meet all of the filter properties.

" } }, "com.amazonaws.codebuild#TestCases": { @@ -5857,6 +5869,13 @@ "com.amazonaws.codebuild#TestReportSummary": { "type": "structure", "members": { + "total": { + "target": "com.amazonaws.codebuild#WrapperInt", + "traits": { + "smithy.api#documentation": "

The number of test cases in this TestReportSummary. The total includes\n truncated test cases.

", + "smithy.api#required": {} + } + }, "durationInNanoSeconds": { "target": "com.amazonaws.codebuild#WrapperLong", "traits": { @@ -5870,13 +5889,6 @@ "smithy.api#documentation": "

A map that contains the number of each type of status returned by the test results in\n this TestReportSummary.

", "smithy.api#required": {} } - }, - "total": { - "target": "com.amazonaws.codebuild#WrapperInt", - "traits": { - "smithy.api#documentation": "

The number of test cases in this TestReportSummary. The total includes\n truncated test cases.

", - "smithy.api#required": {} - } } }, "traits": { @@ -5919,35 +5931,26 @@ "com.amazonaws.codebuild#UpdateProjectInput": { "type": "structure", "members": { - "encryptionKey": { - "target": "com.amazonaws.codebuild#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/alias-name\n ).

" - } - }, - "sourceVersion": { - "target": "com.amazonaws.codebuild#String", + "cache": { + "target": "com.amazonaws.codebuild#ProjectCache", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

Stores recently used information so that it can be quickly accessed at a later\n time.

" } }, - "secondarySourceVersions": { - "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", + "artifacts": { + "target": "com.amazonaws.codebuild#ProjectArtifacts", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. If\n secondarySourceVersions is specified at the build level, then they take\n over these secondarySourceVersions (at the project level).

" + "smithy.api#documentation": "

Information to be changed about the build output artifacts for the build\n project.

" } }, - "description": { - "target": "com.amazonaws.codebuild#ProjectDescription", + "tags": { + "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

A new or replacement description of the build project.

" + "smithy.api#documentation": "

An updated list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" } }, - "cache": { - "target": "com.amazonaws.codebuild#ProjectCache", - "traits": { - "smithy.api#documentation": "

Stores recently used information so that it can be quickly accessed at a later\n time.

" - } + "buildBatchConfig": { + "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig" }, "secondarySources": { "target": "com.amazonaws.codebuild#ProjectSources", @@ -5955,34 +5958,29 @@ "smithy.api#documentation": "

An array of ProjectSource objects.

" } }, - "source": { - "target": "com.amazonaws.codebuild#ProjectSource", - "traits": { - "smithy.api#documentation": "

Information to be changed about the build input source code for the build\n project.

" - } - }, "fileSystemLocations": { "target": "com.amazonaws.codebuild#ProjectFileSystemLocations", "traits": { "smithy.api#documentation": "

\n An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object \n specifies the identifier, location, mountOptions, \n mountPoint, and type of a file system created using Amazon Elastic File System.\n

" } }, - "secondaryArtifacts": { - "target": "com.amazonaws.codebuild#ProjectArtifactsList", + "serviceRole": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of ProjectSource objects.

" + "smithy.api#documentation": "

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent\n AWS services on behalf of the AWS account.

" } }, - "tags": { - "target": "com.amazonaws.codebuild#TagList", + "name": { + "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An updated list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

The name of the build project.

\n \n

You cannot change a build project's name.

\n ", + "smithy.api#required": {} } }, - "timeoutInMinutes": { - "target": "com.amazonaws.codebuild#TimeOut", + "badgeEnabled": { + "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before\n timing out any related build that did not get marked as completed.

" + "smithy.api#documentation": "

Set this to true to generate a publicly accessible URL for your project's build\n badge.

" } }, "queuedTimeoutInMinutes": { @@ -5991,6 +5989,12 @@ "smithy.api#documentation": "

The number of minutes a build is allowed to be queued before it times out.

" } }, + "logsConfig": { + "target": "com.amazonaws.codebuild#LogsConfig", + "traits": { + "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs,\n logs in an S3 bucket, or both.

" + } + }, "environment": { "target": "com.amazonaws.codebuild#ProjectEnvironment", "traits": { @@ -6003,38 +6007,46 @@ "smithy.api#documentation": "

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" } }, - "serviceRole": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "timeoutInMinutes": { + "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent\n AWS services on behalf of the AWS account.

" + "smithy.api#documentation": "

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before\n timing out any related build that did not get marked as completed.

" } }, - "logsConfig": { - "target": "com.amazonaws.codebuild#LogsConfig", + "source": { + "target": "com.amazonaws.codebuild#ProjectSource", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs,\n logs in an S3 bucket, or both.

" + "smithy.api#documentation": "

Information to be changed about the build input source code for the build\n project.

" } }, - "buildBatchConfig": { - "target": "com.amazonaws.codebuild#ProjectBuildBatchConfig" + "secondaryArtifacts": { + "target": "com.amazonaws.codebuild#ProjectArtifactsList", + "traits": { + "smithy.api#documentation": "

An array of ProjectSource objects.

" + } }, - "artifacts": { - "target": "com.amazonaws.codebuild#ProjectArtifacts", + "sourceVersion": { + "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Information to be changed about the build output artifacts for the build\n project.

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" } }, - "name": { + "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the build project.

\n \n

You cannot change a build project's name.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, - "badgeEnabled": { - "target": "com.amazonaws.codebuild#WrapperBoolean", + "secondarySourceVersions": { + "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

Set this to true to generate a publicly accessible URL for your project's build\n badge.

" + "smithy.api#documentation": "

An array of ProjectSourceVersion objects. If\n secondarySourceVersions is specified at the build level, then they take\n over these secondarySourceVersions (at the project level).

" + } + }, + "description": { + "target": "com.amazonaws.codebuild#ProjectDescription", + "traits": { + "smithy.api#documentation": "

A new or replacement description of the build project.

" } } } @@ -6073,12 +6085,6 @@ "com.amazonaws.codebuild#UpdateReportGroupInput": { "type": "structure", "members": { - "exportConfig": { - "target": "com.amazonaws.codebuild#ReportExportConfig", - "traits": { - "smithy.api#documentation": "

\n Used to specify an updated export type. Valid values are:\n

\n " - } - }, "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { @@ -6091,6 +6097,12 @@ "smithy.api#documentation": "

\n The ARN of the report group to update.\n

", "smithy.api#required": {} } + }, + "exportConfig": { + "target": "com.amazonaws.codebuild#ReportExportConfig", + "traits": { + "smithy.api#documentation": "

\n Used to specify an updated export type. Valid values are:\n

\n " + } } } }, @@ -6137,13 +6149,6 @@ "smithy.api#documentation": "

A boolean value that specifies whether the associated GitHub repository's secret\n token should be updated. If you use Bitbucket for your repository,\n rotateSecret is ignored.

" } }, - "projectName": { - "target": "com.amazonaws.codebuild#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

", - "smithy.api#required": {} - } - }, "branchFilter": { "target": "com.amazonaws.codebuild#String", "traits": { @@ -6161,6 +6166,13 @@ "traits": { "smithy.api#documentation": "

An array of arrays of WebhookFilter objects used to determine if a\n webhook event can trigger a build. A filter group must contain at least one\n EVENT\n WebhookFilter.

" } + }, + "projectName": { + "target": "com.amazonaws.codebuild#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the AWS CodeBuild project.

", + "smithy.api#required": {} + } } } }, @@ -6194,17 +6206,17 @@ "smithy.api#documentation": "

A list of one or more subnet IDs in your Amazon VPC.

" } }, - "securityGroupIds": { - "target": "com.amazonaws.codebuild#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

A list of one or more security groups IDs in your Amazon VPC.

" - } - }, "vpcId": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the Amazon VPC.

" } + }, + "securityGroupIds": { + "target": "com.amazonaws.codebuild#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of one or more security groups IDs in your Amazon VPC.

" + } } }, "traits": { @@ -6214,22 +6226,16 @@ "com.amazonaws.codebuild#Webhook": { "type": "structure", "members": { - "lastModifiedSecret": { - "target": "com.amazonaws.codebuild#Timestamp", - "traits": { - "smithy.api#documentation": "

A timestamp that indicates the last time a repository's secret token was modified.\n

" - } - }, - "secret": { + "url": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The secret token of the associated repository.

\n \n

A Bitbucket webhook does not support secret.

\n " + "smithy.api#documentation": "

The URL to the webhook.

" } }, - "url": { + "payloadUrl": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The URL to the webhook.

" + "smithy.api#documentation": "

The AWS CodeBuild endpoint where webhook events are sent.

" } }, "filterGroups": { @@ -6238,10 +6244,10 @@ "smithy.api#documentation": "

An array of arrays of WebhookFilter objects used to determine which\n webhooks are triggered. At least one WebhookFilter in the array must\n specify EVENT as its type.

\n

For a build to be triggered, at least one filter group in the\n filterGroups array must pass. For a filter group to pass, each of its\n filters must pass.

" } }, - "payloadUrl": { - "target": "com.amazonaws.codebuild#NonEmptyString", + "buildType": { + "target": "com.amazonaws.codebuild#WebhookBuildType", "traits": { - "smithy.api#documentation": "

The AWS CodeBuild endpoint where webhook events are sent.

" + "smithy.api#documentation": "

Specifies the type of build this webhook will trigger.

" } }, "branchFilter": { @@ -6250,10 +6256,16 @@ "smithy.api#documentation": "

A regular expression used to determine which repository branches are built when a\n webhook is triggered. If the name of a branch matches the regular expression, then it is\n built. If branchFilter is empty, then all branches are built.

\n \n

It is recommended that you use filterGroups instead of\n branchFilter.

\n " } }, - "buildType": { - "target": "com.amazonaws.codebuild#WebhookBuildType", + "lastModifiedSecret": { + "target": "com.amazonaws.codebuild#Timestamp", "traits": { - "smithy.api#documentation": "

Specifies the type of build this webhook will trigger.

" + "smithy.api#documentation": "

A timestamp that indicates the last time a repository's secret token was modified.\n

" + } + }, + "secret": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The secret token of the associated repository.

\n \n

A Bitbucket webhook does not support secret.

\n " } } }, diff --git a/codegen/sdk-codegen/aws-models/codecommit.2015-04-13.json b/codegen/sdk-codegen/aws-models/codecommit.2015-04-13.json index df561816ffbd..8b5d654a030d 100644 --- a/codegen/sdk-codegen/aws-models/codecommit.2015-04-13.json +++ b/codegen/sdk-codegen/aws-models/codecommit.2015-04-13.json @@ -79,12 +79,6 @@ "com.amazonaws.codecommit#ApprovalRule": { "type": "structure", "members": { - "creationDate": { - "target": "com.amazonaws.codecommit#CreationDate", - "traits": { - "smithy.api#documentation": "

The date the approval rule was created, in timestamp format.

" - } - }, "originApprovalRuleTemplate": { "target": "com.amazonaws.codecommit#OriginApprovalRuleTemplate", "traits": { @@ -97,16 +91,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule.

" } }, - "lastModifiedDate": { - "target": "com.amazonaws.codecommit#LastModifiedDate", - "traits": { - "smithy.api#documentation": "

The date the approval rule was most recently changed, in timestamp format.

" - } - }, - "approvalRuleName": { - "target": "com.amazonaws.codecommit#ApprovalRuleName", + "approvalRuleContent": { + "target": "com.amazonaws.codecommit#ApprovalRuleContent", "traits": { - "smithy.api#documentation": "

The name of the approval rule.

" + "smithy.api#documentation": "

The content of the approval rule.

" } }, "approvalRuleId": { @@ -115,10 +103,16 @@ "smithy.api#documentation": "

The system-generated ID of the approval rule.

" } }, - "approvalRuleContent": { - "target": "com.amazonaws.codecommit#ApprovalRuleContent", + "lastModifiedDate": { + "target": "com.amazonaws.codecommit#LastModifiedDate", "traits": { - "smithy.api#documentation": "

The content of the approval rule.

" + "smithy.api#documentation": "

The date the approval rule was most recently changed, in timestamp format.

" + } + }, + "approvalRuleName": { + "target": "com.amazonaws.codecommit#ApprovalRuleName", + "traits": { + "smithy.api#documentation": "

The name of the approval rule.

" } }, "ruleContentSha256": { @@ -126,6 +120,12 @@ "traits": { "smithy.api#documentation": "

The SHA-256 hash signature for the content of the approval rule.

" } + }, + "creationDate": { + "target": "com.amazonaws.codecommit#CreationDate", + "traits": { + "smithy.api#documentation": "

The date the approval rule was created, in timestamp format.

" + } } }, "traits": { @@ -262,10 +262,16 @@ "com.amazonaws.codecommit#ApprovalRuleTemplate": { "type": "structure", "members": { - "approvalRuleTemplateContent": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateContent", + "lastModifiedDate": { + "target": "com.amazonaws.codecommit#LastModifiedDate", "traits": { - "smithy.api#documentation": "

The content of the approval rule template.

" + "smithy.api#documentation": "

The date the approval rule template was most recently changed, in timestamp format.

" + } + }, + "approvalRuleTemplateName": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the approval rule template.

" } }, "approvalRuleTemplateDescription": { @@ -274,16 +280,16 @@ "smithy.api#documentation": "

The description of the approval rule template.

" } }, - "lastModifiedUser": { - "target": "com.amazonaws.codecommit#Arn", + "approvalRuleTemplateId": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule template.

" + "smithy.api#documentation": "

The system-generated ID of the approval rule template.

" } }, - "creationDate": { - "target": "com.amazonaws.codecommit#CreationDate", + "approvalRuleTemplateContent": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateContent", "traits": { - "smithy.api#documentation": "

The date the approval rule template was created, in timestamp format.

" + "smithy.api#documentation": "

The content of the approval rule template.

" } }, "ruleContentSha256": { @@ -292,22 +298,16 @@ "smithy.api#documentation": "

The SHA-256 hash signature for the content of the approval rule template.

" } }, - "approvalRuleTemplateId": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateId", - "traits": { - "smithy.api#documentation": "

The system-generated ID of the approval rule template.

" - } - }, - "approvalRuleTemplateName": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", + "lastModifiedUser": { + "target": "com.amazonaws.codecommit#Arn", "traits": { - "smithy.api#documentation": "

The name of the approval rule template.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule template.

" } }, - "lastModifiedDate": { - "target": "com.amazonaws.codecommit#LastModifiedDate", + "creationDate": { + "target": "com.amazonaws.codecommit#CreationDate", "traits": { - "smithy.api#documentation": "

The date the approval rule template was most recently changed, in timestamp format.

" + "smithy.api#documentation": "

The date the approval rule template was created, in timestamp format.

" } } }, @@ -628,18 +628,18 @@ "com.amazonaws.codecommit#BatchAssociateApprovalRuleTemplateWithRepositoriesError": { "type": "structure", "members": { - "errorMessage": { - "target": "com.amazonaws.codecommit#ErrorMessage", - "traits": { - "smithy.api#documentation": "

An error message that provides details about why the repository name was not found or not valid.

" - } - }, "errorCode": { "target": "com.amazonaws.codecommit#ErrorCode", "traits": { "smithy.api#documentation": "

An error code that specifies whether the repository name was not valid or not found.

" } }, + "errorMessage": { + "target": "com.amazonaws.codecommit#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An error message that provides details about why the repository name was not found or not valid.

" + } + }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { @@ -660,17 +660,17 @@ "com.amazonaws.codecommit#BatchAssociateApprovalRuleTemplateWithRepositoriesInput": { "type": "structure", "members": { - "approvalRuleTemplateName": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", + "repositoryNames": { + "target": "com.amazonaws.codecommit#RepositoryNameList", "traits": { - "smithy.api#documentation": "

The name of the template you want to associate with one or more repositories.

", + "smithy.api#documentation": "

The names of the repositories you want to associate with the template.

\n \n

The length constraint limit is for each string in the array. The array itself can be empty.

\n ", "smithy.api#required": {} } }, - "repositoryNames": { - "target": "com.amazonaws.codecommit#RepositoryNameList", + "approvalRuleTemplateName": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", "traits": { - "smithy.api#documentation": "

The names of the repositories you want to associate with the template.

\n \n

The length constraint limit is for each string in the array. The array itself can be empty.

\n ", + "smithy.api#documentation": "

The name of the template you want to associate with one or more repositories.

", "smithy.api#required": {} } } @@ -810,11 +810,16 @@ "com.amazonaws.codecommit#BatchDescribeMergeConflictsInput": { "type": "structure", "members": { - "destinationCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", + "maxConflictFiles": { + "target": "com.amazonaws.codecommit#MaxResults", "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of files to include in the output.

" + } + }, + "conflictResolutionStrategy": { + "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", + "traits": { + "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" } }, "maxMergeHunks": { @@ -823,6 +828,12 @@ "smithy.api#documentation": "

The maximum number of merge hunks to include in the output.

" } }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" + } + }, "sourceCommitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { @@ -836,10 +847,11 @@ "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, - "nextToken": { - "target": "com.amazonaws.codecommit#NextToken", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" + "smithy.api#documentation": "

The name of the repository that contains the merge conflicts you want to review.

", + "smithy.api#required": {} } }, "mergeOption": { @@ -849,25 +861,13 @@ "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "destinationCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", "traits": { - "smithy.api#documentation": "

The name of the repository that contains the merge conflicts you want to review.

", + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", "smithy.api#required": {} } }, - "conflictResolutionStrategy": { - "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", - "traits": { - "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" - } - }, - "maxConflictFiles": { - "target": "com.amazonaws.codecommit#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of files to include in the output.

" - } - }, "filePaths": { "target": "com.amazonaws.codecommit#FilePaths", "traits": { @@ -879,12 +879,6 @@ "com.amazonaws.codecommit#BatchDescribeMergeConflictsOutput": { "type": "structure", "members": { - "baseCommitId": { - "target": "com.amazonaws.codecommit#ObjectId", - "traits": { - "smithy.api#documentation": "

The commit ID of the merge base.

" - } - }, "conflicts": { "target": "com.amazonaws.codecommit#Conflicts", "traits": { @@ -899,10 +893,10 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.codecommit#NextToken", + "baseCommitId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" + "smithy.api#documentation": "

The commit ID of the merge base.

" } }, "errors": { @@ -911,6 +905,12 @@ "smithy.api#documentation": "

A list of any errors returned while describing the merge conflicts for each file.

" } }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" + } + }, "destinationCommitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { @@ -999,17 +999,17 @@ "com.amazonaws.codecommit#BatchDisassociateApprovalRuleTemplateFromRepositoriesInput": { "type": "structure", "members": { - "repositoryNames": { - "target": "com.amazonaws.codecommit#RepositoryNameList", + "approvalRuleTemplateName": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", "traits": { - "smithy.api#documentation": "

The repository names that you want to disassociate from the approval rule\n template.

\n \n

The length constraint limit is for each string in the array. The array itself can be empty.

\n ", + "smithy.api#documentation": "

The name of the template that you want to disassociate from one or more repositories.

", "smithy.api#required": {} } }, - "approvalRuleTemplateName": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", + "repositoryNames": { + "target": "com.amazonaws.codecommit#RepositoryNameList", "traits": { - "smithy.api#documentation": "

The name of the template that you want to disassociate from one or more repositories.

", + "smithy.api#documentation": "

The repository names that you want to disassociate from the approval rule\n template.

\n \n

The length constraint limit is for each string in the array. The array itself can be empty.

\n ", "smithy.api#required": {} } } @@ -1018,17 +1018,17 @@ "com.amazonaws.codecommit#BatchDisassociateApprovalRuleTemplateFromRepositoriesOutput": { "type": "structure", "members": { - "disassociatedRepositoryNames": { - "target": "com.amazonaws.codecommit#RepositoryNameList", + "errors": { + "target": "com.amazonaws.codecommit#BatchDisassociateApprovalRuleTemplateFromRepositoriesErrorsList", "traits": { - "smithy.api#documentation": "

A list of repository names that have had their association with the template\n removed.

", + "smithy.api#documentation": "

A list of any errors that might have occurred while attempting to remove the association between the template and the repositories.

", "smithy.api#required": {} } }, - "errors": { - "target": "com.amazonaws.codecommit#BatchDisassociateApprovalRuleTemplateFromRepositoriesErrorsList", + "disassociatedRepositoryNames": { + "target": "com.amazonaws.codecommit#RepositoryNameList", "traits": { - "smithy.api#documentation": "

A list of any errors that might have occurred while attempting to remove the association between the template and the repositories.

", + "smithy.api#documentation": "

A list of repository names that have had their association with the template\n removed.

", "smithy.api#required": {} } } @@ -1113,17 +1113,17 @@ "com.amazonaws.codecommit#BatchGetCommitsInput": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "commitIds": { + "target": "com.amazonaws.codecommit#CommitIdsInputList", "traits": { - "smithy.api#documentation": "

The name of the repository that contains the commits.

", + "smithy.api#documentation": "

The full commit IDs of the commits to get information about.

\n \n

You must supply the full SHA IDs of each commit. You cannot use shortened SHA\n IDs.

\n ", "smithy.api#required": {} } }, - "commitIds": { - "target": "com.amazonaws.codecommit#CommitIdsInputList", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The full commit IDs of the commits to get information about.

\n \n

You must supply the full SHA IDs of each commit. You cannot use shortened SHA\n IDs.

\n ", + "smithy.api#documentation": "

The name of the repository that contains the commits.

", "smithy.api#required": {} } } @@ -1202,17 +1202,17 @@ "com.amazonaws.codecommit#BatchGetRepositoriesOutput": { "type": "structure", "members": { - "repositoriesNotFound": { - "target": "com.amazonaws.codecommit#RepositoryNotFoundList", - "traits": { - "smithy.api#documentation": "

Returns a list of repository names for which information could not be found.

" - } - }, "repositories": { "target": "com.amazonaws.codecommit#RepositoryMetadataList", "traits": { "smithy.api#documentation": "

A list of repositories returned by the batch get repositories operation.

" } + }, + "repositoriesNotFound": { + "target": "com.amazonaws.codecommit#RepositoryNotFoundList", + "traits": { + "smithy.api#documentation": "

Returns a list of repository names for which information could not be found.

" + } } }, "traits": { @@ -1267,6 +1267,12 @@ "com.amazonaws.codecommit#BlobMetadata": { "type": "structure", "members": { + "mode": { + "target": "com.amazonaws.codecommit#Mode", + "traits": { + "smithy.api#documentation": "

The file mode permissions of the blob. File mode permission codes include:

\n " + } + }, "path": { "target": "com.amazonaws.codecommit#Path", "traits": { @@ -1278,12 +1284,6 @@ "traits": { "smithy.api#documentation": "

The full ID of the blob.

" } - }, - "mode": { - "target": "com.amazonaws.codecommit#Mode", - "traits": { - "smithy.api#documentation": "

The file mode permissions of the blob. File mode permission codes include:

\n " - } } }, "traits": { @@ -1727,22 +1727,22 @@ "com.amazonaws.codecommit#Comment": { "type": "structure", "members": { - "deleted": { - "target": "com.amazonaws.codecommit#IsCommentDeleted", + "content": { + "target": "com.amazonaws.codecommit#Content", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the comment has been deleted.

" + "smithy.api#documentation": "

The content of the comment.

" } }, - "authorArn": { - "target": "com.amazonaws.codecommit#Arn", + "lastModifiedDate": { + "target": "com.amazonaws.codecommit#LastModifiedDate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the person who posted the comment.

" + "smithy.api#documentation": "

The date and time the comment was most recently modified, in timestamp format.

" } }, - "content": { - "target": "com.amazonaws.codecommit#Content", + "authorArn": { + "target": "com.amazonaws.codecommit#Arn", "traits": { - "smithy.api#documentation": "

The content of the comment.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the person who posted the comment.

" } }, "clientRequestToken": { @@ -1751,10 +1751,10 @@ "smithy.api#documentation": "

A unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request is received with\n the same parameters and a token is included, the request returns information about the\n initial request that used that token.

" } }, - "lastModifiedDate": { - "target": "com.amazonaws.codecommit#LastModifiedDate", + "deleted": { + "target": "com.amazonaws.codecommit#IsCommentDeleted", "traits": { - "smithy.api#documentation": "

The date and time the comment was most recently modified, in timestamp format.

" + "smithy.api#documentation": "

A Boolean value indicating whether the comment has been deleted.

" } }, "reactionCounts": { @@ -1894,24 +1894,18 @@ "com.amazonaws.codecommit#CommentsForComparedCommit": { "type": "structure", "members": { + "beforeCommitId": { + "target": "com.amazonaws.codecommit#CommitId", + "traits": { + "smithy.api#documentation": "

The full commit ID of the commit used to establish the before of the\n comparison.

" + } + }, "comments": { "target": "com.amazonaws.codecommit#Comments", "traits": { "smithy.api#documentation": "

An array of comment objects. Each comment object contains information about a comment on the comparison\n between commits.

" } }, - "beforeBlobId": { - "target": "com.amazonaws.codecommit#ObjectId", - "traits": { - "smithy.api#documentation": "

The full blob ID of the commit used to establish the before of the comparison.

" - } - }, - "beforeCommitId": { - "target": "com.amazonaws.codecommit#CommitId", - "traits": { - "smithy.api#documentation": "

The full commit ID of the commit used to establish the before of the\n comparison.

" - } - }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { @@ -1924,16 +1918,22 @@ "smithy.api#documentation": "

Location information about the comment on the comparison, including the file name,\n line number, and whether the version of the file where the comment was made is BEFORE or\n AFTER.

" } }, + "afterCommitId": { + "target": "com.amazonaws.codecommit#CommitId", + "traits": { + "smithy.api#documentation": "

The full commit ID of the commit used to establish the after of the comparison.

" + } + }, "afterBlobId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { "smithy.api#documentation": "

The full blob ID of the commit used to establish the after of the comparison.

" } }, - "afterCommitId": { - "target": "com.amazonaws.codecommit#CommitId", + "beforeBlobId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The full commit ID of the commit used to establish the after of the comparison.

" + "smithy.api#documentation": "

The full blob ID of the commit used to establish the before of the comparison.

" } } }, @@ -1950,22 +1950,16 @@ "com.amazonaws.codecommit#CommentsForPullRequest": { "type": "structure", "members": { - "afterBlobId": { - "target": "com.amazonaws.codecommit#ObjectId", - "traits": { - "smithy.api#documentation": "

The full blob ID of the file on which you want to comment on the source commit.

" - } - }, "location": { "target": "com.amazonaws.codecommit#Location", "traits": { "smithy.api#documentation": "

Location information about the comment on the pull request, including the file name,\n line number, and whether the version of the file where the comment was made is BEFORE\n (destination branch) or AFTER (source branch).

" } }, - "afterCommitId": { - "target": "com.amazonaws.codecommit#CommitId", + "afterBlobId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The full commit ID of the commit that was the tip of the source branch at the time the\n comment was made.

" + "smithy.api#documentation": "

The full blob ID of the file on which you want to comment on the source commit.

" } }, "beforeCommitId": { @@ -1980,10 +1974,10 @@ "smithy.api#documentation": "

The full blob ID of the file on which you want to comment on the destination commit.

" } }, - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "afterCommitId": { + "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request.

" + "smithy.api#documentation": "

The full commit ID of the commit that was the tip of the source branch at the time the\n comment was made.

" } }, "repositoryName": { @@ -1992,6 +1986,12 @@ "smithy.api#documentation": "

The name of the repository that contains the pull request.

" } }, + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", + "traits": { + "smithy.api#documentation": "

The system-generated ID of the pull request.

" + } + }, "comments": { "target": "com.amazonaws.codecommit#Comments", "traits": { @@ -2012,10 +2012,16 @@ "com.amazonaws.codecommit#Commit": { "type": "structure", "members": { - "additionalData": { - "target": "com.amazonaws.codecommit#AdditionalData", + "commitId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

Any other data associated with the specified commit.

" + "smithy.api#documentation": "

The full SHA ID of the specified commit.

" + } + }, + "committer": { + "target": "com.amazonaws.codecommit#UserInfo", + "traits": { + "smithy.api#documentation": "

Information about the person who committed the specified commit, also known as the committer. Information includes \n the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured \n in Git.

\n

For more information\n about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git\n by Scott Chacon and Ben Straub.

" } }, "parents": { @@ -2024,10 +2030,10 @@ "smithy.api#documentation": "

A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.

" } }, - "commitId": { - "target": "com.amazonaws.codecommit#ObjectId", + "additionalData": { + "target": "com.amazonaws.codecommit#AdditionalData", "traits": { - "smithy.api#documentation": "

The full SHA ID of the specified commit.

" + "smithy.api#documentation": "

Any other data associated with the specified commit.

" } }, "author": { @@ -2036,23 +2042,17 @@ "smithy.api#documentation": "

Information about the author of the specified commit. Information includes \n the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured \n in Git.

" } }, - "message": { - "target": "com.amazonaws.codecommit#Message", - "traits": { - "smithy.api#documentation": "

The commit message associated with the specified commit.

" - } - }, - "committer": { - "target": "com.amazonaws.codecommit#UserInfo", - "traits": { - "smithy.api#documentation": "

Information about the person who committed the specified commit, also known as the committer. Information includes \n the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured \n in Git.

\n

For more information\n about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git\n by Scott Chacon and Ben Straub.

" - } - }, "treeId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { "smithy.api#documentation": "

Tree information for the specified commit.

" } + }, + "message": { + "target": "com.amazonaws.codecommit#Message", + "traits": { + "smithy.api#documentation": "

The commit message associated with the specified commit.

" + } } }, "traits": { @@ -2235,22 +2235,28 @@ "com.amazonaws.codecommit#ConflictMetadata": { "type": "structure", "members": { + "objectTypes": { + "target": "com.amazonaws.codecommit#ObjectTypes", + "traits": { + "smithy.api#documentation": "

Information about any object type conflicts in a merge operation.

" + } + }, "fileModeConflict": { "target": "com.amazonaws.codecommit#IsFileModeConflict", "traits": { "smithy.api#documentation": "

A boolean value indicating whether there are conflicts in the file mode of a file.

" } }, - "mergeOperations": { - "target": "com.amazonaws.codecommit#MergeOperations", + "isBinaryFile": { + "target": "com.amazonaws.codecommit#IsBinaryFile", "traits": { - "smithy.api#documentation": "

Whether an add, modify, or delete operation caused the conflict between the source and destination of the merge.

" + "smithy.api#documentation": "

A boolean value (true or false) indicating whether the file is binary or textual in the source, destination, and base of the merge.

" } }, - "fileModes": { - "target": "com.amazonaws.codecommit#FileModes", + "contentConflict": { + "target": "com.amazonaws.codecommit#IsContentConflict", "traits": { - "smithy.api#documentation": "

The file modes of the file in the source, destination, and base of the merge.

" + "smithy.api#documentation": "

A boolean value indicating whether there are conflicts in the content of a file.

" } }, "fileSizes": { @@ -2259,22 +2265,16 @@ "smithy.api#documentation": "

The file sizes of the file in the source, destination, and base of the merge.

" } }, - "isBinaryFile": { - "target": "com.amazonaws.codecommit#IsBinaryFile", - "traits": { - "smithy.api#documentation": "

A boolean value (true or false) indicating whether the file is binary or textual in the source, destination, and base of the merge.

" - } - }, - "objectTypes": { - "target": "com.amazonaws.codecommit#ObjectTypes", + "mergeOperations": { + "target": "com.amazonaws.codecommit#MergeOperations", "traits": { - "smithy.api#documentation": "

Information about any object type conflicts in a merge operation.

" + "smithy.api#documentation": "

Whether an add, modify, or delete operation caused the conflict between the source and destination of the merge.

" } }, - "contentConflict": { - "target": "com.amazonaws.codecommit#IsContentConflict", + "fileModes": { + "target": "com.amazonaws.codecommit#FileModes", "traits": { - "smithy.api#documentation": "

A boolean value indicating whether there are conflicts in the content of a file.

" + "smithy.api#documentation": "

The file modes of the file in the source, destination, and base of the merge.

" } }, "filePath": { @@ -2283,17 +2283,17 @@ "smithy.api#documentation": "

The path of the file that contains conflicts.

" } }, - "numberOfConflicts": { - "target": "com.amazonaws.codecommit#NumberOfConflicts", - "traits": { - "smithy.api#documentation": "

The number of conflicts, including both hunk conflicts and metadata conflicts.

" - } - }, "objectTypeConflict": { "target": "com.amazonaws.codecommit#IsObjectTypeConflict", "traits": { "smithy.api#documentation": "

A boolean value (true or false) indicating whether there are conflicts between the branches in the object type of a file, folder, or submodule.

" } + }, + "numberOfConflicts": { + "target": "com.amazonaws.codecommit#NumberOfConflicts", + "traits": { + "smithy.api#documentation": "

The number of conflicts, including both hunk conflicts and metadata conflicts.

" + } } }, "traits": { @@ -2408,6 +2408,12 @@ "com.amazonaws.codecommit#CreateApprovalRuleTemplateInput": { "type": "structure", "members": { + "approvalRuleTemplateDescription": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the approval rule template. Consider providing a description that\n explains what this template does and when it might be appropriate to associate it with\n repositories.

" + } + }, "approvalRuleTemplateName": { "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", "traits": { @@ -2415,12 +2421,6 @@ "smithy.api#required": {} } }, - "approvalRuleTemplateDescription": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateDescription", - "traits": { - "smithy.api#documentation": "

The description of the approval rule template. Consider providing a description that\n explains what this template does and when it might be appropriate to associate it with\n repositories.

" - } - }, "approvalRuleTemplateContent": { "target": "com.amazonaws.codecommit#ApprovalRuleTemplateContent", "traits": { @@ -2505,17 +2505,17 @@ "smithy.api#required": {} } }, - "branchName": { - "target": "com.amazonaws.codecommit#BranchName", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The name of the new branch to create.

", + "smithy.api#documentation": "

The name of the repository in which you want to create the new branch.

", "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "branchName": { + "target": "com.amazonaws.codecommit#BranchName", "traits": { - "smithy.api#documentation": "

The name of the repository in which you want to create the new branch.

", + "smithy.api#documentation": "

The name of the new branch to create.

", "smithy.api#required": {} } } @@ -2655,22 +2655,22 @@ "com.amazonaws.codecommit#CreateCommitInput": { "type": "structure", "members": { - "commitMessage": { - "target": "com.amazonaws.codecommit#Message", - "traits": { - "smithy.api#documentation": "

The commit message you want to include in the commit. Commit messages are limited to\n 256 KB. If no message is specified, a default message is used.

" - } - }, "parentCommitId": { "target": "com.amazonaws.codecommit#CommitId", "traits": { "smithy.api#documentation": "

The ID of the commit that is the parent of the commit you create. Not required if this\n is an empty repository.

" } }, - "putFiles": { - "target": "com.amazonaws.codecommit#PutFileEntries", + "authorName": { + "target": "com.amazonaws.codecommit#Name", "traits": { - "smithy.api#documentation": "

The files to add or update in this commit.

" + "smithy.api#documentation": "

The name of the author who created the commit. This information is used as both the\n author and committer for the commit.

" + } + }, + "setFileModes": { + "target": "com.amazonaws.codecommit#SetFileModeEntries", + "traits": { + "smithy.api#documentation": "

The file modes to update for files in this commit.

" } }, "branchName": { @@ -2680,16 +2680,16 @@ "smithy.api#required": {} } }, - "email": { - "target": "com.amazonaws.codecommit#Email", + "putFiles": { + "target": "com.amazonaws.codecommit#PutFileEntries", "traits": { - "smithy.api#documentation": "

The email address of the person who created the commit.

" + "smithy.api#documentation": "

The files to add or update in this commit.

" } }, - "setFileModes": { - "target": "com.amazonaws.codecommit#SetFileModeEntries", + "commitMessage": { + "target": "com.amazonaws.codecommit#Message", "traits": { - "smithy.api#documentation": "

The file modes to update for files in this commit.

" + "smithy.api#documentation": "

The commit message you want to include in the commit. Commit messages are limited to\n 256 KB. If no message is specified, a default message is used.

" } }, "repositoryName": { @@ -2699,16 +2699,10 @@ "smithy.api#required": {} } }, - "authorName": { - "target": "com.amazonaws.codecommit#Name", - "traits": { - "smithy.api#documentation": "

The name of the author who created the commit. This information is used as both the\n author and committer for the commit.

" - } - }, - "deleteFiles": { - "target": "com.amazonaws.codecommit#DeleteFileEntries", + "email": { + "target": "com.amazonaws.codecommit#Email", "traits": { - "smithy.api#documentation": "

The files to delete in this commit. These files still exist in earlier commits.

" + "smithy.api#documentation": "

The email address of the person who created the commit.

" } }, "keepEmptyFolders": { @@ -2716,16 +2710,22 @@ "traits": { "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If true, a ..gitkeep file is created for empty folders.\n The default is false.

" } + }, + "deleteFiles": { + "target": "com.amazonaws.codecommit#DeleteFileEntries", + "traits": { + "smithy.api#documentation": "

The files to delete in this commit. These files still exist in earlier commits.

" + } } } }, "com.amazonaws.codecommit#CreateCommitOutput": { "type": "structure", "members": { - "filesAdded": { - "target": "com.amazonaws.codecommit#FilesMetadata", + "treeId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The files added as part of the committed file changes.

" + "smithy.api#documentation": "

The full SHA-1 pointer of the tree information for the commit that contains the commited file changes.

" } }, "filesUpdated": { @@ -2734,22 +2734,22 @@ "smithy.api#documentation": "

The files updated as part of the commited file changes.

" } }, - "filesDeleted": { - "target": "com.amazonaws.codecommit#FilesMetadata", - "traits": { - "smithy.api#documentation": "

The files deleted as part of the committed file changes.

" - } - }, "commitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { "smithy.api#documentation": "

The full commit ID of the commit that contains your committed file changes.

" } }, - "treeId": { - "target": "com.amazonaws.codecommit#ObjectId", + "filesDeleted": { + "target": "com.amazonaws.codecommit#FilesMetadata", "traits": { - "smithy.api#documentation": "

The full SHA-1 pointer of the tree information for the commit that contains the commited file changes.

" + "smithy.api#documentation": "

The files deleted as part of the committed file changes.

" + } + }, + "filesAdded": { + "target": "com.amazonaws.codecommit#FilesMetadata", + "traits": { + "smithy.api#documentation": "

The files added as part of the committed file changes.

" } } } @@ -2905,17 +2905,17 @@ "com.amazonaws.codecommit#CreatePullRequestApprovalRuleInput": { "type": "structure", "members": { - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "approvalRuleContent": { + "target": "com.amazonaws.codecommit#ApprovalRuleContent", "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request for which you want to create the approval rule.

", + "smithy.api#documentation": "

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information\n about approval pools, see the AWS CodeCommit User Guide.

\n \n

When you create the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:

\n
    \n
  • \n

    \n CodeCommitApprovers: This option only\n requires an AWS account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the AWS account 123456789012\n and Mary_Major, all of the following would be counted\n as approvals coming from that user:

    \n
      \n
    • \n

      An IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)

      \n
      • \n
    • \n

      A federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)

      \n
      • \n
    \n

    This option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).

    \n
    • \n
  • \n

    \n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.

    \n
    • \n
\n

For more information about IAM ARNs, wildcards, and formats, see\n IAM\n Identifiers in the IAM User Guide.

\n \n ", "smithy.api#required": {} } }, - "approvalRuleContent": { - "target": "com.amazonaws.codecommit#ApprovalRuleContent", + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", "traits": { - "smithy.api#documentation": "

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information\n about approval pools, see the AWS CodeCommit User Guide.

\n \n

When you create the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:

\n
    \n
  • \n

    \n CodeCommitApprovers: This option only\n requires an AWS account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the AWS account 123456789012\n and Mary_Major, all of the following would be counted\n as approvals coming from that user:

    \n
      \n
    • \n

      An IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)

      \n
      • \n
    • \n

      A federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)

      \n
      • \n
    \n

    This option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).

    \n
    • \n
  • \n

    \n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.

    \n
    • \n
\n

For more information about IAM ARNs, wildcards, and formats, see\n IAM\n Identifiers in the IAM User Guide.

\n \n ", + "smithy.api#documentation": "

The system-generated ID of the pull request for which you want to create the approval rule.

", "smithy.api#required": {} } }, @@ -2943,13 +2943,6 @@ "com.amazonaws.codecommit#CreatePullRequestInput": { "type": "structure", "members": { - "title": { - "target": "com.amazonaws.codecommit#Title", - "traits": { - "smithy.api#documentation": "

The title of the pull request. This title is used to identify the pull request to\n other users in the repository.

", - "smithy.api#required": {} - } - }, "clientRequestToken": { "target": "com.amazonaws.codecommit#ClientRequestToken", "traits": { @@ -2957,6 +2950,13 @@ "smithy.api#idempotencyToken": {} } }, + "title": { + "target": "com.amazonaws.codecommit#Title", + "traits": { + "smithy.api#documentation": "

The title of the pull request. This title is used to identify the pull request to\n other users in the repository.

", + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.codecommit#Description", "traits": { @@ -3049,17 +3049,17 @@ "smithy.api#documentation": "

A comment or description about the new repository.

\n \n

The description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.

\n " } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "tags": { + "target": "com.amazonaws.codecommit#TagsMap", "traits": { - "smithy.api#documentation": "

The name of the new repository to be created.

\n \n

The repository name must be unique across the calling AWS account. Repository names\n are limited to 100 alphanumeric, dash, and underscore characters, and cannot include\n certain characters. For more information about the limits on repository names, see\n Limits in the AWS CodeCommit User Guide. The\n suffix .git is prohibited.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more tag key-value pairs to use when tagging this repository.

" } }, - "tags": { - "target": "com.amazonaws.codecommit#TagsMap", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

One or more tag key-value pairs to use when tagging this repository.

" + "smithy.api#documentation": "

The name of the new repository to be created.

\n \n

The repository name must be unique across the calling AWS account. Repository names\n are limited to 100 alphanumeric, dash, and underscore characters, and cannot include\n certain characters. For more information about the limits on repository names, see\n Limits in the AWS CodeCommit User Guide. The\n suffix .git is prohibited.

\n ", + "smithy.api#required": {} } } }, @@ -3206,17 +3206,18 @@ "com.amazonaws.codecommit#CreateUnreferencedMergeCommitInput": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "sourceCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", "traits": { - "smithy.api#documentation": "

The name of the repository where you want to create the unreferenced merge commit.

", + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", "smithy.api#required": {} } }, - "commitMessage": { - "target": "com.amazonaws.codecommit#Message", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The commit message for the unreferenced commit.

" + "smithy.api#documentation": "

The name of the repository where you want to create the unreferenced merge commit.

", + "smithy.api#required": {} } }, "mergeOption": { @@ -3233,18 +3234,18 @@ "smithy.api#required": {} } }, - "email": { - "target": "com.amazonaws.codecommit#Email", - "traits": { - "smithy.api#documentation": "

The email address for the person who created the unreferenced commit.

" - } - }, "conflictResolution": { "target": "com.amazonaws.codecommit#ConflictResolution", "traits": { "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" } }, + "commitMessage": { + "target": "com.amazonaws.codecommit#Message", + "traits": { + "smithy.api#documentation": "

The commit message for the unreferenced commit.

" + } + }, "authorName": { "target": "com.amazonaws.codecommit#Name", "traits": { @@ -3257,17 +3258,16 @@ "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" } }, - "conflictDetailLevel": { - "target": "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum", + "email": { + "target": "com.amazonaws.codecommit#Email", "traits": { - "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" + "smithy.api#documentation": "

The email address for the person who created the unreferenced commit.

" } }, - "sourceCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", + "conflictDetailLevel": { + "target": "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum", "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, "keepEmptyFolders": { @@ -3413,17 +3413,17 @@ "com.amazonaws.codecommit#DeleteBranchInput": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "branchName": { + "target": "com.amazonaws.codecommit#BranchName", "traits": { - "smithy.api#documentation": "

The name of the repository that contains the branch to be deleted.

", + "smithy.api#documentation": "

The name of the branch to delete.

", "smithy.api#required": {} } }, - "branchName": { - "target": "com.amazonaws.codecommit#BranchName", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The name of the branch to delete.

", + "smithy.api#documentation": "

The name of the repository that contains the branch to be deleted.

", "smithy.api#required": {} } } @@ -3599,10 +3599,10 @@ "com.amazonaws.codecommit#DeleteFileInput": { "type": "structure", "members": { - "email": { - "target": "com.amazonaws.codecommit#Email", + "commitMessage": { + "target": "com.amazonaws.codecommit#Message", "traits": { - "smithy.api#documentation": "

The email address for the commit that deletes the file. If no email address is\n specified, the email address is left blank.

" + "smithy.api#documentation": "

The commit message you want to include as part of deleting the file. Commit messages\n are limited to 256 KB. If no message is specified, a default message is used.

" } }, "filePath": { @@ -3612,6 +3612,12 @@ "smithy.api#required": {} } }, + "email": { + "target": "com.amazonaws.codecommit#Email", + "traits": { + "smithy.api#documentation": "

The email address for the commit that deletes the file. If no email address is\n specified, the email address is left blank.

" + } + }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { @@ -3619,12 +3625,6 @@ "smithy.api#required": {} } }, - "commitMessage": { - "target": "com.amazonaws.codecommit#Message", - "traits": { - "smithy.api#documentation": "

The commit message you want to include as part of deleting the file. Commit messages\n are limited to 256 KB. If no message is specified, a default message is used.

" - } - }, "name": { "target": "com.amazonaws.codecommit#Name", "traits": { @@ -3656,13 +3656,6 @@ "com.amazonaws.codecommit#DeleteFileOutput": { "type": "structure", "members": { - "blobId": { - "target": "com.amazonaws.codecommit#ObjectId", - "traits": { - "smithy.api#documentation": "

The blob ID removed from the tree as part of deleting the file.

", - "smithy.api#required": {} - } - }, "commitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { @@ -3677,6 +3670,13 @@ "smithy.api#required": {} } }, + "blobId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "

The blob ID removed from the tree as part of deleting the file.

", + "smithy.api#required": {} + } + }, "treeId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { @@ -3922,10 +3922,10 @@ "com.amazonaws.codecommit#DescribeMergeConflictsInput": { "type": "structure", "members": { - "mergeOption": { - "target": "com.amazonaws.codecommit#MergeOptionTypeEnum", + "sourceCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", "traits": { - "smithy.api#documentation": "

The merge option or strategy you want to use to merge the code.

", + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", "smithy.api#required": {} } }, @@ -3936,10 +3936,10 @@ "smithy.api#required": {} } }, - "filePath": { - "target": "com.amazonaws.codecommit#Path", + "mergeOption": { + "target": "com.amazonaws.codecommit#MergeOptionTypeEnum", "traits": { - "smithy.api#documentation": "

The path of the target files used to describe the conflicts.

", + "smithy.api#documentation": "

The merge option or strategy you want to use to merge the code.

", "smithy.api#required": {} } }, @@ -3950,16 +3950,10 @@ "smithy.api#required": {} } }, - "conflictDetailLevel": { - "target": "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum", - "traits": { - "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" - } - }, - "sourceCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", + "filePath": { + "target": "com.amazonaws.codecommit#Path", "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", + "smithy.api#documentation": "

The path of the target files used to describe the conflicts.

", "smithy.api#required": {} } }, @@ -3969,10 +3963,10 @@ "smithy.api#documentation": "

The maximum number of merge hunks to include in the output.

" } }, - "conflictResolutionStrategy": { - "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", + "conflictDetailLevel": { + "target": "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum", "traits": { - "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" + "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, "nextToken": { @@ -3980,23 +3974,22 @@ "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } + }, + "conflictResolutionStrategy": { + "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", + "traits": { + "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" + } } } }, "com.amazonaws.codecommit#DescribeMergeConflictsOutput": { "type": "structure", "members": { - "destinationCommitId": { - "target": "com.amazonaws.codecommit#ObjectId", - "traits": { - "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

", - "smithy.api#required": {} - } - }, - "sourceCommitId": { - "target": "com.amazonaws.codecommit#ObjectId", + "mergeHunks": { + "target": "com.amazonaws.codecommit#MergeHunks", "traits": { - "smithy.api#documentation": "

The commit ID of the source commit specifier that was used in the merge evaluation.

", + "smithy.api#documentation": "

A list of merge hunks of the differences between the files or lines.

", "smithy.api#required": {} } }, @@ -4019,10 +4012,17 @@ "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" } }, - "mergeHunks": { - "target": "com.amazonaws.codecommit#MergeHunks", + "sourceCommitId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

A list of merge hunks of the differences between the files or lines.

", + "smithy.api#documentation": "

The commit ID of the source commit specifier that was used in the merge evaluation.

", + "smithy.api#required": {} + } + }, + "destinationCommitId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

", "smithy.api#required": {} } } @@ -4095,18 +4095,18 @@ "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, - "actorArn": { - "target": "com.amazonaws.codecommit#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user whose actions resulted in the event.\n Examples include updating the pull request with more commits or changing the status of a\n pull request.

" - } - }, "pullRequestEventType": { "target": "com.amazonaws.codecommit#PullRequestEventType", "traits": { "smithy.api#documentation": "

Optional. The pull request event type about which you want to return information.

" } }, + "actorArn": { + "target": "com.amazonaws.codecommit#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user whose actions resulted in the event.\n Examples include updating the pull request with more commits or changing the status of a\n pull request.

" + } + }, "maxResults": { "target": "com.amazonaws.codecommit#MaxResults", "traits": { @@ -4152,18 +4152,18 @@ "com.amazonaws.codecommit#Difference": { "type": "structure", "members": { - "changeType": { - "target": "com.amazonaws.codecommit#ChangeTypeEnum", - "traits": { - "smithy.api#documentation": "

Whether the change type of the difference is an addition (A), deletion (D), or modification (M).

" - } - }, "beforeBlob": { "target": "com.amazonaws.codecommit#BlobMetadata", "traits": { "smithy.api#documentation": "

Information about a beforeBlob data type object, including the ID, \n the file mode permission code, and the path.

" } }, + "changeType": { + "target": "com.amazonaws.codecommit#ChangeTypeEnum", + "traits": { + "smithy.api#documentation": "

Whether the change type of the difference is an addition (A), deletion (D), or modification (M).

" + } + }, "afterBlob": { "target": "com.amazonaws.codecommit#BlobMetadata", "traits": { @@ -4243,17 +4243,17 @@ "com.amazonaws.codecommit#DisassociateApprovalRuleTemplateFromRepositoryInput": { "type": "structure", "members": { - "approvalRuleTemplateName": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The name of the approval rule template to disassociate from a specified repository.

", + "smithy.api#documentation": "

The name of the repository you want to disassociate from the template.

", "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "approvalRuleTemplateName": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", "traits": { - "smithy.api#documentation": "

The name of the repository you want to disassociate from the template.

", + "smithy.api#documentation": "

The name of the approval rule template to disassociate from a specified repository.

", "smithy.api#required": {} } } @@ -4424,6 +4424,12 @@ "com.amazonaws.codecommit#Evaluation": { "type": "structure", "members": { + "approvalRulesSatisfied": { + "target": "com.amazonaws.codecommit#ApprovalRulesSatisfiedList", + "traits": { + "smithy.api#documentation": "

The names of the approval rules that have had their conditions met.

" + } + }, "approvalRulesNotSatisfied": { "target": "com.amazonaws.codecommit#ApprovalRulesNotSatisfiedList", "traits": { @@ -4436,12 +4442,6 @@ "smithy.api#documentation": "

Whether the approval rule requirements for the pull request have been overridden and no longer need to be met.

" } }, - "approvalRulesSatisfied": { - "target": "com.amazonaws.codecommit#ApprovalRulesSatisfiedList", - "traits": { - "smithy.api#documentation": "

The names of the approval rules that have had their conditions met.

" - } - }, "approved": { "target": "com.amazonaws.codecommit#Approved", "traits": { @@ -4584,18 +4584,18 @@ "com.amazonaws.codecommit#FileMetadata": { "type": "structure", "members": { - "blobId": { - "target": "com.amazonaws.codecommit#ObjectId", - "traits": { - "smithy.api#documentation": "

The blob ID that contains the file information.

" - } - }, "absolutePath": { "target": "com.amazonaws.codecommit#Path", "traits": { "smithy.api#documentation": "

The full path to the file to be added or updated, including the name of the\n file.

" } }, + "blobId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "

The blob ID that contains the file information.

" + } + }, "fileMode": { "target": "com.amazonaws.codecommit#FileModeTypeEnum", "traits": { @@ -4644,12 +4644,6 @@ "com.amazonaws.codecommit#FileModes": { "type": "structure", "members": { - "base": { - "target": "com.amazonaws.codecommit#FileModeTypeEnum", - "traits": { - "smithy.api#documentation": "

The file mode of a file in the base of a merge or pull request.

" - } - }, "destination": { "target": "com.amazonaws.codecommit#FileModeTypeEnum", "traits": { @@ -4661,6 +4655,12 @@ "traits": { "smithy.api#documentation": "

The file mode of a file in the source of a merge or pull request.

" } + }, + "base": { + "target": "com.amazonaws.codecommit#FileModeTypeEnum", + "traits": { + "smithy.api#documentation": "

The file mode of a file in the base of a merge or pull request.

" + } } }, "traits": { @@ -4715,16 +4715,16 @@ "smithy.api#documentation": "

The size of a file in the destination of a merge or pull request.

" } }, - "base": { + "source": { "target": "com.amazonaws.codecommit#FileSize", "traits": { - "smithy.api#documentation": "

The size of a file in the base of a merge or pull request.

" + "smithy.api#documentation": "

The size of a file in the source of a merge or pull request.

" } }, - "source": { + "base": { "target": "com.amazonaws.codecommit#FileSize", "traits": { - "smithy.api#documentation": "

The size of a file in the source of a merge or pull request.

" + "smithy.api#documentation": "

The size of a file in the base of a merge or pull request.

" } } }, @@ -4762,17 +4762,17 @@ "smithy.api#documentation": "

The relative path of the specified folder from the folder where the query originated.

" } }, - "treeId": { - "target": "com.amazonaws.codecommit#ObjectId", - "traits": { - "smithy.api#documentation": "

The full SHA-1 pointer of the tree information for the commit that contains the folder.

" - } - }, "absolutePath": { "target": "com.amazonaws.codecommit#Path", "traits": { "smithy.api#documentation": "

The fully qualified path of the folder in the repository.

" } + }, + "treeId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "

The full SHA-1 pointer of the tree information for the commit that contains the folder.

" + } } }, "traits": { @@ -5150,21 +5150,21 @@ "smithy.api#documentation": "

Optional. The Amazon Resource Name (ARN) of the user or identity for which you want to get reaction information.

" } }, - "maxResults": { - "target": "com.amazonaws.codecommit#MaxResults", - "traits": { - "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results. The default is the same as the allowed maximum, 1,000.

" - } - }, "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the results.

" } - } - } - }, - "com.amazonaws.codecommit#GetCommentReactionsOutput": { + }, + "maxResults": { + "target": "com.amazonaws.codecommit#MaxResults", + "traits": { + "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results. The default is the same as the allowed maximum, 1,000.

" + } + } + } + }, + "com.amazonaws.codecommit#GetCommentReactionsOutput": { "type": "structure", "members": { "reactionsForComment": { @@ -5243,16 +5243,11 @@ "com.amazonaws.codecommit#GetCommentsForComparedCommitInput": { "type": "structure", "members": { - "beforeCommitId": { + "afterCommitId": { "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

To establish the directionality of the comparison, the full commit ID of the before\n commit.

" - } - }, - "nextToken": { - "target": "com.amazonaws.codecommit#NextToken", - "traits": { - "smithy.api#documentation": "

An enumeration token that when provided in a request, returns the next batch of the results.

" + "smithy.api#documentation": "

To establish the directionality of the comparison, the full commit ID of the after\n commit.

", + "smithy.api#required": {} } }, "maxResults": { @@ -5261,11 +5256,16 @@ "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results. The\n default is 100 comments, but you can configure up to 500.

" } }, - "afterCommitId": { + "beforeCommitId": { "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

To establish the directionality of the comparison, the full commit ID of the after\n commit.

", - "smithy.api#required": {} + "smithy.api#documentation": "

To establish the directionality of the comparison, the full commit ID of the before\n commit.

" + } + }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that when provided in a request, returns the next batch of the results.

" } }, "repositoryName": { @@ -5373,12 +5373,6 @@ "smithy.api#documentation": "

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

" } }, - "afterCommitId": { - "target": "com.amazonaws.codecommit#CommitId", - "traits": { - "smithy.api#documentation": "

The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.

" - } - }, "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { @@ -5391,11 +5385,10 @@ "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments.\n You can return up to 500 comments with a single request.

" } }, - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "afterCommitId": { + "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.

" } }, "repositoryName": { @@ -5403,6 +5396,13 @@ "traits": { "smithy.api#documentation": "

The name of the repository that contains the pull request.

" } + }, + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", + "traits": { + "smithy.api#documentation": "

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

", + "smithy.api#required": {} + } } } }, @@ -5577,16 +5577,23 @@ "com.amazonaws.codecommit#GetDifferencesInput": { "type": "structure", "members": { + "afterCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", + "traits": { + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, - "beforeCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", + "MaxResults": { + "target": "com.amazonaws.codecommit#Limit", "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, the full commit ID). Optional. If not specified, all changes before the\n afterCommitSpecifier value are shown. If you do not use\n beforeCommitSpecifier in your request, consider limiting the results\n with maxResults.

" + "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results.

" } }, "beforePath": { @@ -5602,17 +5609,10 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.codecommit#Limit", - "traits": { - "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results.

" - } - }, - "afterCommitSpecifier": { + "beforeCommitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, the full commit ID). Optional. If not specified, all changes before the\n afterCommitSpecifier value are shown. If you do not use\n beforeCommitSpecifier in your request, consider limiting the results\n with maxResults.

" } }, "afterPath": { @@ -5626,17 +5626,17 @@ "com.amazonaws.codecommit#GetDifferencesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.codecommit#NextToken", - "traits": { - "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" - } - }, "differences": { "target": "com.amazonaws.codecommit#DifferenceList", "traits": { "smithy.api#documentation": "

A data type object that contains information about the differences, including whether\n the difference is added, modified, or deleted (A, D, M).

" } + }, + "NextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" + } } } }, @@ -5699,13 +5699,6 @@ "com.amazonaws.codecommit#GetFileInput": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", - "traits": { - "smithy.api#documentation": "

The name of the repository that contains the file.

", - "smithy.api#required": {} - } - }, "commitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { @@ -5718,12 +5711,26 @@ "smithy.api#documentation": "

The fully qualified path to the file, including the full name and extension of the\n file. For example, /examples/file.md is the fully qualified path to a file named file.md\n in a folder named examples.

", "smithy.api#required": {} } + }, + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository that contains the file.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.codecommit#GetFileOutput": { "type": "structure", "members": { + "blobId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "

The blob ID of the object that represents the file content.

", + "smithy.api#required": {} + } + }, "commitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { @@ -5731,10 +5738,10 @@ "smithy.api#required": {} } }, - "blobId": { - "target": "com.amazonaws.codecommit#ObjectId", + "filePath": { + "target": "com.amazonaws.codecommit#Path", "traits": { - "smithy.api#documentation": "

The blob ID of the object that represents the file content.

", + "smithy.api#documentation": "

The fully qualified path to the specified file. Returns the name and extension of the\n file.

", "smithy.api#required": {} } }, @@ -5752,13 +5759,6 @@ "smithy.api#required": {} } }, - "filePath": { - "target": "com.amazonaws.codecommit#Path", - "traits": { - "smithy.api#documentation": "

The fully qualified path to the specified file. Returns the name and extension of the\n file.

", - "smithy.api#required": {} - } - }, "fileSize": { "target": "com.amazonaws.codecommit#ObjectSize", "traits": { @@ -5831,18 +5831,18 @@ "smithy.api#required": {} } }, + "commitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", + "traits": { + "smithy.api#documentation": "

A fully qualified reference used to identify a commit that contains the version of the\n folder's content to return. A fully qualified reference can be a commit ID, branch name,\n tag, or reference such as HEAD. If no specifier is provided, the folder content is\n returned as it exists in the HEAD commit.

" + } + }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { "smithy.api#documentation": "

The name of the repository.

", "smithy.api#required": {} } - }, - "commitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", - "traits": { - "smithy.api#documentation": "

A fully qualified reference used to identify a commit that contains the version of the\n folder's content to return. A fully qualified reference can be a commit ID, branch name,\n tag, or reference such as HEAD. If no specifier is provided, the folder content is\n returned as it exists in the HEAD commit.

" - } } } }, @@ -5868,11 +5868,10 @@ "smithy.api#documentation": "

The list of files in the specified folder, if any.

" } }, - "commitId": { - "target": "com.amazonaws.codecommit#ObjectId", + "symbolicLinks": { + "target": "com.amazonaws.codecommit#SymbolicLinkList", "traits": { - "smithy.api#documentation": "

The full commit ID used as a reference for the returned version of the folder\n content.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The list of symbolic links to other files and folders in the specified folder, if\n any.

" } }, "subModules": { @@ -5881,17 +5880,18 @@ "smithy.api#documentation": "

The list of submodules in the specified folder, if any.

" } }, - "symbolicLinks": { - "target": "com.amazonaws.codecommit#SymbolicLinkList", - "traits": { - "smithy.api#documentation": "

The list of symbolic links to other files and folders in the specified folder, if\n any.

" - } - }, "subFolders": { "target": "com.amazonaws.codecommit#FolderList", "traits": { "smithy.api#documentation": "

The list of folders that exist under the specified folder, if any.

" } + }, + "commitId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "

The full commit ID used as a reference for the returned version of the folder\n content.

", + "smithy.api#required": {} + } } } }, @@ -5995,16 +5995,16 @@ "smithy.api#documentation": "

The commit ID for the merge commit created when the source branch was merged into the\n destination branch. If the fast-forward merge strategy was used, there is no merge\n commit.

" } }, - "destinationCommitId": { + "baseCommitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

" + "smithy.api#documentation": "

The commit ID of the merge base.

" } }, - "baseCommitId": { + "destinationCommitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The commit ID of the merge base.

" + "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

" } }, "sourceCommitId": { @@ -6103,12 +6103,6 @@ "com.amazonaws.codecommit#GetMergeConflictsInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codecommit#NextToken", - "traits": { - "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" - } - }, "conflictDetailLevel": { "target": "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum", "traits": { @@ -6122,6 +6116,12 @@ "smithy.api#required": {} } }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" + } + }, "sourceCommitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { @@ -6135,10 +6135,11 @@ "smithy.api#documentation": "

The maximum number of files to include in the output.

" } }, - "conflictResolutionStrategy": { - "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" + "smithy.api#documentation": "

The name of the repository where the pull request was created.

", + "smithy.api#required": {} } }, "mergeOption": { @@ -6148,11 +6149,10 @@ "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "conflictResolutionStrategy": { + "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", "traits": { - "smithy.api#documentation": "

The name of the repository where the pull request was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" } } } @@ -6160,17 +6160,17 @@ "com.amazonaws.codecommit#GetMergeConflictsOutput": { "type": "structure", "members": { - "destinationCommitId": { - "target": "com.amazonaws.codecommit#ObjectId", + "conflictMetadataList": { + "target": "com.amazonaws.codecommit#ConflictMetadataList", "traits": { - "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

", + "smithy.api#documentation": "

A list of metadata for any conflicting files. If the specified merge strategy is\n FAST_FORWARD_MERGE, this list is always empty.

", "smithy.api#required": {} } }, - "sourceCommitId": { + "destinationCommitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The commit ID of the source commit specifier that was used in the merge evaluation.

", + "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

", "smithy.api#required": {} } }, @@ -6181,6 +6181,13 @@ "smithy.api#required": {} } }, + "sourceCommitId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "

The commit ID of the source commit specifier that was used in the merge evaluation.

", + "smithy.api#required": {} + } + }, "baseCommitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { @@ -6192,13 +6199,6 @@ "traits": { "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" } - }, - "conflictMetadataList": { - "target": "com.amazonaws.codecommit#ConflictMetadataList", - "traits": { - "smithy.api#documentation": "

A list of metadata for any conflicting files. If the specified merge strategy is\n FAST_FORWARD_MERGE, this list is always empty.

", - "smithy.api#required": {} - } } } }, @@ -6267,6 +6267,13 @@ "com.amazonaws.codecommit#GetMergeOptionsInput": { "type": "structure", "members": { + "sourceCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", + "traits": { + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", + "smithy.api#required": {} + } + }, "destinationCommitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { @@ -6287,13 +6294,6 @@ "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, - "sourceCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", - "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", - "smithy.api#required": {} - } - }, "conflictResolutionStrategy": { "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", "traits": { @@ -6305,17 +6305,17 @@ "com.amazonaws.codecommit#GetMergeOptionsOutput": { "type": "structure", "members": { - "mergeOptions": { - "target": "com.amazonaws.codecommit#MergeOptions", + "baseCommitId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The merge option or strategy used to merge the code.

", + "smithy.api#documentation": "

The commit ID of the merge base.

", "smithy.api#required": {} } }, - "baseCommitId": { + "destinationCommitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The commit ID of the merge base.

", + "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

", "smithy.api#required": {} } }, @@ -6326,10 +6326,10 @@ "smithy.api#required": {} } }, - "destinationCommitId": { - "target": "com.amazonaws.codecommit#ObjectId", + "mergeOptions": { + "target": "com.amazonaws.codecommit#MergeOptions", "traits": { - "smithy.api#documentation": "

The commit ID of the destination commit specifier that was used in the merge evaluation.

", + "smithy.api#documentation": "

The merge option or strategy used to merge the code.

", "smithy.api#required": {} } } @@ -6518,17 +6518,17 @@ "com.amazonaws.codecommit#GetPullRequestOverrideStateInput": { "type": "structure", "members": { - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "revisionId": { + "target": "com.amazonaws.codecommit#RevisionId", "traits": { - "smithy.api#documentation": "

The ID of the pull request for which you want to get information about whether approval rules have been set aside (overridden).

", + "smithy.api#documentation": "

The system-generated ID of the revision for the pull request. To retrieve the most\n recent revision ID, use\n GetPullRequest.

", "smithy.api#required": {} } }, - "revisionId": { - "target": "com.amazonaws.codecommit#RevisionId", + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", "traits": { - "smithy.api#documentation": "

The system-generated ID of the revision for the pull request. To retrieve the most\n recent revision ID, use\n GetPullRequest.

", + "smithy.api#documentation": "

The ID of the pull request for which you want to get information about whether approval rules have been set aside (overridden).

", "smithy.api#required": {} } } @@ -7657,22 +7657,22 @@ "com.amazonaws.codecommit#IsBinaryFile": { "type": "structure", "members": { - "base": { + "destination": { "target": "com.amazonaws.codecommit#CapitalBoolean", "traits": { - "smithy.api#documentation": "

The binary or non-binary status of a file in the base of a merge or pull request.

" + "smithy.api#documentation": "

The binary or non-binary status of a file in the destination of a merge or pull request.

" } }, - "source": { + "base": { "target": "com.amazonaws.codecommit#CapitalBoolean", "traits": { - "smithy.api#documentation": "

The binary or non-binary status of file in the source of a merge or pull request.

" + "smithy.api#documentation": "

The binary or non-binary status of a file in the base of a merge or pull request.

" } }, - "destination": { + "source": { "target": "com.amazonaws.codecommit#CapitalBoolean", "traits": { - "smithy.api#documentation": "

The binary or non-binary status of a file in the destination of a merge or pull request.

" + "smithy.api#documentation": "

The binary or non-binary status of file in the source of a merge or pull request.

" } } }, @@ -7750,17 +7750,17 @@ "com.amazonaws.codecommit#ListApprovalRuleTemplatesInput": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.codecommit#MaxResults", - "traits": { - "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results.

" - } - }, "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } + }, + "maxResults": { + "target": "com.amazonaws.codecommit#MaxResults", + "traits": { + "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results.

" + } } } }, @@ -7857,17 +7857,17 @@ "com.amazonaws.codecommit#ListAssociatedApprovalRuleTemplatesForRepositoryOutput": { "type": "structure", "members": { - "approvalRuleTemplateNames": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateNameList", - "traits": { - "smithy.api#documentation": "

The names of all approval rule templates associated with the repository.

" - } - }, "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that allows the operation to batch the next results of the operation.

" } + }, + "approvalRuleTemplateNames": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateNameList", + "traits": { + "smithy.api#documentation": "

The names of all approval rule templates associated with the repository.

" + } } } }, @@ -7941,17 +7941,17 @@ "com.amazonaws.codecommit#ListBranchesOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codecommit#NextToken", - "traits": { - "smithy.api#documentation": "

An enumeration token that returns the batch of the results.

" - } - }, "branches": { "target": "com.amazonaws.codecommit#BranchNameList", "traits": { "smithy.api#documentation": "

The list of branch names.

" } + }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that returns the batch of the results.

" + } } }, "traits": { @@ -8026,6 +8026,12 @@ "smithy.api#required": {} } }, + "maxResults": { + "target": "com.amazonaws.codecommit#MaxResults", + "traits": { + "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results.

" + } + }, "authorArn": { "target": "com.amazonaws.codecommit#Arn", "traits": { @@ -8038,12 +8044,6 @@ "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, - "maxResults": { - "target": "com.amazonaws.codecommit#MaxResults", - "traits": { - "smithy.api#documentation": "

A non-zero, non-negative integer used to limit the number of returned results.

" - } - }, "pullRequestStatus": { "target": "com.amazonaws.codecommit#PullRequestStatusEnum", "traits": { @@ -8174,35 +8174,35 @@ "com.amazonaws.codecommit#ListRepositoriesForApprovalRuleTemplateOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codecommit#NextToken", - "traits": { - "smithy.api#documentation": "

An enumeration token that allows the operation to batch the next results of the operation.

" - } - }, "repositoryNames": { "target": "com.amazonaws.codecommit#RepositoryNameList", "traits": { "smithy.api#documentation": "

A list of repository names that are associated with the specified approval rule template.

" } + }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that allows the operation to batch the next results of the operation.

" + } } } }, "com.amazonaws.codecommit#ListRepositoriesInput": { "type": "structure", "members": { - "sortBy": { - "target": "com.amazonaws.codecommit#SortByEnum", - "traits": { - "smithy.api#documentation": "

The criteria used to sort the results of a list repositories operation.

" - } - }, "order": { "target": "com.amazonaws.codecommit#OrderEnum", "traits": { "smithy.api#documentation": "

The order in which to sort the results of a list repositories operation.

" } }, + "sortBy": { + "target": "com.amazonaws.codecommit#SortByEnum", + "traits": { + "smithy.api#documentation": "

The criteria used to sort the results of a list repositories operation.

" + } + }, "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { @@ -8217,17 +8217,17 @@ "com.amazonaws.codecommit#ListRepositoriesOutput": { "type": "structure", "members": { - "repositories": { - "target": "com.amazonaws.codecommit#RepositoryNameIdPairList", - "traits": { - "smithy.api#documentation": "

Lists the repositories called by the list repositories operation.

" - } - }, "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that allows the operation to batch the results of the operation. \n Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, \n another page of 1,000 records is retrieved.

" } + }, + "repositories": { + "target": "com.amazonaws.codecommit#RepositoryNameIdPairList", + "traits": { + "smithy.api#documentation": "

Lists the repositories called by the list repositories operation.

" + } } }, "traits": { @@ -8263,18 +8263,18 @@ "com.amazonaws.codecommit#ListTagsForResourceInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codecommit#NextToken", - "traits": { - "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" - } - }, "resourceArn": { "target": "com.amazonaws.codecommit#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want to get information\n about tags, if any.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" + } } } }, @@ -8573,6 +8573,13 @@ "smithy.api#required": {} } }, + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository where you want to merge two branches.

", + "smithy.api#required": {} + } + }, "sourceCommitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { @@ -8585,29 +8592,22 @@ "traits": { "smithy.api#documentation": "

The branch where the merge is applied.

" } - }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", - "traits": { - "smithy.api#documentation": "

The name of the repository where you want to merge two branches.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.codecommit#MergeBranchesByFastForwardOutput": { "type": "structure", "members": { - "commitId": { + "treeId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The commit ID of the merge in the destination or target branch.

" + "smithy.api#documentation": "

The tree ID of the merge in the destination or target branch.

" } }, - "treeId": { + "commitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The tree ID of the merge in the destination or target branch.

" + "smithy.api#documentation": "

The commit ID of the merge in the destination or target branch.

" } } } @@ -8746,24 +8746,16 @@ "com.amazonaws.codecommit#MergeBranchesBySquashInput": { "type": "structure", "members": { - "keepEmptyFolders": { - "target": "com.amazonaws.codecommit#KeepEmptyFolders", - "traits": { - "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If this is specified as true, a .gitkeep file is\n created for empty folders. The default is false.

" - } - }, - "sourceCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", + "conflictResolutionStrategy": { + "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" } }, - "destinationCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", + "conflictResolution": { + "target": "com.amazonaws.codecommit#ConflictResolution", "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", - "smithy.api#required": {} + "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" } }, "repositoryName": { @@ -8773,16 +8765,17 @@ "smithy.api#required": {} } }, - "conflictResolution": { - "target": "com.amazonaws.codecommit#ConflictResolution", + "keepEmptyFolders": { + "target": "com.amazonaws.codecommit#KeepEmptyFolders", "traits": { - "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" + "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If this is specified as true, a .gitkeep file is\n created for empty folders. The default is false.

" } }, - "email": { - "target": "com.amazonaws.codecommit#Email", + "sourceCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", "traits": { - "smithy.api#documentation": "

The email address of the person merging the branches. This information is used in the\n commit information for the merge.

" + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", + "smithy.api#required": {} } }, "conflictDetailLevel": { @@ -8791,22 +8784,23 @@ "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, - "authorName": { - "target": "com.amazonaws.codecommit#Name", + "email": { + "target": "com.amazonaws.codecommit#Email", "traits": { - "smithy.api#documentation": "

The name of the author who created the commit. This information is used as both the\n author and committer for the commit.

" + "smithy.api#documentation": "

The email address of the person merging the branches. This information is used in the\n commit information for the merge.

" } }, - "conflictResolutionStrategy": { - "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", + "authorName": { + "target": "com.amazonaws.codecommit#Name", "traits": { - "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" + "smithy.api#documentation": "

The name of the author who created the commit. This information is used as both the\n author and committer for the commit.

" } }, - "targetBranch": { - "target": "com.amazonaws.codecommit#BranchName", + "destinationCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", "traits": { - "smithy.api#documentation": "

The branch where the merge is applied.

" + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", + "smithy.api#required": {} } }, "commitMessage": { @@ -8814,22 +8808,28 @@ "traits": { "smithy.api#documentation": "

The commit message for the merge.

" } + }, + "targetBranch": { + "target": "com.amazonaws.codecommit#BranchName", + "traits": { + "smithy.api#documentation": "

The branch where the merge is applied.

" + } } } }, "com.amazonaws.codecommit#MergeBranchesBySquashOutput": { "type": "structure", "members": { - "treeId": { + "commitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The tree ID of the merge in the destination or target branch.

" + "smithy.api#documentation": "

The commit ID of the merge in the destination or target branch.

" } }, - "commitId": { + "treeId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The commit ID of the merge in the destination or target branch.

" + "smithy.api#documentation": "

The tree ID of the merge in the destination or target branch.

" } } } @@ -8968,6 +8968,18 @@ "com.amazonaws.codecommit#MergeBranchesByThreeWayInput": { "type": "structure", "members": { + "targetBranch": { + "target": "com.amazonaws.codecommit#BranchName", + "traits": { + "smithy.api#documentation": "

The branch where the merge is applied.

" + } + }, + "conflictResolutionStrategy": { + "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", + "traits": { + "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" + } + }, "sourceCommitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { @@ -8975,11 +8987,10 @@ "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "keepEmptyFolders": { + "target": "com.amazonaws.codecommit#KeepEmptyFolders", "traits": { - "smithy.api#documentation": "

The name of the repository where you want to merge two branches.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If true, a .gitkeep file is created for empty folders.\n The default is false.

" } }, "conflictResolution": { @@ -8988,16 +8999,11 @@ "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" } }, - "conflictResolutionStrategy": { - "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", - "traits": { - "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" - } - }, - "keepEmptyFolders": { - "target": "com.amazonaws.codecommit#KeepEmptyFolders", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If true, a .gitkeep file is created for empty folders.\n The default is false.

" + "smithy.api#documentation": "

The name of the repository where you want to merge two branches.

", + "smithy.api#required": {} } }, "email": { @@ -9012,19 +9018,6 @@ "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, - "destinationCommitSpecifier": { - "target": "com.amazonaws.codecommit#CommitName", - "traits": { - "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", - "smithy.api#required": {} - } - }, - "targetBranch": { - "target": "com.amazonaws.codecommit#BranchName", - "traits": { - "smithy.api#documentation": "

The branch where the merge is applied.

" - } - }, "authorName": { "target": "com.amazonaws.codecommit#Name", "traits": { @@ -9036,6 +9029,13 @@ "traits": { "smithy.api#documentation": "

The commit message to include in the commit information for the merge.

" } + }, + "destinationCommitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", + "traits": { + "smithy.api#documentation": "

The branch, tag, HEAD, or other fully qualified reference used to identify a commit\n (for example, a branch name or a full commit ID).

", + "smithy.api#required": {} + } } } }, @@ -9071,38 +9071,38 @@ "smithy.api#documentation": "

Information about the merge hunk in the source of a merge or pull request.

" } }, - "isConflict": { - "target": "com.amazonaws.codecommit#IsHunkConflict", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether a combination of hunks contains a conflict.\n Conflicts occur when the same file or the same lines in a file were modified in both the\n source and destination of a merge or pull request. Valid values include true, false, and\n null. True when the hunk represents a conflict and one or more files contains a line\n conflict. File mode conflicts in a merge do not set this to true.

" - } - }, "destination": { "target": "com.amazonaws.codecommit#MergeHunkDetail", "traits": { "smithy.api#documentation": "

Information about the merge hunk in the destination of a merge or pull request.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Information about merge hunks in a merge or pull request operation.

" + }, + "isConflict": { + "target": "com.amazonaws.codecommit#IsHunkConflict", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether a combination of hunks contains a conflict.\n Conflicts occur when the same file or the same lines in a file were modified in both the\n source and destination of a merge or pull request. Valid values include true, false, and\n null. True when the hunk represents a conflict and one or more files contains a line\n conflict. File mode conflicts in a merge do not set this to true.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about merge hunks in a merge or pull request operation.

" } }, "com.amazonaws.codecommit#MergeHunkDetail": { "type": "structure", "members": { - "endLine": { - "target": "com.amazonaws.codecommit#LineNumber", - "traits": { - "smithy.api#documentation": "

The end position of the hunk in the merge result.

" - } - }, "hunkContent": { "target": "com.amazonaws.codecommit#HunkContent", "traits": { "smithy.api#documentation": "

The base-64 encoded content of the hunk merged region that might contain a\n conflict.

" } }, + "endLine": { + "target": "com.amazonaws.codecommit#LineNumber", + "traits": { + "smithy.api#documentation": "

The end position of the hunk in the merge result.

" + } + }, "startLine": { "target": "com.amazonaws.codecommit#LineNumber", "traits": { @@ -9286,17 +9286,17 @@ "com.amazonaws.codecommit#MergePullRequestByFastForwardInput": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", "traits": { - "smithy.api#documentation": "

The name of the repository where the pull request was created.

", + "smithy.api#documentation": "

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

", "smithy.api#required": {} } }, - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

", + "smithy.api#documentation": "

The name of the repository where the pull request was created.

", "smithy.api#required": {} } }, @@ -9450,22 +9450,22 @@ "com.amazonaws.codecommit#MergePullRequestBySquashInput": { "type": "structure", "members": { - "sourceCommitId": { - "target": "com.amazonaws.codecommit#ObjectId", + "email": { + "target": "com.amazonaws.codecommit#Email", "traits": { - "smithy.api#documentation": "

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an \n exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

" + "smithy.api#documentation": "

The email address of the person merging the branches. This information is used in the\n commit information for the merge.

" } }, - "conflictDetailLevel": { - "target": "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum", + "conflictResolution": { + "target": "com.amazonaws.codecommit#ConflictResolution", "traits": { - "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" + "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" } }, - "email": { - "target": "com.amazonaws.codecommit#Email", + "sourceCommitId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The email address of the person merging the branches. This information is used in the\n commit information for the merge.

" + "smithy.api#documentation": "

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an \n exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

" } }, "authorName": { @@ -9486,17 +9486,16 @@ "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" } }, - "conflictResolution": { - "target": "com.amazonaws.codecommit#ConflictResolution", + "keepEmptyFolders": { + "target": "com.amazonaws.codecommit#KeepEmptyFolders", "traits": { - "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" + "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If true, a .gitkeep file is created for empty folders.\n The default is false.

" } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "conflictDetailLevel": { + "target": "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum", "traits": { - "smithy.api#documentation": "

The name of the repository where the pull request was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, "pullRequestId": { @@ -9506,10 +9505,11 @@ "smithy.api#required": {} } }, - "keepEmptyFolders": { - "target": "com.amazonaws.codecommit#KeepEmptyFolders", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If true, a .gitkeep file is created for empty folders.\n The default is false.

" + "smithy.api#documentation": "

The name of the repository where the pull request was created.

", + "smithy.api#required": {} } } } @@ -9653,10 +9653,10 @@ "com.amazonaws.codecommit#MergePullRequestByThreeWayInput": { "type": "structure", "members": { - "conflictResolutionStrategy": { - "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", + "authorName": { + "target": "com.amazonaws.codecommit#Name", "traits": { - "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" + "smithy.api#documentation": "

The name of the author who created the commit. This information is used as both the\n author and committer for the commit.

" } }, "conflictDetailLevel": { @@ -9665,10 +9665,10 @@ "smithy.api#documentation": "

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used,\n which returns a not-mergeable result if the same file has differences in both branches.\n If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in\n both branches has differences on the same line.

" } }, - "keepEmptyFolders": { - "target": "com.amazonaws.codecommit#KeepEmptyFolders", + "sourceCommitId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If true, a .gitkeep file is created for empty folders.\n The default is false.

" + "smithy.api#documentation": "

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an \n exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

" } }, "email": { @@ -9677,11 +9677,10 @@ "smithy.api#documentation": "

The email address of the person merging the branches. This information is used in the\n commit information for the merge.

" } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "conflictResolutionStrategy": { + "target": "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum", "traits": { - "smithy.api#documentation": "

The name of the repository where the pull request was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.

" } }, "pullRequestId": { @@ -9691,22 +9690,23 @@ "smithy.api#required": {} } }, - "conflictResolution": { - "target": "com.amazonaws.codecommit#ConflictResolution", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" + "smithy.api#documentation": "

The name of the repository where the pull request was created.

", + "smithy.api#required": {} } }, - "sourceCommitId": { - "target": "com.amazonaws.codecommit#ObjectId", + "keepEmptyFolders": { + "target": "com.amazonaws.codecommit#KeepEmptyFolders", "traits": { - "smithy.api#documentation": "

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an \n exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

" + "smithy.api#documentation": "

If the commit contains deletions, whether to keep a folder or folder structure if the\n changes leave the folders empty. If true, a .gitkeep file is created for empty folders.\n The default is false.

" } }, - "authorName": { - "target": "com.amazonaws.codecommit#Name", + "conflictResolution": { + "target": "com.amazonaws.codecommit#ConflictResolution", "traits": { - "smithy.api#documentation": "

The name of the author who created the commit. This information is used as both the\n author and committer for the commit.

" + "smithy.api#documentation": "

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.

" } }, "commitMessage": { @@ -9862,16 +9862,16 @@ "com.amazonaws.codecommit#ObjectTypes": { "type": "structure", "members": { - "destination": { + "source": { "target": "com.amazonaws.codecommit#ObjectTypeEnum", "traits": { - "smithy.api#documentation": "

The type of the object in the destination branch.

" + "smithy.api#documentation": "

The type of the object in the source branch.

" } }, - "source": { + "destination": { "target": "com.amazonaws.codecommit#ObjectTypeEnum", "traits": { - "smithy.api#documentation": "

The type of the object in the source branch.

" + "smithy.api#documentation": "

The type of the object in the destination branch.

" } }, "base": { @@ -10227,13 +10227,6 @@ "com.amazonaws.codecommit#PostCommentForComparedCommitInput": { "type": "structure", "members": { - "content": { - "target": "com.amazonaws.codecommit#Content", - "traits": { - "smithy.api#documentation": "

The content of the comment you want to make.

", - "smithy.api#required": {} - } - }, "clientRequestToken": { "target": "com.amazonaws.codecommit#ClientRequestToken", "traits": { @@ -10241,23 +10234,24 @@ "smithy.api#idempotencyToken": {} } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "location": { + "target": "com.amazonaws.codecommit#Location", "traits": { - "smithy.api#documentation": "

The name of the repository where you want to post a comment on the comparison between commits.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The location of the comparison where you want to comment.

" } }, - "beforeCommitId": { - "target": "com.amazonaws.codecommit#CommitId", + "content": { + "target": "com.amazonaws.codecommit#Content", "traits": { - "smithy.api#documentation": "

To establish the directionality of the comparison, the full commit ID of the before\n commit. Required for commenting on any commit unless that commit is the initial\n commit.

" + "smithy.api#documentation": "

The content of the comment you want to make.

", + "smithy.api#required": {} } }, - "location": { - "target": "com.amazonaws.codecommit#Location", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The location of the comparison where you want to comment.

" + "smithy.api#documentation": "

The name of the repository where you want to post a comment on the comparison between commits.

", + "smithy.api#required": {} } }, "afterCommitId": { @@ -10266,22 +10260,34 @@ "smithy.api#documentation": "

To establish the directionality of the comparison, the full commit ID of the after\n commit.

", "smithy.api#required": {} } + }, + "beforeCommitId": { + "target": "com.amazonaws.codecommit#CommitId", + "traits": { + "smithy.api#documentation": "

To establish the directionality of the comparison, the full commit ID of the before\n commit. Required for commenting on any commit unless that commit is the initial\n commit.

" + } } } }, "com.amazonaws.codecommit#PostCommentForComparedCommitOutput": { "type": "structure", "members": { - "location": { - "target": "com.amazonaws.codecommit#Location", + "afterCommitId": { + "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

The location of the comment in the comparison between the two commits.

" + "smithy.api#documentation": "

In the directionality you established, the full commit ID of the after commit.

" } }, - "afterBlobId": { - "target": "com.amazonaws.codecommit#ObjectId", + "comment": { + "target": "com.amazonaws.codecommit#Comment", "traits": { - "smithy.api#documentation": "

In the directionality you established, the blob ID of the after blob.

" + "smithy.api#documentation": "

The content of the comment you posted.

" + } + }, + "location": { + "target": "com.amazonaws.codecommit#Location", + "traits": { + "smithy.api#documentation": "

The location of the comment in the comparison between the two commits.

" } }, "beforeCommitId": { @@ -10296,22 +10302,16 @@ "smithy.api#documentation": "

The name of the repository where you posted a comment on the comparison between commits.

" } }, - "comment": { - "target": "com.amazonaws.codecommit#Comment", - "traits": { - "smithy.api#documentation": "

The content of the comment you posted.

" - } - }, - "afterCommitId": { - "target": "com.amazonaws.codecommit#CommitId", + "beforeBlobId": { + "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

In the directionality you established, the full commit ID of the after commit.

" + "smithy.api#documentation": "

In the directionality you established, the blob ID of the before blob.

" } }, - "beforeBlobId": { + "afterBlobId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

In the directionality you established, the blob ID of the before blob.

" + "smithy.api#documentation": "

In the directionality you established, the blob ID of the after blob.

" } } } @@ -10422,10 +10422,10 @@ "smithy.api#required": {} } }, - "content": { - "target": "com.amazonaws.codecommit#Content", + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", "traits": { - "smithy.api#documentation": "

The content of your comment on the change.

", + "smithy.api#documentation": "

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

", "smithy.api#required": {} } }, @@ -10436,19 +10436,13 @@ "smithy.api#required": {} } }, - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "content": { + "target": "com.amazonaws.codecommit#Content", "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

", + "smithy.api#documentation": "

The content of your comment on the change.

", "smithy.api#required": {} } }, - "location": { - "target": "com.amazonaws.codecommit#Location", - "traits": { - "smithy.api#documentation": "

The location of the change where you want to post your comment. If no location is\n provided, the comment is posted as a general comment on the pull request difference\n between the before commit ID and the after commit ID.

" - } - }, "afterCommitId": { "target": "com.amazonaws.codecommit#CommitId", "traits": { @@ -10462,6 +10456,12 @@ "smithy.api#documentation": "

A unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request is received with\n the same parameters and a token is included, the request returns information about the\n initial request that used that token.

", "smithy.api#idempotencyToken": {} } + }, + "location": { + "target": "com.amazonaws.codecommit#Location", + "traits": { + "smithy.api#documentation": "

The location of the change where you want to post your comment. If no location is\n provided, the comment is posted as a general comment on the pull request difference\n between the before commit ID and the after commit ID.

" + } } } }, @@ -10474,40 +10474,34 @@ "smithy.api#documentation": "

The full commit ID of the commit in the source branch used to create the pull request, \n or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.

" } }, - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", - "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request.

" - } - }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { "smithy.api#documentation": "

The name of the repository where you posted a comment on a pull request.

" } }, - "afterCommitId": { - "target": "com.amazonaws.codecommit#CommitId", + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", "traits": { - "smithy.api#documentation": "

The full commit ID of the commit in the destination branch where the pull request is\n merged.

" + "smithy.api#documentation": "

The system-generated ID of the pull request.

" } }, - "beforeBlobId": { + "afterBlobId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

In the directionality of the pull request, the blob ID of the before blob.

" + "smithy.api#documentation": "

In the directionality of the pull request, the blob ID of the after blob.

" } }, - "afterBlobId": { + "beforeBlobId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

In the directionality of the pull request, the blob ID of the after blob.

" + "smithy.api#documentation": "

In the directionality of the pull request, the blob ID of the before blob.

" } }, - "comment": { - "target": "com.amazonaws.codecommit#Comment", + "afterCommitId": { + "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

The content of the comment you posted.

" + "smithy.api#documentation": "

The full commit ID of the commit in the destination branch where the pull request is\n merged.

" } }, "location": { @@ -10515,6 +10509,12 @@ "traits": { "smithy.api#documentation": "

The location of the change where you posted your comment.

" } + }, + "comment": { + "target": "com.amazonaws.codecommit#Comment", + "traits": { + "smithy.api#documentation": "

The content of the comment you posted.

" + } } } }, @@ -10560,13 +10560,6 @@ "com.amazonaws.codecommit#PostCommentReplyInput": { "type": "structure", "members": { - "content": { - "target": "com.amazonaws.codecommit#Content", - "traits": { - "smithy.api#documentation": "

The contents of your reply to a comment.

", - "smithy.api#required": {} - } - }, "clientRequestToken": { "target": "com.amazonaws.codecommit#ClientRequestToken", "traits": { @@ -10574,6 +10567,13 @@ "smithy.api#idempotencyToken": {} } }, + "content": { + "target": "com.amazonaws.codecommit#Content", + "traits": { + "smithy.api#documentation": "

The contents of your reply to a comment.

", + "smithy.api#required": {} + } + }, "inReplyTo": { "target": "com.amazonaws.codecommit#CommentId", "traits": { @@ -10597,52 +10597,52 @@ "com.amazonaws.codecommit#PullRequest": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.codecommit#Description", + "approvalRules": { + "target": "com.amazonaws.codecommit#ApprovalRulesList", "traits": { - "smithy.api#documentation": "

The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

" + "smithy.api#documentation": "

The approval rules applied to the pull request.

" } }, - "clientRequestToken": { - "target": "com.amazonaws.codecommit#ClientRequestToken", + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", "traits": { - "smithy.api#documentation": "

A unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request is received with\n the same parameters and a token is included, the request returns information about the\n initial request that used that token.

" + "smithy.api#documentation": "

The system-generated ID of the pull request.

" } }, - "authorArn": { - "target": "com.amazonaws.codecommit#Arn", + "lastActivityDate": { + "target": "com.amazonaws.codecommit#LastModifiedDate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the pull request.

" + "smithy.api#documentation": "

The day and time of the last user or system activity on the pull request, in timestamp format.

" } }, - "pullRequestStatus": { - "target": "com.amazonaws.codecommit#PullRequestStatusEnum", + "creationDate": { + "target": "com.amazonaws.codecommit#CreationDate", "traits": { - "smithy.api#documentation": "

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

" + "smithy.api#documentation": "

The date and time the pull request was originally created, in timestamp format.

" } }, - "lastActivityDate": { - "target": "com.amazonaws.codecommit#LastModifiedDate", + "authorArn": { + "target": "com.amazonaws.codecommit#Arn", "traits": { - "smithy.api#documentation": "

The day and time of the last user or system activity on the pull request, in timestamp format.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the pull request.

" } }, - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "description": { + "target": "com.amazonaws.codecommit#Description", "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request.

" + "smithy.api#documentation": "

The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

" } }, - "creationDate": { - "target": "com.amazonaws.codecommit#CreationDate", + "clientRequestToken": { + "target": "com.amazonaws.codecommit#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The date and time the pull request was originally created, in timestamp format.

" + "smithy.api#documentation": "

A unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request is received with\n the same parameters and a token is included, the request returns information about the\n initial request that used that token.

" } }, - "approvalRules": { - "target": "com.amazonaws.codecommit#ApprovalRulesList", + "pullRequestStatus": { + "target": "com.amazonaws.codecommit#PullRequestStatusEnum", "traits": { - "smithy.api#documentation": "

The approval rules applied to the pull request.

" + "smithy.api#documentation": "

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

" } }, "title": { @@ -10651,17 +10651,17 @@ "smithy.api#documentation": "

The user-defined title of the pull request. This title is displayed in the list of\n pull requests to other repository users.

" } }, - "pullRequestTargets": { - "target": "com.amazonaws.codecommit#PullRequestTargetList", - "traits": { - "smithy.api#documentation": "

The targets of the pull request, including the source branch and destination branch for the pull request.

" - } - }, "revisionId": { "target": "com.amazonaws.codecommit#RevisionId", "traits": { "smithy.api#documentation": "

The system-generated revision ID for the pull request.

" } + }, + "pullRequestTargets": { + "target": "com.amazonaws.codecommit#PullRequestTargetList", + "traits": { + "smithy.api#documentation": "

The targets of the pull request, including the source branch and destination branch for the pull request.

" + } } }, "traits": { @@ -10763,16 +10763,28 @@ "com.amazonaws.codecommit#PullRequestEvent": { "type": "structure", "members": { - "pullRequestStatusChangedEventMetadata": { - "target": "com.amazonaws.codecommit#PullRequestStatusChangedEventMetadata", + "actorArn": { + "target": "com.amazonaws.codecommit#Arn", "traits": { - "smithy.api#documentation": "

Information about the change in status for the pull request event.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user whose actions resulted in the event.\n Examples include updating the pull request with more commits or changing the status of a\n pull request.

" } }, - "approvalRuleOverriddenEventMetadata": { - "target": "com.amazonaws.codecommit#ApprovalRuleOverriddenEventMetadata", + "pullRequestCreatedEventMetadata": { + "target": "com.amazonaws.codecommit#PullRequestCreatedEventMetadata", "traits": { - "smithy.api#documentation": "

Information about an approval rule override event for a pull request.

" + "smithy.api#documentation": "

Information about the source and destination branches for the pull request.

" + } + }, + "pullRequestId": { + "target": "com.amazonaws.codecommit#PullRequestId", + "traits": { + "smithy.api#documentation": "

The system-generated ID of the pull request.

" + } + }, + "pullRequestStatusChangedEventMetadata": { + "target": "com.amazonaws.codecommit#PullRequestStatusChangedEventMetadata", + "traits": { + "smithy.api#documentation": "

Information about the change in status for the pull request event.

" } }, "pullRequestEventType": { @@ -10781,10 +10793,10 @@ "smithy.api#documentation": "

The type of the pull request event (for example, a status change event\n (PULL_REQUEST_STATUS_CHANGED) or update event\n (PULL_REQUEST_SOURCE_REFERENCE_UPDATED)).

" } }, - "pullRequestCreatedEventMetadata": { - "target": "com.amazonaws.codecommit#PullRequestCreatedEventMetadata", + "approvalRuleOverriddenEventMetadata": { + "target": "com.amazonaws.codecommit#ApprovalRuleOverriddenEventMetadata", "traits": { - "smithy.api#documentation": "

Information about the source and destination branches for the pull request.

" + "smithy.api#documentation": "

Information about an approval rule override event for a pull request.

" } }, "pullRequestSourceReferenceUpdatedEventMetadata": { @@ -10793,22 +10805,16 @@ "smithy.api#documentation": "

Information about the updated source branch for the pull request event.

" } }, - "approvalStateChangedEventMetadata": { - "target": "com.amazonaws.codecommit#ApprovalStateChangedEventMetadata", - "traits": { - "smithy.api#documentation": "

Information about an approval state change for a pull request.

" - } - }, "approvalRuleEventMetadata": { "target": "com.amazonaws.codecommit#ApprovalRuleEventMetadata", "traits": { "smithy.api#documentation": "

Information about a pull request event.

" } }, - "pullRequestId": { - "target": "com.amazonaws.codecommit#PullRequestId", + "approvalStateChangedEventMetadata": { + "target": "com.amazonaws.codecommit#ApprovalStateChangedEventMetadata", "traits": { - "smithy.api#documentation": "

The system-generated ID of the pull request.

" + "smithy.api#documentation": "

Information about an approval state change for a pull request.

" } }, "eventDate": { @@ -10817,12 +10823,6 @@ "smithy.api#documentation": "

The day and time of the pull request event, in timestamp format.

" } }, - "actorArn": { - "target": "com.amazonaws.codecommit#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user whose actions resulted in the event.\n Examples include updating the pull request with more commits or changing the status of a\n pull request.

" - } - }, "pullRequestMergedStateChangedEventMetadata": { "target": "com.amazonaws.codecommit#PullRequestMergedStateChangedEventMetadata", "traits": { @@ -10910,18 +10910,18 @@ "com.amazonaws.codecommit#PullRequestMergedStateChangedEventMetadata": { "type": "structure", "members": { - "destinationReference": { - "target": "com.amazonaws.codecommit#ReferenceName", - "traits": { - "smithy.api#documentation": "

The name of the branch that the pull request is merged into.

" - } - }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { "smithy.api#documentation": "

The name of the repository where the pull request was created.

" } }, + "destinationReference": { + "target": "com.amazonaws.codecommit#ReferenceName", + "traits": { + "smithy.api#documentation": "

The name of the branch that the pull request is merged into.

" + } + }, "mergeMetadata": { "target": "com.amazonaws.codecommit#MergeMetadata", "traits": { @@ -10936,10 +10936,10 @@ "com.amazonaws.codecommit#PullRequestSourceReferenceUpdatedEventMetadata": { "type": "structure", "members": { - "beforeCommitId": { + "mergeBase": { "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was updated.

" + "smithy.api#documentation": "

The commit ID of the most recent commit that the source branch and the destination branch have in common.

" } }, "afterCommitId": { @@ -10948,10 +10948,10 @@ "smithy.api#documentation": "

The full commit ID of the commit in the source branch that was the tip of the branch at the time the pull request was updated.

" } }, - "mergeBase": { + "beforeCommitId": { "target": "com.amazonaws.codecommit#CommitId", "traits": { - "smithy.api#documentation": "

The commit ID of the most recent commit that the source branch and the destination branch have in common.

" + "smithy.api#documentation": "

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was updated.

" } }, "repositoryName": { @@ -11012,16 +11012,22 @@ "com.amazonaws.codecommit#PullRequestTarget": { "type": "structure", "members": { + "mergeMetadata": { + "target": "com.amazonaws.codecommit#MergeMetadata", + "traits": { + "smithy.api#documentation": "

Returns metadata about the state of the merge, including whether the merge has been made.

" + } + }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { "smithy.api#documentation": "

The name of the repository that contains the pull request source and destination branches.

" } }, - "destinationReference": { + "sourceReference": { "target": "com.amazonaws.codecommit#ReferenceName", "traits": { - "smithy.api#documentation": "

The branch of the repository where the pull request changes are merged. Also known as\n the destination branch.

" + "smithy.api#documentation": "

The branch of the repository that contains the changes for the pull request. Also known as the source branch.

" } }, "destinationCommit": { @@ -11036,16 +11042,10 @@ "smithy.api#documentation": "

The full commit ID of the tip of the source branch used to create the pull request. If\n the pull request branch is updated by a push while the pull request is open, the commit\n ID changes to reflect the new tip of the branch.

" } }, - "sourceReference": { + "destinationReference": { "target": "com.amazonaws.codecommit#ReferenceName", "traits": { - "smithy.api#documentation": "

The branch of the repository that contains the changes for the pull request. Also known as the source branch.

" - } - }, - "mergeMetadata": { - "target": "com.amazonaws.codecommit#MergeMetadata", - "traits": { - "smithy.api#documentation": "

Returns metadata about the state of the merge, including whether the merge has been made.

" + "smithy.api#documentation": "

The branch of the repository where the pull request changes are merged. Also known as\n the destination branch.

" } }, "mergeBase": { @@ -11235,12 +11235,6 @@ "smithy.api#documentation": "

The name and full path of the file that contains the changes you want to make as part of the commit, \n if you are not providing the file content directly.

" } }, - "fileMode": { - "target": "com.amazonaws.codecommit#FileModeTypeEnum", - "traits": { - "smithy.api#documentation": "

The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

" - } - }, "filePath": { "target": "com.amazonaws.codecommit#Path", "traits": { @@ -11248,6 +11242,12 @@ "smithy.api#required": {} } }, + "fileMode": { + "target": "com.amazonaws.codecommit#FileModeTypeEnum", + "traits": { + "smithy.api#documentation": "

The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

" + } + }, "fileContent": { "target": "com.amazonaws.codecommit#FileContent", "traits": { @@ -11283,11 +11283,10 @@ "smithy.api#documentation": "

The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, \n no commit ID is required. If this is not an empty repository, a commit ID is required.

\n

The commit ID must match the ID of the head commit at the time of the operation.\n Otherwise, an error occurs, and the file is not added or updated.

" } }, - "branchName": { - "target": "com.amazonaws.codecommit#BranchName", + "name": { + "target": "com.amazonaws.codecommit#Name", "traits": { - "smithy.api#documentation": "

The name of the branch where you want to add or update the file. If this is an empty\n repository, this branch is created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the person adding or updating the file. Although it is optional, a name\n makes the commit history for your repository more useful.

" } }, "fileContent": { @@ -11297,42 +11296,43 @@ "smithy.api#required": {} } }, - "fileMode": { - "target": "com.amazonaws.codecommit#FileModeTypeEnum", + "branchName": { + "target": "com.amazonaws.codecommit#BranchName", "traits": { - "smithy.api#documentation": "

The file mode permissions of the blob. Valid file mode permissions are listed\n here.

" + "smithy.api#documentation": "

The name of the branch where you want to add or update the file. If this is an empty\n repository, this branch is created.

", + "smithy.api#required": {} } }, - "email": { - "target": "com.amazonaws.codecommit#Email", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

An email address for the person adding or updating the file.

" + "smithy.api#documentation": "

The name of the repository where you want to add or update the file.

", + "smithy.api#required": {} } }, - "filePath": { - "target": "com.amazonaws.codecommit#Path", + "commitMessage": { + "target": "com.amazonaws.codecommit#Message", "traits": { - "smithy.api#documentation": "

The name of the file you want to add or update, including the relative path to the file in the repository.

\n \n

If the path does not currently exist in the repository, the path is created as part of adding\n the file.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

A message about why this file was added or updated. Although it is optional, a message\n makes the commit history for your repository more useful.

" } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "filePath": { + "target": "com.amazonaws.codecommit#Path", "traits": { - "smithy.api#documentation": "

The name of the repository where you want to add or update the file.

", + "smithy.api#documentation": "

The name of the file you want to add or update, including the relative path to the file in the repository.

\n \n

If the path does not currently exist in the repository, the path is created as part of adding\n the file.

\n ", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.codecommit#Name", + "email": { + "target": "com.amazonaws.codecommit#Email", "traits": { - "smithy.api#documentation": "

The name of the person adding or updating the file. Although it is optional, a name\n makes the commit history for your repository more useful.

" + "smithy.api#documentation": "

An email address for the person adding or updating the file.

" } }, - "commitMessage": { - "target": "com.amazonaws.codecommit#Message", + "fileMode": { + "target": "com.amazonaws.codecommit#FileModeTypeEnum", "traits": { - "smithy.api#documentation": "

A message about why this file was added or updated. Although it is optional, a message\n makes the commit history for your repository more useful.

" + "smithy.api#documentation": "

The file mode permissions of the blob. Valid file mode permissions are listed\n here.

" } } } @@ -11340,24 +11340,24 @@ "com.amazonaws.codecommit#PutFileOutput": { "type": "structure", "members": { - "blobId": { + "commitId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The ID of the blob, which is its SHA-1 pointer.

", + "smithy.api#documentation": "

The full SHA ID of the commit that contains this file change.

", "smithy.api#required": {} } }, - "treeId": { + "blobId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The full SHA-1 pointer of the tree information for the commit that contains this file change.

", + "smithy.api#documentation": "

The ID of the blob, which is its SHA-1 pointer.

", "smithy.api#required": {} } }, - "commitId": { + "treeId": { "target": "com.amazonaws.codecommit#ObjectId", "traits": { - "smithy.api#documentation": "

The full SHA ID of the commit that contains this file change.

", + "smithy.api#documentation": "

The full SHA-1 pointer of the tree information for the commit that contains this file change.

", "smithy.api#required": {} } } @@ -11792,10 +11792,10 @@ "com.amazonaws.codecommit#RepositoryMetadata": { "type": "structure", "members": { - "cloneUrlHttp": { - "target": "com.amazonaws.codecommit#CloneUrlHttp", + "repositoryId": { + "target": "com.amazonaws.codecommit#RepositoryId", "traits": { - "smithy.api#documentation": "

The URL to use for cloning the repository over HTTPS.

" + "smithy.api#documentation": "

The ID of the repository.

" } }, "repositoryDescription": { @@ -11804,10 +11804,10 @@ "smithy.api#documentation": "

A comment or description about the repository.

" } }, - "repositoryId": { - "target": "com.amazonaws.codecommit#RepositoryId", + "cloneUrlHttp": { + "target": "com.amazonaws.codecommit#CloneUrlHttp", "traits": { - "smithy.api#documentation": "

The ID of the repository.

" + "smithy.api#documentation": "

The URL to use for cloning the repository over HTTPS.

" } }, "lastModifiedDate": { @@ -11816,22 +11816,22 @@ "smithy.api#documentation": "

The date and time the repository was last modified, in timestamp format.

" } }, - "cloneUrlSsh": { - "target": "com.amazonaws.codecommit#CloneUrlSsh", + "defaultBranch": { + "target": "com.amazonaws.codecommit#BranchName", "traits": { - "smithy.api#documentation": "

The URL to use for cloning the repository over SSH.

" + "smithy.api#documentation": "

The repository's default branch name.

" } }, - "accountId": { - "target": "com.amazonaws.codecommit#AccountId", + "cloneUrlSsh": { + "target": "com.amazonaws.codecommit#CloneUrlSsh", "traits": { - "smithy.api#documentation": "

The ID of the AWS account associated with the repository.

" + "smithy.api#documentation": "

The URL to use for cloning the repository over SSH.

" } }, - "defaultBranch": { - "target": "com.amazonaws.codecommit#BranchName", + "Arn": { + "target": "com.amazonaws.codecommit#Arn", "traits": { - "smithy.api#documentation": "

The repository's default branch name.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the repository.

" } }, "repositoryName": { @@ -11846,10 +11846,10 @@ "smithy.api#documentation": "

The date and time the repository was created, in timestamp format.

" } }, - "Arn": { - "target": "com.amazonaws.codecommit#Arn", + "accountId": { + "target": "com.amazonaws.codecommit#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the repository.

" + "smithy.api#documentation": "

The ID of the AWS account associated with the repository.

" } } }, @@ -11891,17 +11891,17 @@ "com.amazonaws.codecommit#RepositoryNameIdPair": { "type": "structure", "members": { - "repositoryId": { - "target": "com.amazonaws.codecommit#RepositoryId", - "traits": { - "smithy.api#documentation": "

The ID associated with the repository.

" - } - }, "repositoryName": { "target": "com.amazonaws.codecommit#RepositoryName", "traits": { "smithy.api#documentation": "

The name associated with the repository.

" } + }, + "repositoryId": { + "target": "com.amazonaws.codecommit#RepositoryId", + "traits": { + "smithy.api#documentation": "

The ID associated with the repository.

" + } } }, "traits": { @@ -11974,12 +11974,6 @@ "com.amazonaws.codecommit#RepositoryTrigger": { "type": "structure", "members": { - "customData": { - "target": "com.amazonaws.codecommit#RepositoryTriggerCustomData", - "traits": { - "smithy.api#documentation": "

Any custom data associated with the trigger to be included in the information sent to\n the target of the trigger.

" - } - }, "destinationArn": { "target": "com.amazonaws.codecommit#Arn", "traits": { @@ -11987,17 +11981,23 @@ "smithy.api#required": {} } }, + "name": { + "target": "com.amazonaws.codecommit#RepositoryTriggerName", + "traits": { + "smithy.api#documentation": "

The name of the trigger.

", + "smithy.api#required": {} + } + }, "branches": { "target": "com.amazonaws.codecommit#BranchNameList", "traits": { "smithy.api#documentation": "

The branches to be included in the trigger configuration. If you specify an empty\n array, the trigger applies to all branches.

\n \n

Although no content is required in the array, you must include the array itself.

\n " } }, - "name": { - "target": "com.amazonaws.codecommit#RepositoryTriggerName", + "customData": { + "target": "com.amazonaws.codecommit#RepositoryTriggerCustomData", "traits": { - "smithy.api#documentation": "

The name of the trigger.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Any custom data associated with the trigger to be included in the information sent to\n the target of the trigger.

" } }, "events": { @@ -12567,17 +12567,17 @@ "com.amazonaws.codecommit#Target": { "type": "structure", "members": { - "sourceReference": { - "target": "com.amazonaws.codecommit#ReferenceName", + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", "traits": { - "smithy.api#documentation": "

The branch of the repository that contains the changes for the pull request. Also known as the source branch.

", + "smithy.api#documentation": "

The name of the repository that contains the pull request.

", "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.codecommit#RepositoryName", + "sourceReference": { + "target": "com.amazonaws.codecommit#ReferenceName", "traits": { - "smithy.api#documentation": "

The name of the repository that contains the pull request.

", + "smithy.api#documentation": "

The branch of the repository that contains the changes for the pull request. Also known as the source branch.

", "smithy.api#required": {} } }, @@ -12908,17 +12908,17 @@ "com.amazonaws.codecommit#UpdateApprovalRuleTemplateContentInput": { "type": "structure", "members": { - "newRuleContent": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateContent", + "approvalRuleTemplateName": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", "traits": { - "smithy.api#documentation": "

The content that replaces the existing content of the rule. Content statements must be\n complete. You cannot provide only the changes.

", + "smithy.api#documentation": "

The name of the approval rule template where you want to update the content of the rule.

", "smithy.api#required": {} } }, - "approvalRuleTemplateName": { - "target": "com.amazonaws.codecommit#ApprovalRuleTemplateName", + "newRuleContent": { + "target": "com.amazonaws.codecommit#ApprovalRuleTemplateContent", "traits": { - "smithy.api#documentation": "

The name of the approval rule template where you want to update the content of the rule.

", + "smithy.api#documentation": "

The content that replaces the existing content of the rule. Content statements must be\n complete. You cannot provide only the changes.

", "smithy.api#required": {} } }, @@ -13093,17 +13093,17 @@ "com.amazonaws.codecommit#UpdateCommentInput": { "type": "structure", "members": { - "content": { - "target": "com.amazonaws.codecommit#Content", + "commentId": { + "target": "com.amazonaws.codecommit#CommentId", "traits": { - "smithy.api#documentation": "

The updated content to replace the existing content of the comment.

", + "smithy.api#documentation": "

The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit \n or GetCommentsForPullRequest.

", "smithy.api#required": {} } }, - "commentId": { - "target": "com.amazonaws.codecommit#CommentId", + "content": { + "target": "com.amazonaws.codecommit#Content", "traits": { - "smithy.api#documentation": "

The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit \n or GetCommentsForPullRequest.

", + "smithy.api#documentation": "

The updated content to replace the existing content of the comment.

", "smithy.api#required": {} } } @@ -13251,17 +13251,17 @@ "com.amazonaws.codecommit#UpdatePullRequestApprovalRuleContentInput": { "type": "structure", "members": { - "newRuleContent": { - "target": "com.amazonaws.codecommit#ApprovalRuleContent", + "approvalRuleName": { + "target": "com.amazonaws.codecommit#ApprovalRuleName", "traits": { - "smithy.api#documentation": "

The updated content for the approval rule.

\n \n

When you update the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:

\n
    \n
  • \n

    \n CodeCommitApprovers: This option only\n requires an AWS account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the AWS account 123456789012\n and Mary_Major, all of the following are counted as\n approvals coming from that user:

    \n
      \n
    • \n

      An IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)

      \n
      • \n
    • \n

      A federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)

      \n
      • \n
    \n

    This option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).

    \n
    • \n
  • \n

    \n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.

    \n
    • \n
\n

For more information about IAM ARNs, wildcards, and formats, see IAM\n Identifiers in the IAM User Guide.

\n \n ", + "smithy.api#documentation": "

The name of the approval rule you want to update.

", "smithy.api#required": {} } }, - "approvalRuleName": { - "target": "com.amazonaws.codecommit#ApprovalRuleName", + "newRuleContent": { + "target": "com.amazonaws.codecommit#ApprovalRuleContent", "traits": { - "smithy.api#documentation": "

The name of the approval rule you want to update.

", + "smithy.api#documentation": "

The updated content for the approval rule.

\n \n

When you update the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:

\n
    \n
  • \n

    \n CodeCommitApprovers: This option only\n requires an AWS account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the AWS account 123456789012\n and Mary_Major, all of the following are counted as\n approvals coming from that user:

    \n
      \n
    • \n

      An IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)

      \n
      • \n
    • \n

      A federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)

      \n
      • \n
    \n

    This option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).

    \n
    • \n
  • \n

    \n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.

    \n
    • \n
\n

For more information about IAM ARNs, wildcards, and formats, see IAM\n Identifiers in the IAM User Guide.

\n \n ", "smithy.api#required": {} } }, @@ -13691,17 +13691,17 @@ "smithy.api#documentation": "

The name of the user who made the specified commit.

" } }, - "date": { - "target": "com.amazonaws.codecommit#Date", - "traits": { - "smithy.api#documentation": "

The date when the specified commit was commited, in timestamp format with GMT offset.

" - } - }, "email": { "target": "com.amazonaws.codecommit#Email", "traits": { "smithy.api#documentation": "

The email address associated with the user who made the commit, if any.

" } + }, + "date": { + "target": "com.amazonaws.codecommit#Date", + "traits": { + "smithy.api#documentation": "

The date when the specified commit was commited, in timestamp format with GMT offset.

" + } } }, "traits": { 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 0a8d189fa79a..2cd95f012f5d 100644 --- a/codegen/sdk-codegen/aws-models/codedeploy.2014-10-06.json +++ b/codegen/sdk-codegen/aws-models/codedeploy.2014-10-06.json @@ -86,9 +86,7 @@ "com.amazonaws.codedeploy#AdditionalDeploymentStatusInfo": { "type": "string", "traits": { - "smithy.api#deprecated": { - "message": "AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead." - } + "smithy.api#deprecated": {} } }, "com.amazonaws.codedeploy#Alarm": { @@ -108,12 +106,6 @@ "com.amazonaws.codedeploy#AlarmConfiguration": { "type": "structure", "members": { - "ignorePollAlarmFailure": { - "target": "com.amazonaws.codedeploy#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether a deployment should continue if information about the current state\n of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

\n " - } - }, "enabled": { "target": "com.amazonaws.codedeploy#Boolean", "traits": { @@ -125,6 +117,12 @@ "traits": { "smithy.api#documentation": "

A list of alarms configured for the deployment group. A maximum of 10 alarms can be\n added to a deployment group.

" } + }, + "ignorePollAlarmFailure": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a deployment should continue if information about the current state\n of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

\n " + } } }, "traits": { @@ -211,16 +209,10 @@ "com.amazonaws.codedeploy#ApplicationInfo": { "type": "structure", "members": { - "createTime": { - "target": "com.amazonaws.codedeploy#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the application was created.

" - } - }, - "linkedToGitHub": { - "target": "com.amazonaws.codedeploy#Boolean", + "gitHubAccountName": { + "target": "com.amazonaws.codedeploy#GitHubAccountTokenName", "traits": { - "smithy.api#documentation": "

True if the user has authenticated with GitHub for the specified application.\n Otherwise, false.

" + "smithy.api#documentation": "

The name for a connection to a GitHub account.

" } }, "computePlatform": { @@ -229,10 +221,10 @@ "smithy.api#documentation": "

The destination platform type for deployment of the application (Lambda\n or Server).

" } }, - "gitHubAccountName": { - "target": "com.amazonaws.codedeploy#GitHubAccountTokenName", + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

The name for a connection to a GitHub account.

" + "smithy.api#documentation": "

The time at which the application was created.

" } }, "applicationName": { @@ -246,6 +238,12 @@ "traits": { "smithy.api#documentation": "

The application ID.

" } + }, + "linkedToGitHub": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#documentation": "

True if the user has authenticated with GitHub for the specified application.\n Otherwise, false.

" + } } }, "traits": { @@ -349,17 +347,17 @@ "com.amazonaws.codedeploy#AutoRollbackConfiguration": { "type": "structure", "members": { - "events": { - "target": "com.amazonaws.codedeploy#AutoRollbackEventsList", - "traits": { - "smithy.api#documentation": "

The event type or types that trigger a rollback.

" - } - }, "enabled": { "target": "com.amazonaws.codedeploy#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether a defined automatic rollback configuration is currently\n enabled.

" } + }, + "events": { + "target": "com.amazonaws.codedeploy#AutoRollbackEventsList", + "traits": { + "smithy.api#documentation": "

The event type or types that trigger a rollback.

" + } } }, "traits": { @@ -394,17 +392,17 @@ "com.amazonaws.codedeploy#AutoScalingGroup": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.codedeploy#AutoScalingGroupName", - "traits": { - "smithy.api#documentation": "

The Auto Scaling group name.

" - } - }, "hook": { "target": "com.amazonaws.codedeploy#AutoScalingGroupHook", "traits": { "smithy.api#documentation": "

An Auto Scaling lifecycle event hook name.

" } + }, + "name": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupName", + "traits": { + "smithy.api#documentation": "

The Auto Scaling group name.

" + } } }, "traits": { @@ -464,17 +462,17 @@ "com.amazonaws.codedeploy#BatchGetApplicationRevisionsInput": { "type": "structure", "members": { - "revisions": { - "target": "com.amazonaws.codedeploy#RevisionLocationList", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

An array of RevisionLocation objects that specify information to get about the application revisions, including type and\n location. The maximum number of RevisionLocation objects you can specify is 25.

", + "smithy.api#documentation": "

The name of an AWS CodeDeploy application about which to get revision\n information.

", "smithy.api#required": {} } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "revisions": { + "target": "com.amazonaws.codedeploy#RevisionLocationList", "traits": { - "smithy.api#documentation": "

The name of an AWS CodeDeploy application about which to get revision\n information.

", + "smithy.api#documentation": "

An array of RevisionLocation objects that specify information to get about the application revisions, including type and\n location. The maximum number of RevisionLocation objects you can specify is 25.

", "smithy.api#required": {} } } @@ -492,17 +490,17 @@ "smithy.api#documentation": "

Information about errors that might have occurred during the API call.

" } }, - "revisions": { - "target": "com.amazonaws.codedeploy#RevisionInfoList", - "traits": { - "smithy.api#documentation": "

Additional information about the revisions, including the type and location.

" - } - }, "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { "smithy.api#documentation": "

The name of the application that corresponds to the revisions.

" } + }, + "revisions": { + "target": "com.amazonaws.codedeploy#RevisionInfoList", + "traits": { + "smithy.api#documentation": "

Additional information about the revisions, including the type and location.

" + } } }, "traits": { @@ -602,17 +600,17 @@ "com.amazonaws.codedeploy#BatchGetDeploymentGroupsInput": { "type": "structure", "members": { - "deploymentGroupNames": { - "target": "com.amazonaws.codedeploy#DeploymentGroupsList", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

The names of the deployment groups.

", + "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or\n AWS account.

", "smithy.api#required": {} } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "deploymentGroupNames": { + "target": "com.amazonaws.codedeploy#DeploymentGroupsList", "traits": { - "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the applicable IAM user or\n AWS account.

", + "smithy.api#documentation": "

The names of the deployment groups.

", "smithy.api#required": {} } } @@ -682,17 +680,17 @@ "com.amazonaws.codedeploy#BatchGetDeploymentInstancesInput": { "type": "structure", "members": { - "instanceIds": { - "target": "com.amazonaws.codedeploy#InstancesList", + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.

", + "smithy.api#documentation": "

The unique ID of a deployment.

", "smithy.api#required": {} } }, - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", + "instanceIds": { + "target": "com.amazonaws.codedeploy#InstancesList", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#documentation": "

The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.

", "smithy.api#required": {} } } @@ -912,18 +910,18 @@ "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration": { "type": "structure", "members": { - "deploymentReadyOption": { - "target": "com.amazonaws.codedeploy#DeploymentReadyOption", - "traits": { - "smithy.api#documentation": "

Information about the action to take when newly provisioned instances are ready to\n receive traffic in a blue/green deployment.

" - } - }, "greenFleetProvisioningOption": { "target": "com.amazonaws.codedeploy#GreenFleetProvisioningOption", "traits": { "smithy.api#documentation": "

Information about how instances are provisioned for a replacement environment in a\n blue/green deployment.

" } }, + "deploymentReadyOption": { + "target": "com.amazonaws.codedeploy#DeploymentReadyOption", + "traits": { + "smithy.api#documentation": "

Information about the action to take when newly provisioned instances are ready to\n receive traffic in a blue/green deployment.

" + } + }, "terminateBlueInstancesOnDeploymentSuccess": { "target": "com.amazonaws.codedeploy#BlueInstanceTerminationOption", "traits": { @@ -938,17 +936,17 @@ "com.amazonaws.codedeploy#BlueInstanceTerminationOption": { "type": "structure", "members": { - "terminationWaitTimeInMinutes": { - "target": "com.amazonaws.codedeploy#Duration", - "traits": { - "smithy.api#documentation": "

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before\n terminating instances from the original environment.

\n \n

\n For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, \n CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. \n

\n \n

\n The maximum setting is 2880 minutes (2 days).\n

" - } - }, "action": { "target": "com.amazonaws.codedeploy#InstanceAction", "traits": { "smithy.api#documentation": "

The action to take on instances in the original environment after a successful\n blue/green deployment.

\n " } + }, + "terminationWaitTimeInMinutes": { + "target": "com.amazonaws.codedeploy#Duration", + "traits": { + "smithy.api#documentation": "

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before\n terminating instances from the original environment.

\n \n

\n For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, \n CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. \n

\n \n

\n The maximum setting is 2880 minutes (2 days).\n

" + } } }, "traits": { @@ -1006,16 +1004,16 @@ "com.amazonaws.codedeploy#CloudFormationTarget": { "type": "structure", "members": { - "targetVersionWeight": { - "target": "com.amazonaws.codedeploy#TrafficWeight", + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", "traits": { - "smithy.api#documentation": "

The percentage of production traffic that the target version of an AWS CloudFormation\n blue/green deployment receives.

" + "smithy.api#documentation": "

The lifecycle events of the AWS CloudFormation blue/green deployment to this target\n application.

" } }, - "targetId": { - "target": "com.amazonaws.codedeploy#TargetId", + "status": { + "target": "com.amazonaws.codedeploy#TargetStatus", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment target that has a type\n of CloudFormationTarget.

" + "smithy.api#documentation": "

The status of an AWS CloudFormation blue/green deployment's target application.

" } }, "resourceType": { @@ -1024,16 +1022,10 @@ "smithy.api#documentation": "

The resource type for the AWS CloudFormation blue/green deployment.

" } }, - "status": { - "target": "com.amazonaws.codedeploy#TargetStatus", - "traits": { - "smithy.api#documentation": "

The status of an AWS CloudFormation blue/green deployment's target application.

" - } - }, - "lifecycleEvents": { - "target": "com.amazonaws.codedeploy#LifecycleEventList", + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", "traits": { - "smithy.api#documentation": "

The lifecycle events of the AWS CloudFormation blue/green deployment to this target\n application.

" + "smithy.api#documentation": "

The unique ID of a deployment target that has a type\n of CloudFormationTarget.

" } }, "lastUpdatedAt": { @@ -1042,6 +1034,12 @@ "smithy.api#documentation": "

The date and time when the target application was updated by an AWS CloudFormation\n blue/green deployment.

" } }, + "targetVersionWeight": { + "target": "com.amazonaws.codedeploy#TrafficWeight", + "traits": { + "smithy.api#documentation": "

The percentage of production traffic that the target version of an AWS CloudFormation\n blue/green deployment receives.

" + } + }, "deploymentId": { "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { @@ -1277,17 +1275,17 @@ "com.amazonaws.codedeploy#ContinueDeploymentInput": { "type": "structure", "members": { - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", - "traits": { - "smithy.api#documentation": "

The unique ID of a blue/green deployment for which you want to start rerouting\n traffic to the replacement environment.

" - } - }, "deploymentWaitType": { "target": "com.amazonaws.codedeploy#DeploymentWaitType", "traits": { "smithy.api#documentation": "

The status of the deployment's waiting period. READY_WAIT indicates that\n the deployment is ready to start shifting traffic. TERMINATION_WAIT\n indicates that the traffic is shifted, but the original target is not terminated.

" } + }, + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a blue/green deployment for which you want to start rerouting\n traffic to the replacement environment.

" + } } } }, @@ -1488,6 +1486,18 @@ "com.amazonaws.codedeploy#CreateDeploymentConfigInput": { "type": "structure", "members": { + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" + } + }, + "trafficRoutingConfig": { + "target": "com.amazonaws.codedeploy#TrafficRoutingConfig", + "traits": { + "smithy.api#documentation": "

The configuration that specifies how the deployment traffic is routed.

" + } + }, "deploymentConfigName": { "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { @@ -1500,18 +1510,6 @@ "traits": { "smithy.api#documentation": "

The minimum number of healthy instances that should be available at any time during\n the deployment. There are two parameters expected in the input: type and value.

\n

The type parameter takes either of the following values:

\n \n

The value parameter takes an integer.

\n

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT\n and a value of 95.

" } - }, - "trafficRoutingConfig": { - "target": "com.amazonaws.codedeploy#TrafficRoutingConfig", - "traits": { - "smithy.api#documentation": "

The configuration that specifies how the deployment traffic is routed.

" - } - }, - "computePlatform": { - "target": "com.amazonaws.codedeploy#ComputePlatform", - "traits": { - "smithy.api#documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" - } } }, "traits": { @@ -1648,58 +1646,61 @@ "com.amazonaws.codedeploy#CreateDeploymentGroupInput": { "type": "structure", "members": { - "onPremisesInstanceTagFilters": { - "target": "com.amazonaws.codedeploy#TagFilterList", + "alarmConfiguration": { + "target": "com.amazonaws.codedeploy#AlarmConfiguration", "traits": { - "smithy.api#documentation": "

The on-premises instance tags on which to filter. The deployment group includes\n on-premises instances with any of the specified tags. Cannot be used in the same call as\n OnPremisesTagSet.

" + "smithy.api#documentation": "

Information to add about Amazon CloudWatch alarms when the deployment group is\n created.

" } }, - "deploymentStyle": { - "target": "com.amazonaws.codedeploy#DeploymentStyle", + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", "traits": { - "smithy.api#documentation": "

Information about the type of deployment, in-place or blue/green, that you want to run\n and whether to route deployment traffic behind a load balancer.

" + "smithy.api#documentation": "

Information about the load balancer used in a deployment.

" } }, - "blueGreenDeploymentConfiguration": { - "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", + "ec2TagFilters": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList", "traits": { - "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + "smithy.api#documentation": "

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances\n with any of the specified tags. Cannot be used in the same call as ec2TagSet.

" } }, - "onPremisesTagSet": { - "target": "com.amazonaws.codedeploy#OnPremisesTagSet", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

Information about groups of tags applied to on-premises instances. The deployment\n group includes only on-premises instances identified by all of the tag groups. Cannot be\n used in the same call as onPremisesInstanceTagFilters.

" + "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

", + "smithy.api#required": {} } }, - "autoScalingGroups": { - "target": "com.amazonaws.codedeploy#AutoScalingGroupNameList", + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", "traits": { - "smithy.api#documentation": "

A list of associated Amazon EC2 Auto Scaling groups.

" + "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" } }, - "tags": { - "target": "com.amazonaws.codedeploy#TagList", + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", "traits": { - "smithy.api#documentation": "

\n The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag \n consists of a key and an optional value, both of which you define.\n

" + "smithy.api#documentation": "

Information about the type of deployment, in-place or blue/green, that you want to run\n and whether to route deployment traffic behind a load balancer.

" } }, - "alarmConfiguration": { - "target": "com.amazonaws.codedeploy#AlarmConfiguration", + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", "traits": { - "smithy.api#documentation": "

Information to add about Amazon CloudWatch alarms when the deployment group is\n created.

" + "smithy.api#documentation": "

The name of a new deployment group for the specified application.

", + "smithy.api#required": {} } }, - "ec2TagFilters": { - "target": "com.amazonaws.codedeploy#EC2TagFilterList", + "serviceRoleArn": { + "target": "com.amazonaws.codedeploy#Role", "traits": { - "smithy.api#documentation": "

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances\n with any of the specified tags. Cannot be used in the same call as ec2TagSet.

" + "smithy.api#documentation": "

A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the\n user's behalf when interacting with AWS services.

", + "smithy.api#required": {} } }, - "loadBalancerInfo": { - "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "triggerConfigurations": { + "target": "com.amazonaws.codedeploy#TriggerConfigList", "traits": { - "smithy.api#documentation": "

Information about the load balancer used in a deployment.

" + "smithy.api#documentation": "

Information about triggers to create when the deployment group is created. For\n examples, see Create a Trigger for an\n AWS CodeDeploy Event in the AWS CodeDeploy User\n Guide.

" } }, "deploymentConfigName": { @@ -1708,17 +1709,16 @@ "smithy.api#documentation": "

If specified, the deployment configuration name can be either one of the predefined\n configurations provided with AWS CodeDeploy or a custom deployment configuration that\n you create by calling the create deployment configuration operation.

\n

\n CodeDeployDefault.OneAtATime is the default deployment configuration. It\n is used if a configuration isn't specified for the deployment or deployment\n group.

\n

For more information about the predefined deployment configurations in AWS CodeDeploy,\n see Working with\n Deployment Configurations in CodeDeploy in the AWS CodeDeploy User\n Guide.

" } }, - "deploymentGroupName": { - "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "ec2TagSet": { + "target": "com.amazonaws.codedeploy#EC2TagSet", "traits": { - "smithy.api#documentation": "

The name of a new deployment group for the specified application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Information about groups of tags applied to EC2 instances. The deployment group\n includes only EC2 instances identified by all the tag groups. Cannot be used in the same\n call as ec2TagFilters.

" } }, - "triggerConfigurations": { - "target": "com.amazonaws.codedeploy#TriggerConfigList", + "autoScalingGroups": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupNameList", "traits": { - "smithy.api#documentation": "

Information about triggers to create when the deployment group is created. For\n examples, see Create a Trigger for an\n AWS CodeDeploy Event in the AWS CodeDeploy User\n Guide.

" + "smithy.api#documentation": "

A list of associated Amazon EC2 Auto Scaling groups.

" } }, "ecsServices": { @@ -1727,30 +1727,28 @@ "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service\n is specified as an Amazon ECS cluster and service name pair using the format\n :.

" } }, - "autoRollbackConfiguration": { - "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "onPremisesTagSet": { + "target": "com.amazonaws.codedeploy#OnPremisesTagSet", "traits": { - "smithy.api#documentation": "

Configuration information for an automatic rollback that is added when a deployment\n group is created.

" + "smithy.api#documentation": "

Information about groups of tags applied to on-premises instances. The deployment\n group includes only on-premises instances identified by all of the tag groups. Cannot be\n used in the same call as onPremisesInstanceTagFilters.

" } }, - "serviceRoleArn": { - "target": "com.amazonaws.codedeploy#Role", + "onPremisesInstanceTagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", "traits": { - "smithy.api#documentation": "

A service role Amazon Resource Name (ARN) that allows AWS CodeDeploy to act on the\n user's behalf when interacting with AWS services.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The on-premises instance tags on which to filter. The deployment group includes\n on-premises instances with any of the specified tags. Cannot be used in the same call as\n OnPremisesTagSet.

" } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "tags": { + "target": "com.amazonaws.codedeploy#TagList", "traits": { - "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag \n consists of a key and an optional value, both of which you define.\n

" } }, - "ec2TagSet": { - "target": "com.amazonaws.codedeploy#EC2TagSet", + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", "traits": { - "smithy.api#documentation": "

Information about groups of tags applied to EC2 instances. The deployment group\n includes only EC2 instances identified by all the tag groups. Cannot be used in the same\n call as ec2TagFilters.

" + "smithy.api#documentation": "

Configuration information for an automatic rollback that is added when a deployment\n group is created.

" } } }, @@ -1775,16 +1773,16 @@ "com.amazonaws.codedeploy#CreateDeploymentInput": { "type": "structure", "members": { - "deploymentConfigName": { - "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "targetInstances": { + "target": "com.amazonaws.codedeploy#TargetInstances", "traits": { - "smithy.api#documentation": "

The name of a deployment configuration associated with the IAM user or AWS\n account.

\n

If not specified, the value configured in the deployment group is used as the default.\n If the deployment group does not have a deployment configuration associated with it,\n CodeDeployDefault.OneAtATime is used by default.

" + "smithy.api#documentation": "

Information about the instances that belong to the replacement environment in a\n blue/green deployment.

" } }, - "description": { - "target": "com.amazonaws.codedeploy#Description", + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", "traits": { - "smithy.api#documentation": "

A comment about the deployment.

" + "smithy.api#documentation": "

The name of the deployment group.

" } }, "fileExistsBehavior": { @@ -1793,35 +1791,34 @@ "smithy.api#documentation": "

Information about how AWS CodeDeploy handles files that already exist in a deployment\n target location but weren't part of the previous successful deployment.

\n

The fileExistsBehavior parameter takes any of the following\n values:

\n " } }, - "targetInstances": { - "target": "com.amazonaws.codedeploy#TargetInstances", + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "

Information about the instances that belong to the replacement environment in a\n blue/green deployment.

" + "smithy.api#documentation": "

The name of a deployment configuration associated with the IAM user or AWS\n account.

\n

If not specified, the value configured in the deployment group is used as the default.\n If the deployment group does not have a deployment configuration associated with it,\n CodeDeployDefault.OneAtATime is used by default.

" } }, - "ignoreApplicationStopFailures": { + "updateOutdatedInstancesOnly": { "target": "com.amazonaws.codedeploy#Boolean", "traits": { - "smithy.api#documentation": "

If true, then if an ApplicationStop, BeforeBlockTraffic, or\n AfterBlockTraffic deployment lifecycle event to an instance fails, then\n the deployment continues to the next deployment lifecycle event. For example, if\n ApplicationStop fails, the deployment continues with\n DownloadBundle. If BeforeBlockTraffic fails, the\n deployment continues with BlockTraffic. If AfterBlockTraffic\n fails, the deployment continues with ApplicationStop.

\n \n

\n If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. \n If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, \n then a deployment to the next instance is attempted.\n

\n \n

During a deployment, the AWS CodeDeploy agent runs the scripts specified for\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic in the AppSpec file from the previous successful\n deployment. (All other scripts are run from the AppSpec file in the current deployment.)\n If one of these scripts contains an error and does not run successfully, the deployment\n can fail.

\n \n

If the cause of the failure is a script from the last successful deployment that will\n never run successfully, create a new deployment and use\n ignoreApplicationStopFailures to specify that the\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic failures should be ignored.

" + "smithy.api#documentation": "

Indicates whether to deploy to all instances or only to instances that are not\n running the latest application revision.

" } }, - "updateOutdatedInstancesOnly": { + "ignoreApplicationStopFailures": { "target": "com.amazonaws.codedeploy#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether to deploy to all instances or only to instances that are not\n running the latest application revision.

" + "smithy.api#documentation": "

If true, then if an ApplicationStop, BeforeBlockTraffic, or\n AfterBlockTraffic deployment lifecycle event to an instance fails, then\n the deployment continues to the next deployment lifecycle event. For example, if\n ApplicationStop fails, the deployment continues with\n DownloadBundle. If BeforeBlockTraffic fails, the\n deployment continues with BlockTraffic. If AfterBlockTraffic\n fails, the deployment continues with ApplicationStop.

\n \n

\n If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. \n If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, \n then a deployment to the next instance is attempted.\n

\n \n

During a deployment, the AWS CodeDeploy agent runs the scripts specified for\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic in the AppSpec file from the previous successful\n deployment. (All other scripts are run from the AppSpec file in the current deployment.)\n If one of these scripts contains an error and does not run successfully, the deployment\n can fail.

\n \n

If the cause of the failure is a script from the last successful deployment that will\n never run successfully, create a new deployment and use\n ignoreApplicationStopFailures to specify that the\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic failures should be ignored.

" } }, - "deploymentGroupName": { - "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", "traits": { - "smithy.api#documentation": "

The name of the deployment group.

" + "smithy.api#documentation": "

Configuration information for an automatic rollback that is added when a deployment is\n created.

" } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "description": { + "target": "com.amazonaws.codedeploy#Description", "traits": { - "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A comment about the deployment.

" } }, "revision": { @@ -1830,10 +1827,11 @@ "smithy.api#documentation": "

The type and location of the revision to deploy.

" } }, - "autoRollbackConfiguration": { - "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

Configuration information for an automatic rollback that is added when a deployment is\n created.

" + "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

", + "smithy.api#required": {} } } }, @@ -1960,17 +1958,17 @@ "com.amazonaws.codedeploy#DeleteDeploymentGroupInput": { "type": "structure", "members": { - "deploymentGroupName": { - "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

The name of a deployment group for the specified application.

", + "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

", "smithy.api#required": {} } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", "traits": { - "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

", + "smithy.api#documentation": "

The name of a deployment group for the specified application.

", "smithy.api#required": {} } } @@ -2143,16 +2141,10 @@ "com.amazonaws.codedeploy#DeploymentConfigInfo": { "type": "structure", "members": { - "computePlatform": { - "target": "com.amazonaws.codedeploy#ComputePlatform", - "traits": { - "smithy.api#documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" - } - }, - "createTime": { - "target": "com.amazonaws.codedeploy#Timestamp", + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "

The time at which the deployment configuration was created.

" + "smithy.api#documentation": "

The deployment configuration name.

" } }, "minimumHealthyHosts": { @@ -2167,17 +2159,23 @@ "smithy.api#documentation": "

The configuration that specifies how the deployment traffic is routed. Used for \n deployments with a Lambda or ECS compute platform only.

" } }, - "deploymentConfigName": { - "target": "com.amazonaws.codedeploy#DeploymentConfigName", - "traits": { - "smithy.api#documentation": "

The deployment configuration name.

" - } - }, "deploymentConfigId": { "target": "com.amazonaws.codedeploy#DeploymentConfigId", "traits": { "smithy.api#documentation": "

The deployment configuration ID.

" } + }, + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" + } + }, + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the deployment configuration was created.

" + } } }, "traits": { @@ -2311,130 +2309,130 @@ "com.amazonaws.codedeploy#DeploymentGroupInfo": { "type": "structure", "members": { - "onPremisesInstanceTagFilters": { - "target": "com.amazonaws.codedeploy#TagFilterList", + "deploymentGroupId": { + "target": "com.amazonaws.codedeploy#DeploymentGroupId", "traits": { - "smithy.api#documentation": "

The on-premises instance tags on which to filter. The deployment group includes\n on-premises instances with any of the specified tags.

" + "smithy.api#documentation": "

The deployment group ID.

" } }, - "deploymentStyle": { - "target": "com.amazonaws.codedeploy#DeploymentStyle", + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" + "smithy.api#documentation": "

The deployment configuration name.

" } }, - "ec2TagSet": { - "target": "com.amazonaws.codedeploy#EC2TagSet", + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", "traits": { - "smithy.api#documentation": "

Information about groups of tags applied to an EC2 instance. The deployment group\n includes only EC2 instances identified by all of the tag groups. Cannot be used in the\n same call as ec2TagFilters.

" + "smithy.api#documentation": "

Information about the load balancer to use in a deployment.

" } }, - "triggerConfigurations": { - "target": "com.amazonaws.codedeploy#TriggerConfigList", + "ec2TagSet": { + "target": "com.amazonaws.codedeploy#EC2TagSet", "traits": { - "smithy.api#documentation": "

Information about triggers associated with the deployment group.

" + "smithy.api#documentation": "

Information about groups of tags applied to an EC2 instance. The deployment group\n includes only EC2 instances identified by all of the tag groups. Cannot be used in the\n same call as ec2TagFilters.

" } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", "traits": { - "smithy.api#documentation": "

The application name.

" + "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" } }, - "serviceRoleArn": { - "target": "com.amazonaws.codedeploy#Role", + "computePlatform": { + "target": "com.amazonaws.codedeploy#ComputePlatform", "traits": { - "smithy.api#documentation": "

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. \n For more information, see Create a Service Role for AWS CodeDeploy in \n the AWS CodeDeploy User Guide.

" + "smithy.api#documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" } }, - "ecsServices": { - "target": "com.amazonaws.codedeploy#ECSServiceList", + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", "traits": { - "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service\n is specified as an Amazon ECS cluster and service name pair using the format\n :.

" + "smithy.api#documentation": "

The deployment group name.

" } }, - "autoRollbackConfiguration": { - "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "ec2TagFilters": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList", "traits": { - "smithy.api#documentation": "

Information about the automatic rollback configuration associated with the deployment\n group.

" + "smithy.api#documentation": "

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances\n with any of the specified tags.

" } }, - "blueGreenDeploymentConfiguration": { - "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", + "alarmConfiguration": { + "target": "com.amazonaws.codedeploy#AlarmConfiguration", "traits": { - "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + "smithy.api#documentation": "

A list of alarms associated with the deployment group.

" } }, - "deploymentConfigName": { - "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", "traits": { - "smithy.api#documentation": "

The deployment configuration name.

" + "smithy.api#documentation": "

Information about the automatic rollback configuration associated with the deployment\n group.

" } }, - "targetRevision": { - "target": "com.amazonaws.codedeploy#RevisionLocation", + "lastAttemptedDeployment": { + "target": "com.amazonaws.codedeploy#LastDeploymentInfo", "traits": { - "smithy.api#documentation": "

Information about the deployment group's target revision, including type and\n location.

" + "smithy.api#documentation": "

Information about the most recent attempted deployment to the deployment group.

" } }, - "alarmConfiguration": { - "target": "com.amazonaws.codedeploy#AlarmConfiguration", + "autoScalingGroups": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupList", "traits": { - "smithy.api#documentation": "

A list of alarms associated with the deployment group.

" + "smithy.api#documentation": "

A list of associated Auto Scaling groups.

" } }, - "loadBalancerInfo": { - "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "onPremisesTagSet": { + "target": "com.amazonaws.codedeploy#OnPremisesTagSet", "traits": { - "smithy.api#documentation": "

Information about the load balancer to use in a deployment.

" + "smithy.api#documentation": "

Information about groups of tags applied to an on-premises instance. The deployment\n group includes only on-premises instances identified by all the tag groups. Cannot be\n used in the same call as onPremisesInstanceTagFilters.

" } }, - "deploymentGroupId": { - "target": "com.amazonaws.codedeploy#DeploymentGroupId", + "triggerConfigurations": { + "target": "com.amazonaws.codedeploy#TriggerConfigList", "traits": { - "smithy.api#documentation": "

The deployment group ID.

" + "smithy.api#documentation": "

Information about triggers associated with the deployment group.

" } }, - "computePlatform": { - "target": "com.amazonaws.codedeploy#ComputePlatform", + "lastSuccessfulDeployment": { + "target": "com.amazonaws.codedeploy#LastDeploymentInfo", "traits": { - "smithy.api#documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" + "smithy.api#documentation": "

Information about the most recent successful deployment to the deployment\n group.

" } }, - "autoScalingGroups": { - "target": "com.amazonaws.codedeploy#AutoScalingGroupList", + "targetRevision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", "traits": { - "smithy.api#documentation": "

A list of associated Auto Scaling groups.

" + "smithy.api#documentation": "

Information about the deployment group's target revision, including type and\n location.

" } }, - "lastSuccessfulDeployment": { - "target": "com.amazonaws.codedeploy#LastDeploymentInfo", + "serviceRoleArn": { + "target": "com.amazonaws.codedeploy#Role", "traits": { - "smithy.api#documentation": "

Information about the most recent successful deployment to the deployment\n group.

" + "smithy.api#documentation": "

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. \n For more information, see Create a Service Role for AWS CodeDeploy in \n the AWS CodeDeploy User Guide.

" } }, - "deploymentGroupName": { - "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", "traits": { - "smithy.api#documentation": "

The deployment group name.

" + "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" } }, - "onPremisesTagSet": { - "target": "com.amazonaws.codedeploy#OnPremisesTagSet", + "ecsServices": { + "target": "com.amazonaws.codedeploy#ECSServiceList", "traits": { - "smithy.api#documentation": "

Information about groups of tags applied to an on-premises instance. The deployment\n group includes only on-premises instances identified by all the tag groups. Cannot be\n used in the same call as onPremisesInstanceTagFilters.

" + "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service\n is specified as an Amazon ECS cluster and service name pair using the format\n :.

" } }, - "ec2TagFilters": { - "target": "com.amazonaws.codedeploy#EC2TagFilterList", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances\n with any of the specified tags.

" + "smithy.api#documentation": "

The application name.

" } }, - "lastAttemptedDeployment": { - "target": "com.amazonaws.codedeploy#LastDeploymentInfo", + "onPremisesInstanceTagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", "traits": { - "smithy.api#documentation": "

Information about the most recent attempted deployment to the deployment group.

" + "smithy.api#documentation": "

The on-premises instance tags on which to filter. The deployment group includes\n on-premises instances with any of the specified tags.

" } } }, @@ -2514,58 +2512,46 @@ "com.amazonaws.codedeploy#DeploymentInfo": { "type": "structure", "members": { - "errorInformation": { - "target": "com.amazonaws.codedeploy#ErrorInformation", - "traits": { - "smithy.api#documentation": "

Information about any error associated with this deployment.

" - } - }, - "blueGreenDeploymentConfiguration": { - "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", - "traits": { - "smithy.api#documentation": "

Information about blue/green deployment options for this deployment.

" - } - }, - "deploymentStatusMessages": { - "target": "com.amazonaws.codedeploy#DeploymentStatusMessageList", + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "

Messages that contain information about the status of a deployment.

" + "smithy.api#documentation": "

The deployment configuration name.

" } }, - "autoRollbackConfiguration": { - "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", + "deploymentOverview": { + "target": "com.amazonaws.codedeploy#DeploymentOverview", "traits": { - "smithy.api#documentation": "

Information about the automatic rollback configuration associated with the\n deployment.

" + "smithy.api#documentation": "

A summary of the deployment status of the instances in the deployment.

" } }, - "createTime": { - "target": "com.amazonaws.codedeploy#Timestamp", + "deploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the deployment was created.

" + "smithy.api#documentation": "

The deployment group name.

" } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "description": { + "target": "com.amazonaws.codedeploy#Description", "traits": { - "smithy.api#documentation": "

The application name.

" + "smithy.api#documentation": "

A comment about the deployment.

" } }, - "additionalDeploymentStatusInfo": { - "target": "com.amazonaws.codedeploy#AdditionalDeploymentStatusInfo", + "instanceTerminationWaitTimeStarted": { + "target": "com.amazonaws.codedeploy#Boolean", "traits": { - "smithy.api#documentation": "

Provides information about the results of a deployment, such as whether instances in\n the original environment in a blue/green deployment were not terminated.

" + "smithy.api#documentation": "

Indicates whether the wait period set for the termination of instances in the original\n environment has started. Status is 'false' if the KEEP_ALIVE option is specified.\n Otherwise, 'true' as soon as the termination wait period starts.

" } }, - "ignoreApplicationStopFailures": { - "target": "com.amazonaws.codedeploy#Boolean", + "rollbackInfo": { + "target": "com.amazonaws.codedeploy#RollbackInfo", "traits": { - "smithy.api#documentation": "

If true, then if an ApplicationStop, BeforeBlockTraffic, or\n AfterBlockTraffic deployment lifecycle event to an instance fails, then\n the deployment continues to the next deployment lifecycle event. For example, if\n ApplicationStop fails, the deployment continues with DownloadBundle. If\n BeforeBlockTraffic fails, the deployment continues with\n BlockTraffic. If AfterBlockTraffic fails, the deployment\n continues with ApplicationStop.

\n \n

\n If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. \n If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, \n then a deployment to the next instance is attempted.\n

\n \n

During a deployment, the AWS CodeDeploy agent runs the scripts specified for\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic in the AppSpec file from the previous successful\n deployment. (All other scripts are run from the AppSpec file in the current deployment.)\n If one of these scripts contains an error and does not run successfully, the deployment\n can fail.

\n \n

If the cause of the failure is a script from the last successful deployment that will\n never run successfully, create a new deployment and use\n ignoreApplicationStopFailures to specify that the\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic failures should be ignored.

" + "smithy.api#documentation": "

Information about a deployment rollback.

" } }, - "deploymentGroupName": { - "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

The deployment group name.

" + "smithy.api#documentation": "

A timestamp that indicates when the deployment was created.

" } }, "fileExistsBehavior": { @@ -2574,70 +2560,76 @@ "smithy.api#documentation": "

Information about how AWS CodeDeploy handles files that already exist in a deployment\n target location but weren't part of the previous successful deployment.

\n " } }, - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

" + "smithy.api#documentation": "

Information about blue/green deployment options for this deployment.

" } }, - "instanceTerminationWaitTimeStarted": { - "target": "com.amazonaws.codedeploy#Boolean", + "status": { + "target": "com.amazonaws.codedeploy#DeploymentStatus", "traits": { - "smithy.api#documentation": "

Indicates whether the wait period set for the termination of instances in the original\n environment has started. Status is 'false' if the KEEP_ALIVE option is specified.\n Otherwise, 'true' as soon as the termination wait period starts.

" + "smithy.api#documentation": "

The current state of the deployment as a whole.

" } }, - "revision": { - "target": "com.amazonaws.codedeploy#RevisionLocation", + "autoRollbackConfiguration": { + "target": "com.amazonaws.codedeploy#AutoRollbackConfiguration", "traits": { - "smithy.api#documentation": "

Information about the location of stored application artifacts and the service from\n which to retrieve them.

" + "smithy.api#documentation": "

Information about the automatic rollback configuration associated with the\n deployment.

" } }, - "updateOutdatedInstancesOnly": { - "target": "com.amazonaws.codedeploy#Boolean", + "deploymentStatusMessages": { + "target": "com.amazonaws.codedeploy#DeploymentStatusMessageList", "traits": { - "smithy.api#documentation": "

Indicates whether only instances that are not running the latest application revision\n are to be deployed to.

" + "smithy.api#documentation": "

Messages that contain information about the status of a deployment.

" } }, - "rollbackInfo": { - "target": "com.amazonaws.codedeploy#RollbackInfo", + "additionalDeploymentStatusInfo": { + "target": "com.amazonaws.codedeploy#AdditionalDeploymentStatusInfo", "traits": { - "smithy.api#documentation": "

Information about a deployment rollback.

" + "smithy.api#documentation": "

Provides information about the results of a deployment, such as whether instances in\n the original environment in a blue/green deployment were not terminated.

" } }, - "deploymentStyle": { - "target": "com.amazonaws.codedeploy#DeploymentStyle", + "ignoreApplicationStopFailures": { + "target": "com.amazonaws.codedeploy#Boolean", "traits": { - "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" + "smithy.api#documentation": "

If true, then if an ApplicationStop, BeforeBlockTraffic, or\n AfterBlockTraffic deployment lifecycle event to an instance fails, then\n the deployment continues to the next deployment lifecycle event. For example, if\n ApplicationStop fails, the deployment continues with DownloadBundle. If\n BeforeBlockTraffic fails, the deployment continues with\n BlockTraffic. If AfterBlockTraffic fails, the deployment\n continues with ApplicationStop.

\n \n

\n If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. \n If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, \n then a deployment to the next instance is attempted.\n

\n \n

During a deployment, the AWS CodeDeploy agent runs the scripts specified for\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic in the AppSpec file from the previous successful\n deployment. (All other scripts are run from the AppSpec file in the current deployment.)\n If one of these scripts contains an error and does not run successfully, the deployment\n can fail.

\n \n

If the cause of the failure is a script from the last successful deployment that will\n never run successfully, create a new deployment and use\n ignoreApplicationStopFailures to specify that the\n ApplicationStop, BeforeBlockTraffic, and\n AfterBlockTraffic failures should be ignored.

" } }, - "startTime": { - "target": "com.amazonaws.codedeploy#Timestamp", + "previousRevision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the deployment was deployed to the deployment\n group.

\n

In some cases, the reported value of the start time might be later than the complete\n time. This is due to differences in the clock settings of backend servers that\n participate in the deployment process.

" + "smithy.api#documentation": "

Information about the application revision that was deployed to the deployment group\n before the most recent successful deployment.

" } }, - "targetInstances": { - "target": "com.amazonaws.codedeploy#TargetInstances", + "creator": { + "target": "com.amazonaws.codedeploy#DeploymentCreator", "traits": { - "smithy.api#documentation": "

Information about the instances that belong to the replacement environment in a\n blue/green deployment.

" + "smithy.api#documentation": "

The means by which the deployment was created:

\n " } }, - "status": { - "target": "com.amazonaws.codedeploy#DeploymentStatus", + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", "traits": { - "smithy.api#documentation": "

The current state of the deployment as a whole.

" + "smithy.api#documentation": "

Information about the load balancer used in the deployment.

" } }, - "previousRevision": { + "revision": { "target": "com.amazonaws.codedeploy#RevisionLocation", "traits": { - "smithy.api#documentation": "

Information about the application revision that was deployed to the deployment group\n before the most recent successful deployment.

" + "smithy.api#documentation": "

Information about the location of stored application artifacts and the service from\n which to retrieve them.

" } }, - "deploymentOverview": { - "target": "com.amazonaws.codedeploy#DeploymentOverview", + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

A summary of the deployment status of the instances in the deployment.

" + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, + "updateOutdatedInstancesOnly": { + "target": "com.amazonaws.codedeploy#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether only instances that are not running the latest application revision\n are to be deployed to.

" } }, "computePlatform": { @@ -2646,40 +2638,46 @@ "smithy.api#documentation": "

The destination platform type for the deployment (Lambda, Server, or ECS).

" } }, - "creator": { - "target": "com.amazonaws.codedeploy#DeploymentCreator", + "errorInformation": { + "target": "com.amazonaws.codedeploy#ErrorInformation", "traits": { - "smithy.api#documentation": "

The means by which the deployment was created:

\n " + "smithy.api#documentation": "

Information about any error associated with this deployment.

" } }, - "deploymentConfigName": { - "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "externalId": { + "target": "com.amazonaws.codedeploy#ExternalId", "traits": { - "smithy.api#documentation": "

The deployment configuration name.

" + "smithy.api#documentation": "

The unique ID for an external resource (for example, a CloudFormation stack ID) that\n is linked to this deployment.

" } }, - "loadBalancerInfo": { - "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "completeTime": { + "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

Information about the load balancer used in the deployment.

" + "smithy.api#documentation": "

A timestamp that indicates when the deployment was complete.

" } }, - "externalId": { - "target": "com.amazonaws.codedeploy#ExternalId", + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", "traits": { - "smithy.api#documentation": "

The unique ID for an external resource (for example, a CloudFormation stack ID) that\n is linked to this deployment.

" + "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" } }, - "completeTime": { + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", + "traits": { + "smithy.api#documentation": "

The application name.

" + } + }, + "startTime": { "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the deployment was complete.

" + "smithy.api#documentation": "

A timestamp that indicates when the deployment was deployed to the deployment\n group.

\n

In some cases, the reported value of the start time might be later than the complete\n time. This is due to differences in the clock settings of backend servers that\n participate in the deployment process.

" } }, - "description": { - "target": "com.amazonaws.codedeploy#Description", + "targetInstances": { + "target": "com.amazonaws.codedeploy#TargetInstances", "traits": { - "smithy.api#documentation": "

A comment about the deployment.

" + "smithy.api#documentation": "

Information about the instances that belong to the replacement environment in a\n blue/green deployment.

" } } }, @@ -2756,28 +2754,28 @@ "smithy.api#documentation": "

The number of instances in the deployment to which revisions have been successfully\n deployed.

" } }, - "Pending": { + "Ready": { "target": "com.amazonaws.codedeploy#InstanceCount", "traits": { - "smithy.api#documentation": "

The number of instances in the deployment in a pending state.

" + "smithy.api#documentation": "

The number of instances in a replacement environment ready to receive traffic in a\n blue/green deployment.

" } }, - "Ready": { + "Failed": { "target": "com.amazonaws.codedeploy#InstanceCount", "traits": { - "smithy.api#documentation": "

The number of instances in a replacement environment ready to receive traffic in a\n blue/green deployment.

" + "smithy.api#documentation": "

The number of instances in the deployment in a failed state.

" } }, - "Skipped": { + "Pending": { "target": "com.amazonaws.codedeploy#InstanceCount", "traits": { - "smithy.api#documentation": "

The number of instances in the deployment in a skipped state.

" + "smithy.api#documentation": "

The number of instances in the deployment in a pending state.

" } }, - "Failed": { + "Skipped": { "target": "com.amazonaws.codedeploy#InstanceCount", "traits": { - "smithy.api#documentation": "

The number of instances in the deployment in a failed state.

" + "smithy.api#documentation": "

The number of instances in the deployment in a skipped state.

" } }, "InProgress": { @@ -2809,17 +2807,17 @@ "com.amazonaws.codedeploy#DeploymentReadyOption": { "type": "structure", "members": { - "actionOnTimeout": { - "target": "com.amazonaws.codedeploy#DeploymentReadyAction", - "traits": { - "smithy.api#documentation": "

Information about when to reroute traffic from an original environment to a\n replacement environment in a blue/green deployment.

\n " - } - }, "waitTimeInMinutes": { "target": "com.amazonaws.codedeploy#Duration", "traits": { "smithy.api#documentation": "

The number of minutes to wait before the status of a blue/green deployment is changed\n to Stopped if rerouting is not started manually. Applies only to the\n STOP_DEPLOYMENT option for actionOnTimeout.

" } + }, + "actionOnTimeout": { + "target": "com.amazonaws.codedeploy#DeploymentReadyAction", + "traits": { + "smithy.api#documentation": "

Information about when to reroute traffic from an original environment to a\n replacement environment in a blue/green deployment.

\n " + } } }, "traits": { @@ -2900,20 +2898,17 @@ "com.amazonaws.codedeploy#DeploymentTarget": { "type": "structure", "members": { - "instanceTarget": { - "target": "com.amazonaws.codedeploy#InstanceTarget", - "traits": { - "smithy.api#documentation": "

Information about the target for a deployment that uses the EC2/On-premises compute\n platform.

" - } - }, "deploymentTargetType": { "target": "com.amazonaws.codedeploy#DeploymentTargetType", "traits": { "smithy.api#documentation": "

The deployment type that is specific to the deployment's compute platform or deployments initiated by a CloudFormation stack update.

" } }, - "cloudFormationTarget": { - "target": "com.amazonaws.codedeploy#CloudFormationTarget" + "ecsTarget": { + "target": "com.amazonaws.codedeploy#ECSTarget", + "traits": { + "smithy.api#documentation": "

Information about the target for a deployment that uses the Amazon ECS compute\n platform.

" + } }, "lambdaTarget": { "target": "com.amazonaws.codedeploy#LambdaTarget", @@ -2921,10 +2916,13 @@ "smithy.api#documentation": "

Information about the target for a deployment that uses the AWS Lambda compute\n platform.

" } }, - "ecsTarget": { - "target": "com.amazonaws.codedeploy#ECSTarget", + "cloudFormationTarget": { + "target": "com.amazonaws.codedeploy#CloudFormationTarget" + }, + "instanceTarget": { + "target": "com.amazonaws.codedeploy#InstanceTarget", "traits": { - "smithy.api#documentation": "

Information about the target for a deployment that uses the Amazon ECS compute\n platform.

" + "smithy.api#documentation": "

Information about the target for a deployment that uses the EC2/On-premises compute\n platform.

" } } }, @@ -3101,18 +3099,6 @@ "com.amazonaws.codedeploy#Diagnostics": { "type": "structure", "members": { - "logTail": { - "target": "com.amazonaws.codedeploy#LogTail", - "traits": { - "smithy.api#documentation": "

The last portion of the diagnostic log.

\n

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

" - } - }, - "scriptName": { - "target": "com.amazonaws.codedeploy#ScriptName", - "traits": { - "smithy.api#documentation": "

The name of the script.

" - } - }, "errorCode": { "target": "com.amazonaws.codedeploy#LifecycleErrorCode", "traits": { @@ -3124,6 +3110,18 @@ "traits": { "smithy.api#documentation": "

The message associated with the error.

" } + }, + "logTail": { + "target": "com.amazonaws.codedeploy#LogTail", + "traits": { + "smithy.api#documentation": "

The last portion of the diagnostic log.

\n

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

" + } + }, + "scriptName": { + "target": "com.amazonaws.codedeploy#ScriptName", + "traits": { + "smithy.api#documentation": "

The name of the script.

" + } } }, "traits": { @@ -3142,17 +3140,17 @@ "smithy.api#documentation": "

The tag filter type:

\n " } }, - "Key": { - "target": "com.amazonaws.codedeploy#Key", - "traits": { - "smithy.api#documentation": "

The tag filter key.

" - } - }, "Value": { "target": "com.amazonaws.codedeploy#Value", "traits": { "smithy.api#documentation": "

The tag filter value.

" } + }, + "Key": { + "target": "com.amazonaws.codedeploy#Key", + "traits": { + "smithy.api#documentation": "

The tag filter key.

" + } } }, "traits": { @@ -3210,17 +3208,17 @@ "com.amazonaws.codedeploy#ECSService": { "type": "structure", "members": { - "serviceName": { - "target": "com.amazonaws.codedeploy#ECSServiceName", - "traits": { - "smithy.api#documentation": "

The name of the target Amazon ECS service.

" - } - }, "clusterName": { "target": "com.amazonaws.codedeploy#ECSClusterName", "traits": { "smithy.api#documentation": "

The name of the cluster that the Amazon ECS service is associated with.

" } + }, + "serviceName": { + "target": "com.amazonaws.codedeploy#ECSServiceName", + "traits": { + "smithy.api#documentation": "

The name of the target Amazon ECS service.

" + } } }, "traits": { @@ -3254,16 +3252,16 @@ "com.amazonaws.codedeploy#ECSTarget": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.codedeploy#TargetStatus", + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", "traits": { - "smithy.api#documentation": "

The status an Amazon ECS deployment's target ECS application.

" + "smithy.api#documentation": "

The lifecycle events of the deployment to this target Amazon ECS application.

" } }, - "taskSetsInfo": { - "target": "com.amazonaws.codedeploy#ECSTaskSetList", + "status": { + "target": "com.amazonaws.codedeploy#TargetStatus", "traits": { - "smithy.api#documentation": "

The ECSTaskSet objects associated with the ECS target.

" + "smithy.api#documentation": "

The status an Amazon ECS deployment's target ECS application.

" } }, "targetId": { @@ -3272,10 +3270,10 @@ "smithy.api#documentation": "

The unique ID of a deployment target that has a type of ecsTarget.\n

" } }, - "targetArn": { - "target": "com.amazonaws.codedeploy#TargetArn", + "taskSetsInfo": { + "target": "com.amazonaws.codedeploy#ECSTaskSetList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" + "smithy.api#documentation": "

The ECSTaskSet objects associated with the ECS target.

" } }, "lastUpdatedAt": { @@ -3284,16 +3282,16 @@ "smithy.api#documentation": "

The date and time when the target Amazon ECS application was updated by a deployment.\n

" } }, - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", + "targetArn": { + "target": "com.amazonaws.codedeploy#TargetArn", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" } }, - "lifecycleEvents": { - "target": "com.amazonaws.codedeploy#LifecycleEventList", + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

The lifecycle events of the deployment to this target Amazon ECS application.

" + "smithy.api#documentation": "

The unique ID of a deployment.

" } } }, @@ -3304,52 +3302,52 @@ "com.amazonaws.codedeploy#ECSTaskSet": { "type": "structure", "members": { - "identifer": { - "target": "com.amazonaws.codedeploy#ECSTaskSetIdentifier", + "trafficWeight": { + "target": "com.amazonaws.codedeploy#TrafficWeight", "traits": { - "smithy.api#documentation": "

A unique ID of an ECSTaskSet.

" + "smithy.api#documentation": "

The percentage of traffic served by this task set.

" } }, - "runningCount": { - "target": "com.amazonaws.codedeploy#ECSTaskSetCount", + "taskSetLabel": { + "target": "com.amazonaws.codedeploy#TargetLabel", "traits": { - "smithy.api#documentation": "

The number of tasks in the task set that are in the RUNNING status\n during an Amazon ECS deployment. A task in the RUNNING state is running and\n ready for use.

" + "smithy.api#documentation": "

A label that identifies whether the ECS task set is an original target\n (BLUE) or a replacement target (GREEN).

" } }, - "status": { - "target": "com.amazonaws.codedeploy#ECSTaskSetStatus", + "targetGroup": { + "target": "com.amazonaws.codedeploy#TargetGroupInfo", "traits": { - "smithy.api#documentation": "

The status of the task set. There are three valid task set statuses:

\n " + "smithy.api#documentation": "

The target group associated with the task set. The target group is used by AWS\n CodeDeploy to manage traffic to a task set.

" } }, - "desiredCount": { - "target": "com.amazonaws.codedeploy#ECSTaskSetCount", + "status": { + "target": "com.amazonaws.codedeploy#ECSTaskSetStatus", "traits": { - "smithy.api#documentation": "

The number of tasks in a task set. During a deployment that uses the Amazon ECS\n compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this\n value to determine how many tasks to create. After the updated task set is created,\n CodeDeploy shifts traffic to the new task set.

" + "smithy.api#documentation": "

The status of the task set. There are three valid task set statuses:

\n " } }, - "trafficWeight": { - "target": "com.amazonaws.codedeploy#TrafficWeight", + "identifer": { + "target": "com.amazonaws.codedeploy#ECSTaskSetIdentifier", "traits": { - "smithy.api#documentation": "

The percentage of traffic served by this task set.

" + "smithy.api#documentation": "

A unique ID of an ECSTaskSet.

" } }, - "targetGroup": { - "target": "com.amazonaws.codedeploy#TargetGroupInfo", + "runningCount": { + "target": "com.amazonaws.codedeploy#ECSTaskSetCount", "traits": { - "smithy.api#documentation": "

The target group associated with the task set. The target group is used by AWS\n CodeDeploy to manage traffic to a task set.

" + "smithy.api#documentation": "

The number of tasks in the task set that are in the RUNNING status\n during an Amazon ECS deployment. A task in the RUNNING state is running and\n ready for use.

" } }, - "taskSetLabel": { - "target": "com.amazonaws.codedeploy#TargetLabel", + "pendingCount": { + "target": "com.amazonaws.codedeploy#ECSTaskSetCount", "traits": { - "smithy.api#documentation": "

A label that identifies whether the ECS task set is an original target\n (BLUE) or a replacement target (GREEN).

" + "smithy.api#documentation": "

The number of tasks in the task set that are in the PENDING status\n during an Amazon ECS deployment. A task in the PENDING state is preparing\n to enter the RUNNING state. A task set enters the PENDING\n status when it launches for the first time, or when it is restarted after being in the\n STOPPED state.

" } }, - "pendingCount": { + "desiredCount": { "target": "com.amazonaws.codedeploy#ECSTaskSetCount", "traits": { - "smithy.api#documentation": "

The number of tasks in the task set that are in the PENDING status\n during an Amazon ECS deployment. A task in the PENDING state is preparing\n to enter the RUNNING state. A task set enters the PENDING\n status when it launches for the first time, or when it is restarted after being in the\n STOPPED state.

" + "smithy.api#documentation": "

The number of tasks in a task set. During a deployment that uses the Amazon ECS\n compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this\n value to determine how many tasks to create. After the updated task set is created,\n CodeDeploy shifts traffic to the new task set.

" } } }, @@ -3598,34 +3596,34 @@ "com.amazonaws.codedeploy#GenericRevisionInfo": { "type": "structure", "members": { - "lastUsedTime": { + "registerTime": { "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

When the revision was last used by AWS CodeDeploy.

" + "smithy.api#documentation": "

When the revision was registered with AWS CodeDeploy.

" } }, - "description": { - "target": "com.amazonaws.codedeploy#Description", + "firstUsedTime": { + "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

A comment about the revision.

" + "smithy.api#documentation": "

When the revision was first used by AWS CodeDeploy.

" } }, - "deploymentGroups": { - "target": "com.amazonaws.codedeploy#DeploymentGroupsList", + "description": { + "target": "com.amazonaws.codedeploy#Description", "traits": { - "smithy.api#documentation": "

The deployment groups for which this is the current target revision.

" + "smithy.api#documentation": "

A comment about the revision.

" } }, - "registerTime": { + "lastUsedTime": { "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

When the revision was registered with AWS CodeDeploy.

" + "smithy.api#documentation": "

When the revision was last used by AWS CodeDeploy.

" } }, - "firstUsedTime": { - "target": "com.amazonaws.codedeploy#Timestamp", + "deploymentGroups": { + "target": "com.amazonaws.codedeploy#DeploymentGroupsList", "traits": { - "smithy.api#documentation": "

When the revision was first used by AWS CodeDeploy.

" + "smithy.api#documentation": "

The deployment groups for which this is the current target revision.

" } } }, @@ -3720,17 +3718,17 @@ "com.amazonaws.codedeploy#GetApplicationRevisionInput": { "type": "structure", "members": { - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "revision": { + "target": "com.amazonaws.codedeploy#RevisionLocation", "traits": { - "smithy.api#documentation": "

The name of the application that corresponds to the revision.

", + "smithy.api#documentation": "

Information about the application revision to get, including type and location.

", "smithy.api#required": {} } }, - "revision": { - "target": "com.amazonaws.codedeploy#RevisionLocation", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

Information about the application revision to get, including type and location.

", + "smithy.api#documentation": "

The name of the application that corresponds to the revision.

", "smithy.api#required": {} } } @@ -3742,10 +3740,10 @@ "com.amazonaws.codedeploy#GetApplicationRevisionOutput": { "type": "structure", "members": { - "revisionInfo": { - "target": "com.amazonaws.codedeploy#GenericRevisionInfo", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

General information about the revision.

" + "smithy.api#documentation": "

The name of the application that corresponds to the revision.

" } }, "revision": { @@ -3754,10 +3752,10 @@ "smithy.api#documentation": "

Additional information about the revision, including type and location.

" } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "revisionInfo": { + "target": "com.amazonaws.codedeploy#GenericRevisionInfo", "traits": { - "smithy.api#documentation": "

The name of the application that corresponds to the revision.

" + "smithy.api#documentation": "

General information about the revision.

" } } }, @@ -3970,17 +3968,17 @@ "com.amazonaws.codedeploy#GetDeploymentInstanceInput": { "type": "structure", "members": { - "instanceId": { - "target": "com.amazonaws.codedeploy#InstanceId", + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

The unique ID of an instance in the deployment group.

", + "smithy.api#documentation": "

The unique ID of a deployment.

", "smithy.api#required": {} } }, - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", + "instanceId": { + "target": "com.amazonaws.codedeploy#InstanceId", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

", + "smithy.api#documentation": "

The unique ID of an instance in the deployment group.

", "smithy.api#required": {} } } @@ -4058,17 +4056,17 @@ "com.amazonaws.codedeploy#GetDeploymentTargetInput": { "type": "structure", "members": { - "targetId": { - "target": "com.amazonaws.codedeploy#TargetId", - "traits": { - "smithy.api#documentation": "

The unique ID of a deployment target.

" - } - }, "deploymentId": { "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { "smithy.api#documentation": "

The unique ID of a deployment.

" } + }, + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment target.

" + } } } }, @@ -4352,10 +4350,22 @@ "com.amazonaws.codedeploy#InstanceInfo": { "type": "structure", "members": { - "iamSessionArn": { - "target": "com.amazonaws.codedeploy#IamSessionArn", + "instanceName": { + "target": "com.amazonaws.codedeploy#InstanceName", "traits": { - "smithy.api#documentation": "

The ARN of the IAM session associated with the on-premises instance.

" + "smithy.api#documentation": "

The name of the on-premises instance.

" + } + }, + "deregisterTime": { + "target": "com.amazonaws.codedeploy#Timestamp", + "traits": { + "smithy.api#documentation": "

If the on-premises instance was deregistered, the time at which the on-premises\n instance was deregistered.

" + } + }, + "iamUserArn": { + "target": "com.amazonaws.codedeploy#IamUserArn", + "traits": { + "smithy.api#documentation": "

The IAM user ARN associated with the on-premises instance.

" } }, "instanceArn": { @@ -4370,16 +4380,10 @@ "smithy.api#documentation": "

The tags currently associated with the on-premises instance.

" } }, - "iamUserArn": { - "target": "com.amazonaws.codedeploy#IamUserArn", - "traits": { - "smithy.api#documentation": "

The IAM user ARN associated with the on-premises instance.

" - } - }, - "deregisterTime": { - "target": "com.amazonaws.codedeploy#Timestamp", + "iamSessionArn": { + "target": "com.amazonaws.codedeploy#IamSessionArn", "traits": { - "smithy.api#documentation": "

If the on-premises instance was deregistered, the time at which the on-premises\n instance was deregistered.

" + "smithy.api#documentation": "

The ARN of the IAM session associated with the on-premises instance.

" } }, "registerTime": { @@ -4387,12 +4391,6 @@ "traits": { "smithy.api#documentation": "

The time at which the on-premises instance was registered.

" } - }, - "instanceName": { - "target": "com.amazonaws.codedeploy#InstanceName", - "traits": { - "smithy.api#documentation": "

The name of the on-premises instance.

" - } } }, "traits": { @@ -4521,22 +4519,22 @@ "com.amazonaws.codedeploy#InstanceSummary": { "type": "structure", "members": { - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", + "status": { + "target": "com.amazonaws.codedeploy#InstanceStatus", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

" + "smithy.api#documentation": "

The deployment status for this instance:

\n " } }, - "instanceId": { - "target": "com.amazonaws.codedeploy#InstanceId", + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", "traits": { - "smithy.api#documentation": "

The instance ID.

" + "smithy.api#documentation": "

A list of lifecycle events for this instance.

" } }, - "lastUpdatedAt": { - "target": "com.amazonaws.codedeploy#Timestamp", + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the instance information was last updated.

" + "smithy.api#documentation": "

The unique ID of a deployment.

" } }, "instanceType": { @@ -4545,16 +4543,16 @@ "smithy.api#documentation": "

Information about which environment an instance belongs to in a blue/green\n deployment.

\n " } }, - "lifecycleEvents": { - "target": "com.amazonaws.codedeploy#LifecycleEventList", + "instanceId": { + "target": "com.amazonaws.codedeploy#InstanceId", "traits": { - "smithy.api#documentation": "

A list of lifecycle events for this instance.

" + "smithy.api#documentation": "

The instance ID.

" } }, - "status": { - "target": "com.amazonaws.codedeploy#InstanceStatus", + "lastUpdatedAt": { + "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

The deployment status for this instance:

\n " + "smithy.api#documentation": "

A timestamp that indicates when the instance information was last updated.

" } } }, @@ -4574,16 +4572,16 @@ "com.amazonaws.codedeploy#InstanceTarget": { "type": "structure", "members": { - "instanceLabel": { - "target": "com.amazonaws.codedeploy#TargetLabel", + "targetArn": { + "target": "com.amazonaws.codedeploy#TargetArn", "traits": { - "smithy.api#documentation": "

A label that identifies whether the instance is an original target\n (BLUE) or a replacement target (GREEN).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" } }, - "lifecycleEvents": { - "target": "com.amazonaws.codedeploy#LifecycleEventList", + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

The lifecycle events of the deployment to this target instance.

" + "smithy.api#documentation": "

The unique ID of a deployment.

" } }, "lastUpdatedAt": { @@ -4592,10 +4590,10 @@ "smithy.api#documentation": "

The date and time when the target instance was updated by a deployment.

" } }, - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

" + "smithy.api#documentation": "

The lifecycle events of the deployment to this target instance.

" } }, "targetId": { @@ -4604,17 +4602,17 @@ "smithy.api#documentation": "

The unique ID of a deployment target that has a type of instanceTarget.\n

" } }, - "targetArn": { - "target": "com.amazonaws.codedeploy#TargetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" - } - }, "status": { "target": "com.amazonaws.codedeploy#TargetStatus", "traits": { "smithy.api#documentation": "

The status an EC2/On-premises deployment's target instance.

" } + }, + "instanceLabel": { + "target": "com.amazonaws.codedeploy#TargetLabel", + "traits": { + "smithy.api#documentation": "

A label that identifies whether the instance is an original target\n (BLUE) or a replacement target (GREEN).

" + } } }, "traits": { @@ -5467,22 +5465,16 @@ "com.amazonaws.codedeploy#LambdaFunctionInfo": { "type": "structure", "members": { - "currentVersion": { - "target": "com.amazonaws.codedeploy#Version", - "traits": { - "smithy.api#documentation": "

\n The version of a Lambda function that production traffic points to.\n

" - } - }, "targetVersion": { "target": "com.amazonaws.codedeploy#Version", "traits": { "smithy.api#documentation": "

\n The version of a Lambda function that production traffic points to after the Lambda function is deployed.\n

" } }, - "functionName": { - "target": "com.amazonaws.codedeploy#LambdaFunctionName", + "currentVersion": { + "target": "com.amazonaws.codedeploy#Version", "traits": { - "smithy.api#documentation": "

\n The name of a Lambda function.\n

" + "smithy.api#documentation": "

\n The version of a Lambda function that production traffic points to.\n

" } }, "functionAlias": { @@ -5496,6 +5488,12 @@ "traits": { "smithy.api#documentation": "

\n The percentage of production traffic that the target version of a Lambda function receives.\n

" } + }, + "functionName": { + "target": "com.amazonaws.codedeploy#LambdaFunctionName", + "traits": { + "smithy.api#documentation": "

\n The name of a Lambda function.\n

" + } } }, "traits": { @@ -5508,16 +5506,16 @@ "com.amazonaws.codedeploy#LambdaTarget": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.codedeploy#TargetStatus", + "lifecycleEvents": { + "target": "com.amazonaws.codedeploy#LifecycleEventList", "traits": { - "smithy.api#documentation": "

The status an AWS Lambda deployment's target Lambda function.

" + "smithy.api#documentation": "

The lifecycle events of the deployment to this target Lambda function.

" } }, - "lambdaFunctionInfo": { - "target": "com.amazonaws.codedeploy#LambdaFunctionInfo", + "status": { + "target": "com.amazonaws.codedeploy#TargetStatus", "traits": { - "smithy.api#documentation": "

\n A LambdaFunctionInfo object that describes a target Lambda function.\n

" + "smithy.api#documentation": "

The status an AWS Lambda deployment's target Lambda function.

" } }, "targetArn": { @@ -5526,16 +5524,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

" } }, - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", - "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

" - } - }, - "lifecycleEvents": { - "target": "com.amazonaws.codedeploy#LifecycleEventList", + "targetId": { + "target": "com.amazonaws.codedeploy#TargetId", "traits": { - "smithy.api#documentation": "

The lifecycle events of the deployment to this target Lambda function.

" + "smithy.api#documentation": "

The unique ID of a deployment target that has a type of lambdaTarget.\n

" } }, "lastUpdatedAt": { @@ -5544,10 +5536,16 @@ "smithy.api#documentation": "

The date and time when the target Lambda function was updated by a deployment.\n

" } }, - "targetId": { - "target": "com.amazonaws.codedeploy#TargetId", + "lambdaFunctionInfo": { + "target": "com.amazonaws.codedeploy#LambdaFunctionInfo", "traits": { - "smithy.api#documentation": "

The unique ID of a deployment target that has a type of lambdaTarget.\n

" + "smithy.api#documentation": "

\n A LambdaFunctionInfo object that describes a target Lambda function.\n

" + } + }, + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" } } }, @@ -5558,10 +5556,10 @@ "com.amazonaws.codedeploy#LastDeploymentInfo": { "type": "structure", "members": { - "createTime": { + "endTime": { "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the most recent deployment to the deployment group\n started.

" + "smithy.api#documentation": "

A timestamp that indicates when the most recent deployment to the deployment group was\n complete.

" } }, "deploymentId": { @@ -5570,16 +5568,16 @@ "smithy.api#documentation": "

The unique ID of a deployment.

" } }, - "status": { - "target": "com.amazonaws.codedeploy#DeploymentStatus", + "createTime": { + "target": "com.amazonaws.codedeploy#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the most recent deployment.

" + "smithy.api#documentation": "

A timestamp that indicates when the most recent deployment to the deployment group\n started.

" } }, - "endTime": { - "target": "com.amazonaws.codedeploy#Timestamp", + "status": { + "target": "com.amazonaws.codedeploy#DeploymentStatus", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the most recent deployment to the deployment group was\n complete.

" + "smithy.api#documentation": "

The status of the most recent deployment.

" } } }, @@ -5627,18 +5625,18 @@ "smithy.api#documentation": "

A timestamp that indicates when the deployment lifecycle event started.

" } }, - "status": { - "target": "com.amazonaws.codedeploy#LifecycleEventStatus", - "traits": { - "smithy.api#documentation": "

The deployment lifecycle event status:

\n " - } - }, "lifecycleEventName": { "target": "com.amazonaws.codedeploy#LifecycleEventName", "traits": { "smithy.api#documentation": "

The deployment lifecycle event name, such as ApplicationStop,\n BeforeInstall, AfterInstall,\n ApplicationStart, or ValidateService.

" } }, + "status": { + "target": "com.amazonaws.codedeploy#LifecycleEventStatus", + "traits": { + "smithy.api#documentation": "

The deployment lifecycle event status:

\n " + } + }, "endTime": { "target": "com.amazonaws.codedeploy#Timestamp", "traits": { @@ -5784,10 +5782,10 @@ "com.amazonaws.codedeploy#ListApplicationRevisionsInput": { "type": "structure", "members": { - "s3Bucket": { - "target": "com.amazonaws.codedeploy#S3Bucket", + "sortBy": { + "target": "com.amazonaws.codedeploy#ApplicationRevisionSortBy", "traits": { - "smithy.api#documentation": "

An Amazon S3 bucket name to limit the search for revisions.

\n

If set to null, all of the user's buckets are searched.

" + "smithy.api#documentation": "

The column name to use to sort the list results:

\n \n

If not specified or set to null, the results are returned in an arbitrary order.

" } }, "applicationName": { @@ -5797,16 +5795,16 @@ "smithy.api#required": {} } }, - "s3KeyPrefix": { - "target": "com.amazonaws.codedeploy#S3Key", + "s3Bucket": { + "target": "com.amazonaws.codedeploy#S3Bucket", "traits": { - "smithy.api#documentation": "

A key prefix for the set of Amazon S3 objects to limit the search for revisions.\n

" + "smithy.api#documentation": "

An Amazon S3 bucket name to limit the search for revisions.

\n

If set to null, all of the user's buckets are searched.

" } }, - "sortBy": { - "target": "com.amazonaws.codedeploy#ApplicationRevisionSortBy", + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", "traits": { - "smithy.api#documentation": "

The column name to use to sort the list results:

\n \n

If not specified or set to null, the results are returned in an arbitrary order.

" + "smithy.api#documentation": "

An identifier returned from the previous ListApplicationRevisions call.\n It can be used to return the next set of applications in the list.

" } }, "deployed": { @@ -5815,10 +5813,10 @@ "smithy.api#documentation": "

Whether to list revisions based on whether the revision is the target revision of a\n deployment group:

\n " } }, - "nextToken": { - "target": "com.amazonaws.codedeploy#NextToken", + "s3KeyPrefix": { + "target": "com.amazonaws.codedeploy#S3Key", "traits": { - "smithy.api#documentation": "

An identifier returned from the previous ListApplicationRevisions call.\n It can be used to return the next set of applications in the list.

" + "smithy.api#documentation": "

A key prefix for the set of Amazon S3 objects to limit the search for revisions.\n

" } }, "sortOrder": { @@ -5947,17 +5945,17 @@ "com.amazonaws.codedeploy#ListDeploymentConfigsOutput": { "type": "structure", "members": { - "deploymentConfigsList": { - "target": "com.amazonaws.codedeploy#DeploymentConfigsList", - "traits": { - "smithy.api#documentation": "

A list of deployment configurations, including built-in configurations such as\n CodeDeployDefault.OneAtATime.

" - } - }, "nextToken": { "target": "com.amazonaws.codedeploy#NextToken", "traits": { "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment configurations call to return the next set of\n deployment configurations in the list.

" } + }, + "deploymentConfigsList": { + "target": "com.amazonaws.codedeploy#DeploymentConfigsList", + "traits": { + "smithy.api#documentation": "

A list of deployment configurations, including built-in configurations such as\n CodeDeployDefault.OneAtATime.

" + } } }, "traits": { @@ -6025,17 +6023,17 @@ "smithy.api#documentation": "

The application name.

" } }, - "nextToken": { - "target": "com.amazonaws.codedeploy#NextToken", - "traits": { - "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment groups call to return the next set of deployment\n groups in the list.

" - } - }, "deploymentGroups": { "target": "com.amazonaws.codedeploy#DeploymentGroupsList", "traits": { "smithy.api#documentation": "

A list of deployment group names.

" } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment groups call to return the next set of deployment\n groups in the list.

" + } } }, "traits": { @@ -6097,6 +6095,18 @@ "com.amazonaws.codedeploy#ListDeploymentInstancesInput": { "type": "structure", "members": { + "instanceTypeFilter": { + "target": "com.amazonaws.codedeploy#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

The set of instances in a blue/green deployment, either those in the original\n environment (\"BLUE\") or those in the replacement environment (\"GREEN\"), for which you\n want to view instance information.

" + } + }, + "instanceStatusFilter": { + "target": "com.amazonaws.codedeploy#InstanceStatusList", + "traits": { + "smithy.api#documentation": "

A subset of instances to list by status:

\n " + } + }, "deploymentId": { "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { @@ -6109,18 +6119,6 @@ "traits": { "smithy.api#documentation": "

An identifier returned from the previous list deployment instances call. It can be\n used to return the next set of deployment instances in the list.

" } - }, - "instanceTypeFilter": { - "target": "com.amazonaws.codedeploy#InstanceTypeList", - "traits": { - "smithy.api#documentation": "

The set of instances in a blue/green deployment, either those in the original\n environment (\"BLUE\") or those in the replacement environment (\"GREEN\"), for which you\n want to view instance information.

" - } - }, - "instanceStatusFilter": { - "target": "com.amazonaws.codedeploy#InstanceStatusList", - "traits": { - "smithy.api#documentation": "

A subset of instances to list by status:

\n " - } } }, "traits": { @@ -6130,17 +6128,17 @@ "com.amazonaws.codedeploy#ListDeploymentInstancesOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codedeploy#NextToken", - "traits": { - "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment instances call to return the next set of\n deployment instances in the list.

" - } - }, "instancesList": { "target": "com.amazonaws.codedeploy#InstancesList", "traits": { "smithy.api#documentation": "

A list of instance IDs.

" } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list deployment instances call to return the next set of\n deployment instances in the list.

" + } } }, "traits": { @@ -6188,6 +6186,12 @@ "com.amazonaws.codedeploy#ListDeploymentTargetsInput": { "type": "structure", "members": { + "deploymentId": { + "target": "com.amazonaws.codedeploy#DeploymentId", + "traits": { + "smithy.api#documentation": "

The unique ID of a deployment.

" + } + }, "targetFilters": { "target": "com.amazonaws.codedeploy#TargetFilters", "traits": { @@ -6199,12 +6203,6 @@ "traits": { "smithy.api#documentation": "

A token identifier returned from the previous ListDeploymentTargets\n call. It can be used to return the next set of deployment targets in the list.

" } - }, - "deploymentId": { - "target": "com.amazonaws.codedeploy#DeploymentId", - "traits": { - "smithy.api#documentation": "

The unique ID of a deployment.

" - } } } }, @@ -6280,10 +6278,10 @@ "com.amazonaws.codedeploy#ListDeploymentsInput": { "type": "structure", "members": { - "createTimeRange": { - "target": "com.amazonaws.codedeploy#TimeRange", + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", "traits": { - "smithy.api#documentation": "

A time range (start and end) for returning a subset of the list of deployments.

" + "smithy.api#documentation": "

An identifier returned from the previous list deployments call. It can be used to\n return the next set of deployments in the list.

" } }, "externalId": { @@ -6292,16 +6290,22 @@ "smithy.api#documentation": "

The unique ID of an external resource for returning deployments linked to the external resource.

" } }, + "createTimeRange": { + "target": "com.amazonaws.codedeploy#TimeRange", + "traits": { + "smithy.api#documentation": "

A time range (start and end) for returning a subset of the list of deployments.

" + } + }, "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

\n \n

If applicationName is specified, then deploymentGroupName must \n be specified. If it is not specified, then deploymentGroupName must not \n be specified.\n

\n " } }, - "nextToken": { - "target": "com.amazonaws.codedeploy#NextToken", + "includeOnlyStatuses": { + "target": "com.amazonaws.codedeploy#DeploymentStatusList", "traits": { - "smithy.api#documentation": "

An identifier returned from the previous list deployments call. It can be used to\n return the next set of deployments in the list.

" + "smithy.api#documentation": "

A subset of deployments to list by status:

\n " } }, "deploymentGroupName": { @@ -6309,12 +6313,6 @@ "traits": { "smithy.api#documentation": "

The name of a deployment group for the specified application.

\n \n

If deploymentGroupName is specified, then applicationName must \n be specified. If it is not specified, then applicationName must not \n be specified.\n

\n " } - }, - "includeOnlyStatuses": { - "target": "com.amazonaws.codedeploy#DeploymentStatusList", - "traits": { - "smithy.api#documentation": "

A subset of deployments to list by status:

\n " - } } }, "traits": { @@ -6424,10 +6422,10 @@ "com.amazonaws.codedeploy#ListOnPremisesInstancesInput": { "type": "structure", "members": { - "tagFilters": { - "target": "com.amazonaws.codedeploy#TagFilterList", + "registrationStatus": { + "target": "com.amazonaws.codedeploy#RegistrationStatus", "traits": { - "smithy.api#documentation": "

The on-premises instance tags that are used to restrict the on-premises instance\n names returned.

" + "smithy.api#documentation": "

The registration status of the on-premises instances:

\n " } }, "nextToken": { @@ -6436,10 +6434,10 @@ "smithy.api#documentation": "

An identifier returned from the previous list on-premises instances call. It can be\n used to return the next set of on-premises instances in the list.

" } }, - "registrationStatus": { - "target": "com.amazonaws.codedeploy#RegistrationStatus", + "tagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", "traits": { - "smithy.api#documentation": "

The registration status of the on-premises instances:

\n " + "smithy.api#documentation": "

The on-premises instance tags that are used to restrict the on-premises instance\n names returned.

" } } }, @@ -6450,17 +6448,17 @@ "com.amazonaws.codedeploy#ListOnPremisesInstancesOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codedeploy#NextToken", - "traits": { - "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list on-premises instances call to return the next set of\n on-premises instances in the list.

" - } - }, "instanceNames": { "target": "com.amazonaws.codedeploy#InstanceNameList", "traits": { "smithy.api#documentation": "

The list of matching on-premises instance names.

" } + }, + "nextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

If a large amount of information is returned, an identifier is also returned. It can\n be used in a subsequent list on-premises instances call to return the next set of\n on-premises instances in the list.

" + } } }, "traits": { @@ -6512,18 +6510,18 @@ "com.amazonaws.codedeploy#ListTagsForResourceInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.codedeploy#NextToken", - "traits": { - "smithy.api#documentation": "

An identifier returned from the previous ListTagsForResource call.\n It can be used to return the next set of applications in the list.

" - } - }, "ResourceArn": { "target": "com.amazonaws.codedeploy#Arn", "traits": { "smithy.api#documentation": "

\n The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the \n resource that is identified by the ResourceArn.\n

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.codedeploy#NextToken", + "traits": { + "smithy.api#documentation": "

An identifier returned from the previous ListTagsForResource call.\n It can be used to return the next set of applications in the list.

" + } } } }, @@ -6556,18 +6554,18 @@ "com.amazonaws.codedeploy#LoadBalancerInfo": { "type": "structure", "members": { - "targetGroupPairInfoList": { - "target": "com.amazonaws.codedeploy#TargetGroupPairInfoList", - "traits": { - "smithy.api#documentation": "

The target group pair information. This is an array of\n TargeGroupPairInfo objects with a maximum size of one.

" - } - }, "targetGroupInfoList": { "target": "com.amazonaws.codedeploy#TargetGroupInfoList", "traits": { "smithy.api#documentation": "

An array that contains information about the target group to use for load balancing in\n a deployment. In Elastic Load Balancing, target groups are used with Application Load\n Balancers.

\n \n

Adding more than one target group to the array is not supported.

\n " } }, + "targetGroupPairInfoList": { + "target": "com.amazonaws.codedeploy#TargetGroupPairInfoList", + "traits": { + "smithy.api#documentation": "

The target group pair information. This is an array of\n TargeGroupPairInfo objects with a maximum size of one.

" + } + }, "elbInfoList": { "target": "com.amazonaws.codedeploy#ELBInfoList", "traits": { @@ -6727,17 +6725,17 @@ "smithy.api#documentation": "

The unique ID of a deployment. Pass this ID to a Lambda function that validates a\n deployment lifecycle event.

" } }, - "status": { - "target": "com.amazonaws.codedeploy#LifecycleEventStatus", - "traits": { - "smithy.api#documentation": "

The result of a Lambda function that validates a deployment lifecycle event\n (Succeeded or Failed).

" - } - }, "lifecycleEventHookExecutionId": { "target": "com.amazonaws.codedeploy#LifecycleEventHookExecutionId", "traits": { "smithy.api#documentation": "

The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is\n specified in the hooks section of the AppSpec file.

" } + }, + "status": { + "target": "com.amazonaws.codedeploy#LifecycleEventStatus", + "traits": { + "smithy.api#documentation": "

The result of a Lambda function that validates a deployment lifecycle event\n (Succeeded or Failed).

" + } } } }, @@ -6820,18 +6818,18 @@ "smithy.api#required": {} } }, + "description": { + "target": "com.amazonaws.codedeploy#Description", + "traits": { + "smithy.api#documentation": "

A comment about the revision.

" + } + }, "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { "smithy.api#documentation": "

The name of an AWS CodeDeploy application associated with the IAM user or AWS\n account.

", "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.codedeploy#Description", - "traits": { - "smithy.api#documentation": "

A comment about the revision.

" - } } }, "traits": { @@ -7024,19 +7022,19 @@ } }, "com.amazonaws.codedeploy#RevisionInfo": { - "type": "structure", - "members": { - "revisionLocation": { - "target": "com.amazonaws.codedeploy#RevisionLocation", - "traits": { - "smithy.api#documentation": "

Information about the location and type of an application revision.

" - } - }, + "type": "structure", + "members": { "genericRevisionInfo": { "target": "com.amazonaws.codedeploy#GenericRevisionInfo", "traits": { "smithy.api#documentation": "

Information about an application revision, including usage details and associated\n deployment groups.

" } + }, + "revisionLocation": { + "target": "com.amazonaws.codedeploy#RevisionLocation", + "traits": { + "smithy.api#documentation": "

Information about the location and type of an application revision.

" + } } }, "traits": { @@ -7052,10 +7050,10 @@ "com.amazonaws.codedeploy#RevisionLocation": { "type": "structure", "members": { - "gitHubLocation": { - "target": "com.amazonaws.codedeploy#GitHubLocation", + "appSpecContent": { + "target": "com.amazonaws.codedeploy#AppSpecContent", "traits": { - "smithy.api#documentation": "

Information about the location of application artifacts stored in GitHub.

" + "smithy.api#documentation": "

The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The\n content is formatted as JSON or YAML and stored as a RawString.

" } }, "revisionType": { @@ -7064,22 +7062,22 @@ "smithy.api#documentation": "

The type of application revision:

\n " } }, - "appSpecContent": { - "target": "com.amazonaws.codedeploy#AppSpecContent", + "s3Location": { + "target": "com.amazonaws.codedeploy#S3Location", "traits": { - "smithy.api#documentation": "

The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The\n content is formatted as JSON or YAML and stored as a RawString.

" + "smithy.api#documentation": "

Information about the location of a revision stored in Amazon S3.

" } }, - "string": { - "target": "com.amazonaws.codedeploy#RawString", + "gitHubLocation": { + "target": "com.amazonaws.codedeploy#GitHubLocation", "traits": { - "smithy.api#documentation": "

Information about the location of an AWS Lambda deployment revision stored as a\n RawString.

" + "smithy.api#documentation": "

Information about the location of application artifacts stored in GitHub.

" } }, - "s3Location": { - "target": "com.amazonaws.codedeploy#S3Location", + "string": { + "target": "com.amazonaws.codedeploy#RawString", "traits": { - "smithy.api#documentation": "

Information about the location of a revision stored in Amazon S3.

" + "smithy.api#documentation": "

Information about the location of an AWS Lambda deployment revision stored as a\n RawString.

" } } }, @@ -7152,16 +7150,16 @@ "com.amazonaws.codedeploy#RollbackInfo": { "type": "structure", "members": { - "rollbackTriggeringDeploymentId": { + "rollbackDeploymentId": { "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

The deployment ID of the deployment that was underway and triggered a rollback\n deployment because it failed or was stopped.

" + "smithy.api#documentation": "

The ID of the deployment rollback.

" } }, - "rollbackDeploymentId": { + "rollbackTriggeringDeploymentId": { "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { - "smithy.api#documentation": "

The ID of the deployment rollback.

" + "smithy.api#documentation": "

The deployment ID of the deployment that was underway and triggered a rollback\n deployment because it failed or was stopped.

" } }, "rollbackMessage": { @@ -7196,6 +7194,12 @@ "smithy.api#documentation": "

The file type of the application revision. Must be one of the following:

\n " } }, + "version": { + "target": "com.amazonaws.codedeploy#VersionId", + "traits": { + "smithy.api#documentation": "

A specific version of the Amazon S3 object that represents the bundled artifacts for\n the application revision.

\n

If the version is not specified, the system uses the most recent version by\n default.

" + } + }, "eTag": { "target": "com.amazonaws.codedeploy#ETag", "traits": { @@ -7207,12 +7211,6 @@ "traits": { "smithy.api#documentation": "

The name of the Amazon S3 object that represents the bundled artifacts for the\n application revision.

" } - }, - "version": { - "target": "com.amazonaws.codedeploy#VersionId", - "traits": { - "smithy.api#documentation": "

A specific version of the Amazon S3 object that represents the bundled artifacts for\n the application revision.

\n

If the version is not specified, the system uses the most recent version by\n default.

" - } } }, "traits": { @@ -7315,18 +7313,18 @@ "com.amazonaws.codedeploy#StopDeploymentInput": { "type": "structure", "members": { + "autoRollbackEnabled": { + "target": "com.amazonaws.codedeploy#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Indicates, when a deployment is stopped, whether instances that have been updated\n should be rolled back to the previous version of the application revision.

" + } + }, "deploymentId": { "target": "com.amazonaws.codedeploy#DeploymentId", "traits": { "smithy.api#documentation": "

The unique ID of a deployment.

", "smithy.api#required": {} } - }, - "autoRollbackEnabled": { - "target": "com.amazonaws.codedeploy#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Indicates, when a deployment is stopped, whether instances that have been updated\n should be rolled back to the previous version of the application revision.

" - } } }, "traits": { @@ -7371,17 +7369,17 @@ "com.amazonaws.codedeploy#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.codedeploy#Key", - "traits": { - "smithy.api#documentation": "

The tag's key.

" - } - }, "Value": { "target": "com.amazonaws.codedeploy#Value", "traits": { "smithy.api#documentation": "

The tag's value.

" } + }, + "Key": { + "target": "com.amazonaws.codedeploy#Key", + "traits": { + "smithy.api#documentation": "

The tag's key.

" + } } }, "traits": { @@ -7391,12 +7389,6 @@ "com.amazonaws.codedeploy#TagFilter": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.codedeploy#TagFilterType", - "traits": { - "smithy.api#documentation": "

The on-premises instance tag filter type:

\n " - } - }, "Key": { "target": "com.amazonaws.codedeploy#Key", "traits": { @@ -7408,6 +7400,12 @@ "traits": { "smithy.api#documentation": "

The on-premises instance tag filter value.

" } + }, + "Type": { + "target": "com.amazonaws.codedeploy#TagFilterType", + "traits": { + "smithy.api#documentation": "

The on-premises instance tag filter type:

\n " + } } }, "traits": { @@ -7522,17 +7520,17 @@ "com.amazonaws.codedeploy#TagResourceInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.codedeploy#TagList", + "ResourceArn": { + "target": "com.amazonaws.codedeploy#Arn", "traits": { - "smithy.api#documentation": "

\n A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.\n

", + "smithy.api#documentation": "

\n The ARN of a resource, such as a CodeDeploy application or deployment group.\n

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.codedeploy#Arn", + "Tags": { + "target": "com.amazonaws.codedeploy#TagList", "traits": { - "smithy.api#documentation": "

\n The ARN of a resource, such as a CodeDeploy application or deployment group.\n

", + "smithy.api#documentation": "

\n A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.\n

", "smithy.api#required": {} } } @@ -7610,6 +7608,12 @@ "com.amazonaws.codedeploy#TargetGroupPairInfo": { "type": "structure", "members": { + "targetGroups": { + "target": "com.amazonaws.codedeploy#TargetGroupInfoList", + "traits": { + "smithy.api#documentation": "

One pair of target groups. One is associated with the original task set. The second\n is associated with the task set that serves traffic after the deployment is complete.

" + } + }, "testTrafficRoute": { "target": "com.amazonaws.codedeploy#TrafficRoute", "traits": { @@ -7621,12 +7625,6 @@ "traits": { "smithy.api#documentation": "

The path used by a load balancer to route production traffic when an Amazon ECS\n deployment is complete.

" } - }, - "targetGroups": { - "target": "com.amazonaws.codedeploy#TargetGroupInfoList", - "traits": { - "smithy.api#documentation": "

One pair of target groups. One is associated with the original task set. The second\n is associated with the task set that serves traffic after the deployment is complete.

" - } } }, "traits": { @@ -7765,17 +7763,17 @@ "com.amazonaws.codedeploy#TimeBasedLinear": { "type": "structure", "members": { - "linearPercentage": { - "target": "com.amazonaws.codedeploy#Percentage", - "traits": { - "smithy.api#documentation": "

The percentage of traffic that is shifted at the start of each increment of a\n TimeBasedLinear deployment.

" - } - }, "linearInterval": { "target": "com.amazonaws.codedeploy#WaitTimeInMins", "traits": { "smithy.api#documentation": "

The number of minutes between each incremental traffic shift of a\n TimeBasedLinear deployment.

" } + }, + "linearPercentage": { + "target": "com.amazonaws.codedeploy#Percentage", + "traits": { + "smithy.api#documentation": "

The percentage of traffic that is shifted at the start of each increment of a\n TimeBasedLinear deployment.

" + } } }, "traits": { @@ -7822,12 +7820,6 @@ "com.amazonaws.codedeploy#TrafficRoutingConfig": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.codedeploy#TrafficRoutingType", - "traits": { - "smithy.api#documentation": "

The type of traffic shifting (TimeBasedCanary or\n TimeBasedLinear) used by a deployment configuration.

" - } - }, "timeBasedLinear": { "target": "com.amazonaws.codedeploy#TimeBasedLinear", "traits": { @@ -7839,6 +7831,12 @@ "traits": { "smithy.api#documentation": "

A configuration that shifts traffic from one version of a Lambda function or ECS task set to another\n in two increments. The original and target Lambda function versions or ECS task sets are specified in the\n deployment's AppSpec file.

" } + }, + "type": { + "target": "com.amazonaws.codedeploy#TrafficRoutingType", + "traits": { + "smithy.api#documentation": "

The type of traffic shifting (TimeBasedCanary or\n TimeBasedLinear) used by a deployment configuration.

" + } } }, "traits": { @@ -7870,12 +7868,6 @@ "com.amazonaws.codedeploy#TriggerConfig": { "type": "structure", "members": { - "triggerName": { - "target": "com.amazonaws.codedeploy#TriggerName", - "traits": { - "smithy.api#documentation": "

The name of the notification trigger.

" - } - }, "triggerTargetArn": { "target": "com.amazonaws.codedeploy#TriggerTargetArn", "traits": { @@ -7887,6 +7879,12 @@ "traits": { "smithy.api#documentation": "

The event type or types for which notifications are triggered.

" } + }, + "triggerName": { + "target": "com.amazonaws.codedeploy#TriggerName", + "traits": { + "smithy.api#documentation": "

The name of the notification trigger.

" + } } }, "traits": { @@ -8075,16 +8073,16 @@ "com.amazonaws.codedeploy#UpdateApplicationInput": { "type": "structure", "members": { - "applicationName": { + "newApplicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

The current name of the application you want to change.

" + "smithy.api#documentation": "

The new name to give the application.

" } }, - "newApplicationName": { + "applicationName": { "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

The new name to give the application.

" + "smithy.api#documentation": "

The current name of the application you want to change.

" } } }, @@ -8202,29 +8200,30 @@ "com.amazonaws.codedeploy#UpdateDeploymentGroupInput": { "type": "structure", "members": { - "deploymentStyle": { - "target": "com.amazonaws.codedeploy#DeploymentStyle", + "currentDeploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", "traits": { - "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" + "smithy.api#documentation": "

The current name of the deployment group.

", + "smithy.api#required": {} } }, - "applicationName": { - "target": "com.amazonaws.codedeploy#ApplicationName", + "deploymentConfigName": { + "target": "com.amazonaws.codedeploy#DeploymentConfigName", "traits": { - "smithy.api#documentation": "

The application name that corresponds to the deployment group to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The replacement deployment configuration name to use, if you want to change it.

" } }, - "blueGreenDeploymentConfiguration": { - "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", + "ec2TagFilters": { + "target": "com.amazonaws.codedeploy#EC2TagFilterList", "traits": { - "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + "smithy.api#documentation": "

The replacement set of Amazon EC2 tags on which to filter, if you want to change them.\n To keep the existing tags, enter their names. To remove tags, do not enter any tag\n names.

" } }, - "onPremisesInstanceTagFilters": { - "target": "com.amazonaws.codedeploy#TagFilterList", + "applicationName": { + "target": "com.amazonaws.codedeploy#ApplicationName", "traits": { - "smithy.api#documentation": "

The replacement set of on-premises instance tags on which to filter, if you want to\n change them. To keep the existing tags, enter their names. To remove tags, do not enter\n any tag names.

" + "smithy.api#documentation": "

The application name that corresponds to the deployment group to update.

", + "smithy.api#required": {} } }, "alarmConfiguration": { @@ -8233,34 +8232,16 @@ "smithy.api#documentation": "

Information to add or change about Amazon CloudWatch alarms when the deployment group\n is updated.

" } }, - "loadBalancerInfo": { - "target": "com.amazonaws.codedeploy#LoadBalancerInfo", - "traits": { - "smithy.api#documentation": "

Information about the load balancer used in a deployment.

" - } - }, - "autoScalingGroups": { - "target": "com.amazonaws.codedeploy#AutoScalingGroupNameList", - "traits": { - "smithy.api#documentation": "

The replacement list of Auto Scaling groups to be included in the deployment group, if\n you want to change them. To keep the Auto Scaling groups, enter their names. To remove\n Auto Scaling groups, do not enter any Auto Scaling group names.

" - } - }, "serviceRoleArn": { "target": "com.amazonaws.codedeploy#Role", "traits": { "smithy.api#documentation": "

A replacement ARN for the service role, if you want to change it.

" } }, - "ec2TagFilters": { - "target": "com.amazonaws.codedeploy#EC2TagFilterList", - "traits": { - "smithy.api#documentation": "

The replacement set of Amazon EC2 tags on which to filter, if you want to change them.\n To keep the existing tags, enter their names. To remove tags, do not enter any tag\n names.

" - } - }, - "ecsServices": { - "target": "com.amazonaws.codedeploy#ECSServiceList", + "newDeploymentGroupName": { + "target": "com.amazonaws.codedeploy#DeploymentGroupName", "traits": { - "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service\n is specified as an Amazon ECS cluster and service name pair using the format\n :.

" + "smithy.api#documentation": "

The new name of the deployment group, if you want to change it.

" } }, "onPremisesTagSet": { @@ -8269,11 +8250,22 @@ "smithy.api#documentation": "

Information about an on-premises instance tag set. The deployment group includes only\n on-premises instances identified by all the tag groups.

" } }, - "currentDeploymentGroupName": { - "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "triggerConfigurations": { + "target": "com.amazonaws.codedeploy#TriggerConfigList", "traits": { - "smithy.api#documentation": "

The current name of the deployment group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Information about triggers to change when the deployment group is updated. For\n examples, see Edit a Trigger in a\n CodeDeploy Deployment Group in the AWS CodeDeploy User\n Guide.

" + } + }, + "ec2TagSet": { + "target": "com.amazonaws.codedeploy#EC2TagSet", + "traits": { + "smithy.api#documentation": "

Information about groups of tags applied to on-premises instances. The deployment\n group includes only EC2 instances identified by all the tag groups.

" + } + }, + "deploymentStyle": { + "target": "com.amazonaws.codedeploy#DeploymentStyle", + "traits": { + "smithy.api#documentation": "

Information about the type of deployment, either in-place or blue/green, you want to\n run and whether to route deployment traffic behind a load balancer.

" } }, "autoRollbackConfiguration": { @@ -8282,28 +8274,34 @@ "smithy.api#documentation": "

Information for an automatic rollback configuration that is added or changed when a\n deployment group is updated.

" } }, - "triggerConfigurations": { - "target": "com.amazonaws.codedeploy#TriggerConfigList", + "autoScalingGroups": { + "target": "com.amazonaws.codedeploy#AutoScalingGroupNameList", "traits": { - "smithy.api#documentation": "

Information about triggers to change when the deployment group is updated. For\n examples, see Edit a Trigger in a\n CodeDeploy Deployment Group in the AWS CodeDeploy User\n Guide.

" + "smithy.api#documentation": "

The replacement list of Auto Scaling groups to be included in the deployment group, if\n you want to change them. To keep the Auto Scaling groups, enter their names. To remove\n Auto Scaling groups, do not enter any Auto Scaling group names.

" } }, - "deploymentConfigName": { - "target": "com.amazonaws.codedeploy#DeploymentConfigName", + "onPremisesInstanceTagFilters": { + "target": "com.amazonaws.codedeploy#TagFilterList", "traits": { - "smithy.api#documentation": "

The replacement deployment configuration name to use, if you want to change it.

" + "smithy.api#documentation": "

The replacement set of on-premises instance tags on which to filter, if you want to\n change them. To keep the existing tags, enter their names. To remove tags, do not enter\n any tag names.

" } }, - "newDeploymentGroupName": { - "target": "com.amazonaws.codedeploy#DeploymentGroupName", + "ecsServices": { + "target": "com.amazonaws.codedeploy#ECSServiceList", "traits": { - "smithy.api#documentation": "

The new name of the deployment group, if you want to change it.

" + "smithy.api#documentation": "

The target Amazon ECS services in the deployment group. This applies only to\n deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service\n is specified as an Amazon ECS cluster and service name pair using the format\n :.

" } }, - "ec2TagSet": { - "target": "com.amazonaws.codedeploy#EC2TagSet", + "blueGreenDeploymentConfiguration": { + "target": "com.amazonaws.codedeploy#BlueGreenDeploymentConfiguration", "traits": { - "smithy.api#documentation": "

Information about groups of tags applied to on-premises instances. The deployment\n group includes only EC2 instances identified by all the tag groups.

" + "smithy.api#documentation": "

Information about blue/green deployment options for a deployment group.

" + } + }, + "loadBalancerInfo": { + "target": "com.amazonaws.codedeploy#LoadBalancerInfo", + "traits": { + "smithy.api#documentation": "

Information about the load balancer used in a deployment.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/codeguru-reviewer.2019-09-19.json b/codegen/sdk-codegen/aws-models/codeguru-reviewer.2019-09-19.json index c11483c280b2..4830a1ec82ad 100644 --- a/codegen/sdk-codegen/aws-models/codeguru-reviewer.2019-09-19.json +++ b/codegen/sdk-codegen/aws-models/codeguru-reviewer.2019-09-19.json @@ -36,6 +36,9 @@ { "target": "com.amazonaws.codegurureviewer#AssociateRepository" }, + { + "target": "com.amazonaws.codegurureviewer#CreateCodeReview" + }, { "target": "com.amazonaws.codegurureviewer#DescribeCodeReview" }, @@ -69,7 +72,7 @@ "sdkId": "CodeGuru Reviewer", "arnNamespace": "codeguru-reviewer", "cloudFormationName": "CodeGuruReviewer", - "cloudTrailEventSource": "guru.amazonaws.com" + "cloudTrailEventSource": "codegurureviewer.amazonaws.com" }, "aws.auth#sigv4": { "name": "codeguru-reviewer" @@ -128,7 +131,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Use to associate an AWS CodeCommit repository or a repostory managed by \n AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a \n repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides \n automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see \n Recommendations in \n Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide. \n

\n \n

If you associate a CodeCommit repository, it must be in the same \n AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

\n \n

Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar\n Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in\n the Amazon CodeGuru Reviewer User Guide.\n

\n \n \n

\n You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate \n a GitHub repository, use the console. For more information, see \n Getting \n started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.\n

\n ", + "smithy.api#documentation": "

\n Use to associate an AWS CodeCommit repository or a repostory managed by \n AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a \n repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides \n automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see \n Recommendations in \n Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide. \n

\n \n

If you associate a CodeCommit repository, it must be in the same \n AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

\n \n

Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar\n Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in\n the Amazon CodeGuru Reviewer User Guide.\n

\n \n \n

\n You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate \n a GitHub repository, use the console. For more information, see \n Getting \n started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/associations", @@ -139,19 +142,19 @@ "com.amazonaws.codegurureviewer#AssociateRepositoryRequest": { "type": "structure", "members": { + "ClientRequestToken": { + "target": "com.amazonaws.codegurureviewer#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository\n associations if there are failures and retries.

", + "smithy.api#idempotencyToken": {} + } + }, "Repository": { "target": "com.amazonaws.codegurureviewer#Repository", "traits": { "smithy.api#documentation": "

The repository to associate.

", "smithy.api#required": {} } - }, - "ClientRequestToken": { - "target": "com.amazonaws.codegurureviewer#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

\n

To add a new repository association, this parameter specifies a unique \n identifier for the new repository association that helps ensure idempotency.

\n\n

If you use the AWS CLI or one of the AWS SDKs to call this operation, you \n can leave this parameter empty. The CLI or SDK generates a random UUID for you \n and includes that in the request. If you don't use the SDK and instead generate \n a raw HTTP request to the Secrets Manager service endpoint, you must generate \n a ClientRequestToken yourself for new versions and include that value in the request.

\n\n

You typically interact with this value if you implement your own retry \n logic and want to ensure that a given repository association is not created twice. \n We recommend that you generate a UUID-type value to ensure uniqueness within the \n specified repository association.

\n\n

Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository\n associations if there are failures and retries.

", - "smithy.api#idempotencyToken": {} - } } } }, @@ -175,6 +178,15 @@ } } }, + "com.amazonaws.codegurureviewer#BranchName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.codegurureviewer#ClientRequestToken": { "type": "string", "traits": { @@ -209,28 +221,34 @@ "smithy.api#documentation": "

\n The reason for the state of the code review.\n

" } }, + "Metrics": { + "target": "com.amazonaws.codegurureviewer#Metrics", + "traits": { + "smithy.api#documentation": "

\n The statistics from the code review.\n

" + } + }, "Type": { "target": "com.amazonaws.codegurureviewer#Type", "traits": { "smithy.api#documentation": "

\n The type of code review.\n

" } }, - "Owner": { - "target": "com.amazonaws.codegurureviewer#Owner", + "RepositoryName": { + "target": "com.amazonaws.codegurureviewer#Name", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

\n The name of the repository.\n

" } }, - "SourceCodeType": { - "target": "com.amazonaws.codegurureviewer#SourceCodeType", + "CreatedTimeStamp": { + "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { - "smithy.api#documentation": "

\n The type of the source code for the code review.\n

" + "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was created.\n

" } }, - "LastUpdatedTimeStamp": { - "target": "com.amazonaws.codegurureviewer#TimeStamp", + "State": { + "target": "com.amazonaws.codegurureviewer#JobState", "traits": { - "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was last updated.\n

" + "smithy.api#documentation": "

The valid code review states are:

\n " } }, "ProviderType": { @@ -239,46 +257,40 @@ "smithy.api#documentation": "

\n The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).\n

" } }, - "CodeReviewArn": { - "target": "com.amazonaws.codegurureviewer#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

" - } - }, - "PullRequestId": { - "target": "com.amazonaws.codegurureviewer#PullRequestId", + "LastUpdatedTimeStamp": { + "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { - "smithy.api#documentation": "

\n The pull request ID for the code review.\n

" + "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was last updated.\n

" } }, - "Name": { - "target": "com.amazonaws.codegurureviewer#Name", + "SourceCodeType": { + "target": "com.amazonaws.codegurureviewer#SourceCodeType", "traits": { - "smithy.api#documentation": "

\n The name of the code review.\n

" + "smithy.api#documentation": "

\n The type of the source code for the code review.\n

" } }, - "State": { - "target": "com.amazonaws.codegurureviewer#JobState", + "Owner": { + "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

The valid code review states are:

\n " + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" } }, - "Metrics": { - "target": "com.amazonaws.codegurureviewer#Metrics", + "Name": { + "target": "com.amazonaws.codegurureviewer#Name", "traits": { - "smithy.api#documentation": "

\n The statistics from the code review.\n

" + "smithy.api#documentation": "

\n The name of the code review.\n

" } }, - "CreatedTimeStamp": { - "target": "com.amazonaws.codegurureviewer#TimeStamp", + "CodeReviewArn": { + "target": "com.amazonaws.codegurureviewer#Arn", "traits": { - "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was created.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

" } }, - "RepositoryName": { - "target": "com.amazonaws.codegurureviewer#Name", + "PullRequestId": { + "target": "com.amazonaws.codegurureviewer#PullRequestId", "traits": { - "smithy.api#documentation": "

\n The name of the repository.\n

" + "smithy.api#documentation": "

\n The pull request ID for the code review.\n

" } } }, @@ -286,6 +298,16 @@ "smithy.api#documentation": "

\n Information about a code review.\n

" } }, + "com.amazonaws.codegurureviewer#CodeReviewName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "[a-zA-Z0-9-_]*" + } + }, "com.amazonaws.codegurureviewer#CodeReviewSummaries": { "type": "list", "member": { @@ -295,18 +317,18 @@ "com.amazonaws.codegurureviewer#CodeReviewSummary": { "type": "structure", "members": { - "ProviderType": { - "target": "com.amazonaws.codegurureviewer#ProviderType", - "traits": { - "smithy.api#documentation": "

\n The provider type of the repository association.\n

" - } - }, "State": { "target": "com.amazonaws.codegurureviewer#JobState", "traits": { "smithy.api#documentation": "

\n The state of the code review.\n

\n

The valid code review states are:

\n " } }, + "ProviderType": { + "target": "com.amazonaws.codegurureviewer#ProviderType", + "traits": { + "smithy.api#documentation": "

\n The provider type of the repository association.\n

" + } + }, "MetricsSummary": { "target": "com.amazonaws.codegurureviewer#MetricsSummary", "traits": { @@ -319,16 +341,22 @@ "smithy.api#documentation": "

\n The pull request ID for the code review.\n

" } }, - "CodeReviewArn": { - "target": "com.amazonaws.codegurureviewer#Arn", + "RepositoryName": { + "target": "com.amazonaws.codegurureviewer#Name", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

" + "smithy.api#documentation": "

\n The name of the repository.\n

" } }, - "Owner": { - "target": "com.amazonaws.codegurureviewer#Owner", + "LastUpdatedTimeStamp": { + "target": "com.amazonaws.codegurureviewer#TimeStamp", + "traits": { + "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was last updated.\n

" + } + }, + "Name": { + "target": "com.amazonaws.codegurureviewer#Name", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

\n The name of the code review.\n

" } }, "Type": { @@ -337,33 +365,42 @@ "smithy.api#documentation": "

\n The type of the code review.\n

" } }, - "CreatedTimeStamp": { - "target": "com.amazonaws.codegurureviewer#TimeStamp", + "Owner": { + "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was created.\n

" + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" } }, - "Name": { - "target": "com.amazonaws.codegurureviewer#Name", + "CodeReviewArn": { + "target": "com.amazonaws.codegurureviewer#Arn", "traits": { - "smithy.api#documentation": "

\n The name of the code review.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

" } }, - "LastUpdatedTimeStamp": { + "CreatedTimeStamp": { "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { - "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was last updated.\n

" + "smithy.api#documentation": "

\n The time, in milliseconds since the epoch, when the code review was created.\n

" } - }, - "RepositoryName": { - "target": "com.amazonaws.codegurureviewer#Name", + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about the summary of the code review.\n

" + } + }, + "com.amazonaws.codegurureviewer#CodeReviewType": { + "type": "structure", + "members": { + "RepositoryAnalysis": { + "target": "com.amazonaws.codegurureviewer#RepositoryAnalysis", "traits": { - "smithy.api#documentation": "

\n The name of the repository.\n

" + "smithy.api#documentation": "

\n A code review that analyzes all code under a specified branch in an associated respository. \n The assocated repository is specified using its ARN in \n CreateCodeReview\n \n

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n Information about the summary of the code review.\n

" + "smithy.api#documentation": "

\n The type of a code review. There are two code review types: \n

\n " } }, "com.amazonaws.codegurureviewer#CommitDiffSourceCodeType": { @@ -372,18 +409,18 @@ "SourceCommit": { "target": "com.amazonaws.codegurureviewer#CommitId", "traits": { - "smithy.api#documentation": "

\n The SHA of the source commit.\n

" + "smithy.api#documentation": "

\n The SHA of the source commit used to generate a commit diff.\n

" } }, "DestinationCommit": { "target": "com.amazonaws.codegurureviewer#CommitId", "traits": { - "smithy.api#documentation": "

\n The SHA of the destination commit.\n

" + "smithy.api#documentation": "

\n The SHA of the destination commit used to generate a commit diff.\n

" } } }, "traits": { - "smithy.api#documentation": "

\n The commit diff for the pull request.\n

" + "smithy.api#documentation": "

\n A type of \n SourceCodeType\n that \n specifies the commit diff for a pull request on an associated repository.\n

" } }, "com.amazonaws.codegurureviewer#CommitId": { @@ -418,6 +455,84 @@ "smithy.api#pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+" } }, + "com.amazonaws.codegurureviewer#CreateCodeReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurureviewer#CreateCodeReviewRequest" + }, + "output": { + "target": "com.amazonaws.codegurureviewer#CreateCodeReviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurureviewer#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurureviewer#ConflictException" + }, + { + "target": "com.amazonaws.codegurureviewer#InternalServerException" + }, + { + "target": "com.amazonaws.codegurureviewer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurureviewer#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurureviewer#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Use to create a code review for a repository analysis.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/codereviews", + "code": 200 + } + } + }, + "com.amazonaws.codegurureviewer#CreateCodeReviewRequest": { + "type": "structure", + "members": { + "RepositoryAssociationArn": { + "target": "com.amazonaws.codegurureviewer#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the \n \n RepositoryAssociation\n object. \n You can retrieve this ARN by calling ListRepositories.\n

\n

\n A code review can only be created on an associated repository. This is the ARN of the \n associated repository.\n

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.codegurureviewer#CodeReviewName", + "traits": { + "smithy.api#documentation": "

\n The name of the code review. Each code review of the same code review type must have a unique name in your AWS account.\n

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.codegurureviewer#CodeReviewType", + "traits": { + "smithy.api#documentation": "

\n The type of code review to create. This is specified using a \n \n CodeReviewType\n \n object.\n

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.codegurureviewer#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

\n Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code \n reviews if there are failures and retries.\n

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.codegurureviewer#CreateCodeReviewResponse": { + "type": "structure", + "members": { + "CodeReview": { + "target": "com.amazonaws.codegurureviewer#CodeReview" + } + } + }, "com.amazonaws.codegurureviewer#DescribeCodeReview": { "type": "operation", "input": { @@ -513,6 +628,13 @@ "com.amazonaws.codegurureviewer#DescribeRecommendationFeedbackRequest": { "type": "structure", "members": { + "UserId": { + "target": "com.amazonaws.codegurureviewer#UserId", + "traits": { + "smithy.api#documentation": "

\n Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.\n

\n

\n The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For \n more information, see \n Specifying a Principal in the AWS Identity and Access Management User Guide.\n

", + "smithy.api#httpQuery": "UserId" + } + }, "RecommendationId": { "target": "com.amazonaws.codegurureviewer#RecommendationId", "traits": { @@ -528,13 +650,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "UserId": { - "target": "com.amazonaws.codegurureviewer#UserId", - "traits": { - "smithy.api#documentation": "

\n Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.\n

\n

\n The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For \n more information, see \n Specifying a Principal in the AWS Identity and Access Management User Guide.\n

", - "smithy.api#httpQuery": "UserId" - } } } }, @@ -589,7 +704,7 @@ "AssociationArn": { "target": "com.amazonaws.codegurureviewer#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n \n RepositoryAssociation\n object. \n You can retrieve this ARN by calling ListRepositories.

", + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the \n \n RepositoryAssociation\n object. \n You can retrieve this ARN by calling ListRepositories.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -650,7 +765,7 @@ "AssociationArn": { "target": "com.amazonaws.codegurureviewer#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n \n RepositoryAssociation\n object. \n

", + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the \n \n RepositoryAssociation\n object. \n You can retrieve this ARN by calling ListRepositories.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -789,6 +904,13 @@ "com.amazonaws.codegurureviewer#ListCodeReviewsRequest": { "type": "structure", "members": { + "ProviderTypes": { + "target": "com.amazonaws.codegurureviewer#ProviderTypes", + "traits": { + "smithy.api#documentation": "

\n List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.\n

", + "smithy.api#httpQuery": "ProviderTypes" + } + }, "MaxResults": { "target": "com.amazonaws.codegurureviewer#ListCodeReviewsMaxResults", "traits": { @@ -796,11 +918,11 @@ "smithy.api#httpQuery": "MaxResults" } }, - "NextToken": { - "target": "com.amazonaws.codegurureviewer#NextToken", + "States": { + "target": "com.amazonaws.codegurureviewer#JobStates", "traits": { - "smithy.api#documentation": "

\n If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.\n

", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "

\n List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.\n

\n

The valid code review states are:

\n ", + "smithy.api#httpQuery": "States" } }, "RepositoryNames": { @@ -818,18 +940,11 @@ "smithy.api#required": {} } }, - "States": { - "target": "com.amazonaws.codegurureviewer#JobStates", + "NextToken": { + "target": "com.amazonaws.codegurureviewer#NextToken", "traits": { - "smithy.api#documentation": "

\n List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.\n

\n

The valid code review states are:

\n ", - "smithy.api#httpQuery": "States" - } - }, - "ProviderTypes": { - "target": "com.amazonaws.codegurureviewer#ProviderTypes", - "traits": { - "smithy.api#documentation": "

\n List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.\n

", - "smithy.api#httpQuery": "ProviderTypes" + "smithy.api#documentation": "

\n If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.\n

", + "smithy.api#httpQuery": "NextToken" } } } @@ -900,21 +1015,6 @@ "smithy.api#httpQuery": "MaxResults" } }, - "UserIds": { - "target": "com.amazonaws.codegurureviewer#UserIds", - "traits": { - "smithy.api#documentation": "

\n An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.\n

\n

\n The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For \n more information, see \n Specifying a Principal in the AWS Identity and Access Management User Guide.\n

", - "smithy.api#httpQuery": "UserIds" - } - }, - "CodeReviewArn": { - "target": "com.amazonaws.codegurureviewer#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "RecommendationIds": { "target": "com.amazonaws.codegurureviewer#RecommendationIds", "traits": { @@ -928,23 +1028,38 @@ "smithy.api#documentation": "

\n If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.\n

", "smithy.api#httpQuery": "NextToken" } + }, + "CodeReviewArn": { + "target": "com.amazonaws.codegurureviewer#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserIds": { + "target": "com.amazonaws.codegurureviewer#UserIds", + "traits": { + "smithy.api#documentation": "

\n An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.\n

\n

\n The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For \n more information, see \n Specifying a Principal in the AWS Identity and Access Management User Guide.\n

", + "smithy.api#httpQuery": "UserIds" + } } } }, "com.amazonaws.codegurureviewer#ListRecommendationFeedbackResponse": { "type": "structure", "members": { - "RecommendationFeedbackSummaries": { - "target": "com.amazonaws.codegurureviewer#RecommendationFeedbackSummaries", - "traits": { - "smithy.api#documentation": "

Recommendation feedback summaries corresponding to the code review ARN.

" - } - }, "NextToken": { "target": "com.amazonaws.codegurureviewer#NextToken", "traits": { "smithy.api#documentation": "

\n If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.\n

" } + }, + "RecommendationFeedbackSummaries": { + "target": "com.amazonaws.codegurureviewer#RecommendationFeedbackSummaries", + "traits": { + "smithy.api#documentation": "

Recommendation feedback summaries corresponding to the code review ARN.

" + } } } }, @@ -997,6 +1112,13 @@ "smithy.api#httpQuery": "MaxResults" } }, + "NextToken": { + "target": "com.amazonaws.codegurureviewer#NextToken", + "traits": { + "smithy.api#documentation": "

\n Pagination token.\n

", + "smithy.api#httpQuery": "NextToken" + } + }, "CodeReviewArn": { "target": "com.amazonaws.codegurureviewer#Arn", "traits": { @@ -1004,30 +1126,23 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.codegurureviewer#NextToken", - "traits": { - "smithy.api#documentation": "

\n Pagination token.\n

", - "smithy.api#httpQuery": "NextToken" - } } } }, "com.amazonaws.codegurureviewer#ListRecommendationsResponse": { "type": "structure", "members": { - "RecommendationSummaries": { - "target": "com.amazonaws.codegurureviewer#RecommendationSummaries", - "traits": { - "smithy.api#documentation": "

\n List of recommendations for the requested code review.\n

" - } - }, "NextToken": { "target": "com.amazonaws.codegurureviewer#NextToken", "traits": { "smithy.api#documentation": "

\n Pagination token.\n

" } + }, + "RecommendationSummaries": { + "target": "com.amazonaws.codegurureviewer#RecommendationSummaries", + "traits": { + "smithy.api#documentation": "

\n List of recommendations for the requested code review.\n

" + } } } }, @@ -1067,6 +1182,20 @@ "com.amazonaws.codegurureviewer#ListRepositoryAssociationsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.codegurureviewer#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated \n ListRepositoryAssociations request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

\n \n

Treat this token as an opaque identifier that is only used to retrieve \n the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#httpQuery": "NextToken" + } + }, + "Owners": { + "target": "com.amazonaws.codegurureviewer#Owners", + "traits": { + "smithy.api#documentation": "

List of owners to use as a filter. \n For AWS CodeCommit, it is the name of the CodeCommit account that was\n used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account \n that was used to associate the repository.

", + "smithy.api#httpQuery": "Owner" + } + }, "MaxResults": { "target": "com.amazonaws.codegurureviewer#MaxResults", "traits": { @@ -1074,11 +1203,11 @@ "smithy.api#httpQuery": "MaxResults" } }, - "NextToken": { - "target": "com.amazonaws.codegurureviewer#NextToken", + "Names": { + "target": "com.amazonaws.codegurureviewer#Names", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated \n ListRepositoryAssociations request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

\n \n

Treat this token as an opaque identifier that is only used to retrieve \n the next items in a list and not for other programmatic purposes.

\n ", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "

List of repository names to use as a filter.

", + "smithy.api#httpQuery": "Name" } }, "ProviderTypes": { @@ -1091,23 +1220,9 @@ "States": { "target": "com.amazonaws.codegurureviewer#RepositoryAssociationStates", "traits": { - "smithy.api#documentation": "

List of repository association states to use as a filter.

\n

The valid repository association states are:

\n ", + "smithy.api#documentation": "

List of repository association states to use as a filter.

\n

The valid repository association states are:

\n ", "smithy.api#httpQuery": "State" } - }, - "Owners": { - "target": "com.amazonaws.codegurureviewer#Owners", - "traits": { - "smithy.api#documentation": "

List of owners to use as a filter. \n For AWS CodeCommit, it is the name of the CodeCommit account that was\n used to associate the repository. For other repository source providers, such as Bitbucket, this is name of the account \n that was used to associate the repository.

", - "smithy.api#httpQuery": "Owner" - } - }, - "Names": { - "target": "com.amazonaws.codegurureviewer#Names", - "traits": { - "smithy.api#documentation": "

List of repository names to use as a filter.

", - "smithy.api#httpQuery": "Name" - } } } }, @@ -1147,17 +1262,17 @@ "com.amazonaws.codegurureviewer#Metrics": { "type": "structure", "members": { - "MeteredLinesOfCodeCount": { - "target": "com.amazonaws.codegurureviewer#MeteredLinesOfCodeCount", - "traits": { - "smithy.api#documentation": "

\n Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, \n this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already \n existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments \n and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in \n a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, \n MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of\n code for a total of 2,725 lines of code.\n

" - } - }, "FindingsCount": { "target": "com.amazonaws.codegurureviewer#FindingsCount", "traits": { "smithy.api#documentation": "

\n Total number of recommendations found in the code review.\n

" } + }, + "MeteredLinesOfCodeCount": { + "target": "com.amazonaws.codegurureviewer#MeteredLinesOfCodeCount", + "traits": { + "smithy.api#documentation": "

\n Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, \n this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already \n existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments \n and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in \n a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, \n MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of\n code for a total of 2,725 lines of code.\n

" + } } }, "traits": { @@ -1167,17 +1282,17 @@ "com.amazonaws.codegurureviewer#MetricsSummary": { "type": "structure", "members": { - "MeteredLinesOfCodeCount": { - "target": "com.amazonaws.codegurureviewer#MeteredLinesOfCodeCount", - "traits": { - "smithy.api#documentation": "

\n Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, \n this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already \n existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments \n and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in \n a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, \n MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of\n code for a total of 2,725 lines of code.\n

" - } - }, "FindingsCount": { "target": "com.amazonaws.codegurureviewer#FindingsCount", "traits": { "smithy.api#documentation": "

\n Total number of recommendations found in the code review.\n

" } + }, + "MeteredLinesOfCodeCount": { + "target": "com.amazonaws.codegurureviewer#MeteredLinesOfCodeCount", + "traits": { + "smithy.api#documentation": "

\n Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, \n this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already \n existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments \n and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in \n a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, \n MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of\n code for a total of 2,725 lines of code.\n

" + } } }, "traits": { @@ -1331,10 +1446,10 @@ "com.amazonaws.codegurureviewer#PutRecommendationFeedbackRequest": { "type": "structure", "members": { - "Reactions": { - "target": "com.amazonaws.codegurureviewer#Reactions", + "RecommendationId": { + "target": "com.amazonaws.codegurureviewer#RecommendationId", "traits": { - "smithy.api#documentation": "

\n List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.\n

", + "smithy.api#documentation": "

\n The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.\n

", "smithy.api#required": {} } }, @@ -1345,10 +1460,10 @@ "smithy.api#required": {} } }, - "RecommendationId": { - "target": "com.amazonaws.codegurureviewer#RecommendationId", + "Reactions": { + "target": "com.amazonaws.codegurureviewer#Reactions", "traits": { - "smithy.api#documentation": "

\n The recommendation ID that can be used to track the provided recommendations and then to collect the feedback.\n

", + "smithy.api#documentation": "

\n List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback.\n

", "smithy.api#required": {} } } @@ -1388,22 +1503,16 @@ "com.amazonaws.codegurureviewer#RecommendationFeedback": { "type": "structure", "members": { - "RecommendationId": { - "target": "com.amazonaws.codegurureviewer#RecommendationId", - "traits": { - "smithy.api#documentation": "

\n The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.\n

" - } - }, - "CreatedTimeStamp": { + "LastUpdatedTimeStamp": { "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { - "smithy.api#documentation": "

\n The time at which the feedback was created.\n

" + "smithy.api#documentation": "

\n The time at which the feedback was last updated. \n

" } }, - "CodeReviewArn": { - "target": "com.amazonaws.codegurureviewer#Arn", + "RecommendationId": { + "target": "com.amazonaws.codegurureviewer#RecommendationId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

" + "smithy.api#documentation": "

\n The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.\n

" } }, "Reactions": { @@ -1418,10 +1527,16 @@ "smithy.api#documentation": "

\n The ID of the user that made the API call.\n

\n

\n The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For \n more information, see \n Specifying a Principal in the AWS Identity and Access Management User Guide.\n

" } }, - "LastUpdatedTimeStamp": { + "CodeReviewArn": { + "target": "com.amazonaws.codegurureviewer#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n CodeReview\n object.\n

" + } + }, + "CreatedTimeStamp": { "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { - "smithy.api#documentation": "

\n The time at which the feedback was last updated. \n

" + "smithy.api#documentation": "

\n The time at which the feedback was created.\n

" } } }, @@ -1438,10 +1553,10 @@ "com.amazonaws.codegurureviewer#RecommendationFeedbackSummary": { "type": "structure", "members": { - "Reactions": { - "target": "com.amazonaws.codegurureviewer#Reactions", + "UserId": { + "target": "com.amazonaws.codegurureviewer#UserId", "traits": { - "smithy.api#documentation": "

\n List for storing reactions. Reactions are utf-8 text code for emojis.\n

" + "smithy.api#documentation": "

\n The ID of the user that gave the feedback.\n

\n

\n The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For \n more information, see \n Specifying a Principal in the AWS Identity and Access Management User Guide.\n

" } }, "RecommendationId": { @@ -1450,10 +1565,10 @@ "smithy.api#documentation": "

\n The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.\n

" } }, - "UserId": { - "target": "com.amazonaws.codegurureviewer#UserId", + "Reactions": { + "target": "com.amazonaws.codegurureviewer#Reactions", "traits": { - "smithy.api#documentation": "

\n The ID of the user that gave the feedback.\n

\n

\n The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For \n more information, see \n Specifying a Principal in the AWS Identity and Access Management User Guide.\n

" + "smithy.api#documentation": "

\n List for storing reactions. Reactions are utf-8 text code for emojis.\n

" } } }, @@ -1491,22 +1606,16 @@ "com.amazonaws.codegurureviewer#RecommendationSummary": { "type": "structure", "members": { - "FilePath": { - "target": "com.amazonaws.codegurureviewer#FilePath", - "traits": { - "smithy.api#documentation": "

Name of the file on which a recommendation is provided.

" - } - }, "Description": { "target": "com.amazonaws.codegurureviewer#Text", "traits": { "smithy.api#documentation": "

\n A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.\n

" } }, - "StartLine": { - "target": "com.amazonaws.codegurureviewer#LineNumber", + "FilePath": { + "target": "com.amazonaws.codegurureviewer#FilePath", "traits": { - "smithy.api#documentation": "

\n Start line from where the recommendation is applicable in the source commit or source branch.\n

" + "smithy.api#documentation": "

Name of the file on which a recommendation is provided.

" } }, "RecommendationId": { @@ -1520,6 +1629,12 @@ "traits": { "smithy.api#documentation": "

\n Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.\n

" } + }, + "StartLine": { + "target": "com.amazonaws.codegurureviewer#LineNumber", + "traits": { + "smithy.api#documentation": "

\n Start line from where the recommendation is applicable in the source commit or source branch.\n

" + } } }, "traits": { @@ -1535,84 +1650,99 @@ "smithy.api#documentation": "

\n Information about a GitHub Enterprise Server repository.\n

" } }, - "Bitbucket": { - "target": "com.amazonaws.codegurureviewer#ThirdPartySourceRepository", - "traits": { - "smithy.api#documentation": "

\n Information about a Bitbucket repository.\n

" - } - }, "CodeCommit": { "target": "com.amazonaws.codegurureviewer#CodeCommitRepository", "traits": { "smithy.api#documentation": "

Information about an AWS CodeCommit repository.

" } + }, + "Bitbucket": { + "target": "com.amazonaws.codegurureviewer#ThirdPartySourceRepository", + "traits": { + "smithy.api#documentation": "

\n Information about a Bitbucket repository.\n

" + } } }, "traits": { "smithy.api#documentation": "

\n Information about an associated AWS CodeCommit repository or an associated repository that is managed \n by AWS CodeStar Connections (for example, Bitbucket). This Repository object \n is not used if your source code is in an associated GitHub repository.\n

" } }, - "com.amazonaws.codegurureviewer#RepositoryAssociation": { + "com.amazonaws.codegurureviewer#RepositoryAnalysis": { "type": "structure", "members": { - "AssociationArn": { - "target": "com.amazonaws.codegurureviewer#Arn", + "RepositoryHead": { + "target": "com.amazonaws.codegurureviewer#RepositoryHeadSourceCodeType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the repository association.

" + "smithy.api#documentation": "

\n A \n SourceCodeType\n that \n specifies the tip of a branch in an associated repository. \n

", + "smithy.api#required": {} } - }, + } + }, + "traits": { + "smithy.api#documentation": "

\n A code review type that analyzes all code under a specified branch in an associated respository. \n The assocated repository is specified using its ARN when you call \n CreateCodeReview\n .\n

" + } + }, + "com.amazonaws.codegurureviewer#RepositoryAssociation": { + "type": "structure", + "members": { "LastUpdatedTimeStamp": { "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the repository association was last updated.

" } }, - "CreatedTimeStamp": { - "target": "com.amazonaws.codegurureviewer#TimeStamp", + "Owner": { + "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the repository association was created.

" + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" } }, - "ProviderType": { - "target": "com.amazonaws.codegurureviewer#ProviderType", + "AssociationId": { + "target": "com.amazonaws.codegurureviewer#AssociationId", "traits": { - "smithy.api#documentation": "

The provider type of the repository association.

" + "smithy.api#documentation": "

The ID of the repository association.

" } }, - "StateReason": { - "target": "com.amazonaws.codegurureviewer#StateReason", + "Name": { + "target": "com.amazonaws.codegurureviewer#Name", "traits": { - "smithy.api#documentation": "

A description of why the repository association is in the current state.

" + "smithy.api#documentation": "

The name of the repository.

" } }, - "State": { - "target": "com.amazonaws.codegurureviewer#RepositoryAssociationState", + "ConnectionArn": { + "target": "com.amazonaws.codegurureviewer#ConnectionArn", "traits": { - "smithy.api#documentation": "

The state of the repository association.

\n

The valid repository association states are:

\n " + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is \n arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see \n \n Connection\n in \n the AWS CodeStar Connections API Reference.\n

" } }, - "ConnectionArn": { - "target": "com.amazonaws.codegurureviewer#ConnectionArn", + "ProviderType": { + "target": "com.amazonaws.codegurureviewer#ProviderType", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is \n arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see \n Connection in \n the AWS CodeStar Connections API Reference.\n

" + "smithy.api#documentation": "

The provider type of the repository association.

" } }, - "Name": { - "target": "com.amazonaws.codegurureviewer#Name", + "AssociationArn": { + "target": "com.amazonaws.codegurureviewer#Arn", "traits": { - "smithy.api#documentation": "

The name of the repository.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the repository association.

" } }, - "AssociationId": { - "target": "com.amazonaws.codegurureviewer#AssociationId", + "CreatedTimeStamp": { + "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { - "smithy.api#documentation": "

The ID of the repository association.

" + "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the repository association was created.

" } }, - "Owner": { - "target": "com.amazonaws.codegurureviewer#Owner", + "StateReason": { + "target": "com.amazonaws.codegurureviewer#StateReason", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

A description of why the repository association is in the current state.

" + } + }, + "State": { + "target": "com.amazonaws.codegurureviewer#RepositoryAssociationState", + "traits": { + "smithy.api#documentation": "

The state of the repository association.

\n

The valid repository association states are:

\n " } } }, @@ -1664,10 +1794,10 @@ "com.amazonaws.codegurureviewer#RepositoryAssociationSummary": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.codegurureviewer#RepositoryAssociationState", + "ProviderType": { + "target": "com.amazonaws.codegurureviewer#ProviderType", "traits": { - "smithy.api#documentation": "

The state of the repository association.

\n

The valid repository association states are:

\n " + "smithy.api#documentation": "

The provider type of the repository association.

" } }, "AssociationId": { @@ -1676,40 +1806,40 @@ "smithy.api#documentation": "

\n The repository association ID.\n

" } }, - "ProviderType": { - "target": "com.amazonaws.codegurureviewer#ProviderType", + "State": { + "target": "com.amazonaws.codegurureviewer#RepositoryAssociationState", "traits": { - "smithy.api#documentation": "

The provider type of the repository association.

" + "smithy.api#documentation": "

The state of the repository association.

\n

The valid repository association states are:

\n " } }, - "Name": { - "target": "com.amazonaws.codegurureviewer#Name", + "ConnectionArn": { + "target": "com.amazonaws.codegurureviewer#ConnectionArn", "traits": { - "smithy.api#documentation": "

The name of the repository association.

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is \n arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see \n \n Connection\n in \n the AWS CodeStar Connections API Reference.\n

" } }, - "AssociationArn": { - "target": "com.amazonaws.codegurureviewer#Arn", + "LastUpdatedTimeStamp": { + "target": "com.amazonaws.codegurureviewer#TimeStamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n \n RepositoryAssociation\n object. \n

" + "smithy.api#documentation": "

The time, in milliseconds since the epoch, since the repository association\n was last updated.\n

" } }, - "ConnectionArn": { - "target": "com.amazonaws.codegurureviewer#ConnectionArn", + "Owner": { + "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is \n arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see \n Connection in \n the AWS CodeStar Connections API Reference.\n

" + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" } }, - "Owner": { - "target": "com.amazonaws.codegurureviewer#Owner", + "AssociationArn": { + "target": "com.amazonaws.codegurureviewer#Arn", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the \n \n RepositoryAssociation\n object. \n You can retrieve this ARN by calling ListRepositories.\n

" } }, - "LastUpdatedTimeStamp": { - "target": "com.amazonaws.codegurureviewer#TimeStamp", + "Name": { + "target": "com.amazonaws.codegurureviewer#Name", "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, since the repository association\n was last updated.\n

" + "smithy.api#documentation": "

The name of the repository association.

" } } }, @@ -1717,6 +1847,21 @@ "smithy.api#documentation": "

Summary information about a repository association. The \n \n ListRepositoryAssociations\n \n operation returns a list of RepositoryAssociationSummary objects.

" } }, + "com.amazonaws.codegurureviewer#RepositoryHeadSourceCodeType": { + "type": "structure", + "members": { + "BranchName": { + "target": "com.amazonaws.codegurureviewer#BranchName", + "traits": { + "smithy.api#documentation": "

\n The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies \n the tip of this branch.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A \n SourceCodeType\n that specifies \n the tip of a branch in an associated repository.\n

" + } + }, "com.amazonaws.codegurureviewer#RepositoryNames": { "type": "list", "member": { @@ -1748,12 +1893,15 @@ "CommitDiff": { "target": "com.amazonaws.codegurureviewer#CommitDiffSourceCodeType", "traits": { - "smithy.api#documentation": "

\n The commit diff for the pull request.\n

" + "smithy.api#documentation": "

\n A \n SourceCodeType\n that \n specifies a commit diff created by a pull request on an associated repository.\n

" } + }, + "RepositoryHead": { + "target": "com.amazonaws.codegurureviewer#RepositoryHeadSourceCodeType" } }, "traits": { - "smithy.api#documentation": "

\n Information about the source code type.\n

" + "smithy.api#documentation": "

\n Specifies the source code that is analyzed in a code review. A code review can analyze the source code that is specified \n using a pull request diff or a branch in an associated repository.\n

" } }, "com.amazonaws.codegurureviewer#StateReason": { @@ -1777,6 +1925,13 @@ "com.amazonaws.codegurureviewer#ThirdPartySourceRepository": { "type": "structure", "members": { + "ConnectionArn": { + "target": "com.amazonaws.codegurureviewer#ConnectionArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is \n arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see \n \n Connection\n in \n the AWS CodeStar Connections API Reference.\n

", + "smithy.api#required": {} + } + }, "Owner": { "target": "com.amazonaws.codegurureviewer#Owner", "traits": { @@ -1790,13 +1945,6 @@ "smithy.api#documentation": "

\n The name of the third party source repository.\n

", "smithy.api#required": {} } - }, - "ConnectionArn": { - "target": "com.amazonaws.codegurureviewer#ConnectionArn", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is \n arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see \n Connection in \n the AWS CodeStar Connections API Reference.\n

", - "smithy.api#required": {} - } } }, "traits": { @@ -1826,6 +1974,10 @@ { "value": "PullRequest", "name": "PULL_REQUEST" + }, + { + "value": "RepositoryAnalysis", + "name": "REPOSITORY_ANALYSIS" } ] } diff --git a/codegen/sdk-codegen/aws-models/codepipeline.2015-07-09.json b/codegen/sdk-codegen/aws-models/codepipeline.2015-07-09.json index 4e1f59979bcf..e25512b5bf23 100644 --- a/codegen/sdk-codegen/aws-models/codepipeline.2015-07-09.json +++ b/codegen/sdk-codegen/aws-models/codepipeline.2015-07-09.json @@ -165,6 +165,13 @@ "com.amazonaws.codepipeline#AcknowledgeThirdPartyJobInput": { "type": "structure", "members": { + "jobId": { + "target": "com.amazonaws.codepipeline#ThirdPartyJobId", + "traits": { + "smithy.api#documentation": "

The unique system-generated ID of the job.

", + "smithy.api#required": {} + } + }, "clientToken": { "target": "com.amazonaws.codepipeline#ClientToken", "traits": { @@ -178,13 +185,6 @@ "smithy.api#documentation": "

A system-generated random number that AWS CodePipeline uses to ensure that the job\n is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.

", "smithy.api#required": {} } - }, - "jobId": { - "target": "com.amazonaws.codepipeline#ThirdPartyJobId", - "traits": { - "smithy.api#documentation": "

The unique system-generated ID of the job.

", - "smithy.api#required": {} - } } }, "traits": { @@ -277,12 +277,6 @@ "smithy.api#documentation": "

Indicates that the property is used with PollForJobs. When creating a\n custom action, an action can have up to one queryable property. If it has one, that\n property must be both required and not secret.

\n

If you create a pipeline with a custom action type, and that custom action contains\n a queryable property, the value for that configuration property is subject to other\n restrictions. The value must be less than or equal to twenty (20) characters. The value\n can contain only alphanumeric characters, underscores, and hyphens.

" } }, - "description": { - "target": "com.amazonaws.codepipeline#Description", - "traits": { - "smithy.api#documentation": "

The description of the action configuration property that is displayed to\n users.

" - } - }, "required": { "target": "com.amazonaws.codepipeline#Boolean", "traits": { @@ -290,12 +284,6 @@ "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.codepipeline#ActionConfigurationPropertyType", - "traits": { - "smithy.api#documentation": "

The type of the configuration property.

" - } - }, "key": { "target": "com.amazonaws.codepipeline#Boolean", "traits": { @@ -303,6 +291,12 @@ "smithy.api#required": {} } }, + "type": { + "target": "com.amazonaws.codepipeline#ActionConfigurationPropertyType", + "traits": { + "smithy.api#documentation": "

The type of the configuration property.

" + } + }, "name": { "target": "com.amazonaws.codepipeline#ActionConfigurationKey", "traits": { @@ -310,6 +304,12 @@ "smithy.api#required": {} } }, + "description": { + "target": "com.amazonaws.codepipeline#Description", + "traits": { + "smithy.api#documentation": "

The description of the action configuration property that is displayed to\n users.

" + } + }, "secret": { "target": "com.amazonaws.codepipeline#Boolean", "traits": { @@ -401,6 +401,12 @@ "smithy.api#documentation": "

The ARN of the IAM service role that performs the declared action. This is assumed\n through the roleArn for the pipeline.

" } }, + "namespace": { + "target": "com.amazonaws.codepipeline#ActionNamespace", + "traits": { + "smithy.api#documentation": "

The variable namespace associated with the action. All variables produced as output by\n this action fall under this namespace.

" + } + }, "name": { "target": "com.amazonaws.codepipeline#ActionName", "traits": { @@ -408,16 +414,16 @@ "smithy.api#required": {} } }, - "namespace": { - "target": "com.amazonaws.codepipeline#ActionNamespace", + "configuration": { + "target": "com.amazonaws.codepipeline#ActionConfigurationMap", "traits": { - "smithy.api#documentation": "

The variable namespace associated with the action. All variables produced as output by\n this action fall under this namespace.

" + "smithy.api#documentation": "

The action's configuration. These are key-value pairs that specify input values for\n an action. For more information, see Action Structure Requirements in CodePipeline. For the list of\n configuration properties for the AWS CloudFormation action type in CodePipeline, see\n Configuration Properties Reference in the AWS CloudFormation User\n Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the\n AWS CloudFormation User Guide.

\n

The values can be represented in either JSON or YAML format. For example, the JSON\n configuration item format is as follows:

\n

\n JSON:\n

\n

\n \"Configuration\" : { Key : Value },\n

" } }, - "region": { - "target": "com.amazonaws.codepipeline#AWSRegionName", + "outputArtifacts": { + "target": "com.amazonaws.codepipeline#OutputArtifactList", "traits": { - "smithy.api#documentation": "

The action declaration's AWS Region, such as us-east-1.

" + "smithy.api#documentation": "

The name or ID of the result of the action declaration, such as a test or build\n artifact.

" } }, "actionTypeId": { @@ -427,28 +433,22 @@ "smithy.api#required": {} } }, - "configuration": { - "target": "com.amazonaws.codepipeline#ActionConfigurationMap", - "traits": { - "smithy.api#documentation": "

The action's configuration. These are key-value pairs that specify input values for\n an action. For more information, see Action Structure Requirements in CodePipeline. For the list of\n configuration properties for the AWS CloudFormation action type in CodePipeline, see\n Configuration Properties Reference in the AWS CloudFormation User\n Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the\n AWS CloudFormation User Guide.

\n

The values can be represented in either JSON or YAML format. For example, the JSON\n configuration item format is as follows:

\n

\n JSON:\n

\n

\n \"Configuration\" : { Key : Value },\n

" - } - }, "runOrder": { "target": "com.amazonaws.codepipeline#ActionRunOrder", "traits": { "smithy.api#documentation": "

The order in which actions are run.

" } }, - "inputArtifacts": { - "target": "com.amazonaws.codepipeline#InputArtifactList", + "region": { + "target": "com.amazonaws.codepipeline#AWSRegionName", "traits": { - "smithy.api#documentation": "

The name or ID of the artifact consumed by the action, such as a test or build\n artifact.

" + "smithy.api#documentation": "

The action declaration's AWS Region, such as us-east-1.

" } }, - "outputArtifacts": { - "target": "com.amazonaws.codepipeline#OutputArtifactList", + "inputArtifacts": { + "target": "com.amazonaws.codepipeline#InputArtifactList", "traits": { - "smithy.api#documentation": "

The name or ID of the result of the action declaration, such as a test or build\n artifact.

" + "smithy.api#documentation": "

The name or ID of the artifact consumed by the action, such as a test or build\n artifact.

" } } }, @@ -459,58 +459,58 @@ "com.amazonaws.codepipeline#ActionExecution": { "type": "structure", "members": { - "externalExecutionUrl": { - "target": "com.amazonaws.codepipeline#Url", - "traits": { - "smithy.api#documentation": "

The URL of a resource external to AWS that is used when running the action (for\n example, an external repository URL).

" - } - }, - "summary": { - "target": "com.amazonaws.codepipeline#ExecutionSummary", - "traits": { - "smithy.api#documentation": "

A summary of the run of the action.

" - } - }, "lastUpdatedBy": { "target": "com.amazonaws.codepipeline#LastUpdatedBy", "traits": { "smithy.api#documentation": "

The ARN of the user who last changed the pipeline.

" } }, - "lastStatusChange": { - "target": "com.amazonaws.codepipeline#Timestamp", - "traits": { - "smithy.api#documentation": "

The last status change of the action.

" - } - }, "percentComplete": { "target": "com.amazonaws.codepipeline#Percentage", "traits": { "smithy.api#documentation": "

A percentage of completeness of the action as it runs.

" } }, + "externalExecutionUrl": { + "target": "com.amazonaws.codepipeline#Url", + "traits": { + "smithy.api#documentation": "

The URL of a resource external to AWS that is used when running the action (for\n example, an external repository URL).

" + } + }, "errorDetails": { "target": "com.amazonaws.codepipeline#ErrorDetails", "traits": { "smithy.api#documentation": "

The details of an error returned by a URL external to AWS.

" } }, + "lastStatusChange": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "

The last status change of the action.

" + } + }, "status": { "target": "com.amazonaws.codepipeline#ActionExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the action, or for a completed action, the last status of the\n action.

" } }, + "token": { + "target": "com.amazonaws.codepipeline#ActionExecutionToken", + "traits": { + "smithy.api#documentation": "

The system-generated token used to identify a unique approval request. The token\n for each open approval request can be obtained using the GetPipelineState\n command. It is used to validate that the approval request corresponding to this token is\n still valid.

" + } + }, "externalExecutionId": { "target": "com.amazonaws.codepipeline#ExecutionId", "traits": { "smithy.api#documentation": "

The external ID of the run of the action.

" } }, - "token": { - "target": "com.amazonaws.codepipeline#ActionExecutionToken", + "summary": { + "target": "com.amazonaws.codepipeline#ExecutionSummary", "traits": { - "smithy.api#documentation": "

The system-generated token used to identify a unique approval request. The token\n for each open approval request can be obtained using the GetPipelineState\n command. It is used to validate that the approval request corresponding to this token is\n still valid.

" + "smithy.api#documentation": "

A summary of the run of the action.

" } } }, @@ -521,46 +521,22 @@ "com.amazonaws.codepipeline#ActionExecutionDetail": { "type": "structure", "members": { - "pipelineExecutionId": { - "target": "com.amazonaws.codepipeline#PipelineExecutionId", - "traits": { - "smithy.api#documentation": "

The pipeline execution ID for the action execution.

" - } - }, "startTime": { "target": "com.amazonaws.codepipeline#Timestamp", "traits": { "smithy.api#documentation": "

The start time of the action execution.

" } }, - "lastUpdateTime": { - "target": "com.amazonaws.codepipeline#Timestamp", - "traits": { - "smithy.api#documentation": "

The last update time of the action execution.

" - } - }, "input": { "target": "com.amazonaws.codepipeline#ActionExecutionInput", "traits": { "smithy.api#documentation": "

Input details for the action execution, such as role ARN, Region, and input\n artifacts.

" } }, - "pipelineVersion": { - "target": "com.amazonaws.codepipeline#PipelineVersion", - "traits": { - "smithy.api#documentation": "

The version of the pipeline where the action was run.

" - } - }, - "status": { - "target": "com.amazonaws.codepipeline#ActionExecutionStatus", - "traits": { - "smithy.api#documentation": "

The status of the action execution. Status categories are InProgress,\n Succeeded, and Failed.

" - } - }, - "actionName": { - "target": "com.amazonaws.codepipeline#ActionName", + "pipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", "traits": { - "smithy.api#documentation": "

The name of the action.

" + "smithy.api#documentation": "

The pipeline execution ID for the action execution.

" } }, "actionExecutionId": { @@ -575,11 +551,35 @@ "smithy.api#documentation": "

The name of the stage that contains the action.

" } }, + "pipelineVersion": { + "target": "com.amazonaws.codepipeline#PipelineVersion", + "traits": { + "smithy.api#documentation": "

The version of the pipeline where the action was run.

" + } + }, "output": { "target": "com.amazonaws.codepipeline#ActionExecutionOutput", "traits": { "smithy.api#documentation": "

Output details for the action execution, such as the action execution result.

" } + }, + "actionName": { + "target": "com.amazonaws.codepipeline#ActionName", + "traits": { + "smithy.api#documentation": "

The name of the action.

" + } + }, + "lastUpdateTime": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "

The last update time of the action execution.

" + } + }, + "status": { + "target": "com.amazonaws.codepipeline#ActionExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the action execution. Status categories are InProgress,\n Succeeded, and Failed.

" + } } }, "traits": { @@ -618,8 +618,11 @@ "smithy.api#documentation": "

Configuration data for an action execution with all variable references replaced with\n their real values for the execution.

" } }, - "actionTypeId": { - "target": "com.amazonaws.codepipeline#ActionTypeId" + "configuration": { + "target": "com.amazonaws.codepipeline#ActionConfigurationMap", + "traits": { + "smithy.api#documentation": "

Configuration data for an action execution.

" + } }, "roleArn": { "target": "com.amazonaws.codepipeline#RoleArn", @@ -627,17 +630,8 @@ "smithy.api#documentation": "

The ARN of the IAM service role that performs the declared action. This is assumed\n through the roleArn for the pipeline.

" } }, - "region": { - "target": "com.amazonaws.codepipeline#AWSRegionName", - "traits": { - "smithy.api#documentation": "

The AWS Region for the action, such as us-east-1.

" - } - }, - "configuration": { - "target": "com.amazonaws.codepipeline#ActionConfigurationMap", - "traits": { - "smithy.api#documentation": "

Configuration data for an action execution.

" - } + "actionTypeId": { + "target": "com.amazonaws.codepipeline#ActionTypeId" }, "namespace": { "target": "com.amazonaws.codepipeline#ActionNamespace", @@ -645,6 +639,12 @@ "smithy.api#documentation": "

The variable namespace associated with the action. All variables produced as output by\n this action fall under this namespace.

" } }, + "region": { + "target": "com.amazonaws.codepipeline#AWSRegionName", + "traits": { + "smithy.api#documentation": "

The AWS Region for the action, such as us-east-1.

" + } + }, "inputArtifacts": { "target": "com.amazonaws.codepipeline#ArtifactDetailList", "traits": { @@ -685,10 +685,10 @@ "com.amazonaws.codepipeline#ActionExecutionResult": { "type": "structure", "members": { - "externalExecutionSummary": { - "target": "com.amazonaws.codepipeline#ExternalExecutionSummary", + "externalExecutionId": { + "target": "com.amazonaws.codepipeline#ExternalExecutionId", "traits": { - "smithy.api#documentation": "

The action provider's summary for the action execution.

" + "smithy.api#documentation": "

The action provider's external ID for the action execution.

" } }, "externalExecutionUrl": { @@ -697,10 +697,10 @@ "smithy.api#documentation": "

The deepest external link to the external resource (for example, a repository URL or\n deployment endpoint) that is used when running the action.

" } }, - "externalExecutionId": { - "target": "com.amazonaws.codepipeline#ExternalExecutionId", + "externalExecutionSummary": { + "target": "com.amazonaws.codepipeline#ExternalExecutionSummary", "traits": { - "smithy.api#documentation": "

The action provider's external ID for the action execution.

" + "smithy.api#documentation": "

The action provider's summary for the action execution.

" } } }, @@ -801,6 +801,13 @@ "com.amazonaws.codepipeline#ActionRevision": { "type": "structure", "members": { + "created": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the most recent version of the action was created, in\n timestamp format.

", + "smithy.api#required": {} + } + }, "revisionId": { "target": "com.amazonaws.codepipeline#Revision", "traits": { @@ -814,13 +821,6 @@ "smithy.api#documentation": "

The unique identifier of the change that set the state to this revision (for\n example, a deployment ID or timestamp).

", "smithy.api#required": {} } - }, - "created": { - "target": "com.amazonaws.codepipeline#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when the most recent version of the action was created, in\n timestamp format.

", - "smithy.api#required": {} - } } }, "traits": { @@ -846,16 +846,10 @@ "smithy.api#documentation": "

Represents information about the version (or revision) of an action.

" } }, - "actionName": { - "target": "com.amazonaws.codepipeline#ActionName", - "traits": { - "smithy.api#documentation": "

The name of the action.

" - } - }, - "latestExecution": { - "target": "com.amazonaws.codepipeline#ActionExecution", + "entityUrl": { + "target": "com.amazonaws.codepipeline#Url", "traits": { - "smithy.api#documentation": "

Represents information about the run of an action.

" + "smithy.api#documentation": "

A URL link for more information about the state of the action, such as a deployment\n group details page.

" } }, "revisionUrl": { @@ -864,10 +858,16 @@ "smithy.api#documentation": "

A URL link for more information about the revision, such as a commit details\n page.

" } }, - "entityUrl": { - "target": "com.amazonaws.codepipeline#Url", + "actionName": { + "target": "com.amazonaws.codepipeline#ActionName", "traits": { - "smithy.api#documentation": "

A URL link for more information about the state of the action, such as a deployment\n group details page.

" + "smithy.api#documentation": "

The name of the action.

" + } + }, + "latestExecution": { + "target": "com.amazonaws.codepipeline#ActionExecution", + "traits": { + "smithy.api#documentation": "

Represents information about the run of an action.

" } } }, @@ -897,13 +897,6 @@ "smithy.api#required": {} } }, - "outputArtifactDetails": { - "target": "com.amazonaws.codepipeline#ArtifactDetails", - "traits": { - "smithy.api#documentation": "

The details of the output artifact of the action, such as its commit ID.

", - "smithy.api#required": {} - } - }, "inputArtifactDetails": { "target": "com.amazonaws.codepipeline#ArtifactDetails", "traits": { @@ -916,6 +909,13 @@ "traits": { "smithy.api#documentation": "

The configuration properties for the action type.

" } + }, + "outputArtifactDetails": { + "target": "com.amazonaws.codepipeline#ArtifactDetails", + "traits": { + "smithy.api#documentation": "

The details of the output artifact of the action, such as its commit ID.

", + "smithy.api#required": {} + } } }, "traits": { @@ -982,6 +982,12 @@ "com.amazonaws.codepipeline#ActionTypeSettings": { "type": "structure", "members": { + "revisionUrlTemplate": { + "target": "com.amazonaws.codepipeline#UrlTemplate", + "traits": { + "smithy.api#documentation": "

The URL returned to the AWS CodePipeline console that contains a link to the page\n where customers can update or change the configuration of the external action.

" + } + }, "thirdPartyConfigurationUrl": { "target": "com.amazonaws.codepipeline#Url", "traits": { @@ -999,12 +1005,6 @@ "traits": { "smithy.api#documentation": "

The URL returned to the AWS CodePipeline console that contains a link to the\n top-level landing page for the external system, such as the console page for AWS\n CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console\n and provides a link to the execution entity of the external action.

" } - }, - "revisionUrlTemplate": { - "target": "com.amazonaws.codepipeline#UrlTemplate", - "traits": { - "smithy.api#documentation": "

The URL returned to the AWS CodePipeline console that contains a link to the page\n where customers can update or change the configuration of the external action.

" - } } }, "traits": { @@ -1087,17 +1087,17 @@ "smithy.api#documentation": "

The artifact's revision ID. Depending on the type of object, this could be a commit\n ID (GitHub) or a revision ID (Amazon S3).

" } }, - "name": { - "target": "com.amazonaws.codepipeline#ArtifactName", - "traits": { - "smithy.api#documentation": "

The artifact's name.

" - } - }, "location": { "target": "com.amazonaws.codepipeline#ArtifactLocation", "traits": { "smithy.api#documentation": "

The location of an artifact.

" } + }, + "name": { + "target": "com.amazonaws.codepipeline#ArtifactName", + "traits": { + "smithy.api#documentation": "

The artifact's name.

" + } } }, "traits": { @@ -1202,16 +1202,10 @@ "com.amazonaws.codepipeline#ArtifactRevision": { "type": "structure", "members": { - "revisionChangeIdentifier": { - "target": "com.amazonaws.codepipeline#RevisionChangeIdentifier", - "traits": { - "smithy.api#documentation": "

An additional identifier for a revision, such as a commit date or, for artifacts\n stored in Amazon S3 buckets, the ETag value.

" - } - }, - "name": { - "target": "com.amazonaws.codepipeline#ArtifactName", + "revisionUrl": { + "target": "com.amazonaws.codepipeline#Url", "traits": { - "smithy.api#documentation": "

The name of an artifact. This name might be system-generated, such as \"MyApp\", or\n defined by the user when an action is created.

" + "smithy.api#documentation": "

The commit ID for the artifact revision. For artifacts stored in GitHub or AWS\n CodeCommit repositories, the commit ID is linked to a commit details page.

" } }, "revisionId": { @@ -1232,10 +1226,16 @@ "smithy.api#documentation": "

The date and time when the most recent revision of the artifact was created, in\n timestamp format.

" } }, - "revisionUrl": { - "target": "com.amazonaws.codepipeline#Url", + "name": { + "target": "com.amazonaws.codepipeline#ArtifactName", "traits": { - "smithy.api#documentation": "

The commit ID for the artifact revision. For artifacts stored in GitHub or AWS\n CodeCommit repositories, the commit ID is linked to a commit details page.

" + "smithy.api#documentation": "

The name of an artifact. This name might be system-generated, such as \"MyApp\", or\n defined by the user when an action is created.

" + } + }, + "revisionChangeIdentifier": { + "target": "com.amazonaws.codepipeline#RevisionChangeIdentifier", + "traits": { + "smithy.api#documentation": "

An additional identifier for a revision, such as a commit date or, for artifacts\n stored in Amazon S3 buckets, the ETag value.

" } } }, @@ -1252,13 +1252,6 @@ "com.amazonaws.codepipeline#ArtifactStore": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.codepipeline#ArtifactStoreType", - "traits": { - "smithy.api#documentation": "

The type of the artifact store, such as S3.

", - "smithy.api#required": {} - } - }, "encryptionKey": { "target": "com.amazonaws.codepipeline#EncryptionKey", "traits": { @@ -1271,6 +1264,13 @@ "smithy.api#documentation": "

The S3 bucket used for storing the artifacts for a pipeline. You can specify the\n name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline\n artifacts is created for you based on the name of the pipeline. You can use any S3\n bucket in the same AWS Region as the pipeline to store your pipeline\n artifacts.

", "smithy.api#required": {} } + }, + "type": { + "target": "com.amazonaws.codepipeline#ArtifactStoreType", + "traits": { + "smithy.api#documentation": "

The type of the artifact store, such as S3.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1310,15 +1310,15 @@ "com.amazonaws.codepipeline#BlockerDeclaration": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.codepipeline#BlockerName", + "type": { + "target": "com.amazonaws.codepipeline#BlockerType", "traits": { "smithy.api#documentation": "

Reserved for future use.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.codepipeline#BlockerType", + "name": { + "target": "com.amazonaws.codepipeline#BlockerName", "traits": { "smithy.api#documentation": "

Reserved for future use.

", "smithy.api#required": {} @@ -1587,24 +1587,25 @@ "smithy.api#documentation": "

URLs that provide users information about this custom action.

" } }, - "version": { - "target": "com.amazonaws.codepipeline#Version", + "provider": { + "target": "com.amazonaws.codepipeline#ActionProvider", "traits": { - "smithy.api#documentation": "

The version identifier of the custom action.

", + "smithy.api#documentation": "

The provider of the service used in the custom action, such as AWS\n CodeDeploy.

", "smithy.api#required": {} } }, - "provider": { - "target": "com.amazonaws.codepipeline#ActionProvider", + "version": { + "target": "com.amazonaws.codepipeline#Version", "traits": { - "smithy.api#documentation": "

The provider of the service used in the custom action, such as AWS\n CodeDeploy.

", + "smithy.api#documentation": "

The version identifier of the custom action.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.codepipeline#TagList", + "category": { + "target": "com.amazonaws.codepipeline#ActionCategory", "traits": { - "smithy.api#documentation": "

The tags for the custom action.

" + "smithy.api#documentation": "

The category of the custom action, such as a build action or a test\n action.

\n \n

Although Source and Approval are listed as valid\n values, they are not currently functional. These values are reserved for future\n use.

\n ", + "smithy.api#required": {} } }, "configurationProperties": { @@ -1613,11 +1614,10 @@ "smithy.api#documentation": "

The configuration properties for the custom action.

\n \n

You can refer to a name in the configuration properties of the custom action\n within the URL templates by following the format of {Config:name}, as long as the\n configuration property is both required and not secret. For more information, see\n Create a\n Custom Action for a Pipeline.

\n " } }, - "category": { - "target": "com.amazonaws.codepipeline#ActionCategory", + "tags": { + "target": "com.amazonaws.codepipeline#TagList", "traits": { - "smithy.api#documentation": "

The category of the custom action, such as a build action or a test\n action.

\n \n

Although Source and Approval are listed as valid\n values, they are not currently functional. These values are reserved for future\n use.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags for the custom action.

" } } }, @@ -1710,21 +1710,21 @@ "traits": { "smithy.api#documentation": "

Represents the input of a CreatePipeline action.

" } - }, - "com.amazonaws.codepipeline#CreatePipelineOutput": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.codepipeline#TagList", - "traits": { - "smithy.api#documentation": "

Specifies the tags applied to the pipeline.

" - } - }, + }, + "com.amazonaws.codepipeline#CreatePipelineOutput": { + "type": "structure", + "members": { "pipeline": { "target": "com.amazonaws.codepipeline#PipelineDeclaration", "traits": { "smithy.api#documentation": "

Represents the structure of actions and stages to be performed in the pipeline.\n

" } + }, + "tags": { + "target": "com.amazonaws.codepipeline#TagList", + "traits": { + "smithy.api#documentation": "

Specifies the tags applied to the pipeline.

" + } } }, "traits": { @@ -1734,18 +1734,18 @@ "com.amazonaws.codepipeline#CurrentRevision": { "type": "structure", "members": { - "revisionSummary": { - "target": "com.amazonaws.codepipeline#RevisionSummary", - "traits": { - "smithy.api#documentation": "

The summary of the most recent revision of the artifact.

" - } - }, "created": { "target": "com.amazonaws.codepipeline#Time", "traits": { "smithy.api#documentation": "

The date and time when the most recent revision of the artifact was created, in\n timestamp format.

" } }, + "revisionSummary": { + "target": "com.amazonaws.codepipeline#RevisionSummary", + "traits": { + "smithy.api#documentation": "

The summary of the most recent revision of the artifact.

" + } + }, "changeIdentifier": { "target": "com.amazonaws.codepipeline#RevisionChangeIdentifier", "traits": { @@ -1953,6 +1953,13 @@ "smithy.api#required": {} } }, + "reason": { + "target": "com.amazonaws.codepipeline#DisabledReason", + "traits": { + "smithy.api#documentation": "

The reason given to the user that a stage is disabled, such as waiting for manual\n approval or manual tests. This message is displayed in the pipeline console\n UI.

", + "smithy.api#required": {} + } + }, "stageName": { "target": "com.amazonaws.codepipeline#StageName", "traits": { @@ -1966,13 +1973,6 @@ "smithy.api#documentation": "

The name of the pipeline in which you want to disable the flow of artifacts from\n one stage to another.

", "smithy.api#required": {} } - }, - "reason": { - "target": "com.amazonaws.codepipeline#DisabledReason", - "traits": { - "smithy.api#documentation": "

The reason given to the user that a stage is disabled, such as waiting for manual\n approval or manual tests. This message is displayed in the pipeline console\n UI.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2024,17 +2024,17 @@ "com.amazonaws.codepipeline#EnableStageTransitionInput": { "type": "structure", "members": { - "transitionType": { - "target": "com.amazonaws.codepipeline#StageTransitionType", + "pipelineName": { + "target": "com.amazonaws.codepipeline#PipelineName", "traits": { - "smithy.api#documentation": "

Specifies whether artifacts are allowed to enter the stage and be processed by the\n actions in that stage (inbound) or whether already processed artifacts are allowed to\n transition to the next stage (outbound).

", + "smithy.api#documentation": "

The name of the pipeline in which you want to enable the flow of artifacts from one\n stage to another.

", "smithy.api#required": {} } }, - "pipelineName": { - "target": "com.amazonaws.codepipeline#PipelineName", + "transitionType": { + "target": "com.amazonaws.codepipeline#StageTransitionType", "traits": { - "smithy.api#documentation": "

The name of the pipeline in which you want to enable the flow of artifacts from one\n stage to another.

", + "smithy.api#documentation": "

Specifies whether artifacts are allowed to enter the stage and be processed by the\n actions in that stage (inbound) or whether already processed artifacts are allowed to\n transition to the next stage (outbound).

", "smithy.api#required": {} } }, @@ -2188,10 +2188,11 @@ "com.amazonaws.codepipeline#FailureDetails": { "type": "structure", "members": { - "externalExecutionId": { - "target": "com.amazonaws.codepipeline#ExecutionId", + "type": { + "target": "com.amazonaws.codepipeline#FailureType", "traits": { - "smithy.api#documentation": "

The external ID of the run of the action that failed.

" + "smithy.api#documentation": "

The type of the failure.

", + "smithy.api#required": {} } }, "message": { @@ -2201,11 +2202,10 @@ "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.codepipeline#FailureType", + "externalExecutionId": { + "target": "com.amazonaws.codepipeline#ExecutionId", "traits": { - "smithy.api#documentation": "

The type of the failure.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The external ID of the run of the action that failed.

" } } }, @@ -2454,10 +2454,10 @@ "com.amazonaws.codepipeline#GetPipelineStateOutput": { "type": "structure", "members": { - "updated": { - "target": "com.amazonaws.codepipeline#Timestamp", + "pipelineVersion": { + "target": "com.amazonaws.codepipeline#PipelineVersion", "traits": { - "smithy.api#documentation": "

The date and time the pipeline was last updated, in timestamp format.

" + "smithy.api#documentation": "

The version number of the pipeline.

\n \n

A newly created pipeline is always assigned a version number of\n 1.

\n " } }, "stageStates": { @@ -2466,16 +2466,16 @@ "smithy.api#documentation": "

A list of the pipeline stage output information, including stage name, state, most\n recent run details, whether the stage is disabled, and other data.

" } }, - "created": { + "updated": { "target": "com.amazonaws.codepipeline#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time the pipeline was created, in timestamp format.

" + "smithy.api#documentation": "

The date and time the pipeline was last updated, in timestamp format.

" } }, - "pipelineVersion": { - "target": "com.amazonaws.codepipeline#PipelineVersion", + "created": { + "target": "com.amazonaws.codepipeline#Timestamp", "traits": { - "smithy.api#documentation": "

The version number of the pipeline.

\n \n

A newly created pipeline is always assigned a version number of\n 1.

\n " + "smithy.api#documentation": "

The date and time the pipeline was created, in timestamp format.

" } }, "pipelineName": { @@ -2518,17 +2518,17 @@ "com.amazonaws.codepipeline#GetThirdPartyJobDetailsInput": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.codepipeline#ThirdPartyJobId", + "clientToken": { + "target": "com.amazonaws.codepipeline#ClientToken", "traits": { - "smithy.api#documentation": "

The unique system-generated ID used for identifying the job.

", + "smithy.api#documentation": "

The clientToken portion of the clientId and clientToken pair used to verify that\n the calling entity is allowed access to the job and its details.

", "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.codepipeline#ClientToken", + "jobId": { + "target": "com.amazonaws.codepipeline#ThirdPartyJobId", "traits": { - "smithy.api#documentation": "

The clientToken portion of the clientId and clientToken pair used to verify that\n the calling entity is allowed access to the job and its details.

", + "smithy.api#documentation": "

The unique system-generated ID used for identifying the job.

", "smithy.api#required": {} } } @@ -2779,12 +2779,6 @@ "com.amazonaws.codepipeline#Job": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.codepipeline#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the AWS account to use when performing the job.

" - } - }, "nonce": { "target": "com.amazonaws.codepipeline#Nonce", "traits": { @@ -2797,6 +2791,12 @@ "smithy.api#documentation": "

The unique system-generated ID of the job.

" } }, + "accountId": { + "target": "com.amazonaws.codepipeline#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the AWS account to use when performing the job.

" + } + }, "data": { "target": "com.amazonaws.codepipeline#JobData", "traits": { @@ -2811,34 +2811,34 @@ "com.amazonaws.codepipeline#JobData": { "type": "structure", "members": { - "pipelineContext": { - "target": "com.amazonaws.codepipeline#PipelineContext", + "encryptionKey": { + "target": "com.amazonaws.codepipeline#EncryptionKey", "traits": { - "smithy.api#documentation": "

Represents information about a pipeline to a job worker.

\n \n

Includes pipelineArn and pipelineExecutionId for\n custom jobs.

\n " + "smithy.api#documentation": "

Represents information about the key used to encrypt data in the artifact store,\n such as an AWS Key Management Service (AWS KMS) key.

" } }, - "artifactCredentials": { - "target": "com.amazonaws.codepipeline#AWSSessionCredentials", + "actionConfiguration": { + "target": "com.amazonaws.codepipeline#ActionConfiguration", "traits": { - "smithy.api#documentation": "

Represents an AWS session credentials object. These credentials are temporary\n credentials that are issued by AWS Secure Token Service (STS). They can be used to\n access input and output artifacts in the S3 bucket used to store artifacts for the\n pipeline in AWS CodePipeline.

" + "smithy.api#documentation": "

Represents information about an action configuration.

" } }, - "continuationToken": { - "target": "com.amazonaws.codepipeline#ContinuationToken", + "pipelineContext": { + "target": "com.amazonaws.codepipeline#PipelineContext", "traits": { - "smithy.api#documentation": "

A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job\n to continue the job asynchronously.

" + "smithy.api#documentation": "

Represents information about a pipeline to a job worker.

\n \n

Includes pipelineArn and pipelineExecutionId for\n custom jobs.

\n " } }, - "encryptionKey": { - "target": "com.amazonaws.codepipeline#EncryptionKey", + "outputArtifacts": { + "target": "com.amazonaws.codepipeline#ArtifactList", "traits": { - "smithy.api#documentation": "

Represents information about the key used to encrypt data in the artifact store,\n such as an AWS Key Management Service (AWS KMS) key.

" + "smithy.api#documentation": "

The output of the job.

" } }, - "actionConfiguration": { - "target": "com.amazonaws.codepipeline#ActionConfiguration", + "inputArtifacts": { + "target": "com.amazonaws.codepipeline#ArtifactList", "traits": { - "smithy.api#documentation": "

Represents information about an action configuration.

" + "smithy.api#documentation": "

The artifact supplied to the job.

" } }, "actionTypeId": { @@ -2847,16 +2847,16 @@ "smithy.api#documentation": "

Represents information about an action type.

" } }, - "inputArtifacts": { - "target": "com.amazonaws.codepipeline#ArtifactList", + "continuationToken": { + "target": "com.amazonaws.codepipeline#ContinuationToken", "traits": { - "smithy.api#documentation": "

The artifact supplied to the job.

" + "smithy.api#documentation": "

A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job\n to continue the job asynchronously.

" } }, - "outputArtifacts": { - "target": "com.amazonaws.codepipeline#ArtifactList", + "artifactCredentials": { + "target": "com.amazonaws.codepipeline#AWSSessionCredentials", "traits": { - "smithy.api#documentation": "

The output of the job.

" + "smithy.api#documentation": "

Represents an AWS session credentials object. These credentials are temporary\n credentials that are issued by AWS Secure Token Service (STS). They can be used to\n access input and output artifacts in the S3 bucket used to store artifacts for the\n pipeline in AWS CodePipeline.

" } } }, @@ -2873,17 +2873,17 @@ "smithy.api#documentation": "

Represents other information about a job required for a job worker to complete the\n job.

" } }, - "id": { - "target": "com.amazonaws.codepipeline#JobId", - "traits": { - "smithy.api#documentation": "

The unique system-generated ID of the job.

" - } - }, "accountId": { "target": "com.amazonaws.codepipeline#AccountId", "traits": { "smithy.api#documentation": "

The AWS account ID associated with the job.

" } + }, + "id": { + "target": "com.amazonaws.codepipeline#JobId", + "traits": { + "smithy.api#documentation": "

The unique system-generated ID of the job.

" + } } }, "traits": { @@ -3019,30 +3019,30 @@ "com.amazonaws.codepipeline#ListActionExecutionsInput": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.codepipeline#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. Action execution history\n is retained for up to 12 months, based on action execution start times. Default value is\n 100.

\n \n

Detailed execution history is available for executions run on or after February\n 21, 2019.

\n " - } - }, "filter": { "target": "com.amazonaws.codepipeline#ActionExecutionFilter", "traits": { "smithy.api#documentation": "

Input information used to filter action execution history.

" } }, + "nextToken": { + "target": "com.amazonaws.codepipeline#NextToken", + "traits": { + "smithy.api#documentation": "

The token that was returned from the previous ListActionExecutions call,\n which can be used to return the next set of action executions in the list.

" + } + }, + "maxResults": { + "target": "com.amazonaws.codepipeline#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. Action execution history\n is retained for up to 12 months, based on action execution start times. Default value is\n 100.

\n \n

Detailed execution history is available for executions run on or after February\n 21, 2019.

\n " + } + }, "pipelineName": { "target": "com.amazonaws.codepipeline#PipelineName", "traits": { "smithy.api#documentation": "

The name of the pipeline for which you want to list action execution history.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.codepipeline#NextToken", - "traits": { - "smithy.api#documentation": "

The token that was returned from the previous ListActionExecutions call,\n which can be used to return the next set of action executions in the list.

" - } } } }, @@ -3110,18 +3110,18 @@ "com.amazonaws.codepipeline#ListActionTypesOutput": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.codepipeline#NextToken", + "traits": { + "smithy.api#documentation": "

If the amount of returned information is significantly large, an identifier is also\n returned. It can be used in a subsequent list action types call to return the next set\n of action types in the list.

" + } + }, "actionTypes": { "target": "com.amazonaws.codepipeline#ActionTypeList", "traits": { "smithy.api#documentation": "

Provides details of the action types.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.codepipeline#NextToken", - "traits": { - "smithy.api#documentation": "

If the amount of returned information is significantly large, an identifier is also\n returned. It can be used in a subsequent list action types call to return the next set\n of action types in the list.

" - } } }, "traits": { @@ -3159,6 +3159,12 @@ "com.amazonaws.codepipeline#ListPipelineExecutionsInput": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.codepipeline#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. Pipeline history is\n limited to the most recent 12 months, based on pipeline execution start times. Default\n value is 100.

" + } + }, "pipelineName": { "target": "com.amazonaws.codepipeline#PipelineName", "traits": { @@ -3166,12 +3172,6 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.codepipeline#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. Pipeline history is\n limited to the most recent 12 months, based on pipeline execution start times. Default\n value is 100.

" - } - }, "nextToken": { "target": "com.amazonaws.codepipeline#NextToken", "traits": { @@ -3186,17 +3186,17 @@ "com.amazonaws.codepipeline#ListPipelineExecutionsOutput": { "type": "structure", "members": { - "pipelineExecutionSummaries": { - "target": "com.amazonaws.codepipeline#PipelineExecutionSummaryList", - "traits": { - "smithy.api#documentation": "

A list of executions in the history of a pipeline.

" - } - }, "nextToken": { "target": "com.amazonaws.codepipeline#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used in the next ListPipelineExecutions call. To\n view all items in the list, continue to call this operation with each subsequent token\n until no more nextToken values are returned.

" } + }, + "pipelineExecutionSummaries": { + "target": "com.amazonaws.codepipeline#PipelineExecutionSummaryList", + "traits": { + "smithy.api#documentation": "

A list of executions in the history of a pipeline.

" + } } }, "traits": { @@ -3295,10 +3295,11 @@ "com.amazonaws.codepipeline#ListTagsForResourceInput": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.codepipeline#MaxResults", + "resourceArn": { + "target": "com.amazonaws.codepipeline#ResourceArn", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to get tags for.

", + "smithy.api#required": {} } }, "nextToken": { @@ -3307,11 +3308,10 @@ "smithy.api#documentation": "

The token that was returned from the previous API call, which would be used to return\n the next page of the list. The ListTagsforResource call lists all available tags in one\n call and does not use pagination.

" } }, - "resourceArn": { - "target": "com.amazonaws.codepipeline#ResourceArn", + "maxResults": { + "target": "com.amazonaws.codepipeline#MaxResults", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to get tags for.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" } } } @@ -3319,29 +3319,23 @@ "com.amazonaws.codepipeline#ListTagsForResourceOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codepipeline#NextToken", - "traits": { - "smithy.api#documentation": "

If the amount of returned information is significantly large, an identifier is also\n returned and can be used in a subsequent API call to return the next page of the list.\n The ListTagsforResource call lists all available tags in one call and does not use\n pagination.

" - } - }, "tags": { "target": "com.amazonaws.codepipeline#TagList", "traits": { "smithy.api#documentation": "

The tags for the resource.

" } + }, + "nextToken": { + "target": "com.amazonaws.codepipeline#NextToken", + "traits": { + "smithy.api#documentation": "

If the amount of returned information is significantly large, an identifier is also\n returned and can be used in a subsequent API call to return the next page of the list.\n The ListTagsforResource call lists all available tags in one call and does not use\n pagination.

" + } } } }, "com.amazonaws.codepipeline#ListWebhookItem": { "type": "structure", "members": { - "lastTriggered": { - "target": "com.amazonaws.codepipeline#WebhookLastTriggered", - "traits": { - "smithy.api#documentation": "

The date and time a webhook was last successfully triggered, in timestamp\n format.

" - } - }, "url": { "target": "com.amazonaws.codepipeline#WebhookUrl", "traits": { @@ -3349,10 +3343,16 @@ "smithy.api#required": {} } }, - "errorMessage": { - "target": "com.amazonaws.codepipeline#WebhookErrorMessage", + "arn": { + "target": "com.amazonaws.codepipeline#WebhookArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the webhook.

" + } + }, + "lastTriggered": { + "target": "com.amazonaws.codepipeline#WebhookLastTriggered", "traits": { - "smithy.api#documentation": "

The text of the error message about the webhook.

" + "smithy.api#documentation": "

The date and time a webhook was last successfully triggered, in timestamp\n format.

" } }, "errorCode": { @@ -3361,16 +3361,16 @@ "smithy.api#documentation": "

The number code of the error.

" } }, - "tags": { - "target": "com.amazonaws.codepipeline#TagList", + "errorMessage": { + "target": "com.amazonaws.codepipeline#WebhookErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the tags applied to the webhook.

" + "smithy.api#documentation": "

The text of the error message about the webhook.

" } }, - "arn": { - "target": "com.amazonaws.codepipeline#WebhookArn", + "tags": { + "target": "com.amazonaws.codepipeline#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the webhook.

" + "smithy.api#documentation": "

Specifies the tags applied to the webhook.

" } }, "definition": { @@ -3413,34 +3413,34 @@ "com.amazonaws.codepipeline#ListWebhooksInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.codepipeline#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" - } - }, "NextToken": { "target": "com.amazonaws.codepipeline#NextToken", "traits": { "smithy.api#documentation": "

The token that was returned from the previous ListWebhooks call, which can be used\n to return the next set of webhooks in the list.

" } + }, + "MaxResults": { + "target": "com.amazonaws.codepipeline#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" + } } } }, "com.amazonaws.codepipeline#ListWebhooksOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.codepipeline#NextToken", - "traits": { - "smithy.api#documentation": "

If the amount of returned information is significantly large, an identifier is also\n returned and can be used in a subsequent ListWebhooks call to return the next set of\n webhooks in the list.

" - } - }, "webhooks": { "target": "com.amazonaws.codepipeline#WebhookList", "traits": { "smithy.api#documentation": "

The JSON detail returned for each webhook in the list output for the ListWebhooks\n call.

" } + }, + "NextToken": { + "target": "com.amazonaws.codepipeline#NextToken", + "traits": { + "smithy.api#documentation": "

If the amount of returned information is significantly large, an identifier is also\n returned and can be used in a subsequent ListWebhooks call to return the next set of\n webhooks in the list.

" + } } } }, @@ -3602,34 +3602,34 @@ "com.amazonaws.codepipeline#PipelineContext": { "type": "structure", "members": { - "action": { - "target": "com.amazonaws.codepipeline#ActionContext", + "stage": { + "target": "com.amazonaws.codepipeline#StageContext", "traits": { - "smithy.api#documentation": "

The context of an action to a job worker in the stage of a pipeline.

" + "smithy.api#documentation": "

The stage of the pipeline.

" } }, - "pipelineArn": { - "target": "com.amazonaws.codepipeline#PipelineArn", + "pipelineName": { + "target": "com.amazonaws.codepipeline#PipelineName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline.

" + "smithy.api#documentation": "

The name of the pipeline. This is a user-specified value. Pipeline names must be\n unique across all pipeline names under an Amazon Web Services account.

" } }, - "pipelineExecutionId": { - "target": "com.amazonaws.codepipeline#PipelineExecutionId", + "pipelineArn": { + "target": "com.amazonaws.codepipeline#PipelineArn", "traits": { - "smithy.api#documentation": "

The execution ID of the pipeline.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline.

" } }, - "pipelineName": { - "target": "com.amazonaws.codepipeline#PipelineName", + "action": { + "target": "com.amazonaws.codepipeline#ActionContext", "traits": { - "smithy.api#documentation": "

The name of the pipeline. This is a user-specified value. Pipeline names must be\n unique across all pipeline names under an Amazon Web Services account.

" + "smithy.api#documentation": "

The context of an action to a job worker in the stage of a pipeline.

" } }, - "stage": { - "target": "com.amazonaws.codepipeline#StageContext", + "pipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", "traits": { - "smithy.api#documentation": "

The stage of the pipeline.

" + "smithy.api#documentation": "

The execution ID of the pipeline.

" } } }, @@ -3640,6 +3640,13 @@ "com.amazonaws.codepipeline#PipelineDeclaration": { "type": "structure", "members": { + "stages": { + "target": "com.amazonaws.codepipeline#PipelineStageDeclarationList", + "traits": { + "smithy.api#documentation": "

The stage in which to perform the action.

", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.codepipeline#PipelineName", "traits": { @@ -3653,31 +3660,24 @@ "smithy.api#documentation": "

A mapping of artifactStore objects and their corresponding AWS\n Regions. There must be an artifact store for the pipeline Region and for each\n cross-region action in the pipeline.

\n \n

You must include either artifactStore or\n artifactStores in your pipeline, but you cannot use both. If you\n create a cross-region action in your pipeline, you must use\n artifactStores.

\n " } }, - "stages": { - "target": "com.amazonaws.codepipeline#PipelineStageDeclarationList", - "traits": { - "smithy.api#documentation": "

The stage in which to perform the action.

", - "smithy.api#required": {} - } - }, "version": { "target": "com.amazonaws.codepipeline#PipelineVersion", "traits": { "smithy.api#documentation": "

The version number of the pipeline. A new pipeline always has a version number of\n 1. This number is incremented when a pipeline is updated.

" } }, + "artifactStore": { + "target": "com.amazonaws.codepipeline#ArtifactStore", + "traits": { + "smithy.api#documentation": "

Represents information about the S3 bucket where artifacts are stored for the\n pipeline.

\n \n

You must include either artifactStore or\n artifactStores in your pipeline, but you cannot use both. If you\n create a cross-region action in your pipeline, you must use\n artifactStores.

\n " + } + }, "roleArn": { "target": "com.amazonaws.codepipeline#RoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform\n actions with no actionRoleArn, or to use to assume roles for actions with\n an actionRoleArn.

", "smithy.api#required": {} } - }, - "artifactStore": { - "target": "com.amazonaws.codepipeline#ArtifactStore", - "traits": { - "smithy.api#documentation": "

Represents information about the S3 bucket where artifacts are stored for the\n pipeline.

\n \n

You must include either artifactStore or\n artifactStores in your pipeline, but you cannot use both. If you\n create a cross-region action in your pipeline, you must use\n artifactStores.

\n " - } } }, "traits": { @@ -3687,30 +3687,30 @@ "com.amazonaws.codepipeline#PipelineExecution": { "type": "structure", "members": { - "pipelineVersion": { - "target": "com.amazonaws.codepipeline#PipelineVersion", - "traits": { - "smithy.api#documentation": "

The version number of the pipeline with the specified pipeline execution.

" - } - }, "pipelineName": { "target": "com.amazonaws.codepipeline#PipelineName", "traits": { "smithy.api#documentation": "

The name of the pipeline with the specified pipeline execution.

" } }, - "status": { - "target": "com.amazonaws.codepipeline#PipelineExecutionStatus", - "traits": { - "smithy.api#documentation": "

The status of the pipeline execution.

\n " - } - }, "artifactRevisions": { "target": "com.amazonaws.codepipeline#ArtifactRevisionList", "traits": { "smithy.api#documentation": "

A list of ArtifactRevision objects included in a pipeline\n execution.

" } }, + "pipelineVersion": { + "target": "com.amazonaws.codepipeline#PipelineVersion", + "traits": { + "smithy.api#documentation": "

The version number of the pipeline with the specified pipeline execution.

" + } + }, + "status": { + "target": "com.amazonaws.codepipeline#PipelineExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the pipeline execution.

\n " + } + }, "pipelineExecutionId": { "target": "com.amazonaws.codepipeline#PipelineExecutionId", "traits": { @@ -3789,40 +3789,40 @@ "com.amazonaws.codepipeline#PipelineExecutionSummary": { "type": "structure", "members": { - "trigger": { - "target": "com.amazonaws.codepipeline#ExecutionTrigger", + "pipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", "traits": { - "smithy.api#documentation": "

The interaction or event that started a pipeline execution, such as automated change\n detection or a StartPipelineExecution API call.

" + "smithy.api#documentation": "

The ID of the pipeline execution.

" } }, - "startTime": { - "target": "com.amazonaws.codepipeline#Timestamp", + "stopTrigger": { + "target": "com.amazonaws.codepipeline#StopExecutionTrigger", "traits": { - "smithy.api#documentation": "

The date and time when the pipeline execution began, in timestamp format.

" + "smithy.api#documentation": "

The interaction that stopped a pipeline execution.

" } }, - "lastUpdateTime": { + "startTime": { "target": "com.amazonaws.codepipeline#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time of the last change to the pipeline execution, in timestamp\n format.

" + "smithy.api#documentation": "

The date and time when the pipeline execution began, in timestamp format.

" } }, - "pipelineExecutionId": { - "target": "com.amazonaws.codepipeline#PipelineExecutionId", + "sourceRevisions": { + "target": "com.amazonaws.codepipeline#SourceRevisionList", "traits": { - "smithy.api#documentation": "

The ID of the pipeline execution.

" + "smithy.api#documentation": "

A list of the source artifact revisions that initiated a pipeline\n execution.

" } }, - "stopTrigger": { - "target": "com.amazonaws.codepipeline#StopExecutionTrigger", + "trigger": { + "target": "com.amazonaws.codepipeline#ExecutionTrigger", "traits": { - "smithy.api#documentation": "

The interaction that stopped a pipeline execution.

" + "smithy.api#documentation": "

The interaction or event that started a pipeline execution, such as automated change\n detection or a StartPipelineExecution API call.

" } }, - "sourceRevisions": { - "target": "com.amazonaws.codepipeline#SourceRevisionList", + "lastUpdateTime": { + "target": "com.amazonaws.codepipeline#Timestamp", "traits": { - "smithy.api#documentation": "

A list of the source artifact revisions that initiated a pipeline\n execution.

" + "smithy.api#documentation": "

The date and time of the last change to the pipeline execution, in timestamp\n format.

" } }, "status": { @@ -3851,6 +3851,12 @@ "com.amazonaws.codepipeline#PipelineMetadata": { "type": "structure", "members": { + "created": { + "target": "com.amazonaws.codepipeline#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the pipeline was created, in timestamp format.

" + } + }, "pipelineArn": { "target": "com.amazonaws.codepipeline#PipelineArn", "traits": { @@ -3862,12 +3868,6 @@ "traits": { "smithy.api#documentation": "

The date and time the pipeline was last updated, in timestamp format.

" } - }, - "created": { - "target": "com.amazonaws.codepipeline#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time the pipeline was created, in timestamp format.

" - } } }, "traits": { @@ -3929,18 +3929,18 @@ "smithy.api#documentation": "

The date and time of the last update to the pipeline, in timestamp\n format.

" } }, - "name": { - "target": "com.amazonaws.codepipeline#PipelineName", - "traits": { - "smithy.api#documentation": "

The name of the pipeline.

" - } - }, "version": { "target": "com.amazonaws.codepipeline#PipelineVersion", "traits": { "smithy.api#documentation": "

The version number of the pipeline.

" } }, + "name": { + "target": "com.amazonaws.codepipeline#PipelineName", + "traits": { + "smithy.api#documentation": "

The name of the pipeline.

" + } + }, "created": { "target": "com.amazonaws.codepipeline#Timestamp", "traits": { @@ -3999,18 +3999,18 @@ "com.amazonaws.codepipeline#PollForJobsInput": { "type": "structure", "members": { - "queryParam": { - "target": "com.amazonaws.codepipeline#QueryParamMap", - "traits": { - "smithy.api#documentation": "

A map of property names and values. For an action type with no queryable\n properties, this value must be null or an empty map. For an action type with a queryable\n property, you must supply that property as a key in the map. Only jobs whose action\n configuration matches the mapped value are returned.

" - } - }, "maxBatchSize": { "target": "com.amazonaws.codepipeline#MaxBatchSize", "traits": { "smithy.api#documentation": "

The maximum number of jobs to return in a poll for jobs call.

" } }, + "queryParam": { + "target": "com.amazonaws.codepipeline#QueryParamMap", + "traits": { + "smithy.api#documentation": "

A map of property names and values. For an action type with no queryable\n properties, this value must be null or an empty map. For an action type with a queryable\n property, you must supply that property as a key in the map. Only jobs whose action\n configuration matches the mapped value are returned.

" + } + }, "actionTypeId": { "target": "com.amazonaws.codepipeline#ActionTypeId", "traits": { @@ -4135,17 +4135,17 @@ "smithy.api#required": {} } }, - "actionName": { - "target": "com.amazonaws.codepipeline#ActionName", + "actionRevision": { + "target": "com.amazonaws.codepipeline#ActionRevision", "traits": { - "smithy.api#documentation": "

The name of the action that processes the revision.

", + "smithy.api#documentation": "

Represents information about the version (or revision) of an action.

", "smithy.api#required": {} } }, - "actionRevision": { - "target": "com.amazonaws.codepipeline#ActionRevision", + "actionName": { + "target": "com.amazonaws.codepipeline#ActionName", "traits": { - "smithy.api#documentation": "

Represents information about the version (or revision) of an action.

", + "smithy.api#documentation": "

The name of the action that processes the revision.

", "smithy.api#required": {} } } @@ -4157,17 +4157,17 @@ "com.amazonaws.codepipeline#PutActionRevisionOutput": { "type": "structure", "members": { - "newRevision": { - "target": "com.amazonaws.codepipeline#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the artifact revision was previously used in an execution of the\n specified pipeline.

" - } - }, "pipelineExecutionId": { "target": "com.amazonaws.codepipeline#PipelineExecutionId", "traits": { "smithy.api#documentation": "

The ID of the current workflow state of the pipeline.

" } + }, + "newRevision": { + "target": "com.amazonaws.codepipeline#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the artifact revision was previously used in an execution of the\n specified pipeline.

" + } } }, "traits": { @@ -4223,6 +4223,13 @@ "smithy.api#required": {} } }, + "stageName": { + "target": "com.amazonaws.codepipeline#StageName", + "traits": { + "smithy.api#documentation": "

The name of the stage that contains the action.

", + "smithy.api#required": {} + } + }, "actionName": { "target": "com.amazonaws.codepipeline#ActionName", "traits": { @@ -4236,13 +4243,6 @@ "smithy.api#documentation": "

The system-generated token used to identify a unique approval request. The token\n for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval\n request corresponding to this token is still valid.

", "smithy.api#required": {} } - }, - "stageName": { - "target": "com.amazonaws.codepipeline#StageName", - "traits": { - "smithy.api#documentation": "

The name of the stage that contains the action.

", - "smithy.api#required": {} - } } }, "traits": { @@ -4286,17 +4286,17 @@ "com.amazonaws.codepipeline#PutJobFailureResultInput": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.codepipeline#JobId", + "failureDetails": { + "target": "com.amazonaws.codepipeline#FailureDetails", "traits": { - "smithy.api#documentation": "

The unique system-generated ID of the job that failed. This is the same ID returned\n from PollForJobs.

", + "smithy.api#documentation": "

The details about the failure of a job.

", "smithy.api#required": {} } }, - "failureDetails": { - "target": "com.amazonaws.codepipeline#FailureDetails", + "jobId": { + "target": "com.amazonaws.codepipeline#JobId", "traits": { - "smithy.api#documentation": "

The details about the failure of a job.

", + "smithy.api#documentation": "

The unique system-generated ID of the job that failed. This is the same ID returned\n from PollForJobs.

", "smithy.api#required": {} } } @@ -4331,29 +4331,23 @@ "com.amazonaws.codepipeline#PutJobSuccessResultInput": { "type": "structure", "members": { - "outputVariables": { - "target": "com.amazonaws.codepipeline#OutputVariablesMap", - "traits": { - "smithy.api#documentation": "

Key-value pairs produced as output by a job worker that can be made available to a\n downstream action configuration. outputVariables can be included only when\n there is no continuation token on the request.

" - } - }, - "currentRevision": { - "target": "com.amazonaws.codepipeline#CurrentRevision", + "jobId": { + "target": "com.amazonaws.codepipeline#JobId", "traits": { - "smithy.api#documentation": "

The ID of the current revision of the artifact successfully worked on by the\n job.

" + "smithy.api#documentation": "

The unique system-generated ID of the job that succeeded. This is the same ID\n returned from PollForJobs.

", + "smithy.api#required": {} } }, - "executionDetails": { - "target": "com.amazonaws.codepipeline#ExecutionDetails", + "outputVariables": { + "target": "com.amazonaws.codepipeline#OutputVariablesMap", "traits": { - "smithy.api#documentation": "

The execution details of the successful job, such as the actions taken by the job\n worker.

" + "smithy.api#documentation": "

Key-value pairs produced as output by a job worker that can be made available to a\n downstream action configuration. outputVariables can be included only when\n there is no continuation token on the request.

" } }, - "jobId": { - "target": "com.amazonaws.codepipeline#JobId", + "currentRevision": { + "target": "com.amazonaws.codepipeline#CurrentRevision", "traits": { - "smithy.api#documentation": "

The unique system-generated ID of the job that succeeded. This is the same ID\n returned from PollForJobs.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the current revision of the artifact successfully worked on by the\n job.

" } }, "continuationToken": { @@ -4361,6 +4355,12 @@ "traits": { "smithy.api#documentation": "

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a\n successful job provides to identify a custom action in progress. Future jobs use this\n token to identify the running instance of the action. It can be reused to return more\n information about the progress of the custom action. When the action is complete, no\n continuation token should be supplied.

" } + }, + "executionDetails": { + "target": "com.amazonaws.codepipeline#ExecutionDetails", + "traits": { + "smithy.api#documentation": "

The execution details of the successful job, such as the actions taken by the job\n worker.

" + } } }, "traits": { @@ -4393,17 +4393,17 @@ "com.amazonaws.codepipeline#PutThirdPartyJobFailureResultInput": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.codepipeline#ClientToken", + "jobId": { + "target": "com.amazonaws.codepipeline#ThirdPartyJobId", "traits": { - "smithy.api#documentation": "

The clientToken portion of the clientId and clientToken pair used to verify that\n the calling entity is allowed access to the job and its details.

", + "smithy.api#documentation": "

The ID of the job that failed. This is the same ID returned from\n PollForThirdPartyJobs.

", "smithy.api#required": {} } }, - "jobId": { - "target": "com.amazonaws.codepipeline#ThirdPartyJobId", + "clientToken": { + "target": "com.amazonaws.codepipeline#ClientToken", "traits": { - "smithy.api#documentation": "

The ID of the job that failed. This is the same ID returned from\n PollForThirdPartyJobs.

", + "smithy.api#documentation": "

The clientToken portion of the clientId and clientToken pair used to verify that\n the calling entity is allowed access to the job and its details.

", "smithy.api#required": {} } }, @@ -4445,23 +4445,22 @@ "com.amazonaws.codepipeline#PutThirdPartyJobSuccessResultInput": { "type": "structure", "members": { - "currentRevision": { - "target": "com.amazonaws.codepipeline#CurrentRevision", + "executionDetails": { + "target": "com.amazonaws.codepipeline#ExecutionDetails", "traits": { - "smithy.api#documentation": "

Represents information about a current revision.

" + "smithy.api#documentation": "

The details of the actions taken and results produced on an artifact as it passes\n through stages in the pipeline.

" } }, - "jobId": { - "target": "com.amazonaws.codepipeline#ThirdPartyJobId", + "currentRevision": { + "target": "com.amazonaws.codepipeline#CurrentRevision", "traits": { - "smithy.api#documentation": "

The ID of the job that successfully completed. This is the same ID returned from\n PollForThirdPartyJobs.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Represents information about a current revision.

" } }, - "executionDetails": { - "target": "com.amazonaws.codepipeline#ExecutionDetails", + "continuationToken": { + "target": "com.amazonaws.codepipeline#ContinuationToken", "traits": { - "smithy.api#documentation": "

The details of the actions taken and results produced on an artifact as it passes\n through stages in the pipeline.

" + "smithy.api#documentation": "

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a\n successful job provides to identify a partner action in progress. Future jobs use this\n token to identify the running instance of the action. It can be reused to return more\n information about the progress of the partner action. When the action is complete, no\n continuation token should be supplied.

" } }, "clientToken": { @@ -4471,10 +4470,11 @@ "smithy.api#required": {} } }, - "continuationToken": { - "target": "com.amazonaws.codepipeline#ContinuationToken", + "jobId": { + "target": "com.amazonaws.codepipeline#ThirdPartyJobId", "traits": { - "smithy.api#documentation": "

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a\n successful job provides to identify a partner action in progress. Future jobs use this\n token to identify the running instance of the action. It can be reused to return more\n information about the progress of the partner action. When the action is complete, no\n continuation token should be supplied.

" + "smithy.api#documentation": "

The ID of the job that successfully completed. This is the same ID returned from\n PollForThirdPartyJobs.

", + "smithy.api#required": {} } } }, @@ -4661,10 +4661,10 @@ "com.amazonaws.codepipeline#RetryStageExecutionInput": { "type": "structure", "members": { - "pipelineExecutionId": { - "target": "com.amazonaws.codepipeline#PipelineExecutionId", + "pipelineName": { + "target": "com.amazonaws.codepipeline#PipelineName", "traits": { - "smithy.api#documentation": "

The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of\n the failed stage

", + "smithy.api#documentation": "

The name of the pipeline that contains the failed stage.

", "smithy.api#required": {} } }, @@ -4682,10 +4682,10 @@ "smithy.api#required": {} } }, - "pipelineName": { - "target": "com.amazonaws.codepipeline#PipelineName", + "pipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", "traits": { - "smithy.api#documentation": "

The name of the pipeline that contains the failed stage.

", + "smithy.api#documentation": "

The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of\n the failed stage

", "smithy.api#required": {} } } @@ -4748,17 +4748,17 @@ "com.amazonaws.codepipeline#S3ArtifactLocation": { "type": "structure", "members": { - "objectKey": { - "target": "com.amazonaws.codepipeline#S3ObjectKey", + "bucketName": { + "target": "com.amazonaws.codepipeline#S3BucketName", "traits": { - "smithy.api#documentation": "

The key of the object in the S3 bucket, which uniquely identifies the object in the\n bucket.

", + "smithy.api#documentation": "

The name of the S3 bucket.

", "smithy.api#required": {} } }, - "bucketName": { - "target": "com.amazonaws.codepipeline#S3BucketName", + "objectKey": { + "target": "com.amazonaws.codepipeline#S3ObjectKey", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#documentation": "

The key of the object in the S3 bucket, which uniquely identifies the object in the\n bucket.

", "smithy.api#required": {} } } @@ -4820,22 +4820,16 @@ "com.amazonaws.codepipeline#SourceRevision": { "type": "structure", "members": { - "revisionSummary": { - "target": "com.amazonaws.codepipeline#RevisionSummary", - "traits": { - "smithy.api#documentation": "

Summary information about the most recent revision of the artifact. For GitHub and\n AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the\n user-provided content of a codepipeline-artifact-revision-summary key\n specified in the object metadata.

" - } - }, "revisionUrl": { "target": "com.amazonaws.codepipeline#Url", "traits": { "smithy.api#documentation": "

The commit ID for the artifact revision. For artifacts stored in GitHub or AWS\n CodeCommit repositories, the commit ID is linked to a commit details page.

" } }, - "revisionId": { - "target": "com.amazonaws.codepipeline#Revision", + "revisionSummary": { + "target": "com.amazonaws.codepipeline#RevisionSummary", "traits": { - "smithy.api#documentation": "

The system-generated unique ID that identifies the revision number of the\n artifact.

" + "smithy.api#documentation": "

Summary information about the most recent revision of the artifact. For GitHub and\n AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the\n user-provided content of a codepipeline-artifact-revision-summary key\n specified in the object metadata.

" } }, "actionName": { @@ -4844,6 +4838,12 @@ "smithy.api#documentation": "

The name of the action that processed the revision to the source\n artifact.

", "smithy.api#required": {} } + }, + "revisionId": { + "target": "com.amazonaws.codepipeline#Revision", + "traits": { + "smithy.api#documentation": "

The system-generated unique ID that identifies the revision number of the\n artifact.

" + } } }, "traits": { @@ -4885,6 +4885,13 @@ "com.amazonaws.codepipeline#StageDeclaration": { "type": "structure", "members": { + "actions": { + "target": "com.amazonaws.codepipeline#StageActionDeclarationList", + "traits": { + "smithy.api#documentation": "

The actions included in a stage.

", + "smithy.api#required": {} + } + }, "blockers": { "target": "com.amazonaws.codepipeline#StageBlockerDeclarationList", "traits": { @@ -4897,13 +4904,6 @@ "smithy.api#documentation": "

The name of the stage.

", "smithy.api#required": {} } - }, - "actions": { - "target": "com.amazonaws.codepipeline#StageActionDeclarationList", - "traits": { - "smithy.api#documentation": "

The actions included in a stage.

", - "smithy.api#required": {} - } } }, "traits": { @@ -5019,18 +5019,18 @@ "smithy.api#documentation": "

The state of the stage.

" } }, - "stageName": { - "target": "com.amazonaws.codepipeline#StageName", - "traits": { - "smithy.api#documentation": "

The name of the stage.

" - } - }, "inboundTransitionState": { "target": "com.amazonaws.codepipeline#TransitionState", "traits": { "smithy.api#documentation": "

The state of the inbound transition, which is either enabled or disabled.

" } }, + "stageName": { + "target": "com.amazonaws.codepipeline#StageName", + "traits": { + "smithy.api#documentation": "

The name of the stage.

" + } + }, "latestExecution": { "target": "com.amazonaws.codepipeline#StageExecution", "traits": { @@ -5086,19 +5086,19 @@ "com.amazonaws.codepipeline#StartPipelineExecutionInput": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.codepipeline#PipelineName", - "traits": { - "smithy.api#documentation": "

The name of the pipeline to start.

", - "smithy.api#required": {} - } - }, "clientRequestToken": { "target": "com.amazonaws.codepipeline#ClientRequestToken", "traits": { "smithy.api#documentation": "

The system-generated unique ID used to identify a unique execution\n request.

", "smithy.api#idempotencyToken": {} } + }, + "name": { + "target": "com.amazonaws.codepipeline#PipelineName", + "traits": { + "smithy.api#documentation": "

The name of the pipeline to start.

", + "smithy.api#required": {} + } } }, "traits": { @@ -5343,28 +5343,10 @@ "com.amazonaws.codepipeline#ThirdPartyJobData": { "type": "structure", "members": { - "continuationToken": { - "target": "com.amazonaws.codepipeline#ContinuationToken", - "traits": { - "smithy.api#documentation": "

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job\n requires to continue the job asynchronously.

" - } - }, - "artifactCredentials": { - "target": "com.amazonaws.codepipeline#AWSSessionCredentials", - "traits": { - "smithy.api#documentation": "

Represents an AWS session credentials object. These credentials are temporary\n credentials that are issued by AWS Secure Token Service (STS). They can be used to\n access input and output artifacts in the S3 bucket used to store artifact for the\n pipeline in AWS CodePipeline.

" - } - }, - "actionConfiguration": { - "target": "com.amazonaws.codepipeline#ActionConfiguration", - "traits": { - "smithy.api#documentation": "

Represents information about an action configuration.

" - } - }, - "outputArtifacts": { - "target": "com.amazonaws.codepipeline#ArtifactList", + "pipelineContext": { + "target": "com.amazonaws.codepipeline#PipelineContext", "traits": { - "smithy.api#documentation": "

The name of the artifact that is the result of the action, if any. This name might\n be system-generated, such as \"MyBuiltApp\", or it might be defined by the user when the\n action is created.

" + "smithy.api#documentation": "

Represents information about a pipeline to a job worker.

\n \n

Does not include pipelineArn and pipelineExecutionId\n for ThirdParty jobs.

\n " } }, "encryptionKey": { @@ -5373,10 +5355,16 @@ "smithy.api#documentation": "

The encryption key used to encrypt and decrypt data in the artifact store for the\n pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and\n might not be present.

" } }, - "pipelineContext": { - "target": "com.amazonaws.codepipeline#PipelineContext", + "artifactCredentials": { + "target": "com.amazonaws.codepipeline#AWSSessionCredentials", "traits": { - "smithy.api#documentation": "

Represents information about a pipeline to a job worker.

\n \n

Does not include pipelineArn and pipelineExecutionId\n for ThirdParty jobs.

\n " + "smithy.api#documentation": "

Represents an AWS session credentials object. These credentials are temporary\n credentials that are issued by AWS Secure Token Service (STS). They can be used to\n access input and output artifacts in the S3 bucket used to store artifact for the\n pipeline in AWS CodePipeline.

" + } + }, + "continuationToken": { + "target": "com.amazonaws.codepipeline#ContinuationToken", + "traits": { + "smithy.api#documentation": "

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job\n requires to continue the job asynchronously.

" } }, "actionTypeId": { @@ -5390,6 +5378,18 @@ "traits": { "smithy.api#documentation": "

The name of the artifact that is worked on by the action, if any. This name might\n be system-generated, such as \"MyApp\", or it might be defined by the user when the action\n is created. The input artifact name must match the name of an output artifact generated\n by an action in an earlier action or stage of the pipeline.

" } + }, + "outputArtifacts": { + "target": "com.amazonaws.codepipeline#ArtifactList", + "traits": { + "smithy.api#documentation": "

The name of the artifact that is the result of the action, if any. This name might\n be system-generated, such as \"MyBuiltApp\", or it might be defined by the user when the\n action is created.

" + } + }, + "actionConfiguration": { + "target": "com.amazonaws.codepipeline#ActionConfiguration", + "traits": { + "smithy.api#documentation": "

Represents information about an action configuration.

" + } } }, "traits": { @@ -5470,17 +5470,17 @@ "smithy.api#documentation": "

The ID of the user who last changed the transition state.

" } }, - "disabledReason": { - "target": "com.amazonaws.codepipeline#DisabledReason", - "traits": { - "smithy.api#documentation": "

The user-specified reason why the transition between two stages of a pipeline was\n disabled.

" - } - }, "enabled": { "target": "com.amazonaws.codepipeline#Enabled", "traits": { "smithy.api#documentation": "

Whether the transition between stages is enabled (true) or disabled\n (false).

" } + }, + "disabledReason": { + "target": "com.amazonaws.codepipeline#DisabledReason", + "traits": { + "smithy.api#documentation": "

The user-specified reason why the transition between two stages of a pipeline was\n disabled.

" + } } }, "traits": { @@ -5559,17 +5559,17 @@ "com.amazonaws.codepipeline#UntagResourceInput": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.codepipeline#TagKeyList", + "resourceArn": { + "target": "com.amazonaws.codepipeline#ResourceArn", "traits": { - "smithy.api#documentation": "

The list of keys for the tags to be removed from the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.codepipeline#ResourceArn", + "tagKeys": { + "target": "com.amazonaws.codepipeline#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

", + "smithy.api#documentation": "

The list of keys for the tags to be removed from the resource.

", "smithy.api#required": {} } } @@ -5689,17 +5689,17 @@ "com.amazonaws.codepipeline#WebhookAuthConfiguration": { "type": "structure", "members": { - "SecretToken": { - "target": "com.amazonaws.codepipeline#WebhookAuthConfigurationSecretToken", - "traits": { - "smithy.api#documentation": "

The property used to configure GitHub authentication. For GITHUB_HMAC, only the\n SecretToken property must be set.

" - } - }, "AllowedIPRange": { "target": "com.amazonaws.codepipeline#WebhookAuthConfigurationAllowedIPRange", "traits": { "smithy.api#documentation": "

The property used to configure acceptance of webhooks in an IP address range. For\n IP, only the AllowedIPRange property must be set. This property must be set\n to a valid CIDR range.

" } + }, + "SecretToken": { + "target": "com.amazonaws.codepipeline#WebhookAuthConfigurationSecretToken", + "traits": { + "smithy.api#documentation": "

The property used to configure GitHub authentication. For GITHUB_HMAC, only the\n SecretToken property must be set.

" + } } }, "traits": { @@ -5746,17 +5746,17 @@ "com.amazonaws.codepipeline#WebhookDefinition": { "type": "structure", "members": { - "targetAction": { - "target": "com.amazonaws.codepipeline#ActionName", + "targetPipeline": { + "target": "com.amazonaws.codepipeline#PipelineName", "traits": { - "smithy.api#documentation": "

The name of the action in a pipeline you want to connect to the webhook. The action\n must be from the source (first) stage of the pipeline.

", + "smithy.api#documentation": "

The name of the pipeline you want to connect to the webhook.

", "smithy.api#required": {} } }, - "targetPipeline": { - "target": "com.amazonaws.codepipeline#PipelineName", + "authenticationConfiguration": { + "target": "com.amazonaws.codepipeline#WebhookAuthConfiguration", "traits": { - "smithy.api#documentation": "

The name of the pipeline you want to connect to the webhook.

", + "smithy.api#documentation": "

Properties that configure the authentication applied to incoming webhook trigger\n requests. The required properties depend on the authentication type. For GITHUB_HMAC,\n only the SecretToken property must be set. For IP, only the\n AllowedIPRange property must be set to a valid CIDR range. For\n UNAUTHENTICATED, no properties can be set.

", "smithy.api#required": {} } }, @@ -5767,10 +5767,10 @@ "smithy.api#required": {} } }, - "authenticationConfiguration": { - "target": "com.amazonaws.codepipeline#WebhookAuthConfiguration", + "filters": { + "target": "com.amazonaws.codepipeline#WebhookFilters", "traits": { - "smithy.api#documentation": "

Properties that configure the authentication applied to incoming webhook trigger\n requests. The required properties depend on the authentication type. For GITHUB_HMAC,\n only the SecretToken property must be set. For IP, only the\n AllowedIPRange property must be set to a valid CIDR range. For\n UNAUTHENTICATED, no properties can be set.

", + "smithy.api#documentation": "

A list of rules applied to the body/payload sent in the POST request to a webhook\n URL. All defined rules must pass for the request to be accepted and the pipeline\n started.

", "smithy.api#required": {} } }, @@ -5781,10 +5781,10 @@ "smithy.api#required": {} } }, - "filters": { - "target": "com.amazonaws.codepipeline#WebhookFilters", + "targetAction": { + "target": "com.amazonaws.codepipeline#ActionName", "traits": { - "smithy.api#documentation": "

A list of rules applied to the body/payload sent in the POST request to a webhook\n URL. All defined rules must pass for the request to be accepted and the pipeline\n started.

", + "smithy.api#documentation": "

The name of the action in a pipeline you want to connect to the webhook. The action\n must be from the source (first) stage of the pipeline.

", "smithy.api#required": {} } } @@ -5802,18 +5802,18 @@ "com.amazonaws.codepipeline#WebhookFilterRule": { "type": "structure", "members": { - "matchEquals": { - "target": "com.amazonaws.codepipeline#MatchEquals", - "traits": { - "smithy.api#documentation": "

The value selected by the JsonPath expression must match what is\n supplied in the MatchEquals field. Otherwise, the request is ignored.\n Properties from the target action configuration can be included as placeholders in this\n value by surrounding the action configuration key with curly brackets. For example, if\n the value supplied here is \"refs/heads/{Branch}\" and the target action has an action\n configuration property called \"Branch\" with a value of \"master\", the\n MatchEquals value is evaluated as \"refs/heads/master\". For a list of\n action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

" - } - }, "jsonPath": { "target": "com.amazonaws.codepipeline#JsonPath", "traits": { "smithy.api#documentation": "

A JsonPath expression that is applied to the body/payload of the webhook. The value\n selected by the JsonPath expression must match the value specified in the\n MatchEquals field. Otherwise, the request is ignored. For more\n information, see Java JsonPath\n implementation in GitHub.

", "smithy.api#required": {} } + }, + "matchEquals": { + "target": "com.amazonaws.codepipeline#MatchEquals", + "traits": { + "smithy.api#documentation": "

The value selected by the JsonPath expression must match what is\n supplied in the MatchEquals field. Otherwise, the request is ignored.\n Properties from the target action configuration can be included as placeholders in this\n value by surrounding the action configuration key with curly brackets. For example, if\n the value supplied here is \"refs/heads/{Branch}\" and the target action has an action\n configuration property called \"Branch\" with a value of \"master\", the\n MatchEquals value is evaluated as \"refs/heads/master\". For a list of\n action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/codestar-connections.2019-12-01.json b/codegen/sdk-codegen/aws-models/codestar-connections.2019-12-01.json index 9f136efb853d..dd0e4124eca0 100644 --- a/codegen/sdk-codegen/aws-models/codestar-connections.2019-12-01.json +++ b/codegen/sdk-codegen/aws-models/codestar-connections.2019-12-01.json @@ -91,7 +91,7 @@ "sdkId": "CodeStar connections", "arnNamespace": "codestar-connections", "cloudFormationName": "CodeStarconnections", - "cloudTrailEventSource": "connections.codestar.amazonaws.com" + "cloudTrailEventSource": "codestarconnections.amazonaws.com" }, "aws.auth#sigv4": { "name": "codestar-connections" @@ -110,6 +110,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between AWS services.

\n \n

The ARN is never reused if the connection is deleted.

\n " } }, + "ConnectionName": { + "target": "com.amazonaws.codestarconnections#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection. Connection names must be unique in an AWS user account.

" + } + }, "HostArn": { "target": "com.amazonaws.codestarconnections#HostArn", "traits": { @@ -133,12 +139,6 @@ "traits": { "smithy.api#documentation": "

The identifier of the external provider where your third-party code repository is configured.\n For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

" } - }, - "ConnectionName": { - "target": "com.amazonaws.codestarconnections#ConnectionName", - "traits": { - "smithy.api#documentation": "

The name of the connection. Connection names must be unique in an AWS user account.

" - } } }, "traits": { @@ -215,16 +215,10 @@ "com.amazonaws.codestarconnections#CreateConnectionInput": { "type": "structure", "members": { - "HostArn": { - "target": "com.amazonaws.codestarconnections#HostArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host associated with the connection to be created.

" - } - }, - "ProviderType": { - "target": "com.amazonaws.codestarconnections#ProviderType", + "Tags": { + "target": "com.amazonaws.codestarconnections#TagList", "traits": { - "smithy.api#documentation": "

The name of the external provider where your third-party code repository is configured.\n The valid provider type is Bitbucket.

" + "smithy.api#documentation": "

The key-value pair to use when tagging the resource.

" } }, "ConnectionName": { @@ -234,10 +228,16 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.codestarconnections#TagList", + "ProviderType": { + "target": "com.amazonaws.codestarconnections#ProviderType", "traits": { - "smithy.api#documentation": "

The key-value pair to use when tagging the resource.

" + "smithy.api#documentation": "

The name of the external provider where your third-party code repository is configured.\n The valid provider type is Bitbucket.

" + } + }, + "HostArn": { + "target": "com.amazonaws.codestarconnections#HostArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host associated with the connection to be created.

" } } } @@ -245,18 +245,18 @@ "com.amazonaws.codestarconnections#CreateConnectionOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.codestarconnections#TagList", - "traits": { - "smithy.api#documentation": "

Specifies the tags applied to the resource.

" - } - }, "ConnectionArn": { "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the\n connection reference when the connection is shared between AWS services.

\n \n

The ARN is never reused if the connection is deleted.

\n ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.codestarconnections#TagList", + "traits": { + "smithy.api#documentation": "

Specifies the tags applied to the resource.

" + } } } }, @@ -287,6 +287,13 @@ "smithy.api#required": {} } }, + "Name": { + "target": "com.amazonaws.codestarconnections#HostName", + "traits": { + "smithy.api#documentation": "

The name of the host to be created. The name must be unique in the calling AWS\n account.

", + "smithy.api#required": {} + } + }, "VpcConfiguration": { "target": "com.amazonaws.codestarconnections#VpcConfiguration", "traits": { @@ -299,13 +306,6 @@ "smithy.api#documentation": "

The endpoint of the infrastructure to be represented by the host after it is\n created.

", "smithy.api#required": {} } - }, - "Name": { - "target": "com.amazonaws.codestarconnections#HostName", - "traits": { - "smithy.api#documentation": "

The name of the host to be created. The name must be unique in the calling AWS\n account.

", - "smithy.api#required": {} - } } } }, @@ -479,10 +479,10 @@ "smithy.api#documentation": "

The provider type of the requested host, such as GitHub Enterprise Server.

" } }, - "VpcConfiguration": { - "target": "com.amazonaws.codestarconnections#VpcConfiguration", + "Name": { + "target": "com.amazonaws.codestarconnections#HostName", "traits": { - "smithy.api#documentation": "

The VPC configuration of the requested host.

" + "smithy.api#documentation": "

The name of the requested host.

" } }, "ProviderEndpoint": { @@ -491,16 +491,16 @@ "smithy.api#documentation": "

The endpoint of the infrastructure represented by the requested host.

" } }, - "Status": { - "target": "com.amazonaws.codestarconnections#HostStatus", + "VpcConfiguration": { + "target": "com.amazonaws.codestarconnections#VpcConfiguration", "traits": { - "smithy.api#documentation": "

The status of the requested host.

" + "smithy.api#documentation": "

The VPC configuration of the requested host.

" } }, - "Name": { - "target": "com.amazonaws.codestarconnections#HostName", + "Status": { + "target": "com.amazonaws.codestarconnections#HostStatus", "traits": { - "smithy.api#documentation": "

The name of the requested host.

" + "smithy.api#documentation": "

The status of the requested host.

" } } } @@ -508,22 +508,22 @@ "com.amazonaws.codestarconnections#Host": { "type": "structure", "members": { - "VpcConfiguration": { - "target": "com.amazonaws.codestarconnections#VpcConfiguration", + "StatusMessage": { + "target": "com.amazonaws.codestarconnections#HostStatusMessage", "traits": { - "smithy.api#documentation": "

The VPC configuration provisioned for the host.

" + "smithy.api#documentation": "

The status description for the host.

" } }, - "Name": { - "target": "com.amazonaws.codestarconnections#HostName", + "ProviderType": { + "target": "com.amazonaws.codestarconnections#ProviderType", "traits": { - "smithy.api#documentation": "

The name of the host.

" + "smithy.api#documentation": "

The name of the installed provider to be associated with your connection. The host\n resource represents the infrastructure where your provider type is installed. The valid\n provider type is GitHub Enterprise Server.

" } }, - "ProviderEndpoint": { - "target": "com.amazonaws.codestarconnections#Url", + "Name": { + "target": "com.amazonaws.codestarconnections#HostName", "traits": { - "smithy.api#documentation": "

The endpoint of the infrastructure where your provider type is installed.

" + "smithy.api#documentation": "

The name of the host.

" } }, "HostArn": { @@ -532,22 +532,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host.

" } }, - "Status": { - "target": "com.amazonaws.codestarconnections#HostStatus", + "VpcConfiguration": { + "target": "com.amazonaws.codestarconnections#VpcConfiguration", "traits": { - "smithy.api#documentation": "

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

" + "smithy.api#documentation": "

The VPC configuration provisioned for the host.

" } }, - "StatusMessage": { - "target": "com.amazonaws.codestarconnections#HostStatusMessage", + "Status": { + "target": "com.amazonaws.codestarconnections#HostStatus", "traits": { - "smithy.api#documentation": "

The status description for the host.

" + "smithy.api#documentation": "

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

" } }, - "ProviderType": { - "target": "com.amazonaws.codestarconnections#ProviderType", + "ProviderEndpoint": { + "target": "com.amazonaws.codestarconnections#Url", "traits": { - "smithy.api#documentation": "

The name of the installed provider to be associated with your connection. The host\n resource represents the infrastructure where your provider type is installed. The valid\n provider type is GitHub Enterprise Server.

" + "smithy.api#documentation": "

The endpoint of the infrastructure where your provider type is installed.

" } } }, @@ -619,28 +619,28 @@ "com.amazonaws.codestarconnections#ListConnectionsInput": { "type": "structure", "members": { - "HostArnFilter": { - "target": "com.amazonaws.codestarconnections#HostArn", - "traits": { - "smithy.api#documentation": "

Filters the list of connections to those associated with a specified host.

" - } - }, "ProviderTypeFilter": { "target": "com.amazonaws.codestarconnections#ProviderType", "traits": { "smithy.api#documentation": "

Filters the list of connections to those associated with a specified provider, such as\n Bitbucket.

" } }, + "MaxResults": { + "target": "com.amazonaws.codestarconnections#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" + } + }, "NextToken": { "target": "com.amazonaws.codestarconnections#NextToken", "traits": { "smithy.api#documentation": "

The token that was returned from the previous ListConnections call, which\n can be used to return the next set of connections in the list.

" } }, - "MaxResults": { - "target": "com.amazonaws.codestarconnections#MaxResults", + "HostArnFilter": { + "target": "com.amazonaws.codestarconnections#HostArn", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Filters the list of connections to those associated with a specified host.

" } } } @@ -648,17 +648,17 @@ "com.amazonaws.codestarconnections#ListConnectionsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.codestarconnections#NextToken", - "traits": { - "smithy.api#documentation": "

A token that can be used in the next ListConnections call. To view all\n items in the list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" - } - }, "Connections": { "target": "com.amazonaws.codestarconnections#ConnectionList", "traits": { "smithy.api#documentation": "

A list of connections and the details for each connection, such as status, owner, and\n provider type.

" } + }, + "NextToken": { + "target": "com.amazonaws.codestarconnections#NextToken", + "traits": { + "smithy.api#documentation": "

A token that can be used in the next ListConnections call. To view all\n items in the list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" + } } } }, @@ -682,34 +682,34 @@ "com.amazonaws.codestarconnections#ListHostsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.codestarconnections#NextToken", - "traits": { - "smithy.api#documentation": "

The token that was returned from the previous ListHosts call, which can be\n used to return the next set of hosts in the list.

" - } - }, "MaxResults": { "target": "com.amazonaws.codestarconnections#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" } + }, + "NextToken": { + "target": "com.amazonaws.codestarconnections#NextToken", + "traits": { + "smithy.api#documentation": "

The token that was returned from the previous ListHosts call, which can be\n used to return the next set of hosts in the list.

" + } } } }, "com.amazonaws.codestarconnections#ListHostsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.codestarconnections#NextToken", - "traits": { - "smithy.api#documentation": "

A token that can be used in the next ListHosts call. To view all items in the\n list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" - } - }, "Hosts": { "target": "com.amazonaws.codestarconnections#HostList", "traits": { "smithy.api#documentation": "

A list of hosts and the details for each host, such as status, endpoint, and provider\n type.

" } + }, + "NextToken": { + "target": "com.amazonaws.codestarconnections#NextToken", + "traits": { + "smithy.api#documentation": "

A token that can be used in the next ListHosts call. To view all items in the\n list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" + } } } }, @@ -779,6 +779,10 @@ "value": "Bitbucket", "name": "BITBUCKET" }, + { + "value": "GitHub", + "name": "GITHUB" + }, { "value": "GitHubEnterpriseServer", "name": "GITHUB_ENTERPRISE_SERVER" @@ -984,17 +988,17 @@ "com.amazonaws.codestarconnections#UntagResourceInput": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.codestarconnections#TagKeyList", + "ResourceArn": { + "target": "com.amazonaws.codestarconnections#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The list of keys for the tags to be removed from the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.codestarconnections#AmazonResourceName", + "TagKeys": { + "target": "com.amazonaws.codestarconnections#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

", + "smithy.api#documentation": "

The list of keys for the tags to be removed from the resource.

", "smithy.api#required": {} } } @@ -1016,31 +1020,31 @@ "com.amazonaws.codestarconnections#VpcConfiguration": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.codestarconnections#SecurityGroupIds", + "TlsCertificate": { + "target": "com.amazonaws.codestarconnections#TlsCertificate", "traits": { - "smithy.api#documentation": "

The ID of the security group or security groups associated with the Amazon VPC connected\n to the infrastructure where your provider type is installed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

" } }, - "VpcId": { - "target": "com.amazonaws.codestarconnections#VpcId", + "SubnetIds": { + "target": "com.amazonaws.codestarconnections#SubnetIds", "traits": { - "smithy.api#documentation": "

The ID of the Amazon VPC connected to the infrastructure where your provider type is\n installed.

", + "smithy.api#documentation": "

The ID of the subnet or subnets associated with the Amazon VPC connected to the\n infrastructure where your provider type is installed.

", "smithy.api#required": {} } }, - "SubnetIds": { - "target": "com.amazonaws.codestarconnections#SubnetIds", + "SecurityGroupIds": { + "target": "com.amazonaws.codestarconnections#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The ID of the subnet or subnets associated with the Amazon VPC connected to the\n infrastructure where your provider type is installed.

", + "smithy.api#documentation": "

The ID of the security group or security groups associated with the Amazon VPC connected\n to the infrastructure where your provider type is installed.

", "smithy.api#required": {} } }, - "TlsCertificate": { - "target": "com.amazonaws.codestarconnections#TlsCertificate", + "VpcId": { + "target": "com.amazonaws.codestarconnections#VpcId", "traits": { - "smithy.api#documentation": "

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

" + "smithy.api#documentation": "

The ID of the Amazon VPC connected to the infrastructure where your provider type is\n installed.

", + "smithy.api#required": {} } } }, diff --git a/codegen/sdk-codegen/aws-models/codestar-notifications.2019-10-15.json b/codegen/sdk-codegen/aws-models/codestar-notifications.2019-10-15.json index 10999b4e4569..215aec478eaf 100644 --- a/codegen/sdk-codegen/aws-models/codestar-notifications.2019-10-15.json +++ b/codegen/sdk-codegen/aws-models/codestar-notifications.2019-10-15.json @@ -177,57 +177,57 @@ "com.amazonaws.codestarnotifications#CreateNotificationRuleRequest": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleStatus", + "traits": { + "smithy.api#documentation": "

The status of the notification rule. The default value is ENABLED. If the status is\n set to DISABLED, notifications aren't sent for the notification rule.

" + } + }, "Tags": { "target": "com.amazonaws.codestarnotifications#Tags", "traits": { "smithy.api#documentation": "

A list of tags to apply to this notification rule. Key names cannot start with \"aws\".

" } }, - "EventTypeIds": { - "target": "com.amazonaws.codestarnotifications#EventTypeIds", + "Name": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleName", "traits": { - "smithy.api#documentation": "

A list of event types associated with this notification rule. For a list of allowed\n events, see EventTypeSummary.

", + "smithy.api#documentation": "

The name for the notification rule. Notifictaion rule names must be unique in your AWS\n account.

", "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.codestarnotifications#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request with the same\n parameters is received and a token is included, the request returns information about\n the initial request that used that token.

\n \n

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an\n idempotency token is created for you.

\n ", - "smithy.api#idempotencyToken": {} - } - }, - "DetailType": { - "target": "com.amazonaws.codestarnotifications#DetailType", + "Resource": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleResource", "traits": { - "smithy.api#documentation": "

The level of detail to include in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information\n provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline,\n repositories in AWS CodeCommit, and build projects in AWS CodeBuild.

", "smithy.api#required": {} } }, - "Resource": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleResource", + "Targets": { + "target": "com.amazonaws.codestarnotifications#Targets", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline,\n repositories in AWS CodeCommit, and build projects in AWS CodeBuild.

", + "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of SNS topics to associate with the\n notification rule.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleStatus", + "ClientRequestToken": { + "target": "com.amazonaws.codestarnotifications#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The status of the notification rule. The default value is ENABLED. If the status is\n set to DISABLED, notifications aren't sent for the notification rule.

" + "smithy.api#documentation": "

A unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request with the same\n parameters is received and a token is included, the request returns information about\n the initial request that used that token.

\n \n

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an\n idempotency token is created for you.

\n ", + "smithy.api#idempotencyToken": {} } }, - "Targets": { - "target": "com.amazonaws.codestarnotifications#Targets", + "DetailType": { + "target": "com.amazonaws.codestarnotifications#DetailType", "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of SNS topics to associate with the\n notification rule.

", + "smithy.api#documentation": "

The level of detail to include in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information\n provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleName", + "EventTypeIds": { + "target": "com.amazonaws.codestarnotifications#EventTypeIds", "traits": { - "smithy.api#documentation": "

The name for the notification rule. Notifictaion rule names must be unique in your AWS\n account.

", + "smithy.api#documentation": "

A list of event types associated with this notification rule. For a list of allowed\n events, see EventTypeSummary.

", "smithy.api#required": {} } } @@ -382,29 +382,10 @@ "com.amazonaws.codestarnotifications#DescribeNotificationRuleResult": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

", - "smithy.api#required": {} - } - }, - "LastModifiedTimestamp": { - "target": "com.amazonaws.codestarnotifications#LastModifiedTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the notification rule was most recently updated, in timestamp\n format.

" - } - }, - "DetailType": { - "target": "com.amazonaws.codestarnotifications#DetailType", - "traits": { - "smithy.api#documentation": "

The level of detail included in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information\n provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

" - } - }, - "Status": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleStatus", + "Targets": { + "target": "com.amazonaws.codestarnotifications#TargetsBatch", "traits": { - "smithy.api#documentation": "

The status of the notification rule. Valid statuses are on (sending notifications) or off\n (not sending notifications).

" + "smithy.api#documentation": "

A list of the SNS topics associated with the notification rule.

" } }, "EventTypes": { @@ -419,28 +400,35 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource associated with the notification\n rule.

" } }, + "LastModifiedTimestamp": { + "target": "com.amazonaws.codestarnotifications#LastModifiedTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the notification rule was most recently updated, in timestamp\n format.

" + } + }, "Name": { "target": "com.amazonaws.codestarnotifications#NotificationRuleName", "traits": { "smithy.api#documentation": "

The name of the notification rule.

" } }, - "Tags": { - "target": "com.amazonaws.codestarnotifications#Tags", + "Arn": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { - "smithy.api#documentation": "

The tags associated with the notification rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

", + "smithy.api#required": {} } }, - "CreatedTimestamp": { - "target": "com.amazonaws.codestarnotifications#CreatedTimestamp", + "Tags": { + "target": "com.amazonaws.codestarnotifications#Tags", "traits": { - "smithy.api#documentation": "

The date and time the notification rule was created, in timestamp format.

" + "smithy.api#documentation": "

The tags associated with the notification rule.

" } }, - "Targets": { - "target": "com.amazonaws.codestarnotifications#TargetsBatch", + "Status": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleStatus", "traits": { - "smithy.api#documentation": "

A list of the SNS topics associated with the notification rule.

" + "smithy.api#documentation": "

The status of the notification rule. Valid statuses are on (sending notifications) or off\n (not sending notifications).

" } }, "CreatedBy": { @@ -448,6 +436,18 @@ "traits": { "smithy.api#documentation": "

The name or email alias of the person who created the notification rule.

" } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.codestarnotifications#CreatedTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the notification rule was created, in timestamp format.

" + } + }, + "DetailType": { + "target": "com.amazonaws.codestarnotifications#DetailType", + "traits": { + "smithy.api#documentation": "

The level of detail included in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information\n provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

" + } } } }, @@ -499,10 +499,10 @@ "smithy.api#documentation": "

The system-generated ID of the event.

" } }, - "ResourceType": { - "target": "com.amazonaws.codestarnotifications#ResourceType", + "EventTypeName": { + "target": "com.amazonaws.codestarnotifications#EventTypeName", "traits": { - "smithy.api#documentation": "

The resource type of the event.

" + "smithy.api#documentation": "

The name of the event.

" } }, "ServiceName": { @@ -511,10 +511,10 @@ "smithy.api#documentation": "

The name of the service for which the event applies.

" } }, - "EventTypeName": { - "target": "com.amazonaws.codestarnotifications#EventTypeName", + "ResourceType": { + "target": "com.amazonaws.codestarnotifications#ResourceType", "traits": { - "smithy.api#documentation": "

The name of the event.

" + "smithy.api#documentation": "

The resource type of the event.

" } } }, @@ -634,10 +634,11 @@ "com.amazonaws.codestarnotifications#ListEventTypesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.codestarnotifications#ListEventTypesFilters", + "MaxResults": { + "target": "com.amazonaws.codestarnotifications#MaxResults", "traits": { - "smithy.api#documentation": "

The filters to use to return information by service or resource type.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of\n results that can be returned is 100.

" } }, "NextToken": { @@ -646,11 +647,10 @@ "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, - "MaxResults": { - "target": "com.amazonaws.codestarnotifications#MaxResults", + "Filters": { + "target": "com.amazonaws.codestarnotifications#ListEventTypesFilters", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of\n results that can be returned is 100.

" + "smithy.api#documentation": "

The filters to use to return information by service or resource type.

" } } } @@ -658,17 +658,17 @@ "com.amazonaws.codestarnotifications#ListEventTypesResult": { "type": "structure", "members": { - "EventTypes": { - "target": "com.amazonaws.codestarnotifications#EventTypeBatch", - "traits": { - "smithy.api#documentation": "

Information about each event, including service name, resource type, event ID, and event\n name.

" - } - }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that can be used in a request to return the next batch of the results.

" } + }, + "EventTypes": { + "target": "com.amazonaws.codestarnotifications#EventTypeBatch", + "traits": { + "smithy.api#documentation": "

Information about each event, including service name, resource type, event ID, and event\n name.

" + } } } }, @@ -706,17 +706,17 @@ "com.amazonaws.codestarnotifications#ListNotificationRulesFilter": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilterValue", + "Name": { + "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilterName", "traits": { - "smithy.api#documentation": "

The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by RESOURCE \n in Name, you might specify the ARN of a pipeline in AWS CodePipeline for the value.

", + "smithy.api#documentation": "

The name of the attribute you want to use to filter the returned notification rules.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilterName", + "Value": { + "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilterValue", "traits": { - "smithy.api#documentation": "

The name of the attribute you want to use to filter the returned notification rules.

", + "smithy.api#documentation": "

The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by RESOURCE \n in Name, you might specify the ARN of a pipeline in AWS CodePipeline for the value.

", "smithy.api#required": {} } } @@ -767,17 +767,17 @@ "smithy.api#documentation": "

A non-negative integer used to limit the number of returned results. The maximum number of\n results that can be returned is 100.

" } }, - "Filters": { - "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilters", - "traits": { - "smithy.api#documentation": "

The filters to use to return information by service or resource type. For valid values,\n see ListNotificationRulesFilter.

\n \n

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

\n " - } - }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } + }, + "Filters": { + "target": "com.amazonaws.codestarnotifications#ListNotificationRulesFilters", + "traits": { + "smithy.api#documentation": "

The filters to use to return information by service or resource type. For valid values,\n see ListNotificationRulesFilter.

\n \n

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

\n " + } } } }, @@ -930,12 +930,6 @@ "com.amazonaws.codestarnotifications#ListTargetsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.codestarnotifications#ListTargetsFilters", - "traits": { - "smithy.api#documentation": "

The filters to use to return information by service or resource type. Valid filters\n include target type, target address, and target status.

\n \n

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

\n " - } - }, "NextToken": { "target": "com.amazonaws.codestarnotifications#NextToken", "traits": { @@ -948,6 +942,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "

A non-negative integer used to limit the number of returned results. The maximum number of\n results that can be returned is 100.

" } + }, + "Filters": { + "target": "com.amazonaws.codestarnotifications#ListTargetsFilters", + "traits": { + "smithy.api#documentation": "

The filters to use to return information by service or resource type. Valid filters\n include target type, target address, and target status.

\n \n

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

\n " + } } } }, @@ -1055,17 +1055,17 @@ "com.amazonaws.codestarnotifications#NotificationRuleSummary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleId", - "traits": { - "smithy.api#documentation": "

The unique ID of the notification rule.

" - } - }, "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule.

" } + }, + "Id": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleId", + "traits": { + "smithy.api#documentation": "

The unique ID of the notification rule.

" + } } }, "traits": { @@ -1138,10 +1138,10 @@ "com.amazonaws.codestarnotifications#SubscribeRequest": { "type": "structure", "members": { - "Target": { - "target": "com.amazonaws.codestarnotifications#Target", + "ClientRequestToken": { + "target": "com.amazonaws.codestarnotifications#ClientRequestToken", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" } }, "Arn": { @@ -1151,10 +1151,10 @@ "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.codestarnotifications#ClientRequestToken", + "Target": { + "target": "com.amazonaws.codestarnotifications#Target", "traits": { - "smithy.api#documentation": "

An enumeration token that, when provided in a request, returns the next batch of the\n results.

" + "smithy.api#required": {} } } } @@ -1217,17 +1217,17 @@ "com.amazonaws.codestarnotifications#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.codestarnotifications#Tags", + "Arn": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { - "smithy.api#documentation": "

The list of tags to associate with the resource. Tag key names cannot start with \"aws\".

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule to tag.

", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", + "Tags": { + "target": "com.amazonaws.codestarnotifications#Tags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule to tag.

", + "smithy.api#documentation": "

The list of tags to associate with the resource. Tag key names cannot start with \"aws\".

", "smithy.api#required": {} } } @@ -1266,17 +1266,17 @@ "com.amazonaws.codestarnotifications#Target": { "type": "structure", "members": { - "TargetAddress": { - "target": "com.amazonaws.codestarnotifications#TargetAddress", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic.

" - } - }, "TargetType": { "target": "com.amazonaws.codestarnotifications#TargetType", "traits": { "smithy.api#documentation": "

The target type. Can be an Amazon SNS topic.

" } + }, + "TargetAddress": { + "target": "com.amazonaws.codestarnotifications#TargetAddress", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic.

" + } } }, "traits": { @@ -1323,10 +1323,10 @@ "com.amazonaws.codestarnotifications#TargetSummary": { "type": "structure", "members": { - "TargetAddress": { - "target": "com.amazonaws.codestarnotifications#TargetAddress", + "TargetType": { + "target": "com.amazonaws.codestarnotifications#TargetType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic.

" + "smithy.api#documentation": "

The type of the target (for example, SNS).

" } }, "TargetStatus": { @@ -1335,10 +1335,10 @@ "smithy.api#documentation": "

The status of the target.

" } }, - "TargetType": { - "target": "com.amazonaws.codestarnotifications#TargetType", + "TargetAddress": { + "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { - "smithy.api#documentation": "

The type of the target (for example, SNS).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic.

" } } }, @@ -1454,17 +1454,17 @@ "com.amazonaws.codestarnotifications#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.codestarnotifications#TagKeys", + "Arn": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { - "smithy.api#documentation": "

The key names of the tags to remove.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule from which to remove the\n tags.

", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", + "TagKeys": { + "target": "com.amazonaws.codestarnotifications#TagKeys", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification rule from which to remove the\n tags.

", + "smithy.api#documentation": "

The key names of the tags to remove.

", "smithy.api#required": {} } } @@ -1502,22 +1502,10 @@ "com.amazonaws.codestarnotifications#UpdateNotificationRuleRequest": { "type": "structure", "members": { - "Targets": { - "target": "com.amazonaws.codestarnotifications#Targets", - "traits": { - "smithy.api#documentation": "

The address and type of the targets to receive notifications from this notification\n rule.

" - } - }, - "DetailType": { - "target": "com.amazonaws.codestarnotifications#DetailType", - "traits": { - "smithy.api#documentation": "

The level of detail to include in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information\n provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

" - } - }, - "EventTypeIds": { - "target": "com.amazonaws.codestarnotifications#EventTypeIds", + "Name": { + "target": "com.amazonaws.codestarnotifications#NotificationRuleName", "traits": { - "smithy.api#documentation": "

A list of event types associated with this notification rule.

" + "smithy.api#documentation": "

The name of the notification rule.

" } }, "Status": { @@ -1526,6 +1514,12 @@ "smithy.api#documentation": "

The status of the notification rule. Valid statuses include enabled (sending notifications) or\n disabled (not sending notifications).

" } }, + "DetailType": { + "target": "com.amazonaws.codestarnotifications#DetailType", + "traits": { + "smithy.api#documentation": "

The level of detail to include in the notifications for this resource. BASIC will include only the \n contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information\n provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

" + } + }, "Arn": { "target": "com.amazonaws.codestarnotifications#NotificationRuleArn", "traits": { @@ -1533,10 +1527,16 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.codestarnotifications#NotificationRuleName", + "EventTypeIds": { + "target": "com.amazonaws.codestarnotifications#EventTypeIds", "traits": { - "smithy.api#documentation": "

The name of the notification rule.

" + "smithy.api#documentation": "

A list of event types associated with this notification rule.

" + } + }, + "Targets": { + "target": "com.amazonaws.codestarnotifications#Targets", + "traits": { + "smithy.api#documentation": "

The address and type of the targets to receive notifications from this notification\n rule.

" } } } diff --git a/codegen/sdk-codegen/aws-models/codestar.2017-04-19.json b/codegen/sdk-codegen/aws-models/codestar.2017-04-19.json index a0967c1f0d15..6b0e245c3e0b 100644 --- a/codegen/sdk-codegen/aws-models/codestar.2017-04-19.json +++ b/codegen/sdk-codegen/aws-models/codestar.2017-04-19.json @@ -74,12 +74,6 @@ "smithy.api#documentation": "

Whether the team member is allowed to use an SSH public/private key pair to remotely\n access project resources, for example Amazon EC2 instances.

" } }, - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A user- or system-generated token that identifies the entity that requested the team\n member association to the project. This token can be used to repeat the request.

" - } - }, "projectRole": { "target": "com.amazonaws.codestar#Role", "traits": { @@ -87,11 +81,10 @@ "smithy.api#required": {} } }, - "userArn": { - "target": "com.amazonaws.codestar#UserArn", + "clientRequestToken": { + "target": "com.amazonaws.codestar#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar\n project.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A user- or system-generated token that identifies the entity that requested the team\n member association to the project. This token can be used to repeat the request.

" } }, "projectId": { @@ -100,6 +93,13 @@ "smithy.api#documentation": "

The ID of the project to which you will add the IAM user.

", "smithy.api#required": {} } + }, + "userArn": { + "target": "com.amazonaws.codestar#UserArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar\n project.

", + "smithy.api#required": {} + } } } }, @@ -176,17 +176,17 @@ "com.amazonaws.codestar#CodeDestination": { "type": "structure", "members": { - "gitHub": { - "target": "com.amazonaws.codestar#GitHubCodeDestination", - "traits": { - "smithy.api#documentation": "

Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the\n project request will be uploaded after project creation.

" - } - }, "codeCommit": { "target": "com.amazonaws.codestar#CodeCommitCodeDestination", "traits": { "smithy.api#documentation": "

Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided\n with the project request will be uploaded after project creation.

" } + }, + "gitHub": { + "target": "com.amazonaws.codestar#GitHubCodeDestination", + "traits": { + "smithy.api#documentation": "

Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the\n project request will be uploaded after project creation.

" + } } }, "traits": { @@ -333,6 +333,13 @@ "com.amazonaws.codestar#CreateProjectRequest": { "type": "structure", "members": { + "id": { + "target": "com.amazonaws.codestar#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the project to be created in AWS CodeStar.

", + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.codestar#ProjectDescription", "traits": { @@ -346,6 +353,12 @@ "smithy.api#required": {} } }, + "toolchain": { + "target": "com.amazonaws.codestar#Toolchain", + "traits": { + "smithy.api#documentation": "

The name of the toolchain template file submitted with the project request. If\n this parameter is specified, the request must also include the sourceCode parameter.

" + } + }, "tags": { "target": "com.amazonaws.codestar#Tags", "traits": { @@ -358,19 +371,6 @@ "smithy.api#documentation": "

A list of the Code objects submitted with the project request. If this\n parameter is specified, the request must also include the toolchain parameter.

" } }, - "toolchain": { - "target": "com.amazonaws.codestar#Toolchain", - "traits": { - "smithy.api#documentation": "

The name of the toolchain template file submitted with the project request. If\n this parameter is specified, the request must also include the sourceCode parameter.

" - } - }, - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "

The ID of the project to be created in AWS CodeStar.

", - "smithy.api#required": {} - } - }, "clientRequestToken": { "target": "com.amazonaws.codestar#ClientRequestToken", "traits": { @@ -382,13 +382,6 @@ "com.amazonaws.codestar#CreateProjectResult": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "

The ID of the project.

", - "smithy.api#required": {} - } - }, "arn": { "target": "com.amazonaws.codestar#ProjectArn", "traits": { @@ -402,6 +395,13 @@ "smithy.api#documentation": "

Reserved for future use.

" } }, + "id": { + "target": "com.amazonaws.codestar#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the project.

", + "smithy.api#required": {} + } + }, "clientRequestToken": { "target": "com.amazonaws.codestar#ClientRequestToken", "traits": { @@ -440,13 +440,6 @@ "smithy.api#required": {} } }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", - "traits": { - "smithy.api#documentation": "

The email address that will be displayed as part of the user's profile in\n AWS CodeStar.

", - "smithy.api#required": {} - } - }, "sshPublicKey": { "target": "com.amazonaws.codestar#SshPublicKey", "traits": { @@ -459,25 +452,19 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user in IAM.

", "smithy.api#required": {} } + }, + "emailAddress": { + "target": "com.amazonaws.codestar#Email", + "traits": { + "smithy.api#documentation": "

The email address that will be displayed as part of the user's profile in\n AWS CodeStar.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.codestar#CreateUserProfileResult": { "type": "structure", "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user in IAM.

", - "smithy.api#required": {} - } - }, - "createdTimestamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", - "traits": { - "smithy.api#documentation": "

The date the user profile was created, in timestamp format.

" - } - }, "lastModifiedTimestamp": { "target": "com.amazonaws.codestar#LastModifiedTimestamp", "traits": { @@ -496,11 +483,24 @@ "smithy.api#documentation": "

The name that is displayed as the friendly name for the user in AWS CodeStar.

" } }, + "createdTimestamp": { + "target": "com.amazonaws.codestar#CreatedTimestamp", + "traits": { + "smithy.api#documentation": "

The date the user profile was created, in timestamp format.

" + } + }, "sshPublicKey": { "target": "com.amazonaws.codestar#SshPublicKey", "traits": { "smithy.api#documentation": "

The SSH public key associated with the user in AWS CodeStar. This is the public portion of the\n public/private keypair the user can use to access project resources if a project owner allows\n the user remote access to those resources.

" } + }, + "userArn": { + "target": "com.amazonaws.codestar#UserArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user in IAM.

", + "smithy.api#required": {} + } } } }, @@ -533,6 +533,12 @@ "com.amazonaws.codestar#DeleteProjectRequest": { "type": "structure", "members": { + "clientRequestToken": { + "target": "com.amazonaws.codestar#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A user- or system-generated token that identifies the entity that requested project\n deletion. This token can be used to repeat the request.

" + } + }, "deleteStack": { "target": "com.amazonaws.codestar#DeleteStack", "traits": { @@ -545,29 +551,23 @@ "smithy.api#documentation": "

The ID of the project to be deleted in AWS CodeStar.

", "smithy.api#required": {} } - }, - "clientRequestToken": { - "target": "com.amazonaws.codestar#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A user- or system-generated token that identifies the entity that requested project\n deletion. This token can be used to repeat the request.

" - } } } }, "com.amazonaws.codestar#DeleteProjectResult": { "type": "structure", "members": { - "stackId": { - "target": "com.amazonaws.codestar#StackId", - "traits": { - "smithy.api#documentation": "

The ID of the primary stack in AWS CloudFormation that will be deleted as part of\n deleting the project and its resources.

" - } - }, "projectArn": { "target": "com.amazonaws.codestar#ProjectArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted project.

" } + }, + "stackId": { + "target": "com.amazonaws.codestar#StackId", + "traits": { + "smithy.api#documentation": "

The ID of the primary stack in AWS CloudFormation that will be deleted as part of\n deleting the project and its resources.

" + } } } }, @@ -659,34 +659,22 @@ "com.amazonaws.codestar#DescribeProjectResult": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.codestar#ProjectDescription", - "traits": { - "smithy.api#documentation": "

The description of the project, if any.

" - } - }, - "createdTimeStamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the project was created, in timestamp format.

" - } - }, "name": { "target": "com.amazonaws.codestar#ProjectName", "traits": { "smithy.api#documentation": "

The display name for the project.

" } }, - "arn": { - "target": "com.amazonaws.codestar#ProjectArn", + "description": { + "target": "com.amazonaws.codestar#ProjectDescription", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the project.

" + "smithy.api#documentation": "

The description of the project, if any.

" } }, - "status": { - "target": "com.amazonaws.codestar#ProjectStatus", + "arn": { + "target": "com.amazonaws.codestar#ProjectArn", "traits": { - "smithy.api#documentation": "

The project creation or deletion status.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the project.

" } }, "projectTemplateId": { @@ -701,16 +689,28 @@ "smithy.api#documentation": "

The ID of the project.

" } }, + "stackId": { + "target": "com.amazonaws.codestar#StackId", + "traits": { + "smithy.api#documentation": "

The ID of the primary stack in AWS CloudFormation used to generate resources for the\n project.

" + } + }, + "status": { + "target": "com.amazonaws.codestar#ProjectStatus", + "traits": { + "smithy.api#documentation": "

The project creation or deletion status.

" + } + }, "clientRequestToken": { "target": "com.amazonaws.codestar#ClientRequestToken", "traits": { "smithy.api#documentation": "

A user- or system-generated token that identifies the entity that requested project\n creation.

" } }, - "stackId": { - "target": "com.amazonaws.codestar#StackId", + "createdTimeStamp": { + "target": "com.amazonaws.codestar#CreatedTimestamp", "traits": { - "smithy.api#documentation": "

The ID of the primary stack in AWS CloudFormation used to generate resources for the\n project.

" + "smithy.api#documentation": "

The date and time the project was created, in timestamp format.

" } } } @@ -750,19 +750,13 @@ "com.amazonaws.codestar#DescribeUserProfileResult": { "type": "structure", "members": { - "createdTimestamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", + "userArn": { + "target": "com.amazonaws.codestar#UserArn", "traits": { - "smithy.api#documentation": "

The date and time when the user profile was created in AWS CodeStar, in timestamp\n format.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

", "smithy.api#required": {} } }, - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", - "traits": { - "smithy.api#documentation": "

The display name shown for the user in AWS CodeStar projects. For example, this could be set\n to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also\n used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are\n included in the display name, the first character that appears after the space will be used as\n the second character in the user initial icon. The initial icon displays a maximum of two\n characters, so a display name with more than one space (for example \"Mary Jane Major\") would\n generate an initial icon using the first character and the first character after the space\n (\"MJ\", not \"MM\").

" - } - }, "lastModifiedTimestamp": { "target": "com.amazonaws.codestar#LastModifiedTimestamp", "traits": { @@ -776,11 +770,10 @@ "smithy.api#documentation": "

The email address for the user. Optional.

" } }, - "userArn": { - "target": "com.amazonaws.codestar#UserArn", + "displayName": { + "target": "com.amazonaws.codestar#UserProfileDisplayName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The display name shown for the user in AWS CodeStar projects. For example, this could be set\n to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also\n used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are\n included in the display name, the first character that appears after the space will be used as\n the second character in the user initial icon. The initial icon displays a maximum of two\n characters, so a display name with more than one space (for example \"Mary Jane Major\") would\n generate an initial icon using the first character and the first character after the space\n (\"MJ\", not \"MM\").

" } }, "sshPublicKey": { @@ -788,6 +781,13 @@ "traits": { "smithy.api#documentation": "

The SSH public key associated with the user. This SSH public key is associated with the\n user profile, and can be used in conjunction with the associated private key for access to\n project resources, such as Amazon EC2 instances, if a project owner grants remote access to\n those resources.

" } + }, + "createdTimestamp": { + "target": "com.amazonaws.codestar#CreatedTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the user profile was created in AWS CodeStar, in timestamp\n format.

", + "smithy.api#required": {} + } } } }, @@ -854,31 +854,30 @@ "com.amazonaws.codestar#GitHubCodeDestination": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.codestar#RepositoryType", + "name": { + "target": "com.amazonaws.codestar#RepositoryName", "traits": { - "smithy.api#documentation": "

The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

", + "smithy.api#documentation": "

Name of the GitHub repository to be created in AWS CodeStar.

", "smithy.api#required": {} } }, - "privateRepository": { - "target": "com.amazonaws.codestar#RepositoryIsPrivate", + "description": { + "target": "com.amazonaws.codestar#RepositoryDescription", "traits": { - "smithy.api#documentation": "

Whether the GitHub repository is to be a private repository.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Description for the GitHub repository to be created in AWS CodeStar. This description displays in\n GitHub after the repository is created.

" } }, - "token": { - "target": "com.amazonaws.codestar#GitHubPersonalToken", + "privateRepository": { + "target": "com.amazonaws.codestar#RepositoryIsPrivate", "traits": { - "smithy.api#documentation": "

The GitHub user's personal access token for the GitHub repository.

", + "smithy.api#documentation": "

Whether the GitHub repository is to be a private repository.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.codestar#RepositoryName", + "owner": { + "target": "com.amazonaws.codestar#RepositoryOwner", "traits": { - "smithy.api#documentation": "

Name of the GitHub repository to be created in AWS CodeStar.

", + "smithy.api#documentation": "

The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should\n be owned by a GitHub organization, provide its name.

", "smithy.api#required": {} } }, @@ -889,17 +888,18 @@ "smithy.api#required": {} } }, - "owner": { - "target": "com.amazonaws.codestar#RepositoryOwner", + "type": { + "target": "com.amazonaws.codestar#RepositoryType", "traits": { - "smithy.api#documentation": "

The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should\n be owned by a GitHub organization, provide its name.

", + "smithy.api#documentation": "

The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.codestar#RepositoryDescription", + "token": { + "target": "com.amazonaws.codestar#GitHubPersonalToken", "traits": { - "smithy.api#documentation": "

Description for the GitHub repository to be created in AWS CodeStar. This description displays in\n GitHub after the repository is created.

" + "smithy.api#documentation": "

The GitHub user's personal access token for the GitHub repository.

", + "smithy.api#required": {} } } }, @@ -981,18 +981,18 @@ "com.amazonaws.codestar#ListProjectsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "

The continuation token to be used to return the next set of results, if the results\n cannot be returned in one response.

" - } - }, "maxResults": { "target": "com.amazonaws.codestar#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum amount of data that can be contained in a single set of results.

" } + }, + "nextToken": { + "target": "com.amazonaws.codestar#PaginationToken", + "traits": { + "smithy.api#documentation": "

The continuation token to be used to return the next set of results, if the results\n cannot be returned in one response.

" + } } } }, @@ -1040,6 +1040,13 @@ "com.amazonaws.codestar#ListResourcesRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.codestar#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum amount of data that can be contained in a single set of results.

" + } + }, "projectId": { "target": "com.amazonaws.codestar#ProjectId", "traits": { @@ -1052,13 +1059,6 @@ "traits": { "smithy.api#documentation": "

The continuation token for the next set of results, if the results cannot be returned\n in one response.

" } - }, - "maxResults": { - "target": "com.amazonaws.codestar#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum amount of data that can be contained in a single set of results.

" - } } } }, @@ -1105,16 +1105,16 @@ "com.amazonaws.codestar#ListTagsForProjectRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", + "maxResults": { + "target": "com.amazonaws.codestar#MaxResults", "traits": { + "smithy.api#box": {}, "smithy.api#documentation": "

Reserved for future use.

" } }, - "maxResults": { - "target": "com.amazonaws.codestar#MaxResults", + "nextToken": { + "target": "com.amazonaws.codestar#PaginationToken", "traits": { - "smithy.api#box": {}, "smithy.api#documentation": "

Reserved for future use.

" } }, @@ -1130,17 +1130,17 @@ "com.amazonaws.codestar#ListTagsForProjectResult": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.codestar#Tags", - "traits": { - "smithy.api#documentation": "

The tags for the project.

" - } - }, "nextToken": { "target": "com.amazonaws.codestar#PaginationToken", "traits": { "smithy.api#documentation": "

Reserved for future use.

" } + }, + "tags": { + "target": "com.amazonaws.codestar#Tags", + "traits": { + "smithy.api#documentation": "

The tags for the project.

" + } } } }, @@ -1170,6 +1170,12 @@ "com.amazonaws.codestar#ListTeamMembersRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.codestar#PaginationToken", + "traits": { + "smithy.api#documentation": "

The continuation token for the next set of results, if the results cannot be returned\n in one response.

" + } + }, "maxResults": { "target": "com.amazonaws.codestar#MaxResults", "traits": { @@ -1183,12 +1189,6 @@ "smithy.api#documentation": "

The ID of the project for which you want to list team members.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "

The continuation token for the next set of results, if the results cannot be returned\n in one response.

" - } } } }, @@ -1251,18 +1251,18 @@ "com.amazonaws.codestar#ListUserProfilesResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.codestar#PaginationToken", - "traits": { - "smithy.api#documentation": "

The continuation token to use when requesting the next set of results, if there are\n more results to be returned.

" - } - }, "userProfiles": { "target": "com.amazonaws.codestar#UserProfilesList", "traits": { "smithy.api#documentation": "

All the user profiles configured in AWS CodeStar for an AWS account.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.codestar#PaginationToken", + "traits": { + "smithy.api#documentation": "

The continuation token to use when requesting the next set of results, if there are\n more results to be returned.

" + } } } }, @@ -1386,18 +1386,18 @@ "com.amazonaws.codestar#ProjectStatus": { "type": "structure", "members": { + "reason": { + "target": "com.amazonaws.codestar#Reason", + "traits": { + "smithy.api#documentation": "

In the case of a project creation or deletion failure, a reason for the\n failure.

" + } + }, "state": { "target": "com.amazonaws.codestar#State", "traits": { "smithy.api#documentation": "

The phase of completion for a project creation or deletion.

", "smithy.api#required": {} } - }, - "reason": { - "target": "com.amazonaws.codestar#Reason", - "traits": { - "smithy.api#documentation": "

In the case of a project creation or deletion failure, a reason for the\n failure.

" - } } }, "traits": { @@ -1407,17 +1407,17 @@ "com.amazonaws.codestar#ProjectSummary": { "type": "structure", "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", - "traits": { - "smithy.api#documentation": "

The ID of the project.

" - } - }, "projectArn": { "target": "com.amazonaws.codestar#ProjectArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

" } + }, + "projectId": { + "target": "com.amazonaws.codestar#ProjectId", + "traits": { + "smithy.api#documentation": "

The ID of the project.

" + } } }, "traits": { @@ -1681,11 +1681,11 @@ "com.amazonaws.codestar#TeamMember": { "type": "structure", "members": { - "projectRole": { - "target": "com.amazonaws.codestar#Role", + "remoteAccessAllowed": { + "target": "com.amazonaws.codestar#RemoteAccessAllowed", "traits": { - "smithy.api#documentation": "

The role assigned to the user in the project. Project roles have different levels of\n access. For more information, see Working with\n Teams in the AWS CodeStar User Guide.

", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

Whether the user is allowed to remotely access project resources using an SSH\n public/private key pair.

" } }, "userArn": { @@ -1695,11 +1695,11 @@ "smithy.api#required": {} } }, - "remoteAccessAllowed": { - "target": "com.amazonaws.codestar#RemoteAccessAllowed", + "projectRole": { + "target": "com.amazonaws.codestar#Role", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

Whether the user is allowed to remotely access project resources using an SSH\n public/private key pair.

" + "smithy.api#documentation": "

The role assigned to the user in the project. Project roles have different levels of\n access. For more information, see Working with\n Teams in the AWS CodeStar User Guide.

", + "smithy.api#required": {} } } }, @@ -1778,11 +1778,10 @@ "com.amazonaws.codestar#Toolchain": { "type": "structure", "members": { - "source": { - "target": "com.amazonaws.codestar#ToolchainSource", + "roleArn": { + "target": "com.amazonaws.codestar#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the toolchain template file provided with the\n project request is stored. AWS CodeStar retrieves the file during project creation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The service role ARN for AWS CodeStar to use for the toolchain template during stack\n provisioning.

" } }, "stackParameters": { @@ -1791,10 +1790,11 @@ "smithy.api#documentation": "

The list of parameter overrides to be passed into the toolchain template during stack\n provisioning, if any.

" } }, - "roleArn": { - "target": "com.amazonaws.codestar#RoleArn", + "source": { + "target": "com.amazonaws.codestar#ToolchainSource", "traits": { - "smithy.api#documentation": "

The service role ARN for AWS CodeStar to use for the toolchain template during stack\n provisioning.

" + "smithy.api#documentation": "

The Amazon S3 location where the toolchain template file provided with the\n project request is stored. AWS CodeStar retrieves the file during project creation.

", + "smithy.api#required": {} } } }, @@ -1846,17 +1846,17 @@ "com.amazonaws.codestar#UntagProjectRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.codestar#TagKeys", + "id": { + "target": "com.amazonaws.codestar#ProjectId", "traits": { - "smithy.api#documentation": "

The tags to remove from the project.

", + "smithy.api#documentation": "

The ID of the project to remove tags from.

", "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.codestar#ProjectId", + "tags": { + "target": "com.amazonaws.codestar#TagKeys", "traits": { - "smithy.api#documentation": "

The ID of the project to remove tags from.

", + "smithy.api#documentation": "

The tags to remove from the project.

", "smithy.api#required": {} } } @@ -1952,11 +1952,11 @@ "com.amazonaws.codestar#UpdateTeamMemberRequest": { "type": "structure", "members": { - "projectId": { - "target": "com.amazonaws.codestar#ProjectId", + "remoteAccessAllowed": { + "target": "com.amazonaws.codestar#RemoteAccessAllowed", "traits": { - "smithy.api#documentation": "

The ID of the project.

", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

Whether a team member is allowed to remotely access project resources using the SSH\n public key associated with the user's profile. Even if this is set to True, the user must\n associate a public key with their profile before the user can access resources.

" } }, "projectRole": { @@ -1972,11 +1972,11 @@ "smithy.api#required": {} } }, - "remoteAccessAllowed": { - "target": "com.amazonaws.codestar#RemoteAccessAllowed", + "projectId": { + "target": "com.amazonaws.codestar#ProjectId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

Whether a team member is allowed to remotely access project resources using the SSH\n public key associated with the user's profile. Even if this is set to True, the user must\n associate a public key with their profile before the user can access resources.

" + "smithy.api#documentation": "

The ID of the project.

", + "smithy.api#required": {} } } } @@ -2028,11 +2028,10 @@ "com.amazonaws.codestar#UpdateUserProfileRequest": { "type": "structure", "members": { - "userArn": { - "target": "com.amazonaws.codestar#UserArn", + "emailAddress": { + "target": "com.amazonaws.codestar#Email", "traits": { - "smithy.api#documentation": "

The name that will be displayed as the friendly name for the user in AWS\n CodeStar.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The email address that is displayed as part of the user's profile in AWS\n CodeStar.

" } }, "sshPublicKey": { @@ -2047,10 +2046,11 @@ "smithy.api#documentation": "

The name that is displayed as the friendly name for the user in AWS CodeStar.

" } }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", + "userArn": { + "target": "com.amazonaws.codestar#UserArn", "traits": { - "smithy.api#documentation": "

The email address that is displayed as part of the user's profile in AWS\n CodeStar.

" + "smithy.api#documentation": "

The name that will be displayed as the friendly name for the user in AWS\n CodeStar.

", + "smithy.api#required": {} } } } @@ -2058,22 +2058,23 @@ "com.amazonaws.codestar#UpdateUserProfileResult": { "type": "structure", "members": { - "displayName": { - "target": "com.amazonaws.codestar#UserProfileDisplayName", + "createdTimestamp": { + "target": "com.amazonaws.codestar#CreatedTimestamp", "traits": { - "smithy.api#documentation": "

The name that is displayed as the friendly name for the user in AWS CodeStar.

" + "smithy.api#documentation": "

The date the user profile was created, in timestamp format.

" } }, - "emailAddress": { - "target": "com.amazonaws.codestar#Email", + "userArn": { + "target": "com.amazonaws.codestar#UserArn", "traits": { - "smithy.api#documentation": "

The email address that is displayed as part of the user's profile in AWS\n CodeStar.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user in IAM.

", + "smithy.api#required": {} } }, - "createdTimestamp": { - "target": "com.amazonaws.codestar#CreatedTimestamp", + "emailAddress": { + "target": "com.amazonaws.codestar#Email", "traits": { - "smithy.api#documentation": "

The date the user profile was created, in timestamp format.

" + "smithy.api#documentation": "

The email address that is displayed as part of the user's profile in AWS\n CodeStar.

" } }, "lastModifiedTimestamp": { @@ -2088,11 +2089,10 @@ "smithy.api#documentation": "

The SSH public key associated with the user in AWS CodeStar. This is the public portion of the\n public/private keypair the user can use to access project resources if a project owner allows\n the user remote access to those resources.

" } }, - "userArn": { - "target": "com.amazonaws.codestar#UserArn", + "displayName": { + "target": "com.amazonaws.codestar#UserProfileDisplayName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user in IAM.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name that is displayed as the friendly name for the user in AWS CodeStar.

" } } } @@ -2147,6 +2147,12 @@ "com.amazonaws.codestar#UserProfileSummary": { "type": "structure", "members": { + "userArn": { + "target": "com.amazonaws.codestar#UserArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user in IAM.

" + } + }, "emailAddress": { "target": "com.amazonaws.codestar#Email", "traits": { @@ -2159,12 +2165,6 @@ "smithy.api#documentation": "

The display name of a user in AWS CodeStar. For example, this could be set to both first and\n last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate\n the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the\n display name, the first character that appears after the space will be used as the second\n character in the user initial icon. The initial icon displays a maximum of two characters, so\n a display name with more than one space (for example \"Mary Jane Major\") would generate an\n initial icon using the first character and the first character after the space (\"MJ\", not\n \"MM\").

" } }, - "userArn": { - "target": "com.amazonaws.codestar#UserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user in IAM.

" - } - }, "sshPublicKey": { "target": "com.amazonaws.codestar#SshPublicKey", "traits": { diff --git a/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json b/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json index dd591389d218..c86083f5f1f0 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity-provider.2016-04-18.json @@ -342,7 +342,7 @@ "sdkId": "Cognito Identity Provider", "arnNamespace": "cognito-idp", "cloudFormationName": "Cognito", - "cloudTrailEventSource": "model.idp.identity.cognito.amazonaws.com" + "cloudTrailEventSource": "cognitoidentityprovider.amazonaws.com" }, "aws.auth#sigv4": { "name": "cognito-idp" @@ -355,6 +355,16 @@ } } }, + "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 86400 + } + } + }, "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType": { "type": "structure", "members": { @@ -375,17 +385,17 @@ "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType": { "type": "structure", "members": { - "Notify": { - "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionNotifyType", + "EventAction": { + "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType", "traits": { - "smithy.api#documentation": "

Flag specifying whether to send a notification.

", + "smithy.api#documentation": "

The event action.

\n ", "smithy.api#required": {} } }, - "EventAction": { - "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType", + "Notify": { + "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionNotifyType", "traits": { - "smithy.api#documentation": "

The event action.

\n ", + "smithy.api#documentation": "

Flag specifying whether to send a notification.

", "smithy.api#required": {} } } @@ -403,16 +413,16 @@ "smithy.api#documentation": "

Action to take for a high risk.

" } }, - "MediumAction": { + "LowAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType", "traits": { - "smithy.api#documentation": "

Action to take for a medium risk.

" + "smithy.api#documentation": "

Action to take for a low risk.

" } }, - "LowAction": { + "MediumAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType", "traits": { - "smithy.api#documentation": "

Action to take for a low risk.

" + "smithy.api#documentation": "

Action to take for a medium risk.

" } } }, @@ -446,18 +456,18 @@ "com.amazonaws.cognitoidentityprovider#AccountTakeoverRiskConfigurationType": { "type": "structure", "members": { - "NotifyConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#NotifyConfigurationType", - "traits": { - "smithy.api#documentation": "

The notify configuration used to construct email notifications.

" - } - }, "Actions": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionsType", "traits": { "smithy.api#documentation": "

Account takeover risk configuration actions

", "smithy.api#required": {} } + }, + "NotifyConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#NotifyConfigurationType", + "traits": { + "smithy.api#documentation": "

The notify configuration used to construct email notifications.

" + } } }, "traits": { @@ -499,17 +509,17 @@ "com.amazonaws.cognitoidentityprovider#AddCustomAttributesRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "CustomAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#CustomAttributesListType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to add custom attributes.

", + "smithy.api#documentation": "

An array of custom attributes, such as Mutable and Name.

", "smithy.api#required": {} } }, - "CustomAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#CustomAttributesListType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

An array of custom attributes, such as Mutable and Name.

", + "smithy.api#documentation": "

The user pool ID for the user pool where you want to add custom attributes.

", "smithy.api#required": {} } } @@ -557,10 +567,10 @@ "com.amazonaws.cognitoidentityprovider#AdminAddUserToGroupRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

", + "smithy.api#documentation": "

The username for the user.

", "smithy.api#required": {} } }, @@ -571,10 +581,10 @@ "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The username for the user.

", + "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } } @@ -630,17 +640,17 @@ "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUpRequest": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user name for which you want to confirm user registration.

", + "smithy.api#documentation": "

The user pool ID for which you want to confirm user registration.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user pool ID for which you want to confirm user registration.

", + "smithy.api#documentation": "

The user name for which you want to confirm user registration.

", "smithy.api#required": {} } }, @@ -721,7 +731,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new user in the specified user pool.

\n

If MessageAction is not set, the default is to send a welcome message via\n email or phone (SMS).

\n \n

This message is based on a template that you configured in your call to or . This\n template includes your custom sign-up instructions and placeholders for user name\n and temporary password.

\n \n

Alternatively, you can call AdminCreateUser with “SUPPRESS” for the\n MessageAction parameter, and Amazon Cognito will not send any email.

\n

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.

\n

AdminCreateUser requires developer credentials.

" + "smithy.api#documentation": "

Creates a new user in the specified user pool.

\n

If MessageAction is not set, the default is to send a welcome message via\n email or phone (SMS).

\n

This message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and placeholders \n for user name and temporary password.

\n

Alternatively, you can call AdminCreateUser with “SUPPRESS” for the\n MessageAction parameter, and Amazon Cognito will not send any email.

\n

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.

\n

\n AdminCreateUser requires developer credentials.

" } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType": { @@ -733,17 +743,17 @@ "smithy.api#documentation": "

Set to True if only the administrator is allowed to create user profiles.\n Set to False if users can sign themselves up via an app.

" } }, - "UnusedAccountValidityDays": { - "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserUnusedAccountValidityDaysType", - "traits": { - "smithy.api#documentation": "

The user account expiration limit, in days, after which the account is no longer\n usable. To reset the account after that time limit, you must call\n AdminCreateUser again, specifying \"RESEND\" for the\n MessageAction parameter. The default value for this parameter is 7.

\n \n

If you set a value for TemporaryPasswordValidityDays in\n PasswordPolicy, that value will be used and\n UnusedAccountValidityDays will be deprecated for that user pool.\n

\n " - } - }, "InviteMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#MessageTemplateType", "traits": { "smithy.api#documentation": "

The message template to be used for the welcome message to new users.

\n

See also Customizing User Invitation Messages.

" } + }, + "UnusedAccountValidityDays": { + "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserUnusedAccountValidityDaysType", + "traits": { + "smithy.api#documentation": "

The user account expiration limit, in days, after which the account is no longer\n usable. To reset the account after that time limit, you must call\n AdminCreateUser again, specifying \"RESEND\" for the\n MessageAction parameter. The default value for this parameter is 7.

\n \n

If you set a value for TemporaryPasswordValidityDays in\n PasswordPolicy, that value will be used and\n UnusedAccountValidityDays will be deprecated for that user pool.\n

\n " + } } }, "traits": { @@ -753,16 +763,24 @@ "com.amazonaws.cognitoidentityprovider#AdminCreateUserRequest": { "type": "structure", "members": { - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is\n assigned to the pre sign-up trigger. When Amazon Cognito invokes\n this function, it passes a JSON payload, which the function receives as input. This\n payload contains a clientMetadata attribute, which provides the data that\n you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + "smithy.api#documentation": "

The username for the user. Must be unique within the user pool. Must be a UTF-8 string\n between 1 and 128 characters. After the user is created, the username cannot be\n changed.

", + "smithy.api#required": {} } }, - "ForceAliasCreation": { - "target": "com.amazonaws.cognitoidentityprovider#ForceAliasCreation", + "DesiredDeliveryMediums": { + "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumListType", "traits": { - "smithy.api#documentation": "

This parameter is only used if the phone_number_verified or\n email_verified attribute is set to True. Otherwise, it is\n ignored.

\n

If this parameter is set to True and the phone number or email address\n specified in the UserAttributes parameter already exists as an alias with a different\n user, the API call will migrate the alias from the previous user to the newly created\n user. The previous user will no longer be able to log in using that alias.

\n

If this parameter is set to False, the API throws an\n AliasExistsException error if the alias already exists. The default\n value is False.

" + "smithy.api#documentation": "

Specify \"EMAIL\" if email will be used to send the welcome message.\n Specify \"SMS\" if the phone number will be used. The default value is\n \"SMS\". More than one value can be specified.

" + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID for the user pool where the user will be created.

", + "smithy.api#required": {} } }, "MessageAction": { @@ -777,36 +795,28 @@ "smithy.api#documentation": "

The user's validation data. This is an array of name-value pairs that contain user\n attributes and attribute values that you can use for custom validation, such as\n restricting the types of user accounts that can be registered. For example, you might\n choose to allow or disallow user sign-up based on the user's domain.

\n

To configure custom validation, you must create a Pre Sign-up Lambda trigger for the\n user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger\n receives the validation data and uses it in the validation process.

\n

The user's validation data is not persisted.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "TemporaryPassword": { + "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where the user will be created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.

\n

The temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page along with a new password to\n be used in all future sign-ins.

\n

This parameter is not required. If you do not specify a value, Amazon Cognito\n generates one for you.

\n

The temporary password can only be used until the user account expiration limit that\n you specified when you created the user pool. To reset the account after that time\n limit, you must call AdminCreateUser again, specifying\n \"RESEND\" for the MessageAction parameter.

" } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "ForceAliasCreation": { + "target": "com.amazonaws.cognitoidentityprovider#ForceAliasCreation", "traits": { - "smithy.api#documentation": "

The username for the user. Must be unique within the user pool. Must be a UTF-8 string\n between 1 and 128 characters. After the user is created, the username cannot be\n changed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

This parameter is only used if the phone_number_verified or\n email_verified attribute is set to True. Otherwise, it is\n ignored.

\n

If this parameter is set to True and the phone number or email address\n specified in the UserAttributes parameter already exists as an alias with a different\n user, the API call will migrate the alias from the previous user to the newly created\n user. The previous user will no longer be able to log in using that alias.

\n

If this parameter is set to False, the API throws an\n AliasExistsException error if the alias already exists. The default\n value is False.

" } }, "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

An array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than Username. However, any attributes that you specify as required\n (in or in the Attributes tab of the console) must be supplied either by you (in your\n call to AdminCreateUser) or by the user (when he or she signs up in\n response to your welcome message).

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. This can be done in your call to AdminCreateUser or in the\n Users tab of the Amazon Cognito console for\n managing your user pools.

\n

In your call to AdminCreateUser, you can set the\n email_verified attribute to True, and you can set the\n phone_number_verified attribute to True. (You can also do\n this by calling .)

\n " - } - }, - "TemporaryPassword": { - "target": "com.amazonaws.cognitoidentityprovider#PasswordType", - "traits": { - "smithy.api#documentation": "

The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.

\n

The temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page along with a new password to\n be used in all future sign-ins.

\n

This parameter is not required. If you do not specify a value, Amazon Cognito\n generates one for you.

\n

The temporary password can only be used until the user account expiration limit that\n you specified when you created the user pool. To reset the account after that time\n limit, you must call AdminCreateUser again, specifying\n \"RESEND\" for the MessageAction parameter.

" + "smithy.api#documentation": "

An array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than Username. However, any attributes that you specify as required\n (when creating a user pool or in the Attributes tab of the console) must be supplied either by you (in your\n call to AdminCreateUser) or by the user (when he or she signs up in\n response to your welcome message).

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. This can be done in your call to AdminCreateUser or in the\n Users tab of the Amazon Cognito console for\n managing your user pools.

\n

In your call to AdminCreateUser, you can set the\n email_verified attribute to True, and you can set the\n phone_number_verified attribute to True. (You can also do\n this by calling AdminUpdateUserAttributes.)

\n " } }, - "DesiredDeliveryMediums": { - "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumListType", + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

Specify \"EMAIL\" if email will be used to send the welcome message.\n Specify \"SMS\" if the phone number will be used. The default value is\n \"SMS\". More than one value can be specified.

" + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is\n assigned to the pre sign-up trigger. When Amazon Cognito invokes\n this function, it passes a JSON payload, which the function receives as input. This\n payload contains a clientMetadata attribute, which provides the data that\n you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " } } }, @@ -901,10 +911,10 @@ "com.amazonaws.cognitoidentityprovider#AdminDeleteUserAttributesRequest": { "type": "structure", "members": { - "UserAttributeNames": { - "target": "com.amazonaws.cognitoidentityprovider#AttributeNameListType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

An array of strings representing the user attribute names you wish to delete.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

", + "smithy.api#documentation": "

The user name of the user from which you would like to delete attributes.

", "smithy.api#required": {} } }, @@ -915,10 +925,10 @@ "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserAttributeNames": { + "target": "com.amazonaws.cognitoidentityprovider#AttributeNameListType", "traits": { - "smithy.api#documentation": "

The user name of the user from which you would like to delete attributes.

", + "smithy.api#documentation": "

An array of strings representing the user attribute names you wish to delete.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

", "smithy.api#required": {} } } @@ -988,23 +998,23 @@ } ], "traits": { - "smithy.api#documentation": "

Disables the user from signing in with the specified external (SAML or social)\n identity provider. If the user to disable is a Cognito User Pools native username +\n password user, they are not permitted to use their password to sign-in. If the user to\n disable is a linked external IdP user, any link between that user and an existing user\n is removed. The next time the external user (no longer attached to the previously linked\n DestinationUser) signs in, they must create a new user account. See\n .

\n

This action is enabled only for admin access and requires developer\n credentials.

\n

The ProviderName must match the value specified when creating an IdP for\n the pool.

\n

To disable a native username + password user, the ProviderName value must\n be Cognito and the ProviderAttributeName must be\n Cognito_Subject, with the ProviderAttributeValue being the\n name that is used in the user pool for the user.

\n

The ProviderAttributeName must always be Cognito_Subject for\n social identity providers. The ProviderAttributeValue must always be the\n exact subject that was used when the user was originally linked as a source user.

\n

For de-linking a SAML identity, there are two scenarios. If the linked identity has\n not yet been used to sign-in, the ProviderAttributeName and\n ProviderAttributeValue must be the same values that were used for the\n SourceUser when the identities were originally linked in the call. (If the linking was done with\n ProviderAttributeName set to Cognito_Subject, the same\n applies here). However, if the user has already signed in, the\n ProviderAttributeName must be Cognito_Subject and\n ProviderAttributeValue must be the subject of the SAML\n assertion.

" + "smithy.api#documentation": "

Disables the user from signing in with the specified external (SAML or social)\n identity provider. If the user to disable is a Cognito User Pools native username +\n password user, they are not permitted to use their password to sign-in. If the user to\n disable is a linked external IdP user, any link between that user and an existing user\n is removed. The next time the external user (no longer attached to the previously linked\n DestinationUser) signs in, they must create a new user account. See\n AdminLinkProviderForUser.

\n

This action is enabled only for admin access and requires developer\n credentials.

\n

The ProviderName must match the value specified when creating an IdP for\n the pool.

\n

To disable a native username + password user, the ProviderName value must\n be Cognito and the ProviderAttributeName must be\n Cognito_Subject, with the ProviderAttributeValue being the\n name that is used in the user pool for the user.

\n

The ProviderAttributeName must always be Cognito_Subject for\n social identity providers. The ProviderAttributeValue must always be the\n exact subject that was used when the user was originally linked as a source user.

\n

For de-linking a SAML identity, there are two scenarios. If the linked identity has\n not yet been used to sign-in, the ProviderAttributeName and\n ProviderAttributeValue must be the same values that were used for the\n SourceUser when the identities were originally linked using \n AdminLinkProviderForUser call. (If the linking was done with\n ProviderAttributeName set to Cognito_Subject, the same\n applies here). However, if the user has already signed in, the\n ProviderAttributeName must be Cognito_Subject and\n ProviderAttributeValue must be the subject of the SAML\n assertion.

" } }, "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUserRequest": { "type": "structure", "members": { - "User": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The user to be disabled.

", + "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", + "User": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

", + "smithy.api#documentation": "

The user to be disabled.

", "smithy.api#required": {} } } @@ -1049,17 +1059,17 @@ "com.amazonaws.cognitoidentityprovider#AdminDisableUserRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to disable the user.

", + "smithy.api#documentation": "

The user name of the user you wish to disable.

", "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user name of the user you wish to disable.

", + "smithy.api#documentation": "

The user pool ID for the user pool where you want to disable the user.

", "smithy.api#required": {} } } @@ -1110,17 +1120,17 @@ "com.amazonaws.cognitoidentityprovider#AdminEnableUserRequest": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user name of the user you wish to enable.

", + "smithy.api#documentation": "

The user pool ID for the user pool where you want to enable the user.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to enable the user.

", + "smithy.api#documentation": "

The user name of the user you wish to enable.

", "smithy.api#required": {} } } @@ -1232,17 +1242,17 @@ "com.amazonaws.cognitoidentityprovider#AdminGetDeviceRequest": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "DeviceKey": { + "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { - "smithy.api#documentation": "

The user name.

", + "smithy.api#documentation": "

The device key.

", "smithy.api#required": {} } }, - "DeviceKey": { - "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The device key.

", + "smithy.api#documentation": "

The user name.

", "smithy.api#required": {} } }, @@ -1330,23 +1340,10 @@ "com.amazonaws.cognitoidentityprovider#AdminGetUserResponse": { "type": "structure", "members": { - "PreferredMfaSetting": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

The user's preferred MFA setting.

" - } - }, - "UserCreateDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", - "traits": { - "smithy.api#documentation": "

The date the user was created.

" - } - }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "MFAOptions": { + "target": "com.amazonaws.cognitoidentityprovider#MFAOptionListType", "traits": { - "smithy.api#documentation": "

The user name of the user about whom you are receiving information.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about TOTP\n software token MFA configurations. To look up information about either type of MFA\n configuration, use UserMFASettingList instead.

" } }, "UserMFASettingList": { @@ -1355,10 +1352,10 @@ "smithy.api#documentation": "

The MFA options that are enabled for the user. The possible values in this list are\n SMS_MFA and SOFTWARE_TOKEN_MFA.

" } }, - "Enabled": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "UserCreateDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

Indicates that the status is enabled.

" + "smithy.api#documentation": "

The date the user was created.

" } }, "UserAttributes": { @@ -1367,16 +1364,23 @@ "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

" } }, - "UserStatus": { - "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", + "Enabled": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

The user status. Can be one of the following:

\n " + "smithy.api#documentation": "

Indicates that the status is enabled.

" } }, - "MFAOptions": { - "target": "com.amazonaws.cognitoidentityprovider#MFAOptionListType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "traits": { + "smithy.api#documentation": "

The user name of the user about whom you are receiving information.

", + "smithy.api#required": {} + } + }, + "PreferredMfaSetting": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about TOTP\n software token MFA configurations. To look up information about either type of MFA\n configuration, use the AdminGetUserResponse$UserMFASettingList\n response instead.

" + "smithy.api#documentation": "

The user's preferred MFA setting.

" } }, "UserLastModifiedDate": { @@ -1384,6 +1388,12 @@ "traits": { "smithy.api#documentation": "

The date the user was last modified.

" } + }, + "UserStatus": { + "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", + "traits": { + "smithy.api#documentation": "

The user status. Can be one of the following:

\n " + } } }, "traits": { @@ -1452,18 +1462,10 @@ "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthRequest": { "type": "structure", "members": { - "AuthFlow": { - "target": "com.amazonaws.cognitoidentityprovider#AuthFlowType", - "traits": { - "smithy.api#documentation": "

The authentication flow for this call to execute. The API action will depend on this\n value. For example:

\n \n

Valid values include:

\n ", - "smithy.api#required": {} - } - }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "AnalyticsMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The analytics metadata for collecting Amazon Pinpoint metrics for\n AdminInitiateAuth calls.

" } }, "ClientMetadata": { @@ -1472,10 +1474,11 @@ "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda\n functions that are specified for various triggers. The ClientMetadata value is passed as\n input to the functions for only the following triggers:

\n \n\n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON\n payload, which the function receives as input. This payload contains a\n validationData attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in\n AWS Lambda, you can process the validationData value to enhance your\n workflow for your specific needs.

\n\n

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the\n functions for the following triggers, but it does not provide the ClientMetadata value\n as input:

\n\n \n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " } }, - "AnalyticsMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", + "AuthFlow": { + "target": "com.amazonaws.cognitoidentityprovider#AuthFlowType", "traits": { - "smithy.api#documentation": "

The analytics metadata for collecting Amazon Pinpoint metrics for\n AdminInitiateAuth calls.

" + "smithy.api#documentation": "

The authentication flow for this call to execute. The API action will depend on this\n value. For example:

\n \n

Valid values include:

\n ", + "smithy.api#required": {} } }, "ContextData": { @@ -1484,10 +1487,17 @@ "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", + "smithy.api#required": {} + } + }, "AuthParameters": { "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you are invoking. The required values depend on the value\n of AuthFlow:

\n " + "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you are invoking. The required values depend on the value\n of AuthFlow:

\n " } }, "ClientId": { @@ -1505,18 +1515,18 @@ "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthResponse": { "type": "structure", "members": { - "AuthenticationResult": { - "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", - "traits": { - "smithy.api#documentation": "

The result of the authentication response. This is only returned if the caller does\n not need to pass another challenge. If the caller does need to pass another challenge\n before it gets tokens, ChallengeName, ChallengeParameters, and\n Session are returned.

" - } - }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { "smithy.api#documentation": "

The name of the challenge which you are responding to with this call. This is returned\n to you in the AdminInitiateAuth response if you need to pass another\n challenge.

\n " } }, + "AuthenticationResult": { + "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", + "traits": { + "smithy.api#documentation": "

The result of the authentication response. This is only returned if the caller does\n not need to pass another challenge. If the caller does need to pass another challenge\n before it gets tokens, ChallengeName, ChallengeParameters, and\n Session are returned.

" + } + }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { @@ -1569,12 +1579,19 @@ } ], "traits": { - "smithy.api#documentation": "

Links an existing user account in a user pool (DestinationUser) to an\n identity from an external identity provider (SourceUser) based on a\n specified attribute name and value from the external identity provider. This allows you\n to create a link from the existing user account to an external federated user identity\n that has not yet been used to sign in, so that the federated user identity can be used\n to sign in as the existing user account.

\n

For example, if there is an existing user with a username and password, this API\n links that user to a federated user identity, so that when the federated user identity\n is used, the user signs in as the existing user account.

\n \n

Because this API allows a user with an external federated identity to sign in as\n an existing user in the user pool, it is critical that it only be used with external\n identity providers and provider attributes that have been trusted by the application\n owner.

\n \n

See also .

\n

This action is enabled only for admin access and requires developer\n credentials.

" + "smithy.api#documentation": "

Links an existing user account in a user pool (DestinationUser) to an\n identity from an external identity provider (SourceUser) based on a\n specified attribute name and value from the external identity provider. This allows you\n to create a link from the existing user account to an external federated user identity\n that has not yet been used to sign in, so that the federated user identity can be used\n to sign in as the existing user account.

\n

For example, if there is an existing user with a username and password, this API\n links that user to a federated user identity, so that when the federated user identity\n is used, the user signs in as the existing user account.

\n \n

The maximum number of federated identities linked to a user is 5.

\n \n \n

Because this API allows a user with an external federated identity to sign in as\n an existing user in the user pool, it is critical that it only be used with external\n identity providers and provider attributes that have been trusted by the application\n owner.

\n \n \n

This action is enabled only for admin access and requires developer\n credentials.

" } }, "com.amazonaws.cognitoidentityprovider#AdminLinkProviderForUserRequest": { "type": "structure", "members": { + "SourceUser": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", + "traits": { + "smithy.api#documentation": "

An external identity provider account for a user who does not currently exist yet in\n the user pool. This user must be a federated user (for example, a SAML or Facebook\n user), not another native user.

\n

If the SourceUser is a federated social identity provider user (Facebook,\n Google, or Login with Amazon), you must set the ProviderAttributeName to\n Cognito_Subject. For social identity providers, the\n ProviderName will be Facebook, Google, or\n LoginWithAmazon, and Cognito will automatically parse the Facebook,\n Google, and Login with Amazon tokens for id, sub, and\n user_id, respectively. The ProviderAttributeValue for the\n user must be the same value as the id, sub, or\n user_id value found in the social identity provider token.

\n

\n

For SAML, the ProviderAttributeName can be any value that matches a claim\n in the SAML assertion. If you wish to link SAML users based on the subject of the SAML\n assertion, you should map the subject to a claim through the SAML identity provider and\n submit that claim name as the ProviderAttributeName. If you set\n ProviderAttributeName to Cognito_Subject, Cognito will\n automatically parse the default unique identifier found in the subject from the SAML\n token.

", + "smithy.api#required": {} + } + }, "DestinationUser": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { @@ -1588,13 +1605,6 @@ "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } - }, - "SourceUser": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", - "traits": { - "smithy.api#documentation": "

An external identity provider account for a user who does not currently exist yet in\n the user pool. This user must be a federated user (for example, a SAML or Facebook\n user), not another native user.

\n

If the SourceUser is a federated social identity provider user (Facebook,\n Google, or Login with Amazon), you must set the ProviderAttributeName to\n Cognito_Subject. For social identity providers, the\n ProviderName will be Facebook, Google, or\n LoginWithAmazon, and Cognito will automatically parse the Facebook,\n Google, and Login with Amazon tokens for id, sub, and\n user_id, respectively. The ProviderAttributeValue for the\n user must be the same value as the id, sub, or\n user_id value found in the social identity provider token.

\n

\n

For SAML, the ProviderAttributeName can be any value that matches a claim\n in the SAML assertion. If you wish to link SAML users based on the subject of the SAML\n assertion, you should map the subject to a claim through the SAML identity provider and\n submit that claim name as the ProviderAttributeName. If you set\n ProviderAttributeName to Cognito_Subject, Cognito will\n automatically parse the default unique identifier found in the subject from the SAML\n token.

", - "smithy.api#required": {} - } } } }, @@ -1637,11 +1647,16 @@ "com.amazonaws.cognitoidentityprovider#AdminListDevicesRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "PaginationToken": { + "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The pagination token.

" + } + }, + "Limit": { + "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", + "traits": { + "smithy.api#documentation": "

The limit of the devices request.

" } }, "Username": { @@ -1651,16 +1666,11 @@ "smithy.api#required": {} } }, - "PaginationToken": { - "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", - "traits": { - "smithy.api#documentation": "

The pagination token.

" - } - }, - "Limit": { - "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The limit of the devices request.

" + "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#required": {} } } }, @@ -1729,17 +1739,16 @@ "com.amazonaws.cognitoidentityprovider#AdminListGroupsForUserRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Limit": { + "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The limit of the request to list groups.

" } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The username for the user.

", + "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } }, @@ -1749,10 +1758,11 @@ "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } }, - "Limit": { - "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The limit of the request to list groups.

" + "smithy.api#documentation": "

The username for the user.

", + "smithy.api#required": {} } } } @@ -1760,17 +1770,17 @@ "com.amazonaws.cognitoidentityprovider#AdminListGroupsForUserResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" - } - }, "Groups": { "target": "com.amazonaws.cognitoidentityprovider#GroupListType", "traits": { "smithy.api#documentation": "

The groups that the user belongs to.

" } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } } } }, @@ -1818,12 +1828,6 @@ "com.amazonaws.cognitoidentityprovider#AdminListUserAuthEventsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", - "traits": { - "smithy.api#documentation": "

The maximum number of authentication events to return.

" - } - }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { @@ -1837,6 +1841,12 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", + "traits": { + "smithy.api#documentation": "

The maximum number of authentication events to return.

" + } + }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -1902,17 +1912,17 @@ "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "GroupName": { + "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

", + "smithy.api#documentation": "

The group name.

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The group name.

", + "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } } @@ -1974,6 +1984,12 @@ "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordRequest": { "type": "structure", "members": { + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "traits": { + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function\n that is assigned to the custom message trigger. When Amazon Cognito\n invokes this function, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your AdminResetUserPassword\n request. In your function code in AWS Lambda, you can process the\n clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + } + }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -1981,12 +1997,6 @@ "smithy.api#required": {} } }, - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", - "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function\n that is assigned to the custom message trigger. When Amazon Cognito\n invokes this function, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your AdminResetUserPassword\n request. In your function code in AWS Lambda, you can process the\n clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " - } - }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { @@ -2083,28 +2093,22 @@ "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeRequest": { "type": "structure", "members": { - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", - "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: pre sign-up,\n custom message, post authentication,\n user migration, pre token generation,\n define auth challenge, create auth\n challenge, and verify auth challenge response. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminRespondToAuthChallenge request. In your function code in AWS Lambda, you can\n process the clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " - } - }, - "ChallengeResponses": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

The value of the USERNAME attribute must be the user's actual username,\n not an alias (such as email address or phone number). To make this easier, the\n AdminInitiateAuth response includes the actual username value in the\n USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in\n your call to AdminInitiateAuth.

" + "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If InitiateAuth or RespondToAuthChallenge API call\n determines that the caller needs to go through another challenge, they return a session\n with other challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge API call.

" } }, - "ContextData": { - "target": "com.amazonaws.cognitoidentityprovider#ContextDataType", + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: pre sign-up,\n custom message, post authentication,\n user migration, pre token generation,\n define auth challenge, create auth\n challenge, and verify auth challenge response. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminRespondToAuthChallenge request. In your function code in AWS Lambda, you can\n process the clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " } }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The challenge name. For more information, see .

", + "smithy.api#documentation": "

The challenge name. For more information, see AdminInitiateAuth.

", "smithy.api#required": {} } }, @@ -2114,17 +2118,16 @@ "smithy.api#documentation": "

The analytics metadata for collecting Amazon Pinpoint metrics for\n AdminRespondToAuthChallenge calls.

" } }, - "Session": { - "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "ContextData": { + "target": "com.amazonaws.cognitoidentityprovider#ContextDataType", "traits": { - "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If InitiateAuth or RespondToAuthChallenge API call\n determines that the caller needs to go through another challenge, they return a session\n with other challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge API call.

" + "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "ChallengeResponses": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

The value of the USERNAME attribute must be the user's actual username,\n not an alias (such as email address or phone number). To make this easier, the\n AdminInitiateAuth response includes the actual username value in the\n USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in\n your call to AdminInitiateAuth.

" } }, "ClientId": { @@ -2133,6 +2136,13 @@ "smithy.api#documentation": "

The app client ID.

", "smithy.api#required": {} } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2142,28 +2152,28 @@ "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeResponse": { "type": "structure", "members": { - "ChallengeParameters": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "

The challenge parameters. For more information, see .

" + "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If the caller needs to\n go through another challenge, they return a session with other challenge parameters.\n This session should be passed as it is to the next RespondToAuthChallenge\n API call.

" } }, - "AuthenticationResult": { - "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", + "ChallengeParameters": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", "traits": { - "smithy.api#documentation": "

The result returned by the server in response to the authentication request.

" + "smithy.api#documentation": "

The challenge parameters. For more information, see AdminInitiateAuth.

" } }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the challenge. For more information, see .

" + "smithy.api#documentation": "

The name of the challenge. For more information, see AdminInitiateAuth.

" } }, - "Session": { - "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "AuthenticationResult": { + "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", "traits": { - "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If the or API call determines that the caller needs to\n go through another challenge, they return a session with other challenge parameters.\n This session should be passed as it is to the next RespondToAuthChallenge\n API call.

" + "smithy.api#documentation": "

The result returned by the server in response to the authentication request.

" } } }, @@ -2209,30 +2219,30 @@ "com.amazonaws.cognitoidentityprovider#AdminSetUserMFAPreferenceRequest": { "type": "structure", "members": { - "SMSMfaSettings": { - "target": "com.amazonaws.cognitoidentityprovider#SMSMfaSettingsType", + "SoftwareTokenMfaSettings": { + "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", "traits": { - "smithy.api#documentation": "

The SMS text message MFA settings.

" + "smithy.api#documentation": "

The time-based one-time password software token MFA settings.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#documentation": "

The user pool username or alias.

", "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool username or alias.

", + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } }, - "SoftwareTokenMfaSettings": { - "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", + "SMSMfaSettings": { + "target": "com.amazonaws.cognitoidentityprovider#SMSMfaSettingsType", "traits": { - "smithy.api#documentation": "

The time-based one-time password software token MFA settings.

" + "smithy.api#documentation": "

The SMS text message MFA settings.

" } } } @@ -2279,13 +2289,6 @@ "com.amazonaws.cognitoidentityprovider#AdminSetUserPasswordRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", - "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to set the user's password.

", - "smithy.api#required": {} - } - }, "Password": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { @@ -2293,10 +2296,11 @@ "smithy.api#required": {} } }, - "Permanent": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

\n True if the password is permanent, False if it is\n temporary.

" + "smithy.api#documentation": "

The user pool ID for the user pool where you want to set the user's password.

", + "smithy.api#required": {} } }, "Username": { @@ -2305,6 +2309,12 @@ "smithy.api#documentation": "

The user name of the user whose password you wish to set.

", "smithy.api#required": {} } + }, + "Permanent": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "traits": { + "smithy.api#documentation": "

\n True if the password is permanent, False if it is\n temporary.

" + } } } }, @@ -2338,7 +2348,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either\n type of MFA, use the AdminSetUserMFAPreference action instead.

" + "smithy.api#documentation": "

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either\n type of MFA, use AdminSetUserMFAPreference instead.

" } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserSettingsRequest": { @@ -2415,6 +2425,13 @@ "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedbackRequest": { "type": "structure", "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#required": {} + } + }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { @@ -2435,13 +2452,6 @@ "smithy.api#documentation": "

The authentication event ID.

", "smithy.api#required": {} } - }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", - "traits": { - "smithy.api#documentation": "

The user pool ID.

", - "smithy.api#required": {} - } } } }, @@ -2487,30 +2497,30 @@ "com.amazonaws.cognitoidentityprovider#AdminUpdateDeviceStatusRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", - "traits": { - "smithy.api#documentation": "

The user pool ID.

", - "smithy.api#required": {} - } - }, "DeviceRememberedStatus": { "target": "com.amazonaws.cognitoidentityprovider#DeviceRememberedStatusType", "traits": { "smithy.api#documentation": "

The status indicating whether a device has been remembered or not.

" } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "DeviceKey": { + "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { - "smithy.api#documentation": "

The user name.

", + "smithy.api#documentation": "

The device key.

", "smithy.api#required": {} } }, - "DeviceKey": { - "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The device key.

", + "smithy.api#documentation": "

The user name.

", + "smithy.api#required": {} + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } } @@ -2582,16 +2592,10 @@ "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesRequest": { "type": "structure", "members": { - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", - "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the\n function that is assigned to the custom message trigger. When\n Amazon Cognito invokes this function, it passes a JSON payload, which the function\n receives as input. This payload contains a clientMetadata attribute, which\n provides the data that you assigned to the ClientMetadata parameter in your\n AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process\n the clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " - } - }, - "UserAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

", + "smithy.api#documentation": "

The user name of the user for whom you want to update user attributes.

", "smithy.api#required": {} } }, @@ -2602,12 +2606,18 @@ "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

The user name of the user for whom you want to update user attributes.

", + "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

", "smithy.api#required": {} } + }, + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "traits": { + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the\n function that is assigned to the custom message trigger. When\n Amazon Cognito invokes this function, it passes a JSON payload, which the function\n receives as input. This payload contains a clientMetadata attribute, which\n provides the data that you assigned to the ClientMetadata parameter in your\n AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process\n the clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + } } }, "traits": { @@ -2656,17 +2666,17 @@ "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOutRequest": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user name.

", + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#documentation": "

The user name.

", "smithy.api#required": {} } } @@ -2745,36 +2755,39 @@ "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType": { "type": "structure", "members": { - "UserDataShared": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "ApplicationArn": { + "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

If UserDataShared is true, Amazon Cognito will include user\n data in the events it publishes to Amazon Pinpoint analytics.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint \n project for Pinpoint integration with the chosen User Pool Client. \n Amazon Cognito publishes events to the pinpoint project declared by the app ARN.

" + } + }, + "ExternalId": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The external ID.

" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon\n Pinpoint analytics.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon\n Pinpoint analytics.

" } }, - "ExternalId": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", + "UserDataShared": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

The external ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If UserDataShared is true, Amazon Cognito will include user\n data in the events it publishes to Amazon Pinpoint analytics.

" } }, "ApplicationId": { "target": "com.amazonaws.cognitoidentityprovider#HexStringType", "traits": { - "smithy.api#documentation": "

The application ID for an Amazon Pinpoint application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The application ID for an Amazon Pinpoint application.

" } } }, "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for a user\n pool.

\n \n

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

\n " + "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for a user\n pool.

\n \n

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1.\n In regions where Pinpoint is available, Cognito User Pools will \n support sending events to Amazon Pinpoint projects within that same region. \n

\n " } }, "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType": { @@ -2810,6 +2823,9 @@ "target": "com.amazonaws.cognitoidentityprovider#AssociateSoftwareTokenResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, @@ -2833,34 +2849,34 @@ "com.amazonaws.cognitoidentityprovider#AssociateSoftwareTokenRequest": { "type": "structure", "members": { - "Session": { - "target": "com.amazonaws.cognitoidentityprovider#SessionType", - "traits": { - "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. This allows authentication of the user as part of the MFA setup process.

" - } - }, "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "

The access token.

" } + }, + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "traits": { + "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. This allows authentication of the user as part of the MFA setup process.

" + } } } }, "com.amazonaws.cognitoidentityprovider#AssociateSoftwareTokenResponse": { "type": "structure", "members": { - "SecretCode": { - "target": "com.amazonaws.cognitoidentityprovider#SecretCodeType", - "traits": { - "smithy.api#documentation": "

A unique generated shared secret code that is used in the TOTP algorithm to generate a\n one time code.

" - } - }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. This allows authentication of the user as part of the MFA setup process.

" } + }, + "SecretCode": { + "target": "com.amazonaws.cognitoidentityprovider#SecretCodeType", + "traits": { + "smithy.api#documentation": "

A unique generated shared secret code that is used in the TOTP algorithm to generate a\n one time code.

" + } } } }, @@ -2961,40 +2977,34 @@ "com.amazonaws.cognitoidentityprovider#AuthEventType": { "type": "structure", "members": { - "EventType": { - "target": "com.amazonaws.cognitoidentityprovider#EventType", - "traits": { - "smithy.api#documentation": "

The event type.

" - } - }, - "ChallengeResponses": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponseListType", + "EventContextData": { + "target": "com.amazonaws.cognitoidentityprovider#EventContextDataType", "traits": { - "smithy.api#documentation": "

The challenge responses.

" + "smithy.api#documentation": "

The user context data captured at the time of an event request. It provides additional\n information about the client from which event the request is received.

" } }, - "EventId": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", + "EventFeedback": { + "target": "com.amazonaws.cognitoidentityprovider#EventFeedbackType", "traits": { - "smithy.api#documentation": "

The event ID.

" + "smithy.api#documentation": "

A flag specifying the user feedback captured at the time of an event request is good\n or bad.

" } }, - "EventResponse": { - "target": "com.amazonaws.cognitoidentityprovider#EventResponseType", + "EventType": { + "target": "com.amazonaws.cognitoidentityprovider#EventType", "traits": { - "smithy.api#documentation": "

The event response.

" + "smithy.api#documentation": "

The event type.

" } }, - "EventContextData": { - "target": "com.amazonaws.cognitoidentityprovider#EventContextDataType", + "EventId": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The user context data captured at the time of an event request. It provides additional\n information about the client from which event the request is received.

" + "smithy.api#documentation": "

The event ID.

" } }, - "EventFeedback": { - "target": "com.amazonaws.cognitoidentityprovider#EventFeedbackType", + "ChallengeResponses": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponseListType", "traits": { - "smithy.api#documentation": "

A flag specifying the user feedback captured at the time of an event request is good\n or bad.

" + "smithy.api#documentation": "

The challenge responses.

" } }, "CreationDate": { @@ -3008,6 +3018,12 @@ "traits": { "smithy.api#documentation": "

The event risk.

" } + }, + "EventResponse": { + "target": "com.amazonaws.cognitoidentityprovider#EventResponseType", + "traits": { + "smithy.api#documentation": "

The event response.

" + } } }, "traits": { @@ -3070,16 +3086,10 @@ "com.amazonaws.cognitoidentityprovider#AuthenticationResultType": { "type": "structure", "members": { - "TokenType": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

The token type.

" - } - }, - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "ExpiresIn": { + "target": "com.amazonaws.cognitoidentityprovider#IntegerType", "traits": { - "smithy.api#documentation": "

The access token.

" + "smithy.api#documentation": "

The expiration period of the authentication result in seconds.

" } }, "NewDeviceMetadata": { @@ -3100,10 +3110,16 @@ "smithy.api#documentation": "

The ID token.

" } }, - "ExpiresIn": { - "target": "com.amazonaws.cognitoidentityprovider#IntegerType", + "TokenType": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The expiration period of the authentication result in seconds.

" + "smithy.api#documentation": "

The token type.

" + } + }, + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

The access token.

" } } }, @@ -3239,17 +3255,17 @@ "com.amazonaws.cognitoidentityprovider#ChallengeResponseType": { "type": "structure", "members": { - "ChallengeName": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeName", - "traits": { - "smithy.api#documentation": "

The challenge name

" - } - }, "ChallengeResponse": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponse", "traits": { "smithy.api#documentation": "

The challenge response.

" } + }, + "ChallengeName": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeName", + "traits": { + "smithy.api#documentation": "

The challenge name

" + } } }, "traits": { @@ -3314,17 +3330,17 @@ "com.amazonaws.cognitoidentityprovider#ChangePasswordRequest": { "type": "structure", "members": { - "PreviousPassword": { - "target": "com.amazonaws.cognitoidentityprovider#PasswordType", + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

The old password.

", + "smithy.api#documentation": "

The access token.

", "smithy.api#required": {} } }, - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "PreviousPassword": { + "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "

The access token.

", + "smithy.api#documentation": "

The old password.

", "smithy.api#required": {} } }, @@ -3412,12 +3428,6 @@ "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", - "traits": { - "smithy.api#documentation": "

The attribute name.

" - } - }, "Destination": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { @@ -3429,6 +3439,12 @@ "traits": { "smithy.api#documentation": "

The delivery medium (email message or phone number).

" } + }, + "AttributeName": { + "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", + "traits": { + "smithy.api#documentation": "

The attribute name.

" + } } }, "traits": { @@ -3604,12 +3620,6 @@ "smithy.api#required": {} } }, - "DeviceName": { - "target": "com.amazonaws.cognitoidentityprovider#DeviceNameType", - "traits": { - "smithy.api#documentation": "

The device name.

" - } - }, "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { @@ -3617,6 +3627,12 @@ "smithy.api#required": {} } }, + "DeviceName": { + "target": "com.amazonaws.cognitoidentityprovider#DeviceNameType", + "traits": { + "smithy.api#documentation": "

The device name.

" + } + }, "DeviceSecretVerifierConfig": { "target": "com.amazonaws.cognitoidentityprovider#DeviceSecretVerifierConfigType", "traits": { @@ -3706,10 +3722,17 @@ "com.amazonaws.cognitoidentityprovider#ConfirmForgotPasswordRequest": { "type": "structure", "members": { - "SecretHash": { - "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.

" + "smithy.api#documentation": "

The user name of the user for whom you want to enter a code to retrieve a forgotten\n password.

", + "smithy.api#required": {} + } + }, + "UserContextData": { + "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", + "traits": { + "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } }, "ClientId": { @@ -3719,6 +3742,12 @@ "smithy.api#required": {} } }, + "SecretHash": { + "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", + "traits": { + "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.

" + } + }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { @@ -3728,23 +3757,10 @@ "ConfirmationCode": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmationCodeType", "traits": { - "smithy.api#documentation": "

The confirmation code sent by a user's request to retrieve a forgotten password. For\n more information, see

", - "smithy.api#required": {} - } - }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", - "traits": { - "smithy.api#documentation": "

The user name of the user for whom you want to enter a code to retrieve a forgotten\n password.

", + "smithy.api#documentation": "

The confirmation code sent by a user's request to retrieve a forgotten password. For\n more information, see ForgotPassword.

", "smithy.api#required": {} } }, - "UserContextData": { - "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", - "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" - } - }, "Password": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { @@ -3831,16 +3847,18 @@ "com.amazonaws.cognitoidentityprovider#ConfirmSignUpRequest": { "type": "structure", "members": { - "ForceAliasCreation": { - "target": "com.amazonaws.cognitoidentityprovider#ForceAliasCreation", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

Boolean to be specified to force user confirmation irrespective of existing alias. By\n default set to False. If this parameter is set to True and the\n phone number/email used for sign up confirmation already exists as an alias with a\n different user, the API call will migrate the alias from the previous user to the newly\n created user being confirmed. If set to False, the API will throw an\n AliasExistsException error.

" + "smithy.api#documentation": "

The user name of the user whose registration you wish to confirm.

", + "smithy.api#required": {} } }, - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito\n invokes this function, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + "smithy.api#documentation": "

The ID of the app client associated with the user pool.

", + "smithy.api#required": {} } }, "SecretHash": { @@ -3849,13 +3867,6 @@ "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.

" } }, - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", - "traits": { - "smithy.api#documentation": "

The ID of the app client associated with the user pool.

", - "smithy.api#required": {} - } - }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { @@ -3869,18 +3880,23 @@ "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", - "traits": { - "smithy.api#documentation": "

The user name of the user whose registration you wish to confirm.

", - "smithy.api#required": {} - } - }, "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for\n ConfirmSignUp calls.

" } + }, + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "traits": { + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito\n invokes this function, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + } + }, + "ForceAliasCreation": { + "target": "com.amazonaws.cognitoidentityprovider#ForceAliasCreation", + "traits": { + "smithy.api#documentation": "

Boolean to be specified to force user confirmation irrespective of existing alias. By\n default set to False. If this parameter is set to True and the\n phone number/email used for sign up confirmation already exists as an alias with a\n different user, the API call will migrate the alias from the previous user to the newly\n created user being confirmed. If set to False, the API will throw an\n AliasExistsException error.

" + } } }, "traits": { @@ -3907,6 +3923,13 @@ "com.amazonaws.cognitoidentityprovider#ContextDataType": { "type": "structure", "members": { + "ServerName": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

Your server endpoint where this API is invoked.

", + "smithy.api#required": {} + } + }, "HttpHeaders": { "target": "com.amazonaws.cognitoidentityprovider#HttpHeaderList", "traits": { @@ -3920,24 +3943,17 @@ "smithy.api#documentation": "

Encoded data containing device fingerprinting details, collected using the Amazon\n Cognito context data collection library.

" } }, - "IpAddress": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

Source IP address of your user.

", - "smithy.api#required": {} - } - }, - "ServerName": { + "ServerPath": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

Your server endpoint where this API is invoked.

", + "smithy.api#documentation": "

Your server path where this API is invoked.

", "smithy.api#required": {} } }, - "ServerPath": { + "IpAddress": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

Your server path where this API is invoked.

", + "smithy.api#documentation": "

Source IP address of your user.

", "smithy.api#required": {} } } @@ -3984,12 +4000,6 @@ "com.amazonaws.cognitoidentityprovider#CreateGroupRequest": { "type": "structure", "members": { - "Precedence": { - "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", - "traits": { - "smithy.api#documentation": "

A nonnegative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence values take precedence over\n groups with higher or null Precedence values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN will be\n used in the cognito:roles and cognito:preferred_role claims in\n the user's tokens.

\n

Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim is\n not set in users' tokens.

\n

The default Precedence value is null.

" - } - }, "GroupName": { "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { @@ -3997,6 +4007,12 @@ "smithy.api#required": {} } }, + "Precedence": { + "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", + "traits": { + "smithy.api#documentation": "

A nonnegative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence values take precedence over\n groups with higher or null Precedence values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN will be\n used in the cognito:roles and cognito:preferred_role claims in\n the user's tokens.

\n

Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim is\n not set in users' tokens.

\n

The default Precedence value is null.

" + } + }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -4067,17 +4083,10 @@ "com.amazonaws.cognitoidentityprovider#CreateIdentityProviderRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", - "traits": { - "smithy.api#documentation": "

The user pool ID.

", - "smithy.api#required": {} - } - }, - "ProviderType": { - "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", + "ProviderName": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderNameTypeV1", "traits": { - "smithy.api#documentation": "

The identity provider type.

", + "smithy.api#documentation": "

The identity provider name.

", "smithy.api#required": {} } }, @@ -4093,17 +4102,24 @@ "smithy.api#documentation": "

A list of identity provider identifiers.

" } }, - "ProviderName": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderNameTypeV1", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The identity provider name.

", + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } }, "ProviderDetails": { "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", "traits": { - "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys\n for each identity provider type.

\n ", + "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys\n for each identity provider type.

\n ", + "smithy.api#required": {} + } + }, + "ProviderType": { + "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", + "traits": { + "smithy.api#documentation": "

The identity provider type.

", "smithy.api#required": {} } } @@ -4156,10 +4172,10 @@ "com.amazonaws.cognitoidentityprovider#CreateResourceServerRequest": { "type": "structure", "members": { - "Identifier": { - "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", + "Name": { + "target": "com.amazonaws.cognitoidentityprovider#ResourceServerNameType", "traits": { - "smithy.api#documentation": "

A unique resource server identifier for the resource server. This could be an HTTPS\n endpoint where the resource server is located. For example,\n https://my-weather-api.example.com.

", + "smithy.api#documentation": "

A friendly name for the resource server.

", "smithy.api#required": {} } }, @@ -4169,17 +4185,17 @@ "smithy.api#documentation": "

A list of scopes. Each scope is map, where the keys are name and\n description.

" } }, - "Name": { - "target": "com.amazonaws.cognitoidentityprovider#ResourceServerNameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

A friendly name for the resource server.

", + "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Identifier": { + "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

", + "smithy.api#documentation": "

A unique resource server identifier for the resource server. This could be an HTTPS\n endpoint where the resource server is located. For example,\n https://my-weather-api.example.com.

", "smithy.api#required": {} } } @@ -4357,42 +4373,40 @@ "com.amazonaws.cognitoidentityprovider#CreateUserPoolClientRequest": { "type": "structure", "members": { - "DefaultRedirectURI": { - "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", + "AccessTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType", "traits": { - "smithy.api#documentation": "

The default redirect URI. Must be in the CallbackURLs list.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" + "smithy.api#documentation": "

The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if\n you have entered a value in TokenValidityUnits.

" } }, - "AllowedOAuthFlows": { - "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", + "ExplicitAuthFlows": { + "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "

The allowed OAuth flows.

\n

Set to code to initiate a code grant flow, which provides an\n authorization code as the response. This code can be exchanged for access tokens with\n the token endpoint.

\n

Set to implicit to specify that the client should get the access token\n (and, optionally, ID token, based on scopes) directly.

\n

Set to client_credentials to specify that the client should get the\n access token (and, optionally, ID token, based on scopes) from the token endpoint using\n a combination of client and client_secret.

" + "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_ prefix are deprecated in favor of new names with the\n ALLOW_ prefix. Note that values with ALLOW_ prefix cannot\n be used along with values without ALLOW_ prefix.

\n

Valid values include:

\n " } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "WriteAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to create a user pool client.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user pool attributes that the app client can write to.

\n

If your app client allows users to sign in through an identity provider, this array\n must include all attributes that are mapped to identity provider attributes. Amazon\n Cognito updates mapped attributes when users sign in to your application through an\n identity provider. If your app client lacks write access to a mapped attribute, Amazon\n Cognito throws an error when it attempts to update the attribute. For more information,\n see Specifying Identity Provider Attribute Mappings for Your User\n Pool.

" } }, - "ClientName": { - "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", + "DefaultRedirectURI": { + "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { - "smithy.api#documentation": "

The client name for the user pool client you would like to create.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The default redirect URI. Must be in the CallbackURLs list.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" } }, - "PreventUserExistenceErrors": { - "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", + "RefreshTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { - "smithy.api#documentation": "

Use this setting to choose which errors and responses are returned by Cognito APIs\n during authentication, account confirmation, and password recovery when the user does\n not exist in the user pool. When set to ENABLED and the user does not\n exist, authentication returns an error indicating either the username or password was\n incorrect, and account confirmation and password recovery return a response indicating a\n code was sent to a simulated destination. When set to LEGACY, those APIs\n will return a UserNotFoundException exception if the user does not exist in\n the user pool.

\n

Valid values include:

\n \n

This setting affects the behavior of following APIs:

\n \n \n

After February 15th 2020, the value of PreventUserExistenceErrors\n will default to ENABLED for newly created user pool clients if no value\n is provided.

\n " + "smithy.api#documentation": "

The time limit, in days, after which the refresh token is no longer valid and cannot\n be used.

" } }, - "WriteAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", + "AllowedOAuthFlowsUserPoolClient": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

The user pool attributes that the app client can write to.

\n

If your app client allows users to sign in through an identity provider, this array\n must include all attributes that are mapped to identity provider attributes. Amazon\n Cognito updates mapped attributes when users sign in to your application through an\n identity provider. If your app client lacks write access to a mapped attribute, Amazon\n Cognito throws an error when it attempts to update the attribute. For more information,\n see Specifying Identity Provider Attribute Mappings for Your User\n Pool.

" + "smithy.api#documentation": "

Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Cognito user pools.

" } }, "ReadAttributes": { @@ -4401,58 +4415,78 @@ "smithy.api#documentation": "

The read attributes.

" } }, - "RefreshTokenValidity": { - "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", + "GenerateSecret": { + "target": "com.amazonaws.cognitoidentityprovider#GenerateSecret", "traits": { - "smithy.api#documentation": "

The time limit, in days, after which the refresh token is no longer valid and cannot\n be used.

" + "smithy.api#documentation": "

Boolean to specify whether you want to generate a secret for the user pool client\n being created.

" } }, - "AllowedOAuthScopes": { - "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", + "AnalyticsConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "

The allowed OAuth scopes. Possible values provided by OAuth are: phone,\n email, openid, and profile. Possible values\n provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created\n in Resource Servers are also supported.

" + "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for this user\n pool.

\n \n

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1.\n In regions where Pinpoint is available, Cognito User Pools will \n support sending events to Amazon Pinpoint projects within that same region. \n

\n " } }, - "SupportedIdentityProviders": { - "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", + "PreventUserExistenceErrors": { + "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", "traits": { - "smithy.api#documentation": "

A list of provider names for the identity providers that are supported on this client.\n The following are supported: COGNITO, Facebook,\n Google and LoginWithAmazon.

" + "smithy.api#documentation": "

Use this setting to choose which errors and responses are returned by Cognito APIs\n during authentication, account confirmation, and password recovery when the user does\n not exist in the user pool. When set to ENABLED and the user does not\n exist, authentication returns an error indicating either the username or password was\n incorrect, and account confirmation and password recovery return a response indicating a\n code was sent to a simulated destination. When set to LEGACY, those APIs\n will return a UserNotFoundException exception if the user does not exist in\n the user pool.

\n

Valid values include:

\n \n \n \n \n

After February 15th 2020, the value of PreventUserExistenceErrors\n will default to ENABLED for newly created user pool clients if no value\n is provided.

\n " } }, - "CallbackURLs": { - "target": "com.amazonaws.cognitoidentityprovider#CallbackURLsListType", + "IdTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { - "smithy.api#documentation": "

A list of allowed redirect (callback) URLs for the identity providers.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" + "smithy.api#documentation": "

The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if\n you have entered a value in TokenValidityUnits.

" } }, - "AllowedOAuthFlowsUserPoolClient": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "LogoutURLs": { + "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", "traits": { - "smithy.api#documentation": "

Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Cognito user pools.

" + "smithy.api#documentation": "

A list of allowed logout URLs for the identity providers.

" } }, - "AnalyticsConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", + "TokenValidityUnits": { + "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for this user\n pool.

\n \n

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

\n " + "smithy.api#documentation": "

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

" } }, - "LogoutURLs": { - "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", + "SupportedIdentityProviders": { + "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

A list of allowed logout URLs for the identity providers.

" + "smithy.api#documentation": "

A list of provider names for the identity providers that are supported on this client.\n The following are supported: COGNITO, Facebook,\n Google and LoginWithAmazon.

" } }, - "ExplicitAuthFlows": { - "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_ prefix are deprecated in favor of new names with the\n ALLOW_ prefix. Note that values with ALLOW_ prefix cannot\n be used along with values without ALLOW_ prefix.

\n

Valid values include:

\n " + "smithy.api#documentation": "

The user pool ID for the user pool where you want to create a user pool client.

", + "smithy.api#required": {} } }, - "GenerateSecret": { - "target": "com.amazonaws.cognitoidentityprovider#GenerateSecret", + "AllowedOAuthFlows": { + "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", "traits": { - "smithy.api#documentation": "

Boolean to specify whether you want to generate a secret for the user pool client\n being created.

" + "smithy.api#documentation": "

The allowed OAuth flows.

\n

Set to code to initiate a code grant flow, which provides an\n authorization code as the response. This code can be exchanged for access tokens with\n the token endpoint.

\n

Set to implicit to specify that the client should get the access token\n (and, optionally, ID token, based on scopes) directly.

\n

Set to client_credentials to specify that the client should get the\n access token (and, optionally, ID token, based on scopes) from the token endpoint using\n a combination of client and client_secret.

" + } + }, + "ClientName": { + "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", + "traits": { + "smithy.api#documentation": "

The client name for the user pool client you would like to create.

", + "smithy.api#required": {} + } + }, + "AllowedOAuthScopes": { + "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", + "traits": { + "smithy.api#documentation": "

The allowed OAuth scopes. Possible values provided by OAuth are: phone,\n email, openid, and profile. Possible values\n provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created\n in Resource Servers are also supported.

" + } + }, + "CallbackURLs": { + "target": "com.amazonaws.cognitoidentityprovider#CallbackURLsListType", + "traits": { + "smithy.api#documentation": "

A list of allowed redirect (callback) URLs for the identity providers.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" } } }, @@ -4506,11 +4540,10 @@ "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainRequest": { "type": "structure", "members": { - "Domain": { - "target": "com.amazonaws.cognitoidentityprovider#DomainType", + "CustomDomainConfig": { + "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", "traits": { - "smithy.api#documentation": "

The domain string.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.

\n

Provide this parameter only if you want to use a custom domain for your user pool.\n Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain\n instead.

\n

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

" } }, "UserPoolId": { @@ -4520,10 +4553,11 @@ "smithy.api#required": {} } }, - "CustomDomainConfig": { - "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", + "Domain": { + "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.

\n

Provide this parameter only if you want to use a custom domain for your user pool.\n Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain\n instead.

\n

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

" + "smithy.api#documentation": "

The domain string.

", + "smithy.api#required": {} } } } @@ -4542,10 +4576,10 @@ "com.amazonaws.cognitoidentityprovider#CreateUserPoolRequest": { "type": "structure", "members": { - "EmailConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", + "MfaConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "

The email configuration.

" + "smithy.api#documentation": "

Specifies MFA configuration details.

" } }, "AdminCreateUserConfig": { @@ -4554,70 +4588,71 @@ "smithy.api#documentation": "

The configuration for AdminCreateUser requests.

" } }, - "EmailVerificationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", - "traits": { - "smithy.api#documentation": "

A string representing the email verification message.

" - } - }, "DeviceConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", "traits": { "smithy.api#documentation": "

The device configuration.

" } }, - "SmsConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", + "EmailVerificationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "

The SMS configuration.

" + "smithy.api#documentation": "

A string representing the email verification message.

" } }, - "UserPoolTags": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", + "VerificationMessageTemplate": { + "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { - "smithy.api#documentation": "

The tag keys and values to assign to the user pool. A tag is a label that you can use\n to categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.

" + "smithy.api#documentation": "

The template for the verification message that the user sees when the app requests\n permission to access the user's information.

" } }, - "EmailVerificationSubject": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", + "SmsAuthenticationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { - "smithy.api#documentation": "

A string representing the email verification subject.

" + "smithy.api#documentation": "

A string representing the SMS authentication message.

" } }, - "UserPoolAddOns": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", + "SmsVerificationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { - "smithy.api#documentation": "

Used to enable advanced security risk detection. Set the key\n AdvancedSecurityMode to the value \"AUDIT\".

" + "smithy.api#documentation": "

A string representing the SMS verification message.

" } }, - "Policies": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", + "LambdaConfig": { + "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { - "smithy.api#documentation": "

The policies associated with the new user pool.

" + "smithy.api#documentation": "

The Lambda trigger configuration information for the new user pool.

\n \n

In a push model, event sources (such as Amazon S3 and custom applications) need\n permission to invoke a function. So you will need to make an extra call to add\n permission for these event sources to invoke your Lambda function.

\n

\n

For more information on using the Lambda API to add permission, see \n AddPermission .

\n

For adding permission using the AWS CLI, see add-permission\n .

\n " } }, - "Schema": { - "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", + "PoolName": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", "traits": { - "smithy.api#documentation": "

An array of schema attributes for the new user pool. These attributes can be standard\n or custom attributes.

" + "smithy.api#documentation": "

A string used to name the user pool.

", + "smithy.api#required": {} } }, - "AutoVerifiedAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", + "AliasAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", "traits": { - "smithy.api#documentation": "

The attributes to be auto-verified. Possible values: email, phone_number.

" + "smithy.api#documentation": "

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or\n preferred_username.

" } }, - "SmsAuthenticationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "UsernameConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { - "smithy.api#documentation": "

A string representing the SMS authentication message.

" + "smithy.api#documentation": "

You can choose to set case sensitivity on the username input for the selected sign-in\n option. For example, when this is set to False, users will be able to sign\n in using either \"username\" or \"Username\". This configuration is immutable once it has\n been set. For more information, see UsernameConfigurationType.

" } }, - "AccountRecoverySetting": { - "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", + "SmsConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", + "traits": { + "smithy.api#documentation": "

The SMS configuration.

" + } + }, + "UserPoolAddOns": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "

Use this setting to define which verified available method a user can use to recover\n their password when they call ForgotPassword. It allows you to define a\n preferred method when a user has more than one method available. With this setting, SMS\n does not qualify for a valid password recovery mechanism if the user also has SMS MFA\n enabled. In the absence of this setting, Cognito uses the legacy behavior to determine\n the recovery method where SMS is preferred over email.

\n \n

Starting February 1, 2020, the value of AccountRecoverySetting will\n default to verified_email first and verified_phone_number\n as the second option for newly created user pools if no value is provided.

\n " + "smithy.api#documentation": "

Used to enable advanced security risk detection. Set the key\n AdvancedSecurityMode to the value \"AUDIT\".

" } }, "UsernameAttributes": { @@ -4626,47 +4661,46 @@ "smithy.api#documentation": "

Specifies whether email addresses or phone numbers can be specified as usernames when\n a user signs up.

" } }, - "LambdaConfig": { - "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", + "AccountRecoverySetting": { + "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", "traits": { - "smithy.api#documentation": "

The Lambda trigger configuration information for the new user pool.

\n \n

In a push model, event sources (such as Amazon S3 and custom applications) need\n permission to invoke a function. So you will need to make an extra call to add\n permission for these event sources to invoke your Lambda function.

\n

\n

For more information on using the Lambda API to add permission, see \n AddPermission .

\n

For adding permission using the AWS CLI, see add-permission\n .

\n " + "smithy.api#documentation": "

Use this setting to define which verified available method a user can use to recover\n their password when they call ForgotPassword. It allows you to define a\n preferred method when a user has more than one method available. With this setting, SMS\n does not qualify for a valid password recovery mechanism if the user also has SMS MFA\n enabled. In the absence of this setting, Cognito uses the legacy behavior to determine\n the recovery method where SMS is preferred over email.

" } }, - "VerificationMessageTemplate": { - "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", + "UserPoolTags": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { - "smithy.api#documentation": "

The template for the verification message that the user sees when the app requests\n permission to access the user's information.

" + "smithy.api#documentation": "

The tag keys and values to assign to the user pool. A tag is a label that you can use\n to categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.

" } }, - "PoolName": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", + "Schema": { + "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", "traits": { - "smithy.api#documentation": "

A string used to name the user pool.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of schema attributes for the new user pool. These attributes can be standard\n or custom attributes.

" } }, - "UsernameConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", + "EmailConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", "traits": { - "smithy.api#documentation": "

You can choose to set case sensitivity on the username input for the selected sign-in\n option. For example, when this is set to False, users will be able to sign\n in using either \"username\" or \"Username\". This configuration is immutable once it has\n been set. For more information, see .

" + "smithy.api#documentation": "

The email configuration.

" } }, - "AliasAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", + "AutoVerifiedAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { - "smithy.api#documentation": "

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or\n preferred_username.

" + "smithy.api#documentation": "

The attributes to be auto-verified. Possible values: email, phone_number.

" } }, - "SmsVerificationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "EmailVerificationSubject": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "

A string representing the SMS verification message.

" + "smithy.api#documentation": "

A string representing the email verification subject.

" } }, - "MfaConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", + "Policies": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { - "smithy.api#documentation": "

Specifies MFA configuration details.

" + "smithy.api#documentation": "

The policies associated with the new user pool.

" } } }, @@ -4961,17 +4995,17 @@ "com.amazonaws.cognitoidentityprovider#DeleteUserAttributesRequest": { "type": "structure", "members": { - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "UserAttributeNames": { + "target": "com.amazonaws.cognitoidentityprovider#AttributeNameListType", "traits": { - "smithy.api#documentation": "

The access token used in the request to delete user attributes.

", + "smithy.api#documentation": "

An array of strings representing the user attribute names you wish to delete.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

", "smithy.api#required": {} } }, - "UserAttributeNames": { - "target": "com.amazonaws.cognitoidentityprovider#AttributeNameListType", + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

An array of strings representing the user attribute names you wish to delete.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

", + "smithy.api#documentation": "

The access token used in the request to delete user attributes.

", "smithy.api#required": {} } } @@ -5256,17 +5290,17 @@ "com.amazonaws.cognitoidentityprovider#DescribeResourceServerRequest": { "type": "structure", "members": { - "Identifier": { - "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The identifier for the resource server

", + "smithy.api#documentation": "

The user pool ID for the user pool that hosts the resource server.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Identifier": { + "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool that hosts the resource server.

", + "smithy.api#documentation": "

The identifier for the resource server

", "smithy.api#required": {} } } @@ -5319,18 +5353,18 @@ "com.amazonaws.cognitoidentityprovider#DescribeRiskConfigurationRequest": { "type": "structure", "members": { - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", - "traits": { - "smithy.api#documentation": "

The app client ID.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The app client ID.

" + } } } }, @@ -5658,16 +5692,16 @@ "com.amazonaws.cognitoidentityprovider#DeviceSecretVerifierConfigType": { "type": "structure", "members": { - "PasswordVerifier": { + "Salt": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The password verifier.

" + "smithy.api#documentation": "

The salt.

" } }, - "Salt": { + "PasswordVerifier": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The salt.

" + "smithy.api#documentation": "

The password verifier.

" } } }, @@ -5678,16 +5712,16 @@ "com.amazonaws.cognitoidentityprovider#DeviceType": { "type": "structure", "members": { - "DeviceCreateDate": { + "DeviceLastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The creation date of the device.

" + "smithy.api#documentation": "

The last modified date of the device.

" } }, - "DeviceLastAuthenticatedDate": { + "DeviceCreateDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date in which the device was last authenticated.

" + "smithy.api#documentation": "

The creation date of the device.

" } }, "DeviceKey": { @@ -5696,10 +5730,10 @@ "smithy.api#documentation": "

The device key.

" } }, - "DeviceLastModifiedDate": { + "DeviceLastAuthenticatedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The last modified date of the device.

" + "smithy.api#documentation": "

The date in which the device was last authenticated.

" } }, "DeviceAttributes": { @@ -5716,10 +5750,10 @@ "com.amazonaws.cognitoidentityprovider#DomainDescriptionType": { "type": "structure", "members": { - "S3Bucket": { - "target": "com.amazonaws.cognitoidentityprovider#S3BucketType", + "CustomDomainConfig": { + "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", "traits": { - "smithy.api#documentation": "

The S3 bucket where the static files for this domain are stored.

" + "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.

" } }, "Domain": { @@ -5728,40 +5762,40 @@ "smithy.api#documentation": "

The domain string.

" } }, - "AWSAccountId": { - "target": "com.amazonaws.cognitoidentityprovider#AWSAccountIdType", - "traits": { - "smithy.api#documentation": "

The AWS account ID for the user pool owner.

" - } - }, - "Version": { - "target": "com.amazonaws.cognitoidentityprovider#DomainVersionType", - "traits": { - "smithy.api#documentation": "

The app version.

" - } - }, "CloudFrontDistribution": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "

The ARN of the CloudFront distribution.

" } }, + "Status": { + "target": "com.amazonaws.cognitoidentityprovider#DomainStatusType", + "traits": { + "smithy.api#documentation": "

The domain status.

" + } + }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "

The user pool ID.

" } }, - "Status": { - "target": "com.amazonaws.cognitoidentityprovider#DomainStatusType", + "AWSAccountId": { + "target": "com.amazonaws.cognitoidentityprovider#AWSAccountIdType", "traits": { - "smithy.api#documentation": "

The domain status.

" + "smithy.api#documentation": "

The AWS account ID for the user pool owner.

" } }, - "CustomDomainConfig": { - "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", + "Version": { + "target": "com.amazonaws.cognitoidentityprovider#DomainVersionType", "traits": { - "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.

" + "smithy.api#documentation": "

The app version.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.cognitoidentityprovider#S3BucketType", + "traits": { + "smithy.api#documentation": "

The S3 bucket where the static files for this domain are stored.

" } } }, @@ -5837,35 +5871,35 @@ "com.amazonaws.cognitoidentityprovider#EmailConfigurationType": { "type": "structure", "members": { - "From": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

Identifies either the sender’s email address or the sender’s name with their email\n address. For example, testuser@example.com or Test User\n . This address will appear before the body of the\n email.

" - } - }, "EmailSendingAccount": { "target": "com.amazonaws.cognitoidentityprovider#EmailSendingAccountType", "traits": { "smithy.api#documentation": "

Specifies whether Amazon Cognito emails your users by using its built-in email\n functionality or your Amazon SES email configuration. Specify one of the following\n values:

\n
\n
COGNITO_DEFAULT
\n
\n

When Amazon Cognito emails your users, it uses its built-in email\n functionality. When you use the default option, Amazon Cognito allows only a\n limited number of emails each day for your user pool. For typical production\n environments, the default email limit is below the required delivery volume.\n To achieve a higher delivery volume, specify DEVELOPER to use your Amazon\n SES email configuration.

\n

To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito\n Developer Guide.

\n

The default FROM address is no-reply@verificationemail.com. To customize\n the FROM address, provide the ARN of an Amazon SES verified email address\n for the SourceArn parameter.

\n
\n
DEVELOPER
\n
\n

When Amazon Cognito emails your users, it uses your Amazon SES\n configuration. Amazon Cognito calls Amazon SES on your behalf to send email\n from your verified email address. When you use this option, the email\n delivery limits are the same limits that apply to your Amazon SES verified\n email address in your AWS account.

\n

If you use this option, you must provide the ARN of an Amazon SES verified\n email address for the SourceArn parameter.

\n

Before Amazon Cognito can email your users, it requires additional\n permissions to call Amazon SES on your behalf. When you update your user\n pool with this option, Amazon Cognito creates a service-linked\n role, which is a type of IAM role, in your AWS account. This\n role contains the permissions that allow Amazon Cognito to access Amazon SES\n and send email messages with your address. For more information about the\n service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon\n Cognito in the Amazon Cognito Developer\n Guide.

\n
\n
" } }, - "ConfigurationSet": { - "target": "com.amazonaws.cognitoidentityprovider#SESConfigurationSet", - "traits": { - "smithy.api#documentation": "

The set of configuration rules that can be applied to emails sent using Amazon SES. A\n configuration set is applied to an email by including a reference to the configuration\n set in the headers of the email. Once applied, all of the rules in that configuration\n set are applied to the email. Configuration sets can be used to apply the following\n types of rules to emails:

\n " - } - }, "ReplyToEmailAddress": { "target": "com.amazonaws.cognitoidentityprovider#EmailAddressType", "traits": { "smithy.api#documentation": "

The destination to which the receiver of the email should reply to.

" } }, + "From": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

Identifies either the sender’s email address or the sender’s name with their email\n address. For example, testuser@example.com or Test User\n . This address will appear before the body of the\n email.

" + } + }, "SourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email\n address is used in one of the following ways, depending on the value that you specify\n for the EmailSendingAccount parameter:

\n " } + }, + "ConfigurationSet": { + "target": "com.amazonaws.cognitoidentityprovider#SESConfigurationSet", + "traits": { + "smithy.api#documentation": "

The set of configuration rules that can be applied to emails sent using Amazon SES. A\n configuration set is applied to an email by including a reference to the configuration\n set in the headers of the email. Once applied, all of the rules in that configuration\n set are applied to the email. Configuration sets can be used to apply the following\n types of rules to emails:

\n " + } } }, "traits": { @@ -5963,28 +5997,28 @@ "com.amazonaws.cognitoidentityprovider#EventContextDataType": { "type": "structure", "members": { - "Country": { + "Timezone": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The user's country.

" + "smithy.api#documentation": "

The user's time zone.

" } }, - "IpAddress": { + "City": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The user's IP address.

" + "smithy.api#documentation": "

The user's city.

" } }, - "City": { + "Country": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The user's city.

" + "smithy.api#documentation": "

The user's country.

" } }, - "Timezone": { + "IpAddress": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The user's time zone.

" + "smithy.api#documentation": "

The user's IP address.

" } }, "DeviceName": { @@ -6001,13 +6035,6 @@ "com.amazonaws.cognitoidentityprovider#EventFeedbackType": { "type": "structure", "members": { - "Provider": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

The provider.

", - "smithy.api#required": {} - } - }, "FeedbackDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { @@ -6020,6 +6047,13 @@ "smithy.api#documentation": "

The event feedback value.

", "smithy.api#required": {} } + }, + "Provider": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The provider.

", + "smithy.api#required": {} + } } }, "traits": { @@ -6079,12 +6113,6 @@ "com.amazonaws.cognitoidentityprovider#EventRiskType": { "type": "structure", "members": { - "RiskDecision": { - "target": "com.amazonaws.cognitoidentityprovider#RiskDecisionType", - "traits": { - "smithy.api#documentation": "

The risk decision.

" - } - }, "CompromisedCredentialsDetected": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { @@ -6096,6 +6124,12 @@ "traits": { "smithy.api#documentation": "

The risk level.

" } + }, + "RiskDecision": { + "target": "com.amazonaws.cognitoidentityprovider#RiskDecisionType", + "traits": { + "smithy.api#documentation": "

The risk decision.

" + } } }, "traits": { @@ -6241,18 +6275,18 @@ "com.amazonaws.cognitoidentityprovider#ForgetDeviceRequest": { "type": "structure", "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

The access token for the forgotten device request.

" + } + }, "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { "smithy.api#documentation": "

The device key.

", "smithy.api#required": {} } - }, - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", - "traits": { - "smithy.api#documentation": "

The access token for the forgotten device request.

" - } } }, "traits": { @@ -6316,24 +6350,17 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer\n Guide. If neither a verified phone number nor a verified email exists, an\n InvalidParameterException is thrown. To use the confirmation code for\n resetting the password, call .

", + "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. \n If neither a verified phone number nor a verified email exists, an\n InvalidParameterException is thrown. To use the confirmation code for\n resetting the password, call ConfirmForgotPassword.

", "smithy.api#optionalAuth": {} } }, "com.amazonaws.cognitoidentityprovider#ForgotPasswordRequest": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "AnalyticsMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { - "smithy.api#documentation": "

The user name of the user for whom you want to enter a code to reset a forgotten\n password.

", - "smithy.api#required": {} - } - }, - "UserContextData": { - "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", - "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" + "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for\n ForgotPassword calls.

" } }, "ClientMetadata": { @@ -6342,10 +6369,17 @@ "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the ForgotPassword API action, Amazon Cognito invokes any functions that\n are assigned to the following triggers: pre sign-up,\n custom message, and user migration. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your ForgotPassword request. In your function code in AWS Lambda, you can process the\n clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " } }, - "AnalyticsMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for\n ForgotPassword calls.

" + "smithy.api#documentation": "

The user name of the user for whom you want to enter a code to reset a forgotten\n password.

", + "smithy.api#required": {} + } + }, + "UserContextData": { + "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", + "traits": { + "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } }, "SecretHash": { @@ -6430,17 +6464,17 @@ "com.amazonaws.cognitoidentityprovider#GetCSVHeaderResponse": { "type": "structure", "members": { - "CSVHeader": { - "target": "com.amazonaws.cognitoidentityprovider#ListOfStringTypes", - "traits": { - "smithy.api#documentation": "

The header information for the .csv file for the user import job.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "

The user pool ID for the user pool that the users are to be imported into.

" } + }, + "CSVHeader": { + "target": "com.amazonaws.cognitoidentityprovider#ListOfStringTypes", + "traits": { + "smithy.api#documentation": "

The header information for the .csv file for the user import job.

" + } } }, "traits": { @@ -6556,17 +6590,17 @@ "com.amazonaws.cognitoidentityprovider#GetGroupRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "GroupName": { + "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

", + "smithy.api#documentation": "

The name of the group.

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The name of the group.

", + "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } } @@ -6615,17 +6649,17 @@ "com.amazonaws.cognitoidentityprovider#GetIdentityProviderByIdentifierRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "IdpIdentifier": { + "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifierType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#documentation": "

The identity provider ID.

", "smithy.api#required": {} } }, - "IdpIdentifier": { - "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifierType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The identity provider ID.

", + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } } @@ -6861,13 +6895,6 @@ "com.amazonaws.cognitoidentityprovider#GetUserAttributeVerificationCodeRequest": { "type": "structure", "members": { - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", - "traits": { - "smithy.api#documentation": "

The access token returned by the server response to get the user attribute\n verification code.

", - "smithy.api#required": {} - } - }, "AttributeName": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", "traits": { @@ -6880,6 +6907,13 @@ "traits": { "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the\n function that is assigned to the custom message trigger. When\n Amazon Cognito invokes this function, it passes a JSON payload, which the function\n receives as input. This payload contains a clientMetadata attribute, which\n provides the data that you assigned to the ClientMetadata parameter in your\n GetUserAttributeVerificationCode request. In your function code in AWS Lambda, you can\n process the clientMetadata value to enhance your workflow for your specific\n needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " } + }, + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

The access token returned by the server response to get the user attribute\n verification code.

", + "smithy.api#required": {} + } } }, "traits": { @@ -6944,18 +6978,18 @@ "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigResponse": { "type": "structure", "members": { - "SmsMfaConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType", - "traits": { - "smithy.api#documentation": "

The SMS text message multi-factor (MFA) configuration.

" - } - }, "SoftwareTokenMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaConfigType", "traits": { "smithy.api#documentation": "

The software token multi-factor (MFA) configuration.

" } }, + "SmsMfaConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType", + "traits": { + "smithy.api#documentation": "

The SMS text message multi-factor (MFA) configuration.

" + } + }, "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { @@ -6982,6 +7016,12 @@ "com.amazonaws.cognitoidentityprovider#GetUserResponse": { "type": "structure", "members": { + "UserMFASettingList": { + "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", + "traits": { + "smithy.api#documentation": "

The MFA options that are enabled for the user. The possible values in this list are\n SMS_MFA and SOFTWARE_TOKEN_MFA.

" + } + }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { @@ -6989,12 +7029,6 @@ "smithy.api#required": {} } }, - "UserMFASettingList": { - "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", - "traits": { - "smithy.api#documentation": "

The MFA options that are enabled for the user. The possible values in this list are\n SMS_MFA and SOFTWARE_TOKEN_MFA.

" - } - }, "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { @@ -7005,7 +7039,7 @@ "MFAOptions": { "target": "com.amazonaws.cognitoidentityprovider#MFAOptionListType", "traits": { - "smithy.api#documentation": "

\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about TOTP\n software token MFA configurations. To look up information about either type of MFA\n configuration, use the use the GetUserResponse$UserMFASettingList\n response instead.

" + "smithy.api#documentation": "

\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about TOTP\n software token MFA configurations. To look up information about either type of MFA\n configuration, use UserMFASettingList instead.

" } }, "PreferredMfaSetting": { @@ -7108,22 +7142,10 @@ "com.amazonaws.cognitoidentityprovider#GroupType": { "type": "structure", "members": { - "Precedence": { - "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", - "traits": { - "smithy.api#documentation": "

A nonnegative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. If a user belongs to two or\n more groups, it is the group with the highest precedence whose role ARN will be used in\n the cognito:roles and cognito:preferred_role claims in the\n user's tokens. Groups with higher Precedence values take precedence over\n groups with lower Precedence values or with null Precedence\n values.

\n

Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim is\n not set in users' tokens.

\n

The default Precedence value is null.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", - "traits": { - "smithy.api#documentation": "

The date the group was last modified.

" - } - }, - "CreationDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The date the group was created.

" + "smithy.api#documentation": "

The user pool ID for the user pool.

" } }, "Description": { @@ -7138,10 +7160,16 @@ "smithy.api#documentation": "

The name of the group.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

" + "smithy.api#documentation": "

The date the group was last modified.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date the group was created.

" } }, "RoleArn": { @@ -7149,6 +7177,12 @@ "traits": { "smithy.api#documentation": "

The role ARN for the group.

" } + }, + "Precedence": { + "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", + "traits": { + "smithy.api#documentation": "

A nonnegative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. If a user belongs to two or\n more groups, it is the group with the highest precedence whose role ARN will be used in\n the cognito:roles and cognito:preferred_role claims in the\n user's tokens. Groups with higher Precedence values take precedence over\n groups with lower Precedence values or with null Precedence\n values.

\n

Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim is\n not set in users' tokens.

\n

The default Precedence value is null.

" + } } }, "traits": { @@ -7187,33 +7221,31 @@ "target": "com.amazonaws.cognitoidentityprovider#HttpHeader" } }, + "com.amazonaws.cognitoidentityprovider#IdTokenValidityType": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 86400 + } + } + }, "com.amazonaws.cognitoidentityprovider#IdentityProviderType": { "type": "structure", "members": { - "ProviderDetails": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", - "traits": { - "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys\n for each identity provider type.

\n " - } - }, - "IdpIdentifiers": { - "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", - "traits": { - "smithy.api#documentation": "

A list of identity provider identifiers.

" - } - }, - "AttributeMapping": { - "target": "com.amazonaws.cognitoidentityprovider#AttributeMappingType", - "traits": { - "smithy.api#documentation": "

A mapping of identity provider attributes to standard and custom user pool\n attributes.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "

The user pool ID.

" } }, + "ProviderName": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", + "traits": { + "smithy.api#documentation": "

The identity provider name.

" + } + }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { @@ -7226,10 +7258,16 @@ "smithy.api#documentation": "

The date the identity provider was created.

" } }, - "ProviderName": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", + "AttributeMapping": { + "target": "com.amazonaws.cognitoidentityprovider#AttributeMappingType", "traits": { - "smithy.api#documentation": "

The identity provider name.

" + "smithy.api#documentation": "

A mapping of identity provider attributes to standard and custom user pool\n attributes.

" + } + }, + "IdpIdentifiers": { + "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", + "traits": { + "smithy.api#documentation": "

A list of identity provider identifiers.

" } }, "ProviderType": { @@ -7237,6 +7275,12 @@ "traits": { "smithy.api#documentation": "

The identity provider type.

" } + }, + "ProviderDetails": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", + "traits": { + "smithy.api#documentation": "

The identity provider details. The following list describes the provider detail keys\n for each identity provider type.

\n " + } } }, "traits": { @@ -7363,29 +7407,16 @@ "com.amazonaws.cognitoidentityprovider#InitiateAuthRequest": { "type": "structure", "members": { - "AuthParameters": { - "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", - "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you are invoking. The required values depend on the value\n of AuthFlow:

\n " - } - }, - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", - "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda\n functions that are specified for various triggers. The ClientMetadata value is passed as\n input to the functions for only the following triggers:

\n \n\n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON\n payload, which the function receives as input. This payload contains a\n validationData attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS\n Lambda, you can process the validationData value to enhance your workflow\n for your specific needs.

\n\n

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions\n for the following triggers, but it does not provide the ClientMetadata value as\n input:

\n\n \n\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " - } - }, "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for\n InitiateAuth calls.

" } }, - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "AuthParameters": { + "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The app client ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you are invoking. The required values depend on the value\n of AuthFlow:

\n " } }, "UserContextData": { @@ -7400,6 +7431,19 @@ "smithy.api#documentation": "

The authentication flow for this call to execute. The API action will depend on this\n value. For example:

\n \n

Valid values include:

\n \n

\n ADMIN_NO_SRP_AUTH is not a valid value.

", "smithy.api#required": {} } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The app client ID.

", + "smithy.api#required": {} + } + }, + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "traits": { + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda\n functions that are specified for various triggers. The ClientMetadata value is passed as\n input to the functions for only the following triggers:

\n \n\n

When Amazon Cognito invokes the functions for these triggers, it passes a JSON\n payload, which the function receives as input. This payload contains a\n validationData attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS\n Lambda, you can process the validationData value to enhance your workflow\n for your specific needs.

\n\n

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions\n for the following triggers, but it does not provide the ClientMetadata value as\n input:

\n\n \n\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + } } }, "traits": { @@ -7409,18 +7453,6 @@ "com.amazonaws.cognitoidentityprovider#InitiateAuthResponse": { "type": "structure", "members": { - "Session": { - "target": "com.amazonaws.cognitoidentityprovider#SessionType", - "traits": { - "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If the or API call determines that the caller needs to\n go through another challenge, they return a session with other challenge parameters.\n This session should be passed as it is to the next RespondToAuthChallenge\n API call.

" - } - }, - "ChallengeParameters": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", - "traits": { - "smithy.api#documentation": "

The challenge parameters. These are returned to you in the InitiateAuth\n response if you need to pass another challenge. The responses in this parameter should\n be used to compute inputs to the next call (RespondToAuthChallenge).

\n

All challenges require USERNAME and SECRET_HASH (if\n applicable).

" - } - }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { @@ -7432,6 +7464,18 @@ "traits": { "smithy.api#documentation": "

The result of the authentication response. This is only returned if the caller does\n not need to pass another challenge. If the caller does need to pass another challenge\n before it gets tokens, ChallengeName, ChallengeParameters, and\n Session are returned.

" } + }, + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "traits": { + "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If the caller needs to\n go through another challenge, they return a session with other challenge parameters.\n This session should be passed as it is to the next RespondToAuthChallenge\n API call.

" + } + }, + "ChallengeParameters": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", + "traits": { + "smithy.api#documentation": "

The challenge parameters. These are returned to you in the InitiateAuth\n response if you need to pass another challenge. The responses in this parameter should\n be used to compute inputs to the next call (RespondToAuthChallenge).

\n

All challenges require USERNAME and SECRET_HASH (if\n applicable).

" + } } }, "traits": { @@ -7584,28 +7628,22 @@ "com.amazonaws.cognitoidentityprovider#LambdaConfigType": { "type": "structure", "members": { - "PreSignUp": { - "target": "com.amazonaws.cognitoidentityprovider#ArnType", - "traits": { - "smithy.api#documentation": "

A pre-registration AWS Lambda trigger.

" - } - }, - "PostConfirmation": { + "UserMigration": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A post-confirmation AWS Lambda trigger.

" + "smithy.api#documentation": "

The user migration Lambda config type.

" } }, - "CreateAuthChallenge": { + "DefineAuthChallenge": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

Creates an authentication challenge.

" + "smithy.api#documentation": "

Defines the authentication challenge.

" } }, - "PreTokenGeneration": { + "VerifyAuthChallengeResponse": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A Lambda trigger that is invoked before token generation.

" + "smithy.api#documentation": "

Verifies the authentication challenge response.

" } }, "PreAuthentication": { @@ -7614,16 +7652,10 @@ "smithy.api#documentation": "

A pre-authentication AWS Lambda trigger.

" } }, - "UserMigration": { - "target": "com.amazonaws.cognitoidentityprovider#ArnType", - "traits": { - "smithy.api#documentation": "

The user migration Lambda config type.

" - } - }, - "CustomMessage": { + "PreSignUp": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

A custom Message AWS Lambda trigger.

" + "smithy.api#documentation": "

A pre-registration AWS Lambda trigger.

" } }, "PostAuthentication": { @@ -7632,16 +7664,28 @@ "smithy.api#documentation": "

A post-authentication AWS Lambda trigger.

" } }, - "VerifyAuthChallengeResponse": { + "PostConfirmation": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

Verifies the authentication challenge response.

" + "smithy.api#documentation": "

A post-confirmation AWS Lambda trigger.

" } }, - "DefineAuthChallenge": { + "CustomMessage": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

Defines the authentication challenge.

" + "smithy.api#documentation": "

A custom Message AWS Lambda trigger.

" + } + }, + "PreTokenGeneration": { + "target": "com.amazonaws.cognitoidentityprovider#ArnType", + "traits": { + "smithy.api#documentation": "

A Lambda trigger that is invoked before token generation.

" + } + }, + "CreateAuthChallenge": { + "target": "com.amazonaws.cognitoidentityprovider#ArnType", + "traits": { + "smithy.api#documentation": "

Creates an authentication challenge.

" } } }, @@ -7709,18 +7753,18 @@ "com.amazonaws.cognitoidentityprovider#ListDevicesRequest": { "type": "structure", "members": { - "PaginationToken": { - "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", - "traits": { - "smithy.api#documentation": "

The pagination token for the list request.

" - } - }, "Limit": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { "smithy.api#documentation": "

The limit of the device request.

" } }, + "PaginationToken": { + "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", + "traits": { + "smithy.api#documentation": "

The pagination token for the list request.

" + } + }, "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { @@ -7736,17 +7780,17 @@ "com.amazonaws.cognitoidentityprovider#ListDevicesResponse": { "type": "structure", "members": { - "PaginationToken": { - "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", - "traits": { - "smithy.api#documentation": "

The pagination token for the list device response.

" - } - }, "Devices": { "target": "com.amazonaws.cognitoidentityprovider#DeviceListType", "traits": { "smithy.api#documentation": "

The devices returned in the list devices response.

" } + }, + "PaginationToken": { + "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", + "traits": { + "smithy.api#documentation": "

The pagination token for the list device response.

" + } } }, "traits": { @@ -7791,12 +7835,6 @@ "com.amazonaws.cognitoidentityprovider#ListGroupsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -7804,6 +7842,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } + }, "Limit": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { @@ -7867,10 +7911,11 @@ "com.amazonaws.cognitoidentityprovider#ListIdentityProvidersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

A pagination token.

" + "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#required": {} } }, "MaxResults": { @@ -7879,11 +7924,10 @@ "smithy.api#documentation": "

The maximum number of identity providers to return.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A pagination token.

" } } } @@ -7969,12 +8013,6 @@ "com.amazonaws.cognitoidentityprovider#ListResourceServersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", - "traits": { - "smithy.api#documentation": "

A pagination token.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -7987,24 +8025,30 @@ "traits": { "smithy.api#documentation": "

The maximum number of resource servers to return.

" } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", + "traits": { + "smithy.api#documentation": "

A pagination token.

" + } } } }, "com.amazonaws.cognitoidentityprovider#ListResourceServersResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", + "traits": { + "smithy.api#documentation": "

A pagination token.

" + } + }, "ResourceServers": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServersListType", "traits": { "smithy.api#documentation": "

The resource servers.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", - "traits": { - "smithy.api#documentation": "

A pagination token.

" - } } } }, @@ -8120,17 +8164,17 @@ "com.amazonaws.cognitoidentityprovider#ListUserImportJobsResponse": { "type": "structure", "members": { - "UserImportJobs": { - "target": "com.amazonaws.cognitoidentityprovider#UserImportJobsListType", - "traits": { - "smithy.api#documentation": "

The user import jobs.

" - } - }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "

An identifier that can be used to return the next set of user import jobs in the\n list.

" } + }, + "UserImportJobs": { + "target": "com.amazonaws.cognitoidentityprovider#UserImportJobsListType", + "traits": { + "smithy.api#documentation": "

The user import jobs.

" + } } }, "traits": { @@ -8175,13 +8219,6 @@ "com.amazonaws.cognitoidentityprovider#ListUserPoolClientsRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", - "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to list user pool clients.

", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimit", "traits": { @@ -8193,6 +8230,13 @@ "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID for the user pool where you want to list user pool clients.

", + "smithy.api#required": {} + } } }, "traits": { @@ -8202,17 +8246,17 @@ "com.amazonaws.cognitoidentityprovider#ListUserPoolClientsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" - } - }, "UserPoolClients": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientListType", "traits": { "smithy.api#documentation": "

The user pool clients in the response that lists user pool clients.

" } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } } }, "traits": { @@ -8269,17 +8313,17 @@ "com.amazonaws.cognitoidentityprovider#ListUserPoolsResponse": { "type": "structure", "members": { - "UserPools": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolListType", - "traits": { - "smithy.api#documentation": "

The user pools from the response to list users.

" - } - }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } + }, + "UserPools": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolListType", + "traits": { + "smithy.api#documentation": "

The user pools from the response to list users.

" + } } }, "traits": { @@ -8359,11 +8403,10 @@ "com.amazonaws.cognitoidentityprovider#ListUsersInGroupRequest": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", + "Limit": { + "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { - "smithy.api#documentation": "

The name of the group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The limit of the request to list users.

" } }, "UserPoolId": { @@ -8373,10 +8416,11 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", + "GroupName": { + "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { - "smithy.api#documentation": "

The limit of the request to list users.

" + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#required": {} } }, "NextToken": { @@ -8390,29 +8434,23 @@ "com.amazonaws.cognitoidentityprovider#ListUsersInGroupResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" - } - }, "Users": { "target": "com.amazonaws.cognitoidentityprovider#UsersListType", "traits": { "smithy.api#documentation": "

The users returned in the request to list users.

" } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } } } }, "com.amazonaws.cognitoidentityprovider#ListUsersRequest": { "type": "structure", "members": { - "AttributesToGet": { - "target": "com.amazonaws.cognitoidentityprovider#SearchedAttributeNamesListType", - "traits": { - "smithy.api#documentation": "

An array of strings, where each string is the name of a user attribute to be returned\n for each user in the search results. If the array is null, all attributes are\n returned.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -8426,10 +8464,10 @@ "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } }, - "Limit": { - "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", + "AttributesToGet": { + "target": "com.amazonaws.cognitoidentityprovider#SearchedAttributeNamesListType", "traits": { - "smithy.api#documentation": "

Maximum number of users to be returned.

" + "smithy.api#documentation": "

An array of strings, where each string is the name of a user attribute to be returned\n for each user in the search results. If the array is null, all attributes are\n returned.

" } }, "Filter": { @@ -8437,6 +8475,12 @@ "traits": { "smithy.api#documentation": "

A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character. For example,\n \"family_name = \\\"Reddy\\\"\".

\n \n

If the filter string is empty, ListUsers returns all users in the user\n pool.

\n

You can only search for the following standard attributes:

\n \n

Custom attributes are not searchable.

\n

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito\n Developer Guide.

" } + }, + "Limit": { + "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", + "traits": { + "smithy.api#documentation": "

Maximum number of users to be returned.

" + } } }, "traits": { @@ -8446,17 +8490,17 @@ "com.amazonaws.cognitoidentityprovider#ListUsersResponse": { "type": "structure", "members": { - "Users": { - "target": "com.amazonaws.cognitoidentityprovider#UsersListType", - "traits": { - "smithy.api#documentation": "

The users returned in the request to list users.

" - } - }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } + }, + "Users": { + "target": "com.amazonaws.cognitoidentityprovider#UsersListType", + "traits": { + "smithy.api#documentation": "

The users returned in the request to list users.

" + } } }, "traits": { @@ -8503,21 +8547,21 @@ "com.amazonaws.cognitoidentityprovider#MFAOptionType": { "type": "structure", "members": { - "DeliveryMedium": { - "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumType", - "traits": { - "smithy.api#documentation": "

The delivery medium to send the MFA code. You can use this parameter to set only the\n SMS delivery medium value.

" - } - }, "AttributeName": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", "traits": { "smithy.api#documentation": "

The attribute name of the MFA option type. The only valid value is\n phone_number.

" } + }, + "DeliveryMedium": { + "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumType", + "traits": { + "smithy.api#documentation": "

The delivery medium to send the MFA code. You can use this parameter to set only the\n SMS delivery medium value.

" + } } }, "traits": { - "smithy.api#documentation": "

\n This data type is no longer supported. You can use it only for\n SMS MFA configurations. You can't use it for TOTP software token MFA\n configurations.

\n

To set either type of MFA configuration, use the AdminSetUserMFAPreference or SetUserMFAPreference\n actions.

\n

To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList or GetUserResponse$UserMFASettingList responses.

" + "smithy.api#documentation": "

\n This data type is no longer supported. You can use it only for\n SMS MFA configurations. You can't use it for TOTP software token MFA\n configurations.

" } }, "com.amazonaws.cognitoidentityprovider#MessageActionType": { @@ -8538,10 +8582,10 @@ "com.amazonaws.cognitoidentityprovider#MessageTemplateType": { "type": "structure", "members": { - "EmailMessage": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", + "EmailSubject": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "

The message template for email messages.

" + "smithy.api#documentation": "

The subject line for email messages.

" } }, "SMSMessage": { @@ -8550,10 +8594,10 @@ "smithy.api#documentation": "

The message template for SMS messages.

" } }, - "EmailSubject": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", + "EmailMessage": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "

The subject line for email messages.

" + "smithy.api#documentation": "

The message template for email messages.

" } } }, @@ -8567,17 +8611,17 @@ "com.amazonaws.cognitoidentityprovider#NewDeviceMetadataType": { "type": "structure", "members": { - "DeviceGroupKey": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

The device group key.

" - } - }, "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { "smithy.api#documentation": "

The device key.

" } + }, + "DeviceGroupKey": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The device group key.

" + } } }, "traits": { @@ -8603,10 +8647,10 @@ "com.amazonaws.cognitoidentityprovider#NotifyConfigurationType": { "type": "structure", "members": { - "From": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", + "NoActionEmail": { + "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", "traits": { - "smithy.api#documentation": "

The email address that is sending the email. It must be either individually verified\n with Amazon SES, or from a domain that has been verified with Amazon SES.

" + "smithy.api#documentation": "

The email template used when a detected risk event is allowed.

" } }, "SourceArn": { @@ -8616,12 +8660,6 @@ "smithy.api#required": {} } }, - "NoActionEmail": { - "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", - "traits": { - "smithy.api#documentation": "

The email template used when a detected risk event is allowed.

" - } - }, "ReplyTo": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { @@ -8634,6 +8672,12 @@ "smithy.api#documentation": "

The MFA email template used when MFA is challenged as part of a detected risk.

" } }, + "From": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The email address that is sending the email. It must be either individually verified\n with Amazon SES, or from a domain that has been verified with Amazon SES.

" + } + }, "BlockEmail": { "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", "traits": { @@ -8648,19 +8692,19 @@ "com.amazonaws.cognitoidentityprovider#NotifyEmailType": { "type": "structure", "members": { - "Subject": { - "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationSubjectType", - "traits": { - "smithy.api#documentation": "

The subject.

", - "smithy.api#required": {} - } - }, "HtmlBody": { "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationBodyType", "traits": { "smithy.api#documentation": "

The HTML body.

" } }, + "Subject": { + "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationSubjectType", + "traits": { + "smithy.api#documentation": "

The subject.

", + "smithy.api#required": {} + } + }, "TextBody": { "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationBodyType", "traits": { @@ -8753,10 +8797,10 @@ "com.amazonaws.cognitoidentityprovider#PasswordPolicyType": { "type": "structure", "members": { - "RequireSymbols": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "TemporaryPasswordValidityDays": { + "target": "com.amazonaws.cognitoidentityprovider#TemporaryPasswordValidityDaysType", "traits": { - "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one symbol in their password.

" + "smithy.api#documentation": "

In the password policy you have set, refers to the number of days a temporary password\n is valid. If the user does not sign-in during this time, their password will need to be\n reset by an administrator.

\n \n

When you set TemporaryPasswordValidityDays for a user pool, you will\n no longer be able to set the deprecated UnusedAccountValidityDays value\n for that user pool.

\n " } }, "RequireUppercase": { @@ -8765,10 +8809,10 @@ "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one uppercase letter in their password.

" } }, - "TemporaryPasswordValidityDays": { - "target": "com.amazonaws.cognitoidentityprovider#TemporaryPasswordValidityDaysType", + "RequireLowercase": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

In the password policy you have set, refers to the number of days a temporary password\n is valid. If the user does not sign-in during this time, their password will need to be\n reset by an administrator.

\n \n

When you set TemporaryPasswordValidityDays for a user pool, you will\n no longer be able to set the deprecated UnusedAccountValidityDays value\n for that user pool.

\n " + "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one lowercase letter in their password.

" } }, "MinimumLength": { @@ -8777,16 +8821,16 @@ "smithy.api#documentation": "

The minimum length of the password policy that you have set. Cannot be less than\n 6.

" } }, - "RequireLowercase": { + "RequireNumbers": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one lowercase letter in their password.

" + "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one number in their password.

" } }, - "RequireNumbers": { + "RequireSymbols": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one number in their password.

" + "smithy.api#documentation": "

In the password policy that you have set, refers to whether you have required users to\n use at least one symbol in their password.

" } } }, @@ -8891,18 +8935,18 @@ "com.amazonaws.cognitoidentityprovider#ProviderDescription": { "type": "structure", "members": { - "ProviderName": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", - "traits": { - "smithy.api#documentation": "

The identity provider name.

" - } - }, "ProviderType": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", "traits": { "smithy.api#documentation": "

The identity provider type.

" } }, + "ProviderName": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", + "traits": { + "smithy.api#documentation": "

The identity provider name.

" + } + }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { @@ -8952,6 +8996,12 @@ "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType": { "type": "structure", "members": { + "ProviderAttributeValue": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The value of the provider attribute to link to, for example,\n xxxxx_account.

" + } + }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { @@ -8963,12 +9013,6 @@ "traits": { "smithy.api#documentation": "

The name of the provider attribute to link to, for example,\n NameID.

" } - }, - "ProviderAttributeValue": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

The value of the provider attribute to link to, for example,\n xxxxx_account.

" - } } }, "traits": { @@ -9040,17 +9084,17 @@ "com.amazonaws.cognitoidentityprovider#RecoveryOptionType": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.cognitoidentityprovider#RecoveryOptionNameType", + "Priority": { + "target": "com.amazonaws.cognitoidentityprovider#PriorityType", "traits": { - "smithy.api#documentation": "

Specifies the recovery method for a user.

", + "smithy.api#documentation": "

A positive integer specifying priority of a method with 1 being the highest\n priority.

", "smithy.api#required": {} } }, - "Priority": { - "target": "com.amazonaws.cognitoidentityprovider#PriorityType", + "Name": { + "target": "com.amazonaws.cognitoidentityprovider#RecoveryOptionNameType", "traits": { - "smithy.api#documentation": "

A positive integer specifying priority of a method with 1 being the highest\n priority.

", + "smithy.api#documentation": "

Specifies the recovery method for a user.

", "smithy.api#required": {} } } @@ -9074,7 +9118,7 @@ "traits": { "smithy.api#range": { "min": 0, - "max": 3650 + "max": 315360000 } } }, @@ -9139,12 +9183,6 @@ "com.amazonaws.cognitoidentityprovider#ResendConfirmationCodeRequest": { "type": "structure", "members": { - "UserContextData": { - "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", - "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" - } - }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { @@ -9152,11 +9190,10 @@ "smithy.api#required": {} } }, - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "UserContextData": { + "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

The ID of the client associated with the user pool.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } }, "SecretHash": { @@ -9165,6 +9202,13 @@ "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.

" } }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The ID of the client associated with the user pool.

", + "smithy.api#required": {} + } + }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { @@ -9288,12 +9332,6 @@ "com.amazonaws.cognitoidentityprovider#ResourceServerType": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", - "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool that hosts the resource server.

" - } - }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { @@ -9306,6 +9344,12 @@ "smithy.api#documentation": "

A list of scopes that are defined for the resource server.

" } }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID for the user pool that hosts the resource server.

" + } + }, "Name": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerNameType", "traits": { @@ -9402,42 +9446,36 @@ "com.amazonaws.cognitoidentityprovider#RespondToAuthChallengeRequest": { "type": "structure", "members": { - "ChallengeResponses": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", - "traits": { - "smithy.api#documentation": "

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

\n SECRET_HASH (if app client is configured with client secret) applies\n to all inputs below (including SOFTWARE_TOKEN_MFA).

\n \n " - } - }, - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "Session": { + "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "

The app client ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If InitiateAuth or RespondToAuthChallenge API call\n determines that the caller needs to go through another challenge, they return a session\n with other challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge API call.

" } }, - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "AnalyticsMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions\n that are assigned to the following triggers: post authentication,\n pre token generation, define auth\n challenge, create auth challenge, and\n verify auth challenge. When Amazon Cognito invokes any of these\n functions, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for\n RespondToAuthChallenge calls.

" } }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The challenge name. For more information, see .

\n

\n ADMIN_NO_SRP_AUTH is not a valid value.

", + "smithy.api#documentation": "

The challenge name. For more information, see InitiateAuth.

\n

\n ADMIN_NO_SRP_AUTH is not a valid value.

", "smithy.api#required": {} } }, - "AnalyticsMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for\n RespondToAuthChallenge calls.

" + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions\n that are assigned to the following triggers: post authentication,\n pre token generation, define auth\n challenge, create auth challenge, and\n verify auth challenge. When Amazon Cognito invokes any of these\n functions, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " } }, - "Session": { - "target": "com.amazonaws.cognitoidentityprovider#SessionType", + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If InitiateAuth or RespondToAuthChallenge API call\n determines that the caller needs to go through another challenge, they return a session\n with other challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge API call.

" + "smithy.api#documentation": "

The app client ID.

", + "smithy.api#required": {} } }, "UserContextData": { @@ -9445,6 +9483,12 @@ "traits": { "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } + }, + "ChallengeResponses": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", + "traits": { + "smithy.api#documentation": "

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

\n SECRET_HASH (if app client is configured with client secret) applies\n to all inputs below (including SOFTWARE_TOKEN_MFA).

\n \n " + } } }, "traits": { @@ -9454,28 +9498,28 @@ "com.amazonaws.cognitoidentityprovider#RespondToAuthChallengeResponse": { "type": "structure", "members": { - "AuthenticationResult": { - "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", + "ChallengeParameters": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", "traits": { - "smithy.api#documentation": "

The result returned by the server in response to the request to respond to the\n authentication challenge.

" + "smithy.api#documentation": "

The challenge parameters. For more information, see InitiateAuth.

" } }, - "ChallengeName": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", + "AuthenticationResult": { + "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", "traits": { - "smithy.api#documentation": "

The challenge name. For more information, see .

" + "smithy.api#documentation": "

The result returned by the server in response to the request to respond to the\n authentication challenge.

" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If the or API call determines that the caller needs to\n go through another challenge, they return a session with other challenge parameters.\n This session should be passed as it is to the next RespondToAuthChallenge\n API call.

" + "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service. If the caller needs to\n go through another challenge, they return a session with other challenge parameters.\n This session should be passed as it is to the next RespondToAuthChallenge\n API call.

" } }, - "ChallengeParameters": { - "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", + "ChallengeName": { + "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The challenge parameters. For more information, see .

" + "smithy.api#documentation": "

The challenge name. For more information, see InitiateAuth.

" } } }, @@ -9486,28 +9530,28 @@ "com.amazonaws.cognitoidentityprovider#RiskConfigurationType": { "type": "structure", "members": { - "RiskExceptionConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#RiskExceptionConfigurationType", - "traits": { - "smithy.api#documentation": "

The configuration to override the risk decision.

" - } - }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "

The app client ID.

" } }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID.

" + } + }, "AccountTakeoverRiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverRiskConfigurationType", "traits": { "smithy.api#documentation": "

The account takeover risk configuration object including the\n NotifyConfiguration object and Actions to take in the case\n of an account takeover.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "RiskExceptionConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#RiskExceptionConfigurationType", "traits": { - "smithy.api#documentation": "

The user pool ID.

" + "smithy.api#documentation": "

The configuration to override the risk decision.

" } }, "CompromisedCredentialsRiskConfiguration": { @@ -9549,17 +9593,17 @@ "com.amazonaws.cognitoidentityprovider#RiskExceptionConfigurationType": { "type": "structure", "members": { - "BlockedIPRangeList": { - "target": "com.amazonaws.cognitoidentityprovider#BlockedIPRangeListType", - "traits": { - "smithy.api#documentation": "

Overrides the risk decision to always block the pre-authentication requests. The IP\n range is in CIDR notation: a compact representation of an IP address and its associated\n routing prefix.

" - } - }, "SkippedIPRangeList": { "target": "com.amazonaws.cognitoidentityprovider#SkippedIPRangeListType", "traits": { "smithy.api#documentation": "

Risk detection is not performed on the IP addresses in the range list. The IP range is\n in CIDR notation.

" } + }, + "BlockedIPRangeList": { + "target": "com.amazonaws.cognitoidentityprovider#BlockedIPRangeListType", + "traits": { + "smithy.api#documentation": "

Overrides the risk decision to always block the pre-authentication requests. The IP\n range is in CIDR notation: a compact representation of an IP address and its associated\n routing prefix.

" + } } }, "traits": { @@ -9628,11 +9672,11 @@ "com.amazonaws.cognitoidentityprovider#SchemaAttributeType": { "type": "structure", "members": { - "Required": { + "Mutable": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies whether a user pool attribute is required. If the attribute is required and\n the user does not provide a value, registration or sign-in will fail.

" + "smithy.api#documentation": "

Specifies whether the value of the attribute can be changed.

\n

For any user pool attribute that's mapped to an identity provider attribute, you must\n set this parameter to true. Amazon Cognito updates mapped attributes when\n users sign in to your application through an identity provider. If an attribute is\n immutable, Amazon Cognito throws an error when it attempts to update the attribute. For\n more information, see Specifying Identity Provider Attribute Mappings for Your User\n Pool.

" } }, "StringAttributeConstraints": { @@ -9641,36 +9685,36 @@ "smithy.api#documentation": "

Specifies the constraints for an attribute of the string type.

" } }, - "Name": { - "target": "com.amazonaws.cognitoidentityprovider#CustomAttributeNameType", + "AttributeDataType": { + "target": "com.amazonaws.cognitoidentityprovider#AttributeDataType", "traits": { - "smithy.api#documentation": "

A schema attribute of the name type.

" + "smithy.api#documentation": "

The attribute data type.

" } }, - "DeveloperOnlyAttribute": { + "Required": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "\n

We recommend that you use WriteAttributes in the user pool client to control how attributes can\n be mutated for new use cases instead of using\n DeveloperOnlyAttribute.

\n \n

Specifies whether the attribute type is developer only. This attribute can only be\n modified by an administrator. Users will not be able to modify this attribute using\n their access token. For example, DeveloperOnlyAttribute can be modified\n using the API but cannot be updated\n using the API.

" + "smithy.api#documentation": "

Specifies whether a user pool attribute is required. If the attribute is required and\n the user does not provide a value, registration or sign-in will fail.

" } }, - "Mutable": { + "DeveloperOnlyAttribute": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies whether the value of the attribute can be changed.

\n

For any user pool attribute that's mapped to an identity provider attribute, you must\n set this parameter to true. Amazon Cognito updates mapped attributes when\n users sign in to your application through an identity provider. If an attribute is\n immutable, Amazon Cognito throws an error when it attempts to update the attribute. For\n more information, see Specifying Identity Provider Attribute Mappings for Your User\n Pool.

" + "smithy.api#documentation": "\n

We recommend that you use WriteAttributes in the user pool client to control how attributes can\n be mutated for new use cases instead of using\n DeveloperOnlyAttribute.

\n \n

Specifies whether the attribute type is developer only. This attribute can only be\n modified by an administrator. Users will not be able to modify this attribute using\n their access token. For example, DeveloperOnlyAttribute can be modified\n using AdminUpdateUserAttributes but cannot be updated\n using UpdateUserAttributes.

" } }, - "NumberAttributeConstraints": { - "target": "com.amazonaws.cognitoidentityprovider#NumberAttributeConstraintsType", + "Name": { + "target": "com.amazonaws.cognitoidentityprovider#CustomAttributeNameType", "traits": { - "smithy.api#documentation": "

Specifies the constraints for an attribute of the number type.

" + "smithy.api#documentation": "

A schema attribute of the name type.

" } }, - "AttributeDataType": { - "target": "com.amazonaws.cognitoidentityprovider#AttributeDataType", + "NumberAttributeConstraints": { + "target": "com.amazonaws.cognitoidentityprovider#NumberAttributeConstraintsType", "traits": { - "smithy.api#documentation": "

The attribute data type.

" + "smithy.api#documentation": "

Specifies the constraints for an attribute of the number type.

" } } }, @@ -9805,7 +9849,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures actions on detected risks. To delete the risk configuration for\n UserPoolId or ClientId, pass null values for all four\n configuration types.

\n

To enable Amazon Cognito advanced security features, update the user pool to include\n the UserPoolAddOns keyAdvancedSecurityMode.

\n

See .

" + "smithy.api#documentation": "

Configures actions on detected risks. To delete the risk configuration for\n UserPoolId or ClientId, pass null values for all four\n configuration types.

\n

To enable Amazon Cognito advanced security features, update the user pool to include\n the UserPoolAddOns keyAdvancedSecurityMode.

" } }, "com.amazonaws.cognitoidentityprovider#SetRiskConfigurationRequest": { @@ -9817,12 +9861,6 @@ "smithy.api#documentation": "

The configuration to override the risk decision.

" } }, - "AccountTakeoverRiskConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverRiskConfigurationType", - "traits": { - "smithy.api#documentation": "

The account takeover risk configuration.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -9836,6 +9874,12 @@ "smithy.api#documentation": "

The compromised credentials risk configuration.

" } }, + "AccountTakeoverRiskConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverRiskConfigurationType", + "traits": { + "smithy.api#documentation": "

The account takeover risk configuration.

" + } + }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { @@ -9888,6 +9932,18 @@ "com.amazonaws.cognitoidentityprovider#SetUICustomizationRequest": { "type": "structure", "members": { + "ImageFile": { + "target": "com.amazonaws.cognitoidentityprovider#ImageFileType", + "traits": { + "smithy.api#documentation": "

The uploaded logo image for the UI customization.

" + } + }, + "CSS": { + "target": "com.amazonaws.cognitoidentityprovider#CSSType", + "traits": { + "smithy.api#documentation": "

The CSS values in the UI customization.

" + } + }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { @@ -9900,18 +9956,6 @@ "smithy.api#documentation": "

The user pool ID for the user pool.

", "smithy.api#required": {} } - }, - "CSS": { - "target": "com.amazonaws.cognitoidentityprovider#CSSType", - "traits": { - "smithy.api#documentation": "

The CSS values in the UI customization.

" - } - }, - "ImageFile": { - "target": "com.amazonaws.cognitoidentityprovider#ImageFileType", - "traits": { - "smithy.api#documentation": "

The uploaded logo image for the UI customization.

" - } } } }, @@ -9965,6 +10009,12 @@ "com.amazonaws.cognitoidentityprovider#SetUserMFAPreferenceRequest": { "type": "structure", "members": { + "SoftwareTokenMfaSettings": { + "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", + "traits": { + "smithy.api#documentation": "

The time-based one-time password software token MFA settings.

" + } + }, "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { @@ -9972,14 +10022,8 @@ "smithy.api#required": {} } }, - "SoftwareTokenMfaSettings": { - "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", - "traits": { - "smithy.api#documentation": "

The time-based one-time password software token MFA settings.

" - } - }, - "SMSMfaSettings": { - "target": "com.amazonaws.cognitoidentityprovider#SMSMfaSettingsType", + "SMSMfaSettings": { + "target": "com.amazonaws.cognitoidentityprovider#SMSMfaSettingsType", "traits": { "smithy.api#documentation": "

The SMS text message multi-factor authentication (MFA) settings.

" } @@ -10028,6 +10072,12 @@ "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigRequest": { "type": "structure", "members": { + "MfaConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", + "traits": { + "smithy.api#documentation": "

The MFA configuration. Valid values include:

\n " + } + }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { @@ -10035,10 +10085,10 @@ "smithy.api#required": {} } }, - "MfaConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", + "SmsMfaConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType", "traits": { - "smithy.api#documentation": "

The MFA configuration. Valid values include:

\n " + "smithy.api#documentation": "

The SMS text message MFA configuration.

" } }, "SoftwareTokenMfaConfiguration": { @@ -10046,24 +10096,12 @@ "traits": { "smithy.api#documentation": "

The software token MFA configuration.

" } - }, - "SmsMfaConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType", - "traits": { - "smithy.api#documentation": "

The SMS text message MFA configuration.

" - } } } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigResponse": { "type": "structure", "members": { - "MfaConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", - "traits": { - "smithy.api#documentation": "

The MFA configuration. Valid values include:

\n " - } - }, "SoftwareTokenMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaConfigType", "traits": { @@ -10075,6 +10113,12 @@ "traits": { "smithy.api#documentation": "

The SMS text message MFA configuration.

" } + }, + "MfaConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", + "traits": { + "smithy.api#documentation": "

The MFA configuration. Valid values include:

\n " + } } } }, @@ -10111,7 +10155,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either\n type of MFA, use the SetUserMFAPreference action instead.

", + "smithy.api#documentation": "

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either\n type of MFA, use SetUserMFAPreference instead.

", "smithy.api#optionalAuth": {} } }, @@ -10205,17 +10249,10 @@ "com.amazonaws.cognitoidentityprovider#SignUpRequest": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", - "traits": { - "smithy.api#documentation": "

The user name of the user you wish to register.

", - "smithy.api#required": {} - } - }, - "ClientMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", + "AnalyticsMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { - "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the SignUp API action, Amazon Cognito invokes any functions that are\n assigned to the following triggers: pre sign-up, custom\n message, and post confirmation. When Amazon Cognito\n invokes any of these functions, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your SignUp request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " + "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for SignUp\n calls.

" } }, "Password": { @@ -10225,10 +10262,10 @@ "smithy.api#required": {} } }, - "AnalyticsMetadata": { - "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", + "ClientMetadata": { + "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics metadata for collecting metrics for SignUp\n calls.

" + "smithy.api#documentation": "

A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.

\n

You create custom workflows by assigning AWS Lambda functions to user pool triggers.\n When you use the SignUp API action, Amazon Cognito invokes any functions that are\n assigned to the following triggers: pre sign-up, custom\n message, and post confirmation. When Amazon Cognito\n invokes any of these functions, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your SignUp request. In your\n function code in AWS Lambda, you can process the clientMetadata value to\n enhance your workflow for your specific needs.

\n

For more information, see Customizing User Pool Workflows with Lambda Triggers in the\n Amazon Cognito Developer Guide.

\n \n

Take the following limitations into consideration when you use the ClientMetadata\n parameter:

\n
    \n
  • \n

    Amazon Cognito does not store the ClientMetadata value. This data is\n available only to AWS Lambda triggers that are assigned to a user pool to\n support custom workflows. If your user pool configuration does not include\n triggers, the ClientMetadata parameter serves no purpose.

    \n
    • \n
  • \n

    Amazon Cognito does not validate the ClientMetadata value.

    \n
    • \n
  • \n

    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use\n it to provide sensitive information.

    \n
    • \n
\n " } }, "UserAttributes": { @@ -10237,11 +10274,10 @@ "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

" } }, - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "SecretHash": { + "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { - "smithy.api#documentation": "

The ID of the client associated with the user pool.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.

" } }, "UserContextData": { @@ -10250,10 +10286,11 @@ "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } }, - "SecretHash": { - "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.

" + "smithy.api#documentation": "

The user name of the user you wish to register.

", + "smithy.api#required": {} } }, "ValidationData": { @@ -10261,6 +10298,13 @@ "traits": { "smithy.api#documentation": "

The validation data in the request to register a user.

" } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The ID of the client associated with the user pool.

", + "smithy.api#required": {} + } } }, "traits": { @@ -10270,13 +10314,6 @@ "com.amazonaws.cognitoidentityprovider#SignUpResponse": { "type": "structure", "members": { - "UserConfirmed": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", - "traits": { - "smithy.api#documentation": "

A response from the server indicating that a user registration has been\n confirmed.

", - "smithy.api#required": {} - } - }, "UserSub": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { @@ -10289,6 +10326,13 @@ "traits": { "smithy.api#documentation": "

The code delivery details returned by the server response to the user registration\n request.

" } + }, + "UserConfirmed": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "traits": { + "smithy.api#documentation": "

A response from the server indicating that a user registration has been\n confirmed.

", + "smithy.api#required": {} + } } }, "traits": { @@ -10310,18 +10354,18 @@ "com.amazonaws.cognitoidentityprovider#SmsConfigurationType": { "type": "structure", "members": { - "ExternalId": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", - "traits": { - "smithy.api#documentation": "

The external ID is a value that we recommend you use to add security to your IAM role\n which is used to call Amazon SNS to send SMS messages for your user pool. If you provide\n an ExternalId, the Cognito User Pool will include it when attempting to\n assume your IAM role, so that you can set your roles trust policy to require the\n ExternalID. If you use the Cognito Management Console to create a role\n for SMS MFA, Cognito will create a role with the required permissions and a trust policy\n that demonstrates use of the ExternalId.

" - } - }, "SnsCallerArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.\n This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS\n messages.

", "smithy.api#required": {} } + }, + "ExternalId": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The external ID is a value that we recommend you use to add security to your IAM role\n which is used to call Amazon SNS to send SMS messages for your user pool. If you provide\n an ExternalId, the Cognito User Pool will include it when attempting to\n assume your IAM role, so that you can set your roles trust policy to require the\n ExternalID. If you use the Cognito Management Console to create a role\n for SMS MFA, Cognito will create a role with the required permissions and a trust policy\n that demonstrates use of the ExternalId.

" + } } }, "traits": { @@ -10450,17 +10494,17 @@ "com.amazonaws.cognitoidentityprovider#StartUserImportJobRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The job ID for the user import job.

", + "smithy.api#documentation": "

The user pool ID for the user pool that the users are being imported into.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "JobId": { + "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool that the users are being imported into.

", + "smithy.api#documentation": "

The job ID for the user import job.

", "smithy.api#required": {} } } @@ -10533,17 +10577,17 @@ "com.amazonaws.cognitoidentityprovider#StopUserImportJobRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The job ID for the user import job.

", + "smithy.api#documentation": "

The user pool ID for the user pool that the users are being imported into.

", "smithy.api#required": {} } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "JobId": { + "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool that the users are being imported into.

", + "smithy.api#documentation": "

The job ID for the user import job.

", "smithy.api#required": {} } } @@ -10674,6 +10718,29 @@ } } }, + "com.amazonaws.cognitoidentityprovider#TimeUnitsType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "seconds", + "name": "SECONDS" + }, + { + "value": "minutes", + "name": "MINUTES" + }, + { + "value": "hours", + "name": "HOURS" + }, + { + "value": "days", + "name": "DAYS" + } + ] + } + }, "com.amazonaws.cognitoidentityprovider#TokenModelType": { "type": "string", "traits": { @@ -10681,6 +10748,32 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType": { + "type": "structure", + "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", + "traits": { + "smithy.api#documentation": "

A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.

" + } + }, + "IdToken": { + "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", + "traits": { + "smithy.api#documentation": "

A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.

" + } + }, + "RefreshToken": { + "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", + "traits": { + "smithy.api#documentation": "

A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data type for TokenValidityUnits that specifics the time measurements for token validity.

" + } + }, "com.amazonaws.cognitoidentityprovider#TooManyFailedAttemptsException": { "type": "structure", "members": { @@ -10716,16 +10809,10 @@ "com.amazonaws.cognitoidentityprovider#UICustomizationType": { "type": "structure", "members": { - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", - "traits": { - "smithy.api#documentation": "

The client ID for the client app.

" - } - }, - "ImageUrl": { - "target": "com.amazonaws.cognitoidentityprovider#ImageUrlType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The logo image for the UI customization.

" + "smithy.api#documentation": "

The user pool ID for the user pool.

" } }, "CSS": { @@ -10734,10 +10821,10 @@ "smithy.api#documentation": "

The CSS values in the UI customization.

" } }, - "CSSVersion": { - "target": "com.amazonaws.cognitoidentityprovider#CSSVersionType", + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The CSS version number.

" + "smithy.api#documentation": "

The last-modified date for the UI customization.

" } }, "CreationDate": { @@ -10746,16 +10833,22 @@ "smithy.api#documentation": "

The creation date for the UI customization.

" } }, - "LastModifiedDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

The last-modified date for the UI customization.

" + "smithy.api#documentation": "

The client ID for the client app.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "ImageUrl": { + "target": "com.amazonaws.cognitoidentityprovider#ImageUrlType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool.

" + "smithy.api#documentation": "

The logo image for the UI customization.

" + } + }, + "CSSVersion": { + "target": "com.amazonaws.cognitoidentityprovider#CSSVersionType", + "traits": { + "smithy.api#documentation": "

The CSS version number.

" } } }, @@ -10840,17 +10933,17 @@ "com.amazonaws.cognitoidentityprovider#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.cognitoidentityprovider#ArnType", + "TagKeys": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsListType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

", + "smithy.api#documentation": "

The keys of the tags to remove from the user pool.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsListType", + "ResourceArn": { + "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The keys of the tags to remove from the user pool.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

", "smithy.api#required": {} } } @@ -10898,31 +10991,31 @@ "com.amazonaws.cognitoidentityprovider#UpdateAuthEventFeedbackRequest": { "type": "structure", "members": { - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "EventId": { + "target": "com.amazonaws.cognitoidentityprovider#EventIdType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#documentation": "

The event ID.

", "smithy.api#required": {} } }, - "FeedbackValue": { - "target": "com.amazonaws.cognitoidentityprovider#FeedbackValueType", + "FeedbackToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

The authentication event feedback value.

", + "smithy.api#documentation": "

The feedback token.

", "smithy.api#required": {} } }, - "EventId": { - "target": "com.amazonaws.cognitoidentityprovider#EventIdType", + "FeedbackValue": { + "target": "com.amazonaws.cognitoidentityprovider#FeedbackValueType", "traits": { - "smithy.api#documentation": "

The event ID.

", + "smithy.api#documentation": "

The authentication event feedback value.

", "smithy.api#required": {} } }, - "FeedbackToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The feedback token.

", + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } }, @@ -10983,13 +11076,6 @@ "com.amazonaws.cognitoidentityprovider#UpdateDeviceStatusRequest": { "type": "structure", "members": { - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", - "traits": { - "smithy.api#documentation": "

The access token.

", - "smithy.api#required": {} - } - }, "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { @@ -11002,6 +11088,13 @@ "traits": { "smithy.api#documentation": "

The status of whether a device is remembered.

" } + }, + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

The access token.

", + "smithy.api#required": {} + } } }, "traits": { @@ -11047,6 +11140,12 @@ "com.amazonaws.cognitoidentityprovider#UpdateGroupRequest": { "type": "structure", "members": { + "Precedence": { + "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", + "traits": { + "smithy.api#documentation": "

The new precedence value for the group. For more information about this parameter, see\n CreateGroup.

" + } + }, "GroupName": { "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { @@ -11061,12 +11160,6 @@ "smithy.api#required": {} } }, - "Precedence": { - "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", - "traits": { - "smithy.api#documentation": "

The new precedence value for the group. For more information about this parameter, see\n .

" - } - }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { @@ -11127,16 +11220,16 @@ "com.amazonaws.cognitoidentityprovider#UpdateIdentityProviderRequest": { "type": "structure", "members": { - "IdpIdentifiers": { - "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", + "ProviderDetails": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", "traits": { - "smithy.api#documentation": "

A list of identity provider identifiers.

" + "smithy.api#documentation": "

The identity provider details to be updated, such as MetadataURL and\n MetadataFile.

" } }, - "ProviderName": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The identity provider name.

", + "smithy.api#documentation": "

The user pool ID.

", "smithy.api#required": {} } }, @@ -11146,17 +11239,17 @@ "smithy.api#documentation": "

The identity provider attribute mapping to be changed.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "ProviderName": { + "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "

The user pool ID.

", + "smithy.api#documentation": "

The identity provider name.

", "smithy.api#required": {} } }, - "ProviderDetails": { - "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", + "IdpIdentifiers": { + "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { - "smithy.api#documentation": "

The identity provider details to be updated, such as MetadataURL and\n MetadataFile.

" + "smithy.api#documentation": "

A list of identity provider identifiers.

" } } } @@ -11205,6 +11298,12 @@ "com.amazonaws.cognitoidentityprovider#UpdateResourceServerRequest": { "type": "structure", "members": { + "Scopes": { + "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeListType", + "traits": { + "smithy.api#documentation": "

The scope values to be set for the resource server.

" + } + }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { @@ -11225,12 +11324,6 @@ "smithy.api#documentation": "

The name of the resource server.

", "smithy.api#required": {} } - }, - "Scopes": { - "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeListType", - "traits": { - "smithy.api#documentation": "

The scope values to be set for the resource server.

" - } } } }, @@ -11319,6 +11412,13 @@ "com.amazonaws.cognitoidentityprovider#UpdateUserAttributesRequest": { "type": "structure", "members": { + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "traits": { + "smithy.api#documentation": "

The access token for the request to update user attributes.

", + "smithy.api#required": {} + } + }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { @@ -11331,13 +11431,6 @@ "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

", "smithy.api#required": {} } - }, - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", - "traits": { - "smithy.api#documentation": "

The access token for the request to update user attributes.

", - "smithy.api#required": {} - } } }, "traits": { @@ -11402,7 +11495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings with .

\n \n

If you don't provide a value for an attribute, it will be set to the default\n value.

\n " + "smithy.api#documentation": "

Updates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool.

\n \n

If you don't provide a value for an attribute, it will be set to the default\n value.

\n " } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClient": { @@ -11440,16 +11533,16 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified user pool app client with the specified attributes. You can get\n a list of the current user pool app client settings with .

\n \n

If you don't provide a value for an attribute, it will be set to the default\n value.

\n " + "smithy.api#documentation": "

Updates the specified user pool app client with the specified attributes. You can get\n a list of the current user pool app client settings using DescribeUserPoolClient.

\n \n

If you don't provide a value for an attribute, it will be set to the default\n value.

\n " } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClientRequest": { "type": "structure", "members": { - "SupportedIdentityProviders": { - "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", + "IdTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { - "smithy.api#documentation": "

A list of provider names for the identity providers that are supported on this\n client.

" + "smithy.api#documentation": "

The time limit, after which the ID token is no longer valid and cannot be used.

" } }, "CallbackURLs": { @@ -11458,35 +11551,53 @@ "smithy.api#documentation": "

A list of allowed redirect (callback) URLs for the identity providers.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" } }, - "AllowedOAuthScopes": { - "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", + "LogoutURLs": { + "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", "traits": { - "smithy.api#documentation": "

The allowed OAuth scopes. Possible values provided by OAuth are: phone,\n email, openid, and profile. Possible values\n provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created\n in Resource Servers are also supported.

" + "smithy.api#documentation": "

A list of allowed logout URLs for the identity providers.

" } }, - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "AllowedOAuthFlowsUserPoolClient": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

The ID of the client associated with the user pool.

", + "smithy.api#documentation": "

Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Cognito user pools.

" + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The user pool ID for the user pool where you want to update the user pool\n client.

", "smithy.api#required": {} } }, - "LogoutURLs": { - "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", + "TokenValidityUnits": { + "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { - "smithy.api#documentation": "

A list of allowed logout URLs for the identity providers.

" + "smithy.api#documentation": "

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

" } }, - "RefreshTokenValidity": { - "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", + "SupportedIdentityProviders": { + "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

The time limit, in days, after which the refresh token is no longer valid and cannot\n be used.

" + "smithy.api#documentation": "

A list of provider names for the identity providers that are supported on this\n client.

" } }, - "PreventUserExistenceErrors": { - "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", + "ReadAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", + "traits": { + "smithy.api#documentation": "

The read-only attributes of the user pool.

" + } + }, + "AccessTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType", + "traits": { + "smithy.api#documentation": "

The time limit, after which the access token is no longer valid and cannot be used.

" + } + }, + "ExplicitAuthFlows": { + "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "

Use this setting to choose which errors and responses are returned by Cognito APIs\n during authentication, account confirmation, and password recovery when the user does\n not exist in the user pool. When set to ENABLED and the user does not\n exist, authentication returns an error indicating either the username or password was\n incorrect, and account confirmation and password recovery return a response indicating a\n code was sent to a simulated destination. When set to LEGACY, those APIs\n will return a UserNotFoundException exception if the user does not exist in\n the user pool.

\n

Valid values include:

\n \n

This setting affects the behavior of following APIs:

\n \n \n

After February 15th 2020, the value of PreventUserExistenceErrors\n will default to ENABLED for newly created user pool clients if no value\n is provided.

\n " + "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_ prefix are deprecated in favor of new names with the\n ALLOW_ prefix. Note that values with ALLOW_ prefix cannot\n be used along with values without ALLOW_ prefix.

\n

Valid values include:

\n " } }, "WriteAttributes": { @@ -11495,23 +11606,23 @@ "smithy.api#documentation": "

The writeable attributes of the user pool.

" } }, - "AnalyticsConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", + "DefaultRedirectURI": { + "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for this user\n pool.

\n \n

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

\n " + "smithy.api#documentation": "

The default redirect URI. Must be in the CallbackURLs list.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool where you want to update the user pool\n client.

", + "smithy.api#documentation": "

The ID of the client associated with the user pool.

", "smithy.api#required": {} } }, - "AllowedOAuthFlows": { - "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", + "AllowedOAuthScopes": { + "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", "traits": { - "smithy.api#documentation": "

The allowed OAuth flows.

\n

Set to code to initiate a code grant flow, which provides an\n authorization code as the response. This code can be exchanged for access tokens with\n the token endpoint.

\n

Set to implicit to specify that the client should get the access token\n (and, optionally, ID token, based on scopes) directly.

\n

Set to client_credentials to specify that the client should get the\n access token (and, optionally, ID token, based on scopes) from the token endpoint using\n a combination of client and client_secret.

" + "smithy.api#documentation": "

The allowed OAuth scopes. Possible values provided by OAuth are: phone,\n email, openid, and profile. Possible values\n provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created\n in Resource Servers are also supported.

" } }, "ClientName": { @@ -11520,28 +11631,28 @@ "smithy.api#documentation": "

The client name from the update user pool client request.

" } }, - "ExplicitAuthFlows": { - "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", + "PreventUserExistenceErrors": { + "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", "traits": { - "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_ prefix are deprecated in favor of new names with the\n ALLOW_ prefix. Note that values with ALLOW_ prefix cannot\n be used along with values without ALLOW_ prefix.

\n

Valid values include:

\n " + "smithy.api#documentation": "

Use this setting to choose which errors and responses are returned by Cognito APIs\n during authentication, account confirmation, and password recovery when the user does\n not exist in the user pool. When set to ENABLED and the user does not\n exist, authentication returns an error indicating either the username or password was\n incorrect, and account confirmation and password recovery return a response indicating a\n code was sent to a simulated destination. When set to LEGACY, those APIs\n will return a UserNotFoundException exception if the user does not exist in\n the user pool.

\n

Valid values include:

\n \n \n \n \n

After February 15th 2020, the value of PreventUserExistenceErrors\n will default to ENABLED for newly created user pool clients if no value\n is provided.

\n " } }, - "AllowedOAuthFlowsUserPoolClient": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", + "AllowedOAuthFlows": { + "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", "traits": { - "smithy.api#documentation": "

Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Cognito user pools.

" + "smithy.api#documentation": "

The allowed OAuth flows.

\n

Set to code to initiate a code grant flow, which provides an\n authorization code as the response. This code can be exchanged for access tokens with\n the token endpoint.

\n

Set to implicit to specify that the client should get the access token\n (and, optionally, ID token, based on scopes) directly.

\n

Set to client_credentials to specify that the client should get the\n access token (and, optionally, ID token, based on scopes) from the token endpoint using\n a combination of client and client_secret.

" } }, - "DefaultRedirectURI": { - "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", + "RefreshTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { - "smithy.api#documentation": "

The default redirect URI. Must be in the CallbackURLs list.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" + "smithy.api#documentation": "

The time limit, in days, after which the refresh token is no longer valid and cannot\n be used.

" } }, - "ReadAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", + "AnalyticsConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "

The read-only attributes of the user pool.

" + "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for collecting metrics for this user\n pool.

\n \n

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1.\n In regions where Pinpoint is available, Cognito User Pools will \n support sending events to Amazon Pinpoint projects within that same region.\n

\n " } } }, @@ -11595,17 +11706,17 @@ "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainRequest": { "type": "structure", "members": { - "Domain": { - "target": "com.amazonaws.cognitoidentityprovider#DomainType", + "CustomDomainConfig": { + "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", "traits": { - "smithy.api#documentation": "

The domain name for the custom domain that hosts the sign-up and sign-in pages for\n your application. For example: auth.example.com.

\n

This string can include only lowercase letters, numbers, and hyphens. Do not use a\n hyphen for the first or last character. Use periods to separate subdomain names.

", + "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in pages for\n your application. Use this object to specify an SSL certificate that is managed by\n ACM.

", "smithy.api#required": {} } }, - "CustomDomainConfig": { - "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", + "Domain": { + "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "

The configuration for a custom domain that hosts the sign-up and sign-in pages for\n your application. Use this object to specify an SSL certificate that is managed by\n ACM.

", + "smithy.api#documentation": "

The domain name for the custom domain that hosts the sign-up and sign-in pages for\n your application. For example: auth.example.com.

\n

This string can include only lowercase letters, numbers, and hyphens. Do not use a\n hyphen for the first or last character. Use periods to separate subdomain names.

", "smithy.api#required": {} } }, @@ -11638,59 +11749,52 @@ "com.amazonaws.cognitoidentityprovider#UpdateUserPoolRequest": { "type": "structure", "members": { - "UserPoolAddOns": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", - "traits": { - "smithy.api#documentation": "

Used to enable advanced security risk detection. Set the key\n AdvancedSecurityMode to the value \"AUDIT\".

" - } - }, - "SmsVerificationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "EmailVerificationSubject": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "

A container with information about the SMS verification message.

" + "smithy.api#documentation": "

The subject of the email verification message.

" } }, - "EmailConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", + "SmsConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

Email configuration.

" + "smithy.api#documentation": "

SMS configuration.

" } }, - "EmailVerificationSubject": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", + "VerificationMessageTemplate": { + "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { - "smithy.api#documentation": "

The subject of the email verification message.

" + "smithy.api#documentation": "

The template for verification messages.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "UserPoolAddOns": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool you want to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Used to enable advanced security risk detection. Set the key\n AdvancedSecurityMode to the value \"AUDIT\".

" } }, - "LambdaConfig": { - "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", + "EmailConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", "traits": { - "smithy.api#documentation": "

The AWS Lambda configuration information from the request to update the user\n pool.

" + "smithy.api#documentation": "

Email configuration.

" } }, - "MfaConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", + "AdminCreateUserConfig": { + "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", "traits": { - "smithy.api#documentation": "

Can be one of the following values:

\n " + "smithy.api#documentation": "

The configuration for AdminCreateUser requests.

" } }, - "EmailVerificationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", + "AccountRecoverySetting": { + "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", "traits": { - "smithy.api#documentation": "

The contents of the email verification message.

" + "smithy.api#documentation": "

Use this setting to define which verified available method a user can use to recover\n their password when they call ForgotPassword. It allows you to define a\n preferred method when a user has more than one method available. With this setting, SMS\n does not qualify for a valid password recovery mechanism if the user also has SMS MFA\n enabled. In the absence of this setting, Cognito uses the legacy behavior to determine\n the recovery method where SMS is preferred over email.

" } }, - "DeviceConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", + "Policies": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { - "smithy.api#documentation": "

Device configuration.

" + "smithy.api#documentation": "

A container with the policies you wish to update in a user pool.

" } }, "UserPoolTags": { @@ -11699,46 +11803,53 @@ "smithy.api#documentation": "

The tag keys and values to assign to the user pool. A tag is a label that you can use\n to categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.

" } }, + "SmsAuthenticationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "traits": { + "smithy.api#documentation": "

The contents of the SMS authentication message.

" + } + }, "AutoVerifiedAttributes": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { "smithy.api#documentation": "

The attributes that are automatically verified when the Amazon Cognito service makes a\n request to update user pools.

" } }, - "SmsAuthenticationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The contents of the SMS authentication message.

" + "smithy.api#documentation": "

The user pool ID for the user pool you want to update.

", + "smithy.api#required": {} } }, - "AccountRecoverySetting": { - "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", + "SmsVerificationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { - "smithy.api#documentation": "

Use this setting to define which verified available method a user can use to recover\n their password when they call ForgotPassword. It allows you to define a\n preferred method when a user has more than one method available. With this setting, SMS\n does not qualify for a valid password recovery mechanism if the user also has SMS MFA\n enabled. In the absence of this setting, Cognito uses the legacy behavior to determine\n the recovery method where SMS is preferred over email.

" + "smithy.api#documentation": "

A container with information about the SMS verification message.

" } }, - "Policies": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", + "DeviceConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", "traits": { - "smithy.api#documentation": "

A container with the policies you wish to update in a user pool.

" + "smithy.api#documentation": "

Device configuration.

" } }, - "AdminCreateUserConfig": { - "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", + "EmailVerificationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "

The configuration for AdminCreateUser requests.

" + "smithy.api#documentation": "

The contents of the email verification message.

" } }, - "SmsConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", + "MfaConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "

SMS configuration.

" + "smithy.api#documentation": "

Can be one of the following values:

\n " } }, - "VerificationMessageTemplate": { - "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", + "LambdaConfig": { + "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { - "smithy.api#documentation": "

The template for verification messages.

" + "smithy.api#documentation": "

The AWS Lambda configuration information from the request to update the user\n pool.

" } } }, @@ -11854,34 +11965,46 @@ "com.amazonaws.cognitoidentityprovider#UserImportJobType": { "type": "structure", "members": { + "StartDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date when the user import job was started.

" + } + }, "JobId": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { "smithy.api#documentation": "

The job ID for the user import job.

" } }, - "CompletionDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", + "FailedUsers": { + "target": "com.amazonaws.cognitoidentityprovider#LongType", "traits": { - "smithy.api#documentation": "

The date when the user import job was completed.

" + "smithy.api#documentation": "

The number of users that could not be imported.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", - "traits": { + "CreationDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date the user import job was created.

" + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { "smithy.api#documentation": "

The user pool ID for the user pool that the users are being imported into.

" } }, - "CompletionMessage": { - "target": "com.amazonaws.cognitoidentityprovider#CompletionMessageType", + "SkippedUsers": { + "target": "com.amazonaws.cognitoidentityprovider#LongType", "traits": { - "smithy.api#documentation": "

The message returned when the user import job is completed.

" + "smithy.api#documentation": "

The number of users that were skipped.

" } }, - "StartDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The date when the user import job was started.

" + "smithy.api#documentation": "

The role ARN for the Amazon CloudWatch Logging role for the user import job. For more\n information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer\n Guide.

" } }, "PreSignedUrl": { @@ -11896,22 +12019,22 @@ "smithy.api#documentation": "

The number of users that were successfully imported.

" } }, - "JobName": { - "target": "com.amazonaws.cognitoidentityprovider#UserImportJobNameType", + "CompletionMessage": { + "target": "com.amazonaws.cognitoidentityprovider#CompletionMessageType", "traits": { - "smithy.api#documentation": "

The job name for the user import job.

" + "smithy.api#documentation": "

The message returned when the user import job is completed.

" } }, - "CreationDate": { + "CompletionDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user import job was created.

" + "smithy.api#documentation": "

The date when the user import job was completed.

" } }, - "FailedUsers": { - "target": "com.amazonaws.cognitoidentityprovider#LongType", + "JobName": { + "target": "com.amazonaws.cognitoidentityprovider#UserImportJobNameType", "traits": { - "smithy.api#documentation": "

The number of users that could not be imported.

" + "smithy.api#documentation": "

The job name for the user import job.

" } }, "Status": { @@ -11919,18 +12042,6 @@ "traits": { "smithy.api#documentation": "

The status of the user import job. One of the following:

\n " } - }, - "CloudWatchLogsRoleArn": { - "target": "com.amazonaws.cognitoidentityprovider#ArnType", - "traits": { - "smithy.api#documentation": "

The role ARN for the Amazon CloudWatch Logging role for the user import job. For more\n information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer\n Guide.

" - } - }, - "SkippedUsers": { - "target": "com.amazonaws.cognitoidentityprovider#LongType", - "traits": { - "smithy.api#documentation": "

The number of users that were skipped.

" - } } }, "traits": { @@ -12040,17 +12151,17 @@ "smithy.api#documentation": "

The ID of the client associated with the user pool.

" } }, - "ClientName": { - "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", - "traits": { - "smithy.api#documentation": "

The client name from the user pool client description.

" - } - }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "

The user pool ID for the user pool where you want to describe the user pool\n client.

" } + }, + "ClientName": { + "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", + "traits": { + "smithy.api#documentation": "

The client name from the user pool client description.

" + } } }, "traits": { @@ -12066,28 +12177,34 @@ "com.amazonaws.cognitoidentityprovider#UserPoolClientType": { "type": "structure", "members": { - "ExplicitAuthFlows": { - "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", + "RefreshTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { - "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_ prefix are deprecated in favor of new names with the\n ALLOW_ prefix. Note that values with ALLOW_ prefix cannot\n be used along with values without ALLOW_ prefix.

\n

Valid values include:

\n " + "smithy.api#documentation": "

The time limit, in days, after which the refresh token is no longer valid and cannot\n be used.

" } }, - "DefaultRedirectURI": { - "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", + "AllowedOAuthScopes": { + "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", "traits": { - "smithy.api#documentation": "

The default redirect URI. Must be in the CallbackURLs list.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" + "smithy.api#documentation": "

The allowed OAuth scopes. Possible values provided by OAuth are: phone,\n email, openid, and profile. Possible values\n provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created\n in Resource Servers are also supported.

" } }, - "WriteAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", + "CreationDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The writeable attributes.

" + "smithy.api#documentation": "

The date the user pool client was created.

" } }, - "RefreshTokenValidity": { - "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", + "AnalyticsConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "

The time limit, in days, after which the refresh token is no longer valid and cannot\n be used.

" + "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for the user pool client.

\n \n

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

\n " + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date the user pool client was last modified.

" } }, "AllowedOAuthFlowsUserPoolClient": { @@ -12103,40 +12220,46 @@ "smithy.api#documentation": "

The Read-only attributes.

" } }, - "AnalyticsConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", + "DefaultRedirectURI": { + "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration for the user pool client.

\n \n

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

\n " + "smithy.api#documentation": "

The default redirect URI. Must be in the CallbackURLs list.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" } }, - "PreventUserExistenceErrors": { - "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", + "SupportedIdentityProviders": { + "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

Use this setting to choose which errors and responses are returned by Cognito APIs\n during authentication, account confirmation, and password recovery when the user does\n not exist in the user pool. When set to ENABLED and the user does not\n exist, authentication returns an error indicating either the username or password was\n incorrect, and account confirmation and password recovery return a response indicating a\n code was sent to a simulated destination. When set to LEGACY, those APIs\n will return a UserNotFoundException exception if the user does not exist in\n the user pool.

\n

Valid values include:

\n \n

This setting affects the behavior of following APIs:

\n \n \n

After February 15th 2020, the value of PreventUserExistenceErrors\n will default to ENABLED for newly created user pool clients if no value\n is provided.

\n " + "smithy.api#documentation": "

A list of provider names for the identity providers that are supported on this\n client.

" } }, - "ClientSecret": { - "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The client secret from the user pool request of the client type.

" + "smithy.api#documentation": "

The user pool ID for the user pool client.

" } }, - "ClientId": { - "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "CallbackURLs": { + "target": "com.amazonaws.cognitoidentityprovider#CallbackURLsListType", "traits": { - "smithy.api#documentation": "

The ID of the client associated with the user pool.

" + "smithy.api#documentation": "

A list of allowed redirect (callback) URLs for the identity providers.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" } }, - "LogoutURLs": { - "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", + "TokenValidityUnits": { + "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { - "smithy.api#documentation": "

A list of allowed logout URLs for the identity providers.

" + "smithy.api#documentation": "

The time units used to specify the token validity times of their respective token.

" } }, - "SupportedIdentityProviders": { - "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", + "PreventUserExistenceErrors": { + "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", "traits": { - "smithy.api#documentation": "

A list of provider names for the identity providers that are supported on this\n client.

" + "smithy.api#documentation": "

Use this setting to choose which errors and responses are returned by Cognito APIs\n during authentication, account confirmation, and password recovery when the user does\n not exist in the user pool. When set to ENABLED and the user does not\n exist, authentication returns an error indicating either the username or password was\n incorrect, and account confirmation and password recovery return a response indicating a\n code was sent to a simulated destination. When set to LEGACY, those APIs\n will return a UserNotFoundException exception if the user does not exist in\n the user pool.

\n

Valid values include:

\n \n \n \n \n

After February 15th 2020, the value of PreventUserExistenceErrors\n will default to ENABLED for newly created user pool clients if no value\n is provided.

\n " + } + }, + "AllowedOAuthFlows": { + "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", + "traits": { + "smithy.api#documentation": "

The allowed OAuth flows.

\n

Set to code to initiate a code grant flow, which provides an\n authorization code as the response. This code can be exchanged for access tokens with\n the token endpoint.

\n

Set to implicit to specify that the client should get the access token\n (and, optionally, ID token, based on scopes) directly.

\n

Set to client_credentials to specify that the client should get the\n access token (and, optionally, ID token, based on scopes) from the token endpoint using\n a combination of client and client_secret.

" } }, "ClientName": { @@ -12145,40 +12268,46 @@ "smithy.api#documentation": "

The client name from the user pool request of the client type.

" } }, - "AllowedOAuthFlows": { - "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", + "WriteAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", "traits": { - "smithy.api#documentation": "

The allowed OAuth flows.

\n

Set to code to initiate a code grant flow, which provides an\n authorization code as the response. This code can be exchanged for access tokens with\n the token endpoint.

\n

Set to implicit to specify that the client should get the access token\n (and, optionally, ID token, based on scopes) directly.

\n

Set to client_credentials to specify that the client should get the\n access token (and, optionally, ID token, based on scopes) from the token endpoint using\n a combination of client and client_secret.

" + "smithy.api#documentation": "

The writeable attributes.

" } }, - "UserPoolId": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "ClientSecret": { + "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { - "smithy.api#documentation": "

The user pool ID for the user pool client.

" + "smithy.api#documentation": "

The client secret from the user pool request of the client type.

" } }, - "CreationDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", + "ExplicitAuthFlows": { + "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "

The date the user pool client was created.

" + "smithy.api#documentation": "

The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_ prefix are deprecated in favor of new names with the\n ALLOW_ prefix. Note that values with ALLOW_ prefix cannot\n be used along with values without ALLOW_ prefix.

\n

Valid values include:

\n " } }, - "LastModifiedDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", + "LogoutURLs": { + "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", "traits": { - "smithy.api#documentation": "

The date the user pool client was last modified.

" + "smithy.api#documentation": "

A list of allowed logout URLs for the identity providers.

" } }, - "CallbackURLs": { - "target": "com.amazonaws.cognitoidentityprovider#CallbackURLsListType", + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { - "smithy.api#documentation": "

A list of allowed redirect (callback) URLs for the identity providers.

\n

A redirect URI must:

\n \n

See OAuth 2.0 -\n Redirection Endpoint.

\n

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing\n purposes only.

\n

App callback URLs such as myapp://example are also supported.

" + "smithy.api#documentation": "

The ID of the client associated with the user pool.

" } }, - "AllowedOAuthScopes": { - "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", + "AccessTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType", "traits": { - "smithy.api#documentation": "

The allowed OAuth scopes. Possible values provided by OAuth are: phone,\n email, openid, and profile. Possible values\n provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created\n in Resource Servers are also supported.

" + "smithy.api#documentation": "

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.

" + } + }, + "IdTokenValidity": { + "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", + "traits": { + "smithy.api#documentation": "

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.

" } } }, @@ -12189,12 +12318,6 @@ "com.amazonaws.cognitoidentityprovider#UserPoolDescriptionType": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", - "traits": { - "smithy.api#documentation": "

The name in a user pool description.

" - } - }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { @@ -12207,10 +12330,10 @@ "smithy.api#documentation": "

The date the user pool description was created.

" } }, - "Id": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "Status": { + "target": "com.amazonaws.cognitoidentityprovider#StatusType", "traits": { - "smithy.api#documentation": "

The ID in a user pool description.

" + "smithy.api#documentation": "

The user pool status in a user pool description.

" } }, "LambdaConfig": { @@ -12219,10 +12342,16 @@ "smithy.api#documentation": "

The AWS Lambda configuration information in a user pool description.

" } }, - "Status": { - "target": "com.amazonaws.cognitoidentityprovider#StatusType", + "Id": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "

The user pool status in a user pool description.

" + "smithy.api#documentation": "

The ID in a user pool description.

" + } + }, + "Name": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", + "traits": { + "smithy.api#documentation": "

The name in a user pool description.

" } } }, @@ -12320,46 +12449,52 @@ "com.amazonaws.cognitoidentityprovider#UserPoolType": { "type": "structure", "members": { - "SmsVerificationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "CustomDomain": { + "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "

The contents of the SMS verification message.

" + "smithy.api#documentation": "

A custom domain name that you provide to Amazon Cognito. This parameter applies only\n if you use a custom domain to host the sign-up and sign-in pages for your application.\n For example: auth.example.com.

\n

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

" } }, - "SmsConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", + "EmailVerificationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "

The SMS configuration.

" + "smithy.api#documentation": "

The contents of the email verification message.

" } }, - "EstimatedNumberOfUsers": { - "target": "com.amazonaws.cognitoidentityprovider#IntegerType", + "SmsConfigurationFailure": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

A number estimating the size of the user pool.

" + "smithy.api#documentation": "

The reason why the SMS configuration cannot send the messages to your users.

" } }, - "LambdaConfig": { - "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", + "UserPoolAddOns": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "

The AWS Lambda triggers associated with the user pool.

" + "smithy.api#documentation": "

The user pool add-ons.

" } }, - "Domain": { - "target": "com.amazonaws.cognitoidentityprovider#DomainType", + "Status": { + "target": "com.amazonaws.cognitoidentityprovider#StatusType", "traits": { - "smithy.api#documentation": "

Holds the domain prefix if the user pool has a domain associated with it.

" + "smithy.api#documentation": "

The status of a user pool.

" } }, - "AliasAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", + "SmsAuthenticationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { - "smithy.api#documentation": "

Specifies the attributes that are aliased in a user pool.

" + "smithy.api#documentation": "

The contents of the SMS authentication message.

" } }, - "Name": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", + "EmailConfigurationFailure": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The name of the user pool.

" + "smithy.api#documentation": "

The reason why the email configuration cannot send the messages to your users.

" + } + }, + "AccountRecoverySetting": { + "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", + "traits": { + "smithy.api#documentation": "

Use this setting to define which verified available method a user can use to recover\n their password when they call ForgotPassword. It allows you to define a\n preferred method when a user has more than one method available. With this setting, SMS\n does not qualify for a valid password recovery mechanism if the user also has SMS MFA\n enabled. In the absence of this setting, Cognito uses the legacy behavior to determine\n the recovery method where SMS is preferred over email.

" } }, "LastModifiedDate": { @@ -12374,40 +12509,34 @@ "smithy.api#documentation": "

The date the user pool was created.

" } }, - "VerificationMessageTemplate": { - "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", - "traits": { - "smithy.api#documentation": "

The template for verification messages.

" - } - }, - "AccountRecoverySetting": { - "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", + "UsernameConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { - "smithy.api#documentation": "

Use this setting to define which verified available method a user can use to recover\n their password when they call ForgotPassword. It allows you to define a\n preferred method when a user has more than one method available. With this setting, SMS\n does not qualify for a valid password recovery mechanism if the user also has SMS MFA\n enabled. In the absence of this setting, Cognito uses the legacy behavior to determine\n the recovery method where SMS is preferred over email.

" + "smithy.api#documentation": "

You can choose to enable case sensitivity on the username input for the selected\n sign-in option. For example, when this is set to False, users will be able\n to sign in using either \"username\" or \"Username\". This configuration is immutable once\n it has been set. For more information, see UsernameConfigurationType.

" } }, - "EmailVerificationSubject": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", + "Name": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", "traits": { - "smithy.api#documentation": "

The subject of the email verification message.

" + "smithy.api#documentation": "

The name of the user pool.

" } }, - "AdminCreateUserConfig": { - "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", + "SmsVerificationMessage": { + "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { - "smithy.api#documentation": "

The configuration for AdminCreateUser requests.

" + "smithy.api#documentation": "

The contents of the SMS verification message.

" } }, - "SmsConfigurationFailure": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", + "Domain": { + "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "

The reason why the SMS configuration cannot send the messages to your users.

" + "smithy.api#documentation": "

Holds the domain prefix if the user pool has a domain associated with it.

" } }, - "Policies": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", + "EmailVerificationSubject": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "

The policies associated with the user pool.

" + "smithy.api#documentation": "

The subject of the email verification message.

" } }, "EmailConfiguration": { @@ -12416,28 +12545,22 @@ "smithy.api#documentation": "

The email configuration.

" } }, - "UsernameConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", - "traits": { - "smithy.api#documentation": "

You can choose to enable case sensitivity on the username input for the selected\n sign-in option. For example, when this is set to False, users will be able\n to sign in using either \"username\" or \"Username\". This configuration is immutable once\n it has been set. For more information, see .

" - } - }, - "CustomDomain": { - "target": "com.amazonaws.cognitoidentityprovider#DomainType", + "EstimatedNumberOfUsers": { + "target": "com.amazonaws.cognitoidentityprovider#IntegerType", "traits": { - "smithy.api#documentation": "

A custom domain name that you provide to Amazon Cognito. This parameter applies only\n if you use a custom domain to host the sign-up and sign-in pages for your application.\n For example: auth.example.com.

\n

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

" + "smithy.api#documentation": "

A number estimating the size of the user pool.

" } }, - "SchemaAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", + "AdminCreateUserConfig": { + "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", "traits": { - "smithy.api#documentation": "

A container with the schema attributes of a user pool.

" + "smithy.api#documentation": "

The configuration for AdminCreateUser requests.

" } }, - "MfaConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", + "DeviceConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", "traits": { - "smithy.api#documentation": "

Can be one of the following values:

\n " + "smithy.api#documentation": "

The device configuration.

" } }, "UserPoolTags": { @@ -12446,16 +12569,16 @@ "smithy.api#documentation": "

The tags that are assigned to the user pool. A tag is a label that you can apply to\n user pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.

" } }, - "SmsAuthenticationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", + "SmsConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { - "smithy.api#documentation": "

The contents of the SMS authentication message.

" + "smithy.api#documentation": "

The SMS configuration.

" } }, - "Arn": { - "target": "com.amazonaws.cognitoidentityprovider#ArnType", + "Policies": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user pool.

" + "smithy.api#documentation": "

The policies associated with the user pool.

" } }, "Id": { @@ -12464,16 +12587,16 @@ "smithy.api#documentation": "

The ID of the user pool.

" } }, - "DeviceConfiguration": { - "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", + "AutoVerifiedAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { - "smithy.api#documentation": "

The device configuration.

" + "smithy.api#documentation": "

Specifies the attributes that are auto-verified in a user pool.

" } }, - "EmailVerificationMessage": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", + "Arn": { + "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The contents of the email verification message.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user pool.

" } }, "UsernameAttributes": { @@ -12482,28 +12605,34 @@ "smithy.api#documentation": "

Specifies whether email addresses or phone numbers can be specified as usernames when\n a user signs up.

" } }, - "EmailConfigurationFailure": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", + "VerificationMessageTemplate": { + "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { - "smithy.api#documentation": "

The reason why the email configuration cannot send the messages to your users.

" + "smithy.api#documentation": "

The template for verification messages.

" } }, - "AutoVerifiedAttributes": { - "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", + "LambdaConfig": { + "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { - "smithy.api#documentation": "

Specifies the attributes that are auto-verified in a user pool.

" + "smithy.api#documentation": "

The AWS Lambda triggers associated with the user pool.

" } }, - "UserPoolAddOns": { - "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", + "AliasAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", "traits": { - "smithy.api#documentation": "

The user pool add-ons.

" + "smithy.api#documentation": "

Specifies the attributes that are aliased in a user pool.

" } }, - "Status": { - "target": "com.amazonaws.cognitoidentityprovider#StatusType", + "MfaConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "

The status of a user pool.

" + "smithy.api#documentation": "

Can be one of the following values:

\n " + } + }, + "SchemaAttributes": { + "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", + "traits": { + "smithy.api#documentation": "

A container with the schema attributes of a user pool.

" } } }, @@ -12549,16 +12678,16 @@ "com.amazonaws.cognitoidentityprovider#UserType": { "type": "structure", "members": { - "UserStatus": { - "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", + "Enabled": { + "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "

The user status. Can be one of the following:

\n " + "smithy.api#documentation": "

Specifies whether the user is enabled.

" } }, - "Username": { - "target": "com.amazonaws.cognitoidentityprovider#UsernameType", + "Attributes": { + "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

The user name of the user you wish to describe.

" + "smithy.api#documentation": "

A container with information about the user type attributes.

" } }, "UserCreateDate": { @@ -12567,22 +12696,16 @@ "smithy.api#documentation": "

The creation date of the user.

" } }, - "Enabled": { - "target": "com.amazonaws.cognitoidentityprovider#BooleanType", - "traits": { - "smithy.api#documentation": "

Specifies whether the user is enabled.

" - } - }, - "Attributes": { - "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", + "Username": { + "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

A container with information about the user type attributes.

" + "smithy.api#documentation": "

The user name of the user you wish to describe.

" } }, - "UserLastModifiedDate": { - "target": "com.amazonaws.cognitoidentityprovider#DateType", + "UserStatus": { + "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { - "smithy.api#documentation": "

The last modified date of the user.

" + "smithy.api#documentation": "

The user status. Can be one of the following:

\n " } }, "MFAOptions": { @@ -12590,6 +12713,12 @@ "traits": { "smithy.api#documentation": "

The MFA options for the user.

" } + }, + "UserLastModifiedDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The last modified date of the user.

" + } } }, "traits": { @@ -12668,16 +12797,10 @@ "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType": { "type": "structure", "members": { - "EmailMessage": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", - "traits": { - "smithy.api#documentation": "

The email message template.

" - } - }, - "EmailSubjectByLink": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectByLinkType", + "EmailMessageByLink": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageByLinkType", "traits": { - "smithy.api#documentation": "

The subject line for the email message template for sending a confirmation link to the\n user.

" + "smithy.api#documentation": "

The email message template for sending a confirmation link to the user.

" } }, "SmsMessage": { @@ -12686,12 +12809,6 @@ "smithy.api#documentation": "

The SMS message template.

" } }, - "EmailMessageByLink": { - "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageByLinkType", - "traits": { - "smithy.api#documentation": "

The email message template for sending a confirmation link to the user.

" - } - }, "DefaultEmailOption": { "target": "com.amazonaws.cognitoidentityprovider#DefaultEmailOptionType", "traits": { @@ -12703,6 +12820,18 @@ "traits": { "smithy.api#documentation": "

The subject line for the email message template.

" } + }, + "EmailSubjectByLink": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectByLinkType", + "traits": { + "smithy.api#documentation": "

The subject line for the email message template for sending a confirmation link to the\n user.

" + } + }, + "EmailMessage": { + "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", + "traits": { + "smithy.api#documentation": "

The email message template.

" + } } }, "traits": { @@ -12783,10 +12912,10 @@ "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenRequest": { "type": "structure", "members": { - "FriendlyDeviceName": { - "target": "com.amazonaws.cognitoidentityprovider#StringType", + "AccessToken": { + "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

The friendly device name.

" + "smithy.api#documentation": "

The access token.

" } }, "Session": { @@ -12795,17 +12924,17 @@ "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service.

" } }, - "UserCode": { - "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFAUserCodeType", + "FriendlyDeviceName": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The one time password computed using the secret code returned by

", - "smithy.api#required": {} + "smithy.api#documentation": "

The friendly device name.

" } }, - "AccessToken": { - "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", + "UserCode": { + "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFAUserCodeType", "traits": { - "smithy.api#documentation": "

The access token.

" + "smithy.api#documentation": "

The one time password computed using the secret code returned by AssociateSoftwareToken\".

", + "smithy.api#required": {} } } } @@ -12813,17 +12942,17 @@ "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenResponseType", - "traits": { - "smithy.api#documentation": "

The status of the verify software token.

" - } - }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "

The session which should be passed both ways in challenge-response calls to the\n service.

" } + }, + "Status": { + "target": "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenResponseType", + "traits": { + "smithy.api#documentation": "

The status of the verify software token.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/cognito-identity.2014-06-30.json b/codegen/sdk-codegen/aws-models/cognito-identity.2014-06-30.json index d04eb0c8189e..4c71cfa965c6 100644 --- a/codegen/sdk-codegen/aws-models/cognito-identity.2014-06-30.json +++ b/codegen/sdk-codegen/aws-models/cognito-identity.2014-06-30.json @@ -111,7 +111,7 @@ "sdkId": "Cognito Identity", "arnNamespace": "cognito-identity", "cloudFormationName": "Cognito", - "cloudTrailEventSource": "model.identity.cognito.amazonaws.com" + "cloudTrailEventSource": "cognitoidentity.amazonaws.com" }, "aws.auth#sigv4": { "name": "cognito-identity" @@ -180,18 +180,18 @@ "com.amazonaws.cognitoidentity#CognitoIdentityProvider": { "type": "structure", "members": { - "ClientId": { - "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderClientId", - "traits": { - "smithy.api#documentation": "

The client ID for the Amazon Cognito user pool.

" - } - }, "ProviderName": { "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderName", "traits": { "smithy.api#documentation": "

The provider name for an Amazon Cognito user pool. For example,\n cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

" } }, + "ClientId": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderClientId", + "traits": { + "smithy.api#documentation": "

The client ID for the Amazon Cognito user pool.

" + } + }, "ServerSideTokenCheck": { "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderTokenCheck", "traits": { @@ -284,23 +284,29 @@ "com.amazonaws.cognitoidentity#CreateIdentityPoolInput": { "type": "structure", "members": { - "IdentityPoolName": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolName", + "CognitoIdentityProviders": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderList", "traits": { - "smithy.api#documentation": "

A string that you provide.

", + "smithy.api#documentation": "

An array of Amazon Cognito user pools and their client IDs.

" + } + }, + "AllowUnauthenticatedIdentities": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolUnauthenticated", + "traits": { + "smithy.api#documentation": "

TRUE if the identity pool supports unauthenticated logins.

", "smithy.api#required": {} } }, - "DeveloperProviderName": { - "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "SupportedLoginProviders": { + "target": "com.amazonaws.cognitoidentity#IdentityProviders", "traits": { - "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users. This name acts as a\n placeholder that allows your backend and the Cognito service to communicate about the\n developer provider. For the DeveloperProviderName, you can use letters as well\n as period (.), underscore (_), and dash\n (-).

\n

Once you have set a developer provider name, you cannot change it. Please take care\n in setting this parameter.

" + "smithy.api#documentation": "

Optional key:value pairs mapping provider names to provider app IDs.

" } }, - "CognitoIdentityProviders": { - "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderList", + "IdentityPoolTags": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", "traits": { - "smithy.api#documentation": "

An array of Amazon Cognito user pools and their client IDs.

" + "smithy.api#documentation": "

Tags to assign to the identity pool. A tag is a label that you can apply to identity\n pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.

" } }, "AllowClassicFlow": { @@ -309,6 +315,13 @@ "smithy.api#documentation": "

Enables or disables the Basic (Classic) authentication flow. For more information, see\n Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

" } }, + "IdentityPoolName": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolName", + "traits": { + "smithy.api#documentation": "

A string that you provide.

", + "smithy.api#required": {} + } + }, "OpenIdConnectProviderARNs": { "target": "com.amazonaws.cognitoidentity#OIDCProviderList", "traits": { @@ -321,23 +334,10 @@ "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity\n pool.

" } }, - "IdentityPoolTags": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", - "traits": { - "smithy.api#documentation": "

Tags to assign to the identity pool. A tag is a label that you can apply to identity\n pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.

" - } - }, - "SupportedLoginProviders": { - "target": "com.amazonaws.cognitoidentity#IdentityProviders", - "traits": { - "smithy.api#documentation": "

Optional key:value pairs mapping provider names to provider app IDs.

" - } - }, - "AllowUnauthenticatedIdentities": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolUnauthenticated", + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", "traits": { - "smithy.api#documentation": "

TRUE if the identity pool supports unauthenticated logins.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users. This name acts as a\n placeholder that allows your backend and the Cognito service to communicate about the\n developer provider. For the DeveloperProviderName, you can use letters as well\n as period (.), underscore (_), and dash\n (-).

\n

Once you have set a developer provider name, you cannot change it. Please take care\n in setting this parameter.

" } } }, @@ -348,12 +348,6 @@ "com.amazonaws.cognitoidentity#Credentials": { "type": "structure", "members": { - "SecretKey": { - "target": "com.amazonaws.cognitoidentity#SecretKeyString", - "traits": { - "smithy.api#documentation": "

The Secret Access Key portion of the credentials

" - } - }, "AccessKeyId": { "target": "com.amazonaws.cognitoidentity#AccessKeyString", "traits": { @@ -371,6 +365,12 @@ "traits": { "smithy.api#documentation": "

The Session Token portion of the credentials

" } + }, + "SecretKey": { + "target": "com.amazonaws.cognitoidentity#SecretKeyString", + "traits": { + "smithy.api#documentation": "

The Secret Access Key portion of the credentials

" + } } }, "traits": { @@ -674,13 +674,6 @@ "com.amazonaws.cognitoidentity#GetCredentialsForIdentityInput": { "type": "structure", "members": { - "IdentityId": { - "target": "com.amazonaws.cognitoidentity#IdentityId", - "traits": { - "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", - "smithy.api#required": {} - } - }, "Logins": { "target": "com.amazonaws.cognitoidentity#LoginsMap", "traits": { @@ -692,6 +685,13 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were\n received in the token from the identity provider. For example, a SAML-based identity\n provider. This parameter is optional for identity providers that do not support role\n customization.

" } + }, + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", + "smithy.api#required": {} + } } }, "traits": { @@ -759,13 +759,6 @@ "com.amazonaws.cognitoidentity#GetIdInput": { "type": "structure", "members": { - "IdentityPoolId": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolId", - "traits": { - "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.cognitoidentity#AccountId", "traits": { @@ -777,6 +770,13 @@ "traits": { "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. The\n available provider names for Logins are as follows:

\n " } + }, + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } } }, "traits": { @@ -853,17 +853,17 @@ "smithy.api#documentation": "

How users for a specific identity provider are to mapped to roles. This is a\n String-to-RoleMapping object map. The string identifies the identity\n provider, for example, \"graph.facebook.com\" or\n \"cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".

" } }, - "IdentityPoolId": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolId", - "traits": { - "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" - } - }, "Roles": { "target": "com.amazonaws.cognitoidentity#RolesMap", "traits": { "smithy.api#documentation": "

The map of roles associated with this pool. Currently only authenticated and\n unauthenticated roles are supported.

" } + }, + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" + } } }, "traits": { @@ -943,23 +943,17 @@ "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentityInput": { "type": "structure", "members": { - "IdentityPoolId": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsMap", "traits": { - "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. Each\n name-value pair represents a user from a public provider or developer provider. If the user\n is from a developer provider, the name-value pair will follow the syntax\n \"developer_provider_name\": \"developer_user_identifier\". The developer\n provider is the \"domain\" by which Cognito will refer to your users; you provided this\n domain while creating/updating the identity pool. The developer user identifier is an\n identifier from your backend that uniquely identifies a user. When you create an identity\n pool, you can specify the supported logins.

", "smithy.api#required": {} } }, - "IdentityId": { - "target": "com.amazonaws.cognitoidentity#IdentityId", - "traits": { - "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" - } - }, - "Logins": { - "target": "com.amazonaws.cognitoidentity#LoginsMap", + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", "traits": { - "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. Each\n name-value pair represents a user from a public provider or developer provider. If the user\n is from a developer provider, the name-value pair will follow the syntax\n \"developer_provider_name\": \"developer_user_identifier\". The developer\n provider is the \"domain\" by which Cognito will refer to your users; you provided this\n domain while creating/updating the identity pool. The developer user identifier is an\n identifier from your backend that uniquely identifies a user. When you create an identity\n pool, you can specify the supported logins.

", + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", "smithy.api#required": {} } }, @@ -968,6 +962,12 @@ "traits": { "smithy.api#documentation": "

The expiration time of the token, in seconds. You can specify a custom expiration\n time for the token so that you can cache it. If you don't provide an expiration time, the\n token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS\n credentials, which are valid for a maximum of one hour. The maximum token duration you can\n set is 24 hours. You should take care in setting the expiration time for a token, as there\n are significant security implications: an attacker could use a leaked token to access your\n AWS resources for the token's duration.

\n \n

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

\n " } + }, + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } } }, "traits": { @@ -977,17 +977,17 @@ "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentityResponse": { "type": "structure", "members": { - "IdentityId": { - "target": "com.amazonaws.cognitoidentity#IdentityId", - "traits": { - "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" - } - }, "Token": { "target": "com.amazonaws.cognitoidentity#OIDCToken", "traits": { "smithy.api#documentation": "

An OpenID token.

" } + }, + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } } }, "traits": { @@ -997,18 +997,18 @@ "com.amazonaws.cognitoidentity#GetOpenIdTokenInput": { "type": "structure", "members": { - "Logins": { - "target": "com.amazonaws.cognitoidentity#LoginsMap", - "traits": { - "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. When\n using graph.facebook.com and www.amazon.com, supply the access_token returned from the\n provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any\n other OpenId Connect provider, always include the id_token.

" - } - }, "IdentityId": { "target": "com.amazonaws.cognitoidentity#IdentityId", "traits": { "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", "smithy.api#required": {} } + }, + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsMap", + "traits": { + "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. When\n using graph.facebook.com and www.amazon.com, supply the access_token returned from the\n provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any\n other OpenId Connect provider, always include the id_token.

" + } } }, "traits": { @@ -1047,18 +1047,6 @@ "com.amazonaws.cognitoidentity#IdentityDescription": { "type": "structure", "members": { - "LastModifiedDate": { - "target": "com.amazonaws.cognitoidentity#DateType", - "traits": { - "smithy.api#documentation": "

Date on which the identity was last modified.

" - } - }, - "CreationDate": { - "target": "com.amazonaws.cognitoidentity#DateType", - "traits": { - "smithy.api#documentation": "

Date on which the identity was created.

" - } - }, "IdentityId": { "target": "com.amazonaws.cognitoidentity#IdentityId", "traits": { @@ -1070,6 +1058,18 @@ "traits": { "smithy.api#documentation": "

The provider names.

" } + }, + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentity#DateType", + "traits": { + "smithy.api#documentation": "

Date on which the identity was last modified.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.cognitoidentity#DateType", + "traits": { + "smithy.api#documentation": "

Date on which the identity was created.

" + } } }, "traits": { @@ -1101,16 +1101,11 @@ "com.amazonaws.cognitoidentity#IdentityPool": { "type": "structure", "members": { - "AllowClassicFlow": { - "target": "com.amazonaws.cognitoidentity#ClassicFlow", - "traits": { - "smithy.api#documentation": "

Enables or disables the Basic (Classic) authentication flow. For more information, see\n Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

" - } - }, - "CognitoIdentityProviders": { - "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderList", + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", "traits": { - "smithy.api#documentation": "

A list representing an Amazon Cognito user pool and its client ID.

" + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} } }, "SamlProviderARNs": { @@ -1125,23 +1120,23 @@ "smithy.api#documentation": "

A list of OpendID Connect provider ARNs.

" } }, - "IdentityPoolTags": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", + "AllowUnauthenticatedIdentities": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolUnauthenticated", "traits": { - "smithy.api#documentation": "

The tags that are assigned to the identity pool. A tag is a label that you can apply to\n identity pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.

" + "smithy.api#documentation": "

TRUE if the identity pool supports unauthenticated logins.

", + "smithy.api#required": {} } }, - "IdentityPoolId": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "AllowClassicFlow": { + "target": "com.amazonaws.cognitoidentity#ClassicFlow", "traits": { - "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Enables or disables the Basic (Classic) authentication flow. For more information, see\n Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

" } }, - "DeveloperProviderName": { - "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "IdentityPoolTags": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", "traits": { - "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users.

" + "smithy.api#documentation": "

The tags that are assigned to the identity pool. A tag is a label that you can apply to\n identity pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.

" } }, "IdentityPoolName": { @@ -1157,11 +1152,16 @@ "smithy.api#documentation": "

Optional key:value pairs mapping provider names to provider app IDs.

" } }, - "AllowUnauthenticatedIdentities": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolUnauthenticated", + "CognitoIdentityProviders": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderList", "traits": { - "smithy.api#documentation": "

TRUE if the identity pool supports unauthenticated logins.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list representing an Amazon Cognito user pool and its client ID.

" + } + }, + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "traits": { + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users.

" } } }, @@ -1192,17 +1192,17 @@ "com.amazonaws.cognitoidentity#IdentityPoolShortDescription": { "type": "structure", "members": { - "IdentityPoolName": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolName", - "traits": { - "smithy.api#documentation": "

A string that you provide.

" - } - }, "IdentityPoolId": { "target": "com.amazonaws.cognitoidentity#IdentityPoolId", "traits": { "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" } + }, + "IdentityPoolName": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolName", + "traits": { + "smithy.api#documentation": "

A string that you provide.

" + } } }, "traits": { @@ -1371,17 +1371,10 @@ "com.amazonaws.cognitoidentity#ListIdentitiesInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentity#PaginationKey", - "traits": { - "smithy.api#documentation": "

A pagination token.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.cognitoidentity#QueryLimit", + "HideDisabled": { + "target": "com.amazonaws.cognitoidentity#HideDisabled", "traits": { - "smithy.api#documentation": "

The maximum number of identities to return.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional boolean parameter that allows you to hide disabled identities. If\n omitted, the ListIdentities API will include disabled identities in the response.

" } }, "IdentityPoolId": { @@ -1391,10 +1384,17 @@ "smithy.api#required": {} } }, - "HideDisabled": { - "target": "com.amazonaws.cognitoidentity#HideDisabled", + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", "traits": { - "smithy.api#documentation": "

An optional boolean parameter that allows you to hide disabled identities. If\n omitted, the ListIdentities API will include disabled identities in the response.

" + "smithy.api#documentation": "

A pagination token.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cognitoidentity#QueryLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of identities to return.

", + "smithy.api#required": {} } } }, @@ -1405,6 +1405,12 @@ "com.amazonaws.cognitoidentity#ListIdentitiesResponse": { "type": "structure", "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" + } + }, "Identities": { "target": "com.amazonaws.cognitoidentity#IdentitiesList", "traits": { @@ -1416,12 +1422,6 @@ "traits": { "smithy.api#documentation": "

A pagination token.

" } - }, - "IdentityPoolId": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolId", - "traits": { - "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" - } } }, "traits": { @@ -1460,18 +1460,18 @@ "com.amazonaws.cognitoidentity#ListIdentityPoolsInput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token.

" + } + }, "MaxResults": { "target": "com.amazonaws.cognitoidentity#QueryLimit", "traits": { "smithy.api#documentation": "

The maximum number of identities to return.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.cognitoidentity#PaginationKey", - "traits": { - "smithy.api#documentation": "

A pagination token.

" - } } }, "traits": { @@ -1606,10 +1606,16 @@ "com.amazonaws.cognitoidentity#LookupDeveloperIdentityInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.cognitoidentity#PaginationKey", + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", "traits": { - "smithy.api#documentation": "

A pagination token. The first call you make will have NextToken set to\n null. After that the service will return NextToken values as needed. For\n example, let's say you make a request with MaxResults set to 10, and there are\n 20 matches in the database. The service will return a pagination token as a part of the\n response. This token can be used to call the API again and get results starting from the\n 11th match.

" + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cognitoidentity#QueryLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of identities to return.

" } }, "IdentityPoolId": { @@ -1625,16 +1631,10 @@ "smithy.api#documentation": "

A unique ID used by your backend authentication process to identify a user.\n Typically, a developer identity provider would issue many developer user identifiers, in\n keeping with the number of users.

" } }, - "MaxResults": { - "target": "com.amazonaws.cognitoidentity#QueryLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of identities to return.

" - } - }, - "IdentityId": { - "target": "com.amazonaws.cognitoidentity#IdentityId", + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", "traits": { - "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + "smithy.api#documentation": "

A pagination token. The first call you make will have NextToken set to\n null. After that the service will return NextToken values as needed. For\n example, let's say you make a request with MaxResults set to 10, and there are\n 20 matches in the database. The service will return a pagination token as a part of the\n response. This token can be used to call the API again and get results starting from the\n 11th match.

" } } }, @@ -1651,17 +1651,17 @@ "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" } }, - "NextToken": { - "target": "com.amazonaws.cognitoidentity#PaginationKey", - "traits": { - "smithy.api#documentation": "

A pagination token. The first call you make will have NextToken set to\n null. After that the service will return NextToken values as needed. For\n example, let's say you make a request with MaxResults set to 10, and there are\n 20 matches in the database. The service will return a pagination token as a part of the\n response. This token can be used to call the API again and get results starting from the\n 11th match.

" - } - }, "DeveloperUserIdentifierList": { "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifierList", "traits": { "smithy.api#documentation": "

This is the list of developer user identifiers associated with an identity ID.\n Cognito supports the association of multiple developer user identifiers with an identity\n ID.

" } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token. The first call you make will have NextToken set to\n null. After that the service will return NextToken values as needed. For\n example, let's say you make a request with MaxResults set to 10, and there are\n 20 matches in the database. The service will return a pagination token as a part of the\n response. This token can be used to call the API again and get results starting from the\n 11th match.

" + } } }, "traits": { @@ -1671,13 +1671,6 @@ "com.amazonaws.cognitoidentity#MappingRule": { "type": "structure", "members": { - "Claim": { - "target": "com.amazonaws.cognitoidentity#ClaimName", - "traits": { - "smithy.api#documentation": "

The claim name that must be present in the token, for example, \"isAdmin\" or\n \"paid\".

", - "smithy.api#required": {} - } - }, "RoleARN": { "target": "com.amazonaws.cognitoidentity#ARNString", "traits": { @@ -1698,6 +1691,13 @@ "smithy.api#documentation": "

A brief string that the claim must match, for example, \"paid\" or \"yes\".

", "smithy.api#required": {} } + }, + "Claim": { + "target": "com.amazonaws.cognitoidentity#ClaimName", + "traits": { + "smithy.api#documentation": "

The claim name that must be present in the token, for example, \"isAdmin\" or\n \"paid\".

", + "smithy.api#required": {} + } } }, "traits": { @@ -1774,24 +1774,17 @@ "com.amazonaws.cognitoidentity#MergeDeveloperIdentitiesInput": { "type": "structure", "members": { - "DestinationUserIdentifier": { + "SourceUserIdentifier": { "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", "traits": { - "smithy.api#documentation": "

User identifier for the destination user. The value should be a\n DeveloperUserIdentifier.

", - "smithy.api#required": {} - } - }, - "DeveloperProviderName": { - "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", - "traits": { - "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain\n name that you provide while creating an identity pool. This name acts as a placeholder that\n allows your backend and the Cognito service to communicate about the developer provider.\n For the DeveloperProviderName, you can use letters as well as period (.),\n underscore (_), and dash (-).

", + "smithy.api#documentation": "

User identifier for the source user. The value should be a\n DeveloperUserIdentifier.

", "smithy.api#required": {} } }, - "SourceUserIdentifier": { + "DestinationUserIdentifier": { "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", "traits": { - "smithy.api#documentation": "

User identifier for the source user. The value should be a\n DeveloperUserIdentifier.

", + "smithy.api#documentation": "

User identifier for the destination user. The value should be a\n DeveloperUserIdentifier.

", "smithy.api#required": {} } }, @@ -1801,6 +1794,13 @@ "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", "smithy.api#required": {} } + }, + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "traits": { + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain\n name that you provide while creating an identity pool. This name acts as a placeholder that\n allows your backend and the Cognito service to communicate about the developer provider.\n For the DeveloperProviderName, you can use letters as well as period (.),\n underscore (_), and dash (-).

", + "smithy.api#required": {} + } } }, "traits": { @@ -1906,17 +1906,17 @@ "smithy.api#required": {} } }, - "RulesConfiguration": { - "target": "com.amazonaws.cognitoidentity#RulesConfigurationType", - "traits": { - "smithy.api#documentation": "

The rules to be used for mapping users to roles.

\n

If you specify Rules as the role mapping type, RulesConfiguration is\n required.

" - } - }, "AmbiguousRoleResolution": { "target": "com.amazonaws.cognitoidentity#AmbiguousRoleResolutionType", "traits": { "smithy.api#documentation": "

If you specify Token or Rules as the Type,\n AmbiguousRoleResolution is required.

\n

Specifies the action to be taken if either no rules match the claim value for the\n Rules type, or there is no cognito:preferred_role claim and\n there are multiple cognito:roles matches for the Token\n type.

" } + }, + "RulesConfiguration": { + "target": "com.amazonaws.cognitoidentity#RulesConfigurationType", + "traits": { + "smithy.api#documentation": "

The rules to be used for mapping users to roles.

\n

If you specify Rules as the role mapping type, RulesConfiguration is\n required.

" + } } }, "traits": { @@ -2036,6 +2036,12 @@ "com.amazonaws.cognitoidentity#SetIdentityPoolRolesInput": { "type": "structure", "members": { + "RoleMappings": { + "target": "com.amazonaws.cognitoidentity#RoleMappingMap", + "traits": { + "smithy.api#documentation": "

How users for a specific identity provider are to mapped to roles. This is a string\n to RoleMapping object map. The string identifies the identity provider,\n for example, \"graph.facebook.com\" or\n \"cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".

\n

Up to 25 rules can be specified per identity provider.

" + } + }, "Roles": { "target": "com.amazonaws.cognitoidentity#RolesMap", "traits": { @@ -2049,12 +2055,6 @@ "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", "smithy.api#required": {} } - }, - "RoleMappings": { - "target": "com.amazonaws.cognitoidentity#RoleMappingMap", - "traits": { - "smithy.api#documentation": "

How users for a specific identity provider are to mapped to roles. This is a string\n to RoleMapping object map. The string identifies the identity provider,\n for example, \"graph.facebook.com\" or\n \"cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".

\n

Up to 25 rules can be specified per identity provider.

" - } } }, "traits": { @@ -2192,31 +2192,31 @@ "com.amazonaws.cognitoidentity#UnlinkDeveloperIdentityInput": { "type": "structure", "members": { - "IdentityPoolId": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", "traits": { - "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users.

", "smithy.api#required": {} } }, - "IdentityId": { - "target": "com.amazonaws.cognitoidentity#IdentityId", + "DeveloperUserIdentifier": { + "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", + "smithy.api#documentation": "

A unique ID used by your backend authentication process to identify a user.

", "smithy.api#required": {} } }, - "DeveloperUserIdentifier": { - "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", "traits": { - "smithy.api#documentation": "

A unique ID used by your backend authentication process to identify a user.

", + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", "smithy.api#required": {} } }, - "DeveloperProviderName": { - "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", "traits": { - "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users.

", + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", "smithy.api#required": {} } } @@ -2289,17 +2289,17 @@ "com.amazonaws.cognitoidentity#UnprocessedIdentityId": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.cognitoidentity#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code indicating the type of error that occurred.

" - } - }, "IdentityId": { "target": "com.amazonaws.cognitoidentity#IdentityId", "traits": { "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" } + }, + "ErrorCode": { + "target": "com.amazonaws.cognitoidentity#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code indicating the type of error that occurred.

" + } } }, "traits": { @@ -2350,17 +2350,17 @@ "com.amazonaws.cognitoidentity#UntagResourceInput": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsListType", + "ResourceArn": { + "target": "com.amazonaws.cognitoidentity#ARNString", "traits": { - "smithy.api#documentation": "

The keys of the tags to remove from the user pool.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the identity pool that the tags are assigned\n to.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.cognitoidentity#ARNString", + "TagKeys": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsListType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the identity pool that the tags are assigned\n to.

", + "smithy.api#documentation": "

The keys of the tags to remove from the user pool.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/cognito-sync.2014-06-30.json b/codegen/sdk-codegen/aws-models/cognito-sync.2014-06-30.json index 83312a1f3fad..eaa3683dd8ce 100644 --- a/codegen/sdk-codegen/aws-models/cognito-sync.2014-06-30.json +++ b/codegen/sdk-codegen/aws-models/cognito-sync.2014-06-30.json @@ -90,7 +90,7 @@ "sdkId": "Cognito Sync", "arnNamespace": "cognito-sync", "cloudFormationName": "CognitoSync", - "cloudTrailEventSource": "model.sync.cognito.amazonaws.com" + "cloudTrailEventSource": "cognitosync.amazonaws.com" }, "aws.auth#sigv4": { "name": "cognito-sync" @@ -244,6 +244,12 @@ "com.amazonaws.cognitosync#CognitoStreams": { "type": "structure", "members": { + "StreamingStatus": { + "target": "com.amazonaws.cognitosync#StreamingStatus", + "traits": { + "smithy.api#documentation": "

Status of the Cognito streams. Valid values are:

\n " + } + }, "DisabledReason": { "target": "com.amazonaws.cognitosync#String", "traits": { @@ -256,12 +262,6 @@ "smithy.api#documentation": "

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

" } }, - "StreamingStatus": { - "target": "com.amazonaws.cognitosync#StreamingStatus", - "traits": { - "smithy.api#documentation": "

Status of the Cognito streams. Valid values are:

\n " - } - }, "RoleArn": { "target": "com.amazonaws.cognitosync#AssumeRoleArn", "traits": { @@ -293,12 +293,6 @@ "com.amazonaws.cognitosync#Dataset": { "type": "structure", "members": { - "NumRecords": { - "target": "com.amazonaws.cognitosync#Long", - "traits": { - "smithy.api#documentation": "

Number of records in this dataset.

" - } - }, "IdentityId": { "target": "com.amazonaws.cognitosync#IdentityId", "traits": { @@ -311,16 +305,16 @@ "smithy.api#documentation": "

The device that made the last change to this dataset.

" } }, - "LastModifiedDate": { - "target": "com.amazonaws.cognitosync#Date", + "DatasetName": { + "target": "com.amazonaws.cognitosync#DatasetName", "traits": { - "smithy.api#documentation": "

Date when the dataset was last modified.

" + "smithy.api#documentation": "

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

" } }, - "CreationDate": { + "LastModifiedDate": { "target": "com.amazonaws.cognitosync#Date", "traits": { - "smithy.api#documentation": "

Date on which the dataset was created.

" + "smithy.api#documentation": "

Date when the dataset was last modified.

" } }, "DataStorage": { @@ -329,10 +323,16 @@ "smithy.api#documentation": "

Total size in bytes of the records in this dataset.

" } }, - "DatasetName": { - "target": "com.amazonaws.cognitosync#DatasetName", + "CreationDate": { + "target": "com.amazonaws.cognitosync#Date", "traits": { - "smithy.api#documentation": "

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

" + "smithy.api#documentation": "

Date on which the dataset was created.

" + } + }, + "NumRecords": { + "target": "com.amazonaws.cognitosync#Long", + "traits": { + "smithy.api#documentation": "

Number of records in this dataset.

" } } }, @@ -623,16 +623,16 @@ "com.amazonaws.cognitosync#DescribeIdentityUsageRequest": { "type": "structure", "members": { - "IdentityPoolId": { - "target": "com.amazonaws.cognitosync#IdentityPoolId", + "IdentityId": { + "target": "com.amazonaws.cognitosync#IdentityId", "traits": { "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)\n created by Amazon Cognito. GUID generation is unique within a region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "IdentityId": { - "target": "com.amazonaws.cognitosync#IdentityId", + "IdentityPoolId": { + "target": "com.amazonaws.cognitosync#IdentityPoolId", "traits": { "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)\n created by Amazon Cognito. GUID generation is unique within a region.

", "smithy.api#httpLabel": {}, @@ -758,10 +758,10 @@ "smithy.api#documentation": "

Status of the last bulk publish operation, valid values are:

\n " } }, - "IdentityPoolId": { - "target": "com.amazonaws.cognitosync#IdentityPoolId", + "BulkPublishStartTime": { + "target": "com.amazonaws.cognitosync#Date", "traits": { - "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

" + "smithy.api#documentation": "

The date/time at which the last bulk publish was initiated.

" } }, "FailureMessage": { @@ -770,16 +770,16 @@ "smithy.api#documentation": "

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

" } }, - "BulkPublishCompleteTime": { - "target": "com.amazonaws.cognitosync#Date", + "IdentityPoolId": { + "target": "com.amazonaws.cognitosync#IdentityPoolId", "traits": { - "smithy.api#documentation": "

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

" + "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

" } }, - "BulkPublishStartTime": { + "BulkPublishCompleteTime": { "target": "com.amazonaws.cognitosync#Date", "traits": { - "smithy.api#documentation": "

The date/time at which the last bulk publish was initiated.

" + "smithy.api#documentation": "

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

" } } }, @@ -904,18 +904,18 @@ "com.amazonaws.cognitosync#GetIdentityPoolConfigurationResponse": { "type": "structure", "members": { - "IdentityPoolId": { - "target": "com.amazonaws.cognitosync#IdentityPoolId", - "traits": { - "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

" - } - }, "CognitoStreams": { "target": "com.amazonaws.cognitosync#CognitoStreams", "traits": { "smithy.api#documentation": "

Options to apply to this identity pool for Amazon Cognito streams.

" } }, + "IdentityPoolId": { + "target": "com.amazonaws.cognitosync#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

" + } + }, "PushSync": { "target": "com.amazonaws.cognitosync#PushSync", "traits": { @@ -994,22 +994,16 @@ "smithy.api#documentation": "

Number of datasets for the identity.

" } }, - "LastModifiedDate": { - "target": "com.amazonaws.cognitosync#Date", - "traits": { - "smithy.api#documentation": "

Date on which the identity was last modified.

" - } - }, "IdentityId": { "target": "com.amazonaws.cognitosync#IdentityId", "traits": { "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)\n created by Amazon Cognito. GUID generation is unique within a region.

" } }, - "IdentityPoolId": { - "target": "com.amazonaws.cognitosync#IdentityPoolId", + "LastModifiedDate": { + "target": "com.amazonaws.cognitosync#Date", "traits": { - "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)\n created by Amazon Cognito. GUID generation is unique within a region.

" + "smithy.api#documentation": "

Date on which the identity was last modified.

" } }, "DataStorage": { @@ -1017,6 +1011,12 @@ "traits": { "smithy.api#documentation": "

Total data storage for this identity.

" } + }, + "IdentityPoolId": { + "target": "com.amazonaws.cognitosync#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)\n created by Amazon Cognito. GUID generation is unique within a region.

" + } } }, "traits": { @@ -1301,28 +1301,28 @@ "com.amazonaws.cognitosync#ListIdentityPoolUsageResponse": { "type": "structure", "members": { - "IdentityPoolUsages": { - "target": "com.amazonaws.cognitosync#IdentityPoolUsageList", + "Count": { + "target": "com.amazonaws.cognitosync#Integer", "traits": { - "smithy.api#documentation": "

Usage information for the identity pools.

" + "smithy.api#documentation": "

Total number of identities for the identity pool.

" } }, - "Count": { + "MaxResults": { "target": "com.amazonaws.cognitosync#Integer", "traits": { - "smithy.api#documentation": "

Total number of identities for the identity pool.

" + "smithy.api#documentation": "

The maximum number of results to be returned.

" } }, - "NextToken": { - "target": "com.amazonaws.cognitosync#String", + "IdentityPoolUsages": { + "target": "com.amazonaws.cognitosync#IdentityPoolUsageList", "traits": { - "smithy.api#documentation": "

A pagination token for obtaining the next page of results.

" + "smithy.api#documentation": "

Usage information for the identity pools.

" } }, - "MaxResults": { - "target": "com.amazonaws.cognitosync#Integer", + "NextToken": { + "target": "com.amazonaws.cognitosync#String", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned.

" + "smithy.api#documentation": "

A pagination token for obtaining the next page of results.

" } } }, @@ -1364,27 +1364,27 @@ "com.amazonaws.cognitosync#ListRecordsRequest": { "type": "structure", "members": { - "IdentityPoolId": { - "target": "com.amazonaws.cognitosync#IdentityPoolId", + "IdentityId": { + "target": "com.amazonaws.cognitosync#IdentityId", "traits": { "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "IdentityId": { - "target": "com.amazonaws.cognitosync#IdentityId", + "IdentityPoolId": { + "target": "com.amazonaws.cognitosync#IdentityPoolId", "traits": { "smithy.api#documentation": "

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.cognitosync#IntegerString", + "LastSyncCount": { + "target": "com.amazonaws.cognitosync#Long", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The last server sync count for this record.

", + "smithy.api#httpQuery": "lastSyncCount" } }, "NextToken": { @@ -1394,11 +1394,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "LastSyncCount": { - "target": "com.amazonaws.cognitosync#Long", + "MaxResults": { + "target": "com.amazonaws.cognitosync#IntegerString", "traits": { - "smithy.api#documentation": "

The last server sync count for this record.

", - "smithy.api#httpQuery": "lastSyncCount" + "smithy.api#documentation": "

The maximum number of results to be returned.

", + "smithy.api#httpQuery": "maxResults" } }, "DatasetName": { @@ -1430,12 +1430,6 @@ "smithy.api#documentation": "

Total number of records.

" } }, - "DatasetSyncCount": { - "target": "com.amazonaws.cognitosync#Long", - "traits": { - "smithy.api#documentation": "

Server sync count for this dataset.

" - } - }, "MergedDatasetNames": { "target": "com.amazonaws.cognitosync#MergedDatasetNameList", "traits": { @@ -1454,6 +1448,12 @@ "smithy.api#documentation": "

The user/device that made the last change to this record.

" } }, + "DatasetSyncCount": { + "target": "com.amazonaws.cognitosync#Long", + "traits": { + "smithy.api#documentation": "

Server sync count for this dataset.

" + } + }, "DatasetDeletedAfterRequestedSyncCount": { "target": "com.amazonaws.cognitosync#Boolean", "traits": { @@ -1466,17 +1466,17 @@ "smithy.api#documentation": "

A list of all records.

" } }, - "NextToken": { - "target": "com.amazonaws.cognitosync#String", - "traits": { - "smithy.api#documentation": "

A pagination token for obtaining the next page of results.

" - } - }, "DatasetExists": { "target": "com.amazonaws.cognitosync#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the dataset exists.

" } + }, + "NextToken": { + "target": "com.amazonaws.cognitosync#String", + "traits": { + "smithy.api#documentation": "

A pagination token for obtaining the next page of results.

" + } } }, "traits": { @@ -1586,28 +1586,22 @@ "smithy.api#documentation": "

The last modified date of the client device.

" } }, - "SyncCount": { - "target": "com.amazonaws.cognitosync#Long", - "traits": { - "smithy.api#documentation": "

The server sync count for this record.

" - } - }, "LastModifiedDate": { "target": "com.amazonaws.cognitosync#Date", "traits": { "smithy.api#documentation": "

The date on which the record was last modified.

" } }, - "Value": { - "target": "com.amazonaws.cognitosync#RecordValue", + "SyncCount": { + "target": "com.amazonaws.cognitosync#Long", "traits": { - "smithy.api#documentation": "

The value for the record.

" + "smithy.api#documentation": "

The server sync count for this record.

" } }, - "Key": { - "target": "com.amazonaws.cognitosync#RecordKey", + "Value": { + "target": "com.amazonaws.cognitosync#RecordValue", "traits": { - "smithy.api#documentation": "

The key for the record.

" + "smithy.api#documentation": "

The value for the record.

" } }, "LastModifiedBy": { @@ -1615,6 +1609,12 @@ "traits": { "smithy.api#documentation": "

The user/device that made the last change to this record.

" } + }, + "Key": { + "target": "com.amazonaws.cognitosync#RecordKey", + "traits": { + "smithy.api#documentation": "

The key for the record.

" + } } }, "traits": { @@ -1639,10 +1639,10 @@ "com.amazonaws.cognitosync#RecordPatch": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.cognitosync#RecordKey", + "Op": { + "target": "com.amazonaws.cognitosync#Operation", "traits": { - "smithy.api#documentation": "

The key associated with the record patch.

", + "smithy.api#documentation": "

An operation, either replace or remove.

", "smithy.api#required": {} } }, @@ -1652,13 +1652,6 @@ "smithy.api#documentation": "

The last modified date of the client device.

" } }, - "Op": { - "target": "com.amazonaws.cognitosync#Operation", - "traits": { - "smithy.api#documentation": "

An operation, either replace or remove.

", - "smithy.api#required": {} - } - }, "SyncCount": { "target": "com.amazonaws.cognitosync#Long", "traits": { @@ -1671,6 +1664,13 @@ "traits": { "smithy.api#documentation": "

The value associated with the record patch.

" } + }, + "Key": { + "target": "com.amazonaws.cognitosync#RecordKey", + "traits": { + "smithy.api#documentation": "

The key associated with the record patch.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1937,18 +1937,18 @@ "com.amazonaws.cognitosync#SetIdentityPoolConfigurationResponse": { "type": "structure", "members": { - "CognitoStreams": { - "target": "com.amazonaws.cognitosync#CognitoStreams", - "traits": { - "smithy.api#documentation": "

Options to apply to this identity pool for Amazon Cognito streams.

" - } - }, "PushSync": { "target": "com.amazonaws.cognitosync#PushSync", "traits": { "smithy.api#documentation": "

Options to apply to this identity pool for push synchronization.

" } }, + "CognitoStreams": { + "target": "com.amazonaws.cognitosync#CognitoStreams", + "traits": { + "smithy.api#documentation": "

Options to apply to this identity pool for Amazon Cognito streams.

" + } + }, "IdentityPoolId": { "target": "com.amazonaws.cognitosync#IdentityPoolId", "traits": { @@ -2225,12 +2225,6 @@ "com.amazonaws.cognitosync#UpdateRecordsRequest": { "type": "structure", "members": { - "RecordPatches": { - "target": "com.amazonaws.cognitosync#RecordPatchList", - "traits": { - "smithy.api#documentation": "

A list of patch operations.

" - } - }, "IdentityPoolId": { "target": "com.amazonaws.cognitosync#IdentityPoolId", "traits": { @@ -2239,6 +2233,12 @@ "smithy.api#required": {} } }, + "RecordPatches": { + "target": "com.amazonaws.cognitosync#RecordPatchList", + "traits": { + "smithy.api#documentation": "

A list of patch operations.

" + } + }, "DatasetName": { "target": "com.amazonaws.cognitosync#DatasetName", "traits": { @@ -2247,6 +2247,13 @@ "smithy.api#required": {} } }, + "SyncSessionToken": { + "target": "com.amazonaws.cognitosync#SyncSessionToken", + "traits": { + "smithy.api#documentation": "

The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

", + "smithy.api#required": {} + } + }, "ClientContext": { "target": "com.amazonaws.cognitosync#ClientContext", "traits": { @@ -2260,13 +2267,6 @@ "smithy.api#documentation": "

The unique ID generated for this device by Cognito.

" } }, - "SyncSessionToken": { - "target": "com.amazonaws.cognitosync#SyncSessionToken", - "traits": { - "smithy.api#documentation": "

The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

", - "smithy.api#required": {} - } - }, "IdentityId": { "target": "com.amazonaws.cognitosync#IdentityId", "traits": { diff --git a/codegen/sdk-codegen/aws-models/comprehend.2017-11-27.json b/codegen/sdk-codegen/aws-models/comprehend.2017-11-27.json index 82e985bf8649..6aee8fcee12f 100644 --- a/codegen/sdk-codegen/aws-models/comprehend.2017-11-27.json +++ b/codegen/sdk-codegen/aws-models/comprehend.2017-11-27.json @@ -32,6 +32,44 @@ "com.amazonaws.comprehend#AnyLengthString": { "type": "string" }, + "com.amazonaws.comprehend#AttributeNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AttributeNamesListItem" + } + }, + "com.amazonaws.comprehend#AttributeNamesListItem": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + } + }, + "com.amazonaws.comprehend#AugmentedManifestsListItem": { + "type": "structure", + "members": { + "AttributeNames": { + "target": "com.amazonaws.comprehend#AttributeNamesList", + "traits": { + "smithy.api#documentation": "

The JSON attribute that contains the annotations for your training documents. The number\n of attribute names that you specify depends on whether your augmented manifest file is the\n output of a single labeling job or a chained labeling job.

\n

If your file is the output of a single labeling job, specify the LabelAttributeName key\n that was used when the job was created in Ground Truth.

\n

If your file is the output of a chained labeling job, specify the LabelAttributeName key\n for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from\n an individual job.

", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of the augmented manifest file.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An augmented manifest file that provides training data for your custom model. An augmented\n manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

" + } + }, "com.amazonaws.comprehend#BatchDetectDominantLanguage": { "type": "operation", "input": { @@ -55,7 +93,7 @@ } ], "traits": { - "smithy.api#documentation": "

Determines the dominant language of the input text for a batch of documents. For a list\n of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

" + "smithy.api#documentation": "

Determines the dominant language of the input text for a batch of documents. For a list\n of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.\n

" } }, "com.amazonaws.comprehend#BatchDetectDominantLanguageItemResult": { @@ -144,17 +182,17 @@ "com.amazonaws.comprehend#BatchDetectEntitiesItemResult": { "type": "structure", "members": { - "Entities": { - "target": "com.amazonaws.comprehend#ListOfEntities", - "traits": { - "smithy.api#documentation": "

One or more Entity objects, one for each entity detected in the\n document.

" - } - }, "Index": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "

The zero-based index of the document in the input list.

" } + }, + "Entities": { + "target": "com.amazonaws.comprehend#ListOfEntities", + "traits": { + "smithy.api#documentation": "

One or more Entity objects, one for each entity detected in the\n document.

" + } } }, "traits": { @@ -167,7 +205,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages supported by Amazon \n Comprehend.\n All documents must be in the same language.

", + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", "smithy.api#required": {} } }, @@ -183,17 +221,17 @@ "com.amazonaws.comprehend#BatchDetectEntitiesResponse": { "type": "structure", "members": { - "ErrorList": { - "target": "com.amazonaws.comprehend#BatchItemErrorList", + "ResultList": { + "target": "com.amazonaws.comprehend#ListOfDetectEntitiesResult", "traits": { - "smithy.api#documentation": "

A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.

", + "smithy.api#documentation": "

A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.

", "smithy.api#required": {} } }, - "ResultList": { - "target": "com.amazonaws.comprehend#ListOfDetectEntitiesResult", + "ErrorList": { + "target": "com.amazonaws.comprehend#BatchItemErrorList", "traits": { - "smithy.api#documentation": "

A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.

", + "smithy.api#documentation": "

A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.

", "smithy.api#required": {} } } @@ -234,17 +272,17 @@ "com.amazonaws.comprehend#BatchDetectKeyPhrasesItemResult": { "type": "structure", "members": { - "KeyPhrases": { - "target": "com.amazonaws.comprehend#ListOfKeyPhrases", - "traits": { - "smithy.api#documentation": "

One or more KeyPhrase objects, one for each key phrase detected in\n the document.

" - } - }, "Index": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "

The zero-based index of the document in the input list.

" } + }, + "KeyPhrases": { + "target": "com.amazonaws.comprehend#ListOfKeyPhrases", + "traits": { + "smithy.api#documentation": "

One or more KeyPhrase objects, one for each key phrase detected in\n the document.

" + } } }, "traits": { @@ -254,17 +292,17 @@ "com.amazonaws.comprehend#BatchDetectKeyPhrasesRequest": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "TextList": { + "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages supported by Amazon \n Comprehend.\n All documents must be in the same language.

", + "smithy.api#documentation": "

A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.

", "smithy.api#required": {} } }, - "TextList": { - "target": "com.amazonaws.comprehend#CustomerInputStringList", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.

", + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", "smithy.api#required": {} } } @@ -330,17 +368,17 @@ "smithy.api#documentation": "

The sentiment detected in the document.

" } }, - "Index": { - "target": "com.amazonaws.comprehend#Integer", - "traits": { - "smithy.api#documentation": "

The zero-based index of the document in the input list.

" - } - }, "SentimentScore": { "target": "com.amazonaws.comprehend#SentimentScore", "traits": { "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its sentiment\n detection.

" } + }, + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } } }, "traits": { @@ -360,7 +398,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages supported by Amazon \n Comprehend.\n All documents must be in the same language.

", + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", "smithy.api#required": {} } } @@ -420,17 +458,17 @@ "com.amazonaws.comprehend#BatchDetectSyntaxItemResult": { "type": "structure", "members": { - "Index": { - "target": "com.amazonaws.comprehend#Integer", - "traits": { - "smithy.api#documentation": "

The zero-based index of the document in the input list.

" - } - }, "SyntaxTokens": { "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", "traits": { "smithy.api#documentation": "

The syntax tokens for the words in the document, one token for each word.

" } + }, + "Index": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + } } }, "traits": { @@ -450,7 +488,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#SyntaxLanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the following languages supported by Amazon \n Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All\n documents must be in the same language.

", + "smithy.api#documentation": "

The language of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

", "smithy.api#required": {} } } @@ -481,10 +519,10 @@ "com.amazonaws.comprehend#BatchItemError": { "type": "structure", "members": { - "Index": { - "target": "com.amazonaws.comprehend#Integer", + "ErrorCode": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "

The zero-based index of the document in the input list.

" + "smithy.api#documentation": "

The numeric error code of the error.

" } }, "ErrorMessage": { @@ -493,10 +531,10 @@ "smithy.api#documentation": "

A text description of the error.

" } }, - "ErrorCode": { - "target": "com.amazonaws.comprehend#String", + "Index": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The numeric error code of the error.

" + "smithy.api#documentation": "

The zero-based index of the document in the input list.

" } } }, @@ -526,57 +564,57 @@ "com.amazonaws.comprehend#ClassifierEvaluationMetrics": { "type": "structure", "members": { - "Accuracy": { + "MicroPrecision": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

The fraction of the labels that were correct recognized. It is computed by dividing\n the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

" + "smithy.api#documentation": "

A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n Unlike the Precision metric which comes from averaging the precision of all available labels,\n this is based on the overall score of all precision scores added together.

" } }, - "HammingLoss": { + "Accuracy": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the \n total number of labels. Scores closer to zero are better.

" + "smithy.api#documentation": "

The fraction of the labels that were correct recognized. It is computed by dividing the\n number of labels in the test documents that were correctly recognized by the total number of\n labels in the test documents.

" } }, - "MicroRecall": { + "MicroF1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned \n most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model \n can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores \n of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.

" + "smithy.api#documentation": "

A measure of how accurate the classifier results are for the test data. It is a\n combination of the Micro Precision and Micro Recall values. The\n Micro F1Score is the harmonic mean of the two scores. The highest score is 1,\n and the worst score is 0.

" } }, - "MicroF1Score": { + "MicroRecall": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision \n and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, \n and the worst score is 0.

" + "smithy.api#documentation": "

A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results. Specifically, this indicates how\n many of the correct categories in the text that the model can predict. It is a percentage of\n correct categories in the text that can found. Instead of averaging the recall scores of all\n labels (as with Recall), micro Recall is based on the overall score of all recall scores added\n together.

" } }, - "F1Score": { + "Precision": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how accurate the classifier results are for the test data. It is \n derived from the Precision and Recall values. The F1Score is \n the harmonic average of the two scores. The highest score is 1, and the worst score is 0.\n

" + "smithy.api#documentation": "

A measure of the usefulness of the classifier results in the test data. High precision\n means that the classifier returned substantially more relevant results than irrelevant\n ones.

" } }, - "Recall": { + "HammingLoss": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how complete the classifier results are for the test data. High recall means \n that the classifier returned most of the relevant results.

" + "smithy.api#documentation": "

Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction\n of wrong labels compared to the total number of labels. Scores closer to zero are\n better.

" } }, - "Precision": { + "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of the usefulness of the classifier results in the test data. High precision \n means that the classifier returned substantially more relevant results than irrelevant ones.

" + "smithy.api#documentation": "

A measure of how accurate the classifier results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. The highest score is 1, and the worst score is 0.

" } }, - "MicroPrecision": { + "Recall": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned \n substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision \n of all available labels, this is based on the overall score of all precision scores added together.

" + "smithy.api#documentation": "

A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the result metrics for the test data associated with an documentation classifier.

" + "smithy.api#documentation": "

Describes the result metrics for the test data associated with an documentation\n classifier.

" } }, "com.amazonaws.comprehend#ClassifierMetadata": { @@ -594,16 +632,16 @@ "smithy.api#documentation": "

The number of documents in the input data that were used to train the classifier.\n Typically this is 80 to 90 percent of the input documents.

" } }, - "NumberOfTestDocuments": { - "target": "com.amazonaws.comprehend#Integer", + "EvaluationMetrics": { + "target": "com.amazonaws.comprehend#ClassifierEvaluationMetrics", "traits": { - "smithy.api#documentation": "

The number of documents in the input data that were used to test the classifier. Typically\n this is 10 to 20 percent of the input documents, up to 10,000 documents.

" + "smithy.api#documentation": "

Describes the result metrics for the test data associated with an documentation\n classifier.

" } }, - "EvaluationMetrics": { - "target": "com.amazonaws.comprehend#ClassifierEvaluationMetrics", + "NumberOfTestDocuments": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

Describes the result metrics for the test data associated with an documentation classifier.

" + "smithy.api#documentation": "

The number of documents in the input data that were used to test the classifier. Typically\n this is 10 to 20 percent of the input documents, up to 10,000 documents.

" } } }, @@ -635,7 +673,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.

" + "smithy.api#documentation": "

Creates a new document classification request to analyze a single document in real-time,\n using a previously created and trained custom model and an endpoint.

" } }, "com.amazonaws.comprehend#ClassifyDocumentRequest": { @@ -660,16 +698,16 @@ "com.amazonaws.comprehend#ClassifyDocumentResponse": { "type": "structure", "members": { - "Classes": { - "target": "com.amazonaws.comprehend#ListOfClasses", + "Labels": { + "target": "com.amazonaws.comprehend#ListOfLabels", "traits": { - "smithy.api#documentation": "

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected \n to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

" + "smithy.api#documentation": "

The labels used the document being analyzed. These are used for multi-label trained\n models. Individual labels represent different categories that are related in some manner and\n are not multually exclusive. For example, a movie can be just an action movie, or it can be an\n action movie, a science fiction movie, and a comedy, all at the same time.

" } }, - "Labels": { - "target": "com.amazonaws.comprehend#ListOfLabels", + "Classes": { + "target": "com.amazonaws.comprehend#ListOfClasses", "traits": { - "smithy.api#documentation": "

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner \n and are not multually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and \n a comedy, all at the same time.

" + "smithy.api#documentation": "

The classes used by the document being analyzed. These are used for multi-class trained\n models. Individual classes are mutually exclusive and each document is expected to have only a\n single class assigned to it. For example, an animal can be a dog or a cat, but not both at the\n same time.

" } } }, @@ -798,6 +836,9 @@ { "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob" }, + { + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob" + }, { "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJob" }, @@ -813,6 +854,9 @@ { "target": "com.amazonaws.comprehend#DetectKeyPhrases" }, + { + "target": "com.amazonaws.comprehend#DetectPiiEntities" + }, { "target": "com.amazonaws.comprehend#DetectSentiment" }, @@ -840,6 +884,9 @@ { "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobs" }, + { + "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobs" + }, { "target": "com.amazonaws.comprehend#ListSentimentDetectionJobs" }, @@ -861,6 +908,9 @@ { "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJob" }, + { + "target": "com.amazonaws.comprehend#StartPiiEntitiesDetectionJob" + }, { "target": "com.amazonaws.comprehend#StartSentimentDetectionJob" }, @@ -876,6 +926,9 @@ { "target": "com.amazonaws.comprehend#StopKeyPhrasesDetectionJob" }, + { + "target": "com.amazonaws.comprehend#StopPiiEntitiesDetectionJob" + }, { "target": "com.amazonaws.comprehend#StopSentimentDetectionJob" }, @@ -906,7 +959,7 @@ "name": "comprehend" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these\n actions to determine the topics contained in your documents, the topics they discuss, the\n predominant sentiment expressed in them, the predominant language used, and more.

", + "smithy.api#documentation": "

Amazon Comprehend is an AWS service for gaining insight into the content of documents.\n Use these actions to determine the topics contained in your documents, the topics they\n discuss, the predominant sentiment expressed in them, the predominant language used, and\n more.

", "smithy.api#title": "Amazon Comprehend" } }, @@ -918,7 +971,7 @@ } }, "traits": { - "smithy.api#documentation": "

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

", + "smithy.api#documentation": "

Concurrent modification of the tags associated with an Amazon Comprehend resource is not\n supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -964,43 +1017,49 @@ "com.amazonaws.comprehend#CreateDocumentClassifierRequest": { "type": "structure", "members": { - "DocumentClassifierName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

The name of the document classifier.

", + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "

Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource \n used by Amazon Comprehend. For example, \n a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + "smithy.api#documentation": "

Tags to be associated with the document classifier being created. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

Indicates the mode in which the classifier will be trained. The classifier can be trained\n in multi-class mode, which identifies one and only one class for each document, or multi-label\n mode, which identifies one or more labels for each document. In multi-label mode, multiple\n labels for an individual document are separated by a delimiter. The default delimiter between\n labels is a pipe (|).

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend\n generates one.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom classifier. For more information, see Amazon\n VPC.

" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the following languages supported by Amazon \n Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All\n documents must be in the same language.

", - "smithy.api#required": {} + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "Mode": { - "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "DocumentClassifierName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", "traits": { - "smithy.api#documentation": "

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which \n identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each \n document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default \n delimiter between labels is a pipe (|).

" + "smithy.api#documentation": "

The name of the document classifier.

", + "smithy.api#required": {} } }, "InputDataConfig": { @@ -1010,10 +1069,10 @@ "smithy.api#required": {} } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Enables the addition of output results configuration parameters for custom classifier\n jobs.

" } }, "DataAccessRoleArn": { @@ -1022,12 +1081,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.

", "smithy.api#required": {} } - }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", - "traits": { - "smithy.api#documentation": "

Enables the addition of output results configuration parameters for custom classifier jobs.

" - } } } }, @@ -1077,44 +1130,44 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a model-specific endpoint for synchronous inference for a previously trained custom model

" + "smithy.api#documentation": "

Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model\n

" } }, "com.amazonaws.comprehend#CreateEndpointRequest": { "type": "structure", "members": { - "EndpointName": { - "target": "com.amazonaws.comprehend#ComprehendEndpointName", - "traits": { - "smithy.api#documentation": "

This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

", - "smithy.api#required": {} - } - }, "DesiredInferenceUnits": { "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { - "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint. Each \n inference unit represents of a throughput of 100 characters per second.

", + "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.

", "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "EndpointName": { + "target": "com.amazonaws.comprehend#ComprehendEndpointName", "traits": { - "smithy.api#documentation": "

An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend \n will not return a ResourceInUseException.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

This is the descriptive suffix that becomes part of the EndpointArn used for\n all subsequent requests to this resource.

", + "smithy.api#required": {} } }, "ModelArn": { "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.

", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model to which the endpoint will be\n attached.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "

Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata \n to the endpoint. For example, a tag with \"Sales\" as the key might be added to an endpoint \n to indicate its use by the sales department.

" + "smithy.api#documentation": "

Tags associated with the endpoint being created. A tag is a key-value pair that adds\n metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an\n endpoint to indicate its use by the sales department.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

An idempotency token provided by the customer. If this token matches a previous endpoint\n creation request, Amazon Comprehend will not return a ResourceInUseException.\n

", + "smithy.api#idempotencyToken": {} } } } @@ -1165,63 +1218,63 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is \n submitted, you can check job status using the API.

" + "smithy.api#documentation": "

Creates an entity recognizer using submitted files. After your\n CreateEntityRecognizer request is submitted, you can check job status using the\n API.

" } }, "com.amazonaws.comprehend#CreateEntityRecognizerRequest": { "type": "structure", "members": { - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "Tags": { + "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

Tags to be associated with the entity recognizer being created. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" } }, - "RecognizerName": { - "target": "com.amazonaws.comprehend#ComprehendArnName", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. \n Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

", + "smithy.api#documentation": "

You can specify any of the following languages supported by Amazon Comprehend: English\n (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\").\n All documents must be in the same language.

", "smithy.api#required": {} } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

Specifies the format and location of the input data. The S3 bucket containing the input data must\n be located in the same region as the entity recognizer being created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} } }, - "Tags": { - "target": "com.amazonaws.comprehend#TagList", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a \n resource used by Amazon Comprehend. For example, \n a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend\n generates one.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

Specifies the format and location of the input data. The S3 bucket containing the input\n data must be located in the same region as the entity recognizer being created.

", + "smithy.api#required": {} } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language. Only English (\"en\") is currently supported.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom entity recognizer. For more information, see\n Amazon\n VPC.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.

", "smithy.api#required": {} } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "RecognizerName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

The name given to the newly created recognizer. Recognizer names can be a maximum of 256\n characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name\n must be unique in the account/region.

", + "smithy.api#required": {} } } } @@ -1284,7 +1337,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a previously created document classifier

\n

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be\n deleted. If an active inference job is using the model, a ResourceInUseException will be\n returned.

\n

This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by\n a background job. Once removed, the classifier disappears from your account and is no longer available for use.

" + "smithy.api#documentation": "

Deletes a previously created document classifier

\n

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.

\n

This is an asynchronous action that puts the classifier into a DELETING state, and it is\n then removed by a background job. Once removed, the classifier disappears from your account\n and is no longer available for use.

" } }, "com.amazonaws.comprehend#DeleteDocumentClassifierRequest": { @@ -1329,7 +1382,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted.

" + "smithy.api#documentation": "

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints\n must be deleted in order for the model to be deleted.

" } }, "com.amazonaws.comprehend#DeleteEndpointRequest": { @@ -1377,7 +1430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an entity recognizer.

\n

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be\n deleted. If an active inference job is using the model, a ResourceInUseException will be\n returned.

\n

This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by\n a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

" + "smithy.api#documentation": "

Deletes an entity recognizer.

\n

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.

\n

This is an asynchronous action that puts the recognizer into a DELETING state, and it is\n then removed by a background job. Once removed, the recognizer disappears from your account\n and is no longer available for use.

" } }, "com.amazonaws.comprehend#DeleteEntityRecognizerRequest": { @@ -1566,7 +1619,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.

" + "smithy.api#documentation": "

Gets the properties associated with a specific endpoint. Use this operation to get the\n status of an endpoint.

" } }, "com.amazonaws.comprehend#DescribeEndpointRequest": { @@ -1664,7 +1717,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides details about an entity recognizer including status, S3 buckets containing \n training data, recognizer metadata, metrics, and so on.

" + "smithy.api#documentation": "

Provides details about an entity recognizer including status, S3 buckets containing\n training data, recognizer metadata, metrics, and so on.

" } }, "com.amazonaws.comprehend#DescribeEntityRecognizerRequest": { @@ -1739,13 +1792,13 @@ } } }, - "com.amazonaws.comprehend#DescribeSentimentDetectionJob": { + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob": { "type": "operation", "input": { - "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest" + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest" }, "output": { - "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse" + "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse" }, "errors": [ { @@ -1762,10 +1815,10 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the properties associated with a sentiment detection job. Use this operation to get\n the status of a detection job.

" + "smithy.api#documentation": "

Gets the properties associated with a PII entities detection job. For example, you can use\n this operation to get the job status.

" } }, - "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest": { + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest": { "type": "structure", "members": { "JobId": { @@ -1777,12 +1830,58 @@ } } }, - "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse": { + "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse": { "type": "structure", "members": { - "SentimentDetectionJobProperties": { - "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties", - "traits": { + "PiiEntitiesDetectionJobProperties": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" + } + } + }, + "com.amazonaws.comprehend#DescribeSentimentDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the properties associated with a sentiment detection job. Use this operation to get\n the status of a detection job.

" + } + }, + "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse": { + "type": "structure", + "members": { + "SentimentDetectionJobProperties": { + "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties", + "traits": { "smithy.api#documentation": "

An object that contains the properties associated with a sentiment detection job.

" } } @@ -1857,7 +1956,7 @@ } ], "traits": { - "smithy.api#documentation": "

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend\n can detect, see Amazon Comprehend Supported Languages.

" + "smithy.api#documentation": "

Determines the dominant language of the input text. For a list of languages that Amazon\n Comprehend can detect, see Amazon Comprehend Supported Languages.

" } }, "com.amazonaws.comprehend#DetectDominantLanguageRequest": { @@ -1878,7 +1977,7 @@ "Languages": { "target": "com.amazonaws.comprehend#ListOfDominantLanguages", "traits": { - "smithy.api#documentation": "

The languages that Amazon Comprehend detected in the input text. For each language, the response\n returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy\n of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the\n IETF Tools web site.

" + "smithy.api#documentation": "

The languages that Amazon Comprehend detected in the input text. For each language, the\n response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend\n has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the\n IETF Tools web site.

" } } }, @@ -1918,6 +2017,13 @@ "com.amazonaws.comprehend#DetectEntitiesRequest": { "type": "structure", "members": { + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.

", + "smithy.api#required": {} + } + }, "EndpointArn": { "target": "com.amazonaws.comprehend#EntityRecognizerEndpointArn", "traits": { @@ -1929,13 +2035,6 @@ "traits": { "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

\n

If your request includes the endpoint for a custom entity recognition model, Amazon\n Comprehend uses the language of your custom model, and it ignores any language code that you\n specify here.

" } - }, - "Text": { - "target": "com.amazonaws.comprehend#CustomerInputString", - "traits": { - "smithy.api#documentation": "

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.

", - "smithy.api#required": {} - } } } }, @@ -1982,17 +2081,17 @@ "com.amazonaws.comprehend#DetectKeyPhrasesRequest": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehend#CustomerInputString", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.

", + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", "smithy.api#required": {} } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "Text": { + "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages supported by Amazon \n Comprehend.\n All documents must be in the same language.

", + "smithy.api#documentation": "

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.

", "smithy.api#required": {} } } @@ -2004,7 +2103,7 @@ "KeyPhrases": { "target": "com.amazonaws.comprehend#ListOfKeyPhrases", "traits": { - "smithy.api#documentation": "

A collection of key phrases that Amazon Comprehend identified in the input text. For each key\n phrase, the response provides the text of the key phrase, where the key phrase begins and\n ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + "smithy.api#documentation": "

A collection of key phrases that Amazon Comprehend identified in the input text. For\n each key phrase, the response provides the text of the key phrase, where the key phrase begins\n and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" } } }, @@ -2012,6 +2111,62 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.comprehend#DetectPiiEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DetectPiiEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DetectPiiEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#UnsupportedLanguageException" + } + ], + "traits": { + "smithy.api#documentation": "

Inspects the input text for entities that contain personally identifiable information\n (PII) and returns information about them.

" + } + }, + "com.amazonaws.comprehend#DetectPiiEntitiesRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#DetectPiiEntitiesResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.comprehend#ListOfPiiEntities", + "traits": { + "smithy.api#documentation": "

A collection of PII entities identified in the input text. For each entity, the response\n provides the entity type, where the entity text begins and ends, and the level of confidence\n that Amazon Comprehend has in the detection.

" + } + } + } + }, "com.amazonaws.comprehend#DetectSentiment": { "type": "operation", "input": { @@ -2051,7 +2206,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages supported by Amazon \n Comprehend.\n All documents must be in the same language.

", + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", "smithy.api#required": {} } } @@ -2060,16 +2215,16 @@ "com.amazonaws.comprehend#DetectSentimentResponse": { "type": "structure", "members": { - "SentimentScore": { - "target": "com.amazonaws.comprehend#SentimentScore", + "Sentiment": { + "target": "com.amazonaws.comprehend#SentimentType", "traits": { - "smithy.api#documentation": "

An object that lists the sentiments, and their corresponding confidence\n levels.

" + "smithy.api#documentation": "

The inferred sentiment that Amazon Comprehend has the highest level of confidence\n in.

" } }, - "Sentiment": { - "target": "com.amazonaws.comprehend#SentimentType", + "SentimentScore": { + "target": "com.amazonaws.comprehend#SentimentScore", "traits": { - "smithy.api#documentation": "

The inferred sentiment that Amazon Comprehend has the highest level of confidence in.

" + "smithy.api#documentation": "

An object that lists the sentiments, and their corresponding confidence\n levels.

" } } }, @@ -2116,7 +2271,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#SyntaxLanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the input documents. You can specify any of the following languages supported by Amazon \n Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\").

", + "smithy.api#documentation": "

The language code of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\").

", "smithy.api#required": {} } } @@ -2139,17 +2294,17 @@ "com.amazonaws.comprehend#DocumentClass": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "

The name of the class.

" - } - }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "

The confidence score that Amazon Comprehend has this class correctly attributed.

" } + }, + "Name": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The name of the class.

" + } } }, "traits": { @@ -2165,18 +2320,18 @@ "smithy.api#documentation": "

Filters on the name of the job.

" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", - "traits": { - "smithy.api#documentation": "

Filters the list based on job status. Returns only jobs with the specified status.

" - } - }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" } }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list based on job status. Returns only jobs with the specified status.

" + } + }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { @@ -2191,28 +2346,28 @@ "com.amazonaws.comprehend#DocumentClassificationJobProperties": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

A description of the status of the job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.

" } }, - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

The time that the document classification job was submitted for processing.

" + "smithy.api#documentation": "

The current status of the document classification job. If the status is\n FAILED, the Message field shows the reason for the failure.

" } }, - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

" + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your document classification job. For more information, see Amazon\n VPC.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

The input data configuration that you supplied when you created the document\n classification job.

" } }, "JobId": { @@ -2221,46 +2376,46 @@ "smithy.api#documentation": "

The identifier assigned to the document classification job.

" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

The current status of the document classification job. If the status is\n FAILED, the Message field shows the reason for the failure.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The input data configuration that you supplied when you created the document\n classification job.

" + "smithy.api#documentation": "

The time that the document classification job was submitted for processing.

" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "

The time that the document classification job completed.

" + "smithy.api#documentation": "

A description of the status of the job.

" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.

" + "smithy.api#documentation": "

The name that you assigned to the document classification job.

" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The output data configuration that you supplied when you created the document\n classification job.

" + "smithy.api#documentation": "

The time that the document classification job completed.

" } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The name that you assigned to the document classification job.

" + "smithy.api#documentation": "

The output data configuration that you supplied when you created the document\n classification job.

" } } }, @@ -2284,6 +2439,27 @@ "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, + "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#DocumentClassifierDataFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPREHEND_CSV", + "name": "COMPREHEND_CSV" + }, + { + "value": "AUGMENTED_MANIFEST", + "name": "AUGMENTED_MANIFEST" + } + ] + } + }, "com.amazonaws.comprehend#DocumentClassifierEndpointArn": { "type": "string", "traits": { @@ -2297,48 +2473,59 @@ "com.amazonaws.comprehend#DocumentClassifierFilter": { "type": "structure", "members": { - "SubmitTimeAfter": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "

Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted after the specified time. Classifiers are returned in\n descending order, newest to oldest.

" - } - }, "Status": { "target": "com.amazonaws.comprehend#ModelStatus", "traits": { - "smithy.api#documentation": "

Filters the list of classifiers based on status.

" + "smithy.api#documentation": "

Filters the list of classifiers based on status.

" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted before the specified time. Classifiers are returned in\n ascending order, oldest to newest.

" + "smithy.api#documentation": "

Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted before the specified time. Classifiers are\n returned in ascending order, oldest to newest.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted after the specified time. Classifiers are\n returned in descending order, newest to oldest.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information for filtering a list of document classifiers. You can \n only specify\n one filtering parameter in a request. For more information, see the operation.

" + "smithy.api#documentation": "

Provides information for filtering a list of document classifiers. You can only specify\n one filtering parameter in a request. For more information, see the operation.

" } }, "com.amazonaws.comprehend#DocumentClassifierInputDataConfig": { "type": "structure", "members": { - "S3Uri": { - "target": "com.amazonaws.comprehend#S3Uri", + "LabelDelimiter": { + "target": "com.amazonaws.comprehend#LabelDelimiter", "traits": { - "smithy.api#documentation": "

The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.

\n

For example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates the delimiter used to separate each label for training a multi-label classifier.\n The default delimiter between labels is a pipe (|). You can use a different character as a\n delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\n training documents use a delimiter other than the default or the delimiter you specify, the\n labels on that line will be combined to make a single unique label, such as\n LABELLABELLABEL.

" } }, - "LabelDelimiter": { - "target": "com.amazonaws.comprehend#LabelDelimiter", + "DataFormat": { + "target": "com.amazonaws.comprehend#DocumentClassifierDataFormat", + "traits": { + "smithy.api#documentation": "

The format of your training data:

\n \n

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.

" + } + }, + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList", "traits": { - "smithy.api#documentation": "

Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter \n between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by \n specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the \n delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

" + "smithy.api#documentation": "

A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.

\n

This parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.

\n

For example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.

\n

This parameter is required if you set DataFormat to\n COMPREHEND_CSV.

" } } }, "traits": { - "smithy.api#documentation": "

The input properties for training a document classifier.

\n

For more information on how the input file is formatted, see \n how-document-classification-training-data.

" + "smithy.api#documentation": "

The input properties for training a document classifier.

\n

For more information on how the input file is formatted, see how-document-classification-training-data.

" } }, "com.amazonaws.comprehend#DocumentClassifierMode": { @@ -2362,13 +2549,13 @@ "KmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an \n analysis job. The KmsKeyId can be one of the following formats:

\n " + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. The KmsKeyId can be one of the following formats:

\n " } }, "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

When you use the OutputDataConfig object while creating a custom classifier, you\n specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the\n same region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of this output file.

\n

When the custom classifier job is finished, the service creates the output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n confusion matrix.

" + "smithy.api#documentation": "

When you use the OutputDataConfig object while creating a custom\n classifier, you specify the Amazon S3 location where you want to write the confusion matrix.\n The URI must be in the same region as the API endpoint that you are calling. The location is\n used as the prefix for the actual location of this output file.

\n

When the custom classifier job is finished, the service creates the output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n confusion matrix.

" } } }, @@ -2379,94 +2566,94 @@ "com.amazonaws.comprehend#DocumentClassifierProperties": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.comprehend#ModelStatus", - "traits": { - "smithy.api#documentation": "

The status of the document classifier. If the status is TRAINED the\n classifier is ready to use. If the status is FAILED you can see additional\n information about why the classifier wasn't trained in the Message field.

" + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Provides output results configuration parameters for custom classifier jobs.

" } }, - "SubmitTime": { + "TrainingStartTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the document classifier was submitted for training.

" + "smithy.api#documentation": "

Indicates the time when the training starts on documentation classifiers. You are billed\n for the time interval between this time and the value of TrainingEndTime.

" } }, - "Mode": { - "target": "com.amazonaws.comprehend#DocumentClassifierMode", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and \n the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.

" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", "traits": { - "smithy.api#documentation": "

The input data configuration that you supplied when you created the document classifier\n for training.

" + "smithy.api#documentation": "

The status of the document classifier. If the status is TRAINED the\n classifier is ready to use. If the status is FAILED you can see additional\n information about why the classifier wasn't trained in the Message field.

" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "ClassifierMetadata": { + "target": "com.amazonaws.comprehend#ClassifierMetadata", "traits": { - "smithy.api#documentation": "

The time that training the document classifier completed.

" + "smithy.api#documentation": "

Information about the document classifier, including the number of documents used for\n training the classifier, the number of documents used for test the classifier, and an accuracy\n rating.

" } }, - "TrainingEndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { - "smithy.api#documentation": "

The time that training of the document classifier was completed.\n Indicates the time when the training completes on documentation classifiers. You are billed for \n the time interval between this time and the value of TrainingStartTime.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

Provides output results configuration parameters for custom classifier jobs.

" + "smithy.api#documentation": "

The time that the document classifier was submitted for training.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "Mode": { + "target": "com.amazonaws.comprehend#DocumentClassifierMode", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

Indicates the mode in which the specific classifier was trained. This also indicates the\n format of input documents and the format of the confusion matrix. Each classifier can only be\n trained in one mode and this cannot be changed once the classifier is trained.

" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "

The language code for the language of the documents that the classifier was trained\n on.

" + "smithy.api#documentation": "

Additional information about the status of the classifier.

" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "TrainingEndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.

" + "smithy.api#documentation": "

The time that training of the document classifier was completed. Indicates the time when\n the training completes on documentation classifiers. You are billed for the time interval\n between this time and the value of TrainingStartTime.

" } }, - "TrainingStartTime": { + "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time when the training starts on documentation classifiers. You are billed for \n the time interval between this time and the value of TrainingEndTime.

" + "smithy.api#documentation": "

The time that training the document classifier completed.

" } }, - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier.

" + "smithy.api#documentation": "

The input data configuration that you supplied when you created the document classifier\n for training.

" } }, - "ClassifierMetadata": { - "target": "com.amazonaws.comprehend#ClassifierMetadata", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

Information about the document classifier, including the number of documents used for\n training the classifier, the number of documents used for test the classifier, and an accuracy\n rating.

" + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom classifier. For more information, see Amazon\n VPC.

" } }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

Additional information about the status of the classifier.

" + "smithy.api#documentation": "

The language code for the language of the documents that the classifier was trained\n on.

" } } }, @@ -2506,7 +2693,7 @@ "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" } }, "LanguageCode": { @@ -2523,18 +2710,18 @@ "com.amazonaws.comprehend#DominantLanguageDetectionJobFilter": { "type": "structure", "members": { - "SubmitTimeAfter": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" - } - }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" } }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -2555,16 +2742,10 @@ "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties": { "type": "structure", "members": { - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", - "traits": { - "smithy.api#documentation": "

The current status of the dominant language detection job. If the status is\n FAILED, the Message field shows the reason for the failure.

" - } - }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + "smithy.api#documentation": "

The input data configuration that you supplied when you created the dominant language\n detection job.

" } }, "SubmitTime": { @@ -2573,28 +2754,34 @@ "smithy.api#documentation": "

The time that the dominant language detection job was submitted for processing.

" } }, - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier assigned to the dominant language detection job.

" + "smithy.api#documentation": "

The time that the dominant language detection job completed.

" } }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

A description for the status of a job.

" + "smithy.api#documentation": "

The name that you assigned to the dominant language detection job.

" } }, "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your dominant language detection job. For more information, see\n Amazon\n VPC.

" } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "

The name that you assigned to the dominant language detection job.

" + "smithy.api#documentation": "

The identifier assigned to the dominant language detection job.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description for the status of a job.

" } }, "OutputDataConfig": { @@ -2603,22 +2790,22 @@ "smithy.api#documentation": "

The output data configuration that you supplied when you created the dominant language\n detection job.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

The current status of the dominant language detection job. If the status is\n FAILED, the Message field shows the reason for the failure.

" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

The time that the dominant language detection job completed.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.

" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

The input data configuration that you supplied when you created the dominant language\n detection job.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } } }, @@ -2641,10 +2828,10 @@ "com.amazonaws.comprehend#EndpointFilter": { "type": "structure", "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.comprehend#Timestamp", + "Status": { + "target": "com.amazonaws.comprehend#EndpointStatus", "traits": { - "smithy.api#documentation": "

Specifies a date after which the returned endpoint or endpoints were created.

" + "smithy.api#documentation": "

Specifies the status of the endpoint being returned. Possible values are: Creating, Ready,\n Updating, Deleting, Failed.

" } }, "CreationTimeBefore": { @@ -2653,10 +2840,10 @@ "smithy.api#documentation": "

Specifies a date before which the returned endpoint or endpoints were created.

" } }, - "Status": { - "target": "com.amazonaws.comprehend#EndpointStatus", + "CreationTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.

" + "smithy.api#documentation": "

Specifies a date after which the returned endpoint or endpoints were created.

" } }, "ModelArn": { @@ -2667,22 +2854,16 @@ } }, "traits": { - "smithy.api#documentation": "

The filter used to determine which endpoints are are returned. You can filter jobs on their name, model, status, or the date and time that they were created. \n You can only set one filter at a time.

" + "smithy.api#documentation": "

The filter used to determine which endpoints are are returned. You can filter jobs on\n their name, model, status, or the date and time that they were created. You can only set one\n filter at a time.

" } }, "com.amazonaws.comprehend#EndpointProperties": { "type": "structure", "members": { - "DesiredInferenceUnits": { + "CurrentInferenceUnits": { "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { - "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint. Each \n inference unit represents of a throughput of 100 characters per second.

" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the endpoint was last modified.

" + "smithy.api#documentation": "

The number of inference units currently used by the model using this endpoint.

" } }, "Message": { @@ -2691,10 +2872,10 @@ "smithy.api#documentation": "

Specifies a reason for failure in cases of Failed status.

" } }, - "CurrentInferenceUnits": { - "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + "Status": { + "target": "com.amazonaws.comprehend#EndpointStatus", "traits": { - "smithy.api#documentation": "

The number of inference units currently used by the model using this endpoint.

" + "smithy.api#documentation": "

Specifies the status of the endpoint. Because the endpoint updates and creation are\n asynchronous, so customers will need to wait for the endpoint to be Ready status\n before making inference requests.

" } }, "ModelArn": { @@ -2703,16 +2884,16 @@ "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

" } }, - "Status": { - "target": "com.amazonaws.comprehend#EndpointStatus", + "DesiredInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { - "smithy.api#documentation": "

Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so \n customers will need to wait for the endpoint to be Ready status before making inference requests.

" + "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.

" } }, - "EndpointArn": { - "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint.

" + "smithy.api#documentation": "

The date and time that the endpoint was last modified.

" } }, "CreationTime": { @@ -2720,6 +2901,12 @@ "traits": { "smithy.api#documentation": "

The creation date and time of the endpoint.

" } + }, + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint.

" + } } }, "traits": { @@ -2762,6 +2949,12 @@ "com.amazonaws.comprehend#EntitiesDetectionJobFilter": { "type": "structure", "members": { + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -2774,12 +2967,6 @@ "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", - "traits": { - "smithy.api#documentation": "

Filters on the name of the job.

" - } - }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { @@ -2794,10 +2981,10 @@ "com.amazonaws.comprehend#EntitiesDetectionJobProperties": { "type": "structure", "members": { - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

The current status of the entities detection job. If the status is FAILED,\n the Message field shows the reason for the failure.

" + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your entity detection job. For more information, see Amazon\n VPC.

" } }, "LanguageCode": { @@ -2806,40 +2993,34 @@ "smithy.api#documentation": "

The language code of the input documents.

" } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", - "traits": { - "smithy.api#documentation": "

The name that you assigned the entities detection job.

" - } - }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "

The output data configuration that you supplied when you created the entities detection\n job.

" + "smithy.api#documentation": "

The identifier assigned to the entities detection job.

" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

The input data configuration that you supplied when you created the entities detection\n job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.

" } }, - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { - "smithy.api#documentation": "

The time that the entities detection job was submitted for processing.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The time that the entities detection job completed

" + "smithy.api#documentation": "

The output data configuration that you supplied when you created the entities detection\n job.

" } }, "Message": { @@ -2848,28 +3029,34 @@ "smithy.api#documentation": "

A description of the status of a job.

" } }, - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

The identifier assigned to the entities detection job.

" + "smithy.api#documentation": "

The name that you assigned the entities detection job.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

The current status of the entities detection job. If the status is FAILED,\n the Message field shows the reason for the failure.

" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + "smithy.api#documentation": "

The time that the entities detection job was submitted for processing.

" } }, - "EntityRecognizerArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + "smithy.api#documentation": "

The time that the entities detection job completed

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input data configuration that you supplied when you created the entities detection\n job.

" } } }, @@ -2886,16 +3073,16 @@ "com.amazonaws.comprehend#Entity": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehend#String", + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The text of the entity.

" + "smithy.api#documentation": "

A character offset in the input text that shows where the entity ends. The offset\n returns the position of each UTF-8 code point in the string. A code point\n is the abstract character from a particular graphical representation. For example, a\n multi-byte UTF-8 character maps to a single code point.

" } }, - "Score": { - "target": "com.amazonaws.comprehend#Float", + "Text": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + "smithy.api#documentation": "

The text of the entity.

" } }, "Type": { @@ -2904,16 +3091,16 @@ "smithy.api#documentation": "

The entity's type.

" } }, - "BeginOffset": { - "target": "com.amazonaws.comprehend#Integer", + "Score": { + "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

A character offset in the input text that shows where the entity begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" } }, - "EndOffset": { + "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

A character offset in the input text that shows where the entity ends. The offset\n returns the position of each UTF-8 code point in the string. A code point\n is the abstract character from a particular graphical representation. For example, a\n multi-byte UTF-8 character maps to a single code point.

" + "smithy.api#documentation": "

A character offset in the input text that shows where the entity begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.

" } } }, @@ -2927,7 +3114,7 @@ "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the \n same region as the API endpoint that you are calling.

", + "smithy.api#documentation": "

Specifies the Amazon S3 location where the annotations for an entity recognizer are\n located. The URI must be in the same region as the API endpoint that you are calling.

", "smithy.api#required": {} } } @@ -2946,13 +3133,34 @@ "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, + "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" + } + }, + "com.amazonaws.comprehend#EntityRecognizerDataFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPREHEND_CSV", + "name": "COMPREHEND_CSV" + }, + { + "value": "AUGMENTED_MANIFEST", + "name": "AUGMENTED_MANIFEST" + } + ] + } + }, "com.amazonaws.comprehend#EntityRecognizerDocuments": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The \n URI must be in the same region as the API endpoint that you are calling.

", + "smithy.api#documentation": "

Specifies the Amazon S3 location where the training documents for an entity recognizer\n are located. The URI must be in the same region as the API endpoint that you are\n calling.

", "smithy.api#required": {} } } @@ -2977,7 +3185,7 @@ "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.

", + "smithy.api#documentation": "

Specifies the Amazon S3 location where the entity list is located. The URI must be in the\n same region as the API endpoint that you are calling.

", "smithy.api#required": {} } } @@ -2989,32 +3197,38 @@ "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics": { "type": "structure", "members": { - "F1Score": { + "Recall": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how accurate the recognizer results are for the test data. It is \n derived from the Precision and Recall values. The F1Score is \n the harmonic average of the two scores. The highest score is 1, and the worst score is 0.\n

" + "smithy.api#documentation": "

A measure of how complete the recognizer results are for the test data. High recall means\n that the recognizer returned most of the relevant results.

" } }, - "Recall": { + "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

" + "smithy.api#documentation": "

A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. The highest score is 1, and the worst score is 0.

" } }, "Precision": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of the usefulness of the recognizer results in the test data. High precision \n means that the recognizer returned substantially more relevant results than irrelevant ones.\n

" + "smithy.api#documentation": "

A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n

" } } }, "traits": { - "smithy.api#documentation": "

Detailed information about the accuracy of an entity recognizer.\n

" + "smithy.api#documentation": "

Detailed information about the accuracy of an entity recognizer.

" } }, "com.amazonaws.comprehend#EntityRecognizerFilter": { "type": "structure", "members": { + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + }, "Status": { "target": "com.amazonaws.comprehend#ModelStatus", "traits": { @@ -3024,47 +3238,52 @@ "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.

" - } - }, - "SubmitTimeBefore": { - "target": "com.amazonaws.comprehend#Timestamp", - "traits": { - "smithy.api#documentation": "

Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.

" + "smithy.api#documentation": "

Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information for filtering a list of entity recognizers. You can only specify\n one filtering parameter in a request. For more information, see the operation./>

" + "smithy.api#documentation": "

Provides information for filtering a list of entity recognizers. You can only specify one\n filtering parameter in a request. For more information, see the operation./>

" } }, "com.amazonaws.comprehend#EntityRecognizerInputDataConfig": { "type": "structure", "members": { + "Annotations": { + "target": "com.amazonaws.comprehend#EntityRecognizerAnnotations", + "traits": { + "smithy.api#documentation": "

The S3 location of the CSV file that annotates your training documents.

" + } + }, "EntityTypes": { "target": "com.amazonaws.comprehend#EntityTypesList", "traits": { - "smithy.api#documentation": "

The entity types in the input data for an entity recognizer. A maximum of 12 entity types can be used at one time to train an entity recognizer.

", + "smithy.api#documentation": "

The entity types in the labeled training data that Amazon Comprehend uses to train the\n custom entity recognizer. Any entity types that you don't specify are ignored.

\n

A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity\n types must not contain the following invalid characters: \\n (line break), \\\\n (escaped line\n break), \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),\n space, and , (comma).

", "smithy.api#required": {} } }, + "AugmentedManifests": { + "target": "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList", + "traits": { + "smithy.api#documentation": "

A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.

\n

This parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.

" + } + }, "EntityList": { "target": "com.amazonaws.comprehend#EntityRecognizerEntityList", "traits": { - "smithy.api#documentation": "

S3 location of the entity list for an entity recognizer.

" + "smithy.api#documentation": "

The S3 location of the CSV file that has the entity list for your custom entity\n recognizer.

" } }, - "Annotations": { - "target": "com.amazonaws.comprehend#EntityRecognizerAnnotations", + "DataFormat": { + "target": "com.amazonaws.comprehend#EntityRecognizerDataFormat", "traits": { - "smithy.api#documentation": "

S3 location of the annotations file for an entity recognizer.

" + "smithy.api#documentation": "

The format of your training data:

\n \n

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.

" } }, "Documents": { "target": "com.amazonaws.comprehend#EntityRecognizerDocuments", "traits": { - "smithy.api#documentation": "

S3 location of the documents folder for an entity recognizer

", - "smithy.api#required": {} + "smithy.api#documentation": "

The S3 location of the folder that contains the training documents for your custom entity\n recognizer.

\n

This parameter is required if you set DataFormat to\n COMPREHEND_CSV.

" } } }, @@ -3090,13 +3309,13 @@ "NumberOfTestDocuments": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

" + "smithy.api#documentation": "

The number of documents in the input data that were used to test the entity recognizer.\n Typically this is 10 to 20 percent of the input documents.

" } }, "NumberOfTrainedDocuments": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

" + "smithy.api#documentation": "

The number of documents in the input data that were used to train the entity recognizer.\n Typically this is 80 to 90 percent of the input documents.

" } } }, @@ -3114,66 +3333,66 @@ "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem": { "type": "structure", "members": { + "NumberOfTrainMentions": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the number of times the given entity type was seen in the training data.

" + } + }, "EvaluationMetrics": { "target": "com.amazonaws.comprehend#EntityTypesEvaluationMetrics", "traits": { - "smithy.api#documentation": "

Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

" + "smithy.api#documentation": "

Detailed information about the accuracy of the entity recognizer for a specific item on\n the list of entity types.

" } }, "Type": { "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "

Type of entity from the list of entity types in the metadata of an entity recognizer.

" - } - }, - "NumberOfTrainMentions": { - "target": "com.amazonaws.comprehend#Integer", - "traits": { - "smithy.api#documentation": "

Indicates the number of times the given entity type was seen in the training data.

" + "smithy.api#documentation": "

Type of entity from the list of entity types in the metadata of an entity recognizer.\n

" } } }, "traits": { - "smithy.api#documentation": "

Individual item from the list of entity types in the metadata of an entity recognizer.

" + "smithy.api#documentation": "

Individual item from the list of entity types in the metadata of an entity\n recognizer.

" } }, "com.amazonaws.comprehend#EntityRecognizerProperties": { "type": "structure", "members": { - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

The time that the recognizer was submitted for processing.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "

The time that the recognizer creation completed.

" + "smithy.api#documentation": "

A description of the status of the recognizer.

" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", + "RecognizerMetadata": { + "target": "com.amazonaws.comprehend#EntityRecognizerMetadata", "traits": { - "smithy.api#documentation": "

The input data properties of an entity recognizer.

" + "smithy.api#documentation": "

Provides information about an entity recognizer.

" } }, - "TrainingStartTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

The time that training of the entity recognizer started.

" + "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language. Only\n English (\"en\") is currently supported.

" } }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

A description of the status of the recognizer.

" + "smithy.api#documentation": "

The time that the recognizer creation completed.

" } }, "TrainingEndTime": { @@ -3182,40 +3401,40 @@ "smithy.api#documentation": "

The time that training of the entity recognizer was completed.

" } }, - "Status": { - "target": "com.amazonaws.comprehend#ModelStatus", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", "traits": { - "smithy.api#documentation": "

Provides the status of the entity recognizer.

" + "smithy.api#documentation": "

The input data properties of an entity recognizer.

" } }, - "EntityRecognizerArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom entity recognizer. For more information, see Amazon\n VPC.

" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

" + "smithy.api#documentation": "

The time that the recognizer was submitted for processing.

" } }, - "RecognizerMetadata": { - "target": "com.amazonaws.comprehend#EntityRecognizerMetadata", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

Provides information about an entity recognizer.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "TrainingStartTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

The time that training of the entity recognizer started.

" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "Status": { + "target": "com.amazonaws.comprehend#ModelStatus", "traits": { - "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language. Only \n English (\"en\") is currently supported.

" + "smithy.api#documentation": "

Provides the status of the entity recognizer.

" } } }, @@ -3279,33 +3498,33 @@ "min": 0, "max": 64 }, - "smithy.api#pattern": "[_A-Z0-9]+" + "smithy.api#pattern": "^(?:(?!\\\\n+|\\\\t+|\\\\r+|[\\r\\t\\n\\s,]).)+$" } }, "com.amazonaws.comprehend#EntityTypesEvaluationMetrics": { "type": "structure", "members": { - "Precision": { + "Recall": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision \n means that the recognizer returned substantially more relevant results than irrelevant ones.\n

" + "smithy.api#documentation": "

A measure of how complete the recognizer results are for a specific entity type in the\n test data. High recall means that the recognizer returned most of the relevant results.

" } }, - "Recall": { + "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer \n returned most of the relevant results.

" + "smithy.api#documentation": "

A measure of how accurate the recognizer results are for for a specific entity type in the\n test data. It is derived from the Precision and Recall values. The\n F1Score is the harmonic average of the two scores. The highest score is 1, and\n the worst score is 0.

" } }, - "F1Score": { + "Precision": { "target": "com.amazonaws.comprehend#Double", "traits": { - "smithy.api#documentation": "

A measure of how accurate the recognizer results are for for a specific entity type in the test data. It is \n derived from the Precision and Recall values. The F1Score is \n the harmonic average of the two scores. The highest score is 1, and the worst score is 0.\n

" + "smithy.api#documentation": "

A measure of the usefulness of the recognizer results for a specific entity type in the\n test data. High precision means that the recognizer returned substantially more relevant\n results than irrelevant ones.

" } } }, "traits": { - "smithy.api#documentation": "

Detailed information about the accuracy of an entity recognizer for a specific entity type.

" + "smithy.api#documentation": "

Detailed information about the accuracy of an entity recognizer for a specific entity\n type.

" } }, "com.amazonaws.comprehend#EntityTypesList": { @@ -3320,13 +3539,13 @@ "Type": { "target": "com.amazonaws.comprehend#EntityTypeName", "traits": { - "smithy.api#documentation": "

Entity type of an item on an entity type list.

", + "smithy.api#documentation": "

An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.

\n

Entity types must not contain the following invalid characters: \\n (line break), \\\\n\n (escaped line break, \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t\n (escaped tab), space, and , (comma).

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Information about an individual item on a list of entity types.

" + "smithy.api#documentation": "

An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.

" } }, "com.amazonaws.comprehend#Float": { @@ -3357,18 +3576,18 @@ "com.amazonaws.comprehend#InputDataConfig": { "type": "structure", "members": { - "InputFormat": { - "target": "com.amazonaws.comprehend#InputFormat", - "traits": { - "smithy.api#documentation": "

Specifies how the text in an input file should be processed:

\n " - } - }, "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 URI for the input data. The URI must be in same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of data files.

\n

For example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix,\n Amazon Comprehend uses all of them as input.

", + "smithy.api#documentation": "

The Amazon S3 URI for the input data. The URI must be in same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of data files.

\n

For example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.

", "smithy.api#required": {} } + }, + "InputFormat": { + "target": "com.amazonaws.comprehend#InputFormat", + "traits": { + "smithy.api#documentation": "

Specifies how the text in an input file should be processed:

\n " + } } }, "traits": { @@ -3417,7 +3636,7 @@ } }, "traits": { - "smithy.api#documentation": "

The filter specified for the operation is invalid.\n Specify a different filter.

", + "smithy.api#documentation": "

The filter specified for the operation is invalid. Specify a different\n filter.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3430,7 +3649,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request\n is invalid.

", + "smithy.api#documentation": "

The request is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3502,12 +3721,6 @@ "com.amazonaws.comprehend#KeyPhrase": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "

The text of a key noun phrase.

" - } - }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { @@ -3520,10 +3733,16 @@ "smithy.api#documentation": "

A character offset in the input text that shows where the key phrase begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.

" } }, + "Text": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

The text of a key noun phrase.

" + } + }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" } } }, @@ -3534,6 +3753,12 @@ "com.amazonaws.comprehend#KeyPhrasesDetectionJobFilter": { "type": "structure", "members": { + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { @@ -3546,12 +3771,6 @@ "smithy.api#documentation": "

Filters on the name of the job.

" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", - "traits": { - "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" - } - }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { @@ -3566,16 +3785,22 @@ "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The language code of the input documents.

" + "smithy.api#documentation": "

The time that the key phrases detection job completed.

" } }, - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier assigned to the key phrases detection job.

" + "smithy.api#documentation": "

The time that the key phrases detection job was submitted for processing.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, "JobStatus": { @@ -3584,10 +3809,10 @@ "smithy.api#documentation": "

The current status of the key phrases detection job. If the status is FAILED,\n the Message field shows the reason for the failure.

" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

The time that the key phrases detection job completed.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.

" } }, "InputDataConfig": { @@ -3596,22 +3821,22 @@ "smithy.api#documentation": "

The input data configuration that you supplied when you created the key phrases detection\n job.

" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "

The output data configuration that you supplied when you created the key phrases detection\n job.

" + "smithy.api#documentation": "

A description of the status of a job.

" } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + "smithy.api#documentation": "

The identifier assigned to the key phrases detection job.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

The output data configuration that you supplied when you created the key phrases detection\n job.

" } }, "JobName": { @@ -3620,22 +3845,16 @@ "smithy.api#documentation": "

The name that you assigned the key phrases detection job.

" } }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", - "traits": { - "smithy.api#documentation": "

A description of the status of a job.

" - } - }, - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

The time that the key phrases detection job was submitted for processing.

" + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your key phrases detection job. For more information, see Amazon\n VPC.

" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

The language code of the input documents.

" } } }, @@ -3666,7 +3885,7 @@ } }, "traits": { - "smithy.api#documentation": "

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

", + "smithy.api#documentation": "

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and\n re-enter it.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3776,17 +3995,17 @@ "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their names, status, or the\n date and time that they were submitted. You can only set one filter at a time.

" } }, - "MaxResults": { - "target": "com.amazonaws.comprehend#MaxResultsInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" - } - }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "

Identifies the next page of results to return.

" } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } } } }, @@ -3847,34 +4066,34 @@ "smithy.api#documentation": "

Identifies the next page of results to return.

" } }, - "MaxResults": { - "target": "com.amazonaws.comprehend#MaxResultsInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" - } - }, "Filter": { "target": "com.amazonaws.comprehend#DocumentClassifierFilter", "traits": { "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } } } }, "com.amazonaws.comprehend#ListDocumentClassifiersResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "

Identifies the next page of results to return.

" - } - }, "DocumentClassifierPropertiesList": { "target": "com.amazonaws.comprehend#DocumentClassifierPropertiesList", "traits": { "smithy.api#documentation": "

A list containing the properties of each job returned.

" } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } } } }, @@ -3975,22 +4194,22 @@ "com.amazonaws.comprehend#ListEndpointsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "

Identifies the next page of results to return.

" - } - }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" } }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, "Filter": { "target": "com.amazonaws.comprehend#EndpointFilter", "traits": { - "smithy.api#documentation": "

Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. \n You can only set one filter at a time.

" + "smithy.api#documentation": "

Filters the endpoints that are returned. You can filter endpoints on their name, model,\n status, or the date and time that they were created. You can only set one filter at a time.\n

" } } } @@ -3998,16 +4217,16 @@ "com.amazonaws.comprehend#ListEndpointsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.comprehend#String", + "EndpointPropertiesList": { + "target": "com.amazonaws.comprehend#EndpointPropertiesList", "traits": { - "smithy.api#documentation": "

Identifies the next page of results to return.

" + "smithy.api#documentation": "

Displays a list of endpoint properties being retrieved by the service in response to the\n request.

" } }, - "EndpointPropertiesList": { - "target": "com.amazonaws.comprehend#EndpointPropertiesList", + "NextToken": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "

Displays a list of endpoint properties being retrieved by the service in response to the request.

" + "smithy.api#documentation": "

Identifies the next page of results to return.

" } } } @@ -4046,6 +4265,12 @@ "com.amazonaws.comprehend#ListEntitiesDetectionJobsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, "Filter": { "target": "com.amazonaws.comprehend#EntitiesDetectionJobFilter", "traits": { @@ -4057,12 +4282,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" } - }, - "NextToken": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "

Identifies the next page of results to return.

" - } } } }, @@ -4106,7 +4325,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of the properties of all entity recognizers that you created, including recognizers currently\n in training. Allows \n you to filter the list of recognizers based on criteria such as status and submission time. This \n call returns up to 500 entity recognizers in the list, with a default number of 100 \n recognizers in the list.

\n

The results of this list are not in any particular order. Please get the list and sort \n locally if needed.

", + "smithy.api#documentation": "

Gets a list of the properties of all entity recognizers that you created, including\n recognizers currently in training. Allows you to filter the list of recognizers based on\n criteria such as status and submission time. This call returns up to 500 entity recognizers in\n the list, with a default number of 100 recognizers in the list.

\n

The results of this list are not in any particular order. Please get the list and sort\n locally if needed.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4117,6 +4336,12 @@ "com.amazonaws.comprehend#ListEntityRecognizersRequest": { "type": "structure", "members": { + "Filter": { + "target": "com.amazonaws.comprehend#EntityRecognizerFilter", + "traits": { + "smithy.api#documentation": "

Filters the list of entities returned. You can filter on Status,\n SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter\n at a time.

" + } + }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { @@ -4128,29 +4353,23 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return on each page. The default is 100.

" } - }, - "Filter": { - "target": "com.amazonaws.comprehend#EntityRecognizerFilter", - "traits": { - "smithy.api#documentation": "

Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

" - } } } }, "com.amazonaws.comprehend#ListEntityRecognizersResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "

Identifies the next page of results to return.

" - } - }, "EntityRecognizerPropertiesList": { "target": "com.amazonaws.comprehend#EntityRecognizerPropertiesList", "traits": { "smithy.api#documentation": "

The list of properties of an entity recognizer.

" } + }, + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } } } }, @@ -4194,17 +4413,17 @@ "smithy.api#documentation": "

Identifies the next page of results to return.

" } }, - "MaxResults": { - "target": "com.amazonaws.comprehend#MaxResultsInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" - } - }, "Filter": { "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobFilter", "traits": { "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } } } }, @@ -4285,12 +4504,90 @@ "target": "com.amazonaws.comprehend#DocumentLabel" } }, + "com.amazonaws.comprehend#ListOfPiiEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#PiiEntity" + } + }, + "com.amazonaws.comprehend#ListOfPiiEntityTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#PiiEntityType" + } + }, "com.amazonaws.comprehend#ListOfSyntaxTokens": { "type": "list", "member": { "target": "com.amazonaws.comprehend#SyntaxToken" } }, + "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidFilterException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the PII entity detection jobs that you have submitted.

" + } + }, + "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "Filter": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page.

" + } + } + } + }, + "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, + "PiiEntitiesDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } + } + } + }, "com.amazonaws.comprehend#ListSentimentDetectionJobs": { "type": "operation", "input": { @@ -4325,10 +4622,10 @@ "com.amazonaws.comprehend#ListSentimentDetectionJobsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.comprehend#String", + "MaxResults": { + "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { - "smithy.api#documentation": "

Identifies the next page of results to return.

" + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" } }, "Filter": { @@ -4337,10 +4634,10 @@ "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.

" } }, - "MaxResults": { - "target": "com.amazonaws.comprehend#MaxResultsInteger", + "NextToken": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + "smithy.api#documentation": "

Identifies the next page of results to return.

" } } } @@ -4348,17 +4645,17 @@ "com.amazonaws.comprehend#ListSentimentDetectionJobsResponse": { "type": "structure", "members": { - "SentimentDetectionJobPropertiesList": { - "target": "com.amazonaws.comprehend#SentimentDetectionJobPropertiesList", - "traits": { - "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" - } - }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "

Identifies the next page of results to return.

" } + }, + "SentimentDetectionJobPropertiesList": { + "target": "com.amazonaws.comprehend#SentimentDetectionJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job that is returned.

" + } } } }, @@ -4382,7 +4679,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags associated with a given Amazon Comprehend resource.

" + "smithy.api#documentation": "

Lists all tags associated with a given Amazon Comprehend resource.

" } }, "com.amazonaws.comprehend#ListTagsForResourceRequest": { @@ -4391,7 +4688,7 @@ "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.\n

", "smithy.api#required": {} } } @@ -4403,13 +4700,13 @@ "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "

Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, \n a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + "smithy.api#documentation": "

Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" } }, "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are\n querying.

" } } } @@ -4448,6 +4745,12 @@ "com.amazonaws.comprehend#ListTopicsDetectionJobsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.comprehend#String", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { @@ -4459,12 +4762,6 @@ "traits": { "smithy.api#documentation": "

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the\n date and time that they were submitted. You can set only one filter at a time.

" } - }, - "NextToken": { - "target": "com.amazonaws.comprehend#String", - "traits": { - "smithy.api#documentation": "

Identifies the next page of results to return.

" - } } } }, @@ -4485,6 +4782,16 @@ } } }, + "com.amazonaws.comprehend#MaskCharacter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "[!@#$%&*]" + } + }, "com.amazonaws.comprehend#MaxResultsInteger": { "type": "integer", "traits": { @@ -4543,18 +4850,18 @@ "com.amazonaws.comprehend#OutputDataConfig": { "type": "structure", "members": { + "KmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. The KmsKeyId can be one of the following formats:

\n " + } + }, "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "

When you use the OutputDataConfig object with asynchronous operations, you\n specify the Amazon S3 location where you want to write the output data. The URI must be in the\n same region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of the output file.

\n

When the topic detection job is finished, the service creates an output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n ouput of the operation.

", "smithy.api#required": {} } - }, - "KmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", - "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

\n " - } } }, "traits": { @@ -4564,21 +4871,21 @@ "com.amazonaws.comprehend#PartOfSpeechTag": { "type": "structure", "members": { - "Tag": { - "target": "com.amazonaws.comprehend#PartOfSpeechTagType", + "Score": { + "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

Identifies the part of speech that the token represents.

" + "smithy.api#documentation": "

The confidence that Amazon Comprehend has that the part of speech was correctly\n identified.

" } }, - "Score": { - "target": "com.amazonaws.comprehend#Float", + "Tag": { + "target": "com.amazonaws.comprehend#PartOfSpeechTagType", "traits": { - "smithy.api#documentation": "

The confidence that Amazon Comprehend has that the part of speech was correctly identified.

" + "smithy.api#documentation": "

Identifies the part of speech that the token represents.

" } } }, "traits": { - "smithy.api#documentation": "

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend\n has that the part of speech was correctly identified. For more information about the parts of\n speech that Amazon Comprehend can identify, see how-syntax.

" + "smithy.api#documentation": "

Identifies the part of speech represented by the token and gives the confidence that\n Amazon Comprehend has that the part of speech was correctly identified. For more information\n about the parts of speech that Amazon Comprehend can identify, see how-syntax.

" } }, "com.amazonaws.comprehend#PartOfSpeechTagType": { @@ -4660,6 +4967,332 @@ ] } }, + "com.amazonaws.comprehend#PiiEntitiesDetectionJobFilter": { + "type": "structure", + "members": { + "SubmitTimeBefore": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

Filters on the name of the job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, + "SubmitTimeAfter": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information for filtering a list of PII entity detection jobs.

" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties": { + "type": "structure", + "members": { + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the PII entities detection job completed.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#PiiOutputDataConfig", + "traits": { + "smithy.api#documentation": "

The output data configuration that you supplied when you created the PII entities\n detection job.

" + } + }, + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", + "traits": { + "smithy.api#documentation": "

A description of the status of a job.

" + } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The name that you assigned the PII entities detection job.

" + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the output provides the locations (offsets) of PII entities or a file in\n which PII entities are redacted.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents

" + } + }, + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier assigned to the PII entities detection job.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.

" + } + }, + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the PII entities detection job was submitted for processing.

" + } + }, + "RedactionConfig": { + "target": "com.amazonaws.comprehend#RedactionConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for PII entity redaction.

\n

This parameter is required if you set the Mode parameter to\n ONLY_REDACTION. In that case, you must provide a RedactionConfig\n definition that includes the PiiEntityTypes parameter.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input properties for a PII entities detection job.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the PII entities detection job. If the status is\n FAILED, the Message field shows the reason for the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a PII entities detection job.

" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MASK", + "name": "MASK" + }, + { + "value": "REPLACE_WITH_PII_ENTITY_TYPE", + "name": "REPLACE_WITH_PII_ENTITY_TYPE" + } + ] + } + }, + "com.amazonaws.comprehend#PiiEntitiesDetectionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ONLY_REDACTION", + "name": "ONLY_REDACTION" + }, + { + "value": "ONLY_OFFSETS", + "name": "ONLY_OFFSETS" + } + ] + } + }, + "com.amazonaws.comprehend#PiiEntity": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.comprehend#PiiEntityType", + "traits": { + "smithy.api#documentation": "

The entity's type.

" + } + }, + "Score": { + "target": "com.amazonaws.comprehend#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

A character offset in the input text that shows where the PII entity ends. The offset\n returns the position of each UTF-8 code point in the string. A code point\n is the abstract character from a particular graphical representation. For example, a\n multi-byte UTF-8 character maps to a single code point.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehend#Integer", + "traits": { + "smithy.api#documentation": "

A character offset in the input text that shows where the PII entity begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a PII entity.

" + } + }, + "com.amazonaws.comprehend#PiiEntityType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BANK_ACCOUNT_NUMBER", + "name": "BANK_ACCOUNT_NUMBER" + }, + { + "value": "BANK_ROUTING", + "name": "BANK_ROUTING" + }, + { + "value": "CREDIT_DEBIT_NUMBER", + "name": "CREDIT_DEBIT_NUMBER" + }, + { + "value": "CREDIT_DEBIT_CVV", + "name": "CREDIT_DEBIT_CVV" + }, + { + "value": "CREDIT_DEBIT_EXPIRY", + "name": "CREDIT_DEBIT_EXPIRY" + }, + { + "value": "PIN", + "name": "PIN" + }, + { + "value": "EMAIL", + "name": "EMAIL" + }, + { + "value": "ADDRESS", + "name": "ADDRESS" + }, + { + "value": "NAME", + "name": "NAME" + }, + { + "value": "PHONE", + "name": "PHONE" + }, + { + "value": "SSN", + "name": "SSN" + }, + { + "value": "DATE_TIME", + "name": "DATE_TIME" + }, + { + "value": "PASSPORT_NUMBER", + "name": "PASSPORT_NUMBER" + }, + { + "value": "DRIVER_ID", + "name": "DRIVER_ID" + }, + { + "value": "URL", + "name": "URL" + }, + { + "value": "AGE", + "name": "AGE" + }, + { + "value": "USERNAME", + "name": "USERNAME" + }, + { + "value": "PASSWORD", + "name": "PASSWORD" + }, + { + "value": "AWS_ACCESS_KEY", + "name": "AWS_ACCESS_KEY" + }, + { + "value": "AWS_SECRET_KEY", + "name": "AWS_SECRET_KEY" + }, + { + "value": "IP_ADDRESS", + "name": "IP_ADDRESS" + }, + { + "value": "MAC_ADDRESS", + "name": "MAC_ADDRESS" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.comprehend#PiiOutputDataConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.comprehend#S3Uri", + "traits": { + "smithy.api#documentation": "

When you use the PiiOutputDataConfig object with asynchronous operations,\n you specify the Amazon S3 location where you want to write the output data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for the output of PII entity detection jobs.

" + } + }, + "com.amazonaws.comprehend#RedactionConfig": { + "type": "structure", + "members": { + "MaskMode": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the PII entity is redacted with the mask character or the entity\n type.

" + } + }, + "PiiEntityTypes": { + "target": "com.amazonaws.comprehend#ListOfPiiEntityTypes", + "traits": { + "smithy.api#documentation": "

An array of the types of PII entities that Amazon Comprehend detects in the input text for\n your request.

" + } + }, + "MaskCharacter": { + "target": "com.amazonaws.comprehend#MaskCharacter", + "traits": { + "smithy.api#documentation": "

A character that replaces each character in the redacted PII entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for PII entity redaction.

" + } + }, "com.amazonaws.comprehend#ResourceInUseException": { "type": "structure", "members": { @@ -4668,7 +5301,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified resource name is already in use. Use a different name and try your request again.

", + "smithy.api#documentation": "

The specified resource name is already in use. Use a different name and try your request\n again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4681,7 +5314,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

", + "smithy.api#documentation": "

The maximum number of resources per account has been exceeded. Review the resources, and\n then try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4707,7 +5340,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified resource is not available. Check the resource and try your request again.

", + "smithy.api#documentation": "

The specified resource is not available. Check the resource and try your request\n again.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -4753,16 +5386,16 @@ "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" } }, - "SubmitTimeAfter": { + "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" } }, - "SubmitTimeBefore": { + "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.

" + "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.

" } }, "JobName": { @@ -4779,16 +5412,34 @@ "com.amazonaws.comprehend#SentimentDetectionJobProperties": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

The identifier assigned to the sentiment detection job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.

" } }, - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

A description of the status of a job.

" + "smithy.api#documentation": "

The time that the sentiment detection job was submitted for processing.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your sentiment detection job. For more information, see Amazon\n VPC.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the input documents.

" + } + }, + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the sentiment detection job ended.

" } }, "OutputDataConfig": { @@ -4803,40 +5454,28 @@ "smithy.api#documentation": "

The name that you assigned to the sentiment detection job

" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", - "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. \n For more information, see Amazon VPC.

" - } - }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "

The language code of the input documents.

" + "smithy.api#documentation": "

A description of the status of a job.

" } }, "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", - "traits": { - "smithy.api#documentation": "

The input data configuration that you supplied when you created the sentiment detection\n job.

" - } - }, - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "

The time that the sentiment detection job was submitted for processing.

" + "smithy.api#documentation": "

The input data configuration that you supplied when you created the sentiment detection\n job.

" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

The time that the sentiment detection job ended.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + "smithy.api#documentation": "

The identifier assigned to the sentiment detection job.

" } }, "JobStatus": { @@ -4844,12 +5483,6 @@ "traits": { "smithy.api#documentation": "

The current status of the sentiment detection job. If the status is FAILED,\n the Messages field shows the reason for the failure.

" } - }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", - "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " - } } }, "traits": { @@ -4865,33 +5498,33 @@ "com.amazonaws.comprehend#SentimentScore": { "type": "structure", "members": { - "Negative": { + "Mixed": { "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the\n NEGATIVE sentiment.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the MIXED sentiment.

" } }, "Positive": { "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the\n POSITIVE sentiment.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the POSITIVE sentiment.

" } }, - "Mixed": { + "Negative": { "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the\n MIXED sentiment.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the NEGATIVE sentiment.

" } }, "Neutral": { "target": "com.amazonaws.comprehend#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the\n NEUTRAL sentiment.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the NEUTRAL sentiment.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of\n sentiments.

" + "smithy.api#documentation": "

Describes the level of confidence that Amazon Comprehend has in the accuracy of its\n detection of sentiments.

" } }, "com.amazonaws.comprehend#SentimentType": { @@ -4952,13 +5585,6 @@ "com.amazonaws.comprehend#StartDocumentClassificationJobRequest": { "type": "structure", "members": { - "DocumentClassifierArn": { - "target": "com.amazonaws.comprehend#DocumentClassifierArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the document classifier to use to process the\n job.

", - "smithy.api#required": {} - } - }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { @@ -4966,13 +5592,6 @@ "smithy.api#required": {} } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

Specifies where to send the output files.

", - "smithy.api#required": {} - } - }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { @@ -4983,27 +5602,41 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "DocumentClassifierArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { - "smithy.api#documentation": "

The identifier of the job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the document classifier to use to process the\n job.

", + "smithy.api#required": {} } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend\n generates one.

", + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.

", "smithy.api#idempotencyToken": {} } + }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your document classification job. For more information, see\n Amazon\n VPC.

" + } } } }, @@ -5013,7 +5646,7 @@ "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

The status of the job:

\n " + "smithy.api#documentation": "

The status of the job:

\n " } }, "JobId": { @@ -5053,43 +5686,43 @@ "com.amazonaws.comprehend#StartDominantLanguageDetectionJobRequest": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.comprehend#JobName", - "traits": { - "smithy.api#documentation": "

An identifier for the job.

" - } - }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", "smithy.api#required": {} } }, "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your dominant language detection job. For more information,\n see Amazon VPC.

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend\n generates one.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

An identifier for the job.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", + "smithy.api#required": {} } }, "OutputDataConfig": { @@ -5147,29 +5780,31 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

\n

This API can be used for either standard entity detection or custom entity recognition. In order \n to be used for custom entity recognition, the optional EntityRecognizerArn must be used\n in order to provide access to the recognizer being used to detect the custom entity.

" + "smithy.api#documentation": "

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

\n

This API can be used for either standard entity detection or custom entity recognition. In\n order to be used for custom entity recognition, the optional EntityRecognizerArn\n must be used in order to provide access to the recognizer being used to detect the custom\n entity.

" } }, "com.amazonaws.comprehend#StartEntitiesDetectionJobRequest": { "type": "structure", "members": { - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language. You can\n specify any of the languages supported by Amazon Comprehend. If custom entities recognition is\n used, this parameter is ignored and the language used for training the model is used\n instead.

", "smithy.api#required": {} } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} } }, - "EntityRecognizerArn": { - "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by\n the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity\n recognition job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", + "smithy.api#required": {} } }, "InputDataConfig": { @@ -5179,37 +5814,35 @@ "smithy.api#required": {} } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "EntityRecognizerArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used\n by the StartEntitiesDetectionJob. This ARN is optional and is only used for a\n custom entity recognition job.

" } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier of the job.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language.\n You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this\n parameter is ignored and the language used for training the model is used instead.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your entity detection job. For more information, see Amazon\n VPC.

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend\n generates one.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The identifier of the job.

" } } } @@ -5217,16 +5850,16 @@ "com.amazonaws.comprehend#StartEntitiesDetectionJobResponse": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

The identifier generated for the job. To get the status of job, use this identifier with\n the operation.

" + "smithy.api#documentation": "

The status of the job.

\n " } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "

The status of the job.

\n " + "smithy.api#documentation": "

The identifier generated for the job. To get the status of job, use this identifier with\n the operation.

" } } } @@ -5260,10 +5893,10 @@ "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobRequest": { "type": "structure", "members": { - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, "InputDataConfig": { @@ -5273,17 +5906,37 @@ "smithy.api#required": {} } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", "smithy.api#required": {} } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your key phrases detection job. For more information, see\n Amazon\n VPC.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", + "smithy.api#required": {} } }, "OutputDataConfig": { @@ -5292,18 +5945,80 @@ "smithy.api#documentation": "

Specifies where to send the output files.

", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job.

\n " + } + }, + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" + } + } + } + }, + "com.amazonaws.comprehend#StartPiiEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous PII entity detection job for a collection of documents.

" + } + }, + "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.comprehend#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the input documents.

", + "smithy.api#required": {} + } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend\n generates one.

", + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", "smithy.api#idempotencyToken": {} } }, - "LanguageCode": { - "target": "com.amazonaws.comprehend#LanguageCode", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMode", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages supported by Amazon \n Comprehend. All\n documents must be in the same language.

", + "smithy.api#documentation": "

Specifies whether the output provides the locations (offsets) of PII entities or a file in\n which PII entities are redacted.

", "smithy.api#required": {} } }, @@ -5312,22 +6027,42 @@ "traits": { "smithy.api#documentation": "

The identifier of the job.

" } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for the output of PII entity detection jobs.

", + "smithy.api#required": {} + } + }, + "RedactionConfig": { + "target": "com.amazonaws.comprehend#RedactionConfig", + "traits": { + "smithy.api#documentation": "

Provides configuration parameters for PII entity redaction.

\n

This parameter is required if you set the Mode parameter to\n ONLY_REDACTION. In that case, you must provide a RedactionConfig\n definition that includes the PiiEntityTypes parameter.

" + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", + "traits": { + "smithy.api#documentation": "

The input properties for a PII entities detection job.

", + "smithy.api#required": {} + } } } }, - "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobResponse": { + "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobResponse": { "type": "structure", "members": { - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "JobId": { + "target": "com.amazonaws.comprehend#JobId", "traits": { - "smithy.api#documentation": "

The status of the job.

\n " + "smithy.api#documentation": "

The identifier generated for the job.

" } }, - "JobId": { - "target": "com.amazonaws.comprehend#JobId", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" + "smithy.api#documentation": "

The status of the job.

" } } } @@ -5361,58 +6096,58 @@ "com.amazonaws.comprehend#StartSentimentDetectionJobRequest": { "type": "structure", "members": { - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", "smithy.api#required": {} } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", "smithy.api#required": {} } }, "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your sentiment detection job. For more information, see Amazon\n VPC.

" } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend\n generates one.

", + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", "smithy.api#idempotencyToken": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages supported by Amazon \n Comprehend. All\n documents must be in the same language.

", + "smithy.api#documentation": "

The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.

", "smithy.api#required": {} } - }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", - "traits": { - "smithy.api#documentation": "

The identifier of the job.

" - } } } }, @@ -5462,24 +6197,10 @@ "com.amazonaws.comprehend#StartTopicsDetectionJobRequest": { "type": "structure", "members": { - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role\n that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehend#ClientRequestTokenString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend\n generates one.

", - "smithy.api#idempotencyToken": {} - } - }, "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your topic detection job. For more information, see Amazon\n VPC.

" } }, "InputDataConfig": { @@ -5489,29 +6210,43 @@ "smithy.api#required": {} } }, + "JobName": { + "target": "com.amazonaws.comprehend#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " + } + }, "NumberOfTopics": { "target": "com.amazonaws.comprehend#NumberOfTopicsInteger", "traits": { "smithy.api#documentation": "

The number of topics to detect.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "ClientRequestToken": { + "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.

", + "smithy.api#idempotencyToken": {} } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

Specifies where to send the output files. The output is a compressed archive with two\n files, topic-terms.csv that lists the terms associated with each topic, and\n doc-topics.csv that lists the documents associated with each topic

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role\n that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", "smithy.api#required": {} } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The identifier of the job.

" + "smithy.api#documentation": "

Specifies where to send the output files. The output is a compressed archive with two\n files, topic-terms.csv that lists the terms associated with each topic, and\n doc-topics.csv that lists the documents associated with each topic

", + "smithy.api#required": {} } } } @@ -5571,17 +6306,17 @@ "com.amazonaws.comprehend#StopDominantLanguageDetectionJobResponse": { "type": "structure", "members": { - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", - "traits": { - "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopDominantLanguageDetectionJob operation.

" - } - }, "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "

The identifier of the dominant language detection job to stop.

" } + }, + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopDominantLanguageDetectionJob operation.

" + } } } }, @@ -5623,17 +6358,17 @@ "com.amazonaws.comprehend#StopEntitiesDetectionJobResponse": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.comprehend#JobId", - "traits": { - "smithy.api#documentation": "

The identifier of the entities detection job to stop.

" - } - }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "

Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopEntitiesDetectionJob operation.

" } + }, + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the entities detection job to stop.

" + } } } }, @@ -5689,6 +6424,58 @@ } } }, + "com.amazonaws.comprehend#StopPiiEntitiesDetectionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#JobNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a PII entities detection job in progress.

" + } + }, + "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the PII entities detection job to stop.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", + "traits": { + "smithy.api#documentation": "

The status of the PII entities detection job.

" + } + }, + "JobId": { + "target": "com.amazonaws.comprehend#JobId", + "traits": { + "smithy.api#documentation": "

The identifier of the PII entities detection job to stop.

" + } + } + } + }, "com.amazonaws.comprehend#StopSentimentDetectionJob": { "type": "operation", "input": { @@ -5764,7 +6551,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a document classifier training job while in progress.

\n

If the training job state is TRAINING, the job is marked for termination \n and put into the STOP_REQUESTED state. If the training job completes before it can be \n stopped, it is put into the TRAINED; otherwise the training job is stopped and \n put into the STOPPED state and the service sends back an HTTP 200 response \n with an empty HTTP body.

" + "smithy.api#documentation": "

Stops a document classifier training job while in progress.

\n

If the training job state is TRAINING, the job is marked for termination and\n put into the STOP_REQUESTED state. If the training job completes before it can be\n stopped, it is put into the TRAINED; otherwise the training job is stopped and\n put into the STOPPED state and the service sends back an HTTP 200 response with\n an empty HTTP body.

" } }, "com.amazonaws.comprehend#StopTrainingDocumentClassifierRequest": { @@ -5773,7 +6560,7 @@ "DocumentClassifierArn": { "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the document classifier currently being\n trained.

", "smithy.api#required": {} } } @@ -5806,7 +6593,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an entity recognizer training job while in progress.

\n

If the training job state is TRAINING, the job is marked for termination and put into \n the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the \n training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

" + "smithy.api#documentation": "

Stops an entity recognizer training job while in progress.

\n

If the training job state is TRAINING, the job is marked for termination and\n put into the STOP_REQUESTED state. If the training job completes before it can be\n stopped, it is put into the TRAINED; otherwise the training job is stopped and\n putted into the STOPPED state and the service sends back an HTTP 200 response\n with an empty HTTP body.

" } }, "com.amazonaws.comprehend#StopTrainingEntityRecognizerRequest": { @@ -5815,7 +6602,7 @@ "EntityRecognizerArn": { "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the entity recognizer currently being\n trained.

", "smithy.api#required": {} } } @@ -5889,10 +6676,10 @@ "com.amazonaws.comprehend#SyntaxToken": { "type": "structure", "members": { - "TokenId": { - "target": "com.amazonaws.comprehend#Integer", + "Text": { + "target": "com.amazonaws.comprehend#String", "traits": { - "smithy.api#documentation": "

A unique identifier for a token.

" + "smithy.api#documentation": "

The word that was recognized in the source text.

" } }, "BeginOffset": { @@ -5901,22 +6688,22 @@ "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the first character in the\n word.

" } }, - "EndOffset": { + "TokenId": { "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n word.

" + "smithy.api#documentation": "

A unique identifier for a token.

" } }, - "Text": { - "target": "com.amazonaws.comprehend#String", + "EndOffset": { + "target": "com.amazonaws.comprehend#Integer", "traits": { - "smithy.api#documentation": "

The word that was recognized in the source text.

" + "smithy.api#documentation": "

The zero-based offset from the beginning of the source text to the last character in the\n word.

" } }, "PartOfSpeech": { "target": "com.amazonaws.comprehend#PartOfSpeechTag", "traits": { - "smithy.api#documentation": "

Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of\n speech was correctly identified. For more information, see how-syntax.

" + "smithy.api#documentation": "

Provides the part of speech label and the confidence level that Amazon Comprehend has that\n the part of speech was correctly identified. For more information, see how-syntax.

" } } }, @@ -5927,22 +6714,22 @@ "com.amazonaws.comprehend#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.comprehend#TagValue", - "traits": { - "smithy.api#documentation": "

The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

" - } - }, "Key": { "target": "com.amazonaws.comprehend#TagKey", "traits": { - "smithy.api#documentation": "

The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

", + "smithy.api#documentation": "

The initial part of a key-value pair that forms a tag associated with a given resource.\n For instance, if you want to show which resources are used by which departments, you might use\n “Department” as the key portion of the pair, with multiple possible values such as “sales,”\n “legal,” and “administration.”

", "smithy.api#required": {} } + }, + "Value": { + "target": "com.amazonaws.comprehend#TagValue", + "traits": { + "smithy.api#documentation": "

The second part of a key-value pair that forms a tag associated with a given resource.\n For instance, if you want to show which resources are used by which departments, you might use\n “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the\n sales department.

" + } } }, "traits": { - "smithy.api#documentation": "

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

" + "smithy.api#documentation": "

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For\n example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to\n indicate its use by a particular department.

" } }, "com.amazonaws.comprehend#TagKey": { @@ -5992,7 +6779,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. \n For example, \n a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + "smithy.api#documentation": "

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n

" } }, "com.amazonaws.comprehend#TagResourceRequest": { @@ -6001,14 +6788,14 @@ "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want\n to associate the tags.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { - "smithy.api#documentation": "

Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

", + "smithy.api#documentation": "

Tags being associated with a specific Amazon Comprehend resource. There can be a maximum\n of 50 tags (both existing and pending) associated with a specific resource.

", "smithy.api#required": {} } } @@ -6064,7 +6851,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

", + "smithy.api#documentation": "

The request contains more tag keys than can be associated with a resource (50 tag keys per\n resource).

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6077,7 +6864,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum\n number of tags includes both existing tags and those included in your current request.

", + "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per\n resource). The maximum number of tags includes both existing tags and those included in your\n current request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6085,10 +6872,10 @@ "com.amazonaws.comprehend#TopicsDetectionJobFilter": { "type": "structure", "members": { - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "JobName": { + "target": "com.amazonaws.comprehend#JobName", "traits": { - "smithy.api#documentation": "

Filters the list of topic detection jobs based on job status. Returns only jobs with\n the specified status.

" + "smithy.api#documentation": "

" } }, "SubmitTimeAfter": { @@ -6103,10 +6890,10 @@ "smithy.api#documentation": "

Filters the list of jobs based on the time that the job was submitted for processing.\n Only returns jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.

" } }, - "JobName": { - "target": "com.amazonaws.comprehend#JobName", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Filters the list of topic detection jobs based on job status. Returns only jobs with\n the specified status.

" } } }, @@ -6117,28 +6904,28 @@ "com.amazonaws.comprehend#TopicsDetectionJobProperties": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.comprehend#AnyLengthString", + "JobStatus": { + "target": "com.amazonaws.comprehend#JobStatus", "traits": { - "smithy.api#documentation": "

A description for the status of a job.

" + "smithy.api#documentation": "

The current status of the topic detection job. If the status is Failed,\n the reason for the failure is shown in the Message field.

" } }, - "SubmitTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

The time that the topic detection job was submitted for processing.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your job data.

" } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.comprehend#KmsKeyId", + "VpcConfig": { + "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that \n process the analysis job. The VolumeKmsKeyId can be either of the following formats:

\n " + "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your topic detection job. For more information, see Amazon\n VPC.

" } }, - "JobStatus": { - "target": "com.amazonaws.comprehend#JobStatus", + "InputDataConfig": { + "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { - "smithy.api#documentation": "

The current status of the topic detection job. If the status is Failed,\n the reason for the failure is shown in the Message field.

" + "smithy.api#documentation": "

The input data configuration supplied when you created the topic detection\n job.

" } }, "JobId": { @@ -6147,34 +6934,28 @@ "smithy.api#documentation": "

The identifier assigned to the topic detection job.

" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehend#InputDataConfig", - "traits": { - "smithy.api#documentation": "

The input data configuration supplied when you created the topic detection\n job.

" - } - }, "NumberOfTopics": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "

The number of topics to detect supplied when you created the topic detection job. The\n default is 10.

" } }, - "EndTime": { - "target": "com.amazonaws.comprehend#Timestamp", + "VolumeKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { - "smithy.api#documentation": "

The time that the topic detection job was completed.

" + "smithy.api#documentation": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:

\n " } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehend#IamRoleArn", + "SubmitTime": { + "target": "com.amazonaws.comprehend#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.

" + "smithy.api#documentation": "

The time that the topic detection job was submitted for processing.

" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehend#OutputDataConfig", + "Message": { + "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { - "smithy.api#documentation": "

The output data configuration supplied when you created the topic detection\n job.

" + "smithy.api#documentation": "

A description for the status of a job.

" } }, "JobName": { @@ -6183,10 +6964,16 @@ "smithy.api#documentation": "

The name of the topic detection job.

" } }, - "VpcConfig": { - "target": "com.amazonaws.comprehend#VpcConfig", + "EndTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the topic detection job was completed.

" + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { - "smithy.api#documentation": "

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

The output data configuration supplied when you created the topic detection\n job.

" } } }, @@ -6208,7 +6995,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Comprehend can't process the language of the input text. For all custom entity recognition\n APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in \n all supported languages. For a list of supported languages, see supported-languages.

", + "smithy.api#documentation": "

Amazon Comprehend can't process the language of the input text. For all custom entity\n recognition APIs (such as CreateEntityRecognizer), only English, Spanish, French,\n Italian, German, or Portuguese are accepted. For most other APIs, such as those for Custom\n Classification, Amazon Comprehend accepts text in all supported languages. For a list of\n supported languages, see supported-languages.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6248,14 +7035,14 @@ "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you\n want to remove the tags.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.comprehend#TagKeyList", "traits": { - "smithy.api#documentation": "

The initial part of a key-value pair that forms a tag being removed from a given resource. \n For example, \n a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.

", + "smithy.api#documentation": "

The initial part of a key-value pair that forms a tag being removed from a given resource.\n For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by\n the sales department. Keys must be unique and cannot be duplicated for a particular resource.\n

", "smithy.api#required": {} } } @@ -6303,17 +7090,17 @@ "com.amazonaws.comprehend#UpdateEndpointRequest": { "type": "structure", "members": { - "EndpointArn": { - "target": "com.amazonaws.comprehend#ComprehendEndpointArn", + "DesiredInferenceUnits": { + "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint being updated.

", + "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.

", "smithy.api#required": {} } }, - "DesiredInferenceUnits": { - "target": "com.amazonaws.comprehend#InferenceUnitsInteger", + "EndpointArn": { + "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { - "smithy.api#documentation": "

The desired number of inference units to be used by the model using this endpoint. Each \n inference unit represents of a throughput of 100 characters per second.

", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the endpoint being updated.

", "smithy.api#required": {} } } @@ -6326,23 +7113,23 @@ "com.amazonaws.comprehend#VpcConfig": { "type": "structure", "members": { - "Subnets": { - "target": "com.amazonaws.comprehend#Subnets", + "SecurityGroupIds": { + "target": "com.amazonaws.comprehend#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the \n VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by \"subnet-\", for instance: \"subnet-04ccf456919e69055\". \n For more information, see VPCs and Subnets.

", + "smithy.api#documentation": "

The ID number for a security group on an instance of your private VPC. Security groups on\n your VPC function serve as a virtual firewall to control inbound and outbound traffic and\n provides security for the resources that you’ll be accessing on the VPC. This ID number is\n preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see Security\n Groups for your VPC.

", "smithy.api#required": {} } }, - "SecurityGroupIds": { - "target": "com.amazonaws.comprehend#SecurityGroupIds", + "Subnets": { + "target": "com.amazonaws.comprehend#Subnets", "traits": { - "smithy.api#documentation": "

The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and \n provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". \n For more information, see Security Groups for your VPC.

", + "smithy.api#documentation": "

The ID for each subnet being used in your private VPC. This subnet is a subset of the a\n range of IPv4 addresses used by the VPC and is specific to a given availability zone in the\n VPC’s region. This ID number is preceded by \"subnet-\", for instance:\n \"subnet-04ccf456919e69055\". For more information, see VPCs and\n Subnets.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For \n For more information, see Amazon VPC.

" + "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for the job. For For more information, see Amazon\n VPC.

" } } } diff --git a/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json b/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json index 72c000c25aee..5361dbb4af10 100644 --- a/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json +++ b/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json @@ -35,28 +35,16 @@ "com.amazonaws.comprehendmedical#Attribute": { "type": "structure", "members": { - "Score": { - "target": "com.amazonaws.comprehendmedical#Float", - "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized\n as an attribute.

" - } - }, - "Category": { - "target": "com.amazonaws.comprehendmedical#EntityType", - "traits": { - "smithy.api#documentation": "

The category of attribute.

" - } - }, - "RelationshipScore": { - "target": "com.amazonaws.comprehendmedical#Float", + "EndOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this\n entity.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute ends. The\n offset returns the UTF-8 code point in the string.

" } }, - "EndOffset": { + "BeginOffset": { "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute ends. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute begins. The\n offset returns the UTF-8 code point in the string.

" } }, "Id": { @@ -65,10 +53,16 @@ "smithy.api#documentation": "

The numeric identifier for this attribute. This is a monotonically increasing id unique\n within this response rather than a global unique identifier.

" } }, - "BeginOffset": { - "target": "com.amazonaws.comprehendmedical#Integer", + "Category": { + "target": "com.amazonaws.comprehendmedical#EntityType", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute begins. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The category of attribute.

" + } + }, + "RelationshipType": { + "target": "com.amazonaws.comprehendmedical#RelationshipType", + "traits": { + "smithy.api#documentation": "

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.\n

" } }, "Traits": { @@ -77,10 +71,16 @@ "smithy.api#documentation": "

Contextual information for this attribute.

" } }, - "RelationshipType": { - "target": "com.amazonaws.comprehendmedical#RelationshipType", + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.\n

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized\n as an attribute.

" + } + }, + "Type": { + "target": "com.amazonaws.comprehendmedical#EntitySubType", + "traits": { + "smithy.api#documentation": "

The type of attribute.

" } }, "Text": { @@ -89,10 +89,10 @@ "smithy.api#documentation": "

The segment of input text extracted as this attribute.

" } }, - "Type": { - "target": "com.amazonaws.comprehendmedical#EntitySubType", + "RelationshipScore": { + "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The type of attribute.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this\n entity.

" } } }, @@ -151,6 +151,12 @@ "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobFilter": { "type": "structure", "members": { + "JobStatus": { + "target": "com.amazonaws.comprehendmedical#JobStatus", + "traits": { + "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" + } + }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehendmedical#Timestamp", "traits": { @@ -168,12 +174,6 @@ "traits": { "smithy.api#documentation": "

Filters on the name of the job.

" } - }, - "JobStatus": { - "target": "com.amazonaws.comprehendmedical#JobStatus", - "traits": { - "smithy.api#documentation": "

Filters the list of jobs based on job status. Returns only jobs with the specified\n status.

" - } } }, "traits": { @@ -183,16 +183,16 @@ "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobProperties": { "type": "structure", "members": { - "ManifestFilePath": { - "target": "com.amazonaws.comprehendmedical#ManifestFilePath", + "EndTime": { + "target": "com.amazonaws.comprehendmedical#Timestamp", "traits": { - "smithy.api#documentation": "

The path to the file that describes the results of a batch job.

" + "smithy.api#documentation": "

The time that the detection job completed.

" } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehendmedical#InputDataConfig", + "SubmitTime": { + "target": "com.amazonaws.comprehendmedical#Timestamp", "traits": { - "smithy.api#documentation": "

The input data configuration that you supplied when you created the detection job.

" + "smithy.api#documentation": "

The time that the detection job was submitted for processing.

" } }, "ModelVersion": { @@ -201,22 +201,16 @@ "smithy.api#documentation": "

The version of the model used to analyze the documents. The version number looks like\n X.X.X. You can use this information to track the model used for a particular batch of\n documents.

" } }, - "OutputDataConfig": { - "target": "com.amazonaws.comprehendmedical#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

The output data configuration that you supplied when you created the detection job.

" - } - }, - "EndTime": { - "target": "com.amazonaws.comprehendmedical#Timestamp", + "InputDataConfig": { + "target": "com.amazonaws.comprehendmedical#InputDataConfig", "traits": { - "smithy.api#documentation": "

The time that the detection job completed.

" + "smithy.api#documentation": "

The input data configuration that you supplied when you created the detection job.

" } }, - "JobName": { - "target": "com.amazonaws.comprehendmedical#JobName", + "OutputDataConfig": { + "target": "com.amazonaws.comprehendmedical#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The name that you assigned to the detection job.

" + "smithy.api#documentation": "

The output data configuration that you supplied when you created the detection job.

" } }, "Message": { @@ -225,10 +219,16 @@ "smithy.api#documentation": "

A description of the status of a job.

" } }, - "SubmitTime": { - "target": "com.amazonaws.comprehendmedical#Timestamp", + "KMSKey": { + "target": "com.amazonaws.comprehendmedical#KMSKey", "traits": { - "smithy.api#documentation": "

The time that the detection job was submitted for processing.

" + "smithy.api#documentation": "

The AWS Key Management Service key, if any, used to encrypt the output files.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.comprehendmedical#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the detection job. If the status is FAILED, the\n Message field shows the reason for the failure.

" } }, "ExpirationTime": { @@ -243,22 +243,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

" } }, - "KMSKey": { - "target": "com.amazonaws.comprehendmedical#KMSKey", + "LanguageCode": { + "target": "com.amazonaws.comprehendmedical#LanguageCode", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service key, if any, used to encrypt the output files.

" + "smithy.api#documentation": "

The language code of the input documents.

" } }, - "JobStatus": { - "target": "com.amazonaws.comprehendmedical#JobStatus", + "JobName": { + "target": "com.amazonaws.comprehendmedical#JobName", "traits": { - "smithy.api#documentation": "

The current status of the detection job. If the status is FAILED, the\n Message field shows the reason for the failure.

" + "smithy.api#documentation": "

The name that you assigned to the detection job.

" } }, - "LanguageCode": { - "target": "com.amazonaws.comprehendmedical#LanguageCode", + "ManifestFilePath": { + "target": "com.amazonaws.comprehendmedical#ManifestFilePath", "traits": { - "smithy.api#documentation": "

The language code of the input documents.

" + "smithy.api#documentation": "

The path to the file that describes the results of a batch job.

" } }, "JobId": { @@ -351,7 +351,7 @@ "sdkId": "ComprehendMedical", "arnNamespace": "comprehendmedical", "cloudFormationName": "ComprehendMedical", - "cloudTrailEventSource": "medical.deepinsight.amazonaws.com" + "cloudTrailEventSource": "comprehendmedical.amazonaws.com" }, "aws.auth#sigv4": { "name": "comprehendmedical" @@ -607,6 +607,13 @@ "com.amazonaws.comprehendmedical#DetectEntitiesResponse": { "type": "structure", "members": { + "Entities": { + "target": "com.amazonaws.comprehendmedical#EntityList", + "traits": { + "smithy.api#documentation": "

The collection of medical entities extracted from the input text and their associated\n information. For each entity, the response provides the entity text, the entity category,\n where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the\n detection and analysis. Attributes and traits of the entity are also returned.

", + "smithy.api#required": {} + } + }, "ModelVersion": { "target": "com.amazonaws.comprehendmedical#String", "traits": { @@ -620,13 +627,6 @@ "smithy.api#documentation": "

If the result of the previous request to DetectEntities was truncated,\n include the PaginationToken to fetch the next page of entities.

" } }, - "Entities": { - "target": "com.amazonaws.comprehendmedical#EntityList", - "traits": { - "smithy.api#documentation": "

The collection of medical entities extracted from the input text and their associated\n information. For each entity, the response provides the entity text, the entity category,\n where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the\n detection and analysis. Attributes and traits of the entity are also returned.

", - "smithy.api#required": {} - } - }, "UnmappedAttributes": { "target": "com.amazonaws.comprehendmedical#UnmappedAttributeList", "traits": { @@ -688,10 +688,11 @@ "smithy.api#documentation": "

Attributes extracted from the input text that couldn't be related to an entity.

" } }, - "PaginationToken": { + "ModelVersion": { "target": "com.amazonaws.comprehendmedical#String", "traits": { - "smithy.api#documentation": "

If the result to the DetectEntitiesV2 operation was truncated, include the\n PaginationToken to fetch the next page of entities.

" + "smithy.api#documentation": "

The version of the model used to analyze the documents. The version number looks like\n X.X.X. You can use this information to track the model used for a particular batch of\n documents.

", + "smithy.api#required": {} } }, "Entities": { @@ -701,11 +702,10 @@ "smithy.api#required": {} } }, - "ModelVersion": { + "PaginationToken": { "target": "com.amazonaws.comprehendmedical#String", "traits": { - "smithy.api#documentation": "

The version of the model used to analyze the documents. The version number looks like\n X.X.X. You can use this information to track the model used for a particular batch of\n documents.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If the result to the DetectEntitiesV2 operation was truncated, include the\n PaginationToken to fetch the next page of entities.

" } } } @@ -782,34 +782,34 @@ "com.amazonaws.comprehendmedical#Entity": { "type": "structure", "members": { - "Text": { - "target": "com.amazonaws.comprehendmedical#String", + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The segment of input text extracted as this entity.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

" } }, - "EndOffset": { - "target": "com.amazonaws.comprehendmedical#Integer", + "Category": { + "target": "com.amazonaws.comprehendmedical#EntityType", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity ends. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The category of the entity.

" } }, - "Attributes": { - "target": "com.amazonaws.comprehendmedical#AttributeList", + "Type": { + "target": "com.amazonaws.comprehendmedical#EntitySubType", "traits": { - "smithy.api#documentation": "

The extracted attributes that relate to this entity.

" + "smithy.api#documentation": "

Describes the specific type of entity with category of entities.

" } }, - "Category": { - "target": "com.amazonaws.comprehendmedical#EntityType", + "BeginOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The category of the entity.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity begins. The\n offset returns the UTF-8 code point in the string.

" } }, - "BeginOffset": { + "EndOffset": { "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity begins. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity ends. The\n offset returns the UTF-8 code point in the string.

" } }, "Id": { @@ -818,22 +818,22 @@ "smithy.api#documentation": "

The numeric identifier for the entity. This is a monotonically increasing id unique\n within this response rather than a global unique identifier.

" } }, - "Type": { - "target": "com.amazonaws.comprehendmedical#EntitySubType", + "Traits": { + "target": "com.amazonaws.comprehendmedical#TraitList", "traits": { - "smithy.api#documentation": "

Describes the specific type of entity with category of entities.

" + "smithy.api#documentation": "

Contextual information for the entity.

" } }, - "Score": { - "target": "com.amazonaws.comprehendmedical#Float", + "Attributes": { + "target": "com.amazonaws.comprehendmedical#AttributeList", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

" + "smithy.api#documentation": "

The extracted attributes that relate to this entity.

" } }, - "Traits": { - "target": "com.amazonaws.comprehendmedical#TraitList", + "Text": { + "target": "com.amazonaws.comprehendmedical#String", "traits": { - "smithy.api#documentation": "

Contextual information for the entity.

" + "smithy.api#documentation": "

The segment of input text extracted as this entity.

" } } }, @@ -1036,28 +1036,22 @@ "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that this attribute is\n correctly related to this entity.

" } }, - "Type": { - "target": "com.amazonaws.comprehendmedical#ICD10CMAttributeType", - "traits": { - "smithy.api#documentation": "

The type of attribute. InferICD10CM detects entities of the type DX_NAME.\n

" - } - }, "Score": { "target": "com.amazonaws.comprehendmedical#Float", "traits": { "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the segment of text is\n correctly recognized as an attribute.

" } }, - "EndOffset": { - "target": "com.amazonaws.comprehendmedical#Integer", + "Type": { + "target": "com.amazonaws.comprehendmedical#ICD10CMAttributeType", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute ends. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The type of attribute. InferICD10CM detects entities of the type DX_NAME.\n

" } }, - "Id": { + "EndOffset": { "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The numeric identifier for this attribute. This is a monotonically increasing id unique\n within this response rather than a global unique identifier.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute ends. The\n offset returns the UTF-8 code point in the string.

" } }, "Traits": { @@ -1066,10 +1060,10 @@ "smithy.api#documentation": "

The contextual information for the attribute. The traits recognized by InferICD10CM are\n DIAGNOSIS, SIGN, SYMPTOM, and\n NEGATION.

" } }, - "BeginOffset": { + "Id": { "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute begins. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The numeric identifier for this attribute. This is a monotonically increasing id unique\n within this response rather than a global unique identifier.

" } }, "Text": { @@ -1077,6 +1071,12 @@ "traits": { "smithy.api#documentation": "

The segment of input text which contains the detected attribute.

" } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute begins. The\n offset returns the UTF-8 code point in the string.

" + } } }, "traits": { @@ -1151,22 +1151,22 @@ "com.amazonaws.comprehendmedical#ICD10CMEntity": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.comprehendmedical#ICD10CMAttributeList", + "Text": { + "target": "com.amazonaws.comprehendmedical#OntologyLinkingBoundedLengthString", "traits": { - "smithy.api#documentation": "

The detected attributes that relate to the entity. An extracted segment of the text that\n is an attribute of an entity, or otherwise related to an entity, such as the nature of a\n medical condition.

" + "smithy.api#documentation": "

The segment of input text that is matched to the detected entity.

" } }, - "ICD10CMConcepts": { - "target": "com.amazonaws.comprehendmedical#ICD10CMConceptList", + "Attributes": { + "target": "com.amazonaws.comprehendmedical#ICD10CMAttributeList", "traits": { - "smithy.api#documentation": "

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the\n likelihood of the match.

" + "smithy.api#documentation": "

The detected attributes that relate to the entity. An extracted segment of the text that\n is an attribute of an entity, or otherwise related to an entity, such as the nature of a\n medical condition.

" } }, - "Id": { - "target": "com.amazonaws.comprehendmedical#Integer", + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The numeric identifier for the entity. This is a monotonically increasing id unique within\n this response rather than a global unique identifier.

" + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has in the accuracy of the\n detection.

" } }, "Traits": { @@ -1175,16 +1175,10 @@ "smithy.api#documentation": "

Provides Contextual information for the entity. The traits recognized by InferICD10CM are\n DIAGNOSIS, SIGN, SYMPTOM, and\n NEGATION.\n

" } }, - "EndOffset": { - "target": "com.amazonaws.comprehendmedical#Integer", - "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity ends. The\n offset returns the UTF-8 code point in the string.

" - } - }, - "BeginOffset": { - "target": "com.amazonaws.comprehendmedical#Integer", + "ICD10CMConcepts": { + "target": "com.amazonaws.comprehendmedical#ICD10CMConceptList", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity begins. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the\n likelihood of the match.

" } }, "Type": { @@ -1193,10 +1187,10 @@ "smithy.api#documentation": "

Describes the specific type of entity with category of entities. InferICD10CM detects\n entities of the type DX_NAME.

" } }, - "Score": { - "target": "com.amazonaws.comprehendmedical#Float", + "EndOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has in the accuracy of the\n detection.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity ends. The\n offset returns the UTF-8 code point in the string.

" } }, "Category": { @@ -1205,10 +1199,16 @@ "smithy.api#documentation": "

The category of the entity. InferICD10CM detects entities in the\n MEDICAL_CONDITION category.

" } }, - "Text": { - "target": "com.amazonaws.comprehendmedical#OntologyLinkingBoundedLengthString", + "Id": { + "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The segment of input text that is matched to the detected entity.

" + "smithy.api#documentation": "

The numeric identifier for the entity. This is a monotonically increasing id unique within\n this response rather than a global unique identifier.

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity begins. The\n offset returns the UTF-8 code point in the string.

" } } }, @@ -1247,17 +1247,17 @@ "com.amazonaws.comprehendmedical#ICD10CMTrait": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.comprehendmedical#ICD10CMTraitName", - "traits": { - "smithy.api#documentation": "

Provides a name or contextual description about the trait.

" - } - }, "Score": { "target": "com.amazonaws.comprehendmedical#Float", "traits": { "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized\n as a trait.

" } + }, + "Name": { + "target": "com.amazonaws.comprehendmedical#ICD10CMTraitName", + "traits": { + "smithy.api#documentation": "

Provides a name or contextual description about the trait.

" + } } }, "traits": { @@ -1418,6 +1418,12 @@ "com.amazonaws.comprehendmedical#InferRxNormResponse": { "type": "structure", "members": { + "PaginationToken": { + "target": "com.amazonaws.comprehendmedical#String", + "traits": { + "smithy.api#documentation": "

If the result of the previous request to InferRxNorm was truncated, include\n the PaginationToken to fetch the next page of medication entities.

" + } + }, "Entities": { "target": "com.amazonaws.comprehendmedical#RxNormEntityList", "traits": { @@ -1430,30 +1436,24 @@ "traits": { "smithy.api#documentation": "

The version of the model used to analyze the documents, in the format\n n.n.n You can use this\n information to track the model used for a particular batch of documents.

" } - }, - "PaginationToken": { - "target": "com.amazonaws.comprehendmedical#String", - "traits": { - "smithy.api#documentation": "

If the result of the previous request to InferRxNorm was truncated, include\n the PaginationToken to fetch the next page of medication entities.

" - } } } }, "com.amazonaws.comprehendmedical#InputDataConfig": { "type": "structure", "members": { + "S3Key": { + "target": "com.amazonaws.comprehendmedical#S3Key", + "traits": { + "smithy.api#documentation": "

The path to the input data files in the S3 bucket.

" + } + }, "S3Bucket": { "target": "com.amazonaws.comprehendmedical#S3Bucket", "traits": { "smithy.api#documentation": "

The URI of the S3 bucket that contains the input data. The bucket must be in the same\n region as the API endpoint that you are calling.

\n

Each file in the document collection must be less than 40 KB. You can store a maximum of\n 30 GB in the bucket.

", "smithy.api#required": {} } - }, - "S3Key": { - "target": "com.amazonaws.comprehendmedical#S3Key", - "traits": { - "smithy.api#documentation": "

The path to the input data files in the S3 bucket.

" - } } }, "traits": { @@ -1610,12 +1610,6 @@ "com.amazonaws.comprehendmedical#ListEntitiesDetectionV2JobsRequest": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobFilter", - "traits": { - "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs based on their names, status, or\n the date and time that they were submitted. You can only set one filter at a time.

" - } - }, "NextToken": { "target": "com.amazonaws.comprehendmedical#String", "traits": { @@ -1627,23 +1621,29 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" } + }, + "Filter": { + "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs based on their names, status, or\n the date and time that they were submitted. You can only set one filter at a time.

" + } } } }, "com.amazonaws.comprehendmedical#ListEntitiesDetectionV2JobsResponse": { "type": "structure", "members": { - "ComprehendMedicalAsyncJobPropertiesList": { - "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobPropertiesList", - "traits": { - "smithy.api#documentation": "

A list containing the properties of each job returned.

" - } - }, "NextToken": { "target": "com.amazonaws.comprehendmedical#String", "traits": { "smithy.api#documentation": "

Identifies the next page of results to return.

" } + }, + "ComprehendMedicalAsyncJobPropertiesList": { + "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobPropertiesList", + "traits": { + "smithy.api#documentation": "

A list containing the properties of each job returned.

" + } } } }, @@ -1682,17 +1682,17 @@ "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

" } }, - "MaxResults": { - "target": "com.amazonaws.comprehendmedical#MaxResultsInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" - } - }, "NextToken": { "target": "com.amazonaws.comprehendmedical#String", "traits": { "smithy.api#documentation": "

Identifies the next page of results to return.

" } + }, + "MaxResults": { + "target": "com.amazonaws.comprehendmedical#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in each page. The default is 100.

" + } } } }, @@ -1808,18 +1808,18 @@ "com.amazonaws.comprehendmedical#ListRxNormInferenceJobsRequest": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobFilter", - "traits": { - "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

" - } - }, "MaxResults": { "target": "com.amazonaws.comprehendmedical#MaxResultsInteger", "traits": { "smithy.api#documentation": "

Identifies the next page of results to return.

" } }, + "Filter": { + "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobFilter", + "traits": { + "smithy.api#documentation": "

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

" + } + }, "NextToken": { "target": "com.amazonaws.comprehendmedical#String", "traits": { @@ -1992,16 +1992,10 @@ "com.amazonaws.comprehendmedical#RxNormAttribute": { "type": "structure", "members": { - "Score": { - "target": "com.amazonaws.comprehendmedical#Float", - "traits": { - "smithy.api#documentation": "

The level of confidence that Comprehend Medical has that the segment of text is correctly\n recognized as an attribute.

" - } - }, - "RelationshipScore": { - "target": "com.amazonaws.comprehendmedical#Float", + "EndOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the attribute is\n accurately linked to an entity.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute ends. The\n offset returns the UTF-8 code point in the string.

" } }, "BeginOffset": { @@ -2010,16 +2004,22 @@ "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute begins. The\n offset returns the UTF-8 code point in the string.

" } }, + "RelationshipScore": { + "target": "com.amazonaws.comprehendmedical#Float", + "traits": { + "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the attribute is\n accurately linked to an entity.

" + } + }, "Type": { "target": "com.amazonaws.comprehendmedical#RxNormAttributeType", "traits": { "smithy.api#documentation": "

The type of attribute. The types of attributes recognized by InferRxNorm are\n BRAND_NAME and GENERIC_NAME.

" } }, - "EndOffset": { - "target": "com.amazonaws.comprehendmedical#Integer", + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the attribute ends. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The level of confidence that Comprehend Medical has that the segment of text is correctly\n recognized as an attribute.

" } }, "Traits": { @@ -2028,17 +2028,17 @@ "smithy.api#documentation": "

Contextual information for the attribute. InferRxNorm recognizes the trait\n NEGATION for attributes, i.e. that the patient is not taking a specific dose or\n form of a medication.

" } }, - "Id": { - "target": "com.amazonaws.comprehendmedical#Integer", - "traits": { - "smithy.api#documentation": "

The numeric identifier for this attribute. This is a monotonically increasing id unique\n within this response rather than a global unique identifier.

" - } - }, "Text": { "target": "com.amazonaws.comprehendmedical#String", "traits": { "smithy.api#documentation": "

The segment of input text which corresponds to the detected attribute.

" } + }, + "Id": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

The numeric identifier for this attribute. This is a monotonically increasing id unique\n within this response rather than a global unique identifier.

" + } } }, "traits": { @@ -2121,10 +2121,22 @@ "com.amazonaws.comprehendmedical#RxNormEntity": { "type": "structure", "members": { - "EndOffset": { + "BeginOffset": { "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity ends. The\n offset returns the UTF-8 code point in the string.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity begins. The\n offset returns the UTF-8 code point in the string.

" + } + }, + "RxNormConcepts": { + "target": "com.amazonaws.comprehendmedical#RxNormConceptList", + "traits": { + "smithy.api#documentation": "

The RxNorm concepts that the entity could refer to, along with a score indicating the\n likelihood of the match.

" + } + }, + "Traits": { + "target": "com.amazonaws.comprehendmedical#RxNormTraitList", + "traits": { + "smithy.api#documentation": "

Contextual information for the entity.

" } }, "Category": { @@ -2139,16 +2151,10 @@ "smithy.api#documentation": "

The numeric identifier for the entity. This is a monotonically increasing id unique within\n this response rather than a global unique identifier.

" } }, - "BeginOffset": { + "EndOffset": { "target": "com.amazonaws.comprehendmedical#Integer", "traits": { - "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity begins. The\n offset returns the UTF-8 code point in the string.

" - } - }, - "Attributes": { - "target": "com.amazonaws.comprehendmedical#RxNormAttributeList", - "traits": { - "smithy.api#documentation": "

The extracted attributes that relate to the entity. The attributes recognized by\n InferRxNorm are DOSAGE, DURATION, FORM,\n FREQUENCY, RATE, ROUTE_OR_MODE, and\n STRENGTH.

" + "smithy.api#documentation": "

The 0-based character offset in the input text that shows where the entity ends. The\n offset returns the UTF-8 code point in the string.

" } }, "Text": { @@ -2157,16 +2163,16 @@ "smithy.api#documentation": "

The segment of input text extracted from which the entity was detected.

" } }, - "RxNormConcepts": { - "target": "com.amazonaws.comprehendmedical#RxNormConceptList", + "Attributes": { + "target": "com.amazonaws.comprehendmedical#RxNormAttributeList", "traits": { - "smithy.api#documentation": "

The RxNorm concepts that the entity could refer to, along with a score indicating the\n likelihood of the match.

" + "smithy.api#documentation": "

The extracted attributes that relate to the entity. The attributes recognized by\n InferRxNorm are DOSAGE, DURATION, FORM,\n FREQUENCY, RATE, ROUTE_OR_MODE, and\n STRENGTH.

" } }, - "Traits": { - "target": "com.amazonaws.comprehendmedical#RxNormTraitList", + "Type": { + "target": "com.amazonaws.comprehendmedical#RxNormEntityType", "traits": { - "smithy.api#documentation": "

Contextual information for the entity.

" + "smithy.api#documentation": "

Describes the specific type of entity. For InferRxNorm, the recognized entity type is\n MEDICATION.

" } }, "Score": { @@ -2174,12 +2180,6 @@ "traits": { "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected\n entity.

" } - }, - "Type": { - "target": "com.amazonaws.comprehendmedical#RxNormEntityType", - "traits": { - "smithy.api#documentation": "

Describes the specific type of entity. For InferRxNorm, the recognized entity type is\n MEDICATION.

" - } } }, "traits": { @@ -2323,6 +2323,26 @@ "smithy.api#documentation": "

The identifier of the job.

" } }, + "KMSKey": { + "target": "com.amazonaws.comprehendmedical#KMSKey", + "traits": { + "smithy.api#documentation": "

An AWS Key Management Service key to encrypt your output files. If you do not specify a\n key, the files are written in plain text.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehendmedical#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.comprehendmedical#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, "LanguageCode": { "target": "com.amazonaws.comprehendmedical#LanguageCode", "traits": { @@ -2337,32 +2357,12 @@ "smithy.api#idempotencyToken": {} } }, - "KMSKey": { - "target": "com.amazonaws.comprehendmedical#KMSKey", - "traits": { - "smithy.api#documentation": "

An AWS Key Management Service key to encrypt your output files. If you do not specify a\n key, the files are written in plain text.

" - } - }, "OutputDataConfig": { "target": "com.amazonaws.comprehendmedical#OutputDataConfig", "traits": { "smithy.api#documentation": "

Specifies where to send the output files.

", "smithy.api#required": {} } - }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehendmedical#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", - "smithy.api#required": {} - } - }, - "InputDataConfig": { - "target": "com.amazonaws.comprehendmedical#InputDataConfig", - "traits": { - "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", - "smithy.api#required": {} - } } } }, @@ -2406,19 +2406,6 @@ "com.amazonaws.comprehendmedical#StartICD10CMInferenceJobRequest": { "type": "structure", "members": { - "OutputDataConfig": { - "target": "com.amazonaws.comprehendmedical#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

Specifies where to send the output files.

", - "smithy.api#required": {} - } - }, - "JobName": { - "target": "com.amazonaws.comprehendmedical#JobName", - "traits": { - "smithy.api#documentation": "

The identifier of the job.

" - } - }, "LanguageCode": { "target": "com.amazonaws.comprehendmedical#LanguageCode", "traits": { @@ -2433,25 +2420,38 @@ "smithy.api#idempotencyToken": {} } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.comprehendmedical#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", - "smithy.api#required": {} - } - }, "KMSKey": { "target": "com.amazonaws.comprehendmedical#KMSKey", "traits": { "smithy.api#documentation": "

An AWS Key Management Service key to encrypt your output files. If you do not specify a\n key, the files are written in plain text.

" } }, + "JobName": { + "target": "com.amazonaws.comprehendmedical#JobName", + "traits": { + "smithy.api#documentation": "

The identifier of the job.

" + } + }, "InputDataConfig": { "target": "com.amazonaws.comprehendmedical#InputDataConfig", "traits": { "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", "smithy.api#required": {} } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehendmedical#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehendmedical#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} + } } } }, @@ -2495,6 +2495,13 @@ "com.amazonaws.comprehendmedical#StartPHIDetectionJobRequest": { "type": "structure", "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehendmedical#InputDataConfig", + "traits": { + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#required": {} + } + }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehendmedical#IamRoleArn", "traits": { @@ -2502,11 +2509,10 @@ "smithy.api#required": {} } }, - "LanguageCode": { - "target": "com.amazonaws.comprehendmedical#LanguageCode", + "JobName": { + "target": "com.amazonaws.comprehendmedical#JobName", "traits": { - "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The identifier of the job.

" } }, "ClientRequestToken": { @@ -2516,10 +2522,10 @@ "smithy.api#idempotencyToken": {} } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehendmedical#InputDataConfig", + "LanguageCode": { + "target": "com.amazonaws.comprehendmedical#LanguageCode", "traits": { - "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", + "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language.

", "smithy.api#required": {} } }, @@ -2530,12 +2536,6 @@ "smithy.api#required": {} } }, - "JobName": { - "target": "com.amazonaws.comprehendmedical#JobName", - "traits": { - "smithy.api#documentation": "

The identifier of the job.

" - } - }, "KMSKey": { "target": "com.amazonaws.comprehendmedical#KMSKey", "traits": { @@ -2584,24 +2584,25 @@ "com.amazonaws.comprehendmedical#StartRxNormInferenceJobRequest": { "type": "structure", "members": { - "OutputDataConfig": { - "target": "com.amazonaws.comprehendmedical#OutputDataConfig", + "LanguageCode": { + "target": "com.amazonaws.comprehendmedical#LanguageCode", "traits": { - "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language.

", "smithy.api#required": {} } }, - "InputDataConfig": { - "target": "com.amazonaws.comprehendmedical#InputDataConfig", + "ClientRequestToken": { + "target": "com.amazonaws.comprehendmedical#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical\n generates one.

", + "smithy.api#idempotencyToken": {} } }, - "KMSKey": { - "target": "com.amazonaws.comprehendmedical#KMSKey", + "OutputDataConfig": { + "target": "com.amazonaws.comprehendmedical#OutputDataConfig", "traits": { - "smithy.api#documentation": "

An AWS Key Management Service key to encrypt your output files. If you do not specify a\n key, the files are written in plain text.

" + "smithy.api#documentation": "

Specifies where to send the output files.

", + "smithy.api#required": {} } }, "DataAccessRoleArn": { @@ -2611,18 +2612,17 @@ "smithy.api#required": {} } }, - "LanguageCode": { - "target": "com.amazonaws.comprehendmedical#LanguageCode", + "InputDataConfig": { + "target": "com.amazonaws.comprehendmedical#InputDataConfig", "traits": { - "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language.

", + "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

", "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.comprehendmedical#ClientRequestTokenString", + "KMSKey": { + "target": "com.amazonaws.comprehendmedical#KMSKey", "traits": { - "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical\n generates one.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

An AWS Key Management Service key to encrypt your output files. If you do not specify a\n key, the files are written in plain text.

" } }, "JobName": { @@ -2894,17 +2894,17 @@ "com.amazonaws.comprehendmedical#UnmappedAttribute": { "type": "structure", "members": { - "Attribute": { - "target": "com.amazonaws.comprehendmedical#Attribute", - "traits": { - "smithy.api#documentation": "

The specific attribute that has been extracted but not mapped to an entity.

" - } - }, "Type": { "target": "com.amazonaws.comprehendmedical#EntityType", "traits": { "smithy.api#documentation": "

The type of the attribute, could be one of the following values: \"MEDICATION\",\n \"MEDICAL_CONDITION\", \"ANATOMY\", \"TEST_AND_TREATMENT_PROCEDURE\" or\n \"PROTECTED_HEALTH_INFORMATION\".

" } + }, + "Attribute": { + "target": "com.amazonaws.comprehendmedical#Attribute", + "traits": { + "smithy.api#documentation": "

The specific attribute that has been extracted but not mapped to an entity.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/compute-optimizer.2019-11-01.json b/codegen/sdk-codegen/aws-models/compute-optimizer.2019-11-01.json index 6faf4c4b244d..13bf0edab09e 100644 --- a/codegen/sdk-codegen/aws-models/compute-optimizer.2019-11-01.json +++ b/codegen/sdk-codegen/aws-models/compute-optimizer.2019-11-01.json @@ -63,18 +63,18 @@ "com.amazonaws.computeoptimizer#AutoScalingGroupConfiguration": { "type": "structure", "members": { - "maxSize": { - "target": "com.amazonaws.computeoptimizer#MaxSize", - "traits": { - "smithy.api#documentation": "

The maximum size, or maximum number of instances, for the Auto Scaling group.

" - } - }, "instanceType": { "target": "com.amazonaws.computeoptimizer#InstanceType", "traits": { "smithy.api#documentation": "

The instance type for the Auto Scaling group.

" } }, + "maxSize": { + "target": "com.amazonaws.computeoptimizer#MaxSize", + "traits": { + "smithy.api#documentation": "

The maximum size, or maximum number of instances, for the Auto Scaling group.

" + } + }, "desiredCapacity": { "target": "com.amazonaws.computeoptimizer#DesiredCapacity", "traits": { @@ -98,22 +98,10 @@ "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendation": { "type": "structure", "members": { - "lookBackPeriodInDays": { - "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", - "traits": { - "smithy.api#documentation": "

The number of days for which utilization metrics were analyzed for the Auto Scaling\n group.

" - } - }, - "accountId": { - "target": "com.amazonaws.computeoptimizer#AccountId", - "traits": { - "smithy.api#documentation": "

The AWS account ID of the Auto Scaling group.

" - } - }, - "utilizationMetrics": { - "target": "com.amazonaws.computeoptimizer#UtilizationMetrics", + "finding": { + "target": "com.amazonaws.computeoptimizer#Finding", "traits": { - "smithy.api#documentation": "

An array of objects that describe the utilization metrics of the Auto Scaling group.

" + "smithy.api#documentation": "

The finding classification for the Auto Scaling group.

\n

Findings for Auto Scaling groups include:

\n \n \n

The values that are returned might be NOT_OPTIMIZED or\n OPTIMIZED.

\n " } }, "autoScalingGroupName": { @@ -134,22 +122,34 @@ "smithy.api#documentation": "

An array of objects that describe the current configuration of the Auto Scaling group.

" } }, + "accountId": { + "target": "com.amazonaws.computeoptimizer#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID of the Auto Scaling group.

" + } + }, "autoScalingGroupArn": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling group.

" } }, - "lastRefreshTimestamp": { - "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", + "lookBackPeriodInDays": { + "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", "traits": { - "smithy.api#documentation": "

The time stamp of when the Auto Scaling group recommendation was last refreshed.

" + "smithy.api#documentation": "

The number of days for which utilization metrics were analyzed for the Auto Scaling\n group.

" } }, - "finding": { - "target": "com.amazonaws.computeoptimizer#Finding", + "utilizationMetrics": { + "target": "com.amazonaws.computeoptimizer#UtilizationMetrics", "traits": { - "smithy.api#documentation": "

The finding classification for the Auto Scaling group.

\n

Findings for Auto Scaling groups include:

\n \n \n

The values that are returned might be NOT_OPTIMIZED or\n OPTIMIZED.

\n " + "smithy.api#documentation": "

An array of objects that describe the utilization metrics of the Auto Scaling group.

" + } + }, + "lastRefreshTimestamp": { + "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of when the Auto Scaling group recommendation was last refreshed.

" } } }, @@ -163,13 +163,7 @@ "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { - "smithy.api#documentation": "

An array of objects that describe the projected utilization metrics of the Auto Scaling group\n recommendation option.

" - } - }, - "rank": { - "target": "com.amazonaws.computeoptimizer#Rank", - "traits": { - "smithy.api#documentation": "

The rank of the Auto Scaling group recommendation option.

\n

The top recommendation option is ranked as 1.

" + "smithy.api#documentation": "

An array of objects that describe the projected utilization metrics of the Auto Scaling group\n recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed on them. For\n more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

\n " } }, "configuration": { @@ -183,6 +177,12 @@ "traits": { "smithy.api#documentation": "

The performance risk of the Auto Scaling group configuration recommendation.

\n

Performance risk is the likelihood of the recommended instance type not meeting the\n performance requirement of your workload.

\n

The lowest performance risk is categorized as 0, and the highest as\n 5.

" } + }, + "rank": { + "target": "com.amazonaws.computeoptimizer#Rank", + "traits": { + "smithy.api#documentation": "

The rank of the Auto Scaling group recommendation option.

\n

The top recommendation option is ranked as 1.

" + } } }, "traits": { @@ -298,28 +298,28 @@ "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.computeoptimizer#NextToken", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of export jobs.

" - } - }, "filters": { "target": "com.amazonaws.computeoptimizer#JobFilters", "traits": { "smithy.api#documentation": "

An array of objects that describe a filter to return a more specific list of export\n jobs.

" } }, + "maxResults": { + "target": "com.amazonaws.computeoptimizer#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of export jobs to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + } + }, "jobIds": { "target": "com.amazonaws.computeoptimizer#JobIds", "traits": { "smithy.api#documentation": "

The identification numbers of the export jobs to return.

\n\n

An export job ID is returned when you create an export using the\n ExportAutoScalingGroupRecommendations or\n ExportEC2InstanceRecommendations actions.

\n\n

All export jobs created in the last seven days are returned if this parameter is\n omitted.

" } }, - "maxResults": { - "target": "com.amazonaws.computeoptimizer#MaxResults", + "nextToken": { + "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of export jobs to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The token to advance to the next page of export jobs.

" } } } @@ -397,12 +397,6 @@ "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendationsRequest": { "type": "structure", "members": { - "includeMemberAccounts": { - "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", - "traits": { - "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the master account of an organization.

\n

The member accounts must also be opted in to Compute Optimizer.

\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" - } - }, "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { @@ -410,16 +404,28 @@ "smithy.api#required": {} } }, + "includeMemberAccounts": { + "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", + "traits": { + "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the master account of an organization.

\n

The member accounts must also be opted in to Compute Optimizer.

\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + } + }, "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { "smithy.api#documentation": "

The format of the export file.

\n

The only export file format currently supported is Csv.

" } }, + "filters": { + "target": "com.amazonaws.computeoptimizer#Filters", + "traits": { + "smithy.api#documentation": "

An array of objects that describe a filter to export a more specific set of Auto Scaling group\n recommendations.

" + } + }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableAutoScalingGroupFields", "traits": { - "smithy.api#documentation": "

The recommendations data to include in the export file.

" + "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.

" } }, "accountIds": { @@ -427,12 +433,6 @@ "traits": { "smithy.api#documentation": "

The IDs of the AWS accounts for which to export Auto Scaling group recommendations.

\n

If your account is the master account of an organization, use this parameter to\n specify the member accounts for which you want to export recommendations.

\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n

You can specify multiple account IDs per request.

" } - }, - "filters": { - "target": "com.amazonaws.computeoptimizer#Filters", - "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter to export a more specific set of Auto Scaling group\n recommendations.

" - } } } }, @@ -508,10 +508,17 @@ "com.amazonaws.computeoptimizer#ExportEC2InstanceRecommendationsRequest": { "type": "structure", "members": { - "accountIds": { - "target": "com.amazonaws.computeoptimizer#AccountIds", + "s3DestinationConfig": { + "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts for which to export instance recommendations.

\n

If your account is the master account of an organization, use this parameter to\n specify the member accounts for which you want to export recommendations.

\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n

You can specify multiple account IDs per request.

" + "smithy.api#documentation": "

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for\n the export job.

\n

You must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.

", + "smithy.api#required": {} + } + }, + "includeMemberAccounts": { + "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", + "traits": { + "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the master account of an organization.

\n

The member accounts must also be opted in to Compute Optimizer.

\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" } }, "fileFormat": { @@ -523,13 +530,13 @@ "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableInstanceFields", "traits": { - "smithy.api#documentation": "

The recommendations data to include in the export file.

" + "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.

" } }, - "includeMemberAccounts": { - "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", + "accountIds": { + "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the master account of an organization.

\n

The member accounts must also be opted in to Compute Optimizer.

\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + "smithy.api#documentation": "

The IDs of the AWS accounts for which to export instance recommendations.

\n

If your account is the master account of an organization, use this parameter to\n specify the member accounts for which you want to export recommendations.

\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n

You can specify multiple account IDs per request.

" } }, "filters": { @@ -537,30 +544,23 @@ "traits": { "smithy.api#documentation": "

An array of objects that describe a filter to export a more specific set of instance\n recommendations.

" } - }, - "s3DestinationConfig": { - "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", - "traits": { - "smithy.api#documentation": "

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for\n the export job.

\n

You must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.computeoptimizer#ExportEC2InstanceRecommendationsResponse": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.computeoptimizer#JobId", - "traits": { - "smithy.api#documentation": "

The identification number of the export job.

\n

Use the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.

" - } - }, "s3Destination": { "target": "com.amazonaws.computeoptimizer#S3Destination", "traits": { "smithy.api#documentation": "

An object that describes the destination Amazon S3 bucket of a recommendations export\n file.

" } + }, + "jobId": { + "target": "com.amazonaws.computeoptimizer#JobId", + "traits": { + "smithy.api#documentation": "

The identification number of the export job.

\n

Use the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.

" + } } } }, @@ -592,6 +592,22 @@ "value": "UtilizationMetricsMemoryMaximum", "name": "UTILIZATION_METRICS_MEMORY_MAXIMUM" }, + { + "value": "UtilizationMetricsEbsReadOpsPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_READ_OPS_PER_SECOND_MAXIMUM" + }, + { + "value": "UtilizationMetricsEbsWriteOpsPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_WRITE_OPS_PER_SECOND_MAXIMUM" + }, + { + "value": "UtilizationMetricsEbsReadBytesPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_READ_BYTES_PER_SECOND_MAXIMUM" + }, + { + "value": "UtilizationMetricsEbsWriteBytesPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_WRITE_BYTES_PER_SECOND_MAXIMUM" + }, { "value": "LookbackPeriodInDays", "name": "LOOKBACK_PERIOD_IN_DAYS" @@ -745,6 +761,22 @@ "value": "UtilizationMetricsMemoryMaximum", "name": "UTILIZATION_METRICS_MEMORY_MAXIMUM" }, + { + "value": "UtilizationMetricsEbsReadOpsPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_READ_OPS_PER_SECOND_MAXIMUM" + }, + { + "value": "UtilizationMetricsEbsWriteOpsPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_WRITE_OPS_PER_SECOND_MAXIMUM" + }, + { + "value": "UtilizationMetricsEbsReadBytesPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_READ_BYTES_PER_SECOND_MAXIMUM" + }, + { + "value": "UtilizationMetricsEbsWriteBytesPerSecondMaximum", + "name": "UTILIZATION_METRICS_EBS_WRITE_BYTES_PER_SECOND_MAXIMUM" + }, { "value": "CurrentOnDemandPrice", "name": "CURRENT_ON_DEMAND_PRICE" @@ -855,17 +887,17 @@ "com.amazonaws.computeoptimizer#Filter": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.computeoptimizer#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the filter.

\n

Specify Finding to return recommendations with a specific findings\n classification (e.g., Overprovisioned).

\n

Specify RecommendationSourceType to return recommendations of a specific\n resource type (e.g., AutoScalingGroup).

" - } - }, "values": { "target": "com.amazonaws.computeoptimizer#FilterValues", "traits": { "smithy.api#documentation": "

The value of the filter.

\n

If you specify the name parameter as Finding, and you\n request recommendations for an instance, then the valid values are\n Underprovisioned, Overprovisioned,\n NotOptimized, or Optimized.

\n

If you specify the name parameter as Finding, and you\n request recommendations for an Auto Scaling group, then the valid values\n are Optimized, or NotOptimized.

\n

If you specify the name parameter as\n RecommendationSourceType, then the valid values are\n Ec2Instance, or AutoScalingGroup.

" } + }, + "name": { + "target": "com.amazonaws.computeoptimizer#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter.

\n

Specify Finding to return recommendations with a specific findings\n classification (e.g., Overprovisioned).

\n

Specify RecommendationSourceType to return recommendations of a specific\n resource type (e.g., AutoScalingGroup).

" + } } }, "traits": { @@ -960,16 +992,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns Auto Scaling group recommendations.

\n

AWS Compute Optimizer currently generates recommendations for Auto Scaling groups that are configured to\n run instances of the M, C, R, T, and X instance families. The service does not generate\n recommendations for Auto Scaling groups that have a scaling policy attached to them, or that do\n not have the same values for desired, minimum, and maximum capacity. In order for Compute Optimizer\n to analyze your Auto Scaling groups, they must be of a fixed size. For more information, see the\n AWS Compute Optimizer User Guide.

" + "smithy.api#documentation": "

Returns Auto Scaling group recommendations.

\n\n

AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of\n requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.

" } }, "com.amazonaws.computeoptimizer#GetAutoScalingGroupRecommendationsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.computeoptimizer#MaxResults", + "accountIds": { + "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The maximum number of Auto Scaling group recommendations to return with a single\n request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The IDs of the AWS accounts for which to return Auto Scaling group recommendations.

\n

If your account is the master account of an organization, use this parameter to\n specify the member accounts for which you want to return Auto Scaling group\n recommendations.

\n

Only one account ID can be specified per request.

" } }, "filters": { @@ -978,6 +1010,12 @@ "smithy.api#documentation": "

An array of objects that describe a filter that returns a more specific list of Auto Scaling\n group recommendations.

" } }, + "maxResults": { + "target": "com.amazonaws.computeoptimizer#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of Auto Scaling group recommendations to return with a single\n request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + } + }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { @@ -989,12 +1027,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return\n recommendations.

" } - }, - "accountIds": { - "target": "com.amazonaws.computeoptimizer#AccountIds", - "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts for which to return Auto Scaling group recommendations.

\n

If your account is the master account of an organization, use this parameter to\n specify the member accounts for which you want to return Auto Scaling group\n recommendations.

\n

Only one account ID can be specified per request.

" - } } } }, @@ -1056,7 +1088,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns Amazon EC2 instance recommendations.

\n

AWS Compute Optimizer currently generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) and Amazon EC2 Auto Scaling. It\n generates recommendations for M, C, R, T, and X instance families. For more information,\n see the AWS Compute Optimizer\n User Guide.

" + "smithy.api#documentation": "

Returns Amazon EC2 instance recommendations.

\n\n

AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a\n specific set of requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.

" } }, "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendationsRequest": { @@ -1068,22 +1100,16 @@ "smithy.api#documentation": "

The token to advance to the next page of instance recommendations.

" } }, - "maxResults": { - "target": "com.amazonaws.computeoptimizer#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of instance recommendations to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" - } - }, "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "

The IDs of the AWS accounts for which to return instance recommendations.

\n

If your account is the master account of an organization, use this parameter to\n specify the member accounts for which you want to return instance\n recommendations.

\n

Only one account ID can be specified per request.

" } }, - "instanceArns": { - "target": "com.amazonaws.computeoptimizer#InstanceArns", + "maxResults": { + "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instances for which to return\n recommendations.

" + "smithy.api#documentation": "

The maximum number of instance recommendations to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" } }, "filters": { @@ -1091,6 +1117,12 @@ "traits": { "smithy.api#documentation": "

An array of objects that describe a filter that returns a more specific list of\n instance recommendations.

" } + }, + "instanceArns": { + "target": "com.amazonaws.computeoptimizer#InstanceArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instances for which to return\n recommendations.

" + } } } }, @@ -1103,17 +1135,17 @@ "smithy.api#documentation": "

An array of objects that describe instance recommendations.

" } }, - "errors": { - "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", - "traits": { - "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n

For example, an error is returned if you request recommendations for an instance of an\n unsupported instance family.

" - } - }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "

The token to use to advance to the next page of instance recommendations.

\n

This value is null when there are no more pages of instance recommendations to\n return.

" } + }, + "errors": { + "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", + "traits": { + "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n

For example, an error is returned if you request recommendations for an instance of an\n unsupported instance family.

" + } } } }, @@ -1152,16 +1184,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

" + "smithy.api#documentation": "

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run this action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

\n " } }, "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetricsRequest": { "type": "structure", "members": { - "endTime": { - "target": "com.amazonaws.computeoptimizer#Timestamp", + "period": { + "target": "com.amazonaws.computeoptimizer#Period", "traits": { - "smithy.api#documentation": "

The time stamp of the last projected metrics data point to return.

", + "smithy.api#documentation": "

The granularity, in seconds, of the projected metrics data points.

", "smithy.api#required": {} } }, @@ -1172,17 +1204,17 @@ "smithy.api#required": {} } }, - "period": { - "target": "com.amazonaws.computeoptimizer#Period", + "stat": { + "target": "com.amazonaws.computeoptimizer#MetricStatistic", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the projected metrics data points.

", + "smithy.api#documentation": "

The statistic of the projected metrics.

", "smithy.api#required": {} } }, - "stat": { - "target": "com.amazonaws.computeoptimizer#MetricStatistic", + "endTime": { + "target": "com.amazonaws.computeoptimizer#Timestamp", "traits": { - "smithy.api#documentation": "

The statistic of the projected metrics.

", + "smithy.api#documentation": "

The time stamp of the last projected metrics data point to return.

", "smithy.api#required": {} } }, @@ -1245,18 +1277,18 @@ "com.amazonaws.computeoptimizer#GetEnrollmentStatusResponse": { "type": "structure", "members": { - "statusReason": { - "target": "com.amazonaws.computeoptimizer#StatusReason", - "traits": { - "smithy.api#documentation": "

The reason for the enrollment status of the account.

\n

For example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.

" - } - }, "memberAccountsEnrolled": { "target": "com.amazonaws.computeoptimizer#MemberAccountsEnrolled", "traits": { "smithy.api#documentation": "

Confirms the enrollment status of member accounts within the organization, if the\n account is a master account of an organization.

" } }, + "statusReason": { + "target": "com.amazonaws.computeoptimizer#StatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the enrollment status of the account.

\n

For example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.

" + } + }, "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { @@ -1268,18 +1300,18 @@ "com.amazonaws.computeoptimizer#GetRecommendationError": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.computeoptimizer#Message", - "traits": { - "smithy.api#documentation": "

The message, or reason, for the error.

" - } - }, "code": { "target": "com.amazonaws.computeoptimizer#Code", "traits": { "smithy.api#documentation": "

The error code.

" } }, + "message": { + "target": "com.amazonaws.computeoptimizer#Message", + "traits": { + "smithy.api#documentation": "

The message, or reason, for the error.

" + } + }, "identifier": { "target": "com.amazonaws.computeoptimizer#Identifier", "traits": { @@ -1335,18 +1367,18 @@ "com.amazonaws.computeoptimizer#GetRecommendationSummariesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.computeoptimizer#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of recommendation summaries to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" - } - }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "

The token to advance to the next page of recommendation summaries.

" } }, + "maxResults": { + "target": "com.amazonaws.computeoptimizer#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of recommendation summaries to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + } + }, "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { @@ -1358,17 +1390,17 @@ "com.amazonaws.computeoptimizer#GetRecommendationSummariesResponse": { "type": "structure", "members": { - "recommendationSummaries": { - "target": "com.amazonaws.computeoptimizer#RecommendationSummaries", - "traits": { - "smithy.api#documentation": "

An array of objects that summarize a recommendation.

" - } - }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "

The token to use to advance to the next page of recommendation summaries.

\n

This value is null when there are no more pages of recommendation summaries to\n return.

" } + }, + "recommendationSummaries": { + "target": "com.amazonaws.computeoptimizer#RecommendationSummaries", + "traits": { + "smithy.api#documentation": "

An array of objects that summarize a recommendation.

" + } } } }, @@ -1393,52 +1425,52 @@ "com.amazonaws.computeoptimizer#InstanceRecommendation": { "type": "structure", "members": { - "lastRefreshTimestamp": { - "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", + "instanceName": { + "target": "com.amazonaws.computeoptimizer#InstanceName", "traits": { - "smithy.api#documentation": "

The time stamp of when the instance recommendation was last refreshed.

" + "smithy.api#documentation": "

The name of the current instance.

" } }, - "finding": { - "target": "com.amazonaws.computeoptimizer#Finding", + "currentInstanceType": { + "target": "com.amazonaws.computeoptimizer#CurrentInstanceType", "traits": { - "smithy.api#documentation": "

The finding classification for the instance.

\n

Findings for instances include:

\n \n \n

The values that are returned might be UNDER_PROVISIONED,\n OVER_PROVISIONED, or OPTIMIZED.

\n " + "smithy.api#documentation": "

The instance type of the current instance.

" } }, - "recommendationOptions": { - "target": "com.amazonaws.computeoptimizer#RecommendationOptions", + "utilizationMetrics": { + "target": "com.amazonaws.computeoptimizer#UtilizationMetrics", "traits": { - "smithy.api#documentation": "

An array of objects that describe the recommendation options for the instance.

" + "smithy.api#documentation": "

An array of objects that describe the utilization metrics of the instance.

" } }, - "recommendationSources": { - "target": "com.amazonaws.computeoptimizer#RecommendationSources", + "accountId": { + "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { - "smithy.api#documentation": "

An array of objects that describe the source resource of the recommendation.

" + "smithy.api#documentation": "

The AWS account ID of the instance.

" } }, - "utilizationMetrics": { - "target": "com.amazonaws.computeoptimizer#UtilizationMetrics", + "recommendationOptions": { + "target": "com.amazonaws.computeoptimizer#RecommendationOptions", "traits": { - "smithy.api#documentation": "

An array of objects that describe the utilization metrics of the instance.

" + "smithy.api#documentation": "

An array of objects that describe the recommendation options for the instance.

" } }, - "instanceName": { - "target": "com.amazonaws.computeoptimizer#InstanceName", + "finding": { + "target": "com.amazonaws.computeoptimizer#Finding", "traits": { - "smithy.api#documentation": "

The name of the current instance.

" + "smithy.api#documentation": "

The finding classification for the instance.

\n

Findings for instances include:

\n \n \n

The values that are returned might be UNDER_PROVISIONED,\n OVER_PROVISIONED, or OPTIMIZED.

\n " } }, - "currentInstanceType": { - "target": "com.amazonaws.computeoptimizer#CurrentInstanceType", + "instanceArn": { + "target": "com.amazonaws.computeoptimizer#InstanceArn", "traits": { - "smithy.api#documentation": "

The instance type of the current instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the current instance.

" } }, - "accountId": { - "target": "com.amazonaws.computeoptimizer#AccountId", + "lastRefreshTimestamp": { + "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { - "smithy.api#documentation": "

The AWS account ID of the instance.

" + "smithy.api#documentation": "

The time stamp of when the instance recommendation was last refreshed.

" } }, "lookBackPeriodInDays": { @@ -1447,10 +1479,10 @@ "smithy.api#documentation": "

The number of days for which utilization metrics were analyzed for the\n instance.

" } }, - "instanceArn": { - "target": "com.amazonaws.computeoptimizer#InstanceArn", + "recommendationSources": { + "target": "com.amazonaws.computeoptimizer#RecommendationSources", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the current instance.

" + "smithy.api#documentation": "

An array of objects that describe the source resource of the recommendation.

" } } }, @@ -1461,10 +1493,10 @@ "com.amazonaws.computeoptimizer#InstanceRecommendationOption": { "type": "structure", "members": { - "rank": { - "target": "com.amazonaws.computeoptimizer#Rank", + "projectedUtilizationMetrics": { + "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { - "smithy.api#documentation": "

The rank of the instance recommendation option.

\n

The top recommendation option is ranked as 1.

" + "smithy.api#documentation": "

An array of objects that describe the projected utilization metrics of the instance\n recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed on them. For\n more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

\n " } }, "instanceType": { @@ -1473,10 +1505,10 @@ "smithy.api#documentation": "

The instance type of the instance recommendation.

" } }, - "projectedUtilizationMetrics": { - "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", + "rank": { + "target": "com.amazonaws.computeoptimizer#Rank", "traits": { - "smithy.api#documentation": "

An array of objects that describe the projected utilization metrics of the instance\n recommendation option.

" + "smithy.api#documentation": "

The rank of the instance recommendation option.

\n

The top recommendation option is ranked as 1.

" } }, "performanceRisk": { @@ -1528,17 +1560,17 @@ "com.amazonaws.computeoptimizer#JobFilter": { "type": "structure", "members": { - "values": { - "target": "com.amazonaws.computeoptimizer#FilterValues", - "traits": { - "smithy.api#documentation": "

The value of the filter.

\n

If you specify the name parameter as ResourceType, the valid\n values are Ec2Instance or AutoScalingGroup.

\n

If you specify the name parameter as JobStatus, the valid\n values are Queued, InProgress, Complete, or\n Failed.

" - } - }, "name": { "target": "com.amazonaws.computeoptimizer#JobFilterName", "traits": { "smithy.api#documentation": "

The name of the filter.

\n

Specify ResourceType to return export jobs of a specific resource type\n (e.g., Ec2Instance).

\n

Specify JobStatus to return export jobs with a specific status (e.g,\n Complete).

" } + }, + "values": { + "target": "com.amazonaws.computeoptimizer#FilterValues", + "traits": { + "smithy.api#documentation": "

The value of the filter.

\n

If you specify the name parameter as ResourceType, the valid\n values are Ec2Instance or AutoScalingGroup.

\n

If you specify the name parameter as JobStatus, the valid\n values are Queued, InProgress, Complete, or\n Failed.

" + } } }, "traits": { @@ -1649,6 +1681,22 @@ { "value": "Memory", "name": "MEMORY" + }, + { + "value": "EBS_READ_OPS_PER_SECOND", + "name": "EBS_READ_OPS_PER_SECOND" + }, + { + "value": "EBS_WRITE_OPS_PER_SECOND", + "name": "EBS_WRITE_OPS_PER_SECOND" + }, + { + "value": "EBS_READ_BYTES_PER_SECOND", + "name": "EBS_READ_BYTES_PER_SECOND" + }, + { + "value": "EBS_WRITE_BYTES_PER_SECOND", + "name": "EBS_WRITE_BYTES_PER_SECOND" } ] } @@ -1724,16 +1772,10 @@ "com.amazonaws.computeoptimizer#ProjectedMetric": { "type": "structure", "members": { - "timestamps": { - "target": "com.amazonaws.computeoptimizer#Timestamps", - "traits": { - "smithy.api#documentation": "

The time stamps of the projected utilization metric.

" - } - }, "name": { "target": "com.amazonaws.computeoptimizer#MetricName", "traits": { - "smithy.api#documentation": "

The name of the projected utilization metric.

\n \n

Memory metrics are only returned for resources that have the unified CloudWatch agent\n installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

\n " + "smithy.api#documentation": "

The name of the projected utilization metric.

" } }, "values": { @@ -1741,10 +1783,16 @@ "traits": { "smithy.api#documentation": "

The values of the projected utilization metrics.

" } + }, + "timestamps": { + "target": "com.amazonaws.computeoptimizer#Timestamps", + "traits": { + "smithy.api#documentation": "

The time stamps of the projected utilization metric.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes a projected utilization metric of a recommendation option, such as an Amazon EC2\n instance.

" + "smithy.api#documentation": "

Describes a projected utilization metric of a recommendation option, such as an Amazon EC2\n instance.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the\n GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

\n " } }, "com.amazonaws.computeoptimizer#ProjectedMetrics": { @@ -1765,28 +1813,22 @@ "com.amazonaws.computeoptimizer#RecommendationExportJob": { "type": "structure", "members": { - "failureReason": { - "target": "com.amazonaws.computeoptimizer#FailureReason", - "traits": { - "smithy.api#documentation": "

The reason for an export job failure.

" - } - }, - "status": { - "target": "com.amazonaws.computeoptimizer#JobStatus", + "destination": { + "target": "com.amazonaws.computeoptimizer#ExportDestination", "traits": { - "smithy.api#documentation": "

The status of the export job.

" + "smithy.api#documentation": "

An object that describes the destination of the export file.

" } }, - "lastUpdatedTimestamp": { - "target": "com.amazonaws.computeoptimizer#LastUpdatedTimestamp", + "creationTimestamp": { + "target": "com.amazonaws.computeoptimizer#CreationTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp of when the export job was last updated.

" + "smithy.api#documentation": "

The timestamp of when the export job was created.

" } }, - "destination": { - "target": "com.amazonaws.computeoptimizer#ExportDestination", + "status": { + "target": "com.amazonaws.computeoptimizer#JobStatus", "traits": { - "smithy.api#documentation": "

An object that describes the destination of the export file.

" + "smithy.api#documentation": "

The status of the export job.

" } }, "resourceType": { @@ -1795,16 +1837,22 @@ "smithy.api#documentation": "

The resource type of the exported recommendations.

" } }, + "lastUpdatedTimestamp": { + "target": "com.amazonaws.computeoptimizer#LastUpdatedTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the export job was last updated.

" + } + }, "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { "smithy.api#documentation": "

The identification number of the export job.

" } }, - "creationTimestamp": { - "target": "com.amazonaws.computeoptimizer#CreationTimestamp", + "failureReason": { + "target": "com.amazonaws.computeoptimizer#FailureReason", "traits": { - "smithy.api#documentation": "

The timestamp of when the export job was created.

" + "smithy.api#documentation": "

The reason for an export job failure.

" } } }, @@ -1827,17 +1875,17 @@ "com.amazonaws.computeoptimizer#RecommendationSource": { "type": "structure", "members": { - "recommendationSourceArn": { - "target": "com.amazonaws.computeoptimizer#RecommendationSourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation source.

" - } - }, "recommendationSourceType": { "target": "com.amazonaws.computeoptimizer#RecommendationSourceType", "traits": { "smithy.api#documentation": "

The resource type of the recommendation source.

" } + }, + "recommendationSourceArn": { + "target": "com.amazonaws.computeoptimizer#RecommendationSourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation source.

" + } } }, "traits": { @@ -1877,10 +1925,10 @@ "com.amazonaws.computeoptimizer#RecommendationSummary": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.computeoptimizer#AccountId", + "recommendationResourceType": { + "target": "com.amazonaws.computeoptimizer#RecommendationSourceType", "traits": { - "smithy.api#documentation": "

The AWS account ID of the recommendation summary.

" + "smithy.api#documentation": "

The resource type of the recommendation.

" } }, "summaries": { @@ -1889,10 +1937,10 @@ "smithy.api#documentation": "

An array of objects that describe a recommendation summary.

" } }, - "recommendationResourceType": { - "target": "com.amazonaws.computeoptimizer#RecommendationSourceType", + "accountId": { + "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { - "smithy.api#documentation": "

The resource type of the recommendation.

" + "smithy.api#documentation": "

The AWS account ID of the recommendation summary.

" } } }, @@ -1912,21 +1960,21 @@ "smithy.api#documentation": "

The recommended instance type.

" } }, - "projectedMetrics": { - "target": "com.amazonaws.computeoptimizer#ProjectedMetrics", - "traits": { - "smithy.api#documentation": "

An array of objects that describe a projected utilization metric.

" - } - }, "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { "smithy.api#documentation": "

The rank of the recommendation option projected metric.

\n

The top recommendation option is ranked as 1.

\n

The projected metric rank correlates to the recommendation option rank. For example,\n the projected metric ranked as 1 is related to the recommendation option\n that is also ranked as 1 in the same response.

" } + }, + "projectedMetrics": { + "target": "com.amazonaws.computeoptimizer#ProjectedMetrics", + "traits": { + "smithy.api#documentation": "

An array of objects that describe a projected utilization metric.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes a projected utilization metric of a recommendation option.

" + "smithy.api#documentation": "

Describes a projected utilization metric of a recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the\n GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

\n " } }, "com.amazonaws.computeoptimizer#RecommendedOptionProjectedMetrics": { @@ -2057,17 +2105,17 @@ "com.amazonaws.computeoptimizer#Summary": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.computeoptimizer#SummaryValue", - "traits": { - "smithy.api#documentation": "

The value of the recommendation summary.

" - } - }, "name": { "target": "com.amazonaws.computeoptimizer#Finding", "traits": { "smithy.api#documentation": "

The finding classification of the recommendation.

" } + }, + "value": { + "target": "com.amazonaws.computeoptimizer#SummaryValue", + "traits": { + "smithy.api#documentation": "

The value of the recommendation summary.

" + } } }, "traits": { @@ -2137,51 +2185,51 @@ "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusRequest": { "type": "structure", "members": { + "includeMemberAccounts": { + "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", + "traits": { + "smithy.api#documentation": "

Indicates whether to enroll member accounts of the organization if the your account is\n the master account of an organization.

" + } + }, "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { "smithy.api#documentation": "

The new enrollment status of the account.

\n

Accepted options are Active or Inactive. You will get an\n error if Pending or Failed are specified.

", "smithy.api#required": {} } - }, - "includeMemberAccounts": { - "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", - "traits": { - "smithy.api#documentation": "

Indicates whether to enroll member accounts of the organization if the your account is\n the master account of an organization.

" - } } } }, "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusResponse": { "type": "structure", "members": { - "statusReason": { - "target": "com.amazonaws.computeoptimizer#StatusReason", - "traits": { - "smithy.api#documentation": "

The reason for the enrollment status of the account. For example, an account might\n show a status of Pending because member accounts of an organization require\n more time to be enrolled in the service.

" - } - }, "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { "smithy.api#documentation": "

The enrollment status of the account.

" } + }, + "statusReason": { + "target": "com.amazonaws.computeoptimizer#StatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the enrollment status of the account. For example, an account might\n show a status of Pending because member accounts of an organization require\n more time to be enrolled in the service.

" + } } } }, "com.amazonaws.computeoptimizer#UtilizationMetric": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.computeoptimizer#MetricValue", + "name": { + "target": "com.amazonaws.computeoptimizer#MetricName", "traits": { - "smithy.api#documentation": "

The value of the utilization metric.

" + "smithy.api#documentation": "

The name of the utilization metric.

\n \n

The Memory metric is returned only for resources that have the\n unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

\n " } }, - "name": { - "target": "com.amazonaws.computeoptimizer#MetricName", + "value": { + "target": "com.amazonaws.computeoptimizer#MetricValue", "traits": { - "smithy.api#documentation": "

The name of the utilization metric.

\n \n

Memory metrics are only returned for resources that have the unified CloudWatch agent\n installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

\n " + "smithy.api#documentation": "

The value of the utilization metric.

" } }, "statistic": { diff --git a/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json b/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json index 12381faf67f2..bffcd9f2af6f 100644 --- a/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json +++ b/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json @@ -91,6 +91,12 @@ "com.amazonaws.configservice#AggregateComplianceByConfigRule": { "type": "structure", "members": { + "AccountId": { + "target": "com.amazonaws.configservice#AccountId", + "traits": { + "smithy.api#documentation": "

The 12-digit account ID of the source account.

" + } + }, "Compliance": { "target": "com.amazonaws.configservice#Compliance", "traits": { @@ -103,12 +109,6 @@ "smithy.api#documentation": "

The source region from where the data is aggregated.

" } }, - "AccountId": { - "target": "com.amazonaws.configservice#AccountId", - "traits": { - "smithy.api#documentation": "

The 12-digit account ID of the source account.

" - } - }, "ConfigRuleName": { "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { @@ -155,10 +155,10 @@ "com.amazonaws.configservice#AggregateEvaluationResult": { "type": "structure", "members": { - "ComplianceType": { - "target": "com.amazonaws.configservice#ComplianceType", + "EvaluationResultIdentifier": { + "target": "com.amazonaws.configservice#EvaluationResultIdentifier", "traits": { - "smithy.api#documentation": "

The resource compliance status.

\n\t\t

For the AggregationEvaluationResult data type, AWS\n\t\t\tConfig supports only the COMPLIANT and\n\t\t\t\tNON_COMPLIANT. AWS Config does not support the\n\t\t\t\tNOT_APPLICABLE and INSUFFICIENT_DATA\n\t\t\tvalue.

" + "smithy.api#documentation": "

Uniquely identifies the evaluation result.

" } }, "Annotation": { @@ -167,22 +167,16 @@ "smithy.api#documentation": "

Supplementary information about how the agrregate evaluation\n\t\t\tdetermined the compliance.

" } }, - "AwsRegion": { - "target": "com.amazonaws.configservice#AwsRegion", - "traits": { - "smithy.api#documentation": "

The source region from where the data is aggregated.

" - } - }, "AccountId": { "target": "com.amazonaws.configservice#AccountId", "traits": { "smithy.api#documentation": "

The 12-digit account ID of the source account.

" } }, - "EvaluationResultIdentifier": { - "target": "com.amazonaws.configservice#EvaluationResultIdentifier", + "ResultRecordedTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

Uniquely identifies the evaluation result.

" + "smithy.api#documentation": "

The time when AWS Config recorded the aggregate evaluation\n\t\t\tresult.

" } }, "ConfigRuleInvokedTime": { @@ -191,10 +185,16 @@ "smithy.api#documentation": "

The time when the AWS Config rule evaluated the AWS\n\t\t\tresource.

" } }, - "ResultRecordedTime": { - "target": "com.amazonaws.configservice#Date", + "ComplianceType": { + "target": "com.amazonaws.configservice#ComplianceType", "traits": { - "smithy.api#documentation": "

The time when AWS Config recorded the aggregate evaluation\n\t\t\tresult.

" + "smithy.api#documentation": "

The resource compliance status.

\n\t\t

For the AggregationEvaluationResult data type, AWS\n\t\t\tConfig supports only the COMPLIANT and\n\t\t\t\tNON_COMPLIANT. AWS Config does not support the\n\t\t\t\tNOT_APPLICABLE and INSUFFICIENT_DATA\n\t\t\tvalue.

" + } + }, + "AwsRegion": { + "target": "com.amazonaws.configservice#AwsRegion", + "traits": { + "smithy.api#documentation": "

The source region from where the data is aggregated.

" } } }, @@ -211,17 +211,17 @@ "com.amazonaws.configservice#AggregateResourceIdentifier": { "type": "structure", "members": { - "SourceRegion": { - "target": "com.amazonaws.configservice#AwsRegion", + "ResourceType": { + "target": "com.amazonaws.configservice#ResourceType", "traits": { - "smithy.api#documentation": "

The source region where data is aggregated.

", + "smithy.api#documentation": "

The type of the AWS resource.

", "smithy.api#required": {} } }, - "SourceAccountId": { - "target": "com.amazonaws.configservice#AccountId", + "ResourceId": { + "target": "com.amazonaws.configservice#ResourceId", "traits": { - "smithy.api#documentation": "

The 12-digit account ID of the source account.

", + "smithy.api#documentation": "

The ID of the AWS resource.

", "smithy.api#required": {} } }, @@ -231,17 +231,17 @@ "smithy.api#documentation": "

The name of the AWS resource.

" } }, - "ResourceId": { - "target": "com.amazonaws.configservice#ResourceId", + "SourceRegion": { + "target": "com.amazonaws.configservice#AwsRegion", "traits": { - "smithy.api#documentation": "

The ID of the AWS resource.

", + "smithy.api#documentation": "

The source region where data is aggregated.

", "smithy.api#required": {} } }, - "ResourceType": { - "target": "com.amazonaws.configservice#ResourceType", + "SourceAccountId": { + "target": "com.amazonaws.configservice#AccountId", "traits": { - "smithy.api#documentation": "

The type of the AWS resource.

", + "smithy.api#documentation": "

The 12-digit account ID of the source account.

", "smithy.api#required": {} } } @@ -259,10 +259,16 @@ "smithy.api#documentation": "

The source account ID or an organization.

" } }, - "LastUpdateTime": { - "target": "com.amazonaws.configservice#Date", + "SourceType": { + "target": "com.amazonaws.configservice#AggregatedSourceType", "traits": { - "smithy.api#documentation": "

The time of the last update.

" + "smithy.api#documentation": "

The source account or an organization.

" + } + }, + "LastErrorMessage": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The message indicating that the source account aggregation\n\t\t\tfailed due to an error.

" } }, "LastUpdateStatus": { @@ -271,10 +277,10 @@ "smithy.api#documentation": "

Filters the last updated status type.

\n\t\t " } }, - "LastErrorMessage": { - "target": "com.amazonaws.configservice#String", + "AwsRegion": { + "target": "com.amazonaws.configservice#AwsRegion", "traits": { - "smithy.api#documentation": "

The message indicating that the source account aggregation\n\t\t\tfailed due to an error.

" + "smithy.api#documentation": "

The region authorized to collect aggregated data.

" } }, "LastErrorCode": { @@ -283,16 +289,10 @@ "smithy.api#documentation": "

The error code that AWS Config returned when the source account\n\t\t\taggregation last failed.

" } }, - "SourceType": { - "target": "com.amazonaws.configservice#AggregatedSourceType", - "traits": { - "smithy.api#documentation": "

The source account or an organization.

" - } - }, - "AwsRegion": { - "target": "com.amazonaws.configservice#AwsRegion", + "LastUpdateTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The region authorized to collect aggregated data.

" + "smithy.api#documentation": "

The time of the last update.

" } } }, @@ -360,12 +360,6 @@ "smithy.api#documentation": "

The time stamp when the aggregation authorization was\n\t\t\tcreated.

" } }, - "AuthorizedAccountId": { - "target": "com.amazonaws.configservice#AccountId", - "traits": { - "smithy.api#documentation": "

The 12-digit account ID of the account authorized to aggregate\n\t\t\tdata.

" - } - }, "AggregationAuthorizationArn": { "target": "com.amazonaws.configservice#String", "traits": { @@ -377,6 +371,12 @@ "traits": { "smithy.api#documentation": "

The region authorized to collect aggregated data.

" } + }, + "AuthorizedAccountId": { + "target": "com.amazonaws.configservice#AccountId", + "traits": { + "smithy.api#documentation": "

The 12-digit account ID of the account authorized to aggregate\n\t\t\tdata.

" + } } }, "traits": { @@ -456,88 +456,88 @@ "com.amazonaws.configservice#BaseConfigurationItem": { "type": "structure", "members": { - "configurationStateId": { - "target": "com.amazonaws.configservice#ConfigurationStateId", + "awsRegion": { + "target": "com.amazonaws.configservice#AwsRegion", "traits": { - "smithy.api#documentation": "

An identifier that indicates the ordering of the configuration\n\t\t\titems of a resource.

" + "smithy.api#documentation": "

The region where the resource resides.

" } }, - "accountId": { - "target": "com.amazonaws.configservice#AccountId", + "resourceId": { + "target": "com.amazonaws.configservice#ResourceId", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account ID associated with the resource.

" + "smithy.api#documentation": "

The ID of the resource (for example., sg-xxxxxx).

" } }, - "resourceType": { - "target": "com.amazonaws.configservice#ResourceType", + "availabilityZone": { + "target": "com.amazonaws.configservice#AvailabilityZone", "traits": { - "smithy.api#documentation": "

The type of AWS resource.

" + "smithy.api#documentation": "

The Availability Zone associated with the resource.

" } }, - "supplementaryConfiguration": { - "target": "com.amazonaws.configservice#SupplementaryConfiguration", + "configurationItemStatus": { + "target": "com.amazonaws.configservice#ConfigurationItemStatus", "traits": { - "smithy.api#documentation": "

Configuration attributes that AWS Config returns for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\tconfiguration parameter.

" + "smithy.api#documentation": "

The configuration item status. The valid values are:

\n\t\t\n\t\t \n\t\t \n

The CIs do not incur any cost.

\n " } }, - "resourceName": { - "target": "com.amazonaws.configservice#ResourceName", + "configuration": { + "target": "com.amazonaws.configservice#Configuration", "traits": { - "smithy.api#documentation": "

The custom name of the resource, if available.

" + "smithy.api#documentation": "

The description of the resource configuration.

" } }, - "version": { - "target": "com.amazonaws.configservice#Version", + "resourceCreationTime": { + "target": "com.amazonaws.configservice#ResourceCreationTime", "traits": { - "smithy.api#documentation": "

The version number of the resource configuration.

" + "smithy.api#documentation": "

The time stamp when the resource was created.

" } }, - "configuration": { - "target": "com.amazonaws.configservice#Configuration", + "arn": { + "target": "com.amazonaws.configservice#ARN", "traits": { - "smithy.api#documentation": "

The description of the resource configuration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" } }, - "resourceId": { - "target": "com.amazonaws.configservice#ResourceId", + "resourceType": { + "target": "com.amazonaws.configservice#ResourceType", "traits": { - "smithy.api#documentation": "

The ID of the resource (for example., sg-xxxxxx).

" + "smithy.api#documentation": "

The type of AWS resource.

" } }, - "awsRegion": { - "target": "com.amazonaws.configservice#AwsRegion", + "accountId": { + "target": "com.amazonaws.configservice#AccountId", "traits": { - "smithy.api#documentation": "

The region where the resource resides.

" + "smithy.api#documentation": "

The 12-digit AWS account ID associated with the resource.

" } }, - "availabilityZone": { - "target": "com.amazonaws.configservice#AvailabilityZone", + "configurationStateId": { + "target": "com.amazonaws.configservice#ConfigurationStateId", "traits": { - "smithy.api#documentation": "

The Availability Zone associated with the resource.

" + "smithy.api#documentation": "

An identifier that indicates the ordering of the configuration\n\t\t\titems of a resource.

" } }, - "arn": { - "target": "com.amazonaws.configservice#ARN", + "resourceName": { + "target": "com.amazonaws.configservice#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + "smithy.api#documentation": "

The custom name of the resource, if available.

" } }, - "configurationItemCaptureTime": { - "target": "com.amazonaws.configservice#ConfigurationItemCaptureTime", + "supplementaryConfiguration": { + "target": "com.amazonaws.configservice#SupplementaryConfiguration", "traits": { - "smithy.api#documentation": "

The time when the configuration recording was initiated.

" + "smithy.api#documentation": "

Configuration attributes that AWS Config returns for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\tconfiguration parameter.

" } }, - "configurationItemStatus": { - "target": "com.amazonaws.configservice#ConfigurationItemStatus", + "version": { + "target": "com.amazonaws.configservice#Version", "traits": { - "smithy.api#documentation": "

The configuration item status. The valid values are:

\n\t\t\n\t\t \n\t\t \n

The CIs do not incur any cost.

\n " + "smithy.api#documentation": "

The version number of the resource configuration.

" } }, - "resourceCreationTime": { - "target": "com.amazonaws.configservice#ResourceCreationTime", + "configurationItemCaptureTime": { + "target": "com.amazonaws.configservice#ConfigurationItemCaptureTime", "traits": { - "smithy.api#documentation": "

The time stamp when the resource was created.

" + "smithy.api#documentation": "

The time when the configuration recording was initiated.

" } } }, @@ -741,6 +741,12 @@ "com.amazonaws.configservice#ComplianceByResource": { "type": "structure", "members": { + "Compliance": { + "target": "com.amazonaws.configservice#Compliance", + "traits": { + "smithy.api#documentation": "

Indicates whether the AWS resource complies with all of the AWS\n\t\t\tConfig rules that evaluated it.

" + } + }, "ResourceId": { "target": "com.amazonaws.configservice#BaseResourceId", "traits": { @@ -752,12 +758,6 @@ "traits": { "smithy.api#documentation": "

The type of the AWS resource that was evaluated.

" } - }, - "Compliance": { - "target": "com.amazonaws.configservice#Compliance", - "traits": { - "smithy.api#documentation": "

Indicates whether the AWS resource complies with all of the AWS\n\t\t\tConfig rules that evaluated it.

" - } } }, "traits": { @@ -892,22 +892,28 @@ "com.amazonaws.configservice#ConfigExportDeliveryInfo": { "type": "structure", "members": { + "lastErrorMessage": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The error message from the last attempted delivery.

" + } + }, "lastStatus": { "target": "com.amazonaws.configservice#DeliveryStatus", "traits": { "smithy.api#documentation": "

Status of the last attempted delivery.

" } }, - "lastAttemptTime": { + "lastSuccessfulTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The time of the last attempted delivery.

" + "smithy.api#documentation": "

The time of the last successful delivery.

" } }, - "lastSuccessfulTime": { - "target": "com.amazonaws.configservice#Date", + "lastErrorCode": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The time of the last successful delivery.

" + "smithy.api#documentation": "

The error code from the last attempted delivery.

" } }, "nextDeliveryTime": { @@ -916,16 +922,10 @@ "smithy.api#documentation": "

The time that the next delivery occurs.

" } }, - "lastErrorCode": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The error code from the last attempted delivery.

" - } - }, - "lastErrorMessage": { - "target": "com.amazonaws.configservice#String", + "lastAttemptTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The error message from the last attempted delivery.

" + "smithy.api#documentation": "

The time of the last attempted delivery.

" } } }, @@ -936,12 +936,6 @@ "com.amazonaws.configservice#ConfigRule": { "type": "structure", "members": { - "ConfigRuleState": { - "target": "com.amazonaws.configservice#ConfigRuleState", - "traits": { - "smithy.api#documentation": "

Indicates whether the AWS Config rule is active or is currently\n\t\t\tbeing deleted by AWS Config. It can also indicate the evaluation\n\t\t\tstatus for the AWS Config rule.

\n\n\t\t

AWS Config sets the state of the rule to\n\t\t\t\tEVALUATING temporarily after you use the\n\t\t\t\tStartConfigRulesEvaluation request to evaluate your\n\t\t\tresources against the AWS Config rule.

\n\n\t\t

AWS Config sets the state of the rule to\n\t\t\t\tDELETING_RESULTS temporarily after you use the\n\t\t\t\tDeleteEvaluationResults request to delete the\n\t\t\tcurrent evaluation results for the AWS Config rule.

\n\n\t\t

AWS Config temporarily sets the state of a rule to\n\t\t\t\tDELETING after you use the\n\t\t\t\tDeleteConfigRule request to delete the rule. After\n\t\t\tAWS Config deletes the rule, the rule and all of its evaluations are\n\t\t\terased and are no longer available.

" - } - }, "Source": { "target": "com.amazonaws.configservice#Source", "traits": { @@ -955,22 +949,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Config\n\t\t\trule.

" } }, - "Scope": { - "target": "com.amazonaws.configservice#Scope", - "traits": { - "smithy.api#documentation": "

Defines which resources can trigger an evaluation for the rule.\n\t\t\tThe scope can include one or more resource types, a combination of\n\t\t\tone resource type and one resource ID, or a combination of a tag key\n\t\t\tand value. Specify a scope to constrain the resources that can\n\t\t\ttrigger an evaluation for the rule. If you do not specify a scope,\n\t\t\tevaluations are triggered when any resource in the recording group\n\t\t\tchanges.

\n\t\t \n

The scope can be empty.

\n " - } - }, - "CreatedBy": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "ConfigRuleState": { + "target": "com.amazonaws.configservice#ConfigRuleState", "traits": { - "smithy.api#documentation": "

Service principal name of the service that created the\n\t\t\trule.

\n\t\t \n\t\t\t

The field is populated only if the service linked rule is\n\t\t\t\tcreated by a service. The field is empty if you create your own\n\t\t\t\trule.

\n\t\t " + "smithy.api#documentation": "

Indicates whether the AWS Config rule is active or is currently\n\t\t\tbeing deleted by AWS Config. It can also indicate the evaluation\n\t\t\tstatus for the AWS Config rule.

\n\n\t\t

AWS Config sets the state of the rule to\n\t\t\t\tEVALUATING temporarily after you use the\n\t\t\t\tStartConfigRulesEvaluation request to evaluate your\n\t\t\tresources against the AWS Config rule.

\n\n\t\t

AWS Config sets the state of the rule to\n\t\t\t\tDELETING_RESULTS temporarily after you use the\n\t\t\t\tDeleteEvaluationResults request to delete the\n\t\t\tcurrent evaluation results for the AWS Config rule.

\n\n\t\t

AWS Config temporarily sets the state of a rule to\n\t\t\t\tDELETING after you use the\n\t\t\t\tDeleteConfigRule request to delete the rule. After\n\t\t\tAWS Config deletes the rule, the rule and all of its evaluations are\n\t\t\terased and are no longer available.

" } }, - "MaximumExecutionFrequency": { - "target": "com.amazonaws.configservice#MaximumExecutionFrequency", + "InputParameters": { + "target": "com.amazonaws.configservice#StringWithCharLimit1024", "traits": { - "smithy.api#documentation": "

The maximum frequency with which AWS Config runs evaluations\n\t\t\tfor a rule. You can specify a value for\n\t\t\t\tMaximumExecutionFrequency when:

\n\t\t \n\n\n\n\t\t \n\t\t\t

By default, rules with a periodic trigger are evaluated\n\t\t\t\tevery 24 hours. To change the frequency, specify a valid value\n\t\t\t\tfor the MaximumExecutionFrequency\n\t\t\t\tparameter.

\n\t\t " + "smithy.api#documentation": "

A string, in JSON format, that is passed to the AWS Config rule\n\t\t\tLambda function.

" } }, "ConfigRuleId": { @@ -979,10 +967,10 @@ "smithy.api#documentation": "

The ID of the AWS Config rule.

" } }, - "InputParameters": { - "target": "com.amazonaws.configservice#StringWithCharLimit1024", + "Scope": { + "target": "com.amazonaws.configservice#Scope", "traits": { - "smithy.api#documentation": "

A string, in JSON format, that is passed to the AWS Config rule\n\t\t\tLambda function.

" + "smithy.api#documentation": "

Defines which resources can trigger an evaluation for the rule.\n\t\t\tThe scope can include one or more resource types, a combination of\n\t\t\tone resource type and one resource ID, or a combination of a tag key\n\t\t\tand value. Specify a scope to constrain the resources that can\n\t\t\ttrigger an evaluation for the rule. If you do not specify a scope,\n\t\t\tevaluations are triggered when any resource in the recording group\n\t\t\tchanges.

\n\t\t \n

The scope can be empty.

\n " } }, "Description": { @@ -991,11 +979,23 @@ "smithy.api#documentation": "

The description that you provide for the AWS Config\n\t\t\trule.

" } }, + "MaximumExecutionFrequency": { + "target": "com.amazonaws.configservice#MaximumExecutionFrequency", + "traits": { + "smithy.api#documentation": "

The maximum frequency with which AWS Config runs evaluations\n\t\t\tfor a rule. You can specify a value for\n\t\t\t\tMaximumExecutionFrequency when:

\n\t\t \n\n\n\n\t\t \n\t\t\t

By default, rules with a periodic trigger are evaluated\n\t\t\t\tevery 24 hours. To change the frequency, specify a valid value\n\t\t\t\tfor the MaximumExecutionFrequency\n\t\t\t\tparameter.

\n\t\t " + } + }, "ConfigRuleName": { "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { "smithy.api#documentation": "

The name that you assign to the AWS Config rule. The name is\n\t\t\trequired if you are adding a new rule.

" } + }, + "CreatedBy": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", + "traits": { + "smithy.api#documentation": "

Service principal name of the service that created the\n\t\t\trule.

\n\t\t \n\t\t\t

The field is populated only if the service linked rule is\n\t\t\t\tcreated by a service. The field is empty if you create your own\n\t\t\t\trule.

\n\t\t " + } } }, "traits": { @@ -1005,10 +1005,10 @@ "com.amazonaws.configservice#ConfigRuleComplianceFilters": { "type": "structure", "members": { - "ConfigRuleName": { - "target": "com.amazonaws.configservice#ConfigRuleName", + "ComplianceType": { + "target": "com.amazonaws.configservice#ComplianceType", "traits": { - "smithy.api#documentation": "

The name of the AWS Config rule.

" + "smithy.api#documentation": "

The rule compliance status.

\n\t\t

For the ConfigRuleComplianceFilters data type, AWS\n\t\t\tConfig supports only COMPLIANT and\n\t\t\t\tNON_COMPLIANT. AWS Config does not support the\n\t\t\t\tNOT_APPLICABLE and the\n\t\t\t\tINSUFFICIENT_DATA values.

" } }, "AwsRegion": { @@ -1017,16 +1017,16 @@ "smithy.api#documentation": "

The source region where the data is aggregated.\n\t\t\t

" } }, - "AccountId": { - "target": "com.amazonaws.configservice#AccountId", + "ConfigRuleName": { + "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { - "smithy.api#documentation": "

The 12-digit account ID of the source account.\n\t\t\t

" + "smithy.api#documentation": "

The name of the AWS Config rule.

" } }, - "ComplianceType": { - "target": "com.amazonaws.configservice#ComplianceType", + "AccountId": { + "target": "com.amazonaws.configservice#AccountId", "traits": { - "smithy.api#documentation": "

The rule compliance status.

\n\t\t

For the ConfigRuleComplianceFilters data type, AWS\n\t\t\tConfig supports only COMPLIANT and\n\t\t\t\tNON_COMPLIANT. AWS Config does not support the\n\t\t\t\tNOT_APPLICABLE and the\n\t\t\t\tINSUFFICIENT_DATA values.

" + "smithy.api#documentation": "

The 12-digit account ID of the source account.\n\t\t\t

" } } }, @@ -1037,17 +1037,17 @@ "com.amazonaws.configservice#ConfigRuleComplianceSummaryFilters": { "type": "structure", "members": { - "AwsRegion": { - "target": "com.amazonaws.configservice#AwsRegion", - "traits": { - "smithy.api#documentation": "

The source region where the data is aggregated.

" - } - }, "AccountId": { "target": "com.amazonaws.configservice#AccountId", "traits": { "smithy.api#documentation": "

The 12-digit account ID of the source account.

" } + }, + "AwsRegion": { + "target": "com.amazonaws.configservice#AwsRegion", + "traits": { + "smithy.api#documentation": "

The source region where the data is aggregated.

" + } } }, "traits": { @@ -1078,16 +1078,22 @@ "smithy.api#documentation": "

The error code that AWS Config returned when the rule last\n\t\t\tfailed.

" } }, - "LastFailedInvocationTime": { - "target": "com.amazonaws.configservice#Date", + "ConfigRuleArn": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The time that AWS Config last failed to invoke the AWS Config\n\t\t\trule to evaluate your AWS resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Config\n\t\t\trule.

" } }, - "LastFailedEvaluationTime": { + "ConfigRuleName": { + "target": "com.amazonaws.configservice#ConfigRuleName", + "traits": { + "smithy.api#documentation": "

The name of the AWS Config rule.

" + } + }, + "LastSuccessfulInvocationTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The time that AWS Config last failed to evaluate your AWS\n\t\t\tresources against the rule.

" + "smithy.api#documentation": "

The time that AWS Config last successfully invoked the AWS\n\t\t\tConfig rule to evaluate your AWS resources.

" } }, "FirstEvaluationStarted": { @@ -1096,10 +1102,16 @@ "smithy.api#documentation": "

Indicates whether AWS Config has evaluated your resources\n\t\t\tagainst the rule at least once.

\n\t\t " } }, - "LastSuccessfulEvaluationTime": { + "LastFailedInvocationTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The time that AWS Config last successfully evaluated your AWS\n\t\t\tresources against the rule.

" + "smithy.api#documentation": "

The time that AWS Config last failed to invoke the AWS Config\n\t\t\trule to evaluate your AWS resources.

" + } + }, + "FirstActivatedTime": { + "target": "com.amazonaws.configservice#Date", + "traits": { + "smithy.api#documentation": "

The time that you first activated the AWS Config\n\t\t\trule.

" } }, "ConfigRuleId": { @@ -1108,40 +1120,28 @@ "smithy.api#documentation": "

The ID of the AWS Config rule.

" } }, - "LastDeactivatedTime": { - "target": "com.amazonaws.configservice#Date", + "LastErrorMessage": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The time that you last turned off the AWS Config rule.

" + "smithy.api#documentation": "

The error message that AWS Config returned when the rule last\n\t\t\tfailed.

" } }, - "FirstActivatedTime": { + "LastFailedEvaluationTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The time that you first activated the AWS Config\n\t\t\trule.

" + "smithy.api#documentation": "

The time that AWS Config last failed to evaluate your AWS\n\t\t\tresources against the rule.

" } }, - "LastSuccessfulInvocationTime": { + "LastSuccessfulEvaluationTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The time that AWS Config last successfully invoked the AWS\n\t\t\tConfig rule to evaluate your AWS resources.

" - } - }, - "ConfigRuleArn": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Config\n\t\t\trule.

" - } - }, - "ConfigRuleName": { - "target": "com.amazonaws.configservice#ConfigRuleName", - "traits": { - "smithy.api#documentation": "

The name of the AWS Config rule.

" + "smithy.api#documentation": "

The time that AWS Config last successfully evaluated your AWS\n\t\t\tresources against the rule.

" } }, - "LastErrorMessage": { - "target": "com.amazonaws.configservice#String", + "LastDeactivatedTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The error message that AWS Config returned when the rule last\n\t\t\tfailed.

" + "smithy.api#documentation": "

The time that you last turned off the AWS Config rule.

" } } }, @@ -1223,10 +1223,10 @@ "com.amazonaws.configservice#ConfigStreamDeliveryInfo": { "type": "structure", "members": { - "lastStatus": { - "target": "com.amazonaws.configservice#DeliveryStatus", + "lastErrorMessage": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

Status of the last attempted delivery.

\n\t\t

\n\t\t\t Note Providing an SNS topic on a\n\t\t\t\tDeliveryChannel for AWS Config is optional. If the SNS\n\t\t\tdelivery is turned off, the last status will be Not_Applicable.

" + "smithy.api#documentation": "

The error message from the last attempted delivery.

" } }, "lastStatusChangeTime": { @@ -1235,16 +1235,16 @@ "smithy.api#documentation": "

The time from the last status change.

" } }, - "lastErrorCode": { - "target": "com.amazonaws.configservice#String", + "lastStatus": { + "target": "com.amazonaws.configservice#DeliveryStatus", "traits": { - "smithy.api#documentation": "

The error code from the last attempted delivery.

" + "smithy.api#documentation": "

Status of the last attempted delivery.

\n\t\t

\n\t\t\t Note Providing an SNS topic on a\n\t\t\t\tDeliveryChannel for AWS Config is optional. If the SNS\n\t\t\tdelivery is turned off, the last status will be Not_Applicable.

" } }, - "lastErrorMessage": { + "lastErrorCode": { "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The error message from the last attempted delivery.

" + "smithy.api#documentation": "

The error code from the last attempted delivery.

" } } }, @@ -1276,10 +1276,10 @@ "smithy.api#documentation": "

Provides a list of source accounts and regions to be\n\t\t\taggregated.

" } }, - "OrganizationAggregationSource": { - "target": "com.amazonaws.configservice#OrganizationAggregationSource", + "CreationTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

Provides an organization and list of regions to be\n\t\t\taggregated.

" + "smithy.api#documentation": "

The time stamp when the configuration aggregator was\n\t\t\tcreated.

" } }, "ConfigurationAggregatorName": { @@ -1288,10 +1288,10 @@ "smithy.api#documentation": "

The name of the aggregator.

" } }, - "CreationTime": { - "target": "com.amazonaws.configservice#Date", + "OrganizationAggregationSource": { + "target": "com.amazonaws.configservice#OrganizationAggregationSource", "traits": { - "smithy.api#documentation": "

The time stamp when the configuration aggregator was\n\t\t\tcreated.

" + "smithy.api#documentation": "

Provides an organization and list of regions to be\n\t\t\taggregated.

" } }, "LastUpdatedTime": { @@ -1342,28 +1342,22 @@ "com.amazonaws.configservice#ConfigurationItem": { "type": "structure", "members": { - "awsRegion": { - "target": "com.amazonaws.configservice#AwsRegion", - "traits": { - "smithy.api#documentation": "

The region where the resource resides.

" - } - }, - "configurationItemMD5Hash": { - "target": "com.amazonaws.configservice#ConfigurationItemMD5Hash", + "supplementaryConfiguration": { + "target": "com.amazonaws.configservice#SupplementaryConfiguration", "traits": { - "smithy.api#documentation": "

Unique MD5 hash that represents the configuration item's\n\t\t\tstate.

\n\t\t

You can use MD5 hash to compare the states of two or more\n\t\t\tconfiguration items that are associated with the same\n\t\t\tresource.

" + "smithy.api#documentation": "

Configuration attributes that AWS Config returns for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\t\tconfiguration parameter.

" } }, - "resourceId": { - "target": "com.amazonaws.configservice#ResourceId", + "resourceName": { + "target": "com.amazonaws.configservice#ResourceName", "traits": { - "smithy.api#documentation": "

The ID of the resource (for example,\n\t\t\tsg-xxxxxx).

" + "smithy.api#documentation": "

The custom name of the resource, if available.

" } }, - "resourceType": { - "target": "com.amazonaws.configservice#ResourceType", + "configuration": { + "target": "com.amazonaws.configservice#Configuration", "traits": { - "smithy.api#documentation": "

The type of AWS resource.

" + "smithy.api#documentation": "

The description of the resource configuration.

" } }, "relatedEvents": { @@ -1372,82 +1366,88 @@ "smithy.api#documentation": "

A list of CloudTrail event IDs.

\n\t\t

A populated field indicates that the current configuration was\n\t\t\tinitiated by the events recorded in the CloudTrail log. For more\n\t\t\tinformation about CloudTrail, see What Is AWS CloudTrail.

\n\t\t

An empty field indicates that the current configuration was not\n\t\t\tinitiated by any event. As of Version 1.3, the relatedEvents field is empty. \n\t\t\tYou can access the LookupEvents API in the AWS CloudTrail API Reference to retrieve the events for the resource.

" } }, - "relationships": { - "target": "com.amazonaws.configservice#RelationshipList", + "configurationItemStatus": { + "target": "com.amazonaws.configservice#ConfigurationItemStatus", "traits": { - "smithy.api#documentation": "

A list of related AWS resources.

" + "smithy.api#documentation": "

The configuration item status. The valid values are:

\n\t\t\n\t\t \n\t\t \n

The CIs do not incur any cost.

\n " } }, - "accountId": { - "target": "com.amazonaws.configservice#AccountId", + "version": { + "target": "com.amazonaws.configservice#Version", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account ID associated with the\n\t\t\tresource.

" + "smithy.api#documentation": "

The version number of the resource configuration.

" } }, - "configurationStateId": { - "target": "com.amazonaws.configservice#ConfigurationStateId", + "tags": { + "target": "com.amazonaws.configservice#Tags", "traits": { - "smithy.api#documentation": "

An identifier that indicates the ordering of the configuration\n\t\t\titems of a resource.

" + "smithy.api#documentation": "

A mapping of key value tags associated with the\n\t\t\tresource.

" } }, - "arn": { - "target": "com.amazonaws.configservice#ARN", + "availabilityZone": { + "target": "com.amazonaws.configservice#AvailabilityZone", "traits": { - "smithy.api#documentation": "

accoun

" + "smithy.api#documentation": "

The Availability Zone associated with the resource.

" } }, - "resourceCreationTime": { - "target": "com.amazonaws.configservice#ResourceCreationTime", + "resourceId": { + "target": "com.amazonaws.configservice#ResourceId", "traits": { - "smithy.api#documentation": "

The time stamp when the resource was created.

" + "smithy.api#documentation": "

The ID of the resource (for example,\n\t\t\tsg-xxxxxx).

" } }, - "supplementaryConfiguration": { - "target": "com.amazonaws.configservice#SupplementaryConfiguration", + "configurationItemCaptureTime": { + "target": "com.amazonaws.configservice#ConfigurationItemCaptureTime", "traits": { - "smithy.api#documentation": "

Configuration attributes that AWS Config returns for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\t\tconfiguration parameter.

" + "smithy.api#documentation": "

The time when the configuration recording was\n\t\t\tinitiated.

" } }, - "configurationItemStatus": { - "target": "com.amazonaws.configservice#ConfigurationItemStatus", + "arn": { + "target": "com.amazonaws.configservice#ARN", "traits": { - "smithy.api#documentation": "

The configuration item status. The valid values are:

\n\t\t\n\t\t \n\t\t \n

The CIs do not incur any cost.

\n " + "smithy.api#documentation": "

accoun

" } }, - "configurationItemCaptureTime": { - "target": "com.amazonaws.configservice#ConfigurationItemCaptureTime", + "resourceCreationTime": { + "target": "com.amazonaws.configservice#ResourceCreationTime", "traits": { - "smithy.api#documentation": "

The time when the configuration recording was\n\t\t\tinitiated.

" + "smithy.api#documentation": "

The time stamp when the resource was created.

" } }, - "configuration": { - "target": "com.amazonaws.configservice#Configuration", + "configurationItemMD5Hash": { + "target": "com.amazonaws.configservice#ConfigurationItemMD5Hash", "traits": { - "smithy.api#documentation": "

The description of the resource configuration.

" + "smithy.api#documentation": "

Unique MD5 hash that represents the configuration item's\n\t\t\tstate.

\n\t\t

You can use MD5 hash to compare the states of two or more\n\t\t\tconfiguration items that are associated with the same\n\t\t\tresource.

" } }, - "resourceName": { - "target": "com.amazonaws.configservice#ResourceName", + "resourceType": { + "target": "com.amazonaws.configservice#ResourceType", "traits": { - "smithy.api#documentation": "

The custom name of the resource, if available.

" + "smithy.api#documentation": "

The type of AWS resource.

" } }, - "availabilityZone": { - "target": "com.amazonaws.configservice#AvailabilityZone", + "relationships": { + "target": "com.amazonaws.configservice#RelationshipList", "traits": { - "smithy.api#documentation": "

The Availability Zone associated with the resource.

" + "smithy.api#documentation": "

A list of related AWS resources.

" } }, - "tags": { - "target": "com.amazonaws.configservice#Tags", + "configurationStateId": { + "target": "com.amazonaws.configservice#ConfigurationStateId", "traits": { - "smithy.api#documentation": "

A mapping of key value tags associated with the\n\t\t\tresource.

" + "smithy.api#documentation": "

An identifier that indicates the ordering of the configuration\n\t\t\titems of a resource.

" } }, - "version": { - "target": "com.amazonaws.configservice#Version", + "awsRegion": { + "target": "com.amazonaws.configservice#AwsRegion", "traits": { - "smithy.api#documentation": "

The version number of the resource configuration.

" + "smithy.api#documentation": "

The region where the resource resides.

" + } + }, + "accountId": { + "target": "com.amazonaws.configservice#AccountId", + "traits": { + "smithy.api#documentation": "

The 12-digit AWS account ID associated with the\n\t\t\tresource.

" } } }, @@ -1503,17 +1503,17 @@ "smithy.api#documentation": "

Specifies the types of AWS resources for which AWS Config\n\t\t\trecords configuration changes.

" } }, - "roleARN": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the IAM role used to describe the\n\t\t\tAWS resources associated with the account.

" - } - }, "name": { "target": "com.amazonaws.configservice#RecorderName", "traits": { "smithy.api#documentation": "

The name of the recorder. By default, AWS Config automatically\n\t\t\tassigns the name \"default\" when creating the configuration recorder.\n\t\t\tYou cannot change the assigned name.

" } + }, + "roleARN": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the IAM role used to describe the\n\t\t\tAWS resources associated with the account.

" + } } }, "traits": { @@ -1535,28 +1535,22 @@ "com.amazonaws.configservice#ConfigurationRecorderStatus": { "type": "structure", "members": { - "recording": { - "target": "com.amazonaws.configservice#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether or not the recorder is currently\n\t\t\trecording.

" - } - }, - "lastErrorCode": { - "target": "com.amazonaws.configservice#String", + "lastStopTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The error code indicating that the recording failed.

" + "smithy.api#documentation": "

The time the recorder was last stopped.

" } }, - "lastStatusChangeTime": { - "target": "com.amazonaws.configservice#Date", + "lastStatus": { + "target": "com.amazonaws.configservice#RecorderStatus", "traits": { - "smithy.api#documentation": "

The time when the status was last changed.

" + "smithy.api#documentation": "

The last (previous) status of the recorder.

" } }, - "lastErrorMessage": { - "target": "com.amazonaws.configservice#String", + "recording": { + "target": "com.amazonaws.configservice#Boolean", "traits": { - "smithy.api#documentation": "

The message indicating that the recording failed due to an\n\t\t\terror.

" + "smithy.api#documentation": "

Specifies whether or not the recorder is currently\n\t\t\trecording.

" } }, "lastStartTime": { @@ -1565,10 +1559,10 @@ "smithy.api#documentation": "

The time the recorder was last started.

" } }, - "lastStatus": { - "target": "com.amazonaws.configservice#RecorderStatus", + "lastErrorMessage": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The last (previous) status of the recorder.

" + "smithy.api#documentation": "

The message indicating that the recording failed due to an\n\t\t\terror.

" } }, "name": { @@ -1577,10 +1571,16 @@ "smithy.api#documentation": "

The name of the configuration recorder.

" } }, - "lastStopTime": { + "lastErrorCode": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The error code indicating that the recording failed.

" + } + }, + "lastStatusChangeTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The time the recorder was last stopped.

" + "smithy.api#documentation": "

The time when the status was last changed.

" } } }, @@ -1641,17 +1641,17 @@ "com.amazonaws.configservice#ConformancePackComplianceSummary": { "type": "structure", "members": { - "ConformancePackComplianceStatus": { - "target": "com.amazonaws.configservice#ConformancePackComplianceType", + "ConformancePackName": { + "target": "com.amazonaws.configservice#ConformancePackName", "traits": { - "smithy.api#documentation": "

The status of the conformance pack. The allowed values are COMPLIANT and NON_COMPLIANT.

", + "smithy.api#documentation": "

The name of the conformance pack name.

", "smithy.api#required": {} } }, - "ConformancePackName": { - "target": "com.amazonaws.configservice#ConformancePackName", + "ConformancePackComplianceStatus": { + "target": "com.amazonaws.configservice#ConformancePackComplianceType", "traits": { - "smithy.api#documentation": "

The name of the conformance pack name.

", + "smithy.api#documentation": "

The status of the conformance pack. The allowed values are COMPLIANT and NON_COMPLIANT.

", "smithy.api#required": {} } } @@ -1702,13 +1702,6 @@ "com.amazonaws.configservice#ConformancePackDetail": { "type": "structure", "members": { - "DeliveryS3Bucket": { - "target": "com.amazonaws.configservice#DeliveryS3Bucket", - "traits": { - "smithy.api#documentation": "

Conformance pack template that is used to create a pack. The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\".

", - "smithy.api#required": {} - } - }, "ConformancePackArn": { "target": "com.amazonaws.configservice#ConformancePackArn", "traits": { @@ -1716,18 +1709,6 @@ "smithy.api#required": {} } }, - "CreatedBy": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", - "traits": { - "smithy.api#documentation": "

AWS service that created the conformance pack.

" - } - }, - "ConformancePackInputParameters": { - "target": "com.amazonaws.configservice#ConformancePackInputParameters", - "traits": { - "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" - } - }, "ConformancePackId": { "target": "com.amazonaws.configservice#ConformancePackId", "traits": { @@ -1735,10 +1716,16 @@ "smithy.api#required": {} } }, - "LastUpdateRequestedTime": { - "target": "com.amazonaws.configservice#Date", + "DeliveryS3KeyPrefix": { + "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", "traits": { - "smithy.api#documentation": "

Last time when conformation pack update was requested.

" + "smithy.api#documentation": "

The prefix for the Amazon S3 bucket.

" + } + }, + "DeliveryS3Bucket": { + "target": "com.amazonaws.configservice#DeliveryS3Bucket", + "traits": { + "smithy.api#documentation": "

Conformance pack template that is used to create a pack. The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\".

" } }, "ConformancePackName": { @@ -1748,10 +1735,22 @@ "smithy.api#required": {} } }, - "DeliveryS3KeyPrefix": { - "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", + "ConformancePackInputParameters": { + "target": "com.amazonaws.configservice#ConformancePackInputParameters", "traits": { - "smithy.api#documentation": "

The prefix for the Amazon S3 bucket.

" + "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" + } + }, + "LastUpdateRequestedTime": { + "target": "com.amazonaws.configservice#Date", + "traits": { + "smithy.api#documentation": "

Last time when conformation pack update was requested.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", + "traits": { + "smithy.api#documentation": "

AWS service that created the conformance pack.

" } } }, @@ -1774,6 +1773,12 @@ "com.amazonaws.configservice#ConformancePackEvaluationFilters": { "type": "structure", "members": { + "ResourceIds": { + "target": "com.amazonaws.configservice#ConformancePackComplianceResourceIds", + "traits": { + "smithy.api#documentation": "

Filters the results by resource IDs.

\n\t\t \n

This is valid only when you provide resource type. If there is no resource type, you will see an error.

\n " + } + }, "ResourceType": { "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { @@ -1786,12 +1791,6 @@ "smithy.api#documentation": "

Filters the results by AWS Config rule names.

" } }, - "ResourceIds": { - "target": "com.amazonaws.configservice#ConformancePackComplianceResourceIds", - "traits": { - "smithy.api#documentation": "

Filters the results by resource IDs.

\n\t\t \n

This is valid only when you provide resource type. If there is no resource type, you will see an error.

\n " - } - }, "ComplianceType": { "target": "com.amazonaws.configservice#ConformancePackComplianceType", "traits": { @@ -1806,6 +1805,12 @@ "com.amazonaws.configservice#ConformancePackEvaluationResult": { "type": "structure", "members": { + "Annotation": { + "target": "com.amazonaws.configservice#Annotation", + "traits": { + "smithy.api#documentation": "

Supplementary information about how the evaluation determined the compliance.

" + } + }, "ComplianceType": { "target": "com.amazonaws.configservice#ConformancePackComplianceType", "traits": { @@ -1832,12 +1837,6 @@ "smithy.api#documentation": "

The time when AWS Config recorded the evaluation result.

", "smithy.api#required": {} } - }, - "Annotation": { - "target": "com.amazonaws.configservice#Annotation", - "traits": { - "smithy.api#documentation": "

Supplementary information about how the evaluation determined the compliance.

" - } } }, "traits": { @@ -1924,17 +1923,17 @@ "com.amazonaws.configservice#ConformancePackRuleCompliance": { "type": "structure", "members": { - "ComplianceType": { - "target": "com.amazonaws.configservice#ConformancePackComplianceType", - "traits": { - "smithy.api#documentation": "

Compliance of the AWS Config rule

\n\t\t

The allowed values are COMPLIANT and NON_COMPLIANT.

" - } - }, "ConfigRuleName": { "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { "smithy.api#documentation": "

Name of the config rule.

" } + }, + "ComplianceType": { + "target": "com.amazonaws.configservice#ConformancePackComplianceType", + "traits": { + "smithy.api#documentation": "

Compliance of the AWS Config rule

\n\t\t

The allowed values are COMPLIANT and NON_COMPLIANT.

" + } } }, "traits": { @@ -1995,31 +1994,30 @@ "com.amazonaws.configservice#ConformancePackStatusDetail": { "type": "structure", "members": { - "ConformancePackId": { - "target": "com.amazonaws.configservice#ConformancePackId", + "ConformancePackState": { + "target": "com.amazonaws.configservice#ConformancePackState", "traits": { - "smithy.api#documentation": "

ID of the conformance pack.

", + "smithy.api#documentation": "

Indicates deployment status of conformance pack.

\n\t\t

AWS Config sets the state of the conformance pack to:

\n\t\t ", "smithy.api#required": {} } }, - "LastUpdateRequestedTime": { - "target": "com.amazonaws.configservice#Date", + "StackArn": { + "target": "com.amazonaws.configservice#StackArn", "traits": { - "smithy.api#documentation": "

Last time when conformation pack creation and update was requested.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of AWS CloudFormation stack.

", "smithy.api#required": {} } }, - "ConformancePackName": { - "target": "com.amazonaws.configservice#ConformancePackName", + "LastUpdateCompletedTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

Name of the conformance pack.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Last time when conformation pack creation and update was successful.

" } }, - "ConformancePackState": { - "target": "com.amazonaws.configservice#ConformancePackState", + "ConformancePackArn": { + "target": "com.amazonaws.configservice#ConformancePackArn", "traits": { - "smithy.api#documentation": "

Indicates deployment status of conformance pack.

\n\t\t

AWS Config sets the state of the conformance pack to:

\n\t\t ", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of comformance pack.

", "smithy.api#required": {} } }, @@ -2029,23 +2027,24 @@ "smithy.api#documentation": "

The reason of conformance pack creation failure.

" } }, - "LastUpdateCompletedTime": { - "target": "com.amazonaws.configservice#Date", + "ConformancePackId": { + "target": "com.amazonaws.configservice#ConformancePackId", "traits": { - "smithy.api#documentation": "

Last time when conformation pack creation and update was successful.

" + "smithy.api#documentation": "

ID of the conformance pack.

", + "smithy.api#required": {} } }, - "StackArn": { - "target": "com.amazonaws.configservice#StackArn", + "LastUpdateRequestedTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of AWS CloudFormation stack.

", + "smithy.api#documentation": "

Last time when conformation pack creation and update was requested.

", "smithy.api#required": {} } }, - "ConformancePackArn": { - "target": "com.amazonaws.configservice#ConformancePackArn", + "ConformancePackName": { + "target": "com.amazonaws.configservice#ConformancePackName", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of comformance pack.

", + "smithy.api#documentation": "

Name of the conformance pack.

", "smithy.api#required": {} } } @@ -2119,17 +2118,17 @@ "com.amazonaws.configservice#DeleteAggregationAuthorizationRequest": { "type": "structure", "members": { - "AuthorizedAwsRegion": { - "target": "com.amazonaws.configservice#AwsRegion", + "AuthorizedAccountId": { + "target": "com.amazonaws.configservice#AccountId", "traits": { - "smithy.api#documentation": "

The region authorized to collect aggregated data.

", + "smithy.api#documentation": "

The 12-digit account ID of the account authorized to aggregate\n\t\t\tdata.

", "smithy.api#required": {} } }, - "AuthorizedAccountId": { - "target": "com.amazonaws.configservice#AccountId", + "AuthorizedAwsRegion": { + "target": "com.amazonaws.configservice#AwsRegion", "traits": { - "smithy.api#documentation": "

The 12-digit account ID of the account authorized to aggregate\n\t\t\tdata.

", + "smithy.api#documentation": "

The region authorized to collect aggregated data.

", "smithy.api#required": {} } } @@ -2448,18 +2447,18 @@ "com.amazonaws.configservice#DeleteRemediationConfigurationRequest": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The type of a resource.

" - } - }, "ConfigRuleName": { "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { "smithy.api#documentation": "

The name of the AWS Config rule for which you want to delete remediation configuration.

", "smithy.api#required": {} } + }, + "ResourceType": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The type of a resource.

" + } } } }, @@ -2487,17 +2486,17 @@ "com.amazonaws.configservice#DeleteRemediationExceptionsRequest": { "type": "structure", "members": { - "ResourceKeys": { - "target": "com.amazonaws.configservice#RemediationExceptionResourceKeys", + "ConfigRuleName": { + "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { - "smithy.api#documentation": "

An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

", + "smithy.api#documentation": "

The name of the AWS Config rule for which you want to delete remediation exception configuration.

", "smithy.api#required": {} } }, - "ConfigRuleName": { - "target": "com.amazonaws.configservice#ConfigRuleName", + "ResourceKeys": { + "target": "com.amazonaws.configservice#RemediationExceptionResourceKeys", "traits": { - "smithy.api#documentation": "

The name of the AWS Config rule for which you want to delete remediation exception configuration.

", + "smithy.api#documentation": "

An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

", "smithy.api#required": {} } } @@ -2534,17 +2533,17 @@ "com.amazonaws.configservice#DeleteResourceConfigRequest": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.configservice#ResourceTypeString", + "ResourceId": { + "target": "com.amazonaws.configservice#ResourceId", "traits": { - "smithy.api#documentation": "

The type of the resource.

", + "smithy.api#documentation": "

Unique identifier of the resource.

", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.configservice#ResourceId", + "ResourceType": { + "target": "com.amazonaws.configservice#ResourceTypeString", "traits": { - "smithy.api#documentation": "

Unique identifier of the resource.

", + "smithy.api#documentation": "

The type of the resource.

", "smithy.api#required": {} } } @@ -2640,10 +2639,16 @@ "smithy.api#documentation": "

The name of the Amazon S3 bucket to which AWS Config delivers\n\t\t\tconfiguration snapshots and configuration history files.

\n\t\t

If you specify a bucket that belongs to another AWS account,\n\t\t\tthat bucket must have policies that grant access permissions to AWS\n\t\t\tConfig. For more information, see Permissions for the Amazon S3 Bucket in the AWS Config\n\t\t\tDeveloper Guide.

" } }, - "s3KeyPrefix": { + "configSnapshotDeliveryProperties": { + "target": "com.amazonaws.configservice#ConfigSnapshotDeliveryProperties", + "traits": { + "smithy.api#documentation": "

The options for how often AWS Config delivers configuration\n\t\t\tsnapshots to the Amazon S3 bucket.

" + } + }, + "snsTopicARN": { "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The prefix for the specified Amazon S3 bucket.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which\n\t\t\tAWS Config sends notifications about configuration\n\t\t\tchanges.

\n\t\t

If you choose a topic from another account, the topic must have\n\t\t\tpolicies that grant access permissions to AWS Config. For more\n\t\t\tinformation, see Permissions for the Amazon SNS Topic in the AWS Config\n\t\t\tDeveloper Guide.

" } }, "name": { @@ -2652,16 +2657,10 @@ "smithy.api#documentation": "

The name of the delivery channel. By default, AWS Config\n\t\t\tassigns the name \"default\" when creating the delivery channel. To\n\t\t\tchange the delivery channel name, you must use the\n\t\t\tDeleteDeliveryChannel action to delete your current delivery\n\t\t\tchannel, and then you must use the PutDeliveryChannel command to\n\t\t\tcreate a delivery channel that has the desired name.

" } }, - "configSnapshotDeliveryProperties": { - "target": "com.amazonaws.configservice#ConfigSnapshotDeliveryProperties", - "traits": { - "smithy.api#documentation": "

The options for how often AWS Config delivers configuration\n\t\t\tsnapshots to the Amazon S3 bucket.

" - } - }, - "snsTopicARN": { + "s3KeyPrefix": { "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which\n\t\t\tAWS Config sends notifications about configuration\n\t\t\tchanges.

\n\t\t

If you choose a topic from another account, the topic must have\n\t\t\tpolicies that grant access permissions to AWS Config. For more\n\t\t\tinformation, see Permissions for the Amazon SNS Topic in the AWS Config\n\t\t\tDeveloper Guide.

" + "smithy.api#documentation": "

The prefix for the specified Amazon S3 bucket.

" } } }, @@ -2690,18 +2689,18 @@ "smithy.api#documentation": "

A list that contains the status of the delivery of the\n\t\t\tconfiguration history to the specified Amazon S3 bucket.

" } }, - "configStreamDeliveryInfo": { - "target": "com.amazonaws.configservice#ConfigStreamDeliveryInfo", - "traits": { - "smithy.api#documentation": "

A list containing the status of the delivery of the\n\t\t\tconfiguration stream notification to the specified Amazon SNS\n\t\t\ttopic.

" - } - }, "name": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The name of the delivery channel.

" } }, + "configStreamDeliveryInfo": { + "target": "com.amazonaws.configservice#ConfigStreamDeliveryInfo", + "traits": { + "smithy.api#documentation": "

A list containing the status of the delivery of the\n\t\t\tconfiguration stream notification to the specified Amazon SNS\n\t\t\ttopic.

" + } + }, "configSnapshotDeliveryInfo": { "target": "com.amazonaws.configservice#ConfigExportDeliveryInfo", "traits": { @@ -2723,7 +2722,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 3, + "min": 0, "max": 63 } } @@ -2732,7 +2731,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 1024 } } @@ -2785,6 +2784,12 @@ "com.amazonaws.configservice#DescribeAggregateComplianceByConfigRulesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" + } + }, "Filters": { "target": "com.amazonaws.configservice#ConfigRuleComplianceFilters", "traits": { @@ -2803,12 +2808,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is\n\t\t\tmaximum.\n\t\t\tIf you specify 0, AWS Config uses the default.

" } - }, - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" - } } } }, @@ -2855,17 +2854,17 @@ "com.amazonaws.configservice#DescribeAggregationAuthorizationsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.configservice#Limit", - "traits": { - "smithy.api#documentation": "

The maximum number of AggregationAuthorizations returned on\n\t\t\teach page. The default is maximum. If you specify 0, AWS Config uses\n\t\t\tthe default.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" } + }, + "Limit": { + "target": "com.amazonaws.configservice#Limit", + "traits": { + "smithy.api#documentation": "

The maximum number of AggregationAuthorizations returned on\n\t\t\teach page. The default is maximum. If you specify 0, AWS Config uses\n\t\t\tthe default.

" + } } } }, @@ -2912,12 +2911,6 @@ "com.amazonaws.configservice#DescribeComplianceByConfigRuleRequest": { "type": "structure", "members": { - "ComplianceTypes": { - "target": "com.amazonaws.configservice#ComplianceTypes", - "traits": { - "smithy.api#documentation": "

Filters the results by compliance.

\n\t\t

The allowed values are COMPLIANT and NON_COMPLIANT.

" - } - }, "ConfigRuleNames": { "target": "com.amazonaws.configservice#ConfigRuleNames", "traits": { @@ -2929,6 +2922,12 @@ "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" } + }, + "ComplianceTypes": { + "target": "com.amazonaws.configservice#ComplianceTypes", + "traits": { + "smithy.api#documentation": "

Filters the results by compliance.

\n\t\t

The allowed values are COMPLIANT and NON_COMPLIANT.

" + } } }, "traits": { @@ -2978,34 +2977,34 @@ "com.amazonaws.configservice#DescribeComplianceByResourceRequest": { "type": "structure", "members": { - "ComplianceTypes": { - "target": "com.amazonaws.configservice#ComplianceTypes", + "ResourceType": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

Filters the results by compliance.

\n\t\t

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

" + "smithy.api#documentation": "

The types of AWS resources for which you want compliance\n\t\t\tinformation (for example, AWS::EC2::Instance). For this\n\t\t\taction, you can specify that the resource type is an AWS account by\n\t\t\tspecifying AWS::::Account.

" } }, - "ResourceId": { - "target": "com.amazonaws.configservice#BaseResourceId", + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", "traits": { - "smithy.api#documentation": "

The ID of the AWS resource for which you want compliance\n\t\t\tinformation. You can specify only one resource ID. If you specify a\n\t\t\tresource ID, you must also specify a type for\n\t\t\t\tResourceType.

" + "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" } }, - "Limit": { - "target": "com.amazonaws.configservice#Limit", + "ResourceId": { + "target": "com.amazonaws.configservice#BaseResourceId", "traits": { - "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is 10. You cannot specify a number greater than 100. If\n\t\t\tyou specify 0, AWS Config uses the default.

" + "smithy.api#documentation": "

The ID of the AWS resource for which you want compliance\n\t\t\tinformation. You can specify only one resource ID. If you specify a\n\t\t\tresource ID, you must also specify a type for\n\t\t\t\tResourceType.

" } }, - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", + "ComplianceTypes": { + "target": "com.amazonaws.configservice#ComplianceTypes", "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" + "smithy.api#documentation": "

Filters the results by compliance.

\n\t\t

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

" } }, - "ResourceType": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "Limit": { + "target": "com.amazonaws.configservice#Limit", "traits": { - "smithy.api#documentation": "

The types of AWS resources for which you want compliance\n\t\t\tinformation (for example, AWS::EC2::Instance). For this\n\t\t\taction, you can specify that the resource type is an AWS account by\n\t\t\tspecifying AWS::::Account.

" + "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is 10. You cannot specify a number greater than 100. If\n\t\t\tyou specify 0, AWS Config uses the default.

" } } }, @@ -3059,12 +3058,6 @@ "com.amazonaws.configservice#DescribeConfigRuleEvaluationStatusRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.configservice#RuleLimit", - "traits": { - "smithy.api#documentation": "

The number of rule evaluation results that you want\n\t\t\treturned.

\n\t\t\n\t\t

This parameter is required if the rule limit for your account\n\t\t\tis more than the default of 150 rules.

\n\t\t

For information about requesting a rule limit increase, see\n\t\t\t\tAWS Config Limits in the AWS General\n\t\t\t\tReference Guide.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { @@ -3076,6 +3069,12 @@ "traits": { "smithy.api#documentation": "

The name of the AWS managed Config rules for which you want\n\t\t\tstatus information. If you do not specify any names, AWS Config\n\t\t\treturns status information for all AWS managed Config rules that you\n\t\t\tuse.

" } + }, + "Limit": { + "target": "com.amazonaws.configservice#RuleLimit", + "traits": { + "smithy.api#documentation": "

The number of rule evaluation results that you want\n\t\t\treturned.

\n\t\t\n\t\t

This parameter is required if the rule limit for your account\n\t\t\tis more than the default of 150 rules.

\n\t\t

For information about requesting a rule limit increase, see\n\t\t\t\tAWS Config Limits in the AWS General\n\t\t\t\tReference Guide.

" + } } }, "traits": { @@ -3125,17 +3124,17 @@ "com.amazonaws.configservice#DescribeConfigRulesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" - } - }, "ConfigRuleNames": { "target": "com.amazonaws.configservice#ConfigRuleNames", "traits": { "smithy.api#documentation": "

The names of the AWS Config rules for which you want details.\n\t\t\tIf you do not specify any names, AWS Config returns details for all\n\t\t\tyour rules.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" + } } }, "traits": { @@ -3197,10 +3196,10 @@ "smithy.api#documentation": "

Filters the status type.

\n\t\t " } }, - "NextToken": { - "target": "com.amazonaws.configservice#String", + "Limit": { + "target": "com.amazonaws.configservice#Limit", "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" + "smithy.api#documentation": "

The maximum number of AggregatorSourceStatus returned on each\n\t\t\tpage. The default is maximum. If you specify 0, AWS Config uses the\n\t\t\tdefault.

" } }, "ConfigurationAggregatorName": { @@ -3210,10 +3209,10 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.configservice#Limit", + "NextToken": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The maximum number of AggregatorSourceStatus returned on each\n\t\t\tpage. The default is maximum. If you specify 0, AWS Config uses the\n\t\t\tdefault.

" + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" } } } @@ -3438,11 +3437,10 @@ "smithy.api#documentation": "

A ConformancePackComplianceFilters object.

" } }, - "ConformancePackName": { - "target": "com.amazonaws.configservice#ConformancePackName", - "traits": { - "smithy.api#documentation": "

Name of the conformance pack.

", - "smithy.api#required": {} + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" } }, "Limit": { @@ -3451,10 +3449,11 @@ "smithy.api#documentation": "

The maximum number of AWS Config rules within a conformance pack are returned on each page.

" } }, - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", + "ConformancePackName": { + "target": "com.amazonaws.configservice#ConformancePackName", "traits": { - "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" + "smithy.api#documentation": "

Name of the conformance pack.

", + "smithy.api#required": {} } } } @@ -3469,18 +3468,18 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" - } - }, "ConformancePackName": { "target": "com.amazonaws.configservice#ConformancePackName", "traits": { "smithy.api#documentation": "

Name of the conformance pack.

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" + } } } }, @@ -3738,34 +3737,34 @@ "smithy.api#documentation": "

The names of organization config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg rules.

" } }, - "NextToken": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" - } - }, "Limit": { "target": "com.amazonaws.configservice#CosmosPageLimit", "traits": { "smithy.api#documentation": "

The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } } } }, "com.amazonaws.configservice#DescribeOrganizationConfigRuleStatusesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" - } - }, "OrganizationConfigRuleStatuses": { "target": "com.amazonaws.configservice#OrganizationConfigRuleStatuses", "traits": { "smithy.api#documentation": "

A list of OrganizationConfigRuleStatus objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } } } }, @@ -3870,34 +3869,34 @@ "smithy.api#documentation": "

The maximum number of OrganizationConformancePackStatuses returned on each page. \n\t\t\tIf you do no specify a number, AWS Config uses the default. The default is 100.

" } }, - "OrganizationConformancePackNames": { - "target": "com.amazonaws.configservice#OrganizationConformancePackNames", - "traits": { - "smithy.api#documentation": "

The names of organization conformance packs for which you want status details. \n\t\t\tIf you do not specify any names, AWS Config returns details for all your organization conformance packs.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } + }, + "OrganizationConformancePackNames": { + "target": "com.amazonaws.configservice#OrganizationConformancePackNames", + "traits": { + "smithy.api#documentation": "

The names of organization conformance packs for which you want status details. \n\t\t\tIf you do not specify any names, AWS Config returns details for all your organization conformance packs.

" + } } } }, "com.amazonaws.configservice#DescribeOrganizationConformancePackStatusesResponse": { "type": "structure", "members": { - "OrganizationConformancePackStatuses": { - "target": "com.amazonaws.configservice#OrganizationConformancePackStatuses", - "traits": { - "smithy.api#documentation": "

A list of OrganizationConformancePackStatus objects.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } + }, + "OrganizationConformancePackStatuses": { + "target": "com.amazonaws.configservice#OrganizationConformancePackStatuses", + "traits": { + "smithy.api#documentation": "

A list of OrganizationConformancePackStatus objects.

" + } } } }, @@ -3953,17 +3952,17 @@ "com.amazonaws.configservice#DescribeOrganizationConformancePacksResponse": { "type": "structure", "members": { - "OrganizationConformancePacks": { - "target": "com.amazonaws.configservice#OrganizationConformancePacks", - "traits": { - "smithy.api#documentation": "

Returns a list of OrganizationConformancePacks objects.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a\n\t\t\tpaginated response.

" } + }, + "OrganizationConformancePacks": { + "target": "com.amazonaws.configservice#OrganizationConformancePacks", + "traits": { + "smithy.api#documentation": "

Returns a list of OrganizationConformancePacks objects.

" + } } } }, @@ -4002,17 +4001,17 @@ "com.amazonaws.configservice#DescribePendingAggregationRequestsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.configservice#DescribePendingAggregationRequestsLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is maximum. If you specify 0, AWS Config uses the\n\t\t\tdefault.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" } + }, + "Limit": { + "target": "com.amazonaws.configservice#DescribePendingAggregationRequestsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is maximum. If you specify 0, AWS Config uses the\n\t\t\tdefault.

" + } } } }, @@ -4102,6 +4101,13 @@ "smithy.api#documentation": "

The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, AWS Config uses the default.

" } }, + "ConfigRuleName": { + "target": "com.amazonaws.configservice#ConfigRuleName", + "traits": { + "smithy.api#documentation": "

The name of the AWS Config rule.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { @@ -4113,30 +4119,23 @@ "traits": { "smithy.api#documentation": "

An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

" } - }, - "ConfigRuleName": { - "target": "com.amazonaws.configservice#ConfigRuleName", - "traits": { - "smithy.api#documentation": "

The name of the AWS Config rule.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.configservice#DescribeRemediationExceptionsResponse": { "type": "structure", "members": { - "RemediationExceptions": { - "target": "com.amazonaws.configservice#RemediationExceptions", - "traits": { - "smithy.api#documentation": "

Returns a list of remediation exception objects.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" } + }, + "RemediationExceptions": { + "target": "com.amazonaws.configservice#RemediationExceptions", + "traits": { + "smithy.api#documentation": "

Returns a list of remediation exception objects.

" + } } } }, @@ -4169,12 +4168,6 @@ "com.amazonaws.configservice#DescribeRemediationExecutionStatusRequest": { "type": "structure", "members": { - "ResourceKeys": { - "target": "com.amazonaws.configservice#ResourceKeys", - "traits": { - "smithy.api#documentation": "

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { @@ -4193,23 +4186,29 @@ "smithy.api#documentation": "

A list of AWS Config rule names.

", "smithy.api#required": {} } + }, + "ResourceKeys": { + "target": "com.amazonaws.configservice#ResourceKeys", + "traits": { + "smithy.api#documentation": "

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

" + } } } }, "com.amazonaws.configservice#DescribeRemediationExecutionStatusResponse": { "type": "structure", "members": { - "RemediationExecutionStatuses": { - "target": "com.amazonaws.configservice#RemediationExecutionStatuses", - "traits": { - "smithy.api#documentation": "

Returns a list of remediation execution statuses objects.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } + }, + "RemediationExecutionStatuses": { + "target": "com.amazonaws.configservice#RemediationExecutionStatuses", + "traits": { + "smithy.api#documentation": "

Returns a list of remediation execution statuses objects.

" + } } } }, @@ -4239,34 +4238,34 @@ "com.amazonaws.configservice#DescribeRetentionConfigurationsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" - } - }, "RetentionConfigurationNames": { "target": "com.amazonaws.configservice#RetentionConfigurationNameList", "traits": { "smithy.api#documentation": "

A list of names of retention configurations for which you want\n\t\t\tdetails. If you do not specify a name, AWS Config returns details\n\t\t\tfor all the retention configurations for that account.

\n\t\t \n\t\t\t

Currently, AWS Config supports only one retention\n\t\t\t\tconfiguration per region in your account.

\n\t\t " } + }, + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" + } } } }, "com.amazonaws.configservice#DescribeRetentionConfigurationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" - } - }, "RetentionConfigurations": { "target": "com.amazonaws.configservice#RetentionConfigurationList", "traits": { "smithy.api#documentation": "

Returns a retention configuration object.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" + } } } }, @@ -4315,18 +4314,18 @@ "smithy.api#required": {} } }, - "Annotation": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", - "traits": { - "smithy.api#documentation": "

Supplementary information about how the evaluation determined\n\t\t\tthe compliance.

" - } - }, "OrderingTimestamp": { "target": "com.amazonaws.configservice#OrderingTimestamp", "traits": { "smithy.api#documentation": "

The time of the event in AWS Config that triggered the\n\t\t\tevaluation. For event-based evaluations, the time indicates when AWS\n\t\t\tConfig created the configuration item that triggered the evaluation.\n\t\t\tFor periodic evaluations, the time indicates when AWS Config\n\t\t\ttriggered the evaluation at the frequency that you specified (for\n\t\t\texample, every 24 hours).

", "smithy.api#required": {} } + }, + "Annotation": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", + "traits": { + "smithy.api#documentation": "

Supplementary information about how the evaluation determined\n\t\t\tthe compliance.

" + } } }, "traits": { @@ -4336,24 +4335,6 @@ "com.amazonaws.configservice#EvaluationResult": { "type": "structure", "members": { - "Annotation": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", - "traits": { - "smithy.api#documentation": "

Supplementary information about how the evaluation determined\n\t\t\tthe compliance.

" - } - }, - "ConfigRuleInvokedTime": { - "target": "com.amazonaws.configservice#Date", - "traits": { - "smithy.api#documentation": "

The time when the AWS Config rule evaluated the AWS\n\t\t\tresource.

" - } - }, - "ResultRecordedTime": { - "target": "com.amazonaws.configservice#Date", - "traits": { - "smithy.api#documentation": "

The time when AWS Config recorded the evaluation\n\t\t\tresult.

" - } - }, "EvaluationResultIdentifier": { "target": "com.amazonaws.configservice#EvaluationResultIdentifier", "traits": { @@ -4371,6 +4352,24 @@ "traits": { "smithy.api#documentation": "

An encrypted token that associates an evaluation with an AWS\n\t\t\tConfig rule. The token identifies the rule, the AWS resource being\n\t\t\tevaluated, and the event that triggered the evaluation.

" } + }, + "ConfigRuleInvokedTime": { + "target": "com.amazonaws.configservice#Date", + "traits": { + "smithy.api#documentation": "

The time when the AWS Config rule evaluated the AWS\n\t\t\tresource.

" + } + }, + "ResultRecordedTime": { + "target": "com.amazonaws.configservice#Date", + "traits": { + "smithy.api#documentation": "

The time when AWS Config recorded the evaluation\n\t\t\tresult.

" + } + }, + "Annotation": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", + "traits": { + "smithy.api#documentation": "

Supplementary information about how the evaluation determined\n\t\t\tthe compliance.

" + } } }, "traits": { @@ -4400,12 +4399,6 @@ "com.amazonaws.configservice#EvaluationResultQualifier": { "type": "structure", "members": { - "ConfigRuleName": { - "target": "com.amazonaws.configservice#ConfigRuleName", - "traits": { - "smithy.api#documentation": "

The name of the AWS Config rule that was used in the\n\t\t\tevaluation.

" - } - }, "ResourceId": { "target": "com.amazonaws.configservice#BaseResourceId", "traits": { @@ -4417,6 +4410,12 @@ "traits": { "smithy.api#documentation": "

The type of AWS resource that was evaluated.

" } + }, + "ConfigRuleName": { + "target": "com.amazonaws.configservice#ConfigRuleName", + "traits": { + "smithy.api#documentation": "

The name of the AWS Config rule that was used in the\n\t\t\tevaluation.

" + } } }, "traits": { @@ -4542,17 +4541,17 @@ "com.amazonaws.configservice#FailedRemediationExceptionBatch": { "type": "structure", "members": { - "FailureMessage": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

Returns a failure message. For example, the auto-remediation has failed.

" - } - }, "FailedItems": { "target": "com.amazonaws.configservice#RemediationExceptions", "traits": { "smithy.api#documentation": "

Returns remediation exception resource key object of the failed items.

" } + }, + "FailureMessage": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

Returns a failure message. For example, the auto-remediation has failed.

" + } } }, "traits": { @@ -4617,23 +4616,17 @@ "com.amazonaws.configservice#GetAggregateComplianceDetailsByConfigRuleRequest": { "type": "structure", "members": { - "AwsRegion": { - "target": "com.amazonaws.configservice#AwsRegion", - "traits": { - "smithy.api#documentation": "

The source region from where the data is aggregated.

", - "smithy.api#required": {} - } - }, "Limit": { "target": "com.amazonaws.configservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is 50. You cannot specify a number greater than 100. If\n\t\t\tyou specify 0, AWS Config uses the default.

" } }, - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", + "ConfigurationAggregatorName": { + "target": "com.amazonaws.configservice#ConfigurationAggregatorName", "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" + "smithy.api#documentation": "

The name of the configuration aggregator.

", + "smithy.api#required": {} } }, "ConfigRuleName": { @@ -4643,17 +4636,17 @@ "smithy.api#required": {} } }, - "ComplianceType": { - "target": "com.amazonaws.configservice#ComplianceType", + "AwsRegion": { + "target": "com.amazonaws.configservice#AwsRegion", "traits": { - "smithy.api#documentation": "

The resource compliance status.

\n\t\t \n\t\t\t

For the\n\t\t\t\t\tGetAggregateComplianceDetailsByConfigRuleRequest\n\t\t\t\tdata type, AWS Config supports only the COMPLIANT\n\t\t\t\tand NON_COMPLIANT. AWS Config does not support the\n\t\t\t\t\tNOT_APPLICABLE and\n\t\t\t\t\tINSUFFICIENT_DATA values.

\n\t\t " + "smithy.api#documentation": "

The source region from where the data is aggregated.

", + "smithy.api#required": {} } }, - "ConfigurationAggregatorName": { - "target": "com.amazonaws.configservice#ConfigurationAggregatorName", + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", "traits": { - "smithy.api#documentation": "

The name of the configuration aggregator.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" } }, "AccountId": { @@ -4662,23 +4655,29 @@ "smithy.api#documentation": "

The 12-digit account ID of the source account.

", "smithy.api#required": {} } + }, + "ComplianceType": { + "target": "com.amazonaws.configservice#ComplianceType", + "traits": { + "smithy.api#documentation": "

The resource compliance status.

\n\t\t \n\t\t\t

For the\n\t\t\t\t\tGetAggregateComplianceDetailsByConfigRuleRequest\n\t\t\t\tdata type, AWS Config supports only the COMPLIANT\n\t\t\t\tand NON_COMPLIANT. AWS Config does not support the\n\t\t\t\t\tNOT_APPLICABLE and\n\t\t\t\t\tINSUFFICIENT_DATA values.

\n\t\t " + } } } }, "com.amazonaws.configservice#GetAggregateComplianceDetailsByConfigRuleResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" - } - }, "AggregateEvaluationResults": { "target": "com.amazonaws.configservice#AggregateEvaluationResultList", "traits": { "smithy.api#documentation": "

Returns an AggregateEvaluationResults object.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" + } } } }, @@ -4711,11 +4710,10 @@ "com.amazonaws.configservice#GetAggregateConfigRuleComplianceSummaryRequest": { "type": "structure", "members": { - "ConfigurationAggregatorName": { - "target": "com.amazonaws.configservice#ConfigurationAggregatorName", + "Limit": { + "target": "com.amazonaws.configservice#GroupByAPILimit", "traits": { - "smithy.api#documentation": "

The name of the configuration aggregator.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is 1000. You cannot specify a number greater than 1000.\n\t\t\tIf you specify 0, AWS Config uses the default.

" } }, "GroupByKey": { @@ -4724,22 +4722,23 @@ "smithy.api#documentation": "

Groups the result based on ACCOUNT_ID or AWS_REGION.

" } }, - "Filters": { - "target": "com.amazonaws.configservice#ConfigRuleComplianceSummaryFilters", - "traits": { - "smithy.api#documentation": "

Filters the results based on the\n\t\t\tConfigRuleComplianceSummaryFilters object.

" - } - }, "NextToken": { "target": "com.amazonaws.configservice#NextToken", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use\n\t\t\tto get the next page of results in a paginated response.

" } }, - "Limit": { - "target": "com.amazonaws.configservice#GroupByAPILimit", + "Filters": { + "target": "com.amazonaws.configservice#ConfigRuleComplianceSummaryFilters", "traits": { - "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is 1000. You cannot specify a number greater than 1000.\n\t\t\tIf you specify 0, AWS Config uses the default.

" + "smithy.api#documentation": "

Filters the results based on the\n\t\t\tConfigRuleComplianceSummaryFilters object.

" + } + }, + "ConfigurationAggregatorName": { + "target": "com.amazonaws.configservice#ConfigurationAggregatorName", + "traits": { + "smithy.api#documentation": "

The name of the configuration aggregator.

", + "smithy.api#required": {} } } } @@ -4802,17 +4801,10 @@ "smithy.api#documentation": "

The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.

" } }, - "ConfigurationAggregatorName": { - "target": "com.amazonaws.configservice#ConfigurationAggregatorName", - "traits": { - "smithy.api#documentation": "

The name of the configuration aggregator.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", + "GroupByKey": { + "target": "com.amazonaws.configservice#ResourceCountGroupKey", "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + "smithy.api#documentation": "

The key to group the resource counts.

" } }, "Filters": { @@ -4821,10 +4813,17 @@ "smithy.api#documentation": "

Filters the results based on the ResourceCountFilters object.

" } }, - "GroupByKey": { - "target": "com.amazonaws.configservice#ResourceCountGroupKey", + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", "traits": { - "smithy.api#documentation": "

The key to group the resource counts.

" + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "ConfigurationAggregatorName": { + "target": "com.amazonaws.configservice#ConfigurationAggregatorName", + "traits": { + "smithy.api#documentation": "

The name of the configuration aggregator.

", + "smithy.api#required": {} } } } @@ -4832,16 +4831,16 @@ "com.amazonaws.configservice#GetAggregateDiscoveredResourceCountsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", + "GroupedResourceCounts": { + "target": "com.amazonaws.configservice#GroupedResourceCountList", "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + "smithy.api#documentation": "

Returns a list of GroupedResourceCount objects.

" } }, - "GroupByKey": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", "traits": { - "smithy.api#documentation": "

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

" + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "TotalDiscoveredResources": { @@ -4851,10 +4850,10 @@ "smithy.api#required": {} } }, - "GroupedResourceCounts": { - "target": "com.amazonaws.configservice#GroupedResourceCountList", + "GroupByKey": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

Returns a list of GroupedResourceCount objects.

" + "smithy.api#documentation": "

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

" } } } @@ -4888,17 +4887,17 @@ "com.amazonaws.configservice#GetAggregateResourceConfigRequest": { "type": "structure", "members": { - "ConfigurationAggregatorName": { - "target": "com.amazonaws.configservice#ConfigurationAggregatorName", + "ResourceIdentifier": { + "target": "com.amazonaws.configservice#AggregateResourceIdentifier", "traits": { - "smithy.api#documentation": "

The name of the configuration aggregator.

", + "smithy.api#documentation": "

An object that identifies aggregate resource.

", "smithy.api#required": {} } }, - "ResourceIdentifier": { - "target": "com.amazonaws.configservice#AggregateResourceIdentifier", + "ConfigurationAggregatorName": { + "target": "com.amazonaws.configservice#ConfigurationAggregatorName", "traits": { - "smithy.api#documentation": "

An object that identifies aggregate resource.

", + "smithy.api#documentation": "

The name of the configuration aggregator.

", "smithy.api#required": {} } } @@ -4941,10 +4940,11 @@ "com.amazonaws.configservice#GetComplianceDetailsByConfigRuleRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.configservice#Limit", + "ConfigRuleName": { + "target": "com.amazonaws.configservice#StringWithCharLimit64", "traits": { - "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is 10. You cannot specify a number greater than 100. If\n\t\t\tyou specify 0, AWS Config uses the default.

" + "smithy.api#documentation": "

The name of the AWS Config rule for which you want compliance\n\t\t\tinformation.

", + "smithy.api#required": {} } }, "NextToken": { @@ -4953,11 +4953,10 @@ "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" } }, - "ConfigRuleName": { - "target": "com.amazonaws.configservice#StringWithCharLimit64", + "Limit": { + "target": "com.amazonaws.configservice#Limit", "traits": { - "smithy.api#documentation": "

The name of the AWS Config rule for which you want compliance\n\t\t\tinformation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of evaluation results returned on each page.\n\t\t\tThe default is 10. You cannot specify a number greater than 100. If\n\t\t\tyou specify 0, AWS Config uses the default.

" } }, "ComplianceTypes": { @@ -5024,18 +5023,18 @@ "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" } }, - "ComplianceTypes": { - "target": "com.amazonaws.configservice#ComplianceTypes", - "traits": { - "smithy.api#documentation": "

Filters the results by compliance.

\n\t\t

The allowed values are COMPLIANT,\n\t\t\t\tNON_COMPLIANT, and\n\t\t\tNOT_APPLICABLE.

" - } - }, "ResourceType": { "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { "smithy.api#documentation": "

The type of the AWS resource for which you want compliance\n\t\t\tinformation.

", "smithy.api#required": {} } + }, + "ComplianceTypes": { + "target": "com.amazonaws.configservice#ComplianceTypes", + "traits": { + "smithy.api#documentation": "

Filters the results by compliance.

\n\t\t

The allowed values are COMPLIANT,\n\t\t\t\tNON_COMPLIANT, and\n\t\t\tNOT_APPLICABLE.

" + } } }, "traits": { @@ -5207,18 +5206,18 @@ "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" } }, + "ConformancePackRuleEvaluationResults": { + "target": "com.amazonaws.configservice#ConformancePackRuleEvaluationResultsList", + "traits": { + "smithy.api#documentation": "

Returns a list of ConformancePackEvaluationResult objects.

" + } + }, "ConformancePackName": { "target": "com.amazonaws.configservice#ConformancePackName", "traits": { "smithy.api#documentation": "

Name of the conformance pack.

", "smithy.api#required": {} } - }, - "ConformancePackRuleEvaluationResults": { - "target": "com.amazonaws.configservice#ConformancePackRuleEvaluationResultsList", - "traits": { - "smithy.api#documentation": "

Returns a list of ConformancePackEvaluationResult objects.

" - } } } }, @@ -5318,17 +5317,17 @@ "smithy.api#documentation": "

The comma-separated list that specifies the resource types that\n\t\t\tyou want AWS Config to return (for example,\n\t\t\t\t\"AWS::EC2::Instance\",\n\t\t\t\"AWS::IAM::User\").

\n\n\t\t

If a value for resourceTypes is not specified, AWS\n\t\t\tConfig returns all resource types that AWS Config is recording in\n\t\t\tthe region for your account.

\n\t\t \n\t\t\t

If the configuration recorder is turned off, AWS Config\n\t\t\t\treturns an empty list of ResourceCount\n\t\t\t\tobjects. If the configuration recorder is not recording a\n\t\t\t\tspecific resource type (for example, S3 buckets), that resource\n\t\t\t\ttype is not returned in the list of ResourceCount objects.

\n\t\t " } }, - "limit": { - "target": "com.amazonaws.configservice#Limit", - "traits": { - "smithy.api#documentation": "

The maximum number of ResourceCount objects\n\t\t\treturned on each page. The default is 100. You cannot specify a\n\t\t\tnumber greater than 100. If you specify 0, AWS Config uses the\n\t\t\tdefault.

" - } - }, "nextToken": { "target": "com.amazonaws.configservice#NextToken", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" } + }, + "limit": { + "target": "com.amazonaws.configservice#Limit", + "traits": { + "smithy.api#documentation": "

The maximum number of ResourceCount objects\n\t\t\treturned on each page. The default is 100. You cannot specify a\n\t\t\tnumber greater than 100. If you specify 0, AWS Config uses the\n\t\t\tdefault.

" + } } } }, @@ -5384,6 +5383,12 @@ "com.amazonaws.configservice#GetOrganizationConfigRuleDetailedStatusRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, "Filters": { "target": "com.amazonaws.configservice#StatusDetailFilters", "traits": { @@ -5402,29 +5407,23 @@ "traits": { "smithy.api#documentation": "

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.

" } - }, - "NextToken": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" - } } } }, "com.amazonaws.configservice#GetOrganizationConfigRuleDetailedStatusResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" - } - }, "OrganizationConfigRuleDetailedStatus": { "target": "com.amazonaws.configservice#OrganizationConfigRuleDetailedStatus", "traits": { "smithy.api#documentation": "

A list of MemberAccountStatus objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } } } }, @@ -5463,6 +5462,12 @@ "smithy.api#documentation": "

An OrganizationResourceDetailedStatusFilters object.

" } }, + "NextToken": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, "OrganizationConformancePackName": { "target": "com.amazonaws.configservice#OrganizationConformancePackName", "traits": { @@ -5470,12 +5475,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" - } - }, "Limit": { "target": "com.amazonaws.configservice#CosmosPageLimit", "traits": { @@ -5487,17 +5486,17 @@ "com.amazonaws.configservice#GetOrganizationConformancePackDetailedStatusResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" - } - }, "OrganizationConformancePackDetailedStatuses": { "target": "com.amazonaws.configservice#OrganizationConformancePackDetailedStatuses", "traits": { "smithy.api#documentation": "

A list of OrganizationConformancePackDetailedStatus objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } } } }, @@ -5542,17 +5541,10 @@ "com.amazonaws.configservice#GetResourceConfigHistoryRequest": { "type": "structure", "members": { - "laterTime": { - "target": "com.amazonaws.configservice#LaterTime", - "traits": { - "smithy.api#documentation": "

The time stamp that indicates a later time. If not specified,\n\t\t\tcurrent time is taken.

" - } - }, - "resourceId": { - "target": "com.amazonaws.configservice#ResourceId", + "limit": { + "target": "com.amazonaws.configservice#Limit", "traits": { - "smithy.api#documentation": "

The ID of the resource (for example.,\n\t\t\tsg-xxxxxx).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of configuration items returned on each\n\t\t\tpage. The default is 10. You cannot specify a number greater than\n\t\t\t100. If you specify 0, AWS Config uses the default.

" } }, "nextToken": { @@ -5561,12 +5553,6 @@ "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" } }, - "earlierTime": { - "target": "com.amazonaws.configservice#EarlierTime", - "traits": { - "smithy.api#documentation": "

The time stamp that indicates an earlier time. If not\n\t\t\tspecified, the action returns paginated results that contain\n\t\t\tconfiguration items that start when the first configuration item was\n\t\t\trecorded.

" - } - }, "resourceType": { "target": "com.amazonaws.configservice#ResourceType", "traits": { @@ -5574,16 +5560,29 @@ "smithy.api#required": {} } }, + "earlierTime": { + "target": "com.amazonaws.configservice#EarlierTime", + "traits": { + "smithy.api#documentation": "

The time stamp that indicates an earlier time. If not\n\t\t\tspecified, the action returns paginated results that contain\n\t\t\tconfiguration items that start when the first configuration item was\n\t\t\trecorded.

" + } + }, "chronologicalOrder": { "target": "com.amazonaws.configservice#ChronologicalOrder", "traits": { "smithy.api#documentation": "

The chronological order for configuration items listed. By\n\t\t\tdefault, the results are listed in reverse chronological\n\t\t\torder.

" } }, - "limit": { - "target": "com.amazonaws.configservice#Limit", + "laterTime": { + "target": "com.amazonaws.configservice#LaterTime", "traits": { - "smithy.api#documentation": "

The maximum number of configuration items returned on each\n\t\t\tpage. The default is 10. You cannot specify a number greater than\n\t\t\t100. If you specify 0, AWS Config uses the default.

" + "smithy.api#documentation": "

The time stamp that indicates a later time. If not specified,\n\t\t\tcurrent time is taken.

" + } + }, + "resourceId": { + "target": "com.amazonaws.configservice#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource (for example.,\n\t\t\tsg-xxxxxx).

", + "smithy.api#required": {} } } }, @@ -5591,20 +5590,20 @@ "smithy.api#documentation": "

The input for the GetResourceConfigHistory\n\t\t\taction.

" } }, - "com.amazonaws.configservice#GetResourceConfigHistoryResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The string that you use in a subsequent request to get the next\n\t\t\tpage of results in a paginated response.

" - } - }, + "com.amazonaws.configservice#GetResourceConfigHistoryResponse": { + "type": "structure", + "members": { "configurationItems": { "target": "com.amazonaws.configservice#ConfigurationItemList", "traits": { "smithy.api#documentation": "

A list that contains the configuration history of one or more\n\t\t\tresources.

" } + }, + "nextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The string that you use in a subsequent request to get the next\n\t\t\tpage of results in a paginated response.

" + } } }, "traits": { @@ -5941,31 +5940,31 @@ "smithy.api#documentation": "

Filters the results based on the ResourceFilters object.

" } }, - "ResourceType": { - "target": "com.amazonaws.configservice#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resources that you want AWS Config to list in the response.

", - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.configservice#NextToken", "traits": { "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, - "Limit": { - "target": "com.amazonaws.configservice#Limit", - "traits": { - "smithy.api#documentation": "

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" - } - }, "ConfigurationAggregatorName": { "target": "com.amazonaws.configservice#ConfigurationAggregatorName", "traits": { "smithy.api#documentation": "

The name of the configuration aggregator.

", "smithy.api#required": {} } + }, + "ResourceType": { + "target": "com.amazonaws.configservice#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resources that you want AWS Config to list in the response.

", + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.configservice#Limit", + "traits": { + "smithy.api#documentation": "

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + } } } }, @@ -6021,16 +6020,22 @@ "smithy.api#documentation": "

The maximum number of resource identifiers returned on each\n\t\t\tpage. The default is 100. You cannot specify a number greater than\n\t\t\t100. If you specify 0, AWS Config uses the default.

" } }, - "includeDeletedResources": { - "target": "com.amazonaws.configservice#Boolean", + "resourceName": { + "target": "com.amazonaws.configservice#ResourceName", "traits": { - "smithy.api#documentation": "

Specifies whether AWS Config includes deleted resources in the\n\t\t\tresults. By default, deleted resources are not included.

" + "smithy.api#documentation": "

The custom name of only those resources that you want AWS\n\t\t\tConfig to list in the response. If you do not specify this\n\t\t\tparameter, AWS Config lists all resources of the specified type that\n\t\t\tit has discovered.

" } }, - "nextToken": { - "target": "com.amazonaws.configservice#NextToken", + "resourceIds": { + "target": "com.amazonaws.configservice#ResourceIdList", "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" + "smithy.api#documentation": "

The IDs of only those resources that you want AWS Config to\n\t\t\tlist in the response. If you do not specify this parameter, AWS\n\t\t\tConfig lists all resources of the specified type that it has\n\t\t\tdiscovered.

" + } + }, + "includeDeletedResources": { + "target": "com.amazonaws.configservice#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether AWS Config includes deleted resources in the\n\t\t\tresults. By default, deleted resources are not included.

" } }, "resourceType": { @@ -6040,16 +6045,10 @@ "smithy.api#required": {} } }, - "resourceIds": { - "target": "com.amazonaws.configservice#ResourceIdList", - "traits": { - "smithy.api#documentation": "

The IDs of only those resources that you want AWS Config to\n\t\t\tlist in the response. If you do not specify this parameter, AWS\n\t\t\tConfig lists all resources of the specified type that it has\n\t\t\tdiscovered.

" - } - }, - "resourceName": { - "target": "com.amazonaws.configservice#ResourceName", + "nextToken": { + "target": "com.amazonaws.configservice#NextToken", "traits": { - "smithy.api#documentation": "

The custom name of only those resources that you want AWS\n\t\t\tConfig to list in the response. If you do not specify this\n\t\t\tparameter, AWS Config lists all resources of the specified type that\n\t\t\tit has discovered.

" + "smithy.api#documentation": "

The nextToken string returned on a previous page\n\t\t\tthat you use to get the next page of results in a paginated\n\t\t\tresponse.

" } } }, @@ -6060,17 +6059,17 @@ "com.amazonaws.configservice#ListDiscoveredResourcesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The string that you use in a subsequent request to get the next\n\t\t\tpage of results in a paginated response.

" - } - }, "resourceIdentifiers": { "target": "com.amazonaws.configservice#ResourceIdentifierList", "traits": { "smithy.api#documentation": "

The details that identify a resource that is discovered by AWS\n\t\t\tConfig, including the resource type, ID, and (if available) the\n\t\t\tcustom resource name.

" } + }, + "nextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The string that you use in a subsequent request to get the next\n\t\t\tpage of results in a paginated response.

" + } } }, "traits": { @@ -6106,10 +6105,11 @@ "com.amazonaws.configservice#ListTagsForResourceRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", + "ResourceArn": { + "target": "com.amazonaws.configservice#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

", + "smithy.api#required": {} } }, "Limit": { @@ -6118,11 +6118,10 @@ "smithy.api#documentation": "

The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default.

" } }, - "ResourceArn": { - "target": "com.amazonaws.configservice#AmazonResourceName", + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } } } @@ -6346,10 +6345,10 @@ "smithy.api#documentation": "

An error message indicating that config rule account creation or deletion has failed due to an error in the member account.

" } }, - "ConfigRuleName": { - "target": "com.amazonaws.configservice#StringWithCharLimit64", + "AccountId": { + "target": "com.amazonaws.configservice#AccountId", "traits": { - "smithy.api#documentation": "

The name of config rule deployed in the member account.

", + "smithy.api#documentation": "

The 12-digit account ID of a member account.

", "smithy.api#required": {} } }, @@ -6366,18 +6365,18 @@ "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.configservice#AccountId", - "traits": { - "smithy.api#documentation": "

The 12-digit account ID of a member account.

", - "smithy.api#required": {} - } - }, "ErrorCode": { "target": "com.amazonaws.configservice#String", "traits": { "smithy.api#documentation": "

An error code that is returned when config rule creation or deletion failed in the member account.

" } + }, + "ConfigRuleName": { + "target": "com.amazonaws.configservice#StringWithCharLimit64", + "traits": { + "smithy.api#documentation": "

The name of config rule deployed in the member account.

", + "smithy.api#required": {} + } } }, "traits": { @@ -6716,13 +6715,19 @@ "com.amazonaws.configservice#OrganizationConfigRule": { "type": "structure", "members": { - "OrganizationConfigRuleArn": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "OrganizationConfigRuleName": { + "target": "com.amazonaws.configservice#OrganizationConfigRuleName", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of organization config rule.

", + "smithy.api#documentation": "

The name that you assign to organization config rule.

", "smithy.api#required": {} } }, + "ExcludedAccounts": { + "target": "com.amazonaws.configservice#ExcludedAccounts", + "traits": { + "smithy.api#documentation": "

A comma-separated list of accounts excluded from organization config rule.

" + } + }, "OrganizationCustomRuleMetadata": { "target": "com.amazonaws.configservice#OrganizationCustomRuleMetadata", "traits": { @@ -6735,24 +6740,18 @@ "smithy.api#documentation": "

The timestamp of the last update.

" } }, - "ExcludedAccounts": { - "target": "com.amazonaws.configservice#ExcludedAccounts", + "OrganizationManagedRuleMetadata": { + "target": "com.amazonaws.configservice#OrganizationManagedRuleMetadata", "traits": { - "smithy.api#documentation": "

A comma-separated list of accounts excluded from organization config rule.

" + "smithy.api#documentation": "

An OrganizationManagedRuleMetadata object.

" } }, - "OrganizationConfigRuleName": { - "target": "com.amazonaws.configservice#OrganizationConfigRuleName", + "OrganizationConfigRuleArn": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

The name that you assign to organization config rule.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of organization config rule.

", "smithy.api#required": {} } - }, - "OrganizationManagedRuleMetadata": { - "target": "com.amazonaws.configservice#OrganizationManagedRuleMetadata", - "traits": { - "smithy.api#documentation": "

An OrganizationManagedRuleMetadata object.

" - } } }, "traits": { @@ -6803,6 +6802,12 @@ "smithy.api#documentation": "

An error message indicating that organization config rule creation or deletion failed due to an error.

" } }, + "ErrorCode": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

An error code that is returned when organization config rule creation or deletion has failed.

" + } + }, "OrganizationRuleStatus": { "target": "com.amazonaws.configservice#OrganizationRuleStatus", "traits": { @@ -6810,12 +6815,6 @@ "smithy.api#required": {} } }, - "ErrorCode": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

An error code that is returned when organization config rule creation or deletion has failed.

" - } - }, "LastUpdateTime": { "target": "com.amazonaws.configservice#Date", "traits": { @@ -6867,30 +6866,29 @@ "com.amazonaws.configservice#OrganizationConformancePack": { "type": "structure", "members": { - "DeliveryS3Bucket": { - "target": "com.amazonaws.configservice#DeliveryS3Bucket", + "OrganizationConformancePackArn": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

Location of an Amazon S3 bucket where AWS Config can \n\t\t\tdeliver evaluation results and conformance pack template that is used to create a pack.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of organization conformance pack.

", "smithy.api#required": {} } }, - "DeliveryS3KeyPrefix": { - "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", + "ExcludedAccounts": { + "target": "com.amazonaws.configservice#ExcludedAccounts", "traits": { - "smithy.api#documentation": "

Any folder structure you want to add to an Amazon S3 bucket.

" + "smithy.api#documentation": "

A comma-separated list of accounts excluded from organization conformance pack.

" } }, - "OrganizationConformancePackName": { - "target": "com.amazonaws.configservice#OrganizationConformancePackName", + "DeliveryS3KeyPrefix": { + "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", "traits": { - "smithy.api#documentation": "

The name you assign to an organization conformance pack.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Any folder structure you want to add to an Amazon S3 bucket.

" } }, - "ConformancePackInputParameters": { - "target": "com.amazonaws.configservice#ConformancePackInputParameters", + "DeliveryS3Bucket": { + "target": "com.amazonaws.configservice#DeliveryS3Bucket", "traits": { - "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" + "smithy.api#documentation": "

Location of an Amazon S3 bucket where AWS Config can \n\t\t\tdeliver evaluation results and conformance pack template that is used to create a pack.

" } }, "LastUpdateTime": { @@ -6900,17 +6898,17 @@ "smithy.api#required": {} } }, - "OrganizationConformancePackArn": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "ConformancePackInputParameters": { + "target": "com.amazonaws.configservice#ConformancePackInputParameters", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of organization conformance pack.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" } }, - "ExcludedAccounts": { - "target": "com.amazonaws.configservice#ExcludedAccounts", + "OrganizationConformancePackName": { + "target": "com.amazonaws.configservice#OrganizationConformancePackName", "traits": { - "smithy.api#documentation": "

A comma-separated list of accounts excluded from organization conformance pack.

" + "smithy.api#documentation": "

The name you assign to an organization conformance pack.

", + "smithy.api#required": {} } } }, @@ -6921,16 +6919,10 @@ "com.amazonaws.configservice#OrganizationConformancePackDetailedStatus": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.configservice#String", - "traits": { - "smithy.api#documentation": "

An error message indicating that conformance pack account creation or deletion \n\t\t\thas failed due to an error in the member account.

" - } - }, - "ConformancePackName": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "AccountId": { + "target": "com.amazonaws.configservice#AccountId", "traits": { - "smithy.api#documentation": "

The name of conformance pack deployed in the member account.

", + "smithy.api#documentation": "

The 12-digit account ID of a member account.

", "smithy.api#required": {} } }, @@ -6940,11 +6932,10 @@ "smithy.api#documentation": "

An error code that is returned when conformance pack creation or \n\t\t\tdeletion failed in the member account.

" } }, - "AccountId": { - "target": "com.amazonaws.configservice#AccountId", + "ErrorMessage": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The 12-digit account ID of a member account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An error message indicating that conformance pack account creation or deletion \n\t\t\thas failed due to an error in the member account.

" } }, "Status": { @@ -6959,6 +6950,13 @@ "traits": { "smithy.api#documentation": "

The timestamp of the last status update.

" } + }, + "ConformancePackName": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", + "traits": { + "smithy.api#documentation": "

The name of conformance pack deployed in the member account.

", + "smithy.api#required": {} + } } }, "traits": { @@ -6996,10 +6994,10 @@ "com.amazonaws.configservice#OrganizationConformancePackStatus": { "type": "structure", "members": { - "LastUpdateTime": { - "target": "com.amazonaws.configservice#Date", + "ErrorCode": { + "target": "com.amazonaws.configservice#String", "traits": { - "smithy.api#documentation": "

The timestamp of the last update.

" + "smithy.api#documentation": "

An error code that is returned when organization conformance pack creation or deletion has failed in a member account.

" } }, "Status": { @@ -7009,10 +7007,10 @@ "smithy.api#required": {} } }, - "ErrorCode": { - "target": "com.amazonaws.configservice#String", + "LastUpdateTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

An error code that is returned when organization conformance pack creation or deletion has failed in a member account.

" + "smithy.api#documentation": "

The timestamp of the last update.

" } }, "ErrorMessage": { @@ -7063,22 +7061,23 @@ "com.amazonaws.configservice#OrganizationCustomRuleMetadata": { "type": "structure", "members": { - "TagKeyScope": { - "target": "com.amazonaws.configservice#StringWithCharLimit128", + "TagValueScope": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that make up a tag. \n\t\t\tA key is a general label that acts like a category for more specific tag values.

" + "smithy.api#documentation": "

The optional part of a key-value pair that make up a tag. \n\t\t\tA value acts as a descriptor within a tag category (key).

" } }, - "ResourceTypesScope": { - "target": "com.amazonaws.configservice#ResourceTypesScope", + "LambdaFunctionArn": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

The type of the AWS resource that was evaluated.

" + "smithy.api#documentation": "

The lambda function ARN.

", + "smithy.api#required": {} } }, - "InputParameters": { - "target": "com.amazonaws.configservice#StringWithCharLimit2048", + "MaximumExecutionFrequency": { + "target": "com.amazonaws.configservice#MaximumExecutionFrequency", "traits": { - "smithy.api#documentation": "

A string, in JSON format, that is passed to organization config rule Lambda function.

" + "smithy.api#documentation": "

The maximum frequency with which AWS Config runs evaluations for a rule. \n\t\t\tYour custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

\n\t\t \n

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid \n\t\t\tvalue for the MaximumExecutionFrequency parameter.

\n " } }, "OrganizationConfigRuleTriggerTypes": { @@ -7088,17 +7087,16 @@ "smithy.api#required": {} } }, - "MaximumExecutionFrequency": { - "target": "com.amazonaws.configservice#MaximumExecutionFrequency", + "InputParameters": { + "target": "com.amazonaws.configservice#StringWithCharLimit2048", "traits": { - "smithy.api#documentation": "

The maximum frequency with which AWS Config runs evaluations for a rule. \n\t\t\tYour custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

\n\t\t \n

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid \n\t\t\tvalue for the MaximumExecutionFrequency parameter.

\n " + "smithy.api#documentation": "

A string, in JSON format, that is passed to organization config rule Lambda function.

" } }, - "LambdaFunctionArn": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "ResourceIdScope": { + "target": "com.amazonaws.configservice#StringWithCharLimit768", "traits": { - "smithy.api#documentation": "

The lambda function ARN.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the AWS resource that was evaluated.

" } }, "Description": { @@ -7107,16 +7105,16 @@ "smithy.api#documentation": "

The description that you provide for organization config rule.

" } }, - "TagValueScope": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "TagKeyScope": { + "target": "com.amazonaws.configservice#StringWithCharLimit128", "traits": { - "smithy.api#documentation": "

The optional part of a key-value pair that make up a tag. \n\t\t\tA value acts as a descriptor within a tag category (key).

" + "smithy.api#documentation": "

One part of a key-value pair that make up a tag. \n\t\t\tA key is a general label that acts like a category for more specific tag values.

" } }, - "ResourceIdScope": { - "target": "com.amazonaws.configservice#StringWithCharLimit768", + "ResourceTypesScope": { + "target": "com.amazonaws.configservice#ResourceTypesScope", "traits": { - "smithy.api#documentation": "

The ID of the AWS resource that was evaluated.

" + "smithy.api#documentation": "

The type of the AWS resource that was evaluated.

" } } }, @@ -7127,22 +7125,11 @@ "com.amazonaws.configservice#OrganizationManagedRuleMetadata": { "type": "structure", "members": { - "ResourceTypesScope": { - "target": "com.amazonaws.configservice#ResourceTypesScope", - "traits": { - "smithy.api#documentation": "

The type of the AWS resource that was evaluated.

" - } - }, - "TagKeyScope": { - "target": "com.amazonaws.configservice#StringWithCharLimit128", - "traits": { - "smithy.api#documentation": "

One part of a key-value pair that make up a tag. \n\t\t\tA key is a general label that acts like a category for more specific tag values.

" - } - }, - "InputParameters": { - "target": "com.amazonaws.configservice#StringWithCharLimit2048", + "RuleIdentifier": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { - "smithy.api#documentation": "

A string, in JSON format, that is passed to organization config rule Lambda function.

" + "smithy.api#documentation": "

For organization config managed rules, a predefined identifier from a\n\t\t\tlist. For example, IAM_PASSWORD_POLICY is a managed\n\t\t\trule. To reference a managed rule, see Using AWS Managed Config Rules.

", + "smithy.api#required": {} } }, "MaximumExecutionFrequency": { @@ -7157,10 +7144,16 @@ "smithy.api#documentation": "

The ID of the AWS resource that was evaluated.

" } }, - "Description": { - "target": "com.amazonaws.configservice#StringWithCharLimit256Min0", + "InputParameters": { + "target": "com.amazonaws.configservice#StringWithCharLimit2048", "traits": { - "smithy.api#documentation": "

The description that you provide for organization config rule.

" + "smithy.api#documentation": "

A string, in JSON format, that is passed to organization config rule Lambda function.

" + } + }, + "TagKeyScope": { + "target": "com.amazonaws.configservice#StringWithCharLimit128", + "traits": { + "smithy.api#documentation": "

One part of a key-value pair that make up a tag. \n\t\t\tA key is a general label that acts like a category for more specific tag values.

" } }, "TagValueScope": { @@ -7169,11 +7162,16 @@ "smithy.api#documentation": "

The optional part of a key-value pair that make up a tag. \n\t\t\tA value acts as a descriptor within a tag category (key).

" } }, - "RuleIdentifier": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "ResourceTypesScope": { + "target": "com.amazonaws.configservice#ResourceTypesScope", "traits": { - "smithy.api#documentation": "

For organization config managed rules, a predefined identifier from a\n\t\t\tlist. For example, IAM_PASSWORD_POLICY is a managed\n\t\t\trule. To reference a managed rule, see Using AWS Managed Config Rules.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The type of the AWS resource that was evaluated.

" + } + }, + "Description": { + "target": "com.amazonaws.configservice#StringWithCharLimit256Min0", + "traits": { + "smithy.api#documentation": "

The description that you provide for organization config rule.

" } } }, @@ -7443,11 +7441,10 @@ "com.amazonaws.configservice#PutAggregationAuthorizationRequest": { "type": "structure", "members": { - "AuthorizedAccountId": { - "target": "com.amazonaws.configservice#AccountId", + "Tags": { + "target": "com.amazonaws.configservice#TagsList", "traits": { - "smithy.api#documentation": "

The 12-digit account ID of the account authorized to aggregate data.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of tag object.

" } }, "AuthorizedAwsRegion": { @@ -7457,10 +7454,11 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.configservice#TagsList", + "AuthorizedAccountId": { + "target": "com.amazonaws.configservice#AccountId", "traits": { - "smithy.api#documentation": "

An array of tag object.

" + "smithy.api#documentation": "

The 12-digit account ID of the account authorized to aggregate data.

", + "smithy.api#required": {} } } } @@ -7505,18 +7503,18 @@ "com.amazonaws.configservice#PutConfigRuleRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.configservice#TagsList", - "traits": { - "smithy.api#documentation": "

An array of tag object.

" - } - }, "ConfigRule": { "target": "com.amazonaws.configservice#ConfigRule", "traits": { "smithy.api#documentation": "

The rule that you want to add to your account.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.configservice#TagsList", + "traits": { + "smithy.api#documentation": "

An array of tag object.

" + } } } }, @@ -7555,16 +7553,11 @@ "com.amazonaws.configservice#PutConfigurationAggregatorRequest": { "type": "structure", "members": { - "AccountAggregationSources": { - "target": "com.amazonaws.configservice#AccountAggregationSourceList", - "traits": { - "smithy.api#documentation": "

A list of AccountAggregationSource object.\n\t\t\t\n\t\t

" - } - }, - "Tags": { - "target": "com.amazonaws.configservice#TagsList", + "ConfigurationAggregatorName": { + "target": "com.amazonaws.configservice#ConfigurationAggregatorName", "traits": { - "smithy.api#documentation": "

An array of tag object.

" + "smithy.api#documentation": "

The name of the configuration aggregator.

", + "smithy.api#required": {} } }, "OrganizationAggregationSource": { @@ -7573,11 +7566,16 @@ "smithy.api#documentation": "

An OrganizationAggregationSource object.

" } }, - "ConfigurationAggregatorName": { - "target": "com.amazonaws.configservice#ConfigurationAggregatorName", + "Tags": { + "target": "com.amazonaws.configservice#TagsList", "traits": { - "smithy.api#documentation": "

The name of the configuration aggregator.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of tag object.

" + } + }, + "AccountAggregationSources": { + "target": "com.amazonaws.configservice#AccountAggregationSourceList", + "traits": { + "smithy.api#documentation": "

A list of AccountAggregationSource object.\n\t\t\t\n\t\t

" } } } @@ -7666,8 +7664,7 @@ "DeliveryS3Bucket": { "target": "com.amazonaws.configservice#DeliveryS3Bucket", "traits": { - "smithy.api#documentation": "

AWS Config stores intermediate files while processing conformance pack template.

", - "smithy.api#required": {} + "smithy.api#documentation": "

AWS Config stores intermediate files while processing conformance pack template.

" } }, "ConformancePackName": { @@ -7677,16 +7674,16 @@ "smithy.api#required": {} } }, - "TemplateS3Uri": { - "target": "com.amazonaws.configservice#TemplateS3Uri", + "TemplateBody": { + "target": "com.amazonaws.configservice#TemplateBody", "traits": { - "smithy.api#documentation": "

Location of file containing the template body (s3://bucketname/prefix). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

\n\t\t \n

You must have access to read Amazon S3 bucket.

\n " + "smithy.api#documentation": "

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n\t\t \n

You can only use a YAML template with one resource type, that is, config rule and a remediation action.

\n " } }, - "DeliveryS3KeyPrefix": { - "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", + "TemplateS3Uri": { + "target": "com.amazonaws.configservice#TemplateS3Uri", "traits": { - "smithy.api#documentation": "

The prefix for the Amazon S3 bucket.

" + "smithy.api#documentation": "

Location of file containing the template body (s3://bucketname/prefix). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

\n\t\t \n

You must have access to read Amazon S3 bucket.

\n " } }, "ConformancePackInputParameters": { @@ -7695,10 +7692,10 @@ "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" } }, - "TemplateBody": { - "target": "com.amazonaws.configservice#TemplateBody", + "DeliveryS3KeyPrefix": { + "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", "traits": { - "smithy.api#documentation": "

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n\t\t \n

You can only use a YAML template with one resource type, that is, config rule and a remediation action.

\n " + "smithy.api#documentation": "

The prefix for the Amazon S3 bucket.

" } } } @@ -7787,12 +7784,6 @@ "com.amazonaws.configservice#PutEvaluationsRequest": { "type": "structure", "members": { - "Evaluations": { - "target": "com.amazonaws.configservice#Evaluations", - "traits": { - "smithy.api#documentation": "

The assessments that the AWS Lambda function performs. Each\n\t\t\tevaluation identifies an AWS resource and indicates whether it\n\t\t\tcomplies with the AWS Config rule that invokes the AWS Lambda\n\t\t\tfunction.

" - } - }, "ResultToken": { "target": "com.amazonaws.configservice#String", "traits": { @@ -7805,6 +7796,12 @@ "traits": { "smithy.api#documentation": "

Use this parameter to specify a test run for\n\t\t\t\tPutEvaluations. You can verify whether your AWS\n\t\t\tLambda function will deliver evaluation results to AWS Config. No\n\t\t\tupdates occur to your existing evaluations, and evaluation results\n\t\t\tare not sent to AWS Config.

\n\n\t\t \n\t\t\t

When TestMode is true,\n\t\t\t\t\tPutEvaluations doesn't require a valid value\n\t\t\t\tfor the ResultToken parameter, but the value cannot\n\t\t\t\tbe null.

\n\t\t " } + }, + "Evaluations": { + "target": "com.amazonaws.configservice#Evaluations", + "traits": { + "smithy.api#documentation": "

The assessments that the AWS Lambda function performs. Each\n\t\t\tevaluation identifies an AWS resource and indicates whether it\n\t\t\tcomplies with the AWS Config rule that invokes the AWS Lambda\n\t\t\tfunction.

" + } } }, "traits": { @@ -7866,18 +7863,6 @@ "com.amazonaws.configservice#PutOrganizationConfigRuleRequest": { "type": "structure", "members": { - "OrganizationCustomRuleMetadata": { - "target": "com.amazonaws.configservice#OrganizationCustomRuleMetadata", - "traits": { - "smithy.api#documentation": "

An OrganizationCustomRuleMetadata object.

" - } - }, - "ExcludedAccounts": { - "target": "com.amazonaws.configservice#ExcludedAccounts", - "traits": { - "smithy.api#documentation": "

A comma-separated list of accounts that you want to exclude from an organization config rule.

" - } - }, "OrganizationManagedRuleMetadata": { "target": "com.amazonaws.configservice#OrganizationManagedRuleMetadata", "traits": { @@ -7890,6 +7875,18 @@ "smithy.api#documentation": "

The name that you assign to an organization config rule.

", "smithy.api#required": {} } + }, + "OrganizationCustomRuleMetadata": { + "target": "com.amazonaws.configservice#OrganizationCustomRuleMetadata", + "traits": { + "smithy.api#documentation": "

An OrganizationCustomRuleMetadata object.

" + } + }, + "ExcludedAccounts": { + "target": "com.amazonaws.configservice#ExcludedAccounts", + "traits": { + "smithy.api#documentation": "

A comma-separated list of accounts that you want to exclude from an organization config rule.

" + } } } }, @@ -7945,10 +7942,10 @@ "com.amazonaws.configservice#PutOrganizationConformancePackRequest": { "type": "structure", "members": { - "DeliveryS3Bucket": { - "target": "com.amazonaws.configservice#DeliveryS3Bucket", + "OrganizationConformancePackName": { + "target": "com.amazonaws.configservice#OrganizationConformancePackName", "traits": { - "smithy.api#documentation": "

Location of an Amazon S3 bucket where AWS Config can deliver evaluation results. AWS Config\n\t\t\tstores intermediate files while processing conformance pack template.

\n\t\t

The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\". \n\t\t\tFor more information, see Permissions for cross account bucket access.

", + "smithy.api#documentation": "

Name of the organization conformance pack you want to create.

", "smithy.api#required": {} } }, @@ -7958,35 +7955,34 @@ "smithy.api#documentation": "

A string containing full conformance pack template body. Structure containing the template body\n\t\t\twith a minimum length of 1 byte and a maximum length of 51,200 bytes.

" } }, - "TemplateS3Uri": { - "target": "com.amazonaws.configservice#TemplateS3Uri", + "DeliveryS3KeyPrefix": { + "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The uri must point to the conformance pack template\n\t\t\t(max size: 300 KB).

\n\t\t \n

You must have access to read Amazon S3 bucket.

\n " + "smithy.api#documentation": "

The prefix for the Amazon S3 bucket.

" } }, - "OrganizationConformancePackName": { - "target": "com.amazonaws.configservice#OrganizationConformancePackName", + "DeliveryS3Bucket": { + "target": "com.amazonaws.configservice#DeliveryS3Bucket", "traits": { - "smithy.api#documentation": "

Name of the organization conformance pack you want to create.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Location of an Amazon S3 bucket where AWS Config can deliver evaluation results. AWS Config\n\t\t\tstores intermediate files while processing conformance pack template.

\n\t\t

The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\". \n\t\t\tFor more information, see Permissions for cross account bucket access.

" } }, - "ConformancePackInputParameters": { - "target": "com.amazonaws.configservice#ConformancePackInputParameters", + "ExcludedAccounts": { + "target": "com.amazonaws.configservice#ExcludedAccounts", "traits": { - "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" + "smithy.api#documentation": "

A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.

" } }, - "DeliveryS3KeyPrefix": { - "target": "com.amazonaws.configservice#DeliveryS3KeyPrefix", + "TemplateS3Uri": { + "target": "com.amazonaws.configservice#TemplateS3Uri", "traits": { - "smithy.api#documentation": "

The prefix for the Amazon S3 bucket.

" + "smithy.api#documentation": "

Location of file containing the template body. The uri must point to the conformance pack template\n\t\t\t(max size: 300 KB).

\n\t\t \n

You must have access to read Amazon S3 bucket.

\n " } }, - "ExcludedAccounts": { - "target": "com.amazonaws.configservice#ExcludedAccounts", + "ConformancePackInputParameters": { + "target": "com.amazonaws.configservice#ConformancePackInputParameters", "traits": { - "smithy.api#documentation": "

A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.

" + "smithy.api#documentation": "

A list of ConformancePackInputParameter objects.

" } } } @@ -8082,17 +8078,17 @@ "smithy.api#required": {} } }, - "ExpirationTime": { - "target": "com.amazonaws.configservice#Date", - "traits": { - "smithy.api#documentation": "

The exception is automatically deleted after the expiration date.

" - } - }, "Message": { "target": "com.amazonaws.configservice#StringWithCharLimit1024", "traits": { "smithy.api#documentation": "

The message contains an explanation of the exception.

" } + }, + "ExpirationTime": { + "target": "com.amazonaws.configservice#Date", + "traits": { + "smithy.api#documentation": "

The exception is automatically deleted after the expiration date.

" + } } } }, @@ -8133,11 +8129,10 @@ "com.amazonaws.configservice#PutResourceConfigRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.configservice#ResourceId", + "Tags": { + "target": "com.amazonaws.configservice#Tags", "traits": { - "smithy.api#documentation": "

Unique identifier of the resource.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Tags associated with the resource.

" } }, "SchemaVersionId": { @@ -8147,12 +8142,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.configservice#Tags", - "traits": { - "smithy.api#documentation": "

Tags associated with the resource.

" - } - }, "Configuration": { "target": "com.amazonaws.configservice#Configuration", "traits": { @@ -8160,10 +8149,11 @@ "smithy.api#required": {} } }, - "ResourceName": { - "target": "com.amazonaws.configservice#ResourceName", + "ResourceId": { + "target": "com.amazonaws.configservice#ResourceId", "traits": { - "smithy.api#documentation": "

Name of the resource.

" + "smithy.api#documentation": "

Unique identifier of the resource.

", + "smithy.api#required": {} } }, "ResourceType": { @@ -8172,6 +8162,12 @@ "smithy.api#documentation": "

The type of the resource. The custom resource type must be registered with AWS CloudFormation.

\n\t\t \n

You cannot use the organization names “aws”, “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

\n ", "smithy.api#required": {} } + }, + "ResourceName": { + "target": "com.amazonaws.configservice#ResourceName", + "traits": { + "smithy.api#documentation": "

Name of the resource.

" + } } } }, @@ -8263,10 +8259,10 @@ "com.amazonaws.configservice#RecordingGroup": { "type": "structure", "members": { - "resourceTypes": { - "target": "com.amazonaws.configservice#ResourceTypeList", + "includeGlobalResourceTypes": { + "target": "com.amazonaws.configservice#IncludeGlobalResourceTypes", "traits": { - "smithy.api#documentation": "

A comma-separated list that specifies the types of AWS\n\t\t\tresources for which AWS Config records configuration changes (for\n\t\t\texample, AWS::EC2::Instance or\n\t\t\t\tAWS::CloudTrail::Trail).

\n\t\t

Before you can set this option to true, you must\n\t\t\tset the allSupported option to\n\t\t\tfalse.

\n\t\t

If you set this option to true, when AWS Config\n\t\t\tadds support for a new type of resource, it will not record\n\t\t\tresources of that type unless you manually add that type to your\n\t\t\trecording group.

\n\t\t

For a list of valid resourceTypes values, see the\n\t\t\t\tresourceType Value column in\n\t\t\t\tSupported AWS Resource Types.

" + "smithy.api#documentation": "

Specifies whether AWS Config includes all supported types of\n\t\t\tglobal resources (for example, IAM resources) with the resources\n\t\t\tthat it records.

\n\t\t

Before you can set this option to true, you must\n\t\t\tset the allSupported option to\n\t\t\ttrue.

\n\t\t

If you set this option to true, when AWS Config\n\t\t\tadds support for a new type of global resource, it starts recording\n\t\t\tresources of that type automatically.

\n\t\t

The configuration details for any global resource are the same\n\t\t\tin all regions. To prevent duplicate configuration items, you should\n\t\t\tconsider customizing AWS Config in only one region to record global\n\t\t\tresources.

" } }, "allSupported": { @@ -8275,10 +8271,10 @@ "smithy.api#documentation": "

Specifies whether AWS Config records configuration changes for\n\t\t\tevery supported type of regional resource.

\n\t\t

If you set this option to true, when AWS Config\n\t\t\tadds support for a new type of regional resource, it starts\n\t\t\trecording resources of that type automatically.

\n\t\t

If you set this option to true, you cannot\n\t\t\tenumerate a list of resourceTypes.

" } }, - "includeGlobalResourceTypes": { - "target": "com.amazonaws.configservice#IncludeGlobalResourceTypes", + "resourceTypes": { + "target": "com.amazonaws.configservice#ResourceTypeList", "traits": { - "smithy.api#documentation": "

Specifies whether AWS Config includes all supported types of\n\t\t\tglobal resources (for example, IAM resources) with the resources\n\t\t\tthat it records.

\n\t\t

Before you can set this option to true, you must\n\t\t\tset the allSupported option to\n\t\t\ttrue.

\n\t\t

If you set this option to true, when AWS Config\n\t\t\tadds support for a new type of global resource, it starts recording\n\t\t\tresources of that type automatically.

\n\t\t

The configuration details for any global resource are the same\n\t\t\tin all regions. To prevent duplicate configuration items, you should\n\t\t\tconsider customizing AWS Config in only one region to record global\n\t\t\tresources.

" + "smithy.api#documentation": "

A comma-separated list that specifies the types of AWS\n\t\t\tresources for which AWS Config records configuration changes (for\n\t\t\texample, AWS::EC2::Instance or\n\t\t\t\tAWS::CloudTrail::Trail).

\n\t\t

Before you can set this option to true, you must\n\t\t\tset the allSupported option to\n\t\t\tfalse.

\n\t\t

If you set this option to true, when AWS Config\n\t\t\tadds support for a new type of resource, it will not record\n\t\t\tresources of that type unless you manually add that type to your\n\t\t\trecording group.

\n\t\t

For a list of valid resourceTypes values, see the\n\t\t\t\tresourceType Value column in\n\t\t\t\tSupported AWS Resource Types.

" } } }, @@ -8313,7 +8309,13 @@ "resourceName": { "target": "com.amazonaws.configservice#ResourceName", "traits": { - "smithy.api#documentation": "

The custom name of the related resource, if\n\t\t\tavailable.

" + "smithy.api#documentation": "

The custom name of the related resource, if\n\t\t\tavailable.

" + } + }, + "resourceType": { + "target": "com.amazonaws.configservice#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the related resource.

" } }, "relationshipName": { @@ -8327,12 +8329,6 @@ "traits": { "smithy.api#documentation": "

The ID of the related resource (for example,\n\t\t\t\tsg-xxxxxx).

" } - }, - "resourceType": { - "target": "com.amazonaws.configservice#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type of the related resource.

" - } } }, "traits": { @@ -8357,49 +8353,29 @@ "smithy.api#documentation": "

Amazon Resource Name (ARN) of remediation configuration.

" } }, - "TargetVersion": { - "target": "com.amazonaws.configservice#String", + "RetryAttemptSeconds": { + "target": "com.amazonaws.configservice#AutoRemediationAttemptSeconds", "traits": { - "smithy.api#documentation": "

Version of the target. For example, version of the SSM document.

\n\t\t \n

If you make backward incompatible changes to the SSM document, \n\t\t\tyou must call PutRemediationConfiguration API again to ensure the remediations can run.

\n " + "smithy.api#documentation": "

Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

\n\t\t

For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, \n\t\tAWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

" } }, - "TargetId": { - "target": "com.amazonaws.configservice#StringWithCharLimit256", + "ConfigRuleName": { + "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { - "smithy.api#documentation": "

Target ID is the name of the public document.

", + "smithy.api#documentation": "

The name of the AWS Config rule.

", "smithy.api#required": {} } }, - "Parameters": { - "target": "com.amazonaws.configservice#RemediationParameters", - "traits": { - "smithy.api#documentation": "

An object of the RemediationParameterValue.

" - } - }, "CreatedByService": { "target": "com.amazonaws.configservice#StringWithCharLimit1024", "traits": { "smithy.api#documentation": "

Name of the service that owns the service linked rule, if applicable.

" } }, - "Automatic": { - "target": "com.amazonaws.configservice#Boolean", - "traits": { - "smithy.api#documentation": "

The remediation is triggered automatically.

" - } - }, - "TargetType": { - "target": "com.amazonaws.configservice#RemediationTargetType", - "traits": { - "smithy.api#documentation": "

The type of the target. Target executes remediation. For example, SSM document.

", - "smithy.api#required": {} - } - }, - "ConfigRuleName": { - "target": "com.amazonaws.configservice#ConfigRuleName", + "ExecutionControls": { + "target": "com.amazonaws.configservice#ExecutionControls", "traits": { - "smithy.api#documentation": "

The name of the AWS Config rule.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An ExecutionControls object.

" } }, "ResourceType": { @@ -8408,10 +8384,10 @@ "smithy.api#documentation": "

The type of a resource.

" } }, - "ExecutionControls": { - "target": "com.amazonaws.configservice#ExecutionControls", + "Parameters": { + "target": "com.amazonaws.configservice#RemediationParameters", "traits": { - "smithy.api#documentation": "

An ExecutionControls object.

" + "smithy.api#documentation": "

An object of the RemediationParameterValue.

" } }, "MaximumAutomaticAttempts": { @@ -8420,10 +8396,30 @@ "smithy.api#documentation": "

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

\n\t\t

For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeconds as 50 seconds, \n\t\t\t\n\t\t\tAWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

" } }, - "RetryAttemptSeconds": { - "target": "com.amazonaws.configservice#AutoRemediationAttemptSeconds", + "TargetType": { + "target": "com.amazonaws.configservice#RemediationTargetType", "traits": { - "smithy.api#documentation": "

Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

\n\t\t

For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, \n\t\tAWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

" + "smithy.api#documentation": "

The type of the target. Target executes remediation. For example, SSM document.

", + "smithy.api#required": {} + } + }, + "Automatic": { + "target": "com.amazonaws.configservice#Boolean", + "traits": { + "smithy.api#documentation": "

The remediation is triggered automatically.

" + } + }, + "TargetId": { + "target": "com.amazonaws.configservice#StringWithCharLimit256", + "traits": { + "smithy.api#documentation": "

Target ID is the name of the public document.

", + "smithy.api#required": {} + } + }, + "TargetVersion": { + "target": "com.amazonaws.configservice#String", + "traits": { + "smithy.api#documentation": "

Version of the target. For example, version of the SSM document.

\n\t\t \n

If you make backward incompatible changes to the SSM document, \n\t\t\tyou must call PutRemediationConfiguration API again to ensure the remediations can run.

\n " } } }, @@ -8446,25 +8442,12 @@ "com.amazonaws.configservice#RemediationException": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.configservice#StringWithCharLimit1024", - "traits": { - "smithy.api#documentation": "

The ID of the resource (for example., sg-xxxxxx).

", - "smithy.api#required": {} - } - }, "ExpirationTime": { "target": "com.amazonaws.configservice#Date", "traits": { "smithy.api#documentation": "

The time when the remediation exception will be deleted.

" } }, - "Message": { - "target": "com.amazonaws.configservice#StringWithCharLimit1024", - "traits": { - "smithy.api#documentation": "

An explanation of an remediation exception.

" - } - }, "ConfigRuleName": { "target": "com.amazonaws.configservice#ConfigRuleName", "traits": { @@ -8472,6 +8455,19 @@ "smithy.api#required": {} } }, + "ResourceId": { + "target": "com.amazonaws.configservice#StringWithCharLimit1024", + "traits": { + "smithy.api#documentation": "

The ID of the resource (for example., sg-xxxxxx).

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.configservice#StringWithCharLimit1024", + "traits": { + "smithy.api#documentation": "

An explanation of an remediation exception.

" + } + }, "ResourceType": { "target": "com.amazonaws.configservice#StringWithCharLimit256", "traits": { @@ -8560,13 +8556,10 @@ "smithy.api#documentation": "

The time when the remediation execution was last updated.

" } }, - "ResourceKey": { - "target": "com.amazonaws.configservice#ResourceKey" - }, - "InvocationTime": { - "target": "com.amazonaws.configservice#Date", + "State": { + "target": "com.amazonaws.configservice#RemediationExecutionState", "traits": { - "smithy.api#documentation": "

Start time when the remediation was executed.

" + "smithy.api#documentation": "

ENUM of the values.

" } }, "StepDetails": { @@ -8575,10 +8568,13 @@ "smithy.api#documentation": "

Details of every step.

" } }, - "State": { - "target": "com.amazonaws.configservice#RemediationExecutionState", + "ResourceKey": { + "target": "com.amazonaws.configservice#ResourceKey" + }, + "InvocationTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

ENUM of the values.

" + "smithy.api#documentation": "

Start time when the remediation was executed.

" } } }, @@ -8601,16 +8597,16 @@ "smithy.api#documentation": "

An error message if the step was interrupted during execution.

" } }, - "State": { - "target": "com.amazonaws.configservice#RemediationExecutionStepState", + "StopTime": { + "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The valid status of the step.

" + "smithy.api#documentation": "

The time when the step stopped.

" } }, - "StartTime": { - "target": "com.amazonaws.configservice#Date", + "State": { + "target": "com.amazonaws.configservice#RemediationExecutionStepState", "traits": { - "smithy.api#documentation": "

The time when the step started.

" + "smithy.api#documentation": "

The valid status of the step.

" } }, "Name": { @@ -8619,10 +8615,10 @@ "smithy.api#documentation": "

The details of the step.

" } }, - "StopTime": { + "StartTime": { "target": "com.amazonaws.configservice#Date", "traits": { - "smithy.api#documentation": "

The time when the step stopped.

" + "smithy.api#documentation": "

The time when the step started.

" } } }, @@ -8673,17 +8669,17 @@ "com.amazonaws.configservice#RemediationParameterValue": { "type": "structure", "members": { - "ResourceValue": { - "target": "com.amazonaws.configservice#ResourceValue", - "traits": { - "smithy.api#documentation": "

The value is dynamic and changes at run-time.

" - } - }, "StaticValue": { "target": "com.amazonaws.configservice#StaticValue", "traits": { "smithy.api#documentation": "

The value is static and does not change at run-time.

" } + }, + "ResourceValue": { + "target": "com.amazonaws.configservice#ResourceValue", + "traits": { + "smithy.api#documentation": "

The value is dynamic and changes at run-time.

" + } } }, "traits": { @@ -8739,12 +8735,6 @@ "com.amazonaws.configservice#ResourceCountFilters": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.configservice#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of the AWS resource.

" - } - }, "Region": { "target": "com.amazonaws.configservice#AwsRegion", "traits": { @@ -8756,6 +8746,12 @@ "traits": { "smithy.api#documentation": "

The 12-digit ID of the account.

" } + }, + "ResourceType": { + "target": "com.amazonaws.configservice#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of the AWS resource.

" + } } }, "traits": { @@ -8796,10 +8792,10 @@ "com.amazonaws.configservice#ResourceFilters": { "type": "structure", "members": { - "Region": { - "target": "com.amazonaws.configservice#AwsRegion", + "ResourceName": { + "target": "com.amazonaws.configservice#ResourceName", "traits": { - "smithy.api#documentation": "

The source region.

" + "smithy.api#documentation": "

The name of the resource.

" } }, "ResourceId": { @@ -8814,10 +8810,10 @@ "smithy.api#documentation": "

The 12-digit source account ID.

" } }, - "ResourceName": { - "target": "com.amazonaws.configservice#ResourceName", + "Region": { + "target": "com.amazonaws.configservice#AwsRegion", "traits": { - "smithy.api#documentation": "

The name of the resource.

" + "smithy.api#documentation": "

The source region.

" } } }, @@ -8843,10 +8839,10 @@ "com.amazonaws.configservice#ResourceIdentifier": { "type": "structure", "members": { - "resourceType": { - "target": "com.amazonaws.configservice#ResourceType", + "resourceId": { + "target": "com.amazonaws.configservice#ResourceId", "traits": { - "smithy.api#documentation": "

The type of resource.

" + "smithy.api#documentation": "

The ID of the resource (for example,\n\t\t\tsg-xxxxxx).

" } }, "resourceDeletionTime": { @@ -8855,17 +8851,17 @@ "smithy.api#documentation": "

The time that the resource was deleted.

" } }, - "resourceId": { - "target": "com.amazonaws.configservice#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource (for example,\n\t\t\tsg-xxxxxx).

" - } - }, "resourceName": { "target": "com.amazonaws.configservice#ResourceName", "traits": { "smithy.api#documentation": "

The custom name of the resource (if available).

" } + }, + "resourceType": { + "target": "com.amazonaws.configservice#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource.

" + } } }, "traits": { @@ -8908,17 +8904,17 @@ "com.amazonaws.configservice#ResourceKey": { "type": "structure", "members": { - "resourceId": { - "target": "com.amazonaws.configservice#ResourceId", + "resourceType": { + "target": "com.amazonaws.configservice#ResourceType", "traits": { - "smithy.api#documentation": "

The ID of the resource (for example., sg-xxxxxx).

", + "smithy.api#documentation": "

The resource type.

", "smithy.api#required": {} } }, - "resourceType": { - "target": "com.amazonaws.configservice#ResourceType", + "resourceId": { + "target": "com.amazonaws.configservice#ResourceId", "traits": { - "smithy.api#documentation": "

The resource type.

", + "smithy.api#documentation": "

The ID of the resource (for example., sg-xxxxxx).

", "smithy.api#required": {} } } @@ -9509,12 +9505,6 @@ "smithy.api#documentation": "

The resource types of only those AWS resources that you want to\n\t\t\ttrigger an evaluation for the rule. You can only specify one type if\n\t\t\tyou also specify a resource ID for\n\t\t\tComplianceResourceId.

" } }, - "TagKey": { - "target": "com.amazonaws.configservice#StringWithCharLimit128", - "traits": { - "smithy.api#documentation": "

The tag key that is applied to only those AWS resources that\n\t\t\tyou want to trigger an evaluation for the rule.

" - } - }, "ComplianceResourceId": { "target": "com.amazonaws.configservice#BaseResourceId", "traits": { @@ -9526,6 +9516,12 @@ "traits": { "smithy.api#documentation": "

The tag value applied to only those AWS resources that you want\n\t\t\tto trigger an evaluation for the rule. If you specify a value for\n\t\t\t\tTagValue, you must also specify a value for\n\t\t\t\tTagKey.

" } + }, + "TagKey": { + "target": "com.amazonaws.configservice#StringWithCharLimit128", + "traits": { + "smithy.api#documentation": "

The tag key that is applied to only those AWS resources that\n\t\t\tyou want to trigger an evaluation for the rule.

" + } } }, "traits": { @@ -9578,6 +9574,13 @@ "smithy.api#documentation": "

The maximum number of query results returned on each page.

" } }, + "Expression": { + "target": "com.amazonaws.configservice#Expression", + "traits": { + "smithy.api#documentation": "

The SQL query SELECT command.

", + "smithy.api#required": {} + } + }, "ConfigurationAggregatorName": { "target": "com.amazonaws.configservice#ConfigurationAggregatorName", "traits": { @@ -9590,13 +9593,6 @@ "traits": { "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" } - }, - "Expression": { - "target": "com.amazonaws.configservice#Expression", - "traits": { - "smithy.api#documentation": "

The SQL query SELECT command.

", - "smithy.api#required": {} - } } } }, @@ -9676,17 +9672,17 @@ "smithy.api#documentation": "

Returns the QueryInfo object.

" } }, - "NextToken": { - "target": "com.amazonaws.configservice#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" - } - }, "Results": { "target": "com.amazonaws.configservice#Results", "traits": { "smithy.api#documentation": "

Returns the results for the SQL query.

" } + }, + "NextToken": { + "target": "com.amazonaws.configservice#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" + } } } }, @@ -10032,7 +10028,7 @@ "sdkId": "Config Service", "arnNamespace": "config", "cloudFormationName": "Config", - "cloudTrailEventSource": "dove.starling.amazonaws.com" + "cloudTrailEventSource": "configservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "config" @@ -10416,17 +10412,17 @@ "com.amazonaws.configservice#TagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.configservice#AmazonResourceName", + "Tags": { + "target": "com.amazonaws.configservice#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

", + "smithy.api#documentation": "

An array of tag object.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.configservice#TagList", + "ResourceArn": { + "target": "com.amazonaws.configservice#AmazonResourceName", "traits": { - "smithy.api#documentation": "

An array of tag object.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

", "smithy.api#required": {} } } 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 5107660abf49..251d8aa2009d 100644 --- a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json +++ b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json @@ -71,12 +71,27 @@ "type": "service", "version": "2017-08-08", "operations": [ + { + "target": "com.amazonaws.connect#AssociateRoutingProfileQueues" + }, + { + "target": "com.amazonaws.connect#CreateContactFlow" + }, + { + "target": "com.amazonaws.connect#CreateRoutingProfile" + }, { "target": "com.amazonaws.connect#CreateUser" }, { "target": "com.amazonaws.connect#DeleteUser" }, + { + "target": "com.amazonaws.connect#DescribeContactFlow" + }, + { + "target": "com.amazonaws.connect#DescribeRoutingProfile" + }, { "target": "com.amazonaws.connect#DescribeUser" }, @@ -86,6 +101,9 @@ { "target": "com.amazonaws.connect#DescribeUserHierarchyStructure" }, + { + "target": "com.amazonaws.connect#DisassociateRoutingProfileQueues" + }, { "target": "com.amazonaws.connect#GetContactAttributes" }, @@ -107,9 +125,15 @@ { "target": "com.amazonaws.connect#ListPhoneNumbers" }, + { + "target": "com.amazonaws.connect#ListPrompts" + }, { "target": "com.amazonaws.connect#ListQueues" }, + { + "target": "com.amazonaws.connect#ListRoutingProfileQueues" + }, { "target": "com.amazonaws.connect#ListRoutingProfiles" }, @@ -155,6 +179,24 @@ { "target": "com.amazonaws.connect#UpdateContactAttributes" }, + { + "target": "com.amazonaws.connect#UpdateContactFlowContent" + }, + { + "target": "com.amazonaws.connect#UpdateContactFlowName" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrency" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueue" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileName" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileQueues" + }, { "target": "com.amazonaws.connect#UpdateUserHierarchy" }, @@ -182,10 +224,69 @@ "name": "connect" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a\n customer contact center and provide reliable customer engagement at any scale.

\n

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact\n routing. You can also resolve customer issues more efficiently by putting customers in touch with\n the right agents.

\n

There are limits to the number of Amazon Connect resources that you can create and limits to the\n number of requests that you can make per second. For more information, see Amazon Connect\n Service Limits in the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a\n customer contact center and provide reliable customer engagement at any scale.

\n

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact\n routing. You can also resolve customer issues more efficiently by putting customers in touch with\n the right agents.

\n

There are limits to the number of Amazon Connect resources that you can create and limits to the\n number of requests that you can make per second. For more information, see Amazon Connect\n Service Quotas in the Amazon Connect Administrator Guide.

\n

To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect\n endpoints, see Amazon Connect\n Endpoints.

\n \n

Working with contact flows? Check out the Amazon Connect\n Flow language.

\n ", "smithy.api#title": "Amazon Connect Service" } }, + "com.amazonaws.connect#AssociateRoutingProfileQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest" + }, + "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": "

Associates a set of queues with a routing profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest": { + "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": {} + } + }, + "QueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", + "traits": { + "smithy.api#documentation": "

The queues to associate with this routing profile.

", + "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": {} + } + } + } + }, "com.amazonaws.connect#AttributeName": { "type": "string", "traits": { @@ -264,17 +365,17 @@ "com.amazonaws.connect#ChatMessage": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.connect#ChatContent", + "ContentType": { + "target": "com.amazonaws.connect#ChatContentType", "traits": { - "smithy.api#documentation": "

The content of the chat message.

", + "smithy.api#documentation": "

The type of the content. Supported types are text/plain.

", "smithy.api#required": {} } }, - "ContentType": { - "target": "com.amazonaws.connect#ChatContentType", + "Content": { + "target": "com.amazonaws.connect#ChatContent", "traits": { - "smithy.api#documentation": "

The type of the content. Supported types are text/plain.

", + "smithy.api#documentation": "

The content of the chat message.

", "smithy.api#required": {} } } @@ -303,6 +404,71 @@ ] } }, + "com.amazonaws.connect#Concurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.connect#ContactFlow": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact flow.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", + "traits": { + "smithy.api#documentation": "

The description of the contact flow.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowContent", + "traits": { + "smithy.api#documentation": "

The content of the contact flow.

" + } + }, + "Type": { + "target": "com.amazonaws.connect#ContactFlowType", + "traits": { + "smithy.api#documentation": "

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator\n Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

One or more tags.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", + "traits": { + "smithy.api#documentation": "

The name of the contact flow.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a contact flow.

" + } + }, + "com.amazonaws.connect#ContactFlowContent": { + "type": "string" + }, + "com.amazonaws.connect#ContactFlowDescription": { + "type": "string" + }, "com.amazonaws.connect#ContactFlowId": { "type": "string", "traits": { @@ -313,27 +479,39 @@ } }, "com.amazonaws.connect#ContactFlowName": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.connect#ContactFlowNotPublishedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The contact flow has not been published.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, "com.amazonaws.connect#ContactFlowSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.connect#ContactFlowName", - "traits": { - "smithy.api#documentation": "

The name of the contact flow.

" - } - }, "ContactFlowType": { "target": "com.amazonaws.connect#ContactFlowType", "traits": { "smithy.api#documentation": "

The type of contact flow.

" } }, - "Id": { - "target": "com.amazonaws.connect#ContactFlowId", + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", "traits": { - "smithy.api#documentation": "

The identifier of the contact flow.

" + "smithy.api#documentation": "

The name of the contact flow.

" } }, "Arn": { @@ -341,10 +519,16 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact flow.

" } + }, + "Id": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow.

" + } } }, "traits": { - "smithy.api#documentation": "

Contains summary information about a contact flow.

" + "smithy.api#documentation": "

Contains summary information about a contact flow.

\n

You can also create and update contact flows using the Amazon Connect\n Flow language.

" } }, "com.amazonaws.connect#ContactFlowSummaryList": { @@ -433,13 +617,13 @@ "smithy.api#httpError": 410 } }, - "com.amazonaws.connect#CreateUser": { + "com.amazonaws.connect#CreateContactFlow": { "type": "operation", "input": { - "target": "com.amazonaws.connect#CreateUserRequest" + "target": "com.amazonaws.connect#CreateContactFlowRequest" }, "output": { - "target": "com.amazonaws.connect#CreateUserResponse" + "target": "com.amazonaws.connect#CreateContactFlowResponse" }, "errors": [ { @@ -448,6 +632,9 @@ { "target": "com.amazonaws.connect#InternalServiceException" }, + { + "target": "com.amazonaws.connect#InvalidContactFlowException" + }, { "target": "com.amazonaws.connect#InvalidParameterException" }, @@ -465,27 +652,27 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a user account for the specified Amazon Connect instance.

", + "smithy.api#documentation": "

Creates a contact flow for the specified Amazon Connect instance.

\n

You can also create and update contact flows using the Amazon Connect\n Flow language.

", "smithy.api#http": { "method": "PUT", - "uri": "/users/{InstanceId}", + "uri": "/contact-flows/{InstanceId}", "code": 200 } } }, - "com.amazonaws.connect#CreateUserRequest": { + "com.amazonaws.connect#CreateContactFlowRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.connect#TagMap", + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", "traits": { - "smithy.api#documentation": "

One or more tags.

" + "smithy.api#documentation": "

The description of the contact flow.

" } }, - "SecurityProfileIds": { - "target": "com.amazonaws.connect#SecurityProfileIds", + "Content": { + "target": "com.amazonaws.connect#ContactFlowContent", "traits": { - "smithy.api#documentation": "

The identifier of the security profile for the user.

", + "smithy.api#documentation": "

The content of the contact flow.\n \n

", "smithy.api#required": {} } }, @@ -497,247 +684,167 @@ "smithy.api#required": {} } }, - "PhoneConfig": { - "target": "com.amazonaws.connect#UserPhoneConfig", + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", "traits": { - "smithy.api#documentation": "

The phone settings for the user.

", + "smithy.api#documentation": "

The name of the contact flow.

", "smithy.api#required": {} } }, - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group for the user.

" - } - }, - "DirectoryUserId": { - "target": "com.amazonaws.connect#DirectoryUserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account in the directory used for identity management. If Amazon Connect\n cannot access the directory, you can specify this identifier to authenticate users. If you\n include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity\n information is used to authenticate users from your directory.

\n

This parameter is required if you are using an existing directory for identity management in\n Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for\n identity management and include this parameter, an error is returned.

" - } - }, - "IdentityInfo": { - "target": "com.amazonaws.connect#UserIdentityInfo", - "traits": { - "smithy.api#documentation": "

The information about the identity of the user.

" - } - }, - "Password": { - "target": "com.amazonaws.connect#Password", - "traits": { - "smithy.api#documentation": "

The password for the user account. A password is required if you are using Amazon Connect for\n identity management. Otherwise, it is an error to include a password.

" - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", + "Type": { + "target": "com.amazonaws.connect#ContactFlowType", "traits": { - "smithy.api#documentation": "

The identifier of the routing profile for the user.

", + "smithy.api#documentation": "

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator\n Guide.

", "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.connect#AgentUsername", + "Tags": { + "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "

The user name for the account. For instances not using SAML for identity management, the\n user name can include up to 20 characters. If you are using SAML for identity management, the\n user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more tags.

" } } } }, - "com.amazonaws.connect#CreateUserResponse": { + "com.amazonaws.connect#CreateContactFlowResponse": { "type": "structure", "members": { - "UserId": { - "target": "com.amazonaws.connect#UserId", + "ContactFlowArn": { + "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The identifier of the user account.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact flow.

" } }, - "UserArn": { - "target": "com.amazonaws.connect#ARN", + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" + "smithy.api#documentation": "

The identifier of the contact flow.

" } } } }, - "com.amazonaws.connect#Credentials": { - "type": "structure", - "members": { - "RefreshTokenExpiration": { - "target": "com.amazonaws.connect#timestamp", - "traits": { - "smithy.api#documentation": "

Renews the expiration timer for a generated token.

" - } - }, - "AccessTokenExpiration": { - "target": "com.amazonaws.connect#timestamp", - "traits": { - "smithy.api#documentation": "

A token generated with an expiration time for the session a user is logged in to\n Amazon Connect.

" - } + "com.amazonaws.connect#CreateRoutingProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateRoutingProfileRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateRoutingProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" }, - "AccessToken": { - "target": "com.amazonaws.connect#SecurityToken", - "traits": { - "smithy.api#documentation": "

An access token generated for a federated user to access Amazon Connect.

" - } + { + "target": "com.amazonaws.connect#InternalServiceException" }, - "RefreshToken": { - "target": "com.amazonaws.connect#SecurityToken", - "traits": { - "smithy.api#documentation": "

Renews a token generated for a user to access the Amazon Connect instance.

" - } + { + "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": "

Contains credentials to use for federation.

" + "smithy.api#documentation": "

Creates a new routing profile.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/routing-profiles/{InstanceId}", + "code": 200 + } } }, - "com.amazonaws.connect#CurrentMetric": { + "com.amazonaws.connect#CreateRoutingProfileRequest": { "type": "structure", "members": { - "Unit": { - "target": "com.amazonaws.connect#Unit", + "DefaultOutboundQueueId": { + "target": "com.amazonaws.connect#QueueId", "traits": { - "smithy.api#documentation": "

The unit for the metric.

" + "smithy.api#documentation": "

The default outbound queue for the routing profile.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

One or more tags.

" } }, "Name": { - "target": "com.amazonaws.connect#CurrentMetricName", + "target": "com.amazonaws.connect#RoutingProfileName", "traits": { - "smithy.api#documentation": "

The name of the metric.

" + "smithy.api#documentation": "

The name of the routing profile. Must not be more than 127 characters.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator\n Guide.

" - } - }, - "com.amazonaws.connect#CurrentMetricData": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.connect#Value", + }, + "Description": { + "target": "com.amazonaws.connect#RoutingProfileDescription", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The value of the metric.

" + "smithy.api#documentation": "

Description of the routing profile. Must not be more than 250 characters.

", + "smithy.api#required": {} } }, - "Metric": { - "target": "com.amazonaws.connect#CurrentMetric", + "QueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", "traits": { - "smithy.api#documentation": "

Information about the metric.

" + "smithy.api#documentation": "

The inbound queues associated with the routing profile. If no queue is added, the agent can\n only make outbound calls.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the data for a real-time metric.

" - } - }, - "com.amazonaws.connect#CurrentMetricDataCollections": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetricData" - } - }, - "com.amazonaws.connect#CurrentMetricName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The current metric names.

", - "smithy.api#enum": [ - { - "value": "AGENTS_ONLINE", - "name": "AGENTS_ONLINE" - }, - { - "value": "AGENTS_AVAILABLE", - "name": "AGENTS_AVAILABLE" - }, - { - "value": "AGENTS_ON_CALL", - "name": "AGENTS_ON_CALL" - }, - { - "value": "AGENTS_NON_PRODUCTIVE", - "name": "AGENTS_NON_PRODUCTIVE" - }, - { - "value": "AGENTS_AFTER_CONTACT_WORK", - "name": "AGENTS_AFTER_CONTACT_WORK" - }, - { - "value": "AGENTS_ERROR", - "name": "AGENTS_ERROR" - }, - { - "value": "AGENTS_STAFFED", - "name": "AGENTS_STAFFED" - }, - { - "value": "CONTACTS_IN_QUEUE", - "name": "CONTACTS_IN_QUEUE" - }, - { - "value": "OLDEST_CONTACT_AGE", - "name": "OLDEST_CONTACT_AGE" - }, - { - "value": "CONTACTS_SCHEDULED", - "name": "CONTACTS_SCHEDULED" - }, - { - "value": "AGENTS_ON_CONTACT", - "name": "AGENTS_ON_CONTACT" - }, - { - "value": "SLOTS_ACTIVE", - "name": "SLOTS_ACTIVE" - }, - { - "value": "SLOTS_AVAILABLE", - "name": "SLOTS_AVAILABLE" + }, + "MediaConcurrencies": { + "target": "com.amazonaws.connect#MediaConcurrencies", + "traits": { + "smithy.api#documentation": "

The channels agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

", + "smithy.api#required": {} } - ] + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } } }, - "com.amazonaws.connect#CurrentMetricResult": { + "com.amazonaws.connect#CreateRoutingProfileResponse": { "type": "structure", "members": { - "Dimensions": { - "target": "com.amazonaws.connect#Dimensions", + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", "traits": { - "smithy.api#documentation": "

The dimensions for the metrics.

" + "smithy.api#documentation": "

The identifier of the routing profile.

" } }, - "Collections": { - "target": "com.amazonaws.connect#CurrentMetricDataCollections", + "RoutingProfileArn": { + "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The set of metrics.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a set of real-time metrics.

" - } - }, - "com.amazonaws.connect#CurrentMetricResults": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetricResult" - } - }, - "com.amazonaws.connect#CurrentMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetric" } }, - "com.amazonaws.connect#DeleteUser": { + "com.amazonaws.connect#CreateUser": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeleteUserRequest" + "target": "com.amazonaws.connect#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateUserResponse" }, "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, { "target": "com.amazonaws.connect#InternalServiceException" }, @@ -747,6 +854,9 @@ { "target": "com.amazonaws.connect#InvalidRequestException" }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, { "target": "com.amazonaws.connect#ResourceNotFoundException" }, @@ -755,17 +865,31 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a user account from the specified Amazon Connect instance.

", + "smithy.api#documentation": "

Creates a user account for the specified Amazon Connect instance.

\n

For information about how to create user accounts using the Amazon Connect console, see Add Users in\n the Amazon Connect Administrator Guide.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/users/{InstanceId}/{UserId}", + "method": "PUT", + "uri": "/users/{InstanceId}", "code": 200 } } }, - "com.amazonaws.connect#DeleteUserRequest": { + "com.amazonaws.connect#CreateUserRequest": { "type": "structure", "members": { + "SecurityProfileIds": { + "target": "com.amazonaws.connect#SecurityProfileIds", + "traits": { + "smithy.api#documentation": "

The identifier of the security profile for the user.

", + "smithy.api#required": {} + } + }, + "PhoneConfig": { + "target": "com.amazonaws.connect#UserPhoneConfig", + "traits": { + "smithy.api#documentation": "

The phone settings for the user.

", + "smithy.api#required": {} + } + }, "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { @@ -774,325 +898,287 @@ "smithy.api#required": {} } }, - "UserId": { - "target": "com.amazonaws.connect#UserId", + "IdentityInfo": { + "target": "com.amazonaws.connect#UserIdentityInfo", "traits": { - "smithy.api#documentation": "

The identifier of the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The information about the identity of the user.

" } - } - } - }, - "com.amazonaws.connect#DescribeUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeUserRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" }, - { - "target": "com.amazonaws.connect#InvalidParameterException" + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group for the user.

" + } }, - { - "target": "com.amazonaws.connect#InvalidRequestException" + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile for the user.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified user account. You can find the instance ID in the console (it’s the\n final part of the ARN). The console does not display the user IDs. Instead, list the users and\n note the IDs provided in the output.

", - "smithy.api#http": { - "method": "GET", - "uri": "/users/{InstanceId}/{UserId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeUserHierarchyGroupRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeUserHierarchyGroupResponse" - }, - "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": "

Describes the specified hierarchy group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyGroupRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "Tags": { + "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

One or more tags.

" } }, - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", + "Password": { + "target": "com.amazonaws.connect#Password", "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The password for the user account. A password is required if you are using Amazon Connect for\n identity management. Otherwise, it is an error to include a password.

" } - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyGroupResponse": { - "type": "structure", - "members": { - "HierarchyGroup": { - "target": "com.amazonaws.connect#HierarchyGroup", + }, + "DirectoryUserId": { + "target": "com.amazonaws.connect#DirectoryUserId", "traits": { - "smithy.api#documentation": "

Information about the hierarchy group.

" + "smithy.api#documentation": "

The identifier of the user account in the directory used for identity management. If Amazon Connect\n cannot access the directory, you can specify this identifier to authenticate users. If you\n include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity\n information is used to authenticate users from your directory.

\n

This parameter is required if you are using an existing directory for identity management in\n Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for\n identity management and include this parameter, an error is returned.

" } - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyStructure": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeUserHierarchyStructureRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeUserHierarchyStructureResponse" - }, - "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": "

Describes the hierarchy structure of the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user-hierarchy-structure/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyStructureRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "Username": { + "target": "com.amazonaws.connect#AgentUsername", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The user name for the account. For instances not using SAML for identity management, the\n user name can include up to 20 characters. If you are using SAML for identity management, the\n user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.

", "smithy.api#required": {} } } } }, - "com.amazonaws.connect#DescribeUserHierarchyStructureResponse": { + "com.amazonaws.connect#CreateUserResponse": { "type": "structure", "members": { - "HierarchyStructure": { - "target": "com.amazonaws.connect#HierarchyStructure", + "UserId": { + "target": "com.amazonaws.connect#UserId", "traits": { - "smithy.api#documentation": "

Information about the hierarchy structure.

" + "smithy.api#documentation": "

The identifier of the user account.

" + } + }, + "UserArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" } } } }, - "com.amazonaws.connect#DescribeUserRequest": { + "com.amazonaws.connect#Credentials": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "RefreshTokenExpiration": { + "target": "com.amazonaws.connect#timestamp", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Renews the expiration timer for a generated token.

" } }, - "UserId": { - "target": "com.amazonaws.connect#UserId", + "RefreshToken": { + "target": "com.amazonaws.connect#SecurityToken", "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Renews a token generated for a user to access the Amazon Connect instance.

" } - } - } - }, - "com.amazonaws.connect#DescribeUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.connect#User", + }, + "AccessTokenExpiration": { + "target": "com.amazonaws.connect#timestamp", "traits": { - "smithy.api#documentation": "

Information about the user account and configuration settings.

" + "smithy.api#documentation": "

A token generated with an expiration time for the session a user is logged in to\n Amazon Connect.

" } - } - } - }, - "com.amazonaws.connect#DestinationNotAllowedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", + }, + "AccessToken": { + "target": "com.amazonaws.connect#SecurityToken", "traits": { - "smithy.api#documentation": "

The message.

" + "smithy.api#documentation": "

An access token generated for a federated user to access Amazon Connect.

" } } }, "traits": { - "smithy.api#documentation": "

Outbound calls to the destination number are not allowed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 + "smithy.api#documentation": "

Contains credentials to use for federation.

" } }, - "com.amazonaws.connect#Dimensions": { + "com.amazonaws.connect#CurrentMetric": { "type": "structure", "members": { - "Channel": { - "target": "com.amazonaws.connect#Channel", + "Name": { + "target": "com.amazonaws.connect#CurrentMetricName", "traits": { - "smithy.api#documentation": "

The channel used for grouping and filters.

" + "smithy.api#documentation": "

The name of the metric.

" } }, - "Queue": { - "target": "com.amazonaws.connect#QueueReference", + "Unit": { + "target": "com.amazonaws.connect#Unit", "traits": { - "smithy.api#documentation": "

Information about the queue for which metrics are returned.

" + "smithy.api#documentation": "

The unit for the metric.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about the dimensions for a set of metrics.

" - } - }, - "com.amazonaws.connect#DirectoryUserId": { - "type": "string" - }, - "com.amazonaws.connect#DisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#DuplicateResourceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

A resource with the specified name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 + "smithy.api#documentation": "

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator\n Guide.

" } }, - "com.amazonaws.connect#Email": { - "type": "string" - }, - "com.amazonaws.connect#Filters": { + "com.amazonaws.connect#CurrentMetricData": { "type": "structure", "members": { - "Channels": { - "target": "com.amazonaws.connect#Channels", + "Metric": { + "target": "com.amazonaws.connect#CurrentMetric", "traits": { - "smithy.api#documentation": "

The channel to use to filter the metrics.

" + "smithy.api#documentation": "

Information about the metric.

" } }, - "Queues": { - "target": "com.amazonaws.connect#Queues", + "Value": { + "target": "com.amazonaws.connect#Value", "traits": { - "smithy.api#documentation": "

The queues to use to filter the metrics. You can specify up to 100 queues per\n request.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

The value of the metric.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the filter to apply when retrieving metrics.

" + "smithy.api#documentation": "

Contains the data for a real-time metric.

" } }, - "com.amazonaws.connect#GetContactAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetContactAttributesRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetContactAttributesResponse" + "com.amazonaws.connect#CurrentMetricDataCollections": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetricData" + } + }, + "com.amazonaws.connect#CurrentMetricName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The current metric names.

", + "smithy.api#enum": [ + { + "value": "AGENTS_ONLINE", + "name": "AGENTS_ONLINE" + }, + { + "value": "AGENTS_AVAILABLE", + "name": "AGENTS_AVAILABLE" + }, + { + "value": "AGENTS_ON_CALL", + "name": "AGENTS_ON_CALL" + }, + { + "value": "AGENTS_NON_PRODUCTIVE", + "name": "AGENTS_NON_PRODUCTIVE" + }, + { + "value": "AGENTS_AFTER_CONTACT_WORK", + "name": "AGENTS_AFTER_CONTACT_WORK" + }, + { + "value": "AGENTS_ERROR", + "name": "AGENTS_ERROR" + }, + { + "value": "AGENTS_STAFFED", + "name": "AGENTS_STAFFED" + }, + { + "value": "CONTACTS_IN_QUEUE", + "name": "CONTACTS_IN_QUEUE" + }, + { + "value": "OLDEST_CONTACT_AGE", + "name": "OLDEST_CONTACT_AGE" + }, + { + "value": "CONTACTS_SCHEDULED", + "name": "CONTACTS_SCHEDULED" + }, + { + "value": "AGENTS_ON_CONTACT", + "name": "AGENTS_ON_CONTACT" + }, + { + "value": "SLOTS_ACTIVE", + "name": "SLOTS_ACTIVE" + }, + { + "value": "SLOTS_AVAILABLE", + "name": "SLOTS_AVAILABLE" + } + ] + } + }, + "com.amazonaws.connect#CurrentMetricResult": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.connect#Dimensions", + "traits": { + "smithy.api#documentation": "

The dimensions for the metrics.

" + } + }, + "Collections": { + "target": "com.amazonaws.connect#CurrentMetricDataCollections", + "traits": { + "smithy.api#documentation": "

The set of metrics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a set of real-time metrics.

" + } + }, + "com.amazonaws.connect#CurrentMetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetricResult" + } + }, + "com.amazonaws.connect#CurrentMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetric" + } + }, + "com.amazonaws.connect#Delay": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 9999 + } + } + }, + "com.amazonaws.connect#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteUserRequest" }, "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": "

Retrieves the contact attributes for the specified contact.

", + "smithy.api#documentation": "

Deletes a user account from the specified Amazon Connect instance.

\n

For information about what happens to a user's data when their account is deleted, see\n Delete Users from\n Your Amazon Connect Instance in the Amazon Connect Administrator\n Guide.

", "smithy.api#http": { - "method": "GET", - "uri": "/contact/attributes/{InstanceId}/{InitialContactId}", + "method": "DELETE", + "uri": "/users/{InstanceId}/{UserId}", "code": 200 } } }, - "com.amazonaws.connect#GetContactAttributesRequest": { + "com.amazonaws.connect#DeleteUserRequest": { "type": "structure", "members": { - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", + "UserId": { + "target": "com.amazonaws.connect#UserId", "traits": { - "smithy.api#documentation": "

The identifier of the initial contact.

", + "smithy.api#documentation": "

The identifier of the user.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1107,26 +1193,18 @@ } } }, - "com.amazonaws.connect#GetContactAttributesResponse": { - "type": "structure", - "members": { - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

Information about the attributes.

" - } - } - } - }, - "com.amazonaws.connect#GetCurrentMetricData": { + "com.amazonaws.connect#DescribeContactFlow": { "type": "operation", "input": { - "target": "com.amazonaws.connect#GetCurrentMetricDataRequest" + "target": "com.amazonaws.connect#DescribeContactFlowRequest" }, "output": { - "target": "com.amazonaws.connect#GetCurrentMetricDataResponse" + "target": "com.amazonaws.connect#DescribeContactFlowResponse" }, "errors": [ + { + "target": "com.amazonaws.connect#ContactFlowNotPublishedException" + }, { "target": "com.amazonaws.connect#InternalServiceException" }, @@ -1144,52 +1222,22 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the real-time metric data from the specified Amazon Connect instance.

\n

For more information, see Real-time Metrics Reports\n in the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Describes the specified contact flow.

\n

You can also create and update contact flows using the Amazon Connect\n Flow language.

", "smithy.api#http": { - "method": "POST", - "uri": "/metrics/current/{InstanceId}", + "method": "GET", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#GetCurrentMetricDataRequest": { + "com.amazonaws.connect#DescribeContactFlowRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.connect#Filters", - "traits": { - "smithy.api#documentation": "

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is\n retrieved only for the resources associated with the queues or channels included in the filter.\n You can include both queue IDs and queue ARNs in the same request. The only supported channel is\n VOICE.

", - "smithy.api#required": {} - } - }, - "Groupings": { - "target": "com.amazonaws.connect#Groupings", - "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when grouped by\n QUEUE, the metrics returned apply to each queue rather than aggregated for all\n queues. If you group by CHANNEL, you should include a Channels filter. The only\n supported channel is VOICE.

\n

If no Grouping is included in the request, a summary of metrics is\n returned.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximimum number of results to return per page.

" - } - }, - "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.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" - } - }, - "CurrentMetrics": { - "target": "com.amazonaws.connect#CurrentMetrics", + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of each metric, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

\n
\n
AGENTS_AFTER_CONTACT_WORK
\n
\n

Unit: COUNT

\n
\n
AGENTS_AVAILABLE
\n
\n

Unit: COUNT

\n
\n
AGENTS_ERROR
\n
\n

Unit: COUNT

\n
\n
AGENTS_NON_PRODUCTIVE
\n
\n

Unit: COUNT

\n
\n
AGENTS_ON_CALL
\n
\n

Unit: COUNT

\n
\n
AGENTS_ON_CONTACT
\n
\n

Unit: COUNT

\n
\n
AGENTS_ONLINE
\n
\n

Unit: COUNT

\n
\n
AGENTS_STAFFED
\n
\n

Unit: COUNT

\n
\n
CONTACTS_IN_QUEUE
\n
\n

Unit: COUNT

\n
\n
CONTACTS_SCHEDULED
\n
\n

Unit: COUNT

\n
\n
OLDEST_CONTACT_AGE
\n
\n

Unit: SECONDS

\n
\n
SLOTS_ACTIVE
\n
\n

Unit: COUNT

\n
\n
SLOTS_AVAILABLE
\n
\n

Unit: COUNT

\n
\n
", + "smithy.api#documentation": "

The identifier of the contact flow.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -1203,41 +1251,26 @@ } } }, - "com.amazonaws.connect#GetCurrentMetricDataResponse": { + "com.amazonaws.connect#DescribeContactFlowResponse": { "type": "structure", "members": { - "MetricResults": { - "target": "com.amazonaws.connect#CurrentMetricResults", - "traits": { - "smithy.api#documentation": "

Information about the real-time metrics.

" - } - }, - "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.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" - } - }, - "DataSnapshotTime": { - "target": "com.amazonaws.connect#timestamp", + "ContactFlow": { + "target": "com.amazonaws.connect#ContactFlow", "traits": { - "smithy.api#documentation": "

The time at which the metrics were retrieved and cached for pagination.

" + "smithy.api#documentation": "

Information about the contact flow.

" } } } }, - "com.amazonaws.connect#GetFederationToken": { + "com.amazonaws.connect#DescribeRoutingProfile": { "type": "operation", "input": { - "target": "com.amazonaws.connect#GetFederationTokenRequest" + "target": "com.amazonaws.connect#DescribeRoutingProfileRequest" }, "output": { - "target": "com.amazonaws.connect#GetFederationTokenResponse" + "target": "com.amazonaws.connect#DescribeRoutingProfileResponse" }, "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, { "target": "com.amazonaws.connect#InternalServiceException" }, @@ -1251,19 +1284,19 @@ "target": "com.amazonaws.connect#ResourceNotFoundException" }, { - "target": "com.amazonaws.connect#UserNotFoundException" + "target": "com.amazonaws.connect#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Retrieves a token for federation.

", + "smithy.api#documentation": "

Describes the specified routing profile.

", "smithy.api#http": { "method": "GET", - "uri": "/user/federate/{InstanceId}", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}", "code": 200 } } }, - "com.amazonaws.connect#GetFederationTokenRequest": { + "com.amazonaws.connect#DescribeRoutingProfileRequest": { "type": "structure", "members": { "InstanceId": { @@ -1273,27 +1306,35 @@ "smithy.api#httpLabel": {}, "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": {} + } } } }, - "com.amazonaws.connect#GetFederationTokenResponse": { + "com.amazonaws.connect#DescribeRoutingProfileResponse": { "type": "structure", "members": { - "Credentials": { - "target": "com.amazonaws.connect#Credentials", + "RoutingProfile": { + "target": "com.amazonaws.connect#RoutingProfile", "traits": { - "smithy.api#documentation": "

The credentials to use for federation.

" + "smithy.api#documentation": "

The routing profile.

" } } } }, - "com.amazonaws.connect#GetMetricData": { + "com.amazonaws.connect#DescribeUser": { "type": "operation", "input": { - "target": "com.amazonaws.connect#GetMetricDataRequest" + "target": "com.amazonaws.connect#DescribeUserRequest" }, "output": { - "target": "com.amazonaws.connect#GetMetricDataResponse" + "target": "com.amazonaws.connect#DescribeUserResponse" }, "errors": [ { @@ -1313,55 +1354,51 @@ } ], "traits": { - "smithy.api#documentation": "

Gets historical metric data from the specified Amazon Connect instance.

\n

For more information, see Historical Metrics Reports in\n the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Describes the specified user account. You can find the instance ID in the console (it’s the\n final part of the ARN). The console does not display the user IDs. Instead, list the users and\n note the IDs provided in the output.

", "smithy.api#http": { - "method": "POST", - "uri": "/metrics/historical/{InstanceId}", + "method": "GET", + "uri": "/users/{InstanceId}/{UserId}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#GetMetricDataRequest": { - "type": "structure", - "members": { - "Groupings": { - "target": "com.amazonaws.connect#Groupings", - "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n

The only supported grouping is QUEUE.

\n

If no grouping is specified, a summary of metrics for all queues is returned.

" - } + "com.amazonaws.connect#DescribeUserHierarchyGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeUserHierarchyGroupRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeUserHierarchyGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" }, - "StartTime": { - "target": "com.amazonaws.connect#timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,\n such as 10:05, 10:10, 10:15.

\n

The start time cannot be earlier than 24 hours before the time of the request. Historical\n metrics are available only for 24 hours.

", - "smithy.api#required": {} - } - }, - "HistoricalMetrics": { - "target": "com.amazonaws.connect#HistoricalMetrics", - "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: Only \"Less than\" comparisons are supported, with the following service level\n thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

\n
\n
", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.connect#InvalidParameterException" }, - "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.

" - } + { + "target": "com.amazonaws.connect#InvalidRequestException" }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximimum number of results to return per page.

" - } + { + "target": "com.amazonaws.connect#ResourceNotFoundException" }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified hierarchy group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyGroupRequest": { + "type": "structure", + "members": { "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { @@ -1370,1016 +1407,1149 @@ "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.connect#timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,\n such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

\n

The time range between the start and end time must be less than 24 hours.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.connect#Filters", + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", "traits": { - "smithy.api#documentation": "

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is\n retrieved only for the resources associated with the queues or channels included in the filter.\n You can include both queue IDs and queue ARNs in the same request. The only supported channel is\n VOICE.

", + "smithy.api#documentation": "

The identifier of the hierarchy group.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#GetMetricDataResponse": { + "com.amazonaws.connect#DescribeUserHierarchyGroupResponse": { "type": "structure", "members": { - "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.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" - } - }, - "MetricResults": { - "target": "com.amazonaws.connect#HistoricalMetricResults", + "HierarchyGroup": { + "target": "com.amazonaws.connect#HierarchyGroup", "traits": { - "smithy.api#documentation": "

Information about the historical metrics.

\n

If no grouping is specified, a summary of metric data is returned.

" + "smithy.api#documentation": "

Information about the hierarchy group.

" } } } }, - "com.amazonaws.connect#Grouping": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "QUEUE", - "name": "QUEUE" - }, - { - "value": "CHANNEL", - "name": "CHANNEL" - } - ] - } - }, - "com.amazonaws.connect#Groupings": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Grouping" + "com.amazonaws.connect#DescribeUserHierarchyStructure": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeUserHierarchyStructureRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeUserHierarchyStructureResponse" }, + "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#length": { - "min": 0, - "max": 2 + "smithy.api#documentation": "

Describes the hierarchy structure of the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user-hierarchy-structure/{InstanceId}", + "code": 200 } } }, - "com.amazonaws.connect#HierarchyGroup": { + "com.amazonaws.connect#DescribeUserHierarchyStructureRequest": { "type": "structure", "members": { - "HierarchyPath": { - "target": "com.amazonaws.connect#HierarchyPath", - "traits": { - "smithy.api#documentation": "

Information about the levels in the hierarchy group.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "LevelId": { - "target": "com.amazonaws.connect#HierarchyLevelId", + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyStructureResponse": { + "type": "structure", + "members": { + "HierarchyStructure": { + "target": "com.amazonaws.connect#HierarchyStructure", "traits": { - "smithy.api#documentation": "

The identifier of the level in the hierarchy group.

" + "smithy.api#documentation": "

Information about the hierarchy structure.

" } - }, - "Name": { - "target": "com.amazonaws.connect#HierarchyGroupName", + } + } + }, + "com.amazonaws.connect#DescribeUserRequest": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", "traits": { - "smithy.api#documentation": "

The name of the hierarchy group.

" + "smithy.api#documentation": "

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.connect#HierarchyGroupId", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a hierarchy group.

" } }, - "com.amazonaws.connect#HierarchyGroupId": { - "type": "string" - }, - "com.amazonaws.connect#HierarchyGroupName": { - "type": "string" - }, - "com.amazonaws.connect#HierarchyGroupSummary": { + "com.amazonaws.connect#DescribeUserResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.connect#HierarchyGroupName", - "traits": { - "smithy.api#documentation": "

The name of the hierarchy group.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#HierarchyGroupId", + "User": { + "target": "com.amazonaws.connect#User", "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

" + "smithy.api#documentation": "

Information about the user account and configuration settings.

" } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + } + } + }, + "com.amazonaws.connect#DestinationNotAllowedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" + "smithy.api#documentation": "

The message.

" } } }, "traits": { - "smithy.api#documentation": "

Contains summary information about a hierarchy group.

" - } - }, - "com.amazonaws.connect#HierarchyGroupSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HierarchyGroupSummary" + "smithy.api#documentation": "

Outbound calls to the destination number are not allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 } }, - "com.amazonaws.connect#HierarchyLevel": { + "com.amazonaws.connect#Dimensions": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.connect#HierarchyLevelName", - "traits": { - "smithy.api#documentation": "

The name of the hierarchy level.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + "Queue": { + "target": "com.amazonaws.connect#QueueReference", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy level.

" + "smithy.api#documentation": "

Information about the queue for which metrics are returned.

" } }, - "Id": { - "target": "com.amazonaws.connect#HierarchyLevelId", + "Channel": { + "target": "com.amazonaws.connect#Channel", "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy level.

" + "smithy.api#documentation": "

The channel used for grouping and filters.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about a hierarchy level.

" + "smithy.api#documentation": "

Contains information about the dimensions for a set of metrics.

" } }, - "com.amazonaws.connect#HierarchyLevelId": { - "type": "string" - }, - "com.amazonaws.connect#HierarchyLevelName": { + "com.amazonaws.connect#DirectoryUserId": { "type": "string" }, - "com.amazonaws.connect#HierarchyPath": { - "type": "structure", - "members": { - "LevelTwo": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", - "traits": { - "smithy.api#documentation": "

Information about level two.

" - } + "com.amazonaws.connect#DisassociateRoutingProfileQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" }, - "LevelThree": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", - "traits": { - "smithy.api#documentation": "

Information about level three.

" - } + { + "target": "com.amazonaws.connect#InvalidParameterException" }, - "LevelFour": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a set of queues from a routing profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

Information about level four.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "LevelOne": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", "traits": { - "smithy.api#documentation": "

Information about level one.

" + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "LevelFive": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", + "QueueReferences": { + "target": "com.amazonaws.connect#RoutingProfileQueueReferenceList", "traits": { - "smithy.api#documentation": "

Information about level five.

" + "smithy.api#documentation": "

The queues to disassociate from this routing profile.

", + "smithy.api#required": {} } } + } + }, + "com.amazonaws.connect#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#DuplicateResourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } }, "traits": { - "smithy.api#documentation": "

Contains information about the levels of a hierarchy group.

" + "smithy.api#documentation": "

A resource with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 } }, - "com.amazonaws.connect#HierarchyStructure": { + "com.amazonaws.connect#Email": { + "type": "string" + }, + "com.amazonaws.connect#Filters": { "type": "structure", "members": { - "LevelFive": { - "target": "com.amazonaws.connect#HierarchyLevel", + "Channels": { + "target": "com.amazonaws.connect#Channels", "traits": { - "smithy.api#documentation": "

Information about level five.

" + "smithy.api#documentation": "

The channel to use to filter the metrics.

" } }, - "LevelThree": { - "target": "com.amazonaws.connect#HierarchyLevel", + "Queues": { + "target": "com.amazonaws.connect#Queues", "traits": { - "smithy.api#documentation": "

Information about level three.

" + "smithy.api#documentation": "

The queues to use to filter the metrics. You can specify up to 100 queues per\n request.

" } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the filter to apply when retrieving metrics.

" + } + }, + "com.amazonaws.connect#GetContactAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetContactAttributesRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetContactAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" }, - "LevelTwo": { - "target": "com.amazonaws.connect#HierarchyLevel", + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the contact attributes for the specified contact.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact/attributes/{InstanceId}/{InitialContactId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetContactAttributesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

Information about level two.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "LevelFour": { - "target": "com.amazonaws.connect#HierarchyLevel", + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

Information about level four.

" + "smithy.api#documentation": "

The identifier of the initial contact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "LevelOne": { - "target": "com.amazonaws.connect#HierarchyLevel", + } + } + }, + "com.amazonaws.connect#GetContactAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.connect#Attributes", "traits": { - "smithy.api#documentation": "

Information about level one.

" + "smithy.api#documentation": "

Information about the attributes.

" } } + } + }, + "com.amazonaws.connect#GetCurrentMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetCurrentMetricDataRequest" }, + "output": { + "target": "com.amazonaws.connect#GetCurrentMetricDataResponse" + }, + "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": "

Contains information about a hierarchy structure.

" + "smithy.api#documentation": "

Gets the real-time metric data from the specified Amazon Connect instance.

\n

For a description of each metric, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/metrics/current/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.connect#HistoricalMetric": { + "com.amazonaws.connect#GetCurrentMetricDataRequest": { "type": "structure", "members": { - "Statistic": { - "target": "com.amazonaws.connect#Statistic", + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", "traits": { - "smithy.api#documentation": "

The statistic for the metric.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximimum number of results to return per page.

" } }, - "Threshold": { - "target": "com.amazonaws.connect#Threshold", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

The threshold for the metric, used with service level metrics.

" + "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.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" } }, - "Name": { - "target": "com.amazonaws.connect#HistoricalMetricName", + "Filters": { + "target": "com.amazonaws.connect#Filters", "traits": { - "smithy.api#documentation": "

The name of the metric.

" + "smithy.api#documentation": "

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is\n retrieved only for the resources associated with the queues or channels included in the filter.\n You can include both queue IDs and queue ARNs in the same request. Both VOICE and CHAT channels are supported.

", + "smithy.api#required": {} } }, - "Unit": { - "target": "com.amazonaws.connect#Unit", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The unit for the metric.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CurrentMetrics": { + "target": "com.amazonaws.connect#CurrentMetrics", + "traits": { + "smithy.api#documentation": "

The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

\n
\n
AGENTS_AFTER_CONTACT_WORK
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: ACW\n

\n\n
\n
AGENTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Available\n

\n
\n
AGENTS_ERROR
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Error\n

\n
\n
AGENTS_NON_PRODUCTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: NPT (Non-Productive Time)\n

\n
\n
AGENTS_ON_CALL
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ON_CONTACT
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ONLINE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Online\n

\n
\n
AGENTS_STAFFED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Staffed\n

\n
\n
CONTACTS_IN_QUEUE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: In\n queue\n

\n
\n
CONTACTS_SCHEDULED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Scheduled\n

\n
\n
OLDEST_CONTACT_AGE
\n
\n

Unit: SECONDS

\n

When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a\n response like this:

\n

\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }

\n

The actual OLDEST_CONTACT_AGE is 24 seconds.

\n\n

Name in real-time metrics report: Oldest\n

\n
\n
SLOTS_ACTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Active\n

\n
\n
SLOTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Availability\n

\n
\n
", + "smithy.api#required": {} + } + }, + "Groupings": { + "target": "com.amazonaws.connect#Groupings", + "traits": { + "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when grouped by\n QUEUE, the metrics returned apply to each queue rather than aggregated for all\n queues. If you group by CHANNEL, you should include a Channels filter. Both VOICE and CHAT channels are supported.

\n

If no Grouping is included in the request, a summary of metrics is\n returned.

" } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

" } }, - "com.amazonaws.connect#HistoricalMetricData": { + "com.amazonaws.connect#GetCurrentMetricDataResponse": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.connect#Value", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The value of the metric.

" + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" } }, - "Metric": { - "target": "com.amazonaws.connect#HistoricalMetric", + "MetricResults": { + "target": "com.amazonaws.connect#CurrentMetricResults", "traits": { - "smithy.api#documentation": "

Information about the metric.

" + "smithy.api#documentation": "

Information about the real-time metrics.

" + } + }, + "DataSnapshotTime": { + "target": "com.amazonaws.connect#timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the metrics were retrieved and cached for pagination.

" } } - }, - "traits": { - "smithy.api#documentation": "

Contains the data for a historical metric.

" - } - }, - "com.amazonaws.connect#HistoricalMetricDataCollections": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HistoricalMetricData" } }, - "com.amazonaws.connect#HistoricalMetricName": { - "type": "string", + "com.amazonaws.connect#GetFederationToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetFederationTokenRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetFederationTokenResponse" + }, + "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#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#UserNotFoundException" + } + ], "traits": { - "smithy.api#documentation": "

The historical metric names.

", - "smithy.api#enum": [ - { - "value": "CONTACTS_QUEUED", - "name": "CONTACTS_QUEUED" - }, - { - "value": "CONTACTS_HANDLED", - "name": "CONTACTS_HANDLED" - }, - { - "value": "CONTACTS_ABANDONED", - "name": "CONTACTS_ABANDONED" - }, - { - "value": "CONTACTS_CONSULTED", - "name": "CONTACTS_CONSULTED" - }, - { - "value": "CONTACTS_AGENT_HUNG_UP_FIRST", - "name": "CONTACTS_AGENT_HUNG_UP_FIRST" - }, - { - "value": "CONTACTS_HANDLED_INCOMING", - "name": "CONTACTS_HANDLED_INCOMING" - }, - { - "value": "CONTACTS_HANDLED_OUTBOUND", - "name": "CONTACTS_HANDLED_OUTBOUND" - }, - { - "value": "CONTACTS_HOLD_ABANDONS", - "name": "CONTACTS_HOLD_ABANDONS" - }, - { - "value": "CONTACTS_TRANSFERRED_IN", - "name": "CONTACTS_TRANSFERRED_IN" - }, - { - "value": "CONTACTS_TRANSFERRED_OUT", - "name": "CONTACTS_TRANSFERRED_OUT" - }, - { - "value": "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", - "name": "CONTACTS_TRANSFERRED_IN_FROM_QUEUE" - }, - { - "value": "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", - "name": "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE" - }, - { - "value": "CONTACTS_MISSED", - "name": "CONTACTS_MISSED" - }, - { - "value": "CALLBACK_CONTACTS_HANDLED", - "name": "CALLBACK_CONTACTS_HANDLED" - }, - { - "value": "API_CONTACTS_HANDLED", - "name": "API_CONTACTS_HANDLED" - }, - { - "value": "OCCUPANCY", - "name": "OCCUPANCY" - }, - { - "value": "HANDLE_TIME", - "name": "HANDLE_TIME" - }, - { - "value": "AFTER_CONTACT_WORK_TIME", - "name": "AFTER_CONTACT_WORK_TIME" - }, - { - "value": "QUEUED_TIME", - "name": "QUEUED_TIME" - }, - { - "value": "ABANDON_TIME", - "name": "ABANDON_TIME" - }, - { - "value": "QUEUE_ANSWER_TIME", - "name": "QUEUE_ANSWER_TIME" - }, - { - "value": "HOLD_TIME", - "name": "HOLD_TIME" - }, - { - "value": "INTERACTION_TIME", - "name": "INTERACTION_TIME" - }, - { - "value": "INTERACTION_AND_HOLD_TIME", - "name": "INTERACTION_AND_HOLD_TIME" - }, - { - "value": "SERVICE_LEVEL", - "name": "SERVICE_LEVEL" - } - ] + "smithy.api#documentation": "

Retrieves a token for federation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user/federate/{InstanceId}", + "code": 200 + } } }, - "com.amazonaws.connect#HistoricalMetricResult": { + "com.amazonaws.connect#GetFederationTokenRequest": { "type": "structure", "members": { - "Collections": { - "target": "com.amazonaws.connect#HistoricalMetricDataCollections", - "traits": { - "smithy.api#documentation": "

The set of metrics.

" - } - }, - "Dimensions": { - "target": "com.amazonaws.connect#Dimensions", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The dimension for the metrics.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the historical metrics retrieved.

" } }, - "com.amazonaws.connect#HistoricalMetricResults": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HistoricalMetricResult" + "com.amazonaws.connect#GetFederationTokenResponse": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.connect#Credentials", + "traits": { + "smithy.api#documentation": "

The credentials to use for federation.

" + } + } } }, - "com.amazonaws.connect#HistoricalMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HistoricalMetric" + "com.amazonaws.connect#GetMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetMetricDataResponse" + }, + "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": "

Gets historical metric data from the specified Amazon Connect instance.

\n

For a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/metrics/historical/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.connect#HoursOfOperationId": { - "type": "string" - }, - "com.amazonaws.connect#HoursOfOperationName": { - "type": "string" - }, - "com.amazonaws.connect#HoursOfOperationSummary": { + "com.amazonaws.connect#GetMetricDataRequest": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.connect#ARN", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hours of operation.

" + "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.

" } }, - "Id": { - "target": "com.amazonaws.connect#HoursOfOperationId", + "EndTime": { + "target": "com.amazonaws.connect#timestamp", "traits": { - "smithy.api#documentation": "

The identifier of the hours of operation.

" + "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,\n such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

\n

The time range between the start and end time must be less than 24 hours.

", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.connect#HoursOfOperationName", + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", "traits": { - "smithy.api#documentation": "

The name of the hours of operation.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximimum number of results to return per page.

" + } + }, + "HistoricalMetrics": { + "target": "com.amazonaws.connect#HistoricalMetrics", + "traits": { + "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: Only \"Less than\" comparisons are supported, with the following service level\n thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

\n
\n
", + "smithy.api#required": {} + } + }, + "Groupings": { + "target": "com.amazonaws.connect#Groupings", + "traits": { + "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n

The only supported grouping is QUEUE.

\n

If no grouping is specified, a summary of metrics for all queues is returned.

" + } + }, + "StartTime": { + "target": "com.amazonaws.connect#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,\n such as 10:05, 10:10, 10:15.

\n

The start time cannot be earlier than 24 hours before the time of the request. Historical\n metrics are available only for 24 hours.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.connect#Filters", + "traits": { + "smithy.api#documentation": "

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is\n retrieved only for the resources associated with the queues or channels included in the filter.\n You can include both queue IDs and queue ARNs in the same request. Both VOICE and CHAT channels are supported.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

Contains summary information about hours of operation for a contact center.

" - } - }, - "com.amazonaws.connect#HoursOfOperationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HoursOfOperationSummary" - } - }, - "com.amazonaws.connect#InstanceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 } } }, - "com.amazonaws.connect#InternalServiceException": { + "com.amazonaws.connect#GetMetricDataResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.connect#Message", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

The message.

" + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" + } + }, + "MetricResults": { + "target": "com.amazonaws.connect#HistoricalMetricResults", + "traits": { + "smithy.api#documentation": "

Information about the historical metrics.

\n

If no grouping is specified, a summary of metric data is returned.

" } } - }, - "traits": { - "smithy.api#documentation": "

Request processing failed due to an error or failure with the service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 } }, - "com.amazonaws.connect#InvalidParameterException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message.

" + "com.amazonaws.connect#Grouping": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUEUE", + "name": "QUEUE" + }, + { + "value": "CHANNEL", + "name": "CHANNEL" } - } + ] + } + }, + "com.amazonaws.connect#Groupings": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Grouping" }, "traits": { - "smithy.api#documentation": "

One or more of the specified parameters are not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#length": { + "min": 0, + "max": 2 + } } }, - "com.amazonaws.connect#InvalidRequestException": { + "com.amazonaws.connect#HierarchyGroup": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.connect#Message", + "Id": { + "target": "com.amazonaws.connect#HierarchyGroupId", "traits": { - "smithy.api#documentation": "

The message.

" + "smithy.api#documentation": "

The identifier of the hierarchy group.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" + } + }, + "LevelId": { + "target": "com.amazonaws.connect#HierarchyLevelId", + "traits": { + "smithy.api#documentation": "

The identifier of the level in the hierarchy group.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#HierarchyGroupName", + "traits": { + "smithy.api#documentation": "

The name of the hierarchy group.

" + } + }, + "HierarchyPath": { + "target": "com.amazonaws.connect#HierarchyPath", + "traits": { + "smithy.api#documentation": "

Information about the levels in the hierarchy group.

" } } }, "traits": { - "smithy.api#documentation": "

The request is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "

Contains information about a hierarchy group.

" } }, - "com.amazonaws.connect#LimitExceededException": { + "com.amazonaws.connect#HierarchyGroupId": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyGroupName": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyGroupSummary": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.connect#Message", + "Id": { + "target": "com.amazonaws.connect#HierarchyGroupId", "traits": { - "smithy.api#documentation": "

The message.

" + "smithy.api#documentation": "

The identifier of the hierarchy group.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#HierarchyGroupName", + "traits": { + "smithy.api#documentation": "

The name of the hierarchy group.

" } } }, "traits": { - "smithy.api#documentation": "

The allowed limit for the resource has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 + "smithy.api#documentation": "

Contains summary information about a hierarchy group.

" } }, - "com.amazonaws.connect#ListContactFlows": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListContactFlowsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListContactFlowsResponse" - }, - "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 information about the contact flows for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/contact-flows-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ContactFlowSummaryList", - "pageSize": "MaxResults" - } + "com.amazonaws.connect#HierarchyGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HierarchyGroupSummary" } }, - "com.amazonaws.connect#ListContactFlowsRequest": { + "com.amazonaws.connect#HierarchyLevel": { "type": "structure", "members": { - "ContactFlowTypes": { - "target": "com.amazonaws.connect#ContactFlowTypes", - "traits": { - "smithy.api#documentation": "

The type of contact flow.

", - "smithy.api#httpQuery": "contactFlowTypes" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "Arn": { + "target": "com.amazonaws.connect#ARN", "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" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy level.

" } }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "Name": { + "target": "com.amazonaws.connect#HierarchyLevelName", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the hierarchy level.

" } }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", + "Id": { + "target": "com.amazonaws.connect#HierarchyLevelId", "traits": { - "smithy.api#documentation": "

The maximimum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The identifier of the hierarchy level.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a hierarchy level.

" } }, - "com.amazonaws.connect#ListContactFlowsResponse": { + "com.amazonaws.connect#HierarchyLevelId": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyLevelName": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyPath": { "type": "structure", "members": { - "ContactFlowSummaryList": { - "target": "com.amazonaws.connect#ContactFlowSummaryList", + "LevelFour": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", "traits": { - "smithy.api#documentation": "

Information about the contact flows.

" + "smithy.api#documentation": "

Information about level four.

" } }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "LevelOne": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + "smithy.api#documentation": "

Information about level one.

" } - } - } - }, - "com.amazonaws.connect#ListHoursOfOperations": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListHoursOfOperationsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListHoursOfOperationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" }, - { - "target": "com.amazonaws.connect#InvalidRequestException" + "LevelTwo": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level two.

" + } }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" + "LevelThree": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level three.

" + } }, - { - "target": "com.amazonaws.connect#ThrottlingException" + "LevelFive": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level five.

" + } } - ], + }, "traits": { - "smithy.api#documentation": "

Provides information about the hours of operation for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/hours-of-operations-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "HoursOfOperationSummaryList", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "

Contains information about the levels of a hierarchy group.

" } }, - "com.amazonaws.connect#ListHoursOfOperationsRequest": { + "com.amazonaws.connect#HierarchyStructure": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "LevelThree": { + "target": "com.amazonaws.connect#HierarchyLevel", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Information about level three.

" } }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", + "LevelTwo": { + "target": "com.amazonaws.connect#HierarchyLevel", "traits": { - "smithy.api#documentation": "

The maximimum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

Information about level two.

" } }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "LevelOne": { + "target": "com.amazonaws.connect#HierarchyLevel", "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" + "smithy.api#documentation": "

Information about level one.

" } - } - } - }, - "com.amazonaws.connect#ListHoursOfOperationsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + }, + "LevelFour": { + "target": "com.amazonaws.connect#HierarchyLevel", "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + "smithy.api#documentation": "

Information about level four.

" } }, - "HoursOfOperationSummaryList": { - "target": "com.amazonaws.connect#HoursOfOperationSummaryList", + "LevelFive": { + "target": "com.amazonaws.connect#HierarchyLevel", "traits": { - "smithy.api#documentation": "

Information about the hours of operation.

" + "smithy.api#documentation": "

Information about level five.

" } } - } - }, - "com.amazonaws.connect#ListPhoneNumbers": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListPhoneNumbersRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListPhoneNumbersResponse" }, - "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 information about the phone numbers for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/phone-numbers-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PhoneNumberSummaryList", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "

Contains information about a hierarchy structure.

" } }, - "com.amazonaws.connect#ListPhoneNumbersRequest": { + "com.amazonaws.connect#HistoricalMetric": { "type": "structure", "members": { - "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" - } - }, - "PhoneNumberTypes": { - "target": "com.amazonaws.connect#PhoneNumberTypes", + "Threshold": { + "target": "com.amazonaws.connect#Threshold", "traits": { - "smithy.api#documentation": "

The type of phone number.

", - "smithy.api#httpQuery": "phoneNumberTypes" + "smithy.api#documentation": "

The threshold for the metric, used with service level metrics.

" } }, - "PhoneNumberCountryCodes": { - "target": "com.amazonaws.connect#PhoneNumberCountryCodes", + "Name": { + "target": "com.amazonaws.connect#HistoricalMetricName", "traits": { - "smithy.api#documentation": "

The ISO country code.

", - "smithy.api#httpQuery": "phoneNumberCountryCodes" + "smithy.api#documentation": "

The name of the metric.

" } }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "Statistic": { + "target": "com.amazonaws.connect#Statistic", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The statistic for the metric.

" } }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", + "Unit": { + "target": "com.amazonaws.connect#Unit", "traits": { - "smithy.api#documentation": "

The maximimum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The unit for the metric.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

" } }, - "com.amazonaws.connect#ListPhoneNumbersResponse": { + "com.amazonaws.connect#HistoricalMetricData": { "type": "structure", "members": { - "PhoneNumberSummaryList": { - "target": "com.amazonaws.connect#PhoneNumberSummaryList", + "Value": { + "target": "com.amazonaws.connect#Value", "traits": { - "smithy.api#documentation": "

Information about the phone numbers.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

The value of the metric.

" } }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "Metric": { + "target": "com.amazonaws.connect#HistoricalMetric", "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 metric.

" } } - } - }, - "com.amazonaws.connect#ListQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListQueuesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListQueuesResponse" }, - "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 information about the queues for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/queues-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "QueueSummaryList", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "

Contains the data for a historical metric.

" } }, - "com.amazonaws.connect#ListQueuesRequest": { - "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#documentation": "

The maximimum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "QueueTypes": { - "target": "com.amazonaws.connect#QueueTypes", - "traits": { - "smithy.api#documentation": "

The type of queue.

", - "smithy.api#httpQuery": "queueTypes" + "com.amazonaws.connect#HistoricalMetricDataCollections": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HistoricalMetricData" + } + }, + "com.amazonaws.connect#HistoricalMetricName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The historical metric names.

", + "smithy.api#enum": [ + { + "value": "CONTACTS_QUEUED", + "name": "CONTACTS_QUEUED" + }, + { + "value": "CONTACTS_HANDLED", + "name": "CONTACTS_HANDLED" + }, + { + "value": "CONTACTS_ABANDONED", + "name": "CONTACTS_ABANDONED" + }, + { + "value": "CONTACTS_CONSULTED", + "name": "CONTACTS_CONSULTED" + }, + { + "value": "CONTACTS_AGENT_HUNG_UP_FIRST", + "name": "CONTACTS_AGENT_HUNG_UP_FIRST" + }, + { + "value": "CONTACTS_HANDLED_INCOMING", + "name": "CONTACTS_HANDLED_INCOMING" + }, + { + "value": "CONTACTS_HANDLED_OUTBOUND", + "name": "CONTACTS_HANDLED_OUTBOUND" + }, + { + "value": "CONTACTS_HOLD_ABANDONS", + "name": "CONTACTS_HOLD_ABANDONS" + }, + { + "value": "CONTACTS_TRANSFERRED_IN", + "name": "CONTACTS_TRANSFERRED_IN" + }, + { + "value": "CONTACTS_TRANSFERRED_OUT", + "name": "CONTACTS_TRANSFERRED_OUT" + }, + { + "value": "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", + "name": "CONTACTS_TRANSFERRED_IN_FROM_QUEUE" + }, + { + "value": "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", + "name": "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE" + }, + { + "value": "CONTACTS_MISSED", + "name": "CONTACTS_MISSED" + }, + { + "value": "CALLBACK_CONTACTS_HANDLED", + "name": "CALLBACK_CONTACTS_HANDLED" + }, + { + "value": "API_CONTACTS_HANDLED", + "name": "API_CONTACTS_HANDLED" + }, + { + "value": "OCCUPANCY", + "name": "OCCUPANCY" + }, + { + "value": "HANDLE_TIME", + "name": "HANDLE_TIME" + }, + { + "value": "AFTER_CONTACT_WORK_TIME", + "name": "AFTER_CONTACT_WORK_TIME" + }, + { + "value": "QUEUED_TIME", + "name": "QUEUED_TIME" + }, + { + "value": "ABANDON_TIME", + "name": "ABANDON_TIME" + }, + { + "value": "QUEUE_ANSWER_TIME", + "name": "QUEUE_ANSWER_TIME" + }, + { + "value": "HOLD_TIME", + "name": "HOLD_TIME" + }, + { + "value": "INTERACTION_TIME", + "name": "INTERACTION_TIME" + }, + { + "value": "INTERACTION_AND_HOLD_TIME", + "name": "INTERACTION_AND_HOLD_TIME" + }, + { + "value": "SERVICE_LEVEL", + "name": "SERVICE_LEVEL" } - } + ] } }, - "com.amazonaws.connect#ListQueuesResponse": { + "com.amazonaws.connect#HistoricalMetricResult": { "type": "structure", "members": { - "QueueSummaryList": { - "target": "com.amazonaws.connect#QueueSummaryList", + "Dimensions": { + "target": "com.amazonaws.connect#Dimensions", "traits": { - "smithy.api#documentation": "

Information about the queues.

" + "smithy.api#documentation": "

The dimension for the metrics.

" } }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "Collections": { + "target": "com.amazonaws.connect#HistoricalMetricDataCollections", "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + "smithy.api#documentation": "

The set of metrics.

" } } - } - }, - "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.

", - "smithy.api#http": { - "method": "GET", - "uri": "/routing-profiles-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "RoutingProfileSummaryList", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "

Contains information about the historical metrics retrieved.

" } }, - "com.amazonaws.connect#ListRoutingProfilesRequest": { + "com.amazonaws.connect#HistoricalMetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HistoricalMetricResult" + } + }, + "com.amazonaws.connect#HistoricalMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HistoricalMetric" + } + }, + "com.amazonaws.connect#HoursOfOperationId": { + "type": "string" + }, + "com.amazonaws.connect#HoursOfOperationName": { + "type": "string" + }, + "com.amazonaws.connect#HoursOfOperationSummary": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "Arn": { + "target": "com.amazonaws.connect#ARN", "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" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hours of operation.

" } }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "Name": { + "target": "com.amazonaws.connect#HoursOfOperationName", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the hours of operation.

" } }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", + "Id": { + "target": "com.amazonaws.connect#HoursOfOperationId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximimum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The identifier of the hours of operation.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about hours of operation for a contact center.

" } }, - "com.amazonaws.connect#ListRoutingProfilesResponse": { + "com.amazonaws.connect#HoursOfOperationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HoursOfOperationSummary" + } + }, + "com.amazonaws.connect#InstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#InternalServiceException": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "Message": { + "target": "com.amazonaws.connect#Message", "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + "smithy.api#documentation": "

The message.

" } - }, - "RoutingProfileSummaryList": { - "target": "com.amazonaws.connect#RoutingProfileSummaryList", + } + }, + "traits": { + "smithy.api#documentation": "

Request processing failed due to an error or failure with the service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.connect#InvalidContactFlowException": { + "type": "structure", + "members": { + "problems": { + "target": "com.amazonaws.connect#Problems", "traits": { - "smithy.api#documentation": "

Information about the routing profiles.

" + "smithy.api#documentation": "

The problems with the contact flow. Please fix before trying again.

" } } + }, + "traits": { + "smithy.api#documentation": "

The contact flow is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, - "com.amazonaws.connect#ListSecurityProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListSecurityProfilesRequest" + "com.amazonaws.connect#InvalidParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more of the specified parameters are not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.connect#InvalidRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.connect#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The allowed limit for the resource has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.connect#ListContactFlows": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListContactFlowsRequest" }, "output": { - "target": "com.amazonaws.connect#ListSecurityProfilesResponse" + "target": "com.amazonaws.connect#ListContactFlowsResponse" }, "errors": [ { @@ -2399,72 +2569,78 @@ } ], "traits": { - "smithy.api#documentation": "

Provides summary information about the security profiles for the specified Amazon Connect\n instance.

", + "smithy.api#documentation": "

Provides information about the contact flows for the specified Amazon Connect instance.

\n

You can also create and update contact flows using the Amazon Connect\n Flow language.

\n

For more information about contact flows, see Contact Flows in the\n Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "GET", - "uri": "/security-profiles-summary/{InstanceId}", + "uri": "/contact-flows-summary/{InstanceId}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "SecurityProfileSummaryList", + "items": "ContactFlowSummaryList", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListSecurityProfilesRequest": { + "com.amazonaws.connect#ListContactFlowsRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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" } }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "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" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowTypes": { + "target": "com.amazonaws.connect#ContactFlowTypes", + "traits": { + "smithy.api#documentation": "

The type of contact flow.

", + "smithy.api#httpQuery": "contactFlowTypes" } } } }, - "com.amazonaws.connect#ListSecurityProfilesResponse": { + "com.amazonaws.connect#ListContactFlowsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "ContactFlowSummaryList": { + "target": "com.amazonaws.connect#ContactFlowSummaryList", "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 contact flows.

" } }, - "SecurityProfileSummaryList": { - "target": "com.amazonaws.connect#SecurityProfileSummaryList", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

Information about the security profiles.

" + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" } } } }, - "com.amazonaws.connect#ListTagsForResource": { + "com.amazonaws.connect#ListHoursOfOperations": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListTagsForResourceRequest" + "target": "com.amazonaws.connect#ListHoursOfOperationsRequest" }, "output": { - "target": "com.amazonaws.connect#ListTagsForResourceResponse" + "target": "com.amazonaws.connect#ListHoursOfOperationsResponse" }, "errors": [ { @@ -2484,45 +2660,71 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags for the specified resource.

", + "smithy.api#documentation": "

Provides information about the hours of operation for the specified Amazon Connect instance.

\n

For more information about hours of operation, see Set the Hours of Operation for a\n Queue in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", + "uri": "/hours-of-operations-summary/{InstanceId}", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HoursOfOperationSummaryList", + "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListTagsForResourceRequest": { + "com.amazonaws.connect#ListHoursOfOperationsRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.connect#ARN", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#documentation": "

The maximimum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "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" + } } } }, - "com.amazonaws.connect#ListTagsForResourceResponse": { + "com.amazonaws.connect#ListHoursOfOperationsResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.connect#TagMap", + "HoursOfOperationSummaryList": { + "target": "com.amazonaws.connect#HoursOfOperationSummaryList", "traits": { - "smithy.api#documentation": "

Information about the tags.

" + "smithy.api#documentation": "

Information about the hours of operation.

" + } + }, + "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#ListUserHierarchyGroups": { + "com.amazonaws.connect#ListPhoneNumbers": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListUserHierarchyGroupsRequest" + "target": "com.amazonaws.connect#ListPhoneNumbersRequest" }, "output": { - "target": "com.amazonaws.connect#ListUserHierarchyGroupsResponse" + "target": "com.amazonaws.connect#ListPhoneNumbersResponse" }, "errors": [ { @@ -2542,29 +2744,28 @@ } ], "traits": { - "smithy.api#documentation": "

Provides summary information about the hierarchy groups for the specified Amazon Connect\n instance.

", + "smithy.api#documentation": "

Provides information about the phone numbers for the specified Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "GET", - "uri": "/user-hierarchy-groups-summary/{InstanceId}", + "uri": "/phone-numbers-summary/{InstanceId}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "UserHierarchyGroupSummaryList", + "items": "PhoneNumberSummaryList", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListUserHierarchyGroupsRequest": { + "com.amazonaws.connect#ListPhoneNumbersRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", + "PhoneNumberTypes": { + "target": "com.amazonaws.connect#PhoneNumberTypes", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximimum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The type of phone number.

", + "smithy.api#httpQuery": "phoneNumberTypes" } }, "NextToken": { @@ -2574,6 +2775,13 @@ "smithy.api#httpQuery": "nextToken" } }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#documentation": "

The maximimum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { @@ -2581,33 +2789,40 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "PhoneNumberCountryCodes": { + "target": "com.amazonaws.connect#PhoneNumberCountryCodes", + "traits": { + "smithy.api#documentation": "

The ISO country code.

", + "smithy.api#httpQuery": "phoneNumberCountryCodes" + } } } }, - "com.amazonaws.connect#ListUserHierarchyGroupsResponse": { + "com.amazonaws.connect#ListPhoneNumbersResponse": { "type": "structure", "members": { - "UserHierarchyGroupSummaryList": { - "target": "com.amazonaws.connect#HierarchyGroupSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the hierarchy groups.

" - } - }, "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.

" } + }, + "PhoneNumberSummaryList": { + "target": "com.amazonaws.connect#PhoneNumberSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the phone numbers.

" + } } } }, - "com.amazonaws.connect#ListUsers": { + "com.amazonaws.connect#ListPrompts": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListUsersRequest" + "target": "com.amazonaws.connect#ListPromptsRequest" }, "output": { - "target": "com.amazonaws.connect#ListUsersResponse" + "target": "com.amazonaws.connect#ListPromptsResponse" }, "errors": [ { @@ -2627,49 +2842,49 @@ } ], "traits": { - "smithy.api#documentation": "

Provides summary information about the users for the specified Amazon Connect instance.

", + "smithy.api#documentation": "

Provides information about the prompts for the specified Amazon Connect\n instance.

", "smithy.api#http": { "method": "GET", - "uri": "/users-summary/{InstanceId}", + "uri": "/prompts-summary/{InstanceId}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "UserSummaryList", + "items": "PromptSummaryList", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListUsersRequest": { + "com.amazonaws.connect#ListPromptsRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n 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#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "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" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } }, - "com.amazonaws.connect#ListUsersResponse": { + "com.amazonaws.connect#ListPromptsResponse": { "type": "structure", "members": { "NextToken": { @@ -2678,110 +2893,720 @@ "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" } }, - "UserSummaryList": { - "target": "com.amazonaws.connect#UserSummaryList", + "PromptSummaryList": { + "target": "com.amazonaws.connect#PromptSummaryList", "traits": { - "smithy.api#documentation": "

Information about the users.

" + "smithy.api#documentation": "

Information about the prompts.

" } } } }, - "com.amazonaws.connect#MaxResult100": { - "type": "integer", + "com.amazonaws.connect#ListQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListQueuesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListQueuesResponse" + }, + "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#range": { - "min": 1, - "max": 100 + "smithy.api#documentation": "

Provides information about the queues for the specified Amazon Connect instance.

\n

For more information about queues, see Queues: Standard and\n Agent in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/queues-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QueueSummaryList", + "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#MaxResult1000": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 + "com.amazonaws.connect#ListQueuesRequest": { + "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#documentation": "

The maximimum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "QueueTypes": { + "target": "com.amazonaws.connect#QueueTypes", + "traits": { + "smithy.api#documentation": "

The type of queue.

", + "smithy.api#httpQuery": "queueTypes" + } } } }, - "com.amazonaws.connect#Message": { - "type": "string" - }, - "com.amazonaws.connect#NextToken": { - "type": "string" - }, - "com.amazonaws.connect#OutboundContactNotPermittedException": { + "com.amazonaws.connect#ListQueuesResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.connect#Message", + "QueueSummaryList": { + "target": "com.amazonaws.connect#QueueSummaryList", "traits": { - "smithy.api#documentation": "

The message.

" + "smithy.api#documentation": "

Information about the queues.

" + } + }, + "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#ListRoutingProfileQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRoutingProfileQueuesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListRoutingProfileQueuesResponse" }, + "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": "

The contact is not permitted.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 + "smithy.api#documentation": "

List the queues associated with a routing profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RoutingProfileQueueConfigSummaryList", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.connect#ParticipantDetails": { + "com.amazonaws.connect#ListRoutingProfileQueuesRequest": { "type": "structure", "members": { - "DisplayName": { - "target": "com.amazonaws.connect#DisplayName", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

Display name of the participant.

", + "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" + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximimum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

The customer's details.

" } }, - "com.amazonaws.connect#ParticipantId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 + "com.amazonaws.connect#ListRoutingProfileQueuesResponse": { + "type": "structure", + "members": { + "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#ParticipantToken": { - "type": "string", + "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#length": { - "min": 1, - "max": 1000 + "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#Password": { - "type": "string", - "traits": { - "smithy.api#pattern": "/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/" + "com.amazonaws.connect#ListRoutingProfilesRequest": { + "type": "structure", + "members": { + "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" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "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#PhoneNumber": { - "type": "string" + "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#PhoneNumberCountryCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AF", - "name": "AF" - }, - { - "value": "AL", - "name": "AL" - }, - { - "value": "DZ", + "com.amazonaws.connect#ListSecurityProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListSecurityProfilesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListSecurityProfilesResponse" + }, + "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 security profiles for the specified Amazon Connect\n instance.

\n

For more information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/security-profiles-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityProfileSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListSecurityProfilesRequest": { + "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#ListSecurityProfilesResponse": { + "type": "structure", + "members": { + "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.

" + } + }, + "SecurityProfileSummaryList": { + "target": "com.amazonaws.connect#SecurityProfileSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the security profiles.

" + } + } + } + }, + "com.amazonaws.connect#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListTagsForResourceResponse" + }, + "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": "

Lists the tags for the specified resource.

\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": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.connect#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

Information about the tags.

" + } + } + } + }, + "com.amazonaws.connect#ListUserHierarchyGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListUserHierarchyGroupsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListUserHierarchyGroupsResponse" + }, + "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 hierarchy groups for the specified Amazon Connect\n instance.

\n

For more information about agent hierarchies, see Set Up Agent Hierarchies in the\n Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user-hierarchy-groups-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserHierarchyGroupSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListUserHierarchyGroupsRequest": { + "type": "structure", + "members": { + "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" + } + }, + "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" + } + } + } + }, + "com.amazonaws.connect#ListUserHierarchyGroupsResponse": { + "type": "structure", + "members": { + "UserHierarchyGroupSummaryList": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the hierarchy groups.

" + } + }, + "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#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListUsersResponse" + }, + "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 users for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/users-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListUsersRequest": { + "type": "structure", + "members": { + "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" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "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#ListUsersResponse": { + "type": "structure", + "members": { + "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.

" + } + }, + "UserSummaryList": { + "target": "com.amazonaws.connect#UserSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the users.

" + } + } + } + }, + "com.amazonaws.connect#MaxResult100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#MaxResult1000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.connect#MediaConcurrencies": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#MediaConcurrency" + } + }, + "com.amazonaws.connect#MediaConcurrency": { + "type": "structure", + "members": { + "Concurrency": { + "target": "com.amazonaws.connect#Concurrency", + "traits": { + "smithy.api#documentation": "

The number of contacts an agent can have on a channel simultaneously.

", + "smithy.api#required": {} + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

The channels that agents can handle in the Contact Control Panel (CCP).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about which channels are supported, and how many contacts an agent can\n have on a channel simultaneously.

" + } + }, + "com.amazonaws.connect#Message": { + "type": "string" + }, + "com.amazonaws.connect#NextToken": { + "type": "string" + }, + "com.amazonaws.connect#OutboundContactNotPermittedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The contact is not permitted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.connect#ParticipantDetails": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.connect#DisplayName", + "traits": { + "smithy.api#documentation": "

Display name of the participant.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The customer's details.

" + } + }, + "com.amazonaws.connect#ParticipantId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#ParticipantToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.connect#Password": { + "type": "string", + "traits": { + "smithy.api#pattern": "/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/" + } + }, + "com.amazonaws.connect#PhoneNumber": { + "type": "string" + }, + "com.amazonaws.connect#PhoneNumberCountryCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AF", + "name": "AF" + }, + { + "value": "AL", + "name": "AL" + }, + { + "value": "DZ", "name": "DZ" }, { @@ -3697,265 +4522,1034 @@ "name": "VE" }, { - "value": "VN", - "name": "VN" + "value": "VN", + "name": "VN" + }, + { + "value": "WF", + "name": "WF" + }, + { + "value": "EH", + "name": "EH" + }, + { + "value": "YE", + "name": "YE" + }, + { + "value": "ZM", + "name": "ZM" + }, + { + "value": "ZW", + "name": "ZW" + } + ] + } + }, + "com.amazonaws.connect#PhoneNumberCountryCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.connect#PhoneNumberId": { + "type": "string" + }, + "com.amazonaws.connect#PhoneNumberSummary": { + "type": "structure", + "members": { + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a phone number for a contact center.

" + } + }, + "com.amazonaws.connect#PhoneNumberSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PhoneNumberSummary" + } + }, + "com.amazonaws.connect#PhoneNumberType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TOLL_FREE", + "name": "TOLL_FREE" }, { - "value": "WF", - "name": "WF" - }, + "value": "DID", + "name": "DID" + } + ] + } + }, + "com.amazonaws.connect#PhoneNumberTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PhoneNumberType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.connect#PhoneType": { + "type": "string", + "traits": { + "smithy.api#enum": [ { - "value": "EH", - "name": "EH" + "value": "SOFT_PHONE", + "name": "SOFT_PHONE" }, { - "value": "YE", - "name": "YE" - }, + "value": "DESK_PHONE", + "name": "DESK_PHONE" + } + ] + } + }, + "com.amazonaws.connect#Priority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 99 + } + } + }, + "com.amazonaws.connect#ProblemDetail": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.connect#ProblemMessageString", + "traits": { + "smithy.api#documentation": "

The problem detail's message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a problem detail.

" + } + }, + "com.amazonaws.connect#ProblemMessageString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#Problems": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ProblemDetail" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.connect#PromptId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#PromptName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#PromptSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the prompt.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#PromptId", + "traits": { + "smithy.api#documentation": "

The identifier of the prompt.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#PromptName", + "traits": { + "smithy.api#documentation": "

The name of the prompt.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the prompt.

" + } + }, + "com.amazonaws.connect#PromptSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PromptSummary" + } + }, + "com.amazonaws.connect#QueueId": { + "type": "string" + }, + "com.amazonaws.connect#QueueName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#QueueReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the queue.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a queue resource for which metrics are returned.

" + } + }, + "com.amazonaws.connect#QueueSummary": { + "type": "structure", + "members": { + "QueueType": { + "target": "com.amazonaws.connect#QueueType", + "traits": { + "smithy.api#documentation": "

The type of queue.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#QueueName", + "traits": { + "smithy.api#documentation": "

The name of the queue.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the queue.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a queue.

" + } + }, + "com.amazonaws.connect#QueueSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueSummary" + } + }, + "com.amazonaws.connect#QueueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ { - "value": "ZM", - "name": "ZM" + "value": "STANDARD", + "name": "STANDARD" }, { - "value": "ZW", - "name": "ZW" + "value": "AGENT", + "name": "AGENT" + } + ] + } + }, + "com.amazonaws.connect#QueueTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.connect#Queues": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message.

" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, - "com.amazonaws.connect#PhoneNumberCountryCodes": { + "com.amazonaws.connect#ResumeContactRecording": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ResumeContactRecordingRequest" + }, + "output": { + "target": "com.amazonaws.connect#ResumeContactRecordingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.

\n \n

Only voice recordings are supported at this time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/resume-recording", + "code": 200 + } + } + }, + "com.amazonaws.connect#ResumeContactRecordingRequest": { + "type": "structure", + "members": { + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#ResumeContactRecordingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#RoutingProfile": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#RoutingProfileName", + "traits": { + "smithy.api#documentation": "

The name of the routing profile.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

One or more tags.

" + } + }, + "DefaultOutboundQueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the default outbound queue for this routing profile.

" + } + }, + "RoutingProfileArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "MediaConcurrencies": { + "target": "com.amazonaws.connect#MediaConcurrencies", + "traits": { + "smithy.api#documentation": "

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#RoutingProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the routing profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a routing profile.

" + } + }, + "com.amazonaws.connect#RoutingProfileDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, + "com.amazonaws.connect#RoutingProfileId": { + "type": "string" + }, + "com.amazonaws.connect#RoutingProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfig": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.connect#Priority", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and\n delay.

", + "smithy.api#required": {} + } + }, + "Delay": { + "target": "com.amazonaws.connect#Delay", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The delay, in seconds, a contact should be in the queue before they are routed to an\n available agent. For more information, see Queues: priority and\n delay in the Amazon Connect Administrator Guide.

", + "smithy.api#required": {} + } + }, + "QueueReference": { + "target": "com.amazonaws.connect#RoutingProfileQueueReference", + "traits": { + "smithy.api#documentation": "

Contains information about a queue resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the queue and channel for which priority and delay can be set.

" + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfigSummary": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

The channels this queue supports.

", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.connect#Priority", + "traits": { + "smithy.api#documentation": "

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and\n delay.

", + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the queue.

", + "smithy.api#required": {} + } + }, + "Delay": { + "target": "com.amazonaws.connect#Delay", + "traits": { + "smithy.api#documentation": "

The delay, in seconds, that a contact should be in the queue before they are routed to an\n available agent. For more information, see Queues: priority and\n delay in the Amazon Connect Administrator Guide.

", + "smithy.api#required": {} + } + }, + "QueueArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

", + "smithy.api#required": {} + } + }, + "QueueName": { + "target": "com.amazonaws.connect#QueueName", + "traits": { + "smithy.api#documentation": "

The name of the queue.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a routing profile queue.

" + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigSummary" + } + }, + "com.amazonaws.connect#RoutingProfileQueueReference": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

The channels agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

", + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the queue.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the channel and queue identifier for a routing profile.

" + } + }, + "com.amazonaws.connect#RoutingProfileQueueReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileQueueReference" + } + }, + "com.amazonaws.connect#RoutingProfileSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#RoutingProfileName", + "traits": { + "smithy.api#documentation": "

The name of the routing profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a routing profile.

" + } + }, + "com.amazonaws.connect#RoutingProfileSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileSummary" + } + }, + "com.amazonaws.connect#SecurityProfileId": { + "type": "string" + }, + "com.amazonaws.connect#SecurityProfileIds": { "type": "list", "member": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode" + "target": "com.amazonaws.connect#SecurityProfileId" }, "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 10 } } }, - "com.amazonaws.connect#PhoneNumberId": { + "com.amazonaws.connect#SecurityProfileName": { "type": "string" }, - "com.amazonaws.connect#PhoneNumberSummary": { + "com.amazonaws.connect#SecurityProfileSummary": { "type": "structure", "members": { - "PhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" - } - }, - "PhoneNumberType": { - "target": "com.amazonaws.connect#PhoneNumberType", + "Name": { + "target": "com.amazonaws.connect#SecurityProfileName", "traits": { - "smithy.api#documentation": "

The type of phone number.

" + "smithy.api#documentation": "

The name of the security profile.

" } }, "Id": { - "target": "com.amazonaws.connect#PhoneNumberId", + "target": "com.amazonaws.connect#SecurityProfileId", "traits": { - "smithy.api#documentation": "

The identifier of the phone number.

" + "smithy.api#documentation": "

The identifier of the security profile.

" } }, - "PhoneNumberCountryCode": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "Arn": { + "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The ISO country code.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the security profile.

" } } }, "traits": { - "smithy.api#documentation": "

Contains summary information about a phone number for a contact center.

" + "smithy.api#documentation": "

Contains information about a security profile.

" } }, - "com.amazonaws.connect#PhoneNumberSummaryList": { + "com.amazonaws.connect#SecurityProfileSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.connect#PhoneNumberSummary" + "target": "com.amazonaws.connect#SecurityProfileSummary" } }, - "com.amazonaws.connect#PhoneNumberType": { + "com.amazonaws.connect#SecurityToken": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "TOLL_FREE", - "name": "TOLL_FREE" - }, - { - "value": "DID", - "name": "DID" - } - ] + "smithy.api#sensitive": {} } }, - "com.amazonaws.connect#PhoneNumberTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#PhoneNumberType" + "com.amazonaws.connect#StartChatContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartChatContactRequest" }, + "output": { + "target": "com.amazonaws.connect#StartChatContactResponse" + }, + "errors": [ + { + "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" + } + ], "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 + "smithy.api#documentation": "

Initiates a contact flow to start a new chat for the customer. Response of this API provides\n a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n\n

When a new chat contact is successfully created, clients need to subscribe to the\n participant’s connection for the created chat within 5 minutes. This is achieved by invoking\n CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n\n

A 429 error occurs in two situations:

\n \n\n

For more information about how chat works, see Chat in the Amazon Connect Administrator\n Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/chat", + "code": 200 } } }, - "com.amazonaws.connect#PhoneType": { - "type": "string", + "com.amazonaws.connect#StartChatContactRequest": { + "type": "structure", + "members": { + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the\n Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On\n the contact flow page, under the name of the contact flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", + "smithy.api#required": {} + } + }, + "InitialMessage": { + "target": "com.amazonaws.connect#ChatMessage", + "traits": { + "smithy.api#documentation": "

The initial message to be sent to the newly created chat.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect\n attributes, and can be accessed in contact flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" + } + }, + "ParticipantDetails": { + "target": "com.amazonaws.connect#ParticipantDetails", + "traits": { + "smithy.api#documentation": "

Information identifying the participant.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#StartChatContactResponse": { + "type": "structure", + "members": { + "ParticipantToken": { + "target": "com.amazonaws.connect#ParticipantToken", + "traits": { + "smithy.api#documentation": "

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat\n participant.

" + } + }, + "ParticipantId": { + "target": "com.amazonaws.connect#ParticipantId", + "traits": { + "smithy.api#documentation": "

The identifier for a chat participant. The participantId for a chat participant is the same\n throughout the chat lifecycle.

" + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + } + } + } + }, + "com.amazonaws.connect#StartContactRecording": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartContactRecordingRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartContactRecordingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "SOFT_PHONE", - "name": "SOFT_PHONE" - }, - { - "value": "DESK_PHONE", - "name": "DESK_PHONE" + "smithy.api#documentation": "

This API starts recording the contact when the agent joins the call. StartContactRecording\n is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing\n call, you can't use StartContactRecording to restart it. For scenarios where the recording has\n started and you want to suspend and resume it, such as when collecting sensitive information (for\n example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/start-recording", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartContactRecordingRequest": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact.

", + "smithy.api#required": {} } - ] + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#required": {} + } + }, + "VoiceRecordingConfiguration": { + "target": "com.amazonaws.connect#VoiceRecordingConfiguration", + "traits": { + "smithy.api#documentation": "

Who is being recorded.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#required": {} + } + } } }, - "com.amazonaws.connect#QueueId": { - "type": "string" + "com.amazonaws.connect#StartContactRecordingResponse": { + "type": "structure", + "members": {} }, - "com.amazonaws.connect#QueueName": { - "type": "string", + "com.amazonaws.connect#StartOutboundVoiceContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartOutboundVoiceContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartOutboundVoiceContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DestinationNotAllowedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#OutboundContactNotPermittedException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 + "smithy.api#documentation": "

This API places an outbound call to a contact, and then initiates the contact flow. It\n performs the actions in the contact flow that's specified (in ContactFlowId).

\n \n

Agents are not involved in initiating the outbound API (that is, dialing the contact). If\n the contact flow places an outbound call to a contact, and then puts the contact in queue, that's\n when the call is routed to the agent, like any other inbound case.

\n \n

There is a 60 second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.

\n \n

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/outbound-voice", + "code": 200 } } }, - "com.amazonaws.connect#QueueReference": { + "com.amazonaws.connect#StartOutboundVoiceContactRequest": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.connect#ARN", + "QueueId": { + "target": "com.amazonaws.connect#QueueId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

" + "smithy.api#documentation": "

The queue for the call. If you specify a queue, the phone displayed for caller ID is the\n phone number specified in the queue. If you do not specify a queue, the queue defined in the\n contact flow is used. If you do not specify a queue, you must specify a source phone\n number.

" } }, - "Id": { - "target": "com.amazonaws.connect#QueueId", + "DestinationPhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", "traits": { - "smithy.api#documentation": "

The identifier of the queue.

" + "smithy.api#documentation": "

The phone number of the customer, in E.164 format.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a queue resource for which metrics are returned.

" - } - }, - "com.amazonaws.connect#QueueSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#QueueName", + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

The name of the queue.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. The token is valid for 7 days after creation. If a contact is already started, the\n contact ID is returned. If the contact is disconnected, a new contact is started.

", + "smithy.api#idempotencyToken": {} } }, - "QueueType": { - "target": "com.amazonaws.connect#QueueType", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The type of queue.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + "SourcePhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

" + "smithy.api#documentation": "

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify\n a source phone number, you must specify a queue.

" } }, - "Id": { - "target": "com.amazonaws.connect#QueueId", + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The identifier of the queue.

" + "smithy.api#documentation": "

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the\n Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On\n the contact flow page, under the name of the contact flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect\n attributes, and can be accessed in contact flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" } } - }, - "traits": { - "smithy.api#documentation": "

Contains summary information about a queue.

" } }, - "com.amazonaws.connect#QueueSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QueueSummary" + "com.amazonaws.connect#StartOutboundVoiceContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + } + } } }, - "com.amazonaws.connect#QueueType": { + "com.amazonaws.connect#Statistic": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "STANDARD", - "name": "STANDARD" + "value": "SUM", + "name": "SUM" }, { - "value": "AGENT", - "name": "AGENT" + "value": "MAX", + "name": "MAX" + }, + { + "value": "AVG", + "name": "AVG" } ] } }, - "com.amazonaws.connect#QueueTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QueueType" + "com.amazonaws.connect#StopContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StopContactRequest" }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.connect#Queues": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QueueId" + "output": { + "target": "com.amazonaws.connect#StopContactResponse" }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message.

" - } + "errors": [ + { + "target": "com.amazonaws.connect#ContactNotFoundException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" } - }, + ], "traits": { - "smithy.api#documentation": "

The specified resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "

Ends the specified contact.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/stop", + "code": 200 + } } }, - "com.amazonaws.connect#ResumeContactRecording": { + "com.amazonaws.connect#StopContactRecording": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ResumeContactRecordingRequest" + "target": "com.amazonaws.connect#StopContactRecordingRequest" }, "output": { - "target": "com.amazonaws.connect#ResumeContactRecordingResponse" + "target": "com.amazonaws.connect#StopContactRecordingResponse" }, "errors": [ { @@ -3969,17 +5563,24 @@ } ], "traits": { - "smithy.api#documentation": "

When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.

\n\n

Only voice recordings are supported at this time.

", + "smithy.api#documentation": "

When a contact is being recorded, this API stops recording the call. StopContactRecording is\n a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't\n use StartContactRecording to restart it. For scenarios where the recording has started and you\n want to suspend it for sensitive information (for example, to collect a credit card number), and\n then restart it, use SuspendContactRecording and ResumeContactRecording.

\n \n

Only voice recordings are supported at this time.

", "smithy.api#http": { "method": "POST", - "uri": "/contact/resume-recording", + "uri": "/contact/stop-recording", "code": 200 } } }, - "com.amazonaws.connect#ResumeContactRecordingRequest": { + "com.amazonaws.connect#StopContactRecordingRequest": { "type": "structure", "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#required": {} + } + }, "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { @@ -3993,127 +5594,135 @@ "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", "smithy.api#required": {} } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#required": {} - } } } }, - "com.amazonaws.connect#ResumeContactRecordingResponse": { + "com.amazonaws.connect#StopContactRecordingResponse": { "type": "structure", "members": {} }, - "com.amazonaws.connect#RoutingProfileId": { - "type": "string" - }, - "com.amazonaws.connect#RoutingProfileName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#RoutingProfileSummary": { + "com.amazonaws.connect#StopContactRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.connect#RoutingProfileName", - "traits": { - "smithy.api#documentation": "

The name of the routing profile.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#RoutingProfileId", + "ContactId": { + "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

" + "smithy.api#documentation": "

The ID of the contact.

", + "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Contains summary information about a routing profile.

" - } - }, - "com.amazonaws.connect#RoutingProfileSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileSummary" } }, - "com.amazonaws.connect#SecurityProfileId": { - "type": "string" + "com.amazonaws.connect#StopContactResponse": { + "type": "structure", + "members": {} }, - "com.amazonaws.connect#SecurityProfileIds": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SecurityProfileId" + "com.amazonaws.connect#SuspendContactRecording": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SuspendContactRecordingRequest" }, + "output": { + "target": "com.amazonaws.connect#SuspendContactRecordingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 + "smithy.api#documentation": "

When a contact is being recorded, this API suspends recording the call. For example, you\n might suspend the call recording while collecting sensitive information, such as a credit card\n number. Then use ResumeContactRecording to restart recording.

\n

The period of time that the recording is suspended is filled with silence in the final\n recording.

\n

Only voice recordings are supported at this time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/suspend-recording", + "code": 200 } } }, - "com.amazonaws.connect#SecurityProfileName": { - "type": "string" - }, - "com.amazonaws.connect#SecurityProfileSummary": { + "com.amazonaws.connect#SuspendContactRecordingRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.connect#SecurityProfileId", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the security profile.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.connect#SecurityProfileName", + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

The name of the security profile.

" + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + "ContactId": { + "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the security profile.

" + "smithy.api#documentation": "

The identifier of the contact.

", + "smithy.api#required": {} } } - }, + } + }, + "com.amazonaws.connect#SuspendContactRecordingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#TagKey": { + "type": "string", "traits": { - "smithy.api#documentation": "

Contains information about a security profile.

" + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, - "com.amazonaws.connect#SecurityProfileSummaryList": { + "com.amazonaws.connect#TagKeyList": { "type": "list", "member": { - "target": "com.amazonaws.connect#SecurityProfileSummary" + "target": "com.amazonaws.connect#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } } }, - "com.amazonaws.connect#SecurityToken": { - "type": "string", + "com.amazonaws.connect#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#TagKey" + }, + "value": { + "target": "com.amazonaws.connect#TagValue" + }, "traits": { - "smithy.api#sensitive": {} + "smithy.api#length": { + "min": 1, + "max": 200 + } } }, - "com.amazonaws.connect#StartChatContact": { + "com.amazonaws.connect#TagResource": { "type": "operation", "input": { - "target": "com.amazonaws.connect#StartChatContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#StartChatContactResponse" + "target": "com.amazonaws.connect#TagResourceRequest" }, "errors": [ { @@ -4126,96 +5735,113 @@ "target": "com.amazonaws.connect#InvalidRequestException" }, { - "target": "com.amazonaws.connect#LimitExceededException" + "target": "com.amazonaws.connect#ResourceNotFoundException" }, { - "target": "com.amazonaws.connect#ResourceNotFoundException" + "target": "com.amazonaws.connect#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Initiates a contact flow to start a new chat for the customer. Response of this API provides\n a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n\n

When a new chat contact is successfully created, clients need to subscribe to the\n participant’s connection for the created chat within 5 minutes. This is achieved by invoking\n CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

", + "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#http": { - "method": "PUT", - "uri": "/contact/chat", + "method": "POST", + "uri": "/tags/{resourceArn}", "code": 200 } } }, - "com.amazonaws.connect#StartChatContactRequest": { + "com.amazonaws.connect#TagResourceRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#required": {} - } - }, - "InitialMessage": { - "target": "com.amazonaws.connect#ChatMessage", - "traits": { - "smithy.api#documentation": "

The initial message to be sent to the newly created chat.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", + "tags": { + "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "

The identifier of the contact flow for the chat.

", + "smithy.api#documentation": "

One or more tags. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

", "smithy.api#required": {} } }, - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect\n attributes, and can be accessed in contact flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" - } - }, - "ParticipantDetails": { - "target": "com.amazonaws.connect#ParticipantDetails", + "resourceArn": { + "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

Information identifying the participant.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#StartChatContactResponse": { + "com.amazonaws.connect#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connect#Threshold": { "type": "structure", "members": { - "ParticipantToken": { - "target": "com.amazonaws.connect#ParticipantToken", - "traits": { - "smithy.api#documentation": "

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat\n participant.

" - } - }, - "ParticipantId": { - "target": "com.amazonaws.connect#ParticipantId", + "ThresholdValue": { + "target": "com.amazonaws.connect#ThresholdValue", "traits": { - "smithy.api#documentation": "

The identifier for a chat participant. The participantId for a chat participant is the same\n throughout the chat lifecycle.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

The threshold value to compare.

" } }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", + "Comparison": { + "target": "com.amazonaws.connect#Comparison", "traits": { - "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + "smithy.api#documentation": "

The type of comparison. Only \"less than\" (LT) comparisons are supported.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the threshold for service level metrics.

" } }, - "com.amazonaws.connect#StartContactRecording": { + "com.amazonaws.connect#ThresholdValue": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.connect#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The throttling limit has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.connect#Unit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SECONDS", + "name": "SECONDS" + }, + { + "value": "COUNT", + "name": "COUNT" + }, + { + "value": "PERCENT", + "name": "PERCENT" + } + ] + } + }, + "com.amazonaws.connect#UntagResource": { "type": "operation", "input": { - "target": "com.amazonaws.connect#StartContactRecordingRequest" - }, - "output": { - "target": "com.amazonaws.connect#StartContactRecordingResponse" + "target": "com.amazonaws.connect#UntagResourceRequest" }, "errors": [ { @@ -4229,66 +5855,50 @@ }, { "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

This API starts recording the contact when the agent joins the call. StartContactRecording\n is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing\n call, you can't use StartContactRecording to restart it. For scenarios where the recording has\n started and you want to suspend and resume it, such as when collecting sensitive information (for\n example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

", + "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", "smithy.api#http": { - "method": "POST", - "uri": "/contact/start-recording", + "method": "DELETE", + "uri": "/tags/{resourceArn}", "code": 200 } } }, - "com.amazonaws.connect#StartContactRecordingRequest": { + "com.amazonaws.connect#UntagResourceRequest": { "type": "structure", "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - }, - "VoiceRecordingConfiguration": { - "target": "com.amazonaws.connect#VoiceRecordingConfiguration", + "resourceArn": { + "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

Who is being recorded.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "tagKeys": { + "target": "com.amazonaws.connect#TagKeyList", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StartContactRecordingResponse": { - "type": "structure", - "members": {} + } + } + } }, - "com.amazonaws.connect#StartOutboundVoiceContact": { + "com.amazonaws.connect#UpdateContactAttributes": { "type": "operation", "input": { - "target": "com.amazonaws.connect#StartOutboundVoiceContactRequest" + "target": "com.amazonaws.connect#UpdateContactAttributesRequest" }, "output": { - "target": "com.amazonaws.connect#StartOutboundVoiceContactResponse" + "target": "com.amazonaws.connect#UpdateContactAttributesResponse" }, "errors": [ - { - "target": "com.amazonaws.connect#DestinationNotAllowedException" - }, { "target": "com.amazonaws.connect#InternalServiceException" }, @@ -4298,58 +5908,26 @@ { "target": "com.amazonaws.connect#InvalidRequestException" }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#OutboundContactNotPermittedException" - }, { "target": "com.amazonaws.connect#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "

This API places an outbound call to a contact, and then initiates the contact flow. It\n performs the actions in the contact flow that's specified (in ContactFlowId).

\n\n

Agents are not involved in initiating the outbound API (that is, dialing the contact). If\n the contact flow places an outbound call to a contact, and then puts the contact in queue, that's\n when the call is routed to the agent, like any other inbound case.

\n\n

There is a 60 second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.

", + "smithy.api#documentation": "

Creates or updates the contact attributes associated with the specified contact.

\n

You can add or update attributes for both ongoing and completed contacts. For example, you\n can update the customer's name or the reason the customer called while the call is active, or add\n notes about steps that the agent took during the call that are displayed to the next agent that\n takes the call. You can also update attributes for a contact using data from your CRM application\n and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis,\n such as legal review or identifying abusive callers.

\n

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

\n

This operation is also available in the Amazon Connect Flow language. See UpdateContactAttributes.

\n\n

\n Important: You cannot use the operation to update\n attributes for contacts that occurred prior to the release of the API, September 12, 2018. You\n can update attributes only for contacts that started after the release of the API. If you attempt\n to update attributes for a contact that occurred prior to the release of the API, a 400 error is\n returned. This applies also to queued callbacks that were initiated prior to the release of the\n API but are still active in your instance.

", "smithy.api#http": { - "method": "PUT", - "uri": "/contact/outbound-voice", + "method": "POST", + "uri": "/contact/attributes", "code": 200 } } }, - "com.amazonaws.connect#StartOutboundVoiceContactRequest": { + "com.amazonaws.connect#UpdateContactAttributesRequest": { "type": "structure", "members": { - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The queue for the call. If you specify a queue, the phone displayed for caller ID is the\n phone number specified in the queue. If you do not specify a queue, the queue defined in the\n contact flow is used. If you do not specify a queue, you must specify a source phone\n number.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. The token is valid for 7 days after creation. If a contact is already started, the\n contact ID is returned. If the contact is disconnected, a new contact is started.

", - "smithy.api#idempotencyToken": {} - } - }, - "DestinationPhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number of the customer, in E.164 format.

", - "smithy.api#required": {} - } - }, - "SourcePhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify\n a source phone number, you must specify a queue.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", + "Attributes": { + "target": "com.amazonaws.connect#Attributes", "traits": { - "smithy.api#documentation": "

The identifier of the contact flow for the outbound call.

", + "smithy.api#documentation": "

The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other\n contact attributes.

\n

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

", "smithy.api#required": {} } }, @@ -4360,58 +5938,30 @@ "smithy.api#required": {} } }, - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect\n attributes, and can be accessed in contact flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" - } - } - } - }, - "com.amazonaws.connect#StartOutboundVoiceContactResponse": { - "type": "structure", - "members": { - "ContactId": { + "InitialContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#required": {} } } } }, - "com.amazonaws.connect#Statistic": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUM", - "name": "SUM" - }, - { - "value": "MAX", - "name": "MAX" - }, - { - "value": "AVG", - "name": "AVG" - } - ] - } + "com.amazonaws.connect#UpdateContactAttributesResponse": { + "type": "structure", + "members": {} }, - "com.amazonaws.connect#StopContact": { + "com.amazonaws.connect#UpdateContactFlowContent": { "type": "operation", "input": { - "target": "com.amazonaws.connect#StopContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#StopContactResponse" + "target": "com.amazonaws.connect#UpdateContactFlowContentRequest" }, "errors": [ { - "target": "com.amazonaws.connect#ContactNotFoundException" + "target": "com.amazonaws.connect#InternalServiceException" }, { - "target": "com.amazonaws.connect#InternalServiceException" + "target": "com.amazonaws.connect#InvalidContactFlowException" }, { "target": "com.amazonaws.connect#InvalidParameterException" @@ -4421,197 +5971,178 @@ }, { "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Ends the specified contact.

", + "smithy.api#documentation": "

Updates the specified contact flow.

\n

You can also create and update contact flows using the Amazon Connect\n Flow language.

", "smithy.api#http": { "method": "POST", - "uri": "/contact/stop", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/content", "code": 200 } } }, - "com.amazonaws.connect#StopContactRecording": { + "com.amazonaws.connect#UpdateContactFlowContentRequest": { + "type": "structure", + "members": { + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowContent", + "traits": { + "smithy.api#documentation": "

The JSON string that represents contact flow’s content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowName": { "type": "operation", "input": { - "target": "com.amazonaws.connect#StopContactRecordingRequest" - }, - "output": { - "target": "com.amazonaws.connect#StopContactRecordingResponse" + "target": "com.amazonaws.connect#UpdateContactFlowNameRequest" }, "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#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

When a contact is being recorded, this API stops recording the call. StopContactRecording is\n a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't\n use StartContactRecording to restart it. For scenarios where the recording has started and you\n want to suspend it for sensitive information (for example, to collect a credit card number), and\n then restart it, use SuspendContactRecording and ResumeContactRecording.

\n\n

Only voice recordings are supported at this time.

", + "smithy.api#documentation": "

The name of the contact flow.

", "smithy.api#http": { "method": "POST", - "uri": "/contact/stop-recording", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/name", "code": 200 } } }, - "com.amazonaws.connect#StopContactRecordingRequest": { + "com.amazonaws.connect#UpdateContactFlowNameRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the contact flow.

" } }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StopContactRecordingResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#StopContactRequest": { - "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": {} } }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", "traits": { - "smithy.api#documentation": "

The ID of the contact.

", + "smithy.api#documentation": "

The description of the contact flow.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#StopContactResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#SuspendContactRecording": { + "com.amazonaws.connect#UpdateRoutingProfileConcurrency": { "type": "operation", "input": { - "target": "com.amazonaws.connect#SuspendContactRecordingRequest" - }, - "output": { - "target": "com.amazonaws.connect#SuspendContactRecordingResponse" + "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest" }, "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": "

When a contact is being recorded, this API suspends recording the call. For example, you\n might suspend the call recording while collecting sensitive information, such as a credit card\n number. Then use ResumeContactRecording to restart recording.

\n

The period of time that the recording is suspended is filled with silence in the final\n recording.

\n

Only voice recordings are supported at this time.

", + "smithy.api#documentation": "

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

", "smithy.api#http": { "method": "POST", - "uri": "/contact/suspend-recording", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency", "code": 200 } } }, - "com.amazonaws.connect#SuspendContactRecordingRequest": { + "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest": { "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": {} } }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", + "MediaConcurrencies": { + "target": "com.amazonaws.connect#MediaConcurrencies", "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", + "smithy.api#documentation": "

The channels agents can handle in the Contact Control Panel (CCP).

", "smithy.api#required": {} } } } }, - "com.amazonaws.connect#SuspendContactRecordingResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.connect#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.connect#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.connect#TagKey" - }, - "value": { - "target": "com.amazonaws.connect#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.connect#TagResource": { + "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueue": { "type": "operation", "input": { - "target": "com.amazonaws.connect#TagResourceRequest" + "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest" }, "errors": [ { @@ -4631,108 +6162,51 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

The supported resource type is users.

", + "smithy.api#documentation": "

Updates the default outbound queue of a routing profile.

", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue", "code": 200 } } }, - "com.amazonaws.connect#TagResourceRequest": { + "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.connect#TagMap", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

One or more tags. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.connect#ARN", + "DefaultOutboundQueueId": { + "target": "com.amazonaws.connect#QueueId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The identifier for the default outbound queue.

", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.connect#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.connect#Threshold": { - "type": "structure", - "members": { - "Comparison": { - "target": "com.amazonaws.connect#Comparison", - "traits": { - "smithy.api#documentation": "

The type of comparison. Only \"less than\" (LT) comparisons are supported.

" - } }, - "ThresholdValue": { - "target": "com.amazonaws.connect#ThresholdValue", + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The threshold value to compare.

" + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the threshold for service level metrics.

" - } - }, - "com.amazonaws.connect#ThresholdValue": { - "type": "double", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.connect#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The throttling limit has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 } }, - "com.amazonaws.connect#Unit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SECONDS", - "name": "SECONDS" - }, - { - "value": "COUNT", - "name": "COUNT" - }, - { - "value": "PERCENT", - "name": "PERCENT" - } - ] - } - }, - "com.amazonaws.connect#UntagResource": { + "com.amazonaws.connect#UpdateRoutingProfileName": { "type": "operation", "input": { - "target": "com.amazonaws.connect#UntagResourceRequest" + "target": "com.amazonaws.connect#UpdateRoutingProfileNameRequest" }, "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, { "target": "com.amazonaws.connect#InternalServiceException" }, @@ -4750,42 +6224,51 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", + "smithy.api#documentation": "

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/name", "code": 200 } } }, - "com.amazonaws.connect#UntagResourceRequest": { + "com.amazonaws.connect#UpdateRoutingProfileNameRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.connect#ARN", + "Description": { + "target": "com.amazonaws.connect#RoutingProfileDescription", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#documentation": "

The description of the routing profile. Must not be more than 250 characters.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.connect#TagKeyList", + "Name": { + "target": "com.amazonaws.connect#RoutingProfileName", "traits": { - "smithy.api#documentation": "

The tag keys.

", - "smithy.api#httpQuery": "tagKeys", + "smithy.api#documentation": "

The name of the routing profile. Must not be more than 127 characters.

" + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#UpdateContactAttributes": { + "com.amazonaws.connect#UpdateRoutingProfileQueues": { "type": "operation", "input": { - "target": "com.amazonaws.connect#UpdateContactAttributesRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateContactAttributesResponse" + "target": "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest" }, "errors": [ { @@ -4799,24 +6282,27 @@ }, { "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Creates or updates the contact attributes associated with the specified contact.

\n

You can add or update attributes for both ongoing and completed contacts. For example, you\n can update the customer's name or the reason the customer called while the call is active, or add\n notes about steps that the agent took during the call that are displayed to the next agent that\n takes the call. You can also update attributes for a contact using data from your CRM application\n and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis,\n such as legal review or identifying abusive callers.

\n

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

\n\n

\n Important: You cannot use the operation to update\n attributes for contacts that occurred prior to the release of the API, September 12, 2018. You\n can update attributes only for contacts that started after the release of the API. If you attempt\n to update attributes for a contact that occurred prior to the release of the API, a 400 error is\n returned. This applies also to queued callbacks that were initiated prior to the release of the\n API but are still active in your instance.

", + "smithy.api#documentation": "

Updates the properties associated with a set of queues for a routing profile.

", "smithy.api#http": { "method": "POST", - "uri": "/contact/attributes", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", "code": 200 } } }, - "com.amazonaws.connect#UpdateContactAttributesRequest": { + "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.connect#Attributes", + "QueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", "traits": { - "smithy.api#documentation": "

The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other\n contact attributes.

\n

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

", + "smithy.api#documentation": "

The queues to be updated for this routing profile.

", "smithy.api#required": {} } }, @@ -4824,22 +6310,20 @@ "target": "com.amazonaws.connect#InstanceId", "traits": { "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#UpdateContactAttributesResponse": { - "type": "structure", - "members": {} - }, "com.amazonaws.connect#UpdateUserHierarchy": { "type": "operation", "input": { @@ -4874,6 +6358,14 @@ "com.amazonaws.connect#UpdateUserHierarchyRequest": { "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": {} + } + }, "HierarchyGroupId": { "target": "com.amazonaws.connect#HierarchyGroupId", "traits": { @@ -4887,14 +6379,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -4921,7 +6405,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the identity information for the specified user.

", + "smithy.api#documentation": "

Updates the identity information for the specified user.

\n \n

Someone with the ability to invoke UpdateUserIndentityInfo can change the\n login credentials of other users by changing their email address. This poses a security risk to\n your organization. They can change the email address of a user to the attacker's email address,\n and then reset the password through email. We strongly recommend limiting who has the ability to\n invoke UpdateUserIndentityInfo. For more information, see Best\n Practices for Security Profiles in the Amazon Connect Administrator\n Guide.

\n ", "smithy.api#http": { "method": "POST", "uri": "/users/{InstanceId}/{UserId}/identity-info", @@ -5050,6 +6534,13 @@ "com.amazonaws.connect#UpdateUserRoutingProfileRequest": { "type": "structure", "members": { + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile for the user.

", + "smithy.api#required": {} + } + }, "UserId": { "target": "com.amazonaws.connect#UserId", "traits": { @@ -5065,13 +6556,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile for the user.

", - "smithy.api#required": {} - } } } }, @@ -5109,6 +6593,14 @@ "com.amazonaws.connect#UpdateUserSecurityProfilesRequest": { "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": {} + } + }, "SecurityProfileIds": { "target": "com.amazonaws.connect#SecurityProfileIds", "traits": { @@ -5123,14 +6615,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -5143,16 +6627,22 @@ "smithy.api#documentation": "

The identifier of the user account in the directory used for identity management.

" } }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile for the user.

" + } + }, "IdentityInfo": { "target": "com.amazonaws.connect#UserIdentityInfo", "traits": { "smithy.api#documentation": "

Information about the user identity.

" } }, - "SecurityProfileIds": { - "target": "com.amazonaws.connect#SecurityProfileIds", + "Tags": { + "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "

The identifiers of the security profiles for the user.

" + "smithy.api#documentation": "

The tags.

" } }, "HierarchyGroupId": { @@ -5167,28 +6657,22 @@ "smithy.api#documentation": "

Information about the phone configuration for the user.

" } }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags.

" - } - }, - "Username": { - "target": "com.amazonaws.connect#AgentUsername", + "Arn": { + "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The user name assigned to the user account.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" } }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", + "SecurityProfileIds": { + "target": "com.amazonaws.connect#SecurityProfileIds", "traits": { - "smithy.api#documentation": "

The identifier of the routing profile for the user.

" + "smithy.api#documentation": "

The identifiers of the security profiles for the user.

" } }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + "Username": { + "target": "com.amazonaws.connect#AgentUsername", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" + "smithy.api#documentation": "

The user name assigned to the user account.

" } }, "Id": { @@ -5208,10 +6692,10 @@ "com.amazonaws.connect#UserIdentityInfo": { "type": "structure", "members": { - "FirstName": { - "target": "com.amazonaws.connect#AgentFirstName", + "Email": { + "target": "com.amazonaws.connect#Email", "traits": { - "smithy.api#documentation": "

The first name. This is required if you are using Amazon Connect or SAML for identity\n management.

" + "smithy.api#documentation": "

The email address. If you are using SAML for identity management and include this parameter,\n an error is returned.

" } }, "LastName": { @@ -5220,10 +6704,10 @@ "smithy.api#documentation": "

The last name. This is required if you are using Amazon Connect or SAML for identity\n management.

" } }, - "Email": { - "target": "com.amazonaws.connect#Email", + "FirstName": { + "target": "com.amazonaws.connect#AgentFirstName", "traits": { - "smithy.api#documentation": "

The email address. If you are using SAML for identity management and include this parameter,\n an error is returned.

" + "smithy.api#documentation": "

The first name. This is required if you are using Amazon Connect or SAML for identity\n management.

" } } }, @@ -5247,12 +6731,6 @@ "com.amazonaws.connect#UserPhoneConfig": { "type": "structure", "members": { - "AutoAccept": { - "target": "com.amazonaws.connect#AutoAccept", - "traits": { - "smithy.api#documentation": "

The Auto accept setting.

" - } - }, "PhoneType": { "target": "com.amazonaws.connect#PhoneType", "traits": { @@ -5260,6 +6738,12 @@ "smithy.api#required": {} } }, + "AutoAccept": { + "target": "com.amazonaws.connect#AutoAccept", + "traits": { + "smithy.api#documentation": "

The Auto accept setting.

" + } + }, "AfterContactWorkTimeLimit": { "target": "com.amazonaws.connect#AfterContactWorkTimeLimit", "traits": { @@ -5280,12 +6764,6 @@ "com.amazonaws.connect#UserSummary": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.connect#AgentUsername", - "traits": { - "smithy.api#documentation": "

The Amazon Connect user name of the user account.

" - } - }, "Arn": { "target": "com.amazonaws.connect#ARN", "traits": { @@ -5297,6 +6775,12 @@ "traits": { "smithy.api#documentation": "

The identifier of the user account.

" } + }, + "Username": { + "target": "com.amazonaws.connect#AgentUsername", + "traits": { + "smithy.api#documentation": "

The Amazon Connect user name of the user account.

" + } } }, "traits": { 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 706c9bda5928..5b735ead59d8 100644 --- a/codegen/sdk-codegen/aws-models/connectparticipant.2018-09-07.json +++ b/codegen/sdk-codegen/aws-models/connectparticipant.2018-09-07.json @@ -68,9 +68,9 @@ "traits": { "aws.api#service": { "sdkId": "ConnectParticipant", - "arnNamespace": "execute-api", + "arnNamespace": "connect", "cloudFormationName": "ConnectParticipant", - "cloudTrailEventSource": "v20180907.amazonconnectparticipantservice.amazon.com" + "cloudTrailEventSource": "connectparticipant.amazonaws.com" }, "aws.auth#sigv4": { "name": "execute-api" @@ -224,18 +224,18 @@ "com.amazonaws.connectparticipant#CreateParticipantConnectionRequest": { "type": "structure", "members": { - "ParticipantToken": { - "target": "com.amazonaws.connectparticipant#ParticipantToken", + "Type": { + "target": "com.amazonaws.connectparticipant#ConnectionTypeList", "traits": { - "smithy.api#documentation": "

Participant Token as obtained from StartChatContact API response.

", - "smithy.api#httpHeader": "X-Amz-Bearer", + "smithy.api#documentation": "

Type of connection information required.

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.connectparticipant#ConnectionTypeList", + "ParticipantToken": { + "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { - "smithy.api#documentation": "

Type of connection information required.

", + "smithy.api#documentation": "

Participant Token as obtained from StartChatContact API response.

", + "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } } @@ -244,17 +244,17 @@ "com.amazonaws.connectparticipant#CreateParticipantConnectionResponse": { "type": "structure", "members": { - "ConnectionCredentials": { - "target": "com.amazonaws.connectparticipant#ConnectionCredentials", - "traits": { - "smithy.api#documentation": "

Creates the participant's connection credentials. The authentication token associated\n with the participant's connection.

" - } - }, "Websocket": { "target": "com.amazonaws.connectparticipant#Websocket", "traits": { "smithy.api#documentation": "

Creates the participant's websocket connection.

" } + }, + "ConnectionCredentials": { + "target": "com.amazonaws.connectparticipant#ConnectionCredentials", + "traits": { + "smithy.api#documentation": "

Creates the participant's connection credentials. The authentication token associated\n with the participant's connection.

" + } } } }, @@ -292,13 +292,6 @@ "com.amazonaws.connectparticipant#DisconnectParticipantRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.connectparticipant#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, "ConnectionToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { @@ -306,6 +299,13 @@ "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } + }, + "ClientToken": { + "target": "com.amazonaws.connectparticipant#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } } } }, @@ -361,16 +361,17 @@ "com.amazonaws.connectparticipant#GetTranscriptRequest": { "type": "structure", "members": { - "SortOrder": { - "target": "com.amazonaws.connectparticipant#SortKey", + "ScanDirection": { + "target": "com.amazonaws.connectparticipant#ScanDirection", "traits": { - "smithy.api#documentation": "

The sort order for the records. Default: DESCENDING.

" + "smithy.api#documentation": "

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

" } }, - "ContactId": { - "target": "com.amazonaws.connectparticipant#ContactId", + "MaxResults": { + "target": "com.amazonaws.connectparticipant#MaxResults", "traits": { - "smithy.api#documentation": "

The contactId from the current contact chain for which transcript is needed.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return in the page. Default: 10. \n

" } }, "StartPosition": { @@ -393,17 +394,16 @@ "smithy.api#documentation": "

The pagination token. Use the value returned previously in the next subsequent request\n to retrieve the next set of results.

" } }, - "MaxResults": { - "target": "com.amazonaws.connectparticipant#MaxResults", + "SortOrder": { + "target": "com.amazonaws.connectparticipant#SortKey", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of results to return in the page. Default: 10. \n

" + "smithy.api#documentation": "

The sort order for the records. Default: DESCENDING.

" } }, - "ScanDirection": { - "target": "com.amazonaws.connectparticipant#ScanDirection", + "ContactId": { + "target": "com.amazonaws.connectparticipant#ContactId", "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 contactId from the current contact chain for which transcript is needed.

" } } } @@ -411,6 +411,12 @@ "com.amazonaws.connectparticipant#GetTranscriptResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.connectparticipant#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token. Use the value returned previously in the next subsequent request\n to retrieve the next set of results.

" + } + }, "InitialContactId": { "target": "com.amazonaws.connectparticipant#ContactId", "traits": { @@ -422,12 +428,6 @@ "traits": { "smithy.api#documentation": "

The list of messages in the session.

" } - }, - "NextToken": { - "target": "com.amazonaws.connectparticipant#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token. Use the value returned previously in the next subsequent request\n to retrieve the next set of results.

" - } } } }, @@ -462,6 +462,18 @@ "com.amazonaws.connectparticipant#Item": { "type": "structure", "members": { + "Type": { + "target": "com.amazonaws.connectparticipant#ChatItemType", + "traits": { + "smithy.api#documentation": "

Type of the item: message or event.

" + } + }, + "ParticipantRole": { + "target": "com.amazonaws.connectparticipant#ParticipantRole", + "traits": { + "smithy.api#documentation": "

The role of the sender. For example, is it a customer, agent, or system.

" + } + }, "ParticipantId": { "target": "com.amazonaws.connectparticipant#ParticipantId", "traits": { @@ -474,10 +486,10 @@ "smithy.api#documentation": "

The type of content of the item.

" } }, - "Type": { - "target": "com.amazonaws.connectparticipant#ChatItemType", + "Id": { + "target": "com.amazonaws.connectparticipant#ChatItemId", "traits": { - "smithy.api#documentation": "

Type of the item: message or event.

" + "smithy.api#documentation": "

The ID of the item.

" } }, "Content": { @@ -486,28 +498,16 @@ "smithy.api#documentation": "

The content of the message or event.

" } }, - "AbsoluteTime": { - "target": "com.amazonaws.connectparticipant#Instant", - "traits": { - "smithy.api#documentation": "

The time when the message or event was sent.

\n

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.

" - } - }, "DisplayName": { "target": "com.amazonaws.connectparticipant#DisplayName", "traits": { "smithy.api#documentation": "

The chat display name of the sender.

" } }, - "Id": { - "target": "com.amazonaws.connectparticipant#ChatItemId", - "traits": { - "smithy.api#documentation": "

The ID of the item.

" - } - }, - "ParticipantRole": { - "target": "com.amazonaws.connectparticipant#ParticipantRole", + "AbsoluteTime": { + "target": "com.amazonaws.connectparticipant#Instant", "traits": { - "smithy.api#documentation": "

The role of the sender. For example, is it a customer, agent, or system.

" + "smithy.api#documentation": "

The time when the message or event was sent.

\n

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.

" } } }, @@ -649,11 +649,16 @@ "com.amazonaws.connectparticipant#SendEventRequest": { "type": "structure", "members": { - "ConnectionToken": { - "target": "com.amazonaws.connectparticipant#ParticipantToken", + "Content": { + "target": "com.amazonaws.connectparticipant#ChatContent", "traits": { - "smithy.api#documentation": "

The authentication token associated with the participant's connection.

", - "smithy.api#httpHeader": "X-Amz-Bearer", + "smithy.api#documentation": "

The content of the event to be sent (for example, message text). This is not yet\n supported.

" + } + }, + "ContentType": { + "target": "com.amazonaws.connectparticipant#ChatContentType", + "traits": { + "smithy.api#documentation": "

The content type of the request. Supported types are:

\n\n ", "smithy.api#required": {} } }, @@ -664,35 +669,30 @@ "smithy.api#idempotencyToken": {} } }, - "ContentType": { - "target": "com.amazonaws.connectparticipant#ChatContentType", + "ConnectionToken": { + "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { - "smithy.api#documentation": "

The content type of the request. Supported types are:

\n\n ", + "smithy.api#documentation": "

The authentication token associated with the participant's connection.

", + "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } - }, - "Content": { - "target": "com.amazonaws.connectparticipant#ChatContent", - "traits": { - "smithy.api#documentation": "

The content of the event to be sent (for example, message text). This is not yet\n supported.

" - } } } }, "com.amazonaws.connectparticipant#SendEventResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.connectparticipant#ChatItemId", - "traits": { - "smithy.api#documentation": "

The ID of the response.

" - } - }, "AbsoluteTime": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "

The time when the event was sent.

\n

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.

" } + }, + "Id": { + "target": "com.amazonaws.connectparticipant#ChatItemId", + "traits": { + "smithy.api#documentation": "

The ID of the response.

" + } } } }, @@ -730,11 +730,11 @@ "com.amazonaws.connectparticipant#SendMessageRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.connectparticipant#ClientToken", + "Content": { + "target": "com.amazonaws.connectparticipant#ChatContent", "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#documentation": "

The content of the message.

", + "smithy.api#required": {} } }, "ContentType": { @@ -752,11 +752,11 @@ "smithy.api#required": {} } }, - "Content": { - "target": "com.amazonaws.connectparticipant#ChatContent", + "ClientToken": { + "target": "com.amazonaws.connectparticipant#ClientToken", "traits": { - "smithy.api#documentation": "

The content of the message.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} } } } @@ -764,17 +764,17 @@ "com.amazonaws.connectparticipant#SendMessageResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.connectparticipant#ChatItemId", - "traits": { - "smithy.api#documentation": "

The ID of the message.

" - } - }, "AbsoluteTime": { "target": "com.amazonaws.connectparticipant#Instant", "traits": { "smithy.api#documentation": "

The time when the message was sent.

\n

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.

" } + }, + "Id": { + "target": "com.amazonaws.connectparticipant#ChatItemId", + "traits": { + "smithy.api#documentation": "

The ID of the message.

" + } } } }, @@ -796,12 +796,6 @@ "com.amazonaws.connectparticipant#StartPosition": { "type": "structure", "members": { - "AbsoluteTime": { - "target": "com.amazonaws.connectparticipant#Instant", - "traits": { - "smithy.api#documentation": "

The time in ISO format where to start.

\n

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.

" - } - }, "MostRecent": { "target": "com.amazonaws.connectparticipant#MostRecent", "traits": { @@ -813,6 +807,12 @@ "traits": { "smithy.api#documentation": "

The ID of the message or event where to start.

" } + }, + "AbsoluteTime": { + "target": "com.amazonaws.connectparticipant#Instant", + "traits": { + "smithy.api#documentation": "

The time in ISO format where to start.

\n

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cost-and-usage-report-service.2017-01-06.json b/codegen/sdk-codegen/aws-models/cost-and-usage-report-service.2017-01-06.json index 4037f44b4106..dc65b034be47 100644 --- a/codegen/sdk-codegen/aws-models/cost-and-usage-report-service.2017-01-06.json +++ b/codegen/sdk-codegen/aws-models/cost-and-usage-report-service.2017-01-06.json @@ -51,13 +51,13 @@ "sdkId": "Cost and Usage Report Service", "arnNamespace": "cur", "cloudFormationName": "CostandUsageReportService", - "cloudTrailEventSource": "awsorigamiservicegateway.amazonaws.com" + "cloudTrailEventSource": "costandusagereportservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "cur" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete \n AWS Cost and Usage report definitions.

\n

AWS Cost and Usage reports track the monthly AWS costs and usage \n associated with your AWS account.\n \n The report contains line items for each unique combination of AWS product,\n usage type, and operation that your AWS account uses. \n \n You can configure the AWS Cost and Usage report to show only the data that you want, using the\n AWS Cost and Usage API.

\n\n \n

Service Endpoint

\n

The AWS Cost and Usage Report API provides the following endpoint:

\n ", + "smithy.api#documentation": "

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete \n AWS Cost and Usage report definitions.

\n

AWS Cost and Usage reports track the monthly AWS costs and usage \n associated with your AWS account.\n \n The report contains line items for each unique combination of AWS product,\n usage type, and operation that your AWS account uses. \n \n You can configure the AWS Cost and Usage report to show only the data that you want, using the\n AWS Cost and Usage API.

\n\n \n

Service Endpoint

\n

The AWS Cost and Usage Report API provides the following endpoint:

\n ", "smithy.api#title": "AWS Cost and Usage Report Service" } }, @@ -67,24 +67,16 @@ "smithy.api#documentation": "

The region of the S3 bucket that AWS delivers the report into.

", "smithy.api#enum": [ { - "value": "us-east-1", - "name": "US_STANDARD" - }, - { - "value": "us-west-1", - "name": "NORTHERN_CALIFORNIA" - }, - { - "value": "us-west-2", - "name": "OREGON" + "value": "af-south-1", + "name": "CAPE_TOWN" }, { - "value": "eu-central-1", - "name": "FRANKFURT" + "value": "ap-east-1", + "name": "HONG_KONG" }, { - "value": "eu-west-1", - "name": "IRELAND" + "value": "ap-south-1", + "name": "MUMBAI" }, { "value": "ap-southeast-1", @@ -99,16 +91,72 @@ "name": "TOKYO" }, { - "value": "eu-north-1", - "name": "STOCKHOLM" + "value": "ap-northeast-2", + "name": "SEOUL" }, { "value": "ap-northeast-3", "name": "OSAKA" }, { - "value": "ap-east-1", - "name": "HONG_KONG" + "value": "ca-central-1", + "name": "CANADA_CENTRAL" + }, + { + "value": "eu-central-1", + "name": "FRANKFURT" + }, + { + "value": "eu-west-1", + "name": "IRELAND" + }, + { + "value": "eu-west-2", + "name": "LONDON" + }, + { + "value": "eu-west-3", + "name": "PARIS" + }, + { + "value": "eu-north-1", + "name": "STOCKHOLM" + }, + { + "value": "eu-south-1", + "name": "MILANO" + }, + { + "value": "me-south-1", + "name": "BAHRAIN" + }, + { + "value": "sa-east-1", + "name": "SAO_PAULO" + }, + { + "value": "us-east-1", + "name": "US_STANDARD" + }, + { + "value": "us-east-2", + "name": "OHIO" + }, + { + "value": "us-west-1", + "name": "NORTHERN_CALIFORNIA" + }, + { + "value": "us-west-2", + "name": "OREGON" + }, + { + "value": "cn-north-1", + "name": "BEIJING" + }, + { + "value": "cn-northwest-1", + "name": "NINGXIA" } ] } @@ -186,7 +234,10 @@ "type": "structure", "members": { "ReportName": { - "target": "com.amazonaws.costandusagereportservice#ReportName" + "target": "com.amazonaws.costandusagereportservice#ReportName", + "traits": { + "smithy.api#documentation": "

The name of the report that you want to delete. The name must be unique, is case sensitive, and can't include spaces.

" + } } }, "traits": { @@ -249,14 +300,14 @@ "com.amazonaws.costandusagereportservice#DescribeReportDefinitionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.costandusagereportservice#GenericString" - }, "ReportDefinitions": { "target": "com.amazonaws.costandusagereportservice#ReportDefinitionList", "traits": { "smithy.api#documentation": "

A list of AWS Cost and Usage reports owned by the account.

" } + }, + "NextToken": { + "target": "com.amazonaws.costandusagereportservice#GenericString" } }, "traits": { @@ -284,7 +335,12 @@ "com.amazonaws.costandusagereportservice#GenericString": { "type": "string", "traits": { - "smithy.api#documentation": "

A generic string.

" + "smithy.api#documentation": "

A generic string.

", + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[A-Za-z0-9_\\.\\-=]*" } }, "com.amazonaws.costandusagereportservice#InternalErrorException": { @@ -414,8 +470,8 @@ "smithy.api#documentation": "

Whether you want Amazon Web Services to overwrite the previous version of each report or \n to deliver the report in addition to the previous versions.

" } }, - "TimeUnit": { - "target": "com.amazonaws.costandusagereportservice#TimeUnit", + "Format": { + "target": "com.amazonaws.costandusagereportservice#ReportFormat", "traits": { "smithy.api#required": {} } @@ -426,20 +482,26 @@ "smithy.api#required": {} } }, - "Compression": { - "target": "com.amazonaws.costandusagereportservice#CompressionFormat", + "TimeUnit": { + "target": "com.amazonaws.costandusagereportservice#TimeUnit", "traits": { "smithy.api#required": {} } }, - "Format": { - "target": "com.amazonaws.costandusagereportservice#ReportFormat", + "S3Prefix": { + "target": "com.amazonaws.costandusagereportservice#S3Prefix", "traits": { "smithy.api#required": {} } }, - "S3Prefix": { - "target": "com.amazonaws.costandusagereportservice#S3Prefix", + "Compression": { + "target": "com.amazonaws.costandusagereportservice#CompressionFormat", + "traits": { + "smithy.api#required": {} + } + }, + "S3Bucket": { + "target": "com.amazonaws.costandusagereportservice#S3Bucket", "traits": { "smithy.api#required": {} } @@ -457,10 +519,10 @@ "smithy.api#documentation": "

Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to \n previous months. These charges can include refunds, credits, or support fees.

" } }, - "S3Bucket": { - "target": "com.amazonaws.costandusagereportservice#S3Bucket", + "AdditionalArtifacts": { + "target": "com.amazonaws.costandusagereportservice#AdditionalArtifactList", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

A list of manifests that you want Amazon Web Services to create for this report.

" } }, "S3Region": { @@ -468,12 +530,6 @@ "traits": { "smithy.api#required": {} } - }, - "AdditionalArtifacts": { - "target": "com.amazonaws.costandusagereportservice#AdditionalArtifactList", - "traits": { - "smithy.api#documentation": "

A list of manifests that you want Amazon Web Services to create for this report.

" - } } }, "traits": { @@ -550,7 +606,8 @@ "smithy.api#length": { "min": 0, "max": 256 - } + }, + "smithy.api#pattern": "[A-Za-z0-9_\\.\\-]+" } }, "com.amazonaws.costandusagereportservice#S3Prefix": { @@ -597,6 +654,10 @@ { "value": "DAILY", "name": "DAILY" + }, + { + "value": "MONTHLY", + "name": "MONTHLY" } ] } diff --git a/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json b/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json index ef0662a30ea8..ddb66a7cdfb0 100644 --- a/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json +++ b/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json @@ -33,15 +33,36 @@ "type": "service", "version": "2017-10-25", "operations": [ + { + "target": "com.amazonaws.costexplorer#CreateAnomalyMonitor" + }, + { + "target": "com.amazonaws.costexplorer#CreateAnomalySubscription" + }, { "target": "com.amazonaws.costexplorer#CreateCostCategoryDefinition" }, + { + "target": "com.amazonaws.costexplorer#DeleteAnomalyMonitor" + }, + { + "target": "com.amazonaws.costexplorer#DeleteAnomalySubscription" + }, { "target": "com.amazonaws.costexplorer#DeleteCostCategoryDefinition" }, { "target": "com.amazonaws.costexplorer#DescribeCostCategoryDefinition" }, + { + "target": "com.amazonaws.costexplorer#GetAnomalies" + }, + { + "target": "com.amazonaws.costexplorer#GetAnomalyMonitors" + }, + { + "target": "com.amazonaws.costexplorer#GetAnomalySubscriptions" + }, { "target": "com.amazonaws.costexplorer#GetCostAndUsage" }, @@ -87,6 +108,15 @@ { "target": "com.amazonaws.costexplorer#ListCostCategoryDefinitions" }, + { + "target": "com.amazonaws.costexplorer#ProvideAnomalyFeedback" + }, + { + "target": "com.amazonaws.costexplorer#UpdateAnomalyMonitor" + }, + { + "target": "com.amazonaws.costexplorer#UpdateAnomalySubscription" + }, { "target": "com.amazonaws.costexplorer#UpdateCostCategoryDefinition" } @@ -96,7 +126,7 @@ "sdkId": "Cost Explorer", "arnNamespace": "ce", "cloudFormationName": "CostExplorer", - "cloudTrailEventSource": "v0.awsinsightsindexservice.amazonaws.com" + "cloudTrailEventSource": "costexplorer.amazonaws.com" }, "aws.auth#sigv4": { "name": "ce" @@ -127,6 +157,287 @@ "com.amazonaws.costexplorer#AmortizedUpfrontFee": { "type": "string" }, + "com.amazonaws.costexplorer#Anomalies": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#Anomaly" + } + }, + "com.amazonaws.costexplorer#Anomaly": { + "type": "structure", + "members": { + "DimensionValue": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The dimension for the anomaly. For example, an AWS service in a service monitor.\n

" + } + }, + "AnomalyEndDate": { + "target": "com.amazonaws.costexplorer#YearMonthDay", + "traits": { + "smithy.api#documentation": "

\n The last day the anomaly is detected.\n

" + } + }, + "MonitorArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.

", + "smithy.api#required": {} + } + }, + "RootCauses": { + "target": "com.amazonaws.costexplorer#RootCauses", + "traits": { + "smithy.api#documentation": "

\n The list of identified root causes for the anomaly.\n

" + } + }, + "AnomalyStartDate": { + "target": "com.amazonaws.costexplorer#YearMonthDay", + "traits": { + "smithy.api#documentation": "

\n The first day the anomaly is detected.\n

" + } + }, + "Feedback": { + "target": "com.amazonaws.costexplorer#AnomalyFeedbackType", + "traits": { + "smithy.api#documentation": "

\n The feedback value.\n

" + } + }, + "AnomalyScore": { + "target": "com.amazonaws.costexplorer#AnomalyScore", + "traits": { + "smithy.api#documentation": "

\n The latest and maximum score for the anomaly.\n

", + "smithy.api#required": {} + } + }, + "Impact": { + "target": "com.amazonaws.costexplorer#Impact", + "traits": { + "smithy.api#documentation": "

\n The dollar impact for the anomaly.\n

", + "smithy.api#required": {} + } + }, + "AnomalyId": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for the anomaly.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An unusual cost pattern. This consists of the detailed metadata and the current status of the anomaly object.\n

" + } + }, + "com.amazonaws.costexplorer#AnomalyDateInterval": { + "type": "structure", + "members": { + "StartDate": { + "target": "com.amazonaws.costexplorer#YearMonthDay", + "traits": { + "smithy.api#documentation": "

\n The first date an anomaly was observed.\n

", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.costexplorer#YearMonthDay", + "traits": { + "smithy.api#documentation": "

\n The last date an anomaly was observed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The time period for an anomaly.\n

" + } + }, + "com.amazonaws.costexplorer#AnomalyFeedbackType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "YES", + "name": "YES" + }, + { + "value": "NO", + "name": "NO" + }, + { + "value": "PLANNED_ACTIVITY", + "name": "PLANNED_ACTIVITY" + } + ] + } + }, + "com.amazonaws.costexplorer#AnomalyMonitor": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The name of the monitor.\n

", + "smithy.api#required": {} + } + }, + "MonitorSpecification": { + "target": "com.amazonaws.costexplorer#Expression" + }, + "MonitorType": { + "target": "com.amazonaws.costexplorer#MonitorType", + "traits": { + "smithy.api#documentation": "

\n The possible type values.\n

", + "smithy.api#required": {} + } + }, + "MonitorDimension": { + "target": "com.amazonaws.costexplorer#MonitorDimension", + "traits": { + "smithy.api#documentation": "

\n The dimensions to evaluate.\n

" + } + }, + "LastEvaluatedDate": { + "target": "com.amazonaws.costexplorer#YearMonthDay", + "traits": { + "smithy.api#documentation": "

\n The date when the monitor last evaluated for anomalies.\n

" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.costexplorer#YearMonthDay", + "traits": { + "smithy.api#documentation": "

\n The date when the monitor was last updated.\n

" + } + }, + "DimensionalValueCount": { + "target": "com.amazonaws.costexplorer#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

\n The value for evaluated dimensions.\n

" + } + }, + "MonitorArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) value.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.costexplorer#YearMonthDay", + "traits": { + "smithy.api#documentation": "

\n The date when the monitor was created.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This object continuously inspects your account's cost data for anomalies, based on\n MonitorType and MonitorSpecification. The content consists\n of detailed metadata and the current status of the monitor object.

" + } + }, + "com.amazonaws.costexplorer#AnomalyMonitors": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#AnomalyMonitor" + } + }, + "com.amazonaws.costexplorer#AnomalyScore": { + "type": "structure", + "members": { + "CurrentScore": { + "target": "com.amazonaws.costexplorer#GenericDouble", + "traits": { + "smithy.api#documentation": "

\n The last observed score.\n

", + "smithy.api#required": {} + } + }, + "MaxScore": { + "target": "com.amazonaws.costexplorer#GenericDouble", + "traits": { + "smithy.api#documentation": "

\n The maximum score observed during the AnomalyDateInterval.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Quantifies the anomaly. The higher score means that it is more anomalous.

" + } + }, + "com.amazonaws.costexplorer#AnomalySubscription": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The name for the subscription.\n

", + "smithy.api#required": {} + } + }, + "Threshold": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

\n The dollar value that triggers a notification if the threshold is exceeded.\n

", + "smithy.api#required": {} + } + }, + "SubscriptionArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The AnomalySubscription Amazon Resource Name (ARN).

" + } + }, + "Subscribers": { + "target": "com.amazonaws.costexplorer#Subscribers", + "traits": { + "smithy.api#documentation": "

\n A list of subscribers to notify.\n

", + "smithy.api#required": {} + } + }, + "Frequency": { + "target": "com.amazonaws.costexplorer#AnomalySubscriptionFrequency", + "traits": { + "smithy.api#documentation": "

\n The frequency at which anomaly reports are sent over email.\n

", + "smithy.api#required": {} + } + }, + "MonitorArnList": { + "target": "com.amazonaws.costexplorer#Values", + "traits": { + "smithy.api#documentation": "

\n A list of cost anomaly monitors.\n

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n Your unique account identifier.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The association between a monitor, threshold, and list of subscribers used to deliver notifications about anomalies detected by a monitor that exceeds a threshold. The content consists of the detailed metadata and the current status of the AnomalySubscription object.\n

" + } + }, + "com.amazonaws.costexplorer#AnomalySubscriptionFrequency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DAILY", + "name": "DAILY" + }, + { + "value": "IMMEDIATE", + "name": "IMMEDIATE" + }, + { + "value": "WEEKLY", + "name": "WEEKLY" + } + ] + } + }, + "com.amazonaws.costexplorer#AnomalySubscriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#AnomalySubscription" + } + }, "com.amazonaws.costexplorer#Arn": { "type": "string", "traits": { @@ -186,10 +497,10 @@ "com.amazonaws.costexplorer#CostCategory": { "type": "structure", "members": { - "CostCategoryArn": { - "target": "com.amazonaws.costexplorer#Arn", + "Rules": { + "target": "com.amazonaws.costexplorer#CostCategoryRulesList", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

", + "smithy.api#documentation": "

\n Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.\n

", "smithy.api#required": {} } }, @@ -199,10 +510,16 @@ "smithy.api#documentation": "

\n The Cost Category's effective end date.

" } }, - "Rules": { - "target": "com.amazonaws.costexplorer#CostCategoryRulesList", + "CostCategoryArn": { + "target": "com.amazonaws.costexplorer#Arn", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

", + "smithy.api#required": {} + } + }, + "RuleVersion": { + "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", "traits": { - "smithy.api#documentation": "

\n Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.\n

", "smithy.api#required": {} } }, @@ -212,10 +529,10 @@ "smithy.api#required": {} } }, - "RuleVersion": { - "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", + "ProcessingStatus": { + "target": "com.amazonaws.costexplorer#CostCategoryProcessingStatusList", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

\n The list of processing statuses for Cost Management products for a specific cost category.\n

" } }, "EffectiveStart": { @@ -250,62 +567,100 @@ "smithy.api#pattern": "^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?\n The Cost Category's effective end date.

" - } - }, - "NumberOfRules": { - "target": "com.amazonaws.costexplorer#NonNegativeInteger", - "traits": { - "smithy.api#documentation": "

\n The number of rules associated with a specific Cost Category.\n

" - } - }, - "Name": { - "target": "com.amazonaws.costexplorer#CostCategoryName" - }, - "EffectiveStart": { - "target": "com.amazonaws.costexplorer#ZonedDateTime", + "Component": { + "target": "com.amazonaws.costexplorer#CostCategoryStatusComponent", "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective start date.

" + "smithy.api#documentation": "

\n The Cost Management product name of the applied status.\n

" } }, - "CostCategoryArn": { - "target": "com.amazonaws.costexplorer#Arn", + "Status": { + "target": "com.amazonaws.costexplorer#CostCategoryStatus", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" + "smithy.api#documentation": "

\n The process status for a specific cost category.\n

" } } }, "traits": { - "smithy.api#documentation": "

A reference to a Cost Category containing only enough information to identify the Cost Category.

\n

You can use this information to retrieve the full Cost Category information using DescribeCostCategory.

" + "smithy.api#documentation": "

\n The list of processing statuses for Cost Management products for a specific cost category.\n

" } }, - "com.amazonaws.costexplorer#CostCategoryReferencesList": { + "com.amazonaws.costexplorer#CostCategoryProcessingStatusList": { "type": "list", "member": { - "target": "com.amazonaws.costexplorer#CostCategoryReference" + "target": "com.amazonaws.costexplorer#CostCategoryProcessingStatus" } }, - "com.amazonaws.costexplorer#CostCategoryRule": { + "com.amazonaws.costexplorer#CostCategoryReference": { "type": "structure", "members": { - "Rule": { - "target": "com.amazonaws.costexplorer#Expression", + "ProcessingStatus": { + "target": "com.amazonaws.costexplorer#CostCategoryProcessingStatusList", "traits": { - "smithy.api#documentation": "

An Expression object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME.

\n

Root level OR is not supported. We recommend that you create a separate\n rule instead.

\n \n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the AWS Billing and Cost Management User\n Guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The list of processing statuses for Cost Management products for a specific cost category.\n

" + } + }, + "CostCategoryArn": { + "target": "com.amazonaws.costexplorer#Arn", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" + } + }, + "Values": { + "target": "com.amazonaws.costexplorer#CostCategoryValuesList", + "traits": { + "smithy.api#documentation": "

\n A list of unique cost category values in a specific cost category.\n

" + } + }, + "NumberOfRules": { + "target": "com.amazonaws.costexplorer#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

\n The number of rules associated with a specific Cost Category.\n

" + } + }, + "EffectiveEnd": { + "target": "com.amazonaws.costexplorer#ZonedDateTime", + "traits": { + "smithy.api#documentation": "

\n The Cost Category's effective end date.

" } }, + "Name": { + "target": "com.amazonaws.costexplorer#CostCategoryName" + }, + "EffectiveStart": { + "target": "com.amazonaws.costexplorer#ZonedDateTime", + "traits": { + "smithy.api#documentation": "

\n The Cost Category's effective start date.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A reference to a Cost Category containing only enough information to identify the Cost Category.

\n

You can use this information to retrieve the full Cost Category information using DescribeCostCategory.

" + } + }, + "com.amazonaws.costexplorer#CostCategoryReferencesList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#CostCategoryReference" + } + }, + "com.amazonaws.costexplorer#CostCategoryRule": { + "type": "structure", + "members": { "Value": { "target": "com.amazonaws.costexplorer#CostCategoryValue", "traits": { "smithy.api#required": {} } + }, + "Rule": { + "target": "com.amazonaws.costexplorer#Expression", + "traits": { + "smithy.api#documentation": "

An Expression\n object used to categorize costs. This supports dimensions, tags, and nested expressions.\n Currently the only dimensions supported are LINKED_ACCOUNT,\n SERVICE_CODE, RECORD_TYPE, and\n LINKED_ACCOUNT_NAME.

\n

Root level OR is not supported. We recommend that you create a separate\n rule instead.

\n \n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the AWS Billing and Cost Management User\n Guide.

", + "smithy.api#required": {} + } } }, "traits": { @@ -336,6 +691,32 @@ } } }, + "com.amazonaws.costexplorer#CostCategoryStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROCESSING", + "name": "PROCESSING" + }, + { + "value": "APPLIED", + "name": "APPLIED" + } + ] + } + }, + "com.amazonaws.costexplorer#CostCategoryStatusComponent": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COST_EXPLORER", + "name": "COST_EXPLORER" + } + ] + } + }, "com.amazonaws.costexplorer#CostCategoryValue": { "type": "string", "traits": { @@ -356,6 +737,12 @@ "smithy.api#documentation": "

The specific value of the Cost Category.

" } }, + "MatchOptions": { + "target": "com.amazonaws.costexplorer#MatchOptions", + "traits": { + "smithy.api#documentation": "

\n The match options that you can use to filter your results. MatchOptions is only applicable for only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.\n

" + } + }, "Key": { "target": "com.amazonaws.costexplorer#CostCategoryName" } @@ -364,6 +751,12 @@ "smithy.api#documentation": "

The Cost Categories values used for filtering the costs.

" } }, + "com.amazonaws.costexplorer#CostCategoryValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#CostCategoryValue" + } + }, "com.amazonaws.costexplorer#Coverage": { "type": "structure", "members": { @@ -393,10 +786,10 @@ "com.amazonaws.costexplorer#CoverageByTime": { "type": "structure", "members": { - "Total": { - "target": "com.amazonaws.costexplorer#Coverage", + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

The total reservation coverage, in hours.

" + "smithy.api#documentation": "

The period that this coverage was used over.

" } }, "Groups": { @@ -405,10 +798,10 @@ "smithy.api#documentation": "

The groups of instances that the reservation covered.

" } }, - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "Total": { + "target": "com.amazonaws.costexplorer#Coverage", "traits": { - "smithy.api#documentation": "

The period that this coverage was used over.

" + "smithy.api#documentation": "

The total reservation coverage, in hours.

" } } }, @@ -433,6 +826,12 @@ "com.amazonaws.costexplorer#CoverageHours": { "type": "structure", "members": { + "TotalRunningHours": { + "target": "com.amazonaws.costexplorer#TotalRunningHours", + "traits": { + "smithy.api#documentation": "

The total instance usage, in hours.

" + } + }, "CoverageHoursPercentage": { "target": "com.amazonaws.costexplorer#CoverageHoursPercentage", "traits": { @@ -445,12 +844,6 @@ "smithy.api#documentation": "

The number of instance running hours that reservations covered.

" } }, - "TotalRunningHours": { - "target": "com.amazonaws.costexplorer#TotalRunningHours", - "traits": { - "smithy.api#documentation": "

The total instance usage, in hours.

" - } - }, "OnDemandHours": { "target": "com.amazonaws.costexplorer#OnDemandHours", "traits": { @@ -468,16 +861,16 @@ "com.amazonaws.costexplorer#CoverageNormalizedUnits": { "type": "structure", "members": { - "ReservedNormalizedUnits": { - "target": "com.amazonaws.costexplorer#ReservedNormalizedUnits", + "TotalRunningNormalizedUnits": { + "target": "com.amazonaws.costexplorer#TotalRunningNormalizedUnits", "traits": { - "smithy.api#documentation": "

The number of normalized units that a reservation covers.

" + "smithy.api#documentation": "

The total number of normalized units that you used.

" } }, - "CoverageNormalizedUnitsPercentage": { - "target": "com.amazonaws.costexplorer#CoverageNormalizedUnitsPercentage", + "ReservedNormalizedUnits": { + "target": "com.amazonaws.costexplorer#ReservedNormalizedUnits", "traits": { - "smithy.api#documentation": "

The percentage of your used instance normalized units that a reservation\n covers.

" + "smithy.api#documentation": "

The number of normalized units that a reservation covers.

" } }, "OnDemandNormalizedUnits": { @@ -486,10 +879,10 @@ "smithy.api#documentation": "

The number of normalized units that are covered by On-Demand Instances instead of a\n reservation.

" } }, - "TotalRunningNormalizedUnits": { - "target": "com.amazonaws.costexplorer#TotalRunningNormalizedUnits", + "CoverageNormalizedUnitsPercentage": { + "target": "com.amazonaws.costexplorer#CoverageNormalizedUnitsPercentage", "traits": { - "smithy.api#documentation": "

The total number of normalized units that you used.

" + "smithy.api#documentation": "

The percentage of your used instance normalized units that a reservation\n covers.

" } } }, @@ -506,6 +899,91 @@ "target": "com.amazonaws.costexplorer#CoverageByTime" } }, + "com.amazonaws.costexplorer#CreateAnomalyMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#CreateAnomalyMonitorRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#CreateAnomalyMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new cost anomaly detection monitor with the requested type and monitor\n specification.

" + } + }, + "com.amazonaws.costexplorer#CreateAnomalyMonitorRequest": { + "type": "structure", + "members": { + "AnomalyMonitor": { + "target": "com.amazonaws.costexplorer#AnomalyMonitor", + "traits": { + "smithy.api#documentation": "

The cost anomaly detection monitor object that you want to create.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#CreateAnomalyMonitorResponse": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The unique identifier of your newly created cost anomaly detection monitor.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#CreateAnomalySubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#CreateAnomalySubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#CreateAnomalySubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + }, + { + "target": "com.amazonaws.costexplorer#UnknownMonitorException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a subscription to a cost anomaly detection monitor. You can use each subscription to\n define subscribers with email or SNS notifications. Email subscribers can set a dollar\n threshold and a time frequency for receiving notifications.

" + } + }, + "com.amazonaws.costexplorer#CreateAnomalySubscriptionRequest": { + "type": "structure", + "members": { + "AnomalySubscription": { + "target": "com.amazonaws.costexplorer#AnomalySubscription", + "traits": { + "smithy.api#documentation": "

\n The cost anomaly subscription object that you want to create.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#CreateAnomalySubscriptionResponse": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of your newly created cost anomaly subscription.\n

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.costexplorer#CreateCostCategoryDefinition": { "type": "operation", "input": { @@ -529,14 +1007,14 @@ "com.amazonaws.costexplorer#CreateCostCategoryDefinitionRequest": { "type": "structure", "members": { - "RuleVersion": { - "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", + "Name": { + "target": "com.amazonaws.costexplorer#CostCategoryName", "traits": { "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.costexplorer#CostCategoryName", + "RuleVersion": { + "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", "traits": { "smithy.api#required": {} } @@ -570,34 +1048,28 @@ "com.amazonaws.costexplorer#CurrentInstance": { "type": "structure", "members": { - "CurrencyCode": { + "MonthlyCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this instance.

" + "smithy.api#documentation": "

Current On-Demand cost of operating this instance on a monthly basis.

" } }, - "ReservationCoveredHoursInLookbackPeriod": { + "ResourceId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Number of hours during the lookback period covered by reservations.

" + "smithy.api#documentation": "

Resource ID of the current instance.

" } }, - "OnDemandHoursInLookbackPeriod": { + "TotalRunningHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Number of hours during the lookback period billed at On Demand rates.

" - } - }, - "Tags": { - "target": "com.amazonaws.costexplorer#TagValuesList", - "traits": { - "smithy.api#documentation": "

Cost allocation resource tags applied to the instance.

" + "smithy.api#documentation": "

The total number of hours the instance ran during the lookback period.

" } }, - "MonthlyCost": { + "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Current On Demand cost of operating this instance on a monthly basis.

" + "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" } }, "InstanceName": { @@ -606,22 +1078,28 @@ "smithy.api#documentation": "

The name you've given an instance. This field will show as blank if you haven't given the instance a name.

" } }, - "ResourceDetails": { - "target": "com.amazonaws.costexplorer#ResourceDetails", + "OnDemandHoursInLookbackPeriod": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Details about the resource and utilization.

" + "smithy.api#documentation": "

Number of hours during the lookback period billed at On-Demand rates.

" } }, - "ResourceId": { + "ReservationCoveredHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Resource ID of the current instance.

" + "smithy.api#documentation": "

Number of hours during the lookback period covered by reservations.

" } }, - "TotalRunningHoursInLookbackPeriod": { + "Tags": { + "target": "com.amazonaws.costexplorer#TagValuesList", + "traits": { + "smithy.api#documentation": "

Cost allocation resource tags applied to the instance.

" + } + }, + "SavingsPlansCoveredHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total number of hours the instance ran during the lookback period.

" + "smithy.api#documentation": "

Number of hours during the lookback period covered by Savings Plans.

" } }, "ResourceUtilization": { @@ -630,10 +1108,10 @@ "smithy.api#documentation": "

Utilization information of the current instance during the lookback period.

" } }, - "SavingsPlansCoveredHoursInLookbackPeriod": { - "target": "com.amazonaws.costexplorer#GenericString", + "ResourceDetails": { + "target": "com.amazonaws.costexplorer#ResourceDetails", "traits": { - "smithy.api#documentation": "

Number of hours during the lookback period covered by Savings Plans.

" + "smithy.api#documentation": "

Details about the resource and utilization.

" } } }, @@ -656,17 +1134,17 @@ "com.amazonaws.costexplorer#DateInterval": { "type": "structure", "members": { - "Start": { + "End": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

The beginning of the time period that you want the usage and costs for. The start\n date is inclusive. For example, if start is 2017-01-01, AWS\n retrieves cost and usage data starting at 2017-01-01 up to the end\n date.

", + "smithy.api#documentation": "

The end of the time period that you want the usage and costs for. The end date is\n exclusive. For example, if end is 2017-05-01, AWS retrieves\n cost and usage data from the start date up to, but not including,\n 2017-05-01.

", "smithy.api#required": {} } }, - "End": { + "Start": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

The end of the time period that you want the usage and costs for. The end date is\n exclusive. For example, if end is 2017-05-01, AWS retrieves\n cost and usage data from the start date up to, but not including,\n 2017-05-01.

", + "smithy.api#documentation": "

The beginning of the time period that you want the usage and costs for. The start\n date is inclusive. For example, if start is 2017-01-01, AWS\n retrieves cost and usage data starting at 2017-01-01 up to the end\n date.

", "smithy.api#required": {} } } @@ -675,52 +1153,124 @@ "smithy.api#documentation": "

The time period that you want the usage and costs for.\n

" } }, - "com.amazonaws.costexplorer#DeleteCostCategoryDefinition": { + "com.amazonaws.costexplorer#DeleteAnomalyMonitor": { "type": "operation", "input": { - "target": "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionRequest" + "target": "com.amazonaws.costexplorer#DeleteAnomalyMonitorRequest" }, "output": { - "target": "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionResponse" + "target": "com.amazonaws.costexplorer#DeleteAnomalyMonitorResponse" }, "errors": [ { "target": "com.amazonaws.costexplorer#LimitExceededException" }, { - "target": "com.amazonaws.costexplorer#ResourceNotFoundException" + "target": "com.amazonaws.costexplorer#UnknownMonitorException" } ], "traits": { - "smithy.api#documentation": "

Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

" + "smithy.api#documentation": "

Deletes a cost anomaly monitor.

" } }, - "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionRequest": { + "com.amazonaws.costexplorer#DeleteAnomalyMonitorRequest": { "type": "structure", "members": { - "CostCategoryArn": { - "target": "com.amazonaws.costexplorer#Arn", + "MonitorArn": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

", + "smithy.api#documentation": "

The unique identifier of the cost anomaly monitor that you want to delete.

", "smithy.api#required": {} } } } }, - "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionResponse": { + "com.amazonaws.costexplorer#DeleteAnomalyMonitorResponse": { "type": "structure", - "members": { - "CostCategoryArn": { - "target": "com.amazonaws.costexplorer#Arn", - "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" + "members": {} + }, + "com.amazonaws.costexplorer#DeleteAnomalySubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#DeleteAnomalySubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#DeleteAnomalySubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + }, + { + "target": "com.amazonaws.costexplorer#UnknownSubscriptionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a cost anomaly subscription.

" + } + }, + "com.amazonaws.costexplorer#DeleteAnomalySubscriptionRequest": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the cost anomaly subscription that you want to delete.

", + "smithy.api#required": {} } + } + } + }, + "com.amazonaws.costexplorer#DeleteAnomalySubscriptionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.costexplorer#DeleteCostCategoryDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" }, + { + "target": "com.amazonaws.costexplorer#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

" + } + }, + "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionRequest": { + "type": "structure", + "members": { + "CostCategoryArn": { + "target": "com.amazonaws.costexplorer#Arn", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#DeleteCostCategoryDefinitionResponse": { + "type": "structure", + "members": { "EffectiveEnd": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { "smithy.api#documentation": "

\n The effective end date of the Cost Category as a result of deleting it. No costs after this date will be categorized by the deleted Cost Category.\n

" } + }, + "CostCategoryArn": { + "target": "com.amazonaws.costexplorer#Arn", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" + } } } }, @@ -747,18 +1297,18 @@ "com.amazonaws.costexplorer#DescribeCostCategoryDefinitionRequest": { "type": "structure", "members": { + "EffectiveOn": { + "target": "com.amazonaws.costexplorer#ZonedDateTime", + "traits": { + "smithy.api#documentation": "

\n The date when the Cost Category was effective.\n

" + } + }, "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

", "smithy.api#required": {} } - }, - "EffectiveOn": { - "target": "com.amazonaws.costexplorer#ZonedDateTime", - "traits": { - "smithy.api#documentation": "

\n The date when the Cost Category was effective.\n

" - } } } }, @@ -896,16 +1446,16 @@ "com.amazonaws.costexplorer#DimensionValues": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.costexplorer#Values", + "MatchOptions": { + "target": "com.amazonaws.costexplorer#MatchOptions", "traits": { - "smithy.api#documentation": "

The metadata values that you can use to filter and group your results. You can use\n GetDimensionValues to find specific values.

" + "smithy.api#documentation": "

The match options that you can use to filter your results.\n MatchOptions is only applicable for actions related to Cost Category.\n The default values for MatchOptions are EQUALS and\n CASE_SENSITIVE.

" } }, - "MatchOptions": { - "target": "com.amazonaws.costexplorer#MatchOptions", + "Values": { + "target": "com.amazonaws.costexplorer#Values", "traits": { - "smithy.api#documentation": "

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

" + "smithy.api#documentation": "

The metadata values that you can use to filter and group your results. You can use\n GetDimensionValues to find specific values.

" } }, "Key": { @@ -945,37 +1495,57 @@ "target": "com.amazonaws.costexplorer#DimensionValuesWithAttributes" } }, - "com.amazonaws.costexplorer#EC2InstanceDetails": { + "com.amazonaws.costexplorer#EBSResourceUtilization": { "type": "structure", "members": { - "AvailabilityZone": { + "EbsWriteBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The Availability Zone of the recommended reservation.

" + "smithy.api#documentation": "

\n The maximum size of write operations per second.\n

" } }, - "Family": { + "EbsWriteOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The instance family of the recommended reservation.

" + "smithy.api#documentation": "

\n The maximum number of write operations per second.\n

" } }, - "Region": { + "EbsReadOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

\n The maximum number of read operations per second.\n

" } }, - "SizeFlexEligible": { + "EbsReadBytesPerSecond": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The maximum size of read operations per second\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The EBS field that contains a list of EBS metrics associated with the current instance.\n

" + } + }, + "com.amazonaws.costexplorer#EC2InstanceDetails": { + "type": "structure", + "members": { + "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" } }, - "InstanceType": { + "Family": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of instance that AWS recommends.

" + "smithy.api#documentation": "

The instance family of the recommended reservation.

" + } + }, + "Region": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" } }, "Tenancy": { @@ -984,16 +1554,28 @@ "smithy.api#documentation": "

Whether the recommended reservation is dedicated or shared.

" } }, + "InstanceType": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The type of instance that AWS recommends.

" + } + }, "Platform": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { "smithy.api#documentation": "

The platform of the recommended reservation. The platform is the specific\n combination of operating system, license model, and software on an instance.

" } }, - "CurrentGeneration": { + "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The Availability Zone of the recommended reservation.

" } } }, @@ -1004,58 +1586,58 @@ "com.amazonaws.costexplorer#EC2ResourceDetails": { "type": "structure", "members": { - "Vcpu": { + "Storage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Number of VCPU cores in the Amazon Web Services instance type.

" + "smithy.api#documentation": "

The disk storage of the AWS instance (not EBS storage).

" } }, - "Memory": { + "InstanceType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Memory capacity of Amazon Web Services instance.

" + "smithy.api#documentation": "

The type of AWS instance.

" } }, - "HourlyOnDemandRate": { + "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Hourly public On Demand rate for the instance type.

" + "smithy.api#documentation": "

The AWS Region of the instance.

" } }, - "InstanceType": { + "NetworkPerformance": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of Amazon Web Services instance.

" + "smithy.api#documentation": "

Network performance capacity of the AWS instance.

" } }, - "Platform": { + "Sku": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.

" + "smithy.api#documentation": "

The SKU of the product.

" } }, - "Region": { + "Vcpu": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the instance.

" + "smithy.api#documentation": "

Number of VCPU cores in the AWS instance type.

" } }, - "Storage": { + "Platform": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The disk storage of the Amazon Web Services instance (Not EBS storage).

" + "smithy.api#documentation": "

The platform of the AWS instance. The platform is the specific combination of\n operating system, license model, and software on an instance.

" } }, - "NetworkPerformance": { + "HourlyOnDemandRate": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Network performance capacity of the Amazon Web Services instance.

" + "smithy.api#documentation": "

Hourly public On-Demand rate for the instance type.

" } }, - "Sku": { + "Memory": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The SKU of the product.

" + "smithy.api#documentation": "

Memory capacity of the AWS instance.

" } } }, @@ -1072,6 +1654,12 @@ "smithy.api#documentation": "

Maximum observed or expected storage utilization of the instance (does not measure EBS storage).

" } }, + "EBSResourceUtilization": { + "target": "com.amazonaws.costexplorer#EBSResourceUtilization", + "traits": { + "smithy.api#documentation": "

\n The EBS field that contains a list of EBS metrics associated with the current instance.\n

" + } + }, "MaxCpuUtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { @@ -1106,22 +1694,16 @@ "com.amazonaws.costexplorer#ESInstanceDetails": { "type": "structure", "members": { - "CurrentGeneration": { - "target": "com.amazonaws.costexplorer#GenericBoolean", - "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" - } - }, - "InstanceClass": { + "InstanceSize": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The class of instance that AWS recommends.

" + "smithy.api#documentation": "

The size of instance that AWS recommends.

" } }, - "InstanceSize": { + "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The size of instance that AWS recommends.

" + "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" } }, "SizeFlexEligible": { @@ -1130,10 +1712,16 @@ "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" } }, - "Region": { + "CurrentGeneration": { + "target": "com.amazonaws.costexplorer#GenericBoolean", + "traits": { + "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + } + }, + "InstanceClass": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The class of instance that AWS recommends.

" } } }, @@ -1144,6 +1732,12 @@ "com.amazonaws.costexplorer#ElastiCacheInstanceDetails": { "type": "structure", "members": { + "SizeFlexEligible": { + "target": "com.amazonaws.costexplorer#GenericBoolean", + "traits": { + "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + } + }, "NodeType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { @@ -1156,10 +1750,10 @@ "smithy.api#documentation": "

Whether the recommendation is for a current generation instance.

" } }, - "Region": { + "ProductDescription": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The description of the recommended reservation.

" } }, "Family": { @@ -1168,16 +1762,10 @@ "smithy.api#documentation": "

The instance family of the recommended reservation.

" } }, - "SizeFlexEligible": { - "target": "com.amazonaws.costexplorer#GenericBoolean", - "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" - } - }, - "ProductDescription": { + "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The description of the recommended reservation.

" + "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" } } }, @@ -1197,22 +1785,16 @@ "com.amazonaws.costexplorer#Expression": { "type": "structure", "members": { - "Not": { - "target": "com.amazonaws.costexplorer#Expression", + "CostCategories": { + "target": "com.amazonaws.costexplorer#CostCategoryValues", "traits": { - "smithy.api#documentation": "

Return results that don't match a Dimension object.

" + "smithy.api#documentation": "

The filter based on CostCategory values.

" } }, - "Or": { + "And": { "target": "com.amazonaws.costexplorer#Expressions", "traits": { - "smithy.api#documentation": "

Return results that match either Dimension object.

" - } - }, - "Tags": { - "target": "com.amazonaws.costexplorer#TagValues", - "traits": { - "smithy.api#documentation": "

The specific Tag to use for Expression.

" + "smithy.api#documentation": "

Return results that match both Dimension objects.

" } }, "Dimensions": { @@ -1221,21 +1803,27 @@ "smithy.api#documentation": "

The specific Dimension to use for Expression.

" } }, - "CostCategories": { - "target": "com.amazonaws.costexplorer#CostCategoryValues", + "Tags": { + "target": "com.amazonaws.costexplorer#TagValues", "traits": { - "smithy.api#documentation": "

The filter based on CostCategory values.

" + "smithy.api#documentation": "

The specific Tag to use for Expression.

" } }, - "And": { + "Not": { + "target": "com.amazonaws.costexplorer#Expression", + "traits": { + "smithy.api#documentation": "

Return results that don't match a Dimension object.

" + } + }, + "Or": { "target": "com.amazonaws.costexplorer#Expressions", "traits": { - "smithy.api#documentation": "

Return results that match both Dimension objects.

" + "smithy.api#documentation": "

Return results that match either Dimension object.

" } } }, "traits": { - "smithy.api#documentation": "

Use Expression to filter by cost or by usage. There are two patterns:

\n \n \n

For GetRightsizingRecommendation action, a combination of OR and NOT is not\n supported. OR is not supported between different dimensions, or dimensions and tags.\n NOT operators aren't supported.\n Dimensions\n are also limited to LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n " + "smithy.api#documentation": "

Use Expression to filter by cost or by usage. There are two patterns:

\n \n \n

For GetRightsizingRecommendation action, a combination of OR and NOT is not\n supported. OR is not supported between different dimensions, or dimensions and tags.\n NOT operators aren't supported.\n Dimensions\n are also limited to LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n " } }, "com.amazonaws.costexplorer#Expressions": { @@ -1247,6 +1835,18 @@ "com.amazonaws.costexplorer#ForecastResult": { "type": "structure", "members": { + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", + "traits": { + "smithy.api#documentation": "

The period of time that the forecast covers.

" + } + }, + "MeanValue": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The mean value of the forecast.

" + } + }, "PredictionIntervalLowerBound": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { @@ -1258,41 +1858,246 @@ "traits": { "smithy.api#documentation": "

The upper limit for the prediction interval.

" } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast created for your query.

" + } + }, + "com.amazonaws.costexplorer#ForecastResultsByTime": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#ForecastResult" + } + }, + "com.amazonaws.costexplorer#GenericBoolean": { + "type": "boolean" + }, + "com.amazonaws.costexplorer#GenericDouble": { + "type": "double" + }, + "com.amazonaws.costexplorer#GenericString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 }, - "MeanValue": { + "smithy.api#pattern": "[\\S\\s]*" + } + }, + "com.amazonaws.costexplorer#GetAnomalies": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#GetAnomaliesRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#GetAnomaliesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account, during the time period\n specified by the DateInterval object.

" + } + }, + "com.amazonaws.costexplorer#GetAnomaliesRequest": { + "type": "structure", + "members": { + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + } + }, + "DateInterval": { + "target": "com.amazonaws.costexplorer#AnomalyDateInterval", + "traits": { + "smithy.api#documentation": "

Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object\n will have an AnomalyEndDate in the specified time range.

", + "smithy.api#required": {} + } + }, + "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The mean value of the forecast.

" + "smithy.api#documentation": "

Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon\n Resource Name (ARN).

" + } + }, + "TotalImpact": { + "target": "com.amazonaws.costexplorer#TotalImpactFilter", + "traits": { + "smithy.api#documentation": "

Filters anomaly results by the total impact field on the anomaly object. For example, you\n can filter anomalies GREATER_THAN 200.00 to retrieve anomalies, with an estimated\n dollar impact greater than 200.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.costexplorer#PageSize", + "traits": { + "smithy.api#documentation": "

\n The number of entries a paginated response contains.\n

" + } + }, + "Feedback": { + "target": "com.amazonaws.costexplorer#AnomalyFeedbackType", + "traits": { + "smithy.api#documentation": "

Filters anomaly results by the feedback field on the anomaly object.

" + } + } + } + }, + "com.amazonaws.costexplorer#GetAnomaliesResponse": { + "type": "structure", + "members": { + "Anomalies": { + "target": "com.amazonaws.costexplorer#Anomalies", + "traits": { + "smithy.api#documentation": "

\n A list of cost anomalies.\n

", + "smithy.api#required": {} + } + }, + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + } + } + } + }, + "com.amazonaws.costexplorer#GetAnomalyMonitors": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#GetAnomalyMonitorsRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#GetAnomalyMonitorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + }, + { + "target": "com.amazonaws.costexplorer#UnknownMonitorException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the cost anomaly monitor definitions for your account. You can filter using a\n list of cost anomaly monitor Amazon Resource Names (ARNs).

" + } + }, + "com.amazonaws.costexplorer#GetAnomalyMonitorsRequest": { + "type": "structure", + "members": { + "MonitorArnList": { + "target": "com.amazonaws.costexplorer#Values", + "traits": { + "smithy.api#documentation": "

\n A list of cost anomaly monitor ARNs.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.costexplorer#PageSize", + "traits": { + "smithy.api#documentation": "

\n The number of entries a paginated response contains.\n

" + } + }, + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + } + } + } + }, + "com.amazonaws.costexplorer#GetAnomalyMonitorsResponse": { + "type": "structure", + "members": { + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + } + }, + "AnomalyMonitors": { + "target": "com.amazonaws.costexplorer#AnomalyMonitors", + "traits": { + "smithy.api#documentation": "

\n A list of cost anomaly monitors that includes the detailed metadata for each monitor.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#GetAnomalySubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#GetAnomalySubscriptionsRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#GetAnomalySubscriptionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + }, + { + "target": "com.amazonaws.costexplorer#UnknownSubscriptionException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the cost anomaly subscription objects for your account. You can filter using a\n list of cost anomaly monitor Amazon Resource Names (ARNs).

" + } + }, + "com.amazonaws.costexplorer#GetAnomalySubscriptionsRequest": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n Cost anomaly monitor ARNs.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.costexplorer#PageSize", + "traits": { + "smithy.api#documentation": "

\n The number of entries a paginated response contains.\n

" + } + }, + "SubscriptionArnList": { + "target": "com.amazonaws.costexplorer#Values", + "traits": { + "smithy.api#documentation": "

\n A list of cost anomaly subscription ARNs.\n

" } }, - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The period of time that the forecast covers.

" + "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" } } - }, - "traits": { - "smithy.api#documentation": "

The forecast created for your query.

" } }, - "com.amazonaws.costexplorer#ForecastResultsByTime": { - "type": "list", - "member": { - "target": "com.amazonaws.costexplorer#ForecastResult" - } - }, - "com.amazonaws.costexplorer#GenericBoolean": { - "type": "boolean" - }, - "com.amazonaws.costexplorer#GenericString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 + "com.amazonaws.costexplorer#GetAnomalySubscriptionsResponse": { + "type": "structure", + "members": { + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + } }, - "smithy.api#pattern": "[\\S\\s]*" + "AnomalySubscriptions": { + "target": "com.amazonaws.costexplorer#AnomalySubscriptions", + "traits": { + "smithy.api#documentation": "

\n A list of cost anomaly subscriptions that includes the detailed metadata for each one.\n

", + "smithy.api#required": {} + } + } } }, "com.amazonaws.costexplorer#GetCostAndUsage": { @@ -1321,47 +2126,48 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as \n\t\t\tBlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group \n\t\t\tyour data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list \n\t\t\tof valid dimensions, see the \n\t\t\tGetDimensionValues \n\t\t\toperation. Master accounts in an organization in AWS Organizations have access to all member accounts.

" + "smithy.api#documentation": "

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as \n\t\t\tBlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group \n\t\t\tyour data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list \n\t\t\tof valid dimensions, see the \n\t\t\tGetDimensionValues \n\t\t operation. Master account in an organization in AWS Organizations have access to all member accounts.

" } }, "com.amazonaws.costexplorer#GetCostAndUsageRequest": { "type": "structure", "members": { - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "Metrics": { + "target": "com.amazonaws.costexplorer#MetricNames", "traits": { - "smithy.api#documentation": "

Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

", + "smithy.api#documentation": "

Which metrics are returned in the query. For more information about blended and unblended rates, see \n\t\t\tWhy does the \"blended\" annotation \n\t\t\t\tappear on some line items in my bill?.

\n\t\t

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, \n\t\t\tNetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

\n\t\t \n\t\t\t

If you return the UsageQuantity metric, the service aggregates all usage numbers without \n\t\t\t\ttaking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, \n\t\t\t\tthe results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units \n\t\t\t\t(for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or \n\t\t\t\tUsageTypeGroups.

\n\t\t \n\t\t

\n Metrics is required for GetCostAndUsage requests.

", "smithy.api#required": {} } }, - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", + "GroupBy": { + "target": "com.amazonaws.costexplorer#GroupDefinitions", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

You can group AWS costs using up to two different groups, either dimensions, tag keys,\n cost categories, or any two group by types.

\n\t\t

When you group by tag key, you get all tag values, including empty strings.

\n\t\t

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, \n\t\t\tOPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, \n\t\t TENANCY, RECORD_TYPE, and USAGE_TYPE.

" } }, - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", + "Granularity": { + "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT \n\t\t\tand get the costs that are associated with that account's usage of that service. You can nest Expression objects \n\t\t\tto define any combination of dimension filters. For more information, see \n\t\t\tExpression.

" + "smithy.api#documentation": "

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, \n\t the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

" } }, - "Metrics": { - "target": "com.amazonaws.costexplorer#MetricNames", + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

Which metrics are returned in the query. For more information about blended and unblended rates, see \n\t\t\tWhy does the \"blended\" annotation \n\t\t\t\tappear on some line items in my bill?.

\n\t\t

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, \n\t\t\tNetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

\n\t\t \n\t\t\t

If you return the UsageQuantity metric, the service aggregates all usage numbers without \n\t\t\t\ttaking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, \n\t\t\t\tthe results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units \n\t\t\t\t(for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or \n\t\t\t\tUsageTypeGroups.

\n\t\t \n\t\t

\n Metrics is required for GetCostAndUsage requests.

" + "smithy.api#documentation": "

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT \n\t\t\tand get the costs that are associated with that account's usage of that service. You can nest Expression objects \n\t\t\tto define any combination of dimension filters. For more information, see \n\t\t\tExpression.

" } }, - "Granularity": { - "target": "com.amazonaws.costexplorer#Granularity", + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, \n\t the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

" + "smithy.api#documentation": "

Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

", + "smithy.api#required": {} } }, - "GroupBy": { - "target": "com.amazonaws.costexplorer#GroupDefinitions", + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

\n\t\t

When you group by tag key, you get all tag values, including empty strings.

\n\t\t

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, \n\t\t\tOPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, \n\t\t TENANCY, RECORD_TYPE, and USAGE_TYPE.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } } } @@ -1369,18 +2175,18 @@ "com.amazonaws.costexplorer#GetCostAndUsageResponse": { "type": "structure", "members": { - "GroupDefinitions": { - "target": "com.amazonaws.costexplorer#GroupDefinitions", - "traits": { - "smithy.api#documentation": "

The groups that are specified by the Filter or GroupBy parameters in the request.

" - } - }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } }, + "GroupDefinitions": { + "target": "com.amazonaws.costexplorer#GroupDefinitions", + "traits": { + "smithy.api#documentation": "

The groups that are specified by the Filter or GroupBy parameters in the request.

" + } + }, "ResultsByTime": { "target": "com.amazonaws.costexplorer#ResultsByTime", "traits": { @@ -1415,22 +2221,23 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves cost and usage metrics with resources for your account. You can specify which cost and\n\t usage-related metric, such as BlendedCosts or UsageQuantity, that\n\t you want the request to return. You can also filter and group your data by various dimensions,\n\t such as SERVICE or AZ, in a specific time range. For a complete list\n\t of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS\n\t Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

\n\t \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.

\n " + "smithy.api#documentation": "

Retrieves cost and usage metrics with resources for your account. You can specify which cost and\n\t usage-related metric, such as BlendedCosts or UsageQuantity, that\n\t you want the request to return. You can also filter and group your data by various dimensions,\n\t such as SERVICE or AZ, in a specific time range. For a complete list\n\t of valid dimensions, see the GetDimensionValues operation. Master account in an organization in AWS\n\t Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

\n\t \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.

\n " } }, "com.amazonaws.costexplorer#GetCostAndUsageWithResourcesRequest": { "type": "structure", "members": { - "GroupBy": { - "target": "com.amazonaws.costexplorer#GroupDefinitions", + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

You can group Amazon Web Services costs using up to two different groups: either dimensions, tag keys,\n or both.

" + "smithy.api#documentation": "

Filters Amazon Web Services costs by different dimensions. For example, you can specify\n SERVICE and LINKED_ACCOUNT and get the costs that are associated\n with that account's usage of that service. You can nest Expression objects to\n define any combination of dimension filters. For more information, see Expression.

\n

The GetCostAndUsageWithResources operation requires that you either group by or filter by a\n ResourceId. It requires the Expression \n \"SERVICE = Amazon Elastic Compute Cloud - Compute\" in the filter.

", + "smithy.api#required": {} } }, - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", + "Granularity": { + "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

Filters Amazon Web Services costs by different dimensions. For example, you can specify\n SERVICE and LINKED_ACCOUNT and get the costs that are associated\n with that account's usage of that service. You can nest Expression objects to\n define any combination of dimension filters. For more information, see Expression.

\n

The GetCostAndUsageWithResources operation requires that you either group by or filter by a\n ResourceId.

" + "smithy.api#documentation": "

Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If\n\t Granularity isn't set, the response object doesn't include the\n\t Granularity, MONTHLY, DAILY, or HOURLY.

" } }, "Metrics": { @@ -1452,10 +2259,10 @@ "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } }, - "Granularity": { - "target": "com.amazonaws.costexplorer#Granularity", + "GroupBy": { + "target": "com.amazonaws.costexplorer#GroupDefinitions", "traits": { - "smithy.api#documentation": "

Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If\n\t Granularity isn't set, the response object doesn't include the\n\t Granularity, MONTHLY, DAILY, or HOURLY.

" + "smithy.api#documentation": "

You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.

" } } } @@ -1506,16 +2313,16 @@ "com.amazonaws.costexplorer#GetCostForecastRequest": { "type": "structure", "members": { - "PredictionIntervalLevel": { - "target": "com.amazonaws.costexplorer#PredictionIntervalLevel", + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean \n\t\t\tby specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value \n\t\t\tfalling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" + "smithy.api#documentation": "

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

" } }, "TimePeriod": { "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

The period of time that you want the forecast to cover.

", + "smithy.api#documentation": "

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

", "smithy.api#required": {} } }, @@ -1526,10 +2333,10 @@ "smithy.api#required": {} } }, - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", + "PredictionIntervalLevel": { + "target": "com.amazonaws.costexplorer#PredictionIntervalLevel", "traits": { - "smithy.api#documentation": "

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

" + "smithy.api#documentation": "

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean \n\t\t\tby specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value \n\t\t\tfalling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" } }, "Granularity": { @@ -1544,17 +2351,17 @@ "com.amazonaws.costexplorer#GetCostForecastResponse": { "type": "structure", "members": { - "ForecastResultsByTime": { - "target": "com.amazonaws.costexplorer#ForecastResultsByTime", - "traits": { - "smithy.api#documentation": "

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, \n\t\t\tthis is a list of months.

" - } - }, "Total": { "target": "com.amazonaws.costexplorer#MetricValue", "traits": { "smithy.api#documentation": "

How much you are forecasted to spend over the forecast period, in USD.

" } + }, + "ForecastResultsByTime": { + "target": "com.amazonaws.costexplorer#ForecastResultsByTime", + "traits": { + "smithy.api#documentation": "

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, \n\t\t\tthis is a list of months.

" + } } } }, @@ -1590,16 +2397,17 @@ "com.amazonaws.costexplorer#GetDimensionValuesRequest": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", + "Dimension": { + "target": "com.amazonaws.costexplorer#Dimension", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The name of the dimension. Each Dimension is available for a different Context. \n\t\t\tFor more information, see Context. \n\t\t\t\n\t\t

", + "smithy.api#required": {} } }, - "SearchString": { - "target": "com.amazonaws.costexplorer#SearchString", + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The value that you want to search the filter values for.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } }, "TimePeriod": { @@ -1612,14 +2420,13 @@ "Context": { "target": "com.amazonaws.costexplorer#Context", "traits": { - "smithy.api#documentation": "

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n \n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n \n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n " + "smithy.api#documentation": "

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n \n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n \n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n " } }, - "Dimension": { - "target": "com.amazonaws.costexplorer#Dimension", + "SearchString": { + "target": "com.amazonaws.costexplorer#SearchString", "traits": { - "smithy.api#documentation": "

The name of the dimension. Each Dimension is available for a different Context. \n\t\t\tFor more information, see Context. \n\t\t\t\n\t\t

", - "smithy.api#required": {} + "smithy.api#documentation": "

The value that you want to search the filter values for.

" } } } @@ -1627,32 +2434,32 @@ "com.amazonaws.costexplorer#GetDimensionValuesResponse": { "type": "structure", "members": { - "ReturnSize": { - "target": "com.amazonaws.costexplorer#PageSize", + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The number of results that AWS returned at one time.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } }, - "TotalSize": { + "ReturnSize": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { - "smithy.api#documentation": "

The total number of search results.

", + "smithy.api#documentation": "

The number of results that AWS returned at one time.

", "smithy.api#required": {} } }, - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" - } - }, "DimensionValues": { "target": "com.amazonaws.costexplorer#DimensionValuesWithAttributesList", "traits": { "smithy.api#documentation": "

The filters that you used to filter your request. Some dimensions are available only for a specific context.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n \n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n \n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n ", "smithy.api#required": {} } + }, + "TotalSize": { + "target": "com.amazonaws.costexplorer#PageSize", + "traits": { + "smithy.api#documentation": "

The total number of search results.

", + "smithy.api#required": {} + } } } }, @@ -1682,10 +2489,10 @@ "com.amazonaws.costexplorer#GetReservationCoverageRequest": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

Filters utilization data by dimensions. You can filter by the following dimensions:

\n\t\t \n\t\t

\n GetReservationCoverage uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension. You can nest only one level deep. \n\t\t\tIf there are multiple values for a dimension, they are OR'd together.

\n\t\t

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

\n\t

Cost category is also supported.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } }, "Granularity": { @@ -1694,29 +2501,29 @@ "smithy.api#documentation": "

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

\n\t\t

If GroupBy is set, Granularity can't be set. If Granularity isn't set, \n\t\t\tthe response object doesn't include Granularity, either MONTHLY or DAILY.

\n\t\t

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

" } }, - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "GroupBy": { + "target": "com.amazonaws.costexplorer#GroupDefinitions", "traits": { - "smithy.api#documentation": "

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data \n\t\t\tfor a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

", - "smithy.api#required": {} + "smithy.api#documentation": "

You can group the data by the following attributes:

\n\t\t " } }, - "Metrics": { - "target": "com.amazonaws.costexplorer#MetricNames", + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The measurement that you want your reservation coverage reported in.

\n\t\t

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

" + "smithy.api#documentation": "

Filters utilization data by dimensions. You can filter by the following dimensions:

\n\t\t \n\t\t

\n GetReservationCoverage uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension. You can nest only one level deep. \n\t\t\tIf there are multiple values for a dimension, they are OR'd together.

\n\t\t

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

\n\t

Cost category is also supported.

" } }, - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", + "Metrics": { + "target": "com.amazonaws.costexplorer#MetricNames", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The measurement that you want your reservation coverage reported in.

\n\t\t

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

" } }, - "GroupBy": { - "target": "com.amazonaws.costexplorer#GroupDefinitions", + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

You can group the data by the following attributes:

\n\t\t " + "smithy.api#documentation": "

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data \n\t\t\tfor a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

", + "smithy.api#required": {} } } }, @@ -1733,18 +2540,18 @@ "smithy.api#documentation": "

The total amount of instance usage that a reservation covered.

" } }, - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" - } - }, "CoveragesByTime": { "target": "com.amazonaws.costexplorer#CoveragesByTime", "traits": { "smithy.api#documentation": "

The amount of time that your reservations covered.

", "smithy.api#required": {} } + }, + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } } } }, @@ -1774,16 +2581,10 @@ "com.amazonaws.costexplorer#GetReservationPurchaseRecommendationRequest": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.costexplorer#NonNegativeInteger", - "traits": { - "smithy.api#documentation": "

The number of recommendations that you want returned in a single response object.

" - } - }, - "AccountId": { - "target": "com.amazonaws.costexplorer#GenericString", + "PaymentOption": { + "target": "com.amazonaws.costexplorer#PaymentOption", "traits": { - "smithy.api#documentation": "

The account ID that is associated with the recommendation.

" + "smithy.api#documentation": "

The reservation purchase option that you want recommendations for.

" } }, "Service": { @@ -1793,10 +2594,10 @@ "smithy.api#required": {} } }, - "LookbackPeriodInDays": { - "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", + "PageSize": { + "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The number of previous days that you want AWS to consider when it calculates your recommendations.

" + "smithy.api#documentation": "

The number of recommendations that you want returned in a single response object.

" } }, "TermInYears": { @@ -1805,10 +2606,16 @@ "smithy.api#documentation": "

The reservation term that you want recommendations for.

" } }, - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", + "AccountId": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results that you want to retrieve.

" + "smithy.api#documentation": "

The account ID that is associated with the recommendation.

" + } + }, + "AccountScope": { + "target": "com.amazonaws.costexplorer#AccountScope", + "traits": { + "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the master account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

" } }, "ServiceSpecification": { @@ -1817,16 +2624,16 @@ "smithy.api#documentation": "

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

" } }, - "PaymentOption": { - "target": "com.amazonaws.costexplorer#PaymentOption", + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The reservation purchase option that you want recommendations for.

" + "smithy.api#documentation": "

The pagination token that indicates the next set of results that you want to retrieve.

" } }, - "AccountScope": { - "target": "com.amazonaws.costexplorer#AccountScope", + "LookbackPeriodInDays": { + "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual linked accounts only.

" + "smithy.api#documentation": "

The number of previous days that you want AWS to consider when it calculates your recommendations.

" } } } @@ -1834,12 +2641,6 @@ "com.amazonaws.costexplorer#GetReservationPurchaseRecommendationResponse": { "type": "structure", "members": { - "Recommendations": { - "target": "com.amazonaws.costexplorer#ReservationPurchaseRecommendations", - "traits": { - "smithy.api#documentation": "

Recommendations for reservations to purchase.

" - } - }, "Metadata": { "target": "com.amazonaws.costexplorer#ReservationPurchaseRecommendationMetadata", "traits": { @@ -1849,7 +2650,13 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The pagination token for the next set of retrievable results.

" + "smithy.api#documentation": "

The pagination token for the next set of retrievable results.

" + } + }, + "Recommendations": { + "target": "com.amazonaws.costexplorer#ReservationPurchaseRecommendations", + "traits": { + "smithy.api#documentation": "

Recommendations for reservations to purchase.

" } } } @@ -1874,16 +2681,22 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. \n\t\t\tYou can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible \n\t\t\tdimension values. Currently, you can group only by SUBSCRIPTION_ID.

" + "smithy.api#documentation": "

Retrieves the reservation utilization for your account. Master account in an organization have access to member accounts. \n\t\t\tYou can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible \n\t\t\tdimension values. Currently, you can group only by SUBSCRIPTION_ID.

" } }, "com.amazonaws.costexplorer#GetReservationUtilizationRequest": { "type": "structure", "members": { - "GroupBy": { - "target": "com.amazonaws.costexplorer#GroupDefinitions", + "Granularity": { + "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

Groups only by SUBSCRIPTION_ID. Metadata is included.

" + "smithy.api#documentation": "

If GroupBy is set, Granularity can't be set. If Granularity isn't set, \n\t\t\tthe response object doesn't include Granularity, either MONTHLY or DAILY. \n\t\t\tIf both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

\n\t\t

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

" + } + }, + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", + "traits": { + "smithy.api#documentation": "

Filters utilization data by dimensions. You can filter by the following dimensions:

\n\t\t \n\t\t

\n GetReservationUtilization uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension, and nesting is supported up to \n\t\t\tonly one level deep. If there are multiple values for a dimension, they are OR'd together.

" } }, "TimePeriod": { @@ -1899,16 +2712,10 @@ "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } }, - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", - "traits": { - "smithy.api#documentation": "

Filters utilization data by dimensions. You can filter by the following dimensions:

\n\t\t \n\t\t

\n GetReservationUtilization uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension, and nesting is supported up to \n\t\t\tonly one level deep. If there are multiple values for a dimension, they are OR'd together.

" - } - }, - "Granularity": { - "target": "com.amazonaws.costexplorer#Granularity", + "GroupBy": { + "target": "com.amazonaws.costexplorer#GroupDefinitions", "traits": { - "smithy.api#documentation": "

If GroupBy is set, Granularity can't be set. If Granularity isn't set, \n\t\t\tthe response object doesn't include Granularity, either MONTHLY or DAILY. \n\t\t\tIf both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

\n\t\t

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

" + "smithy.api#documentation": "

Groups only by SUBSCRIPTION_ID. Metadata is included.

" } } } @@ -1960,12 +2767,6 @@ "com.amazonaws.costexplorer#GetRightsizingRecommendationRequest": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", - "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results that you want to retrieve.

" - } - }, "Service": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { @@ -1973,12 +2774,6 @@ "smithy.api#required": {} } }, - "Configuration": { - "target": "com.amazonaws.costexplorer#RightsizingRecommendationConfiguration", - "traits": { - "smithy.api#documentation": "

Enables you to customize recommendations across two attributes. You can choose to view\n recommendations for instances within the same instance families or across different instance\n families. You can also choose to view your estimated savings associated with recommendations\n with consideration of existing Savings Plans or RI benefits, or\n neither.

" - } - }, "Filter": { "target": "com.amazonaws.costexplorer#Expression" }, @@ -1987,18 +2782,24 @@ "traits": { "smithy.api#documentation": "

The number of recommendations that you want returned in a single response object.

" } + }, + "Configuration": { + "target": "com.amazonaws.costexplorer#RightsizingRecommendationConfiguration", + "traits": { + "smithy.api#documentation": "

Enables you to customize recommendations across two attributes. You can choose to view\n recommendations for instances within the same instance families or across different instance\n families. You can also choose to view your estimated savings associated with recommendations\n with consideration of existing Savings Plans or RI benefits, or\n neither.

" + } + }, + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results that you want to retrieve.

" + } } } }, "com.amazonaws.costexplorer#GetRightsizingRecommendationResponse": { "type": "structure", "members": { - "RightsizingRecommendations": { - "target": "com.amazonaws.costexplorer#RightsizingRecommendationList", - "traits": { - "smithy.api#documentation": "

Recommendations to rightsize resources.

" - } - }, "Metadata": { "target": "com.amazonaws.costexplorer#RightsizingRecommendationMetadata", "traits": { @@ -2017,6 +2818,12 @@ "smithy.api#documentation": "

The token to retrieve the next set of results.

" } }, + "RightsizingRecommendations": { + "target": "com.amazonaws.costexplorer#RightsizingRecommendationList", + "traits": { + "smithy.api#documentation": "

Recommendations to rightsize resources.

" + } + }, "Configuration": { "target": "com.amazonaws.costexplorer#RightsizingRecommendationConfiguration", "traits": { @@ -2056,6 +2863,12 @@ "com.amazonaws.costexplorer#GetSavingsPlansCoverageRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + } + }, "TimePeriod": { "target": "com.amazonaws.costexplorer#DateInterval", "traits": { @@ -2063,16 +2876,16 @@ "smithy.api#required": {} } }, - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", + "Metrics": { + "target": "com.amazonaws.costexplorer#MetricNames", "traits": { - "smithy.api#documentation": "

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

\n \n

\n GetSavingsPlansCoverage uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

\n

Cost category is also supported.

" + "smithy.api#documentation": "

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

" } }, - "NextToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

\n \n

\n GetSavingsPlansCoverage uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

\n

Cost category is also supported.

" } }, "MaxResults": { @@ -2082,41 +2895,35 @@ "smithy.api#documentation": "

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

" } }, - "GroupBy": { - "target": "com.amazonaws.costexplorer#GroupDefinitions", - "traits": { - "smithy.api#documentation": "

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

" - } - }, - "Metrics": { - "target": "com.amazonaws.costexplorer#MetricNames", - "traits": { - "smithy.api#documentation": "

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

" - } - }, "Granularity": { "target": "com.amazonaws.costexplorer#Granularity", "traits": { "smithy.api#documentation": "

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

\n\t

The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

" } + }, + "GroupBy": { + "target": "com.amazonaws.costexplorer#GroupDefinitions", + "traits": { + "smithy.api#documentation": "

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

" + } } } }, "com.amazonaws.costexplorer#GetSavingsPlansCoverageResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + } + }, "SavingsPlansCoverages": { "target": "com.amazonaws.costexplorer#SavingsPlansCoverages", "traits": { "smithy.api#documentation": "

The amount of spend that your Savings Plans covered.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" - } } } }, @@ -2143,23 +2950,24 @@ "com.amazonaws.costexplorer#GetSavingsPlansPurchaseRecommendationRequest": { "type": "structure", "members": { - "TermInYears": { - "target": "com.amazonaws.costexplorer#TermInYears", + "LookbackPeriodInDays": { + "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The savings plan recommendation term used to\n generate these\n recommendations.

", + "smithy.api#documentation": "

The lookback period used to generate the recommendation.

", "smithy.api#required": {} } }, - "AccountScope": { - "target": "com.amazonaws.costexplorer#AccountScope", + "SavingsPlansType": { + "target": "com.amazonaws.costexplorer#SupportedSavingsPlansType", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual linked accounts only.

" + "smithy.api#documentation": "

The Savings Plans recommendation type requested.

", + "smithy.api#required": {} } }, - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", + "AccountScope": { + "target": "com.amazonaws.costexplorer#AccountScope", "traits": { - "smithy.api#documentation": "

You can filter your recommendations by Account ID with the LINKED_ACCOUNT\n dimension. To filter your recommendations by Account ID, specify Key as\n LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) for\n which you want to see Savings Plans purchase recommendations.

\n

For GetSavingsPlansPurchaseRecommendation, the Filter does not include\n CostCategories or Tags. It only includes Dimensions.\n With Dimensions, Key must be LINKED_ACCOUNT and\n Value can be a single Account ID or multiple comma-separated Account IDs for\n which you want to see Savings Plans Purchase Recommendations. AND and\n OR operators are not supported.

" + "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the master account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

" } }, "PaymentOption": { @@ -2169,29 +2977,28 @@ "smithy.api#required": {} } }, - "PageSize": { - "target": "com.amazonaws.costexplorer#NonNegativeInteger", - "traits": { - "smithy.api#documentation": "

The number of recommendations that you want returned in a single response object.

" - } - }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } }, - "SavingsPlansType": { - "target": "com.amazonaws.costexplorer#SupportedSavingsPlansType", + "PageSize": { + "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The Savings Plans recommendation type requested.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of recommendations that you want returned in a single response object.

" } }, - "LookbackPeriodInDays": { - "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The lookback period used to generate the recommendation.

", + "smithy.api#documentation": "

You can filter your recommendations by Account ID with the LINKED_ACCOUNT\n dimension. To filter your recommendations by Account ID, specify Key as\n LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) for\n which you want to see Savings Plans purchase recommendations.

\n

For GetSavingsPlansPurchaseRecommendation, the Filter does not include\n CostCategories or Tags. It only includes Dimensions.\n With Dimensions, Key must be LINKED_ACCOUNT and\n Value can be a single Account ID or multiple comma-separated Account IDs for\n which you want to see Savings Plans Purchase Recommendations. AND and\n OR operators are not supported.

" + } + }, + "TermInYears": { + "target": "com.amazonaws.costexplorer#TermInYears", + "traits": { + "smithy.api#documentation": "

The savings plan recommendation term used to\n generate these\n recommendations.

", "smithy.api#required": {} } } @@ -2200,6 +3007,12 @@ "com.amazonaws.costexplorer#GetSavingsPlansPurchaseRecommendationResponse": { "type": "structure", "members": { + "Metadata": { + "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationMetadata", + "traits": { + "smithy.api#documentation": "

Information regarding this specific recommendation set.

" + } + }, "SavingsPlansPurchaseRecommendation": { "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendation", "traits": { @@ -2211,12 +3024,6 @@ "traits": { "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } - }, - "Metadata": { - "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationMetadata", - "traits": { - "smithy.api#documentation": "

Information regarding this specific recommendation set.

" - } } } }, @@ -2237,7 +3044,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Master accounts in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

\n\t \n

You cannot group by any dimension values for GetSavingsPlansUtilization.

\n " + "smithy.api#documentation": "

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Master account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

\n\t \n

You cannot group by any dimension values for GetSavingsPlansUtilization.

\n " } }, "com.amazonaws.costexplorer#GetSavingsPlansUtilizationDetails": { @@ -2271,13 +3078,6 @@ "com.amazonaws.costexplorer#GetSavingsPlansUtilizationDetailsRequest": { "type": "structure", "members": { - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", - "traits": { - "smithy.api#documentation": "

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

", - "smithy.api#required": {} - } - }, "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { @@ -2291,6 +3091,13 @@ "smithy.api#documentation": "

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

" } }, + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", + "traits": { + "smithy.api#documentation": "

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { @@ -2302,17 +3109,16 @@ "com.amazonaws.costexplorer#GetSavingsPlansUtilizationDetailsResponse": { "type": "structure", "members": { - "SavingsPlansUtilizationDetails": { - "target": "com.amazonaws.costexplorer#SavingsPlansUtilizationDetails", + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

", "smithy.api#required": {} } }, - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "Total": { + "target": "com.amazonaws.costexplorer#SavingsPlansUtilizationAggregates", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

The total Savings Plans utilization, regardless of time period.

" } }, "NextToken": { @@ -2321,10 +3127,11 @@ "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } }, - "Total": { - "target": "com.amazonaws.costexplorer#SavingsPlansUtilizationAggregates", + "SavingsPlansUtilizationDetails": { + "target": "com.amazonaws.costexplorer#SavingsPlansUtilizationDetails", "traits": { - "smithy.api#documentation": "

The total Savings Plans utilization, regardless of time period.

" + "smithy.api#documentation": "

Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

", + "smithy.api#required": {} } } } @@ -2332,10 +3139,11 @@ "com.amazonaws.costexplorer#GetSavingsPlansUtilizationRequest": { "type": "structure", "members": { - "Granularity": { - "target": "com.amazonaws.costexplorer#Granularity", + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

The granularity of the Amazon Web Services utillization data for your Savings Plans.

\n\t

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

" + "smithy.api#documentation": "

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

", + "smithy.api#required": {} } }, "Filter": { @@ -2344,11 +3152,10 @@ "smithy.api#documentation": "

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

\n \n

\n GetSavingsPlansUtilization uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension.

" } }, - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "Granularity": { + "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The granularity of the Amazon Web Services utillization data for your Savings Plans.

\n\t

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

" } } } @@ -2403,16 +3210,10 @@ "com.amazonaws.costexplorer#GetTagsRequest": { "type": "structure", "members": { - "SearchString": { - "target": "com.amazonaws.costexplorer#SearchString", - "traits": { - "smithy.api#documentation": "

The value that you want to search for.

" - } - }, - "TagKey": { - "target": "com.amazonaws.costexplorer#TagKey", + "NextPageToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The key of the tag that you want to return values for.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" } }, "TimePeriod": { @@ -2422,10 +3223,16 @@ "smithy.api#required": {} } }, - "NextPageToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", + "TagKey": { + "target": "com.amazonaws.costexplorer#TagKey", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The key of the tag that you want to return values for.

" + } + }, + "SearchString": { + "target": "com.amazonaws.costexplorer#SearchString", + "traits": { + "smithy.api#documentation": "

The value that you want to search for.

" } } } @@ -2433,13 +3240,6 @@ "com.amazonaws.costexplorer#GetTagsResponse": { "type": "structure", "members": { - "ReturnSize": { - "target": "com.amazonaws.costexplorer#PageSize", - "traits": { - "smithy.api#documentation": "

The number of query results that AWS returns at a time.

", - "smithy.api#required": {} - } - }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { @@ -2453,6 +3253,13 @@ "smithy.api#required": {} } }, + "ReturnSize": { + "target": "com.amazonaws.costexplorer#PageSize", + "traits": { + "smithy.api#documentation": "

The number of query results that AWS returns at a time.

", + "smithy.api#required": {} + } + }, "TotalSize": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { @@ -2488,11 +3295,10 @@ "com.amazonaws.costexplorer#GetUsageForecastRequest": { "type": "structure", "members": { - "Granularity": { - "target": "com.amazonaws.costexplorer#Granularity", + "Filter": { + "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

\n\t\t

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

" } }, "Metric": { @@ -2502,41 +3308,42 @@ "smithy.api#required": {} } }, + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", + "traits": { + "smithy.api#documentation": "

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n\t\t retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

", + "smithy.api#required": {} + } + }, "PredictionIntervalLevel": { "target": "com.amazonaws.costexplorer#PredictionIntervalLevel", "traits": { "smithy.api#documentation": "

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean \n\t\t\tby specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value \n\t\t\tfalling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" } }, - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "Granularity": { + "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

", + "smithy.api#documentation": "

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

\n\t\t

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

", "smithy.api#required": {} } - }, - "Filter": { - "target": "com.amazonaws.costexplorer#Expression", - "traits": { - "smithy.api#documentation": "

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

" - } } } }, "com.amazonaws.costexplorer#GetUsageForecastResponse": { "type": "structure", "members": { - "ForecastResultsByTime": { - "target": "com.amazonaws.costexplorer#ForecastResultsByTime", - "traits": { - "smithy.api#documentation": "

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, \n\t\t\tthis is a list of months.

" - } - }, "Total": { "target": "com.amazonaws.costexplorer#MetricValue", "traits": { "smithy.api#documentation": "

How much you're forecasted to use over the forecast period.

" } + }, + "ForecastResultsByTime": { + "target": "com.amazonaws.costexplorer#ForecastResultsByTime", + "traits": { + "smithy.api#documentation": "

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, \n\t\t\tthis is a list of months.

" + } } } }, @@ -2562,17 +3369,17 @@ "com.amazonaws.costexplorer#Group": { "type": "structure", "members": { - "Metrics": { - "target": "com.amazonaws.costexplorer#Metrics", - "traits": { - "smithy.api#documentation": "

The metrics that are included in this group.

" - } - }, "Keys": { "target": "com.amazonaws.costexplorer#Keys", "traits": { "smithy.api#documentation": "

The keys that are included in this group.

" } + }, + "Metrics": { + "target": "com.amazonaws.costexplorer#Metrics", + "traits": { + "smithy.api#documentation": "

The metrics that are included in this group.

" + } } }, "traits": { @@ -2640,15 +3447,30 @@ "target": "com.amazonaws.costexplorer#Group" } }, - "com.amazonaws.costexplorer#InstanceDetails": { + "com.amazonaws.costexplorer#Impact": { "type": "structure", "members": { - "RDSInstanceDetails": { - "target": "com.amazonaws.costexplorer#RDSInstanceDetails", + "MaxImpact": { + "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { - "smithy.api#documentation": "

The Amazon RDS instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

\n The maximum dollar value observed for an anomaly.\n

", + "smithy.api#required": {} } }, + "TotalImpact": { + "target": "com.amazonaws.costexplorer#GenericDouble", + "traits": { + "smithy.api#documentation": "

\n The cumulative dollar value observed for an anomaly.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The anomaly's dollar value.\n

" + } + }, + "com.amazonaws.costexplorer#InstanceDetails": { + "type": "structure", + "members": { "EC2InstanceDetails": { "target": "com.amazonaws.costexplorer#EC2InstanceDetails", "traits": { @@ -2672,6 +3494,12 @@ "traits": { "smithy.api#documentation": "

The ElastiCache instances that AWS recommends that you purchase.

" } + }, + "RDSInstanceDetails": { + "target": "com.amazonaws.costexplorer#RDSInstanceDetails", + "traits": { + "smithy.api#documentation": "

The Amazon RDS instances that AWS recommends that you purchase.

" + } } }, "traits": { @@ -2736,6 +3564,13 @@ "com.amazonaws.costexplorer#ListCostCategoryDefinitionsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.costexplorer#CostCategoryMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The number of entries a paginated response contains.

" + } + }, "NextToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { @@ -2747,30 +3582,23 @@ "traits": { "smithy.api#documentation": "

\n The date when the Cost Category was effective.\n

" } - }, - "MaxResults": { - "target": "com.amazonaws.costexplorer#CostCategoryMaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The number of entries a paginated response contains.

" - } } } }, "com.amazonaws.costexplorer#ListCostCategoryDefinitionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.costexplorer#NextPageToken", - "traits": { - "smithy.api#documentation": "

\n The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.\n

" - } - }, "CostCategoryReferences": { "target": "com.amazonaws.costexplorer#CostCategoryReferencesList", "traits": { "smithy.api#documentation": "

\n A reference to a Cost Category containing enough information to identify the Cost Category.\n

" } + }, + "NextToken": { + "target": "com.amazonaws.costexplorer#NextPageToken", + "traits": { + "smithy.api#documentation": "

\n The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.\n

" + } } } }, @@ -2898,17 +3726,17 @@ "com.amazonaws.costexplorer#MetricValue": { "type": "structure", "members": { - "Unit": { - "target": "com.amazonaws.costexplorer#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit that the metric is given in.

" - } - }, "Amount": { "target": "com.amazonaws.costexplorer#MetricAmount", "traits": { "smithy.api#documentation": "

The actual number that represents the metric.

" } + }, + "Unit": { + "target": "com.amazonaws.costexplorer#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit that the metric is given in.

" + } } }, "traits": { @@ -2930,7 +3758,7 @@ "TargetInstances": { "target": "com.amazonaws.costexplorer#TargetInstancesList", "traits": { - "smithy.api#documentation": "

Identifies whether this instance type is the Amazon Web Services default recommendation.

" + "smithy.api#documentation": "

Identifies whether this instance type is the AWS default recommendation.

" } } }, @@ -2938,6 +3766,32 @@ "smithy.api#documentation": "

Details on the modification recommendation.

" } }, + "com.amazonaws.costexplorer#MonitorDimension": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SERVICE", + "name": "SERVICE" + } + ] + } + }, + "com.amazonaws.costexplorer#MonitorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DIMENSIONAL", + "name": "DIMENSIONAL" + }, + { + "value": "CUSTOM", + "name": "CUSTOM" + } + ] + } + }, "com.amazonaws.costexplorer#NetRISavings": { "type": "string" }, @@ -2959,6 +3813,46 @@ } } }, + "com.amazonaws.costexplorer#NullableNonNegativeDouble": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0.0 + } + } + }, + "com.amazonaws.costexplorer#NumericOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUAL", + "name": "EQUAL" + }, + { + "value": "GREATER_THAN_OR_EQUAL", + "name": "GREATER_THAN_OR_EQUAL" + }, + { + "value": "LESS_THAN_OR_EQUAL", + "name": "LESS_THAN_OR_EQUAL" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + } + ] + } + }, "com.amazonaws.costexplorer#OfferingClass": { "type": "string", "traits": { @@ -3033,6 +3927,54 @@ } } }, + "com.amazonaws.costexplorer#ProvideAnomalyFeedback": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#ProvideAnomalyFeedbackRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#ProvideAnomalyFeedbackResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the feedback property of a given cost anomaly.

" + } + }, + "com.amazonaws.costexplorer#ProvideAnomalyFeedbackRequest": { + "type": "structure", + "members": { + "AnomalyId": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n A cost anomaly ID.\n

", + "smithy.api#required": {} + } + }, + "Feedback": { + "target": "com.amazonaws.costexplorer#AnomalyFeedbackType", + "traits": { + "smithy.api#documentation": "

Describes whether the cost anomaly was a planned activity or you considered it an anomaly.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#ProvideAnomalyFeedbackResponse": { + "type": "structure", + "members": { + "AnomalyId": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The ID of the modified cost anomaly.\n

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.costexplorer#PurchasedHours": { "type": "string" }, @@ -3042,28 +3984,28 @@ "com.amazonaws.costexplorer#RDSInstanceDetails": { "type": "structure", "members": { - "DeploymentOption": { + "LicenseModel": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a reservation in a single Availability Zone or a\n reservation with a backup in a second Availability Zone.

" + "smithy.api#documentation": "

The license model that the recommended reservation supports.

" } }, - "DatabaseEngine": { - "target": "com.amazonaws.costexplorer#GenericString", + "CurrentGeneration": { + "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

The database engine that the recommended reservation supports.

" + "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" } }, - "Family": { + "DeploymentOption": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The instance family of the recommended reservation.

" + "smithy.api#documentation": "

Whether the recommendation is for a reservation in a single Availability Zone or a\n reservation with a backup in a second Availability Zone.

" } }, - "LicenseModel": { + "Family": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The license model that the recommended reservation supports.

" + "smithy.api#documentation": "

The instance family of the recommended reservation.

" } }, "Region": { @@ -3078,22 +4020,22 @@ "smithy.api#documentation": "

The type of instance that AWS recommends.

" } }, - "SizeFlexEligible": { - "target": "com.amazonaws.costexplorer#GenericBoolean", + "DatabaseEdition": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

The database edition that the recommended reservation supports.

" } }, - "DatabaseEdition": { + "DatabaseEngine": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The database edition that the recommended reservation supports.

" + "smithy.api#documentation": "

The database engine that the recommended reservation supports.

" } }, - "CurrentGeneration": { + "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" } } }, @@ -3119,34 +4061,34 @@ "com.amazonaws.costexplorer#RedshiftInstanceDetails": { "type": "structure", "members": { - "SizeFlexEligible": { - "target": "com.amazonaws.costexplorer#GenericBoolean", + "Region": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" } }, - "NodeType": { + "Family": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of node that AWS recommends.

" + "smithy.api#documentation": "

The instance family of the recommended reservation.

" } }, - "CurrentGeneration": { + "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" } }, - "Region": { + "NodeType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The type of node that AWS recommends.

" } }, - "Family": { - "target": "com.amazonaws.costexplorer#GenericString", + "CurrentGeneration": { + "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

The instance family of the recommended reservation.

" + "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" } } }, @@ -3169,22 +4111,28 @@ "com.amazonaws.costexplorer#ReservationAggregates": { "type": "structure", "members": { - "TotalActualHours": { - "target": "com.amazonaws.costexplorer#TotalActualHours", + "TotalActualUnits": { + "target": "com.amazonaws.costexplorer#TotalActualUnits", "traits": { - "smithy.api#documentation": "

The total number of reservation hours that you used.

" + "smithy.api#documentation": "

The total number of Amazon EC2 reservation hours that you used, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" } }, - "OnDemandCostOfRIHoursUsed": { - "target": "com.amazonaws.costexplorer#OnDemandCostOfRIHoursUsed", + "PurchasedHours": { + "target": "com.amazonaws.costexplorer#PurchasedHours", "traits": { - "smithy.api#documentation": "

How much your reservation would cost if charged On-Demand rates.

" + "smithy.api#documentation": "

How many reservation hours that you purchased.

" } }, - "TotalPotentialRISavings": { - "target": "com.amazonaws.costexplorer#TotalPotentialRISavings", + "UtilizationPercentageInUnits": { + "target": "com.amazonaws.costexplorer#UtilizationPercentageInUnits", + "traits": { + "smithy.api#documentation": "

The percentage of Amazon EC2 reservation time that you used, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" + } + }, + "PurchasedUnits": { + "target": "com.amazonaws.costexplorer#PurchasedUnits", "traits": { - "smithy.api#documentation": "

How much you could save if you use your entire reservation.

" + "smithy.api#documentation": "

How many Amazon EC2 reservation hours that you purchased, converted to normalized units.\n Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" } }, "TotalAmortizedFee": { @@ -3193,46 +4141,46 @@ "smithy.api#documentation": "

The total cost of your reservation, amortized over the reservation\n period.

" } }, - "UnusedUnits": { - "target": "com.amazonaws.costexplorer#UnusedUnits", + "TotalActualHours": { + "target": "com.amazonaws.costexplorer#TotalActualHours", "traits": { - "smithy.api#documentation": "

The number of Amazon EC2 reservation hours that you didn't use, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" + "smithy.api#documentation": "

The total number of reservation hours that you used.

" } }, - "PurchasedUnits": { - "target": "com.amazonaws.costexplorer#PurchasedUnits", + "UnusedHours": { + "target": "com.amazonaws.costexplorer#UnusedHours", "traits": { - "smithy.api#documentation": "

How many Amazon EC2 reservation hours that you purchased, converted to normalized units.\n Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" + "smithy.api#documentation": "

The number of reservation hours that you didn't use.

" } }, - "PurchasedHours": { - "target": "com.amazonaws.costexplorer#PurchasedHours", + "AmortizedUpfrontFee": { + "target": "com.amazonaws.costexplorer#AmortizedUpfrontFee", "traits": { - "smithy.api#documentation": "

How many reservation hours that you purchased.

" + "smithy.api#documentation": "

The upfront cost of your reservation, amortized over the reservation\n period.

" } }, - "UtilizationPercentageInUnits": { - "target": "com.amazonaws.costexplorer#UtilizationPercentageInUnits", + "OnDemandCostOfRIHoursUsed": { + "target": "com.amazonaws.costexplorer#OnDemandCostOfRIHoursUsed", "traits": { - "smithy.api#documentation": "

The percentage of Amazon EC2 reservation time that you used, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" + "smithy.api#documentation": "

How much your reservation would cost if charged On-Demand rates.

" } }, - "TotalActualUnits": { - "target": "com.amazonaws.costexplorer#TotalActualUnits", + "TotalPotentialRISavings": { + "target": "com.amazonaws.costexplorer#TotalPotentialRISavings", "traits": { - "smithy.api#documentation": "

The total number of Amazon EC2 reservation hours that you used, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" + "smithy.api#documentation": "

How much you could save if you use your entire reservation.

" } }, - "AmortizedRecurringFee": { - "target": "com.amazonaws.costexplorer#AmortizedRecurringFee", + "UnusedUnits": { + "target": "com.amazonaws.costexplorer#UnusedUnits", "traits": { - "smithy.api#documentation": "

The monthly cost of your reservation, amortized over the reservation\n period.

" + "smithy.api#documentation": "

The number of Amazon EC2 reservation hours that you didn't use, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" } }, - "UnusedHours": { - "target": "com.amazonaws.costexplorer#UnusedHours", + "AmortizedRecurringFee": { + "target": "com.amazonaws.costexplorer#AmortizedRecurringFee", "traits": { - "smithy.api#documentation": "

The number of reservation hours that you didn't use.

" + "smithy.api#documentation": "

The monthly cost of your reservation, amortized over the reservation\n period.

" } }, "NetRISavings": { @@ -3246,12 +4194,6 @@ "traits": { "smithy.api#documentation": "

The percentage of reservation time that you used.

" } - }, - "AmortizedUpfrontFee": { - "target": "com.amazonaws.costexplorer#AmortizedUpfrontFee", - "traits": { - "smithy.api#documentation": "

The upfront cost of your reservation, amortized over the reservation\n period.

" - } } }, "traits": { @@ -3261,17 +4203,17 @@ "com.amazonaws.costexplorer#ReservationCoverageGroup": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.costexplorer#Attributes", - "traits": { - "smithy.api#documentation": "

The attributes for this group of reservations.

" - } - }, "Coverage": { "target": "com.amazonaws.costexplorer#Coverage", "traits": { "smithy.api#documentation": "

How much instance usage this group of reservations covered.

" } + }, + "Attributes": { + "target": "com.amazonaws.costexplorer#Attributes", + "traits": { + "smithy.api#documentation": "

The attributes for this group of reservations.

" + } } }, "traits": { @@ -3293,34 +4235,22 @@ "com.amazonaws.costexplorer#ReservationPurchaseRecommendation": { "type": "structure", "members": { - "TermInYears": { - "target": "com.amazonaws.costexplorer#TermInYears", - "traits": { - "smithy.api#documentation": "

The term of the reservation that you want recommendations for, in years.

" - } - }, "ServiceSpecification": { "target": "com.amazonaws.costexplorer#ServiceSpecification", "traits": { "smithy.api#documentation": "

Hardware specifications for the service that you want recommendations\n for.

" } }, - "RecommendationSummary": { - "target": "com.amazonaws.costexplorer#ReservationPurchaseRecommendationSummary", - "traits": { - "smithy.api#documentation": "

A summary about the recommended purchase.

" - } - }, "RecommendationDetails": { "target": "com.amazonaws.costexplorer#ReservationPurchaseRecommendationDetails", "traits": { "smithy.api#documentation": "

Details about the recommended purchases.

" } }, - "AccountScope": { - "target": "com.amazonaws.costexplorer#AccountScope", + "LookbackPeriodInDays": { + "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The account scope that AWS recommends that you purchase this instance for. For\n example, you can purchase this reservation for an entire organization in AWS\n Organizations.

" + "smithy.api#documentation": "

How many days of previous usage that AWS considers when making this\n recommendation.

" } }, "PaymentOption": { @@ -3329,10 +4259,22 @@ "smithy.api#documentation": "

The payment option for the reservation. For example, AllUpfront or\n NoUpfront.

" } }, - "LookbackPeriodInDays": { - "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", + "TermInYears": { + "target": "com.amazonaws.costexplorer#TermInYears", "traits": { - "smithy.api#documentation": "

How many days of previous usage that AWS considers when making this\n recommendation.

" + "smithy.api#documentation": "

The term of the reservation that you want recommendations for, in years.

" + } + }, + "AccountScope": { + "target": "com.amazonaws.costexplorer#AccountScope", + "traits": { + "smithy.api#documentation": "

The account scope that AWS recommends that you purchase this instance for. For\n example, you can purchase this reservation for an entire organization in AWS\n Organizations.

" + } + }, + "RecommendationSummary": { + "target": "com.amazonaws.costexplorer#ReservationPurchaseRecommendationSummary", + "traits": { + "smithy.api#documentation": "

A summary about the recommended purchase.

" } } }, @@ -3343,100 +4285,100 @@ "com.amazonaws.costexplorer#ReservationPurchaseRecommendationDetail": { "type": "structure", "members": { - "MinimumNormalizedUnitsUsedPerHour": { + "AverageNormalizedUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The minimum number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" + "smithy.api#documentation": "

The average number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" } }, - "EstimatedMonthlySavingsPercentage": { + "AverageNumberOfInstancesUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that this specific recommendation could save you in a month,\n as a percentage of your overall costs.

" + "smithy.api#documentation": "

The average number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" } }, - "RecommendedNormalizedUnitsToPurchase": { + "EstimatedMonthlyOnDemandCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of normalized units that AWS recommends that you purchase.

" + "smithy.api#documentation": "

How much AWS estimates that you spend on On-Demand Instances in a month.

" } }, - "RecurringStandardMonthlyCost": { + "UpfrontCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much purchasing this instance costs you on a monthly basis.

" + "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" } }, - "AverageUtilization": { + "AccountId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average utilization of your instances. AWS uses this to calculate your\n recommended reservation purchases.

" + "smithy.api#documentation": "

The account that this RI recommendation is for.

" } }, - "MaximumNumberOfInstancesUsedPerHour": { + "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" + "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" } }, - "MaximumNormalizedUnitsUsedPerHour": { + "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" + "smithy.api#documentation": "

How much AWS estimates that this specific recommendation could save you in a\n month.

" } }, - "CurrencyCode": { + "EstimatedReservationCostForLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" + "smithy.api#documentation": "

How much AWS estimates that you would have spent for all usage during the specified\n historical period if you had\n a\n reservation.

" } }, - "EstimatedMonthlySavingsAmount": { + "MinimumNumberOfInstancesUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that this specific recommendation could save you in a\n month.

" + "smithy.api#documentation": "

The minimum number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" } }, - "AverageNumberOfInstancesUsedPerHour": { + "MaximumNumberOfInstancesUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" + "smithy.api#documentation": "

The maximum number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" } }, - "EstimatedMonthlyOnDemandCost": { + "RecommendedNormalizedUnitsToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that you spend on On-Demand Instances in a month.

" + "smithy.api#documentation": "

The number of normalized units that AWS recommends that you purchase.

" } }, - "AccountId": { + "RecommendedNumberOfInstancesToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The account that this RI recommendation is for.

" + "smithy.api#documentation": "

The number of instances that AWS recommends that you purchase.

" } }, - "RecommendedNumberOfInstancesToPurchase": { + "MinimumNormalizedUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The minimum number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" } }, - "MinimumNumberOfInstancesUsedPerHour": { + "AverageUtilization": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The minimum number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" + "smithy.api#documentation": "

The average utilization of your instances. AWS uses this to calculate your\n recommended reservation purchases.

" } }, - "EstimatedReservationCostForLookbackPeriod": { + "RecurringStandardMonthlyCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that you would have spent for all usage during the specified\n historical period if you had\n a\n reservation.

" + "smithy.api#documentation": "

How much purchasing this instance costs you on a monthly basis.

" } }, - "EstimatedBreakEvenInMonths": { + "MaximumNormalizedUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How long AWS estimates that it takes for this instance to start saving you money,\n in months.

" + "smithy.api#documentation": "

The maximum number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" } }, "InstanceDetails": { @@ -3445,16 +4387,16 @@ "smithy.api#documentation": "

Details about the instances that AWS recommends that you purchase.

" } }, - "UpfrontCost": { + "EstimatedMonthlySavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much purchasing this instance costs you upfront.

" + "smithy.api#documentation": "

How much AWS estimates that this specific recommendation could save you in a month,\n as a percentage of your overall costs.

" } }, - "AverageNormalizedUnitsUsedPerHour": { + "EstimatedBreakEvenInMonths": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" + "smithy.api#documentation": "

How long AWS estimates that it takes for this instance to start saving you money,\n in months.

" } } }, @@ -3471,16 +4413,16 @@ "com.amazonaws.costexplorer#ReservationPurchaseRecommendationMetadata": { "type": "structure", "members": { - "RecommendationId": { + "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The ID for this specific recommendation.

" + "smithy.api#documentation": "

The timestamp for when AWS made this recommendation.

" } }, - "GenerationTimestamp": { + "RecommendationId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The timestamp for when AWS made this recommendation.

" + "smithy.api#documentation": "

The ID for this specific recommendation.

" } } }, @@ -3491,10 +4433,10 @@ "com.amazonaws.costexplorer#ReservationPurchaseRecommendationSummary": { "type": "structure", "members": { - "CurrencyCode": { + "TotalEstimatedMonthlySavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code used for this recommendation.

" + "smithy.api#documentation": "

The total amount that AWS estimates that this recommendation could save you in a\n month, as a percentage of your costs.

" } }, "TotalEstimatedMonthlySavingsAmount": { @@ -3503,10 +4445,10 @@ "smithy.api#documentation": "

The total amount that AWS estimates that this recommendation could save you in a\n month.

" } }, - "TotalEstimatedMonthlySavingsPercentage": { + "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total amount that AWS estimates that this recommendation could save you in a\n month, as a percentage of your costs.

" + "smithy.api#documentation": "

The currency code used for this recommendation.

" } } }, @@ -3523,18 +4465,6 @@ "com.amazonaws.costexplorer#ReservationUtilizationGroup": { "type": "structure", "members": { - "Utilization": { - "target": "com.amazonaws.costexplorer#ReservationAggregates", - "traits": { - "smithy.api#documentation": "

How much you used this group of reservations.

" - } - }, - "Key": { - "target": "com.amazonaws.costexplorer#ReservationGroupKey", - "traits": { - "smithy.api#documentation": "

The key for a specific reservation attribute.

" - } - }, "Value": { "target": "com.amazonaws.costexplorer#ReservationGroupValue", "traits": { @@ -3546,6 +4476,18 @@ "traits": { "smithy.api#documentation": "

The attributes for this group of reservations.

" } + }, + "Utilization": { + "target": "com.amazonaws.costexplorer#ReservationAggregates", + "traits": { + "smithy.api#documentation": "

How much you used this group of reservations.

" + } + }, + "Key": { + "target": "com.amazonaws.costexplorer#ReservationGroupKey", + "traits": { + "smithy.api#documentation": "

The key for a specific reservation attribute.

" + } } }, "traits": { @@ -3597,7 +4539,7 @@ "EC2ResourceUtilization": { "target": "com.amazonaws.costexplorer#EC2ResourceUtilization", "traits": { - "smithy.api#documentation": "

Utilization of current Amazon EC2 Instance

" + "smithy.api#documentation": "

Utilization of current Amazon EC2 instance.

" } } }, @@ -3608,12 +4550,6 @@ "com.amazonaws.costexplorer#ResultByTime": { "type": "structure", "members": { - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", - "traits": { - "smithy.api#documentation": "

The time period that the result covers.

" - } - }, "Total": { "target": "com.amazonaws.costexplorer#Metrics", "traits": { @@ -3626,6 +4562,12 @@ "smithy.api#documentation": "

The groups that this time period includes.

" } }, + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", + "traits": { + "smithy.api#documentation": "

The time period that the result covers.

" + } + }, "Estimated": { "target": "com.amazonaws.costexplorer#Estimated", "traits": { @@ -3646,16 +4588,22 @@ "com.amazonaws.costexplorer#RightsizingRecommendation": { "type": "structure", "members": { + "RightsizingType": { + "target": "com.amazonaws.costexplorer#RightsizingType", + "traits": { + "smithy.api#documentation": "

Recommendation to either terminate or modify the resource.

" + } + }, "TerminateRecommendationDetail": { "target": "com.amazonaws.costexplorer#TerminateRecommendationDetail", "traits": { "smithy.api#documentation": "

Details for termination recommendations.

" } }, - "RightsizingType": { - "target": "com.amazonaws.costexplorer#RightsizingType", + "AccountId": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Recommendation to either terminate or modify the resource.

" + "smithy.api#documentation": "

The account that this recommendation is for.

" } }, "CurrentInstance": { @@ -3669,12 +4617,6 @@ "traits": { "smithy.api#documentation": "

Details for modification recommendations.

" } - }, - "AccountId": { - "target": "com.amazonaws.costexplorer#GenericString", - "traits": { - "smithy.api#documentation": "

The account that this recommendation is for.

" - } } }, "traits": { @@ -3684,17 +4626,17 @@ "com.amazonaws.costexplorer#RightsizingRecommendationConfiguration": { "type": "structure", "members": { - "BenefitsConsidered": { - "target": "com.amazonaws.costexplorer#GenericBoolean", + "RecommendationTarget": { + "target": "com.amazonaws.costexplorer#RecommendationTarget", "traits": { - "smithy.api#documentation": "

\n The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE.\n

", + "smithy.api#documentation": "

\n The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY.\n

", "smithy.api#required": {} } }, - "RecommendationTarget": { - "target": "com.amazonaws.costexplorer#RecommendationTarget", + "BenefitsConsidered": { + "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

\n The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY.\n

", + "smithy.api#documentation": "

\n The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE.\n

", "smithy.api#required": {} } } @@ -3712,22 +4654,22 @@ "com.amazonaws.costexplorer#RightsizingRecommendationMetadata": { "type": "structure", "members": { - "RecommendationId": { - "target": "com.amazonaws.costexplorer#GenericString", + "LookbackPeriodInDays": { + "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The ID for this specific recommendation.

" + "smithy.api#documentation": "

How many days of previous usage that AWS considers when making this\n recommendation.

" } }, - "LookbackPeriodInDays": { - "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", + "RecommendationId": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How many days of previous usage that Amazon Web Services considers when making this recommendation.

" + "smithy.api#documentation": "

The ID for this specific recommendation.

" } }, "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The timestamp\n for when Amazon Web Services made this recommendation.

" + "smithy.api#documentation": "

The timestamp for when AWS made this recommendation.

" } } }, @@ -3738,28 +4680,28 @@ "com.amazonaws.costexplorer#RightsizingRecommendationSummary": { "type": "structure", "members": { - "EstimatedTotalMonthlySavingsAmount": { + "TotalRecommendationCount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Estimated total savings resulting from modifications, on a monthly basis.

" + "smithy.api#documentation": "

Total number of instance recommendations.

" } }, - "TotalRecommendationCount": { + "SavingsCurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Total number of instance recommendations.

" + "smithy.api#documentation": "

The currency code that AWS used to calculate the savings.

" } }, - "SavingsPercentage": { + "EstimatedTotalMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Savings percentage based on the recommended modifications, relative to the total\n On-Demand\n costs associated with these instances.

" + "smithy.api#documentation": "

Estimated total savings resulting from modifications, on a monthly basis.

" } }, - "SavingsCurrencyCode": { + "SavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the savings.

" + "smithy.api#documentation": "

Savings percentage based on the recommended modifications, relative to the total\n On-Demand\n costs associated with these instances.

" } } }, @@ -3782,22 +4724,60 @@ ] } }, + "com.amazonaws.costexplorer#RootCause": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The AWS service name associated with the cost anomaly.\n

" + } + }, + "LinkedAccount": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The linked account value associated with the cost anomaly.\n

" + } + }, + "UsageType": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The UsageType value associated with the cost anomaly.\n

" + } + }, + "Region": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The AWS Region associated with the cost anomaly.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The combination of AWS service, linked account, Region, and usage type where a cost anomaly is observed.\n

" + } + }, + "com.amazonaws.costexplorer#RootCauses": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#RootCause" + } + }, "com.amazonaws.costexplorer#SavingsPlanArn": { "type": "string" }, "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment": { "type": "structure", "members": { - "AmortizedUpfrontCommitment": { + "AmortizedRecurringCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

" + "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront.

" } }, - "AmortizedRecurringCommitment": { + "AmortizedUpfrontCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront.

" + "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

" } }, "TotalAmortizedCommitment": { @@ -3837,28 +4817,28 @@ "com.amazonaws.costexplorer#SavingsPlansCoverageData": { "type": "structure", "members": { - "SpendCoveredBySavingsPlans": { + "OnDemandCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amount of your Amazon Web Services usage that is covered by a Savings Plans.

" + "smithy.api#documentation": "

The cost of your AWS usage at the public On-Demand rate.

" } }, - "CoveragePercentage": { + "SpendCoveredBySavingsPlans": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The percentage of your existing Savings Plans covered usage, divided by all of your\n eligible Savings Plans usage in an account(or set of accounts).

" + "smithy.api#documentation": "

The amount of your AWS usage that is covered by a Savings Plans.

" } }, - "OnDemandCost": { + "CoveragePercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The cost of your Amazon Web Services usage at the public On-Demand rate.

" + "smithy.api#documentation": "

The percentage of your existing Savings Plans covered usage, divided by all of your\n eligible Savings Plans usage in an account(or set of accounts).

" } }, "TotalCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total cost of your Amazon Web Services usage, regardless of your purchase option.

" + "smithy.api#documentation": "

The total cost of your AWS usage, regardless of your purchase option.

" } } }, @@ -3875,22 +4855,22 @@ "com.amazonaws.costexplorer#SavingsPlansDetails": { "type": "structure", "members": { - "Region": { + "OfferingId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

A collection of AWS resources in a geographic area. Each AWS Region is isolated and independent of the other Regions.

" + "smithy.api#documentation": "

The unique ID used to distinguish Savings Plans from one another.

" } }, - "InstanceFamily": { + "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

A group of instance types that Savings Plans applies to.

" + "smithy.api#documentation": "

A collection of AWS resources in a geographic area. Each AWS Region is isolated and independent of the other Regions.

" } }, - "OfferingId": { + "InstanceFamily": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The unique ID used to distinguish Savings Plans from one another.

" + "smithy.api#documentation": "

A group of instance types that Savings Plans applies to.

" } } }, @@ -3901,16 +4881,28 @@ "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendation": { "type": "structure", "members": { + "PaymentOption": { + "target": "com.amazonaws.costexplorer#PaymentOption", + "traits": { + "smithy.api#documentation": "

The payment option used to generate the recommendation.

" + } + }, + "TermInYears": { + "target": "com.amazonaws.costexplorer#TermInYears", + "traits": { + "smithy.api#documentation": "

The Savings Plans recommendation term in years, used to generate the recommendation.

" + } + }, "SavingsPlansPurchaseRecommendationSummary": { "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationSummary", "traits": { "smithy.api#documentation": "

Summary metrics for your Savings Plans Recommendations.

" } }, - "SavingsPlansType": { - "target": "com.amazonaws.costexplorer#SupportedSavingsPlansType", + "SavingsPlansPurchaseRecommendationDetails": { + "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationDetailList", "traits": { - "smithy.api#documentation": "

The requested Savings Plans recommendation type.

" + "smithy.api#documentation": "

Details for the Savings Plans we recommend that you purchase to cover existing Savings\n Plans eligible workloads.

" } }, "LookbackPeriodInDays": { @@ -3919,28 +4911,16 @@ "smithy.api#documentation": "

The lookback period in days, used to generate the recommendation.

" } }, - "PaymentOption": { - "target": "com.amazonaws.costexplorer#PaymentOption", + "SavingsPlansType": { + "target": "com.amazonaws.costexplorer#SupportedSavingsPlansType", "traits": { - "smithy.api#documentation": "

The payment option used to generate the recommendation.

" + "smithy.api#documentation": "

The requested Savings Plans recommendation type.

" } }, "AccountScope": { "target": "com.amazonaws.costexplorer#AccountScope", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual linked accounts only.

" - } - }, - "SavingsPlansPurchaseRecommendationDetails": { - "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationDetailList", - "traits": { - "smithy.api#documentation": "

Details for the Savings Plans we recommend that you purchase to cover existing Savings\n Plans eligible workloads.

" - } - }, - "TermInYears": { - "target": "com.amazonaws.costexplorer#TermInYears", - "traits": { - "smithy.api#documentation": "

The Savings Plans recommendation term in years, used to generate the recommendation.

" + "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the master account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

" } } }, @@ -3951,22 +4931,22 @@ "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationDetail": { "type": "structure", "members": { - "EstimatedOnDemandCost": { + "CurrentMaximumHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.

" + "smithy.api#documentation": "

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" } }, - "SavingsPlansDetails": { - "target": "com.amazonaws.costexplorer#SavingsPlansDetails", + "CurrentMinimumHourlyOnDemandSpend": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Details for your recommended Savings Plans.

" + "smithy.api#documentation": "

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" } }, - "EstimatedSavingsPercentage": { + "EstimatedOnDemandCostWithCurrentCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

" + "smithy.api#documentation": "

\n The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.\n

" } }, "EstimatedSPCost": { @@ -3975,28 +4955,22 @@ "smithy.api#documentation": "

The cost of the recommended Savings Plans over the length of the lookback period.

" } }, - "EstimatedMonthlySavingsAmount": { - "target": "com.amazonaws.costexplorer#GenericString", - "traits": { - "smithy.api#documentation": "

The estimated monthly savings amount, based on the recommended Savings Plans.

" - } - }, - "CurrentMaximumHourlyOnDemandSpend": { + "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + "smithy.api#documentation": "

The currency code AWS used to generate the recommendations and present potential\n savings.

" } }, - "CurrentMinimumHourlyOnDemandSpend": { + "EstimatedSavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + "smithy.api#documentation": "

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

" } }, - "EstimatedSavingsAmount": { + "EstimatedROI": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated savings amount based on the recommended Savings Plans over the length of the lookback period.

" + "smithy.api#documentation": "

The estimated return on investment based on the recommended Savings Plans purchased. This is calculated as estimatedSavingsAmount/ estimatedSPCost*100.

" } }, "AccountId": { @@ -4005,34 +4979,34 @@ "smithy.api#documentation": "

The AccountID the recommendation is generated for.

" } }, - "EstimatedROI": { + "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated return on investment based on the recommended Savings Plans purchased. This is calculated as estimatedSavingsAmount/ estimatedSPCost*100.

" + "smithy.api#documentation": "

The estimated monthly savings amount, based on the recommended Savings Plans.

" } }, - "CurrencyCode": { + "CurrentAverageHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code Amazon Web Services used to generate the recommendations and present potential savings.

" + "smithy.api#documentation": "

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

" } }, - "HourlyCommitmentToPurchase": { + "EstimatedOnDemandCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The recommended hourly commitment level for the Savings Plans type, and configuration based on the usage during the lookback period.

" + "smithy.api#documentation": "

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.

" } }, - "CurrentAverageHourlyOnDemandSpend": { + "EstimatedSavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + "smithy.api#documentation": "

The estimated savings amount based on the recommended Savings Plans over the length of the lookback period.

" } }, - "UpfrontCost": { - "target": "com.amazonaws.costexplorer#GenericString", + "SavingsPlansDetails": { + "target": "com.amazonaws.costexplorer#SavingsPlansDetails", "traits": { - "smithy.api#documentation": "

The upfront cost of the recommended Savings Plans, based on the selected payment option.

" + "smithy.api#documentation": "

Details for your recommended Savings Plans.

" } }, "EstimatedAverageUtilization": { @@ -4041,10 +5015,16 @@ "smithy.api#documentation": "

The estimated utilization of the recommended Savings Plans.

" } }, - "EstimatedOnDemandCostWithCurrentCommitment": { + "UpfrontCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.\n

" + "smithy.api#documentation": "

The upfront cost of the recommended Savings Plans, based on the selected payment option.

" + } + }, + "HourlyCommitmentToPurchase": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The recommended hourly commitment level for the Savings Plans type, and configuration based on the usage during the lookback period.

" } } }, @@ -4081,46 +5061,46 @@ "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationSummary": { "type": "structure", "members": { - "EstimatedROI": { + "CurrentOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated return on investment based on the recommended Savings Plans and estimated savings.

" + "smithy.api#documentation": "

The current total on demand spend of the applicable usage types over the lookback period.

" } }, - "CurrencyCode": { + "EstimatedSavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code Amazon Web Services used to generate the recommendations and present potential savings.

" + "smithy.api#documentation": "

The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.

" } }, - "EstimatedTotalCost": { + "EstimatedOnDemandCostWithCurrentCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.

" + "smithy.api#documentation": "

\n The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.\n

" } }, - "EstimatedMonthlySavingsAmount": { + "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated monthly savings amount, based on the recommended Savings Plans purchase.

" + "smithy.api#documentation": "

The currency code AWS used to generate the recommendations and present potential\n savings.

" } }, - "CurrentOnDemandSpend": { + "EstimatedSavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The current total on demand spend of the applicable usage types over the lookback period.

" + "smithy.api#documentation": "

The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as estimatedSavingsAmount/ CurrentOnDemandSpend*100.

" } }, - "EstimatedSavingsPercentage": { + "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as estimatedSavingsAmount/ CurrentOnDemandSpend*100.

" + "smithy.api#documentation": "

The estimated monthly savings amount, based on the recommended Savings Plans purchase.

" } }, - "HourlyCommitmentToPurchase": { + "EstimatedTotalCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The recommended hourly commitment based on the recommendation parameters.

" + "smithy.api#documentation": "

The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.

" } }, "DailyCommitmentToPurchase": { @@ -4129,22 +5109,22 @@ "smithy.api#documentation": "

The recommended Savings Plans cost on a daily (24 hourly) basis.

" } }, - "TotalRecommendationCount": { + "EstimatedROI": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The aggregate number of Savings Plans recommendations that exist for your account.

" + "smithy.api#documentation": "

The estimated return on investment based on the recommended Savings Plans and estimated savings.

" } }, - "EstimatedSavingsAmount": { + "TotalRecommendationCount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.

" + "smithy.api#documentation": "

The aggregate number of Savings Plans recommendations that exist for your account.

" } }, - "EstimatedOnDemandCostWithCurrentCommitment": { + "HourlyCommitmentToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.\n

" + "smithy.api#documentation": "

The recommended hourly commitment based on the recommendation parameters.

" } } }, @@ -4155,16 +5135,16 @@ "com.amazonaws.costexplorer#SavingsPlansSavings": { "type": "structure", "members": { - "OnDemandCostEquivalent": { + "NetSavings": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much the amount that the usage would have cost if it was\n accrued\n at the On-Demand rate.

" + "smithy.api#documentation": "

The savings amount that you are accumulating for the usage that is covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

" } }, - "NetSavings": { + "OnDemandCostEquivalent": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The savings amount that you are accumulating for the usage that is covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

" + "smithy.api#documentation": "

How much the amount that the usage would have cost if it was\n accrued\n at the On-Demand rate.

" } } }, @@ -4187,16 +5167,16 @@ "smithy.api#documentation": "

The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.

" } }, - "TotalCommitment": { + "UtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

" + "smithy.api#documentation": "

The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

" } }, - "UtilizationPercentage": { + "TotalCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

" + "smithy.api#documentation": "

The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

" } } }, @@ -4207,18 +5187,18 @@ "com.amazonaws.costexplorer#SavingsPlansUtilizationAggregates": { "type": "structure", "members": { - "AmortizedCommitment": { - "target": "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment", - "traits": { - "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" - } - }, "Savings": { "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" } }, + "AmortizedCommitment": { + "target": "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment", + "traits": { + "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" + } + }, "Utilization": { "target": "com.amazonaws.costexplorer#SavingsPlansUtilization", "traits": { @@ -4234,29 +5214,29 @@ "com.amazonaws.costexplorer#SavingsPlansUtilizationByTime": { "type": "structure", "members": { - "TimePeriod": { - "target": "com.amazonaws.costexplorer#DateInterval", + "Utilization": { + "target": "com.amazonaws.costexplorer#SavingsPlansUtilization", "traits": { + "smithy.api#documentation": "

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

", "smithy.api#required": {} } }, - "AmortizedCommitment": { - "target": "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment", + "Savings": { + "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { - "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" + "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" } }, - "Savings": { - "target": "com.amazonaws.costexplorer#SavingsPlansSavings", + "TimePeriod": { + "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" + "smithy.api#required": {} } }, - "Utilization": { - "target": "com.amazonaws.costexplorer#SavingsPlansUtilization", + "AmortizedCommitment": { + "target": "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment", "traits": { - "smithy.api#documentation": "

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" } } }, @@ -4267,12 +5247,6 @@ "com.amazonaws.costexplorer#SavingsPlansUtilizationDetail": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.costexplorer#Attributes", - "traits": { - "smithy.api#documentation": "

The attribute that applies to a specific Dimension.

" - } - }, "SavingsPlanArn": { "target": "com.amazonaws.costexplorer#SavingsPlanArn", "traits": { @@ -4296,10 +5270,16 @@ "traits": { "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans fees.

" } + }, + "Attributes": { + "target": "com.amazonaws.costexplorer#Attributes", + "traits": { + "smithy.api#documentation": "

The attribute that applies to a specific Dimension.

" + } } }, "traits": { - "smithy.api#documentation": "

A single daily or monthly Savings Plans utilization rate, and details for your account. Master accounts in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

" + "smithy.api#documentation": "

A single daily or monthly Savings Plans utilization rate, and details for your account. A master account in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

" } }, "com.amazonaws.costexplorer#SavingsPlansUtilizationDetails": { @@ -4332,7 +5312,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n You've reached the limit on the number of resources you can create, or exceeded the size of an individual resources.\n

", + "smithy.api#documentation": "

You've reached the limit on the number of resources you can create, or exceeded the\n size of an individual resource.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4351,6 +5331,78 @@ "smithy.api#documentation": "

Hardware specifications for the service that you want recommendations\n for.

" } }, + "com.amazonaws.costexplorer#Subscriber": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.costexplorer#SubscriberStatus", + "traits": { + "smithy.api#documentation": "

Indicates if the subscriber accepts the notifications.

" + } + }, + "Type": { + "target": "com.amazonaws.costexplorer#SubscriberType", + "traits": { + "smithy.api#documentation": "

\n The notification delivery channel.\n

" + } + }, + "Address": { + "target": "com.amazonaws.costexplorer#SubscriberAddress", + "traits": { + "smithy.api#documentation": "

The email address or SNS Amazon Resource Name (ARN), depending on the Type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The recipient of AnomalySubscription notifications.\n

" + } + }, + "com.amazonaws.costexplorer#SubscriberAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 302 + }, + "smithy.api#pattern": "(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+$)" + } + }, + "com.amazonaws.costexplorer#SubscriberStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONFIRMED", + "name": "CONFIRMED" + }, + { + "value": "DECLINED", + "name": "DECLINED" + } + ] + } + }, + "com.amazonaws.costexplorer#SubscriberType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EMAIL", + "name": "EMAIL" + }, + { + "value": "SNS", + "name": "SNS" + } + ] + } + }, + "com.amazonaws.costexplorer#Subscribers": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#Subscriber" + } + }, "com.amazonaws.costexplorer#SupportedSavingsPlansType": { "type": "string", "traits": { @@ -4400,7 +5452,7 @@ "MatchOptions": { "target": "com.amazonaws.costexplorer#MatchOptions", "traits": { - "smithy.api#documentation": "

The match options that you can use to filter your results. MatchOptions is only applicable for only applicable for actions related to Cost Category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

" + "smithy.api#documentation": "

The match options that you can use to filter your results.\n MatchOptions is only applicable for actions related to Cost Category.\n The default values for MatchOptions are EQUALS and\n CASE_SENSITIVE.

" } } }, @@ -4420,13 +5472,13 @@ "DefaultTargetInstance": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Indicates whether or not this recommendation is the defaulted Amazon Web Services recommendation.

" + "smithy.api#documentation": "

Indicates whether this recommendation is the defaulted AWS recommendation.

" } }, - "CurrencyCode": { - "target": "com.amazonaws.costexplorer#GenericString", + "ResourceDetails": { + "target": "com.amazonaws.costexplorer#ResourceDetails", "traits": { - "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this instance.

" + "smithy.api#documentation": "

Details on the target instance type.

" } }, "ExpectedResourceUtilization": { @@ -4435,22 +5487,22 @@ "smithy.api#documentation": "

Expected utilization metrics for target instance type.

" } }, - "ResourceDetails": { - "target": "com.amazonaws.costexplorer#ResourceDetails", + "EstimatedMonthlySavings": { + "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Details on the target instance type.

" + "smithy.api#documentation": "

Estimated savings resulting from modification, on a monthly basis.

" } }, - "EstimatedMonthlyCost": { + "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Expected cost to operate this instance type on a monthly basis.

" + "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" } }, - "EstimatedMonthlySavings": { + "EstimatedMonthlyCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Estimated savings resulting from modification, on a monthly basis.

" + "smithy.api#documentation": "

Expected cost to operate this instance type on a monthly basis.

" } } }, @@ -4482,16 +5534,16 @@ "com.amazonaws.costexplorer#TerminateRecommendationDetail": { "type": "structure", "members": { - "EstimatedMonthlySavings": { + "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Estimated savings resulting from modification, on a monthly basis.

" + "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" } }, - "CurrencyCode": { + "EstimatedMonthlySavings": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this instance.

" + "smithy.api#documentation": "

Estimated savings resulting from modification, on a monthly basis.

" } } }, @@ -4508,6 +5560,34 @@ "com.amazonaws.costexplorer#TotalAmortizedFee": { "type": "string" }, + "com.amazonaws.costexplorer#TotalImpactFilter": { + "type": "structure", + "members": { + "NumericOperator": { + "target": "com.amazonaws.costexplorer#NumericOperator", + "traits": { + "smithy.api#documentation": "

\n The comparing value used in the filter.\n

", + "smithy.api#required": {} + } + }, + "EndValue": { + "target": "com.amazonaws.costexplorer#GenericDouble", + "traits": { + "smithy.api#documentation": "

The upper bound dollar value used in the filter.

" + } + }, + "StartValue": { + "target": "com.amazonaws.costexplorer#GenericDouble", + "traits": { + "smithy.api#documentation": "

\n The lower bound dollar value used in the filter.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Filters cost anomalies based on the total impact.

" + } + }, "com.amazonaws.costexplorer#TotalPotentialRISavings": { "type": "string" }, @@ -4517,6 +5597,32 @@ "com.amazonaws.costexplorer#TotalRunningNormalizedUnits": { "type": "string" }, + "com.amazonaws.costexplorer#UnknownMonitorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.costexplorer#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The cost anomaly monitor does not exist for the account.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.costexplorer#UnknownSubscriptionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.costexplorer#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The cost anomaly subscription does not exist for the account.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.costexplorer#UnresolvableUsageUnitException": { "type": "structure", "members": { @@ -4535,6 +5641,133 @@ "com.amazonaws.costexplorer#UnusedUnits": { "type": "string" }, + "com.amazonaws.costexplorer#UpdateAnomalyMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#UpdateAnomalyMonitorRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#UpdateAnomalyMonitorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + }, + { + "target": "com.amazonaws.costexplorer#UnknownMonitorException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing cost anomaly monitor. The changes made are applied going forward, and\n does not change anomalies detected in the past.

" + } + }, + "com.amazonaws.costexplorer#UpdateAnomalyMonitorRequest": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The new name for the cost anomaly monitor.\n

" + } + }, + "MonitorArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

Cost anomaly monitor Amazon Resource Names (ARNs).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#UpdateAnomalyMonitorResponse": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n A cost anomaly monitor ARN.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#UpdateAnomalySubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#UpdateAnomalySubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#UpdateAnomalySubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + }, + { + "target": "com.amazonaws.costexplorer#UnknownMonitorException" + }, + { + "target": "com.amazonaws.costexplorer#UnknownSubscriptionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing cost anomaly monitor subscription.

" + } + }, + "com.amazonaws.costexplorer#UpdateAnomalySubscriptionRequest": { + "type": "structure", + "members": { + "Subscribers": { + "target": "com.amazonaws.costexplorer#Subscribers", + "traits": { + "smithy.api#documentation": "

\n The update to the subscriber list.\n

" + } + }, + "MonitorArnList": { + "target": "com.amazonaws.costexplorer#Values", + "traits": { + "smithy.api#documentation": "

\n A list of cost anomaly subscription ARNs.\n

" + } + }, + "SubscriptionArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

A cost anomaly subscription Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "Frequency": { + "target": "com.amazonaws.costexplorer#AnomalySubscriptionFrequency", + "traits": { + "smithy.api#documentation": "

\n The update to the frequency value at which subscribers will receive notifications.\n

" + } + }, + "Threshold": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

\n The update to the threshold value for receiving notifications.\n

" + } + }, + "SubscriptionName": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n The subscription's new name.\n

" + } + } + } + }, + "com.amazonaws.costexplorer#UpdateAnomalySubscriptionResponse": { + "type": "structure", + "members": { + "SubscriptionArn": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

\n A cost anomaly subscription ARN.\n

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.costexplorer#UpdateCostCategoryDefinition": { "type": "operation", "input": { @@ -4561,6 +5794,12 @@ "com.amazonaws.costexplorer#UpdateCostCategoryDefinitionRequest": { "type": "structure", "members": { + "RuleVersion": { + "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", + "traits": { + "smithy.api#required": {} + } + }, "Rules": { "target": "com.amazonaws.costexplorer#CostCategoryRulesList", "traits": { @@ -4574,35 +5813,35 @@ "smithy.api#documentation": "

The unique identifier for your Cost Category.

", "smithy.api#required": {} } - }, - "RuleVersion": { - "target": "com.amazonaws.costexplorer#CostCategoryRuleVersion", - "traits": { - "smithy.api#required": {} - } } } }, "com.amazonaws.costexplorer#UpdateCostCategoryDefinitionResponse": { "type": "structure", "members": { - "EffectiveStart": { - "target": "com.amazonaws.costexplorer#ZonedDateTime", - "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective start date.\n

" - } - }, "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" } + }, + "EffectiveStart": { + "target": "com.amazonaws.costexplorer#ZonedDateTime", + "traits": { + "smithy.api#documentation": "

\n The Cost Category's effective start date.\n

" + } } } }, "com.amazonaws.costexplorer#UtilizationByTime": { "type": "structure", "members": { + "Groups": { + "target": "com.amazonaws.costexplorer#ReservationUtilizationGroups", + "traits": { + "smithy.api#documentation": "

The groups that this utilization result uses.

" + } + }, "Total": { "target": "com.amazonaws.costexplorer#ReservationAggregates", "traits": { @@ -4614,12 +5853,6 @@ "traits": { "smithy.api#documentation": "

The period of time that this utilization was used for.

" } - }, - "Groups": { - "target": "com.amazonaws.costexplorer#ReservationUtilizationGroups", - "traits": { - "smithy.api#documentation": "

The groups that this utilization result uses.

" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/data-pipeline.2012-10-29.json b/codegen/sdk-codegen/aws-models/data-pipeline.2012-10-29.json index e9fc7371cbef..068e73406ee0 100644 --- a/codegen/sdk-codegen/aws-models/data-pipeline.2012-10-29.json +++ b/codegen/sdk-codegen/aws-models/data-pipeline.2012-10-29.json @@ -58,6 +58,12 @@ "com.amazonaws.datapipeline#ActivatePipelineInput": { "type": "structure", "members": { + "startTimestamp": { + "target": "com.amazonaws.datapipeline#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

" + } + }, "parameterValues": { "target": "com.amazonaws.datapipeline#ParameterValueList", "traits": { @@ -70,12 +76,6 @@ "smithy.api#documentation": "

The ID of the pipeline.

", "smithy.api#required": {} } - }, - "startTimestamp": { - "target": "com.amazonaws.datapipeline#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

" - } } }, "traits": { @@ -173,13 +173,6 @@ "smithy.api#documentation": "

A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. \n For more information, see Controlling User Access to Pipelines \n in the AWS Data Pipeline Developer Guide.

" } }, - "name": { - "target": "com.amazonaws.datapipeline#id", - "traits": { - "smithy.api#documentation": "

The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

", - "smithy.api#required": {} - } - }, "uniqueId": { "target": "com.amazonaws.datapipeline#id", "traits": { @@ -192,6 +185,13 @@ "traits": { "smithy.api#documentation": "

The description for the pipeline.

" } + }, + "name": { + "target": "com.amazonaws.datapipeline#id", + "traits": { + "smithy.api#documentation": "

The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

", + "smithy.api#required": {} + } } }, "traits": { @@ -280,7 +280,7 @@ "sdkId": "Data Pipeline", "arnNamespace": "datapipeline", "cloudFormationName": "DataPipeline", - "cloudTrailEventSource": "webservice.setl.amazon.com" + "cloudTrailEventSource": "datapipeline.amazonaws.com" }, "aws.auth#sigv4": { "name": "datapipeline" @@ -416,6 +416,18 @@ "com.amazonaws.datapipeline#DescribeObjectsInput": { "type": "structure", "members": { + "evaluateExpressions": { + "target": "com.amazonaws.datapipeline#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

" + } + }, + "marker": { + "target": "com.amazonaws.datapipeline#string", + "traits": { + "smithy.api#documentation": "

The starting point for the results to be returned. For the first call, this value should be empty. \n As long as there are more results, continue to call DescribeObjects with\n the marker value from the previous call to retrieve the next set of results.

" + } + }, "pipelineId": { "target": "com.amazonaws.datapipeline#id", "traits": { @@ -429,18 +441,6 @@ "smithy.api#documentation": "

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

", "smithy.api#required": {} } - }, - "evaluateExpressions": { - "target": "com.amazonaws.datapipeline#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

" - } - }, - "marker": { - "target": "com.amazonaws.datapipeline#string", - "traits": { - "smithy.api#documentation": "

The starting point for the results to be returned. For the first call, this value should be empty. \n As long as there are more results, continue to call DescribeObjects with\n the marker value from the previous call to retrieve the next set of results.

" - } } }, "traits": { @@ -450,6 +450,12 @@ "com.amazonaws.datapipeline#DescribeObjectsOutput": { "type": "structure", "members": { + "hasMoreResults": { + "target": "com.amazonaws.datapipeline#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether there are more results to return.

" + } + }, "marker": { "target": "com.amazonaws.datapipeline#string", "traits": { @@ -462,12 +468,6 @@ "smithy.api#documentation": "

An array of object definitions.

", "smithy.api#required": {} } - }, - "hasMoreResults": { - "target": "com.amazonaws.datapipeline#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether there are more results to return.

" - } } }, "traits": { @@ -606,6 +606,13 @@ "com.amazonaws.datapipeline#Field": { "type": "structure", "members": { + "key": { + "target": "com.amazonaws.datapipeline#fieldNameString", + "traits": { + "smithy.api#documentation": "

The field identifier.

", + "smithy.api#required": {} + } + }, "refValue": { "target": "com.amazonaws.datapipeline#fieldNameString", "traits": { @@ -617,13 +624,6 @@ "traits": { "smithy.api#documentation": "

The field value, expressed as a String.

" } - }, - "key": { - "target": "com.amazonaws.datapipeline#fieldNameString", - "traits": { - "smithy.api#documentation": "

The field identifier.

", - "smithy.api#required": {} - } } }, "traits": { @@ -659,18 +659,18 @@ "com.amazonaws.datapipeline#GetPipelineDefinitionInput": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.datapipeline#string", - "traits": { - "smithy.api#documentation": "

The version of the pipeline definition to retrieve. Set this parameter to latest (default) \n to use the last definition saved to the pipeline or active to use the last definition \n that was activated.

" - } - }, "pipelineId": { "target": "com.amazonaws.datapipeline#id", "traits": { "smithy.api#documentation": "

The ID of the pipeline.

", "smithy.api#required": {} } + }, + "version": { + "target": "com.amazonaws.datapipeline#string", + "traits": { + "smithy.api#documentation": "

The version of the pipeline definition to retrieve. Set this parameter to latest (default) \n to use the last definition saved to the pipeline or active to use the last definition \n that was activated.

" + } } }, "traits": { @@ -680,12 +680,6 @@ "com.amazonaws.datapipeline#GetPipelineDefinitionOutput": { "type": "structure", "members": { - "pipelineObjects": { - "target": "com.amazonaws.datapipeline#PipelineObjectList", - "traits": { - "smithy.api#documentation": "

The objects defined in the pipeline.

" - } - }, "parameterValues": { "target": "com.amazonaws.datapipeline#ParameterValueList", "traits": { @@ -697,6 +691,12 @@ "traits": { "smithy.api#documentation": "

The parameter objects used in the pipeline definition.

" } + }, + "pipelineObjects": { + "target": "com.amazonaws.datapipeline#PipelineObjectList", + "traits": { + "smithy.api#documentation": "

The objects defined in the pipeline.

" + } } }, "traits": { @@ -706,16 +706,16 @@ "com.amazonaws.datapipeline#InstanceIdentity": { "type": "structure", "members": { - "document": { + "signature": { "target": "com.amazonaws.datapipeline#string", "traits": { - "smithy.api#documentation": "

A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.

" + "smithy.api#documentation": "

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

" } }, - "signature": { + "document": { "target": "com.amazonaws.datapipeline#string", "traits": { - "smithy.api#documentation": "

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

" + "smithy.api#documentation": "

A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.

" } } }, @@ -795,6 +795,12 @@ "com.amazonaws.datapipeline#ListPipelinesOutput": { "type": "structure", "members": { + "marker": { + "target": "com.amazonaws.datapipeline#string", + "traits": { + "smithy.api#documentation": "

The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput \n again with this marker value. If the value is null, there are no more results.

" + } + }, "hasMoreResults": { "target": "com.amazonaws.datapipeline#boolean", "traits": { @@ -807,12 +813,6 @@ "smithy.api#documentation": "

The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call \n DescribePipelines and GetPipelineDefinition.

", "smithy.api#required": {} } - }, - "marker": { - "target": "com.amazonaws.datapipeline#string", - "traits": { - "smithy.api#documentation": "

The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput \n again with this marker value. If the value is null, there are no more results.

" - } } }, "traits": { @@ -822,17 +822,17 @@ "com.amazonaws.datapipeline#Operator": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.datapipeline#OperatorType", - "traits": { - "smithy.api#documentation": "

\n The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. \n

\n

The comparison operators EQ and REF_EQ act on the following fields:

\n \n \n

\n The comparison operators GE, LE, and BETWEEN act on the following fields:\n

\n \n

Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".

" - } - }, "values": { "target": "com.amazonaws.datapipeline#stringList", "traits": { "smithy.api#documentation": "

The value that the actual field value will be compared with.

" } + }, + "type": { + "target": "com.amazonaws.datapipeline#OperatorType", + "traits": { + "smithy.api#documentation": "

\n The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. \n

\n

The comparison operators EQ and REF_EQ act on the following fields:

\n \n \n

\n The comparison operators GE, LE, and BETWEEN act on the following fields:\n

\n \n

Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".

" + } } }, "traits": { @@ -897,17 +897,17 @@ "com.amazonaws.datapipeline#ParameterObject": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.datapipeline#fieldNameString", + "attributes": { + "target": "com.amazonaws.datapipeline#ParameterAttributeList", "traits": { - "smithy.api#documentation": "

The ID of the parameter object.

", + "smithy.api#documentation": "

The attributes of the parameter object.

", "smithy.api#required": {} } }, - "attributes": { - "target": "com.amazonaws.datapipeline#ParameterAttributeList", + "id": { + "target": "com.amazonaws.datapipeline#fieldNameString", "traits": { - "smithy.api#documentation": "

The attributes of the parameter object.

", + "smithy.api#documentation": "

The ID of the parameter object.

", "smithy.api#required": {} } } @@ -968,19 +968,6 @@ "com.amazonaws.datapipeline#PipelineDescription": { "type": "structure", "members": { - "pipelineId": { - "target": "com.amazonaws.datapipeline#id", - "traits": { - "smithy.api#documentation": "

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.datapipeline#string", - "traits": { - "smithy.api#documentation": "

Description of the pipeline.

" - } - }, "fields": { "target": "com.amazonaws.datapipeline#fieldList", "traits": { @@ -1000,6 +987,19 @@ "traits": { "smithy.api#documentation": "

A list of tags to associated with a pipeline. Tags let you control access to pipelines. \n For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" } + }, + "pipelineId": { + "target": "com.amazonaws.datapipeline#id", + "traits": { + "smithy.api#documentation": "

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datapipeline#string", + "traits": { + "smithy.api#documentation": "

Description of the pipeline.

" + } } }, "traits": { @@ -1015,16 +1015,16 @@ "com.amazonaws.datapipeline#PipelineIdName": { "type": "structure", "members": { - "id": { + "name": { "target": "com.amazonaws.datapipeline#id", "traits": { - "smithy.api#documentation": "

The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" + "smithy.api#documentation": "

The name of the pipeline.

" } }, - "name": { + "id": { "target": "com.amazonaws.datapipeline#id", "traits": { - "smithy.api#documentation": "

The name of the pipeline.

" + "smithy.api#documentation": "

The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" } } }, @@ -1050,13 +1050,6 @@ "com.amazonaws.datapipeline#PipelineObject": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.datapipeline#id", - "traits": { - "smithy.api#documentation": "

The ID of the object.

", - "smithy.api#required": {} - } - }, "fields": { "target": "com.amazonaws.datapipeline#fieldList", "traits": { @@ -1070,6 +1063,13 @@ "smithy.api#documentation": "

The name of the object.

", "smithy.api#required": {} } + }, + "id": { + "target": "com.amazonaws.datapipeline#id", + "traits": { + "smithy.api#documentation": "

The ID of the object.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1124,17 +1124,17 @@ "smithy.api#required": {} } }, - "instanceIdentity": { - "target": "com.amazonaws.datapipeline#InstanceIdentity", - "traits": { - "smithy.api#documentation": "

Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

" - } - }, "hostname": { "target": "com.amazonaws.datapipeline#id", "traits": { "smithy.api#documentation": "

The public DNS name of the calling task runner.

" } + }, + "instanceIdentity": { + "target": "com.amazonaws.datapipeline#InstanceIdentity", + "traits": { + "smithy.api#documentation": "

Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

" + } } }, "traits": { @@ -1184,13 +1184,6 @@ "com.amazonaws.datapipeline#PutPipelineDefinitionInput": { "type": "structure", "members": { - "pipelineObjects": { - "target": "com.amazonaws.datapipeline#PipelineObjectList", - "traits": { - "smithy.api#documentation": "

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

", - "smithy.api#required": {} - } - }, "pipelineId": { "target": "com.amazonaws.datapipeline#id", "traits": { @@ -1209,6 +1202,13 @@ "traits": { "smithy.api#documentation": "

The parameter values used with the pipeline.

" } + }, + "pipelineObjects": { + "target": "com.amazonaws.datapipeline#PipelineObjectList", + "traits": { + "smithy.api#documentation": "

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1218,6 +1218,12 @@ "com.amazonaws.datapipeline#PutPipelineDefinitionOutput": { "type": "structure", "members": { + "validationWarnings": { + "target": "com.amazonaws.datapipeline#ValidationWarnings", + "traits": { + "smithy.api#documentation": "

The validation warnings that are associated with the objects defined in pipelineObjects.

" + } + }, "errored": { "target": "com.amazonaws.datapipeline#boolean", "traits": { @@ -1230,12 +1236,6 @@ "traits": { "smithy.api#documentation": "

The validation errors that are associated with the objects defined in pipelineObjects.

" } - }, - "validationWarnings": { - "target": "com.amazonaws.datapipeline#ValidationWarnings", - "traits": { - "smithy.api#documentation": "

The validation warnings that are associated with the objects defined in pipelineObjects.

" - } } }, "traits": { @@ -1298,10 +1298,10 @@ "smithy.api#required": {} } }, - "limit": { - "target": "com.amazonaws.datapipeline#int", + "marker": { + "target": "com.amazonaws.datapipeline#string", "traits": { - "smithy.api#documentation": "

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

" + "smithy.api#documentation": "

The starting point for the results to be returned. For the first call, this value should be empty. \n As long as there are more results, continue to call QueryObjects with\n the marker value from the previous call to retrieve the next set of results.

" } }, "query": { @@ -1310,18 +1310,18 @@ "smithy.api#documentation": "

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. \n The conditions in the query are limited to top-level String fields in the object. \n These filters can be applied to components, instances, and attempts.

" } }, - "marker": { - "target": "com.amazonaws.datapipeline#string", - "traits": { - "smithy.api#documentation": "

The starting point for the results to be returned. For the first call, this value should be empty. \n As long as there are more results, continue to call QueryObjects with\n the marker value from the previous call to retrieve the next set of results.

" - } - }, "pipelineId": { "target": "com.amazonaws.datapipeline#id", "traits": { "smithy.api#documentation": "

The ID of the pipeline.

", "smithy.api#required": {} } + }, + "limit": { + "target": "com.amazonaws.datapipeline#int", + "traits": { + "smithy.api#documentation": "

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

" + } } }, "traits": { @@ -1337,17 +1337,17 @@ "smithy.api#documentation": "

The starting point for the next page of results. To view the next page of results, call QueryObjects \n again with this marker value. If the value is null, there are no more results.

" } }, - "ids": { - "target": "com.amazonaws.datapipeline#idList", - "traits": { - "smithy.api#documentation": "

The identifiers that match the query selectors.

" - } - }, "hasMoreResults": { "target": "com.amazonaws.datapipeline#boolean", "traits": { "smithy.api#documentation": "

Indicates whether there are more results that can be obtained by a subsequent call.

" } + }, + "ids": { + "target": "com.amazonaws.datapipeline#idList", + "traits": { + "smithy.api#documentation": "

The identifiers that match the query selectors.

" + } } }, "traits": { @@ -1441,18 +1441,18 @@ "com.amazonaws.datapipeline#ReportTaskProgressInput": { "type": "structure", "members": { - "fields": { - "target": "com.amazonaws.datapipeline#fieldList", - "traits": { - "smithy.api#documentation": "

Key-value pairs that define the properties of the ReportTaskProgressInput object.

" - } - }, "taskId": { "target": "com.amazonaws.datapipeline#taskId", "traits": { "smithy.api#documentation": "

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

", "smithy.api#required": {} } + }, + "fields": { + "target": "com.amazonaws.datapipeline#fieldList", + "traits": { + "smithy.api#documentation": "

Key-value pairs that define the properties of the ReportTaskProgressInput object.

" + } } }, "traits": { @@ -1497,10 +1497,10 @@ "com.amazonaws.datapipeline#ReportTaskRunnerHeartbeatInput": { "type": "structure", "members": { - "hostname": { - "target": "com.amazonaws.datapipeline#id", + "workerGroup": { + "target": "com.amazonaws.datapipeline#string", "traits": { - "smithy.api#documentation": "

The public DNS name of the task runner.

" + "smithy.api#documentation": "

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. \n You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string \n must be an exact, case-sensitive, match.

" } }, "taskrunnerId": { @@ -1510,10 +1510,10 @@ "smithy.api#required": {} } }, - "workerGroup": { - "target": "com.amazonaws.datapipeline#string", + "hostname": { + "target": "com.amazonaws.datapipeline#id", "traits": { - "smithy.api#documentation": "

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. \n You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string \n must be an exact, case-sensitive, match.

" + "smithy.api#documentation": "

The public DNS name of the task runner.

" } } }, @@ -1591,17 +1591,17 @@ "com.amazonaws.datapipeline#SetStatusInput": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.datapipeline#string", + "pipelineId": { + "target": "com.amazonaws.datapipeline#id", "traits": { - "smithy.api#documentation": "

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. \n For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

", + "smithy.api#documentation": "

The ID of the pipeline that contains the objects.

", "smithy.api#required": {} } }, - "pipelineId": { - "target": "com.amazonaws.datapipeline#id", + "status": { + "target": "com.amazonaws.datapipeline#string", "traits": { - "smithy.api#documentation": "

The ID of the pipeline that contains the objects.

", + "smithy.api#documentation": "

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. \n For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

", "smithy.api#required": {} } }, @@ -1649,23 +1649,22 @@ "com.amazonaws.datapipeline#SetTaskStatusInput": { "type": "structure", "members": { - "errorStackTrace": { - "target": "com.amazonaws.datapipeline#errorStackTraceString", + "errorId": { + "target": "com.amazonaws.datapipeline#string", "traits": { - "smithy.api#documentation": "

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" + "smithy.api#documentation": "

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.

" } }, - "taskStatus": { - "target": "com.amazonaws.datapipeline#TaskStatus", + "errorMessage": { + "target": "com.amazonaws.datapipeline#errorMessage", "traits": { - "smithy.api#documentation": "

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" } }, - "errorId": { - "target": "com.amazonaws.datapipeline#string", + "errorStackTrace": { + "target": "com.amazonaws.datapipeline#errorStackTraceString", "traits": { - "smithy.api#documentation": "

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.

" + "smithy.api#documentation": "

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" } }, "taskId": { @@ -1675,10 +1674,11 @@ "smithy.api#required": {} } }, - "errorMessage": { - "target": "com.amazonaws.datapipeline#errorMessage", + "taskStatus": { + "target": "com.amazonaws.datapipeline#TaskStatus", "traits": { - "smithy.api#documentation": "

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" + "smithy.api#documentation": "

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

", + "smithy.api#required": {} } } }, @@ -1739,12 +1739,6 @@ "smithy.api#documentation": "

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

" } }, - "objects": { - "target": "com.amazonaws.datapipeline#PipelineObjectMap", - "traits": { - "smithy.api#documentation": "

Connection information for the location where the task runner will publish the output of the task.

" - } - }, "taskId": { "target": "com.amazonaws.datapipeline#taskId", "traits": { @@ -1756,6 +1750,12 @@ "traits": { "smithy.api#documentation": "

The ID of the pipeline that provided the task.

" } + }, + "objects": { + "target": "com.amazonaws.datapipeline#PipelineObjectMap", + "traits": { + "smithy.api#documentation": "

Connection information for the location where the task runner will publish the output of the task.

" + } } }, "traits": { @@ -1810,11 +1810,10 @@ "com.amazonaws.datapipeline#ValidatePipelineDefinitionInput": { "type": "structure", "members": { - "pipelineObjects": { - "target": "com.amazonaws.datapipeline#PipelineObjectList", + "parameterValues": { + "target": "com.amazonaws.datapipeline#ParameterValueList", "traits": { - "smithy.api#documentation": "

The objects that define the pipeline changes to validate against the pipeline.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The parameter values used with the pipeline.

" } }, "parameterObjects": { @@ -1830,10 +1829,11 @@ "smithy.api#required": {} } }, - "parameterValues": { - "target": "com.amazonaws.datapipeline#ParameterValueList", + "pipelineObjects": { + "target": "com.amazonaws.datapipeline#PipelineObjectList", "traits": { - "smithy.api#documentation": "

The parameter values used with the pipeline.

" + "smithy.api#documentation": "

The objects that define the pipeline changes to validate against the pipeline.

", + "smithy.api#required": {} } } }, @@ -1844,12 +1844,6 @@ "com.amazonaws.datapipeline#ValidatePipelineDefinitionOutput": { "type": "structure", "members": { - "validationErrors": { - "target": "com.amazonaws.datapipeline#ValidationErrors", - "traits": { - "smithy.api#documentation": "

Any validation errors that were found.

" - } - }, "errored": { "target": "com.amazonaws.datapipeline#boolean", "traits": { @@ -1862,6 +1856,12 @@ "traits": { "smithy.api#documentation": "

Any validation warnings that were found.

" } + }, + "validationErrors": { + "target": "com.amazonaws.datapipeline#ValidationErrors", + "traits": { + "smithy.api#documentation": "

Any validation errors that were found.

" + } } }, "traits": { @@ -1897,17 +1897,17 @@ "com.amazonaws.datapipeline#ValidationWarning": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.datapipeline#id", - "traits": { - "smithy.api#documentation": "

The identifier of the object that contains the validation warning.

" - } - }, "warnings": { "target": "com.amazonaws.datapipeline#validationMessages", "traits": { "smithy.api#documentation": "

A description of the validation warning.

" } + }, + "id": { + "target": "com.amazonaws.datapipeline#id", + "traits": { + "smithy.api#documentation": "

The identifier of the object that contains the validation warning.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json b/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json index cbd3c2c7d90b..bcef14b24e00 100644 --- a/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json +++ b/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json @@ -47,16 +47,16 @@ "com.amazonaws.databasemigrationservice#AccountQuota": { "type": "structure", "members": { - "Used": { + "Max": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The amount currently used toward the quota maximum.

" + "smithy.api#documentation": "

The maximum allowed value for the quota.

" } }, - "Max": { + "Used": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The maximum allowed value for the quota.

" + "smithy.api#documentation": "

The amount currently used toward the quota maximum.

" } }, "AccountQuotaName": { @@ -93,23 +93,23 @@ } ], "traits": { - "smithy.api#documentation": "

Adds metadata tags to an AWS DMS resource, including replication instance, endpoint,\n security group, and migration task. These tags can also be used with cost allocation\n reporting to track cost associated with DMS resources, or used in a Condition statement in\n an IAM policy for DMS.

" + "smithy.api#documentation": "

Adds metadata tags to an AWS DMS resource, including replication instance, endpoint,\n security group, and migration task. These tags can also be used with cost allocation\n reporting to track cost associated with DMS resources, or used in a Condition statement in\n an IAM policy for DMS. For more information, see \n Tag\n data type description.

" } }, "com.amazonaws.databasemigrationservice#AddTagsToResourceMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.databasemigrationservice#TagList", + "ResourceArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

One or more tags to be assigned to the resource.

", + "smithy.api#documentation": "

Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).

\n

For AWS DMS, you can tag a replication instance, an endpoint, or a replication task.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "

Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).

\n

For AWS DMS, you can tag a replication instance, an endpoint, or a replication task.

", + "smithy.api#documentation": "

One or more tags to be assigned to the resource.

", "smithy.api#required": {} } } @@ -294,7 +294,7 @@ "sdkId": "Database Migration Service", "arnNamespace": "dms", "cloudFormationName": "DMS", - "cloudTrailEventSource": "v20160101.dms.amazonaws.com" + "cloudTrailEventSource": "databasemigrationservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "dms" @@ -327,17 +327,17 @@ "com.amazonaws.databasemigrationservice#ApplyPendingMaintenanceActionMessage": { "type": "structure", "members": { - "ApplyAction": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance\n action applies to.

", "smithy.api#required": {} } }, - "ReplicationInstanceArn": { + "ApplyAction": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance\n action applies to.

", + "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

", "smithy.api#required": {} } }, @@ -412,7 +412,7 @@ } }, "traits": { - "smithy.api#documentation": "

The name of an Availability Zone for use during database migration.

" + "smithy.api#documentation": "

The name of an Availability Zone for use during database migration.\n AvailabilityZone is an optional parameter to the \n CreateReplicationInstance\n operation, and it’s value relates to\n the AWS Region of an endpoint. For example, the availability zone of an endpoint in the\n us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.

" } }, "com.amazonaws.databasemigrationservice#AvailabilityZonesList": { @@ -491,22 +491,22 @@ "smithy.api#documentation": "

The contents of a .pem file, which contains an X.509 certificate.

" } }, - "CertificateOwner": { - "target": "com.amazonaws.databasemigrationservice#String", + "ValidToDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The owner of the certificate.

" + "smithy.api#documentation": "

The final date that the certificate is valid.

" } }, - "ValidFromDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "SigningAlgorithm": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The beginning date that the certificate is valid.

" + "smithy.api#documentation": "

The signing algorithm for the certificate.

" } }, - "CertificateArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "CertificateWallet": { + "target": "com.amazonaws.databasemigrationservice#CertificateWallet", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" + "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL.

" } }, "CertificateCreationDate": { @@ -515,28 +515,28 @@ "smithy.api#documentation": "

The date that the certificate was created.

" } }, - "CertificateWallet": { - "target": "com.amazonaws.databasemigrationservice#CertificateWallet", + "KeyLength": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL.

" + "smithy.api#documentation": "

The key length of the cryptographic algorithm being used.

" } }, - "SigningAlgorithm": { + "CertificateOwner": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The signing algorithm for the certificate.

" + "smithy.api#documentation": "

The owner of the certificate.

" } }, - "KeyLength": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "CertificateArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The key length of the cryptographic algorithm being used.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" } }, - "ValidToDate": { + "ValidFromDate": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The final date that the certificate is valid.

" + "smithy.api#documentation": "

The beginning date that the certificate is valid.

" } }, "CertificateIdentifier": { @@ -562,6 +562,25 @@ "com.amazonaws.databasemigrationservice#CertificateWallet": { "type": "blob" }, + "com.amazonaws.databasemigrationservice#CharLengthSemantics": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "default", + "name": "DEFAULT" + }, + { + "value": "char", + "name": "CHAR" + }, + { + "value": "byte", + "name": "BYTE" + } + ] + } + }, "com.amazonaws.databasemigrationservice#CompressionTypeValue": { "type": "string", "traits": { @@ -586,22 +605,22 @@ "smithy.api#documentation": "

The ARN string that uniquely identifies the endpoint.

" } }, - "ReplicationInstanceIdentifier": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

" + "smithy.api#documentation": "

The connection status. This parameter can return one of the following values:

\n " } }, - "EndpointIdentifier": { + "ReplicationInstanceIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The identifier of the endpoint. Identifiers must begin with a letter and must contain only\n ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two\n consecutive hyphens.

" + "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

" } }, - "Status": { + "EndpointIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The connection status. This parameter can return one of the following values:

\n " + "smithy.api#documentation": "

The identifier of the endpoint. Identifiers must begin with a letter and must contain only\n ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two\n consecutive hyphens.

" } }, "ReplicationInstanceArn": { @@ -665,186 +684,192 @@ "com.amazonaws.databasemigrationservice#CreateEndpointMessage": { "type": "structure", "members": { - "RedshiftSettings": { - "target": "com.amazonaws.databasemigrationservice#RedshiftSettings" - }, - "Tags": { - "target": "com.amazonaws.databasemigrationservice#TagList", + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

One or more tags to be assigned to the endpoint.

" + "smithy.api#documentation": "

The port used by the endpoint database.

" } }, - "ServerName": { + "EndpointIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the server where the endpoint database resides.

" + "smithy.api#documentation": "

The database endpoint identifier. Identifiers must begin with a letter and must contain\n only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two\n consecutive hyphens.

", + "smithy.api#required": {} } }, - "ExtraConnectionAttributes": { - "target": "com.amazonaws.databasemigrationservice#String", + "KafkaSettings": { + "target": "com.amazonaws.databasemigrationservice#KafkaSettings", "traits": { - "smithy.api#documentation": "

Additional attributes associated with the connection. Each attribute is specified as a\n name-value pair associated by an equal sign (=). Multiple attributes are separated by a\n semicolon (;) with no additional white space. For information on the attributes available\n for connecting your source or target endpoint, see Working with\n AWS DMS Endpoints in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target Apache Kafka endpoint. For more information about\n the available settings, see Using Apache Kafka as a Target for \n AWS Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" } }, - "MongoDbSettings": { - "target": "com.amazonaws.databasemigrationservice#MongoDbSettings", + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source MongoDB endpoint. For more information about the\n available settings, see Using MongoDB as a Target for AWS Database Migration Service in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service access role that you want to use to\n create the endpoint.

" } }, - "CertificateArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "SybaseSettings": { + "target": "com.amazonaws.databasemigrationservice#SybaseSettings", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" + "smithy.api#documentation": "

Settings in JSON format for the source and target SAP ASE endpoint. For information\n about other available settings, see Extra connection attributes\n when using SAP ASE as a source for AWS DMS and Extra connection attributes\n when using SAP ASE as a target for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" } }, - "Password": { - "target": "com.amazonaws.databasemigrationservice#SecretString", + "EndpointType": { + "target": "com.amazonaws.databasemigrationservice#ReplicationEndpointTypeValue", "traits": { - "smithy.api#documentation": "

The password to be used to log in to the endpoint database.

" + "smithy.api#documentation": "

The type of endpoint. Valid values are source and target.

", + "smithy.api#required": {} } }, - "SybaseSettings": { - "target": "com.amazonaws.databasemigrationservice#SybaseSettings", + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target SAP ASE endpoint. For information\n about other available settings, see Extra connection attributes\n when using SAP ASE as a source for AWS DMS and Extra connection attributes\n when using SAP ASE as a target for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" + "smithy.api#documentation": "

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none\n

" } }, - "KmsKeyId": { - "target": "com.amazonaws.databasemigrationservice#String", + "OracleSettings": { + "target": "com.amazonaws.databasemigrationservice#OracleSettings", "traits": { - "smithy.api#documentation": "

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

\n

If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key.

\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" + "smithy.api#documentation": "

Settings in JSON format for the source and target Oracle endpoint. For information about\n other available settings, see Extra connection attributes \n when using Oracle as a source for AWS DMS and \n \n Extra connection attributes when using Oracle as a target for AWS DMS \n in the AWS Database Migration Service User Guide.\n

" } }, - "DatabaseName": { - "target": "com.amazonaws.databasemigrationservice#String", + "MySQLSettings": { + "target": "com.amazonaws.databasemigrationservice#MySQLSettings", "traits": { - "smithy.api#documentation": "

The name of the endpoint database.

" + "smithy.api#documentation": "

Settings in JSON format for the source and target MySQL endpoint. For information about\n other available settings, see Extra connection attributes \n when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in\n the AWS Database Migration Service User Guide.\n

" } }, - "EngineName": { - "target": "com.amazonaws.databasemigrationservice#String", + "S3Settings": { + "target": "com.amazonaws.databasemigrationservice#S3Settings", "traits": { - "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\",\n \"aurora-postgresql\", \"redshift\", \"s3\",\n \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\",\n \"sqlserver\", and \"neptune\".

", - "smithy.api#required": {} + "smithy.api#documentation": "

Settings in JSON format for the target Amazon S3 endpoint. For more information about\n the available settings, see Extra\n Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" } }, - "ElasticsearchSettings": { - "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", + "IBMDb2Settings": { + "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Elasticsearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in\n the AWS Database Migration Service User Guide.

" + "smithy.api#documentation": "

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other\n available settings, see Extra connection attributes\n when using Db2 LUW as a source for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" } }, - "DynamoDbSettings": { - "target": "com.amazonaws.databasemigrationservice#DynamoDbSettings", + "MicrosoftSQLServerSettings": { + "target": "com.amazonaws.databasemigrationservice#MicrosoftSQLServerSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other \n available settings, see Using Object Mapping to Migrate\n Data to DynamoDB in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For\n information about other available settings, see Extra connection\n attributes when using SQL Server as a source for AWS DMS and \n Extra connection attributes when using SQL Server as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" } }, - "Username": { + "CertificateArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The user name to be used to log in to the endpoint database.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" } }, - "KinesisSettings": { - "target": "com.amazonaws.databasemigrationservice#KinesisSettings", + "PostgreSQLSettings": { + "target": "com.amazonaws.databasemigrationservice#PostgreSQLSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For\n more information about the available settings, see Using Amazon Kinesis Data Streams \n as a Target for AWS Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the source and target PostgreSQL endpoint. For information\n about other available settings, see Extra connection\n attributes when using PostgreSQL as a source for AWS DMS and \n Extra connection attributes when using PostgreSQL as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" } }, - "ExternalTableDefinition": { + "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The external table definition.

" + "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\",\n \"aurora-postgresql\", \"redshift\", \"s3\",\n \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", and \"neptune\".

", + "smithy.api#required": {} } }, - "MySQLSettings": { - "target": "com.amazonaws.databasemigrationservice#MySQLSettings", + "ExtraConnectionAttributes": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target MySQL endpoint. For information about\n other available settings, see Extra connection attributes \n when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in\n the AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

Additional attributes associated with the connection. Each attribute is specified as a\n name-value pair associated by an equal sign (=). Multiple attributes are separated by a\n semicolon (;) with no additional white space. For information on the attributes available\n for connecting your source or target endpoint, see Working with\n AWS DMS Endpoints in the AWS Database Migration Service User\n Guide.\n

" } }, - "SslMode": { - "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "ExternalTableDefinition": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none\n

" + "smithy.api#documentation": "

The external table definition.

" } }, - "EndpointType": { - "target": "com.amazonaws.databasemigrationservice#ReplicationEndpointTypeValue", + "Username": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of endpoint. Valid values are source and target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user name to be used to log in to the endpoint database.

" } }, - "ServiceAccessRoleArn": { + "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service access role that you want to use to\n create the endpoint.

" + "smithy.api#documentation": "

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

\n

If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key.

\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" } }, - "PostgreSQLSettings": { - "target": "com.amazonaws.databasemigrationservice#PostgreSQLSettings", + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target PostgreSQL endpoint. For information\n about other available settings, see Extra connection\n attributes when using PostgreSQL as a source for AWS DMS and \n Extra connection attributes when using PostgreSQL as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

The name of the endpoint database.

" } }, - "EndpointIdentifier": { + "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The database endpoint identifier. Identifiers must begin with a letter and must contain only\n ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two\n consecutive hyphens.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the server where the endpoint database resides.

" } }, - "MicrosoftSQLServerSettings": { - "target": "com.amazonaws.databasemigrationservice#MicrosoftSQLServerSettings", + "DmsTransferSettings": { + "target": "com.amazonaws.databasemigrationservice#DmsTransferSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For\n information about other available settings, see Extra connection\n attributes when using SQL Server as a source for AWS DMS and \n Extra connection attributes when using SQL Server as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

The settings in JSON format for the DMS transfer type of source endpoint.

\n

Possible settings include the following:

\n \n

Shorthand syntax for these settings is as follows:\n ServiceAccessRoleArn=string,BucketName=string,CompressionType=string\n

\n

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\":\n \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } \n

" } }, - "OracleSettings": { - "target": "com.amazonaws.databasemigrationservice#OracleSettings", + "ElasticsearchSettings": { + "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target Oracle endpoint. For information about\n other available settings, see Extra connection attributes \n when using Oracle as a source for AWS DMS and \n \n Extra connection attributes when using Oracle as a target for AWS DMS \n in the AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target Elasticsearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in\n the AWS Database Migration Service User Guide.

" } }, - "KafkaSettings": { - "target": "com.amazonaws.databasemigrationservice#KafkaSettings", + "NeptuneSettings": { + "target": "com.amazonaws.databasemigrationservice#NeptuneSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Apache Kafka endpoint. For more information about\n the available settings, see Using Apache Kafka as a Target for \n AWS Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target Amazon Neptune endpoint.\n For more information\n about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target \n in the AWS Database Migration Service User Guide.\n

" } }, - "Port": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "DynamoDbSettings": { + "target": "com.amazonaws.databasemigrationservice#DynamoDbSettings", "traits": { - "smithy.api#documentation": "

The port used by the endpoint database.

" + "smithy.api#documentation": "

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other \n available settings, see Using Object Mapping to Migrate\n Data to DynamoDB in the AWS Database Migration Service User\n Guide.\n

" } }, - "NeptuneSettings": { - "target": "com.amazonaws.databasemigrationservice#NeptuneSettings", + "MongoDbSettings": { + "target": "com.amazonaws.databasemigrationservice#MongoDbSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Amazon Neptune endpoint.\n For more information\n about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target \n in the AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the source MongoDB endpoint. For more information about the\n available settings, see Using MongoDB as a Target for AWS Database Migration Service in the\n AWS Database Migration Service User Guide.\n

" } }, - "DmsTransferSettings": { - "target": "com.amazonaws.databasemigrationservice#DmsTransferSettings", + "RedshiftSettings": { + "target": "com.amazonaws.databasemigrationservice#RedshiftSettings" + }, + "KinesisSettings": { + "target": "com.amazonaws.databasemigrationservice#KinesisSettings", "traits": { - "smithy.api#documentation": "

The settings in JSON format for the DMS transfer type of source endpoint.

\n

Possible settings include the following:

\n \n

Shorthand syntax for these settings is as follows:\n ServiceAccessRoleArn=string,BucketName=string,CompressionType=string\n

\n

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\":\n \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } \n

" + "smithy.api#documentation": "

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For\n more information about the available settings, see Using Amazon Kinesis Data Streams \n as a Target for AWS Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" } }, - "S3Settings": { - "target": "com.amazonaws.databasemigrationservice#S3Settings", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Amazon S3 endpoint. For more information about\n the available settings, see Extra\n Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

One or more tags to be assigned to the endpoint.

" } }, - "IBMDb2Settings": { - "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other\n available settings, see Extra connection attributes\n when using Db2 LUW as a source for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" + "smithy.api#documentation": "

The password to be used to log in to the endpoint database.

" } - } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, AWS DMS generates a default identifier\n value for the end of EndpointArn.

" + } + } }, "traits": { "smithy.api#documentation": "

" @@ -911,17 +936,16 @@ "com.amazonaws.databasemigrationservice#CreateEventSubscriptionMessage": { "type": "structure", "members": { - "SourceIds": { - "target": "com.amazonaws.databasemigrationservice#SourceIdsList", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "

A list of identifiers for which AWS DMS provides notification events.

\n

If you don't specify a value, notifications are provided for all sources.

\n

If you specify multiple values, they must be of the same type. For example, if you\n specify a database instance ID, then all of the other values must be database instance\n IDs.

" + "smithy.api#documentation": "

One or more tags to be assigned to the event subscription.

" } }, - "SubscriptionName": { + "SourceType": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the AWS DMS event notification subscription. This name must be less than 255 characters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The type of AWS DMS resource that generates the events. For example, if you want to be\n notified of events generated by a replication instance, you set this parameter to\n replication-instance. If this value isn't specified, all events are\n returned.

\n

Valid values: replication-instance | replication-task\n

" } }, "EventCategories": { @@ -930,16 +954,10 @@ "smithy.api#documentation": "

A list of event categories for a source type that you want to subscribe to. For more\n information, see Working with Events and\n Notifications in the AWS Database Migration Service User\n Guide.\n

" } }, - "Enabled": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A Boolean value; set to true to activate the subscription, or set to\n false to create the subscription but not activate it.

" - } - }, - "SourceType": { - "target": "com.amazonaws.databasemigrationservice#String", + "SourceIds": { + "target": "com.amazonaws.databasemigrationservice#SourceIdsList", "traits": { - "smithy.api#documentation": "

The type of AWS DMS resource that generates the events. For example, if you want to be\n notified of events generated by a replication instance, you set this parameter to\n replication-instance. If this value isn't specified, all events are\n returned.

\n

Valid values: replication-instance | replication-task\n

" + "smithy.api#documentation": "

A list of identifiers for which AWS DMS provides notification events.

\n

If you don't specify a value, notifications are provided for all sources.

\n

If you specify multiple values, they must be of the same type. For example, if you\n specify a database instance ID, then all of the other values must be database instance\n IDs.

" } }, "SnsTopicArn": { @@ -949,10 +967,17 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.databasemigrationservice#TagList", + "Enabled": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

One or more tags to be assigned to the event subscription.

" + "smithy.api#documentation": "

A Boolean value; set to true to activate the subscription, or set to\n false to create the subscription but not activate it.

" + } + }, + "SubscriptionName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of the AWS DMS event notification subscription. This name must be less than 255 characters.

", + "smithy.api#required": {} } } }, @@ -1015,96 +1040,102 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the replication instance using the specified parameters.

\n

AWS DMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For\n information on the required permissions, see IAM Permissions Needed to Use AWS DMS.

" + "smithy.api#documentation": "

Creates the replication instance using the specified parameters.

\n

AWS DMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For\n information on the required permissions, see \n IAM Permissions Needed to Use AWS DMS.

" } }, "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage": { "type": "structure", "members": { - "ReplicationSubnetGroupIdentifier": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A subnet group to associate with the replication instance.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

Default: A 30-minute window selected at random from an 8-hour block of time per AWS\n Region, occurring on a random day of the week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, - "Tags": { - "target": "com.amazonaws.databasemigrationservice#TagList", + "AllocatedStorage": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

One or more tags to be assigned to the replication instance.

" + "smithy.api#documentation": "

The amount of storage (in gigabytes) to be initially allocated for the replication\n instance.

" } }, - "PreferredMaintenanceWindow": { + "DnsNameServers": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

Default: A 30-minute window selected at random from an 8-hour block of time per AWS\n Region, occurring on a random day of the week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

A list of custom DNS name servers supported for the replication instance to access your\n on-premise source or target database. This list overrides the default name servers\n supported by the replication instance. You can specify a comma-separated list of internet\n addresses for up to four on-premise DNS name servers. For example:\n \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"\n

" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ReplicationInstanceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.

\n

Default: true\n

" + "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n \n

Example: myrepinstance\n

", + "smithy.api#required": {} } }, - "ReplicationInstanceClass": { - "target": "com.amazonaws.databasemigrationservice#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.

" } }, - "PubliclyAccessible": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "KmsKeyId": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for the replication instance. A value of\n true represents an instance with a public IP address. A value of\n false represents an instance with a private IP address. The default value\n is true.

" + "smithy.api#documentation": "

An AWS KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key.

\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" } }, - "DnsNameServers": { + "AvailabilityZone": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A list of custom DNS name servers supported for the replication instance to access your\n on-premise source or target database. This list overrides the default name servers\n supported by the replication instance. You can specify a comma-separated list of internet\n addresses for up to four on-premise DNS name servers. For example:\n \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"\n

" + "smithy.api#documentation": "

The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for\n example: us-east-1d\n

" } }, - "ReplicationInstanceIdentifier": { + "ReplicationInstanceClass": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n \n

Example: myrepinstance\n

", + "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

", "smithy.api#required": {} } }, - "EngineVersion": { + "ReplicationSubnetGroupIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The engine version number of the replication instance.

" + "smithy.api#documentation": "

A subnet group to associate with the replication instance.

" } }, - "MultiAZ": { + "AutoMinorVersionUpgrade": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.

" + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.

\n

Default: true\n

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "ResourceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The amount of storage (in gigabytes) to be initially allocated for the replication\n instance.

" + "smithy.api#documentation": "

A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, AWS DMS generates a default identifier\n value for the end of EndpointArn.

" } }, - "AvailabilityZone": { - "target": "com.amazonaws.databasemigrationservice#String", + "MultiAZ": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for\n example: us-east-1d\n

" + "smithy.api#documentation": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.

" } }, - "KmsKeyId": { + "PubliclyAccessible": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for the replication instance. A value of\n true represents an instance with a public IP address. A value of\n false represents an instance with a private IP address. The default value\n is true.

" + } + }, + "EngineVersion": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An AWS KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key.

\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" + "smithy.api#documentation": "

The engine version number of the replication instance.

\n

If an engine version number is not specified when a replication \n instance is created, the default is the latest engine version available.

" } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "

Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.

" + "smithy.api#documentation": "

One or more tags to be assigned to the replication instance.

" } } }, @@ -1161,19 +1192,19 @@ "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage": { "type": "structure", "members": { - "ReplicationSubnetGroupDescription": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The description for the subnet group.

", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { "smithy.api#documentation": "

One or more tags to be assigned to the subnet group.

" } }, + "SubnetIds": { + "target": "com.amazonaws.databasemigrationservice#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

One or more subnet IDs to be assigned to the subnet group.

", + "smithy.api#required": {} + } + }, "ReplicationSubnetGroupIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -1181,10 +1212,10 @@ "smithy.api#required": {} } }, - "SubnetIds": { - "target": "com.amazonaws.databasemigrationservice#SubnetIdentifierList", + "ReplicationSubnetGroupDescription": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

One or more subnet IDs to be assigned to the subnet group.

", + "smithy.api#documentation": "

The description for the subnet group.

", "smithy.api#required": {} } } @@ -1242,75 +1273,75 @@ "com.amazonaws.databasemigrationservice#CreateReplicationTaskMessage": { "type": "structure", "members": { - "ReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a replication instance.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more tags to be assigned to the replication task.

" } }, - "CdcStartTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "SourceEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates the start time for a change data capture (CDC) operation. Use either\n CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.\n Specifying both values results in an error.

\n

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

", + "smithy.api#required": {} } }, - "TableMappings": { + "CdcStartPosition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The table mappings for the task, in JSON format. For more information, see Using Table\n Mapping to Specify Task Settings in the AWS Database Migration Service User\n Guide.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start.\n Specifying both values results in an error.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

\n

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

\n \n

When you use this task setting with a source PostgreSQL database, a logical\n replication slot should already be created and associated with the source endpoint. You\n can verify this by setting the slotName extra connection attribute to the\n name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source\n for AWS DMS.

\n " } }, - "TargetEndpointArn": { + "ResourceIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, AWS DMS generates a default identifier\n value for the end of EndpointArn.

" } }, - "ReplicationTaskIdentifier": { + "TableMappings": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An identifier for the replication task.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The table mappings for the task, in JSON format. For more information, see Using Table\n Mapping to Specify Task Settings in the AWS Database Migration Service User\n Guide.\n

", "smithy.api#required": {} } }, - "SourceEndpointArn": { + "CdcStopPosition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

" } }, - "CdcStartPosition": { + "TaskData": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start.\n Specifying both values results in an error.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

\n

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

\n \n

When you use this task setting with a source PostgreSQL database, a logical\n replication slot should already be created and associated with the source endpoint. You\n can verify this by setting the slotName extra connection attribute to the\n name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source\n for AWS DMS.

\n " + "smithy.api#documentation": "

Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n AWS Database Migration Service User Guide.\n

" } }, - "CdcStopPosition": { + "TargetEndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.databasemigrationservice#TagList", + "CdcStartTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

One or more tags to be assigned to the replication task.

" + "smithy.api#documentation": "

Indicates the start time for a change data capture (CDC) operation. Use either\n CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.\n Specifying both values results in an error.

\n

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

" } }, - "TaskData": { + "ReplicationTaskIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

An identifier for the replication task.

\n

Constraints:

\n ", + "smithy.api#required": {} } }, - "ReplicationTaskSettings": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Overall settings for the task, in JSON format. For more information, see Specifying Task\n Settings for AWS Database Migration Service Tasks in the AWS Database\n Migration User Guide.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a replication instance.

", + "smithy.api#required": {} } }, "MigrationType": { @@ -1319,6 +1350,12 @@ "smithy.api#documentation": "

The migration type. Valid values: full-load | cdc | full-load-and-cdc\n

", "smithy.api#required": {} } + }, + "ReplicationTaskSettings": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Overall settings for the task, in JSON format. For more information, see Specifying Task\n Settings for AWS Database Migration Service Tasks in the AWS Database\n Migration User Guide.\n

" + } } }, "traits": { @@ -1354,6 +1391,56 @@ ] } }, + "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SLASH", + "name": "SLASH" + }, + { + "value": "UNDERSCORE", + "name": "UNDERSCORE" + }, + { + "value": "DASH", + "name": "DASH" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "YYYYMMDD", + "name": "YYYYMMDD" + }, + { + "value": "YYYYMMDDHH", + "name": "YYYYMMDDHH" + }, + { + "value": "YYYYMM", + "name": "YYYYMM" + }, + { + "value": "MMYYYYDD", + "name": "MMYYYYDD" + }, + { + "value": "DDMMYYYY", + "name": "DDMMYYYY" + } + ] + } + }, "com.amazonaws.databasemigrationservice#DeleteCertificate": { "type": "operation", "input": { @@ -1816,22 +1903,34 @@ "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsMessage": { "type": "structure", "members": { + "TargetEngineName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Name of a database engine that the specified replication instance supports as a target.

" + } + }, + "ReplicationTaskArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of a migration task on which you want to base \n the default list of individual assessments.

" + } + }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { "smithy.api#documentation": "

Maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.

" } }, - "ReplicationTaskArn": { + "SourceEngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of a migration task on which you want to base \n the default list of individual assessments.

" + "smithy.api#documentation": "

Name of a database engine that the specified replication instance supports as a source.

" } }, - "TargetEngineName": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Name of a database engine that the specified replication instance supports as a target.

" + "smithy.api#documentation": "

ARN of a replication instance on which you want to base the default list of individual\n assessments.

" } }, "MigrationType": { @@ -1845,18 +1944,6 @@ "traits": { "smithy.api#documentation": "

Optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } - }, - "SourceEngineName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

Name of a database engine that the specified replication instance supports as a source.

" - } - }, - "ReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

ARN of a replication instance on which you want to base the default list of individual\n assessments.

" - } } }, "traits": { @@ -1866,17 +1953,17 @@ "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

Pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.

" - } - }, "IndividualAssessmentNames": { "target": "com.amazonaws.databasemigrationservice#IndividualAssessmentNameList", "traits": { "smithy.api#documentation": "

List of names for the individual assessments supported by the premigration assessment\n run that you start based on the specified request parameters. For more information on the\n available individual assessments, including compatibility with different migration task\n configurations, see Working with premigration assessment runs in the\n AWS Database Migration Service User Guide.\n

" } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.

" + } } }, "traits": { @@ -1908,6 +1995,12 @@ "com.amazonaws.databasemigrationservice#DescribeCertificatesMessage": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the certificates described in the form of key-value pairs.

" + } + }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -1919,12 +2012,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 10

" } - }, - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "

Filters applied to the certificates described in the form of key-value pairs.

" - } } } }, @@ -1970,6 +2057,12 @@ "com.amazonaws.databasemigrationservice#DescribeConnectionsMessage": { "type": "structure", "members": { + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { @@ -1981,12 +2074,6 @@ "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } - }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } } }, "traits": { @@ -1996,17 +2083,17 @@ "com.amazonaws.databasemigrationservice#DescribeConnectionsResponse": { "type": "structure", "members": { - "Connections": { - "target": "com.amazonaws.databasemigrationservice#ConnectionList", - "traits": { - "smithy.api#documentation": "

A description of the connections.

" - } - }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } + }, + "Connections": { + "target": "com.amazonaws.databasemigrationservice#ConnectionList", + "traits": { + "smithy.api#documentation": "

A description of the connections.

" + } } }, "traits": { @@ -2059,17 +2146,17 @@ "com.amazonaws.databasemigrationservice#DescribeEndpointTypesResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" - } - }, "SupportedEndpointTypes": { "target": "com.amazonaws.databasemigrationservice#SupportedEndpointTypeList", "traits": { "smithy.api#documentation": "

The types of endpoints that are supported.

" } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + } } }, "traits": { @@ -2101,18 +2188,18 @@ "com.amazonaws.databasemigrationservice#DescribeEndpointsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "

Filters applied to the endpoints.

\n

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

" - } - }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the endpoints.

\n

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

" + } + }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { @@ -2159,17 +2246,17 @@ "com.amazonaws.databasemigrationservice#DescribeEventCategoriesMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "

Filters applied to the event categories.

" - } - }, "SourceType": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

The type of AWS DMS resource that generates events.

\n

Valid values: replication-instance | replication-task

" } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the event categories.

" + } } }, "traits": { @@ -2215,12 +2302,6 @@ "com.amazonaws.databasemigrationservice#DescribeEventSubscriptionsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -2238,6 +2319,12 @@ "traits": { "smithy.api#documentation": "

The name of the AWS DMS event subscription to be described.

" } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } } }, "traits": { @@ -2284,34 +2371,40 @@ "com.amazonaws.databasemigrationservice#DescribeEventsMessage": { "type": "structure", "members": { - "EndTime": { + "EventCategories": { + "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for the source type that you've chosen.

" + } + }, + "StartTime": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The end time for the events to be listed.

" + "smithy.api#documentation": "

The start time for the events to be listed.

" } }, - "MaxRecords": { + "Duration": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The duration of the events to be listed.

" } }, - "SourceIdentifier": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The identifier of an event source.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, - "Duration": { + "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The duration of the events to be listed.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "SourceType": { - "target": "com.amazonaws.databasemigrationservice#SourceType", + "SourceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of AWS DMS resource that generates events.

\n

Valid values: replication-instance | replication-task

" + "smithy.api#documentation": "

The identifier of an event source.

" } }, "Filters": { @@ -2320,22 +2413,16 @@ "smithy.api#documentation": "

Filters applied to events.

" } }, - "EventCategories": { - "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for the source type that you've chosen.

" - } - }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The start time for the events to be listed.

" + "smithy.api#documentation": "

The end time for the events to be listed.

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "SourceType": { + "target": "com.amazonaws.databasemigrationservice#SourceType", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "smithy.api#documentation": "

The type of AWS DMS resource that generates events.

\n

Valid values: replication-instance | replication-task

" } } }, @@ -2403,17 +2490,17 @@ "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" - } - }, "OrderableReplicationInstances": { "target": "com.amazonaws.databasemigrationservice#OrderableReplicationInstanceList", "traits": { "smithy.api#documentation": "

The order-able replication instances available.

" } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + } } }, "traits": { @@ -2445,16 +2532,10 @@ "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, "ReplicationInstanceArn": { @@ -2463,10 +2544,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

" } } }, @@ -2571,10 +2658,11 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

", + "smithy.api#required": {} } }, "Marker": { @@ -2583,11 +2671,10 @@ "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, - "ReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } } @@ -2595,10 +2682,10 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsResponse": { "type": "structure", "members": { - "ReplicationInstanceTaskLogs": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceTaskLogsList", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An array of replication task log metadata. Each member of the array contains the\n replication task name, ARN, and task log size (in bytes).

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, "ReplicationInstanceArn": { @@ -2607,10 +2694,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationInstanceTaskLogs": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceTaskLogsList", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "smithy.api#documentation": "

An array of replication task log metadata. Each member of the array contains the\n replication task name, ARN, and task log size (in bytes).

" } } } @@ -2640,18 +2727,18 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { "smithy.api#documentation": "

Filters applied to replication instances.

\n

Valid filter names: replication-instance-arn | replication-instance-id |\n replication-instance-class | engine-version

" } }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -2708,18 +2795,18 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { @@ -2734,17 +2821,17 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" - } - }, "ReplicationSubnetGroups": { "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroups", "traits": { "smithy.api#documentation": "

A description of the replication subnet groups.

" } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + } } }, "traits": { @@ -2776,6 +2863,12 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage": { "type": "structure", "members": { + "ReplicationTaskArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input\n parameter is specified, the API returns only one result and ignore the values of the\n MaxRecords and Marker parameters.

" + } + }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -2787,12 +2880,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } - }, - "ReplicationTaskArn": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input\n parameter is specified, the API returns only one result and ignore the values of the\n MaxRecords and Marker parameters.

" - } } }, "traits": { @@ -2802,6 +2889,12 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse": { "type": "structure", "members": { + "ReplicationTaskAssessmentResults": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResultList", + "traits": { + "smithy.api#documentation": "

The task assessment report.

" + } + }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -2813,12 +2906,6 @@ "traits": { "smithy.api#documentation": "

- The Amazon S3 bucket where the task assessment report is located.

" } - }, - "ReplicationTaskAssessmentResults": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResultList", - "traits": { - "smithy.api#documentation": "

The task assessment report.

" - } } }, "traits": { @@ -2850,18 +2937,18 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "

Filters applied to the premigration assessment runs described in the form of key-value pairs.

\n

Valid filter names: replication-task-assessment-run-arn, replication-task-arn,\n replication-instance-arn, status\n

" - } - }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.

" } }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the premigration assessment runs described in the form of key-value pairs.

\n

Valid filter names: replication-task-assessment-run-arn, replication-task-arn,\n replication-instance-arn, status\n

" + } + }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -2876,17 +2963,17 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

A pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.

" - } - }, "ReplicationTaskAssessmentRuns": { "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunList", "traits": { "smithy.api#documentation": "

One or more premigration assessment runs as specified by Filters.

" } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.

" + } } }, "traits": { @@ -2918,18 +3005,18 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "

Filters applied to the individual assessments described in the form of key-value\n pairs.

\n

Valid filter names: replication-task-assessment-run-arn,\n replication-task-arn, status\n

" - } - }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.

" } }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the individual assessments described in the form of key-value\n pairs.

\n

Valid filter names: replication-task-assessment-run-arn,\n replication-task-arn, status\n

" + } + }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -2986,16 +3073,16 @@ "com.amazonaws.databasemigrationservice#DescribeReplicationTasksMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, - "WithoutSettings": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

An option to set to avoid returning information about settings. Use this to reduce\n overhead when setting information is too large. To use this option, choose\n true; otherwise, choose false (the default).

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Filters": { @@ -3004,10 +3091,10 @@ "smithy.api#documentation": "

Filters applied to replication tasks.

\n

Valid filter names: replication-task-arn | replication-task-id | migration-type |\n endpoint-arn | replication-instance-arn

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "WithoutSettings": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "smithy.api#documentation": "

An option to set to avoid returning information about settings. Use this to reduce\n overhead when setting information is too large. To use this option, choose\n true; otherwise, choose false (the default).

" } } }, @@ -3135,11 +3222,16 @@ "com.amazonaws.databasemigrationservice#DescribeTableStatisticsMessage": { "type": "structure", "members": { - "ReplicationTaskArn": { + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 500.

" + } + }, + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" } }, "Filters": { @@ -3148,16 +3240,11 @@ "smithy.api#documentation": "

Filters applied to table statistics.

\n

Valid filter names: schema-name | table-name | table-state

\n

A combination of filters creates an AND condition where each record matches all\n specified filters.

" } }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 500.

" - } - }, - "Marker": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", + "smithy.api#required": {} } } }, @@ -3217,16 +3304,16 @@ "com.amazonaws.databasemigrationservice#DmsTransferSettings": { "type": "structure", "members": { - "ServiceAccessRoleArn": { + "BucketName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The IAM role that has permission to access the Amazon S3 bucket.

" + "smithy.api#documentation": "

The name of the S3 bucket to use.

" } }, - "BucketName": { + "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket to use.

" + "smithy.api#documentation": "

The IAM role that has permission to access the Amazon S3 bucket.

" } } }, @@ -3252,16 +3339,10 @@ "com.amazonaws.databasemigrationservice#ElasticsearchSettings": { "type": "structure", "members": { - "ErrorRetryDuration": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of seconds for which DMS retries failed API requests to the\n Elasticsearch cluster.

" - } - }, "EndpointUri": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The endpoint for the Elasticsearch cluster.

", + "smithy.api#documentation": "

The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport \n protocol (http/https) is not specified.

", "smithy.api#required": {} } }, @@ -3272,10 +3353,16 @@ "smithy.api#required": {} } }, + "ErrorRetryDuration": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of seconds for which DMS retries failed API requests to the\n Elasticsearch cluster.

" + } + }, "FullLoadErrorPercentage": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum percentage of records that can fail to be written before a full load\n operation stops.

" + "smithy.api#documentation": "

The maximum percentage of records that can fail to be written before a full load\n operation stops.

\n

To avoid early failure, this counter is only effective after 1000 records \n are transferred. Elasticsearch also has the concept of error monitoring during the \n last 10 minutes of an Observation Window. If transfer of all records fail in the \n last 10 minutes, the full load operation stops.

" } } }, @@ -3320,64 +3407,34 @@ "com.amazonaws.databasemigrationservice#Endpoint": { "type": "structure", "members": { - "EngineName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The database engine name. Valid values, depending on the EndpointType, include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" - } - }, - "EndpointArn": { + "DatabaseName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + "smithy.api#documentation": "

The name of the database at the endpoint.

" } }, - "ExternalId": { + "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Value returned by a call to CreateEndpoint that can be used for cross-account\n validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a\n cross-account.

" - } - }, - "DmsTransferSettings": { - "target": "com.amazonaws.databasemigrationservice#DmsTransferSettings", - "traits": { - "smithy.api#documentation": "

The settings in JSON format for the DMS transfer type of source endpoint.

\n

Possible settings include the following:

\n \n

Shorthand syntax for these settings is as follows:\n ServiceAccessRoleArn=string,BucketName=string,CompressionType=string\n

\n

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\":\n \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } \n

" - } - }, - "SslMode": { - "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", - "traits": { - "smithy.api#documentation": "

The SSL mode used to connect to the endpoint. The default value is none.

" - } - }, - "EndpointType": { - "target": "com.amazonaws.databasemigrationservice#ReplicationEndpointTypeValue", - "traits": { - "smithy.api#documentation": "

The type of endpoint. Valid values are source and target.

" - } - }, - "PostgreSQLSettings": { - "target": "com.amazonaws.databasemigrationservice#PostgreSQLSettings", - "traits": { - "smithy.api#documentation": "

The settings for the PostgreSQL source and target endpoint. For more information, see\n the PostgreSQLSettings structure.

" + "smithy.api#documentation": "

The name of the server at the endpoint.

" } }, - "Status": { - "target": "com.amazonaws.databasemigrationservice#String", + "ElasticsearchSettings": { + "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", "traits": { - "smithy.api#documentation": "

The status of the endpoint.

" + "smithy.api#documentation": "

The settings for the Elasticsearch source endpoint. For more information, see the\n ElasticsearchSettings structure.

" } }, - "KinesisSettings": { - "target": "com.amazonaws.databasemigrationservice#KinesisSettings", + "RedshiftSettings": { + "target": "com.amazonaws.databasemigrationservice#RedshiftSettings", "traits": { - "smithy.api#documentation": "

The settings for the Amazon Kinesis target endpoint. For more information, see the\n KinesisSettings structure.

" + "smithy.api#documentation": "

Settings for the Amazon Redshift endpoint.

" } }, - "EndpointIdentifier": { + "ExtraConnectionAttributes": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The database endpoint identifier. Identifiers must begin with a letter and must contain\n only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two\n consecutive hyphens.

" + "smithy.api#documentation": "

Additional connection attributes used to connect to the endpoint.

" } }, "KmsKeyId": { @@ -3386,70 +3443,70 @@ "smithy.api#documentation": "

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

\n

If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key.

\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" } }, - "ExtraConnectionAttributes": { - "target": "com.amazonaws.databasemigrationservice#String", + "NeptuneSettings": { + "target": "com.amazonaws.databasemigrationservice#NeptuneSettings", "traits": { - "smithy.api#documentation": "

Additional connection attributes used to connect to the endpoint.

" + "smithy.api#documentation": "

The settings for the Amazon Neptune target endpoint. For more information, see the\n NeptuneSettings structure.

" } }, - "Username": { - "target": "com.amazonaws.databasemigrationservice#String", + "DmsTransferSettings": { + "target": "com.amazonaws.databasemigrationservice#DmsTransferSettings", "traits": { - "smithy.api#documentation": "

The user name used to connect to the endpoint.

" + "smithy.api#documentation": "

The settings in JSON format for the DMS transfer type of source endpoint.

\n

Possible settings include the following:

\n \n

Shorthand syntax for these settings is as follows:\n ServiceAccessRoleArn=string,BucketName=string,CompressionType=string\n

\n

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\":\n \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } \n

" } }, - "ExternalTableDefinition": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The external table definition.

" + "smithy.api#documentation": "

The status of the endpoint.

" } }, - "DynamoDbSettings": { - "target": "com.amazonaws.databasemigrationservice#DynamoDbSettings", + "CertificateArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The settings for the DynamoDB target endpoint. For more information, see the\n DynamoDBSettings structure.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

" } }, - "SybaseSettings": { - "target": "com.amazonaws.databasemigrationservice#SybaseSettings", + "EndpointIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The settings for the SAP ASE source and target endpoint. For more information, see the\n SybaseSettings structure.

" + "smithy.api#documentation": "

The database endpoint identifier. Identifiers must begin with a letter and must contain\n only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two\n consecutive hyphens.

" } }, - "DatabaseName": { - "target": "com.amazonaws.databasemigrationservice#String", + "OracleSettings": { + "target": "com.amazonaws.databasemigrationservice#OracleSettings", "traits": { - "smithy.api#documentation": "

The name of the database at the endpoint.

" + "smithy.api#documentation": "

The settings for the Oracle source and target endpoint. For more information, see the\n OracleSettings structure.

" } }, - "CertificateArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "PostgreSQLSettings": { + "target": "com.amazonaws.databasemigrationservice#PostgreSQLSettings", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

" + "smithy.api#documentation": "

The settings for the PostgreSQL source and target endpoint. For more information, see\n the PostgreSQLSettings structure.

" } }, - "MongoDbSettings": { - "target": "com.amazonaws.databasemigrationservice#MongoDbSettings", + "EndpointType": { + "target": "com.amazonaws.databasemigrationservice#ReplicationEndpointTypeValue", "traits": { - "smithy.api#documentation": "

The settings for the MongoDB source endpoint. For more information, see the\n MongoDbSettings structure.

" + "smithy.api#documentation": "

The type of endpoint. Valid values are source and target.

" } }, - "ServerName": { - "target": "com.amazonaws.databasemigrationservice#String", + "KafkaSettings": { + "target": "com.amazonaws.databasemigrationservice#KafkaSettings", "traits": { - "smithy.api#documentation": "

The name of the server at the endpoint.

" + "smithy.api#documentation": "

The settings for the Apache Kafka target endpoint. For more information, see the\n KafkaSettings structure.

" } }, - "ElasticsearchSettings": { - "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", "traits": { - "smithy.api#documentation": "

The settings for the Elasticsearch source endpoint. For more information, see the\n ElasticsearchSettings structure.

" + "smithy.api#documentation": "

The SSL mode used to connect to the endpoint. The default value is none.

" } }, - "OracleSettings": { - "target": "com.amazonaws.databasemigrationservice#OracleSettings", + "IBMDb2Settings": { + "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", "traits": { - "smithy.api#documentation": "

The settings for the Oracle source and target endpoint. For more information, see the\n OracleSettings structure.

" + "smithy.api#documentation": "

The settings for the IBM Db2 LUW source endpoint. For more information, see the\n IBMDb2Settings structure.\n

" } }, "Port": { @@ -3458,22 +3515,28 @@ "smithy.api#documentation": "

The port value used to access the endpoint.

" } }, - "KafkaSettings": { - "target": "com.amazonaws.databasemigrationservice#KafkaSettings", + "EngineDisplayName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The settings for the Apache Kafka target endpoint. For more information, see the\n KafkaSettings structure.

" + "smithy.api#documentation": "

The expanded name for the engine name. For example, if the EngineName\n parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"

" } }, - "ServiceAccessRoleArn": { + "ExternalTableDefinition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) used by the service access IAM role.

" + "smithy.api#documentation": "

The external table definition.

" } }, - "EngineDisplayName": { + "Username": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The expanded name for the engine name. For example, if the EngineName\n parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"

" + "smithy.api#documentation": "

The user name used to connect to the endpoint.

" + } + }, + "SybaseSettings": { + "target": "com.amazonaws.databasemigrationservice#SybaseSettings", + "traits": { + "smithy.api#documentation": "

The settings for the SAP ASE source and target endpoint. For more information, see the\n SybaseSettings structure.

" } }, "MicrosoftSQLServerSettings": { @@ -3494,22 +3557,46 @@ "smithy.api#documentation": "

The settings for the S3 target endpoint. For more information, see the\n S3Settings structure.

" } }, - "NeptuneSettings": { - "target": "com.amazonaws.databasemigrationservice#NeptuneSettings", + "EngineName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The settings for the Amazon Neptune target endpoint. For more information, see the\n NeptuneSettings structure.

" + "smithy.api#documentation": "

The database engine name. Valid values, depending on the EndpointType, include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" } }, - "IBMDb2Settings": { - "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", + "DynamoDbSettings": { + "target": "com.amazonaws.databasemigrationservice#DynamoDbSettings", "traits": { - "smithy.api#documentation": "

The settings for the IBM Db2 LUW source endpoint. For more information, see the\n IBMDb2Settings structure.\n

" + "smithy.api#documentation": "

The settings for the DynamoDB target endpoint. For more information, see the\n DynamoDBSettings structure.

" } }, - "RedshiftSettings": { - "target": "com.amazonaws.databasemigrationservice#RedshiftSettings", + "MongoDbSettings": { + "target": "com.amazonaws.databasemigrationservice#MongoDbSettings", "traits": { - "smithy.api#documentation": "

Settings for the Amazon Redshift endpoint.

" + "smithy.api#documentation": "

The settings for the MongoDB source endpoint. For more information, see the\n MongoDbSettings structure.

" + } + }, + "ExternalId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Value returned by a call to CreateEndpoint that can be used for cross-account\n validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a\n cross-account.

" + } + }, + "EndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + } + }, + "KinesisSettings": { + "target": "com.amazonaws.databasemigrationservice#KinesisSettings", + "traits": { + "smithy.api#documentation": "

The settings for the Amazon Kinesis target endpoint. For more information, see the\n KinesisSettings structure.

" + } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used by the service access IAM role.

" } } }, @@ -3529,16 +3616,16 @@ "com.amazonaws.databasemigrationservice#Event": { "type": "structure", "members": { - "SourceIdentifier": { + "Message": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The identifier of an event source.

" + "smithy.api#documentation": "

The event message.

" } }, - "EventCategories": { - "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "SourceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The event categories available for the specified source type.

" + "smithy.api#documentation": "

The identifier of an event source.

" } }, "SourceType": { @@ -3547,10 +3634,10 @@ "smithy.api#documentation": "

The type of AWS DMS resource that generates events.

\n

Valid values: replication-instance | endpoint | replication-task

" } }, - "Message": { - "target": "com.amazonaws.databasemigrationservice#String", + "EventCategories": { + "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", "traits": { - "smithy.api#documentation": "

The event message.

" + "smithy.api#documentation": "

The event categories available for the specified source type.

" } }, "Date": { @@ -3590,7 +3677,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lists categories of events subscribed to, and generated by, the applicable AWS DMS\n resource type.

" + "smithy.api#documentation": "

Lists categories of events subscribed to, and generated by, the applicable AWS DMS\n resource type. This data type appears in response to the \n \n DescribeEventCategories\n \n action.

" } }, "com.amazonaws.databasemigrationservice#EventCategoryGroupList": { @@ -3614,22 +3701,16 @@ "com.amazonaws.databasemigrationservice#EventSubscription": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.databasemigrationservice#Boolean", - "traits": { - "smithy.api#documentation": "

Boolean value that indicates if the event subscription is enabled.

" - } - }, - "SnsTopicArn": { + "SourceType": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The topic ARN of the AWS DMS event notification subscription.

" + "smithy.api#documentation": "

The type of AWS DMS resource that generates events.

\n

Valid values: replication-instance | replication-server | security-group |\n replication-task

" } }, - "CustSubscriptionId": { - "target": "com.amazonaws.databasemigrationservice#String", + "EventCategoriesList": { + "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", "traits": { - "smithy.api#documentation": "

The AWS DMS event notification subscription Id.

" + "smithy.api#documentation": "

A lists of event categories.

" } }, "CustomerAwsId": { @@ -3638,22 +3719,22 @@ "smithy.api#documentation": "

The AWS customer account associated with the AWS DMS event notification\n subscription.

" } }, - "SubscriptionCreationTime": { - "target": "com.amazonaws.databasemigrationservice#String", + "Enabled": { + "target": "com.amazonaws.databasemigrationservice#Boolean", "traits": { - "smithy.api#documentation": "

The time the AWS DMS event notification subscription was created.

" + "smithy.api#documentation": "

Boolean value that indicates if the event subscription is enabled.

" } }, - "EventCategoriesList": { - "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "SubscriptionCreationTime": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A lists of event categories.

" + "smithy.api#documentation": "

The time the AWS DMS event notification subscription was created.

" } }, - "SourceType": { + "CustSubscriptionId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of AWS DMS resource that generates events.

\n

Valid values: replication-instance | replication-server | security-group |\n replication-task

" + "smithy.api#documentation": "

The AWS DMS event notification subscription Id.

" } }, "SourceIdsList": { @@ -3667,6 +3748,12 @@ "traits": { "smithy.api#documentation": "

The status of the AWS DMS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission |\n topic-not-exist

\n

The status \"no-permission\" indicates that AWS DMS no longer has permission to post to\n the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the\n subscription was created.

" } + }, + "SnsTopicArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The topic ARN of the AWS DMS event notification subscription.

" + } } }, "traits": { @@ -3710,7 +3797,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* or similar operation.

" + "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.

" } }, "com.amazonaws.databasemigrationservice#FilterList": { @@ -3734,10 +3821,22 @@ "com.amazonaws.databasemigrationservice#IBMDb2Settings": { "type": "structure", "members": { - "Port": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" + } + }, + "CurrentLsn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

For ongoing replication (CDC), use CurrentLSN to specify a\n log sequence number (LSN) where you want the replication\n to start.

" + } + }, + "MaxKBytesPerRead": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint TCP port.

" + "smithy.api#documentation": "

Maximum number of bytes per read, as a NUMBER value.\n The default is 64 KB.

" } }, "Password": { @@ -3752,16 +3851,22 @@ "smithy.api#documentation": "

Database name for the endpoint.

" } }, - "Username": { - "target": "com.amazonaws.databasemigrationservice#String", + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint connection user name.

" + "smithy.api#documentation": "

Endpoint TCP port.

" } }, - "ServerName": { + "SetDataCaptureChanges": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Enables ongoing replication (CDC) as a BOOLEAN value. The\n default is true.

" + } + }, + "Username": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" + "smithy.api#documentation": "

Endpoint connection user name.

" } } }, @@ -3795,10 +3900,11 @@ "com.amazonaws.databasemigrationservice#ImportCertificateMessage": { "type": "structure", "members": { - "CertificateWallet": { - "target": "com.amazonaws.databasemigrationservice#CertificateWallet", + "CertificateIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL.

" + "smithy.api#documentation": "

A customer-assigned name for the certificate. Identifiers must begin with a letter and\n must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or\n contain two consecutive hyphens.

", + "smithy.api#required": {} } }, "CertificatePem": { @@ -3807,11 +3913,10 @@ "smithy.api#documentation": "

The contents of a .pem file, which contains an X.509 certificate.

" } }, - "CertificateIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "CertificateWallet": { + "target": "com.amazonaws.databasemigrationservice#CertificateWallet", "traits": { - "smithy.api#documentation": "

A customer-assigned name for the certificate. Identifiers must begin with a letter and\n must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or\n contain two consecutive hyphens.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL.

" } }, "Tags": { @@ -4001,10 +4106,10 @@ "com.amazonaws.databasemigrationservice#KafkaSettings": { "type": "structure", "members": { - "MessageFormat": { - "target": "com.amazonaws.databasemigrationservice#MessageFormatValue", + "PartitionIncludeSchemaTable": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The output format for the records created on the endpoint. The message format is\n JSON (default) or JSON_UNFORMATTED (a single line with no\n tab).

" + "smithy.api#documentation": "

Prefixes schema and table names to partition values, when the partition type is\n primary-key-type. Doing this increases data distribution among Kafka\n partitions. For example, suppose that a SysBench schema has thousands of tables and each\n table has only limited range for a primary key. In this case, the same primary key is sent\n from thousands of tables to the same partition, which causes throttling. The default is\n false.

" } }, "Broker": { @@ -4013,40 +4118,52 @@ "smithy.api#documentation": "

The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker \n in the form \n broker-hostname-or-ip:port\n . For example, \"ec2-12-345-678-901.compute-1.amazonaws.com:2345\".

" } }, - "PartitionIncludeSchemaTable": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "Topic": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The topic to which you migrate the data. If you don't specify a topic, AWS DMS\n specifies \"kafka-default-topic\" as the migration topic.

" + } + }, + "MessageMaxBytes": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Prefixes schema and table names to partition values, when the partition type is\n primary-key-type. Doing this increases data distribution among Kafka\n partitions. For example, suppose that a SysBench schema has thousands of tables and each\n table has only limited range for a primary key. In this case, the same primary key is sent\n from thousands of tables to the same partition, which causes throttling. The default is\n False.

" + "smithy.api#documentation": "

The maximum size in bytes for records created on the endpoint The default is 1,000,000.

" } }, "IncludeTableAlterOperations": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Includes any data definition language (DDL) operations that change the table in the\n control data, such as rename-table, drop-table,\n add-column, drop-column, and rename-column. The\n default is False.

" + "smithy.api#documentation": "

Includes any data definition language (DDL) operations that change the table in the\n control data, such as rename-table, drop-table,\n add-column, drop-column, and rename-column. The\n default is false.

" } }, - "IncludePartitionValue": { + "IncludeNullAndEmpty": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Shows the partition value within the Kafka message output, unless the partition type is\n schema-table-type. The default is False.

" + "smithy.api#documentation": "

Include NULL and empty columns for records migrated to the endpoint. The default is false.

" } }, - "Topic": { - "target": "com.amazonaws.databasemigrationservice#String", + "IncludeControlDetails": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The topic to which you migrate the data. If you don't specify a topic, AWS DMS\n specifies \"kafka-default-topic\" as the migration topic.

" + "smithy.api#documentation": "

Shows detailed control information for table definition, column definition, and table\n and column changes in the Kafka message output. The default is false.

" } }, - "IncludeControlDetails": { + "MessageFormat": { + "target": "com.amazonaws.databasemigrationservice#MessageFormatValue", + "traits": { + "smithy.api#documentation": "

The output format for the records created on the endpoint. The message format is\n JSON (default) or JSON_UNFORMATTED (a single line with no\n tab).

" + } + }, + "IncludePartitionValue": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Shows detailed control information for table definition, column definition, and table\n and column changes in the Kafka message output. The default is False.

" + "smithy.api#documentation": "

Shows the partition value within the Kafka message output, unless the partition type is\n schema-table-type. The default is false.

" } }, "IncludeTransactionDetails": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Provides detailed transaction information from the source database. This information\n includes a commit timestamp, a log position, and values for transaction_id,\n previous transaction_id, and transaction_record_id (the record\n offset within a transaction). The default is False.

" + "smithy.api#documentation": "

Provides detailed transaction information from the source database. This information\n includes a commit timestamp, a log position, and values for transaction_id,\n previous transaction_id, and transaction_record_id (the record\n offset within a transaction). The default is false.

" } } }, @@ -4063,16 +4180,16 @@ "com.amazonaws.databasemigrationservice#KinesisSettings": { "type": "structure", "members": { - "IncludeTransactionDetails": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Provides detailed transaction information from the source database. This information\n includes a commit timestamp, a log position, and values for transaction_id,\n previous transaction_id, and transaction_record_id (the record\n offset within a transaction). The default is False.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role\n that AWS DMS uses to write to the Kinesis data stream.

" } }, - "PartitionIncludeSchemaTable": { + "IncludeNullAndEmpty": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Prefixes schema and table names to partition values, when the partition type is\n primary-key-type. Doing this increases data distribution among Kinesis\n shards. For example, suppose that a SysBench schema has thousands of tables and each table\n has only limited range for a primary key. In this case, the same primary key is sent from\n thousands of tables to the same shard, which causes throttling. The default is False.

" + "smithy.api#documentation": "

Include NULL and empty columns for records migrated to the endpoint. The default is false.

" } }, "StreamArn": { @@ -4081,16 +4198,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

" } }, + "PartitionIncludeSchemaTable": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Prefixes schema and table names to partition values, when the partition type is\n primary-key-type. Doing this increases data distribution among Kinesis\n shards. For example, suppose that a SysBench schema has thousands of tables and each table\n has only limited range for a primary key. In this case, the same primary key is sent from\n thousands of tables to the same shard, which causes throttling. The default is false.

" + } + }, "IncludeTableAlterOperations": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Includes any data definition language (DDL) operations that change the table in the\n control data, such as rename-table, drop-table,\n add-column, drop-column, and rename-column. The\n default is False.

" + "smithy.api#documentation": "

Includes any data definition language (DDL) operations that change the table in the\n control data, such as rename-table, drop-table,\n add-column, drop-column, and rename-column. The\n default is false.

" } }, - "ServiceAccessRoleArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "IncludeTransactionDetails": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role\n that AWS DMS uses to write to the Kinesis data stream.

" + "smithy.api#documentation": "

Provides detailed transaction information from the source database. This information\n includes a commit timestamp, a log position, and values for transaction_id,\n previous transaction_id, and transaction_record_id (the record\n offset within a transaction). The default is false.

" } }, "MessageFormat": { @@ -4102,13 +4225,13 @@ "IncludeControlDetails": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Shows detailed control information for table definition, column definition, and table\n and column changes in the Kinesis message output. The default is False.

" + "smithy.api#documentation": "

Shows detailed control information for table definition, column definition, and table\n and column changes in the Kinesis message output. The default is false.

" } }, "IncludePartitionValue": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Shows the partition value within the Kinesis message output, unless the partition type\n is schema-table-type. The default is False.

" + "smithy.api#documentation": "

Shows the partition value within the Kinesis message output, unless the partition type\n is schema-table-type. The default is false.

" } } }, @@ -4130,7 +4253,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags for an AWS DMS resource.

" + "smithy.api#documentation": "

Lists all metadata tags attached to an AWS DMS resource, including \n replication instance, endpoint, security group, and migration task. \n For more information, see \n Tag\n data type description.

" } }, "com.amazonaws.databasemigrationservice#ListTagsForResourceMessage": { @@ -4183,10 +4306,28 @@ "com.amazonaws.databasemigrationservice#MicrosoftSQLServerSettings": { "type": "structure", "members": { - "Username": { + "ReadBackupOnly": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When this attribute is set to Y, AWS DMS only reads changes\n from transaction log backups and doesn't read from the\n active transaction log file during ongoing replication. Setting\n this parameter to Y enables you to control active transaction\n log file growth during full load and ongoing replication\n tasks. However, it can add some source latency to ongoing\n replication.

" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Endpoint TCP port.

" + } + }, + "BcpPacketSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum size of the packets (in bytes) used to transfer\n data using BCP.

" + } + }, + "DatabaseName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Endpoint connection user name.

" + "smithy.api#documentation": "

Database name for the endpoint.

" } }, "ServerName": { @@ -4195,10 +4336,22 @@ "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" } }, - "DatabaseName": { + "SafeguardPolicy": { + "target": "com.amazonaws.databasemigrationservice#SafeguardPolicy", + "traits": { + "smithy.api#documentation": "

Use this attribute to minimize the need to access the\n backup log and enable AWS DMS to prevent truncation using one of the\n following two methods.

\n

\n Start transactions in the database: This is the default\n method. When this method is used, AWS DMS prevents\n TLOG truncation by mimicking a transaction in the database.\n As long as such a transaction is open, changes that appear\n after the transaction started aren't truncated. If you need\n Microsoft Replication to be enabled in your database, then\n you must choose this method.

\n

\n Exclusively use sp_repldone within a single task: When\n this method is used, AWS DMS reads the changes and then\n uses sp_repldone to mark the TLOG transactions as ready\n for truncation. Although this method doesn't involve any\n transactional activities, it can only be used when Microsoft\n Replication isn't running. Also, when using this method, only\n one AWS DMS task can access the database at any given\n time. Therefore, if you need to run parallel AWS DMS tasks\n against the same database, use the default method.

" + } + }, + "UseBcpFullLoad": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "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.

" + } + }, + "ControlTablesFileGroup": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Database name for the endpoint.

" + "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.

" } }, "Password": { @@ -4207,10 +4360,10 @@ "smithy.api#documentation": "

Endpoint connection password.

" } }, - "Port": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Username": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Endpoint TCP port.

" + "smithy.api#documentation": "

Endpoint connection user name.

" } } }, @@ -4269,176 +4422,176 @@ "com.amazonaws.databasemigrationservice#ModifyEndpointMessage": { "type": "structure", "members": { - "SybaseSettings": { - "target": "com.amazonaws.databasemigrationservice#SybaseSettings", + "PostgreSQLSettings": { + "target": "com.amazonaws.databasemigrationservice#PostgreSQLSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target SAP ASE endpoint. For information\n about other available settings, see Extra connection attributes\n when using SAP ASE as a source for AWS DMS and Extra connection attributes\n when using SAP ASE as a target for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the source and target PostgreSQL endpoint. For information\n about other available settings, see Extra connection\n attributes when using PostgreSQL as a source for AWS DMS and \n Extra connection attributes when using PostgreSQL as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" } }, - "MicrosoftSQLServerSettings": { - "target": "com.amazonaws.databasemigrationservice#MicrosoftSQLServerSettings", + "EndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For\n information about other available settings, see Extra connection\n attributes when using SQL Server as a source for AWS DMS and \n Extra connection attributes when using SQL Server as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", + "smithy.api#required": {} } }, - "OracleSettings": { - "target": "com.amazonaws.databasemigrationservice#OracleSettings", + "DynamoDbSettings": { + "target": "com.amazonaws.databasemigrationservice#DynamoDbSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target Oracle endpoint. For information about\n other available settings, see Extra connection\n attributes when using Oracle as a source for AWS DMS and \n Extra connection attributes when using Oracle as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other \n available settings, see Using Object Mapping to Migrate\n Data to DynamoDB in the AWS Database Migration Service User\n Guide.\n

" } }, - "EndpointIdentifier": { + "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The database endpoint identifier. Identifiers must begin with a letter and must contain\n only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two\n consecutive hyphens.

" + "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the EndpointType,\n include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" } }, - "ServiceAccessRoleArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "MySQLSettings": { + "target": "com.amazonaws.databasemigrationservice#MySQLSettings", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service access role you want to use to modify\n the endpoint.

" + "smithy.api#documentation": "

Settings in JSON format for the source and target MySQL endpoint. For information about\n other available settings, see Extra connection\n attributes when using MySQL as a source for AWS DMS and Extra\n connection attributes when using a MySQL-compatible database as a target for AWS\n DMS in the AWS Database Migration Service User\n Guide.\n

" } }, - "EndpointType": { - "target": "com.amazonaws.databasemigrationservice#ReplicationEndpointTypeValue", + "S3Settings": { + "target": "com.amazonaws.databasemigrationservice#S3Settings", "traits": { - "smithy.api#documentation": "

The type of endpoint. Valid values are source and target.

" + "smithy.api#documentation": "

Settings in JSON format for the target Amazon S3 endpoint. For more information about\n the available settings, see Extra\n Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" } }, - "Port": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "ExternalTableDefinition": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The port used by the endpoint database.

" + "smithy.api#documentation": "

The external table definition.

" } }, - "SslMode": { - "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "Username": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The SSL mode used to connect to the endpoint. The default value is none.

" + "smithy.api#documentation": "

The user name to be used to login to the endpoint database.

" } }, - "ExtraConnectionAttributes": { - "target": "com.amazonaws.databasemigrationservice#String", + "KafkaSettings": { + "target": "com.amazonaws.databasemigrationservice#KafkaSettings", "traits": { - "smithy.api#documentation": "

Additional attributes associated with the connection. To reset this parameter, pass the\n empty string (\"\") as an argument.

" + "smithy.api#documentation": "

Settings in JSON format for the target Apache Kafka endpoint. For more information about\n the available settings, see Using Apache Kafka as a Target for AWS\n Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" } }, - "CertificateArn": { + "EndpointIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

" + "smithy.api#documentation": "

The database endpoint identifier. Identifiers must begin with a letter and must contain\n only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two\n consecutive hyphens.

" } }, - "DatabaseName": { - "target": "com.amazonaws.databasemigrationservice#String", + "MicrosoftSQLServerSettings": { + "target": "com.amazonaws.databasemigrationservice#MicrosoftSQLServerSettings", "traits": { - "smithy.api#documentation": "

The name of the endpoint database.

" + "smithy.api#documentation": "

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For\n information about other available settings, see Extra connection\n attributes when using SQL Server as a source for AWS DMS and \n Extra connection attributes when using SQL Server as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" } }, - "Username": { - "target": "com.amazonaws.databasemigrationservice#String", + "OracleSettings": { + "target": "com.amazonaws.databasemigrationservice#OracleSettings", "traits": { - "smithy.api#documentation": "

The user name to be used to login to the endpoint database.

" + "smithy.api#documentation": "

Settings in JSON format for the source and target Oracle endpoint. For information about\n other available settings, see Extra connection\n attributes when using Oracle as a source for AWS DMS and \n Extra connection attributes when using Oracle as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" } }, - "ExternalTableDefinition": { - "target": "com.amazonaws.databasemigrationservice#String", + "IBMDb2Settings": { + "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", "traits": { - "smithy.api#documentation": "

The external table definition.

" + "smithy.api#documentation": "

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other\n available settings, see Extra connection attributes\n when using Db2 LUW as a source for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" } }, - "DynamoDbSettings": { - "target": "com.amazonaws.databasemigrationservice#DynamoDbSettings", + "DmsTransferSettings": { + "target": "com.amazonaws.databasemigrationservice#DmsTransferSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other \n available settings, see Using Object Mapping to Migrate\n Data to DynamoDB in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

The settings in JSON format for the DMS transfer type of source endpoint.

\n

Attributes include the following:

\n \n

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string\n ,BucketName=string,CompressionType=string\n

\n

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\": \"string\",\n \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } \n

" } }, - "EngineName": { + "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the EndpointType,\n include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" + "smithy.api#documentation": "

The name of the server where the endpoint database resides.

" } }, - "PostgreSQLSettings": { - "target": "com.amazonaws.databasemigrationservice#PostgreSQLSettings", + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target PostgreSQL endpoint. For information\n about other available settings, see Extra connection\n attributes when using PostgreSQL as a source for AWS DMS and \n Extra connection attributes when using PostgreSQL as a target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

The port used by the endpoint database.

" } }, - "DmsTransferSettings": { - "target": "com.amazonaws.databasemigrationservice#DmsTransferSettings", + "CertificateArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The settings in JSON format for the DMS transfer type of source endpoint.

\n

Attributes include the following:

\n \n

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string\n ,BucketName=string,CompressionType=string\n

\n

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\": \"string\",\n \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } \n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

" } }, - "ServerName": { - "target": "com.amazonaws.databasemigrationservice#String", + "MongoDbSettings": { + "target": "com.amazonaws.databasemigrationservice#MongoDbSettings", "traits": { - "smithy.api#documentation": "

The name of the server where the endpoint database resides.

" + "smithy.api#documentation": "

Settings in JSON format for the source MongoDB endpoint. For more information about the\n available settings, see the configuration properties section in Using MongoDB as a Target for AWS\n Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" } }, - "ElasticsearchSettings": { - "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", + "NeptuneSettings": { + "target": "com.amazonaws.databasemigrationservice#NeptuneSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Elasticsearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in\n the AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target Amazon Neptune endpoint. For more information\n about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target \n in the AWS Database Migration Service User Guide.\n

" } }, - "KinesisSettings": { - "target": "com.amazonaws.databasemigrationservice#KinesisSettings", + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For\n more information about the available settings, see Using Amazon Kinesis Data Streams \n as a Target for AWS Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

The name of the endpoint database.

" } }, "RedshiftSettings": { "target": "com.amazonaws.databasemigrationservice#RedshiftSettings" }, - "MySQLSettings": { - "target": "com.amazonaws.databasemigrationservice#MySQLSettings", + "ExtraConnectionAttributes": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source and target MySQL endpoint. For information about\n other available settings, see Extra connection\n attributes when using MySQL as a source for AWS DMS and Extra\n connection attributes when using a MySQL-compatible database as a target for AWS\n DMS in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

Additional attributes associated with the connection. To reset this parameter, pass the\n empty string (\"\") as an argument.

" } }, - "EndpointArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "SybaseSettings": { + "target": "com.amazonaws.databasemigrationservice#SybaseSettings", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Settings in JSON format for the source and target SAP ASE endpoint. For information\n about other available settings, see Extra connection attributes\n when using SAP ASE as a source for AWS DMS and Extra connection attributes\n when using SAP ASE as a target for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" } }, - "IBMDb2Settings": { - "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other\n available settings, see Extra connection attributes\n when using Db2 LUW as a source for AWS DMS in the AWS Database\n Migration Service User Guide.\n

" + "smithy.api#documentation": "

The password to be used to login to the endpoint database.

" } }, - "S3Settings": { - "target": "com.amazonaws.databasemigrationservice#S3Settings", + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Amazon S3 endpoint. For more information about\n the available settings, see Extra\n Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service access role you want to use to modify\n the endpoint.

" } }, - "NeptuneSettings": { - "target": "com.amazonaws.databasemigrationservice#NeptuneSettings", + "ElasticsearchSettings": { + "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Amazon Neptune endpoint. For more information\n about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target \n in the AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target Elasticsearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in\n the AWS Database Migration Service User Guide.\n

" } }, - "KafkaSettings": { - "target": "com.amazonaws.databasemigrationservice#KafkaSettings", + "KinesisSettings": { + "target": "com.amazonaws.databasemigrationservice#KinesisSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Apache Kafka endpoint. For more information about\n the available settings, see Using Apache Kafka as a Target for AWS\n Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For\n more information about the available settings, see Using Amazon Kinesis Data Streams \n as a Target for AWS Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" } }, - "MongoDbSettings": { - "target": "com.amazonaws.databasemigrationservice#MongoDbSettings", + "EndpointType": { + "target": "com.amazonaws.databasemigrationservice#ReplicationEndpointTypeValue", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the source MongoDB endpoint. For more information about the\n available settings, see the configuration properties section in Using MongoDB as a Target for AWS\n Database Migration Service in the AWS Database Migration Service User\n Guide.\n

" + "smithy.api#documentation": "

The type of endpoint. Valid values are source and target.

" } }, - "Password": { - "target": "com.amazonaws.databasemigrationservice#SecretString", + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", "traits": { - "smithy.api#documentation": "

The password to be used to login to the endpoint database.

" + "smithy.api#documentation": "

The SSL mode used to connect to the endpoint. The default value is none.

" } } }, @@ -4504,10 +4657,10 @@ "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionMessage": { "type": "structure", "members": { - "EventCategories": { - "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "SnsTopicArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A list of event categories for a source type that you want to subscribe to. Use the\n DescribeEventCategories action to see a list of event categories.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.\n The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" } }, "Enabled": { @@ -4516,23 +4669,23 @@ "smithy.api#documentation": "

A Boolean value; set to true to activate the\n subscription.

" } }, - "SubscriptionName": { + "SourceType": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the AWS DMS event notification subscription to be modified.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The type of AWS DMS resource that generates the events you want to subscribe to.

\n

Valid values: replication-instance | replication-task

" } }, - "SnsTopicArn": { + "SubscriptionName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.\n The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + "smithy.api#documentation": "

The name of the AWS DMS event notification subscription to be modified.

", + "smithy.api#required": {} } }, - "SourceType": { - "target": "com.amazonaws.databasemigrationservice#String", + "EventCategories": { + "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", "traits": { - "smithy.api#documentation": "

The type of AWS DMS resource that generates the events you want to subscribe to.

\n

Valid values: replication-instance | replication-task

" + "smithy.api#documentation": "

A list of event categories for a source type that you want to subscribe to. Use the\n DescribeEventCategories action to see a list of event categories.

" } } }, @@ -4592,17 +4745,10 @@ "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceMessage": { "type": "structure", "members": { - "ReplicationInstanceClass": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" - } - }, - "ReplicationInstanceArn": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter does not result in an outage, except in the\n following situation, and the change is asynchronously applied as soon as possible. If\n moving this window to the current time, there must be at least 30 minutes between the\n current time and end of the window to ensure pending changes are applied.

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" } }, "AutoMinorVersionUpgrade": { @@ -4611,6 +4757,12 @@ "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 " } }, + "ReplicationInstanceClass": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" + } + }, "VpcSecurityGroupIds": { "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", "traits": { @@ -4623,34 +4775,35 @@ "smithy.api#documentation": "

Indicates that major version upgrades are allowed. Changing this parameter does not\n result in an outage, and the change is asynchronously applied as soon as possible.

\n

This parameter must be set to true when specifying a value for the\n EngineVersion parameter that is a different major version than the\n replication instance's current version.

" } }, - "MultiAZ": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "EngineVersion": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.

" + "smithy.api#documentation": "

The engine version number of the replication instance.

\n

When modifying a major engine version of an instance, also set \n AllowMajorVersionUpgrade to true.

" } }, - "ApplyImmediately": { - "target": "com.amazonaws.databasemigrationservice#Boolean", + "ReplicationInstanceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates whether the changes should be applied immediately or during the next\n maintenance window.

" + "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

" } }, - "EngineVersion": { - "target": "com.amazonaws.databasemigrationservice#String", + "ApplyImmediately": { + "target": "com.amazonaws.databasemigrationservice#Boolean", "traits": { - "smithy.api#documentation": "

The engine version number of the replication instance.

" + "smithy.api#documentation": "

Indicates whether the changes should be applied immediately or during the next\n maintenance window.

" } }, - "ReplicationInstanceIdentifier": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

", + "smithy.api#required": {} } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.databasemigrationservice#String", + "MultiAZ": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter does not result in an outage, except in the\n following situation, and the change is asynchronously applied as soon as possible. If\n moving this window to the current time, there must be at least 30 minutes between the\n current time and end of the window to ensure pending changes are applied.

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" + "smithy.api#documentation": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.

" } }, "AllocatedStorage": { @@ -4781,10 +4934,10 @@ "com.amazonaws.databasemigrationservice#ModifyReplicationTaskMessage": { "type": "structure", "members": { - "TableMappings": { - "target": "com.amazonaws.databasemigrationservice#String", + "MigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", "traits": { - "smithy.api#documentation": "

When using the AWS CLI or boto3, provide the path of the JSON file that contains the\n table mappings. Precede the path with file://. When working with the DMS API,\n provide the JSON as the parameter value, for example: --table-mappings\n file://mappingfile.json\n

" + "smithy.api#documentation": "

The migration type. Valid values: full-load | cdc | full-load-and-cdc\n

" } }, "CdcStartPosition": { @@ -4793,10 +4946,10 @@ "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start.\n Specifying both values results in an error.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

\n

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

\n \n

When you use this task setting with a source PostgreSQL database, a logical\n replication slot should already be created and associated with the source endpoint. You\n can verify this by setting the slotName extra connection attribute to the\n name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source\n for AWS DMS.

\n " } }, - "ReplicationTaskSettings": { + "CdcStopPosition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

JSON file that contains settings for the task, such as task metadata settings.

" + "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

" } }, "ReplicationTaskIdentifier": { @@ -4805,29 +4958,29 @@ "smithy.api#documentation": "

The replication task identifier.

\n

Constraints:

\n " } }, - "CdcStopPosition": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", + "smithy.api#required": {} } }, - "ReplicationTaskArn": { + "TaskData": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n AWS Database Migration Service User Guide.\n

" } }, - "MigrationType": { - "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "ReplicationTaskSettings": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The migration type. Valid values: full-load | cdc | full-load-and-cdc\n

" + "smithy.api#documentation": "

JSON file that contains settings for the task, such as task metadata settings.

" } }, - "TaskData": { + "TableMappings": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

When using the AWS CLI or boto3, provide the path of the JSON file that contains the\n table mappings. Precede the path with file://. When working with the DMS API,\n provide the JSON as the parameter value, for example: --table-mappings\n file://mappingfile.json\n

" } }, "CdcStartTime": { @@ -4858,58 +5011,34 @@ "com.amazonaws.databasemigrationservice#MongoDbSettings": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.databasemigrationservice#String", - "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.

" - } - }, - "ExtractDocId": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

Specifies the document ID. Use this setting when NestingLevel is set to\n \"none\".

\n

Default value is \"false\".

" - } - }, - "Port": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port value for the MongoDB source endpoint.

" - } - }, - "AuthType": { - "target": "com.amazonaws.databasemigrationservice#AuthTypeValue", - "traits": { - "smithy.api#documentation": "

The authentication type you use to access the MongoDB source endpoint.

\n

When when set to \"no\", user name and password parameters are not used and\n can be empty.

" - } - }, "Password": { "target": "com.amazonaws.databasemigrationservice#SecretString", "traits": { "smithy.api#documentation": "

The password for the user account you use to access the MongoDB source endpoint.\n

" } }, - "ServerName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The name of the server on the MongoDB source endpoint.

" - } - }, "NestingLevel": { "target": "com.amazonaws.databasemigrationservice#NestingLevelValue", "traits": { "smithy.api#documentation": "

Specifies either document or table mode.

\n

Default value is \"none\". Specify \"none\" to use document mode.\n Specify \"one\" to use table mode.

" } }, + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of the server on the MongoDB source endpoint.

" + } + }, "Username": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

The user name you use to access the MongoDB source endpoint.

" } }, - "DatabaseName": { + "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The database name on the MongoDB source endpoint.

" + "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.

" } }, "AuthMechanism": { @@ -4918,19 +5047,43 @@ "smithy.api#documentation": "

The authentication mechanism you use to access the MongoDB source endpoint.

\n

For the default value, in MongoDB version 2.x, \"default\" is\n \"mongodb_cr\". For MongoDB version 3.x or later, \"default\" is\n \"scram_sha_1\". This setting isn't used when AuthType is\n set to \"no\".

" } }, - "DocsToInvestigate": { + "AuthSource": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates the number of documents to preview to determine the document organization.\n Use this setting when NestingLevel is set to \"one\".

\n

Must be a positive value greater than 0. Default value is\n 1000.

" + "smithy.api#documentation": "

The MongoDB database name. This setting isn't used when AuthType is\n set to \"no\".

\n

The default is \"admin\".

" } }, - "AuthSource": { + "DatabaseName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The MongoDB database name. This setting isn't used when AuthType is\n set to \"no\".

\n

The default is \"admin\".

" + "smithy.api#documentation": "

The database name on the MongoDB source endpoint.

" } - } - }, + }, + "AuthType": { + "target": "com.amazonaws.databasemigrationservice#AuthTypeValue", + "traits": { + "smithy.api#documentation": "

The authentication type you use to access the MongoDB source endpoint.

\n

When when set to \"no\", user name and password parameters are not used and\n can be empty.

" + } + }, + "ExtractDocId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Specifies the document ID. Use this setting when NestingLevel is set to\n \"none\".

\n

Default value is \"false\".

" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port value for the MongoDB source endpoint.

" + } + }, + "DocsToInvestigate": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Indicates the number of documents to preview to determine the document organization.\n Use this setting when NestingLevel is set to \"one\".

\n

Must be a positive value greater than 0. Default value is\n 1000.

" + } + } + }, "traits": { "smithy.api#documentation": "

Provides information that defines a MongoDB endpoint.

" } @@ -4938,10 +5091,28 @@ "com.amazonaws.databasemigrationservice#MySQLSettings": { "type": "structure", "members": { - "Port": { + "ParallelLoadThreads": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint TCP port.

" + "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

" + } + }, + "ServerTimezone": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Specifies the time zone for the source MySQL database.

\n

Example: serverTimezone=US/Pacific;\n

\n

Note: Do not enclose time zones in single quotes.

" + } + }, + "MaxFileSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the maximum size (in KB) of any .csv file used to\n transfer data to a MySQL-compatible database.

\n

Example: maxFileSize=512\n

" + } + }, + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

Endpoint connection password.

" } }, "Username": { @@ -4950,6 +5121,24 @@ "smithy.api#documentation": "

Endpoint connection user name.

" } }, + "TargetDbType": { + "target": "com.amazonaws.databasemigrationservice#TargetDbType", + "traits": { + "smithy.api#documentation": "

Specifies where to migrate source tables on the target, either\n to a single database or multiple databases.

\n

Example: targetDbType=MULTIPLE_DATABASES\n

" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Endpoint TCP port.

" + } + }, + "AfterConnectScript": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Specifies a script to run immediately after AWS DMS\n connects to the endpoint. The migration task continues\n running regardless if the SQL statement succeeds or fails.

" + } + }, "DatabaseName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -4962,10 +5151,10 @@ "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" } }, - "Password": { - "target": "com.amazonaws.databasemigrationservice#SecretString", + "EventsPollInterval": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint connection password.

" + "smithy.api#documentation": "

Specifies how often to check the binary log for new\n changes/events when the database is idle.

\n

Example: eventsPollInterval=5;\n

\n

In the example, AWS DMS checks for changes in the binary\n logs every five seconds.

" } } }, @@ -4976,13 +5165,6 @@ "com.amazonaws.databasemigrationservice#NeptuneSettings": { "type": "structure", "members": { - "S3BucketFolder": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

A folder path where you want AWS DMS to store migrated graph data in the S3 bucket\n specified by S3BucketName\n

", - "smithy.api#required": {} - } - }, "MaxRetryCount": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { @@ -4995,10 +5177,11 @@ "smithy.api#documentation": "

The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS\n DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the\n bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of\n migrated graph data.

" } }, - "IamAuthEnabled": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "S3BucketFolder": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

If you want AWS Identity and Access Management (IAM) authorization enabled for this\n endpoint, set this parameter to true. Then attach the appropriate IAM policy\n document to your service role specified by ServiceAccessRoleArn. The default\n is false.

" + "smithy.api#documentation": "

A folder path where you want AWS DMS to store migrated graph data in the S3 bucket\n specified by S3BucketName\n

", + "smithy.api#required": {} } }, "S3BucketName": { @@ -5008,6 +5191,12 @@ "smithy.api#required": {} } }, + "IamAuthEnabled": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

If you want AWS Identity and Access Management (IAM) authorization enabled for this\n endpoint, set this parameter to true. Then attach the appropriate IAM policy\n document to your service role specified by ServiceAccessRoleArn. The default\n is false.

" + } + }, "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -5043,28 +5232,40 @@ "com.amazonaws.databasemigrationservice#OracleSettings": { "type": "structure", "members": { - "DatabaseName": { + "OraclePathPrefix": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Database name for the endpoint.

" + "smithy.api#documentation": "

Set this string attribute to the required value in order to use\n the Binary Reader to capture change data for an Amazon\n RDS for Oracle as the source. This value specifies the\n default Oracle root used to access the redo logs.

" } }, - "Password": { - "target": "com.amazonaws.databasemigrationservice#SecretString", + "ReadAheadBlocks": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint connection password.

" + "smithy.api#documentation": "

Set this attribute to change the number of read-ahead\n blocks that DMS configures to perform a Change Data\n Capture (CDC) load using Oracle Automatic Storage\n Management (ASM). You can specify an integer value\n between 1000 (the default) and 200,000 (the maximum).

" } }, - "AsmUser": { - "target": "com.amazonaws.databasemigrationservice#String", + "AccessAlternateDirectly": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

For an Oracle source endpoint, your ASM user name. You can set this value from the\n asm_user value. You set asm_user as part of the extra\n connection attribute string to access an Oracle server with Binary Reader that uses ASM.\n For more information, see Configuration for change data capture (CDC) on an Oracle source\n database.

" + "smithy.api#documentation": "

Set this attribute to false in order to use the Binary Reader\n to capture change data for an Amazon RDS for Oracle as the\n source. This tells the DMS instance to not access redo logs\n through any specified path prefix replacement using direct\n file access.

" } }, - "SecurityDbEncryptionName": { + "RetryInterval": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the number of seconds that the system waits\n before resending a query.

\n

Example: retryInterval=6;\n

" + } + }, + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

Endpoint connection password.

" + } + }, + "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

For an Oracle source endpoint, the name of a key used for the transparent data\n encryption (TDE) of the columns and tablespaces in an Oracle source database that is\n encrypted using TDE. The key value is the value of the SecurityDbEncryption\n setting. For more information on setting the key name value of\n SecurityDbEncryptionName, see the information and example for setting the\n securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for AWS\n DMS in the AWS Database Migration Service User\n Guide.

" + "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" } }, "SecurityDbEncryption": { @@ -5073,22 +5274,70 @@ "smithy.api#documentation": "

For an Oracle source endpoint, the transparent data encryption (TDE) password required\n by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the\n \n TDE_Password\n part of the comma-separated value you\n set to the Password request parameter when you create the endpoint. The\n SecurityDbEncryptian setting is related to this\n SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for AWS\n DMS in the AWS Database Migration Service User Guide.

" } }, + "DirectPathParallelLoad": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, this attribute specifies a parallel load\n when useDirectPathFullLoad is set to Y. This attribute\n also only applies when you use the AWS DMS parallel load\n feature. Note that the target table cannot have any constraints or indexes.

" + } + }, + "UseAlternateFolderForOnline": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Set this attribute to true in order to use the Binary Reader\n to capture change data for an Amazon RDS for Oracle as\n the source. This tells the DMS instance to use any specified\n prefix replacement to access all online redo logs.

" + } + }, "AsmPassword": { "target": "com.amazonaws.databasemigrationservice#SecretString", "traits": { "smithy.api#documentation": "

For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.\n You can set this value from the \n asm_user_password\n value.\n You set this value as part of the comma-separated value that you set to the\n Password request parameter when you create the endpoint to access\n transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source\n database.

" } }, + "FailTasksOnLobTruncation": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, this attribute causes a task to fail if the\n actual size of an LOB column is greater than the specified\n LobMaxSize.

\n

If a task is set to limited LOB mode and this option is set to\n true, the task fails instead of truncating the LOB data.

" + } + }, + "CharLengthSemantics": { + "target": "com.amazonaws.databasemigrationservice#CharLengthSemantics", + "traits": { + "smithy.api#documentation": "

Specifies whether the length of a character column is in\n bytes or in characters. To indicate that the character column\n length is in characters, set this attribute to CHAR. Otherwise,\n the character column length is in bytes.

\n

Example: charLengthSemantics=CHAR;\n

" + } + }, + "AdditionalArchivedLogDestId": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Set this attribute with archivedLogDestId in a primary/\n standby setup. This attribute is useful in the case of a\n switchover. In this case, AWS DMS needs to know which\n destination to get archive redo logs from to read changes.\n This need arises because the previous primary instance is\n now a standby instance after switchover.

" + } + }, "AsmServer": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

For an Oracle source endpoint, your ASM server address. You can set this value from the\n asm_server value. You set asm_server as part of the extra\n connection attribute string to access an Oracle server with Binary Reader that uses ASM.\n For more information, see Configuration for change data capture (CDC) on an Oracle source\n database.

" } }, - "ServerName": { + "DatabaseName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" + "smithy.api#documentation": "

Database name for the endpoint.

" + } + }, + "DirectPathNoLog": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, this attribute helps to increase the\n commit rate on the Oracle target database by writing\n directly to tables and not writing a trail to database logs.

" + } + }, + "AsmUser": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

For an Oracle source endpoint, your ASM user name. You can set this value from the\n asm_user value. You set asm_user as part of the extra\n connection attribute string to access an Oracle server with Binary Reader that uses ASM.\n For more information, see Configuration for change data capture (CDC) on an Oracle source\n database.

" + } + }, + "NumberDatatypeScale": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the number scale. You can select a scale up to 38,\n or you can select FLOAT. By default, the NUMBER data type\n is converted to precision 38, scale 10.

\n

Example: numberDataTypeScale=12\n

" } }, "Username": { @@ -5097,11 +5346,71 @@ "smithy.api#documentation": "

Endpoint connection user name.

" } }, + "SecurityDbEncryptionName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

For an Oracle source endpoint, the name of a key used for the transparent data\n encryption (TDE) of the columns and tablespaces in an Oracle source database that is\n encrypted using TDE. The key value is the value of the SecurityDbEncryption\n setting. For more information on setting the key name value of\n SecurityDbEncryptionName, see the information and example for setting the\n securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for AWS\n DMS in the AWS Database Migration Service User\n Guide.

" + } + }, + "ArchivedLogsOnly": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When this field is set to Y, AWS DMS only accesses the\n archived redo logs. If the archived redo logs are stored on\n Oracle ASM only, the AWS DMS user account needs to be\n granted ASM privileges.

" + } + }, + "ReadTableSpaceName": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, this attribute supports tablespace\n replication.

" + } + }, "Port": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { "smithy.api#documentation": "

Endpoint TCP port.

" } + }, + "EnableHomogenousTablespace": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Set this attribute to enable homogenous tablespace\n replication and create existing tables or indexes under the\n same tablespace on the target.

" + } + }, + "AddSupplementalLogging": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Set this attribute to set up table-level supplemental logging\n for the Oracle database. This attribute enables PRIMARY KEY\n supplemental logging on all tables selected for a migration\n task.

\n

If you use this option, you still need to enable\n database-level supplemental logging.

" + } + }, + "ArchivedLogDestId": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the destination of the archived redo logs. The\n value should be the same as the DEST_ID number in the\n v$archived_log table. When working with multiple log\n destinations (DEST_ID), we recommend that you to specify\n an archived redo logs location identifier. Doing this improves\n performance by ensuring that the correct logs are accessed\n from the outset.

" + } + }, + "ReplacePathPrefix": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Set this attribute to true in order to use the Binary Reader\n to capture change data for an Amazon RDS for Oracle as the\n source. This setting tells DMS instance to replace the default\n Oracle root with the specified usePathPrefix setting to\n access the redo logs.

" + } + }, + "ParallelAsmReadThreads": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Set this attribute to change the number of threads that\n DMS configures to perform a Change Data Capture (CDC)\n load using Oracle Automatic Storage Management (ASM).\n You can specify an integer value between 2 (the default)\n and 8 (the maximum). Use this attribute together with the\n readAheadBlocks attribute.

" + } + }, + "UsePathPrefix": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Set this string attribute to the required value in order to use\n the Binary Reader to capture change data for an Amazon\n RDS for Oracle as the source. This value specifies the path\n prefix used to replace the default Oracle root to access the\n redo logs.

" + } + }, + "AllowSelectNestedTables": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Set this attribute to true to enable replication of Oracle\n tables containing columns that are nested tables or defined\n types.

" + } } }, "traits": { @@ -5111,16 +5420,16 @@ "com.amazonaws.databasemigrationservice#OrderableReplicationInstance": { "type": "structure", "members": { - "EngineVersion": { + "ReplicationInstanceClass": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The version of the replication engine.

" + "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" } }, - "StorageType": { - "target": "com.amazonaws.databasemigrationservice#String", + "MinAllocatedStorage": { + "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The type of storage used by the replication instance.

" + "smithy.api#documentation": "

The minimum amount of storage (in gigabytes) that can be allocated for the replication\n instance.

" } }, "AvailabilityZones": { @@ -5129,28 +5438,16 @@ "smithy.api#documentation": "

List of Availability Zones for this replication instance.

" } }, - "ReplicationInstanceClass": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" - } - }, - "MinAllocatedStorage": { - "target": "com.amazonaws.databasemigrationservice#Integer", - "traits": { - "smithy.api#documentation": "

The minimum amount of storage (in gigabytes) that can be allocated for the replication\n instance.

" - } - }, "DefaultAllocatedStorage": { "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { "smithy.api#documentation": "

The default amount of storage (in gigabytes) that is allocated for the replication\n instance.

" } }, - "ReleaseStatus": { - "target": "com.amazonaws.databasemigrationservice#ReleaseStatusValues", + "EngineVersion": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The value returned when the specified EngineVersion of the replication \n instance is in Beta or test mode. This indicates some features might not work as expected.

\n \n

AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

\n " + "smithy.api#documentation": "

The version of the replication engine.

" } }, "MaxAllocatedStorage": { @@ -5164,6 +5461,18 @@ "traits": { "smithy.api#documentation": "

The amount of storage (in gigabytes) that is allocated for the replication\n instance.

" } + }, + "StorageType": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The type of storage used by the replication instance.

" + } + }, + "ReleaseStatus": { + "target": "com.amazonaws.databasemigrationservice#ReleaseStatusValues", + "traits": { + "smithy.api#documentation": "

The value returned when the specified EngineVersion of the replication \n instance is in Beta or test mode. This indicates some features might not work as expected.

\n \n

AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

\n " + } } }, "traits": { @@ -5197,22 +5506,22 @@ "com.amazonaws.databasemigrationservice#PendingMaintenanceAction": { "type": "structure", "members": { - "CurrentApplyDate": { + "AutoAppliedAfterDate": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The effective date when the pending maintenance action will be applied to the resource.\n This date takes into account opt-in requests received from the\n ApplyPendingMaintenanceAction API operation, and also the\n AutoAppliedAfterDate and ForcedApplyDate parameter values.\n This value is blank if an opt-in request has not been received and nothing has been\n specified for AutoAppliedAfterDate or ForcedApplyDate.

" + "smithy.api#documentation": "

The date of the maintenance window when the action is to be applied. The maintenance\n action is applied to the resource during its first maintenance window after this date. If\n this date is specified, any next-maintenance opt-in requests are\n ignored.

" } }, - "Description": { - "target": "com.amazonaws.databasemigrationservice#String", + "ForcedApplyDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" + "smithy.api#documentation": "

The date when the maintenance action will be automatically applied. The maintenance\n action is applied to the resource on this date regardless of the maintenance window for the\n resource. If this date is specified, any immediate opt-in requests are\n ignored.

" } }, - "AutoAppliedAfterDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The date of the maintenance window when the action is to be applied. The maintenance\n action is applied to the resource during its first maintenance window after this date. If\n this date is specified, any next-maintenance opt-in requests are\n ignored.

" + "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" } }, "OptInStatus": { @@ -5221,17 +5530,17 @@ "smithy.api#documentation": "

The type of opt-in request that has been received for the resource.

" } }, - "ForcedApplyDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", - "traits": { - "smithy.api#documentation": "

The date when the maintenance action will be automatically applied. The maintenance\n action is applied to the resource on this date regardless of the maintenance window for the\n resource. If this date is specified, any immediate opt-in requests are\n ignored.

" - } - }, "Action": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource.

" } + }, + "CurrentApplyDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

The effective date when the pending maintenance action will be applied to the resource.\n This date takes into account opt-in requests received from the\n ApplyPendingMaintenanceAction API operation, and also the\n AutoAppliedAfterDate and ForcedApplyDate parameter values.\n This value is blank if an opt-in request has not been received and nothing has been\n specified for AutoAppliedAfterDate or ForcedApplyDate.

" + } } }, "traits": { @@ -5259,34 +5568,76 @@ "com.amazonaws.databasemigrationservice#PostgreSQLSettings": { "type": "structure", "members": { + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

Endpoint connection password.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Database name for the endpoint.

" + } + }, + "CaptureDdls": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

To capture DDL events, AWS DMS creates various artifacts in\n the PostgreSQL database when the task starts. You can later\n remove these artifacts.

\n

If this value is set to N, you don't have to create tables or\n triggers on the source database.

" + } + }, + "SlotName": { + "target": "com.amazonaws.databasemigrationservice#String", + "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.

" + } + }, + "DdlArtifactsSchema": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The schema in which the operational DDL database artifacts\n are created.

\n

Example: ddlArtifactsSchema=xyzddlschema;\n

" + } + }, "Username": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

Endpoint connection user name.

" } }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Endpoint TCP port.

" + } + }, "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" } }, - "Password": { - "target": "com.amazonaws.databasemigrationservice#SecretString", + "AfterConnectScript": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Endpoint connection password.

" + "smithy.api#documentation": "

For use with change data capture (CDC) only, this attribute\n has AWS DMS bypass foreign keys and user triggers to\n reduce the time it takes to bulk load data.

\n

Example: afterConnectScript=SET\n session_replication_role='replica'\n

" } }, - "Port": { + "MaxFileSize": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint TCP port.

" + "smithy.api#documentation": "

Specifies the maximum size (in KB) of any .csv file used to\n transfer data to PostgreSQL.

\n

Example: maxFileSize=512\n

" } }, - "DatabaseName": { - "target": "com.amazonaws.databasemigrationservice#String", + "FailTasksOnLobTruncation": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Database name for the endpoint.

" + "smithy.api#documentation": "

When set to true, this value causes a task to fail if the\n actual size of a LOB column is greater than the specified\n LobMaxSize.

\n

If task is set to Limited LOB mode and this option is set to\n true, the task fails instead of truncating the LOB data.

" + } + }, + "ExecuteTimeout": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Sets the client statement timeout for the PostgreSQL\n instance, in seconds. The default value is 60 seconds.

\n

Example: executeTimeout=100;\n

" } } }, @@ -5346,64 +5697,64 @@ "com.amazonaws.databasemigrationservice#RedshiftSettings": { "type": "structure", "members": { - "ReplaceInvalidChars": { - "target": "com.amazonaws.databasemigrationservice#String", + "EncryptionMode": { + "target": "com.amazonaws.databasemigrationservice#EncryptionModeValue", "traits": { - "smithy.api#documentation": "

A list of characters that you want to replace. Use with\n ReplaceChars.

" + "smithy.api#documentation": "

The type of server-side encryption that you want to use for your data. This encryption\n type is part of the endpoint settings or the extra connections attributes for Amazon S3.\n You can choose either SSE_S3 (the default) or SSE_KMS.

\n \n

For the ModifyEndpoint operation, you can change the existing value of the\n EncryptionMode parameter from SSE_KMS to\n SSE_S3. But you can’t change the existing value from SSE_S3\n to SSE_KMS.

\n \n

To use SSE_S3, create an AWS Identity and Access Management (IAM) role with\n a policy that allows \"arn:aws:s3:::*\" to use the following actions:\n \"s3:PutObject\", \"s3:ListBucket\"\n

" } }, - "TimeFormat": { - "target": "com.amazonaws.databasemigrationservice#String", + "EmptyAsNull": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The time format that you want to use. Valid values are auto\n (case-sensitive), 'timeformat_string', 'epochsecs', or\n 'epochmillisecs'. It defaults to 10. Using auto recognizes\n most strings, even some that aren't supported when you use a time format string.

\n

If your date and time values use formats different from each other, set this parameter\n to auto.

" + "smithy.api#documentation": "

A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as\n NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default\n is false.

" } }, - "BucketFolder": { - "target": "com.amazonaws.databasemigrationservice#String", + "TrimBlanks": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The location where the comma-separated value (.csv) files are stored before being\n uploaded to the S3 bucket.

" + "smithy.api#documentation": "

A value that specifies to remove the trailing white space characters from a VARCHAR\n string. This parameter applies only to columns with a VARCHAR data type. Choose\n true to remove unneeded white space. The default is\n false.

" } }, - "RemoveQuotes": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "MaxFileSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies to remove surrounding quotation marks from strings in the\n incoming data. All characters within the quotation marks, including delimiters, are\n retained. Choose true to remove quotation marks. The default is\n false.

" + "smithy.api#documentation": "

The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer \n data to Amazon Redshift. It defaults to 1048576KB (1 GB).

" } }, - "DatabaseName": { - "target": "com.amazonaws.databasemigrationservice#String", + "TruncateColumns": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The name of the Amazon Redshift data warehouse (service) that you are working\n with.

" + "smithy.api#documentation": "

A value that specifies to truncate data in columns to the appropriate number of\n characters, so that the data fits in the column. This parameter applies only to columns\n with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose\n true to truncate data. The default is false.

" } }, - "ReplaceChars": { + "BucketName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value that specifies to replaces the invalid characters specified in\n ReplaceInvalidChars, substituting the specified characters instead. The\n default is \"?\".

" + "smithy.api#documentation": "

The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.

" } }, - "ServerSideEncryptionKmsKeyId": { + "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode,\n provide this key ID. The key that you use needs an attached policy that enables IAM user\n permissions and allows use of the key.

" + "smithy.api#documentation": "

The name of the Amazon Redshift cluster you are using.

" } }, - "BucketName": { + "DateFormat": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket you want to use

" + "smithy.api#documentation": "

The date format that you are using. Valid values are auto (case-sensitive),\n your date format string enclosed in quotes, or NULL. If this parameter is left unset\n (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most\n strings, even some that aren't supported when you use a date format string.

\n

If your date and time values use formats different from each other, set this to\n auto.

" } }, - "ServiceAccessRoleArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "CaseSensitiveNames": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift\n service.

" + "smithy.api#documentation": "

If Amazon Redshift is configured to support case sensitive schema names, set\n CaseSensitiveNames to true. The default is\n false.

" } }, - "TruncateColumns": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "WriteBufferSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies to truncate data in columns to the appropriate number of\n characters, so that the data fits in the column. This parameter applies only to columns\n with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose\n true to truncate data. The default is false.

" + "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).

" } }, "Password": { @@ -5412,64 +5763,88 @@ "smithy.api#documentation": "

The password for the user named in the username property.

" } }, - "FileTransferUploadStreams": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "AfterConnectScript": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The number of threads used to upload a single file. This parameter accepts a value from\n 1 through 64. It defaults to 10.

" + "smithy.api#documentation": "

Code to run after connecting. This parameter should contain the code itself, not the\n name of a file containing the code.

" } }, - "ConnectionTimeout": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "TimeFormat": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value that sets the amount of time to wait (in milliseconds) before timing out,\n beginning from when you initially establish a connection.

" + "smithy.api#documentation": "

The time format that you want to use. Valid values are auto\n (case-sensitive), 'timeformat_string', 'epochsecs', or\n 'epochmillisecs'. It defaults to 10. Using auto recognizes\n most strings, even some that aren't supported when you use a time format string.

\n

If your date and time values use formats different from each other, set this parameter\n to auto.

" } }, - "WriteBufferSize": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The size of the write buffer to use in rows. Valid values range from 1 through 2,048.\n The default is 1,024. Use this setting to tune performance.

" + "smithy.api#documentation": "

The name of the Amazon Redshift data warehouse (service) that you are working\n with.

" } }, - "TrimBlanks": { + "ServerSideEncryptionKmsKeyId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode,\n provide this key ID. The key that you use needs an attached policy that enables IAM user\n permissions and allows use of the key.

" + } + }, + "RemoveQuotes": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that specifies to remove the trailing white space characters from a VARCHAR\n string. This parameter applies only to columns with a VARCHAR data type. Choose\n true to remove unneeded white space. The default is\n false.

" + "smithy.api#documentation": "

A value that specifies to remove surrounding quotation marks from strings in the\n incoming data. All characters within the quotation marks, including delimiters, are\n retained. Choose true to remove quotation marks. The default is\n false.

" } }, - "AfterConnectScript": { + "Username": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Code to run after connecting. This parameter should contain the code itself, not the\n name of a file containing the code.

" + "smithy.api#documentation": "

An Amazon Redshift user name for a registered user.

" } }, - "MaxFileSize": { + "CompUpdate": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

If you set CompUpdate to true Amazon Redshift applies\n automatic compression if the table is empty. This applies even if the table columns already\n have encodings other than RAW. If you set CompUpdate to\n false, automatic compression is disabled and existing column encodings\n aren't changed. The default is true.

" + } + }, + "LoadTimeout": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift. This\n accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).

" + "smithy.api#documentation": "

The amount of time to wait (in milliseconds) before timing out of operations performed \n by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.

" } }, - "Username": { + "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An Amazon Redshift user name for a registered user.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift\n service.

" } }, - "DateFormat": { - "target": "com.amazonaws.databasemigrationservice#String", + "AcceptAnyDate": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The date format that you are using. Valid values are auto (case-sensitive),\n your date format string enclosed in quotes, or NULL. If this parameter is left unset\n (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most\n strings, even some that aren't supported when you use a date format string.

\n

If your date and time values use formats different from each other, set this to\n auto.

" + "smithy.api#documentation": "

A value that indicates to allow any date format, including invalid formats such as\n 00/00/00 00:00:00, to be loaded without generating an error. You can choose\n true or false (the default).

\n

This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with\n the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT\n specification, Amazon Redshift inserts a NULL value into that field.

" } }, - "LoadTimeout": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "ExplicitIds": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The amount of time to wait (in milliseconds) before timing out, beginning from when you\n begin loading.

" + "smithy.api#documentation": "

This setting is only valid for a full-load migration task. Set ExplicitIds\n to true to have tables with IDENTITY columns override their\n auto-generated values with explicit values loaded from the source data files used to\n populate the tables. The default is false.

" } }, - "ServerName": { + "ReplaceChars": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A value that specifies to replaces the invalid characters specified in\n ReplaceInvalidChars, substituting the specified characters instead. The\n default is \"?\".

" + } + }, + "BucketFolder": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon Redshift cluster you are using.

" + "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.

" + } + }, + "ConnectionTimeout": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that sets the amount of time to wait (in milliseconds) before timing out,\n beginning from when you initially establish a connection.

" } }, "Port": { @@ -5478,22 +5853,16 @@ "smithy.api#documentation": "

The port number for Amazon Redshift. The default value is 5439.

" } }, - "EncryptionMode": { - "target": "com.amazonaws.databasemigrationservice#EncryptionModeValue", - "traits": { - "smithy.api#documentation": "

The type of server-side encryption that you want to use for your data. This encryption\n type is part of the endpoint settings or the extra connections attributes for Amazon S3.\n You can choose either SSE_S3 (the default) or SSE_KMS. To use\n SSE_S3, create an AWS Identity and Access Management (IAM) role with a\n policy that allows \"arn:aws:s3:::*\" to use the following actions:\n \"s3:PutObject\", \"s3:ListBucket\"\n

" - } - }, - "EmptyAsNull": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ReplaceInvalidChars": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as\n NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default\n is false.

" + "smithy.api#documentation": "

A list of characters that you want to replace. Use with\n ReplaceChars.

" } }, - "AcceptAnyDate": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "FileTransferUploadStreams": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that indicates to allow any date format, including invalid formats such as\n 00/00/00 00:00:00, to be loaded without generating an error. You can choose\n true or false (the default).

\n

This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with\n the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT\n specification, Amazon Redshift inserts a NULL value into that field.

" + "smithy.api#documentation": "

The number of threads used to upload a single file. This parameter accepts a value from\n 1 through 64. It defaults to 10.

\n

The number of parallel streams used to upload a single .csv file to an S3 bucket using\n S3 Multipart Upload. For more information, see Multipart upload\n overview.

\n

\n FileTransferUploadStreams accepts a value from 1 through 64. It\n defaults to 10.

" } } }, @@ -5530,17 +5899,17 @@ "com.amazonaws.databasemigrationservice#RefreshSchemasMessage": { "type": "structure", "members": { - "ReplicationInstanceArn": { + "EndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", "smithy.api#required": {} } }, - "EndpointArn": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

", "smithy.api#required": {} } } @@ -5566,16 +5935,16 @@ "com.amazonaws.databasemigrationservice#RefreshSchemasStatus": { "type": "structure", "members": { - "LastRefreshDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "Status": { + "target": "com.amazonaws.databasemigrationservice#RefreshSchemasStatusTypeValue", "traits": { - "smithy.api#documentation": "

The date the schema was last refreshed.

" + "smithy.api#documentation": "

The status of the schema.

" } }, - "EndpointArn": { + "LastFailureMessage": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + "smithy.api#documentation": "

The last failure message for the schema.

" } }, "ReplicationInstanceArn": { @@ -5584,16 +5953,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" } }, - "LastFailureMessage": { + "EndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The last failure message for the schema.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" } }, - "Status": { - "target": "com.amazonaws.databasemigrationservice#RefreshSchemasStatusTypeValue", + "LastRefreshDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The status of the schema.

" + "smithy.api#documentation": "

The date the schema was last refreshed.

" } } }, @@ -5669,17 +6038,17 @@ "com.amazonaws.databasemigrationservice#ReloadTablesMessage": { "type": "structure", "members": { - "ReplicationTaskArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "TablesToReload": { + "target": "com.amazonaws.databasemigrationservice#TableListToReload", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", + "smithy.api#documentation": "

The name and schema of the table to be reloaded.

", "smithy.api#required": {} } }, - "TablesToReload": { - "target": "com.amazonaws.databasemigrationservice#TableListToReload", + "ReplicationTaskArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name and schema of the table to be reloaded.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", "smithy.api#required": {} } }, @@ -5716,7 +6085,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes metadata tags from a DMS resource.

" + "smithy.api#documentation": "

Removes metadata tags from an AWS DMS resource, including replication instance, \n endpoint, security group, and migration task. For more information, see \n \n Tag\n \n data type description.

" } }, "com.amazonaws.databasemigrationservice#RemoveTagsFromResourceMessage": { @@ -5766,71 +6135,58 @@ "com.amazonaws.databasemigrationservice#ReplicationInstance": { "type": "structure", "members": { - "VpcSecurityGroups": { - "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

The VPC security group for the instance.

" - } - }, - "ReplicationInstancePublicIpAddress": { + "DnsNameServers": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

The public IP address of the replication instance.

" + "smithy.api#documentation": "

The DNS name servers supported for the replication instance to access your on-premise source or target database.

" } }, - "PendingModifiedValues": { - "target": "com.amazonaws.databasemigrationservice#ReplicationPendingModifiedValues", + "InstanceCreateTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The pending modification values.

" + "smithy.api#documentation": "

The time the replication instance was created.

" } }, - "ReplicationInstanceClass": { + "SecondaryAvailabilityZone": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class.

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" - } - }, - "ReplicationInstancePrivateIpAddresses": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstancePrivateIpAddressList", - "traits": { - "smithy.api#documentation": "

One or more private IP addresses for the replication instance.

" + "smithy.api#documentation": "

The Availability Zone of the standby replication instance in a Multi-AZ\n deployment.

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "FreeUntil": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The amount of storage (in gigabytes) that is allocated for the replication\n instance.

" + "smithy.api#documentation": "

The expiration date of the free replication instance that is part of the Free DMS\n program.

" } }, - "PreferredMaintenanceWindow": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The maintenance window times for the replication instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" } }, - "KmsKeyId": { + "EngineVersion": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An AWS KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key.

\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" + "smithy.api#documentation": "

The engine version number of the replication instance.

\n

If an engine version number is not specified when a replication \n instance is created, the default is the latest engine version available.

\n

When modifying a major engine version of an instance, also set \n AllowMajorVersionUpgrade to true.

" } }, - "DnsNameServers": { + "AvailabilityZone": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The DNS name servers supported for the replication instance to access your on-premise source or target database.

" + "smithy.api#documentation": "

The Availability Zone for the instance.

" } }, - "AvailabilityZone": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Availability Zone for the instance.

" + "smithy.api#documentation": "

The maintenance window times for the replication instance. Any pending upgrades to the\n replication instance are performed during this time.

" } }, - "ReplicationInstanceIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "AllocatedStorage": { + "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n \n

Example: myrepinstance\n

" + "smithy.api#documentation": "

The amount of storage (in gigabytes) that is allocated for the replication\n instance.

" } }, "PubliclyAccessible": { @@ -5839,16 +6195,16 @@ "smithy.api#documentation": "

Specifies the accessibility options for the replication instance. A value of\n true represents an instance with a public IP address. A value of\n false represents an instance with a private IP address. The default value\n is true.

" } }, - "FreeUntil": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "KmsKeyId": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The expiration date of the free replication instance that is part of the Free DMS\n program.

" + "smithy.api#documentation": "

An AWS KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key.

\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" } }, - "InstanceCreateTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "ReplicationInstanceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The time the replication instance was created.

" + "smithy.api#documentation": "

The replication instance identifier is a required parameter. This parameter is stored as\n a lowercase string.

\n

Constraints:

\n \n

Example: myrepinstance\n

" } }, "ReplicationInstancePublicIpAddresses": { @@ -5857,6 +6213,18 @@ "smithy.api#documentation": "

One or more public IP addresses for the replication instance.

" } }, + "ReplicationSubnetGroup": { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup", + "traits": { + "smithy.api#documentation": "

The subnet group for the replication instance.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.databasemigrationservice#ReplicationPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

The pending modification values.

" + } + }, "ReplicationInstancePrivateIpAddress": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -5864,28 +6232,29 @@ "smithy.api#documentation": "

The private IP address of the replication instance.

" } }, - "SecondaryAvailabilityZone": { + "ReplicationInstancePublicIpAddress": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Availability Zone of the standby replication instance in a Multi-AZ\n deployment.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

The public IP address of the replication instance.

" } }, - "EngineVersion": { - "target": "com.amazonaws.databasemigrationservice#String", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.databasemigrationservice#Boolean", "traits": { - "smithy.api#documentation": "

The engine version number of the replication instance.

" + "smithy.api#documentation": "

Boolean value indicating if minor version upgrades will be automatically applied to the\n instance.

" } }, - "AutoMinorVersionUpgrade": { + "MultiAZ": { "target": "com.amazonaws.databasemigrationservice#Boolean", "traits": { - "smithy.api#documentation": "

Boolean value indicating if minor version upgrades will be automatically applied to the\n instance.

" + "smithy.api#documentation": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.

" } }, - "ReplicationInstanceArn": { + "ReplicationInstanceClass": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. It is a required parameter, although a defualt value is\n pre-selected in the DMS console.

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" } }, "ReplicationInstanceStatus": { @@ -5894,16 +6263,16 @@ "smithy.api#documentation": "

The status of the replication instance. The possible return values include:

\n \n " } }, - "MultiAZ": { - "target": "com.amazonaws.databasemigrationservice#Boolean", + "ReplicationInstancePrivateIpAddresses": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstancePrivateIpAddressList", "traits": { - "smithy.api#documentation": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.

" + "smithy.api#documentation": "

One or more private IP addresses for the replication instance.

" } }, - "ReplicationSubnetGroup": { - "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup", + "VpcSecurityGroups": { + "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

The subnet group for the replication instance.

" + "smithy.api#documentation": "

The VPC security group for the instance.

" } } }, @@ -5967,71 +6336,71 @@ "com.amazonaws.databasemigrationservice#ReplicationPendingModifiedValues": { "type": "structure", "members": { - "EngineVersion": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The engine version number of the replication instance.

" - } - }, "MultiAZ": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { "smithy.api#documentation": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.

" } }, + "ReplicationInstanceClass": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class.

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" + } + }, "AllocatedStorage": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { "smithy.api#documentation": "

The amount of storage (in gigabytes) that is allocated for the replication\n instance.

" } }, - "ReplicationInstanceClass": { + "EngineVersion": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the replication instance as defined for the specified\n replication instance class.

\n

For more information on the settings and capacities for the available replication instance classes, see \n \n Selecting the right AWS DMS replication instance for your migration.\n

" + "smithy.api#documentation": "

The engine version number of the replication instance.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about the values of pending modifications to a replication\n instance. This data type is an object of the ReplicationInstance user-defined\n data type.

" + "smithy.api#documentation": "

Provides information about the values of pending modifications to a replication\n instance. This data type is an object of the\n \n ReplicationInstance\n user-defined\n data type.

" } }, "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.databasemigrationservice#String", + "Subnets": { + "target": "com.amazonaws.databasemigrationservice#SubnetList", "traits": { - "smithy.api#documentation": "

The ID of the VPC.

" + "smithy.api#documentation": "

The subnets that are in the subnet group.

" } }, - "ReplicationSubnetGroupDescription": { + "ReplicationSubnetGroupIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A description for the replication subnet group.

" + "smithy.api#documentation": "

The identifier of the replication instance subnet group.

" } }, - "SubnetGroupStatus": { + "VpcId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The status of the subnet group.

" + "smithy.api#documentation": "

The ID of the VPC.

" } }, - "ReplicationSubnetGroupIdentifier": { + "SubnetGroupStatus": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The identifier of the replication instance subnet group.

" + "smithy.api#documentation": "

The status of the subnet group.

" } }, - "Subnets": { - "target": "com.amazonaws.databasemigrationservice#SubnetList", + "ReplicationSubnetGroupDescription": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The subnets that are in the subnet group.

" + "smithy.api#documentation": "

A description for the replication subnet group.

" } } }, "traits": { - "smithy.api#documentation": "

Describes a subnet group in response to a request by the DescribeReplicationSubnetGroup\n operation.

" + "smithy.api#documentation": "

Describes a subnet group in response to a request by the\n DescribeReplicationSubnetGroups operation.

" } }, "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs": { @@ -6061,16 +6430,16 @@ "com.amazonaws.databasemigrationservice#ReplicationTask": { "type": "structure", "members": { - "ReplicationTaskCreationDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "CdcStopPosition": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The date the replication task was created.

" + "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

" } }, - "ReplicationTaskSettings": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationTaskStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The settings for the replication task.

" + "smithy.api#documentation": "

The date the replication task is scheduled to start.

" } }, "Status": { @@ -6079,64 +6448,58 @@ "smithy.api#documentation": "

The status of the replication task.

" } }, - "ReplicationTaskStartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", - "traits": { - "smithy.api#documentation": "

The date the replication task is scheduled to start.

" - } - }, - "ReplicationTaskIdentifier": { + "ReplicationTaskSettings": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The user-assigned replication task identifier or name.

\n

Constraints:

\n " + "smithy.api#documentation": "

The settings for the replication task.

" } }, - "StopReason": { - "target": "com.amazonaws.databasemigrationservice#String", + "MigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", "traits": { - "smithy.api#documentation": "

The reason the replication task was stopped. This response parameter can return one of\n the following values:

\n " + "smithy.api#documentation": "

The type of migration.

" } }, - "ReplicationTaskArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationTaskStats": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskStats", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

" + "smithy.api#documentation": "

The statistics for the task, including elapsed time, tables loaded, and table\n errors.

" } }, - "SourceEndpointArn": { + "CdcStartPosition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start.\n Specifying both values results in an error.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

\n

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

" } }, - "RecoveryCheckpoint": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates the last checkpoint that occurred during a change data capture (CDC)\n operation. You can provide this value to the CdcStartPosition parameter to\n start a CDC operation that begins at that checkpoint.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" } }, - "ReplicationTaskStats": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskStats", + "TaskData": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The statistics for the task, including elapsed time, tables loaded, and table\n errors.

" + "smithy.api#documentation": "

Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n AWS Database Migration Service User Guide.\n

" } }, - "ReplicationInstanceArn": { + "TargetEndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" } }, - "CdcStopPosition": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

" } }, - "LastFailureMessage": { + "ReplicationTaskIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The last error (failure) message generated for the replication instance.

" + "smithy.api#documentation": "

The user-assigned replication task identifier or name.

\n

Constraints:

\n " } }, "TableMappings": { @@ -6145,28 +6508,34 @@ "smithy.api#documentation": "

Table mappings specified in the task.

" } }, - "MigrationType": { - "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "ReplicationTaskCreationDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The type of migration.

" + "smithy.api#documentation": "

The date the replication task was created.

" } }, - "TaskData": { + "LastFailureMessage": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n AWS Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

The last error (failure) message generated for the replication task.

" } }, - "TargetEndpointArn": { + "RecoveryCheckpoint": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + "smithy.api#documentation": "

Indicates the last checkpoint that occurred during a change data capture (CDC)\n operation. You can provide this value to the CdcStartPosition parameter to\n start a CDC operation that begins at that checkpoint.

" } }, - "CdcStartPosition": { + "StopReason": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start.\n Specifying both values results in an error.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

\n

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

" + "smithy.api#documentation": "

The reason the replication task was stopped. This response parameter can return one of\n the following values:

\n " + } + }, + "SourceEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" } } }, @@ -6177,6 +6546,12 @@ "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResult": { "type": "structure", "members": { + "ReplicationTaskIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The replication task identifier of the task on which the task assessment was run.\n

" + } + }, "S3ObjectUrl": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -6189,34 +6564,28 @@ "smithy.api#documentation": "

The date the task assessment was completed.

" } }, - "ReplicationTaskArn": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

" - } - }, - "ReplicationTaskIdentifier": { + "AssessmentResults": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The replication task identifier of the task on which the task assessment was run.\n

" + "smithy.api#documentation": "

The task assessment results in JSON format.

" } }, - "AssessmentStatus": { + "AssessmentResultsFile": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The status of the task assessment.

" + "smithy.api#documentation": "

The file containing the results of the task assessment.

" } }, - "AssessmentResults": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The task assessment results in JSON format.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

" } }, - "AssessmentResultsFile": { + "AssessmentStatus": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The file containing the results of the task assessment.

" + "smithy.api#documentation": "

The status of the task assessment.

" } } }, @@ -6236,10 +6605,22 @@ "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRun": { "type": "structure", "members": { - "ReplicationTaskAssessmentRunArn": { + "LastFailureMessage": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of this assessment run.

" + "smithy.api#documentation": "

Last message generated by an individual assessment failure.

" + } + }, + "ReplicationTaskAssessmentRunCreationDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

Date on which the assessment run was created using the\n StartReplicationTaskAssessmentRun operation.

" + } + }, + "AssessmentRunName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Unique name of the assessment run.

" } }, "AssessmentProgress": { @@ -6260,40 +6641,28 @@ "smithy.api#documentation": "

Folder in an Amazon S3 bucket where AWS DMS stores the results of this assessment\n run.

" } }, - "LastFailureMessage": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

Last message generated by an individual assessment failure.

" - } - }, "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { "smithy.api#documentation": "

ARN of the service role used to start the assessment run using the\n StartReplicationTaskAssessmentRun operation.

" } }, - "AssessmentRunName": { + "ResultKmsKeyArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Unique name of the assessment run.

" - } - }, - "ReplicationTaskAssessmentRunCreationDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", - "traits": { - "smithy.api#documentation": "

Date on which the assessment run was created using the\n StartReplicationTaskAssessmentRun operation.

" + "smithy.api#documentation": "

ARN of the AWS KMS encryption key used to encrypt the assessment run results.

" } }, - "Status": { + "ResultLocationBucket": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Assessment run status.

\n

This status can have one of the following values:

\n " + "smithy.api#documentation": "

Amazon S3 bucket where AWS DMS stores the results of this assessment run.

" } }, - "ResultKmsKeyArn": { + "ReplicationTaskAssessmentRunArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

ARN of the AWS KMS encryption key used to encrypt the assessment run results.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of this assessment run.

" } }, "ReplicationTaskArn": { @@ -6302,10 +6671,10 @@ "smithy.api#documentation": "

ARN of the migration task associated with this premigration\n assessment run.

" } }, - "ResultLocationBucket": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Amazon S3 bucket where AWS DMS stores the results of this assessment run.

" + "smithy.api#documentation": "

Assessment run status.

\n

This status can have one of the following values:

\n " } } }, @@ -6322,16 +6691,16 @@ "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunProgress": { "type": "structure", "members": { - "IndividualAssessmentCount": { + "IndividualAssessmentCompletedCount": { "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The number of individual assessments that are specified to run.

" + "smithy.api#documentation": "

The number of individual assessments that have completed, successfully or not.

" } }, - "IndividualAssessmentCompletedCount": { + "IndividualAssessmentCount": { "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The number of individual assessments that have completed, successfully or not.

" + "smithy.api#documentation": "

The number of individual assessments that are specified to run.

" } } }, @@ -6348,10 +6717,10 @@ "smithy.api#documentation": "

Name of this individual assessment.

" } }, - "ReplicationTaskAssessmentRunArn": { + "ReplicationTaskIndividualAssessmentArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

ARN of the premigration assessment run that is created to run this individual\n assessment.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of this individual assessment.

" } }, "ReplicationTaskIndividualAssessmentStartDate": { @@ -6360,16 +6729,16 @@ "smithy.api#documentation": "

Date when this individual assessment was started as part of running the\n StartReplicationTaskAssessmentRun operation.

" } }, - "Status": { + "ReplicationTaskAssessmentRunArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Individual assessment status.

\n

This status can have one of the following values:

\n " + "smithy.api#documentation": "

ARN of the premigration assessment run that is created to run this individual\n assessment.

" } }, - "ReplicationTaskIndividualAssessmentArn": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of this individual assessment.

" + "smithy.api#documentation": "

Individual assessment status.

\n

This status can have one of the following values:

\n " } } }, @@ -6395,58 +6764,58 @@ "com.amazonaws.databasemigrationservice#ReplicationTaskStats": { "type": "structure", "members": { - "FullLoadFinishDate": { + "StopDate": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The date the replication task full load was completed.

" + "smithy.api#documentation": "

The date the replication task was stopped.

" } }, - "FreshStartDate": { + "FullLoadStartDate": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The date the replication task was started either with a fresh start or a target reload.

" + "smithy.api#documentation": "

The date the replication task full load was started.

" } }, - "TablesLoaded": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "ElapsedTimeMillis": { + "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The number of tables loaded for this task.

" + "smithy.api#documentation": "

The elapsed time of the task, in milliseconds.

" } }, - "TablesLoading": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "FreshStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The number of tables currently loading for this task.

" + "smithy.api#documentation": "

The date the replication task was started either with a fresh start or a target reload.

" } }, - "StopDate": { + "StartDate": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The date the replication task was stopped.

" + "smithy.api#documentation": "

The date the replication task was started either with a fresh start or a resume. For more information, see \n StartReplicationTaskType.

" } }, - "TablesErrored": { + "TablesLoading": { "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The number of errors that have occurred during this task.

" + "smithy.api#documentation": "

The number of tables currently loading for this task.

" } }, - "FullLoadStartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "TablesLoaded": { + "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The date the replication task full load was started.

" + "smithy.api#documentation": "

The number of tables loaded for this task.

" } }, - "StartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "FullLoadProgressPercent": { + "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The date the replication task was started either with a fresh start or a resume. For more information, see \n StartReplicationTaskType.

" + "smithy.api#documentation": "

The percent complete for the full load migration task.

" } }, - "ElapsedTimeMillis": { - "target": "com.amazonaws.databasemigrationservice#Long", + "TablesErrored": { + "target": "com.amazonaws.databasemigrationservice#Integer", "traits": { - "smithy.api#documentation": "

The elapsed time of the task, in milliseconds.

" + "smithy.api#documentation": "

The number of errors that have occurred during this task.

" } }, "TablesQueued": { @@ -6455,10 +6824,10 @@ "smithy.api#documentation": "

The number of tables queued for this task.

" } }, - "FullLoadProgressPercent": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "FullLoadFinishDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The percent complete for the full load migration task.

" + "smithy.api#documentation": "

The date the replication task full load was completed.

" } } }, @@ -6564,28 +6933,22 @@ "com.amazonaws.databasemigrationservice#S3Settings": { "type": "structure", "members": { - "TimestampColumnName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

A value that when nonblank causes AWS DMS to add a column with timestamp information to\n the endpoint data for an Amazon S3 target.

\n \n

AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

\n \n

DMS includes an additional STRING column in the\n .csv or .parquet object files of your migrated data when you set\n TimestampColumnName to a nonblank value.

\n

For a full load, each row of this timestamp column contains a\n timestamp for when the data was transferred from the source to\n the target by DMS.

\n

For a change data capture (CDC) load, each row of the timestamp column contains the\n timestamp for the commit of that row in the source\n database.

\n

The string format for this timestamp column value is\n yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the\n precision of this value is in microseconds. For a CDC load, the\n rounding of the precision depends on the commit timestamp\n supported by DMS for the source database.

\n

When the AddColumnName parameter is set to true, DMS also\n includes a name for the timestamp column that you set with\n TimestampColumnName.

" - } - }, - "CompressionType": { - "target": "com.amazonaws.databasemigrationservice#CompressionTypeValue", + "DictPageSizeLimit": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress\n the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed.\n This parameter applies to both .csv and .parquet file formats.

" + "smithy.api#documentation": "

The maximum size of an encoded dictionary page of a column. If the dictionary page\n exceeds this, this column is stored using an encoding type of PLAIN. This\n parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page\n before it reverts to PLAIN encoding. This size is used for\n .parquet file format only.

" } }, - "ParquetTimestampInMillisecond": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ExternalTableDefinition": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value that specifies the precision of any TIMESTAMP column values that\n are written to an Amazon S3 object file in .parquet format.

\n \n

AWS DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.

\n \n

When ParquetTimestampInMillisecond is set to true or\n y, AWS DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.

\n

Currently, Amazon Athena and AWS Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.

\n \n\n

AWS DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.

\n\n

Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.

\n\n " + "smithy.api#documentation": "

Specifies how tables are defined in the S3 source files only.

" } }, - "EnableStatistics": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ServerSideEncryptionKmsKeyId": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value that enables statistics for Parquet pages and row groups. Choose\n true to enable statistics, false to disable. Statistics\n include NULL, DISTINCT, MAX, and MIN\n values. This parameter defaults to true. This value is used for\n .parquet file format only.

" + "smithy.api#documentation": "

If you are using SSE_KMS for the EncryptionMode, provide the\n AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and\n Access Management (IAM) user permissions and allows use of the key.

\n

Here is a CLI example: aws dms create-endpoint --endpoint-identifier\n value --endpoint-type target --engine-name s3 --s3-settings\n ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value\n \n

" } }, "DataFormat": { @@ -6594,52 +6957,46 @@ "smithy.api#documentation": "

The format of the data that you want to use for output. You can choose one of the\n following:

\n " } }, - "ParquetVersion": { - "target": "com.amazonaws.databasemigrationservice#ParquetVersionValue", - "traits": { - "smithy.api#documentation": "

The version of the Apache Parquet format that you want to use: parquet_1_0\n (the default) or parquet_2_0.

" - } - }, "CsvDelimiter": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The delimiter used to separate columns in the source files. The default is a comma.\n

" + "smithy.api#documentation": "

The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.\n

" } }, - "BucketFolder": { + "CsvRowDelimiter": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An optional parameter to set a folder name in the S3 bucket. If provided, tables are\n created in the path\n \n bucketFolder/schema_name/table_name/.\n If this parameter isn't specified, then the path used is\n \n schema_name/table_name/.

" + "smithy.api#documentation": "

The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage\n return (\\n).

" } }, - "IncludeOpForFullLoad": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value that enables a full load to write INSERT operations to the comma-separated value\n (.csv) output files only to indicate how the rows were added to the source database.

\n \n

AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.

\n \n

For full load, records can only be inserted. By default (the false\n setting), no information is recorded in these output files for a full load to indicate that\n the rows were inserted at the source database. If IncludeOpForFullLoad is set\n to true or y, the INSERT is recorded as an I annotation in the\n first field of the .csv file. This allows the format of your target records from a full\n load to be consistent with the target records from a CDC load.

\n \n

This setting works together with the CdcInsertsOnly and the\n CdcInsertsAndUpdates parameters for output to .csv files only. For more\n information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS\n Database Migration Service User Guide..

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used by the service access IAM role. It is a required\n parameter that enables DMS to write and read objects from an 3S bucket.

" } }, - "EncodingType": { - "target": "com.amazonaws.databasemigrationservice#EncodingTypeValue", + "CdcInsertsAndUpdates": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The type of encoding you are using:

\n " + "smithy.api#documentation": "

A value that enables a change data capture (CDC) load to write INSERT and UPDATE\n operations to .csv or .parquet (columnar storage) output files. The default setting is\n false, but when CdcInsertsAndUpdates is set to\n true or y, only INSERTs and UPDATEs from the source database\n are migrated to the .csv or .parquet file.

\n

For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the\n value of the IncludeOpForFullLoad parameter. If\n IncludeOpForFullLoad is set to true, the first field of every\n CDC record is set to either I or U to indicate INSERT and UPDATE\n operations at the source. But if IncludeOpForFullLoad is set to\n false, CDC records are written without an indication of INSERT or UPDATE\n operations at the source. For more information about how these settings work together, see\n Indicating Source DB Operations in Migrated S3 Data in the AWS\n Database Migration Service User Guide..

\n \n\n

AWS DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.

\n\n

\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.

\n\n " } }, - "CdcInsertsAndUpdates": { + "EnableStatistics": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that enables a change data capture (CDC) load to write INSERT and UPDATE\n operations to .csv or .parquet (columnar storage) output files. The default setting is\n false, but when CdcInsertsAndUpdates is set to \n trueor y, INSERTs and UPDATEs from the\n source database are migrated to the .csv or .parquet file.

\n

For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the\n value of the IncludeOpForFullLoad parameter. If\n IncludeOpForFullLoad is set to true, the first field of every\n CDC record is set to either I or U to indicate INSERT and UPDATE\n operations at the source. But if IncludeOpForFullLoad is set to\n false, CDC records are written without an indication of INSERT or UPDATE\n operations at the source. For more information about how these settings work together, see\n Indicating Source DB Operations in Migrated S3 Data in the AWS\n Database Migration Service User Guide..

\n \n\n

AWS DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.

\n\n

\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.

\n\n " + "smithy.api#documentation": "

A value that enables statistics for Parquet pages and row groups. Choose\n true to enable statistics, false to disable. Statistics\n include NULL, DISTINCT, MAX, and MIN\n values. This parameter defaults to true. This value is used for\n .parquet file format only.

" } }, - "ExternalTableDefinition": { + "BucketFolder": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The external table definition.

" + "smithy.api#documentation": "

An optional parameter to set a folder name in the S3 bucket. If provided, tables are\n created in the path\n \n bucketFolder/schema_name/table_name/.\n If this parameter isn't specified, then the path used is\n \n schema_name/table_name/.

" } }, - "ServerSideEncryptionKmsKeyId": { - "target": "com.amazonaws.databasemigrationservice#String", + "ParquetTimestampInMillisecond": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

If you are using SSE_KMS for the EncryptionMode, provide the\n AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and\n Access Management (IAM) user permissions and allows use of the key.

\n

Here is a CLI example: aws dms create-endpoint --endpoint-identifier\n value --endpoint-type target --engine-name s3 --s3-settings\n ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value\n \n

" + "smithy.api#documentation": "

A value that specifies the precision of any TIMESTAMP column values that\n are written to an Amazon S3 object file in .parquet format.

\n \n

AWS DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.

\n \n

When ParquetTimestampInMillisecond is set to true or\n y, AWS DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.

\n

Currently, Amazon Athena and AWS Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.

\n \n\n

AWS DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.

\n\n

Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.

\n\n " } }, "BucketName": { @@ -6648,46 +7005,76 @@ "smithy.api#documentation": "

The name of the S3 bucket.

" } }, - "DataPageSize": { + "EncryptionMode": { + "target": "com.amazonaws.databasemigrationservice#EncryptionModeValue", + "traits": { + "smithy.api#documentation": "

The type of server-side encryption that you want to use for your data. This encryption\n type is part of the endpoint settings or the extra connections attributes for Amazon S3.\n You can choose either SSE_S3 (the default) or SSE_KMS.

\n \n

For the ModifyEndpoint operation, you can change the existing value of\n the EncryptionMode parameter from SSE_KMS to\n SSE_S3. But you can’t change the existing value from SSE_S3\n to SSE_KMS.

\n \n

To use SSE_S3, you need an AWS Identity and Access Management (IAM) role\n with permission to allow \"arn:aws:s3:::dms-*\" to use the following\n actions:

\n " + } + }, + "DatePartitionEnabled": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, this parameter partitions S3 bucket folders based on transaction commit \n dates. The default value is false. For more information about date-based folder partitoning, \n see Using date-based folder partitioning\n

" + } + }, + "RowGroupLength": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB).\n This number is used for .parquet file format only.

" + "smithy.api#documentation": "

The number of rows in a row group. A smaller row group size provides faster reads. But\n as the number of row groups grows, the slower writes become. This parameter defaults to\n 10,000 rows. This number is used for .parquet file format only.

\n

If you choose a value larger than the maximum, RowGroupLength is set to the\n max row group length in bytes (64 * 1024 * 1024).

" } }, - "ServiceAccessRoleArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "CompressionType": { + "target": "com.amazonaws.databasemigrationservice#CompressionTypeValue", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) used by the service access IAM role.

" + "smithy.api#documentation": "

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress\n the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed.\n This parameter applies to both .csv and .parquet file formats.

" } }, "CdcInsertsOnly": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that enables a change data capture (CDC) load to write only INSERT operations to\n .csv or columnar storage (.parquet) output files. By default (the\n false setting), the first field in a .csv or .parquet record contains the\n letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was\n inserted, updated, or deleted at the source database for a CDC load to the target.

\n

If CdcInsertsOnly is set to true or y, only\n INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format\n only, how these INSERTs are recorded depends on the value of\n IncludeOpForFullLoad. If IncludeOpForFullLoad is set to\n true, the first field of every CDC record is set to I to indicate the\n INSERT operation at the source. If IncludeOpForFullLoad is set to\n false, every CDC record is written without a first field to indicate the\n INSERT operation at the source. For more information about how these settings work\n together, see Indicating Source DB Operations in Migrated S3 Data in the AWS\n Database Migration Service User Guide..

\n\n \n\n

AWS DMS supports the interaction described preceding between the\n CdcInsertsOnly and IncludeOpForFullLoad parameters in\n versions 3.1.4 and later.

\n\n

\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.

\n\n " + "smithy.api#documentation": "

A value that enables a change data capture (CDC) load to write only INSERT operations to\n .csv or columnar storage (.parquet) output files. By default (the\n false setting), the first field in a .csv or .parquet record contains the\n letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was\n inserted, updated, or deleted at the source database for a CDC load to the target.

\n

If CdcInsertsOnly is set to true or y, only\n INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format\n only, how these INSERTs are recorded depends on the value of\n IncludeOpForFullLoad. If IncludeOpForFullLoad is set to\n true, the first field of every CDC record is set to I to indicate the\n INSERT operation at the source. If IncludeOpForFullLoad is set to\n false, every CDC record is written without a first field to indicate the\n INSERT operation at the source. For more information about how these settings work\n together, see Indicating Source DB Operations in Migrated S3 Data in the AWS\n Database Migration Service User Guide..

\n\n \n\n

AWS DMS supports the interaction described preceding between the\n CdcInsertsOnly and IncludeOpForFullLoad parameters in\n versions 3.1.4 and later.

\n\n

\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.

\n\n " + } + }, + "DatePartitionDelimiter": { + "target": "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue", + "traits": { + "smithy.api#documentation": "

Specifies a date separating delimiter to use during folder partitioning. The default value is \n SLASH. Use this parameter when DatePartitionedEnabled is set to true.

" + } + }, + "ParquetVersion": { + "target": "com.amazonaws.databasemigrationservice#ParquetVersionValue", + "traits": { + "smithy.api#documentation": "

The version of the Apache Parquet format that you want to use: parquet_1_0\n (the default) or parquet_2_0.

" + } + }, + "TimestampColumnName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A value that when nonblank causes AWS DMS to add a column with timestamp information to\n the endpoint data for an Amazon S3 target.

\n \n

AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

\n \n

DMS includes an additional STRING column in the\n .csv or .parquet object files of your migrated data when you set\n TimestampColumnName to a nonblank value.

\n

For a full load, each row of this timestamp column contains a\n timestamp for when the data was transferred from the source to\n the target by DMS.

\n

For a change data capture (CDC) load, each row of the timestamp column contains the\n timestamp for the commit of that row in the source\n database.

\n

The string format for this timestamp column value is\n yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the\n precision of this value is in microseconds. For a CDC load, the\n rounding of the precision depends on the commit timestamp\n supported by DMS for the source database.

\n

When the AddColumnName parameter is set to true, DMS also\n includes a name for the timestamp column that you set with\n TimestampColumnName.

" } }, - "DictPageSizeLimit": { + "DataPageSize": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum size of an encoded dictionary page of a column. If the dictionary page\n exceeds this, this column is stored using an encoding type of PLAIN. This\n parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page\n before it reverts to PLAIN encoding. This size is used for\n .parquet file format only.

" + "smithy.api#documentation": "

The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB).\n This number is used for .parquet file format only.

" } }, - "CsvRowDelimiter": { - "target": "com.amazonaws.databasemigrationservice#String", + "IncludeOpForFullLoad": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The delimiter used to separate rows in the source files. The default is a carriage\n return (\\n).

" + "smithy.api#documentation": "

A value that enables a full load to write INSERT operations to the comma-separated value\n (.csv) output files only to indicate how the rows were added to the source database.

\n \n

AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.

\n \n

For full load, records can only be inserted. By default (the false\n setting), no information is recorded in these output files for a full load to indicate that\n the rows were inserted at the source database. If IncludeOpForFullLoad is set\n to true or y, the INSERT is recorded as an I annotation in the\n first field of the .csv file. This allows the format of your target records from a full\n load to be consistent with the target records from a CDC load.

\n \n

This setting works together with the CdcInsertsOnly and the\n CdcInsertsAndUpdates parameters for output to .csv files only. For more\n information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS\n Database Migration Service User Guide..

\n " } }, - "RowGroupLength": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "DatePartitionSequence": { + "target": "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue", "traits": { - "smithy.api#documentation": "

The number of rows in a row group. A smaller row group size provides faster reads. But\n as the number of row groups grows, the slower writes become. This parameter defaults to\n 10,000 rows. This number is used for .parquet file format only.

\n

If you choose a value larger than the maximum, RowGroupLength is set to the\n max row group length in bytes (64 * 1024 * 1024).

" + "smithy.api#documentation": "

Identifies the sequence of the date format to use during folder partitioning. The default value is \n YYYYMMDD. Use this parameter when DatePartitionedEnabled is set to true.

" } }, - "EncryptionMode": { - "target": "com.amazonaws.databasemigrationservice#EncryptionModeValue", + "EncodingType": { + "target": "com.amazonaws.databasemigrationservice#EncodingTypeValue", "traits": { - "smithy.api#documentation": "

The type of server-side encryption that you want to use for your data. This encryption\n type is part of the endpoint settings or the extra connections attributes for Amazon S3.\n You can choose either SSE_S3 (the default) or SSE_KMS. To use\n SSE_S3, you need an AWS Identity and Access Management (IAM) role with\n permission to allow \"arn:aws:s3:::dms-*\" to use the following actions:

\n " + "smithy.api#documentation": "

The type of encoding you are using:

\n " } } }, @@ -6725,6 +7112,25 @@ "smithy.api#error": "client" } }, + "com.amazonaws.databasemigrationservice#SafeguardPolicy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "rely-on-sql-server-replication-agent", + "name": "RELY_ON_SQL_SERVER_REPLICATION_AGENT" + }, + { + "value": "exclusive-automatic-truncation", + "name": "EXCLUSIVE_AUTOMATIC_TRUNCATION" + }, + { + "value": "shared-automatic-truncation", + "name": "SHARED_AUTOMATIC_TRUNCATION" + } + ] + } + }, "com.amazonaws.databasemigrationservice#SchemaList": { "type": "list", "member": { @@ -6881,20 +7287,6 @@ "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessmentRunMessage": { "type": "structure", "members": { - "ServiceAccessRoleArn": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

ARN of a service role needed to start the assessment run.

", - "smithy.api#required": {} - } - }, - "AssessmentRunName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

Unique name to identify the assessment run.

", - "smithy.api#required": {} - } - }, "ResultLocationFolder": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -6907,18 +7299,25 @@ "smithy.api#documentation": "

Encryption mode that you can specify to encrypt the results of this assessment run. If\n you don't specify this request parameter, AWS DMS stores the assessment run results\n without encryption. You can specify one of the options following:

\n " } }, - "IncludeOnly": { - "target": "com.amazonaws.databasemigrationservice#IncludeTestList", - "traits": { - "smithy.api#documentation": "

Space-separated list of names for specific individual assessments that you want to\n include. These names come from the default list of individual assessments that AWS DMS\n supports for the associated migration task. This task is specified by\n ReplicationTaskArn.

\n \n

You can't set a value for IncludeOnly if you also set a value for\n Exclude in the API operation.

\n

To identify the names of the default individual assessments that AWS DMS\n supports for the associated migration task, run the\n DescribeApplicableIndividualAssessments operation using its own\n ReplicationTaskArn request parameter.

\n " - } - }, "Exclude": { "target": "com.amazonaws.databasemigrationservice#ExcludeTestList", "traits": { "smithy.api#documentation": "

Space-separated list of names for specific individual assessments that you want to\n exclude. These names come from the default list of individual assessments that AWS DMS\n supports for the associated migration task. This task is specified by\n ReplicationTaskArn.

\n \n

You can't set a value for Exclude if you also set a value for\n IncludeOnly in the API operation.

\n

To identify the names of the default individual assessments that AWS DMS\n supports for the associated migration task, run the\n DescribeApplicableIndividualAssessments operation using its own\n ReplicationTaskArn request parameter.

\n " } }, + "AssessmentRunName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Unique name to identify the assessment run.

", + "smithy.api#required": {} + } + }, + "ResultKmsKeyArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

ARN of a custom KMS encryption key that you specify when you set\n ResultEncryptionMode to \"SSE_KMS\".

" + } + }, "ResultLocationBucket": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -6933,10 +7332,17 @@ "smithy.api#required": {} } }, - "ResultKmsKeyArn": { + "IncludeOnly": { + "target": "com.amazonaws.databasemigrationservice#IncludeTestList", + "traits": { + "smithy.api#documentation": "

Space-separated list of names for specific individual assessments that you want to\n include. These names come from the default list of individual assessments that AWS DMS\n supports for the associated migration task. This task is specified by\n ReplicationTaskArn.

\n \n

You can't set a value for IncludeOnly if you also set a value for\n Exclude in the API operation.

\n

To identify the names of the default individual assessments that AWS DMS\n supports for the associated migration task, run the\n DescribeApplicableIndividualAssessments operation using its own\n ReplicationTaskArn request parameter.

\n " + } + }, + "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

ARN of a custom KMS encryption key that you specify when you set\n ResultEncryptionMode to \"SSE_KMS\".

" + "smithy.api#documentation": "

ARN of a service role needed to start the assessment run.

", + "smithy.api#required": {} } } }, @@ -6961,30 +7367,30 @@ "com.amazonaws.databasemigrationservice#StartReplicationTaskMessage": { "type": "structure", "members": { - "CdcStartPosition": { - "target": "com.amazonaws.databasemigrationservice#String", + "StartReplicationTaskType": { + "target": "com.amazonaws.databasemigrationservice#StartReplicationTaskTypeValue", "traits": { - "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start.\n Specifying both values results in an error.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

\n

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

\n \n

When you use this task setting with a source PostgreSQL database, a logical\n replication slot should already be created and associated with the source endpoint. You\n can verify this by setting the slotName extra connection attribute to the\n name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source\n for AWS DMS.

\n " + "smithy.api#documentation": "

A type of replication task.

", + "smithy.api#required": {} } }, - "CdcStopPosition": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task to be started.

", + "smithy.api#required": {} } }, - "ReplicationTaskArn": { + "CdcStopPosition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task to be started.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.

\n

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

\n

Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

" } }, - "StartReplicationTaskType": { - "target": "com.amazonaws.databasemigrationservice#StartReplicationTaskTypeValue", + "CdcStartPosition": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of replication task.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start.\n Specifying both values results in an error.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

\n

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

\n \n

When you use this task setting with a source PostgreSQL database, a logical\n replication slot should already be created and associated with the source endpoint. You\n can verify this by setting the slotName extra connection attribute to the\n name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source\n for AWS DMS.

\n " } }, "CdcStartTime": { @@ -7107,21 +7513,21 @@ "smithy.api#documentation": "

The Availability Zone of the subnet.

" } }, - "SubnetIdentifier": { + "SubnetStatus": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The subnet identifier.

" + "smithy.api#documentation": "

The status of the subnet.

" } }, - "SubnetStatus": { + "SubnetIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The status of the subnet.

" + "smithy.api#documentation": "

The subnet identifier.

" } } }, "traits": { - "smithy.api#documentation": "

In response to a request by the DescribeReplicationSubnetGroup operation, this object\n identifies a subnet by its given Availability Zone, subnet identifier, and status.

" + "smithy.api#documentation": "

In response to a request by the DescribeReplicationSubnetGroups operation,\n this object identifies a subnet by its given Availability Zone, subnet identifier, and\n status.

" } }, "com.amazonaws.databasemigrationservice#SubnetAlreadyInUse": { @@ -7160,6 +7566,12 @@ "com.amazonaws.databasemigrationservice#SupportedEndpointType": { "type": "structure", "members": { + "SupportsCDC": { + "target": "com.amazonaws.databasemigrationservice#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if Change Data Capture (CDC) is supported.

" + } + }, "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -7172,12 +7584,6 @@ "smithy.api#documentation": "

The earliest AWS DMS engine version that supports this endpoint engine. Note that endpoint engines released with AWS DMS versions earlier than 3.1.1 do not return a value for this parameter.

" } }, - "SupportsCDC": { - "target": "com.amazonaws.databasemigrationservice#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates if Change Data Capture (CDC) is supported.

" - } - }, "EngineDisplayName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { @@ -7207,10 +7613,10 @@ "com.amazonaws.databasemigrationservice#SybaseSettings": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", "traits": { - "smithy.api#documentation": "

Endpoint TCP port.

" + "smithy.api#documentation": "

Endpoint connection password.

" } }, "DatabaseName": { @@ -7219,22 +7625,22 @@ "smithy.api#documentation": "

Database name for the endpoint.

" } }, - "Username": { + "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Endpoint connection user name.

" + "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" } }, - "ServerName": { - "target": "com.amazonaws.databasemigrationservice#String", + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

" + "smithy.api#documentation": "

Endpoint TCP port.

" } }, - "Password": { - "target": "com.amazonaws.databasemigrationservice#SecretString", + "Username": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Endpoint connection password.

" + "smithy.api#documentation": "

Endpoint connection user name.

" } } }, @@ -7254,22 +7660,22 @@ "com.amazonaws.databasemigrationservice#TableStatistics": { "type": "structure", "members": { - "ValidationFailedRecords": { + "Ddls": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The number of records that failed validation.

" + "smithy.api#documentation": "

The data definition language (DDL) used to build and modify the structure of your tables.

" } }, - "Inserts": { - "target": "com.amazonaws.databasemigrationservice#Long", + "FullLoadReloaded": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The number of insert actions performed on a table.

" + "smithy.api#documentation": "

A value that indicates if the table was reloaded (true) \n or loaded as part of a new full load operation (false).

" } }, - "ValidationState": { + "TableState": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The validation state of the table.

\n

This parameter can have the following values:

\n " + "smithy.api#documentation": "

The state of the tables described.

\n

Valid states: Table does not exist | Before load | Full load | Table completed | Table\n cancelled | Table error | Table all | Table updates | Table is being reloaded

" } }, "ValidationStateDetails": { @@ -7278,94 +7684,94 @@ "smithy.api#documentation": "

Additional details about the state of validation.

" } }, - "TableName": { - "target": "com.amazonaws.databasemigrationservice#String", + "FullLoadStartTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The name of the table.

" + "smithy.api#documentation": "

The time when the full load operation started.

" } }, - "FullLoadRows": { + "Updates": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The number of rows added during the full load operation.

" + "smithy.api#documentation": "

The number of update actions performed on a table.

" } }, - "TableState": { - "target": "com.amazonaws.databasemigrationservice#String", + "FullLoadCondtnlChkFailedRows": { + "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The state of the tables described.

\n

Valid states: Table does not exist | Before load | Full load | Table completed | Table\n cancelled | Table error | Table all | Table updates | Table is being reloaded

" + "smithy.api#documentation": "

The number of rows that failed conditional checks during the full load operation (valid\n only for migrations where DynamoDB is the target).

" } }, - "SchemaName": { - "target": "com.amazonaws.databasemigrationservice#String", + "Deletes": { + "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The schema name.

" + "smithy.api#documentation": "

The number of delete actions performed on a table.

" } }, - "ValidationSuspendedRecords": { + "FullLoadErrorRows": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The number of records that couldn't be validated.

" + "smithy.api#documentation": "

The number of rows that failed to load during the full load operation (valid only for\n migrations where DynamoDB is the target).

" } }, - "ValidationPendingRecords": { - "target": "com.amazonaws.databasemigrationservice#Long", + "LastUpdateTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The number of records that have yet to be validated.

" + "smithy.api#documentation": "

The last time a table was updated.

" } }, - "FullLoadReloaded": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "FullLoadEndTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

A value that indicates if the table was reloaded (true) \n or loaded as part of a new full load operation (false).

" + "smithy.api#documentation": "

The time when the full load operation completed.

" } }, - "Updates": { - "target": "com.amazonaws.databasemigrationservice#Long", + "ValidationState": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The number of update actions performed on a table.

" + "smithy.api#documentation": "

The validation state of the table.

\n

This parameter can have the following values:

\n " } }, - "Ddls": { + "FullLoadRows": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The data definition language (DDL) used to build and modify the structure of your tables.

" + "smithy.api#documentation": "

The number of rows added during the full load operation.

" } }, - "LastUpdateTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "TableName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The last time a table was updated.

" + "smithy.api#documentation": "

The name of the table.

" } }, - "FullLoadEndTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "ValidationFailedRecords": { + "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The time when the full load operation completed.

" + "smithy.api#documentation": "

The number of records that failed validation.

" } }, - "FullLoadStartTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "Inserts": { + "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The time when the full load operation started.

" + "smithy.api#documentation": "

The number of insert actions performed on a table.

" } }, - "FullLoadErrorRows": { - "target": "com.amazonaws.databasemigrationservice#Long", + "SchemaName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The number of rows that failed to load during the full load operation (valid only for\n migrations where DynamoDB is the target).

" + "smithy.api#documentation": "

The schema name.

" } }, - "Deletes": { + "ValidationSuspendedRecords": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The number of delete actions performed on a table.

" + "smithy.api#documentation": "

The number of records that couldn't be validated.

" } }, - "FullLoadCondtnlChkFailedRows": { + "ValidationPendingRecords": { "target": "com.amazonaws.databasemigrationservice#Long", "traits": { - "smithy.api#documentation": "

The number of rows that failed conditional checks during the full load operation (valid\n only for migrations where DynamoDB is the target).

" + "smithy.api#documentation": "

The number of records that have yet to be validated.

" } } }, @@ -7382,17 +7788,17 @@ "com.amazonaws.databasemigrationservice#TableToReload": { "type": "structure", "members": { - "SchemaName": { + "TableName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The schema name of the table to be reloaded.

", + "smithy.api#documentation": "

The table name of the table to be reloaded.

", "smithy.api#required": {} } }, - "TableName": { + "SchemaName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The table name of the table to be reloaded.

", + "smithy.api#documentation": "

The schema name of the table to be reloaded.

", "smithy.api#required": {} } } @@ -7404,16 +7810,16 @@ "com.amazonaws.databasemigrationservice#Tag": { "type": "structure", "members": { - "Value": { + "Key": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be 1-256 Unicode\n characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only\n contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-'\n (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + "smithy.api#documentation": "

A key is the required name of the tag. The string value can be 1-128 Unicode characters\n in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain\n only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java\n regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } }, - "Key": { + "Value": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A key is the required name of the tag. The string value can be 1-128 Unicode characters\n in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain\n only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java\n regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be 1-256 Unicode\n characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only\n contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-'\n (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } } }, @@ -7430,6 +7836,21 @@ } } }, + "com.amazonaws.databasemigrationservice#TargetDbType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "specific-database", + "name": "SPECIFIC_DATABASE" + }, + { + "value": "multiple-databases", + "name": "MULTIPLE_DATABASES" + } + ] + } + }, "com.amazonaws.databasemigrationservice#TestConnection": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json b/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json index 5e5ce45d6820..ca9d5bffed85 100644 --- a/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json @@ -55,13 +55,6 @@ "com.amazonaws.dataexchange#AssetDestinationEntry": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The S3 bucket that is the destination for the asset.

", - "smithy.api#required": {} - } - }, "AssetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { @@ -74,6 +67,13 @@ "traits": { "smithy.api#documentation": "

The name of the object in Amazon S3 for the asset.

" } + }, + "Bucket": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The S3 bucket that is the destination for the asset.

", + "smithy.api#required": {} + } } }, "traits": { @@ -91,23 +91,17 @@ "com.amazonaws.dataexchange#AssetEntry": { "type": "structure", "members": { - "SourceId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" - } - }, - "Name": { - "target": "com.amazonaws.dataexchange#AssetName", - "traits": { - "smithy.api#documentation": "

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

", + "smithy.api#documentation": "

The unique identifier for the revision associated with this asset.

", "smithy.api#required": {} } }, - "AssetDetails": { - "target": "com.amazonaws.dataexchange#AssetDetails", + "Id": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

Information about the asset, including its size.

", + "smithy.api#documentation": "

The unique identifier for the asset.

", "smithy.api#required": {} } }, @@ -125,40 +119,46 @@ "smithy.api#required": {} } }, - "RevisionId": { + "DataSetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this asset.

", + "smithy.api#documentation": "

The unique identifier for the data set associated with this asset.

", "smithy.api#required": {} } }, - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "AssetDetails": { + "target": "com.amazonaws.dataexchange#AssetDetails", "traits": { - "smithy.api#documentation": "

The date and time that the asset was created, in ISO 8601 format.

", + "smithy.api#documentation": "

Information about the asset, including its size.

", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.dataexchange#Id", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The unique identifier for the asset.

", + "smithy.api#documentation": "

The ARN for the asset.

", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "Name": { + "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "

The ARN for the asset.

", + "smithy.api#documentation": "

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

", "smithy.api#required": {} } }, - "DataSetId": { - "target": "com.amazonaws.dataexchange#Id", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this asset.

", + "smithy.api#documentation": "

The date and time that the asset was created, in ISO 8601 format.

", "smithy.api#required": {} } + }, + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" + } } }, "traits": { @@ -174,17 +174,17 @@ "com.amazonaws.dataexchange#AssetSourceEntry": { "type": "structure", "members": { - "Bucket": { + "Key": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The S3 bucket that's part of the source of the asset.

", + "smithy.api#documentation": "

The name of the object in Amazon S3 for the asset.

", "smithy.api#required": {} } }, - "Key": { + "Bucket": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The name of the object in Amazon S3 for the asset.

", + "smithy.api#documentation": "

The S3 bucket that's part of the source of the asset.

", "smithy.api#required": {} } } @@ -287,18 +287,18 @@ "com.amazonaws.dataexchange#ConflictException": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for the resource with the conflict.

" - } - }, "ResourceType": { "target": "com.amazonaws.dataexchange#ResourceType", "traits": { "smithy.api#documentation": "

The type of the resource with the conflict.

" } }, + "ResourceId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the resource with the conflict.

" + } + }, "Message": { "target": "com.amazonaws.dataexchange#__string", "traits": { @@ -350,6 +350,12 @@ "com.amazonaws.dataexchange#CreateDataSetRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", + "traits": { + "smithy.api#documentation": "

A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

" + } + }, "Description": { "target": "com.amazonaws.dataexchange#Description", "traits": { @@ -370,12 +376,6 @@ "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.dataexchange#MapOf__string", - "traits": { - "smithy.api#documentation": "

A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

" - } } }, "traits": { @@ -385,16 +385,22 @@ "com.amazonaws.dataexchange#CreateDataSetResponse": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the data set.

" + } + }, "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" } }, - "CreatedAt": { + "UpdatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

" + "smithy.api#documentation": "

The date and time that the data set was last updated, in ISO 8601 format.

" } }, "Tags": { @@ -403,28 +409,22 @@ "smithy.api#documentation": "

The tags for the data set.

" } }, - "SourceId": { - "target": "com.amazonaws.dataexchange#Id", - "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" - } - }, - "OriginDetails": { - "target": "com.amazonaws.dataexchange#OriginDetails", - "traits": { - "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" - } - }, "Name": { "target": "com.amazonaws.dataexchange#Name", "traits": { "smithy.api#documentation": "

The name of the data set.

" } }, - "UpdatedAt": { + "Origin": { + "target": "com.amazonaws.dataexchange#Origin", + "traits": { + "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" + } + }, + "CreatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the data set was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

" } }, "Description": { @@ -433,22 +433,22 @@ "smithy.api#documentation": "

The description for the data set.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the data set.

" - } - }, "Id": { "target": "com.amazonaws.dataexchange#Id", "traits": { "smithy.api#documentation": "

The unique identifier for the data set.

" } }, - "Origin": { - "target": "com.amazonaws.dataexchange#Origin", + "OriginDetails": { + "target": "com.amazonaws.dataexchange#OriginDetails", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" + } + }, + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" } } } @@ -512,16 +512,16 @@ "com.amazonaws.dataexchange#CreateJobResponse": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.dataexchange#Type", + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The job type.

" + "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

" } }, - "Details": { - "target": "com.amazonaws.dataexchange#ResponseDetails", + "State": { + "target": "com.amazonaws.dataexchange#State", "traits": { - "smithy.api#documentation": "

Details about the job.

" + "smithy.api#documentation": "

The state of the job.

" } }, "Errors": { @@ -530,22 +530,22 @@ "smithy.api#documentation": "

The errors associated with jobs.

" } }, - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Details": { + "target": "com.amazonaws.dataexchange#ResponseDetails", "traits": { - "smithy.api#documentation": "

The date and time that the job was created, in ISO 8601 format.

" + "smithy.api#documentation": "

Details about the job.

" } }, - "State": { - "target": "com.amazonaws.dataexchange#State", + "Type": { + "target": "com.amazonaws.dataexchange#Type", "traits": { - "smithy.api#documentation": "

The state of the job.

" + "smithy.api#documentation": "

The job type.

" } }, - "Id": { - "target": "com.amazonaws.dataexchange#Id", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier for the job.

" + "smithy.api#documentation": "

The date and time that the job was created, in ISO 8601 format.

" } }, "Arn": { @@ -554,10 +554,10 @@ "smithy.api#documentation": "

The ARN for the job.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Id": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The unique identifier for the job.

" } } } @@ -599,10 +599,10 @@ "com.amazonaws.dataexchange#CreateRevisionRequest": { "type": "structure", "members": { - "Comment": { - "target": "com.amazonaws.dataexchange#__stringMin0Max16384", + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

An optional comment about the revision.

" + "smithy.api#documentation": "

A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

" } }, "DataSetId": { @@ -613,10 +613,10 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.dataexchange#MapOf__string", + "Comment": { + "target": "com.amazonaws.dataexchange#__stringMin0Max16384", "traits": { - "smithy.api#documentation": "

A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

" + "smithy.api#documentation": "

An optional comment about the revision.

" } } }, @@ -627,58 +627,58 @@ "com.amazonaws.dataexchange#CreateRevisionResponse": { "type": "structure", "members": { - "Comment": { - "target": "com.amazonaws.dataexchange#__stringMin0Max16384", + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

An optional comment about the revision.

" + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" } }, - "Tags": { - "target": "com.amazonaws.dataexchange#MapOf__string", + "Id": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The tags for the revision.

" + "smithy.api#documentation": "

The unique identifier for the revision.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The ARN for the revision

" + "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

" } }, - "Finalized": { - "target": "com.amazonaws.dataexchange#__boolean", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

" } }, - "DataSetId": { - "target": "com.amazonaws.dataexchange#Id", + "Comment": { + "target": "com.amazonaws.dataexchange#__stringMin0Max16384", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

" + "smithy.api#documentation": "

An optional comment about the revision.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The ARN for the revision

" } }, - "Id": { - "target": "com.amazonaws.dataexchange#Id", + "Finalized": { + "target": "com.amazonaws.dataexchange#__boolean", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" } }, - "CreatedAt": { + "UpdatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

" + "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" } }, - "SourceId": { - "target": "com.amazonaws.dataexchange#Id", + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

The tags for the revision.

" } } } @@ -772,31 +772,36 @@ "com.amazonaws.dataexchange#DataSetEntry": { "type": "structure", "members": { - "Origin": { - "target": "com.amazonaws.dataexchange#Origin", + "Name": { + "target": "com.amazonaws.dataexchange#Name", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

", + "smithy.api#documentation": "

The name of the data set.

", "smithy.api#required": {} } }, - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "OriginDetails": { + "target": "com.amazonaws.dataexchange#OriginDetails", "traits": { - "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The ARN for the data set.

", + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.dataexchange#Description", + "Origin": { + "target": "com.amazonaws.dataexchange#Origin", "traits": { - "smithy.api#documentation": "

The description for the data set.

", + "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

", "smithy.api#required": {} } }, @@ -807,19 +812,13 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.dataexchange#Name", + "Description": { + "target": "com.amazonaws.dataexchange#Description", "traits": { - "smithy.api#documentation": "

The name of the data set.

", + "smithy.api#documentation": "

The description for the data set.

", "smithy.api#required": {} } }, - "SourceId": { - "target": "com.amazonaws.dataexchange#Id", - "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" - } - }, "UpdatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { @@ -827,18 +826,19 @@ "smithy.api#required": {} } }, - "OriginDetails": { - "target": "com.amazonaws.dataexchange#OriginDetails", - "traits": { - "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" - } - }, "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

", "smithy.api#required": {} } + }, + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the data set.

", + "smithy.api#required": {} + } } }, "traits": { @@ -882,18 +882,18 @@ "com.amazonaws.dataexchange#DeleteAssetRequest": { "type": "structure", "members": { - "DataSetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a data set.

", + "smithy.api#documentation": "

The unique identifier for a revision.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RevisionId": { + "DataSetId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#documentation": "

The unique identifier for a data set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -992,18 +992,18 @@ "com.amazonaws.dataexchange#DeleteRevisionRequest": { "type": "structure", "members": { - "DataSetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a data set.

", + "smithy.api#documentation": "

The unique identifier for a revision.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RevisionId": { + "DataSetId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#documentation": "

The unique identifier for a data set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1030,24 +1030,24 @@ "com.amazonaws.dataexchange#ExportAssetToSignedUrlRequestDetails": { "type": "structure", "members": { - "RevisionId": { + "AssetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this export request.

", + "smithy.api#documentation": "

The unique identifier for the asset that is exported to a signed URL.

", "smithy.api#required": {} } }, - "AssetId": { + "DataSetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the asset that is exported to a signed URL.

", + "smithy.api#documentation": "

The unique identifier for the data set associated with this export job.

", "smithy.api#required": {} } }, - "DataSetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this export job.

", + "smithy.api#documentation": "

The unique identifier for the revision associated with this export request.

", "smithy.api#required": {} } } @@ -1059,10 +1059,10 @@ "com.amazonaws.dataexchange#ExportAssetToSignedUrlResponseDetails": { "type": "structure", "members": { - "AssetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the asset associated with this export job.

", + "smithy.api#documentation": "

The unique identifier for the revision associated with this export response.

", "smithy.api#required": {} } }, @@ -1079,18 +1079,18 @@ "smithy.api#documentation": "

The date and time that the signed URL expires, in ISO 8601 format.

" } }, - "RevisionId": { - "target": "com.amazonaws.dataexchange#Id", - "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this export response.

", - "smithy.api#required": {} - } - }, "SignedUrl": { "target": "com.amazonaws.dataexchange#__string", "traits": { "smithy.api#documentation": "

The signed URL for the export request.

" } + }, + "AssetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier for the asset associated with this export job.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1100,10 +1100,10 @@ "com.amazonaws.dataexchange#ExportAssetsToS3RequestDetails": { "type": "structure", "members": { - "AssetDestinations": { - "target": "com.amazonaws.dataexchange#ListOfAssetDestinationEntry", + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The destination for the asset.

", + "smithy.api#documentation": "

The unique identifier for the revision associated with this export request.

", "smithy.api#required": {} } }, @@ -1120,10 +1120,10 @@ "smithy.api#documentation": "

Encryption configuration for the export job.

" } }, - "RevisionId": { - "target": "com.amazonaws.dataexchange#Id", + "AssetDestinations": { + "target": "com.amazonaws.dataexchange#ListOfAssetDestinationEntry", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this export request.

", + "smithy.api#documentation": "

The destination for the asset.

", "smithy.api#required": {} } } @@ -1135,31 +1135,31 @@ "com.amazonaws.dataexchange#ExportAssetsToS3ResponseDetails": { "type": "structure", "members": { - "AssetDestinations": { - "target": "com.amazonaws.dataexchange#ListOfAssetDestinationEntry", + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The destination in Amazon S3 where the asset is exported.

", + "smithy.api#documentation": "

The unique identifier for the data set associated with this export job.

", "smithy.api#required": {} } }, - "RevisionId": { - "target": "com.amazonaws.dataexchange#Id", + "Encryption": { + "target": "com.amazonaws.dataexchange#ExportServerSideEncryption", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this export response.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Encryption configuration of the export job.

" } }, - "DataSetId": { - "target": "com.amazonaws.dataexchange#Id", + "AssetDestinations": { + "target": "com.amazonaws.dataexchange#ListOfAssetDestinationEntry", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this export job.

", + "smithy.api#documentation": "

The destination in Amazon S3 where the asset is exported.

", "smithy.api#required": {} } }, - "Encryption": { - "target": "com.amazonaws.dataexchange#ExportServerSideEncryption", + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

Encryption configuration of the export job.

" + "smithy.api#documentation": "

The unique identifier for the revision associated with this export response.

", + "smithy.api#required": {} } } }, @@ -1170,18 +1170,18 @@ "com.amazonaws.dataexchange#ExportServerSideEncryption": { "type": "structure", "members": { - "KmsKeyArn": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

" - } - }, "Type": { "target": "com.amazonaws.dataexchange#ServerSideEncryptionTypes", "traits": { "smithy.api#documentation": "

The type of server side encryption used for encrypting the objects in Amazon S3.

", "smithy.api#required": {} } + }, + "KmsKeyArn": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

" + } } }, "traits": { @@ -1222,10 +1222,10 @@ "com.amazonaws.dataexchange#GetAssetRequest": { "type": "structure", "members": { - "AssetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for an asset.

", + "smithy.api#documentation": "

The unique identifier for a revision.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1238,10 +1238,10 @@ "smithy.api#required": {} } }, - "RevisionId": { + "AssetId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#documentation": "

The unique identifier for an asset.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1251,16 +1251,16 @@ "com.amazonaws.dataexchange#GetAssetResponse": { "type": "structure", "members": { - "RevisionId": { - "target": "com.amazonaws.dataexchange#Id", + "AssetDetails": { + "target": "com.amazonaws.dataexchange#AssetDetails", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this asset.

" + "smithy.api#documentation": "

Information about the asset, including its size.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "AssetType": { + "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "

The ARN for the asset.

" + "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" } }, "CreatedAt": { @@ -1269,46 +1269,46 @@ "smithy.api#documentation": "

The date and time that the asset was created, in ISO 8601 format.

" } }, - "DataSetId": { + "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this asset.

" + "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" } }, - "Id": { - "target": "com.amazonaws.dataexchange#Id", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The unique identifier for the asset.

" + "smithy.api#documentation": "

The ARN for the asset.

" } }, - "Name": { - "target": "com.amazonaws.dataexchange#AssetName", + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

" + "smithy.api#documentation": "

The date and time that the asset was last updated, in ISO 8601 format.

" } }, - "SourceId": { + "Id": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" + "smithy.api#documentation": "

The unique identifier for the asset.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The date and time that the asset was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The unique identifier for the data set associated with this asset.

" } }, - "AssetType": { - "target": "com.amazonaws.dataexchange#AssetType", + "Name": { + "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" + "smithy.api#documentation": "

The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.

" } }, - "AssetDetails": { - "target": "com.amazonaws.dataexchange#AssetDetails", + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

Information about the asset, including its size.

" + "smithy.api#documentation": "

The unique identifier for the revision associated with this asset.

" } } } @@ -1360,22 +1360,16 @@ "com.amazonaws.dataexchange#GetDataSetResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.dataexchange#Id", - "traits": { - "smithy.api#documentation": "

The unique identifier for the data set.

" - } - }, - "Description": { - "target": "com.amazonaws.dataexchange#Description", + "AssetType": { + "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "

The description for the data set.

" + "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

The date and time that the data set was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The tags for the data set.

" } }, "Origin": { @@ -1384,46 +1378,52 @@ "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" } }, - "Name": { - "target": "com.amazonaws.dataexchange#Name", + "OriginDetails": { + "target": "com.amazonaws.dataexchange#OriginDetails", "traits": { - "smithy.api#documentation": "

The name of the data set.

" + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The ARN for the data set.

" + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" } }, - "OriginDetails": { - "target": "com.amazonaws.dataexchange#OriginDetails", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" + "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

" } }, - "Tags": { - "target": "com.amazonaws.dataexchange#MapOf__string", + "Description": { + "target": "com.amazonaws.dataexchange#Description", "traits": { - "smithy.api#documentation": "

The tags for the data set.

" + "smithy.api#documentation": "

The description for the data set.

" } }, - "AssetType": { - "target": "com.amazonaws.dataexchange#AssetType", + "Id": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" + "smithy.api#documentation": "

The unique identifier for the data set.

" } }, - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

" + "smithy.api#documentation": "

The ARN for the data set.

" } }, - "SourceId": { - "target": "com.amazonaws.dataexchange#Id", + "Name": { + "target": "com.amazonaws.dataexchange#Name", "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" + "smithy.api#documentation": "

The name of the data set.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the data set was last updated, in ISO 8601 format.

" } } } @@ -1475,16 +1475,22 @@ "com.amazonaws.dataexchange#GetJobResponse": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the job.

" + } + }, "Id": { "target": "com.amazonaws.dataexchange#Id", "traits": { "smithy.api#documentation": "

The unique identifier for the job.

" } }, - "State": { - "target": "com.amazonaws.dataexchange#State", + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The state of the job.

" + "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

" } }, "CreatedAt": { @@ -1493,10 +1499,10 @@ "smithy.api#documentation": "

The date and time that the job was created, in ISO 8601 format.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "State": { + "target": "com.amazonaws.dataexchange#State", "traits": { - "smithy.api#documentation": "

The ARN for the job.

" + "smithy.api#documentation": "

The state of the job.

" } }, "Errors": { @@ -1505,23 +1511,17 @@ "smithy.api#documentation": "

The errors associated with jobs.

" } }, - "Type": { - "target": "com.amazonaws.dataexchange#Type", - "traits": { - "smithy.api#documentation": "

The job type.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

" - } - }, "Details": { "target": "com.amazonaws.dataexchange#ResponseDetails", "traits": { "smithy.api#documentation": "

Details about the job.

" } + }, + "Type": { + "target": "com.amazonaws.dataexchange#Type", + "traits": { + "smithy.api#documentation": "

The job type.

" + } } } }, @@ -1559,18 +1559,18 @@ "com.amazonaws.dataexchange#GetRevisionRequest": { "type": "structure", "members": { - "RevisionId": { + "DataSetId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#documentation": "

The unique identifier for a data set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DataSetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a data set.

", + "smithy.api#documentation": "

The unique identifier for a revision.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1580,28 +1580,22 @@ "com.amazonaws.dataexchange#GetRevisionResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.dataexchange#Id", - "traits": { - "smithy.api#documentation": "

The unique identifier for the revision.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The tags for the revision.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "Comment": { + "target": "com.amazonaws.dataexchange#__stringMin0Max16384", "traits": { - "smithy.api#documentation": "

The ARN for the revision

" + "smithy.api#documentation": "

An optional comment about the revision.

" } }, - "DataSetId": { - "target": "com.amazonaws.dataexchange#Id", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

" + "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

" } }, "Finalized": { @@ -1610,22 +1604,28 @@ "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" } }, - "Tags": { - "target": "com.amazonaws.dataexchange#MapOf__string", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The tags for the revision.

" + "smithy.api#documentation": "

The ARN for the revision

" } }, - "Comment": { - "target": "com.amazonaws.dataexchange#__stringMin0Max16384", + "Id": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

An optional comment about the revision.

" + "smithy.api#documentation": "

The unique identifier for the revision.

" } }, - "CreatedAt": { + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

" + } + }, + "UpdatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

" + "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" } }, "SourceId": { @@ -1656,17 +1656,17 @@ "com.amazonaws.dataexchange#ImportAssetFromSignedUrlRequestDetails": { "type": "structure", "members": { - "DataSetId": { - "target": "com.amazonaws.dataexchange#Id", + "AssetName": { + "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this import job.

", + "smithy.api#documentation": "

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.

", "smithy.api#required": {} } }, - "Md5Hash": { - "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

", + "smithy.api#documentation": "

The unique identifier for the data set associated with this import job.

", "smithy.api#required": {} } }, @@ -1677,10 +1677,10 @@ "smithy.api#required": {} } }, - "AssetName": { - "target": "com.amazonaws.dataexchange#AssetName", + "Md5Hash": { + "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", "traits": { - "smithy.api#documentation": "

The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.

", + "smithy.api#documentation": "

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

", "smithy.api#required": {} } } @@ -1692,12 +1692,6 @@ "com.amazonaws.dataexchange#ImportAssetFromSignedUrlResponseDetails": { "type": "structure", "members": { - "SignedUrl": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The signed URL.

" - } - }, "DataSetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { @@ -1711,12 +1705,6 @@ "smithy.api#documentation": "

The time and date at which the signed URL expires, in ISO 8601 format.

" } }, - "Md5Hash": { - "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", - "traits": { - "smithy.api#documentation": "

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

" - } - }, "AssetName": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { @@ -1724,12 +1712,24 @@ "smithy.api#required": {} } }, + "SignedUrl": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The signed URL.

" + } + }, "RevisionId": { "target": "com.amazonaws.dataexchange#Id", "traits": { "smithy.api#documentation": "

The unique identifier for the revision associated with this import response.

", "smithy.api#required": {} } + }, + "Md5Hash": { + "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", + "traits": { + "smithy.api#documentation": "

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

" + } } }, "traits": { @@ -1739,10 +1739,10 @@ "com.amazonaws.dataexchange#ImportAssetsFromS3RequestDetails": { "type": "structure", "members": { - "AssetSources": { - "target": "com.amazonaws.dataexchange#ListOfAssetSourceEntry", + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

Is a list of S3 bucket and object key pairs.

", + "smithy.api#documentation": "

The unique identifier for the revision associated with this import request.

", "smithy.api#required": {} } }, @@ -1753,10 +1753,10 @@ "smithy.api#required": {} } }, - "RevisionId": { - "target": "com.amazonaws.dataexchange#Id", + "AssetSources": { + "target": "com.amazonaws.dataexchange#ListOfAssetSourceEntry", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this import request.

", + "smithy.api#documentation": "

Is a list of S3 bucket and object key pairs.

", "smithy.api#required": {} } } @@ -1768,10 +1768,10 @@ "com.amazonaws.dataexchange#ImportAssetsFromS3ResponseDetails": { "type": "structure", "members": { - "DataSetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this import job.

", + "smithy.api#documentation": "

The unique identifier for the revision associated with this import response.

", "smithy.api#required": {} } }, @@ -1782,10 +1782,10 @@ "smithy.api#required": {} } }, - "RevisionId": { + "DataSetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this import response.

", + "smithy.api#documentation": "

The unique identifier for the data set associated with this import job.

", "smithy.api#required": {} } } @@ -1814,58 +1814,58 @@ "com.amazonaws.dataexchange#JobEntry": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "Type": { + "target": "com.amazonaws.dataexchange#Type", "traits": { - "smithy.api#documentation": "

The ARN for the job.

", + "smithy.api#documentation": "

The job type.

", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.dataexchange#Id", + "Errors": { + "target": "com.amazonaws.dataexchange#ListOfJobError", "traits": { - "smithy.api#documentation": "

The unique identifier for the job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Errors for jobs.

" } }, - "State": { - "target": "com.amazonaws.dataexchange#State", + "Details": { + "target": "com.amazonaws.dataexchange#ResponseDetails", "traits": { - "smithy.api#documentation": "

The state of the job.

", + "smithy.api#documentation": "

Details of the operation to be performed by the job, such as export destination details or import source details.

", "smithy.api#required": {} } }, - "Errors": { - "target": "com.amazonaws.dataexchange#ListOfJobError", + "Id": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

Errors for jobs.

" + "smithy.api#documentation": "

The unique identifier for the job.

", + "smithy.api#required": {} } }, - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The date and time that the job was created, in ISO 8601 format.

", + "smithy.api#documentation": "

The ARN for the job.

", "smithy.api#required": {} } }, - "Details": { - "target": "com.amazonaws.dataexchange#ResponseDetails", + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

Details of the operation to be performed by the job, such as export destination details or import source details.

", + "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.dataexchange#Type", + "State": { + "target": "com.amazonaws.dataexchange#State", "traits": { - "smithy.api#documentation": "

The job type.

", + "smithy.api#documentation": "

The state of the job.

", "smithy.api#required": {} } }, - "UpdatedAt": { + "CreatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

", + "smithy.api#documentation": "

The date and time that the job was created, in ISO 8601 format.

", "smithy.api#required": {} } } @@ -1877,21 +1877,6 @@ "com.amazonaws.dataexchange#JobError": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.dataexchange#JobErrorResourceTypes", - "traits": { - "smithy.api#documentation": "The type of resource related to the error." - } - }, - "Details": { - "target": "com.amazonaws.dataexchange#Details" - }, - "LimitValue": { - "target": "com.amazonaws.dataexchange#__double", - "traits": { - "smithy.api#documentation": "The value of the exceeded limit." - } - }, "Code": { "target": "com.amazonaws.dataexchange#Code", "traits": { @@ -1899,16 +1884,22 @@ "smithy.api#required": {} } }, + "ResourceId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The unique identifier for the resource related to the error." + } + }, "LimitName": { "target": "com.amazonaws.dataexchange#JobErrorLimitName", "traits": { "smithy.api#documentation": "

The name of the limit that was reached.

" } }, - "ResourceId": { - "target": "com.amazonaws.dataexchange#__string", + "LimitValue": { + "target": "com.amazonaws.dataexchange#__double", "traits": { - "smithy.api#documentation": "The unique identifier for the resource related to the error." + "smithy.api#documentation": "The value of the exceeded limit." } }, "Message": { @@ -1917,6 +1908,15 @@ "smithy.api#documentation": "The message related to the job error.", "smithy.api#required": {} } + }, + "ResourceType": { + "target": "com.amazonaws.dataexchange#JobErrorResourceTypes", + "traits": { + "smithy.api#documentation": "The type of resource related to the error." + } + }, + "Details": { + "target": "com.amazonaws.dataexchange#Details" } }, "traits": { @@ -2038,17 +2038,23 @@ "method": "GET", "uri": "/v1/data-sets/{DataSetId}/revisions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Revisions", + "pageSize": "MaxResults" } } }, "com.amazonaws.dataexchange#ListDataSetRevisionsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.dataexchange#MaxResults", + "NextToken": { + "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The maximum number of results returned by a single call.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" } }, "DataSetId": { @@ -2059,11 +2065,11 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.dataexchange#__string", + "MaxResults": { + "target": "com.amazonaws.dataexchange#MaxResults", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The maximum number of results returned by a single call.

", + "smithy.api#httpQuery": "maxResults" } } } @@ -2071,17 +2077,17 @@ "com.amazonaws.dataexchange#ListDataSetRevisionsResponse": { "type": "structure", "members": { - "Revisions": { - "target": "com.amazonaws.dataexchange#ListOfRevisionEntry", - "traits": { - "smithy.api#documentation": "

The asset objects listed by the request.

" - } - }, "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" } + }, + "Revisions": { + "target": "com.amazonaws.dataexchange#ListOfRevisionEntry", + "traits": { + "smithy.api#documentation": "

The asset objects listed by the request.

" + } } } }, @@ -2113,19 +2119,18 @@ "method": "GET", "uri": "/v1/data-sets", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSets", + "pageSize": "MaxResults" } } }, "com.amazonaws.dataexchange#ListDataSetsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.dataexchange#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results returned by a single call.

", - "smithy.api#httpQuery": "maxResults" - } - }, "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { @@ -2133,6 +2138,13 @@ "smithy.api#httpQuery": "nextToken" } }, + "MaxResults": { + "target": "com.amazonaws.dataexchange#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by a single call.

", + "smithy.api#httpQuery": "maxResults" + } + }, "Origin": { "target": "com.amazonaws.dataexchange#__string", "traits": { @@ -2145,17 +2157,17 @@ "com.amazonaws.dataexchange#ListDataSetsResponse": { "type": "structure", "members": { - "DataSets": { - "target": "com.amazonaws.dataexchange#ListOfDataSetEntry", - "traits": { - "smithy.api#documentation": "

The data set objects listed by the request.

" - } - }, "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" } + }, + "DataSets": { + "target": "com.amazonaws.dataexchange#ListOfDataSetEntry", + "traits": { + "smithy.api#documentation": "

The data set objects listed by the request.

" + } } } }, @@ -2187,12 +2199,25 @@ "method": "GET", "uri": "/v1/jobs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Jobs", + "pageSize": "MaxResults" } } }, "com.amazonaws.dataexchange#ListJobsRequest": { "type": "structure", "members": { + "RevisionId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#httpQuery": "revisionId" + } + }, "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { @@ -2213,30 +2238,23 @@ "smithy.api#documentation": "

The unique identifier for a data set.

", "smithy.api#httpQuery": "dataSetId" } - }, - "RevisionId": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

", - "smithy.api#httpQuery": "revisionId" - } } } }, "com.amazonaws.dataexchange#ListJobsResponse": { "type": "structure", "members": { - "Jobs": { - "target": "com.amazonaws.dataexchange#ListOfJobEntry", - "traits": { - "smithy.api#documentation": "

The jobs listed by the request.

" - } - }, "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" } + }, + "Jobs": { + "target": "com.amazonaws.dataexchange#ListOfJobEntry", + "traits": { + "smithy.api#documentation": "

The jobs listed by the request.

" + } } } }, @@ -2322,18 +2340,23 @@ "method": "GET", "uri": "/v1/data-sets/{DataSetId}/revisions/{RevisionId}/assets", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Assets", + "pageSize": "MaxResults" } } }, "com.amazonaws.dataexchange#ListRevisionAssetsRequest": { "type": "structure", "members": { - "RevisionId": { + "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { @@ -2351,11 +2374,12 @@ "smithy.api#required": {} } }, - "NextToken": { + "RevisionId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -2363,17 +2387,17 @@ "com.amazonaws.dataexchange#ListRevisionAssetsResponse": { "type": "structure", "members": { - "Assets": { - "target": "com.amazonaws.dataexchange#ListOfAssetEntry", - "traits": { - "smithy.api#documentation": "

The asset objects listed by the request.

" - } - }, "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" } + }, + "Assets": { + "target": "com.amazonaws.dataexchange#ListOfAssetEntry", + "traits": { + "smithy.api#documentation": "

The asset objects listed by the request.

" + } } } }, @@ -2479,16 +2503,16 @@ "com.amazonaws.dataexchange#RequestDetails": { "type": "structure", "members": { - "ExportAssetToSignedUrl": { - "target": "com.amazonaws.dataexchange#ExportAssetToSignedUrlRequestDetails", + "ExportAssetsToS3": { + "target": "com.amazonaws.dataexchange#ExportAssetsToS3RequestDetails", "traits": { - "smithy.api#documentation": "

Details about the export to signed URL request.

" + "smithy.api#documentation": "

Details about the export to Amazon S3 request.

" } }, - "ImportAssetsFromS3": { - "target": "com.amazonaws.dataexchange#ImportAssetsFromS3RequestDetails", + "ExportAssetToSignedUrl": { + "target": "com.amazonaws.dataexchange#ExportAssetToSignedUrlRequestDetails", "traits": { - "smithy.api#documentation": "

Details about the import from Amazon S3 request.

" + "smithy.api#documentation": "

Details about the export to signed URL request.

" } }, "ImportAssetFromSignedUrl": { @@ -2497,10 +2521,10 @@ "smithy.api#documentation": "

Details about the import from signed URL request.

" } }, - "ExportAssetsToS3": { - "target": "com.amazonaws.dataexchange#ExportAssetsToS3RequestDetails", + "ImportAssetsFromS3": { + "target": "com.amazonaws.dataexchange#ImportAssetsFromS3RequestDetails", "traits": { - "smithy.api#documentation": "

Details about the export to Amazon S3 request.

" + "smithy.api#documentation": "

Details about the import from Amazon S3 request.

" } } }, @@ -2563,28 +2587,28 @@ "com.amazonaws.dataexchange#ResponseDetails": { "type": "structure", "members": { + "ExportAssetToSignedUrl": { + "target": "com.amazonaws.dataexchange#ExportAssetToSignedUrlResponseDetails", + "traits": { + "smithy.api#documentation": "

Details for the export to signed URL response.

" + } + }, "ExportAssetsToS3": { "target": "com.amazonaws.dataexchange#ExportAssetsToS3ResponseDetails", "traits": { "smithy.api#documentation": "

Details for the export to Amazon S3 response.

" } }, - "ImportAssetFromSignedUrl": { - "target": "com.amazonaws.dataexchange#ImportAssetFromSignedUrlResponseDetails", - "traits": { - "smithy.api#documentation": "

Details for the import from signed URL response.

" - } - }, "ImportAssetsFromS3": { "target": "com.amazonaws.dataexchange#ImportAssetsFromS3ResponseDetails", "traits": { "smithy.api#documentation": "

Details for the import from Amazon S3 response.

" } }, - "ExportAssetToSignedUrl": { - "target": "com.amazonaws.dataexchange#ExportAssetToSignedUrlResponseDetails", + "ImportAssetFromSignedUrl": { + "target": "com.amazonaws.dataexchange#ImportAssetFromSignedUrlResponseDetails", "traits": { - "smithy.api#documentation": "

Details for the export to signed URL response.

" + "smithy.api#documentation": "

Details for the import from signed URL response.

" } } }, @@ -2595,37 +2619,37 @@ "com.amazonaws.dataexchange#RevisionEntry": { "type": "structure", "members": { - "DataSetId": { - "target": "com.amazonaws.dataexchange#Id", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

", + "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

", "smithy.api#required": {} } }, - "SourceId": { - "target": "com.amazonaws.dataexchange#Id", + "Finalized": { + "target": "com.amazonaws.dataexchange#__boolean", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" } }, - "Id": { - "target": "com.amazonaws.dataexchange#Id", + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision.

", + "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

", "smithy.api#required": {} } }, - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" } }, - "Comment": { - "target": "com.amazonaws.dataexchange#__stringMin0Max16384", + "Id": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

An optional comment about the revision.

" + "smithy.api#documentation": "

The unique identifier for the revision.

", + "smithy.api#required": {} } }, "Arn": { @@ -2635,17 +2659,17 @@ "smithy.api#required": {} } }, - "Finalized": { - "target": "com.amazonaws.dataexchange#__boolean", + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

", + "smithy.api#required": {} } }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Comment": { + "target": "com.amazonaws.dataexchange#__stringMin0Max16384", "traits": { - "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional comment about the revision.

" } } }, @@ -2687,11 +2711,10 @@ "com.amazonaws.dataexchange#ServiceLimitExceededException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.dataexchange#__string", + "LimitValue": { + "target": "com.amazonaws.dataexchange#__double", "traits": { - "smithy.api#documentation": "

The request has exceeded the quotas imposed by the service.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum value for the service-specific limit.

" } }, "LimitName": { @@ -2700,10 +2723,11 @@ "smithy.api#documentation": "

The name of the quota that was exceeded.

" } }, - "LimitValue": { - "target": "com.amazonaws.dataexchange#__double", + "Message": { + "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The maximum value for the service-specific limit.

" + "smithy.api#documentation": "

The request has exceeded the quotas imposed by the service.

", + "smithy.api#required": {} } } }, @@ -2958,14 +2982,6 @@ "com.amazonaws.dataexchange#UpdateAssetRequest": { "type": "structure", "members": { - "AssetId": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for an asset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { @@ -2981,6 +2997,14 @@ "smithy.api#required": {} } }, + "AssetId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for an asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "DataSetId": { "target": "com.amazonaws.dataexchange#__string", "traits": { @@ -2997,34 +3021,10 @@ "com.amazonaws.dataexchange#UpdateAssetResponse": { "type": "structure", "members": { - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the asset was created, in ISO 8601 format.

" - } - }, - "RevisionId": { + "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the revision associated with this asset.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the asset was last updated, in ISO 8601 format.

" - } - }, - "AssetType": { - "target": "com.amazonaws.dataexchange#AssetType", - "traits": { - "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" - } - }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the asset.

" + "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" } }, "AssetDetails": { @@ -3051,10 +3051,34 @@ "smithy.api#documentation": "

The unique identifier for the asset.

" } }, - "SourceId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" + "smithy.api#documentation": "

The unique identifier for the revision associated with this asset.

" + } + }, + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the asset.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the asset was created, in ISO 8601 format.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the asset was last updated, in ISO 8601 format.

" + } + }, + "AssetType": { + "target": "com.amazonaws.dataexchange#AssetType", + "traits": { + "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" } } } @@ -3096,12 +3120,6 @@ "com.amazonaws.dataexchange#UpdateDataSetRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.dataexchange#Description", - "traits": { - "smithy.api#documentation": "

The description for the data set.

" - } - }, "Name": { "target": "com.amazonaws.dataexchange#Name", "traits": { @@ -3115,6 +3133,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.dataexchange#Description", + "traits": { + "smithy.api#documentation": "

The description for the data set.

" + } } }, "traits": { @@ -3124,64 +3148,64 @@ "com.amazonaws.dataexchange#UpdateDataSetResponse": { "type": "structure", "members": { - "OriginDetails": { - "target": "com.amazonaws.dataexchange#OriginDetails", + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" + "smithy.api#documentation": "

The date and time that the data set was last updated, in ISO 8601 format.

" } }, - "Name": { - "target": "com.amazonaws.dataexchange#Name", + "Description": { + "target": "com.amazonaws.dataexchange#Description", "traits": { - "smithy.api#documentation": "

The name of the data set.

" + "smithy.api#documentation": "

The description for the data set.

" } }, - "SourceId": { + "Id": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" + "smithy.api#documentation": "

The unique identifier for the data set.

" } }, - "Origin": { - "target": "com.amazonaws.dataexchange#Origin", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" + "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

" } }, - "Description": { - "target": "com.amazonaws.dataexchange#Description", + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The description for the data set.

" + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" } }, - "Id": { - "target": "com.amazonaws.dataexchange#Id", + "OriginDetails": { + "target": "com.amazonaws.dataexchange#OriginDetails", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set.

" + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" } }, - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "AssetType": { + "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "

The ARN for the data set.

" + "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" } }, - "CreatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Name": { + "target": "com.amazonaws.dataexchange#Name", "traits": { - "smithy.api#documentation": "

The date and time that the data set was created, in ISO 8601 format.

" + "smithy.api#documentation": "

The name of the data set.

" } }, - "AssetType": { - "target": "com.amazonaws.dataexchange#AssetType", + "Origin": { + "target": "com.amazonaws.dataexchange#Origin", "traits": { - "smithy.api#documentation": "

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

" + "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" } }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The date and time that the data set was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The ARN for the data set.

" } } } @@ -3226,10 +3250,10 @@ "com.amazonaws.dataexchange#UpdateRevisionRequest": { "type": "structure", "members": { - "DataSetId": { + "RevisionId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a data set.

", + "smithy.api#documentation": "

The unique identifier for a revision.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3246,10 +3270,10 @@ "smithy.api#documentation": "

An optional comment about the revision.

" } }, - "RevisionId": { + "DataSetId": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#documentation": "

The unique identifier for a data set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3262,16 +3286,16 @@ "com.amazonaws.dataexchange#UpdateRevisionResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.dataexchange#Arn", + "SourceId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The ARN for the revision.

" + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" } }, - "Finalized": { - "target": "com.amazonaws.dataexchange#__boolean", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

" } }, "Id": { @@ -3280,22 +3304,22 @@ "smithy.api#documentation": "

The unique identifier for the revision.

" } }, - "DataSetId": { - "target": "com.amazonaws.dataexchange#Id", + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

" + "smithy.api#documentation": "

The ARN for the revision.

" } }, - "CreatedAt": { + "UpdatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the revision was created, in ISO 8601 format.

" + "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" } }, - "SourceId": { - "target": "com.amazonaws.dataexchange#Id", + "Finalized": { + "target": "com.amazonaws.dataexchange#__boolean", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" } }, "Comment": { @@ -3304,10 +3328,10 @@ "smithy.api#documentation": "

An optional comment about the revision.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.dataexchange#Timestamp", + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The date and time that the revision was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The unique identifier for the data set associated with this revision.

" } } } diff --git a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json index d55c758a4432..5bd532923eba 100644 --- a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json +++ b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json @@ -76,17 +76,17 @@ "smithy.api#documentation": "

The name of the agent.

" } }, - "AgentArn": { - "target": "com.amazonaws.datasync#AgentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent.

" - } - }, "Status": { "target": "com.amazonaws.datasync#AgentStatus", "traits": { "smithy.api#documentation": "

The status of the agent.

" } + }, + "AgentArn": { + "target": "com.amazonaws.datasync#AgentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent.

" + } } }, "traits": { @@ -188,22 +188,23 @@ } ], "traits": { - "smithy.api#documentation": "

Activates an AWS DataSync agent that you have deployed on your host. The activation\n process associates your agent with your account. In the activation process, you specify\n information such as the AWS Region that you want to activate the agent in. You activate the\n agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your\n tasks are created in this AWS Region.

\n

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to\n a VPC endpoint so you can run tasks without going over the public Internet.

\n

You can use an agent for more than one location. If a task uses multiple agents, all of\n them need to have status AVAILABLE for the task to run. If you use multiple agents for a\n source location, the status of all the agents must be AVAILABLE for the task to run.

\n \n\n

Agents are automatically updated by AWS on a regular basis, using a mechanism that\n ensures minimal interruption to your tasks.

\n

" + "smithy.api#documentation": "

Activates an AWS DataSync agent that you have deployed on your host. The activation\n process associates your agent with your account. In the activation process, you specify\n information such as the AWS Region that you want to activate the agent in. You activate the\n agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your\n tasks are created in this AWS Region.

\n

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to\n a VPC endpoint so you can run tasks without going over the public internet.

\n

You can use an agent for more than one location. If a task uses multiple agents, all of\n them need to have status AVAILABLE for the task to run. If you use multiple agents for a\n source location, the status of all the agents must be AVAILABLE for the task to run.

\n \n\n

Agents are automatically updated by AWS on a regular basis, using a mechanism that\n ensures minimal interruption to your tasks.

\n

" } }, "com.amazonaws.datasync#CreateAgentRequest": { "type": "structure", "members": { - "SubnetArns": { - "target": "com.amazonaws.datasync#PLSubnetArnList", + "ActivationKey": { + "target": "com.amazonaws.datasync#ActivationKey", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic\n network interfaces for each data transfer task. The agent that runs a task must be private.\n When you start a task that is associated with an agent created in a VPC, or one that has\n access to an IP address in a VPC, then the task is also private. In this case, DataSync\n creates four network interfaces for each task in your subnet. For a data transfer to work, the\n agent must be able to route to all these four network interfaces.

" + "smithy.api#documentation": "

Your agent activation key. You can get the activation key either by sending an HTTP GET\n request with redirects that enable you to get the agent IP address (port 80). Alternatively,\n you can get it from the AWS DataSync console.

\n

The redirect URL returned in the response provides you the activation key for your\n agent in the query string parameter activationKey. It might also include other\n activation-related parameters; however, these are merely defaults. The arguments you pass to\n this API call determine the actual configuration of your agent.

\n \n\n

For more information, see Activating an Agent in the AWS DataSync\n User Guide.\n

", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#PLSecurityGroupArnList", "traits": { - "smithy.api#documentation": "

The key-value pair that represents the tag that you want to associate with the agent.\n The value can be an empty string. This value helps you manage, filter, and search for your\n agents.

\n \n

Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @.

\n " + "smithy.api#documentation": "

The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.

" } }, "VpcEndpointId": { @@ -212,23 +213,22 @@ "smithy.api#documentation": "

The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is\n the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC\n endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

\n

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

" } }, - "AgentName": { - "target": "com.amazonaws.datasync#TagValue", + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "

The name you configured for your agent. This value is a text reference that is used to\n identify the agent in the console.

" + "smithy.api#documentation": "

The key-value pair that represents the tag that you want to associate with the agent.\n The value can be an empty string. This value helps you manage, filter, and search for your\n agents.

\n \n

Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @.

\n " } }, - "ActivationKey": { - "target": "com.amazonaws.datasync#ActivationKey", + "SubnetArns": { + "target": "com.amazonaws.datasync#PLSubnetArnList", "traits": { - "smithy.api#documentation": "

Your agent activation key. You can get the activation key either by sending an HTTP GET\n request with redirects that enable you to get the agent IP address (port 80). Alternatively,\n you can get it from the AWS DataSync console.

\n

The redirect URL returned in the response provides you the activation key for your\n agent in the query string parameter activationKey. It might also include other\n activation-related parameters; however, these are merely defaults. The arguments you pass to\n this API call determine the actual configuration of your agent.

\n \n\n

For more information, see Activating an Agent in the AWS DataSync\n User Guide.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic\n network interfaces for each data transfer task. The agent that runs a task must be private.\n When you start a task that is associated with an agent created in a VPC, or one that has\n access to an IP address in a VPC, then the task is also private. In this case, DataSync\n creates four network interfaces for each task in your subnet. For a data transfer to work, the\n agent must be able to route to all these four network interfaces.

" } }, - "SecurityGroupArns": { - "target": "com.amazonaws.datasync#PLSecurityGroupArnList", + "AgentName": { + "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "

The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.

" + "smithy.api#documentation": "

The name you configured for your agent. This value is a text reference that is used to\n identify the agent in the console.

" } } }, @@ -273,23 +273,16 @@ "com.amazonaws.datasync#CreateLocationEfsRequest": { "type": "structure", "members": { - "Subdirectory": { - "target": "com.amazonaws.datasync#EfsSubdirectory", - "traits": { - "smithy.api#documentation": "

A subdirectory in the location’s path. This subdirectory in the EFS file system is used\n to read data from the EFS source location or write data to the EFS destination. By default,\n AWS DataSync uses the root directory.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n " - } - }, "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { "smithy.api#documentation": "

The key-value pair that represents a tag that you want to add to the resource. The\n value can be an empty string. This value helps you manage, filter, and search for your\n resources. We recommend that you create a name tag for your location.

" } }, - "EfsFilesystemArn": { - "target": "com.amazonaws.datasync#EfsFilesystemArn", + "Subdirectory": { + "target": "com.amazonaws.datasync#EfsSubdirectory", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Amazon EFS file system.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A subdirectory in the location’s path. This subdirectory in the EFS file system is used\n to read data from the EFS source location or write data to the EFS destination. By default,\n AWS DataSync uses the root directory.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n " } }, "Ec2Config": { @@ -298,6 +291,13 @@ "smithy.api#documentation": "

The subnet and security group that the Amazon EFS file system uses. The security group\n that you provide needs to be able to communicate with the security group on the mount target\n in the subnet specified.

\n

The exact relationship between security group M (of the mount target) and security\n group S (which you provide for DataSync to use at this stage) is as follows:

\n ", "smithy.api#required": {} } + }, + "EfsFilesystemArn": { + "target": "com.amazonaws.datasync#EfsFilesystemArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Amazon EFS file system.

", + "smithy.api#required": {} + } } }, "traits": { @@ -348,13 +348,6 @@ "smithy.api#required": {} } }, - "FsxFilesystemArn": { - "target": "com.amazonaws.datasync#FsxFilesystemArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the FSx for Windows file system.

", - "smithy.api#required": {} - } - }, "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { @@ -374,17 +367,24 @@ "smithy.api#documentation": "

The key-value pair that represents a tag that you want to add to the resource. The\n value can be an empty string. This value helps you manage, filter, and search for your\n resources. We recommend that you create a name tag for your location.

" } }, - "User": { - "target": "com.amazonaws.datasync#SmbUser", + "Subdirectory": { + "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", "traits": { - "smithy.api#documentation": "

The user who has the permissions to access files and folders in the\n FSx for Windows file system.

", + "smithy.api#documentation": "

A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows file system is used\n to read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.

" + } + }, + "FsxFilesystemArn": { + "target": "com.amazonaws.datasync#FsxFilesystemArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the FSx for Windows file system.

", "smithy.api#required": {} } }, - "Subdirectory": { - "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", + "User": { + "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "

A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows file system is used\n to read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.

" + "smithy.api#documentation": "

The user who has the permissions to access files and folders in the\n FSx for Windows file system.

", + "smithy.api#required": {} } } } @@ -423,23 +423,23 @@ "com.amazonaws.datasync#CreateLocationNfsRequest": { "type": "structure", "members": { - "MountOptions": { - "target": "com.amazonaws.datasync#NfsMountOptions", + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "

The NFS mount options that DataSync can use to mount your NFS share.

" + "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.

" } }, - "OnPremConfig": { - "target": "com.amazonaws.datasync#OnPremConfig", + "Subdirectory": { + "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to\n an NFS server.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

", + "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n

To see all the paths exported by your NFS server. run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", + "MountOptions": { + "target": "com.amazonaws.datasync#NfsMountOptions", "traits": { - "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.

" + "smithy.api#documentation": "

The NFS mount options that DataSync can use to mount your NFS share.

" } }, "ServerHostname": { @@ -449,10 +449,10 @@ "smithy.api#required": {} } }, - "Subdirectory": { - "target": "com.amazonaws.datasync#NfsSubdirectory", + "OnPremConfig": { + "target": "com.amazonaws.datasync#OnPremConfig", "traits": { - "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n

To see all the paths exported by your NFS server. run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

", + "smithy.api#documentation": "

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to\n an NFS server.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

", "smithy.api#required": {} } } @@ -492,7 +492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for a self-managed object storage bucket.

" + "smithy.api#documentation": "

Creates an endpoint for a self-managed object storage bucket. For more information\n about self-managed object storage locations, see create-object-location.

" } }, "com.amazonaws.datasync#CreateLocationObjectStorageRequest": { @@ -504,22 +504,16 @@ "smithy.api#documentation": "

The protocol that the object storage server uses to communicate. \n Valid values are HTTP or HTTPS.

" } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", - "traits": { - "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.

" - } - }, - "Subdirectory": { - "target": "com.amazonaws.datasync#S3Subdirectory", + "SecretKey": { + "target": "com.amazonaws.datasync#ObjectStorageSecretKey", "traits": { - "smithy.api#documentation": "

The subdirectory in the self-managed object storage server that is used\n to read data from.

" + "smithy.api#documentation": "

Optional. The secret key is used if credentials are required to access the self-managed\n object storage server. If your object storage requires a user name and password to\n authenticate, use AccessKey and SecretKey to provide the user name\n and password, respectively.

" } }, - "AgentArns": { - "target": "com.amazonaws.datasync#AgentArnList", + "ServerHostname": { + "target": "com.amazonaws.datasync#ServerHostname", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agents associated with the \n self-managed object storage server location.

", + "smithy.api#documentation": "

The name of the self-managed object storage server. This value is the \n IP address or Domain Name Service (DNS) name of the object storage server. \n An agent uses this host name to mount the object storage server in a network.

", "smithy.api#required": {} } }, @@ -530,16 +524,16 @@ "smithy.api#required": {} } }, - "AccessKey": { - "target": "com.amazonaws.datasync#ObjectStorageAccessKey", + "Subdirectory": { + "target": "com.amazonaws.datasync#S3Subdirectory", "traits": { - "smithy.api#documentation": "

Optional. The access key is used if credentials are required to access \n the self-managed object storage server.

" + "smithy.api#documentation": "

The subdirectory in the self-managed object storage server that is used\n to read data from.

" } }, - "SecretKey": { - "target": "com.amazonaws.datasync#ObjectStorageSecretKey", + "AccessKey": { + "target": "com.amazonaws.datasync#ObjectStorageAccessKey", "traits": { - "smithy.api#documentation": "

Optional. The secret key is used if credentials are required to access \n the self-managed object storage server.

" + "smithy.api#documentation": "

Optional. The access key is used if credentials are required to access the self-managed\n object storage server. If your object storage requires a user name and password to\n authenticate, use AccessKey and SecretKey to provide the user name\n and password, respectively.

" } }, "ServerPort": { @@ -548,12 +542,18 @@ "smithy.api#documentation": "

The port that your self-managed object storage server accepts inbound network traffic on.\n The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can \n specify a custom port if your self-managed object storage server requires one.

" } }, - "ServerHostname": { - "target": "com.amazonaws.datasync#ServerHostname", + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

The name of the self-managed object storage server. This value is the \n IP address or Domain Name Service (DNS) name of the object storage server. \n An agent uses this host name to mount the object storage server in a network.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agents associated with the \n self-managed object storage server location.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.

" + } } }, "traits": { @@ -591,28 +591,23 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an Amazon S3 bucket.

\n

For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access\n Management (IAM) role that has the required permissions. You can set up the required\n permissions by creating an IAM policy that grants the required permissions and attaching the\n policy to the role. An example of such a policy is shown in the examples section.

\n\n \n

For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the\n AWS DataSync User Guide.\n

" + "smithy.api#documentation": "

Creates an endpoint for an Amazon S3 bucket.

\n\n \n

For more information, see\n https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli\n in the AWS DataSync User Guide.

" } }, "com.amazonaws.datasync#CreateLocationS3Request": { "type": "structure", "members": { - "S3Config": { - "target": "com.amazonaws.datasync#S3Config", + "S3BucketArn": { + "target": "com.amazonaws.datasync#S3BucketArn", "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket. If the bucket is on an \n AWS Outpost, this must be an access point ARN.

", "smithy.api#required": {} } }, - "S3StorageClass": { - "target": "com.amazonaws.datasync#S3StorageClass", - "traits": { - "smithy.api#documentation": "

The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the\n Amazon Simple Storage Service Developer Guide. Some storage classes\n have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

" - } - }, - "Subdirectory": { - "target": "com.amazonaws.datasync#S3Subdirectory", + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read\n data from the S3 source location or write data to the S3 destination.

" + "smithy.api#documentation": "

If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of \n the DataSync agents deployed on your AWS Outpost. For more information about launching a \n DataSync agent on an Amazon Outpost, see outposts-agent.

" } }, "Tags": { @@ -621,12 +616,23 @@ "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.

" } }, - "S3BucketArn": { - "target": "com.amazonaws.datasync#S3BucketArn", + "S3StorageClass": { + "target": "com.amazonaws.datasync#S3StorageClass", + "traits": { + "smithy.api#documentation": "

The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in AWS Regions, the storage class defaults to Standard.\n For buckets on AWS Outposts, the storage class defaults to AWS S3 Outposts.

\n \n

For more information about S3 storage classes, see Amazon S3 Storage Classes in the\n Amazon Simple Storage Service Developer Guide. Some storage classes\n have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

" + } + }, + "S3Config": { + "target": "com.amazonaws.datasync#S3Config", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

", "smithy.api#required": {} } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#S3Subdirectory", + "traits": { + "smithy.api#documentation": "

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read\n data from the S3 source location or write data to the S3 destination.

" + } } }, "traits": { @@ -676,23 +682,16 @@ "smithy.api#documentation": "

The name of the Windows domain that the SMB server belongs to.

" } }, - "AgentArns": { - "target": "com.amazonaws.datasync#AgentArnList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)\n location.

", - "smithy.api#required": {} - } - }, "MountOptions": { "target": "com.amazonaws.datasync#SmbMountOptions", "traits": { "smithy.api#documentation": "

The mount options used by DataSync to access the SMB server.

" } }, - "Password": { - "target": "com.amazonaws.datasync#SmbPassword", + "Subdirectory": { + "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { - "smithy.api#documentation": "

The password of the user who can mount the share, has the permissions to access files and\n folders in the SMB share.

", + "smithy.api#documentation": "

The subdirectory in the SMB file system that is used to read data from the SMB source\n location or write data to the SMB destination. The SMB path should be a path that's\n exported by the SMB server, or a subdirectory of that path. The path should be such that it\n can be mounted by other SMB clients in your network.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n \n \n

To transfer all the data in the folder you specified, DataSync needs to have permissions\n to mount the SMB share, as well as to access all the data in that share. To ensure this,\n either ensure that the user/password specified belongs to the user who can mount the share,\n and who has the appropriate permissions for all of the files and directories that you want\n DataSync to access, or use credentials of a member of the Backup Operators group to mount\n the share. Doing either enables the agent to access the data. For the agent to access\n directories, you must additionally enable all execute access.

", "smithy.api#required": {} } }, @@ -703,16 +702,10 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", - "traits": { - "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The value\n can be an empty string. We recommend using tags to name your resources.

" - } - }, - "Subdirectory": { - "target": "com.amazonaws.datasync#SmbSubdirectory", + "Password": { + "target": "com.amazonaws.datasync#SmbPassword", "traits": { - "smithy.api#documentation": "

The subdirectory in the SMB file system that is used to read data from the SMB source\n location or write data to the SMB destination. The SMB path should be a path that's\n exported by the SMB server, or a subdirectory of that path. The path should be such that it\n can be mounted by other SMB clients in your network.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n \n \n

To transfer all the data in the folder you specified, DataSync needs to have permissions\n to mount the SMB share, as well as to access all the data in that share. To ensure this,\n either ensure that the user/password specified belongs to the user who can mount the share,\n and who has the appropriate permissions for all of the files and directories that you want\n DataSync to access, or use credentials of a member of the Backup Operators group to mount\n the share. Doing either enables the agent to access the data. For the agent to access\n directories, you must additionally enable all execute access.

", + "smithy.api#documentation": "

The password of the user who can mount the share, has the permissions to access files and\n folders in the SMB share.

", "smithy.api#required": {} } }, @@ -722,6 +715,19 @@ "smithy.api#documentation": "

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name\n of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB\n server in a network.

\n \n

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

\n ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The value\n can be an empty string. We recommend using tags to name your resources.

" + } + }, + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)\n location.

", + "smithy.api#required": {} + } } }, "traits": { @@ -759,7 +765,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a task. A task is a set of two locations (source and destination) and a set of\n Options that you use to control the behavior of a task. If you don't specify Options when you\n create a task, AWS DataSync populates them with service defaults.

\n

When you create a task, it first enters the CREATING state. During CREATING\n AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task\n transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If\n required, AWS DataSync mounts the AWS location before each task execution.

\n

If an agent that is associated with a source (NFS) location goes offline, the task\n transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING\n status for more than a few minutes, it means that your agent might be having trouble mounting\n the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often\n caused by either a misconfigured firewall or a mistyped NFS server host name.

" + "smithy.api#documentation": "

Creates a task. A task is a set of two locations (source and destination) and a set of\n Options that you use to control the behavior of a task. If you don't specify Options when you\n create a task, AWS DataSync populates them with service defaults.

\n

When you create a task, it first enters the CREATING state. During CREATING\n AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task\n transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If\n required, AWS DataSync mounts the AWS location before each task execution.

\n

If an agent that is associated with a source (NFS) location goes offline, the task\n transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING\n status for more than a few minutes, it means that your agent might be having trouble mounting\n the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often\n caused by either a misconfigured firewall or a mistyped NFS server hostname.

" } }, "com.amazonaws.datasync#CreateTaskRequest": { @@ -772,10 +778,10 @@ "smithy.api#required": {} } }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.datasync#LogGroupArn", + "Options": { + "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor and log events in the task.

" + "smithy.api#documentation": "

The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution. You can configure these\n options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data\n integrity verification, and so on.

\n

For each individual task execution, you can override these options by specifying the\n OverrideOptions before starting the task execution. For more information, see\n the operation.

" } }, "Name": { @@ -784,11 +790,10 @@ "smithy.api#documentation": "

The name of a task. This value is a text reference that is used to identify the task in\n the console.

" } }, - "DestinationLocationArn": { - "target": "com.amazonaws.datasync#LocationArn", + "Excludes": { + "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS storage resource's location.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\"\n

\n

\n

" } }, "Tags": { @@ -797,22 +802,23 @@ "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the resource. The\n value can be an empty string.

" } }, - "Excludes": { - "target": "com.amazonaws.datasync#FilterList", + "DestinationLocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\"\n

\n

\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS storage resource's location.

", + "smithy.api#required": {} } }, - "Schedule": { - "target": "com.amazonaws.datasync#TaskSchedule", + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "

Specifies a schedule used to periodically transfer files from a source to a destination\n location. The schedule should be specified in UTC time. For more information, see task-scheduling.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor and log events in the task.

" } }, - "Options": { - "target": "com.amazonaws.datasync#Options", + "Schedule": { + "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "

The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution. You can configure these\n options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data\n integrity verification, and so on.

\n

For each individual task execution, you can override these options by specifying the\n OverrideOptions before starting the task execution. For more information, see\n the operation.

" + "smithy.api#documentation": "

Specifies a schedule used to periodically transfer files from a source to a destination\n location. The schedule should be specified in UTC time. For more information, see task-scheduling.

" } } }, @@ -995,10 +1001,10 @@ "smithy.api#documentation": "

The time that the agent was activated (that is, created in your account).

" } }, - "Name": { - "target": "com.amazonaws.datasync#TagValue", + "AgentArn": { + "target": "com.amazonaws.datasync#AgentArn", "traits": { - "smithy.api#documentation": "

The name of the agent.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent.

" } }, "EndpointType": { @@ -1007,12 +1013,6 @@ "smithy.api#documentation": "

The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint,\n the agent is not accessible over the public internet.

" } }, - "LastConnectionTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "

The time that the agent last connected to DataSyc.

" - } - }, "Status": { "target": "com.amazonaws.datasync#AgentStatus", "traits": { @@ -1025,10 +1025,16 @@ "smithy.api#documentation": "

The subnet and the security group that DataSync used to access a VPC endpoint.

" } }, - "AgentArn": { - "target": "com.amazonaws.datasync#AgentArn", + "LastConnectionTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent.

" + "smithy.api#documentation": "

The time that the agent last connected to DataSyc.

" + } + }, + "Name": { + "target": "com.amazonaws.datasync#TagValue", + "traits": { + "smithy.api#documentation": "

The name of the agent.

" } } }, @@ -1074,25 +1080,25 @@ "com.amazonaws.datasync#DescribeLocationEfsResponse": { "type": "structure", "members": { - "Ec2Config": { - "target": "com.amazonaws.datasync#Ec2Config" - }, - "LocationUri": { - "target": "com.amazonaws.datasync#LocationUri", + "CreationTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The URL of the EFS location that was described.

" + "smithy.api#documentation": "

The time that the EFS location was created.

" } }, + "Ec2Config": { + "target": "com.amazonaws.datasync#Ec2Config" + }, "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the EFS location that was described.

" } }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "

The time that the EFS location was created.

" + "smithy.api#documentation": "

The URL of the EFS location that was described.

" } } }, @@ -1141,16 +1147,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FSx for Windows location that was described.

" } }, + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", + "traits": { + "smithy.api#documentation": "

The URL of the FSx for Windows location that was described.

" + } + }, "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { "smithy.api#documentation": "

The user who has the permissions to access files and folders in the\n FSx for Windows file system.

" } }, - "Domain": { - "target": "com.amazonaws.datasync#SmbDomain", + "CreationTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The name of the Windows domain that the FSx for Windows server belongs to.

" + "smithy.api#documentation": "

The time that the FSx for Windows location was created.

" } }, "SecurityGroupArns": { @@ -1159,16 +1171,10 @@ "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx\n for Windows file system.

" } }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "

The time that the FSx for Windows location was created.

" - } - }, - "LocationUri": { - "target": "com.amazonaws.datasync#LocationUri", + "Domain": { + "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "

The URL of the FSx for Windows location that was described.

" + "smithy.api#documentation": "

The name of the Windows domain that the FSx for Windows server belongs to.

" } } } @@ -1211,32 +1217,32 @@ "com.amazonaws.datasync#DescribeLocationNfsResponse": { "type": "structure", "members": { - "LocationUri": { - "target": "com.amazonaws.datasync#LocationUri", - "traits": { - "smithy.api#documentation": "

The URL of the source NFS location that was described.

" - } - }, "MountOptions": { "target": "com.amazonaws.datasync#NfsMountOptions", "traits": { "smithy.api#documentation": "

The NFS mount options that DataSync used to mount your NFS share.

" } }, + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", + "traits": { + "smithy.api#documentation": "

The URL of the source NFS location that was described.

" + } + }, "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NFS location that was described.

" } }, - "OnPremConfig": { - "target": "com.amazonaws.datasync#OnPremConfig" - }, "CreationTime": { "target": "com.amazonaws.datasync#Time", "traits": { "smithy.api#documentation": "

The time that the NFS location was created.

" } + }, + "OnPremConfig": { + "target": "com.amazonaws.datasync#OnPremConfig" } }, "traits": { @@ -1260,7 +1266,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata about a self-managed object storage server location.

" + "smithy.api#documentation": "

Returns metadata about a self-managed object storage server location. For more information\n about self-managed object storage locations, see create-object-location.

" } }, "com.amazonaws.datasync#DescribeLocationObjectStorageRequest": { @@ -1287,10 +1293,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agents associated with the \n self-managed object storage server location.

" } }, - "LocationArn": { - "target": "com.amazonaws.datasync#LocationArn", + "CreationTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.

" + "smithy.api#documentation": "

The time that the self-managed object storage server agent was created.

" + } + }, + "ServerProtocol": { + "target": "com.amazonaws.datasync#ObjectStorageServerProtocol", + "traits": { + "smithy.api#documentation": "

The protocol that the object storage server uses to communicate. \n Valid values are HTTP or HTTPS.

" } }, "LocationUri": { @@ -1302,7 +1314,7 @@ "AccessKey": { "target": "com.amazonaws.datasync#ObjectStorageAccessKey", "traits": { - "smithy.api#documentation": "

Optional. The access key is used if credentials are required to access \n the self-managed object storage server.

" + "smithy.api#documentation": "

Optional. The access key is used if credentials are required to access the self-managed\n object storage server. If your object storage requires a user name and password to\n authenticate, use AccessKey and SecretKey to provide the user name\n and password, respectively.

" } }, "ServerPort": { @@ -1311,16 +1323,10 @@ "smithy.api#documentation": "

The port that your self-managed object storage server accepts inbound network traffic on.\n The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).

" } }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "

The time that the self-managed object storage server agent was created.

" - } - }, - "ServerProtocol": { - "target": "com.amazonaws.datasync#ObjectStorageServerProtocol", + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The protocol that the object storage server uses to communicate. \n Valid values are HTTP or HTTPS.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.

" } } }, @@ -1366,8 +1372,23 @@ "com.amazonaws.datasync#DescribeLocationS3Response": { "type": "structure", "members": { - "S3Config": { - "target": "com.amazonaws.datasync#S3Config" + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

" + } + }, + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon S3 location that was described.

" + } + }, + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", + "traits": { + "smithy.api#documentation": "

If you are using DataSync on an Amazon Outpost, the Amazon Resource Name (ARNs) \n of the EC2 agents deployed on your AWS Outpost. For more information about launching \n a DataSync agent on an Amazon Outpost, see outposts-agent.

" + } }, "CreationTime": { "target": "com.amazonaws.datasync#Time", @@ -1381,17 +1402,8 @@ "smithy.api#documentation": "

The Amazon S3 storage class that you chose to store your files in when this location is\n used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the\n Amazon Simple Storage Service Developer Guide. Some storage classes\n have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

" } }, - "LocationArn": { - "target": "com.amazonaws.datasync#LocationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket location.

" - } - }, - "LocationUri": { - "target": "com.amazonaws.datasync#LocationUri", - "traits": { - "smithy.api#documentation": "

The URL of the Amazon S3 location that was described.

" - } + "S3Config": { + "target": "com.amazonaws.datasync#S3Config" } }, "traits": { @@ -1434,48 +1446,48 @@ } }, "com.amazonaws.datasync#DescribeLocationSmbResponse": { - "type": "structure", - "members": { - "LocationArn": { - "target": "com.amazonaws.datasync#LocationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SMB location that was described.

" - } - }, + "type": "structure", + "members": { "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source SMB file system location that is\n created.

" } }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "

The time that the SMB location was created.

" - } - }, "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { "smithy.api#documentation": "

The user who can mount the share, has the permissions to access files and folders in the\n SMB share.

" } }, + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", + "traits": { + "smithy.api#documentation": "

The URL of the source SBM location that was described.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.datasync#Time", + "traits": { + "smithy.api#documentation": "

The time that the SMB location was created.

" + } + }, "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { "smithy.api#documentation": "

The name of the Windows domain that the SMB server belongs to.

" } }, - "MountOptions": { - "target": "com.amazonaws.datasync#SmbMountOptions", + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The mount options that are available for DataSync to use to access an SMB location.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SMB location that was described.

" } }, - "LocationUri": { - "target": "com.amazonaws.datasync#LocationUri", + "MountOptions": { + "target": "com.amazonaws.datasync#SmbMountOptions", "traits": { - "smithy.api#documentation": "

The URL of the source SBM location that was described.

" + "smithy.api#documentation": "

The mount options that are available for DataSync to use to access an SMB location.

" } } }, @@ -1541,11 +1553,8 @@ "com.amazonaws.datasync#DescribeTaskExecutionResponse": { "type": "structure", "members": { - "Includes": { - "target": "com.amazonaws.datasync#FilterList", - "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n list should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" - } + "Options": { + "target": "com.amazonaws.datasync#Options" }, "Status": { "target": "com.amazonaws.datasync#TaskExecutionStatus", @@ -1553,19 +1562,28 @@ "smithy.api#documentation": "

The status of the task execution.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.\n

" } }, + "BytesTransferred": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#documentation": "

The physical number of bytes transferred over the network.

" + } + }, "FilesTransferred": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#documentation": "

The actual number of files that was transferred over the network. This value is\n calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated\n periodically when each file is read from the source and sent over the network.

\n

If failures occur during a transfer, this value can be less than\n EstimatedFilesToTransfer. This value can also be greater than\n EstimatedFilesTransferred in some cases. This element is\n implementation-specific for some location types, so don't use it as an indicator for a correct\n file number or to monitor your task execution.

" } }, - "Options": { - "target": "com.amazonaws.datasync#Options" + "Excludes": { + "target": "com.amazonaws.datasync#FilterList", + "traits": { + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" + } }, - "EstimatedFilesToTransfer": { - "target": "com.amazonaws.datasync#long", + "Includes": { + "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

The expected number of files that is to be transferred over the network. This value is\n calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the\n expected number of files to be transferred. It's calculated based on comparing the\n content of the source and destination locations and finding the delta that needs to be\n transferred.

" + "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n list should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" } }, "BytesWritten": { @@ -1574,16 +1592,16 @@ "smithy.api#documentation": "

The number of logical bytes written to the destination AWS storage resource.

" } }, - "BytesTransferred": { + "EstimatedFilesToTransfer": { "target": "com.amazonaws.datasync#long", "traits": { - "smithy.api#documentation": "

The physical number of bytes transferred over the network.

" + "smithy.api#documentation": "

The expected number of files that is to be transferred over the network. This value is\n calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the\n expected number of files to be transferred. It's calculated based on comparing the\n content of the source and destination locations and finding the delta that needs to be\n transferred.

" } }, - "StartTime": { - "target": "com.amazonaws.datasync#Time", + "Result": { + "target": "com.amazonaws.datasync#TaskExecutionResultDetail", "traits": { - "smithy.api#documentation": "

The time that the task execution was started.

" + "smithy.api#documentation": "

The result of the task execution.

" } }, "TaskExecutionArn": { @@ -1598,16 +1616,10 @@ "smithy.api#documentation": "

The estimated physical number of bytes that is to be transferred over the\n network.

" } }, - "Excludes": { - "target": "com.amazonaws.datasync#FilterList", - "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" - } - }, - "Result": { - "target": "com.amazonaws.datasync#TaskExecutionResultDetail", + "StartTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The result of the task execution.

" + "smithy.api#documentation": "

The time that the task execution was started.

" } } }, @@ -1633,46 +1645,34 @@ "com.amazonaws.datasync#DescribeTaskResponse": { "type": "structure", "members": { - "DestinationNetworkInterfaceArns": { - "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that\n was created for your subnet.

" - } - }, - "ErrorCode": { + "ErrorDetail": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "

Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" - } - }, - "SourceLocationArn": { - "target": "com.amazonaws.datasync#LocationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source file system's location.

" + "smithy.api#documentation": "

Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.

" } }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", + "DestinationNetworkInterfaceArns": { + "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "

The time that the task was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that\n was created for your subnet.

" } }, - "ErrorDetail": { - "target": "com.amazonaws.datasync#string", + "Name": { + "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "

Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.

" + "smithy.api#documentation": "

The name of the task that was described.

" } }, - "Status": { - "target": "com.amazonaws.datasync#TaskStatus", + "CurrentTaskExecutionArn": { + "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "

The status of the task that was described.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution that is syncing files.

" } }, - "Options": { - "target": "com.amazonaws.datasync#Options", + "Excludes": { + "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution. You can configure these\n options to preserve metadata such as user ID (UID) and group (GID), file permissions, data\n integrity verification, and so on.

\n

For each individual task execution, you can override these options by specifying the\n overriding OverrideOptions value to \n operation.

" + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" } }, "DestinationLocationArn": { @@ -1681,10 +1681,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS storage resource's location.

" } }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.datasync#LogGroupArn", + "TaskArn": { + "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.

\n\n \n

For more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task that was described.

" } }, "SourceNetworkInterfaceArns": { @@ -1693,34 +1693,46 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was\n created for your subnet.

" } }, + "Status": { + "target": "com.amazonaws.datasync#TaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the task that was described.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.\n

" + } + }, "Schedule": { "target": "com.amazonaws.datasync#TaskSchedule", "traits": { "smithy.api#documentation": "

The schedule used to periodically transfer files from a source to a destination location.

" } }, - "Name": { - "target": "com.amazonaws.datasync#TagValue", + "ErrorCode": { + "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "

The name of the task that was described.

" + "smithy.api#documentation": "

Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" } }, - "CurrentTaskExecutionArn": { - "target": "com.amazonaws.datasync#TaskExecutionArn", + "CreationTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution that is syncing files.

" + "smithy.api#documentation": "

The time that the task was created.

" } }, - "Excludes": { - "target": "com.amazonaws.datasync#FilterList", + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.

\n\n \n

For more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.

" } }, - "TaskArn": { - "target": "com.amazonaws.datasync#TaskArn", + "SourceLocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task that was described.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source file system's location.

" + } + }, + "Options": { + "target": "com.amazonaws.datasync#Options", + "traits": { + "smithy.api#documentation": "

The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution. You can configure these\n options to preserve metadata such as user ID (UID) and group (GID), file permissions, data\n integrity verification, and so on.

\n

For each individual task execution, you can override these options by specifying the\n overriding OverrideOptions value to \n operation.

" } } }, @@ -1846,6 +1858,16 @@ ] } }, + "com.amazonaws.datasync#FilterAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_\\ \\-\\:\\*\\.\\\\/\\?-]*$" + } + }, "com.amazonaws.datasync#FilterList": { "type": "list", "member": { @@ -1861,17 +1883,17 @@ "com.amazonaws.datasync#FilterRule": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.datasync#FilterValue", - "traits": { - "smithy.api#documentation": "

A single filter string that consists of the patterns to include or exclude. The patterns\n are delimited by \"|\" (that is, a pipe), for example: /folder1|/folder2\n

\n

\n

" - } - }, "FilterType": { "target": "com.amazonaws.datasync#FilterType", "traits": { "smithy.api#documentation": "

The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule\n type.

" } + }, + "Value": { + "target": "com.amazonaws.datasync#FilterValue", + "traits": { + "smithy.api#documentation": "

A single filter string that consists of the patterns to include or exclude. The patterns\n are delimited by \"|\" (that is, a pipe), for example: /folder1|/folder2\n

\n

\n

" + } } }, "traits": { @@ -1904,6 +1926,12 @@ "smithy.api#pattern": "^[^\\x00]+$" } }, + "com.amazonaws.datasync#FilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.datasync#FilterAttributeValue" + } + }, "com.amazonaws.datasync#FmrsService": { "type": "service", "version": "2018-11-09", @@ -2160,17 +2188,17 @@ "com.amazonaws.datasync#ListAgentsResponse": { "type": "structure", "members": { - "Agents": { - "target": "com.amazonaws.datasync#AgentList", - "traits": { - "smithy.api#documentation": "

A list of agents in your account.

" - } - }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of agents.

" } + }, + "Agents": { + "target": "com.amazonaws.datasync#AgentList", + "traits": { + "smithy.api#documentation": "

A list of agents in your account.

" + } } }, "traits": { @@ -2205,6 +2233,12 @@ "com.amazonaws.datasync#ListLocationsRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.datasync#LocationFilters", + "traits": { + "smithy.api#documentation": "

You can use API filters to narrow down the list of resources returned by ListLocations. \n For example, to retrieve all tasks on a specific source location, you can use ListLocations \n with filter name LocationType S3 and Operator Equals.

" + } + }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { @@ -2225,17 +2259,17 @@ "com.amazonaws.datasync#ListLocationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.datasync#NextToken", - "traits": { - "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of locations.

" - } - }, "Locations": { "target": "com.amazonaws.datasync#LocationList", "traits": { "smithy.api#documentation": "

An array that contains a list of locations.

" } + }, + "NextToken": { + "target": "com.amazonaws.datasync#NextToken", + "traits": { + "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of locations.

" + } } }, "traits": { @@ -2297,17 +2331,17 @@ "com.amazonaws.datasync#ListTagsForResourceResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.datasync#OutputTagList", - "traits": { - "smithy.api#documentation": "

Array of resource tags.

" - } - }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of resource tags.

" } + }, + "Tags": { + "target": "com.amazonaws.datasync#OutputTagList", + "traits": { + "smithy.api#documentation": "

Array of resource tags.

" + } } }, "traits": { @@ -2342,6 +2376,12 @@ "com.amazonaws.datasync#ListTaskExecutionsRequest": { "type": "structure", "members": { + "TaskArn": { + "target": "com.amazonaws.datasync#TaskArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task whose tasks you want to list.

" + } + }, "MaxResults": { "target": "com.amazonaws.datasync#MaxResults", "traits": { @@ -2353,12 +2393,6 @@ "traits": { "smithy.api#documentation": "

An opaque string that indicates the position at which to begin the next list of the\n executed tasks.

" } - }, - "TaskArn": { - "target": "com.amazonaws.datasync#TaskArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task whose tasks you want to list.

" - } } }, "traits": { @@ -2368,17 +2402,17 @@ "com.amazonaws.datasync#ListTaskExecutionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.datasync#NextToken", - "traits": { - "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of executed tasks.

" - } - }, "TaskExecutions": { "target": "com.amazonaws.datasync#TaskExecutionList", "traits": { "smithy.api#documentation": "

A list of executed tasks.

" } + }, + "NextToken": { + "target": "com.amazonaws.datasync#NextToken", + "traits": { + "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of executed tasks.

" + } } }, "traits": { @@ -2413,16 +2447,22 @@ "com.amazonaws.datasync#ListTasksRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.datasync#MaxResults", + "Filters": { + "target": "com.amazonaws.datasync#TaskFilters", "traits": { - "smithy.api#documentation": "

The maximum number of tasks to return.

" + "smithy.api#documentation": "

You can use API filters to narrow down the list of resources returned by ListTasks. \n For example, to retrieve all tasks on a specific source location, you can use ListTasks\n with filter name LocationId and Operator Equals with the ARN for the \n location.

" } }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { - "smithy.api#documentation": "

An opaque string that indicates the position at which to begin the next list of\n tasks.

" + "smithy.api#documentation": "

An opaque string that indicates the position at which to begin the next list of\n tasks.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.datasync#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of tasks to return.

" } } }, @@ -2460,6 +2500,60 @@ "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$" } }, + "com.amazonaws.datasync#LocationFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.datasync#Operator", + "traits": { + "smithy.api#documentation": "

The operator that is used to compare filter values (for example, Equals or \n Contains). For more about API filtering operators, see query-resources.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.datasync#FilterValues", + "traits": { + "smithy.api#documentation": "

The values that you want to filter for. For example, you might want to display only Amazon S3 \n locations.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.datasync#LocationFilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter being used. Each API call supports a list of filters that are available \n for it (for example, LocationType for ListLocations).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You can use API filters to narrow down the list of resources returned by ListLocations. \n For example, to retrieve all your Amazon S3 locations, you can use ListLocations with \n filter name LocationType S3 and Operator Equals.

" + } + }, + "com.amazonaws.datasync#LocationFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LocationUri", + "name": "LocationUri" + }, + { + "value": "LocationType", + "name": "LocationType" + }, + { + "value": "CreationTime", + "name": "CreationTime" + } + ] + } + }, + "com.amazonaws.datasync#LocationFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.datasync#LocationFilter" + } + }, "com.amazonaws.datasync#LocationList": { "type": "list", "member": { @@ -2679,7 +2773,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

ARNs)of the agents to use for an NFS location.

", + "smithy.api#documentation": "

ARNs of the agents to use for an NFS location.

", "smithy.api#required": {} } } @@ -2688,6 +2782,53 @@ "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)\n location.

" } }, + "com.amazonaws.datasync#Operator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Equals", + "name": "EQ" + }, + { + "value": "NotEquals", + "name": "NE" + }, + { + "value": "In", + "name": "IN" + }, + { + "value": "LessThanOrEqual", + "name": "LE" + }, + { + "value": "LessThan", + "name": "LT" + }, + { + "value": "GreaterThanOrEqual", + "name": "GE" + }, + { + "value": "GreaterThan", + "name": "GT" + }, + { + "value": "Contains", + "name": "CONTAINS" + }, + { + "value": "NotContains", + "name": "NOT_CONTAINS" + }, + { + "value": "BeginsWith", + "name": "BEGINS_WITH" + } + ] + } + }, "com.amazonaws.datasync#Options": { "type": "structure", "members": { @@ -2697,22 +2838,22 @@ "smithy.api#documentation": "

A value that determines whether a data integrity verification should be performed at\n the end of a task execution after all data and metadata have been transferred. \n For more information, see \n create-task\n

\n

Default value: POINT_IN_TIME_CONSISTENT.

\n

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.\n

\n \n

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination \n at the end of the transfer \n to verify that source and destination are fully \n synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier \n Deep Archive storage classes.

\n

NONE: No additional verification is done at the end of the \n transfer, but all data transmissions are integrity-checked with \n checksum verification during the transfer.

" } }, - "Gid": { - "target": "com.amazonaws.datasync#Gid", + "PreserveDevices": { + "target": "com.amazonaws.datasync#PreserveDevices", "traits": { - "smithy.api#documentation": "

The group ID (GID) of the file's owners.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

\n

NONE: Ignore UID and GID.

" + "smithy.api#documentation": "

A value that determines whether AWS DataSync should preserve the metadata of block\n and character devices in the source file system, and recreate the files with that device name\n and metadata on the destination.

\n \n

AWS DataSync can't sync the actual contents of such devices, because they are\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n

Default value: NONE.

\n

NONE: Ignore special devices (recommended).

\n

PRESERVE: Preserve character and block device metadata. This option isn't currently\n supported for Amazon EFS.

" } }, - "PreserveDeletedFiles": { - "target": "com.amazonaws.datasync#PreserveDeletedFiles", + "OverwriteMode": { + "target": "com.amazonaws.datasync#OverwriteMode", "traits": { - "smithy.api#documentation": "

A value that specifies whether files in the destination that don't exist in the source\n file system should be preserved. This option can affect your storage cost. \n If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed\n information, see using-storage-classes in the AWS DataSync User\n Guide.

\n

Default value: PRESERVE.

\n

PRESERVE: Ignore such destination files (recommended).

\n

REMOVE: Delete destination files that aren’t present in the source.

" + "smithy.api#documentation": "

A value that determines whether files at the destination should be overwritten or\n preserved when copying files. If set to NEVER a destination file will not be\n replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to\n protect against overwriting those changes.

\n

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync\n User Guide.

" } }, - "TaskQueueing": { - "target": "com.amazonaws.datasync#TaskQueueing", + "Atime": { + "target": "com.amazonaws.datasync#Atime", "traits": { - "smithy.api#documentation": "

A value that determines whether tasks should be queued before executing the tasks. If set\n to ENABLED, the tasks will be queued. The default is ENABLED.

\n

If you use the same agent to run multiple tasks, you can enable the tasks to run in\n series. For more information, see queue-task-execution.

" + "smithy.api#documentation": "

A file metadata value that shows the last time a file was accessed (that is, when the\n file was read or written to). If you set Atime to BEST_EFFORT, DataSync\n attempts to preserve the original Atime attribute on all source files (that is,\n the version before the PREPARING phase). However, Atime's behavior is not\n fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

\n

Default value: BEST_EFFORT.

\n

BEST_EFFORT: Attempt to preserve the per-file Atime value\n (recommended).

\n

NONE: Ignore Atime.

\n \n

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be NONE.

\n " } }, "PosixPermissions": { @@ -2721,28 +2862,16 @@ "smithy.api#documentation": "

A value that determines which users or groups can access a file for a specific purpose\n such as reading, writing, or execution of the file.

\n

Default value: PRESERVE.

\n

PRESERVE: Preserve POSIX-style permissions (recommended).

\n

NONE: Ignore permissions.

\n \n

AWS DataSync can preserve extant permissions of a source location.

\n " } }, - "TransferMode": { - "target": "com.amazonaws.datasync#TransferMode", - "traits": { - "smithy.api#documentation": "

TransferMode has two values: CHANGED and ALL. CHANGED performs an \"incremental\" \n or \"delta sync\", it compares file modification time between source and destination to \n determine which files need to be transferred. ALL skips destination inventory and \n transfers all files discovered on the source.

" - } - }, - "BytesPerSecond": { - "target": "com.amazonaws.datasync#BytesPerSecond", - "traits": { - "smithy.api#documentation": "

A value that limits the bandwidth used by AWS DataSync. For example, if you want\n AWS DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).

" - } - }, - "OverwriteMode": { - "target": "com.amazonaws.datasync#OverwriteMode", + "PreserveDeletedFiles": { + "target": "com.amazonaws.datasync#PreserveDeletedFiles", "traits": { - "smithy.api#documentation": "

A value that determines whether files at the destination should be overwritten or\n preserved when copying files. If set to NEVER a destination file will not be\n replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to\n protect against overwriting those changes.

\n

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync\n User Guide.

" + "smithy.api#documentation": "

A value that specifies whether files in the destination that don't exist in the source\n file system should be preserved. This option can affect your storage cost. \n If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed\n information, see using-storage-classes in the AWS DataSync User\n Guide.

\n

Default value: PRESERVE.

\n

PRESERVE: Ignore such destination files (recommended).

\n

REMOVE: Delete destination files that aren’t present in the source.

" } }, - "Atime": { - "target": "com.amazonaws.datasync#Atime", + "Gid": { + "target": "com.amazonaws.datasync#Gid", "traits": { - "smithy.api#documentation": "

A file metadata value that shows the last time a file was accessed (that is, when the\n file was read or written to). If you set Atime to BEST_EFFORT, DataSync\n attempts to preserve the original Atime attribute on all source files (that is,\n the version before the PREPARING phase). However, Atime's behavior is not\n fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

\n

Default value: BEST_EFFORT.

\n

BEST_EFFORT: Attempt to preserve the per-file Atime value\n (recommended).

\n

NONE: Ignore Atime.

\n \n

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be NONE.

\n " + "smithy.api#documentation": "

The group ID (GID) of the file's owners.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

\n

NONE: Ignore UID and GID.

" } }, "Uid": { @@ -2757,16 +2886,28 @@ "smithy.api#documentation": "

A value that determines the type of logs that DataSync publishes to a log stream in the\n Amazon CloudWatch log group that you provide. For more information about providing a log group\n for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published.\n BASIC publishes logs on errors for individual files transferred, and\n TRANSFER publishes logs for every file or object that is transferred and\n integrity checked.

" } }, + "BytesPerSecond": { + "target": "com.amazonaws.datasync#BytesPerSecond", + "traits": { + "smithy.api#documentation": "

A value that limits the bandwidth used by AWS DataSync. For example, if you want\n AWS DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).

" + } + }, "Mtime": { "target": "com.amazonaws.datasync#Mtime", "traits": { "smithy.api#documentation": "

A value that indicates the last time that a file was modified (that is, a file was\n written to) before the PREPARING phase.

\n

Default value: PRESERVE.

\n

PRESERVE: Preserve original Mtime (recommended)

\n

NONE: Ignore Mtime.

\n \n

If Mtime is set to PRESERVE, Atime must be set to\n BEST_EFFORT.

\n

If Mtime is set to NONE, Atime must also be set to NONE.\n

\n " } }, - "PreserveDevices": { - "target": "com.amazonaws.datasync#PreserveDevices", + "TransferMode": { + "target": "com.amazonaws.datasync#TransferMode", "traits": { - "smithy.api#documentation": "

A value that determines whether AWS DataSync should preserve the metadata of block\n and character devices in the source file system, and recreate the files with that device name\n and metadata on the destination.

\n \n

AWS DataSync can't sync the actual contents of such devices, because they are\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n

Default value: NONE.

\n

NONE: Ignore special devices (recommended).

\n

PRESERVE: Preserve character and block device metadata. This option isn't currently\n supported for Amazon EFS.

" + "smithy.api#documentation": "

A value that determines whether DataSync transfers only the data and metadata that differ between the source \n and the destination location, or whether DataSync transfers all the content from the source, without comparing to \n the destination location.

\n

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the \n destination location.

\n

ALL: DataSync copies all source location content to the destination, without comparing to existing content on \n the destination.

" + } + }, + "TaskQueueing": { + "target": "com.amazonaws.datasync#TaskQueueing", + "traits": { + "smithy.api#documentation": "

A value that determines whether tasks should be queued before executing the tasks. If set\n to ENABLED, the tasks will be queued. The default is ENABLED.

\n

If you use the same agent to run multiple tasks, you can enable the tasks to run in\n series. For more information, see queue-task-execution.

" } } }, @@ -2904,17 +3045,17 @@ "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated\n in a VPC or an agent that has access to a VPC endpoint.

" } }, - "PrivateLinkEndpoint": { - "target": "com.amazonaws.datasync#Endpoint", - "traits": { - "smithy.api#documentation": "

The private endpoint that is configured for an agent that has access to IP addresses in a\n PrivateLink. An agent that is configured with this endpoint will not be accessible\n over the public internet.

" - } - }, "SecurityGroupArns": { "target": "com.amazonaws.datasync#PLSecurityGroupArnList", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2\n resource that hosts an agent activated in a VPC or an agent that has access to a VPC\n endpoint.

" } + }, + "PrivateLinkEndpoint": { + "target": "com.amazonaws.datasync#Endpoint", + "traits": { + "smithy.api#documentation": "

The private endpoint that is configured for an agent that has access to IP addresses in a\n PrivateLink. An agent that is configured with this endpoint will not be accessible\n over the public internet.

" + } } }, "traits": { @@ -2926,9 +3067,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 76 + "max": 156 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:::([^/]*)$" + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$" } }, "com.amazonaws.datasync#S3Config": { @@ -2973,6 +3114,10 @@ { "value": "DEEP_ARCHIVE", "name": "DEEP_ARCHIVE" + }, + { + "value": "OUTPOSTS", + "name": "OUTPOSTS" } ] } @@ -3110,9 +3255,6 @@ "com.amazonaws.datasync#StartTaskExecutionRequest": { "type": "structure", "members": { - "OverrideOptions": { - "target": "com.amazonaws.datasync#Options" - }, "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { @@ -3125,6 +3267,9 @@ "traits": { "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe). For example: \"/folder1|/folder2\"\n

\n

\n

" } + }, + "OverrideOptions": { + "target": "com.amazonaws.datasync#Options" } }, "traits": { @@ -3303,28 +3448,22 @@ "com.amazonaws.datasync#TaskExecutionResultDetail": { "type": "structure", "members": { - "PrepareDuration": { - "target": "com.amazonaws.datasync#Duration", - "traits": { - "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the PREPARING phase.\n

" - } - }, "PrepareStatus": { "target": "com.amazonaws.datasync#PhaseStatus", "traits": { "smithy.api#documentation": "

The status of the PREPARING phase.

" } }, - "TotalDuration": { - "target": "com.amazonaws.datasync#Duration", + "VerifyStatus": { + "target": "com.amazonaws.datasync#PhaseStatus", "traits": { - "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination location.

" + "smithy.api#documentation": "

The status of the VERIFYING Phase.

" } }, - "ErrorCode": { - "target": "com.amazonaws.datasync#string", + "PrepareDuration": { + "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "

Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" + "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the PREPARING phase.\n

" } }, "VerifyDuration": { @@ -3333,28 +3472,34 @@ "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the VERIFYING\n phase.

" } }, + "ErrorCode": { + "target": "com.amazonaws.datasync#string", + "traits": { + "smithy.api#documentation": "

Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" + } + }, "ErrorDetail": { "target": "com.amazonaws.datasync#string", "traits": { "smithy.api#documentation": "

Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.

" } }, - "TransferDuration": { - "target": "com.amazonaws.datasync#Duration", + "TransferStatus": { + "target": "com.amazonaws.datasync#PhaseStatus", "traits": { - "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the TRANSFERRING\n phase.

" + "smithy.api#documentation": "

The status of the TRANSFERRING Phase.

" } }, - "VerifyStatus": { - "target": "com.amazonaws.datasync#PhaseStatus", + "TotalDuration": { + "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "

The status of the VERIFYING Phase.

" + "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination location.

" } }, - "TransferStatus": { - "target": "com.amazonaws.datasync#PhaseStatus", + "TransferDuration": { + "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "

The status of the TRANSFERRING Phase.

" + "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the TRANSFERRING\n phase.

" } } }, @@ -3397,6 +3542,56 @@ ] } }, + "com.amazonaws.datasync#TaskFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.datasync#Operator", + "traits": { + "smithy.api#documentation": "

The operator that is used to compare filter values (for example, Equals or \n Contains). For more about API filtering operators, see query-resources.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.datasync#FilterValues", + "traits": { + "smithy.api#documentation": "

The values that you want to filter for. For example, you might want to display only tasks \n for a specific destination location.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.datasync#TaskFilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter being used. Each API call supports a list of filters that are available\n for it. For example, LocationId for ListTasks.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You can use API filters to narrow down the list of resources returned by ListTasks.\n For example, to retrieve all tasks on a source location, you can use ListTasks\n with filter name LocationId and Operator Equals with the ARN for the \n location.

" + } + }, + "com.amazonaws.datasync#TaskFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LocationId", + "name": "LocationId" + }, + { + "value": "CreationTime", + "name": "CreationTime" + } + ] + } + }, + "com.amazonaws.datasync#TaskFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.datasync#TaskFilter" + } + }, "com.amazonaws.datasync#TaskList": { "type": "list", "member": { @@ -3406,10 +3601,10 @@ "com.amazonaws.datasync#TaskListEntry": { "type": "structure", "members": { - "TaskArn": { - "target": "com.amazonaws.datasync#TaskArn", + "Status": { + "target": "com.amazonaws.datasync#TaskStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task.

" + "smithy.api#documentation": "

The status of the task.

" } }, "Name": { @@ -3418,10 +3613,10 @@ "smithy.api#documentation": "

The name of the task.

" } }, - "Status": { - "target": "com.amazonaws.datasync#TaskStatus", + "TaskArn": { + "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "

The status of the task.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task.

" } } }, @@ -3648,17 +3843,14 @@ "smithy.api#required": {} } }, - "Schedule": { - "target": "com.amazonaws.datasync#TaskSchedule", + "Excludes": { + "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

Specifies a schedule used to periodically transfer files from a source to a destination\n location. You can configure your task to execute hourly, daily, weekly or on specific days of\n the week. You control when in the day or hour you want the task to execute. The time you\n specify is UTC time. For more information, see task-scheduling.

" + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" } }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.datasync#LogGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource name of the CloudWatch\n LogGroup.

" - } + "Options": { + "target": "com.amazonaws.datasync#Options" }, "Name": { "target": "com.amazonaws.datasync#TagValue", @@ -3666,13 +3858,16 @@ "smithy.api#documentation": "

The name of the task to update.

" } }, - "Options": { - "target": "com.amazonaws.datasync#Options" + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.datasync#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource name of the CloudWatch\n LogGroup.

" + } }, - "Excludes": { - "target": "com.amazonaws.datasync#FilterList", + "Schedule": { + "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" + "smithy.api#documentation": "

Specifies a schedule used to periodically transfer files from a source to a destination\n location. You can configure your task to execute hourly, daily, weekly or on specific days of\n the week. You control when in the day or hour you want the task to execute. The time you\n specify is UTC time. For more information, see task-scheduling.

" } } }, 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 1d4f37c32407..a0ecb4b5f3a6 100644 --- a/codegen/sdk-codegen/aws-models/dax.2017-04-19.json +++ b/codegen/sdk-codegen/aws-models/dax.2017-04-19.json @@ -102,7 +102,7 @@ "sdkId": "DAX", "arnNamespace": "dax", "cloudFormationName": "DAX", - "cloudTrailEventSource": "v20170419.admin.dax" + "cloudTrailEventSource": "dax.amazonaws.com" }, "aws.auth#sigv4": { "name": "dax" @@ -140,64 +140,52 @@ "com.amazonaws.dax#Cluster": { "type": "structure", "members": { - "PreferredMaintenanceWindow": { + "SubnetGroup": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A range of time when maintenance of DAX cluster software will be performed. For\n example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than\n 30 minutes, and is performed automatically within the maintenance window.

" + "smithy.api#documentation": "

The subnet group where the DAX cluster is running.

" } }, - "ParameterGroup": { - "target": "com.amazonaws.dax#ParameterGroupStatus", + "NodeType": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The parameter group being used by nodes in the cluster.

" + "smithy.api#documentation": "

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of\n the same type.)

" } }, - "SSEDescription": { - "target": "com.amazonaws.dax#SSEDescription", + "Nodes": { + "target": "com.amazonaws.dax#NodeList", "traits": { - "smithy.api#documentation": "

The description of the server-side encryption status on the specified DAX cluster.

" + "smithy.api#documentation": "

A list of nodes that are currently in the cluster.

" } }, - "ClusterDiscoveryEndpoint": { - "target": "com.amazonaws.dax#Endpoint", + "NotificationConfiguration": { + "target": "com.amazonaws.dax#NotificationConfiguration", "traits": { - "smithy.api#documentation": "

The configuration endpoint for this DAX cluster, consisting of a DNS name and a\n port number. Client applications can specify this endpoint, rather than an individual\n node endpoint, and allow the DAX client software to intelligently route requests and\n responses to nodes in the DAX cluster.

" + "smithy.api#documentation": "

Describes a notification topic and its status. Notification topics are used for\n publishing DAX events to subscribers using Amazon Simple Notification Service\n (SNS).

" } }, - "Description": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The description of the cluster.

" - } - }, - "ActiveNodes": { - "target": "com.amazonaws.dax#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of nodes in the cluster that are active (i.e., capable of serving\n requests).

" + "smithy.api#documentation": "

A range of time when maintenance of DAX cluster software will be performed. For\n example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than\n 30 minutes, and is performed automatically within the maintenance window.

" } }, - "Nodes": { - "target": "com.amazonaws.dax#NodeList", + "SecurityGroups": { + "target": "com.amazonaws.dax#SecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

A list of nodes that are currently in the cluster.

" + "smithy.api#documentation": "

A list of security groups, and the status of each, for the nodes in the cluster.

" } }, - "SubnetGroup": { + "Description": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The subnet group where the DAX cluster is running.

" - } - }, - "NotificationConfiguration": { - "target": "com.amazonaws.dax#NotificationConfiguration", - "traits": { - "smithy.api#documentation": "

Describes a notification topic and its status. Notification topics are used for\n publishing DAX events to subscribers using Amazon Simple Notification Service\n (SNS).

" + "smithy.api#documentation": "

The description of the cluster.

" } }, - "IamRoleArn": { + "ClusterArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX\n will assume this role and use the role's permissions to access DynamoDB on your\n behalf.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.\n

" } }, "NodeIdsToRemove": { @@ -206,28 +194,28 @@ "smithy.api#documentation": "

A list of nodes to be removed from the cluster.

" } }, - "Status": { - "target": "com.amazonaws.dax#String", + "ActiveNodes": { + "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The current status of the cluster.

" + "smithy.api#documentation": "

The number of nodes in the cluster that are active (i.e., capable of serving\n requests).

" } }, - "SecurityGroups": { - "target": "com.amazonaws.dax#SecurityGroupMembershipList", + "Status": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A list of security groups, and the status of each, for the nodes in the cluster.

" + "smithy.api#documentation": "

The current status of the cluster.

" } }, - "ClusterArn": { - "target": "com.amazonaws.dax#String", + "ParameterGroup": { + "target": "com.amazonaws.dax#ParameterGroupStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.\n

" + "smithy.api#documentation": "

The parameter group being used by nodes in the cluster.

" } }, - "NodeType": { + "ClusterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of\n the same type.)

" + "smithy.api#documentation": "

The name of the DAX cluster.

" } }, "TotalNodes": { @@ -236,10 +224,22 @@ "smithy.api#documentation": "

The total number of nodes in the cluster.

" } }, - "ClusterName": { + "IamRoleArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the DAX cluster.

" + "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX\n will assume this role and use the role's permissions to access DynamoDB on your\n behalf.

" + } + }, + "SSEDescription": { + "target": "com.amazonaws.dax#SSEDescription", + "traits": { + "smithy.api#documentation": "

The description of the server-side encryption status on the specified DAX cluster.

" + } + }, + "ClusterDiscoveryEndpoint": { + "target": "com.amazonaws.dax#Endpoint", + "traits": { + "smithy.api#documentation": "

The configuration endpoint for this DAX cluster, consisting of a DNS name and a\n port number. Client applications can specify this endpoint, rather than an individual\n node endpoint, and allow the DAX client software to intelligently route requests and\n responses to nodes in the DAX cluster.

" } } }, @@ -357,35 +357,24 @@ "com.amazonaws.dax#CreateClusterRequest": { "type": "structure", "members": { - "ReplicationFactor": { - "target": "com.amazonaws.dax#Integer", - "traits": { - "smithy.api#documentation": "

The number of nodes in the DAX cluster. A replication factor of 1 will\n create a single-node cluster, without any read replicas. For additional fault tolerance,\n you can create a multiple node cluster with one or more read replicas. To do this, set\n ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). \n If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

\n \n

AWS recommends that you have at least two read replicas per cluster.

\n ", - "smithy.api#required": {} - } - }, - "ParameterGroupName": { - "target": "com.amazonaws.dax#String", + "Tags": { + "target": "com.amazonaws.dax#TagList", "traits": { - "smithy.api#documentation": "

The parameter group to be associated with the DAX cluster.

" + "smithy.api#documentation": "

A set of tags to associate with the DAX cluster.

" } }, - "Description": { + "NodeType": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A description of the cluster.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.dax#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster\n has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter.\n If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

" + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the cluster.

", + "smithy.api#required": {} } }, - "SubnetGroupName": { + "ClusterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the subnet group to be used for the replication group.

\n \n

DAX clusters can only run in an Amazon VPC environment. All of the subnets\n that you specify in a subnet group must exist in the same VPC.

\n " + "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase\n string.

\n

\n Constraints:\n

\n ", + "smithy.api#required": {} } }, "SSESpecification": { @@ -394,31 +383,30 @@ "smithy.api#documentation": "

Represents the settings used to enable server-side encryption on the cluster.

" } }, - "Tags": { - "target": "com.amazonaws.dax#TagList", + "ReplicationFactor": { + "target": "com.amazonaws.dax#Integer", "traits": { - "smithy.api#documentation": "

A set of tags to associate with the DAX cluster.

" + "smithy.api#documentation": "

The number of nodes in the DAX cluster. A replication factor of 1 will\n create a single-node cluster, without any read replicas. For additional fault tolerance,\n you can create a multiple node cluster with one or more read replicas. To do this, set\n ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). \n If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

\n \n

AWS recommends that you have at least two read replicas per cluster.

\n ", + "smithy.api#required": {} } }, - "ClusterName": { + "IamRoleArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase\n string.

\n

\n Constraints:\n

\n ", + "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX\n will assume this role and use the role's permissions to access DynamoDB on your\n behalf.

", "smithy.api#required": {} } }, - "IamRoleArn": { + "Description": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX\n will assume this role and use the role's permissions to access DynamoDB on your\n behalf.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the cluster.

" } }, - "NodeType": { + "SubnetGroupName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the cluster.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the subnet group to be used for the replication group.

\n \n

DAX clusters can only run in an Amazon VPC environment. All of the subnets\n that you specify in a subnet group must exist in the same VPC.

\n " } }, "NotificationTopicArn": { @@ -427,6 +415,18 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will\n be sent.

\n \n

The Amazon SNS topic owner must be same as the DAX cluster owner.

\n " } }, + "AvailabilityZones": { + "target": "com.amazonaws.dax#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster\n has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter.\n If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

The parameter group to be associated with the DAX cluster.

" + } + }, "SecurityGroupIds": { "target": "com.amazonaws.dax#SecurityGroupIdentifierList", "traits": { @@ -487,17 +487,17 @@ "com.amazonaws.dax#CreateParameterGroupRequest": { "type": "structure", "members": { - "ParameterGroupName": { + "Description": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the parameter group to apply to all of the clusters in this replication\n group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the parameter group.

" } }, - "Description": { + "ParameterGroupName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A description of the parameter group.

" + "smithy.api#documentation": "

The name of the parameter group to apply to all of the clusters in this replication\n group.

", + "smithy.api#required": {} } } } @@ -545,13 +545,6 @@ "com.amazonaws.dax#CreateSubnetGroupRequest": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.dax#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

A list of VPC subnet IDs for the subnet group.

", - "smithy.api#required": {} - } - }, "Description": { "target": "com.amazonaws.dax#String", "traits": { @@ -564,6 +557,13 @@ "smithy.api#documentation": "

A name for the subnet group. This value is stored as a lowercase string.

", "smithy.api#required": {} } + }, + "SubnetIds": { + "target": "com.amazonaws.dax#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs for the subnet group.

", + "smithy.api#required": {} + } } } }, @@ -613,6 +613,12 @@ "com.amazonaws.dax#DecreaseReplicationFactorRequest": { "type": "structure", "members": { + "NodeIdsToRemove": { + "target": "com.amazonaws.dax#NodeIdentifierList", + "traits": { + "smithy.api#documentation": "

The unique identifiers of the nodes to be removed from the cluster.

" + } + }, "NewReplicationFactor": { "target": "com.amazonaws.dax#Integer", "traits": { @@ -620,10 +626,10 @@ "smithy.api#required": {} } }, - "NodeIdsToRemove": { - "target": "com.amazonaws.dax#NodeIdentifierList", + "AvailabilityZones": { + "target": "com.amazonaws.dax#AvailabilityZoneList", "traits": { - "smithy.api#documentation": "

The unique identifiers of the nodes to be removed from the cluster.

" + "smithy.api#documentation": "

The Availability Zone(s) from which to remove nodes.

" } }, "ClusterName": { @@ -632,12 +638,6 @@ "smithy.api#documentation": "

The name of the DAX cluster from which you want to remove nodes.

", "smithy.api#required": {} } - }, - "AvailabilityZones": { - "target": "com.amazonaws.dax#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The Availability Zone(s) from which to remove nodes.

" - } } } }, @@ -854,17 +854,17 @@ "com.amazonaws.dax#DescribeClustersResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" - } - }, "Clusters": { "target": "com.amazonaws.dax#ClusterList", "traits": { "smithy.api#documentation": "

The descriptions of your DAX clusters, in response to a\n DescribeClusters request.

" } + }, + "NextToken": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } } } }, @@ -951,46 +951,46 @@ "com.amazonaws.dax#DescribeEventsRequest": { "type": "structure", "members": { - "SourceType": { - "target": "com.amazonaws.dax#SourceType", + "StartTime": { + "target": "com.amazonaws.dax#TStamp", "traits": { - "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are\n returned.

" + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601\n format.

" } }, - "NextToken": { + "SourceName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" + "smithy.api#documentation": "

The identifier of the event source for which events will be returned. If not\n specified, then all sources are included in the response.

" } }, - "Duration": { + "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of minutes' worth of events to retrieve.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, - "EndTime": { - "target": "com.amazonaws.dax#TStamp", + "SourceType": { + "target": "com.amazonaws.dax#SourceType", "traits": { - "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601\n format.

" + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are\n returned.

" } }, - "MaxResults": { - "target": "com.amazonaws.dax#IntegerOptional", + "NextToken": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.dax#TStamp", "traits": { - "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601\n format.

" + "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601\n format.

" } }, - "SourceName": { - "target": "com.amazonaws.dax#String", + "Duration": { + "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The identifier of the event source for which events will be returned. If not\n specified, then all sources are included in the response.

" + "smithy.api#documentation": "

The number of minutes' worth of events to retrieve.

" } } } @@ -1041,12 +1041,6 @@ "com.amazonaws.dax#DescribeParameterGroupsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" - } - }, "ParameterGroupNames": { "target": "com.amazonaws.dax#ParameterGroupNameList", "traits": { @@ -1058,6 +1052,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } + }, + "NextToken": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" + } } } }, @@ -1107,29 +1107,29 @@ "com.amazonaws.dax#DescribeParametersRequest": { "type": "structure", "members": { - "Source": { + "ParameterGroupName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

How the parameter is defined. For example, system denotes a\n system-defined parameter.

" + "smithy.api#documentation": "

The name of the parameter group.

", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.dax#String", + "MaxResults": { + "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, - "ParameterGroupName": { + "NextToken": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the parameter group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" } }, - "MaxResults": { - "target": "com.amazonaws.dax#IntegerOptional", + "Source": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

How the parameter is defined. For example, system denotes a\n system-defined parameter.

" } } } @@ -1137,17 +1137,17 @@ "com.amazonaws.dax#DescribeParametersResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" - } - }, "Parameters": { "target": "com.amazonaws.dax#ParameterList", "traits": { "smithy.api#documentation": "

A list of parameters within a parameter group. Each element in the list represents one parameter.

" } + }, + "NextToken": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } } } }, @@ -1174,18 +1174,18 @@ "com.amazonaws.dax#DescribeSubnetGroupsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" - } - }, "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, + "NextToken": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of\n results from this action. If this parameter is specified, the response includes only\n results beyond the token, up to the value specified by\n MaxResults.

" + } + }, "SubnetGroupNames": { "target": "com.amazonaws.dax#SubnetGroupNameList", "traits": { @@ -1197,16 +1197,16 @@ "com.amazonaws.dax#DescribeSubnetGroupsResponse": { "type": "structure", "members": { - "SubnetGroups": { - "target": "com.amazonaws.dax#SubnetGroupList", + "NextToken": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

An array of subnet groups. Each element in the array represents a single subnet group.

" + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" } }, - "NextToken": { - "target": "com.amazonaws.dax#String", + "SubnetGroups": { + "target": "com.amazonaws.dax#SubnetGroupList", "traits": { - "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + "smithy.api#documentation": "

An array of subnet groups. Each element in the array represents a single subnet group.

" } } } @@ -1214,17 +1214,17 @@ "com.amazonaws.dax#Endpoint": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.dax#Integer", - "traits": { - "smithy.api#documentation": "

The port number that applications should use to connect to the endpoint.

" - } - }, "Address": { "target": "com.amazonaws.dax#String", "traits": { "smithy.api#documentation": "

The DNS hostname of the endpoint.

" } + }, + "Port": { + "target": "com.amazonaws.dax#Integer", + "traits": { + "smithy.api#documentation": "

The port number that applications should use to connect to the endpoint.

" + } } }, "traits": { @@ -1234,10 +1234,10 @@ "com.amazonaws.dax#Event": { "type": "structure", "members": { - "Message": { + "SourceName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A user-defined message associated with the event.

" + "smithy.api#documentation": "

The source of the event. For example, if the event occurred at the node level, the\n source would be the node ID.

" } }, "SourceType": { @@ -1246,16 +1246,16 @@ "smithy.api#documentation": "

Specifies the origin of this event - a cluster, a parameter group, a node ID,\n etc.

" } }, - "Date": { - "target": "com.amazonaws.dax#TStamp", + "Message": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The date and time when the event occurred.

" + "smithy.api#documentation": "

A user-defined message associated with the event.

" } }, - "SourceName": { - "target": "com.amazonaws.dax#String", + "Date": { + "target": "com.amazonaws.dax#TStamp", "traits": { - "smithy.api#documentation": "

The source of the event. For example, if the event occurred at the node level, the\n source would be the node ID.

" + "smithy.api#documentation": "

The date and time when the event occurred.

" } } }, @@ -1316,17 +1316,17 @@ "com.amazonaws.dax#IncreaseReplicationFactorRequest": { "type": "structure", "members": { - "NewReplicationFactor": { - "target": "com.amazonaws.dax#Integer", + "ClusterName": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The new number of nodes for the DAX cluster.

", + "smithy.api#documentation": "

The name of the DAX cluster that will receive additional nodes.

", "smithy.api#required": {} } }, - "ClusterName": { - "target": "com.amazonaws.dax#String", + "NewReplicationFactor": { + "target": "com.amazonaws.dax#Integer", "traits": { - "smithy.api#documentation": "

The name of the DAX cluster that will receive additional nodes.

", + "smithy.api#documentation": "

The new number of nodes for the DAX cluster.

", "smithy.api#required": {} } }, @@ -1537,23 +1537,29 @@ "com.amazonaws.dax#ListTagsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

If this value is present, there are additional results to be displayed. To retrieve them, call \n ListTags again, with NextToken set to this value.

" - } - }, "Tags": { "target": "com.amazonaws.dax#TagList", "traits": { "smithy.api#documentation": "

A list of tags currently associated with the DAX cluster.

" } + }, + "NextToken": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

If this value is present, there are additional results to be displayed. To retrieve them, call \n ListTags again, with NextToken set to this value.

" + } } } }, "com.amazonaws.dax#Node": { "type": "structure", "members": { + "Endpoint": { + "target": "com.amazonaws.dax#Endpoint", + "traits": { + "smithy.api#documentation": "

The endpoint for the node, consisting of a DNS name and a port number. Client\n applications can connect directly to a node endpoint, if desired (as an alternative to\n allowing DAX client software to intelligently route requests and responses to nodes in\n the DAX cluster.

" + } + }, "NodeId": { "target": "com.amazonaws.dax#String", "traits": { @@ -1566,29 +1572,23 @@ "smithy.api#documentation": "

The Availability Zone (AZ) in which the node has been deployed.

" } }, - "NodeCreateTime": { - "target": "com.amazonaws.dax#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time (in UNIX epoch format) when the node was launched.

" - } - }, "NodeStatus": { "target": "com.amazonaws.dax#String", "traits": { "smithy.api#documentation": "

The current status of the node. For example: available.

" } }, - "Endpoint": { - "target": "com.amazonaws.dax#Endpoint", - "traits": { - "smithy.api#documentation": "

The endpoint for the node, consisting of a DNS name and a port number. Client\n applications can connect directly to a node endpoint, if desired (as an alternative to\n allowing DAX client software to intelligently route requests and responses to nodes in\n the DAX cluster.

" - } - }, "ParameterGroupStatus": { "target": "com.amazonaws.dax#String", "traits": { "smithy.api#documentation": "

The status of the parameter group associated with this node. For example,\n in-sync.

" } + }, + "NodeCreateTime": { + "target": "com.amazonaws.dax#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time (in UNIX epoch format) when the node was launched.

" + } } }, "traits": { @@ -1649,16 +1649,16 @@ "com.amazonaws.dax#NodeTypeSpecificValue": { "type": "structure", "members": { - "NodeType": { + "Value": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A node type to which the parameter value applies.

" + "smithy.api#documentation": "

The parameter value for this node type.

" } }, - "Value": { + "NodeType": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The parameter value for this node type.

" + "smithy.api#documentation": "

A node type to which the parameter value applies.

" } } }, @@ -1695,22 +1695,22 @@ "com.amazonaws.dax#Parameter": { "type": "structure", "members": { - "DataType": { - "target": "com.amazonaws.dax#String", + "IsModifiable": { + "target": "com.amazonaws.dax#IsModifiable", "traits": { - "smithy.api#documentation": "

The data type of the parameter. For example, integer:

" + "smithy.api#documentation": "

Whether the customer is allowed to modify the parameter.

" } }, - "Source": { - "target": "com.amazonaws.dax#String", + "NodeTypeSpecificValues": { + "target": "com.amazonaws.dax#NodeTypeSpecificValueList", "traits": { - "smithy.api#documentation": "

How the parameter is defined. For example, system denotes a\n system-defined parameter.

" + "smithy.api#documentation": "

A list of node types, and specific parameter values for each node.

" } }, - "ChangeType": { - "target": "com.amazonaws.dax#ChangeType", + "AllowedValues": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The conditions under which changes to this parameter can be applied. For example,\n requires-reboot indicates that a new value for this parameter will only\n take effect if a node is rebooted.

" + "smithy.api#documentation": "

A range of values within which the parameter can be set.

" } }, "Description": { @@ -1719,10 +1719,16 @@ "smithy.api#documentation": "

A description of the parameter

" } }, - "NodeTypeSpecificValues": { - "target": "com.amazonaws.dax#NodeTypeSpecificValueList", + "ChangeType": { + "target": "com.amazonaws.dax#ChangeType", "traits": { - "smithy.api#documentation": "

A list of node types, and specific parameter values for each node.

" + "smithy.api#documentation": "

The conditions under which changes to this parameter can be applied. For example,\n requires-reboot indicates that a new value for this parameter will only\n take effect if a node is rebooted.

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

The value for the parameter.

" } }, "ParameterType": { @@ -1731,16 +1737,16 @@ "smithy.api#documentation": "

Determines whether the parameter can be applied to any nodes, or only nodes of a\n particular type.

" } }, - "IsModifiable": { - "target": "com.amazonaws.dax#IsModifiable", + "DataType": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

Whether the customer is allowed to modify the parameter.

" + "smithy.api#documentation": "

The data type of the parameter. For example, integer:

" } }, - "ParameterValue": { + "Source": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The value for the parameter.

" + "smithy.api#documentation": "

How the parameter is defined. For example, system denotes a\n system-defined parameter.

" } }, "ParameterName": { @@ -1748,12 +1754,6 @@ "traits": { "smithy.api#documentation": "

The name of the parameter.

" } - }, - "AllowedValues": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

A range of values within which the parameter can be set.

" - } } }, "traits": { @@ -1834,18 +1834,18 @@ "com.amazonaws.dax#ParameterGroupStatus": { "type": "structure", "members": { - "ParameterGroupName": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

The name of the parameter group.

" - } - }, "NodeIdsToReboot": { "target": "com.amazonaws.dax#NodeIdentifierList", "traits": { "smithy.api#documentation": "

The node IDs of one or more nodes to be rebooted.

" } }, + "ParameterGroupName": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group.

" + } + }, "ParameterApplyStatus": { "target": "com.amazonaws.dax#String", "traits": { @@ -1866,16 +1866,16 @@ "com.amazonaws.dax#ParameterNameValue": { "type": "structure", "members": { - "ParameterValue": { + "ParameterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The value of the parameter.

" + "smithy.api#documentation": "

The name of the parameter.

" } }, - "ParameterName": { + "ParameterValue": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the parameter.

" + "smithy.api#documentation": "

The value of the parameter.

" } } }, @@ -1937,17 +1937,17 @@ "com.amazonaws.dax#RebootNodeRequest": { "type": "structure", "members": { - "NodeId": { + "ClusterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The system-assigned ID of the node to be rebooted.

", + "smithy.api#documentation": "

The name of the DAX cluster containing the node to be rebooted.

", "smithy.api#required": {} } }, - "ClusterName": { + "NodeId": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the DAX cluster containing the node to be rebooted.

", + "smithy.api#documentation": "

The system-assigned ID of the node to be rebooted.

", "smithy.api#required": {} } } @@ -2027,16 +2027,16 @@ "com.amazonaws.dax#SecurityGroupMembership": { "type": "structure", "members": { - "Status": { + "SecurityGroupIdentifier": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The status of this security group.

" + "smithy.api#documentation": "

The unique ID for this security group.

" } }, - "SecurityGroupIdentifier": { + "Status": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The unique ID for this security group.

" + "smithy.api#documentation": "

The status of this security group.

" } } }, @@ -2085,16 +2085,16 @@ "com.amazonaws.dax#Subnet": { "type": "structure", "members": { - "SubnetIdentifier": { + "SubnetAvailabilityZone": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The system-assigned identifier for the subnet.

" + "smithy.api#documentation": "

The Availability Zone (AZ) for the subnet.

" } }, - "SubnetAvailabilityZone": { + "SubnetIdentifier": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) for the subnet.

" + "smithy.api#documentation": "

The system-assigned identifier for the subnet.

" } } }, @@ -2111,12 +2111,6 @@ "smithy.api#documentation": "

A list of subnets associated with the subnet group.

" } }, - "VpcId": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

" - } - }, "Description": { "target": "com.amazonaws.dax#String", "traits": { @@ -2128,6 +2122,12 @@ "traits": { "smithy.api#documentation": "

The name of the subnet group.

" } + }, + "VpcId": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

" + } } }, "traits": { @@ -2242,16 +2242,16 @@ "com.amazonaws.dax#Tag": { "type": "structure", "members": { - "Key": { + "Value": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have\n one tag with the same key. If you try to add an existing tag (same key), the\n existing tag value will be updated to the new value.

" + "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be null.

" } }, - "Value": { + "Key": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be null.

" + "smithy.api#documentation": "

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have\n one tag with the same key. If you try to add an existing tag (same key), the\n existing tag value will be updated to the new value.

" } } }, @@ -2394,17 +2394,17 @@ "com.amazonaws.dax#UntagResourceRequest": { "type": "structure", "members": { - "ResourceName": { - "target": "com.amazonaws.dax#String", + "TagKeys": { + "target": "com.amazonaws.dax#KeyList", "traits": { - "smithy.api#documentation": "

The name of the DAX resource from which the tags should be removed.

", + "smithy.api#documentation": "

A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.dax#KeyList", + "ResourceName": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

", + "smithy.api#documentation": "

The name of the DAX resource from which the tags should be removed.

", "smithy.api#required": {} } } @@ -2459,47 +2459,47 @@ "com.amazonaws.dax#UpdateClusterRequest": { "type": "structure", "members": { - "ParameterGroupName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of a parameter group for this cluster.

" + "smithy.api#documentation": "

A range of time when maintenance of DAX cluster software will be performed. For\n example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than\n 30 minutes, and is performed automatically within the maintenance window.

" } }, - "Description": { + "ClusterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A description of the changes being made to the cluster.

" + "smithy.api#documentation": "

The name of the DAX cluster to be modified.

", + "smithy.api#required": {} } }, - "SecurityGroupIds": { - "target": "com.amazonaws.dax#SecurityGroupIdentifierList", + "ParameterGroupName": { + "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not \n specified, DAX assigns the default VPC security group to each node.

" + "smithy.api#documentation": "

The name of a parameter group for this cluster.

" } }, - "NotificationTopicArn": { + "NotificationTopicStatus": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the topic.

" + "smithy.api#documentation": "

The current state of the topic.

" } }, - "PreferredMaintenanceWindow": { + "Description": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A range of time when maintenance of DAX cluster software will be performed. For\n example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than\n 30 minutes, and is performed automatically within the maintenance window.

" + "smithy.api#documentation": "

A description of the changes being made to the cluster.

" } }, - "NotificationTopicStatus": { - "target": "com.amazonaws.dax#String", + "SecurityGroupIds": { + "target": "com.amazonaws.dax#SecurityGroupIdentifierList", "traits": { - "smithy.api#documentation": "

The current state of the topic.

" + "smithy.api#documentation": "

A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not \n specified, DAX assigns the default VPC security group to each node.

" } }, - "ClusterName": { + "NotificationTopicArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the DAX cluster to be modified.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the topic.

" } } } @@ -2606,12 +2606,6 @@ "com.amazonaws.dax#UpdateSubnetGroupRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.dax#String", - "traits": { - "smithy.api#documentation": "

A description of the subnet group.

" - } - }, "SubnetIds": { "target": "com.amazonaws.dax#SubnetIdentifierList", "traits": { @@ -2624,6 +2618,12 @@ "smithy.api#documentation": "

The name of the subnet group.

", "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.dax#String", + "traits": { + "smithy.api#documentation": "

A description of the subnet group.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/detective.2018-10-26.json b/codegen/sdk-codegen/aws-models/detective.2018-10-26.json index 528ce163576a..ab989207c534 100644 --- a/codegen/sdk-codegen/aws-models/detective.2018-10-26.json +++ b/codegen/sdk-codegen/aws-models/detective.2018-10-26.json @@ -72,17 +72,17 @@ "com.amazonaws.detective#Account": { "type": "structure", "members": { - "EmailAddress": { - "target": "com.amazonaws.detective#EmailAddress", + "AccountId": { + "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account root user email address for the AWS account.

", + "smithy.api#documentation": "

The account identifier of the AWS account.

", "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.detective#AccountId", + "EmailAddress": { + "target": "com.amazonaws.detective#EmailAddress", "traits": { - "smithy.api#documentation": "

The account identifier of the AWS account.

", + "smithy.api#documentation": "

The AWS account root user email address for the AWS account.

", "smithy.api#required": {} } } @@ -264,10 +264,11 @@ "com.amazonaws.detective#CreateMembersRequest": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.detective#EmailMessage", + "Accounts": { + "target": "com.amazonaws.detective#AccountList", "traits": { - "smithy.api#documentation": "

Customized message text to include in the invitation email message to the invited member\n accounts.

" + "smithy.api#documentation": "

The list of AWS accounts to invite to become member accounts in the behavior graph.\n For each invited account, the account list contains the account identifier and the AWS\n account root user email address.

", + "smithy.api#required": {} } }, "GraphArn": { @@ -277,11 +278,10 @@ "smithy.api#required": {} } }, - "Accounts": { - "target": "com.amazonaws.detective#AccountList", + "Message": { + "target": "com.amazonaws.detective#EmailMessage", "traits": { - "smithy.api#documentation": "

The list of AWS accounts to invite to become member accounts in the behavior graph.\n For each invited account, the account list contains the account identifier and the AWS\n account root user email address.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Customized message text to include in the invitation email message to the invited member\n accounts.

" } } } @@ -374,17 +374,17 @@ "com.amazonaws.detective#DeleteMembersRequest": { "type": "structure", "members": { - "GraphArn": { - "target": "com.amazonaws.detective#GraphArn", + "AccountIds": { + "target": "com.amazonaws.detective#AccountIdList", "traits": { - "smithy.api#documentation": "

The ARN of the behavior graph to delete members from.

", + "smithy.api#documentation": "

The list of AWS account identifiers for the member accounts to delete from the\n behavior graph.

", "smithy.api#required": {} } }, - "AccountIds": { - "target": "com.amazonaws.detective#AccountIdList", + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "

The list of AWS account identifiers for the member accounts to delete from the\n behavior graph.

", + "smithy.api#documentation": "

The ARN of the behavior graph to delete members from.

", "smithy.api#required": {} } } @@ -611,17 +611,17 @@ "com.amazonaws.detective#ListGraphsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.detective#MemberResultsLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of graphs to return at a time. The total must be less than the\n overall limit on the number of results to return, which is currently 200.

" - } - }, "NextToken": { "target": "com.amazonaws.detective#PaginationToken", "traits": { "smithy.api#documentation": "

For requests to get the next page of results, the pagination token that was returned\n with the previous set of results. The initial request does not include a pagination\n token.

" } + }, + "MaxResults": { + "target": "com.amazonaws.detective#MemberResultsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of graphs to return at a time. The total must be less than the\n overall limit on the number of results to return, which is currently 200.

" + } } } }, @@ -675,34 +675,34 @@ "com.amazonaws.detective#ListInvitationsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.detective#PaginationToken", - "traits": { - "smithy.api#documentation": "

For requests to retrieve the next page of results, the pagination token that was\n returned with the previous page of results. The initial request does not include a\n pagination token.

" - } - }, "MaxResults": { "target": "com.amazonaws.detective#MemberResultsLimit", "traits": { "smithy.api#documentation": "

The maximum number of behavior graph invitations to return in the response. The total\n must be less than the overall limit on the number of results to return, which is currently\n 200.

" } + }, + "NextToken": { + "target": "com.amazonaws.detective#PaginationToken", + "traits": { + "smithy.api#documentation": "

For requests to retrieve the next page of results, the pagination token that was\n returned with the previous page of results. The initial request does not include a\n pagination token.

" + } } } }, "com.amazonaws.detective#ListInvitationsResponse": { "type": "structure", "members": { - "Invitations": { - "target": "com.amazonaws.detective#MemberDetailList", - "traits": { - "smithy.api#documentation": "

The list of behavior graphs for which the member account has open or accepted\n invitations.

" - } - }, "NextToken": { "target": "com.amazonaws.detective#PaginationToken", "traits": { "smithy.api#documentation": "

If there are more behavior graphs remaining in the results, then this is the pagination\n token to use to request the next page of behavior graphs.

" } + }, + "Invitations": { + "target": "com.amazonaws.detective#MemberDetailList", + "traits": { + "smithy.api#documentation": "

The list of behavior graphs for which the member account has open or accepted\n invitations.

" + } } } }, @@ -742,10 +742,10 @@ "com.amazonaws.detective#ListMembersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.detective#PaginationToken", + "MaxResults": { + "target": "com.amazonaws.detective#MemberResultsLimit", "traits": { - "smithy.api#documentation": "

For requests to retrieve the next page of member account results, the pagination token\n that was returned with the previous page of results. The initial request does not include a\n pagination token.

" + "smithy.api#documentation": "

The maximum number of member accounts to include in the response. The total must be less\n than the overall limit on the number of results to return, which is currently 200.

" } }, "GraphArn": { @@ -755,10 +755,10 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.detective#MemberResultsLimit", + "NextToken": { + "target": "com.amazonaws.detective#PaginationToken", "traits": { - "smithy.api#documentation": "

The maximum number of member accounts to include in the response. The total must be less\n than the overall limit on the number of results to return, which is currently 200.

" + "smithy.api#documentation": "

For requests to retrieve the next page of member account results, the pagination token\n that was returned with the previous page of results. The initial request does not include a\n pagination token.

" } } } @@ -783,64 +783,64 @@ "com.amazonaws.detective#MemberDetail": { "type": "structure", "members": { - "UpdatedTime": { - "target": "com.amazonaws.detective#Timestamp", + "Status": { + "target": "com.amazonaws.detective#MemberStatus", "traits": { - "smithy.api#documentation": "

The date and time that the member account was last updated. The value is in milliseconds\n since the epoch.

" + "smithy.api#documentation": "

The current membership status of the member account. The status can have one of the\n following values:

\n \n

Member accounts that declined an invitation or that were removed from the behavior graph\n are not included.

" } }, - "GraphArn": { - "target": "com.amazonaws.detective#GraphArn", + "AccountId": { + "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "

The ARN of the behavior graph that the member account was invited to.

" + "smithy.api#documentation": "

The AWS account identifier for the member account.

" } }, - "InvitedTime": { + "PercentOfGraphUtilizationUpdatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that Detective sent the invitation to the member account. The value is in\n milliseconds since the epoch.

" + "smithy.api#documentation": "

The date and time when the graph utilization percentage was last updated.

" } }, - "DisabledReason": { - "target": "com.amazonaws.detective#MemberDisabledReason", + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that\n the member account is not enabled.

\n

The reason can have one of the following values:

\n " + "smithy.api#documentation": "

The ARN of the behavior graph that the member account was invited to.

" } }, - "EmailAddress": { - "target": "com.amazonaws.detective#EmailAddress", + "DisabledReason": { + "target": "com.amazonaws.detective#MemberDisabledReason", "traits": { - "smithy.api#documentation": "

The AWS account root user email address for the member account.

" + "smithy.api#documentation": "

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that\n the member account is not enabled.

\n

The reason can have one of the following values:

\n " } }, - "AccountId": { + "MasterId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account identifier for the member account.

" + "smithy.api#documentation": "

The AWS account identifier of the master account for the behavior graph.

" } }, - "PercentOfGraphUtilization": { - "target": "com.amazonaws.detective#Percentage", + "InvitedTime": { + "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "

The member account data volume as a percentage of the maximum allowed data volume. 0\n indicates 0 percent, and 100 indicates 100 percent.

\n

Note that this is not the percentage of the behavior graph data volume.

\n

For example, the data volume for the behavior graph is 80 GB per day. The maximum data\n volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then\n PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed\n data volume.

" + "smithy.api#documentation": "

The date and time that Detective sent the invitation to the member account. The value is in\n milliseconds since the epoch.

" } }, - "MasterId": { - "target": "com.amazonaws.detective#AccountId", + "UpdatedTime": { + "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "

The AWS account identifier of the master account for the behavior graph.

" + "smithy.api#documentation": "

The date and time that the member account was last updated. The value is in milliseconds\n since the epoch.

" } }, - "PercentOfGraphUtilizationUpdatedTime": { - "target": "com.amazonaws.detective#Timestamp", + "EmailAddress": { + "target": "com.amazonaws.detective#EmailAddress", "traits": { - "smithy.api#documentation": "

The date and time when the graph utilization percentage was last updated.

" + "smithy.api#documentation": "

The AWS account root user email address for the member account.

" } }, - "Status": { - "target": "com.amazonaws.detective#MemberStatus", + "PercentOfGraphUtilization": { + "target": "com.amazonaws.detective#Percentage", "traits": { - "smithy.api#documentation": "

The current membership status of the member account. The status can have one of the\n following values:

\n \n

Member accounts that declined an invitation or that were removed from the behavior graph\n are not included.

" + "smithy.api#documentation": "

The member account data volume as a percentage of the maximum allowed data volume. 0\n indicates 0 percent, and 100 indicates 100 percent.

\n

Note that this is not the percentage of the behavior graph data volume.

\n

For example, the data volume for the behavior graph is 80 GB per day. The maximum data\n volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then\n PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed\n data volume.

" } } }, @@ -1021,17 +1021,17 @@ "com.amazonaws.detective#StartMonitoringMemberRequest": { "type": "structure", "members": { - "GraphArn": { - "target": "com.amazonaws.detective#GraphArn", + "AccountId": { + "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "

The ARN of the behavior graph.

", + "smithy.api#documentation": "

The account ID of the member account to try to enable.

\n

The account must be an invited member account with a status of\n ACCEPTED_BUT_DISABLED.

", "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.detective#AccountId", + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "

The account ID of the member account to try to enable.

\n

The account must be an invited member account with a status of\n ACCEPTED_BUT_DISABLED.

", + "smithy.api#documentation": "

The ARN of the behavior graph.

", "smithy.api#required": {} } } @@ -1043,17 +1043,17 @@ "com.amazonaws.detective#UnprocessedAccount": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.detective#AccountId", - "traits": { - "smithy.api#documentation": "

The AWS account identifier of the member account that was not processed.

" - } - }, "Reason": { "target": "com.amazonaws.detective#UnprocessedReason", "traits": { "smithy.api#documentation": "

The reason that the member account request could not be processed.

" } + }, + "AccountId": { + "target": "com.amazonaws.detective#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account identifier of the member account that was not processed.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/device-farm.2015-06-23.json b/codegen/sdk-codegen/aws-models/device-farm.2015-06-23.json index fe08c7b363cd..fea7dbe76861 100644 --- a/codegen/sdk-codegen/aws-models/device-farm.2015-06-23.json +++ b/codegen/sdk-codegen/aws-models/device-farm.2015-06-23.json @@ -41,10 +41,22 @@ "com.amazonaws.devicefarm#AccountSettings": { "type": "structure", "members": { - "trialMinutes": { - "target": "com.amazonaws.devicefarm#TrialMinutes", + "maxJobTimeoutMinutes": { + "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", "traits": { - "smithy.api#documentation": "

Information about an AWS account's usage of free trial device minutes.

" + "smithy.api#documentation": "

The maximum number of minutes a test run executes before it times out.

" + } + }, + "awsAccountNumber": { + "target": "com.amazonaws.devicefarm#AWSAccountNumber", + "traits": { + "smithy.api#documentation": "

The AWS account number specified in the AccountSettings\n container.

" + } + }, + "maxSlots": { + "target": "com.amazonaws.devicefarm#MaxSlotMap", + "traits": { + "smithy.api#documentation": "

The maximum number of device slots that the AWS account can purchase. Each maximum\n is expressed as an offering-id:number pair, where the\n offering-id represents one of the IDs returned by the\n ListOfferings command.

" } }, "unmeteredRemoteAccessDevices": { @@ -65,28 +77,16 @@ "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.

" } }, - "maxJobTimeoutMinutes": { - "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", - "traits": { - "smithy.api#documentation": "

The maximum number of minutes a test run executes before it times out.

" - } - }, "defaultJobTimeoutMinutes": { "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", "traits": { "smithy.api#documentation": "

The default number of minutes (at the account level) a test run executes before it times out. The\n default value is 150 minutes.

" } }, - "awsAccountNumber": { - "target": "com.amazonaws.devicefarm#AWSAccountNumber", - "traits": { - "smithy.api#documentation": "

The AWS account number specified in the AccountSettings\n container.

" - } - }, - "maxSlots": { - "target": "com.amazonaws.devicefarm#MaxSlotMap", + "trialMinutes": { + "target": "com.amazonaws.devicefarm#TrialMinutes", "traits": { - "smithy.api#documentation": "

The maximum number of device slots that the AWS account can purchase. Each maximum\n is expressed as an offering-id:number pair, where the\n offering-id represents one of the IDs returned by the\n ListOfferings command.

" + "smithy.api#documentation": "

Information about an AWS account's usage of free trial device minutes.

" } } }, @@ -146,18 +146,6 @@ "com.amazonaws.devicefarm#Artifact": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.devicefarm#Name", - "traits": { - "smithy.api#documentation": "

The artifact's name.

" - } - }, - "type": { - "target": "com.amazonaws.devicefarm#ArtifactType", - "traits": { - "smithy.api#documentation": "

The artifact's type.

\n

Allowed values include the following:

\n " - } - }, "extension": { "target": "com.amazonaws.devicefarm#String", "traits": { @@ -170,11 +158,23 @@ "smithy.api#documentation": "

The presigned Amazon S3 URL that can be used with a GET request to download the artifact's\n file.

" } }, + "type": { + "target": "com.amazonaws.devicefarm#ArtifactType", + "traits": { + "smithy.api#documentation": "

The artifact's type.

\n

Allowed values include the following:

\n " + } + }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The artifact's ARN.

" } + }, + "name": { + "target": "com.amazonaws.devicefarm#Name", + "traits": { + "smithy.api#documentation": "

The artifact's name.

" + } } }, "traits": { @@ -349,6 +349,12 @@ "com.amazonaws.devicefarm#CPU": { "type": "structure", "members": { + "frequency": { + "target": "com.amazonaws.devicefarm#String", + "traits": { + "smithy.api#documentation": "

The CPU's frequency.

" + } + }, "architecture": { "target": "com.amazonaws.devicefarm#String", "traits": { @@ -360,12 +366,6 @@ "traits": { "smithy.api#documentation": "

The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2\n GHz CPU is expressed as 1200000000.

" } - }, - "frequency": { - "target": "com.amazonaws.devicefarm#String", - "traits": { - "smithy.api#documentation": "

The CPU's frequency.

" - } } }, "traits": { @@ -406,28 +406,28 @@ "com.amazonaws.devicefarm#Counters": { "type": "structure", "members": { - "failed": { + "passed": { "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The number of failed entities.

" + "smithy.api#documentation": "

The number of passed entities.

" } }, - "warned": { + "skipped": { "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The number of warned entities.

" + "smithy.api#documentation": "

The number of skipped entities.

" } }, - "passed": { + "warned": { "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The number of passed entities.

" + "smithy.api#documentation": "

The number of warned entities.

" } }, - "stopped": { + "failed": { "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The number of stopped entities.

" + "smithy.api#documentation": "

The number of failed entities.

" } }, "errored": { @@ -436,10 +436,10 @@ "smithy.api#documentation": "

The number of errored entities.

" } }, - "skipped": { + "stopped": { "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The number of skipped entities.

" + "smithy.api#documentation": "

The number of stopped entities.

" } }, "total": { @@ -489,19 +489,6 @@ "smithy.api#required": {} } }, - "maxDevices": { - "target": "com.amazonaws.devicefarm#Integer", - "traits": { - "smithy.api#documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are\n available and meet the criteria that you assign for the rules parameter. Depending on how many\n devices meet these constraints, your device pool might contain fewer devices than the value for this\n parameter.

\n

By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.

" - } - }, - "projectArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the project for the device pool.

", - "smithy.api#required": {} - } - }, "description": { "target": "com.amazonaws.devicefarm#Message", "traits": { @@ -514,6 +501,19 @@ "smithy.api#documentation": "

The device pool's rules.

", "smithy.api#required": {} } + }, + "projectArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the project for the device pool.

", + "smithy.api#required": {} + } + }, + "maxDevices": { + "target": "com.amazonaws.devicefarm#Integer", + "traits": { + "smithy.api#documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are\n available and meet the criteria that you assign for the rules parameter. Depending on how many\n devices meet these constraints, your device pool might contain fewer devices than the value for this\n parameter.

\n

By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.

" + } } }, "traits": { @@ -563,12 +563,6 @@ "com.amazonaws.devicefarm#CreateInstanceProfileRequest": { "type": "structure", "members": { - "rebootAfterUse": { - "target": "com.amazonaws.devicefarm#Boolean", - "traits": { - "smithy.api#documentation": "

When set to true, Device Farm reboots the instance after a test run. The default value is\n true.

" - } - }, "description": { "target": "com.amazonaws.devicefarm#Message", "traits": { @@ -588,6 +582,12 @@ "smithy.api#required": {} } }, + "rebootAfterUse": { + "target": "com.amazonaws.devicefarm#Boolean", + "traits": { + "smithy.api#documentation": "

When set to true, Device Farm reboots the instance after a test run. The default value is\n true.

" + } + }, "excludeAppPackagesFromCleanup": { "target": "com.amazonaws.devicefarm#PackageIds", "traits": { @@ -636,23 +636,16 @@ "com.amazonaws.devicefarm#CreateNetworkProfileRequest": { "type": "structure", "members": { - "downlinkLossPercent": { - "target": "com.amazonaws.devicefarm#PercentInteger", - "traits": { - "smithy.api#documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" - } - }, - "uplinkDelayMs": { + "uplinkJitterMs": { "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" + "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "description": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The name for the new network profile.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the network profile.

" } }, "uplinkBandwidthBits": { @@ -661,22 +654,22 @@ "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" } }, - "uplinkJitterMs": { + "downlinkBandwidthBits": { "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" + "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" } }, - "downlinkDelayMs": { + "downlinkJitterMs": { "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" + "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" } }, - "downlinkBandwidthBits": { - "target": "com.amazonaws.devicefarm#Long", + "downlinkLossPercent": { + "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { - "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" + "smithy.api#documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" } }, "type": { @@ -685,6 +678,25 @@ "smithy.api#documentation": "

The type of network profile to create. Valid values are listed here.

" } }, + "name": { + "target": "com.amazonaws.devicefarm#Name", + "traits": { + "smithy.api#documentation": "

The name for the new network profile.

", + "smithy.api#required": {} + } + }, + "uplinkDelayMs": { + "target": "com.amazonaws.devicefarm#Long", + "traits": { + "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" + } + }, + "downlinkDelayMs": { + "target": "com.amazonaws.devicefarm#Long", + "traits": { + "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" + } + }, "uplinkLossPercent": { "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { @@ -697,18 +709,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to create a\n network profile.

", "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.devicefarm#Message", - "traits": { - "smithy.api#documentation": "

The description of the network profile.

" - } - }, - "downlinkJitterMs": { - "target": "com.amazonaws.devicefarm#Long", - "traits": { - "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" - } } } }, @@ -755,18 +755,18 @@ "com.amazonaws.devicefarm#CreateProjectRequest": { "type": "structure", "members": { - "defaultJobTimeoutMinutes": { - "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", - "traits": { - "smithy.api#documentation": "

Sets the execution timeout value (in minutes) for a project. All test runs in this project use the\n specified execution timeout value unless overridden when scheduling a run.

" - } - }, "name": { "target": "com.amazonaws.devicefarm#Name", "traits": { "smithy.api#documentation": "

The project's name.

", "smithy.api#required": {} } + }, + "defaultJobTimeoutMinutes": { + "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", + "traits": { + "smithy.api#documentation": "

Sets the execution timeout value (in minutes) for a project. All test runs in this project use the\n specified execution timeout value unless overridden when scheduling a run.

" + } } }, "traits": { @@ -836,23 +836,10 @@ "com.amazonaws.devicefarm#CreateRemoteAccessSessionRequest": { "type": "structure", "members": { - "projectArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to create a remote\n access session.

", - "smithy.api#required": {} - } - }, - "interactionMode": { - "target": "com.amazonaws.devicefarm#InteractionMode", - "traits": { - "smithy.api#documentation": "

The interaction mode of the remote access session. Valid values are:

\n " - } - }, - "remoteRecordEnabled": { + "remoteDebugEnabled": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

Set to true to enable remote recording for the remote access\n session.

" + "smithy.api#documentation": "

Set to true if you want to access devices remotely for debugging in\n your remote access session.

\n

Remote debugging is no\n longer supported.

" } }, "sshPublicKey": { @@ -861,35 +848,34 @@ "smithy.api#documentation": "

Ignored. The public key of the ssh key pair you want to use for connecting to remote\n devices in your remote debugging session. This key is required only if remoteDebugEnabled is\n set to true.

\n

Remote debugging is no\n longer supported.

" } }, - "clientId": { - "target": "com.amazonaws.devicefarm#ClientId", + "skipAppResign": { + "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

Unique identifier for the client. If you want access to multiple devices on the same client, you should\n pass the same clientId value in each call to CreateRemoteAccessSession. This\n identifier is required only if remoteDebugEnabled is set to true.

\n

Remote debugging is no\n longer supported.

" + "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?\n

" } }, - "configuration": { - "target": "com.amazonaws.devicefarm#CreateRemoteAccessSessionConfiguration", + "interactionMode": { + "target": "com.amazonaws.devicefarm#InteractionMode", "traits": { - "smithy.api#documentation": "

The configuration information for the remote access session request.

" + "smithy.api#documentation": "

The interaction mode of the remote access session. Valid values are:

\n " } }, - "deviceArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The ARN of the device for which you want to create a remote access session.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the remote access session to create.

" } }, - "skipAppResign": { - "target": "com.amazonaws.devicefarm#Boolean", + "clientId": { + "target": "com.amazonaws.devicefarm#ClientId", "traits": { - "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?\n

" + "smithy.api#documentation": "

Unique identifier for the client. If you want access to multiple devices on the same client, you should\n pass the same clientId value in each call to CreateRemoteAccessSession. This\n identifier is required only if remoteDebugEnabled is set to true.

\n

Remote debugging is no\n longer supported.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "configuration": { + "target": "com.amazonaws.devicefarm#CreateRemoteAccessSessionConfiguration", "traits": { - "smithy.api#documentation": "

The name of the remote access session to create.

" + "smithy.api#documentation": "

The configuration information for the remote access session request.

" } }, "instanceArn": { @@ -904,10 +890,24 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the app to be recorded in the remote access\n session.

" } }, - "remoteDebugEnabled": { - "target": "com.amazonaws.devicefarm#Boolean", + "projectArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Set to true if you want to access devices remotely for debugging in\n your remote access session.

\n

Remote debugging is no\n longer supported.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to create a remote\n access session.

", + "smithy.api#required": {} + } + }, + "remoteRecordEnabled": { + "target": "com.amazonaws.devicefarm#Boolean", + "traits": { + "smithy.api#documentation": "

Set to true to enable remote recording for the remote access\n session.

" + } + }, + "deviceArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the device for which you want to create a remote access session.

", + "smithy.api#required": {} } } }, @@ -949,18 +949,18 @@ "com.amazonaws.devicefarm#CreateTestGridProjectRequest": { "type": "structure", "members": { + "description": { + "target": "com.amazonaws.devicefarm#ResourceDescription", + "traits": { + "smithy.api#documentation": "

Human-readable description of the project.

" + } + }, "name": { "target": "com.amazonaws.devicefarm#ResourceName", "traits": { "smithy.api#documentation": "

Human-readable name of the Selenium testing project.

", "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.devicefarm#ResourceDescription", - "traits": { - "smithy.api#documentation": "

Human-readable description of the project.

" - } } } }, @@ -1020,17 +1020,17 @@ "com.amazonaws.devicefarm#CreateTestGridUrlResult": { "type": "structure", "members": { - "expires": { - "target": "com.amazonaws.devicefarm#DateTime", - "traits": { - "smithy.api#documentation": "

The number of seconds the URL from CreateTestGridUrlResult$url stays active.

" - } - }, "url": { "target": "com.amazonaws.devicefarm#String", "traits": { "smithy.api#documentation": "

A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to be passed\n to a RemoteWebDriver.

" } + }, + "expires": { + "target": "com.amazonaws.devicefarm#DateTime", + "traits": { + "smithy.api#documentation": "

The number of seconds the URL from CreateTestGridUrlResult$url stays active.

" + } } } }, @@ -1063,6 +1063,13 @@ "com.amazonaws.devicefarm#CreateUploadRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.devicefarm#Name", + "traits": { + "smithy.api#documentation": "

The upload's file name. The name should not contain any forward slashes (/). If you are\n uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an\n Android app, the file name must end with the .apk extension. For all others, the file name must\n end with the .zip file extension.

", + "smithy.api#required": {} + } + }, "projectArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { @@ -1082,13 +1089,6 @@ "traits": { "smithy.api#documentation": "

The upload's content type (for example, application/octet-stream).

" } - }, - "name": { - "target": "com.amazonaws.devicefarm#Name", - "traits": { - "smithy.api#documentation": "

The upload's file name. The name should not contain any forward slashes (/). If you are\n uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an\n Android app, the file name must end with the .apk extension. For all others, the file name must\n end with the .zip file extension.

", - "smithy.api#required": {} - } } }, "traits": { @@ -1141,17 +1141,17 @@ "smithy.api#documentation": "

An optional description that provides details about your VPC endpoint configuration.

" } }, - "vpceServiceName": { - "target": "com.amazonaws.devicefarm#VPCEServiceName", + "serviceDnsName": { + "target": "com.amazonaws.devicefarm#ServiceDnsName", "traits": { - "smithy.api#documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

", + "smithy.api#documentation": "

The DNS name of the service running in your VPC that you want Device Farm to\n test.

", "smithy.api#required": {} } }, - "serviceDnsName": { - "target": "com.amazonaws.devicefarm#ServiceDnsName", + "vpceServiceName": { + "target": "com.amazonaws.devicefarm#VPCEServiceName", "traits": { - "smithy.api#documentation": "

The DNS name of the service running in your VPC that you want Device Farm to\n test.

", + "smithy.api#documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

", "smithy.api#required": {} } }, @@ -1189,18 +1189,18 @@ "com.amazonaws.devicefarm#CustomerArtifactPaths": { "type": "structure", "members": { - "androidPaths": { - "target": "com.amazonaws.devicefarm#AndroidPaths", - "traits": { - "smithy.api#documentation": "

Comma-separated list of paths on the Android device where the artifacts generated by the customer's\n tests are pulled from.

" - } - }, "deviceHostPaths": { "target": "com.amazonaws.devicefarm#DeviceHostPaths", "traits": { "smithy.api#documentation": "

Comma-separated list of paths in the test execution environment where the artifacts generated by the\n customer's tests are pulled from.

" } }, + "androidPaths": { + "target": "com.amazonaws.devicefarm#AndroidPaths", + "traits": { + "smithy.api#documentation": "

Comma-separated list of paths on the Android device where the artifacts generated by the customer's\n tests are pulled from.

" + } + }, "iosPaths": { "target": "com.amazonaws.devicefarm#IosPaths", "traits": { @@ -1626,16 +1626,16 @@ "com.amazonaws.devicefarm#Device": { "type": "structure", "members": { - "availability": { - "target": "com.amazonaws.devicefarm#DeviceAvailability", + "remoteAccessEnabled": { + "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.

" + "smithy.api#documentation": "

Specifies whether remote access has been enabled for the specified\n device.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "platform": { + "target": "com.amazonaws.devicefarm#DevicePlatform", "traits": { - "smithy.api#documentation": "

The device's display name.

" + "smithy.api#documentation": "

The device's platform.

\n

Allowed values include:

\n " } }, "model": { @@ -1650,28 +1650,34 @@ "smithy.api#documentation": "

The device's ARN.

" } }, - "os": { - "target": "com.amazonaws.devicefarm#String", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The device's operating system type.

" + "smithy.api#documentation": "

The device's display name.

" } }, - "fleetType": { - "target": "com.amazonaws.devicefarm#String", + "remoteDebugEnabled": { + "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.

" + "smithy.api#documentation": "

This flag is set to true if remote debugging is enabled for the\n device.

\n

Remote debugging is no\n longer supported.

" } }, - "carrier": { + "os": { "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The device's carrier.

" + "smithy.api#documentation": "

The device's operating system type.

" } }, - "fleetName": { - "target": "com.amazonaws.devicefarm#String", + "cpu": { + "target": "com.amazonaws.devicefarm#CPU", "traits": { - "smithy.api#documentation": "

The name of the fleet to which this device belongs.

" + "smithy.api#documentation": "

Information about the device's CPU.

" + } + }, + "formFactor": { + "target": "com.amazonaws.devicefarm#DeviceFormFactor", + "traits": { + "smithy.api#documentation": "

The device's form factor.

\n

Allowed values include:

\n " } }, "memory": { @@ -1686,28 +1692,28 @@ "smithy.api#documentation": "

The device's model ID.

" } }, - "image": { - "target": "com.amazonaws.devicefarm#String", + "resolution": { + "target": "com.amazonaws.devicefarm#Resolution", "traits": { - "smithy.api#documentation": "

The device's image name.

" + "smithy.api#documentation": "

The resolution of the device.

" } }, - "instances": { - "target": "com.amazonaws.devicefarm#DeviceInstances", + "availability": { + "target": "com.amazonaws.devicefarm#DeviceAvailability", "traits": { - "smithy.api#documentation": "

The instances that belong to this device.

" + "smithy.api#documentation": "

Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.

" } }, - "formFactor": { - "target": "com.amazonaws.devicefarm#DeviceFormFactor", + "fleetType": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The device's form factor.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.

" } }, - "cpu": { - "target": "com.amazonaws.devicefarm#CPU", + "carrier": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

Information about the device's CPU.

" + "smithy.api#documentation": "

The device's carrier.

" } }, "radio": { @@ -1716,40 +1722,34 @@ "smithy.api#documentation": "

The device's radio.

" } }, - "heapSize": { - "target": "com.amazonaws.devicefarm#Long", - "traits": { - "smithy.api#documentation": "

The device's heap size, expressed in bytes.

" - } - }, - "remoteDebugEnabled": { - "target": "com.amazonaws.devicefarm#Boolean", + "manufacturer": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

This flag is set to true if remote debugging is enabled for the\n device.

\n

Remote debugging is no\n longer supported.

" + "smithy.api#documentation": "

The device's manufacturer name.

" } }, - "resolution": { - "target": "com.amazonaws.devicefarm#Resolution", + "instances": { + "target": "com.amazonaws.devicefarm#DeviceInstances", "traits": { - "smithy.api#documentation": "

The resolution of the device.

" + "smithy.api#documentation": "

The instances that belong to this device.

" } }, - "manufacturer": { + "fleetName": { "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The device's manufacturer name.

" + "smithy.api#documentation": "

The name of the fleet to which this device belongs.

" } }, - "remoteAccessEnabled": { - "target": "com.amazonaws.devicefarm#Boolean", + "heapSize": { + "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

Specifies whether remote access has been enabled for the specified\n device.

" + "smithy.api#documentation": "

The device's heap size, expressed in bytes.

" } }, - "platform": { - "target": "com.amazonaws.devicefarm#DevicePlatform", + "image": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The device's platform.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

The device's image name.

" } } }, @@ -2090,7 +2090,7 @@ "sdkId": "Device Farm", "arnNamespace": "devicefarm", "cloudFormationName": "DeviceFarm", - "cloudTrailEventSource": "model.devicefarm.amazon.com" + "cloudTrailEventSource": "devicefarm.amazonaws.com" }, "aws.auth#sigv4": { "name": "devicefarm" @@ -2106,12 +2106,6 @@ "com.amazonaws.devicefarm#DeviceFilter": { "type": "structure", "members": { - "values": { - "target": "com.amazonaws.devicefarm#DeviceFilterValues", - "traits": { - "smithy.api#documentation": "

An array of one or more filter values used in a device filter.

\n

\n Operator Values\n

\n \n

\n Attribute Values\n

\n " - } - }, "operator": { "target": "com.amazonaws.devicefarm#RuleOperator", "traits": { @@ -2123,6 +2117,12 @@ "traits": { "smithy.api#documentation": "

The aspect of a device such as platform or model used as the selection criteria in a\n device filter.

\n

The supported operators for each attribute are provided in the following list.

\n
\n
ARN
\n
\n

The Amazon Resource Name (ARN) of the device (for example,\n arn:aws:devicefarm:us-west-2::device:12345Example).

\n

Supported operators: EQUALS, IN, NOT_IN\n

\n
\n
PLATFORM
\n
\n

The device platform. Valid values are ANDROID or IOS.

\n

Supported operators: EQUALS\n

\n
\n
OS_VERSION
\n
\n

The operating system version (for example, 10.3.2).

\n

Supported operators: EQUALS, GREATER_THAN,\n GREATER_THAN_OR_EQUALS, IN,\n LESS_THAN, LESS_THAN_OR_EQUALS,\n NOT_IN\n

\n
\n
MODEL
\n
\n

The device model (for example, iPad 5th Gen).

\n

Supported operators: CONTAINS, EQUALS,\n IN, NOT_IN\n

\n
\n
AVAILABILITY
\n
\n

The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

\n

Supported operators: EQUALS\n

\n
\n
FORM_FACTOR
\n
\n

The device form factor. Valid values are PHONE or TABLET.

\n

Supported operators: EQUALS\n

\n
\n
MANUFACTURER
\n
\n

The device manufacturer (for example, Apple).

\n

Supported operators: EQUALS, IN,\n NOT_IN\n

\n
\n
REMOTE_ACCESS_ENABLED
\n
\n

Whether the device is enabled for remote access. Valid values are TRUE or\n FALSE.

\n

Supported operators: EQUALS\n

\n
\n
REMOTE_DEBUG_ENABLED
\n
\n

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

\n

Supported operators: EQUALS\n

\n

Because remote debugging is no longer\n supported, this filter is ignored.

\n
\n
INSTANCE_ARN
\n
\n

The Amazon Resource Name (ARN) of the device instance.

\n

Supported operators: EQUALS, IN,\n NOT_IN\n

\n
\n
INSTANCE_LABELS
\n
\n

The label of the device instance.

\n

Supported operators: CONTAINS\n

\n
\n
FLEET_TYPE
\n
\n

The fleet type. Valid values are PUBLIC or PRIVATE.

\n

Supported operators: EQUALS\n

\n
\n
" } + }, + "values": { + "target": "com.amazonaws.devicefarm#DeviceFilterValues", + "traits": { + "smithy.api#documentation": "

An array of one or more filter values used in a device filter.

\n

\n Operator Values\n

\n \n

\n Attribute Values\n

\n " + } } }, "traits": { @@ -2220,22 +2220,22 @@ "com.amazonaws.devicefarm#DeviceInstance": { "type": "structure", "members": { - "labels": { - "target": "com.amazonaws.devicefarm#InstanceLabels", + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

An array of strings that describe the device instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device instance.

" } }, - "udid": { - "target": "com.amazonaws.devicefarm#String", + "deviceArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Unique device identifier for the device instance.

" + "smithy.api#documentation": "

The ARN of the device.

" } }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "instanceProfile": { + "target": "com.amazonaws.devicefarm#InstanceProfile", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device instance.

" + "smithy.api#documentation": "

A object that contains information about the instance profile.

" } }, "status": { @@ -2244,16 +2244,16 @@ "smithy.api#documentation": "

The status of the device instance. Valid values are listed here.

" } }, - "deviceArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "udid": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The ARN of the device.

" + "smithy.api#documentation": "

Unique device identifier for the device instance.

" } }, - "instanceProfile": { - "target": "com.amazonaws.devicefarm#InstanceProfile", + "labels": { + "target": "com.amazonaws.devicefarm#InstanceLabels", "traits": { - "smithy.api#documentation": "

A object that contains information about the instance profile.

" + "smithy.api#documentation": "

An array of strings that describe the device instance.

" } } }, @@ -2270,10 +2270,10 @@ "com.amazonaws.devicefarm#DeviceMinutes": { "type": "structure", "members": { - "total": { + "metered": { "target": "com.amazonaws.devicefarm#Double", "traits": { - "smithy.api#documentation": "

When specified, represents the total minutes used by the resource to run\n tests.

" + "smithy.api#documentation": "

When specified, represents only the sum of metered minutes used by the resource to\n run tests.

" } }, "unmetered": { @@ -2282,10 +2282,10 @@ "smithy.api#documentation": "

When specified, represents only the sum of unmetered minutes used by the resource\n to run tests.

" } }, - "metered": { + "total": { "target": "com.amazonaws.devicefarm#Double", "traits": { - "smithy.api#documentation": "

When specified, represents only the sum of metered minutes used by the resource to\n run tests.

" + "smithy.api#documentation": "

When specified, represents the total minutes used by the resource to run\n tests.

" } } }, @@ -2311,34 +2311,28 @@ "com.amazonaws.devicefarm#DevicePool": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.devicefarm#Message", - "traits": { - "smithy.api#documentation": "

The device pool's description.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The device pool's ARN.

" } }, - "type": { - "target": "com.amazonaws.devicefarm#DevicePoolType", + "rules": { + "target": "com.amazonaws.devicefarm#Rules", "traits": { - "smithy.api#documentation": "

The device pool's type.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

Information about the device pool's rules.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "description": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The device pool's name.

" + "smithy.api#documentation": "

The device pool's description.

" } }, - "rules": { - "target": "com.amazonaws.devicefarm#Rules", + "type": { + "target": "com.amazonaws.devicefarm#DevicePoolType", "traits": { - "smithy.api#documentation": "

Information about the device pool's rules.

" + "smithy.api#documentation": "

The device pool's type.

\n

Allowed values include:

\n " } }, "maxDevices": { @@ -2346,6 +2340,12 @@ "traits": { "smithy.api#documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are\n available and meet the criteria that you assign for the rules parameter. Depending on how many\n devices meet these constraints, your device pool might contain fewer devices than the value for this\n parameter.

\n

By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.

" } + }, + "name": { + "target": "com.amazonaws.devicefarm#Name", + "traits": { + "smithy.api#documentation": "

The device pool's name.

" + } } }, "traits": { @@ -2355,12 +2355,6 @@ "com.amazonaws.devicefarm#DevicePoolCompatibilityResult": { "type": "structure", "members": { - "device": { - "target": "com.amazonaws.devicefarm#Device", - "traits": { - "smithy.api#documentation": "

The device (phone or tablet) to return information about.

" - } - }, "incompatibilityMessages": { "target": "com.amazonaws.devicefarm#IncompatibilityMessages", "traits": { @@ -2372,6 +2366,12 @@ "traits": { "smithy.api#documentation": "

Whether the result was compatible with the device pool.

" } + }, + "device": { + "target": "com.amazonaws.devicefarm#Device", + "traits": { + "smithy.api#documentation": "

The device (phone or tablet) to return information about.

" + } } }, "traits": { @@ -2430,10 +2430,10 @@ "com.amazonaws.devicefarm#DeviceSelectionResult": { "type": "structure", "members": { - "matchedDevicesCount": { - "target": "com.amazonaws.devicefarm#Integer", + "filters": { + "target": "com.amazonaws.devicefarm#DeviceFilters", "traits": { - "smithy.api#documentation": "

The number of devices that matched the device filter selection criteria.

" + "smithy.api#documentation": "

The filters in a device selection result.

" } }, "maxDevices": { @@ -2442,10 +2442,10 @@ "smithy.api#documentation": "

The maximum number of devices to be selected by a device filter and included in a test\n run.

" } }, - "filters": { - "target": "com.amazonaws.devicefarm#DeviceFilters", + "matchedDevicesCount": { + "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The filters in a device selection result.

" + "smithy.api#documentation": "

The number of devices that matched the device filter selection criteria.

" } } }, @@ -2471,16 +2471,16 @@ "com.amazonaws.devicefarm#ExecutionConfiguration": { "type": "structure", "members": { - "videoCapture": { - "target": "com.amazonaws.devicefarm#VideoCapture", + "skipAppResign": { + "target": "com.amazonaws.devicefarm#SkipAppResign", "traits": { - "smithy.api#documentation": "

Set to true to enable video capture. Otherwise, set to false. The default is true.

" + "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.

" } }, - "jobTimeoutMinutes": { - "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", + "accountsCleanup": { + "target": "com.amazonaws.devicefarm#AccountsCleanup", "traits": { - "smithy.api#documentation": "

The number of minutes a test run executes before it times out.

" + "smithy.api#documentation": "

True if account cleanup is enabled at the beginning of the test. Otherwise, false.

" } }, "appPackagesCleanup": { @@ -2489,16 +2489,16 @@ "smithy.api#documentation": "

True if app package cleanup is enabled at the beginning of the test. Otherwise, false.

" } }, - "skipAppResign": { - "target": "com.amazonaws.devicefarm#SkipAppResign", + "videoCapture": { + "target": "com.amazonaws.devicefarm#VideoCapture", "traits": { - "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.

" + "smithy.api#documentation": "

Set to true to enable video capture. Otherwise, set to false. The default is true.

" } }, - "accountsCleanup": { - "target": "com.amazonaws.devicefarm#AccountsCleanup", + "jobTimeoutMinutes": { + "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", "traits": { - "smithy.api#documentation": "

True if account cleanup is enabled at the beginning of the test. Otherwise, false.

" + "smithy.api#documentation": "

The number of minutes a test run executes before it times out.

" } } }, @@ -2785,10 +2785,16 @@ "com.amazonaws.devicefarm#GetDevicePoolCompatibilityRequest": { "type": "structure", "members": { - "test": { - "target": "com.amazonaws.devicefarm#ScheduleRunTest", + "appArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Information about the uploaded test to be run against the device pool.

" + "smithy.api#documentation": "

The ARN of the app that is associated with the specified device pool.

" + } + }, + "testType": { + "target": "com.amazonaws.devicefarm#TestType", + "traits": { + "smithy.api#documentation": "

The test type for the specified device pool.

\n

Allowed values include the following:

\n " } }, "devicePoolArn": { @@ -2804,16 +2810,10 @@ "smithy.api#documentation": "

An object that contains information about the settings for a run.

" } }, - "appArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the app that is associated with the specified device pool.

" - } - }, - "testType": { - "target": "com.amazonaws.devicefarm#TestType", + "test": { + "target": "com.amazonaws.devicefarm#ScheduleRunTest", "traits": { - "smithy.api#documentation": "

The test type for the specified device pool.

\n

Allowed values include the following:

\n " + "smithy.api#documentation": "

Information about the uploaded test to be run against the device pool.

" } } }, @@ -2824,16 +2824,16 @@ "com.amazonaws.devicefarm#GetDevicePoolCompatibilityResult": { "type": "structure", "members": { - "incompatibleDevices": { + "compatibleDevices": { "target": "com.amazonaws.devicefarm#DevicePoolCompatibilityResults", "traits": { - "smithy.api#documentation": "

Information about incompatible devices.

" + "smithy.api#documentation": "

Information about compatible devices.

" } }, - "compatibleDevices": { + "incompatibleDevices": { "target": "com.amazonaws.devicefarm#DevicePoolCompatibilityResults", "traits": { - "smithy.api#documentation": "

Information about compatible devices.

" + "smithy.api#documentation": "

Information about incompatible devices.

" } } }, @@ -3443,16 +3443,16 @@ "com.amazonaws.devicefarm#GetTestGridSessionRequest": { "type": "structure", "members": { - "sessionArn": { + "projectArn": { "target": "com.amazonaws.devicefarm#DeviceFarmArn", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a TestGridSession.

" + "smithy.api#documentation": "

The ARN for the project that this session belongs to. See CreateTestGridProject and ListTestGridProjects.

" } }, - "projectArn": { + "sessionArn": { "target": "com.amazonaws.devicefarm#DeviceFarmArn", "traits": { - "smithy.api#documentation": "

The ARN for the project that this session belongs to. See CreateTestGridProject and ListTestGridProjects.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a TestGridSession.

" } }, "sessionId": { @@ -3683,17 +3683,17 @@ "com.amazonaws.devicefarm#InstallToRemoteAccessSessionRequest": { "type": "structure", "members": { - "appArn": { + "remoteAccessSessionArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the app about which you are requesting information.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the remote access session about which you are\n requesting information.

", "smithy.api#required": {} } }, - "remoteAccessSessionArn": { + "appArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the remote access session about which you are\n requesting information.

", + "smithy.api#documentation": "

The ARN of the app about which you are requesting information.

", "smithy.api#required": {} } } @@ -3725,36 +3725,36 @@ "com.amazonaws.devicefarm#InstanceProfile": { "type": "structure", "members": { - "rebootAfterUse": { - "target": "com.amazonaws.devicefarm#Boolean", - "traits": { - "smithy.api#documentation": "

When set to true, Device Farm reboots the instance after a test run. The default value is\n true.

" - } - }, "excludeAppPackagesFromCleanup": { "target": "com.amazonaws.devicefarm#PackageIds", "traits": { "smithy.api#documentation": "

An array of strings containing the list of app packages that should not be cleaned up from the device\n after a test run completes.

\n

The list of packages is considered only if you set packageCleanup to\n true.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", - "traits": { - "smithy.api#documentation": "

The name of the instance profile.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

" } }, + "name": { + "target": "com.amazonaws.devicefarm#Name", + "traits": { + "smithy.api#documentation": "

The name of the instance profile.

" + } + }, "description": { "target": "com.amazonaws.devicefarm#Message", "traits": { "smithy.api#documentation": "

The description of the instance profile.

" } }, + "rebootAfterUse": { + "target": "com.amazonaws.devicefarm#Boolean", + "traits": { + "smithy.api#documentation": "

When set to true, Device Farm reboots the instance after a test run. The default value is\n true.

" + } + }, "packageCleanup": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { @@ -3858,76 +3858,76 @@ "com.amazonaws.devicefarm#Job": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "status": { + "target": "com.amazonaws.devicefarm#ExecutionStatus", "traits": { - "smithy.api#documentation": "

The job's ARN.

" + "smithy.api#documentation": "

The job's status.

\n

Allowed values include:

\n " } }, - "deviceMinutes": { - "target": "com.amazonaws.devicefarm#DeviceMinutes", + "type": { + "target": "com.amazonaws.devicefarm#TestType", "traits": { - "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the job.

" + "smithy.api#documentation": "

The job's type.

\n

Allowed values include the following:

\n " } }, - "message": { - "target": "com.amazonaws.devicefarm#Message", + "device": { + "target": "com.amazonaws.devicefarm#Device", "traits": { - "smithy.api#documentation": "

A message about the job's result.

" + "smithy.api#documentation": "

The device (phone or tablet).

" } }, - "stopped": { - "target": "com.amazonaws.devicefarm#DateTime", + "videoCapture": { + "target": "com.amazonaws.devicefarm#VideoCapture", "traits": { - "smithy.api#documentation": "

The job's stop time.

" + "smithy.api#documentation": "

This value is set to true if video capture is enabled. Otherwise, it is set to false.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "result": { + "target": "com.amazonaws.devicefarm#ExecutionResult", "traits": { - "smithy.api#documentation": "

The job's name.

" + "smithy.api#documentation": "

The job's result.

\n

Allowed values include:

\n " } }, - "counters": { - "target": "com.amazonaws.devicefarm#Counters", + "message": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The job's result counters.

" + "smithy.api#documentation": "

A message about the job's result.

" } }, - "started": { - "target": "com.amazonaws.devicefarm#DateTime", + "videoEndpoint": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The job's start time.

" + "smithy.api#documentation": "

The endpoint for streaming device video.

" } }, - "result": { - "target": "com.amazonaws.devicefarm#ExecutionResult", + "counters": { + "target": "com.amazonaws.devicefarm#Counters", "traits": { - "smithy.api#documentation": "

The job's result.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

The job's result counters.

" } }, - "device": { - "target": "com.amazonaws.devicefarm#Device", + "started": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The device (phone or tablet).

" + "smithy.api#documentation": "

The job's start time.

" } }, - "videoEndpoint": { - "target": "com.amazonaws.devicefarm#String", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The endpoint for streaming device video.

" + "smithy.api#documentation": "

The job's name.

" } }, - "status": { - "target": "com.amazonaws.devicefarm#ExecutionStatus", + "deviceMinutes": { + "target": "com.amazonaws.devicefarm#DeviceMinutes", "traits": { - "smithy.api#documentation": "

The job's status.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the job.

" } }, - "type": { - "target": "com.amazonaws.devicefarm#TestType", + "created": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The job's type.

\n

Allowed values include the following:

\n " + "smithy.api#documentation": "

When the job was created.

" } }, "instanceArn": { @@ -3936,16 +3936,16 @@ "smithy.api#documentation": "

The ARN of the instance.

" } }, - "videoCapture": { - "target": "com.amazonaws.devicefarm#VideoCapture", + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

This value is set to true if video capture is enabled. Otherwise, it is set to false.

" + "smithy.api#documentation": "

The job's ARN.

" } }, - "created": { + "stopped": { "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

When the job was created.

" + "smithy.api#documentation": "

The job's stop time.

" } } }, @@ -4014,6 +4014,12 @@ "com.amazonaws.devicefarm#ListArtifactsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } + }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { @@ -4021,12 +4027,6 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "type": { "target": "com.amazonaws.devicefarm#ArtifactCategory", "traits": { @@ -4042,17 +4042,17 @@ "com.amazonaws.devicefarm#ListArtifactsResult": { "type": "structure", "members": { - "artifacts": { - "target": "com.amazonaws.devicefarm#Artifacts", - "traits": { - "smithy.api#documentation": "

Information about the artifacts.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" } + }, + "artifacts": { + "target": "com.amazonaws.devicefarm#Artifacts", + "traits": { + "smithy.api#documentation": "

Information about the artifacts.

" + } } }, "traits": { @@ -4088,34 +4088,34 @@ "com.amazonaws.devicefarm#ListDeviceInstancesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" - } - }, "maxResults": { "target": "com.amazonaws.devicefarm#Integer", "traits": { "smithy.api#documentation": "

An integer that specifies the maximum number of items you want to return in the API response.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } } } }, "com.amazonaws.devicefarm#ListDeviceInstancesResult": { "type": "structure", "members": { - "deviceInstances": { - "target": "com.amazonaws.devicefarm#DeviceInstances", - "traits": { - "smithy.api#documentation": "

An object that contains information about your device instances.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

An identifier that can be used in the next call to this operation to return the next\n set of items in the list.

" } + }, + "deviceInstances": { + "target": "com.amazonaws.devicefarm#DeviceInstances", + "traits": { + "smithy.api#documentation": "

An object that contains information about your device instances.

" + } } } }, @@ -4153,12 +4153,6 @@ "com.amazonaws.devicefarm#ListDevicePoolsRequest": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.devicefarm#DevicePoolType", - "traits": { - "smithy.api#documentation": "

The device pools' type.

\n

Allowed values include:

\n " - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { @@ -4166,6 +4160,12 @@ "smithy.api#required": {} } }, + "type": { + "target": "com.amazonaws.devicefarm#DevicePoolType", + "traits": { + "smithy.api#documentation": "

The device pools' type.

\n

Allowed values include:

\n " + } + }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { @@ -4231,12 +4231,6 @@ "com.amazonaws.devicefarm#ListDevicesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { @@ -4248,6 +4242,12 @@ "traits": { "smithy.api#documentation": "

Used to select a set of devices. A filter is made up of an attribute, an operator, and\n one or more values.

\n " } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -4257,17 +4257,17 @@ "com.amazonaws.devicefarm#ListDevicesResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" - } - }, "devices": { "target": "com.amazonaws.devicefarm#Devices", "traits": { "smithy.api#documentation": "

Information about the devices.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" + } } }, "traits": { @@ -4303,17 +4303,17 @@ "com.amazonaws.devicefarm#ListInstanceProfilesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.devicefarm#Integer", - "traits": { - "smithy.api#documentation": "

An integer that specifies the maximum number of items you want to return in the API response.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } + }, + "maxResults": { + "target": "com.amazonaws.devicefarm#Integer", + "traits": { + "smithy.api#documentation": "

An integer that specifies the maximum number of items you want to return in the API response.

" + } } } }, @@ -4368,18 +4368,18 @@ "com.amazonaws.devicefarm#ListJobsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The run's Amazon Resource Name (ARN).

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -4435,10 +4435,11 @@ "com.amazonaws.devicefarm#ListNetworkProfilesRequest": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.devicefarm#NetworkProfileType", + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The type of network profile to return information about. Valid values are listed here.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to list network\n profiles.

", + "smithy.api#required": {} } }, "nextToken": { @@ -4447,11 +4448,10 @@ "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" } }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "type": { + "target": "com.amazonaws.devicefarm#NetworkProfileType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to list network\n profiles.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The type of network profile to return information about. Valid values are listed here.

" } } } @@ -4459,17 +4459,17 @@ "com.amazonaws.devicefarm#ListNetworkProfilesResult": { "type": "structure", "members": { - "networkProfiles": { - "target": "com.amazonaws.devicefarm#NetworkProfiles", - "traits": { - "smithy.api#documentation": "

A list of the available network profiles.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" } + }, + "networkProfiles": { + "target": "com.amazonaws.devicefarm#NetworkProfiles", + "traits": { + "smithy.api#documentation": "

A list of the available network profiles.

" + } } } }, @@ -4700,17 +4700,17 @@ "com.amazonaws.devicefarm#ListProjectsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm\n returns a list of all projects for the AWS account. You can also specify a project\n ARN.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -4720,17 +4720,17 @@ "com.amazonaws.devicefarm#ListProjectsResult": { "type": "structure", "members": { - "projects": { - "target": "com.amazonaws.devicefarm#Projects", - "traits": { - "smithy.api#documentation": "

Information about the projects.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" } + }, + "projects": { + "target": "com.amazonaws.devicefarm#Projects", + "traits": { + "smithy.api#documentation": "

Information about the projects.

" + } } }, "traits": { @@ -4766,18 +4766,18 @@ "com.amazonaws.devicefarm#ListRemoteAccessSessionsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project about which you are requesting\n information.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -4787,17 +4787,17 @@ "com.amazonaws.devicefarm#ListRemoteAccessSessionsResult": { "type": "structure", "members": { - "remoteAccessSessions": { - "target": "com.amazonaws.devicefarm#RemoteAccessSessions", - "traits": { - "smithy.api#documentation": "

A container that represents the metadata from the service about each remote access session you are\n requesting.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" } + }, + "remoteAccessSessions": { + "target": "com.amazonaws.devicefarm#RemoteAccessSessions", + "traits": { + "smithy.api#documentation": "

A container that represents the metadata from the service about each remote access session you are\n requesting.

" + } } }, "traits": { @@ -4838,18 +4838,18 @@ "com.amazonaws.devicefarm#ListRunsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } + }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to list\n runs.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } } }, "traits": { @@ -4859,17 +4859,17 @@ "com.amazonaws.devicefarm#ListRunsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" - } - }, "runs": { "target": "com.amazonaws.devicefarm#Runs", "traits": { "smithy.api#documentation": "

Information about the runs.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" + } } }, "traits": { @@ -4910,18 +4910,18 @@ "com.amazonaws.devicefarm#ListSamplesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job used to list samples.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -4982,18 +4982,18 @@ "com.amazonaws.devicefarm#ListSuitesRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } + }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The job's Amazon Resource Name (ARN).

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } } }, "traits": { @@ -5003,17 +5003,17 @@ "com.amazonaws.devicefarm#ListSuitesResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" - } - }, "suites": { "target": "com.amazonaws.devicefarm#Suites", "traits": { "smithy.api#documentation": "

Information about the suites.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" + } } }, "traits": { @@ -5111,17 +5111,17 @@ "com.amazonaws.devicefarm#ListTestGridProjectsResult": { "type": "structure", "members": { - "testGridProjects": { - "target": "com.amazonaws.devicefarm#TestGridProjects", - "traits": { - "smithy.api#documentation": "

The list of TestGridProjects, based on a ListTestGridProjectsRequest.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

Used for pagination. Pass into ListTestGridProjects to get more results in a paginated\n request.

" } + }, + "testGridProjects": { + "target": "com.amazonaws.devicefarm#TestGridProjects", + "traits": { + "smithy.api#documentation": "

The list of TestGridProjects, based on a ListTestGridProjectsRequest.

" + } } } }, @@ -5156,10 +5156,10 @@ "com.amazonaws.devicefarm#ListTestGridSessionActionsRequest": { "type": "structure", "members": { - "maxResult": { - "target": "com.amazonaws.devicefarm#MaxPageSize", + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { - "smithy.api#documentation": "

The maximum number of sessions to return per response.

" + "smithy.api#documentation": "

Pagination token.

" } }, "sessionArn": { @@ -5169,10 +5169,10 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", + "maxResult": { + "target": "com.amazonaws.devicefarm#MaxPageSize", "traits": { - "smithy.api#documentation": "

Pagination token.

" + "smithy.api#documentation": "

The maximum number of sessions to return per response.

" } } } @@ -5225,19 +5225,6 @@ "com.amazonaws.devicefarm#ListTestGridSessionArtifactsRequest": { "type": "structure", "members": { - "sessionArn": { - "target": "com.amazonaws.devicefarm#DeviceFarmArn", - "traits": { - "smithy.api#documentation": "

The ARN of a TestGridSession.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

Pagination token.

" - } - }, "type": { "target": "com.amazonaws.devicefarm#TestGridSessionArtifactCategory", "traits": { @@ -5249,23 +5236,36 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to be returned by a request.

" } - } - } - }, - "com.amazonaws.devicefarm#ListTestGridSessionArtifactsResult": { - "type": "structure", - "members": { + }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

Pagination token.

" } }, + "sessionArn": { + "target": "com.amazonaws.devicefarm#DeviceFarmArn", + "traits": { + "smithy.api#documentation": "

The ARN of a TestGridSession.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.devicefarm#ListTestGridSessionArtifactsResult": { + "type": "structure", + "members": { "artifacts": { "target": "com.amazonaws.devicefarm#TestGridSessionArtifacts", "traits": { "smithy.api#documentation": "

A list of test grid session artifacts for a TestGridSession.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination token.

" + } } } }, @@ -5300,16 +5300,11 @@ "com.amazonaws.devicefarm#ListTestGridSessionsRequest": { "type": "structure", "members": { - "creationTimeBefore": { - "target": "com.amazonaws.devicefarm#DateTime", + "projectArn": { + "target": "com.amazonaws.devicefarm#DeviceFarmArn", "traits": { - "smithy.api#documentation": "

Return only sessions created before this time.

" - } - }, - "endTimeAfter": { - "target": "com.amazonaws.devicefarm#DateTime", - "traits": { - "smithy.api#documentation": "

Return only sessions that ended after this time.

" + "smithy.api#documentation": "

ARN of a TestGridProject.

", + "smithy.api#required": {} } }, "status": { @@ -5318,23 +5313,16 @@ "smithy.api#documentation": "

Return only sessions in this state.

" } }, - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

Pagination token.

" - } - }, "creationTimeAfter": { "target": "com.amazonaws.devicefarm#DateTime", "traits": { "smithy.api#documentation": "

Return only sessions created after this time.

" } }, - "projectArn": { - "target": "com.amazonaws.devicefarm#DeviceFarmArn", + "creationTimeBefore": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

ARN of a TestGridProject.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Return only sessions created before this time.

" } }, "endTimeBefore": { @@ -5343,11 +5331,23 @@ "smithy.api#documentation": "

Return only sessions that ended before this time.

" } }, + "endTimeAfter": { + "target": "com.amazonaws.devicefarm#DateTime", + "traits": { + "smithy.api#documentation": "

Return only sessions that ended after this time.

" + } + }, "maxResult": { "target": "com.amazonaws.devicefarm#MaxPageSize", "traits": { "smithy.api#documentation": "

Return only this many results at a time.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination token.

" + } } } }, @@ -5402,18 +5402,18 @@ "com.amazonaws.devicefarm#ListTestsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The test suite's Amazon Resource Name (ARN).

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -5423,17 +5423,17 @@ "com.amazonaws.devicefarm#ListTestsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" - } - }, "tests": { "target": "com.amazonaws.devicefarm#Tests", "traits": { "smithy.api#documentation": "

Information about the tests.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" + } } }, "traits": { @@ -5474,18 +5474,18 @@ "com.amazonaws.devicefarm#ListUniqueProblemsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The unique problems' ARNs.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -5495,17 +5495,17 @@ "com.amazonaws.devicefarm#ListUniqueProblemsResult": { "type": "structure", "members": { - "uniqueProblems": { - "target": "com.amazonaws.devicefarm#UniqueProblemsByExecutionResultMap", - "traits": { - "smithy.api#documentation": "

Information about the unique problems.

\n

Allowed values include:

\n " - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" } + }, + "uniqueProblems": { + "target": "com.amazonaws.devicefarm#UniqueProblemsByExecutionResultMap", + "traits": { + "smithy.api#documentation": "

Information about the unique problems.

\n

Allowed values include:

\n " + } } }, "traits": { @@ -5546,12 +5546,6 @@ "com.amazonaws.devicefarm#ListUploadsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" - } - }, "type": { "target": "com.amazonaws.devicefarm#UploadType", "traits": { @@ -5564,6 +5558,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to list\n uploads.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can\n be used to return the next set of items in the list.

" + } } }, "traits": { @@ -5573,17 +5573,17 @@ "com.amazonaws.devicefarm#ListUploadsResult": { "type": "structure", "members": { - "uploads": { - "target": "com.amazonaws.devicefarm#Uploads", - "traits": { - "smithy.api#documentation": "

Information about the uploads.

" - } - }, "nextToken": { "target": "com.amazonaws.devicefarm#PaginationToken", "traits": { "smithy.api#documentation": "

If the number of items that are returned is significantly large, this is an identifier that is also\n returned. It can be used in a subsequent call to this operation to return the next set of items in the\n list.

" } + }, + "uploads": { + "target": "com.amazonaws.devicefarm#Uploads", + "traits": { + "smithy.api#documentation": "

Information about the uploads.

" + } } }, "traits": { @@ -5613,17 +5613,17 @@ "com.amazonaws.devicefarm#ListVPCEConfigurationsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.devicefarm#PaginationToken", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" - } - }, "maxResults": { "target": "com.amazonaws.devicefarm#Integer", "traits": { "smithy.api#documentation": "

An integer that specifies the maximum number of items you want to return in the API response.

" } + }, + "nextToken": { + "target": "com.amazonaws.devicefarm#PaginationToken", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } } } }, @@ -5647,17 +5647,17 @@ "com.amazonaws.devicefarm#Location": { "type": "structure", "members": { - "longitude": { + "latitude": { "target": "com.amazonaws.devicefarm#Double", "traits": { - "smithy.api#documentation": "

The longitude.

", + "smithy.api#documentation": "

The latitude.

", "smithy.api#required": {} } }, - "latitude": { + "longitude": { "target": "com.amazonaws.devicefarm#Double", "traits": { - "smithy.api#documentation": "

The latitude.

", + "smithy.api#documentation": "

The longitude.

", "smithy.api#required": {} } } @@ -5741,48 +5741,30 @@ "com.amazonaws.devicefarm#NetworkProfile": { "type": "structure", "members": { - "uplinkDelayMs": { - "target": "com.amazonaws.devicefarm#Long", - "traits": { - "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" - } - }, - "downlinkJitterMs": { + "uplinkJitterMs": { "target": "com.amazonaws.devicefarm#Long", "traits": { "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" } }, - "description": { - "target": "com.amazonaws.devicefarm#Message", - "traits": { - "smithy.api#documentation": "

The description of the network profile.

" - } - }, - "downlinkLossPercent": { - "target": "com.amazonaws.devicefarm#PercentInteger", + "type": { + "target": "com.amazonaws.devicefarm#NetworkProfileType", "traits": { - "smithy.api#documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" + "smithy.api#documentation": "

The type of network profile. Valid values are listed here.

" } }, - "uplinkJitterMs": { - "target": "com.amazonaws.devicefarm#Long", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" + "smithy.api#documentation": "

The name of the network profile.

" } }, - "downlinkBandwidthBits": { + "uplinkBandwidthBits": { "target": "com.amazonaws.devicefarm#Long", "traits": { "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" } }, - "type": { - "target": "com.amazonaws.devicefarm#NetworkProfileType", - "traits": { - "smithy.api#documentation": "

The type of network profile. Valid values are listed here.

" - } - }, "uplinkLossPercent": { "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { @@ -5801,17 +5783,35 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network profile.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "downlinkJitterMs": { + "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

The name of the network profile.

" + "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" } }, - "uplinkBandwidthBits": { + "uplinkDelayMs": { + "target": "com.amazonaws.devicefarm#Long", + "traits": { + "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" + } + }, + "downlinkBandwidthBits": { "target": "com.amazonaws.devicefarm#Long", "traits": { "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" } + }, + "downlinkLossPercent": { + "target": "com.amazonaws.devicefarm#PercentInteger", + "traits": { + "smithy.api#documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" + } + }, + "description": { + "target": "com.amazonaws.devicefarm#Message", + "traits": { + "smithy.api#documentation": "

The description of the network profile.

" + } } }, "traits": { @@ -5884,18 +5884,18 @@ "smithy.api#documentation": "

The ID that corresponds to a device offering.

" } }, - "platform": { - "target": "com.amazonaws.devicefarm#DevicePlatform", - "traits": { - "smithy.api#documentation": "

The platform of the device (for example, ANDROID or IOS).

" - } - }, "description": { "target": "com.amazonaws.devicefarm#Message", "traits": { "smithy.api#documentation": "

A string that describes the offering.

" } }, + "platform": { + "target": "com.amazonaws.devicefarm#DevicePlatform", + "traits": { + "smithy.api#documentation": "

The platform of the device (for example, ANDROID or IOS).

" + } + }, "type": { "target": "com.amazonaws.devicefarm#OfferingType", "traits": { @@ -5918,17 +5918,17 @@ "com.amazonaws.devicefarm#OfferingPromotion": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.devicefarm#Message", - "traits": { - "smithy.api#documentation": "

A string that describes the offering promotion.

" - } - }, "id": { "target": "com.amazonaws.devicefarm#OfferingPromotionIdentifier", "traits": { "smithy.api#documentation": "

The ID of the offering promotion.

" } + }, + "description": { + "target": "com.amazonaws.devicefarm#Message", + "traits": { + "smithy.api#documentation": "

A string that describes the offering promotion.

" + } } }, "traits": { @@ -5993,10 +5993,10 @@ "com.amazonaws.devicefarm#OfferingTransaction": { "type": "structure", "members": { - "offeringStatus": { - "target": "com.amazonaws.devicefarm#OfferingStatus", + "transactionId": { + "target": "com.amazonaws.devicefarm#TransactionIdentifier", "traits": { - "smithy.api#documentation": "

The status of an offering transaction.

" + "smithy.api#documentation": "

The transaction ID of the offering transaction.

" } }, "cost": { @@ -6011,17 +6011,17 @@ "smithy.api#documentation": "

The ID that corresponds to a device offering promotion.

" } }, - "transactionId": { - "target": "com.amazonaws.devicefarm#TransactionIdentifier", - "traits": { - "smithy.api#documentation": "

The transaction ID of the offering transaction.

" - } - }, "createdOn": { "target": "com.amazonaws.devicefarm#DateTime", "traits": { "smithy.api#documentation": "

The date on which an offering transaction was created.

" } + }, + "offeringStatus": { + "target": "com.amazonaws.devicefarm#OfferingStatus", + "traits": { + "smithy.api#documentation": "

The status of an offering transaction.

" + } } }, "traits": { @@ -6097,28 +6097,16 @@ "com.amazonaws.devicefarm#Problem": { "type": "structure", "members": { - "result": { - "target": "com.amazonaws.devicefarm#ExecutionResult", - "traits": { - "smithy.api#documentation": "

The problem's result.

\n

Allowed values include:

\n " - } - }, - "suite": { - "target": "com.amazonaws.devicefarm#ProblemDetail", - "traits": { - "smithy.api#documentation": "

Information about the associated suite.

" - } - }, "test": { "target": "com.amazonaws.devicefarm#ProblemDetail", "traits": { "smithy.api#documentation": "

Information about the associated test.

" } }, - "run": { - "target": "com.amazonaws.devicefarm#ProblemDetail", + "message": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

Information about the associated run.

" + "smithy.api#documentation": "

A message about the problem's result.

" } }, "device": { @@ -6127,19 +6115,31 @@ "smithy.api#documentation": "

Information about the associated device.

" } }, - "message": { - "target": "com.amazonaws.devicefarm#Message", + "job": { + "target": "com.amazonaws.devicefarm#ProblemDetail", "traits": { - "smithy.api#documentation": "

A message about the problem's result.

" + "smithy.api#documentation": "

Information about the associated job.

" } }, - "job": { + "run": { "target": "com.amazonaws.devicefarm#ProblemDetail", "traits": { - "smithy.api#documentation": "

Information about the associated job.

" + "smithy.api#documentation": "

Information about the associated run.

" } - } - }, + }, + "result": { + "target": "com.amazonaws.devicefarm#ExecutionResult", + "traits": { + "smithy.api#documentation": "

The problem's result.

\n

Allowed values include:

\n " + } + }, + "suite": { + "target": "com.amazonaws.devicefarm#ProblemDetail", + "traits": { + "smithy.api#documentation": "

Information about the associated suite.

" + } + } + }, "traits": { "smithy.api#documentation": "

Represents a specific warning or failure.

" } @@ -6173,18 +6173,18 @@ "com.amazonaws.devicefarm#Project": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.devicefarm#Name", - "traits": { - "smithy.api#documentation": "

The project's name.

" - } - }, "created": { "target": "com.amazonaws.devicefarm#DateTime", "traits": { "smithy.api#documentation": "

When the project was created.

" } }, + "name": { + "target": "com.amazonaws.devicefarm#Name", + "traits": { + "smithy.api#documentation": "

The project's name.

" + } + }, "defaultJobTimeoutMinutes": { "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", "traits": { @@ -6240,12 +6240,6 @@ "com.amazonaws.devicefarm#PurchaseOfferingRequest": { "type": "structure", "members": { - "quantity": { - "target": "com.amazonaws.devicefarm#Integer", - "traits": { - "smithy.api#documentation": "

The number of device slots to purchase in an offering request.

" - } - }, "offeringId": { "target": "com.amazonaws.devicefarm#OfferingIdentifier", "traits": { @@ -6257,6 +6251,12 @@ "traits": { "smithy.api#documentation": "

The ID of the offering promotion to be applied to the purchase.

" } + }, + "quantity": { + "target": "com.amazonaws.devicefarm#Integer", + "traits": { + "smithy.api#documentation": "

The number of device slots to purchase in an offering request.

" + } } }, "traits": { @@ -6289,10 +6289,10 @@ "com.amazonaws.devicefarm#Radios": { "type": "structure", "members": { - "gps": { + "bluetooth": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

True if GPS is enabled at the beginning of the test. Otherwise, false.

" + "smithy.api#documentation": "

True if Bluetooth is enabled at the beginning of the test. Otherwise, false.

" } }, "nfc": { @@ -6307,10 +6307,10 @@ "smithy.api#documentation": "

True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.

" } }, - "bluetooth": { + "gps": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

True if Bluetooth is enabled at the beginning of the test. Otherwise, false.

" + "smithy.api#documentation": "

True if GPS is enabled at the beginning of the test. Otherwise, false.

" } } }, @@ -6321,17 +6321,17 @@ "com.amazonaws.devicefarm#RecurringCharge": { "type": "structure", "members": { - "cost": { - "target": "com.amazonaws.devicefarm#MonetaryAmount", - "traits": { - "smithy.api#documentation": "

The cost of the recurring charge.

" - } - }, "frequency": { "target": "com.amazonaws.devicefarm#RecurringChargeFrequency", "traits": { "smithy.api#documentation": "

The frequency in which charges recur.

" } + }, + "cost": { + "target": "com.amazonaws.devicefarm#MonetaryAmount", + "traits": { + "smithy.api#documentation": "

The cost of the recurring charge.

" + } } }, "traits": { @@ -6358,46 +6358,40 @@ "com.amazonaws.devicefarm#RemoteAccessSession": { "type": "structure", "members": { - "instanceArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the instance.

" - } - }, - "deviceUdid": { - "target": "com.amazonaws.devicefarm#String", + "message": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

Unique device identifier for the remote device. Only returned if remote debugging\n is enabled for the remote access session.

\n

Remote debugging is no\n longer supported.

" + "smithy.api#documentation": "

A message about the remote access session.

" } }, - "result": { - "target": "com.amazonaws.devicefarm#ExecutionResult", + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The result of the remote access session. Can be any of the following:

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the remote access session.

" } }, - "skipAppResign": { - "target": "com.amazonaws.devicefarm#SkipAppResign", + "deviceMinutes": { + "target": "com.amazonaws.devicefarm#DeviceMinutes", "traits": { - "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.

" + "smithy.api#documentation": "

The number of minutes a device is used in a remote access session (including setup\n and teardown minutes).

" } }, - "endpoint": { - "target": "com.amazonaws.devicefarm#String", + "interactionMode": { + "target": "com.amazonaws.devicefarm#InteractionMode", "traits": { - "smithy.api#documentation": "

The endpoint for the remote access sesssion.

" + "smithy.api#documentation": "

The interaction mode of the remote access session. Valid values are:

\n " } }, - "started": { + "stopped": { "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the remote access session was started.

" + "smithy.api#documentation": "

The date and time the remote access session was stopped.

" } }, - "created": { - "target": "com.amazonaws.devicefarm#DateTime", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The date and time the remote access session was created.

" + "smithy.api#documentation": "

The name of the remote access session.

" } }, "remoteDebugEnabled": { @@ -6406,70 +6400,58 @@ "smithy.api#documentation": "

This flag is set to true if remote debugging is enabled for the remote\n access session.

\n

Remote debugging is no\n longer supported.

" } }, - "deviceMinutes": { - "target": "com.amazonaws.devicefarm#DeviceMinutes", - "traits": { - "smithy.api#documentation": "

The number of minutes a device is used in a remote access session (including setup\n and teardown minutes).

" - } - }, "remoteRecordAppArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The ARN for the app to be recorded in the remote access session.

" } }, - "message": { - "target": "com.amazonaws.devicefarm#Message", - "traits": { - "smithy.api#documentation": "

A message about the remote access session.

" - } - }, - "clientId": { - "target": "com.amazonaws.devicefarm#ClientId", - "traits": { - "smithy.api#documentation": "

Unique identifier of your client for the remote access session. Only returned if\n remote debugging is enabled for the remote access session.

\n

Remote debugging is no\n longer supported.

" - } - }, "status": { "target": "com.amazonaws.devicefarm#ExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the remote access session. Can be any of the following:

\n " } }, + "instanceArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the instance.

" + } + }, "billingMethod": { "target": "com.amazonaws.devicefarm#BillingMethod", "traits": { "smithy.api#documentation": "

The billing method of the remote access session. Possible values include METERED or\n UNMETERED. For more information about metered devices, see AWS Device Farm\n terminology.

" } }, - "stopped": { + "created": { "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the remote access session was stopped.

" + "smithy.api#documentation": "

The date and time the remote access session was created.

" } }, - "interactionMode": { - "target": "com.amazonaws.devicefarm#InteractionMode", + "remoteRecordEnabled": { + "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

The interaction mode of the remote access session. Valid values are:

\n " + "smithy.api#documentation": "

This flag is set to true if remote recording is enabled for the remote\n access session.

" } }, - "device": { - "target": "com.amazonaws.devicefarm#Device", + "endpoint": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The device (phone or tablet) used in the remote access session.

" + "smithy.api#documentation": "

The endpoint for the remote access sesssion.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "device": { + "target": "com.amazonaws.devicefarm#Device", "traits": { - "smithy.api#documentation": "

The name of the remote access session.

" + "smithy.api#documentation": "

The device (phone or tablet) used in the remote access session.

" } }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "deviceUdid": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the remote access session.

" + "smithy.api#documentation": "

Unique device identifier for the remote device. Only returned if remote debugging\n is enabled for the remote access session.

\n

Remote debugging is no\n longer supported.

" } }, "hostAddress": { @@ -6478,10 +6460,28 @@ "smithy.api#documentation": "

IP address of the EC2 host where you need to connect to remotely debug devices.\n Only returned if remote debugging is enabled for the remote access session.

\n

Remote debugging is no\n longer supported.

" } }, - "remoteRecordEnabled": { - "target": "com.amazonaws.devicefarm#Boolean", + "skipAppResign": { + "target": "com.amazonaws.devicefarm#SkipAppResign", "traits": { - "smithy.api#documentation": "

This flag is set to true if remote recording is enabled for the remote\n access session.

" + "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.

" + } + }, + "started": { + "target": "com.amazonaws.devicefarm#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the remote access session was started.

" + } + }, + "clientId": { + "target": "com.amazonaws.devicefarm#ClientId", + "traits": { + "smithy.api#documentation": "

Unique identifier of your client for the remote access session. Only returned if\n remote debugging is enabled for the remote access session.

\n

Remote debugging is no\n longer supported.

" + } + }, + "result": { + "target": "com.amazonaws.devicefarm#ExecutionResult", + "traits": { + "smithy.api#documentation": "

The result of the remote access session. Can be any of the following:

\n " } } }, @@ -6527,17 +6527,17 @@ "com.amazonaws.devicefarm#RenewOfferingRequest": { "type": "structure", "members": { - "offeringId": { - "target": "com.amazonaws.devicefarm#OfferingIdentifier", - "traits": { - "smithy.api#documentation": "

The ID of a request to renew an offering.

" - } - }, "quantity": { "target": "com.amazonaws.devicefarm#Integer", "traits": { "smithy.api#documentation": "

The quantity requested in an offering renewal.

" } + }, + "offeringId": { + "target": "com.amazonaws.devicefarm#OfferingIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of a request to renew an offering.

" + } } }, "traits": { @@ -6611,12 +6611,6 @@ "com.amazonaws.devicefarm#Rule": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.devicefarm#String", - "traits": { - "smithy.api#documentation": "

The rule's value.

" - } - }, "operator": { "target": "com.amazonaws.devicefarm#RuleOperator", "traits": { @@ -6628,6 +6622,12 @@ "traits": { "smithy.api#documentation": "

The rule's stringified attribute. For example, specify the value as\n \"\\\"abc\\\"\".

\n

The supported operators for each attribute are provided in the following\n list.

\n
\n
APPIUM_VERSION
\n
\n

The Appium version for the test.

\n

Supported operators: CONTAINS\n

\n
\n
ARN
\n
\n

The Amazon Resource Name (ARN) of the device (for example,\n arn:aws:devicefarm:us-west-2::device:12345Example.

\n

Supported operators: EQUALS,\n IN, NOT_IN\n

\n
\n
AVAILABILITY
\n
\n

The current availability of the device. Valid values are AVAILABLE,\n HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

\n

Supported operators: EQUALS\n

\n
\n
FLEET_TYPE
\n
\n

The fleet type. Valid values are PUBLIC or PRIVATE.

\n

Supported operators: EQUALS\n

\n
\n
FORM_FACTOR
\n
\n

The device form factor. Valid values are PHONE or TABLET.

\n

Supported operators: EQUALS,\n IN, NOT_IN\n

\n
\n
INSTANCE_ARN
\n
\n

The Amazon Resource Name (ARN) of the device instance.

\n

Supported operators: IN,\n NOT_IN\n

\n
\n
INSTANCE_LABELS
\n
\n

The label of the device instance.

\n

Supported operators: CONTAINS\n

\n
\n
MANUFACTURER
\n
\n

The device manufacturer (for example, Apple).

\n

Supported operators: EQUALS,\n IN, NOT_IN\n

\n
\n
MODEL
\n
\n

The device model, such as Apple iPad Air 2 or Google Pixel.

\n

Supported operators: CONTAINS,\n EQUALS, IN, NOT_IN\n

\n
\n
OS_VERSION
\n
\n

The operating system version (for example, 10.3.2).

\n

Supported operators: EQUALS,\n GREATER_THAN, GREATER_THAN_OR_EQUALS,\n IN, LESS_THAN,\n LESS_THAN_OR_EQUALS, NOT_IN\n

\n
\n
PLATFORM
\n
\n

The device platform. Valid values are ANDROID or IOS.

\n

Supported operators: EQUALS,\n IN, NOT_IN\n

\n
\n
REMOTE_ACCESS_ENABLED
\n
\n

Whether the device is enabled for remote access. Valid values are TRUE\n or FALSE.

\n

Supported operators: EQUALS\n

\n
\n
REMOTE_DEBUG_ENABLED
\n
\n

Whether the device is enabled for remote debugging. Valid values are\n TRUE or FALSE.

\n

Supported operators: EQUALS\n

\n

Because remote debugging is no longer\n supported, this filter is ignored.

\n
\n
" } + }, + "value": { + "target": "com.amazonaws.devicefarm#String", + "traits": { + "smithy.api#documentation": "

The rule's value.

" + } } }, "traits": { @@ -6682,52 +6682,40 @@ "com.amazonaws.devicefarm#Run": { "type": "structure", "members": { - "platform": { - "target": "com.amazonaws.devicefarm#DevicePlatform", + "message": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The run's platform.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

A message about the run's result.

" } }, - "eventCount": { - "target": "com.amazonaws.devicefarm#Integer", + "created": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz\n test should perform.

" + "smithy.api#documentation": "

When the run was created.

" } }, - "appUpload": { + "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

An app to upload or that has been uploaded.

" - } - }, - "billingMethod": { - "target": "com.amazonaws.devicefarm#BillingMethod", - "traits": { - "smithy.api#documentation": "

Specifies the billing method for a test run: metered or\n unmetered. If the parameter is not specified, the default value is\n metered.

\n \n

If you have unmetered device slots, you must set this to unmetered to use them.\n Otherwise, the run is counted toward metered device minutes.

\n " - } - }, - "type": { - "target": "com.amazonaws.devicefarm#TestType", - "traits": { - "smithy.api#documentation": "

The run's type.

\n

Must be one of the following values:

\n " + "smithy.api#documentation": "

The run's ARN.

" } }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "deviceMinutes": { + "target": "com.amazonaws.devicefarm#DeviceMinutes", "traits": { - "smithy.api#documentation": "

The run's ARN.

" + "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the test run.

" } }, - "devicePoolArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "billingMethod": { + "target": "com.amazonaws.devicefarm#BillingMethod", "traits": { - "smithy.api#documentation": "

The ARN of the device pool for the run.

" + "smithy.api#documentation": "

Specifies the billing method for a test run: metered or\n unmetered. If the parameter is not specified, the default value is\n metered.

\n \n

If you have unmetered device slots, you must set this to unmetered to use them.\n Otherwise, the run is counted toward metered device minutes.

\n " } }, - "message": { - "target": "com.amazonaws.devicefarm#Message", + "status": { + "target": "com.amazonaws.devicefarm#ExecutionStatus", "traits": { - "smithy.api#documentation": "

A message about the run's result.

" + "smithy.api#documentation": "

The run's status.

\n

Allowed values include:

\n " } }, "customerArtifactPaths": { @@ -6736,28 +6724,22 @@ "smithy.api#documentation": "

Output CustomerArtifactPaths object for the test run.

" } }, - "locale": { - "target": "com.amazonaws.devicefarm#String", - "traits": { - "smithy.api#documentation": "

Information about the locale that is used for the run.

" - } - }, - "started": { - "target": "com.amazonaws.devicefarm#DateTime", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The run's start time.

" + "smithy.api#documentation": "

The run's name.

" } }, - "seed": { - "target": "com.amazonaws.devicefarm#Integer", + "networkProfile": { + "target": "com.amazonaws.devicefarm#NetworkProfile", "traits": { - "smithy.api#documentation": "

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same\n seed value between tests ensures identical event sequences.

" + "smithy.api#documentation": "

The network profile being used for a test run.

" } }, - "jobTimeoutMinutes": { - "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", + "stopped": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The number of minutes the job executes before it times out.

" + "smithy.api#documentation": "

The run's stop time.

" } }, "radios": { @@ -6766,58 +6748,58 @@ "smithy.api#documentation": "

Information about the radio states for the run.

" } }, - "result": { - "target": "com.amazonaws.devicefarm#ExecutionResult", + "jobTimeoutMinutes": { + "target": "com.amazonaws.devicefarm#JobTimeoutMinutes", "traits": { - "smithy.api#documentation": "

The run's result.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

The number of minutes the job executes before it times out.

" } }, - "testSpecArn": { + "devicePoolArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the YAML-formatted test specification for the run.

" + "smithy.api#documentation": "

The ARN of the device pool for the run.

" } }, - "deviceSelectionResult": { - "target": "com.amazonaws.devicefarm#DeviceSelectionResult", + "platform": { + "target": "com.amazonaws.devicefarm#DevicePlatform", "traits": { - "smithy.api#documentation": "

The results of a device filter used to select the devices for a test run.

" + "smithy.api#documentation": "

The run's platform.

\n

Allowed values include:

\n " } }, - "completedJobs": { - "target": "com.amazonaws.devicefarm#Integer", + "locale": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

The total number of completed jobs.

" + "smithy.api#documentation": "

Information about the locale that is used for the run.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "type": { + "target": "com.amazonaws.devicefarm#TestType", "traits": { - "smithy.api#documentation": "

The run's name.

" + "smithy.api#documentation": "

The run's type.

\n

Must be one of the following values:

\n " } }, - "networkProfile": { - "target": "com.amazonaws.devicefarm#NetworkProfile", + "result": { + "target": "com.amazonaws.devicefarm#ExecutionResult", "traits": { - "smithy.api#documentation": "

The network profile being used for a test run.

" + "smithy.api#documentation": "

The run's result.

\n

Allowed values include:

\n " } }, - "deviceMinutes": { - "target": "com.amazonaws.devicefarm#DeviceMinutes", + "started": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the test run.

" + "smithy.api#documentation": "

The run's start time.

" } }, - "created": { - "target": "com.amazonaws.devicefarm#DateTime", + "seed": { + "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

When the run was created.

" + "smithy.api#documentation": "

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same\n seed value between tests ensures identical event sequences.

" } }, - "stopped": { - "target": "com.amazonaws.devicefarm#DateTime", + "eventCount": { + "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The run's stop time.

" + "smithy.api#documentation": "

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz\n test should perform.

" } }, "parsingResultUrl": { @@ -6826,28 +6808,34 @@ "smithy.api#documentation": "

Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package.\n If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points\n to.

" } }, - "status": { - "target": "com.amazonaws.devicefarm#ExecutionStatus", + "completedJobs": { + "target": "com.amazonaws.devicefarm#Integer", "traits": { - "smithy.api#documentation": "

The run's status.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

The total number of completed jobs.

" } }, - "skipAppResign": { - "target": "com.amazonaws.devicefarm#SkipAppResign", + "webUrl": { + "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.

" + "smithy.api#documentation": "

The Device Farm console URL for the recording of the run.

" } }, - "totalJobs": { - "target": "com.amazonaws.devicefarm#Integer", + "appUpload": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The total number of jobs for the run.

" + "smithy.api#documentation": "

An app to upload or that has been uploaded.

" } }, - "resultCode": { - "target": "com.amazonaws.devicefarm#ExecutionResultCode", + "testSpecArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Supporting field for the result field. Set only if result is SKIPPED.\n PARSING_FAILED if the result is skipped because of test package parsing failure.

" + "smithy.api#documentation": "

The ARN of the YAML-formatted test specification for the run.

" + } + }, + "deviceSelectionResult": { + "target": "com.amazonaws.devicefarm#DeviceSelectionResult", + "traits": { + "smithy.api#documentation": "

The results of a device filter used to select the devices for a test run.

" } }, "location": { @@ -6862,10 +6850,22 @@ "smithy.api#documentation": "

The run's result counters.

" } }, - "webUrl": { - "target": "com.amazonaws.devicefarm#String", + "skipAppResign": { + "target": "com.amazonaws.devicefarm#SkipAppResign", "traits": { - "smithy.api#documentation": "

The Device Farm console URL for the recording of the run.

" + "smithy.api#documentation": "

When set to true, for private devices, Device Farm does not sign your app again. For public\n devices, Device Farm always signs your apps again.

\n

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device\n Farm FAQs.

" + } + }, + "resultCode": { + "target": "com.amazonaws.devicefarm#ExecutionResultCode", + "traits": { + "smithy.api#documentation": "

Supporting field for the result field. Set only if result is SKIPPED.\n PARSING_FAILED if the result is skipped because of test package parsing failure.

" + } + }, + "totalJobs": { + "target": "com.amazonaws.devicefarm#Integer", + "traits": { + "smithy.api#documentation": "

The total number of jobs for the run.

" } } }, @@ -6882,18 +6882,18 @@ "com.amazonaws.devicefarm#Sample": { "type": "structure", "members": { - "url": { - "target": "com.amazonaws.devicefarm#URL", - "traits": { - "smithy.api#documentation": "

The presigned Amazon S3 URL that can be used with a GET request to download the sample's\n file.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The sample's ARN.

" } }, + "url": { + "target": "com.amazonaws.devicefarm#URL", + "traits": { + "smithy.api#documentation": "

The presigned Amazon S3 URL that can be used with a GET request to download the sample's\n file.

" + } + }, "type": { "target": "com.amazonaws.devicefarm#SampleType", "traits": { @@ -7018,28 +7018,16 @@ "com.amazonaws.devicefarm#ScheduleRunConfiguration": { "type": "structure", "members": { - "billingMethod": { - "target": "com.amazonaws.devicefarm#BillingMethod", - "traits": { - "smithy.api#documentation": "

Specifies the billing method for a test run: metered or\n unmetered. If the parameter is not specified, the default value is\n metered.

\n \n

If you have purchased unmetered device slots, you must set this parameter to unmetered to\n make use of them. Otherwise, your run counts against your metered time.

\n " - } - }, - "customerArtifactPaths": { - "target": "com.amazonaws.devicefarm#CustomerArtifactPaths", - "traits": { - "smithy.api#documentation": "

Input CustomerArtifactPaths object for the scheduled run\n configuration.

" - } - }, - "locale": { - "target": "com.amazonaws.devicefarm#String", + "radios": { + "target": "com.amazonaws.devicefarm#Radios", "traits": { - "smithy.api#documentation": "

Information about the locale that is used for the run.

" + "smithy.api#documentation": "

Information about the radio states for the run.

" } }, - "extraDataPackageArn": { + "networkProfileArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to\n external data for Android or the app's sandbox for iOS.

" + "smithy.api#documentation": "

Reserved for internal use.

" } }, "location": { @@ -7060,16 +7048,28 @@ "smithy.api#documentation": "

An array of ARNs for your VPC endpoint configurations.

" } }, - "radios": { - "target": "com.amazonaws.devicefarm#Radios", + "billingMethod": { + "target": "com.amazonaws.devicefarm#BillingMethod", "traits": { - "smithy.api#documentation": "

Information about the radio states for the run.

" + "smithy.api#documentation": "

Specifies the billing method for a test run: metered or\n unmetered. If the parameter is not specified, the default value is\n metered.

\n \n

If you have purchased unmetered device slots, you must set this parameter to unmetered to\n make use of them. Otherwise, your run counts against your metered time.

\n " } }, - "networkProfileArn": { + "extraDataPackageArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Reserved for internal use.

" + "smithy.api#documentation": "

The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to\n external data for Android or the app's sandbox for iOS.

" + } + }, + "locale": { + "target": "com.amazonaws.devicefarm#String", + "traits": { + "smithy.api#documentation": "

Information about the locale that is used for the run.

" + } + }, + "customerArtifactPaths": { + "target": "com.amazonaws.devicefarm#CustomerArtifactPaths", + "traits": { + "smithy.api#documentation": "

Input CustomerArtifactPaths object for the scheduled run\n configuration.

" } } }, @@ -7080,17 +7080,23 @@ "com.amazonaws.devicefarm#ScheduleRunRequest": { "type": "structure", "members": { - "projectArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "test": { + "target": "com.amazonaws.devicefarm#ScheduleRunTest", "traits": { - "smithy.api#documentation": "

The ARN of the project for the run to be scheduled.

", + "smithy.api#documentation": "

Information about the test for the run to be scheduled.

", "smithy.api#required": {} } }, - "configuration": { - "target": "com.amazonaws.devicefarm#ScheduleRunConfiguration", + "deviceSelectionConfiguration": { + "target": "com.amazonaws.devicefarm#DeviceSelectionConfiguration", "traits": { - "smithy.api#documentation": "

Information about the settings for the run to be scheduled.

" + "smithy.api#documentation": "

The filter criteria used to dynamically select a set of devices for a test run and the maximum number of\n devices to be included in the run.

\n

Either \n devicePoolArn\n or \n deviceSelectionConfiguration\n is required in a\n request.

" + } + }, + "appArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of an application package to run tests against, created with CreateUpload.\n See ListUploads.

" } }, "devicePoolArn": { @@ -7111,23 +7117,17 @@ "smithy.api#documentation": "

Specifies configuration information about a test run, such as the execution timeout\n (in minutes).

" } }, - "deviceSelectionConfiguration": { - "target": "com.amazonaws.devicefarm#DeviceSelectionConfiguration", - "traits": { - "smithy.api#documentation": "

The filter criteria used to dynamically select a set of devices for a test run and the maximum number of\n devices to be included in the run.

\n

Either \n devicePoolArn\n or \n deviceSelectionConfiguration\n is required in a\n request.

" - } - }, - "appArn": { + "projectArn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of an application package to run tests against, created with CreateUpload.\n See ListUploads.

" + "smithy.api#documentation": "

The ARN of the project for the run to be scheduled.

", + "smithy.api#required": {} } }, - "test": { - "target": "com.amazonaws.devicefarm#ScheduleRunTest", + "configuration": { + "target": "com.amazonaws.devicefarm#ScheduleRunConfiguration", "traits": { - "smithy.api#documentation": "

Information about the test for the run to be scheduled.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Information about the settings for the run to be scheduled.

" } } }, @@ -7152,17 +7152,16 @@ "com.amazonaws.devicefarm#ScheduleRunTest": { "type": "structure", "members": { - "parameters": { - "target": "com.amazonaws.devicefarm#TestParameters", + "testSpecArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The test's parameters, such as test framework parameters and fixture settings.\n Parameters are represented by name-value pairs of strings.

\n

For all tests:

\n \n

For Calabash tests:

\n \n

For Appium tests (all types):

\n \n

For fuzz tests (Android only):

\n \n

For Explorer tests:

\n \n

For Instrumentation:

\n \n

For XCTest and XCTestUI:

\n \n

For UIAutomator:

\n " + "smithy.api#documentation": "

The ARN of the YAML-formatted test specification.

" } }, - "type": { - "target": "com.amazonaws.devicefarm#TestType", + "filter": { + "target": "com.amazonaws.devicefarm#Filter", "traits": { - "smithy.api#documentation": "

The test's type.

\n

Must be one of the following values:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The test's filter.

" } }, "testPackageArn": { @@ -7171,16 +7170,17 @@ "smithy.api#documentation": "

The ARN of the uploaded test to be run.

" } }, - "testSpecArn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "parameters": { + "target": "com.amazonaws.devicefarm#TestParameters", "traits": { - "smithy.api#documentation": "

The ARN of the YAML-formatted test specification.

" + "smithy.api#documentation": "

The test's parameters, such as test framework parameters and fixture settings.\n Parameters are represented by name-value pairs of strings.

\n

For all tests:

\n \n

For Calabash tests:

\n \n

For Appium tests (all types):

\n \n

For fuzz tests (Android only):

\n \n

For Explorer tests:

\n \n

For Instrumentation:

\n \n

For XCTest and XCTestUI:

\n \n

For UIAutomator:

\n " } }, - "filter": { - "target": "com.amazonaws.devicefarm#Filter", + "type": { + "target": "com.amazonaws.devicefarm#TestType", "traits": { - "smithy.api#documentation": "

The test's filter.

" + "smithy.api#documentation": "

The test's type.

\n

Must be one of the following values:

\n ", + "smithy.api#required": {} } } }, @@ -7392,28 +7392,28 @@ "com.amazonaws.devicefarm#Suite": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.devicefarm#Message", + "started": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

A message about the suite's result.

" + "smithy.api#documentation": "

The suite's start time.

" } }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "counters": { + "target": "com.amazonaws.devicefarm#Counters", "traits": { - "smithy.api#documentation": "

The suite's ARN.

" + "smithy.api#documentation": "

The suite's result counters.

" } }, - "deviceMinutes": { - "target": "com.amazonaws.devicefarm#DeviceMinutes", + "type": { + "target": "com.amazonaws.devicefarm#TestType", "traits": { - "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the test\n suite.

" + "smithy.api#documentation": "

The suite's type.

\n

Must be one of the following values:

\n " } }, - "created": { - "target": "com.amazonaws.devicefarm#DateTime", + "status": { + "target": "com.amazonaws.devicefarm#ExecutionStatus", "traits": { - "smithy.api#documentation": "

When the suite was created.

" + "smithy.api#documentation": "

The suite's status.

\n

Allowed values include:

\n " } }, "stopped": { @@ -7422,40 +7422,40 @@ "smithy.api#documentation": "

The suite's stop time.

" } }, - "result": { - "target": "com.amazonaws.devicefarm#ExecutionResult", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The suite's result.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

The suite's name.

" } }, - "type": { - "target": "com.amazonaws.devicefarm#TestType", + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The suite's type.

\n

Must be one of the following values:

\n " + "smithy.api#documentation": "

The suite's ARN.

" } }, - "counters": { - "target": "com.amazonaws.devicefarm#Counters", + "result": { + "target": "com.amazonaws.devicefarm#ExecutionResult", "traits": { - "smithy.api#documentation": "

The suite's result counters.

" + "smithy.api#documentation": "

The suite's result.

\n

Allowed values include:

\n " } }, - "status": { - "target": "com.amazonaws.devicefarm#ExecutionStatus", + "message": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The suite's status.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

A message about the suite's result.

" } }, - "started": { - "target": "com.amazonaws.devicefarm#DateTime", + "deviceMinutes": { + "target": "com.amazonaws.devicefarm#DeviceMinutes", "traits": { - "smithy.api#documentation": "

The suite's start time.

" + "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the test\n suite.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "created": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The suite's name.

" + "smithy.api#documentation": "

When the suite was created.

" } } }, @@ -7527,11 +7527,11 @@ "com.amazonaws.devicefarm#TagOperationException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.devicefarm#ExceptionMessage" - }, "resourceName": { "target": "com.amazonaws.devicefarm#AmazonResourceName" + }, + "message": { + "target": "com.amazonaws.devicefarm#ExceptionMessage" } }, "traits": { @@ -7543,11 +7543,11 @@ "com.amazonaws.devicefarm#TagPolicyException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.devicefarm#ExceptionMessage" - }, "resourceName": { "target": "com.amazonaws.devicefarm#AmazonResourceName" + }, + "message": { + "target": "com.amazonaws.devicefarm#ExceptionMessage" } }, "traits": { @@ -7588,17 +7588,17 @@ "com.amazonaws.devicefarm#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.devicefarm#TagList", + "ResourceARN": { + "target": "com.amazonaws.devicefarm#DeviceFarmArn", "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum\n character length of 128 characters. Tag values can have a maximum length of 256 characters.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags\n with the following Device Farm resources: PROJECT, RUN,\n NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE,\n SESSION, DEVICE_POOL, DEVICE, and\n VPCE_CONFIGURATION.

", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.devicefarm#DeviceFarmArn", + "Tags": { + "target": "com.amazonaws.devicefarm#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags\n with the following Device Farm resources: PROJECT, RUN,\n NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE,\n SESSION, DEVICE_POOL, DEVICE, and\n VPCE_CONFIGURATION.

", + "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum\n character length of 128 characters. Tag values can have a maximum length of 256 characters.

", "smithy.api#required": {} } } @@ -7620,52 +7620,46 @@ "com.amazonaws.devicefarm#Test": { "type": "structure", "members": { - "started": { - "target": "com.amazonaws.devicefarm#DateTime", - "traits": { - "smithy.api#documentation": "

The test's start time.

" - } - }, - "status": { - "target": "com.amazonaws.devicefarm#ExecutionStatus", + "result": { + "target": "com.amazonaws.devicefarm#ExecutionResult", "traits": { - "smithy.api#documentation": "

The test's status.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

The test's result.

\n

Allowed values include:

\n " } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "counters": { + "target": "com.amazonaws.devicefarm#Counters", "traits": { - "smithy.api#documentation": "

The test's name.

" + "smithy.api#documentation": "

The test's result counters.

" } }, - "created": { + "started": { "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

When the test was created.

" + "smithy.api#documentation": "

The test's start time.

" } }, - "counters": { - "target": "com.amazonaws.devicefarm#Counters", + "stopped": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The test's result counters.

" + "smithy.api#documentation": "

The test's stop time.

" } }, - "result": { - "target": "com.amazonaws.devicefarm#ExecutionResult", + "message": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The test's result.

\n

Allowed values include:

\n " + "smithy.api#documentation": "

A message about the test's result.

" } }, - "stopped": { - "target": "com.amazonaws.devicefarm#DateTime", + "type": { + "target": "com.amazonaws.devicefarm#TestType", "traits": { - "smithy.api#documentation": "

The test's stop time.

" + "smithy.api#documentation": "

The test's type.

\n

Must be one of the following values:

\n " } }, - "deviceMinutes": { - "target": "com.amazonaws.devicefarm#DeviceMinutes", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the test.

" + "smithy.api#documentation": "

The test's name.

" } }, "arn": { @@ -7674,16 +7668,22 @@ "smithy.api#documentation": "

The test's ARN.

" } }, - "type": { - "target": "com.amazonaws.devicefarm#TestType", + "status": { + "target": "com.amazonaws.devicefarm#ExecutionStatus", "traits": { - "smithy.api#documentation": "

The test's type.

\n

Must be one of the following values:

\n " + "smithy.api#documentation": "

The test's status.

\n

Allowed values include:

\n " } }, - "message": { - "target": "com.amazonaws.devicefarm#Message", + "created": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

A message about the test's result.

" + "smithy.api#documentation": "

When the test was created.

" + } + }, + "deviceMinutes": { + "target": "com.amazonaws.devicefarm#DeviceMinutes", + "traits": { + "smithy.api#documentation": "

Represents the total (metered or unmetered) minutes used by the test.

" } } }, @@ -7694,22 +7694,16 @@ "com.amazonaws.devicefarm#TestGridProject": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.devicefarm#String", + "created": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

A human-readable description for the project.

" + "smithy.api#documentation": "

When the project was created.

" } }, - "name": { + "description": { "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

A human-readable name for the project.

" - } - }, - "created": { - "target": "com.amazonaws.devicefarm#DateTime", - "traits": { - "smithy.api#documentation": "

When the project was created.

" + "smithy.api#documentation": "

A human-readable description for the project.

" } }, "arn": { @@ -7717,6 +7711,12 @@ "traits": { "smithy.api#documentation": "

The ARN for the project.

" } + }, + "name": { + "target": "com.amazonaws.devicefarm#String", + "traits": { + "smithy.api#documentation": "

A human-readable name for the project.

" + } } }, "traits": { @@ -7732,28 +7732,22 @@ "com.amazonaws.devicefarm#TestGridSession": { "type": "structure", "members": { - "created": { - "target": "com.amazonaws.devicefarm#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the session was started.

" - } - }, - "ended": { - "target": "com.amazonaws.devicefarm#DateTime", + "status": { + "target": "com.amazonaws.devicefarm#TestGridSessionStatus", "traits": { - "smithy.api#documentation": "

The time the session ended.

" + "smithy.api#documentation": "

The state of the session.

" } }, - "arn": { - "target": "com.amazonaws.devicefarm#DeviceFarmArn", + "billingMinutes": { + "target": "com.amazonaws.devicefarm#Double", "traits": { - "smithy.api#documentation": "

The ARN of the session.

" + "smithy.api#documentation": "

The number of billed minutes that were used for this session.

" } }, - "status": { - "target": "com.amazonaws.devicefarm#TestGridSessionStatus", + "created": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The state of the session.

" + "smithy.api#documentation": "

The time that the session was started.

" } }, "seleniumProperties": { @@ -7762,10 +7756,16 @@ "smithy.api#documentation": "

A JSON object of options and parameters passed to the Selenium WebDriver.

" } }, - "billingMinutes": { - "target": "com.amazonaws.devicefarm#Double", + "arn": { + "target": "com.amazonaws.devicefarm#DeviceFarmArn", "traits": { - "smithy.api#documentation": "

The number of billed minutes that were used for this session.

" + "smithy.api#documentation": "

The ARN of the session.

" + } + }, + "ended": { + "target": "com.amazonaws.devicefarm#DateTime", + "traits": { + "smithy.api#documentation": "

The time the session ended.

" } } }, @@ -7776,10 +7776,10 @@ "com.amazonaws.devicefarm#TestGridSessionAction": { "type": "structure", "members": { - "statusCode": { + "requestMethod": { "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

HTTP status code returned to the browser when the action was taken.

" + "smithy.api#documentation": "

HTTP method that the browser used to make the request.

" } }, "action": { @@ -7788,22 +7788,22 @@ "smithy.api#documentation": "

The action taken by the session.

" } }, - "started": { - "target": "com.amazonaws.devicefarm#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the session invoked the action.

" - } - }, "duration": { "target": "com.amazonaws.devicefarm#Long", "traits": { "smithy.api#documentation": "

The time, in milliseconds, that the action took to complete in the browser.

" } }, - "requestMethod": { + "statusCode": { "target": "com.amazonaws.devicefarm#String", "traits": { - "smithy.api#documentation": "

HTTP method that the browser used to make the request.

" + "smithy.api#documentation": "

HTTP status code returned to the browser when the action was taken.

" + } + }, + "started": { + "target": "com.amazonaws.devicefarm#DateTime", + "traits": { + "smithy.api#documentation": "

The time that the session invoked the action.

" } } }, @@ -7820,18 +7820,18 @@ "com.amazonaws.devicefarm#TestGridSessionArtifact": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.devicefarm#TestGridSessionArtifactType", - "traits": { - "smithy.api#documentation": "

The kind of artifact.

" - } - }, "filename": { "target": "com.amazonaws.devicefarm#String", "traits": { "smithy.api#documentation": "

The file name of the artifact.

" } }, + "type": { + "target": "com.amazonaws.devicefarm#TestGridSessionArtifactType", + "traits": { + "smithy.api#documentation": "

The kind of artifact.

" + } + }, "url": { "target": "com.amazonaws.devicefarm#String", "traits": { @@ -8027,11 +8027,11 @@ "com.amazonaws.devicefarm#TooManyTagsException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.devicefarm#ExceptionMessage" - }, "resourceName": { "target": "com.amazonaws.devicefarm#AmazonResourceName" + }, + "message": { + "target": "com.amazonaws.devicefarm#ExceptionMessage" } }, "traits": { @@ -8051,16 +8051,16 @@ "com.amazonaws.devicefarm#TrialMinutes": { "type": "structure", "members": { - "total": { + "remaining": { "target": "com.amazonaws.devicefarm#Double", "traits": { - "smithy.api#documentation": "

The total number of free trial minutes that the account started with.

" + "smithy.api#documentation": "

The number of free trial minutes remaining in the account.

" } }, - "remaining": { + "total": { "target": "com.amazonaws.devicefarm#Double", "traits": { - "smithy.api#documentation": "

The number of free trial minutes remaining in the account.

" + "smithy.api#documentation": "

The total number of free trial minutes that the account started with.

" } } }, @@ -8080,17 +8080,17 @@ "com.amazonaws.devicefarm#UniqueProblem": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.devicefarm#Message", - "traits": { - "smithy.api#documentation": "

A message about the unique problems' result.

" - } - }, "problems": { "target": "com.amazonaws.devicefarm#Problems", "traits": { "smithy.api#documentation": "

Information about the problems.

" } + }, + "message": { + "target": "com.amazonaws.devicefarm#Message", + "traits": { + "smithy.api#documentation": "

A message about the unique problems' result.

" + } } }, "traits": { @@ -8138,17 +8138,17 @@ "com.amazonaws.devicefarm#UntagResourceRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.devicefarm#DeviceFarmArn", + "TagKeys": { + "target": "com.amazonaws.devicefarm#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate\n tags with the following Device Farm resources: PROJECT, RUN,\n NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE,\n SESSION, DEVICE_POOL, DEVICE, and\n VPCE_CONFIGURATION.

", + "smithy.api#documentation": "

The keys of the tags to be removed.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.devicefarm#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.devicefarm#DeviceFarmArn", "traits": { - "smithy.api#documentation": "

The keys of the tags to be removed.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate\n tags with the following Device Farm resources: PROJECT, RUN,\n NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE,\n SESSION, DEVICE_POOL, DEVICE, and\n VPCE_CONFIGURATION.

", "smithy.api#required": {} } } @@ -8248,29 +8248,17 @@ "com.amazonaws.devicefarm#UpdateDevicePoolRequest": { "type": "structure", "members": { - "maxDevices": { - "target": "com.amazonaws.devicefarm#Integer", + "clearMaxDevices": { + "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds\n devices that are available and that meet the criteria that you assign for the\n rules parameter. Depending on how many devices meet these constraints,\n your device pool might contain fewer devices than the value for this parameter.

\n

By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.

\n

If you use this parameter in your request, you cannot use the\n clearMaxDevices parameter in the same request.

" + "smithy.api#documentation": "

Sets whether the maxDevices parameter applies to your device pool. If you set this parameter\n to true, the maxDevices parameter does not apply, and Device Farm does not limit\n the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices\n that meet the criteria specified in the rules parameter.

\n

If you use this parameter in your request, you cannot use the maxDevices\n parameter in the same request.

" } }, "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Device Farm device pool to update.

", - "smithy.api#required": {} - } - }, - "rules": { - "target": "com.amazonaws.devicefarm#Rules", - "traits": { - "smithy.api#documentation": "

Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for\n your request, the update replaces the existing rules.

" - } - }, - "clearMaxDevices": { - "target": "com.amazonaws.devicefarm#Boolean", + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Sets whether the maxDevices parameter applies to your device pool. If you set this parameter\n to true, the maxDevices parameter does not apply, and Device Farm does not limit\n the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices\n that meet the criteria specified in the rules parameter.

\n

If you use this parameter in your request, you cannot use the maxDevices\n parameter in the same request.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Device Farm device pool to update.

", + "smithy.api#required": {} } }, "name": { @@ -8284,6 +8272,18 @@ "traits": { "smithy.api#documentation": "

A description of the device pool to update.

" } + }, + "maxDevices": { + "target": "com.amazonaws.devicefarm#Integer", + "traits": { + "smithy.api#documentation": "

The number of devices that Device Farm can add to your device pool. Device Farm adds\n devices that are available and that meet the criteria that you assign for the\n rules parameter. Depending on how many devices meet these constraints,\n your device pool might contain fewer devices than the value for this parameter.

\n

By specifying the maximum number of devices, you can control the costs that you incur\n by running tests.

\n

If you use this parameter in your request, you cannot use the\n clearMaxDevices parameter in the same request.

" + } + }, + "rules": { + "target": "com.amazonaws.devicefarm#Rules", + "traits": { + "smithy.api#documentation": "

Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for\n your request, the update replaces the existing rules.

" + } } }, "traits": { @@ -8339,10 +8339,10 @@ "smithy.api#documentation": "

An array of strings that specifies the list of app packages that should not be cleaned up from the device\n after a test run is over.

\n

The list of packages is only considered if you set packageCleanup to\n true.

" } }, - "rebootAfterUse": { - "target": "com.amazonaws.devicefarm#Boolean", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The updated choice for whether you want to reboot the device after use. The default\n value is true.

" + "smithy.api#documentation": "

The updated name for your instance profile.

" } }, "arn": { @@ -8352,22 +8352,22 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "description": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The updated name for your instance profile.

" + "smithy.api#documentation": "

The updated description for your instance profile.

" } }, - "packageCleanup": { + "rebootAfterUse": { "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

The updated choice for whether you want to specify package cleanup. The default value\n is false for private devices.

" + "smithy.api#documentation": "

The updated choice for whether you want to reboot the device after use. The default\n value is true.

" } }, - "description": { - "target": "com.amazonaws.devicefarm#Message", + "packageCleanup": { + "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

The updated description for your instance profile.

" + "smithy.api#documentation": "

The updated choice for whether you want to specify package cleanup. The default value\n is false for private devices.

" } } } @@ -8412,77 +8412,77 @@ "com.amazonaws.devicefarm#UpdateNetworkProfileRequest": { "type": "structure", "members": { - "downlinkLossPercent": { - "target": "com.amazonaws.devicefarm#PercentInteger", + "uplinkBandwidthBits": { + "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" + "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" } }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "description": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to update network\n profile settings.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the network profile about which you are returning\n information.

" } }, - "uplinkDelayMs": { - "target": "com.amazonaws.devicefarm#Long", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" + "smithy.api#documentation": "

The name of the network profile about which you are returning\n information.

" } }, - "description": { - "target": "com.amazonaws.devicefarm#Message", + "uplinkLossPercent": { + "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { - "smithy.api#documentation": "

The description of the network profile about which you are returning\n information.

" + "smithy.api#documentation": "

Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.

" } }, - "downlinkJitterMs": { + "uplinkJitterMs": { "target": "com.amazonaws.devicefarm#Long", "traits": { "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" } }, - "downlinkBandwidthBits": { + "downlinkDelayMs": { "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" + "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" } }, - "uplinkJitterMs": { - "target": "com.amazonaws.devicefarm#Long", + "downlinkLossPercent": { + "target": "com.amazonaws.devicefarm#PercentInteger", "traits": { - "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" + "smithy.api#documentation": "

Proportion of received packets that fail to arrive from 0 to 100 percent.

" } }, - "uplinkLossPercent": { - "target": "com.amazonaws.devicefarm#PercentInteger", + "downlinkBandwidthBits": { + "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

Proportion of transmitted packets that fail to arrive from 0 to 100\n percent.

" + "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" } }, - "type": { - "target": "com.amazonaws.devicefarm#NetworkProfileType", + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The type of network profile to return information about. Valid values are listed here.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project for which you want to update network\n profile settings.

", + "smithy.api#required": {} } }, - "downlinkDelayMs": { + "downlinkJitterMs": { "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" + "smithy.api#documentation": "

Time variation in the delay of received packets in milliseconds as an integer from\n 0 to 2000.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "uplinkDelayMs": { + "target": "com.amazonaws.devicefarm#Long", "traits": { - "smithy.api#documentation": "

The name of the network profile about which you are returning\n information.

" + "smithy.api#documentation": "

Delay time for all packets to destination in milliseconds as an integer from 0 to\n 2000.

" } }, - "uplinkBandwidthBits": { - "target": "com.amazonaws.devicefarm#Long", + "type": { + "target": "com.amazonaws.devicefarm#NetworkProfileType", "traits": { - "smithy.api#documentation": "

The data throughput rate in bits per second, as an integer from 0 to\n 104857600.

" + "smithy.api#documentation": "

The type of network profile to return information about. Valid values are listed here.

" } } } @@ -8533,18 +8533,18 @@ "smithy.api#documentation": "

The number of minutes a test run in the project executes before it times out.

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", - "traits": { - "smithy.api#documentation": "

A string that represents the new name of the project that you are updating.

" - } - }, "arn": { "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project whose name to update.

", "smithy.api#required": {} } + }, + "name": { + "target": "com.amazonaws.devicefarm#Name", + "traits": { + "smithy.api#documentation": "

A string that represents the new name of the project that you are updating.

" + } } }, "traits": { @@ -8598,17 +8598,17 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.devicefarm#ResourceDescription", - "traits": { - "smithy.api#documentation": "

Human-readable description for the project.

" - } - }, "name": { "target": "com.amazonaws.devicefarm#ResourceName", "traits": { "smithy.api#documentation": "

Human-readable name for the project.

" } + }, + "description": { + "target": "com.amazonaws.devicefarm#ResourceDescription", + "traits": { + "smithy.api#documentation": "

Human-readable description for the project.

" + } } } }, @@ -8652,16 +8652,16 @@ "com.amazonaws.devicefarm#UpdateUploadRequest": { "type": "structure", "members": { - "editContent": { - "target": "com.amazonaws.devicefarm#Boolean", + "contentType": { + "target": "com.amazonaws.devicefarm#ContentType", "traits": { - "smithy.api#documentation": "

Set to true if the YAML file has changed and must be updated. Otherwise, set to false.

" + "smithy.api#documentation": "

The upload's content type (for example, application/x-yaml).

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "editContent": { + "target": "com.amazonaws.devicefarm#Boolean", "traits": { - "smithy.api#documentation": "

The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file\n name must end with the .yaml or .yml file extension.

" + "smithy.api#documentation": "

Set to true if the YAML file has changed and must be updated. Otherwise, set to false.

" } }, "arn": { @@ -8671,10 +8671,10 @@ "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.devicefarm#ContentType", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

The upload's content type (for example, application/x-yaml).

" + "smithy.api#documentation": "

The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file\n name must end with the .yaml or .yml file extension.

" } } } @@ -8719,17 +8719,10 @@ "com.amazonaws.devicefarm#UpdateVPCEConfigurationRequest": { "type": "structure", "members": { - "vpceConfigurationName": { - "target": "com.amazonaws.devicefarm#VPCEConfigurationName", - "traits": { - "smithy.api#documentation": "

The friendly name you give to your VPC endpoint configuration to manage your configurations more\n easily.

" - } - }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "serviceDnsName": { + "target": "com.amazonaws.devicefarm#ServiceDnsName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to\n update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already\n be in use on the internet.

" } }, "vpceServiceName": { @@ -8738,17 +8731,24 @@ "smithy.api#documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

" } }, - "serviceDnsName": { - "target": "com.amazonaws.devicefarm#ServiceDnsName", - "traits": { - "smithy.api#documentation": "

The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already\n be in use on the internet.

" - } - }, "vpceConfigurationDescription": { "target": "com.amazonaws.devicefarm#VPCEConfigurationDescription", "traits": { "smithy.api#documentation": "

An optional description that provides details about your VPC endpoint configuration.

" } + }, + "vpceConfigurationName": { + "target": "com.amazonaws.devicefarm#VPCEConfigurationName", + "traits": { + "smithy.api#documentation": "

The friendly name you give to your VPC endpoint configuration to manage your configurations more\n easily.

" + } + }, + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to\n update.

", + "smithy.api#required": {} + } } } }, @@ -8766,34 +8766,34 @@ "com.amazonaws.devicefarm#Upload": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.devicefarm#Message", + "name": { + "target": "com.amazonaws.devicefarm#Name", "traits": { - "smithy.api#documentation": "

A message about the upload's result.

" + "smithy.api#documentation": "

The upload's file name.

" } }, - "url": { - "target": "com.amazonaws.devicefarm#URL", + "created": { + "target": "com.amazonaws.devicefarm#DateTime", "traits": { - "smithy.api#documentation": "

The presigned Amazon S3 URL that was used to store a file using a PUT request.

" + "smithy.api#documentation": "

When the upload was created.

" } }, - "category": { - "target": "com.amazonaws.devicefarm#UploadCategory", + "arn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The upload's category. Allowed values include:

\n " + "smithy.api#documentation": "

The upload's ARN.

" } }, - "created": { - "target": "com.amazonaws.devicefarm#DateTime", + "metadata": { + "target": "com.amazonaws.devicefarm#Metadata", "traits": { - "smithy.api#documentation": "

When the upload was created.

" + "smithy.api#documentation": "

The upload's metadata. For example, for Android, this contains information that is\n parsed from the manifest and is displayed in the AWS Device Farm console after the\n associated app is uploaded.

" } }, - "contentType": { - "target": "com.amazonaws.devicefarm#ContentType", + "type": { + "target": "com.amazonaws.devicefarm#UploadType", "traits": { - "smithy.api#documentation": "

The upload's content type (for example, application/octet-stream).

" + "smithy.api#documentation": "

The upload's type.

\n

Must be one of the following values:

\n " } }, "status": { @@ -8802,28 +8802,28 @@ "smithy.api#documentation": "

The upload's status.

\n

Must be one of the following values:

\n " } }, - "type": { - "target": "com.amazonaws.devicefarm#UploadType", + "message": { + "target": "com.amazonaws.devicefarm#Message", "traits": { - "smithy.api#documentation": "

The upload's type.

\n

Must be one of the following values:

\n " + "smithy.api#documentation": "

A message about the upload's result.

" } }, - "metadata": { - "target": "com.amazonaws.devicefarm#Metadata", + "category": { + "target": "com.amazonaws.devicefarm#UploadCategory", "traits": { - "smithy.api#documentation": "

The upload's metadata. For example, for Android, this contains information that is\n parsed from the manifest and is displayed in the AWS Device Farm console after the\n associated app is uploaded.

" + "smithy.api#documentation": "

The upload's category. Allowed values include:

\n " } }, - "arn": { - "target": "com.amazonaws.devicefarm#AmazonResourceName", + "contentType": { + "target": "com.amazonaws.devicefarm#ContentType", "traits": { - "smithy.api#documentation": "

The upload's ARN.

" + "smithy.api#documentation": "

The upload's content type (for example, application/octet-stream).

" } }, - "name": { - "target": "com.amazonaws.devicefarm#Name", + "url": { + "target": "com.amazonaws.devicefarm#URL", "traits": { - "smithy.api#documentation": "

The upload's file name.

" + "smithy.api#documentation": "

The presigned Amazon S3 URL that was used to store a file using a PUT request.

" } } }, @@ -9013,10 +9013,10 @@ "com.amazonaws.devicefarm#VPCEConfiguration": { "type": "structure", "members": { - "serviceDnsName": { - "target": "com.amazonaws.devicefarm#ServiceDnsName", + "vpceServiceName": { + "target": "com.amazonaws.devicefarm#VPCEServiceName", "traits": { - "smithy.api#documentation": "

The DNS name that maps to the private IP address of the service you want to\n access.

" + "smithy.api#documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

" } }, "arn": { @@ -9025,22 +9025,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC endpoint configuration.

" } }, - "vpceConfigurationDescription": { - "target": "com.amazonaws.devicefarm#VPCEConfigurationDescription", - "traits": { - "smithy.api#documentation": "

An optional description that provides details about your VPC endpoint configuration.

" - } - }, "vpceConfigurationName": { "target": "com.amazonaws.devicefarm#VPCEConfigurationName", "traits": { "smithy.api#documentation": "

The friendly name you give to your VPC endpoint configuration to manage your configurations more\n easily.

" } }, - "vpceServiceName": { - "target": "com.amazonaws.devicefarm#VPCEServiceName", + "serviceDnsName": { + "target": "com.amazonaws.devicefarm#ServiceDnsName", "traits": { - "smithy.api#documentation": "

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

" + "smithy.api#documentation": "

The DNS name that maps to the private IP address of the service you want to\n access.

" + } + }, + "vpceConfigurationDescription": { + "target": "com.amazonaws.devicefarm#VPCEConfigurationDescription", + "traits": { + "smithy.api#documentation": "

An optional description that provides details about your VPC endpoint configuration.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json b/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json index 5cd9c54eeaf2..9aaa22f48778 100644 --- a/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json +++ b/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json @@ -55,19 +55,6 @@ "com.amazonaws.directconnect#AcceptDirectConnectGatewayAssociationProposalRequest": { "type": "structure", "members": { - "directConnectGatewayId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway.

", - "smithy.api#required": {} - } - }, - "overrideAllowedPrefixesToDirectConnectGateway": { - "target": "com.amazonaws.directconnect#RouteFilterPrefixList", - "traits": { - "smithy.api#documentation": "

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

\n

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

" - } - }, "associatedGatewayOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { @@ -81,6 +68,19 @@ "smithy.api#documentation": "

The ID of the request proposal.

", "smithy.api#required": {} } + }, + "directConnectGatewayId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the Direct Connect gateway.

", + "smithy.api#required": {} + } + }, + "overrideAllowedPrefixesToDirectConnectGateway": { + "target": "com.amazonaws.directconnect#RouteFilterPrefixList", + "traits": { + "smithy.api#documentation": "

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

\n

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

" + } } } }, @@ -131,10 +131,10 @@ "com.amazonaws.directconnect#AllocateConnectionOnInterconnectRequest": { "type": "structure", "members": { - "connectionName": { - "target": "com.amazonaws.directconnect#ConnectionName", + "ownerAccount": { + "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "

The name of the provisioned connection.

", + "smithy.api#documentation": "

The ID of the AWS account of the customer for whom the connection will be provisioned.

", "smithy.api#required": {} } }, @@ -145,10 +145,10 @@ "smithy.api#required": {} } }, - "bandwidth": { - "target": "com.amazonaws.directconnect#Bandwidth", + "connectionName": { + "target": "com.amazonaws.directconnect#ConnectionName", "traits": { - "smithy.api#documentation": "

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps,\n 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners\n who have met specific requirements\n are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

", + "smithy.api#documentation": "

The name of the provisioned connection.

", "smithy.api#required": {} } }, @@ -159,10 +159,10 @@ "smithy.api#required": {} } }, - "ownerAccount": { - "target": "com.amazonaws.directconnect#OwnerAccount", + "bandwidth": { + "target": "com.amazonaws.directconnect#Bandwidth", "traits": { - "smithy.api#documentation": "

The ID of the AWS account of the customer for whom the connection will be provisioned.

", + "smithy.api#documentation": "

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps,\n 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners\n who have met specific requirements\n are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

", "smithy.api#required": {} } } @@ -217,17 +217,17 @@ "smithy.api#required": {} } }, - "vlan": { - "target": "com.amazonaws.directconnect#VLAN", + "connectionId": { + "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The dedicated VLAN provisioned to the hosted connection.

", + "smithy.api#documentation": "

The ID of the interconnect or LAG.

", "smithy.api#required": {} } }, - "connectionId": { - "target": "com.amazonaws.directconnect#ConnectionId", + "vlan": { + "target": "com.amazonaws.directconnect#VLAN", "traits": { - "smithy.api#documentation": "

The ID of the interconnect or LAG.

", + "smithy.api#documentation": "

The dedicated VLAN provisioned to the hosted connection.

", "smithy.api#required": {} } }, @@ -527,18 +527,18 @@ "com.amazonaws.directconnect#AssociatedGateway": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.directconnect#GatewayType", - "traits": { - "smithy.api#documentation": "

The type of associated gateway.

" - } - }, "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { "smithy.api#documentation": "

The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

" } }, + "type": { + "target": "com.amazonaws.directconnect#GatewayType", + "traits": { + "smithy.api#documentation": "

The type of associated gateway.

" + } + }, "id": { "target": "com.amazonaws.directconnect#GatewayIdentifier", "traits": { @@ -580,34 +580,16 @@ "com.amazonaws.directconnect#BGPPeer": { "type": "structure", "members": { - "customerAddress": { - "target": "com.amazonaws.directconnect#CustomerAddress", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the customer interface.

" - } - }, - "bgpPeerId": { - "target": "com.amazonaws.directconnect#BGPPeerId", - "traits": { - "smithy.api#documentation": "

The ID of the BGP peer.

" - } - }, - "bgpPeerState": { - "target": "com.amazonaws.directconnect#BGPPeerState", - "traits": { - "smithy.api#documentation": "

The state of the BGP peer. The following are the possible values:

\n " - } - }, "authKey": { "target": "com.amazonaws.directconnect#BGPAuthKey", "traits": { "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" } }, - "asn": { - "target": "com.amazonaws.directconnect#ASN", + "amazonAddress": { + "target": "com.amazonaws.directconnect#AmazonAddress", "traits": { - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" } }, "addressFamily": { @@ -616,10 +598,10 @@ "smithy.api#documentation": "

The address family for the BGP peer.

" } }, - "amazonAddress": { - "target": "com.amazonaws.directconnect#AmazonAddress", + "customerAddress": { + "target": "com.amazonaws.directconnect#CustomerAddress", "traits": { - "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" + "smithy.api#documentation": "

The IP address assigned to the customer interface.

" } }, "awsDeviceV2": { @@ -628,11 +610,29 @@ "smithy.api#documentation": "

The Direct Connect endpoint on which the BGP peer terminates.

" } }, + "bgpPeerId": { + "target": "com.amazonaws.directconnect#BGPPeerId", + "traits": { + "smithy.api#documentation": "

The ID of the BGP peer.

" + } + }, + "asn": { + "target": "com.amazonaws.directconnect#ASN", + "traits": { + "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + } + }, "bgpStatus": { "target": "com.amazonaws.directconnect#BGPStatus", "traits": { "smithy.api#documentation": "

The status of the BGP peer. The following are the possible values:

\n " } + }, + "bgpPeerState": { + "target": "com.amazonaws.directconnect#BGPPeerState", + "traits": { + "smithy.api#documentation": "

The state of the BGP peer. The following are the possible values:

\n " + } } }, "traits": { @@ -781,18 +781,18 @@ "smithy.api#documentation": "

The ID of the virtual private gateway.

" } }, + "directConnectGatewayId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" + } + }, "virtualInterfaceId": { "target": "com.amazonaws.directconnect#VirtualInterfaceId", "traits": { "smithy.api#documentation": "

The ID of the virtual interface.

", "smithy.api#required": {} } - }, - "directConnectGatewayId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" - } } } }, @@ -909,16 +909,16 @@ "smithy.api#documentation": "

Indicates whether jumbo frames (9001 MTU) are supported.

" } }, - "awsDeviceV2": { - "target": "com.amazonaws.directconnect#AwsDeviceV2", + "lagId": { + "target": "com.amazonaws.directconnect#LagId", "traits": { - "smithy.api#documentation": "

The Direct Connect endpoint on which the physical connection terminates.

" + "smithy.api#documentation": "

The ID of the LAG.

" } }, - "vlan": { - "target": "com.amazonaws.directconnect#VLAN", + "awsDeviceV2": { + "target": "com.amazonaws.directconnect#AwsDeviceV2", "traits": { - "smithy.api#documentation": "

The ID of the VLAN.

" + "smithy.api#documentation": "

The Direct Connect endpoint on which the physical connection terminates.

" } }, "connectionName": { @@ -933,10 +933,10 @@ "smithy.api#documentation": "

The AWS Region where the connection is located.

" } }, - "lagId": { - "target": "com.amazonaws.directconnect#LagId", + "vlan": { + "target": "com.amazonaws.directconnect#VLAN", "traits": { - "smithy.api#documentation": "

The ID of the LAG.

" + "smithy.api#documentation": "

The ID of the VLAN.

" } }, "connectionId": { @@ -957,24 +957,6 @@ "smithy.api#documentation": "

The ID of the AWS account that owns the connection.

" } }, - "connectionState": { - "target": "com.amazonaws.directconnect#ConnectionState", - "traits": { - "smithy.api#documentation": "

The state of the connection. The following are the possible values:

\n " - } - }, - "awsDevice": { - "target": "com.amazonaws.directconnect#AwsDevice", - "traits": { - "smithy.api#documentation": "

The Direct Connect endpoint on which the physical connection terminates.

" - } - }, - "partnerName": { - "target": "com.amazonaws.directconnect#PartnerName", - "traits": { - "smithy.api#documentation": "

The name of the AWS Direct Connect service provider associated with the connection.

" - } - }, "loaIssueTime": { "target": "com.amazonaws.directconnect#LoaIssueTime", "traits": { @@ -993,10 +975,22 @@ "smithy.api#documentation": "

The name of the service provider associated with the connection.

" } }, - "bandwidth": { - "target": "com.amazonaws.directconnect#Bandwidth", + "partnerName": { + "target": "com.amazonaws.directconnect#PartnerName", "traits": { - "smithy.api#documentation": "

The bandwidth of the connection.

" + "smithy.api#documentation": "

The name of the AWS Direct Connect service provider associated with the connection.

" + } + }, + "awsDevice": { + "target": "com.amazonaws.directconnect#AwsDevice", + "traits": { + "smithy.api#documentation": "

The Direct Connect endpoint on which the physical connection terminates.

" + } + }, + "connectionState": { + "target": "com.amazonaws.directconnect#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection. The following are the possible values:

\n " } }, "location": { @@ -1004,6 +998,12 @@ "traits": { "smithy.api#documentation": "

The location of the connection.

" } + }, + "bandwidth": { + "target": "com.amazonaws.directconnect#Bandwidth", + "traits": { + "smithy.api#documentation": "

The bandwidth of the connection.

" + } } }, "traits": { @@ -1147,10 +1147,11 @@ "com.amazonaws.directconnect#CreateConnectionRequest": { "type": "structure", "members": { - "providerName": { - "target": "com.amazonaws.directconnect#ProviderName", + "location": { + "target": "com.amazonaws.directconnect#LocationCode", "traits": { - "smithy.api#documentation": "

The name of the service provider associated with the requested connection.

" + "smithy.api#documentation": "

The location of the connection.

", + "smithy.api#required": {} } }, "bandwidth": { @@ -1160,13 +1161,6 @@ "smithy.api#required": {} } }, - "location": { - "target": "com.amazonaws.directconnect#LocationCode", - "traits": { - "smithy.api#documentation": "

The location of the connection.

", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.directconnect#TagList", "traits": { @@ -1185,6 +1179,12 @@ "traits": { "smithy.api#documentation": "

The ID of the LAG.

" } + }, + "providerName": { + "target": "com.amazonaws.directconnect#ProviderName", + "traits": { + "smithy.api#documentation": "

The name of the service provider associated with the requested connection.

" + } } } }, @@ -1258,13 +1258,6 @@ "smithy.api#required": {} } }, - "directConnectGatewayId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway.

", - "smithy.api#required": {} - } - }, "addAllowedPrefixesToDirectConnectGateway": { "target": "com.amazonaws.directconnect#RouteFilterPrefixList", "traits": { @@ -1277,6 +1270,13 @@ "smithy.api#documentation": "

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

" } }, + "directConnectGatewayId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the Direct Connect gateway.

", + "smithy.api#required": {} + } + }, "directConnectGatewayOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { @@ -1300,12 +1300,6 @@ "com.amazonaws.directconnect#CreateDirectConnectGatewayAssociationRequest": { "type": "structure", "members": { - "virtualGatewayId": { - "target": "com.amazonaws.directconnect#VirtualGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the virtual private gateway.

" - } - }, "gatewayId": { "target": "com.amazonaws.directconnect#GatewayIdToAssociate", "traits": { @@ -1324,6 +1318,12 @@ "traits": { "smithy.api#documentation": "

The Amazon VPC prefixes to advertise to the Direct Connect gateway

\n

This parameter is required when you create an association to a transit gateway.

\n

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

" } + }, + "virtualGatewayId": { + "target": "com.amazonaws.directconnect#VirtualGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual private gateway.

" + } } } }, @@ -1341,18 +1341,18 @@ "com.amazonaws.directconnect#CreateDirectConnectGatewayRequest": { "type": "structure", "members": { - "amazonSideAsn": { - "target": "com.amazonaws.directconnect#LongAsn", - "traits": { - "smithy.api#documentation": "

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured\n on the Amazon side of the connection. The ASN must be in the private range of 64,512 to\n 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

" - } - }, "directConnectGatewayName": { "target": "com.amazonaws.directconnect#DirectConnectGatewayName", "traits": { "smithy.api#documentation": "

The name of the Direct Connect gateway.

", "smithy.api#required": {} } + }, + "amazonSideAsn": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured\n on the Amazon side of the connection. The ASN must be in the private range of 64,512 to\n 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

" + } } } }, @@ -1409,12 +1409,6 @@ "smithy.api#required": {} } }, - "providerName": { - "target": "com.amazonaws.directconnect#ProviderName", - "traits": { - "smithy.api#documentation": "

The name of the service provider associated with the interconnect.

" - } - }, "interconnectName": { "target": "com.amazonaws.directconnect#InterconnectName", "traits": { @@ -1422,17 +1416,23 @@ "smithy.api#required": {} } }, - "location": { - "target": "com.amazonaws.directconnect#LocationCode", + "tags": { + "target": "com.amazonaws.directconnect#TagList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the interconnect.

" + } + }, + "location": { + "target": "com.amazonaws.directconnect#LocationCode", "traits": { "smithy.api#documentation": "

The location of the interconnect.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.directconnect#TagList", + "providerName": { + "target": "com.amazonaws.directconnect#ProviderName", "traits": { - "smithy.api#documentation": "

The tags to associate with the interconnect.

" + "smithy.api#documentation": "

The name of the service provider associated with the interconnect.

" } } } @@ -1460,7 +1460,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a link aggregation group (LAG) with the specified number of bundled\n physical connections between the customer network and a specific AWS Direct Connect location.\n A LAG is a logical interface that uses the Link Aggregation Control Protocol\n (LACP) to aggregate multiple interfaces, enabling you to treat them as a single \n interface.

\n

All connections in a LAG must use the same bandwidth and must terminate at the same AWS Direct Connect endpoint.

\n

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections \n for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

\n

You can specify an existing physical connection or interconnect to include in the LAG\n (which counts towards the total number of connections). Doing so interrupts the current\n physical connection or hosted connections, and re-establishes them as a member of the\n LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the\n connection terminates. Any virtual interfaces associated with the connection are\n automatically disassociated and re-associated with the LAG. The connection ID does not\n change.

\n

If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is \n automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual \n interfaces cannot be directly configured.

" + "smithy.api#documentation": "

Creates a link aggregation group (LAG) with the specified number of bundled\n physical dedicated connections between the customer network and a specific AWS Direct Connect location.\n A LAG is a logical interface that uses the Link Aggregation Control Protocol\n (LACP) to aggregate multiple interfaces, enabling you to treat them as a single \n interface.

\n

All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same AWS Direct Connect endpoint.

\n

You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you\n request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is\n created.

\n

You can specify an existing physical dedicated connection or interconnect to include in\n the LAG (which counts towards the total number of connections). Doing so interrupts the\n current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG\n will be created on the same AWS Direct Connect endpoint to which the dedicated connection terminates. Any\n virtual interfaces associated with the dedicated connection are automatically disassociated\n and re-associated with the LAG. The connection ID does not change.

\n

If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is \n automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual \n interfaces cannot be directly configured.

" } }, "com.amazonaws.directconnect#CreateLagRequest": { @@ -1469,22 +1469,22 @@ "connectionId": { "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of an existing connection to migrate to the LAG.

" - } - }, - "providerName": { - "target": "com.amazonaws.directconnect#ProviderName", - "traits": { - "smithy.api#documentation": "

The name of the service provider associated with the LAG.

" + "smithy.api#documentation": "

The ID of an existing dedicated connection to migrate to the LAG.

" } }, "numberOfConnections": { "target": "com.amazonaws.directconnect#Count", "traits": { - "smithy.api#documentation": "

The number of physical connections initially provisioned and bundled by the LAG.

", + "smithy.api#documentation": "

The number of physical dedicated connections initially provisioned and bundled by the\n LAG.

", "smithy.api#required": {} } }, + "providerName": { + "target": "com.amazonaws.directconnect#ProviderName", + "traits": { + "smithy.api#documentation": "

The name of the service provider associated with the LAG.

" + } + }, "tags": { "target": "com.amazonaws.directconnect#TagList", "traits": { @@ -1497,17 +1497,10 @@ "smithy.api#documentation": "

The tags to associate with the automtically created LAGs.

" } }, - "location": { - "target": "com.amazonaws.directconnect#LocationCode", - "traits": { - "smithy.api#documentation": "

The location for the LAG.

", - "smithy.api#required": {} - } - }, "connectionsBandwidth": { "target": "com.amazonaws.directconnect#Bandwidth", "traits": { - "smithy.api#documentation": "

The bandwidth of the individual physical connections bundled by the LAG. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps.

", + "smithy.api#documentation": "

The bandwidth of the individual physical dedicated connections bundled by the LAG. The\n possible values are 1Gbps and 10Gbps.

", "smithy.api#required": {} } }, @@ -1517,6 +1510,13 @@ "smithy.api#documentation": "

The name of the LAG.

", "smithy.api#required": {} } + }, + "location": { + "target": "com.amazonaws.directconnect#LocationCode", + "traits": { + "smithy.api#documentation": "

The location for the LAG.

", + "smithy.api#required": {} + } } } }, @@ -1689,18 +1689,6 @@ "com.amazonaws.directconnect#DeleteBGPPeerRequest": { "type": "structure", "members": { - "customerAddress": { - "target": "com.amazonaws.directconnect#CustomerAddress", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the customer interface.

" - } - }, - "asn": { - "target": "com.amazonaws.directconnect#ASN", - "traits": { - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" - } - }, "virtualInterfaceId": { "target": "com.amazonaws.directconnect#VirtualInterfaceId", "traits": { @@ -1712,6 +1700,18 @@ "traits": { "smithy.api#documentation": "

The ID of the BGP peer.

" } + }, + "customerAddress": { + "target": "com.amazonaws.directconnect#CustomerAddress", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the customer interface.

" + } + }, + "asn": { + "target": "com.amazonaws.directconnect#ASN", + "traits": { + "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + } } } }, @@ -2159,6 +2159,12 @@ "com.amazonaws.directconnect#DescribeDirectConnectGatewayAssociationProposalsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", + "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.

\n\t

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" + } + }, "directConnectGatewayId": { "target": "com.amazonaws.directconnect#DirectConnectGatewayId", "traits": { @@ -2171,12 +2177,6 @@ "smithy.api#documentation": "

The ID of the proposal.

" } }, - "maxResults": { - "target": "com.amazonaws.directconnect#MaxResultSetSize", - "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.

\n\t

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" - } - }, "nextToken": { "target": "com.amazonaws.directconnect#PaginationToken", "traits": { @@ -2194,17 +2194,17 @@ "com.amazonaws.directconnect#DescribeDirectConnectGatewayAssociationProposalsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.directconnect#PaginationToken", - "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.

" - } - }, "directConnectGatewayAssociationProposals": { "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationProposalList", "traits": { "smithy.api#documentation": "

Describes the Direct Connect gateway association proposals.

" } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "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.

" + } } } }, @@ -2231,22 +2231,28 @@ "com.amazonaws.directconnect#DescribeDirectConnectGatewayAssociationsRequest": { "type": "structure", "members": { + "directConnectGatewayId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" + } + }, "associationId": { "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationId", "traits": { "smithy.api#documentation": "

The ID of the Direct Connect gateway association.

" } }, - "nextToken": { - "target": "com.amazonaws.directconnect#PaginationToken", + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", "traits": { - "smithy.api#documentation": "

The token provided in the previous call to retrieve the next page.

" + "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.

\n\t

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" } }, - "directConnectGatewayId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" + "smithy.api#documentation": "

The token provided in the previous call to retrieve the next page.

" } }, "associatedGatewayId": { @@ -2255,12 +2261,6 @@ "smithy.api#documentation": "

The ID of the associated gateway.

" } }, - "maxResults": { - "target": "com.amazonaws.directconnect#MaxResultSetSize", - "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.

\n\t

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" - } - }, "virtualGatewayId": { "target": "com.amazonaws.directconnect#VirtualGatewayId", "traits": { @@ -2315,18 +2315,18 @@ "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" } }, - "maxResults": { - "target": "com.amazonaws.directconnect#MaxResultSetSize", - "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.

\n\t

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" - } - }, "nextToken": { "target": "com.amazonaws.directconnect#PaginationToken", "traits": { "smithy.api#documentation": "

The token provided in the previous call to retrieve the next page.

" } }, + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", + "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.

\n\t

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" + } + }, "virtualInterfaceId": { "target": "com.amazonaws.directconnect#VirtualInterfaceId", "traits": { @@ -2585,6 +2585,12 @@ "com.amazonaws.directconnect#DescribeLoaRequest": { "type": "structure", "members": { + "loaContentType": { + "target": "com.amazonaws.directconnect#LoaContentType", + "traits": { + "smithy.api#documentation": "

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

" + } + }, "connectionId": { "target": "com.amazonaws.directconnect#ConnectionId", "traits": { @@ -2597,12 +2603,6 @@ "traits": { "smithy.api#documentation": "

The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the \n LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

" } - }, - "loaContentType": { - "target": "com.amazonaws.directconnect#LoaContentType", - "traits": { - "smithy.api#documentation": "

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

" - } } } }, @@ -2741,6 +2741,18 @@ "smithy.api#documentation": "

The error message if the state of an object failed to advance.

" } }, + "directConnectGatewayId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" + } + }, + "amazonSideAsn": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The autonomous system number (ASN) for the Amazon side of the connection.

" + } + }, "directConnectGatewayName": { "target": "com.amazonaws.directconnect#DirectConnectGatewayName", "traits": { @@ -2753,23 +2765,11 @@ "smithy.api#documentation": "

The state of the Direct Connect gateway. The following are the possible values:

\n " } }, - "amazonSideAsn": { - "target": "com.amazonaws.directconnect#LongAsn", - "traits": { - "smithy.api#documentation": "

The autonomous system number (ASN) for the Amazon side of the connection.

" - } - }, "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { "smithy.api#documentation": "

The ID of the AWS account that owns the Direct Connect gateway.

" } - }, - "directConnectGatewayId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" - } } }, "traits": { @@ -2791,24 +2791,30 @@ "smithy.api#documentation": "

The error message if the state of an object failed to advance.

" } }, - "virtualGatewayOwnerAccount": { - "target": "com.amazonaws.directconnect#OwnerAccount", - "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the virtual private gateway.

" - } - }, "virtualGatewayRegion": { "target": "com.amazonaws.directconnect#VirtualGatewayRegion", "traits": { "smithy.api#documentation": "

The AWS Region where the virtual private gateway is located.

" } }, + "virtualGatewayOwnerAccount": { + "target": "com.amazonaws.directconnect#OwnerAccount", + "traits": { + "smithy.api#documentation": "

The ID of the AWS account that owns the virtual private gateway.

" + } + }, "allowedPrefixesToDirectConnectGateway": { "target": "com.amazonaws.directconnect#RouteFilterPrefixList", "traits": { "smithy.api#documentation": "

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

" } }, + "directConnectGatewayOwnerAccount": { + "target": "com.amazonaws.directconnect#OwnerAccount", + "traits": { + "smithy.api#documentation": "

The ID of the AWS account that owns the associated gateway.

" + } + }, "virtualGatewayId": { "target": "com.amazonaws.directconnect#VirtualGatewayId", "traits": { @@ -2821,10 +2827,10 @@ "smithy.api#documentation": "

Information about the associated gateway.

" } }, - "directConnectGatewayOwnerAccount": { - "target": "com.amazonaws.directconnect#OwnerAccount", + "associationId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the associated gateway.

" + "smithy.api#documentation": "

The ID of the Direct Connect gateway association.

" } }, "directConnectGatewayId": { @@ -2832,12 +2838,6 @@ "traits": { "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" } - }, - "associationId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationId", - "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway association.

" - } } }, "traits": { @@ -2856,12 +2856,6 @@ "com.amazonaws.directconnect#DirectConnectGatewayAssociationProposal": { "type": "structure", "members": { - "proposalState": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationProposalState", - "traits": { - "smithy.api#documentation": "

The state of the proposal. The following are possible values:

\n " - } - }, "requestedAllowedPrefixesToDirectConnectGateway": { "target": "com.amazonaws.directconnect#RouteFilterPrefixList", "traits": { @@ -2874,10 +2868,10 @@ "smithy.api#documentation": "

The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

" } }, - "proposalId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationProposalId", + "directConnectGatewayOwnerAccount": { + "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "

The ID of the association proposal.

" + "smithy.api#documentation": "

The ID of the AWS account that owns the Direct Connect gateway.

" } }, "directConnectGatewayId": { @@ -2886,16 +2880,22 @@ "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" } }, - "associatedGateway": { - "target": "com.amazonaws.directconnect#AssociatedGateway", + "proposalId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationProposalId", "traits": { - "smithy.api#documentation": "

Information about the associated gateway.

" + "smithy.api#documentation": "

The ID of the association proposal.

" } }, - "directConnectGatewayOwnerAccount": { - "target": "com.amazonaws.directconnect#OwnerAccount", + "proposalState": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationProposalState", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the Direct Connect gateway.

" + "smithy.api#documentation": "

The state of the proposal. The following are possible values:

\n " + } + }, + "associatedGateway": { + "target": "com.amazonaws.directconnect#AssociatedGateway", + "traits": { + "smithy.api#documentation": "

Information about the associated gateway.

" } } }, @@ -2953,10 +2953,10 @@ "com.amazonaws.directconnect#DirectConnectGatewayAttachment": { "type": "structure", "members": { - "stateChangeError": { - "target": "com.amazonaws.directconnect#StateChangeError", + "virtualInterfaceId": { + "target": "com.amazonaws.directconnect#VirtualInterfaceId", "traits": { - "smithy.api#documentation": "

The error message if the state of an object failed to advance.

" + "smithy.api#documentation": "

The ID of the virtual interface.

" } }, "virtualInterfaceOwnerAccount": { @@ -2971,10 +2971,10 @@ "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" } }, - "virtualInterfaceId": { - "target": "com.amazonaws.directconnect#VirtualInterfaceId", + "attachmentType": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayAttachmentType", "traits": { - "smithy.api#documentation": "

The ID of the virtual interface.

" + "smithy.api#documentation": "

The type of attachment.

" } }, "attachmentState": { @@ -2983,16 +2983,16 @@ "smithy.api#documentation": "

The state of the attachment. The following are the possible values:

\n " } }, - "virtualInterfaceRegion": { - "target": "com.amazonaws.directconnect#VirtualInterfaceRegion", + "stateChangeError": { + "target": "com.amazonaws.directconnect#StateChangeError", "traits": { - "smithy.api#documentation": "

The AWS Region where the virtual interface is located.

" + "smithy.api#documentation": "

The error message if the state of an object failed to advance.

" } }, - "attachmentType": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayAttachmentType", + "virtualInterfaceRegion": { + "target": "com.amazonaws.directconnect#VirtualInterfaceRegion", "traits": { - "smithy.api#documentation": "

The type of attachment.

" + "smithy.api#documentation": "

The AWS Region where the virtual interface is located.

" } } }, @@ -3184,40 +3184,40 @@ "com.amazonaws.directconnect#Interconnect": { "type": "structure", "members": { - "interconnectId": { - "target": "com.amazonaws.directconnect#InterconnectId", - "traits": { - "smithy.api#documentation": "

The ID of the interconnect.

" - } - }, "bandwidth": { "target": "com.amazonaws.directconnect#Bandwidth", "traits": { "smithy.api#documentation": "

The bandwidth of the connection.

" } }, - "hasLogicalRedundancy": { - "target": "com.amazonaws.directconnect#HasLogicalRedundancy", + "awsDevice": { + "target": "com.amazonaws.directconnect#AwsDevice", "traits": { - "smithy.api#documentation": "

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

" + "smithy.api#documentation": "

The Direct Connect endpoint on which the physical connection terminates.

" } }, - "providerName": { - "target": "com.amazonaws.directconnect#ProviderName", + "interconnectId": { + "target": "com.amazonaws.directconnect#InterconnectId", "traits": { - "smithy.api#documentation": "

The name of the service provider associated with the interconnect.

" + "smithy.api#documentation": "

The ID of the interconnect.

" } }, - "interconnectState": { - "target": "com.amazonaws.directconnect#InterconnectState", + "hasLogicalRedundancy": { + "target": "com.amazonaws.directconnect#HasLogicalRedundancy", "traits": { - "smithy.api#documentation": "

The state of the interconnect. The following are the possible values:

\n " + "smithy.api#documentation": "

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

" } }, - "tags": { - "target": "com.amazonaws.directconnect#TagList", + "providerName": { + "target": "com.amazonaws.directconnect#ProviderName", "traits": { - "smithy.api#documentation": "

The tags associated with the interconnect.

" + "smithy.api#documentation": "

The name of the service provider associated with the interconnect.

" + } + }, + "loaIssueTime": { + "target": "com.amazonaws.directconnect#LoaIssueTime", + "traits": { + "smithy.api#documentation": "

The time of the most recent call to DescribeLoa for this connection.

" } }, "jumboFrameCapable": { @@ -3226,22 +3226,22 @@ "smithy.api#documentation": "

Indicates whether jumbo frames (9001 MTU) are supported.

" } }, - "loaIssueTime": { - "target": "com.amazonaws.directconnect#LoaIssueTime", + "tags": { + "target": "com.amazonaws.directconnect#TagList", "traits": { - "smithy.api#documentation": "

The time of the most recent call to DescribeLoa for this connection.

" + "smithy.api#documentation": "

The tags associated with the interconnect.

" } }, - "lagId": { - "target": "com.amazonaws.directconnect#LagId", + "interconnectState": { + "target": "com.amazonaws.directconnect#InterconnectState", "traits": { - "smithy.api#documentation": "

The ID of the LAG.

" + "smithy.api#documentation": "

The state of the interconnect. The following are the possible values:

\n " } }, - "awsDevice": { - "target": "com.amazonaws.directconnect#AwsDevice", + "lagId": { + "target": "com.amazonaws.directconnect#LagId", "traits": { - "smithy.api#documentation": "

The Direct Connect endpoint on which the physical connection terminates.

" + "smithy.api#documentation": "

The ID of the LAG.

" } }, "region": { @@ -3333,6 +3333,12 @@ "com.amazonaws.directconnect#Lag": { "type": "structure", "members": { + "lagState": { + "target": "com.amazonaws.directconnect#LagState", + "traits": { + "smithy.api#documentation": "

The state of the LAG. The following are the possible values:

\n " + } + }, "providerName": { "target": "com.amazonaws.directconnect#ProviderName", "traits": { @@ -3345,28 +3351,22 @@ "smithy.api#documentation": "

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

" } }, - "awsDeviceV2": { - "target": "com.amazonaws.directconnect#AwsDeviceV2", - "traits": { - "smithy.api#documentation": "

The AWS Direct Connect endpoint that hosts the LAG.

" - } - }, - "awsDevice": { - "target": "com.amazonaws.directconnect#AwsDevice", - "traits": { - "smithy.api#documentation": "

The AWS Direct Connect endpoint that hosts the LAG.

" - } - }, "lagId": { "target": "com.amazonaws.directconnect#LagId", "traits": { "smithy.api#documentation": "

The ID of the LAG.

" } }, - "lagState": { - "target": "com.amazonaws.directconnect#LagState", + "allowsHostedConnections": { + "target": "com.amazonaws.directconnect#BooleanFlag", "traits": { - "smithy.api#documentation": "

The state of the LAG. The following are the possible values:

\n " + "smithy.api#documentation": "

Indicates whether the LAG can host other connections.

" + } + }, + "awsDeviceV2": { + "target": "com.amazonaws.directconnect#AwsDeviceV2", + "traits": { + "smithy.api#documentation": "

The AWS Direct Connect endpoint that hosts the LAG.

" } }, "jumboFrameCapable": { @@ -3375,22 +3375,22 @@ "smithy.api#documentation": "

Indicates whether jumbo frames (9001 MTU) are supported.

" } }, - "allowsHostedConnections": { - "target": "com.amazonaws.directconnect#BooleanFlag", + "awsDevice": { + "target": "com.amazonaws.directconnect#AwsDevice", "traits": { - "smithy.api#documentation": "

Indicates whether the LAG can host other connections.

" + "smithy.api#documentation": "

The AWS Direct Connect endpoint that hosts the LAG.

" } }, - "connectionsBandwidth": { - "target": "com.amazonaws.directconnect#Bandwidth", + "lagName": { + "target": "com.amazonaws.directconnect#LagName", "traits": { - "smithy.api#documentation": "

The individual bandwidth of the physical connections bundled by the LAG. The possible\n values are 1Gbps and 10Gbps.

" + "smithy.api#documentation": "

The name of the LAG.

" } }, - "tags": { - "target": "com.amazonaws.directconnect#TagList", + "connectionsBandwidth": { + "target": "com.amazonaws.directconnect#Bandwidth", "traits": { - "smithy.api#documentation": "

The tags associated with the LAG.

" + "smithy.api#documentation": "

The individual bandwidth of the physical connections bundled by the LAG. The possible\n values are 1Gbps and 10Gbps.

" } }, "location": { @@ -3399,16 +3399,16 @@ "smithy.api#documentation": "

The location of the LAG.

" } }, - "lagName": { - "target": "com.amazonaws.directconnect#LagName", + "connections": { + "target": "com.amazonaws.directconnect#ConnectionList", "traits": { - "smithy.api#documentation": "

The name of the LAG.

" + "smithy.api#documentation": "

The connections bundled by the LAG.

" } }, - "numberOfConnections": { - "target": "com.amazonaws.directconnect#Count", + "tags": { + "target": "com.amazonaws.directconnect#TagList", "traits": { - "smithy.api#documentation": "

The number of physical connections bundled by the LAG, up to a maximum of 10.

" + "smithy.api#documentation": "

The tags associated with the LAG.

" } }, "ownerAccount": { @@ -3417,10 +3417,10 @@ "smithy.api#documentation": "

The ID of the AWS account that owns the LAG.

" } }, - "connections": { - "target": "com.amazonaws.directconnect#ConnectionList", + "numberOfConnections": { + "target": "com.amazonaws.directconnect#Count", "traits": { - "smithy.api#documentation": "

The connections bundled by the LAG.

" + "smithy.api#documentation": "

The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.

" } }, "region": { @@ -3432,7 +3432,7 @@ "minimumLinks": { "target": "com.amazonaws.directconnect#Count", "traits": { - "smithy.api#documentation": "

The minimum number of physical connections that must be operational for the LAG itself to be operational.

" + "smithy.api#documentation": "

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

" } } }, @@ -3520,22 +3520,16 @@ "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.

\n\t

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" } }, - "nextToken": { - "target": "com.amazonaws.directconnect#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "testId": { "target": "com.amazonaws.directconnect#TestId", "traits": { "smithy.api#documentation": "

The ID of the virtual interface failover test.

" } }, - "status": { - "target": "com.amazonaws.directconnect#FailureTestHistoryStatus", + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", "traits": { - "smithy.api#documentation": "

The status of the virtual interface failover test.

" + "smithy.api#documentation": "

The token for the next page of results.

" } }, "bgpPeers": { @@ -3544,6 +3538,12 @@ "smithy.api#documentation": "

The BGP peers that were placed in the DOWN state during the virtual interface failover test.

" } }, + "status": { + "target": "com.amazonaws.directconnect#FailureTestHistoryStatus", + "traits": { + "smithy.api#documentation": "

The status of the virtual interface failover test.

" + } + }, "virtualInterfaceId": { "target": "com.amazonaws.directconnect#VirtualInterfaceId", "traits": { @@ -3615,6 +3615,12 @@ "smithy.api#documentation": "

The name of the service provider for the location.

" } }, + "region": { + "target": "com.amazonaws.directconnect#Region", + "traits": { + "smithy.api#documentation": "

The AWS Region for the location.

" + } + }, "availablePortSpeeds": { "target": "com.amazonaws.directconnect#AvailablePortSpeeds", "traits": { @@ -3627,12 +3633,6 @@ "smithy.api#documentation": "

The name of the location. This includes the name of the colocation partner and the physical site of the building.

" } }, - "region": { - "target": "com.amazonaws.directconnect#Region", - "traits": { - "smithy.api#documentation": "

The AWS Region for the location.

" - } - }, "locationCode": { "target": "com.amazonaws.directconnect#LocationCode", "traits": { @@ -3700,18 +3700,18 @@ "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" } }, - "asn": { - "target": "com.amazonaws.directconnect#ASN", - "traits": { - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" - } - }, "amazonAddress": { "target": "com.amazonaws.directconnect#AmazonAddress", "traits": { "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" } }, + "asn": { + "target": "com.amazonaws.directconnect#ASN", + "traits": { + "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + } + }, "addressFamily": { "target": "com.amazonaws.directconnect#AddressFamily", "traits": { @@ -3726,12 +3726,6 @@ "com.amazonaws.directconnect#NewPrivateVirtualInterface": { "type": "structure", "members": { - "authKey": { - "target": "com.amazonaws.directconnect#BGPAuthKey", - "traits": { - "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" - } - }, "virtualInterfaceName": { "target": "com.amazonaws.directconnect#VirtualInterfaceName", "traits": { @@ -3739,29 +3733,28 @@ "smithy.api#required": {} } }, - "virtualGatewayId": { - "target": "com.amazonaws.directconnect#VirtualGatewayId", + "amazonAddress": { + "target": "com.amazonaws.directconnect#AmazonAddress", "traits": { - "smithy.api#documentation": "

The ID of the virtual private gateway.

" + "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" } }, - "directConnectGatewayId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "addressFamily": { + "target": "com.amazonaws.directconnect#AddressFamily", "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" + "smithy.api#documentation": "

The address family for the BGP peer.

" } }, - "vlan": { - "target": "com.amazonaws.directconnect#VLAN", + "virtualGatewayId": { + "target": "com.amazonaws.directconnect#VirtualGatewayId", "traits": { - "smithy.api#documentation": "

The ID of the VLAN.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the virtual private gateway.

" } }, - "mtu": { - "target": "com.amazonaws.directconnect#MTU", + "directConnectGatewayId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayId", "traits": { - "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" } }, "asn": { @@ -3771,10 +3764,11 @@ "smithy.api#required": {} } }, - "addressFamily": { - "target": "com.amazonaws.directconnect#AddressFamily", + "vlan": { + "target": "com.amazonaws.directconnect#VLAN", "traits": { - "smithy.api#documentation": "

The address family for the BGP peer.

" + "smithy.api#documentation": "

The ID of the VLAN.

", + "smithy.api#required": {} } }, "customerAddress": { @@ -3783,16 +3777,22 @@ "smithy.api#documentation": "

The IP address assigned to the customer interface.

" } }, - "tags": { - "target": "com.amazonaws.directconnect#TagList", + "mtu": { + "target": "com.amazonaws.directconnect#MTU", "traits": { - "smithy.api#documentation": "

The tags associated with the private virtual interface.

" + "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" } }, - "amazonAddress": { - "target": "com.amazonaws.directconnect#AmazonAddress", + "authKey": { + "target": "com.amazonaws.directconnect#BGPAuthKey", "traits": { - "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" + "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + } + }, + "tags": { + "target": "com.amazonaws.directconnect#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the private virtual interface.

" } } }, @@ -3809,11 +3809,10 @@ "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" } }, - "vlan": { - "target": "com.amazonaws.directconnect#VLAN", + "authKey": { + "target": "com.amazonaws.directconnect#BGPAuthKey", "traits": { - "smithy.api#documentation": "

The ID of the VLAN.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" } }, "asn": { @@ -3823,10 +3822,10 @@ "smithy.api#required": {} } }, - "authKey": { - "target": "com.amazonaws.directconnect#BGPAuthKey", + "amazonAddress": { + "target": "com.amazonaws.directconnect#AmazonAddress", "traits": { - "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" } }, "customerAddress": { @@ -3841,24 +3840,25 @@ "smithy.api#documentation": "

The address family for the BGP peer.

" } }, - "virtualInterfaceName": { - "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "vlan": { + "target": "com.amazonaws.directconnect#VLAN", "traits": { - "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", + "smithy.api#documentation": "

The ID of the VLAN.

", "smithy.api#required": {} } }, - "amazonAddress": { - "target": "com.amazonaws.directconnect#AmazonAddress", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" - } - }, "tags": { "target": "com.amazonaws.directconnect#TagList", "traits": { "smithy.api#documentation": "

The tags associated with the private virtual interface.

" } + }, + "virtualInterfaceName": { + "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "traits": { + "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", + "smithy.api#required": {} + } } }, "traits": { @@ -3881,6 +3881,12 @@ "smithy.api#documentation": "

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

" } }, + "amazonAddress": { + "target": "com.amazonaws.directconnect#AmazonAddress", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" + } + }, "virtualInterfaceName": { "target": "com.amazonaws.directconnect#VirtualInterfaceName", "traits": { @@ -3888,18 +3894,6 @@ "smithy.api#required": {} } }, - "customerAddress": { - "target": "com.amazonaws.directconnect#CustomerAddress", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the customer interface.

" - } - }, - "tags": { - "target": "com.amazonaws.directconnect#TagList", - "traits": { - "smithy.api#documentation": "

The tags associated with the public virtual interface.

" - } - }, "addressFamily": { "target": "com.amazonaws.directconnect#AddressFamily", "traits": { @@ -3912,10 +3906,16 @@ "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" } }, - "amazonAddress": { - "target": "com.amazonaws.directconnect#AmazonAddress", + "tags": { + "target": "com.amazonaws.directconnect#TagList", "traits": { - "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" + "smithy.api#documentation": "

The tags associated with the public virtual interface.

" + } + }, + "customerAddress": { + "target": "com.amazonaws.directconnect#CustomerAddress", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the customer interface.

" } }, "vlan": { @@ -3939,6 +3939,12 @@ "smithy.api#documentation": "

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

" } }, + "customerAddress": { + "target": "com.amazonaws.directconnect#CustomerAddress", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the customer interface.

" + } + }, "vlan": { "target": "com.amazonaws.directconnect#VLAN", "traits": { @@ -3946,17 +3952,17 @@ "smithy.api#required": {} } }, - "amazonAddress": { - "target": "com.amazonaws.directconnect#AmazonAddress", + "asn": { + "target": "com.amazonaws.directconnect#ASN", "traits": { - "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" + "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

", + "smithy.api#required": {} } }, - "virtualInterfaceName": { - "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "addressFamily": { + "target": "com.amazonaws.directconnect#AddressFamily", "traits": { - "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The address family for the BGP peer.

" } }, "tags": { @@ -3965,10 +3971,11 @@ "smithy.api#documentation": "

The tags associated with the public virtual interface.

" } }, - "customerAddress": { - "target": "com.amazonaws.directconnect#CustomerAddress", + "virtualInterfaceName": { + "target": "com.amazonaws.directconnect#VirtualInterfaceName", "traits": { - "smithy.api#documentation": "

The IP address assigned to the customer interface.

" + "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

", + "smithy.api#required": {} } }, "authKey": { @@ -3977,17 +3984,10 @@ "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" } }, - "asn": { - "target": "com.amazonaws.directconnect#ASN", - "traits": { - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

", - "smithy.api#required": {} - } - }, - "addressFamily": { - "target": "com.amazonaws.directconnect#AddressFamily", + "amazonAddress": { + "target": "com.amazonaws.directconnect#AmazonAddress", "traits": { - "smithy.api#documentation": "

The address family for the BGP peer.

" + "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" } } }, @@ -3998,22 +3998,22 @@ "com.amazonaws.directconnect#NewTransitVirtualInterface": { "type": "structure", "members": { - "authKey": { - "target": "com.amazonaws.directconnect#BGPAuthKey", + "customerAddress": { + "target": "com.amazonaws.directconnect#CustomerAddress", "traits": { - "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + "smithy.api#documentation": "

The IP address assigned to the customer interface.

" } }, - "customerAddress": { - "target": "com.amazonaws.directconnect#CustomerAddress", + "authKey": { + "target": "com.amazonaws.directconnect#BGPAuthKey", "traits": { - "smithy.api#documentation": "

The IP address assigned to the customer interface.

" + "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" } }, - "vlan": { - "target": "com.amazonaws.directconnect#VLAN", + "amazonAddress": { + "target": "com.amazonaws.directconnect#AmazonAddress", "traits": { - "smithy.api#documentation": "

The ID of the VLAN.

" + "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" } }, "addressFamily": { @@ -4022,10 +4022,10 @@ "smithy.api#documentation": "

The address family for the BGP peer.

" } }, - "virtualInterfaceName": { - "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "vlan": { + "target": "com.amazonaws.directconnect#VLAN", "traits": { - "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

" + "smithy.api#documentation": "

The ID of the VLAN.

" } }, "asn": { @@ -4034,29 +4034,29 @@ "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" } }, - "amazonAddress": { - "target": "com.amazonaws.directconnect#AmazonAddress", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" - } - }, "tags": { "target": "com.amazonaws.directconnect#TagList", "traits": { "smithy.api#documentation": "

The tags associated with the transitive virtual interface.

" } }, - "mtu": { - "target": "com.amazonaws.directconnect#MTU", - "traits": { - "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" - } - }, "directConnectGatewayId": { "target": "com.amazonaws.directconnect#DirectConnectGatewayId", "traits": { "smithy.api#documentation": "

The ID of the Direct Connect gateway.

" } + }, + "virtualInterfaceName": { + "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "traits": { + "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

" + } + }, + "mtu": { + "target": "com.amazonaws.directconnect#MTU", + "traits": { + "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + } } }, "traits": { @@ -4066,36 +4066,18 @@ "com.amazonaws.directconnect#NewTransitVirtualInterfaceAllocation": { "type": "structure", "members": { - "addressFamily": { - "target": "com.amazonaws.directconnect#AddressFamily", - "traits": { - "smithy.api#documentation": "

The address family for the BGP peer.

" - } - }, "tags": { "target": "com.amazonaws.directconnect#TagList", "traits": { "smithy.api#documentation": "

The tags associated with the transitive virtual interface.

" } }, - "amazonAddress": { - "target": "com.amazonaws.directconnect#AmazonAddress", - "traits": { - "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" - } - }, "virtualInterfaceName": { "target": "com.amazonaws.directconnect#VirtualInterfaceName", "traits": { "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

" } }, - "asn": { - "target": "com.amazonaws.directconnect#ASN", - "traits": { - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" - } - }, "vlan": { "target": "com.amazonaws.directconnect#VLAN", "traits": { @@ -4108,16 +4090,34 @@ "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" } }, + "authKey": { + "target": "com.amazonaws.directconnect#BGPAuthKey", + "traits": { + "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + } + }, + "asn": { + "target": "com.amazonaws.directconnect#ASN", + "traits": { + "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" + } + }, + "amazonAddress": { + "target": "com.amazonaws.directconnect#AmazonAddress", + "traits": { + "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" + } + }, "customerAddress": { "target": "com.amazonaws.directconnect#CustomerAddress", "traits": { "smithy.api#documentation": "

The IP address assigned to the customer interface.

" } }, - "authKey": { - "target": "com.amazonaws.directconnect#BGPAuthKey", + "addressFamily": { + "target": "com.amazonaws.directconnect#AddressFamily", "traits": { - "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + "smithy.api#documentation": "

The address family for the BGP peer.

" } } }, @@ -4505,18 +4505,18 @@ "com.amazonaws.directconnect#Tag": { "type": "structure", "members": { + "value": { + "target": "com.amazonaws.directconnect#TagValue", + "traits": { + "smithy.api#documentation": "

The value.

" + } + }, "key": { "target": "com.amazonaws.directconnect#TagKey", "traits": { "smithy.api#documentation": "

The key.

", "smithy.api#required": {} } - }, - "value": { - "target": "com.amazonaws.directconnect#TagValue", - "traits": { - "smithy.api#documentation": "

The value.

" - } } }, "traits": { @@ -4702,17 +4702,17 @@ "smithy.api#documentation": "

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

" } }, - "associationId": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationId", - "traits": { - "smithy.api#documentation": "

The ID of the Direct Connect gateway association.

" - } - }, "addAllowedPrefixesToDirectConnectGateway": { "target": "com.amazonaws.directconnect#RouteFilterPrefixList", "traits": { "smithy.api#documentation": "

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

" } + }, + "associationId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociationId", + "traits": { + "smithy.api#documentation": "

The ID of the Direct Connect gateway association.

" + } } } }, @@ -4812,17 +4812,17 @@ "com.amazonaws.directconnect#VirtualGateway": { "type": "structure", "members": { - "virtualGatewayId": { - "target": "com.amazonaws.directconnect#VirtualGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the virtual private gateway.

" - } - }, "virtualGatewayState": { "target": "com.amazonaws.directconnect#VirtualGatewayState", "traits": { "smithy.api#documentation": "

The state of the virtual private gateway. The following are the possible values:

\n " } + }, + "virtualGatewayId": { + "target": "com.amazonaws.directconnect#VirtualGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual private gateway.

" + } } }, "traits": { @@ -4861,22 +4861,16 @@ "com.amazonaws.directconnect#VirtualInterface": { "type": "structure", "members": { - "connectionId": { - "target": "com.amazonaws.directconnect#ConnectionId", - "traits": { - "smithy.api#documentation": "

The ID of the connection.

" - } - }, "bgpPeers": { "target": "com.amazonaws.directconnect#BGPPeerList", "traits": { "smithy.api#documentation": "

The BGP peers configured on this virtual interface.

" } }, - "virtualInterfaceState": { - "target": "com.amazonaws.directconnect#VirtualInterfaceState", + "connectionId": { + "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The state of the virtual interface. The following are the possible values:

\n " + "smithy.api#documentation": "

The ID of the connection.

" } }, "virtualInterfaceType": { @@ -4891,16 +4885,10 @@ "smithy.api#documentation": "

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

" } }, - "authKey": { - "target": "com.amazonaws.directconnect#BGPAuthKey", - "traits": { - "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" - } - }, - "awsDeviceV2": { - "target": "com.amazonaws.directconnect#AwsDeviceV2", + "jumboFrameCapable": { + "target": "com.amazonaws.directconnect#JumboFrameCapable", "traits": { - "smithy.api#documentation": "

The\n Direct Connect endpoint on which the virtual interface terminates.

" + "smithy.api#documentation": "

Indicates whether jumbo frames (9001 MTU) are supported.

" } }, "tags": { @@ -4909,22 +4897,28 @@ "smithy.api#documentation": "

The tags associated with the virtual interface.

" } }, - "jumboFrameCapable": { - "target": "com.amazonaws.directconnect#JumboFrameCapable", - "traits": { - "smithy.api#documentation": "

Indicates whether jumbo frames (9001 MTU) are supported.

" - } - }, "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { "smithy.api#documentation": "

The ID of the AWS account that owns the virtual interface.

" } }, - "mtu": { - "target": "com.amazonaws.directconnect#MTU", + "virtualInterfaceState": { + "target": "com.amazonaws.directconnect#VirtualInterfaceState", "traits": { - "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + "smithy.api#documentation": "

The state of the virtual interface. The following are the possible values:

\n " + } + }, + "awsDeviceV2": { + "target": "com.amazonaws.directconnect#AwsDeviceV2", + "traits": { + "smithy.api#documentation": "

The\n Direct Connect endpoint on which the virtual interface terminates.

" + } + }, + "authKey": { + "target": "com.amazonaws.directconnect#BGPAuthKey", + "traits": { + "smithy.api#documentation": "

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" } }, "customerAddress": { @@ -4933,6 +4927,18 @@ "smithy.api#documentation": "

The IP address assigned to the customer interface.

" } }, + "vlan": { + "target": "com.amazonaws.directconnect#VLAN", + "traits": { + "smithy.api#documentation": "

The ID of the VLAN.

" + } + }, + "mtu": { + "target": "com.amazonaws.directconnect#MTU", + "traits": { + "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + } + }, "directConnectGatewayId": { "target": "com.amazonaws.directconnect#DirectConnectGatewayId", "traits": { @@ -4951,46 +4957,40 @@ "smithy.api#documentation": "

The location of the connection.

" } }, - "virtualInterfaceId": { - "target": "com.amazonaws.directconnect#VirtualInterfaceId", - "traits": { - "smithy.api#documentation": "

The ID of the virtual interface.

" - } - }, - "amazonSideAsn": { - "target": "com.amazonaws.directconnect#LongAsn", - "traits": { - "smithy.api#documentation": "

The autonomous system number (ASN) for the Amazon side of the connection.

" - } - }, "amazonAddress": { "target": "com.amazonaws.directconnect#AmazonAddress", "traits": { "smithy.api#documentation": "

The IP address assigned to the Amazon interface.

" } }, + "virtualInterfaceName": { + "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "traits": { + "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

" + } + }, "virtualGatewayId": { "target": "com.amazonaws.directconnect#VirtualGatewayId", "traits": { "smithy.api#documentation": "

The ID of the virtual private gateway. Applies only to private virtual interfaces.

" } }, - "virtualInterfaceName": { - "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "amazonSideAsn": { + "target": "com.amazonaws.directconnect#LongAsn", "traits": { - "smithy.api#documentation": "

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

" + "smithy.api#documentation": "

The autonomous system number (ASN) for the Amazon side of the connection.

" } }, - "vlan": { - "target": "com.amazonaws.directconnect#VLAN", + "virtualInterfaceId": { + "target": "com.amazonaws.directconnect#VirtualInterfaceId", "traits": { - "smithy.api#documentation": "

The ID of the VLAN.

" + "smithy.api#documentation": "

The ID of the virtual interface.

" } }, - "asn": { - "target": "com.amazonaws.directconnect#ASN", + "region": { + "target": "com.amazonaws.directconnect#Region", "traits": { - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" + "smithy.api#documentation": "

The AWS Region where the virtual interface is located.

" } }, "addressFamily": { @@ -4999,10 +4999,10 @@ "smithy.api#documentation": "

The address family for the BGP peer.

" } }, - "region": { - "target": "com.amazonaws.directconnect#Region", + "asn": { + "target": "com.amazonaws.directconnect#ASN", "traits": { - "smithy.api#documentation": "

The AWS Region where the virtual interface is located.

" + "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" } } }, @@ -5062,10 +5062,10 @@ "com.amazonaws.directconnect#VirtualInterfaceTestHistory": { "type": "structure", "members": { - "testId": { - "target": "com.amazonaws.directconnect#TestId", + "status": { + "target": "com.amazonaws.directconnect#FailureTestHistoryStatus", "traits": { - "smithy.api#documentation": "

The ID of the virtual interface failover test.

" + "smithy.api#documentation": "

The status of the virtual interface failover test.

" } }, "ownerAccount": { @@ -5074,40 +5074,40 @@ "smithy.api#documentation": "

The owner ID of the tested virtual interface.

" } }, - "status": { - "target": "com.amazonaws.directconnect#FailureTestHistoryStatus", - "traits": { - "smithy.api#documentation": "

The status of the virtual interface failover test.

" - } - }, "endTime": { "target": "com.amazonaws.directconnect#EndTime", "traits": { "smithy.api#documentation": "

The time that the virtual interface moves out of the DOWN state.

" } }, + "virtualInterfaceId": { + "target": "com.amazonaws.directconnect#VirtualInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the tested virtual interface.

" + } + }, "bgpPeers": { "target": "com.amazonaws.directconnect#BGPPeerIdList", "traits": { "smithy.api#documentation": "

The BGP peers that were put in the DOWN state as part of the virtual interface failover test.

" } }, - "startTime": { - "target": "com.amazonaws.directconnect#StartTime", + "testDurationInMinutes": { + "target": "com.amazonaws.directconnect#TestDuration", "traits": { - "smithy.api#documentation": "

The time that the virtual interface moves to the DOWN state.

" + "smithy.api#documentation": "

The time that the virtual interface failover test ran in minutes.

" } }, - "virtualInterfaceId": { - "target": "com.amazonaws.directconnect#VirtualInterfaceId", + "testId": { + "target": "com.amazonaws.directconnect#TestId", "traits": { - "smithy.api#documentation": "

The ID of the tested virtual interface.

" + "smithy.api#documentation": "

The ID of the virtual interface failover test.

" } }, - "testDurationInMinutes": { - "target": "com.amazonaws.directconnect#TestDuration", + "startTime": { + "target": "com.amazonaws.directconnect#StartTime", "traits": { - "smithy.api#documentation": "

The time that the virtual interface failover test ran in minutes.

" + "smithy.api#documentation": "

The time that the virtual interface moves to the DOWN state.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json b/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json index fd4b7f532ca8..d89aba84ceb3 100644 --- a/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json +++ b/codegen/sdk-codegen/aws-models/directory-service.2015-04-16.json @@ -143,6 +143,12 @@ "com.amazonaws.directoryservice#AddIpRoutesRequest": { "type": "structure", "members": { + "UpdateSecurityGroupForDirectoryControllers": { + "target": "com.amazonaws.directoryservice#UpdateSecurityGroupForDirectoryControllers", + "traits": { + "smithy.api#documentation": "

If set to true, updates the inbound and outbound rules of the security group that has the description: \"AWS created security group for directory ID directory controllers.\"\n Following are the new rules:\n

\n

Inbound:

\n \n \n

\n

Outbound:

\n \n

These security rules impact an internal network interface that is not exposed publicly.

" + } + }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { @@ -156,12 +162,6 @@ "smithy.api#documentation": "

IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

", "smithy.api#required": {} } - }, - "UpdateSecurityGroupForDirectoryControllers": { - "target": "com.amazonaws.directoryservice#UpdateSecurityGroupForDirectoryControllers", - "traits": { - "smithy.api#documentation": "

If set to true, updates the inbound and outbound rules of the security group that has the description: \"AWS created security group for directory ID directory controllers.\"\n Following are the new rules:\n

\n

Inbound:

\n \n \n

\n

Outbound:

\n \n

These security rules impact an internal network interface that is not exposed publicly.

" - } } } }, @@ -201,17 +201,17 @@ "com.amazonaws.directoryservice#AddTagsToResourceRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.directoryservice#ResourceId", + "Tags": { + "target": "com.amazonaws.directoryservice#Tags", "traits": { - "smithy.api#documentation": "

Identifier (ID) for the directory to which to add the tag.

", + "smithy.api#documentation": "

The tags to be assigned to the directory.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.directoryservice#Tags", + "ResourceId": { + "target": "com.amazonaws.directoryservice#ResourceId", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the directory.

", + "smithy.api#documentation": "

Identifier (ID) for the directory to which to add the tag.

", "smithy.api#required": {} } } @@ -237,17 +237,17 @@ "com.amazonaws.directoryservice#Attribute": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.directoryservice#AttributeName", - "traits": { - "smithy.api#documentation": "

The name of the attribute.

" - } - }, "Value": { "target": "com.amazonaws.directoryservice#AttributeValue", "traits": { "smithy.api#documentation": "

The value of the attribute.

" } + }, + "Name": { + "target": "com.amazonaws.directoryservice#AttributeName", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

" + } } }, "traits": { @@ -327,17 +327,17 @@ "com.amazonaws.directoryservice#CancelSchemaExtensionRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "SchemaExtensionId": { + "target": "com.amazonaws.directoryservice#SchemaExtensionId", "traits": { - "smithy.api#documentation": "

The identifier of the directory whose schema extension will be canceled.

", + "smithy.api#documentation": "

The identifier of the schema extension that will be canceled.

", "smithy.api#required": {} } }, - "SchemaExtensionId": { - "target": "com.amazonaws.directoryservice#SchemaExtensionId", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the schema extension that will be canceled.

", + "smithy.api#documentation": "

The identifier of the directory whose schema extension will be canceled.

", "smithy.api#required": {} } } @@ -350,10 +350,10 @@ "com.amazonaws.directoryservice#Certificate": { "type": "structure", "members": { - "CommonName": { - "target": "com.amazonaws.directoryservice#CertificateCN", + "RegisteredDateTime": { + "target": "com.amazonaws.directoryservice#CertificateRegisteredDateTime", "traits": { - "smithy.api#documentation": "

The common name for the certificate.

" + "smithy.api#documentation": "

The date and time that the certificate was registered.

" } }, "CertificateId": { @@ -362,16 +362,16 @@ "smithy.api#documentation": "

The identifier of the certificate.

" } }, - "State": { - "target": "com.amazonaws.directoryservice#CertificateState", + "CommonName": { + "target": "com.amazonaws.directoryservice#CertificateCN", "traits": { - "smithy.api#documentation": "

The state of the certificate.

" + "smithy.api#documentation": "

The common name for the certificate.

" } }, - "ExpiryDateTime": { - "target": "com.amazonaws.directoryservice#CertificateExpiryDateTime", + "State": { + "target": "com.amazonaws.directoryservice#CertificateState", "traits": { - "smithy.api#documentation": "

The date and time when the certificate will expire.

" + "smithy.api#documentation": "

The state of the certificate.

" } }, "StateReason": { @@ -380,10 +380,10 @@ "smithy.api#documentation": "

Describes a state change for the certificate.

" } }, - "RegisteredDateTime": { - "target": "com.amazonaws.directoryservice#CertificateRegisteredDateTime", + "ExpiryDateTime": { + "target": "com.amazonaws.directoryservice#CertificateExpiryDateTime", "traits": { - "smithy.api#documentation": "

The date and time that the certificate was registered.

" + "smithy.api#documentation": "

The date and time when the certificate will expire.

" } } }, @@ -394,11 +394,11 @@ "com.amazonaws.directoryservice#CertificateAlreadyExistsException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -460,12 +460,6 @@ "com.amazonaws.directoryservice#CertificateInfo": { "type": "structure", "members": { - "ExpiryDateTime": { - "target": "com.amazonaws.directoryservice#CertificateExpiryDateTime", - "traits": { - "smithy.api#documentation": "

The date and time when the certificate will expire.

" - } - }, "CertificateId": { "target": "com.amazonaws.directoryservice#CertificateId", "traits": { @@ -483,6 +477,12 @@ "traits": { "smithy.api#documentation": "

The state of the certificate.

" } + }, + "ExpiryDateTime": { + "target": "com.amazonaws.directoryservice#CertificateExpiryDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the certificate will expire.

" + } } }, "traits": { @@ -586,17 +586,17 @@ "smithy.api#documentation": "

The identifier of the computer.

" } }, - "ComputerAttributes": { - "target": "com.amazonaws.directoryservice#Attributes", - "traits": { - "smithy.api#documentation": "

An array of Attribute objects containing the LDAP attributes that belong to the\n computer account.

" - } - }, "ComputerName": { "target": "com.amazonaws.directoryservice#ComputerName", "traits": { "smithy.api#documentation": "

The computer name.

" } + }, + "ComputerAttributes": { + "target": "com.amazonaws.directoryservice#Attributes", + "traits": { + "smithy.api#documentation": "

An array of Attribute objects containing the LDAP attributes that belong to the\n computer account.

" + } } }, "traits": { @@ -626,6 +626,12 @@ "com.amazonaws.directoryservice#ConditionalForwarder": { "type": "structure", "members": { + "ReplicationScope": { + "target": "com.amazonaws.directoryservice#ReplicationScope", + "traits": { + "smithy.api#documentation": "

The replication scope of the conditional forwarder. The only allowed value is\n Domain, which will replicate the conditional forwarder to all of the\n domain controllers for your AWS directory.

" + } + }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { @@ -637,12 +643,6 @@ "traits": { "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

" } - }, - "ReplicationScope": { - "target": "com.amazonaws.directoryservice#ReplicationScope", - "traits": { - "smithy.api#documentation": "

The replication scope of the conditional forwarder. The only allowed value is\n Domain, which will replicate the conditional forwarder to all of the\n domain controllers for your AWS directory.

" - } } }, "traits": { @@ -684,31 +684,29 @@ "com.amazonaws.directoryservice#ConnectDirectoryRequest": { "type": "structure", "members": { - "Password": { - "target": "com.amazonaws.directoryservice#ConnectPassword", + "Tags": { + "target": "com.amazonaws.directoryservice#Tags", "traits": { - "smithy.api#documentation": "

The password for the on-premises user account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to be assigned to AD Connector.

" } }, - "Size": { - "target": "com.amazonaws.directoryservice#DirectorySize", + "ConnectSettings": { + "target": "com.amazonaws.directoryservice#DirectoryConnectSettings", "traits": { - "smithy.api#documentation": "

The size of the directory.

", + "smithy.api#documentation": "

A DirectoryConnectSettings object that contains additional information for the\n operation.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.directoryservice#DirectoryName", + "Description": { + "target": "com.amazonaws.directoryservice#Description", "traits": { - "smithy.api#documentation": "

The fully qualified name of the on-premises directory, such as\n corp.example.com.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the directory.

" } }, - "ConnectSettings": { - "target": "com.amazonaws.directoryservice#DirectoryConnectSettings", + "Size": { + "target": "com.amazonaws.directoryservice#DirectorySize", "traits": { - "smithy.api#documentation": "

A DirectoryConnectSettings object that contains additional information for the\n operation.

", + "smithy.api#documentation": "

The size of the directory.

", "smithy.api#required": {} } }, @@ -718,16 +716,18 @@ "smithy.api#documentation": "

The NetBIOS name of the on-premises directory, such as CORP.

" } }, - "Tags": { - "target": "com.amazonaws.directoryservice#Tags", + "Password": { + "target": "com.amazonaws.directoryservice#ConnectPassword", "traits": { - "smithy.api#documentation": "

The tags to be assigned to AD Connector.

" + "smithy.api#documentation": "

The password for the on-premises user account.

", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.directoryservice#Description", + "Name": { + "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { - "smithy.api#documentation": "

A description for the directory.

" + "smithy.api#documentation": "

The fully qualified name of the on-premises directory, such as\n corp.example.com.

", + "smithy.api#required": {} } } }, @@ -794,17 +794,17 @@ "com.amazonaws.directoryservice#CreateAliasRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "Alias": { + "target": "com.amazonaws.directoryservice#AliasName", "traits": { - "smithy.api#documentation": "

The identifier of the directory for which to create the alias.

", + "smithy.api#documentation": "

The requested alias.

\n

The alias must be unique amongst all aliases in AWS. This operation throws an\n EntityAlreadyExistsException error if the alias already exists.

", "smithy.api#required": {} } }, - "Alias": { - "target": "com.amazonaws.directoryservice#AliasName", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The requested alias.

\n

The alias must be unique amongst all aliases in AWS. This operation throws an\n EntityAlreadyExistsException error if the alias already exists.

", + "smithy.api#documentation": "

The identifier of the directory for which to create the alias.

", "smithy.api#required": {} } } @@ -816,17 +816,17 @@ "com.amazonaws.directoryservice#CreateAliasResult": { "type": "structure", "members": { - "Alias": { - "target": "com.amazonaws.directoryservice#AliasName", - "traits": { - "smithy.api#documentation": "

The alias for the directory.

" - } - }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

" } + }, + "Alias": { + "target": "com.amazonaws.directoryservice#AliasName", + "traits": { + "smithy.api#documentation": "

The alias for the directory.

" + } } }, "traits": { @@ -874,17 +874,23 @@ "com.amazonaws.directoryservice#CreateComputerRequest": { "type": "structure", "members": { - "OrganizationalUnitDistinguishedName": { - "target": "com.amazonaws.directoryservice#OrganizationalUnitDN", + "Password": { + "target": "com.amazonaws.directoryservice#ComputerPassword", "traits": { - "smithy.api#documentation": "

The fully-qualified distinguished name of the organizational unit to place the computer account in.

" + "smithy.api#documentation": "

A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

", + "smithy.api#required": {} } }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "ComputerAttributes": { + "target": "com.amazonaws.directoryservice#Attributes", "traits": { - "smithy.api#documentation": "

The identifier of the directory in which to create the computer account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of Attribute objects that contain any LDAP attributes to apply to the\n computer account.

" + } + }, + "OrganizationalUnitDistinguishedName": { + "target": "com.amazonaws.directoryservice#OrganizationalUnitDN", + "traits": { + "smithy.api#documentation": "

The fully-qualified distinguished name of the organizational unit to place the computer account in.

" } }, "ComputerName": { @@ -894,18 +900,12 @@ "smithy.api#required": {} } }, - "Password": { - "target": "com.amazonaws.directoryservice#ComputerPassword", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

", + "smithy.api#documentation": "

The identifier of the directory in which to create the computer account.

", "smithy.api#required": {} } - }, - "ComputerAttributes": { - "target": "com.amazonaws.directoryservice#Attributes", - "traits": { - "smithy.api#documentation": "

An array of Attribute objects that contain any LDAP attributes to apply to the\n computer account.

" - } } }, "traits": { @@ -964,10 +964,10 @@ "com.amazonaws.directoryservice#CreateConditionalForwarderRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "RemoteDomainName": { + "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The directory ID of the AWS directory for which you are creating the conditional forwarder.

", + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

", "smithy.api#required": {} } }, @@ -978,10 +978,10 @@ "smithy.api#required": {} } }, - "RemoteDomainName": { - "target": "com.amazonaws.directoryservice#RemoteDomainName", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

", + "smithy.api#documentation": "

The directory ID of the AWS directory for which you are creating the conditional forwarder.

", "smithy.api#required": {} } } @@ -1026,30 +1026,29 @@ "com.amazonaws.directoryservice#CreateDirectoryRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.directoryservice#Description", + "Password": { + "target": "com.amazonaws.directoryservice#Password", "traits": { - "smithy.api#documentation": "

A description for the directory.

" + "smithy.api#documentation": "

The password for the directory administrator. The directory creation process creates\n a directory administrator account with the user name Administrator and this\n password.

\n

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

", + "smithy.api#required": {} } }, - "Size": { - "target": "com.amazonaws.directoryservice#DirectorySize", + "ShortName": { + "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { - "smithy.api#documentation": "

The size of the directory.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The NetBIOS name of the directory, such as CORP.

" } }, - "Name": { - "target": "com.amazonaws.directoryservice#DirectoryName", + "Tags": { + "target": "com.amazonaws.directoryservice#Tags", "traits": { - "smithy.api#documentation": "

The fully qualified name for the directory, such as corp.example.com.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to be assigned to the Simple AD directory.

" } }, - "Password": { - "target": "com.amazonaws.directoryservice#Password", + "Name": { + "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { - "smithy.api#documentation": "

The password for the directory administrator. The directory creation process creates\n a directory administrator account with the user name Administrator and this\n password.

\n

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

", + "smithy.api#documentation": "

The fully qualified name for the directory, such as corp.example.com.

", "smithy.api#required": {} } }, @@ -1059,16 +1058,17 @@ "smithy.api#documentation": "

A DirectoryVpcSettings object that contains additional information for the\n operation.

" } }, - "ShortName": { - "target": "com.amazonaws.directoryservice#DirectoryShortName", + "Description": { + "target": "com.amazonaws.directoryservice#Description", "traits": { - "smithy.api#documentation": "

The NetBIOS name of the directory, such as CORP.

" + "smithy.api#documentation": "

A description for the directory.

" } }, - "Tags": { - "target": "com.amazonaws.directoryservice#Tags", + "Size": { + "target": "com.amazonaws.directoryservice#DirectorySize", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the Simple AD directory.

" + "smithy.api#documentation": "

The size of the directory.

", + "smithy.api#required": {} } } }, @@ -1125,17 +1125,17 @@ "com.amazonaws.directoryservice#CreateLogSubscriptionRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "LogGroupName": { + "target": "com.amazonaws.directoryservice#LogGroupName", "traits": { - "smithy.api#documentation": "

Identifier of the directory to which you want to subscribe and receive real-time logs\n to your specified CloudWatch log group.

", + "smithy.api#documentation": "

The name of the CloudWatch log group where the real-time domain controller logs are forwarded.

", "smithy.api#required": {} } }, - "LogGroupName": { - "target": "com.amazonaws.directoryservice#LogGroupName", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch log group where the real-time domain controller logs are forwarded.

", + "smithy.api#documentation": "

Identifier of the directory to which you want to subscribe and receive real-time logs\n to your specified CloudWatch log group.

", "smithy.api#required": {} } } @@ -1177,50 +1177,50 @@ "com.amazonaws.directoryservice#CreateMicrosoftADRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.directoryservice#Tags", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the AWS Managed Microsoft AD directory.

" - } - }, "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { "smithy.api#documentation": "

A description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

" } }, - "Name": { - "target": "com.amazonaws.directoryservice#DirectoryName", + "ShortName": { + "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { - "smithy.api#documentation": "

The fully qualified domain name for the AWS Managed Microsoft AD directory, such as\n corp.example.com. This name will resolve inside your VPC only. It does not need\n to be publicly resolvable.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

" } }, - "Password": { - "target": "com.amazonaws.directoryservice#Password", + "VpcSettings": { + "target": "com.amazonaws.directoryservice#DirectoryVpcSettings", "traits": { - "smithy.api#documentation": "

The password for the default administrative user named Admin.

\n

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

", + "smithy.api#documentation": "

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

", "smithy.api#required": {} } }, - "Edition": { - "target": "com.amazonaws.directoryservice#DirectoryEdition", + "Tags": { + "target": "com.amazonaws.directoryservice#Tags", "traits": { - "smithy.api#documentation": "

AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

" + "smithy.api#documentation": "

The tags to be assigned to the AWS Managed Microsoft AD directory.

" } }, - "ShortName": { - "target": "com.amazonaws.directoryservice#DirectoryShortName", + "Password": { + "target": "com.amazonaws.directoryservice#Password", "traits": { - "smithy.api#documentation": "

The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

" + "smithy.api#documentation": "

The password for the default administrative user named Admin.

\n

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

", + "smithy.api#required": {} } }, - "VpcSettings": { - "target": "com.amazonaws.directoryservice#DirectoryVpcSettings", + "Name": { + "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { - "smithy.api#documentation": "

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

", + "smithy.api#documentation": "

The fully qualified domain name for the AWS Managed Microsoft AD directory, such as\n corp.example.com. This name will resolve inside your VPC only. It does not need\n to be publicly resolvable.

", "smithy.api#required": {} } + }, + "Edition": { + "target": "com.amazonaws.directoryservice#DirectoryEdition", + "traits": { + "smithy.api#documentation": "

AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

" + } } }, "traits": { @@ -1343,18 +1343,10 @@ "com.amazonaws.directoryservice#CreateTrustRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.

", - "smithy.api#required": {} - } - }, - "RemoteDomainName": { - "target": "com.amazonaws.directoryservice#RemoteDomainName", + "TrustType": { + "target": "com.amazonaws.directoryservice#TrustType", "traits": { - "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The trust relationship type. Forest is the default.

" } }, "SelectiveAuth": { @@ -1363,16 +1355,10 @@ "smithy.api#documentation": "

Optional parameter to enable selective authentication for the trust.

" } }, - "TrustType": { - "target": "com.amazonaws.directoryservice#TrustType", - "traits": { - "smithy.api#documentation": "

The trust relationship type. Forest is the default.

" - } - }, - "TrustDirection": { - "target": "com.amazonaws.directoryservice#TrustDirection", + "RemoteDomainName": { + "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The direction of the trust relationship.

", + "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

", "smithy.api#required": {} } }, @@ -1388,6 +1374,20 @@ "smithy.api#documentation": "

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

", "smithy.api#required": {} } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.

", + "smithy.api#required": {} + } + }, + "TrustDirection": { + "target": "com.amazonaws.directoryservice#TrustDirection", + "traits": { + "smithy.api#documentation": "

The direction of the trust relationship.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1465,17 +1465,17 @@ "com.amazonaws.directoryservice#DeleteConditionalForwarderRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "RemoteDomainName": { + "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The directory ID for which you are deleting the conditional forwarder.

", + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

", "smithy.api#required": {} } }, - "RemoteDomainName": { - "target": "com.amazonaws.directoryservice#RemoteDomainName", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

", + "smithy.api#documentation": "

The directory ID for which you are deleting the conditional forwarder.

", "smithy.api#required": {} } } @@ -1672,18 +1672,18 @@ "com.amazonaws.directoryservice#DeleteTrustRequest": { "type": "structure", "members": { - "DeleteAssociatedConditionalForwarder": { - "target": "com.amazonaws.directoryservice#DeleteAssociatedConditionalForwarder", - "traits": { - "smithy.api#documentation": "

Delete a conditional forwarder as part of a DeleteTrustRequest.

" - } - }, "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

The Trust ID of the trust relationship to be deleted.

", "smithy.api#required": {} } + }, + "DeleteAssociatedConditionalForwarder": { + "target": "com.amazonaws.directoryservice#DeleteAssociatedConditionalForwarder", + "traits": { + "smithy.api#documentation": "

Delete a conditional forwarder as part of a DeleteTrustRequest.

" + } } }, "traits": { @@ -1855,17 +1855,17 @@ "com.amazonaws.directoryservice#DescribeCertificateRequest": { "type": "structure", "members": { - "CertificateId": { - "target": "com.amazonaws.directoryservice#CertificateId", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the certificate.

", + "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "CertificateId": { + "target": "com.amazonaws.directoryservice#CertificateId", "traits": { - "smithy.api#documentation": "

The identifier of the directory.

", + "smithy.api#documentation": "

The identifier of the certificate.

", "smithy.api#required": {} } } @@ -1917,18 +1917,18 @@ "com.amazonaws.directoryservice#DescribeConditionalForwardersRequest": { "type": "structure", "members": { - "RemoteDomainNames": { - "target": "com.amazonaws.directoryservice#RemoteDomainNames", - "traits": { - "smithy.api#documentation": "

The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

" - } - }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The directory ID for which to get the list of associated conditional forwarders.

", "smithy.api#required": {} } + }, + "RemoteDomainNames": { + "target": "com.amazonaws.directoryservice#RemoteDomainNames", + "traits": { + "smithy.api#documentation": "

The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

" + } } }, "traits": { @@ -1981,10 +1981,10 @@ "com.amazonaws.directoryservice#DescribeDirectoriesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", + "DirectoryIds": { + "target": "com.amazonaws.directoryservice#DirectoryIds", "traits": { - "smithy.api#documentation": "

The DescribeDirectoriesResult.NextToken value from a previous call to\n DescribeDirectories. Pass null if this is the first call.

" + "smithy.api#documentation": "

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" } }, "Limit": { @@ -1993,10 +1993,10 @@ "smithy.api#documentation": "

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

" } }, - "DirectoryIds": { - "target": "com.amazonaws.directoryservice#DirectoryIds", + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" + "smithy.api#documentation": "

The DescribeDirectoriesResult.NextToken value from a previous call to\n DescribeDirectories. Pass null if this is the first call.

" } } }, @@ -2007,17 +2007,17 @@ "com.amazonaws.directoryservice#DescribeDirectoriesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", - "traits": { - "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter\n in a subsequent call to DescribeDirectories to retrieve the next set of items.

" - } - }, "DirectoryDescriptions": { "target": "com.amazonaws.directoryservice#DirectoryDescriptions", "traits": { "smithy.api#documentation": "

The list of DirectoryDescription objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter\n in a subsequent call to DescribeDirectories to retrieve the next set of items.

" + } } }, "traits": { @@ -2064,12 +2064,6 @@ "com.amazonaws.directoryservice#DescribeDomainControllersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", - "traits": { - "smithy.api#documentation": "

The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

" - } - }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { @@ -2088,23 +2082,29 @@ "traits": { "smithy.api#documentation": "

The maximum number of items to return.

" } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

" + } } } }, "com.amazonaws.directoryservice#DescribeDomainControllersResult": { "type": "structure", "members": { - "DomainControllers": { - "target": "com.amazonaws.directoryservice#DomainControllers", - "traits": { - "smithy.api#documentation": "

List of the DomainController objects that were retrieved.

" - } - }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.

" } + }, + "DomainControllers": { + "target": "com.amazonaws.directoryservice#DomainControllers", + "traits": { + "smithy.api#documentation": "

List of the DomainController objects that were retrieved.

" + } } } }, @@ -2137,17 +2137,17 @@ "com.amazonaws.directoryservice#DescribeEventTopicsRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

" - } - }, "TopicNames": { "target": "com.amazonaws.directoryservice#TopicNames", "traits": { "smithy.api#documentation": "

A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

" + } } }, "traits": { @@ -2203,30 +2203,30 @@ "com.amazonaws.directoryservice#DescribeLDAPSSettingsRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.directoryservice#LDAPSType", - "traits": { - "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is supported.

" - } - }, "Limit": { "target": "com.amazonaws.directoryservice#PageLimit", "traits": { "smithy.api#documentation": "

Specifies the number of items that should be displayed on one page.

" } }, - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", - "traits": { - "smithy.api#documentation": "

The type of next token used for pagination.

" - } - }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } + }, + "Type": { + "target": "com.amazonaws.directoryservice#LDAPSType", + "traits": { + "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is supported.

" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

The type of next token used for pagination.

" + } } } }, @@ -2282,29 +2282,29 @@ "com.amazonaws.directoryservice#DescribeSharedDirectoriesRequest": { "type": "structure", "members": { - "SharedDirectoryIds": { - "target": "com.amazonaws.directoryservice#DirectoryIds", - "traits": { - "smithy.api#documentation": "

A list of identifiers of all shared directories in your account.

" - } - }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeSharedDirectoriesResult.NextToken value from a previous call to\n DescribeSharedDirectories. Pass null if this is the first call.\n

" } }, + "OwnerDirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

Returns the identifier of the directory in the directory owner account.

", + "smithy.api#required": {} + } + }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The number of shared directories to return in the response object.

" } }, - "OwnerDirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "SharedDirectoryIds": { + "target": "com.amazonaws.directoryservice#DirectoryIds", "traits": { - "smithy.api#documentation": "

Returns the identifier of the directory in the directory owner account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of identifiers of all shared directories in your account.

" } } } @@ -2358,10 +2358,10 @@ "com.amazonaws.directoryservice#DescribeSnapshotsRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "SnapshotIds": { + "target": "com.amazonaws.directoryservice#SnapshotIds", "traits": { - "smithy.api#documentation": "

The identifier of the directory for which to retrieve snapshot information.

" + "smithy.api#documentation": "

A list of identifiers of the snapshots to obtain the information for. If this member is\n null or empty, all snapshots are returned using the Limit and NextToken\n members.

" } }, "Limit": { @@ -2370,10 +2370,10 @@ "smithy.api#documentation": "

The maximum number of objects to return.

" } }, - "SnapshotIds": { - "target": "com.amazonaws.directoryservice#SnapshotIds", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

A list of identifiers of the snapshots to obtain the information for. If this member is\n null or empty, all snapshots are returned using the Limit and NextToken\n members.

" + "smithy.api#documentation": "

The identifier of the directory for which to retrieve snapshot information.

" } }, "NextToken": { @@ -2390,17 +2390,17 @@ "com.amazonaws.directoryservice#DescribeSnapshotsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", - "traits": { - "smithy.api#documentation": "

If not null, more results are available. Pass this value in the NextToken member of\n a subsequent call to DescribeSnapshots.

" - } - }, "Snapshots": { "target": "com.amazonaws.directoryservice#Snapshots", "traits": { "smithy.api#documentation": "

The list of Snapshot objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

If not null, more results are available. Pass this value in the NextToken member of\n a subsequent call to DescribeSnapshots.

" + } } }, "traits": { @@ -2442,28 +2442,28 @@ "com.amazonaws.directoryservice#DescribeTrustsRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

The Directory ID of the AWS directory that is a part of the requested trust relationship.

" - } - }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { "smithy.api#documentation": "

The maximum number of objects to return.

" } }, + "TrustIds": { + "target": "com.amazonaws.directoryservice#TrustIds", + "traits": { + "smithy.api#documentation": "

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" + } + }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

The DescribeTrustsResult.NextToken value from a previous call to\n DescribeTrusts. Pass null if this is the first call.

" } }, - "TrustIds": { - "target": "com.amazonaws.directoryservice#TrustIds", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" + "smithy.api#documentation": "

The Directory ID of the AWS directory that is a part of the requested trust relationship.

" } } }, @@ -2474,17 +2474,17 @@ "com.amazonaws.directoryservice#DescribeTrustsResult": { "type": "structure", "members": { - "Trusts": { - "target": "com.amazonaws.directoryservice#Trusts", - "traits": { - "smithy.api#documentation": "

The list of Trust objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" - } - }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter\n in a subsequent call to DescribeTrusts to retrieve the next set of items.

" } + }, + "Trusts": { + "target": "com.amazonaws.directoryservice#Trusts", + "traits": { + "smithy.api#documentation": "

The list of Trust objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" + } } }, "traits": { @@ -2512,11 +2512,11 @@ "com.amazonaws.directoryservice#DirectoryAlreadySharedException": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.directoryservice#RequestId" - }, "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { @@ -2527,13 +2527,6 @@ "com.amazonaws.directoryservice#DirectoryConnectSettings": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.directoryservice#SubnetIds", - "traits": { - "smithy.api#documentation": "

A list of subnet identifiers in the VPC in which the AD Connector is created.

", - "smithy.api#required": {} - } - }, "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { @@ -2548,6 +2541,13 @@ "smithy.api#required": {} } }, + "SubnetIds": { + "target": "com.amazonaws.directoryservice#SubnetIds", + "traits": { + "smithy.api#documentation": "

A list of subnet identifiers in the VPC in which the AD Connector is created.

", + "smithy.api#required": {} + } + }, "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { @@ -2563,34 +2563,28 @@ "com.amazonaws.directoryservice#DirectoryConnectSettingsDescription": { "type": "structure", "members": { - "SecurityGroupId": { - "target": "com.amazonaws.directoryservice#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The security group identifier for the AD Connector directory.

" - } - }, - "ConnectIps": { - "target": "com.amazonaws.directoryservice#IpAddrs", - "traits": { - "smithy.api#documentation": "

The IP addresses of the AD Connector servers.

" - } - }, "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { "smithy.api#documentation": "

A list of subnet identifiers in the VPC that the AD Connector is in.

" } }, + "SecurityGroupId": { + "target": "com.amazonaws.directoryservice#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The security group identifier for the AD Connector directory.

" + } + }, "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the VPC that the AD Connector is in.

" } }, - "CustomerUserName": { - "target": "com.amazonaws.directoryservice#UserName", + "ConnectIps": { + "target": "com.amazonaws.directoryservice#IpAddrs", "traits": { - "smithy.api#documentation": "

The user name of the service account in the on-premises directory.

" + "smithy.api#documentation": "

The IP addresses of the AD Connector servers.

" } }, "AvailabilityZones": { @@ -2598,6 +2592,12 @@ "traits": { "smithy.api#documentation": "

A list of the Availability Zones that the directory is in.

" } + }, + "CustomerUserName": { + "target": "com.amazonaws.directoryservice#UserName", + "traits": { + "smithy.api#documentation": "

The user name of the service account in the on-premises directory.

" + } } }, "traits": { @@ -2607,94 +2607,82 @@ "com.amazonaws.directoryservice#DirectoryDescription": { "type": "structure", "members": { - "ConnectSettings": { - "target": "com.amazonaws.directoryservice#DirectoryConnectSettingsDescription", - "traits": { - "smithy.api#documentation": "

A DirectoryConnectSettingsDescription object that contains additional information\n about an AD Connector directory. This member is only present if the directory is an AD\n Connector directory.

" - } - }, - "ShareNotes": { - "target": "com.amazonaws.directoryservice#Notes", + "Description": { + "target": "com.amazonaws.directoryservice#Description", "traits": { - "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" + "smithy.api#documentation": "

The description for the directory.

" } }, - "Stage": { - "target": "com.amazonaws.directoryservice#DirectoryStage", + "LaunchTime": { + "target": "com.amazonaws.directoryservice#LaunchTime", "traits": { - "smithy.api#documentation": "

The current stage of the directory.

" + "smithy.api#documentation": "

Specifies when the directory was created.

" } }, - "ShareMethod": { - "target": "com.amazonaws.directoryservice#ShareMethod", + "SsoEnabled": { + "target": "com.amazonaws.directoryservice#SsoEnabled", "traits": { - "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a shared directory request (HANDSHAKE).

" + "smithy.api#documentation": "

Indicates if single sign-on is enabled for the directory. For more information, see\n EnableSso and DisableSso.

" } }, - "Type": { - "target": "com.amazonaws.directoryservice#DirectoryType", + "Size": { + "target": "com.amazonaws.directoryservice#DirectorySize", "traits": { "smithy.api#documentation": "

The directory size.

" } }, - "RadiusStatus": { - "target": "com.amazonaws.directoryservice#RadiusStatus", - "traits": { - "smithy.api#documentation": "

The status of the RADIUS MFA server connection.

" - } - }, - "ShortName": { - "target": "com.amazonaws.directoryservice#DirectoryShortName", + "DnsIpAddrs": { + "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

The short name of the directory.

" + "smithy.api#documentation": "

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

" } }, - "Alias": { - "target": "com.amazonaws.directoryservice#AliasName", + "ShareStatus": { + "target": "com.amazonaws.directoryservice#ShareStatus", "traits": { - "smithy.api#documentation": "

The alias for the\n directory. If no\n alias has been created for the directory, the alias is the directory identifier, such as\n d-XXXXXXXXXX.

" + "smithy.api#documentation": "

Current directory status of the shared AWS Managed Microsoft AD directory.

" } }, - "StageReason": { - "target": "com.amazonaws.directoryservice#StageReason", + "ShareNotes": { + "target": "com.amazonaws.directoryservice#Notes", "traits": { - "smithy.api#documentation": "

Additional information about the directory stage.

" + "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" } }, - "StageLastUpdatedDateTime": { - "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", + "Name": { + "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { - "smithy.api#documentation": "

The date and time that the stage was last updated.

" + "smithy.api#documentation": "

The fully qualified name of the directory.

" } }, - "OwnerDirectoryDescription": { - "target": "com.amazonaws.directoryservice#OwnerDirectoryDescription", + "VpcSettings": { + "target": "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription", "traits": { - "smithy.api#documentation": "

Describes the AWS Managed Microsoft AD directory in the directory owner account.

" + "smithy.api#documentation": "

A DirectoryVpcSettingsDescription object that contains additional information about\n a directory. This member is only present if the directory is a Simple AD or Managed AD\n directory.

" } }, - "Description": { - "target": "com.amazonaws.directoryservice#Description", + "ShortName": { + "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { - "smithy.api#documentation": "

The description for the directory.

" + "smithy.api#documentation": "

The short name of the directory.

" } }, - "VpcSettings": { - "target": "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription", + "ShareMethod": { + "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "

A DirectoryVpcSettingsDescription object that contains additional information about\n a directory. This member is only present if the directory is a Simple AD or Managed AD\n directory.

" + "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a shared directory request (HANDSHAKE).

" } }, - "RadiusSettings": { - "target": "com.amazonaws.directoryservice#RadiusSettings", + "StageReason": { + "target": "com.amazonaws.directoryservice#StageReason", "traits": { - "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server configured\n for this directory.

" + "smithy.api#documentation": "

Additional information about the directory stage.

" } }, - "Name": { - "target": "com.amazonaws.directoryservice#DirectoryName", + "Edition": { + "target": "com.amazonaws.directoryservice#DirectoryEdition", "traits": { - "smithy.api#documentation": "

The fully qualified name of the directory.

" + "smithy.api#documentation": "

The edition associated with this directory.

" } }, "DirectoryId": { @@ -2703,16 +2691,22 @@ "smithy.api#documentation": "

The directory identifier.

" } }, - "Size": { - "target": "com.amazonaws.directoryservice#DirectorySize", + "DesiredNumberOfDomainControllers": { + "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", "traits": { - "smithy.api#documentation": "

The directory size.

" + "smithy.api#documentation": "

The desired number of domain controllers in the directory if the directory is Microsoft AD.

" } }, - "LaunchTime": { - "target": "com.amazonaws.directoryservice#LaunchTime", + "RadiusStatus": { + "target": "com.amazonaws.directoryservice#RadiusStatus", "traits": { - "smithy.api#documentation": "

Specifies when the directory was created.

" + "smithy.api#documentation": "

The status of the RADIUS MFA server connection.

" + } + }, + "Alias": { + "target": "com.amazonaws.directoryservice#AliasName", + "traits": { + "smithy.api#documentation": "

The alias for the\n directory. If no\n alias has been created for the directory, the alias is the directory identifier, such as\n d-XXXXXXXXXX.

" } }, "AccessUrl": { @@ -2721,34 +2715,40 @@ "smithy.api#documentation": "

The access URL for the directory, such as\n http://.awsapps.com.\n If no alias has been created for the directory, \n is the directory identifier, such as d-XXXXXXXXXX.

" } }, - "Edition": { - "target": "com.amazonaws.directoryservice#DirectoryEdition", + "OwnerDirectoryDescription": { + "target": "com.amazonaws.directoryservice#OwnerDirectoryDescription", "traits": { - "smithy.api#documentation": "

The edition associated with this directory.

" + "smithy.api#documentation": "

Describes the AWS Managed Microsoft AD directory in the directory owner account.

" } }, - "DesiredNumberOfDomainControllers": { - "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", + "StageLastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { - "smithy.api#documentation": "

The desired number of domain controllers in the directory if the directory is Microsoft AD.

" + "smithy.api#documentation": "

The date and time that the stage was last updated.

" } }, - "DnsIpAddrs": { - "target": "com.amazonaws.directoryservice#DnsIpAddrs", + "ConnectSettings": { + "target": "com.amazonaws.directoryservice#DirectoryConnectSettingsDescription", "traits": { - "smithy.api#documentation": "

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

" + "smithy.api#documentation": "

A DirectoryConnectSettingsDescription object that contains additional information\n about an AD Connector directory. This member is only present if the directory is an AD\n Connector directory.

" } }, - "ShareStatus": { - "target": "com.amazonaws.directoryservice#ShareStatus", + "Stage": { + "target": "com.amazonaws.directoryservice#DirectoryStage", "traits": { - "smithy.api#documentation": "

Current directory status of the shared AWS Managed Microsoft AD directory.

" + "smithy.api#documentation": "

The current stage of the directory.

" } }, - "SsoEnabled": { - "target": "com.amazonaws.directoryservice#SsoEnabled", + "RadiusSettings": { + "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { - "smithy.api#documentation": "

Indicates if single sign-on is enabled for the directory. For more information, see\n EnableSso and DisableSso.

" + "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server configured\n for this directory.

" + } + }, + "Type": { + "target": "com.amazonaws.directoryservice#DirectoryType", + "traits": { + "smithy.api#documentation": "

The directory size.

" } } }, @@ -2813,11 +2813,11 @@ "com.amazonaws.directoryservice#DirectoryLimitExceededException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -2828,58 +2828,58 @@ "com.amazonaws.directoryservice#DirectoryLimits": { "type": "structure", "members": { - "CloudOnlyDirectoriesLimitReached": { - "target": "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached", + "CloudOnlyDirectoriesCurrentCount": { + "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

Indicates if the cloud directory limit has been reached.

" + "smithy.api#documentation": "

The current number of cloud directories in the Region.

" } }, - "ConnectedDirectoriesLimitReached": { - "target": "com.amazonaws.directoryservice#ConnectedDirectoriesLimitReached", + "CloudOnlyDirectoriesLimit": { + "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

Indicates if the connected directory limit has been reached.

" + "smithy.api#documentation": "

The maximum number of cloud directories allowed in the Region.

" } }, - "CloudOnlyDirectoriesLimit": { + "CloudOnlyMicrosoftADLimit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

The maximum number of cloud directories allowed in the Region.

" + "smithy.api#documentation": "

The maximum number of AWS Managed Microsoft AD directories allowed in the region.

" } }, - "CloudOnlyMicrosoftADLimitReached": { - "target": "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached", + "ConnectedDirectoriesLimitReached": { + "target": "com.amazonaws.directoryservice#ConnectedDirectoriesLimitReached", "traits": { - "smithy.api#documentation": "

Indicates if the AWS Managed Microsoft AD directory limit has been reached.

" + "smithy.api#documentation": "

Indicates if the connected directory limit has been reached.

" } }, - "ConnectedDirectoriesLimit": { - "target": "com.amazonaws.directoryservice#Limit", + "CloudOnlyDirectoriesLimitReached": { + "target": "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached", "traits": { - "smithy.api#documentation": "

The maximum number of connected directories allowed in the Region.

" + "smithy.api#documentation": "

Indicates if the cloud directory limit has been reached.

" } }, - "ConnectedDirectoriesCurrentCount": { + "CloudOnlyMicrosoftADCurrentCount": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

The current number of connected directories in the Region.

" + "smithy.api#documentation": "

The current number of AWS Managed Microsoft AD directories in the region.

" } }, - "CloudOnlyDirectoriesCurrentCount": { - "target": "com.amazonaws.directoryservice#Limit", + "CloudOnlyMicrosoftADLimitReached": { + "target": "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached", "traits": { - "smithy.api#documentation": "

The current number of cloud directories in the Region.

" + "smithy.api#documentation": "

Indicates if the AWS Managed Microsoft AD directory limit has been reached.

" } }, - "CloudOnlyMicrosoftADLimit": { + "ConnectedDirectoriesLimit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

The maximum number of AWS Managed Microsoft AD directories allowed in the region.

" + "smithy.api#documentation": "

The maximum number of connected directories allowed in the Region.

" } }, - "CloudOnlyMicrosoftADCurrentCount": { + "ConnectedDirectoriesCurrentCount": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

The current number of AWS Managed Microsoft AD directories in the region.

" + "smithy.api#documentation": "

The current number of connected directories in the Region.

" } } }, @@ -2896,11 +2896,11 @@ "com.amazonaws.directoryservice#DirectoryNotSharedException": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.directoryservice#RequestId" - }, "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { @@ -3089,7 +3089,7 @@ "sdkId": "Directory Service", "arnNamespace": "ds", "cloudFormationName": "DirectoryService", - "cloudTrailEventSource": "v20150416.directoryservice.amazonaws.com" + "cloudTrailEventSource": "directoryservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "ds" @@ -3237,28 +3237,28 @@ "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.directoryservice#SubnetIds", - "traits": { - "smithy.api#documentation": "

The identifiers of the subnets for the directory servers.

" - } - }, "AvailabilityZones": { "target": "com.amazonaws.directoryservice#AvailabilityZones", "traits": { "smithy.api#documentation": "

The list of Availability Zones that the directory is in.

" } }, + "SecurityGroupId": { + "target": "com.amazonaws.directoryservice#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The domain controller security group identifier for the directory.

" + } + }, "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { "smithy.api#documentation": "

The identifier of the VPC that the directory is in.

" } }, - "SecurityGroupId": { - "target": "com.amazonaws.directoryservice#SecurityGroupId", + "SubnetIds": { + "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { - "smithy.api#documentation": "

The domain controller security group identifier for the directory.

" + "smithy.api#documentation": "

The identifiers of the subnets for the directory servers.

" } } }, @@ -3304,17 +3304,17 @@ "com.amazonaws.directoryservice#DisableLDAPSRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "Type": { + "target": "com.amazonaws.directoryservice#LDAPSType", "traits": { - "smithy.api#documentation": "

The identifier of the directory.

", + "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is supported.

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.directoryservice#LDAPSType", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is supported.

", + "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } } @@ -3401,6 +3401,13 @@ "com.amazonaws.directoryservice#DisableSsoRequest": { "type": "structure", "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to disable single-sign on.

", + "smithy.api#required": {} + } + }, "UserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { @@ -3412,13 +3419,6 @@ "traits": { "smithy.api#documentation": "

The password of an alternate account to use to disable single-sign on. This is only used\n for AD Connector directories. For more information, see the UserName parameter.

" } - }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

The identifier of the directory for which to disable single-sign on.

", - "smithy.api#required": {} - } } }, "traits": { @@ -3441,18 +3441,6 @@ "com.amazonaws.directoryservice#DomainController": { "type": "structure", "members": { - "StatusReason": { - "target": "com.amazonaws.directoryservice#DomainControllerStatusReason", - "traits": { - "smithy.api#documentation": "

A description of the domain controller state.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.directoryservice#SubnetId", - "traits": { - "smithy.api#documentation": "

Identifier of the subnet in the VPC that contains the domain controller.

" - } - }, "StatusLastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { @@ -3465,10 +3453,22 @@ "smithy.api#documentation": "

Specifies when the domain controller was created.

" } }, - "DnsIpAddr": { - "target": "com.amazonaws.directoryservice#IpAddr", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The IP address of the domain controller.

" + "smithy.api#documentation": "

Identifier of the directory where the domain controller resides.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.directoryservice#DomainControllerStatusReason", + "traits": { + "smithy.api#documentation": "

A description of the domain controller state.

" + } + }, + "DomainControllerId": { + "target": "com.amazonaws.directoryservice#DomainControllerId", + "traits": { + "smithy.api#documentation": "

Identifies a specific domain controller in the directory.

" } }, "Status": { @@ -3477,10 +3477,10 @@ "smithy.api#documentation": "

The status of the domain controller.

" } }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "VpcId": { + "target": "com.amazonaws.directoryservice#VpcId", "traits": { - "smithy.api#documentation": "

Identifier of the directory where the domain controller resides.

" + "smithy.api#documentation": "

The identifier of the VPC that contains the domain controller.

" } }, "AvailabilityZone": { @@ -3489,16 +3489,16 @@ "smithy.api#documentation": "

The Availability Zone where the domain controller is located.

" } }, - "VpcId": { - "target": "com.amazonaws.directoryservice#VpcId", + "DnsIpAddr": { + "target": "com.amazonaws.directoryservice#IpAddr", "traits": { - "smithy.api#documentation": "

The identifier of the VPC that contains the domain controller.

" + "smithy.api#documentation": "

The IP address of the domain controller.

" } }, - "DomainControllerId": { - "target": "com.amazonaws.directoryservice#DomainControllerId", + "SubnetId": { + "target": "com.amazonaws.directoryservice#SubnetId", "traits": { - "smithy.api#documentation": "

Identifies a specific domain controller in the directory.

" + "smithy.api#documentation": "

Identifier of the subnet in the VPC that contains the domain controller.

" } } }, @@ -3521,11 +3521,11 @@ "com.amazonaws.directoryservice#DomainControllerLimitExceededException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -3618,17 +3618,17 @@ "com.amazonaws.directoryservice#EnableLDAPSRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.directoryservice#LDAPSType", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is supported.

", + "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "Type": { + "target": "com.amazonaws.directoryservice#LDAPSType", "traits": { - "smithy.api#documentation": "

The identifier of the directory.

", + "smithy.api#documentation": "

The type of LDAP security to enable. Currently only the value Client is supported.

", "smithy.api#required": {} } } @@ -3670,17 +3670,17 @@ "com.amazonaws.directoryservice#EnableRadiusRequest": { "type": "structure", "members": { - "RadiusSettings": { - "target": "com.amazonaws.directoryservice#RadiusSettings", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server.

", + "smithy.api#documentation": "

The identifier of the directory for which to enable MFA.

", "smithy.api#required": {} } }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "RadiusSettings": { + "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { - "smithy.api#documentation": "

The identifier of the directory for which to enable MFA.

", + "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server.

", "smithy.api#required": {} } } @@ -3734,18 +3734,18 @@ "smithy.api#documentation": "

The password of an alternate account to use to enable single-sign on. This is only used for\n AD Connector directories. For more information, see the UserName parameter.

" } }, + "UserName": { + "target": "com.amazonaws.directoryservice#UserName", + "traits": { + "smithy.api#documentation": "

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

\n

If the AD Connector service account does not have privileges to add a service principal\n name, you can specify an alternate account with the UserName and Password\n parameters. These credentials are only used to enable single sign-on and are not stored by\n the service. The AD Connector service account is not changed.

" + } + }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the directory for which to enable single-sign on.

", "smithy.api#required": {} } - }, - "UserName": { - "target": "com.amazonaws.directoryservice#UserName", - "traits": { - "smithy.api#documentation": "

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

\n

If the AD Connector service account does not have privileges to add a service principal\n name, you can specify an alternate account with the UserName and Password\n parameters. These credentials are only used to enable single sign-on and are not stored by\n the service. The AD Connector service account is not changed.

" - } } }, "traits": { @@ -3765,11 +3765,11 @@ "com.amazonaws.directoryservice#EntityAlreadyExistsException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -3795,10 +3795,10 @@ "com.amazonaws.directoryservice#EventTopic": { "type": "structure", "members": { - "TopicArn": { - "target": "com.amazonaws.directoryservice#TopicArn", + "CreatedDateTime": { + "target": "com.amazonaws.directoryservice#CreatedDateTime", "traits": { - "smithy.api#documentation": "

The SNS topic ARN (Amazon Resource Name).

" + "smithy.api#documentation": "

The date and time of when you associated your directory with the SNS topic.

" } }, "TopicName": { @@ -3807,16 +3807,10 @@ "smithy.api#documentation": "

The name of an AWS SNS topic the receives status messages from the directory.

" } }, - "CreatedDateTime": { - "target": "com.amazonaws.directoryservice#CreatedDateTime", - "traits": { - "smithy.api#documentation": "

The date and time of when you associated your directory with the SNS topic.

" - } - }, - "Status": { - "target": "com.amazonaws.directoryservice#TopicStatus", + "TopicArn": { + "target": "com.amazonaws.directoryservice#TopicArn", "traits": { - "smithy.api#documentation": "

The topic registration status.

" + "smithy.api#documentation": "

The SNS topic ARN (Amazon Resource Name).

" } }, "DirectoryId": { @@ -3824,6 +3818,12 @@ "traits": { "smithy.api#documentation": "

The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

" } + }, + "Status": { + "target": "com.amazonaws.directoryservice#TopicStatus", + "traits": { + "smithy.api#documentation": "

The topic registration status.

" + } } }, "traits": { @@ -3956,11 +3956,11 @@ "com.amazonaws.directoryservice#InvalidCertificateException": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.directoryservice#RequestId" - }, "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { @@ -3971,11 +3971,11 @@ "com.amazonaws.directoryservice#InvalidLDAPSStatusException": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.directoryservice#RequestId" - }, "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { @@ -3986,11 +3986,11 @@ "com.amazonaws.directoryservice#InvalidNextTokenException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -4031,11 +4031,11 @@ "com.amazonaws.directoryservice#InvalidTargetException": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.directoryservice#RequestId" - }, "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { @@ -4078,10 +4078,10 @@ "com.amazonaws.directoryservice#IpRouteInfo": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.directoryservice#Description", + "IpRouteStatusReason": { + "target": "com.amazonaws.directoryservice#IpRouteStatusReason", "traits": { - "smithy.api#documentation": "

Description of the IpRouteInfo.

" + "smithy.api#documentation": "

The reason for the IpRouteStatusMsg.

" } }, "DirectoryId": { @@ -4090,16 +4090,10 @@ "smithy.api#documentation": "

Identifier (ID) of the directory associated with the IP addresses.

" } }, - "CidrIp": { - "target": "com.amazonaws.directoryservice#CidrIp", - "traits": { - "smithy.api#documentation": "

IP address block in the IpRoute.

" - } - }, - "IpRouteStatusMsg": { - "target": "com.amazonaws.directoryservice#IpRouteStatusMsg", + "Description": { + "target": "com.amazonaws.directoryservice#Description", "traits": { - "smithy.api#documentation": "

The status of the IP address block.

" + "smithy.api#documentation": "

Description of the IpRouteInfo.

" } }, "AddedDateTime": { @@ -4108,10 +4102,16 @@ "smithy.api#documentation": "

The date and time the address block was added to the directory.

" } }, - "IpRouteStatusReason": { - "target": "com.amazonaws.directoryservice#IpRouteStatusReason", + "CidrIp": { + "target": "com.amazonaws.directoryservice#CidrIp", "traits": { - "smithy.api#documentation": "

The reason for the IpRouteStatusMsg.

" + "smithy.api#documentation": "

IP address block in the IpRoute.

" + } + }, + "IpRouteStatusMsg": { + "target": "com.amazonaws.directoryservice#IpRouteStatusMsg", + "traits": { + "smithy.api#documentation": "

The status of the IP address block.

" } } }, @@ -4122,11 +4122,11 @@ "com.amazonaws.directoryservice#IpRouteLimitExceededException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -4189,17 +4189,17 @@ "smithy.api#documentation": "

Describes a state change for LDAPS.

" } }, - "LastUpdatedDateTime": { - "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", - "traits": { - "smithy.api#documentation": "

The date and time when the LDAPS settings were last updated.

" - } - }, "LDAPSStatus": { "target": "com.amazonaws.directoryservice#LDAPSStatus", "traits": { "smithy.api#documentation": "

The state of the LDAPS settings.

" } + }, + "LastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the LDAPS settings were last updated.

" + } } }, "traits": { @@ -4308,12 +4308,6 @@ "com.amazonaws.directoryservice#ListCertificatesRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.directoryservice#PageLimit", - "traits": { - "smithy.api#documentation": "

The number of items that should show up on one page

" - } - }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { @@ -4326,6 +4320,12 @@ "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } + }, + "Limit": { + "target": "com.amazonaws.directoryservice#PageLimit", + "traits": { + "smithy.api#documentation": "

The number of items that should show up on one page

" + } } } }, @@ -4378,13 +4378,6 @@ "com.amazonaws.directoryservice#ListIpRoutesRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

", - "smithy.api#required": {} - } - }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { @@ -4396,6 +4389,13 @@ "traits": { "smithy.api#documentation": "

The ListIpRoutes.NextToken value from a previous call to\n ListIpRoutes. Pass null if this is the first call.

" } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

", + "smithy.api#required": {} + } } } }, @@ -4445,6 +4445,12 @@ "com.amazonaws.directoryservice#ListLogSubscriptionsRequest": { "type": "structure", "members": { + "Limit": { + "target": "com.amazonaws.directoryservice#Limit", + "traits": { + "smithy.api#documentation": "

The maximum number of items returned.

" + } + }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { @@ -4456,12 +4462,6 @@ "traits": { "smithy.api#documentation": "

If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned.

" } - }, - "Limit": { - "target": "com.amazonaws.directoryservice#Limit", - "traits": { - "smithy.api#documentation": "

The maximum number of items returned.

" - } } } }, @@ -4511,10 +4511,10 @@ "com.amazonaws.directoryservice#ListSchemaExtensionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", + "Limit": { + "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

" + "smithy.api#documentation": "

The maximum number of items to return.

" } }, "DirectoryId": { @@ -4524,10 +4524,10 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.directoryservice#Limit", + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of items to return.

" + "smithy.api#documentation": "

The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

" } } } @@ -4535,17 +4535,17 @@ "com.amazonaws.directoryservice#ListSchemaExtensionsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", - "traits": { - "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.

" - } - }, "SchemaExtensionsInfo": { "target": "com.amazonaws.directoryservice#SchemaExtensionsInfo", "traits": { "smithy.api#documentation": "

Information about the schema extensions applied to the directory.

" } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.

" + } } } }, @@ -4581,6 +4581,12 @@ "com.amazonaws.directoryservice#ListTagsForResourceRequest": { "type": "structure", "members": { + "Limit": { + "target": "com.amazonaws.directoryservice#Limit", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { @@ -4593,29 +4599,23 @@ "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve tags.

", "smithy.api#required": {} } - }, - "Limit": { - "target": "com.amazonaws.directoryservice#Limit", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } } } }, "com.amazonaws.directoryservice#ListTagsForResourceResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.directoryservice#NextToken", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } } } }, @@ -4632,18 +4632,18 @@ "com.amazonaws.directoryservice#LogSubscription": { "type": "structure", "members": { - "SubscriptionCreatedDateTime": { - "target": "com.amazonaws.directoryservice#SubscriptionCreatedDateTime", - "traits": { - "smithy.api#documentation": "

The date and time that the log subscription was created.

" - } - }, "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { "smithy.api#documentation": "

Identifier (ID) of the directory that you want to associate with the log subscription.

" } }, + "SubscriptionCreatedDateTime": { + "target": "com.amazonaws.directoryservice#SubscriptionCreatedDateTime", + "traits": { + "smithy.api#documentation": "

The date and time that the log subscription was created.

" + } + }, "LogGroupName": { "target": "com.amazonaws.directoryservice#LogGroupName", "traits": { @@ -4670,11 +4670,11 @@ "com.amazonaws.directoryservice#NoAvailableCertificateException": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.directoryservice#RequestId" - }, "Message": { "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" } }, "traits": { @@ -4725,16 +4725,10 @@ "smithy.api#documentation": "

Information about the status of the RADIUS server.

" } }, - "DnsIpAddrs": { - "target": "com.amazonaws.directoryservice#DnsIpAddrs", - "traits": { - "smithy.api#documentation": "

IP address of the directory’s domain controllers.

" - } - }, - "RadiusSettings": { - "target": "com.amazonaws.directoryservice#RadiusSettings", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server.

" + "smithy.api#documentation": "

Identifier of the AWS Managed Microsoft AD directory in the directory owner account.

" } }, "AccountId": { @@ -4743,10 +4737,10 @@ "smithy.api#documentation": "

Identifier of the directory owner account.

" } }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "RadiusSettings": { + "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { - "smithy.api#documentation": "

Identifier of the AWS Managed Microsoft AD directory in the directory owner account.

" + "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server.

" } }, "VpcSettings": { @@ -4754,6 +4748,12 @@ "traits": { "smithy.api#documentation": "

Information about the VPC settings for the directory.

" } + }, + "DnsIpAddrs": { + "target": "com.amazonaws.directoryservice#DnsIpAddrs", + "traits": { + "smithy.api#documentation": "

IP address of the directory’s domain controllers.

" + } } }, "traits": { @@ -4830,16 +4830,10 @@ "com.amazonaws.directoryservice#RadiusSettings": { "type": "structure", "members": { - "UseSameUsername": { - "target": "com.amazonaws.directoryservice#UseSameUsername", - "traits": { - "smithy.api#documentation": "

Not currently used.

" - } - }, - "RadiusTimeout": { - "target": "com.amazonaws.directoryservice#RadiusTimeout", + "RadiusServers": { + "target": "com.amazonaws.directoryservice#Servers", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for the RADIUS server to respond.

" + "smithy.api#documentation": "

An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

" } }, "RadiusPort": { @@ -4848,16 +4842,10 @@ "smithy.api#documentation": "

The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.

" } }, - "SharedSecret": { - "target": "com.amazonaws.directoryservice#RadiusSharedSecret", - "traits": { - "smithy.api#documentation": "

Required for enabling RADIUS on the directory.

" - } - }, - "RadiusServers": { - "target": "com.amazonaws.directoryservice#Servers", + "AuthenticationProtocol": { + "target": "com.amazonaws.directoryservice#RadiusAuthenticationProtocol", "traits": { - "smithy.api#documentation": "

An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

" + "smithy.api#documentation": "

The protocol specified for your RADIUS endpoints.

" } }, "RadiusRetries": { @@ -4866,10 +4854,10 @@ "smithy.api#documentation": "

The maximum number of times that communication with the RADIUS server is attempted.

" } }, - "AuthenticationProtocol": { - "target": "com.amazonaws.directoryservice#RadiusAuthenticationProtocol", + "RadiusTimeout": { + "target": "com.amazonaws.directoryservice#RadiusTimeout", "traits": { - "smithy.api#documentation": "

The protocol specified for your RADIUS endpoints.

" + "smithy.api#documentation": "

The amount of time, in seconds, to wait for the RADIUS server to respond.

" } }, "DisplayLabel": { @@ -4877,6 +4865,18 @@ "traits": { "smithy.api#documentation": "

Not currently used.

" } + }, + "SharedSecret": { + "target": "com.amazonaws.directoryservice#RadiusSharedSecret", + "traits": { + "smithy.api#documentation": "

Required for enabling RADIUS on the directory.

" + } + }, + "UseSameUsername": { + "target": "com.amazonaws.directoryservice#UseSameUsername", + "traits": { + "smithy.api#documentation": "

Not currently used.

" + } } }, "traits": { @@ -4965,17 +4965,17 @@ "com.amazonaws.directoryservice#RegisterCertificateRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "CertificateData": { + "target": "com.amazonaws.directoryservice#CertificateData", "traits": { - "smithy.api#documentation": "

The identifier of the directory.

", + "smithy.api#documentation": "

The certificate PEM string that needs to be registered.

", "smithy.api#required": {} } }, - "CertificateData": { - "target": "com.amazonaws.directoryservice#CertificateData", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The certificate PEM string that needs to be registered.

", + "smithy.api#documentation": "

The identifier of the directory.

", "smithy.api#required": {} } } @@ -5143,17 +5143,17 @@ "com.amazonaws.directoryservice#RemoveIpRoutesRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "CidrIps": { + "target": "com.amazonaws.directoryservice#CidrIps", "traits": { - "smithy.api#documentation": "

Identifier (ID) of the directory from which you want to remove the IP addresses.

", + "smithy.api#documentation": "

IP address blocks that you want to remove.

", "smithy.api#required": {} } }, - "CidrIps": { - "target": "com.amazonaws.directoryservice#CidrIps", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

IP address blocks that you want to remove.

", + "smithy.api#documentation": "

Identifier (ID) of the directory from which you want to remove the IP addresses.

", "smithy.api#required": {} } } @@ -5192,17 +5192,17 @@ "com.amazonaws.directoryservice#RemoveTagsFromResourceRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.directoryservice#ResourceId", + "TagKeys": { + "target": "com.amazonaws.directoryservice#TagKeys", "traits": { - "smithy.api#documentation": "

Identifier (ID) of the directory from which to remove the tag.

", + "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.directoryservice#TagKeys", + "ResourceId": { + "target": "com.amazonaws.directoryservice#ResourceId", "traits": { - "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", + "smithy.api#documentation": "

Identifier (ID) of the directory from which to remove the tag.

", "smithy.api#required": {} } } @@ -5268,10 +5268,10 @@ "com.amazonaws.directoryservice#ResetUserPasswordRequest": { "type": "structure", "members": { - "NewPassword": { - "target": "com.amazonaws.directoryservice#UserPassword", + "UserName": { + "target": "com.amazonaws.directoryservice#CustomerUserName", "traits": { - "smithy.api#documentation": "

The new password that will be reset.

", + "smithy.api#documentation": "

The user name of the user whose password will be reset.

", "smithy.api#required": {} } }, @@ -5282,10 +5282,10 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.directoryservice#CustomerUserName", + "NewPassword": { + "target": "com.amazonaws.directoryservice#UserPassword", "traits": { - "smithy.api#documentation": "

The user name of the user whose password will be reset.

", + "smithy.api#documentation": "

The new password that will be reset.

", "smithy.api#required": {} } } @@ -5368,40 +5368,28 @@ "com.amazonaws.directoryservice#SchemaExtensionInfo": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.directoryservice#Description", - "traits": { - "smithy.api#documentation": "

A description of the schema extension.

" - } - }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

The identifier of the directory to which the schema extension is applied.

" - } - }, "SchemaExtensionStatusReason": { "target": "com.amazonaws.directoryservice#SchemaExtensionStatusReason", "traits": { "smithy.api#documentation": "

The reason for the SchemaExtensionStatus.

" } }, - "SchemaExtensionId": { - "target": "com.amazonaws.directoryservice#SchemaExtensionId", + "EndDateTime": { + "target": "com.amazonaws.directoryservice#EndDateTime", "traits": { - "smithy.api#documentation": "

The identifier of the schema extension.

" + "smithy.api#documentation": "

The date and time that the schema extension was completed.

" } }, - "SchemaExtensionStatus": { - "target": "com.amazonaws.directoryservice#SchemaExtensionStatus", + "Description": { + "target": "com.amazonaws.directoryservice#Description", "traits": { - "smithy.api#documentation": "

The current status of the schema extension.

" + "smithy.api#documentation": "

A description of the schema extension.

" } }, - "EndDateTime": { - "target": "com.amazonaws.directoryservice#EndDateTime", + "SchemaExtensionStatus": { + "target": "com.amazonaws.directoryservice#SchemaExtensionStatus", "traits": { - "smithy.api#documentation": "

The date and time that the schema extension was completed.

" + "smithy.api#documentation": "

The current status of the schema extension.

" } }, "StartDateTime": { @@ -5409,6 +5397,18 @@ "traits": { "smithy.api#documentation": "

The date and time that the schema extension started being applied to the directory.

" } + }, + "SchemaExtensionId": { + "target": "com.amazonaws.directoryservice#SchemaExtensionId", + "traits": { + "smithy.api#documentation": "

The identifier of the schema extension.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory to which the schema extension is applied.

" + } } }, "traits": { @@ -5506,11 +5506,11 @@ "com.amazonaws.directoryservice#ServiceException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -5565,30 +5565,30 @@ "com.amazonaws.directoryservice#ShareDirectoryRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "ShareNotes": { + "target": "com.amazonaws.directoryservice#Notes", "traits": { - "smithy.api#documentation": "

Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" } }, - "ShareTarget": { - "target": "com.amazonaws.directoryservice#ShareTarget", + "ShareMethod": { + "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "

Identifier for the directory consumer account with whom the directory is to be shared.

", + "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a directory sharing request (HANDSHAKE).

", "smithy.api#required": {} } }, - "ShareNotes": { - "target": "com.amazonaws.directoryservice#Notes", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" + "smithy.api#documentation": "

Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

", + "smithy.api#required": {} } }, - "ShareMethod": { - "target": "com.amazonaws.directoryservice#ShareMethod", + "ShareTarget": { + "target": "com.amazonaws.directoryservice#ShareTarget", "traits": { - "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a directory sharing request (HANDSHAKE).

", + "smithy.api#documentation": "

Identifier for the directory consumer account with whom the directory is to be shared.

", "smithy.api#required": {} } } @@ -5607,12 +5607,12 @@ }, "com.amazonaws.directoryservice#ShareLimitExceededException": { "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, + "members": { "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -5681,17 +5681,17 @@ "com.amazonaws.directoryservice#ShareTarget": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.directoryservice#TargetType", + "Id": { + "target": "com.amazonaws.directoryservice#TargetId", "traits": { - "smithy.api#documentation": "

Type of identifier to be used in the Id field.

", + "smithy.api#documentation": "

Identifier of the directory consumer account.

", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.directoryservice#TargetId", + "Type": { + "target": "com.amazonaws.directoryservice#TargetType", "traits": { - "smithy.api#documentation": "

Identifier of the directory consumer account.

", + "smithy.api#documentation": "

Type of identifier to be used in the Id field.

", "smithy.api#required": {} } } @@ -5709,16 +5709,16 @@ "com.amazonaws.directoryservice#SharedDirectory": { "type": "structure", "members": { - "SharedDirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "ShareMethod": { + "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

" + "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a shared directory request (HANDSHAKE).

" } }, - "ShareNotes": { - "target": "com.amazonaws.directoryservice#Notes", + "SharedAccountId": { + "target": "com.amazonaws.directoryservice#CustomerId", "traits": { - "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" + "smithy.api#documentation": "

Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.

" } }, "CreatedDateTime": { @@ -5727,22 +5727,22 @@ "smithy.api#documentation": "

The date and time that the shared directory was created.

" } }, - "LastUpdatedDateTime": { - "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", + "SharedDirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The date and time that the shared directory was last updated.

" + "smithy.api#documentation": "

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

" } }, - "ShareMethod": { - "target": "com.amazonaws.directoryservice#ShareMethod", + "ShareStatus": { + "target": "com.amazonaws.directoryservice#ShareStatus", "traits": { - "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a shared directory request (HANDSHAKE).

" + "smithy.api#documentation": "

Current directory status of the shared AWS Managed Microsoft AD directory.

" } }, - "OwnerAccountId": { - "target": "com.amazonaws.directoryservice#CustomerId", + "ShareNotes": { + "target": "com.amazonaws.directoryservice#Notes", "traits": { - "smithy.api#documentation": "

Identifier of the directory owner account, which contains the directory that has been\n shared to the consumer account.

" + "smithy.api#documentation": "

A directory share request that is sent by the directory owner to the directory consumer.\n The request includes a typed message to help the directory consumer administrator determine\n whether to approve or reject the share invitation.

" } }, "OwnerDirectoryId": { @@ -5751,16 +5751,16 @@ "smithy.api#documentation": "

Identifier of the directory in the directory owner account.

" } }, - "ShareStatus": { - "target": "com.amazonaws.directoryservice#ShareStatus", + "LastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { - "smithy.api#documentation": "

Current directory status of the shared AWS Managed Microsoft AD directory.

" + "smithy.api#documentation": "

The date and time that the shared directory was last updated.

" } }, - "SharedAccountId": { + "OwnerAccountId": { "target": "com.amazonaws.directoryservice#CustomerId", "traits": { - "smithy.api#documentation": "

Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.

" + "smithy.api#documentation": "

Identifier of the directory owner account, which contains the directory that has been\n shared to the consumer account.

" } } }, @@ -5771,18 +5771,6 @@ "com.amazonaws.directoryservice#Snapshot": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.directoryservice#SnapshotStatus", - "traits": { - "smithy.api#documentation": "

The snapshot status.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.directoryservice#SnapshotId", - "traits": { - "smithy.api#documentation": "

The snapshot identifier.

" - } - }, "StartTime": { "target": "com.amazonaws.directoryservice#StartTime", "traits": { @@ -5795,10 +5783,10 @@ "smithy.api#documentation": "

The descriptive name of the snapshot.

" } }, - "Type": { - "target": "com.amazonaws.directoryservice#SnapshotType", + "Status": { + "target": "com.amazonaws.directoryservice#SnapshotStatus", "traits": { - "smithy.api#documentation": "

The snapshot type.

" + "smithy.api#documentation": "

The snapshot status.

" } }, "DirectoryId": { @@ -5806,6 +5794,18 @@ "traits": { "smithy.api#documentation": "

The directory identifier.

" } + }, + "Type": { + "target": "com.amazonaws.directoryservice#SnapshotType", + "traits": { + "smithy.api#documentation": "

The snapshot type.

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.directoryservice#SnapshotId", + "traits": { + "smithy.api#documentation": "

The snapshot identifier.

" + } } }, "traits": { @@ -5851,17 +5851,17 @@ "smithy.api#documentation": "

The maximum number of manual snapshots allowed.

" } }, - "ManualSnapshotsCurrentCount": { - "target": "com.amazonaws.directoryservice#Limit", - "traits": { - "smithy.api#documentation": "

The current number of manual snapshots of the directory.

" - } - }, "ManualSnapshotsLimitReached": { "target": "com.amazonaws.directoryservice#ManualSnapshotsLimitReached", "traits": { "smithy.api#documentation": "

Indicates if the manual snapshot limit has been reached.

" } + }, + "ManualSnapshotsCurrentCount": { + "target": "com.amazonaws.directoryservice#Limit", + "traits": { + "smithy.api#documentation": "

The current number of manual snapshots of the directory.

" + } } }, "traits": { @@ -5965,31 +5965,31 @@ "com.amazonaws.directoryservice#StartSchemaExtensionRequest": { "type": "structure", "members": { - "LdifContent": { - "target": "com.amazonaws.directoryservice#LdifContent", + "Description": { + "target": "com.amazonaws.directoryservice#Description", "traits": { - "smithy.api#documentation": "

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \\n. See the example request below for more details. The file size can be no larger than 1MB.

", + "smithy.api#documentation": "

A description of the schema extension.

", "smithy.api#required": {} } }, - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "CreateSnapshotBeforeSchemaExtension": { + "target": "com.amazonaws.directoryservice#CreateSnapshotBeforeSchemaExtension", "traits": { - "smithy.api#documentation": "

The identifier of the directory for which the schema extension will be applied to.

", + "smithy.api#documentation": "

If true, creates a snapshot of the directory before applying the schema extension.

", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.directoryservice#Description", + "LdifContent": { + "target": "com.amazonaws.directoryservice#LdifContent", "traits": { - "smithy.api#documentation": "

A description of the schema extension.

", + "smithy.api#documentation": "

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \\n. See the example request below for more details. The file size can be no larger than 1MB.

", "smithy.api#required": {} } }, - "CreateSnapshotBeforeSchemaExtension": { - "target": "com.amazonaws.directoryservice#CreateSnapshotBeforeSchemaExtension", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

If true, creates a snapshot of the directory before applying the schema extension.

", + "smithy.api#documentation": "

The identifier of the directory for which the schema extension will be applied to.

", "smithy.api#required": {} } } @@ -6030,17 +6030,17 @@ "com.amazonaws.directoryservice#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.directoryservice#TagValue", + "Key": { + "target": "com.amazonaws.directoryservice#TagKey", "traits": { - "smithy.api#documentation": "

The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", + "smithy.api#documentation": "

Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.directoryservice#TagKey", + "Value": { + "target": "com.amazonaws.directoryservice#TagValue", "traits": { - "smithy.api#documentation": "

Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", + "smithy.api#documentation": "

The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", "smithy.api#required": {} } } @@ -6161,16 +6161,10 @@ "com.amazonaws.directoryservice#Trust": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

The Directory ID of the AWS directory involved in the trust relationship.

" - } - }, - "TrustStateReason": { - "target": "com.amazonaws.directoryservice#TrustStateReason", + "TrustType": { + "target": "com.amazonaws.directoryservice#TrustType", "traits": { - "smithy.api#documentation": "

The reason for the TrustState.

" + "smithy.api#documentation": "

The trust relationship type. Forest is the default.

" } }, "CreatedDateTime": { @@ -6191,22 +6185,16 @@ "smithy.api#documentation": "

Current state of selective authentication for the trust.

" } }, - "StateLastUpdatedDateTime": { - "target": "com.amazonaws.directoryservice#StateLastUpdatedDateTime", - "traits": { - "smithy.api#documentation": "

The date and time that the TrustState was last updated.

" - } - }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

" } }, - "TrustId": { - "target": "com.amazonaws.directoryservice#TrustId", + "TrustDirection": { + "target": "com.amazonaws.directoryservice#TrustDirection", "traits": { - "smithy.api#documentation": "

The unique ID of the trust relationship.

" + "smithy.api#documentation": "

The trust relationship direction.

" } }, "LastUpdatedDateTime": { @@ -6215,16 +6203,28 @@ "smithy.api#documentation": "

The date and time that the trust relationship was last updated.

" } }, - "TrustDirection": { - "target": "com.amazonaws.directoryservice#TrustDirection", + "StateLastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#StateLastUpdatedDateTime", "traits": { - "smithy.api#documentation": "

The trust relationship direction.

" + "smithy.api#documentation": "

The date and time that the TrustState was last updated.

" } }, - "TrustType": { - "target": "com.amazonaws.directoryservice#TrustType", + "TrustId": { + "target": "com.amazonaws.directoryservice#TrustId", "traits": { - "smithy.api#documentation": "

The trust relationship type. Forest is the default.

" + "smithy.api#documentation": "

The unique ID of the trust relationship.

" + } + }, + "TrustStateReason": { + "target": "com.amazonaws.directoryservice#TrustStateReason", + "traits": { + "smithy.api#documentation": "

The reason for the TrustState.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The Directory ID of the AWS directory involved in the trust relationship.

" } } }, @@ -6381,17 +6381,17 @@ "com.amazonaws.directoryservice#UnshareDirectoryRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "UnshareTarget": { + "target": "com.amazonaws.directoryservice#UnshareTarget", "traits": { - "smithy.api#documentation": "

The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.

", + "smithy.api#documentation": "

Identifier for the directory consumer account with whom the directory has to be unshared.

", "smithy.api#required": {} } }, - "UnshareTarget": { - "target": "com.amazonaws.directoryservice#UnshareTarget", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier for the directory consumer account with whom the directory has to be unshared.

", + "smithy.api#documentation": "

The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.

", "smithy.api#required": {} } } @@ -6411,17 +6411,17 @@ "com.amazonaws.directoryservice#UnshareTarget": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.directoryservice#TargetId", + "Type": { + "target": "com.amazonaws.directoryservice#TargetType", "traits": { - "smithy.api#documentation": "

Identifier of the directory consumer account.

", + "smithy.api#documentation": "

Type of identifier to be used in the Id field.

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.directoryservice#TargetType", + "Id": { + "target": "com.amazonaws.directoryservice#TargetId", "traits": { - "smithy.api#documentation": "

Type of identifier to be used in the Id field.

", + "smithy.api#documentation": "

Identifier of the directory consumer account.

", "smithy.api#required": {} } } @@ -6433,11 +6433,11 @@ "com.amazonaws.directoryservice#UnsupportedOperationException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.directoryservice#ExceptionMessage" - }, "RequestId": { "target": "com.amazonaws.directoryservice#RequestId" + }, + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" } }, "traits": { @@ -6480,6 +6480,13 @@ "com.amazonaws.directoryservice#UpdateConditionalForwarderRequest": { "type": "structure", "members": { + "DnsIpAddrs": { + "target": "com.amazonaws.directoryservice#DnsIpAddrs", + "traits": { + "smithy.api#documentation": "

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

", + "smithy.api#required": {} + } + }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { @@ -6493,13 +6500,6 @@ "smithy.api#documentation": "

The directory ID of the AWS directory for which to update the conditional forwarder.

", "smithy.api#required": {} } - }, - "DnsIpAddrs": { - "target": "com.amazonaws.directoryservice#DnsIpAddrs", - "traits": { - "smithy.api#documentation": "

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

", - "smithy.api#required": {} - } } }, "traits": { @@ -6551,17 +6551,17 @@ "com.amazonaws.directoryservice#UpdateNumberOfDomainControllersRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "DesiredNumber": { + "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", "traits": { - "smithy.api#documentation": "

Identifier of the directory to which the domain controllers will be added or removed.

", + "smithy.api#documentation": "

The number of domain controllers desired in the directory.

", "smithy.api#required": {} } }, - "DesiredNumber": { - "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The number of domain controllers desired in the directory.

", + "smithy.api#documentation": "

Identifier of the directory to which the domain controllers will be added or removed.

", "smithy.api#required": {} } } @@ -6658,32 +6658,32 @@ "com.amazonaws.directoryservice#UpdateTrustRequest": { "type": "structure", "members": { - "SelectiveAuth": { - "target": "com.amazonaws.directoryservice#SelectiveAuth", - "traits": { - "smithy.api#documentation": "

Updates selective authentication for the trust.

" - } - }, "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

Identifier of the trust relationship.

", "smithy.api#required": {} } + }, + "SelectiveAuth": { + "target": "com.amazonaws.directoryservice#SelectiveAuth", + "traits": { + "smithy.api#documentation": "

Updates selective authentication for the trust.

" + } } } }, "com.amazonaws.directoryservice#UpdateTrustResult": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.directoryservice#RequestId" - }, "TrustId": { "target": "com.amazonaws.directoryservice#TrustId", "traits": { "smithy.api#documentation": "

Identifier of the trust relationship.

" } + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" } } }, 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 641200b8b91d..6248a5b4c7cf 100644 --- a/codegen/sdk-codegen/aws-models/dlm.2018-01-12.json +++ b/codegen/sdk-codegen/aws-models/dlm.2018-01-12.json @@ -65,7 +65,10 @@ "type": "boolean" }, "com.amazonaws.dlm#CopyTagsNullable": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#box": {} + } }, "com.amazonaws.dlm#Count": { "type": "integer", @@ -96,7 +99,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.

", + "smithy.api#documentation": "

Creates a policy to manage the lifecycle of the specified AWS resources. You can\n\t\t\tcreate up to 100 lifecycle policies.

", "smithy.api#http": { "method": "POST", "uri": "/policies", @@ -110,35 +113,35 @@ "ExecutionRoleArn": { "target": "com.amazonaws.dlm#ExecutionRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by\n\t\t\tthe lifecycle policy.

", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.dlm#PolicyDescription", + "Tags": { + "target": "com.amazonaws.dlm#TagMap", "traits": { - "smithy.api#documentation": "

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to apply to the lifecycle policy during creation.

" } }, - "State": { - "target": "com.amazonaws.dlm#SettablePolicyStateValues", + "PolicyDetails": { + "target": "com.amazonaws.dlm#PolicyDetails", "traits": { - "smithy.api#documentation": "

The desired activation state of the lifecycle policy after creation.

", + "smithy.api#documentation": "

The configuration details of the lifecycle policy.

", "smithy.api#required": {} } }, - "PolicyDetails": { - "target": "com.amazonaws.dlm#PolicyDetails", + "Description": { + "target": "com.amazonaws.dlm#PolicyDescription", "traits": { - "smithy.api#documentation": "

The configuration details of the lifecycle policy.

", + "smithy.api#documentation": "

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are\n\t\t\tsupported.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.dlm#TagMap", + "State": { + "target": "com.amazonaws.dlm#SettablePolicyStateValues", "traits": { - "smithy.api#documentation": "

The tags to apply to the lifecycle policy during creation.

" + "smithy.api#documentation": "

The desired activation state of the lifecycle policy after creation.

", + "smithy.api#required": {} } } } @@ -160,13 +163,13 @@ "Times": { "target": "com.amazonaws.dlm#TimesList", "traits": { - "smithy.api#documentation": "

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon DLM selects a time within the next 24 hours.

" + "smithy.api#documentation": "

The time, in UTC, to start the operation. The supported format is hh:mm.

\n\t\t

The operation occurs within a one-hour window following the specified time. If you do\n\t\t\tnot specify a time, Amazon DLM selects a time within the next 24 hours.

" } }, "CronExpression": { "target": "com.amazonaws.dlm#CronExpression", "traits": { - "smithy.api#documentation": "

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1\n\t\t\tyear. For more information, see Cron\n\t\t\t\texpressions in the Amazon CloudWatch User Guide.

" } }, "IntervalUnit": { @@ -178,12 +181,12 @@ "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { - "smithy.api#documentation": "

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

" + "smithy.api#documentation": "

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and\n\t\t\t24.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies when to create snapshots of EBS volumes.

You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.

" + "smithy.api#documentation": "

Specifies when to create snapshots of EBS volumes.

\n\t\t

You must specify either a Cron expression or an interval, interval unit, and start\n\t\t\ttime. You cannot specify both.

" } }, "com.amazonaws.dlm#CronExpression": { @@ -208,7 +211,7 @@ "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { - "smithy.api#documentation": "

The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

" + "smithy.api#documentation": "

The amount of time to retain each snapshot. The maximum is 100 years. This is\n\t\t\tequivalent to 1200 months, 5200 weeks, or 36500 days.

" } } }, @@ -222,16 +225,10 @@ "Encrypted": { "target": "com.amazonaws.dlm#Encrypted", "traits": { - "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.

", + "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled,\n\t\t\tenable encryption using this parameter. Copies of encrypted snapshots are encrypted,\n\t\t\teven if this parameter is false or if encryption by default is not enabled.

", "smithy.api#required": {} } }, - "RetainRule": { - "target": "com.amazonaws.dlm#CrossRegionCopyRetainRule", - "traits": { - "smithy.api#documentation": "

The retention rule.

" - } - }, "TargetRegion": { "target": "com.amazonaws.dlm#TargetRegion", "traits": { @@ -239,6 +236,12 @@ "smithy.api#required": {} } }, + "RetainRule": { + "target": "com.amazonaws.dlm#CrossRegionCopyRetainRule", + "traits": { + "smithy.api#documentation": "

The retention rule.

" + } + }, "CopyTags": { "target": "com.amazonaws.dlm#CopyTagsNullable", "traits": { @@ -248,7 +251,7 @@ "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.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS\n\t\t\tencryption. If this parameter is not specified, your AWS managed CMK for EBS is\n\t\t\tused.

" } } }, @@ -268,50 +271,6 @@ } } }, - "com.amazonaws.dlm#DLM": { - "type": "service", - "version": "2018-01-12", - "operations": [ - { - "target": "com.amazonaws.dlm#CreateLifecyclePolicy" - }, - { - "target": "com.amazonaws.dlm#DeleteLifecyclePolicy" - }, - { - "target": "com.amazonaws.dlm#GetLifecyclePolicies" - }, - { - "target": "com.amazonaws.dlm#GetLifecyclePolicy" - }, - { - "target": "com.amazonaws.dlm#ListTagsForResource" - }, - { - "target": "com.amazonaws.dlm#TagResource" - }, - { - "target": "com.amazonaws.dlm#UntagResource" - }, - { - "target": "com.amazonaws.dlm#UpdateLifecyclePolicy" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "DLM", - "arnNamespace": "dlm", - "cloudFormationName": "DLM", - "cloudTrailEventSource": "dlm.amazonaws.com" - }, - "aws.auth#sigv4": { - "name": "dlm" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Data Lifecycle Manager

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle in the Amazon EC2 User Guide.

", - "smithy.api#title": "Amazon Data Lifecycle Manager" - } - }, "com.amazonaws.dlm#DeleteLifecyclePolicy": { "type": "operation", "input": { @@ -332,7 +291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

", + "smithy.api#documentation": "

Deletes the specified lifecycle policy and halts the automated operations that the\n\t\t\tpolicy specified.

", "smithy.api#http": { "method": "DELETE", "uri": "/policies/{PolicyId}", @@ -358,7 +317,10 @@ "members": {} }, "com.amazonaws.dlm#Encrypted": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#box": {} + } }, "com.amazonaws.dlm#ErrorCode": { "type": "string" @@ -367,7 +329,10 @@ "type": "string" }, "com.amazonaws.dlm#ExcludeBootVolume": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#box": {} + } }, "com.amazonaws.dlm#ExecutionRoleArn": { "type": "string", @@ -397,7 +362,7 @@ "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { - "smithy.api#documentation": "

The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

" + "smithy.api#documentation": "

The amount of time to enable fast snapshot restore. The maximum is 100 years. This is\n\t\t\tequivalent to 1200 months, 5200 weeks, or 36500 days.

" } }, "AvailabilityZones": { @@ -409,7 +374,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval.

" + "smithy.api#documentation": "

Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot\n\t\t\trestore based on either a count or a time interval.

" } }, "com.amazonaws.dlm#GetLifecyclePolicies": { @@ -435,7 +400,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

", + "smithy.api#documentation": "

Gets summary information about all or the specified data lifecycle policies.

\n\t\t

To get complete information about a policy, use GetLifecyclePolicy.

", "smithy.api#http": { "method": "GET", "uri": "/policies", @@ -453,11 +418,11 @@ "smithy.api#httpQuery": "resourceTypes" } }, - "TargetTags": { - "target": "com.amazonaws.dlm#TargetTagsFilterList", + "TagsToAdd": { + "target": "com.amazonaws.dlm#TagsToAddFilterList", "traits": { - "smithy.api#documentation": "

The target tag for a policy.

Tags are strings in the format key=value.

", - "smithy.api#httpQuery": "targetTags" + "smithy.api#documentation": "

The tags to add to objects created by the policy.

\n\t\t

Tags are strings in the format key=value.

\n\t\t

These user-defined tags are added in addition to the AWS-added lifecycle tags.

", + "smithy.api#httpQuery": "tagsToAdd" } }, "PolicyIds": { @@ -467,11 +432,11 @@ "smithy.api#httpQuery": "policyIds" } }, - "TagsToAdd": { - "target": "com.amazonaws.dlm#TagsToAddFilterList", + "TargetTags": { + "target": "com.amazonaws.dlm#TargetTagsFilterList", "traits": { - "smithy.api#documentation": "

The tags to add to objects created by the policy.

Tags are strings in the format key=value.

These user-defined tags are added in addition to the AWS-added lifecycle tags.

", - "smithy.api#httpQuery": "tagsToAdd" + "smithy.api#documentation": "

The target tag for a policy.

\n\t\t

Tags are strings in the format key=value.

", + "smithy.api#httpQuery": "targetTags" } }, "State": { @@ -609,9 +574,6 @@ "smithy.api#documentation": "

The request included parameters that cannot be provided together.

" } }, - "Code": { - "target": "com.amazonaws.dlm#ErrorCode" - }, "RequiredParameters": { "target": "com.amazonaws.dlm#ParameterList", "traits": { @@ -620,10 +582,13 @@ }, "Message": { "target": "com.amazonaws.dlm#ErrorMessage" + }, + "Code": { + "target": "com.amazonaws.dlm#ErrorCode" } }, "traits": { - "smithy.api#documentation": "

Bad request. The request is missing required parameters or has invalid parameters.

", + "smithy.api#documentation": "

Bad request. The request is missing required parameters or has invalid\n\t\t\tparameters.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -637,10 +602,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" } }, - "PolicyId": { - "target": "com.amazonaws.dlm#PolicyId", + "Description": { + "target": "com.amazonaws.dlm#PolicyDescription", "traits": { - "smithy.api#documentation": "

The identifier of the lifecycle policy.

" + "smithy.api#documentation": "

The description of the lifecycle policy.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.dlm#StatusMessage", + "traits": { + "smithy.api#documentation": "

The description of the status.

" } }, "DateModified": { @@ -649,10 +620,10 @@ "smithy.api#documentation": "

The local date and time when the lifecycle policy was last modified.

" } }, - "StatusMessage": { - "target": "com.amazonaws.dlm#StatusMessage", + "PolicyId": { + "target": "com.amazonaws.dlm#PolicyId", "traits": { - "smithy.api#documentation": "

The description of the status.

" + "smithy.api#documentation": "

The identifier of the lifecycle policy.

" } }, "Tags": { @@ -661,10 +632,10 @@ "smithy.api#documentation": "

The tags.

" } }, - "ExecutionRoleArn": { - "target": "com.amazonaws.dlm#ExecutionRoleArn", + "PolicyDetails": { + "target": "com.amazonaws.dlm#PolicyDetails", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

" + "smithy.api#documentation": "

The configuration of the lifecycle policy

" } }, "State": { @@ -673,22 +644,16 @@ "smithy.api#documentation": "

The activation state of the lifecycle policy.

" } }, - "DateCreated": { - "target": "com.amazonaws.dlm#Timestamp", - "traits": { - "smithy.api#documentation": "

The local date and time when the lifecycle policy was created.

" - } - }, - "PolicyDetails": { - "target": "com.amazonaws.dlm#PolicyDetails", + "ExecutionRoleArn": { + "target": "com.amazonaws.dlm#ExecutionRoleArn", "traits": { - "smithy.api#documentation": "

The configuration of the lifecycle policy

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by\n\t\t\tthe lifecycle policy.

" } }, - "Description": { - "target": "com.amazonaws.dlm#PolicyDescription", + "DateCreated": { + "target": "com.amazonaws.dlm#Timestamp", "traits": { - "smithy.api#documentation": "

The description of the lifecycle policy.

" + "smithy.api#documentation": "

The local date and time when the lifecycle policy was created.

" } } }, @@ -699,12 +664,6 @@ "com.amazonaws.dlm#LifecyclePolicySummary": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.dlm#PolicyDescription", - "traits": { - "smithy.api#documentation": "

The description of the lifecycle policy.

" - } - }, "Tags": { "target": "com.amazonaws.dlm#TagMap", "traits": { @@ -722,6 +681,12 @@ "traits": { "smithy.api#documentation": "

The activation state of the lifecycle policy.

" } + }, + "Description": { + "target": "com.amazonaws.dlm#PolicyDescription", + "traits": { + "smithy.api#documentation": "

The description of the lifecycle policy.

" + } } }, "traits": { @@ -737,6 +702,9 @@ "com.amazonaws.dlm#LimitExceededException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.dlm#ErrorMessage" + }, "Code": { "target": "com.amazonaws.dlm#ErrorCode" }, @@ -745,9 +713,6 @@ "traits": { "smithy.api#documentation": "

Value is the type of resource for which a limit was exceeded.

" } - }, - "Message": { - "target": "com.amazonaws.dlm#ErrorMessage" } }, "traits": { @@ -823,12 +788,12 @@ "ExcludeBootVolume": { "target": "com.amazonaws.dlm#ExcludeBootVolume", "traits": { - "smithy.api#documentation": "

[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.

" + "smithy.api#documentation": "

[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the\n\t\t\troot volume from snapshots created using CreateSnapshots.\n\t\t\tThe default is false.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type.

" + "smithy.api#documentation": "

Specifies optional parameters to add to a policy. The set of valid parameters depends\n\t\t\ton the combination of policy type and resource type.

" } }, "com.amazonaws.dlm#PolicyArn": { @@ -863,19 +828,19 @@ "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 resource type. Use VOLUME to create snapshots of individual volumes or use\n\t\t\tINSTANCE to create multi-volume snapshots from the volumes for an instance.

" } }, "PolicyType": { "target": "com.amazonaws.dlm#PolicyTypeValues", "traits": { - "smithy.api#documentation": "

The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.

" + "smithy.api#documentation": "

The valid target resource types and actions a policy can manage. The default is\n\t\t\tEBS_SNAPSHOT_MANAGEMENT.

" } }, "Schedules": { "target": "com.amazonaws.dlm#ScheduleList", "traits": { - "smithy.api#documentation": "

The schedule of policy-defined actions.

" + "smithy.api#documentation": "

The schedules of policy-defined actions. A policy can have up to four schedules - one\n\t\t\tmandatory schedule and up to three optional schedules.

" } }, "TargetTags": { @@ -919,23 +884,23 @@ "com.amazonaws.dlm#ResourceNotFoundException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.dlm#ErrorCode" - }, "ResourceIds": { "target": "com.amazonaws.dlm#PolicyIdList", "traits": { "smithy.api#documentation": "

Value is a list of resource IDs that were not found.

" } }, - "Message": { - "target": "com.amazonaws.dlm#ErrorMessage" - }, "ResourceType": { "target": "com.amazonaws.dlm#String", "traits": { "smithy.api#documentation": "

Value is the type of resource that was not found.

" } + }, + "Code": { + "target": "com.amazonaws.dlm#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.dlm#ErrorMessage" } }, "traits": { @@ -980,21 +945,21 @@ "smithy.api#documentation": "

The unit of time for time-based retention.

" } }, - "Count": { - "target": "com.amazonaws.dlm#Count", + "Interval": { + "target": "com.amazonaws.dlm#Interval", "traits": { - "smithy.api#documentation": "

The number of snapshots to retain for each volume, up to a maximum of 1000.

" + "smithy.api#documentation": "

The amount of time to retain each snapshot. The maximum is 100 years. This is\n\t\t\tequivalent to 1200 months, 5200 weeks, or 36500 days.

" } }, - "Interval": { - "target": "com.amazonaws.dlm#Interval", + "Count": { + "target": "com.amazonaws.dlm#Count", "traits": { - "smithy.api#documentation": "

The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

" + "smithy.api#documentation": "

The number of snapshots to retain for each volume, up to a maximum of 1000.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval.

" + "smithy.api#documentation": "

Specifies the retention rule for a lifecycle policy. You can retain snapshots based on\n\t\t\teither a count or a time interval.

" } }, "com.amazonaws.dlm#RetentionIntervalUnitValues": { @@ -1032,13 +997,13 @@ "CopyTags": { "target": "com.amazonaws.dlm#CopyTags", "traits": { - "smithy.api#documentation": "

Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

" + "smithy.api#documentation": "

Copy all user-defined tags on a source volume to snapshots of the volume created by\n\t\t\tthis policy.

" } }, - "Name": { - "target": "com.amazonaws.dlm#ScheduleName", + "RetainRule": { + "target": "com.amazonaws.dlm#RetainRule", "traits": { - "smithy.api#documentation": "

The name of the schedule.

" + "smithy.api#documentation": "

The retention rule.

" } }, "FastRestoreRule": { @@ -1047,22 +1012,16 @@ "smithy.api#documentation": "

The rule for enabling fast snapshot restore.

" } }, - "RetainRule": { - "target": "com.amazonaws.dlm#RetainRule", - "traits": { - "smithy.api#documentation": "

The retention rule.

" - } - }, - "TagsToAdd": { - "target": "com.amazonaws.dlm#TagsToAddList", + "Name": { + "target": "com.amazonaws.dlm#ScheduleName", "traits": { - "smithy.api#documentation": "

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

" + "smithy.api#documentation": "

The name of the schedule.

" } }, "VariableTags": { "target": "com.amazonaws.dlm#VariableTagsList", "traits": { - "smithy.api#documentation": "

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.

" + "smithy.api#documentation": "

A collection of key/value pairs with values determined dynamically when the policy is\n\t\t\texecuted. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two\n\t\t\tfollowing formats: $(instance-id) or $(timestamp). Variable\n\t\t\ttags are only valid for EBS Snapshot Management – Instance policies.

" } }, "CreateRule": { @@ -1070,6 +1029,12 @@ "traits": { "smithy.api#documentation": "

The creation rule.

" } + }, + "TagsToAdd": { + "target": "com.amazonaws.dlm#TagsToAddList", + "traits": { + "smithy.api#documentation": "

The tags to apply to policy-created resources. These user-defined tags are in addition\n\t\t\tto the AWS-added lifecycle tags.

" + } } }, "traits": { @@ -1084,7 +1049,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1 + "max": 4 } } }, @@ -1345,10 +1310,7 @@ } }, "com.amazonaws.dlm#Timestamp": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } + "type": "timestamp" }, "com.amazonaws.dlm#UntagResource": { "type": "operation", @@ -1381,14 +1343,6 @@ "com.amazonaws.dlm#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.dlm#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.dlm#PolicyArn", "traits": { @@ -1396,6 +1350,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TagKeys": { + "target": "com.amazonaws.dlm#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -1437,6 +1399,12 @@ "com.amazonaws.dlm#UpdateLifecyclePolicyRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.dlm#PolicyDescription", + "traits": { + "smithy.api#documentation": "

A description of the lifecycle policy.

" + } + }, "PolicyId": { "target": "com.amazonaws.dlm#PolicyId", "traits": { @@ -1454,19 +1422,13 @@ "PolicyDetails": { "target": "com.amazonaws.dlm#PolicyDetails", "traits": { - "smithy.api#documentation": "

The configuration of the lifecycle policy. You cannot update the policy type or the resource type.

" - } - }, - "Description": { - "target": "com.amazonaws.dlm#PolicyDescription", - "traits": { - "smithy.api#documentation": "

A description of the lifecycle policy.

" + "smithy.api#documentation": "

The configuration of the lifecycle policy. You cannot update the policy type or the\n\t\t\tresource type.

" } }, "ExecutionRoleArn": { "target": "com.amazonaws.dlm#ExecutionRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by\n\t\t\tthe lifecycle policy.

" } } } @@ -1486,6 +1448,50 @@ "max": 45 } } + }, + "com.amazonaws.dlm#dlm_20180112": { + "type": "service", + "version": "2018-01-12", + "operations": [ + { + "target": "com.amazonaws.dlm#CreateLifecyclePolicy" + }, + { + "target": "com.amazonaws.dlm#DeleteLifecyclePolicy" + }, + { + "target": "com.amazonaws.dlm#GetLifecyclePolicies" + }, + { + "target": "com.amazonaws.dlm#GetLifecyclePolicy" + }, + { + "target": "com.amazonaws.dlm#ListTagsForResource" + }, + { + "target": "com.amazonaws.dlm#TagResource" + }, + { + "target": "com.amazonaws.dlm#UntagResource" + }, + { + "target": "com.amazonaws.dlm#UpdateLifecyclePolicy" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "DLM", + "arnNamespace": "dlm", + "cloudFormationName": "DLM", + "cloudTrailEventSource": "dlm.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "dlm" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Data Lifecycle Manager\n\t\t

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create\n\t\t\tlifecycle policies, which are used to automate operations on the specified\n\t\t\tresources.

\n\t\t

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM\n\t\t\twith Amazon EBS, see Automating the Amazon EBS\n\t\t\t\tSnapshot Lifecycle in the Amazon EC2 User Guide.

", + "smithy.api#title": "Amazon Data Lifecycle Manager" + } } } } 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 f15a89c438d3..a6b383df4ebb 100644 --- a/codegen/sdk-codegen/aws-models/docdb.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/docdb.2014-10-31.json @@ -46,29 +46,29 @@ } ], "traits": { - "smithy.api#documentation": "

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation\n reporting to track costs that are associated with Amazon DocumentDB resources. or in a\n Condition statement in an AWS Identity and Access Management (IAM)\n policy for Amazon DocumentDB.

" + "smithy.api#documentation": "

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags \n with cost allocation reporting to track costs that are associated \n with Amazon DocumentDB resources. or in a Condition statement in \n an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

" } }, "com.amazonaws.docdb#AddTagsToResourceMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.docdb#TagList", + "ResourceName": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the Amazon DocumentDB resource.

", + "smithy.api#documentation": "

The Amazon DocumentDB resource that the tags are added to. This value is an\n Amazon Resource Name .

", "smithy.api#required": {} } }, - "ResourceName": { - "target": "com.amazonaws.docdb#String", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name\n (ARN).

", + "smithy.api#documentation": "

The tags to be assigned to the Amazon DocumentDB resource.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the input to AddTagsToResource.

" + "smithy.api#documentation": "

Represents the input to AddTagsToResource.\n

" } }, "com.amazonaws.docdb#AmazonRDSv19": { @@ -253,36 +253,36 @@ } ], "traits": { - "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, to a DB\n instance).

" + "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, \n to an Amazon DocumentDB instance).

" } }, "com.amazonaws.docdb#ApplyPendingMaintenanceActionMessage": { "type": "structure", "members": { - "ApplyAction": { + "OptInType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade\n

", + "smithy.api#documentation": "

A value that specifies the type of opt-in request or undoes an \n opt-in request. An opt-in request of type immediate \n can't be undone.

\n

Valid values:

\n ", "smithy.api#required": {} } }, - "OptInType": { + "ApplyAction": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A value that specifies the type of opt-in request or undoes an opt-in request. An\n opt-in request of type immediate can't be undone.

\n

Valid values:

\n ", + "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade\n

", "smithy.api#required": {} } }, "ResourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that the pending maintenance action\n applies to.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that the pending \n maintenance action applies to.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the input to ApplyPendingMaintenanceAction.

" + "smithy.api#documentation": "

Represents the input to ApplyPendingMaintenanceAction.\n

" } }, "com.amazonaws.docdb#ApplyPendingMaintenanceActionResult": { @@ -359,10 +359,16 @@ "com.amazonaws.docdb#Certificate": { "type": "structure", "members": { - "CertificateIdentifier": { + "CertificateType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The unique key that identifies a certificate.

\n

Example: rds-ca-2019\n

" + "smithy.api#documentation": "

The type of the certificate.

\n

Example: CA\n

" + } + }, + "CertificateArn": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

\n

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019\n

" } }, "Thumbprint": { @@ -371,6 +377,12 @@ "smithy.api#documentation": "

The thumbprint of the certificate.

" } }, + "CertificateIdentifier": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The unique key that identifies a certificate.

\n

Example: rds-ca-2019\n

" + } + }, "ValidTill": { "target": "com.amazonaws.docdb#TStamp", "traits": { @@ -382,18 +394,6 @@ "traits": { "smithy.api#documentation": "

The starting date-time from which the certificate is valid.

\n

Example: 2019-07-31T17:57:09Z\n

" } - }, - "CertificateType": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The type of the certificate.

\n

Example: CA\n

" - } - }, - "CertificateArn": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

\n

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019\n

" - } } }, "traits": { @@ -412,17 +412,17 @@ "com.amazonaws.docdb#CertificateMessage": { "type": "structure", "members": { - "Certificates": { - "target": "com.amazonaws.docdb#CertificateList", - "traits": { - "smithy.api#documentation": "

A list of certificates for this AWS account.

" - } - }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided if the number of records retrieved is greater than\n MaxRecords. If this parameter is specified, the marker specifies the next record\n in the list. Including the value of Marker in the next call to \n DescribeCertificates results in the next page of certificates.

" } + }, + "Certificates": { + "target": "com.amazonaws.docdb#CertificateList", + "traits": { + "smithy.api#documentation": "

A list of certificates for this AWS account.

" + } } } }, @@ -485,23 +485,17 @@ "com.amazonaws.docdb#CopyDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.docdb#TagList", - "traits": { - "smithy.api#documentation": "

The tags that are to be assigned to the parameter group.

" - } - }, "SourceDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source cluster parameter\n group.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source cluster\n parameter group.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "TargetDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The identifier for the copied cluster parameter group.

\n

Constraints:

\n \n

Example: my-cluster-param-group1\n

", + "smithy.api#documentation": "

The identifier for the copied cluster parameter group.

\n

Constraints:

\n \n

Example: my-cluster-param-group1\n

", "smithy.api#required": {} } }, @@ -511,10 +505,16 @@ "smithy.api#documentation": "

A description for the copied cluster parameter group.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.docdb#TagList", + "traits": { + "smithy.api#documentation": "

The tags that are to be assigned to the parameter group.

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the input to CopyDBClusterParameterGroup.

" + "smithy.api#documentation": "

Represents the input to CopyDBClusterParameterGroup.\n

" } }, "com.amazonaws.docdb#CopyDBClusterParameterGroupResult": { @@ -554,53 +554,53 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a snapshot of a cluster.

\n

To copy a cluster snapshot from a shared manual cluster snapshot,\n SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name\n (ARN) of the shared cluster snapshot.

\n

To cancel the copy operation after it is in progress, delete the target cluster\n snapshot identified by TargetDBClusterSnapshotIdentifier while that DB\n cluster snapshot is in the copying status.

" + "smithy.api#documentation": "

Copies a snapshot of a cluster.

\n \n

To copy a cluster snapshot from a shared manual cluster snapshot,\n SourceDBClusterSnapshotIdentifier must be the Amazon \n Resource Name (ARN) of the shared cluster snapshot. You can only \n copy a shared DB cluster snapshot, whether encrypted or not, in the \n same AWS Region.

\n \n

To cancel the copy operation after it is in progress, delete the \n target cluster snapshot identified by \n TargetDBClusterSnapshotIdentifier while that cluster \n snapshot is in the copying status.

" } }, "com.amazonaws.docdb#CopyDBClusterSnapshotMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.docdb#TagList", + "SourceDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the cluster snapshot.

" + "smithy.api#documentation": "

The identifier of the cluster snapshot to copy. This parameter is\n not case sensitive.

\n \n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", + "smithy.api#required": {} } }, - "CopyTags": { - "target": "com.amazonaws.docdb#BooleanOptional", + "KmsKeyId": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Set to true to copy all tags from the source cluster snapshot to the\n target cluster snapshot, and otherwise false. The default is\n false.

" + "smithy.api#documentation": "

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS\n key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or\n the AWS KMS key alias for the AWS KMS encryption key.

\n \n

If you copy an encrypted cluster snapshot from your AWS account, \n you can specify a value for KmsKeyId to encrypt the \n copy with a new AWS KMS encryption key. If you don't specify a value\n for KmsKeyId, then the copy of the cluster snapshot is \n encrypted with the same AWS KMS key as the source cluster snapshot.\n

\n \n

If you copy an encrypted cluster snapshot that is shared from \n another AWS account, then you must specify a value for \n KmsKeyId.

\n \n \n

To copy an encrypted cluster snapshot to another AWS Region, set\n KmsKeyId to the AWS KMS key ID that you want to use to \n encrypt the copy of the cluster snapshot in the destination Region. \n AWS KMS encryption keys are specific to the AWS Region that they are \n created in, and you can't use encryption keys from one AWS Region in \n another AWS Region.

\n \n

If you copy an unencrypted cluster snapshot and specify a value \n for the KmsKeyId parameter, an error is returned.

" } }, - "KmsKeyId": { + "PreSignedUrl": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the\n Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS\n KMS encryption key.

\n

If you copy an encrypted cluster snapshot from your AWS account, you can specify a\n value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key.\n If you don't specify a value for KmsKeyId, then the copy of the cluster\n snapshot is encrypted with the same AWS KMS key as the source cluster snapshot.

\n

If you copy an encrypted cluster snapshot that is shared from another AWS account,\n then you must specify a value for KmsKeyId.

\n

To copy an encrypted cluster snapshot to another AWS Region, set\n KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy\n of the cluster snapshot in the destination Region. AWS KMS encryption keys are\n specific to the AWS Region that they are created in, and you can't use encryption keys\n from one Region in another Region.

\n

If you copy an unencrypted cluster snapshot and specify a value for the\n KmsKeyId parameter, an error is returned.

" + "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API action in the AWS Region that \n contains the source cluster snapshot to copy. You must use the \n PreSignedUrl parameter when copying a cluster snapshot\n from another AWS Region.

\n \n

If you are using an AWS SDK tool or the AWS CLI, you can specify \n SourceRegion (or --source-region for the\n AWS CLI) instead of specifying PreSignedUrl manually. \n Specifying SourceRegion autogenerates a pre-signed URL \n that is a valid request for the operation that can be executed in\n the source AWS Region.

\n \n

The presigned URL must be a valid request for the \n CopyDBClusterSnapshot API action that can be executed \n in the source AWS Region that contains the cluster snapshot to be \n copied. The presigned URL request must contain the following\n parameter values:

\n " } }, - "SourceDBClusterSnapshotIdentifier": { + "TargetDBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The identifier of the cluster snapshot to copy. This parameter is not case\n sensitive.

\n

You can't copy an encrypted, shared cluster snapshot from one AWS Region to\n another.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", + "smithy.api#documentation": "

The identifier of the new cluster snapshot to create from the \n source cluster snapshot. This parameter is not case sensitive.

\n

Constraints:

\n \n

Example: my-cluster-snapshot2\n

", "smithy.api#required": {} } }, - "PreSignedUrl": { - "target": "com.amazonaws.docdb#String", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API action in the AWS Region that contains the\n source cluster snapshot to copy. You must use the PreSignedUrl parameter\n when copying an encrypted cluster snapshot from another AWS Region.

\n

The presigned URL must be a valid request for the CopyDBSClusterSnapshot\n API action that can be executed in the source AWS Region that contains the encrypted DB\n cluster snapshot to be copied. The presigned URL request must contain the following\n parameter values:

\n " + "smithy.api#documentation": "

The tags to be assigned to the cluster snapshot.

" } }, - "TargetDBClusterSnapshotIdentifier": { - "target": "com.amazonaws.docdb#String", + "CopyTags": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

The identifier of the new cluster snapshot to create from the source cluster\n snapshot. This parameter is not case sensitive.

\n

Constraints:

\n \n

Example: my-cluster-snapshot2\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Set to true to copy all tags from the source cluster \n snapshot to the target cluster snapshot, and otherwise \n false. The default is false.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input to CopyDBClusterSnapshot.

" + "smithy.api#documentation": "

Represents the input to CopyDBClusterSnapshot.\n

" } }, "com.amazonaws.docdb#CopyDBClusterSnapshotResult": { @@ -673,121 +673,127 @@ "com.amazonaws.docdb#CreateDBClusterMessage": { "type": "structure", "members": { - "DBSubnetGroupName": { + "AvailabilityZones": { + "target": "com.amazonaws.docdb#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 Availability Zones that instances in the \n cluster can be created in.

" + } + }, + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A subnet group to associate with this cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not\n be default.

\n

Example: mySubnetgroup\n

" + "smithy.api#documentation": "

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

" } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.docdb#LogTypeList", "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this cluster.

" + "smithy.api#documentation": "

A list of log types that need to be enabled for exporting to Amazon \n CloudWatch Logs. You can enable audit logs or profiler logs. For more \n information, see \n Auditing Amazon DocumentDB Events \n and \n Profiling Amazon DocumentDB Operations.\n

" } }, - "Tags": { - "target": "com.amazonaws.docdb#TagList", + "Engine": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the cluster.

" + "smithy.api#documentation": "

The name of the database engine to be used for this cluster.

\n

Valid values: docdb\n

", + "smithy.api#required": {} } }, - "AvailabilityZones": { - "target": "com.amazonaws.docdb#AvailabilityZones", + "Port": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 Availability Zones that instances in the cluster can be\n created in.

" + "smithy.api#documentation": "

The port number on which the instances in the cluster accept \n connections.

" } }, - "MasterUserPassword": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable\n ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol\n (@).

\n

Constraints: Must contain from 8 to 100 characters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the cluster parameter group to associate with this \n cluster.

" } }, - "Engine": { + "MasterUserPassword": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this cluster.

\n

Valid values: docdb\n

", + "smithy.api#documentation": "

The password for the master database user. This password can \n contain any printable ASCII character except forward slash (/), \n double quote (\"), or the \"at\" symbol (@).

\n

Constraints: Must contain from 8 to 100 characters.

", "smithy.api#required": {} } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.docdb#LogTypeList", + "BackupRetentionPeriod": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

A list of log types that need to be enabled for exporting to Amazon CloudWatch\n Logs.

" + "smithy.api#documentation": "

The number of days for which automated backups are retained. You \n must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " } }, - "DeletionProtection": { - "target": "com.amazonaws.docdb#BooleanOptional", + "PreSignedUrl": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

" + "smithy.api#documentation": "

Not currently supported.\n

" } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.docdb#IntegerOptional", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. You must specify a\n minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " + "smithy.api#documentation": "

The tags to be assigned to the cluster.

" } }, - "DBClusterIdentifier": { + "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The daily time range during which automated backups are created if\n automated backups are enabled using the \n BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour\n block of time for each AWS Region.

\n

Constraints:

\n " } }, - "MasterUsername": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the master user for the cluster.

\n

Constraints:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, \n in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour\n block of time for each AWS Region, occurring on a random day of the \n week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, - "DBClusterParameterGroupName": { + "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the cluster parameter group to associate with this cluster.

" + "smithy.api#documentation": "

A subnet group to associate with this cluster.

\n

Constraints: Must match the name of an existing \n DBSubnetGroup. Must not be default.

\n

Example: mySubnetgroup\n

" } }, - "KmsKeyId": { - "target": "com.amazonaws.docdb#String", + "DeletionProtection": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted cluster.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS\n encryption key. If you are creating a cluster using the same AWS account that owns\n the AWS KMS encryption key that is used to encrypt the new cluster, you can use the\n AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

\n

If an encryption key is not specified in KmsKeyId:

\n \n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has\n a different default encryption key for each AWS Region.

\n

If you create a replica of an encrypted cluster in another AWS Region, you must set\n KmsKeyId to a KMS key ID that is valid in the destination AWS Region.\n This key is used to encrypt the replica in that AWS Region.

" + "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If \n DeletionProtection is enabled, the cluster cannot be \n deleted unless it is modified and DeletionProtection is \n disabled. DeletionProtection protects clusters from \n being accidentally deleted.

" } }, - "Port": { - "target": "com.amazonaws.docdb#IntegerOptional", + "MasterUsername": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The port number on which the instances in the cluster accept connections.

" + "smithy.api#documentation": "

The name of the master user for the cluster.

\n

Constraints:

\n ", + "smithy.api#required": {} } }, - "EngineVersion": { + "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

" + "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n \n

Example: my-cluster\n

", + "smithy.api#required": {} } }, - "StorageEncrypted": { - "target": "com.amazonaws.docdb#BooleanOptional", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

Specifies whether the cluster is encrypted.

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this cluster.\n

" } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.docdb#String", + "StorageEncrypted": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups\n are enabled using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region.

\n

Constraints:

\n " + "smithy.api#documentation": "

Specifies whether the cluster is encrypted.

" } }, - "PreferredMaintenanceWindow": { + "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted cluster.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for \n the AWS KMS encryption key. If you are creating a cluster using the\n same AWS account that owns the AWS KMS encryption key that is used \n to encrypt the new cluster, you can use the AWS KMS key alias \n instead of the ARN for the AWS KMS encryption key.

\n

If an encryption key is not specified in KmsKeyId:\n

\n \n

AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS \n Region.

\n

If you create a replica of an encrypted cluster in another AWS \n Region, you must set KmsKeyId to a KMS key ID that is\n valid in the destination AWS Region. This key is used to encrypt the \n replica in that AWS Region.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input to CreateDBCluster.

" + "smithy.api#documentation": "

Represents the input to CreateDBCluster.\n

" } }, "com.amazonaws.docdb#CreateDBClusterParameterGroup": { @@ -807,37 +813,37 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new cluster parameter group.

\n

Parameters in a cluster parameter group apply to all of the instances in a DB\n cluster.

\n

A cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the cluster. To provide custom values for any of\n the parameters, you must modify the group after you create it. After you create a DB\n cluster parameter group, you must associate it with your cluster. For the new DB\n cluster parameter group and associated settings to take effect, you must then reboot the\n instances in the cluster without failover.

\n \n

After you create a cluster parameter group, you should wait at least 5 minutes\n before creating your first cluster that uses that cluster parameter group as\n the default parameter group. This allows Amazon DocumentDB to fully complete the create action\n before the cluster parameter group is used as the default for a new cluster.\n This step is especially important for parameters that are critical when creating the\n default database for a cluster, such as the character set for the default\n database defined by the character_set_database parameter.

\n " + "smithy.api#documentation": "

Creates a new cluster parameter group.

\n

Parameters in a cluster parameter group apply to all of the \n instances in a cluster.

\n

A cluster parameter group is initially created with the default \n parameters for the database engine used by instances in the cluster.\n In Amazon DocumentDB, you cannot make modifications directly to the \n default.docdb3.6 cluster parameter group. If your \n Amazon DocumentDB cluster is using the default cluster parameter group and you\n want to modify a value in it, you must first \n create a new parameter group\n or \n copy an existing parameter group,\n modify it, and then apply the modified parameter group to your \n cluster. For the new cluster parameter group and associated settings\n to take effect, you must then reboot the instances in the cluster \n without failover. For more information,\n see \n Modifying Amazon DocumentDB Cluster Parameter Groups.\n

" } }, "com.amazonaws.docdb#CreateDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Description": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The description for the cluster parameter group.

", + "smithy.api#documentation": "

The name of the cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.docdb#TagList", + "DBParameterGroupFamily": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the cluster parameter group.

" + "smithy.api#documentation": "

The cluster parameter group family name.

", + "smithy.api#required": {} } }, - "DBClusterParameterGroupName": { + "Description": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#documentation": "

The description for the cluster parameter group.

", "smithy.api#required": {} } }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.docdb#String", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

The cluster parameter group family name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to be assigned to the cluster parameter group.

" } } }, @@ -893,24 +899,24 @@ "com.amazonaws.docdb#CreateDBClusterSnapshotMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.docdb#TagList", + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the cluster snapshot.

" + "smithy.api#documentation": "

The identifier of the cluster snapshot. This parameter is stored \n as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", + "smithy.api#required": {} } }, "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The identifier of the cluster to create a snapshot for. This parameter is not case\n sensitive.

\n

Constraints:

\n \n

Example: my-cluster\n

", + "smithy.api#documentation": "

The identifier of the cluster to create a snapshot for. This \n parameter is not case sensitive.

\n

Constraints:

\n \n

Example: my-cluster\n

", "smithy.api#required": {} } }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.docdb#String", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

The identifier of the cluster snapshot. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to be assigned to the cluster snapshot.

" } } }, @@ -988,6 +994,13 @@ "com.amazonaws.docdb#CreateDBInstanceMessage": { "type": "structure", "members": { + "Engine": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid value: docdb\n

", + "smithy.api#required": {} + } + }, "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { @@ -1001,29 +1014,29 @@ "smithy.api#required": {} } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.docdb#BooleanOptional", + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates that minor engine upgrades are applied automatically to the instance\n during the maintenance window.

\n

Default: true\n

" + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, - "Tags": { - "target": "com.amazonaws.docdb#TagList", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the instance. You can assign up to \n 10 tags to an instance.

" + "smithy.api#documentation": "

Indicates that minor engine upgrades are applied automatically to the instance\n during the maintenance window.

\n

Default: true\n

" } }, - "Engine": { + "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid value: docdb\n

", + "smithy.api#documentation": "

The instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", "smithy.api#required": {} } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.docdb#String", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The tags to be assigned to the instance. You can assign up to \n 10 tags to an instance.

" } }, "DBClusterIdentifier": { @@ -1036,14 +1049,7 @@ "AvailabilityZone": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 Availability Zone that the instance is created in.

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS\n Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the\n MultiAZ parameter is set to true. The specified\n Availability Zone must be in the same AWS Region as the current endpoint.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon EC2 Availability Zone that the instance is created in.

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

Example: us-east-1d\n

" } } }, @@ -1098,12 +1104,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.docdb#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the subnet group.

" - } - }, "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { @@ -1117,6 +1117,12 @@ "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the subnet group.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.docdb#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the subnet group.

" + } } }, "traits": { @@ -1134,58 +1140,58 @@ "com.amazonaws.docdb#DBCluster": { "type": "structure", "members": { - "LatestRestorableTime": { - "target": "com.amazonaws.docdb#TStamp", + "StorageEncrypted": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" + "smithy.api#documentation": "

Specifies whether the cluster is encrypted.

" } }, - "ReaderEndpoint": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The reader endpoint for the cluster. The reader endpoint for a cluster load\n balances connections across the Amazon DocumentDB replicas that are available in a cluster. As\n clients request new connections to the reader endpoint, Amazon DocumentDB distributes the\n connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can\n help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

\n

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to\n be the primary instance, your connection is dropped. To continue sending your read\n workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader\n endpoint.

" + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.docdb#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that this cluster is configured to export to Amazon CloudWatch\n Logs.

" } }, - "Engine": { - "target": "com.amazonaws.docdb#String", + "Port": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

Provides the name of the database engine to be used for this cluster.

" + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" } }, - "DeletionProtection": { - "target": "com.amazonaws.docdb#Boolean", + "ClusterCreateTime": { + "target": "com.amazonaws.docdb#TStamp", "traits": { - "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

" + "smithy.api#documentation": "

Specifies the time when the cluster was created, in Universal Coordinated Time\n (UTC).

" } }, - "HostedZoneId": { - "target": "com.amazonaws.docdb#String", + "BackupRetentionPeriod": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + "smithy.api#documentation": "

Specifies the number of days for which automatic snapshots are retained.

" } }, - "AvailabilityZones": { - "target": "com.amazonaws.docdb#AvailabilityZones", + "MasterUsername": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the cluster\n can be created in.

" + "smithy.api#documentation": "

Contains the master user name for the cluster.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.docdb#String", + "DBClusterMembers": { + "target": "com.amazonaws.docdb#DBClusterMemberList", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster.

" + "smithy.api#documentation": "

Provides the list of instances that make up the cluster.

" } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.docdb#String", + "MultiAZ": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in\n Universal Coordinated Time (UTC).

" + "smithy.api#documentation": "

Specifies whether the cluster has instances in multiple Availability Zones.

" } }, - "PreferredBackupWindow": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if automated\n backups are enabled, as determined by the BackupRetentionPeriod.

" + "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in\n Universal Coordinated Time (UTC).

" } }, "DBClusterArn": { @@ -1194,22 +1200,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cluster.

" } }, - "DBClusterParameterGroup": { + "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the cluster parameter group for the cluster.

" + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if automated\n backups are enabled, as determined by the BackupRetentionPeriod.

" } }, - "DBSubnetGroup": { + "DBClusterParameterGroup": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the cluster,\n including the name, description, and subnets in the subnet group.

" - } - }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.docdb#LogTypeList", - "traits": { - "smithy.api#documentation": "

A list of log types that this cluster is configured to export to Amazon CloudWatch\n Logs.

" + "smithy.api#documentation": "

Specifies the name of the cluster parameter group for the cluster.

" } }, "AssociatedRoles": { @@ -1218,10 +1218,10 @@ "smithy.api#documentation": "

Provides a list of the AWS Identity and Access Management (IAM) roles that are\n associated with the cluster. IAM roles that are associated with a cluster grant\n permission for the cluster to access other AWS services on your behalf.

" } }, - "MultiAZ": { - "target": "com.amazonaws.docdb#Boolean", + "DBSubnetGroup": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies whether the cluster has instances in multiple Availability Zones.

" + "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the cluster,\n including the name, description, and subnets in the subnet group.

" } }, "VpcSecurityGroups": { @@ -1230,82 +1230,88 @@ "smithy.api#documentation": "

Provides a list of virtual private cloud (VPC) security groups that the cluster\n belongs to.

" } }, - "StorageEncrypted": { - "target": "com.amazonaws.docdb#Boolean", + "Status": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies whether the cluster is encrypted.

" + "smithy.api#documentation": "

Specifies the current state of this cluster.

" } }, - "Endpoint": { + "EarliestRestorableTime": { + "target": "com.amazonaws.docdb#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" + } + }, + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the cluster.

" + "smithy.api#documentation": "

Indicates the database engine version.

" } }, - "MasterUsername": { + "HostedZoneId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Contains the master user name for the cluster.

" + "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.docdb#IntegerOptional", + "DeletionProtection": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the number of days for which automatic snapshots are retained.

" + "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

" } }, - "PercentProgress": { - "target": "com.amazonaws.docdb#String", + "LatestRestorableTime": { + "target": "com.amazonaws.docdb#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" + "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" } }, - "DBClusterIdentifier": { - "target": "com.amazonaws.docdb#String", + "AvailabilityZones": { + "target": "com.amazonaws.docdb#AvailabilityZones", "traits": { - "smithy.api#documentation": "

Contains a user-supplied cluster identifier. This identifier is the unique key that\n identifies a cluster.

" + "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the cluster\n can be created in.

" } }, - "DbClusterResourceId": { + "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the cluster. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is\n accessed.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster.

" } }, - "DBClusterMembers": { - "target": "com.amazonaws.docdb#DBClusterMemberList", + "Engine": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the list of instances that make up the cluster.

" + "smithy.api#documentation": "

Provides the name of the database engine to be used for this cluster.

" } }, - "Status": { + "Endpoint": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the current state of this cluster.

" + "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the cluster.

" } }, - "EarliestRestorableTime": { - "target": "com.amazonaws.docdb#TStamp", + "DbClusterResourceId": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" + "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the cluster. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is\n accessed.

" } }, - "EngineVersion": { + "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" + "smithy.api#documentation": "

Contains a user-supplied cluster identifier. This identifier is the unique key that\n identifies a cluster.

" } }, - "ClusterCreateTime": { - "target": "com.amazonaws.docdb#TStamp", + "PercentProgress": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the time when the cluster was created, in Universal Coordinated Time\n (UTC).

" + "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" } }, - "Port": { - "target": "com.amazonaws.docdb#IntegerOptional", + "ReaderEndpoint": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + "smithy.api#documentation": "

The reader endpoint for the cluster. The reader endpoint for a cluster load\n balances connections across the Amazon DocumentDB replicas that are available in a cluster. As\n clients request new connections to the reader endpoint, Amazon DocumentDB distributes the\n connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can\n help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

\n

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to\n be the primary instance, your connection is dropped. To continue sending your read\n workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader\n endpoint.

" } } }, @@ -1338,12 +1344,6 @@ "com.amazonaws.docdb#DBClusterMember": { "type": "structure", "members": { - "IsClusterWriter": { - "target": "com.amazonaws.docdb#Boolean", - "traits": { - "smithy.api#documentation": "

A value that is true if the cluster member is the primary instance for\n the cluster and false otherwise.

" - } - }, "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { @@ -1361,6 +1361,12 @@ "traits": { "smithy.api#documentation": "

Specifies the status of the cluster parameter group for this member of the DB\n cluster.

" } + }, + "IsClusterWriter": { + "target": "com.amazonaws.docdb#Boolean", + "traits": { + "smithy.api#documentation": "

A value that is true if the cluster member is the primary instance for\n the cluster and false otherwise.

" + } } }, "traits": { @@ -1412,28 +1418,28 @@ "com.amazonaws.docdb#DBClusterParameterGroup": { "type": "structure", "members": { - "DBClusterParameterGroupName": { + "DBClusterParameterGroupArn": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the name of the cluster parameter group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cluster parameter group.

" } }, - "DBParameterGroupFamily": { + "Description": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the name of the parameter group family that this cluster parameter\n group is compatible with.

" + "smithy.api#documentation": "

Provides the customer-specified description for this cluster parameter\n group.

" } }, - "DBClusterParameterGroupArn": { + "DBParameterGroupFamily": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cluster parameter group.

" + "smithy.api#documentation": "

Provides the name of the parameter group family that this cluster parameter\n group is compatible with.

" } }, - "Description": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the customer-specified description for this cluster parameter\n group.

" + "smithy.api#documentation": "

Provides the name of the cluster parameter group.

" } } }, @@ -1444,17 +1450,17 @@ "com.amazonaws.docdb#DBClusterParameterGroupDetails": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "Parameters": { "target": "com.amazonaws.docdb#ParametersList", "traits": { "smithy.api#documentation": "

Provides a list of parameters for the cluster parameter group.

" } + }, + "Marker": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } }, "traits": { @@ -1500,17 +1506,17 @@ "com.amazonaws.docdb#DBClusterParameterGroupsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "DBClusterParameterGroups": { "target": "com.amazonaws.docdb#DBClusterParameterGroupList", "traits": { "smithy.api#documentation": "

A list of cluster parameter groups.

" } + }, + "Marker": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } }, "traits": { @@ -1533,16 +1539,16 @@ "com.amazonaws.docdb#DBClusterRole": { "type": "structure", "members": { - "RoleArn": { + "Status": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n cluster.

" + "smithy.api#documentation": "

Describes the state of association between the IAM role and the cluster. The\n Status property returns one of the following values:

\n " } }, - "Status": { + "RoleArn": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the cluster. The\n Status property returns one of the following values:

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n cluster.

" } } }, @@ -1562,58 +1568,46 @@ "com.amazonaws.docdb#DBClusterSnapshot": { "type": "structure", "members": { - "ClusterCreateTime": { - "target": "com.amazonaws.docdb#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time when the cluster was created, in Universal Coordinated Time\n (UTC).

" - } - }, - "Engine": { + "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the database engine.

" + "smithy.api#documentation": "

Specifies the identifier for the cluster snapshot.

" } }, - "AvailabilityZones": { - "target": "com.amazonaws.docdb#AvailabilityZones", + "Port": { + "target": "com.amazonaws.docdb#Integer", "traits": { - "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the cluster\n snapshot can be restored in.

" + "smithy.api#documentation": "

Specifies the port that the cluster was listening on at the time of the\n snapshot.

" } }, - "EngineVersion": { + "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the version of the database engine for this cluster snapshot.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster snapshot.

" } }, - "MasterUsername": { + "DBClusterSnapshotArn": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the master user name for the cluster snapshot.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cluster snapshot.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.docdb#String", + "StorageEncrypted": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster snapshot.

" + "smithy.api#documentation": "

Specifies whether the cluster snapshot is encrypted.

" } }, - "DBClusterSnapshotIdentifier": { + "Status": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the identifier for the cluster snapshot.

" + "smithy.api#documentation": "

Specifies the status of this cluster snapshot.

" } }, - "VpcId": { + "SnapshotType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the virtual private cloud (VPC) ID that is associated with the cluster\n snapshot.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.docdb#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the cluster snapshot is encrypted.

" + "smithy.api#documentation": "

Provides the type of the cluster snapshot.

" } }, "DBClusterIdentifier": { @@ -1622,28 +1616,28 @@ "smithy.api#documentation": "

Specifies the cluster identifier of the cluster that this cluster snapshot\n was created from.

" } }, - "SnapshotCreateTime": { - "target": "com.amazonaws.docdb#TStamp", + "VpcId": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the time when the snapshot was taken, in UTC.

" + "smithy.api#documentation": "

Provides the virtual private cloud (VPC) ID that is associated with the cluster\n snapshot.

" } }, - "PercentProgress": { - "target": "com.amazonaws.docdb#Integer", + "Engine": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" + "smithy.api#documentation": "

Specifies the name of the database engine.

" } }, - "Port": { - "target": "com.amazonaws.docdb#Integer", + "AvailabilityZones": { + "target": "com.amazonaws.docdb#AvailabilityZones", "traits": { - "smithy.api#documentation": "

Specifies the port that the cluster was listening on at the time of the\n snapshot.

" + "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the cluster\n snapshot can be restored in.

" } }, - "DBClusterSnapshotArn": { + "MasterUsername": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cluster snapshot.

" + "smithy.api#documentation": "

Provides the master user name for the cluster snapshot.

" } }, "SourceDBClusterSnapshotArn": { @@ -1652,16 +1646,28 @@ "smithy.api#documentation": "

If the cluster snapshot was copied from a source cluster snapshot, the ARN for\n the source cluster snapshot; otherwise, a null value.

" } }, - "Status": { - "target": "com.amazonaws.docdb#String", + "ClusterCreateTime": { + "target": "com.amazonaws.docdb#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the status of this cluster snapshot.

" + "smithy.api#documentation": "

Specifies the time when the cluster was created, in Universal Coordinated Time\n (UTC).

" } }, - "SnapshotType": { + "SnapshotCreateTime": { + "target": "com.amazonaws.docdb#TStamp", + "traits": { + "smithy.api#documentation": "

Provides the time when the snapshot was taken, in UTC.

" + } + }, + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the type of the cluster snapshot.

" + "smithy.api#documentation": "

Provides the version of the database engine for this cluster snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.docdb#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" } } }, @@ -1685,17 +1691,17 @@ "com.amazonaws.docdb#DBClusterSnapshotAttribute": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The name of the manual cluster snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that have\n permission to copy or restore the manual cluster snapshot.

" - } - }, "AttributeValues": { "target": "com.amazonaws.docdb#AttributeValueList", "traits": { "smithy.api#documentation": "

The values for the manual cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this\n element returns a list of IDs of the AWS accounts that are authorized to copy or restore\n the manual cluster snapshot. If a value of all is in the list, then the\n manual cluster snapshot is public and available for any AWS account to copy or\n restore.

" } + }, + "AttributeName": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The name of the manual cluster snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that have\n permission to copy or restore the manual cluster snapshot.

" + } } }, "traits": { @@ -1714,17 +1720,17 @@ "com.amazonaws.docdb#DBClusterSnapshotAttributesResult": { "type": "structure", "members": { - "DBClusterSnapshotAttributes": { - "target": "com.amazonaws.docdb#DBClusterSnapshotAttributeList", - "traits": { - "smithy.api#documentation": "

The list of attributes and values for the cluster snapshot.

" - } - }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The identifier of the cluster snapshot that the attributes apply to.

" } + }, + "DBClusterSnapshotAttributes": { + "target": "com.amazonaws.docdb#DBClusterSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the cluster snapshot.

" + } } }, "traits": { @@ -1743,17 +1749,17 @@ "com.amazonaws.docdb#DBClusterSnapshotMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "DBClusterSnapshots": { "target": "com.amazonaws.docdb#DBClusterSnapshotList", "traits": { "smithy.api#documentation": "

Provides a list of cluster snapshots.

" } + }, + "Marker": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } }, "traits": { @@ -1776,52 +1782,52 @@ "com.amazonaws.docdb#DBEngineVersion": { "type": "structure", "members": { - "SupportsLogExportsToCloudwatchLogs": { - "target": "com.amazonaws.docdb#Boolean", + "ExportableLogTypes": { + "target": "com.amazonaws.docdb#LogTypeList", "traits": { - "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types\n specified by ExportableLogTypes to CloudWatch Logs.

" + "smithy.api#documentation": "

The types of logs that the database engine has available for export to Amazon\n CloudWatch Logs.

" } }, - "Engine": { + "DBEngineVersionDescription": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the database engine.

" + "smithy.api#documentation": "

The description of the database engine version.

" } }, - "ValidUpgradeTarget": { - "target": "com.amazonaws.docdb#ValidUpgradeTargetList", + "DBEngineDescription": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" + "smithy.api#documentation": "

The description of the database engine.

" } }, - "EngineVersion": { + "Engine": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine.

" + "smithy.api#documentation": "

The name of the database engine.

" } }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.docdb#String", + "SupportsLogExportsToCloudwatchLogs": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

The name of the parameter group family for the database engine.

" + "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types\n specified by ExportableLogTypes to CloudWatch Logs.

" } }, - "ExportableLogTypes": { - "target": "com.amazonaws.docdb#LogTypeList", + "ValidUpgradeTarget": { + "target": "com.amazonaws.docdb#ValidUpgradeTargetList", "traits": { - "smithy.api#documentation": "

The types of logs that the database engine has available for export to Amazon\n CloudWatch Logs.

" + "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" } }, - "DBEngineVersionDescription": { + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The description of the database engine version.

" + "smithy.api#documentation": "

The version number of the database engine.

" } }, - "DBEngineDescription": { + "DBParameterGroupFamily": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The description of the database engine.

" + "smithy.api#documentation": "

The name of the parameter group family for the database engine.

" } } }, @@ -1861,52 +1867,52 @@ "com.amazonaws.docdb#DBInstance": { "type": "structure", "members": { - "PreferredMaintenanceWindow": { + "DBInstanceArn": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in\n Universal Coordinated Time (UTC).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the instance.

" } }, - "AvailabilityZone": { - "target": "com.amazonaws.docdb#String", + "LatestRestorableTime": { + "target": "com.amazonaws.docdb#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the name of the Availability Zone that the instance is located in.

" + "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" } }, - "PubliclyAccessible": { - "target": "com.amazonaws.docdb#Boolean", + "BackupRetentionPeriod": { + "target": "com.amazonaws.docdb#Integer", "traits": { - "smithy.api#documentation": "

Not supported. Amazon DocumentDB does not currently support public endpoints. The value \n of PubliclyAccessible is always false.

" + "smithy.api#documentation": "

Specifies the number of days for which automatic snapshots are retained.

" } }, - "DBSubnetGroup": { - "target": "com.amazonaws.docdb#DBSubnetGroup", + "Engine": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the instance,\n including the name, description, and subnets in the subnet group.

" + "smithy.api#documentation": "

Provides the name of the database engine to be used for this instance.

" } }, - "CACertificateIdentifier": { - "target": "com.amazonaws.docdb#String", + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.docdb#LogTypeList", "traits": { - "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" + "smithy.api#documentation": "

A list of log types that this instance is configured to export to Amazon CloudWatch\n Logs.

" } }, - "Endpoint": { - "target": "com.amazonaws.docdb#Endpoint", + "StatusInfos": { + "target": "com.amazonaws.docdb#DBInstanceStatusInfoList", "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint.

" + "smithy.api#documentation": "

The status of a read replica. If the instance is not a read replica, this is\n blank.

" } }, - "KmsKeyId": { + "DBInstanceStatus": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted instance.

" + "smithy.api#documentation": "

Specifies the current state of this database.

" } }, - "PendingModifiedValues": { - "target": "com.amazonaws.docdb#PendingModifiedValues", + "KmsKeyId": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies that changes to the instance are pending. This element is included only\n when changes are pending. Specific changes are identified by subelements.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted instance.

" } }, "DBInstanceClass": { @@ -1915,10 +1921,22 @@ "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the instance.

" } }, - "LatestRestorableTime": { + "InstanceCreateTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" + "smithy.api#documentation": "

Provides the date and time that the instance was created.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in\n Universal Coordinated Time (UTC).

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Availability Zone that the instance is located in.

" } }, "AutoMinorVersionUpgrade": { @@ -1933,58 +1951,52 @@ "smithy.api#documentation": "

Provides a list of VPC security group elements that the instance belongs to.

" } }, - "Engine": { + "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the name of the database engine to be used for this instance.

" - } - }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.docdb#LogTypeList", - "traits": { - "smithy.api#documentation": "

A list of log types that this instance is configured to export to Amazon CloudWatch\n Logs.

" + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if\n automated backups are enabled, as determined by the BackupRetentionPeriod.\n

" } }, - "StatusInfos": { - "target": "com.amazonaws.docdb#DBInstanceStatusInfoList", + "DbiResourceId": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The status of a read replica. If the instance is not a read replica, this is\n blank.

" + "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the instance. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is\n accessed.

" } }, - "DBInstanceArn": { - "target": "com.amazonaws.docdb#String", + "DBSubnetGroup": { + "target": "com.amazonaws.docdb#DBSubnetGroup", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the instance.

" + "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the instance,\n including the name, description, and subnets in the subnet group.

" } }, - "DBInstanceStatus": { + "CACertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the current state of this database.

" + "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.docdb#Integer", + "PendingModifiedValues": { + "target": "com.amazonaws.docdb#PendingModifiedValues", "traits": { - "smithy.api#documentation": "

Specifies the number of days for which automatic snapshots are retained.

" + "smithy.api#documentation": "

Specifies that changes to the instance are pending. This element is included only\n when changes are pending. Specific changes are identified by subelements.

" } }, - "DBClusterIdentifier": { - "target": "com.amazonaws.docdb#String", + "Endpoint": { + "target": "com.amazonaws.docdb#Endpoint", "traits": { - "smithy.api#documentation": "

Contains the name of the cluster that the instance is a member of if the \n instance is a member of a cluster.

" + "smithy.api#documentation": "

Specifies the connection endpoint.

" } }, - "DbiResourceId": { - "target": "com.amazonaws.docdb#String", + "PubliclyAccessible": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the instance. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is\n accessed.

" + "smithy.api#documentation": "

Not supported. Amazon DocumentDB does not currently support public endpoints. The value \n of PubliclyAccessible is always false.

" } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.docdb#String", + "PromotionTier": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if\n automated backups are enabled, as determined by the BackupRetentionPeriod.\n

" + "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

" } }, "StorageEncrypted": { @@ -1993,16 +2005,16 @@ "smithy.api#documentation": "

Specifies whether or not the instance is encrypted.

" } }, - "InstanceCreateTime": { - "target": "com.amazonaws.docdb#TStamp", + "EngineVersion": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the date and time that the instance was created.

" + "smithy.api#documentation": "

Indicates the database engine version.

" } }, - "PromotionTier": { - "target": "com.amazonaws.docdb#IntegerOptional", + "DBClusterIdentifier": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

" + "smithy.api#documentation": "

Contains the name of the cluster that the instance is a member of if the \n instance is a member of a cluster.

" } }, "DBInstanceIdentifier": { @@ -2010,12 +2022,6 @@ "traits": { "smithy.api#documentation": "

Contains a user-provided database identifier. This identifier is the unique key that\n identifies an instance.

" } - }, - "EngineVersion": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" - } } }, "traits": { @@ -2080,6 +2086,12 @@ "com.amazonaws.docdb#DBInstanceStatusInfo": { "type": "structure", "members": { + "Normal": { + "target": "com.amazonaws.docdb#Boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that is true if the instance is operating normally, or\n false if the instance is in an error state.

" + } + }, "Status": { "target": "com.amazonaws.docdb#String", "traits": { @@ -2097,12 +2109,6 @@ "traits": { "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance is not in\n an error state, this value is blank.

" } - }, - "Normal": { - "target": "com.amazonaws.docdb#Boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that is true if the instance is operating normally, or\n false if the instance is in an error state.

" - } } }, "traits": { @@ -2199,40 +2205,40 @@ "com.amazonaws.docdb#DBSubnetGroup": { "type": "structure", "members": { - "VpcId": { + "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the virtual private cloud (VPC) ID of the subnet group.

" + "smithy.api#documentation": "

The name of the subnet group.

" } }, - "DBSubnetGroupArn": { - "target": "com.amazonaws.docdb#String", + "Subnets": { + "target": "com.amazonaws.docdb#SubnetList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" + "smithy.api#documentation": "

Detailed information about one or more subnets within a subnet group.

" } }, - "DBSubnetGroupDescription": { + "DBSubnetGroupArn": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the description of the subnet group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" } }, - "SubnetGroupStatus": { + "VpcId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides the status of the subnet group.

" + "smithy.api#documentation": "

Provides the virtual private cloud (VPC) ID of the subnet group.

" } }, - "DBSubnetGroupName": { + "DBSubnetGroupDescription": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the subnet group.

" + "smithy.api#documentation": "

Provides the description of the subnet group.

" } }, - "Subnets": { - "target": "com.amazonaws.docdb#SubnetList", + "SubnetGroupStatus": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Detailed information about one or more subnets within a subnet group.

" + "smithy.api#documentation": "

Provides the status of the subnet group.

" } } }, @@ -2587,12 +2593,24 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for\n this AWS account.

" + "smithy.api#documentation": "

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for\n this AWS account.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Certificates", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.docdb#DescribeCertificatesMessage": { "type": "structure", "members": { + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records \n exist than the specified MaxRecords value, a pagination token \n called a marker is included in the response so that the remaining results can \n be retrieved.

\n

Default: 100

\n

Constraints:

\n " + } + }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { @@ -2610,12 +2628,6 @@ "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } - }, - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records \n exist than the specified MaxRecords value, a pagination token \n called a marker is included in the response so that the remaining results can \n be retrieved.

\n

Default: 100

\n

Constraints:

\n " - } } } }, @@ -2633,16 +2645,22 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a\n DBClusterParameterGroupName parameter is specified, the list contains\n only the description of the specified cluster parameter group.

" + "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a\n DBClusterParameterGroupName parameter is specified, the list contains\n only the description of the specified cluster parameter group.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterParameterGroups", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.docdb#DescribeDBClusterParameterGroupsMessage": { "type": "structure", "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.docdb#String", + "Filters": { + "target": "com.amazonaws.docdb#FilterList", "traits": { - "smithy.api#documentation": "

The name of a specific cluster parameter group to return details for.

\n

Constraints:

\n " + "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "Marker": { @@ -2651,10 +2669,10 @@ "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, - "Filters": { - "target": "com.amazonaws.docdb#FilterList", + "DBClusterParameterGroupName": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

The name of a specific cluster parameter group to return details for.

\n

Constraints:

\n " } }, "MaxRecords": { @@ -2682,12 +2700,31 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the detailed parameter list for a particular cluster parameter\n group.

" + "smithy.api#documentation": "

Returns the detailed parameter list for a particular cluster parameter\n group.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.docdb#DescribeDBClusterParametersMessage": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.docdb#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The name of a specific cluster parameter group to return parameter details\n for.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { @@ -2705,19 +2742,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } - }, - "Filters": { - "target": "com.amazonaws.docdb#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The name of a specific cluster parameter group to return parameter details\n for.

\n

Constraints:

\n ", - "smithy.api#required": {} - } } }, "traits": { @@ -2778,22 +2802,22 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about cluster snapshots. This API operation supports\n pagination.

" + "smithy.api#documentation": "

Returns information about cluster snapshots. This API operation supports\n pagination.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterSnapshots", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.docdb#DescribeDBClusterSnapshotsMessage": { "type": "structure", "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The ID of the cluster to retrieve the list of cluster snapshots for. This\n parameter can't be used with the DBClusterSnapshotIdentifier parameter.\n This parameter is not case sensitive.

\n

Constraints:

\n " - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.docdb#String", + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

A specific cluster snapshot identifier to describe. This parameter can't be used\n with the DBClusterIdentifier parameter. This value is stored as a lowercase\n string.

\n

Constraints:

\n " + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "IncludeShared": { @@ -2802,16 +2826,22 @@ "smithy.api#documentation": "

Set to true to include shared manual cluster snapshots from other AWS\n accounts that this AWS account has been given permission to copy or restore, and\n otherwise false. The default is false.

" } }, - "SnapshotType": { + "Marker": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The type of cluster snapshots to be returned. You can specify one of the following\n values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual\n cluster snapshots are returned. You can include shared cluster snapshots with\n these results by setting the IncludeShared parameter to true.\n You can include public cluster snapshots with these results by setting the\n IncludePublic parameter to true.

\n

The IncludeShared and IncludePublic parameters don't apply\n for SnapshotType values of manual or automated.\n The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when\n SnapshotType is set to public.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, - "IncludePublic": { - "target": "com.amazonaws.docdb#Boolean", + "DBClusterIdentifier": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Set to true to include manual cluster snapshots that are public and\n can be copied or restored by any AWS account, and otherwise false. The\n default is false.

" + "smithy.api#documentation": "

The ID of the cluster to retrieve the list of cluster snapshots for. This\n parameter can't be used with the DBClusterSnapshotIdentifier parameter.\n This parameter is not case sensitive.

\n

Constraints:

\n " + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

A specific cluster snapshot identifier to describe. This parameter can't be used\n with the DBClusterIdentifier parameter. This value is stored as a lowercase\n string.

\n

Constraints:

\n " } }, "Filters": { @@ -2820,16 +2850,16 @@ "smithy.api#documentation": "

This parameter is not currently supported.

" } }, - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", + "IncludePublic": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

Set to true to include manual cluster snapshots that are public and\n can be copied or restored by any AWS account, and otherwise false. The\n default is false.

" } }, - "Marker": { + "SnapshotType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + "smithy.api#documentation": "

The type of cluster snapshots to be returned. You can specify one of the following\n values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual\n cluster snapshots are returned. You can include shared cluster snapshots with\n these results by setting the IncludeShared parameter to true.\n You can include public cluster snapshots with these results by setting the\n IncludePublic parameter to true.

\n

The IncludeShared and IncludePublic parameters don't apply\n for SnapshotType values of manual or automated.\n The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when\n SnapshotType is set to public.

" } } }, @@ -2863,18 +2893,6 @@ "com.amazonaws.docdb#DescribeDBClustersMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Filters": { - "target": "com.amazonaws.docdb#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more clusters to describe.

\n

Supported filters:

\n " - } - }, "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { @@ -2886,6 +2904,18 @@ "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } + }, + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Filters": { + "target": "com.amazonaws.docdb#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more clusters to describe.

\n

Supported filters:

\n " + } } }, "traits": { @@ -2913,58 +2943,58 @@ "com.amazonaws.docdb#DescribeDBEngineVersionsMessage": { "type": "structure", "members": { - "ListSupportedTimezones": { - "target": "com.amazonaws.docdb#BooleanOptional", + "Filters": { + "target": "com.amazonaws.docdb#FilterList", "traits": { - "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the\n TimeZone parameter for CreateDBInstance, the response\n includes a list of supported time zones for each engine version.

" + "smithy.api#documentation": "

This parameter is not currently supported.

" } }, - "Marker": { + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + "smithy.api#documentation": "

The database engine version to return.

\n

Example: 3.6.0\n

" } }, - "Engine": { + "DBParameterGroupFamily": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The database engine to return.

" + "smithy.api#documentation": "

The name of a specific parameter group family to return details for.

\n

Constraints:

\n " } }, - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", + "DefaultOnly": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

Indicates that only the default version of the specified engine or engine and major\n version combination is returned.

" } }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.docdb#String", + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

The name of a specific parameter group family to return details for.

\n

Constraints:

\n " + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "Filters": { - "target": "com.amazonaws.docdb#FilterList", + "ListSupportedCharacterSets": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the\n CharacterSetName parameter for CreateDBInstance, the\n response includes a list of supported character sets for each engine version.

" } }, - "EngineVersion": { - "target": "com.amazonaws.docdb#String", + "ListSupportedTimezones": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" + "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the\n TimeZone parameter for CreateDBInstance, the response\n includes a list of supported time zones for each engine version.

" } - }, - "DefaultOnly": { - "target": "com.amazonaws.docdb#Boolean", + }, + "Marker": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates that only the default version of the specified engine or engine and major\n version combination is returned.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, - "ListSupportedCharacterSets": { - "target": "com.amazonaws.docdb#BooleanOptional", + "Engine": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the\n CharacterSetName parameter for CreateDBInstance, the\n response includes a list of supported character sets for each engine version.

" + "smithy.api#documentation": "

The database engine to return.

" } } }, @@ -2998,12 +3028,6 @@ "com.amazonaws.docdb#DescribeDBInstancesMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.docdb#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more instances to describe.

\n

Supported filters:

\n " - } - }, "MaxRecords": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { @@ -3021,6 +3045,12 @@ "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } + }, + "Filters": { + "target": "com.amazonaws.docdb#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more instances to describe.

\n

Supported filters:

\n " + } } }, "traits": { @@ -3053,16 +3083,10 @@ "com.amazonaws.docdb#DescribeDBSubnetGroupsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.docdb#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", + "Marker": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBSubnetGroupName": { @@ -3071,10 +3095,16 @@ "smithy.api#documentation": "

The name of the subnet group to return details for.

" } }, - "Marker": { - "target": "com.amazonaws.docdb#String", + "Filters": { + "target": "com.amazonaws.docdb#FilterList", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } }, @@ -3097,6 +3127,18 @@ "com.amazonaws.docdb#DescribeEngineDefaultClusterParametersMessage": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.docdb#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, "DBParameterGroupFamily": { "target": "com.amazonaws.docdb#String", "traits": { @@ -3109,18 +3151,6 @@ "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } - }, - "Filters": { - "target": "com.amazonaws.docdb#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } } }, "traits": { @@ -3188,30 +3218,18 @@ "com.amazonaws.docdb#DescribeEventsMessage": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.docdb#TStamp", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601\n format.

\n

Example: 2009-07-08T18:00Z

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "SourceType": { "target": "com.amazonaws.docdb#SourceType", "traits": { "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are\n returned.

" } }, + "EventCategories": { + "target": "com.amazonaws.docdb#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories that trigger notifications for an event notification\n subscription.

" + } + }, "StartTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { @@ -3224,12 +3242,6 @@ "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified,\n then all sources are included in the response.

\n

Constraints:

\n " } }, - "EventCategories": { - "target": "com.amazonaws.docdb#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories that trigger notifications for an event notification\n subscription.

" - } - }, "Filters": { "target": "com.amazonaws.docdb#FilterList", "traits": { @@ -3241,6 +3253,24 @@ "traits": { "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" } + }, + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "EndTime": { + "target": "com.amazonaws.docdb#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601\n format.

\n

Example: 2009-07-08T18:00Z

" + } + }, + "Marker": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } }, "traits": { @@ -3268,10 +3298,16 @@ "com.amazonaws.docdb#DescribeOrderableDBInstanceOptionsMessage": { "type": "structure", "members": { - "Marker": { + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available\n offerings that match the specified engine version.

" + } + }, + "Filters": { + "target": "com.amazonaws.docdb#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "Vpc": { @@ -3280,17 +3316,10 @@ "smithy.api#documentation": "

The virtual private cloud (VPC) filter value. Specify this parameter to show only the\n available VPC or non-VPC offerings.

" } }, - "Engine": { + "Marker": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the engine to retrieve instance options for.

", - "smithy.api#required": {} - } - }, - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, "DBInstanceClass": { @@ -3299,22 +3328,23 @@ "smithy.api#documentation": "

The instance class filter value. Specify this parameter to show only the available\n offerings that match the specified instance class.

" } }, - "Filters": { - "target": "com.amazonaws.docdb#FilterList", + "Engine": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

The name of the engine to retrieve instance options for.

", + "smithy.api#required": {} } }, - "LicenseModel": { - "target": "com.amazonaws.docdb#String", + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available\n offerings that match the specified license model.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "EngineVersion": { + "LicenseModel": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available\n offerings that match the specified engine version.

" + "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available\n offerings that match the specified license model.

" } } }, @@ -3336,34 +3366,40 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of resources (for example, instances) that have at least one pending\n maintenance action.

" + "smithy.api#documentation": "

Returns a list of resources (for example, instances) that have at least one pending\n maintenance action.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "PendingMaintenanceActions", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.docdb#DescribePendingMaintenanceActionsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.docdb#IntegerOptional", + "Filters": { + "target": "com.amazonaws.docdb#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions\n for.

\n

Supported filters:

\n " } }, - "Marker": { + "ResourceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" } }, - "ResourceIdentifier": { - "target": "com.amazonaws.docdb#String", + "MaxRecords": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token (marker) is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "Filters": { - "target": "com.amazonaws.docdb#FilterList", + "Marker": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions\n for.

\n

Supported filters:

\n " + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } } }, @@ -3374,12 +3410,6 @@ "com.amazonaws.docdb#Endpoint": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.docdb#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" - } - }, "HostedZoneId": { "target": "com.amazonaws.docdb#String", "traits": { @@ -3391,6 +3421,12 @@ "traits": { "smithy.api#documentation": "

Specifies the DNS address of the instance.

" } + }, + "Port": { + "target": "com.amazonaws.docdb#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + } } }, "traits": { @@ -3400,6 +3436,12 @@ "com.amazonaws.docdb#EngineDefaults": { "type": "structure", "members": { + "Parameters": { + "target": "com.amazonaws.docdb#ParametersList", + "traits": { + "smithy.api#documentation": "

The parameters of a particular cluster parameter group family.

" + } + }, "Marker": { "target": "com.amazonaws.docdb#String", "traits": { @@ -3411,12 +3453,6 @@ "traits": { "smithy.api#documentation": "

The name of the cluster parameter group family to return the engine parameter\n information for.

" } - }, - "Parameters": { - "target": "com.amazonaws.docdb#ParametersList", - "traits": { - "smithy.api#documentation": "

The parameters of a particular cluster parameter group family.

" - } } }, "traits": { @@ -3426,18 +3462,6 @@ "com.amazonaws.docdb#Event": { "type": "structure", "members": { - "Date": { - "target": "com.amazonaws.docdb#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the date and time of the event.

" - } - }, - "SourceIdentifier": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

Provides the identifier for the source of the event.

" - } - }, "SourceType": { "target": "com.amazonaws.docdb#SourceType", "traits": { @@ -3461,6 +3485,18 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" } + }, + "SourceIdentifier": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

Provides the identifier for the source of the event.

" + } + }, + "Date": { + "target": "com.amazonaws.docdb#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the date and time of the event.

" + } } }, "traits": { @@ -3479,17 +3515,17 @@ "com.amazonaws.docdb#EventCategoriesMap": { "type": "structure", "members": { - "EventCategories": { - "target": "com.amazonaws.docdb#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

The event categories for the specified source type.

" - } - }, "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The source type that the returned categories belong to.

" } + }, + "EventCategories": { + "target": "com.amazonaws.docdb#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

The event categories for the specified source type.

" + } } }, "traits": { @@ -3531,17 +3567,17 @@ "com.amazonaws.docdb#EventsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "Events": { "target": "com.amazonaws.docdb#EventList", "traits": { "smithy.api#documentation": "

Detailed information about one or more events.

" } + }, + "Marker": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } }, "traits": { @@ -3577,16 +3613,16 @@ "com.amazonaws.docdb#FailoverDBClusterMessage": { "type": "structure", "members": { - "DBClusterIdentifier": { + "TargetDBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A cluster identifier to force a failover for. This parameter is not case\n sensitive.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of the instance to promote to the primary instance.

\n

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For\n example, mydbcluster-replica1.

" } }, - "TargetDBInstanceIdentifier": { + "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the instance to promote to the primary instance.

\n

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For\n example, mydbcluster-replica1.

" + "smithy.api#documentation": "

A cluster identifier to force a failover for. This parameter is not case\n sensitive.

\n

Constraints:

\n " } } }, @@ -3605,17 +3641,17 @@ "com.amazonaws.docdb#Filter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.docdb#String", + "Values": { + "target": "com.amazonaws.docdb#FilterValueList", "traits": { - "smithy.api#documentation": "

The name of the filter. Filter names are case sensitive.

", + "smithy.api#documentation": "

One or more filter values. Filter values are case sensitive.

", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.docdb#FilterValueList", + "Name": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

One or more filter values. Filter values are case sensitive.

", + "smithy.api#documentation": "

The name of the filter. Filter names are case sensitive.

", "smithy.api#required": {} } } @@ -3891,18 +3927,18 @@ "com.amazonaws.docdb#ListTagsForResourceMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.docdb#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, "ResourceName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name\n (ARN).

", "smithy.api#required": {} } + }, + "Filters": { + "target": "com.amazonaws.docdb#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } } }, "traits": { @@ -3965,10 +4001,34 @@ "com.amazonaws.docdb#ModifyDBClusterMessage": { "type": "structure", "members": { - "NewDBClusterIdentifier": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The new cluster identifier for the cluster when renaming a cluster. This\n value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + } + }, + "Port": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The same port as the original cluster.

" + } + }, + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.docdb#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to Amazon\n CloudWatch Logs for a specific instance or cluster. The\n EnableLogTypes and DisableLogTypes arrays determine which\n logs are exported (or not exported) to CloudWatch Logs.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of virtual private cloud (VPC) security groups that the cluster will belong\n to.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups\n are enabled, using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region.

\n

Constraints:

\n " } }, "DeletionProtection": { @@ -3984,16 +4044,10 @@ "smithy.api#required": {} } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" - } - }, - "Port": { - "target": "com.amazonaws.docdb#IntegerOptional", + "ApplyImmediately": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

The port number on which the cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The same port as the original cluster.

" + "smithy.api#documentation": "

A value that specifies whether the changes in this request and any pending changes are\n asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the cluster. If this\n parameter is set to false, changes to the cluster are applied during the\n next maintenance window.

\n

The ApplyImmediately parameter affects only the\n NewDBClusterIdentifier and MasterUserPassword values. If\n you set this parameter value to false, the changes to the\n NewDBClusterIdentifier and MasterUserPassword values are\n applied during the next maintenance window. All other changes are applied immediately,\n regardless of the value of the ApplyImmediately parameter.

\n

Default: false\n

" } }, "EngineVersion": { @@ -4002,28 +4056,22 @@ "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless the ApplyImmediately parameter is set to true.

" } }, - "MasterUserPassword": { + "NewDBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable\n ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol\n (@).

\n

Constraints: Must contain from 8 to 100 characters.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of virtual private cloud (VPC) security groups that the cluster will belong\n to.

" + "smithy.api#documentation": "

The new cluster identifier for the cluster when renaming a cluster. This\n value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

" } }, - "PreferredBackupWindow": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups\n are enabled, using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of the cluster parameter group to use for the cluster.

" } }, - "DBClusterParameterGroupName": { + "MasterUserPassword": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the cluster parameter group to use for the cluster.

" + "smithy.api#documentation": "

The password for the master database user. This password can contain any printable\n ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol\n (@).

\n

Constraints: Must contain from 8 to 100 characters.

" } }, "BackupRetentionPeriod": { @@ -4031,18 +4079,6 @@ "traits": { "smithy.api#documentation": "

The number of days for which automated backups are retained. You must specify a\n minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " } - }, - "ApplyImmediately": { - "target": "com.amazonaws.docdb#Boolean", - "traits": { - "smithy.api#documentation": "

A value that specifies whether the changes in this request and any pending changes are\n asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the cluster. If this\n parameter is set to false, changes to the cluster are applied during the\n next maintenance window.

\n

The ApplyImmediately parameter affects only the\n NewDBClusterIdentifier and MasterUserPassword values. If\n you set this parameter value to false, the changes to the\n NewDBClusterIdentifier and MasterUserPassword values are\n applied during the next maintenance window. All other changes are applied immediately,\n regardless of the value of the ApplyImmediately parameter.

\n

Default: false\n

" - } - }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.docdb#CloudwatchLogsExportConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to Amazon\n CloudWatch Logs for a specific instance or cluster. The\n EnableLogTypes and DisableLogTypes arrays determine which\n logs are exported (or not exported) to CloudWatch Logs.

" - } } }, "traits": { @@ -4072,17 +4108,17 @@ "com.amazonaws.docdb#ModifyDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.docdb#ParametersList", + "DBClusterParameterGroupName": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A list of parameters in the cluster parameter group to modify.

", + "smithy.api#documentation": "

The name of the cluster parameter group to modify.

", "smithy.api#required": {} } }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.docdb#String", + "Parameters": { + "target": "com.amazonaws.docdb#ParametersList", "traits": { - "smithy.api#documentation": "

The name of the cluster parameter group to modify.

", + "smithy.api#documentation": "

A list of parameters in the cluster parameter group to modify.

", "smithy.api#required": {} } } @@ -4125,11 +4161,16 @@ "com.amazonaws.docdb#ModifyDBClusterSnapshotAttributeMessage": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.docdb#String", + "ValuesToRemove": { + "target": "com.amazonaws.docdb#AttributeValueList", "traits": { - "smithy.api#documentation": "

The name of the cluster snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this value to restore.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of cluster snapshot attributes to remove from the attribute specified by\n AttributeName.

\n

To remove authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this list to include one or more AWS account identifiers. To remove\n authorization for any AWS account to copy or restore the cluster snapshot, set it to\n all . If you specify all, an AWS account whose account ID\n is explicitly added to the restore attribute can still copy or restore a\n manual cluster snapshot.

" + } + }, + "ValuesToAdd": { + "target": "com.amazonaws.docdb#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of cluster snapshot attributes to add to the attribute specified by\n AttributeName.

\n

To authorize other AWS accounts to copy or restore a manual cluster snapshot, set\n this list to include one or more AWS account IDs. To make the manual cluster snapshot\n restorable by any AWS account, set it to all. Do not add the\n all value for any manual cluster snapshots that contain private\n information that you don't want to be available to all AWS accounts.

" } }, "DBClusterSnapshotIdentifier": { @@ -4139,16 +4180,11 @@ "smithy.api#required": {} } }, - "ValuesToRemove": { - "target": "com.amazonaws.docdb#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of cluster snapshot attributes to remove from the attribute specified by\n AttributeName.

\n

To remove authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this list to include one or more AWS account identifiers. To remove\n authorization for any AWS account to copy or restore the cluster snapshot, set it to\n all . If you specify all, an AWS account whose account ID\n is explicitly added to the restore attribute can still copy or restore a\n manual cluster snapshot.

" - } - }, - "ValuesToAdd": { - "target": "com.amazonaws.docdb#AttributeValueList", + "AttributeName": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A list of cluster snapshot attributes to add to the attribute specified by\n AttributeName.

\n

To authorize other AWS accounts to copy or restore a manual cluster snapshot, set\n this list to include one or more AWS account IDs. To make the manual cluster snapshot\n restorable by any AWS account, set it to all. Do not add the\n all value for any manual cluster snapshots that contain private\n information that you don't want to be available to all AWS accounts.

" + "smithy.api#documentation": "

The name of the cluster snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this value to restore.

", + "smithy.api#required": {} } } }, @@ -4220,28 +4256,28 @@ "com.amazonaws.docdb#ModifyDBInstanceMessage": { "type": "structure", "members": { - "PreferredMaintenanceWindow": { + "CACertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter doesn't result in an outage except in the\n following situation, and the change is asynchronously applied as soon as possible. If\n there are pending actions that cause a reboot, and the maintenance window is changed to\n include the current time, changing this parameter causes a reboot of the instance. If\n you are moving this window to the current time, there must be at least 30 minutes\n between the current time and end of the window to ensure that pending changes are\n applied.

\n

Default: Uses existing setting.

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Must be at least 30 minutes.

" + "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the instance.

" } }, - "PromotionTier": { - "target": "com.amazonaws.docdb#IntegerOptional", + "NewDBInstanceIdentifier": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

\n

Default: 1

\n

Valid values: 0-15

" + "smithy.api#documentation": "

The new instance identifier for the instance when renaming an instance. When\n you change the instance identifier, an instance reboot occurs immediately if you set\n Apply Immediately to true. It occurs during the next\n maintenance window if you set Apply Immediately to false. This\n value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

" } }, - "DBInstanceClass": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the instance; for example,\n db.r5.large. Not all instance classes are available in all AWS\n Regions.

\n

If you modify the instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless ApplyImmediately is\n specified as true for this request.

\n

Default: Uses existing setting.

" + "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter doesn't result in an outage except in the\n following situation, and the change is asynchronously applied as soon as possible. If\n there are pending actions that cause a reboot, and the maintenance window is changed to\n include the current time, changing this parameter causes a reboot of the instance. If\n you are moving this window to the current time, there must be at least 30 minutes\n between the current time and end of the window to ensure that pending changes are\n applied.

\n

Default: Uses existing setting.

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Must be at least 30 minutes.

" } }, - "NewDBInstanceIdentifier": { - "target": "com.amazonaws.docdb#String", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

The new instance identifier for the instance when renaming an instance. When\n you change the instance identifier, an instance reboot occurs immediately if you set\n Apply Immediately to true. It occurs during the next\n maintenance window if you set Apply Immediately to false. This\n value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

" + "smithy.api#documentation": "

Indicates that minor version upgrades are applied automatically to the instance\n during the maintenance window. Changing this parameter doesn't result in an outage\n except in the following case, and the change is asynchronously applied as soon as\n possible. An outage results if this parameter is set to true during the\n maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled\n automatic patching for that engine version.

" } }, "DBInstanceIdentifier": { @@ -4251,22 +4287,22 @@ "smithy.api#required": {} } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.docdb#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates that minor version upgrades are applied automatically to the instance\n during the maintenance window. Changing this parameter doesn't result in an outage\n except in the following case, and the change is asynchronously applied as soon as\n possible. An outage results if this parameter is set to true during the\n maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled\n automatic patching for that engine version.

" - } - }, "ApplyImmediately": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are\n asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the instance.

\n

If this parameter is set to false, changes to the instance are\n applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next reboot.

\n

Default: false\n

" } }, - "CACertificateIdentifier": { + "PromotionTier": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

\n

Default: 1

\n

Valid values: 0-15

" + } + }, + "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the instance.

" + "smithy.api#documentation": "

The new compute and memory capacity of the instance; for example,\n db.r5.large. Not all instance classes are available in all AWS\n Regions.

\n

If you modify the instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless ApplyImmediately is\n specified as true for this request.

\n

Default: Uses existing setting.

" } } }, @@ -4314,10 +4350,10 @@ "com.amazonaws.docdb#ModifyDBSubnetGroupMessage": { "type": "structure", "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.docdb#String", + "SubnetIds": { + "target": "com.amazonaws.docdb#SubnetIdentifierList", "traits": { - "smithy.api#documentation": "

The name for the subnet group. This value is stored as a lowercase string. You\n can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not\n be default.

\n

Example: mySubnetgroup\n

", + "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the subnet group.

", "smithy.api#required": {} } }, @@ -4327,10 +4363,10 @@ "smithy.api#documentation": "

The description for the subnet group.

" } }, - "SubnetIds": { - "target": "com.amazonaws.docdb#SubnetIdentifierList", + "DBSubnetGroupName": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the subnet group.

", + "smithy.api#documentation": "

The name for the subnet group. This value is stored as a lowercase string. You\n can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not\n be default.

\n

Example: mySubnetgroup\n

", "smithy.api#required": {} } } @@ -4350,22 +4386,22 @@ "com.amazonaws.docdb#OrderableDBInstanceOption": { "type": "structure", "members": { - "AvailabilityZones": { - "target": "com.amazonaws.docdb#AvailabilityZoneList", + "LicenseModel": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A list of Availability Zones for an instance.

" + "smithy.api#documentation": "

The license model for an instance.

" } }, - "DBInstanceClass": { + "Engine": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The instance class for an instance.

" + "smithy.api#documentation": "

The engine type of an instance.

" } }, - "Engine": { + "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The engine type of an instance.

" + "smithy.api#documentation": "

The instance class for an instance.

" } }, "Vpc": { @@ -4374,16 +4410,16 @@ "smithy.api#documentation": "

Indicates whether an instance is in a virtual private cloud (VPC).

" } }, - "EngineVersion": { - "target": "com.amazonaws.docdb#String", + "AvailabilityZones": { + "target": "com.amazonaws.docdb#AvailabilityZoneList", "traits": { - "smithy.api#documentation": "

The engine version of an instance.

" + "smithy.api#documentation": "

A list of Availability Zones for an instance.

" } }, - "LicenseModel": { + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The license model for an instance.

" + "smithy.api#documentation": "

The engine version of an instance.

" } } }, @@ -4423,64 +4459,64 @@ "com.amazonaws.docdb#Parameter": { "type": "structure", "members": { - "Description": { + "Source": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Provides a description of the parameter.

" + "smithy.api#documentation": "

Indicates the source of the parameter value.

" } }, - "ApplyType": { + "MinimumEngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the engine-specific parameters type.

" + "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" } }, - "IsModifiable": { - "target": "com.amazonaws.docdb#Boolean", + "ParameterName": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can\n be modified. Some parameters have security or operational implications that prevent them\n from being changed.

" + "smithy.api#documentation": "

Specifies the name of the parameter.

" } }, - "ApplyMethod": { - "target": "com.amazonaws.docdb#ApplyMethod", + "DataType": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates when to apply parameter updates.

" + "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" } }, - "ParameterName": { + "AllowedValues": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the parameter.

" + "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" } }, - "Source": { + "ParameterValue": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates the source of the parameter value.

" + "smithy.api#documentation": "

Specifies the value of the parameter.

" } }, - "DataType": { + "ApplyType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" + "smithy.api#documentation": "

Specifies the engine-specific parameters type.

" } }, - "MinimumEngineVersion": { + "Description": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" + "smithy.api#documentation": "

Provides a description of the parameter.

" } }, - "AllowedValues": { - "target": "com.amazonaws.docdb#String", + "ApplyMethod": { + "target": "com.amazonaws.docdb#ApplyMethod", "traits": { - "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" + "smithy.api#documentation": "

Indicates when to apply parameter updates.

" } }, - "ParameterValue": { - "target": "com.amazonaws.docdb#String", + "IsModifiable": { + "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can\n be modified. Some parameters have security or operational implications that prevent them\n from being changed.

" } } }, @@ -4500,16 +4536,16 @@ "com.amazonaws.docdb#PendingCloudwatchLogsExports": { "type": "structure", "members": { - "LogTypesToDisable": { + "LogTypesToEnable": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { - "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log\n types are exported to Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated,\n these log types aren't exported to CloudWatch Logs.

" } }, - "LogTypesToEnable": { + "LogTypesToDisable": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { - "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated,\n these log types aren't exported to CloudWatch Logs.

" + "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log\n types are exported to Amazon CloudWatch Logs.

" } } }, @@ -4520,6 +4556,12 @@ "com.amazonaws.docdb#PendingMaintenanceAction": { "type": "structure", "members": { + "ForcedApplyDate": { + "target": "com.amazonaws.docdb#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the maintenance action is automatically applied. The maintenance action\n is applied to the resource on this date regardless of the maintenance window for the\n resource. If this date is specified, any immediate opt-in requests are\n ignored.

" + } + }, "OptInStatus": { "target": "com.amazonaws.docdb#String", "traits": { @@ -4532,12 +4574,6 @@ "smithy.api#documentation": "

The effective date when the pending maintenance action is applied to the\n resource.

" } }, - "Description": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" - } - }, "Action": { "target": "com.amazonaws.docdb#String", "traits": { @@ -4550,10 +4586,10 @@ "smithy.api#documentation": "

The date of the maintenance window when the action is applied. The maintenance action\n is applied to the resource during its first maintenance window after this date. If this\n date is specified, any next-maintenance opt-in requests are ignored.

" } }, - "ForcedApplyDate": { - "target": "com.amazonaws.docdb#TStamp", + "Description": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The date when the maintenance action is automatically applied. The maintenance action\n is applied to the resource on this date regardless of the maintenance window for the\n resource. If this date is specified, any immediate opt-in requests are\n ignored.

" + "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" } } }, @@ -4602,40 +4638,46 @@ "com.amazonaws.docdb#PendingModifiedValues": { "type": "structure", "members": { - "StorageType": { - "target": "com.amazonaws.docdb#String", + "BackupRetentionPeriod": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the instance.

" + "smithy.api#documentation": "

Specifies the pending number of days for which automated backups are retained.

" } }, - "LicenseModel": { + "AllocatedStorage": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Contains the new AllocatedStorage size for then instance that will be\n applied or is currently being applied.

" + } + }, + "CACertificateIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The license model for the instance.

\n

Valid values: license-included, bring-your-own-license,\n general-public-license\n

" + "smithy.api#documentation": "

Specifies the identifier of the certificate authority (CA) certificate for the DB\n instance.

" } }, - "Port": { + "Iops": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the pending port for the instance.

" + "smithy.api#documentation": "

Specifies the new Provisioned IOPS value for the instance that will be applied or\n is currently being applied.

" } }, - "EngineVersion": { + "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" + "smithy.api#documentation": "

Contains the new DBInstanceClass for the instance that will be\n applied or is currently being applied.

" } }, - "Iops": { - "target": "com.amazonaws.docdb#IntegerOptional", + "DBInstanceIdentifier": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the new Provisioned IOPS value for the instance that will be applied or\n is currently being applied.

" + "smithy.api#documentation": "

Contains the new DBInstanceIdentifier for the instance that will be\n applied or is currently being applied.

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.docdb#IntegerOptional", + "MultiAZ": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

Contains the new AllocatedStorage size for then instance that will be\n applied or is currently being applied.

" + "smithy.api#documentation": "

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

" } }, "DBSubnetGroupName": { @@ -4650,16 +4692,22 @@ "smithy.api#documentation": "

Contains the pending or currently in-progress change of the master credentials for the\n instance.

" } }, - "CACertificateIdentifier": { + "LicenseModel": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies the identifier of the certificate authority (CA) certificate for the DB\n instance.

" + "smithy.api#documentation": "

The license model for the instance.

\n

Valid values: license-included, bring-your-own-license,\n general-public-license\n

" } }, - "DBInstanceIdentifier": { + "StorageType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Contains the new DBInstanceIdentifier for the instance that will be\n applied or is currently being applied.

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the instance.

" + } + }, + "Port": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the pending port for the instance.

" } }, "PendingCloudwatchLogsExports": { @@ -4668,22 +4716,10 @@ "smithy.api#documentation": "

A list of the log types whose configuration is still pending. These log types are in\n the process of being activated or deactivated.

" } }, - "DBInstanceClass": { + "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Contains the new DBInstanceClass for the instance that will be\n applied or is currently being applied.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.docdb#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.docdb#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the pending number of days for which automated backups are retained.

" + "smithy.api#documentation": "

Indicates the database engine version.

" } } }, @@ -4714,18 +4750,18 @@ "com.amazonaws.docdb#RebootDBInstanceMessage": { "type": "structure", "members": { + "ForceFailover": { + "target": "com.amazonaws.docdb#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When true, the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't specify true if the instance is not configured for\n Multi-AZ.

" + } + }, "DBInstanceIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", "smithy.api#required": {} } - }, - "ForceFailover": { - "target": "com.amazonaws.docdb#BooleanOptional", - "traits": { - "smithy.api#documentation": "

When true, the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't specify true if the instance is not configured for\n Multi-AZ.

" - } } }, "traits": { @@ -4805,12 +4841,6 @@ "com.amazonaws.docdb#ResetDBClusterParameterGroupMessage": { "type": "structure", "members": { - "ResetAllParameters": { - "target": "com.amazonaws.docdb#Boolean", - "traits": { - "smithy.api#documentation": "

A value that is set to true to reset all parameters in the cluster\n parameter group to their default values, and false otherwise. You can't use\n this parameter if there is a list of parameter names specified for the\n Parameters parameter.

" - } - }, "DBClusterParameterGroupName": { "target": "com.amazonaws.docdb#String", "traits": { @@ -4823,6 +4853,12 @@ "traits": { "smithy.api#documentation": "

A list of parameter names in the cluster parameter group to reset to the default\n values. You can't use this parameter if the ResetAllParameters parameter is\n set to true.

" } + }, + "ResetAllParameters": { + "target": "com.amazonaws.docdb#Boolean", + "traits": { + "smithy.api#documentation": "

A value that is set to true to reset all parameters in the cluster\n parameter group to their default values, and false otherwise. You can't use\n this parameter if there is a list of parameter names specified for the\n Parameters parameter.

" + } } }, "traits": { @@ -4845,21 +4881,21 @@ "com.amazonaws.docdb#ResourcePendingMaintenanceActions": { "type": "structure", "members": { - "PendingMaintenanceActionDetails": { - "target": "com.amazonaws.docdb#PendingMaintenanceActionDetails", + "ResourceIdentifier": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the\n resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that has pending \n maintenance actions.

" } }, - "ResourceIdentifier": { - "target": "com.amazonaws.docdb#String", + "PendingMaintenanceActionDetails": { + "target": "com.amazonaws.docdb#PendingMaintenanceActionDetails", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that has pending maintenance\n actions.

" + "smithy.api#documentation": "

A list that provides details about the pending maintenance actions\n for the resource.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the output of ApplyPendingMaintenanceAction.

" + "smithy.api#documentation": "

Represents the output of ApplyPendingMaintenanceAction.\n

" } }, "com.amazonaws.docdb#RestoreDBClusterFromSnapshot": { @@ -4921,41 +4957,29 @@ "com.amazonaws.docdb#RestoreDBClusterFromSnapshotMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.docdb#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the restored cluster.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of virtual private cloud (VPC) security groups that the new cluster will\n belong to.

" - } - }, "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { "smithy.api#documentation": "

The name of the subnet group to use for the new cluster.

\n

Constraints: If provided, must match the name of an existing\n DBSubnetGroup.

\n

Example: mySubnetgroup\n

" } }, - "DeletionProtection": { - "target": "com.amazonaws.docdb#BooleanOptional", + "Engine": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

" + "smithy.api#documentation": "

The database engine to use for the new cluster.

\n

Default: The same as source.

\n

Constraint: Must be compatible with the engine of the source.

", + "smithy.api#required": {} } }, - "DBClusterIdentifier": { - "target": "com.amazonaws.docdb#String", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.docdb#LogTypeList", "traits": { - "smithy.api#documentation": "

The name of the cluster to create from the snapshot or cluster snapshot. This\n parameter isn't case sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of log types that must be enabled for exporting to Amazon CloudWatch\n Logs.

" } }, - "EngineVersion": { - "target": "com.amazonaws.docdb#String", + "AvailabilityZones": { + "target": "com.amazonaws.docdb#AvailabilityZones", "traits": { - "smithy.api#documentation": "

The version of the database engine to use for the new cluster.

" + "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB\n cluster can be created in.

" } }, "SnapshotIdentifier": { @@ -4965,10 +4989,10 @@ "smithy.api#required": {} } }, - "Port": { - "target": "com.amazonaws.docdb#IntegerOptional", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The port number on which the new cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The same port as the original cluster.

" + "smithy.api#documentation": "

A list of virtual private cloud (VPC) security groups that the new cluster will\n belong to.

" } }, "KmsKeyId": { @@ -4977,23 +5001,35 @@ "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB\n snapshot or cluster snapshot.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS\n encryption key. If you are restoring a cluster with the same AWS account that owns\n the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS\n KMS key alias instead of the ARN for the AWS KMS encryption key.

\n

If you do not specify a value for the KmsKeyId parameter, then the\n following occurs:

\n " } }, - "AvailabilityZones": { - "target": "com.amazonaws.docdb#AvailabilityZones", + "DeletionProtection": { + "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB\n cluster can be created in.

" + "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If DeletionProtection is\n enabled, the cluster cannot be deleted unless it is modified and\n DeletionProtection is disabled. DeletionProtection\n protects clusters from being accidentally deleted.

" } }, - "Engine": { + "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new cluster.

\n

Default: The same as source.

\n

Constraint: Must be compatible with the engine of the source.

", + "smithy.api#documentation": "

The name of the cluster to create from the snapshot or cluster snapshot. This\n parameter isn't case sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", "smithy.api#required": {} } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.docdb#LogTypeList", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

A list of log types that must be enabled for exporting to Amazon CloudWatch\n Logs.

" + "smithy.api#documentation": "

The tags to be assigned to the restored cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine to use for the new cluster.

" + } + }, + "Port": { + "target": "com.amazonaws.docdb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the new cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The same port as the original cluster.

" } } }, @@ -5071,10 +5107,16 @@ "com.amazonaws.docdb#RestoreDBClusterToPointInTimeMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.docdb#TagList", + "DBSubnetGroupName": { + "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the restored cluster.

" + "smithy.api#documentation": "

The subnet group name to use for the new cluster.

\n

Constraints: If provided, must match the name of an existing\n DBSubnetGroup.

\n

Example: mySubnetgroup\n

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the new cluster belongs to.

" } }, "SourceDBClusterIdentifier": { @@ -5084,34 +5126,22 @@ "smithy.api#required": {} } }, - "Port": { - "target": "com.amazonaws.docdb#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the new cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The default port for the engine.

" - } - }, "RestoreToTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { "smithy.api#documentation": "

The date and time to restore the cluster to.

\n

Valid values: A time in Universal Coordinated Time (UTC) format.

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

" } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.docdb#LogTypeList", - "traits": { - "smithy.api#documentation": "

A list of log types that must be enabled for exporting to Amazon CloudWatch\n Logs.

" - } - }, "UseLatestRestorableTime": { "target": "com.amazonaws.docdb#Boolean", "traits": { "smithy.api#documentation": "

A value that is set to true to restore the cluster to the latest\n restorable backup time, and false otherwise.

\n

Default: false\n

\n

Constraints: Cannot be specified if the RestoreToTime parameter is\n provided.

" } }, - "DBSubnetGroupName": { - "target": "com.amazonaws.docdb#String", + "Port": { + "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

The subnet group name to use for the new cluster.

\n

Constraints: If provided, must match the name of an existing\n DBSubnetGroup.

\n

Example: mySubnetgroup\n

" + "smithy.api#documentation": "

The port number on which the new cluster accepts connections.

\n

Constraints: Must be a value from 1150 to 65535.

\n

Default: The default port for the engine.

" } }, "DeletionProtection": { @@ -5133,10 +5163,16 @@ "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted cluster from an\n encrypted cluster.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS\n encryption key. If you are restoring a cluster with the same AWS account that owns\n the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS\n KMS key alias instead of the ARN for the AWS KMS encryption key.

\n

You can restore to a new cluster and encrypt the new cluster with an AWS KMS key\n that is different from the AWS KMS key used to encrypt the source cluster. The new DB\n cluster is encrypted with the AWS KMS key identified by the KmsKeyId\n parameter.

\n

If you do not specify a value for the KmsKeyId parameter, then the\n following occurs:

\n \n

If DBClusterIdentifier refers to a cluster that is not encrypted, then\n the restore request is rejected.

" } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.docdb#VpcSecurityGroupIdList", + "Tags": { + "target": "com.amazonaws.docdb#TagList", "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new cluster belongs to.

" + "smithy.api#documentation": "

The tags to be assigned to the restored cluster.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.docdb#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that must be enabled for exporting to Amazon CloudWatch\n Logs.

" } } }, @@ -5424,12 +5460,6 @@ "com.amazonaws.docdb#UpgradeTarget": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.docdb#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine that an instance can be upgraded to.

" - } - }, "AutoUpgrade": { "target": "com.amazonaws.docdb#Boolean", "traits": { @@ -5453,6 +5483,12 @@ "traits": { "smithy.api#documentation": "

The name of the upgrade target database engine.

" } + }, + "Description": { + "target": "com.amazonaws.docdb#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine that an instance can be upgraded to.

" + } } }, "traits": { @@ -5480,16 +5516,16 @@ "com.amazonaws.docdb#VpcSecurityGroupMembership": { "type": "structure", "members": { - "Status": { + "VpcSecurityGroupId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The status of the VPC security group.

" + "smithy.api#documentation": "

The name of the VPC security group.

" } }, - "VpcSecurityGroupId": { + "Status": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the VPC security group.

" + "smithy.api#documentation": "

The status of the VPC security group.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json index aa8d48833eaa..f91ed65ed2bc 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json @@ -50,69 +50,69 @@ "com.amazonaws.dynamodbstreams#AttributeValue": { "type": "structure", "members": { - "BOOL": { - "target": "com.amazonaws.dynamodbstreams#BooleanAttributeValue", + "SS": { + "target": "com.amazonaws.dynamodbstreams#StringSetAttributeValue", "traits": { - "smithy.api#documentation": "

A Boolean data type.

" + "smithy.api#documentation": "

An attribute of type String Set. For example:

\n

\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n

" } }, - "M": { - "target": "com.amazonaws.dynamodbstreams#MapAttributeValue", + "BS": { + "target": "com.amazonaws.dynamodbstreams#BinarySetAttributeValue", "traits": { - "smithy.api#documentation": "

A Map data type.

" + "smithy.api#documentation": "

An attribute of type Binary Set. For example:

\n

\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n

" } }, - "L": { - "target": "com.amazonaws.dynamodbstreams#ListAttributeValue", + "N": { + "target": "com.amazonaws.dynamodbstreams#NumberAttributeValue", "traits": { - "smithy.api#documentation": "

A List data type.

" + "smithy.api#documentation": "

An attribute of type Number. For example:

\n

\n \"N\": \"123.45\"\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" } }, - "S": { - "target": "com.amazonaws.dynamodbstreams#StringAttributeValue", + "L": { + "target": "com.amazonaws.dynamodbstreams#ListAttributeValue", "traits": { - "smithy.api#documentation": "

A String data type.

" + "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n

" } }, - "B": { - "target": "com.amazonaws.dynamodbstreams#BinaryAttributeValue", + "BOOL": { + "target": "com.amazonaws.dynamodbstreams#BooleanAttributeValue", "traits": { - "smithy.api#documentation": "

A Binary data type.

" + "smithy.api#documentation": "

An attribute of type Boolean. For example:

\n

\n \"BOOL\": true\n

" } }, - "NS": { - "target": "com.amazonaws.dynamodbstreams#NumberSetAttributeValue", + "M": { + "target": "com.amazonaws.dynamodbstreams#MapAttributeValue", "traits": { - "smithy.api#documentation": "

A Number Set data type.

" + "smithy.api#documentation": "

An attribute of type Map. For example:

\n

\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n

" } }, "NULL": { "target": "com.amazonaws.dynamodbstreams#NullAttributeValue", "traits": { - "smithy.api#documentation": "

A Null data type.

" + "smithy.api#documentation": "

An attribute of type Null. For example:

\n

\n \"NULL\": true\n

" } }, - "N": { - "target": "com.amazonaws.dynamodbstreams#NumberAttributeValue", + "NS": { + "target": "com.amazonaws.dynamodbstreams#NumberSetAttributeValue", "traits": { - "smithy.api#documentation": "

A Number data type.

" + "smithy.api#documentation": "

An attribute of type Number Set. For example:

\n

\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" } }, - "BS": { - "target": "com.amazonaws.dynamodbstreams#BinarySetAttributeValue", + "B": { + "target": "com.amazonaws.dynamodbstreams#BinaryAttributeValue", "traits": { - "smithy.api#documentation": "

A Binary Set data type.

" + "smithy.api#documentation": "

An attribute of type Binary. For example:

\n

\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n

" } }, - "SS": { - "target": "com.amazonaws.dynamodbstreams#StringSetAttributeValue", + "S": { + "target": "com.amazonaws.dynamodbstreams#StringAttributeValue", "traits": { - "smithy.api#documentation": "

A String Set data type.

" + "smithy.api#documentation": "

An attribute of type String. For example:

\n

\n \"S\": \"Hello\"\n

" } } }, "traits": { - "smithy.api#documentation": "

Represents the data for an attribute. You can set one, and only one, of the elements.

\n

Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

" + "smithy.api#documentation": "

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

\n

For more information, see Data Types in the\n Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodbstreams#BinaryAttributeValue": { @@ -163,17 +163,17 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.dynamodbstreams#PositiveIntegerObject", - "traits": { - "smithy.api#documentation": "

The maximum number of shard objects to return. The upper limit is 100.

" - } - }, "ExclusiveStartShardId": { "target": "com.amazonaws.dynamodbstreams#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the first item that this operation will evaluate. Use the value that was\n returned for LastEvaluatedShardId in the previous operation.

" } + }, + "Limit": { + "target": "com.amazonaws.dynamodbstreams#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of shard objects to return. The upper limit is 100.

" + } } }, "traits": { @@ -216,7 +216,7 @@ "sdkId": "DynamoDB Streams", "arnNamespace": "dynamodb", "cloudFormationName": "DynamoDBStreams", - "cloudTrailEventSource": "v20120810.streams.dynamodb.amazonaws.com" + "cloudTrailEventSource": "dynamodbstreams.amazonaws.com" }, "aws.auth#sigv4": { "name": "dynamodb" @@ -300,17 +300,17 @@ "com.amazonaws.dynamodbstreams#GetRecordsOutput": { "type": "structure", "members": { - "NextShardIterator": { - "target": "com.amazonaws.dynamodbstreams#ShardIterator", - "traits": { - "smithy.api#documentation": "

The next position in the shard from which to start sequentially reading stream records. If\n set to null, the shard has been closed and the requested iterator will not return\n any more data.

" - } - }, "Records": { "target": "com.amazonaws.dynamodbstreams#RecordList", "traits": { "smithy.api#documentation": "

The stream records from the shard, which were retrieved using the shard iterator.

" } + }, + "NextShardIterator": { + "target": "com.amazonaws.dynamodbstreams#ShardIterator", + "traits": { + "smithy.api#documentation": "

The next position in the shard from which to start sequentially reading stream records. If\n set to null, the shard has been closed and the requested iterator will not return\n any more data.

" + } } }, "traits": { @@ -343,10 +343,10 @@ "com.amazonaws.dynamodbstreams#GetShardIteratorInput": { "type": "structure", "members": { - "StreamArn": { - "target": "com.amazonaws.dynamodbstreams#StreamArn", + "ShardId": { + "target": "com.amazonaws.dynamodbstreams#ShardId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream.

", + "smithy.api#documentation": "

The identifier of the shard. The iterator will be returned for this shard ID.

", "smithy.api#required": {} } }, @@ -356,10 +356,10 @@ "smithy.api#documentation": "

The sequence number of a stream record in the shard from which to start reading.

" } }, - "ShardId": { - "target": "com.amazonaws.dynamodbstreams#ShardId", + "StreamArn": { + "target": "com.amazonaws.dynamodbstreams#StreamArn", "traits": { - "smithy.api#documentation": "

The identifier of the shard. The iterator will be returned for this shard ID.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream.

", "smithy.api#required": {} } }, @@ -392,16 +392,16 @@ "com.amazonaws.dynamodbstreams#Identity": { "type": "structure", "members": { - "Type": { + "PrincipalId": { "target": "com.amazonaws.dynamodbstreams#String", "traits": { - "smithy.api#documentation": "

The type of the identity. For Time To Live, the type is \"Service\".

" + "smithy.api#documentation": "

A unique identifier for the entity that made the call. For Time To Live, the\n principalId is \"dynamodb.amazonaws.com\".

" } }, - "PrincipalId": { + "Type": { "target": "com.amazonaws.dynamodbstreams#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the entity that made the call. For Time To Live, the\n principalId is \"dynamodb.amazonaws.com\".

" + "smithy.api#documentation": "

The type of the identity. For Time To Live, the type is \"Service\".

" } } }, @@ -451,7 +451,7 @@ "KeyType": { "target": "com.amazonaws.dynamodbstreams#KeyType", "traits": { - "smithy.api#documentation": "

The attribute data, consisting of the data type and the attribute value itself.

", + "smithy.api#documentation": "

The role that this key attribute will assume:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range\n attribute. The term \"range attribute\" derives from the way DynamoDB\n stores items with the same partition key physically close together, in sorted order\n by the sort key value.

\n ", "smithy.api#required": {} } }, @@ -464,7 +464,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a single element of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.

\n

A KeySchemaElement represents exactly one attribute of the primary key. For example, a\n simple primary key (partition key) would be represented by one KeySchemaElement. A composite primary key (partition key and sort key) would require one KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.

\n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

\n " + "smithy.api#documentation": "

Represents a single element of a key schema. A key schema specifies\n the attributes that make up the primary key of a table, or the key attributes of an\n index.

\n

A KeySchemaElement represents exactly one attribute of the primary key. For\n example, a simple primary key would be represented by one KeySchemaElement\n (for the partition key). A composite primary key would require one\n KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.

\n

A KeySchemaElement must be a scalar, top-level attribute (not a nested\n attribute). The data type must be one of String, Number, or Binary. The attribute cannot\n be nested within a List or a Map.

" } }, "com.amazonaws.dynamodbstreams#KeyType": { @@ -491,7 +491,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that\n receive this exception. Your request is eventually successful, unless your retry queue is too\n large to finish. Reduce the frequency of requests and use exponential backoff. For more\n information, go to Error Retries and Exponential\n Backoff in the Amazon DynamoDB Developer Guide.

", + "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be\n taken.

\n

Up to 50 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and\n RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary\n indexes. You can have up to 25 such requests running at a time; however, if the table or\n index specifications are complex, DynamoDB might temporarily reduce the number of\n concurrent operations.

\n

There is a soft account quota of 256 tables.

", "smithy.api#error": "client" } }, @@ -628,16 +628,10 @@ "com.amazonaws.dynamodbstreams#Record": { "type": "structure", "members": { - "dynamodb": { - "target": "com.amazonaws.dynamodbstreams#StreamRecord", - "traits": { - "smithy.api#documentation": "

The main body of the stream record, containing all of the DynamoDB-specific fields.

" - } - }, - "awsRegion": { + "eventID": { "target": "com.amazonaws.dynamodbstreams#String", "traits": { - "smithy.api#documentation": "

The region in which the GetRecords request was received.

" + "smithy.api#documentation": "

A globally unique identifier for the event that was recorded in this stream record.

" } }, "eventName": { @@ -652,22 +646,28 @@ "smithy.api#documentation": "

The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

" } }, - "userIdentity": { - "target": "com.amazonaws.dynamodbstreams#Identity", - "traits": { - "smithy.api#documentation": "

Items that are deleted by the Time to Live process after expiration have the following fields:

\n " - } - }, "eventVersion": { "target": "com.amazonaws.dynamodbstreams#String", "traits": { "smithy.api#documentation": "

The version number of the stream record format. This number is updated whenever the structure of Record is modified.

\n

Client applications must not assume that eventVersion will remain at a particular\n value, as this number is subject to change at any time. In general, eventVersion will\n only increase as the low-level DynamoDB Streams API evolves.

" } }, - "eventID": { + "awsRegion": { "target": "com.amazonaws.dynamodbstreams#String", "traits": { - "smithy.api#documentation": "

A globally unique identifier for the event that was recorded in this stream record.

" + "smithy.api#documentation": "

The region in which the GetRecords request was received.

" + } + }, + "dynamodb": { + "target": "com.amazonaws.dynamodbstreams#StreamRecord", + "traits": { + "smithy.api#documentation": "

The main body of the stream record, containing all of the DynamoDB-specific fields.

" + } + }, + "userIdentity": { + "target": "com.amazonaws.dynamodbstreams#Identity", + "traits": { + "smithy.api#documentation": "

Items that are deleted by the Time to Live process after expiration have the following fields:

\n " } } }, @@ -692,7 +692,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation tried to access a nonexistent stream.

", + "smithy.api#documentation": "

The operation tried to access a nonexistent table or index. The resource\n might not be specified correctly, or its status might not be\n ACTIVE.

", "smithy.api#error": "client" } }, @@ -711,13 +711,13 @@ "EndingSequenceNumber": { "target": "com.amazonaws.dynamodbstreams#SequenceNumber", "traits": { - "smithy.api#documentation": "

The last sequence number.

" + "smithy.api#documentation": "

The last sequence number for the stream records contained within a shard. String contains numeric characters only.

" } }, "StartingSequenceNumber": { "target": "com.amazonaws.dynamodbstreams#SequenceNumber", "traits": { - "smithy.api#documentation": "

The first sequence number.

" + "smithy.api#documentation": "

The first sequence number for the stream records contained within a shard. String contains numeric characters only.

" } } }, @@ -728,16 +728,16 @@ "com.amazonaws.dynamodbstreams#Shard": { "type": "structure", "members": { - "ParentShardId": { + "ShardId": { "target": "com.amazonaws.dynamodbstreams#ShardId", "traits": { - "smithy.api#documentation": "

The shard ID of the current shard's parent.

" + "smithy.api#documentation": "

The system-generated identifier for this shard.

" } }, - "ShardId": { + "ParentShardId": { "target": "com.amazonaws.dynamodbstreams#ShardId", "traits": { - "smithy.api#documentation": "

The system-generated identifier for this shard.

" + "smithy.api#documentation": "

The shard ID of the current shard's parent.

" } }, "SequenceNumberRange": { @@ -803,17 +803,17 @@ "smithy.api#documentation": "

A timestamp, in ISO 8601 format, for this stream.

\n

Note that LatestStreamLabel is not a unique identifier for the stream, because it is\n possible that a stream from another table might have the same timestamp. However, the\n combination of the following three elements is guaranteed to be unique:

\n " } }, - "TableName": { - "target": "com.amazonaws.dynamodbstreams#TableName", - "traits": { - "smithy.api#documentation": "

The DynamoDB table with which the stream is associated.

" - } - }, "StreamArn": { "target": "com.amazonaws.dynamodbstreams#StreamArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream.

" } + }, + "TableName": { + "target": "com.amazonaws.dynamodbstreams#TableName", + "traits": { + "smithy.api#documentation": "

The DynamoDB table with which the stream is associated.

" + } } }, "traits": { @@ -832,16 +832,10 @@ "com.amazonaws.dynamodbstreams#StreamDescription": { "type": "structure", "members": { - "LastEvaluatedShardId": { - "target": "com.amazonaws.dynamodbstreams#ShardId", - "traits": { - "smithy.api#documentation": "

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

\n

If LastEvaluatedShardId is empty, then the \"last page\" of results has been\n processed and there is currently no more data to be retrieved.

\n

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is\n more data in the result set. The only way to know when you have reached the end of the result\n set is when LastEvaluatedShardId is empty.

" - } - }, - "KeySchema": { - "target": "com.amazonaws.dynamodbstreams#KeySchema", + "StreamStatus": { + "target": "com.amazonaws.dynamodbstreams#StreamStatus", "traits": { - "smithy.api#documentation": "

The key attribute(s) of the stream's DynamoDB table.

" + "smithy.api#documentation": "

Indicates the current status of the stream:

\n " } }, "StreamViewType": { @@ -850,10 +844,10 @@ "smithy.api#documentation": "

Indicates the format of the records within this stream:

\n " } }, - "StreamArn": { - "target": "com.amazonaws.dynamodbstreams#StreamArn", + "CreationRequestDateTime": { + "target": "com.amazonaws.dynamodbstreams#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream.

" + "smithy.api#documentation": "

The date and time when the request to create this stream was issued.

" } }, "Shards": { @@ -862,22 +856,22 @@ "smithy.api#documentation": "

The shards that comprise the stream.

" } }, - "StreamLabel": { - "target": "com.amazonaws.dynamodbstreams#String", + "StreamArn": { + "target": "com.amazonaws.dynamodbstreams#StreamArn", "traits": { - "smithy.api#documentation": "

A timestamp, in ISO 8601 format, for this stream.

\n

Note that LatestStreamLabel is not a unique identifier for the stream, because it is\n possible that a stream from another table might have the same timestamp. However, the\n combination of the following three elements is guaranteed to be unique:

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream.

" } }, - "CreationRequestDateTime": { - "target": "com.amazonaws.dynamodbstreams#Date", + "KeySchema": { + "target": "com.amazonaws.dynamodbstreams#KeySchema", "traits": { - "smithy.api#documentation": "

The date and time when the request to create this stream was issued.

" + "smithy.api#documentation": "

The key attribute(s) of the stream's DynamoDB table.

" } }, - "StreamStatus": { - "target": "com.amazonaws.dynamodbstreams#StreamStatus", + "StreamLabel": { + "target": "com.amazonaws.dynamodbstreams#String", "traits": { - "smithy.api#documentation": "

Indicates the current status of the stream:

\n " + "smithy.api#documentation": "

A timestamp, in ISO 8601 format, for this stream.

\n

Note that LatestStreamLabel is not a unique identifier for the stream, because it is\n possible that a stream from another table might have the same timestamp. However, the\n combination of the following three elements is guaranteed to be unique:

\n " } }, "TableName": { @@ -885,6 +879,12 @@ "traits": { "smithy.api#documentation": "

The DynamoDB table with which the stream is associated.

" } + }, + "LastEvaluatedShardId": { + "target": "com.amazonaws.dynamodbstreams#ShardId", + "traits": { + "smithy.api#documentation": "

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

\n

If LastEvaluatedShardId is empty, then the \"last page\" of results has been\n processed and there is currently no more data to be retrieved.

\n

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is\n more data in the result set. The only way to know when you have reached the end of the result\n set is when LastEvaluatedShardId is empty.

" + } } }, "traits": { @@ -906,12 +906,6 @@ "smithy.api#documentation": "

The sequence number of the stream record.

" } }, - "StreamViewType": { - "target": "com.amazonaws.dynamodbstreams#StreamViewType", - "traits": { - "smithy.api#documentation": "

The type of data from the modified DynamoDB item that was captured in this stream record:

\n " - } - }, "OldImage": { "target": "com.amazonaws.dynamodbstreams#AttributeMap", "traits": { @@ -924,23 +918,29 @@ "smithy.api#documentation": "

The approximate date and time when the stream record was created, in UNIX epoch time format.

" } }, - "Keys": { - "target": "com.amazonaws.dynamodbstreams#AttributeMap", - "traits": { - "smithy.api#documentation": "

The primary key attribute(s) for the DynamoDB item that was modified.

" - } - }, "SizeBytes": { "target": "com.amazonaws.dynamodbstreams#PositiveLongObject", "traits": { "smithy.api#documentation": "

The size of the stream record, in bytes.

" } }, + "Keys": { + "target": "com.amazonaws.dynamodbstreams#AttributeMap", + "traits": { + "smithy.api#documentation": "

The primary key attribute(s) for the DynamoDB item that was modified.

" + } + }, "NewImage": { "target": "com.amazonaws.dynamodbstreams#AttributeMap", "traits": { "smithy.api#documentation": "

The item in the DynamoDB table as it appeared after it was modified.

" } + }, + "StreamViewType": { + "target": "com.amazonaws.dynamodbstreams#StreamViewType", + "traits": { + "smithy.api#documentation": "

The type of data from the modified DynamoDB item that was captured in this stream record:

\n " + } } }, "traits": { 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 db37cb11b2b3..c8227278f8a3 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -35,18 +35,18 @@ "com.amazonaws.dynamodb#ArchivalSummary": { "type": "structure", "members": { - "ArchivalReason": { - "target": "com.amazonaws.dynamodb#ArchivalReason", - "traits": { - "smithy.api#documentation": "

The reason DynamoDB archived the table. Currently, the only\n possible value is:

\n\n " - } - }, "ArchivalBackupArn": { "target": "com.amazonaws.dynamodb#BackupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup the table was archived\n to, when applicable in the archival reason. If you wish to restore this\n backup to the same table name, you will need to delete the original\n table.

" } }, + "ArchivalReason": { + "target": "com.amazonaws.dynamodb#ArchivalReason", + "traits": { + "smithy.api#documentation": "

The reason DynamoDB archived the table. Currently, the only\n possible value is:

\n\n " + } + }, "ArchivalDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { @@ -155,34 +155,34 @@ "smithy.api#documentation": "

An attribute of type Number Set. For example:

\n

\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" } }, - "BS": { - "target": "com.amazonaws.dynamodb#BinarySetAttributeValue", + "S": { + "target": "com.amazonaws.dynamodb#StringAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Binary Set. For example:

\n

\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n

" + "smithy.api#documentation": "

An attribute of type String. For example:

\n

\n \"S\": \"Hello\"\n

" } }, - "NULL": { - "target": "com.amazonaws.dynamodb#NullAttributeValue", + "B": { + "target": "com.amazonaws.dynamodb#BinaryAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Null. For example:

\n

\n \"NULL\": true\n

" + "smithy.api#documentation": "

An attribute of type Binary. For example:

\n

\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n

" } }, - "SS": { - "target": "com.amazonaws.dynamodb#StringSetAttributeValue", + "BS": { + "target": "com.amazonaws.dynamodb#BinarySetAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type String Set. For example:

\n

\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n

" + "smithy.api#documentation": "

An attribute of type Binary Set. For example:

\n

\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n

" } }, - "S": { - "target": "com.amazonaws.dynamodb#StringAttributeValue", + "SS": { + "target": "com.amazonaws.dynamodb#StringSetAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type String. For example:

\n

\n \"S\": \"Hello\"\n

" + "smithy.api#documentation": "

An attribute of type String Set. For example:

\n

\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n

" } }, - "B": { - "target": "com.amazonaws.dynamodb#BinaryAttributeValue", + "N": { + "target": "com.amazonaws.dynamodb#NumberAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Binary. For example:

\n

\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n

" + "smithy.api#documentation": "

An attribute of type Number. For example:

\n

\n \"N\": \"123.45\"\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" } }, "M": { @@ -191,16 +191,16 @@ "smithy.api#documentation": "

An attribute of type Map. For example:

\n

\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n

" } }, - "L": { - "target": "com.amazonaws.dynamodb#ListAttributeValue", + "NULL": { + "target": "com.amazonaws.dynamodb#NullAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n

" + "smithy.api#documentation": "

An attribute of type Null. For example:

\n

\n \"NULL\": true\n

" } }, - "N": { - "target": "com.amazonaws.dynamodb#NumberAttributeValue", + "L": { + "target": "com.amazonaws.dynamodb#ListAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Number. For example:

\n

\n \"N\": \"123.45\"\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" + "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n

" } } }, @@ -304,18 +304,6 @@ "com.amazonaws.dynamodb#AutoScalingSettingsDescription": { "type": "structure", "members": { - "ScalingPolicies": { - "target": "com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList", - "traits": { - "smithy.api#documentation": "

Information about the scaling policies.

" - } - }, - "MaximumUnits": { - "target": "com.amazonaws.dynamodb#PositiveLongObject", - "traits": { - "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be scaled up to.

" - } - }, "MinimumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { @@ -333,6 +321,18 @@ "traits": { "smithy.api#documentation": "

Role ARN used for configuring the auto scaling policy.

" } + }, + "ScalingPolicies": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList", + "traits": { + "smithy.api#documentation": "

Information about the scaling policies.

" + } + }, + "MaximumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be scaled up to.

" + } } }, "traits": { @@ -342,12 +342,6 @@ "com.amazonaws.dynamodb#AutoScalingSettingsUpdate": { "type": "structure", "members": { - "AutoScalingDisabled": { - "target": "com.amazonaws.dynamodb#BooleanObject", - "traits": { - "smithy.api#documentation": "

Disabled auto scaling for this global table or global secondary index.

" - } - }, "MinimumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { @@ -360,16 +354,22 @@ "smithy.api#documentation": "

The scaling policy to apply for scaling target global table or global secondary index capacity units.

" } }, + "AutoScalingRoleArn": { + "target": "com.amazonaws.dynamodb#AutoScalingRoleArn", + "traits": { + "smithy.api#documentation": "

Role ARN used for configuring auto scaling policy.

" + } + }, "MaximumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be scaled up to.

" } }, - "AutoScalingRoleArn": { - "target": "com.amazonaws.dynamodb#AutoScalingRoleArn", + "AutoScalingDisabled": { + "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Role ARN used for configuring auto scaling policy.

" + "smithy.api#documentation": "

Disabled auto scaling for this global table or global secondary index.

" } } }, @@ -413,16 +413,17 @@ "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate": { "type": "structure", "members": { - "ScaleOutCooldown": { + "ScaleInCooldown": { "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another scale\n in activity can start. The cooldown period is used to block subsequent scale in requests\n until it has expired. You should scale in conservatively to protect your application's\n availability. However, if another alarm triggers a scale out policy during the cooldown\n period after a scale-in, application auto scaling scales out your scalable target\n immediately.

" } }, - "ScaleInCooldown": { - "target": "com.amazonaws.dynamodb#IntegerObject", + "TargetValue": { + "target": "com.amazonaws.dynamodb#Double", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another scale\n in activity can start. The cooldown period is used to block subsequent scale in requests\n until it has expired. You should scale in conservatively to protect your application's\n availability. However, if another alarm triggers a scale out policy during the cooldown\n period after a scale-in, application auto scaling scales out your scalable target\n immediately.

" + "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

", + "smithy.api#required": {} } }, "DisableScaleIn": { @@ -431,11 +432,10 @@ "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is true,\n scale in is disabled and the target tracking policy won't remove capacity from the scalable resource.\n Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.\n The default value is false.

" } }, - "TargetValue": { - "target": "com.amazonaws.dynamodb#Double", + "ScaleOutCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { - "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.

" } } }, @@ -464,6 +464,12 @@ "com.amazonaws.dynamodb#BackupDescription": { "type": "structure", "members": { + "BackupDetails": { + "target": "com.amazonaws.dynamodb#BackupDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the backup created for the table.

" + } + }, "SourceTableFeatureDetails": { "target": "com.amazonaws.dynamodb#SourceTableFeatureDetails", "traits": { @@ -475,12 +481,6 @@ "traits": { "smithy.api#documentation": "

Contains the details of the table when the backup was created.

" } - }, - "BackupDetails": { - "target": "com.amazonaws.dynamodb#BackupDetails", - "traits": { - "smithy.api#documentation": "

Contains the details of the backup created for the table.

" - } } }, "traits": { @@ -490,20 +490,6 @@ "com.amazonaws.dynamodb#BackupDetails": { "type": "structure", "members": { - "BackupStatus": { - "target": "com.amazonaws.dynamodb#BackupStatus", - "traits": { - "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

", - "smithy.api#required": {} - } - }, - "BackupCreationDateTime": { - "target": "com.amazonaws.dynamodb#BackupCreationDateTime", - "traits": { - "smithy.api#documentation": "

Time at which the backup was created. This is the request time of the backup.

", - "smithy.api#required": {} - } - }, "BackupExpiryDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { @@ -517,6 +503,13 @@ "smithy.api#required": {} } }, + "BackupStatus": { + "target": "com.amazonaws.dynamodb#BackupStatus", + "traits": { + "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

", + "smithy.api#required": {} + } + }, "BackupName": { "target": "com.amazonaws.dynamodb#BackupName", "traits": { @@ -524,6 +517,13 @@ "smithy.api#required": {} } }, + "BackupCreationDateTime": { + "target": "com.amazonaws.dynamodb#BackupCreationDateTime", + "traits": { + "smithy.api#documentation": "

Time at which the backup was created. This is the request time of the backup.

", + "smithy.api#required": {} + } + }, "BackupArn": { "target": "com.amazonaws.dynamodb#BackupArn", "traits": { @@ -610,6 +610,12 @@ "com.amazonaws.dynamodb#BackupSummary": { "type": "structure", "members": { + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the backup.

" + } + }, "BackupName": { "target": "com.amazonaws.dynamodb#BackupName", "traits": { @@ -622,12 +628,6 @@ "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will expire. This\n SYSTEM on-demand backup expires automatically 35 days after its\n creation.

" } }, - "BackupArn": { - "target": "com.amazonaws.dynamodb#BackupArn", - "traits": { - "smithy.api#documentation": "

ARN associated with the backup.

" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -640,35 +640,35 @@ "smithy.api#documentation": "

Unique identifier for the table.

" } }, - "TableArn": { - "target": "com.amazonaws.dynamodb#TableArn", - "traits": { - "smithy.api#documentation": "

ARN associated with the table.

" - } - }, "BackupType": { "target": "com.amazonaws.dynamodb#BackupType", "traits": { "smithy.api#documentation": "

BackupType:

\n " } }, - "BackupStatus": { - "target": "com.amazonaws.dynamodb#BackupStatus", - "traits": { - "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

" - } - }, "BackupCreationDateTime": { "target": "com.amazonaws.dynamodb#BackupCreationDateTime", "traits": { "smithy.api#documentation": "

Time at which the backup was created.

" } }, + "BackupStatus": { + "target": "com.amazonaws.dynamodb#BackupStatus", + "traits": { + "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

" + } + }, "BackupSizeBytes": { "target": "com.amazonaws.dynamodb#BackupSizeBytes", "traits": { "smithy.api#documentation": "

Size of the backup in bytes.

" } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the table.

" + } } }, "traits": { @@ -759,15 +759,15 @@ "com.amazonaws.dynamodb#BatchGetItemInput": { "type": "structure", "members": { + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, "RequestItems": { "target": "com.amazonaws.dynamodb#BatchGetRequestMap", "traits": { "smithy.api#documentation": "

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

\n

Each element in the map of items to retrieve consists of the following:

\n ", "smithy.api#required": {} } - }, - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" } }, "traits": { @@ -883,10 +883,10 @@ "com.amazonaws.dynamodb#BatchWriteItemOutput": { "type": "structure", "members": { - "UnprocessedItems": { - "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", "traits": { - "smithy.api#documentation": "

A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as RequestItems, so you can provide\n this value directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each UnprocessedItems entry consists of a table name and, for that table, a list of\n operations to perform (DeleteRequest or PutRequest).

\n \n

If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

" + "smithy.api#documentation": "

A list of tables that were processed by BatchWriteItem and, for each table,\n information about any item collections that were affected by individual DeleteItem or\n PutItem operations.

\n

Each entry consists of the following subelements:

\n " } }, "ConsumedCapacity": { @@ -895,10 +895,10 @@ "smithy.api#documentation": "

The capacity units consumed by the entire BatchWriteItem operation.

\n

Each element consists of:

\n " } }, - "ItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", + "UnprocessedItems": { + "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", "traits": { - "smithy.api#documentation": "

A list of tables that were processed by BatchWriteItem and, for each table,\n information about any item collections that were affected by individual DeleteItem or\n PutItem operations.

\n

Each entry consists of the following subelements:

\n " + "smithy.api#documentation": "

A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as RequestItems, so you can provide\n this value directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each UnprocessedItems entry consists of a table name and, for that table, a list of\n operations to perform (DeleteRequest or PutRequest).

\n \n

If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

" } } }, @@ -937,17 +937,17 @@ "com.amazonaws.dynamodb#BillingModeSummary": { "type": "structure", "members": { - "LastUpdateToPayPerRequestDateTime": { - "target": "com.amazonaws.dynamodb#Date", - "traits": { - "smithy.api#documentation": "

Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

" - } - }, "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

\n " } + }, + "LastUpdateToPayPerRequestDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

" + } } }, "traits": { @@ -1016,22 +1016,22 @@ "com.amazonaws.dynamodb#Capacity": { "type": "structure", "members": { - "CapacityUnits": { + "ReadCapacityUnits": { "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", "traits": { - "smithy.api#documentation": "

The total number of capacity units consumed on a table or an index.

" + "smithy.api#documentation": "

The total number of read capacity units consumed on a table or an index.

" } }, - "WriteCapacityUnits": { + "CapacityUnits": { "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", "traits": { - "smithy.api#documentation": "

The total number of write capacity units consumed on a table or an index.

" + "smithy.api#documentation": "

The total number of capacity units consumed on a table or an index.

" } }, - "ReadCapacityUnits": { + "WriteCapacityUnits": { "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", "traits": { - "smithy.api#documentation": "

The total number of read capacity units consumed on a table or an index.

" + "smithy.api#documentation": "

The total number of write capacity units consumed on a table or an index.

" } } }, @@ -1100,18 +1100,18 @@ "com.amazonaws.dynamodb#Condition": { "type": "structure", "members": { - "AttributeValueList": { - "target": "com.amazonaws.dynamodb#AttributeValueList", - "traits": { - "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in the\n list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, a is greater than A, and a\n is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

" - } - }, "ComparisonOperator": { "target": "com.amazonaws.dynamodb#ComparisonOperator", "traits": { "smithy.api#documentation": "

A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

\n \n

For usage examples of AttributeValueList and ComparisonOperator, see\n Legacy Conditional Parameters\n in the Amazon DynamoDB Developer Guide.

", "smithy.api#required": {} } + }, + "AttributeValueList": { + "target": "com.amazonaws.dynamodb#AttributeValueList", + "traits": { + "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in the\n list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, a is greater than A, and a\n is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

" + } } }, "traits": { @@ -1121,30 +1121,30 @@ "com.amazonaws.dynamodb#ConditionCheck": { "type": "structure", "members": { - "ExpressionAttributeValues": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "Key": { + "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + "smithy.api#documentation": "

The primary key of the item to be checked. Each element consists of an\n attribute name and a value for that attribute.

", + "smithy.api#required": {} } }, - "ReturnValuesOnConditionCheckFailure": { - "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the ConditionCheck condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

", + "smithy.api#required": {} } }, - "ConditionExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" } }, - "Key": { - "target": "com.amazonaws.dynamodb#Key", + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

The primary key of the item to be checked. Each element consists of an\n attribute name and a value for that attribute.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the ConditionCheck condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.

" } }, "TableName": { @@ -1205,30 +1205,24 @@ "com.amazonaws.dynamodb#ConsumedCapacity": { "type": "structure", "members": { - "Table": { - "target": "com.amazonaws.dynamodb#Capacity", - "traits": { - "smithy.api#documentation": "

The amount of throughput consumed on the table affected by the operation.

" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The name of the table that was affected by the operation.

" } }, - "LocalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", - "traits": { - "smithy.api#documentation": "

The amount of throughput consumed on each local index affected by the operation.

" - } - }, "CapacityUnits": { "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", "traits": { "smithy.api#documentation": "

The total number of capacity units consumed by the operation.

" } }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on each local index affected by the operation.

" + } + }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", "traits": { @@ -1246,6 +1240,12 @@ "traits": { "smithy.api#documentation": "

The total number of write capacity units consumed by the operation.

" } + }, + "Table": { + "target": "com.amazonaws.dynamodb#Capacity", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on the table affected by the operation.

" + } } }, "traits": { @@ -1267,18 +1267,18 @@ "com.amazonaws.dynamodb#ContinuousBackupsDescription": { "type": "structure", "members": { + "PointInTimeRecoveryDescription": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryDescription", + "traits": { + "smithy.api#documentation": "

The description of the point in time recovery settings applied to the table.

" + } + }, "ContinuousBackupsStatus": { "target": "com.amazonaws.dynamodb#ContinuousBackupsStatus", "traits": { "smithy.api#documentation": "

\n ContinuousBackupsStatus can be one of the following states: ENABLED,\n DISABLED

", "smithy.api#required": {} } - }, - "PointInTimeRecoveryDescription": { - "target": "com.amazonaws.dynamodb#PointInTimeRecoveryDescription", - "traits": { - "smithy.api#documentation": "

The description of the point in time recovery settings applied to the table.

" - } } }, "traits": { @@ -1366,6 +1366,12 @@ "com.amazonaws.dynamodb#ContributorInsightsSummary": { "type": "structure", "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Name of the table associated with the summary.

" + } + }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { @@ -1377,12 +1383,6 @@ "traits": { "smithy.api#documentation": "

Describes the current status for contributor insights for the given table and index, if applicable.

" } - }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "

Name of the table associated with the summary.

" - } } }, "traits": { @@ -1457,17 +1457,16 @@ "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction": { "type": "structure", "members": { - "Projection": { - "target": "com.amazonaws.dynamodb#Projection", + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" } }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", "traits": { - "smithy.api#documentation": "

The name of the global secondary index to be created.

", + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

", "smithy.api#required": {} } }, @@ -1478,10 +1477,11 @@ "smithy.api#required": {} } }, - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The name of the global secondary index to be created.

", + "smithy.api#required": {} } } }, @@ -1573,18 +1573,18 @@ "smithy.api#required": {} } }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "

Replica-specific global secondary index settings.

" - } - }, "KMSMasterKeyId": { "target": "com.amazonaws.dynamodb#KMSMasterKeyId", "traits": { "smithy.api#documentation": "

The AWS KMS customer master key (CMK) that should be used for AWS KMS encryption\n in the new replica. To specify a CMK, use its key ID, Amazon Resource Name (ARN),\n alias name, or alias ARN. Note that you should only provide this parameter if the\n key is different from the default DynamoDB KMS master key alias/aws/dynamodb.

" } }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index settings.

" + } + }, "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { @@ -1625,16 +1625,24 @@ "com.amazonaws.dynamodb#CreateTableInput": { "type": "structure", "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table to create.

", + "smithy.api#required": {} + } + }, "SSESpecification": { "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { "smithy.api#documentation": "

Represents the settings used to enable server-side encryption.

" } }, - "StreamSpecification": { - "target": "com.amazonaws.dynamodb#StreamSpecification", + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "

The settings for DynamoDB Streams on the table. These settings consist of:

\n " + "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes.

", + "smithy.api#required": {} } }, "KeySchema": { @@ -1644,19 +1652,24 @@ "smithy.api#required": {} } }, - "AttributeDefinitions": { - "target": "com.amazonaws.dynamodb#AttributeDefinitions", - "traits": { - "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes.

", - "smithy.api#required": {} - } - }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", "traits": { "smithy.api#documentation": "

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

\n " } }, + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

The settings for DynamoDB Streams on the table. These settings consist of:

\n " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.

\n\t\t

If you set BillingMode as PROVISIONED, you must specify this property. If you\n set BillingMode as PAY_PER_REQUEST, you cannot specify this\n property.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { @@ -1669,24 +1682,11 @@ "smithy.api#documentation": "

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

\n

Each local secondary index in the array includes the following:

\n " } }, - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", - "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the UpdateTable operation.

\n\t\t

\n\t\t\tIf you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as\n\t\t\tPAY_PER_REQUEST, you cannot specify this property. \n\t\t

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer\n Guide.

" - } - }, "Tags": { "target": "com.amazonaws.dynamodb#TagList", "traits": { "smithy.api#documentation": "

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

" } - }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "

The name of the table to create.

", - "smithy.api#required": {} - } } }, "traits": { @@ -1720,10 +1720,10 @@ "smithy.api#required": {} } }, - "ExpressionAttributeValues": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional delete to succeed.

" } }, "Key": { @@ -1733,10 +1733,10 @@ "smithy.api#required": {} } }, - "ConditionExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional delete to succeed.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" } }, "ExpressionAttributeNames": { @@ -1864,16 +1864,19 @@ "com.amazonaws.dynamodb#DeleteItemInput": { "type": "structure", "members": { - "ExpressionAttributeValues": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" } }, - "ConditionExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional DeleteItem to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" } }, "Key": { @@ -1883,25 +1886,23 @@ "smithy.api#required": {} } }, - "Expected": { - "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, - "ConditionalOperator": { - "target": "com.amazonaws.dynamodb#ConditionalOperator", + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional DeleteItem to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" - }, - "ReturnValues": { - "target": "com.amazonaws.dynamodb#ReturnValue", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared before they\n were deleted. For DeleteItem, the valid values are:

\n \n \n

The ReturnValues parameter is used by several DynamoDB operations; however,\n DeleteItem does not recognize any values other than NONE or\n ALL_OLD.

\n " + "smithy.api#documentation": "

The name of the table from which to delete the item.

", + "smithy.api#required": {} } }, "ExpressionAttributeNames": { @@ -1916,11 +1917,10 @@ "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "ReturnValues": { + "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "

The name of the table from which to delete the item.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared before they\n were deleted. For DeleteItem, the valid values are:

\n \n \n

The ReturnValues parameter is used by several DynamoDB operations; however,\n DeleteItem does not recognize any values other than NONE or\n ALL_OLD.

\n " } } }, @@ -1931,6 +1931,12 @@ "com.amazonaws.dynamodb#DeleteItemOutput": { "type": "structure", "members": { + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the DeleteItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned Mode in the Amazon DynamoDB Developer\n Guide.

" + } + }, "ItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", "traits": { @@ -1942,12 +1948,6 @@ "traits": { "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the item as it\n appeared before the DeleteItem operation. This map appears in the response only if\n ReturnValues was specified as ALL_OLD in the request.

" } - }, - "ConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ConsumedCapacity", - "traits": { - "smithy.api#documentation": "

The capacity units consumed by the DeleteItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned Mode in the Amazon DynamoDB Developer\n Guide.

" - } } }, "traits": { @@ -2190,6 +2190,18 @@ "com.amazonaws.dynamodb#DescribeContributorInsightsOutput": { "type": "structure", "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table being described.

" + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index being described.

" + } + }, "FailureException": { "target": "com.amazonaws.dynamodb#FailureException", "traits": { @@ -2202,12 +2214,6 @@ "smithy.api#documentation": "

List of names of the associated Alpine rules.

" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "

The name of the table being described.

" - } - }, "ContributorInsightsStatus": { "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", "traits": { @@ -2219,12 +2225,6 @@ "traits": { "smithy.api#documentation": "

Timestamp of the last time the status was changed.

" } - }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", - "traits": { - "smithy.api#documentation": "

The name of the global secondary index being described.

" - } } } }, @@ -2371,7 +2371,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the current provisioned-capacity limits for your AWS account in a Region, both\n for the Region as a whole and for any one DynamoDB table that you create there.

\n

When you establish an AWS account, the account has initial limits on the maximum read\n capacity units and write capacity units that you can provision across all of your\n DynamoDB tables in a given Region. Also, there are per-table limits that apply when you\n create a table there. For more information, see Limits page in the\n Amazon DynamoDB Developer Guide.

\n\n

Although you can increase these limits by filing a case at\n AWS Support Center,\n obtaining the increase is not instantaneous. The DescribeLimits\n action lets you write code to compare the capacity you are currently using to those limits\n imposed by your account so that you have enough time to apply for an increase before you hit\n a limit.

\n\n

For example, you could use one of the AWS SDKs to do the following:

\n\n
    \n
  1. \n

    Call DescribeLimits for a particular Region to obtain your current\n account limits on provisioned capacity there.

    \n
    2. \n
  2. \n

    Create a variable to hold the aggregate read capacity units provisioned for all\n your tables in that Region, and one to hold the aggregate write capacity units.\n Zero them both.

    \n
    3. \n
  3. \n

    Call ListTables to obtain a list of all your DynamoDB tables.

    \n
    4. \n
  4. \n

    For each table name listed by ListTables, do the following:

    \n
      \n
    • \n

      Call DescribeTable with the table name.

      \n
      • \n
    • \n

      Use the data returned by DescribeTable to add the read capacity units and write capacity\n units provisioned for the table itself to your variables.

      \n
      • \n
    • \n

      If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

      \n
      • \n
    \n
    5. \n
  5. \n

    Report the account limits for that Region returned by DescribeLimits, along with\n the total current provisioned capacity levels you have calculated.

    \n
    6. \n
\n\n

This will let you see whether you are getting close to your account-level limits.

\n

The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

\n

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly. But the only upper limit that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account limits.

\n \n

\n DescribeLimits should only be called periodically. You can expect throttling\n errors if you call it more than once in a minute.

\n \n

The DescribeLimits Request element has no content.

" + "smithy.api#documentation": "

Returns the current provisioned-capacity quotas for your AWS account in a Region, both\n for the Region as a whole and for any one DynamoDB table that you create there.

\n

When you establish an AWS account, the account has initial quotas on the maximum read\n capacity units and write capacity units that you can provision across all of your\n DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you\n create a table there. For more information, see Service, Account, and Table\n Quotas page in the Amazon DynamoDB Developer\n Guide.

\n\n

Although you can increase these quotas by filing a case at AWS Support Center, obtaining the increase is not\n instantaneous. The DescribeLimits action lets you write code to compare the\n capacity you are currently using to those quotas imposed by your account so that you\n have enough time to apply for an increase before you hit a quota.

\n\n

For example, you could use one of the AWS SDKs to do the following:

\n\n
    \n
  1. \n

    Call DescribeLimits for a particular Region to obtain your current\n account quotas on provisioned capacity there.

    \n
    2. \n
  2. \n

    Create a variable to hold the aggregate read capacity units provisioned for all\n your tables in that Region, and one to hold the aggregate write capacity units.\n Zero them both.

    \n
    3. \n
  3. \n

    Call ListTables to obtain a list of all your DynamoDB tables.

    \n
    4. \n
  4. \n

    For each table name listed by ListTables, do the following:

    \n
      \n
    • \n

      Call DescribeTable with the table name.

      \n
      • \n
    • \n

      Use the data returned by DescribeTable to add the read capacity units and write capacity\n units provisioned for the table itself to your variables.

      \n
      • \n
    • \n

      If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

      \n
      • \n
    \n
    5. \n
  5. \n

    Report the account quotas for that Region returned by DescribeLimits, along with\n the total current provisioned capacity levels you have calculated.

    \n
    6. \n
\n\n

This will let you see whether you are getting close to your account-level quotas.

\n

The per-table quotas apply only when you are creating a new table. They restrict the sum\n of the provisioned capacity of the new table itself and all its global secondary\n indexes.

\n

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly, but the only quota that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account quotas.

\n \n

\n DescribeLimits should only be called periodically. You can expect throttling\n errors if you call it more than once in a minute.

\n \n

The DescribeLimits Request element has no content.

" } }, "com.amazonaws.dynamodb#DescribeLimitsInput": { @@ -2384,16 +2384,16 @@ "com.amazonaws.dynamodb#DescribeLimitsOutput": { "type": "structure", "members": { - "AccountMaxWriteCapacityUnits": { + "TableMaxWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum total write capacity units that your account allows you to provision across\n all of your tables in this Region.

" + "smithy.api#documentation": "

The maximum write capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the write capacity units\n provisioned for its global secondary indexes (GSIs).

" } }, - "TableMaxWriteCapacityUnits": { + "AccountMaxWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum write capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the write capacity units\n provisioned for its global secondary indexes (GSIs).

" + "smithy.api#documentation": "

The maximum total write capacity units that your account allows you to provision across\n all of your tables in this Region.

" } }, "TableMaxReadCapacityUnits": { @@ -2697,7 +2697,7 @@ "sdkId": "DynamoDB", "arnNamespace": "dynamodb", "cloudFormationName": "DynamoDB", - "cloudTrailEventSource": "v20120810.dynamodb.amazonaws.com" + "cloudTrailEventSource": "dynamodb.amazonaws.com" }, "aws.auth#sigv4": { "name": "dynamodb" @@ -2856,17 +2856,17 @@ "smithy.api#documentation": "

A string that identifies one or more attributes of the specified item\n to retrieve from the table. The attributes in the expression must be\n separated by commas. If no attribute names are specified, then all\n attributes of the specified item are returned. If any of the requested\n attributes are not found, they do not appear in the result.

" } }, - "Key": { - "target": "com.amazonaws.dynamodb#Key", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

A map of attribute names to AttributeValue objects that\n specifies the primary key of the item to retrieve.

", + "smithy.api#documentation": "

The name of the table from which to retrieve the specified item.

", "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "Key": { + "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The name of the table from which to retrieve the specified item.

", + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects that\n specifies the primary key of the item to retrieve.

", "smithy.api#required": {} } } @@ -2907,10 +2907,10 @@ "com.amazonaws.dynamodb#GetItemInput": { "type": "structure", "members": { - "ProjectionExpression": { - "target": "com.amazonaws.dynamodb#ProjectionExpression", + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

" } }, "TableName": { @@ -2920,11 +2920,8 @@ "smithy.api#required": {} } }, - "AttributesToGet": { - "target": "com.amazonaws.dynamodb#AttributeNameList", - "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.

" - } + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", @@ -2932,8 +2929,11 @@ "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.

" + } }, "Key": { "target": "com.amazonaws.dynamodb#Key", @@ -2942,10 +2942,10 @@ "smithy.api#required": {} } }, - "ConsistentRead": { - "target": "com.amazonaws.dynamodb#ConsistentRead", + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

" + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -2956,17 +2956,17 @@ "com.amazonaws.dynamodb#GetItemOutput": { "type": "structure", "members": { - "ConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ConsumedCapacity", - "traits": { - "smithy.api#documentation": "

The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer\n Guide.

" - } - }, "Item": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, as specified\n by ProjectionExpression.

" } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer\n Guide.

" + } } }, "traits": { @@ -2986,7 +2986,7 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" } }, "IndexName": { @@ -3039,22 +3039,22 @@ "com.amazonaws.dynamodb#GlobalSecondaryIndexDescription": { "type": "structure", "members": { - "Projection": { - "target": "com.amazonaws.dynamodb#Projection", + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" } }, - "ItemCount": { - "target": "com.amazonaws.dynamodb#Long", + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", "traits": { - "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" } }, - "IndexSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", "traits": { - "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" } }, "IndexArn": { @@ -3069,22 +3069,16 @@ "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

\n " } }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", - "traits": { - "smithy.api#documentation": "

The name of the global secondary index.

" - } - }, "IndexStatus": { "target": "com.amazonaws.dynamodb#IndexStatus", "traits": { "smithy.api#documentation": "

The current state of the global secondary index:

\n " } }, - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The name of the global secondary index.

" } }, "Backfilling": { @@ -3092,6 +3086,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from \n the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key \n cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, \n the backfilling operation is complete and Backfilling is false.

\n

You can delete an index that is being created during the Backfilling phase\n when IndexStatus is set to CREATING and Backfilling is true. You\n can't delete the index that is being created when IndexStatus is set to\n CREATING and Backfilling is false.

\n \n

For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

\n " } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#Long", + "traits": { + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + } } }, "traits": { @@ -3119,17 +3119,17 @@ "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

\n " } }, - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", - "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

" - } - }, "Projection": { "target": "com.amazonaws.dynamodb#Projection", "traits": { "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into\n the global secondary index. These are in addition to the primary\n key attributes and index key attributes, which are automatically\n projected.

" } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

" + } } }, "traits": { @@ -3151,17 +3151,17 @@ "smithy.api#documentation": "

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

" } }, - "Create": { - "target": "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction", - "traits": { - "smithy.api#documentation": "

The parameters required for creating a global secondary index on an existing table:

\n " - } - }, "Delete": { "target": "com.amazonaws.dynamodb#DeleteGlobalSecondaryIndexAction", "traits": { "smithy.api#documentation": "

The name of an existing global secondary index to be removed.

" } + }, + "Create": { + "target": "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction", + "traits": { + "smithy.api#documentation": "

The parameters required for creating a global secondary index on an existing table:

\n " + } } }, "traits": { @@ -3183,17 +3183,17 @@ "com.amazonaws.dynamodb#GlobalTable": { "type": "structure", "members": { - "ReplicationGroup": { - "target": "com.amazonaws.dynamodb#ReplicaList", - "traits": { - "smithy.api#documentation": "

The Regions where the global table has replicas.

" - } - }, "GlobalTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The global table name.

" } + }, + "ReplicationGroup": { + "target": "com.amazonaws.dynamodb#ReplicaList", + "traits": { + "smithy.api#documentation": "

The Regions where the global table has replicas.

" + } } }, "traits": { @@ -3218,10 +3218,10 @@ "com.amazonaws.dynamodb#GlobalTableDescription": { "type": "structure", "members": { - "CreationDateTime": { - "target": "com.amazonaws.dynamodb#Date", + "GlobalTableArn": { + "target": "com.amazonaws.dynamodb#GlobalTableArnString", "traits": { - "smithy.api#documentation": "

The creation time of the global table.

" + "smithy.api#documentation": "

The unique identifier of the global table.

" } }, "ReplicationGroup": { @@ -3230,22 +3230,22 @@ "smithy.api#documentation": "

The Regions where the global table has replicas.

" } }, - "GlobalTableStatus": { - "target": "com.amazonaws.dynamodb#GlobalTableStatus", - "traits": { - "smithy.api#documentation": "

The current state of the global table:

\n " - } - }, "GlobalTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The global table name.

" } }, - "GlobalTableArn": { - "target": "com.amazonaws.dynamodb#GlobalTableArnString", + "CreationDateTime": { + "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

The unique identifier of the global table.

" + "smithy.api#documentation": "

The creation time of the global table.

" + } + }, + "GlobalTableStatus": { + "target": "com.amazonaws.dynamodb#GlobalTableStatus", + "traits": { + "smithy.api#documentation": "

The current state of the global table:

\n " } } }, @@ -3640,12 +3640,6 @@ "com.amazonaws.dynamodb#KeysAndAttributes": { "type": "structure", "members": { - "ProjectionExpression": { - "target": "com.amazonaws.dynamodb#ProjectionExpression", - "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by\n commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" - } - }, "Keys": { "target": "com.amazonaws.dynamodb#KeyList", "traits": { @@ -3653,12 +3647,6 @@ "smithy.api#required": {} } }, - "ConsistentRead": { - "target": "com.amazonaws.dynamodb#ConsistentRead", - "traits": { - "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly consistent\n read is used; otherwise, an eventually consistent read is used.

" - } - }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { @@ -3670,6 +3658,18 @@ "traits": { "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly consistent\n read is used; otherwise, an eventually consistent read is used.

" + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by\n commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" + } } }, "traits": { @@ -3690,7 +3690,7 @@ } }, "traits": { - "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be taken.

\n

Up to 50 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary indexes. You can have up to \n 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily \n reduce the number of concurrent operations.

\n

There is a soft account limit of 256 tables.

", + "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be taken.

\n

Up to 50 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary indexes. You can have up to \n 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily \n reduce the number of concurrent operations.

\n

There is a soft account quota of 256 tables.

", "smithy.api#error": "client" } }, @@ -3717,7 +3717,7 @@ } ], "traits": { - "smithy.api#documentation": "

List backups associated with an AWS account. To list backups for a given table, specify\n TableName. ListBackups returns a paginated list of results\n with at most 1 MB worth of items in a page. You can also specify a limit for the maximum\n number of entries to be returned in a page.

\n

In the request, start time is inclusive, but end time is exclusive. Note that these\n limits are for the time at which the original backup was requested.

\n

You can call ListBackups a maximum of five times per second.

" + "smithy.api#documentation": "

List backups associated with an AWS account. To list backups for a given table, specify\n TableName. ListBackups returns a paginated list of results\n with at most 1 MB worth of items in a page. You can also specify a maximum number of\n entries to be returned in a page.

\n

In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.

\n

You can call ListBackups a maximum of five times per second.

" } }, "com.amazonaws.dynamodb#ListBackupsInput": { @@ -3729,10 +3729,10 @@ "smithy.api#documentation": "

The backups from the table specified by BackupType are listed.

\n

Where BackupType can be:

\n " } }, - "TimeRangeUpperBound": { - "target": "com.amazonaws.dynamodb#TimeRangeUpperBound", + "TimeRangeLowerBound": { + "target": "com.amazonaws.dynamodb#TimeRangeLowerBound", "traits": { - "smithy.api#documentation": "

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

" + "smithy.api#documentation": "

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

" } }, "ExclusiveStartBackupArn": { @@ -3741,18 +3741,18 @@ "smithy.api#documentation": "

\n LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last\n evaluated when the current page of results was returned, inclusive of the current page\n of results. This value may be specified as the ExclusiveStartBackupArn of a\n new ListBackups operation in order to fetch the next page of results.

" } }, - "TimeRangeLowerBound": { - "target": "com.amazonaws.dynamodb#TimeRangeLowerBound", - "traits": { - "smithy.api#documentation": "

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The backups from the table specified by TableName are listed.

" } }, + "TimeRangeUpperBound": { + "target": "com.amazonaws.dynamodb#TimeRangeUpperBound", + "traits": { + "smithy.api#documentation": "

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

" + } + }, "Limit": { "target": "com.amazonaws.dynamodb#BackupsInputLimit", "traits": { @@ -3764,17 +3764,17 @@ "com.amazonaws.dynamodb#ListBackupsOutput": { "type": "structure", "members": { - "BackupSummaries": { - "target": "com.amazonaws.dynamodb#BackupSummaries", - "traits": { - "smithy.api#documentation": "

List of BackupSummary objects.

" - } - }, "LastEvaluatedBackupArn": { "target": "com.amazonaws.dynamodb#BackupArn", "traits": { "smithy.api#documentation": "

\n The ARN of the backup last evaluated when the current page of results was returned,\n inclusive of the current page of results. This value may be specified as the\n ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.\n

\n

\n If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no\n more results to be retrieved.\n

\n

If LastEvaluatedBackupArn is not empty, this may or may not indicate that\n there is more data to be returned. All results are guaranteed to have been returned if\n and only if no value for LastEvaluatedBackupArn is returned.

" } + }, + "BackupSummaries": { + "target": "com.amazonaws.dynamodb#BackupSummaries", + "traits": { + "smithy.api#documentation": "

List of BackupSummary objects.

" + } } } }, @@ -3812,17 +3812,17 @@ "smithy.api#documentation": "

The name of the table.

" } }, - "MaxResults": { - "target": "com.amazonaws.dynamodb#ListContributorInsightsLimit", - "traits": { - "smithy.api#documentation": "

Maximum number of results to return per page.

" - } - }, "NextToken": { "target": "com.amazonaws.dynamodb#NextTokenString", "traits": { "smithy.api#documentation": "

A token to for the desired page, if there is one.

" } + }, + "MaxResults": { + "target": "com.amazonaws.dynamodb#ListContributorInsightsLimit", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return per page.

" + } } } }, @@ -3874,10 +3874,10 @@ "com.amazonaws.dynamodb#ListGlobalTablesInput": { "type": "structure", "members": { - "ExclusiveStartGlobalTableName": { - "target": "com.amazonaws.dynamodb#TableName", + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", "traits": { - "smithy.api#documentation": "

The first global table name that this operation will evaluate.

" + "smithy.api#documentation": "

Lists the global tables in a specific Region.

" } }, "Limit": { @@ -3886,10 +3886,10 @@ "smithy.api#documentation": "

The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.

\n

If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point,\n with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

" } }, - "RegionName": { - "target": "com.amazonaws.dynamodb#RegionName", + "ExclusiveStartGlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

Lists the global tables in a specific Region.

" + "smithy.api#documentation": "

The first global table name that this operation will evaluate.

" } } } @@ -3970,17 +3970,17 @@ "com.amazonaws.dynamodb#ListTablesOutput": { "type": "structure", "members": { - "TableNames": { - "target": "com.amazonaws.dynamodb#TableNameList", - "traits": { - "smithy.api#documentation": "

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

\n

If LastEvaluatedTableName also appears in the output, you can use this value as the\n ExclusiveStartTableName parameter in a subsequent ListTables request and\n obtain the next page of results.

" - } - }, "LastEvaluatedTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The name of the last table in the current page of results. Use this value as the\n ExclusiveStartTableName in a new request to obtain the next page of results, until\n all the table names are returned.

\n

If you do not receive a LastEvaluatedTableName value in the response, this means that\n there are no more table names to be retrieved.

" } + }, + "TableNames": { + "target": "com.amazonaws.dynamodb#TableNameList", + "traits": { + "smithy.api#documentation": "

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

\n

If LastEvaluatedTableName also appears in the output, you can use this value as the\n ExclusiveStartTableName parameter in a subsequent ListTables request and\n obtain the next page of results.

" + } } }, "traits": { @@ -4013,18 +4013,18 @@ "com.amazonaws.dynamodb#ListTagsOfResourceInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.dynamodb#NextTokenString", - "traits": { - "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

" - } - }, "ResourceArn": { "target": "com.amazonaws.dynamodb#ResourceArnString", "traits": { "smithy.api#documentation": "

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

" + } } } }, @@ -4048,10 +4048,10 @@ "com.amazonaws.dynamodb#LocalSecondaryIndex": { "type": "structure", "members": { - "Projection": { - "target": "com.amazonaws.dynamodb#Projection", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the local\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

", + "smithy.api#documentation": "

The name of the local secondary index. The name must be unique among all other indexes on this table.

", "smithy.api#required": {} } }, @@ -4062,10 +4062,10 @@ "smithy.api#required": {} } }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", "traits": { - "smithy.api#documentation": "

The name of the local secondary index. The name must be unique among all other indexes on this table.

", + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the local\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

", "smithy.api#required": {} } } @@ -4077,22 +4077,16 @@ "com.amazonaws.dynamodb#LocalSecondaryIndexDescription": { "type": "structure", "members": { - "IndexArn": { - "target": "com.amazonaws.dynamodb#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the index.

" - } - }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { "smithy.api#documentation": "

Represents the name of the local secondary index.

" } }, - "Projection": { - "target": "com.amazonaws.dynamodb#Projection", + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the index.

" } }, "IndexSizeBytes": { @@ -4101,10 +4095,10 @@ "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" } }, - "ItemCount": { - "target": "com.amazonaws.dynamodb#Long", + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", "traits": { - "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" } }, "KeySchema": { @@ -4112,6 +4106,12 @@ "traits": { "smithy.api#documentation": "

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

\n " } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#Long", + "traits": { + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + } } }, "traits": { @@ -4127,18 +4127,18 @@ "com.amazonaws.dynamodb#LocalSecondaryIndexInfo": { "type": "structure", "members": { - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", - "traits": { - "smithy.api#documentation": "

Represents the name of the local secondary index.

" - } - }, "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { "smithy.api#documentation": "

The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

\n " } }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

Represents the name of the local secondary index.

" + } + }, "Projection": { "target": "com.amazonaws.dynamodb#Projection", "traits": { @@ -4231,17 +4231,17 @@ "smithy.api#documentation": "

Specifies the earliest point in time you can restore your table to. You can restore your\n table to any point in time during the last 35 days.

" } }, - "PointInTimeRecoveryStatus": { - "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", - "traits": { - "smithy.api#documentation": "

The current state of point in time recovery:

\n " - } - }, "LatestRestorableDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { "smithy.api#documentation": "

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n

" } + }, + "PointInTimeRecoveryStatus": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", + "traits": { + "smithy.api#documentation": "

The current state of point in time recovery:

\n " + } } }, "traits": { @@ -4312,7 +4312,7 @@ "ProjectionType": { "target": "com.amazonaws.dynamodb#ProjectionType", "traits": { - "smithy.api#documentation": "

The set of attributes that are projected into the index:

\n " + "smithy.api#documentation": "

The set of attributes that are projected into the index:

\n " } }, "NonKeyAttributes": { @@ -4364,7 +4364,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#ProvisionedThroughputDescription": { @@ -4385,13 +4385,7 @@ "NumberOfDecreasesToday": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

" - } - }, - "LastDecreaseDateTime": { - "target": "com.amazonaws.dynamodb#Date", - "traits": { - "smithy.api#documentation": "

The date and time of the last provisioned throughput decrease for this table.

" + "smithy.api#documentation": "

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" } }, "ReadCapacityUnits": { @@ -4399,6 +4393,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

" } + }, + "LastDecreaseDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time of the last provisioned throughput decrease for this table.

" + } } }, "traits": { @@ -4443,12 +4443,6 @@ "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" } }, - "ConditionExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", - "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -4456,6 +4450,12 @@ "smithy.api#required": {} } }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

" + } + }, "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { @@ -4521,24 +4521,18 @@ "com.amazonaws.dynamodb#PutItemInput": { "type": "structure", "members": { - "ReturnItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", - "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" - } - }, - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", - "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" - } - }, "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared before they\n were updated with the PutItem request. For PutItem, the valid values are:

\n \n \n

The ReturnValues parameter is used by several DynamoDB operations; however,\n PutItem does not recognize any values other than NONE or\n ALL_OLD.

\n " } }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + } + }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -4553,31 +4547,37 @@ "smithy.api#required": {} } }, - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" - }, - "ExpressionAttributeValues": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional PutItem operation to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" + } + }, "ConditionalOperator": { "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" } }, - "Expected": { - "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -4667,24 +4667,6 @@ "com.amazonaws.dynamodb#QueryInput": { "type": "structure", "members": { - "KeyConditions": { - "target": "com.amazonaws.dynamodb#KeyConditions", - "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see\n KeyConditions in the Amazon DynamoDB Developer Guide.

" - } - }, - "ScanIndexForward": { - "target": "com.amazonaws.dynamodb#BooleanObject", - "traits": { - "smithy.api#documentation": "

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

\n

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

\n

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

" - } - }, - "QueryFilter": { - "target": "com.amazonaws.dynamodb#FilterConditionMap", - "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n QueryFilter in the Amazon DynamoDB Developer Guide.

" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -4698,8 +4680,17 @@ "smithy.api#documentation": "

The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that\n if you use the IndexName parameter, you must also provide TableName.\n

" } }, - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + "KeyConditions": { + "target": "com.amazonaws.dynamodb#KeyConditions", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see\n KeyConditions in the Amazon DynamoDB Developer Guide.

" + } + }, + "ScanIndexForward": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

\n

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

\n

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

" + } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", @@ -4713,6 +4704,15 @@ "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.

" } }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "QueryFilter": { + "target": "com.amazonaws.dynamodb#FilterConditionMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n QueryFilter in the Amazon DynamoDB Developer Guide.

" + } + }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { @@ -4731,10 +4731,10 @@ "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

\n

Strongly consistent reads\n are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.

" } }, - "ConditionalOperator": { - "target": "com.amazonaws.dynamodb#ConditionalOperator", + "KeyConditionExpression": { + "target": "com.amazonaws.dynamodb#KeyExpression", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The condition that specifies the key values for items to be retrieved by the\n Query action.

\n\n

The condition must perform an equality test on a single partition key value.

\n

The condition can optionally perform one of several comparison tests on a single\n sort key value. This allows Query to retrieve one item with a given\n partition key value and sort key value, or several items that have the same partition\n key value but different sort key values.

\n\n

The partition key equality test is required, and must be specified in the following format:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n

\n\n

If you also want to provide a condition for the sort key, it must be combined using AND with the condition\n for the sort key. Following is an example, using the = comparison operator for the sort key:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n

\n

Valid comparisons for the sort key condition are as follows:

\n \n\n

Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at runtime.

\n\n

You can optionally use the ExpressionAttributeNames parameter to replace the names of\n the partition key and sort key with placeholder tokens. This option might be necessary if an attribute\n name conflicts with a DynamoDB reserved word. For example, the following\n KeyConditionExpression parameter causes an error because Size is a reserved\n word:

\n \n

To work around this, define a placeholder (such a #S) to represent the attribute\n name Size. KeyConditionExpression then is as follows:

\n \n

For a list of reserved words, see Reserved\n Words in the Amazon DynamoDB Developer Guide.

\n\n

For more information on ExpressionAttributeNames and ExpressionAttributeValues,\n see Using Placeholders for Attribute\n Names and Values in the Amazon DynamoDB Developer Guide.

" } }, "Select": { @@ -4743,16 +4743,16 @@ "smithy.api#documentation": "

The attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n the index.

\n \n

If neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.

\n " } }, - "Limit": { - "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" } }, - "FilterExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.

" } }, "ExclusiveStartKey": { @@ -4761,10 +4761,10 @@ "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number, or Binary. No\n set data types are allowed.

" } }, - "KeyConditionExpression": { - "target": "com.amazonaws.dynamodb#KeyExpression", + "FilterExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

The condition that specifies the key values for items to be retrieved by the\n Query action.

\n\n

The condition must perform an equality test on a single partition key value.

\n

The condition can optionally perform one of several comparison tests on a single\n sort key value. This allows Query to retrieve one item with a given\n partition key value and sort key value, or several items that have the same partition\n key value but different sort key values.

\n\n

The partition key equality test is required, and must be specified in the following format:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n

\n\n

If you also want to provide a condition for the sort key, it must be combined using AND with the condition\n for the sort key. Following is an example, using the = comparison operator for the sort key:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n

\n

Valid comparisons for the sort key condition are as follows:

\n \n\n

Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at runtime.

\n\n

You can optionally use the ExpressionAttributeNames parameter to replace the names of\n the partition key and sort key with placeholder tokens. This option might be necessary if an attribute\n name conflicts with a DynamoDB reserved word. For example, the following\n KeyConditionExpression parameter causes an error because Size is a reserved\n word:

\n \n

To work around this, define a placeholder (such a #S) to represent the attribute\n name Size. KeyConditionExpression then is as follows:

\n \n

For a list of reserved words, see Reserved\n Words in the Amazon DynamoDB Developer Guide.

\n\n

For more information on ExpressionAttributeNames and ExpressionAttributeValues,\n see Using Placeholders for Attribute\n Names and Values in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer Guide.

" } } }, @@ -4775,34 +4775,34 @@ "com.amazonaws.dynamodb#QueryOutput": { "type": "structure", "members": { - "ScannedCount": { - "target": "com.amazonaws.dynamodb#Integer", - "traits": { - "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Query operation. For more information, see Count and ScannedCount in the\n Amazon DynamoDB Developer Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same as\n Count.

" - } - }, - "Count": { - "target": "com.amazonaws.dynamodb#Integer", - "traits": { - "smithy.api#documentation": "

The number of items in the response.

\n

If you used a QueryFilter in the request, then Count is the number of items\n returned after the filter was applied, and ScannedCount is the number of\n matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count and ScannedCount are the\n same.

" - } - }, "Items": { "target": "com.amazonaws.dynamodb#ItemList", "traits": { "smithy.api#documentation": "

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

" } }, + "LastEvaluatedKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

" + } + }, "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { "smithy.api#documentation": "

The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.

" } }, - "LastEvaluatedKey": { - "target": "com.amazonaws.dynamodb#Key", + "ScannedCount": { + "target": "com.amazonaws.dynamodb#Integer", "traits": { - "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

" + "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Query operation. For more information, see Count and ScannedCount in the\n Amazon DynamoDB Developer Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same as\n Count.

" + } + }, + "Count": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#documentation": "

The number of items in the response.

\n

If you used a QueryFilter in the request, then Count is the number of items\n returned after the filter was applied, and ScannedCount is the number of\n matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count and ScannedCount are the\n same.

" } } }, @@ -4848,6 +4848,12 @@ "smithy.api#documentation": "

The Region where the replica exists.

" } }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescriptionList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index auto scaling settings.

" + } + }, "ReplicaProvisionedReadCapacityAutoScalingSettings": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" }, @@ -4859,12 +4865,6 @@ "traits": { "smithy.api#documentation": "

The current state of the replica:

\n " } - }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescriptionList", - "traits": { - "smithy.api#documentation": "

Replica-specific global secondary index auto scaling settings.

" - } } }, "traits": { @@ -4915,12 +4915,6 @@ "com.amazonaws.dynamodb#ReplicaDescription": { "type": "structure", "members": { - "RegionName": { - "target": "com.amazonaws.dynamodb#RegionName", - "traits": { - "smithy.api#documentation": "

The name of the Region.

" - } - }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList", "traits": { @@ -4933,22 +4927,22 @@ "smithy.api#documentation": "

Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.

" } }, - "ReplicaStatus": { - "target": "com.amazonaws.dynamodb#ReplicaStatus", + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", "traits": { - "smithy.api#documentation": "

The current state of the replica:

\n " + "smithy.api#documentation": "

The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS\n encryption.

" } }, - "ReplicaStatusPercentProgress": { - "target": "com.amazonaws.dynamodb#ReplicaStatusPercentProgress", + "ReplicaInaccessibleDateTime": { + "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

Specifies the progress of a Create, Update, or Delete action on the replica\n as a percentage.

" + "smithy.api#documentation": "

The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

" } }, - "KMSMasterKeyId": { - "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", "traits": { - "smithy.api#documentation": "

The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS\n encryption.

" + "smithy.api#documentation": "

The name of the Region.

" } }, "ReplicaStatusDescription": { @@ -4956,6 +4950,18 @@ "traits": { "smithy.api#documentation": "

Detailed information about the replica status.

" } + }, + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", + "traits": { + "smithy.api#documentation": "

The current state of the replica:

\n " + } + }, + "ReplicaStatusPercentProgress": { + "target": "com.amazonaws.dynamodb#ReplicaStatusPercentProgress", + "traits": { + "smithy.api#documentation": "

Specifies the progress of a Create, Update, or Delete action on the replica\n as a percentage.

" + } } }, "traits": { @@ -5024,14 +5030,14 @@ "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdate": { "type": "structure", "members": { - "ProvisionedReadCapacityAutoScalingUpdate": { - "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" - }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { "smithy.api#documentation": "

The name of the global secondary index.

" } + }, + "ProvisionedReadCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" } }, "traits": { @@ -5047,17 +5053,17 @@ "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescription": { "type": "structure", "members": { - "ProvisionedThroughputOverride": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", - "traits": { - "smithy.api#documentation": "

If not described, uses the source table GSI's read capacity settings.

" - } - }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { "smithy.api#documentation": "

The name of the global secondary index.

" } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

If not described, uses the source table GSI's read capacity settings.

" + } } }, "traits": { @@ -5084,16 +5090,23 @@ "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescription": { "type": "structure", "members": { - "ProvisionedWriteCapacityAutoScalingSettings": { - "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's write capacity\n units.

" + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other indexes on this table.

", + "smithy.api#required": {} } }, - "IndexStatus": { - "target": "com.amazonaws.dynamodb#IndexStatus", + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

\n The current status of the global secondary index:

\n " + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

" + } + }, + "ProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's write capacity\n units.

" } }, "ProvisionedWriteCapacityUnits": { @@ -5102,11 +5115,10 @@ "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" } }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", "traits": { - "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other indexes on this table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The current status of the global secondary index:

\n " } }, "ProvisionedReadCapacityAutoScalingSettings": { @@ -5114,12 +5126,6 @@ "traits": { "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's read capacity units.

" } - }, - "ProvisionedReadCapacityUnits": { - "target": "com.amazonaws.dynamodb#PositiveLongObject", - "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

" - } } }, "traits": { @@ -5192,12 +5198,6 @@ "com.amazonaws.dynamodb#ReplicaSettingsDescription": { "type": "structure", "members": { - "ReplicaProvisionedWriteCapacityAutoScalingSettings": { - "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", - "traits": { - "smithy.api#documentation": "

Auto scaling settings for a global table replica's write capacity units.

" - } - }, "ReplicaProvisionedReadCapacityUnits": { "target": "com.amazonaws.dynamodb#NonNegativeLongObject", "traits": { @@ -5210,12 +5210,6 @@ "smithy.api#documentation": "

Auto scaling settings for a global table replica's read capacity units.

" } }, - "ReplicaProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.dynamodb#NonNegativeLongObject", - "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.

" - } - }, "RegionName": { "target": "com.amazonaws.dynamodb#RegionName", "traits": { @@ -5223,6 +5217,12 @@ "smithy.api#required": {} } }, + "ReplicaProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.

" + } + }, "ReplicaStatus": { "target": "com.amazonaws.dynamodb#ReplicaStatus", "traits": { @@ -5240,6 +5240,12 @@ "traits": { "smithy.api#documentation": "

Replica global secondary index settings for the global table.

" } + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global table replica's write capacity units.

" + } } }, "traits": { @@ -5255,16 +5261,22 @@ "com.amazonaws.dynamodb#ReplicaSettingsUpdate": { "type": "structure", "members": { + "ReplicaGlobalSecondaryIndexSettingsUpdate": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be modified.

" + } + }, "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", "traits": { "smithy.api#documentation": "

Auto scaling settings for managing a global table replica's read capacity units.

" } }, - "ReplicaGlobalSecondaryIndexSettingsUpdate": { - "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList", + "ReplicaProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be modified.

" + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.\n

" } }, "RegionName": { @@ -5273,12 +5285,6 @@ "smithy.api#documentation": "

The Region of the replica to be added.

", "smithy.api#required": {} } - }, - "ReplicaProvisionedReadCapacityUnits": { - "target": "com.amazonaws.dynamodb#PositiveLongObject", - "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.\n

" - } } }, "traits": { @@ -5315,6 +5321,9 @@ }, { "value": "ACTIVE" + }, + { + "value": "REGION_DISABLED" } ] } @@ -5396,7 +5405,7 @@ } }, "traits": { - "smithy.api#documentation": "

Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support to request a limit increase.

", + "smithy.api#documentation": "

Throughput exceeds the current throughput quota for your account. Please contact AWS Support at AWS Support to request a quota increase.

", "smithy.api#error": "client" } }, @@ -5448,18 +5457,19 @@ "com.amazonaws.dynamodb#RestoreSummary": { "type": "structure", "members": { - "SourceBackupArn": { - "target": "com.amazonaws.dynamodb#BackupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup from which the table was restored.

" - } - }, "SourceTableArn": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { "smithy.api#documentation": "

The ARN of the source table of the backup that is being restored.

" } }, + "RestoreInProgress": { + "target": "com.amazonaws.dynamodb#RestoreInProgress", + "traits": { + "smithy.api#documentation": "

Indicates if a restore is in progress or not.

", + "smithy.api#required": {} + } + }, "RestoreDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { @@ -5467,11 +5477,10 @@ "smithy.api#required": {} } }, - "RestoreInProgress": { - "target": "com.amazonaws.dynamodb#RestoreInProgress", + "SourceBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", "traits": { - "smithy.api#documentation": "

Indicates if a restore is in progress or not.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup from which the table was restored.

" } } }, @@ -5523,6 +5532,12 @@ "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" } }, + "LocalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" + } + }, "SSESpecificationOverride": { "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { @@ -5543,12 +5558,6 @@ "smithy.api#required": {} } }, - "LocalSecondaryIndexOverride": { - "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", - "traits": { - "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" - } - }, "BillingModeOverride": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { @@ -5621,59 +5630,59 @@ "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" } }, - "SourceTableArn": { - "target": "com.amazonaws.dynamodb#TableArn", + "SSESpecificationOverride": { + "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { - "smithy.api#documentation": "

The DynamoDB table that will be restored. This value is an Amazon\n Resource Name (ARN).

" + "smithy.api#documentation": "

The new server-side encryption settings for the restored table.

" } }, - "ProvisionedThroughputOverride": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "UseLatestRestorableTime": { + "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Provisioned throughput settings for the restored table.

" + "smithy.api#documentation": "

Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.

" } }, - "SSESpecificationOverride": { - "target": "com.amazonaws.dynamodb#SSESpecification", + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "

The new server-side encryption settings for the restored table.

" + "smithy.api#documentation": "

Provisioned throughput settings for the restored table.

" } }, - "TargetTableName": { - "target": "com.amazonaws.dynamodb#TableName", + "GlobalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

The name of the new table to which it must be restored to.

", - "smithy.api#required": {} + "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" } }, - "BillingModeOverride": { - "target": "com.amazonaws.dynamodb#BillingMode", + "RestoreDateTime": { + "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

The billing mode of the restored table.

" + "smithy.api#documentation": "

Time in the past to restore the table to.

" } }, - "SourceTableName": { - "target": "com.amazonaws.dynamodb#TableName", + "SourceTableArn": { + "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

Name of the source table that is being restored.

" + "smithy.api#documentation": "

The DynamoDB table that will be restored. This value is an Amazon\n Resource Name (ARN).

" } }, - "RestoreDateTime": { - "target": "com.amazonaws.dynamodb#Date", + "BillingModeOverride": { + "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "

Time in the past to restore the table to.

" + "smithy.api#documentation": "

The billing mode of the restored table.

" } }, - "GlobalSecondaryIndexOverride": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "TargetTableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" + "smithy.api#documentation": "

The name of the new table to which it must be restored to.

", + "smithy.api#required": {} } }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.dynamodb#BooleanObject", + "SourceTableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.

" + "smithy.api#documentation": "

Name of the source table that is being restored.

" } } } @@ -5763,18 +5772,18 @@ "smithy.api#documentation": "

Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's\n AWS KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB\n detects that the table's AWS KMS key is accessible again. DynamoDB will initiate the table\n archival process when table's AWS KMS key remains inaccessible for more than seven days\n from this date.

" } }, - "Status": { - "target": "com.amazonaws.dynamodb#SSEStatus", - "traits": { - "smithy.api#documentation": "

Represents the current state of server-side encryption. The only supported values are:

\n " - } - }, "KMSMasterKeyArn": { "target": "com.amazonaws.dynamodb#KMSMasterKeyArn", "traits": { "smithy.api#documentation": "

The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.

" } }, + "Status": { + "target": "com.amazonaws.dynamodb#SSEStatus", + "traits": { + "smithy.api#documentation": "

Represents the current state of server-side encryption. The only supported values are:

\n " + } + }, "SSEType": { "target": "com.amazonaws.dynamodb#SSEType", "traits": { @@ -5901,10 +5910,16 @@ "com.amazonaws.dynamodb#ScanInput": { "type": "structure", "members": { - "ExpressionAttributeValues": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

A Boolean value that determines the read consistency model during the scan:

\n \n

The default setting for ConsistentRead is false.

\n

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

" } }, "Select": { @@ -5913,6 +5928,12 @@ "smithy.api#documentation": "

The attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n the index.

\n \n

If neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.

\n " } }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, "Segment": { "target": "com.amazonaws.dynamodb#ScanSegment", "traits": { @@ -5925,18 +5946,6 @@ "smithy.api#documentation": "

For a parallel Scan request, TotalSegments represents the total number of\n segments into which the Scan operation will be divided. The value of\n TotalSegments corresponds to the number of application workers that will perform the\n parallel scan. For example, if you want to use four application threads to scan a table or an index,\n specify a TotalSegments value of 4.

\n

The value for TotalSegments must be greater than or equal to 1, and less than or equal\n to 1000000. If you specify a TotalSegments value of 1, the Scan operation will\n be sequential rather than parallel.

\n

If you specify TotalSegments, you must also specify Segment.

" } }, - "ConsistentRead": { - "target": "com.amazonaws.dynamodb#ConsistentRead", - "traits": { - "smithy.api#documentation": "

A Boolean value that determines the read consistency model during the scan:

\n \n

The default setting for ConsistentRead is false.

\n

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

" - } - }, - "ProjectionExpression": { - "target": "com.amazonaws.dynamodb#ProjectionExpression", - "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" - } - }, "ScanFilter": { "target": "com.amazonaws.dynamodb#FilterConditionMap", "traits": { @@ -5971,22 +5980,16 @@ "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, - "FilterExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", - "traits": { - "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.

\n \n

For more information, see\n Filter Expressions in the Amazon DynamoDB Developer Guide.

" - } - }, "ExclusiveStartKey": { "target": "com.amazonaws.dynamodb#Key", "traits": { "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

\n

In a parallel scan, a\n Scan request that includes ExclusiveStartKey must specify the same segment\n whose previous Scan returned the corresponding value of LastEvaluatedKey.

" } }, - "ConditionalOperator": { - "target": "com.amazonaws.dynamodb#ConditionalOperator", + "FilterExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.

\n \n

For more information, see\n Filter Expressions in the Amazon DynamoDB Developer Guide.

" } }, "Limit": { @@ -5994,6 +5997,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer\n Guide.

" } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + } } }, "traits": { @@ -6003,12 +6012,6 @@ "com.amazonaws.dynamodb#ScanOutput": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.dynamodb#ItemList", - "traits": { - "smithy.api#documentation": "

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

" - } - }, "Count": { "target": "com.amazonaws.dynamodb#Integer", "traits": { @@ -6021,16 +6024,22 @@ "smithy.api#documentation": "

The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Scan operation. For more information, see Count and ScannedCount in the\n Amazon DynamoDB Developer Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same as\n Count.

" } }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the Scan operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.

" + } + }, "LastEvaluatedKey": { "target": "com.amazonaws.dynamodb#Key", "traits": { "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results\n has been processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean\n that there is more data in the result set. The only way to know when you have reached\n the end of the result set is when LastEvaluatedKey is\n empty.

" } }, - "ConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "Items": { + "target": "com.amazonaws.dynamodb#ItemList", "traits": { - "smithy.api#documentation": "

The capacity units consumed by the Scan operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

" } } }, @@ -6089,10 +6098,10 @@ "com.amazonaws.dynamodb#SourceTableDetails": { "type": "structure", "members": { - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

Read IOPs and Write IOPS on the table when the backup was created.

", + "smithy.api#documentation": "

The name of the table for which the backup was created.

", "smithy.api#required": {} } }, @@ -6103,30 +6112,24 @@ "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "TableCreationDateTime": { + "target": "com.amazonaws.dynamodb#TableCreationDateTime", "traits": { - "smithy.api#documentation": "

The name of the table for which the backup was created.

", + "smithy.api#documentation": "

Time when the source table was created.

", "smithy.api#required": {} } }, - "ItemCount": { - "target": "com.amazonaws.dynamodb#ItemCount", - "traits": { - "smithy.api#documentation": "

Number of items in the table. Note that this is an approximate value.

" - } - }, - "TableSizeBytes": { - "target": "com.amazonaws.dynamodb#Long", + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

Size of the table in bytes. Note that this is an approximate value.

" + "smithy.api#documentation": "

Schema of the table.

", + "smithy.api#required": {} } }, - "TableCreationDateTime": { - "target": "com.amazonaws.dynamodb#TableCreationDateTime", + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", "traits": { - "smithy.api#documentation": "

Time when the source table was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Number of items in the table. Note that this is an approximate value.

" } }, "TableArn": { @@ -6135,10 +6138,10 @@ "smithy.api#documentation": "

ARN of the table for which backup was created.

" } }, - "KeySchema": { - "target": "com.amazonaws.dynamodb#KeySchema", + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "

Schema of the table.

", + "smithy.api#documentation": "

Read IOPs and Write IOPS on the table when the backup was created.

", "smithy.api#required": {} } }, @@ -6147,6 +6150,12 @@ "traits": { "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

\n " } + }, + "TableSizeBytes": { + "target": "com.amazonaws.dynamodb#Long", + "traits": { + "smithy.api#documentation": "

Size of the table in bytes. Note that this is an approximate value.

" + } } }, "traits": { @@ -6156,18 +6165,18 @@ "com.amazonaws.dynamodb#SourceTableFeatureDetails": { "type": "structure", "members": { - "LocalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#LocalSecondaryIndexes", - "traits": { - "smithy.api#documentation": "

Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

" - } - }, "TimeToLiveDescription": { "target": "com.amazonaws.dynamodb#TimeToLiveDescription", "traits": { "smithy.api#documentation": "

Time to Live settings on the table when the backup was created.

" } }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexes", + "traits": { + "smithy.api#documentation": "

Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

" + } + }, "SSEDescription": { "target": "com.amazonaws.dynamodb#SSEDescription", "traits": { @@ -6209,18 +6218,18 @@ "com.amazonaws.dynamodb#StreamSpecification": { "type": "structure", "members": { - "StreamViewType": { - "target": "com.amazonaws.dynamodb#StreamViewType", - "traits": { - "smithy.api#documentation": "

\n When an item in the table is modified, StreamViewType\n determines what information is written to the stream for this table. Valid values for\n StreamViewType are:

\n " - } - }, "StreamEnabled": { "target": "com.amazonaws.dynamodb#StreamEnabled", "traits": { "smithy.api#documentation": "

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

", "smithy.api#required": {} } + }, + "StreamViewType": { + "target": "com.amazonaws.dynamodb#StreamViewType", + "traits": { + "smithy.api#documentation": "

\n When an item in the table is modified, StreamViewType\n determines what information is written to the stream for this table. Valid values for\n StreamViewType are:

\n " + } } }, "traits": { @@ -6282,17 +6291,17 @@ "smithy.api#documentation": "

The current state of the table:

\n " } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", - "traits": { - "smithy.api#documentation": "

The name of the table.

" - } - }, "Replicas": { "target": "com.amazonaws.dynamodb#ReplicaAutoScalingDescriptionList", "traits": { "smithy.api#documentation": "

Represents replicas of the global table.

" } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } } }, "traits": { @@ -6305,46 +6314,34 @@ "com.amazonaws.dynamodb#TableDescription": { "type": "structure", "members": { - "SSEDescription": { - "target": "com.amazonaws.dynamodb#SSEDescription", - "traits": { - "smithy.api#documentation": "

The description of the server-side encryption status on the specified table.

" - } - }, - "ArchivalSummary": { - "target": "com.amazonaws.dynamodb#ArchivalSummary", - "traits": { - "smithy.api#documentation": "

Contains information about the table archive.

" - } - }, "BillingModeSummary": { "target": "com.amazonaws.dynamodb#BillingModeSummary", "traits": { "smithy.api#documentation": "

Contains the details for the read/write capacity mode.

" } }, - "LatestStreamArn": { - "target": "com.amazonaws.dynamodb#StreamArn", + "TableArn": { + "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the table.

" } }, - "GlobalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", + "SSEDescription": { + "target": "com.amazonaws.dynamodb#SSEDescription", "traits": { - "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be\n returned.

" + "smithy.api#documentation": "

The description of the server-side encryption status on the specified table.

" } }, - "AttributeDefinitions": { - "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "ArchivalSummary": { + "target": "com.amazonaws.dynamodb#ArchivalSummary", "traits": { - "smithy.api#documentation": "

An array of AttributeDefinition objects. Each of these objects describes one attribute\n in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n " + "smithy.api#documentation": "

Contains information about the table archive.

" } }, - "TableArn": { - "target": "com.amazonaws.dynamodb#String", + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the table.

" + "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be\n returned.

" } }, "GlobalTableVersion": { @@ -6353,22 +6350,28 @@ "smithy.api#documentation": "

Represents the version of global tables in use, if the table is replicated across AWS Regions.

" } }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique identifier for the table for which the backup was created.

" + } + }, "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", "traits": { "smithy.api#documentation": "

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" } }, - "Replicas": { - "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

Represents replicas of the table.

" + "smithy.api#documentation": "

The primary key structure for the table. Each KeySchemaElement consists of:

\n \n

For more information about primary keys, see Primary Key in the\n Amazon DynamoDB Developer Guide.

" } }, - "TableId": { - "target": "com.amazonaws.dynamodb#TableId", + "Replicas": { + "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", "traits": { - "smithy.api#documentation": "

Unique identifier for the table for which the backup was created.

" + "smithy.api#documentation": "

Represents replicas of the table.

" } }, "TableSizeBytes": { @@ -6389,22 +6392,16 @@ "smithy.api#documentation": "

The current DynamoDB Streams configuration for the table.

" } }, - "KeySchema": { - "target": "com.amazonaws.dynamodb#KeySchema", - "traits": { - "smithy.api#documentation": "

The primary key structure for the table. Each KeySchemaElement consists of:

\n \n

For more information about primary keys, see Primary Key in the\n Amazon DynamoDB Developer Guide.

" - } - }, "RestoreSummary": { "target": "com.amazonaws.dynamodb#RestoreSummary", "traits": { "smithy.api#documentation": "

Contains details for the restore.

" } }, - "LocalSecondaryIndexes": { - "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be\n returned.

" + "smithy.api#documentation": "

An array of AttributeDefinition objects. Each of these objects describes one attribute\n in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n " } }, "LatestStreamLabel": { @@ -6413,6 +6410,18 @@ "smithy.api#documentation": "

A timestamp, in ISO 8601 format, for this stream.

\n\n

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

\n " } }, + "LatestStreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

" + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be\n returned.

" + } + }, "CreationDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { @@ -6651,17 +6660,17 @@ "com.amazonaws.dynamodb#TimeToLiveSpecification": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.dynamodb#TimeToLiveEnabled", + "AttributeName": { + "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", "traits": { - "smithy.api#documentation": "

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

", + "smithy.api#documentation": "

The name of the TTL attribute used to store the expiration time for items in the\n table.

", "smithy.api#required": {} } }, - "AttributeName": { - "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", + "Enabled": { + "target": "com.amazonaws.dynamodb#TimeToLiveEnabled", "traits": { - "smithy.api#documentation": "

The name of the TTL attribute used to store the expiration time for items in the\n table.

", + "smithy.api#documentation": "

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

", "smithy.api#required": {} } } @@ -6769,17 +6778,17 @@ "com.amazonaws.dynamodb#TransactGetItemsOutput": { "type": "structure", "members": { - "ConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", - "traits": { - "smithy.api#documentation": "

If the ReturnConsumedCapacity value was TOTAL,\n this is an array of ConsumedCapacity objects, one for each table\n addressed by TransactGetItem objects in the TransactItems\n parameter. These ConsumedCapacity objects report the read-capacity\n units consumed by the TransactGetItems call in that table.

" - } - }, "Responses": { "target": "com.amazonaws.dynamodb#ItemResponseList", "traits": { "smithy.api#documentation": "

An ordered array of up to 25 ItemResponse objects, each of which corresponds\n to the TransactGetItem object in the same position in the\n TransactItems array. Each ItemResponse object\n contains a Map of the name-value pairs that are the projected attributes of\n the requested item.

\n

If a requested item could not be retrieved, the corresponding ItemResponse\n object is Null, or if the requested item has no projected attributes, the corresponding\n ItemResponse object is an empty Map.

" } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

If the ReturnConsumedCapacity value was TOTAL,\n this is an array of ConsumedCapacity objects, one for each table\n addressed by TransactGetItem objects in the TransactItems\n parameter. These ConsumedCapacity objects report the read-capacity\n units consumed by the TransactGetItems call in that table.

" + } } } }, @@ -6792,6 +6801,12 @@ "smithy.api#documentation": "

A request to perform a PutItem operation.

" } }, + "Delete": { + "target": "com.amazonaws.dynamodb#Delete", + "traits": { + "smithy.api#documentation": "

A request to perform a DeleteItem operation.

" + } + }, "ConditionCheck": { "target": "com.amazonaws.dynamodb#ConditionCheck", "traits": { @@ -6803,12 +6818,6 @@ "traits": { "smithy.api#documentation": "

A request to perform an UpdateItem operation.

" } - }, - "Delete": { - "target": "com.amazonaws.dynamodb#Delete", - "traits": { - "smithy.api#documentation": "

A request to perform a DeleteItem operation.

" - } } }, "traits": { @@ -6868,13 +6877,15 @@ "com.amazonaws.dynamodb#TransactWriteItemsInput": { "type": "structure", "members": { - "TransactItems": { - "target": "com.amazonaws.dynamodb#TransactWriteItemList", + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

An ordered array of up to 25 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same AWS account and Region, and no two of them can operate on\n the same item.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to\n SIZE, the response includes statistics about item collections (if any), that\n were modified during the operation and are returned in the response.\n If set to NONE (the default), no statistics are returned.\n

" } }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, "ClientRequestToken": { "target": "com.amazonaws.dynamodb#ClientRequestToken", "traits": { @@ -6882,13 +6893,11 @@ "smithy.api#idempotencyToken": {} } }, - "ReturnConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" - }, - "ReturnItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "TransactItems": { + "target": "com.amazonaws.dynamodb#TransactWriteItemList", "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to\n SIZE, the response includes statistics about item collections (if any), that\n were modified during the operation and are returned in the response.\n If set to NONE (the default), no statistics are returned.\n

" + "smithy.api#documentation": "

An ordered array of up to 25 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same AWS account and Region, and no two of them can operate on\n the same item.

", + "smithy.api#required": {} } } } @@ -6896,17 +6905,17 @@ "com.amazonaws.dynamodb#TransactWriteItemsOutput": { "type": "structure", "members": { - "ConsumedCapacity": { - "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", - "traits": { - "smithy.api#documentation": "

The capacity units consumed by the entire TransactWriteItems\n operation. The values of the list are ordered according to\n the ordering of the TransactItems request parameter.\n

" - } - }, "ItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", "traits": { "smithy.api#documentation": "

A list of tables that were processed by TransactWriteItems and, for each\n table, information about any item collections that were affected by individual\n UpdateItem, PutItem, or DeleteItem\n operations.

" } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire TransactWriteItems\n operation. The values of the list are ordered according to\n the ordering of the TransactItems request parameter.\n

" + } } } }, @@ -7000,12 +7009,6 @@ "com.amazonaws.dynamodb#Update": { "type": "structure", "members": { - "ExpressionAttributeNames": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", - "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" - } - }, "UpdateExpression": { "target": "com.amazonaws.dynamodb#UpdateExpression", "traits": { @@ -7013,17 +7016,16 @@ "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

Name of the table for the UpdateItem request.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" } }, - "ConditionExpression": { - "target": "com.amazonaws.dynamodb#ConditionExpression", + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Update condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

" } }, "Key": { @@ -7039,10 +7041,17 @@ "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" } }, - "ReturnValuesOnConditionCheckFailure": { - "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Update condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

" + "smithy.api#documentation": "

Name of the table for the UpdateItem request.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" } } }, @@ -7136,36 +7145,36 @@ "smithy.api#required": {} } }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The global secondary index name, if applicable.

" + } + }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The name of the table.

", "smithy.api#required": {} } - }, - "IndexName": { - "target": "com.amazonaws.dynamodb#IndexName", - "traits": { - "smithy.api#documentation": "

The global secondary index name, if applicable.

" - } } } }, "com.amazonaws.dynamodb#UpdateContributorInsightsOutput": { "type": "structure", "members": { - "ContributorInsightsStatus": { - "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", - "traits": { - "smithy.api#documentation": "

The status of contributor insights

" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The name of the table.

" } }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "

The status of contributor insights

" + } + }, "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { @@ -7183,7 +7192,7 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

", + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

", "smithy.api#required": {} } }, @@ -7299,6 +7308,12 @@ "com.amazonaws.dynamodb#UpdateGlobalTableSettingsInput": { "type": "structure", "members": { + "GlobalTableProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n

" + } + }, "GlobalTableGlobalSecondaryIndexSettingsUpdate": { "target": "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList", "traits": { @@ -7311,30 +7326,24 @@ "smithy.api#documentation": "

Represents the settings for a global table in a Region that will be modified.

" } }, - "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": { - "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", - "traits": { - "smithy.api#documentation": "

Auto scaling settings for managing provisioned write capacity for the global\n table.

" - } - }, "GlobalTableBillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { "smithy.api#documentation": "

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

\n " } }, + "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing provisioned write capacity for the global\n table.

" + } + }, "GlobalTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { "smithy.api#documentation": "

The name of the global table

", "smithy.api#required": {} } - }, - "GlobalTableProvisionedWriteCapacityUnits": { - "target": "com.amazonaws.dynamodb#PositiveLongObject", - "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n

" - } } } }, @@ -7396,28 +7405,28 @@ "com.amazonaws.dynamodb#UpdateItemInput": { "type": "structure", "members": { - "ReturnItemCollectionMetrics": { - "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", - "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" - } - }, "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appear\n before or after they are updated. For UpdateItem, the valid values\n are:

\n \n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n

The values returned are strongly consistent.

" } }, + "UpdateExpression": { + "target": "com.amazonaws.dynamodb#UpdateExpression", + "traits": { + "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.

\n

The following action values are available for UpdateExpression.

\n \n

You can have many actions in a single expression, such as the following: SET a=:value1,\n b=:value2 DELETE :value3, :value4, :value5\n

\n

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

" + } + }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly\n in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide.) To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, - "UpdateExpression": { - "target": "com.amazonaws.dynamodb#UpdateExpression", + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.

\n

The following action values are available for UpdateExpression.

\n \n

You can have many actions in a single expression, such as the following: SET a=:value1,\n b=:value2 DELETE :value3, :value4, :value5\n

\n

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" } }, "ConditionExpression": { @@ -7426,25 +7435,26 @@ "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

" } }, - "ConditionalOperator": { - "target": "com.amazonaws.dynamodb#ConditionalOperator", + "AttributeUpdates": { + "target": "com.amazonaws.dynamodb#AttributeUpdates", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use UpdateExpression instead. For more information, see\n AttributeUpdates in the Amazon DynamoDB Developer Guide.

" } }, - "ExpressionAttributeValues": { - "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" } }, "ReturnConsumedCapacity": { "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" }, - "AttributeUpdates": { - "target": "com.amazonaws.dynamodb#AttributeUpdates", + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use UpdateExpression instead. For more information, see\n AttributeUpdates in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The name of the table containing the item to update.

", + "smithy.api#required": {} } }, "Key": { @@ -7454,17 +7464,16 @@ "smithy.api#required": {} } }, - "Expected": { - "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" } }, - "TableName": { - "target": "com.amazonaws.dynamodb#TableName", + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

The name of the table containing the item to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -7508,18 +7517,18 @@ "smithy.api#required": {} } }, - "ProvisionedThroughputOverride": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", - "traits": { - "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" - } - }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", "traits": { "smithy.api#documentation": "

Replica-specific global secondary index settings.

" } }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" + } + }, "KMSMasterKeyId": { "target": "com.amazonaws.dynamodb#KMSMasterKeyId", "traits": { @@ -7563,12 +7572,6 @@ "com.amazonaws.dynamodb#UpdateTableInput": { "type": "structure", "members": { - "SSESpecification": { - "target": "com.amazonaws.dynamodb#SSESpecification", - "traits": { - "smithy.api#documentation": "

The new server-side encryption settings for the specified table.

" - } - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -7576,16 +7579,22 @@ "smithy.api#required": {} } }, + "GlobalSecondaryIndexUpdates": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList", + "traits": { + "smithy.api#documentation": "

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

\n \n

You can create or delete only one global secondary index per UpdateTable operation.

\n

For more information, see Managing Global Secondary\n Indexes in the Amazon DynamoDB Developer Guide.

" + } + }, "AttributeDefinitions": { "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

" } }, - "GlobalSecondaryIndexUpdates": { - "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList", + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification", "traits": { - "smithy.api#documentation": "

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

\n \n

You can create or delete only one global secondary index per UpdateTable operation.

\n

For more information, see Managing Global Secondary\n Indexes in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The new server-side encryption settings for the specified table.

" } }, "BillingMode": { @@ -7594,18 +7603,18 @@ "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage capacity. \n When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial\n provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes \n over the past 30 minutes.

\n " } }, - "ProvisionedThroughput": { - "target": "com.amazonaws.dynamodb#ProvisionedThroughput", - "traits": { - "smithy.api#documentation": "

The new provisioned throughput settings for the specified table or index.

" - } - }, "ReplicaUpdates": { "target": "com.amazonaws.dynamodb#ReplicationGroupUpdateList", "traits": { "smithy.api#documentation": "

A list of replica update actions (create, delete, or update) for the table.

\n \n

This property only applies to Version 2019.11.21 of global tables.

\n " } }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

The new provisioned throughput settings for the specified table or index.

" + } + }, "StreamSpecification": { "target": "com.amazonaws.dynamodb#StreamSpecification", "traits": { @@ -7660,15 +7669,6 @@ "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingInput": { "type": "structure", "members": { - "ReplicaUpdates": { - "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList", - "traits": { - "smithy.api#documentation": "

Represents the auto scaling settings of replicas of the table that will be\n modified.

" - } - }, - "ProvisionedWriteCapacityAutoScalingUpdate": { - "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" - }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { @@ -7676,11 +7676,20 @@ "smithy.api#required": {} } }, + "ProvisionedWriteCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + }, "GlobalSecondaryIndexUpdates": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList", "traits": { "smithy.api#documentation": "

Represents the auto scaling settings of the global secondary indexes of the replica\n to be updated.

" } + }, + "ReplicaUpdates": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of replicas of the table that will be\n modified.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/ebs.2019-11-02.json b/codegen/sdk-codegen/aws-models/ebs.2019-11-02.json index afa6c4ff6e53..78ff288a5847 100644 --- a/codegen/sdk-codegen/aws-models/ebs.2019-11-02.json +++ b/codegen/sdk-codegen/aws-models/ebs.2019-11-02.json @@ -67,17 +67,17 @@ "com.amazonaws.ebs#Block": { "type": "structure", "members": { - "BlockIndex": { - "target": "com.amazonaws.ebs#BlockIndex", - "traits": { - "smithy.api#documentation": "

The block index.

" - } - }, "BlockToken": { "target": "com.amazonaws.ebs#BlockToken", "traits": { "smithy.api#documentation": "

The block token for the block index.

" } + }, + "BlockIndex": { + "target": "com.amazonaws.ebs#BlockIndex", + "traits": { + "smithy.api#documentation": "

The block index.

" + } } }, "traits": { @@ -134,18 +134,18 @@ "com.amazonaws.ebs#ChangedBlock": { "type": "structure", "members": { - "BlockIndex": { - "target": "com.amazonaws.ebs#BlockIndex", - "traits": { - "smithy.api#documentation": "

The block index.

" - } - }, "FirstBlockToken": { "target": "com.amazonaws.ebs#BlockToken", "traits": { "smithy.api#documentation": "

The block token for the block index of the FirstSnapshotId specified in\n the ListChangedBlocks operation. This value is absent if the first snapshot\n does not have the changed block that is on the second snapshot.

" } }, + "BlockIndex": { + "target": "com.amazonaws.ebs#BlockIndex", + "traits": { + "smithy.api#documentation": "

The block index.

" + } + }, "SecondBlockToken": { "target": "com.amazonaws.ebs#BlockToken", "traits": { @@ -255,18 +255,11 @@ "com.amazonaws.ebs#CompleteSnapshotRequest": { "type": "structure", "members": { - "Checksum": { - "target": "com.amazonaws.ebs#Checksum", - "traits": { - "smithy.api#documentation": "

An aggregated Base-64 SHA256 checksum based on the checksums of each written\n block.

\n

To generate the aggregated checksum using the linear aggregation method, arrange the\n checksums for each written block in ascending order of their block index, concatenate\n them to form a single string, and then generate the checksum on the entire string using\n the SHA256 algorithm.

", - "smithy.api#httpHeader": "x-amz-Checksum" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ebs#SnapshotId", + "ChangedBlocksCount": { + "target": "com.amazonaws.ebs#ChangedBlocksCount", "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The number of blocks that were written to the snapshot.

", + "smithy.api#httpHeader": "x-amz-ChangedBlocksCount", "smithy.api#required": {} } }, @@ -277,20 +270,27 @@ "smithy.api#httpHeader": "x-amz-Checksum-Aggregation-Method" } }, - "ChangedBlocksCount": { - "target": "com.amazonaws.ebs#ChangedBlocksCount", - "traits": { - "smithy.api#documentation": "

The number of blocks that were written to the snapshot.

", - "smithy.api#httpHeader": "x-amz-ChangedBlocksCount", - "smithy.api#required": {} - } - }, "ChecksumAlgorithm": { "target": "com.amazonaws.ebs#ChecksumAlgorithm", "traits": { "smithy.api#documentation": "

The algorithm used to generate the checksum. Currently, the only supported algorithm\n is SHA256.

", "smithy.api#httpHeader": "x-amz-Checksum-Algorithm" } + }, + "SnapshotId": { + "target": "com.amazonaws.ebs#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Checksum": { + "target": "com.amazonaws.ebs#Checksum", + "traits": { + "smithy.api#documentation": "

An aggregated Base-64 SHA256 checksum based on the checksums of each written\n block.

\n

To generate the aggregated checksum using the linear aggregation method, arrange the\n checksums for each written block in ascending order of their block index, concatenate\n them to form a single string, and then generate the checksum on the entire string using\n the SHA256 algorithm.

", + "smithy.api#httpHeader": "x-amz-Checksum" + } } } }, @@ -375,13 +375,13 @@ "sdkId": "EBS", "arnNamespace": "ebs", "cloudFormationName": "EBS", - "cloudTrailEventSource": "zeppelindataservice.amazon.com" + "cloudTrailEventSource": "ebs.amazonaws.com" }, "aws.auth#sigv4": { "name": "ebs" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS\n snapshots, and identify the difference between two snapshots. You can view the details\n of blocks in an EBS snapshot, compare the block difference between two snapshots, and\n directly access the data in a snapshot. If you're an independent software vendor (ISV)\n who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective\n to track incremental changes on your EBS volumes via EBS snapshots. This can be done\n without having to create new volumes from EBS snapshots.

\n\n\n

This API reference provides detailed information about the actions, data types,\n parameters, and errors of the EBS direct APIs. For more information about the elements that\n make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User\n Guide. For more information about the supported AWS Regions, endpoints,\n and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in\n the AWS General Reference.

", + "smithy.api#documentation": "

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create EBS snapshots, write data directly to \n \t\tyour snapshots, read data on your snapshots, and identify the differences or changes between \n \t\ttwo snapshots. If you’re an independent software vendor (ISV) who offers backup services for \n \t\tAmazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on \n \t\tyour EBS volumes through snapshots. This can be done without having to create new volumes \n \t\tfrom snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

\n \t\t\n \t

You can create incremental snapshots directly from data on-premises into EBS volumes and the \n \t\tcloud to use for quick disaster recovery. With the ability to write and read snapshots, you can \n \t\twrite your on-premises data to an EBS snapshot during a disaster. Then after recovery, you can \n \t\trestore it back to AWS or on-premises from the snapshot. You no longer need to build and \n \t\tmaintain complex mechanisms to copy data to and from Amazon EBS.

\n\n\n

This API reference provides detailed information about the actions, data types,\n parameters, and errors of the EBS direct APIs. For more information about the elements that\n make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User\n Guide. For more information about the supported AWS Regions, endpoints,\n and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in\n the AWS General Reference.

", "smithy.api#title": "Amazon Elastic Block Store" } }, @@ -434,6 +434,14 @@ "com.amazonaws.ebs#GetSnapshotBlockRequest": { "type": "structure", "members": { + "SnapshotId": { + "target": "com.amazonaws.ebs#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot containing the block from which to get data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "BlockToken": { "target": "com.amazonaws.ebs#BlockToken", "traits": { @@ -449,34 +457,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "SnapshotId": { - "target": "com.amazonaws.ebs#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the snapshot containing the block from which to get data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.ebs#GetSnapshotBlockResponse": { "type": "structure", "members": { - "BlockData": { - "target": "com.amazonaws.ebs#BlockData", - "traits": { - "smithy.api#documentation": "

The data content of the block.

", - "smithy.api#httpPayload": {} - } - }, - "Checksum": { - "target": "com.amazonaws.ebs#Checksum", - "traits": { - "smithy.api#documentation": "

The checksum generated for the block, which is Base64 encoded.

", - "smithy.api#httpHeader": "x-amz-Checksum" - } - }, "DataLength": { "target": "com.amazonaws.ebs#DataLength", "traits": { @@ -490,6 +476,20 @@ "smithy.api#documentation": "

The algorithm used to generate the checksum for the block, such as SHA256.

", "smithy.api#httpHeader": "x-amz-Checksum-Algorithm" } + }, + "Checksum": { + "target": "com.amazonaws.ebs#Checksum", + "traits": { + "smithy.api#documentation": "

The checksum generated for the block, which is Base64 encoded.

", + "smithy.api#httpHeader": "x-amz-Checksum" + } + }, + "BlockData": { + "target": "com.amazonaws.ebs#BlockData", + "traits": { + "smithy.api#documentation": "

The data content of the block.

", + "smithy.api#httpPayload": {} + } } } }, @@ -556,7 +556,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the block indexes and block tokens for blocks that are different between two\n Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

", + "smithy.api#documentation": "

Returns information about the blocks that are different between two\n Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

", "smithy.api#http": { "method": "GET", "uri": "/snapshots/{SecondSnapshotId}/changedblocks", @@ -572,6 +572,14 @@ "com.amazonaws.ebs#ListChangedBlocksRequest": { "type": "structure", "members": { + "SecondSnapshotId": { + "target": "com.amazonaws.ebs#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the second snapshot to use for the comparison.

\n \n

The SecondSnapshotId parameter must be specified with a\n FirstSnapshotID parameter; otherwise, an error occurs.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "FirstSnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { @@ -593,18 +601,10 @@ "smithy.api#httpQuery": "maxResults" } }, - "SecondSnapshotId": { - "target": "com.amazonaws.ebs#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the second snapshot to use for the comparison.

\n \n

The SecondSnapshotId parameter must be specified with a\n FirstSnapshotID parameter; otherwise, an error occurs.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "StartingBlockIndex": { "target": "com.amazonaws.ebs#BlockIndex", "traits": { - "smithy.api#documentation": "

The block index from which the comparison should start.

\n\n\n

The list in the response will start from this block index or the next valid block\n index in the snapshots.

", + "smithy.api#documentation": "

The block index from which the comparison should start.

\n

The list in the response will start from this block index or the next valid block\n index in the snapshots.

", "smithy.api#httpQuery": "startingBlockIndex" } } @@ -613,18 +613,6 @@ "com.amazonaws.ebs#ListChangedBlocksResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ebs#PageToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there\n are no more results to return.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ebs#VolumeSize", - "traits": { - "smithy.api#documentation": "

The size of the volume in GB.

" - } - }, "BlockSize": { "target": "com.amazonaws.ebs#BlockSize", "traits": { @@ -637,6 +625,18 @@ "smithy.api#documentation": "

The time when the BlockToken expires.

" } }, + "VolumeSize": { + "target": "com.amazonaws.ebs#VolumeSize", + "traits": { + "smithy.api#documentation": "

The size of the volume in GB.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ebs#PageToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there\n are no more results to return.

" + } + }, "ChangedBlocks": { "target": "com.amazonaws.ebs#ChangedBlocks", "traits": { @@ -674,7 +674,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.

", + "smithy.api#documentation": "

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

", "smithy.api#http": { "method": "GET", "uri": "/snapshots/{SnapshotId}/blocks", @@ -690,12 +690,11 @@ "com.amazonaws.ebs#ListSnapshotBlocksRequest": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.ebs#SnapshotId", + "MaxResults": { + "target": "com.amazonaws.ebs#MaxResults", "traits": { - "smithy.api#documentation": "

The ID of the snapshot from which to get block indexes and block tokens.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The number of results to return.

", + "smithy.api#httpQuery": "maxResults" } }, "StartingBlockIndex": { @@ -712,11 +711,12 @@ "smithy.api#httpQuery": "pageToken" } }, - "MaxResults": { - "target": "com.amazonaws.ebs#MaxResults", + "SnapshotId": { + "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ID of the snapshot from which to get block indexes and block tokens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -736,6 +736,12 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there\n are no more results to return.

" } }, + "ExpiryTime": { + "target": "com.amazonaws.ebs#TimeStamp", + "traits": { + "smithy.api#documentation": "

The time when the BlockToken expires.

" + } + }, "Blocks": { "target": "com.amazonaws.ebs#Blocks", "traits": { @@ -747,12 +753,6 @@ "traits": { "smithy.api#documentation": "

The size of the block.

" } - }, - "ExpiryTime": { - "target": "com.amazonaws.ebs#TimeStamp", - "traits": { - "smithy.api#documentation": "

The time when the BlockToken expires.

" - } } } }, @@ -827,7 +827,7 @@ "traits": { "aws.auth#unsignedPayload": {}, "smithy.api#auth": ["aws.auth#sigv4"], - "smithy.api#documentation": "

Writes a block of data to a block in the snapshot. If the specified block contains\n data, the existing data is overwritten. The target snapshot must be in the\n pending state.

\t\n \t

Data written to a snapshot must be aligned with 512-byte sectors.

", + "smithy.api#documentation": "

Writes a block of data to a snapshot. If the specified block contains\n data, the existing data is overwritten. The target snapshot must be in the\n pending state.

\t\n \t

Data written to a snapshot must be aligned with 512-byte sectors.

", "smithy.api#http": { "method": "PUT", "uri": "/snapshots/{SnapshotId}/blocks/{BlockIndex}", @@ -838,25 +838,18 @@ "com.amazonaws.ebs#PutSnapshotBlockRequest": { "type": "structure", "members": { - "DataLength": { - "target": "com.amazonaws.ebs#DataLength", + "SnapshotId": { + "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The size of the data to write to the block, in bytes. Currently, the only supported\n size is 524288.

\n

Valid values: 524288\n

", - "smithy.api#httpHeader": "x-amz-Data-Length", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Progress": { - "target": "com.amazonaws.ebs#Progress", - "traits": { - "smithy.api#documentation": "

The progress of the write process, as a percentage.

", - "smithy.api#httpHeader": "x-amz-Progress" - } - }, "BlockIndex": { "target": "com.amazonaws.ebs#BlockIndex", "traits": { - "smithy.api#documentation": "

The block index of the block in which to write the data. A block index is the offset\n position of a block within a snapshot, and it is used to identify the block. To identify\n the logical offset of the data in the logical volume, multiply the block index with the\n block size (Block index * 512 bytes).

", + "smithy.api#documentation": "

The block index of the block in which to write the data. A block index is a logical \n \tindex in units of 512 KiB blocks. To identify the block index, divide \n \tthe logical offset of the data in the logical volume by the block size (logical offset of \n \tdata/524288). The logical offset of the data must be 512 \n \tKiB aligned.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -869,27 +862,34 @@ "smithy.api#required": {} } }, - "SnapshotId": { - "target": "com.amazonaws.ebs#SnapshotId", + "Progress": { + "target": "com.amazonaws.ebs#Progress", "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The progress of the write process, as a percentage.

", + "smithy.api#httpHeader": "x-amz-Progress" + } + }, + "BlockData": { + "target": "com.amazonaws.ebs#BlockData", + "traits": { + "smithy.api#documentation": "

The data to write to the block.

\n

The block data is not signed as part of the Signature Version 4 signing process. As a\n result, you must generate and provide a Base64-encoded SHA256 checksum for the block\n data using the x-amz-Checksum header. Also, you \n \tmust specify the checksum algorithm using the x-amz-Checksum-Algorithm \n \theader. The checksum that you provide is part of the Signature Version 4 signing process. \n \tIt is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity \n \tof the data. If the checksums do not correspond, the request fails. For more information, \n \tsee \n Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User\n Guide.

", + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "ChecksumAlgorithm": { - "target": "com.amazonaws.ebs#ChecksumAlgorithm", + "DataLength": { + "target": "com.amazonaws.ebs#DataLength", "traits": { - "smithy.api#documentation": "

The algorithm used to generate the checksum. Currently, the only supported algorithm\n is SHA256.

", - "smithy.api#httpHeader": "x-amz-Checksum-Algorithm", + "smithy.api#documentation": "

The size of the data to write to the block, in bytes. Currently, the only supported\n size is 524288.

\n

Valid values: 524288\n

", + "smithy.api#httpHeader": "x-amz-Data-Length", "smithy.api#required": {} } }, - "BlockData": { - "target": "com.amazonaws.ebs#BlockData", + "ChecksumAlgorithm": { + "target": "com.amazonaws.ebs#ChecksumAlgorithm", "traits": { - "smithy.api#documentation": "

The data to write to the block.

\n

The block data is not signed as part of the Signature Version 4 signing process. As a\n result, you must generate and provide a Base64-encoded SHA256 checksum for the block\n data using the x-amz-Checksum header. Also, you \n \tmust specify the checksum algorithm using the x-amz-Checksum-Algorithm \n \theader. The checksum that you provide is part of the Signature Version 4 signing process. \n \tIt is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity \n \tof the data. If the checksums do not correspond, the request fails. For more information, \n \tsee \n Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User\n Guide.

", - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

The algorithm used to generate the checksum. Currently, the only supported algorithm\n is SHA256.

", + "smithy.api#httpHeader": "x-amz-Checksum-Algorithm", "smithy.api#required": {} } } @@ -898,33 +898,33 @@ "com.amazonaws.ebs#PutSnapshotBlockResponse": { "type": "structure", "members": { - "Checksum": { - "target": "com.amazonaws.ebs#Checksum", - "traits": { - "smithy.api#documentation": "

The SHA256 checksum generated for the block data by Amazon EBS.

", - "smithy.api#httpHeader": "x-amz-Checksum" - } - }, "ChecksumAlgorithm": { "target": "com.amazonaws.ebs#ChecksumAlgorithm", "traits": { "smithy.api#documentation": "

The algorithm used by Amazon EBS to generate the checksum.

", "smithy.api#httpHeader": "x-amz-Checksum-Algorithm" } + }, + "Checksum": { + "target": "com.amazonaws.ebs#Checksum", + "traits": { + "smithy.api#documentation": "

The SHA256 checksum generated for the block data by Amazon EBS.

", + "smithy.api#httpHeader": "x-amz-Checksum" + } } } }, "com.amazonaws.ebs#RequestThrottledException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.ebs#ErrorMessage" + }, "Reason": { "target": "com.amazonaws.ebs#RequestThrottledExceptionReason", "traits": { "smithy.api#documentation": "

The reason for the exception.

" } - }, - "Message": { - "target": "com.amazonaws.ebs#ErrorMessage" } }, "traits": { @@ -1068,6 +1068,12 @@ "com.amazonaws.ebs#StartSnapshotRequest": { "type": "structure", "members": { + "Timeout": { + "target": "com.amazonaws.ebs#Timeout", + "traits": { + "smithy.api#documentation": "

The amount of time (in minutes) after which the snapshot is automatically cancelled\n if:

\n \n

If no value is specified, the timeout defaults to 60 minutes.

" + } + }, "ClientToken": { "target": "com.amazonaws.ebs#IdempotencyToken", "traits": { @@ -1075,10 +1081,11 @@ "smithy.api#idempotencyToken": {} } }, - "Description": { - "target": "com.amazonaws.ebs#Description", + "VolumeSize": { + "target": "com.amazonaws.ebs#VolumeSize", "traits": { - "smithy.api#documentation": "

A description for the snapshot.

" + "smithy.api#documentation": "

The size of the volume, in GiB. The maximum size is 16384 GiB (16\n TiB).

", + "smithy.api#required": {} } }, "Tags": { @@ -1087,11 +1094,10 @@ "smithy.api#documentation": "

The tags to apply to the snapshot.

" } }, - "VolumeSize": { - "target": "com.amazonaws.ebs#VolumeSize", + "Encrypted": { + "target": "com.amazonaws.ebs#Boolean", "traits": { - "smithy.api#documentation": "

The size of the volume, in GiB. The maximum size is 16384 GiB (16\n TiB).

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify\n true. To create an unencrypted snapshot, omit this parameter.

\n

If you specify a value for ParentSnapshotId, omit\n this parameter.

\n

If you specify true, the snapshot is encrypted using the CMK specified\n using the KmsKeyArn parameter. If no value is specified\n for KmsKeyArn, the default CMK for your account is \n \tused. If no default CMK has been specified for your account, the AWS managed CMK is used. \n \tTo set a default CMK for your account, use \n \t\tModifyEbsDefaultKmsKeyId.

\n

If your account is enabled for encryption by default, you cannot set this parameter to\n false. In this case, you can omit this parameter.

\n\n

For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

" } }, "KmsKeyArn": { @@ -1100,22 +1106,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) \n \tcustomer master key (CMK) to be used to encrypt the snapshot. If you do not specify a \n \tCMK, the default AWS managed CMK is used.

\n

If you specify a ParentSnapshotId, omit this\n parameter; the snapshot will be encrypted using the same CMK that was used to encrypt\n the parent snapshot.

\n

If Encrypted is set to true, \n \tyou must specify a CMK ARN.

" } }, - "Encrypted": { - "target": "com.amazonaws.ebs#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify\n true. To create an unencrypted snapshot, omit this parameter.

\n

If you specify a value for ParentSnapshotId, omit\n this parameter.

\n

If you specify true, the snapshot is encrypted using the CMK specified\n using the KmsKeyArn parameter. If no value is specified\n for KmsKeyArn, the default CMK for your account is \n \tused. If no default CMK has been specified for your account, the AWS managed CMK is used. \n \tTo set a default CMK for your account, use \n \t\tModifyEbsDefaultKmsKeyId.

\n

If your account is enabled for encryption by default, you cannot set this parameter to\n false. In this case, you can omit this parameter.

\n\n

For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

" - } - }, "ParentSnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { "smithy.api#documentation": "

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating\n the first snapshot for an on-premises volume, omit this parameter.

\n

If your account is enabled for encryption by default, you cannot use an unencrypted\n snapshot as a parent snapshot. You must first create an encrypted copy of the parent\n snapshot using CopySnapshot.

" } }, - "Timeout": { - "target": "com.amazonaws.ebs#Timeout", + "Description": { + "target": "com.amazonaws.ebs#Description", "traits": { - "smithy.api#documentation": "

The amount of time (in minutes) after which the snapshot is automatically cancelled\n if:

\n \n

If no value is specified, the timeout defaults to 60 minutes.

" + "smithy.api#documentation": "

A description for the snapshot.

" } } } @@ -1123,10 +1123,16 @@ "com.amazonaws.ebs#StartSnapshotResponse": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.ebs#TimeStamp", + "Tags": { + "target": "com.amazonaws.ebs#Tags", "traits": { - "smithy.api#documentation": "

The timestamp when the snapshot was created.

" + "smithy.api#documentation": "

The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more\n information, see Tagging your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.ebs#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer\n master key (CMK) used to encrypt the snapshot.

" } }, "OwnerId": { @@ -1135,10 +1141,16 @@ "smithy.api#documentation": "

The AWS account ID of the snapshot owner.

" } }, - "SnapshotId": { + "VolumeSize": { + "target": "com.amazonaws.ebs#VolumeSize", + "traits": { + "smithy.api#documentation": "

The size of the volume, in GiB.

" + } + }, + "ParentSnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

" + "smithy.api#documentation": "

The ID of the parent snapshot.

" } }, "Description": { @@ -1147,22 +1159,10 @@ "smithy.api#documentation": "

The description of the snapshot.

" } }, - "KmsKeyArn": { - "target": "com.amazonaws.ebs#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer\n master key (CMK) used to encrypt the snapshot.

" - } - }, - "ParentSnapshotId": { + "SnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The ID of the parent snapshot.

" - } - }, - "Status": { - "target": "com.amazonaws.ebs#Status", - "traits": { - "smithy.api#documentation": "

The status of the snapshot.

" + "smithy.api#documentation": "

The ID of the snapshot.

" } }, "BlockSize": { @@ -1171,16 +1171,16 @@ "smithy.api#documentation": "

The size of the blocks in the snapshot, in bytes.

" } }, - "Tags": { - "target": "com.amazonaws.ebs#Tags", + "StartTime": { + "target": "com.amazonaws.ebs#TimeStamp", "traits": { - "smithy.api#documentation": "

The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more\n information, see Tagging your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The timestamp when the snapshot was created.

" } }, - "VolumeSize": { - "target": "com.amazonaws.ebs#VolumeSize", + "Status": { + "target": "com.amazonaws.ebs#Status", "traits": { - "smithy.api#documentation": "

The size of the volume, in GiB.

" + "smithy.api#documentation": "

The status of the snapshot.

" } } } @@ -1211,17 +1211,17 @@ "com.amazonaws.ebs#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.ebs#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

" - } - }, "Key": { "target": "com.amazonaws.ebs#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

" } + }, + "Value": { + "target": "com.amazonaws.ebs#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/ec2-instance-connect.2018-04-02.json b/codegen/sdk-codegen/aws-models/ec2-instance-connect.2018-04-02.json index f399fb325f19..d22ffabf94aa 100644 --- a/codegen/sdk-codegen/aws-models/ec2-instance-connect.2018-04-02.json +++ b/codegen/sdk-codegen/aws-models/ec2-instance-connect.2018-04-02.json @@ -42,7 +42,7 @@ "sdkId": "EC2 Instance Connect", "arnNamespace": "ec2-instance-connect", "cloudFormationName": "EC2InstanceConnect", - "cloudTrailEventSource": "sshaccessproxyservice.aws.amazon.com" + "cloudTrailEventSource": "ec2instanceconnect.amazonaws.com" }, "aws.auth#sigv4": { "name": "ec2-instance-connect" @@ -165,10 +165,10 @@ "com.amazonaws.ec2instanceconnect#SendSSHPublicKeyRequest": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2instanceconnect#AvailabilityZone", + "SSHPublicKey": { + "target": "com.amazonaws.ec2instanceconnect#SSHPublicKey", "traits": { - "smithy.api#documentation": "

The availability zone the EC2 instance was launched in.

", + "smithy.api#documentation": "

The public key to be published to the instance. To use it after publication you must have the matching private key.

", "smithy.api#required": {} } }, @@ -179,10 +179,10 @@ "smithy.api#required": {} } }, - "SSHPublicKey": { - "target": "com.amazonaws.ec2instanceconnect#SSHPublicKey", + "AvailabilityZone": { + "target": "com.amazonaws.ec2instanceconnect#AvailabilityZone", "traits": { - "smithy.api#documentation": "

The public key to be published to the instance. To use it after publication you must have the matching private key.

", + "smithy.api#documentation": "

The availability zone the EC2 instance was launched in.

", "smithy.api#required": {} } }, 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 1e204f587374..d8c5e8df77b8 100644 --- a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json @@ -44,6 +44,13 @@ "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuoteRequest": { "type": "structure", "members": { + "TargetConfigurations": { + "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", + "traits": { + "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", + "smithy.api#xmlName": "TargetConfiguration" + } + }, "ReservedInstanceIds": { "target": "com.amazonaws.ec2#ReservedInstanceIdSet", "traits": { @@ -52,13 +59,6 @@ "smithy.api#xmlName": "ReservedInstanceId" } }, - "TargetConfigurations": { - "target": "com.amazonaws.ec2#TargetConfigurationRequestSet", - "traits": { - "smithy.api#documentation": "

The configuration of the target Convertible Reserved Instance to exchange for your\n current Convertible Reserved Instances.

", - "smithy.api#xmlName": "TargetConfiguration" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -101,18 +101,18 @@ "com.amazonaws.ec2#AcceptTransitGatewayPeeringAttachmentRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { "smithy.api#documentation": "

The ID of the transit gateway attachment.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -144,18 +144,18 @@ "com.amazonaws.ec2#AcceptTransitGatewayVpcAttachmentRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { "smithy.api#documentation": "

The ID of the attachment.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -187,13 +187,6 @@ "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest": { "type": "structure", "members": { - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC endpoint service.

", - "smithy.api#required": {} - } - }, "VpcEndpointIds": { "target": "com.amazonaws.ec2#VpcEndpointIdList", "traits": { @@ -207,6 +200,13 @@ "traits": { "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.

" } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC endpoint service.

", + "smithy.api#required": {} + } } } }, @@ -352,12 +352,12 @@ "com.amazonaws.ec2#ActiveInstance": { "type": "structure", "members": { - "SpotInstanceRequestId": { + "InstanceType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestId", - "smithy.api#documentation": "

The ID of the Spot Instance request.

", - "smithy.api#xmlName": "spotInstanceRequestId" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" } }, "InstanceId": { @@ -368,6 +368,14 @@ "smithy.api#xmlName": "instanceId" } }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, "InstanceHealth": { "target": "com.amazonaws.ec2#InstanceHealthStatus", "traits": { @@ -375,14 +383,6 @@ "smithy.api#documentation": "

The health status of the instance. If the status of either the instance status check \n or the system status check is impaired, the health status of the instance\n is unhealthy. Otherwise, the health status is healthy.

", "smithy.api#xmlName": "instanceHealth" } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } } }, "traits": { @@ -436,17 +436,17 @@ "com.amazonaws.ec2#AddPrefixListEntry": { "type": "structure", "members": { - "Description": { + "Cidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A description for the entry.

\n

Constraints: Up to 255 characters in length.

" + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#required": {} } }, - "Cidr": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The CIDR block.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the entry.

\n

Constraints: Up to 255 characters in length.

" } } }, @@ -457,28 +457,20 @@ "com.amazonaws.ec2#Address": { "type": "structure", "members": { - "Domain": { - "target": "com.amazonaws.ec2#DomainType", - "traits": { - "aws.protocols#ec2QueryName": "Domain", - "smithy.api#documentation": "

Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).

", - "smithy.api#xmlName": "domain" - } - }, - "CustomerOwnedIp": { + "NetworkInterfaceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIp", - "smithy.api#documentation": "

The customer-owned IP address.

", - "smithy.api#xmlName": "customerOwnedIp" + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" } }, - "PrivateIpAddress": { + "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IP address associated with the Elastic IP address.

", - "smithy.api#xmlName": "privateIpAddress" + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" } }, "Tags": { @@ -489,44 +481,44 @@ "smithy.api#xmlName": "tagSet" } }, - "AllocationId": { + "PublicIpv4Pool": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The ID representing the allocation of the address for use with EC2-VPC.

", - "smithy.api#xmlName": "allocationId" + "aws.protocols#ec2QueryName": "PublicIpv4Pool", + "smithy.api#documentation": "

The ID of an address pool.

", + "smithy.api#xmlName": "publicIpv4Pool" } }, - "CustomerOwnedIpv4Pool": { + "NetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", - "smithy.api#documentation": "

The ID of the customer-owned address pool.

", - "smithy.api#xmlName": "customerOwnedIpv4Pool" + "aws.protocols#ec2QueryName": "NetworkBorderGroup", + "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which AWS advertises IP addresses.

", + "smithy.api#xmlName": "networkBorderGroup" } }, - "PublicIpv4Pool": { + "AssociationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PublicIpv4Pool", - "smithy.api#documentation": "

The ID of an address pool.

", - "smithy.api#xmlName": "publicIpv4Pool" + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID representing the association of the address with an instance in a VPC.

", + "smithy.api#xmlName": "associationId" } }, - "NetworkBorderGroup": { + "PublicIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the location from which the IP address is advertised.

", - "smithy.api#xmlName": "networkBorderGroup" + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" } }, - "NetworkInterfaceId": { + "NetworkInterfaceOwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "NetworkInterfaceOwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the network interface.

", + "smithy.api#xmlName": "networkInterfaceOwnerId" } }, "InstanceId": { @@ -537,33 +529,49 @@ "smithy.api#xmlName": "instanceId" } }, - "PublicIp": { + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "aws.protocols#ec2QueryName": "Domain", + "smithy.api#documentation": "

Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).

", + "smithy.api#xmlName": "domain" + } + }, + "CarrierIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated. This option is only available for network interfaces\n which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

", + "smithy.api#xmlName": "carrierIp" } }, - "NetworkInterfaceOwnerId": { + "AllocationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the network interface.

", - "smithy.api#xmlName": "networkInterfaceOwnerId" + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The ID representing the allocation of the address for use with EC2-VPC.

", + "smithy.api#xmlName": "allocationId" } }, - "AssociationId": { + "PrivateIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID representing the association of the address with an instance in a VPC.

", - "smithy.api#xmlName": "associationId" + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IP address associated with the Elastic IP address.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address.

", + "smithy.api#xmlName": "customerOwnedIp" } } }, "traits": { - "smithy.api#documentation": "

Describes an Elastic IP address.

" + "smithy.api#documentation": "

Describes an Elastic IP address, or a carrier IP address.

" } }, "com.amazonaws.ec2#AddressList": { @@ -590,18 +598,18 @@ "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "Cidr": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The address range, in CIDR notation. This must be the exact range that you provisioned. \n You can't advertise only a portion of the provisioned range.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -640,24 +648,12 @@ "target": "com.amazonaws.ec2#AllocateAddressResult" }, "traits": { - "smithy.api#documentation": "

Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different AWS account.

\n

You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created \n from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an \n Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP\n address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

\n

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate\n 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different AWS account.

\n

You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created \n from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an \n Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP\n address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

\n

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate\n 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

" } }, "com.amazonaws.ec2#AllocateAddressRequest": { "type": "structure", "members": { - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The location from which the IP address is advertised. Use this parameter to limit the address to this location.

\n

A network border group is a unique set of Availability Zones or Local Zones from where AWS\n advertises IP addresses and limits the addresses to the group. IP addresses cannot move\n between network border groups.

\n

Use DescribeAvailabilityZones to view the network border groups.

\n \n \n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

\n " - } - }, - "Domain": { - "target": "com.amazonaws.ec2#DomainType", - "traits": { - "smithy.api#documentation": "

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

\n

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default\n is vpc.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -666,10 +662,10 @@ "smithy.api#xmlName": "dryRun" } }, - "PublicIpv4Pool": { - "target": "com.amazonaws.ec2#String", + "Address": { + "target": "com.amazonaws.ec2#PublicIpAddress", "traits": { - "smithy.api#documentation": "

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n To specify a specific address from the address pool, use the Address parameter instead.

" + "smithy.api#documentation": "

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

" } }, "CustomerOwnedIpv4Pool": { @@ -678,10 +674,22 @@ "smithy.api#documentation": "

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 \n select an address from the address pool. Alternatively, specify a specific \n address from the address pool.

" } }, - "Address": { - "target": "com.amazonaws.ec2#PublicIpAddress", + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

" + "smithy.api#documentation": "

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.

\n

Use DescribeAvailabilityZones to view the network border groups.

\n \n \n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

\n " + } + }, + "Domain": { + "target": "com.amazonaws.ec2#DomainType", + "traits": { + "smithy.api#documentation": "

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

\n

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default\n is vpc.

" + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n To specify a specific address from the address pool, use the Address parameter instead.

" } } } @@ -689,6 +697,22 @@ "com.amazonaws.ec2#AllocateAddressResult": { "type": "structure", "members": { + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4Pool", + "smithy.api#documentation": "

The ID of an address pool.

", + "smithy.api#xmlName": "publicIpv4Pool" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address. This option is only available for network interfaces which reside\n in a subnet in a Wavelength Zone (for example an EC2 instance).

", + "smithy.api#xmlName": "carrierIp" + } + }, "CustomerOwnedIp": { "target": "com.amazonaws.ec2#String", "traits": { @@ -705,44 +729,36 @@ "smithy.api#xmlName": "domain" } }, - "PublicIpv4Pool": { + "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PublicIpv4Pool", - "smithy.api#documentation": "

The ID of an address pool.

", - "smithy.api#xmlName": "publicIpv4Pool" + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" } }, - "PublicIp": { + "AllocationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "smithy.api#xmlName": "allocationId" } }, "NetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The location from which the IP address is advertised.

", + "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises\n IP addresses.

", "smithy.api#xmlName": "networkBorderGroup" } }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", - "smithy.api#documentation": "

The ID of the customer-owned address pool.

", - "smithy.api#xmlName": "customerOwnedIpv4Pool" - } - }, - "AllocationId": { + "PublicIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", - "smithy.api#xmlName": "allocationId" + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" } } } @@ -762,14 +778,6 @@ "com.amazonaws.ec2#AllocateHostsRequest": { "type": "structure", "members": { - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", - "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that \n \t\tmatch its instance type configuration, or if it only accepts Host tenancy \n \t\tinstance launches that specify its unique host ID. For more information, \n \t\tsee \n \tUnderstanding Instance Placement and Host Affinity in the \n \tAmazon EC2 User Guide for Linux Instances.

\n\n

Default: on\n

", - "smithy.api#xmlName": "autoPlacement" - } - }, "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { @@ -779,19 +787,18 @@ "smithy.api#xmlName": "availabilityZone" } }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", "traits": { - "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify \n\t\t\tan instance family, the Dedicated Hosts support multiple instance types within that \n\t\t\tinstance family.

\n\t\t\n\t\t

If you want the Dedicated Hosts to support a specific instance type only, omit this \n\t\t\tparameter and specify InstanceType \n\t\t\tinstead. You cannot specify InstanceFamily and \n\t\t\tInstanceType in the same request.

" + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that \n \t\tmatch its instance type configuration, or if it only accepts Host tenancy \n \t\tinstance launches that specify its unique host ID. For more information, \n \t\tsee \n \tUnderstanding Instance Placement and Host Affinity in the \n \tAmazon EC2 User Guide for Linux Instances.

\n\n

Default: on\n

", + "smithy.api#xmlName": "autoPlacement" } }, - "Quantity": { - "target": "com.amazonaws.ec2#Integer", + "InstanceFamily": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Quantity", - "smithy.api#documentation": "

The number of Dedicated Hosts to allocate to your account with these parameters.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "quantity" + "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify \n\t\t\tan instance family, the Dedicated Hosts support multiple instance types within that \n\t\t\tinstance family.

\n\t\t\n\t\t

If you want the Dedicated Hosts to support a specific instance type only, omit this \n\t\t\tparameter and specify InstanceType \n\t\t\tinstead. You cannot specify InstanceFamily and \n\t\t\tInstanceType in the same request.

" } }, "TagSpecifications": { @@ -822,6 +829,15 @@ "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you\n\t\tspecify an instance type, the Dedicated Hosts support instances of the \n\t\tspecified instance type only.

\n \t\n \t

If you want the Dedicated Hosts to support multiple instance types in a specific \n \t\tinstance family, omit this parameter and specify InstanceFamily \n \t\tinstead. You cannot specify InstanceType and \n \t\tInstanceFamily in the same request.

", "smithy.api#xmlName": "instanceType" } + }, + "Quantity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Quantity", + "smithy.api#documentation": "

The number of Dedicated Hosts to allocate to your account with these parameters.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "quantity" + } } } }, @@ -900,14 +916,6 @@ "com.amazonaws.ec2#AllowedPrincipal": { "type": "structure", "members": { - "Principal": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Principal", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", - "smithy.api#xmlName": "principal" - } - }, "PrincipalType": { "target": "com.amazonaws.ec2#PrincipalType", "traits": { @@ -915,6 +923,14 @@ "smithy.api#documentation": "

The type of principal.

", "smithy.api#xmlName": "principalType" } + }, + "Principal": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Principal", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal.

", + "smithy.api#xmlName": "principal" + } } }, "traits": { @@ -1073,6 +1089,9 @@ { "target": "com.amazonaws.ec2#CreateCapacityReservation" }, + { + "target": "com.amazonaws.ec2#CreateCarrierGateway" + }, { "target": "com.amazonaws.ec2#CreateClientVpnEndpoint" }, @@ -1196,6 +1215,9 @@ { "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment" }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference" + }, { "target": "com.amazonaws.ec2#CreateTransitGatewayRoute" }, @@ -1232,6 +1254,9 @@ { "target": "com.amazonaws.ec2#CreateVpnGateway" }, + { + "target": "com.amazonaws.ec2#DeleteCarrierGateway" + }, { "target": "com.amazonaws.ec2#DeleteClientVpnEndpoint" }, @@ -1340,6 +1365,9 @@ { "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment" }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference" + }, { "target": "com.amazonaws.ec2#DeleteTransitGatewayRoute" }, @@ -1412,6 +1440,9 @@ { "target": "com.amazonaws.ec2#DescribeCapacityReservations" }, + { + "target": "com.amazonaws.ec2#DescribeCarrierGateways" + }, { "target": "com.amazonaws.ec2#DescribeClassicLinkInstances" }, @@ -1874,6 +1905,9 @@ { "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations" }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences" + }, { "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations" }, @@ -1979,6 +2013,12 @@ { "target": "com.amazonaws.ec2#ModifyTrafficMirrorSession" }, + { + "target": "com.amazonaws.ec2#ModifyTransitGateway" + }, + { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference" + }, { "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment" }, @@ -2012,6 +2052,9 @@ { "target": "com.amazonaws.ec2#ModifyVpnConnection" }, + { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptions" + }, { "target": "com.amazonaws.ec2#ModifyVpnTunnelCertificate" }, @@ -2221,6 +2264,12 @@ "smithy.api#required": {} } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { @@ -2235,12 +2284,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "SecurityGroupId" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } } } }, @@ -2313,12 +2356,12 @@ "com.amazonaws.ec2#AssignIpv6AddressesRequest": { "type": "structure", "members": { - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#Ipv6AddressList", + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", - "smithy.api#xmlName": "ipv6Addresses" + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

The number of IPv6 addresses to assign to the network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range. You can't use this\n option if specifying specific IPv6 addresses.

", + "smithy.api#xmlName": "ipv6AddressCount" } }, "NetworkInterfaceId": { @@ -2330,12 +2373,12 @@ "smithy.api#xmlName": "networkInterfaceId" } }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "

The number of IPv6 addresses to assign to the network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range. You can't use this\n option if specifying specific IPv6 addresses.

", - "smithy.api#xmlName": "ipv6AddressCount" + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", + "smithy.api#xmlName": "ipv6Addresses" } } } @@ -2376,6 +2419,14 @@ "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { "type": "structure", "members": { + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, "AllowReassignment": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -2384,14 +2435,6 @@ "smithy.api#xmlName": "allowReassignment" } }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressStringList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

\n

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -2401,12 +2444,12 @@ "smithy.api#xmlName": "networkInterfaceId" } }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressStringList", "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#documentation": "

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

\n

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "smithy.api#xmlName": "privateIpAddress" } } }, @@ -2417,14 +2460,6 @@ "com.amazonaws.ec2#AssignPrivateIpAddressesResult": { "type": "structure", "members": { - "AssignedPrivateIpAddresses": { - "target": "com.amazonaws.ec2#AssignedPrivateIpAddressList", - "traits": { - "aws.protocols#ec2QueryName": "AssignedPrivateIpAddressesSet", - "smithy.api#documentation": "

The private IP addresses assigned to the network interface.

", - "smithy.api#xmlName": "assignedPrivateIpAddressesSet" - } - }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -2432,6 +2467,14 @@ "smithy.api#documentation": "

The ID of the network interface.

", "smithy.api#xmlName": "networkInterfaceId" } + }, + "AssignedPrivateIpAddresses": { + "target": "com.amazonaws.ec2#AssignedPrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "AssignedPrivateIpAddressesSet", + "smithy.api#documentation": "

The private IP addresses assigned to the network interface.

", + "smithy.api#xmlName": "assignedPrivateIpAddressesSet" + } } } }, @@ -2469,34 +2512,22 @@ "target": "com.amazonaws.ec2#AssociateAddressResult" }, "traits": { - "smithy.api#documentation": "

Associates an Elastic IP address with an instance or a network interface. Before you can\n use an Elastic IP address, you must allocate it to your account.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.

\n

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.

\n " + "smithy.api#documentation": "

Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.

\n

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.

\n

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.

\n " } }, "com.amazonaws.ec2#AssociateAddressRequest": { "type": "structure", "members": { - "AllowReassociation": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowReassociation", - "smithy.api#documentation": "

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", - "smithy.api#xmlName": "allowReassociation" - } - }, - "PrivateIpAddress": { + "PublicIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", - "smithy.api#xmlName": "privateIpAddress" + "smithy.api#documentation": "

The Elastic IP address to associate with the instance. This is required for EC2-Classic.

" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

\n \t

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

", - "smithy.api#xmlName": "networkInterfaceId" + "smithy.api#documentation": "

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" } }, "DryRun": { @@ -2507,16 +2538,12 @@ "smithy.api#xmlName": "dryRun" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", + "AllowReassociation": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The Elastic IP address to associate with the instance. This is required for EC2-Classic.

" + "aws.protocols#ec2QueryName": "AllowReassociation", + "smithy.api#documentation": "

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "smithy.api#xmlName": "allowReassociation" } }, "AllocationId": { @@ -2524,6 +2551,22 @@ "traits": { "smithy.api#documentation": "

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

\n \t

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "smithy.api#xmlName": "privateIpAddress" + } } } }, @@ -2555,19 +2598,6 @@ "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, "SubnetId": { "target": "com.amazonaws.ec2#SubnetId", "traits": { @@ -2581,20 +2611,25 @@ "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} + } } } }, "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult": { "type": "structure", "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The unique ID of the target network association.

", - "smithy.api#xmlName": "associationId" - } - }, "Status": { "target": "com.amazonaws.ec2#AssociationStatus", "traits": { @@ -2602,6 +2637,14 @@ "smithy.api#documentation": "

The current state of the target network association.

", "smithy.api#xmlName": "status" } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The unique ID of the target network association.

", + "smithy.api#xmlName": "associationId" + } } } }, @@ -2617,17 +2660,17 @@ "com.amazonaws.ec2#AssociateDhcpOptionsRequest": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#DefaultingDhcpOptionsId", "traits": { - "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#documentation": "

The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.

", "smithy.api#required": {} } }, - "DhcpOptionsId": { - "target": "com.amazonaws.ec2#DefaultingDhcpOptionsId", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.

", + "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#required": {} } }, @@ -2656,17 +2699,17 @@ "com.amazonaws.ec2#AssociateIamInstanceProfileRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", "traits": { - "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#documentation": "

The IAM instance profile.

", "smithy.api#required": {} } }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#required": {} } } @@ -2700,12 +2743,13 @@ "com.amazonaws.ec2#AssociateRouteTableRequest": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" } }, "GatewayId": { @@ -2722,13 +2766,12 @@ "smithy.api#xmlName": "dryRun" } }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" } } } @@ -2736,14 +2779,6 @@ "com.amazonaws.ec2#AssociateRouteTableResult": { "type": "structure", "members": { - "AssociationState": { - "target": "com.amazonaws.ec2#RouteTableAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "AssociationState", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "associationState" - } - }, "AssociationId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -2751,6 +2786,14 @@ "smithy.api#documentation": "

The route table association ID. This ID is required for disassociating the route\n\t\t\ttable.

", "smithy.api#xmlName": "associationId" } + }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } } } }, @@ -2825,6 +2868,12 @@ "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest": { "type": "structure", "members": { + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -2837,12 +2886,6 @@ "smithy.api#documentation": "

The IDs of the subnets to associate with the transit gateway multicast domain.

" } }, - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { @@ -2879,12 +2922,6 @@ "com.amazonaws.ec2#AssociateTransitGatewayRouteTableRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { @@ -2898,6 +2935,12 @@ "smithy.api#documentation": "

The ID of the attachment.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -2929,28 +2972,25 @@ "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { "type": "structure", "members": { - "Ipv6Pool": { - "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", - "traits": { - "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" - } - }, "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

An IPv4 CIDR block to associate with the VPC.

" } }, - "Ipv6CidrBlockNetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CiDR block to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

\n

You can have one IPv6 CIDR block association per network border group.

" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" } }, - "Ipv6CidrBlock": { + "Ipv6CidrBlockNetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter\n to limit the CIDR block to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

\n

You can have one IPv6 CIDR block association per network border group.

" } }, "AmazonProvidedIpv6CidrBlock": { @@ -2961,13 +3001,16 @@ "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" + "smithy.api#documentation": "

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + } + }, + "Ipv6Pool": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" } } } @@ -2975,6 +3018,14 @@ "com.amazonaws.ec2#AssociateVpcCidrBlockResult": { "type": "structure", "members": { + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, "Ipv6CidrBlockAssociation": { "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociation", "traits": { @@ -2990,14 +3041,6 @@ "smithy.api#documentation": "

Information about the IPv4 CIDR block association.

", "smithy.api#xmlName": "cidrBlockAssociation" } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } } } }, @@ -3056,14 +3099,6 @@ "com.amazonaws.ec2#AssociationStatus": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#AssociationStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the target network association.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -3071,6 +3106,14 @@ "smithy.api#documentation": "

A message about the status of the target network association, if applicable.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#AssociationStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the target network association.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -3114,12 +3157,13 @@ "com.amazonaws.ec2#AttachClassicLinkVpcRequest": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdStringList", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "smithy.api#required": {}, - "smithy.api#xmlName": "SecurityGroupId" + "smithy.api#xmlName": "instanceId" } }, "DryRun": { @@ -3130,13 +3174,12 @@ "smithy.api#xmlName": "dryRun" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "smithy.api#documentation": "

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" + "smithy.api#xmlName": "SecurityGroupId" } }, "VpcId": { @@ -3183,15 +3226,6 @@ "smithy.api#xmlName": "dryRun" } }, - "InternetGatewayId": { - "target": "com.amazonaws.ec2#InternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "InternetGatewayId", - "smithy.api#documentation": "

The ID of the internet gateway.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "internetGatewayId" - } - }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { @@ -3200,6 +3234,15 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcId" } + }, + "InternetGatewayId": { + "target": "com.amazonaws.ec2#InternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "InternetGatewayId", + "smithy.api#documentation": "

The ID of the internet gateway.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "internetGatewayId" + } } } }, @@ -3218,21 +3261,13 @@ "com.amazonaws.ec2#AttachNetworkInterfaceRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" + "smithy.api#xmlName": "networkInterfaceId" } }, "DeviceIndex": { @@ -3244,13 +3279,21 @@ "smithy.api#xmlName": "deviceIndex" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" + "smithy.api#xmlName": "instanceId" } } }, @@ -3283,16 +3326,24 @@ "target": "com.amazonaws.ec2#VolumeAttachment" }, "traits": { - "smithy.api#documentation": "

Attaches an EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.

\n

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For\n more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

\n

After you attach an EBS volume, you must make it available. For more information, see \n Making an EBS Volume Available For Use.

\n

If a volume has an AWS Marketplace product code:

\n \n

For more information, see Attaching Amazon EBS Volumes in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Attaches an EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.

\n

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For\n more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

\n

After you attach an EBS volume, you must make it available. For more information, see \n Making an EBS volume available for use.

\n

If a volume has an AWS Marketplace product code:

\n \n

For more information, see Attaching Amazon EBS volumes in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#AttachVolumeRequest": { "type": "structure", "members": { - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the EBS volume. The volume and instance must be within the same Availability\n Zone.

", + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#required": {} } }, @@ -3303,20 +3354,12 @@ "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", "traits": { - "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#documentation": "

The ID of the EBS volume. The volume and instance must be within the same Availability\n Zone.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } } }, @@ -3342,6 +3385,13 @@ "smithy.api#required": {} } }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -3349,13 +3399,6 @@ "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" } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#required": {} - } } }, "traits": { @@ -3432,6 +3475,14 @@ "com.amazonaws.ec2#AuthorizationRule": { "type": "structure", "members": { + "AccessAll": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AccessAll", + "smithy.api#documentation": "

Indicates whether the authorization rule grants access to all clients.

", + "smithy.api#xmlName": "accessAll" + } + }, "GroupId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -3440,20 +3491,12 @@ "smithy.api#xmlName": "groupId" } }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Description": { + "DestinationCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A brief description of the authorization rule.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

", + "smithy.api#xmlName": "destinationCidr" } }, "Status": { @@ -3464,20 +3507,20 @@ "smithy.api#xmlName": "status" } }, - "DestinationCidr": { + "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DestinationCidr", - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

", - "smithy.api#xmlName": "destinationCidr" + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the authorization rule is associated.

", + "smithy.api#xmlName": "clientVpnEndpointId" } }, - "AccessAll": { - "target": "com.amazonaws.ec2#Boolean", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AccessAll", - "smithy.api#documentation": "

Indicates whether the authorization rule grants access to all clients.

", - "smithy.api#xmlName": "accessAll" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the authorization rule.

", + "smithy.api#xmlName": "description" } } }, @@ -3515,13 +3558,6 @@ "smithy.api#documentation": "

A brief description of the authorization rule.

" } }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, "TargetNetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { @@ -3529,10 +3565,10 @@ "smithy.api#required": {} } }, - "DryRun": { + "AuthorizeAllGroups": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

Indicates whether to grant access to all clients. Specify true to grant all\n clients who successfully establish a VPN connection access to the network. Must be set\n to true if AccessGroupId is not specified.

" } }, "AccessGroupId": { @@ -3541,6 +3577,12 @@ "smithy.api#documentation": "

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -3548,10 +3590,11 @@ "smithy.api#idempotencyToken": {} } }, - "AuthorizeAllGroups": { - "target": "com.amazonaws.ec2#Boolean", + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { - "smithy.api#documentation": "

Indicates whether to grant access to all clients. Specify true to grant all\n clients who successfully establish a VPN connection access to the network. Must be set\n to true if AccessGroupId is not specified.

" + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} } } } @@ -3581,53 +3624,44 @@ "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { "type": "structure", "members": { - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", - "smithy.api#xmlName": "toPort" - } - }, - "SourceSecurityGroupName": { + "IpProtocol": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupName", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", - "smithy.api#xmlName": "sourceSecurityGroupName" + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", + "smithy.api#xmlName": "ipProtocol" } }, - "FromPort": { + "ToPort": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "FromPort", + "aws.protocols#ec2QueryName": "ToPort", "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", - "smithy.api#xmlName": "fromPort" + "smithy.api#xmlName": "toPort" } }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "groupId" + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP\n address range in the same set of permissions.

", + "smithy.api#xmlName": "ipPermissions" } }, - "IpProtocol": { + "CidrIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", - "smithy.api#xmlName": "ipProtocol" + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", + "smithy.api#xmlName": "cidrIp" } }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP\n address range in the same set of permissions.

", - "smithy.api#xmlName": "ipPermissions" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "SourceSecurityGroupOwnerId": { @@ -3638,20 +3672,29 @@ "smithy.api#xmlName": "sourceSecurityGroupOwnerId" } }, - "CidrIp": { + "SourceSecurityGroupName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CidrIp", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", - "smithy.api#xmlName": "cidrIp" + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", + "smithy.api#xmlName": "sourceSecurityGroupName" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "FromPort": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "fromPort" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupId" } } } @@ -3668,40 +3711,42 @@ "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest": { "type": "structure", "members": { - "ToPort": { - "target": "com.amazonaws.ec2#Integer", + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", "traits": { - "smithy.api#documentation": "

The end of port range for the TCP and UDP protocols, or an ICMP code number.\n\t\t\tFor the ICMP code number, use -1 to specify all codes. If you\n\t\t\tspecify all ICMP types, you must specify all codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" } }, - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n\t\t\tsecurity group ID or the security group name in the request.

" + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter \n in combination with the following parameters: the CIDR IP address range, the start of the port range, \n the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. \n To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For \n EC2-VPC, the source security group must be in the same VPC.

" } }, - "FromPort": { + "ToPort": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The start of port range for the TCP and UDP protocols, or an ICMP type number.\n\t\t\tFor the ICMP type number, use -1 to specify all types. If you\n\t\t\tspecify all ICMP types, you must specify all codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + "smithy.api#documentation": "

The end of port range for the TCP and UDP protocols, or an ICMP code number.\n\t\t\tFor the ICMP code number, use -1 to specify all codes. If you\n\t\t\tspecify all ICMP types, you must specify all codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" } }, - "SourceSecurityGroupOwnerId": { - "target": "com.amazonaws.ec2#String", + "FromPort": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

[nondefault VPC] The AWS account ID for the source security group, if the source security group is \n in a different account. You can't specify this parameter in combination with the following parameters: \n the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. \n Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol \n and port range, use a set of IP permissions instead.

" + "smithy.api#documentation": "

The start of port range for the TCP and UDP protocols, or an ICMP type number.\n\t\t\tFor the ICMP type number, use -1 to specify all types. If you\n\t\t\tspecify all ICMP types, you must specify all codes.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" } }, - "SourceSecurityGroupName": { - "target": "com.amazonaws.ec2#String", + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter \n in combination with the following parameters: the CIDR IP address range, the start of the port range, \n the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. \n To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For \n EC2-VPC, the source security group must be in the same VPC.

" + "smithy.api#documentation": "

The sets of IP permissions.

" } }, - "CidrIp": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source\n security group. To specify an IPv6 address range, use a set of IP permissions.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "IpProtocol": { @@ -3710,24 +3755,22 @@ "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

\n

[VPC only] Use -1 to specify all protocols. If you specify -1 or a \n protocol other than tcp, udp, or icmp, traffic on all ports \n is allowed, regardless of any ports you specify.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n\t\t\tsecurity group ID or the security group name in the request.

" } }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The sets of IP permissions.

" + "smithy.api#documentation": "

[nondefault VPC] The AWS account ID for the source security group, if the source security group is \n in a different account. You can't specify this parameter in combination with the following parameters: \n the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. \n Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol \n and port range, use a set of IP permissions instead.

" } }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", + "CidrIp": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + "smithy.api#documentation": "

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source\n security group. To specify an IPv6 address range, use a set of IP permissions.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" } } } @@ -3767,97 +3810,97 @@ "com.amazonaws.ec2#AvailabilityZone": { "type": "structure", "members": { - "ParentZoneId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ParentZoneId", - "smithy.api#documentation": "

The ID of the zone that handles some of the Local Zone control plane operations, such as\n API calls.

", - "smithy.api#xmlName": "parentZoneId" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", + "OptInStatus": { + "target": "com.amazonaws.ec2#AvailabilityZoneOptInStatus", "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

For Availability Zones, this parameter has the same value as the Region name.

\n

For Local Zones, the name of the associated group, for example us-west-2-lax-1.

", - "smithy.api#xmlName": "groupName" + "aws.protocols#ec2QueryName": "OptInStatus", + "smithy.api#documentation": "

For Availability Zones, this parameter always has the value of\n opt-in-not-required.

\n

For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible\n values are opted-in, and not-opted-in.

", + "smithy.api#xmlName": "optInStatus" } }, - "ParentZoneName": { + "RegionName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ParentZoneName", - "smithy.api#documentation": "

The name of the zone that handles some of the Local Zone control plane operations, such as API calls.

", - "smithy.api#xmlName": "parentZoneName" + "aws.protocols#ec2QueryName": "RegionName", + "smithy.api#documentation": "

The name of the Region.

", + "smithy.api#xmlName": "regionName" } }, "ZoneType": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ZoneType", - "smithy.api#documentation": "

The type of zone. The valid values are availability-zone and local-zone.

", + "smithy.api#documentation": "

The type of zone. The valid values are availability-zone,\n local-zone, and wavelength-zone.

", "smithy.api#xmlName": "zoneType" } }, - "ZoneId": { - "target": "com.amazonaws.ec2#String", + "Messages": { + "target": "com.amazonaws.ec2#AvailabilityZoneMessageList", "traits": { - "aws.protocols#ec2QueryName": "ZoneId", - "smithy.api#documentation": "

The ID of the Zone.

", - "smithy.api#xmlName": "zoneId" + "aws.protocols#ec2QueryName": "MessageSet", + "smithy.api#documentation": "

Any messages about the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "messageSet" } }, - "State": { - "target": "com.amazonaws.ec2#AvailabilityZoneState", + "ParentZoneName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ZoneState", - "smithy.api#documentation": "

The state of the Zone.

", - "smithy.api#xmlName": "zoneState" + "aws.protocols#ec2QueryName": "ParentZoneName", + "smithy.api#documentation": "

The name of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", + "smithy.api#xmlName": "parentZoneName" } }, - "RegionName": { + "ParentZoneId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RegionName", - "smithy.api#documentation": "

The name of the Region.

", - "smithy.api#xmlName": "regionName" + "aws.protocols#ec2QueryName": "ParentZoneId", + "smithy.api#documentation": "

The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", + "smithy.api#xmlName": "parentZoneId" } }, "NetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the location from which the address is advertised.

", + "smithy.api#documentation": "

The name of the network border group.

", "smithy.api#xmlName": "networkBorderGroup" } }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

For Availability Zones, this parameter has the same value as the Region name.

\n

For Local Zones, the name of the associated group, for example\n us-west-2-lax-1.

\n

For Wavelength Zones, the name of the associated group, for example\n us-east-1-wl1-bos-wlz-1.

", + "smithy.api#xmlName": "groupName" + } + }, "ZoneName": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ZoneName", - "smithy.api#documentation": "

The name of the Zone.

", + "smithy.api#documentation": "

The name of the Availability Zone, Local Zone, or Wavelength Zone.

", "smithy.api#xmlName": "zoneName" } }, - "Messages": { - "target": "com.amazonaws.ec2#AvailabilityZoneMessageList", + "State": { + "target": "com.amazonaws.ec2#AvailabilityZoneState", "traits": { - "aws.protocols#ec2QueryName": "MessageSet", - "smithy.api#documentation": "

Any messages about the Zone.

", - "smithy.api#xmlName": "messageSet" + "aws.protocols#ec2QueryName": "ZoneState", + "smithy.api#documentation": "

The state of the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "zoneState" } }, - "OptInStatus": { - "target": "com.amazonaws.ec2#AvailabilityZoneOptInStatus", + "ZoneId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OptInStatus", - "smithy.api#documentation": "

For Availability Zones, this parameter always has the value of\n opt-in-not-required.

\n

For Local Zones, this parameter is the opt in status. The possible values are opted-in, and \n not-opted-in.

", - "smithy.api#xmlName": "optInStatus" + "aws.protocols#ec2QueryName": "ZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone, Local Zone, or Wavelength Zone.

", + "smithy.api#xmlName": "zoneId" } } }, "traits": { - "smithy.api#documentation": "

Describes a Zone.

" + "smithy.api#documentation": "

Describes Availability Zones, Local Zones, and Wavelength Zones.

" } }, "com.amazonaws.ec2#AvailabilityZoneList": { @@ -3876,13 +3919,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The message about the Zone.

", + "smithy.api#documentation": "

The message about the Availability Zone, Local Zone, or Wavelength Zone.

", "smithy.api#xmlName": "message" } } }, "traits": { - "smithy.api#documentation": "

Describes a message about a Zone.

" + "smithy.api#documentation": "

Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.

" } }, "com.amazonaws.ec2#AvailabilityZoneMessageList": { @@ -3941,14 +3984,6 @@ "com.amazonaws.ec2#AvailableCapacity": { "type": "structure", "members": { - "AvailableVCpus": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableVCpus", - "smithy.api#documentation": "

The number of vCPUs available for launching instances onto the Dedicated Host.

", - "smithy.api#xmlName": "availableVCpus" - } - }, "AvailableInstanceCapacity": { "target": "com.amazonaws.ec2#AvailableInstanceCapacityList", "traits": { @@ -3956,6 +3991,14 @@ "smithy.api#documentation": "

The number of instances that can be launched onto the Dedicated Host depending on \n \t\tthe host's available capacity. For Dedicated Hosts that support multiple instance types, \n \t\tthis parameter represents the number of instances for each instance size that is \n \t\tsupported on the host.

", "smithy.api#xmlName": "availableInstanceCapacity" } + }, + "AvailableVCpus": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableVCpus", + "smithy.api#documentation": "

The number of vCPUs available for launching instances onto the Dedicated Host.

", + "smithy.api#xmlName": "availableVCpus" + } } }, "traits": { @@ -4065,14 +4108,6 @@ "smithy.api#xmlName": "deviceName" } }, - "VirtualName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", - "smithy.api#xmlName": "virtualName" - } - }, "Ebs": { "target": "com.amazonaws.ec2#EbsBlockDevice", "traits": { @@ -4088,6 +4123,14 @@ "smithy.api#documentation": "

Suppresses the specified device included in the block device mapping of the\n AMI.

", "smithy.api#xmlName": "noDevice" } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", + "smithy.api#xmlName": "virtualName" + } } }, "traits": { @@ -4142,12 +4185,11 @@ "com.amazonaws.ec2#BundleInstanceRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

The ID of the instance to bundle.

\n

Type: String

\n

Default: None

\n

Required: Yes

", + "smithy.api#required": {} } }, "Storage": { @@ -4157,11 +4199,12 @@ "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the instance to bundle.

\n

Type: String

\n

Default: None

\n

Required: Yes

", - "smithy.api#required": {} + "aws.protocols#ec2QueryName": "DryRun", + "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" } } }, @@ -4188,12 +4231,12 @@ "com.amazonaws.ec2#BundleTask": { "type": "structure", "members": { - "InstanceId": { + "Progress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance associated with this bundle task.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The level of task completion, as a percent (for example, 20%).

", + "smithy.api#xmlName": "progress" } }, "BundleId": { @@ -4204,36 +4247,28 @@ "smithy.api#xmlName": "bundleId" } }, - "UpdateTime": { - "target": "com.amazonaws.ec2#DateTime", + "Storage": { + "target": "com.amazonaws.ec2#Storage", "traits": { - "aws.protocols#ec2QueryName": "UpdateTime", - "smithy.api#documentation": "

The time of the most recent update for the task.

", - "smithy.api#xmlName": "updateTime" + "aws.protocols#ec2QueryName": "Storage", + "smithy.api#documentation": "

The Amazon S3 storage locations.

", + "smithy.api#xmlName": "storage" } }, - "Progress": { + "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The level of task completion, as a percent (for example, 20%).

", - "smithy.api#xmlName": "progress" - } - }, - "BundleTaskError": { - "target": "com.amazonaws.ec2#BundleTaskError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

If the task fails, a description of the error.

", - "smithy.api#xmlName": "error" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance associated with this bundle task.

", + "smithy.api#xmlName": "instanceId" } }, - "Storage": { - "target": "com.amazonaws.ec2#Storage", + "State": { + "target": "com.amazonaws.ec2#BundleTaskState", "traits": { - "aws.protocols#ec2QueryName": "Storage", - "smithy.api#documentation": "

The Amazon S3 storage locations.

", - "smithy.api#xmlName": "storage" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the task.

", + "smithy.api#xmlName": "state" } }, "StartTime": { @@ -4244,12 +4279,20 @@ "smithy.api#xmlName": "startTime" } }, - "State": { - "target": "com.amazonaws.ec2#BundleTaskState", + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the task.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The time of the most recent update for the task.

", + "smithy.api#xmlName": "updateTime" + } + }, + "BundleTaskError": { + "target": "com.amazonaws.ec2#BundleTaskError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

If the task fails, a description of the error.

", + "smithy.api#xmlName": "error" } } }, @@ -4260,14 +4303,6 @@ "com.amazonaws.ec2#BundleTaskError": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -4275,6 +4310,14 @@ "smithy.api#documentation": "

The error message.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -4335,12 +4378,12 @@ "smithy.api#xmlName": "state" } }, - "Description": { + "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the address range.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

", + "smithy.api#xmlName": "statusMessage" } }, "Cidr": { @@ -4351,12 +4394,12 @@ "smithy.api#xmlName": "cidr" } }, - "StatusMessage": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

", - "smithy.api#xmlName": "statusMessage" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the address range.

", + "smithy.api#xmlName": "description" } } }, @@ -4442,6 +4485,13 @@ "com.amazonaws.ec2#CancelBundleTaskRequest": { "type": "structure", "members": { + "BundleId": { + "target": "com.amazonaws.ec2#BundleId", + "traits": { + "smithy.api#documentation": "

The ID of the bundle task.

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -4449,13 +4499,6 @@ "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" } - }, - "BundleId": { - "target": "com.amazonaws.ec2#BundleId", - "traits": { - "smithy.api#documentation": "

The ID of the bundle task.

", - "smithy.api#required": {} - } } }, "traits": { @@ -4604,17 +4647,17 @@ "smithy.api#documentation": "

The ID of the import image or import snapshot task to be canceled.

" } }, - "CancelReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The reason for canceling the task.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } + }, + "CancelReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The reason for canceling the task.

" + } } } }, @@ -4629,14 +4672,6 @@ "smithy.api#xmlName": "state" } }, - "PreviousState": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PreviousState", - "smithy.api#documentation": "

The current state of the task being canceled.

", - "smithy.api#xmlName": "previousState" - } - }, "ImportTaskId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -4644,6 +4679,14 @@ "smithy.api#documentation": "

The ID of the task being canceled.

", "smithy.api#xmlName": "importTaskId" } + }, + "PreviousState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PreviousState", + "smithy.api#documentation": "

The current state of the task being canceled.

", + "smithy.api#xmlName": "previousState" + } } } }, @@ -4707,14 +4750,6 @@ "com.amazonaws.ec2#CancelSpotFleetRequestsError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The description for the error code.

", - "smithy.api#xmlName": "message" - } - }, "Code": { "target": "com.amazonaws.ec2#CancelBatchErrorCode", "traits": { @@ -4722,6 +4757,14 @@ "smithy.api#documentation": "

The error code.

", "smithy.api#xmlName": "code" } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the error code.

", + "smithy.api#xmlName": "message" + } } }, "traits": { @@ -4731,14 +4774,6 @@ "com.amazonaws.ec2#CancelSpotFleetRequestsErrorItem": { "type": "structure", "members": { - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - }, "Error": { "target": "com.amazonaws.ec2#CancelSpotFleetRequestsError", "traits": { @@ -4746,6 +4781,14 @@ "smithy.api#documentation": "

The error.

", "smithy.api#xmlName": "error" } + }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } } }, "traits": { @@ -4764,6 +4807,15 @@ "com.amazonaws.ec2#CancelSpotFleetRequestsRequest": { "type": "structure", "members": { + "TerminateInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "TerminateInstances", + "smithy.api#documentation": "

Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "terminateInstances" + } + }, "SpotFleetRequestIds": { "target": "com.amazonaws.ec2#SpotFleetRequestIdList", "traits": { @@ -4780,15 +4832,6 @@ "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" } - }, - "TerminateInstances": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "TerminateInstances", - "smithy.api#documentation": "

Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "terminateInstances" - } } }, "traits": { @@ -4822,6 +4865,14 @@ "com.amazonaws.ec2#CancelSpotFleetRequestsSuccessItem": { "type": "structure", "members": { + "CurrentSpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentSpotFleetRequestState", + "smithy.api#documentation": "

The current state of the Spot Fleet request.

", + "smithy.api#xmlName": "currentSpotFleetRequestState" + } + }, "PreviousSpotFleetRequestState": { "target": "com.amazonaws.ec2#BatchState", "traits": { @@ -4837,14 +4888,6 @@ "smithy.api#documentation": "

The ID of the Spot Fleet request.

", "smithy.api#xmlName": "spotFleetRequestId" } - }, - "CurrentSpotFleetRequestState": { - "target": "com.amazonaws.ec2#BatchState", - "traits": { - "aws.protocols#ec2QueryName": "CurrentSpotFleetRequestState", - "smithy.api#documentation": "

The current state of the Spot Fleet request.

", - "smithy.api#xmlName": "currentSpotFleetRequestState" - } } }, "traits": { @@ -4937,14 +4980,6 @@ "com.amazonaws.ec2#CancelledSpotInstanceRequest": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#CancelSpotInstanceRequestState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Spot Instance request.

", - "smithy.api#xmlName": "state" - } - }, "SpotInstanceRequestId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -4952,6 +4987,14 @@ "smithy.api#documentation": "

The ID of the Spot Instance request.

", "smithy.api#xmlName": "spotInstanceRequestId" } + }, + "State": { + "target": "com.amazonaws.ec2#CancelSpotInstanceRequestState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance request.

", + "smithy.api#xmlName": "state" + } } }, "traits": { @@ -4970,36 +5013,28 @@ "com.amazonaws.ec2#CapacityReservation": { "type": "structure", "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instanceType" - } - }, - "AvailableInstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "EphemeralStorage": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "AvailableInstanceCount", - "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", - "smithy.api#xmlName": "availableInstanceCount" + "aws.protocols#ec2QueryName": "EphemeralStorage", + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports instances with temporary, block-level\n\t\t\tstorage.

", + "smithy.api#xmlName": "ephemeralStorage" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Capacity Reservation.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "EndDate", + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

", + "smithy.api#xmlName": "endDate" } }, - "CapacityReservationId": { - "target": "com.amazonaws.ec2#String", + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" } }, "TotalInstanceCount": { @@ -5010,14 +5045,6 @@ "smithy.api#xmlName": "totalInstanceCount" } }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the Capacity Reservation.

", - "smithy.api#xmlName": "ownerId" - } - }, "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { @@ -5026,60 +5053,60 @@ "smithy.api#xmlName": "availabilityZone" } }, - "EndDate": { - "target": "com.amazonaws.ec2#DateTime", + "InstanceMatchCriteria": { + "target": "com.amazonaws.ec2#InstanceMatchCriteria", "traits": { - "aws.protocols#ec2QueryName": "EndDate", - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

", - "smithy.api#xmlName": "endDate" + "aws.protocols#ec2QueryName": "InstanceMatchCriteria", + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n\t\t ", + "smithy.api#xmlName": "instanceMatchCriteria" } }, - "CapacityReservationArn": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationArn" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Capacity Reservation.

", + "smithy.api#xmlName": "tagSet" } }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

", - "smithy.api#xmlName": "ebsOptimized" + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t ", + "smithy.api#xmlName": "tenancy" } }, - "EphemeralStorage": { - "target": "com.amazonaws.ec2#Boolean", + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EphemeralStorage", - "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports instances with temporary, block-level\n\t\t\tstorage.

", - "smithy.api#xmlName": "ephemeralStorage" + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID of the Capacity Reservation.

", + "smithy.api#xmlName": "availabilityZoneId" } }, - "InstancePlatform": { - "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", + "OwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstancePlatform", - "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instancePlatform" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the Capacity Reservation.

", + "smithy.api#xmlName": "ownerId" } }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", + "AvailableInstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneId", - "smithy.api#documentation": "

The Availability Zone ID of the Capacity Reservation.

", - "smithy.api#xmlName": "availabilityZoneId" + "aws.protocols#ec2QueryName": "AvailableInstanceCount", + "smithy.api#documentation": "

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", + "smithy.api#xmlName": "availableInstanceCount" } }, - "Tenancy": { - "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t ", - "smithy.api#xmlName": "tenancy" + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" } }, "CreateDate": { @@ -5090,6 +5117,22 @@ "smithy.api#xmlName": "createDate" } }, + "EndDateType": { + "target": "com.amazonaws.ec2#EndDateType", + "traits": { + "aws.protocols#ec2QueryName": "EndDateType", + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n\t\t ", + "smithy.api#xmlName": "endDateType" + } + }, + "CapacityReservationArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationArn" + } + }, "State": { "target": "com.amazonaws.ec2#CapacityReservationState", "traits": { @@ -5098,20 +5141,20 @@ "smithy.api#xmlName": "state" } }, - "EndDateType": { - "target": "com.amazonaws.ec2#EndDateType", + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", "traits": { - "aws.protocols#ec2QueryName": "EndDateType", - "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n\t\t ", - "smithy.api#xmlName": "endDateType" + "aws.protocols#ec2QueryName": "InstancePlatform", + "smithy.api#documentation": "

The type of operating system for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instancePlatform" } }, - "InstanceMatchCriteria": { - "target": "com.amazonaws.ec2#InstanceMatchCriteria", + "InstanceType": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceMatchCriteria", - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n\t\t ", - "smithy.api#xmlName": "instanceMatchCriteria" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" } } }, @@ -5122,14 +5165,6 @@ "com.amazonaws.ec2#CapacityReservationGroup": { "type": "structure", "members": { - "GroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupArn", - "smithy.api#documentation": "

The ARN of the resource group.

", - "smithy.api#xmlName": "groupArn" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -5137,6 +5172,14 @@ "smithy.api#documentation": "

The ID of the AWS account that owns the resource group.

", "smithy.api#xmlName": "ownerId" } + }, + "GroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupArn", + "smithy.api#documentation": "

The ARN of the resource group.

", + "smithy.api#xmlName": "groupArn" + } } }, "traits": { @@ -5211,10 +5254,6 @@ { "value": "Linux with SQL Server Enterprise", "name": "LINUX_WITH_SQL_SERVER_ENTERPRISE" - }, - { - "value": "Windows BYOL", - "name": "BYOL_WINDOWS" } ] } @@ -5274,17 +5313,17 @@ "com.amazonaws.ec2#CapacityReservationSpecification": { "type": "structure", "members": { - "CapacityReservationTarget": { - "target": "com.amazonaws.ec2#CapacityReservationTarget", - "traits": { - "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation group.

" - } - }, "CapacityReservationPreference": { "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

\n\t\t " } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTarget", + "traits": { + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation group.

" + } } }, "traits": { @@ -5294,14 +5333,6 @@ "com.amazonaws.ec2#CapacityReservationSpecificationResponse": { "type": "structure", "members": { - "CapacityReservationTarget": { - "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationTarget", - "smithy.api#documentation": "

Information about the targeted Capacity Reservation or Capacity Reservation group.

", - "smithy.api#xmlName": "capacityReservationTarget" - } - }, "CapacityReservationPreference": { "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { @@ -5309,6 +5340,14 @@ "smithy.api#documentation": "

Describes the instance's Capacity Reservation preferences. Possible preferences include:

\n ", "smithy.api#xmlName": "capacityReservationPreference" } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationTarget", + "smithy.api#documentation": "

Information about the targeted Capacity Reservation or Capacity Reservation group.

", + "smithy.api#xmlName": "capacityReservationTarget" + } } }, "traits": { @@ -5360,14 +5399,6 @@ "com.amazonaws.ec2#CapacityReservationTargetResponse": { "type": "structure", "members": { - "CapacityReservationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the targeted Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" - } - }, "CapacityReservationResourceGroupArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -5375,6 +5406,14 @@ "smithy.api#documentation": "

The ARN of the targeted Capacity Reservation group.

", "smithy.api#xmlName": "capacityReservationResourceGroupArn" } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the targeted Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } } }, "traits": { @@ -5394,6 +5433,100 @@ ] } }, + "com.amazonaws.ec2#CarrierGateway": { + "type": "structure", + "members": { + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID of the owner of the carrier gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the carrier gateway.

", + "smithy.api#xmlName": "tagSet" + } + }, + "State": { + "target": "com.amazonaws.ec2#CarrierGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the carrier gateway.

", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC associated with the carrier gateway.

", + "smithy.api#xmlName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a carrier gateway.

" + } + }, + "com.amazonaws.ec2#CarrierGatewayId": { + "type": "string" + }, + "com.amazonaws.ec2#CarrierGatewayIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CarrierGatewayId" + } + }, + "com.amazonaws.ec2#CarrierGatewayMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#CarrierGatewaySet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CarrierGatewayState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pending" + }, + { + "value": "available" + }, + { + "value": "deleting" + }, + { + "value": "deleted" + } + ] + } + }, "com.amazonaws.ec2#CertificateAuthentication": { "type": "structure", "members": { @@ -5507,22 +5640,6 @@ "com.amazonaws.ec2#ClassicLinkInstance": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, "Groups": { "target": "com.amazonaws.ec2#GroupIdentifierList", "traits": { @@ -5538,6 +5655,22 @@ "smithy.api#documentation": "

Any tags assigned to the instance.

", "smithy.api#xmlName": "tagSet" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } } }, "traits": { @@ -5640,28 +5773,28 @@ "com.amazonaws.ec2#ClientData": { "type": "structure", "members": { - "Comment": { - "target": "com.amazonaws.ec2#String", + "UploadEnd": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

A user-defined comment about the disk upload.

" + "smithy.api#documentation": "

The time that the disk upload ends.

" } }, - "UploadStart": { - "target": "com.amazonaws.ec2#DateTime", + "UploadSize": { + "target": "com.amazonaws.ec2#Double", "traits": { - "smithy.api#documentation": "

The time that the disk upload starts.

" + "smithy.api#documentation": "

The size of the uploaded disk image, in GiB.

" } }, - "UploadEnd": { + "UploadStart": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The time that the disk upload ends.

" + "smithy.api#documentation": "

The time that the disk upload starts.

" } }, - "UploadSize": { - "target": "com.amazonaws.ec2#Double", + "Comment": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The size of the uploaded disk image, in GiB.

" + "smithy.api#documentation": "

A user-defined comment about the disk upload.

" } } }, @@ -5675,6 +5808,22 @@ "com.amazonaws.ec2#ClientVpnAuthentication": { "type": "structure", "members": { + "MutualAuthentication": { + "target": "com.amazonaws.ec2#CertificateAuthentication", + "traits": { + "aws.protocols#ec2QueryName": "MutualAuthentication", + "smithy.api#documentation": "

Information about the authentication certificates, if applicable.

", + "smithy.api#xmlName": "mutualAuthentication" + } + }, + "Type": { + "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The authentication type used.

", + "smithy.api#xmlName": "type" + } + }, "ActiveDirectory": { "target": "com.amazonaws.ec2#DirectoryServiceAuthentication", "traits": { @@ -5690,22 +5839,6 @@ "smithy.api#documentation": "

Information about the IAM SAML identity provider, if applicable.

", "smithy.api#xmlName": "federatedAuthentication" } - }, - "Type": { - "target": "com.amazonaws.ec2#ClientVpnAuthenticationType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The authentication type used.

", - "smithy.api#xmlName": "type" - } - }, - "MutualAuthentication": { - "target": "com.amazonaws.ec2#CertificateAuthentication", - "traits": { - "aws.protocols#ec2QueryName": "MutualAuthentication", - "smithy.api#documentation": "

Information about the authentication certificates, if applicable.

", - "smithy.api#xmlName": "mutualAuthentication" - } } }, "traits": { @@ -5778,14 +5911,6 @@ "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatus": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the authorization rule.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -5793,6 +5918,14 @@ "smithy.api#documentation": "

A message about the status of the authorization rule, if applicable.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#ClientVpnAuthorizationRuleStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the authorization rule.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -5821,36 +5954,12 @@ "com.amazonaws.ec2#ClientVpnConnection": { "type": "structure", "members": { - "EgressPackets": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EgressPackets", - "smithy.api#documentation": "

The number of packets received by the client.

", - "smithy.api#xmlName": "egressPackets" - } - }, - "ConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionId", - "smithy.api#documentation": "

The ID of the client connection.

", - "smithy.api#xmlName": "connectionId" - } - }, - "EgressBytes": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EgressBytes", - "smithy.api#documentation": "

The number of bytes received by the client.

", - "smithy.api#xmlName": "egressBytes" - } - }, - "ConnectionEstablishedTime": { + "ClientIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ConnectionEstablishedTime", - "smithy.api#documentation": "

The date and time the client connection was established.

", - "smithy.api#xmlName": "connectionEstablishedTime" + "aws.protocols#ec2QueryName": "ClientIp", + "smithy.api#documentation": "

The IP address of the client.

", + "smithy.api#xmlName": "clientIp" } }, "Username": { @@ -5869,12 +5978,12 @@ "smithy.api#xmlName": "timestamp" } }, - "ClientIp": { + "ConnectionEndTime": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ClientIp", - "smithy.api#documentation": "

The IP address of the client.

", - "smithy.api#xmlName": "clientIp" + "aws.protocols#ec2QueryName": "ConnectionEndTime", + "smithy.api#documentation": "

The date and time the client connection was terminated.

", + "smithy.api#xmlName": "connectionEndTime" } }, "IngressBytes": { @@ -5885,20 +5994,44 @@ "smithy.api#xmlName": "ingressBytes" } }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the client connection.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", + "smithy.api#xmlName": "clientVpnEndpointId" } }, - "IngressPackets": { + "EgressPackets": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IngressPackets", - "smithy.api#documentation": "

The number of packets sent by the client.

", - "smithy.api#xmlName": "ingressPackets" + "aws.protocols#ec2QueryName": "EgressPackets", + "smithy.api#documentation": "

The number of packets received by the client.

", + "smithy.api#xmlName": "egressPackets" + } + }, + "ConnectionEstablishedTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionEstablishedTime", + "smithy.api#documentation": "

The date and time the client connection was established.

", + "smithy.api#xmlName": "connectionEstablishedTime" + } + }, + "EgressBytes": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EgressBytes", + "smithy.api#documentation": "

The number of bytes received by the client.

", + "smithy.api#xmlName": "egressBytes" + } + }, + "ConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionId", + "smithy.api#documentation": "

The ID of the client connection.

", + "smithy.api#xmlName": "connectionId" } }, "CommonName": { @@ -5909,20 +6042,20 @@ "smithy.api#xmlName": "commonName" } }, - "ClientVpnEndpointId": { + "IngressPackets": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", - "smithy.api#xmlName": "clientVpnEndpointId" + "aws.protocols#ec2QueryName": "IngressPackets", + "smithy.api#documentation": "

The number of packets sent by the client.

", + "smithy.api#xmlName": "ingressPackets" } }, - "ConnectionEndTime": { - "target": "com.amazonaws.ec2#String", + "Status": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", "traits": { - "aws.protocols#ec2QueryName": "ConnectionEndTime", - "smithy.api#documentation": "

The date and time the client connection was terminated.

", - "smithy.api#xmlName": "connectionEndTime" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the client connection.

", + "smithy.api#xmlName": "status" } } }, @@ -5942,14 +6075,6 @@ "com.amazonaws.ec2#ClientVpnConnectionStatus": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", - "smithy.api#xmlName": "message" - } - }, "Code": { "target": "com.amazonaws.ec2#ClientVpnConnectionStatusCode", "traits": { @@ -5957,6 +6082,14 @@ "smithy.api#documentation": "

The state of the client connection.

", "smithy.api#xmlName": "code" } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the client connection, if applicable.

", + "smithy.api#xmlName": "message" + } } }, "traits": { @@ -5985,36 +6118,12 @@ "com.amazonaws.ec2#ClientVpnEndpoint": { "type": "structure", "members": { - "ServerCertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServerCertificateArn", - "smithy.api#documentation": "

The ARN of the server certificate.

", - "smithy.api#xmlName": "serverCertificateArn" - } - }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpointId", - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#xmlName": "clientVpnEndpointId" - } - }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", - "smithy.api#xmlName": "status" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Client VPN endpoint.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" } }, "ClientCidrBlock": { @@ -6025,14 +6134,6 @@ "smithy.api#xmlName": "clientCidrBlock" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupIdSet", - "smithy.api#documentation": "

The IDs of the security groups for the target network.

", - "smithy.api#xmlName": "securityGroupIdSet" - } - }, "VpnProtocol": { "target": "com.amazonaws.ec2#VpnProtocol", "traits": { @@ -6052,6 +6153,54 @@ "smithy.api#xmlName": "associatedTargetNetwork" } }, + "TransportProtocol": { + "target": "com.amazonaws.ec2#TransportProtocol", + "traits": { + "aws.protocols#ec2QueryName": "TransportProtocol", + "smithy.api#documentation": "

The transport protocol used by the Client VPN endpoint.

", + "smithy.api#xmlName": "transportProtocol" + } + }, + "DnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "DnsServer", + "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution.

", + "smithy.api#xmlName": "dnsServer" + } + }, + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogResponseOptions", + "traits": { + "aws.protocols#ec2QueryName": "ConnectionLogOptions", + "smithy.api#documentation": "

Information about the client connection logging options for the Client VPN endpoint.

", + "smithy.api#xmlName": "connectionLogOptions" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } + }, + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpointId", + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "clientVpnEndpointId" + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServerCertificateArn", + "smithy.api#documentation": "

The ARN of the server certificate.

", + "smithy.api#xmlName": "serverCertificateArn" + } + }, "AuthenticationOptions": { "target": "com.amazonaws.ec2#ClientVpnAuthenticationList", "traits": { @@ -6068,6 +6217,14 @@ "smithy.api#xmlName": "splitTunnel" } }, + "CreationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The date and time the Client VPN endpoint was created.

", + "smithy.api#xmlName": "creationTime" + } + }, "VpnPort": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -6076,12 +6233,12 @@ "smithy.api#xmlName": "vpnPort" } }, - "DnsServers": { - "target": "com.amazonaws.ec2#ValueStringList", + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", "traits": { - "aws.protocols#ec2QueryName": "DnsServer", - "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution.

", - "smithy.api#xmlName": "dnsServer" + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The IDs of the security groups for the target network.

", + "smithy.api#xmlName": "securityGroupIdSet" } }, "DeletionTime": { @@ -6092,14 +6249,6 @@ "smithy.api#xmlName": "deletionTime" } }, - "DnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DnsName", - "smithy.api#documentation": "

The DNS name to be used by clients when connecting to the Client VPN endpoint.

", - "smithy.api#xmlName": "dnsName" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -6108,36 +6257,20 @@ "smithy.api#xmlName": "description" } }, - "ConnectionLogOptions": { - "target": "com.amazonaws.ec2#ConnectionLogResponseOptions", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionLogOptions", - "smithy.api#documentation": "

Information about the client connection logging options for the Client VPN endpoint.

", - "smithy.api#xmlName": "connectionLogOptions" - } - }, - "TransportProtocol": { - "target": "com.amazonaws.ec2#TransportProtocol", - "traits": { - "aws.protocols#ec2QueryName": "TransportProtocol", - "smithy.api#documentation": "

The transport protocol used by the Client VPN endpoint.

", - "smithy.api#xmlName": "transportProtocol" - } - }, - "CreationTime": { + "DnsName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The date and time the Client VPN endpoint was created.

", - "smithy.api#xmlName": "creationTime" + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name to be used by clients when connecting to the Client VPN endpoint.

", + "smithy.api#xmlName": "dnsName" } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Client VPN endpoint.

", + "smithy.api#xmlName": "tagSet" } } }, @@ -6160,14 +6293,6 @@ "com.amazonaws.ec2#ClientVpnEndpointStatus": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#ClientVpnEndpointStatusCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the Client VPN endpoint. Possible states include:

\n\t\t ", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -6175,6 +6300,14 @@ "smithy.api#documentation": "

A message about the status of the Client VPN endpoint.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatusCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state of the Client VPN endpoint. Possible states include:

\n\t\t ", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -6211,20 +6344,20 @@ "smithy.api#xmlName": "targetSubnet" } }, - "Origin": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Origin", - "smithy.api#documentation": "

Indicates how the route was associated with the Client VPN endpoint. \n\t\t\tassociate indicates that the route was automatically added when the target network \n\t\t\twas associated with the Client VPN endpoint. add-route indicates that the route \n\t\t\twas manually added using the CreateClientVpnRoute action.

", - "smithy.api#xmlName": "origin" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A brief description of the route.

", + "smithy.api#xmlName": "description" } }, - "DestinationCidr": { - "target": "com.amazonaws.ec2#String", + "Status": { + "target": "com.amazonaws.ec2#ClientVpnRouteStatus", "traits": { - "aws.protocols#ec2QueryName": "DestinationCidr", - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination.

", - "smithy.api#xmlName": "destinationCidr" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the route.

", + "smithy.api#xmlName": "status" } }, "Type": { @@ -6235,14 +6368,6 @@ "smithy.api#xmlName": "type" } }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnRouteStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the route.

", - "smithy.api#xmlName": "status" - } - }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -6251,12 +6376,20 @@ "smithy.api#xmlName": "clientVpnEndpointId" } }, - "Description": { + "DestinationCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A brief description of the route.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "DestinationCidr", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination.

", + "smithy.api#xmlName": "destinationCidr" + } + }, + "Origin": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Indicates how the route was associated with the Client VPN endpoint. \n\t\t\tassociate indicates that the route was automatically added when the target network \n\t\t\twas associated with the Client VPN endpoint. add-route indicates that the route \n\t\t\twas manually added using the CreateClientVpnRoute action.

", + "smithy.api#xmlName": "origin" } } }, @@ -6276,14 +6409,6 @@ "com.amazonaws.ec2#ClientVpnRouteStatus": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

A message about the status of the Client VPN endpoint route, if applicable.

", - "smithy.api#xmlName": "message" - } - }, "Code": { "target": "com.amazonaws.ec2#ClientVpnRouteStatusCode", "traits": { @@ -6291,6 +6416,14 @@ "smithy.api#documentation": "

The state of the Client VPN endpoint route.

", "smithy.api#xmlName": "code" } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

A message about the status of the Client VPN endpoint route, if applicable.

", + "smithy.api#xmlName": "message" + } } }, "traits": { @@ -6336,14 +6469,6 @@ "smithy.api#xmlName": "awsService" } }, - "AllocationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The allocation ID of the address.

", - "smithy.api#xmlName": "allocationId" - } - }, "CoIp": { "target": "com.amazonaws.ec2#String", "traits": { @@ -6359,6 +6484,14 @@ "smithy.api#documentation": "

The AWS account ID.

", "smithy.api#xmlName": "awsAccountId" } + }, + "AllocationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID of the address.

", + "smithy.api#xmlName": "allocationId" + } } }, "traits": { @@ -6385,12 +6518,12 @@ "smithy.api#xmlName": "poolId" } }, - "PoolArn": { - "target": "com.amazonaws.ec2#ResourceArn", + "PoolCidrs": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "PoolArn", - "smithy.api#documentation": "

The ARN of the address pool.

", - "smithy.api#xmlName": "poolArn" + "aws.protocols#ec2QueryName": "PoolCidrSet", + "smithy.api#documentation": "

The address ranges of the address pool.

", + "smithy.api#xmlName": "poolCidrSet" } }, "Tags": { @@ -6401,14 +6534,6 @@ "smithy.api#xmlName": "tagSet" } }, - "PoolCidrs": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "PoolCidrSet", - "smithy.api#documentation": "

The address ranges of the address pool.

", - "smithy.api#xmlName": "poolCidrSet" - } - }, "LocalGatewayRouteTableId": { "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", "traits": { @@ -6416,6 +6541,14 @@ "smithy.api#documentation": "

The ID of the local gateway route table.

", "smithy.api#xmlName": "localGatewayRouteTableId" } + }, + "PoolArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "PoolArn", + "smithy.api#documentation": "

The ARN of the address pool.

", + "smithy.api#xmlName": "poolArn" + } } }, "traits": { @@ -6515,16 +6648,16 @@ "com.amazonaws.ec2#ConnectionLogOptions": { "type": "structure", "members": { - "CloudwatchLogStream": { + "CloudwatchLogGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch Logs log stream to which the connection data is published.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs log group. Required if connection logging is enabled.

" } }, - "CloudwatchLogGroup": { + "CloudwatchLogStream": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch Logs log group. Required if connection logging is enabled.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs log stream to which the connection data is published.

" } }, "Enabled": { @@ -6541,12 +6674,6 @@ "com.amazonaws.ec2#ConnectionLogResponseOptions": { "type": "structure", "members": { - "CloudwatchLogGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

" - } - }, "Enabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -6558,6 +6685,12 @@ "traits": { "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.

" } + }, + "CloudwatchLogGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

" + } } }, "traits": { @@ -6567,20 +6700,12 @@ "com.amazonaws.ec2#ConnectionNotification": { "type": "structure", "members": { - "ConnectionNotificationState": { - "target": "com.amazonaws.ec2#ConnectionNotificationState", - "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotificationState", - "smithy.api#documentation": "

The state of the notification.

", - "smithy.api#xmlName": "connectionNotificationState" - } - }, - "ServiceId": { + "ConnectionNotificationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the endpoint service.

", - "smithy.api#xmlName": "serviceId" + "aws.protocols#ec2QueryName": "ConnectionNotificationId", + "smithy.api#documentation": "

The ID of the notification.

", + "smithy.api#xmlName": "connectionNotificationId" } }, "ConnectionNotificationType": { @@ -6591,20 +6716,20 @@ "smithy.api#xmlName": "connectionNotificationType" } }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#String", + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointId", - "smithy.api#documentation": "

The ID of the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointId" + "aws.protocols#ec2QueryName": "ConnectionEvents", + "smithy.api#documentation": "

The events for the notification. Valid values are Accept,\n Connect, Delete, and Reject.

", + "smithy.api#xmlName": "connectionEvents" } }, - "ConnectionNotificationId": { - "target": "com.amazonaws.ec2#String", + "ConnectionNotificationState": { + "target": "com.amazonaws.ec2#ConnectionNotificationState", "traits": { - "aws.protocols#ec2QueryName": "ConnectionNotificationId", - "smithy.api#documentation": "

The ID of the notification.

", - "smithy.api#xmlName": "connectionNotificationId" + "aws.protocols#ec2QueryName": "ConnectionNotificationState", + "smithy.api#documentation": "

The state of the notification.

", + "smithy.api#xmlName": "connectionNotificationState" } }, "ConnectionNotificationArn": { @@ -6615,12 +6740,20 @@ "smithy.api#xmlName": "connectionNotificationArn" } }, - "ConnectionEvents": { - "target": "com.amazonaws.ec2#ValueStringList", + "ServiceId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ConnectionEvents", - "smithy.api#documentation": "

The events for the notification. Valid values are Accept,\n Connect, Delete, and Reject.

", - "smithy.api#xmlName": "connectionEvents" + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the endpoint service.

", + "smithy.api#xmlName": "serviceId" + } + }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" } } }, @@ -6697,14 +6830,6 @@ "com.amazonaws.ec2#ConversionTask": { "type": "structure", "members": { - "ImportVolume": { - "target": "com.amazonaws.ec2#ImportVolumeTaskDetails", - "traits": { - "aws.protocols#ec2QueryName": "ImportVolume", - "smithy.api#documentation": "

If the task is for importing a volume, this contains information about the import volume task.

", - "smithy.api#xmlName": "importVolume" - } - }, "ImportInstance": { "target": "com.amazonaws.ec2#ImportInstanceTaskDetails", "traits": { @@ -6713,12 +6838,20 @@ "smithy.api#xmlName": "importInstance" } }, - "ConversionTaskId": { + "ImportVolume": { + "target": "com.amazonaws.ec2#ImportVolumeTaskDetails", + "traits": { + "aws.protocols#ec2QueryName": "ImportVolume", + "smithy.api#documentation": "

If the task is for importing a volume, this contains information about the import volume task.

", + "smithy.api#xmlName": "importVolume" + } + }, + "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ConversionTaskId", - "smithy.api#documentation": "

The ID of the conversion task.

", - "smithy.api#xmlName": "conversionTaskId" + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message related to the conversion task.

", + "smithy.api#xmlName": "statusMessage" } }, "Tags": { @@ -6729,14 +6862,6 @@ "smithy.api#xmlName": "tagSet" } }, - "ExpirationTime": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExpirationTime", - "smithy.api#documentation": "

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel\n the task.

", - "smithy.api#xmlName": "expirationTime" - } - }, "State": { "target": "com.amazonaws.ec2#ConversionTaskState", "traits": { @@ -6745,12 +6870,20 @@ "smithy.api#xmlName": "state" } }, - "StatusMessage": { + "ConversionTaskId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message related to the conversion task.

", - "smithy.api#xmlName": "statusMessage" + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#documentation": "

The ID of the conversion task.

", + "smithy.api#xmlName": "conversionTaskId" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExpirationTime", + "smithy.api#documentation": "

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel\n the task.

", + "smithy.api#xmlName": "expirationTime" } } }, @@ -6802,6 +6935,12 @@ "smithy.api#required": {} } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "Name": { "target": "com.amazonaws.ec2#String", "traits": { @@ -6814,12 +6953,6 @@ "smithy.api#documentation": "

The description for the new AFI.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "SourceRegion": { "target": "com.amazonaws.ec2#String", "traits": { @@ -6870,24 +7003,10 @@ "smithy.api#required": {} } }, - "SourceImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ID of the AMI to copy.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the new AMI in the destination Region.

", - "smithy.api#required": {} - } - }, - "ClientToken": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n\t\t\t\tidempotency of the request. For more information, see How to Ensure Idempotency in the \n\t\t\t Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

A description for the new AMI in the destination Region.

" } }, "DryRun": { @@ -6898,12 +7017,6 @@ "smithy.api#xmlName": "dryRun" } }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the new AMI in the destination Region.

" - } - }, "KmsKeyId": { "target": "com.amazonaws.ec2#KmsKeyId", "traits": { @@ -6919,6 +7032,26 @@ "smithy.api#documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted.\n You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted\n copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default \n AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "smithy.api#xmlName": "encrypted" } + }, + "SourceImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the AMI to copy.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n\t\t\t\tidempotency of the request. For more information, see How to Ensure Idempotency in the \n\t\t\t Amazon Elastic Compute Cloud User Guide.

" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the new AMI in the destination Region.

", + "smithy.api#required": {} + } } }, "traits": { @@ -6950,18 +7083,12 @@ "target": "com.amazonaws.ec2#CopySnapshotResult" }, "traits": { - "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the\n snapshot within the same Region or from one Region to another. You can use the snapshot to\n create EBS volumes or Amazon Machine Images (AMIs).

\n

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain\n unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted \n snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a \n different CMK.

\n

To copy an encrypted snapshot that has been shared from another account, you must have\n permissions for the CMK used to encrypt the snapshot.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copying an Amazon EBS Snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the\n snapshot within the same Region or from one Region to another. You can use the snapshot to\n create EBS volumes or Amazon Machine Images (AMIs).

\n

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain\n unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted \n snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a \n different CMK.

\n

To copy an encrypted snapshot that has been shared from another account, you must have\n permissions for the CMK used to encrypt the snapshot.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copying an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CopySnapshotRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the EBS snapshot.

" - } - }, "PresignedUrl": { "target": "com.amazonaws.ec2#String", "traits": { @@ -6978,11 +7105,17 @@ "smithy.api#xmlName": "dryRun" } }, - "SourceRegion": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the Region that contains the snapshot to be copied.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the EBS snapshot.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new snapshot.

", + "smithy.api#xmlName": "TagSpecification" } }, "KmsKeyId": { @@ -6993,14 +7126,6 @@ "smithy.api#xmlName": "kmsKeyId" } }, - "DestinationRegion": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationRegion", - "smithy.api#documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.

\n \n

The snapshot copy is sent to the regional endpoint that you sent the HTTP\n request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is\n specified using the --region parameter or the default Region in your AWS\n configuration file.

", - "smithy.api#xmlName": "destinationRegion" - } - }, "Encrypted": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -7016,11 +7141,19 @@ "smithy.api#required": {} } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "SourceRegion": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The tags to apply to the new snapshot.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The ID of the Region that contains the snapshot to be copied.

", + "smithy.api#required": {} + } + }, + "DestinationRegion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationRegion", + "smithy.api#documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.

\n \n

The snapshot copy is sent to the regional endpoint that you sent the HTTP\n request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is\n specified using the --region parameter or the default Region in your AWS\n configuration file.

", + "smithy.api#xmlName": "destinationRegion" } } } @@ -7028,14 +7161,6 @@ "com.amazonaws.ec2#CopySnapshotResult": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the new snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -7043,6 +7168,14 @@ "smithy.api#documentation": "

Any tags applied to the new snapshot.

", "smithy.api#xmlName": "tagSet" } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the new snapshot.

", + "smithy.api#xmlName": "snapshotId" + } } } }, @@ -7098,16 +7231,16 @@ "com.amazonaws.ec2#CpuOptionsRequest": { "type": "structure", "members": { - "ThreadsPerCore": { + "CoreCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for\n the instance, specify a value of 1. Otherwise, specify the default value of\n 2.

" + "smithy.api#documentation": "

The number of CPU cores for the instance.

" } }, - "CoreCount": { + "ThreadsPerCore": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of CPU cores for the instance.

" + "smithy.api#documentation": "

The number of threads per CPU core. To disable multithreading for\n the instance, specify a value of 1. Otherwise, specify the default value of\n 2.

" } } }, @@ -7130,16 +7263,29 @@ "com.amazonaws.ec2#CreateCapacityReservationRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

", + "smithy.api#required": {} } }, - "EphemeralStorage": { + "EbsOptimized": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports instances with temporary, block-level\n\t\t\tstorage.

" + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone in which to create the Capacity Reservation.

" + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\t\n\t\t

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

\n\t\t\n\t\t

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

" } }, "InstanceType": { @@ -7155,35 +7301,28 @@ "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n\t\t \n\t\t

Default: open\n

" } }, - "InstancePlatform": { - "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", - "traits": { - "smithy.api#documentation": "

The type of operating system for which to reserve capacity.

", - "smithy.api#required": {} - } - }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, - "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The ID of the Availability Zone in which to create the Capacity Reservation.

" + "smithy.api#documentation": "

The tags to apply to the Capacity Reservation during launch.

" } }, - "EbsOptimized": { + "EphemeralStorage": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides\n\t\t\tdedicated throughput to Amazon EBS and an optimized configuration stack to provide\n\t\t\toptimal I/O performance. This optimization isn't available with all instance types.\n\t\t\tAdditional usage charges apply when using an EBS- optimized instance.

" + "smithy.api#documentation": "

Indicates whether the Capacity Reservation supports instances with temporary, block-level\n\t\t\tstorage.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", "traits": { - "smithy.api#documentation": "

The tags to apply to the Capacity Reservation during launch.

" + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t " } }, "AvailabilityZone": { @@ -7192,16 +7331,10 @@ "smithy.api#documentation": "

The Availability Zone in which to create the Capacity Reservation.

" } }, - "EndDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\t\n\t\t

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

\n\t\t\n\t\t

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t " + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "EndDateType": { @@ -7210,10 +7343,10 @@ "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n\t\t " } }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "InstancePlatform": { + "target": "com.amazonaws.ec2#CapacityReservationInstancePlatform", "traits": { - "smithy.api#documentation": "

The number of instances for which to reserve capacity.

", + "smithy.api#documentation": "

The type of operating system for which to reserve capacity.

", "smithy.api#required": {} } } @@ -7232,84 +7365,129 @@ } } }, - "com.amazonaws.ec2#CreateClientVpnEndpoint": { + "com.amazonaws.ec2#CreateCarrierGateway": { "type": "operation", "input": { - "target": "com.amazonaws.ec2#CreateClientVpnEndpointRequest" + "target": "com.amazonaws.ec2#CreateCarrierGatewayRequest" }, "output": { - "target": "com.amazonaws.ec2#CreateClientVpnEndpointResult" + "target": "com.amazonaws.ec2#CreateCarrierGatewayResult" }, "traits": { - "smithy.api#documentation": "

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to \n\t\t\tenable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions \n\t\t\tare terminated.

" + "smithy.api#documentation": "

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer\n Guide.

" } }, - "com.amazonaws.ec2#CreateClientVpnEndpointRequest": { + "com.amazonaws.ec2#CreateCarrierGatewayRequest": { "type": "structure", "members": { - "VpnPort": { - "target": "com.amazonaws.ec2#Integer", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n\t

Valid Values: 443 | 1194\n

\n\t

Default Value: 443\n

" + "smithy.api#documentation": "

The tags to associate with the carrier gateway.

", + "smithy.api#xmlName": "TagSpecification" } }, - "ConnectionLogOptions": { - "target": "com.amazonaws.ec2#ConnectionLogOptions", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

Information about the client connection logging options.

\n\t\t

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n\t\t ", + "smithy.api#documentation": "

The ID of the VPC to associate with the carrier gateway.

", "smithy.api#required": {} } }, - "TransportProtocol": { - "target": "com.amazonaws.ec2#TransportProtocol", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The transport protocol to be used by the VPN session.

\n\t\t

Default value: udp\n

" + "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.

" } }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.ec2#CreateCarrierGatewayResult": { + "type": "structure", + "members": { + "CarrierGateway": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGateway", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGateway" + } + } + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateClientVpnEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateClientVpnEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to \n\t\t\tenable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions \n\t\t\tare terminated.

" + } + }, + "com.amazonaws.ec2#CreateClientVpnEndpointRequest": { + "type": "structure", + "members": { "Description": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" } }, - "ClientCidrBlock": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "ServerCertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the server certificate. For more information, see \n\t\t\tthe AWS Certificate Manager User Guide.

", "smithy.api#required": {} } }, - "DnsServers": { - "target": "com.amazonaws.ec2#ValueStringList", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can\n\t\t\thave up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

" + "smithy.api#documentation": "

The tags to apply to the Client VPN endpoint during creation.

", + "smithy.api#xmlName": "TagSpecification" } }, - "ServerCertificateArn": { + "ClientCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ARN of the server certificate. For more information, see \n\t\t\tthe AWS Certificate Manager User Guide.

", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

", "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

", + "smithy.api#xmlName": "SecurityGroupId" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "SplitTunnel": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

\n\t\t

By default, split-tunnel on a VPN endpoint is disabled.

\n\t\t

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS\n\t\t\t\tClient VPN Administrator Guide.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "DnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "smithy.api#documentation": "

The tags to apply to the Client VPN endpoint during creation.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can\n\t\t\thave up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

" } }, "VpcId": { @@ -7318,10 +7496,23 @@ "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

" } }, - "SplitTunnel": { - "target": "com.amazonaws.ec2#Boolean", + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogOptions", "traits": { - "smithy.api#documentation": "

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

\n\t\t

By default, split-tunnel on a VPN endpoint is disabled.

\n\t\t

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS\n\t\t\t\tClient VPN Administrator Guide.

" + "smithy.api#documentation": "

Information about the client connection logging options.

\n\t\t

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n\t\t ", + "smithy.api#required": {} + } + }, + "VpnPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n\t

Valid Values: 443 | 1194\n

\n\t

Default Value: 443\n

" + } + }, + "TransportProtocol": { + "target": "com.amazonaws.ec2#TransportProtocol", + "traits": { + "smithy.api#documentation": "

The transport protocol to be used by the VPN session.

\n\t\t

Default value: udp\n

" } }, "AuthenticationOptions": { @@ -7332,11 +7523,10 @@ "smithy.api#xmlName": "Authentication" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

", - "smithy.api#xmlName": "SecurityGroupId" + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } } @@ -7352,14 +7542,6 @@ "smithy.api#xmlName": "dnsName" } }, - "Status": { - "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", - "smithy.api#xmlName": "status" - } - }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -7367,6 +7549,14 @@ "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", "smithy.api#xmlName": "clientVpnEndpointId" } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientVpnEndpointStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the Client VPN endpoint.

", + "smithy.api#xmlName": "status" + } } } }, @@ -7385,44 +7575,44 @@ "com.amazonaws.ec2#CreateClientVpnRouteRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, - "DestinationCidrBlock": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

\n\t\t \t\n\t\t

Route address ranges cannot overlap with the CIDR range specified for client allocation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A brief description of the route.

" } }, - "TargetVpcSubnetId": { - "target": "com.amazonaws.ec2#SubnetId", + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { - "smithy.api#documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.

", + "smithy.api#documentation": "

The ID of the Client VPN endpoint to which to add the route.

", "smithy.api#required": {} } }, - "Description": { + "DestinationCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A brief description of the route.

" + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

\n\t\t ", + "smithy.api#required": {} } }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "TargetVpcSubnetId": { + "target": "com.amazonaws.ec2#SubnetId", "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint to which to add the route.

", + "smithy.api#documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.

\n\t

Alternatively, if you're adding a route for the local network, specify local.

", "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} } } } @@ -7449,7 +7639,7 @@ "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" }, "traits": { - "smithy.api#documentation": "

Provides information to AWS about your VPN customer gateway device. The customer\n gateway is the appliance at your end of the VPN connection. (The device on the AWS side\n of the VPN connection is the virtual private gateway.) You must provide the\n Internet-routable IP address of the customer gateway's external interface. The IP\n address must be static and can be behind a device performing network address translation\n (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your\n network. If you don't have an ASN already, you can use a private ASN (in the 64512 -\n 65534 range).

\n \n

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the\n exception of 7224, which is reserved in the us-east-1 Region, and 9059,\n which is reserved in the eu-west-1 Region.

\n \n

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN\n User Guide.

\n \n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. Identical requests\n return information about the existing customer gateway and do not create new\n customer gateways.

\n " + "smithy.api#documentation": "

Provides information to AWS about your VPN customer gateway device. The customer\n gateway is the appliance at your end of the VPN connection. (The device on the AWS side\n of the VPN connection is the virtual private gateway.) You must provide the\n internet-routable IP address of the customer gateway's external interface. The IP\n address must be static and can be behind a device performing network address translation\n (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your\n network. If you don't have an ASN already, you can use a private ASN (in the 64512 -\n 65534 range).

\n \n

Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the\n exception of the following:

\n
    \n
  • \n

    7224 - reserved in the us-east-1 Region

    \n
    • \n
  • \n

    9059 - reserved in the eu-west-1 Region

    \n
    • \n
  • \n

    17943 - reserved in the ap-southeast-1 Region

    \n
    • \n
  • \n

    10124 - reserved in the ap-northeast-1 Region

    \n
    • \n
\n \n

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN\n User Guide.

\n \n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. Identical requests\n return information about the existing customer gateway and do not create new\n customer gateways.

\n " } }, "com.amazonaws.ec2#CreateCustomerGatewayRequest": { @@ -7462,13 +7652,6 @@ "smithy.api#xmlName": "IpAddress" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the customer gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -7477,11 +7660,10 @@ "smithy.api#xmlName": "dryRun" } }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", + "CertificateArn": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The type of VPN connection that this customer gateway supports (ipsec.1).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

" } }, "DeviceName": { @@ -7490,18 +7672,26 @@ "smithy.api#documentation": "

A name for the customer gateway device.

\n

Length Constraints: Up to 255 characters.

" } }, - "CertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

" - } - }, "BgpAsn": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

For devices that support BGP, the customer gateway's BGP ASN.

\n

Default: 65000

", "smithy.api#required": {} } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "smithy.api#documentation": "

The type of VPN connection that this customer gateway supports (ipsec.1).

", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the customer gateway.

", + "smithy.api#xmlName": "TagSpecification" + } } }, "traits": { @@ -7539,18 +7729,18 @@ "com.amazonaws.ec2#CreateDefaultSubnetRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The Availability Zone in which to create the default subnet.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -7618,13 +7808,12 @@ "com.amazonaws.ec2#CreateDhcpOptionsRequest": { "type": "structure", "members": { - "DhcpConfigurations": { - "target": "com.amazonaws.ec2#NewDhcpConfigurationList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "DhcpConfiguration", - "smithy.api#documentation": "

A DHCP configuration option.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "dhcpConfiguration" + "aws.protocols#ec2QueryName": "DryRun", + "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": { @@ -7634,12 +7823,13 @@ "smithy.api#xmlName": "TagSpecification" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "DhcpConfigurations": { + "target": "com.amazonaws.ec2#NewDhcpConfigurationList", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "aws.protocols#ec2QueryName": "DhcpConfiguration", + "smithy.api#documentation": "

A DHCP configuration option.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "dhcpConfiguration" } } } @@ -7672,6 +7862,19 @@ "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the egress-only internet gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { @@ -7684,33 +7887,12 @@ "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see How to Ensure\n\t\t\t\tIdempotency.

" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the egress-only internet gateway.

", - "smithy.api#xmlName": "TagSpecification" - } } } }, "com.amazonaws.ec2#CreateEgressOnlyInternetGatewayResult": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest.

", - "smithy.api#xmlName": "clientToken" - } - }, "EgressOnlyInternetGateway": { "target": "com.amazonaws.ec2#EgressOnlyInternetGateway", "traits": { @@ -7718,6 +7900,14 @@ "smithy.api#documentation": "

Information about the egress-only internet gateway.

", "smithy.api#xmlName": "egressOnlyInternetGateway" } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest.

", + "smithy.api#xmlName": "clientToken" + } } } }, @@ -7736,14 +7926,6 @@ "com.amazonaws.ec2#CreateFleetError": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ErrorMessage", - "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error Codes.

", - "smithy.api#xmlName": "errorMessage" - } - }, "Lifecycle": { "target": "com.amazonaws.ec2#InstanceLifecycle", "traits": { @@ -7752,14 +7934,6 @@ "smithy.api#xmlName": "lifecycle" } }, - "ErrorCode": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ErrorCode", - "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error Codes.

", - "smithy.api#xmlName": "errorCode" - } - }, "LaunchTemplateAndOverrides": { "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", "traits": { @@ -7767,6 +7941,22 @@ "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", "smithy.api#xmlName": "launchTemplateAndOverrides" } + }, + "ErrorMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorMessage", + "smithy.api#documentation": "

The error message that describes why the instance could not be launched. For more\n information about error messages, see Error Codes.

", + "smithy.api#xmlName": "errorMessage" + } + }, + "ErrorCode": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ErrorCode", + "smithy.api#documentation": "

The error code that indicates why the instance could not be launched. For more\n information about error codes, see Error Codes.

", + "smithy.api#xmlName": "errorCode" + } } }, "traits": { @@ -7785,6 +7975,14 @@ "com.amazonaws.ec2#CreateFleetInstance": { "type": "structure", "members": { + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", + "smithy.api#xmlName": "platform" + } + }, "Lifecycle": { "target": "com.amazonaws.ec2#InstanceLifecycle", "traits": { @@ -7793,14 +7991,6 @@ "smithy.api#xmlName": "lifecycle" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdsSet", "traits": { @@ -7817,12 +8007,12 @@ "smithy.api#xmlName": "launchTemplateAndOverrides" } }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", - "smithy.api#xmlName": "platform" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" } } }, @@ -7842,40 +8032,48 @@ "com.amazonaws.ec2#CreateFleetRequest": { "type": "structure", "members": { - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

" } }, - "SpotOptions": { - "target": "com.amazonaws.ec2#SpotOptionsRequest", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" + "smithy.api#documentation": "

The key-value pair for tagging the EC2 Fleet request on creation. The value for\n ResourceType must be fleet, otherwise the fleet request fails.\n To tag instances at launch, specify the tags in the launch\n template. For information about tagging after launch, see Tagging Your\n Resources.

", + "smithy.api#xmlName": "TagSpecification" } }, - "Type": { - "target": "com.amazonaws.ec2#FleetType", + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The type of the request. By default, the EC2 Fleet places an asynchronous request for your\n desired capacity, and maintains it by replenishing interrupted Spot Instances\n (maintain). A value of instant places a synchronous one-time\n request, and returns errors for any instances that could not be launched. A value of\n request places an asynchronous one-time request without maintaining\n capacity or submitting requests in alternative capacity pools if capacity is unavailable.\n For more information, see EC2 Fleet\n Request Types in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy instances.

" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "OnDemandOptions": { + "target": "com.amazonaws.ec2#OnDemandOptionsRequest", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

" + "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", "traits": { - "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#documentation": "

The number of units to request.

", + "smithy.api#required": {} } }, - "ReplaceUnhealthyInstances": { + "TerminateInstancesWithExpiration": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy instances.

" + "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

" } }, "LaunchTemplateConfigs": { @@ -7885,18 +8083,10 @@ "smithy.api#required": {} } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the EC2 Fleet request on creation. The value for\n ResourceType must be fleet, otherwise the fleet request fails.\n To tag instances at launch, specify the tags in the launch\n template. For information about tagging after launch, see Tagging Your\n Resources.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "TargetCapacitySpecification": { - "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotOptionsRequest", "traits": { - "smithy.api#documentation": "

The number of units to request.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Describes the configuration of Spot Instances in an EC2 Fleet.

" } }, "ExcessCapacityTerminationPolicy": { @@ -7905,22 +8095,22 @@ "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

" } }, - "OnDemandOptions": { - "target": "com.amazonaws.ec2#OnDemandOptionsRequest", + "Type": { + "target": "com.amazonaws.ec2#FleetType", "traits": { - "smithy.api#documentation": "

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + "smithy.api#documentation": "

The type of the request. By default, the EC2 Fleet places an asynchronous request for your\n desired capacity, and maintains it by replenishing interrupted Spot Instances\n (maintain). A value of instant places a synchronous one-time\n request, and returns errors for any instances that could not be launched. A value of\n request places an asynchronous one-time request without maintaining\n capacity or submitting requests in alternative capacity pools if capacity is unavailable.\n For more information, see EC2 Fleet\n Request Types in the Amazon Elastic Compute Cloud User Guide.

" } }, - "TerminateInstancesWithExpiration": { + "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

" + "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.

" } }, - "ValidUntil": { + "ValidFrom": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

" + "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

" } } } @@ -7928,6 +8118,14 @@ "com.amazonaws.ec2#CreateFleetResult": { "type": "structure", "members": { + "Instances": { + "target": "com.amazonaws.ec2#CreateFleetInstancesSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetInstanceSet", + "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

", + "smithy.api#xmlName": "fleetInstanceSet" + } + }, "Errors": { "target": "com.amazonaws.ec2#CreateFleetErrorsSet", "traits": { @@ -7943,14 +8141,6 @@ "smithy.api#documentation": "

The ID of the EC2 Fleet.

", "smithy.api#xmlName": "fleetId" } - }, - "Instances": { - "target": "com.amazonaws.ec2#CreateFleetInstancesSet", - "traits": { - "aws.protocols#ec2QueryName": "FleetInstanceSet", - "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

", - "smithy.api#xmlName": "fleetInstanceSet" - } } } }, @@ -7969,11 +8159,10 @@ "com.amazonaws.ec2#CreateFlowLogsRequest": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.ec2#FlowLogsResourceType", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The type of resource for which to create the flow log. For example, if you specified a VPC ID for \n the ResourceId property, specify VPC for this property.

", - "smithy.api#required": {} + "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.

" } }, "LogGroupName": { @@ -7982,10 +8171,11 @@ "smithy.api#documentation": "

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

\n

If you specify LogDestinationType as s3, do not specify \n DeliverLogsPermissionArn or LogGroupName.

" } }, - "LogFormat": { - "target": "com.amazonaws.ec2#String", + "ResourceType": { + "target": "com.amazonaws.ec2#FlowLogsResourceType", "traits": { - "smithy.api#documentation": "

The fields to include in the flow log record, in the order in which they should\n appear. For a list of available fields, see Flow Log Records. If you\n omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

\n

Specify the fields using the ${field-id} format, separated by spaces. For\n the AWS CLI, use single quotation marks (' ') to surround the parameter value.

" + "smithy.api#documentation": "

The type of resource for which to create the flow log. For example, if you specified a VPC ID for \n the ResourceId property, specify VPC for this property.

", + "smithy.api#required": {} } }, "LogDestination": { @@ -7994,31 +8184,17 @@ "smithy.api#documentation": "

Specifies the destination to which the flow log data is to be published. Flow log data can be published \n to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified\n for LogDestinationType.

\n

If LogDestinationType is not specified or cloud-watch-logs,\n specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish\n to a log group called my-logs, specify\n arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively,\n use LogGroupName instead.

\n

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a \n subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: \n bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a \n bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You \n cannot use AWSLogs as a subfolder name. This is a reserved term.

" } }, - "ResourceIds": { - "target": "com.amazonaws.ec2#FlowLogResourceIds", - "traits": { - "smithy.api#documentation": "

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

\n

Constraints: Maximum of 1000 resources

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ResourceId" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the flow logs.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "MaxAggregationInterval": { - "target": "com.amazonaws.ec2#Integer", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.

\n

Default: 600

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TrafficType": { + "target": "com.amazonaws.ec2#TrafficType", "traits": { - "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#documentation": "

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

", + "smithy.api#required": {} } }, "LogDestinationType": { @@ -8027,23 +8203,37 @@ "smithy.api#documentation": "

Specifies the type of destination to which the flow log data is to be published. Flow log data can be \n published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To \n publish flow log data to Amazon S3, specify s3.

\n

If you specify LogDestinationType as s3, do not specify \n DeliverLogsPermissionArn or LogGroupName.

\n

Default: cloud-watch-logs\n

" } }, + "LogFormat": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The fields to include in the flow log record, in the order in which they should\n appear. For a list of available fields, see Flow Log Records. If you\n omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

\n

Specify the fields using the ${field-id} format, separated by spaces. For\n the AWS CLI, use single quotation marks (' ') to surround the parameter value.

" + } + }, "DeliverLogsPermissionArn": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group \n in your account.

\n

If you specify LogDestinationType as s3, do not specify \n DeliverLogsPermissionArn or LogGroupName.

" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

" + "smithy.api#documentation": "

The tags to apply to the flow logs.

", + "smithy.api#xmlName": "TagSpecification" } }, - "TrafficType": { - "target": "com.amazonaws.ec2#TrafficType", + "ResourceIds": { + "target": "com.amazonaws.ec2#FlowLogResourceIds", "traits": { - "smithy.api#documentation": "

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

\n

Constraints: Maximum of 1000 resources

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ResourceId" + } + }, + "MaxAggregationInterval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.

\n

Default: 600

" } } } @@ -8051,12 +8241,12 @@ "com.amazonaws.ec2#CreateFlowLogsResult": { "type": "structure", "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#UnsuccessfulItemSet", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the flow logs that could not be created successfully.

", - "smithy.api#xmlName": "unsuccessful" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" } }, "FlowLogIds": { @@ -8067,12 +8257,12 @@ "smithy.api#xmlName": "flowLogIdSet" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "Unsuccessful": { + "target": "com.amazonaws.ec2#UnsuccessfulItemSet", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#xmlName": "clientToken" + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the flow logs that could not be created successfully.

", + "smithy.api#xmlName": "unsuccessful" } } } @@ -8099,22 +8289,17 @@ "smithy.api#required": {} } }, - "LogsStorageLocation": { - "target": "com.amazonaws.ec2#StorageLocation", - "traits": { - "smithy.api#documentation": "

The location in Amazon S3 for the output logs.

" - } - }, - "ClientToken": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring Idempotency.

" + "smithy.api#documentation": "

A description for the AFI.

" } }, - "Name": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

A name for the AFI.

" + "smithy.api#documentation": "

The tags to apply to the FPGA image during creation.

", + "smithy.api#xmlName": "TagSpecification" } }, "DryRun": { @@ -8123,17 +8308,22 @@ "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.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "Name": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The tags to apply to the FPGA image during creation.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

A name for the AFI.

" } }, - "Description": { + "LogsStorageLocation": { + "target": "com.amazonaws.ec2#StorageLocation", + "traits": { + "smithy.api#documentation": "

The location in Amazon S3 for the output logs.

" + } + }, + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A description for the AFI.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see Ensuring Idempotency.

" } } } @@ -8174,20 +8364,21 @@ "com.amazonaws.ec2#CreateImageRequest": { "type": "structure", "members": { - "NoReboot": { - "target": "com.amazonaws.ec2#Boolean", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NoReboot", - "smithy.api#documentation": "

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", - "smithy.api#xmlName": "noReboot" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the new image.

", + "smithy.api#xmlName": "description" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "Name": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

", - "smithy.api#xmlName": "blockDeviceMapping" + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

A name for the new image.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "name" } }, "InstanceId": { @@ -8207,21 +8398,20 @@ "smithy.api#xmlName": "dryRun" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the new image.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

", + "smithy.api#xmlName": "blockDeviceMapping" } }, - "Name": { - "target": "com.amazonaws.ec2#String", + "NoReboot": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

A name for the new image.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", - "smithy.api#required": {}, - "smithy.api#xmlName": "name" + "aws.protocols#ec2QueryName": "NoReboot", + "smithy.api#documentation": "

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "smithy.api#xmlName": "noReboot" } } } @@ -8254,14 +8444,6 @@ "com.amazonaws.ec2#CreateInstanceExportTaskRequest": { "type": "structure", "members": { - "TargetEnvironment": { - "target": "com.amazonaws.ec2#ExportEnvironment", - "traits": { - "aws.protocols#ec2QueryName": "TargetEnvironment", - "smithy.api#documentation": "

The target virtualization environment.

", - "smithy.api#xmlName": "targetEnvironment" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -8270,13 +8452,12 @@ "smithy.api#xmlName": "description" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "ExportToS3Task": { + "target": "com.amazonaws.ec2#ExportToS3TaskSpecification", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "ExportToS3", + "smithy.api#documentation": "

The format and location for an instance export task.

", + "smithy.api#xmlName": "exportToS3" } }, "TagSpecifications": { @@ -8286,12 +8467,21 @@ "smithy.api#xmlName": "TagSpecification" } }, - "ExportToS3Task": { - "target": "com.amazonaws.ec2#ExportToS3TaskSpecification", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "aws.protocols#ec2QueryName": "ExportToS3", - "smithy.api#documentation": "

The format and location for an instance export task.

", - "smithy.api#xmlName": "exportToS3" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "TargetEnvironment": { + "target": "com.amazonaws.ec2#ExportEnvironment", + "traits": { + "aws.protocols#ec2QueryName": "TargetEnvironment", + "smithy.api#documentation": "

The target virtualization environment.

", + "smithy.api#xmlName": "targetEnvironment" } } } @@ -8324,6 +8514,13 @@ "com.amazonaws.ec2#CreateInternetGatewayRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the internet gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -8331,13 +8528,6 @@ "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 internet gateway.

", - "smithy.api#xmlName": "TagSpecification" - } } } }, @@ -8369,6 +8559,14 @@ "com.amazonaws.ec2#CreateKeyPairRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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": { @@ -8382,14 +8580,6 @@ "smithy.api#documentation": "

A unique name for the key pair.

\n\t

Constraints: Up to 255 ASCII characters

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } } }, @@ -8408,24 +8598,16 @@ "com.amazonaws.ec2#CreateLaunchTemplateRequest": { "type": "structure", "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the launch template during creation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" } }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", "traits": { - "smithy.api#documentation": "

A name for the launch template.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the first version of the launch template.

" } }, "LaunchTemplateData": { @@ -8441,10 +8623,18 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } }, - "VersionDescription": { - "target": "com.amazonaws.ec2#VersionDescription", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

A description for the first version of the launch template.

" + "smithy.api#documentation": "

The tags to apply to the launch template during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

A name for the launch template.

", + "smithy.api#required": {} } } } @@ -8485,28 +8675,28 @@ "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + "smithy.api#documentation": "

A description for the version of the launch template.

" } }, - "SourceVersion": { - "target": "com.amazonaws.ec2#String", + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The version number of the launch template version on which to base the new version.\n The new version inherits the same launch parameters as the source version, except for\n parameters that you specify in LaunchTemplateData. Snapshots applied\n to the block device mapping are ignored when creating a new version unless they\n are explicitly included.

" + "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", + "SourceVersion": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" + "smithy.api#documentation": "

The version number of the launch template version on which to base the new version.\n The new version inherits the same launch parameters as the source version, except for\n parameters that you specify in LaunchTemplateData. Snapshots applied\n to the block device mapping are ignored when creating a new version unless they\n are explicitly included.

" } }, "LaunchTemplateData": { @@ -8516,16 +8706,16 @@ "smithy.api#required": {} } }, - "VersionDescription": { - "target": "com.amazonaws.ec2#VersionDescription", + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

A description for the version of the launch template.

" + "smithy.api#documentation": "

The name of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" } }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" } } } @@ -8533,21 +8723,21 @@ "com.amazonaws.ec2#CreateLaunchTemplateVersionResult": { "type": "structure", "members": { - "Warning": { - "target": "com.amazonaws.ec2#ValidationWarning", - "traits": { - "aws.protocols#ec2QueryName": "Warning", - "smithy.api#documentation": "

If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

", - "smithy.api#xmlName": "warning" - } - }, - "LaunchTemplateVersion": { - "target": "com.amazonaws.ec2#LaunchTemplateVersion", + "LaunchTemplateVersion": { + "target": "com.amazonaws.ec2#LaunchTemplateVersion", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplateVersion", "smithy.api#documentation": "

Information about the launch template version.

", "smithy.api#xmlName": "launchTemplateVersion" } + }, + "Warning": { + "target": "com.amazonaws.ec2#ValidationWarning", + "traits": { + "aws.protocols#ec2QueryName": "Warning", + "smithy.api#documentation": "

If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

", + "smithy.api#xmlName": "warning" + } } } }, @@ -8566,10 +8756,10 @@ "com.amazonaws.ec2#CreateLocalGatewayRouteRequest": { "type": "structure", "members": { - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on \n the most specific match.

", "smithy.api#required": {} } }, @@ -8586,10 +8776,10 @@ "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.

" } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", "traits": { - "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on \n the most specific match.

", + "smithy.api#documentation": "

The ID of the virtual interface group.

", "smithy.api#required": {} } } @@ -8623,23 +8813,16 @@ "com.amazonaws.ec2#CreateLocalGatewayRouteTableVpcAssociationRequest": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#required": {} } }, @@ -8649,6 +8832,13 @@ "smithy.api#documentation": "

The tags to assign to the local gateway route table VPC association.

", "smithy.api#xmlName": "TagSpecification" } + }, + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", + "traits": { + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#required": {} + } } } }, @@ -8687,13 +8877,6 @@ "smithy.api#required": {} } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraints: Up to 255 UTF-8 characters in length.

", - "smithy.api#idempotencyToken": {} - } - }, "Entries": { "target": "com.amazonaws.ec2#AddPrefixListEntries", "traits": { @@ -8701,6 +8884,12 @@ "smithy.api#xmlName": "Entry" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "MaxEntries": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -8708,6 +8897,13 @@ "smithy.api#required": {} } }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A name for the prefix list.

\n

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

", + "smithy.api#required": {} + } + }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -8715,17 +8911,11 @@ "smithy.api#xmlName": "TagSpecification" } }, - "PrefixListName": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A name for the prefix list.

\n

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

", - "smithy.api#required": {} - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraints: Up to 255 UTF-8 characters in length.

", + "smithy.api#idempotencyToken": {} } } } @@ -8758,6 +8948,13 @@ "com.amazonaws.ec2#CreateNatGatewayRequest": { "type": "structure", "members": { + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see How to Ensure\n\t\t\t\tIdempotency.

\n

Constraint: Maximum 64 ASCII characters.

", + "smithy.api#idempotencyToken": {} + } + }, "AllocationId": { "target": "com.amazonaws.ec2#AllocationId", "traits": { @@ -8765,13 +8962,6 @@ "smithy.api#required": {} } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the NAT gateway.

", - "smithy.api#xmlName": "TagSpecification" - } - }, "SubnetId": { "target": "com.amazonaws.ec2#SubnetId", "traits": { @@ -8779,17 +8969,17 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "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#documentation": "

The tags to assign to the NAT gateway.

", + "smithy.api#xmlName": "TagSpecification" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. For more information, see How to Ensure\n\t\t\t\tIdempotency.

\n

Constraint: Maximum 64 ASCII characters.

", - "smithy.api#idempotencyToken": {} + "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.

" } } } @@ -8839,36 +9029,47 @@ "com.amazonaws.ec2#CreateNetworkAclEntryRequest": { "type": "structure", "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n\t\t 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", - "smithy.api#xmlName": "cidrBlock" + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" } }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.\n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", - "smithy.api#xmlName": "portRange" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, - "RuleAction": { - "target": "com.amazonaws.ec2#RuleAction", + "Protocol": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n \t\t\tprotocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n\t\t\tallowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n\t\t\tprotocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n\t\t\tcodes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n\t\t\tand specify an IPv6 CIDR block, you must specify an ICMP type and code.

", "smithy.api#required": {}, - "smithy.api#xmlName": "ruleAction" + "smithy.api#xmlName": "protocol" } }, - "IcmpTypeCode": { - "target": "com.amazonaws.ec2#IcmpTypeCode", + "Egress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol \n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", - "smithy.api#xmlName": "Icmp" + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:db8:1234:1a00::/64).

", + "smithy.api#xmlName": "ipv6CidrBlock" } }, "NetworkAclId": { @@ -8880,47 +9081,36 @@ "smithy.api#xmlName": "networkAclId" } }, - "Protocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n \t\t\tprotocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n\t\t\tallowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n\t\t\tprotocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n\t\t\tcodes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n\t\t\tand specify an IPv6 CIDR block, you must specify an ICMP type and code.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "protocol" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol \n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" } }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", "smithy.api#required": {}, - "smithy.api#xmlName": "egress" + "smithy.api#xmlName": "ruleAction" } }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ruleNumber" + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.\n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "smithy.api#xmlName": "portRange" } }, - "Ipv6CidrBlock": { + "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:db8:1234:1a00::/64).

", - "smithy.api#xmlName": "ipv6CidrBlock" + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n\t\t 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#xmlName": "cidrBlock" } } } @@ -8928,6 +9118,13 @@ "com.amazonaws.ec2#CreateNetworkAclRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the network ACL.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -8944,13 +9141,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcId" } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the network ACL.

", - "smithy.api#xmlName": "TagSpecification" - } } } }, @@ -8994,12 +9184,6 @@ "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" - } - }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -9007,16 +9191,16 @@ "smithy.api#required": {} } }, - "AwsAccountId": { + "AwsService": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The AWS account ID.

" + "smithy.api#documentation": "

The AWS service. Currently not supported.

" } }, - "AwsService": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The AWS service. Currently not supported.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" } }, "Permission": { @@ -9025,6 +9209,12 @@ "smithy.api#documentation": "

The type of permission to grant.

", "smithy.api#required": {} } + }, + "AwsAccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The AWS account ID.

" + } } }, "traits": { @@ -9050,14 +9240,6 @@ "com.amazonaws.ec2#CreateNetworkInterfaceRequest": { "type": "structure", "members": { - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.\n You can't use this option if you're specifying a number of IPv6 addresses.

", - "smithy.api#xmlName": "ipv6Addresses" - } - }, "Groups": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { @@ -9065,6 +9247,30 @@ "smithy.api#xmlName": "SecurityGroupId" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

The number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -9073,13 +9279,12 @@ "smithy.api#xmlName": "description" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet to associate with the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.\n You can't use this option if you're specifying a number of IPv6 addresses.

", + "smithy.api#xmlName": "ipv6Addresses" } }, "PrivateIpAddresses": { @@ -9090,12 +9295,20 @@ "smithy.api#xmlName": "privateIpAddresses" } }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).

", - "smithy.api#xmlName": "privateIpAddress" + "smithy.api#documentation": "

The tags to apply to the new network interface.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet to associate with the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" } }, "InterfaceType": { @@ -9111,29 +9324,6 @@ "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range. You can't use this\n option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set\n to true, you can specify 0 to override this setting.

", "smithy.api#xmlName": "ipv6AddressCount" } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the new network interface.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

The number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" - } } }, "traits": { @@ -9179,6 +9369,20 @@ "smithy.api#xmlName": "groupName" } }, + "Strategy": { + "target": "com.amazonaws.ec2#PlacementStrategy", + "traits": { + "aws.protocols#ec2QueryName": "Strategy", + "smithy.api#documentation": "

The placement strategy.

", + "smithy.api#xmlName": "strategy" + } + }, + "PartitionCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of partitions. Valid only when Strategy is\n set to partition.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -9193,20 +9397,6 @@ "smithy.api#documentation": "

The tags to apply to the new placement group.

", "smithy.api#xmlName": "TagSpecification" } - }, - "Strategy": { - "target": "com.amazonaws.ec2#PlacementStrategy", - "traits": { - "aws.protocols#ec2QueryName": "Strategy", - "smithy.api#documentation": "

The placement strategy.

", - "smithy.api#xmlName": "strategy" - } - }, - "PartitionCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The number of partitions. Valid only when Strategy is\n set to partition.

" - } } } }, @@ -9237,15 +9427,6 @@ "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { "type": "structure", "members": { - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#ReservationId", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the active Standard Reserved Instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "reservedInstancesId" - } - }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -9255,13 +9436,13 @@ "smithy.api#xmlName": "clientToken" } }, - "PriceSchedules": { - "target": "com.amazonaws.ec2#PriceScheduleSpecificationList", + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#ReservationId", "traits": { - "aws.protocols#ec2QueryName": "PriceSchedules", - "smithy.api#documentation": "

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the active Standard Reserved Instance.

", "smithy.api#required": {}, - "smithy.api#xmlName": "priceSchedules" + "smithy.api#xmlName": "reservedInstancesId" } }, "InstanceCount": { @@ -9272,6 +9453,15 @@ "smithy.api#required": {}, "smithy.api#xmlName": "instanceCount" } + }, + "PriceSchedules": { + "target": "com.amazonaws.ec2#PriceScheduleSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PriceSchedules", + "smithy.api#documentation": "

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "priceSchedules" + } } }, "traits": { @@ -9309,26 +9499,20 @@ "com.amazonaws.ec2#CreateRouteRequest": { "type": "structure", "members": { - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of a VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of a network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" } }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the local gateway.

" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "smithy.api#xmlName": "instanceId" } }, "DestinationCidrBlock": { @@ -9345,12 +9529,21 @@ "smithy.api#documentation": "

The ID of a prefix list used for the destination match.

" } }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table for the route.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" } }, "GatewayId": { @@ -9369,43 +9562,46 @@ "smithy.api#xmlName": "dryRun" } }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#documentation": "

The ID of the route table for the route.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" } }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", "traits": { - "smithy.api#documentation": "

The ID of a transit gateway.

" + "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" } }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" } }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" + "smithy.api#documentation": "

The ID of the local gateway.

" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of a transit gateway.

" } } } @@ -9438,6 +9634,14 @@ "com.amazonaws.ec2#CreateRouteTableRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { @@ -9453,14 +9657,6 @@ "smithy.api#documentation": "

The tags to assign to the route table.

", "smithy.api#xmlName": "TagSpecification" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } } }, @@ -9492,19 +9688,12 @@ "com.amazonaws.ec2#CreateSecurityGroupRequest": { "type": "structure", "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the security group.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

A description for the security group. This is informational only.

\n\t\t

Constraints: Up to 255 characters in length

\n\t\t

Constraints for EC2-Classic: ASCII characters

\n\t\t

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", - "smithy.api#required": {}, - "smithy.api#xmlName": "GroupDescription" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "GroupName": { @@ -9520,12 +9709,19 @@ "smithy.api#documentation": "

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

A description for the security group. This is informational only.

\n\t\t

Constraints: Up to 255 characters in length

\n\t\t

Constraints for EC2-Classic: ASCII characters

\n\t\t

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#required": {}, + "smithy.api#xmlName": "GroupDescription" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the security group.

", + "smithy.api#xmlName": "TagSpecification" } } } @@ -9533,14 +9729,6 @@ "com.amazonaws.ec2#CreateSecurityGroupResult": { "type": "structure", "members": { - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -9548,6 +9736,14 @@ "smithy.api#documentation": "

The tags assigned to the security group.

", "smithy.api#xmlName": "tagSet" } + }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } } } }, @@ -9560,18 +9756,12 @@ "target": "com.amazonaws.ec2#Snapshot" }, "traits": { - "smithy.api#documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n backups, to make copies of EBS volumes, and to save data before shutting down an\n instance.

\n

When a snapshot is created, any AWS Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your EBS volume at the time the snapshot command is\n issued; this may exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.

\n

To create a snapshot for EBS volumes that serve as root devices, you should stop the\n instance before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.

\n

You can tag your snapshots during creation. For more information, see Tagging Your Amazon EC2\n Resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n backups, to make copies of EBS volumes, and to save data before shutting down an\n instance.

\n

When a snapshot is created, any AWS Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your EBS volume at the time the snapshot command is\n issued; this may exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.

\n

To create a snapshot for EBS volumes that serve as root devices, you should stop the\n instance before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.

\n

You can tag your snapshots during creation. For more information, see Tagging your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateSnapshotRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

A description for the snapshot.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -9593,6 +9783,12 @@ "smithy.api#documentation": "

The ID of the EBS volume.

", "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description for the snapshot.

" + } } } }, @@ -9611,16 +9807,16 @@ "com.amazonaws.ec2#CreateSnapshotsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

A description propagated to every snapshot specified by the instance.

" } }, - "CopyTagsFromSource": { - "target": "com.amazonaws.ec2#CopyTagsFromSource", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Copies the tags from the specified volume to corresponding snapshot.

" + "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.

" } }, "TagSpecifications": { @@ -9637,10 +9833,10 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "CopyTagsFromSource": { + "target": "com.amazonaws.ec2#CopyTagsFromSource", "traits": { - "smithy.api#documentation": "

A description propagated to every snapshot specified by the instance.

" + "smithy.api#documentation": "

Copies the tags from the specified volume to corresponding snapshot.

" } } } @@ -9673,12 +9869,12 @@ "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Prefix", - "smithy.api#documentation": "

A prefix for the data feed file names.

", - "smithy.api#xmlName": "prefix" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "Bucket": { @@ -9690,12 +9886,12 @@ "smithy.api#xmlName": "bucket" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Prefix": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "aws.protocols#ec2QueryName": "Prefix", + "smithy.api#documentation": "

A prefix for the data feed file names.

", + "smithy.api#xmlName": "prefix" } } }, @@ -9734,23 +9930,23 @@ "com.amazonaws.ec2#CreateSubnetRequest": { "type": "structure", "members": { - "Ipv6CidrBlock": { + "AvailabilityZoneId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.

" + "smithy.api#documentation": "

The AZ ID or the Local Zone ID of the subnet.

" } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Availability Zone or Local Zone for the subnet.

\n

Default: AWS selects one for you. If you create more than one subnet in your VPC, we \n do not necessarily select a different zone for each subnet.

\n

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example\n us-west-2-lax-1a. For information about the Regions that support Local Zones, \n see Available Regions in the Amazon Elastic Compute Cloud User Guide.

\n

To create a subnet in an Outpost, set this value to the Availability Zone for the\n Outpost and specify the Outpost ARN.

" } }, - "AvailabilityZoneId": { + "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The AZ ID or the Local Zone ID of the subnet.

" + "smithy.api#documentation": "

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#required": {} } }, "OutpostArn": { @@ -9759,24 +9955,17 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also\n specify the Availability Zone of the Outpost subnet.

" } }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#required": {} } }, - "AvailabilityZone": { + "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Availability Zone or Local Zone for the subnet.

\n

Default: AWS selects one for you. If you create more than one subnet in your VPC, we \n do not necessarily select a different zone for each subnet.

\n

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example\n us-west-2-lax-1a. For information about the Regions that support Local Zones, \n see Available Regions in the Amazon Elastic Compute Cloud User Guide.

\n

To create a subnet in an Outpost, set this value to the Availability Zone for the\n Outpost and specify the Outpost ARN.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the subnet.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.

" } }, "DryRun": { @@ -9786,6 +9975,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 subnet.

", + "smithy.api#xmlName": "TagSpecification" + } } } }, @@ -9822,14 +10018,6 @@ "smithy.api#xmlName": "ResourceId" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "smithy.api#documentation": "

The tags. The value parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty string.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "Tag" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -9837,6 +10025,14 @@ "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" } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "smithy.api#documentation": "

The tags. The value parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty string.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Tag" + } } } }, @@ -9855,10 +10051,11 @@ "com.amazonaws.ec2#CreateTrafficMirrorFilterRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "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#documentation": "

The tags to assign to a Traffic Mirror filter.

", + "smithy.api#xmlName": "TagSpecification" } }, "ClientToken": { @@ -9874,11 +10071,10 @@ "smithy.api#documentation": "

The description of the Traffic Mirror filter.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The tags to assign to a Traffic Mirror filter.

", - "smithy.api#xmlName": "TagSpecification" + "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.

" } } } @@ -9886,14 +10082,6 @@ "com.amazonaws.ec2#CreateTrafficMirrorFilterResult": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, "TrafficMirrorFilter": { "target": "com.amazonaws.ec2#TrafficMirrorFilter", "traits": { @@ -9901,6 +10089,14 @@ "smithy.api#documentation": "

Information about the Traffic Mirror filter.

", "smithy.api#xmlName": "trafficMirrorFilter" } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#xmlName": "clientToken" + } } } }, @@ -9919,19 +10115,27 @@ "com.amazonaws.ec2#CreateTrafficMirrorFilterRuleRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

", + "smithy.api#required": {} } }, - "SourceCidrBlock": { - "target": "com.amazonaws.ec2#String", + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", "traits": { - "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

", + "smithy.api#documentation": "

The ID of the filter that this rule is associated with.

", "smithy.api#required": {} } }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, "RuleAction": { "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", "traits": { @@ -9939,29 +10143,30 @@ "smithy.api#required": {} } }, - "Protocol": { - "target": "com.amazonaws.ec2#Integer", + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", "traits": { - "smithy.api#documentation": "

The protocol, for example UDP, to assign to the Traffic Mirror rule.

\n

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

" + "smithy.api#documentation": "

The source port range.

" } }, - "DestinationCidrBlock": { + "SourceCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

", + "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The description of the Traffic Mirror rule.

" + "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

", + "smithy.api#required": {} } }, - "DestinationPortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "Protocol": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The destination port range.

" + "smithy.api#documentation": "

The protocol, for example UDP, to assign to the Traffic Mirror rule.

\n

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

" } }, "TrafficDirection": { @@ -9971,31 +10176,22 @@ "smithy.api#required": {} } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "SourcePortRange": { + "DestinationPortRange": { "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", "traits": { - "smithy.api#documentation": "

The source port range.

" + "smithy.api#documentation": "

The destination port range.

" } }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

", - "smithy.api#required": {} + "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.

" } }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the filter that this rule is associated with.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the Traffic Mirror rule.

" } } } @@ -10036,10 +10232,11 @@ "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", "traits": { - "smithy.api#documentation": "

The description of the Traffic Mirror session.

" + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#required": {} } }, "ClientToken": { @@ -10049,18 +10246,18 @@ "smithy.api#idempotencyToken": {} } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", "traits": { - "smithy.api#documentation": "

The ID of the source network interface.

", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", "smithy.api#required": {} } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "

The tags to assign to a Traffic Mirror session.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The ID of the source network interface.

", + "smithy.api#required": {} } }, "DryRun": { @@ -10069,10 +10266,11 @@ "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.

" } }, - "VirtualNetworkId": { - "target": "com.amazonaws.ec2#Integer", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN\n protocol, see RFC 7348. If you do\n not specify a VirtualNetworkId, an account-wide unique id is chosen at\n random.

" + "smithy.api#documentation": "

The tags to assign to a Traffic Mirror session.

", + "smithy.api#xmlName": "TagSpecification" } }, "PacketLength": { @@ -10081,24 +10279,22 @@ "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.

\n

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

" } }, - "SessionNumber": { - "target": "com.amazonaws.ec2#Integer", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

\n

Valid values are 1-32766.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the Traffic Mirror session.

" } }, - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetId", + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN\n protocol, see RFC 7348. If you do\n not specify a VirtualNetworkId, an account-wide unique id is chosen at\n random.

" } }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "SessionNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#documentation": "

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

\n

Valid values are 1-32766.

", "smithy.api#required": {} } } @@ -10107,14 +10303,6 @@ "com.amazonaws.ec2#CreateTrafficMirrorSessionResult": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, "TrafficMirrorSession": { "target": "com.amazonaws.ec2#TrafficMirrorSession", "traits": { @@ -10122,6 +10310,14 @@ "smithy.api#documentation": "

Information about the Traffic Mirror session.

", "smithy.api#xmlName": "trafficMirrorSession" } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#xmlName": "clientToken" + } } } }, @@ -10146,10 +10342,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { - "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#documentation": "

The network interface ID that is associated with the target.

" } }, "Description": { @@ -10158,13 +10354,6 @@ "smithy.api#documentation": "

The description of the Traffic Mirror target.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the Traffic Mirror target.

", - "smithy.api#xmlName": "TagSpecification" - } - }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -10172,10 +10361,17 @@ "smithy.api#idempotencyToken": {} } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The network interface ID that is associated with the target.

" + "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.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Traffic Mirror target.

", + "smithy.api#xmlName": "TagSpecification" } } } @@ -10183,14 +10379,6 @@ "com.amazonaws.ec2#CreateTrafficMirrorTargetResult": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, "TrafficMirrorTarget": { "target": "com.amazonaws.ec2#TrafficMirrorTarget", "traits": { @@ -10198,6 +10386,14 @@ "smithy.api#documentation": "

Information about the Traffic Mirror target.

", "smithy.api#xmlName": "trafficMirrorTarget" } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#xmlName": "clientToken" + } } } }, @@ -10228,6 +10424,13 @@ "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest": { "type": "structure", "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -10240,13 +10443,6 @@ "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", "smithy.api#xmlName": "TagSpecification" } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } } } }, @@ -10278,10 +10474,10 @@ "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { "type": "structure", "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", + "PeerAccountId": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#documentation": "

The AWS account ID of the owner of the peer transit gateway.

", "smithy.api#required": {} } }, @@ -10299,24 +10495,24 @@ "smithy.api#xmlName": "TagSpecification" } }, - "PeerAccountId": { + "PeerRegion": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The AWS account ID of the owner of the peer transit gateway.

", + "smithy.api#documentation": "

The Region where the peer transit gateway is located.

", "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", "traits": { - "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#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} } }, - "PeerRegion": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The Region where the peer transit gateway is located.

", - "smithy.api#required": {} + "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.

" } } } @@ -10334,14 +10530,38 @@ } } }, - "com.amazonaws.ec2#CreateTransitGatewayRequest": { + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceRequest": { "type": "structure", "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The tags to apply to the transit gateway.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list that is used for destination matches.

", + "smithy.api#required": {} } }, "DryRun": { @@ -10350,16 +10570,54 @@ "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.

" } }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A description of the transit gateway.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the transit gateway.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "Options": { "target": "com.amazonaws.ec2#TransitGatewayRequestOptions", "traits": { "smithy.api#documentation": "

The transit gateway options.

" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

A description of the transit gateway.

" + "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.

" } } } @@ -10392,23 +10650,17 @@ "com.amazonaws.ec2#CreateTransitGatewayRouteRequest": { "type": "structure", "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { "smithy.api#documentation": "

The ID of the attachment.

" } }, - "Blackhole": { - "target": "com.amazonaws.ec2#Boolean", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on the\n most specific match.

", + "smithy.api#required": {} } }, "DryRun": { @@ -10417,10 +10669,16 @@ "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.

" } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The CIDR range used for destination matches. Routing decisions are based on the\n most specific match.

", + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table.

", "smithy.api#required": {} } } @@ -10454,13 +10712,6 @@ "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest": { "type": "structure", "members": { - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -10472,6 +10723,13 @@ "traits": { "smithy.api#documentation": "

The tags to apply to the transit gateway route table.

" } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } } } }, @@ -10503,23 +10761,29 @@ "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequest": { "type": "structure", "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to apply to the VPC attachment.

" } }, - "SubnetIds": { - "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. \n You must specify at least one subnet, but we recommend that you specify two subnets for better availability.\n The transit gateway uses one IP address from each specified subnet.

", + "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#required": {} } }, @@ -10529,16 +10793,10 @@ "smithy.api#documentation": "

The VPC attachment options.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the VPC attachment.

" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", + "SubnetIds": { + "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#documentation": "

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. \n You must specify at least one subnet, but we recommend that you specify two subnets for better availability.\n The transit gateway uses one IP address from each specified subnet.

", "smithy.api#required": {} } } @@ -10547,17 +10805,17 @@ "com.amazonaws.ec2#CreateTransitGatewayVpcAttachmentRequestOptions": { "type": "structure", "members": { - "Ipv6Support": { - "target": "com.amazonaws.ec2#Ipv6SupportValue", - "traits": { - "smithy.api#documentation": "

Enable or disable IPv6 support. The default is enable.

" - } - }, "DnsSupport": { "target": "com.amazonaws.ec2#DnsSupportValue", "traits": { "smithy.api#documentation": "

Enable or disable DNS support. The default is enable.

" } + }, + "Ipv6Support": { + "target": "com.amazonaws.ec2#Ipv6SupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable IPv6 support. The default is enable.

" + } } }, "traits": { @@ -10586,20 +10844,12 @@ "target": "com.amazonaws.ec2#Volume" }, "traits": { - "smithy.api#documentation": "

Creates an EBS volume that can be attached to an instance in the same Availability Zone.\n The volume is created in the regional endpoint that you send the HTTP request to. For more\n information see Regions and\n Endpoints.

\n

You can create a new empty volume or restore a volume from an EBS snapshot.\n Any AWS Marketplace product codes from the snapshot are propagated to the volume.

\n

You can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS Encryption\n in the Amazon Elastic Compute Cloud User Guide.

\n

You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2\n Resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Creating an Amazon EBS Volume in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an EBS volume that can be attached to an instance in the same Availability Zone.\n The volume is created in the regional endpoint that you send the HTTP request to. For more\n information see Regions and\n Endpoints.

\n

You can create a new empty volume or restore a volume from an EBS snapshot.\n Any AWS Marketplace product codes from the snapshot are propagated to the volume.

\n

You can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS Encryption\n in the Amazon Elastic Compute Cloud User Guide.

\n

You can tag your volumes during creation. For more information, see Tagging your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Creating an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateVolumePermission": { "type": "structure", "members": { - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The AWS account ID to be added or removed.

", - "smithy.api#xmlName": "userId" - } - }, "Group": { "target": "com.amazonaws.ec2#PermissionGroup", "traits": { @@ -10607,6 +10857,14 @@ "smithy.api#documentation": "

The group to be added or removed. The possible value is all.

", "smithy.api#xmlName": "group" } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The AWS account ID to be added or removed.

", + "smithy.api#xmlName": "userId" + } } }, "traits": { @@ -10625,16 +10883,16 @@ "com.amazonaws.ec2#CreateVolumePermissionModifications": { "type": "structure", "members": { - "Remove": { + "Add": { "target": "com.amazonaws.ec2#CreateVolumePermissionList", "traits": { - "smithy.api#documentation": "

Removes the specified AWS account ID or group from the list.

" + "smithy.api#documentation": "

Adds the specified AWS account ID or group to the list.

" } }, - "Add": { + "Remove": { "target": "com.amazonaws.ec2#CreateVolumePermissionList", "traits": { - "smithy.api#documentation": "

Adds the specified AWS account ID or group to the list.

" + "smithy.api#documentation": "

Removes the specified AWS account ID or group from the list.

" } } }, @@ -10645,24 +10903,35 @@ "com.amazonaws.ec2#CreateVolumeRequest": { "type": "structure", "members": { - "AvailabilityZone": { + "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create the volume.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" + } + }, + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n Nitro-based instances. Other instance families guarantee performance up to\n 32,000 IOPS. For more information, see Amazon EBS volume types in the\n Amazon Elastic Compute Cloud User Guide.

\n

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

" } }, "VolumeType": { "target": "com.amazonaws.ec2#VolumeType", "traits": { - "smithy.api#documentation": "

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD,\n st1 for Throughput Optimized HDD, sc1 for Cold HDD, or\n standard for Magnetic volumes.

\n

Default: gp2\n

" + "smithy.api#documentation": "

The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,\n st1 for Throughput Optimized HDD, sc1 for Cold HDD, or\n standard for Magnetic volumes.

\n

Default: gp2\n

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", "traits": { - "smithy.api#documentation": "

The tags to apply to the volume during creation.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create the volume.

", + "smithy.api#required": {} } }, "KmsKeyId": { @@ -10671,23 +10940,30 @@ "smithy.api#documentation": "

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.\n If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the CMK using any of the following:

\n \n

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

" } }, - "Iops": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the volume during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "Size": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum\n ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for\n volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n Nitro-based instances. Other instance families guarantee performance up to\n 32,000 IOPS. For more information, see Amazon EBS Volume Types in the\n Amazon Elastic Compute Cloud User Guide.

\n

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

" + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

\n

Constraints: 1-16,384 for gp2,\n 4-16,384 for io1 and io2, 500-16,384 for\n st1, 500-16,384 for sc1, and\n 1-1,024 for standard. If you specify a\n snapshot, the volume size must be equal to or larger than the snapshot size.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size,\n the default is the snapshot size.

" } }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", + "MultiAttachEnabled": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" + "smithy.api#documentation": "

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n \tvolume to up to 16 Nitro-based instances in the same Availability Zone. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" } }, "Encrypted": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Specifies whether the volume should be encrypted. \n The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. \n For more information, see Encryption by Default\n in the Amazon Elastic Compute Cloud User Guide.

\n

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. \n For more information, see Supported\n Instance Types.

", + "smithy.api#documentation": "

Specifies whether the volume should be encrypted. \n The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. \n For more information, see Encryption by default\n in the Amazon Elastic Compute Cloud User Guide.

\n

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. \n For more information, see Supported\n instance types.

", "smithy.api#xmlName": "encrypted" } }, @@ -10698,24 +10974,6 @@ "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" } - }, - "MultiAttachEnabled": { - "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 \tvolume to up to 16 Nitro-based instances in the same Availability Zone. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

" - } - }, - "Size": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

\n

Constraints: 1-16,384 for gp2,\n 4-16,384 for io1, 500-16,384 for\n st1, 500-16,384 for sc1, and\n 1-1,024 for standard. If you specify a\n snapshot, the volume size must be equal to or larger than the snapshot size.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size,\n the default is the snapshot size.

" - } } } }, @@ -10758,12 +11016,6 @@ "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest": { "type": "structure", "members": { - "VpcEndpointId": { - "target": "com.amazonaws.ec2#VpcEndpointId", - "traits": { - "smithy.api#documentation": "

The ID of the endpoint.

" - } - }, "ConnectionNotificationArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -10771,17 +11023,16 @@ "smithy.api#required": {} } }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the endpoint service.

" + "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.

" } }, - "ConnectionEvents": { - "target": "com.amazonaws.ec2#ValueStringList", + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", "traits": { - "smithy.api#documentation": "

One or more endpoint events for which to receive notifications. Valid values are\n Accept, Connect, Delete, and\n Reject.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the endpoint service.

" } }, "ClientToken": { @@ -10790,10 +11041,17 @@ "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", "traits": { - "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#documentation": "

The ID of the endpoint.

" + } + }, + "ConnectionEvents": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more endpoint events for which to receive notifications. Valid values are\n Accept, Connect, Delete, and\n Reject.

", + "smithy.api#required": {} } } } @@ -10836,36 +11094,42 @@ "smithy.api#xmlName": "SecurityGroupId" } }, - "ServiceName": { - "target": "com.amazonaws.ec2#String", + "VpcEndpointType": { + "target": "com.amazonaws.ec2#VpcEndpointType", "traits": { - "smithy.api#documentation": "

The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service\n provider.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The type of endpoint.

\n

Default: Gateway

" } }, - "ClientToken": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, + "PolicyDocument": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

" + "smithy.api#documentation": "

A policy to attach to the endpoint that controls access to the\n service. The policy must be in valid JSON format. If this parameter is not specified, we\n attach a default policy that allows full access to the service.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ServiceName": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service\n provider.

", + "smithy.api#required": {} } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The tags to associate with the endpoint.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.

\n

To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.

\n

Default: true\n

" } }, - "VpcEndpointType": { - "target": "com.amazonaws.ec2#VpcEndpointType", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

The type of endpoint.

\n

Default: Gateway

" + "smithy.api#documentation": "

The ID of the VPC in which the endpoint will be used.

", + "smithy.api#required": {} } }, "RouteTableIds": { @@ -10875,23 +11139,17 @@ "smithy.api#xmlName": "RouteTableId" } }, - "PolicyDocument": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A policy to attach to the endpoint that controls access to the\n service. The policy must be in valid JSON format. If this parameter is not specified, we\n attach a default policy that allows full access to the service.

" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC in which the endpoint will be used.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

" } }, - "PrivateDnsEnabled": { - "target": "com.amazonaws.ec2#Boolean", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.

\n

To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.

\n

Default: true\n

" + "smithy.api#documentation": "

The tags to associate with the endpoint.

", + "smithy.api#xmlName": "TagSpecification" } } }, @@ -10902,14 +11160,6 @@ "com.amazonaws.ec2#CreateVpcEndpointResult": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#xmlName": "clientToken" - } - }, "VpcEndpoint": { "target": "com.amazonaws.ec2#VpcEndpoint", "traits": { @@ -10917,6 +11167,14 @@ "smithy.api#documentation": "

Information about the endpoint.

", "smithy.api#xmlName": "vpcEndpoint" } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } } }, "traits": { @@ -10938,43 +11196,43 @@ "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { "type": "structure", "members": { - "NetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your\n service.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "NetworkLoadBalancerArn" + "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.

" } }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The private DNS name to assign to the VPC endpoint service.

" + "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted. To accept a request, use AcceptVpcEndpointConnections.

" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n For more information, see How to Ensure\n Idempotency.

" + "smithy.api#documentation": "

The tags to associate with the service.

", + "smithy.api#xmlName": "TagSpecification" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The private DNS name to assign to the VPC endpoint service.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "smithy.api#documentation": "

The tags to associate with the service.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your\n service.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "NetworkLoadBalancerArn" } }, - "AcceptanceRequired": { - "target": "com.amazonaws.ec2#Boolean", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted. To accept a request, use AcceptVpcEndpointConnections.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\n For more information, see How to Ensure\n Idempotency.

" } } } @@ -10982,14 +11240,6 @@ "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#xmlName": "clientToken" - } - }, "ServiceConfiguration": { "target": "com.amazonaws.ec2#ServiceConfiguration", "traits": { @@ -10997,6 +11247,14 @@ "smithy.api#documentation": "

Information about the service configuration.

", "smithy.api#xmlName": "serviceConfiguration" } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#xmlName": "clientToken" + } } } }, @@ -11029,6 +11287,14 @@ "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n\t\t

Default: The Region in which you make the request.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "PeerOwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -11037,13 +11303,6 @@ "smithy.api#xmlName": "peerOwnerId" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the peering connection.

", - "smithy.api#xmlName": "TagSpecification" - } - }, "PeerVpcId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -11052,12 +11311,11 @@ "smithy.api#xmlName": "peerVpcId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

The tags to assign to the peering connection.

", + "smithy.api#xmlName": "TagSpecification" } } } @@ -11078,11 +11336,12 @@ "com.amazonaws.ec2#CreateVpcRequest": { "type": "structure", "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "smithy.api#documentation": "

The tags to assign to the VPC.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy options for instances launched into the VPC. For default, instances\n are launched with shared tenancy by default. You can launch instances with any tenancy into a\n shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy\n instances by default. You can only launch instances with a tenancy of dedicated\n or host into a dedicated tenancy VPC.

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", + "smithy.api#xmlName": "instanceTenancy" } }, "DryRun": { @@ -11093,19 +11352,18 @@ "smithy.api#xmlName": "dryRun" } }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", + "AmazonProvidedIpv6CidrBlock": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", - "smithy.api#required": {} + "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", + "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.\n You cannot specify the range of IP addresses, or the size of the CIDR block.

", + "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" } }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy options for instances launched into the VPC. For default, instances\n are launched with shared tenancy by default. You can launch instances with any tenancy into a\n shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy\n instances by default. You can only launch instances with a tenancy of dedicated\n or host into a dedicated tenancy VPC.

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", - "smithy.api#xmlName": "instanceTenancy" + "smithy.api#documentation": "

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" } }, "Ipv6CidrBlockNetworkBorderGroup": { @@ -11114,24 +11372,24 @@ "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

" } }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", + "Ipv6Pool": { + "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", "traits": { - "smithy.api#documentation": "

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" } }, - "AmazonProvidedIpv6CidrBlock": { - "target": "com.amazonaws.ec2#Boolean", + "CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", - "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.\n You cannot specify the range of IP addresses, or the size of the CIDR block.

", - "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" + "smithy.api#documentation": "

The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#required": {} } }, - "Ipv6Pool": { - "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

" + "smithy.api#documentation": "

The tags to assign to the VPC.

", + "smithy.api#xmlName": "TagSpecification" } } } @@ -11158,19 +11416,12 @@ "target": "com.amazonaws.ec2#CreateVpnConnectionResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPN connection between an existing virtual private gateway and a VPN\n customer gateway. The supported connection type is ipsec.1.

\n

The response includes information that you need to give to your network administrator\n to configure your customer gateway.

\n \n

We strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway.

\n \n

If you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.

\n

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN\n User Guide.

" + "smithy.api#documentation": "

Creates a VPN connection between an existing virtual private gateway or transit gateway and a\n customer gateway. The supported connection type is ipsec.1.

\n

The response includes information that you need to give to your network administrator\n to configure your customer gateway.

\n \n

We strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.

\n \n

If you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.

\n

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN\n User Guide.

" } }, "com.amazonaws.ec2#CreateVpnConnectionRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The type of VPN connection (ipsec.1).

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -11179,12 +11430,16 @@ "smithy.api#xmlName": "dryRun" } }, - "Options": { - "target": "com.amazonaws.ec2#VpnConnectionOptionsSpecification", + "VpnGatewayId": { + "target": "com.amazonaws.ec2#VpnGatewayId", "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The options for the VPN connection.

", - "smithy.api#xmlName": "options" + "smithy.api#documentation": "

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

" } }, "CustomerGatewayId": { @@ -11201,16 +11456,19 @@ "smithy.api#xmlName": "TagSpecification" } }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#VpnGatewayId", + "Type": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

" + "smithy.api#documentation": "

The type of VPN connection (ipsec.1).

", + "smithy.api#required": {} } }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", + "Options": { + "target": "com.amazonaws.ec2#VpnConnectionOptionsSpecification", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

" + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The options for the VPN connection.

", + "smithy.api#xmlName": "options" } } }, @@ -11246,17 +11504,17 @@ "com.amazonaws.ec2#CreateVpnConnectionRouteRequest": { "type": "structure", "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", "smithy.api#required": {} } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", "traits": { - "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", + "smithy.api#documentation": "

The ID of the VPN connection.

", "smithy.api#required": {} } } @@ -11280,17 +11538,19 @@ "com.amazonaws.ec2#CreateVpnGatewayRequest": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The Availability Zone for the virtual private gateway.

" + "aws.protocols#ec2QueryName": "DryRun", + "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", + "Type": { + "target": "com.amazonaws.ec2#GatewayType", "traits": { - "smithy.api#documentation": "

The tags to apply to the virtual private gateway.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The type of VPN connection this virtual private gateway supports.

", + "smithy.api#required": {} } }, "AmazonSideAsn": { @@ -11299,19 +11559,17 @@ "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

\n\t\t

Default: 64512

" } }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The type of VPN connection this virtual private gateway supports.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Availability Zone for the virtual private gateway.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

The tags to apply to the virtual private gateway.

", + "smithy.api#xmlName": "TagSpecification" } } }, @@ -11385,12 +11643,12 @@ "com.amazonaws.ec2#CustomerGateway": { "type": "structure", "members": { - "IpAddress": { + "CustomerGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The Internet-routable IP address of the customer gateway's outside interface.

", - "smithy.api#xmlName": "ipAddress" + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#xmlName": "customerGatewayId" } }, "State": { @@ -11401,20 +11659,20 @@ "smithy.api#xmlName": "state" } }, - "CustomerGatewayId": { + "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayId", - "smithy.api#documentation": "

The ID of the customer gateway.

", - "smithy.api#xmlName": "customerGatewayId" + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The name of customer gateway device.

", + "smithy.api#xmlName": "deviceName" } }, - "CertificateArn": { + "BgpAsn": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CertificateArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

", - "smithy.api#xmlName": "certificateArn" + "aws.protocols#ec2QueryName": "BgpAsn", + "smithy.api#documentation": "

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "smithy.api#xmlName": "bgpAsn" } }, "Type": { @@ -11433,20 +11691,20 @@ "smithy.api#xmlName": "tagSet" } }, - "BgpAsn": { + "CertificateArn": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "BgpAsn", - "smithy.api#documentation": "

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", - "smithy.api#xmlName": "bgpAsn" + "aws.protocols#ec2QueryName": "CertificateArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

", + "smithy.api#xmlName": "certificateArn" } }, - "DeviceName": { + "IpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The name of customer gateway device.

", - "smithy.api#xmlName": "deviceName" + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

The Internet-routable IP address of the customer gateway's outside interface.

", + "smithy.api#xmlName": "ipAddress" } } }, @@ -11564,6 +11822,49 @@ "com.amazonaws.ec2#DefaultingDhcpOptionsId": { "type": "string" }, + "com.amazonaws.ec2#DeleteCarrierGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteCarrierGatewayRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteCarrierGatewayResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a carrier gateway.

\n \n

If you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.

\n " + } + }, + "com.amazonaws.ec2#DeleteCarrierGatewayRequest": { + "type": "structure", + "members": { + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + } + } + }, + "com.amazonaws.ec2#DeleteCarrierGatewayResult": { + "type": "structure", + "members": { + "CarrierGateway": { + "target": "com.amazonaws.ec2#CarrierGateway", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGateway", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGateway" + } + } + } + }, "com.amazonaws.ec2#DeleteClientVpnEndpoint": { "type": "operation", "input": { @@ -11579,18 +11880,18 @@ "com.amazonaws.ec2#DeleteClientVpnEndpointRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { "smithy.api#documentation": "

The ID of the Client VPN to be deleted.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } } } }, @@ -11628,10 +11929,10 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route to be deleted.

", + "smithy.api#documentation": "

The ID of the Client VPN endpoint from which the route is to be deleted.

", "smithy.api#required": {} } }, @@ -11641,10 +11942,10 @@ "smithy.api#documentation": "

The ID of the target subnet used by the route.

" } }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint from which the route is to be deleted.

", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route to be deleted.

", "smithy.api#required": {} } } @@ -11739,18 +12040,18 @@ "com.amazonaws.ec2#DeleteEgressOnlyInternetGatewayRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "EgressOnlyInternetGatewayId": { "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", "traits": { "smithy.api#documentation": "

The ID of the egress-only internet gateway.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -11770,14 +12071,6 @@ "com.amazonaws.ec2#DeleteFleetError": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#DeleteFleetErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -11785,6 +12078,14 @@ "smithy.api#documentation": "

The description for the error code.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#DeleteFleetErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -11850,6 +12151,14 @@ "com.amazonaws.ec2#DeleteFleetSuccessItem": { "type": "structure", "members": { + "PreviousFleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", + "traits": { + "aws.protocols#ec2QueryName": "PreviousFleetState", + "smithy.api#documentation": "

The previous state of the EC2 Fleet.

", + "smithy.api#xmlName": "previousFleetState" + } + }, "FleetId": { "target": "com.amazonaws.ec2#FleetId", "traits": { @@ -11865,14 +12174,6 @@ "smithy.api#documentation": "

The current state of the EC2 Fleet.

", "smithy.api#xmlName": "currentFleetState" } - }, - "PreviousFleetState": { - "target": "com.amazonaws.ec2#FleetStateCode", - "traits": { - "aws.protocols#ec2QueryName": "PreviousFleetState", - "smithy.api#documentation": "

The previous state of the EC2 Fleet.

", - "smithy.api#xmlName": "previousFleetState" - } } }, "traits": { @@ -11903,6 +12204,13 @@ "com.amazonaws.ec2#DeleteFleetsRequest": { "type": "structure", "members": { + "TerminateInstances": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to terminate instances for an EC2 Fleet if it is deleted\n successfully.

", + "smithy.api#required": {} + } + }, "FleetIds": { "target": "com.amazonaws.ec2#FleetIdSet", "traits": { @@ -11911,13 +12219,6 @@ "smithy.api#xmlName": "FleetId" } }, - "TerminateInstances": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether to terminate instances for an EC2 Fleet if it is deleted\n successfully.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -12006,18 +12307,18 @@ "com.amazonaws.ec2#DeleteFpgaImageRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "FpgaImageId": { "target": "com.amazonaws.ec2#FpgaImageId", "traits": { "smithy.api#documentation": "

The ID of the AFI.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -12120,17 +12421,17 @@ "smithy.api#documentation": "

The name of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" } }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" + } } } }, @@ -12162,18 +12463,18 @@ "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest": { "type": "structure", "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" + } + }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { @@ -12193,14 +12494,6 @@ "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorItem": { "type": "structure", "members": { - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, "VersionNumber": { "target": "com.amazonaws.ec2#Long", "traits": { @@ -12209,12 +12502,12 @@ "smithy.api#xmlName": "versionNumber" } }, - "ResponseError": { - "target": "com.amazonaws.ec2#ResponseError", + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ResponseError", - "smithy.api#documentation": "

Information about the error.

", - "smithy.api#xmlName": "responseError" + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" } }, "LaunchTemplateId": { @@ -12224,6 +12517,14 @@ "smithy.api#documentation": "

The ID of the launch template.

", "smithy.api#xmlName": "launchTemplateId" } + }, + "ResponseError": { + "target": "com.amazonaws.ec2#ResponseError", + "traits": { + "aws.protocols#ec2QueryName": "ResponseError", + "smithy.api#documentation": "

Information about the error.

", + "smithy.api#xmlName": "responseError" + } } }, "traits": { @@ -12242,6 +12543,14 @@ "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessItem": { "type": "structure", "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" + } + }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -12257,14 +12566,6 @@ "smithy.api#documentation": "

The version number of the launch template.

", "smithy.api#xmlName": "versionNumber" } - }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

", - "smithy.api#xmlName": "launchTemplateId" - } } }, "traits": { @@ -12283,14 +12584,6 @@ "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult": { "type": "structure", "members": { - "UnsuccessfullyDeletedLaunchTemplateVersions": { - "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "UnsuccessfullyDeletedLaunchTemplateVersionSet", - "smithy.api#documentation": "

Information about the launch template versions that could not be deleted.

", - "smithy.api#xmlName": "unsuccessfullyDeletedLaunchTemplateVersionSet" - } - }, "SuccessfullyDeletedLaunchTemplateVersions": { "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseSuccessSet", "traits": { @@ -12298,6 +12591,14 @@ "smithy.api#documentation": "

Information about the launch template versions that were successfully\n deleted.

", "smithy.api#xmlName": "successfullyDeletedLaunchTemplateVersionSet" } + }, + "UnsuccessfullyDeletedLaunchTemplateVersions": { + "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResponseErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "UnsuccessfullyDeletedLaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions that could not be deleted.

", + "smithy.api#xmlName": "unsuccessfullyDeletedLaunchTemplateVersionSet" + } } } }, @@ -12409,18 +12710,18 @@ "com.amazonaws.ec2#DeleteManagedPrefixListRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "PrefixListId": { "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { "smithy.api#documentation": "

The ID of the prefix list.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -12452,12 +12753,6 @@ "com.amazonaws.ec2#DeleteNatGatewayRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "NatGatewayId": { "target": "com.amazonaws.ec2#NatGatewayId", "traits": { @@ -12465,6 +12760,12 @@ "smithy.api#required": {}, "smithy.api#xmlName": "NatGatewayId" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -12502,15 +12803,6 @@ "com.amazonaws.ec2#DeleteNetworkAclEntryRequest": { "type": "structure", "members": { - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#documentation": "

The ID of the network ACL.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } - }, "Egress": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -12520,6 +12812,15 @@ "smithy.api#xmlName": "egress" } }, + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -12585,11 +12886,10 @@ "com.amazonaws.ec2#DeleteNetworkInterfacePermissionRequest": { "type": "structure", "members": { - "NetworkInterfacePermissionId": { - "target": "com.amazonaws.ec2#NetworkInterfacePermissionId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the network interface permission.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" } }, "Force": { @@ -12598,10 +12898,11 @@ "smithy.api#documentation": "

Specify true to remove the permission even if the network interface is\n\t\t\tattached to an instance.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "NetworkInterfacePermissionId": { + "target": "com.amazonaws.ec2#NetworkInterfacePermissionId", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

The ID of the network interface permission.

", + "smithy.api#required": {} } } }, @@ -12628,14 +12929,6 @@ "com.amazonaws.ec2#DeleteNetworkInterfaceRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -12644,6 +12937,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "networkInterfaceId" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } }, "traits": { @@ -12662,6 +12963,14 @@ "com.amazonaws.ec2#DeletePlacementGroupRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "GroupName": { "target": "com.amazonaws.ec2#PlacementGroupName", "traits": { @@ -12670,14 +12979,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "groupName" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } } }, @@ -12773,14 +13074,6 @@ "com.amazonaws.ec2#DeleteQueuedReservedInstancesResult": { "type": "structure", "members": { - "SuccessfulQueuedPurchaseDeletions": { - "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet", - "traits": { - "aws.protocols#ec2QueryName": "SuccessfulQueuedPurchaseDeletionSet", - "smithy.api#documentation": "

Information about the queued purchases that were successfully deleted.

", - "smithy.api#xmlName": "successfulQueuedPurchaseDeletionSet" - } - }, "FailedQueuedPurchaseDeletions": { "target": "com.amazonaws.ec2#FailedQueuedPurchaseDeletionSet", "traits": { @@ -12788,6 +13081,14 @@ "smithy.api#documentation": "

Information about the queued purchases that could not be deleted.

", "smithy.api#xmlName": "failedQueuedPurchaseDeletionSet" } + }, + "SuccessfulQueuedPurchaseDeletions": { + "target": "com.amazonaws.ec2#SuccessfulQueuedPurchaseDeletionSet", + "traits": { + "aws.protocols#ec2QueryName": "SuccessfulQueuedPurchaseDeletionSet", + "smithy.api#documentation": "

Information about the queued purchases that were successfully deleted.

", + "smithy.api#xmlName": "successfulQueuedPurchaseDeletionSet" + } } } }, @@ -12803,12 +13104,18 @@ "com.amazonaws.ec2#DeleteRouteRequest": { "type": "structure", "members": { - "DestinationIpv6CidrBlock": { + "DestinationCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list for the route.

" } }, "DryRun": { @@ -12819,14 +13126,6 @@ "smithy.api#xmlName": "dryRun" } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, "RouteTableId": { "target": "com.amazonaws.ec2#RouteTableId", "traits": { @@ -12836,10 +13135,12 @@ "smithy.api#xmlName": "routeTableId" } }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the prefix list for the route.

" + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" } } } @@ -12856,6 +13157,14 @@ "com.amazonaws.ec2#DeleteRouteTableRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "RouteTableId": { "target": "com.amazonaws.ec2#RouteTableId", "traits": { @@ -12864,14 +13173,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "routeTableId" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } } }, @@ -12887,12 +13188,6 @@ "com.amazonaws.ec2#DeleteSecurityGroupRequest": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -12901,6 +13196,12 @@ "smithy.api#xmlName": "dryRun" } }, + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + } + }, "GroupId": { "target": "com.amazonaws.ec2#SecurityGroupId", "traits": { @@ -12915,12 +13216,19 @@ "target": "com.amazonaws.ec2#DeleteSnapshotRequest" }, "traits": { - "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Deleting an Amazon EBS Snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Deleting an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#DeleteSnapshotRequest": { "type": "structure", "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -12928,13 +13236,6 @@ "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" } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the EBS snapshot.

", - "smithy.api#required": {} - } } } }, @@ -13089,18 +13390,18 @@ "com.amazonaws.ec2#DeleteTrafficMirrorFilterRuleRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TrafficMirrorFilterRuleId": { "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleId", "traits": { "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -13132,18 +13433,18 @@ "com.amazonaws.ec2#DeleteTrafficMirrorSessionRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TrafficMirrorSessionId": { "target": "com.amazonaws.ec2#TrafficMirrorSessionId", "traits": { "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -13175,18 +13476,18 @@ "com.amazonaws.ec2#DeleteTrafficMirrorTargetRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TrafficMirrorTargetId": { "target": "com.amazonaws.ec2#TrafficMirrorTargetId", "traits": { "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -13301,6 +13602,56 @@ } } }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceRequest": { + "type": "structure", + "members": { + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + } + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the deleted prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + } + }, "com.amazonaws.ec2#DeleteTransitGatewayRequest": { "type": "structure", "members": { @@ -13347,6 +13698,13 @@ "com.amazonaws.ec2#DeleteTransitGatewayRouteRequest": { "type": "structure", "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, "DestinationCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { @@ -13359,13 +13717,6 @@ "traits": { "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.

" } - }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } } } }, @@ -13397,18 +13748,18 @@ "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { "smithy.api#documentation": "

The ID of the transit gateway route table.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -13440,18 +13791,18 @@ "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachmentRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { "smithy.api#documentation": "

The ID of the attachment.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -13474,19 +13825,12 @@ "target": "com.amazonaws.ec2#DeleteVolumeRequest" }, "traits": { - "smithy.api#documentation": "

Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).

\n

The volume can remain in the deleting state for several minutes.

\n

For more information, see Deleting an Amazon EBS Volume in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).

\n

The volume can remain in the deleting state for several minutes.

\n

For more information, see Deleting an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#DeleteVolumeRequest": { "type": "structure", "members": { - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -13494,6 +13838,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" } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} + } } } }, @@ -13723,13 +14074,6 @@ "com.amazonaws.ec2#DeleteVpnConnectionRequest": { "type": "structure", "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", - "traits": { - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -13737,6 +14081,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" } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } } }, "traits": { @@ -13755,17 +14106,17 @@ "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest": { "type": "structure", "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", "smithy.api#required": {} } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", "traits": { - "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer network.

", + "smithy.api#documentation": "

The ID of the VPN connection.

", "smithy.api#required": {} } } @@ -13821,18 +14172,18 @@ "com.amazonaws.ec2#DeprovisionByoipCidrRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "Cidr": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The address range, in CIDR notation. The prefix must be the same prefix \n that you specified when you provisioned the address range.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -13861,13 +14212,6 @@ "com.amazonaws.ec2#DeregisterImageRequest": { "type": "structure", "members": { - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -13875,6 +14219,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" } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } } }, "traits": { @@ -13896,17 +14247,17 @@ "com.amazonaws.ec2#DeregisterInstanceEventNotificationAttributesRequest": { "type": "structure", "members": { - "InstanceTagAttribute": { - "target": "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest", - "traits": { - "smithy.api#documentation": "

Information about the tag keys to deregister.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } + }, + "InstanceTagAttribute": { + "target": "com.amazonaws.ec2#DeregisterInstanceTagAttributeRequest", + "traits": { + "smithy.api#documentation": "

Information about the tag keys to deregister.

" + } } } }, @@ -13959,28 +14310,28 @@ "com.amazonaws.ec2#DeregisterTransitGatewayMulticastGroupMembersRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "GroupIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" } }, + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, "NetworkInterfaceIds": { "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", "traits": { "smithy.api#documentation": "

The IDs of the group members' network interfaces.

" } }, - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + "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.

" } } } @@ -14019,6 +14370,12 @@ "smithy.api#documentation": "

The IDs of the group sources' network interfaces.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "GroupIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -14030,12 +14387,6 @@ "traits": { "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -14067,14 +14418,6 @@ "com.amazonaws.ec2#DescribeAccountAttributesRequest": { "type": "structure", "members": { - "AttributeNames": { - "target": "com.amazonaws.ec2#AccountAttributeNameStringList", - "traits": { - "aws.protocols#ec2QueryName": "AttributeName", - "smithy.api#documentation": "

The account attribute names.

", - "smithy.api#xmlName": "attributeName" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -14082,6 +14425,14 @@ "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" } + }, + "AttributeNames": { + "target": "com.amazonaws.ec2#AccountAttributeNameStringList", + "traits": { + "aws.protocols#ec2QueryName": "AttributeName", + "smithy.api#documentation": "

The account attribute names.

", + "smithy.api#xmlName": "attributeName" + } } } }, @@ -14113,13 +14464,6 @@ "com.amazonaws.ec2#DescribeAddressesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -14128,6 +14472,13 @@ "smithy.api#xmlName": "dryRun" } }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, "PublicIps": { "target": "com.amazonaws.ec2#PublicIpStringList", "traits": { @@ -14210,45 +14561,45 @@ "target": "com.amazonaws.ec2#DescribeAvailabilityZonesResult" }, "traits": { - "smithy.api#documentation": "

Describes the Availability Zones and Local Zones that are available to you. \n If there is an event impacting an Availability Zone or Local Zone, you can use this request to view the state and any provided messages for that Availability Zone or Local Zone.

\n

For more information about Availability Zones and Local Zones, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User\n Guide.

" + "smithy.api#documentation": "

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.

\n

For more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions, Zones and\n Outposts in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#DescribeAvailabilityZonesRequest": { "type": "structure", "members": { - "AllAvailabilityZones": { + "ZoneIds": { + "target": "com.amazonaws.ec2#ZoneIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

", + "smithy.api#xmlName": "ZoneId" + } + }, + "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Include all Availability Zones and Local Zones regardless of your opt in status.

\n

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "ZoneNames": { "target": "com.amazonaws.ec2#ZoneNameStringList", "traits": { - "smithy.api#documentation": "

The names of the Zones.

", + "smithy.api#documentation": "

The names of the Availability Zones, Local Zones, and Wavelength Zones.

", "smithy.api#xmlName": "ZoneName" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, - "DryRun": { + "AllAvailabilityZones": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, - "ZoneIds": { - "target": "com.amazonaws.ec2#ZoneIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the Zones.

", - "smithy.api#xmlName": "ZoneId" + "smithy.api#documentation": "

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your\n opt-in status.

\n

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

" } } } @@ -14260,7 +14611,7 @@ "target": "com.amazonaws.ec2#AvailabilityZoneList", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZoneInfo", - "smithy.api#documentation": "

Information about the Zones.

", + "smithy.api#documentation": "

Information about the Availability Zones, Local Zones, and Wavelength Zones.

", "smithy.api#xmlName": "availabilityZoneInfo" } } @@ -14281,11 +14632,11 @@ "com.amazonaws.ec2#DescribeBundleTasksRequest": { "type": "structure", "members": { - "BundleIds": { - "target": "com.amazonaws.ec2#BundleIdStringList", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The bundle task IDs.

\n

Default: Describes all your bundle tasks.

", - "smithy.api#xmlName": "BundleId" + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" } }, "DryRun": { @@ -14296,11 +14647,11 @@ "smithy.api#xmlName": "dryRun" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "BundleIds": { + "target": "com.amazonaws.ec2#BundleIdStringList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The bundle task IDs.

\n

Default: Describes all your bundle tasks.

", + "smithy.api#xmlName": "BundleId" } } } @@ -14366,14 +14717,6 @@ "com.amazonaws.ec2#DescribeByoipCidrsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "ByoipCidrs": { "target": "com.amazonaws.ec2#ByoipCidrSet", "traits": { @@ -14381,6 +14724,14 @@ "smithy.api#documentation": "

Information about your address ranges.

", "smithy.api#xmlName": "byoipCidrSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -14393,7 +14744,13 @@ "target": "com.amazonaws.ec2#DescribeCapacityReservationsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS\n\t\t\tRegion that you're currently using.

" + "smithy.api#documentation": "

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS\n\t\t\tRegion that you're currently using.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeCapacityReservationsMaxResults": { @@ -14408,16 +14765,11 @@ "com.amazonaws.ec2#DescribeCapacityReservationsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "CapacityReservationIds": { + "target": "com.amazonaws.ec2#CapacityReservationIdSet", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "CapacityReservationId" } }, "MaxResults": { @@ -14426,6 +14778,12 @@ "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -14433,11 +14791,10 @@ "smithy.api#xmlName": "Filter" } }, - "CapacityReservationIds": { - "target": "com.amazonaws.ec2#CapacityReservationIdSet", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "CapacityReservationId" + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } } @@ -14463,6 +14820,82 @@ } } }, + "com.amazonaws.ec2#DescribeCarrierGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCarrierGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCarrierGatewaysResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more of your carrier gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CarrierGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCarrierGatewaysRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#CarrierGatewayMaxResults", + "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.

" + } + }, + "CarrierGatewayIds": { + "target": "com.amazonaws.ec2#CarrierGatewayIdSet", + "traits": { + "smithy.api#documentation": "

One or more carrier gateway IDs.

", + "smithy.api#xmlName": "CarrierGatewayId" + } + } + } + }, + "com.amazonaws.ec2#DescribeCarrierGatewaysResult": { + "type": "structure", + "members": { + "CarrierGateways": { + "target": "com.amazonaws.ec2#CarrierGatewaySet", + "traits": { + "aws.protocols#ec2QueryName": "CarrierGatewaySet", + "smithy.api#documentation": "

Information about the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewaySet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } + } + } + }, "com.amazonaws.ec2#DescribeClassicLinkInstances": { "type": "operation", "input": { @@ -14472,7 +14905,13 @@ "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.

" + "smithy.api#documentation": "

Describes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Instances", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults": { @@ -14487,6 +14926,13 @@ "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#xmlName": "Filter" + } + }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { @@ -14494,14 +14940,6 @@ "smithy.api#xmlName": "InstanceId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults", "traits": { @@ -14518,11 +14956,12 @@ "smithy.api#xmlName": "nextToken" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", - "smithy.api#xmlName": "Filter" + "aws.protocols#ec2QueryName": "DryRun", + "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" } } } @@ -14530,14 +14969,6 @@ "com.amazonaws.ec2#DescribeClassicLinkInstancesResult": { "type": "structure", "members": { - "Instances": { - "target": "com.amazonaws.ec2#ClassicLinkInstanceList", - "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

Information about one or more linked EC2-Classic instances.

", - "smithy.api#xmlName": "instancesSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -14545,6 +14976,14 @@ "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#xmlName": "nextToken" } + }, + "Instances": { + "target": "com.amazonaws.ec2#ClassicLinkInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

Information about one or more linked EC2-Classic instances.

", + "smithy.api#xmlName": "instancesSet" + } } } }, @@ -14557,7 +14996,13 @@ "target": "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult" }, "traits": { - "smithy.api#documentation": "

Describes the authorization rules for a specified Client VPN endpoint.

" + "smithy.api#documentation": "

Describes the authorization rules for a specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AuthorizationRules", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesMaxResults": { @@ -14572,6 +15017,12 @@ "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -14579,13 +15030,6 @@ "smithy.api#xmlName": "Filter" } }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", - "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -14598,10 +15042,11 @@ "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} } } } @@ -14609,14 +15054,6 @@ "com.amazonaws.ec2#DescribeClientVpnAuthorizationRulesResult": { "type": "structure", "members": { - "AuthorizationRules": { - "target": "com.amazonaws.ec2#AuthorizationRuleSet", - "traits": { - "aws.protocols#ec2QueryName": "AuthorizationRule", - "smithy.api#documentation": "

Information about the authorization rules.

", - "smithy.api#xmlName": "authorizationRule" - } - }, "NextToken": { "target": "com.amazonaws.ec2#NextToken", "traits": { @@ -14624,6 +15061,14 @@ "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#xmlName": "nextToken" } + }, + "AuthorizationRules": { + "target": "com.amazonaws.ec2#AuthorizationRuleSet", + "traits": { + "aws.protocols#ec2QueryName": "AuthorizationRule", + "smithy.api#documentation": "

Information about the authorization rules.

", + "smithy.api#xmlName": "authorizationRule" + } } } }, @@ -14636,7 +15081,13 @@ "target": "com.amazonaws.ec2#DescribeClientVpnConnectionsResult" }, "traits": { - "smithy.api#documentation": "

Describes active client connections and connections that have been terminated within the last 60 \n\t\t\tminutes for the specified Client VPN endpoint.

" + "smithy.api#documentation": "

Describes active client connections and connections that have been terminated within the last 60 \n\t\t\tminutes for the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Connections", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeClientVpnConnectionsMaxResults": { @@ -14657,16 +15108,11 @@ "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n\t ", + "smithy.api#xmlName": "Filter" } }, "ClientVpnEndpointId": { @@ -14676,11 +15122,16 @@ "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n\t ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } } @@ -14688,14 +15139,6 @@ "com.amazonaws.ec2#DescribeClientVpnConnectionsResult": { "type": "structure", "members": { - "Connections": { - "target": "com.amazonaws.ec2#ClientVpnConnectionSet", - "traits": { - "aws.protocols#ec2QueryName": "Connections", - "smithy.api#documentation": "

Information about the active and terminated client connections.

", - "smithy.api#xmlName": "connections" - } - }, "NextToken": { "target": "com.amazonaws.ec2#NextToken", "traits": { @@ -14703,6 +15146,14 @@ "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#xmlName": "nextToken" } + }, + "Connections": { + "target": "com.amazonaws.ec2#ClientVpnConnectionSet", + "traits": { + "aws.protocols#ec2QueryName": "Connections", + "smithy.api#documentation": "

Information about the active and terminated client connections.

", + "smithy.api#xmlName": "connections" + } } } }, @@ -14724,22 +15175,35 @@ "target": "com.amazonaws.ec2#DescribeClientVpnEndpointsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more Client VPN endpoints in the account.

" + "smithy.api#documentation": "

Describes one or more Client VPN endpoints in the account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClientVpnEndpoints", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeClientVpnEndpointsRequest": { "type": "structure", "members": { + "ClientVpnEndpointIds": { + "target": "com.amazonaws.ec2#ClientVpnEndpointIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#xmlName": "ClientVpnEndpointId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults", "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" } }, "Filters": { @@ -14749,17 +15213,10 @@ "smithy.api#xmlName": "Filter" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClientVpnEndpointMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" - } - }, - "ClientVpnEndpointIds": { - "target": "com.amazonaws.ec2#ClientVpnEndpointIdList", + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#xmlName": "ClientVpnEndpointId" + "smithy.api#documentation": "

The token to retrieve the next page of results.

" } } } @@ -14767,14 +15224,6 @@ "com.amazonaws.ec2#DescribeClientVpnEndpointsResult": { "type": "structure", "members": { - "ClientVpnEndpoints": { - "target": "com.amazonaws.ec2#EndpointSet", - "traits": { - "aws.protocols#ec2QueryName": "ClientVpnEndpoint", - "smithy.api#documentation": "

Information about the Client VPN endpoints.

", - "smithy.api#xmlName": "clientVpnEndpoint" - } - }, "NextToken": { "target": "com.amazonaws.ec2#NextToken", "traits": { @@ -14782,6 +15231,14 @@ "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#xmlName": "nextToken" } + }, + "ClientVpnEndpoints": { + "target": "com.amazonaws.ec2#EndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "ClientVpnEndpoint", + "smithy.api#documentation": "

Information about the Client VPN endpoints.

", + "smithy.api#xmlName": "clientVpnEndpoint" + } } } }, @@ -14794,7 +15251,13 @@ "target": "com.amazonaws.ec2#DescribeClientVpnRoutesResult" }, "traits": { - "smithy.api#documentation": "

Describes the routes for the specified Client VPN endpoint.

" + "smithy.api#documentation": "

Describes the routes for the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Routes", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults": { @@ -14815,17 +15278,10 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults", "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" } }, "Filters": { @@ -14835,10 +15291,17 @@ "smithy.api#xmlName": "Filter" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClientVpnRoutesMaxResults", + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "traits": { + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} } } } @@ -14846,14 +15309,6 @@ "com.amazonaws.ec2#DescribeClientVpnRoutesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "Routes": { "target": "com.amazonaws.ec2#ClientVpnRouteSet", "traits": { @@ -14861,6 +15316,14 @@ "smithy.api#documentation": "

Information about the Client VPN endpoint routes.

", "smithy.api#xmlName": "routes" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -14873,7 +15336,13 @@ "target": "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult" }, "traits": { - "smithy.api#documentation": "

Describes the target networks associated with the specified Client VPN endpoint.

" + "smithy.api#documentation": "

Describes the target networks associated with the specified Client VPN endpoint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClientVpnTargetNetworks", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeClientVpnTargetNetworksMaxResults": { @@ -14895,17 +15364,16 @@ "smithy.api#xmlName": "Filter" } }, - "AssociationIds": { - "target": "com.amazonaws.ec2#ValueStringList", + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", "traits": { - "smithy.api#documentation": "

The IDs of the target network associations.

" + "smithy.api#documentation": "

The token to retrieve the next page of results.

" } }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "MaxResults": { @@ -14914,16 +15382,17 @@ "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", + "AssociationIds": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" + "smithy.api#documentation": "

The IDs of the target network associations.

" } } } @@ -14931,14 +15400,6 @@ "com.amazonaws.ec2#DescribeClientVpnTargetNetworksResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "ClientVpnTargetNetworks": { "target": "com.amazonaws.ec2#TargetNetworkSet", "traits": { @@ -14946,6 +15407,14 @@ "smithy.api#documentation": "

Information about the associated target networks.

", "smithy.api#xmlName": "clientVpnTargetNetworks" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -14958,17 +15427,22 @@ "target": "com.amazonaws.ec2#DescribeCoipPoolsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified customer-owned address pools or all of your customer-owned address pools.

" + "smithy.api#documentation": "

Describes the specified customer-owned address pools or all of your customer-owned address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CoipPools", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeCoipPoolsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters. The following are the possible values:

\n \n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token for the next page of results.

" } }, "PoolIds": { @@ -14978,16 +15452,11 @@ "smithy.api#xmlName": "PoolId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "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#documentation": "

The filters. The following are the possible values:

\n \n ", + "smithy.api#xmlName": "Filter" } }, "MaxResults": { @@ -14995,6 +15464,12 @@ "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.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -15043,14 +15518,6 @@ "com.amazonaws.ec2#DescribeConversionTasksRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "ConversionTaskIds": { "target": "com.amazonaws.ec2#ConversionIdStringList", "traits": { @@ -15058,6 +15525,14 @@ "smithy.api#documentation": "

The conversion task IDs.

", "smithy.api#xmlName": "conversionTaskId" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -15097,19 +15572,19 @@ "smithy.api#xmlName": "dryRun" } }, - "CustomerGatewayIds": { - "target": "com.amazonaws.ec2#CustomerGatewayIdStringList", - "traits": { - "smithy.api#documentation": "

One or more customer gateway IDs.

\n

Default: Describes all your customer gateways.

", - "smithy.api#xmlName": "CustomerGatewayId" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } + }, + "CustomerGatewayIds": { + "target": "com.amazonaws.ec2#CustomerGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more customer gateway IDs.

\n

Default: Describes all your customer gateways.

", + "smithy.api#xmlName": "CustomerGatewayId" + } } }, "traits": { @@ -15141,7 +15616,13 @@ "target": "com.amazonaws.ec2#DescribeDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your DHCP options sets.

\n\t\t

For more information, see DHCP Options Sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Describes one or more of your DHCP options sets.

\n\t\t

For more information, see DHCP Options Sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DhcpOptions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults": { @@ -15156,12 +15637,6 @@ "com.amazonaws.ec2#DescribeDhcpOptionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "DhcpOptionsIds": { "target": "com.amazonaws.ec2#DhcpOptionsIdStringList", "traits": { @@ -15169,13 +15644,6 @@ "smithy.api#xmlName": "DhcpOptionsId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -15184,6 +15652,19 @@ "smithy.api#xmlName": "dryRun" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#xmlName": "Filter" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults", "traits": { @@ -15195,14 +15676,6 @@ "com.amazonaws.ec2#DescribeDhcpOptionsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "DhcpOptions": { "target": "com.amazonaws.ec2#DhcpOptionsList", "traits": { @@ -15210,6 +15683,14 @@ "smithy.api#documentation": "

Information about one or more DHCP options sets.

", "smithy.api#xmlName": "dhcpOptionsSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -15222,7 +15703,13 @@ "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your egress-only internet gateways.

" + "smithy.api#documentation": "

Describes one or more of your egress-only internet gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EgressOnlyInternetGateways", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults": { @@ -15237,17 +15724,11 @@ "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults", - "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.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "EgressOnlyInternetGatewayIds": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n \t ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

One or more egress-only internet gateway IDs.

", + "smithy.api#xmlName": "EgressOnlyInternetGatewayId" } }, "DryRun": { @@ -15256,17 +15737,23 @@ "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.

" } }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeEgressOnlyInternetGatewaysMaxResults", + "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.ec2#String", "traits": { "smithy.api#documentation": "

The token for the next page of results.

" } }, - "EgressOnlyInternetGatewayIds": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayIdList", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more egress-only internet gateway IDs.

", - "smithy.api#xmlName": "EgressOnlyInternetGatewayId" + "smithy.api#documentation": "

One or more filters.

\n \t ", + "smithy.api#xmlName": "Filter" } } } @@ -15316,24 +15803,17 @@ "com.amazonaws.ec2#DescribeElasticGpusRequest": { "type": "structure", "members": { - "ElasticGpuIds": { - "target": "com.amazonaws.ec2#ElasticGpuIdSet", - "traits": { - "smithy.api#documentation": "

The Elastic Graphics accelerator IDs.

", - "smithy.api#xmlName": "ElasticGpuId" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeElasticGpusMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 5 and 1000.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "ElasticGpuIds": { + "target": "com.amazonaws.ec2#ElasticGpuIdSet", "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The Elastic Graphics accelerator IDs.

", + "smithy.api#xmlName": "ElasticGpuId" } }, "NextToken": { @@ -15347,18 +15827,25 @@ "traits": { "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.

" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } } } }, "com.amazonaws.ec2#DescribeElasticGpusResult": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "ElasticGpuSet": { + "target": "com.amazonaws.ec2#ElasticGpuSet", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The total number of items to return. If the total number of items available is more\n than the value specified in max-items then a Next-Token will be provided in the output\n that you can use to resume pagination.

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "ElasticGpuSet", + "smithy.api#documentation": "

Information about the Elastic Graphics accelerators.

", + "smithy.api#xmlName": "elasticGpuSet" } }, "NextToken": { @@ -15369,12 +15856,12 @@ "smithy.api#xmlName": "nextToken" } }, - "ElasticGpuSet": { - "target": "com.amazonaws.ec2#ElasticGpuSet", + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuSet", - "smithy.api#documentation": "

Information about the Elastic Graphics accelerators.

", - "smithy.api#xmlName": "elasticGpuSet" + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The total number of items to return. If the total number of items available is more\n than the value specified in max-items then a Next-Token will be provided in the output\n that you can use to resume pagination.

", + "smithy.api#xmlName": "maxResults" } } } @@ -15388,7 +15875,13 @@ "target": "com.amazonaws.ec2#DescribeExportImageTasksResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified export image tasks or all of your export image tasks.

" + "smithy.api#documentation": "

Describes the specified export image tasks or all of your export image tasks.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ExportImageTasks", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeExportImageTasksMaxResults": { @@ -15403,18 +15896,6 @@ "com.amazonaws.ec2#DescribeExportImageTasksRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

A token that indicates the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "ExportImageTaskIds": { "target": "com.amazonaws.ec2#ExportImageTaskIdList", "traits": { @@ -15422,17 +15903,29 @@ "smithy.api#xmlName": "ExportImageTaskId" } }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", + "smithy.api#xmlName": "Filter" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeExportImageTasksMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", "traits": { - "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

A token that indicates the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" } } } @@ -15506,6 +15999,22 @@ "com.amazonaws.ec2#DescribeFastSnapshotRestoreSuccessItem": { "type": "structure", "members": { + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + }, + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores.

", + "smithy.api#xmlName": "state" + } + }, "SnapshotId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -15514,20 +16023,12 @@ "smithy.api#xmlName": "snapshotId" } }, - "EnabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", - "smithy.api#xmlName": "enabledTime" - } - }, - "DisablingTime": { + "EnablingTime": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "DisablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", - "smithy.api#xmlName": "disablingTime" + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" } }, "OptimizingTime": { @@ -15538,12 +16039,28 @@ "smithy.api#xmlName": "optimizingTime" } }, - "DisabledTime": { + "EnabledTime": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "DisabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", - "smithy.api#xmlName": "disabledTime" + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" + } + }, + "OwnerAlias": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" } }, "OwnerId": { @@ -15554,14 +16071,6 @@ "smithy.api#xmlName": "ownerId" } }, - "EnablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "EnablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", - "smithy.api#xmlName": "enablingTime" - } - }, "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { @@ -15570,28 +16079,12 @@ "smithy.api#xmlName": "availabilityZone" } }, - "State": { - "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of fast snapshot restores.

", - "smithy.api#xmlName": "state" - } - }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", - "smithy.api#xmlName": "ownerAlias" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", + "DisablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", - "smithy.api#xmlName": "stateTransitionReason" + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" } } }, @@ -15617,7 +16110,13 @@ "target": "com.amazonaws.ec2#DescribeFastSnapshotRestoresResult" }, "traits": { - "smithy.api#documentation": "

Describes the state of fast snapshot restores for your snapshots.

" + "smithy.api#documentation": "

Describes the state of fast snapshot restores for your snapshots.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FastSnapshotRestores", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeFastSnapshotRestoresMaxResults": { @@ -15633,13 +16132,6 @@ "com.amazonaws.ec2#DescribeFastSnapshotRestoresRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -15657,6 +16149,13 @@ "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.

" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } } } }, @@ -15684,6 +16183,14 @@ "com.amazonaws.ec2#DescribeFleetError": { "type": "structure", "members": { + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, "ErrorCode": { "target": "com.amazonaws.ec2#String", "traits": { @@ -15707,14 +16214,6 @@ "smithy.api#documentation": "

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", "smithy.api#xmlName": "lifecycle" } - }, - "LaunchTemplateAndOverrides": { - "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", - "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", - "smithy.api#xmlName": "launchTemplateAndOverrides" - } } }, "traits": { @@ -15736,6 +16235,12 @@ "com.amazonaws.ec2#DescribeFleetHistoryRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. Specify a value between 1 and\n 1000. The default value is 1000. To retrieve the remaining results, make another call with\n the returned NextToken value.

" + } + }, "FleetId": { "target": "com.amazonaws.ec2#FleetId", "traits": { @@ -15743,18 +16248,18 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. Specify a value between 1 and\n 1000. The default value is 1000. To retrieve the remaining results, make another call with\n the returned NextToken value.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, "StartTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -15767,32 +16272,26 @@ "traits": { "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

" } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } } } }, "com.amazonaws.ec2#DescribeFleetHistoryResult": { "type": "structure", "members": { - "HistoryRecords": { - "target": "com.amazonaws.ec2#HistoryRecordSet", + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", "traits": { - "aws.protocols#ec2QueryName": "HistoryRecordSet", - "smithy.api#documentation": "

Information about the events in the history of the EC2 Fleet.

", - "smithy.api#xmlName": "historyRecordSet" + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC Fleet.

", + "smithy.api#xmlName": "fleetId" } }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "startTime" + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#xmlName": "nextToken" } }, "LastEvaluatedTime": { @@ -15803,20 +16302,20 @@ "smithy.api#xmlName": "lastEvaluatedTime" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "HistoryRecords": { + "target": "com.amazonaws.ec2#HistoryRecordSet", "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#xmlName": "nextToken" + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

Information about the events in the history of the EC2 Fleet.

", + "smithy.api#xmlName": "historyRecordSet" } }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC Fleet.

", - "smithy.api#xmlName": "fleetId" + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The start date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" } } } @@ -15836,6 +16335,18 @@ "com.amazonaws.ec2#DescribeFleetInstancesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -15850,23 +16361,11 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call. Specify a value between 1 and\n 1000. The default value is 1000. To retrieve the remaining results, make another call with\n the returned NextToken value.

" } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } } } }, @@ -15881,14 +16380,6 @@ "smithy.api#xmlName": "activeInstanceSet" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#xmlName": "nextToken" - } - }, "FleetId": { "target": "com.amazonaws.ec2#FleetId", "traits": { @@ -15896,6 +16387,14 @@ "smithy.api#documentation": "

The ID of the EC2 Fleet.

", "smithy.api#xmlName": "fleetId" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#xmlName": "nextToken" + } } } }, @@ -15908,7 +16407,13 @@ "target": "com.amazonaws.ec2#DescribeFleetsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified EC2 Fleets or all of your EC2 Fleets.

" + "smithy.api#documentation": "

Describes the specified EC2 Fleets or all of your EC2 Fleets.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Fleets", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeFleetsErrorSet": { @@ -15923,14 +16428,6 @@ "com.amazonaws.ec2#DescribeFleetsInstances": { "type": "structure", "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdsSet", - "traits": { - "aws.protocols#ec2QueryName": "InstanceIds", - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#xmlName": "instanceIds" - } - }, "Lifecycle": { "target": "com.amazonaws.ec2#InstanceLifecycle", "traits": { @@ -15939,12 +16436,20 @@ "smithy.api#xmlName": "lifecycle" } }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", + "LaunchTemplateAndOverrides": { + "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", - "smithy.api#xmlName": "platform" + "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", + "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", + "smithy.api#xmlName": "launchTemplateAndOverrides" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdsSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceIds", + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#xmlName": "instanceIds" } }, "InstanceType": { @@ -15955,12 +16460,12 @@ "smithy.api#xmlName": "instanceType" } }, - "LaunchTemplateAndOverrides": { - "target": "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse", + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateAndOverrides", - "smithy.api#documentation": "

The launch templates and overrides that were used for launching the instances. The\n values that you specify in the Overrides replace the values in the launch template.

", - "smithy.api#xmlName": "launchTemplateAndOverrides" + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", + "smithy.api#xmlName": "platform" } } }, @@ -15980,6 +16485,12 @@ "com.amazonaws.ec2#DescribeFleetsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -15993,10 +16504,10 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call. Specify a value between 1 and\n 1000. The default value is 1000. To retrieve the remaining results, make another call with\n the returned NextToken value.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" + "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.

" } }, "FleetIds": { @@ -16005,26 +16516,12 @@ "smithy.api#documentation": "

The ID of the EC2 Fleets.

", "smithy.api#xmlName": "FleetId" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, "com.amazonaws.ec2#DescribeFleetsResult": { "type": "structure", "members": { - "Fleets": { - "target": "com.amazonaws.ec2#FleetSet", - "traits": { - "aws.protocols#ec2QueryName": "FleetSet", - "smithy.api#documentation": "

Information about the EC2 Fleets.

", - "smithy.api#xmlName": "fleetSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -16032,6 +16529,14 @@ "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#xmlName": "nextToken" } + }, + "Fleets": { + "target": "com.amazonaws.ec2#FleetSet", + "traits": { + "aws.protocols#ec2QueryName": "FleetSet", + "smithy.api#documentation": "

Information about the EC2 Fleets.

", + "smithy.api#xmlName": "fleetSet" + } } } }, @@ -16044,16 +16549,28 @@ "target": "com.amazonaws.ec2#DescribeFlowLogsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more flow logs. To view the information in your flow logs (the log\n streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs\n API.

" + "smithy.api#documentation": "

Describes one or more flow logs. To view the information in your flow logs (the log\n streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs\n API.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FlowLogs", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeFlowLogsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "NextToken": { + "target": "com.amazonaws.ec2#String", "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.

" + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n " } }, "FlowLogIds": { @@ -16063,22 +16580,16 @@ "smithy.api#xmlName": "FlowLogId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, - "Filter": { - "target": "com.amazonaws.ec2#FilterList", + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

One or more filters.

\n " + "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.

" } } } @@ -16086,14 +16597,6 @@ "com.amazonaws.ec2#DescribeFlowLogsResult": { "type": "structure", "members": { - "FlowLogs": { - "target": "com.amazonaws.ec2#FlowLogSet", - "traits": { - "aws.protocols#ec2QueryName": "FlowLogSet", - "smithy.api#documentation": "

Information about the flow logs.

", - "smithy.api#xmlName": "flowLogSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -16101,6 +16604,14 @@ "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#xmlName": "nextToken" } + }, + "FlowLogs": { + "target": "com.amazonaws.ec2#FlowLogSet", + "traits": { + "aws.protocols#ec2QueryName": "FlowLogSet", + "smithy.api#documentation": "

Information about the flow logs.

", + "smithy.api#xmlName": "flowLogSet" + } } } }, @@ -16163,7 +16674,13 @@ "target": "com.amazonaws.ec2#DescribeFpgaImagesResult" }, "traits": { - "smithy.api#documentation": "

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs,\n\t\t\tprivate AFIs that you own, and AFIs owned by other AWS accounts for which you have load\n\t\t\tpermissions.

" + "smithy.api#documentation": "

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs,\n\t\t\tprivate AFIs that you own, and AFIs owned by other AWS accounts for which you have load\n\t\t\tpermissions.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FpgaImages", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeFpgaImagesMaxResults": { @@ -16178,6 +16695,13 @@ "com.amazonaws.ec2#DescribeFpgaImagesRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n\t\t ", + "smithy.api#xmlName": "Filter" + } + }, "Owners": { "target": "com.amazonaws.ec2#OwnerStringList", "traits": { @@ -16185,11 +16709,11 @@ "smithy.api#xmlName": "Owner" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "FpgaImageIds": { + "target": "com.amazonaws.ec2#FpgaImageIdList", "traits": { - "smithy.api#documentation": "

The filters.

\n\t\t ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The AFI IDs.

", + "smithy.api#xmlName": "FpgaImageId" } }, "NextToken": { @@ -16204,13 +16728,6 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call.

" } }, - "FpgaImageIds": { - "target": "com.amazonaws.ec2#FpgaImageIdList", - "traits": { - "smithy.api#documentation": "

The AFI IDs.

", - "smithy.api#xmlName": "FpgaImageId" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -16249,7 +16766,13 @@ "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsResult" }, "traits": { - "smithy.api#documentation": "

Describes the Dedicated Host reservations that are available to purchase.

\n

The results describe all of the Dedicated Host reservation offerings, including\n\t\t\tofferings that might not match the instance family and Region of your Dedicated Hosts.\n\t\t\tWhen purchasing an offering, ensure that the instance family and Region of the offering\n\t\t\tmatches that of the Dedicated Hosts with which it is to be associated. For more\n\t\t\tinformation about supported instance types, see Dedicated Hosts\n\t\t\t\tOverview in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the Dedicated Host reservations that are available to purchase.

\n

The results describe all of the Dedicated Host reservation offerings, including\n\t\t\tofferings that might not match the instance family and Region of your Dedicated Hosts.\n\t\t\tWhen purchasing an offering, ensure that the instance family and Region of the offering\n\t\t\tmatches that of the Dedicated Hosts with which it is to be associated. For more\n\t\t\tinformation about supported instance types, see Dedicated Hosts\n\t\t\t\tOverview in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OfferingSet", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeHostReservationOfferingsRequest": { @@ -16261,18 +16784,6 @@ "smithy.api#documentation": "

This is the maximum duration of the reservation to purchase, specified in seconds.\n Reservations are available in one-year and three-year terms. The number of seconds\n specified must be the number of seconds in a year (365x24x60x60) times one of the\n supported durations (1 or 3). For example, specify 94608000 for three years.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#OfferingId", - "traits": { - "smithy.api#documentation": "

The ID of the reservation offering.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeHostReservationsMaxResults", "traits": { @@ -16290,6 +16801,18 @@ "traits": { "smithy.api#documentation": "

This is the minimum duration of the reservation you'd like to purchase, specified\n in seconds. Reservations are available in one-year and three-year terms. The number of\n seconds specified must be the number of seconds in a year (365x24x60x60) times one of\n the supported durations (1 or 3). For example, specify 31536000 for one year.

" } + }, + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", + "traits": { + "smithy.api#documentation": "

The ID of the reservation offering.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } } } }, @@ -16323,7 +16846,13 @@ "target": "com.amazonaws.ec2#DescribeHostReservationsResult" }, "traits": { - "smithy.api#documentation": "

Describes reservations that are associated with Dedicated Hosts in your\n account.

" + "smithy.api#documentation": "

Describes reservations that are associated with Dedicated Hosts in your\n account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HostReservationSet", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeHostReservationsMaxResults": { @@ -16338,28 +16867,28 @@ "com.amazonaws.ec2#DescribeHostReservationsRequest": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n " - } - }, "HostReservationIdSet": { "target": "com.amazonaws.ec2#HostReservationIdSet", "traits": { "smithy.api#documentation": "

The host reservation IDs.

" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Filter": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + "smithy.api#documentation": "

The filters.

\n " } } } @@ -16367,14 +16896,6 @@ "com.amazonaws.ec2#DescribeHostReservationsResult": { "type": "structure", "members": { - "HostReservationSet": { - "target": "com.amazonaws.ec2#HostReservationSet", - "traits": { - "aws.protocols#ec2QueryName": "HostReservationSet", - "smithy.api#documentation": "

Details about the reservation's configuration.

", - "smithy.api#xmlName": "hostReservationSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -16382,6 +16903,14 @@ "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#xmlName": "nextToken" } + }, + "HostReservationSet": { + "target": "com.amazonaws.ec2#HostReservationSet", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationSet", + "smithy.api#documentation": "

Details about the reservation's configuration.

", + "smithy.api#xmlName": "hostReservationSet" + } } } }, @@ -16394,28 +16923,18 @@ "target": "com.amazonaws.ec2#DescribeHostsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

\n

The results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.

" + "smithy.api#documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

\n

The results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Hosts", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeHostsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - }, - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "filter" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -16431,6 +16950,22 @@ "smithy.api#documentation": "

The IDs of the Dedicated Hosts. The IDs are used for targeted instance\n launches.

", "smithy.api#xmlName": "hostId" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, + "Filter": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "filter" + } } } }, @@ -16464,7 +16999,13 @@ "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsResult" }, "traits": { - "smithy.api#documentation": "

Describes your IAM instance profile associations.

" + "smithy.api#documentation": "

Describes your IAM instance profile associations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IamInstanceProfileAssociations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults": { @@ -16486,10 +17027,11 @@ "smithy.api#xmlName": "AssociationId" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" } }, "NextToken": { @@ -16498,11 +17040,10 @@ "smithy.api#documentation": "

The token to request the next page of results.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeIamInstanceProfileAssociationsMaxResults", "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" } } } @@ -16579,14 +17120,6 @@ "com.amazonaws.ec2#DescribeIdentityIdFormatRequest": { "type": "structure", "members": { - "Resource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Resource", - "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", - "smithy.api#xmlName": "resource" - } - }, "PrincipalArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -16595,6 +17128,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "principalArn" } + }, + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", + "smithy.api#xmlName": "resource" + } } } }, @@ -16626,6 +17167,13 @@ "com.amazonaws.ec2#DescribeImageAttributeRequest": { "type": "structure", "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -16634,13 +17182,6 @@ "smithy.api#xmlName": "dryRun" } }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, "Attribute": { "target": "com.amazonaws.ec2#ImageAttributeName", "traits": { @@ -16668,11 +17209,11 @@ "com.amazonaws.ec2#DescribeImagesRequest": { "type": "structure", "members": { - "Owners": { - "target": "com.amazonaws.ec2#OwnerStringList", + "ExecutableUsers": { + "target": "com.amazonaws.ec2#ExecutableByStringList", "traits": { - "smithy.api#documentation": "

Scopes the results to images with the specified owners. You can specify a combination of \n AWS account IDs, self, amazon, and aws-marketplace. \n If you omit this parameter, the results include all images for which you have launch permissions, \n regardless of ownership.

", - "smithy.api#xmlName": "Owner" + "smithy.api#documentation": "

Scopes the images by users with explicit launch permissions. \n\t\t\t\tSpecify an AWS account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).

", + "smithy.api#xmlName": "ExecutableBy" } }, "ImageIds": { @@ -16693,15 +17234,15 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, - "ExecutableUsers": { - "target": "com.amazonaws.ec2#ExecutableByStringList", + "Owners": { + "target": "com.amazonaws.ec2#OwnerStringList", "traits": { - "smithy.api#documentation": "

Scopes the images by users with explicit launch permissions. \n\t\t\t\tSpecify an AWS account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).

", - "smithy.api#xmlName": "ExecutableBy" + "smithy.api#documentation": "

Scopes the results to images with the specified owners. You can specify a combination of \n AWS account IDs, self, amazon, and aws-marketplace. \n If you omit this parameter, the results include all images for which you have launch permissions, \n regardless of ownership.

", + "smithy.api#xmlName": "Owner" } } } @@ -16728,7 +17269,13 @@ "target": "com.amazonaws.ec2#DescribeImportImageTasksResult" }, "traits": { - "smithy.api#documentation": "

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + "smithy.api#documentation": "

Displays details about an import virtual machine or import snapshot tasks that are already created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImportImageTasks", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeImportImageTasksRequest": { @@ -16740,19 +17287,6 @@ "smithy.api#documentation": "

A token that indicates the next page of results.

" } }, - "ImportTaskIds": { - "target": "com.amazonaws.ec2#ImportTaskIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the import image tasks.

", - "smithy.api#xmlName": "ImportTaskId" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -16765,20 +17299,25 @@ "smithy.api#documentation": "

Filter tasks using the task-state filter and one of the following values: active,\n completed, deleting, or deleted.

", "smithy.api#xmlName": "Filters" } + }, + "ImportTaskIds": { + "target": "com.amazonaws.ec2#ImportTaskIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the import image tasks.

", + "smithy.api#xmlName": "ImportTaskId" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } } } }, "com.amazonaws.ec2#DescribeImportImageTasksResult": { "type": "structure", "members": { - "ImportImageTasks": { - "target": "com.amazonaws.ec2#ImportImageTaskList", - "traits": { - "aws.protocols#ec2QueryName": "ImportImageTaskSet", - "smithy.api#documentation": "

A list of zero or more import image tasks that are currently active or were completed or canceled in the\n previous 7 days.

", - "smithy.api#xmlName": "importImageTaskSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -16786,6 +17325,14 @@ "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", "smithy.api#xmlName": "nextToken" } + }, + "ImportImageTasks": { + "target": "com.amazonaws.ec2#ImportImageTaskList", + "traits": { + "aws.protocols#ec2QueryName": "ImportImageTaskSet", + "smithy.api#documentation": "

A list of zero or more import image tasks that are currently active or were completed or canceled in the\n previous 7 days.

", + "smithy.api#xmlName": "importImageTaskSet" + } } } }, @@ -16798,19 +17345,18 @@ "target": "com.amazonaws.ec2#DescribeImportSnapshotTasksResult" }, "traits": { - "smithy.api#documentation": "

Describes your import snapshot tasks.

" + "smithy.api#documentation": "

Describes your import snapshot tasks.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImportSnapshotTasks", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeImportSnapshotTasksRequest": { "type": "structure", "members": { - "ImportTaskIds": { - "target": "com.amazonaws.ec2#ImportSnapshotTaskIdList", - "traits": { - "smithy.api#documentation": "

A list of import snapshot task IDs.

", - "smithy.api#xmlName": "ImportTaskId" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -16818,10 +17364,10 @@ "smithy.api#xmlName": "Filters" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

A token that indicates the next page of results.

" + "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.

" } }, "MaxResults": { @@ -16830,10 +17376,17 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results, make another call\n with the returned NextToken value.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

A token that indicates the next page of results.

" + } + }, + "ImportTaskIds": { + "target": "com.amazonaws.ec2#ImportSnapshotTaskIdList", + "traits": { + "smithy.api#documentation": "

A list of import snapshot task IDs.

", + "smithy.api#xmlName": "ImportTaskId" } } } @@ -16841,14 +17394,6 @@ "com.amazonaws.ec2#DescribeImportSnapshotTasksResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", - "smithy.api#xmlName": "nextToken" - } - }, "ImportSnapshotTasks": { "target": "com.amazonaws.ec2#ImportSnapshotTaskList", "traits": { @@ -16856,6 +17401,14 @@ "smithy.api#documentation": "

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the\n previous 7 days.

", "smithy.api#xmlName": "importSnapshotTaskSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to get the next page of results. This value is null when there are no more results\n to return.

", + "smithy.api#xmlName": "nextToken" + } } } }, @@ -16911,7 +17464,13 @@ "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.

\n

If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.

\n

If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.

\n

For more information, see Burstable\n performance instances in the Amazon Elastic Compute Cloud User\n Guide.

" + "smithy.api#documentation": "

Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.

\n

If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.

\n

If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.

\n

For more information, see Burstable\n performance instances in the Amazon Elastic Compute Cloud User\n Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceCreditSpecifications", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsMaxResults": { @@ -16926,6 +17485,12 @@ "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -16933,16 +17498,11 @@ "smithy.api#xmlName": "Filter" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { - "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#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 1000 explicitly specified instance IDs.

", + "smithy.api#xmlName": "InstanceId" } }, "MaxResults": { @@ -16951,11 +17511,10 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 5 and 1000. You cannot specify this parameter and the instance IDs\n parameter in the same call.

" } }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 1000 explicitly specified instance IDs.

", - "smithy.api#xmlName": "InstanceId" + "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.

" } } } @@ -16963,14 +17522,6 @@ "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult": { "type": "structure", "members": { - "InstanceCreditSpecifications": { - "target": "com.amazonaws.ec2#InstanceCreditSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCreditSpecificationSet", - "smithy.api#documentation": "

Information about the credit option for CPU usage of an instance.

", - "smithy.api#xmlName": "instanceCreditSpecificationSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -16978,6 +17529,14 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "InstanceCreditSpecifications": { + "target": "com.amazonaws.ec2#InstanceCreditSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCreditSpecificationSet", + "smithy.api#documentation": "

Information about the credit option for CPU usage of an instance.

", + "smithy.api#xmlName": "instanceCreditSpecificationSet" + } } } }, @@ -17026,7 +17585,13 @@ "target": "com.amazonaws.ec2#DescribeInstanceStatusResult" }, "traits": { - "smithy.api#documentation": "

Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.

\n

Instance status includes the following components:

\n " + "smithy.api#documentation": "

Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.

\n

Instance status includes the following components:

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceStatuses", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeInstanceStatusRequest": { @@ -17039,10 +17604,19 @@ "smithy.api#xmlName": "Filter" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", + "smithy.api#xmlName": "InstanceId" } }, "IncludeAllInstances": { @@ -17053,25 +17627,16 @@ "smithy.api#xmlName": "includeAllInstances" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 5 and 1000. You cannot specify this parameter and the instance IDs\n parameter in the same call.

" } }, - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", - "smithy.api#xmlName": "InstanceId" + "smithy.api#documentation": "

The token to retrieve the next page of results.

" } } } @@ -17079,14 +17644,6 @@ "com.amazonaws.ec2#DescribeInstanceStatusResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, "InstanceStatuses": { "target": "com.amazonaws.ec2#InstanceStatusList", "traits": { @@ -17094,6 +17651,14 @@ "smithy.api#documentation": "

Information about the status of the instances.

", "smithy.api#xmlName": "instanceStatusSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } } } }, @@ -17106,18 +17671,18 @@ "target": "com.amazonaws.ec2#DescribeInstanceTypeOfferingsResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of all instance types offered. The results can be filtered by location (Region or Availability\n Zone). If no location is specified, the instance types offered in the current Region are returned.

" + "smithy.api#documentation": "

Returns a list of all instance types offered. The results can be filtered by location (Region or Availability\n Zone). If no location is specified, the instance types offered in the current Region are returned.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypeOfferings", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeInstanceTypeOfferingsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#DITOMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results\n can be seen by sending another request with the next token value.

" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -17125,10 +17690,10 @@ "smithy.api#xmlName": "Filter" } }, - "LocationType": { - "target": "com.amazonaws.ec2#LocationType", + "MaxResults": { + "target": "com.amazonaws.ec2#DITOMaxResults", "traits": { - "smithy.api#documentation": "

The location type.

" + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results\n can be seen by sending another request with the next token value.

" } }, "DryRun": { @@ -17142,6 +17707,12 @@ "traits": { "smithy.api#documentation": "

The token to retrieve the next page of results.

" } + }, + "LocationType": { + "target": "com.amazonaws.ec2#LocationType", + "traits": { + "smithy.api#documentation": "

The location type.

" + } } } }, @@ -17175,12 +17746,25 @@ "target": "com.amazonaws.ec2#DescribeInstanceTypesResult" }, "traits": { - "smithy.api#documentation": "

Describes the details of the instance types that are offered in a location. The results can be filtered by the\n attributes of the instance types.

" + "smithy.api#documentation": "

Describes the details of the instance types that are offered in a location. The results can be filtered by the\n attributes of the instance types.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceTypes", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeInstanceTypesRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", + "smithy.api#xmlName": "Filter" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#DITMaxResults", "traits": { @@ -17193,39 +17777,24 @@ "smithy.api#documentation": "

The token to retrieve the next page of results.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "InstanceTypes": { "target": "com.amazonaws.ec2#RequestInstanceTypeList", "traits": { "smithy.api#documentation": "

The instance types. For more information, see Instance Types in the Amazon Elastic Compute\n Cloud User Guide.

", "smithy.api#xmlName": "InstanceType" } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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\n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } } } }, "com.amazonaws.ec2#DescribeInstanceTypesResult": { "type": "structure", "members": { - "InstanceTypes": { - "target": "com.amazonaws.ec2#InstanceTypeInfoList", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTypeSet", - "smithy.api#documentation": "

The instance type. For more information, see Instance Types in the Amazon Elastic Compute\n Cloud User Guide.

", - "smithy.api#xmlName": "instanceTypeSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#NextToken", "traits": { @@ -17233,6 +17802,14 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there\n are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypeInfoList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypeSet", + "smithy.api#documentation": "

The instance type. For more information, see Instance Types in the Amazon Elastic Compute\n Cloud User Guide.

", + "smithy.api#xmlName": "instanceTypeSet" + } } } }, @@ -17245,12 +17822,26 @@ "target": "com.amazonaws.ec2#DescribeInstancesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified instances. \n If you specify filters, the output includes information for only those instances that meet the filter criteria. \n If you do not specify instance IDs or filters, the output includes information for all instances,\n which can affect performance. We recommend that you use pagination to ensure that the operation \n returns quickly and successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you \n specify an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

" + "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified instances. \n If you specify filters, the output includes information for only those instances that meet the filter criteria. \n If you do not specify instance IDs or filters, the output includes information for all instances,\n which can affect performance. We recommend that you use pagination to ensure that the operation \n returns quickly and successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you \n specify an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Reservations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeInstancesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { @@ -17258,13 +17849,6 @@ "smithy.api#xmlName": "InstanceId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -17273,14 +17857,6 @@ "smithy.api#xmlName": "dryRun" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to request the next page of results.

", - "smithy.api#xmlName": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -17288,20 +17864,19 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 5 and 1000. You cannot specify this parameter and the instance IDs\n parameter in the same call.

", "smithy.api#xmlName": "maxResults" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } } } }, "com.amazonaws.ec2#DescribeInstancesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, "Reservations": { "target": "com.amazonaws.ec2#ReservationList", "traits": { @@ -17309,6 +17884,14 @@ "smithy.api#documentation": "

Information about the reservations.

", "smithy.api#xmlName": "reservationSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } } } }, @@ -17321,7 +17904,13 @@ "target": "com.amazonaws.ec2#DescribeInternetGatewaysResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your internet gateways.

" + "smithy.api#documentation": "

Describes one or more of your internet gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InternetGateways", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults": { @@ -17336,14 +17925,6 @@ "com.amazonaws.ec2#DescribeInternetGatewaysRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults", "traits": { @@ -17370,6 +17951,14 @@ "traits": { "smithy.api#documentation": "

The token for the next page of results.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -17403,12 +17992,25 @@ "target": "com.amazonaws.ec2#DescribeIpv6PoolsResult" }, "traits": { - "smithy.api#documentation": "

Describes your IPv6 address pools.

" + "smithy.api#documentation": "

Describes your IPv6 address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipv6Pools", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeIpv6PoolsRequest": { "type": "structure", "members": { + "PoolIds": { + "target": "com.amazonaws.ec2#Ipv6PoolIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the IPv6 address pools.

", + "smithy.api#xmlName": "PoolId" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -17416,29 +18018,22 @@ "smithy.api#xmlName": "Filter" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", - "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.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", + "MaxResults": { + "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "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.

" } }, - "PoolIds": { - "target": "com.amazonaws.ec2#Ipv6PoolIdList", + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", "traits": { - "smithy.api#documentation": "

The IDs of the IPv6 address pools.

", - "smithy.api#xmlName": "PoolId" + "smithy.api#documentation": "

The token for the next page of results.

" } } } @@ -17479,12 +18074,11 @@ "com.amazonaws.ec2#DescribeKeyPairsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "KeyPairIds": { + "target": "com.amazonaws.ec2#KeyPairIdStringList", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

The IDs of the key pairs.

", + "smithy.api#xmlName": "KeyPairId" } }, "Filters": { @@ -17494,19 +18088,20 @@ "smithy.api#xmlName": "Filter" } }, - "KeyPairIds": { - "target": "com.amazonaws.ec2#KeyPairIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the key pairs.

", - "smithy.api#xmlName": "KeyPairId" - } - }, "KeyNames": { "target": "com.amazonaws.ec2#KeyNameStringList", "traits": { "smithy.api#documentation": "

The key pair names.

\n

Default: Describes all your key pairs.

", "smithy.api#xmlName": "KeyName" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -17532,16 +18127,23 @@ "target": "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more versions of a specified launch template. You can describe all\n versions, individual versions, or a range of versions. You can also describe all the\n latest versions or all the default versions of all the launch templates in your\n account.

" + "smithy.api#documentation": "

Describes one or more versions of a specified launch template. You can describe all\n versions, individual versions, or a range of versions. You can also describe all the\n latest versions or all the default versions of all the launch templates in your\n account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LaunchTemplateVersions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLaunchTemplateVersionsRequest": { "type": "structure", "members": { - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The name of the launch template. To describe one or more versions of a specified\n launch template, you must specify either the launch template ID or the launch template\n name in the request. To describe all the latest or default launch template versions in\n your account, you must omit this parameter.

" + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" } }, "MinVersion": { @@ -17556,11 +18158,22 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the launch template. To describe one or more versions of a specified launch\n template, you must specify either the launch template ID or the launch template name in\n the request. To describe all the latest or default launch template versions in your\n account, you must omit this parameter.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } }, "MaxVersion": { @@ -17576,22 +18189,10 @@ "smithy.api#xmlName": "LaunchTemplateVersion" } }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", - "traits": { - "smithy.api#documentation": "

The ID of the launch template. To describe one or more versions of a specified launch\n template, you must specify either the launch template ID or the launch template name in\n the request. To describe all the latest or default launch template versions in your\n account, you must omit this parameter.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + "smithy.api#documentation": "

The name of the launch template. To describe one or more versions of a specified\n launch template, you must specify either the launch template ID or the launch template\n name in the request. To describe all the latest or default launch template versions in\n your account, you must omit this parameter.

" } } } @@ -17599,14 +18200,6 @@ "com.amazonaws.ec2#DescribeLaunchTemplateVersionsResult": { "type": "structure", "members": { - "LaunchTemplateVersions": { - "target": "com.amazonaws.ec2#LaunchTemplateVersionSet", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateVersionSet", - "smithy.api#documentation": "

Information about the launch template versions.

", - "smithy.api#xmlName": "launchTemplateVersionSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -17614,6 +18207,14 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "LaunchTemplateVersions": { + "target": "com.amazonaws.ec2#LaunchTemplateVersionSet", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateVersionSet", + "smithy.api#documentation": "

Information about the launch template versions.

", + "smithy.api#xmlName": "launchTemplateVersionSet" + } } } }, @@ -17626,7 +18227,13 @@ "target": "com.amazonaws.ec2#DescribeLaunchTemplatesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more launch templates.

" + "smithy.api#documentation": "

Describes one or more launch templates.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LaunchTemplates", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults": { @@ -17641,10 +18248,11 @@ "com.amazonaws.ec2#DescribeLaunchTemplatesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" } }, "LaunchTemplateNames": { @@ -17654,11 +18262,10 @@ "smithy.api#xmlName": "LaunchTemplateName" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeLaunchTemplatesMaxResults", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value. This value\n can be between 1 and 200.

" } }, "DryRun": { @@ -17667,32 +18274,24 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, "LaunchTemplateIds": { "target": "com.amazonaws.ec2#LaunchTemplateIdStringList", "traits": { "smithy.api#documentation": "

One or more launch template IDs.

", "smithy.api#xmlName": "LaunchTemplateId" } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } } } }, "com.amazonaws.ec2#DescribeLaunchTemplatesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, "LaunchTemplates": { "target": "com.amazonaws.ec2#LaunchTemplateSet", "traits": { @@ -17700,6 +18299,14 @@ "smithy.api#documentation": "

Information about the launch templates.

", "smithy.api#xmlName": "launchTemplates" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is\n null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } } } }, @@ -17712,57 +18319,55 @@ "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the associations between virtual interface groups and local gateway route tables.

" + "smithy.api#documentation": "

Describes the associations between virtual interface groups and local gateway route tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTableVirtualInterfaceGroupAssociations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest": { "type": "structure", "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet", - "traits": { - "smithy.api#documentation": "

The IDs of the associations.

", - "smithy.api#xmlName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The token for the next page of results.

" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "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.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "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.

" + } } } }, "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult": { "type": "structure", "members": { - "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", - "smithy.api#documentation": "

Information about the associations.

", - "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -17770,6 +18375,14 @@ "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#xmlName": "nextToken" } + }, + "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet", + "smithy.api#documentation": "

Information about the associations.

", + "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet" + } } } }, @@ -17782,7 +18395,13 @@ "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified associations between VPCs and local gateway route tables.

" + "smithy.api#documentation": "

Describes the specified associations between VPCs and local gateway route tables.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTableVpcAssociations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLocalGatewayRouteTableVpcAssociationsRequest": { @@ -17795,16 +18414,11 @@ "smithy.api#xmlName": "LocalGatewayRouteTableVpcAssociationId" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", - "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.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "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#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" } }, "NextToken": { @@ -17813,11 +18427,16 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" + "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.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" } } } @@ -17852,7 +18471,13 @@ "target": "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more local gateway route tables. By default, all local gateway route tables are described.\n Alternatively, you can filter the results.

" + "smithy.api#documentation": "

Describes one or more local gateway route tables. By default, all local gateway route tables are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayRouteTables", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLocalGatewayRouteTablesRequest": { @@ -17864,17 +18489,17 @@ "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.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "LocalGatewayRouteTableIds": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableIdSet", "traits": { - "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#documentation": "

The IDs of the local gateway route tables.

", + "smithy.api#xmlName": "LocalGatewayRouteTableId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" + "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.

" } }, "NextToken": { @@ -17883,11 +18508,11 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, - "LocalGatewayRouteTableIds": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableIdSet", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The IDs of the local gateway route tables.

", - "smithy.api#xmlName": "LocalGatewayRouteTableId" + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" } } } @@ -17922,25 +18547,30 @@ "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified local gateway virtual interface groups.

" + "smithy.api#documentation": "

Describes the specified local gateway virtual interface groups.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayVirtualInterfaceGroups", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The token for the next page of results.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "LocalGatewayVirtualInterfaceGroupIds": { "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupIdSet", "traits": { @@ -17954,10 +18584,11 @@ "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.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "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#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" } } } @@ -17965,14 +18596,6 @@ "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfaceGroupsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "LocalGatewayVirtualInterfaceGroups": { "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupSet", "traits": { @@ -17980,6 +18603,14 @@ "smithy.api#documentation": "

The virtual interface groups.

", "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -17992,7 +18623,13 @@ "target": "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified local gateway virtual interfaces.

" + "smithy.api#documentation": "

Describes the specified local gateway virtual interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGatewayVirtualInterfaces", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesRequest": { @@ -18010,11 +18647,10 @@ "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.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more filters.

", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token for the next page of results.

" } }, "LocalGatewayVirtualInterfaceIds": { @@ -18024,10 +18660,11 @@ "smithy.api#xmlName": "LocalGatewayVirtualInterfaceId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

One or more filters.

", + "smithy.api#xmlName": "Filter" } } } @@ -18035,14 +18672,6 @@ "com.amazonaws.ec2#DescribeLocalGatewayVirtualInterfacesResult": { "type": "structure", "members": { - "LocalGatewayVirtualInterfaces": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceSet", - "smithy.api#documentation": "

Information about the virtual interfaces.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -18050,6 +18679,14 @@ "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#xmlName": "nextToken" } + }, + "LocalGatewayVirtualInterfaces": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceSet", + "smithy.api#documentation": "

Information about the virtual interfaces.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceSet" + } } } }, @@ -18062,19 +18699,18 @@ "target": "com.amazonaws.ec2#DescribeLocalGatewaysResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more local gateways. By default, all local gateways are described. \n Alternatively, you can filter the results.

" + "smithy.api#documentation": "

Describes one or more local gateways. By default, all local gateways are described. \n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LocalGateways", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeLocalGatewaysRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

", - "smithy.api#xmlName": "Filter" - } - }, "LocalGatewayIds": { "target": "com.amazonaws.ec2#LocalGatewayIdSet", "traits": { @@ -18082,16 +18718,17 @@ "smithy.api#xmlName": "LocalGatewayId" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#LocalGatewayMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "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.

" + "smithy.api#documentation": "

One or more filters.

", + "smithy.api#xmlName": "Filter" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "MaxResults": { + "target": "com.amazonaws.ec2#LocalGatewayMaxResults", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "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.

" } }, "DryRun": { @@ -18099,6 +18736,12 @@ "traits": { "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.

" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } } }, @@ -18132,7 +18775,13 @@ "target": "com.amazonaws.ec2#DescribeManagedPrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes your managed prefix lists and any AWS-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

" + "smithy.api#documentation": "

Describes your managed prefix lists and any AWS-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixLists", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeManagedPrefixListsRequest": { @@ -18150,13 +18799,6 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#PrefixListMaxResults", "traits": { @@ -18169,20 +18811,19 @@ "smithy.api#documentation": "

One or more prefix list IDs.

", "smithy.api#xmlName": "PrefixListId" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } } } }, "com.amazonaws.ec2#DescribeManagedPrefixListsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "PrefixLists": { "target": "com.amazonaws.ec2#ManagedPrefixListSet", "traits": { @@ -18190,6 +18831,14 @@ "smithy.api#documentation": "

Information about the prefix lists.

", "smithy.api#xmlName": "prefixListSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -18202,7 +18851,13 @@ "target": "com.amazonaws.ec2#DescribeMovingAddressesResult" }, "traits": { - "smithy.api#documentation": "

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" + "smithy.api#documentation": "

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MovingAddressStatuses", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeMovingAddressesMaxResults": { @@ -18225,6 +18880,14 @@ "smithy.api#xmlName": "dryRun" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeMovingAddressesMaxResults", "traits": { @@ -18248,28 +18911,12 @@ "smithy.api#documentation": "

One or more Elastic IP addresses.

", "smithy.api#xmlName": "publicIp" } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#xmlName": "nextToken" - } } } }, "com.amazonaws.ec2#DescribeMovingAddressesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "MovingAddressStatuses": { "target": "com.amazonaws.ec2#MovingAddressStatusSet", "traits": { @@ -18277,6 +18924,14 @@ "smithy.api#documentation": "

The status for each Elastic IP address.

", "smithy.api#xmlName": "movingAddressStatusSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -18289,7 +18944,13 @@ "target": "com.amazonaws.ec2#DescribeNatGatewaysResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your NAT gateways.

" + "smithy.api#documentation": "

Describes one or more of your NAT gateways.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NatGateways", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeNatGatewaysMaxResults": { @@ -18310,29 +18971,29 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n " - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, + "NatGatewayIds": { + "target": "com.amazonaws.ec2#NatGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more NAT gateway IDs.

", + "smithy.api#xmlName": "NatGatewayId" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeNatGatewaysMaxResults", "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.

" } }, - "NatGatewayIds": { - "target": "com.amazonaws.ec2#NatGatewayIdStringList", + "Filter": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more NAT gateway IDs.

", - "smithy.api#xmlName": "NatGatewayId" + "smithy.api#documentation": "

One or more filters.

\n " } } } @@ -18367,7 +19028,13 @@ "target": "com.amazonaws.ec2#DescribeNetworkAclsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your network ACLs.

\n\t\t

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Describes one or more of your network ACLs.

\n\t\t

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkAcls", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeNetworkAclsMaxResults": { @@ -18382,6 +19049,18 @@ "com.amazonaws.ec2#DescribeNetworkAclsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsMaxResults", + "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.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -18390,13 +19069,6 @@ "smithy.api#xmlName": "dryRun" } }, - "NetworkAclIds": { - "target": "com.amazonaws.ec2#NetworkAclIdStringList", - "traits": { - "smithy.api#documentation": "

One or more network ACL IDs.

\n\t\t

Default: Describes all your network ACLs.

", - "smithy.api#xmlName": "NetworkAclId" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -18404,16 +19076,11 @@ "smithy.api#xmlName": "Filter" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNetworkAclsMaxResults", + "NetworkAclIds": { + "target": "com.amazonaws.ec2#NetworkAclIdStringList", "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.

" + "smithy.api#documentation": "

One or more network ACL IDs.

\n\t\t

Default: Describes all your network ACLs.

", + "smithy.api#xmlName": "NetworkAclId" } } } @@ -18503,12 +19170,12 @@ "smithy.api#xmlName": "description" } }, - "Attachment": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

The attachment (if any) of the network interface.

", - "smithy.api#xmlName": "attachment" + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", + "smithy.api#xmlName": "sourceDestCheck" } }, "NetworkInterfaceId": { @@ -18519,12 +19186,12 @@ "smithy.api#xmlName": "networkInterfaceId" } }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.

", - "smithy.api#xmlName": "sourceDestCheck" + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The attachment (if any) of the network interface.

", + "smithy.api#xmlName": "attachment" } } }, @@ -18541,7 +19208,13 @@ "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsResult" }, "traits": { - "smithy.api#documentation": "

Describes the permissions for your network interfaces.

" + "smithy.api#documentation": "

Describes the permissions for your network interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInterfacePermissions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults": { @@ -18556,18 +19229,6 @@ "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results,\n\t\t\tmake another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.

" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -18581,6 +19242,18 @@ "smithy.api#documentation": "

One or more network interface permission IDs.

", "smithy.api#xmlName": "NetworkInterfacePermissionId" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacePermissionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining results,\n\t\t\tmake another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.

" + } } }, "traits": { @@ -18620,7 +19293,13 @@ "target": "com.amazonaws.ec2#DescribeNetworkInterfacesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your network interfaces.

" + "smithy.api#documentation": "

Describes one or more of your network interfaces.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NetworkInterfaces", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults": { @@ -18635,17 +19314,12 @@ "com.amazonaws.ec2#DescribeNetworkInterfacesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#NetworkInterfaceIdList", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more network interface IDs.

\n\t\t

Default: Describes all your network interfaces.

", - "smithy.api#xmlName": "NetworkInterfaceId" + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#xmlName": "filter" } }, "MaxResults": { @@ -18654,6 +19328,12 @@ "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you\n can specify in a subsequent call to get the next set of results. You cannot specify this\n parameter and the network interface IDs parameter in the same request.

" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -18662,12 +19342,11 @@ "smithy.api#xmlName": "dryRun" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#NetworkInterfaceIdList", "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

One or more filters.

\n\t\t ", - "smithy.api#xmlName": "filter" + "smithy.api#documentation": "

One or more network interface IDs.

\n\t\t

Default: Describes all your network interfaces.

", + "smithy.api#xmlName": "NetworkInterfaceId" } } }, @@ -18721,14 +19400,6 @@ "smithy.api#xmlName": "GroupId" } }, - "GroupNames": { - "target": "com.amazonaws.ec2#PlacementGroupStringList", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The names of the placement groups.

\n

Default: Describes all your placement groups, or only those otherwise\n specified.

", - "smithy.api#xmlName": "groupName" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -18743,6 +19414,14 @@ "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } + }, + "GroupNames": { + "target": "com.amazonaws.ec2#PlacementGroupStringList", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The names of the placement groups.

\n

Default: Describes all your placement groups, or only those otherwise\n specified.

", + "smithy.api#xmlName": "groupName" + } } } }, @@ -18768,42 +19447,48 @@ "target": "com.amazonaws.ec2#DescribePrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes available AWS services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

" + "smithy.api#documentation": "

Describes available AWS services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixLists", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribePrefixListsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListResourceIdStringList", + "traits": { + "smithy.api#documentation": "

One or more prefix list IDs.

", + "smithy.api#xmlName": "PrefixListId" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "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.

" } }, - "PrefixListIds": { - "target": "com.amazonaws.ec2#PrefixListResourceIdStringList", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more prefix list IDs.

", - "smithy.api#xmlName": "PrefixListId" + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" } } } @@ -18811,14 +19496,6 @@ "com.amazonaws.ec2#DescribePrefixListsResult": { "type": "structure", "members": { - "PrefixLists": { - "target": "com.amazonaws.ec2#PrefixListSet", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListSet", - "smithy.api#documentation": "

All available prefix lists.

", - "smithy.api#xmlName": "prefixListSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -18826,6 +19503,14 @@ "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#xmlName": "nextToken" } + }, + "PrefixLists": { + "target": "com.amazonaws.ec2#PrefixListSet", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListSet", + "smithy.api#documentation": "

All available prefix lists.

", + "smithy.api#xmlName": "prefixListSet" + } } } }, @@ -18838,7 +19523,13 @@ "target": "com.amazonaws.ec2#DescribePrincipalIdFormatResult" }, "traits": { - "smithy.api#documentation": "

Describes the ID format settings for the root user and all IAM roles and IAM users\n that have explicitly specified a longer ID (17-character ID) preference.

\n

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they\n explicitly override the settings. This request is useful for identifying those IAM users and IAM roles\n that have overridden the default ID settings.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

" + "smithy.api#documentation": "

Describes the ID format settings for the root user and all IAM roles and IAM users\n that have explicitly specified a longer ID (17-character ID) preference.

\n

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they\n explicitly override the settings. This request is useful for identifying those IAM users and IAM roles\n that have overridden the default ID settings.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Principals", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults": { @@ -18853,12 +19544,6 @@ "com.amazonaws.ec2#DescribePrincipalIdFormatRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" - } - }, "Resources": { "target": "com.amazonaws.ec2#ResourceList", "traits": { @@ -18866,16 +19551,22 @@ "smithy.api#xmlName": "Resource" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#DescribePrincipalIdFormatMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The token to request the next page of results.

" } } } @@ -18883,14 +19574,6 @@ "com.amazonaws.ec2#DescribePrincipalIdFormatResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "Principals": { "target": "com.amazonaws.ec2#PrincipalIdFormatList", "traits": { @@ -18898,6 +19581,14 @@ "smithy.api#documentation": "

Information about the ID format settings for the ARN.

", "smithy.api#xmlName": "principalSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -18910,12 +19601,24 @@ "target": "com.amazonaws.ec2#DescribePublicIpv4PoolsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified IPv4 address pools.

" + "smithy.api#documentation": "

Describes the specified IPv4 address pools.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PublicIpv4Pools", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribePublicIpv4PoolsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#PoolMaxResults", + "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.

" + } + }, "PoolIds": { "target": "com.amazonaws.ec2#PublicIpv4PoolIdStringList", "traits": { @@ -18930,12 +19633,6 @@ "smithy.api#xmlName": "Filter" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#PoolMaxResults", - "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.ec2#NextToken", "traits": { @@ -18980,12 +19677,17 @@ "com.amazonaws.ec2#DescribeRegionsRequest": { "type": "structure", "members": { - "DryRun": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "AllRegions": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

Indicates whether to display all Regions, including Regions that are disabled for your account.

" } }, "RegionNames": { @@ -18995,17 +19697,12 @@ "smithy.api#xmlName": "RegionName" } }, - "AllRegions": { + "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether to display all Regions, including Regions that are disabled for your account.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" + "aws.protocols#ec2QueryName": "DryRun", + "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" } } } @@ -19103,7 +19800,12 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

\n \t

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

\n \t

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedInstancesModifications" + } } }, "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest": { @@ -19116,13 +19818,6 @@ "smithy.api#xmlName": "Filter" } }, - "ReservedInstancesModificationIds": { - "target": "com.amazonaws.ec2#ReservedInstancesModificationIdStringList", - "traits": { - "smithy.api#documentation": "

IDs for the submitted modification request.

", - "smithy.api#xmlName": "ReservedInstancesModificationId" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -19130,6 +19825,13 @@ "smithy.api#documentation": "

The token to retrieve the next page of results.

", "smithy.api#xmlName": "nextToken" } + }, + "ReservedInstancesModificationIds": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationIdStringList", + "traits": { + "smithy.api#documentation": "

IDs for the submitted modification request.

", + "smithy.api#xmlName": "ReservedInstancesModificationId" + } } }, "traits": { @@ -19169,30 +19871,51 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult" }, "traits": { - "smithy.api#documentation": "

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

\n

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

\n

For more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

\n

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

\n

For more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReservedInstancesOfferings", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeReservedInstancesOfferingsRequest": { "type": "structure", "members": { - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The offering class of the Reserved Instance. Can be standard or convertible.

" + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n\t\t

Default: 100

", + "smithy.api#xmlName": "maxResults" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "MaxInstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The maximum number of instances to filter when searching for offerings.

\n\t\t

Default: 20

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxDuration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

The maximum duration (in seconds) to filter when searching for offerings.

\n\t\t

Default: 94608000 (3 years)

" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", + "smithy.api#xmlName": "offeringType" } }, "ProductDescription": { @@ -19209,32 +19932,17 @@ "smithy.api#xmlName": "dryRun" } }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

" - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy\n of dedicated is applied to instances that run in a VPC on single-tenant hardware\n (i.e., Dedicated Instances).

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", + "ReservedInstancesOfferingIds": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList", "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", - "smithy.api#xmlName": "offeringType" + "smithy.api#documentation": "

One or more Reserved Instances offering IDs.

", + "smithy.api#xmlName": "ReservedInstancesOfferingId" } }, - "MinDuration": { - "target": "com.amazonaws.ec2#Long", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "

The minimum duration (in seconds) to filter when searching for offerings.

\n\t\t

Default: 2592000 (1 month)

" + "smithy.api#documentation": "

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "IncludeMarketplace": { @@ -19243,38 +19951,38 @@ "smithy.api#documentation": "

Include Reserved Instance Marketplace offerings in the response.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The offering class of the Reserved Instance. Can be standard or convertible.

" } }, - "MaxDuration": { - "target": "com.amazonaws.ec2#Long", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The maximum duration (in seconds) to filter when searching for offerings.

\n\t\t

Default: 94608000 (3 years)

" + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to retrieve the next page of results.

", + "smithy.api#xmlName": "nextToken" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n\t\t

Default: 100

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy\n of dedicated is applied to instances that run in a VPC on single-tenant hardware\n (i.e., Dedicated Instances).

\n

\n Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

\n

Default: default\n

", + "smithy.api#xmlName": "instanceTenancy" } }, - "MaxInstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The maximum number of instances to filter when searching for offerings.

\n\t\t

Default: 20

" + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

" } }, - "ReservedInstancesOfferingIds": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingIdStringList", + "MinDuration": { + "target": "com.amazonaws.ec2#Long", "traits": { - "smithy.api#documentation": "

One or more Reserved Instances offering IDs.

", - "smithy.api#xmlName": "ReservedInstancesOfferingId" + "smithy.api#documentation": "

The minimum duration (in seconds) to filter when searching for offerings.

\n\t\t

Default: 2592000 (1 month)

" } } }, @@ -19285,14 +19993,6 @@ "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult": { "type": "structure", "members": { - "ReservedInstancesOfferings": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesOfferingsSet", - "smithy.api#documentation": "

A list of Reserved Instances offerings.

", - "smithy.api#xmlName": "reservedInstancesOfferingsSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -19300,6 +20000,14 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "ReservedInstancesOfferings": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingsSet", + "smithy.api#documentation": "

A list of Reserved Instances offerings.

", + "smithy.api#xmlName": "reservedInstancesOfferingsSet" + } } }, "traits": { @@ -19316,6 +20024,19 @@ "smithy.api#xmlName": "ReservedInstancesId" } }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "smithy.api#documentation": "

Describes whether the Reserved Instance is Standard or Convertible.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, "OfferingType": { "target": "com.amazonaws.ec2#OfferingTypeValues", "traits": { @@ -19331,19 +20052,6 @@ "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" } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", - "traits": { - "smithy.api#documentation": "

Describes whether the Reserved Instance is Standard or Convertible.

" - } } }, "traits": { @@ -19375,7 +20083,13 @@ "target": "com.amazonaws.ec2#DescribeRouteTablesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your route tables.

\n

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

\n\t\t

For more information, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Describes one or more of your route tables.

\n

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

\n\t\t

For more information, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RouteTables", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeRouteTablesMaxResults": { @@ -19390,13 +20104,6 @@ "com.amazonaws.ec2#DescribeRouteTablesRequest": { "type": "structure", "members": { - "RouteTableIds": { - "target": "com.amazonaws.ec2#RouteTableIdStringList", - "traits": { - "smithy.api#documentation": "

One or more route table IDs.

\n\t\t

Default: Describes all your route tables.

", - "smithy.api#xmlName": "RouteTableId" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -19405,6 +20112,12 @@ "smithy.api#xmlName": "dryRun" } }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeRouteTablesMaxResults", + "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.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -19412,16 +20125,17 @@ "smithy.api#xmlName": "Filter" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "RouteTableIds": { + "target": "com.amazonaws.ec2#RouteTableIdStringList", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

One or more route table IDs.

\n\t\t

Default: Describes all your route tables.

", + "smithy.api#xmlName": "RouteTableId" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeRouteTablesMaxResults", + "NextToken": { + "target": "com.amazonaws.ec2#String", "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.

" + "smithy.api#documentation": "

The token for the next page of results.

" } } } @@ -19459,7 +20173,13 @@ "target": "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityResult" }, "traits": { - "smithy.api#documentation": "

Finds available schedules that meet the specified criteria.

\n

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

\n

After you find a schedule that meets your needs, call PurchaseScheduledInstances\n to purchase Scheduled Instances with that schedule.

" + "smithy.api#documentation": "

Finds available schedules that meet the specified criteria.

\n

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

\n

After you find a schedule that meets your needs, call PurchaseScheduledInstances\n to purchase Scheduled Instances with that schedule.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledInstanceAvailabilitySet", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityMaxResults": { @@ -19474,6 +20194,12 @@ "com.amazonaws.ec2#DescribeScheduledInstanceAvailabilityRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "FirstSlotStartTimeRange": { "target": "com.amazonaws.ec2#SlotDateTimeRangeRequest", "traits": { @@ -19481,22 +20207,24 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "MinSlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "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#documentation": "

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" } }, - "MaxSlotDurationInHours": { - "target": "com.amazonaws.ec2#Integer", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours\n and less than 1,720.

" + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" } }, "MaxResults": { @@ -19505,24 +20233,16 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 300.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token for the next set of results.

" } }, - "MinSlotDurationInHours": { + "MaxSlotDurationInHours": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" - } - }, - "Recurrence": { - "target": "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest", - "traits": { - "smithy.api#documentation": "

The schedule recurrence.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours\n and less than 1,720.

" } } }, @@ -19563,22 +20283,22 @@ "target": "com.amazonaws.ec2#DescribeScheduledInstancesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified Scheduled Instances or all your Scheduled Instances.

" + "smithy.api#documentation": "

Describes the specified Scheduled Instances or all your Scheduled Instances.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledInstanceSet", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeScheduledInstancesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 100.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" + "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.

" } }, "ScheduledInstanceIds": { @@ -19588,17 +20308,10 @@ "smithy.api#xmlName": "ScheduledInstanceId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The token for the next set of results.

" } }, "SlotStartTimeRange": { @@ -19606,6 +20319,19 @@ "traits": { "smithy.api#documentation": "

The time period for the first schedule to start.

" } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. \n This value can be between 5 and 300. The default value is 100.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -19651,18 +20377,18 @@ "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "GroupId": { "target": "com.amazonaws.ec2#GroupIds", "traits": { "smithy.api#documentation": "

The IDs of the security groups in your account.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -19688,7 +20414,13 @@ "target": "com.amazonaws.ec2#DescribeSecurityGroupsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroups", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults": { @@ -19703,6 +20435,12 @@ "com.amazonaws.ec2#DescribeSecurityGroupsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to request the next page of results.

" + } + }, "GroupIds": { "target": "com.amazonaws.ec2#GroupIdStringList", "traits": { @@ -19710,23 +20448,17 @@ "smithy.api#xmlName": "GroupId" } }, - "GroupNames": { - "target": "com.amazonaws.ec2#GroupNameStringList", - "traits": { - "smithy.api#documentation": "

[EC2-Classic and default VPC only] The names of the security groups. You can specify either\n\t\t\tthe security group name or the security group ID. For security groups in a nondefault VPC, use\n\t\t\tthe group-name filter to describe security groups by name.

\n

Default: Describes all your security groups.

", - "smithy.api#xmlName": "GroupName" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeSecurityGroupsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another request with the returned NextToken value. This value\n can be between 5 and 1000. If this parameter is not specified, then all results are\n returned.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "GroupNames": { + "target": "com.amazonaws.ec2#GroupNameStringList", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

" + "smithy.api#documentation": "

[EC2-Classic and default VPC only] The names of the security groups. You can specify either\n\t\t\tthe security group name or the security group ID. For security groups in a nondefault VPC, use\n\t\t\tthe group-name filter to describe security groups by name.

\n

Default: Describes all your security groups.

", + "smithy.api#xmlName": "GroupName" } }, "Filters": { @@ -19782,13 +20514,6 @@ "com.amazonaws.ec2#DescribeSnapshotAttributeRequest": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", - "traits": { - "smithy.api#documentation": "

The ID of the EBS snapshot.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -19803,6 +20528,13 @@ "smithy.api#documentation": "

The snapshot attribute you would like to view.

", "smithy.api#required": {} } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the EBS snapshot.

", + "smithy.api#required": {} + } } } }, @@ -19817,14 +20549,6 @@ "smithy.api#xmlName": "snapshotId" } }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes.

", - "smithy.api#xmlName": "productCodes" - } - }, "CreateVolumePermissions": { "target": "com.amazonaws.ec2#CreateVolumePermissionList", "traits": { @@ -19832,6 +20556,14 @@ "smithy.api#documentation": "

The users and groups that have the permissions for creating volumes from the\n snapshot.

", "smithy.api#xmlName": "createVolumePermission" } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } } } }, @@ -19844,7 +20576,13 @@ "target": "com.amazonaws.ec2#DescribeSnapshotsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other AWS accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or AWS accounts with create volume permissions. If no options are specified, Amazon\n EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the AWS account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify AWS account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. The MaxResults parameter sets the maximum number of results\n returned in a single page. If the list of results exceeds your MaxResults value,\n then that number of results is returned along with a NextToken value that can be\n passed to a subsequent DescribeSnapshots request to retrieve the remaining\n results.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other AWS accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n \n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or AWS accounts with create volume permissions. If no options are specified, Amazon\n EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the AWS account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify AWS account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. The MaxResults parameter sets the maximum number of results\n returned in a single page. If the list of results exceeds your MaxResults value,\n then that number of results is returned along with a NextToken value that can be\n passed to a subsequent DescribeSnapshots request to retrieve the remaining\n results.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Snapshots", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeSnapshotsRequest": { @@ -19857,18 +20595,16 @@ "smithy.api#xmlName": "RestorableBy" } }, - "SnapshotIds": { - "target": "com.amazonaws.ec2#SnapshotIdStringList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The snapshot IDs.

\n

Default: Describes the snapshots for which you have create volume permissions.

", - "smithy.api#xmlName": "SnapshotId" + "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n DescribeSnapshots request where MaxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the NextToken value. This value is\n null when there are no more results to return.

" } }, - "OwnerIds": { - "target": "com.amazonaws.ec2#OwnerStringList", + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

Scopes the results to snapshots with the specified owners. You can specify a combination of\n AWS account IDs, self, and amazon.

", - "smithy.api#xmlName": "Owner" + "smithy.api#documentation": "

The maximum number of snapshot results returned by DescribeSnapshots in\n paginated output. When this parameter is used, DescribeSnapshots only returns\n MaxResults results in a single page along with a NextToken\n response element. The remaining results of the initial request can be seen by sending another\n DescribeSnapshots request with the returned NextToken value. This\n value can be between 5 and 1000; if MaxResults is given a value larger than 1000,\n only 1000 results are returned. If this parameter is not used, then\n DescribeSnapshots returns all results. You cannot specify this parameter and\n the snapshot IDs parameter in the same request.

" } }, "Filters": { @@ -19886,16 +20622,18 @@ "smithy.api#xmlName": "dryRun" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "OwnerIds": { + "target": "com.amazonaws.ec2#OwnerStringList", "traits": { - "smithy.api#documentation": "

The maximum number of snapshot results returned by DescribeSnapshots in\n paginated output. When this parameter is used, DescribeSnapshots only returns\n MaxResults results in a single page along with a NextToken\n response element. The remaining results of the initial request can be seen by sending another\n DescribeSnapshots request with the returned NextToken value. This\n value can be between 5 and 1000; if MaxResults is given a value larger than 1000,\n only 1000 results are returned. If this parameter is not used, then\n DescribeSnapshots returns all results. You cannot specify this parameter and\n the snapshot IDs parameter in the same request.

" + "smithy.api#documentation": "

Scopes the results to snapshots with the specified owners. You can specify a combination of\n AWS account IDs, self, and amazon.

", + "smithy.api#xmlName": "Owner" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "SnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", "traits": { - "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n DescribeSnapshots request where MaxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the NextToken value. This value is\n null when there are no more results to return.

" + "smithy.api#documentation": "

The snapshot IDs.

\n

Default: Describes the snapshots for which you have create volume permissions.

", + "smithy.api#xmlName": "SnapshotId" } } } @@ -19989,14 +20727,6 @@ "com.amazonaws.ec2#DescribeSpotFleetInstancesRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults", "traits": { @@ -20005,6 +20735,15 @@ "smithy.api#xmlName": "maxResults" } }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -20013,13 +20752,12 @@ "smithy.api#xmlName": "nextToken" } }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#SpotFleetRequestId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestId" + "aws.protocols#ec2QueryName": "DryRun", + "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" } } }, @@ -20030,12 +20768,12 @@ "com.amazonaws.ec2#DescribeSpotFleetInstancesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", + "ActiveInstances": { + "target": "com.amazonaws.ec2#ActiveInstanceSet", "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" + "aws.protocols#ec2QueryName": "ActiveInstanceSet", + "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", + "smithy.api#xmlName": "activeInstanceSet" } }, "SpotFleetRequestId": { @@ -20046,12 +20784,12 @@ "smithy.api#xmlName": "spotFleetRequestId" } }, - "ActiveInstances": { - "target": "com.amazonaws.ec2#ActiveInstanceSet", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ActiveInstanceSet", - "smithy.api#documentation": "

The running instances. This list is refreshed periodically and might be out of\n date.

", - "smithy.api#xmlName": "activeInstanceSet" + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" } } }, @@ -20083,12 +20821,12 @@ "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryRequest": { "type": "structure", "members": { - "EventType": { - "target": "com.amazonaws.ec2#EventType", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

", - "smithy.api#xmlName": "eventType" + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#xmlName": "nextToken" } }, "SpotFleetRequestId": { @@ -20100,14 +20838,6 @@ "smithy.api#xmlName": "spotFleetRequestId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#xmlName": "nextToken" - } - }, "StartTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -20117,14 +20847,6 @@ "smithy.api#xmlName": "startTime" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults", "traits": { @@ -20132,6 +20854,22 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call. \n Specify a value between 1 and 1000. The default value is 1000. \n To retrieve the remaining results, make another call with the returned\n NextToken value.

", "smithy.api#xmlName": "maxResults" } + }, + "EventType": { + "target": "com.amazonaws.ec2#EventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The type of events to describe. By default, all events are described.

", + "smithy.api#xmlName": "eventType" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } }, "traits": { @@ -20141,14 +20879,6 @@ "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse": { "type": "structure", "members": { - "HistoryRecords": { - "target": "com.amazonaws.ec2#HistoryRecords", - "traits": { - "aws.protocols#ec2QueryName": "HistoryRecordSet", - "smithy.api#documentation": "

Information about the events in the history of the Spot Fleet request.

", - "smithy.api#xmlName": "historyRecordSet" - } - }, "StartTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -20157,12 +20887,12 @@ "smithy.api#xmlName": "startTime" } }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", + "LastEvaluatedTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" + "aws.protocols#ec2QueryName": "LastEvaluatedTime", + "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more results, this value is not present.

", + "smithy.api#xmlName": "lastEvaluatedTime" } }, "NextToken": { @@ -20173,12 +20903,20 @@ "smithy.api#xmlName": "nextToken" } }, - "LastEvaluatedTime": { - "target": "com.amazonaws.ec2#DateTime", + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LastEvaluatedTime", - "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more results, this value is not present.

", - "smithy.api#xmlName": "lastEvaluatedTime" + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" + } + }, + "HistoryRecords": { + "target": "com.amazonaws.ec2#HistoryRecords", + "traits": { + "aws.protocols#ec2QueryName": "HistoryRecordSet", + "smithy.api#documentation": "

Information about the events in the history of the Spot Fleet request.

", + "smithy.api#xmlName": "historyRecordSet" } } }, @@ -20195,20 +20933,18 @@ "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse" }, "traits": { - "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

" + "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotFleetRequestConfigs", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeSpotFleetRequestsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -20217,12 +20953,12 @@ "smithy.api#xmlName": "maxResults" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#xmlName": "nextToken" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "SpotFleetRequestIds": { @@ -20232,6 +20968,14 @@ "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", "smithy.api#xmlName": "spotFleetRequestId" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#xmlName": "nextToken" + } } }, "traits": { @@ -20271,7 +21015,13 @@ "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a\n\t\trunning Spot Instance by examining the response. If the status of\n\t\tthe Spot Instance is fulfilled, the instance ID \n\t\tappears in the response and contains the identifier of the instance.\n\t\tAlternatively, you can use DescribeInstances with a filter to\n\t\tlook for instances where the instance lifecycle is spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.

\n\t

Spot Instance requests are deleted four hours after they are canceled and their instances\n are terminated.

" + "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a\n\t\trunning Spot Instance by examining the response. If the status of\n\t\tthe Spot Instance is fulfilled, the instance ID \n\t\tappears in the response and contains the identifier of the instance.\n\t\tAlternatively, you can use DescribeInstances with a filter to\n\t\tlook for instances where the instance lifecycle is spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.

\n\t

Spot Instance requests are deleted four hours after they are canceled and their instances\n are terminated.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotInstanceRequests", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest": { @@ -20283,12 +21033,17 @@ "smithy.api#documentation": "

The token to request the next set of results. This value is null when\n there are no more results to return.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. Specify a value between 5\n and 1000. To retrieve the remaining results, make another call with the returned\n NextToken value.

" } }, "SpotInstanceRequestIds": { @@ -20298,17 +21053,12 @@ "smithy.api#xmlName": "SpotInstanceRequestId" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. Specify a value between 5\n and 1000. To retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" + "aws.protocols#ec2QueryName": "DryRun", + "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" } } }, @@ -20319,14 +21069,6 @@ "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult": { "type": "structure", "members": { - "SpotInstanceRequests": { - "target": "com.amazonaws.ec2#SpotInstanceRequestList", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", - "smithy.api#documentation": "

One or more Spot Instance requests.

", - "smithy.api#xmlName": "spotInstanceRequestSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -20334,6 +21076,14 @@ "smithy.api#documentation": "

The token to use to retrieve the next set of results. This value is null\n when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "SpotInstanceRequests": { + "target": "com.amazonaws.ec2#SpotInstanceRequestList", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestSet", + "smithy.api#documentation": "

One or more Spot Instance requests.

", + "smithy.api#xmlName": "spotInstanceRequestSet" + } } }, "traits": { @@ -20349,12 +21099,25 @@ "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryResult" }, "traits": { - "smithy.api#documentation": "

Describes the Spot price history. For more information, see\n\t\tSpot Instance pricing history \n in the Amazon EC2 User Guide for Linux Instances.

\n\t

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. \n\t The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + "smithy.api#documentation": "

Describes the Spot price history. For more information, see\n\t\tSpot Instance pricing history \n in the Amazon EC2 User Guide for Linux Instances.

\n\t

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. \n\t The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SpotPriceHistory", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, "EndTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -20363,6 +21126,21 @@ "smithy.api#xmlName": "endTime" } }, + "ProductDescriptions": { + "target": "com.amazonaws.ec2#ProductDescriptionList", + "traits": { + "smithy.api#documentation": "

Filters the results by the specified basic product descriptions.

", + "smithy.api#xmlName": "ProductDescription" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, "InstanceTypes": { "target": "com.amazonaws.ec2#InstanceTypeList", "traits": { @@ -20370,12 +21148,12 @@ "smithy.api#xmlName": "InstanceType" } }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price history data, \n in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "startTime" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "NextToken": { @@ -20394,34 +21172,12 @@ "smithy.api#xmlName": "maxResults" } }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "ProductDescriptions": { - "target": "com.amazonaws.ec2#ProductDescriptionList", + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

Filters the results by the specified basic product descriptions.

", - "smithy.api#xmlName": "ProductDescription" + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price history data, \n in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" } } }, @@ -20432,14 +21188,6 @@ "com.amazonaws.ec2#DescribeSpotPriceHistoryResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null or an empty\n string when there are no more results to return.

", - "smithy.api#xmlName": "nextToken" - } - }, "SpotPriceHistory": { "target": "com.amazonaws.ec2#SpotPriceHistoryList", "traits": { @@ -20447,6 +21195,14 @@ "smithy.api#documentation": "

The historical Spot prices.

", "smithy.api#xmlName": "spotPriceHistorySet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null or an empty\n string when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } } }, "traits": { @@ -20462,7 +21218,13 @@ "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsResult" }, "traits": { - "smithy.api#documentation": "

[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" + "smithy.api#documentation": "

[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StaleSecurityGroupSet", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeStaleSecurityGroupsMaxResults": { @@ -20498,18 +21260,18 @@ "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -20543,7 +21305,13 @@ "target": "com.amazonaws.ec2#DescribeSubnetsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your subnets.

\n

For more information, see Your VPC and Subnets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Describes one or more of your subnets.

\n

For more information, see Your VPC and Subnets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subnets", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeSubnetsMaxResults": { @@ -20558,6 +21326,12 @@ "com.amazonaws.ec2#DescribeSubnetsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSubnetsMaxResults", + "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.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -20566,10 +21340,11 @@ "smithy.api#xmlName": "dryRun" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSubnetsMaxResults", + "SubnetIds": { + "target": "com.amazonaws.ec2#SubnetIdStringList", "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.

" + "smithy.api#documentation": "

One or more subnet IDs.

\n\t\t

Default: Describes all your subnets.

", + "smithy.api#xmlName": "SubnetId" } }, "NextToken": { @@ -20584,27 +21359,12 @@ "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } - }, - "SubnetIds": { - "target": "com.amazonaws.ec2#SubnetIdStringList", - "traits": { - "smithy.api#documentation": "

One or more subnet IDs.

\n\t\t

Default: Describes all your subnets.

", - "smithy.api#xmlName": "SubnetId" - } } } }, "com.amazonaws.ec2#DescribeSubnetsResult": { "type": "structure", "members": { - "Subnets": { - "target": "com.amazonaws.ec2#SubnetList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetSet", - "smithy.api#documentation": "

Information about one or more subnets.

", - "smithy.api#xmlName": "subnetSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -20612,6 +21372,14 @@ "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#xmlName": "nextToken" } + }, + "Subnets": { + "target": "com.amazonaws.ec2#SubnetList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetSet", + "smithy.api#documentation": "

Information about one or more subnets.

", + "smithy.api#xmlName": "subnetSet" + } } } }, @@ -20624,27 +21392,18 @@ "target": "com.amazonaws.ec2#DescribeTagsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For more information about tags, see Tagging Your Resources in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For more information about tags, see Tagging Your Resources in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTagsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -20660,6 +21419,21 @@ "smithy.api#documentation": "

The maximum number of results to return in a single call.\n This value can be between 5 and 1000. \n\t\t\tTo retrieve the remaining results, make another call with the returned NextToken value.

", "smithy.api#xmlName": "maxResults" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -20693,12 +21467,24 @@ "target": "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more Traffic Mirror filters.

" + "smithy.api#documentation": "

Describes one or more Traffic Mirror filters.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorFilters", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTrafficMirrorFiltersRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -20706,44 +21492,30 @@ "smithy.api#xmlName": "Filter" } }, - "TrafficMirrorFilterIds": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#xmlName": "TrafficMirrorFilterId" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", "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.

" } + }, + "TrafficMirrorFilterIds": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "TrafficMirrorFilterId" + } } } }, "com.amazonaws.ec2#DescribeTrafficMirrorFiltersResult": { "type": "structure", "members": { - "TrafficMirrorFilters": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterSet", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterSet", - "smithy.api#documentation": "

Information about one or more Traffic Mirror filters.

", - "smithy.api#xmlName": "trafficMirrorFilterSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -20751,6 +21523,14 @@ "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#xmlName": "nextToken" } + }, + "TrafficMirrorFilters": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterSet", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterSet", + "smithy.api#documentation": "

Information about one or more Traffic Mirror filters.

", + "smithy.api#xmlName": "trafficMirrorFilterSet" + } } } }, @@ -20763,7 +21543,13 @@ "target": "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

" + "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorSessions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTrafficMirrorSessionsRequest": { @@ -20776,19 +21562,6 @@ "smithy.api#xmlName": "TrafficMirrorSessionId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", "traits": { @@ -20800,20 +21573,25 @@ "traits": { "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.

" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } } } }, "com.amazonaws.ec2#DescribeTrafficMirrorSessionsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "TrafficMirrorSessions": { "target": "com.amazonaws.ec2#TrafficMirrorSessionSet", "traits": { @@ -20821,6 +21599,14 @@ "smithy.api#documentation": "

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", "smithy.api#xmlName": "trafficMirrorSessionSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -20833,19 +21619,18 @@ "target": "com.amazonaws.ec2#DescribeTrafficMirrorTargetsResult" }, "traits": { - "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

" + "smithy.api#documentation": "

Information about one or more Traffic Mirror targets.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficMirrorTargets", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTrafficMirrorTargetsRequest": { "type": "structure", "members": { - "TrafficMirrorTargetIds": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetIdList", - "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror targets.

", - "smithy.api#xmlName": "TrafficMirrorTargetId" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -20853,10 +21638,10 @@ "smithy.api#xmlName": "Filter" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "MaxResults": { + "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", "traits": { - "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#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": { @@ -20865,10 +21650,17 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#TrafficMirroringMaxResults", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "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.

" + "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.

" + } + }, + "TrafficMirrorTargetIds": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror targets.

", + "smithy.api#xmlName": "TrafficMirrorTargetId" } } } @@ -20903,41 +21695,47 @@ "target": "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more attachments between resources and transit gateways. By default, all attachments are described.\n Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

" + "smithy.api#documentation": "

Describes one or more attachments between resources and transit gateways. By default, all attachments are described.\n Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayAttachments", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#TransitGatewayMaxResults", "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.ec2#String", + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

The IDs of the attachments.

" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, - "TransitGatewayAttachmentIds": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IDs of the attachments.

" + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" } } } @@ -20945,14 +21743,6 @@ "com.amazonaws.ec2#DescribeTransitGatewayAttachmentsResult": { "type": "structure", "members": { - "TransitGatewayAttachments": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachments", - "smithy.api#documentation": "

Information about the attachments.

", - "smithy.api#xmlName": "transitGatewayAttachments" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -20960,6 +21750,14 @@ "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#xmlName": "nextToken" } + }, + "TransitGatewayAttachments": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachments", + "smithy.api#documentation": "

Information about the attachments.

", + "smithy.api#xmlName": "transitGatewayAttachments" + } } } }, @@ -20972,18 +21770,18 @@ "target": "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more transit gateway multicast domains.

" + "smithy.api#documentation": "

Describes one or more transit gateway multicast domains.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayMulticastDomains", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTransitGatewayMulticastDomainsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "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.

" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -20991,10 +21789,10 @@ "smithy.api#xmlName": "Filter" } }, - "TransitGatewayMulticastDomainIds": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList", + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + "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": { @@ -21003,6 +21801,12 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, + "TransitGatewayMulticastDomainIds": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainIdStringList", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -21041,16 +21845,22 @@ "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsResult" }, "traits": { - "smithy.api#documentation": "

Describes your transit gateway peering attachments.

" + "smithy.api#documentation": "

Describes your transit gateway peering attachments.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPeeringAttachments", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachmentsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "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.

" } }, "TransitGatewayAttachmentIds": { @@ -21059,23 +21869,23 @@ "smithy.api#documentation": "

One or more IDs of the transit gateway peering attachments.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#TransitGatewayMaxResults", "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.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "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#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" } } } @@ -21110,29 +21920,28 @@ "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described.\n Alternatively, you can filter the results.

" + "smithy.api#documentation": "

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTables", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest": { "type": "structure", "members": { - "TransitGatewayRouteTableIds": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the transit gateway route tables.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#TransitGatewayMaxResults", "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.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "TransitGatewayRouteTableIds": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The IDs of the transit gateway route tables.

" } }, "NextToken": { @@ -21146,6 +21955,13 @@ "traits": { "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.

" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } } } }, @@ -21179,22 +21995,29 @@ "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more VPC attachments. By default, all VPC attachments are described.\n Alternatively, you can filter the results.

" + "smithy.api#documentation": "

Describes one or more VPC attachments. By default, all VPC attachments are described.\n Alternatively, you can filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayVpcAttachments", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", "traits": { - "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#documentation": "

The IDs of the attachments.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" } }, "MaxResults": { @@ -21203,17 +22026,16 @@ "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.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" + "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.

" } }, - "TransitGatewayAttachmentIds": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IDs of the attachments.

" + "smithy.api#documentation": "

The token for the next page of results.

" } } } @@ -21248,18 +22070,36 @@ "target": "com.amazonaws.ec2#DescribeTransitGatewaysResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can\n filter the results.

" + "smithy.api#documentation": "

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can\n filter the results.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGateways", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTransitGatewaysRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "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.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, "TransitGatewayIds": { "target": "com.amazonaws.ec2#TransitGatewayIdStringList", "traits": { @@ -21269,21 +22109,9 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", - "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.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } } } }, @@ -21323,10 +22151,10 @@ "com.amazonaws.ec2#DescribeVolumeAttributeRequest": { "type": "structure", "members": { - "Attribute": { - "target": "com.amazonaws.ec2#VolumeAttributeName", + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", "traits": { - "smithy.api#documentation": "

The attribute of the volume. This parameter is required.

", + "smithy.api#documentation": "

The ID of the volume.

", "smithy.api#required": {} } }, @@ -21338,10 +22166,10 @@ "smithy.api#xmlName": "dryRun" } }, - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", + "Attribute": { + "target": "com.amazonaws.ec2#VolumeAttributeName", "traits": { - "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#documentation": "

The attribute of the volume. This parameter is required.

", "smithy.api#required": {} } } @@ -21350,6 +22178,14 @@ "com.amazonaws.ec2#DescribeVolumeAttributeResult": { "type": "structure", "members": { + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

A list of product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, "VolumeId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -21365,14 +22201,6 @@ "smithy.api#documentation": "

The state of autoEnableIO attribute.

", "smithy.api#xmlName": "autoEnableIO" } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

A list of product codes.

", - "smithy.api#xmlName": "productCodes" - } } } }, @@ -21385,12 +22213,26 @@ "target": "com.amazonaws.ec2#DescribeVolumeStatusResult" }, "traits": { - "smithy.api#documentation": "

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks may still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitoring the Status of Your Volumes in the\n Amazon Elastic Compute Cloud User Guide.

\n

\n Events: Reflect the cause of a volume status and may require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n may have inconsistent data.

\n

\n Actions: Reflect the actions you may have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume\n for data consistency.

\n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

" + "smithy.api#documentation": "

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks may still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitoring the status of your volumes in the\n Amazon Elastic Compute Cloud User Guide.

\n

\n Events: Reflect the cause of a volume status and may require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n may have inconsistent data.

\n

\n Actions: Reflect the actions you may have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume\n for data consistency.

\n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VolumeStatuses", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVolumeStatusRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -21405,14 +22247,6 @@ "smithy.api#xmlName": "VolumeId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -21430,14 +22264,6 @@ "com.amazonaws.ec2#DescribeVolumeStatusResult": { "type": "structure", "members": { - "VolumeStatuses": { - "target": "com.amazonaws.ec2#VolumeStatusList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeStatusSet", - "smithy.api#documentation": "

Information about the status of the volumes.

", - "smithy.api#xmlName": "volumeStatusSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -21445,6 +22271,14 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "VolumeStatuses": { + "target": "com.amazonaws.ec2#VolumeStatusList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeStatusSet", + "smithy.api#documentation": "

Information about the status of the volumes.

", + "smithy.api#xmlName": "volumeStatusSet" + } } } }, @@ -21457,7 +22291,13 @@ "target": "com.amazonaws.ec2#DescribeVolumesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. The MaxResults parameter sets the maximum number of results\n returned in a single page. If the list of results exceeds your MaxResults value,\n then that number of results is returned along with a NextToken value that can be\n passed to a subsequent DescribeVolumes request to retrieve the remaining\n results.

\n

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. The MaxResults parameter sets the maximum number of results\n returned in a single page. If the list of results exceeds your MaxResults value,\n then that number of results is returned along with a NextToken value that can be\n passed to a subsequent DescribeVolumes request to retrieve the remaining\n results.

\n

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Volumes", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVolumesModifications": { @@ -21469,19 +22309,38 @@ "target": "com.amazonaws.ec2#DescribeVolumesModificationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the most recent volume modification request for the specified EBS volumes.

\n

If a volume has never been modified, some information in the output will be null.\n If a volume has been modified more than once, the output includes only the most \n recent modification request.

\n

You can also use CloudWatch Events to check the status of a modification to an EBS\n volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see\n Monitoring Volume Modifications in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the most recent volume modification request for the specified EBS volumes.

\n

If a volume has never been modified, some information in the output will be null.\n If a volume has been modified more than once, the output includes only the most \n recent modification request.

\n

You can also use CloudWatch Events to check the status of a modification to an EBS\n volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see\n Monitoring volume modifications in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VolumesModifications", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVolumesModificationsRequest": { "type": "structure", "members": { + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the volumes.

", + "smithy.api#xmlName": "VolumeId" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results (up to a limit of 500) to be returned in a paginated\n request.

" + } + }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -21493,33 +22352,12 @@ "traits": { "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.

" } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results (up to a limit of 500) to be returned in a paginated\n request.

" - } - }, - "VolumeIds": { - "target": "com.amazonaws.ec2#VolumeIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the volumes.

", - "smithy.api#xmlName": "VolumeId" - } } } }, "com.amazonaws.ec2#DescribeVolumesModificationsResult": { "type": "structure", "members": { - "VolumesModifications": { - "target": "com.amazonaws.ec2#VolumeModificationList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeModificationSet", - "smithy.api#documentation": "

Information about the volume modifications.

", - "smithy.api#xmlName": "volumeModificationSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -21527,23 +22365,24 @@ "smithy.api#documentation": "

Token for pagination, null if there are no more results

", "smithy.api#xmlName": "nextToken" } + }, + "VolumesModifications": { + "target": "com.amazonaws.ec2#VolumeModificationList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeModificationSet", + "smithy.api#documentation": "

Information about the volume modifications.

", + "smithy.api#xmlName": "volumeModificationSet" + } } } }, "com.amazonaws.ec2#DescribeVolumesRequest": { "type": "structure", "members": { - "VolumeIds": { - "target": "com.amazonaws.ec2#VolumeIdStringList", - "traits": { - "smithy.api#documentation": "

The volume IDs.

", - "smithy.api#xmlName": "VolumeId" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -21555,12 +22394,11 @@ "smithy.api#xmlName": "dryRun" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "VolumeIds": { + "target": "com.amazonaws.ec2#VolumeIdStringList", "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n DescribeVolumes request where MaxResults was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the NextToken value. This value is null when\n there are no more results to return.

", - "smithy.api#xmlName": "nextToken" + "smithy.api#documentation": "

The volume IDs.

", + "smithy.api#xmlName": "VolumeId" } }, "MaxResults": { @@ -21570,20 +22408,20 @@ "smithy.api#documentation": "

The maximum number of volume results returned by DescribeVolumes in paginated\n output. When this parameter is used, DescribeVolumes only returns\n MaxResults results in a single page along with a NextToken\n response element. The remaining results of the initial request can be seen by sending another\n DescribeVolumes request with the returned NextToken value. This\n value can be between 5 and 500; if MaxResults is given a value larger than 500,\n only 500 results are returned. If this parameter is not used, then\n DescribeVolumes returns all results. You cannot specify this parameter and the\n volume IDs parameter in the same request.

", "smithy.api#xmlName": "maxResults" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n DescribeVolumes request where MaxResults was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the NextToken value. This value is null when\n there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } } } }, "com.amazonaws.ec2#DescribeVolumesResult": { "type": "structure", "members": { - "Volumes": { - "target": "com.amazonaws.ec2#VolumeList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSet", - "smithy.api#documentation": "

Information about the volumes.

", - "smithy.api#xmlName": "volumeSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -21591,6 +22429,14 @@ "smithy.api#documentation": "

The NextToken value to include in a future DescribeVolumes\n request. When the results of a DescribeVolumes request exceed\n MaxResults, this value can be used to retrieve the next page of results. This\n value is null when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "Volumes": { + "target": "com.amazonaws.ec2#VolumeList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSet", + "smithy.api#documentation": "

Information about the volumes.

", + "smithy.api#xmlName": "volumeSet" + } } } }, @@ -21609,6 +22455,13 @@ "com.amazonaws.ec2#DescribeVpcAttributeRequest": { "type": "structure", "members": { + "Attribute": { + "target": "com.amazonaws.ec2#VpcAttributeName", + "traits": { + "smithy.api#documentation": "

The VPC attribute.

", + "smithy.api#required": {} + } + }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { @@ -21623,13 +22476,6 @@ "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" } - }, - "Attribute": { - "target": "com.amazonaws.ec2#VpcAttributeName", - "traits": { - "smithy.api#documentation": "

The VPC attribute.

", - "smithy.api#required": {} - } } } }, @@ -21644,14 +22490,6 @@ "smithy.api#xmlName": "vpcId" } }, - "EnableDnsSupport": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "EnableDnsSupport", - "smithy.api#documentation": "

Indicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.

", - "smithy.api#xmlName": "enableDnsSupport" - } - }, "EnableDnsHostnames": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { @@ -21659,6 +22497,14 @@ "smithy.api#documentation": "

Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is true, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.

", "smithy.api#xmlName": "enableDnsHostnames" } + }, + "EnableDnsSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnableDnsSupport", + "smithy.api#documentation": "

Indicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.

", + "smithy.api#xmlName": "enableDnsSupport" + } } } }, @@ -21683,7 +22529,13 @@ "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportResult" }, "traits": { - "smithy.api#documentation": "

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS\n hostname of a linked EC2-Classic instance resolves to its private IP address when\n addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n of an instance in a VPC resolves to its private IP address when addressed from a linked\n EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS\n hostname of a linked EC2-Classic instance resolves to its private IP address when\n addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname\n of an instance in a VPC resolves to its private IP address when addressed from a linked\n EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Vpcs", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults": { @@ -21707,12 +22559,12 @@ "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults", + "NextToken": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "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.

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#xmlName": "nextToken" } }, "VpcIds": { @@ -21722,12 +22574,12 @@ "smithy.api#xmlName": "VpcIds" } }, - "NextToken": { - "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportNextToken", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults", "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#xmlName": "nextToken" + "aws.protocols#ec2QueryName": "MaxResults", + "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.

", + "smithy.api#xmlName": "maxResults" } } } @@ -21756,11 +22608,11 @@ "com.amazonaws.ec2#DescribeVpcClassicLinkRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "VpcIds": { + "target": "com.amazonaws.ec2#VpcClassicLinkIdList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

One or more VPCs for which you want to describe the ClassicLink status.

", + "smithy.api#xmlName": "VpcId" } }, "DryRun": { @@ -21771,11 +22623,11 @@ "smithy.api#xmlName": "dryRun" } }, - "VpcIds": { - "target": "com.amazonaws.ec2#VpcClassicLinkIdList", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more VPCs for which you want to describe the ClassicLink status.

", - "smithy.api#xmlName": "VpcId" + "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#xmlName": "Filter" } } } @@ -21802,7 +22654,13 @@ "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the connection notifications for VPC endpoints and VPC endpoint\n services.

" + "smithy.api#documentation": "

Describes the connection notifications for VPC endpoints and VPC endpoint\n services.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ConnectionNotificationSet", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcEndpointConnectionNotificationsRequest": { @@ -21815,6 +22673,12 @@ "smithy.api#xmlName": "Filter" } }, + "ConnectionNotificationId": { + "target": "com.amazonaws.ec2#ConnectionNotificationId", + "traits": { + "smithy.api#documentation": "

The ID of the notification.

" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -21827,12 +22691,6 @@ "smithy.api#documentation": "

The token to request the next page of results.

" } }, - "ConnectionNotificationId": { - "target": "com.amazonaws.ec2#ConnectionNotificationId", - "traits": { - "smithy.api#documentation": "

The ID of the notification.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -21871,17 +22729,22 @@ "target": "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult" }, "traits": { - "smithy.api#documentation": "

Describes the VPC endpoint connections to your VPC endpoint services, including any\n endpoints that are pending your acceptance.

" + "smithy.api#documentation": "

Describes the VPC endpoint connections to your VPC endpoint services, including any\n endpoints that are pending your acceptance.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcEndpointConnections", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcEndpointConnectionsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token to retrieve the next page of results.

" } }, "DryRun": { @@ -21890,16 +22753,17 @@ "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.

" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" + "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#xmlName": "Filter" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" } } } @@ -21907,14 +22771,6 @@ "com.amazonaws.ec2#DescribeVpcEndpointConnectionsResult": { "type": "structure", "members": { - "VpcEndpointConnections": { - "target": "com.amazonaws.ec2#VpcEndpointConnectionSet", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointConnectionSet", - "smithy.api#documentation": "

Information about one or more VPC endpoint connections.

", - "smithy.api#xmlName": "vpcEndpointConnectionSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -21922,6 +22778,14 @@ "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#xmlName": "nextToken" } + }, + "VpcEndpointConnections": { + "target": "com.amazonaws.ec2#VpcEndpointConnectionSet", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointConnectionSet", + "smithy.api#documentation": "

Information about one or more VPC endpoint connections.

", + "smithy.api#xmlName": "vpcEndpointConnectionSet" + } } } }, @@ -21934,30 +22798,35 @@ "target": "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the VPC endpoint service configurations in your account (your services).

" + "smithy.api#documentation": "

Describes the VPC endpoint service configurations in your account (your services).

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ServiceConfigurations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcEndpointServiceConfigurationsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ServiceIds": { + "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", "traits": { - "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#documentation": "

The IDs of one or more services.

", + "smithy.api#xmlName": "ServiceId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token to retrieve the next page of results.

" } }, - "ServiceIds": { - "target": "com.amazonaws.ec2#VpcEndpointServiceIdList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IDs of one or more services.

", - "smithy.api#xmlName": "ServiceId" + "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.

" } }, "MaxResults": { @@ -21966,10 +22835,11 @@ "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" + "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#xmlName": "Filter" } } } @@ -22004,12 +22874,24 @@ "target": "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult" }, "traits": { - "smithy.api#documentation": "

Describes the principals (service consumers) that are permitted to discover your VPC\n endpoint service.

" + "smithy.api#documentation": "

Describes the principals (service consumers) that are permitted to discover your VPC\n endpoint service.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AllowedPrincipals", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -22017,44 +22899,30 @@ "smithy.api#xmlName": "Filter" } }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", - "traits": { - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next page of results.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1,000; if\n MaxResults is given a value larger than 1,000, only 1,000 results are\n returned.

" } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.ec2#DescribeVpcEndpointServicePermissionsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "AllowedPrincipals": { "target": "com.amazonaws.ec2#AllowedPrincipalSet", "traits": { @@ -22062,6 +22930,14 @@ "smithy.api#documentation": "

Information about one or more allowed principals.

", "smithy.api#xmlName": "allowedPrincipals" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -22080,10 +22956,11 @@ "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", + "ServiceNames": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" + "smithy.api#documentation": "

One or more service names.

", + "smithy.api#xmlName": "ServiceName" } }, "Filters": { @@ -22093,23 +22970,22 @@ "smithy.api#xmlName": "Filter" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" } }, - "ServiceNames": { - "target": "com.amazonaws.ec2#ValueStringList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more service names.

", - "smithy.api#xmlName": "ServiceName" + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" } } }, @@ -22120,14 +22996,6 @@ "com.amazonaws.ec2#DescribeVpcEndpointServicesResult": { "type": "structure", "members": { - "ServiceNames": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "ServiceNameSet", - "smithy.api#documentation": "

A list of supported services.

", - "smithy.api#xmlName": "serviceNameSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -22143,6 +23011,14 @@ "smithy.api#documentation": "

Information about the service.

", "smithy.api#xmlName": "serviceDetailSet" } + }, + "ServiceNames": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "ServiceNameSet", + "smithy.api#documentation": "

A list of supported services.

", + "smithy.api#xmlName": "serviceNameSet" + } } }, "traits": { @@ -22158,25 +23034,18 @@ "target": "com.amazonaws.ec2#DescribeVpcEndpointsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your VPC endpoints.

" + "smithy.api#documentation": "

Describes one or more of your VPC endpoints.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcEndpoints", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcEndpointsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" - } - }, "VpcEndpointIds": { "target": "com.amazonaws.ec2#VpcEndpointIdList", "traits": { @@ -22190,11 +23059,24 @@ "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a prior call.)

" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -22204,14 +23086,6 @@ "com.amazonaws.ec2#DescribeVpcEndpointsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", - "smithy.api#xmlName": "nextToken" - } - }, "VpcEndpoints": { "target": "com.amazonaws.ec2#VpcEndpointSet", "traits": { @@ -22219,6 +23093,14 @@ "smithy.api#documentation": "

Information about the endpoints.

", "smithy.api#xmlName": "vpcEndpointSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "smithy.api#xmlName": "nextToken" + } } }, "traits": { @@ -22234,7 +23116,13 @@ "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your VPC peering connections.

" + "smithy.api#documentation": "

Describes one or more of your VPC peering connections.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VpcPeeringConnections", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults": { @@ -22256,6 +23144,18 @@ "smithy.api#xmlName": "VpcPeeringConnectionId" } }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults", + "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.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -22270,18 +23170,6 @@ "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults", - "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.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } } } }, @@ -22315,7 +23203,13 @@ "target": "com.amazonaws.ec2#DescribeVpcsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your VPCs.

" + "smithy.api#documentation": "

Describes one or more of your VPCs.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Vpcs", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeVpcsMaxResults": { @@ -22330,6 +23224,13 @@ "com.amazonaws.ec2#DescribeVpcsRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -22338,11 +23239,10 @@ "smithy.api#xmlName": "dryRun" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcsMaxResults", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", - "smithy.api#xmlName": "Filter" + "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": { @@ -22351,12 +23251,6 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVpcsMaxResults", - "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.

" - } - }, "VpcIds": { "target": "com.amazonaws.ec2#VpcIdStringList", "traits": { @@ -22402,6 +23296,13 @@ "com.amazonaws.ec2#DescribeVpnConnectionsRequest": { "type": "structure", "members": { + "VpnConnectionIds": { + "target": "com.amazonaws.ec2#VpnConnectionIdStringList", + "traits": { + "smithy.api#documentation": "

One or more VPN connection IDs.

\n

Default: Describes your VPN connections.

", + "smithy.api#xmlName": "VpnConnectionId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -22416,13 +23317,6 @@ "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } - }, - "VpnConnectionIds": { - "target": "com.amazonaws.ec2#VpnConnectionIdStringList", - "traits": { - "smithy.api#documentation": "

One or more VPN connection IDs.

\n

Default: Describes your VPN connections.

", - "smithy.api#xmlName": "VpnConnectionId" - } } }, "traits": { @@ -22460,6 +23354,13 @@ "com.amazonaws.ec2#DescribeVpnGatewaysRequest": { "type": "structure", "members": { + "VpnGatewayIds": { + "target": "com.amazonaws.ec2#VpnGatewayIdStringList", + "traits": { + "smithy.api#documentation": "

One or more virtual private gateway IDs.

\n

Default: Describes all your virtual private gateways.

", + "smithy.api#xmlName": "VpnGatewayId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -22468,13 +23369,6 @@ "smithy.api#xmlName": "dryRun" } }, - "VpnGatewayIds": { - "target": "com.amazonaws.ec2#VpnGatewayIdStringList", - "traits": { - "smithy.api#documentation": "

One or more virtual private gateway IDs.

\n

Default: Describes all your virtual private gateways.

", - "smithy.api#xmlName": "VpnGatewayId" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -22518,13 +23412,13 @@ "com.amazonaws.ec2#DetachClassicLinkVpcRequest": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC to which the instance is linked.

", + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance to unlink from the VPC.

", "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" + "smithy.api#xmlName": "instanceId" } }, "DryRun": { @@ -22535,13 +23429,13 @@ "smithy.api#xmlName": "dryRun" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance to unlink from the VPC.

", + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC to which the instance is linked.

", "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" + "smithy.api#xmlName": "vpcId" } } } @@ -22571,12 +23465,13 @@ "com.amazonaws.ec2#DetachInternetGatewayRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" } }, "InternetGatewayId": { @@ -22588,13 +23483,12 @@ "smithy.api#xmlName": "internetGatewayId" } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "DryRun", + "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" } } } @@ -22619,14 +23513,6 @@ "smithy.api#xmlName": "dryRun" } }, - "Force": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Force", - "smithy.api#documentation": "

Specifies whether to force a detachment.

\n \n
    \n
  • \n

    Use the Force parameter only as a last resort to detach a network interface from a failed instance.

    \n
    • \n
  • \n

    If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

    \n
    • \n
  • \n

    If you force the detachment of a network interface, the instance metadata\n might not get updated. This means that the attributes associated\n with the detached network interface might still be visible. The\n instance metadata will get updated when you stop and start the\n instance.

    \n
    • \n
\n ", - "smithy.api#xmlName": "force" - } - }, "AttachmentId": { "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", "traits": { @@ -22635,6 +23521,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "attachmentId" } + }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Force", + "smithy.api#documentation": "

Specifies whether to force a detachment.

\n \n
    \n
  • \n

    Use the Force parameter only as a last resort to detach a network interface from a failed instance.

    \n
    • \n
  • \n

    If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

    \n
    • \n
  • \n

    If you force the detachment of a network interface, the instance metadata\n might not get updated. This means that the attributes associated\n with the detached network interface might still be visible. The\n instance metadata will get updated when you stop and start the\n instance.

    \n
    • \n
\n ", + "smithy.api#xmlName": "force" + } } }, "traits": { @@ -22650,19 +23544,12 @@ "target": "com.amazonaws.ec2#VolumeAttachment" }, "traits": { - "smithy.api#documentation": "

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so can result\n in the volume becoming stuck in the busy state while detaching. If this happens,\n detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot\n the instance, or all three. If an EBS volume is the root device of an instance, it can't be\n detached while the instance is running. To detach the root volume, stop the instance\n first.

\n

When a volume with an AWS Marketplace product code is detached from an instance, the\n product code is no longer associated with the instance.

\n

For more information, see Detaching an Amazon EBS Volume in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so can result\n in the volume becoming stuck in the busy state while detaching. If this happens,\n detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot\n the instance, or all three. If an EBS volume is the root device of an instance, it can't be\n detached while the instance is running. To detach the root volume, stop the instance\n first.

\n

When a volume with an AWS Marketplace product code is detached from an instance, the\n product code is no longer associated with the instance.

\n

For more information, see Detaching an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#DetachVolumeRequest": { "type": "structure", "members": { - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -22671,10 +23558,11 @@ "smithy.api#xmlName": "dryRun" } }, - "Force": { - "target": "com.amazonaws.ec2#Boolean", + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", "traits": { - "smithy.api#documentation": "

Forces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.

" + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#required": {} } }, "InstanceId": { @@ -22683,6 +23571,12 @@ "smithy.api#documentation": "

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

" } }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Forces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.

" + } + }, "Device": { "target": "com.amazonaws.ec2#String", "traits": { @@ -22710,13 +23604,6 @@ "smithy.api#required": {} } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -22724,6 +23611,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" } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {} + } } }, "traits": { @@ -22788,14 +23682,6 @@ "com.amazonaws.ec2#DhcpOptions": { "type": "structure", "members": { - "DhcpConfigurations": { - "target": "com.amazonaws.ec2#DhcpConfigurationList", - "traits": { - "aws.protocols#ec2QueryName": "DhcpConfigurationSet", - "smithy.api#documentation": "

One or more DHCP options in the set.

", - "smithy.api#xmlName": "dhcpConfigurationSet" - } - }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -22819,6 +23705,14 @@ "smithy.api#documentation": "

The ID of the AWS account that owns the DHCP options set.

", "smithy.api#xmlName": "ownerId" } + }, + "DhcpConfigurations": { + "target": "com.amazonaws.ec2#DhcpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpConfigurationSet", + "smithy.api#documentation": "

One or more DHCP options in the set.

", + "smithy.api#xmlName": "dhcpConfigurationSet" + } } }, "traits": { @@ -22915,14 +23809,6 @@ "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorItem": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, "FastSnapshotRestoreStateErrors": { "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorSet", "traits": { @@ -22930,6 +23816,14 @@ "smithy.api#documentation": "

The errors.

", "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } } }, "traits": { @@ -22948,14 +23842,6 @@ "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -22963,6 +23849,14 @@ "smithy.api#documentation": "

The error message.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -22972,14 +23866,6 @@ "com.amazonaws.ec2#DisableFastSnapshotRestoreStateErrorItem": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, "Error": { "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreStateError", "traits": { @@ -22987,6 +23873,14 @@ "smithy.api#documentation": "

The error.

", "smithy.api#xmlName": "error" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } } }, "traits": { @@ -23005,28 +23899,20 @@ "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessItem": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of fast snapshot restores for the snapshot.

", - "smithy.api#xmlName": "state" - } - }, - "EnablingTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "OwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EnablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", - "smithy.api#xmlName": "enablingTime" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" } }, - "DisabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DisabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", - "smithy.api#xmlName": "disabledTime" + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" } }, "AvailabilityZone": { @@ -23037,20 +23923,36 @@ "smithy.api#xmlName": "availabilityZone" } }, - "OwnerId": { + "OwnerAlias": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that enabled fast snapshot restores on the snapshot.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", + "smithy.api#xmlName": "ownerAlias" } }, - "OptimizingTime": { + "DisablingTime": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "OptimizingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", - "smithy.api#xmlName": "optimizingTime" + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" + } + }, + "DisabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "DisabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabled state.

", + "smithy.api#xmlName": "disabledTime" + } + }, + "EnablingTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "EnablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabling state.

", + "smithy.api#xmlName": "enablingTime" } }, "EnabledTime": { @@ -23061,12 +23963,12 @@ "smithy.api#xmlName": "enabledTime" } }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", + "State": { + "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.

", - "smithy.api#xmlName": "ownerAlias" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of fast snapshot restores for the snapshot.

", + "smithy.api#xmlName": "state" } }, "SnapshotId": { @@ -23077,20 +23979,12 @@ "smithy.api#xmlName": "snapshotId" } }, - "DisablingTime": { + "OptimizingTime": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "DisablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", - "smithy.api#xmlName": "disablingTime" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", - "smithy.api#xmlName": "stateTransitionReason" + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" } } }, @@ -23122,10 +24016,12 @@ "com.amazonaws.ec2#DisableFastSnapshotRestoresRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "SourceSnapshotIds": { + "target": "com.amazonaws.ec2#SnapshotIdStringList", "traits": { - "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#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SourceSnapshotId" } }, "AvailabilityZones": { @@ -23136,12 +24032,10 @@ "smithy.api#xmlName": "AvailabilityZone" } }, - "SourceSnapshotIds": { - "target": "com.amazonaws.ec2#SnapshotIdStringList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IDs of one or more snapshots. For example, snap-1234567890abcdef0.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SourceSnapshotId" + "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.

" } } } @@ -23149,14 +24043,6 @@ "com.amazonaws.ec2#DisableFastSnapshotRestoresResult": { "type": "structure", "members": { - "Unsuccessful": { - "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "Unsuccessful", - "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be disabled.

", - "smithy.api#xmlName": "unsuccessful" - } - }, "Successful": { "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreSuccessSet", "traits": { @@ -23164,6 +24050,14 @@ "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores were successfully disabled.

", "smithy.api#xmlName": "successful" } + }, + "Unsuccessful": { + "target": "com.amazonaws.ec2#DisableFastSnapshotRestoreErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "Unsuccessful", + "smithy.api#documentation": "

Information about the snapshots for which fast snapshot restores could not be disabled.

", + "smithy.api#xmlName": "unsuccessful" + } } } }, @@ -23182,12 +24076,6 @@ "com.amazonaws.ec2#DisableTransitGatewayRouteTablePropagationRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { @@ -23195,6 +24083,12 @@ "smithy.api#required": {} } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { @@ -23229,12 +24123,6 @@ "com.amazonaws.ec2#DisableVgwRoutePropagationRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" - } - }, "GatewayId": { "target": "com.amazonaws.ec2#VpnGatewayId", "traits": { @@ -23248,6 +24136,12 @@ "smithy.api#documentation": "

The ID of the route table.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" + } } }, "traits": { @@ -23306,6 +24200,14 @@ "com.amazonaws.ec2#DisableVpcClassicLinkRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { @@ -23314,14 +24216,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcId" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } } }, @@ -23387,12 +24281,6 @@ "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, "AssociationId": { "target": "com.amazonaws.ec2#ClientVpnAssociationId", "traits": { @@ -23400,6 +24288,12 @@ "smithy.api#required": {} } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { @@ -23412,14 +24306,6 @@ "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult": { "type": "structure", "members": { - "AssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The ID of the target network association.

", - "smithy.api#xmlName": "associationId" - } - }, "Status": { "target": "com.amazonaws.ec2#AssociationStatus", "traits": { @@ -23427,6 +24313,14 @@ "smithy.api#documentation": "

The current state of the target network association.

", "smithy.api#xmlName": "status" } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the target network association.

", + "smithy.api#xmlName": "associationId" + } } } }, @@ -23527,14 +24421,6 @@ "com.amazonaws.ec2#DisassociateSubnetCidrBlockResult": { "type": "structure", "members": { - "Ipv6CidrBlockAssociation": { - "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", - "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociation" - } - }, "SubnetId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -23542,6 +24428,14 @@ "smithy.api#documentation": "

The ID of the subnet.

", "smithy.api#xmlName": "subnetId" } + }, + "Ipv6CidrBlockAssociation": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociation", + "smithy.api#documentation": "

Information about the IPv6 CIDR block association.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociation" + } } } }, @@ -23560,28 +24454,28 @@ "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomainRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TransitGatewayMulticastDomainId": { "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", "traits": { "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" } }, + "SubnetIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets;

" + } + }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { "smithy.api#documentation": "

The ID of the attachment.

" } }, - "SubnetIds": { - "target": "com.amazonaws.ec2#ValueStringList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IDs of the subnets;

" + "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.

" } } } @@ -23621,18 +24515,18 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { "smithy.api#documentation": "

The ID of the transit gateway route table.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -23713,10 +24607,10 @@ "com.amazonaws.ec2#DiskImage": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", + "Image": { + "target": "com.amazonaws.ec2#DiskImageDetail", "traits": { - "smithy.api#documentation": "

A description of the disk image.

" + "smithy.api#documentation": "

Information about the disk image.

" } }, "Volume": { @@ -23725,10 +24619,10 @@ "smithy.api#documentation": "

Information about the volume.

" } }, - "Image": { - "target": "com.amazonaws.ec2#DiskImageDetail", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Information about the disk image.

" + "smithy.api#documentation": "

A description of the disk image.

" } } }, @@ -23739,6 +24633,14 @@ "com.amazonaws.ec2#DiskImageDescription": { "type": "structure", "members": { + "Size": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#documentation": "

The size of the disk image, in GiB.

", + "smithy.api#xmlName": "size" + } + }, "Checksum": { "target": "com.amazonaws.ec2#String", "traits": { @@ -23755,14 +24657,6 @@ "smithy.api#xmlName": "format" } }, - "Size": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Size", - "smithy.api#documentation": "

The size of the disk image, in GiB.

", - "smithy.api#xmlName": "size" - } - }, "ImportManifestUrl": { "target": "com.amazonaws.ec2#String", "traits": { @@ -23836,14 +24730,6 @@ "com.amazonaws.ec2#DiskImageVolumeDescription": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Id", - "smithy.api#documentation": "

The volume identifier.

", - "smithy.api#xmlName": "id" - } - }, "Size": { "target": "com.amazonaws.ec2#Long", "traits": { @@ -23851,6 +24737,14 @@ "smithy.api#documentation": "

The size of the volume, in GiB.

", "smithy.api#xmlName": "size" } + }, + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The volume identifier.

", + "smithy.api#xmlName": "id" + } } }, "traits": { @@ -23860,12 +24754,12 @@ "com.amazonaws.ec2#DiskInfo": { "type": "structure", "members": { - "SizeInGB": { - "target": "com.amazonaws.ec2#DiskSize", + "Type": { + "target": "com.amazonaws.ec2#DiskType", "traits": { - "aws.protocols#ec2QueryName": "SizeInGB", - "smithy.api#documentation": "

The size of the disk in GB.

", - "smithy.api#xmlName": "sizeInGB" + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of disk.

", + "smithy.api#xmlName": "type" } }, "Count": { @@ -23876,12 +24770,12 @@ "smithy.api#xmlName": "count" } }, - "Type": { - "target": "com.amazonaws.ec2#DiskType", + "SizeInGB": { + "target": "com.amazonaws.ec2#DiskSize", "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of disk.

", - "smithy.api#xmlName": "type" + "aws.protocols#ec2QueryName": "SizeInGB", + "smithy.api#documentation": "

The size of the disk in GB.

", + "smithy.api#xmlName": "sizeInGB" } } }, @@ -23972,17 +24866,17 @@ "com.amazonaws.ec2#DnsServersOptionsModifyStructure": { "type": "structure", "members": { - "CustomDnsServers": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to \n\t\t\ttwo DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values \n\t\t\toverwrite the existing values.

" - } - }, "Enabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether DNS servers should be used. Specify False to delete the existing DNS \n\t\t\tservers.

" } + }, + "CustomDnsServers": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to \n\t\t\ttwo DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values \n\t\t\toverwrite the existing values.

" + } } }, "traits": { @@ -24021,14 +24915,6 @@ "com.amazonaws.ec2#EbsBlockDevice": { "type": "structure", "members": { - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "aws.protocols#ec2QueryName": "VolumeType", - "smithy.api#documentation": "

The volume type. If you set the type to io1, you must also specify\n \tthe Iops parameter. If you set the type to gp2, \n \tst1, sc1, or standard, you must omit \n \tthe Iops parameter.

\n

Default: gp2\n

", - "smithy.api#xmlName": "volumeType" - } - }, "SnapshotId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -24037,20 +24923,27 @@ "smithy.api#xmlName": "snapshotId" } }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume\n size, the default is the snapshot size.

\n

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for\n Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD\n (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for\n Magnetic (standard) volumes. If you specify a snapshot, the volume size\n must be equal to or larger than the snapshot size.

", - "smithy.api#xmlName": "volumeSize" + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type. If you set the type to io1 or io2, you must also specify\n \tthe Iops parameter. If you set the type to gp2, \n \tst1, sc1, or standard, you must omit \n \tthe Iops parameter.

\n

Default: gp2\n

", + "smithy.api#xmlName": "volumeType" } }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Iops", - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For\n io1 volumes, this represents the number of IOPS that are provisioned\n for the volume. For gp2 volumes, this represents the baseline performance\n of the volume and the rate at which the volume accumulates I/O credits for bursting. For\n more information, see Amazon EBS volume types in the\n Amazon Elastic Compute Cloud User Guide.

\n

Constraints: Range is 100-16,000 IOPS for gp2 volumes and\n 100 to 64,000IOPS for io1 volumes in\n most Regions. Maximum io1 IOPS of 64,000 is guaranteed\n only on Nitro-based\n instances. Other instance families guarantee performance up to\n 32,000 IOPS. For more information, see Amazon EBS Volume\n Types in the Amazon Elastic Compute Cloud User Guide.

\n

Condition: This parameter is required for requests to create io1 volumes;\n it is not used in requests to create gp2, st1,\n sc1, or standard volumes.

", - "smithy.api#xmlName": "iops" + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. \n The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. \n For more information, see Amazon EBS Encryption \n in the Amazon Elastic Compute Cloud User Guide.

\n

In no case can you remove encryption from an encrypted volume.

\n

Encrypted volumes can only be attached to instances that support Amazon EBS\n encryption. For more information, see Supported instance types.

\n

This parameter is not returned by .

", + "smithy.api#xmlName": "encrypted" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", + "smithy.api#xmlName": "KmsKeyId" } }, "DeleteOnTermination": { @@ -24061,19 +24954,20 @@ "smithy.api#xmlName": "deleteOnTermination" } }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", + "Iops": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", - "smithy.api#xmlName": "KmsKeyId" + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For\n io1 and io2 volumes, this represents the number of IOPS that are provisioned\n for the volume. For gp2 volumes, this represents the baseline performance\n of the volume and the rate at which the volume accumulates I/O credits for bursting. For\n more information, see Amazon EBS volume types in the\n Amazon Elastic Compute Cloud User Guide.

\n

Constraints: Range is 100-16,000 IOPS for gp2 volumes and\n 100 to 64,000 IOPS for io1 and io2 volumes in\n most Regions. Maximum io1 and io2 IOPS of 64,000 is guaranteed\n only on Nitro-based\n instances. Other instance families guarantee performance up to\n 32,000 IOPS. For more information, see Amazon EBS Volume\n Types in the Amazon Elastic Compute Cloud User Guide.

\n

Condition: This parameter is required for requests to create io1 and io2 volumes;\n it is not used in requests to create gp2, st1,\n sc1, or standard volumes.

", + "smithy.api#xmlName": "iops" } }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. \n The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. \n For more information, see Amazon EBS Encryption \n in the Amazon Elastic Compute Cloud User Guide.

\n

In no case can you remove encryption from an encrypted volume.

\n

Encrypted volumes can only be attached to instances that support Amazon EBS\n encryption. For more information, see Supported instance types.

\n

This parameter is not returned by .

", - "smithy.api#xmlName": "encrypted" + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume\n size, the default is the snapshot size.

\n

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for\n Provisioned IOPS SSD (io1 and io2), 500-16384 for Throughput Optimized HDD\n (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for\n Magnetic (standard) volumes. If you specify a snapshot, the volume size\n must be equal to or larger than the snapshot size.

", + "smithy.api#xmlName": "volumeSize" } } }, @@ -24097,12 +24991,12 @@ "com.amazonaws.ec2#EbsInfo": { "type": "structure", "members": { - "EbsOptimizedSupport": { - "target": "com.amazonaws.ec2#EbsOptimizedSupport", + "EbsOptimizedInfo": { + "target": "com.amazonaws.ec2#EbsOptimizedInfo", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimizedSupport", - "smithy.api#documentation": "

Indicates that the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-Optimized Instances in Amazon EC2 User Guide for\n Linux Instances.

", - "smithy.api#xmlName": "ebsOptimizedSupport" + "aws.protocols#ec2QueryName": "EbsOptimizedInfo", + "smithy.api#documentation": "

Describes the optimized EBS performance for the instance type.

", + "smithy.api#xmlName": "ebsOptimizedInfo" } }, "NvmeSupport": { @@ -24121,12 +25015,12 @@ "smithy.api#xmlName": "encryptionSupport" } }, - "EbsOptimizedInfo": { - "target": "com.amazonaws.ec2#EbsOptimizedInfo", + "EbsOptimizedSupport": { + "target": "com.amazonaws.ec2#EbsOptimizedSupport", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimizedInfo", - "smithy.api#documentation": "

Describes the optimized EBS performance for the instance type.

", - "smithy.api#xmlName": "ebsOptimizedInfo" + "aws.protocols#ec2QueryName": "EbsOptimizedSupport", + "smithy.api#documentation": "

Indicates that the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-Optimized Instances in Amazon EC2 User Guide for\n Linux Instances.

", + "smithy.api#xmlName": "ebsOptimizedSupport" } } }, @@ -24153,14 +25047,6 @@ "smithy.api#xmlName": "volumeId" } }, - "Status": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The attachment state.

", - "smithy.api#xmlName": "status" - } - }, "AttachTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -24168,6 +25054,14 @@ "smithy.api#documentation": "

The time stamp when the attachment initiated.

", "smithy.api#xmlName": "attachTime" } + }, + "Status": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state.

", + "smithy.api#xmlName": "status" + } } }, "traits": { @@ -24177,14 +25071,6 @@ "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification": { "type": "structure", "members": { - "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the EBS volume.

", - "smithy.api#xmlName": "volumeId" - } - }, "DeleteOnTermination": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -24192,6 +25078,14 @@ "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", "smithy.api#xmlName": "deleteOnTermination" } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#VolumeId", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the EBS volume.

", + "smithy.api#xmlName": "volumeId" + } } }, "traits": { @@ -24220,28 +25114,12 @@ "com.amazonaws.ec2#EbsOptimizedInfo": { "type": "structure", "members": { - "BaselineThroughputInMBps": { - "target": "com.amazonaws.ec2#BaselineThroughputInMBps", - "traits": { - "aws.protocols#ec2QueryName": "BaselineThroughputInMBps", - "smithy.api#documentation": "

The baseline throughput performance for an EBS-optimized instance type, in MBps.

", - "smithy.api#xmlName": "baselineThroughputInMBps" - } - }, - "MaximumThroughputInMBps": { - "target": "com.amazonaws.ec2#MaximumThroughputInMBps", - "traits": { - "aws.protocols#ec2QueryName": "MaximumThroughputInMBps", - "smithy.api#documentation": "

The maximum throughput performance for an EBS-optimized instance type, in MBps.

", - "smithy.api#xmlName": "maximumThroughputInMBps" - } - }, - "MaximumIops": { - "target": "com.amazonaws.ec2#MaximumIops", + "BaselineIops": { + "target": "com.amazonaws.ec2#BaselineIops", "traits": { - "aws.protocols#ec2QueryName": "MaximumIops", - "smithy.api#documentation": "

The maximum input/output storage operations per second for an EBS-optimized instance type.

", - "smithy.api#xmlName": "maximumIops" + "aws.protocols#ec2QueryName": "BaselineIops", + "smithy.api#documentation": "

The baseline input/output storage operations per seconds for an EBS-optimized instance type.

", + "smithy.api#xmlName": "baselineIops" } }, "MaximumBandwidthInMbps": { @@ -24252,12 +25130,12 @@ "smithy.api#xmlName": "maximumBandwidthInMbps" } }, - "BaselineIops": { - "target": "com.amazonaws.ec2#BaselineIops", + "BaselineThroughputInMBps": { + "target": "com.amazonaws.ec2#BaselineThroughputInMBps", "traits": { - "aws.protocols#ec2QueryName": "BaselineIops", - "smithy.api#documentation": "

The baseline input/output storage operations per seconds for an EBS-optimized instance type.

", - "smithy.api#xmlName": "baselineIops" + "aws.protocols#ec2QueryName": "BaselineThroughputInMBps", + "smithy.api#documentation": "

The baseline throughput performance for an EBS-optimized instance type, in MBps.

", + "smithy.api#xmlName": "baselineThroughputInMBps" } }, "BaselineBandwidthInMbps": { @@ -24267,6 +25145,22 @@ "smithy.api#documentation": "

The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.

", "smithy.api#xmlName": "baselineBandwidthInMbps" } + }, + "MaximumIops": { + "target": "com.amazonaws.ec2#MaximumIops", + "traits": { + "aws.protocols#ec2QueryName": "MaximumIops", + "smithy.api#documentation": "

The maximum input/output storage operations per second for an EBS-optimized instance type.

", + "smithy.api#xmlName": "maximumIops" + } + }, + "MaximumThroughputInMBps": { + "target": "com.amazonaws.ec2#MaximumThroughputInMBps", + "traits": { + "aws.protocols#ec2QueryName": "MaximumThroughputInMBps", + "smithy.api#documentation": "

The maximum throughput performance for an EBS-optimized instance type, in MBps.

", + "smithy.api#xmlName": "maximumThroughputInMBps" + } } }, "traits": { @@ -24298,6 +25192,14 @@ "com.amazonaws.ec2#EgressOnlyInternetGateway": { "type": "structure", "members": { + "Attachments": { + "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Information about the attachment of the egress-only internet gateway.

", + "smithy.api#xmlName": "attachmentSet" + } + }, "EgressOnlyInternetGatewayId": { "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", "traits": { @@ -24313,14 +25215,6 @@ "smithy.api#documentation": "

The tags assigned to the egress-only internet gateway.

", "smithy.api#xmlName": "tagSet" } - }, - "Attachments": { - "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "

Information about the attachment of the egress-only internet gateway.

", - "smithy.api#xmlName": "attachmentSet" - } } }, "traits": { @@ -24367,14 +25261,6 @@ "smithy.api#xmlName": "elasticGpuAssociationTime" } }, - "ElasticGpuAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuAssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "elasticGpuAssociationId" - } - }, "ElasticGpuAssociationState": { "target": "com.amazonaws.ec2#String", "traits": { @@ -24382,6 +25268,14 @@ "smithy.api#documentation": "

The state of the association between the instance and the\n Elastic Graphics accelerator.

", "smithy.api#xmlName": "elasticGpuAssociationState" } + }, + "ElasticGpuAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "elasticGpuAssociationId" + } } }, "traits": { @@ -24521,28 +25415,12 @@ "com.amazonaws.ec2#ElasticGpus": { "type": "structure", "members": { - "ElasticGpuId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuId", - "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance to which the Elastic Graphics accelerator is attached.

", - "smithy.api#xmlName": "instanceId" - } - }, - "AvailabilityZone": { + "ElasticGpuType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in the which the Elastic Graphics accelerator resides.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "ElasticGpuType", + "smithy.api#documentation": "

The type of Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuType" } }, "ElasticGpuHealth": { @@ -24553,12 +25431,20 @@ "smithy.api#xmlName": "elasticGpuHealth" } }, - "ElasticGpuType": { + "ElasticGpuId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuType", - "smithy.api#documentation": "

The type of Elastic Graphics accelerator.

", - "smithy.api#xmlName": "elasticGpuType" + "aws.protocols#ec2QueryName": "ElasticGpuId", + "smithy.api#documentation": "

The ID of the Elastic Graphics accelerator.

", + "smithy.api#xmlName": "elasticGpuId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in the which the Elastic Graphics accelerator resides.

", + "smithy.api#xmlName": "availabilityZone" } }, "Tags": { @@ -24576,6 +25462,14 @@ "smithy.api#documentation": "

The state of the Elastic Graphics accelerator.

", "smithy.api#xmlName": "elasticGpuState" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance to which the Elastic Graphics accelerator is attached.

", + "smithy.api#xmlName": "instanceId" + } } }, "traits": { @@ -24614,6 +25508,14 @@ "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationId" } }, + "ElasticInferenceAcceleratorAssociationState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationState", + "smithy.api#documentation": "

\n The state of the elastic inference accelerator.\n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationState" + } + }, "ElasticInferenceAcceleratorAssociationTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -24629,14 +25531,6 @@ "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the elastic inference accelerator. \n

", "smithy.api#xmlName": "elasticInferenceAcceleratorArn" } - }, - "ElasticInferenceAcceleratorAssociationState": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationState", - "smithy.api#documentation": "

\n The state of the elastic inference accelerator.\n

", - "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationState" - } } }, "traits": { @@ -24697,7 +25591,7 @@ "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult" }, "traits": { - "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n are always encrypted, either using the default CMK or the CMK that you specified\n when you created each volume. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

\n

You can specify the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n Instance Types.

" + "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n are always encrypted, either using the default CMK or the CMK that you specified\n when you created each volume. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

\n

You can specify the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" } }, "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest": { @@ -24727,14 +25621,6 @@ "com.amazonaws.ec2#EnableFastSnapshotRestoreErrorItem": { "type": "structure", "members": { - "FastSnapshotRestoreStateErrors": { - "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet", - "traits": { - "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", - "smithy.api#documentation": "

The errors.

", - "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" - } - }, "SnapshotId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -24742,6 +25628,14 @@ "smithy.api#documentation": "

The ID of the snapshot.

", "smithy.api#xmlName": "snapshotId" } + }, + "FastSnapshotRestoreStateErrors": { + "target": "com.amazonaws.ec2#EnableFastSnapshotRestoreStateErrorSet", + "traits": { + "aws.protocols#ec2QueryName": "FastSnapshotRestoreStateErrorSet", + "smithy.api#documentation": "

The errors.

", + "smithy.api#xmlName": "fastSnapshotRestoreStateErrorSet" + } } }, "traits": { @@ -24760,14 +25654,6 @@ "com.amazonaws.ec2#EnableFastSnapshotRestoreStateError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The error message.

", - "smithy.api#xmlName": "message" - } - }, "Code": { "target": "com.amazonaws.ec2#String", "traits": { @@ -24775,6 +25661,14 @@ "smithy.api#documentation": "

The error code.

", "smithy.api#xmlName": "code" } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The error message.

", + "smithy.api#xmlName": "message" + } } }, "traits": { @@ -24817,12 +25711,12 @@ "com.amazonaws.ec2#EnableFastSnapshotRestoreSuccessItem": { "type": "structure", "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", + "EnabledTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that enabled fast snapshot restores on the snapshot.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "EnabledTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", + "smithy.api#xmlName": "enabledTime" } }, "AvailabilityZone": { @@ -24833,14 +25727,6 @@ "smithy.api#xmlName": "availabilityZone" } }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateTransitionReason", - "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", - "smithy.api#xmlName": "stateTransitionReason" - } - }, "OwnerAlias": { "target": "com.amazonaws.ec2#String", "traits": { @@ -24849,12 +25735,28 @@ "smithy.api#xmlName": "ownerAlias" } }, - "DisablingTime": { + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that enabled fast snapshot restores on the snapshot.

", + "smithy.api#xmlName": "ownerId" + } + }, + "OptimizingTime": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "DisablingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", - "smithy.api#xmlName": "disablingTime" + "aws.protocols#ec2QueryName": "OptimizingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", + "smithy.api#xmlName": "optimizingTime" } }, "DisabledTime": { @@ -24865,14 +25767,6 @@ "smithy.api#xmlName": "disabledTime" } }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, "State": { "target": "com.amazonaws.ec2#FastSnapshotRestoreStateCode", "traits": { @@ -24889,20 +25783,20 @@ "smithy.api#xmlName": "enablingTime" } }, - "EnabledTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EnabledTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the enabled state.

", - "smithy.api#xmlName": "enabledTime" + "aws.protocols#ec2QueryName": "StateTransitionReason", + "smithy.api#documentation": "

The reason for the state transition. The possible values are as follows:

\n ", + "smithy.api#xmlName": "stateTransitionReason" } }, - "OptimizingTime": { + "DisablingTime": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "OptimizingTime", - "smithy.api#documentation": "

The time at which fast snapshot restores entered the optimizing state.

", - "smithy.api#xmlName": "optimizingTime" + "aws.protocols#ec2QueryName": "DisablingTime", + "smithy.api#documentation": "

The time at which fast snapshot restores entered the disabling state.

", + "smithy.api#xmlName": "disablingTime" } } }, @@ -24928,7 +25822,7 @@ "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresResult" }, "traits": { - "smithy.api#documentation": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

\n

You get the full benefit of fast snapshot restores after they enter the enabled state.\n To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores.\n To disable fast snapshot restores, use DisableFastSnapshotRestores.

\n

For more information, see Amazon EBS Fast Snapshot\n Restore in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

\n

You get the full benefit of fast snapshot restores after they enter the enabled state.\n To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores.\n To disable fast snapshot restores, use DisableFastSnapshotRestores.

\n

For more information, see Amazon EBS fast snapshot\n restore in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest": { @@ -24942,12 +25836,6 @@ "smithy.api#xmlName": "AvailabilityZone" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "SourceSnapshotIds": { "target": "com.amazonaws.ec2#SnapshotIdStringList", "traits": { @@ -24955,6 +25843,12 @@ "smithy.api#required": {}, "smithy.api#xmlName": "SourceSnapshotId" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -24994,12 +25888,6 @@ "com.amazonaws.ec2#EnableTransitGatewayRouteTablePropagationRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { @@ -25013,6 +25901,12 @@ "smithy.api#documentation": "

The ID of the attachment.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -25041,12 +25935,6 @@ "com.amazonaws.ec2#EnableVgwRoutePropagationRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" - } - }, "GatewayId": { "target": "com.amazonaws.ec2#VpnGatewayId", "traits": { @@ -25060,6 +25948,12 @@ "smithy.api#documentation": "

The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is DryRunOperation. \n\t\t\tOtherwise, it is UnauthorizedOperation.

" + } } }, "traits": { @@ -25078,14 +25972,6 @@ "com.amazonaws.ec2#EnableVolumeIORequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "VolumeId": { "target": "com.amazonaws.ec2#VolumeId", "traits": { @@ -25094,6 +25980,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "volumeId" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -25237,12 +26131,12 @@ "com.amazonaws.ec2#EventInformation": { "type": "structure", "members": { - "InstanceId": { + "EventDescription": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance. This information is available only for instanceChange events.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "EventDescription", + "smithy.api#documentation": "

The description of the event.

", + "smithy.api#xmlName": "eventDescription" } }, "EventSubType": { @@ -25253,12 +26147,12 @@ "smithy.api#xmlName": "eventSubType" } }, - "EventDescription": { + "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EventDescription", - "smithy.api#documentation": "

The description of the event.

", - "smithy.api#xmlName": "eventDescription" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance. This information is available only for instanceChange events.

", + "smithy.api#xmlName": "instanceId" } } }, @@ -25328,32 +26222,24 @@ "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } } } }, "com.amazonaws.ec2#ExportClientVpnClientCertificateRevocationListResult": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the client certificate revocation list.

", - "smithy.api#xmlName": "status" - } - }, "CertificateRevocationList": { "target": "com.amazonaws.ec2#String", "traits": { @@ -25361,6 +26247,14 @@ "smithy.api#documentation": "

Information about the client certificate revocation list.

", "smithy.api#xmlName": "certificateRevocationList" } + }, + "Status": { + "target": "com.amazonaws.ec2#ClientCertificateRevocationListStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the client certificate revocation list.

", + "smithy.api#xmlName": "status" + } } } }, @@ -25379,18 +26273,18 @@ "com.amazonaws.ec2#ExportClientVpnClientConfigurationRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { "smithy.api#documentation": "

The ID of the Client VPN endpoint.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } } } }, @@ -25438,16 +26332,25 @@ "com.amazonaws.ec2#ExportImageRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.ec2#String", + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", "traits": { - "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

" + "smithy.api#documentation": "

The disk image format.

", + "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3LocationRequest", "traits": { - "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#documentation": "

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE\n and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Token to enable idempotency for export image requests.

", + "smithy.api#idempotencyToken": {} } }, "TagSpecifications": { @@ -25457,11 +26360,10 @@ "smithy.api#xmlName": "TagSpecification" } }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", + "RoleName": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the image.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

" } }, "Description": { @@ -25470,32 +26372,48 @@ "smithy.api#documentation": "

A description of the image being exported. The maximum length is 255 characters.

" } }, - "DiskImageFormat": { - "target": "com.amazonaws.ec2#DiskImageFormat", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The disk image format.

", - "smithy.api#required": {} + "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.

" } }, - "S3ExportLocation": { - "target": "com.amazonaws.ec2#ExportTaskS3LocationRequest", + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", "traits": { - "smithy.api#documentation": "

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE\n and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "smithy.api#documentation": "

The ID of the image.

", "smithy.api#required": {} } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Token to enable idempotency for export image requests.

", - "smithy.api#idempotencyToken": {} - } } } }, "com.amazonaws.ec2#ExportImageResult": { "type": "structure", "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#xmlName": "imageId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the image being exported.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ExportImageTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ExportImageTaskId", + "smithy.api#documentation": "

The ID of the export image task.

", + "smithy.api#xmlName": "exportImageTaskId" + } + }, "DiskImageFormat": { "target": "com.amazonaws.ec2#DiskImageFormat", "traits": { @@ -25504,6 +26422,22 @@ "smithy.api#xmlName": "diskImageFormat" } }, + "S3ExportLocation": { + "target": "com.amazonaws.ec2#ExportTaskS3Location", + "traits": { + "aws.protocols#ec2QueryName": "S3ExportLocation", + "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", + "smithy.api#xmlName": "s3ExportLocation" + } + }, + "RoleName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RoleName", + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket.

", + "smithy.api#xmlName": "roleName" + } + }, "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { @@ -25512,12 +26446,12 @@ "smithy.api#xmlName": "statusMessage" } }, - "Progress": { + "Status": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percent complete of the export image task.

", - "smithy.api#xmlName": "progress" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", + "smithy.api#xmlName": "status" } }, "Description": { @@ -25528,20 +26462,25 @@ "smithy.api#xmlName": "description" } }, - "ExportImageTaskId": { + "Progress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ExportImageTaskId", - "smithy.api#documentation": "

The ID of the export image task.

", - "smithy.api#xmlName": "exportImageTaskId" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percent complete of the export image task.

", + "smithy.api#xmlName": "progress" } - }, - "Status": { + } + } + }, + "com.amazonaws.ec2#ExportImageTask": { + "type": "structure", + "members": { + "ImageId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the export image task. The possible values are active, completed,\n deleting, and deleted.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#xmlName": "imageId" } }, "Tags": { @@ -25552,20 +26491,12 @@ "smithy.api#xmlName": "tagSet" } }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the image.

", - "smithy.api#xmlName": "imageId" - } - }, - "RoleName": { + "ExportImageTaskId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RoleName", - "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to export images to your Amazon\n S3 bucket.

", - "smithy.api#xmlName": "roleName" + "aws.protocols#ec2QueryName": "ExportImageTaskId", + "smithy.api#documentation": "

The ID of the export image task.

", + "smithy.api#xmlName": "exportImageTaskId" } }, "S3ExportLocation": { @@ -25575,19 +26506,6 @@ "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", "smithy.api#xmlName": "s3ExportLocation" } - } - } - }, - "com.amazonaws.ec2#ExportImageTask": { - "type": "structure", - "members": { - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message for the export image task.

", - "smithy.api#xmlName": "statusMessage" - } }, "Progress": { "target": "com.amazonaws.ec2#String", @@ -25597,20 +26515,12 @@ "smithy.api#xmlName": "progress" } }, - "ExportImageTaskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ExportImageTaskId", - "smithy.api#documentation": "

The ID of the export image task.

", - "smithy.api#xmlName": "exportImageTaskId" - } - }, - "Description": { + "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the image being exported.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message for the export image task.

", + "smithy.api#xmlName": "statusMessage" } }, "Status": { @@ -25621,28 +26531,12 @@ "smithy.api#xmlName": "status" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the image being exported.

", - "smithy.api#xmlName": "tagSet" - } - }, - "S3ExportLocation": { - "target": "com.amazonaws.ec2#ExportTaskS3Location", - "traits": { - "aws.protocols#ec2QueryName": "S3ExportLocation", - "smithy.api#documentation": "

Information about the destination Amazon S3 bucket.

", - "smithy.api#xmlName": "s3ExportLocation" - } - }, - "ImageId": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the image.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the image being exported.

", + "smithy.api#xmlName": "description" } } }, @@ -25674,22 +26568,6 @@ "com.amazonaws.ec2#ExportTask": { "type": "structure", "members": { - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message related to the export task.

", - "smithy.api#xmlName": "statusMessage" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the resource being exported.

", - "smithy.api#xmlName": "description" - } - }, "InstanceExportDetails": { "target": "com.amazonaws.ec2#InstanceExportDetails", "traits": { @@ -25698,12 +26576,20 @@ "smithy.api#xmlName": "instanceExport" } }, - "State": { - "target": "com.amazonaws.ec2#ExportTaskState", + "ExportTaskId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the export task.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "ExportTaskId", + "smithy.api#documentation": "

The ID of the export task.

", + "smithy.api#xmlName": "exportTaskId" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message related to the export task.

", + "smithy.api#xmlName": "statusMessage" } }, "ExportToS3Task": { @@ -25714,6 +26600,14 @@ "smithy.api#xmlName": "exportToS3" } }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the resource being exported.

", + "smithy.api#xmlName": "description" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -25722,12 +26616,12 @@ "smithy.api#xmlName": "tagSet" } }, - "ExportTaskId": { - "target": "com.amazonaws.ec2#String", + "State": { + "target": "com.amazonaws.ec2#ExportTaskState", "traits": { - "aws.protocols#ec2QueryName": "ExportTaskId", - "smithy.api#documentation": "

The ID of the export task.

", - "smithy.api#xmlName": "exportTaskId" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the export task.

", + "smithy.api#xmlName": "state" } } }, @@ -25759,14 +26653,6 @@ "com.amazonaws.ec2#ExportTaskS3Location": { "type": "structure", "members": { - "S3Prefix": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Prefix", - "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

", - "smithy.api#xmlName": "s3Prefix" - } - }, "S3Bucket": { "target": "com.amazonaws.ec2#String", "traits": { @@ -25774,6 +26660,14 @@ "smithy.api#documentation": "

The destination Amazon S3 bucket.

", "smithy.api#xmlName": "s3Bucket" } + }, + "S3Prefix": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Prefix", + "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

", + "smithy.api#xmlName": "s3Prefix" + } } }, "traits": { @@ -25783,17 +26677,17 @@ "com.amazonaws.ec2#ExportTaskS3LocationRequest": { "type": "structure", "members": { - "S3Prefix": { + "S3Bucket": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

" + "smithy.api#documentation": "

The destination Amazon S3 bucket.

", + "smithy.api#required": {} } }, - "S3Bucket": { + "S3Prefix": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The destination Amazon S3 bucket.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The prefix (logical hierarchy) in the bucket.

" } } }, @@ -25823,22 +26717,6 @@ "com.amazonaws.ec2#ExportToS3Task": { "type": "structure", "members": { - "S3Key": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Key", - "smithy.api#documentation": "

The encryption key for your S3 bucket.

", - "smithy.api#xmlName": "s3Key" - } - }, - "DiskImageFormat": { - "target": "com.amazonaws.ec2#DiskImageFormat", - "traits": { - "aws.protocols#ec2QueryName": "DiskImageFormat", - "smithy.api#documentation": "

The format for the exported image.

", - "smithy.api#xmlName": "diskImageFormat" - } - }, "S3Bucket": { "target": "com.amazonaws.ec2#String", "traits": { @@ -25854,6 +26732,22 @@ "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", "smithy.api#xmlName": "containerFormat" } + }, + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, + "S3Key": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "S3Key", + "smithy.api#documentation": "

The encryption key for your S3 bucket.

", + "smithy.api#xmlName": "s3Key" + } } }, "traits": { @@ -25863,6 +26757,14 @@ "com.amazonaws.ec2#ExportToS3TaskSpecification": { "type": "structure", "members": { + "DiskImageFormat": { + "target": "com.amazonaws.ec2#DiskImageFormat", + "traits": { + "aws.protocols#ec2QueryName": "DiskImageFormat", + "smithy.api#documentation": "

The format for the exported image.

", + "smithy.api#xmlName": "diskImageFormat" + } + }, "ContainerFormat": { "target": "com.amazonaws.ec2#ContainerFormat", "traits": { @@ -25871,14 +26773,6 @@ "smithy.api#xmlName": "containerFormat" } }, - "S3Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "S3Bucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant\n WRITE and READ_ACP permissions to the AWS account\n vm-import-export@amazon.com.

", - "smithy.api#xmlName": "s3Bucket" - } - }, "S3Prefix": { "target": "com.amazonaws.ec2#String", "traits": { @@ -25887,12 +26781,12 @@ "smithy.api#xmlName": "s3Prefix" } }, - "DiskImageFormat": { - "target": "com.amazonaws.ec2#DiskImageFormat", + "S3Bucket": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DiskImageFormat", - "smithy.api#documentation": "

The format for the exported image.

", - "smithy.api#xmlName": "diskImageFormat" + "aws.protocols#ec2QueryName": "S3Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant\n WRITE and READ_ACP permissions to the AWS account\n vm-import-export@amazon.com.

", + "smithy.api#xmlName": "s3Bucket" } } }, @@ -25915,30 +26809,30 @@ "com.amazonaws.ec2#ExportTransitGatewayRoutesRequest": { "type": "structure", "members": { - "S3Bucket": { - "target": "com.amazonaws.ec2#String", + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#documentation": "

The ID of the route table.

", "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the route table.

", + "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.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

", "smithy.api#required": {} } } @@ -25963,14 +26857,6 @@ "com.amazonaws.ec2#FailedQueuedPurchaseDeletion": { "type": "structure", "members": { - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" - } - }, "Error": { "target": "com.amazonaws.ec2#DeleteQueuedReservedInstancesError", "traits": { @@ -25978,6 +26864,14 @@ "smithy.api#documentation": "

The error.

", "smithy.api#xmlName": "error" } + }, + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" + } } }, "traits": { @@ -26048,18 +26942,18 @@ "com.amazonaws.ec2#Filter": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

" + } + }, "Values": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { "smithy.api#documentation": "

The filter values. Filter values are case-sensitive.

", "smithy.api#xmlName": "Value" } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

" - } } }, "traits": { @@ -26112,84 +27006,84 @@ "com.amazonaws.ec2#FleetData": { "type": "structure", "members": { - "ReplaceUnhealthyInstances": { - "target": "com.amazonaws.ec2#Boolean", + "FleetId": { + "target": "com.amazonaws.ec2#FleetId", "traits": { - "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", - "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy instances.

", - "smithy.api#xmlName": "replaceUnhealthyInstances" + "aws.protocols#ec2QueryName": "FleetId", + "smithy.api#documentation": "

The ID of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetId" } }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", + "Type": { + "target": "com.amazonaws.ec2#FleetType", "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The creation date and time of the EC2 Fleet.

", - "smithy.api#xmlName": "createTime" + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of request. Indicates whether the EC2 Fleet only requests the target\n capacity, or also attempts to maintain it. If you request a certain target\n capacity, EC2 Fleet only places the required requests; it does not attempt to replenish\n instances if capacity is diminished, and it does not submit requests in alternative\n capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet\n places the required requests to meet this target capacity. It also automatically\n replenishes any interrupted Spot Instances. Default: maintain.

", + "smithy.api#xmlName": "type" } }, - "TerminateInstancesWithExpiration": { - "target": "com.amazonaws.ec2#Boolean", + "Instances": { + "target": "com.amazonaws.ec2#DescribeFleetsInstancesSet", "traits": { - "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", - "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

", - "smithy.api#xmlName": "terminateInstancesWithExpiration" + "aws.protocols#ec2QueryName": "FleetInstanceSet", + "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

", + "smithy.api#xmlName": "fleetInstanceSet" } }, - "OnDemandOptions": { - "target": "com.amazonaws.ec2#OnDemandOptions", + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "OnDemandOptions", - "smithy.api#documentation": "

The allocation strategy of On-Demand Instances in an EC2 Fleet.

", - "smithy.api#xmlName": "onDemandOptions" + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new instance requests are placed or able to fulfill the request. The\n default end date is 7 days from the current date.

", + "smithy.api#xmlName": "validUntil" } }, - "ActivityStatus": { - "target": "com.amazonaws.ec2#FleetActivityStatus", + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "ActivityStatus", - "smithy.api#documentation": "

The progress of the EC2 Fleet. If there is an error, the status is error. After\n all requests are placed, the status is pending_fulfillment. If the size of the\n EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the EC2 Fleet is decreased, the status is pending_termination while\n instances are terminating.

", - "smithy.api#xmlName": "activityStatus" + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target\n capacity.

", + "smithy.api#xmlName": "fulfilledCapacity" } }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n At this point, no new instance requests are placed or able to fulfill the request. The\n default end date is 7 days from the current date.

", - "smithy.api#xmlName": "validUntil" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for an EC2 Fleet resource.

", + "smithy.api#xmlName": "tagSet" } }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "TargetCapacitySpecification": { + "target": "com.amazonaws.ec2#TargetCapacitySpecification", "traits": { - "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity of the\n EC2 Fleet is decreased below the current size of the EC2 Fleet.

", - "smithy.api#xmlName": "excessCapacityTerminationPolicy" + "aws.protocols#ec2QueryName": "TargetCapacitySpecification", + "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

", + "smithy.api#xmlName": "targetCapacitySpecification" } }, - "Errors": { - "target": "com.amazonaws.ec2#DescribeFleetsErrorSet", + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "ErrorSet", - "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.

", - "smithy.api#xmlName": "errorSet" + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

", + "smithy.api#xmlName": "validFrom" } }, - "FulfilledOnDemandCapacity": { - "target": "com.amazonaws.ec2#Double", + "ActivityStatus": { + "target": "com.amazonaws.ec2#FleetActivityStatus", "traits": { - "aws.protocols#ec2QueryName": "FulfilledOnDemandCapacity", - "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target On-Demand\n capacity.

", - "smithy.api#xmlName": "fulfilledOnDemandCapacity" + "aws.protocols#ec2QueryName": "ActivityStatus", + "smithy.api#documentation": "

The progress of the EC2 Fleet. If there is an error, the status is error. After\n all requests are placed, the status is pending_fulfillment. If the size of the\n EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the EC2 Fleet is decreased, the status is pending_termination while\n instances are terminating.

", + "smithy.api#xmlName": "activityStatus" } }, - "Instances": { - "target": "com.amazonaws.ec2#DescribeFleetsInstancesSet", + "OnDemandOptions": { + "target": "com.amazonaws.ec2#OnDemandOptions", "traits": { - "aws.protocols#ec2QueryName": "FleetInstanceSet", - "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

", - "smithy.api#xmlName": "fleetInstanceSet" + "aws.protocols#ec2QueryName": "OnDemandOptions", + "smithy.api#documentation": "

The allocation strategy of On-Demand Instances in an EC2 Fleet.

", + "smithy.api#xmlName": "onDemandOptions" } }, "ClientToken": { @@ -26200,76 +27094,76 @@ "smithy.api#xmlName": "clientToken" } }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date and time of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The default is to start fulfilling the request immediately.

", - "smithy.api#xmlName": "validFrom" + "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", + "smithy.api#documentation": "

Indicates whether running instances should be terminated when the EC2 Fleet expires.

", + "smithy.api#xmlName": "terminateInstancesWithExpiration" } }, - "SpotOptions": { - "target": "com.amazonaws.ec2#SpotOptions", + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SpotOptions", - "smithy.api#documentation": "

The configuration of Spot Instances in an EC2 Fleet.

", - "smithy.api#xmlName": "spotOptions" + "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", + "smithy.api#documentation": "

Indicates whether EC2 Fleet should replace unhealthy instances.

", + "smithy.api#xmlName": "replaceUnhealthyInstances" } }, - "FleetState": { - "target": "com.amazonaws.ec2#FleetStateCode", + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigList", "traits": { - "aws.protocols#ec2QueryName": "FleetState", - "smithy.api#documentation": "

The state of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetState" + "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", + "smithy.api#documentation": "

The launch template and overrides.

", + "smithy.api#xmlName": "launchTemplateConfigs" } }, - "TargetCapacitySpecification": { - "target": "com.amazonaws.ec2#TargetCapacitySpecification", + "Errors": { + "target": "com.amazonaws.ec2#DescribeFleetsErrorSet", "traits": { - "aws.protocols#ec2QueryName": "TargetCapacitySpecification", - "smithy.api#documentation": "

The number of units to request. You can choose to set the target capacity in terms of\n instances or a performance characteristic that is important to your application workload,\n such as vCPUs, memory, or I/O. If the request type is maintain, you can\n specify a target capacity of 0 and add capacity later.

", - "smithy.api#xmlName": "targetCapacitySpecification" + "aws.protocols#ec2QueryName": "ErrorSet", + "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.

", + "smithy.api#xmlName": "errorSet" } }, - "LaunchTemplateConfigs": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigList", + "FleetState": { + "target": "com.amazonaws.ec2#FleetStateCode", "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", - "smithy.api#documentation": "

The launch template and overrides.

", - "smithy.api#xmlName": "launchTemplateConfigs" + "aws.protocols#ec2QueryName": "FleetState", + "smithy.api#documentation": "

The state of the EC2 Fleet.

", + "smithy.api#xmlName": "fleetState" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "SpotOptions": { + "target": "com.amazonaws.ec2#SpotOptions", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for an EC2 Fleet resource.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "SpotOptions", + "smithy.api#documentation": "

The configuration of Spot Instances in an EC2 Fleet.

", + "smithy.api#xmlName": "spotOptions" } }, - "FleetId": { - "target": "com.amazonaws.ec2#FleetId", + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "FleetId", - "smithy.api#documentation": "

The ID of the EC2 Fleet.

", - "smithy.api#xmlName": "fleetId" + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The creation date and time of the EC2 Fleet.

", + "smithy.api#xmlName": "createTime" } }, - "FulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", "traits": { - "aws.protocols#ec2QueryName": "FulfilledCapacity", - "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target\n capacity.

", - "smithy.api#xmlName": "fulfilledCapacity" + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity of the\n EC2 Fleet is decreased below the current size of the EC2 Fleet.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" } }, - "Type": { - "target": "com.amazonaws.ec2#FleetType", + "FulfilledOnDemandCapacity": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of request. Indicates whether the EC2 Fleet only requests the target\n capacity, or also attempts to maintain it. If you request a certain target\n capacity, EC2 Fleet only places the required requests; it does not attempt to replenish\n instances if capacity is diminished, and it does not submit requests in alternative\n capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet\n places the required requests to meet this target capacity. It also automatically\n replenishes any interrupted Spot Instances. Default: maintain.

", - "smithy.api#xmlName": "type" + "aws.protocols#ec2QueryName": "FulfilledOnDemandCapacity", + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target On-Demand\n capacity.

", + "smithy.api#xmlName": "fulfilledOnDemandCapacity" } } }, @@ -26371,17 +27265,17 @@ "com.amazonaws.ec2#FleetLaunchTemplateConfigRequest": { "type": "structure", "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest", - "traits": { - "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request.

" - } - }, "Overrides": { "target": "com.amazonaws.ec2#FleetLaunchTemplateOverridesListRequest", "traits": { "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

" } + }, + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The launch template to use. You must specify either the launch template ID or launch\n template name in the request.

" + } } }, "traits": { @@ -26391,28 +27285,28 @@ "com.amazonaws.ec2#FleetLaunchTemplateOverrides": { "type": "structure", "members": { - "WeightedCapacity": { - "target": "com.amazonaws.ec2#Double", + "Placement": { + "target": "com.amazonaws.ec2#PlacementResponse", "traits": { - "aws.protocols#ec2QueryName": "WeightedCapacity", - "smithy.api#documentation": "

The number of units provided by the specified instance type.

", - "smithy.api#xmlName": "weightedCapacity" + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The location where the instance launched, if applicable.

", + "smithy.api#xmlName": "placement" } }, - "Priority": { - "target": "com.amazonaws.ec2#Double", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "Priority", - "smithy.api#documentation": "

The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to\n determine which launch template override to use first in fulfilling On-Demand capacity. The\n highest priority is launched first. Valid values are whole numbers starting at\n 0. The lower the number, the higher the priority. If no number is set, the\n override has the lowest priority.

", - "smithy.api#xmlName": "priority" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" } }, - "AvailabilityZone": { + "MaxPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "MaxPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

", + "smithy.api#xmlName": "maxPrice" } }, "SubnetId": { @@ -26423,28 +27317,28 @@ "smithy.api#xmlName": "subnetId" } }, - "Placement": { - "target": "com.amazonaws.ec2#PlacementResponse", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The location where the instance launched, if applicable.

", - "smithy.api#xmlName": "placement" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", + "smithy.api#xmlName": "availabilityZone" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#documentation": "

The number of units provided by the specified instance type.

", + "smithy.api#xmlName": "weightedCapacity" } }, - "MaxPrice": { - "target": "com.amazonaws.ec2#String", + "Priority": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "MaxPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

", - "smithy.api#xmlName": "maxPrice" + "aws.protocols#ec2QueryName": "Priority", + "smithy.api#documentation": "

The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to\n determine which launch template override to use first in fulfilling On-Demand capacity. The\n highest priority is launched first. Valid values are whole numbers starting at\n 0. The lower the number, the higher the priority. If no number is set, the\n override has the lowest priority.

", + "smithy.api#xmlName": "priority" } } }, @@ -26479,22 +27373,10 @@ "com.amazonaws.ec2#FleetLaunchTemplateOverridesRequest": { "type": "structure", "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type.

" - } - }, - "Priority": { + "WeightedCapacity": { "target": "com.amazonaws.ec2#Double", "traits": { - "smithy.api#documentation": "

The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to\n determine which launch template override to use first in fulfilling On-Demand capacity. The\n highest priority is launched first. Valid values are whole numbers starting at\n 0. The lower the number, the higher the priority. If no number is set, the\n launch template override has the lowest priority.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.

" + "smithy.api#documentation": "

The number of units provided by the specified instance type.

" } }, "MaxPrice": { @@ -26503,12 +27385,6 @@ "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

" } }, - "WeightedCapacity": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "smithy.api#documentation": "

The number of units provided by the specified instance type.

" - } - }, "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { @@ -26520,6 +27396,24 @@ "traits": { "smithy.api#documentation": "

The location where the instance launched, if applicable.

" } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "smithy.api#documentation": "

The instance type.

" + } + }, + "Priority": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "smithy.api#documentation": "

The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to\n determine which launch template override to use first in fulfilling On-Demand capacity. The\n highest priority is launched first. Valid values are whole numbers starting at\n 0. The lower the number, the higher the priority. If no number is set, the\n launch template override has the lowest priority.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.

" + } } }, "traits": { @@ -26529,14 +27423,6 @@ "com.amazonaws.ec2#FleetLaunchTemplateSpecification": { "type": "structure", "members": { - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template. If you specify the template name, you can't specify the template ID.

", - "smithy.api#xmlName": "launchTemplateName" - } - }, "Version": { "target": "com.amazonaws.ec2#String", "traits": { @@ -26545,6 +27431,14 @@ "smithy.api#xmlName": "version" } }, + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template. If you specify the template name, you can't specify the template ID.

", + "smithy.api#xmlName": "launchTemplateName" + } + }, "LaunchTemplateId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -26561,20 +27455,20 @@ "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch template.

" - } - }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { "smithy.api#documentation": "

The name of the launch template. If you specify the template name, you can't specify the template ID.

" } }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", + "Version": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch template.

" + } + }, + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { "smithy.api#documentation": "

The ID of the launch template. If you specify the template ID, you can't specify the template name.

" } @@ -26668,36 +27562,36 @@ "com.amazonaws.ec2#FlowLog": { "type": "structure", "members": { - "LogDestinationType": { - "target": "com.amazonaws.ec2#LogDestinationType", + "DeliverLogsStatus": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LogDestinationType", - "smithy.api#documentation": "

Specifies the type of destination to which the flow log data is published. Flow log data can be \n published to CloudWatch Logs or Amazon S3.

", - "smithy.api#xmlName": "logDestinationType" + "aws.protocols#ec2QueryName": "DeliverLogsStatus", + "smithy.api#documentation": "

The status of the logs delivery (SUCCESS | FAILED).

", + "smithy.api#xmlName": "deliverLogsStatus" } }, - "ResourceId": { + "FlowLogStatus": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource on which the flow log was created.

", - "smithy.api#xmlName": "resourceId" + "aws.protocols#ec2QueryName": "FlowLogStatus", + "smithy.api#documentation": "

The status of the flow log (ACTIVE).

", + "smithy.api#xmlName": "flowLogStatus" } }, - "LogDestination": { + "LogGroupName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LogDestination", - "smithy.api#documentation": "

Specifies the destination to which the flow log data is published. Flow log data can be\n published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs,\n this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which\n the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN\n of the Amazon S3 bucket to which the data is published.

", - "smithy.api#xmlName": "logDestination" + "aws.protocols#ec2QueryName": "LogGroupName", + "smithy.api#documentation": "

The name of the flow log group.

", + "smithy.api#xmlName": "logGroupName" } }, - "DeliverLogsPermissionArn": { - "target": "com.amazonaws.ec2#String", + "TrafficType": { + "target": "com.amazonaws.ec2#TrafficType", "traits": { - "aws.protocols#ec2QueryName": "DeliverLogsPermissionArn", - "smithy.api#documentation": "

The ARN of the IAM role that posts logs to CloudWatch Logs.

", - "smithy.api#xmlName": "deliverLogsPermissionArn" + "aws.protocols#ec2QueryName": "TrafficType", + "smithy.api#documentation": "

The type of traffic captured for the flow log.

", + "smithy.api#xmlName": "trafficType" } }, "Tags": { @@ -26708,60 +27602,60 @@ "smithy.api#xmlName": "tagSet" } }, - "FlowLogId": { + "DeliverLogsErrorMessage": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "FlowLogId", - "smithy.api#documentation": "

The flow log ID.

", - "smithy.api#xmlName": "flowLogId" + "aws.protocols#ec2QueryName": "DeliverLogsErrorMessage", + "smithy.api#documentation": "

Information about the error that occurred. Rate limited indicates that\n CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've\n reached the limit on the number of log groups that you can create. Access\n error indicates that the IAM role associated with the flow log does not have\n sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an\n internal error.

", + "smithy.api#xmlName": "deliverLogsErrorMessage" } }, - "CreationTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "LogDestination": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The date and time the flow log was created.

", - "smithy.api#xmlName": "creationTime" + "aws.protocols#ec2QueryName": "LogDestination", + "smithy.api#documentation": "

Specifies the destination to which the flow log data is published. Flow log data can be\n published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs,\n this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which\n the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN\n of the Amazon S3 bucket to which the data is published.

", + "smithy.api#xmlName": "logDestination" } }, - "TrafficType": { - "target": "com.amazonaws.ec2#TrafficType", + "DeliverLogsPermissionArn": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TrafficType", - "smithy.api#documentation": "

The type of traffic captured for the flow log.

", - "smithy.api#xmlName": "trafficType" + "aws.protocols#ec2QueryName": "DeliverLogsPermissionArn", + "smithy.api#documentation": "

The ARN of the IAM role that posts logs to CloudWatch Logs.

", + "smithy.api#xmlName": "deliverLogsPermissionArn" } }, - "DeliverLogsStatus": { + "ResourceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeliverLogsStatus", - "smithy.api#documentation": "

The status of the logs delivery (SUCCESS | FAILED).

", - "smithy.api#xmlName": "deliverLogsStatus" + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource on which the flow log was created.

", + "smithy.api#xmlName": "resourceId" } }, - "LogGroupName": { - "target": "com.amazonaws.ec2#String", + "LogDestinationType": { + "target": "com.amazonaws.ec2#LogDestinationType", "traits": { - "aws.protocols#ec2QueryName": "LogGroupName", - "smithy.api#documentation": "

The name of the flow log group.

", - "smithy.api#xmlName": "logGroupName" + "aws.protocols#ec2QueryName": "LogDestinationType", + "smithy.api#documentation": "

Specifies the type of destination to which the flow log data is published. Flow log data can be \n published to CloudWatch Logs or Amazon S3.

", + "smithy.api#xmlName": "logDestinationType" } }, - "FlowLogStatus": { - "target": "com.amazonaws.ec2#String", + "CreationTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "FlowLogStatus", - "smithy.api#documentation": "

The status of the flow log (ACTIVE).

", - "smithy.api#xmlName": "flowLogStatus" + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The date and time the flow log was created.

", + "smithy.api#xmlName": "creationTime" } }, - "MaxAggregationInterval": { - "target": "com.amazonaws.ec2#Integer", + "FlowLogId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "MaxAggregationInterval", - "smithy.api#documentation": "

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.

\n

Valid Values: 60 | 600\n

", - "smithy.api#xmlName": "maxAggregationInterval" + "aws.protocols#ec2QueryName": "FlowLogId", + "smithy.api#documentation": "

The flow log ID.

", + "smithy.api#xmlName": "flowLogId" } }, "LogFormat": { @@ -26772,12 +27666,12 @@ "smithy.api#xmlName": "logFormat" } }, - "DeliverLogsErrorMessage": { - "target": "com.amazonaws.ec2#String", + "MaxAggregationInterval": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "DeliverLogsErrorMessage", - "smithy.api#documentation": "

Information about the error that occurred. Rate limited indicates that\n CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've\n reached the limit on the number of log groups that you can create. Access\n error indicates that the IAM role associated with the flow log does not have\n sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an\n internal error.

", - "smithy.api#xmlName": "deliverLogsErrorMessage" + "aws.protocols#ec2QueryName": "MaxAggregationInterval", + "smithy.api#documentation": "

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.

\n

Valid Values: 60 | 600\n

", + "smithy.api#xmlName": "maxAggregationInterval" } } }, @@ -26848,12 +27742,12 @@ "smithy.api#xmlName": "name" } }, - "MemoryInfo": { - "target": "com.amazonaws.ec2#FpgaDeviceMemoryInfo", + "Count": { + "target": "com.amazonaws.ec2#FpgaDeviceCount", "traits": { - "aws.protocols#ec2QueryName": "MemoryInfo", - "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

", - "smithy.api#xmlName": "memoryInfo" + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The count of FPGA accelerators for the instance type.

", + "smithy.api#xmlName": "count" } }, "Manufacturer": { @@ -26864,12 +27758,12 @@ "smithy.api#xmlName": "manufacturer" } }, - "Count": { - "target": "com.amazonaws.ec2#FpgaDeviceCount", + "MemoryInfo": { + "target": "com.amazonaws.ec2#FpgaDeviceMemoryInfo", "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The count of FPGA accelerators for the instance type.

", - "smithy.api#xmlName": "count" + "aws.protocols#ec2QueryName": "MemoryInfo", + "smithy.api#documentation": "

Describes the memory for the FPGA accelerator for the instance type.

", + "smithy.api#xmlName": "memoryInfo" } } }, @@ -26917,100 +27811,108 @@ "com.amazonaws.ec2#FpgaImage": { "type": "structure", "members": { - "UpdateTime": { - "target": "com.amazonaws.ec2#DateTime", + "ShellVersion": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UpdateTime", - "smithy.api#documentation": "

The time of the most recent update to the AFI.

", - "smithy.api#xmlName": "updateTime" + "aws.protocols#ec2QueryName": "ShellVersion", + "smithy.api#documentation": "

The version of the AWS Shell that was used to create the bitstream.

", + "smithy.api#xmlName": "shellVersion" } }, - "FpgaImageGlobalId": { - "target": "com.amazonaws.ec2#String", + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", "traits": { - "aws.protocols#ec2QueryName": "FpgaImageGlobalId", - "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", - "smithy.api#xmlName": "fpgaImageGlobalId" + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes for the AFI.

", + "smithy.api#xmlName": "productCodes" } }, - "Name": { + "OwnerAlias": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the AFI.

", - "smithy.api#xmlName": "name" + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.

", + "smithy.api#xmlName": "ownerAlias" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Tags", - "smithy.api#documentation": "

Any tags assigned to the AFI.

", - "smithy.api#xmlName": "tags" + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time the AFI was created.

", + "smithy.api#xmlName": "createTime" } }, - "State": { - "target": "com.amazonaws.ec2#FpgaImageState", + "Public": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

Information about the state of the AFI.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "Public", + "smithy.api#documentation": "

Indicates whether the AFI is public.

", + "smithy.api#xmlName": "public" } }, - "OwnerId": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The AWS account ID of the AFI owner.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AFI.

", + "smithy.api#xmlName": "description" } }, - "Public": { - "target": "com.amazonaws.ec2#Boolean", + "PciId": { + "target": "com.amazonaws.ec2#PciId", "traits": { - "aws.protocols#ec2QueryName": "Public", - "smithy.api#documentation": "

Indicates whether the AFI is public.

", - "smithy.api#xmlName": "public" + "aws.protocols#ec2QueryName": "PciId", + "smithy.api#documentation": "

Information about the PCI bus.

", + "smithy.api#xmlName": "pciId" } }, - "CreateTime": { + "UpdateTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The date and time the AFI was created.

", - "smithy.api#xmlName": "createTime" + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The time of the most recent update to the AFI.

", + "smithy.api#xmlName": "updateTime" } }, - "ShellVersion": { + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tags", + "smithy.api#documentation": "

Any tags assigned to the AFI.

", + "smithy.api#xmlName": "tags" + } + }, + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ShellVersion", - "smithy.api#documentation": "

The version of the AWS Shell that was used to create the bitstream.

", - "smithy.api#xmlName": "shellVersion" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID of the AFI owner.

", + "smithy.api#xmlName": "ownerId" } }, - "FpgaImageId": { + "FpgaImageGlobalId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "FpgaImageId", - "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", - "smithy.api#xmlName": "fpgaImageId" + "aws.protocols#ec2QueryName": "FpgaImageGlobalId", + "smithy.api#documentation": "

The global FPGA image identifier (AGFI ID).

", + "smithy.api#xmlName": "fpgaImageGlobalId" } }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", + "State": { + "target": "com.amazonaws.ec2#FpgaImageState", "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes for the AFI.

", - "smithy.api#xmlName": "productCodes" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Information about the state of the AFI.

", + "smithy.api#xmlName": "state" } }, - "Description": { + "FpgaImageId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the AFI.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The FPGA image identifier (AFI ID).

", + "smithy.api#xmlName": "fpgaImageId" } }, "DataRetentionSupport": { @@ -27021,20 +27923,12 @@ "smithy.api#xmlName": "dataRetentionSupport" } }, - "OwnerAlias": { + "Name": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.

", - "smithy.api#xmlName": "ownerAlias" - } - }, - "PciId": { - "target": "com.amazonaws.ec2#PciId", - "traits": { - "aws.protocols#ec2QueryName": "PciId", - "smithy.api#documentation": "

Information about the PCI bus.

", - "smithy.api#xmlName": "pciId" + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AFI.

", + "smithy.api#xmlName": "name" } } }, @@ -27045,12 +27939,20 @@ "com.amazonaws.ec2#FpgaImageAttribute": { "type": "structure", "members": { - "LoadPermissions": { - "target": "com.amazonaws.ec2#LoadPermissionList", + "FpgaImageId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LoadPermissions", - "smithy.api#documentation": "

The load permissions.

", - "smithy.api#xmlName": "loadPermissions" + "aws.protocols#ec2QueryName": "FpgaImageId", + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#xmlName": "fpgaImageId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AFI.

", + "smithy.api#xmlName": "name" } }, "ProductCodes": { @@ -27061,6 +27963,14 @@ "smithy.api#xmlName": "productCodes" } }, + "LoadPermissions": { + "target": "com.amazonaws.ec2#LoadPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "LoadPermissions", + "smithy.api#documentation": "

The load permissions.

", + "smithy.api#xmlName": "loadPermissions" + } + }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -27068,22 +27978,6 @@ "smithy.api#documentation": "

The description of the AFI.

", "smithy.api#xmlName": "description" } - }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the AFI.

", - "smithy.api#xmlName": "name" - } - }, - "FpgaImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "FpgaImageId", - "smithy.api#documentation": "

The ID of the AFI.

", - "smithy.api#xmlName": "fpgaImageId" - } } }, "traits": { @@ -27133,14 +28027,6 @@ "com.amazonaws.ec2#FpgaImageState": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#FpgaImageStateCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state. The following are the possible values:

\n\t\t ", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -27148,6 +28034,14 @@ "smithy.api#documentation": "

If the state is failed, this is the error message.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#FpgaImageStateCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The state. The following are the possible values:

\n\t\t ", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -27176,14 +28070,6 @@ "com.amazonaws.ec2#FpgaInfo": { "type": "structure", "members": { - "TotalFpgaMemoryInMiB": { - "target": "com.amazonaws.ec2#totalFpgaMemory", - "traits": { - "aws.protocols#ec2QueryName": "TotalFpgaMemoryInMiB", - "smithy.api#documentation": "

The total memory of all FPGA accelerators for the instance type.

", - "smithy.api#xmlName": "totalFpgaMemoryInMiB" - } - }, "Fpgas": { "target": "com.amazonaws.ec2#FpgaDeviceInfoList", "traits": { @@ -27191,6 +28077,14 @@ "smithy.api#documentation": "

Describes the FPGAs for the instance type.

", "smithy.api#xmlName": "fpgas" } + }, + "TotalFpgaMemoryInMiB": { + "target": "com.amazonaws.ec2#totalFpgaMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalFpgaMemoryInMiB", + "smithy.api#documentation": "

The total memory of all FPGA accelerators for the instance type.

", + "smithy.api#xmlName": "totalFpgaMemoryInMiB" + } } }, "traits": { @@ -27222,7 +28116,13 @@ "target": "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsResult" }, "traits": { - "smithy.api#documentation": "

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

" + "smithy.api#documentation": "

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ipv6CidrAssociations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetAssociatedIpv6PoolCidrsRequest": { @@ -27235,12 +28135,6 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", - "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.ec2#NextToken", "traits": { @@ -27252,6 +28146,12 @@ "traits": { "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.

" } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Ipv6PoolMaxResults", + "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.

" + } } } }, @@ -27291,6 +28191,12 @@ "com.amazonaws.ec2#GetCapacityReservationUsageRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "CapacityReservationId": { "target": "com.amazonaws.ec2#CapacityReservationId", "traits": { @@ -27309,12 +28215,6 @@ "traits": { "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } } } }, @@ -27330,12 +28230,12 @@ "com.amazonaws.ec2#GetCapacityReservationUsageResult": { "type": "structure", "members": { - "TotalInstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "InstanceUsages": { + "target": "com.amazonaws.ec2#InstanceUsageSet", "traits": { - "aws.protocols#ec2QueryName": "TotalInstanceCount", - "smithy.api#documentation": "

The number of instances for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "totalInstanceCount" + "aws.protocols#ec2QueryName": "InstanceUsageSet", + "smithy.api#documentation": "

Information about the Capacity Reservation usage.

", + "smithy.api#xmlName": "instanceUsageSet" } }, "CapacityReservationId": { @@ -27346,22 +28246,6 @@ "smithy.api#xmlName": "capacityReservationId" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", - "smithy.api#xmlName": "instanceType" - } - }, - "State": { - "target": "com.amazonaws.ec2#CapacityReservationState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n\t\t\t ", - "smithy.api#xmlName": "state" - } - }, "AvailableInstanceCount": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -27370,12 +28254,20 @@ "smithy.api#xmlName": "availableInstanceCount" } }, - "InstanceUsages": { - "target": "com.amazonaws.ec2#InstanceUsageSet", + "TotalInstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "InstanceUsageSet", - "smithy.api#documentation": "

Information about the Capacity Reservation usage.

", - "smithy.api#xmlName": "instanceUsageSet" + "aws.protocols#ec2QueryName": "TotalInstanceCount", + "smithy.api#documentation": "

The number of instances for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "totalInstanceCount" + } + }, + "State": { + "target": "com.amazonaws.ec2#CapacityReservationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n\t\t\t ", + "smithy.api#xmlName": "state" } }, "NextToken": { @@ -27385,6 +28277,14 @@ "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#xmlName": "nextToken" } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The type of instance for which the Capacity Reservation reserves capacity.

", + "smithy.api#xmlName": "instanceType" + } } } }, @@ -27417,6 +28317,12 @@ "smithy.api#xmlName": "Filter" } }, + "MaxResults": { + "target": "com.amazonaws.ec2#CoipPoolMaxResults", + "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.ec2#String", "traits": { @@ -27428,24 +28334,18 @@ "traits": { "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.

" } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#CoipPoolMaxResults", - "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.

" - } } } }, "com.amazonaws.ec2#GetCoipPoolUsageResult": { "type": "structure", "members": { - "CoipAddressUsages": { - "target": "com.amazonaws.ec2#CoipAddressUsageSet", + "CoipPoolId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CoipAddressUsageSet", - "smithy.api#documentation": "

Information about the address usage.

", - "smithy.api#xmlName": "coipAddressUsageSet" + "aws.protocols#ec2QueryName": "CoipPoolId", + "smithy.api#documentation": "

The ID of the customer-owned address pool.

", + "smithy.api#xmlName": "coipPoolId" } }, "LocalGatewayRouteTableId": { @@ -27456,12 +28356,12 @@ "smithy.api#xmlName": "localGatewayRouteTableId" } }, - "CoipPoolId": { - "target": "com.amazonaws.ec2#String", + "CoipAddressUsages": { + "target": "com.amazonaws.ec2#CoipAddressUsageSet", "traits": { - "aws.protocols#ec2QueryName": "CoipPoolId", - "smithy.api#documentation": "

The ID of the customer-owned address pool.

", - "smithy.api#xmlName": "coipPoolId" + "aws.protocols#ec2QueryName": "CoipAddressUsageSet", + "smithy.api#documentation": "

Information about the address usage.

", + "smithy.api#xmlName": "coipAddressUsageSet" } } } @@ -27487,13 +28387,6 @@ "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -27501,18 +28394,25 @@ "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" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.ec2#GetConsoleOutputResult": { "type": "structure", "members": { - "Output": { - "target": "com.amazonaws.ec2#String", + "Timestamp": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Output", - "smithy.api#documentation": "

The console output, base64-encoded. If you are using a command line tool, the tool\n decodes the output for you.

", - "smithy.api#xmlName": "output" + "aws.protocols#ec2QueryName": "Timestamp", + "smithy.api#documentation": "

The time at which the output was last updated.

", + "smithy.api#xmlName": "timestamp" } }, "InstanceId": { @@ -27523,12 +28423,12 @@ "smithy.api#xmlName": "instanceId" } }, - "Timestamp": { - "target": "com.amazonaws.ec2#DateTime", + "Output": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The time at which the output was last updated.

", - "smithy.api#xmlName": "timestamp" + "aws.protocols#ec2QueryName": "Output", + "smithy.api#documentation": "

The console output, base64-encoded. If you are using a command line tool, the tool\n decodes the output for you.

", + "smithy.api#xmlName": "output" } } } @@ -27554,32 +28454,24 @@ "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.

" } }, + "WakeUp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

When set to true, acts as keystroke input and wakes up an instance that's\n in standby or \"sleep\" mode.

" + } + }, "InstanceId": { "target": "com.amazonaws.ec2#InstanceId", "traits": { "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#required": {} } - }, - "WakeUp": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

When set to true, acts as keystroke input and wakes up an instance that's\n in standby or \"sleep\" mode.

" - } } } }, "com.amazonaws.ec2#GetConsoleScreenshotResult": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, "ImageData": { "target": "com.amazonaws.ec2#String", "traits": { @@ -27587,6 +28479,14 @@ "smithy.api#documentation": "

The data that comprises the image.

", "smithy.api#xmlName": "imageData" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } } } }, @@ -27714,22 +28614,29 @@ "target": "com.amazonaws.ec2#GetGroupsForCapacityReservationResult" }, "traits": { - "smithy.api#documentation": "

Lists the resource groups to which a Capacity Reservation has been added.

" + "smithy.api#documentation": "

Lists the resource groups to which a Capacity Reservation has been added.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservationGroups", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetGroupsForCapacityReservationRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "MaxResults": { @@ -27738,11 +28645,10 @@ "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" } }, - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" } } } @@ -27811,14 +28717,6 @@ "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult": { "type": "structure", "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, "TotalHourlyPrice": { "target": "com.amazonaws.ec2#String", "traits": { @@ -27827,6 +28725,14 @@ "smithy.api#xmlName": "totalHourlyPrice" } }, + "TotalUpfrontPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalUpfrontPrice", + "smithy.api#documentation": "

The potential total upfront price. This is billed immediately.

", + "smithy.api#xmlName": "totalUpfrontPrice" + } + }, "Purchase": { "target": "com.amazonaws.ec2#PurchaseSet", "traits": { @@ -27835,12 +28741,12 @@ "smithy.api#xmlName": "purchase" } }, - "TotalUpfrontPrice": { - "target": "com.amazonaws.ec2#String", + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { - "aws.protocols#ec2QueryName": "TotalUpfrontPrice", - "smithy.api#documentation": "

The potential total upfront price. This is billed immediately.

", - "smithy.api#xmlName": "totalUpfrontPrice" + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice and\n totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" } } } @@ -27897,7 +28803,13 @@ "target": "com.amazonaws.ec2#GetManagedPrefixListAssociationsResult" }, "traits": { - "smithy.api#documentation": "

Gets information about the resources that are associated with the specified managed prefix list.

" + "smithy.api#documentation": "

Gets information about the resources that are associated with the specified managed prefix list.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PrefixListAssociations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetManagedPrefixListAssociationsMaxResults": { @@ -27912,16 +28824,17 @@ "com.amazonaws.ec2#GetManagedPrefixListAssociationsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { - "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#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.ec2#NextToken", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "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.

" } }, "MaxResults": { @@ -27930,11 +28843,10 @@ "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.

" } }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", "traits": { - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next page of results.

" } } } @@ -27969,7 +28881,13 @@ "target": "com.amazonaws.ec2#GetManagedPrefixListEntriesResult" }, "traits": { - "smithy.api#documentation": "

Gets information about the entries for a specified managed prefix list.

" + "smithy.api#documentation": "

Gets information about the entries for a specified managed prefix list.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entries", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetManagedPrefixListEntriesRequest": { @@ -27981,18 +28899,6 @@ "smithy.api#documentation": "

The version of the prefix list for which to return the entries. The default is the current version.

" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#PrefixListMaxResults", - "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.ec2#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "PrefixListId": { "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { @@ -28005,20 +28911,24 @@ "traits": { "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.

" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#PrefixListMaxResults", + "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.

" + } } } }, "com.amazonaws.ec2#GetManagedPrefixListEntriesResult": { "type": "structure", "members": { - "Entries": { - "target": "com.amazonaws.ec2#PrefixListEntrySet", - "traits": { - "aws.protocols#ec2QueryName": "EntrySet", - "smithy.api#documentation": "

Information about the prefix list entries.

", - "smithy.api#xmlName": "entrySet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#NextToken", "traits": { @@ -28026,6 +28936,14 @@ "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#xmlName": "nextToken" } + }, + "Entries": { + "target": "com.amazonaws.ec2#PrefixListEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "EntrySet", + "smithy.api#documentation": "

Information about the prefix list entries.

", + "smithy.api#xmlName": "entrySet" + } } } }, @@ -28064,14 +28982,6 @@ "com.amazonaws.ec2#GetPasswordDataResult": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the Windows instance.

", - "smithy.api#xmlName": "instanceId" - } - }, "Timestamp": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -28080,6 +28990,14 @@ "smithy.api#xmlName": "timestamp" } }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the Windows instance.

", + "smithy.api#xmlName": "instanceId" + } + }, "PasswordData": { "target": "com.amazonaws.ec2#String", "traits": { @@ -28134,36 +29052,28 @@ "com.amazonaws.ec2#GetReservedInstancesExchangeQuoteResult": { "type": "structure", "members": { - "IsValidExchange": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsValidExchange", - "smithy.api#documentation": "

If true, the exchange is valid. If false, the exchange cannot be completed.

", - "smithy.api#xmlName": "isValidExchange" - } - }, - "ReservedInstanceValueSet": { - "target": "com.amazonaws.ec2#ReservedInstanceReservationValueSet", + "ValidationFailureReason": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ReservedInstanceValueSet", - "smithy.api#documentation": "

The configuration of your Convertible Reserved Instances.

", - "smithy.api#xmlName": "reservedInstanceValueSet" + "aws.protocols#ec2QueryName": "ValidationFailureReason", + "smithy.api#documentation": "

Describes the reason why the exchange cannot be completed.

", + "smithy.api#xmlName": "validationFailureReason" } }, - "TargetConfigurationValueSet": { - "target": "com.amazonaws.ec2#TargetReservationValueSet", + "CurrencyCode": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TargetConfigurationValueSet", - "smithy.api#documentation": "

The values of the target Convertible Reserved Instances.

", - "smithy.api#xmlName": "targetConfigurationValueSet" + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the transaction.

", + "smithy.api#xmlName": "currencyCode" } }, - "OutputReservedInstancesWillExpireAt": { - "target": "com.amazonaws.ec2#DateTime", + "IsValidExchange": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "OutputReservedInstancesWillExpireAt", - "smithy.api#documentation": "

The new end date of the reservation term.

", - "smithy.api#xmlName": "outputReservedInstancesWillExpireAt" + "aws.protocols#ec2QueryName": "IsValidExchange", + "smithy.api#documentation": "

If true, the exchange is valid. If false, the exchange cannot be completed.

", + "smithy.api#xmlName": "isValidExchange" } }, "TargetConfigurationValueRollup": { @@ -28174,12 +29084,12 @@ "smithy.api#xmlName": "targetConfigurationValueRollup" } }, - "ValidationFailureReason": { + "PaymentDue": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ValidationFailureReason", - "smithy.api#documentation": "

Describes the reason why the exchange cannot be completed.

", - "smithy.api#xmlName": "validationFailureReason" + "aws.protocols#ec2QueryName": "PaymentDue", + "smithy.api#documentation": "

The total true upfront charge for the exchange.

", + "smithy.api#xmlName": "paymentDue" } }, "ReservedInstanceValueRollup": { @@ -28190,20 +29100,28 @@ "smithy.api#xmlName": "reservedInstanceValueRollup" } }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#String", + "TargetConfigurationValueSet": { + "target": "com.amazonaws.ec2#TargetReservationValueSet", "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the transaction.

", - "smithy.api#xmlName": "currencyCode" + "aws.protocols#ec2QueryName": "TargetConfigurationValueSet", + "smithy.api#documentation": "

The values of the target Convertible Reserved Instances.

", + "smithy.api#xmlName": "targetConfigurationValueSet" } }, - "PaymentDue": { - "target": "com.amazonaws.ec2#String", + "ReservedInstanceValueSet": { + "target": "com.amazonaws.ec2#ReservedInstanceReservationValueSet", "traits": { - "aws.protocols#ec2QueryName": "PaymentDue", - "smithy.api#documentation": "

The total true upfront charge for the exchange.

", - "smithy.api#xmlName": "paymentDue" + "aws.protocols#ec2QueryName": "ReservedInstanceValueSet", + "smithy.api#documentation": "

The configuration of your Convertible Reserved Instances.

", + "smithy.api#xmlName": "reservedInstanceValueSet" + } + }, + "OutputReservedInstancesWillExpireAt": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "OutputReservedInstancesWillExpireAt", + "smithy.api#documentation": "

The new end date of the reservation term.

", + "smithy.api#xmlName": "outputReservedInstancesWillExpireAt" } } }, @@ -28220,17 +29138,29 @@ "target": "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult" }, "traits": { - "smithy.api#documentation": "

Lists the route tables to which the specified resource attachment propagates routes.

" + "smithy.api#documentation": "

Lists the route tables to which the specified resource attachment propagates routes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayAttachmentPropagations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsRequest": { "type": "structure", "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" } }, "DryRun": { @@ -28245,17 +29175,11 @@ "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.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} } } } @@ -28263,14 +29187,6 @@ "com.amazonaws.ec2#GetTransitGatewayAttachmentPropagationsResult": { "type": "structure", "members": { - "TransitGatewayAttachmentPropagations": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentPropagations", - "smithy.api#documentation": "

Information about the propagation route tables.

", - "smithy.api#xmlName": "transitGatewayAttachmentPropagations" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -28278,6 +29194,14 @@ "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#xmlName": "nextToken" } + }, + "TransitGatewayAttachmentPropagations": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentPropagationList", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentPropagations", + "smithy.api#documentation": "

Information about the propagation route tables.

", + "smithy.api#xmlName": "transitGatewayAttachmentPropagations" + } } } }, @@ -28290,7 +29214,13 @@ "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult" }, "traits": { - "smithy.api#documentation": "

Gets information about the associations for the transit gateway multicast domain.

" + "smithy.api#documentation": "

Gets information about the associations for the transit gateway multicast domain.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MulticastDomainAssociations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsRequest": { @@ -28302,17 +29232,93 @@ "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.

" } }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, "TransitGatewayMulticastDomainId": { "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", "traits": { "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The token for the next page of results.

" } + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } + }, + "MulticastDomainAssociations": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "MulticastDomainAssociations", + "smithy.api#documentation": "

Information about the multicast domain associations.

", + "smithy.api#xmlName": "multicastDomainAssociations" + } + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult" + }, + "traits": { + "smithy.api#documentation": "

Gets information about the prefix list references in a specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayPrefixListReferences", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "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.

" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", @@ -28323,21 +29329,21 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } } } }, - "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociationsResult": { + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult": { "type": "structure", "members": { - "MulticastDomainAssociations": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociationList", + "TransitGatewayPrefixListReferences": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet", "traits": { - "aws.protocols#ec2QueryName": "MulticastDomainAssociations", - "smithy.api#documentation": "

Information about the multicast domain associations.

", - "smithy.api#xmlName": "multicastDomainAssociations" + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReferenceSet", + "smithy.api#documentation": "

Information about the prefix list references.

", + "smithy.api#xmlName": "transitGatewayPrefixListReferenceSet" } }, "NextToken": { @@ -28359,42 +29365,48 @@ "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult" }, "traits": { - "smithy.api#documentation": "

Gets information about the associations for the specified transit gateway route table.

" + "smithy.api#documentation": "

Gets information about the associations for the specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Associations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", - "smithy.api#xmlName": "Filter" - } - }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.ec2#TransitGatewayMaxResults", "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.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "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.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} } } } @@ -28429,12 +29441,24 @@ "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult" }, "traits": { - "smithy.api#documentation": "

Gets information about the route table propagations for the specified transit gateway route table.

" + "smithy.api#documentation": "

Gets information about the route table propagations for the specified transit gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTablePropagations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "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.

" + } + }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { @@ -28442,10 +29466,10 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.ec2#TransitGatewayMaxResults", + "NextToken": { + "target": "com.amazonaws.ec2#String", "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.

" + "smithy.api#documentation": "

The token for the next page of results.

" } }, "DryRun": { @@ -28454,16 +29478,10 @@ "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.

" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } } @@ -28472,14 +29490,6 @@ "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "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#xmlName": "nextToken" - } - }, "TransitGatewayRouteTablePropagations": { "target": "com.amazonaws.ec2#TransitGatewayRouteTablePropagationList", "traits": { @@ -28487,6 +29497,14 @@ "smithy.api#documentation": "

Information about the route table propagations.

", "smithy.api#xmlName": "transitGatewayRouteTablePropagations" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "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#xmlName": "nextToken" + } } } }, @@ -28499,20 +29517,12 @@ "com.amazonaws.ec2#GpuDeviceInfo": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ec2#GpuDeviceName", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the GPU accelerator.

", - "smithy.api#xmlName": "name" - } - }, - "Manufacturer": { - "target": "com.amazonaws.ec2#GpuDeviceManufacturerName", + "Count": { + "target": "com.amazonaws.ec2#GpuDeviceCount", "traits": { - "aws.protocols#ec2QueryName": "Manufacturer", - "smithy.api#documentation": "

The manufacturer of the GPU accelerator.

", - "smithy.api#xmlName": "manufacturer" + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of GPUs for the instance type.

", + "smithy.api#xmlName": "count" } }, "MemoryInfo": { @@ -28523,12 +29533,20 @@ "smithy.api#xmlName": "memoryInfo" } }, - "Count": { - "target": "com.amazonaws.ec2#GpuDeviceCount", + "Manufacturer": { + "target": "com.amazonaws.ec2#GpuDeviceManufacturerName", "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The number of GPUs for the instance type.

", - "smithy.api#xmlName": "count" + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the GPU accelerator.

", + "smithy.api#xmlName": "manufacturer" + } + }, + "Name": { + "target": "com.amazonaws.ec2#GpuDeviceName", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the GPU accelerator.

", + "smithy.api#xmlName": "name" } } }, @@ -28576,14 +29594,6 @@ "com.amazonaws.ec2#GpuInfo": { "type": "structure", "members": { - "TotalGpuMemoryInMiB": { - "target": "com.amazonaws.ec2#totalGpuMemory", - "traits": { - "aws.protocols#ec2QueryName": "TotalGpuMemoryInMiB", - "smithy.api#documentation": "

The total size of the memory for the GPU accelerators for the instance type.

", - "smithy.api#xmlName": "totalGpuMemoryInMiB" - } - }, "Gpus": { "target": "com.amazonaws.ec2#GpuDeviceInfoList", "traits": { @@ -28591,6 +29601,14 @@ "smithy.api#documentation": "

Describes the GPU accelerators for the instance type.

", "smithy.api#xmlName": "gpus" } + }, + "TotalGpuMemoryInMiB": { + "target": "com.amazonaws.ec2#totalGpuMemory", + "traits": { + "aws.protocols#ec2QueryName": "TotalGpuMemoryInMiB", + "smithy.api#documentation": "

The total size of the memory for the GPU accelerators for the instance type.

", + "smithy.api#xmlName": "totalGpuMemoryInMiB" + } } }, "traits": { @@ -28705,6 +29723,14 @@ "com.amazonaws.ec2#HistoryRecord": { "type": "structure", "members": { + "EventType": { + "target": "com.amazonaws.ec2#EventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type.

\n ", + "smithy.api#xmlName": "eventType" + } + }, "Timestamp": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -28720,14 +29746,6 @@ "smithy.api#documentation": "

Information about the event.

", "smithy.api#xmlName": "eventInformation" } - }, - "EventType": { - "target": "com.amazonaws.ec2#EventType", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type.

\n ", - "smithy.api#xmlName": "eventType" - } } }, "traits": { @@ -28745,14 +29763,6 @@ "smithy.api#xmlName": "eventInformation" } }, - "EventType": { - "target": "com.amazonaws.ec2#FleetEventType", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type.

", - "smithy.api#xmlName": "eventType" - } - }, "Timestamp": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -28760,6 +29770,14 @@ "smithy.api#documentation": "

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", "smithy.api#xmlName": "timestamp" } + }, + "EventType": { + "target": "com.amazonaws.ec2#FleetEventType", + "traits": { + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type.

", + "smithy.api#xmlName": "eventType" + } } }, "traits": { @@ -28787,12 +29805,36 @@ "com.amazonaws.ec2#Host": { "type": "structure", "members": { - "HostRecovery": { - "target": "com.amazonaws.ec2#HostRecovery", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "HostRecovery", - "smithy.api#documentation": "

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

", - "smithy.api#xmlName": "hostRecovery" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the Dedicated Host.

", + "smithy.api#xmlName": "tagSet" + } + }, + "HostProperties": { + "target": "com.amazonaws.ec2#HostProperties", + "traits": { + "aws.protocols#ec2QueryName": "HostProperties", + "smithy.api#documentation": "

The hardware specifications of the Dedicated Host.

", + "smithy.api#xmlName": "hostProperties" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#HostInstanceList", + "traits": { + "aws.protocols#ec2QueryName": "Instances", + "smithy.api#documentation": "

The IDs and instance type that are currently running on the Dedicated\n Host.

", + "smithy.api#xmlName": "instances" + } + }, + "AvailableCapacity": { + "target": "com.amazonaws.ec2#AvailableCapacity", + "traits": { + "aws.protocols#ec2QueryName": "AvailableCapacity", + "smithy.api#documentation": "

Information about the instances running on the Dedicated Host.

", + "smithy.api#xmlName": "availableCapacity" } }, "State": { @@ -28803,20 +29845,28 @@ "smithy.api#xmlName": "state" } }, - "AllocationTime": { - "target": "com.amazonaws.ec2#DateTime", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AllocationTime", - "smithy.api#documentation": "

The time that the Dedicated Host was allocated.

", - "smithy.api#xmlName": "allocationTime" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the Dedicated Host.

", + "smithy.api#xmlName": "availabilityZone" } }, - "HostReservationId": { + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Whether auto-placement is on or off.

", + "smithy.api#xmlName": "autoPlacement" + } + }, + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "HostReservationId", - "smithy.api#documentation": "

The reservation ID of the Dedicated Host. This returns a null response\n if the Dedicated Host doesn't have an associated reservation.

", - "smithy.api#xmlName": "hostReservationId" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#xmlName": "clientToken" } }, "AllowsMultipleInstanceTypes": { @@ -28827,28 +29877,28 @@ "smithy.api#xmlName": "allowsMultipleInstanceTypes" } }, - "AvailableCapacity": { - "target": "com.amazonaws.ec2#AvailableCapacity", + "MemberOfServiceLinkedResourceGroup": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "AvailableCapacity", - "smithy.api#documentation": "

Information about the instances running on the Dedicated Host.

", - "smithy.api#xmlName": "availableCapacity" + "aws.protocols#ec2QueryName": "MemberOfServiceLinkedResourceGroup", + "smithy.api#documentation": "

Indicates whether the Dedicated Host is in a host resource group. If \n\t\t\tmemberOfServiceLinkedResourceGroup is \n\t\t\ttrue, the host is in a host resource group; otherwise, it is not.

", + "smithy.api#xmlName": "memberOfServiceLinkedResourceGroup" } }, - "ReleaseTime": { + "AllocationTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "ReleaseTime", - "smithy.api#documentation": "

The time that the Dedicated Host was released.

", - "smithy.api#xmlName": "releaseTime" + "aws.protocols#ec2QueryName": "AllocationTime", + "smithy.api#documentation": "

The time that the Dedicated Host was allocated.

", + "smithy.api#xmlName": "allocationTime" } }, - "Instances": { - "target": "com.amazonaws.ec2#HostInstanceList", + "OwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Instances", - "smithy.api#documentation": "

The IDs and instance type that are currently running on the Dedicated\n Host.

", - "smithy.api#xmlName": "instances" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the Dedicated Host.

", + "smithy.api#xmlName": "ownerId" } }, "AvailabilityZoneId": { @@ -28859,20 +29909,20 @@ "smithy.api#xmlName": "availabilityZoneId" } }, - "ClientToken": { + "HostReservationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#xmlName": "clientToken" + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The reservation ID of the Dedicated Host. This returns a null response\n if the Dedicated Host doesn't have an associated reservation.

", + "smithy.api#xmlName": "hostReservationId" } }, - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", + "ReleaseTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Whether auto-placement is on or off.

", - "smithy.api#xmlName": "autoPlacement" + "aws.protocols#ec2QueryName": "ReleaseTime", + "smithy.api#documentation": "

The time that the Dedicated Host was released.

", + "smithy.api#xmlName": "releaseTime" } }, "HostId": { @@ -28883,44 +29933,12 @@ "smithy.api#xmlName": "hostId" } }, - "HostProperties": { - "target": "com.amazonaws.ec2#HostProperties", - "traits": { - "aws.protocols#ec2QueryName": "HostProperties", - "smithy.api#documentation": "

The hardware specifications of the Dedicated Host.

", - "smithy.api#xmlName": "hostProperties" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the Dedicated Host.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the Dedicated Host.

", - "smithy.api#xmlName": "tagSet" - } - }, - "MemberOfServiceLinkedResourceGroup": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MemberOfServiceLinkedResourceGroup", - "smithy.api#documentation": "

Indicates whether the Dedicated Host is in a host resource group. If \n\t\t\tmemberOfServiceLinkedResourceGroup is \n\t\t\ttrue, the host is in a host resource group; otherwise, it is not.

", - "smithy.api#xmlName": "memberOfServiceLinkedResourceGroup" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "HostRecovery": { + "target": "com.amazonaws.ec2#HostRecovery", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the Dedicated Host.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "HostRecovery", + "smithy.api#documentation": "

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

", + "smithy.api#xmlName": "hostRecovery" } } }, @@ -28939,14 +29957,6 @@ "smithy.api#xmlName": "instanceType" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of instance that is running on the Dedicated Host.

", - "smithy.api#xmlName": "instanceId" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -28954,6 +29964,14 @@ "smithy.api#documentation": "

The ID of the AWS account that owns the instance.

", "smithy.api#xmlName": "ownerId" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of instance that is running on the Dedicated Host.

", + "smithy.api#xmlName": "instanceId" + } } }, "traits": { @@ -28981,22 +29999,6 @@ "com.amazonaws.ec2#HostOffering": { "type": "structure", "members": { - "UpfrontPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UpfrontPrice", - "smithy.api#documentation": "

The upfront price of the offering. Does not apply to No Upfront\n offerings.

", - "smithy.api#xmlName": "upfrontPrice" - } - }, - "Duration": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#documentation": "

The duration of the offering (in seconds).

", - "smithy.api#xmlName": "duration" - } - }, "CurrencyCode": { "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { @@ -29021,6 +30023,14 @@ "smithy.api#xmlName": "paymentOption" } }, + "OfferingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the offering.

", + "smithy.api#xmlName": "offeringId" + } + }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29029,12 +30039,20 @@ "smithy.api#xmlName": "instanceFamily" } }, - "OfferingId": { + "UpfrontPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OfferingId", - "smithy.api#documentation": "

The ID of the offering.

", - "smithy.api#xmlName": "offeringId" + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the offering. Does not apply to No Upfront\n offerings.

", + "smithy.api#xmlName": "upfrontPrice" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the offering (in seconds).

", + "smithy.api#xmlName": "duration" } } }, @@ -29070,6 +30088,14 @@ "smithy.api#xmlName": "sockets" } }, + "Cores": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Cores", + "smithy.api#documentation": "

The number of cores on the Dedicated Host.

", + "smithy.api#xmlName": "cores" + } + }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29085,14 +30111,6 @@ "smithy.api#documentation": "

The total number of vCPUs on the Dedicated Host.

", "smithy.api#xmlName": "totalVCpus" } - }, - "Cores": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Cores", - "smithy.api#documentation": "

The number of cores on the Dedicated Host.

", - "smithy.api#xmlName": "cores" - } } }, "traits": { @@ -29115,12 +30133,52 @@ "com.amazonaws.ec2#HostReservation": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#ReservationState", + "End": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the reservation.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "End", + "smithy.api#documentation": "

The date and time that the reservation ends.

", + "smithy.api#xmlName": "end" + } + }, + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The payment option selected for this reservation.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "Start": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "Start", + "smithy.api#documentation": "

The date and time that the reservation started.

", + "smithy.api#xmlName": "start" + } + }, + "HostIdSet": { + "target": "com.amazonaws.ec2#ResponseHostIdSet", + "traits": { + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", + "smithy.api#xmlName": "hostIdSet" + } + }, + "HostReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostReservationId", + "smithy.api#documentation": "

The ID of the reservation that specifies the associated Dedicated Hosts.

", + "smithy.api#xmlName": "hostReservationId" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the upfrontPrice and hourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", + "smithy.api#xmlName": "currencyCode" } }, "Tags": { @@ -29131,12 +30189,12 @@ "smithy.api#xmlName": "tagSet" } }, - "Count": { - "target": "com.amazonaws.ec2#Integer", + "OfferingId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The number of Dedicated Hosts the reservation is associated with.

", - "smithy.api#xmlName": "count" + "aws.protocols#ec2QueryName": "OfferingId", + "smithy.api#documentation": "

The ID of the reservation. This remains the same regardless of which Dedicated\n Hosts are associated with it.

", + "smithy.api#xmlName": "offeringId" } }, "InstanceFamily": { @@ -29147,12 +30205,12 @@ "smithy.api#xmlName": "instanceFamily" } }, - "Duration": { + "Count": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#documentation": "

The length of the reservation's term, specified in seconds. Can be 31536000\n (1 year) | 94608000 (3 years).

", - "smithy.api#xmlName": "duration" + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of Dedicated Hosts the reservation is associated with.

", + "smithy.api#xmlName": "count" } }, "UpfrontPrice": { @@ -29163,28 +30221,12 @@ "smithy.api#xmlName": "upfrontPrice" } }, - "Start": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "Start", - "smithy.api#documentation": "

The date and time that the reservation started.

", - "smithy.api#xmlName": "start" - } - }, - "OfferingId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OfferingId", - "smithy.api#documentation": "

The ID of the reservation. This remains the same regardless of which Dedicated\n Hosts are associated with it.

", - "smithy.api#xmlName": "offeringId" - } - }, - "PaymentOption": { - "target": "com.amazonaws.ec2#PaymentOption", + "Duration": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "PaymentOption", - "smithy.api#documentation": "

The payment option selected for this reservation.

", - "smithy.api#xmlName": "paymentOption" + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The length of the reservation's term, specified in seconds. Can be 31536000\n (1 year) | 94608000 (3 years).

", + "smithy.api#xmlName": "duration" } }, "HourlyPrice": { @@ -29195,36 +30237,12 @@ "smithy.api#xmlName": "hourlyPrice" } }, - "End": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "End", - "smithy.api#documentation": "

The date and time that the reservation ends.

", - "smithy.api#xmlName": "end" - } - }, - "HostIdSet": { - "target": "com.amazonaws.ec2#ResponseHostIdSet", - "traits": { - "aws.protocols#ec2QueryName": "HostIdSet", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", - "smithy.api#xmlName": "hostIdSet" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the upfrontPrice and hourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "HostReservationId": { - "target": "com.amazonaws.ec2#String", + "State": { + "target": "com.amazonaws.ec2#ReservationState", "traits": { - "aws.protocols#ec2QueryName": "HostReservationId", - "smithy.api#documentation": "

The ID of the reservation that specifies the associated Dedicated Hosts.

", - "smithy.api#xmlName": "hostReservationId" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the reservation.

", + "smithy.api#xmlName": "state" } } }, @@ -29345,14 +30363,6 @@ "com.amazonaws.ec2#IamInstanceProfile": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Id", - "smithy.api#documentation": "

The ID of the instance profile.

", - "smithy.api#xmlName": "id" - } - }, "Arn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29360,6 +30370,14 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", "smithy.api#xmlName": "arn" } + }, + "Id": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Id", + "smithy.api#documentation": "

The ID of the instance profile.

", + "smithy.api#xmlName": "id" + } } }, "traits": { @@ -29385,12 +30403,12 @@ "smithy.api#xmlName": "timestamp" } }, - "State": { - "target": "com.amazonaws.ec2#IamInstanceProfileAssociationState", + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfile", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" } }, "AssociationId": { @@ -29401,12 +30419,12 @@ "smithy.api#xmlName": "associationId" } }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfile", + "State": { + "target": "com.amazonaws.ec2#IamInstanceProfileAssociationState", "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "state" } } }, @@ -29452,14 +30470,6 @@ "com.amazonaws.ec2#IamInstanceProfileSpecification": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the instance profile.

", - "smithy.api#xmlName": "name" - } - }, "Arn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29467,6 +30477,14 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile.

", "smithy.api#xmlName": "arn" } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the instance profile.

", + "smithy.api#xmlName": "name" + } } }, "traits": { @@ -29476,14 +30494,6 @@ "com.amazonaws.ec2#IcmpTypeCode": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The ICMP type. A value of -1 means all types.

", - "smithy.api#xmlName": "type" - } - }, "Code": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -29491,6 +30501,14 @@ "smithy.api#documentation": "

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "smithy.api#xmlName": "code" } + }, + "Type": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The ICMP type. A value of -1 means all types.

", + "smithy.api#xmlName": "type" + } } }, "traits": { @@ -29500,12 +30518,12 @@ "com.amazonaws.ec2#IdFormat": { "type": "structure", "members": { - "Deadline": { - "target": "com.amazonaws.ec2#DateTime", + "Resource": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Deadline", - "smithy.api#documentation": "

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", - "smithy.api#xmlName": "deadline" + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#documentation": "

The type of resource.

", + "smithy.api#xmlName": "resource" } }, "UseLongIds": { @@ -29516,12 +30534,12 @@ "smithy.api#xmlName": "useLongIds" } }, - "Resource": { - "target": "com.amazonaws.ec2#String", + "Deadline": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Resource", - "smithy.api#documentation": "

The type of resource.

", - "smithy.api#xmlName": "resource" + "aws.protocols#ec2QueryName": "Deadline", + "smithy.api#documentation": "

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", + "smithy.api#xmlName": "deadline" } } }, @@ -29541,68 +30559,76 @@ "com.amazonaws.ec2#Image": { "type": "structure", "members": { - "EnaSupport": { - "target": "com.amazonaws.ec2#Boolean", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", - "smithy.api#xmlName": "enaSupport" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the AMI that was provided during image creation.

", + "smithy.api#xmlName": "description" } }, - "ImageType": { - "target": "com.amazonaws.ec2#ImageTypeValues", + "ImageId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageType", - "smithy.api#documentation": "

The type of image.

", - "smithy.api#xmlName": "imageType" + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" } }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", + "VirtualizationType": { + "target": "com.amazonaws.ec2#VirtualizationType", "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

This value is set to windows for Windows AMIs; otherwise, it is blank.

", - "smithy.api#xmlName": "platform" + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The type of virtualization of the AMI.

", + "smithy.api#xmlName": "virtualizationType" } }, - "StateReason": { - "target": "com.amazonaws.ec2#StateReason", + "RootDeviceType": { + "target": "com.amazonaws.ec2#DeviceType", "traits": { - "aws.protocols#ec2QueryName": "StateReason", - "smithy.api#documentation": "

The reason for the state change.

", - "smithy.api#xmlName": "stateReason" + "aws.protocols#ec2QueryName": "RootDeviceType", + "smithy.api#documentation": "

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "smithy.api#xmlName": "rootDeviceType" } }, - "UsageOperation": { + "KernelId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UsageOperation", - "smithy.api#documentation": "

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.\n usageOperation corresponds to the lineitem/Operation column on your AWS Cost and Usage Report and in the AWS Price\n List API. For the list of UsageOperation codes, see Platform Details and Usage Operation Billing Codes in the\n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "usageOperation" + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with the image, if any. Only applicable for machine images.

", + "smithy.api#xmlName": "kernelId" } }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", "traits": { - "aws.protocols#ec2QueryName": "ImageOwnerId", - "smithy.api#documentation": "

The AWS account ID of the image owner.

", - "smithy.api#xmlName": "imageOwnerId" + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

This value is set to windows for Windows AMIs; otherwise, it is blank.

", + "smithy.api#xmlName": "platform" } }, - "ImageLocation": { + "PlatformDetails": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageLocation", - "smithy.api#documentation": "

The location of the AMI.

", - "smithy.api#xmlName": "imageLocation" + "aws.protocols#ec2QueryName": "PlatformDetails", + "smithy.api#documentation": "

The platform details associated with the billing code of the AMI. For more information,\n see Obtaining\n Billing Information in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "platformDetails" } }, - "ImageOwnerAlias": { + "Hypervisor": { + "target": "com.amazonaws.ec2#HypervisorType", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The hypervisor type of the image.

", + "smithy.api#xmlName": "hypervisor" + } + }, + "UsageOperation": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageOwnerAlias", - "smithy.api#documentation": "

The AWS account alias (for example, amazon, self) or\n the AWS account ID of the AMI owner.

", - "smithy.api#xmlName": "imageOwnerAlias" + "aws.protocols#ec2QueryName": "UsageOperation", + "smithy.api#documentation": "

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.\n usageOperation corresponds to the lineitem/Operation column on your AWS Cost and Usage Report and in the AWS Price\n List API. For the list of UsageOperation codes, see Platform Details and Usage Operation Billing Codes in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "usageOperation" } }, "CreationDate": { @@ -29613,14 +30639,6 @@ "smithy.api#xmlName": "creationDate" } }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the AMI that was provided during image creation.

", - "smithy.api#xmlName": "description" - } - }, "RootDeviceName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29629,68 +30647,52 @@ "smithy.api#xmlName": "rootDeviceName" } }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The kernel associated with the image, if any. Only applicable for machine images.

", - "smithy.api#xmlName": "kernelId" - } - }, - "Public": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsPublic", - "smithy.api#documentation": "

Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.

", - "smithy.api#xmlName": "isPublic" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.ec2#VirtualizationType", + "State": { + "target": "com.amazonaws.ec2#ImageState", "traits": { - "aws.protocols#ec2QueryName": "VirtualizationType", - "smithy.api#documentation": "

The type of virtualization of the AMI.

", - "smithy.api#xmlName": "virtualizationType" + "aws.protocols#ec2QueryName": "ImageState", + "smithy.api#documentation": "

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "smithy.api#xmlName": "imageState" } }, - "PlatformDetails": { + "ImageLocation": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PlatformDetails", - "smithy.api#documentation": "

The platform details associated with the billing code of the AMI. For more information,\n see Obtaining\n Billing Information in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "platformDetails" + "aws.protocols#ec2QueryName": "ImageLocation", + "smithy.api#documentation": "

The location of the AMI.

", + "smithy.api#xmlName": "imageLocation" } }, - "ImageId": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "ImageOwnerId", + "smithy.api#documentation": "

The AWS account ID of the image owner.

", + "smithy.api#xmlName": "imageOwnerId" } }, - "Name": { - "target": "com.amazonaws.ec2#String", + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the AMI that was provided during image creation.

", - "smithy.api#xmlName": "name" + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

Any product codes associated with the AMI.

", + "smithy.api#xmlName": "productCodes" } }, - "Hypervisor": { - "target": "com.amazonaws.ec2#HypervisorType", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The hypervisor type of the image.

", - "smithy.api#xmlName": "hypervisor" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the image.

", + "smithy.api#xmlName": "tagSet" } }, - "RootDeviceType": { - "target": "com.amazonaws.ec2#DeviceType", + "Public": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "RootDeviceType", - "smithy.api#documentation": "

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", - "smithy.api#xmlName": "rootDeviceType" + "aws.protocols#ec2QueryName": "IsPublic", + "smithy.api#documentation": "

Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.

", + "smithy.api#xmlName": "isPublic" } }, "Architecture": { @@ -29701,12 +30703,20 @@ "smithy.api#xmlName": "architecture" } }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", + "ImageType": { + "target": "com.amazonaws.ec2#ImageTypeValues", "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

Any product codes associated with the AMI.

", - "smithy.api#xmlName": "productCodes" + "aws.protocols#ec2QueryName": "ImageType", + "smithy.api#documentation": "

The type of image.

", + "smithy.api#xmlName": "imageType" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" } }, "BlockDeviceMappings": { @@ -29717,28 +30727,28 @@ "smithy.api#xmlName": "blockDeviceMapping" } }, - "State": { - "target": "com.amazonaws.ec2#ImageState", + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", "traits": { - "aws.protocols#ec2QueryName": "ImageState", - "smithy.api#documentation": "

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", - "smithy.api#xmlName": "imageState" + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

The reason for the state change.

", + "smithy.api#xmlName": "stateReason" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "Name": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the image.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the AMI that was provided during image creation.

", + "smithy.api#xmlName": "name" } }, - "SriovNetSupport": { + "ImageOwnerAlias": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", - "smithy.api#xmlName": "sriovNetSupport" + "aws.protocols#ec2QueryName": "ImageOwnerAlias", + "smithy.api#documentation": "

The AWS account alias (for example, amazon, self) or\n the AWS account ID of the AMI owner.

", + "smithy.api#xmlName": "imageOwnerAlias" } }, "RamdiskId": { @@ -29748,6 +30758,14 @@ "smithy.api#documentation": "

The RAM disk associated with the image, if any. Only applicable for machine images.

", "smithy.api#xmlName": "ramdiskId" } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } } }, "traits": { @@ -29757,28 +30775,12 @@ "com.amazonaws.ec2#ImageAttribute": { "type": "structure", "members": { - "RamdiskId": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Ramdisk", - "smithy.api#documentation": "

The RAM disk ID.

", - "smithy.api#xmlName": "ramdisk" - } - }, - "KernelId": { + "Description": { "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "Kernel", - "smithy.api#documentation": "

The kernel ID.

", - "smithy.api#xmlName": "kernel" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the AMI.

", + "smithy.api#xmlName": "description" } }, "BlockDeviceMappings": { @@ -29789,20 +30791,20 @@ "smithy.api#xmlName": "blockDeviceMapping" } }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#AttributeValue", + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", - "smithy.api#xmlName": "sriovNetSupport" + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" } }, - "Description": { + "RamdiskId": { "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the AMI.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

The RAM disk ID.

", + "smithy.api#xmlName": "ramdisk" } }, "LaunchPermissions": { @@ -29813,12 +30815,28 @@ "smithy.api#xmlName": "launchPermission" } }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes.

", - "smithy.api#xmlName": "productCodes" + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

The kernel ID.

", + "smithy.api#xmlName": "kernel" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" } } }, @@ -29869,18 +30887,6 @@ "smithy.api#documentation": "

The ID of the EBS snapshot to be used for importing the snapshot.

" } }, - "Format": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: OVA | VHD | VHDX |VMDK \n

" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description of the disk image.

" - } - }, "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29892,6 +30898,18 @@ "traits": { "smithy.api#documentation": "

The S3 bucket for the disk image.

" } + }, + "Format": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: OVA | VHD | VHDX |VMDK \n

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description of the disk image.

" + } } }, "traits": { @@ -29987,6 +31005,12 @@ "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { @@ -29994,12 +31018,6 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, "CertificateRevocationList": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30085,90 +31103,90 @@ "com.amazonaws.ec2#ImportImageRequest": { "type": "structure", "members": { - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest", + "RoleName": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ARNs of the license configurations.

" + "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", + "DiskContainers": { + "target": "com.amazonaws.ec2#ImageDiskContainerList", "traits": { - "smithy.api#documentation": "

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the\n encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this\n parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The CMK identifier may be provided in any of the following formats:

\n \n

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified CMK must exist in the Region that the AMI is being copied to.

\n

Amazon EBS does not support asymmetric CMKs.

" + "smithy.api#documentation": "

Information about the disk containers.

", + "smithy.api#xmlName": "DiskContainer" } }, - "Platform": { + "Hypervisor": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The operating system of the virtual machine.

\n

Valid values: Windows | Linux\n

" + "smithy.api#documentation": "

The target hypervisor platform.

\n

Valid values: xen\n

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The tags to apply to the image being imported.

", - "smithy.api#xmlName": "TagSpecification" + "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.

" } }, - "Architecture": { + "LicenseType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64 | arm64\n

" + "smithy.api#documentation": "

The license type to be used for the Amazon Machine Image (AMI) after importing.

\n

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify\n AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL\n to retain the source-system license, if appropriate.

\n

To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as AWS. For more information, see Prerequisites in the\n VM Import/Export User Guide.

" } }, - "ClientToken": { + "Platform": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The token to enable idempotency for VM import requests.

" + "smithy.api#documentation": "

The operating system of the virtual machine.

\n

Valid values: Windows | Linux\n

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Architecture": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64 | arm64\n

" } }, - "Description": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A description string for the import image task.

" + "smithy.api#documentation": "

The token to enable idempotency for VM import requests.

" } }, - "ClientData": { - "target": "com.amazonaws.ec2#ClientData", + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", "traits": { - "smithy.api#documentation": "

The client-specific data.

" + "smithy.api#documentation": "

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the\n encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this\n parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The CMK identifier may be provided in any of the following formats:

\n \n

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified CMK must exist in the Region that the AMI is being copied to.

\n

Amazon EBS does not support asymmetric CMKs.

" } }, - "RoleName": { - "target": "com.amazonaws.ec2#String", + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListRequest", "traits": { - "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" + "smithy.api#documentation": "

The ARNs of the license configurations.

" } }, - "DiskContainers": { - "target": "com.amazonaws.ec2#ImageDiskContainerList", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Information about the disk containers.

", - "smithy.api#xmlName": "DiskContainer" + "smithy.api#documentation": "

Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used\n unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" } }, - "LicenseType": { - "target": "com.amazonaws.ec2#String", + "ClientData": { + "target": "com.amazonaws.ec2#ClientData", "traits": { - "smithy.api#documentation": "

The license type to be used for the Amazon Machine Image (AMI) after importing.

\n

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify\n AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL\n to retain the source-system license, if appropriate.

\n

To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as AWS. For more information, see Prerequisites in the\n VM Import/Export User Guide.

" + "smithy.api#documentation": "

The client-specific data.

" } }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used\n unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The tags to apply to the image being imported.

", + "smithy.api#xmlName": "TagSpecification" } }, - "Hypervisor": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The target hypervisor platform.

\n

Valid values: xen\n

" + "smithy.api#documentation": "

A description string for the import image task.

" } } } @@ -30176,60 +31194,12 @@ "com.amazonaws.ec2#ImportImageResult": { "type": "structure", "members": { - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) created by the import task.

", - "smithy.api#xmlName": "imageId" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the image being imported.

", - "smithy.api#xmlName": "tagSet" - } - }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", - "traits": { - "aws.protocols#ec2QueryName": "LicenseSpecifications", - "smithy.api#documentation": "

The ARNs of the license configurations.

", - "smithy.api#xmlName": "licenseSpecifications" - } - }, - "Architecture": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the virtual machine.

", - "smithy.api#xmlName": "architecture" - } - }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status of the task.

", - "smithy.api#xmlName": "status" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the import task.

", - "smithy.api#xmlName": "description" - } - }, - "Hypervisor": { - "target": "com.amazonaws.ec2#String", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The target hypervisor of the import task.

", - "smithy.api#xmlName": "hypervisor" + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the AMI is encrypted.

", + "smithy.api#xmlName": "encrypted" } }, "KmsKeyId": { @@ -30248,20 +31218,20 @@ "smithy.api#xmlName": "licenseType" } }, - "Platform": { + "Hypervisor": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The operating system of the virtual machine.

", - "smithy.api#xmlName": "platform" + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The target hypervisor of the import task.

", + "smithy.api#xmlName": "hypervisor" } }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", + "ImportTaskId": { + "target": "com.amazonaws.ec2#ImportImageTaskId", "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the AMI is encrypted.

", - "smithy.api#xmlName": "encrypted" + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The task ID of the import image task.

", + "smithy.api#xmlName": "importTaskId" } }, "SnapshotDetails": { @@ -30272,14 +31242,6 @@ "smithy.api#xmlName": "snapshotDetailSet" } }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The progress of the task.

", - "smithy.api#xmlName": "progress" - } - }, "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30288,27 +31250,6 @@ "smithy.api#xmlName": "statusMessage" } }, - "ImportTaskId": { - "target": "com.amazonaws.ec2#ImportImageTaskId", - "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The task ID of the import image task.

", - "smithy.api#xmlName": "importTaskId" - } - } - } - }, - "com.amazonaws.ec2#ImportImageTask": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status for the import image task.

", - "smithy.api#xmlName": "status" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30317,52 +31258,81 @@ "smithy.api#xmlName": "description" } }, - "ImageId": { + "Platform": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The operating system of the virtual machine.

", + "smithy.api#xmlName": "platform" } }, - "Architecture": { + "Status": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64 | arm64\n

", - "smithy.api#xmlName": "architecture" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status of the task.

", + "smithy.api#xmlName": "status" } }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the import image task.

", + "smithy.api#documentation": "

Any tags assigned to the image being imported.

", "smithy.api#xmlName": "tagSet" } }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "smithy.api#xmlName": "imageId" + } + }, "LicenseSpecifications": { "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", "traits": { "aws.protocols#ec2QueryName": "LicenseSpecifications", - "smithy.api#documentation": "

The ARNs of the license configurations that are associated with the import image task.

", + "smithy.api#documentation": "

The ARNs of the license configurations.

", "smithy.api#xmlName": "licenseSpecifications" } }, - "ImportTaskId": { + "Progress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The ID of the import image task.

", - "smithy.api#xmlName": "importTaskId" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the task.

", + "smithy.api#xmlName": "progress" } }, - "LicenseType": { + "Architecture": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LicenseType", - "smithy.api#documentation": "

The license type of the virtual machine.

", - "smithy.api#xmlName": "licenseType" + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the virtual machine.

", + "smithy.api#xmlName": "architecture" + } + } + } + }, + "com.amazonaws.ec2#ImportImageTask": { + "type": "structure", + "members": { + "Hypervisor": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

The target hypervisor for the import task.

\n

Valid values: xen\n

", + "smithy.api#xmlName": "hypervisor" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create\n the encrypted image.

", + "smithy.api#xmlName": "kmsKeyId" } }, "Platform": { @@ -30373,6 +31343,22 @@ "smithy.api#xmlName": "platform" } }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A descriptive status message for the import image task.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of progress of the import image task.

", + "smithy.api#xmlName": "progress" + } + }, "Encrypted": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -30381,28 +31367,44 @@ "smithy.api#xmlName": "encrypted" } }, - "KmsKeyId": { + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#ImportImageLicenseSpecificationListResponse", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSpecifications", + "smithy.api#documentation": "

The ARNs of the license configurations that are associated with the import image task.

", + "smithy.api#xmlName": "licenseSpecifications" + } + }, + "LicenseType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create\n the encrypted image.

", - "smithy.api#xmlName": "kmsKeyId" + "aws.protocols#ec2QueryName": "LicenseType", + "smithy.api#documentation": "

The license type of the virtual machine.

", + "smithy.api#xmlName": "licenseType" } }, - "Progress": { + "Status": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percentage of progress of the import image task.

", - "smithy.api#xmlName": "progress" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status for the import image task.

", + "smithy.api#xmlName": "status" } }, - "StatusMessage": { + "Architecture": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A descriptive status message for the import image task.

", - "smithy.api#xmlName": "statusMessage" + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the virtual machine.

\n

Valid values: i386 | x86_64 | arm64\n

", + "smithy.api#xmlName": "architecture" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import task.

", + "smithy.api#xmlName": "description" } }, "SnapshotDetails": { @@ -30413,12 +31415,28 @@ "smithy.api#xmlName": "snapshotDetailSet" } }, - "Hypervisor": { + "ImageId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The target hypervisor for the import task.

\n

Valid values: xen\n

", - "smithy.api#xmlName": "hypervisor" + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "smithy.api#xmlName": "imageId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the import image task.

", + "smithy.api#xmlName": "tagSet" + } + }, + "ImportTaskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import image task.

", + "smithy.api#xmlName": "importTaskId" } } }, @@ -30453,14 +31471,6 @@ "com.amazonaws.ec2#ImportInstanceLaunchSpecification": { "type": "structure", "members": { - "Monitoring": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

Indicates whether monitoring is enabled.

", - "smithy.api#xmlName": "monitoring" - } - }, "PrivateIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30469,35 +31479,12 @@ "smithy.api#xmlName": "privateIpAddress" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. For more information about the instance types that you can import, see Instance Types in the\n VM Import/Export User Guide.

", - "smithy.api#xmlName": "instanceType" - } - }, - "UserData": { - "target": "com.amazonaws.ec2#UserData", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance.

", - "smithy.api#xmlName": "userData" - } - }, - "GroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The security group IDs.

", - "smithy.api#xmlName": "GroupId" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", + "Placement": { + "target": "com.amazonaws.ec2#Placement", "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the\n operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" } }, "Architecture": { @@ -30508,12 +31495,20 @@ "smithy.api#xmlName": "architecture" } }, - "Placement": { - "target": "com.amazonaws.ec2#Placement", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement information for the instance.

", - "smithy.api#xmlName": "placement" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information about the instance types that you can import, see Instance Types in the\n VM Import/Export User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Indicates whether monitoring is enabled.

", + "smithy.api#xmlName": "monitoring" } }, "SubnetId": { @@ -30524,6 +31519,13 @@ "smithy.api#xmlName": "subnetId" } }, + "GroupNames": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

The security group names.

", + "smithy.api#xmlName": "GroupName" + } + }, "AdditionalInfo": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30532,11 +31534,27 @@ "smithy.api#xmlName": "additionalInfo" } }, - "GroupNames": { - "target": "com.amazonaws.ec2#SecurityGroupStringList", + "UserData": { + "target": "com.amazonaws.ec2#UserData", "traits": { - "smithy.api#documentation": "

The security group names.

", - "smithy.api#xmlName": "GroupName" + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance.

", + "smithy.api#xmlName": "userData" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the\n operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "GroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The security group IDs.

", + "smithy.api#xmlName": "GroupId" } } }, @@ -30547,14 +31565,6 @@ "com.amazonaws.ec2#ImportInstanceRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the instance being imported.

", - "smithy.api#xmlName": "description" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -30563,12 +31573,21 @@ "smithy.api#xmlName": "dryRun" } }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#ImportInstanceLaunchSpecification", + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", "traits": { - "aws.protocols#ec2QueryName": "LaunchSpecification", - "smithy.api#documentation": "

The launch specification.

", - "smithy.api#xmlName": "launchSpecification" + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The instance operating system.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "platform" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the instance being imported.

", + "smithy.api#xmlName": "description" } }, "DiskImages": { @@ -30579,13 +31598,12 @@ "smithy.api#xmlName": "diskImage" } }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", + "LaunchSpecification": { + "target": "com.amazonaws.ec2#ImportInstanceLaunchSpecification", "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The instance operating system.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "platform" + "aws.protocols#ec2QueryName": "LaunchSpecification", + "smithy.api#documentation": "

The launch specification.

", + "smithy.api#xmlName": "launchSpecification" } } } @@ -30606,6 +31624,14 @@ "com.amazonaws.ec2#ImportInstanceTaskDetails": { "type": "structure", "members": { + "Volumes": { + "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "Volumes", + "smithy.api#documentation": "

The volumes.

", + "smithy.api#xmlName": "volumes" + } + }, "Platform": { "target": "com.amazonaws.ec2#PlatformValues", "traits": { @@ -30622,14 +31648,6 @@ "smithy.api#xmlName": "description" } }, - "Volumes": { - "target": "com.amazonaws.ec2#ImportInstanceVolumeDetailSet", - "traits": { - "aws.protocols#ec2QueryName": "Volumes", - "smithy.api#documentation": "

The volumes.

", - "smithy.api#xmlName": "volumes" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30646,14 +31664,6 @@ "com.amazonaws.ec2#ImportInstanceVolumeDetailItem": { "type": "structure", "members": { - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status information or errors related to the disk image.

", - "smithy.api#xmlName": "statusMessage" - } - }, "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30662,20 +31672,20 @@ "smithy.api#xmlName": "availabilityZone" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "Volume": { + "target": "com.amazonaws.ec2#DiskImageVolumeDescription", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the task.

", - "smithy.api#xmlName": "description" - } + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#documentation": "

The volume.

", + "smithy.api#xmlName": "volume" + } }, - "BytesConverted": { - "target": "com.amazonaws.ec2#Long", + "Image": { + "target": "com.amazonaws.ec2#DiskImageDescription", "traits": { - "aws.protocols#ec2QueryName": "BytesConverted", - "smithy.api#documentation": "

The number of bytes converted so far.

", - "smithy.api#xmlName": "bytesConverted" + "aws.protocols#ec2QueryName": "Image", + "smithy.api#documentation": "

The image.

", + "smithy.api#xmlName": "image" } }, "Status": { @@ -30686,20 +31696,28 @@ "smithy.api#xmlName": "status" } }, - "Volume": { - "target": "com.amazonaws.ec2#DiskImageVolumeDescription", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Volume", - "smithy.api#documentation": "

The volume.

", - "smithy.api#xmlName": "volume" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the task.

", + "smithy.api#xmlName": "description" } }, - "Image": { - "target": "com.amazonaws.ec2#DiskImageDescription", + "StatusMessage": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Image", - "smithy.api#documentation": "

The image.

", - "smithy.api#xmlName": "image" + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status information or errors related to the disk image.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "BytesConverted": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "BytesConverted", + "smithy.api#documentation": "

The number of bytes converted so far.

", + "smithy.api#xmlName": "bytesConverted" } } }, @@ -30731,13 +31749,11 @@ "com.amazonaws.ec2#ImportKeyPairRequest": { "type": "structure", "members": { - "KeyName": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

A unique name for the key pair.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "keyName" + "smithy.api#documentation": "

The tags to apply to the imported key pair.

", + "smithy.api#xmlName": "TagSpecification" } }, "DryRun": { @@ -30748,13 +31764,6 @@ "smithy.api#xmlName": "dryRun" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the imported key pair.

", - "smithy.api#xmlName": "TagSpecification" - } - }, "PublicKeyMaterial": { "target": "com.amazonaws.ec2#Blob", "traits": { @@ -30763,20 +31772,21 @@ "smithy.api#required": {}, "smithy.api#xmlName": "publicKeyMaterial" } - } - } - }, - "com.amazonaws.ec2#ImportKeyPairResult": { - "type": "structure", - "members": { + }, "KeyName": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The key pair name you provided.

", + "smithy.api#documentation": "

A unique name for the key pair.

", + "smithy.api#required": {}, "smithy.api#xmlName": "keyName" } - }, + } + } + }, + "com.amazonaws.ec2#ImportKeyPairResult": { + "type": "structure", + "members": { "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -30785,6 +31795,14 @@ "smithy.api#xmlName": "tagSet" } }, + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "smithy.api#xmlName": "keyFingerprint" + } + }, "KeyPairId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -30793,12 +31811,12 @@ "smithy.api#xmlName": "keyPairId" } }, - "KeyFingerprint": { + "KeyName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", - "smithy.api#xmlName": "keyFingerprint" + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The key pair name you provided.

", + "smithy.api#xmlName": "keyName" } } } @@ -30818,22 +31836,28 @@ "com.amazonaws.ec2#ImportSnapshotRequest": { "type": "structure", "members": { + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is\n used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, "RoleName": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The name of the role to use when not using the default role, 'vmimport'.

" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", "traits": { - "smithy.api#documentation": "

The description string for the import snapshot task.

" + "smithy.api#documentation": "

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the\n encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this\n parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The CMK identifier may be provided in any of the following formats:

\n \n

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified CMK must exist in the Region that the snapshot is being copied to.

\n

Amazon EBS does not support asymmetric CMKs.

" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "ClientData": { + "target": "com.amazonaws.ec2#ClientData", "traits": { - "smithy.api#documentation": "

Token to enable idempotency for VM import requests.

" + "smithy.api#documentation": "

The client-specific data.

" } }, "DiskContainer": { @@ -30842,10 +31866,10 @@ "smithy.api#documentation": "

Information about the disk container.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

Token to enable idempotency for VM import requests.

" } }, "TagSpecifications": { @@ -30855,22 +31879,16 @@ "smithy.api#xmlName": "TagSpecification" } }, - "ClientData": { - "target": "com.amazonaws.ec2#ClientData", - "traits": { - "smithy.api#documentation": "

The client-specific data.

" - } - }, - "Encrypted": { + "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is\n used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + "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.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the\n encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this\n parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The CMK identifier may be provided in any of the following formats:

\n \n

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified CMK must exist in the Region that the snapshot is being copied to.

\n

Amazon EBS does not support asymmetric CMKs.

" + "smithy.api#documentation": "

The description string for the import snapshot task.

" } } } @@ -30878,20 +31896,12 @@ "com.amazonaws.ec2#ImportSnapshotResult": { "type": "structure", "members": { - "Description": { + "ImportTaskId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the import snapshot task.

", - "smithy.api#xmlName": "description" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the snapshot being imported.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "ImportTaskId", + "smithy.api#documentation": "

The ID of the import snapshot task.

", + "smithy.api#xmlName": "importTaskId" } }, "SnapshotTaskDetail": { @@ -30902,12 +31912,20 @@ "smithy.api#xmlName": "snapshotTaskDetail" } }, - "ImportTaskId": { + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the snapshot being imported.

", + "smithy.api#xmlName": "tagSet" + } + }, + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImportTaskId", - "smithy.api#documentation": "

The ID of the import snapshot task.

", - "smithy.api#xmlName": "importTaskId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import snapshot task.

", + "smithy.api#xmlName": "description" } } } @@ -30923,12 +31941,12 @@ "smithy.api#xmlName": "importTaskId" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the import snapshot task.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the import snapshot task.

", + "smithy.api#xmlName": "description" } }, "SnapshotTaskDetail": { @@ -30939,12 +31957,12 @@ "smithy.api#xmlName": "snapshotTaskDetail" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the import snapshot task.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the import snapshot task.

", + "smithy.api#xmlName": "tagSet" } } }, @@ -31000,15 +32018,6 @@ "com.amazonaws.ec2#ImportVolumeRequest": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone for the resulting EBS volume.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "availabilityZone" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -31017,12 +32026,13 @@ "smithy.api#xmlName": "dryRun" } }, - "Description": { + "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the volume.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the resulting EBS volume.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "availabilityZone" } }, "Volume": { @@ -31042,6 +32052,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "image" } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the volume.

", + "smithy.api#xmlName": "description" + } } } }, @@ -31061,28 +32079,28 @@ "com.amazonaws.ec2#ImportVolumeTaskDetails": { "type": "structure", "members": { - "Image": { - "target": "com.amazonaws.ec2#DiskImageDescription", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Image", - "smithy.api#documentation": "

The image.

", - "smithy.api#xmlName": "image" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description you provided when starting the import volume task.

", + "smithy.api#xmlName": "description" } }, - "BytesConverted": { - "target": "com.amazonaws.ec2#Long", + "Volume": { + "target": "com.amazonaws.ec2#DiskImageVolumeDescription", "traits": { - "aws.protocols#ec2QueryName": "BytesConverted", - "smithy.api#documentation": "

The number of bytes converted so far.

", - "smithy.api#xmlName": "bytesConverted" + "aws.protocols#ec2QueryName": "Volume", + "smithy.api#documentation": "

The volume.

", + "smithy.api#xmlName": "volume" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "Image": { + "target": "com.amazonaws.ec2#DiskImageDescription", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description you provided when starting the import volume task.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "Image", + "smithy.api#documentation": "

The image.

", + "smithy.api#xmlName": "image" } }, "AvailabilityZone": { @@ -31093,12 +32111,12 @@ "smithy.api#xmlName": "availabilityZone" } }, - "Volume": { - "target": "com.amazonaws.ec2#DiskImageVolumeDescription", + "BytesConverted": { + "target": "com.amazonaws.ec2#Long", "traits": { - "aws.protocols#ec2QueryName": "Volume", - "smithy.api#documentation": "

The volume.

", - "smithy.api#xmlName": "volume" + "aws.protocols#ec2QueryName": "BytesConverted", + "smithy.api#documentation": "

The number of bytes converted so far.

", + "smithy.api#xmlName": "bytesConverted" } } }, @@ -31131,14 +32149,6 @@ "com.amazonaws.ec2#InferenceDeviceInfo": { "type": "structure", "members": { - "Manufacturer": { - "target": "com.amazonaws.ec2#InferenceDeviceManufacturerName", - "traits": { - "aws.protocols#ec2QueryName": "Manufacturer", - "smithy.api#documentation": "

The manufacturer of the Inference accelerator.

", - "smithy.api#xmlName": "manufacturer" - } - }, "Count": { "target": "com.amazonaws.ec2#InferenceDeviceCount", "traits": { @@ -31154,6 +32164,14 @@ "smithy.api#documentation": "

The name of the Inference accelerator.

", "smithy.api#xmlName": "name" } + }, + "Manufacturer": { + "target": "com.amazonaws.ec2#InferenceDeviceManufacturerName", + "traits": { + "aws.protocols#ec2QueryName": "Manufacturer", + "smithy.api#documentation": "

The manufacturer of the Inference accelerator.

", + "smithy.api#xmlName": "manufacturer" + } } }, "traits": { @@ -31175,116 +32193,172 @@ "com.amazonaws.ec2#Instance": { "type": "structure", "members": { - "CapacityReservationId": { + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecificationResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationSpecification", + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#xmlName": "capacityReservationSpecification" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#StateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

The reason for the most recent state transition.

", + "smithy.api#xmlName": "stateReason" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The value is Windows for Windows instances; otherwise blank.

", + "smithy.api#xmlName": "platform" + } + }, + "SubnetId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationId", - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#xmlName": "capacityReservationId" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet in which the instance is running.

", + "smithy.api#xmlName": "subnetId" } }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfile", + "KernelId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile associated with the instance, if applicable.

", - "smithy.api#xmlName": "iamInstanceProfile" + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with this instance, if applicable.

", + "smithy.api#xmlName": "kernelId" } }, - "State": { - "target": "com.amazonaws.ec2#InstanceState", + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", "traits": { - "aws.protocols#ec2QueryName": "InstanceState", - "smithy.api#documentation": "

The current state of the instance.

", - "smithy.api#xmlName": "instanceState" + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the image.

", + "smithy.api#xmlName": "architecture" } }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", + "OutpostArn": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups for the instance.

", - "smithy.api#xmlName": "groupSet" + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" } }, - "ClientToken": { + "VirtualizationType": { + "target": "com.amazonaws.ec2#VirtualizationType", + "traits": { + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The virtualization type of the instance.

", + "smithy.api#xmlName": "virtualizationType" + } + }, + "ImageId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

The idempotency token you provided when you launched the instance, if\n applicable.

", - "smithy.api#xmlName": "clientToken" + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

", + "smithy.api#xmlName": "imageId" } }, - "SpotInstanceRequestId": { + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "PrivateDnsName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestId", - "smithy.api#documentation": "

If the request is a Spot Instance request, the ID of the request.

", - "smithy.api#xmlName": "spotInstanceRequestId" + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", + "smithy.api#xmlName": "privateDnsName" } }, - "Licenses": { - "target": "com.amazonaws.ec2#LicenseList", + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceList", "traits": { - "aws.protocols#ec2QueryName": "LicenseSet", - "smithy.api#documentation": "

The license configurations.

", - "smithy.api#xmlName": "licenseSet" + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

[EC2-VPC] The network interfaces for the instance.

", + "smithy.api#xmlName": "networkInterfaceSet" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the instance.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", + "smithy.api#xmlName": "sriovNetSupport" } }, - "PublicDnsName": { + "CapacityReservationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DnsName", - "smithy.api#documentation": "

(IPv4 only) The public DNS name assigned to the instance. This name is not available\n until the instance enters the running state. For EC2-VPC, this name is only\n available if you've enabled DNS hostnames for your VPC.

", - "smithy.api#xmlName": "dnsName" + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" } }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", + "State": { + "target": "com.amazonaws.ec2#InstanceState", "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes attached to this instance, if applicable.

", - "smithy.api#xmlName": "productCodes" + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "instanceState" } }, - "InstanceId": { + "RamdiskId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The RAM disk associated with this instance, if applicable.

", + "smithy.api#xmlName": "ramdiskId" } }, - "StateReason": { - "target": "com.amazonaws.ec2#StateReason", + "ElasticInferenceAcceleratorAssociations": { + "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList", "traits": { - "aws.protocols#ec2QueryName": "StateReason", - "smithy.api#documentation": "

The reason for the most recent state transition.

", - "smithy.api#xmlName": "stateReason" + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationSet", + "smithy.api#documentation": "

The elastic inference accelerator associated with the instance.

", + "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationSet" } }, - "StateTransitionReason": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Reason", - "smithy.api#documentation": "

The reason for the most recent state transition. This might be an empty string.

", - "smithy.api#xmlName": "reason" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

The idempotency token you provided when you launched the instance, if\n applicable.

", + "smithy.api#xmlName": "clientToken" } }, - "MetadataOptions": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "MetadataOptions", - "smithy.api#documentation": "

The metadata options for the instance.

", - "smithy.api#xmlName": "metadataOptions" + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

(IPv4 only) The public DNS name assigned to the instance. This name is not available\n until the instance enters the running state. For EC2-VPC, this name is only\n available if you've enabled DNS hostnames for your VPC.

", + "smithy.api#xmlName": "dnsName" + } + }, + "AmiLaunchIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AmiLaunchIndex", + "smithy.api#documentation": "

The AMI launch index, which can be used to find this instance in the launch\n group.

", + "smithy.api#xmlName": "amiLaunchIndex" + } + }, + "Licenses": { + "target": "com.amazonaws.ec2#LicenseList", + "traits": { + "aws.protocols#ec2QueryName": "LicenseSet", + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "licenseSet" } }, "EnaSupport": { @@ -31311,6 +32385,14 @@ "smithy.api#xmlName": "blockDeviceMapping" } }, + "SpotInstanceRequestId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

If the request is a Spot Instance request, the ID of the request.

", + "smithy.api#xmlName": "spotInstanceRequestId" + } + }, "EbsOptimized": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -31319,36 +32401,52 @@ "smithy.api#xmlName": "ebsOptimized" } }, - "ElasticGpuAssociations": { - "target": "com.amazonaws.ec2#ElasticGpuAssociationList", + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuAssociationSet", - "smithy.api#documentation": "

The Elastic GPU associated with the instance.

", - "smithy.api#xmlName": "elasticGpuAssociationSet" + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes attached to this instance, if applicable.

", + "smithy.api#xmlName": "productCodes" } }, - "RamdiskId": { + "StateTransitionReason": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The RAM disk associated with this instance, if applicable.

", - "smithy.api#xmlName": "ramdiskId" + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the most recent state transition. This might be an empty string.

", + "smithy.api#xmlName": "reason" } }, - "SriovNetSupport": { + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups for the instance.

", + "smithy.api#xmlName": "groupSet" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "MetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance.

", + "smithy.api#xmlName": "metadataOptions" + } + }, + "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface\n is enabled.

", - "smithy.api#xmlName": "sriovNetSupport" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" } }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceList", + "ElasticGpuAssociations": { + "target": "com.amazonaws.ec2#ElasticGpuAssociationList", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

[EC2-VPC] The network interfaces for the instance.

", - "smithy.api#xmlName": "networkInterfaceSet" + "aws.protocols#ec2QueryName": "ElasticGpuAssociationSet", + "smithy.api#documentation": "

The Elastic GPU associated with the instance.

", + "smithy.api#xmlName": "elasticGpuAssociationSet" } }, "KeyName": { @@ -31359,36 +32457,52 @@ "smithy.api#xmlName": "keyName" } }, - "ImageId": { - "target": "com.amazonaws.ec2#String", + "LaunchTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "LaunchTime", + "smithy.api#documentation": "

The time the instance was launched.

", + "smithy.api#xmlName": "launchTime" } }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#Boolean", + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfile", "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

Specifies whether to enable an instance launched in a VPC to perform NAT. This\n controls whether source/destination checking is enabled on the instance. A value of\n true means that checking is enabled, and false means that\n checking is disabled. The value must be false for the instance to perform\n NAT. For more information, see NAT Instances in the\n Amazon Virtual Private Cloud User Guide.

", - "smithy.api#xmlName": "sourceDestCheck" + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile associated with the instance, if applicable.

", + "smithy.api#xmlName": "iamInstanceProfile" } }, - "PrivateIpAddress": { + "PublicIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

", - "smithy.api#xmlName": "privateIpAddress" + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", + "smithy.api#xmlName": "ipAddress" } }, - "AmiLaunchIndex": { - "target": "com.amazonaws.ec2#Integer", + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AmiLaunchIndex", - "smithy.api#documentation": "

The AMI launch index, which can be used to find this instance in the launch\n group.

", - "smithy.api#xmlName": "amiLaunchIndex" + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Monitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The location where the instance launched, if applicable.

", + "smithy.api#xmlName": "placement" } }, "RootDeviceType": { @@ -31399,20 +32513,12 @@ "smithy.api#xmlName": "rootDeviceType" } }, - "ElasticInferenceAcceleratorAssociations": { - "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationSet", - "smithy.api#documentation": "

The elastic inference accelerator associated with the instance.

", - "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationSet" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", + "CpuOptions": { + "target": "com.amazonaws.ec2#CpuOptions", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet in which the instance is running.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "CpuOptions", + "smithy.api#documentation": "

The CPU options for the instance.

", + "smithy.api#xmlName": "cpuOptions" } }, "HibernationOptions": { @@ -31423,38 +32529,6 @@ "smithy.api#xmlName": "hibernationOptions" } }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The kernel associated with this instance, if applicable.

", - "smithy.api#xmlName": "kernelId" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances; otherwise blank.

", - "smithy.api#xmlName": "platform" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "InstanceLifecycle": { - "target": "com.amazonaws.ec2#InstanceLifecycleType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceLifecycle", - "smithy.api#documentation": "

Indicates whether this is a Spot Instance or a Scheduled Instance.

", - "smithy.api#xmlName": "instanceLifecycle" - } - }, "Hypervisor": { "target": "com.amazonaws.ec2#HypervisorType", "traits": { @@ -31463,92 +32537,36 @@ "smithy.api#xmlName": "hypervisor" } }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "CpuOptions": { - "target": "com.amazonaws.ec2#CpuOptions", - "traits": { - "aws.protocols#ec2QueryName": "CpuOptions", - "smithy.api#documentation": "

The CPU options for the instance.

", - "smithy.api#xmlName": "cpuOptions" - } - }, - "LaunchTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTime", - "smithy.api#documentation": "

The time the instance was launched.

", - "smithy.api#xmlName": "launchTime" - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#CapacityReservationSpecificationResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationSpecification", - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", - "smithy.api#xmlName": "capacityReservationSpecification" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#Placement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The location where the instance launched, if applicable.

", - "smithy.api#xmlName": "placement" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.ec2#VirtualizationType", - "traits": { - "aws.protocols#ec2QueryName": "VirtualizationType", - "smithy.api#documentation": "

The virtualization type of the instance.

", - "smithy.api#xmlName": "virtualizationType" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the instance.

", + "smithy.api#xmlName": "tagSet" } }, - "Monitoring": { - "target": "com.amazonaws.ec2#Monitoring", + "InstanceLifecycle": { + "target": "com.amazonaws.ec2#InstanceLifecycleType", "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

The monitoring for the instance.

", - "smithy.api#xmlName": "monitoring" + "aws.protocols#ec2QueryName": "InstanceLifecycle", + "smithy.api#documentation": "

Indicates whether this is a Spot Instance or a Scheduled Instance.

", + "smithy.api#xmlName": "instanceLifecycle" } }, - "PublicIpAddress": { + "PrivateIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The public IPv4 address assigned to the instance, if applicable.

", - "smithy.api#xmlName": "ipAddress" - } - }, - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the image.

", - "smithy.api#xmlName": "architecture" + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

", + "smithy.api#xmlName": "privateIpAddress" } }, - "RootDeviceName": { - "target": "com.amazonaws.ec2#String", + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "RootDeviceName", - "smithy.api#documentation": "

The device name of the root device volume (for example,\n /dev/sda1).

", - "smithy.api#xmlName": "rootDeviceName" + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Specifies whether to enable an instance launched in a VPC to perform NAT. This\n controls whether source/destination checking is enabled on the instance. A value of\n true means that checking is enabled, and false means that\n checking is disabled. The value must be false for the instance to perform\n NAT. For more information, see NAT Instances in the\n Amazon Virtual Private Cloud User Guide.

", + "smithy.api#xmlName": "sourceDestCheck" } } }, @@ -31559,28 +32577,20 @@ "com.amazonaws.ec2#InstanceAttribute": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups associated with the instance.

", - "smithy.api#xmlName": "groupSet" - } - }, - "DisableApiTermination": { + "SourceDestCheck": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If the value is true, you can't terminate the instance through the Amazon\n EC2 console, CLI, or API; otherwise, you can.

", - "smithy.api#xmlName": "disableApiTermination" + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled. A value of true\n means that checking is enabled, and false means that checking is disabled.\n This value must be false for a NAT instance to perform NAT.

", + "smithy.api#xmlName": "sourceDestCheck" } }, - "InstanceInitiatedShutdownBehavior": { + "KernelId": { "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

The kernel ID.

", + "smithy.api#xmlName": "kernel" } }, "SriovNetSupport": { @@ -31591,12 +32601,12 @@ "smithy.api#xmlName": "sriovNetSupport" } }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", + "InstanceId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

A list of product codes.

", - "smithy.api#xmlName": "productCodes" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" } }, "RootDeviceName": { @@ -31607,20 +32617,28 @@ "smithy.api#xmlName": "rootDeviceName" } }, - "EbsOptimized": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping of the instance.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "EnaSupport": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", - "smithy.api#xmlName": "ebsOptimized" + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Indicates whether enhanced networking with ENA is enabled.

", + "smithy.api#xmlName": "enaSupport" } }, - "RamdiskId": { - "target": "com.amazonaws.ec2#AttributeValue", + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", "traits": { - "aws.protocols#ec2QueryName": "Ramdisk", - "smithy.api#documentation": "

The RAM disk ID.

", - "smithy.api#xmlName": "ramdisk" + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups associated with the instance.

", + "smithy.api#xmlName": "groupSet" } }, "InstanceType": { @@ -31631,52 +32649,52 @@ "smithy.api#xmlName": "instanceType" } }, - "UserData": { - "target": "com.amazonaws.ec2#AttributeValue", + "DisableApiTermination": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The user data.

", - "smithy.api#xmlName": "userData" + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If the value is true, you can't terminate the instance through the Amazon\n EC2 console, CLI, or API; otherwise, you can.

", + "smithy.api#xmlName": "disableApiTermination" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mapping of the instance.

", - "smithy.api#xmlName": "blockDeviceMapping" + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

A list of product codes.

", + "smithy.api#xmlName": "productCodes" } }, - "EnaSupport": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", + "UserData": { + "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Indicates whether enhanced networking with ENA is enabled.

", - "smithy.api#xmlName": "enaSupport" + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The user data.

", + "smithy.api#xmlName": "userData" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" } }, - "SourceDestCheck": { + "EbsOptimized": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

Indicates whether source/destination checking is enabled. A value of true\n means that checking is enabled, and false means that checking is disabled.\n This value must be false for a NAT instance to perform NAT.

", - "smithy.api#xmlName": "sourceDestCheck" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "smithy.api#xmlName": "ebsOptimized" } }, - "KernelId": { + "RamdiskId": { "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "Kernel", - "smithy.api#documentation": "

The kernel ID.

", - "smithy.api#xmlName": "kernel" + "aws.protocols#ec2QueryName": "Ramdisk", + "smithy.api#documentation": "

The RAM disk ID.

", + "smithy.api#xmlName": "ramdisk" } } }, @@ -31736,14 +32754,6 @@ "com.amazonaws.ec2#InstanceBlockDeviceMapping": { "type": "structure", "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", - "smithy.api#xmlName": "deviceName" - } - }, "Ebs": { "target": "com.amazonaws.ec2#EbsInstanceBlockDevice", "traits": { @@ -31751,6 +32761,14 @@ "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", "smithy.api#xmlName": "ebs" } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } } }, "traits": { @@ -31769,20 +32787,12 @@ "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecification": { "type": "structure", "members": { - "VirtualName": { + "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name.

", - "smithy.api#xmlName": "virtualName" - } - }, - "Ebs": { - "target": "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification", - "traits": { - "aws.protocols#ec2QueryName": "Ebs", - "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", - "smithy.api#xmlName": "ebs" + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" } }, "NoDevice": { @@ -31793,12 +32803,20 @@ "smithy.api#xmlName": "noDevice" } }, - "DeviceName": { + "VirtualName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", - "smithy.api#xmlName": "deviceName" + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name.

", + "smithy.api#xmlName": "virtualName" + } + }, + "Ebs": { + "target": "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification", + "traits": { + "aws.protocols#ec2QueryName": "Ebs", + "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is\n launched.

", + "smithy.api#xmlName": "ebs" } } }, @@ -31826,14 +32844,6 @@ "smithy.api#xmlName": "availableCapacity" } }, - "TotalCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalCapacity", - "smithy.api#documentation": "

The total number of instances that can be launched onto the Dedicated Host if there \n \t\tare no instances running on it.

", - "smithy.api#xmlName": "totalCapacity" - } - }, "InstanceType": { "target": "com.amazonaws.ec2#String", "traits": { @@ -31841,6 +32851,14 @@ "smithy.api#documentation": "

The instance type supported by the Dedicated Host.

", "smithy.api#xmlName": "instanceType" } + }, + "TotalCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalCapacity", + "smithy.api#documentation": "

The total number of instances that can be launched onto the Dedicated Host if there \n \t\tare no instances running on it.

", + "smithy.api#xmlName": "totalCapacity" + } } }, "traits": { @@ -31850,14 +32868,6 @@ "com.amazonaws.ec2#InstanceCount": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#ListingState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The states of the listed Reserved Instances.

", - "smithy.api#xmlName": "state" - } - }, "InstanceCount": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -31865,6 +32875,14 @@ "smithy.api#documentation": "

The number of listed Reserved Instances in the state specified by the state.

", "smithy.api#xmlName": "instanceCount" } + }, + "State": { + "target": "com.amazonaws.ec2#ListingState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The states of the listed Reserved Instances.

", + "smithy.api#xmlName": "state" + } } }, "traits": { @@ -31925,17 +32943,17 @@ "com.amazonaws.ec2#InstanceCreditSpecificationRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the instance.

" - } - }, "CpuCredits": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The credit option for CPU usage of the instance. Valid values are\n standard and unlimited.

" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } } }, "traits": { @@ -32188,10 +33206,10 @@ "com.amazonaws.ec2#InstanceMetadataOptionsRequest": { "type": "structure", "members": { - "HttpEndpoint": { - "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n " + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

" } }, "HttpTokens": { @@ -32200,10 +33218,10 @@ "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" } }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.ec2#Integer", + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

" + "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n " } } }, @@ -32222,12 +33240,12 @@ "smithy.api#xmlName": "httpPutResponseHopLimit" } }, - "State": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsState", + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "HttpEndpoint", + "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n ", + "smithy.api#xmlName": "httpEndpoint" } }, "HttpTokens": { @@ -32238,12 +33256,12 @@ "smithy.api#xmlName": "httpTokens" } }, - "HttpEndpoint": { - "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "State": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsState", "traits": { - "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n ", - "smithy.api#xmlName": "httpEndpoint" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", + "smithy.api#xmlName": "state" } } }, @@ -32267,14 +33285,6 @@ "com.amazonaws.ec2#InstanceMonitoring": { "type": "structure", "members": { - "Monitoring": { - "target": "com.amazonaws.ec2#Monitoring", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

The monitoring for the instance.

", - "smithy.api#xmlName": "monitoring" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -32282,6 +33292,14 @@ "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#xmlName": "instanceId" } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Monitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } } }, "traits": { @@ -32300,36 +33318,28 @@ "com.amazonaws.ec2#InstanceNetworkInterface": { "type": "structure", "members": { - "Association": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association information for an Elastic IPv4 associated with the network\n interface.

", - "smithy.api#xmlName": "association" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#InstancePrivateIpAddressList", + "VpcId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", - "smithy.api#documentation": "

One or more private IPv4 addresses associated with the network interface.

", - "smithy.api#xmlName": "privateIpAddressesSet" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" } }, - "NetworkInterfaceId": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that created the network interface.

", + "smithy.api#xmlName": "ownerId" } }, - "SubnetId": { + "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

Describes the type of network interface.

\n\t\t

Valid values: interface | efa\n

", + "smithy.api#xmlName": "interfaceType" } }, "Status": { @@ -32348,30 +33358,6 @@ "smithy.api#xmlName": "attachment" } }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that created the network interface.

", - "smithy.api#xmlName": "ownerId" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressesSet", - "smithy.api#documentation": "

One or more IPv6 addresses associated with the network interface.

", - "smithy.api#xmlName": "ipv6AddressesSet" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, "PrivateDnsName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -32388,8 +33374,24 @@ "smithy.api#xmlName": "macAddress" } }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#Boolean", + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#InstancePrivateIpAddressList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

One or more private IPv4 addresses associated with the network interface.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "SourceDestCheck", "smithy.api#documentation": "

Indicates whether to validate network traffic to or from this network interface.

", @@ -32412,20 +33414,36 @@ "smithy.api#xmlName": "description" } }, - "VpcId": { + "PrivateIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

", + "smithy.api#xmlName": "privateIpAddress" } }, - "InterfaceType": { + "Association": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IPv4 associated with the network\n interface.

", + "smithy.api#xmlName": "association" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

One or more IPv6 addresses associated with the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "NetworkInterfaceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

Describes the type of network interface.

\n\t\t

Valid values: interface | efa\n

", - "smithy.api#xmlName": "interfaceType" + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" } } }, @@ -32436,14 +33454,6 @@ "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation": { "type": "structure", "members": { - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The public IP address or Elastic IP address bound to the network interface.

", - "smithy.api#xmlName": "publicIp" - } - }, "PublicDnsName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -32452,6 +33462,14 @@ "smithy.api#xmlName": "publicDnsName" } }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The public IP address or Elastic IP address bound to the network interface.

", + "smithy.api#xmlName": "publicIp" + } + }, "IpOwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -32459,6 +33477,14 @@ "smithy.api#documentation": "

The ID of the owner of the Elastic IP address.

", "smithy.api#xmlName": "ipOwnerId" } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated with the network interface.

", + "smithy.api#xmlName": "carrierIp" + } } }, "traits": { @@ -32468,14 +33494,6 @@ "com.amazonaws.ec2#InstanceNetworkInterfaceAttachment": { "type": "structure", "members": { - "AttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#documentation": "

The ID of the network interface attachment.

", - "smithy.api#xmlName": "attachmentId" - } - }, "Status": { "target": "com.amazonaws.ec2#AttachmentStatus", "traits": { @@ -32484,12 +33502,12 @@ "smithy.api#xmlName": "status" } }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", - "smithy.api#xmlName": "deleteOnTermination" + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" } }, "DeviceIndex": { @@ -32500,12 +33518,20 @@ "smithy.api#xmlName": "deviceIndex" } }, - "AttachTime": { - "target": "com.amazonaws.ec2#DateTime", + "AttachmentId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AttachTime", - "smithy.api#documentation": "

The time stamp when the attachment initiated.

", - "smithy.api#xmlName": "attachTime" + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" } } }, @@ -32525,12 +33551,27 @@ "com.amazonaws.ec2#InstanceNetworkInterfaceSpecification": { "type": "structure", "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "

If set to true, the interface is deleted when the instance is terminated. You can\n specify true only if creating a new network interface when launching an\n instance.

", - "smithy.api#xmlName": "deleteOnTermination" + "aws.protocols#ec2QueryName": "PrivateIpAddresses", + "smithy.api#documentation": "

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.

", + "smithy.api#xmlName": "privateIpAddressesSet" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "subnetId" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "smithy.api#xmlName": "SecurityGroupId" } }, "PrivateIpAddress": { @@ -32541,6 +33582,22 @@ "smithy.api#xmlName": "privateIpAddress" } }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

\n

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

If set to true, the interface is deleted when the instance is terminated. You can\n specify true only if creating a new network interface when launching an\n instance.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, "DeviceIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -32557,42 +33614,20 @@ "smithy.api#xmlName": "ipv6AddressesSet" } }, - "SecondaryPrivateIpAddressCount": { + "Ipv6AddressCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#documentation": "

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

\n

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "InterfaceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see Elastic Fabric Adapter in the \n\t\t\tAmazon Elastic Compute Cloud User Guide.

\n\t\t

If you are not creating an EFA, specify interface or omit this parameter.

\n\t\t

Valid values: interface | efa\n

" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.

", - "smithy.api#xmlName": "privateIpAddressesSet" + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses\n the IPv6 addresses from the range of the subnet. You cannot specify this option and the\n option to assign specific IPv6 addresses in the same request. You can specify this\n option if you've specified a minimum number of instances to launch.

", + "smithy.api#xmlName": "ipv6AddressCount" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The\n public IP address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

", + "smithy.api#xmlName": "associatePublicIpAddress" } }, "Description": { @@ -32603,27 +33638,24 @@ "smithy.api#xmlName": "description" } }, - "Groups": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "InterfaceType": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", - "smithy.api#xmlName": "SecurityGroupId" + "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see Elastic Fabric Adapter in the \n\t\t\tAmazon Elastic Compute Cloud User Guide.

\n\t\t

If you are not creating an EFA, specify interface or omit this parameter.

\n\t\t

Valid values: interface | efa\n

" } }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses\n the IPv6 addresses from the range of the subnet. You cannot specify this option and the\n option to assign specific IPv6 addresses in the same request. You can specify this\n option if you've specified a minimum number of instances to launch.

", - "smithy.api#xmlName": "ipv6AddressCount" + "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

" } }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.ec2#Boolean", + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "AssociatePublicIpAddress", - "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The\n public IP address can only be assigned to a network interface for eth0, and can only be\n assigned to a new network interface, not an existing one. You cannot specify more than one\n network interface in the request. If launching into a default subnet, the default value is\n true.

", - "smithy.api#xmlName": "associatePublicIpAddress" + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're\n \tlaunching more than one instance in a RunInstances request.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } } }, @@ -32643,12 +33675,12 @@ "com.amazonaws.ec2#InstancePrivateIpAddress": { "type": "structure", "members": { - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", + "Association": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IPv4 address of the network interface.

", - "smithy.api#xmlName": "privateIpAddress" + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address for the network interface.

", + "smithy.api#xmlName": "association" } }, "Primary": { @@ -32659,6 +33691,14 @@ "smithy.api#xmlName": "primary" } }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address of the network interface.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, "PrivateDnsName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -32666,14 +33706,6 @@ "smithy.api#documentation": "

The private IPv4 DNS name.

", "smithy.api#xmlName": "privateDnsName" } - }, - "Association": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association information for an Elastic IP address for the network interface.

", - "smithy.api#xmlName": "association" - } } }, "traits": { @@ -32692,17 +33724,17 @@ "com.amazonaws.ec2#InstanceSpecification": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#documentation": "

The instance to specify which volumes should be snapshotted.

" - } - }, "ExcludeBootVolume": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Excludes the root volume from being snapshotted.

" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The instance to specify which volumes should be snapshotted.

" + } } }, "traits": { @@ -32736,14 +33768,6 @@ "com.amazonaws.ec2#InstanceStateChange": { "type": "structure", "members": { - "PreviousState": { - "target": "com.amazonaws.ec2#InstanceState", - "traits": { - "aws.protocols#ec2QueryName": "PreviousState", - "smithy.api#documentation": "

The previous state of the instance.

", - "smithy.api#xmlName": "previousState" - } - }, "CurrentState": { "target": "com.amazonaws.ec2#InstanceState", "traits": { @@ -32752,6 +33776,14 @@ "smithy.api#xmlName": "currentState" } }, + "PreviousState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "PreviousState", + "smithy.api#documentation": "

The previous state of the instance.

", + "smithy.api#xmlName": "previousState" + } + }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -32802,12 +33834,12 @@ "com.amazonaws.ec2#InstanceStatus": { "type": "structure", "members": { - "SystemStatus": { - "target": "com.amazonaws.ec2#InstanceStatusSummary", + "Events": { + "target": "com.amazonaws.ec2#InstanceStatusEventList", "traits": { - "aws.protocols#ec2QueryName": "SystemStatus", - "smithy.api#documentation": "

Reports impaired functionality that stems from issues related to the systems that\n support an instance, such as hardware failures and network connectivity problems.

", - "smithy.api#xmlName": "systemStatus" + "aws.protocols#ec2QueryName": "EventsSet", + "smithy.api#documentation": "

Any scheduled events associated with the instance.

", + "smithy.api#xmlName": "eventsSet" } }, "AvailabilityZone": { @@ -32818,12 +33850,12 @@ "smithy.api#xmlName": "availabilityZone" } }, - "InstanceStatus": { - "target": "com.amazonaws.ec2#InstanceStatusSummary", + "InstanceState": { + "target": "com.amazonaws.ec2#InstanceState", "traits": { - "aws.protocols#ec2QueryName": "InstanceStatus", - "smithy.api#documentation": "

Reports impaired functionality that stems from issues internal to the instance, such\n as impaired reachability.

", - "smithy.api#xmlName": "instanceStatus" + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The intended state of the instance. DescribeInstanceStatus requires\n that an instance be in the running state.

", + "smithy.api#xmlName": "instanceState" } }, "InstanceId": { @@ -32834,12 +33866,12 @@ "smithy.api#xmlName": "instanceId" } }, - "InstanceState": { - "target": "com.amazonaws.ec2#InstanceState", + "InstanceStatus": { + "target": "com.amazonaws.ec2#InstanceStatusSummary", "traits": { - "aws.protocols#ec2QueryName": "InstanceState", - "smithy.api#documentation": "

The intended state of the instance. DescribeInstanceStatus requires\n that an instance be in the running state.

", - "smithy.api#xmlName": "instanceState" + "aws.protocols#ec2QueryName": "InstanceStatus", + "smithy.api#documentation": "

Reports impaired functionality that stems from issues internal to the instance, such\n as impaired reachability.

", + "smithy.api#xmlName": "instanceStatus" } }, "OutpostArn": { @@ -32850,12 +33882,12 @@ "smithy.api#xmlName": "outpostArn" } }, - "Events": { - "target": "com.amazonaws.ec2#InstanceStatusEventList", + "SystemStatus": { + "target": "com.amazonaws.ec2#InstanceStatusSummary", "traits": { - "aws.protocols#ec2QueryName": "EventsSet", - "smithy.api#documentation": "

Any scheduled events associated with the instance.

", - "smithy.api#xmlName": "eventsSet" + "aws.protocols#ec2QueryName": "SystemStatus", + "smithy.api#documentation": "

Reports impaired functionality that stems from issues related to the systems that\n support an instance, such as hardware failures and network connectivity problems.

", + "smithy.api#xmlName": "systemStatus" } } }, @@ -32866,12 +33898,12 @@ "com.amazonaws.ec2#InstanceStatusDetails": { "type": "structure", "members": { - "ImpairedSince": { - "target": "com.amazonaws.ec2#DateTime", + "Status": { + "target": "com.amazonaws.ec2#StatusType", "traits": { - "aws.protocols#ec2QueryName": "ImpairedSince", - "smithy.api#documentation": "

The time when a status check failed. For an instance that was launched and impaired,\n this is the time when the instance was launched.

", - "smithy.api#xmlName": "impairedSince" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status.

", + "smithy.api#xmlName": "status" } }, "Name": { @@ -32882,12 +33914,12 @@ "smithy.api#xmlName": "name" } }, - "Status": { - "target": "com.amazonaws.ec2#StatusType", + "ImpairedSince": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "ImpairedSince", + "smithy.api#documentation": "

The time when a status check failed. For an instance that was launched and impaired,\n this is the time when the instance was launched.

", + "smithy.api#xmlName": "impairedSince" } } }, @@ -32907,6 +33939,14 @@ "com.amazonaws.ec2#InstanceStatusEvent": { "type": "structure", "members": { + "NotBefore": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "NotBefore", + "smithy.api#documentation": "

The earliest scheduled start time for the event.

", + "smithy.api#xmlName": "notBefore" + } + }, "Code": { "target": "com.amazonaws.ec2#EventCode", "traits": { @@ -32915,6 +33955,14 @@ "smithy.api#xmlName": "code" } }, + "InstanceEventId": { + "target": "com.amazonaws.ec2#InstanceEventId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceEventId", + "smithy.api#documentation": "

The ID of the event.

", + "smithy.api#xmlName": "instanceEventId" + } + }, "NotBeforeDeadline": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -32938,22 +33986,6 @@ "smithy.api#documentation": "

A description of the event.

\n

After a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].

", "smithy.api#xmlName": "description" } - }, - "NotBefore": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "NotBefore", - "smithy.api#documentation": "

The earliest scheduled start time for the event.

", - "smithy.api#xmlName": "notBefore" - } - }, - "InstanceEventId": { - "target": "com.amazonaws.ec2#InstanceEventId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceEventId", - "smithy.api#documentation": "

The ID of the event.

", - "smithy.api#xmlName": "instanceEventId" - } } }, "traits": { @@ -33011,14 +34043,6 @@ "com.amazonaws.ec2#InstanceStorageInfo": { "type": "structure", "members": { - "Disks": { - "target": "com.amazonaws.ec2#DiskInfoList", - "traits": { - "aws.protocols#ec2QueryName": "Disks", - "smithy.api#documentation": "

Array describing the disks that are available for the instance type.

", - "smithy.api#xmlName": "disks" - } - }, "TotalSizeInGB": { "target": "com.amazonaws.ec2#DiskSize", "traits": { @@ -33026,6 +34050,14 @@ "smithy.api#documentation": "

The total size of the disks, in GB.

", "smithy.api#xmlName": "totalSizeInGB" } + }, + "Disks": { + "target": "com.amazonaws.ec2#DiskInfoList", + "traits": { + "aws.protocols#ec2QueryName": "Disks", + "smithy.api#documentation": "

Array describing the disks that are available for the instance type.

", + "smithy.api#xmlName": "disks" + } } }, "traits": { @@ -33135,6 +34167,27 @@ { "value": "t3a.2xlarge" }, + { + "value": "t4g.nano" + }, + { + "value": "t4g.micro" + }, + { + "value": "t4g.small" + }, + { + "value": "t4g.medium" + }, + { + "value": "t4g.large" + }, + { + "value": "t4g.xlarge" + }, + { + "value": "t4g.2xlarge" + }, { "value": "m1.small" }, @@ -33552,6 +34605,30 @@ { "value": "c5a.24xlarge" }, + { + "value": "c5ad.large" + }, + { + "value": "c5ad.xlarge" + }, + { + "value": "c5ad.2xlarge" + }, + { + "value": "c5ad.4xlarge" + }, + { + "value": "c5ad.8xlarge" + }, + { + "value": "c5ad.12xlarge" + }, + { + "value": "c5ad.16xlarge" + }, + { + "value": "c5ad.24xlarge" + }, { "value": "c5d.large" }, @@ -34092,12 +35169,68 @@ "com.amazonaws.ec2#InstanceTypeInfo": { "type": "structure", "members": { - "Hypervisor": { - "target": "com.amazonaws.ec2#InstanceTypeHypervisor", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

Indicates the hypervisor used for the instance type.

", - "smithy.api#xmlName": "hypervisor" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. For more information, see Instance Types in the Amazon Elastic Compute\n Cloud User Guide.

", + "smithy.api#xmlName": "instanceType" + } + }, + "SupportedRootDeviceTypes": { + "target": "com.amazonaws.ec2#RootDeviceTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedRootDeviceTypes", + "smithy.api#documentation": "

Indicates the supported root device types.

", + "smithy.api#xmlName": "supportedRootDeviceTypes" + } + }, + "SupportedVirtualizationTypes": { + "target": "com.amazonaws.ec2#VirtualizationTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedVirtualizationTypes", + "smithy.api#documentation": "

The supported virtualization types.

", + "smithy.api#xmlName": "supportedVirtualizationTypes" + } + }, + "BurstablePerformanceSupported": { + "target": "com.amazonaws.ec2#BurstablePerformanceFlag", + "traits": { + "aws.protocols#ec2QueryName": "BurstablePerformanceSupported", + "smithy.api#documentation": "

Indicates whether the instance type is a burstable performance instance type.

", + "smithy.api#xmlName": "burstablePerformanceSupported" + } + }, + "GpuInfo": { + "target": "com.amazonaws.ec2#GpuInfo", + "traits": { + "aws.protocols#ec2QueryName": "GpuInfo", + "smithy.api#documentation": "

Describes the GPU accelerator settings for the instance type.

", + "smithy.api#xmlName": "gpuInfo" + } + }, + "BareMetal": { + "target": "com.amazonaws.ec2#BareMetalFlag", + "traits": { + "aws.protocols#ec2QueryName": "BareMetal", + "smithy.api#documentation": "

Indicates whether the instance is bare metal.

", + "smithy.api#xmlName": "bareMetal" + } + }, + "FpgaInfo": { + "target": "com.amazonaws.ec2#FpgaInfo", + "traits": { + "aws.protocols#ec2QueryName": "FpgaInfo", + "smithy.api#documentation": "

Describes the FPGA accelerator settings for the instance type.

", + "smithy.api#xmlName": "fpgaInfo" + } + }, + "AutoRecoverySupported": { + "target": "com.amazonaws.ec2#AutoRecoveryFlag", + "traits": { + "aws.protocols#ec2QueryName": "AutoRecoverySupported", + "smithy.api#documentation": "

Indicates whether auto recovery is supported.

", + "smithy.api#xmlName": "autoRecoverySupported" } }, "InferenceAcceleratorInfo": { @@ -34108,12 +35241,12 @@ "smithy.api#xmlName": "inferenceAcceleratorInfo" } }, - "PlacementGroupInfo": { - "target": "com.amazonaws.ec2#PlacementGroupInfo", + "EbsInfo": { + "target": "com.amazonaws.ec2#EbsInfo", "traits": { - "aws.protocols#ec2QueryName": "PlacementGroupInfo", - "smithy.api#documentation": "

Describes the placement group settings for the instance type.

", - "smithy.api#xmlName": "placementGroupInfo" + "aws.protocols#ec2QueryName": "EbsInfo", + "smithy.api#documentation": "

Describes the Amazon EBS settings for the instance type.

", + "smithy.api#xmlName": "ebsInfo" } }, "NetworkInfo": { @@ -34124,28 +35257,20 @@ "smithy.api#xmlName": "networkInfo" } }, - "EbsInfo": { - "target": "com.amazonaws.ec2#EbsInfo", - "traits": { - "aws.protocols#ec2QueryName": "EbsInfo", - "smithy.api#documentation": "

Describes the Amazon EBS settings for the instance type.

", - "smithy.api#xmlName": "ebsInfo" - } - }, - "HibernationSupported": { - "target": "com.amazonaws.ec2#HibernationFlag", + "PlacementGroupInfo": { + "target": "com.amazonaws.ec2#PlacementGroupInfo", "traits": { - "aws.protocols#ec2QueryName": "HibernationSupported", - "smithy.api#documentation": "

Indicates whether On-Demand hibernation is supported.

", - "smithy.api#xmlName": "hibernationSupported" + "aws.protocols#ec2QueryName": "PlacementGroupInfo", + "smithy.api#documentation": "

Describes the placement group settings for the instance type.

", + "smithy.api#xmlName": "placementGroupInfo" } }, - "CurrentGeneration": { - "target": "com.amazonaws.ec2#CurrentGenerationFlag", + "Hypervisor": { + "target": "com.amazonaws.ec2#InstanceTypeHypervisor", "traits": { - "aws.protocols#ec2QueryName": "CurrentGeneration", - "smithy.api#documentation": "

Indicates whether the instance type is a current generation.

", - "smithy.api#xmlName": "currentGeneration" + "aws.protocols#ec2QueryName": "Hypervisor", + "smithy.api#documentation": "

Indicates the hypervisor used for the instance type.

", + "smithy.api#xmlName": "hypervisor" } }, "InstanceStorageInfo": { @@ -34156,6 +35281,14 @@ "smithy.api#xmlName": "instanceStorageInfo" } }, + "ProcessorInfo": { + "target": "com.amazonaws.ec2#ProcessorInfo", + "traits": { + "aws.protocols#ec2QueryName": "ProcessorInfo", + "smithy.api#documentation": "

Describes the processor.

", + "smithy.api#xmlName": "processorInfo" + } + }, "FreeTierEligible": { "target": "com.amazonaws.ec2#FreeTierEligibleFlag", "traits": { @@ -34164,36 +35297,20 @@ "smithy.api#xmlName": "freeTierEligible" } }, - "AutoRecoverySupported": { - "target": "com.amazonaws.ec2#AutoRecoveryFlag", - "traits": { - "aws.protocols#ec2QueryName": "AutoRecoverySupported", - "smithy.api#documentation": "

Indicates whether auto recovery is supported.

", - "smithy.api#xmlName": "autoRecoverySupported" - } - }, - "BareMetal": { - "target": "com.amazonaws.ec2#BareMetalFlag", - "traits": { - "aws.protocols#ec2QueryName": "BareMetal", - "smithy.api#documentation": "

Indicates whether the instance is bare metal.

", - "smithy.api#xmlName": "bareMetal" - } - }, - "FpgaInfo": { - "target": "com.amazonaws.ec2#FpgaInfo", + "InstanceStorageSupported": { + "target": "com.amazonaws.ec2#InstanceStorageFlag", "traits": { - "aws.protocols#ec2QueryName": "FpgaInfo", - "smithy.api#documentation": "

Describes the FPGA accelerator settings for the instance type.

", - "smithy.api#xmlName": "fpgaInfo" + "aws.protocols#ec2QueryName": "InstanceStorageSupported", + "smithy.api#documentation": "

Indicates whether instance storage is supported.

", + "smithy.api#xmlName": "instanceStorageSupported" } }, - "GpuInfo": { - "target": "com.amazonaws.ec2#GpuInfo", + "HibernationSupported": { + "target": "com.amazonaws.ec2#HibernationFlag", "traits": { - "aws.protocols#ec2QueryName": "GpuInfo", - "smithy.api#documentation": "

Describes the GPU accelerator settings for the instance type.

", - "smithy.api#xmlName": "gpuInfo" + "aws.protocols#ec2QueryName": "HibernationSupported", + "smithy.api#documentation": "

Indicates whether On-Demand hibernation is supported.

", + "smithy.api#xmlName": "hibernationSupported" } }, "VCpuInfo": { @@ -34204,28 +35321,12 @@ "smithy.api#xmlName": "vCpuInfo" } }, - "SupportedRootDeviceTypes": { - "target": "com.amazonaws.ec2#RootDeviceTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedRootDeviceTypes", - "smithy.api#documentation": "

Indicates the supported root device types.

", - "smithy.api#xmlName": "supportedRootDeviceTypes" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. For more information, see Instance Types in the Amazon Elastic Compute\n Cloud User Guide.

", - "smithy.api#xmlName": "instanceType" - } - }, - "SupportedVirtualizationTypes": { - "target": "com.amazonaws.ec2#VirtualizationTypeList", + "CurrentGeneration": { + "target": "com.amazonaws.ec2#CurrentGenerationFlag", "traits": { - "aws.protocols#ec2QueryName": "SupportedVirtualizationTypes", - "smithy.api#documentation": "

The supported virtualization types.

", - "smithy.api#xmlName": "supportedVirtualizationTypes" + "aws.protocols#ec2QueryName": "CurrentGeneration", + "smithy.api#documentation": "

Indicates whether the instance type is a current generation.

", + "smithy.api#xmlName": "currentGeneration" } }, "MemoryInfo": { @@ -34236,14 +35337,6 @@ "smithy.api#xmlName": "memoryInfo" } }, - "SupportedUsageClasses": { - "target": "com.amazonaws.ec2#UsageClassTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedUsageClasses", - "smithy.api#documentation": "

Indicates whether the instance type is offered for spot or On-Demand.

", - "smithy.api#xmlName": "supportedUsageClasses" - } - }, "DedicatedHostsSupported": { "target": "com.amazonaws.ec2#DedicatedHostFlag", "traits": { @@ -34252,28 +35345,12 @@ "smithy.api#xmlName": "dedicatedHostsSupported" } }, - "ProcessorInfo": { - "target": "com.amazonaws.ec2#ProcessorInfo", - "traits": { - "aws.protocols#ec2QueryName": "ProcessorInfo", - "smithy.api#documentation": "

Describes the processor.

", - "smithy.api#xmlName": "processorInfo" - } - }, - "BurstablePerformanceSupported": { - "target": "com.amazonaws.ec2#BurstablePerformanceFlag", - "traits": { - "aws.protocols#ec2QueryName": "BurstablePerformanceSupported", - "smithy.api#documentation": "

Indicates whether the instance type is a burstable performance instance type.

", - "smithy.api#xmlName": "burstablePerformanceSupported" - } - }, - "InstanceStorageSupported": { - "target": "com.amazonaws.ec2#InstanceStorageFlag", + "SupportedUsageClasses": { + "target": "com.amazonaws.ec2#UsageClassTypeList", "traits": { - "aws.protocols#ec2QueryName": "InstanceStorageSupported", - "smithy.api#documentation": "

Indicates whether instance storage is supported.

", - "smithy.api#xmlName": "instanceStorageSupported" + "aws.protocols#ec2QueryName": "SupportedUsageClasses", + "smithy.api#documentation": "

Indicates whether the instance type is offered for spot or On-Demand.

", + "smithy.api#xmlName": "supportedUsageClasses" } } }, @@ -34299,6 +35376,14 @@ "com.amazonaws.ec2#InstanceTypeOffering": { "type": "structure", "members": { + "Location": { + "target": "com.amazonaws.ec2#Location", + "traits": { + "aws.protocols#ec2QueryName": "Location", + "smithy.api#documentation": "

The identifier for the location. This depends on the location type. For example, if the location type is\n region, the location is the Region code (for example, us-east-2.)

", + "smithy.api#xmlName": "location" + } + }, "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { @@ -34314,14 +35399,6 @@ "smithy.api#documentation": "

The location type.

", "smithy.api#xmlName": "locationType" } - }, - "Location": { - "target": "com.amazonaws.ec2#Location", - "traits": { - "aws.protocols#ec2QueryName": "Location", - "smithy.api#documentation": "

The identifier for the location. This depends on the location type. For example, if the location type is\n region, the location is the Region code (for example, us-east-2.)

", - "smithy.api#xmlName": "location" - } } }, "traits": { @@ -34340,14 +35417,6 @@ "com.amazonaws.ec2#InstanceUsage": { "type": "structure", "members": { - "UsedInstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "UsedInstanceCount", - "smithy.api#documentation": "

The number of instances the AWS account currently has in the Capacity Reservation.

", - "smithy.api#xmlName": "usedInstanceCount" - } - }, "AccountId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -34355,6 +35424,14 @@ "smithy.api#documentation": "

The ID of the AWS account that is making use of the Capacity Reservation.

", "smithy.api#xmlName": "accountId" } + }, + "UsedInstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "UsedInstanceCount", + "smithy.api#documentation": "

The number of instances the AWS account currently has in the Capacity Reservation.

", + "smithy.api#xmlName": "usedInstanceCount" + } } }, "traits": { @@ -34397,12 +35474,12 @@ "smithy.api#xmlName": "internetGatewayId" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "Attachments": { + "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the internet gateway.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Any VPCs attached to the internet gateway.

", + "smithy.api#xmlName": "attachmentSet" } }, "OwnerId": { @@ -34413,12 +35490,12 @@ "smithy.api#xmlName": "ownerId" } }, - "Attachments": { - "target": "com.amazonaws.ec2#InternetGatewayAttachmentList", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "

Any VPCs attached to the internet gateway.

", - "smithy.api#xmlName": "attachmentSet" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the internet gateway.

", + "smithy.api#xmlName": "tagSet" } } }, @@ -34429,14 +35506,6 @@ "com.amazonaws.ec2#InternetGatewayAttachment": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, "State": { "target": "com.amazonaws.ec2#AttachmentStatus", "traits": { @@ -34444,6 +35513,14 @@ "smithy.api#documentation": "

The current state of the attachment. For an internet gateway, the state is\n\t\t\t\tavailable when attached to a VPC; otherwise, this value is not\n\t\t\treturned.

", "smithy.api#xmlName": "state" } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } } }, "traits": { @@ -34483,14 +35560,6 @@ "com.amazonaws.ec2#IpPermission": { "type": "structure", "members": { - "IpRanges": { - "target": "com.amazonaws.ec2#IpRangeList", - "traits": { - "aws.protocols#ec2QueryName": "IpRanges", - "smithy.api#documentation": "

The IPv4 ranges.

", - "smithy.api#xmlName": "ipRanges" - } - }, "Ipv6Ranges": { "target": "com.amazonaws.ec2#Ipv6RangeList", "traits": { @@ -34499,12 +35568,12 @@ "smithy.api#xmlName": "ipv6Ranges" } }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", + "UserIdGroupPairs": { + "target": "com.amazonaws.ec2#UserIdGroupPairList", "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#documentation": "

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value\n\t\tof -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, \n you must specify all codes.

", - "smithy.api#xmlName": "toPort" + "aws.protocols#ec2QueryName": "Groups", + "smithy.api#documentation": "

The security group and AWS account ID pairs.

", + "smithy.api#xmlName": "groups" } }, "FromPort": { @@ -34515,14 +35584,6 @@ "smithy.api#xmlName": "fromPort" } }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) \n or number (see Protocol Numbers).

\n

[VPC only] Use -1 to specify all protocols. When authorizing\n security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify. For tcp,\n udp, and icmp, you must specify a port range. For icmpv6,\n the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", - "smithy.api#xmlName": "ipProtocol" - } - }, "PrefixListIds": { "target": "com.amazonaws.ec2#PrefixListIdList", "traits": { @@ -34531,12 +35592,28 @@ "smithy.api#xmlName": "prefixListIds" } }, - "UserIdGroupPairs": { - "target": "com.amazonaws.ec2#UserIdGroupPairList", + "IpRanges": { + "target": "com.amazonaws.ec2#IpRangeList", "traits": { - "aws.protocols#ec2QueryName": "Groups", - "smithy.api#documentation": "

The security group and AWS account ID pairs.

", - "smithy.api#xmlName": "groups" + "aws.protocols#ec2QueryName": "IpRanges", + "smithy.api#documentation": "

The IPv4 ranges.

", + "smithy.api#xmlName": "ipRanges" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value\n\t\tof -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, \n you must specify all codes.

", + "smithy.api#xmlName": "toPort" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) \n or number (see Protocol Numbers).

\n

[VPC only] Use -1 to specify all protocols. When authorizing\n security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify. For tcp,\n udp, and icmp, you must specify a port range. For icmpv6,\n the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", + "smithy.api#xmlName": "ipProtocol" } } }, @@ -34685,6 +35762,14 @@ "smithy.api#xmlName": "tagSet" } }, + "PoolCidrBlocks": { + "target": "com.amazonaws.ec2#PoolCidrBlocksSet", + "traits": { + "aws.protocols#ec2QueryName": "PoolCidrBlockSet", + "smithy.api#documentation": "

The CIDR blocks for the address pool.

", + "smithy.api#xmlName": "poolCidrBlockSet" + } + }, "PoolId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -34700,14 +35785,6 @@ "smithy.api#documentation": "

The description for the address pool.

", "smithy.api#xmlName": "description" } - }, - "PoolCidrBlocks": { - "target": "com.amazonaws.ec2#PoolCidrBlocksSet", - "traits": { - "aws.protocols#ec2QueryName": "PoolCidrBlockSet", - "smithy.api#documentation": "

The CIDR blocks for the address pool.

", - "smithy.api#xmlName": "poolCidrBlockSet" - } } }, "traits": { @@ -34747,14 +35824,6 @@ "com.amazonaws.ec2#Ipv6Range": { "type": "structure", "members": { - "CidrIpv6": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIpv6", - "smithy.api#documentation": "

The IPv6 CIDR range. You can either specify a CIDR range or a source security group,\n not both. To specify a single IPv6 address, use the /128 prefix length.

", - "smithy.api#xmlName": "cidrIpv6" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -34762,6 +35831,14 @@ "smithy.api#documentation": "

A description for the security group rule that references this IPv6 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", "smithy.api#xmlName": "description" } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "

The IPv6 CIDR range. You can either specify a CIDR range or a source security group,\n not both. To specify a single IPv6 address, use the /128 prefix length.

", + "smithy.api#xmlName": "cidrIpv6" + } } }, "traits": { @@ -34805,14 +35882,6 @@ "com.amazonaws.ec2#KeyPair": { "type": "structure", "members": { - "KeyFingerprint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

The SHA-1 digest of the DER encoded private key.

", - "smithy.api#xmlName": "keyFingerprint" - } - }, "KeyName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -34821,14 +35890,6 @@ "smithy.api#xmlName": "keyName" } }, - "KeyMaterial": { - "target": "com.amazonaws.ec2#SensitiveUserData", - "traits": { - "aws.protocols#ec2QueryName": "KeyMaterial", - "smithy.api#documentation": "

An unencrypted PEM encoded RSA private key.

", - "smithy.api#xmlName": "keyMaterial" - } - }, "KeyPairId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -34837,6 +35898,14 @@ "smithy.api#xmlName": "keyPairId" } }, + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "

The SHA-1 digest of the DER encoded private key.

", + "smithy.api#xmlName": "keyFingerprint" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -34844,6 +35913,14 @@ "smithy.api#documentation": "

Any tags applied to the key pair.

", "smithy.api#xmlName": "tagSet" } + }, + "KeyMaterial": { + "target": "com.amazonaws.ec2#SensitiveUserData", + "traits": { + "aws.protocols#ec2QueryName": "KeyMaterial", + "smithy.api#documentation": "

An unencrypted PEM encoded RSA private key.

", + "smithy.api#xmlName": "keyMaterial" + } } }, "traits": { @@ -34865,20 +35942,12 @@ "com.amazonaws.ec2#KeyPairInfo": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags applied to the key pair.

", - "smithy.api#xmlName": "tagSet" - } - }, - "KeyFingerprint": { + "KeyName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", - "smithy.api#xmlName": "keyFingerprint" + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" } }, "KeyPairId": { @@ -34889,12 +35958,20 @@ "smithy.api#xmlName": "keyPairId" } }, - "KeyName": { + "KeyFingerprint": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "smithy.api#xmlName": "keyFingerprint" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the key pair.

", + "smithy.api#xmlName": "tagSet" } } }, @@ -34944,14 +36021,6 @@ "com.amazonaws.ec2#LaunchPermission": { "type": "structure", "members": { - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The AWS account ID.

", - "smithy.api#xmlName": "userId" - } - }, "Group": { "target": "com.amazonaws.ec2#PermissionGroup", "traits": { @@ -34959,6 +36028,14 @@ "smithy.api#documentation": "

The name of the group.

", "smithy.api#xmlName": "group" } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#xmlName": "userId" + } } }, "traits": { @@ -34977,16 +36054,16 @@ "com.amazonaws.ec2#LaunchPermissionModifications": { "type": "structure", "members": { - "Remove": { + "Add": { "target": "com.amazonaws.ec2#LaunchPermissionList", "traits": { - "smithy.api#documentation": "

The AWS account ID to remove from the list of launch permissions for the AMI.

" + "smithy.api#documentation": "

The AWS account ID to add to the list of launch permissions for the AMI.

" } }, - "Add": { + "Remove": { "target": "com.amazonaws.ec2#LaunchPermissionList", "traits": { - "smithy.api#documentation": "

The AWS account ID to add to the list of launch permissions for the AMI.

" + "smithy.api#documentation": "

The AWS account ID to remove from the list of launch permissions for the AMI.

" } } }, @@ -34997,68 +36074,68 @@ "com.amazonaws.ec2#LaunchSpecification": { "type": "structure", "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "KeyName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

One or more block device mapping entries.

", - "smithy.api#xmlName": "blockDeviceMapping" + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" } }, - "KernelId": { - "target": "com.amazonaws.ec2#String", + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" } }, - "UserData": { - "target": "com.amazonaws.ec2#String", + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The Base64-encoded user data for the instance.

", - "smithy.api#xmlName": "userData" + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" } }, - "AddressingType": { - "target": "com.amazonaws.ec2#String", + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "AddressingType", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "addressingType" + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", + "smithy.api#xmlName": "networkInterfaceSet" } }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", - "smithy.api#xmlName": "groupSet" + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

One or more block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" } }, - "ImageId": { + "UserData": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The Base64-encoded user data for the instance.

", + "smithy.api#xmlName": "userData" } }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "smithy.api#xmlName": "groupSet" } }, "RamdiskId": { @@ -35069,36 +36146,36 @@ "smithy.api#xmlName": "ramdiskId" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "ImageId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" } }, - "Placement": { - "target": "com.amazonaws.ec2#SpotPlacement", + "SubnetId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement information for the instance.

", - "smithy.api#xmlName": "placement" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which to launch the instance.

", + "smithy.api#xmlName": "subnetId" } }, - "KeyName": { + "AddressingType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" } }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "KernelId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify \n subnet IDs and security group IDs using the network interface.

", - "smithy.api#xmlName": "networkInterfaceSet" + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" } }, "IamInstanceProfile": { @@ -35133,22 +36210,6 @@ "com.amazonaws.ec2#LaunchTemplate": { "type": "structure", "members": { - "DefaultVersionNumber": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "DefaultVersionNumber", - "smithy.api#documentation": "

The version number of the default version of the launch template.

", - "smithy.api#xmlName": "defaultVersionNumber" - } - }, - "LatestVersionNumber": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "LatestVersionNumber", - "smithy.api#documentation": "

The version number of the latest version of the launch template.

", - "smithy.api#xmlName": "latestVersionNumber" - } - }, "CreateTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -35157,12 +36218,12 @@ "smithy.api#xmlName": "createTime" } }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", + "LatestVersionNumber": { + "target": "com.amazonaws.ec2#Long", "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

", - "smithy.api#xmlName": "launchTemplateId" + "aws.protocols#ec2QueryName": "LatestVersionNumber", + "smithy.api#documentation": "

The version number of the latest version of the launch template.

", + "smithy.api#xmlName": "latestVersionNumber" } }, "LaunchTemplateName": { @@ -35173,6 +36234,14 @@ "smithy.api#xmlName": "launchTemplateName" } }, + "CreatedBy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreatedBy", + "smithy.api#documentation": "

The principal that created the launch template.

", + "smithy.api#xmlName": "createdBy" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -35181,12 +36250,20 @@ "smithy.api#xmlName": "tagSet" } }, - "CreatedBy": { + "DefaultVersionNumber": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "DefaultVersionNumber", + "smithy.api#documentation": "

The version number of the default version of the launch template.

", + "smithy.api#xmlName": "defaultVersionNumber" + } + }, + "LaunchTemplateId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CreatedBy", - "smithy.api#documentation": "

The principal that created the launch template.

", - "smithy.api#xmlName": "createdBy" + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" } } }, @@ -35197,14 +36274,6 @@ "com.amazonaws.ec2#LaunchTemplateAndOverridesResponse": { "type": "structure", "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", - "smithy.api#documentation": "

The launch template.

", - "smithy.api#xmlName": "launchTemplateSpecification" - } - }, "Overrides": { "target": "com.amazonaws.ec2#FleetLaunchTemplateOverrides", "traits": { @@ -35212,6 +36281,14 @@ "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch\n template.

", "smithy.api#xmlName": "overrides" } + }, + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } } }, "traits": { @@ -35221,6 +36298,14 @@ "com.amazonaws.ec2#LaunchTemplateBlockDeviceMapping": { "type": "structure", "members": { + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name (ephemeralN).

", + "smithy.api#xmlName": "virtualName" + } + }, "Ebs": { "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice", "traits": { @@ -35229,12 +36314,12 @@ "smithy.api#xmlName": "ebs" } }, - "VirtualName": { + "NoDevice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name (ephemeralN).

", - "smithy.api#xmlName": "virtualName" + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

Suppresses the specified device included in the block device mapping of the AMI.

", + "smithy.api#xmlName": "noDevice" } }, "DeviceName": { @@ -35244,14 +36329,6 @@ "smithy.api#documentation": "

The device name.

", "smithy.api#xmlName": "deviceName" } - }, - "NoDevice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NoDevice", - "smithy.api#documentation": "

Suppresses the specified device included in the block device mapping of the AMI.

", - "smithy.api#xmlName": "noDevice" - } } }, "traits": { @@ -35270,28 +36347,28 @@ "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequest": { "type": "structure", "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" - } - }, "Ebs": { "target": "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest", "traits": { "smithy.api#documentation": "

Parameters used to automatically set up EBS volumes when the instance is launched.

" } }, - "NoDevice": { + "VirtualName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Suppresses the specified device included in the block device mapping of the AMI.

" + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

" } }, - "VirtualName": { + "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

" + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" + } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Suppresses the specified device included in the block device mapping of the AMI.

" } } }, @@ -35331,14 +36408,6 @@ "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse": { "type": "structure", "members": { - "CapacityReservationTarget": { - "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationTarget", - "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation group.

", - "smithy.api#xmlName": "capacityReservationTarget" - } - }, "CapacityReservationPreference": { "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { @@ -35346,6 +36415,14 @@ "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

\n\t\t ", "smithy.api#xmlName": "capacityReservationPreference" } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.ec2#CapacityReservationTargetResponse", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationTarget", + "smithy.api#documentation": "

Information about the target Capacity Reservation or Capacity Reservation group.

", + "smithy.api#xmlName": "capacityReservationTarget" + } } }, "traits": { @@ -35355,14 +36432,6 @@ "com.amazonaws.ec2#LaunchTemplateConfig": { "type": "structure", "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", - "smithy.api#documentation": "

The launch template.

", - "smithy.api#xmlName": "launchTemplateSpecification" - } - }, "Overrides": { "target": "com.amazonaws.ec2#LaunchTemplateOverridesList", "traits": { @@ -35370,6 +36439,14 @@ "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch template.

", "smithy.api#xmlName": "overrides" } + }, + "LaunchTemplateSpecification": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", + "smithy.api#documentation": "

The launch template.

", + "smithy.api#xmlName": "launchTemplateSpecification" + } } }, "traits": { @@ -35388,14 +36465,6 @@ "com.amazonaws.ec2#LaunchTemplateCpuOptions": { "type": "structure", "members": { - "CoreCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "CoreCount", - "smithy.api#documentation": "

The number of CPU cores for the instance.

", - "smithy.api#xmlName": "coreCount" - } - }, "ThreadsPerCore": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -35403,6 +36472,14 @@ "smithy.api#documentation": "

The number of threads per CPU core.

", "smithy.api#xmlName": "threadsPerCore" } + }, + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CoreCount", + "smithy.api#documentation": "

The number of CPU cores for the instance.

", + "smithy.api#xmlName": "coreCount" + } } }, "traits": { @@ -35432,6 +36509,22 @@ "com.amazonaws.ec2#LaunchTemplateEbsBlockDevice": { "type": "structure", "members": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#xmlName": "snapshotId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + }, "VolumeType": { "target": "com.amazonaws.ec2#VolumeType", "traits": { @@ -35440,12 +36533,12 @@ "smithy.api#xmlName": "volumeType" } }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted.

", - "smithy.api#xmlName": "encrypted" + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

", + "smithy.api#xmlName": "kmsKeyId" } }, "Iops": { @@ -35464,28 +36557,12 @@ "smithy.api#xmlName": "deleteOnTermination" } }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#xmlName": "volumeSize" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot.

", - "smithy.api#xmlName": "snapshotId" + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted.

", + "smithy.api#xmlName": "encrypted" } } }, @@ -35496,16 +36573,10 @@ "com.amazonaws.ec2#LaunchTemplateEbsBlockDeviceRequest": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.ec2#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for\n encryption.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", "traits": { - "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + "smithy.api#documentation": "

The ID of the snapshot.

" } }, "Encrypted": { @@ -35514,16 +36585,10 @@ "smithy.api#documentation": "

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

" } }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", + "KmsKeyId": { + "target": "com.amazonaws.ec2#KmsKeyId", "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

" + "smithy.api#documentation": "

The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for\n encryption.

" } }, "VolumeType": { @@ -35535,7 +36600,19 @@ "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

\n

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tNitro-based instances. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS Volume Types in the\n \t\tAmazon Elastic Compute Cloud User Guide.

\n \t

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" } } }, @@ -35584,14 +36661,6 @@ "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponse": { "type": "structure", "members": { - "Count": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

\n \t\tThe number of elastic inference accelerators to attach to the instance. \n \t

\n \t

Default: 1

", - "smithy.api#xmlName": "count" - } - }, "Type": { "target": "com.amazonaws.ec2#String", "traits": { @@ -35599,6 +36668,14 @@ "smithy.api#documentation": "

\n The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.\n

", "smithy.api#xmlName": "type" } + }, + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

\n \t\tThe number of elastic inference accelerators to attach to the instance. \n \t

\n \t

Default: 1

", + "smithy.api#xmlName": "count" + } } }, "traits": { @@ -35814,12 +36891,12 @@ "smithy.api#xmlName": "httpTokens" } }, - "State": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState", + "HttpEndpoint": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the instance.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "HttpEndpoint", + "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your instance metadata.\n

\n ", + "smithy.api#xmlName": "httpEndpoint" } }, "HttpPutResponseHopLimit": { @@ -35830,12 +36907,12 @@ "smithy.api#xmlName": "httpPutResponseHopLimit" } }, - "HttpEndpoint": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", + "State": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState", "traits": { - "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your instance metadata.\n

\n ", - "smithy.api#xmlName": "httpEndpoint" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the instance.

", + "smithy.api#xmlName": "state" } } }, @@ -35846,12 +36923,6 @@ "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsRequest": { "type": "structure", "members": { - "HttpEndpoint": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", - "traits": { - "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your instance metadata.\n

\n " - } - }, "HttpPutResponseHopLimit": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -35863,6 +36934,12 @@ "traits": { "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

\n

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

" } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your instance metadata.\n

\n " + } } }, "traits": { @@ -35885,6 +36962,14 @@ "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecification": { "type": "structure", "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, "AssociatePublicIpAddress": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -35893,36 +36978,44 @@ "smithy.api#xmlName": "associatePublicIpAddress" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the network interface.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#documentation": "

The device index for the network interface attachment.

", + "smithy.api#xmlName": "deviceIndex" } }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "

The number of IPv6 addresses for the network interface.

", - "smithy.api#xmlName": "ipv6AddressCount" + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet for the network interface.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "AssociateCarrierIpAddress", + "smithy.api#documentation": "

Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the AWS Wavelength Developer\n Guide.

", + "smithy.api#xmlName": "associateCarrierIpAddress" } }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", - "smithy.api#documentation": "

One or more private IPv4 addresses.

", - "smithy.api#xmlName": "privateIpAddressesSet" + "aws.protocols#ec2QueryName": "Ipv6AddressesSet", + "smithy.api#documentation": "

The IPv6 addresses for the network interface.

", + "smithy.api#xmlName": "ipv6AddressesSet" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses for the network interface.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } }, "PrivateIpAddress": { @@ -35933,36 +37026,36 @@ "smithy.api#xmlName": "privateIpAddress" } }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", + "InterfaceType": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#documentation": "

The device index for the network interface attachment.

", - "smithy.api#xmlName": "deviceIndex" + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

", + "smithy.api#xmlName": "interfaceType" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

One or more private IPv4 addresses.

", + "smithy.api#xmlName": "privateIpAddressesSet" } }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", - "smithy.api#xmlName": "deleteOnTermination" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet for the network interface.

", + "smithy.api#xmlName": "subnetId" } }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressesSet", - "smithy.api#documentation": "

The IPv6 addresses for the network interface.

", - "smithy.api#xmlName": "ipv6AddressesSet" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" } }, "Groups": { @@ -35973,20 +37066,12 @@ "smithy.api#xmlName": "groupSet" } }, - "InterfaceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

The type of network interface.

", - "smithy.api#xmlName": "interfaceType" - } - }, - "SecondaryPrivateIpAddressCount": { + "Ipv6AddressCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#documentation": "

The number of secondary private IPv4 addresses for the network interface.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

The number of IPv6 addresses for the network interface.

", + "smithy.api#xmlName": "ipv6AddressCount" } } }, @@ -36006,28 +37091,22 @@ "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequest": { "type": "structure", "members": { - "Ipv6AddressCount": { + "SecondaryPrivateIpAddressCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressListRequest", - "traits": { - "smithy.api#documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

" + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface.

" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The ID of the subnet for the network interface.

" + "smithy.api#documentation": "

The device index for the network interface attachment.

" } }, - "DeleteOnTermination": { + "AssociatePublicIpAddress": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

" + "smithy.api#documentation": "

Associates a public IPv4 address with eth0 for a new network interface.

" } }, "NetworkInterfaceId": { @@ -36036,22 +37115,22 @@ "smithy.api#documentation": "

The ID of the network interface.

" } }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.ec2#Boolean", + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { - "smithy.api#documentation": "

Associates a public IPv4 address with eth0 for a new network interface.

" + "smithy.api#documentation": "

One or more private IPv4 addresses.

" } }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface.

" + "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

" } }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

One or more private IPv4 addresses.

" + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

" } }, "Description": { @@ -36060,6 +37139,12 @@ "smithy.api#documentation": "

A description for the network interface.

" } }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

" + } + }, "Groups": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { @@ -36067,10 +37152,10 @@ "smithy.api#xmlName": "SecurityGroupId" } }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The device index for the network interface attachment.

" + "smithy.api#documentation": "

Associates a Carrier IP address with eth0 for a new network interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the AWS Wavelength Developer\n Guide.

" } }, "InterfaceType": { @@ -36079,10 +37164,16 @@ "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see Elastic Fabric Adapter in the \n\t\t\tAmazon Elastic Compute Cloud User Guide.

\n\t\t

If you are not creating an EFA, specify interface or omit this parameter.

\n\t\t

Valid values: interface | efa\n

" } }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressListRequest", "traits": { - "smithy.api#documentation": "

The primary private IPv4 address of the network interface.

" + "smithy.api#documentation": "

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "smithy.api#documentation": "

The ID of the subnet for the network interface.

" } } }, @@ -36177,22 +37268,6 @@ "smithy.api#xmlName": "priority" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

", - "smithy.api#xmlName": "spotPrice" - } - }, "WeightedCapacity": { "target": "com.amazonaws.ec2#Double", "traits": { @@ -36216,6 +37291,22 @@ "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", "smithy.api#xmlName": "availabilityZone" } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "SpotPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

", + "smithy.api#xmlName": "spotPrice" + } } }, "traits": { @@ -36234,12 +37325,12 @@ "com.amazonaws.ec2#LaunchTemplatePlacement": { "type": "structure", "members": { - "HostId": { + "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

", - "smithy.api#xmlName": "hostId" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

", + "smithy.api#xmlName": "availabilityZone" } }, "SpreadDomain": { @@ -36250,28 +37341,20 @@ "smithy.api#xmlName": "spreadDomain" } }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the instance.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group for the instance.

", - "smithy.api#xmlName": "groupName" + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", + "smithy.api#xmlName": "tenancy" } }, - "Affinity": { - "target": "com.amazonaws.ec2#String", + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "Affinity", - "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

", - "smithy.api#xmlName": "affinity" + "aws.protocols#ec2QueryName": "PartitionNumber", + "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

", + "smithy.api#xmlName": "partitionNumber" } }, "HostResourceGroupArn": { @@ -36282,20 +37365,28 @@ "smithy.api#xmlName": "hostResourceGroupArn" } }, - "PartitionNumber": { - "target": "com.amazonaws.ec2#Integer", + "GroupName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PartitionNumber", - "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

", - "smithy.api#xmlName": "partitionNumber" + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group for the instance.

", + "smithy.api#xmlName": "groupName" } }, - "Tenancy": { - "target": "com.amazonaws.ec2#Tenancy", + "HostId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", - "smithy.api#xmlName": "tenancy" + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

", + "smithy.api#xmlName": "hostId" + } + }, + "Affinity": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

", + "smithy.api#xmlName": "affinity" } } }, @@ -36306,34 +37397,28 @@ "com.amazonaws.ec2#LaunchTemplatePlacementRequest": { "type": "structure", "members": { - "PartitionNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

" - } - }, "Tenancy": { "target": "com.amazonaws.ec2#Tenancy", "traits": { "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy \n \tof dedicated runs on single-tenant hardware.

" } }, - "SpreadDomain": { - "target": "com.amazonaws.ec2#String", + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", "traits": { - "smithy.api#documentation": "

Reserved for future use.

" + "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

" } }, - "HostResourceGroupArn": { - "target": "com.amazonaws.ec2#String", + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", "traits": { - "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances. If you specify a host \n\t\tresource group ARN, omit the Tenancy parameter \n\t\tor set it to host.

" + "smithy.api#documentation": "

The name of the placement group for the instance.

" } }, - "HostId": { - "target": "com.amazonaws.ec2#DedicatedHostId", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the Dedicated Host for the instance.

" + "smithy.api#documentation": "

The Availability Zone for the instance.

" } }, "Affinity": { @@ -36342,16 +37427,22 @@ "smithy.api#documentation": "

The affinity setting for an instance on a Dedicated Host.

" } }, - "AvailabilityZone": { + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.

" + } + }, + "SpreadDomain": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Availability Zone for the instance.

" + "smithy.api#documentation": "

Reserved for future use.

" } }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the placement group for the instance.

" + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances. If you specify a host \n\t\tresource group ARN, omit the Tenancy parameter \n\t\tor set it to host.

" } } }, @@ -36371,16 +37462,16 @@ "com.amazonaws.ec2#LaunchTemplateSpecification": { "type": "structure", "members": { - "Version": { + "LaunchTemplateName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The version number of the launch template.

\n

Default: The default version for the launch template.

" + "smithy.api#documentation": "

The name of the launch template.

" } }, - "LaunchTemplateName": { + "Version": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the launch template.

" + "smithy.api#documentation": "

The version number of the launch template.

\n

Default: The default version for the launch template.

" } }, "LaunchTemplateId": { @@ -36397,14 +37488,6 @@ "com.amazonaws.ec2#LaunchTemplateSpotMarketOptions": { "type": "structure", "members": { - "MaxPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MaxPrice", - "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances.

", - "smithy.api#xmlName": "maxPrice" - } - }, "InstanceInterruptionBehavior": { "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", "traits": { @@ -36413,6 +37496,14 @@ "smithy.api#xmlName": "instanceInterruptionBehavior" } }, + "MaxPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxPrice", + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances.

", + "smithy.api#xmlName": "maxPrice" + } + }, "BlockDurationMinutes": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -36421,14 +37512,6 @@ "smithy.api#xmlName": "blockDurationMinutes" } }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

", - "smithy.api#xmlName": "validUntil" - } - }, "SpotInstanceType": { "target": "com.amazonaws.ec2#SpotInstanceType", "traits": { @@ -36436,6 +37519,14 @@ "smithy.api#documentation": "

The Spot Instance request type.

", "smithy.api#xmlName": "spotInstanceType" } + }, + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

", + "smithy.api#xmlName": "validUntil" + } } }, "traits": { @@ -36445,16 +37536,16 @@ "com.amazonaws.ec2#LaunchTemplateSpotMarketOptionsRequest": { "type": "structure", "members": { - "SpotInstanceType": { - "target": "com.amazonaws.ec2#SpotInstanceType", + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The Spot Instance request type.

" + "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

" } }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "MaxPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances.

" } }, "ValidUntil": { @@ -36463,16 +37554,16 @@ "smithy.api#documentation": "

The end date of the request. \n For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. \n If the request is persistent, it remains active until it is canceled or this date and time is reached.\n The default end date is 7 days from the current date.

" } }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", "traits": { - "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

" + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" } }, - "MaxPrice": { - "target": "com.amazonaws.ec2#String", + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", "traits": { - "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances.

" + "smithy.api#documentation": "

The Spot Instance request type.

" } } }, @@ -36483,14 +37574,6 @@ "com.amazonaws.ec2#LaunchTemplateTagSpecification": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.ec2#ResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource.

", - "smithy.api#xmlName": "resourceType" - } - }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -36498,6 +37581,14 @@ "smithy.api#documentation": "

The tags for the resource.

", "smithy.api#xmlName": "tagSet" } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#ResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource.

", + "smithy.api#xmlName": "resourceType" + } } }, "traits": { @@ -36546,14 +37637,6 @@ "com.amazonaws.ec2#LaunchTemplateVersion": { "type": "structure", "members": { - "VersionDescription": { - "target": "com.amazonaws.ec2#VersionDescription", - "traits": { - "aws.protocols#ec2QueryName": "VersionDescription", - "smithy.api#documentation": "

The description for the version.

", - "smithy.api#xmlName": "versionDescription" - } - }, "VersionNumber": { "target": "com.amazonaws.ec2#Long", "traits": { @@ -36562,28 +37645,28 @@ "smithy.api#xmlName": "versionNumber" } }, - "DefaultVersion": { - "target": "com.amazonaws.ec2#Boolean", + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "aws.protocols#ec2QueryName": "DefaultVersion", - "smithy.api#documentation": "

Indicates whether the version is the default version.

", - "smithy.api#xmlName": "defaultVersion" + "aws.protocols#ec2QueryName": "LaunchTemplateName", + "smithy.api#documentation": "

The name of the launch template.

", + "smithy.api#xmlName": "launchTemplateName" } }, - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#String", + "VersionDescription": { + "target": "com.amazonaws.ec2#VersionDescription", "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

", - "smithy.api#xmlName": "launchTemplateId" + "aws.protocols#ec2QueryName": "VersionDescription", + "smithy.api#documentation": "

The description for the version.

", + "smithy.api#xmlName": "versionDescription" } }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", + "LaunchTemplateData": { + "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The time the version was created.

", - "smithy.api#xmlName": "createTime" + "aws.protocols#ec2QueryName": "LaunchTemplateData", + "smithy.api#documentation": "

Information about the launch template.

", + "smithy.api#xmlName": "launchTemplateData" } }, "CreatedBy": { @@ -36594,20 +37677,28 @@ "smithy.api#xmlName": "createdBy" } }, - "LaunchTemplateData": { - "target": "com.amazonaws.ec2#ResponseLaunchTemplateData", + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateData", - "smithy.api#documentation": "

Information about the launch template.

", - "smithy.api#xmlName": "launchTemplateData" + "aws.protocols#ec2QueryName": "LaunchTemplateId", + "smithy.api#documentation": "

The ID of the launch template.

", + "smithy.api#xmlName": "launchTemplateId" } }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", + "DefaultVersion": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

", - "smithy.api#xmlName": "launchTemplateName" + "aws.protocols#ec2QueryName": "DefaultVersion", + "smithy.api#documentation": "

Indicates whether the version is the default version.

", + "smithy.api#xmlName": "defaultVersion" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time the version was created.

", + "smithy.api#xmlName": "createTime" } } }, @@ -36767,14 +37858,6 @@ "com.amazonaws.ec2#LoadPermission": { "type": "structure", "members": { - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The AWS account ID.

", - "smithy.api#xmlName": "userId" - } - }, "Group": { "target": "com.amazonaws.ec2#PermissionGroup", "traits": { @@ -36782,6 +37865,14 @@ "smithy.api#documentation": "

The name of the group.

", "smithy.api#xmlName": "group" } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#xmlName": "userId" + } } }, "traits": { @@ -36809,16 +37900,16 @@ "com.amazonaws.ec2#LoadPermissionModifications": { "type": "structure", "members": { - "Remove": { + "Add": { "target": "com.amazonaws.ec2#LoadPermissionListRequest", "traits": { - "smithy.api#documentation": "

The load permissions to remove.

" + "smithy.api#documentation": "

The load permissions to add.

" } }, - "Add": { + "Remove": { "target": "com.amazonaws.ec2#LoadPermissionListRequest", "traits": { - "smithy.api#documentation": "

The load permissions to add.

" + "smithy.api#documentation": "

The load permissions to remove.

" } } }, @@ -36849,6 +37940,14 @@ "com.amazonaws.ec2#LocalGateway": { "type": "structure", "members": { + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, "State": { "target": "com.amazonaws.ec2#String", "traits": { @@ -36877,17 +37976,9 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account ID that owns the local gateway.

", + "smithy.api#documentation": "

The AWS account ID that owns the local gateway.

", "smithy.api#xmlName": "ownerId" } - }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" - } } }, "traits": { @@ -36918,12 +38009,28 @@ "com.amazonaws.ec2#LocalGatewayRoute": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#LocalGatewayRouteState", + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the route.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID that owns the local gateway route.

", + "smithy.api#xmlName": "ownerId" } }, "LocalGatewayRouteTableId": { @@ -36934,6 +38041,14 @@ "smithy.api#xmlName": "localGatewayRouteTableId" } }, + "State": { + "target": "com.amazonaws.ec2#LocalGatewayRouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route.

", + "smithy.api#xmlName": "state" + } + }, "Type": { "target": "com.amazonaws.ec2#LocalGatewayRouteType", "traits": { @@ -36942,20 +38057,12 @@ "smithy.api#xmlName": "type" } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The CIDR block used for destination matches.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", - "smithy.api#documentation": "

The ID of the virtual interface group.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" } } }, @@ -36997,12 +38104,12 @@ "com.amazonaws.ec2#LocalGatewayRouteTable": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the local gateway route table.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" } }, "LocalGatewayId": { @@ -37013,6 +38120,14 @@ "smithy.api#xmlName": "localGatewayId" } }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, "State": { "target": "com.amazonaws.ec2#String", "traits": { @@ -37029,12 +38144,20 @@ "smithy.api#xmlName": "localGatewayRouteTableId" } }, - "OutpostArn": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID that owns the local gateway route table.

", + "smithy.api#xmlName": "ownerId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the local gateway route table.

", + "smithy.api#xmlName": "tagSet" } } }, @@ -37063,6 +38186,14 @@ "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { "type": "structure", "members": { + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", + "smithy.api#documentation": "

The ID of the virtual interface group.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { "target": "com.amazonaws.ec2#LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", "traits": { @@ -37071,20 +38202,20 @@ "smithy.api#xmlName": "localGatewayRouteTableVirtualInterfaceGroupAssociationId" } }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "LocalGatewayRouteTableId": { + "target": "com.amazonaws.ec2#LocalGatewayId", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the association.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the local gateway route table.

", + "smithy.api#xmlName": "localGatewayRouteTableId" } }, "State": { @@ -37095,20 +38226,28 @@ "smithy.api#xmlName": "state" } }, - "LocalGatewayRouteTableId": { - "target": "com.amazonaws.ec2#LocalGatewayId", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the local gateway route table.

", - "smithy.api#xmlName": "localGatewayRouteTableId" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the association.

", + "smithy.api#xmlName": "tagSet" } }, - "LocalGatewayVirtualInterfaceGroupId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "LocalGatewayId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupId", - "smithy.api#documentation": "

The ID of the virtual interface group.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID that owns the local gateway virtual interface group association.

", + "smithy.api#xmlName": "ownerId" } } }, @@ -37140,14 +38279,6 @@ "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociation": { "type": "structure", "members": { - "LocalGatewayRouteTableVpcAssociationId": { - "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationId", - "smithy.api#documentation": "

The ID of the association.

", - "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationId" - } - }, "LocalGatewayRouteTableId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -37164,12 +38295,20 @@ "smithy.api#xmlName": "state" } }, - "VpcId": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID that owns the local gateway route table for the association.

", + "smithy.api#xmlName": "ownerId" + } + }, + "LocalGatewayRouteTableVpcAssociationId": { + "target": "com.amazonaws.ec2#LocalGatewayRouteTableVpcAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableVpcAssociationId", + "smithy.api#documentation": "

The ID of the association.

", + "smithy.api#xmlName": "localGatewayRouteTableVpcAssociationId" } }, "LocalGatewayId": { @@ -37187,6 +38326,22 @@ "smithy.api#documentation": "

The tags assigned to the association.

", "smithy.api#xmlName": "tagSet" } + }, + "LocalGatewayRouteTableArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayRouteTableArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the local gateway route table for the association.

", + "smithy.api#xmlName": "localGatewayRouteTableArn" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } } }, "traits": { @@ -37242,12 +38397,20 @@ "com.amazonaws.ec2#LocalGatewayVirtualInterface": { "type": "structure", "members": { - "Vlan": { - "target": "com.amazonaws.ec2#Integer", + "LocalGatewayVirtualInterfaceId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", "traits": { - "aws.protocols#ec2QueryName": "Vlan", - "smithy.api#documentation": "

The ID of the VLAN.

", - "smithy.api#xmlName": "vlan" + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceId", + "smithy.api#documentation": "

The ID of the virtual interface.

", + "smithy.api#xmlName": "localGatewayVirtualInterfaceId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the virtual interface.

", + "smithy.api#xmlName": "tagSet" } }, "LocalBgpAsn": { @@ -37266,14 +38429,6 @@ "smithy.api#xmlName": "localGatewayId" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the virtual interface.

", - "smithy.api#xmlName": "tagSet" - } - }, "PeerBgpAsn": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -37282,6 +38437,14 @@ "smithy.api#xmlName": "peerBgpAsn" } }, + "LocalAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalAddress", + "smithy.api#documentation": "

The local address.

", + "smithy.api#xmlName": "localAddress" + } + }, "PeerAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -37290,20 +38453,20 @@ "smithy.api#xmlName": "peerAddress" } }, - "LocalAddress": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LocalAddress", - "smithy.api#documentation": "

The local address.

", - "smithy.api#xmlName": "localAddress" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID that owns the local gateway virtual interface.

", + "smithy.api#xmlName": "ownerId" } }, - "LocalGatewayVirtualInterfaceId": { - "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", + "Vlan": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceId", - "smithy.api#documentation": "

The ID of the virtual interface.

", - "smithy.api#xmlName": "localGatewayVirtualInterfaceId" + "aws.protocols#ec2QueryName": "Vlan", + "smithy.api#documentation": "

The ID of the VLAN.

", + "smithy.api#xmlName": "vlan" } } }, @@ -37322,6 +38485,22 @@ "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" } }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the virtual interface group.

", + "smithy.api#xmlName": "tagSet" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID that owns the local gateway virtual interface group.

", + "smithy.api#xmlName": "ownerId" + } + }, "LocalGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -37337,14 +38516,6 @@ "smithy.api#documentation": "

The IDs of the virtual interfaces.

", "smithy.api#xmlName": "localGatewayVirtualInterfaceIdSet" } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the virtual interface group.

", - "smithy.api#xmlName": "tagSet" - } } }, "traits": { @@ -37431,14 +38602,6 @@ "com.amazonaws.ec2#ManagedPrefixList": { "type": "structure", "members": { - "StateMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StateMessage", - "smithy.api#documentation": "

The state message.

", - "smithy.api#xmlName": "stateMessage" - } - }, "PrefixListId": { "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { @@ -37455,28 +38618,12 @@ "smithy.api#xmlName": "ownerId" } }, - "PrefixListName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListName", - "smithy.api#documentation": "

The name of the prefix list.

", - "smithy.api#xmlName": "prefixListName" - } - }, - "PrefixListArn": { - "target": "com.amazonaws.ec2#ResourceArn", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the prefix list.

", - "smithy.api#xmlName": "prefixListArn" - } - }, - "MaxEntries": { - "target": "com.amazonaws.ec2#Integer", + "State": { + "target": "com.amazonaws.ec2#PrefixListState", "traits": { - "aws.protocols#ec2QueryName": "MaxEntries", - "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", - "smithy.api#xmlName": "maxEntries" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the prefix list.

", + "smithy.api#xmlName": "state" } }, "Tags": { @@ -37503,12 +38650,36 @@ "smithy.api#xmlName": "version" } }, - "State": { - "target": "com.amazonaws.ec2#PrefixListState", + "PrefixListArn": { + "target": "com.amazonaws.ec2#ResourceArn", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the prefix list.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "PrefixListArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the prefix list.

", + "smithy.api#xmlName": "prefixListArn" + } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxEntries", + "smithy.api#documentation": "

The maximum number of entries for the prefix list.

", + "smithy.api#xmlName": "maxEntries" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "

The state message.

", + "smithy.api#xmlName": "stateMessage" + } + }, + "PrefixListName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListName", + "smithy.api#documentation": "

The name of the prefix list.

", + "smithy.api#xmlName": "prefixListName" } } }, @@ -37624,16 +38795,23 @@ "target": "com.amazonaws.ec2#ModifyAvailabilityZoneGroupResult" }, "traits": { - "smithy.api#documentation": "

Enables or disables an Availability Zone group for your account.

\n

Use \n \t\tDescribeAvailabilityZones to view the value for GroupName.

" + "smithy.api#documentation": "

Changes the opt-in status of the Local Zone and Wavelength Zone group for your\n account.

\n

Use \n \t\tDescribeAvailabilityZones to view the value for GroupName.

" } }, "com.amazonaws.ec2#ModifyAvailabilityZoneGroupRequest": { "type": "structure", "members": { + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone group, Local Zone group, or Wavelength Zone\n group.

", + "smithy.api#required": {} + } + }, "OptInStatus": { "target": "com.amazonaws.ec2#ModifyAvailabilityZoneOptInStatus", "traits": { - "smithy.api#documentation": "

Indicates whether to enable or disable membership. The valid values are\n opted-in. You must contact AWS Support to disable an Availability Zone group.

", + "smithy.api#documentation": "

Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The\n only valid value is opted-in. You must contact AWS Support to opt out of a Local Zone group, or Wavelength Zone group.

", "smithy.api#required": {} } }, @@ -37642,13 +38820,6 @@ "traits": { "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.

" } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone Group.

", - "smithy.api#required": {} - } } } }, @@ -37693,22 +38864,23 @@ "com.amazonaws.ec2#ModifyCapacityReservationRequest": { "type": "structure", "members": { - "EndDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n\t\t

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

\n\t\t

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", "traits": { - "smithy.api#documentation": "

The number of instances for which to reserve capacity.

" + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n\t\t

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

\n\t\t

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

" } }, "EndDateType": { @@ -37717,11 +38889,10 @@ "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n\t\t " } }, - "CapacityReservationId": { - "target": "com.amazonaws.ec2#CapacityReservationId", + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The ID of the Capacity Reservation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

" } } } @@ -37754,41 +38925,35 @@ "com.amazonaws.ec2#ModifyClientVpnEndpointRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, "VpnPort": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n\t

Valid Values: 443 | 1194\n

\n\t

Default Value: 443\n

" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network.

", - "smithy.api#xmlName": "SecurityGroupId" + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, - "Description": { + "ServerCertificateArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" + "smithy.api#documentation": "

The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).

" } }, - "ConnectionLogOptions": { - "target": "com.amazonaws.ec2#ConnectionLogOptions", + "ClientVpnEndpointId": { + "target": "com.amazonaws.ec2#ClientVpnEndpointId", "traits": { - "smithy.api#documentation": "

Information about the client connection logging options.

\n\t\t

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n\t\t " + "smithy.api#documentation": "

The ID of the Client VPN endpoint to modify.

", + "smithy.api#required": {} } }, - "ServerCertificateArn": { - "target": "com.amazonaws.ec2#String", + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", "traits": { - "smithy.api#documentation": "

The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).

" + "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint.

" } }, "DnsServers": { @@ -37803,17 +38968,23 @@ "smithy.api#documentation": "

Indicates whether the VPN is split-tunnel.

\n

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS\n Client VPN Administrator Guide.

" } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", + "ConnectionLogOptions": { + "target": "com.amazonaws.ec2#ConnectionLogOptions", "traits": { - "smithy.api#documentation": "

The ID of the VPC to associate with the Client VPN endpoint.

" + "smithy.api#documentation": "

Information about the client connection logging options.

\n\t\t

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n\t\t " } }, - "ClientVpnEndpointId": { - "target": "com.amazonaws.ec2#ClientVpnEndpointId", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the Client VPN endpoint to modify.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A brief description of the Client VPN endpoint.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ClientVpnSecurityGroupIdSet", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups to apply to the target network.

", + "smithy.api#xmlName": "SecurityGroupId" } } } @@ -37939,12 +39110,6 @@ "com.amazonaws.ec2#ModifyFleetRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "FleetId": { "target": "com.amazonaws.ec2#FleetId", "traits": { @@ -37952,18 +39117,31 @@ "smithy.api#required": {} } }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", - "traits": { - "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

" - } - }, "TargetCapacitySpecification": { "target": "com.amazonaws.ec2#TargetCapacitySpecificationRequest", "traits": { "smithy.api#documentation": "

The size of the EC2 Fleet.

", "smithy.api#required": {} } + }, + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#FleetLaunchTemplateConfigListRequest", + "traits": { + "smithy.api#documentation": "

The launch template and overrides.

", + "smithy.api#xmlName": "LaunchTemplateConfig" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#FleetExcessCapacityTerminationPolicy", + "traits": { + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the total target capacity of\n the EC2 Fleet is decreased below the current size of the EC2 Fleet.

" + } } } }, @@ -37995,18 +39173,10 @@ "com.amazonaws.ec2#ModifyFpgaImageAttributeRequest": { "type": "structure", "members": { - "UserGroups": { - "target": "com.amazonaws.ec2#UserGroupStringList", - "traits": { - "smithy.api#documentation": "

The user groups. This parameter is valid only when modifying the loadPermission attribute.

", - "smithy.api#xmlName": "UserGroup" - } - }, - "FpgaImageId": { - "target": "com.amazonaws.ec2#FpgaImageId", + "Attribute": { + "target": "com.amazonaws.ec2#FpgaImageAttributeName", "traits": { - "smithy.api#documentation": "

The ID of the AFI.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the attribute.

" } }, "ProductCodes": { @@ -38016,28 +39186,31 @@ "smithy.api#xmlName": "ProductCode" } }, - "Attribute": { - "target": "com.amazonaws.ec2#FpgaImageAttributeName", + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", "traits": { - "smithy.api#documentation": "

The name of the attribute.

" + "smithy.api#documentation": "

The ID of the AFI.

", + "smithy.api#required": {} } }, - "Description": { + "Name": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A description for the AFI.

" + "smithy.api#documentation": "

A name for the AFI.

" } }, - "LoadPermission": { - "target": "com.amazonaws.ec2#LoadPermissionModifications", + "UserGroups": { + "target": "com.amazonaws.ec2#UserGroupStringList", "traits": { - "smithy.api#documentation": "

The load permission for the AFI.

" + "smithy.api#documentation": "

The user groups. This parameter is valid only when modifying the loadPermission attribute.

", + "smithy.api#xmlName": "UserGroup" } }, - "Name": { - "target": "com.amazonaws.ec2#String", + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", "traits": { - "smithy.api#documentation": "

A name for the AFI.

" + "smithy.api#documentation": "

The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.

", + "smithy.api#xmlName": "UserId" } }, "OperationType": { @@ -38046,17 +39219,22 @@ "smithy.api#documentation": "

The operation type.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

A description for the AFI.

" } }, - "UserIds": { - "target": "com.amazonaws.ec2#UserIdStringList", + "LoadPermission": { + "target": "com.amazonaws.ec2#LoadPermissionModifications", "traits": { - "smithy.api#documentation": "

The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.

", - "smithy.api#xmlName": "UserId" + "smithy.api#documentation": "

The load permission for the AFI.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" } } } @@ -38089,24 +39267,27 @@ "com.amazonaws.ec2#ModifyHostsRequest": { "type": "structure", "members": { - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", - "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Specify whether to enable or disable auto-placement.

", - "smithy.api#xmlName": "autoPlacement" - } - }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Host. Specify this parameter\n\t\t\tto modify a Dedicated Host to support multiple instance types within its current\n\t\t\tinstance family.

\n\t\t\n\t\t

If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter \n\t\t\tand specify InstanceType instead. You cannot specify \n\t\t\tInstanceFamily and InstanceType \n\t\t\tin the same request.

" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", "traits": { - "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to\n\t\t\tmodify a Dedicated Host to support only a specific instance type.

\n\t\t\n\t\t

If you want to modify a Dedicated Host to support multiple instance types in its current instance \n\t\t\tfamily, omit this parameter and specify InstanceFamily \n\t\t\tinstead. You cannot specify InstanceType and\n\t\t\tInstanceFamily in the same request.

" + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "hostId" + } + }, + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Specify whether to enable or disable auto-placement.

", + "smithy.api#xmlName": "autoPlacement" } }, "HostRecovery": { @@ -38115,13 +39296,10 @@ "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, \n\t\t\tsee \n\t\t\t\tHost Recovery in the Amazon Elastic Compute Cloud User Guide.

" } }, - "HostIds": { - "target": "com.amazonaws.ec2#RequestHostIdList", + "InstanceType": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts to modify.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "hostId" + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to\n\t\t\tmodify a Dedicated Host to support only a specific instance type.

\n\t\t\n\t\t

If you want to modify a Dedicated Host to support multiple instance types in its current instance \n\t\t\tfamily, omit this parameter and specify InstanceFamily \n\t\t\tinstead. You cannot specify InstanceType and\n\t\t\tInstanceFamily in the same request.

" } } } @@ -38187,15 +39365,6 @@ "com.amazonaws.ec2#ModifyIdentityIdFormatRequest": { "type": "structure", "members": { - "UseLongIds": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "UseLongIds", - "smithy.api#documentation": "

Indicates whether the resource should use longer IDs (17-character IDs)

", - "smithy.api#required": {}, - "smithy.api#xmlName": "useLongIds" - } - }, "Resource": { "target": "com.amazonaws.ec2#String", "traits": { @@ -38213,6 +39382,15 @@ "smithy.api#required": {}, "smithy.api#xmlName": "principalArn" } + }, + "UseLongIds": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "UseLongIds", + "smithy.api#documentation": "

Indicates whether the resource should use longer IDs (17-character IDs)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "useLongIds" + } } } }, @@ -38228,31 +39406,20 @@ "com.amazonaws.ec2#ModifyImageAttributeRequest": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The value of the attribute being modified. \n This parameter can be used only when the Attribute parameter is description or productCodes.

" - } - }, - "OperationType": { - "target": "com.amazonaws.ec2#OperationType", - "traits": { - "smithy.api#documentation": "

The operation type. \n This parameter can be used only when the Attribute parameter is launchPermission.

" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#required": {} - } - }, "Description": { "target": "com.amazonaws.ec2#AttributeValue", "traits": { "smithy.api#documentation": "

A new description for the AMI.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "ProductCodes": { "target": "com.amazonaws.ec2#ProductCodeStringList", "traits": { @@ -38260,18 +39427,11 @@ "smithy.api#xmlName": "ProductCode" } }, - "Attribute": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the attribute to modify. \n The valid values are description, launchPermission, and productCodes.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

The AWS account IDs. \n This parameter can be used only when the Attribute parameter is launchPermission.

", + "smithy.api#xmlName": "UserId" } }, "UserGroups": { @@ -38287,11 +39447,29 @@ "smithy.api#documentation": "

A new launch permission for the AMI.

" } }, - "UserIds": { - "target": "com.amazonaws.ec2#UserIdStringList", + "Attribute": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The AWS account IDs. \n This parameter can be used only when the Attribute parameter is launchPermission.

", - "smithy.api#xmlName": "UserId" + "smithy.api#documentation": "

The name of the attribute to modify. \n The valid values are description, launchPermission, and productCodes.

" + } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The operation type. \n This parameter can be used only when the Attribute parameter is launchPermission.

" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The value of the attribute being modified. \n This parameter can be used only when the Attribute parameter is description or productCodes.

" } } }, @@ -38311,36 +39489,12 @@ "com.amazonaws.ec2#ModifyInstanceAttributeRequest": { "type": "structure", "members": { - "InstanceType": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

Changes the instance type to the specified value. For more information, see Instance\n types. If the instance type is not valid, the error returned is\n InvalidInstanceAttributeValue.

", - "smithy.api#xmlName": "instanceType" - } - }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

A new value for the attribute. Use only with the kernel,\n ramdisk, userData, disableApiTermination, or\n instanceInitiatedShutdownBehavior attribute.

", - "smithy.api#xmlName": "value" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#AttributeValue", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Specifies whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Updating the block device mapping when launching an instance in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "blockDeviceMapping" } }, "Ramdisk": { @@ -38351,37 +39505,19 @@ "smithy.api#xmlName": "ramdisk" } }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If the value is true, you can't terminate the instance using the Amazon\n EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot\n Instances.

", - "smithy.api#xmlName": "disableApiTermination" - } - }, - "Kernel": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "Kernel", - "smithy.api#documentation": "

Changes the instance's kernel to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", - "smithy.api#xmlName": "kernel" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" + "smithy.api#documentation": "

[EC2-VPC] Changes the security groups of the instance. You must specify at least one\n security group, even if it's just the default security group for the VPC. You must\n specify the security group ID, not the security group name.

", + "smithy.api#xmlName": "GroupId" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Updating the block device mapping when launching an instance in the\n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "blockDeviceMapping" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, "EnaSupport": { @@ -38392,11 +39528,20 @@ "smithy.api#xmlName": "enaSupport" } }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdStringList", + "EbsOptimized": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "

[EC2-VPC] Changes the security groups of the instance. You must specify at least one\n security group, even if it's just the default security group for the VPC. You must\n specify the security group ID, not the security group name.

", - "smithy.api#xmlName": "GroupId" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal EBS I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#documentation": "

The name of the attribute.

", + "smithy.api#xmlName": "attribute" } }, "UserData": { @@ -38407,20 +39552,28 @@ "smithy.api#xmlName": "userData" } }, - "Attribute": { - "target": "com.amazonaws.ec2#InstanceAttributeName", + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "

The name of the attribute.

", - "smithy.api#xmlName": "attribute" + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Specifies whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

Changes the instance type to the specified value. For more information, see Instance\n types. If the instance type is not valid, the error returned is\n InvalidInstanceAttributeValue.

", + "smithy.api#xmlName": "instanceType" } }, "SourceDestCheck": { @@ -38429,12 +39582,37 @@ "smithy.api#documentation": "

Specifies whether source/destination checking is enabled. A value of true\n means that checking is enabled, and false means that checking is disabled.\n This value must be false for a NAT instance to perform NAT.

" } }, - "EbsOptimized": { + "DisableApiTermination": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal EBS I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", - "smithy.api#xmlName": "ebsOptimized" + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If the value is true, you can't terminate the instance using the Amazon\n EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot\n Instances.

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" + } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

A new value for the attribute. Use only with the kernel,\n ramdisk, userData, disableApiTermination, or\n instanceInitiatedShutdownBehavior attribute.

", + "smithy.api#xmlName": "value" + } + }, + "Kernel": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Kernel", + "smithy.api#documentation": "

Changes the instance's kernel to the specified value. We recommend that you use\n PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "smithy.api#xmlName": "kernel" } } } @@ -38454,11 +39632,10 @@ "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributesRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the instance to be modified.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "CapacityReservationSpecification": { @@ -38468,10 +39645,11 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

The ID of the instance to be modified.

", + "smithy.api#required": {} } } } @@ -38504,10 +39682,10 @@ "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring\n Idempotency.

" + "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.

" } }, "InstanceCreditSpecifications": { @@ -38518,10 +39696,10 @@ "smithy.api#xmlName": "InstanceCreditSpecification" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

A unique, case-sensitive token that you provide to ensure idempotency of your\n modification request. For more information, see Ensuring\n Idempotency.

" } } } @@ -38562,19 +39740,6 @@ "com.amazonaws.ec2#ModifyInstanceEventStartTimeRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the instance with the scheduled event.

", - "smithy.api#required": {} - } - }, "NotBefore": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -38582,12 +39747,25 @@ "smithy.api#required": {} } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "InstanceEventId": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The ID of the event whose date and time you are modifying.

", "smithy.api#required": {} } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance with the scheduled event.

", + "smithy.api#required": {} + } } } }, @@ -38618,18 +39796,6 @@ "com.amazonaws.ec2#ModifyInstanceMetadataOptionsRequest": { "type": "structure", "members": { - "HttpEndpoint": { - "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", - "traits": { - "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the existing state is maintained.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n " - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, "HttpTokens": { "target": "com.amazonaws.ec2#HttpTokensState", "traits": { @@ -38648,20 +39814,24 @@ "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the existing state is maintained.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n " + } } } }, "com.amazonaws.ec2#ModifyInstanceMetadataOptionsResult": { "type": "structure", "members": { - "InstanceMetadataOptions": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", - "traits": { - "aws.protocols#ec2QueryName": "InstanceMetadataOptions", - "smithy.api#documentation": "

The metadata options for the instance.

", - "smithy.api#xmlName": "instanceMetadataOptions" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -38669,6 +39839,14 @@ "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#xmlName": "instanceId" } + }, + "InstanceMetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsResponse", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance.

", + "smithy.api#xmlName": "instanceMetadataOptions" + } } } }, @@ -38687,6 +39865,14 @@ "com.amazonaws.ec2#ModifyInstancePlacementRequest": { "type": "structure", "members": { + "Tenancy": { + "target": "com.amazonaws.ec2#HostTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy for the instance.

", + "smithy.api#xmlName": "tenancy" + } + }, "Affinity": { "target": "com.amazonaws.ec2#Affinity", "traits": { @@ -38695,27 +39881,27 @@ "smithy.api#xmlName": "affinity" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance that you are modifying.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host with which to associate the instance.

", + "smithy.api#xmlName": "hostId" } }, - "GroupName": { - "target": "com.amazonaws.ec2#PlacementGroupName", + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string\n (\"\").

" + "smithy.api#documentation": "

The ARN of the host resource group in which to place the instance.

" } }, - "Tenancy": { - "target": "com.amazonaws.ec2#HostTenancy", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy for the instance.

", - "smithy.api#xmlName": "tenancy" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance that you are modifying.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" } }, "PartitionNumber": { @@ -38724,18 +39910,10 @@ "smithy.api#documentation": "

Reserved for future use.

" } }, - "HostResourceGroupArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The ARN of the host resource group in which to place the instance.

" - } - }, - "HostId": { - "target": "com.amazonaws.ec2#DedicatedHostId", + "GroupName": { + "target": "com.amazonaws.ec2#PlacementGroupName", "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host with which to associate the instance.

", - "smithy.api#xmlName": "hostId" + "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string\n (\"\").

" } } } @@ -38768,16 +39946,16 @@ "com.amazonaws.ec2#ModifyLaunchTemplateRequest": { "type": "structure", "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.ec2#LaunchTemplateId", + "LaunchTemplateName": { + "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" + "smithy.api#documentation": "

The name of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" } }, "DefaultVersion": { @@ -38787,16 +39965,16 @@ "smithy.api#xmlName": "SetDefaultVersion" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "LaunchTemplateId": { + "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + "smithy.api#documentation": "

The ID of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" } }, - "LaunchTemplateName": { - "target": "com.amazonaws.ec2#LaunchTemplateName", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The name of the launch template. You must specify either the launch template ID or\n launch template name in the request.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } } } @@ -38836,17 +40014,11 @@ "smithy.api#xmlName": "AddEntry" } }, - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} - } - }, - "CurrentVersion": { - "target": "com.amazonaws.ec2#Long", + "RemoveEntries": { + "target": "com.amazonaws.ec2#RemovePrefixListEntries", "traits": { - "smithy.api#documentation": "

The current version of the prefix list.

" + "smithy.api#documentation": "

One or more entries to remove from the prefix list.

", + "smithy.api#xmlName": "RemoveEntry" } }, "DryRun": { @@ -38855,17 +40027,23 @@ "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.

" } }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, "PrefixListName": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

A name for the prefix list.

" } }, - "RemoveEntries": { - "target": "com.amazonaws.ec2#RemovePrefixListEntries", + "CurrentVersion": { + "target": "com.amazonaws.ec2#Long", "traits": { - "smithy.api#documentation": "

One or more entries to remove from the prefix list.

", - "smithy.api#xmlName": "RemoveEntry" + "smithy.api#documentation": "

The current version of the prefix list.

" } } } @@ -38895,14 +40073,6 @@ "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest": { "type": "structure", "members": { - "SourceDestCheck": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.\n A value of true means checking\n is enabled, and false means checking is disabled. This value\n must be false for a NAT instance to perform NAT. For more\n information, see NAT\n Instances in the Amazon Virtual Private Cloud User Guide.

", - "smithy.api#xmlName": "sourceDestCheck" - } - }, "Groups": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { @@ -38926,14 +40096,6 @@ "smithy.api#xmlName": "attachment" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -38942,6 +40104,22 @@ "smithy.api#required": {}, "smithy.api#xmlName": "networkInterfaceId" } + }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

Indicates whether source/destination checking is enabled.\n A value of true means checking\n is enabled, and false means checking is disabled. This value\n must be false for a NAT instance to perform NAT. For more\n information, see NAT\n Instances in the Amazon Virtual Private Cloud User Guide.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } }, "traits": { @@ -38963,14 +40141,6 @@ "com.amazonaws.ec2#ModifyReservedInstancesRequest": { "type": "structure", "members": { - "TargetConfigurations": { - "target": "com.amazonaws.ec2#ReservedInstancesConfigurationList", - "traits": { - "smithy.api#documentation": "

The configuration settings for the Reserved Instances to modify.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ReservedInstancesConfigurationSetItemType" - } - }, "ReservedInstancesIds": { "target": "com.amazonaws.ec2#ReservedInstancesIdStringList", "traits": { @@ -38986,6 +40156,14 @@ "smithy.api#documentation": "

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see \n \t\tEnsuring Idempotency.

", "smithy.api#xmlName": "clientToken" } + }, + "TargetConfigurations": { + "target": "com.amazonaws.ec2#ReservedInstancesConfigurationList", + "traits": { + "smithy.api#documentation": "

The configuration settings for the Reserved Instances to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ReservedInstancesConfigurationSetItemType" + } } }, "traits": { @@ -39014,17 +40192,17 @@ "target": "com.amazonaws.ec2#ModifySnapshotAttributeRequest" }, "traits": { - "smithy.api#documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

\n

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made\n public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

\n

For more information about modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

\n

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made\n public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

\n

For more information about modifying snapshot permissions, see Sharing snapshots in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#ModifySnapshotAttributeRequest": { "type": "structure", "members": { - "UserIds": { - "target": "com.amazonaws.ec2#UserIdStringList", + "GroupNames": { + "target": "com.amazonaws.ec2#GroupNameStringList", "traits": { - "smithy.api#documentation": "

The account ID to modify for the snapshot.

", - "smithy.api#xmlName": "UserId" + "smithy.api#documentation": "

The group to modify for the snapshot.

", + "smithy.api#xmlName": "UserGroup" } }, "SnapshotId": { @@ -39034,29 +40212,17 @@ "smithy.api#required": {} } }, - "OperationType": { - "target": "com.amazonaws.ec2#OperationType", - "traits": { - "smithy.api#documentation": "

The type of operation to perform to the attribute.

" - } - }, "Attribute": { "target": "com.amazonaws.ec2#SnapshotAttributeName", "traits": { "smithy.api#documentation": "

The snapshot attribute to modify. Only volume creation permissions can be modified.

" } }, - "CreateVolumePermission": { - "target": "com.amazonaws.ec2#CreateVolumePermissionModifications", - "traits": { - "smithy.api#documentation": "

A JSON representation of the snapshot attribute modification.

" - } - }, - "GroupNames": { - "target": "com.amazonaws.ec2#GroupNameStringList", + "UserIds": { + "target": "com.amazonaws.ec2#UserIdStringList", "traits": { - "smithy.api#documentation": "

The group to modify for the snapshot.

", - "smithy.api#xmlName": "UserGroup" + "smithy.api#documentation": "

The account ID to modify for the snapshot.

", + "smithy.api#xmlName": "UserId" } }, "DryRun": { @@ -39066,6 +40232,18 @@ "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" } + }, + "OperationType": { + "target": "com.amazonaws.ec2#OperationType", + "traits": { + "smithy.api#documentation": "

The type of operation to perform to the attribute.

" + } + }, + "CreateVolumePermission": { + "target": "com.amazonaws.ec2#CreateVolumePermissionModifications", + "traits": { + "smithy.api#documentation": "

A JSON representation of the snapshot attribute modification.

" + } } } }, @@ -39093,6 +40271,14 @@ "smithy.api#xmlName": "spotFleetRequestId" } }, + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", + "traits": { + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" + } + }, "TargetCapacity": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -39101,18 +40287,17 @@ "smithy.api#xmlName": "targetCapacity" } }, - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#LaunchTemplateConfigList", "traits": { - "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

" + "smithy.api#documentation": "

The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.

", + "smithy.api#xmlName": "LaunchTemplateConfig" } }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

", - "smithy.api#xmlName": "excessCapacityTerminationPolicy" + "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

" } } }, @@ -39148,37 +40333,37 @@ "com.amazonaws.ec2#ModifySubnetAttributeRequest": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "subnetId" - } - }, "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.ec2#CoipPoolId", "traits": { "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

\n

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

" } }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a public IPv4 address.

" + } + }, "AssignIpv6AddressOnCreation": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { "smithy.api#documentation": "

Specify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).

\n

If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.

" } }, - "MapCustomerOwnedIpOnLaunch": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", "traits": { - "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.

\n

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" } }, - "MapPublicIpOnLaunch": { + "MapCustomerOwnedIpOnLaunch": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a public IPv4 address.

" + "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.

\n

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

" } } } @@ -39198,6 +40383,19 @@ "com.amazonaws.ec2#ModifyTrafficMirrorFilterNetworkServicesRequest": { "type": "structure", "members": { + "RemoveNetworkServices": { + "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", + "traits": { + "smithy.api#documentation": "

The network service, for example Amazon DNS, that you no longer want to mirror.

", + "smithy.api#xmlName": "RemoveNetworkService" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TrafficMirrorFilterId": { "target": "com.amazonaws.ec2#TrafficMirrorFilterId", "traits": { @@ -39211,19 +40409,6 @@ "smithy.api#documentation": "

The network service, for example Amazon DNS, that you want to mirror.

", "smithy.api#xmlName": "AddNetworkService" } - }, - "RemoveNetworkServices": { - "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", - "traits": { - "smithy.api#documentation": "

The network service, for example Amazon DNS, that you no longer want to mirror.

", - "smithy.api#xmlName": "RemoveNetworkService" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -39255,16 +40440,10 @@ "com.amazonaws.ec2#ModifyTrafficMirrorFilterRuleRequest": { "type": "structure", "members": { - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

" - } - }, - "Protocol": { - "target": "com.amazonaws.ec2#Integer", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The protocol, for example TCP, to assign to the Traffic Mirror rule.

" + "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

" } }, "SourceCidrBlock": { @@ -39273,10 +40452,10 @@ "smithy.api#documentation": "

The source CIDR block to assign to the Traffic Mirror rule.

" } }, - "TrafficDirection": { - "target": "com.amazonaws.ec2#TrafficDirection", + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The type of traffic (ingress | egress) to assign to the rule.

" + "smithy.api#documentation": "

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given\n direction. The rules are processed in ascending order by rule number.

" } }, "Description": { @@ -39291,10 +40470,16 @@ "smithy.api#documentation": "

The action to assign to the rule.

" } }, - "DestinationPortRange": { + "SourcePortRange": { "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", "traits": { - "smithy.api#documentation": "

The destination ports that are associated with the Traffic Mirror rule.

" + "smithy.api#documentation": "

The port range to assign to the Traffic Mirror rule.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" } }, "TrafficMirrorFilterRuleId": { @@ -39304,29 +40489,29 @@ "smithy.api#required": {} } }, - "SourcePortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", + "RemoveFields": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList", "traits": { - "smithy.api#documentation": "

The port range to assign to the Traffic Mirror rule.

" + "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror filter rule.

\n

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

", + "smithy.api#xmlName": "RemoveField" } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "DestinationPortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRangeRequest", "traits": { - "smithy.api#documentation": "

The destination CIDR block to assign to the Traffic Mirror rule.

" + "smithy.api#documentation": "

The destination ports that are associated with the Traffic Mirror rule.

" } }, - "RemoveFields": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleFieldList", + "Protocol": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The properties that you want to remove from the Traffic Mirror filter rule.

\n

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

", - "smithy.api#xmlName": "RemoveField" + "smithy.api#documentation": "

The protocol, for example TCP, to assign to the Traffic Mirror rule.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", "traits": { - "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#documentation": "

The type of traffic (ingress | egress) to assign to the rule.

" } } } @@ -39359,12 +40544,6 @@ "com.amazonaws.ec2#ModifyTrafficMirrorSessionRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The description to assign to the Traffic Mirror session.

" - } - }, "RemoveFields": { "target": "com.amazonaws.ec2#TrafficMirrorSessionFieldList", "traits": { @@ -39372,29 +40551,22 @@ "smithy.api#xmlName": "RemoveField" } }, - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#TrafficMirrorTargetId", - "traits": { - "smithy.api#documentation": "

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

" - } - }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

" + "smithy.api#documentation": "

The virtual network ID of the Traffic Mirror session.

" } }, - "TrafficMirrorSessionId": { - "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#TrafficMirrorTargetId", "traits": { - "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

" } }, - "PacketLength": { - "target": "com.amazonaws.ec2#Integer", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

" + "smithy.api#documentation": "

The description to assign to the Traffic Mirror session.

" } }, "SessionNumber": { @@ -39409,10 +40581,23 @@ "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.

" } }, - "VirtualNetworkId": { + "PacketLength": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The virtual network ID of the Traffic Mirror session.

" + "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

" + } + }, + "TrafficMirrorSessionId": { + "target": "com.amazonaws.ec2#TrafficMirrorSessionId", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror session.

", + "smithy.api#required": {} + } + }, + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterId", + "traits": { + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

" } } } @@ -39430,34 +40615,187 @@ } } }, - "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment": { + "com.amazonaws.ec2#ModifyTransitGateway": { "type": "operation", "input": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest" + "target": "com.amazonaws.ec2#ModifyTransitGatewayRequest" }, "output": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult" + "target": "com.amazonaws.ec2#ModifyTransitGatewayResult" }, "traits": { - "smithy.api#documentation": "

Modifies the specified VPC attachment.

" + "smithy.api#documentation": "

Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.

" } }, - "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest": { + "com.amazonaws.ec2#ModifyTransitGatewayOptions": { + "type": "structure", + "members": { + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the default propagation route table.

" + } + }, + "AssociationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the default association route table.

" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic association with the default association route table.

" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table.

" + } + }, + "DnsSupport": { + "target": "com.amazonaws.ec2#DnsSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable DNS support.

" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests.

" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The transit gateway options.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceRequest": { "type": "structure", "members": { + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#required": {} + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to drop traffic that matches this route.

" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { - "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#documentation": "

The ID of the attachment to which traffic is routed.

" + } + } + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayPrefixListReferenceResult": { + "type": "structure", + "members": { + "TransitGatewayPrefixListReference": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReference", + "smithy.api#documentation": "

Information about the prefix list reference.

", + "smithy.api#xmlName": "transitGatewayPrefixListReference" + } + } + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.

", "smithy.api#required": {} } }, - "Options": { - "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The new VPC attachment options.

\n \n

You cannot modify the IPv6 options.

\n " + "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.

" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The description for the transit gateway.

" } }, + "Options": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayOptions", + "traits": { + "smithy.api#documentation": "

The options to modify.

" + } + } + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayResult": { + "type": "structure", + "members": { + "TransitGateway": { + "target": "com.amazonaws.ec2#TransitGateway", + "traits": { + "aws.protocols#ec2QueryName": "TransitGateway", + "smithy.api#xmlName": "transitGateway" + } + } + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified VPC attachment.

" + } + }, + "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequest": { + "type": "structure", + "members": { "AddSubnetIds": { "target": "com.amazonaws.ec2#TransitGatewaySubnetIdList", "traits": { @@ -39475,6 +40813,19 @@ "traits": { "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.

" } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions", + "traits": { + "smithy.api#documentation": "

The new VPC attachment options.

\n \n

You cannot modify the IPv6 options.

\n " + } } } }, @@ -39520,7 +40871,7 @@ "target": "com.amazonaws.ec2#ModifyVolumeResult" }, "traits": { - "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you may be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or\n Type of an EBS Volume on Linux. For more information about modifying an EBS volume\n running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For information about\n extending a Linux file system, see Extending a Linux\n File System. For information about extending a Windows file system, see Extending a\n Windows File System.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitoring Volume\n Modifications.

\n

With previous-generation instance types, resizing an EBS volume may require detaching and\n reattaching the volume or stopping and restarting the instance. For more information, see\n Modifying the Size,\n IOPS, or Type of an EBS Volume on Linux and Modifying the Size, IOPS, or Type of an EBS\n Volume on Windows.

\n

If you reach the maximum volume modification rate per volume limit, you will need to wait\n at least six hours before applying further modifications to the affected EBS volume.

" + "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you may be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying an EBS volume running Linux, see Modifying the size, IOPS, or\n type of an EBS volume on Linux. For more information about modifying an EBS volume\n running Windows, see Modifying the size, IOPS, or type of an EBS volume on Windows.

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For information about\n extending a Linux file system, see Extending a Linux\n file system. For information about extending a Windows file system, see Extending a\n Windows file system.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitoring volume\n modifications.

\n

With previous-generation instance types, resizing an EBS volume may require detaching and\n reattaching the volume or stopping and restarting the instance. For more information, see\n Modifying the size,\n IOPS, or type of an EBS volume on Linux and Modifying the size, IOPS, or type of an EBS\n volume on Windows.

\n

If you reach the maximum volume modification rate per volume limit, you will need to wait\n at least six hours before applying further modifications to the affected EBS volume.

" } }, "com.amazonaws.ec2#ModifyVolumeAttribute": { @@ -39561,6 +40912,12 @@ "com.amazonaws.ec2#ModifyVolumeRequest": { "type": "structure", "members": { + "Iops": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The target IOPS rate of the volume.

\n

This is only valid for Provisioned IOPS SSD (io1 and io2) volumes. For moreinformation, see \n \t\n \t\tProvisioned IOPS SSD (io1 and io2) volumes.

\n

Default: If no IOPS value is specified, the existing value is retained.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -39573,24 +40930,18 @@ "smithy.api#documentation": "

The target size of the volume, in GiB. The target volume size must be greater than or\n equal to than the existing size of the volume. For information about available EBS volume\n sizes, see Amazon EBS Volume\n Types.

\n

Default: If no size is specified, the existing size is retained.

" } }, + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "smithy.api#documentation": "

The target EBS volume type of the volume.

\n

Default: If no type is specified, the existing type is retained.

" + } + }, "VolumeId": { "target": "com.amazonaws.ec2#VolumeId", "traits": { "smithy.api#documentation": "

The ID of the volume.

", "smithy.api#required": {} } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The target IOPS rate of the volume.

\n

This is only valid for Provisioned IOPS SSD (io1) volumes. For more\n information, see Provisioned IOPS SSD (io1)\n Volumes.

\n

Default: If no IOPS value is specified, the existing value is retained.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "smithy.api#documentation": "

The target EBS volume type of the volume.

\n

Default: If no type is specified, the existing type is retained.

" - } } } }, @@ -39625,6 +40976,12 @@ "smithy.api#documentation": "

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to\n\t\t\tthe Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP\n\t\t\taddress at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon\n\t\t\tprovided DNS service in the VPC that resolves public DNS hostnames to IP addresses is\n\t\t\tnot enabled.

\n

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" } }, + "EnableDnsHostnames": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

\n

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" + } + }, "VpcId": { "target": "com.amazonaws.ec2#VpcId", "traits": { @@ -39633,12 +40990,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcId" } - }, - "EnableDnsHostnames": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", - "traits": { - "smithy.api#documentation": "

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

\n

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" - } } } }, @@ -39669,10 +41020,10 @@ "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotificationRequest": { "type": "structure", "members": { - "ConnectionNotificationArn": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ARN for the SNS topic for the notification.

" + "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.

" } }, "ConnectionEvents": { @@ -39688,10 +41039,10 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "ConnectionNotificationArn": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The ARN for the SNS topic for the notification.

" } } } @@ -39712,19 +41063,6 @@ "com.amazonaws.ec2#ModifyVpcEndpointRequest": { "type": "structure", "members": { - "RemoveRouteTableIds": { - "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", - "traits": { - "smithy.api#documentation": "

(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

", - "smithy.api#xmlName": "RemoveRouteTableId" - } - }, - "PrivateDnsEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

(Interface endpoint) Indicates whether a private hosted zone is associated with the\n VPC.

" - } - }, "VpcEndpointId": { "target": "com.amazonaws.ec2#VpcEndpointId", "traits": { @@ -39732,23 +41070,24 @@ "smithy.api#required": {} } }, - "ResetPolicy": { - "target": "com.amazonaws.ec2#Boolean", + "RemoveSubnetIds": { + "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", "traits": { - "smithy.api#documentation": "

(Gateway endpoint) Specify true to reset the policy document to the\n default policy. The default policy allows full access to the service.

" + "smithy.api#documentation": "

(Interface endpoint) One or more subnets IDs in which to remove the endpoint.

", + "smithy.api#xmlName": "RemoveSubnetId" } }, - "AddSubnetIds": { - "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", + "RemoveRouteTableIds": { + "target": "com.amazonaws.ec2#VpcEndpointRouteTableIdList", "traits": { - "smithy.api#documentation": "

(Interface endpoint) One or more subnet IDs in which to serve the endpoint.

", - "smithy.api#xmlName": "AddSubnetId" + "smithy.api#documentation": "

(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

", + "smithy.api#xmlName": "RemoveRouteTableId" } }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

A policy to attach to the endpoint that controls access to the service. The policy must\n be in valid JSON format.

" + "smithy.api#documentation": "

(Interface endpoint) Indicates whether a private hosted zone is associated with the\n VPC.

" } }, "DryRun": { @@ -39757,13 +41096,6 @@ "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.

" } }, - "AddSecurityGroupIds": { - "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

(Interface endpoint) One or more security group IDs to associate with the network interface.

", - "smithy.api#xmlName": "AddSecurityGroupId" - } - }, "RemoveSecurityGroupIds": { "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", "traits": { @@ -39778,11 +41110,30 @@ "smithy.api#xmlName": "AddRouteTableId" } }, - "RemoveSubnetIds": { + "AddSecurityGroupIds": { + "target": "com.amazonaws.ec2#VpcEndpointSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

(Interface endpoint) One or more security group IDs to associate with the network interface.

", + "smithy.api#xmlName": "AddSecurityGroupId" + } + }, + "ResetPolicy": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

(Gateway endpoint) Specify true to reset the policy document to the\n default policy. The default policy allows full access to the service.

" + } + }, + "AddSubnetIds": { "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", "traits": { - "smithy.api#documentation": "

(Interface endpoint) One or more subnets IDs in which to remove the endpoint.

", - "smithy.api#xmlName": "RemoveSubnetId" + "smithy.api#documentation": "

(Interface endpoint) One or more subnet IDs in which to serve the endpoint.

", + "smithy.api#xmlName": "AddSubnetId" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A policy to attach to the endpoint that controls access to the service. The policy must\n be in valid JSON format.

" } } }, @@ -39818,6 +41169,12 @@ "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "AddNetworkLoadBalancerArns": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -39825,17 +41182,16 @@ "smithy.api#xmlName": "AddNetworkLoadBalancerArn" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", "traits": { - "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#documentation": "

The private DNS name to assign to the endpoint service.

" } }, - "RemoveNetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", + "RemovePrivateDnsName": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service\n configuration.

", - "smithy.api#xmlName": "RemoveNetworkLoadBalancerArn" + "smithy.api#documentation": "

Removes the private DNS name of the endpoint service.

" } }, "ServiceId": { @@ -39845,22 +41201,17 @@ "smithy.api#required": {} } }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The private DNS name to assign to the endpoint service.

" - } - }, "AcceptanceRequired": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether requests to create an endpoint to your service must be accepted.

" } }, - "RemovePrivateDnsName": { - "target": "com.amazonaws.ec2#Boolean", + "RemoveNetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "smithy.api#documentation": "

Removes the private DNS name of the endpoint service.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service\n configuration.

", + "smithy.api#xmlName": "RemoveNetworkLoadBalancerArn" } } } @@ -39893,18 +41244,6 @@ "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, - "AddAllowedPrincipals": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of one or more principals.\n\t Permissions are granted to the principals in this list.\n\t To grant permissions to all principals, specify an asterisk (*).

" - } - }, "ServiceId": { "target": "com.amazonaws.ec2#VpcEndpointServiceId", "traits": { @@ -39917,6 +41256,18 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARN) of one or more principals.\n\t Permissions are revoked for principals in this list.

" } + }, + "AddAllowedPrincipals": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of one or more principals.\n\t Permissions are granted to the principals in this list.\n\t To grant permissions to all principals, specify an asterisk (*).

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -39955,10 +41306,10 @@ "smithy.api#required": {} } }, - "RequesterPeeringConnectionOptions": { - "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The VPC peering connection options for the requester VPC.

" + "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.

" } }, "AccepterPeeringConnectionOptions": { @@ -39967,10 +41318,10 @@ "smithy.api#documentation": "

The VPC peering connection options for the accepter VPC.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "RequesterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptionsRequest", "traits": { - "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#documentation": "

The VPC peering connection options for the requester VPC.

" } } } @@ -39978,14 +41329,6 @@ "com.amazonaws.ec2#ModifyVpcPeeringConnectionOptionsResult": { "type": "structure", "members": { - "AccepterPeeringConnectionOptions": { - "target": "com.amazonaws.ec2#PeeringConnectionOptions", - "traits": { - "aws.protocols#ec2QueryName": "AccepterPeeringConnectionOptions", - "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter VPC.

", - "smithy.api#xmlName": "accepterPeeringConnectionOptions" - } - }, "RequesterPeeringConnectionOptions": { "target": "com.amazonaws.ec2#PeeringConnectionOptions", "traits": { @@ -39993,6 +41336,14 @@ "smithy.api#documentation": "

Information about the VPC peering connection options for the requester VPC.

", "smithy.api#xmlName": "requesterPeeringConnectionOptions" } + }, + "AccepterPeeringConnectionOptions": { + "target": "com.amazonaws.ec2#PeeringConnectionOptions", + "traits": { + "aws.protocols#ec2QueryName": "AccepterPeeringConnectionOptions", + "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter VPC.

", + "smithy.api#xmlName": "accepterPeeringConnectionOptions" + } } } }, @@ -40058,26 +41409,79 @@ "smithy.api#documentation": "

Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection. To modify the target gateway, the following migration\n options are available:

\n \n

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

\n

This step is required when you migrate from a virtual private gateway with static routes to\n a transit gateway.

\n

You must delete the static routes before you migrate to the new gateway.

\n \n

Keep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.

\n \n

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide.

\n

\n When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

\n \n

If you deleted VPN static routes, you must add the static routes to the transit gateway\n route table.

\n

After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and\n the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable\n for a brief period while we provision the new endpoints.

" } }, - "com.amazonaws.ec2#ModifyVpnConnectionRequest": { + "com.amazonaws.ec2#ModifyVpnConnectionOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the connection options for your Site-to-Site VPN connection.

\n

When you modify the VPN connection options, the VPN endpoint IP addresses on the AWS side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.

" + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest": { "type": "structure", "members": { + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#documentation": "

The ID of the Site-to-Site VPN connection.\n

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "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#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#CustomerGatewayId", + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

" + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" } }, - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IPv4 CIDR on the AWS side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the AWS side of the VPN connection.

\n

Default: ::/0\n

" + } + } + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult": { + "type": "structure", + "members": { + "VpnConnection": { + "target": "com.amazonaws.ec2#VpnConnection", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnection", + "smithy.api#xmlName": "vpnConnection" + } + } + } + }, + "com.amazonaws.ec2#ModifyVpnConnectionRequest": { + "type": "structure", + "members": { + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#CustomerGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

" } }, "TransitGatewayId": { @@ -40086,11 +41490,24 @@ "smithy.api#documentation": "

The ID of the transit gateway.

" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "VpnGatewayId": { "target": "com.amazonaws.ec2#VpnGatewayId", "traits": { "smithy.api#documentation": "

The ID of the virtual private gateway at the AWS side of the VPN connection.

" } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", + "traits": { + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#required": {} + } } } }, @@ -40121,6 +41538,12 @@ "com.amazonaws.ec2#ModifyVpnTunnelCertificateRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "VpnConnectionId": { "target": "com.amazonaws.ec2#VpnConnectionId", "traits": { @@ -40128,12 +41551,6 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "VpnTunnelOutsideIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -40170,11 +41587,10 @@ "com.amazonaws.ec2#ModifyVpnTunnelOptionsRequest": { "type": "structure", "members": { - "VpnConnectionId": { - "target": "com.amazonaws.ec2#VpnConnectionId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the AWS Site-to-Site VPN connection.

", - "smithy.api#required": {} + "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.

" } }, "TunnelOptions": { @@ -40184,10 +41600,11 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "VpnConnectionId": { + "target": "com.amazonaws.ec2#VpnConnectionId", "traits": { - "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#documentation": "

The ID of the AWS Site-to-Site VPN connection.

", + "smithy.api#required": {} } }, "VpnTunnelOutsideIpAddress": { @@ -40214,50 +41631,47 @@ "com.amazonaws.ec2#ModifyVpnTunnelOptionsSpecification": { "type": "structure", "members": { - "Phase2LifetimeSeconds": { + "RekeyFuzzPercentage": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

\n

Default: 3600\n

" + "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" } }, - "Phase1IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "Phase1LifetimeSeconds": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256\n

", - "smithy.api#xmlName": "Phase1IntegrityAlgorithm" + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" } }, - "Phase2IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256\n

", - "smithy.api#xmlName": "Phase2IntegrityAlgorithm" + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique\n across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " } }, - "PreSharedKey": { + "StartupAction": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" } }, - "Phase2EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", + "IKEVersions": { + "target": "com.amazonaws.ec2#IKEVersionsRequestList", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: AES128 | AES256\n

", - "smithy.api#xmlName": "Phase2EncryptionAlgorithm" + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#xmlName": "IKEVersion" } }, - "Phase1EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: AES128 | AES256\n

", - "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" } }, - "RekeyMarginTimeSeconds": { + "ReplayWindowSize": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" } }, "DPDTimeoutSeconds": { @@ -40266,49 +41680,70 @@ "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value between 0 and 30.

\n

Default: 30\n

" } }, - "ReplayWindowSize": { - "target": "com.amazonaws.ec2#Integer", + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase2EncryptionAlgorithm" } }, - "Phase2DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", + "PreSharedKey": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24\n

", - "smithy.api#xmlName": "Phase2DHGroupNumber" + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" } }, - "RekeyFuzzPercentage": { - "target": "com.amazonaws.ec2#Integer", + "DPDTimeoutAction": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" } }, - "Phase1LifetimeSeconds": { + "Phase2LifetimeSeconds": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

\n

Default: 3600\n

" } }, - "TunnelInsideCidr": { - "target": "com.amazonaws.ec2#String", + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique\n across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + } + }, + "RekeyMarginTimeSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" } }, "Phase1DHGroupNumbers": { "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24\n

", + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24\n

", "smithy.api#xmlName": "Phase1DHGroupNumber" } }, - "IKEVersions": { - "target": "com.amazonaws.ec2#IKEVersionsRequestList", + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", - "smithy.api#xmlName": "IKEVersion" + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24\n

", + "smithy.api#xmlName": "Phase2DHGroupNumber" + } + }, + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512\n

", + "smithy.api#xmlName": "Phase2IntegrityAlgorithm" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512\n

", + "smithy.api#xmlName": "Phase1IntegrityAlgorithm" } } }, @@ -40412,6 +41847,14 @@ "com.amazonaws.ec2#MoveAddressToVpcRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "PublicIp": { "target": "com.amazonaws.ec2#String", "traits": { @@ -40420,14 +41863,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "publicIp" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } } }, @@ -40468,14 +41903,6 @@ "com.amazonaws.ec2#MovingAddressStatus": { "type": "structure", "members": { - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" - } - }, "MoveStatus": { "target": "com.amazonaws.ec2#MoveStatus", "traits": { @@ -40483,6 +41910,14 @@ "smithy.api#documentation": "

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", "smithy.api#xmlName": "moveStatus" } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } } }, "traits": { @@ -40514,12 +41949,12 @@ "com.amazonaws.ec2#NatGateway": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC in which the NAT gateway is located.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the NAT gateway.

", + "smithy.api#xmlName": "tagSet" } }, "FailureCode": { @@ -40530,28 +41965,36 @@ "smithy.api#xmlName": "failureCode" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "NatGatewayId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the NAT gateway.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of the NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" } }, - "SubnetId": { + "State": { + "target": "com.amazonaws.ec2#NatGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the NAT gateway.

\n ", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which the NAT gateway is located.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the NAT gateway is located.

", + "smithy.api#xmlName": "vpcId" } }, - "NatGatewayAddresses": { - "target": "com.amazonaws.ec2#NatGatewayAddressList", + "ProvisionedBandwidth": { + "target": "com.amazonaws.ec2#ProvisionedBandwidth", "traits": { - "aws.protocols#ec2QueryName": "NatGatewayAddressSet", - "smithy.api#documentation": "

Information about the IP addresses and network interface associated with the NAT gateway.

", - "smithy.api#xmlName": "natGatewayAddressSet" + "aws.protocols#ec2QueryName": "ProvisionedBandwidth", + "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "smithy.api#xmlName": "provisionedBandwidth" } }, "CreateTime": { @@ -40562,22 +42005,6 @@ "smithy.api#xmlName": "createTime" } }, - "DeleteTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "DeleteTime", - "smithy.api#documentation": "

The date and time the NAT gateway was deleted, if applicable.

", - "smithy.api#xmlName": "deleteTime" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The ID of the NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, "FailureMessage": { "target": "com.amazonaws.ec2#String", "traits": { @@ -40586,20 +42013,28 @@ "smithy.api#xmlName": "failureMessage" } }, - "State": { - "target": "com.amazonaws.ec2#NatGatewayState", + "NatGatewayAddresses": { + "target": "com.amazonaws.ec2#NatGatewayAddressList", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the NAT gateway.

\n ", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "NatGatewayAddressSet", + "smithy.api#documentation": "

Information about the IP addresses and network interface associated with the NAT gateway.

", + "smithy.api#xmlName": "natGatewayAddressSet" } }, - "ProvisionedBandwidth": { - "target": "com.amazonaws.ec2#ProvisionedBandwidth", + "DeleteTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "ProvisionedBandwidth", - "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "provisionedBandwidth" + "aws.protocols#ec2QueryName": "DeleteTime", + "smithy.api#documentation": "

The date and time the NAT gateway was deleted, if applicable.

", + "smithy.api#xmlName": "deleteTime" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the NAT gateway is located.

", + "smithy.api#xmlName": "subnetId" } } }, @@ -40618,12 +42053,12 @@ "smithy.api#xmlName": "networkInterfaceId" } }, - "PrivateIp": { + "AllocationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateIp", - "smithy.api#documentation": "

The private IP address associated with the Elastic IP address.

", - "smithy.api#xmlName": "privateIp" + "aws.protocols#ec2QueryName": "AllocationId", + "smithy.api#documentation": "

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", + "smithy.api#xmlName": "allocationId" } }, "PublicIp": { @@ -40634,12 +42069,12 @@ "smithy.api#xmlName": "publicIp" } }, - "AllocationId": { + "PrivateIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", - "smithy.api#xmlName": "allocationId" + "aws.protocols#ec2QueryName": "PrivateIp", + "smithy.api#documentation": "

The private IP address associated with the Elastic IP address.

", + "smithy.api#xmlName": "privateIp" } } }, @@ -40707,20 +42142,12 @@ "com.amazonaws.ec2#NetworkAcl": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the network ACL.

", - "smithy.api#xmlName": "tagSet" - } - }, - "IsDefault": { - "target": "com.amazonaws.ec2#Boolean", + "OwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Default", - "smithy.api#documentation": "

Indicates whether this is the default network ACL for the VPC.

", - "smithy.api#xmlName": "default" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the network ACL.

", + "smithy.api#xmlName": "ownerId" } }, "Entries": { @@ -40731,14 +42158,6 @@ "smithy.api#xmlName": "entrySet" } }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the network ACL.

", - "smithy.api#xmlName": "ownerId" - } - }, "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -40747,6 +42166,22 @@ "smithy.api#xmlName": "vpcId" } }, + "Associations": { + "target": "com.amazonaws.ec2#NetworkAclAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "AssociationSet", + "smithy.api#documentation": "

Any associations between the network ACL and one or more subnets

", + "smithy.api#xmlName": "associationSet" + } + }, + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Default", + "smithy.api#documentation": "

Indicates whether this is the default network ACL for the VPC.

", + "smithy.api#xmlName": "default" + } + }, "NetworkAclId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -40755,12 +42190,12 @@ "smithy.api#xmlName": "networkAclId" } }, - "Associations": { - "target": "com.amazonaws.ec2#NetworkAclAssociationList", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "AssociationSet", - "smithy.api#documentation": "

Any associations between the network ACL and one or more subnets

", - "smithy.api#xmlName": "associationSet" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the network ACL.

", + "smithy.api#xmlName": "tagSet" } } }, @@ -40771,12 +42206,12 @@ "com.amazonaws.ec2#NetworkAclAssociation": { "type": "structure", "members": { - "NetworkAclAssociationId": { + "NetworkAclId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkAclAssociationId", - "smithy.api#documentation": "

The ID of the association between a network ACL and a subnet.

", - "smithy.api#xmlName": "networkAclAssociationId" + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the network ACL.

", + "smithy.api#xmlName": "networkAclId" } }, "SubnetId": { @@ -40787,12 +42222,12 @@ "smithy.api#xmlName": "subnetId" } }, - "NetworkAclId": { + "NetworkAclAssociationId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#documentation": "

The ID of the network ACL.

", - "smithy.api#xmlName": "networkAclId" + "aws.protocols#ec2QueryName": "NetworkAclAssociationId", + "smithy.api#documentation": "

The ID of the association between a network ACL and a subnet.

", + "smithy.api#xmlName": "networkAclAssociationId" } } }, @@ -40815,6 +42250,22 @@ "com.amazonaws.ec2#NetworkAclEntry": { "type": "structure", "members": { + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.

", + "smithy.api#xmlName": "portRange" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#RuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", + "smithy.api#xmlName": "ruleAction" + } + }, "IcmpTypeCode": { "target": "com.amazonaws.ec2#IcmpTypeCode", "traits": { @@ -40831,12 +42282,12 @@ "smithy.api#xmlName": "protocol" } }, - "RuleAction": { - "target": "com.amazonaws.ec2#RuleAction", + "CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

Indicates whether to allow or deny the traffic that matches the rule.

", - "smithy.api#xmlName": "ruleAction" + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation.

", + "smithy.api#xmlName": "cidrBlock" } }, "RuleNumber": { @@ -40847,14 +42298,6 @@ "smithy.api#xmlName": "ruleNumber" } }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#documentation": "

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", - "smithy.api#xmlName": "egress" - } - }, "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { @@ -40863,20 +42306,12 @@ "smithy.api#xmlName": "ipv6CidrBlock" } }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", + "Egress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.

", - "smithy.api#xmlName": "portRange" + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#documentation": "

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "smithy.api#xmlName": "egress" } } }, @@ -40917,20 +42352,20 @@ "com.amazonaws.ec2#NetworkInfo": { "type": "structure", "members": { - "EnaSupport": { - "target": "com.amazonaws.ec2#EnaSupport", + "Ipv6AddressesPerInterface": { + "target": "com.amazonaws.ec2#MaxIpv6AddrPerInterface", "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Indicates whether Elastic Network Adapter (ENA) is supported.

", - "smithy.api#xmlName": "enaSupport" + "aws.protocols#ec2QueryName": "Ipv6AddressesPerInterface", + "smithy.api#documentation": "

The maximum number of IPv6 addresses per network interface.

", + "smithy.api#xmlName": "ipv6AddressesPerInterface" } }, - "Ipv4AddressesPerInterface": { - "target": "com.amazonaws.ec2#MaxIpv4AddrPerInterface", + "MaximumNetworkInterfaces": { + "target": "com.amazonaws.ec2#MaxNetworkInterfaces", "traits": { - "aws.protocols#ec2QueryName": "Ipv4AddressesPerInterface", - "smithy.api#documentation": "

The maximum number of IPv4 addresses per network interface.

", - "smithy.api#xmlName": "ipv4AddressesPerInterface" + "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", + "smithy.api#documentation": "

The maximum number of network interfaces for the instance type.

", + "smithy.api#xmlName": "maximumNetworkInterfaces" } }, "Ipv6Supported": { @@ -40941,14 +42376,6 @@ "smithy.api#xmlName": "ipv6Supported" } }, - "Ipv6AddressesPerInterface": { - "target": "com.amazonaws.ec2#MaxIpv6AddrPerInterface", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressesPerInterface", - "smithy.api#documentation": "

The maximum number of IPv6 addresses per network interface.

", - "smithy.api#xmlName": "ipv6AddressesPerInterface" - } - }, "EfaSupported": { "target": "com.amazonaws.ec2#EfaSupportedFlag", "traits": { @@ -40957,14 +42384,6 @@ "smithy.api#xmlName": "efaSupported" } }, - "MaximumNetworkInterfaces": { - "target": "com.amazonaws.ec2#MaxNetworkInterfaces", - "traits": { - "aws.protocols#ec2QueryName": "MaximumNetworkInterfaces", - "smithy.api#documentation": "

The maximum number of network interfaces for the instance type.

", - "smithy.api#xmlName": "maximumNetworkInterfaces" - } - }, "NetworkPerformance": { "target": "com.amazonaws.ec2#NetworkPerformance", "traits": { @@ -40972,6 +42391,22 @@ "smithy.api#documentation": "

Describes the network performance.

", "smithy.api#xmlName": "networkPerformance" } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#EnaSupport", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Indicates whether Elastic Network Adapter (ENA) is supported.

", + "smithy.api#xmlName": "enaSupport" + } + }, + "Ipv4AddressesPerInterface": { + "target": "com.amazonaws.ec2#MaxIpv4AddrPerInterface", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4AddressesPerInterface", + "smithy.api#documentation": "

The maximum number of IPv4 addresses per network interface.

", + "smithy.api#xmlName": "ipv4AddressesPerInterface" + } } }, "traits": { @@ -40981,46 +42416,6 @@ "com.amazonaws.ec2#NetworkInterface": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

Any security groups for the network interface.

", - "smithy.api#xmlName": "groupSet" - } - }, - "RequesterManaged": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "RequesterManaged", - "smithy.api#documentation": "

Indicates whether the network interface is being managed by AWS.

", - "smithy.api#xmlName": "requesterManaged" - } - }, - "Association": { - "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", - "traits": { - "aws.protocols#ec2QueryName": "Association", - "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", - "smithy.api#xmlName": "association" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41029,20 +42424,20 @@ "smithy.api#xmlName": "ownerId" } }, - "SubnetId": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description.

", + "smithy.api#xmlName": "description" } }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList", + "TagSet": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", - "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", - "smithy.api#xmlName": "privateIpAddressesSet" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the network interface.

", + "smithy.api#xmlName": "tagSet" } }, "SourceDestCheck": { @@ -41053,20 +42448,20 @@ "smithy.api#xmlName": "sourceDestCheck" } }, - "InterfaceType": { - "target": "com.amazonaws.ec2#NetworkInterfaceType", + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#NetworkInterfacePrivateIpAddressList", "traits": { - "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

The type of network interface.

", - "smithy.api#xmlName": "interfaceType" + "aws.protocols#ec2QueryName": "PrivateIpAddressesSet", + "smithy.api#documentation": "

The private IPv4 addresses associated with the network interface.

", + "smithy.api#xmlName": "privateIpAddressesSet" } }, - "Description": { + "SubnetId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" } }, "PrivateIpAddress": { @@ -41077,12 +42472,20 @@ "smithy.api#xmlName": "privateIpAddress" } }, - "Status": { - "target": "com.amazonaws.ec2#NetworkInterfaceStatus", + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the network interface.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "RequesterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RequesterId", + "smithy.api#documentation": "

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "smithy.api#xmlName": "requesterId" } }, "Ipv6Addresses": { @@ -41093,36 +42496,76 @@ "smithy.api#xmlName": "ipv6AddressesSet" } }, - "RequesterId": { + "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RequesterId", - "smithy.api#documentation": "

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", - "smithy.api#xmlName": "requesterId" + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" } }, - "Attachment": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", + "Association": { + "target": "com.amazonaws.ec2#NetworkInterfaceAssociation", "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

The network interface attachment.

", - "smithy.api#xmlName": "attachment" + "aws.protocols#ec2QueryName": "Association", + "smithy.api#documentation": "

The association information for an Elastic IP address (IPv4) associated with the network interface.

", + "smithy.api#xmlName": "association" } }, - "PrivateDnsName": { + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

Any security groups for the network interface.

", + "smithy.api#xmlName": "groupSet" + } + }, + "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name.

", - "smithy.api#xmlName": "privateDnsName" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" } }, - "NetworkInterfaceId": { + "RequesterManaged": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "RequesterManaged", + "smithy.api#documentation": "

Indicates whether the network interface is being managed by AWS.

", + "smithy.api#xmlName": "requesterManaged" + } + }, + "InterfaceType": { + "target": "com.amazonaws.ec2#NetworkInterfaceType", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceType", + "smithy.api#documentation": "

The type of network interface.

", + "smithy.api#xmlName": "interfaceType" + } + }, + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "Status": { + "target": "com.amazonaws.ec2#NetworkInterfaceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the network interface.

", + "smithy.api#xmlName": "status" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#xmlName": "privateDnsName" } }, "MacAddress": { @@ -41133,20 +42576,12 @@ "smithy.api#xmlName": "macAddress" } }, - "TagSet": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the network interface.

", - "smithy.api#xmlName": "tagSet" - } - }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachment", "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

The network interface attachment.

", + "smithy.api#xmlName": "attachment" } } }, @@ -41157,14 +42592,6 @@ "com.amazonaws.ec2#NetworkInterfaceAssociation": { "type": "structure", "members": { - "PublicDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicDnsName", - "smithy.api#documentation": "

The public DNS name.

", - "smithy.api#xmlName": "publicDnsName" - } - }, "IpOwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41177,7 +42604,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The address of the Elastic IP address bound to the network interface.

", + "smithy.api#documentation": "

The address of the Elastic IP address or Carrier IP address bound to the network\n interface.

", "smithy.api#xmlName": "publicIp" } }, @@ -41189,6 +42616,14 @@ "smithy.api#xmlName": "allocationId" } }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicDnsName", + "smithy.api#documentation": "

The public DNS name.

", + "smithy.api#xmlName": "publicDnsName" + } + }, "AssociationId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41196,10 +42631,26 @@ "smithy.api#documentation": "

The association ID.

", "smithy.api#xmlName": "associationId" } + }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, + "CarrierIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CarrierIp", + "smithy.api#documentation": "

The carrier IP address associated with the network interface.

\n

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

", + "smithy.api#xmlName": "carrierIp" + } } }, "traits": { - "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4 only).

" + "smithy.api#documentation": "

Describes association information for an Elastic IP address (IPv4 only), or a Carrier\n IP address (for a network interface which resides in a subnet in a Wavelength\n Zone).

" } }, "com.amazonaws.ec2#NetworkInterfaceAttachment": { @@ -41213,12 +42664,20 @@ "smithy.api#xmlName": "instanceId" } }, - "AttachmentId": { - "target": "com.amazonaws.ec2#String", + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "AttachmentId", - "smithy.api#documentation": "

The ID of the network interface attachment.

", - "smithy.api#xmlName": "attachmentId" + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#documentation": "

The device index of the network interface attachment on the instance.

", + "smithy.api#xmlName": "deviceIndex" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", + "smithy.api#xmlName": "deleteOnTermination" } }, "Status": { @@ -41245,20 +42704,12 @@ "smithy.api#xmlName": "attachTime" } }, - "DeviceIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#documentation": "

The device index of the network interface attachment on the instance.

", - "smithy.api#xmlName": "deviceIndex" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", + "AttachmentId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "

Indicates whether the network interface is deleted when the instance is terminated.

", - "smithy.api#xmlName": "deleteOnTermination" + "aws.protocols#ec2QueryName": "AttachmentId", + "smithy.api#documentation": "

The ID of the network interface attachment.

", + "smithy.api#xmlName": "attachmentId" } } }, @@ -41371,14 +42822,6 @@ "com.amazonaws.ec2#NetworkInterfacePermission": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AwsAccountId", - "smithy.api#documentation": "

The AWS account ID.

", - "smithy.api#xmlName": "awsAccountId" - } - }, "NetworkInterfacePermissionId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41387,12 +42830,20 @@ "smithy.api#xmlName": "networkInterfacePermissionId" } }, - "AwsService": { + "NetworkInterfaceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AwsService", - "smithy.api#documentation": "

The AWS service.

", - "smithy.api#xmlName": "awsService" + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "Permission": { + "target": "com.amazonaws.ec2#InterfacePermissionType", + "traits": { + "aws.protocols#ec2QueryName": "Permission", + "smithy.api#documentation": "

The type of permission.

", + "smithy.api#xmlName": "permission" } }, "PermissionState": { @@ -41403,20 +42854,20 @@ "smithy.api#xmlName": "permissionState" } }, - "Permission": { - "target": "com.amazonaws.ec2#InterfacePermissionType", + "AwsService": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Permission", - "smithy.api#documentation": "

The type of permission.

", - "smithy.api#xmlName": "permission" + "aws.protocols#ec2QueryName": "AwsService", + "smithy.api#documentation": "

The AWS service.

", + "smithy.api#xmlName": "awsService" } }, - "NetworkInterfaceId": { + "AwsAccountId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "AwsAccountId", + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#xmlName": "awsAccountId" } } }, @@ -41445,14 +42896,6 @@ "com.amazonaws.ec2#NetworkInterfacePermissionState": { "type": "structure", "members": { - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A status message, if applicable.

", - "smithy.api#xmlName": "statusMessage" - } - }, "State": { "target": "com.amazonaws.ec2#NetworkInterfacePermissionStateCode", "traits": { @@ -41460,6 +42903,14 @@ "smithy.api#documentation": "

The state of the permission.

", "smithy.api#xmlName": "state" } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A status message, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } } }, "traits": { @@ -41578,13 +43029,6 @@ "com.amazonaws.ec2#NewDhcpConfiguration": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "smithy.api#documentation": "

One or more values for the DHCP option.

", - "smithy.api#xmlName": "Value" - } - }, "Key": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41592,6 +43036,13 @@ "smithy.api#documentation": "

The name of a DHCP option.

", "smithy.api#xmlName": "key" } + }, + "Values": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

One or more values for the DHCP option.

", + "smithy.api#xmlName": "Value" + } } }, "traits": { @@ -41697,14 +43148,6 @@ "smithy.api#xmlName": "capacityReservationOptions" } }, - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "MaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

", - "smithy.api#xmlName": "maxTotalPrice" - } - }, "SingleAvailabilityZone": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -41713,12 +43156,20 @@ "smithy.api#xmlName": "singleAvailabilityZone" } }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "MinTargetCapacity", - "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

", - "smithy.api#xmlName": "minTargetCapacity" + "aws.protocols#ec2QueryName": "MaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

", + "smithy.api#xmlName": "maxTotalPrice" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", + "traits": { + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowest-price, EC2 Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, EC2 Fleet uses the priority\n that you assigned to each launch template override, launching the highest priority first.\n If you do not specify a value, EC2 Fleet defaults to lowest-price.

", + "smithy.api#xmlName": "allocationStrategy" } }, "SingleInstanceType": { @@ -41729,12 +43180,12 @@ "smithy.api#xmlName": "singleInstanceType" } }, - "AllocationStrategy": { - "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowest-price, EC2 Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, EC2 Fleet uses the priority\n that you assigned to each launch template override, launching the highest priority first.\n If you do not specify a value, EC2 Fleet defaults to lowest-price.

", - "smithy.api#xmlName": "allocationStrategy" + "aws.protocols#ec2QueryName": "MinTargetCapacity", + "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

", + "smithy.api#xmlName": "minTargetCapacity" } } }, @@ -41745,24 +43196,6 @@ "com.amazonaws.ec2#OnDemandOptionsRequest": { "type": "structure", "members": { - "AllocationStrategy": { - "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", - "traits": { - "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowest-price, EC2 Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, EC2 Fleet uses the priority\n that you assigned to each launch template override, launching the highest priority first.\n If you do not specify a value, EC2 Fleet defaults to lowest-price.

" - } - }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

" - } - }, - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

" - } - }, "SingleInstanceType": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -41780,6 +43213,24 @@ "traits": { "smithy.api#documentation": "

The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.\n Supported only for fleets of type instant.

" } + }, + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay.

" + } + }, + "AllocationStrategy": { + "target": "com.amazonaws.ec2#FleetOnDemandAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowest-price, EC2 Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, EC2 Fleet uses the priority\n that you assigned to each launch template override, launching the highest priority first.\n If you do not specify a value, EC2 Fleet defaults to lowest-price.

" + } } }, "traits": { @@ -41830,10 +43281,10 @@ "com.amazonaws.ec2#PciId": { "type": "structure", "members": { - "VendorId": { + "SubsystemVendorId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the vendor.

" + "smithy.api#documentation": "

The ID of the vendor for the subsystem.

" } }, "DeviceId": { @@ -41842,16 +43293,16 @@ "smithy.api#documentation": "

The ID of the device.

" } }, - "SubsystemVendorId": { + "SubsystemId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the vendor for the subsystem.

" + "smithy.api#documentation": "

The ID of the subsystem.

" } }, - "SubsystemId": { + "VendorId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the subsystem.

" + "smithy.api#documentation": "

The ID of the vendor.

" } } }, @@ -41862,14 +43313,6 @@ "com.amazonaws.ec2#PeeringAttachmentStatus": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41877,6 +43320,14 @@ "smithy.api#documentation": "

The status message, if applicable.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The status code.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -41886,14 +43337,6 @@ "com.amazonaws.ec2#PeeringConnectionOptions": { "type": "structure", "members": { - "AllowEgressFromLocalClassicLinkToRemoteVpc": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", - "smithy.api#documentation": "

If true, enables outbound communication from an EC2-Classic instance that's linked to\n a local VPC using ClassicLink to instances in a peer VPC.

", - "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" - } - }, "AllowEgressFromLocalVpcToRemoteClassicLink": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -41902,6 +43345,14 @@ "smithy.api#xmlName": "allowEgressFromLocalVpcToRemoteClassicLink" } }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", + "smithy.api#documentation": "

If true, enables outbound communication from an EC2-Classic instance that's linked to\n a local VPC using ClassicLink to instances in a peer VPC.

", + "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" + } + }, "AllowDnsResolutionFromRemoteVpc": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -41918,10 +43369,10 @@ "com.amazonaws.ec2#PeeringConnectionOptionsRequest": { "type": "structure", "members": { - "AllowDnsResolutionFromRemoteVpc": { + "AllowEgressFromLocalVpcToRemoteClassicLink": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" + "smithy.api#documentation": "

If true, enables outbound communication from instances in a local VPC to an\n EC2-Classic instance that's linked to a peer VPC using ClassicLink.

" } }, "AllowEgressFromLocalClassicLinkToRemoteVpc": { @@ -41930,10 +43381,10 @@ "smithy.api#documentation": "

If true, enables outbound communication from an EC2-Classic instance that's linked to\n a local VPC using ClassicLink to instances in a peer VPC.

" } }, - "AllowEgressFromLocalVpcToRemoteClassicLink": { + "AllowDnsResolutionFromRemoteVpc": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

If true, enables outbound communication from instances in a local VPC to an\n EC2-Classic instance that's linked to a peer VPC using ClassicLink.

" + "smithy.api#documentation": "

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" } } }, @@ -42274,12 +43725,12 @@ "com.amazonaws.ec2#Placement": { "type": "structure", "members": { - "SpreadDomain": { + "GroupName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SpreadDomain", - "smithy.api#documentation": "

Reserved for future use.

\n

This parameter is not supported by CreateFleet.

", - "smithy.api#xmlName": "spreadDomain" + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the placement group the instance is in.

", + "smithy.api#xmlName": "groupName" } }, "PartitionNumber": { @@ -42290,6 +43741,14 @@ "smithy.api#xmlName": "partitionNumber" } }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HostResourceGroupArn", + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances. If you specify \n \t\ta host resource group ARN, omit the Tenancy \n \t\tparameter or set it to host.

\n

This parameter is not supported by CreateFleet.

", + "smithy.api#xmlName": "hostResourceGroupArn" + } + }, "Affinity": { "target": "com.amazonaws.ec2#String", "traits": { @@ -42298,12 +43757,12 @@ "smithy.api#xmlName": "affinity" } }, - "GroupName": { - "target": "com.amazonaws.ec2#String", + "Tenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group the instance is in.

", - "smithy.api#xmlName": "groupName" + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware. The host\n tenancy is not supported for the ImportInstance command.

\n

This parameter is not supported by CreateFleet.

", + "smithy.api#xmlName": "tenancy" } }, "AvailabilityZone": { @@ -42322,20 +43781,12 @@ "smithy.api#xmlName": "hostId" } }, - "HostResourceGroupArn": { + "SpreadDomain": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "HostResourceGroupArn", - "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances. If you specify \n \t\ta host resource group ARN, omit the Tenancy \n \t\tparameter or set it to host.

\n

This parameter is not supported by CreateFleet.

", - "smithy.api#xmlName": "hostResourceGroupArn" - } - }, - "Tenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware. The host\n tenancy is not supported for the ImportInstance command.

\n

This parameter is not supported by CreateFleet.

", - "smithy.api#xmlName": "tenancy" + "aws.protocols#ec2QueryName": "SpreadDomain", + "smithy.api#documentation": "

Reserved for future use.

\n

This parameter is not supported by CreateFleet.

", + "smithy.api#xmlName": "spreadDomain" } } }, @@ -42346,12 +43797,12 @@ "com.amazonaws.ec2#PlacementGroup": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#PlacementGroupState", + "GroupId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the placement group.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the placement group.

", + "smithy.api#xmlName": "groupId" } }, "GroupName": { @@ -42362,12 +43813,12 @@ "smithy.api#xmlName": "groupName" } }, - "PartitionCount": { - "target": "com.amazonaws.ec2#Integer", + "Strategy": { + "target": "com.amazonaws.ec2#PlacementStrategy", "traits": { - "aws.protocols#ec2QueryName": "PartitionCount", - "smithy.api#documentation": "

The number of partitions. Valid only if strategy is\n set to partition.

", - "smithy.api#xmlName": "partitionCount" + "aws.protocols#ec2QueryName": "Strategy", + "smithy.api#documentation": "

The placement strategy.

", + "smithy.api#xmlName": "strategy" } }, "Tags": { @@ -42378,20 +43829,20 @@ "smithy.api#xmlName": "tagSet" } }, - "GroupId": { - "target": "com.amazonaws.ec2#String", + "PartitionCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the placement group.

", - "smithy.api#xmlName": "groupId" + "aws.protocols#ec2QueryName": "PartitionCount", + "smithy.api#documentation": "

The number of partitions. Valid only if strategy is\n set to partition.

", + "smithy.api#xmlName": "partitionCount" } }, - "Strategy": { - "target": "com.amazonaws.ec2#PlacementStrategy", + "State": { + "target": "com.amazonaws.ec2#PlacementGroupState", "traits": { - "aws.protocols#ec2QueryName": "Strategy", - "smithy.api#documentation": "

The placement strategy.

", - "smithy.api#xmlName": "strategy" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the placement group.

", + "smithy.api#xmlName": "state" } } }, @@ -42600,14 +44051,6 @@ "smithy.api#xmlName": "cidrSet" } }, - "PrefixListId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrefixListId", - "smithy.api#documentation": "

The ID of the prefix.

", - "smithy.api#xmlName": "prefixListId" - } - }, "PrefixListName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -42615,6 +44058,14 @@ "smithy.api#documentation": "

The name of the prefix.

", "smithy.api#xmlName": "prefixListName" } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix.

", + "smithy.api#xmlName": "prefixListId" + } } }, "traits": { @@ -42657,14 +44108,6 @@ "com.amazonaws.ec2#PrefixListEntry": { "type": "structure", "members": { - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Cidr", - "smithy.api#documentation": "

The CIDR block.

", - "smithy.api#xmlName": "cidr" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -42672,6 +44115,14 @@ "smithy.api#documentation": "

The description.

", "smithy.api#xmlName": "description" } + }, + "Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Cidr", + "smithy.api#documentation": "

The CIDR block.

", + "smithy.api#xmlName": "cidr" + } } }, "traits": { @@ -42805,14 +44256,6 @@ "com.amazonaws.ec2#PriceSchedule": { "type": "structure", "members": { - "Price": { - "target": "com.amazonaws.ec2#Double", - "traits": { - "aws.protocols#ec2QueryName": "Price", - "smithy.api#documentation": "

The fixed price for the term.

", - "smithy.api#xmlName": "price" - } - }, "CurrencyCode": { "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { @@ -42821,12 +44264,12 @@ "smithy.api#xmlName": "currencyCode" } }, - "Term": { - "target": "com.amazonaws.ec2#Long", + "Price": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "Term", - "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", - "smithy.api#xmlName": "term" + "aws.protocols#ec2QueryName": "Price", + "smithy.api#documentation": "

The fixed price for the term.

", + "smithy.api#xmlName": "price" } }, "Active": { @@ -42836,6 +44279,14 @@ "smithy.api#documentation": "

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

\n

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "smithy.api#xmlName": "active" } + }, + "Term": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Term", + "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "smithy.api#xmlName": "term" + } } }, "traits": { @@ -42862,14 +44313,6 @@ "smithy.api#xmlName": "term" } }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, "Price": { "target": "com.amazonaws.ec2#Double", "traits": { @@ -42877,6 +44320,14 @@ "smithy.api#documentation": "

The fixed price for the term.

", "smithy.api#xmlName": "price" } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } } }, "traits": { @@ -42895,14 +44346,6 @@ "com.amazonaws.ec2#PricingDetail": { "type": "structure", "members": { - "Count": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The number of reservations available for the price.

", - "smithy.api#xmlName": "count" - } - }, "Price": { "target": "com.amazonaws.ec2#Double", "traits": { @@ -42910,6 +44353,14 @@ "smithy.api#documentation": "

The price per instance.

", "smithy.api#xmlName": "price" } + }, + "Count": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Count", + "smithy.api#documentation": "

The number of reservations available for the price.

", + "smithy.api#xmlName": "count" + } } }, "traits": { @@ -42992,12 +44443,12 @@ "com.amazonaws.ec2#PrivateDnsNameConfiguration": { "type": "structure", "members": { - "Type": { + "Name": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The endpoint service verification type, for example TXT.

", - "smithy.api#xmlName": "type" + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.

", + "smithy.api#xmlName": "name" } }, "State": { @@ -43008,14 +44459,6 @@ "smithy.api#xmlName": "state" } }, - "Name": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.

", - "smithy.api#xmlName": "name" - } - }, "Value": { "target": "com.amazonaws.ec2#String", "traits": { @@ -43023,6 +44466,14 @@ "smithy.api#documentation": "

The value the service provider adds to the private DNS name domain record before verification.

", "smithy.api#xmlName": "value" } + }, + "Type": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The endpoint service verification type, for example TXT.

", + "smithy.api#xmlName": "type" + } } }, "traits": { @@ -43041,14 +44492,6 @@ "com.amazonaws.ec2#PrivateIpAddressSpecification": { "type": "structure", "members": { - "Primary": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Primary", - "smithy.api#documentation": "

Indicates whether the private IPv4 address is the primary private IPv4 address. Only\n one IPv4 address can be designated as primary.

", - "smithy.api#xmlName": "primary" - } - }, "PrivateIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -43056,6 +44499,14 @@ "smithy.api#documentation": "

The private IPv4 addresses.

", "smithy.api#xmlName": "privateIpAddress" } + }, + "Primary": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Primary", + "smithy.api#documentation": "

Indicates whether the private IPv4 address is the primary private IPv4 address. Only\n one IPv4 address can be designated as primary.

", + "smithy.api#xmlName": "primary" + } } }, "traits": { @@ -43083,14 +44534,6 @@ "com.amazonaws.ec2#ProcessorInfo": { "type": "structure", "members": { - "SupportedArchitectures": { - "target": "com.amazonaws.ec2#ArchitectureTypeList", - "traits": { - "aws.protocols#ec2QueryName": "SupportedArchitectures", - "smithy.api#documentation": "

A list of architectures supported by the instance type.

", - "smithy.api#xmlName": "supportedArchitectures" - } - }, "SustainedClockSpeedInGhz": { "target": "com.amazonaws.ec2#ProcessorSustainedClockSpeed", "traits": { @@ -43098,6 +44541,14 @@ "smithy.api#documentation": "

The speed of the processor, in GHz.

", "smithy.api#xmlName": "sustainedClockSpeedInGhz" } + }, + "SupportedArchitectures": { + "target": "com.amazonaws.ec2#ArchitectureTypeList", + "traits": { + "aws.protocols#ec2QueryName": "SupportedArchitectures", + "smithy.api#documentation": "

A list of architectures supported by the instance type.

", + "smithy.api#xmlName": "supportedArchitectures" + } } }, "traits": { @@ -43113,14 +44564,6 @@ "com.amazonaws.ec2#ProductCode": { "type": "structure", "members": { - "ProductCodeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ProductCode", - "smithy.api#documentation": "

The product code.

", - "smithy.api#xmlName": "productCode" - } - }, "ProductCodeType": { "target": "com.amazonaws.ec2#ProductCodeValues", "traits": { @@ -43128,6 +44571,14 @@ "smithy.api#documentation": "

The type of product code.

", "smithy.api#xmlName": "type" } + }, + "ProductCodeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ProductCode", + "smithy.api#documentation": "

The product code.

", + "smithy.api#xmlName": "productCode" + } } }, "traits": { @@ -43211,6 +44662,18 @@ "com.amazonaws.ec2#ProvisionByoipCidrRequest": { "type": "structure", "members": { + "PubliclyAdvertisable": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.

\n

Default: true

" + } + }, + "CidrAuthorizationContext": { + "target": "com.amazonaws.ec2#CidrAuthorizationContext", + "traits": { + "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address \n range to Amazon using BYOIP.

" + } + }, "PoolTagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -43218,10 +44681,11 @@ "smithy.api#xmlName": "PoolTagSpecification" } }, - "PubliclyAdvertisable": { - "target": "com.amazonaws.ec2#Boolean", + "Cidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.

\n

Default: true

" + "smithy.api#documentation": "

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can \n specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've \n brought to this or another Region.

", + "smithy.api#required": {} } }, "DryRun": { @@ -43235,19 +44699,6 @@ "traits": { "smithy.api#documentation": "

A description for the address range and the address pool.

" } - }, - "CidrAuthorizationContext": { - "target": "com.amazonaws.ec2#CidrAuthorizationContext", - "traits": { - "smithy.api#documentation": "

A signed document that proves that you are authorized to bring the specified IP address \n range to Amazon using BYOIP.

" - } - }, - "Cidr": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can \n specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've \n brought to this or another Region.

", - "smithy.api#required": {} - } } } }, @@ -43267,28 +44718,28 @@ "com.amazonaws.ec2#ProvisionedBandwidth": { "type": "structure", "members": { - "Requested": { + "Status": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Requested", + "aws.protocols#ec2QueryName": "Status", "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "requested" + "smithy.api#xmlName": "status" } }, - "RequestTime": { - "target": "com.amazonaws.ec2#DateTime", + "Provisioned": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RequestTime", + "aws.protocols#ec2QueryName": "Provisioned", "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "requestTime" + "smithy.api#xmlName": "provisioned" } }, - "Status": { - "target": "com.amazonaws.ec2#String", + "RequestTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Status", + "aws.protocols#ec2QueryName": "RequestTime", "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "status" + "smithy.api#xmlName": "requestTime" } }, "ProvisionTime": { @@ -43299,12 +44750,12 @@ "smithy.api#xmlName": "provisionTime" } }, - "Provisioned": { + "Requested": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Provisioned", + "aws.protocols#ec2QueryName": "Requested", "smithy.api#documentation": "

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", - "smithy.api#xmlName": "provisioned" + "smithy.api#xmlName": "requested" } } }, @@ -43335,20 +44786,20 @@ "smithy.api#xmlName": "networkBorderGroup" } }, - "TotalAddressCount": { - "target": "com.amazonaws.ec2#Integer", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "TotalAddressCount", - "smithy.api#documentation": "

The total number of addresses.

", - "smithy.api#xmlName": "totalAddressCount" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags for the address pool.

", + "smithy.api#xmlName": "tagSet" } }, - "PoolId": { - "target": "com.amazonaws.ec2#String", + "PoolAddressRanges": { + "target": "com.amazonaws.ec2#PublicIpv4PoolRangeSet", "traits": { - "aws.protocols#ec2QueryName": "PoolId", - "smithy.api#documentation": "

The ID of the address pool.

", - "smithy.api#xmlName": "poolId" + "aws.protocols#ec2QueryName": "PoolAddressRangeSet", + "smithy.api#documentation": "

The address ranges.

", + "smithy.api#xmlName": "poolAddressRangeSet" } }, "TotalAvailableAddressCount": { @@ -43367,20 +44818,20 @@ "smithy.api#xmlName": "description" } }, - "PoolAddressRanges": { - "target": "com.amazonaws.ec2#PublicIpv4PoolRangeSet", + "TotalAddressCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "PoolAddressRangeSet", - "smithy.api#documentation": "

The address ranges.

", - "smithy.api#xmlName": "poolAddressRangeSet" + "aws.protocols#ec2QueryName": "TotalAddressCount", + "smithy.api#documentation": "

The total number of addresses.

", + "smithy.api#xmlName": "totalAddressCount" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "PoolId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags for the address pool.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "PoolId", + "smithy.api#documentation": "

The ID of the address pool.

", + "smithy.api#xmlName": "poolId" } } }, @@ -43408,12 +44859,12 @@ "smithy.api#xmlName": "lastAddress" } }, - "AvailableAddressCount": { + "AddressCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "AvailableAddressCount", - "smithy.api#documentation": "

The number of available addresses in the range.

", - "smithy.api#xmlName": "availableAddressCount" + "aws.protocols#ec2QueryName": "AddressCount", + "smithy.api#documentation": "

The number of addresses in the range.

", + "smithy.api#xmlName": "addressCount" } }, "FirstAddress": { @@ -43424,12 +44875,12 @@ "smithy.api#xmlName": "firstAddress" } }, - "AddressCount": { + "AvailableAddressCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "AddressCount", - "smithy.api#documentation": "

The number of addresses in the range.

", - "smithy.api#xmlName": "addressCount" + "aws.protocols#ec2QueryName": "AvailableAddressCount", + "smithy.api#documentation": "

The number of available addresses in the range.

", + "smithy.api#xmlName": "availableAddressCount" } } }, @@ -43458,12 +44909,12 @@ "com.amazonaws.ec2#Purchase": { "type": "structure", "members": { - "PaymentOption": { - "target": "com.amazonaws.ec2#PaymentOption", + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { - "aws.protocols#ec2QueryName": "PaymentOption", - "smithy.api#documentation": "

The payment option for the reservation.

", - "smithy.api#xmlName": "paymentOption" + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the UpfrontPrice and HourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", + "smithy.api#xmlName": "currencyCode" } }, "HostReservationId": { @@ -43474,28 +44925,20 @@ "smithy.api#xmlName": "hostReservationId" } }, - "InstanceFamily": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceFamily", - "smithy.api#documentation": "

The instance family on the Dedicated Host that the reservation can be associated\n with.

", - "smithy.api#xmlName": "instanceFamily" - } - }, - "HostIdSet": { - "target": "com.amazonaws.ec2#ResponseHostIdSet", + "Duration": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "HostIdSet", - "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", - "smithy.api#xmlName": "hostIdSet" + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the reservation's term in seconds.

", + "smithy.api#xmlName": "duration" } }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", + "UpfrontPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the UpfrontPrice and HourlyPrice\n amounts are specified. At this time, the only supported currency is\n USD.

", - "smithy.api#xmlName": "currencyCode" + "aws.protocols#ec2QueryName": "UpfrontPrice", + "smithy.api#documentation": "

The upfront price of the reservation.

", + "smithy.api#xmlName": "upfrontPrice" } }, "HourlyPrice": { @@ -43506,20 +44949,28 @@ "smithy.api#xmlName": "hourlyPrice" } }, - "Duration": { - "target": "com.amazonaws.ec2#Integer", + "HostIdSet": { + "target": "com.amazonaws.ec2#ResponseHostIdSet", "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#documentation": "

The duration of the reservation's term in seconds.

", - "smithy.api#xmlName": "duration" + "aws.protocols#ec2QueryName": "HostIdSet", + "smithy.api#documentation": "

The IDs of the Dedicated Hosts associated with the reservation.

", + "smithy.api#xmlName": "hostIdSet" } }, - "UpfrontPrice": { + "PaymentOption": { + "target": "com.amazonaws.ec2#PaymentOption", + "traits": { + "aws.protocols#ec2QueryName": "PaymentOption", + "smithy.api#documentation": "

The payment option for the reservation.

", + "smithy.api#xmlName": "paymentOption" + } + }, + "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UpfrontPrice", - "smithy.api#documentation": "

The upfront price of the reservation.

", - "smithy.api#xmlName": "upfrontPrice" + "aws.protocols#ec2QueryName": "InstanceFamily", + "smithy.api#documentation": "

The instance family on the Dedicated Host that the reservation can be associated\n with.

", + "smithy.api#xmlName": "instanceFamily" } } }, @@ -43542,43 +44993,43 @@ "com.amazonaws.ec2#PurchaseHostReservationRequest": { "type": "structure", "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "HostIdSet": { + "target": "com.amazonaws.ec2#RequestHostIdSet", "traits": { - "smithy.api#documentation": "

The tags to apply to the Dedicated Host Reservation during purchase.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation will be associated.

", + "smithy.api#required": {} } }, - "LimitPrice": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The specified limit is checked against the total upfront cost of the reservation\n (calculated as the offering's upfront cost multiplied by the host count). If the total\n upfront cost is greater than the specified price limit, the request fails. This is used\n to ensure that the purchase does not exceed the expected upfront cost of the purchase.\n At this time, the only supported currency is USD. For example, to indicate\n a limit price of USD 100, specify 100.00.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", + "OfferingId": { + "target": "com.amazonaws.ec2#OfferingId", "traits": { - "smithy.api#documentation": "

The currency in which the totalUpfrontPrice, LimitPrice,\n and totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

" + "smithy.api#documentation": "

The ID of the offering.

", + "smithy.api#required": {} } }, - "HostIdSet": { - "target": "com.amazonaws.ec2#RequestHostIdSet", + "LimitPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IDs of the Dedicated Hosts with which the reservation will be associated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The specified limit is checked against the total upfront cost of the reservation\n (calculated as the offering's upfront cost multiplied by the host count). If the total\n upfront cost is greater than the specified price limit, the request fails. This is used\n to ensure that the purchase does not exceed the expected upfront cost of the purchase.\n At this time, the only supported currency is USD. For example, to indicate\n a limit price of USD 100, specify 100.00.

" } }, - "OfferingId": { - "target": "com.amazonaws.ec2#OfferingId", + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { - "smithy.api#documentation": "

The ID of the offering.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The currency in which the totalUpfrontPrice, LimitPrice,\n and totalHourlyPrice amounts are specified. At this time, the only\n supported currency is USD.

" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + "smithy.api#documentation": "

The tags to apply to the Dedicated Host Reservation during purchase.

", + "smithy.api#xmlName": "TagSpecification" } } } @@ -43586,6 +45037,14 @@ "com.amazonaws.ec2#PurchaseHostReservationResult": { "type": "structure", "members": { + "TotalHourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TotalHourlyPrice", + "smithy.api#documentation": "

The total hourly price of the reservation calculated per hour.

", + "smithy.api#xmlName": "totalHourlyPrice" + } + }, "CurrencyCode": { "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { @@ -43594,6 +45053,14 @@ "smithy.api#xmlName": "currencyCode" } }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, "Purchase": { "target": "com.amazonaws.ec2#PurchaseSet", "traits": { @@ -43609,39 +45076,23 @@ "smithy.api#documentation": "

The total amount charged to your account when you purchase the reservation.

", "smithy.api#xmlName": "totalUpfrontPrice" } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "TotalHourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TotalHourlyPrice", - "smithy.api#documentation": "

The total hourly price of the reservation calculated per hour.

", - "smithy.api#xmlName": "totalHourlyPrice" - } } } }, "com.amazonaws.ec2#PurchaseRequest": { "type": "structure", "members": { - "PurchaseToken": { - "target": "com.amazonaws.ec2#String", + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The purchase token.

", + "smithy.api#documentation": "

The number of instances.

", "smithy.api#required": {} } }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "PurchaseToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The number of instances.

", + "smithy.api#documentation": "

The purchase token.

", "smithy.api#required": {} } } @@ -43679,12 +45130,10 @@ "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "PurchaseTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#documentation": "

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" } }, "ReservedInstancesOfferingId": { @@ -43709,10 +45158,12 @@ "smithy.api#xmlName": "limitPrice" } }, - "PurchaseTime": { - "target": "com.amazonaws.ec2#DateTime", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" + "aws.protocols#ec2QueryName": "DryRun", + "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" } } }, @@ -43751,13 +45202,6 @@ "com.amazonaws.ec2#PurchaseScheduledInstancesRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, "PurchaseRequests": { "target": "com.amazonaws.ec2#PurchaseRequestSet", "traits": { @@ -43771,6 +45215,13 @@ "traits": { "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.

" } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} + } } }, "traits": { @@ -43854,14 +45305,6 @@ "com.amazonaws.ec2#RebootInstancesRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { @@ -43869,6 +45312,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "InstanceId" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -43980,82 +45431,90 @@ "com.amazonaws.ec2#RegisterImageRequest": { "type": "structure", "members": { - "SriovNetSupport": { - "target": "com.amazonaws.ec2#String", + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

\n

There is no way to disable sriovNetSupport at this time.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", - "smithy.api#xmlName": "sriovNetSupport" + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" } }, - "ImageLocation": { - "target": "com.amazonaws.ec2#String", + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the \n \t\taws-exec-read canned access control list (ACL) to ensure that it can be accessed \n \t\tby Amazon EC2. For more information, see Canned ACLs in the \n \t\tAmazon S3 Service Developer Guide.

" + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" } }, - "RootDeviceName": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, + "VirtualizationType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RootDeviceName", - "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", - "smithy.api#xmlName": "rootDeviceName" + "aws.protocols#ec2QueryName": "VirtualizationType", + "smithy.api#documentation": "

The type of virtualization (hvm | paravirtual).

\n

Default: paravirtual\n

", + "smithy.api#xmlName": "virtualizationType" } }, - "BillingProducts": { - "target": "com.amazonaws.ec2#BillingProductList", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", "traits": { - "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise,\n you can use the AWS Marketplace to bill for the use of an AMI.

", - "smithy.api#xmlName": "BillingProduct" + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "BlockDeviceMapping" } }, - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", - "smithy.api#xmlName": "architecture" + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "enaSupport" } }, - "VirtualizationType": { + "Name": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VirtualizationType", - "smithy.api#documentation": "

The type of virtualization (hvm | paravirtual).

\n

Default: paravirtual\n

", - "smithy.api#xmlName": "virtualizationType" + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

A name for your AMI.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "smithy.api#required": {}, + "smithy.api#xmlName": "name" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", + "smithy.api#xmlName": "architecture" } }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

\n

There is no way to disable sriovNetSupport at this time.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" } }, - "RamdiskId": { - "target": "com.amazonaws.ec2#RamdiskId", + "RootDeviceName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk.

", - "smithy.api#xmlName": "ramdiskId" + "aws.protocols#ec2QueryName": "RootDeviceName", + "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

", + "smithy.api#xmlName": "rootDeviceName" } }, - "Name": { + "ImageLocation": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Name", - "smithy.api#documentation": "

A name for your AMI.

\n

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", - "smithy.api#required": {}, - "smithy.api#xmlName": "name" + "smithy.api#documentation": "

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the \n \t\taws-exec-read canned access control list (ACL) to ensure that it can be accessed \n \t\tby Amazon EC2. For more information, see Canned ACLs in the \n \t\tAmazon S3 Service Developer Guide.

" } }, "Description": { @@ -44066,19 +45525,11 @@ "smithy.api#xmlName": "description" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", - "traits": { - "smithy.api#documentation": "

The block device mapping entries.

", - "smithy.api#xmlName": "BlockDeviceMapping" - } - }, - "EnaSupport": { - "target": "com.amazonaws.ec2#Boolean", + "BillingProducts": { + "target": "com.amazonaws.ec2#BillingProductList", "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", - "smithy.api#xmlName": "enaSupport" + "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise,\n you can use the AWS Marketplace to bill for the use of an AMI.

", + "smithy.api#xmlName": "BillingProduct" } } }, @@ -44117,17 +45568,17 @@ "com.amazonaws.ec2#RegisterInstanceEventNotificationAttributesRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "InstanceTagAttribute": { "target": "com.amazonaws.ec2#RegisterInstanceTagAttributeRequest", "traits": { "smithy.api#documentation": "

Information about the tag keys to register.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -44180,18 +45631,6 @@ "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest": { "type": "structure", "members": { - "NetworkInterfaceIds": { - "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", - "traits": { - "smithy.api#documentation": "

The group members' network interface IDs to register with the transit gateway multicast group.

" - } - }, - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -44203,6 +45642,18 @@ "traits": { "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" } + }, + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#TransitGatewayNetworkInterfaceIdList", + "traits": { + "smithy.api#documentation": "

The group members' network interface IDs to register with the transit gateway multicast group.

" + } } } }, @@ -44240,10 +45691,10 @@ "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", "traits": { - "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#documentation": "

The ID of the transit gateway multicast domain.

" } }, "NetworkInterfaceIds": { @@ -44252,10 +45703,10 @@ "smithy.api#documentation": "

The group sources' network interface IDs to register with the transit gateway multicast group.

" } }, - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + "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.

" } } } @@ -44331,18 +45782,18 @@ "com.amazonaws.ec2#RejectTransitGatewayVpcAttachmentRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { "smithy.api#documentation": "

The ID of the attachment.

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -44374,12 +45825,11 @@ "com.amazonaws.ec2#RejectVpcEndpointConnectionsRequest": { "type": "structure", "members": { - "VpcEndpointIds": { - "target": "com.amazonaws.ec2#VpcEndpointIdList", + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", "traits": { - "smithy.api#documentation": "

The IDs of one or more VPC endpoints.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "VpcEndpointId" + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#required": {} } }, "DryRun": { @@ -44388,11 +45838,12 @@ "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.

" } }, - "ServiceId": { - "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "VpcEndpointIds": { + "target": "com.amazonaws.ec2#VpcEndpointIdList", "traits": { - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IDs of one or more VPC endpoints.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "VpcEndpointId" } } } @@ -44425,14 +45876,6 @@ "com.amazonaws.ec2#RejectVpcPeeringConnectionRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "VpcPeeringConnectionId": { "target": "com.amazonaws.ec2#VpcPeeringConnectionId", "traits": { @@ -44441,6 +45884,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcPeeringConnectionId" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -44477,10 +45928,10 @@ "smithy.api#xmlName": "dryRun" } }, - "NetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", + "AllocationId": { + "target": "com.amazonaws.ec2#AllocationId", "traits": { - "smithy.api#documentation": "

The location that the IP address is released from.

\n

If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes.

\n \n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

\n " + "smithy.api#documentation": "

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } }, "PublicIp": { @@ -44489,10 +45940,10 @@ "smithy.api#documentation": "

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" } }, - "AllocationId": { - "target": "com.amazonaws.ec2#AllocationId", + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + "smithy.api#documentation": "

The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises\n IP addresses.

\n

If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes.

\n \n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

\n " } } } @@ -44630,6 +46081,15 @@ "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest": { "type": "structure", "members": { + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the new network ACL to associate with the subnet.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkAclId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -44646,15 +46106,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "associationId" } - }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#documentation": "

The ID of the new network ACL to associate with the subnet.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } } } }, @@ -44683,30 +46134,28 @@ "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest": { "type": "structure", "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n 172.16.0.0/24).

", - "smithy.api#xmlName": "cidrBlock" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", + "Protocol": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n\t\t

Default: If no value is specified, we replace the ingress rule.

", + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n allowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", "smithy.api#required": {}, - "smithy.api#xmlName": "egress" + "smithy.api#xmlName": "protocol" } }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#documentation": "

The rule number of the entry to replace.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "ruleNumber" + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol\n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" } }, "RuleAction": { @@ -44718,21 +46167,13 @@ "smithy.api#xmlName": "ruleAction" } }, - "Protocol": { - "target": "com.amazonaws.ec2#String", + "NetworkAclId": { + "target": "com.amazonaws.ec2#NetworkAclId", "traits": { - "aws.protocols#ec2QueryName": "Protocol", - "smithy.api#documentation": "

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a\n protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is \n allowed, regardless of any ports or ICMP types or codes that you specify. If you specify \n protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and \n codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) \n and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "aws.protocols#ec2QueryName": "NetworkAclId", + "smithy.api#documentation": "

The ID of the ACL.

", "smithy.api#required": {}, - "smithy.api#xmlName": "protocol" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" + "smithy.api#xmlName": "networkAclId" } }, "PortRange": { @@ -44743,6 +46184,23 @@ "smithy.api#xmlName": "portRange" } }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n\t\t

Default: If no value is specified, we replace the ingress rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n 172.16.0.0/24).

", + "smithy.api#xmlName": "cidrBlock" + } + }, "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { @@ -44751,20 +46209,13 @@ "smithy.api#xmlName": "ipv6CidrBlock" } }, - "NetworkAclId": { - "target": "com.amazonaws.ec2#NetworkAclId", + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "NetworkAclId", - "smithy.api#documentation": "

The ID of the ACL.

", + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#documentation": "

The rule number of the entry to replace.

", "smithy.api#required": {}, - "smithy.api#xmlName": "networkAclId" - } - }, - "IcmpTypeCode": { - "target": "com.amazonaws.ec2#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol\n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", - "smithy.api#xmlName": "Icmp" + "smithy.api#xmlName": "ruleNumber" } } } @@ -44781,6 +46232,50 @@ "com.amazonaws.ec2#ReplaceRouteRequest": { "type": "structure", "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a carrier gateway.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" + } + }, + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the prefix list for the route.

" + } + }, "RouteTableId": { "target": "com.amazonaws.ec2#RouteTableId", "traits": { @@ -44790,12 +46285,6 @@ "smithy.api#xmlName": "routeTableId" } }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of a transit gateway.

" - } - }, "DestinationIpv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { @@ -44804,16 +46293,12 @@ "smithy.api#xmlName": "destinationIpv6CidrBlock" } }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", - "traits": { - "smithy.api#documentation": "

The ID of the local gateway.

" - } - }, - "LocalTarget": { - "target": "com.amazonaws.ec2#Boolean", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "

Specifies whether to reset the local route to its default target (local).

" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", + "smithy.api#xmlName": "instanceId" } }, "DestinationCidrBlock": { @@ -44824,42 +46309,16 @@ "smithy.api#xmlName": "destinationCidrBlock" } }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the prefix list for the route.

" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#RouteGatewayId", + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway.

", - "smithy.api#xmlName": "gatewayId" + "smithy.api#documentation": "

The ID of the local gateway.

" } }, - "DryRun": { + "LocalTarget": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" - } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionId", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of a VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" + "smithy.api#documentation": "

Specifies whether to reset the local route to its default target (local).

" } }, "NetworkInterfaceId": { @@ -44870,20 +46329,18 @@ "smithy.api#xmlName": "networkInterfaceId" } }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionId", "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", - "smithy.api#xmlName": "instanceId" + "smithy.api#documentation": "

The ID of a transit gateway.

" } } } @@ -44911,15 +46368,6 @@ "smithy.api#xmlName": "dryRun" } }, - "AssociationId": { - "target": "com.amazonaws.ec2#RouteTableAssociationId", - "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The association ID.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "associationId" - } - }, "RouteTableId": { "target": "com.amazonaws.ec2#RouteTableId", "traits": { @@ -44928,20 +46376,21 @@ "smithy.api#required": {}, "smithy.api#xmlName": "routeTableId" } + }, + "AssociationId": { + "target": "com.amazonaws.ec2#RouteTableAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "associationId" + } } } }, "com.amazonaws.ec2#ReplaceRouteTableAssociationResult": { "type": "structure", "members": { - "NewAssociationId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NewAssociationId", - "smithy.api#documentation": "

The ID of the new association.

", - "smithy.api#xmlName": "newAssociationId" - } - }, "AssociationState": { "target": "com.amazonaws.ec2#RouteTableAssociationState", "traits": { @@ -44949,6 +46398,14 @@ "smithy.api#documentation": "

The state of the association.

", "smithy.api#xmlName": "associationState" } + }, + "NewAssociationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NewAssociationId", + "smithy.api#documentation": "

The ID of the new association.

", + "smithy.api#xmlName": "newAssociationId" + } } } }, @@ -44967,10 +46424,16 @@ "com.amazonaws.ec2#ReplaceTransitGatewayRouteRequest": { "type": "structure", "members": { - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the attachment.

" + "smithy.api#documentation": "

Indicates whether traffic matching this route is to be dropped.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" } }, "TransitGatewayRouteTableId": { @@ -44980,24 +46443,18 @@ "smithy.api#required": {} } }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

" + } + }, "DestinationCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

", "smithy.api#required": {} } - }, - "Blackhole": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether traffic matching this route is to be dropped.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -45060,6 +46517,14 @@ "com.amazonaws.ec2#ReportInstanceStatusRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "StartTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -45068,12 +46533,21 @@ "smithy.api#xmlName": "startTime" } }, - "EndTime": { - "target": "com.amazonaws.ec2#DateTime", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EndTime", - "smithy.api#documentation": "

The time at which the reported instance health state ended.

", - "smithy.api#xmlName": "endTime" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

Descriptive text about the health state of your instance.

", + "smithy.api#xmlName": "description" + } + }, + "Status": { + "target": "com.amazonaws.ec2#ReportStatusType", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of all instances listed.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "status" } }, "Instances": { @@ -45085,6 +46559,14 @@ "smithy.api#xmlName": "instanceId" } }, + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The time at which the reported instance health state ended.

", + "smithy.api#xmlName": "endTime" + } + }, "ReasonCodes": { "target": "com.amazonaws.ec2#ReasonCodesList", "traits": { @@ -45093,31 +46575,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "reasonCode" } - }, - "Status": { - "target": "com.amazonaws.ec2#ReportStatusType", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of all instances listed.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "status" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

Descriptive text about the health state of your instance.

", - "smithy.api#xmlName": "description" - } } } }, @@ -45167,54 +46624,49 @@ "com.amazonaws.ec2#RequestLaunchTemplateData": { "type": "structure", "members": { - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", - "traits": { - "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify\n any security groups and subnets as part of the network interface.

", - "smithy.api#xmlName": "NetworkInterface" - } - }, - "RamDiskId": { - "target": "com.amazonaws.ec2#RamdiskId", + "TagSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User Provided\n Kernels in the Amazon Elastic Compute Cloud User\n Guide.

\n " + "smithy.api#documentation": "

The tags to apply to the resources during launch. You can only tag instances and\n volumes on launch. The specified tags are applied to all instances or volumes that are\n created during launch. To tag a resource after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" } }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from\n the instance (using the operating system command for system shutdown).

\n

Default: stop\n

" + "smithy.api#documentation": "

The instance type. For more information, see Instance Types in the\n Amazon Elastic Compute Cloud User Guide.

" } }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#Boolean", + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", "traits": { - "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n \t\tthe Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, \n \t\tuse ModifyInstanceAttribute.\n \t\tAlternatively, if you set InstanceInitiatedShutdownBehavior to\n \t\tterminate, you can terminate the instance by running the shutdown\n \t\tcommand from the instance.

" + "smithy.api#documentation": "

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC,\n you must use security group IDs instead. You cannot specify both a security group ID and\n security name in the same request.

", + "smithy.api#xmlName": "SecurityGroup" } }, - "HibernationOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest", + "UserData": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For\n more information, see Hibernate Your Instance in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance. For more\n information, see Running Commands on Your Linux Instance\n at Launch (Linux) and Adding User Data (Windows).

" } }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", + "Monitoring": { + "target": "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

" + "smithy.api#documentation": "

The monitoring for the instance.

" } }, - "CpuOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest", + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", "traits": { - "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User\n\t\t\t\tGuide.

" + "smithy.api#documentation": "

The ID of the AMI.

" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", "traits": { - "smithy.api#documentation": "

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and\n security name in the same request.

", - "smithy.api#xmlName": "SecurityGroupId" + "smithy.api#documentation": "

One or more network interfaces. If you specify a network interface, you must specify\n any security groups and subnets as part of the network interface.

", + "smithy.api#xmlName": "NetworkInterface" } }, "ElasticInferenceAccelerators": { @@ -45224,17 +46676,10 @@ "smithy.api#xmlName": "ElasticInferenceAccelerator" } }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest", - "traits": { - "smithy.api#documentation": "

The license configurations.

", - "smithy.api#xmlName": "LicenseSpecification" - } - }, - "CreditSpecification": { - "target": "com.amazonaws.ec2#CreditSpecificationRequest", + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances\n only.

" + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User Provided\n Kernels in the Amazon Elastic Compute Cloud User\n Guide.

\n " } }, "MetadataOptions": { @@ -45243,48 +46688,47 @@ "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance Metadata and User Data in the\n Amazon Elastic Compute Cloud User Guide.

" } }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest", + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The Capacity Reservation targeting option. If you do not specify this parameter, the \n\t\t\tinstance's Capacity Reservation preference defaults to open, which enables it\n\t\t\tto run in any open Capacity Reservation that has matching attributes (instance type, \n\t\t\tplatform, Availability Zone).

" + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

" } }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest", + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IAM instance profile.

" + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n \t\tthe Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, \n \t\tuse ModifyInstanceAttribute.\n \t\tAlternatively, if you set InstanceInitiatedShutdownBehavior to\n \t\tterminate, you can terminate the instance by running the shutdown\n \t\tcommand from the instance.

" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList", + "HibernationOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest", "traits": { - "smithy.api#documentation": "

The block device mapping.

", - "smithy.api#xmlName": "BlockDeviceMapping" + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For\n more information, see Hibernate Your Instance in the\n Amazon Elastic Compute Cloud User Guide.

" } }, - "UserData": { - "target": "com.amazonaws.ec2#String", + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#LaunchTemplateIamInstanceProfileSpecificationRequest", "traits": { - "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance. For more\n information, see Running Commands on Your Linux Instance\n at Launch (Linux) and Adding User Data (Windows).

" + "smithy.api#documentation": "

The IAM instance profile.

" } }, - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseSpecificationListRequest", "traits": { - "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "LicenseSpecification" } }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationRequest", "traits": { - "smithy.api#documentation": "

The ID of the AMI.

" + "smithy.api#documentation": "

The Capacity Reservation targeting option. If you do not specify this parameter, the \n\t\t\tinstance's Capacity Reservation preference defaults to open, which enables it\n\t\t\tto run in any open Capacity Reservation that has matching attributes (instance type, \n\t\t\tplatform, Availability Zone).

" } }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#SecurityGroupStringList", + "CpuOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateCpuOptionsRequest", "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC,\n you must use security group IDs instead. You cannot specify both a security group ID and\n security name in the same request.

", - "smithy.api#xmlName": "SecurityGroup" + "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User\n\t\t\t\tGuide.

" } }, "InstanceMarketOptions": { @@ -45293,29 +46737,29 @@ "smithy.api#documentation": "

The market (purchasing) option for the instances.

" } }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecificationRequest", "traits": { - "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User Provided\n Kernels in the Amazon Elastic Compute Cloud User\n Guide.

\n " + "smithy.api#documentation": "

The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances\n only.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", "traits": { - "smithy.api#documentation": "

The tags to apply to the resources during launch. You can only tag instances and\n volumes on launch. The specified tags are applied to all instances or volumes that are\n created during launch. To tag a resource after it has been created, see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " } }, - "Placement": { - "target": "com.amazonaws.ec2#LaunchTemplatePlacementRequest", + "RamDiskId": { + "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "smithy.api#documentation": "

The placement for the instance.

" + "smithy.api#documentation": "

The ID of the RAM disk.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User Provided\n Kernels in the Amazon Elastic Compute Cloud User\n Guide.

\n " } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingRequestList", "traits": { - "smithy.api#documentation": "

The instance type. For more information, see Instance Types in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The block device mapping.

", + "smithy.api#xmlName": "BlockDeviceMapping" } }, "ElasticGpuSpecifications": { @@ -45325,10 +46769,23 @@ "smithy.api#xmlName": "ElasticGpuSpecification" } }, - "Monitoring": { - "target": "com.amazonaws.ec2#LaunchTemplatesMonitoringRequest", + "Placement": { + "target": "com.amazonaws.ec2#LaunchTemplatePlacementRequest", "traits": { - "smithy.api#documentation": "

The monitoring for the instance.

" + "smithy.api#documentation": "

The placement for the instance.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and\n security name in the same request.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from\n the instance (using the operating system command for system shutdown).

\n

Default: stop\n

" } } }, @@ -45351,6 +46808,14 @@ "com.amazonaws.ec2#RequestSpotFleetRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } + }, "SpotFleetRequestConfig": { "target": "com.amazonaws.ec2#SpotFleetRequestConfigData", "traits": { @@ -45359,14 +46824,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "spotFleetRequestConfig" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } } }, "traits": { @@ -45404,26 +46861,41 @@ "com.amazonaws.ec2#RequestSpotInstancesRequest": { "type": "structure", "members": { - "ClientToken": { + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

\n \t

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

", + "smithy.api#xmlName": "validFrom" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" + } + }, + "LaunchGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see How to Ensure Idempotency \n in the Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#xmlName": "clientToken" + "aws.protocols#ec2QueryName": "LaunchGroup", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

\n

Default: Instances are launched and terminated individually

", + "smithy.api#xmlName": "launchGroup" } }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. \n If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

", - "smithy.api#xmlName": "validUntil" + "aws.protocols#ec2QueryName": "DryRun", + "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" } }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#RequestSpotLaunchSpecification", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The launch specification.

" + "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.\n

", + "smithy.api#xmlName": "TagSpecification" } }, "SpotPrice": { @@ -45434,6 +46906,14 @@ "smithy.api#xmlName": "spotPrice" } }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

\n

The duration period starts as soon as your Spot Instance receives its instance ID. At\n the end of the duration period, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute\n warning before it terminates.

\n

You can't specify an Availability Zone group or a launch group if you specify a\n duration.

", + "smithy.api#xmlName": "blockDurationMinutes" + } + }, "Type": { "target": "com.amazonaws.ec2#SpotInstanceType", "traits": { @@ -45442,33 +46922,18 @@ "smithy.api#xmlName": "type" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "LaunchSpecification": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecification", "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.\n

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The launch specification.

" } }, - "LaunchGroup": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

\n

Default: Instances are launched and terminated individually

", - "smithy.api#xmlName": "launchGroup" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", - "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" - } - }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

\n \t

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

", - "smithy.api#xmlName": "validFrom" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see How to Ensure Idempotency \n in the Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#xmlName": "clientToken" } }, "InstanceCount": { @@ -45487,20 +46952,12 @@ "smithy.api#xmlName": "availabilityZoneGroup" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

\n

The duration period starts as soon as your Spot Instance receives its instance ID. At\n the end of the duration period, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute\n warning before it terminates.

\n

You can't specify an Availability Zone group or a launch group if you specify a\n duration.

", - "smithy.api#xmlName": "blockDurationMinutes" + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. \n If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

", + "smithy.api#xmlName": "validUntil" } } }, @@ -45527,20 +46984,35 @@ "com.amazonaws.ec2#RequestSpotLaunchSpecification": { "type": "structure", "members": { - "RamdiskId": { - "target": "com.amazonaws.ec2#RamdiskId", + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk.

", - "smithy.api#xmlName": "ramdiskId" + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" } }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. \n This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, \n it is not blank and its encryption status is used for the volume encryption status.

", + "smithy.api#xmlName": "blockDeviceMapping" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList", + "traits": { + "smithy.api#documentation": "

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "smithy.api#xmlName": "SecurityGroup" } }, "Monitoring": { @@ -45551,34 +47023,36 @@ "smithy.api#xmlName": "monitoring" } }, - "UserData": { - "target": "com.amazonaws.ec2#String", + "Placement": { + "target": "com.amazonaws.ec2#SpotPlacement", "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The Base64-encoded user data for the instance. User data is limited to 16 KB.

", - "smithy.api#xmlName": "userData" + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The placement information for the instance.

", + "smithy.api#xmlName": "placement" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList", + "AddressingType": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more security group IDs.

", - "smithy.api#xmlName": "SecurityGroupId" + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" } }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" } }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupList", + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", "traits": { - "smithy.api#documentation": "

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", - "smithy.api#xmlName": "SecurityGroup" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The IDs of the subnets in which to launch the instance. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", + "smithy.api#xmlName": "subnetId" } }, "NetworkInterfaces": { @@ -45588,12 +47062,20 @@ "smithy.api#xmlName": "NetworkInterface" } }, - "Placement": { - "target": "com.amazonaws.ec2#SpotPlacement", + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The placement information for the instance.

", - "smithy.api#xmlName": "placement" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" } }, "KeyName": { @@ -45604,52 +47086,27 @@ "smithy.api#xmlName": "keyName" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk.

", + "smithy.api#xmlName": "ramdiskId" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "UserData": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. \n This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, \n it is not blank and its encryption status is used for the volume encryption status.

", - "smithy.api#xmlName": "blockDeviceMapping" + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The Base64-encoded user data for the instance. User data is limited to 16 KB.

", + "smithy.api#xmlName": "userData" } }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecificationSecurityGroupIdList", "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The IDs of the subnets in which to launch the instance. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", - "smithy.api#xmlName": "subnetId" - } - }, - "AddressingType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AddressingType", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "addressingType" + "smithy.api#documentation": "

One or more security group IDs.

", + "smithy.api#xmlName": "SecurityGroupId" } } }, @@ -45678,20 +47135,20 @@ "com.amazonaws.ec2#Reservation": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", + "OwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

[EC2-Classic only] The security groups.

", - "smithy.api#xmlName": "groupSet" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the reservation.

", + "smithy.api#xmlName": "ownerId" } }, - "Instances": { - "target": "com.amazonaws.ec2#InstanceList", + "ReservationId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

The instances.

", - "smithy.api#xmlName": "instancesSet" + "aws.protocols#ec2QueryName": "ReservationId", + "smithy.api#documentation": "

The ID of the reservation.

", + "smithy.api#xmlName": "reservationId" } }, "RequesterId": { @@ -45702,20 +47159,20 @@ "smithy.api#xmlName": "requesterId" } }, - "ReservationId": { - "target": "com.amazonaws.ec2#String", + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", "traits": { - "aws.protocols#ec2QueryName": "ReservationId", - "smithy.api#documentation": "

The ID of the reservation.

", - "smithy.api#xmlName": "reservationId" + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

[EC2-Classic only] The security groups.

", + "smithy.api#xmlName": "groupSet" } }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", + "Instances": { + "target": "com.amazonaws.ec2#InstanceList", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the reservation.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The instances.

", + "smithy.api#xmlName": "instancesSet" } } }, @@ -45761,14 +47218,6 @@ "com.amazonaws.ec2#ReservationValue": { "type": "structure", "members": { - "HourlyPrice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly rate of the reservation.

", - "smithy.api#xmlName": "hourlyPrice" - } - }, "RemainingUpfrontValue": { "target": "com.amazonaws.ec2#String", "traits": { @@ -45777,6 +47226,14 @@ "smithy.api#xmlName": "remainingUpfrontValue" } }, + "HourlyPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly rate of the reservation.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, "RemainingTotalValue": { "target": "com.amazonaws.ec2#String", "traits": { @@ -45802,14 +47259,6 @@ "com.amazonaws.ec2#ReservedInstanceLimitPrice": { "type": "structure", "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, "Amount": { "target": "com.amazonaws.ec2#Double", "traits": { @@ -45817,6 +47266,14 @@ "smithy.api#documentation": "

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "smithy.api#xmlName": "amount" } + }, + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", + "traits": { + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" + } } }, "traits": { @@ -45884,20 +47341,12 @@ "com.amazonaws.ec2#ReservedInstances": { "type": "structure", "members": { - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy of the instance.

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the resource.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The Reserved Instance product platform description.

", + "smithy.api#xmlName": "productDescription" } }, "AvailabilityZone": { @@ -45908,28 +47357,20 @@ "smithy.api#xmlName": "availabilityZone" } }, - "State": { - "target": "com.amazonaws.ec2#ReservedInstanceState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Reserved Instance purchase.

", - "smithy.api#xmlName": "state" - } - }, - "UsagePrice": { - "target": "com.amazonaws.ec2#Float", + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { - "aws.protocols#ec2QueryName": "UsagePrice", - "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", - "smithy.api#xmlName": "usagePrice" + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" } }, - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#String", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" } }, "Duration": { @@ -45940,20 +47381,36 @@ "smithy.api#xmlName": "duration" } }, - "Scope": { - "target": "com.amazonaws.ec2#scope", + "RecurringCharges": { + "target": "com.amazonaws.ec2#RecurringChargesList", "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

The scope of the Reserved Instance.

", - "smithy.api#xmlName": "scope" + "aws.protocols#ec2QueryName": "RecurringCharges", + "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", + "smithy.api#xmlName": "recurringCharges" } }, - "End": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of reservations purchased.

", + "smithy.api#xmlName": "instanceCount" + } + }, + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type.

", + "smithy.api#xmlName": "offeringType" + } + }, + "Start": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "End", - "smithy.api#documentation": "

The time when the Reserved Instance expires.

", - "smithy.api#xmlName": "end" + "aws.protocols#ec2QueryName": "Start", + "smithy.api#documentation": "

The date and time the Reserved Instance started.

", + "smithy.api#xmlName": "start" } }, "OfferingClass": { @@ -45964,36 +47421,36 @@ "smithy.api#xmlName": "offeringClass" } }, - "Start": { - "target": "com.amazonaws.ec2#DateTime", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "Start", - "smithy.api#documentation": "

The date and time the Reserved Instance started.

", - "smithy.api#xmlName": "start" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" } }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instance.

", + "smithy.api#xmlName": "instanceTenancy" } }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", + "UsagePrice": { + "target": "com.amazonaws.ec2#Float", "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type.

", - "smithy.api#xmlName": "offeringType" + "aws.protocols#ec2QueryName": "UsagePrice", + "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", + "smithy.api#xmlName": "usagePrice" } }, - "RecurringCharges": { - "target": "com.amazonaws.ec2#RecurringChargesList", + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RecurringCharges", - "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", - "smithy.api#xmlName": "recurringCharges" + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" } }, "FixedPrice": { @@ -46004,28 +47461,28 @@ "smithy.api#xmlName": "fixedPrice" } }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", + "Scope": { + "target": "com.amazonaws.ec2#scope", "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

The Reserved Instance product platform description.

", - "smithy.api#xmlName": "productDescription" + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

The scope of the Reserved Instance.

", + "smithy.api#xmlName": "scope" } }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "End": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#documentation": "

The number of reservations purchased.

", - "smithy.api#xmlName": "instanceCount" + "aws.protocols#ec2QueryName": "End", + "smithy.api#documentation": "

The time when the Reserved Instance expires.

", + "smithy.api#xmlName": "end" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "State": { + "target": "com.amazonaws.ec2#ReservedInstanceState", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Reserved Instance purchase.

", + "smithy.api#xmlName": "state" } } }, @@ -46036,14 +47493,6 @@ "com.amazonaws.ec2#ReservedInstancesConfiguration": { "type": "structure", "members": { - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", - "smithy.api#xmlName": "platform" - } - }, "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { @@ -46052,12 +47501,12 @@ "smithy.api#xmlName": "instanceType" } }, - "Scope": { - "target": "com.amazonaws.ec2#scope", + "Platform": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.

", - "smithy.api#xmlName": "scope" + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "smithy.api#xmlName": "platform" } }, "InstanceCount": { @@ -46075,6 +47524,14 @@ "smithy.api#documentation": "

The Availability Zone for the modified Reserved Instances.

", "smithy.api#xmlName": "availabilityZone" } + }, + "Scope": { + "target": "com.amazonaws.ec2#scope", + "traits": { + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.

", + "smithy.api#xmlName": "scope" + } } }, "traits": { @@ -46127,12 +47584,12 @@ "com.amazonaws.ec2#ReservedInstancesListing": { "type": "structure", "members": { - "StatusMessage": { - "target": "com.amazonaws.ec2#String", + "PriceSchedules": { + "target": "com.amazonaws.ec2#PriceScheduleList", "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The reason for the current status of the Reserved Instance listing. The response can be blank.

", - "smithy.api#xmlName": "statusMessage" + "aws.protocols#ec2QueryName": "PriceSchedules", + "smithy.api#documentation": "

The price of the Reserved Instance listing.

", + "smithy.api#xmlName": "priceSchedules" } }, "InstanceCounts": { @@ -46143,28 +47600,28 @@ "smithy.api#xmlName": "instanceCounts" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "UpdateDate": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is\n\t\t\tidempotent. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" + "aws.protocols#ec2QueryName": "UpdateDate", + "smithy.api#documentation": "

The last modified timestamp of the listing.

", + "smithy.api#xmlName": "updateDate" } }, - "ReservedInstancesId": { + "ReservedInstancesListingId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The ID of the Reserved Instance.

", - "smithy.api#xmlName": "reservedInstancesId" + "aws.protocols#ec2QueryName": "ReservedInstancesListingId", + "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", + "smithy.api#xmlName": "reservedInstancesListingId" } }, - "UpdateDate": { + "CreateDate": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "UpdateDate", - "smithy.api#documentation": "

The last modified timestamp of the listing.

", - "smithy.api#xmlName": "updateDate" + "aws.protocols#ec2QueryName": "CreateDate", + "smithy.api#documentation": "

The time the listing was created.

", + "smithy.api#xmlName": "createDate" } }, "Status": { @@ -46183,28 +47640,28 @@ "smithy.api#xmlName": "tagSet" } }, - "CreateDate": { - "target": "com.amazonaws.ec2#DateTime", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CreateDate", - "smithy.api#documentation": "

The time the listing was created.

", - "smithy.api#xmlName": "createDate" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive key supplied by the client to ensure that the request is\n\t\t\tidempotent. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" } }, - "PriceSchedules": { - "target": "com.amazonaws.ec2#PriceScheduleList", + "StatusMessage": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PriceSchedules", - "smithy.api#documentation": "

The price of the Reserved Instance listing.

", - "smithy.api#xmlName": "priceSchedules" + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "smithy.api#xmlName": "statusMessage" } }, - "ReservedInstancesListingId": { + "ReservedInstancesId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesListingId", - "smithy.api#documentation": "

The ID of the Reserved Instance listing.

", - "smithy.api#xmlName": "reservedInstancesListingId" + "aws.protocols#ec2QueryName": "ReservedInstancesId", + "smithy.api#documentation": "

The ID of the Reserved Instance.

", + "smithy.api#xmlName": "reservedInstancesId" } } }, @@ -46235,14 +47692,6 @@ "smithy.api#xmlName": "reservedInstancesSet" } }, - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status of the Reserved Instances modification request.

", - "smithy.api#xmlName": "status" - } - }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -46251,28 +47700,12 @@ "smithy.api#xmlName": "clientToken" } }, - "ModificationResults": { - "target": "com.amazonaws.ec2#ReservedInstancesModificationResultList", - "traits": { - "aws.protocols#ec2QueryName": "ModificationResultSet", - "smithy.api#documentation": "

Contains target configurations along with their corresponding new Reserved Instance IDs.

", - "smithy.api#xmlName": "modificationResultSet" - } - }, - "EffectiveDate": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "EffectiveDate", - "smithy.api#documentation": "

The time for the modification to become effective.

", - "smithy.api#xmlName": "effectiveDate" - } - }, - "StatusMessage": { + "Status": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The reason for the status.

", - "smithy.api#xmlName": "statusMessage" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the Reserved Instances modification request.

", + "smithy.api#xmlName": "status" } }, "CreateDate": { @@ -46283,6 +47716,14 @@ "smithy.api#xmlName": "createDate" } }, + "UpdateDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "UpdateDate", + "smithy.api#documentation": "

The time when the modification request was last updated.

", + "smithy.api#xmlName": "updateDate" + } + }, "ReservedInstancesModificationId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -46291,12 +47732,28 @@ "smithy.api#xmlName": "reservedInstancesModificationId" } }, - "UpdateDate": { + "EffectiveDate": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "UpdateDate", - "smithy.api#documentation": "

The time when the modification request was last updated.

", - "smithy.api#xmlName": "updateDate" + "aws.protocols#ec2QueryName": "EffectiveDate", + "smithy.api#documentation": "

The time for the modification to become effective.

", + "smithy.api#xmlName": "effectiveDate" + } + }, + "ModificationResults": { + "target": "com.amazonaws.ec2#ReservedInstancesModificationResultList", + "traits": { + "aws.protocols#ec2QueryName": "ModificationResultSet", + "smithy.api#documentation": "

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "smithy.api#xmlName": "modificationResultSet" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The reason for the status.

", + "smithy.api#xmlName": "statusMessage" } } }, @@ -46361,28 +47818,20 @@ "com.amazonaws.ec2#ReservedInstancesOffering": { "type": "structure", "members": { - "AvailabilityZone": { + "ReservedInstancesOfferingId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", - "traits": { - "aws.protocols#ec2QueryName": "OfferingClass", - "smithy.api#documentation": "

If convertible it can be exchanged for Reserved Instances of\n the same or higher monetary value, with different configurations. If standard, it is not \n possible to perform an exchange.

", - "smithy.api#xmlName": "offeringClass" + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", + "smithy.api#documentation": "

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.

", + "smithy.api#xmlName": "reservedInstancesOfferingId" } }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", + "FixedPrice": { + "target": "com.amazonaws.ec2#Float", "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type.

", - "smithy.api#xmlName": "offeringType" + "aws.protocols#ec2QueryName": "FixedPrice", + "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", + "smithy.api#xmlName": "fixedPrice" } }, "ProductDescription": { @@ -46393,6 +47842,14 @@ "smithy.api#xmlName": "productDescription" } }, + "RecurringCharges": { + "target": "com.amazonaws.ec2#RecurringChargesList", + "traits": { + "aws.protocols#ec2QueryName": "RecurringCharges", + "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", + "smithy.api#xmlName": "recurringCharges" + } + }, "PricingDetails": { "target": "com.amazonaws.ec2#PricingDetailsList", "traits": { @@ -46401,12 +47858,12 @@ "smithy.api#xmlName": "pricingDetailsSet" } }, - "RecurringCharges": { - "target": "com.amazonaws.ec2#RecurringChargesList", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "RecurringCharges", - "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", - "smithy.api#xmlName": "recurringCharges" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" } }, "Marketplace": { @@ -46417,20 +47874,20 @@ "smithy.api#xmlName": "marketplace" } }, - "Scope": { - "target": "com.amazonaws.ec2#scope", + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

", - "smithy.api#xmlName": "scope" + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type.

", + "smithy.api#xmlName": "offeringType" } }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy of the instance.

", - "smithy.api#xmlName": "instanceTenancy" + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" } }, "UsagePrice": { @@ -46441,6 +47898,14 @@ "smithy.api#xmlName": "usagePrice" } }, + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", + "traits": { + "aws.protocols#ec2QueryName": "OfferingClass", + "smithy.api#documentation": "

If convertible it can be exchanged for Reserved Instances of\n the same or higher monetary value, with different configurations. If standard, it is not \n possible to perform an exchange.

", + "smithy.api#xmlName": "offeringClass" + } + }, "Duration": { "target": "com.amazonaws.ec2#Long", "traits": { @@ -46449,36 +47914,28 @@ "smithy.api#xmlName": "duration" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", - "smithy.api#xmlName": "instanceType" - } - }, - "FixedPrice": { - "target": "com.amazonaws.ec2#Float", + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "aws.protocols#ec2QueryName": "FixedPrice", - "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", - "smithy.api#xmlName": "fixedPrice" + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instance.

", + "smithy.api#xmlName": "instanceTenancy" } }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", + "smithy.api#xmlName": "availabilityZone" } }, - "ReservedInstancesOfferingId": { - "target": "com.amazonaws.ec2#String", + "Scope": { + "target": "com.amazonaws.ec2#scope", "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", - "smithy.api#documentation": "

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.

", - "smithy.api#xmlName": "reservedInstancesOfferingId" + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

", + "smithy.api#xmlName": "scope" } } }, @@ -46574,14 +48031,8 @@ "com.amazonaws.ec2#ResetFpgaImageAttributeRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, - "FpgaImageId": { - "target": "com.amazonaws.ec2#FpgaImageId", + "FpgaImageId": { + "target": "com.amazonaws.ec2#FpgaImageId", "traits": { "smithy.api#documentation": "

The ID of the AFI.

", "smithy.api#required": {} @@ -46592,6 +48043,12 @@ "traits": { "smithy.api#documentation": "

The attribute.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -46669,14 +48126,6 @@ "com.amazonaws.ec2#ResetInstanceAttributeRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#InstanceId", "traits": { @@ -46694,6 +48143,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "attribute" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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" + } } } }, @@ -46717,6 +48174,14 @@ "smithy.api#xmlName": "dryRun" } }, + "SourceDestCheck": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceDestCheck", + "smithy.api#documentation": "

The source/destination checking attribute. Resets the value to true.

", + "smithy.api#xmlName": "sourceDestCheck" + } + }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -46725,14 +48190,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "networkInterfaceId" } - }, - "SourceDestCheck": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceDestCheck", - "smithy.api#documentation": "

The source/destination checking attribute. Resets the value to true.

", - "smithy.api#xmlName": "sourceDestCheck" - } } }, "traits": { @@ -46745,16 +48202,16 @@ "target": "com.amazonaws.ec2#ResetSnapshotAttributeRequest" }, "traits": { - "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For more information about modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For more information about modifying snapshot permissions, see Sharing snapshots in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#ResetSnapshotAttributeRequest": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", + "Attribute": { + "target": "com.amazonaws.ec2#SnapshotAttributeName", "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

", + "smithy.api#documentation": "

The attribute to reset. Currently, only the attribute for permission to create volumes can\n be reset.

", "smithy.api#required": {} } }, @@ -46766,10 +48223,10 @@ "smithy.api#xmlName": "dryRun" } }, - "Attribute": { - "target": "com.amazonaws.ec2#SnapshotAttributeName", + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", "traits": { - "smithy.api#documentation": "

The attribute to reset. Currently, only the attribute for permission to create volumes can\n be reset.

", + "smithy.api#documentation": "

The ID of the snapshot.

", "smithy.api#required": {} } } @@ -46815,6 +48272,9 @@ { "value": "dhcp-options" }, + { + "value": "egress-only-internet-gateway" + }, { "value": "elastic-ip" }, @@ -46938,14 +48398,6 @@ "com.amazonaws.ec2#ResponseError": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#LaunchTemplateErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -46953,6 +48405,14 @@ "smithy.api#documentation": "

The error message, if applicable.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#LaunchTemplateErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -46980,30 +48440,6 @@ "com.amazonaws.ec2#ResponseLaunchTemplateData": { "type": "structure", "members": { - "UserData": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The user data for the instance.

", - "smithy.api#xmlName": "userData" - } - }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse", - "traits": { - "aws.protocols#ec2QueryName": "CapacityReservationSpecification", - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", - "smithy.api#xmlName": "capacityReservationSpecification" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupIdSet", - "smithy.api#documentation": "

The security group IDs.

", - "smithy.api#xmlName": "securityGroupIdSet" - } - }, "InstanceInitiatedShutdownBehavior": { "target": "com.amazonaws.ec2#ShutdownBehavior", "traits": { @@ -47012,36 +48448,44 @@ "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" } }, - "HibernationOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptions", + "LicenseSpecifications": { + "target": "com.amazonaws.ec2#LaunchTemplateLicenseList", "traits": { - "aws.protocols#ec2QueryName": "HibernationOptions", - "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation. For more information, see\n Hibernate\n Your Instance in the Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "hibernationOptions" + "aws.protocols#ec2QueryName": "LicenseSet", + "smithy.api#documentation": "

The license configurations.

", + "smithy.api#xmlName": "licenseSet" } }, - "KernelId": { - "target": "com.amazonaws.ec2#String", + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel, if applicable.

", - "smithy.api#xmlName": "kernelId" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "smithy.api#xmlName": "ebsOptimized" } }, - "RamDiskId": { - "target": "com.amazonaws.ec2#String", + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "RamDiskId", - "smithy.api#documentation": "

The ID of the RAM disk, if applicable.

", - "smithy.api#xmlName": "ramDiskId" + "aws.protocols#ec2QueryName": "NetworkInterfaceSet", + "smithy.api#documentation": "

The network interfaces.

", + "smithy.api#xmlName": "networkInterfaceSet" } }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#Boolean", + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If set to true, indicates that the instance cannot be terminated using\n the Amazon EC2 console, command line tool, or API.

", - "smithy.api#xmlName": "disableApiTermination" + "aws.protocols#ec2QueryName": "SecurityGroupIdSet", + "smithy.api#documentation": "

The security group IDs.

", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions", + "traits": { + "aws.protocols#ec2QueryName": "MetadataOptions", + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance Metadata and User Data in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "metadataOptions" } }, "InstanceMarketOptions": { @@ -47052,12 +48496,12 @@ "smithy.api#xmlName": "instanceMarketOptions" } }, - "MetadataOptions": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptions", + "Monitoring": { + "target": "com.amazonaws.ec2#LaunchTemplatesMonitoring", "traits": { - "aws.protocols#ec2QueryName": "MetadataOptions", - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance Metadata and User Data in the\n Amazon Elastic Compute Cloud User Guide.

", - "smithy.api#xmlName": "metadataOptions" + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" } }, "Placement": { @@ -47068,14 +48512,6 @@ "smithy.api#xmlName": "placement" } }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#LaunchTemplateInstanceNetworkInterfaceSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceSet", - "smithy.api#documentation": "

The network interfaces.

", - "smithy.api#xmlName": "networkInterfaceSet" - } - }, "SecurityGroups": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -47084,20 +48520,44 @@ "smithy.api#xmlName": "securityGroupSet" } }, - "Monitoring": { - "target": "com.amazonaws.ec2#LaunchTemplatesMonitoring", + "KeyName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

The monitoring for the instance.

", - "smithy.api#xmlName": "monitoring" + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" } }, - "ImageId": { + "KernelId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI that was used to launch the instance.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel, if applicable.

", + "smithy.api#xmlName": "kernelId" + } + }, + "ElasticGpuSpecifications": { + "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponseList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticGpuSpecificationSet", + "smithy.api#documentation": "

The elastic GPU specification.

", + "smithy.api#xmlName": "elasticGpuSpecificationSet" + } + }, + "RamDiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamDiskId", + "smithy.api#documentation": "

The ID of the RAM disk, if applicable.

", + "smithy.api#xmlName": "ramDiskId" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMappingSet", + "smithy.api#documentation": "

The block device mappings.

", + "smithy.api#xmlName": "blockDeviceMappingSet" } }, "TagSpecifications": { @@ -47108,28 +48568,44 @@ "smithy.api#xmlName": "tagSpecificationSet" } }, - "LicenseSpecifications": { - "target": "com.amazonaws.ec2#LaunchTemplateLicenseList", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "aws.protocols#ec2QueryName": "LicenseSet", - "smithy.api#documentation": "

The license configurations.

", - "smithy.api#xmlName": "licenseSet" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" } }, - "EbsOptimized": { + "DisableApiTermination": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O.

", - "smithy.api#xmlName": "ebsOptimized" + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If set to true, indicates that the instance cannot be terminated using\n the Amazon EC2 console, command line tool, or API.

", + "smithy.api#xmlName": "disableApiTermination" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#LaunchTemplateCapacityReservationSpecificationResponse", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "CapacityReservationSpecification", + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option.

", + "smithy.api#xmlName": "capacityReservationSpecification" + } + }, + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList", + "traits": { + "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorSet", + "smithy.api#documentation": "

\n The elastic inference accelerator for the instance.\n

", + "smithy.api#xmlName": "elasticInferenceAcceleratorSet" + } + }, + "UserData": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The user data for the instance.

", + "smithy.api#xmlName": "userData" } }, "CreditSpecification": { @@ -47140,28 +48616,20 @@ "smithy.api#xmlName": "creditSpecification" } }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#LaunchTemplateBlockDeviceMappingList", + "HibernationOptions": { + "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptions", "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMappingSet", - "smithy.api#documentation": "

The block device mappings.

", - "smithy.api#xmlName": "blockDeviceMappingSet" + "aws.protocols#ec2QueryName": "HibernationOptions", + "smithy.api#documentation": "

Indicates whether an instance is configured for hibernation. For more information, see\n Hibernate\n Your Instance in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "hibernationOptions" } }, - "ElasticInferenceAccelerators": { - "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList", + "ImageId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorSet", - "smithy.api#documentation": "

\n The elastic inference accelerator for the instance.\n

", - "smithy.api#xmlName": "elasticInferenceAcceleratorSet" + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI that was used to launch the instance.

", + "smithy.api#xmlName": "imageId" } }, "IamInstanceProfile": { @@ -47172,14 +48640,6 @@ "smithy.api#xmlName": "iamInstanceProfile" } }, - "ElasticGpuSpecifications": { - "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponseList", - "traits": { - "aws.protocols#ec2QueryName": "ElasticGpuSpecificationSet", - "smithy.api#documentation": "

The elastic GPU specification.

", - "smithy.api#xmlName": "elasticGpuSpecificationSet" - } - }, "CpuOptions": { "target": "com.amazonaws.ec2#LaunchTemplateCpuOptions", "traits": { @@ -47236,14 +48696,6 @@ "com.amazonaws.ec2#RestoreAddressToClassicResult": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.ec2#Status", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The move status for the IP address.

", - "smithy.api#xmlName": "status" - } - }, "PublicIp": { "target": "com.amazonaws.ec2#String", "traits": { @@ -47251,6 +48703,14 @@ "smithy.api#documentation": "

The Elastic IP address.

", "smithy.api#xmlName": "publicIp" } + }, + "Status": { + "target": "com.amazonaws.ec2#Status", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The move status for the IP address.

", + "smithy.api#xmlName": "status" + } } } }, @@ -47269,31 +48729,31 @@ "com.amazonaws.ec2#RestoreManagedPrefixListVersionRequest": { "type": "structure", "members": { - "PrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the prefix list.

", - "smithy.api#required": {} + "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.

" } }, - "PreviousVersion": { + "CurrentVersion": { "target": "com.amazonaws.ec2#Long", "traits": { - "smithy.api#documentation": "

The version to restore.

", + "smithy.api#documentation": "

The current version number for the prefix list.

", "smithy.api#required": {} } }, - "CurrentVersion": { - "target": "com.amazonaws.ec2#Long", + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { - "smithy.api#documentation": "

The current version number for the prefix list.

", + "smithy.api#documentation": "

The ID of the prefix list.

", "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "PreviousVersion": { + "target": "com.amazonaws.ec2#Long", "traits": { - "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#documentation": "

The version to restore.

", + "smithy.api#required": {} } } } @@ -47333,11 +48793,10 @@ "smithy.api#required": {} } }, - "TargetNetworkCidr": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being removed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "RevokeAllGroups": { @@ -47346,16 +48805,17 @@ "smithy.api#documentation": "

Indicates whether access should be revoked for all clients.

" } }, - "AccessGroupId": { + "TargetNetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the Active Directory group for which to revoke access.

" + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the network for which access is being removed.

", + "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "AccessGroupId": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + "smithy.api#documentation": "

The ID of the Active Directory group for which to revoke access.

" } } } @@ -47378,28 +48838,38 @@ "input": { "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest" }, + "output": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressResult" + }, "traits": { - "smithy.api#documentation": "

[VPC only] Removes the specified egress rules from a security group for EC2-VPC.\n This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the\n values that you specify (for example, ports) must match the existing rule's values\n exactly.

\n

Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security\n group. For the TCP and UDP protocols, you must also specify the destination port or range of\n ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule\n has a description, you do not have to specify the description to revoke the rule.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + "smithy.api#documentation": "

[VPC only] Removes the specified egress rules from a security group for EC2-VPC.\n This action does not apply to security groups for use in EC2-Classic. To remove a rule, the\n values that you specify (for example, ports) must match the existing rule's values\n exactly.

\n \n

[Default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

AWS recommends that you use DescribeSecurityGroups to verify\n that the rule has been removed.

\n \n

Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security\n group. For the TCP and UDP protocols, you must also specify the destination port or range of\n ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule\n has a description, you do not have to specify the description to revoke the rule.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" } }, "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest": { "type": "structure", "members": { - "FromPort": { - "target": "com.amazonaws.ec2#Integer", + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", - "smithy.api#xmlName": "fromPort" + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", + "smithy.api#xmlName": "sourceSecurityGroupName" } }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "groupId" + "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a destination security\n group.

", + "smithy.api#xmlName": "sourceSecurityGroupOwnerId" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", + "smithy.api#xmlName": "ipProtocol" } }, "DryRun": { @@ -47418,14 +48888,6 @@ "smithy.api#xmlName": "ipPermissions" } }, - "SourceSecurityGroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupName", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", - "smithy.api#xmlName": "sourceSecurityGroupName" - } - }, "CidrIp": { "target": "com.amazonaws.ec2#String", "traits": { @@ -47434,14 +48896,6 @@ "smithy.api#xmlName": "cidrIp" } }, - "SourceSecurityGroupOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a destination security\n group.

", - "smithy.api#xmlName": "sourceSecurityGroupOwnerId" - } - }, "ToPort": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -47450,12 +48904,42 @@ "smithy.api#xmlName": "toPort" } }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", - "smithy.api#xmlName": "ipProtocol" + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "groupId" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the port.

", + "smithy.api#xmlName": "fromPort" + } + } + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupEgressResult": { + "type": "structure", + "members": { + "UnknownIpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", + "smithy.api#documentation": "

The outbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", + "smithy.api#xmlName": "unknownIpPermissionSet" + } + }, + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" } } } @@ -47465,29 +48949,20 @@ "input": { "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest" }, + "output": { + "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressResult" + }, "traits": { - "smithy.api#documentation": "

Removes the specified ingress rules from a security group. To remove a rule, the values\n that you specify (for example, ports) must match the existing rule's values exactly.

\n \t \n

[EC2-Classic only] If the values you specify do not match the existing\n \t\trule's values, no error is returned. Use DescribeSecurityGroups to\n \t\tverify that the rule has been removed.

\n \n

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + "smithy.api#documentation": "

Removes the specified ingress rules from a security group. To remove a rule, the values\n that you specify (for example, ports) must match the existing rule's values exactly.

\n \n \t \n

[EC2-Classic , default VPC] If the values you specify do not match the existing rule's values,\n no error is returned, and the output describes the security group rules that were\n not revoked.

\n

AWS recommends that you use DescribeSecurityGroups to verify\n that the rule has been removed.

\n \n\n

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" } }, "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest": { "type": "structure", "members": { - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n security group name in the request. For security groups in a nondefault VPC, you must\n specify the security group ID.

" - } - }, - "SourceSecurityGroupName": { + "IpProtocol": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "smithy.api#documentation": "

The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.

" + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

" } }, "DryRun": { @@ -47504,6 +48979,12 @@ "smithy.api#documentation": "

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.

" } }, + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + } + }, "GroupName": { "target": "com.amazonaws.ec2#SecurityGroupName", "traits": { @@ -47522,16 +49003,43 @@ "smithy.api#documentation": "

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" } }, - "SourceSecurityGroupOwnerId": { + "SourceSecurityGroupName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" } }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.

" + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n security group name in the request. For security groups in a nondefault VPC, you must\n specify the security group ID.

" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "smithy.api#documentation": "

The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.

" + } + } + } + }, + "com.amazonaws.ec2#RevokeSecurityGroupIngressResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, returns an error.

", + "smithy.api#xmlName": "return" + } + }, + "UnknownIpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "UnknownIpPermissionSet", + "smithy.api#documentation": "

The inbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.

", + "smithy.api#xmlName": "unknownIpPermissionSet" } } } @@ -47561,36 +49069,28 @@ "com.amazonaws.ec2#Route": { "type": "structure", "members": { - "LocalGatewayId": { - "target": "com.amazonaws.ec2#String", + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", "traits": { - "aws.protocols#ec2QueryName": "LocalGatewayId", - "smithy.api#documentation": "

The ID of the local gateway.

", - "smithy.api#xmlName": "localGatewayId" + "aws.protocols#ec2QueryName": "CarrierGatewayId", + "smithy.api#documentation": "

The ID of the carrier gateway.

", + "smithy.api#xmlName": "carrierGatewayId" } }, - "DestinationIpv6CidrBlock": { + "GatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" - } - }, - "State": { - "target": "com.amazonaws.ec2#RouteState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of a gateway attached to your VPC.

", + "smithy.api#xmlName": "gatewayId" } }, - "TransitGatewayId": { + "DestinationPrefixListId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of a transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" + "aws.protocols#ec2QueryName": "DestinationPrefixListId", + "smithy.api#documentation": "

The prefix of the AWS service.

", + "smithy.api#xmlName": "destinationPrefixListId" } }, "EgressOnlyInternetGatewayId": { @@ -47601,76 +49101,92 @@ "smithy.api#xmlName": "egressOnlyInternetGatewayId" } }, - "Origin": { - "target": "com.amazonaws.ec2#RouteOrigin", + "InstanceOwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Origin", - "smithy.api#documentation": "

Describes how the route was created.

\n ", - "smithy.api#xmlName": "origin" + "aws.protocols#ec2QueryName": "InstanceOwnerId", + "smithy.api#documentation": "

The AWS account ID of the owner of the instance.

", + "smithy.api#xmlName": "instanceOwnerId" } }, - "DestinationCidrBlock": { + "NatGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block used for the destination match.

", - "smithy.api#xmlName": "destinationCidrBlock" + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" } }, - "GatewayId": { + "LocalGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of a gateway attached to your VPC.

", - "smithy.api#xmlName": "gatewayId" + "aws.protocols#ec2QueryName": "LocalGatewayId", + "smithy.api#documentation": "

The ID of the local gateway.

", + "smithy.api#xmlName": "localGatewayId" } }, - "VpcPeeringConnectionId": { + "State": { + "target": "com.amazonaws.ec2#RouteState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).

", + "smithy.api#xmlName": "state" + } + }, + "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of a VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", + "smithy.api#xmlName": "instanceId" } }, - "InstanceOwnerId": { + "DestinationIpv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceOwnerId", - "smithy.api#documentation": "

The AWS account ID of the owner of the instance.

", - "smithy.api#xmlName": "instanceOwnerId" + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" } }, - "NetworkInterfaceId": { + "DestinationCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block used for the destination match.

", + "smithy.api#xmlName": "destinationCidrBlock" } }, - "DestinationPrefixListId": { + "TransitGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DestinationPrefixListId", - "smithy.api#documentation": "

The prefix of the AWS service.

", - "smithy.api#xmlName": "destinationPrefixListId" + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of a transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" } }, - "NatGatewayId": { + "Origin": { + "target": "com.amazonaws.ec2#RouteOrigin", + "traits": { + "aws.protocols#ec2QueryName": "Origin", + "smithy.api#documentation": "

Describes how the route was created.

\n ", + "smithy.api#xmlName": "origin" + } + }, + "VpcPeeringConnectionId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of a VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" } }, - "InstanceId": { + "NetworkInterfaceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" } } }, @@ -47722,28 +49238,28 @@ "com.amazonaws.ec2#RouteTable": { "type": "structure", "members": { - "VpcId": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the route table.

", + "smithy.api#xmlName": "ownerId" } }, - "RouteTableId": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#xmlName": "routeTableId" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route table.

", + "smithy.api#xmlName": "tagSet" } }, - "Associations": { - "target": "com.amazonaws.ec2#RouteTableAssociationList", + "PropagatingVgws": { + "target": "com.amazonaws.ec2#PropagatingVgwList", "traits": { - "aws.protocols#ec2QueryName": "AssociationSet", - "smithy.api#documentation": "

The associations between the route table and one or more subnets or a gateway.

", - "smithy.api#xmlName": "associationSet" + "aws.protocols#ec2QueryName": "PropagatingVgwSet", + "smithy.api#documentation": "

Any virtual private gateway (VGW) propagating routes.

", + "smithy.api#xmlName": "propagatingVgwSet" } }, "Routes": { @@ -47754,28 +49270,28 @@ "smithy.api#xmlName": "routeSet" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "Associations": { + "target": "com.amazonaws.ec2#RouteTableAssociationList", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the route table.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "AssociationSet", + "smithy.api#documentation": "

The associations between the route table and one or more subnets or a gateway.

", + "smithy.api#xmlName": "associationSet" } }, - "PropagatingVgws": { - "target": "com.amazonaws.ec2#PropagatingVgwList", + "RouteTableId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PropagatingVgwSet", - "smithy.api#documentation": "

Any virtual private gateway (VGW) propagating routes.

", - "smithy.api#xmlName": "propagatingVgwSet" + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#xmlName": "routeTableId" } }, - "OwnerId": { + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the route table.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" } } }, @@ -47786,22 +49302,6 @@ "com.amazonaws.ec2#RouteTableAssociation": { "type": "structure", "members": { - "AssociationState": { - "target": "com.amazonaws.ec2#RouteTableAssociationState", - "traits": { - "aws.protocols#ec2QueryName": "AssociationState", - "smithy.api#documentation": "

The state of the association.

", - "smithy.api#xmlName": "associationState" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet. A subnet ID is not returned for an implicit association.

", - "smithy.api#xmlName": "subnetId" - } - }, "Main": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -47810,14 +49310,6 @@ "smithy.api#xmlName": "main" } }, - "GatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

", - "smithy.api#xmlName": "gatewayId" - } - }, "RouteTableId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -47826,6 +49318,14 @@ "smithy.api#xmlName": "routeTableId" } }, + "AssociationState": { + "target": "com.amazonaws.ec2#RouteTableAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "AssociationState", + "smithy.api#documentation": "

The state of the association.

", + "smithy.api#xmlName": "associationState" + } + }, "RouteTableAssociationId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -47833,6 +49333,22 @@ "smithy.api#documentation": "

The ID of the association.

", "smithy.api#xmlName": "routeTableAssociationId" } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "smithy.api#xmlName": "subnetId" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } } }, "traits": { @@ -47854,14 +49370,6 @@ "com.amazonaws.ec2#RouteTableAssociationState": { "type": "structure", "members": { - "StatusMessage": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

The status message, if applicable.

", - "smithy.api#xmlName": "statusMessage" - } - }, "State": { "target": "com.amazonaws.ec2#RouteTableAssociationStateCode", "traits": { @@ -47869,6 +49377,14 @@ "smithy.api#documentation": "

The state of the association.

", "smithy.api#xmlName": "state" } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

The status message, if applicable.

", + "smithy.api#xmlName": "statusMessage" + } } }, "traits": { @@ -47963,42 +49479,30 @@ "com.amazonaws.ec2#RunInstancesRequest": { "type": "structure", "members": { - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

[EC2-VPC] The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" + "smithy.api#documentation": "

The tags to apply to the resources during launch. You can only tag instances and\n volumes on launch. The specified tags are applied to all instances or volumes that are\n created during launch. To tag a resource after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" } }, - "ElasticInferenceAccelerators": { - "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

", - "smithy.api#xmlName": "ElasticInferenceAccelerator" + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon Elastic Compute Cloud User Guide.

\n " } }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#Boolean", + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, \n use ModifyInstanceAttribute.\n Alternatively, if you set InstanceInitiatedShutdownBehavior to\n terminate, you can terminate the instance by running the shutdown\n command from the instance.

\n

Default: false\n

", - "smithy.api#xmlName": "disableApiTermination" + "smithy.api#documentation": "

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you\n must use security group IDs instead.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

\n

Default: Amazon EC2 uses the default security group.

", + "smithy.api#xmlName": "SecurityGroup" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for the \n request to ensure idempotency.

\n \n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", - "smithy.api#idempotencyToken": {}, - "smithy.api#xmlName": "clientToken" + "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet to launch the instance into.

\n

If you specify a network interface, you must specify any subnets as part of the network interface.

" } }, "Placement": { @@ -48007,22 +49511,24 @@ "smithy.api#documentation": "

The placement for the instance.

" } }, - "CapacityReservationSpecification": { - "target": "com.amazonaws.ec2#CapacityReservationSpecification", + "ElasticGpuSpecification": { + "target": "com.amazonaws.ec2#ElasticGpuSpecifications", "traits": { - "smithy.api#documentation": "

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone).

" + "smithy.api#documentation": "

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that\n you can attach to your Windows instance to accelerate the graphics performance of your\n applications. For more information, see Amazon EC2 Elastic\n GPUs in the Amazon Elastic Compute Cloud User Guide.

" } }, - "MetadataOptions": { - "target": "com.amazonaws.ec2#InstanceMetadataOptionsRequest", + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data.

" + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, \n use ModifyInstanceAttribute.\n Alternatively, if you set InstanceInitiatedShutdownBehavior to\n terminate, you can terminate the instance by running the shutdown\n command from the instance.

\n

Default: false\n

", + "smithy.api#xmlName": "disableApiTermination" } }, - "Monitoring": { - "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", + "KeyName": { + "target": "com.amazonaws.ec2#KeyPairName", "traits": { - "smithy.api#documentation": "

Specifies whether detailed monitoring is enabled for the instance.

" + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " } }, "RamdiskId": { @@ -48031,22 +49537,27 @@ "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the AWS Resource Center and search for the\n kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon Elastic Compute Cloud User Guide.

\n " } }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", + "InstanceMarketOptions": { + "target": "com.amazonaws.ec2#InstanceMarketOptionsRequest", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" + "smithy.api#documentation": "

The market (purchasing) option for the instances.

\n

For RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.

" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "MaxCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The tags to apply to the resources during launch. You can only tag instances and\n volumes on launch. The specified tags are applied to all instances or volumes that are\n created during launch. To tag a resource after it has been created, see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" + "smithy.api#documentation": "

The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.

", + "smithy.api#required": {} } }, - "LicenseSpecifications": { + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "traits": { + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "BlockDeviceMapping" + } + }, + "LicenseSpecifications": { "target": "com.amazonaws.ec2#LicenseSpecificationListRequest", "traits": { "smithy.api#documentation": "

The license configurations.

", @@ -48060,6 +49571,20 @@ "smithy.api#required": {} } }, + "CreditSpecification": { + "target": "com.amazonaws.ec2#CreditSpecificationRequest", + "traits": { + "smithy.api#documentation": "

The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon Elastic Compute Cloud User Guide.

\n

Default: standard (T2 instances) or unlimited (T3/T3a\n instances)

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -48068,24 +49593,24 @@ "smithy.api#xmlName": "dryRun" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using \n\tCreateSecurityGroup.

\n

If you specify a network interface, you must specify any security groups as part of the network interface.

", - "smithy.api#xmlName": "SecurityGroupId" + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

The network interfaces to associate with the instance. If you specify a network interface,\n you must specify any security groups and subnets as part of the network interface.

", + "smithy.api#xmlName": "networkInterface" } }, - "ElasticGpuSpecification": { - "target": "com.amazonaws.ec2#ElasticGpuSpecifications", + "HibernationOptions": { + "target": "com.amazonaws.ec2#HibernationOptionsRequest", "traits": { - "smithy.api#documentation": "

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that\n you can attach to your Windows instance to accelerate the graphics performance of your\n applications. For more information, see Amazon EC2 Elastic\n GPUs in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon Elastic Compute Cloud User Guide.

" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "MetadataOptions": { + "target": "com.amazonaws.ec2#InstanceMetadataOptionsRequest", "traits": { - "smithy.api#documentation": "

The block device mapping entries.

", - "smithy.api#xmlName": "BlockDeviceMapping" + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data.

" } }, "CpuOptions": { @@ -48094,92 +49619,88 @@ "smithy.api#documentation": "

The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.

" } }, - "InstanceMarketOptions": { - "target": "com.amazonaws.ec2#InstanceMarketOptionsRequest", - "traits": { - "smithy.api#documentation": "

The market (purchasing) option for the instances.

\n

For RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.

" - } - }, - "MaxCount": { - "target": "com.amazonaws.ec2#Integer", + "CapacityReservationSpecification": { + "target": "com.amazonaws.ec2#CapacityReservationSpecification", "traits": { - "smithy.api#documentation": "

The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the\n instance's Capacity Reservation preference defaults to open, which enables\n it to run in any open Capacity Reservation that has matching attributes (instance type,\n platform, Availability Zone).

" } }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterface", - "smithy.api#documentation": "

The network interfaces to associate with the instance. If you specify a network interface,\n you must specify any security groups and subnets as part of the network interface.

", - "smithy.api#xmlName": "networkInterface" + "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using \n\tCreateSecurityGroup.

\n

If you specify a network interface, you must specify any security groups as part of the network interface.

", + "smithy.api#xmlName": "SecurityGroupId" } }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for the \n request to ensure idempotency.

\n \n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", + "smithy.api#idempotencyToken": {}, + "smithy.api#xmlName": "clientToken" } }, - "AdditionalInfo": { + "PrivateIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AdditionalInfo", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "additionalInfo" + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#xmlName": "privateIpAddress" } }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", "traits": { - "smithy.api#documentation": "

The ID of the AMI. An AMI ID is required to launch an instance and must be \n \tspecified here or in a launch template.

" + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" } }, - "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", + "LaunchTemplate": { + "target": "com.amazonaws.ec2#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + "smithy.api#documentation": "

The launch template to use to launch the instances. Any parameters that you specify in\n RunInstances override the same parameters in the launch template.\n You can specify either the name or ID of a launch template, but not both.

" } }, - "CreditSpecification": { - "target": "com.amazonaws.ec2#CreditSpecificationRequest", + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon Elastic Compute Cloud User Guide.

\n

Default: standard (T2 instances) or unlimited (T3/T3a\n instances)

" + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" } }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#SecurityGroupStringList", + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you\n must use security group IDs instead.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

\n

Default: Amazon EC2 uses the default security group.

", - "smithy.api#xmlName": "SecurityGroup" + "smithy.api#documentation": "

[EC2-VPC] The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

" } }, - "HibernationOptions": { - "target": "com.amazonaws.ec2#HibernationOptionsRequest", + "Monitoring": { + "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Specifies whether detailed monitoring is enabled for the instance.

" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "ElasticInferenceAccelerators": { + "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", "traits": { - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.

\n

Default: m1.small\n

" + "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

", + "smithy.api#xmlName": "ElasticInferenceAccelerator" } }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", - "smithy.api#xmlName": "privateIpAddress" + "smithy.api#documentation": "

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#xmlName": "Ipv6Address" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", "traits": { - "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet to launch the instance into.

\n

If you specify a network interface, you must specify any subnets as part of the network interface.

" + "smithy.api#documentation": "

The ID of the AMI. An AMI ID is required to launch an instance and must be \n \tspecified here or in a launch template.

" } }, "UserData": { @@ -48188,23 +49709,18 @@ "smithy.api#documentation": "

The user data to make available to the instance. For more information, see Running commands\n on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.

" } }, - "LaunchTemplate": { - "target": "com.amazonaws.ec2#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template to use to launch the instances. Any parameters that you specify in\n RunInstances override the same parameters in the launch template.\n You can specify either the name or ID of a launch template, but not both.

" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", - "smithy.api#xmlName": "Ipv6Address" + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.

\n

Default: m1.small\n

" } }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon Elastic Compute Cloud User Guide.

\n " + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" } } } @@ -48224,6 +49740,13 @@ "com.amazonaws.ec2#RunScheduledInstancesRequest": { "type": "structure", "members": { + "ScheduledInstanceId": { + "target": "com.amazonaws.ec2#ScheduledInstanceId", + "traits": { + "smithy.api#documentation": "

The Scheduled Instance ID.

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -48237,11 +49760,11 @@ "smithy.api#required": {} } }, - "ScheduledInstanceId": { - "target": "com.amazonaws.ec2#ScheduledInstanceId", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Scheduled Instance ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", + "smithy.api#idempotencyToken": {} } }, "InstanceCount": { @@ -48249,13 +49772,6 @@ "traits": { "smithy.api#documentation": "

The number of instances.

\n

Default: 1

" } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that ensures the idempotency of the request. \n For more information, see Ensuring Idempotency.

", - "smithy.api#idempotencyToken": {} - } } }, "traits": { @@ -48289,20 +49805,10 @@ "smithy.api#xmlName": "prefix" } }, - "UploadPolicySignature": { + "AWSAccessKeyId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UploadPolicySignature", - "smithy.api#documentation": "

The signature of the JSON document.

", - "smithy.api#xmlName": "uploadPolicySignature" - } - }, - "UploadPolicy": { - "target": "com.amazonaws.ec2#Blob", - "traits": { - "aws.protocols#ec2QueryName": "UploadPolicy", - "smithy.api#documentation": "

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", - "smithy.api#xmlName": "uploadPolicy" + "smithy.api#documentation": "

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.

" } }, "Bucket": { @@ -48313,10 +49819,20 @@ "smithy.api#xmlName": "bucket" } }, - "AWSAccessKeyId": { + "UploadPolicy": { + "target": "com.amazonaws.ec2#Blob", + "traits": { + "aws.protocols#ec2QueryName": "UploadPolicy", + "smithy.api#documentation": "

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "smithy.api#xmlName": "uploadPolicy" + } + }, + "UploadPolicySignature": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.

" + "aws.protocols#ec2QueryName": "UploadPolicySignature", + "smithy.api#documentation": "

The signature of the JSON document.

", + "smithy.api#xmlName": "uploadPolicySignature" } } }, @@ -48327,44 +49843,28 @@ "com.amazonaws.ec2#ScheduledInstance": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#documentation": "

The number of instances.

", - "smithy.api#xmlName": "instanceCount" - } - }, - "TotalScheduledInstanceHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", - "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", - "smithy.api#xmlName": "totalScheduledInstanceHours" - } - }, - "TermStartDate": { - "target": "com.amazonaws.ec2#DateTime", + "ScheduledInstanceId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TermStartDate", - "smithy.api#documentation": "

The start date for the Scheduled Instance.

", - "smithy.api#xmlName": "termStartDate" + "aws.protocols#ec2QueryName": "ScheduledInstanceId", + "smithy.api#documentation": "

The Scheduled Instance ID.

", + "smithy.api#xmlName": "scheduledInstanceId" } }, - "InstanceType": { + "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" } }, - "TermEndDate": { - "target": "com.amazonaws.ec2#DateTime", + "SlotDurationInHours": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "TermEndDate", - "smithy.api#documentation": "

The end date for the Scheduled Instance.

", - "smithy.api#xmlName": "termEndDate" + "aws.protocols#ec2QueryName": "SlotDurationInHours", + "smithy.api#documentation": "

The number of hours in the schedule.

", + "smithy.api#xmlName": "slotDurationInHours" } }, "NetworkPlatform": { @@ -48375,28 +49875,20 @@ "smithy.api#xmlName": "networkPlatform" } }, - "SlotDurationInHours": { + "InstanceCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "SlotDurationInHours", - "smithy.api#documentation": "

The number of hours in the schedule.

", - "smithy.api#xmlName": "slotDurationInHours" + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of instances.

", + "smithy.api#xmlName": "instanceCount" } }, - "PreviousSlotEndTime": { + "NextSlotStartTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "PreviousSlotEndTime", - "smithy.api#documentation": "

The time that the previous schedule ended or will end.

", - "smithy.api#xmlName": "previousSlotEndTime" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", - "smithy.api#xmlName": "platform" + "aws.protocols#ec2QueryName": "NextSlotStartTime", + "smithy.api#documentation": "

The time for the next schedule to start.

", + "smithy.api#xmlName": "nextSlotStartTime" } }, "Recurrence": { @@ -48407,20 +49899,28 @@ "smithy.api#xmlName": "recurrence" } }, - "AvailabilityZone": { + "HourlyPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price for a single instance.

", + "smithy.api#xmlName": "hourlyPrice" } }, - "ScheduledInstanceId": { + "Platform": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ScheduledInstanceId", - "smithy.api#documentation": "

The Scheduled Instance ID.

", - "smithy.api#xmlName": "scheduledInstanceId" + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The platform (Linux/UNIX or Windows).

", + "smithy.api#xmlName": "platform" + } + }, + "PreviousSlotEndTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "PreviousSlotEndTime", + "smithy.api#documentation": "

The time that the previous schedule ended or will end.

", + "smithy.api#xmlName": "previousSlotEndTime" } }, "CreateDate": { @@ -48431,20 +49931,36 @@ "smithy.api#xmlName": "createDate" } }, - "NextSlotStartTime": { + "TotalScheduledInstanceHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", + "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", + "smithy.api#xmlName": "totalScheduledInstanceHours" + } + }, + "TermEndDate": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "NextSlotStartTime", - "smithy.api#documentation": "

The time for the next schedule to start.

", - "smithy.api#xmlName": "nextSlotStartTime" + "aws.protocols#ec2QueryName": "TermEndDate", + "smithy.api#documentation": "

The end date for the Scheduled Instance.

", + "smithy.api#xmlName": "termEndDate" } }, - "HourlyPrice": { + "TermStartDate": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "TermStartDate", + "smithy.api#documentation": "

The start date for the Scheduled Instance.

", + "smithy.api#xmlName": "termStartDate" + } + }, + "InstanceType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly price for a single instance.

", - "smithy.api#xmlName": "hourlyPrice" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" } } }, @@ -48455,12 +49971,44 @@ "com.amazonaws.ec2#ScheduledInstanceAvailability": { "type": "structure", "members": { - "AvailabilityZone": { + "Recurrence": { + "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", + "traits": { + "aws.protocols#ec2QueryName": "Recurrence", + "smithy.api#documentation": "

The schedule recurrence.

", + "smithy.api#xmlName": "recurrence" + } + }, + "TotalScheduledInstanceHours": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", + "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", + "smithy.api#xmlName": "totalScheduledInstanceHours" + } + }, + "HourlyPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "HourlyPrice", + "smithy.api#documentation": "

The hourly price for a single instance.

", + "smithy.api#xmlName": "hourlyPrice" + } + }, + "FirstSlotStartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "FirstSlotStartTime", + "smithy.api#documentation": "

The time period for the first schedule to start.

", + "smithy.api#xmlName": "firstSlotStartTime" + } + }, + "MaxTermDurationInDays": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxTermDurationInDays", + "smithy.api#documentation": "

The maximum term. The only possible value is 365 days.

", + "smithy.api#xmlName": "maxTermDurationInDays" } }, "MinTermDurationInDays": { @@ -48479,20 +50027,20 @@ "smithy.api#xmlName": "slotDurationInHours" } }, - "PurchaseToken": { + "InstanceType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PurchaseToken", - "smithy.api#documentation": "

The purchase token. This token expires in two hours.

", - "smithy.api#xmlName": "purchaseToken" + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", + "smithy.api#xmlName": "instanceType" } }, - "MaxTermDurationInDays": { - "target": "com.amazonaws.ec2#Integer", + "NetworkPlatform": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "MaxTermDurationInDays", - "smithy.api#documentation": "

The maximum term. The only possible value is 365 days.

", - "smithy.api#xmlName": "maxTermDurationInDays" + "aws.protocols#ec2QueryName": "NetworkPlatform", + "smithy.api#documentation": "

The network platform (EC2-Classic or EC2-VPC).

", + "smithy.api#xmlName": "networkPlatform" } }, "Platform": { @@ -48511,52 +50059,20 @@ "smithy.api#xmlName": "availableInstanceCount" } }, - "NetworkPlatform": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkPlatform", - "smithy.api#documentation": "

The network platform (EC2-Classic or EC2-VPC).

", - "smithy.api#xmlName": "networkPlatform" - } - }, - "TotalScheduledInstanceHours": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TotalScheduledInstanceHours", - "smithy.api#documentation": "

The total number of hours for a single instance for the entire term.

", - "smithy.api#xmlName": "totalScheduledInstanceHours" - } - }, - "FirstSlotStartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "FirstSlotStartTime", - "smithy.api#documentation": "

The time period for the first schedule to start.

", - "smithy.api#xmlName": "firstSlotStartTime" - } - }, - "Recurrence": { - "target": "com.amazonaws.ec2#ScheduledInstanceRecurrence", - "traits": { - "aws.protocols#ec2QueryName": "Recurrence", - "smithy.api#documentation": "

The schedule recurrence.

", - "smithy.api#xmlName": "recurrence" - } - }, - "HourlyPrice": { + "PurchaseToken": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "HourlyPrice", - "smithy.api#documentation": "

The hourly price for a single instance.

", - "smithy.api#xmlName": "hourlyPrice" + "aws.protocols#ec2QueryName": "PurchaseToken", + "smithy.api#documentation": "

The purchase token. This token expires in two hours.

", + "smithy.api#xmlName": "purchaseToken" } }, - "InstanceType": { + "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" } } }, @@ -48588,14 +50104,6 @@ "com.amazonaws.ec2#ScheduledInstanceRecurrence": { "type": "structure", "members": { - "Frequency": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Frequency", - "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

", - "smithy.api#xmlName": "frequency" - } - }, "OccurrenceUnit": { "target": "com.amazonaws.ec2#String", "traits": { @@ -48604,14 +50112,6 @@ "smithy.api#xmlName": "occurrenceUnit" } }, - "OccurrenceRelativeToEnd": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "OccurrenceRelativeToEnd", - "smithy.api#documentation": "

Indicates whether the occurrence is relative to the end of the specified week or month.

", - "smithy.api#xmlName": "occurrenceRelativeToEnd" - } - }, "OccurrenceDaySet": { "target": "com.amazonaws.ec2#OccurrenceDaySet", "traits": { @@ -48620,6 +50120,22 @@ "smithy.api#xmlName": "occurrenceDaySet" } }, + "Frequency": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Frequency", + "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

", + "smithy.api#xmlName": "frequency" + } + }, + "OccurrenceRelativeToEnd": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "OccurrenceRelativeToEnd", + "smithy.api#documentation": "

Indicates whether the occurrence is relative to the end of the specified week or month.

", + "smithy.api#xmlName": "occurrenceRelativeToEnd" + } + }, "Interval": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -48636,12 +50152,6 @@ "com.amazonaws.ec2#ScheduledInstanceRecurrenceRequest": { "type": "structure", "members": { - "Interval": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 \n weeks or every 2 months.

" - } - }, "OccurrenceDays": { "target": "com.amazonaws.ec2#OccurrenceDayRequestSet", "traits": { @@ -48649,16 +50159,22 @@ "smithy.api#xmlName": "OccurrenceDay" } }, - "Frequency": { + "OccurrenceUnit": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

" + "smithy.api#documentation": "

The unit for OccurrenceDays (DayOfWeek or DayOfMonth).\n This value is required for a monthly schedule.\n You can't specify DayOfWeek with a weekly schedule.\n You can't specify this value with a daily schedule.

" } }, - "OccurrenceUnit": { + "Interval": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 \n weeks or every 2 months.

" + } + }, + "Frequency": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The unit for OccurrenceDays (DayOfWeek or DayOfMonth).\n This value is required for a monthly schedule.\n You can't specify DayOfWeek with a weekly schedule.\n You can't specify this value with a daily schedule.

" + "smithy.api#documentation": "

The frequency (Daily, Weekly, or Monthly).

" } }, "OccurrenceRelativeToEnd": { @@ -48684,16 +50200,16 @@ "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMapping": { "type": "structure", "members": { - "Ebs": { - "target": "com.amazonaws.ec2#ScheduledInstancesEbs", + "NoDevice": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Parameters used to set up EBS volumes automatically when the instance is launched.

" + "smithy.api#documentation": "

Suppresses the specified device included in the block device mapping of the AMI.

" } }, - "DeviceName": { - "target": "com.amazonaws.ec2#String", + "Ebs": { + "target": "com.amazonaws.ec2#ScheduledInstancesEbs", "traits": { - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" + "smithy.api#documentation": "

Parameters used to set up EBS volumes automatically when the instance is launched.

" } }, "VirtualName": { @@ -48702,10 +50218,10 @@ "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with two available instance store volumes can specify mappings\n for ephemeral0 and ephemeral1. The number of available instance store\n volumes depends on the instance type. After you connect to the instance, you must mount the\n volume.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" } }, - "NoDevice": { + "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Suppresses the specified device included in the block device mapping of the AMI.

" + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

" } } }, @@ -48725,16 +50241,22 @@ "com.amazonaws.ec2#ScheduledInstancesEbs": { "type": "structure", "members": { - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", + "VolumeType": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" + "smithy.api#documentation": "

The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD\n for st1, Cold HDD for sc1, or standard for\n Magnetic.

\n

Default: gp2\n

" } }, - "VolumeSize": { + "SnapshotId": { + "target": "com.amazonaws.ec2#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot.

" + } + }, + "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tNitro-based instances. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS Volume Types in the\n \t\tAmazon Elastic Compute Cloud User Guide.

\n \t

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

" } }, "DeleteOnTermination": { @@ -48743,22 +50265,16 @@ "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

" } }, - "Iops": { + "VolumeSize": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes,\n this represents the number of IOPS that are provisioned for the volume. For\n gp2 volumes, this represents the baseline performance of the volume and\n the rate at which the volume accumulates I/O credits for bursting. For more information\n about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the\n Amazon Elastic Compute Cloud User Guide.

\n

Constraint: Range is 100-20000 IOPS for io1 volumes and\n 100-10000 IOPS for gp2 volumes.

\n

Condition: This parameter is required for requests to create io1volumes; it\n is not used in requests to create gp2, st1,\n sc1, or standard volumes.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD\n for st1, Cold HDD for sc1, or standard for\n Magnetic.

\n

Default: gp2\n

" + "smithy.api#documentation": "

The size of the volume, in GiB.

\n

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" } }, - "SnapshotId": { - "target": "com.amazonaws.ec2#SnapshotId", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

" + "smithy.api#documentation": "

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" } } }, @@ -48812,40 +50328,37 @@ "com.amazonaws.ec2#ScheduledInstancesLaunchSpecification": { "type": "structure", "members": { - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

\n

Default: false\n

" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#ScheduledInstancesMonitoring", + "UserData": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Enable or disable monitoring for the instances.

" + "smithy.api#documentation": "

The base64-encoded MIME user data.

" } }, - "RamdiskId": { - "target": "com.amazonaws.ec2#RamdiskId", + "InstanceType": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk.

" + "smithy.api#documentation": "

The instance type.

" } }, - "Placement": { - "target": "com.amazonaws.ec2#ScheduledInstancesPlacement", + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", "traits": { - "smithy.api#documentation": "

The placement information.

" + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI).

", + "smithy.api#required": {} } }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile", + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet", "traits": { - "smithy.api#documentation": "

The IAM instance profile.

" + "smithy.api#documentation": "

The network interfaces.

", + "smithy.api#xmlName": "NetworkInterface" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet", "traits": { - "smithy.api#documentation": "

The instance type.

" + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "BlockDeviceMapping" } }, "SecurityGroupIds": { @@ -48867,18 +50380,22 @@ "smithy.api#documentation": "

The ID of the subnet in which to launch the instances.

" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#ScheduledInstancesBlockDeviceMappingSet", + "Monitoring": { + "target": "com.amazonaws.ec2#ScheduledInstancesMonitoring", "traits": { - "smithy.api#documentation": "

The block device mapping entries.

", - "smithy.api#xmlName": "BlockDeviceMapping" + "smithy.api#documentation": "

Enable or disable monitoring for the instances.

" } }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#ScheduledInstancesNetworkInterfaceSet", + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The network interfaces.

", - "smithy.api#xmlName": "NetworkInterface" + "smithy.api#documentation": "

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

\n

Default: false\n

" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#ScheduledInstancesPlacement", + "traits": { + "smithy.api#documentation": "

The placement information.

" } }, "KeyName": { @@ -48887,17 +50404,16 @@ "smithy.api#documentation": "

The name of the key pair.

" } }, - "ImageId": { - "target": "com.amazonaws.ec2#ImageId", + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#ScheduledInstancesIamInstanceProfile", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IAM instance profile.

" } }, - "UserData": { - "target": "com.amazonaws.ec2#String", + "RamdiskId": { + "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "smithy.api#documentation": "

The base64-encoded MIME user data.

" + "smithy.api#documentation": "

The ID of the RAM disk.

" } } }, @@ -48922,11 +50438,10 @@ "com.amazonaws.ec2#ScheduledInstancesNetworkInterface": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", "traits": { - "smithy.api#documentation": "

The IDs of the security groups.

", - "smithy.api#xmlName": "Group" + "smithy.api#documentation": "

The ID of the subnet.

" } }, "PrivateIpAddress": { @@ -48935,23 +50450,29 @@ "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

" } }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

" + } + }, "DeviceIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#documentation": "

The index of the device for the network interface attachment.

" } }, - "PrivateIpAddressConfigs": { - "target": "com.amazonaws.ec2#PrivateIpAddressConfigSet", + "Groups": { + "target": "com.amazonaws.ec2#ScheduledInstancesSecurityGroupIdSet", "traits": { - "smithy.api#documentation": "

The private IPv4 addresses.

", - "smithy.api#xmlName": "PrivateIpAddressConfig" + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "Group" } }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

Indicates whether to delete the interface when the instance is terminated.

" + "smithy.api#documentation": "

The number of secondary private IPv4 addresses.

" } }, "AssociatePublicIpAddress": { @@ -48966,17 +50487,11 @@ "smithy.api#documentation": "

The ID of the network interface.

" } }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList", - "traits": { - "smithy.api#documentation": "

The specific IPv6 addresses from the subnet range.

", - "smithy.api#xmlName": "Ipv6Address" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", + "PrivateIpAddressConfigs": { + "target": "com.amazonaws.ec2#PrivateIpAddressConfigSet", "traits": { - "smithy.api#documentation": "

The ID of the subnet.

" + "smithy.api#documentation": "

The private IPv4 addresses.

", + "smithy.api#xmlName": "PrivateIpAddressConfig" } }, "Description": { @@ -48985,16 +50500,17 @@ "smithy.api#documentation": "

The description.

" } }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#ScheduledInstancesIpv6AddressList", "traits": { - "smithy.api#documentation": "

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

" + "smithy.api#documentation": "

The specific IPv6 addresses from the subnet range.

", + "smithy.api#xmlName": "Ipv6Address" } }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The number of secondary private IPv4 addresses.

" + "smithy.api#documentation": "

Indicates whether to delete the interface when the instance is terminated.

" } } }, @@ -49069,12 +50585,24 @@ "target": "com.amazonaws.ec2#SearchLocalGatewayRoutesResult" }, "traits": { - "smithy.api#documentation": "

Searches for routes in the specified local gateway route table.

" + "smithy.api#documentation": "

Searches for routes in the specified local gateway route table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Routes", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#SearchLocalGatewayRoutesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -49083,6 +50611,12 @@ "smithy.api#xmlName": "Filter" } }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "LocalGatewayRouteTableId": { "target": "com.amazonaws.ec2#LocalGatewayRoutetableId", "traits": { @@ -49090,23 +50624,11 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } } } }, @@ -49140,24 +50662,18 @@ "target": "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsResult" }, "traits": { - "smithy.api#documentation": "

Searches one or more transit gateway multicast groups and returns the group membership information.

" + "smithy.api#documentation": "

Searches one or more transit gateway multicast groups and returns the group membership information.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MulticastGroups", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#SearchTransitGatewayMulticastGroupsRequest": { "type": "structure", "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", - "traits": { - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#TransitGatewayMaxResults", "traits": { @@ -49170,6 +50686,18 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainId", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { @@ -49218,16 +50746,15 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#required": {}, "smithy.api#xmlName": "Filter" } }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#required": {} + "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.

" } }, "MaxResults": { @@ -49236,10 +50763,11 @@ "smithy.api#documentation": "

The maximum number of routes to return.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { - "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#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#required": {} } } } @@ -49268,6 +50796,22 @@ "com.amazonaws.ec2#SecurityGroup": { "type": "structure", "members": { + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The inbound rules associated with the security group.

", + "smithy.api#xmlName": "ipPermissions" + } + }, "IpPermissionsEgress": { "target": "com.amazonaws.ec2#IpPermissionList", "traits": { @@ -49276,20 +50820,12 @@ "smithy.api#xmlName": "ipPermissionsEgress" } }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, - "VpcId": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

[VPC only] The ID of the VPC for the security group.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "GroupDescription", + "smithy.api#documentation": "

A description of the security group.

", + "smithy.api#xmlName": "groupDescription" } }, "Tags": { @@ -49300,22 +50836,6 @@ "smithy.api#xmlName": "tagSet" } }, - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#documentation": "

The inbound rules associated with the security group.

", - "smithy.api#xmlName": "ipPermissions" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -49324,12 +50844,20 @@ "smithy.api#xmlName": "ownerId" } }, - "Description": { + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GroupDescription", - "smithy.api#documentation": "

A description of the security group.

", - "smithy.api#xmlName": "groupDescription" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

[VPC only] The ID of the VPC for the security group.

", + "smithy.api#xmlName": "vpcId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" } } }, @@ -49352,14 +50880,6 @@ "com.amazonaws.ec2#SecurityGroupIdentifier": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, "GroupId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -49367,6 +50887,14 @@ "smithy.api#documentation": "

The ID of the security group.

", "smithy.api#xmlName": "groupId" } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } } }, "traits": { @@ -49388,14 +50916,6 @@ "com.amazonaws.ec2#SecurityGroupReference": { "type": "structure", "members": { - "GroupId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of your security group.

", - "smithy.api#xmlName": "groupId" - } - }, "ReferencingVpcId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -49404,6 +50924,14 @@ "smithy.api#xmlName": "referencingVpcId" } }, + "GroupId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of your security group.

", + "smithy.api#xmlName": "groupId" + } + }, "VpcPeeringConnectionId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -49471,44 +50999,44 @@ "com.amazonaws.ec2#ServiceConfiguration": { "type": "structure", "members": { - "ManagesVpcEndpoints": { - "target": "com.amazonaws.ec2#Boolean", + "NetworkLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", - "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", - "smithy.api#xmlName": "managesVpcEndpoints" + "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

", + "smithy.api#xmlName": "networkLoadBalancerArnSet" } }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", + "ServiceState": { + "target": "com.amazonaws.ec2#ServiceState", "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name for the service.

", - "smithy.api#xmlName": "privateDnsName" + "aws.protocols#ec2QueryName": "ServiceState", + "smithy.api#documentation": "

The service state.

", + "smithy.api#xmlName": "serviceState" } }, - "BaseEndpointDnsNames": { - "target": "com.amazonaws.ec2#ValueStringList", + "AcceptanceRequired": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", - "smithy.api#documentation": "

The DNS names for the service.

", - "smithy.api#xmlName": "baseEndpointDnsNameSet" + "aws.protocols#ec2QueryName": "AcceptanceRequired", + "smithy.api#documentation": "

Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.

", + "smithy.api#xmlName": "acceptanceRequired" } }, - "ServiceId": { + "ServiceName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the service.

", - "smithy.api#xmlName": "serviceId" + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service.

", + "smithy.api#xmlName": "serviceName" } }, - "ServiceType": { - "target": "com.amazonaws.ec2#ServiceTypeDetailSet", + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "ServiceType", - "smithy.api#documentation": "

The type of service.

", - "smithy.api#xmlName": "serviceType" + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#xmlName": "availabilityZoneSet" } }, "Tags": { @@ -49519,14 +51047,6 @@ "smithy.api#xmlName": "tagSet" } }, - "ServiceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ServiceName", - "smithy.api#documentation": "

The name of the service.

", - "smithy.api#xmlName": "serviceName" - } - }, "PrivateDnsNameConfiguration": { "target": "com.amazonaws.ec2#PrivateDnsNameConfiguration", "traits": { @@ -49535,36 +51055,44 @@ "smithy.api#xmlName": "privateDnsNameConfiguration" } }, - "ServiceState": { - "target": "com.amazonaws.ec2#ServiceState", + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceTypeDetailSet", "traits": { - "aws.protocols#ec2QueryName": "ServiceState", - "smithy.api#documentation": "

The service state.

", - "smithy.api#xmlName": "serviceState" + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" } }, - "AvailabilityZones": { + "BaseEndpointDnsNames": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneSet", - "smithy.api#documentation": "

The Availability Zones in which the service is available.

", - "smithy.api#xmlName": "availabilityZoneSet" + "aws.protocols#ec2QueryName": "BaseEndpointDnsNameSet", + "smithy.api#documentation": "

The DNS names for the service.

", + "smithy.api#xmlName": "baseEndpointDnsNameSet" } }, - "NetworkLoadBalancerArns": { - "target": "com.amazonaws.ec2#ValueStringList", + "ManagesVpcEndpoints": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "NetworkLoadBalancerArnSet", - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

", - "smithy.api#xmlName": "networkLoadBalancerArnSet" + "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", + "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", + "smithy.api#xmlName": "managesVpcEndpoints" } }, - "AcceptanceRequired": { - "target": "com.amazonaws.ec2#Boolean", + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AcceptanceRequired", - "smithy.api#documentation": "

Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.

", - "smithy.api#xmlName": "acceptanceRequired" + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name for the service.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service.

", + "smithy.api#xmlName": "serviceId" } } }, @@ -49584,12 +51112,20 @@ "com.amazonaws.ec2#ServiceDetail": { "type": "structure", "members": { - "VpcEndpointPolicySupported": { - "target": "com.amazonaws.ec2#Boolean", + "Owner": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointPolicySupported", - "smithy.api#documentation": "

Indicates whether the service supports endpoint policies.

", - "smithy.api#xmlName": "vpcEndpointPolicySupported" + "aws.protocols#ec2QueryName": "Owner", + "smithy.api#documentation": "

The AWS account ID of the service owner.

", + "smithy.api#xmlName": "owner" + } + }, + "ServiceType": { + "target": "com.amazonaws.ec2#ServiceTypeDetailSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceType", + "smithy.api#documentation": "

The type of service.

", + "smithy.api#xmlName": "serviceType" } }, "BaseEndpointDnsNames": { @@ -49600,28 +51136,36 @@ "smithy.api#xmlName": "baseEndpointDnsNameSet" } }, - "ManagesVpcEndpoints": { + "AcceptanceRequired": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", - "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", - "smithy.api#xmlName": "managesVpcEndpoints" + "aws.protocols#ec2QueryName": "AcceptanceRequired", + "smithy.api#documentation": "

Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

", + "smithy.api#xmlName": "acceptanceRequired" } }, - "ServiceType": { - "target": "com.amazonaws.ec2#ServiceTypeDetailSet", + "AvailabilityZones": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "ServiceType", - "smithy.api#documentation": "

The type of service.

", - "smithy.api#xmlName": "serviceType" + "aws.protocols#ec2QueryName": "AvailabilityZoneSet", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#xmlName": "availabilityZoneSet" } }, - "PrivateDnsNameVerificationState": { - "target": "com.amazonaws.ec2#DnsNameState", + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsNameVerificationState", - "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", - "smithy.api#xmlName": "privateDnsNameVerificationState" + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

The private DNS name for the service.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "ManagesVpcEndpoints": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ManagesVpcEndpoints", + "smithy.api#documentation": "

Indicates whether the service manages its VPC endpoints. Management of the service VPC\n endpoints using the VPC endpoint API is restricted.

", + "smithy.api#xmlName": "managesVpcEndpoints" } }, "ServiceName": { @@ -49632,22 +51176,6 @@ "smithy.api#xmlName": "serviceName" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the service.

", - "smithy.api#xmlName": "tagSet" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneSet", - "smithy.api#documentation": "

The Availability Zones in which the service is available.

", - "smithy.api#xmlName": "availabilityZoneSet" - } - }, "ServiceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -49656,28 +51184,28 @@ "smithy.api#xmlName": "serviceId" } }, - "AcceptanceRequired": { - "target": "com.amazonaws.ec2#Boolean", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "AcceptanceRequired", - "smithy.api#documentation": "

Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

", - "smithy.api#xmlName": "acceptanceRequired" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the service.

", + "smithy.api#xmlName": "tagSet" } }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", + "PrivateDnsNameVerificationState": { + "target": "com.amazonaws.ec2#DnsNameState", "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name for the service.

", - "smithy.api#xmlName": "privateDnsName" + "aws.protocols#ec2QueryName": "PrivateDnsNameVerificationState", + "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", + "smithy.api#xmlName": "privateDnsNameVerificationState" } }, - "Owner": { - "target": "com.amazonaws.ec2#String", + "VpcEndpointPolicySupported": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Owner", - "smithy.api#documentation": "

The AWS account ID of the service owner.

", - "smithy.api#xmlName": "owner" + "aws.protocols#ec2QueryName": "VpcEndpointPolicySupported", + "smithy.api#documentation": "

Indicates whether the service supports endpoint policies.

", + "smithy.api#xmlName": "vpcEndpointPolicySupported" } } }, @@ -49777,17 +51305,17 @@ "com.amazonaws.ec2#SlotDateTimeRangeRequest": { "type": "structure", "members": { - "EarliestTime": { + "LatestTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

", + "smithy.api#documentation": "

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

", "smithy.api#required": {} } }, - "LatestTime": { + "EarliestTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

", + "smithy.api#documentation": "

The earliest date and time, in UTC, for the Scheduled Instance to start.

", "smithy.api#required": {} } } @@ -49819,44 +51347,36 @@ "com.amazonaws.ec2#Snapshot": { "type": "structure", "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The AWS account ID of the EBS snapshot owner.

", - "smithy.api#xmlName": "ownerId" - } - }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#xmlName": "volumeSize" + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", + "smithy.api#xmlName": "startTime" } }, - "OwnerAlias": { - "target": "com.amazonaws.ec2#String", + "State": { + "target": "com.amazonaws.ec2#SnapshotState", "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The AWS owner alias, as maintained by Amazon. The possible values are: amazon | self |\n all | aws-marketplace | microsoft. This AWS owner alias is not to be \n confused with the user-configured AWS account alias, which is set from the IAM console.

", - "smithy.api#xmlName": "ownerAlias" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The snapshot state.

", + "smithy.api#xmlName": "status" } }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the snapshot. Each snapshot receives a unique identifier when it is\n created.

", - "smithy.api#xmlName": "snapshotId" + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" } }, - "VolumeId": { + "DataEncryptionKeyId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any\n purpose.

", - "smithy.api#xmlName": "volumeId" + "aws.protocols#ec2QueryName": "DataEncryptionKeyId", + "smithy.api#documentation": "

The data encryption key identifier for the snapshot. This value is a unique identifier\n that corresponds to the data encryption key that was used to encrypt the original volume or\n snapshot copy. Because data encryption keys are inherited by volumes created from snapshots,\n and vice versa, if snapshots share the same data encryption key identifier, then they belong\n to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", + "smithy.api#xmlName": "dataEncryptionKeyId" } }, "StateMessage": { @@ -49867,28 +51387,20 @@ "smithy.api#xmlName": "statusMessage" } }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the snapshot.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" } }, - "DataEncryptionKeyId": { + "VolumeId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DataEncryptionKeyId", - "smithy.api#documentation": "

The data encryption key identifier for the snapshot. This value is a unique identifier\n that corresponds to the data encryption key that was used to encrypt the original volume or\n snapshot copy. Because data encryption keys are inherited by volumes created from snapshots,\n and vice versa, if snapshots share the same data encryption key identifier, then they belong\n to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", - "smithy.api#xmlName": "dataEncryptionKeyId" + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any\n purpose.

", + "smithy.api#xmlName": "volumeId" } }, "Progress": { @@ -49899,6 +51411,22 @@ "smithy.api#xmlName": "progress" } }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID of the EBS snapshot owner.

", + "smithy.api#xmlName": "ownerId" + } + }, + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" + } + }, "KmsKeyId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -49907,28 +51435,28 @@ "smithy.api#xmlName": "kmsKeyId" } }, - "Description": { + "OwnerAlias": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description for the snapshot.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The AWS owner alias, as maintained by Amazon. The possible values are: amazon | self |\n all | aws-marketplace | microsoft. This AWS owner alias is not to be \n confused with the user-configured AWS account alias, which is set from the IAM console.

", + "smithy.api#xmlName": "ownerAlias" } }, - "State": { - "target": "com.amazonaws.ec2#SnapshotState", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The snapshot state.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the snapshot.

", + "smithy.api#xmlName": "tagSet" } }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", + "SnapshotId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", - "smithy.api#xmlName": "startTime" + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the snapshot. Each snapshot receives a unique identifier when it is\n created.

", + "smithy.api#xmlName": "snapshotId" } } }, @@ -49952,6 +51480,14 @@ "com.amazonaws.ec2#SnapshotDetail": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status of the snapshot creation.

", + "smithy.api#xmlName": "status" + } + }, "SnapshotId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -49960,28 +51496,28 @@ "smithy.api#xmlName": "snapshotId" } }, - "DeviceName": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The block device mapping for the snapshot.

", - "smithy.api#xmlName": "deviceName" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the snapshot.

", + "smithy.api#xmlName": "description" } }, - "Status": { + "Format": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status of the snapshot creation.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "format" } }, - "Url": { - "target": "com.amazonaws.ec2#String", + "DiskImageSize": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "Url", - "smithy.api#documentation": "

The URL used to access the disk image.

", - "smithy.api#xmlName": "url" + "aws.protocols#ec2QueryName": "DiskImageSize", + "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", + "smithy.api#xmlName": "diskImageSize" } }, "UserBucket": { @@ -49992,14 +51528,6 @@ "smithy.api#xmlName": "userBucket" } }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percentage of progress for the task.

", - "smithy.api#xmlName": "progress" - } - }, "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50008,28 +51536,28 @@ "smithy.api#xmlName": "statusMessage" } }, - "Description": { + "Url": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the snapshot.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "Url", + "smithy.api#documentation": "

The URL used to access the disk image.

", + "smithy.api#xmlName": "url" } }, - "DiskImageSize": { - "target": "com.amazonaws.ec2#Double", + "Progress": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DiskImageSize", - "smithy.api#documentation": "

The size of the disk in the snapshot, in GiB.

", - "smithy.api#xmlName": "diskImageSize" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of progress for the task.

", + "smithy.api#xmlName": "progress" } }, - "Format": { + "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Format", - "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", - "smithy.api#xmlName": "format" + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The block device mapping for the snapshot.

", + "smithy.api#xmlName": "deviceName" } } }, @@ -50049,6 +51577,12 @@ "com.amazonaws.ec2#SnapshotDiskContainer": { "type": "structure", "members": { + "Url": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon\n S3 URL (s3://..).

" + } + }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50061,12 +51595,6 @@ "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

" } }, - "Url": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon\n S3 URL (s3://..).

" - } - }, "Format": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50093,6 +51621,30 @@ "com.amazonaws.ec2#SnapshotInfo": { "type": "structure", "members": { + "Progress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

Progress this snapshot has made towards completing.

", + "smithy.api#xmlName": "progress" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

Time this snapshot was started. This is the same for all snapshots initiated by the\n same request.

", + "smithy.api#xmlName": "startTime" + } + }, + "State": { + "target": "com.amazonaws.ec2#SnapshotState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

Current state of the snapshot.

", + "smithy.api#xmlName": "state" + } + }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50101,14 +51653,6 @@ "smithy.api#xmlName": "description" } }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, "VolumeId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50117,6 +51661,14 @@ "smithy.api#xmlName": "volumeId" } }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" + } + }, "SnapshotId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50125,22 +51677,6 @@ "smithy.api#xmlName": "snapshotId" } }, - "State": { - "target": "com.amazonaws.ec2#SnapshotState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

Current state of the snapshot.

", - "smithy.api#xmlName": "state" - } - }, - "Progress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

Progress this snapshot has made towards completing.

", - "smithy.api#xmlName": "progress" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50164,14 +51700,6 @@ "smithy.api#documentation": "

Tags associated with this snapshot.

", "smithy.api#xmlName": "tagSet" } - }, - "StartTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

Time this snapshot was started. This is the same for all snapshots initiated by the\n same request.

", - "smithy.api#xmlName": "startTime" - } } }, "traits": { @@ -50215,20 +51743,20 @@ "com.amazonaws.ec2#SnapshotTaskDetail": { "type": "structure", "members": { - "SnapshotId": { + "KmsKeyId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", - "smithy.api#xmlName": "snapshotId" + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create\n the encrypted snapshot.

", + "smithy.api#xmlName": "kmsKeyId" } }, - "Status": { + "Format": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

A brief status for the import snapshot task.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "Format", + "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "format" } }, "Encrypted": { @@ -50239,28 +51767,28 @@ "smithy.api#xmlName": "encrypted" } }, - "Description": { + "SnapshotId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the snapshot.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot ID of the disk being imported.

", + "smithy.api#xmlName": "snapshotId" } }, - "Url": { + "StatusMessage": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Url", - "smithy.api#documentation": "

The URL of the disk image from which the snapshot is created.

", - "smithy.api#xmlName": "url" + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

A detailed status message for the import snapshot task.

", + "smithy.api#xmlName": "statusMessage" } }, - "Progress": { - "target": "com.amazonaws.ec2#String", + "UserBucket": { + "target": "com.amazonaws.ec2#UserBucketDetails", "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The percentage of completion for the import snapshot task.

", - "smithy.api#xmlName": "progress" + "aws.protocols#ec2QueryName": "UserBucket", + "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", + "smithy.api#xmlName": "userBucket" } }, "DiskImageSize": { @@ -50271,36 +51799,36 @@ "smithy.api#xmlName": "diskImageSize" } }, - "StatusMessage": { + "Status": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StatusMessage", - "smithy.api#documentation": "

A detailed status message for the import snapshot task.

", - "smithy.api#xmlName": "statusMessage" + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

A brief status for the import snapshot task.

", + "smithy.api#xmlName": "status" } }, - "UserBucket": { - "target": "com.amazonaws.ec2#UserBucketDetails", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UserBucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the disk image.

", - "smithy.api#xmlName": "userBucket" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the snapshot.

", + "smithy.api#xmlName": "description" } }, - "Format": { + "Url": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Format", - "smithy.api#documentation": "

The format of the disk image from which the snapshot is created.

", - "smithy.api#xmlName": "format" + "aws.protocols#ec2QueryName": "Url", + "smithy.api#documentation": "

The URL of the disk image from which the snapshot is created.

", + "smithy.api#xmlName": "url" } }, - "KmsKeyId": { + "Progress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create\n the encrypted snapshot.

", - "smithy.api#xmlName": "kmsKeyId" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The percentage of completion for the import snapshot task.

", + "smithy.api#xmlName": "progress" } } }, @@ -50338,6 +51866,14 @@ "smithy.api#xmlName": "prefix" } }, + "Bucket": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Bucket", + "smithy.api#documentation": "

The Amazon S3 bucket where the Spot Instance data feed is located.

", + "smithy.api#xmlName": "bucket" + } + }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -50361,14 +51897,6 @@ "smithy.api#documentation": "

The state of the Spot Instance data feed subscription.

", "smithy.api#xmlName": "state" } - }, - "Bucket": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Bucket", - "smithy.api#documentation": "

The Amazon S3 bucket where the Spot Instance data feed is located.

", - "smithy.api#xmlName": "bucket" - } } }, "traits": { @@ -50378,30 +51906,6 @@ "com.amazonaws.ec2#SpotFleetLaunchSpecification": { "type": "structure", "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

One or more block devices that are mapped to the Spot Instances. You can't specify both\n a snapshot ID and an encryption value. This is because only blank volumes can be\n encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its\n encryption status is used for the volume encryption status.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", - "smithy.api#xmlName": "groupSet" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" - } - }, "NetworkInterfaces": { "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", "traits": { @@ -50426,6 +51930,30 @@ "smithy.api#xmlName": "placement" } }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The IAM instance profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.ec2#Double", + "traits": { + "aws.protocols#ec2QueryName": "WeightedCapacity", + "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.

", + "smithy.api#xmlName": "weightedCapacity" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#SpotFleetTagSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "TagSpecificationSet", + "smithy.api#documentation": "

The tags to apply during creation.

", + "smithy.api#xmlName": "tagSpecificationSet" + } + }, "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { @@ -50434,92 +51962,92 @@ "smithy.api#xmlName": "instanceType" } }, - "Monitoring": { - "target": "com.amazonaws.ec2#SpotFleetMonitoring", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

Enable or disable monitoring for the instances.

", - "smithy.api#xmlName": "monitoring" + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

One or more block devices that are mapped to the Spot Instances. You can't specify both\n a snapshot ID and an encryption value. This is because only blank volumes can be\n encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its\n encryption status is used for the volume encryption status.

", + "smithy.api#xmlName": "blockDeviceMapping" } }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. \n If this value is not specified, the default is the Spot price specified for the fleet.\n To determine the Spot price per unit hour, divide the Spot price by the\n value of WeightedCapacity.

", - "smithy.api#xmlName": "spotPrice" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#SpotFleetTagSpecificationList", + "SubnetId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSpecificationSet", - "smithy.api#documentation": "

The tags to apply during creation.

", - "smithy.api#xmlName": "tagSpecificationSet" + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", + "smithy.api#xmlName": "subnetId" } }, - "RamdiskId": { + "KernelId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.

", - "smithy.api#xmlName": "ramdiskId" + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" } }, - "UserData": { + "AddressingType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The Base64-encoded user data that instances use when starting up.

", - "smithy.api#xmlName": "userData" + "aws.protocols#ec2QueryName": "AddressingType", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "addressingType" } }, - "ImageId": { + "SpotPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. \n If this value is not specified, the default is the Spot price specified for the fleet.\n To determine the Spot price per unit hour, divide the Spot price by the\n value of WeightedCapacity.

", + "smithy.api#xmlName": "spotPrice" } }, - "WeightedCapacity": { - "target": "com.amazonaws.ec2#Double", + "RamdiskId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "WeightedCapacity", - "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.

", - "smithy.api#xmlName": "weightedCapacity" + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.

", + "smithy.api#xmlName": "ramdiskId" } }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "ImageId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The IAM instance profile.

", - "smithy.api#xmlName": "iamInstanceProfile" + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", + "Monitoring": { + "target": "com.amazonaws.ec2#SpotFleetMonitoring", "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate\n them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", - "smithy.api#xmlName": "subnetId" + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Enable or disable monitoring for the instances.

", + "smithy.api#xmlName": "monitoring" } }, - "AddressingType": { + "UserData": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AddressingType", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "addressingType" + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The Base64-encoded user data that instances use when starting up.

", + "smithy.api#xmlName": "userData" } }, - "KernelId": { - "target": "com.amazonaws.ec2#String", + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "smithy.api#xmlName": "groupSet" } } }, @@ -50546,22 +52074,6 @@ "com.amazonaws.ec2#SpotFleetRequestConfig": { "type": "structure", "members": { - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestId" - } - }, - "SpotFleetRequestState": { - "target": "com.amazonaws.ec2#BatchState", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestState", - "smithy.api#documentation": "

The state of the Spot Fleet request.

", - "smithy.api#xmlName": "spotFleetRequestState" - } - }, "ActivityStatus": { "target": "com.amazonaws.ec2#ActivityStatus", "traits": { @@ -50570,12 +52082,12 @@ "smithy.api#xmlName": "activityStatus" } }, - "CreateTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The creation date and time of the request.

", - "smithy.api#xmlName": "createTime" + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestId" } }, "SpotFleetRequestConfig": { @@ -50593,6 +52105,22 @@ "smithy.api#documentation": "

The tags for a Spot Fleet resource.

", "smithy.api#xmlName": "tagSet" } + }, + "SpotFleetRequestState": { + "target": "com.amazonaws.ec2#BatchState", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestState", + "smithy.api#documentation": "

The state of the Spot Fleet request.

", + "smithy.api#xmlName": "spotFleetRequestState" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The creation date and time of the request.

", + "smithy.api#xmlName": "createTime" + } } }, "traits": { @@ -50602,28 +52130,36 @@ "com.amazonaws.ec2#SpotFleetRequestConfigData": { "type": "structure", "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "ReplaceUnhealthyInstances": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tagging Your Resources.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", + "smithy.api#documentation": "

Indicates whether Spot Fleet should replace unhealthy instances.

", + "smithy.api#xmlName": "replaceUnhealthyInstances" } }, - "TargetCapacity": { - "target": "com.amazonaws.ec2#Integer", + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", "traits": { - "aws.protocols#ec2QueryName": "TargetCapacity", - "smithy.api#documentation": "

The number of units to request for the Spot Fleet. You can choose to set the target\n capacity in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "targetCapacity" + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running Spot Instances should be terminated if you decrease the target\n capacity of the Spot Fleet request below the current size of the Spot Fleet.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" } }, - "ValidFrom": { - "target": "com.amazonaws.ec2#DateTime", + "TerminateInstancesWithExpiration": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n By default, Amazon EC2 starts fulfilling the request immediately.

", - "smithy.api#xmlName": "validFrom" + "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", + "smithy.api#documentation": "

Indicates whether running Spot Instances are terminated when the Spot Fleet request\n expires.

", + "smithy.api#xmlName": "terminateInstancesWithExpiration" + } + }, + "LoadBalancersConfig": { + "target": "com.amazonaws.ec2#LoadBalancersConfig", + "traits": { + "aws.protocols#ec2QueryName": "LoadBalancersConfig", + "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. \n Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types:\n C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

", + "smithy.api#xmlName": "loadBalancersConfig" } }, "InstanceInterruptionBehavior": { @@ -50634,44 +52170,44 @@ "smithy.api#xmlName": "instanceInterruptionBehavior" } }, - "LaunchTemplateConfigs": { - "target": "com.amazonaws.ec2#LaunchTemplateConfigList", + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", - "smithy.api#documentation": "

The launch template and overrides. If you specify LaunchTemplateConfigs,\n you can't specify LaunchSpecifications. If you include On-Demand capacity\n in your request, you must use LaunchTemplateConfigs.

", - "smithy.api#xmlName": "launchTemplateConfigs" + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n After the end date and time, no new Spot Instance requests are placed or able to fulfill the request.\n If no value is specified, the Spot Fleet request remains until you cancel it.

", + "smithy.api#xmlName": "validUntil" } }, - "AllocationStrategy": { - "target": "com.amazonaws.ec2#AllocationStrategy", + "OnDemandFulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the Spot Fleet request.

\n

If the allocation strategy is lowestPrice, Spot Fleet launches instances from\n the Spot Instance pools with the lowest price. This is the default allocation strategy.

\n

If the allocation strategy is diversified, Spot Fleet launches instances from\n all the Spot Instance pools that you specify.

\n

If the allocation strategy is capacityOptimized, Spot Fleet launches instances\n from Spot Instance pools with optimal capacity for the number of instances that are\n launching.

", - "smithy.api#xmlName": "allocationStrategy" + "aws.protocols#ec2QueryName": "OnDemandFulfilledCapacity", + "smithy.api#documentation": "

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

", + "smithy.api#xmlName": "onDemandFulfilledCapacity" } }, - "FulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", + "TargetCapacity": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "FulfilledCapacity", - "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

", - "smithy.api#xmlName": "fulfilledCapacity" + "aws.protocols#ec2QueryName": "TargetCapacity", + "smithy.api#documentation": "

The number of units to request for the Spot Fleet. You can choose to set the target\n capacity in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "targetCapacity" } }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

", - "smithy.api#xmlName": "spotPrice" + "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

", + "smithy.api#xmlName": "instancePoolsToUseCount" } }, - "ReplaceUnhealthyInstances": { - "target": "com.amazonaws.ec2#Boolean", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "ReplaceUnhealthyInstances", - "smithy.api#documentation": "

Indicates whether Spot Fleet should replace unhealthy instances.

", - "smithy.api#xmlName": "replaceUnhealthyInstances" + "smithy.api#documentation": "

The key-value pair for tagging the Spot Fleet request on creation. The value for\n ResourceType must be spot-fleet-request, otherwise the\n Spot Fleet request fails. To tag instances at launch, specify the tags in the launch\n template (valid only if you use LaunchTemplateConfigs) or in\n the \n SpotFleetTagSpecification\n (valid only if you use\n LaunchSpecifications). For information about tagging after launch, see\n Tagging Your Resources.

", + "smithy.api#xmlName": "TagSpecification" } }, "IamFleetRole": { @@ -50683,60 +52219,60 @@ "smithy.api#xmlName": "iamFleetRole" } }, - "SpotMaxTotalPrice": { + "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SpotMaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay.\n You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed \n your budget. If you set a maximum price per hour for the On-Demand Instances and \n Spot Instances in your request, Spot Fleet will launch instances until it reaches\n the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached,\n the fleet stops launching instances even if it hasn’t met the target capacity.

", - "smithy.api#xmlName": "spotMaxTotalPrice" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of\n your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" } }, - "InstancePoolsToUseCount": { - "target": "com.amazonaws.ec2#Integer", + "LaunchTemplateConfigs": { + "target": "com.amazonaws.ec2#LaunchTemplateConfigList", "traits": { - "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

", - "smithy.api#xmlName": "instancePoolsToUseCount" + "aws.protocols#ec2QueryName": "LaunchTemplateConfigs", + "smithy.api#documentation": "

The launch template and overrides. If you specify LaunchTemplateConfigs,\n you can't specify LaunchSpecifications. If you include On-Demand capacity\n in your request, you must use LaunchTemplateConfigs.

", + "smithy.api#xmlName": "launchTemplateConfigs" } }, - "LoadBalancersConfig": { - "target": "com.amazonaws.ec2#LoadBalancersConfig", + "OnDemandAllocationStrategy": { + "target": "com.amazonaws.ec2#OnDemandAllocationStrategy", "traits": { - "aws.protocols#ec2QueryName": "LoadBalancersConfig", - "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. \n Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types:\n C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

", - "smithy.api#xmlName": "loadBalancersConfig" + "aws.protocols#ec2QueryName": "OnDemandAllocationStrategy", + "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity.\n If you specify lowestPrice, Spot Fleet uses price to determine the order,\n launching the lowest price first. If you specify prioritized, Spot Fleet uses the\n priority that you assign to each Spot Fleet launch template override, launching the highest\n priority first. If you do not specify a value, Spot Fleet defaults to\n lowestPrice.

", + "smithy.api#xmlName": "onDemandAllocationStrategy" } }, - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", + "SpotMaxTotalPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running Spot Instances should be terminated if you decrease the target\n capacity of the Spot Fleet request below the current size of the Spot Fleet.

", - "smithy.api#xmlName": "excessCapacityTerminationPolicy" + "aws.protocols#ec2QueryName": "SpotMaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay.\n You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed \n your budget. If you set a maximum price per hour for the On-Demand Instances and \n Spot Instances in your request, Spot Fleet will launch instances until it reaches\n the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached,\n the fleet stops launching instances even if it hasn’t met the target capacity.

", + "smithy.api#xmlName": "spotMaxTotalPrice" } }, - "OnDemandMaxTotalPrice": { - "target": "com.amazonaws.ec2#String", + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "OnDemandMaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay. \n You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed \n your budget. If you set a maximum price per hour for the On-Demand Instances and \n Spot Instances in your request, Spot Fleet will launch instances until it reaches\n the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached,\n the fleet stops launching instances even if it hasn’t met the target capacity.

", - "smithy.api#xmlName": "onDemandMaxTotalPrice" + "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", + "smithy.api#documentation": "

The number of On-Demand units to request. You can choose to set the target capacity\n in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

", + "smithy.api#xmlName": "onDemandTargetCapacity" } }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", + "AllocationStrategy": { + "target": "com.amazonaws.ec2#AllocationStrategy", "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n After the end date and time, no new Spot Instance requests are placed or able to fulfill the request.\n If no value is specified, the Spot Fleet request remains until you cancel it.

", - "smithy.api#xmlName": "validUntil" + "aws.protocols#ec2QueryName": "AllocationStrategy", + "smithy.api#documentation": "

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the Spot Fleet request.

\n

If the allocation strategy is lowestPrice, Spot Fleet launches instances from\n the Spot Instance pools with the lowest price. This is the default allocation strategy.

\n

If the allocation strategy is diversified, Spot Fleet launches instances from\n all the Spot Instance pools that you specify.

\n

If the allocation strategy is capacityOptimized, Spot Fleet launches instances\n from Spot Instance pools with optimal capacity for the number of instances that are\n launching.

", + "smithy.api#xmlName": "allocationStrategy" } }, - "Type": { - "target": "com.amazonaws.ec2#FleetType", + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of request. Indicates whether the Spot Fleet only requests the target capacity\n or also attempts to maintain it. When this value is request, the Spot Fleet\n only places the required requests. It does not attempt to replenish Spot Instances if\n capacity is diminished, nor does it submit requests in alternative Spot pools if\n capacity is not available. When this value is maintain, the Spot Fleet\n maintains the target capacity. The Spot Fleet places the required requests to meet\n capacity and automatically replenishes any interrupted instances. Default:\n maintain. instant is listed but is not used by Spot\n Fleet.

", - "smithy.api#xmlName": "type" + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n By default, Amazon EC2 starts fulfilling the request immediately.

", + "smithy.api#xmlName": "validFrom" } }, "LaunchSpecifications": { @@ -50747,44 +52283,36 @@ "smithy.api#xmlName": "launchSpecifications" } }, - "OnDemandAllocationStrategy": { - "target": "com.amazonaws.ec2#OnDemandAllocationStrategy", + "SpotPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OnDemandAllocationStrategy", - "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity.\n If you specify lowestPrice, Spot Fleet uses price to determine the order,\n launching the lowest price first. If you specify prioritized, Spot Fleet uses the\n priority that you assign to each Spot Fleet launch template override, launching the highest\n priority first. If you do not specify a value, Spot Fleet defaults to\n lowestPrice.

", - "smithy.api#xmlName": "onDemandAllocationStrategy" + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

", + "smithy.api#xmlName": "spotPrice" } }, - "OnDemandFulfilledCapacity": { - "target": "com.amazonaws.ec2#Double", + "Type": { + "target": "com.amazonaws.ec2#FleetType", "traits": { - "aws.protocols#ec2QueryName": "OnDemandFulfilledCapacity", - "smithy.api#documentation": "

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

", - "smithy.api#xmlName": "onDemandFulfilledCapacity" + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of request. Indicates whether the Spot Fleet only requests the target capacity\n or also attempts to maintain it. When this value is request, the Spot Fleet\n only places the required requests. It does not attempt to replenish Spot Instances if\n capacity is diminished, nor does it submit requests in alternative Spot pools if\n capacity is not available. When this value is maintain, the Spot Fleet\n maintains the target capacity. The Spot Fleet places the required requests to meet\n capacity and automatically replenishes any interrupted instances. Default:\n maintain. instant is listed but is not used by Spot\n Fleet.

", + "smithy.api#xmlName": "type" } }, - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", + "FulfilledCapacity": { + "target": "com.amazonaws.ec2#Double", "traits": { - "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", - "smithy.api#documentation": "

The number of On-Demand units to request. You can choose to set the target capacity\n in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

", - "smithy.api#xmlName": "onDemandTargetCapacity" + "aws.protocols#ec2QueryName": "FulfilledCapacity", + "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

", + "smithy.api#xmlName": "fulfilledCapacity" } }, - "ClientToken": { + "OnDemandMaxTotalPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of\n your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "TerminateInstancesWithExpiration": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "TerminateInstancesWithExpiration", - "smithy.api#documentation": "

Indicates whether running Spot Instances are terminated when the Spot Fleet request\n expires.

", - "smithy.api#xmlName": "terminateInstancesWithExpiration" + "aws.protocols#ec2QueryName": "OnDemandMaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay. \n You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed \n your budget. If you set a maximum price per hour for the On-Demand Instances and \n Spot Instances in your request, Spot Fleet will launch instances until it reaches\n the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached,\n the fleet stops launching instances even if it hasn’t met the target capacity.

", + "smithy.api#xmlName": "onDemandMaxTotalPrice" } } }, @@ -50816,14 +52344,6 @@ "com.amazonaws.ec2#SpotFleetTagSpecification": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "Tag", - "smithy.api#documentation": "

The tags.

", - "smithy.api#xmlName": "tag" - } - }, "ResourceType": { "target": "com.amazonaws.ec2#ResourceType", "traits": { @@ -50831,6 +52351,14 @@ "smithy.api#documentation": "

The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .

", "smithy.api#xmlName": "resourceType" } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "Tag", + "smithy.api#documentation": "

The tags.

", + "smithy.api#xmlName": "tag" + } } }, "traits": { @@ -50865,92 +52393,68 @@ "com.amazonaws.ec2#SpotInstanceRequest": { "type": "structure", "members": { - "Fault": { - "target": "com.amazonaws.ec2#SpotInstanceStateFault", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "aws.protocols#ec2QueryName": "Fault", - "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", - "smithy.api#xmlName": "fault" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", + "smithy.api#xmlName": "instanceId" } }, - "ValidFrom": { + "CreateTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). \n The request becomes active at this date and time.

", - "smithy.api#xmlName": "validFrom" - } - }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#LaunchSpecification", - "traits": { - "aws.protocols#ec2QueryName": "LaunchSpecification", - "smithy.api#documentation": "

Additional information for launching instances.

", - "smithy.api#xmlName": "launchSpecification" - } - }, - "SpotInstanceRequestId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SpotInstanceRequestId", - "smithy.api#documentation": "

The ID of the Spot Instance request.

", - "smithy.api#xmlName": "spotInstanceRequestId" + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "createTime" } }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

The product description associated with the Spot Instance.

", - "smithy.api#xmlName": "productDescription" + "aws.protocols#ec2QueryName": "ValidUntil", + "smithy.api#documentation": "

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). \n If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. \n\t\tIf the request is persistent, it remains active until it is canceled or this date is reached.\n The default end date is 7 days from the current date.

", + "smithy.api#xmlName": "validUntil" } }, - "ActualBlockHourlyPrice": { - "target": "com.amazonaws.ec2#String", + "State": { + "target": "com.amazonaws.ec2#SpotInstanceState", "traits": { - "aws.protocols#ec2QueryName": "ActualBlockHourlyPrice", - "smithy.api#documentation": "

If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.

", - "smithy.api#xmlName": "actualBlockHourlyPrice" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Spot Instance request. Spot status information helps track your Spot\n Instance requests. For more information, see Spot status in the\n Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#xmlName": "state" } }, - "LaunchGroup": { + "LaunchedAvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", - "smithy.api#xmlName": "launchGroup" + "aws.protocols#ec2QueryName": "LaunchedAvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the request is launched.

", + "smithy.api#xmlName": "launchedAvailabilityZone" } }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", - "smithy.api#xmlName": "instanceInterruptionBehavior" + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#documentation": "

The duration for the Spot Instance, in minutes.

", + "smithy.api#xmlName": "blockDurationMinutes" } }, - "AvailabilityZoneGroup": { + "SpotInstanceRequestId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", - "smithy.api#documentation": "

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

", - "smithy.api#xmlName": "availabilityZoneGroup" - } - }, - "State": { - "target": "com.amazonaws.ec2#SpotInstanceState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Spot Instance request. Spot status information helps track your Spot\n Instance requests. For more information, see Spot status in the\n Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "SpotInstanceRequestId", + "smithy.api#documentation": "

The ID of the Spot Instance request.

", + "smithy.api#xmlName": "spotInstanceRequestId" } }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", + "SpotPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). \n If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. \n\t\tIf the request is persistent, it remains active until it is canceled or this date is reached.\n The default end date is 7 days from the current date.

", - "smithy.api#xmlName": "validUntil" + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per hour that you are willing to pay for a Spot Instance.

", + "smithy.api#xmlName": "spotPrice" } }, "Tags": { @@ -50969,52 +52473,76 @@ "smithy.api#xmlName": "type" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The product description associated with the Spot Instance.

", + "smithy.api#xmlName": "productDescription" } }, - "Status": { - "target": "com.amazonaws.ec2#SpotInstanceStatus", + "ValidFrom": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The status code and status message describing the Spot Instance request.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "ValidFrom", + "smithy.api#documentation": "

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). \n The request becomes active at this date and time.

", + "smithy.api#xmlName": "validFrom" } }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", + "LaunchSpecification": { + "target": "com.amazonaws.ec2#LaunchSpecification", "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "createTime" + "aws.protocols#ec2QueryName": "LaunchSpecification", + "smithy.api#documentation": "

Additional information for launching instances.

", + "smithy.api#xmlName": "launchSpecification" } }, - "SpotPrice": { + "Fault": { + "target": "com.amazonaws.ec2#SpotInstanceStateFault", + "traits": { + "aws.protocols#ec2QueryName": "Fault", + "smithy.api#documentation": "

The fault codes for the Spot Instance request, if any.

", + "smithy.api#xmlName": "fault" + } + }, + "LaunchGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per hour that you are willing to pay for a Spot Instance.

", - "smithy.api#xmlName": "spotPrice" + "aws.protocols#ec2QueryName": "LaunchGroup", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", + "smithy.api#xmlName": "launchGroup" } }, - "LaunchedAvailabilityZone": { + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" + } + }, + "Status": { + "target": "com.amazonaws.ec2#SpotInstanceStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status code and status message describing the Spot Instance request.

", + "smithy.api#xmlName": "status" + } + }, + "ActualBlockHourlyPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LaunchedAvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the request is launched.

", - "smithy.api#xmlName": "launchedAvailabilityZone" + "aws.protocols#ec2QueryName": "ActualBlockHourlyPrice", + "smithy.api#documentation": "

If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.

", + "smithy.api#xmlName": "actualBlockHourlyPrice" } }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", + "AvailabilityZoneGroup": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#documentation": "

The duration for the Spot Instance, in minutes.

", - "smithy.api#xmlName": "blockDurationMinutes" + "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", + "smithy.api#documentation": "

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneGroup" } } }, @@ -51068,14 +52596,6 @@ "com.amazonaws.ec2#SpotInstanceStateFault": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The message for the Spot Instance state change.

", - "smithy.api#xmlName": "message" - } - }, "Code": { "target": "com.amazonaws.ec2#String", "traits": { @@ -51083,6 +52603,14 @@ "smithy.api#documentation": "

The reason code for the Spot Instance state change.

", "smithy.api#xmlName": "code" } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The message for the Spot Instance state change.

", + "smithy.api#xmlName": "message" + } } }, "traits": { @@ -51100,14 +52628,6 @@ "smithy.api#xmlName": "updateTime" } }, - "Message": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The description for the status code.

", - "smithy.api#xmlName": "message" - } - }, "Code": { "target": "com.amazonaws.ec2#String", "traits": { @@ -51115,6 +52635,14 @@ "smithy.api#documentation": "

The status code. For a list of status codes, see Spot status codes\n in the Amazon EC2 User Guide for Linux Instances.

", "smithy.api#xmlName": "code" } + }, + "Message": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Message", + "smithy.api#documentation": "

The description for the status code.

", + "smithy.api#xmlName": "message" + } } }, "traits": { @@ -51137,10 +52665,10 @@ "com.amazonaws.ec2#SpotMarketOptions": { "type": "structure", "members": { - "SpotInstanceType": { - "target": "com.amazonaws.ec2#SpotInstanceType", + "ValidUntil": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The Spot Instance request type. For RunInstances, persistent Spot\n Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or\n stop.

" + "smithy.api#documentation": "

The end date of the request. For a one-time request, the request remains active until\n all instances launch, the request is canceled, or this date is reached. If the request\n is persistent, it remains active until it is canceled or this date and time is reached.\n The default end date is 7 days from the current date.

" } }, "InstanceInterruptionBehavior": { @@ -51149,10 +52677,10 @@ "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is\n terminate.

" } }, - "ValidUntil": { - "target": "com.amazonaws.ec2#DateTime", + "MaxPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The end date of the request. For a one-time request, the request remains active until\n all instances launch, the request is canceled, or this date is reached. If the request\n is persistent, it remains active until it is canceled or this date and time is reached.\n The default end date is 7 days from the current date.

" + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. The default is\n the On-Demand price.

" } }, "BlockDurationMinutes": { @@ -51161,10 +52689,10 @@ "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes.\n This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

" } }, - "MaxPrice": { - "target": "com.amazonaws.ec2#String", + "SpotInstanceType": { + "target": "com.amazonaws.ec2#SpotInstanceType", "traits": { - "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. The default is\n the On-Demand price.

" + "smithy.api#documentation": "

The Spot Instance request type. For RunInstances, persistent Spot\n Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or\n stop.

" } } }, @@ -51175,6 +52703,22 @@ "com.amazonaws.ec2#SpotOptions": { "type": "structure", "members": { + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

", + "smithy.api#xmlName": "instancePoolsToUseCount" + } + }, + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MaxTotalPrice", + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay.

", + "smithy.api#xmlName": "maxTotalPrice" + } + }, "SingleAvailabilityZone": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -51183,20 +52727,12 @@ "smithy.api#xmlName": "singleAvailabilityZone" } }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "MinTargetCapacity", - "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

", - "smithy.api#xmlName": "minTargetCapacity" - } - }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

", - "smithy.api#xmlName": "instanceInterruptionBehavior" + "aws.protocols#ec2QueryName": "SingleInstanceType", + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.\n Supported only for fleets of type instant.

", + "smithy.api#xmlName": "singleInstanceType" } }, "AllocationStrategy": { @@ -51207,28 +52743,20 @@ "smithy.api#xmlName": "allocationStrategy" } }, - "InstancePoolsToUseCount": { + "MinTargetCapacity": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

", - "smithy.api#xmlName": "instancePoolsToUseCount" - } - }, - "SingleInstanceType": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "SingleInstanceType", - "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.\n Supported only for fleets of type instant.

", - "smithy.api#xmlName": "singleInstanceType" + "aws.protocols#ec2QueryName": "MinTargetCapacity", + "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

", + "smithy.api#xmlName": "minTargetCapacity" } }, - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", "traits": { - "aws.protocols#ec2QueryName": "MaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay.

", - "smithy.api#xmlName": "maxTotalPrice" + "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

", + "smithy.api#xmlName": "instanceInterruptionBehavior" } } }, @@ -51239,46 +52767,46 @@ "com.amazonaws.ec2#SpotOptionsRequest": { "type": "structure", "members": { - "MaxTotalPrice": { - "target": "com.amazonaws.ec2#String", + "SingleInstanceType": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay.

" + "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.\n Supported only for fleets of type instant.

" } }, - "MinTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", + "SingleAvailabilityZone": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

" + "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported\n only for fleets of type instant.

" } }, - "InstancePoolsToUseCount": { - "target": "com.amazonaws.ec2#Integer", + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", "traits": { - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when Spot AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

" + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" } }, - "AllocationStrategy": { - "target": "com.amazonaws.ec2#SpotAllocationStrategy", + "InstancePoolsToUseCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the EC2 Fleet.

\n

If the allocation strategy is lowest-price, EC2 Fleet launches instances from\n the Spot Instance pools with the lowest price. This is the default allocation strategy.

\n

If the allocation strategy is diversified, EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.

\n

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances\n from Spot Instance pools with optimal capacity for the number of instances that are\n launching.

" + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when Spot AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

" } }, - "SingleInstanceType": { - "target": "com.amazonaws.ec2#Boolean", + "MinTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.\n Supported only for fleets of type instant.

" + "smithy.api#documentation": "

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is\n not reached, the fleet launches no instances.

" } }, - "SingleAvailabilityZone": { - "target": "com.amazonaws.ec2#Boolean", + "AllocationStrategy": { + "target": "com.amazonaws.ec2#SpotAllocationStrategy", "traits": { - "smithy.api#documentation": "

Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported\n only for fleets of type instant.

" + "smithy.api#documentation": "

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by\n the EC2 Fleet.

\n

If the allocation strategy is lowest-price, EC2 Fleet launches instances from\n the Spot Instance pools with the lowest price. This is the default allocation strategy.

\n

If the allocation strategy is diversified, EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.

\n

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances\n from Spot Instance pools with optimal capacity for the number of instances that are\n launching.

" } }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#SpotInstanceInterruptionBehavior", + "MaxTotalPrice": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" + "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay.

" } } }, @@ -51329,14 +52857,6 @@ "smithy.api#xmlName": "spotPrice" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, "ProductDescription": { "target": "com.amazonaws.ec2#RIProductDescription", "traits": { @@ -51360,6 +52880,14 @@ "smithy.api#documentation": "

The Availability Zone.

", "smithy.api#xmlName": "availabilityZone" } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } } }, "traits": { @@ -51378,14 +52906,6 @@ "com.amazonaws.ec2#StaleIpPermission": { "type": "structure", "members": { - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", - "smithy.api#xmlName": "toPort" - } - }, "UserIdGroupPairs": { "target": "com.amazonaws.ec2#UserIdGroupPairSet", "traits": { @@ -51394,20 +52914,20 @@ "smithy.api#xmlName": "groups" } }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", + "ToPort": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", - "smithy.api#xmlName": "ipProtocol" + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", + "smithy.api#xmlName": "toPort" } }, - "PrefixListIds": { - "target": "com.amazonaws.ec2#PrefixListIdSet", + "FromPort": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "PrefixListIds", - "smithy.api#documentation": "

The prefix list IDs. Not applicable for stale security group rules.

", - "smithy.api#xmlName": "prefixListIds" + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", + "smithy.api#xmlName": "fromPort" } }, "IpRanges": { @@ -51418,12 +52938,20 @@ "smithy.api#xmlName": "ipRanges" } }, - "FromPort": { - "target": "com.amazonaws.ec2#Integer", + "PrefixListIds": { + "target": "com.amazonaws.ec2#PrefixListIdSet", "traits": { - "aws.protocols#ec2QueryName": "FromPort", - "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of\n -1 indicates all ICMP types.

", - "smithy.api#xmlName": "fromPort" + "aws.protocols#ec2QueryName": "PrefixListIds", + "smithy.api#documentation": "

The prefix list IDs. Not applicable for stale security group rules.

", + "smithy.api#xmlName": "prefixListIds" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", + "smithy.api#xmlName": "ipProtocol" } } }, @@ -51443,14 +52971,6 @@ "com.amazonaws.ec2#StaleSecurityGroup": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, "StaleIpPermissionsEgress": { "target": "com.amazonaws.ec2#StaleIpPermissionSet", "traits": { @@ -51459,20 +52979,20 @@ "smithy.api#xmlName": "staleIpPermissionsEgress" } }, - "VpcId": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC for the security group.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the security group.

", + "smithy.api#xmlName": "description" } }, - "StaleIpPermissions": { - "target": "com.amazonaws.ec2#StaleIpPermissionSet", + "GroupName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StaleIpPermissions", - "smithy.api#documentation": "

Information about the stale inbound rules in the security group.

", - "smithy.api#xmlName": "staleIpPermissions" + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" } }, "GroupId": { @@ -51483,12 +53003,20 @@ "smithy.api#xmlName": "groupId" } }, - "Description": { + "StaleIpPermissions": { + "target": "com.amazonaws.ec2#StaleIpPermissionSet", + "traits": { + "aws.protocols#ec2QueryName": "StaleIpPermissions", + "smithy.api#documentation": "

Information about the stale inbound rules in the security group.

", + "smithy.api#xmlName": "staleIpPermissions" + } + }, + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the security group.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC for the security group.

", + "smithy.api#xmlName": "vpcId" } } }, @@ -51520,14 +53048,6 @@ "com.amazonaws.ec2#StartInstancesRequest": { "type": "structure", "members": { - "InstanceIds": { - "target": "com.amazonaws.ec2#InstanceIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of the instances.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "InstanceId" - } - }, "AdditionalInfo": { "target": "com.amazonaws.ec2#String", "traits": { @@ -51536,6 +53056,14 @@ "smithy.api#xmlName": "additionalInfo" } }, + "InstanceIds": { + "target": "com.amazonaws.ec2#InstanceIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -51574,18 +53102,18 @@ "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } + }, "ServiceId": { "target": "com.amazonaws.ec2#VpcEndpointServiceId", "traits": { "smithy.api#documentation": "

The ID of the endpoint service.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } } } }, @@ -51644,14 +53172,6 @@ "com.amazonaws.ec2#StateReason": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The reason code for the state change.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -51659,6 +53179,14 @@ "smithy.api#documentation": "

The message for the state change.

\n ", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The reason code for the state change.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -51744,12 +53272,6 @@ "smithy.api#xmlName": "InstanceId" } }, - "Hibernate": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon Elastic Compute Cloud User Guide.

\n

Default: false\n

" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -51757,6 +53279,12 @@ "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" } + }, + "Hibernate": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon Elastic Compute Cloud User Guide.

\n

Default: false\n

" + } } } }, @@ -51791,16 +53319,16 @@ "com.amazonaws.ec2#StorageLocation": { "type": "structure", "members": { - "Bucket": { + "Key": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

" + "smithy.api#documentation": "

The key.

" } }, - "Key": { + "Bucket": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The key.

" + "smithy.api#documentation": "

The name of the S3 bucket.

" } } }, @@ -51814,52 +53342,20 @@ "com.amazonaws.ec2#Subnet": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the subnet.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC the subnet is in.

", - "smithy.api#xmlName": "vpcId" - } - }, - "MapCustomerOwnedIpOnLaunch": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MapCustomerOwnedIpOnLaunch", - "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives a customer-owned IPv4 address.

", - "smithy.api#xmlName": "mapCustomerOwnedIpOnLaunch" - } - }, - "DefaultForAz": { - "target": "com.amazonaws.ec2#Boolean", + "State": { + "target": "com.amazonaws.ec2#SubnetState", "traits": { - "aws.protocols#ec2QueryName": "DefaultForAz", - "smithy.api#documentation": "

Indicates whether this is the default subnet for the Availability Zone.

", - "smithy.api#xmlName": "defaultForAz" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the subnet.

", + "smithy.api#xmlName": "state" } }, - "AvailabilityZoneId": { + "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneId", - "smithy.api#documentation": "

The AZ ID of the subnet.

", - "smithy.api#xmlName": "availabilityZoneId" - } - }, - "AvailableIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableIpAddressCount", - "smithy.api#documentation": "

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any\n\t\t\tstopped instances are considered unavailable.

", - "smithy.api#xmlName": "availableIpAddressCount" + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block assigned to the subnet.

", + "smithy.api#xmlName": "cidrBlock" } }, "AssignIpv6AddressOnCreation": { @@ -51878,6 +53374,14 @@ "smithy.api#xmlName": "tagSet" } }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the subnet.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" + } + }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -51886,6 +53390,14 @@ "smithy.api#xmlName": "ownerId" } }, + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.ec2#CoipPoolId", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", + "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

", + "smithy.api#xmlName": "customerOwnedIpv4Pool" + } + }, "SubnetId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -51894,44 +53406,36 @@ "smithy.api#xmlName": "subnetId" } }, - "Ipv6CidrBlockAssociationSet": { - "target": "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociationSet", + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", - "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the subnet.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The AZ ID of the subnet.

", + "smithy.api#xmlName": "availabilityZoneId" } }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.ec2#CoipPoolId", + "DefaultForAz": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "CustomerOwnedIpv4Pool", - "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

", - "smithy.api#xmlName": "customerOwnedIpv4Pool" + "aws.protocols#ec2QueryName": "DefaultForAz", + "smithy.api#documentation": "

Indicates whether this is the default subnet for the Availability Zone.

", + "smithy.api#xmlName": "defaultForAz" } }, - "CidrBlock": { + "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block assigned to the subnet.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "MapPublicIpOnLaunch": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MapPublicIpOnLaunch", - "smithy.api#documentation": "

Indicates whether instances launched in this subnet receive a public IPv4 address.

", - "smithy.api#xmlName": "mapPublicIpOnLaunch" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the subnet.

", + "smithy.api#xmlName": "availabilityZone" } }, - "State": { - "target": "com.amazonaws.ec2#SubnetState", + "OutpostArn": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the subnet.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" } }, "SubnetArn": { @@ -51942,12 +53446,36 @@ "smithy.api#xmlName": "subnetArn" } }, - "OutpostArn": { + "MapCustomerOwnedIpOnLaunch": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MapCustomerOwnedIpOnLaunch", + "smithy.api#documentation": "

Indicates whether a network interface created in this subnet (including a network\n interface created by RunInstances) receives a customer-owned IPv4 address.

", + "smithy.api#xmlName": "mapCustomerOwnedIpOnLaunch" + } + }, + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC the subnet is in.

", + "smithy.api#xmlName": "vpcId" + } + }, + "AvailableIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableIpAddressCount", + "smithy.api#documentation": "

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any\n\t\t\tstopped instances are considered unavailable.

", + "smithy.api#xmlName": "availableIpAddressCount" + } + }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MapPublicIpOnLaunch", + "smithy.api#documentation": "

Indicates whether instances launched in this subnet receive a public IPv4 address.

", + "smithy.api#xmlName": "mapPublicIpOnLaunch" } } }, @@ -52055,6 +53583,14 @@ "com.amazonaws.ec2#SubnetIpv6CidrBlockAssociation": { "type": "structure", "members": { + "Ipv6CidrBlockState": { + "target": "com.amazonaws.ec2#SubnetCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", + "smithy.api#documentation": "

Information about the state of the CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlockState" + } + }, "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { @@ -52070,14 +53606,6 @@ "smithy.api#documentation": "

The association ID for the CIDR block.

", "smithy.api#xmlName": "associationId" } - }, - "Ipv6CidrBlockState": { - "target": "com.amazonaws.ec2#SubnetCidrBlockState", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", - "smithy.api#documentation": "

Information about the state of the CIDR block.

", - "smithy.api#xmlName": "ipv6CidrBlockState" - } } }, "traits": { @@ -52190,14 +53718,6 @@ "com.amazonaws.ec2#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", - "smithy.api#xmlName": "value" - } - }, "Key": { "target": "com.amazonaws.ec2#String", "traits": { @@ -52205,6 +53725,14 @@ "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. \n May not begin with aws:.

", "smithy.api#xmlName": "key" } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "smithy.api#xmlName": "value" + } } }, "traits": { @@ -52214,12 +53742,12 @@ "com.amazonaws.ec2#TagDescription": { "type": "structure", "members": { - "Value": { + "ResourceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

The tag value.

", - "smithy.api#xmlName": "value" + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" } }, "ResourceType": { @@ -52230,14 +53758,6 @@ "smithy.api#xmlName": "resourceType" } }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, "Key": { "target": "com.amazonaws.ec2#String", "traits": { @@ -52245,6 +53765,14 @@ "smithy.api#documentation": "

The tag key.

", "smithy.api#xmlName": "key" } + }, + "Value": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

The tag value.

", + "smithy.api#xmlName": "value" + } } }, "traits": { @@ -52307,14 +53835,6 @@ "com.amazonaws.ec2#TargetCapacitySpecification": { "type": "structure", "members": { - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", - "smithy.api#documentation": "

The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

", - "smithy.api#xmlName": "onDemandTargetCapacity" - } - }, "DefaultTargetCapacityType": { "target": "com.amazonaws.ec2#DefaultTargetCapacityType", "traits": { @@ -52323,6 +53843,14 @@ "smithy.api#xmlName": "defaultTargetCapacityType" } }, + "TotalTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TotalTargetCapacity", + "smithy.api#documentation": "

The number of units to request, filled using\n DefaultTargetCapacityType.

", + "smithy.api#xmlName": "totalTargetCapacity" + } + }, "SpotTargetCapacity": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -52331,12 +53859,12 @@ "smithy.api#xmlName": "spotTargetCapacity" } }, - "TotalTargetCapacity": { + "OnDemandTargetCapacity": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "TotalTargetCapacity", - "smithy.api#documentation": "

The number of units to request, filled using\n DefaultTargetCapacityType.

", - "smithy.api#xmlName": "totalTargetCapacity" + "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", + "smithy.api#documentation": "

The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

", + "smithy.api#xmlName": "onDemandTargetCapacity" } } }, @@ -52404,18 +53932,18 @@ "com.amazonaws.ec2#TargetConfigurationRequest": { "type": "structure", "members": { + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot \n be specified in a request

" + } + }, "OfferingId": { "target": "com.amazonaws.ec2#ReservedInstancesOfferingId", "traits": { "smithy.api#documentation": "

The Convertible Reserved Instance offering ID.

", "smithy.api#required": {} } - }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot \n be specified in a request

" - } } }, "traits": { @@ -52481,30 +54009,6 @@ "com.amazonaws.ec2#TargetNetwork": { "type": "structure", "members": { - "SecurityGroups": { - "target": "com.amazonaws.ec2#ValueStringList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroups", - "smithy.api#documentation": "

The IDs of the security groups applied to the target network association.

", - "smithy.api#xmlName": "securityGroups" - } - }, - "Status": { - "target": "com.amazonaws.ec2#AssociationStatus", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The current state of the target network association.

", - "smithy.api#xmlName": "status" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC in which the target network (subnet) is located.

", - "smithy.api#xmlName": "vpcId" - } - }, "TargetNetworkId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -52521,6 +54025,22 @@ "smithy.api#xmlName": "associationId" } }, + "Status": { + "target": "com.amazonaws.ec2#AssociationStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The current state of the target network association.

", + "smithy.api#xmlName": "status" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroups", + "smithy.api#documentation": "

The IDs of the security groups applied to the target network association.

", + "smithy.api#xmlName": "securityGroups" + } + }, "ClientVpnEndpointId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -52528,6 +54048,14 @@ "smithy.api#documentation": "

The ID of the Client VPN endpoint with which the target network is associated.

", "smithy.api#xmlName": "clientVpnEndpointId" } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the target network (subnet) is located.

", + "smithy.api#xmlName": "vpcId" + } } }, "traits": { @@ -52620,6 +54148,18 @@ "com.amazonaws.ec2#TerminateClientVpnConnectionsRequest": { "type": "structure", "members": { + "Username": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the user who initiated the connection. Use this option to terminate all active connections for \n\t\t\tthe specified user. This option can only be used if the user has established up to five connections.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, "ConnectionId": { "target": "com.amazonaws.ec2#VpnConnectionId", "traits": { @@ -52632,18 +54172,6 @@ "smithy.api#documentation": "

The ID of the Client VPN endpoint to which the client is connected.

", "smithy.api#required": {} } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" - } - }, - "Username": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the user who initiated the connection. Use this option to terminate all active connections for \n\t\t\tthe specified user. This option can only be used if the user has established up to five connections.

" - } } } }, @@ -52679,12 +54207,12 @@ "com.amazonaws.ec2#TerminateConnectionStatus": { "type": "structure", "members": { - "PreviousStatus": { - "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", + "ConnectionId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PreviousStatus", - "smithy.api#documentation": "

The state of the client connection.

", - "smithy.api#xmlName": "previousStatus" + "aws.protocols#ec2QueryName": "ConnectionId", + "smithy.api#documentation": "

The ID of the client connection.

", + "smithy.api#xmlName": "connectionId" } }, "CurrentStatus": { @@ -52695,12 +54223,12 @@ "smithy.api#xmlName": "currentStatus" } }, - "ConnectionId": { - "target": "com.amazonaws.ec2#String", + "PreviousStatus": { + "target": "com.amazonaws.ec2#ClientVpnConnectionStatus", "traits": { - "aws.protocols#ec2QueryName": "ConnectionId", - "smithy.api#documentation": "

The ID of the client connection.

", - "smithy.api#xmlName": "connectionId" + "aws.protocols#ec2QueryName": "PreviousStatus", + "smithy.api#documentation": "

The state of the client connection.

", + "smithy.api#xmlName": "previousStatus" } } }, @@ -52794,6 +54322,14 @@ "com.amazonaws.ec2#TrafficMirrorFilter": { "type": "structure", "members": { + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, "NetworkServices": { "target": "com.amazonaws.ec2#TrafficMirrorNetworkServiceList", "traits": { @@ -52802,28 +54338,12 @@ "smithy.api#xmlName": "networkServiceSet" } }, - "EgressFilterRules": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", - "traits": { - "aws.protocols#ec2QueryName": "EgressFilterRuleSet", - "smithy.api#documentation": "

Information about the egress rules that are associated with the Traffic Mirror filter.

", - "smithy.api#xmlName": "egressFilterRuleSet" - } - }, - "IngressFilterRules": { - "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", - "traits": { - "aws.protocols#ec2QueryName": "IngressFilterRuleSet", - "smithy.api#documentation": "

Information about the ingress rules that are associated with the Traffic Mirror filter.

", - "smithy.api#xmlName": "ingressFilterRuleSet" - } - }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#xmlName": "trafficMirrorFilterId" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror filter.

", + "smithy.api#xmlName": "tagSet" } }, "Description": { @@ -52834,12 +54354,20 @@ "smithy.api#xmlName": "description" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "IngressFilterRules": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Traffic Mirror filter.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "IngressFilterRuleSet", + "smithy.api#documentation": "

Information about the ingress rules that are associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "ingressFilterRuleSet" + } + }, + "EgressFilterRules": { + "target": "com.amazonaws.ec2#TrafficMirrorFilterRuleList", + "traits": { + "aws.protocols#ec2QueryName": "EgressFilterRuleSet", + "smithy.api#documentation": "

Information about the egress rules that are associated with the Traffic Mirror filter.

", + "smithy.api#xmlName": "egressFilterRuleSet" } } }, @@ -52862,12 +54390,12 @@ "com.amazonaws.ec2#TrafficMirrorFilterRule": { "type": "structure", "members": { - "SourcePortRange": { - "target": "com.amazonaws.ec2#TrafficMirrorPortRange", + "TrafficMirrorFilterRuleId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SourcePortRange", - "smithy.api#documentation": "

The source port range assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "sourcePortRange" + "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", + "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficMirrorFilterRuleId" } }, "DestinationPortRange": { @@ -52878,28 +54406,36 @@ "smithy.api#xmlName": "destinationPortRange" } }, - "RuleAction": { - "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "RuleAction", - "smithy.api#documentation": "

The action assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "ruleAction" + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#documentation": "

The rule number of the Traffic Mirror rule.

", + "smithy.api#xmlName": "ruleNumber" } }, - "DestinationCidrBlock": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The destination CIDR block assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "destinationCidrBlock" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror rule.

", + "smithy.api#xmlName": "description" } }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#String", + "TrafficDirection": { + "target": "com.amazonaws.ec2#TrafficDirection", "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", - "smithy.api#documentation": "

The ID of the Traffic Mirror filter that the rule is associated with.

", - "smithy.api#xmlName": "trafficMirrorFilterId" + "aws.protocols#ec2QueryName": "TrafficDirection", + "smithy.api#documentation": "

The traffic direction assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "trafficDirection" + } + }, + "RuleAction": { + "target": "com.amazonaws.ec2#TrafficMirrorRuleAction", + "traits": { + "aws.protocols#ec2QueryName": "RuleAction", + "smithy.api#documentation": "

The action assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "ruleAction" } }, "Protocol": { @@ -52910,44 +54446,36 @@ "smithy.api#xmlName": "protocol" } }, - "SourceCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SourceCidrBlock", - "smithy.api#documentation": "

The source CIDR block assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "sourceCidrBlock" - } - }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", + "SourcePortRange": { + "target": "com.amazonaws.ec2#TrafficMirrorPortRange", "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", - "smithy.api#documentation": "

The rule number of the Traffic Mirror rule.

", - "smithy.api#xmlName": "ruleNumber" + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "

The source port range assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "sourcePortRange" } }, - "Description": { + "TrafficMirrorFilterId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the Traffic Mirror rule.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter that the rule is associated with.

", + "smithy.api#xmlName": "trafficMirrorFilterId" } }, - "TrafficMirrorFilterRuleId": { + "SourceCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterRuleId", - "smithy.api#documentation": "

The ID of the Traffic Mirror rule.

", - "smithy.api#xmlName": "trafficMirrorFilterRuleId" + "aws.protocols#ec2QueryName": "SourceCidrBlock", + "smithy.api#documentation": "

The source CIDR block assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "sourceCidrBlock" } }, - "TrafficDirection": { - "target": "com.amazonaws.ec2#TrafficDirection", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TrafficDirection", - "smithy.api#documentation": "

The traffic direction assigned to the Traffic Mirror rule.

", - "smithy.api#xmlName": "trafficDirection" + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The destination CIDR block assigned to the Traffic Mirror rule.

", + "smithy.api#xmlName": "destinationCidrBlock" } } }, @@ -53080,12 +54608,12 @@ "com.amazonaws.ec2#TrafficMirrorSession": { "type": "structure", "members": { - "TrafficMirrorTargetId": { - "target": "com.amazonaws.ec2#String", + "VirtualNetworkId": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", - "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", - "smithy.api#xmlName": "trafficMirrorTargetId" + "aws.protocols#ec2QueryName": "VirtualNetworkId", + "smithy.api#documentation": "

The virtual network ID associated with the Traffic Mirror session.

", + "smithy.api#xmlName": "virtualNetworkId" } }, "Tags": { @@ -53096,36 +54624,12 @@ "smithy.api#xmlName": "tagSet" } }, - "TrafficMirrorFilterId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", - "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", - "smithy.api#xmlName": "trafficMirrorFilterId" - } - }, - "VirtualNetworkId": { + "PacketLength": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "VirtualNetworkId", - "smithy.api#documentation": "

The virtual network ID associated with the Traffic Mirror session.

", - "smithy.api#xmlName": "virtualNetworkId" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the Traffic Mirror session.

", - "smithy.api#xmlName": "description" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror session.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "PacketLength", + "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet

", + "smithy.api#xmlName": "packetLength" } }, "NetworkInterfaceId": { @@ -53152,12 +54656,36 @@ "smithy.api#xmlName": "sessionNumber" } }, - "PacketLength": { - "target": "com.amazonaws.ec2#Integer", + "TrafficMirrorFilterId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PacketLength", - "smithy.api#documentation": "

The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet

", - "smithy.api#xmlName": "packetLength" + "aws.protocols#ec2QueryName": "TrafficMirrorFilterId", + "smithy.api#documentation": "

The ID of the Traffic Mirror filter.

", + "smithy.api#xmlName": "trafficMirrorFilterId" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror session.

", + "smithy.api#xmlName": "ownerId" + } + }, + "TrafficMirrorTargetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the Traffic Mirror session.

", + "smithy.api#xmlName": "description" } } }, @@ -53211,20 +54739,12 @@ "com.amazonaws.ec2#TrafficMirrorTarget": { "type": "structure", "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The network interface ID that is attached to the target.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror target.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags assigned to the Traffic Mirror target.

", + "smithy.api#xmlName": "tagSet" } }, "Type": { @@ -53235,20 +54755,28 @@ "smithy.api#xmlName": "type" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags assigned to the Traffic Mirror target.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

Information about the Traffic Mirror target.

", + "smithy.api#xmlName": "description" } }, - "TrafficMirrorTargetId": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", - "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", - "smithy.api#xmlName": "trafficMirrorTargetId" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the account that owns the Traffic Mirror target.

", + "smithy.api#xmlName": "ownerId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The network interface ID that is attached to the target.

", + "smithy.api#xmlName": "networkInterfaceId" } }, "NetworkLoadBalancerArn": { @@ -53259,12 +54787,12 @@ "smithy.api#xmlName": "networkLoadBalancerArn" } }, - "Description": { + "TrafficMirrorTargetId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

Information about the Traffic Mirror target.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "TrafficMirrorTargetId", + "smithy.api#documentation": "

The ID of the Traffic Mirror target.

", + "smithy.api#xmlName": "trafficMirrorTargetId" } } }, @@ -53337,28 +54865,12 @@ "com.amazonaws.ec2#TransitGateway": { "type": "structure", "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account ID that owns the transit gateway.

", - "smithy.api#xmlName": "ownerId" - } - }, - "TransitGatewayArn": { + "TransitGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayArn" - } - }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" } }, "CreationTime": { @@ -53369,6 +54881,14 @@ "smithy.api#xmlName": "creationTime" } }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account ID that owns the transit gateway.

", + "smithy.api#xmlName": "ownerId" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -53377,12 +54897,12 @@ "smithy.api#xmlName": "tagSet" } }, - "TransitGatewayId": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description of the transit gateway.

", + "smithy.api#xmlName": "description" } }, "Options": { @@ -53393,12 +54913,20 @@ "smithy.api#xmlName": "options" } }, - "Description": { + "State": { + "target": "com.amazonaws.ec2#TransitGatewayState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway.

", + "smithy.api#xmlName": "state" + } + }, + "TransitGatewayArn": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description of the transit gateway.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "TransitGatewayArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayArn" } } }, @@ -53417,6 +54945,14 @@ "smithy.api#xmlName": "state" } }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", "traits": { @@ -53425,14 +54961,6 @@ "smithy.api#xmlName": "transitGatewayRouteTableId" } }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type.

", - "smithy.api#xmlName": "resourceType" - } - }, "ResourceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -53441,12 +54969,12 @@ "smithy.api#xmlName": "resourceId" } }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" } } }, @@ -53476,30 +55004,30 @@ "com.amazonaws.ec2#TransitGatewayAttachment": { "type": "structure", "members": { - "ResourceId": { + "TransitGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "TransitGatewayOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayOwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the transit gateway.

", + "smithy.api#xmlName": "transitGatewayOwnerId" } }, "ResourceType": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", "traits": { "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type.

", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", "smithy.api#xmlName": "resourceType" } }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -53520,18 +55048,10 @@ "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The attachment state.

", + "smithy.api#documentation": "

The attachment state. Note that the initiating state has been deprecated.

", "smithy.api#xmlName": "state" } }, - "TransitGatewayOwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the transit gateway.

", - "smithy.api#xmlName": "transitGatewayOwnerId" - } - }, "ResourceOwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -53555,6 +55075,14 @@ "smithy.api#documentation": "

The association.

", "smithy.api#xmlName": "association" } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } } }, "traits": { @@ -53606,14 +55134,6 @@ "com.amazonaws.ec2#TransitGatewayAttachmentPropagation": { "type": "structure", "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the propagation route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" - } - }, "State": { "target": "com.amazonaws.ec2#TransitGatewayPropagationState", "traits": { @@ -53621,6 +55141,14 @@ "smithy.api#documentation": "

The state of the propagation route table.

", "smithy.api#xmlName": "state" } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the propagation route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } } }, "traits": { @@ -53649,6 +55177,9 @@ { "value": "direct-connect-gateway" }, + { + "value": "peering" + }, { "value": "tgw-peering" } @@ -53662,6 +55193,9 @@ { "value": "initiating" }, + { + "value": "initiatingRequest" + }, { "value": "pendingAcceptance" }, @@ -53750,12 +55284,12 @@ "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupMembers": { "type": "structure", "members": { - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", + "DeregisteredNetworkInterfaceIds": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" + "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", + "smithy.api#documentation": "

The network interface IDs of the deregistered members.

", + "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" } }, "TransitGatewayMulticastDomainId": { @@ -53766,12 +55300,12 @@ "smithy.api#xmlName": "transitGatewayMulticastDomainId" } }, - "DeregisteredNetworkInterfaceIds": { - "target": "com.amazonaws.ec2#ValueStringList", + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeregisteredNetworkInterfaceIds", - "smithy.api#documentation": "

The network interface IDs of the deregistered members.

", - "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" } } }, @@ -53782,6 +55316,14 @@ "com.amazonaws.ec2#TransitGatewayMulticastDeregisteredGroupSources": { "type": "structure", "members": { + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } + }, "TransitGatewayMulticastDomainId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -53797,14 +55339,6 @@ "smithy.api#documentation": "

The network interface IDs of the non-registered members.

", "smithy.api#xmlName": "deregisteredNetworkInterfaceIds" } - }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } } }, "traits": { @@ -53814,22 +55348,6 @@ "com.amazonaws.ec2#TransitGatewayMulticastDomain": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The time the transit gateway multicast domain was created.

", - "smithy.api#xmlName": "creationTime" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, "TransitGatewayMulticastDomainId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -53838,6 +55356,14 @@ "smithy.api#xmlName": "transitGatewayMulticastDomainId" } }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", + "smithy.api#xmlName": "tagSet" + } + }, "State": { "target": "com.amazonaws.ec2#TransitGatewayMulticastDomainState", "traits": { @@ -53846,12 +55372,20 @@ "smithy.api#xmlName": "state" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the transit gateway multicast domain.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The time the transit gateway multicast domain was created.

", + "smithy.api#xmlName": "creationTime" } } }, @@ -53862,14 +55396,6 @@ "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociation": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" - } - }, "Subnet": { "target": "com.amazonaws.ec2#SubnetAssociation", "traits": { @@ -53878,6 +55404,14 @@ "smithy.api#xmlName": "subnet" } }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, "ResourceType": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", "traits": { @@ -53886,12 +55420,12 @@ "smithy.api#xmlName": "resourceType" } }, - "TransitGatewayAttachmentId": { + "ResourceId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" } } }, @@ -53911,6 +55445,14 @@ "com.amazonaws.ec2#TransitGatewayMulticastDomainAssociations": { "type": "structure", "members": { + "Subnets": { + "target": "com.amazonaws.ec2#SubnetAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "Subnets", + "smithy.api#documentation": "

The subnets associated with the multicast domain.

", + "smithy.api#xmlName": "subnets" + } + }, "TransitGatewayMulticastDomainId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -53919,12 +55461,12 @@ "smithy.api#xmlName": "transitGatewayMulticastDomainId" } }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" } }, "ResourceId": { @@ -53935,20 +55477,12 @@ "smithy.api#xmlName": "resourceId" } }, - "Subnets": { - "target": "com.amazonaws.ec2#SubnetAssociationList", - "traits": { - "aws.protocols#ec2QueryName": "Subnets", - "smithy.api#documentation": "

The subnets associated with the multicast domain.

", - "smithy.api#xmlName": "subnets" - } - }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", - "smithy.api#xmlName": "resourceType" + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" } } }, @@ -53999,14 +55533,6 @@ "com.amazonaws.ec2#TransitGatewayMulticastGroup": { "type": "structure", "members": { - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } - }, "MemberType": { "target": "com.amazonaws.ec2#MembershipType", "traits": { @@ -54023,36 +55549,44 @@ "smithy.api#xmlName": "transitGatewayAttachmentId" } }, - "ResourceId": { + "GroupIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" } }, - "GroupSource": { - "target": "com.amazonaws.ec2#Boolean", + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", "traits": { - "aws.protocols#ec2QueryName": "GroupSource", - "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", - "smithy.api#xmlName": "groupSource" + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", + "smithy.api#xmlName": "resourceType" } }, - "SourceType": { - "target": "com.amazonaws.ec2#MembershipType", + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SourceType", - "smithy.api#documentation": "

The source type.

", - "smithy.api#xmlName": "sourceType" + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the transit gateway attachment.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" } }, - "GroupMember": { + "GroupSource": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "GroupMember", + "aws.protocols#ec2QueryName": "GroupSource", "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", - "smithy.api#xmlName": "groupMember" + "smithy.api#xmlName": "groupSource" } }, "SubnetId": { @@ -54063,20 +55597,20 @@ "smithy.api#xmlName": "subnetId" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", + "GroupMember": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the transit gateway attachment.

", - "smithy.api#xmlName": "networkInterfaceId" + "aws.protocols#ec2QueryName": "GroupMember", + "smithy.api#documentation": "

Indicates that the resource is a transit gateway multicast group member.

", + "smithy.api#xmlName": "groupMember" } }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "SourceType": { + "target": "com.amazonaws.ec2#MembershipType", "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource, for example a VPC attachment.

", - "smithy.api#xmlName": "resourceType" + "aws.protocols#ec2QueryName": "SourceType", + "smithy.api#documentation": "

The source type.

", + "smithy.api#xmlName": "sourceType" } } }, @@ -54096,14 +55630,6 @@ "com.amazonaws.ec2#TransitGatewayMulticastRegisteredGroupMembers": { "type": "structure", "members": { - "TransitGatewayMulticastDomainId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", - "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", - "smithy.api#xmlName": "transitGatewayMulticastDomainId" - } - }, "RegisteredNetworkInterfaceIds": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -54119,6 +55645,14 @@ "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", "smithy.api#xmlName": "groupIpAddress" } + }, + "TransitGatewayMulticastDomainId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayMulticastDomainId", + "smithy.api#documentation": "

The ID of the transit gateway multicast domain.

", + "smithy.api#xmlName": "transitGatewayMulticastDomainId" + } } }, "traits": { @@ -54136,14 +55670,6 @@ "smithy.api#xmlName": "transitGatewayMulticastDomainId" } }, - "GroupIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupIpAddress", - "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", - "smithy.api#xmlName": "groupIpAddress" - } - }, "RegisteredNetworkInterfaceIds": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -54151,6 +55677,14 @@ "smithy.api#documentation": "

The IDs of the network interfaces members registered with the transit gateway multicast group.

", "smithy.api#xmlName": "registeredNetworkInterfaceIds" } + }, + "GroupIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupIpAddress", + "smithy.api#documentation": "

The IP address assigned to the transit gateway multicast group.

", + "smithy.api#xmlName": "groupIpAddress" + } } }, "traits": { @@ -54169,20 +55703,12 @@ "com.amazonaws.ec2#TransitGatewayOptions": { "type": "structure", "members": { - "PropagationDefaultRouteTableId": { + "AssociationDefaultRouteTableId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PropagationDefaultRouteTableId", - "smithy.api#documentation": "

The ID of the default propagation route table.

", - "smithy.api#xmlName": "propagationDefaultRouteTableId" - } - }, - "MulticastSupport": { - "target": "com.amazonaws.ec2#MulticastSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "MulticastSupport", - "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

", - "smithy.api#xmlName": "multicastSupport" + "aws.protocols#ec2QueryName": "AssociationDefaultRouteTableId", + "smithy.api#documentation": "

The ID of the default association route table.

", + "smithy.api#xmlName": "associationDefaultRouteTableId" } }, "AmazonSideAsn": { @@ -54193,6 +55719,22 @@ "smithy.api#xmlName": "amazonSideAsn" } }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "traits": { + "aws.protocols#ec2QueryName": "AutoAcceptSharedAttachments", + "smithy.api#documentation": "

Indicates whether attachment requests are automatically accepted.

", + "smithy.api#xmlName": "autoAcceptSharedAttachments" + } + }, + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PropagationDefaultRouteTableId", + "smithy.api#documentation": "

The ID of the default propagation route table.

", + "smithy.api#xmlName": "propagationDefaultRouteTableId" + } + }, "DnsSupport": { "target": "com.amazonaws.ec2#DnsSupportValue", "traits": { @@ -54201,20 +55743,20 @@ "smithy.api#xmlName": "dnsSupport" } }, - "AssociationDefaultRouteTableId": { - "target": "com.amazonaws.ec2#String", + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", "traits": { - "aws.protocols#ec2QueryName": "AssociationDefaultRouteTableId", - "smithy.api#documentation": "

The ID of the default association route table.

", - "smithy.api#xmlName": "associationDefaultRouteTableId" + "aws.protocols#ec2QueryName": "VpnEcmpSupport", + "smithy.api#documentation": "

Indicates whether Equal Cost Multipath Protocol support is enabled.

", + "smithy.api#xmlName": "vpnEcmpSupport" } }, - "DefaultRouteTablePropagation": { - "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "MulticastSupport": { + "target": "com.amazonaws.ec2#MulticastSupportValue", "traits": { - "aws.protocols#ec2QueryName": "DefaultRouteTablePropagation", - "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

", - "smithy.api#xmlName": "defaultRouteTablePropagation" + "aws.protocols#ec2QueryName": "MulticastSupport", + "smithy.api#documentation": "

Indicates whether multicast is enabled on the transit gateway

", + "smithy.api#xmlName": "multicastSupport" } }, "DefaultRouteTableAssociation": { @@ -54225,20 +55767,12 @@ "smithy.api#xmlName": "defaultRouteTableAssociation" } }, - "VpnEcmpSupport": { - "target": "com.amazonaws.ec2#VpnEcmpSupportValue", - "traits": { - "aws.protocols#ec2QueryName": "VpnEcmpSupport", - "smithy.api#documentation": "

Indicates whether Equal Cost Multipath Protocol support is enabled.

", - "smithy.api#xmlName": "vpnEcmpSupport" - } - }, - "AutoAcceptSharedAttachments": { - "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", "traits": { - "aws.protocols#ec2QueryName": "AutoAcceptSharedAttachments", - "smithy.api#documentation": "

Indicates whether attachment requests are automatically accepted.

", - "smithy.api#xmlName": "autoAcceptSharedAttachments" + "aws.protocols#ec2QueryName": "DefaultRouteTablePropagation", + "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

", + "smithy.api#xmlName": "defaultRouteTablePropagation" } } }, @@ -54249,14 +55783,6 @@ "com.amazonaws.ec2#TransitGatewayPeeringAttachment": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The time the transit gateway peering attachment was created.

", - "smithy.api#xmlName": "creationTime" - } - }, "Status": { "target": "com.amazonaws.ec2#PeeringAttachmentStatus", "traits": { @@ -54265,6 +55791,22 @@ "smithy.api#xmlName": "status" } }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The time the transit gateway peering attachment was created.

", + "smithy.api#xmlName": "creationTime" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -54273,12 +55815,12 @@ "smithy.api#xmlName": "tagSet" } }, - "RequesterTgwInfo": { - "target": "com.amazonaws.ec2#PeeringTgwInfo", + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RequesterTgwInfo", - "smithy.api#documentation": "

Information about the requester transit gateway.

", - "smithy.api#xmlName": "requesterTgwInfo" + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" } }, "AccepterTgwInfo": { @@ -54289,20 +55831,12 @@ "smithy.api#xmlName": "accepterTgwInfo" } }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway peering attachment.

", - "smithy.api#xmlName": "state" - } - }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", + "RequesterTgwInfo": { + "target": "com.amazonaws.ec2#PeeringTgwInfo", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the transit gateway peering attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" + "aws.protocols#ec2QueryName": "RequesterTgwInfo", + "smithy.api#documentation": "

Information about the requester transit gateway.

", + "smithy.api#xmlName": "requesterTgwInfo" } } }, @@ -54319,9 +55853,25 @@ } } }, - "com.amazonaws.ec2#TransitGatewayPropagation": { + "com.amazonaws.ec2#TransitGatewayPrefixListAttachment": { "type": "structure", "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } + }, "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { @@ -54329,14 +55879,106 @@ "smithy.api#documentation": "

The ID of the attachment.

", "smithy.api#xmlName": "transitGatewayAttachmentId" } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a transit gateway prefix list attachment.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReference": { + "type": "structure", + "members": { + "TransitGatewayAttachment": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListAttachment", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachment", + "smithy.api#documentation": "

Information about the transit gateway attachment.

", + "smithy.api#xmlName": "transitGatewayAttachment" + } + }, + "PrefixListOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListOwnerId", + "smithy.api#documentation": "

The ID of the prefix list owner.

", + "smithy.api#xmlName": "prefixListOwnerId" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "Blackhole": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Blackhole", + "smithy.api#documentation": "

Indicates whether traffic that matches this route is dropped.

", + "smithy.api#xmlName": "blackhole" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list.

", + "smithy.api#xmlName": "prefixListId" + } }, "State": { - "target": "com.amazonaws.ec2#TransitGatewayPropagationState", + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state.

", + "smithy.api#documentation": "

The state of the prefix list reference.

", "smithy.api#xmlName": "state" } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a prefix list reference.

" + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPrefixListReference", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPrefixListReferenceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pending" + }, + { + "value": "available" + }, + { + "value": "modifying" + }, + { + "value": "deleting" + } + ] + } + }, + "com.amazonaws.ec2#TransitGatewayPropagation": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#xmlName": "resourceId" + } }, "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#String", @@ -54350,16 +55992,24 @@ "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", "traits": { "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type.

", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", "smithy.api#xmlName": "resourceType" } }, - "ResourceId": { - "target": "com.amazonaws.ec2#String", + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPropagationState", "traits": { - "aws.protocols#ec2QueryName": "ResourceId", - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#xmlName": "resourceId" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state.

", + "smithy.api#xmlName": "state" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" } } }, @@ -54389,12 +56039,6 @@ "com.amazonaws.ec2#TransitGatewayRequestOptions": { "type": "structure", "members": { - "DefaultRouteTableAssociation": { - "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", - "traits": { - "smithy.api#documentation": "

Enable or disable automatic association with the default association route table. Enabled by default.

" - } - }, "MulticastSupport": { "target": "com.amazonaws.ec2#MulticastSupportValue", "traits": { @@ -54407,28 +56051,34 @@ "smithy.api#documentation": "

Enable or disable DNS support. Enabled by default.

" } }, + "VpnEcmpSupport": { + "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "traits": { + "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support. Enabled by default.

" + } + }, "AutoAcceptSharedAttachments": { "target": "com.amazonaws.ec2#AutoAcceptSharedAttachmentsValue", "traits": { "smithy.api#documentation": "

Enable or disable automatic acceptance of attachment requests. Disabled by default.

" } }, - "DefaultRouteTablePropagation": { - "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", "traits": { - "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.

" + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.

" } }, - "VpnEcmpSupport": { - "target": "com.amazonaws.ec2#VpnEcmpSupportValue", + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", "traits": { - "smithy.api#documentation": "

Enable or disable Equal Cost Multipath Protocol support. Enabled by default.

" + "smithy.api#documentation": "

Enable or disable automatic association with the default association route table. Enabled by default.

" } }, - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", "traits": { - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.

" + "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.

" } } }, @@ -54439,12 +56089,12 @@ "com.amazonaws.ec2#TransitGatewayRoute": { "type": "structure", "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "Type": { + "target": "com.amazonaws.ec2#TransitGatewayRouteType", "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The CIDR block used for destination matches.

", - "smithy.api#xmlName": "destinationCidrBlock" + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The route type.

", + "smithy.api#xmlName": "type" } }, "State": { @@ -54455,6 +56105,14 @@ "smithy.api#xmlName": "state" } }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "

The ID of the prefix list used for destination matches.

", + "smithy.api#xmlName": "prefixListId" + } + }, "TransitGatewayAttachments": { "target": "com.amazonaws.ec2#TransitGatewayRouteAttachmentList", "traits": { @@ -54463,12 +56121,12 @@ "smithy.api#xmlName": "transitGatewayAttachments" } }, - "Type": { - "target": "com.amazonaws.ec2#TransitGatewayRouteType", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The route type.

", - "smithy.api#xmlName": "type" + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block used for destination matches.

", + "smithy.api#xmlName": "destinationCidrBlock" } } }, @@ -54487,14 +56145,6 @@ "smithy.api#xmlName": "transitGatewayAttachmentId" } }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type.

", - "smithy.api#xmlName": "resourceType" - } - }, "ResourceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -54502,6 +56152,14 @@ "smithy.api#documentation": "

The ID of the resource.

", "smithy.api#xmlName": "resourceId" } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } } }, "traits": { @@ -54559,28 +56217,28 @@ "smithy.api#xmlName": "defaultPropagationRouteTable" } }, - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#String", + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", - "smithy.api#documentation": "

The ID of the transit gateway route table.

", - "smithy.api#xmlName": "transitGatewayRouteTableId" + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the route table.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway.

", + "smithy.api#xmlName": "transitGatewayId" } }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableState", "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the transit gateway route table.

", + "smithy.api#xmlName": "state" } }, "DefaultAssociationRouteTable": { @@ -54591,20 +56249,20 @@ "smithy.api#xmlName": "defaultAssociationRouteTable" } }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableState", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the transit gateway route table.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the route table.

", + "smithy.api#xmlName": "tagSet" } }, - "TransitGatewayId": { + "TransitGatewayRouteTableId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway.

", - "smithy.api#xmlName": "transitGatewayId" + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "

The ID of the transit gateway route table.

", + "smithy.api#xmlName": "transitGatewayRouteTableId" } } }, @@ -54623,12 +56281,12 @@ "smithy.api#xmlName": "resourceId" } }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" } }, "State": { @@ -54639,12 +56297,12 @@ "smithy.api#xmlName": "state" } }, - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The resource type.

", - "smithy.api#xmlName": "resourceType" + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" } } }, @@ -54685,14 +56343,6 @@ "com.amazonaws.ec2#TransitGatewayRouteTablePropagation": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", - "traits": { - "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource.

", - "smithy.api#xmlName": "resourceType" - } - }, "ResourceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -54716,6 +56366,14 @@ "smithy.api#documentation": "

The state of the resource.

", "smithy.api#xmlName": "state" } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource. Note that the tgw-peering resource type has been deprecated.

", + "smithy.api#xmlName": "resourceType" + } } }, "traits": { @@ -54797,12 +56455,12 @@ "com.amazonaws.ec2#TransitGatewayVpcAttachment": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions", + "VpcOwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The VPC attachment options.

", - "smithy.api#xmlName": "options" + "aws.protocols#ec2QueryName": "VpcOwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the VPC.

", + "smithy.api#xmlName": "vpcOwnerId" } }, "SubnetIds": { @@ -54813,28 +56471,20 @@ "smithy.api#xmlName": "subnetIds" } }, - "TransitGatewayAttachmentId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", - "smithy.api#documentation": "

The ID of the attachment.

", - "smithy.api#xmlName": "transitGatewayAttachmentId" - } - }, - "VpcOwnerId": { - "target": "com.amazonaws.ec2#String", + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentOptions", "traits": { - "aws.protocols#ec2QueryName": "VpcOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the VPC.

", - "smithy.api#xmlName": "vpcOwnerId" + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The VPC attachment options.

", + "smithy.api#xmlName": "options" } }, - "State": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the VPC attachment.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags for the VPC attachment.

", + "smithy.api#xmlName": "tagSet" } }, "TransitGatewayId": { @@ -54845,12 +56495,12 @@ "smithy.api#xmlName": "transitGatewayId" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags for the VPC attachment.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The creation time.

", + "smithy.api#xmlName": "creationTime" } }, "VpcId": { @@ -54861,12 +56511,20 @@ "smithy.api#xmlName": "vpcId" } }, - "CreationTime": { - "target": "com.amazonaws.ec2#DateTime", + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentState", "traits": { - "aws.protocols#ec2QueryName": "CreationTime", - "smithy.api#documentation": "

The creation time.

", - "smithy.api#xmlName": "creationTime" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the VPC attachment. Note that the initiating state has been deprecated.

", + "smithy.api#xmlName": "state" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#xmlName": "transitGatewayAttachmentId" } } }, @@ -54920,31 +56578,52 @@ ] } }, + "com.amazonaws.ec2#TunnelInsideIpVersion": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipv4" + }, + { + "value": "ipv6" + } + ] + } + }, "com.amazonaws.ec2#TunnelOption": { "type": "structure", "members": { - "ReplayWindowSize": { + "RekeyFuzzPercentage": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "ReplayWindowSize", - "smithy.api#documentation": "

The number of packets in an IKE replay window.

", - "smithy.api#xmlName": "replayWindowSize" + "aws.protocols#ec2QueryName": "RekeyFuzzPercentage", + "smithy.api#documentation": "

The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.

", + "smithy.api#xmlName": "rekeyFuzzPercentage" } }, - "Phase2DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersList", + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList", "traits": { - "aws.protocols#ec2QueryName": "Phase2DHGroupNumberSet", - "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.

", - "smithy.api#xmlName": "phase2DHGroupNumberSet" + "aws.protocols#ec2QueryName": "Phase2IntegrityAlgorithmSet", + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.

", + "smithy.api#xmlName": "phase2IntegrityAlgorithmSet" } }, - "DpdTimeoutSeconds": { + "RekeyMarginTimeSeconds": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "DpdTimeoutSeconds", - "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

", - "smithy.api#xmlName": "dpdTimeoutSeconds" + "aws.protocols#ec2QueryName": "RekeyMarginTimeSeconds", + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.

", + "smithy.api#xmlName": "rekeyMarginTimeSeconds" + } + }, + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TunnelInsideIpv6Cidr", + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel.

", + "smithy.api#xmlName": "tunnelInsideIpv6Cidr" } }, "Phase1LifetimeSeconds": { @@ -54955,52 +56634,20 @@ "smithy.api#xmlName": "phase1LifetimeSeconds" } }, - "Phase1DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase1DHGroupNumbersList", - "traits": { - "aws.protocols#ec2QueryName": "Phase1DHGroupNumberSet", - "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.

", - "smithy.api#xmlName": "phase1DHGroupNumberSet" - } - }, "TunnelInsideCidr": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "TunnelInsideCidr", - "smithy.api#documentation": "

The range of inside IP addresses for the tunnel.

", + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel.

", "smithy.api#xmlName": "tunnelInsideCidr" } }, - "IkeVersions": { - "target": "com.amazonaws.ec2#IKEVersionsList", - "traits": { - "aws.protocols#ec2QueryName": "IkeVersionSet", - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

", - "smithy.api#xmlName": "ikeVersionSet" - } - }, - "RekeyMarginTimeSeconds": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "RekeyMarginTimeSeconds", - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.

", - "smithy.api#xmlName": "rekeyMarginTimeSeconds" - } - }, - "Phase2EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList", - "traits": { - "aws.protocols#ec2QueryName": "Phase2EncryptionAlgorithmSet", - "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.

", - "smithy.api#xmlName": "phase2EncryptionAlgorithmSet" - } - }, - "Phase2LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersList", "traits": { - "aws.protocols#ec2QueryName": "Phase2LifetimeSeconds", - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

", - "smithy.api#xmlName": "phase2LifetimeSeconds" + "aws.protocols#ec2QueryName": "Phase2DHGroupNumberSet", + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.

", + "smithy.api#xmlName": "phase2DHGroupNumberSet" } }, "Phase1EncryptionAlgorithms": { @@ -55011,6 +56658,14 @@ "smithy.api#xmlName": "phase1EncryptionAlgorithmSet" } }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1IntegrityAlgorithmSet", + "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.

", + "smithy.api#xmlName": "phase1IntegrityAlgorithmSet" + } + }, "PreSharedKey": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55019,6 +56674,14 @@ "smithy.api#xmlName": "preSharedKey" } }, + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersList", + "traits": { + "aws.protocols#ec2QueryName": "Phase1DHGroupNumberSet", + "smithy.api#documentation": "

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.

", + "smithy.api#xmlName": "phase1DHGroupNumberSet" + } + }, "OutsideIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55027,28 +56690,60 @@ "smithy.api#xmlName": "outsideIpAddress" } }, - "Phase2IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsList", + "StartupAction": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Phase2IntegrityAlgorithmSet", - "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.

", - "smithy.api#xmlName": "phase2IntegrityAlgorithmSet" + "aws.protocols#ec2QueryName": "StartupAction", + "smithy.api#documentation": "

The action to take when the establishing the VPN tunnels for a VPN connection.

", + "smithy.api#xmlName": "startupAction" } }, - "Phase1IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsList", + "DpdTimeoutAction": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Phase1IntegrityAlgorithmSet", - "smithy.api#documentation": "

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.

", - "smithy.api#xmlName": "phase1IntegrityAlgorithmSet" + "aws.protocols#ec2QueryName": "DpdTimeoutAction", + "smithy.api#documentation": "

The action to take after a DPD timeout occurs.

", + "smithy.api#xmlName": "dpdTimeoutAction" } }, - "RekeyFuzzPercentage": { + "Phase2LifetimeSeconds": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "RekeyFuzzPercentage", - "smithy.api#documentation": "

The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.

", - "smithy.api#xmlName": "rekeyFuzzPercentage" + "aws.protocols#ec2QueryName": "Phase2LifetimeSeconds", + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

", + "smithy.api#xmlName": "phase2LifetimeSeconds" + } + }, + "IkeVersions": { + "target": "com.amazonaws.ec2#IKEVersionsList", + "traits": { + "aws.protocols#ec2QueryName": "IkeVersionSet", + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

", + "smithy.api#xmlName": "ikeVersionSet" + } + }, + "DpdTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "DpdTimeoutSeconds", + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

", + "smithy.api#xmlName": "dpdTimeoutSeconds" + } + }, + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ReplayWindowSize", + "smithy.api#documentation": "

The number of packets in an IKE replay window.

", + "smithy.api#xmlName": "replayWindowSize" + } + }, + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsList", + "traits": { + "aws.protocols#ec2QueryName": "Phase2EncryptionAlgorithmSet", + "smithy.api#documentation": "

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.

", + "smithy.api#xmlName": "phase2EncryptionAlgorithmSet" } } }, @@ -55103,14 +56798,6 @@ "com.amazonaws.ec2#UnassignIpv6AddressesResult": { "type": "structure", "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#xmlName": "networkInterfaceId" - } - }, "UnassignedIpv6Addresses": { "target": "com.amazonaws.ec2#Ipv6AddressList", "traits": { @@ -55118,6 +56805,14 @@ "smithy.api#documentation": "

The IPv6 addresses that have been unassigned from the network interface.

", "smithy.api#xmlName": "unassignedIpv6Addresses" } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } } } }, @@ -55133,15 +56828,6 @@ "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest": { "type": "structure", "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "networkInterfaceId" - } - }, "PrivateIpAddresses": { "target": "com.amazonaws.ec2#PrivateIpAddressStringList", "traits": { @@ -55150,6 +56836,15 @@ "smithy.api#required": {}, "smithy.api#xmlName": "privateIpAddress" } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "networkInterfaceId" + } } }, "traits": { @@ -55168,6 +56863,9 @@ }, { "value": "t3a" + }, + { + "value": "t4g" } ] } @@ -55244,14 +56942,6 @@ "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItem": { "type": "structure", "members": { - "Error": { - "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

The applicable error for the burstable performance instance whose credit option for\n CPU usage was not modified.

", - "smithy.api#xmlName": "error" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55259,6 +56949,14 @@ "smithy.api#documentation": "

The ID of the instance.

", "smithy.api#xmlName": "instanceId" } + }, + "Error": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

The applicable error for the burstable performance instance whose credit option for\n CPU usage was not modified.

", + "smithy.api#xmlName": "error" + } } }, "traits": { @@ -55268,14 +56966,6 @@ "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationItemError": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55283,6 +56973,14 @@ "smithy.api#documentation": "

The applicable error message.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#UnsuccessfulInstanceCreditSpecificationErrorCode", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -55325,14 +57023,6 @@ "com.amazonaws.ec2#UnsuccessfulItemError": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55340,6 +57030,14 @@ "smithy.api#documentation": "

The error message accompanying the error code.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -55379,18 +57077,6 @@ "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "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.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" - } - }, "IpPermissions": { "target": "com.amazonaws.ec2#IpPermissionList", "traits": { @@ -55403,6 +57089,18 @@ "traits": { "smithy.api#documentation": "

[Default VPC] The name of the security group. You must specify either the security group\n\t\t\tID or the security group name in the request.

" } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } } }, @@ -55434,6 +57132,18 @@ "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest": { "type": "structure", "members": { + "GroupName": { + "target": "com.amazonaws.ec2#SecurityGroupName", + "traits": { + "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n\t\t\tsecurity group ID or the security group name in the request.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" + } + }, "IpPermissions": { "target": "com.amazonaws.ec2#IpPermissionList", "traits": { @@ -55446,18 +57156,6 @@ "traits": { "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.

" } - }, - "GroupName": { - "target": "com.amazonaws.ec2#SecurityGroupName", - "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The name of the security group. You must specify either the\n\t\t\tsecurity group ID or the security group name in the request.

" - } - }, - "GroupId": { - "target": "com.amazonaws.ec2#SecurityGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the security group. You must specify either the security group ID or the\n\t\t\tsecurity group name in the request. For security groups in a nondefault VPC, you must\n\t\t\tspecify the security group ID.

" - } } } }, @@ -55569,12 +57267,12 @@ "com.amazonaws.ec2#UserIdGroupPair": { "type": "structure", "members": { - "GroupId": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the security group rule that references this user ID group\n\t\t\tpair.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", + "smithy.api#xmlName": "description" } }, "VpcId": { @@ -55585,20 +57283,20 @@ "smithy.api#xmlName": "vpcId" } }, - "PeeringStatus": { + "UserId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PeeringStatus", - "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", - "smithy.api#xmlName": "peeringStatus" + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The ID of an AWS account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group\n in another AWS account.

", + "smithy.api#xmlName": "userId" } }, - "Description": { + "GroupName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the security group rule that references this user ID group\n\t\t\tpair.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=;{}!$*

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.

\n

For a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.

", + "smithy.api#xmlName": "groupName" } }, "VpcPeeringConnectionId": { @@ -55609,20 +57307,20 @@ "smithy.api#xmlName": "vpcPeeringConnectionId" } }, - "GroupName": { + "PeeringStatus": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.

\n

For a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.

", - "smithy.api#xmlName": "groupName" + "aws.protocols#ec2QueryName": "PeeringStatus", + "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", + "smithy.api#xmlName": "peeringStatus" } }, - "UserId": { + "GroupId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The ID of an AWS account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group\n in another AWS account.

", - "smithy.api#xmlName": "userId" + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" } } }, @@ -55666,12 +57364,12 @@ "com.amazonaws.ec2#VCpuInfo": { "type": "structure", "members": { - "DefaultVCpus": { - "target": "com.amazonaws.ec2#VCpuCount", + "ValidCores": { + "target": "com.amazonaws.ec2#CoreCountList", "traits": { - "aws.protocols#ec2QueryName": "DefaultVCpus", - "smithy.api#documentation": "

The default number of vCPUs for the instance type.

", - "smithy.api#xmlName": "defaultVCpus" + "aws.protocols#ec2QueryName": "ValidCores", + "smithy.api#documentation": "

List of the valid number of cores that can be configured for the instance type.

", + "smithy.api#xmlName": "validCores" } }, "DefaultThreadsPerCore": { @@ -55682,12 +57380,12 @@ "smithy.api#xmlName": "defaultThreadsPerCore" } }, - "ValidCores": { - "target": "com.amazonaws.ec2#CoreCountList", + "DefaultVCpus": { + "target": "com.amazonaws.ec2#VCpuCount", "traits": { - "aws.protocols#ec2QueryName": "ValidCores", - "smithy.api#documentation": "

List of the valid number of cores that can be configured for the instance type.

", - "smithy.api#xmlName": "validCores" + "aws.protocols#ec2QueryName": "DefaultVCpus", + "smithy.api#documentation": "

The default number of vCPUs for the instance type.

", + "smithy.api#xmlName": "defaultVCpus" } }, "DefaultCores": { @@ -55714,14 +57412,6 @@ "com.amazonaws.ec2#ValidationError": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.

", - "smithy.api#xmlName": "code" - } - }, "Message": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55729,6 +57419,14 @@ "smithy.api#documentation": "

The error message that describes why the parameter or parameter combination is not valid. For more\n information about error messages, see Error Codes.

", "smithy.api#xmlName": "message" } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -55781,30 +57479,6 @@ "com.amazonaws.ec2#VgwTelemetry": { "type": "structure", "members": { - "AcceptedRouteCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AcceptedRouteCount", - "smithy.api#documentation": "

The number of accepted routes.

", - "smithy.api#xmlName": "acceptedRouteCount" - } - }, - "LastStatusChange": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "LastStatusChange", - "smithy.api#documentation": "

The date and time of the last change in status.

", - "smithy.api#xmlName": "lastStatusChange" - } - }, - "CertificateArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CertificateArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

", - "smithy.api#xmlName": "certificateArn" - } - }, "OutsideIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55821,6 +57495,14 @@ "smithy.api#xmlName": "statusMessage" } }, + "AcceptedRouteCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AcceptedRouteCount", + "smithy.api#documentation": "

The number of accepted routes.

", + "smithy.api#xmlName": "acceptedRouteCount" + } + }, "Status": { "target": "com.amazonaws.ec2#TelemetryStatus", "traits": { @@ -55828,6 +57510,22 @@ "smithy.api#documentation": "

The status of the VPN tunnel.

", "smithy.api#xmlName": "status" } + }, + "CertificateArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CertificateArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

", + "smithy.api#xmlName": "certificateArn" + } + }, + "LastStatusChange": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastStatusChange", + "smithy.api#documentation": "

The date and time of the last change in status.

", + "smithy.api#xmlName": "lastStatusChange" + } } }, "traits": { @@ -55868,36 +57566,36 @@ "com.amazonaws.ec2#Volume": { "type": "structure", "members": { - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", + "Attachments": { + "target": "com.amazonaws.ec2#VolumeAttachmentList", "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the volume is encrypted.

", - "smithy.api#xmlName": "encrypted" + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "

Information about the volume attachments.

", + "smithy.api#xmlName": "attachmentSet" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the volume.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the volume.

", + "smithy.api#xmlName": "availabilityZone" } }, - "MultiAttachEnabled": { - "target": "com.amazonaws.ec2#Boolean", + "SnapshotId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "MultiAttachEnabled", - "smithy.api#documentation": "

Indicates whether Amazon EBS Multi-Attach is enabled.

", - "smithy.api#xmlName": "multiAttachEnabled" + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot from which the volume was created, if applicable.

", + "smithy.api#xmlName": "snapshotId" } }, - "OutpostArn": { - "target": "com.amazonaws.ec2#String", + "FastRestored": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", - "smithy.api#xmlName": "outpostArn" + "aws.protocols#ec2QueryName": "FastRestored", + "smithy.api#documentation": "

Indicates whether the volume was created using fast snapshot restore.

", + "smithy.api#xmlName": "fastRestored" } }, "Size": { @@ -55908,36 +57606,52 @@ "smithy.api#xmlName": "size" } }, - "VolumeType": { - "target": "com.amazonaws.ec2#VolumeType", + "Iops": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "VolumeType", - "smithy.api#documentation": "

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD,\n st1 for Throughput Optimized HDD, sc1 for Cold HDD, or\n standard for Magnetic volumes.

", - "smithy.api#xmlName": "volumeType" + "aws.protocols#ec2QueryName": "Iops", + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD\n volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD\n volumes, this represents the baseline performance of the volume and the rate at which the\n volume accumulates I/O credits for bursting. For more information, see Amazon EBS volume types in\n the Amazon Elastic Compute Cloud User Guide.

\n

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100\n to 64,000 IOPS for io1 and io2 volumes, in most Regions. The maximum\n IOPS for io1 and io2 of 64,000 is guaranteed only on Nitro-based\n instances. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

Condition: This parameter is required for requests to create io1 and io2 volumes;\n it is not used in requests to create gp2, st1,\n sc1, or standard volumes.

", + "smithy.api#xmlName": "iops" } }, - "FastRestored": { + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", + "smithy.api#xmlName": "outpostArn" + } + }, + "MultiAttachEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "FastRestored", - "smithy.api#documentation": "

Indicates whether the volume was created using fast snapshot restore.

", - "smithy.api#xmlName": "fastRestored" + "aws.protocols#ec2QueryName": "MultiAttachEnabled", + "smithy.api#documentation": "

Indicates whether Amazon EBS Multi-Attach is enabled.

", + "smithy.api#xmlName": "multiAttachEnabled" } }, - "Attachments": { - "target": "com.amazonaws.ec2#VolumeAttachmentList", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "

Information about the volume attachments.

", - "smithy.api#xmlName": "attachmentSet" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the volume.

", + "smithy.api#xmlName": "tagSet" } }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The snapshot from which the volume was created, if applicable.

", - "smithy.api#xmlName": "snapshotId" + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the volume is encrypted.

", + "smithy.api#xmlName": "encrypted" } }, "State": { @@ -55948,20 +57662,12 @@ "smithy.api#xmlName": "status" } }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the\n volume encryption key for the volume.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "VolumeType": { + "target": "com.amazonaws.ec2#VolumeType", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone for the volume.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "VolumeType", + "smithy.api#documentation": "

The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD,\n st1 for Throughput Optimized HDD, sc1 for Cold HDD, or\n standard for Magnetic volumes.

", + "smithy.api#xmlName": "volumeType" } }, "CreateTime": { @@ -55972,20 +57678,12 @@ "smithy.api#xmlName": "createTime" } }, - "VolumeId": { + "KmsKeyId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#xmlName": "volumeId" - } - }, - "Iops": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Iops", - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD\n volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD\n volumes, this represents the baseline performance of the volume and the rate at which the\n volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in\n the Amazon Elastic Compute Cloud User Guide.

\n

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100\n to 64,000IOPS for io1 volumes, in most Regions. The maximum\n IOPS for io1 of 64,000 is guaranteed only on Nitro-based\n instances. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

Condition: This parameter is required for requests to create io1 volumes;\n it is not used in requests to create gp2, st1,\n sc1, or standard volumes.

", - "smithy.api#xmlName": "iops" + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the\n volume encryption key for the volume.

", + "smithy.api#xmlName": "kmsKeyId" } } }, @@ -56004,6 +57702,22 @@ "smithy.api#xmlName": "volumeId" } }, + "State": { + "target": "com.amazonaws.ec2#VolumeAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state of the volume.

", + "smithy.api#xmlName": "status" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } + }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56012,14 +57726,6 @@ "smithy.api#xmlName": "instanceId" } }, - "AttachTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "AttachTime", - "smithy.api#documentation": "

The time stamp when the attachment initiated.

", - "smithy.api#xmlName": "attachTime" - } - }, "Device": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56028,20 +57734,12 @@ "smithy.api#xmlName": "device" } }, - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "

Indicates whether the EBS volume is deleted on instance termination.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, - "State": { - "target": "com.amazonaws.ec2#VolumeAttachmentState", + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The attachment state of the volume.

", - "smithy.api#xmlName": "status" + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" } } }, @@ -56134,12 +57832,12 @@ "com.amazonaws.ec2#VolumeModification": { "type": "structure", "members": { - "OriginalIops": { + "TargetSize": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "OriginalIops", - "smithy.api#documentation": "

The original IOPS rate of the volume.

", - "smithy.api#xmlName": "originalIops" + "aws.protocols#ec2QueryName": "TargetSize", + "smithy.api#documentation": "

The target size of the volume, in GiB.

", + "smithy.api#xmlName": "targetSize" } }, "ModificationState": { @@ -56150,22 +57848,6 @@ "smithy.api#xmlName": "modificationState" } }, - "TargetVolumeType": { - "target": "com.amazonaws.ec2#VolumeType", - "traits": { - "aws.protocols#ec2QueryName": "TargetVolumeType", - "smithy.api#documentation": "

The target EBS volume type of the volume.

", - "smithy.api#xmlName": "targetVolumeType" - } - }, - "TargetSize": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "TargetSize", - "smithy.api#documentation": "

The target size of the volume, in GiB.

", - "smithy.api#xmlName": "targetSize" - } - }, "OriginalSize": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -56174,20 +57856,20 @@ "smithy.api#xmlName": "originalSize" } }, - "OriginalVolumeType": { - "target": "com.amazonaws.ec2#VolumeType", + "TargetIops": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "OriginalVolumeType", - "smithy.api#documentation": "

The original EBS volume type of the volume.

", - "smithy.api#xmlName": "originalVolumeType" + "aws.protocols#ec2QueryName": "TargetIops", + "smithy.api#documentation": "

The target IOPS rate of the volume.

", + "smithy.api#xmlName": "targetIops" } }, - "EndTime": { - "target": "com.amazonaws.ec2#DateTime", + "Progress": { + "target": "com.amazonaws.ec2#Long", "traits": { - "aws.protocols#ec2QueryName": "EndTime", - "smithy.api#documentation": "

The modification completion or failure time.

", - "smithy.api#xmlName": "endTime" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The modification progress, from 0 to 100 percent complete.

", + "smithy.api#xmlName": "progress" } }, "VolumeId": { @@ -56198,12 +57880,28 @@ "smithy.api#xmlName": "volumeId" } }, - "Progress": { - "target": "com.amazonaws.ec2#Long", + "OriginalIops": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The modification progress, from 0 to 100 percent complete.

", - "smithy.api#xmlName": "progress" + "aws.protocols#ec2QueryName": "OriginalIops", + "smithy.api#documentation": "

The original IOPS rate of the volume.

", + "smithy.api#xmlName": "originalIops" + } + }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The modification start time.

", + "smithy.api#xmlName": "startTime" + } + }, + "OriginalVolumeType": { + "target": "com.amazonaws.ec2#VolumeType", + "traits": { + "aws.protocols#ec2QueryName": "OriginalVolumeType", + "smithy.api#documentation": "

The original EBS volume type of the volume.

", + "smithy.api#xmlName": "originalVolumeType" } }, "StatusMessage": { @@ -56214,20 +57912,20 @@ "smithy.api#xmlName": "statusMessage" } }, - "TargetIops": { - "target": "com.amazonaws.ec2#Integer", + "TargetVolumeType": { + "target": "com.amazonaws.ec2#VolumeType", "traits": { - "aws.protocols#ec2QueryName": "TargetIops", - "smithy.api#documentation": "

The target IOPS rate of the volume.

", - "smithy.api#xmlName": "targetIops" + "aws.protocols#ec2QueryName": "TargetVolumeType", + "smithy.api#documentation": "

The target EBS volume type of the volume.

", + "smithy.api#xmlName": "targetVolumeType" } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The modification start time.

", - "smithy.api#xmlName": "startTime" + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The modification completion or failure time.

", + "smithy.api#xmlName": "endTime" } } }, @@ -56291,14 +57989,6 @@ "com.amazonaws.ec2#VolumeStatusAction": { "type": "structure", "members": { - "EventType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type associated with this operation.

", - "smithy.api#xmlName": "eventType" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56307,12 +57997,12 @@ "smithy.api#xmlName": "description" } }, - "Code": { + "EventType": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The code identifying the operation, for example, enable-volume-io.

", - "smithy.api#xmlName": "code" + "aws.protocols#ec2QueryName": "EventType", + "smithy.api#documentation": "

The event type associated with this operation.

", + "smithy.api#xmlName": "eventType" } }, "EventId": { @@ -56322,6 +58012,14 @@ "smithy.api#documentation": "

The ID of the event associated with this operation.

", "smithy.api#xmlName": "eventId" } + }, + "Code": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Code", + "smithy.api#documentation": "

The code identifying the operation, for example, enable-volume-io.

", + "smithy.api#xmlName": "code" + } } }, "traits": { @@ -56373,14 +58071,6 @@ "com.amazonaws.ec2#VolumeStatusDetails": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The intended status of the volume status.

", - "smithy.api#xmlName": "status" - } - }, "Name": { "target": "com.amazonaws.ec2#VolumeStatusName", "traits": { @@ -56388,6 +58078,14 @@ "smithy.api#documentation": "

The name of the volume status.

", "smithy.api#xmlName": "name" } + }, + "Status": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The intended status of the volume status.

", + "smithy.api#xmlName": "status" + } } }, "traits": { @@ -56406,14 +58104,6 @@ "com.amazonaws.ec2#VolumeStatusEvent": { "type": "structure", "members": { - "EventId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "EventId", - "smithy.api#documentation": "

The ID of this event.

", - "smithy.api#xmlName": "eventId" - } - }, "NotBefore": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { @@ -56430,12 +58120,12 @@ "smithy.api#xmlName": "description" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", + "NotAfter": { + "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance associated with the event.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "NotAfter", + "smithy.api#documentation": "

The latest end time of the event.

", + "smithy.api#xmlName": "notAfter" } }, "EventType": { @@ -56446,12 +58136,20 @@ "smithy.api#xmlName": "eventType" } }, - "NotAfter": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "InstanceId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "NotAfter", - "smithy.api#documentation": "

The latest end time of the event.

", - "smithy.api#xmlName": "notAfter" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance associated with the event.

", + "smithy.api#xmlName": "instanceId" + } + }, + "EventId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "EventId", + "smithy.api#documentation": "

The ID of this event.

", + "smithy.api#xmlName": "eventId" } } }, @@ -56471,14 +58169,6 @@ "com.amazonaws.ec2#VolumeStatusInfo": { "type": "structure", "members": { - "Details": { - "target": "com.amazonaws.ec2#VolumeStatusDetailsList", - "traits": { - "aws.protocols#ec2QueryName": "Details", - "smithy.api#documentation": "

The details of the volume status.

", - "smithy.api#xmlName": "details" - } - }, "Status": { "target": "com.amazonaws.ec2#VolumeStatusInfoStatus", "traits": { @@ -56486,6 +58176,14 @@ "smithy.api#documentation": "

The status of the volume.

", "smithy.api#xmlName": "status" } + }, + "Details": { + "target": "com.amazonaws.ec2#VolumeStatusDetailsList", + "traits": { + "aws.protocols#ec2QueryName": "Details", + "smithy.api#documentation": "

The details of the volume status.

", + "smithy.api#xmlName": "details" + } } }, "traits": { @@ -56511,30 +58209,6 @@ "com.amazonaws.ec2#VolumeStatusItem": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the volume.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "AttachmentStatuses": { - "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatusList", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentStatuses", - "smithy.api#documentation": "

Information about the instances to which the volume is attached.

", - "smithy.api#xmlName": "attachmentStatuses" - } - }, - "VolumeStatus": { - "target": "com.amazonaws.ec2#VolumeStatusInfo", - "traits": { - "aws.protocols#ec2QueryName": "VolumeStatus", - "smithy.api#documentation": "

The volume status.

", - "smithy.api#xmlName": "volumeStatus" - } - }, "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56543,6 +58217,14 @@ "smithy.api#xmlName": "outpostArn" } }, + "Actions": { + "target": "com.amazonaws.ec2#VolumeStatusActionsList", + "traits": { + "aws.protocols#ec2QueryName": "ActionsSet", + "smithy.api#documentation": "

The details of the operation.

", + "smithy.api#xmlName": "actionsSet" + } + }, "VolumeId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56551,6 +58233,14 @@ "smithy.api#xmlName": "volumeId" } }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the volume.

", + "smithy.api#xmlName": "availabilityZone" + } + }, "Events": { "target": "com.amazonaws.ec2#VolumeStatusEventsList", "traits": { @@ -56559,12 +58249,20 @@ "smithy.api#xmlName": "eventsSet" } }, - "Actions": { - "target": "com.amazonaws.ec2#VolumeStatusActionsList", + "AttachmentStatuses": { + "target": "com.amazonaws.ec2#VolumeStatusAttachmentStatusList", "traits": { - "aws.protocols#ec2QueryName": "ActionsSet", - "smithy.api#documentation": "

The details of the operation.

", - "smithy.api#xmlName": "actionsSet" + "aws.protocols#ec2QueryName": "AttachmentStatuses", + "smithy.api#documentation": "

Information about the instances to which the volume is attached.

", + "smithy.api#xmlName": "attachmentStatuses" + } + }, + "VolumeStatus": { + "target": "com.amazonaws.ec2#VolumeStatusInfo", + "traits": { + "aws.protocols#ec2QueryName": "VolumeStatus", + "smithy.api#documentation": "

The volume status.

", + "smithy.api#xmlName": "volumeStatus" } } }, @@ -56604,6 +58302,9 @@ { "value": "io1" }, + { + "value": "io2" + }, { "value": "gp2" }, @@ -56619,52 +58320,52 @@ "com.amazonaws.ec2#Vpc": { "type": "structure", "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the VPC.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The allowed tenancy of instances launched into the VPC.

", + "smithy.api#xmlName": "instanceTenancy" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPC.

", + "smithy.api#xmlName": "tagSet" } }, "DhcpOptionsId": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "DhcpOptionsId", - "smithy.api#documentation": "

The ID of the set of DHCP options you've associated with the VPC (or default\n\t\t\t\tif the default options are associated with the VPC).

", + "smithy.api#documentation": "

The ID of the set of DHCP options you've associated with the VPC.

", "smithy.api#xmlName": "dhcpOptionsId" } }, - "CidrBlock": { + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The primary IPv4 CIDR block for the VPC.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "State": { - "target": "com.amazonaws.ec2#VpcState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the VPC.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" } }, - "IsDefault": { - "target": "com.amazonaws.ec2#Boolean", + "OwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IsDefault", - "smithy.api#documentation": "

Indicates whether the VPC is the default VPC.

", - "smithy.api#xmlName": "isDefault" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the VPC.

", + "smithy.api#xmlName": "ownerId" } }, - "VpcId": { - "target": "com.amazonaws.ec2#String", + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", + "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the VPC.

", + "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" } }, "CidrBlockAssociationSet": { @@ -56675,28 +58376,28 @@ "smithy.api#xmlName": "cidrBlockAssociationSet" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "IsDefault": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the VPC.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "IsDefault", + "smithy.api#documentation": "

Indicates whether the VPC is the default VPC.

", + "smithy.api#xmlName": "isDefault" } }, - "Ipv6CidrBlockAssociationSet": { - "target": "com.amazonaws.ec2#VpcIpv6CidrBlockAssociationSet", + "State": { + "target": "com.amazonaws.ec2#VpcState", "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockAssociationSet", - "smithy.api#documentation": "

Information about the IPv6 CIDR blocks associated with the VPC.

", - "smithy.api#xmlName": "ipv6CidrBlockAssociationSet" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the VPC.

", + "smithy.api#xmlName": "state" } }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", + "CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The allowed tenancy of instances launched into the VPC.

", - "smithy.api#xmlName": "instanceTenancy" + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The primary IPv4 CIDR block for the VPC.

", + "smithy.api#xmlName": "cidrBlock" } } }, @@ -56707,14 +58408,6 @@ "com.amazonaws.ec2#VpcAttachment": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the attachment.

", - "smithy.api#xmlName": "state" - } - }, "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56722,6 +58415,14 @@ "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#xmlName": "vpcId" } + }, + "State": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the attachment.

", + "smithy.api#xmlName": "state" + } } }, "traits": { @@ -56756,14 +58457,6 @@ "com.amazonaws.ec2#VpcCidrBlockAssociation": { "type": "structure", "members": { - "CidrBlockState": { - "target": "com.amazonaws.ec2#VpcCidrBlockState", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlockState", - "smithy.api#documentation": "

Information about the state of the CIDR block.

", - "smithy.api#xmlName": "cidrBlockState" - } - }, "AssociationId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56779,6 +58472,14 @@ "smithy.api#documentation": "

The IPv4 CIDR block.

", "smithy.api#xmlName": "cidrBlock" } + }, + "CidrBlockState": { + "target": "com.amazonaws.ec2#VpcCidrBlockState", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlockState", + "smithy.api#documentation": "

Information about the state of the CIDR block.

", + "smithy.api#xmlName": "cidrBlockState" + } } }, "traits": { @@ -56854,14 +58555,6 @@ "smithy.api#xmlName": "vpcId" } }, - "ClassicLinkEnabled": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "ClassicLinkEnabled", - "smithy.api#documentation": "

Indicates whether the VPC is enabled for ClassicLink.

", - "smithy.api#xmlName": "classicLinkEnabled" - } - }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -56869,6 +58562,14 @@ "smithy.api#documentation": "

Any tags assigned to the VPC.

", "smithy.api#xmlName": "tagSet" } + }, + "ClassicLinkEnabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "ClassicLinkEnabled", + "smithy.api#documentation": "

Indicates whether the VPC is enabled for ClassicLink.

", + "smithy.api#xmlName": "classicLinkEnabled" + } } }, "traits": { @@ -56896,36 +58597,20 @@ "com.amazonaws.ec2#VpcEndpoint": { "type": "structure", "members": { - "LastError": { - "target": "com.amazonaws.ec2#LastError", - "traits": { - "aws.protocols#ec2QueryName": "LastError", - "smithy.api#documentation": "

The last error that occurred for VPC endpoint.

", - "smithy.api#xmlName": "lastError" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PolicyDocument", - "smithy.api#documentation": "

The policy document associated with the endpoint, if applicable.

", - "smithy.api#xmlName": "policyDocument" - } - }, - "VpcEndpointId": { + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointId", - "smithy.api#documentation": "

The ID of the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointId" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC to which the endpoint is associated.

", + "smithy.api#xmlName": "vpcId" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "RequesterManaged": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the VPC endpoint.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "RequesterManaged", + "smithy.api#documentation": "

Indicates whether the VPC endpoint is being managed by its service.

", + "smithy.api#xmlName": "requesterManaged" } }, "NetworkInterfaceIds": { @@ -56936,6 +58621,30 @@ "smithy.api#xmlName": "networkInterfaceIdSet" } }, + "RouteTableIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "RouteTableIdSet", + "smithy.api#documentation": "

(Gateway endpoint) One or more route tables associated with the endpoint.

", + "smithy.api#xmlName": "routeTableIdSet" + } + }, + "DnsEntries": { + "target": "com.amazonaws.ec2#DnsEntrySet", + "traits": { + "aws.protocols#ec2QueryName": "DnsEntrySet", + "smithy.api#documentation": "

(Interface endpoint) The DNS entries for the endpoint.

", + "smithy.api#xmlName": "dnsEntrySet" + } + }, + "State": { + "target": "com.amazonaws.ec2#State", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the VPC endpoint.

", + "smithy.api#xmlName": "state" + } + }, "SubnetIds": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -56944,52 +58653,60 @@ "smithy.api#xmlName": "subnetIdSet" } }, - "VpcEndpointType": { - "target": "com.amazonaws.ec2#VpcEndpointType", + "LastError": { + "target": "com.amazonaws.ec2#LastError", "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointType", - "smithy.api#documentation": "

The type of endpoint.

", - "smithy.api#xmlName": "vpcEndpointType" + "aws.protocols#ec2QueryName": "LastError", + "smithy.api#documentation": "

The last error that occurred for VPC endpoint.

", + "smithy.api#xmlName": "lastError" } }, - "CreationTimestamp": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "CreationTimestamp", - "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

", - "smithy.api#xmlName": "creationTimestamp" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPC endpoint.

", + "smithy.api#xmlName": "tagSet" } }, - "DnsEntries": { - "target": "com.amazonaws.ec2#DnsEntrySet", + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DnsEntrySet", - "smithy.api#documentation": "

(Interface endpoint) The DNS entries for the endpoint.

", - "smithy.api#xmlName": "dnsEntrySet" + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" } }, - "RouteTableIds": { - "target": "com.amazonaws.ec2#ValueStringList", + "PrivateDnsEnabled": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "RouteTableIdSet", - "smithy.api#documentation": "

(Gateway endpoint) One or more route tables associated with the endpoint.

", - "smithy.api#xmlName": "routeTableIdSet" + "aws.protocols#ec2QueryName": "PrivateDnsEnabled", + "smithy.api#documentation": "

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

", + "smithy.api#xmlName": "privateDnsEnabled" } }, - "ServiceName": { + "PolicyDocument": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ServiceName", - "smithy.api#documentation": "

The name of the service to which the endpoint is associated.

", - "smithy.api#xmlName": "serviceName" + "aws.protocols#ec2QueryName": "PolicyDocument", + "smithy.api#documentation": "

The policy document associated with the endpoint, if applicable.

", + "smithy.api#xmlName": "policyDocument" } }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", + "CreationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the VPC endpoint.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "CreationTimestamp", + "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

", + "smithy.api#xmlName": "creationTimestamp" + } + }, + "VpcEndpointType": { + "target": "com.amazonaws.ec2#VpcEndpointType", + "traits": { + "aws.protocols#ec2QueryName": "VpcEndpointType", + "smithy.api#documentation": "

The type of endpoint.

", + "smithy.api#xmlName": "vpcEndpointType" } }, "Groups": { @@ -57000,36 +58717,20 @@ "smithy.api#xmlName": "groupSet" } }, - "State": { - "target": "com.amazonaws.ec2#State", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the VPC endpoint.

", - "smithy.api#xmlName": "state" - } - }, - "RequesterManaged": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "RequesterManaged", - "smithy.api#documentation": "

Indicates whether the VPC endpoint is being managed by its service.

", - "smithy.api#xmlName": "requesterManaged" - } - }, - "PrivateDnsEnabled": { - "target": "com.amazonaws.ec2#Boolean", + "OwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsEnabled", - "smithy.api#documentation": "

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

", - "smithy.api#xmlName": "privateDnsEnabled" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the AWS account that owns the VPC endpoint.

", + "smithy.api#xmlName": "ownerId" } }, - "VpcId": { + "ServiceName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC to which the endpoint is associated.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "ServiceName", + "smithy.api#documentation": "

The name of the service to which the endpoint is associated.

", + "smithy.api#xmlName": "serviceName" } } }, @@ -57040,12 +58741,12 @@ "com.amazonaws.ec2#VpcEndpointConnection": { "type": "structure", "members": { - "VpcEndpointId": { - "target": "com.amazonaws.ec2#String", + "CreationTimestamp": { + "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointId", - "smithy.api#documentation": "

The ID of the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointId" + "aws.protocols#ec2QueryName": "CreationTimestamp", + "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

", + "smithy.api#xmlName": "creationTimestamp" } }, "VpcEndpointState": { @@ -57056,20 +58757,12 @@ "smithy.api#xmlName": "vpcEndpointState" } }, - "VpcEndpointOwner": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcEndpointOwner", - "smithy.api#documentation": "

The AWS account ID of the owner of the VPC endpoint.

", - "smithy.api#xmlName": "vpcEndpointOwner" - } - }, - "ServiceId": { - "target": "com.amazonaws.ec2#String", + "DnsEntries": { + "target": "com.amazonaws.ec2#DnsEntrySet", "traits": { - "aws.protocols#ec2QueryName": "ServiceId", - "smithy.api#documentation": "

The ID of the service to which the endpoint is connected.

", - "smithy.api#xmlName": "serviceId" + "aws.protocols#ec2QueryName": "DnsEntrySet", + "smithy.api#documentation": "

The DNS entries for the VPC endpoint.

", + "smithy.api#xmlName": "dnsEntrySet" } }, "NetworkLoadBalancerArns": { @@ -57080,20 +58773,28 @@ "smithy.api#xmlName": "networkLoadBalancerArnSet" } }, - "DnsEntries": { - "target": "com.amazonaws.ec2#DnsEntrySet", + "VpcEndpointOwner": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DnsEntrySet", - "smithy.api#documentation": "

The DNS entries for the VPC endpoint.

", - "smithy.api#xmlName": "dnsEntrySet" + "aws.protocols#ec2QueryName": "VpcEndpointOwner", + "smithy.api#documentation": "

The AWS account ID of the owner of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointOwner" } }, - "CreationTimestamp": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "VpcEndpointId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CreationTimestamp", - "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

", - "smithy.api#xmlName": "creationTimestamp" + "aws.protocols#ec2QueryName": "VpcEndpointId", + "smithy.api#documentation": "

The ID of the VPC endpoint.

", + "smithy.api#xmlName": "vpcEndpointId" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ServiceId", + "smithy.api#documentation": "

The ID of the service to which the endpoint is connected.

", + "smithy.api#xmlName": "serviceId" } } }, @@ -57207,16 +58908,16 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block.

", + "smithy.api#documentation": "

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from\n which AWS advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

", "smithy.api#xmlName": "networkBorderGroup" } }, - "AssociationId": { - "target": "com.amazonaws.ec2#String", + "Ipv6CidrBlockState": { + "target": "com.amazonaws.ec2#VpcCidrBlockState", "traits": { - "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "

The association ID for the IPv6 CIDR block.

", - "smithy.api#xmlName": "associationId" + "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", + "smithy.api#documentation": "

Information about the state of the CIDR block.

", + "smithy.api#xmlName": "ipv6CidrBlockState" } }, "Ipv6CidrBlock": { @@ -57235,12 +58936,12 @@ "smithy.api#xmlName": "ipv6Pool" } }, - "Ipv6CidrBlockState": { - "target": "com.amazonaws.ec2#VpcCidrBlockState", + "AssociationId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockState", - "smithy.api#documentation": "

Information about the state of the CIDR block.

", - "smithy.api#xmlName": "ipv6CidrBlockState" + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The association ID for the IPv6 CIDR block.

", + "smithy.api#xmlName": "associationId" } } }, @@ -57269,6 +58970,22 @@ "com.amazonaws.ec2#VpcPeeringConnection": { "type": "structure", "members": { + "RequesterVpcInfo": { + "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", + "traits": { + "aws.protocols#ec2QueryName": "RequesterVpcInfo", + "smithy.api#documentation": "

Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

", + "smithy.api#xmlName": "requesterVpcInfo" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "ExpirationTime", + "smithy.api#documentation": "

The time that an unaccepted VPC peering connection will expire.

", + "smithy.api#xmlName": "expirationTime" + } + }, "AccepterVpcInfo": { "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", "traits": { @@ -57277,12 +58994,12 @@ "smithy.api#xmlName": "accepterVpcInfo" } }, - "RequesterVpcInfo": { - "target": "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo", + "VpcPeeringConnectionId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RequesterVpcInfo", - "smithy.api#documentation": "

Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

", - "smithy.api#xmlName": "requesterVpcInfo" + "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", + "smithy.api#documentation": "

The ID of the VPC peering connection.

", + "smithy.api#xmlName": "vpcPeeringConnectionId" } }, "Tags": { @@ -57300,22 +59017,6 @@ "smithy.api#documentation": "

The status of the VPC peering connection.

", "smithy.api#xmlName": "status" } - }, - "VpcPeeringConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcPeeringConnectionId", - "smithy.api#documentation": "

The ID of the VPC peering connection.

", - "smithy.api#xmlName": "vpcPeeringConnectionId" - } - }, - "ExpirationTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "ExpirationTime", - "smithy.api#documentation": "

The time that an unaccepted VPC peering connection will expire.

", - "smithy.api#xmlName": "expirationTime" - } } }, "traits": { @@ -57346,6 +59047,14 @@ "com.amazonaws.ec2#VpcPeeringConnectionOptionsDescription": { "type": "structure", "members": { + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", + "smithy.api#documentation": "

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", + "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" + } + }, "AllowEgressFromLocalVpcToRemoteClassicLink": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -57361,14 +59070,6 @@ "smithy.api#documentation": "

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", "smithy.api#xmlName": "allowDnsResolutionFromRemoteVpc" } - }, - "AllowEgressFromLocalClassicLinkToRemoteVpc": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowEgressFromLocalClassicLinkToRemoteVpc", - "smithy.api#documentation": "

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", - "smithy.api#xmlName": "allowEgressFromLocalClassicLinkToRemoteVpc" - } } }, "traits": { @@ -57436,36 +59137,36 @@ "com.amazonaws.ec2#VpcPeeringConnectionVpcInfo": { "type": "structure", "members": { - "Region": { + "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Region", - "smithy.api#documentation": "

The Region in which the VPC is located.

", - "smithy.api#xmlName": "region" + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" } }, - "Ipv6CidrBlockSet": { - "target": "com.amazonaws.ec2#Ipv6CidrBlockSet", + "CidrBlockSet": { + "target": "com.amazonaws.ec2#CidrBlockSet", "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlockSet", - "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.

", - "smithy.api#xmlName": "ipv6CidrBlockSet" + "aws.protocols#ec2QueryName": "CidrBlockSet", + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.

", + "smithy.api#xmlName": "cidrBlockSet" } }, - "CidrBlock": { + "Region": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.

", - "smithy.api#xmlName": "cidrBlock" + "aws.protocols#ec2QueryName": "Region", + "smithy.api#documentation": "

The Region in which the VPC is located.

", + "smithy.api#xmlName": "region" } }, - "VpcId": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The AWS account ID of the VPC owner.

", + "smithy.api#xmlName": "ownerId" } }, "PeeringOptions": { @@ -57476,20 +59177,20 @@ "smithy.api#xmlName": "peeringOptions" } }, - "CidrBlockSet": { - "target": "com.amazonaws.ec2#CidrBlockSet", + "Ipv6CidrBlockSet": { + "target": "com.amazonaws.ec2#Ipv6CidrBlockSet", "traits": { - "aws.protocols#ec2QueryName": "CidrBlockSet", - "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.

", - "smithy.api#xmlName": "cidrBlockSet" + "aws.protocols#ec2QueryName": "Ipv6CidrBlockSet", + "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.

", + "smithy.api#xmlName": "ipv6CidrBlockSet" } }, - "OwnerId": { + "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The AWS account ID of the VPC owner.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.

", + "smithy.api#xmlName": "cidrBlock" } } }, @@ -57523,20 +59224,20 @@ "com.amazonaws.ec2#VpnConnection": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.ec2#GatewayType", + "TransitGatewayId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of VPN connection.

", - "smithy.api#xmlName": "type" + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", + "smithy.api#xmlName": "transitGatewayId" } }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "VpnGatewayId", - "smithy.api#documentation": "

The ID of the virtual private gateway at the AWS side of the VPN connection.

", - "smithy.api#xmlName": "vpnGatewayId" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the VPN connection.

", + "smithy.api#xmlName": "tagSet" } }, "VgwTelemetry": { @@ -57547,6 +59248,14 @@ "smithy.api#xmlName": "vgwTelemetry" } }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection.

", + "smithy.api#xmlName": "type" + } + }, "CustomerGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -57555,36 +59264,12 @@ "smithy.api#xmlName": "customerGatewayId" } }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayId", - "smithy.api#documentation": "

The ID of the transit gateway associated with the VPN connection.

", - "smithy.api#xmlName": "transitGatewayId" - } - }, - "Routes": { - "target": "com.amazonaws.ec2#VpnStaticRouteList", - "traits": { - "aws.protocols#ec2QueryName": "Routes", - "smithy.api#documentation": "

The static routes associated with the VPN connection.

", - "smithy.api#xmlName": "routes" - } - }, - "Options": { - "target": "com.amazonaws.ec2#VpnConnectionOptions", - "traits": { - "aws.protocols#ec2QueryName": "Options", - "smithy.api#documentation": "

The VPN connection options.

", - "smithy.api#xmlName": "options" - } - }, - "VpnConnectionId": { + "VpnGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionId", - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#xmlName": "vpnConnectionId" + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "smithy.api#xmlName": "vpnGatewayId" } }, "CustomerGatewayConfiguration": { @@ -57595,6 +59280,14 @@ "smithy.api#xmlName": "customerGatewayConfiguration" } }, + "Category": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Category", + "smithy.api#documentation": "

The category of the VPN connection. A value of VPN indicates an AWS VPN\n\t\t\tconnection. A value of VPN-Classic indicates an AWS Classic VPN connection.

", + "smithy.api#xmlName": "category" + } + }, "State": { "target": "com.amazonaws.ec2#VpnState", "traits": { @@ -57603,20 +59296,28 @@ "smithy.api#xmlName": "state" } }, - "Category": { + "Routes": { + "target": "com.amazonaws.ec2#VpnStaticRouteList", + "traits": { + "aws.protocols#ec2QueryName": "Routes", + "smithy.api#documentation": "

The static routes associated with the VPN connection.

", + "smithy.api#xmlName": "routes" + } + }, + "VpnConnectionId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Category", - "smithy.api#documentation": "

The category of the VPN connection. A value of VPN indicates an AWS VPN\n\t\t\tconnection. A value of VPN-Classic indicates an AWS Classic VPN connection.

", - "smithy.api#xmlName": "category" + "aws.protocols#ec2QueryName": "VpnConnectionId", + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#xmlName": "vpnConnectionId" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "Options": { + "target": "com.amazonaws.ec2#VpnConnectionOptions", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the VPN connection.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "Options", + "smithy.api#documentation": "

The VPN connection options.

", + "smithy.api#xmlName": "options" } } }, @@ -57648,12 +59349,12 @@ "com.amazonaws.ec2#VpnConnectionOptions": { "type": "structure", "members": { - "EnableAcceleration": { - "target": "com.amazonaws.ec2#Boolean", + "TunnelInsideIpVersion": { + "target": "com.amazonaws.ec2#TunnelInsideIpVersion", "traits": { - "aws.protocols#ec2QueryName": "EnableAcceleration", - "smithy.api#documentation": "

Indicates whether acceleration is enabled for the VPN connection.

", - "smithy.api#xmlName": "enableAcceleration" + "aws.protocols#ec2QueryName": "TunnelInsideIpVersion", + "smithy.api#documentation": "

Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.

", + "smithy.api#xmlName": "tunnelInsideIpVersion" } }, "TunnelOptions": { @@ -57671,6 +59372,46 @@ "smithy.api#documentation": "

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "smithy.api#xmlName": "staticRoutesOnly" } + }, + "EnableAcceleration": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableAcceleration", + "smithy.api#documentation": "

Indicates whether acceleration is enabled for the VPN connection.

", + "smithy.api#xmlName": "enableAcceleration" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalIpv6NetworkCidr", + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

", + "smithy.api#xmlName": "localIpv6NetworkCidr" + } + }, + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalIpv4NetworkCidr", + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

", + "smithy.api#xmlName": "localIpv4NetworkCidr" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemoteIpv4NetworkCidr", + "smithy.api#documentation": "

The IPv4 CIDR on the AWS side of the VPN connection.

", + "smithy.api#xmlName": "remoteIpv4NetworkCidr" + } + }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RemoteIpv6NetworkCidr", + "smithy.api#documentation": "

The IPv6 CIDR on the AWS side of the VPN connection.

", + "smithy.api#xmlName": "remoteIpv6NetworkCidr" + } } }, "traits": { @@ -57680,10 +59421,10 @@ "com.amazonaws.ec2#VpnConnectionOptionsSpecification": { "type": "structure", "members": { - "TunnelOptions": { - "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList", + "LocalIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The tunnel options for the VPN connection.

" + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" } }, "StaticRoutesOnly": { @@ -57694,11 +59435,41 @@ "smithy.api#xmlName": "staticRoutesOnly" } }, + "RemoteIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the AWS side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "LocalIpv6NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + } + }, + "RemoteIpv4NetworkCidr": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR on the AWS side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + } + }, "EnableAcceleration": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Indicate whether to enable acceleration for the VPN connection.

\n

Default: false\n

" } + }, + "TunnelOptions": { + "target": "com.amazonaws.ec2#VpnTunnelOptionsSpecificationsList", + "traits": { + "smithy.api#documentation": "

The tunnel options for the VPN connection.

" + } + }, + "TunnelInsideIpVersion": { + "target": "com.amazonaws.ec2#TunnelInsideIpVersion", + "traits": { + "smithy.api#documentation": "

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

\n

Default: ipv4\n

" + } } }, "traits": { @@ -57721,6 +59492,14 @@ "com.amazonaws.ec2#VpnGateway": { "type": "structure", "members": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "AmazonSideAsn", + "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

", + "smithy.api#xmlName": "amazonSideAsn" + } + }, "VpnGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -57729,6 +59508,22 @@ "smithy.api#xmlName": "vpnGatewayId" } }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection the virtual private gateway supports.

", + "smithy.api#xmlName": "type" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", + "smithy.api#xmlName": "availabilityZone" + } + }, "State": { "target": "com.amazonaws.ec2#VpnState", "traits": { @@ -57737,14 +59532,6 @@ "smithy.api#xmlName": "state" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the virtual private gateway.

", - "smithy.api#xmlName": "tagSet" - } - }, "VpcAttachments": { "target": "com.amazonaws.ec2#VpcAttachmentList", "traits": { @@ -57753,28 +59540,12 @@ "smithy.api#xmlName": "attachments" } }, - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "AmazonSideAsn", - "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

", - "smithy.api#xmlName": "amazonSideAsn" - } - }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of VPN connection the virtual private gateway supports.

", - "smithy.api#xmlName": "type" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the virtual private gateway.

", + "smithy.api#xmlName": "tagSet" } } }, @@ -57835,12 +59606,12 @@ "com.amazonaws.ec2#VpnStaticRoute": { "type": "structure", "members": { - "Source": { - "target": "com.amazonaws.ec2#VpnStaticRouteSource", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Source", - "smithy.api#documentation": "

Indicates how the routes were provided.

", - "smithy.api#xmlName": "source" + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer data center.

", + "smithy.api#xmlName": "destinationCidrBlock" } }, "State": { @@ -57851,12 +59622,12 @@ "smithy.api#xmlName": "state" } }, - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "Source": { + "target": "com.amazonaws.ec2#VpnStaticRouteSource", "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The CIDR block associated with the local subnet of the customer data center.

", - "smithy.api#xmlName": "destinationCidrBlock" + "aws.protocols#ec2QueryName": "Source", + "smithy.api#documentation": "

Indicates how the routes were provided.

", + "smithy.api#xmlName": "source" } } }, @@ -57886,76 +59657,82 @@ "com.amazonaws.ec2#VpnTunnelOptionsSpecification": { "type": "structure", "members": { - "RekeyMarginTimeSeconds": { - "target": "com.amazonaws.ec2#Integer", + "StartupAction": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" } }, - "Phase2LifetimeSeconds": { - "target": "com.amazonaws.ec2#Integer", + "TunnelInsideIpv6Cidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

\n

Default: 3600\n

" + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" } }, - "Phase2IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", + "Phase2DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256\n

", - "smithy.api#xmlName": "Phase2IntegrityAlgorithm" + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24\n

", + "smithy.api#xmlName": "Phase2DHGroupNumber" } }, - "PreSharedKey": { - "target": "com.amazonaws.ec2#String", + "Phase2EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual private\n\t\t\tgateway and customer gateway.

\n\t\t

Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores\n (_). Must be between 8 and 64 characters in length and cannot start with zero\n (0).

" + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase2EncryptionAlgorithm" } }, - "Phase1IntegrityAlgorithms": { - "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "Phase1DHGroupNumbers": { + "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256\n

", - "smithy.api#xmlName": "Phase1IntegrityAlgorithm" + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24\n

", + "smithy.api#xmlName": "Phase1DHGroupNumber" } }, - "IKEVersions": { - "target": "com.amazonaws.ec2#IKEVersionsRequestList", + "ReplayWindowSize": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", - "smithy.api#xmlName": "IKEVersion" + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" } }, - "TunnelInsideCidr": { - "target": "com.amazonaws.ec2#String", + "DPDTimeoutSeconds": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique\n\t\t\tacross all VPN connections that use the same virtual private gateway.

\n\t\t

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n\t\t\tfollowing CIDR blocks are reserved and cannot be used:

\n\t\t " + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value between 0 and 30.

\n

Default: 30\n

" } }, - "Phase1DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", + "Phase2IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24\n

", - "smithy.api#xmlName": "Phase1DHGroupNumber" + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512\n

", + "smithy.api#xmlName": "Phase2IntegrityAlgorithm" } }, - "ReplayWindowSize": { + "RekeyMarginTimeSeconds": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" } }, - "Phase2EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", + "TunnelInsideCidr": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: AES128 | AES256\n

", - "smithy.api#xmlName": "Phase2EncryptionAlgorithm" + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique\n\t\t\tacross all VPN connections that use the same virtual private gateway.

\n\t\t

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n\t\t\tfollowing CIDR blocks are reserved and cannot be used:

\n\t\t " } }, - "Phase2DHGroupNumbers": { - "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", + "Phase1EncryptionAlgorithms": { + "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24\n

", - "smithy.api#xmlName": "Phase2DHGroupNumber" + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16\n

", + "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + } + }, + "Phase1IntegrityAlgorithms": { + "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", + "traits": { + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512\n

", + "smithy.api#xmlName": "Phase1IntegrityAlgorithm" } }, "RekeyFuzzPercentage": { @@ -57964,23 +59741,35 @@ "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" } }, - "Phase1LifetimeSeconds": { + "PreSharedKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual private\n\t\t\tgateway and customer gateway.

\n\t\t

Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores\n (_). Must be between 8 and 64 characters in length and cannot start with zero\n (0).

" + } + }, + "Phase2LifetimeSeconds": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

\n

Default: 3600\n

" } }, - "Phase1EncryptionAlgorithms": { - "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", + "DPDTimeoutAction": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

\n

Valid values: AES128 | AES256\n

", - "smithy.api#xmlName": "Phase1EncryptionAlgorithm" + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" } }, - "DPDTimeoutSeconds": { + "Phase1LifetimeSeconds": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value between 0 and 30.

\n

Default: 30\n

" + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + } + }, + "IKEVersions": { + "target": "com.amazonaws.ec2#IKEVersionsRequestList", + "traits": { + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#xmlName": "IKEVersion" } } }, diff --git a/codegen/sdk-codegen/aws-models/ecr.2015-09-21.json b/codegen/sdk-codegen/aws-models/ecr.2015-09-21.json index a44ad59a8130..a0e829d4e3e1 100644 --- a/codegen/sdk-codegen/aws-models/ecr.2015-09-21.json +++ b/codegen/sdk-codegen/aws-models/ecr.2015-09-21.json @@ -126,7 +126,7 @@ "sdkId": "ECR", "arnNamespace": "ecr", "cloudFormationName": "ECR", - "cloudTrailEventSource": "frontend.starport.amazonaws.com" + "cloudTrailEventSource": "ecr.amazonaws.com" }, "aws.auth#sigv4": { "name": "ecr" @@ -145,18 +145,18 @@ "com.amazonaws.ecr#Attribute": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.ecr#AttributeValue", - "traits": { - "smithy.api#documentation": "

The value assigned to the attribute key.

" - } - }, "key": { "target": "com.amazonaws.ecr#AttributeKey", "traits": { "smithy.api#documentation": "

The attribute key.

", "smithy.api#required": {} } + }, + "value": { + "target": "com.amazonaws.ecr#AttributeValue", + "traits": { + "smithy.api#documentation": "

The value assigned to the attribute key.

" + } } }, "traits": { @@ -196,10 +196,10 @@ "com.amazonaws.ecr#AuthorizationData": { "type": "structure", "members": { - "proxyEndpoint": { - "target": "com.amazonaws.ecr#ProxyEndpoint", + "authorizationToken": { + "target": "com.amazonaws.ecr#Base64", "traits": { - "smithy.api#documentation": "

The registry URL to use for this authorization token in a docker login\n command. The Amazon ECR registry URL format is\n https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,\n https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

" + "smithy.api#documentation": "

A base64-encoded string that contains authorization data for the specified Amazon ECR\n registry. When the string is decoded, it is presented in the format\n user:password for private registry authentication using docker\n login.

" } }, "expiresAt": { @@ -208,10 +208,10 @@ "smithy.api#documentation": "

The Unix time in seconds and milliseconds when the authorization token expires.\n Authorization tokens are valid for 12 hours.

" } }, - "authorizationToken": { - "target": "com.amazonaws.ecr#Base64", + "proxyEndpoint": { + "target": "com.amazonaws.ecr#ProxyEndpoint", "traits": { - "smithy.api#documentation": "

A base64-encoded string that contains authorization data for the specified Amazon ECR\n registry. When the string is decoded, it is presented in the format\n user:password for private registry authentication using docker\n login.

" + "smithy.api#documentation": "

The registry URL to use for this authorization token in a docker login\n command. The Amazon ECR registry URL format is\n https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,\n https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

" } } }, @@ -263,17 +263,17 @@ "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the image layers to\n check. If you do not specify a registry, the default registry is assumed.

" } }, - "layerDigests": { - "target": "com.amazonaws.ecr#BatchedOperationLayerDigestList", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The digests of the image layers to check.

", + "smithy.api#documentation": "

The name of the repository that is associated with the image layers to check.

", "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "layerDigests": { + "target": "com.amazonaws.ecr#BatchedOperationLayerDigestList", "traits": { - "smithy.api#documentation": "

The name of the repository that is associated with the image layers to check.

", + "smithy.api#documentation": "

The digests of the image layers to check.

", "smithy.api#required": {} } } @@ -322,17 +322,17 @@ "com.amazonaws.ecr#BatchDeleteImageRequest": { "type": "structure", "members": { - "imageIds": { - "target": "com.amazonaws.ecr#ImageIdentifierList", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

A list of image ID references that correspond to images to delete. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.

", + "smithy.api#documentation": "

The repository that contains the image to delete.

", "smithy.api#required": {} } }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", "traits": { - "smithy.api#documentation": "

The repository that contains the image to delete.

", + "smithy.api#documentation": "

A list of image ID references that correspond to images to delete. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.

", "smithy.api#required": {} } }, @@ -390,13 +390,6 @@ "com.amazonaws.ecr#BatchGetImageRequest": { "type": "structure", "members": { - "imageIds": { - "target": "com.amazonaws.ecr#ImageIdentifierList", - "traits": { - "smithy.api#documentation": "

A list of image ID references that correspond to images to describe. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.

", - "smithy.api#required": {} - } - }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { @@ -404,16 +397,23 @@ "smithy.api#required": {} } }, + "acceptedMediaTypes": { + "target": "com.amazonaws.ecr#MediaTypeList", + "traits": { + "smithy.api#documentation": "

The accepted media types for the request.

\n

Valid values: application/vnd.docker.distribution.manifest.v1+json |\n application/vnd.docker.distribution.manifest.v2+json |\n application/vnd.oci.image.manifest.v1+json\n

" + } + }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the images to describe.\n If you do not specify a registry, the default registry is assumed.

" } }, - "acceptedMediaTypes": { - "target": "com.amazonaws.ecr#MediaTypeList", + "imageIds": { + "target": "com.amazonaws.ecr#ImageIdentifierList", "traits": { - "smithy.api#documentation": "

The accepted media types for the request.

\n

Valid values: application/vnd.docker.distribution.manifest.v1+json |\n application/vnd.docker.distribution.manifest.v2+json |\n application/vnd.oci.image.manifest.v1+json\n

" + "smithy.api#documentation": "

A list of image ID references that correspond to images to describe. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.

", + "smithy.api#required": {} } } } @@ -500,19 +500,6 @@ "com.amazonaws.ecr#CompleteLayerUploadRequest": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", - "traits": { - "smithy.api#documentation": "

The name of the repository to associate with the image layer.

", - "smithy.api#required": {} - } - }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry to which to upload layers.\n If you do not specify a registry, the default registry is assumed.

" - } - }, "layerDigests": { "target": "com.amazonaws.ecr#LayerDigestList", "traits": { @@ -526,22 +513,35 @@ "smithy.api#documentation": "

The upload ID from a previous InitiateLayerUpload operation to\n associate with the image layer.

", "smithy.api#required": {} } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository to associate with the image layer.

", + "smithy.api#required": {} + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry to which to upload layers.\n If you do not specify a registry, the default registry is assumed.

" + } } } }, "com.amazonaws.ecr#CompleteLayerUploadResponse": { "type": "structure", "members": { - "uploadId": { - "target": "com.amazonaws.ecr#UploadId", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "

The upload ID associated with the layer.

" + "smithy.api#documentation": "

The registry ID associated with the request.

" } }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", "traits": { - "smithy.api#documentation": "

The repository name associated with the request.

" + "smithy.api#documentation": "

The upload ID associated with the layer.

" } }, "layerDigest": { @@ -550,10 +550,10 @@ "smithy.api#documentation": "

The sha256 digest of the image layer.

" } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The registry ID associated with the request.

" + "smithy.api#documentation": "

The repository name associated with the request.

" } } } @@ -596,35 +596,35 @@ "com.amazonaws.ecr#CreateRepositoryRequest": { "type": "structure", "members": { - "imageScanningConfiguration": { - "target": "com.amazonaws.ecr#ImageScanningConfiguration", + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { - "smithy.api#documentation": "

The image scanning configuration for the repository. This determines whether images\n are scanned for known vulnerabilities after being pushed to the repository.

" + "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" } }, - "tags": { - "target": "com.amazonaws.ecr#TagList", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the repository to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + "smithy.api#documentation": "

The name to use for the repository. The repository name may be specified on its own\n (such as nginx-web-app) or it can be prepended with a namespace to group\n the repository into a category (such as project-a/nginx-web-app).

", + "smithy.api#required": {} } }, - "encryptionConfiguration": { - "target": "com.amazonaws.ecr#EncryptionConfiguration", + "tags": { + "target": "com.amazonaws.ecr#TagList", "traits": { - "smithy.api#documentation": "

The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.

" + "smithy.api#documentation": "

The metadata that you apply to the repository to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" } }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "imageScanningConfiguration": { + "target": "com.amazonaws.ecr#ImageScanningConfiguration", "traits": { - "smithy.api#documentation": "

The name to use for the repository. The repository name may be specified on its own\n (such as nginx-web-app) or it can be prepended with a namespace to group\n the repository into a category (such as project-a/nginx-web-app).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The image scanning configuration for the repository. This determines whether images\n are scanned for known vulnerabilities after being pushed to the repository.

" } }, - "imageTagMutability": { - "target": "com.amazonaws.ecr#ImageTagMutability", + "encryptionConfiguration": { + "target": "com.amazonaws.ecr#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" + "smithy.api#documentation": "

The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.

" } } } @@ -690,16 +690,10 @@ "com.amazonaws.ecr#DeleteLifecyclePolicyResponse": { "type": "structure", "members": { - "lifecyclePolicyText": { - "target": "com.amazonaws.ecr#LifecyclePolicyText", - "traits": { - "smithy.api#documentation": "

The JSON lifecycle policy text.

" - } - }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "

The repository name associated with the request.

" + "smithy.api#documentation": "

The registry ID associated with the request.

" } }, "lastEvaluatedAt": { @@ -708,10 +702,16 @@ "smithy.api#documentation": "

The time stamp of the last time that the lifecycle policy was run.

" } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "lifecyclePolicyText": { + "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { - "smithy.api#documentation": "

The registry ID associated with the request.

" + "smithy.api#documentation": "

The JSON lifecycle policy text.

" + } + }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" } } } @@ -792,10 +792,10 @@ "com.amazonaws.ecr#DeleteRepositoryPolicyResponse": { "type": "structure", "members": { - "policyText": { - "target": "com.amazonaws.ecr#RepositoryPolicyText", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The JSON repository policy that was deleted from the repository.

" + "smithy.api#documentation": "

The repository name associated with the request.

" } }, "registryId": { @@ -804,10 +804,10 @@ "smithy.api#documentation": "

The registry ID associated with the request.

" } }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "policyText": { + "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { - "smithy.api#documentation": "

The repository name associated with the request.

" + "smithy.api#documentation": "

The JSON repository policy that was deleted from the repository.

" } } } @@ -815,12 +815,6 @@ "com.amazonaws.ecr#DeleteRepositoryRequest": { "type": "structure", "members": { - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository to\n delete. If you do not specify a registry, the default registry is assumed.

" - } - }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { @@ -833,6 +827,12 @@ "traits": { "smithy.api#documentation": "

If a repository contains images, forces the deletion.

" } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository to\n delete. If you do not specify a registry, the default registry is assumed.

" + } } } }, @@ -885,29 +885,29 @@ "com.amazonaws.ecr#DescribeImageScanFindingsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.ecr#MaxResults", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "

The maximum number of image scan results returned by\n DescribeImageScanFindings in paginated output. When this parameter is\n used, DescribeImageScanFindings only returns maxResults\n results in a single page along with a nextToken response element. The\n remaining results of the initial request can be seen by sending another\n DescribeImageScanFindings request with the returned\n nextToken value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribeImageScanFindings returns up to 100\n results and a nextToken value, if applicable.

" + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in\n which to describe the image scan findings for. If you do not specify a registry, the\n default registry is assumed.

" } }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { - "smithy.api#documentation": "

The repository for the image for which to describe the scan findings.

", "smithy.api#required": {} } }, - "imageId": { - "target": "com.amazonaws.ecr#ImageIdentifier", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { + "smithy.api#documentation": "

The repository for the image for which to describe the scan findings.

", "smithy.api#required": {} } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in\n which to describe the image scan findings for. If you do not specify a registry, the\n default registry is assumed.

" + "smithy.api#documentation": "

The maximum number of image scan results returned by\n DescribeImageScanFindings in paginated output. When this parameter is\n used, DescribeImageScanFindings only returns maxResults\n results in a single page along with a nextToken response element. The\n remaining results of the initial request can be seen by sending another\n DescribeImageScanFindings request with the returned\n nextToken value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribeImageScanFindings returns up to 100\n results and a nextToken value, if applicable.

" } }, "nextToken": { @@ -921,12 +921,24 @@ "com.amazonaws.ecr#DescribeImageScanFindingsResponse": { "type": "structure", "members": { + "imageScanFindings": { + "target": "com.amazonaws.ecr#ImageScanFindings", + "traits": { + "smithy.api#documentation": "

The information contained in the image scan findings.

" + } + }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "

The registry ID associated with the request.

" } }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeImageScanFindings request. When the results of a\n DescribeImageScanFindings request exceed maxResults, this\n value can be used to retrieve the next page of results. This value is null when there\n are no more results to return.

" + } + }, "imageScanStatus": { "target": "com.amazonaws.ecr#ImageScanStatus", "traits": { @@ -941,18 +953,6 @@ }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier" - }, - "imageScanFindings": { - "target": "com.amazonaws.ecr#ImageScanFindings", - "traits": { - "smithy.api#documentation": "

The information contained in the image scan findings.

" - } - }, - "nextToken": { - "target": "com.amazonaws.ecr#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeImageScanFindings request. When the results of a\n DescribeImageScanFindings request exceed maxResults, this\n value can be used to retrieve the next page of results. This value is null when there\n are no more results to return.

" - } } } }, @@ -1005,16 +1005,10 @@ "com.amazonaws.ecr#DescribeImagesRequest": { "type": "structure", "members": { - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in which\n to describe images. If you do not specify a registry, the default registry is assumed.

" - } - }, - "nextToken": { - "target": "com.amazonaws.ecr#NextToken", + "filter": { + "target": "com.amazonaws.ecr#DescribeImagesFilter", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return. This option cannot be\n used when you specify images with imageIds.

" + "smithy.api#documentation": "

The filter key and value with which to filter your DescribeImages\n results.

" } }, "maxResults": { @@ -1023,12 +1017,6 @@ "smithy.api#documentation": "

The maximum number of repository results returned by DescribeImages in\n paginated output. When this parameter is used, DescribeImages only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another DescribeImages request with the returned nextToken\n value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribeImages returns up to\n 100 results and a nextToken value, if applicable. This\n option cannot be used when you specify images with imageIds.

" } }, - "filter": { - "target": "com.amazonaws.ecr#DescribeImagesFilter", - "traits": { - "smithy.api#documentation": "

The filter key and value with which to filter your DescribeImages\n results.

" - } - }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { @@ -1036,6 +1024,18 @@ "smithy.api#required": {} } }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in which\n to describe images. If you do not specify a registry, the default registry is assumed.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return. This option cannot be\n used when you specify images with imageIds.

" + } + }, "imageIds": { "target": "com.amazonaws.ecr#ImageIdentifierList", "traits": { @@ -1093,6 +1093,12 @@ "com.amazonaws.ecr#DescribeRepositoriesRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.ecr#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of repository results returned by DescribeRepositories\n in paginated output. When this parameter is used, DescribeRepositories only\n returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial\n request can be seen by sending another DescribeRepositories request with\n the returned nextToken value. This value can be between 1\n and 1000. If this parameter is not used, then\n DescribeRepositories returns up to 100 results and a\n nextToken value, if applicable. This option cannot be used when you\n specify repositories with repositoryNames.

" + } + }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { @@ -1110,29 +1116,23 @@ "traits": { "smithy.api#documentation": "

A list of repositories to describe. If this parameter is omitted, then all\n repositories in a registry are described.

" } - }, - "maxResults": { - "target": "com.amazonaws.ecr#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of repository results returned by DescribeRepositories\n in paginated output. When this parameter is used, DescribeRepositories only\n returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial\n request can be seen by sending another DescribeRepositories request with\n the returned nextToken value. This value can be between 1\n and 1000. If this parameter is not used, then\n DescribeRepositories returns up to 100 results and a\n nextToken value, if applicable. This option cannot be used when you\n specify repositories with repositoryNames.

" - } } } }, "com.amazonaws.ecr#DescribeRepositoriesResponse": { "type": "structure", "members": { - "repositories": { - "target": "com.amazonaws.ecr#RepositoryList", - "traits": { - "smithy.api#documentation": "

A list of repository objects corresponding to valid repositories.

" - } - }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "

The nextToken value to include in a future\n DescribeRepositories request. When the results of a\n DescribeRepositories request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when\n there are no more results to return.

" } + }, + "repositories": { + "target": "com.amazonaws.ecr#RepositoryList", + "traits": { + "smithy.api#documentation": "

A list of repository objects corresponding to valid repositories.

" + } } } }, @@ -1154,18 +1154,18 @@ "com.amazonaws.ecr#EncryptionConfiguration": { "type": "structure", "members": { + "kmsKey": { + "target": "com.amazonaws.ecr#KmsKey", + "traits": { + "smithy.api#documentation": "

If you use the KMS encryption type, specify the CMK to use for\n encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must\n exist in the same Region as the repository. If no key is specified, the default AWS\n managed CMK for Amazon ECR will be used.

" + } + }, "encryptionType": { "target": "com.amazonaws.ecr#EncryptionType", "traits": { "smithy.api#documentation": "

The encryption type to use.

\n

If you use the KMS encryption type, the contents of the repository will\n be encrypted using server-side encryption with customer master keys (CMKs) stored in\n AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS\n managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more\n information, see Protecting Data Using Server-Side\n Encryption with CMKs Stored in AWS Key Management Service (SSE-KMS) in the\n Amazon Simple Storage Service Console Developer Guide..

\n

If you use the AES256 encryption type, Amazon ECR uses server-side encryption\n with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n AES-256 encryption algorithm. For more information, see Protecting Data Using\n Server-Side Encryption with Amazon S3-Managed Encryption Keys (SSE-S3) in\n the Amazon Simple Storage Service Console Developer Guide..

", "smithy.api#required": {} } - }, - "kmsKey": { - "target": "com.amazonaws.ecr#KmsKey", - "traits": { - "smithy.api#documentation": "

If you use the KMS encryption type, specify the CMK to use for\n encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must\n exist in the same Region as the repository. If no key is specified, the default AWS\n managed CMK for Amazon ECR will be used.

" - } } }, "traits": { @@ -1356,17 +1356,17 @@ "com.amazonaws.ecr#GetDownloadUrlForLayerResponse": { "type": "structure", "members": { - "layerDigest": { - "target": "com.amazonaws.ecr#LayerDigest", - "traits": { - "smithy.api#documentation": "

The digest of the image layer to download.

" - } - }, "downloadUrl": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "

The pre-signed Amazon S3 download URL for the requested layer.

" } + }, + "layerDigest": { + "target": "com.amazonaws.ecr#LayerDigest", + "traits": { + "smithy.api#documentation": "

The digest of the image layer to download.

" + } } } }, @@ -1431,11 +1431,16 @@ "com.amazonaws.ecr#GetLifecyclePolicyPreviewRequest": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", "traits": { - "smithy.api#documentation": "

The name of the repository.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\u2028\n GetLifecyclePolicyPreviewRequest request where maxResults\n was used and the\u2028 results exceeded the value of that parameter. Pagination continues\n from the end of the\u2028 previous results that returned the nextToken value.\n This value is\u2028 null when there are no more results to return. This option\n cannot be used when you specify images with imageIds.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" } }, "maxResults": { @@ -1444,6 +1449,13 @@ "smithy.api#documentation": "

The maximum number of repository results returned by\n GetLifecyclePolicyPreviewRequest in\u2028 paginated output. When this\n parameter is used, GetLifecyclePolicyPreviewRequest only returns\u2028\n maxResults results in a single page along with a\n nextToken\u2028 response element. The remaining results of the initial request\n can be seen by sending\u2028 another GetLifecyclePolicyPreviewRequest request\n with the returned nextToken\u2028 value. This value can be between\n 1 and 1000. If this\u2028 parameter is not used, then\n GetLifecyclePolicyPreviewRequest returns up to\u2028 100\n results and a nextToken value, if\u2028 applicable. This option cannot be used\n when you specify images with imageIds.

" } }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The name of the repository.

", + "smithy.api#required": {} + } + }, "filter": { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewFilter", "traits": { @@ -1455,34 +1467,16 @@ "traits": { "smithy.api#documentation": "

The list of imageIDs to be included.

" } - }, - "nextToken": { - "target": "com.amazonaws.ecr#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\u2028\n GetLifecyclePolicyPreviewRequest request where maxResults\n was used and the\u2028 results exceeded the value of that parameter. Pagination continues\n from the end of the\u2028 previous results that returned the nextToken value.\n This value is\u2028 null when there are no more results to return. This option\n cannot be used when you specify images with imageIds.

" - } - }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" - } } } }, "com.amazonaws.ecr#GetLifecyclePolicyPreviewResponse": { "type": "structure", "members": { - "previewResults": { - "target": "com.amazonaws.ecr#LifecyclePolicyPreviewResultList", - "traits": { - "smithy.api#documentation": "

The results of the lifecycle policy preview request.

" - } - }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "status": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewStatus", "traits": { - "smithy.api#documentation": "

The repository name associated with the request.

" + "smithy.api#documentation": "

The status of the lifecycle policy preview request.

" } }, "lifecyclePolicyText": { @@ -1503,10 +1497,16 @@ "smithy.api#documentation": "

The registry ID associated with the request.

" } }, - "status": { - "target": "com.amazonaws.ecr#LifecyclePolicyPreviewStatus", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The status of the lifecycle policy preview request.

" + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, + "previewResults": { + "target": "com.amazonaws.ecr#LifecyclePolicyPreviewResultList", + "traits": { + "smithy.api#documentation": "

The results of the lifecycle policy preview request.

" } }, "summary": { @@ -1538,22 +1538,16 @@ "com.amazonaws.ecr#GetLifecyclePolicyResponse": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", - "traits": { - "smithy.api#documentation": "

The repository name associated with the request.

" - } - }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "

The JSON lifecycle policy text.

" } }, - "lastEvaluatedAt": { - "target": "com.amazonaws.ecr#EvaluationTimestamp", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The time stamp of the last time that the lifecycle policy was run.

" + "smithy.api#documentation": "

The repository name associated with the request.

" } }, "registryId": { @@ -1561,6 +1555,12 @@ "traits": { "smithy.api#documentation": "

The registry ID associated with the request.

" } + }, + "lastEvaluatedAt": { + "target": "com.amazonaws.ecr#EvaluationTimestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the last time that the lifecycle policy was run.

" + } } } }, @@ -1634,34 +1634,34 @@ "com.amazonaws.ecr#Image": { "type": "structure", "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry containing the image.

" + } + }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "

The name of the repository associated with the image.

" } }, - "imageManifest": { - "target": "com.amazonaws.ecr#ImageManifest", + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { - "smithy.api#documentation": "

The image manifest associated with the image.

" + "smithy.api#documentation": "

An object containing the image tag and image digest associated with an image.

" } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "imageManifest": { + "target": "com.amazonaws.ecr#ImageManifest", "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry containing the image.

" + "smithy.api#documentation": "

The image manifest associated with the image.

" } }, "imageManifestMediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { - "smithy.api#documentation": "

The media type associated with the image manifest.

" - } - }, - "imageId": { - "target": "com.amazonaws.ecr#ImageIdentifier", - "traits": { - "smithy.api#documentation": "

An object containing the image tag and image digest associated with an image.

" + "smithy.api#documentation": "

The manifest media type of the image.

" } } }, @@ -1707,46 +1707,52 @@ "com.amazonaws.ecr#ImageDetail": { "type": "structure", "members": { - "imageTags": { - "target": "com.amazonaws.ecr#ImageTagList", + "imageSizeInBytes": { + "target": "com.amazonaws.ecr#ImageSizeInBytes", "traits": { - "smithy.api#documentation": "

The list of tags associated with this image.

" + "smithy.api#documentation": "

The size, in bytes, of the image in the repository.

\n

If the image is a manifest list, this will be the max size of all manifests in the\n list.

\n \n

Beginning with Docker version 1.9, the Docker client compresses image layers\n before pushing them to a V2 Docker registry. The output of the docker\n images command shows the uncompressed image size, so it may return a\n larger image size than the image sizes returned by DescribeImages.

\n " } }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "artifactMediaType": { + "target": "com.amazonaws.ecr#MediaType", "traits": { - "smithy.api#documentation": "

The name of the repository to which this image belongs.

" + "smithy.api#documentation": "

The artifact media type of the image.

" } }, - "imageScanStatus": { - "target": "com.amazonaws.ecr#ImageScanStatus", + "imagePushedAt": { + "target": "com.amazonaws.ecr#PushTimestamp", "traits": { - "smithy.api#documentation": "

The current state of the scan.

" + "smithy.api#documentation": "

The date and time, expressed in standard JavaScript date format, at which the current\n image was pushed to the repository.

" } }, - "imageDigest": { - "target": "com.amazonaws.ecr#ImageDigest", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry to which this image belongs.

" + } + }, + "imageManifestMediaType": { + "target": "com.amazonaws.ecr#MediaType", "traits": { - "smithy.api#documentation": "

The sha256 digest of the image manifest.

" + "smithy.api#documentation": "

The media type of the image manifest.

" } }, - "imageSizeInBytes": { - "target": "com.amazonaws.ecr#ImageSizeInBytes", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The size, in bytes, of the image in the repository.

\n

If the image is a manifest list, this will be the max size of all manifests in the\n list.

\n \n

Beginning with Docker version 1.9, the Docker client compresses image layers\n before pushing them to a V2 Docker registry. The output of the docker\n images command shows the uncompressed image size, so it may return a\n larger image size than the image sizes returned by DescribeImages.

\n " + "smithy.api#documentation": "

The name of the repository to which this image belongs.

" } }, - "imagePushedAt": { - "target": "com.amazonaws.ecr#PushTimestamp", + "imageScanStatus": { + "target": "com.amazonaws.ecr#ImageScanStatus", "traits": { - "smithy.api#documentation": "

The date and time, expressed in standard JavaScript date format, at which the current\n image was pushed to the repository.

" + "smithy.api#documentation": "

The current state of the scan.

" } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "imageTags": { + "target": "com.amazonaws.ecr#ImageTagList", "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry to which this image belongs.

" + "smithy.api#documentation": "

The list of tags associated with this image.

" } }, "imageScanFindingsSummary": { @@ -1754,6 +1760,12 @@ "traits": { "smithy.api#documentation": "

A summary of the last completed image scan.

" } + }, + "imageDigest": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image manifest.

" + } } }, "traits": { @@ -1784,10 +1796,10 @@ "com.amazonaws.ecr#ImageFailure": { "type": "structure", "members": { - "imageId": { - "target": "com.amazonaws.ecr#ImageIdentifier", + "failureCode": { + "target": "com.amazonaws.ecr#ImageFailureCode", "traits": { - "smithy.api#documentation": "

The image ID associated with the failure.

" + "smithy.api#documentation": "

The code associated with the failure.

" } }, "failureReason": { @@ -1796,10 +1808,10 @@ "smithy.api#documentation": "

The reason for the failure.

" } }, - "failureCode": { - "target": "com.amazonaws.ecr#ImageFailureCode", + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { - "smithy.api#documentation": "

The code associated with the failure.

" + "smithy.api#documentation": "

The image ID associated with the failure.

" } } }, @@ -1854,17 +1866,17 @@ "com.amazonaws.ecr#ImageIdentifier": { "type": "structure", "members": { - "imageTag": { - "target": "com.amazonaws.ecr#ImageTag", - "traits": { - "smithy.api#documentation": "

The tag used for the image.

" - } - }, "imageDigest": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "

The sha256 digest of the image manifest.

" } + }, + "imageTag": { + "target": "com.amazonaws.ecr#ImageTag", + "traits": { + "smithy.api#documentation": "

The tag used for the image.

" + } } }, "traits": { @@ -1913,16 +1925,16 @@ "com.amazonaws.ecr#ImageScanFinding": { "type": "structure", "members": { - "attributes": { - "target": "com.amazonaws.ecr#AttributeList", + "severity": { + "target": "com.amazonaws.ecr#FindingSeverity", "traits": { - "smithy.api#documentation": "

A collection of attributes of the host from which the finding is generated.

" + "smithy.api#documentation": "

The finding severity.

" } }, - "uri": { - "target": "com.amazonaws.ecr#Url", + "description": { + "target": "com.amazonaws.ecr#FindingDescription", "traits": { - "smithy.api#documentation": "

A link containing additional details about the security vulnerability.

" + "smithy.api#documentation": "

The description of the finding.

" } }, "name": { @@ -1931,16 +1943,16 @@ "smithy.api#documentation": "

The name associated with the finding, usually a CVE number.

" } }, - "severity": { - "target": "com.amazonaws.ecr#FindingSeverity", + "uri": { + "target": "com.amazonaws.ecr#Url", "traits": { - "smithy.api#documentation": "

The finding severity.

" + "smithy.api#documentation": "

A link containing additional details about the security vulnerability.

" } }, - "description": { - "target": "com.amazonaws.ecr#FindingDescription", + "attributes": { + "target": "com.amazonaws.ecr#AttributeList", "traits": { - "smithy.api#documentation": "

The description of the finding.

" + "smithy.api#documentation": "

A collection of attributes of the host from which the finding is generated.

" } } }, @@ -1957,28 +1969,28 @@ "com.amazonaws.ecr#ImageScanFindings": { "type": "structure", "members": { - "findingSeverityCounts": { - "target": "com.amazonaws.ecr#FindingSeverityCounts", - "traits": { - "smithy.api#documentation": "

The image vulnerability counts, sorted by severity.

" - } - }, "imageScanCompletedAt": { "target": "com.amazonaws.ecr#ScanTimestamp", "traits": { "smithy.api#documentation": "

The time of the last completed image scan.

" } }, + "findings": { + "target": "com.amazonaws.ecr#ImageScanFindingList", + "traits": { + "smithy.api#documentation": "

The findings from the image scan.

" + } + }, "vulnerabilitySourceUpdatedAt": { "target": "com.amazonaws.ecr#VulnerabilitySourceUpdateTimestamp", "traits": { "smithy.api#documentation": "

The time when the vulnerability data was last scanned.

" } }, - "findings": { - "target": "com.amazonaws.ecr#ImageScanFindingList", + "findingSeverityCounts": { + "target": "com.amazonaws.ecr#FindingSeverityCounts", "traits": { - "smithy.api#documentation": "

The findings from the image scan.

" + "smithy.api#documentation": "

The image vulnerability counts, sorted by severity.

" } } }, @@ -2015,17 +2027,17 @@ "com.amazonaws.ecr#ImageScanStatus": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.ecr#ScanStatus", - "traits": { - "smithy.api#documentation": "

The current state of an image scan.

" - } - }, "description": { "target": "com.amazonaws.ecr#ScanStatusDescription", "traits": { "smithy.api#documentation": "

The description of the image scan status.

" } + }, + "status": { + "target": "com.amazonaws.ecr#ScanStatus", + "traits": { + "smithy.api#documentation": "

The current state of an image scan.

" + } } }, "traits": { @@ -2141,17 +2153,17 @@ "com.amazonaws.ecr#InitiateLayerUploadResponse": { "type": "structure", "members": { - "partSize": { - "target": "com.amazonaws.ecr#PartSize", - "traits": { - "smithy.api#documentation": "

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

" - } - }, "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { "smithy.api#documentation": "

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload\n operations.

" } + }, + "partSize": { + "target": "com.amazonaws.ecr#PartSize", + "traits": { + "smithy.api#documentation": "

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

" + } } } }, @@ -2173,6 +2185,18 @@ "com.amazonaws.ecr#InvalidLayerPartException": { "type": "structure", "members": { + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the exception.

" + } + }, + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The error message associated with the exception.

" + } + }, "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { @@ -2190,18 +2214,6 @@ "traits": { "smithy.api#documentation": "

The last valid byte received from the layer part upload that is associated with the\n exception.

" } - }, - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", - "traits": { - "smithy.api#documentation": "

The repository name associated with the exception.

" - } - }, - "message": { - "target": "com.amazonaws.ecr#ExceptionMessage", - "traits": { - "smithy.api#documentation": "

The error message associated with the exception.

" - } } }, "traits": { @@ -2242,14 +2254,14 @@ "com.amazonaws.ecr#KmsException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ecr#ExceptionMessage" - }, "kmsError": { "target": "com.amazonaws.ecr#KmsError", "traits": { "smithy.api#documentation": "

The error code returned by AWS KMS.

" } + }, + "message": { + "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { @@ -2269,6 +2281,12 @@ "com.amazonaws.ecr#Layer": { "type": "structure", "members": { + "layerSize": { + "target": "com.amazonaws.ecr#LayerSizeInBytes", + "traits": { + "smithy.api#documentation": "

The size, in bytes, of the image layer.

" + } + }, "layerDigest": { "target": "com.amazonaws.ecr#LayerDigest", "traits": { @@ -2281,12 +2299,6 @@ "smithy.api#documentation": "

The availability status of the image layer.

" } }, - "layerSize": { - "target": "com.amazonaws.ecr#LayerSizeInBytes", - "traits": { - "smithy.api#documentation": "

The size, in bytes, of the image layer.

" - } - }, "mediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { @@ -2349,6 +2361,12 @@ "com.amazonaws.ecr#LayerFailure": { "type": "structure", "members": { + "failureCode": { + "target": "com.amazonaws.ecr#LayerFailureCode", + "traits": { + "smithy.api#documentation": "

The failure code associated with the failure.

" + } + }, "failureReason": { "target": "com.amazonaws.ecr#LayerFailureReason", "traits": { @@ -2360,12 +2378,6 @@ "traits": { "smithy.api#documentation": "

The layer digest associated with the failure.

" } - }, - "failureCode": { - "target": "com.amazonaws.ecr#LayerFailureCode", - "traits": { - "smithy.api#documentation": "

The failure code associated with the failure.

" - } } }, "traits": { @@ -2515,10 +2527,10 @@ "com.amazonaws.ecr#LifecyclePolicyPreviewResult": { "type": "structure", "members": { - "action": { - "target": "com.amazonaws.ecr#LifecyclePolicyRuleAction", + "imageTags": { + "target": "com.amazonaws.ecr#ImageTagList", "traits": { - "smithy.api#documentation": "

The type of action to be taken.

" + "smithy.api#documentation": "

The list of tags associated with this image.

" } }, "appliedRulePriority": { @@ -2527,16 +2539,10 @@ "smithy.api#documentation": "

The priority of the applied rule.

" } }, - "imageDigest": { - "target": "com.amazonaws.ecr#ImageDigest", - "traits": { - "smithy.api#documentation": "

The sha256 digest of the image manifest.

" - } - }, - "imageTags": { - "target": "com.amazonaws.ecr#ImageTagList", + "action": { + "target": "com.amazonaws.ecr#LifecyclePolicyRuleAction", "traits": { - "smithy.api#documentation": "

The list of tags associated with this image.

" + "smithy.api#documentation": "

The type of action to be taken.

" } }, "imagePushedAt": { @@ -2544,6 +2550,12 @@ "traits": { "smithy.api#documentation": "

The date and time, expressed in standard JavaScript date format, at which the current\n image was pushed to the repository.

" } + }, + "imageDigest": { + "target": "com.amazonaws.ecr#ImageDigest", + "traits": { + "smithy.api#documentation": "

The sha256 digest of the image manifest.

" + } } }, "traits": { @@ -2696,22 +2708,22 @@ "com.amazonaws.ecr#ListImagesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ecr#NextToken", - "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n 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 " - } - }, "maxResults": { "target": "com.amazonaws.ecr#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of image results returned by ListImages in paginated\n output. When this parameter is used, ListImages only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListImages request with the returned nextToken value.\n This value can be between 1 and 1000. If this parameter is\n not used, then ListImages returns up to 100 results and a\n nextToken value, if applicable.

" } }, - "filter": { - "target": "com.amazonaws.ecr#ListImagesFilter", + "nextToken": { + "target": "com.amazonaws.ecr#NextToken", "traits": { - "smithy.api#documentation": "

The filter key and value with which to filter your ListImages\n results.

" + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n 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 " + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in which\n to list images. If you do not specify a registry, the default registry is assumed.

" } }, "repositoryName": { @@ -2721,10 +2733,10 @@ "smithy.api#required": {} } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "filter": { + "target": "com.amazonaws.ecr#ListImagesFilter", "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in which\n to list images. If you do not specify a registry, the default registry is assumed.

" + "smithy.api#documentation": "

The filter key and value with which to filter your ListImages\n results.

" } } } @@ -2882,16 +2894,10 @@ "com.amazonaws.ecr#PutImageRequest": { "type": "structure", "members": { - "imageManifestMediaType": { - "target": "com.amazonaws.ecr#MediaType", - "traits": { - "smithy.api#documentation": "

The media type of the image manifest. If you push an image manifest that does not\n contain the mediaType field, you must specify the\n imageManifestMediaType in the request.

" - } - }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "imageDigest": { + "target": "com.amazonaws.ecr#ImageDigest", "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in which\n to put the image. If you do not specify a registry, the default registry is assumed.

" + "smithy.api#documentation": "

The image digest of the image manifest corresponding to the image.

" } }, "imageManifest": { @@ -2908,16 +2914,22 @@ "smithy.api#required": {} } }, - "imageTag": { - "target": "com.amazonaws.ecr#ImageTag", + "imageManifestMediaType": { + "target": "com.amazonaws.ecr#MediaType", "traits": { - "smithy.api#documentation": "

The tag to associate with the image. This parameter is required for images that use\n the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

" + "smithy.api#documentation": "

The media type of the image manifest. If you push an image manifest that does not\n contain the mediaType field, you must specify the\n imageManifestMediaType in the request.

" } }, - "imageDigest": { - "target": "com.amazonaws.ecr#ImageDigest", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "

The image digest of the image manifest corresponding to the image.

" + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in which\n to put the image. If you do not specify a registry, the default registry is assumed.

" + } + }, + "imageTag": { + "target": "com.amazonaws.ecr#ImageTag", + "traits": { + "smithy.api#documentation": "

The tag to associate with the image. This parameter is required for images that use\n the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

" } } } @@ -2959,17 +2971,17 @@ "com.amazonaws.ecr#PutImageScanningConfigurationRequest": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "imageScanningConfiguration": { + "target": "com.amazonaws.ecr#ImageScanningConfiguration", "traits": { - "smithy.api#documentation": "

The name of the repository in which to update the image scanning configuration\n setting.

", + "smithy.api#documentation": "

The image scanning configuration for the repository. This setting determines whether\n images are scanned for known vulnerabilities after being pushed to the\n repository.

", "smithy.api#required": {} } }, - "imageScanningConfiguration": { - "target": "com.amazonaws.ecr#ImageScanningConfiguration", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The image scanning configuration for the repository. This setting determines whether\n images are scanned for known vulnerabilities after being pushed to the\n repository.

", + "smithy.api#documentation": "

The name of the repository in which to update the image scanning configuration\n setting.

", "smithy.api#required": {} } }, @@ -3055,6 +3067,12 @@ "com.amazonaws.ecr#PutImageTagMutabilityResponse": { "type": "structure", "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { @@ -3066,12 +3084,6 @@ "traits": { "smithy.api#documentation": "

The repository name associated with the request.

" } - }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The registry ID associated with the request.

" - } } } }, @@ -3108,24 +3120,30 @@ "smithy.api#required": {} } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository. If you\n do\u2028 not specify a registry, the default registry is assumed.

" - } - }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "

The JSON repository policy text to apply to the repository.

", "smithy.api#required": {} } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository. If you\n do\u2028 not specify a registry, the default registry is assumed.

" + } } } }, "com.amazonaws.ecr#PutLifecyclePolicyResponse": { "type": "structure", "members": { + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { @@ -3137,12 +3155,6 @@ "traits": { "smithy.api#documentation": "

The JSON repository policy text.

" } - }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The registry ID associated with the request.

" - } } } }, @@ -3167,19 +3179,16 @@ "com.amazonaws.ecr#Repository": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.ecr#CreationTimestamp", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "

The date and time, in JavaScript date format, when the repository was created.

" + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.

" } }, - "imageScanningConfiguration": { - "target": "com.amazonaws.ecr#ImageScanningConfiguration" - }, - "repositoryUri": { - "target": "com.amazonaws.ecr#Url", + "repositoryArn": { + "target": "com.amazonaws.ecr#Arn", "traits": { - "smithy.api#documentation": "

The URI for the repository. You can use this URI for container image push\n and pull operations.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the\n repository, AWS account ID of the repository owner, repository namespace, and repository name.\n For example, arn:aws:ecr:region:012345678910:repository/test.

" } }, "encryptionConfiguration": { @@ -3188,16 +3197,22 @@ "smithy.api#documentation": "

The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.

" } }, - "repositoryArn": { - "target": "com.amazonaws.ecr#Arn", + "repositoryUri": { + "target": "com.amazonaws.ecr#Url", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the\n repository, AWS account ID of the repository owner, repository namespace, and repository name.\n For example, arn:aws:ecr:region:012345678910:repository/test.

" + "smithy.api#documentation": "

The URI for the repository. You can use this URI for container image push\n and pull operations.

" } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "createdAt": { + "target": "com.amazonaws.ecr#CreationTimestamp", "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.

" + "smithy.api#documentation": "

The date and time, in JavaScript date format, when the repository was created.

" + } + }, + "imageTagMutability": { + "target": "com.amazonaws.ecr#ImageTagMutability", + "traits": { + "smithy.api#documentation": "

The tag mutability setting for the repository.

" } }, "repositoryName": { @@ -3206,11 +3221,8 @@ "smithy.api#documentation": "

The name of the repository.

" } }, - "imageTagMutability": { - "target": "com.amazonaws.ecr#ImageTagMutability", - "traits": { - "smithy.api#documentation": "

The tag mutability setting for the repository.

" - } + "imageScanningConfiguration": { + "target": "com.amazonaws.ecr#ImageScanningConfiguration" } }, "traits": { @@ -3395,6 +3407,18 @@ "com.amazonaws.ecr#SetRepositoryPolicyRequest": { "type": "structure", "members": { + "force": { + "target": "com.amazonaws.ecr#ForceFlag", + "traits": { + "smithy.api#documentation": "

If the policy you are attempting to set on a repository policy would prevent you from\n setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental\n repository lock outs.

" + } + }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, "policyText": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { @@ -3402,34 +3426,22 @@ "smithy.api#required": {} } }, - "force": { - "target": "com.amazonaws.ecr#ForceFlag", - "traits": { - "smithy.api#documentation": "

If the policy you are attempting to set on a repository policy would prevent you from\n setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental\n repository lock outs.

" - } - }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "

The name of the repository to receive the policy.

", "smithy.api#required": {} } - }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" - } } } }, "com.amazonaws.ecr#SetRepositoryPolicyResponse": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "

The repository name associated with the request.

" + "smithy.api#documentation": "

The registry ID associated with the request.

" } }, "policyText": { @@ -3438,10 +3450,10 @@ "smithy.api#documentation": "

The JSON repository policy text applied to the repository.

" } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The registry ID associated with the request.

" + "smithy.api#documentation": "

The repository name associated with the request.

" } } } @@ -3490,18 +3502,18 @@ "com.amazonaws.ecr#StartImageScanRequest": { "type": "structure", "members": { - "imageId": { - "target": "com.amazonaws.ecr#ImageIdentifier", - "traits": { - "smithy.api#required": {} - } - }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository in\n which to start an image scan request. If you do not specify a registry, the default registry is assumed.

" } }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier", + "traits": { + "smithy.api#required": {} + } + }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { @@ -3514,9 +3526,6 @@ "com.amazonaws.ecr#StartImageScanResponse": { "type": "structure", "members": { - "imageId": { - "target": "com.amazonaws.ecr#ImageIdentifier" - }, "imageScanStatus": { "target": "com.amazonaws.ecr#ImageScanStatus", "traits": { @@ -3534,6 +3543,9 @@ "traits": { "smithy.api#documentation": "

The repository name associated with the request.

" } + }, + "imageId": { + "target": "com.amazonaws.ecr#ImageIdentifier" } } }, @@ -3569,12 +3581,6 @@ "com.amazonaws.ecr#StartLifecyclePolicyPreviewRequest": { "type": "structure", "members": { - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" - } - }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { @@ -3582,6 +3588,12 @@ "smithy.api#required": {} } }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The AWS account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.

" + } + }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { @@ -3593,18 +3605,18 @@ "com.amazonaws.ecr#StartLifecyclePolicyPreviewResponse": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", - "traits": { - "smithy.api#documentation": "

The repository name associated with the request.

" - } - }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "

The registry ID associated with the request.

" } }, + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", + "traits": { + "smithy.api#documentation": "

The repository name associated with the request.

" + } + }, "status": { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewStatus", "traits": { @@ -3622,17 +3634,17 @@ "com.amazonaws.ecr#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.ecr#TagKey", - "traits": { - "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.

" - } - }, "Value": { "target": "com.amazonaws.ecr#TagValue", "traits": { "smithy.api#documentation": "

The optional part of a key-value pair that make up a tag. A value acts as\n a descriptor within a tag category (key).

" } + }, + "Key": { + "target": "com.amazonaws.ecr#TagKey", + "traits": { + "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.

" + } } }, "traits": { @@ -3686,17 +3698,17 @@ "com.amazonaws.ecr#TagResourceRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.ecr#TagList", + "resourceArn": { + "target": "com.amazonaws.ecr#Arn", "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported\n resource is an Amazon ECR repository.

", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.ecr#Arn", + "tags": { + "target": "com.amazonaws.ecr#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported\n resource is an Amazon ECR repository.

", + "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

", "smithy.api#required": {} } } @@ -3784,17 +3796,17 @@ "com.amazonaws.ecr#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.ecr#TagKeyList", + "resourceArn": { + "target": "com.amazonaws.ecr#Arn", "traits": { - "smithy.api#documentation": "

The keys of the tags to be removed.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported\n resource is an Amazon ECR repository.

", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.ecr#Arn", + "tagKeys": { + "target": "com.amazonaws.ecr#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported\n resource is an Amazon ECR repository.

", + "smithy.api#documentation": "

The keys of the tags to be removed.

", "smithy.api#required": {} } } @@ -3848,44 +3860,44 @@ "com.amazonaws.ecr#UploadLayerPartRequest": { "type": "structure", "members": { - "repositoryName": { - "target": "com.amazonaws.ecr#RepositoryName", + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", "traits": { - "smithy.api#documentation": "

The name of the repository to which you are uploading layer parts.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The AWS account ID associated with the registry to which you are uploading layer\n parts. If you do not specify a registry, the default registry is assumed.

" } }, - "partFirstByte": { - "target": "com.amazonaws.ecr#PartSize", + "layerPartBlob": { + "target": "com.amazonaws.ecr#LayerPartBlob", "traits": { - "smithy.api#documentation": "

The position of the first byte of the layer part witin the overall image layer.

", + "smithy.api#documentation": "

The base64-encoded layer part payload.

", "smithy.api#required": {} } }, - "partLastByte": { - "target": "com.amazonaws.ecr#PartSize", + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", "traits": { - "smithy.api#documentation": "

The position of the last byte of the layer part within the overall image layer.

", + "smithy.api#documentation": "

The upload ID from a previous InitiateLayerUpload operation to\n associate with the layer part upload.

", "smithy.api#required": {} } }, - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", + "partFirstByte": { + "target": "com.amazonaws.ecr#PartSize", "traits": { - "smithy.api#documentation": "

The AWS account ID associated with the registry to which you are uploading layer\n parts. If you do not specify a registry, the default registry is assumed.

" + "smithy.api#documentation": "

The position of the first byte of the layer part witin the overall image layer.

", + "smithy.api#required": {} } }, - "uploadId": { - "target": "com.amazonaws.ecr#UploadId", + "repositoryName": { + "target": "com.amazonaws.ecr#RepositoryName", "traits": { - "smithy.api#documentation": "

The upload ID from a previous InitiateLayerUpload operation to\n associate with the layer part upload.

", + "smithy.api#documentation": "

The name of the repository to which you are uploading layer parts.

", "smithy.api#required": {} } }, - "layerPartBlob": { - "target": "com.amazonaws.ecr#LayerPartBlob", + "partLastByte": { + "target": "com.amazonaws.ecr#PartSize", "traits": { - "smithy.api#documentation": "

The base64-encoded layer part payload.

", + "smithy.api#documentation": "

The position of the last byte of the layer part within the overall image layer.

", "smithy.api#required": {} } } @@ -3894,29 +3906,29 @@ "com.amazonaws.ecr#UploadLayerPartResponse": { "type": "structure", "members": { - "registryId": { - "target": "com.amazonaws.ecr#RegistryId", - "traits": { - "smithy.api#documentation": "

The registry ID associated with the request.

" - } - }, - "uploadId": { - "target": "com.amazonaws.ecr#UploadId", - "traits": { - "smithy.api#documentation": "

The upload ID associated with the request.

" - } - }, "lastByteReceived": { "target": "com.amazonaws.ecr#PartSize", "traits": { "smithy.api#documentation": "

The integer value of the last byte received in the request.

" } }, + "registryId": { + "target": "com.amazonaws.ecr#RegistryId", + "traits": { + "smithy.api#documentation": "

The registry ID associated with the request.

" + } + }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "

The repository name associated with the request.

" } + }, + "uploadId": { + "target": "com.amazonaws.ecr#UploadId", + "traits": { + "smithy.api#documentation": "

The upload ID associated with the request.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json index 8e28124317b8..15e21eec52cd 100644 --- a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json +++ b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json @@ -229,7 +229,7 @@ "sdkId": "ECS", "arnNamespace": "ecs", "cloudFormationName": "ECS", - "cloudTrailEventSource": "frontend.madison.amazonaws.com" + "cloudTrailEventSource": "ecs.amazonaws.com" }, "aws.auth#sigv4": { "name": "ecs" @@ -260,28 +260,28 @@ "com.amazonaws.ecs#Attachment": { "type": "structure", "members": { - "id": { + "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The unique identifier for the attachment.

" + "smithy.api#documentation": "

The status of the attachment. Valid values are PRECREATED,\n CREATED, ATTACHING, ATTACHED,\n DETACHING, DETACHED, and DELETED.

" } }, - "details": { - "target": "com.amazonaws.ecs#AttachmentDetails", + "type": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Details of the attachment. For elastic network interfaces, this includes the network\n interface ID, the MAC address, the subnet ID, and the private IPv4 address.

" + "smithy.api#documentation": "

The type of the attachment, such as ElasticNetworkInterface.

" } }, - "status": { + "id": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the attachment. Valid values are PRECREATED,\n CREATED, ATTACHING, ATTACHED,\n DETACHING, DETACHED, and DELETED.

" + "smithy.api#documentation": "

The unique identifier for the attachment.

" } }, - "type": { - "target": "com.amazonaws.ecs#String", + "details": { + "target": "com.amazonaws.ecs#AttachmentDetails", "traits": { - "smithy.api#documentation": "

The type of the attachment, such as ElasticNetworkInterface.

" + "smithy.api#documentation": "

Details of the attachment. For elastic network interfaces, this includes the network\n interface ID, the MAC address, the subnet ID, and the private IPv4 address.

" } } }, @@ -298,17 +298,17 @@ "com.amazonaws.ecs#AttachmentStateChange": { "type": "structure", "members": { - "attachmentArn": { + "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the attachment.

", + "smithy.api#documentation": "

The status of the attachment.

", "smithy.api#required": {} } }, - "status": { + "attachmentArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the attachment.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the attachment.

", "smithy.api#required": {} } } @@ -332,16 +332,11 @@ "com.amazonaws.ecs#Attribute": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers,\n hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are\n allowed.

" - } - }, - "targetId": { + "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ID of the target. You can specify the short form ID for a resource or the full\n Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers,\n hyphens, underscores, and periods are allowed.

", + "smithy.api#required": {} } }, "targetType": { @@ -350,11 +345,16 @@ "smithy.api#documentation": "

The type of the target with which to attach the attribute. This parameter is required\n if you use the short form ID for a resource instead of the full ARN.

" } }, - "name": { + "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers,\n hyphens, underscores, and periods are allowed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers,\n hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are\n allowed.

" + } + }, + "targetId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The ID of the target. You can specify the short form ID for a resource or the full\n Amazon Resource Name (ARN).

" } } }, @@ -383,12 +383,6 @@ "com.amazonaws.ecs#AutoScalingGroupProvider": { "type": "structure", "members": { - "managedTerminationProtection": { - "target": "com.amazonaws.ecs#ManagedTerminationProtection", - "traits": { - "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n provider. This determines whether the Auto Scaling group has managed termination\n protection.

\n \n

When using managed termination protection, managed scaling must also be used\n otherwise managed termination protection will not work.

\n \n

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n an Auto Scaling group that contain tasks from being terminated during a scale-in action.\n The Auto Scaling group and each instance in the Auto Scaling group must have instance\n protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.

\n

When managed termination protection is disabled, your Amazon EC2 instances are not\n protected from termination when the Auto Scaling group scales in.

" - } - }, "managedScaling": { "target": "com.amazonaws.ecs#ManagedScaling", "traits": { @@ -401,6 +395,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the Auto Scaling group.

", "smithy.api#required": {} } + }, + "managedTerminationProtection": { + "target": "com.amazonaws.ecs#ManagedTerminationProtection", + "traits": { + "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n provider. This determines whether the Auto Scaling group has managed termination\n protection.

\n \n

When using managed termination protection, managed scaling must also be used\n otherwise managed termination protection will not work.

\n \n

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n an Auto Scaling group that contain tasks from being terminated during a scale-in action.\n The Auto Scaling group and each instance in the Auto Scaling group must have instance\n protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.

\n

When managed termination protection is disabled, your Amazon EC2 instances are not\n protected from termination when the Auto Scaling group scales in.

" + } } }, "traits": { @@ -464,10 +464,16 @@ "com.amazonaws.ecs#CapacityProvider": { "type": "structure", "members": { - "autoScalingGroupProvider": { - "target": "com.amazonaws.ecs#AutoScalingGroupProvider", + "status": { + "target": "com.amazonaws.ecs#CapacityProviderStatus", "traits": { - "smithy.api#documentation": "

The Auto Scaling group settings for the capacity provider.

" + "smithy.api#documentation": "

The current status of the capacity provider. Only capacity providers in an\n ACTIVE state can be used in a cluster. When a capacity provider is\n successfully deleted, it will have an INACTIVE status.

" + } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n organize it. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n " } }, "name": { @@ -482,28 +488,22 @@ "smithy.api#documentation": "

The update status of the capacity provider. The following are the possible states that\n will be returned.

\n
\n
DELETE_IN_PROGRESS
\n
\n

The capacity provider is in the process of being deleted.

\n
\n
DELETE_COMPLETE
\n
\n

The capacity provider has been successfully deleted and will have an\n INACTIVE status.

\n
\n
DELETE_FAILED
\n
\n

The capacity provider was unable to be deleted. The update status reason\n will provide further details about why the delete failed.

\n
\n
" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n organize it. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n " - } - }, - "updateStatusReason": { + "capacityProviderArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The update status reason. This provides further details about the update status for\n the capacity provider.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the capacity provider.

" } }, - "status": { - "target": "com.amazonaws.ecs#CapacityProviderStatus", + "autoScalingGroupProvider": { + "target": "com.amazonaws.ecs#AutoScalingGroupProvider", "traits": { - "smithy.api#documentation": "

The current status of the capacity provider. Only capacity providers in an\n ACTIVE state can be used in a cluster. When a capacity provider is\n successfully deleted, it will have an INACTIVE status.

" + "smithy.api#documentation": "

The Auto Scaling group settings for the capacity provider.

" } }, - "capacityProviderArn": { + "updateStatusReason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the capacity provider.

" + "smithy.api#documentation": "

The update status reason. This provides further details about the update status for\n the capacity provider.

" } } }, @@ -552,10 +552,10 @@ "com.amazonaws.ecs#CapacityProviderStrategyItem": { "type": "structure", "members": { - "weight": { - "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", + "base": { + "target": "com.amazonaws.ecs#CapacityProviderStrategyItemBase", "traits": { - "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n number of tasks launched that should use the specified capacity provider.

\n

For example, if you have a strategy that contains two capacity providers and both have\n a weight of 1, then when the base is satisfied, the tasks will\n be split evenly across the two capacity providers. Using that same logic, if you specify\n a weight of 1 for capacityProviderA and a weight of\n 4 for capacityProviderB, then for every one task\n that is run using capacityProviderA, four tasks would use\n capacityProviderB.

" + "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on\n the specified capacity provider. Only one capacity provider in a capacity provider\n strategy can have a base defined.

" } }, "capacityProvider": { @@ -565,10 +565,10 @@ "smithy.api#required": {} } }, - "base": { - "target": "com.amazonaws.ecs#CapacityProviderStrategyItemBase", + "weight": { + "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", "traits": { - "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on\n the specified capacity provider. Only one capacity provider in a capacity provider\n strategy can have a base defined.

" + "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n number of tasks launched that should use the specified capacity provider.

\n

For example, if you have a strategy that contains two capacity providers and both have\n a weight of 1, then when the base is satisfied, the tasks will\n be split evenly across the two capacity providers. Using that same logic, if you specify\n a weight of 1 for capacityProviderA and a weight of\n 4 for capacityProviderB, then for every one task\n that is run using capacityProviderA, four tasks would use\n capacityProviderB.

" } } }, @@ -634,22 +634,10 @@ "com.amazonaws.ecs#Cluster": { "type": "structure", "members": { - "attachmentsStatus": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The status of the capacity providers associated with the cluster. The following are\n the states that will be returned:

\n
\n
UPDATE_IN_PROGRESS
\n
\n

The available capacity providers for the cluster are updating. This occurs\n when the Auto Scaling plan is provisioning or deprovisioning.

\n
\n
UPDATE_COMPLETE
\n
\n

The capacity providers have successfully updated.

\n
\n
UPDATE_FAILED
\n
\n

The capacity provider updates failed.

\n
\n
" - } - }, - "defaultCapacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "

The default capacity provider strategy for the cluster. When services or tasks are run\n in the cluster with no launch type or capacity provider strategy specified, the default\n capacity provider strategy is used.

" - } - }, - "pendingTasksCount": { + "activeServicesCount": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The number of tasks in the cluster that are in the PENDING state.

" + "smithy.api#documentation": "

The number of services that are running on the cluster in an ACTIVE\n state. You can view these services with ListServices.

" } }, "settings": { @@ -658,10 +646,16 @@ "smithy.api#documentation": "

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n is enabled or disabled for a cluster.

" } }, - "attachments": { - "target": "com.amazonaws.ecs#Attachments", + "registeredContainerInstancesCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The resources attached to a cluster. When using a capacity provider with a cluster,\n the Auto Scaling plan that is created will be returned as a cluster attachment.

" + "smithy.api#documentation": "

The number of container instances registered into the cluster. This includes container\n instances in both ACTIVE and DRAINING status.

" + } + }, + "defaultCapacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "

The default capacity provider strategy for the cluster. When services or tasks are run\n in the cluster with no launch type or capacity provider strategy specified, the default\n capacity provider strategy is used.

" } }, "runningTasksCount": { @@ -670,16 +664,16 @@ "smithy.api#documentation": "

The number of tasks in the cluster that are in the RUNNING state.

" } }, - "statistics": { - "target": "com.amazonaws.ecs#Statistics", + "attachments": { + "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "

Additional information about your clusters that are separated by launch type,\n including:

\n " + "smithy.api#documentation": "

The resources attached to a cluster. When using a capacity provider with a cluster,\n the Auto Scaling plan that is created will be returned as a cluster attachment.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "pendingTasksCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The number of tasks in the cluster that are in the PENDING state.

" } }, "status": { @@ -688,34 +682,40 @@ "smithy.api#documentation": "

The status of the cluster. The following are the possible states that will be\n returned.

\n
\n
ACTIVE
\n
\n

The cluster is ready to accept tasks and if applicable you can register\n container instances with the cluster.

\n
\n
PROVISIONING
\n
\n

The cluster has capacity providers associated with it and the resources\n needed for the capacity provider are being created.

\n
\n
DEPROVISIONING
\n
\n

The cluster has capacity providers associated with it and the resources\n needed for the capacity provider are being deleted.

\n
\n
FAILED
\n
\n

The cluster has capacity providers associated with it and the resources\n needed for the capacity provider have failed to create.

\n
\n
INACTIVE
\n
\n

The cluster has been deleted. Clusters with an INACTIVE\n status may remain discoverable in your account for a period of time.\n However, this behavior is subject to change in the future, so you should not\n rely on INACTIVE clusters persisting.

\n
\n
" } }, + "statistics": { + "target": "com.amazonaws.ecs#Statistics", + "traits": { + "smithy.api#documentation": "

Additional information about your clusters that are separated by launch type,\n including:

\n " + } + }, "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

" } }, - "capacityProviders": { - "target": "com.amazonaws.ecs#StringList", + "clusterName": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The capacity providers associated with the cluster.

" + "smithy.api#documentation": "

A user-generated string that you use to identify your cluster.

" } }, - "activeServicesCount": { - "target": "com.amazonaws.ecs#Integer", + "attachmentsStatus": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of services that are running on the cluster in an ACTIVE\n state. You can view these services with ListServices.

" + "smithy.api#documentation": "

The status of the capacity providers associated with the cluster. The following are\n the states that will be returned:

\n
\n
UPDATE_IN_PROGRESS
\n
\n

The available capacity providers for the cluster are updating. This occurs\n when the Auto Scaling plan is provisioning or deprovisioning.

\n
\n
UPDATE_COMPLETE
\n
\n

The capacity providers have successfully updated.

\n
\n
UPDATE_FAILED
\n
\n

The capacity provider updates failed.

\n
\n
" } }, - "clusterName": { - "target": "com.amazonaws.ecs#String", + "capacityProviders": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A user-generated string that you use to identify your cluster.

" + "smithy.api#documentation": "

The capacity providers associated with the cluster.

" } }, - "registeredContainerInstancesCount": { - "target": "com.amazonaws.ecs#Integer", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The number of container instances registered into the cluster. This includes container\n instances in both ACTIVE and DRAINING status.

" + "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } } }, @@ -803,17 +803,17 @@ "com.amazonaws.ecs#ClusterSetting": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.ecs#ClusterSettingName", - "traits": { - "smithy.api#documentation": "

The name of the cluster setting. The only supported value is\n containerInsights.

" - } - }, "value": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The value to set for the cluster setting. The supported values are\n enabled and disabled. If enabled is\n specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be\n disabled unless the containerInsights account setting is enabled. If a\n cluster value is specified, it will override the containerInsights value\n set with PutAccountSetting or PutAccountSettingDefault.

" } + }, + "name": { + "target": "com.amazonaws.ecs#ClusterSettingName", + "traits": { + "smithy.api#documentation": "

The name of the cluster setting. The only supported value is\n containerInsights.

" + } } }, "traits": { @@ -882,28 +882,22 @@ "com.amazonaws.ecs#Container": { "type": "structure", "members": { - "reason": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about\n a running or stopped container.

" - } - }, - "name": { + "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the container.

" + "smithy.api#documentation": "

The number of CPU units set for the container. The value will be 0 if no\n value was specified in the container definition when the task definition was\n registered.

" } }, - "exitCode": { - "target": "com.amazonaws.ecs#BoxedInteger", + "networkBindings": { + "target": "com.amazonaws.ecs#NetworkBindings", "traits": { - "smithy.api#documentation": "

The exit code returned from the container.

" + "smithy.api#documentation": "

The network bindings associated with the container.

" } }, - "runtimeId": { - "target": "com.amazonaws.ecs#String", + "gpuIds": { + "target": "com.amazonaws.ecs#GpuIds", "traits": { - "smithy.api#documentation": "

The ID of the Docker container.

" + "smithy.api#documentation": "

The IDs of each GPU assigned to the container.

" } }, "memoryReservation": { @@ -912,46 +906,40 @@ "smithy.api#documentation": "

The soft limit (in MiB) of memory set for the container.

" } }, - "networkBindings": { - "target": "com.amazonaws.ecs#NetworkBindings", - "traits": { - "smithy.api#documentation": "

The network bindings associated with the container.

" - } - }, - "taskArn": { + "image": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the task.

" + "smithy.api#documentation": "

The image used for the container.

" } }, - "image": { + "imageDigest": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The image used for the container.

" + "smithy.api#documentation": "

The container image manifest digest.

\n \n

The imageDigest is only returned if the container is using an image\n hosted in Amazon ECR, otherwise it is omitted.

\n " } }, - "networkInterfaces": { - "target": "com.amazonaws.ecs#NetworkInterfaces", + "reason": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The network interfaces associated with the container.

" + "smithy.api#documentation": "

A short (255 max characters) human-readable string to provide additional details about\n a running or stopped container.

" } }, - "gpuIds": { - "target": "com.amazonaws.ecs#GpuIds", + "healthStatus": { + "target": "com.amazonaws.ecs#HealthStatus", "traits": { - "smithy.api#documentation": "

The IDs of each GPU assigned to the container.

" + "smithy.api#documentation": "

The health status of the container. If health checks are not configured for this\n container in its task definition, then it reports the health status as\n UNKNOWN.

" } }, - "imageDigest": { + "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container image manifest digest.

\n \n

The imageDigest is only returned if the container is using an image\n hosted in Amazon ECR, otherwise it is omitted.

\n " + "smithy.api#documentation": "

The ID of the Docker container.

" } }, - "lastStatus": { + "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The last known status of the container.

" + "smithy.api#documentation": "

The name of the container.

" } }, "containerArn": { @@ -960,16 +948,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container.

" } }, - "healthStatus": { - "target": "com.amazonaws.ecs#HealthStatus", - "traits": { - "smithy.api#documentation": "

The health status of the container. If health checks are not configured for this\n container in its task definition, then it reports the health status as\n UNKNOWN.

" - } - }, - "cpu": { + "taskArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of CPU units set for the container. The value will be 0 if no\n value was specified in the container definition when the task definition was\n registered.

" + "smithy.api#documentation": "

The ARN of the task.

" } }, "memory": { @@ -977,8 +959,26 @@ "traits": { "smithy.api#documentation": "

The hard limit (in MiB) of memory set for the container.

" } - } - }, + }, + "networkInterfaces": { + "target": "com.amazonaws.ecs#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "

The network interfaces associated with the container.

" + } + }, + "lastStatus": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The last known status of the container.

" + } + }, + "exitCode": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The exit code returned from the container.

" + } + } + }, "traits": { "smithy.api#documentation": "

A Docker container that is part of a task.

" } @@ -1009,88 +1009,100 @@ "com.amazonaws.ecs#ContainerDefinition": { "type": "structure", "members": { - "image": { - "target": "com.amazonaws.ecs#String", + "pseudoTerminal": { + "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker\n daemon. Images in the Docker Hub registry are available by default. Other repositories\n are specified with either \n repository-url/image:tag\n or \n repository-url/image@digest\n . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the\n Create a container section of the Docker Remote API and the\n IMAGE parameter of docker\n run.

\n " + "smithy.api#documentation": "

When this parameter is true, a TTY is allocated. This parameter maps to\n Tty in the Create a container section of the\n Docker Remote API and the --tty option to docker run.

" } }, - "command": { - "target": "com.amazonaws.ecs#StringList", + "ulimits": { + "target": "com.amazonaws.ecs#UlimitList", "traits": { - "smithy.api#documentation": "

The command that is passed to the container. This parameter maps to Cmd\n in the Create a container section of the Docker Remote API and the\n COMMAND parameter to docker\n run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each\n argument should be a separated string in the array.

" + "smithy.api#documentation": "

A list of ulimits to set in the container. If a ulimit value is specified\n in a task definition, it will override the default values set by Docker. This parameter\n maps to Ulimits in the Create a container section of the\n Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed\n in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

\n \n

This parameter is not supported for Windows containers.

\n " } }, - "dockerLabels": { - "target": "com.amazonaws.ecs#DockerLabelsMap", + "healthCheck": { + "target": "com.amazonaws.ecs#HealthCheck", "traits": { - "smithy.api#documentation": "

A key/value map of labels to add to the container. This parameter maps to\n Labels in the Create a container section of the\n Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

" + "smithy.api#documentation": "

The container health check command and associated configuration parameters for the\n container. This parameter maps to HealthCheck in the\n Create a container section of the Docker Remote API and the\n HEALTHCHECK parameter of docker\n run.

" } }, - "essential": { + "disableNetworking": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If the essential parameter of a container is marked as true,\n and that container fails or stops for any reason, all other containers that are part of\n the task are stopped. If the essential parameter of a container is marked\n as false, then its failure does not affect the rest of the containers in a\n task. If this parameter is omitted, a container is assumed to be essential.

\n

All tasks must have at least one essential container. If you have an application that\n is composed of multiple containers, you should group containers that are used for a\n common purpose into components, and separate the different components into multiple task\n definitions. For more information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

When this parameter is true, networking is disabled within the container. This\n parameter maps to NetworkDisabled in the Create a container\n section of the Docker Remote API.

\n \n

This parameter is not supported for Windows containers.

\n " } }, - "linuxParameters": { - "target": "com.amazonaws.ecs#LinuxParameters", + "extraHosts": { + "target": "com.amazonaws.ecs#HostEntryList", "traits": { - "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as Linux kernel\n capabilities. For more information see KernelCapabilities.

\n \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts\n file on the container. This parameter maps to ExtraHosts in the\n Create a container section of the Docker Remote API and the\n --add-host option to docker\n run.

\n \n

This parameter is not supported for Windows containers or tasks that use the\n awsvpc network mode.

\n " } }, - "repositoryCredentials": { - "target": "com.amazonaws.ecs#RepositoryCredentials", + "user": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The private repository authentication credentials to use.

" + "smithy.api#documentation": "

The user name to use inside the container. This parameter maps to User in\n the Create a container section of the Docker Remote API and the\n --user option to docker\n run.

\n

You can use the following formats. If specifying a UID or GID, you must specify it as\n a positive integer.

\n \n \n

This parameter is not supported for Windows containers.

\n " } }, - "systemControls": { - "target": "com.amazonaws.ecs#SystemControls", + "dockerSecurityOptions": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n Sysctls in the Create a container section of the\n Docker Remote API and the --sysctl option to docker run.

\n \n

It is not recommended that you specify network-related systemControls\n parameters for multiple containers in a single task that also uses either the\n awsvpc or host network modes. For tasks that use the\n awsvpc network mode, the container that is started last determines\n which systemControls parameters take effect. For tasks that use the\n host network mode, it changes the container instance's namespaced\n kernel parameters as well as the containers.

\n " + "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level\n security systems. This field is not valid for containers in tasks using the\n Fargate launch type.

\n

With Windows containers, this parameter can be used to reference a credential spec\n file when configuring a container for Active Directory authentication. For more\n information, see Using gMSAs for Windows\n Containers in the Amazon Elastic Container Service Developer Guide.

\n

This parameter maps to SecurityOpt in the\n Create a container section of the Docker Remote API and the\n --security-opt option to docker\n run.

\n \n

The Amazon ECS container agent running on a container instance must register with the\n ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n environment variables before containers placed on that instance can use these\n security options. For more information, see Amazon ECS Container\n Agent Configuration in the Amazon Elastic Container Service Developer Guide.

\n " } }, - "logConfiguration": { - "target": "com.amazonaws.ecs#LogConfiguration", + "links": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the\n Create a container section of the Docker Remote API and the\n --log-driver option to docker\n run. By default, containers use the same logging driver that the Docker\n daemon uses. However the container may use a different logging driver than the Docker\n daemon by specifying a log driver with this parameter in the container definition. To\n use a different logging driver for a container, the log system must be configured\n properly on the container instance (or on a different log server for remote logging\n options). For more information on the options for different supported log drivers, see\n Configure\n logging drivers in the Docker documentation.

\n \n

Amazon ECS currently supports a subset of the logging drivers available to the Docker\n daemon (shown in the LogConfiguration data type). Additional log\n drivers may be available in future releases of the Amazon ECS container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

\n \n

The Amazon ECS container agent running on a container instance must register the\n logging drivers available on that instance with the\n ECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n containers placed on that instance can use these log configuration options. For more\n information, see Amazon ECS Container\n Agent Configuration in the Amazon Elastic Container Service Developer Guide.

\n " + "smithy.api#documentation": "

The links parameter allows containers to communicate with each other\n without the need for port mappings. This parameter is only supported if the network mode\n of a task definition is bridge. The name:internalName\n construct is analogous to name:alias in Docker links.\n Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to\n Legacy container links\n in the Docker documentation. This parameter maps to Links in the\n Create a container section of the Docker Remote API and the\n --link option to docker\n run.

\n \n

This parameter is not supported for Windows containers.

\n \n \n

Containers that are collocated on a single container instance may be able to\n communicate with each other without requiring links or host port mappings. Network\n isolation is achieved on the container instance using security groups and VPC\n settings.

\n " } }, - "dockerSecurityOptions": { - "target": "com.amazonaws.ecs#StringList", + "volumesFrom": { + "target": "com.amazonaws.ecs#VolumeFromList", "traits": { - "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level\n security systems. This field is not valid for containers in tasks using the\n Fargate launch type.

\n

With Windows containers, this parameter can be used to reference a credential spec\n file when configuring a container for Active Directory authentication. For more\n information, see Using gMSAs for Windows\n Containers in the Amazon Elastic Container Service Developer Guide.

\n

This parameter maps to SecurityOpt in the\n Create a container section of the Docker Remote API and the\n --security-opt option to docker\n run.

\n \n

The Amazon ECS container agent running on a container instance must register with the\n ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n environment variables before containers placed on that instance can use these\n security options. For more information, see Amazon ECS Container\n Agent Configuration in the Amazon Elastic Container Service Developer Guide.

\n " + "smithy.api#documentation": "

Data volumes to mount from another container. This parameter maps to\n VolumesFrom in the Create a container section of the\n Docker Remote API and the --volumes-from option to docker run.

" } }, - "dependsOn": { - "target": "com.amazonaws.ecs#ContainerDependencies", + "name": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The dependencies defined for container startup and shutdown. A container can contain\n multiple dependencies. When a dependency is defined for container startup, for container\n shutdown it is reversed.

\n

For tasks using the EC2 launch type, the container instances require at\n least version 1.26.0 of the container agent to enable container dependencies. However,\n we recommend using the latest container agent version. For information about checking\n your agent version and updating to the latest version, see Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init package. If your container instances are launched from version\n 20190301 or later, then they contain the required versions of the\n container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n

For tasks using the Fargate launch type, the task or service requires\n platform version 1.3.0 or later.

" + "smithy.api#documentation": "

The name of a container. If you are linking multiple containers together in a task\n definition, the name of one container can be entered in the\n links of another container to connect the containers.\n Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to name in the\n Create a container section of the Docker Remote API and the\n --name option to docker\n run.

" } }, - "environmentFiles": { - "target": "com.amazonaws.ecs#EnvironmentFiles", + "memory": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. This\n parameter maps to the --env-file option to docker run.

\n

You can specify up to ten environment files. The file must have a .env\n file extension. Each line in an environment file should contain an environment variable\n in VARIABLE=VALUE format. Lines beginning with # are treated\n as comments and are ignored. For more information on the environment variable file\n syntax, see Declare default\n environment variables in file.

\n

If there are environment variables specified using the environment\n parameter in a container definition, they take precedence over the variables contained\n within an environment file. If multiple environment files are specified that contain the\n same variable, they are processed from the top down. It is recommended to use unique\n variable names. For more information, see Specifying Environment\n Variables in the Amazon Elastic Container Service Developer Guide.

\n

This field is not valid for containers in tasks using the Fargate launch\n type.

" + "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n to exceed the memory specified here, the container is killed. The total amount of memory\n reserved for all containers within a task must be lower than the task\n memory value, if one is specified. This parameter maps to\n Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.

\n

If using the Fargate launch type, this parameter is optional.

\n

If using the EC2 launch type, you must specify either a task-level\n memory value or a container-level memory value. If you specify both a container-level\n memory and memoryReservation value, memory\n must be greater than memoryReservation. If you specify\n memoryReservation, then that value is subtracted from the available\n memory resources for the container instance on which the container is placed. Otherwise,\n the value of memory is used.

\n

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n not specify fewer than 4 MiB of memory for your containers.

" } }, - "cpu": { - "target": "com.amazonaws.ecs#Integer", + "linuxParameters": { + "target": "com.amazonaws.ecs#LinuxParameters", "traits": { - "smithy.api#documentation": "

The number of cpu units reserved for the container. This parameter maps\n to CpuShares in the Create a container section of the\n Docker Remote API and the --cpu-shares option to docker run.

\n

This field is optional for tasks using the Fargate launch type, and the\n only requirement is that the total amount of CPU reserved for all containers within a\n task be lower than the task-level cpu value.

\n \n

You can determine the number of CPU units that are available per EC2 instance type\n by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n by 1,024.

\n \n

Linux containers share unallocated CPU units with other containers on the container\n instance with the same ratio as their allocated amount. For example, if you run a\n single-container task on a single-core instance type with 512 CPU units specified for\n that container, and that is the only task running on the container instance, that\n container could use the full 1,024 CPU unit share at any given time. However, if you\n launched another copy of the same task on that container instance, each task would be\n guaranteed a minimum of 512 CPU units when needed, and each container could float to\n higher CPU usage if the other container was not using it, but if both tasks were 100%\n active all of the time, they would be limited to 512 CPU units.

\n

On Linux container instances, the Docker daemon on the container instance uses the CPU\n value to calculate the relative CPU share ratios for running containers. For more\n information, see CPU share\n constraint in the Docker documentation. The minimum valid CPU share value\n that the Linux kernel allows is 2. However, the CPU parameter is not required, and you\n can use CPU values below 2 in your container definitions. For CPU values below 2\n (including null), the behavior varies based on your Amazon ECS container agent\n version:

\n \n

On Windows container instances, the CPU limit is enforced as an absolute limit, or a\n quota. Windows containers only have access to the specified amount of CPU that is\n described in the task definition.

" + "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as Linux kernel\n capabilities. For more information see KernelCapabilities.

\n \n

This parameter is not supported for Windows containers.

\n " } }, - "healthCheck": { - "target": "com.amazonaws.ecs#HealthCheck", + "dnsSearchDomains": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The container health check command and associated configuration parameters for the\n container. This parameter maps to HealthCheck in the\n Create a container section of the Docker Remote API and the\n HEALTHCHECK parameter of docker\n run.

" + "smithy.api#documentation": "

A list of DNS search domains that are presented to the container. This parameter maps\n to DnsSearch in the Create a container section of the\n Docker Remote API and the --dns-search option to docker run.

\n \n

This parameter is not supported for Windows containers.

\n " } }, - "readonlyRootFilesystem": { + "essential": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the\n Create a container section of the Docker Remote API and the\n --read-only option to docker\n run.

\n \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

If the essential parameter of a container is marked as true,\n and that container fails or stops for any reason, all other containers that are part of\n the task are stopped. If the essential parameter of a container is marked\n as false, then its failure does not affect the rest of the containers in a\n task. If this parameter is omitted, a container is assumed to be essential.

\n

All tasks must have at least one essential container. If you have an application that\n is composed of multiple containers, you should group containers that are used for a\n common purpose into components, and separate the different components into multiple task\n definitions. For more information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "systemControls": { + "target": "com.amazonaws.ecs#SystemControls", + "traits": { + "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n Sysctls in the Create a container section of the\n Docker Remote API and the --sysctl option to docker run.

\n \n

It is not recommended that you specify network-related systemControls\n parameters for multiple containers in a single task that also uses either the\n awsvpc or host network modes. For tasks that use the\n awsvpc network mode, the container that is started last determines\n which systemControls parameters take effect. For tasks that use the\n host network mode, it changes the container instance's namespaced\n kernel parameters as well as the containers.

\n " + } + }, + "environmentFiles": { + "target": "com.amazonaws.ecs#EnvironmentFiles", + "traits": { + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. This\n parameter maps to the --env-file option to docker run.

\n

You can specify up to ten environment files. The file must have a .env\n file extension. Each line in an environment file should contain an environment variable\n in VARIABLE=VALUE format. Lines beginning with # are treated\n as comments and are ignored. For more information on the environment variable file\n syntax, see Declare default\n environment variables in file.

\n

If there are environment variables specified using the environment\n parameter in a container definition, they take precedence over the variables contained\n within an environment file. If multiple environment files are specified that contain the\n same variable, they are processed from the top down. It is recommended to use unique\n variable names. For more information, see Specifying Environment\n Variables in the Amazon Elastic Container Service Developer Guide.

\n

This field is not valid for containers in tasks using the Fargate launch\n type.

" } }, "environment": { @@ -1099,16 +1111,16 @@ "smithy.api#documentation": "

The environment variables to pass to a container. This parameter maps to\n Env in the Create a container section of the\n Docker Remote API and the --env option to docker run.

\n \n

We do not recommend using plaintext environment variables for sensitive\n information, such as credential data.

\n " } }, - "privileged": { + "readonlyRootFilesystem": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host\n container instance (similar to the root user). This parameter maps to\n Privileged in the Create a container section of the\n Docker Remote API and the --privileged option to docker run.

\n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " + "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the\n Create a container section of the Docker Remote API and the\n --read-only option to docker\n run.

\n \n

This parameter is not supported for Windows containers.

\n " } }, - "user": { + "workingDirectory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The user name to use inside the container. This parameter maps to User in\n the Create a container section of the Docker Remote API and the\n --user option to docker\n run.

\n

You can use the following formats. If specifying a UID or GID, you must specify it as\n a positive integer.

\n \n \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

The working directory in which to run commands inside the container. This parameter\n maps to WorkingDir in the Create a container section of the\n Docker Remote API and the --workdir option to docker run.

" } }, "secrets": { @@ -1117,52 +1129,52 @@ "smithy.api#documentation": "

The secrets to pass to the container. For more information, see Specifying\n Sensitive Data in the Amazon Elastic Container Service Developer Guide.

" } }, - "mountPoints": { - "target": "com.amazonaws.ecs#MountPointList", + "command": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The mount points for data volumes in your container.

\n

This parameter maps to Volumes in the Create a container\n section of the Docker Remote API and the --volume option to docker run.

\n

Windows containers can mount whole directories on the same drive as\n $env:ProgramData. Windows containers cannot mount directories on a\n different drive, and mount point cannot be across drives.

" + "smithy.api#documentation": "

The command that is passed to the container. This parameter maps to Cmd\n in the Create a container section of the Docker Remote API and the\n COMMAND parameter to docker\n run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each\n argument should be a separated string in the array.

" } }, - "name": { - "target": "com.amazonaws.ecs#String", + "dnsServers": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The name of a container. If you are linking multiple containers together in a task\n definition, the name of one container can be entered in the\n links of another container to connect the containers.\n Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to name in the\n Create a container section of the Docker Remote API and the\n --name option to docker\n run.

" + "smithy.api#documentation": "

A list of DNS servers that are presented to the container. This parameter maps to\n Dns in the Create a container section of the\n Docker Remote API and the --dns option to docker run.

\n \n

This parameter is not supported for Windows containers.

\n " } }, - "volumesFrom": { - "target": "com.amazonaws.ecs#VolumeFromList", + "resourceRequirements": { + "target": "com.amazonaws.ecs#ResourceRequirements", "traits": { - "smithy.api#documentation": "

Data volumes to mount from another container. This parameter maps to\n VolumesFrom in the Create a container section of the\n Docker Remote API and the --volumes-from option to docker run.

" + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The only supported\n resource is a GPU.

" } }, - "workingDirectory": { - "target": "com.amazonaws.ecs#String", + "privileged": { + "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

The working directory in which to run commands inside the container. This parameter\n maps to WorkingDir in the Create a container section of the\n Docker Remote API and the --workdir option to docker run.

" + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host\n container instance (similar to the root user). This parameter maps to\n Privileged in the Create a container section of the\n Docker Remote API and the --privileged option to docker run.

\n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " } }, - "memoryReservation": { - "target": "com.amazonaws.ecs#BoxedInteger", + "cpu": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is\n under heavy contention, Docker attempts to keep the container memory to this soft limit.\n However, your container can consume more memory when it needs to, up to either the hard\n limit specified with the memory parameter (if applicable), or all of the\n available memory on the container instance, whichever comes first. This parameter maps\n to MemoryReservation in the Create a container section of\n the Docker Remote API and the --memory-reservation option to docker run.

\n

If a task-level memory value is not specified, you must specify a non-zero integer for\n one or both of memory or memoryReservation in a container\n definition. If you specify both, memory must be greater than\n memoryReservation. If you specify memoryReservation, then\n that value is subtracted from the available memory resources for the container instance\n on which the container is placed. Otherwise, the value of memory is\n used.

\n

For example, if your container normally uses 128 MiB of memory, but occasionally\n bursts to 256 MiB of memory for short periods of time, you can set a\n memoryReservation of 128 MiB, and a memory hard limit of\n 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n from the remaining resources on the container instance, but also allow the container to\n consume more memory resources when needed.

\n

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n not specify fewer than 4 MiB of memory for your containers.

" + "smithy.api#documentation": "

The number of cpu units reserved for the container. This parameter maps\n to CpuShares in the Create a container section of the\n Docker Remote API and the --cpu-shares option to docker run.

\n

This field is optional for tasks using the Fargate launch type, and the\n only requirement is that the total amount of CPU reserved for all containers within a\n task be lower than the task-level cpu value.

\n \n

You can determine the number of CPU units that are available per EC2 instance type\n by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n by 1,024.

\n \n

Linux containers share unallocated CPU units with other containers on the container\n instance with the same ratio as their allocated amount. For example, if you run a\n single-container task on a single-core instance type with 512 CPU units specified for\n that container, and that is the only task running on the container instance, that\n container could use the full 1,024 CPU unit share at any given time. However, if you\n launched another copy of the same task on that container instance, each task would be\n guaranteed a minimum of 512 CPU units when needed, and each container could float to\n higher CPU usage if the other container was not using it, but if both tasks were 100%\n active all of the time, they would be limited to 512 CPU units.

\n

On Linux container instances, the Docker daemon on the container instance uses the CPU\n value to calculate the relative CPU share ratios for running containers. For more\n information, see CPU share\n constraint in the Docker documentation. The minimum valid CPU share value\n that the Linux kernel allows is 2. However, the CPU parameter is not required, and you\n can use CPU values below 2 in your container definitions. For CPU values below 2\n (including null), the behavior varies based on your Amazon ECS container agent\n version:

\n \n

On Windows container instances, the CPU limit is enforced as an absolute limit, or a\n quota. Windows containers only have access to the specified amount of CPU that is\n described in the task definition.

" } }, - "dnsSearchDomains": { - "target": "com.amazonaws.ecs#StringList", + "stopTimeout": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

A list of DNS search domains that are presented to the container. This parameter maps\n to DnsSearch in the Create a container section of the\n Docker Remote API and the --dns-search option to docker run.

\n \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n doesn't exit normally on its own.

\n

For tasks using the Fargate launch type, the task or service requires\n platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the\n parameter is not specified, the default value of 30 seconds is used.

\n

For tasks using the EC2 launch type, if the stopTimeout\n parameter is not specified, the value set for the Amazon ECS container agent configuration\n variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the\n stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n agent configuration variable are set, then the default values of 30 seconds for Linux\n containers and 30 seconds on Windows containers are used. Your container instances\n require at least version 1.26.0 of the container agent to enable a container stop\n timeout value. However, we recommend using the latest container agent version. For\n information about checking your agent version and updating to the latest version, see\n Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init package. If your container instances are launched from version\n 20190301 or later, then they contain the required versions of the\n container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, - "portMappings": { - "target": "com.amazonaws.ecs#PortMappingList", + "dependsOn": { + "target": "com.amazonaws.ecs#ContainerDependencies", "traits": { - "smithy.api#documentation": "

The list of port mappings for the container. Port mappings allow containers to access\n ports on the host container instance to send or receive traffic.

\n

For task definitions that use the awsvpc network mode, you should only\n specify the containerPort. The hostPort can be left blank or\n it must be the same value as the containerPort.

\n

Port mappings on Windows use the NetNAT gateway address rather than\n localhost. There is no loopback for port mappings on Windows, so you\n cannot access a container's mapped port from the host itself.

\n

This parameter maps to PortBindings in the\n Create a container section of the Docker Remote API and the\n --publish option to docker\n run. If the network mode of a task definition is set to none,\n then you can't specify port mappings. If the network mode of a task definition is set to\n host, then host ports must either be undefined or they must match the\n container port in the port mapping.

\n \n

After a task reaches the RUNNING status, manual and automatic host\n and container port assignments are visible in the Network\n Bindings section of a container description for a selected task in\n the Amazon ECS console. The assignments are also visible in the\n networkBindings section DescribeTasks\n responses.

\n " + "smithy.api#documentation": "

The dependencies defined for container startup and shutdown. A container can contain\n multiple dependencies. When a dependency is defined for container startup, for container\n shutdown it is reversed.

\n

For tasks using the EC2 launch type, the container instances require at\n least version 1.26.0 of the container agent to enable container dependencies. However,\n we recommend using the latest container agent version. For information about checking\n your agent version and updating to the latest version, see Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init package. If your container instances are launched from version\n 20190301 or later, then they contain the required versions of the\n container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n

For tasks using the Fargate launch type, the task or service requires\n platform version 1.3.0 or later.

" } }, - "memory": { - "target": "com.amazonaws.ecs#BoxedInteger", + "mountPoints": { + "target": "com.amazonaws.ecs#MountPointList", "traits": { - "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n to exceed the memory specified here, the container is killed. The total amount of memory\n reserved for all containers within a task must be lower than the task\n memory value, if one is specified. This parameter maps to\n Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.

\n

If using the Fargate launch type, this parameter is optional.

\n

If using the EC2 launch type, you must specify either a task-level\n memory value or a container-level memory value. If you specify both a container-level\n memory and memoryReservation value, memory\n must be greater than memoryReservation. If you specify\n memoryReservation, then that value is subtracted from the available\n memory resources for the container instance on which the container is placed. Otherwise,\n the value of memory is used.

\n

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n not specify fewer than 4 MiB of memory for your containers.

" + "smithy.api#documentation": "

The mount points for data volumes in your container.

\n

This parameter maps to Volumes in the Create a container\n section of the Docker Remote API and the --volume option to docker run.

\n

Windows containers can mount whole directories on the same drive as\n $env:ProgramData. Windows containers cannot mount directories on a\n different drive, and mount point cannot be across drives.

" } }, "entryPoint": { @@ -1171,34 +1183,28 @@ "smithy.api#documentation": "\n

Early versions of the Amazon ECS container agent do not properly handle\n entryPoint parameters. If you have problems using\n entryPoint, update your container agent or enter your commands and\n arguments as command array items instead.

\n \n

The entry point that is passed to the container. This parameter maps to\n Entrypoint in the Create a container section of the\n Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

" } }, - "interactive": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "

When this parameter is true, this allows you to deploy containerized\n applications that require stdin or a tty to be allocated. This\n parameter maps to OpenStdin in the Create a container\n section of the Docker Remote API and the --interactive option to docker run.

" - } - }, - "disableNetworking": { - "target": "com.amazonaws.ecs#BoxedBoolean", + "dockerLabels": { + "target": "com.amazonaws.ecs#DockerLabelsMap", "traits": { - "smithy.api#documentation": "

When this parameter is true, networking is disabled within the container. This\n parameter maps to NetworkDisabled in the Create a container\n section of the Docker Remote API.

\n \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

A key/value map of labels to add to the container. This parameter maps to\n Labels in the Create a container section of the\n Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

" } }, - "extraHosts": { - "target": "com.amazonaws.ecs#HostEntryList", + "repositoryCredentials": { + "target": "com.amazonaws.ecs#RepositoryCredentials", "traits": { - "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts\n file on the container. This parameter maps to ExtraHosts in the\n Create a container section of the Docker Remote API and the\n --add-host option to docker\n run.

\n \n

This parameter is not supported for Windows containers or tasks that use the\n awsvpc network mode.

\n " + "smithy.api#documentation": "

The private repository authentication credentials to use.

" } }, - "ulimits": { - "target": "com.amazonaws.ecs#UlimitList", + "portMappings": { + "target": "com.amazonaws.ecs#PortMappingList", "traits": { - "smithy.api#documentation": "

A list of ulimits to set in the container. If a ulimit value is specified\n in a task definition, it will override the default values set by Docker. This parameter\n maps to Ulimits in the Create a container section of the\n Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed\n in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

\n \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

The list of port mappings for the container. Port mappings allow containers to access\n ports on the host container instance to send or receive traffic.

\n

For task definitions that use the awsvpc network mode, you should only\n specify the containerPort. The hostPort can be left blank or\n it must be the same value as the containerPort.

\n

Port mappings on Windows use the NetNAT gateway address rather than\n localhost. There is no loopback for port mappings on Windows, so you\n cannot access a container's mapped port from the host itself.

\n

This parameter maps to PortBindings in the\n Create a container section of the Docker Remote API and the\n --publish option to docker\n run. If the network mode of a task definition is set to none,\n then you can't specify port mappings. If the network mode of a task definition is set to\n host, then host ports must either be undefined or they must match the\n container port in the port mapping.

\n \n

After a task reaches the RUNNING status, manual and automatic host\n and container port assignments are visible in the Network\n Bindings section of a container description for a selected task in\n the Amazon ECS console. The assignments are also visible in the\n networkBindings section DescribeTasks\n responses.

\n " } }, - "pseudoTerminal": { + "interactive": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, a TTY is allocated. This parameter maps to\n Tty in the Create a container section of the\n Docker Remote API and the --tty option to docker run.

" + "smithy.api#documentation": "

When this parameter is true, this allows you to deploy containerized\n applications that require stdin or a tty to be allocated. This\n parameter maps to OpenStdin in the Create a container\n section of the Docker Remote API and the --interactive option to docker run.

" } }, "startTimeout": { @@ -1213,34 +1219,28 @@ "smithy.api#documentation": "

The hostname to use for your container. This parameter maps to Hostname\n in the Create a container section of the Docker Remote API and the\n --hostname option to docker\n run.

\n \n

The hostname parameter is not supported if you are using the\n awsvpc network mode.

\n " } }, - "resourceRequirements": { - "target": "com.amazonaws.ecs#ResourceRequirements", - "traits": { - "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The only supported\n resource is a GPU.

" - } - }, - "firelensConfiguration": { - "target": "com.amazonaws.ecs#FirelensConfiguration", + "logConfiguration": { + "target": "com.amazonaws.ecs#LogConfiguration", "traits": { - "smithy.api#documentation": "

The FireLens configuration for the container. This is used to specify and configure a\n log router for container logs. For more information, see Custom Log Routing\n in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the\n Create a container section of the Docker Remote API and the\n --log-driver option to docker\n run. By default, containers use the same logging driver that the Docker\n daemon uses. However the container may use a different logging driver than the Docker\n daemon by specifying a log driver with this parameter in the container definition. To\n use a different logging driver for a container, the log system must be configured\n properly on the container instance (or on a different log server for remote logging\n options). For more information on the options for different supported log drivers, see\n Configure\n logging drivers in the Docker documentation.

\n \n

Amazon ECS currently supports a subset of the logging drivers available to the Docker\n daemon (shown in the LogConfiguration data type). Additional log\n drivers may be available in future releases of the Amazon ECS container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

\n \n

The Amazon ECS container agent running on a container instance must register the\n logging drivers available on that instance with the\n ECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n containers placed on that instance can use these log configuration options. For more\n information, see Amazon ECS Container\n Agent Configuration in the Amazon Elastic Container Service Developer Guide.

\n " } }, - "dnsServers": { - "target": "com.amazonaws.ecs#StringList", + "image": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

A list of DNS servers that are presented to the container. This parameter maps to\n Dns in the Create a container section of the\n Docker Remote API and the --dns option to docker run.

\n \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker\n daemon. Images in the Docker Hub registry are available by default. Other repositories\n are specified with either \n repository-url/image:tag\n or \n repository-url/image@digest\n . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the\n Create a container section of the Docker Remote API and the\n IMAGE parameter of docker\n run.

\n " } }, - "links": { - "target": "com.amazonaws.ecs#StringList", + "firelensConfiguration": { + "target": "com.amazonaws.ecs#FirelensConfiguration", "traits": { - "smithy.api#documentation": "

The links parameter allows containers to communicate with each other\n without the need for port mappings. This parameter is only supported if the network mode\n of a task definition is bridge. The name:internalName\n construct is analogous to name:alias in Docker links.\n Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to\n Legacy container links\n in the Docker documentation. This parameter maps to Links in the\n Create a container section of the Docker Remote API and the\n --link option to docker\n run.

\n \n

This parameter is not supported for Windows containers.

\n \n \n

Containers that are collocated on a single container instance may be able to\n communicate with each other without requiring links or host port mappings. Network\n isolation is achieved on the container instance using security groups and VPC\n settings.

\n " + "smithy.api#documentation": "

The FireLens configuration for the container. This is used to specify and configure a\n log router for container logs. For more information, see Custom Log Routing\n in the Amazon Elastic Container Service Developer Guide.

" } }, - "stopTimeout": { + "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n doesn't exit normally on its own.

\n

For tasks using the Fargate launch type, the task or service requires\n platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the\n parameter is not specified, the default value of 30 seconds is used.

\n

For tasks using the EC2 launch type, if the stopTimeout\n parameter is not specified, the value set for the Amazon ECS container agent configuration\n variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the\n stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n agent configuration variable are set, then the default values of 30 seconds for Linux\n containers and 30 seconds on Windows containers are used. Your container instances\n require at least version 1.26.0 of the container agent to enable a container stop\n timeout value. However, we recommend using the latest container agent version. For\n information about checking your agent version and updating to the latest version, see\n Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init package. If your container instances are launched from version\n 20190301 or later, then they contain the required versions of the\n container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is\n under heavy contention, Docker attempts to keep the container memory to this soft limit.\n However, your container can consume more memory when it needs to, up to either the hard\n limit specified with the memory parameter (if applicable), or all of the\n available memory on the container instance, whichever comes first. This parameter maps\n to MemoryReservation in the Create a container section of\n the Docker Remote API and the --memory-reservation option to docker run.

\n

If a task-level memory value is not specified, you must specify a non-zero integer for\n one or both of memory or memoryReservation in a container\n definition. If you specify both, memory must be greater than\n memoryReservation. If you specify memoryReservation, then\n that value is subtracted from the available memory resources for the container instance\n on which the container is placed. Otherwise, the value of memory is\n used.

\n

For example, if your container normally uses 128 MiB of memory, but occasionally\n bursts to 256 MiB of memory for short periods of time, you can set a\n memoryReservation of 128 MiB, and a memory hard limit of\n 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n from the remaining resources on the container instance, but also allow the container to\n consume more memory resources when needed.

\n

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n not specify fewer than 4 MiB of memory for your containers.

" } } }, @@ -1285,40 +1285,16 @@ "com.amazonaws.ecs#ContainerInstance": { "type": "structure", "members": { - "agentUpdateStatus": { - "target": "com.amazonaws.ecs#AgentUpdateStatus", - "traits": { - "smithy.api#documentation": "

The status of the most recent agent update. If an update has never been requested,\n this value is NULL.

" - } - }, - "registeredAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container instance was registered.

" - } - }, - "attachments": { - "target": "com.amazonaws.ecs#Attachments", - "traits": { - "smithy.api#documentation": "

The resources attached to a container instance, such as elastic network\n interfaces.

" - } - }, - "versionInfo": { - "target": "com.amazonaws.ecs#VersionInfo", - "traits": { - "smithy.api#documentation": "

The version information for the Amazon ECS container agent and Docker daemon running on the\n container instance.

" - } - }, - "agentConnected": { - "target": "com.amazonaws.ecs#Boolean", + "status": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

This parameter returns true if the agent is connected to Amazon ECS.\n Registered instances with an agent that may be unhealthy or stopped return\n false. Only instances connected to an agent can accept placement\n requests.

" + "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n REGISTRATION_FAILED, ACTIVE, INACTIVE,\n DEREGISTERING, or DRAINING.

\n

If your account has opted in to the awsvpcTrunking account setting, then\n any newly registered container instance will transition to a REGISTERING\n status while the trunk elastic network interface is provisioned for the instance. If the\n registration fails, the instance will transition to a REGISTRATION_FAILED\n status. You can describe the container instance and see the reason for failure in the\n statusReason parameter. Once the container instance is terminated, the\n instance transitions to a DEREGISTERING status while the trunk elastic\n network interface is deprovisioned. The instance then transitions to an\n INACTIVE status.

\n

The ACTIVE status indicates that the container instance can accept tasks.\n The DRAINING indicates that new tasks are not placed on the container\n instance and any service tasks running on the container instance are removed if\n possible. For more information, see Container Instance Draining in the\n Amazon Elastic Container Service Developer Guide.

" } }, - "runningTasksCount": { - "target": "com.amazonaws.ecs#Integer", + "remainingResources": { + "target": "com.amazonaws.ecs#Resources", "traits": { - "smithy.api#documentation": "

The number of tasks on the container instance that are in the RUNNING\n status.

" + "smithy.api#documentation": "

For CPU and memory resource types, this parameter describes the remaining CPU and\n memory that has not already been allocated to tasks and is therefore available for new\n tasks. For port resource types, this parameter describes the ports that were reserved by\n the Amazon ECS container agent (at instance registration time) and any task containers that\n have reserved port mappings on the host (with the host or\n bridge network mode). Any port that is not specified here is available\n for new tasks.

" } }, "tags": { @@ -1327,12 +1303,6 @@ "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n " } }, - "ec2InstanceId": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The EC2 instance ID of the container instance.

" - } - }, "capacityProviderName": { "target": "com.amazonaws.ecs#String", "traits": { @@ -1351,16 +1321,34 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" } }, + "attachments": { + "target": "com.amazonaws.ecs#Attachments", + "traits": { + "smithy.api#documentation": "

The resources attached to a container instance, such as elastic network\n interfaces.

" + } + }, + "agentUpdateStatus": { + "target": "com.amazonaws.ecs#AgentUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the most recent agent update. If an update has never been requested,\n this value is NULL.

" + } + }, "pendingTasksCount": { "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#documentation": "

The number of tasks on the container instance that are in the PENDING\n status.

" } }, - "attributes": { - "target": "com.amazonaws.ecs#Attributes", + "ec2InstanceId": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The attributes set for the container instance, either by the Amazon ECS container agent at\n instance registration or manually with the PutAttributes\n operation.

" + "smithy.api#documentation": "

The EC2 instance ID of the container instance.

" + } + }, + "runningTasksCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#documentation": "

The number of tasks on the container instance that are in the RUNNING\n status.

" } }, "registeredResources": { @@ -1369,10 +1357,16 @@ "smithy.api#documentation": "

For CPU and memory resource types, this parameter describes the amount of each\n resource that was available on the container instance when the container agent\n registered it with Amazon ECS. This value represents the total amount of CPU and memory that\n can be allocated on this container instance to tasks. For port resource types, this\n parameter describes the ports that were reserved by the Amazon ECS container agent when it\n registered the container instance with Amazon ECS.

" } }, - "remainingResources": { - "target": "com.amazonaws.ecs#Resources", + "attributes": { + "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "

For CPU and memory resource types, this parameter describes the remaining CPU and\n memory that has not already been allocated to tasks and is therefore available for new\n tasks. For port resource types, this parameter describes the ports that were reserved by\n the Amazon ECS container agent (at instance registration time) and any task containers that\n have reserved port mappings on the host (with the host or\n bridge network mode). Any port that is not specified here is available\n for new tasks.

" + "smithy.api#documentation": "

The attributes set for the container instance, either by the Amazon ECS container agent at\n instance registration or manually with the PutAttributes\n operation.

" + } + }, + "agentConnected": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#documentation": "

This parameter returns true if the agent is connected to Amazon ECS.\n Registered instances with an agent that may be unhealthy or stopped return\n false. Only instances connected to an agent can accept placement\n requests.

" } }, "statusReason": { @@ -1381,10 +1375,16 @@ "smithy.api#documentation": "

The reason that the container instance reached its current status.

" } }, - "status": { - "target": "com.amazonaws.ecs#String", + "versionInfo": { + "target": "com.amazonaws.ecs#VersionInfo", "traits": { - "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n REGISTRATION_FAILED, ACTIVE, INACTIVE,\n DEREGISTERING, or DRAINING.

\n

If your account has opted in to the awsvpcTrunking account setting, then\n any newly registered container instance will transition to a REGISTERING\n status while the trunk elastic network interface is provisioned for the instance. If the\n registration fails, the instance will transition to a REGISTRATION_FAILED\n status. You can describe the container instance and see the reason for failure in the\n statusReason parameter. Once the container instance is terminated, the\n instance transitions to a DEREGISTERING status while the trunk elastic\n network interface is deprovisioned. The instance then transitions to an\n INACTIVE status.

\n

The ACTIVE status indicates that the container instance can accept tasks.\n The DRAINING indicates that new tasks are not placed on the container\n instance and any service tasks running on the container instance are removed if\n possible. For more information, see Container Instance Draining in the\n Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The version information for the Amazon ECS container agent and Docker daemon running on the\n container instance.

" + } + }, + "registeredAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the container instance was registered.

" } } }, @@ -1445,28 +1445,22 @@ "com.amazonaws.ecs#ContainerOverride": { "type": "structure", "members": { - "environmentFiles": { - "target": "com.amazonaws.ecs#EnvironmentFiles", - "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container, instead\n of the value from the container definition.

" - } - }, - "memory": { + "cpu": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The hard limit (in MiB) of memory to present to the container, instead of the default\n value from the task definition. If your container attempts to exceed the memory\n specified here, the container is killed. You must also specify a container name.

" + "smithy.api#documentation": "

The number of cpu units reserved for the container, instead of the\n default value from the task definition. You must also specify a container name.

" } }, - "environment": { - "target": "com.amazonaws.ecs#EnvironmentVariables", + "name": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment\n variables, which are added to the container at launch, or you can override the existing\n environment variables from the Docker image or the task definition. You must also\n specify a container name.

" + "smithy.api#documentation": "

The name of the container that receives the override. This parameter is required if\n any override is specified.

" } }, - "cpu": { - "target": "com.amazonaws.ecs#BoxedInteger", + "command": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The number of cpu units reserved for the container, instead of the\n default value from the task definition. You must also specify a container name.

" + "smithy.api#documentation": "

The command to send to the container that overrides the default command from the\n Docker image or the task definition. You must also specify a container name.

" } }, "memoryReservation": { @@ -1475,22 +1469,28 @@ "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container, instead of the default\n value from the task definition. You must also specify a container name.

" } }, - "command": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "

The command to send to the container that overrides the default command from the\n Docker image or the task definition. You must also specify a container name.

" - } - }, "resourceRequirements": { "target": "com.amazonaws.ecs#ResourceRequirements", "traits": { "smithy.api#documentation": "

The type and amount of a resource to assign to a container, instead of the default\n value from the task definition. The only supported resource is a GPU.

" } }, - "name": { - "target": "com.amazonaws.ecs#String", + "memory": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The name of the container that receives the override. This parameter is required if\n any override is specified.

" + "smithy.api#documentation": "

The hard limit (in MiB) of memory to present to the container, instead of the default\n value from the task definition. If your container attempts to exceed the memory\n specified here, the container is killed. You must also specify a container name.

" + } + }, + "environmentFiles": { + "target": "com.amazonaws.ecs#EnvironmentFiles", + "traits": { + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container, instead\n of the value from the container definition.

" + } + }, + "environment": { + "target": "com.amazonaws.ecs#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment\n variables, which are added to the container at launch, or you can override the existing\n environment variables from the Docker image or the task definition. You must also\n specify a container name.

" } } }, @@ -1507,10 +1507,10 @@ "com.amazonaws.ecs#ContainerStateChange": { "type": "structure", "members": { - "networkBindings": { - "target": "com.amazonaws.ecs#NetworkBindings", + "imageDigest": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Any network bindings associated with the container.

" + "smithy.api#documentation": "

The container image SHA 256 digest.

" } }, "reason": { @@ -1519,34 +1519,34 @@ "smithy.api#documentation": "

The reason for the state change.

" } }, - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The name of the container.

" - } - }, "exitCode": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "

The exit code for the container, if the state change is a result of the container\n exiting.

" } }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The status of the container.

" + } + }, "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The ID of the Docker container.

" } }, - "status": { - "target": "com.amazonaws.ecs#String", + "networkBindings": { + "target": "com.amazonaws.ecs#NetworkBindings", "traits": { - "smithy.api#documentation": "

The status of the container.

" + "smithy.api#documentation": "

Any network bindings associated with the container.

" } }, - "imageDigest": { + "containerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container image SHA 256 digest.

" + "smithy.api#documentation": "

The name of the container.

" } } }, @@ -1598,11 +1598,10 @@ "com.amazonaws.ecs#CreateCapacityProviderRequest": { "type": "structure", "members": { - "autoScalingGroupProvider": { - "target": "com.amazonaws.ecs#AutoScalingGroupProvider", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The details of the Auto Scaling group for the capacity provider.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n " } }, "name": { @@ -1612,10 +1611,11 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "autoScalingGroupProvider": { + "target": "com.amazonaws.ecs#AutoScalingGroupProvider", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The details of the Auto Scaling group for the capacity provider.

", + "smithy.api#required": {} } } } @@ -1657,10 +1657,10 @@ "com.amazonaws.ecs#CreateClusterRequest": { "type": "structure", "members": { - "capacityProviders": { - "target": "com.amazonaws.ecs#StringList", + "defaultCapacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The short name of one or more capacity providers to associate\n with the cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created and not already associated with another cluster. New\n capacity providers can be created with the CreateCapacityProvider API\n operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" + "smithy.api#documentation": "

The capacity provider strategy to use by default for the cluster.

\n

When creating a service or running a task on a cluster, if no capacity provider or\n launch type is specified then the default capacity provider strategy for the cluster is\n used.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

If a default capacity provider strategy is not defined for a cluster during creation,\n it can be defined later with the PutClusterCapacityProviders API\n operation.

" } }, "clusterName": { @@ -1669,16 +1669,10 @@ "smithy.api#documentation": "

The name of your cluster. If you do not specify a name for your cluster, you create a\n cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " - } - }, - "defaultCapacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "capacityProviders": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use by default for the cluster.

\n

When creating a service or running a task on a cluster, if no capacity provider or\n launch type is specified then the default capacity provider strategy for the cluster is\n used.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

If a default capacity provider strategy is not defined for a cluster during creation,\n it can be defined later with the PutClusterCapacityProviders API\n operation.

" + "smithy.api#documentation": "

The short name of one or more capacity providers to associate\n with the cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created and not already associated with another cluster. New\n capacity providers can be created with the CreateCapacityProvider API\n operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" } }, "settings": { @@ -1686,6 +1680,12 @@ "traits": { "smithy.api#documentation": "

The setting to use when creating a cluster. This parameter is used to enable CloudWatch\n Container Insights for a cluster. If this value is specified, it will override the\n containerInsights value set with PutAccountSetting or\n PutAccountSettingDefault.

" } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } } } }, @@ -1741,41 +1741,28 @@ "com.amazonaws.ecs#CreateServiceRequest": { "type": "structure", "members": { - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", - "traits": { - "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.

" - } - }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to run in your service. If a revision is\n not specified, the latest ACTIVE revision is used.

\n

A task definition must be specified if the service is using the ECS\n deployment controller.

" - } - }, - "serviceName": { - "target": "com.amazonaws.ecs#String", + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n a cluster, but you can have similarly named services in multiple clusters within a\n Region or across multiple Regions.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The network configuration for the service. This parameter is required for task\n definitions that use the awsvpc network mode to receive their own elastic\n network interface, and it is not supported for other network modes. For more\n information, see Task Networking\n in the Amazon Elastic Container Service Developer Guide.

" } }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", + "deploymentController": { + "target": "com.amazonaws.ecs#DeploymentController", "traits": { - "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n more information, see Service Load Balancing in the\n Amazon Elastic Container Service Developer Guide.

\n

If the service is using the rolling update (ECS) deployment controller\n and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to\n the service. The service-linked role is required for services that make use of multiple\n target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.

\n

If the service is using the CODE_DEPLOY deployment controller, the\n service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment\n group, you specify two target groups (referred to as a targetGroupPair).\n During a deployment, AWS CodeDeploy determines which task set in your service has the status\n PRIMARY and associates one target group with it, and then associates\n the other target group with the replacement task set. The load balancer can also have up\n to two listeners: a required listener for production traffic and an optional listener\n that allows you perform validation tests with Lambda functions before routing production\n traffic to it.

\n

After you create a service using the ECS deployment controller, the load\n balancer name or target group ARN, container name, and container port specified in the\n service definition are immutable. If you are using the CODE_DEPLOY\n deployment controller, these values can be changed when updating the service.

\n

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n the container name (as it appears in a container definition), and the container port to\n access from the load balancer. When a task from this service is placed on a container\n instance, the container instance and port combination is registered as a target in the\n target group specified here.

\n

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it\n appears in a container definition), and the container port to access from the load\n balancer. When a task from this service is placed on a container instance, the container\n instance is registered with the load balancer specified here.

\n

Services with tasks that use the awsvpc network mode (for example, those\n with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are\n not supported. Also, when you create any target groups for these services, you must\n choose ip as the target type, not instance, because tasks that\n use the awsvpc network mode are associated with an elastic network\n interface, not an Amazon EC2 instance.

" + "smithy.api#documentation": "

The deployment controller to use for the service.

" } }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The network configuration for the service. This parameter is required for task\n definitions that use the awsvpc network mode to receive their own elastic\n network interface, and it is not supported for other network modes. For more\n information, see Task Networking\n in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The details of the service discovery registries to assign to this service. For more\n information, see Service\n Discovery.

\n \n

Service discovery is supported for Fargate tasks if you are using\n platform version v1.1.0 or later. For more information, see AWS Fargate Platform\n Versions.

\n " } }, - "clientToken": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Up to 32 ASCII characters are allowed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.\n If you do not specify a cluster, the default cluster is assumed.

" } }, "schedulingStrategy": { @@ -1784,22 +1771,29 @@ "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n

There are two service scheduler strategies available:

\n " } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

The platform version that your tasks in the service are running on. A platform version\n is specified only for tasks using the Fargate launch type. If one isn't\n specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n tasks in the service. If no value is specified, the tags are not propagated. Tags can\n only be propagated to the tasks within the service during service creation. To add tags\n to a task after service creation, use the TagResource API\n action.

" } }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for tasks in your service. You can\n specify a maximum of 10 constraints per task (this limit includes constraints in the\n task definition and those specified at runtime).

" + "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n more information, see Service Load Balancing in the\n Amazon Elastic Container Service Developer Guide.

\n

If the service is using the rolling update (ECS) deployment controller\n and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to\n the service. The service-linked role is required for services that make use of multiple\n target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.

\n

If the service is using the CODE_DEPLOY deployment controller, the\n service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment\n group, you specify two target groups (referred to as a targetGroupPair).\n During a deployment, AWS CodeDeploy determines which task set in your service has the status\n PRIMARY and associates one target group with it, and then associates\n the other target group with the replacement task set. The load balancer can also have up\n to two listeners: a required listener for production traffic and an optional listener\n that allows you perform validation tests with Lambda functions before routing production\n traffic to it.

\n

After you create a service using the ECS deployment controller, the load\n balancer name or target group ARN, container name, and container port specified in the\n service definition are immutable. If you are using the CODE_DEPLOY\n deployment controller, these values can be changed when updating the service.

\n

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n the container name (as it appears in a container definition), and the container port to\n access from the load balancer. When a task from this service is placed on a container\n instance, the container instance and port combination is registered as a target in the\n target group specified here.

\n

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it\n appears in a container definition), and the container port to access from the load\n balancer. When a task from this service is placed on a container instance, the container\n instance is registered with the load balancer specified here.

\n

Services with tasks that use the awsvpc network mode (for example, those\n with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are\n not supported. Also, when you create any target groups for these services, you must\n choose ip as the target type, not instance, because tasks that\n use the awsvpc network mode are associated with an elastic network\n interface, not an Amazon EC2 instance.

" } }, - "cluster": { + "desiredCount": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The number of instantiations of the specified task definition to place and keep\n running on your cluster.

\n

This is required if schedulingStrategy is REPLICA or is not\n specified. If schedulingStrategy is DAEMON then this is not\n required.

" + } + }, + "serviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.\n If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n a cluster, but you can have similarly named services in multiple clusters within a\n Region or across multiple Regions.

", + "smithy.api#required": {} } }, "role": { @@ -1808,64 +1802,70 @@ "smithy.api#documentation": "

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n load balancer on your behalf. This parameter is only permitted if you are using a load\n balancer with your service and your task definition does not use the awsvpc\n network mode. If you specify the role parameter, you must also specify a\n load balancer object with the loadBalancers parameter.

\n \n

If your account has already created the Amazon ECS service-linked role, that role is\n used by default for your service unless you specify a role here. The service-linked\n role is required if your task definition uses the awsvpc network mode\n or if the service is configured to use service discovery, an external deployment\n controller, multiple target groups, or Elastic Inference accelerators in which case\n you should not specify a role here. For more information, see Using\n Service-Linked Roles for Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.

\n \n

If your specified role has a path other than /, then you must either\n specify the full role ARN (this is recommended) or prefix the role name with the path.\n For example, if a role with the name bar has a path of /foo/\n then you would specify /foo/bar as the role name. For more information, see\n Friendly Names and Paths in the IAM User Guide.

" } }, - "healthCheckGracePeriodSeconds": { - "target": "com.amazonaws.ecs#BoxedInteger", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used\n when your service is configured to use a load balancer. If your service has a load\n balancer defined and you don't specify a health check grace period value, the default\n value of 0 is used.

\n

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n can specify a health check grace period of up to 2,147,483,647 seconds. During that\n time, the Amazon ECS service scheduler ignores health check status. This grace period can\n prevent the service scheduler from marking tasks as unhealthy and stopping them before\n they have time to come up.

" + "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define. When a\n service is deleted, the tags are deleted as well.

\n

The following basic restrictions apply to tags:

\n " } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the service.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or\n launchType is specified, the\n defaultCapacityProviderStrategy for the cluster is used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" + "smithy.api#documentation": "

The placement strategy objects to use for tasks in your service. You can specify a\n maximum of five strategy rules per service.

" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

The launch type on which to run your service. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

\n

If a launchType is specified, the capacityProviderStrategy\n parameter must be omitted.

" + "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For\n more information, see Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define. When a\n service is deleted, the tags are deleted as well.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.

" } }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", + "clientToken": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For\n more information, see Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Up to 32 ASCII characters are allowed.

" } }, - "serviceRegistries": { - "target": "com.amazonaws.ecs#ServiceRegistries", + "platformVersion": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The details of the service discovery registries to assign to this service. For more\n information, see Service\n Discovery.

\n \n

Service discovery is supported for Fargate tasks if you are using\n platform version v1.1.0 or later. For more information, see AWS Fargate Platform\n Versions.

\n " + "smithy.api#documentation": "

The platform version that your tasks in the service are running on. A platform version\n is specified only for tasks using the Fargate launch type. If one isn't\n specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" } }, - "deploymentController": { - "target": "com.amazonaws.ecs#DeploymentController", + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

The deployment controller to use for the service.

" + "smithy.api#documentation": "

An array of placement constraint objects to use for tasks in your service. You can\n specify a maximum of 10 constraints per task (this limit includes constraints in the\n task definition and those specified at runtime).

" } }, - "propagateTags": { - "target": "com.amazonaws.ecs#PropagateTags", + "taskDefinition": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n tasks in the service. If no value is specified, the tags are not propagated. Tags can\n only be propagated to the tasks within the service during service creation. To add tags\n to a task after service creation, use the TagResource API\n action.

" + "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to run in your service. If a revision is\n not specified, the latest ACTIVE revision is used.

\n

A task definition must be specified if the service is using the ECS\n deployment controller.

" } }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", + "healthCheckGracePeriodSeconds": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The placement strategy objects to use for tasks in your service. You can specify a\n maximum of five strategy rules per service.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used\n when your service is configured to use a load balancer. If your service has a load\n balancer defined and you don't specify a health check grace period value, the default\n value of 0 is used.

\n

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n can specify a health check grace period of up to 2,147,483,647 seconds. During that\n time, the Amazon ECS service scheduler ignores health check status. This grace period can\n prevent the service scheduler from marking tasks as unhealthy and stopping them before\n they have time to come up.

" } }, - "desiredCount": { - "target": "com.amazonaws.ecs#BoxedInteger", + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The number of instantiations of the specified task definition to place and keep\n running on your cluster.

\n

This is required if schedulingStrategy is REPLICA or is not\n specified. If schedulingStrategy is DAEMON then this is not\n required.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the service.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or\n launchType is specified, the\n defaultCapacityProviderStrategy for the cluster is used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "

The launch type on which to run your service. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

\n

If a launchType is specified, the capacityProviderStrategy\n parameter must be omitted.

" } } } @@ -1928,24 +1928,14 @@ "com.amazonaws.ecs#CreateTaskSetRequest": { "type": "structure", "members": { - "serviceRegistries": { - "target": "com.amazonaws.ecs#ServiceRegistries", - "traits": { - "smithy.api#documentation": "

The details of the service discovery registries to assign to this task set. For more\n information, see Service\n Discovery.

" - } - }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n task set in.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define. When a\n service is deleted, the tags are deleted as well.

\n

The following basic restrictions apply to tags:

\n " } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The platform version that the tasks in the task set should use. A platform version is\n specified only for tasks using the Fargate launch type. If one isn't\n specified, the LATEST platform version is used by default.

" - } + "scale": { + "target": "com.amazonaws.ecs#Scale" }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", @@ -1953,6 +1943,12 @@ "smithy.api#documentation": "

A load balancer object representing the load balancer to use with the task set. The\n supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

" } }, + "clientToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Up to 32 ASCII characters are allowed.

" + } + }, "externalId": { "target": "com.amazonaws.ecs#String", "traits": { @@ -1962,19 +1958,13 @@ "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration" }, - "service": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n task set in.

", "smithy.api#required": {} } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", - "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the task set.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or\n launchType is specified, the\n defaultCapacityProviderStrategy for the cluster is used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" - } - }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { @@ -1982,26 +1972,36 @@ "smithy.api#required": {} } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "platformVersion": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The launch type that new tasks in the task set will use. For more information, see\n Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

\n

If a launchType is specified, the capacityProviderStrategy\n parameter must be omitted.

" + "smithy.api#documentation": "

The platform version that the tasks in the task set should use. A platform version is\n specified only for tasks using the Fargate launch type. If one isn't\n specified, the LATEST platform version is used by default.

" } }, - "clientToken": { + "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Up to 32 ASCII characters are allowed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define. When a\n service is deleted, the tags are deleted as well.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The details of the service discovery registries to assign to this task set. For more\n information, see Service\n Discovery.

" } }, - "scale": { - "target": "com.amazonaws.ecs#Scale" + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "

The capacity provider strategy to use for the task set.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or\n launchType is specified, the\n defaultCapacityProviderStrategy for the cluster is used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "

The launch type that new tasks in the task set will use. For more information, see\n Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

\n

If a launchType is specified, the capacityProviderStrategy\n parameter must be omitted.

" + } } } }, @@ -2039,18 +2039,18 @@ "com.amazonaws.ecs#DeleteAccountSettingRequest": { "type": "structure", "members": { - "principalArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n specify the root user, it disables the account setting for all IAM users, IAM roles, and\n the root user of the account unless an IAM user or role explicitly overrides these\n settings. If this field is omitted, the setting is changed only for the authenticated\n user.

" - } - }, "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { "smithy.api#documentation": "

The resource name for which to disable the account setting. If\n serviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n affected. If taskLongArnFormat is specified, the ARN and resource ID for\n your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n specified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n awsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n instances is affected.

", "smithy.api#required": {} } + }, + "principalArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n specify the root user, it disables the account setting for all IAM users, IAM roles, and\n the root user of the account unless an IAM user or role explicitly overrides these\n settings. If this field is omitted, the setting is changed only for the authenticated\n user.

" + } } } }, @@ -2091,18 +2091,18 @@ "com.amazonaws.ecs#DeleteAttributesRequest": { "type": "structure", "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n attributes. If you do not specify a cluster, the default cluster is assumed.

" - } - }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "

The attributes to delete from your resource. You can specify up to 10 attributes per\n request. For custom attributes, specify the attribute name and target ID, but do not\n specify the value. If you specify the target ID using the short form, you must also\n specify the target type.

", "smithy.api#required": {} } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n attributes. If you do not specify a cluster, the default cluster is assumed.

" + } } } }, @@ -2259,17 +2259,17 @@ "smithy.api#documentation": "

If true, allows you to delete a service even if it has not been scaled\n down to zero tasks. It is only necessary to use this if the service is using the\n REPLICA scheduling strategy.

" } }, - "service": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the service to delete.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete.\n If you do not specify a cluster, the default cluster is assumed.

" } }, - "cluster": { + "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete.\n If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The name of the service to delete.

", + "smithy.api#required": {} } } } @@ -2329,6 +2329,13 @@ "com.amazonaws.ecs#DeleteTaskSetRequest": { "type": "structure", "members": { + "taskSet": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

", + "smithy.api#required": {} + } + }, "service": { "target": "com.amazonaws.ecs#String", "traits": { @@ -2336,10 +2343,10 @@ "smithy.api#required": {} } }, - "taskSet": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n set exists in to delete.

", "smithy.api#required": {} } }, @@ -2348,13 +2355,6 @@ "traits": { "smithy.api#documentation": "

If true, this allows you to delete a task set even if it hasn't been\n scaled down to zero.

" } - }, - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n set exists in to delete.

", - "smithy.api#required": {} - } } } }, @@ -2369,22 +2369,16 @@ "com.amazonaws.ecs#Deployment": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The status of the deployment. The following describes each state:

\n
\n
PRIMARY
\n
\n

The most recent deployment of a service.

\n
\n
ACTIVE
\n
\n

A service deployment that still has running tasks, but are in the process\n of being replaced with a new PRIMARY deployment.

\n
\n
INACTIVE
\n
\n

A deployment that has been completely replaced.

\n
\n
" - } - }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The most recent task definition that was specified for the tasks in the service to\n use.

" + "smithy.api#documentation": "

The capacity provider strategy that the deployment is using.

" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "updatedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The platform version on which your tasks in the service are running. A platform\n version is only specified for tasks using the Fargate launch type. If one\n is not specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Unix timestamp for when the service deployment was last updated.

" } }, "desiredCount": { @@ -2393,28 +2387,34 @@ "smithy.api#documentation": "

The most recent desired count of tasks that was specified for the service to deploy or\n maintain.

" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The capacity provider strategy that the deployment is using.

" + "smithy.api#documentation": "

The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.

" } }, - "updatedAt": { + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The platform version on which your tasks in the service are running. A platform\n version is only specified for tasks using the Fargate launch type. If one\n is not specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the service deployment was last updated.

" + "smithy.api#documentation": "

The Unix timestamp for when the service deployment was created.

" } }, - "id": { - "target": "com.amazonaws.ecs#String", + "pendingCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The ID of the deployment.

" + "smithy.api#documentation": "

The number of tasks in the deployment that are in the PENDING\n status.

" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "status": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The launch type the tasks in the service are using. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The status of the deployment. The following describes each state:

\n
\n
PRIMARY
\n
\n

The most recent deployment of a service.

\n
\n
ACTIVE
\n
\n

A service deployment that still has running tasks, but are in the process\n of being replaced with a new PRIMARY deployment.

\n
\n
INACTIVE
\n
\n

A deployment that has been completely replaced.

\n
\n
" } }, "runningCount": { @@ -2423,22 +2423,22 @@ "smithy.api#documentation": "

The number of tasks in the deployment that are in the RUNNING\n status.

" } }, - "pendingCount": { - "target": "com.amazonaws.ecs#Integer", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The number of tasks in the deployment that are in the PENDING\n status.

" + "smithy.api#documentation": "

The launch type the tasks in the service are using. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" } }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", + "id": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.

" + "smithy.api#documentation": "

The ID of the deployment.

" } }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", + "taskDefinition": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the service deployment was created.

" + "smithy.api#documentation": "

The most recent task definition that was specified for the tasks in the service to\n use.

" } } }, @@ -2449,16 +2449,16 @@ "com.amazonaws.ecs#DeploymentConfiguration": { "type": "structure", "members": { - "maximumPercent": { + "minimumHealthyPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n maximum percent parameter represents an upper limit\n on the number of tasks in a service that are allowed in the RUNNING or\n PENDING state during a deployment, as a percentage of the desired\n number of tasks (rounded down to the nearest integer), and while any container instances\n are in the DRAINING state if the service contains tasks using the\n EC2 launch type. This parameter enables you to define the deployment batch\n size. For example, if your service has a desired number of four tasks and a maximum\n percent value of 200%, the scheduler may start four new tasks before stopping the four\n older tasks (provided that the cluster resources required to do this are available). The\n default value for maximum percent is 200%.

\n

If a service is using the blue/green (CODE_DEPLOY) or\n EXTERNAL deployment types and tasks that use the EC2\n launch type, the maximum percent value is set to the\n default value and is used to define the upper limit on the number of the tasks in the\n service that remain in the RUNNING state while the container instances are\n in the DRAINING state. If the tasks in the service use the\n Fargate launch type, the maximum percent value is not used, although it is\n returned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n minimum healthy percent represents a lower limit on\n the number of tasks in a service that must remain in the RUNNING state\n during a deployment, as a percentage of the desired number of tasks (rounded up to the\n nearest integer), and while any container instances are in the DRAINING\n state if the service contains tasks using the EC2 launch type. This\n parameter enables you to deploy without using additional cluster capacity. For example,\n if your service has a desired number of four tasks and a minimum healthy percent of 50%,\n the scheduler may stop two existing tasks to free up cluster capacity before starting\n two new tasks. Tasks for services that do not use a load balancer\n are considered healthy if they are in the RUNNING state; tasks for services\n that do use a load balancer are considered healthy if they are in\n the RUNNING state and they are reported as healthy by the load balancer.\n The default value for minimum healthy percent is 100%.

\n

If a service is using the blue/green (CODE_DEPLOY) or\n EXTERNAL deployment types and tasks that use the EC2\n launch type, the minimum healthy percent value is set\n to the default value and is used to define the lower limit on the number of the tasks in\n the service that remain in the RUNNING state while the container instances\n are in the DRAINING state. If the tasks in the service use the\n Fargate launch type, the minimum healthy percent value is not used,\n although it is returned when describing your service.

" } }, - "minimumHealthyPercent": { + "maximumPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n minimum healthy percent represents a lower limit on\n the number of tasks in a service that must remain in the RUNNING state\n during a deployment, as a percentage of the desired number of tasks (rounded up to the\n nearest integer), and while any container instances are in the DRAINING\n state if the service contains tasks using the EC2 launch type. This\n parameter enables you to deploy without using additional cluster capacity. For example,\n if your service has a desired number of four tasks and a minimum healthy percent of 50%,\n the scheduler may stop two existing tasks to free up cluster capacity before starting\n two new tasks. Tasks for services that do not use a load balancer\n are considered healthy if they are in the RUNNING state; tasks for services\n that do use a load balancer are considered healthy if they are in\n the RUNNING state and they are reported as healthy by the load balancer.\n The default value for minimum healthy percent is 100%.

\n

If a service is using the blue/green (CODE_DEPLOY) or\n EXTERNAL deployment types and tasks that use the EC2\n launch type, the minimum healthy percent value is set\n to the default value and is used to define the lower limit on the number of the tasks in\n the service that remain in the RUNNING state while the container instances\n are in the DRAINING state. If the tasks in the service use the\n Fargate launch type, the minimum healthy percent value is not used,\n although it is returned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n maximum percent parameter represents an upper limit\n on the number of tasks in a service that are allowed in the RUNNING or\n PENDING state during a deployment, as a percentage of the desired\n number of tasks (rounded down to the nearest integer), and while any container instances\n are in the DRAINING state if the service contains tasks using the\n EC2 launch type. This parameter enables you to define the deployment batch\n size. For example, if your service has a desired number of four tasks and a maximum\n percent value of 200%, the scheduler may start four new tasks before stopping the four\n older tasks (provided that the cluster resources required to do this are available). The\n default value for maximum percent is 200%.

\n

If a service is using the blue/green (CODE_DEPLOY) or\n EXTERNAL deployment types and tasks that use the EC2\n launch type, the maximum percent value is set to the\n default value and is used to define the upper limit on the number of the tasks in the\n service that remain in the RUNNING state while the container instances are\n in the DRAINING state. If the tasks in the service use the\n Fargate launch type, the maximum percent value is not used, although it is\n returned when describing your service.

" } } }, @@ -2535,6 +2535,12 @@ "com.amazonaws.ecs#DeregisterContainerInstanceRequest": { "type": "structure", "members": { + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n deregister. If you do not specify a cluster, the default cluster is assumed.

" + } + }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { @@ -2547,12 +2553,6 @@ "traits": { "smithy.api#documentation": "

Forces the deregistration of the container instance. If you have tasks running on the\n container instance when you deregister it with the force option, these\n tasks remain running until you terminate the instance or the tasks stop through some\n other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If\n an orphaned task on your container instance is part of an Amazon ECS service, then the\n service scheduler starts another copy of that task, on a different container instance if\n possible.

\n

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n target group are deregistered. They begin connection draining according to the settings\n on the load balancer or target group.

" } - }, - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n deregister. If you do not specify a cluster, the default cluster is assumed.

" - } } } }, @@ -2639,47 +2639,47 @@ "com.amazonaws.ecs#DescribeCapacityProvidersRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeCapacityProviders request where maxResults was\n 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.

\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 " - } - }, - "include": { - "target": "com.amazonaws.ecs#CapacityProviderFieldList", - "traits": { - "smithy.api#documentation": "

Specifies whether or not you want to see the resource tags for the capacity provider.\n If TAGS is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.

" - } - }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { "smithy.api#documentation": "

The maximum number of account setting results returned by\n DescribeCapacityProviders in paginated output. When this parameter is\n used, DescribeCapacityProviders only returns maxResults\n results in a single page along with a nextToken response element. The\n remaining results of the initial request can be seen by sending another\n DescribeCapacityProviders request with the returned\n nextToken value. This value can be between\n 1 and 10. If this\n parameter is not used, then DescribeCapacityProviders returns up to\n 10 results and a nextToken value\n if applicable.

" } }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeCapacityProviders request where maxResults was\n 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.

\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 " + } + }, "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n 100 capacity providers can be described in an action.

" } + }, + "include": { + "target": "com.amazonaws.ecs#CapacityProviderFieldList", + "traits": { + "smithy.api#documentation": "

Specifies whether or not you want to see the resource tags for the capacity provider.\n If TAGS is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.

" + } } } }, "com.amazonaws.ecs#DescribeCapacityProvidersResponse": { "type": "structure", "members": { - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "

Any failures associated with the call.

" - } - }, "capacityProviders": { "target": "com.amazonaws.ecs#CapacityProviders", "traits": { "smithy.api#documentation": "

The list of capacity providers.

" } }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "

Any failures associated with the call.

" + } + }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { @@ -2714,17 +2714,17 @@ "com.amazonaws.ecs#DescribeClustersRequest": { "type": "structure", "members": { - "include": { - "target": "com.amazonaws.ecs#ClusterFieldList", - "traits": { - "smithy.api#documentation": "

Whether to include additional information about your clusters in the response. If this\n field is omitted, the attachments, statistics, and tags are not included.

\n

If ATTACHMENTS is specified, the attachments for the container instances\n or tasks within the cluster are included.

\n

If SETTINGS is specified, the settings for the cluster are\n included.

\n

If STATISTICS is specified, the following additional information,\n separated by launch type, is included:

\n \n

If TAGS is specified, the metadata tags associated with the cluster are\n included.

" - } - }, "clusters": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.\n If you do not specify a cluster, the default cluster is assumed.

" } + }, + "include": { + "target": "com.amazonaws.ecs#ClusterFieldList", + "traits": { + "smithy.api#documentation": "

Whether to include additional information about your clusters in the response. If this\n field is omitted, the attachments, statistics, and tags are not included.

\n

If ATTACHMENTS is specified, the attachments for the container instances\n or tasks within the cluster are included.

\n

If SETTINGS is specified, the settings for the cluster are\n included.

\n

If STATISTICS is specified, the following additional information,\n separated by launch type, is included:

\n \n

If TAGS is specified, the metadata tags associated with the cluster are\n included.

" + } } } }, @@ -2774,18 +2774,18 @@ "com.amazonaws.ecs#DescribeContainerInstancesRequest": { "type": "structure", "members": { - "include": { - "target": "com.amazonaws.ecs#ContainerInstanceFieldList", - "traits": { - "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the container instance. If\n TAGS is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.

" - } - }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance\n or container instances you are describing were launched in any cluster other than the\n default cluster.

" } }, + "include": { + "target": "com.amazonaws.ecs#ContainerInstanceFieldList", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the container instance. If\n TAGS is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.

" + } + }, "containerInstances": { "target": "com.amazonaws.ecs#StringList", "traits": { @@ -2841,6 +2841,12 @@ "com.amazonaws.ecs#DescribeServicesRequest": { "type": "structure", "members": { + "include": { + "target": "com.amazonaws.ecs#ServiceFieldList", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the service. If\n TAGS is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.

" + } + }, "services": { "target": "com.amazonaws.ecs#StringList", "traits": { @@ -2848,12 +2854,6 @@ "smithy.api#required": {} } }, - "include": { - "target": "com.amazonaws.ecs#ServiceFieldList", - "traits": { - "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the service. If\n TAGS is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.

" - } - }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { @@ -2978,29 +2978,29 @@ "com.amazonaws.ecs#DescribeTaskSetsRequest": { "type": "structure", "members": { - "service": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

", - "smithy.api#required": {} - } - }, "include": { "target": "com.amazonaws.ecs#TaskSetFieldList", "traits": { "smithy.api#documentation": "

Specifies whether to see the resource tags for the task set. If TAGS is\n specified, the tags are included in the response. If this field is omitted, tags are not\n included in the response.

" } }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n sets exist in.

", + "smithy.api#required": {} + } + }, "taskSets": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "

The ID or full Amazon Resource Name (ARN) of task sets to\n describe.

" } }, - "cluster": { + "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n sets exist in.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

", "smithy.api#required": {} } } @@ -3009,17 +3009,17 @@ "com.amazonaws.ecs#DescribeTaskSetsResponse": { "type": "structure", "members": { - "taskSets": { - "target": "com.amazonaws.ecs#TaskSets", - "traits": { - "smithy.api#documentation": "

The list of task sets described.

" - } - }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "

Any failures associated with the call.

" } + }, + "taskSets": { + "target": "com.amazonaws.ecs#TaskSets", + "traits": { + "smithy.api#documentation": "

The list of task sets described.

" + } } } }, @@ -3052,10 +3052,10 @@ "com.amazonaws.ecs#DescribeTasksRequest": { "type": "structure", "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", + "include": { + "target": "com.amazonaws.ecs#TaskFieldList", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you\n are describing were launched in any cluster other than the default cluster.

" + "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the task. If TAGS\n is specified, the tags are included in the response. If this field is omitted, tags are\n not included in the response.

" } }, "tasks": { @@ -3065,10 +3065,10 @@ "smithy.api#required": {} } }, - "include": { - "target": "com.amazonaws.ecs#TaskFieldList", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the task. If TAGS\n is specified, the tags are included in the response. If this field is omitted, tags are\n not included in the response.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you\n are describing were launched in any cluster other than the default cluster.

" } } } @@ -3112,6 +3112,12 @@ "com.amazonaws.ecs#Device": { "type": "structure", "members": { + "permissions": { + "target": "com.amazonaws.ecs#DeviceCgroupPermissions", + "traits": { + "smithy.api#documentation": "

The explicit permissions to provide to the container for the device. By default, the\n container has permissions for read, write, and\n mknod for the device.

" + } + }, "hostPath": { "target": "com.amazonaws.ecs#String", "traits": { @@ -3124,12 +3130,6 @@ "traits": { "smithy.api#documentation": "

The path inside the container at which to expose the host device.

" } - }, - "permissions": { - "target": "com.amazonaws.ecs#DeviceCgroupPermissions", - "traits": { - "smithy.api#documentation": "

The explicit permissions to provide to the container for the device. By default, the\n container has permissions for read, write, and\n mknod for the device.

" - } } }, "traits": { @@ -3233,10 +3233,10 @@ "com.amazonaws.ecs#DockerVolumeConfiguration": { "type": "structure", "members": { - "driver": { - "target": "com.amazonaws.ecs#String", + "labels": { + "target": "com.amazonaws.ecs#StringMap", "traits": { - "smithy.api#documentation": "

The Docker volume driver to use. The driver value must match the driver name provided\n by Docker because it is used for task placement. If the driver was installed using the\n Docker plugin CLI, use docker plugin ls to retrieve the driver name from\n your container instance. If the driver was installed using another method, use Docker\n plugin discovery to retrieve the driver name. For more information, see Docker\n plugin discovery. This parameter maps to Driver in the\n Create a volume section of the Docker Remote API and the\n xxdriver option to docker\n volume create.

" + "smithy.api#documentation": "

Custom metadata to add to your Docker volume. This parameter maps to\n Labels in the Create a volume section of the\n Docker Remote API and the xxlabel option to docker\n volume create.

" } }, "driverOpts": { @@ -3245,10 +3245,10 @@ "smithy.api#documentation": "

A map of Docker driver-specific options passed through. This parameter maps to\n DriverOpts in the Create a volume section of the\n Docker Remote API and the xxopt option to docker\n volume create.

" } }, - "scope": { - "target": "com.amazonaws.ecs#Scope", + "driver": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n scoped to a task are automatically provisioned when the task starts and\n destroyed when the task stops. Docker volumes that are scoped as shared\n persist after the task stops.

" + "smithy.api#documentation": "

The Docker volume driver to use. The driver value must match the driver name provided\n by Docker because it is used for task placement. If the driver was installed using the\n Docker plugin CLI, use docker plugin ls to retrieve the driver name from\n your container instance. If the driver was installed using another method, use Docker\n plugin discovery to retrieve the driver name. For more information, see Docker\n plugin discovery. This parameter maps to Driver in the\n Create a volume section of the Docker Remote API and the\n xxdriver option to docker\n volume create.

" } }, "autoprovision": { @@ -3257,10 +3257,10 @@ "smithy.api#documentation": "

If this value is true, the Docker volume is created if it does not\n already exist.

\n \n

This field is only used if the scope is shared.

\n " } }, - "labels": { - "target": "com.amazonaws.ecs#StringMap", + "scope": { + "target": "com.amazonaws.ecs#Scope", "traits": { - "smithy.api#documentation": "

Custom metadata to add to your Docker volume. This parameter maps to\n Labels in the Create a volume section of the\n Docker Remote API and the xxlabel option to docker\n volume create.

" + "smithy.api#documentation": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n scoped to a task are automatically provisioned when the task starts and\n destroyed when the task stops. Docker volumes that are scoped as shared\n persist after the task stops.

" } } }, @@ -3274,17 +3274,17 @@ "com.amazonaws.ecs#EFSAuthorizationConfig": { "type": "structure", "members": { - "iam": { - "target": "com.amazonaws.ecs#EFSAuthorizationConfigIAM", - "traits": { - "smithy.api#documentation": "

Whether or not to use the Amazon ECS task IAM role defined in a task definition when\n mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n EFSVolumeConfiguration. If this parameter is omitted, the default value\n of DISABLED is used. For more information, see Using\n Amazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.

" - } - }, "accessPointId": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory\n value specified in the EFSVolumeConfiguration will be relative to the\n directory set for the access point. If an access point is used, transit encryption must\n be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon\n EFS Access Points in the Amazon Elastic File System User Guide.

" } + }, + "iam": { + "target": "com.amazonaws.ecs#EFSAuthorizationConfigIAM", + "traits": { + "smithy.api#documentation": "

Whether or not to use the Amazon ECS task IAM role defined in a task definition when\n mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n EFSVolumeConfiguration. If this parameter is omitted, the default value\n of DISABLED is used. For more information, see Using\n Amazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.

" + } } }, "traits": { @@ -3324,35 +3324,35 @@ "com.amazonaws.ecs#EFSVolumeConfiguration": { "type": "structure", "members": { - "transitEncryption": { - "target": "com.amazonaws.ecs#EFSTransitEncryption", + "transitEncryptionPort": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host\n and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n used. If this parameter is omitted, the default value of DISABLED is used.\n For more information, see Encrypting Data in Transit in\n the Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n server. If you do not specify a transit encryption port, it will use the port selection\n strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount\n Helper in the Amazon Elastic File System User Guide.

" } }, - "rootDirectory": { + "fileSystemId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The directory within the Amazon EFS file system to mount as the root directory inside the\n host. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n Specifying / will have the same effect as omitting this parameter.

" + "smithy.api#documentation": "

The Amazon EFS file system ID to use.

", + "smithy.api#required": {} } }, - "authorizationConfig": { - "target": "com.amazonaws.ecs#EFSAuthorizationConfig", + "rootDirectory": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The authorization configuration details for the Amazon EFS file system.

" + "smithy.api#documentation": "

The directory within the Amazon EFS file system to mount as the root directory inside the\n host. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n Specifying / will have the same effect as omitting this parameter.

" } }, - "transitEncryptionPort": { - "target": "com.amazonaws.ecs#BoxedInteger", + "transitEncryption": { + "target": "com.amazonaws.ecs#EFSTransitEncryption", "traits": { - "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n server. If you do not specify a transit encryption port, it will use the port selection\n strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount\n Helper in the Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host\n and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n used. If this parameter is omitted, the default value of DISABLED is used.\n For more information, see Encrypting Data in Transit in\n the Amazon Elastic File System User Guide.

" } }, - "fileSystemId": { - "target": "com.amazonaws.ecs#String", + "authorizationConfig": { + "target": "com.amazonaws.ecs#EFSAuthorizationConfig", "traits": { - "smithy.api#documentation": "

The Amazon EFS file system ID to use.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The authorization configuration details for the Amazon EFS file system.

" } } }, @@ -3408,12 +3408,6 @@ "com.amazonaws.ecs#Failure": { "type": "structure", "members": { - "detail": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The details of the failure.

" - } - }, "arn": { "target": "com.amazonaws.ecs#String", "traits": { @@ -3425,6 +3419,12 @@ "traits": { "smithy.api#documentation": "

The reason for the failure.

" } + }, + "detail": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The details of the failure.

" + } } }, "traits": { @@ -3491,17 +3491,10 @@ "com.amazonaws.ecs#HealthCheck": { "type": "structure", "members": { - "command": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "

A string array representing the command that the container runs to determine if it is\n healthy. The string array must start with CMD to execute the command\n arguments directly, or CMD-SHELL to run the command with the container's\n default shell. For example:

\n

\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n

\n

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n more information, see HealthCheck in the Create a container\n section of the Docker Remote API.

", - "smithy.api#required": {} - } - }, - "retries": { + "startPeriod": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The number of times to retry a failed health check before the container is considered\n unhealthy. You may specify between 1 and 10 retries. The default value is 3.

" + "smithy.api#documentation": "

The optional grace period within which to provide containers time to bootstrap before\n failed health checks count towards the maximum number of retries. You may specify\n between 0 and 300 seconds. The startPeriod is disabled by default.

\n \n

If a health check succeeds within the startPeriod, then the container\n is considered healthy and any subsequent failures count toward the maximum number of\n retries.

\n " } }, "timeout": { @@ -3510,16 +3503,23 @@ "smithy.api#documentation": "

The time period in seconds to wait for a health check to succeed before it is\n considered a failure. You may specify between 2 and 60 seconds. The default value is\n 5.

" } }, - "startPeriod": { + "interval": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The optional grace period within which to provide containers time to bootstrap before\n failed health checks count towards the maximum number of retries. You may specify\n between 0 and 300 seconds. The startPeriod is disabled by default.

\n \n

If a health check succeeds within the startPeriod, then the container\n is considered healthy and any subsequent failures count toward the maximum number of\n retries.

\n " + "smithy.api#documentation": "

The time period in seconds between each health check execution. You may specify\n between 5 and 300 seconds. The default value is 30 seconds.

" } }, - "interval": { + "command": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "

A string array representing the command that the container runs to determine if it is\n healthy. The string array must start with CMD to execute the command\n arguments directly, or CMD-SHELL to run the command with the container's\n default shell. For example:

\n

\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n

\n

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n more information, see HealthCheck in the Create a container\n section of the Docker Remote API.

", + "smithy.api#required": {} + } + }, + "retries": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The time period in seconds between each health check execution. You may specify\n between 5 and 300 seconds. The default value is 30 seconds.

" + "smithy.api#documentation": "

The number of times to retry a failed health check before the container is considered\n unhealthy. You may specify between 1 and 10 retries. The default value is 3.

" } } }, @@ -3549,17 +3549,17 @@ "com.amazonaws.ecs#HostEntry": { "type": "structure", "members": { - "hostname": { + "ipAddress": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The hostname to use in the /etc/hosts entry.

", + "smithy.api#documentation": "

The IP address to use in the /etc/hosts entry.

", "smithy.api#required": {} } }, - "ipAddress": { + "hostname": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The IP address to use in the /etc/hosts entry.

", + "smithy.api#documentation": "

The hostname to use in the /etc/hosts entry.

", "smithy.api#required": {} } } @@ -3679,16 +3679,16 @@ "com.amazonaws.ecs#KernelCapabilities": { "type": "structure", "members": { - "drop": { + "add": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that have been removed from the default\n configuration provided by Docker. This parameter maps to CapDrop in the\n Create a container section of the Docker Remote API and the\n --cap-drop option to docker\n run.

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n \"WAKE_ALARM\"\n

" + "smithy.api#documentation": "

The Linux capabilities for the container that have been added to the default\n configuration provided by Docker. This parameter maps to CapAdd in the\n Create a container section of the Docker Remote API and the\n --cap-add option to docker\n run.

\n \n

The SYS_PTRACE capability is supported for tasks that use the\n Fargate launch type if they are also using platform version 1.4.0. The\n other capabilities are not supported for any platform versions.

\n \n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n \"WAKE_ALARM\"\n

" } }, - "add": { + "drop": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that have been added to the default\n configuration provided by Docker. This parameter maps to CapAdd in the\n Create a container section of the Docker Remote API and the\n --cap-add option to docker\n run.

\n \n

The SYS_PTRACE capability is supported for tasks that use the\n Fargate launch type if they are also using platform version 1.4.0. The\n other capabilities are not supported for any platform versions.

\n \n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n \"WAKE_ALARM\"\n

" + "smithy.api#documentation": "

The Linux capabilities for the container that have been removed from the default\n configuration provided by Docker. This parameter maps to CapDrop in the\n Create a container section of the Docker Remote API and the\n --cap-drop option to docker\n run.

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n \"WAKE_ALARM\"\n

" } } }, @@ -3699,16 +3699,16 @@ "com.amazonaws.ecs#KeyValuePair": { "type": "structure", "members": { - "value": { + "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value of the key-value pair. For environment variables, this is the value of the\n environment variable.

" + "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the\n environment variable.

" } }, - "name": { + "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the\n environment variable.

" + "smithy.api#documentation": "

The value of the key-value pair. For environment variables, this is the value of the\n environment variable.

" } } }, @@ -3746,10 +3746,10 @@ "com.amazonaws.ecs#LinuxParameters": { "type": "structure", "members": { - "sharedMemorySize": { - "target": "com.amazonaws.ecs#BoxedInteger", + "devices": { + "target": "com.amazonaws.ecs#DevicesList", "traits": { - "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume. This parameter\n maps to the --shm-size option to docker\n run.

\n \n

If you are using tasks that use the Fargate launch type, the\n sharedMemorySize parameter is not supported.

\n " + "smithy.api#documentation": "

Any host devices to expose to the container. This parameter maps to\n Devices in the Create a container section of the\n Docker Remote API and the --device option to docker run.

\n \n

If you are using tasks that use the Fargate launch type, the\n devices parameter is not supported.

\n " } }, "maxSwap": { @@ -3758,16 +3758,16 @@ "smithy.api#documentation": "

The total amount of swap memory (in MiB) a container can use. This parameter will be\n translated to the --memory-swap option to docker run where the value would be the sum of\n the container memory plus the maxSwap value.

\n

If a maxSwap value of 0 is specified, the container will not\n use swap. Accepted values are 0 or any positive integer. If the\n maxSwap parameter is omitted, the container will use the swap\n configuration for the container instance it is running on. A maxSwap value\n must be set for the swappiness parameter to be used.

\n \n

If you are using tasks that use the Fargate launch type, the\n maxSwap parameter is not supported.

\n " } }, - "swappiness": { - "target": "com.amazonaws.ecs#BoxedInteger", + "capabilities": { + "target": "com.amazonaws.ecs#KernelCapabilities", "traits": { - "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A\n swappiness value of 0 will cause swapping to not happen\n unless absolutely necessary. A swappiness value of 100 will\n cause pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter is not\n specified, a default value of 60 is used. If a value is not specified for\n maxSwap then this parameter is ignored. This parameter maps to the\n --memory-swappiness option to docker run.

\n \n

If you are using tasks that use the Fargate launch type, the\n swappiness parameter is not supported.

\n " + "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default\n configuration provided by Docker.

\n \n

For tasks that use the Fargate launch type,\n capabilities is supported for all platform versions but the\n add parameter is only supported if using platform version 1.4.0 or\n later.

\n " } }, - "devices": { - "target": "com.amazonaws.ecs#DevicesList", + "initProcessEnabled": { + "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Any host devices to expose to the container. This parameter maps to\n Devices in the Create a container section of the\n Docker Remote API and the --device option to docker run.

\n \n

If you are using tasks that use the Fargate launch type, the\n devices parameter is not supported.

\n " + "smithy.api#documentation": "

Run an init process inside the container that forwards signals and reaps\n processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" } }, "tmpfs": { @@ -3776,16 +3776,16 @@ "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount. This\n parameter maps to the --tmpfs option to docker run.

\n \n

If you are using tasks that use the Fargate launch type, the\n tmpfs parameter is not supported.

\n " } }, - "capabilities": { - "target": "com.amazonaws.ecs#KernelCapabilities", + "swappiness": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default\n configuration provided by Docker.

\n \n

For tasks that use the Fargate launch type,\n capabilities is supported for all platform versions but the\n add parameter is only supported if using platform version 1.4.0 or\n later.

\n " + "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A\n swappiness value of 0 will cause swapping to not happen\n unless absolutely necessary. A swappiness value of 100 will\n cause pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter is not\n specified, a default value of 60 is used. If a value is not specified for\n maxSwap then this parameter is ignored. This parameter maps to the\n --memory-swappiness option to docker run.

\n \n

If you are using tasks that use the Fargate launch type, the\n swappiness parameter is not supported.

\n " } }, - "initProcessEnabled": { - "target": "com.amazonaws.ecs#BoxedBoolean", + "sharedMemorySize": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Run an init process inside the container that forwards signals and reaps\n processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" + "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume. This parameter\n maps to the --shm-size option to docker\n run.

\n \n

If you are using tasks that use the Fargate launch type, the\n sharedMemorySize parameter is not supported.

\n " } } }, @@ -3825,22 +3825,16 @@ "com.amazonaws.ecs#ListAccountSettingsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of account setting results returned by\n ListAccountSettings in paginated output. When this parameter is used,\n ListAccountSettings only returns maxResults results in a\n single page along with a nextToken response element. The remaining results\n of the initial request can be seen by sending another ListAccountSettings\n request with the returned nextToken value. This value can be between\n 1 and 10. If this\n parameter is not used, then ListAccountSettings returns up to\n 10 results and a nextToken value\n if applicable.

" - } - }, - "principalArn": { + "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n this field is omitted, the account settings are listed only for the authenticated\n user.

" + "smithy.api#documentation": "

The nextToken value returned from a ListAccountSettings\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults was provided, it is possible the number\n of results to be fewer than maxResults.

\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 " } }, - "nextToken": { - "target": "com.amazonaws.ecs#String", + "name": { + "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListAccountSettings\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults was provided, it is possible the number\n of results to be fewer than maxResults.

\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 name of the account setting you want to list the settings for.

" } }, "value": { @@ -3849,34 +3843,40 @@ "smithy.api#documentation": "

The value of the account settings with which to filter results. You must also specify\n an account setting name to use this parameter.

" } }, - "name": { - "target": "com.amazonaws.ecs#SettingName", - "traits": { - "smithy.api#documentation": "

The name of the account setting you want to list the settings for.

" - } - }, "effectiveSettings": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether to return the effective settings. If true, the account\n settings for the root user or the default setting for the principalArn are\n returned. If false, the account settings for the principalArn\n are returned if they are set. Otherwise, no account settings are returned.

" } + }, + "maxResults": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of account setting results returned by\n ListAccountSettings in paginated output. When this parameter is used,\n ListAccountSettings only returns maxResults results in a\n single page along with a nextToken response element. The remaining results\n of the initial request can be seen by sending another ListAccountSettings\n request with the returned nextToken value. This value can be between\n 1 and 10. If this\n parameter is not used, then ListAccountSettings returns up to\n 10 results and a nextToken value\n if applicable.

" + } + }, + "principalArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n this field is omitted, the account settings are listed only for the authenticated\n user.

" + } } } }, "com.amazonaws.ecs#ListAccountSettingsResponse": { "type": "structure", "members": { - "settings": { - "target": "com.amazonaws.ecs#Settings", - "traits": { - "smithy.api#documentation": "

The account settings for the resource.

" - } - }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The nextToken value to include in a future\n ListAccountSettings request. When the results of a\n ListAccountSettings request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when\n there are no more results to return.

" } + }, + "settings": { + "target": "com.amazonaws.ecs#Settings", + "traits": { + "smithy.api#documentation": "

The account settings for the resource.

" + } } } }, @@ -3909,41 +3909,41 @@ "com.amazonaws.ecs#ListAttributesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.ecs#BoxedInteger", + "targetType": { + "target": "com.amazonaws.ecs#TargetType", "traits": { - "smithy.api#documentation": "

The maximum number of cluster results returned by ListAttributes in\n paginated output. When this parameter is used, ListAttributes only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListAttributes request with the returned nextToken\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListAttributes returns up to\n 100 results and a nextToken value if applicable.

" + "smithy.api#documentation": "

The type of the target with which to list attributes.

", + "smithy.api#required": {} } }, - "nextToken": { + "attributeValue": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListAttributes request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults was provided, it is possible the number of results\n to be fewer than maxResults.

\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 value of the attribute with which to filter results. You must also specify an\n attribute name to use this parameter.

" } }, - "cluster": { + "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The nextToken value returned from a ListAttributes request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults was provided, it is possible the number of results\n to be fewer than maxResults.

\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 " } }, - "attributeName": { - "target": "com.amazonaws.ecs#String", + "maxResults": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The name of the attribute with which to filter the results.

" + "smithy.api#documentation": "

The maximum number of cluster results returned by ListAttributes in\n paginated output. When this parameter is used, ListAttributes only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListAttributes request with the returned nextToken\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListAttributes returns up to\n 100 results and a nextToken value if applicable.

" } }, - "attributeValue": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value of the attribute with which to filter results. You must also specify an\n attribute name to use this parameter.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n If you do not specify a cluster, the default cluster is assumed.

" } }, - "targetType": { - "target": "com.amazonaws.ecs#TargetType", + "attributeName": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The type of the target with which to list attributes.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the attribute with which to filter the results.

" } } } @@ -3951,17 +3951,17 @@ "com.amazonaws.ecs#ListAttributesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future ListAttributes\n request. When the results of a ListAttributes request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" - } - }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "

A list of attribute objects that meet the criteria of the request.

" } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListAttributes\n request. When the results of a ListAttributes request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } } } }, @@ -3995,36 +3995,36 @@ } }, "com.amazonaws.ecs#ListClustersRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of cluster results returned by ListClusters in\n paginated output. When this parameter is used, ListClusters only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListClusters request with the returned nextToken\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListClusters returns up to\n 100 results and a nextToken value if applicable.

" - } - }, + "type": "structure", + "members": { "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The nextToken value returned from a ListClusters request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults was provided, it is possible the number of results\n to be fewer than maxResults.

\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 " } + }, + "maxResults": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of cluster results returned by ListClusters in\n paginated output. When this parameter is used, ListClusters only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListClusters request with the returned nextToken\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListClusters returns up to\n 100 results and a nextToken value if applicable.

" + } } } }, "com.amazonaws.ecs#ListClustersResponse": { "type": "structure", "members": { - "clusterArns": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your\n account.

" - } - }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The nextToken value to include in a future ListClusters\n request. When the results of a ListClusters request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" } + }, + "clusterArns": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your\n account.

" + } } } }, @@ -4063,22 +4063,16 @@ "com.amazonaws.ecs#ListContainerInstancesRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.ecs#ContainerInstanceStatus", - "traits": { - "smithy.api#documentation": "

Filters the container instances by status. For example, if you specify the\n DRAINING status, the results include only container instances that have\n been set to DRAINING using UpdateContainerInstancesState.\n If you do not specify this parameter, the default is to include container instances set\n to all states other than INACTIVE.

" - } - }, "filter": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

You can filter the results of a ListContainerInstances operation with\n cluster query language statements. For more information, see Cluster Query Language in the\n Amazon Elastic Container Service Developer Guide.

" } }, - "cluster": { + "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n list. If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The nextToken value returned from a ListContainerInstances\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults was provided, it is possible the number\n of results to be fewer than maxResults.

\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 " } }, "maxResults": { @@ -4087,10 +4081,16 @@ "smithy.api#documentation": "

The maximum number of container instance results returned by\n ListContainerInstances in paginated output. When this parameter is\n used, ListContainerInstances only returns maxResults results\n in a single page along with a nextToken response element. The remaining\n results of the initial request can be seen by sending another\n ListContainerInstances request with the returned nextToken\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListContainerInstances returns up to\n 100 results and a nextToken value if applicable.

" } }, - "nextToken": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListContainerInstances\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults was provided, it is possible the number\n of results to be fewer than maxResults.

\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 short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n list. If you do not specify a cluster, the default cluster is assumed.

" + } + }, + "status": { + "target": "com.amazonaws.ecs#ContainerInstanceStatus", + "traits": { + "smithy.api#documentation": "

Filters the container instances by status. For example, if you specify the\n DRAINING status, the results include only container instances that have\n been set to DRAINING using UpdateContainerInstancesState.\n If you do not specify this parameter, the default is to include container instances set\n to all states other than INACTIVE.

" } } } @@ -4147,10 +4147,16 @@ "com.amazonaws.ecs#ListServicesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.ecs#BoxedInteger", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The maximum number of service results returned by ListServices in\n paginated output. When this parameter is used, ListServices only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListServices request with the returned nextToken\n value. This value can be between 1 and 100. If\n this parameter is not used, then ListServices returns up to\n 10 results and a nextToken value if\n applicable.

" + "smithy.api#documentation": "

The launch type for the services to list.

" + } + }, + "schedulingStrategy": { + "target": "com.amazonaws.ecs#SchedulingStrategy", + "traits": { + "smithy.api#documentation": "

The scheduling strategy for services to list.

" } }, "cluster": { @@ -4165,16 +4171,10 @@ "smithy.api#documentation": "

The nextToken value returned from a ListServices request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults was provided, it is possible the number of results\n to be fewer than maxResults.

\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 " } }, - "schedulingStrategy": { - "target": "com.amazonaws.ecs#SchedulingStrategy", - "traits": { - "smithy.api#documentation": "

The scheduling strategy for services to list.

" - } - }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "maxResults": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The launch type for the services to list.

" + "smithy.api#documentation": "

The maximum number of service results returned by ListServices in\n paginated output. When this parameter is used, ListServices only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListServices request with the returned nextToken\n value. This value can be between 1 and 100. If\n this parameter is not used, then ListServices returns up to\n 10 results and a nextToken value if\n applicable.

" } } } @@ -4182,17 +4182,17 @@ "com.amazonaws.ecs#ListServicesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future ListServices\n request. When the results of a ListServices request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" - } - }, "serviceArns": { "target": "com.amazonaws.ecs#StringList", "traits": { "smithy.api#documentation": "

The list of full ARN entries for each service associated with the specified\n cluster.

" } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListServices\n request. When the results of a ListServices request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } } } }, @@ -4277,16 +4277,16 @@ "com.amazonaws.ecs#ListTaskDefinitionFamiliesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ecs#String", + "status": { + "target": "com.amazonaws.ecs#TaskDefinitionFamilyStatus", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a\n ListTaskDefinitionFamilies request indicating that more results are\n available to fulfill the request and further calls will be needed. If\n maxResults was provided, it is possible the number of results to be\n fewer than maxResults.

\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 task definition family status with which to filter the\n ListTaskDefinitionFamilies results. By default, both\n ACTIVE and INACTIVE task definition families are listed.\n If this parameter is set to ACTIVE, only task definition families that have\n an ACTIVE task definition revision are returned. If this parameter is set\n to INACTIVE, only task definition families that do not have any\n ACTIVE task definition revisions are returned. If you paginate the\n resulting output, be sure to keep the status value constant in each\n subsequent request.

" } }, - "familyPrefix": { + "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The familyPrefix is a string that is used to filter the results of\n ListTaskDefinitionFamilies. If you specify a familyPrefix,\n only task definition family names that begin with the familyPrefix string\n are returned.

" + "smithy.api#documentation": "

The nextToken value returned from a\n ListTaskDefinitionFamilies request indicating that more results are\n available to fulfill the request and further calls will be needed. If\n maxResults was provided, it is possible the number of results to be\n fewer than maxResults.

\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 " } }, "maxResults": { @@ -4295,10 +4295,10 @@ "smithy.api#documentation": "

The maximum number of task definition family results returned by\n ListTaskDefinitionFamilies in paginated output. When this parameter is\n used, ListTaskDefinitions only returns maxResults results in a\n single page along with a nextToken response element. The remaining results\n of the initial request can be seen by sending another\n ListTaskDefinitionFamilies request with the returned\n nextToken value. This value can be between 1 and\n 100. If this parameter is not used, then\n ListTaskDefinitionFamilies returns up to 100 results\n and a nextToken value if applicable.

" } }, - "status": { - "target": "com.amazonaws.ecs#TaskDefinitionFamilyStatus", + "familyPrefix": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The task definition family status with which to filter the\n ListTaskDefinitionFamilies results. By default, both\n ACTIVE and INACTIVE task definition families are listed.\n If this parameter is set to ACTIVE, only task definition families that have\n an ACTIVE task definition revision are returned. If this parameter is set\n to INACTIVE, only task definition families that do not have any\n ACTIVE task definition revisions are returned. If you paginate the\n resulting output, be sure to keep the status value constant in each\n subsequent request.

" + "smithy.api#documentation": "

The familyPrefix is a string that is used to filter the results of\n ListTaskDefinitionFamilies. If you specify a familyPrefix,\n only task definition family names that begin with the familyPrefix string\n are returned.

" } } } @@ -4352,12 +4352,24 @@ "com.amazonaws.ecs#ListTaskDefinitionsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of task definition results returned by\n ListTaskDefinitions in paginated output. When this parameter is used,\n ListTaskDefinitions only returns maxResults results in a\n single page along with a nextToken response element. The remaining results\n of the initial request can be seen by sending another ListTaskDefinitions\n request with the returned nextToken value. This value can be between\n 1 and 100. If this parameter is not used, then\n ListTaskDefinitions returns up to 100 results and a\n nextToken value if applicable.

" + } + }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The nextToken value returned from a ListTaskDefinitions\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults was provided, it is possible the number\n of results to be fewer than maxResults.

\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 " } }, + "familyPrefix": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The full family name with which to filter the ListTaskDefinitions\n results. Specifying a familyPrefix limits the listed task definitions to\n task definition revisions that belong to that family.

" + } + }, "sort": { "target": "com.amazonaws.ecs#SortOrder", "traits": { @@ -4369,18 +4381,6 @@ "traits": { "smithy.api#documentation": "

The task definition status with which to filter the ListTaskDefinitions\n results. By default, only ACTIVE task definitions are listed. By setting\n this parameter to INACTIVE, you can view task definitions that are\n INACTIVE as long as an active task or service still references them. If\n you paginate the resulting output, be sure to keep the status value\n constant in each subsequent request.

" } - }, - "maxResults": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of task definition results returned by\n ListTaskDefinitions in paginated output. When this parameter is used,\n ListTaskDefinitions only returns maxResults results in a\n single page along with a nextToken response element. The remaining results\n of the initial request can be seen by sending another ListTaskDefinitions\n request with the returned nextToken value. This value can be between\n 1 and 100. If this parameter is not used, then\n ListTaskDefinitions returns up to 100 results and a\n nextToken value if applicable.

" - } - }, - "familyPrefix": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The full family name with which to filter the ListTaskDefinitions\n results. Specifying a familyPrefix limits the listed task definitions to\n task definition revisions that belong to that family.

" - } } } }, @@ -4439,34 +4439,28 @@ "com.amazonaws.ecs#ListTasksRequest": { "type": "structure", "members": { - "startedBy": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The startedBy value with which to filter the task results. Specifying a\n startedBy value limits the results to tasks that were started with that\n value.

" - } - }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The container instance ID or full ARN of the container instance with which to filter\n the ListTasks results. Specifying a containerInstance limits\n the results to tasks that belong to that container instance.

" } }, - "maxResults": { - "target": "com.amazonaws.ecs#BoxedInteger", + "family": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The maximum number of task results returned by ListTasks in paginated\n output. When this parameter is used, ListTasks only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListTasks request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter is\n not used, then ListTasks returns up to 100 results and a\n nextToken value if applicable.

" + "smithy.api#documentation": "

The name of the family with which to filter the ListTasks results.\n Specifying a family limits the results to tasks that belong to that\n family.

" } }, - "nextToken": { + "serviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListTasks request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults was provided, it is possible the number of results\n to be fewer than maxResults.

\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 name of the service with which to filter the ListTasks results.\n Specifying a serviceName limits the results to tasks that belong to that\n service.

" } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "desiredStatus": { + "target": "com.amazonaws.ecs#DesiredStatus", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.\n If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The task desired status with which to filter the ListTasks results.\n Specifying a desiredStatus of STOPPED limits the results to\n tasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n for debugging tasks that are not starting properly or have died or finished. The default\n status filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n status to RUNNING.

\n \n

Although you can filter results based on a desired status of PENDING,\n this does not return any results. Amazon ECS never sets the desired status of a task to\n that value (only a task's lastStatus may have a value of\n PENDING).

\n " } }, "launchType": { @@ -4475,22 +4469,28 @@ "smithy.api#documentation": "

The launch type for services to list.

" } }, - "family": { + "maxResults": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of task results returned by ListTasks in paginated\n output. When this parameter is used, ListTasks only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListTasks request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter is\n not used, then ListTasks returns up to 100 results and a\n nextToken value if applicable.

" + } + }, + "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the family with which to filter the ListTasks results.\n Specifying a family limits the results to tasks that belong to that\n family.

" + "smithy.api#documentation": "

The nextToken value returned from a ListTasks request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults was provided, it is possible the number of results\n to be fewer than maxResults.

\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 " } }, - "serviceName": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the service with which to filter the ListTasks results.\n Specifying a serviceName limits the results to tasks that belong to that\n service.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.\n If you do not specify a cluster, the default cluster is assumed.

" } }, - "desiredStatus": { - "target": "com.amazonaws.ecs#DesiredStatus", + "startedBy": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The task desired status with which to filter the ListTasks results.\n Specifying a desiredStatus of STOPPED limits the results to\n tasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n for debugging tasks that are not starting properly or have died or finished. The default\n status filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n status to RUNNING.

\n \n

Although you can filter results based on a desired status of PENDING,\n this does not return any results. Amazon ECS never sets the desired status of a task to\n that value (only a task's lastStatus may have a value of\n PENDING).

\n " + "smithy.api#documentation": "

The startedBy value with which to filter the task results. Specifying a\n startedBy value limits the results to tasks that were started with that\n value.

" } } } @@ -4515,16 +4515,16 @@ "com.amazonaws.ecs#LoadBalancer": { "type": "structure", "members": { - "targetGroupArn": { + "containerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n task set.

\n

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a\n Classic Load Balancer the target group ARN should be omitted.

\n

For services using the ECS deployment controller, you can specify one or\n multiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n the Amazon Elastic Container Service Developer Guide.

\n

For services using the CODE_DEPLOY deployment controller, you are\n required to define two target groups for the load balancer. For more information, see\n Blue/Green Deployment with CodeDeploy in the\n Amazon Elastic Container Service Developer Guide.

\n \n

If your service's task definition uses the awsvpc network mode (which\n is required for the Fargate launch type), you must choose\n ip as the target type, not instance, when creating\n your target groups because tasks that use the awsvpc network mode are\n associated with an elastic network interface, not an Amazon EC2 instance.

\n " + "smithy.api#documentation": "

The name of the container (as it appears in a container definition) to associate with\n the load balancer.

" } }, - "containerPort": { - "target": "com.amazonaws.ecs#BoxedInteger", + "targetGroupArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The port on the container to associate with the load balancer. This port must\n correspond to a containerPort in the task definition the tasks in the\n service are using. For tasks that use the EC2 launch type, the container\n instance they are launched on must allow ingress traffic on the hostPort of\n the port mapping.

" + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n task set.

\n

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a\n Classic Load Balancer the target group ARN should be omitted.

\n

For services using the ECS deployment controller, you can specify one or\n multiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n the Amazon Elastic Container Service Developer Guide.

\n

For services using the CODE_DEPLOY deployment controller, you are\n required to define two target groups for the load balancer. For more information, see\n Blue/Green Deployment with CodeDeploy in the\n Amazon Elastic Container Service Developer Guide.

\n \n

If your service's task definition uses the awsvpc network mode (which\n is required for the Fargate launch type), you must choose\n ip as the target type, not instance, when creating\n your target groups because tasks that use the awsvpc network mode are\n associated with an elastic network interface, not an Amazon EC2 instance.

\n " } }, "loadBalancerName": { @@ -4533,10 +4533,10 @@ "smithy.api#documentation": "

The name of the load balancer to associate with the Amazon ECS service or task set.

\n

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer\n or a Network Load Balancer the load balancer name parameter should be omitted.

" } }, - "containerName": { - "target": "com.amazonaws.ecs#String", + "containerPort": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The name of the container (as it appears in a container definition) to associate with\n the load balancer.

" + "smithy.api#documentation": "

The port on the container to associate with the load balancer. This port must\n correspond to a containerPort in the task definition the tasks in the\n service are using. For tasks that use the EC2 launch type, the container\n instance they are launched on must allow ingress traffic on the hostPort of\n the port mapping.

" } } }, @@ -4553,10 +4553,11 @@ "com.amazonaws.ecs#LogConfiguration": { "type": "structure", "members": { - "secretOptions": { - "target": "com.amazonaws.ecs#SecretList", + "logDriver": { + "target": "com.amazonaws.ecs#LogDriver", "traits": { - "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying\n Sensitive Data in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The log driver to use for the container. The valid values listed earlier are log\n drivers that the Amazon ECS container agent can communicate with by default.

\n

For tasks using the Fargate launch type, the supported log drivers are\n awslogs, splunk, and awsfirelens.

\n

For tasks using the EC2 launch type, the supported log drivers are\n awslogs, fluentd, gelf,\n json-file, journald,\n logentries,syslog, splunk, and\n awsfirelens.

\n

For more information about using the awslogs log driver, see Using\n the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

\n

For more information about using the awsfirelens log driver, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

\n \n

If you have a custom driver that is not listed, you can fork the Amazon ECS container\n agent project that is available\n on GitHub and customize it to work with that driver. We encourage you to\n submit pull requests for changes that you would like to have included. However, we\n do not currently provide support for running modified copies of this\n software.

\n ", + "smithy.api#required": {} } }, "options": { @@ -4565,11 +4566,10 @@ "smithy.api#documentation": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

" } }, - "logDriver": { - "target": "com.amazonaws.ecs#LogDriver", + "secretOptions": { + "target": "com.amazonaws.ecs#SecretList", "traits": { - "smithy.api#documentation": "

The log driver to use for the container. The valid values listed earlier are log\n drivers that the Amazon ECS container agent can communicate with by default.

\n

For tasks using the Fargate launch type, the supported log drivers are\n awslogs, splunk, and awsfirelens.

\n

For tasks using the EC2 launch type, the supported log drivers are\n awslogs, fluentd, gelf,\n json-file, journald,\n logentries,syslog, splunk, and\n awsfirelens.

\n

For more information about using the awslogs log driver, see Using\n the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

\n

For more information about using the awsfirelens log driver, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

\n \n

If you have a custom driver that is not listed, you can fork the Amazon ECS container\n agent project that is available\n on GitHub and customize it to work with that driver. We encourage you to\n submit pull requests for changes that you would like to have included. However, we\n do not currently provide support for running modified copies of this\n software.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying\n Sensitive Data in the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -4637,16 +4637,16 @@ "smithy.api#documentation": "

Whether or not to enable managed scaling for the capacity provider.

" } }, - "minimumScalingStepSize": { + "maximumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "

The minimum number of container instances that Amazon ECS will scale in or scale out at one\n time. If this parameter is omitted, the default value of 1 is used.

" + "smithy.api#documentation": "

The maximum number of container instances that Amazon ECS will scale in or scale out at one\n time. If this parameter is omitted, the default value of 10000 is\n used.

" } }, - "maximumScalingStepSize": { + "minimumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "

The maximum number of container instances that Amazon ECS will scale in or scale out at one\n time. If this parameter is omitted, the default value of 10000 is\n used.

" + "smithy.api#documentation": "

The minimum number of container instances that Amazon ECS will scale in or scale out at one\n time. If this parameter is omitted, the default value of 1 is used.

" } }, "targetCapacity": { @@ -4725,6 +4725,12 @@ "com.amazonaws.ecs#MountPoint": { "type": "structure", "members": { + "readOnly": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

If this value is true, the container has read-only access to the volume.\n If this value is false, then the container can write to the volume. The\n default value is false.

" + } + }, "containerPath": { "target": "com.amazonaws.ecs#String", "traits": { @@ -4736,12 +4742,6 @@ "traits": { "smithy.api#documentation": "

The name of the volume to mount. Must be a volume name referenced in the\n name parameter of task definition volume.

" } - }, - "readOnly": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "

If this value is true, the container has read-only access to the volume.\n If this value is false, then the container can write to the volume. The\n default value is false.

" - } } }, "traits": { @@ -4757,10 +4757,10 @@ "com.amazonaws.ecs#NetworkBinding": { "type": "structure", "members": { - "protocol": { - "target": "com.amazonaws.ecs#TransportProtocol", + "containerPort": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The protocol used for the network binding.

" + "smithy.api#documentation": "

The port number on the container that is used with the network binding.

" } }, "hostPort": { @@ -4769,17 +4769,17 @@ "smithy.api#documentation": "

The port number on the host that is used with the network binding.

" } }, - "containerPort": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "

The port number on the container that is used with the network binding.

" - } - }, "bindIP": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The IP address that the container is bound to on the container instance.

" } + }, + "protocol": { + "target": "com.amazonaws.ecs#TransportProtocol", + "traits": { + "smithy.api#documentation": "

The protocol used for the network binding.

" + } } }, "traits": { @@ -4809,12 +4809,6 @@ "com.amazonaws.ecs#NetworkInterface": { "type": "structure", "members": { - "privateIpv4Address": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The private IPv4 address for the network interface.

" - } - }, "ipv6Address": { "target": "com.amazonaws.ecs#String", "traits": { @@ -4826,6 +4820,12 @@ "traits": { "smithy.api#documentation": "

The attachment ID for the network interface.

" } + }, + "privateIpv4Address": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The private IPv4 address for the network interface.

" + } } }, "traits": { @@ -4977,17 +4977,17 @@ "com.amazonaws.ecs#PlatformDevice": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.ecs#String", + "type": { + "target": "com.amazonaws.ecs#PlatformDeviceType", "traits": { - "smithy.api#documentation": "

The ID for the GPU(s) on the container instance. The available GPU IDs can also be\n obtained on the container instance in the\n /var/lib/ecs/gpu/nvidia_gpu_info.json file.

", + "smithy.api#documentation": "

The type of device that is available on the container instance. The only supported\n value is GPU.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.ecs#PlatformDeviceType", + "id": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The type of device that is available on the container instance. The only supported\n value is GPU.

", + "smithy.api#documentation": "

The ID for the GPU(s) on the container instance. The available GPU IDs can also be\n obtained on the container instance in the\n /var/lib/ecs/gpu/nvidia_gpu_info.json file.

", "smithy.api#required": {} } } @@ -5046,16 +5046,16 @@ "smithy.api#documentation": "

The protocol used for the port mapping. Valid values are tcp and\n udp. The default is tcp.

" } }, - "containerPort": { + "hostPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container that is bound to the user-specified or automatically\n assigned host port.

\n

If you are using containers in a task with the awsvpc or\n host network mode, exposed ports should be specified using\n containerPort.

\n

If you are using containers in a task with the bridge network mode and\n you specify a container port and not a host port, your container automatically receives\n a host port in the ephemeral port range. For more information, see\n hostPort. Port mappings that are automatically assigned in this way do not\n count toward the 100 reserved ports limit of a container instance.

\n \n

You cannot expose the same container port for multiple protocols. An error will be\n returned if this is attempted.

\n " + "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n

If you are using containers in a task with the awsvpc or\n host network mode, the hostPort can either be left blank\n or set to the same value as the containerPort.

\n

If you are using containers in a task with the bridge network mode, you\n can specify a non-reserved host port for your container port mapping, or you can omit\n the hostPort (or set it to 0) while specifying a\n containerPort and your container automatically receives a port in the\n ephemeral port range for your container instance operating system and Docker\n version.

\n

The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n parameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n used. Do not attempt to specify a host port in the ephemeral port range as these are\n reserved for automatic assignment. In general, ports below 32768 are outside of the\n ephemeral port range.

\n \n

The default ephemeral port range from 49153 through 65535 is always used for\n Docker versions before 1.6.0.

\n \n

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n a running task is also reserved while the task is running (after a task stops, the host\n port is released). The current reserved ports are displayed in the\n remainingResources of DescribeContainerInstances\n output. A container instance can have up to 100 reserved ports at a time, including the\n default reserved ports. Automatically assigned ports don't count toward the 100 reserved\n ports limit.

" } }, - "hostPort": { + "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n

If you are using containers in a task with the awsvpc or\n host network mode, the hostPort can either be left blank\n or set to the same value as the containerPort.

\n

If you are using containers in a task with the bridge network mode, you\n can specify a non-reserved host port for your container port mapping, or you can omit\n the hostPort (or set it to 0) while specifying a\n containerPort and your container automatically receives a port in the\n ephemeral port range for your container instance operating system and Docker\n version.

\n

The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n parameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n used. Do not attempt to specify a host port in the ephemeral port range as these are\n reserved for automatic assignment. In general, ports below 32768 are outside of the\n ephemeral port range.

\n \n

The default ephemeral port range from 49153 through 65535 is always used for\n Docker versions before 1.6.0.

\n \n

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n a running task is also reserved while the task is running (after a task stops, the host\n port is released). The current reserved ports are displayed in the\n remainingResources of DescribeContainerInstances\n output. A container instance can have up to 100 reserved ports at a time, including the\n default reserved ports. Automatically assigned ports don't count toward the 100 reserved\n ports limit.

" + "smithy.api#documentation": "

The port number on the container that is bound to the user-specified or automatically\n assigned host port.

\n

If you are using containers in a task with the awsvpc or\n host network mode, exposed ports should be specified using\n containerPort.

\n

If you are using containers in a task with the bridge network mode and\n you specify a container port and not a host port, your container automatically receives\n a host port in the ephemeral port range. For more information, see\n hostPort. Port mappings that are automatically assigned in this way do not\n count toward the 100 reserved ports limit of a container instance.

\n \n

You cannot expose the same container port for multiple protocols. An error will be\n returned if this is attempted.

\n " } } }, @@ -5093,18 +5093,18 @@ "smithy.api#documentation": "

The set of network configuration parameters to provide the Container Network Interface\n (CNI) plugin, specified as key-value pairs.

\n " } }, - "type": { - "target": "com.amazonaws.ecs#ProxyConfigurationType", - "traits": { - "smithy.api#documentation": "

The proxy type. The only supported value is APPMESH.

" - } - }, "containerName": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "

The name of the container that will serve as the App Mesh proxy.

", "smithy.api#required": {} } + }, + "type": { + "target": "com.amazonaws.ecs#ProxyConfigurationType", + "traits": { + "smithy.api#documentation": "

The proxy type. The only supported value is APPMESH.

" + } } }, "traits": { @@ -5177,17 +5177,17 @@ "com.amazonaws.ecs#PutAccountSettingDefaultRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.ecs#SettingName", + "value": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The resource name for which to modify the account setting. If\n serviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n affected. If taskLongArnFormat is specified, the ARN and resource ID for\n your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n specified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n awsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n instances is affected. If containerInsights is specified, the default\n setting for CloudWatch Container Insights for your clusters is affected.

", + "smithy.api#documentation": "

The account setting value for the specified principal ARN. Accepted values are\n enabled and disabled.

", "smithy.api#required": {} } }, - "value": { - "target": "com.amazonaws.ecs#String", + "name": { + "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The account setting value for the specified principal ARN. Accepted values are\n enabled and disabled.

", + "smithy.api#documentation": "

The resource name for which to modify the account setting. If\n serviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n affected. If taskLongArnFormat is specified, the ARN and resource ID for\n your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n specified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n awsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n instances is affected. If containerInsights is specified, the default\n setting for CloudWatch Container Insights for your clusters is affected.

", "smithy.api#required": {} } } @@ -5266,18 +5266,18 @@ "com.amazonaws.ecs#PutAttributesRequest": { "type": "structure", "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n attributes. If you do not specify a cluster, the default cluster is assumed.

" - } - }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { "smithy.api#documentation": "

The attributes to apply to your resource. You can specify up to 10 custom attributes\n per resource. You can specify up to 10 attributes in a single call.

", "smithy.api#required": {} } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n attributes. If you do not specify a cluster, the default cluster is assumed.

" + } } } }, @@ -5334,17 +5334,17 @@ "smithy.api#required": {} } }, - "capacityProviders": { - "target": "com.amazonaws.ecs#StringList", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of one or more capacity providers to associate with the cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n settings for. If you do not specify a cluster, the default cluster is assumed.

", "smithy.api#required": {} } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "capacityProviders": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n settings for. If you do not specify a cluster, the default cluster is assumed.

", + "smithy.api#documentation": "

The name of one or more capacity providers to associate with the cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

", "smithy.api#required": {} } } @@ -5384,28 +5384,16 @@ "com.amazonaws.ecs#RegisterContainerInstanceRequest": { "type": "structure", "members": { - "containerInstanceArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The ARN of the container instance (if it was previously registered).

" - } - }, - "attributes": { - "target": "com.amazonaws.ecs#Attributes", - "traits": { - "smithy.api#documentation": "

The container instance attributes that this container instance supports.

" - } - }, "versionInfo": { "target": "com.amazonaws.ecs#VersionInfo", "traits": { "smithy.api#documentation": "

The version information for the Amazon ECS container agent and Docker daemon running on the\n container instance.

" } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container\n instance. If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n " } }, "platformDevices": { @@ -5414,10 +5402,10 @@ "smithy.api#documentation": "

The devices that are available on the container instance. The only supported device\n type is a GPU.

" } }, - "instanceIdentityDocument": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The instance identity document for the EC2 instance to register. This document can be\n found by running the following command from the instance: curl\n http://169.254.169.254/latest/dynamic/instance-identity/document/\n

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container\n instance. If you do not specify a cluster, the default cluster is assumed.

" } }, "instanceIdentityDocumentSignature": { @@ -5432,10 +5420,22 @@ "smithy.api#documentation": "

The resources available on the instance.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "containerInstanceArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The ARN of the container instance (if it was previously registered).

" + } + }, + "instanceIdentityDocument": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The instance identity document for the EC2 instance to register. This document can be\n found by running the following command from the instance: curl\n http://169.254.169.254/latest/dynamic/instance-identity/document/\n

" + } + }, + "attributes": { + "target": "com.amazonaws.ecs#Attributes", + "traits": { + "smithy.api#documentation": "

The container instance attributes that this container instance supports.

" } } } @@ -5477,30 +5477,40 @@ "com.amazonaws.ecs#RegisterTaskDefinitionRequest": { "type": "structure", "members": { - "pidMode": { - "target": "com.amazonaws.ecs#PidMode", + "family": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " + "smithy.api#documentation": "

You must specify a family for a task definition, which allows you to\n track multiple versions of the same task definition. The family is used as\n a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "taskRoleArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task definition to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n assume. All containers in this task are granted the permissions that are specified in\n this role. For more information, see IAM Roles for\n Tasks in the Amazon Elastic Container Service Developer Guide.

" } }, - "requiresCompatibilities": { - "target": "com.amazonaws.ecs#CompatibilityList", + "volumes": { + "target": "com.amazonaws.ecs#VolumeList", "traits": { - "smithy.api#documentation": "

The launch type required by the task. If no value is specified, it defaults to\n EC2.

" + "smithy.api#documentation": "

A list of volume definitions in JSON format that containers in your task may\n use.

" } }, - "memory": { + "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount of memory (in MiB) used by the task. It can be expressed as an integer\n using MiB, for example 1024, or as a string using GB, for example\n 1GB or 1 GB, in a task definition. String values are\n converted to an integer indicating the MiB when the task definition is\n registered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n recommend specifying container-level resources for Windows containers.

\n \n

If using the EC2 launch type, this field is optional.

\n

If using the Fargate launch type, this field is required and you must\n use one of the following values, which determines your range of supported values for the\n cpu parameter:

\n " + "smithy.api#documentation": "

The number of CPU units used by the task. It can be expressed as an integer using CPU\n units, for example 1024, or as a string using vCPUs, for example 1\n vCPU or 1 vcpu, in a task definition. String values are\n converted to an integer indicating the CPU units when the task definition is\n registered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n recommend specifying container-level resources for Windows containers.

\n \n

If you are using the EC2 launch type, this field is optional. Supported\n values are between 128 CPU units (0.125 vCPUs) and\n 10240 CPU units (10 vCPUs).

\n

If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the memory parameter:

\n " + } + }, + "requiresCompatibilities": { + "target": "com.amazonaws.ecs#CompatibilityList", + "traits": { + "smithy.api#documentation": "

The launch type required by the task. If no value is specified, it defaults to\n EC2.

" } }, + "proxyConfiguration": { + "target": "com.amazonaws.ecs#ProxyConfiguration" + }, "placementConstraints": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { @@ -5513,6 +5523,12 @@ "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n The default Docker network mode is bridge. If you are using the\n Fargate launch type, the awsvpc network mode is required. If\n you are using the EC2 launch type, any network mode can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.

\n

With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.

\n

If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.

\n \n

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init package, or AWS Fargate infrastructure support the\n awsvpc network mode.

\n \n

If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.

\n

Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the network mode object.

\n

For more information, see Network\n settings in the Docker run reference.

" } }, + "inferenceAccelerators": { + "target": "com.amazonaws.ecs#InferenceAccelerators", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerators to use for the containers in the task.

" + } + }, "containerDefinitions": { "target": "com.amazonaws.ecs#ContainerDefinitions", "traits": { @@ -5520,22 +5536,22 @@ "smithy.api#required": {} } }, - "ipcMode": { - "target": "com.amazonaws.ecs#IpcMode", + "memory": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " + "smithy.api#documentation": "

The amount of memory (in MiB) used by the task. It can be expressed as an integer\n using MiB, for example 1024, or as a string using GB, for example\n 1GB or 1 GB, in a task definition. String values are\n converted to an integer indicating the MiB when the task definition is\n registered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n recommend specifying container-level resources for Windows containers.

\n \n

If using the EC2 launch type, this field is optional.

\n

If using the Fargate launch type, this field is required and you must\n use one of the following values, which determines your range of supported values for the\n cpu parameter:

\n " } }, - "inferenceAccelerators": { - "target": "com.amazonaws.ecs#InferenceAccelerators", + "ipcMode": { + "target": "com.amazonaws.ecs#IpcMode", "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerators to use for the containers in the task.

" + "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " } }, - "volumes": { - "target": "com.amazonaws.ecs#VolumeList", + "pidMode": { + "target": "com.amazonaws.ecs#PidMode", "traits": { - "smithy.api#documentation": "

A list of volume definitions in JSON format that containers in your task may\n use.

" + "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " } }, "executionRoleArn": { @@ -5544,26 +5560,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make AWS API calls on your behalf. The task execution IAM role is required\n depending on the requirements of your task. For more information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.

" } }, - "cpu": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task. It can be expressed as an integer using CPU\n units, for example 1024, or as a string using vCPUs, for example 1\n vCPU or 1 vcpu, in a task definition. String values are\n converted to an integer indicating the CPU units when the task definition is\n registered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n recommend specifying container-level resources for Windows containers.

\n \n

If you are using the EC2 launch type, this field is optional. Supported\n values are between 128 CPU units (0.125 vCPUs) and\n 10240 CPU units (10 vCPUs).

\n

If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the memory parameter:

\n " - } - }, - "proxyConfiguration": { - "target": "com.amazonaws.ecs#ProxyConfiguration" - }, - "taskRoleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n assume. All containers in this task are granted the permissions that are specified in\n this role. For more information, see IAM Roles for\n Tasks in the Amazon Elastic Container Service Developer Guide.

" - } - }, - "family": { - "target": "com.amazonaws.ecs#String", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

You must specify a family for a task definition, which allows you to\n track multiple versions of the same task definition. The family is used as\n a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The metadata that you apply to the task definition to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } } } @@ -5571,17 +5571,17 @@ "com.amazonaws.ecs#RegisterTaskDefinitionResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "

The list of tags associated with the task definition.

" - } - }, "taskDefinition": { "target": "com.amazonaws.ecs#TaskDefinition", "traits": { "smithy.api#documentation": "

The full description of the registered task definition.

" } + }, + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "

The list of tags associated with the task definition.

" + } } } }, @@ -5609,22 +5609,16 @@ "com.amazonaws.ecs#Resource": { "type": "structure", "members": { - "stringSetValue": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "

When the stringSetValue type is set, the value of the resource must be a\n string type.

" - } - }, - "longValue": { - "target": "com.amazonaws.ecs#Long", + "name": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

When the longValue type is set, the value of the resource must be an\n extended precision floating-point type.

" + "smithy.api#documentation": "

The name of the resource, such as CPU, MEMORY,\n PORTS, PORTS_UDP, or a user-defined resource.

" } }, - "type": { - "target": "com.amazonaws.ecs#String", + "integerValue": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The type of the resource, such as INTEGER, DOUBLE,\n LONG, or STRINGSET.

" + "smithy.api#documentation": "

When the integerValue type is set, the value of the resource must be an\n integer.

" } }, "doubleValue": { @@ -5633,16 +5627,22 @@ "smithy.api#documentation": "

When the doubleValue type is set, the value of the resource must be a\n double precision floating-point type.

" } }, - "name": { + "type": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the resource, such as CPU, MEMORY,\n PORTS, PORTS_UDP, or a user-defined resource.

" + "smithy.api#documentation": "

The type of the resource, such as INTEGER, DOUBLE,\n LONG, or STRINGSET.

" } }, - "integerValue": { - "target": "com.amazonaws.ecs#Integer", + "stringSetValue": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

When the integerValue type is set, the value of the resource must be an\n integer.

" + "smithy.api#documentation": "

When the stringSetValue type is set, the value of the resource must be a\n string type.

" + } + }, + "longValue": { + "target": "com.amazonaws.ecs#Long", + "traits": { + "smithy.api#documentation": "

When the longValue type is set, the value of the resource must be an\n extended precision floating-point type.

" } } }, @@ -5767,101 +5767,101 @@ "com.amazonaws.ecs#RunTaskRequest": { "type": "structure", "members": { - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", + "taskDefinition": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of five\n strategy rules per task.

" + "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to run. If a revision is not specified,\n the latest ACTIVE revision is used.

", + "smithy.api#required": {} } }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The network configuration for the task. This parameter is required for task\n definitions that use the awsvpc network mode to receive their own elastic\n network interface, and it is not supported for other network modes. For more\n information, see Task Networking\n in the Amazon Elastic Container Service Developer Guide.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "platformVersion": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The platform version the task should run. A platform version is only specified for\n tasks using the Fargate launch type. If one is not specified, the\n LATEST platform version is used by default. For more information, see\n AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or\n launchType is specified, the\n defaultCapacityProviderStrategy for the cluster is used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no\n value is specified, the tags are not propagated. Tags can only be propagated to the task\n during task creation. To add tags to a task after task creation, use the TagResource API action.

\n \n

An error will be received if you specify the SERVICE option when\n running a task.

\n " } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "group": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The launch type on which to run your task. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

\n

If a launchType is specified, the capacityProviderStrategy\n parameter must be omitted.

" + "smithy.api#documentation": "

The name of the task group to associate with the task. The default value is the family\n name of the task definition (for example, family:my-family-name).

" } }, - "propagateTags": { - "target": "com.amazonaws.ecs#PropagateTags", + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no\n value is specified, the tags are not propagated. Tags can only be propagated to the task\n during task creation. To add tags to a task after task creation, use the TagResource API action.

\n \n

An error will be received if you specify the SERVICE option when\n running a task.

\n " + "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of five\n strategy rules per task.

" } }, - "overrides": { - "target": "com.amazonaws.ecs#TaskOverride", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n the specified task definition and the overrides it should receive. You can override the\n default command for a container (that is specified in the task definition or Docker\n image) with a command override. You can also override existing environment\n variables (that are specified in the task definition or Docker image) on a container or\n add new environment variables to it with an environment override.

\n \n

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n formatting characters of the override structure.

\n " + "smithy.api#documentation": "

The launch type on which to run your task. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

\n

If a launchType is specified, the capacityProviderStrategy\n parameter must be omitted.

" } }, - "referenceId": { - "target": "com.amazonaws.ecs#String", + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

The reference ID to use for the task.

" + "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n constraints per task (including constraints in the task definition and those specified\n at runtime).

" } }, - "startedBy": { - "target": "com.amazonaws.ecs#String", + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n trigger a task to run a batch process job, you could apply a unique identifier for that\n job to your task with the startedBy parameter. You can then identify which\n tasks belong to that job by filtering the results of a ListTasks call\n with the startedBy value. Up to 36 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.

\n

If a task is started by an Amazon ECS service, then the startedBy parameter\n contains the deployment ID of the service that starts it.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or\n launchType is specified, the\n defaultCapacityProviderStrategy for the cluster is used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

" } }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", + "count": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The network configuration for the task. This parameter is required for task\n definitions that use the awsvpc network mode to receive their own elastic\n network interface, and it is not supported for other network modes. For more\n information, see Task Networking\n in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The number of instantiations of the specified task to place on your cluster. You can\n specify up to 10 tasks per call.

" } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.\n If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.

" } }, - "group": { + "referenceId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the task group to associate with the task. The default value is the family\n name of the task definition (for example, family:my-family-name).

" + "smithy.api#documentation": "

The reference ID to use for the task.

" } }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n constraints per task (including constraints in the task definition and those specified\n at runtime).

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.\n If you do not specify a cluster, the default cluster is assumed.

" } }, - "taskDefinition": { + "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to run. If a revision is not specified,\n the latest ACTIVE revision is used.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n trigger a task to run a batch process job, you could apply a unique identifier for that\n job to your task with the startedBy parameter. You can then identify which\n tasks belong to that job by filtering the results of a ListTasks call\n with the startedBy value. Up to 36 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.

\n

If a task is started by an Amazon ECS service, then the startedBy parameter\n contains the deployment ID of the service that starts it.

" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "overrides": { + "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

The platform version the task should run. A platform version is only specified for\n tasks using the Fargate launch type. If one is not specified, the\n LATEST platform version is used by default. For more information, see\n AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n the specified task definition and the overrides it should receive. You can override the\n default command for a container (that is specified in the task definition or Docker\n image) with a command override. You can also override existing environment\n variables (that are specified in the task definition or Docker image) on a container or\n add new environment variables to it with an environment override.

\n \n

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n formatting characters of the override structure.

\n " } }, - "count": { - "target": "com.amazonaws.ecs#BoxedInteger", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The number of instantiations of the specified task to place on your cluster. You can\n specify up to 10 tasks per call.

" + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } } } @@ -5869,34 +5869,34 @@ "com.amazonaws.ecs#RunTaskResponse": { "type": "structure", "members": { - "tasks": { - "target": "com.amazonaws.ecs#Tasks", - "traits": { - "smithy.api#documentation": "

A full description of the tasks that were run. The tasks that were successfully placed\n on your cluster are described here.

" - } - }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "

Any failures associated with the call.

" } + }, + "tasks": { + "target": "com.amazonaws.ecs#Tasks", + "traits": { + "smithy.api#documentation": "

A full description of the tasks that were run. The tasks that were successfully placed\n on your cluster are described here.

" + } } } }, "com.amazonaws.ecs#Scale": { "type": "structure", "members": { - "unit": { - "target": "com.amazonaws.ecs#ScaleUnit", - "traits": { - "smithy.api#documentation": "

The unit of measure for the scale value.

" - } - }, "value": { "target": "com.amazonaws.ecs#Double", "traits": { "smithy.api#documentation": "

The value, specified as a percent total of a service's desiredCount, to\n scale the task set. Accepted values are numbers between 0 and 100.

" } + }, + "unit": { + "target": "com.amazonaws.ecs#ScaleUnit", + "traits": { + "smithy.api#documentation": "

The unit of measure for the scale value.

" + } } }, "traits": { @@ -5987,28 +5987,40 @@ "com.amazonaws.ecs#Service": { "type": "structure", "members": { - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The placement constraints for the tasks in the service.

" + "smithy.api#documentation": "

The placement strategy that determines how tasks for the service are placed.

" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "taskSets": { + "target": "com.amazonaws.ecs#TaskSets", "traits": { - "smithy.api#documentation": "

The capacity provider strategy associated with the service.

" + "smithy.api#documentation": "

Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL\n deployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n many tasks are running, and whether the task set serves production traffic.

" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "status": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The launch type on which your service is running. If no value is specified, it will\n default to EC2. Valid values include EC2 and\n FARGATE. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The status of the service. The valid values are ACTIVE,\n DRAINING, or INACTIVE.

" } }, - "healthCheckGracePeriodSeconds": { - "target": "com.amazonaws.ecs#BoxedInteger", + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n Elastic Load Balancing target health checks after a task has first started.

" + "smithy.api#documentation": "

The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.

" + } + }, + "schedulingStrategy": { + "target": "com.amazonaws.ecs#SchedulingStrategy", + "traits": { + "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n

There are two service scheduler strategies available:

\n " + } + }, + "serviceName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n a cluster, but you can have similarly named services in multiple clusters within a\n Region or across multiple Regions.

" } }, "enableECSManagedTags": { @@ -6023,10 +6035,10 @@ "smithy.api#documentation": "

The number of tasks in the cluster that are in the PENDING state.

" } }, - "propagateTags": { - "target": "com.amazonaws.ecs#PropagateTags", + "runningCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n task. If no value is specified, the tags are not propagated.

" + "smithy.api#documentation": "

The number of tasks in the cluster that are in the RUNNING state.

" } }, "desiredCount": { @@ -6035,64 +6047,52 @@ "smithy.api#documentation": "

The desired number of instantiations of the task definition to keep running on the\n service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

" } }, - "deploymentController": { - "target": "com.amazonaws.ecs#DeploymentController", + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The deployment controller type the service is using. When using the DescribeServices\n API, this field is omitted if the service is using the ECS deployment\n controller type.

" + "smithy.api#documentation": "

The Unix timestamp for when the service was created.

" } }, - "createdBy": { + "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The principal that created the service.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.

" + "smithy.api#documentation": "

The task definition to use for tasks in the service. This value is specified when the\n service is created with CreateService, and it can be modified with\n UpdateService.

" } }, - "schedulingStrategy": { - "target": "com.amazonaws.ecs#SchedulingStrategy", + "healthCheckGracePeriodSeconds": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n

There are two service scheduler strategies available:

\n " + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n Elastic Load Balancing target health checks after a task has first started.

" } }, - "status": { - "target": "com.amazonaws.ecs#String", + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The status of the service. The valid values are ACTIVE,\n DRAINING, or INACTIVE.

" + "smithy.api#documentation": "

The capacity provider strategy associated with the service.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The placement constraints for the tasks in the service.

" } }, - "taskSets": { - "target": "com.amazonaws.ecs#TaskSets", + "events": { + "target": "com.amazonaws.ecs#ServiceEvents", "traits": { - "smithy.api#documentation": "

Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL\n deployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n many tasks are running, and whether the task set serves production traffic.

" + "smithy.api#documentation": "

The event stream for your service. A maximum of 100 of the latest events are\n displayed.

" } }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The placement strategy that determines how tasks for the service are placed.

" + "smithy.api#documentation": "

The launch type on which your service is running. If no value is specified, it will\n default to EC2. Valid values include EC2 and\n FARGATE. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" } }, - "serviceName": { + "serviceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n a cluster, but you can have similarly named services in multiple clusters within a\n Region or across multiple Regions.

" - } - }, - "deployments": { - "target": "com.amazonaws.ecs#Deployments", - "traits": { - "smithy.api#documentation": "

The current state of deployments for the service.

" + "smithy.api#documentation": "

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

" } }, "serviceRegistries": { @@ -6101,64 +6101,64 @@ "smithy.api#documentation": "

The details of the service discovery registries to assign to this service. For more\n information, see Service\n Discovery.

" } }, - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", + "roleArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.

" + "smithy.api#documentation": "

The ARN of the IAM role associated with the service that allows the Amazon ECS container\n agent to register container instances with an Elastic Load Balancing load balancer.

" } }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the service was created.

" + "smithy.api#documentation": "

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the\n container name (as it appears in a container definition), and the container port to\n access from the load balancer.

" } }, - "clusterArn": { - "target": "com.amazonaws.ecs#String", + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that hosts the service.

" + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n task. If no value is specified, the tags are not propagated.

" } }, - "events": { - "target": "com.amazonaws.ecs#ServiceEvents", + "createdBy": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The event stream for your service. A maximum of 100 of the latest events are\n displayed.

" + "smithy.api#documentation": "

The principal that created the service.

" } }, - "runningCount": { - "target": "com.amazonaws.ecs#Integer", + "deploymentController": { + "target": "com.amazonaws.ecs#DeploymentController", "traits": { - "smithy.api#documentation": "

The number of tasks in the cluster that are in the RUNNING state.

" + "smithy.api#documentation": "

The deployment controller type the service is using. When using the DescribeServices\n API, this field is omitted if the service is using the ECS deployment\n controller type.

" } }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", + "platformVersion": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the\n container name (as it appears in a container definition), and the container port to\n access from the load balancer.

" + "smithy.api#documentation": "

The platform version on which to run your service. A platform version is only\n specified for tasks using the Fargate launch type. If one is not\n specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" } }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", + "deployments": { + "target": "com.amazonaws.ecs#Deployments", "traits": { - "smithy.api#documentation": "

The task definition to use for tasks in the service. This value is specified when the\n service is created with CreateService, and it can be modified with\n UpdateService.

" + "smithy.api#documentation": "

The current state of deployments for the service.

" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The platform version on which to run your service. A platform version is only\n specified for tasks using the Fargate launch type. If one is not\n specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, - "roleArn": { + "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role associated with the service that allows the Amazon ECS container\n agent to register container instances with an Elastic Load Balancing load balancer.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that hosts the service.

" } }, - "serviceArn": { - "target": "com.amazonaws.ecs#String", + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

" + "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.

" } } }, @@ -6169,12 +6169,6 @@ "com.amazonaws.ecs#ServiceEvent": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the event was triggered.

" - } - }, "message": { "target": "com.amazonaws.ecs#String", "traits": { @@ -6186,6 +6180,12 @@ "traits": { "smithy.api#documentation": "

The ID string of the event.

" } + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the event was triggered.

" + } } }, "traits": { @@ -6248,12 +6248,6 @@ "com.amazonaws.ecs#ServiceRegistry": { "type": "structure", "members": { - "containerName": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The container name value, already specified in the task definition, to be used for\n your service discovery service. If the task definition that your service task specifies\n uses the bridge or host network mode, you must specify a\n containerName and containerPort combination from the task\n definition. If the task definition that your service task specifies uses the\n awsvpc network mode and a type SRV DNS record is used, you must specify\n either a containerName and containerPort combination or a\n port value, but not both.

" - } - }, "registryArn": { "target": "com.amazonaws.ecs#String", "traits": { @@ -6271,6 +6265,12 @@ "traits": { "smithy.api#documentation": "

The port value, already specified in the task definition, to be used for your service\n discovery service. If the task definition your service task specifies uses the\n bridge or host network mode, you must specify a\n containerName and containerPort combination from the task\n definition. If the task definition your service task specifies uses the\n awsvpc network mode and a type SRV DNS record is used, you must specify\n either a containerName and containerPort combination or a\n port value, but not both.

" } + }, + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The container name value, already specified in the task definition, to be used for\n your service discovery service. If the task definition that your service task specifies\n uses the bridge or host network mode, you must specify a\n containerName and containerPort combination from the task\n definition. If the task definition that your service task specifies uses the\n awsvpc network mode and a type SRV DNS record is used, you must specify\n either a containerName and containerPort combination or a\n port value, but not both.

" + } } }, "traits": { @@ -6286,12 +6286,6 @@ "com.amazonaws.ecs#Setting": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

Whether the account setting is enabled or disabled for the specified resource.

" - } - }, "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { @@ -6303,6 +6297,12 @@ "traits": { "smithy.api#documentation": "

The Amazon ECS resource name.

" } + }, + "value": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

Whether the account setting is enabled or disabled for the specified resource.

" + } } }, "traits": { @@ -6401,47 +6401,41 @@ "com.amazonaws.ecs#StartTaskRequest": { "type": "structure", "members": { - "taskDefinition": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to start. If a revision is not specified,\n the latest ACTIVE revision is used.

", - "smithy.api#required": {} - } - }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.\n If you do not specify a cluster, the default cluster is assumed.

" } }, - "cluster": { + "group": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.\n If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The name of the task group to associate with the task. The default value is the family\n name of the task definition (for example, family:my-family-name).

" } }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.

" + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, - "propagateTags": { - "target": "com.amazonaws.ecs#PropagateTags", + "taskDefinition": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n task. If no value is specified, the tags are not propagated.

" + "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to start. If a revision is not specified,\n the latest ACTIVE revision is used.

", + "smithy.api#required": {} } }, - "startedBy": { + "referenceId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n trigger a task to run a batch process job, you could apply a unique identifier for that\n job to your task with the startedBy parameter. You can then identify which\n tasks belong to that job by filtering the results of a ListTasks call\n with the startedBy value. Up to 36 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.

\n

If a task is started by an Amazon ECS service, then the startedBy parameter\n contains the deployment ID of the service that starts it.

" + "smithy.api#documentation": "

The reference ID to use for the task.

" } }, - "overrides": { - "target": "com.amazonaws.ecs#TaskOverride", + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n the specified task definition and the overrides it should receive. You can override the\n default command for a container (that is specified in the task definition or Docker\n image) with a command override. You can also override existing environment\n variables (that are specified in the task definition or Docker image) on a container or\n add new environment variables to it with an environment override.

\n \n

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n formatting characters of the override structure.

\n " + "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.

" } }, "containerInstances": { @@ -6451,22 +6445,28 @@ "smithy.api#required": {} } }, - "group": { + "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the task group to associate with the task. The default value is the family\n name of the task definition (for example, family:my-family-name).

" + "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n trigger a task to run a batch process job, you could apply a unique identifier for that\n job to your task with the startedBy parameter. You can then identify which\n tasks belong to that job by filtering the results of a ListTasks call\n with the startedBy value. Up to 36 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.

\n

If a task is started by an Amazon ECS service, then the startedBy parameter\n contains the deployment ID of the service that starts it.

" } }, - "referenceId": { - "target": "com.amazonaws.ecs#String", + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The reference ID to use for the task.

" + "smithy.api#documentation": "

The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc networking mode.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "overrides": { + "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n the specified task definition and the overrides it should receive. You can override the\n default command for a container (that is specified in the task definition or Docker\n image) with a command override. You can also override existing environment\n variables (that are specified in the task definition or Docker image) on a container or\n add new environment variables to it with an environment override.

\n \n

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n formatting characters of the override structure.

\n " + } + }, + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", + "traits": { + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n task. If no value is specified, the tags are not propagated.

" } } } @@ -6474,17 +6474,17 @@ "com.amazonaws.ecs#StartTaskResponse": { "type": "structure", "members": { - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "

Any failures associated with the call.

" - } - }, "tasks": { "target": "com.amazonaws.ecs#Tasks", "traits": { "smithy.api#documentation": "

A full description of the tasks that were started. Each task that was successfully\n placed on your container instances is described.

" } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "

Any failures associated with the call.

" + } } } }, @@ -6654,16 +6654,10 @@ "com.amazonaws.ecs#SubmitContainerStateChangeRequest": { "type": "structure", "members": { - "networkBindings": { - "target": "com.amazonaws.ecs#NetworkBindings", - "traits": { - "smithy.api#documentation": "

The network bindings of the container.

" - } - }, - "containerName": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the container.

" + "smithy.api#documentation": "

The short name or full ARN of the cluster that hosts the container.

" } }, "reason": { @@ -6678,16 +6672,10 @@ "smithy.api#documentation": "

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

" } }, - "cluster": { + "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full ARN of the cluster that hosts the container.

" - } - }, - "exitCode": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "

The exit code returned for the state change request.

" + "smithy.api#documentation": "

The ID of the Docker container.

" } }, "status": { @@ -6696,10 +6684,22 @@ "smithy.api#documentation": "

The status of the state change request.

" } }, - "runtimeId": { + "networkBindings": { + "target": "com.amazonaws.ecs#NetworkBindings", + "traits": { + "smithy.api#documentation": "

The network bindings of the container.

" + } + }, + "exitCode": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The exit code returned for the state change request.

" + } + }, + "containerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ID of the Docker container.

" + "smithy.api#documentation": "

The name of the container.

" } } } @@ -6744,28 +6744,28 @@ "com.amazonaws.ecs#SubmitTaskStateChangeRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.ecs#String", + "attachments": { + "target": "com.amazonaws.ecs#AttachmentStateChanges", "traits": { - "smithy.api#documentation": "

The status of the state change request.

" + "smithy.api#documentation": "

Any attachments associated with the state change request.

" } }, - "executionStoppedAt": { + "pullStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task execution stopped.

" + "smithy.api#documentation": "

The Unix timestamp for when the container image pull completed.

" } }, - "cluster": { + "task": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

" + "smithy.api#documentation": "

The task ID or full ARN of the task in the state change request.

" } }, - "attachments": { - "target": "com.amazonaws.ecs#AttachmentStateChanges", + "reason": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Any attachments associated with the state change request.

" + "smithy.api#documentation": "

The reason for the state change request.

" } }, "containers": { @@ -6774,10 +6774,10 @@ "smithy.api#documentation": "

Any containers associated with the state change request.

" } }, - "reason": { + "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The reason for the state change request.

" + "smithy.api#documentation": "

The status of the state change request.

" } }, "pullStartedAt": { @@ -6786,16 +6786,16 @@ "smithy.api#documentation": "

The Unix timestamp for when the container image pull began.

" } }, - "pullStoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container image pull completed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

" } }, - "task": { - "target": "com.amazonaws.ecs#String", + "executionStoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The task ID or full ARN of the task in the state change request.

" + "smithy.api#documentation": "

The Unix timestamp for when the task execution stopped.

" } } } @@ -6814,16 +6814,16 @@ "com.amazonaws.ecs#SystemControl": { "type": "structure", "members": { - "namespace": { + "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The namespaced kernel parameter for which to set a value.

" + "smithy.api#documentation": "

The value for the namespaced kernel parameter specified in\n namespace.

" } }, - "value": { + "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value for the namespaced kernel parameter specified in\n namespace.

" + "smithy.api#documentation": "

The namespaced kernel parameter for which to set a value.

" } } }, @@ -6905,17 +6905,17 @@ "com.amazonaws.ecs#TagResourceRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.ecs#Tags", + "resourceArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

\n

The following basic restrictions apply to tags:

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources\n are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n instances.

", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.ecs#String", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources\n are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n instances.

", + "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

\n

The following basic restrictions apply to tags:

\n ", "smithy.api#required": {} } } @@ -6973,190 +6973,190 @@ "com.amazonaws.ecs#Task": { "type": "structure", "members": { - "taskDefinitionArn": { + "taskArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the task definition that creates the task.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task.

" } }, - "lastStatus": { - "target": "com.amazonaws.ecs#String", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The last known status of the task. For more information, see Task\n Lifecycle.

" + "smithy.api#documentation": "

The launch type on which your task is running. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" } }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", + "attachments": { + "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task was created (the task entered the\n PENDING state).

" + "smithy.api#documentation": "

The Elastic Network Adapter associated with the task if the task uses the\n awsvpc network mode.

" } }, - "stoppingAt": { - "target": "com.amazonaws.ecs#Timestamp", + "platformVersion": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task stops (transitions from the RUNNING\n state to STOPPED).

" + "smithy.api#documentation": "

The platform version on which your task is running. A platform version is only\n specified for tasks using the Fargate launch type. If one is not\n specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" } }, - "stoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", + "clusterArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task was stopped (the task transitioned from the\n RUNNING state to the STOPPED state).

" + "smithy.api#documentation": "

The ARN of the cluster that hosts the task.

" } }, - "desiredStatus": { + "capacityProviderName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The desired status of the task. For more information, see Task\n Lifecycle.

" + "smithy.api#documentation": "

The capacity provider associated with the task.

" } }, - "startedBy": { + "executionStoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the task execution stopped.

" + } + }, + "availabilityZone": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The tag specified when a task is started. If the task is started by an Amazon ECS service,\n then the startedBy parameter contains the deployment ID of the service that\n starts it.

" + "smithy.api#documentation": "

The availability zone of the task.

" } }, - "pullStoppedAt": { + "startedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container image pull completed.

" + "smithy.api#documentation": "

The Unix timestamp for when the task started (the task transitioned from the\n PENDING state to the RUNNING state).

" } }, - "connectivity": { - "target": "com.amazonaws.ecs#Connectivity", + "stoppedReason": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The connectivity status of a task.

" + "smithy.api#documentation": "

The reason that the task was stopped.

" } }, - "connectivityAt": { - "target": "com.amazonaws.ecs#Timestamp", + "containers": { + "target": "com.amazonaws.ecs#Containers", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task last went into CONNECTED\n status.

" + "smithy.api#documentation": "

The containers associated with the task.

" } }, - "pullStartedAt": { - "target": "com.amazonaws.ecs#Timestamp", + "attributes": { + "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container image pull began.

" + "smithy.api#documentation": "

The attributes of the task

" } }, - "memory": { + "taskDefinitionArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount of memory (in MiB) used by the task as expressed in a task definition. It\n can be expressed as an integer using MiB, for example 1024. It can also be\n expressed as a string using GB, for example 1GB or 1 GB.\n String values are converted to an integer indicating the MiB when the task definition is\n registered.

\n

If you are using the EC2 launch type, this field is optional.

\n

If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the cpu parameter:

\n " + "smithy.api#documentation": "

The ARN of the task definition that creates the task.

" } }, - "version": { - "target": "com.amazonaws.ecs#Long", + "lastStatus": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The version counter for the task. Every time a task experiences a change that triggers\n a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task\n state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n actions with the version reported in CloudWatch Events for the task (inside the\n detail object) to verify that the version in your event stream is\n current.

" + "smithy.api#documentation": "

The last known status of the task. For more information, see Task\n Lifecycle.

" } }, "stopCode": { "target": "com.amazonaws.ecs#TaskStopCode", "traits": { - "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason may\n contain additional details.

" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason may\n contain additional details.

" } }, - "executionStoppedAt": { + "stoppingAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task execution stopped.

" + "smithy.api#documentation": "

The Unix timestamp for when the task stops (transitions from the RUNNING\n state to STOPPED).

" } }, - "availabilityZone": { + "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The availability zone of the task.

" + "smithy.api#documentation": "

The amount of memory (in MiB) used by the task as expressed in a task definition. It\n can be expressed as an integer using MiB, for example 1024. It can also be\n expressed as a string using GB, for example 1GB or 1 GB.\n String values are converted to an integer indicating the MiB when the task definition is\n registered.

\n

If you are using the EC2 launch type, this field is optional.

\n

If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the cpu parameter:

\n " } }, - "attributes": { - "target": "com.amazonaws.ecs#Attributes", + "overrides": { + "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

The attributes of the task

" + "smithy.api#documentation": "

One or more container overrides.

" } }, - "healthStatus": { - "target": "com.amazonaws.ecs#HealthStatus", + "connectivityAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The health status for the task, which is determined by the health of the essential\n containers in the task. If all essential containers in the task are reporting as\n HEALTHY, then the task status also reports as HEALTHY. If\n any essential containers in the task are reporting as UNHEALTHY or\n UNKNOWN, then the task status also reports as UNHEALTHY or\n UNKNOWN, accordingly.

\n \n

The Amazon ECS container agent does not monitor or report on Docker health checks that\n are embedded in a container image (such as those specified in a parent image or from\n the image's Dockerfile) and not specified in the container definition. Health check\n parameters that are specified in a container definition override any Docker health\n checks that exist in the container image.

\n " + "smithy.api#documentation": "

The Unix timestamp for when the task last went into CONNECTED\n status.

" } }, - "clusterArn": { + "desiredStatus": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the cluster that hosts the task.

" + "smithy.api#documentation": "

The desired status of the task. For more information, see Task\n Lifecycle.

" } }, - "containerInstanceArn": { - "target": "com.amazonaws.ecs#String", + "inferenceAccelerators": { + "target": "com.amazonaws.ecs#InferenceAccelerators", "traits": { - "smithy.api#documentation": "

The ARN of the container instances that host the task.

" + "smithy.api#documentation": "

The Elastic Inference accelerator associated with the task.

" } }, - "startedAt": { - "target": "com.amazonaws.ecs#Timestamp", + "startedBy": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task started (the task transitioned from the\n PENDING state to the RUNNING state).

" + "smithy.api#documentation": "

The tag specified when a task is started. If the task is started by an Amazon ECS service,\n then the startedBy parameter contains the deployment ID of the service that\n starts it.

" } }, - "taskArn": { - "target": "com.amazonaws.ecs#String", + "pullStoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task.

" + "smithy.api#documentation": "

The Unix timestamp for when the container image pull completed.

" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "healthStatus": { + "target": "com.amazonaws.ecs#HealthStatus", "traits": { - "smithy.api#documentation": "

The platform version on which your task is running. A platform version is only\n specified for tasks using the Fargate launch type. If one is not\n specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The health status for the task, which is determined by the health of the essential\n containers in the task. If all essential containers in the task are reporting as\n HEALTHY, then the task status also reports as HEALTHY. If\n any essential containers in the task are reporting as UNHEALTHY or\n UNKNOWN, then the task status also reports as UNHEALTHY or\n UNKNOWN, accordingly.

\n \n

The Amazon ECS container agent does not monitor or report on Docker health checks that\n are embedded in a container image (such as those specified in a parent image or from\n the image's Dockerfile) and not specified in the container definition. Health check\n parameters that are specified in a container definition override any Docker health\n checks that exist in the container image.

\n " } }, - "stoppedReason": { - "target": "com.amazonaws.ecs#String", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The reason that the task was stopped.

" + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, - "containers": { - "target": "com.amazonaws.ecs#Containers", + "version": { + "target": "com.amazonaws.ecs#Long", "traits": { - "smithy.api#documentation": "

The containers associated with the task.

" + "smithy.api#documentation": "

The version counter for the task. Every time a task experiences a change that triggers\n a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task\n state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n actions with the version reported in CloudWatch Events for the task (inside the\n detail object) to verify that the version in your event stream is\n current.

" } }, - "capacityProviderName": { - "target": "com.amazonaws.ecs#String", + "stoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The capacity provider associated with the task.

" + "smithy.api#documentation": "

The Unix timestamp for when the task was stopped (the task transitioned from the\n RUNNING state to the STOPPED state).

" } }, - "inferenceAccelerators": { - "target": "com.amazonaws.ecs#InferenceAccelerators", + "cpu": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerator associated with the task.

" + "smithy.api#documentation": "

The number of CPU units used by the task as expressed in a task definition. It can be\n expressed as an integer using CPU units, for example 1024. It can also be\n expressed as a string using vCPUs, for example 1 vCPU or 1\n vcpu. String values are converted to an integer indicating the CPU units when\n the task definition is registered.

\n

If you are using the EC2 launch type, this field is optional. Supported\n values are between 128 CPU units (0.125 vCPUs) and\n 10240 CPU units (10 vCPUs).

\n

If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the memory parameter:

\n " } }, - "attachments": { - "target": "com.amazonaws.ecs#Attachments", + "pullStartedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Elastic Network Adapter associated with the task if the task uses the\n awsvpc network mode.

" + "smithy.api#documentation": "

The Unix timestamp for when the container image pull began.

" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "connectivity": { + "target": "com.amazonaws.ecs#Connectivity", "traits": { - "smithy.api#documentation": "

The launch type on which your task is running. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The connectivity status of a task.

" } }, - "overrides": { - "target": "com.amazonaws.ecs#TaskOverride", + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

One or more container overrides.

" + "smithy.api#documentation": "

The Unix timestamp for when the task was created (the task entered the\n PENDING state).

" } }, "group": { @@ -7165,10 +7165,10 @@ "smithy.api#documentation": "

The name of the task group associated with the task.

" } }, - "cpu": { + "containerInstanceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task as expressed in a task definition. It can be\n expressed as an integer using CPU units, for example 1024. It can also be\n expressed as a string using vCPUs, for example 1 vCPU or 1\n vcpu. String values are converted to an integer indicating the CPU units when\n the task definition is registered.

\n

If you are using the EC2 launch type, this field is optional. Supported\n values are between 128 CPU units (0.125 vCPUs) and\n 10240 CPU units (10 vCPUs).

\n

If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the memory parameter:

\n " + "smithy.api#documentation": "

The ARN of the container instances that host the task.

" } } }, @@ -7179,22 +7179,16 @@ "com.amazonaws.ecs#TaskDefinition": { "type": "structure", "members": { - "placementConstraints": { - "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", - "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for tasks. This field is not valid if\n you are using the Fargate launch type for your task.

" - } - }, - "networkMode": { - "target": "com.amazonaws.ecs#NetworkMode", + "family": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n The default Docker network mode is bridge. If you are using the\n Fargate launch type, the awsvpc network mode is required. If\n you are using the EC2 launch type, any network mode can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.

\n

With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.

\n

If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.

\n \n

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init package, or AWS Fargate infrastructure support the\n awsvpc network mode.

\n \n

If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.

\n

Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the network mode object.

\n

For more information, see Network\n settings in the Docker run reference.

" + "smithy.api#documentation": "

The name of a family that this task definition is registered to. Up to 255 letters\n (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

\n

A family groups multiple versions of a task definition. Amazon ECS gives the first task\n definition that you registered to a family a revision number of 1. Amazon ECS gives\n sequential revision numbers to each task definition that you add.

" } }, - "requiresAttributes": { - "target": "com.amazonaws.ecs#RequiresAttributes", + "revision": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The container instance attributes required by your task. This field is not valid if\n you are using the Fargate launch type for your task.

" + "smithy.api#documentation": "

The revision of the task in a particular family. The revision is a version number of a\n task definition in a family. When you register a task definition for the first time, the\n revision is 1. Each time that you register a new revision of a task\n definition in the same family, the revision value always increases by one, even if you\n have deregistered previous revisions in this family.

" } }, "requiresCompatibilities": { @@ -7203,22 +7197,22 @@ "smithy.api#documentation": "

The launch type the task requires. If no value is specified, it will default to\n EC2. Valid values include EC2 and\n FARGATE.

" } }, - "cpu": { - "target": "com.amazonaws.ecs#String", + "proxyConfiguration": { + "target": "com.amazonaws.ecs#ProxyConfiguration", "traits": { - "smithy.api#documentation": "

The number of cpu units used by the task. If you are using the EC2 launch\n type, this field is optional and any value can be used. If you are using the Fargate\n launch type, this field is required and you must use one of the following values, which\n determines your range of valid values for the memory parameter:

\n " + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n and at least version 1.26.0-1 of the ecs-init package to enable a proxy\n configuration. If your container instances are launched from the Amazon ECS-optimized AMI\n version 20190301 or later, then they contain the required versions of the\n container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, - "pidMode": { - "target": "com.amazonaws.ecs#PidMode", + "status": { + "target": "com.amazonaws.ecs#TaskDefinitionStatus", "traits": { - "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " + "smithy.api#documentation": "

The status of the task definition.

" } }, - "volumes": { - "target": "com.amazonaws.ecs#VolumeList", + "taskDefinitionArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The list of volume definitions for the task.

\n

If your tasks are using the Fargate launch type, the host\n and sourcePath parameters are not supported.

\n

For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the task definition.

" } }, "taskRoleArn": { @@ -7227,10 +7221,16 @@ "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the\n task permission to call AWS APIs on your behalf. For more information, see Amazon ECS\n Task Role in the Amazon Elastic Container Service Developer Guide.

\n

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option\n is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n configuration code in order to take advantage of the feature. For more information, see\n Windows IAM Roles\n for Tasks in the Amazon Elastic Container Service Developer Guide.

" } }, - "containerDefinitions": { - "target": "com.amazonaws.ecs#ContainerDefinitions", + "pidMode": { + "target": "com.amazonaws.ecs#PidMode", "traits": { - "smithy.api#documentation": "

A list of container definitions in JSON format that describe the different containers\n that make up your task. For more information about container definition parameters and\n defaults, see Amazon ECS Task\n Definitions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " + } + }, + "ipcMode": { + "target": "com.amazonaws.ecs#IpcMode", + "traits": { + "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " } }, "compatibilities": { @@ -7239,10 +7239,10 @@ "smithy.api#documentation": "

The launch type to use with your task. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" } }, - "status": { - "target": "com.amazonaws.ecs#TaskDefinitionStatus", + "requiresAttributes": { + "target": "com.amazonaws.ecs#RequiresAttributes", "traits": { - "smithy.api#documentation": "

The status of the task definition.

" + "smithy.api#documentation": "

The container instance attributes required by your task. This field is not valid if\n you are using the Fargate launch type for your task.

" } }, "inferenceAccelerators": { @@ -7257,40 +7257,40 @@ "smithy.api#documentation": "

The amount (in MiB) of memory used by the task.

\n

If using the EC2 launch type, this field is optional and any value can\n be used. If a task-level memory value is specified then the container-level memory value\n is optional.

\n

If using the Fargate launch type, this field is required and you must\n use one of the following values, which determines your range of valid values for the\n cpu parameter:

\n " } }, - "ipcMode": { - "target": "com.amazonaws.ecs#IpcMode", + "containerDefinitions": { + "target": "com.amazonaws.ecs#ContainerDefinitions", "traits": { - "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

\n " + "smithy.api#documentation": "

A list of container definitions in JSON format that describe the different containers\n that make up your task. For more information about container definition parameters and\n defaults, see Amazon ECS Task\n Definitions in the Amazon Elastic Container Service Developer Guide.

" } }, - "proxyConfiguration": { - "target": "com.amazonaws.ecs#ProxyConfiguration", + "networkMode": { + "target": "com.amazonaws.ecs#NetworkMode", "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n and at least version 1.26.0-1 of the ecs-init package to enable a proxy\n configuration. If your container instances are launched from the Amazon ECS-optimized AMI\n version 20190301 or later, then they contain the required versions of the\n container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n The default Docker network mode is bridge. If you are using the\n Fargate launch type, the awsvpc network mode is required. If\n you are using the EC2 launch type, any network mode can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.

\n

With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.

\n

If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.

\n \n

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init package, or AWS Fargate infrastructure support the\n awsvpc network mode.

\n \n

If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.

\n

Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the network mode object.

\n

For more information, see Network\n settings in the Docker run reference.

" } }, - "executionRoleArn": { - "target": "com.amazonaws.ecs#String", + "placementConstraints": { + "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make AWS API calls on your behalf. The task execution IAM role is required\n depending on the requirements of your task. For more information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

An array of placement constraint objects to use for tasks. This field is not valid if\n you are using the Fargate launch type for your task.

" } }, - "family": { - "target": "com.amazonaws.ecs#String", + "volumes": { + "target": "com.amazonaws.ecs#VolumeList", "traits": { - "smithy.api#documentation": "

The name of a family that this task definition is registered to. Up to 255 letters\n (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

\n

A family groups multiple versions of a task definition. Amazon ECS gives the first task\n definition that you registered to a family a revision number of 1. Amazon ECS gives\n sequential revision numbers to each task definition that you add.

" + "smithy.api#documentation": "

The list of volume definitions for the task.

\n

If your tasks are using the Fargate launch type, the host\n and sourcePath parameters are not supported.

\n

For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

" } }, - "taskDefinitionArn": { + "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the task definition.

" + "smithy.api#documentation": "

The number of cpu units used by the task. If you are using the EC2 launch\n type, this field is optional and any value can be used. If you are using the Fargate\n launch type, this field is required and you must use one of the following values, which\n determines your range of valid values for the memory parameter:

\n " } }, - "revision": { - "target": "com.amazonaws.ecs#Integer", + "executionRoleArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The revision of the task in a particular family. The revision is a version number of a\n task definition in a family. When you register a task definition for the first time, the\n revision is 1. Each time that you register a new revision of a task\n definition in the same family, the revision value always increases by one, even if you\n have deregistered previous revisions in this family.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make AWS API calls on your behalf. The task execution IAM role is required\n depending on the requirements of your task. For more information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -7406,28 +7406,16 @@ "com.amazonaws.ecs#TaskOverride": { "type": "structure", "members": { - "taskRoleArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n in this task are granted the permissions that are specified in this role.

" - } - }, - "inferenceAcceleratorOverrides": { - "target": "com.amazonaws.ecs#InferenceAcceleratorOverrides", - "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerator override for the task.

" - } - }, "containerOverrides": { "target": "com.amazonaws.ecs#ContainerOverrides", "traits": { "smithy.api#documentation": "

One or more container overrides sent to a task.

" } }, - "memory": { + "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The memory override for the task.

" + "smithy.api#documentation": "

The cpu override for the task.

" } }, "executionRoleArn": { @@ -7436,10 +7424,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution IAM role override for the task.

" } }, - "cpu": { + "inferenceAcceleratorOverrides": { + "target": "com.amazonaws.ecs#InferenceAcceleratorOverrides", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerator override for the task.

" + } + }, + "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The cpu override for the task.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n in this task are granted the permissions that are specified in this role.

" + } + }, + "memory": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The memory override for the task.

" } } }, @@ -7450,28 +7450,22 @@ "com.amazonaws.ecs#TaskSet": { "type": "structure", "members": { - "stabilityStatusAt": { - "target": "com.amazonaws.ecs#Timestamp", + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task set stability status was retrieved.

" + "smithy.api#documentation": "

Details on a load balancer that is used with a task set.

" } }, - "clusterArn": { + "serviceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n in.

" - } - }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task set was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service the task set exists in.

" } }, - "pendingCount": { - "target": "com.amazonaws.ecs#Integer", + "externalId": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of tasks in the task set that are in the PENDING status during\n a deployment. A task in the PENDING state is preparing to enter the\n RUNNING state. A task set enters the PENDING status when\n it launches for the first time or when it is restarted after being in the\n STOPPED state.

" + "smithy.api#documentation": "

The external ID associated with the task set.

\n

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter\n contains the AWS CodeDeploy deployment ID.

\n

If a task set is created for an external deployment and is associated with a service\n discovery registry, the externalId parameter contains the\n ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

" } }, "serviceRegistries": { @@ -7480,22 +7474,16 @@ "smithy.api#documentation": "

The details of the service discovery registries to assign to this task set. For more\n information, see Service\n Discovery.

" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " - } - }, - "computedDesiredCount": { - "target": "com.amazonaws.ecs#Integer", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The computed desired count for the task set. This is calculated by multiplying the\n service's desiredCount by the task set's scale percentage. The\n result is always rounded up. For example, if the computed desired count is 1.2, it\n rounds up to 2 tasks.

" + "smithy.api#documentation": "

The launch type the tasks in the task set are using. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" } }, - "scale": { - "target": "com.amazonaws.ecs#Scale", + "taskDefinition": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

A floating-point percentage of the desired number of tasks to place and keep running\n in the task set.

" + "smithy.api#documentation": "

The task definition the task set is using.

" } }, "stabilityStatus": { @@ -7504,58 +7492,52 @@ "smithy.api#documentation": "

The stability status, which indicates whether the task set has reached a steady state.\n If the following conditions are met, the task set will be in\n STEADY_STATE:

\n \n

If any of those conditions are not met, the stability status returns\n STABILIZING.

" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "computedDesiredCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The launch type the tasks in the task set are using. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The computed desired count for the task set. This is calculated by multiplying the\n service's desiredCount by the task set's scale percentage. The\n result is always rounded up. For example, if the computed desired count is 1.2, it\n rounds up to 2 tasks.

" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "id": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The capacity provider strategy associated with the task set.

" + "smithy.api#documentation": "

The ID of the task set.

" } }, - "updatedAt": { + "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task set was last updated.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

The network configuration for the task set.

" + "smithy.api#documentation": "

The Unix timestamp for when the task set was created.

" } }, - "startedBy": { + "taskSetArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy\n deployment, the startedBy parameter is CODE_DEPLOY. For a task\n set created for an external deployment, the startedBy field isn't used.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task set.

" } }, - "serviceArn": { - "target": "com.amazonaws.ecs#String", + "updatedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service the task set exists in.

" + "smithy.api#documentation": "

The Unix timestamp for when the task set was last updated.

" } }, - "externalId": { + "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The external ID associated with the task set.

\n

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter\n contains the AWS CodeDeploy deployment ID.

\n

If a task set is created for an external deployment and is associated with a service\n discovery registry, the externalId parameter contains the\n ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

" + "smithy.api#documentation": "

The status of the task set. The following describes each state:

\n
\n
PRIMARY
\n
\n

The task set is serving production traffic.

\n
\n
ACTIVE
\n
\n

The task set is not serving production traffic.

\n
\n
DRAINING
\n
\n

The tasks in the task set are being stopped and their corresponding\n targets are being deregistered from their target group.

\n
\n
" } }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

Details on a load balancer that is used with a task set.

" + "smithy.api#documentation": "

The capacity provider strategy associated with the task set.

" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "pendingCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The platform version on which the tasks in the task set are running. A platform\n version is only specified for tasks using the Fargate launch type. If one\n is not specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The number of tasks in the task set that are in the PENDING status during\n a deployment. A task in the PENDING state is preparing to enter the\n RUNNING state. A task set enters the PENDING status when\n it launches for the first time or when it is restarted after being in the\n STOPPED state.

" } }, "runningCount": { @@ -7564,28 +7546,46 @@ "smithy.api#documentation": "

The number of tasks in the task set that are in the RUNNING status during\n a deployment. A task in the RUNNING state is running and ready for\n use.

" } }, - "status": { - "target": "com.amazonaws.ecs#String", + "scale": { + "target": "com.amazonaws.ecs#Scale", "traits": { - "smithy.api#documentation": "

The status of the task set. The following describes each state:

\n
\n
PRIMARY
\n
\n

The task set is serving production traffic.

\n
\n
ACTIVE
\n
\n

The task set is not serving production traffic.

\n
\n
DRAINING
\n
\n

The tasks in the task set are being stopped and their corresponding\n targets are being deregistered from their target group.

\n
\n
" + "smithy.api#documentation": "

A floating-point percentage of the desired number of tasks to place and keep running\n in the task set.

" } }, - "taskSetArn": { + "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task set.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n in.

" } }, - "id": { + "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ID of the task set.

" + "smithy.api#documentation": "

The platform version on which the tasks in the task set are running. A platform\n version is only specified for tasks using the Fargate launch type. If one\n is not specified, the LATEST platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" } }, - "taskDefinition": { + "tags": { + "target": "com.amazonaws.ecs#Tags", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } + }, + "stabilityStatusAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the task set stability status was retrieved.

" + } + }, + "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The task definition the task set is using.

" + "smithy.api#documentation": "

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy\n deployment, the startedBy parameter is CODE_DEPLOY. For a task\n set created for an external deployment, the startedBy field isn't used.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The network configuration for the task set.

" } } }, @@ -7659,6 +7659,13 @@ "com.amazonaws.ecs#Tmpfs": { "type": "structure", "members": { + "size": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#documentation": "

The size (in MiB) of the tmpfs volume.

", + "smithy.api#required": {} + } + }, "containerPath": { "target": "com.amazonaws.ecs#String", "traits": { @@ -7671,13 +7678,6 @@ "traits": { "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"\n

" } - }, - "size": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#documentation": "

The size (in MiB) of the tmpfs volume.

", - "smithy.api#required": {} - } } }, "traits": { @@ -7708,10 +7708,10 @@ "com.amazonaws.ecs#Ulimit": { "type": "structure", "members": { - "softLimit": { + "hardLimit": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The soft limit for the ulimit type.

", + "smithy.api#documentation": "

The hard limit for the ulimit type.

", "smithy.api#required": {} } }, @@ -7722,10 +7722,10 @@ "smithy.api#required": {} } }, - "hardLimit": { + "softLimit": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The hard limit for the ulimit type.

", + "smithy.api#documentation": "

The soft limit for the ulimit type.

", "smithy.api#required": {} } } @@ -8017,11 +8017,10 @@ "com.amazonaws.ecs#UpdateContainerInstancesStateRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.ecs#ContainerInstanceStatus", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container instance state with which to update the container instance. The only\n valid values for this action are ACTIVE and DRAINING. A\n container instance can only be updated to DRAINING status once it has\n reached an ACTIVE state. If a container instance is in\n REGISTERING, DEREGISTERING, or\n REGISTRATION_FAILED state you can describe the container instance but\n will be unable to update the container instance state.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n update. If you do not specify a cluster, the default cluster is assumed.

" } }, "containerInstances": { @@ -8031,10 +8030,11 @@ "smithy.api#required": {} } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "status": { + "target": "com.amazonaws.ecs#ContainerInstanceStatus", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n update. If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The container instance state with which to update the container instance. The only\n valid values for this action are ACTIVE and DRAINING. A\n container instance can only be updated to DRAINING status once it has\n reached an ACTIVE state. If a container instance is in\n REGISTERING, DEREGISTERING, or\n REGISTRATION_FAILED state you can describe the container instance but\n will be unable to update the container instance state.

", + "smithy.api#required": {} } } } @@ -8042,17 +8042,17 @@ "com.amazonaws.ecs#UpdateContainerInstancesStateResponse": { "type": "structure", "members": { - "containerInstances": { - "target": "com.amazonaws.ecs#ContainerInstances", - "traits": { - "smithy.api#documentation": "

The list of container instances.

" - } - }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "

Any failures associated with the call.

" } + }, + "containerInstances": { + "target": "com.amazonaws.ecs#ContainerInstances", + "traits": { + "smithy.api#documentation": "

The list of container instances.

" + } } } }, @@ -8153,17 +8153,17 @@ "com.amazonaws.ecs#UpdateServicePrimaryTaskSetRequest": { "type": "structure", "members": { - "primaryTaskSet": { + "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the\n deployment.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

", "smithy.api#required": {} } }, - "service": { + "primaryTaskSet": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the\n deployment.

", "smithy.api#required": {} } }, @@ -8187,16 +8187,16 @@ "com.amazonaws.ecs#UpdateServiceRequest": { "type": "structure", "members": { - "taskDefinition": { - "target": "com.amazonaws.ecs#String", + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to run in your service. If a revision is\n not specified, the latest ACTIVE revision is used. If you modify the task\n definition with UpdateService, Amazon ECS spawns a task with the new version of\n the task definition and then stops an old task after the new version is running.

" + "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.

" } }, - "healthCheckGracePeriodSeconds": { - "target": "com.amazonaws.ecs#BoxedInteger", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid\n if your service is configured to use a load balancer. If your service's tasks take a\n while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace\n period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service\n scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS\n service scheduler from marking tasks as unhealthy and stopping them before they have\n time to come up.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.\n If you do not specify a cluster, the default cluster is assumed.

" } }, "platformVersion": { @@ -8205,56 +8205,56 @@ "smithy.api#documentation": "

The platform version on which your tasks in the service are running. A platform\n version is only specified for tasks using the Fargate launch type. If a\n platform version is not specified, the LATEST platform version is used by\n default. For more information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.

" } }, - "forceNewDeployment": { - "target": "com.amazonaws.ecs#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to force a new deployment of the service. Deployments are not forced by\n default. You can use this option to trigger a new deployment with no service definition\n changes. For example, you can update a service's tasks to use a newer Docker image with\n the same image/tag combination (my_image:latest) or to roll Fargate tasks\n onto a newer platform version.

" - } + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration" }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", + "desiredCount": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n value is specified, the existing placement constraints for the service will remain\n unchanged. If this value is specified, it will override any existing placement\n constraints defined for the service. To remove all existing placement constraints,\n specify an empty array.

\n

You can specify a maximum of 10 constraints per task (this limit includes constraints\n in the task definition and those specified at runtime).

" + "smithy.api#documentation": "

The number of instantiations of the task to place and keep running in your\n service.

" } }, - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.

" + "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n specified, the existing placement strategy for the service will remain unchanged. If\n this value is specified, it will override the existing placement strategy defined for\n the service. To remove an existing placement strategy, specify an empty object.

\n

You can specify a maximum of five strategy rules per service.

" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "service": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to update the service to use.

\n

If the service is using the default capacity provider strategy for the cluster, the\n service can be updated to use one or more capacity providers as opposed to the default\n capacity provider strategy. However, when a service is using a capacity provider\n strategy that is not the default capacity provider strategy, the service cannot be\n updated to use the cluster's default capacity provider strategy.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

\n

" + "smithy.api#documentation": "

The name of the service to update.

", + "smithy.api#required": {} } }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration" - }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", + "forceNewDeployment": { + "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n specified, the existing placement strategy for the service will remain unchanged. If\n this value is specified, it will override the existing placement strategy defined for\n the service. To remove an existing placement strategy, specify an empty object.

\n

You can specify a maximum of five strategy rules per service.

" + "smithy.api#documentation": "

Whether to force a new deployment of the service. Deployments are not forced by\n default. You can use this option to trigger a new deployment with no service definition\n changes. For example, you can update a service's tasks to use a newer Docker image with\n the same image/tag combination (my_image:latest) or to roll Fargate tasks\n onto a newer platform version.

" } }, - "cluster": { + "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.\n If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The family and revision (family:revision) or\n full ARN of the task definition to run in your service. If a revision is\n not specified, the latest ACTIVE revision is used. If you modify the task\n definition with UpdateService, Amazon ECS spawns a task with the new version of\n the task definition and then stops an old task after the new version is running.

" } }, - "desiredCount": { + "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The number of instantiations of the task to place and keep running in your\n service.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid\n if your service is configured to use a load balancer. If your service's tasks take a\n while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace\n period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service\n scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS\n service scheduler from marking tasks as unhealthy and stopping them before they have\n time to come up.

" } }, - "service": { - "target": "com.amazonaws.ecs#String", + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

The name of the service to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n value is specified, the existing placement constraints for the service will remain\n unchanged. If this value is specified, it will override any existing placement\n constraints defined for the service. To remove all existing placement constraints,\n specify an empty array.

\n

You can specify a maximum of 10 constraints per task (this limit includes constraints\n in the task definition and those specified at runtime).

" + } + }, + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "

The capacity provider strategy to update the service to use.

\n

If the service is using the default capacity provider strategy for the cluster, the\n service can be updated to use one or more capacity providers as opposed to the default\n capacity provider strategy. However, when a service is using a capacity provider\n strategy that is not the default capacity provider strategy, the service cannot be\n updated to use the cluster's default capacity provider strategy.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n base and weight to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE or\n UPDATING status can be used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a AWS Fargate capacity provider, specify either the FARGATE or\n FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.

\n

The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.

\n

" } } } @@ -8314,30 +8314,30 @@ "com.amazonaws.ecs#UpdateTaskSetRequest": { "type": "structure", "members": { - "taskSet": { - "target": "com.amazonaws.ecs#String", + "scale": { + "target": "com.amazonaws.ecs#Scale", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the task set to update.

", "smithy.api#required": {} } }, - "cluster": { + "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n set exists in.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

", "smithy.api#required": {} } }, - "service": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

", + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n set exists in.

", "smithy.api#required": {} } }, - "scale": { - "target": "com.amazonaws.ecs#Scale", + "taskSet": { + "target": "com.amazonaws.ecs#String", "traits": { + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the task set to update.

", "smithy.api#required": {} } } @@ -8354,22 +8354,22 @@ "com.amazonaws.ecs#VersionInfo": { "type": "structure", "members": { - "agentHash": { + "agentVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n GitHub repository.

" + "smithy.api#documentation": "

The version number of the Amazon ECS container agent.

" } }, - "dockerVersion": { + "agentHash": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Docker version running on the container instance.

" + "smithy.api#documentation": "

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n GitHub repository.

" } }, - "agentVersion": { + "dockerVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The version number of the Amazon ECS container agent.

" + "smithy.api#documentation": "

The Docker version running on the container instance.

" } } }, @@ -8380,10 +8380,10 @@ "com.amazonaws.ecs#Volume": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.ecs#String", + "efsVolumeConfiguration": { + "target": "com.amazonaws.ecs#EFSVolumeConfiguration", "traits": { - "smithy.api#documentation": "

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the\n sourceVolume parameter of container definition\n mountPoints.

" + "smithy.api#documentation": "

This parameter is specified when you are using an Amazon Elastic File System file system for task\n storage.

" } }, "dockerVolumeConfiguration": { @@ -8392,17 +8392,17 @@ "smithy.api#documentation": "

This parameter is specified when you are using Docker volumes. Docker volumes are only\n supported when you are using the EC2 launch type. Windows containers only\n support the use of the local driver. To use bind mounts, specify the\n host parameter instead.

" } }, - "efsVolumeConfiguration": { - "target": "com.amazonaws.ecs#EFSVolumeConfiguration", - "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using an Amazon Elastic File System file system for task\n storage.

" - } - }, "host": { "target": "com.amazonaws.ecs#HostVolumeProperties", "traits": { "smithy.api#documentation": "

This parameter is specified when you are using bind mount host volumes. The contents\n of the host parameter determine whether your bind mount host volume\n persists on the host container instance and where it is stored. If the host\n parameter is empty, then the Docker daemon assigns a host path for your data volume.\n However, the data is not guaranteed to persist after the containers associated with it\n stop running.

\n

Windows containers can mount whole directories on the same drive as\n $env:ProgramData. Windows containers cannot mount directories on a\n different drive, and mount point cannot be across drives. For example, you can mount\n C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" } + }, + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the\n sourceVolume parameter of container definition\n mountPoints.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/efs.2015-02-01.json b/codegen/sdk-codegen/aws-models/efs.2015-02-01.json index 7c9cdeb0fb02..f430ee59ceac 100644 --- a/codegen/sdk-codegen/aws-models/efs.2015-02-01.json +++ b/codegen/sdk-codegen/aws-models/efs.2015-02-01.json @@ -60,28 +60,28 @@ "com.amazonaws.efs#AccessPointDescription": { "type": "structure", "members": { - "AccessPointArn": { - "target": "com.amazonaws.efs#AccessPointArn", + "ClientToken": { + "target": "com.amazonaws.efs#ClientToken", "traits": { - "smithy.api#documentation": "

The unique Amazon Resource Name (ARN) associated with the access point.

" + "smithy.api#documentation": "

The opaque string specified in the request to ensure idempotent creation.

" } }, - "OwnerId": { - "target": "com.amazonaws.efs#AwsAccountId", + "PosixUser": { + "target": "com.amazonaws.efs#PosixUser", "traits": { - "smithy.api#documentation": "

Identified the AWS account that owns the access point resource.

" + "smithy.api#documentation": "

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by\n NFS clients using the access point.

" } }, - "AccessPointId": { - "target": "com.amazonaws.efs#AccessPointId", + "Tags": { + "target": "com.amazonaws.efs#Tags", "traits": { - "smithy.api#documentation": "

The ID of the access point, assigned by Amazon EFS.

" + "smithy.api#documentation": "

The tags associated with the access point, presented as an array of Tag objects.

" } }, - "LifeCycleState": { - "target": "com.amazonaws.efs#LifeCycleState", + "RootDirectory": { + "target": "com.amazonaws.efs#RootDirectory", "traits": { - "smithy.api#documentation": "

Identifies the lifecycle phase of the access point.

" + "smithy.api#documentation": "

The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

" } }, "Name": { @@ -90,34 +90,34 @@ "smithy.api#documentation": "

The name of the access point. This is the value of the Name tag.

" } }, - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "OwnerId": { + "target": "com.amazonaws.efs#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the EFS file system that the access point applies to.

" + "smithy.api#documentation": "

Identified the AWS account that owns the access point resource.

" } }, - "Tags": { - "target": "com.amazonaws.efs#Tags", + "AccessPointArn": { + "target": "com.amazonaws.efs#AccessPointArn", "traits": { - "smithy.api#documentation": "

The tags associated with the access point, presented as an array of Tag objects.

" + "smithy.api#documentation": "

The unique Amazon Resource Name (ARN) associated with the access point.

" } }, - "RootDirectory": { - "target": "com.amazonaws.efs#RootDirectory", + "AccessPointId": { + "target": "com.amazonaws.efs#AccessPointId", "traits": { - "smithy.api#documentation": "

The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

" + "smithy.api#documentation": "

The ID of the access point, assigned by Amazon EFS.

" } }, - "ClientToken": { - "target": "com.amazonaws.efs#ClientToken", + "LifeCycleState": { + "target": "com.amazonaws.efs#LifeCycleState", "traits": { - "smithy.api#documentation": "

The opaque string specified in the request to ensure idempotent creation.

" + "smithy.api#documentation": "

Identifies the lifecycle phase of the access point.

" } }, - "PosixUser": { - "target": "com.amazonaws.efs#PosixUser", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by\n NFS clients using the access point.

" + "smithy.api#documentation": "

The ID of the EFS file system that the access point applies to.

" } } }, @@ -285,12 +285,6 @@ "com.amazonaws.efs#CreateAccessPointRequest": { "type": "structure", "members": { - "RootDirectory": { - "target": "com.amazonaws.efs#RootDirectory", - "traits": { - "smithy.api#documentation": "

Specifies the directory on the Amazon EFS file system that the access point exposes as\n the root directory of your file system to NFS clients using the access point. \n The clients using the access point can only access the root directory and below. \n If the RootDirectory > Path specified does not exist, \n EFS creates it and applies the CreationInfo settings when a client connects to an access point. \n When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

" - } - }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { @@ -298,12 +292,16 @@ "smithy.api#required": {} } }, - "ClientToken": { - "target": "com.amazonaws.efs#ClientToken", + "Tags": { + "target": "com.amazonaws.efs#Tags", "traits": { - "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent\n creation.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Creates tags associated with the access point. Each tag is a key-value pair.

" + } + }, + "RootDirectory": { + "target": "com.amazonaws.efs#RootDirectory", + "traits": { + "smithy.api#documentation": "

Specifies the directory on the Amazon EFS file system that the access point exposes as\n the root directory of your file system to NFS clients using the access point. \n The clients using the access point can only access the root directory and below. \n If the RootDirectory > Path specified does not exist, \n EFS creates it and applies the CreationInfo settings when a client connects to an access point. \n When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

" } }, "PosixUser": { @@ -312,10 +310,12 @@ "smithy.api#documentation": "

The operating system user and\n group applied to all file system requests made using the access point.

" } }, - "Tags": { - "target": "com.amazonaws.efs#Tags", + "ClientToken": { + "target": "com.amazonaws.efs#ClientToken", "traits": { - "smithy.api#documentation": "

Creates tags associated with the access point. Each tag is a key-value pair.

" + "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent\n creation.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } } } @@ -360,22 +360,22 @@ "com.amazonaws.efs#CreateFileSystemRequest": { "type": "structure", "members": { - "ProvisionedThroughputInMibps": { - "target": "com.amazonaws.efs#ProvisionedThroughputInMibps", + "Encrypted": { + "target": "com.amazonaws.efs#Encrypted", "traits": { - "smithy.api#documentation": "

The throughput, measured in MiB/s, that you want to provision for a file system that\n you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. \n You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase\n in the Amazon EFS User Guide.\n

" + "smithy.api#documentation": "

A Boolean value that, if true, creates an encrypted file system. When creating an\n encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS\n KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for\n Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.\n

" } }, - "Tags": { - "target": "com.amazonaws.efs#Tags", + "KmsKeyId": { + "target": "com.amazonaws.efs#KmsKeyId", "traits": { - "smithy.api#documentation": "

A value that specifies to create one or more tags associated with the file system. Each\n tag is a user-defined key-value pair. Name your file system on creation by including a\n \"Key\":\"Name\",\"Value\":\"{value}\" key-value pair.

" + "smithy.api#documentation": "

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This\n parameter is only required if you want to use a nondefault CMK. If this parameter is not\n specified, the default CMK for Amazon EFS is used. This ID can be in one of the following\n formats:

\n \n

If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.

\n \n

EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.

\n " } }, - "ThroughputMode": { - "target": "com.amazonaws.efs#ThroughputMode", + "ProvisionedThroughputInMibps": { + "target": "com.amazonaws.efs#ProvisionedThroughputInMibps", "traits": { - "smithy.api#documentation": "

The throughput mode for the file system to be created. There are two throughput modes to\n choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, \n you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file\n system's throughput in Provisioned Throughput mode or change between the throughput modes\n as long as it’s been more than 24 hours since the last decrease or throughput mode\n change. For more, \n see Specifying Throughput with Provisioned Mode\n in the Amazon EFS User Guide.\n

" + "smithy.api#documentation": "

The throughput, measured in MiB/s, that you want to provision for a file system that\n you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. \n You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase\n in the Amazon EFS User Guide.\n

" } }, "PerformanceMode": { @@ -384,12 +384,6 @@ "smithy.api#documentation": "

The performance mode of the file system. We recommend generalPurpose\n performance mode for most file systems. File systems using the maxIO performance\n mode can scale to higher levels of aggregate throughput and operations per second with a\n tradeoff of slightly higher latencies for most file operations. The performance mode\n can't be changed after the file system has been created.

" } }, - "Encrypted": { - "target": "com.amazonaws.efs#Encrypted", - "traits": { - "smithy.api#documentation": "

A Boolean value that, if true, creates an encrypted file system. When creating an\n encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS\n KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for\n Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.\n

" - } - }, "CreationToken": { "target": "com.amazonaws.efs#CreationToken", "traits": { @@ -398,10 +392,16 @@ "smithy.api#required": {} } }, - "KmsKeyId": { - "target": "com.amazonaws.efs#KmsKeyId", + "Tags": { + "target": "com.amazonaws.efs#Tags", "traits": { - "smithy.api#documentation": "

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This\n parameter is only required if you want to use a nondefault CMK. If this parameter is not\n specified, the default CMK for Amazon EFS is used. This ID can be in one of the following\n formats:

\n \n

If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.

\n \n

EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.

\n " + "smithy.api#documentation": "

A value that specifies to create one or more tags associated with the file system. Each\n tag is a user-defined key-value pair. Name your file system on creation by including a\n \"Key\":\"Name\",\"Value\":\"{value}\" key-value pair.

" + } + }, + "ThroughputMode": { + "target": "com.amazonaws.efs#ThroughputMode", + "traits": { + "smithy.api#documentation": "

The throughput mode for the file system to be created. There are two throughput modes to\n choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, \n you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file\n system's throughput in Provisioned Throughput mode or change between the throughput modes\n as long as it’s been more than 24 hours since the last decrease or throughput mode\n change. For more, \n see Specifying Throughput with Provisioned Mode\n in the Amazon EFS User Guide.\n

" } } } @@ -471,10 +471,11 @@ "smithy.api#required": {} } }, - "IpAddress": { - "target": "com.amazonaws.efs#IpAddress", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "

Valid IPv4 address within the address range of the specified subnet.

" + "smithy.api#documentation": "

The ID of the file system for which to create the mount target.

", + "smithy.api#required": {} } }, "SecurityGroups": { @@ -483,11 +484,10 @@ "smithy.api#documentation": "

Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be\n for the same VPC as subnet specified.

" } }, - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "IpAddress": { + "target": "com.amazonaws.efs#IpAddress", "traits": { - "smithy.api#documentation": "

The ID of the file system for which to create the mount target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Valid IPv4 address within the address range of the specified subnet.

" } } }, @@ -526,18 +526,18 @@ "com.amazonaws.efs#CreateTagsRequest": { "type": "structure", "members": { - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "Tags": { + "target": "com.amazonaws.efs#Tags", "traits": { - "smithy.api#documentation": "

The ID of the file system whose tags you want to modify (String). This operation modifies\n the tags only, not the file system.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

An array of Tag objects to add. Each Tag object is a key-value\n pair.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.efs#Tags", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "

An array of Tag objects to add. Each Tag object is a key-value\n pair.

", + "smithy.api#documentation": "

The ID of the file system whose tags you want to modify (String). This operation modifies\n the tags only, not the file system.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -858,20 +858,6 @@ "com.amazonaws.efs#DescribeAccessPointsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.efs#MaxResults", - "traits": { - "smithy.api#documentation": "

(Optional) When retrieving all access points for a file system,\n you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. \n The default value is 100.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.efs#Token", - "traits": { - "smithy.api#documentation": "

\n NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.

", - "smithy.api#httpQuery": "NextToken" - } - }, "AccessPointId": { "target": "com.amazonaws.efs#AccessPointId", "traits": { @@ -885,23 +871,37 @@ "smithy.api#documentation": "

(Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.

", "smithy.api#httpQuery": "FileSystemId" } + }, + "MaxResults": { + "target": "com.amazonaws.efs#MaxResults", + "traits": { + "smithy.api#documentation": "

(Optional) When retrieving all access points for a file system,\n you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. \n The default value is 100.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.efs#Token", + "traits": { + "smithy.api#documentation": "

\n NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.

", + "smithy.api#httpQuery": "NextToken" + } } } }, "com.amazonaws.efs#DescribeAccessPointsResponse": { "type": "structure", "members": { - "AccessPoints": { - "target": "com.amazonaws.efs#AccessPointDescriptions", - "traits": { - "smithy.api#documentation": "

An array of access point descriptions.

" - } - }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "

Present if there are more access points than returned in the response. \n You can use the NextMarker in the subsequent request to fetch the additional descriptions.

" } + }, + "AccessPoints": { + "target": "com.amazonaws.efs#AccessPointDescriptions", + "traits": { + "smithy.api#documentation": "

An array of access point descriptions.

" + } } } }, @@ -1043,19 +1043,19 @@ "smithy.api#httpQuery": "Marker" } }, - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", - "traits": { - "smithy.api#documentation": "

(Optional) ID of the file system whose description you want to retrieve\n (String).

", - "smithy.api#httpQuery": "FileSystemId" - } - }, "MaxItems": { "target": "com.amazonaws.efs#MaxItems", "traits": { "smithy.api#documentation": "

(Optional) Specifies the maximum number of file systems to return in the response\n (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.\n

", "smithy.api#httpQuery": "MaxItems" } + }, + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", + "traits": { + "smithy.api#documentation": "

(Optional) ID of the file system whose description you want to retrieve\n (String).

", + "smithy.api#httpQuery": "FileSystemId" + } } }, "traits": { @@ -1229,20 +1229,6 @@ "smithy.api#httpQuery": "MountTargetId" } }, - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", - "traits": { - "smithy.api#documentation": "

(Optional) ID of the file system whose mount targets you want to list (String). It must\n be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.

", - "smithy.api#httpQuery": "FileSystemId" - } - }, - "MaxItems": { - "target": "com.amazonaws.efs#MaxItems", - "traits": { - "smithy.api#documentation": "

(Optional) Maximum number of mount targets to return in the response. Currently, this\n number is automatically set to\n 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.

", - "smithy.api#httpQuery": "MaxItems" - } - }, "AccessPointId": { "target": "com.amazonaws.efs#AccessPointId", "traits": { @@ -1256,6 +1242,20 @@ "smithy.api#documentation": "

(Optional) Opaque pagination token returned from a previous\n DescribeMountTargets operation (String). If present, it specifies to continue\n the list from where the previous returning call left off.

", "smithy.api#httpQuery": "Marker" } + }, + "MaxItems": { + "target": "com.amazonaws.efs#MaxItems", + "traits": { + "smithy.api#documentation": "

(Optional) Maximum number of mount targets to return in the response. Currently, this\n number is automatically set to\n 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.

", + "smithy.api#httpQuery": "MaxItems" + } + }, + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", + "traits": { + "smithy.api#documentation": "

(Optional) ID of the file system whose mount targets you want to list (String). It must\n be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.

", + "smithy.api#httpQuery": "FileSystemId" + } } }, "traits": { @@ -1265,6 +1265,12 @@ "com.amazonaws.efs#DescribeMountTargetsResponse": { "type": "structure", "members": { + "NextMarker": { + "target": "com.amazonaws.efs#Marker", + "traits": { + "smithy.api#documentation": "

If a value is present, there are more mount targets to return. In a subsequent request,\n you can provide Marker in your request with this value to retrieve the next set\n of mount targets.

" + } + }, "MountTargets": { "target": "com.amazonaws.efs#MountTargetDescriptions", "traits": { @@ -1276,12 +1282,6 @@ "traits": { "smithy.api#documentation": "

If the request included the Marker, the response returns that value in\n this field.

" } - }, - "NextMarker": { - "target": "com.amazonaws.efs#Marker", - "traits": { - "smithy.api#documentation": "

If a value is present, there are more mount targets to return. In a subsequent request,\n you can provide Marker in your request with this value to retrieve the next set\n of mount targets.

" - } } }, "traits": { @@ -1334,13 +1334,6 @@ "smithy.api#httpQuery": "MaxItems" } }, - "Marker": { - "target": "com.amazonaws.efs#Marker", - "traits": { - "smithy.api#documentation": "

(Optional) An opaque pagination token returned from a previous\n DescribeTags operation (String). If present, it specifies to continue the list\n from where the previous call left off.

", - "smithy.api#httpQuery": "Marker" - } - }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { @@ -1348,6 +1341,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Marker": { + "target": "com.amazonaws.efs#Marker", + "traits": { + "smithy.api#documentation": "

(Optional) An opaque pagination token returned from a previous\n DescribeTags operation (String). If present, it specifies to continue the list\n from where the previous call left off.

", + "smithy.api#httpQuery": "Marker" + } } }, "traits": { @@ -1357,6 +1357,13 @@ "com.amazonaws.efs#DescribeTagsResponse": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.efs#Tags", + "traits": { + "smithy.api#documentation": "

Returns tags associated with the file system as an array of Tag objects.\n

", + "smithy.api#required": {} + } + }, "NextMarker": { "target": "com.amazonaws.efs#Marker", "traits": { @@ -1368,13 +1375,6 @@ "traits": { "smithy.api#documentation": "

If the request included a Marker, the response returns that value in this\n field.

" } - }, - "Tags": { - "target": "com.amazonaws.efs#Tags", - "traits": { - "smithy.api#documentation": "

Returns tags associated with the file system as an array of Tag objects.\n

", - "smithy.api#required": {} - } } }, "traits": { @@ -1398,23 +1398,23 @@ "com.amazonaws.efs#ErrorMessage": { "type": "string" }, - "com.amazonaws.efs#FileSystemAlreadyExists": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.efs#ErrorMessage" - }, - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "com.amazonaws.efs#FileSystemAlreadyExists": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } }, - "ErrorCode": { - "target": "com.amazonaws.efs#ErrorCode", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { @@ -1436,17 +1436,17 @@ "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.efs#Timestamp", + "OwnerId": { + "target": "com.amazonaws.efs#AwsAccountId", "traits": { - "smithy.api#documentation": "

The time that the file system was created, in seconds (since\n 1970-01-01T00:00:00Z).

", + "smithy.api#documentation": "

The AWS account that created the file system. If the file system was created by an IAM\n user, the parent account to which the user belongs is the owner.

", "smithy.api#required": {} } }, - "OwnerId": { - "target": "com.amazonaws.efs#AwsAccountId", + "CreationTime": { + "target": "com.amazonaws.efs#Timestamp", "traits": { - "smithy.api#documentation": "

The AWS account that created the file system. If the file system was created by an IAM\n user, the parent account to which the user belongs is the owner.

", + "smithy.api#documentation": "

The time that the file system was created, in seconds (since\n 1970-01-01T00:00:00Z).

", "smithy.api#required": {} } }, @@ -1471,6 +1471,12 @@ "smithy.api#required": {} } }, + "ThroughputMode": { + "target": "com.amazonaws.efs#ThroughputMode", + "traits": { + "smithy.api#documentation": "

The throughput mode for a file system. There are two throughput modes to choose from for\n your file system: bursting and provisioned. If you set ThroughputMode to provisioned, \n you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's\n throughput in Provisioned Throughput mode or change between the throughput modes as long as\n it’s been more than 24 hours since the last decrease or throughput mode change.\n

" + } + }, "CreationToken": { "target": "com.amazonaws.efs#CreationToken", "traits": { @@ -1478,6 +1484,19 @@ "smithy.api#required": {} } }, + "LifeCycleState": { + "target": "com.amazonaws.efs#LifeCycleState", + "traits": { + "smithy.api#documentation": "

The lifecycle phase of the file system.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.efs#TagValue", + "traits": { + "smithy.api#documentation": "

You can add tags to a file system, including a Name tag. For more\n information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns\n the value in this field.

" + } + }, "Encrypted": { "target": "com.amazonaws.efs#Encrypted", "traits": { @@ -1490,13 +1509,6 @@ "smithy.api#documentation": "

The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024. \n Required if ThroughputMode is set to provisioned. The limit\n on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For\n more information, see Amazon EFS Limits That You Can Increase\n in the Amazon EFS User Guide.\n

" } }, - "LifeCycleState": { - "target": "com.amazonaws.efs#LifeCycleState", - "traits": { - "smithy.api#documentation": "

The lifecycle phase of the file system.

", - "smithy.api#required": {} - } - }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { @@ -1504,18 +1516,6 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.efs#TagValue", - "traits": { - "smithy.api#documentation": "

You can add tags to a file system, including a Name tag. For more\n information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns\n the value in this field.

" - } - }, - "ThroughputMode": { - "target": "com.amazonaws.efs#ThroughputMode", - "traits": { - "smithy.api#documentation": "

The throughput mode for a file system. There are two throughput modes to choose from for\n your file system: bursting and provisioned. If you set ThroughputMode to provisioned, \n you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's\n throughput in Provisioned Throughput mode or change between the throughput modes as long as\n it’s been more than 24 hours since the last decrease or throughput mode change.\n

" - } - }, "FileSystemArn": { "target": "com.amazonaws.efs#FileSystemArn", "traits": { @@ -1552,14 +1552,14 @@ "com.amazonaws.efs#FileSystemInUse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.efs#ErrorMessage" - }, "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { @@ -1648,17 +1648,17 @@ "smithy.api#documentation": "

The latest known metered size (in bytes) of data stored in the Infrequent Access\n storage class.

" } }, - "ValueInStandard": { - "target": "com.amazonaws.efs#FileSystemNullableSizeValue", - "traits": { - "smithy.api#documentation": "

The latest known metered size (in bytes) of data stored in the Standard storage\n class.

" - } - }, "Timestamp": { "target": "com.amazonaws.efs#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the size of data, returned in the Value field, was\n determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.

" } + }, + "ValueInStandard": { + "target": "com.amazonaws.efs#FileSystemNullableSizeValue", + "traits": { + "smithy.api#documentation": "

The latest known metered size (in bytes) of data stored in the Standard storage\n class.

" + } } }, "traits": { @@ -1724,14 +1724,14 @@ "com.amazonaws.efs#InsufficientThroughputCapacity": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" + }, "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } - }, - "Message": { - "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { @@ -1743,14 +1743,14 @@ "com.amazonaws.efs#InternalServerError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.efs#ErrorMessage" - }, "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { @@ -1762,11 +1762,11 @@ "com.amazonaws.efs#InvalidPolicyException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.efs#ErrorMessage" - }, "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { @@ -1938,17 +1938,17 @@ "com.amazonaws.efs#ListTagsForResourceResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.efs#Tags", - "traits": { - "smithy.api#documentation": "

An array of the tags for the specified EFS resource.

" - } - }, "NextToken": { "target": "com.amazonaws.efs#Token", "traits": { "smithy.api#documentation": "

\n NextToken is present if the response payload is paginated. You can use NextToken in a subsequent request to fetch the next page of access point descriptions.

" } + }, + "Tags": { + "target": "com.amazonaws.efs#Tags", + "traits": { + "smithy.api#documentation": "

An array of the tags for the specified EFS resource.

" + } } } }, @@ -2037,7 +2037,7 @@ "sdkId": "EFS", "arnNamespace": "elasticfilesystem", "cloudFormationName": "EFS", - "cloudTrailEventSource": "v20150201.api.magnolio.amazon.com" + "cloudTrailEventSource": "efs.amazonaws.com" }, "aws.auth#sigv4": { "name": "elasticfilesystem" @@ -2112,12 +2112,6 @@ "com.amazonaws.efs#ModifyMountTargetSecurityGroupsRequest": { "type": "structure", "members": { - "SecurityGroups": { - "target": "com.amazonaws.efs#SecurityGroups", - "traits": { - "smithy.api#documentation": "

An array of up to five VPC security group IDs.

" - } - }, "MountTargetId": { "target": "com.amazonaws.efs#MountTargetId", "traits": { @@ -2125,6 +2119,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "SecurityGroups": { + "target": "com.amazonaws.efs#SecurityGroups", + "traits": { + "smithy.api#documentation": "

An array of up to five VPC security group IDs.

" + } } }, "traits": { @@ -2161,10 +2161,11 @@ "com.amazonaws.efs#MountTargetDescription": { "type": "structure", "members": { - "IpAddress": { - "target": "com.amazonaws.efs#IpAddress", + "SubnetId": { + "target": "com.amazonaws.efs#SubnetId", "traits": { - "smithy.api#documentation": "

Address at which the file system can be mounted by using the mount target.

" + "smithy.api#documentation": "

The ID of the mount target's subnet.

", + "smithy.api#required": {} } }, "OwnerId": { @@ -2173,36 +2174,35 @@ "smithy.api#documentation": "

AWS account ID that owns the resource.

" } }, - "LifeCycleState": { - "target": "com.amazonaws.efs#LifeCycleState", + "IpAddress": { + "target": "com.amazonaws.efs#IpAddress", "traits": { - "smithy.api#documentation": "

Lifecycle state of the mount target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Address at which the file system can be mounted by using the mount target.

" } }, - "AvailabilityZoneId": { - "target": "com.amazonaws.efs#AvailabilityZoneId", + "VpcId": { + "target": "com.amazonaws.efs#VpcId", "traits": { - "smithy.api#documentation": "

The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. \n For example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every AWS account.

" + "smithy.api#documentation": "

The Virtual Private Cloud (VPC) ID that the mount target is configured in.

" } }, - "AvailabilityZoneName": { - "target": "com.amazonaws.efs#AvailabilityZoneName", + "AvailabilityZoneId": { + "target": "com.amazonaws.efs#AvailabilityZoneId", "traits": { - "smithy.api#documentation": "

The name of the Availability Zone (AZ) that the mount target resides in. AZs are \n independently mapped to names for each AWS account. For example, the Availability Zone \n us-east-1a for your AWS account might not be the same location as us-east-1a for another AWS account.

" + "smithy.api#documentation": "

The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. \n For example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every AWS account.

" } }, - "SubnetId": { - "target": "com.amazonaws.efs#SubnetId", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "

The ID of the mount target's subnet.

", + "smithy.api#documentation": "

The ID of the file system for which the mount target is intended.

", "smithy.api#required": {} } }, - "MountTargetId": { - "target": "com.amazonaws.efs#MountTargetId", + "LifeCycleState": { + "target": "com.amazonaws.efs#LifeCycleState", "traits": { - "smithy.api#documentation": "

System-assigned mount target ID.

", + "smithy.api#documentation": "

Lifecycle state of the mount target.

", "smithy.api#required": {} } }, @@ -2212,17 +2212,17 @@ "smithy.api#documentation": "

The ID of the network interface that Amazon EFS created when it created the mount\n target.

" } }, - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "MountTargetId": { + "target": "com.amazonaws.efs#MountTargetId", "traits": { - "smithy.api#documentation": "

The ID of the file system for which the mount target is intended.

", + "smithy.api#documentation": "

System-assigned mount target ID.

", "smithy.api#required": {} } }, - "VpcId": { - "target": "com.amazonaws.efs#VpcId", + "AvailabilityZoneName": { + "target": "com.amazonaws.efs#AvailabilityZoneName", "traits": { - "smithy.api#documentation": "

The Virtual Private Cloud (VPC) ID that the mount target is configured in.

" + "smithy.api#documentation": "

The name of the Availability Zone (AZ) that the mount target resides in. AZs are \n independently mapped to names for each AWS account. For example, the Availability Zone \n us-east-1a for your AWS account might not be the same location as us-east-1a for another AWS account.

" } } }, @@ -2249,14 +2249,14 @@ "com.amazonaws.efs#MountTargetNotFound": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.efs#ErrorMessage" - }, "ErrorCode": { "target": "com.amazonaws.efs#ErrorCode", "traits": { "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" } }, "traits": { @@ -2365,11 +2365,11 @@ "com.amazonaws.efs#PolicyNotFound": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.efs#ErrorCode" - }, "Message": { "target": "com.amazonaws.efs#ErrorMessage" + }, + "ErrorCode": { + "target": "com.amazonaws.efs#ErrorCode" } }, "traits": { @@ -2381,11 +2381,10 @@ "com.amazonaws.efs#PosixUser": { "type": "structure", "members": { - "Gid": { - "target": "com.amazonaws.efs#Gid", + "SecondaryGids": { + "target": "com.amazonaws.efs#SecondaryGids", "traits": { - "smithy.api#documentation": "

The POSIX group ID used for all file system operations using this access point.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Secondary POSIX group IDs used for all file system operations using this access point.

" } }, "Uid": { @@ -2395,10 +2394,11 @@ "smithy.api#required": {} } }, - "SecondaryGids": { - "target": "com.amazonaws.efs#SecondaryGids", + "Gid": { + "target": "com.amazonaws.efs#Gid", "traits": { - "smithy.api#documentation": "

Secondary POSIX group IDs used for all file system operations using this access point.

" + "smithy.api#documentation": "

The POSIX group ID used for all file system operations using this access point.

", + "smithy.api#required": {} } } }, @@ -2452,13 +2452,6 @@ "com.amazonaws.efs#PutBackupPolicyRequest": { "type": "structure", "members": { - "BackupPolicy": { - "target": "com.amazonaws.efs#BackupPolicy", - "traits": { - "smithy.api#documentation": "

The backup policy included in the PutBackupPolicy request.

", - "smithy.api#required": {} - } - }, "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { @@ -2466,6 +2459,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "BackupPolicy": { + "target": "com.amazonaws.efs#BackupPolicy", + "traits": { + "smithy.api#documentation": "

The backup policy included in the PutBackupPolicy request.

", + "smithy.api#required": {} + } } } }, @@ -2503,11 +2503,10 @@ "com.amazonaws.efs#PutFileSystemPolicyRequest": { "type": "structure", "members": { - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "Policy": { + "target": "com.amazonaws.efs#Policy", "traits": { - "smithy.api#documentation": "

The ID of the EFS file system that you want to create or update the FileSystemPolicy for.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. \n To find out more about the elements that make up a file system policy, see \n EFS Resource-based Policies.\n

", "smithy.api#required": {} } }, @@ -2517,10 +2516,11 @@ "smithy.api#documentation": "

(Optional) A flag to indicate whether to bypass the FileSystemPolicy lockout safety check. The policy lockout safety check \n determines whether the policy in the request will prevent the principal making the request will be locked out from making future PutFileSystemPolicy requests on the file system.\n Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent \n the principal that is making the request from making a subsequent PutFileSystemPolicy request on the file system. \n The default value is False.\n

" } }, - "Policy": { - "target": "com.amazonaws.efs#Policy", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "

The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. \n To find out more about the elements that make up a file system policy, see \n EFS Resource-based Policies.\n

", + "smithy.api#documentation": "

The ID of the EFS file system that you want to create or update the FileSystemPolicy for.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -2560,18 +2560,18 @@ "com.amazonaws.efs#PutLifecycleConfigurationRequest": { "type": "structure", "members": { - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "LifecyclePolicies": { + "target": "com.amazonaws.efs#LifecyclePolicies", "traits": { - "smithy.api#documentation": "

The ID of the file system for which you are creating the\n LifecycleConfiguration object (String).

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

An array of LifecyclePolicy objects that define the file system's\n LifecycleConfiguration object. A LifecycleConfiguration object\n tells lifecycle management when to transition files from the Standard storage class to the\n Infrequent Access storage class.

", "smithy.api#required": {} } }, - "LifecyclePolicies": { - "target": "com.amazonaws.efs#LifecyclePolicies", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "

An array of LifecyclePolicy objects that define the file system's\n LifecycleConfiguration object. A LifecycleConfiguration object\n tells lifecycle management when to transition files from the Standard storage class to the\n Infrequent Access storage class.

", + "smithy.api#documentation": "

The ID of the file system for which you are creating the\n LifecycleConfiguration object (String).

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -3039,10 +3039,12 @@ "com.amazonaws.efs#UpdateFileSystemRequest": { "type": "structure", "members": { - "ThroughputMode": { - "target": "com.amazonaws.efs#ThroughputMode", + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "

(Optional) The throughput mode that you want your file system to use. If you're not\n updating your throughput mode, you don't need to provide this value in your\n request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.

" + "smithy.api#documentation": "

The ID of the file system that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ProvisionedThroughputInMibps": { @@ -3051,12 +3053,10 @@ "smithy.api#documentation": "

(Optional) The amount of throughput, in MiB/s, that you want to provision for your file\n system. Valid values are 1-1024. Required if ThroughputMode is changed to provisioned on update. \n If you're not updating the amount of provisioned throughput for your file system, you\n don't need to provide this value in your request.

" } }, - "FileSystemId": { - "target": "com.amazonaws.efs#FileSystemId", + "ThroughputMode": { + "target": "com.amazonaws.efs#ThroughputMode", "traits": { - "smithy.api#documentation": "

The ID of the file system that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

(Optional) The throughput mode that you want your file system to use. If you're not\n updating your throughput mode, you don't need to provide this value in your\n request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.

" } } } 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 4e232db51b5f..4618c426e9b0 100644 --- a/codegen/sdk-codegen/aws-models/eks.2017-11-01.json +++ b/codegen/sdk-codegen/aws-models/eks.2017-11-01.json @@ -38,6 +38,9 @@ }, { "value": "AL2_x86_64_GPU" + }, + { + "value": "AL2_ARM_64" } ] } @@ -115,7 +118,7 @@ "sdkId": "EKS", "arnNamespace": "eks", "cloudFormationName": "EKS", - "cloudTrailEventSource": "fe.wesley.amazonaws.com" + "cloudTrailEventSource": "eks.amazonaws.com" }, "aws.auth#sigv4": { "name": "eks" @@ -199,19 +202,19 @@ "com.amazonaws.eks#ClientException": { "type": "structure", "members": { - "clusterName": { + "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" } }, "message": { "target": "com.amazonaws.eks#String" }, - "nodegroupName": { + "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" } } }, @@ -224,46 +227,46 @@ "com.amazonaws.eks#Cluster": { "type": "structure", "members": { - "clientRequestToken": { + "endpoint": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" + "smithy.api#documentation": "

The endpoint for your Kubernetes API server.

" } }, - "identity": { - "target": "com.amazonaws.eks#Identity", + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigResponse", "traits": { - "smithy.api#documentation": "

The identity provider information for the cluster.

" + "smithy.api#documentation": "

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide.

" } }, - "platformVersion": { - "target": "com.amazonaws.eks#String", + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

The platform version of your Amazon EKS cluster. For more information, see Platform\n Versions in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the cluster was created.

" } }, - "roleArn": { - "target": "com.amazonaws.eks#String", + "status": { + "target": "com.amazonaws.eks#ClusterStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control\n plane to make calls to AWS API operations on your behalf.

" + "smithy.api#documentation": "

The current status of the cluster.

" } }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", + "kubernetesNetworkConfig": { + "target": "com.amazonaws.eks#KubernetesNetworkConfigResponse", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the cluster was created.

" + "smithy.api#documentation": "

Network configuration settings for your cluster.

" } }, - "logging": { - "target": "com.amazonaws.eks#Logging", + "certificateAuthority": { + "target": "com.amazonaws.eks#Certificate", "traits": { - "smithy.api#documentation": "

The logging configuration for your cluster.

" + "smithy.api#documentation": "

The certificate-authority-data for your cluster.

" } }, - "arn": { - "target": "com.amazonaws.eks#String", + "logging": { + "target": "com.amazonaws.eks#Logging", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

" + "smithy.api#documentation": "

The logging configuration for your cluster.

" } }, "name": { @@ -272,28 +275,28 @@ "smithy.api#documentation": "

The name of the cluster.

" } }, - "resourcesVpcConfig": { - "target": "com.amazonaws.eks#VpcConfigResponse", + "arn": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

" } }, - "endpoint": { - "target": "com.amazonaws.eks#String", + "identity": { + "target": "com.amazonaws.eks#Identity", "traits": { - "smithy.api#documentation": "

The endpoint for your Kubernetes API server.

" + "smithy.api#documentation": "

The identity provider information for the cluster.

" } }, - "certificateAuthority": { - "target": "com.amazonaws.eks#Certificate", + "roleArn": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The certificate-authority-data for your cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control\n plane to make calls to AWS API operations on your behalf.

" } }, - "status": { - "target": "com.amazonaws.eks#ClusterStatus", + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", "traits": { - "smithy.api#documentation": "

The current status of the cluster.

" + "smithy.api#documentation": "

The encryption configuration for the cluster.

" } }, "tags": { @@ -302,10 +305,16 @@ "smithy.api#documentation": "

The metadata that you apply to the cluster to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Cluster tags do not propagate to any other resources associated with the\n cluster.

" } }, - "encryptionConfig": { - "target": "com.amazonaws.eks#EncryptionConfigList", + "platformVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The platform version of your Amazon EKS cluster. For more information, see Platform\n Versions in the \n Amazon EKS User Guide\n .

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The encryption configuration for the\n cluster.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" } }, "version": { @@ -394,19 +403,25 @@ "com.amazonaws.eks#CreateClusterRequest": { "type": "structure", "members": { - "logging": { - "target": "com.amazonaws.eks#Logging", + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", "traits": { - "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more\n information, see Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see Amazon CloudWatch Pricing.

\n " + "smithy.api#documentation": "

The encryption configuration for the cluster.

" } }, - "name": { - "target": "com.amazonaws.eks#ClusterName", + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigRequest", "traits": { - "smithy.api#documentation": "

The unique name to give to your cluster.

", + "smithy.api#documentation": "

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five\n security groups, but we recommend that you use a dedicated security group for your\n cluster control plane.

", "smithy.api#required": {} } }, + "logging": { + "target": "com.amazonaws.eks#Logging", + "traits": { + "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more\n information, see Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see Amazon CloudWatch Pricing.

\n " + } + }, "clientRequestToken": { "target": "com.amazonaws.eks#String", "traits": { @@ -414,16 +429,17 @@ "smithy.api#idempotencyToken": {} } }, - "encryptionConfig": { - "target": "com.amazonaws.eks#EncryptionConfigList", + "roleArn": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The encryption configuration for the\n cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control\n plane to make calls to AWS API operations on your behalf. For more information, see\n Amazon EKS\n Service IAM Role in the \n Amazon EKS User Guide\n .

", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.eks#TagMap", + "kubernetesNetworkConfig": { + "target": "com.amazonaws.eks#KubernetesNetworkConfigRequest", "traits": { - "smithy.api#documentation": "

The metadata to apply to the cluster to assist with categorization and organization.\n Each tag consists of a key and an optional value, both of which you define.

" + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster.

" } }, "version": { @@ -432,17 +448,16 @@ "smithy.api#documentation": "

The desired Kubernetes version for your cluster. If you don't specify a value here,\n the latest version available in Amazon EKS is used.

" } }, - "roleArn": { - "target": "com.amazonaws.eks#String", + "tags": { + "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to\n other AWS API operations on your behalf. For more information, see Amazon EKS Service\n IAM Role in the \n Amazon EKS User Guide\n .

", - "smithy.api#required": {} + "smithy.api#documentation": "

The metadata to apply to the cluster to assist with categorization and organization.\n Each tag consists of a key and an optional value, both of which you define.

" } }, - "resourcesVpcConfig": { - "target": "com.amazonaws.eks#VpcConfigRequest", + "name": { + "target": "com.amazonaws.eks#ClusterName", "traits": { - "smithy.api#documentation": "

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five\n security groups, but we recommend that you use a dedicated security group for your\n cluster control plane.

", + "smithy.api#documentation": "

The unique name to give to your cluster.

", "smithy.api#required": {} } } @@ -499,10 +514,11 @@ "com.amazonaws.eks#CreateFargateProfileRequest": { "type": "structure", "members": { - "subnets": { - "target": "com.amazonaws.eks#StringList", + "fargateProfileName": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The IDs of subnets to launch your pods into. At this time, pods running on Fargate are\n not assigned public IP addresses, so only private subnets (with no direct route to an\n Internet Gateway) are accepted for this parameter.

" + "smithy.api#documentation": "

The name of the Fargate profile.

", + "smithy.api#required": {} } }, "selectors": { @@ -511,24 +527,16 @@ "smithy.api#documentation": "

The selectors to match for pods to use this Fargate profile. Each selector must have an\n associated namespace. Optionally, you can also specify labels for a namespace. You may\n specify up to five selectors in a Fargate profile.

" } }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "

The metadata to apply to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.

" - } - }, - "podExecutionRoleArn": { - "target": "com.amazonaws.eks#String", + "subnets": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in\n the Fargate profile. The pod execution role allows Fargate infrastructure to register with\n your cluster as a node, and it provides read access to Amazon ECR image repositories. For\n more information, see Pod Execution Role in the\n Amazon EKS User Guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IDs of subnets to launch your pods into. At this time, pods running on Fargate are\n not assigned public IP addresses, so only private subnets (with no direct route to an\n Internet Gateway) are accepted for this parameter.

" } }, - "fargateProfileName": { - "target": "com.amazonaws.eks#String", + "tags": { + "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "

The name of the Fargate profile.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The metadata to apply to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.

" } }, "clusterName": { @@ -545,6 +553,13 @@ "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", "smithy.api#idempotencyToken": {} } + }, + "podExecutionRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in\n the Fargate profile. The pod execution role allows Fargate infrastructure to register with\n your cluster as a node, and it provides read access to Amazon ECR image repositories. For\n more information, see Pod Execution Role in the\n Amazon EKS User Guide.

", + "smithy.api#required": {} + } } } }, @@ -591,7 +606,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a managed worker node group for an Amazon EKS cluster. You can only create a node\n group for your cluster that is equal to the current Kubernetes version for the cluster.\n All node groups are created with the latest AMI release version for the respective minor\n Kubernetes version of the cluster.

\n

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that\n are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the\n Amazon EKS-optimized Amazon Linux 2 AMI. For more information, see Managed\n Node Groups in the Amazon EKS User Guide.

", + "smithy.api#documentation": "

Creates a managed worker node group for an Amazon EKS cluster. You can only create a node\n group for your cluster that is equal to the current Kubernetes version for the cluster.\n All node groups are created with the latest AMI release version for the respective minor\n Kubernetes version of the cluster, unless you deploy a custom AMI using a launch\n template. For more information about using launch templates, see Launch\n template support.

\n

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that\n are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the\n Amazon EKS-optimized Amazon Linux 2 AMI. For more information, see Managed\n Node Groups in the Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups", @@ -602,62 +617,67 @@ "com.amazonaws.eks#CreateNodegroupRequest": { "type": "structure", "members": { - "subnets": { - "target": "com.amazonaws.eks#StringList", + "tags": { + "target": "com.amazonaws.eks#TagMap", "traits": { - "smithy.api#documentation": "

The subnets to use for the Auto Scaling group that is created for your node group.\n These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with\n a value of shared, where CLUSTER_NAME is replaced with the\n name of your cluster.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The metadata to apply to the node group to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Node group tags do not propagate to any other resources associated with the node\n group, such as the Amazon EC2 instances or subnets.

" } }, - "nodegroupName": { + "version": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The unique name to give your node group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Kubernetes version to use for your managed nodes. By default, the Kubernetes\n version of the cluster is used, and this is the only accepted specified value.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, - "amiType": { - "target": "com.amazonaws.eks#AMITypes", + "remoteAccess": { + "target": "com.amazonaws.eks#RemoteAccessConfig", "traits": { - "smithy.api#documentation": "

The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with\n GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which\n uses the Amazon EKS-optimized Linux AMI.

" + "smithy.api#documentation": "

The remote access (SSH) configuration to use with your node group. If you specify launchTemplate,\n then don't specify remoteAccess, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, - "nodeRole": { - "target": "com.amazonaws.eks#String", + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node\n kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes\n receive permissions for these API calls through an IAM instance profile and associated\n policies. Before you can launch worker nodes and register them into a cluster, you must\n create an IAM role for those worker nodes to use when they are launched. For more\n information, see Amazon EKS Worker Node IAM Role in the\n \n Amazon EKS User Guide\n .

", - "smithy.api#required": {} + "smithy.api#documentation": "

An object representing a node group's launch template specification. If specified,\n then do not specify instanceTypes, diskSize, or\n remoteAccess and make sure that the launch template meets the\n requirements in launchTemplateSpecification.

" } }, - "instanceTypes": { - "target": "com.amazonaws.eks#StringList", + "releaseVersion": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The instance type to use for your node group. Currently, you can specify a single\n instance type for a node group. The default value for this parameter is\n t3.medium. If you choose a GPU instance type, be sure to specify the\n AL2_x86_64_GPU with the amiType parameter.

" + "smithy.api#documentation": "

The AMI version of the Amazon EKS-optimized AMI to use with your node group. By default,\n the latest available AMI version for the node group's current Kubernetes version is\n used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, - "releaseVersion": { + "nodeRole": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The AMI version of the Amazon EKS-optimized AMI to use with your node group. By default,\n the latest available AMI version for the node group's current Kubernetes version is\n used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker\n node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes\n receive permissions for these API calls through an IAM instance profile and associated\n policies. Before you can launch worker nodes and register them into a cluster, you must\n create an IAM role for those worker nodes to use when they are launched. For more\n information, see Amazon EKS Worker Node IAM Role in the\n \n Amazon EKS User Guide\n . If you specify launchTemplate, then don't specify \n \n IamInstanceProfile\n in your launch template, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

", + "smithy.api#required": {} } }, - "remoteAccess": { - "target": "com.amazonaws.eks#RemoteAccessConfig", + "instanceTypes": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The remote access (SSH) configuration to use with your node group.

" + "smithy.api#documentation": "

The instance type to use for your node group. You can specify a single instance type\n for a node group. The default value for instanceTypes is\n t3.medium. If you choose a GPU instance type, be sure to specify\n AL2_x86_64_GPU with the amiType parameter.\n If you specify launchTemplate, then don't specify instanceTypes, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, - "scalingConfig": { - "target": "com.amazonaws.eks#NodegroupScalingConfig", + "subnets": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The scaling configuration details for the Auto Scaling group that is created for your\n node group.

" + "smithy.api#documentation": "

The subnets to use for the Auto Scaling group that is created for your node group.\n These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with\n a value of shared, where CLUSTER_NAME is replaced with the\n name of your cluster. If you specify launchTemplate, then don't specify \n SubnetId\n in your launch template, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

", + "smithy.api#required": {} } }, - "clientRequestToken": { + "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The unique name to give your node group.

", + "smithy.api#required": {} + } + }, + "amiType": { + "target": "com.amazonaws.eks#AMITypes", + "traits": { + "smithy.api#documentation": "

The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS-optimized Amazon Linux 2 AMI.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "clusterName": { @@ -668,28 +688,29 @@ "smithy.api#required": {} } }, - "diskSize": { - "target": "com.amazonaws.eks#BoxedInteger", + "labels": { + "target": "com.amazonaws.eks#labelsMap", "traits": { - "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB.

" + "smithy.api#documentation": "

The Kubernetes labels to be applied to the nodes in the node group when they are\n created.

" } }, - "version": { - "target": "com.amazonaws.eks#String", + "diskSize": { + "target": "com.amazonaws.eks#BoxedInteger", "traits": { - "smithy.api#documentation": "

The Kubernetes version to use for your managed nodes. By default, the Kubernetes\n version of the cluster is used, and this is the only accepted specified value.

" + "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB. If you specify launchTemplate, then don't specify diskSize,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, - "tags": { - "target": "com.amazonaws.eks#TagMap", + "clientRequestToken": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The metadata to apply to the node group to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Node group tags do not propagate to any other resources associated with the node\n group, such as the Amazon EC2 instances or subnets.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} } }, - "labels": { - "target": "com.amazonaws.eks#labelsMap", + "scalingConfig": { + "target": "com.amazonaws.eks#NodegroupScalingConfig", "traits": { - "smithy.api#documentation": "

The Kubernetes labels to be applied to the nodes in the node group when they are\n created.

" + "smithy.api#documentation": "

The scaling configuration details for the Auto Scaling group that is created for your\n node group.

" } } } @@ -797,18 +818,18 @@ "com.amazonaws.eks#DeleteFargateProfileRequest": { "type": "structure", "members": { - "fargateProfileName": { + "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Fargate profile to delete.

", + "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the Fargate profile to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "clusterName": { + "fargateProfileName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the Fargate profile to delete.

", + "smithy.api#documentation": "

The name of the Fargate profile to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -866,18 +887,18 @@ "com.amazonaws.eks#DeleteNodegroupRequest": { "type": "structure", "members": { - "nodegroupName": { + "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the node group to delete.

", + "smithy.api#documentation": "

The name of the Amazon EKS cluster that is associated with your node group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "clusterName": { + "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster that is associated with your node group.

", + "smithy.api#documentation": "

The name of the node group to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1050,18 +1071,18 @@ "com.amazonaws.eks#DescribeNodegroupRequest": { "type": "structure", "members": { - "nodegroupName": { + "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the node group to describe.

", + "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the node group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "clusterName": { + "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the node group.

", + "smithy.api#documentation": "

The name of the node group to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1113,6 +1134,14 @@ "com.amazonaws.eks#DescribeUpdateRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "updateId": { "target": "com.amazonaws.eks#String", "traits": { @@ -1127,14 +1156,6 @@ "smithy.api#documentation": "

The name of the Amazon EKS node group associated with the update.

", "smithy.api#httpQuery": "nodegroupName" } - }, - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -1152,21 +1173,21 @@ "com.amazonaws.eks#EncryptionConfig": { "type": "structure", "members": { - "provider": { - "target": "com.amazonaws.eks#Provider", + "resources": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

AWS Key Management Service (AWS KMS) customer master key\n (CMK). Either the ARN or the alias can be used.

" + "smithy.api#documentation": "

Specifies the resources to be encrypted. The only supported value is \"secrets\".

" } }, - "resources": { - "target": "com.amazonaws.eks#StringList", + "provider": { + "target": "com.amazonaws.eks#Provider", "traits": { - "smithy.api#documentation": "

Specifies the resources to be encrypted.\n The only supported value is \"secrets\".

" + "smithy.api#documentation": "

AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be\n used.

" } } }, "traits": { - "smithy.api#documentation": "

The encryption configuration for the\n cluster.

" + "smithy.api#documentation": "

The encryption configuration for the cluster.

" } }, "com.amazonaws.eks#EncryptionConfigList": { @@ -1228,6 +1249,10 @@ { "value": "InsufficientFreeAddresses", "name": "INSUFFICIENT_FREE_ADDRESSES" + }, + { + "value": "ClusterUnreachable", + "name": "CLUSTER_UNREACHABLE" } ] } @@ -1241,17 +1266,17 @@ "smithy.api#documentation": "

An optional field that contains the resource IDs associated with the error.

" } }, - "errorMessage": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

A more complete description of the error.

" - } - }, "errorCode": { "target": "com.amazonaws.eks#ErrorCode", "traits": { "smithy.api#documentation": "

A brief description of the error.

\n " } + }, + "errorMessage": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A more complete description of the error.

" + } } }, "traits": { @@ -1267,16 +1292,10 @@ "com.amazonaws.eks#FargateProfile": { "type": "structure", "members": { - "fargateProfileArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Fargate profile.

" - } - }, - "subnets": { - "target": "com.amazonaws.eks#StringList", + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

The IDs of subnets to launch pods into.

" + "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the Fargate profile was created.

" } }, "fargateProfileName": { @@ -1285,10 +1304,10 @@ "smithy.api#documentation": "

The name of the Fargate profile.

" } }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", + "selectors": { + "target": "com.amazonaws.eks#FargateProfileSelectors", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the Fargate profile was created.

" + "smithy.api#documentation": "

The selectors to match for pods to use this Fargate profile.

" } }, "clusterName": { @@ -1297,28 +1316,34 @@ "smithy.api#documentation": "

The name of the Amazon EKS cluster that the Fargate profile belongs to.

" } }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "

The metadata applied to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.

" - } - }, "podExecutionRoleArn": { "target": "com.amazonaws.eks#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in\n the Fargate profile. For more information, see Pod\n Execution Role in the Amazon EKS User Guide.

" } }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

The metadata applied to the Fargate profile to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Fargate profile tags do not propagate to any other resources associated with the\n Fargate profile, such as the pods that are scheduled with it.

" + } + }, "status": { "target": "com.amazonaws.eks#FargateProfileStatus", "traits": { "smithy.api#documentation": "

The current status of the Fargate profile.

" } }, - "selectors": { - "target": "com.amazonaws.eks#FargateProfileSelectors", + "fargateProfileArn": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The selectors to match for pods to use this Fargate profile.

" + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Fargate profile.

" + } + }, + "subnets": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of subnets to launch pods into.

" } } }, @@ -1338,17 +1363,17 @@ "com.amazonaws.eks#FargateProfileSelector": { "type": "structure", "members": { - "namespace": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The Kubernetes namespace that the selector should match.

" - } - }, "labels": { "target": "com.amazonaws.eks#FargateProfileLabel", "traits": { "smithy.api#documentation": "

The Kubernetes labels that the selector should match. A pod must contain all of the\n labels that are specified in the selector for it to be considered a match.

" } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes namespace that the selector should match.

" + } } }, "traits": { @@ -1410,11 +1435,8 @@ "com.amazonaws.eks#InvalidParameterException": { "type": "structure", "members": { - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" - } + "message": { + "target": "com.amazonaws.eks#String" }, "fargateProfileName": { "target": "com.amazonaws.eks#String", @@ -1422,8 +1444,11 @@ "smithy.api#documentation": "

The Fargate profile associated with the exception.

" } }, - "message": { - "target": "com.amazonaws.eks#String" + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + } }, "clusterName": { "target": "com.amazonaws.eks#String", @@ -1441,19 +1466,19 @@ "com.amazonaws.eks#InvalidRequestException": { "type": "structure", "members": { - "clusterName": { + "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" } }, "message": { "target": "com.amazonaws.eks#String" }, - "nodegroupName": { + "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" } } }, @@ -1466,10 +1491,10 @@ "com.amazonaws.eks#Issue": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.eks#NodegroupIssueCode", + "resourceIds": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

A brief description of the error.

\n " + "smithy.api#documentation": "

The AWS resources that are afflicted by this issue.

" } }, "message": { @@ -1478,10 +1503,10 @@ "smithy.api#documentation": "

The error message associated with the issue.

" } }, - "resourceIds": { - "target": "com.amazonaws.eks#StringList", + "code": { + "target": "com.amazonaws.eks#NodegroupIssueCode", "traits": { - "smithy.api#documentation": "

The AWS resources that are afflicted by this issue.

" + "smithy.api#documentation": "

A brief description of the error.

\n " } } }, @@ -1495,6 +1520,60 @@ "target": "com.amazonaws.eks#Issue" } }, + "com.amazonaws.eks#KubernetesNetworkConfigRequest": { + "type": "structure", + "members": { + "serviceIpv4Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks\n that are peered or connected to your VPC. The block must meet the following requirements:

\n \n \n

You can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster.

" + } + }, + "com.amazonaws.eks#KubernetesNetworkConfigResponse": { + "type": "structure", + "members": { + "serviceIpv4Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't specify a CIDR block, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it\n cannot be changed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster.

" + } + }, + "com.amazonaws.eks#LaunchTemplateSpecification": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the launch template to use. If no version is specified, then the\n template's default version is used.

" + } + }, + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ID of the launch template.

" + } + }, + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n cannot include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or update\n will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API Reference.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

\n

Specify either name or id, but not both.

" + } + }, "com.amazonaws.eks#ListClusters": { "type": "operation", "input": { @@ -1626,36 +1705,36 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.eks#FargateProfilesRequestMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of Fargate profile results returned by\n ListFargateProfiles in paginated output. When you use this parameter,\n ListFargateProfiles returns only maxResults results in a\n single page along with a nextToken response element. You can see the\n remaining results of the initial request by sending another\n ListFargateProfiles request with the returned nextToken\n value. This value can be between 1 and 100. If you don't\n use this parameter, ListFargateProfiles returns up to 100\n results and a nextToken value if applicable.

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.eks#String", "traits": { "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListFargateProfiles request where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.eks#FargateProfilesRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of Fargate profile results returned by\n ListFargateProfiles in paginated output. When you use this parameter,\n ListFargateProfiles returns only maxResults results in a\n single page along with a nextToken response element. You can see the\n remaining results of the initial request by sending another\n ListFargateProfiles request with the returned nextToken\n value. This value can be between 1 and 100. If you don't\n use this parameter, ListFargateProfiles returns up to 100\n results and a nextToken value if applicable.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.eks#ListFargateProfilesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future\n ListFargateProfiles request. When the results of a\n ListFargateProfiles request exceed maxResults, you can use\n this value to retrieve the next page of results. This value is null when\n there are no more results to return.

" - } - }, "fargateProfileNames": { "target": "com.amazonaws.eks#StringList", "traits": { "smithy.api#documentation": "

A list of all of the Fargate profiles associated with the specified cluster.

" } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future\n ListFargateProfiles request. When the results of a\n ListFargateProfiles request exceed maxResults, you can use\n this value to retrieve the next page of results. This value is null when\n there are no more results to return.

" + } } } }, @@ -1685,7 +1764,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS\n account in the specified Region. Self-managed node groups are not listed.

", + "smithy.api#documentation": "

Lists the Amazon EKS managed node groups associated with the specified cluster in your\n AWS account in the specified Region. Self-managed node groups are not listed.

", "smithy.api#http": { "method": "GET", "uri": "/clusters/{clusterName}/node-groups", @@ -1702,6 +1781,13 @@ "com.amazonaws.eks#ListNodegroupsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.eks#ListNodegroupsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of node group results returned by ListNodegroups in\n paginated output. When you use this parameter, ListNodegroups returns only\n maxResults results in a single page along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another ListNodegroups request with the returned nextToken\n value. This value can be between 1 and 100. If you don't\n use this parameter, ListNodegroups returns up to 100\n results and a nextToken value if applicable.

", + "smithy.api#httpQuery": "maxResults" + } + }, "nextToken": { "target": "com.amazonaws.eks#String", "traits": { @@ -1716,13 +1802,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "maxResults": { - "target": "com.amazonaws.eks#ListNodegroupsRequestMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of node group results returned by ListNodegroups in\n paginated output. When you use this parameter, ListNodegroups returns only\n maxResults results in a single page along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another ListNodegroups request with the returned nextToken\n value. This value can be between 1 and 100. If you don't\n use this parameter, ListNodegroups returns up to 100\n results and a nextToken value if applicable.

", - "smithy.api#httpQuery": "maxResults" - } } } }, @@ -1739,17 +1818,17 @@ "com.amazonaws.eks#ListNodegroupsResponse": { "type": "structure", "members": { - "nodegroups": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "

A list of all of the node groups associated with the specified cluster.

" - } - }, "nextToken": { "target": "com.amazonaws.eks#String", "traits": { "smithy.api#documentation": "

The nextToken value to include in a future ListNodegroups\n request. When the results of a ListNodegroups request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" } + }, + "nodegroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

A list of all of the node groups associated with the specified cluster.

" + } } } }, @@ -1842,6 +1921,14 @@ "com.amazonaws.eks#ListUpdatesRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster to list updates for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "nextToken": { "target": "com.amazonaws.eks#String", "traits": { @@ -1862,14 +1949,6 @@ "smithy.api#documentation": "

The name of the Amazon EKS managed node group to list updates for.

", "smithy.api#httpQuery": "nodegroupName" } - }, - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster to list updates for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -1886,17 +1965,17 @@ "com.amazonaws.eks#ListUpdatesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future ListUpdates\n request. When the results of a ListUpdates request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" - } - }, "updateIds": { "target": "com.amazonaws.eks#StringList", "traits": { "smithy.api#documentation": "

A list of all the updates for the specified cluster and Region.

" } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListUpdates\n request. When the results of a ListUpdates request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } } } }, @@ -1976,34 +2055,40 @@ "com.amazonaws.eks#Nodegroup": { "type": "structure", "members": { - "resources": { - "target": "com.amazonaws.eks#NodegroupResources", + "nodegroupName": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The resources associated with the node group, such as Auto Scaling groups and security\n groups for remote access.

" + "smithy.api#documentation": "

The name associated with an Amazon EKS managed node group.

" } }, - "releaseVersion": { - "target": "com.amazonaws.eks#String", + "amiType": { + "target": "com.amazonaws.eks#AMITypes", "traits": { - "smithy.api#documentation": "

The AMI version of the managed node group. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

If the node group was deployed using a launch template with a custom AMI, then this is\n CUSTOM. For node groups that weren't deployed using a launch template,\n this is the AMI type that was specified in the node group configuration.

" } }, - "diskSize": { - "target": "com.amazonaws.eks#BoxedInteger", + "labels": { + "target": "com.amazonaws.eks#labelsMap", "traits": { - "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB.

" + "smithy.api#documentation": "

The Kubernetes labels applied to the nodes in the node group.

\n \n

Only labels that are applied with the Amazon EKS API are shown here. There may be other\n Kubernetes labels applied to the nodes in this group.

\n " } }, - "remoteAccess": { - "target": "com.amazonaws.eks#RemoteAccessConfig", + "subnets": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The remote access (SSH) configuration that is associated with the node group.

" + "smithy.api#documentation": "

The subnets that were specified for the Auto Scaling group that is associated with\n your node group.

" } }, - "labels": { - "target": "com.amazonaws.eks#labelsMap", + "health": { + "target": "com.amazonaws.eks#NodegroupHealth", "traits": { - "smithy.api#documentation": "

The Kubernetes labels applied to the nodes in the node group.

\n \n

Only labels that are applied with the Amazon EKS API are shown here. There may be other\n Kubernetes labels applied to the nodes in this group.

\n " + "smithy.api#documentation": "

The health status of the node group. If there are issues with your node group's\n health, they are listed here.

" + } + }, + "status": { + "target": "com.amazonaws.eks#NodegroupStatus", + "traits": { + "smithy.api#documentation": "

The current status of the managed node group.

" } }, "clusterName": { @@ -2012,6 +2097,18 @@ "smithy.api#documentation": "

The name of the cluster that the managed node group resides in.

" } }, + "nodegroupArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the managed node group.

" + } + }, + "remoteAccess": { + "target": "com.amazonaws.eks#RemoteAccessConfig", + "traits": { + "smithy.api#documentation": "

If the node group wasn't deployed with a launch template, then this is the remote\n access configuration that is associated with the node group. If the node group was\n deployed with a launch template, then this is\n null.

" + } + }, "modifiedAt": { "target": "com.amazonaws.eks#Timestamp", "traits": { @@ -2024,22 +2121,22 @@ "smithy.api#documentation": "

The scaling configuration details for the Auto Scaling group that is associated with\n your node group.

" } }, - "nodeRole": { - "target": "com.amazonaws.eks#String", + "resources": { + "target": "com.amazonaws.eks#NodegroupResources", "traits": { - "smithy.api#documentation": "

The IAM role associated with your node group. The Amazon EKS worker node\n kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes\n receive permissions for these API calls through an IAM instance profile and associated\n policies. Before you can launch worker nodes and register them into a cluster, you must\n create an IAM role for those worker nodes to use when they are launched. For more\n information, see Amazon EKS Worker Node IAM Role in the\n \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

The resources associated with the node group, such as Auto Scaling groups and security\n groups for remote access.

" } }, - "status": { - "target": "com.amazonaws.eks#NodegroupStatus", + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The current status of the managed node group.

" + "smithy.api#documentation": "

If a launch template was used to create the node group, then this is the launch\n template that was used.

" } }, - "health": { - "target": "com.amazonaws.eks#NodegroupHealth", + "instanceTypes": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The health status of the node group. If there are issues with your node group's\n health, they are listed here.

" + "smithy.api#documentation": "

If the node group wasn't deployed with a launch template, then this is the instance\n type that is associated with the node group. If the node group was deployed with a\n launch template, then this is null.

" } }, "tags": { @@ -2054,40 +2151,28 @@ "smithy.api#documentation": "

The Kubernetes version of the managed node group.

" } }, - "nodegroupArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the managed node group.

" - } - }, - "amiType": { - "target": "com.amazonaws.eks#AMITypes", - "traits": { - "smithy.api#documentation": "

The AMI type associated with your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with\n GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which\n uses the Amazon EKS-optimized Linux AMI.

" - } - }, - "subnets": { - "target": "com.amazonaws.eks#StringList", + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

The subnets allowed for the Auto Scaling group that is associated with your node\n group. These subnets must have the following tag:\n kubernetes.io/cluster/CLUSTER_NAME, where CLUSTER_NAME is\n replaced with the name of your cluster.

" + "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the managed node group was\n created.

" } }, - "nodegroupName": { + "nodeRole": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name associated with an Amazon EKS managed node group.

" + "smithy.api#documentation": "

The IAM role associated with your node group. The Amazon EKS worker node\n kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes\n receive permissions for these API calls through an IAM instance profile and associated\n policies.

" } }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", + "diskSize": { + "target": "com.amazonaws.eks#BoxedInteger", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the managed node group was\n created.

" + "smithy.api#documentation": "

If the node group wasn't deployed with a launch template, then this is the disk size\n in the node group configuration. If the node group was deployed with a launch template,\n then this is null.

" } }, - "instanceTypes": { - "target": "com.amazonaws.eks#StringList", + "releaseVersion": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The instance types associated with your node group.

" + "smithy.api#documentation": "

If the node group was deployed using a launch template with a custom AMI, then this is\n the AMI ID that was specified in the launch template. For node groups that weren't\n deployed using a launch template, this is the version of the Amazon EKS-optimized AMI that\n the node group was deployed with.

" } } }, @@ -2180,6 +2265,10 @@ { "value": "InternalFailure", "name": "INTERNAL_FAILURE" + }, + { + "value": "ClusterUnreachable", + "name": "CLUSTER_UNREACHABLE" } ] } @@ -2187,17 +2276,17 @@ "com.amazonaws.eks#NodegroupResources": { "type": "structure", "members": { - "autoScalingGroups": { - "target": "com.amazonaws.eks#AutoScalingGroupList", - "traits": { - "smithy.api#documentation": "

The Auto Scaling groups associated with the node group.

" - } - }, "remoteAccessSecurityGroup": { "target": "com.amazonaws.eks#String", "traits": { "smithy.api#documentation": "

The remote access security group associated with the node group. This security group\n controls SSH access to the worker nodes.

" } + }, + "autoScalingGroups": { + "target": "com.amazonaws.eks#AutoScalingGroupList", + "traits": { + "smithy.api#documentation": "

The Auto Scaling groups associated with the node group.

" + } } }, "traits": { @@ -2213,21 +2302,21 @@ "smithy.api#documentation": "

The maximum number of worker nodes that the managed node group can scale out to.\n Managed node groups can support up to 100 nodes by default.

" } }, - "desiredSize": { + "minSize": { "target": "com.amazonaws.eks#Capacity", "traits": { - "smithy.api#documentation": "

The current number of worker nodes that the managed node group should maintain.

" + "smithy.api#documentation": "

The minimum number of worker nodes that the managed node group can scale in to. This\n number must be greater than zero.

" } }, - "minSize": { + "desiredSize": { "target": "com.amazonaws.eks#Capacity", "traits": { - "smithy.api#documentation": "

The minimum number of worker nodes that the managed node group can scale in to. This\n number must be greater than zero.

" + "smithy.api#documentation": "

The current number of worker nodes that the managed node group should maintain.

" } } }, "traits": { - "smithy.api#documentation": "

An object representing the scaling configuration details for the Auto Scaling group\n that is associated with your node group.

" + "smithy.api#documentation": "

An object representing the scaling configuration details for the Auto Scaling group\n that is associated with your node group. If you specify a value for any property, then\n you must specify values for all of the properties.

" } }, "com.amazonaws.eks#NodegroupStatus": { @@ -2291,28 +2380,28 @@ "keyArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as\n the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more\n information, see Allowing Users in Other Accounts to Use\n a CMK in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric,\n created in the same region as the cluster, and if the CMK was created in a different\n account, the user must have access to the CMK. For more information, see Allowing\n Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer\n Guide.

" } } }, "traits": { - "smithy.api#documentation": "

Identifies the AWS Key Management Service (AWS KMS) customer\n master key (CMK) used to encrypt the secrets.

" + "smithy.api#documentation": "

Identifies the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the\n secrets.

" } }, "com.amazonaws.eks#RemoteAccessConfig": { "type": "structure", "members": { - "sourceSecurityGroups": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "

The security groups that are allowed SSH access (port 22) to the worker nodes. If you\n specify an Amazon EC2 SSH key but do not specify a source security group when you create a\n managed node group, then port 22 on the worker nodes is opened to the internet\n (0.0.0.0/0). For more information, see Security\n Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" - } - }, "ec2SshKey": { "target": "com.amazonaws.eks#String", "traits": { "smithy.api#documentation": "

The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in\n the managed node group. For more information, see Amazon EC2 Key\n Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

" } + }, + "sourceSecurityGroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The security groups that are allowed SSH access (port 22) to the worker nodes. If you\n specify an Amazon EC2 SSH key but do not specify a source security group when you create a\n managed node group, then port 22 on the worker nodes is opened to the internet\n (0.0.0.0/0). For more information, see Security\n Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + } } }, "traits": { @@ -2347,6 +2436,12 @@ "com.amazonaws.eks#ResourceLimitExceededException": { "type": "structure", "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } + }, "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { @@ -2355,12 +2450,6 @@ }, "message": { "target": "com.amazonaws.eks#String" - }, - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" - } } }, "traits": { @@ -2372,13 +2461,10 @@ "com.amazonaws.eks#ResourceNotFoundException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.eks#String" - }, - "fargateProfileName": { + "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Fargate profile associated with the exception.

" + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" } }, "nodegroupName": { @@ -2387,10 +2473,13 @@ "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" } }, - "clusterName": { + "message": { + "target": "com.amazonaws.eks#String" + }, + "fargateProfileName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + "smithy.api#documentation": "

The Fargate profile associated with the exception.

" } } }, @@ -2403,12 +2492,6 @@ "com.amazonaws.eks#ServerException": { "type": "structure", "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" - } - }, "message": { "target": "com.amazonaws.eks#String" }, @@ -2417,6 +2500,12 @@ "traits": { "smithy.api#documentation": "

The Amazon EKS managed node group associated with the exception.

" } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon EKS cluster associated with the exception.

" + } } }, "traits": { @@ -2547,6 +2636,12 @@ "com.amazonaws.eks#UnsupportedAvailabilityZoneException": { "type": "structure", "members": { + "validZones": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "

The supported Availability Zones for your account. Choose subnets in these\n Availability Zones for your cluster.

" + } + }, "clusterName": { "target": "com.amazonaws.eks#String", "traits": { @@ -2561,12 +2656,6 @@ }, "message": { "target": "com.amazonaws.eks#String" - }, - "validZones": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "

The supported Availability Zones for your account. Choose subnets in these\n Availability Zones for your cluster.

" - } } }, "traits": { @@ -2603,14 +2692,6 @@ "com.amazonaws.eks#UntagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported\n resources are Amazon EKS clusters and managed node groups.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "tagKeys": { "target": "com.amazonaws.eks#TagKeyList", "traits": { @@ -2618,6 +2699,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "resourceArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported\n resources are Amazon EKS clusters and managed node groups.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -2628,22 +2717,22 @@ "com.amazonaws.eks#Update": { "type": "structure", "members": { - "params": { - "target": "com.amazonaws.eks#UpdateParams", + "status": { + "target": "com.amazonaws.eks#UpdateStatus", "traits": { - "smithy.api#documentation": "

A key-value map that contains the parameters associated with the update.

" + "smithy.api#documentation": "

The current status of the update.

" } }, - "id": { - "target": "com.amazonaws.eks#String", + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

A UUID that is used to track the update.

" + "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the update was created.

" } }, - "status": { - "target": "com.amazonaws.eks#UpdateStatus", + "errors": { + "target": "com.amazonaws.eks#ErrorDetails", "traits": { - "smithy.api#documentation": "

The current status of the update.

" + "smithy.api#documentation": "

Any errors associated with a Failed update.

" } }, "type": { @@ -2652,16 +2741,16 @@ "smithy.api#documentation": "

The type of the update.

" } }, - "errors": { - "target": "com.amazonaws.eks#ErrorDetails", + "params": { + "target": "com.amazonaws.eks#UpdateParams", "traits": { - "smithy.api#documentation": "

Any errors associated with a Failed update.

" + "smithy.api#documentation": "

A key-value map that contains the parameters associated with the update.

" } }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", + "id": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the update was created.

" + "smithy.api#documentation": "

A UUID that is used to track the update.

" } } }, @@ -2709,16 +2798,6 @@ "com.amazonaws.eks#UpdateClusterConfigRequest": { "type": "structure", "members": { - "resourcesVpcConfig": { - "target": "com.amazonaws.eks#VpcConfigRequest" - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, "logging": { "target": "com.amazonaws.eks#Logging", "traits": { @@ -2732,6 +2811,16 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigRequest" + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } } } }, @@ -2783,12 +2872,11 @@ "com.amazonaws.eks#UpdateClusterVersionRequest": { "type": "structure", "members": { - "name": { + "clientRequestToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} } }, "version": { @@ -2798,11 +2886,12 @@ "smithy.api#required": {} } }, - "clientRequestToken": { + "name": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The name of the Amazon EKS cluster to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -2821,17 +2910,17 @@ "com.amazonaws.eks#UpdateLabelsPayload": { "type": "structure", "members": { - "removeLabels": { - "target": "com.amazonaws.eks#labelsKeyList", - "traits": { - "smithy.api#documentation": "

Kubernetes labels to be removed.

" - } - }, "addOrUpdateLabels": { "target": "com.amazonaws.eks#labelsMap", "traits": { "smithy.api#documentation": "

Kubernetes labels to be added or updated.

" } + }, + "removeLabels": { + "target": "com.amazonaws.eks#labelsKeyList", + "traits": { + "smithy.api#documentation": "

Kubernetes labels to be removed.

" + } } }, "traits": { @@ -2878,13 +2967,6 @@ "com.amazonaws.eks#UpdateNodegroupConfigRequest": { "type": "structure", "members": { - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, "scalingConfig": { "target": "com.amazonaws.eks#NodegroupScalingConfig", "traits": { @@ -2899,12 +2981,6 @@ "smithy.api#required": {} } }, - "labels": { - "target": "com.amazonaws.eks#UpdateLabelsPayload", - "traits": { - "smithy.api#documentation": "

The Kubernetes labels to be applied to the nodes in the node group after the\n update.

" - } - }, "clusterName": { "target": "com.amazonaws.eks#String", "traits": { @@ -2912,6 +2988,19 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + }, + "labels": { + "target": "com.amazonaws.eks#UpdateLabelsPayload", + "traits": { + "smithy.api#documentation": "

The Kubernetes labels to be applied to the nodes in the node group after the\n update.

" + } } } }, @@ -2952,7 +3041,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

\n

You can update to the latest available AMI version of a node group's current\n Kubernetes version by not specifying a Kubernetes version in the request. You can update\n to the latest AMI version of your cluster's current Kubernetes version by specifying\n your cluster's Kubernetes version in the request. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

\n

You cannot roll back a node group to an earlier Kubernetes version or AMI\n version.

\n

When a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully\n and will fail if it is unable to do so. You can force the update if Amazon EKS\n is unable to drain the nodes as a result of a pod disruption budget issue.

", + "smithy.api#documentation": "

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

\n

You can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.

\n

If you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes\n version in the request. You can update to the latest AMI version of your cluster's\n current Kubernetes version by specifying your cluster's Kubernetes version in the\n request. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

\n

You cannot roll back a node group to an earlier Kubernetes version or AMI\n version.

\n

When a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully\n and will fail if it is unable to do so. You can force the update if Amazon EKS\n is unable to drain the nodes as a result of a pod disruption budget issue.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-version", @@ -2963,10 +3052,10 @@ "com.amazonaws.eks#UpdateNodegroupVersionRequest": { "type": "structure", "members": { - "releaseVersion": { + "version": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The AMI version of the Amazon EKS-optimized AMI to use for the update. By default, the\n latest available AMI version for the node group's Kubernetes version is used. For more\n information, see Amazon EKS-Optimized Linux AMI Versions in the\n Amazon EKS User Guide.

" + "smithy.api#documentation": "

The Kubernetes version to update to. If no version is specified, then the Kubernetes\n version of the node group does not change. You can specify the Kubernetes version of the\n cluster to update the node group to the latest AMI version of the cluster's Kubernetes\n version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n version, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "force": { @@ -2975,31 +3064,37 @@ "smithy.api#documentation": "

Force the update if the existing node group's pods are unable to be drained due to a\n pod disruption budget issue. If an update fails because pods could not be drained, you\n can force the update after it fails to terminate the old node whether or not any pods\n are running on the node.

" } }, - "clientRequestToken": { + "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The AMI version of the Amazon EKS-optimized AMI to use for the update. By default, the\n latest available AMI version for the node group's Kubernetes version is used. For more\n information, see Amazon EKS-Optimized Linux AMI Versions in the\n Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, - "version": { - "target": "com.amazonaws.eks#String", + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The Kubernetes version to update to. If no version is specified, then the Kubernetes\n version of the node group does not change. You can specify the Kubernetes version of the\n cluster to update the node group to the latest AMI version of the cluster's Kubernetes\n version.

" + "smithy.api#documentation": "

An object representing a node group's launch template specification. You can only\n update a node group using a launch template if the node group was originally deployed\n with a launch template.

" } }, - "clusterName": { + "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster that is associated with the managed node group to\n update.

", + "smithy.api#documentation": "

The name of the managed node group to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "nodegroupName": { + "clientRequestToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the managed node group to update.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EKS cluster that is associated with the managed node group to\n update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3017,17 +3112,17 @@ "com.amazonaws.eks#UpdateParam": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.eks#UpdateParamType", - "traits": { - "smithy.api#documentation": "

The keys associated with an update request.

" - } - }, "value": { "target": "com.amazonaws.eks#String", "traits": { "smithy.api#documentation": "

The value of the keys submitted as part of an update request.

" } + }, + "type": { + "target": "com.amazonaws.eks#UpdateParamType", + "traits": { + "smithy.api#documentation": "

The keys associated with an update request.

" + } } }, "traits": { @@ -3144,10 +3239,10 @@ "com.amazonaws.eks#VpcConfigRequest": { "type": "structure", "members": { - "publicAccessCidrs": { + "securityGroupIds": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\n you specify is denied. The default value is 0.0.0.0/0. If you've disabled\n private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then\n ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster\n Endpoint Access Control in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

Specify one or more security groups for the cross-account elastic network interfaces\n that Amazon EKS creates to use to allow communication between your worker nodes and the\n Kubernetes control plane. If you don't specify a security group, the default security\n group for your VPC is used.

" } }, "endpointPrivateAccess": { @@ -3156,22 +3251,22 @@ "smithy.api#documentation": "

Set this value to true to enable private access for your cluster's\n Kubernetes API server endpoint. If you enable private access, Kubernetes API requests\n from within your cluster's VPC use the private VPC endpoint. The default value for this\n parameter is false, which disables private access for your Kubernetes API\n server. If you disable private access and you have worker nodes or AWS Fargate pods in the\n cluster, then ensure that publicAccessCidrs includes the necessary CIDR\n blocks for communication with the worker nodes or Fargate pods. For more information, see\n Amazon EKS\n Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .

" } }, - "securityGroupIds": { - "target": "com.amazonaws.eks#StringList", + "endpointPublicAccess": { + "target": "com.amazonaws.eks#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Specify one or more security groups for the cross-account elastic network interfaces\n that Amazon EKS creates to use to allow communication between your worker nodes and the\n Kubernetes control plane. If you don't specify a security group, the default security\n group for your VPC is used.

" + "smithy.api#documentation": "

Set this value to false to disable public access to your cluster's\n Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes\n API server can only receive requests from within the cluster VPC. The default value for\n this parameter is true, which enables public access for your Kubernetes API\n server. For more information, see Amazon EKS Cluster\n Endpoint Access Control in the \n Amazon EKS User Guide\n .

" } }, - "subnetIds": { + "publicAccessCidrs": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic\n network interfaces in these subnets to allow communication between your worker nodes and\n the Kubernetes control plane.

" + "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\n you specify is denied. The default value is 0.0.0.0/0. If you've disabled\n private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then\n ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster\n Endpoint Access Control in the \n Amazon EKS User Guide\n .

" } }, - "endpointPublicAccess": { - "target": "com.amazonaws.eks#BoxedBoolean", + "subnetIds": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

Set this value to false to disable public access to your cluster's\n Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes\n API server can only receive requests from within the cluster VPC. The default value for\n this parameter is true, which enables public access for your Kubernetes API\n server. For more information, see Amazon EKS Cluster\n Endpoint Access Control in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic\n network interfaces in these subnets to allow communication between your worker nodes and\n the Kubernetes control plane.

" } } }, @@ -3182,22 +3277,16 @@ "com.amazonaws.eks#VpcConfigResponse": { "type": "structure", "members": { - "endpointPrivateAccess": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If\n the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate\n from within your cluster's VPC use the private VPC endpoint instead of traversing the\n internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the\n cluster, then ensure that publicAccessCidrs includes the necessary CIDR\n blocks for communication with the worker nodes or Fargate pods. For more information, see\n Amazon EKS\n Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .

" - } - }, - "securityGroupIds": { - "target": "com.amazonaws.eks#StringList", + "vpcId": { + "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The security groups associated with the cross-account elastic network interfaces that\n are used to allow communication between your worker nodes and the Kubernetes control\n plane.

" + "smithy.api#documentation": "

The VPC associated with your cluster.

" } }, - "vpcId": { + "clusterSecurityGroupId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The VPC associated with your cluster.

" + "smithy.api#documentation": "

The cluster security group that was created by Amazon EKS for the cluster. Managed node\n groups use this security group for control-plane-to-data-plane communication.

" } }, "publicAccessCidrs": { @@ -3212,16 +3301,22 @@ "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If\n the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server\n can only receive requests that originate from within the cluster VPC.

" } }, - "clusterSecurityGroupId": { - "target": "com.amazonaws.eks#String", + "subnetIds": { + "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The cluster security group that was created by Amazon EKS for the cluster. Managed node\n groups use this security group for control-plane-to-data-plane communication.

" + "smithy.api#documentation": "

The subnets associated with your cluster.

" } }, - "subnetIds": { + "securityGroupIds": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The subnets associated with your cluster.

" + "smithy.api#documentation": "

The security groups associated with the cross-account elastic network interfaces that\n are used to allow communication between your worker nodes and the Kubernetes control\n plane.

" + } + }, + "endpointPrivateAccess": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If\n the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate\n from within your cluster's VPC use the private VPC endpoint instead of traversing the\n internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the\n cluster, then ensure that publicAccessCidrs includes the necessary CIDR\n blocks for communication with the worker nodes or Fargate pods. For more information, see\n Amazon EKS\n Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .

" } } }, diff --git a/codegen/sdk-codegen/aws-models/elastic-beanstalk.2010-12-01.json b/codegen/sdk-codegen/aws-models/elastic-beanstalk.2010-12-01.json index 104559c82193..00e959e846b7 100644 --- a/codegen/sdk-codegen/aws-models/elastic-beanstalk.2010-12-01.json +++ b/codegen/sdk-codegen/aws-models/elastic-beanstalk.2010-12-01.json @@ -213,17 +213,17 @@ "com.amazonaws.elasticbeanstalk#AbortEnvironmentUpdateMessage": { "type": "structure", "members": { - "EnvironmentId": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", - "traits": { - "smithy.api#documentation": "

This specifies the ID of the environment with the in-progress update that you want to\n cancel.

" - } - }, "EnvironmentName": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", "traits": { "smithy.api#documentation": "

This specifies the name of the environment with the in-progress update that you want to\n cancel.

" } + }, + "EnvironmentId": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", + "traits": { + "smithy.api#documentation": "

This specifies the ID of the environment with the in-progress update that you want to\n cancel.

" + } } }, "traits": { @@ -293,28 +293,22 @@ "com.amazonaws.elasticbeanstalk#ApplicationDescription": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "ResourceLifecycleConfig": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationResourceLifecycleConfig", - "traits": { - "smithy.api#documentation": "

The lifecycle settings for the application.

" - } - }, "Versions": { "target": "com.amazonaws.elasticbeanstalk#VersionLabelsList", "traits": { "smithy.api#documentation": "

The names of the versions for this application.

" } }, - "DateCreated": { - "target": "com.amazonaws.elasticbeanstalk#CreationDate", + "DateUpdated": { + "target": "com.amazonaws.elasticbeanstalk#UpdateDate", "traits": { - "smithy.api#documentation": "

The date when the application was created.

" + "smithy.api#documentation": "

The date when the application was last modified.

" + } + }, + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

" } }, "ApplicationArn": { @@ -323,10 +317,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" } }, - "DateUpdated": { - "target": "com.amazonaws.elasticbeanstalk#UpdateDate", + "ResourceLifecycleConfig": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationResourceLifecycleConfig", "traits": { - "smithy.api#documentation": "

The date when the application was last modified.

" + "smithy.api#documentation": "

The lifecycle settings for the application.

" } }, "Description": { @@ -335,6 +329,12 @@ "smithy.api#documentation": "

User-defined description of the application.

" } }, + "DateCreated": { + "target": "com.amazonaws.elasticbeanstalk#CreationDate", + "traits": { + "smithy.api#documentation": "

The date when the application was created.

" + } + }, "ConfigurationTemplates": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateNamesList", "traits": { @@ -383,6 +383,12 @@ "com.amazonaws.elasticbeanstalk#ApplicationMetrics": { "type": "structure", "members": { + "Duration": { + "target": "com.amazonaws.elasticbeanstalk#NullableInteger", + "traits": { + "smithy.api#documentation": "

The amount of time that the metrics cover (usually 10 seconds). For example, you might\n have 5 requests (request_count) within the most recent time slice of 10 seconds\n (duration).

" + } + }, "Latency": { "target": "com.amazonaws.elasticbeanstalk#Latency", "traits": { @@ -395,12 +401,6 @@ "smithy.api#documentation": "

Represents the percentage of requests over the last 10 seconds that resulted in each\n type of status code response.

" } }, - "Duration": { - "target": "com.amazonaws.elasticbeanstalk#NullableInteger", - "traits": { - "smithy.api#documentation": "

The amount of time that the metrics cover (usually 10 seconds). For example, you might\n have 5 requests (request_count) within the most recent time slice of 10 seconds\n (duration).

" - } - }, "RequestCount": { "target": "com.amazonaws.elasticbeanstalk#RequestCount", "traits": { @@ -470,16 +470,10 @@ "com.amazonaws.elasticbeanstalk#ApplicationVersionDescription": { "type": "structure", "members": { - "SourceBundle": { - "target": "com.amazonaws.elasticbeanstalk#S3Location", - "traits": { - "smithy.api#documentation": "

The storage location of the application version's source bundle in Amazon S3.

" - } - }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "DateUpdated": { + "target": "com.amazonaws.elasticbeanstalk#UpdateDate", "traits": { - "smithy.api#documentation": "

The name of the application to which the application version belongs.

" + "smithy.api#documentation": "

The last modified date of the application version.

" } }, "VersionLabel": { @@ -488,22 +482,28 @@ "smithy.api#documentation": "

A unique identifier for the application version.

" } }, - "DateCreated": { - "target": "com.amazonaws.elasticbeanstalk#CreationDate", - "traits": { - "smithy.api#documentation": "

The creation date of the application version.

" - } - }, "ApplicationVersionArn": { "target": "com.amazonaws.elasticbeanstalk#ApplicationVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application version.

" } }, - "DateUpdated": { - "target": "com.amazonaws.elasticbeanstalk#UpdateDate", + "SourceBuildInformation": { + "target": "com.amazonaws.elasticbeanstalk#SourceBuildInformation", "traits": { - "smithy.api#documentation": "

The last modified date of the application version.

" + "smithy.api#documentation": "

If the version's source code was retrieved from AWS CodeCommit, the location of the\n source code for the application version.

" + } + }, + "Status": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationVersionStatus", + "traits": { + "smithy.api#documentation": "

The processing status of the application version. Reflects the state of the application\n version during its creation. Many of the values are only applicable if you specified\n True for the Process parameter of the\n CreateApplicationVersion action. The following list describes the possible\n values.

\n " + } + }, + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application to which the application version belongs.

" } }, "Description": { @@ -512,22 +512,22 @@ "smithy.api#documentation": "

The description of the application version.

" } }, - "BuildArn": { - "target": "com.amazonaws.elasticbeanstalk#String", + "SourceBundle": { + "target": "com.amazonaws.elasticbeanstalk#S3Location", "traits": { - "smithy.api#documentation": "

Reference to the artifact from the AWS CodeBuild build.

" + "smithy.api#documentation": "

The storage location of the application version's source bundle in Amazon S3.

" } }, - "SourceBuildInformation": { - "target": "com.amazonaws.elasticbeanstalk#SourceBuildInformation", + "BuildArn": { + "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

If the version's source code was retrieved from AWS CodeCommit, the location of the\n source code for the application version.

" + "smithy.api#documentation": "

Reference to the artifact from the AWS CodeBuild build.

" } }, - "Status": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationVersionStatus", + "DateCreated": { + "target": "com.amazonaws.elasticbeanstalk#CreationDate", "traits": { - "smithy.api#documentation": "

The processing status of the application version. Reflects the state of the application\n version during its creation. Many of the values are only applicable if you specified\n True for the Process parameter of the\n CreateApplicationVersion action. The following list describes the possible\n values.

\n " + "smithy.api#documentation": "

The creation date of the application version.

" } } }, @@ -646,16 +646,16 @@ "com.amazonaws.elasticbeanstalk#ApplyEnvironmentManagedActionRequest": { "type": "structure", "members": { - "EnvironmentId": { + "EnvironmentName": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The environment ID of the target environment.

" + "smithy.api#documentation": "

The name of the target environment.

" } }, - "EnvironmentName": { + "EnvironmentId": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The name of the target environment.

" + "smithy.api#documentation": "

The environment ID of the target environment.

" } }, "ActionId": { @@ -679,12 +679,6 @@ "smithy.api#documentation": "

The status of the managed action.

" } }, - "ActionDescription": { - "target": "com.amazonaws.elasticbeanstalk#String", - "traits": { - "smithy.api#documentation": "

A description of the managed action.

" - } - }, "ActionType": { "target": "com.amazonaws.elasticbeanstalk#ActionType", "traits": { @@ -696,6 +690,12 @@ "traits": { "smithy.api#documentation": "

The action ID of the managed action.

" } + }, + "ActionDescription": { + "target": "com.amazonaws.elasticbeanstalk#String", + "traits": { + "smithy.api#documentation": "

A description of the managed action.

" + } } }, "traits": { @@ -797,10 +797,10 @@ "com.amazonaws.elasticbeanstalk#BuildConfiguration": { "type": "structure", "members": { - "TimeoutInMinutes": { - "target": "com.amazonaws.elasticbeanstalk#BoxedInt", + "ArtifactName": { + "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

" + "smithy.api#documentation": "

The name of the artifact of the CodeBuild build.\n If provided, Elastic Beanstalk stores the build artifact in the S3 location \n S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip.\n If not provided, Elastic Beanstalk stores the build artifact in the S3 location \n S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.\n

" } }, "ComputeType": { @@ -809,6 +809,12 @@ "smithy.api#documentation": "

Information about the compute resources the build project will use.

\n " } }, + "TimeoutInMinutes": { + "target": "com.amazonaws.elasticbeanstalk#BoxedInt", + "traits": { + "smithy.api#documentation": "

How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

" + } + }, "CodeBuildServiceRole": { "target": "com.amazonaws.elasticbeanstalk#NonEmptyString", "traits": { @@ -822,12 +828,6 @@ "smithy.api#documentation": "

The ID of the Docker image to use for this build project.

", "smithy.api#required": {} } - }, - "ArtifactName": { - "target": "com.amazonaws.elasticbeanstalk#String", - "traits": { - "smithy.api#documentation": "

The name of the artifact of the CodeBuild build.\n If provided, Elastic Beanstalk stores the build artifact in the S3 location \n S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip.\n If not provided, Elastic Beanstalk stores the build artifact in the S3 location \n S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.\n

" - } } }, "traits": { @@ -851,28 +851,28 @@ "com.amazonaws.elasticbeanstalk#CPUUtilization": { "type": "structure", "members": { - "Idle": { + "System": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

Percentage of time that the CPU has spent in the Idle state over the last\n 10 seconds.

" + "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the System state over the\n last 10 seconds.

" } }, - "User": { + "Privileged": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

Percentage of time that the CPU has spent in the User state over the last\n 10 seconds.

" + "smithy.api#documentation": "

Available on Windows environments only.

\n

Percentage of time that the CPU has spent in the Privileged state over the\n last 10 seconds.

" } }, - "System": { + "SoftIRQ": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the System state over the\n last 10 seconds.

" + "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the SoftIRQ state over the\n last 10 seconds.

" } }, - "SoftIRQ": { + "Nice": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the SoftIRQ state over the\n last 10 seconds.

" + "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the Nice state over the last\n 10 seconds.

" } }, "IOWait": { @@ -881,22 +881,22 @@ "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the I/O Wait state over the\n last 10 seconds.

" } }, - "Nice": { + "IRQ": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the Nice state over the last\n 10 seconds.

" + "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the IRQ state over the last\n 10 seconds.

" } }, - "Privileged": { + "User": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

Available on Windows environments only.

\n

Percentage of time that the CPU has spent in the Privileged state over the\n last 10 seconds.

" + "smithy.api#documentation": "

Percentage of time that the CPU has spent in the User state over the last\n 10 seconds.

" } }, - "IRQ": { + "Idle": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

Available on Linux environments only.

\n

Percentage of time that the CPU has spent in the IRQ state over the last\n 10 seconds.

" + "smithy.api#documentation": "

Percentage of time that the CPU has spent in the Idle state over the last\n 10 seconds.

" } } }, @@ -949,17 +949,17 @@ "com.amazonaws.elasticbeanstalk#CheckDNSAvailabilityResultMessage": { "type": "structure", "members": { - "Available": { - "target": "com.amazonaws.elasticbeanstalk#CnameAvailability", - "traits": { - "smithy.api#documentation": "

Indicates if the specified CNAME is available:

\n " - } - }, "FullyQualifiedCNAME": { "target": "com.amazonaws.elasticbeanstalk#DNSCname", "traits": { "smithy.api#documentation": "

The fully qualified CNAME to reserve when CreateEnvironment is called\n with the provided prefix.

" } + }, + "Available": { + "target": "com.amazonaws.elasticbeanstalk#CnameAvailability", + "traits": { + "smithy.api#documentation": "

Indicates if the specified CNAME is available:

\n " + } } }, "traits": { @@ -1075,18 +1075,6 @@ "com.amazonaws.elasticbeanstalk#ConfigurationOptionDescription": { "type": "structure", "members": { - "ChangeSeverity": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSeverity", - "traits": { - "smithy.api#documentation": "

An indication of which action is required if the value for this configuration option\n changes:

\n " - } - }, - "ValueOptions": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionPossibleValues", - "traits": { - "smithy.api#documentation": "

If specified, values for the configuration option are selected from this\n list.

" - } - }, "UserDefined": { "target": "com.amazonaws.elasticbeanstalk#UserDefinedOption", "traits": { @@ -1099,16 +1087,34 @@ "smithy.api#documentation": "

An indication of which type of values this option has and whether it is allowable to\n select one or more than one of the possible values:

\n " } }, + "MinValue": { + "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionMinValue", + "traits": { + "smithy.api#documentation": "

If specified, the configuration option must be a numeric value greater than this\n value.

" + } + }, + "MaxValue": { + "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionMaxValue", + "traits": { + "smithy.api#documentation": "

If specified, the configuration option must be a numeric value less than this\n value.

" + } + }, "DefaultValue": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionDefaultValue", "traits": { "smithy.api#documentation": "

The default value for this configuration option.

" } }, - "MinValue": { - "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionMinValue", + "MaxLength": { + "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionMaxLength", "traits": { - "smithy.api#documentation": "

If specified, the configuration option must be a numeric value greater than this\n value.

" + "smithy.api#documentation": "

If specified, the configuration option must be a string value no longer than this\n value.

" + } + }, + "Regex": { + "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionRegex", + "traits": { + "smithy.api#documentation": "

If specified, the configuration option must be a string value that satisfies this\n regular expression.

" } }, "Namespace": { @@ -1123,22 +1129,16 @@ "smithy.api#documentation": "

The name of the configuration option.

" } }, - "MaxLength": { - "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionMaxLength", - "traits": { - "smithy.api#documentation": "

If specified, the configuration option must be a string value no longer than this\n value.

" - } - }, - "MaxValue": { - "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionMaxValue", + "ValueOptions": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionPossibleValues", "traits": { - "smithy.api#documentation": "

If specified, the configuration option must be a numeric value less than this\n value.

" + "smithy.api#documentation": "

If specified, values for the configuration option are selected from this\n list.

" } }, - "Regex": { - "target": "com.amazonaws.elasticbeanstalk#OptionRestrictionRegex", + "ChangeSeverity": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSeverity", "traits": { - "smithy.api#documentation": "

If specified, the configuration option must be a string value that satisfies this\n regular expression.

" + "smithy.api#documentation": "

An indication of which action is required if the value for this configuration option\n changes:

\n " } } }, @@ -1167,10 +1167,10 @@ "com.amazonaws.elasticbeanstalk#ConfigurationOptionSetting": { "type": "structure", "members": { - "OptionName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionName", + "ResourceName": { + "target": "com.amazonaws.elasticbeanstalk#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the configuration option.

" + "smithy.api#documentation": "

A unique resource name for the option setting. Use it for a time–based scaling configuration option.

" } }, "Value": { @@ -1179,10 +1179,10 @@ "smithy.api#documentation": "

The current value for the configuration option.

" } }, - "ResourceName": { - "target": "com.amazonaws.elasticbeanstalk#ResourceName", + "OptionName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionName", "traits": { - "smithy.api#documentation": "

A unique resource name for the option setting. Use it for a time–based scaling configuration option.

" + "smithy.api#documentation": "

The name of the configuration option.

" } }, "Namespace": { @@ -1224,6 +1224,12 @@ "com.amazonaws.elasticbeanstalk#ConfigurationOptionsDescription": { "type": "structure", "members": { + "PlatformArn": { + "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "traits": { + "smithy.api#documentation": "

The ARN of the platform version.

" + } + }, "SolutionStackName": { "target": "com.amazonaws.elasticbeanstalk#SolutionStackName", "traits": { @@ -1235,12 +1241,6 @@ "traits": { "smithy.api#documentation": "

A list of ConfigurationOptionDescription.

" } - }, - "PlatformArn": { - "target": "com.amazonaws.elasticbeanstalk#PlatformArn", - "traits": { - "smithy.api#documentation": "

The ARN of the platform version.

" - } } }, "traits": { @@ -1250,34 +1250,28 @@ "com.amazonaws.elasticbeanstalk#ConfigurationSettingsDescription": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application associated with this configuration set.

" - } - }, - "EnvironmentName": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "DateUpdated": { + "target": "com.amazonaws.elasticbeanstalk#UpdateDate", "traits": { - "smithy.api#documentation": "

If not null, the name of the environment for this configuration set.\n

" + "smithy.api#documentation": "

The date (in UTC time) when this configuration set was last modified.

" } }, - "PlatformArn": { - "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "Description": { + "target": "com.amazonaws.elasticbeanstalk#Description", "traits": { - "smithy.api#documentation": "

The ARN of the platform version.

" + "smithy.api#documentation": "

Describes this configuration set.

" } }, - "DateUpdated": { - "target": "com.amazonaws.elasticbeanstalk#UpdateDate", + "EnvironmentName": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", "traits": { - "smithy.api#documentation": "

The date (in UTC time) when this configuration set was last modified.

" + "smithy.api#documentation": "

If not null, the name of the environment for this configuration set.\n

" } }, - "DateCreated": { - "target": "com.amazonaws.elasticbeanstalk#CreationDate", + "TemplateName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { - "smithy.api#documentation": "

The date (in UTC time) when this configuration set was created.

" + "smithy.api#documentation": "

If not null, the name of the configuration template for this\n configuration set.

" } }, "SolutionStackName": { @@ -1286,10 +1280,10 @@ "smithy.api#documentation": "

The name of the solution stack this configuration set uses.

" } }, - "Description": { - "target": "com.amazonaws.elasticbeanstalk#Description", + "DateCreated": { + "target": "com.amazonaws.elasticbeanstalk#CreationDate", "traits": { - "smithy.api#documentation": "

Describes this configuration set.

" + "smithy.api#documentation": "

The date (in UTC time) when this configuration set was created.

" } }, "OptionSettings": { @@ -1304,10 +1298,16 @@ "smithy.api#documentation": "

If this configuration set is associated with an environment, the\n DeploymentStatus parameter indicates the deployment status of this\n configuration set:

\n " } }, - "TemplateName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { - "smithy.api#documentation": "

If not null, the name of the configuration template for this\n configuration set.

" + "smithy.api#documentation": "

The name of the application associated with this configuration set.

" + } + }, + "PlatformArn": { + "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "traits": { + "smithy.api#documentation": "

The ARN of the platform version.

" } } }, @@ -1384,6 +1384,13 @@ "com.amazonaws.elasticbeanstalk#CreateApplicationMessage": { "type": "structure", "members": { + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application. Must be unique within your account.

", + "smithy.api#required": {} + } + }, "ResourceLifecycleConfig": { "target": "com.amazonaws.elasticbeanstalk#ApplicationResourceLifecycleConfig", "traits": { @@ -1401,13 +1408,6 @@ "traits": { "smithy.api#documentation": "

Specifies the tags applied to the application.

\n

Elastic Beanstalk applies these tags only to the application. Environments that you create in the\n application don't inherit the tags.

" } - }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application. Must be unique within your account.

", - "smithy.api#required": {} - } } }, "traits": { @@ -1446,22 +1446,16 @@ "com.amazonaws.elasticbeanstalk#CreateApplicationVersionMessage": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.elasticbeanstalk#Description", - "traits": { - "smithy.api#documentation": "

A description of this application version.

" - } - }, "AutoCreateApplication": { "target": "com.amazonaws.elasticbeanstalk#AutoCreateApplication", "traits": { "smithy.api#documentation": "

Set to true to create an application with the specified name if it doesn't\n already exist.

" } }, - "BuildConfiguration": { - "target": "com.amazonaws.elasticbeanstalk#BuildConfiguration", + "Description": { + "target": "com.amazonaws.elasticbeanstalk#Description", "traits": { - "smithy.api#documentation": "

Settings for an AWS CodeBuild build.

" + "smithy.api#documentation": "

A description of this application version.

" } }, "Process": { @@ -1470,6 +1464,18 @@ "smithy.api#documentation": "

Pre-processes and validates the environment manifest (env.yaml) and\n configuration files (*.config files in the .ebextensions folder) in\n the source bundle. Validating configuration files can identify issues prior to deploying the\n application version to an environment.

\n

You must turn processing on for application versions that you create using AWS\n CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3,\n processing is optional.

\n \n

The Process option validates Elastic Beanstalk configuration files. It\n doesn't validate your application's configuration files, like proxy server or Docker\n configuration.

\n " } }, + "SourceBuildInformation": { + "target": "com.amazonaws.elasticbeanstalk#SourceBuildInformation", + "traits": { + "smithy.api#documentation": "

Specify a commit in an AWS CodeCommit Git repository to use as the source code for the\n application version.

" + } + }, + "BuildConfiguration": { + "target": "com.amazonaws.elasticbeanstalk#BuildConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for an AWS CodeBuild build.

" + } + }, "Tags": { "target": "com.amazonaws.elasticbeanstalk#Tags", "traits": { @@ -1483,12 +1489,6 @@ "smithy.api#required": {} } }, - "SourceBuildInformation": { - "target": "com.amazonaws.elasticbeanstalk#SourceBuildInformation", - "traits": { - "smithy.api#documentation": "

Specify a commit in an AWS CodeCommit Git repository to use as the source code for the\n application version.

" - } - }, "SourceBundle": { "target": "com.amazonaws.elasticbeanstalk#S3Location", "traits": { @@ -1539,25 +1539,18 @@ "smithy.api#documentation": "

Specifies the tags applied to the configuration template.

" } }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the Elastic Beanstalk application to associate with this configuration\n template.

", - "smithy.api#required": {} - } - }, - "PlatformArn": { - "target": "com.amazonaws.elasticbeanstalk#PlatformArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom\n Platforms in the AWS Elastic Beanstalk Developer Guide.

\n \n \n

If you specify PlatformArn, then don't specify\n SolutionStackName.

\n " - } - }, "EnvironmentId": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", "traits": { "smithy.api#documentation": "

The ID of an environment whose settings you want to use to create the configuration\n template. You must specify EnvironmentId if you don't specify\n PlatformArn, SolutionStackName, or\n SourceConfiguration.

" } }, + "SolutionStackName": { + "target": "com.amazonaws.elasticbeanstalk#SolutionStackName", + "traits": { + "smithy.api#documentation": "

The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For\n example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack\n specifies the operating system, runtime, and application server for a configuration template.\n It also determines the set of configuration options as well as the possible and default\n values. For more information, see Supported Platforms in the\n AWS Elastic Beanstalk Developer Guide.

\n

You must specify SolutionStackName if you don't specify\n PlatformArn, EnvironmentId, or\n SourceConfiguration.

\n

Use the \n ListAvailableSolutionStacks\n API to obtain a list of available\n solution stacks.

" + } + }, "Description": { "target": "com.amazonaws.elasticbeanstalk#Description", "traits": { @@ -1570,12 +1563,6 @@ "smithy.api#documentation": "

An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified\n configuration template to create a new configuration.

\n

Values specified in OptionSettings override any values obtained from the\n SourceConfiguration.

\n

You must specify SourceConfiguration if you don't specify\n PlatformArn, EnvironmentId, or\n SolutionStackName.

\n

Constraint: If both solution stack name and source configuration are specified, the\n solution stack of the source configuration template must match the specified solution stack\n name.

" } }, - "SolutionStackName": { - "target": "com.amazonaws.elasticbeanstalk#SolutionStackName", - "traits": { - "smithy.api#documentation": "

The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For\n example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack\n specifies the operating system, runtime, and application server for a configuration template.\n It also determines the set of configuration options as well as the possible and default\n values. For more information, see Supported Platforms in the\n AWS Elastic Beanstalk Developer Guide.

\n

You must specify SolutionStackName if you don't specify\n PlatformArn, EnvironmentId, or\n SourceConfiguration.

\n

Use the \n ListAvailableSolutionStacks\n API to obtain a list of available\n solution stacks.

" - } - }, "TemplateName": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { @@ -1583,11 +1570,24 @@ "smithy.api#required": {} } }, + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the Elastic Beanstalk application to associate with this configuration\n template.

", + "smithy.api#required": {} + } + }, "OptionSettings": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSettingsList", "traits": { "smithy.api#documentation": "

Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these\n values override the values obtained from the solution stack or the source configuration\n template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the\n AWS Elastic Beanstalk Developer Guide.

" } + }, + "PlatformArn": { + "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom\n Platforms in the AWS Elastic Beanstalk Developer Guide.

\n \n \n

If you specify PlatformArn, then don't specify\n SolutionStackName.

\n " + } } }, "traits": { @@ -1617,16 +1617,34 @@ "com.amazonaws.elasticbeanstalk#CreateEnvironmentMessage": { "type": "structure", "members": { + "TemplateName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the Elastic Beanstalk configuration template to use with the environment.

\n \n

If you specify TemplateName, then don't specify \n SolutionStackName.

\n " + } + }, + "Tags": { + "target": "com.amazonaws.elasticbeanstalk#Tags", + "traits": { + "smithy.api#documentation": "

Specifies the tags applied to resources in the environment.

" + } + }, "OptionSettings": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSettingsList", "traits": { "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk sets the specified configuration options to the\n requested value in the configuration set for the new environment. These override the values\n obtained from the solution stack or the configuration template.

" } }, - "TemplateName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "OptionsToRemove": { + "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", "traits": { - "smithy.api#documentation": "

The name of the Elastic Beanstalk configuration template to use with the environment.

\n \n

If you specify TemplateName, then don't specify \n SolutionStackName.

\n " + "smithy.api#documentation": "

A list of custom user-defined configuration options to remove from the configuration\n set for this new environment.

" + } + }, + "EnvironmentName": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "traits": { + "smithy.api#documentation": "

A unique name for the environment.

\n

Constraint: Must be from 4 to 40 characters in length. The name can contain only\n letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique\n within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an\n InvalidParameterValue error.

\n

If you don't specify the CNAMEPrefix parameter, the environment name becomes part of\n the CNAME, and therefore part of the visible URL for your application.

" } }, "SolutionStackName": { @@ -1641,34 +1659,28 @@ "smithy.api#documentation": "

If specified, the environment attempts to use this value as the prefix for the CNAME in\n your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by\n appending a random alphanumeric string to the environment name.

" } }, - "Tags": { - "target": "com.amazonaws.elasticbeanstalk#Tags", - "traits": { - "smithy.api#documentation": "

Specifies the tags applied to resources in the environment.

" - } - }, - "GroupName": { - "target": "com.amazonaws.elasticbeanstalk#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group to which the target environment belongs. Specify a group name\n only if the environment's name is specified in an environment manifest and not with the\n environment name parameter. See Environment Manifest\n (env.yaml) for details.

" - } - }, "Description": { "target": "com.amazonaws.elasticbeanstalk#Description", "traits": { "smithy.api#documentation": "

Your description for this environment.

" } }, + "VersionLabel": { + "target": "com.amazonaws.elasticbeanstalk#VersionLabel", + "traits": { + "smithy.api#documentation": "

The name of the application version to deploy.

\n

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

" + } + }, "PlatformArn": { "target": "com.amazonaws.elasticbeanstalk#PlatformArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom platform to use with the environment. For\n more information, see Custom Platforms in the\n AWS Elastic Beanstalk Developer Guide.

\n \n \n

If you specify PlatformArn, don't specify\n SolutionStackName.

\n " } }, - "EnvironmentName": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "GroupName": { + "target": "com.amazonaws.elasticbeanstalk#GroupName", "traits": { - "smithy.api#documentation": "

A unique name for the environment.

\n

Constraint: Must be from 4 to 40 characters in length. The name can contain only\n letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique\n within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an\n InvalidParameterValue error.

\n

If you don't specify the CNAMEPrefix parameter, the environment name becomes part of\n the CNAME, and therefore part of the visible URL for your application.

" + "smithy.api#documentation": "

The name of the group to which the target environment belongs. Specify a group name\n only if the environment's name is specified in an environment manifest and not with the\n environment name parameter. See Environment Manifest\n (env.yaml) for details.

" } }, "ApplicationName": { @@ -1678,16 +1690,10 @@ "smithy.api#required": {} } }, - "VersionLabel": { - "target": "com.amazonaws.elasticbeanstalk#VersionLabel", - "traits": { - "smithy.api#documentation": "

The name of the application version to deploy.

\n

Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

" - } - }, - "OptionsToRemove": { - "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", + "Tier": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentTier", "traits": { - "smithy.api#documentation": "

A list of custom user-defined configuration options to remove from the configuration\n set for this new environment.

" + "smithy.api#documentation": "

Specifies the tier to use in creating this environment. The environment tier that you\n choose determines whether Elastic Beanstalk provisions resources to support a web application that handles\n HTTP(S) requests or a web application that handles background-processing tasks.

" } }, "OperationsRole": { @@ -1695,12 +1701,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's\n operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream\n services during this call and during subsequent calls acting on this environment. To specify\n an operations role, you must have the iam:PassRole permission for the role. For\n more information, see Operations roles in the\n AWS Elastic Beanstalk Developer Guide.

" } - }, - "Tier": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentTier", - "traits": { - "smithy.api#documentation": "

Specifies the tier to use in creating this environment. The environment tier that you\n choose determines whether Elastic Beanstalk provisions resources to support a web application that handles\n HTTP(S) requests or a web application that handles background-processing tasks.

" - } } }, "traits": { @@ -1733,25 +1733,24 @@ "com.amazonaws.elasticbeanstalk#CreatePlatformVersionRequest": { "type": "structure", "members": { - "PlatformVersion": { - "target": "com.amazonaws.elasticbeanstalk#PlatformVersion", + "PlatformName": { + "target": "com.amazonaws.elasticbeanstalk#PlatformName", "traits": { - "smithy.api#documentation": "

The number, such as 1.0.2, for the new platform version.

", + "smithy.api#documentation": "

The name of your custom platform.

", "smithy.api#required": {} } }, - "PlatformDefinitionBundle": { - "target": "com.amazonaws.elasticbeanstalk#S3Location", + "PlatformVersion": { + "target": "com.amazonaws.elasticbeanstalk#PlatformVersion", "traits": { - "smithy.api#documentation": "

The location of the platform definition archive in Amazon S3.

", + "smithy.api#documentation": "

The number, such as 1.0.2, for the new platform version.

", "smithy.api#required": {} } }, - "PlatformName": { - "target": "com.amazonaws.elasticbeanstalk#PlatformName", + "OptionSettings": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSettingsList", "traits": { - "smithy.api#documentation": "

The name of your custom platform.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The configuration option settings to apply to the builder environment.

" } }, "EnvironmentName": { @@ -1760,10 +1759,11 @@ "smithy.api#documentation": "

The name of the builder environment.

" } }, - "OptionSettings": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSettingsList", + "PlatformDefinitionBundle": { + "target": "com.amazonaws.elasticbeanstalk#S3Location", "traits": { - "smithy.api#documentation": "

The configuration option settings to apply to the builder environment.

" + "smithy.api#documentation": "

The location of the platform definition archive in Amazon S3.

", + "smithy.api#required": {} } }, "Tags": { @@ -1834,17 +1834,17 @@ "com.amazonaws.elasticbeanstalk#CustomAmi": { "type": "structure", "members": { - "ImageId": { - "target": "com.amazonaws.elasticbeanstalk#ImageId", - "traits": { - "smithy.api#documentation": "

THe ID of the image used to create the custom AMI.

" - } - }, "VirtualizationType": { "target": "com.amazonaws.elasticbeanstalk#VirtualizationType", "traits": { "smithy.api#documentation": "

The type of virtualization used to create the custom AMI.

" } + }, + "ImageId": { + "target": "com.amazonaws.elasticbeanstalk#ImageId", + "traits": { + "smithy.api#documentation": "

THe ID of the image used to create the custom AMI.

" + } } }, "traits": { @@ -1936,12 +1936,6 @@ "com.amazonaws.elasticbeanstalk#DeleteApplicationVersionMessage": { "type": "structure", "members": { - "DeleteSourceBundle": { - "target": "com.amazonaws.elasticbeanstalk#DeleteSourceBundle", - "traits": { - "smithy.api#documentation": "

Set to true to delete the source bundle from your storage bucket.\n Otherwise, the application version is deleted only from Elastic Beanstalk and the source\n bundle remains in Amazon S3.

" - } - }, "ApplicationName": { "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { @@ -1949,6 +1943,12 @@ "smithy.api#required": {} } }, + "DeleteSourceBundle": { + "target": "com.amazonaws.elasticbeanstalk#DeleteSourceBundle", + "traits": { + "smithy.api#documentation": "

Set to true to delete the source bundle from your storage bucket.\n Otherwise, the application version is deleted only from Elastic Beanstalk and the source\n bundle remains in Amazon S3.

" + } + }, "VersionLabel": { "target": "com.amazonaws.elasticbeanstalk#VersionLabel", "traits": { @@ -1978,17 +1978,17 @@ "com.amazonaws.elasticbeanstalk#DeleteConfigurationTemplateMessage": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "TemplateName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { - "smithy.api#documentation": "

The name of the application to delete the configuration template from.

", + "smithy.api#documentation": "

The name of the configuration template to delete.

", "smithy.api#required": {} } }, - "TemplateName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { - "smithy.api#documentation": "

The name of the configuration template to delete.

", + "smithy.api#documentation": "

The name of the application to delete the configuration template from.

", "smithy.api#required": {} } } @@ -2091,6 +2091,12 @@ "smithy.api#documentation": "

The ID of the deployment. This number increases by one each time that you deploy source\n code or change instance configuration settings.

" } }, + "DeploymentTime": { + "target": "com.amazonaws.elasticbeanstalk#DeploymentTimestamp", + "traits": { + "smithy.api#documentation": "

For in-progress deployments, the time that the deployment started.

\n

For completed deployments, the time that the deployment ended.

" + } + }, "Status": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { @@ -2102,12 +2108,6 @@ "traits": { "smithy.api#documentation": "

The version label of the application version in the deployment.

" } - }, - "DeploymentTime": { - "target": "com.amazonaws.elasticbeanstalk#DeploymentTimestamp", - "traits": { - "smithy.api#documentation": "

For in-progress deployments, the time that the deployment started.

\n

For completed deployments, the time that the deployment ended.

" - } } }, "traits": { @@ -2157,16 +2157,10 @@ "com.amazonaws.elasticbeanstalk#DescribeApplicationVersionsMessage": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", - "traits": { - "smithy.api#documentation": "

Specify an application name to show only application versions for that\n application.

" - } - }, - "NextToken": { - "target": "com.amazonaws.elasticbeanstalk#Token", + "VersionLabels": { + "target": "com.amazonaws.elasticbeanstalk#VersionLabelsList", "traits": { - "smithy.api#documentation": "

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other\n parameter values must be identical to the ones specified in the initial request.

\n

If no NextToken is specified, the first page is retrieved.

" + "smithy.api#documentation": "

Specify a version label to show a specific application version.

" } }, "MaxRecords": { @@ -2175,10 +2169,16 @@ "smithy.api#documentation": "

For a paginated request. Specify a maximum number of application versions to include in\n each response.

\n

If no MaxRecords is specified, all available application versions are\n retrieved in a single response.

" } }, - "VersionLabels": { - "target": "com.amazonaws.elasticbeanstalk#VersionLabelsList", + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { - "smithy.api#documentation": "

Specify a version label to show a specific application version.

" + "smithy.api#documentation": "

Specify an application name to show only application versions for that\n application.

" + } + }, + "NextToken": { + "target": "com.amazonaws.elasticbeanstalk#Token", + "traits": { + "smithy.api#documentation": "

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other\n parameter values must be identical to the ones specified in the initial request.

\n

If no NextToken is specified, the first page is retrieved.

" } } }, @@ -2232,18 +2232,6 @@ "com.amazonaws.elasticbeanstalk#DescribeConfigurationOptionsMessage": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", - "traits": { - "smithy.api#documentation": "

If specified, restricts the descriptions to only the specified options.

" - } - }, - "PlatformArn": { - "target": "com.amazonaws.elasticbeanstalk#PlatformArn", - "traits": { - "smithy.api#documentation": "

The ARN of the custom platform.

" - } - }, "TemplateName": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { @@ -2256,10 +2244,10 @@ "smithy.api#documentation": "

The name of the solution stack whose configuration options you want to\n describe.

" } }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "Options": { + "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", "traits": { - "smithy.api#documentation": "

The name of the application associated with the configuration template or environment.\n Only needed if you want to describe the configuration options associated with either the\n configuration template or environment.

" + "smithy.api#documentation": "

If specified, restricts the descriptions to only the specified options.

" } }, "EnvironmentName": { @@ -2267,6 +2255,18 @@ "traits": { "smithy.api#documentation": "

The name of the environment whose configuration options you want to describe.

" } + }, + "PlatformArn": { + "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "traits": { + "smithy.api#documentation": "

The ARN of the custom platform.

" + } + }, + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application associated with the configuration template or environment.\n Only needed if you want to describe the configuration options associated with either the\n configuration template or environment.

" + } } }, "traits": { @@ -2293,6 +2293,12 @@ "com.amazonaws.elasticbeanstalk#DescribeConfigurationSettingsMessage": { "type": "structure", "members": { + "TemplateName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the configuration template to describe.

\n

Conditional: You must specify either this parameter or an EnvironmentName, but not\n both. If you specify both, AWS Elastic Beanstalk returns an\n InvalidParameterCombination error. If you do not specify either, AWS Elastic\n Beanstalk returns a MissingRequiredParameter error.

" + } + }, "ApplicationName": { "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { @@ -2305,12 +2311,6 @@ "traits": { "smithy.api#documentation": "

The name of the environment to describe.

\n

Condition: You must specify either this or a TemplateName, but not both. If you\n specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error.\n If you do not specify either, AWS Elastic Beanstalk returns\n MissingRequiredParameter error.

" } - }, - "TemplateName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the configuration template to describe.

\n

Conditional: You must specify either this parameter or an EnvironmentName, but not\n both. If you specify both, AWS Elastic Beanstalk returns an\n InvalidParameterCombination error. If you do not specify either, AWS Elastic\n Beanstalk returns a MissingRequiredParameter error.

" - } } }, "traits": { @@ -2366,28 +2366,22 @@ "com.amazonaws.elasticbeanstalk#DescribeEnvironmentHealthResult": { "type": "structure", "members": { - "EnvironmentName": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The environment's name.

" - } - }, "Status": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentHealth", "traits": { "smithy.api#documentation": "

The environment's operational status. Ready, Launching,\n Updating, Terminating, or Terminated.

" } }, - "ApplicationMetrics": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationMetrics", + "EnvironmentName": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", "traits": { - "smithy.api#documentation": "

Application request metrics for the environment.

" + "smithy.api#documentation": "

The environment's name.

" } }, - "Causes": { - "target": "com.amazonaws.elasticbeanstalk#Causes", + "ApplicationMetrics": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationMetrics", "traits": { - "smithy.api#documentation": "

Descriptions of the data that contributed to the environment's current health\n status.

" + "smithy.api#documentation": "

Application request metrics for the environment.

" } }, "RefreshedAt": { @@ -2408,6 +2402,12 @@ "smithy.api#documentation": "

The health status of the\n environment. For example, Ok.

" } }, + "Causes": { + "target": "com.amazonaws.elasticbeanstalk#Causes", + "traits": { + "smithy.api#documentation": "

Descriptions of the data that contributed to the environment's current health\n status.

" + } + }, "Color": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { @@ -2445,12 +2445,6 @@ "com.amazonaws.elasticbeanstalk#DescribeEnvironmentManagedActionHistoryRequest": { "type": "structure", "members": { - "EnvironmentId": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", - "traits": { - "smithy.api#documentation": "

The environment ID of the target environment.

" - } - }, "EnvironmentName": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", "traits": { @@ -2463,6 +2457,12 @@ "smithy.api#documentation": "

The pagination token returned by a previous request.

" } }, + "EnvironmentId": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", + "traits": { + "smithy.api#documentation": "

The environment ID of the target environment.

" + } + }, "MaxItems": { "target": "com.amazonaws.elasticbeanstalk#Integer", "traits": { @@ -2477,17 +2477,17 @@ "com.amazonaws.elasticbeanstalk#DescribeEnvironmentManagedActionHistoryResult": { "type": "structure", "members": { - "ManagedActionHistoryItems": { - "target": "com.amazonaws.elasticbeanstalk#ManagedActionHistoryItems", - "traits": { - "smithy.api#documentation": "

A list of completed and failed managed actions.

" - } - }, "NextToken": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { "smithy.api#documentation": "

A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of\n results.

" } + }, + "ManagedActionHistoryItems": { + "target": "com.amazonaws.elasticbeanstalk#ManagedActionHistoryItems", + "traits": { + "smithy.api#documentation": "

A list of completed and failed managed actions.

" + } } }, "traits": { @@ -2603,40 +2603,28 @@ "com.amazonaws.elasticbeanstalk#DescribeEnvironmentsMessage": { "type": "structure", "members": { - "EnvironmentNames": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentNamesList", - "traits": { - "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those that have the specified names.

" - } - }, - "IncludeDeleted": { - "target": "com.amazonaws.elasticbeanstalk#IncludeDeleted", - "traits": { - "smithy.api#documentation": "

Indicates whether to include deleted environments:

\n

\n true: Environments that have been deleted after\n IncludedDeletedBackTo are displayed.

\n

\n false: Do not include deleted environments.

" - } - }, "MaxRecords": { "target": "com.amazonaws.elasticbeanstalk#MaxRecords", "traits": { "smithy.api#documentation": "

For a paginated request. Specify a maximum number of environments to include in\n each response.

\n

If no MaxRecords is specified, all available environments are\n retrieved in a single response.

" } }, - "IncludedDeletedBackTo": { - "target": "com.amazonaws.elasticbeanstalk#IncludeDeletedBackTo", - "traits": { - "smithy.api#documentation": "

If specified when IncludeDeleted is set to true, then\n environments deleted after this date are displayed.

" - } - }, "EnvironmentIds": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentIdList", "traits": { "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those that have the specified IDs.

" } }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "IncludedDeletedBackTo": { + "target": "com.amazonaws.elasticbeanstalk#IncludeDeletedBackTo", "traits": { - "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those that are associated with this application.

" + "smithy.api#documentation": "

If specified when IncludeDeleted is set to true, then\n environments deleted after this date are displayed.

" + } + }, + "EnvironmentNames": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentNamesList", + "traits": { + "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those that have the specified names.

" } }, "NextToken": { @@ -2645,11 +2633,23 @@ "smithy.api#documentation": "

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other\n parameter values must be identical to the ones specified in the initial request.

\n

If no NextToken is specified, the first page is retrieved.

" } }, + "IncludeDeleted": { + "target": "com.amazonaws.elasticbeanstalk#IncludeDeleted", + "traits": { + "smithy.api#documentation": "

Indicates whether to include deleted environments:

\n

\n true: Environments that have been deleted after\n IncludedDeletedBackTo are displayed.

\n

\n false: Do not include deleted environments.

" + } + }, "VersionLabel": { "target": "com.amazonaws.elasticbeanstalk#VersionLabel", "traits": { "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those that are associated with this application version.

" } + }, + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "traits": { + "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those that are associated with this application.

" + } } }, "traits": { @@ -2677,24 +2677,12 @@ "com.amazonaws.elasticbeanstalk#DescribeEventsMessage": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.elasticbeanstalk#RequestId", - "traits": { - "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the described events to include only\n those associated with this request ID.

" - } - }, "TemplateName": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that\n are associated with this environment configuration.

" } }, - "MaxRecords": { - "target": "com.amazonaws.elasticbeanstalk#MaxRecords", - "traits": { - "smithy.api#documentation": "

Specifies the maximum number of events that can be returned, beginning with the most\n recent event.

" - } - }, "StartTime": { "target": "com.amazonaws.elasticbeanstalk#TimeFilterStart", "traits": { @@ -2713,22 +2701,16 @@ "smithy.api#documentation": "

If specified, limits the events returned from this call to include only those with the\n specified severity or higher.

" } }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", - "traits": { - "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those associated with this application.

" - } - }, - "EnvironmentName": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "MaxRecords": { + "target": "com.amazonaws.elasticbeanstalk#MaxRecords", "traits": { - "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those\n associated with this environment.

" + "smithy.api#documentation": "

Specifies the maximum number of events that can be returned, beginning with the most\n recent event.

" } }, - "EnvironmentId": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { - "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those\n associated with this environment.

" + "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only\n those associated with this application.

" } }, "PlatformArn": { @@ -2748,6 +2730,24 @@ "traits": { "smithy.api#documentation": "

Pagination token. If specified, the events return the next batch of results.

" } + }, + "RequestId": { + "target": "com.amazonaws.elasticbeanstalk#RequestId", + "traits": { + "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the described events to include only\n those associated with this request ID.

" + } + }, + "EnvironmentName": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "traits": { + "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those\n associated with this environment.

" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", + "traits": { + "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those\n associated with this environment.

" + } } }, "traits": { @@ -2777,18 +2777,6 @@ "com.amazonaws.elasticbeanstalk#DescribeInstancesHealthRequest": { "type": "structure", "members": { - "EnvironmentId": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", - "traits": { - "smithy.api#documentation": "

Specify the AWS Elastic Beanstalk environment by ID.

" - } - }, - "EnvironmentName": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", - "traits": { - "smithy.api#documentation": "

Specify the AWS Elastic Beanstalk environment by name.

" - } - }, "NextToken": { "target": "com.amazonaws.elasticbeanstalk#NextToken", "traits": { @@ -2800,6 +2788,18 @@ "traits": { "smithy.api#documentation": "

Specifies the response elements you wish to receive. To retrieve all attributes, set to\n All. If no attribute names are specified, returns a list of\n instances.

" } + }, + "EnvironmentId": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", + "traits": { + "smithy.api#documentation": "

Specify the AWS Elastic Beanstalk environment by ID.

" + } + }, + "EnvironmentName": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "traits": { + "smithy.api#documentation": "

Specify the AWS Elastic Beanstalk environment by name.

" + } } }, "traits": { @@ -2809,16 +2809,16 @@ "com.amazonaws.elasticbeanstalk#DescribeInstancesHealthResult": { "type": "structure", "members": { - "InstanceHealthList": { - "target": "com.amazonaws.elasticbeanstalk#InstanceHealthList", + "NextToken": { + "target": "com.amazonaws.elasticbeanstalk#NextToken", "traits": { - "smithy.api#documentation": "

Detailed health information about each instance.

\n

The output differs slightly between Linux and Windows environments. There is a difference\n in the members that are supported under the type.

" + "smithy.api#documentation": "

Pagination token for the next page of results, if available.

" } }, - "NextToken": { - "target": "com.amazonaws.elasticbeanstalk#NextToken", + "InstanceHealthList": { + "target": "com.amazonaws.elasticbeanstalk#InstanceHealthList", "traits": { - "smithy.api#documentation": "

Pagination token for the next page of results, if available.

" + "smithy.api#documentation": "

Detailed health information about each instance.

\n

The output differs slightly between Linux and Windows environments. There is a difference\n in the members that are supported under the type.

" } }, "RefreshedAt": { @@ -2939,28 +2939,28 @@ "com.amazonaws.elasticbeanstalk#EnvironmentDescription": { "type": "structure", "members": { - "EnvironmentLinks": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentLinks", + "TemplateName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { - "smithy.api#documentation": "

A list of links to other environments in the same group.

" + "smithy.api#documentation": "

The name of the configuration template used to originally launch this\n environment.

" } }, - "HealthStatus": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentHealthStatus", + "Resources": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentResourcesDescription", "traits": { - "smithy.api#documentation": "

Returns the health status of the application running in your environment. For more\n information, see Health Colors and\n Statuses.

" + "smithy.api#documentation": "

The description of the AWS resources used by this environment.

" } }, - "EndpointURL": { - "target": "com.amazonaws.elasticbeanstalk#EndpointURL", + "HealthStatus": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentHealthStatus", "traits": { - "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For\n single-instance environments, the IP address of the instance.

" + "smithy.api#documentation": "

Returns the health status of the application running in your environment. For more\n information, see Health Colors and\n Statuses.

" } }, - "PlatformArn": { - "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "EnvironmentLinks": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentLinks", "traits": { - "smithy.api#documentation": "

The ARN of the platform version.

" + "smithy.api#documentation": "

A list of links to other environments in the same group.

" } }, "EnvironmentId": { @@ -2969,12 +2969,24 @@ "smithy.api#documentation": "

The ID of this environment.

" } }, + "PlatformArn": { + "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "traits": { + "smithy.api#documentation": "

The ARN of the platform version.

" + } + }, "ApplicationName": { "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { "smithy.api#documentation": "

The name of the application associated with this environment.

" } }, + "EndpointURL": { + "target": "com.amazonaws.elasticbeanstalk#EndpointURL", + "traits": { + "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For\n single-instance environments, the IP address of the instance.

" + } + }, "AbortableOperationInProgress": { "target": "com.amazonaws.elasticbeanstalk#AbortableOperationInProgress", "traits": { @@ -2987,28 +2999,22 @@ "smithy.api#documentation": "

The creation date for this environment.

" } }, - "OperationsRole": { - "target": "com.amazonaws.elasticbeanstalk#OperationsRole", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment's operations role. For more information,\n see Operations roles in the AWS Elastic Beanstalk Developer Guide.

" - } - }, "Tier": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentTier", "traits": { "smithy.api#documentation": "

Describes the current tier of this environment.

" } }, - "CNAME": { - "target": "com.amazonaws.elasticbeanstalk#DNSCname", + "OperationsRole": { + "target": "com.amazonaws.elasticbeanstalk#OperationsRole", "traits": { - "smithy.api#documentation": "

The URL to the CNAME for this environment.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment's operations role. For more information,\n see Operations roles in the AWS Elastic Beanstalk Developer Guide.

" } }, - "Description": { - "target": "com.amazonaws.elasticbeanstalk#Description", + "CNAME": { + "target": "com.amazonaws.elasticbeanstalk#DNSCname", "traits": { - "smithy.api#documentation": "

Describes this environment.

" + "smithy.api#documentation": "

The URL to the CNAME for this environment.

" } }, "SolutionStackName": { @@ -3017,22 +3023,16 @@ "smithy.api#documentation": "

The name of the SolutionStack deployed with this environment.

" } }, - "Status": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "

The current operational status of the environment:

\n\n " - } - }, "EnvironmentArn": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentArn", "traits": { "smithy.api#documentation": "

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

" } }, - "DateUpdated": { - "target": "com.amazonaws.elasticbeanstalk#UpdateDate", + "Status": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentStatus", "traits": { - "smithy.api#documentation": "

The last modified date for this environment.

" + "smithy.api#documentation": "

The current operational status of the environment:

\n\n " } }, "Health": { @@ -3053,16 +3053,16 @@ "smithy.api#documentation": "

The name of this environment.

" } }, - "Resources": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentResourcesDescription", + "DateUpdated": { + "target": "com.amazonaws.elasticbeanstalk#UpdateDate", "traits": { - "smithy.api#documentation": "

The description of the AWS resources used by this environment.

" + "smithy.api#documentation": "

The last modified date for this environment.

" } }, - "TemplateName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "Description": { + "target": "com.amazonaws.elasticbeanstalk#Description", "traits": { - "smithy.api#documentation": "

The name of the configuration template used to originally launch this\n environment.

" + "smithy.api#documentation": "

Describes this environment.

" } } }, @@ -3206,29 +3206,29 @@ "com.amazonaws.elasticbeanstalk#EnvironmentInfoDescription": { "type": "structure", "members": { - "InfoType": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentInfoType", - "traits": { - "smithy.api#documentation": "

The type of information retrieved.

" - } - }, - "Message": { - "target": "com.amazonaws.elasticbeanstalk#Message", - "traits": { - "smithy.api#documentation": "

The retrieved information. Currently contains a presigned Amazon S3 URL. The files are\n deleted after 15 minutes.

\n

Anyone in possession of this URL can access the files before they are deleted. Make the\n URL available only to trusted parties.

" - } - }, "Ec2InstanceId": { "target": "com.amazonaws.elasticbeanstalk#Ec2InstanceId", "traits": { "smithy.api#documentation": "

The Amazon EC2 Instance ID for this information.

" } }, + "InfoType": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentInfoType", + "traits": { + "smithy.api#documentation": "

The type of information retrieved.

" + } + }, "SampleTimestamp": { "target": "com.amazonaws.elasticbeanstalk#SampleTimestamp", "traits": { "smithy.api#documentation": "

The time stamp when this information was retrieved.

" } + }, + "Message": { + "target": "com.amazonaws.elasticbeanstalk#Message", + "traits": { + "smithy.api#documentation": "

The retrieved information. Currently contains a presigned Amazon S3 URL. The files are\n deleted after 15 minutes.

\n

Anyone in possession of this URL can access the files before they are deleted. Make the\n URL available only to trusted parties.

" + } } }, "traits": { @@ -3304,24 +3304,12 @@ "smithy.api#documentation": "

The Auto Scaling launch configurations in use by this environment.

" } }, - "Instances": { - "target": "com.amazonaws.elasticbeanstalk#InstanceList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 instances used by this environment.

" - } - }, "LaunchTemplates": { "target": "com.amazonaws.elasticbeanstalk#LaunchTemplateList", "traits": { "smithy.api#documentation": "

The Amazon EC2 launch templates in use by this environment.

" } }, - "LoadBalancers": { - "target": "com.amazonaws.elasticbeanstalk#LoadBalancerList", - "traits": { - "smithy.api#documentation": "

The LoadBalancers in use by this environment.

" - } - }, "Triggers": { "target": "com.amazonaws.elasticbeanstalk#TriggerList", "traits": { @@ -3334,6 +3322,12 @@ "smithy.api#documentation": "

The queues used by this environment.

" } }, + "Instances": { + "target": "com.amazonaws.elasticbeanstalk#InstanceList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instances used by this environment.

" + } + }, "EnvironmentName": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", "traits": { @@ -3345,6 +3339,12 @@ "traits": { "smithy.api#documentation": "

The AutoScalingGroups used by this environment.

" } + }, + "LoadBalancers": { + "target": "com.amazonaws.elasticbeanstalk#LoadBalancerList", + "traits": { + "smithy.api#documentation": "

The LoadBalancers in use by this environment.

" + } } }, "traits": { @@ -3410,16 +3410,16 @@ "smithy.api#documentation": "

The name of this environment tier.

\n

Valid values:

\n " } }, - "Version": { + "Type": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the\n latest compatible worker tier version.

\n \n

This member is deprecated. Any specific version that you set may become out of date.\n We recommend leaving it unspecified.

\n " + "smithy.api#documentation": "

The type of this environment tier.

\n

Valid values:

\n " } }, - "Type": { + "Version": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The type of this environment tier.

\n

Valid values:

\n " + "smithy.api#documentation": "

The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the\n latest compatible worker tier version.

\n \n

This member is deprecated. Any specific version that you set may become out of date.\n We recommend leaving it unspecified.

\n " } } }, @@ -3451,16 +3451,16 @@ "smithy.api#documentation": "

The name of the environment associated with this event.

" } }, - "RequestId": { - "target": "com.amazonaws.elasticbeanstalk#RequestId", + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { - "smithy.api#documentation": "

The web service request ID for the activity of this event.

" + "smithy.api#documentation": "

The application associated with the event.

" } }, - "PlatformArn": { - "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "RequestId": { + "target": "com.amazonaws.elasticbeanstalk#RequestId", "traits": { - "smithy.api#documentation": "

The ARN of the platform version.

" + "smithy.api#documentation": "

The web service request ID for the activity of this event.

" } }, "VersionLabel": { @@ -3469,18 +3469,18 @@ "smithy.api#documentation": "

The release label for the application version associated with this event.

" } }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", - "traits": { - "smithy.api#documentation": "

The application associated with the event.

" - } - }, "EventDate": { "target": "com.amazonaws.elasticbeanstalk#EventDate", "traits": { "smithy.api#documentation": "

The date when the event occurred.

" } }, + "PlatformArn": { + "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "traits": { + "smithy.api#documentation": "

The ARN of the platform version.

" + } + }, "TemplateName": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { @@ -3636,16 +3636,16 @@ "com.amazonaws.elasticbeanstalk#InstanceHealthSummary": { "type": "structure", "members": { - "Degraded": { + "Warning": { "target": "com.amazonaws.elasticbeanstalk#NullableInteger", "traits": { - "smithy.api#documentation": "

\n Red. The health agent is reporting a high number of request\n failures or other issues for an instance or environment.

" + "smithy.api#documentation": "

\n Yellow. The health agent is reporting a moderate number of\n request failures or other issues for an instance or environment.

" } }, - "Warning": { + "Degraded": { "target": "com.amazonaws.elasticbeanstalk#NullableInteger", "traits": { - "smithy.api#documentation": "

\n Yellow. The health agent is reporting a moderate number of\n request failures or other issues for an instance or environment.

" + "smithy.api#documentation": "

\n Red. The health agent is reporting a high number of request\n failures or other issues for an instance or environment.

" } }, "Ok": { @@ -3666,12 +3666,6 @@ "smithy.api#documentation": "

\n Red. The health agent is reporting a very high number of\n request failures or other issues for an instance or environment.

" } }, - "Pending": { - "target": "com.amazonaws.elasticbeanstalk#NullableInteger", - "traits": { - "smithy.api#documentation": "

\n Grey. An operation is in progress on an instance within the\n command timeout.

" - } - }, "Info": { "target": "com.amazonaws.elasticbeanstalk#NullableInteger", "traits": { @@ -3683,6 +3677,12 @@ "traits": { "smithy.api#documentation": "

\n Grey. AWS Elastic Beanstalk and the health agent are\n reporting no data on an instance.

" } + }, + "Pending": { + "target": "com.amazonaws.elasticbeanstalk#NullableInteger", + "traits": { + "smithy.api#documentation": "

\n Grey. An operation is in progress on an instance within the\n command timeout.

" + } } }, "traits": { @@ -3799,52 +3799,52 @@ "com.amazonaws.elasticbeanstalk#Latency": { "type": "structure", "members": { - "P50": { + "P90": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 50 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 10 percent of requests over the last 10\n seconds.

" } }, - "P95": { + "P85": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 5 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 15 percent of requests over the last 10\n seconds.

" } }, - "P10": { + "P999": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 90 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 0.1 percent of requests over the last 10\n seconds.

" } }, - "P99": { + "P75": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 1 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 25 percent of requests over the last 10\n seconds.

" } }, - "P85": { + "P50": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 15 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 50 percent of requests over the last 10\n seconds.

" } }, - "P999": { + "P95": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 0.1 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 5 percent of requests over the last 10\n seconds.

" } }, - "P75": { + "P10": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 25 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 90 percent of requests over the last 10\n seconds.

" } }, - "P90": { + "P99": { "target": "com.amazonaws.elasticbeanstalk#NullableDouble", "traits": { - "smithy.api#documentation": "

The average latency for the slowest 10 percent of requests over the last 10\n seconds.

" + "smithy.api#documentation": "

The average latency for the slowest 1 percent of requests over the last 10\n seconds.

" } } }, @@ -3967,17 +3967,17 @@ "com.amazonaws.elasticbeanstalk#ListPlatformBranchesResult": { "type": "structure", "members": { - "PlatformBranchSummaryList": { - "target": "com.amazonaws.elasticbeanstalk#PlatformBranchSummaryList", - "traits": { - "smithy.api#documentation": "

Summary information about the platform branches.

" - } - }, "NextToken": { "target": "com.amazonaws.elasticbeanstalk#Token", "traits": { "smithy.api#documentation": "

In a paginated request, if this value isn't null, it's the token that you can\n pass in a subsequent request to get the next response page.

" } + }, + "PlatformBranchSummaryList": { + "target": "com.amazonaws.elasticbeanstalk#PlatformBranchSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about the platform branches.

" + } } } }, @@ -4085,17 +4085,17 @@ "com.amazonaws.elasticbeanstalk#Listener": { "type": "structure", "members": { - "Protocol": { - "target": "com.amazonaws.elasticbeanstalk#String", - "traits": { - "smithy.api#documentation": "

The protocol that is used by the Listener.

" - } - }, "Port": { "target": "com.amazonaws.elasticbeanstalk#Integer", "traits": { "smithy.api#documentation": "

The port that is used by the Listener.

" } + }, + "Protocol": { + "target": "com.amazonaws.elasticbeanstalk#String", + "traits": { + "smithy.api#documentation": "

The protocol that is used by the Listener.

" + } } }, "traits": { @@ -4169,28 +4169,28 @@ "com.amazonaws.elasticbeanstalk#ManagedAction": { "type": "structure", "members": { - "ActionId": { - "target": "com.amazonaws.elasticbeanstalk#String", + "WindowStartTime": { + "target": "com.amazonaws.elasticbeanstalk#Timestamp", "traits": { - "smithy.api#documentation": "

A unique identifier for the managed action.

" + "smithy.api#documentation": "

The start time of the maintenance window in which the managed action will\n execute.

" } }, - "ActionType": { - "target": "com.amazonaws.elasticbeanstalk#ActionType", + "Status": { + "target": "com.amazonaws.elasticbeanstalk#ActionStatus", "traits": { - "smithy.api#documentation": "

The type of managed action.

" + "smithy.api#documentation": "

The status of the managed action. If the action is Scheduled, you can\n apply it immediately with ApplyEnvironmentManagedAction.

" } }, - "WindowStartTime": { - "target": "com.amazonaws.elasticbeanstalk#Timestamp", + "ActionId": { + "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The start time of the maintenance window in which the managed action will\n execute.

" + "smithy.api#documentation": "

A unique identifier for the managed action.

" } }, - "Status": { - "target": "com.amazonaws.elasticbeanstalk#ActionStatus", + "ActionType": { + "target": "com.amazonaws.elasticbeanstalk#ActionType", "traits": { - "smithy.api#documentation": "

The status of the managed action. If the action is Scheduled, you can\n apply it immediately with ApplyEnvironmentManagedAction.

" + "smithy.api#documentation": "

The type of managed action.

" } }, "ActionDescription": { @@ -4207,6 +4207,18 @@ "com.amazonaws.elasticbeanstalk#ManagedActionHistoryItem": { "type": "structure", "members": { + "FinishedTime": { + "target": "com.amazonaws.elasticbeanstalk#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the action finished executing.

" + } + }, + "ActionType": { + "target": "com.amazonaws.elasticbeanstalk#ActionType", + "traits": { + "smithy.api#documentation": "

The type of the managed action.

" + } + }, "FailureType": { "target": "com.amazonaws.elasticbeanstalk#FailureType", "traits": { @@ -4231,18 +4243,6 @@ "smithy.api#documentation": "

If the action failed, a description of the failure.

" } }, - "FinishedTime": { - "target": "com.amazonaws.elasticbeanstalk#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the action finished executing.

" - } - }, - "ActionType": { - "target": "com.amazonaws.elasticbeanstalk#ActionType", - "traits": { - "smithy.api#documentation": "

The type of the managed action.

" - } - }, "ExecutedTime": { "target": "com.amazonaws.elasticbeanstalk#Timestamp", "traits": { @@ -4336,18 +4336,18 @@ "smithy.api#documentation": "

Set to true to delete a version's source bundle from Amazon S3 when\n Elastic Beanstalk deletes the application version.

" } }, + "MaxCount": { + "target": "com.amazonaws.elasticbeanstalk#BoxedInt", + "traits": { + "smithy.api#documentation": "

Specify the maximum number of application versions to retain.

" + } + }, "Enabled": { "target": "com.amazonaws.elasticbeanstalk#BoxedBoolean", "traits": { "smithy.api#documentation": "

Specify true to apply the rule, or false to disable\n it.

", "smithy.api#required": {} } - }, - "MaxCount": { - "target": "com.amazonaws.elasticbeanstalk#BoxedInt", - "traits": { - "smithy.api#documentation": "

Specify the maximum number of application versions to retain.

" - } } }, "traits": { @@ -4475,6 +4475,12 @@ "com.amazonaws.elasticbeanstalk#OptionSpecification": { "type": "structure", "members": { + "OptionName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionName", + "traits": { + "smithy.api#documentation": "

The name of the configuration option.

" + } + }, "Namespace": { "target": "com.amazonaws.elasticbeanstalk#OptionNamespace", "traits": { @@ -4486,12 +4492,6 @@ "traits": { "smithy.api#documentation": "

A unique resource name for a time-based scaling configuration option.

" } - }, - "OptionName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionName", - "traits": { - "smithy.api#documentation": "

The name of the configuration option.

" - } } }, "traits": { @@ -4522,6 +4522,18 @@ "com.amazonaws.elasticbeanstalk#PlatformBranchSummary": { "type": "structure", "members": { + "BranchName": { + "target": "com.amazonaws.elasticbeanstalk#BranchName", + "traits": { + "smithy.api#documentation": "

The name of the platform branch.

" + } + }, + "BranchOrder": { + "target": "com.amazonaws.elasticbeanstalk#BranchOrder", + "traits": { + "smithy.api#documentation": "

An ordinal number that designates the order in which platform branches have been added to\n a platform. This can be helpful, for example, if your code calls the\n ListPlatformBranches action and then displays a list of platform\n branches.

\n

A larger BranchOrder value designates a newer platform branch within the\n platform.

" + } + }, "SupportedTierList": { "target": "com.amazonaws.elasticbeanstalk#SupportedTierList", "traits": { @@ -4534,23 +4546,11 @@ "smithy.api#documentation": "

The name of the platform to which this platform branch belongs.

" } }, - "BranchOrder": { - "target": "com.amazonaws.elasticbeanstalk#BranchOrder", - "traits": { - "smithy.api#documentation": "

An ordinal number that designates the order in which platform branches have been added to\n a platform. This can be helpful, for example, if your code calls the\n ListPlatformBranches action and then displays a list of platform\n branches.

\n

A larger BranchOrder value designates a newer platform branch within the\n platform.

" - } - }, "LifecycleState": { "target": "com.amazonaws.elasticbeanstalk#PlatformBranchLifecycleState", "traits": { "smithy.api#documentation": "

The support life cycle state of the platform branch.

\n

Possible values: beta | supported | deprecated | \n retired\n

" } - }, - "BranchName": { - "target": "com.amazonaws.elasticbeanstalk#BranchName", - "traits": { - "smithy.api#documentation": "

The name of the platform branch.

" - } } }, "traits": { @@ -4569,12 +4569,6 @@ "com.amazonaws.elasticbeanstalk#PlatformDescription": { "type": "structure", "members": { - "PlatformStatus": { - "target": "com.amazonaws.elasticbeanstalk#PlatformStatus", - "traits": { - "smithy.api#documentation": "

The status of the platform version.

" - } - }, "PlatformLifecycleState": { "target": "com.amazonaws.elasticbeanstalk#PlatformLifecycleState", "traits": { @@ -4587,28 +4581,16 @@ "smithy.api#documentation": "

Information about the maintainer of the platform version.

" } }, - "PlatformBranchName": { - "target": "com.amazonaws.elasticbeanstalk#BranchName", - "traits": { - "smithy.api#documentation": "

The platform branch to which the platform version belongs.

" - } - }, "PlatformOwner": { "target": "com.amazonaws.elasticbeanstalk#PlatformOwner", "traits": { "smithy.api#documentation": "

The AWS account ID of the person who created the platform version.

" } }, - "Frameworks": { - "target": "com.amazonaws.elasticbeanstalk#PlatformFrameworks", - "traits": { - "smithy.api#documentation": "

The frameworks supported by the platform version.

" - } - }, - "OperatingSystemVersion": { - "target": "com.amazonaws.elasticbeanstalk#OperatingSystemVersion", + "PlatformBranchName": { + "target": "com.amazonaws.elasticbeanstalk#BranchName", "traits": { - "smithy.api#documentation": "

The version of the operating system used by the platform version.

" + "smithy.api#documentation": "

The platform branch to which the platform version belongs.

" } }, "SupportedTierList": { @@ -4623,28 +4605,46 @@ "smithy.api#documentation": "

The name of the platform version.

" } }, + "PlatformVersion": { + "target": "com.amazonaws.elasticbeanstalk#PlatformVersion", + "traits": { + "smithy.api#documentation": "

The version of the platform version.

" + } + }, "DateCreated": { "target": "com.amazonaws.elasticbeanstalk#CreationDate", "traits": { "smithy.api#documentation": "

The date when the platform version was created.

" } }, + "OperatingSystemVersion": { + "target": "com.amazonaws.elasticbeanstalk#OperatingSystemVersion", + "traits": { + "smithy.api#documentation": "

The version of the operating system used by the platform version.

" + } + }, + "PlatformCategory": { + "target": "com.amazonaws.elasticbeanstalk#PlatformCategory", + "traits": { + "smithy.api#documentation": "

The category of the platform version.

" + } + }, "CustomAmiList": { "target": "com.amazonaws.elasticbeanstalk#CustomAmiList", "traits": { "smithy.api#documentation": "

The custom AMIs supported by the platform version.

" } }, - "Description": { - "target": "com.amazonaws.elasticbeanstalk#Description", + "OperatingSystemName": { + "target": "com.amazonaws.elasticbeanstalk#OperatingSystemName", "traits": { - "smithy.api#documentation": "

The description of the platform version.

" + "smithy.api#documentation": "

The operating system used by the platform version.

" } }, - "PlatformVersion": { - "target": "com.amazonaws.elasticbeanstalk#PlatformVersion", + "PlatformBranchLifecycleState": { + "target": "com.amazonaws.elasticbeanstalk#PlatformBranchLifecycleState", "traits": { - "smithy.api#documentation": "

The version of the platform version.

" + "smithy.api#documentation": "

The state of the platform version's branch in its lifecycle.

\n

Possible values: Beta | Supported | Deprecated |\n Retired\n

" } }, "PlatformArn": { @@ -4653,46 +4653,46 @@ "smithy.api#documentation": "

The ARN of the platform version.

" } }, - "DateUpdated": { - "target": "com.amazonaws.elasticbeanstalk#UpdateDate", + "SupportedAddonList": { + "target": "com.amazonaws.elasticbeanstalk#SupportedAddonList", "traits": { - "smithy.api#documentation": "

The date when the platform version was last updated.

" + "smithy.api#documentation": "

The additions supported by the platform version.

" } }, - "OperatingSystemName": { - "target": "com.amazonaws.elasticbeanstalk#OperatingSystemName", + "ProgrammingLanguages": { + "target": "com.amazonaws.elasticbeanstalk#PlatformProgrammingLanguages", "traits": { - "smithy.api#documentation": "

The operating system used by the platform version.

" + "smithy.api#documentation": "

The programming languages supported by the platform version.

" } }, - "PlatformCategory": { - "target": "com.amazonaws.elasticbeanstalk#PlatformCategory", + "DateUpdated": { + "target": "com.amazonaws.elasticbeanstalk#UpdateDate", "traits": { - "smithy.api#documentation": "

The category of the platform version.

" + "smithy.api#documentation": "

The date when the platform version was last updated.

" } }, - "ProgrammingLanguages": { - "target": "com.amazonaws.elasticbeanstalk#PlatformProgrammingLanguages", + "Frameworks": { + "target": "com.amazonaws.elasticbeanstalk#PlatformFrameworks", "traits": { - "smithy.api#documentation": "

The programming languages supported by the platform version.

" + "smithy.api#documentation": "

The frameworks supported by the platform version.

" } }, - "PlatformBranchLifecycleState": { - "target": "com.amazonaws.elasticbeanstalk#PlatformBranchLifecycleState", + "PlatformStatus": { + "target": "com.amazonaws.elasticbeanstalk#PlatformStatus", "traits": { - "smithy.api#documentation": "

The state of the platform version's branch in its lifecycle.

\n

Possible values: Beta | Supported | Deprecated |\n Retired\n

" + "smithy.api#documentation": "

The status of the platform version.

" } }, - "SolutionStackName": { - "target": "com.amazonaws.elasticbeanstalk#SolutionStackName", + "Description": { + "target": "com.amazonaws.elasticbeanstalk#Description", "traits": { - "smithy.api#documentation": "

The name of the solution stack used by the platform version.

" + "smithy.api#documentation": "

The description of the platform version.

" } }, - "SupportedAddonList": { - "target": "com.amazonaws.elasticbeanstalk#SupportedAddonList", + "SolutionStackName": { + "target": "com.amazonaws.elasticbeanstalk#SolutionStackName", "traits": { - "smithy.api#documentation": "

The additions supported by the platform version.

" + "smithy.api#documentation": "

The name of the solution stack used by the platform version.

" } } }, @@ -4703,10 +4703,10 @@ "com.amazonaws.elasticbeanstalk#PlatformFilter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.elasticbeanstalk#PlatformFilterValueList", + "Type": { + "target": "com.amazonaws.elasticbeanstalk#PlatformFilterType", "traits": { - "smithy.api#documentation": "

The list of values applied to the filtering platform version attribute. Only one value is supported\n for all current operators.

\n

The following list shows valid filter values for some filter attributes.

\n " + "smithy.api#documentation": "

The platform version attribute to which the filter values are applied.

\n

Valid values: PlatformName | PlatformVersion |\n PlatformStatus | PlatformBranchName |\n PlatformLifecycleState | PlatformOwner |\n SupportedTier | SupportedAddon |\n ProgrammingLanguageName | OperatingSystemName\n

" } }, "Operator": { @@ -4715,10 +4715,10 @@ "smithy.api#documentation": "

The operator to apply to the Type with each of the\n Values.

\n

Valid values: = | != |\n < | <= |\n > | >= |\n contains | begins_with | ends_with\n

" } }, - "Type": { - "target": "com.amazonaws.elasticbeanstalk#PlatformFilterType", + "Values": { + "target": "com.amazonaws.elasticbeanstalk#PlatformFilterValueList", "traits": { - "smithy.api#documentation": "

The platform version attribute to which the filter values are applied.

\n

Valid values: PlatformName | PlatformVersion |\n PlatformStatus | PlatformBranchName |\n PlatformLifecycleState | PlatformOwner |\n SupportedTier | SupportedAddon |\n ProgrammingLanguageName | OperatingSystemName\n

" + "smithy.api#documentation": "

The list of values applied to the filtering platform version attribute. Only one value is supported\n for all current operators.

\n

The following list shows valid filter values for some filter attributes.

\n " } } }, @@ -4794,16 +4794,16 @@ "com.amazonaws.elasticbeanstalk#PlatformProgrammingLanguage": { "type": "structure", "members": { - "Name": { + "Version": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The name of the programming language.

" + "smithy.api#documentation": "

The version of the programming language.

" } }, - "Version": { + "Name": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The version of the programming language.

" + "smithy.api#documentation": "

The name of the programming language.

" } } }, @@ -4842,12 +4842,6 @@ "com.amazonaws.elasticbeanstalk#PlatformSummary": { "type": "structure", "members": { - "PlatformBranchLifecycleState": { - "target": "com.amazonaws.elasticbeanstalk#PlatformBranchLifecycleState", - "traits": { - "smithy.api#documentation": "

The state of the platform version's branch in its lifecycle.

\n

Possible values: beta | supported | deprecated |\n retired\n

" - } - }, "OperatingSystemVersion": { "target": "com.amazonaws.elasticbeanstalk#OperatingSystemVersion", "traits": { @@ -4866,6 +4860,30 @@ "smithy.api#documentation": "

The tiers in which the platform version runs.

" } }, + "PlatformBranchLifecycleState": { + "target": "com.amazonaws.elasticbeanstalk#PlatformBranchLifecycleState", + "traits": { + "smithy.api#documentation": "

The state of the platform version's branch in its lifecycle.

\n

Possible values: beta | supported | deprecated |\n retired\n

" + } + }, + "PlatformArn": { + "target": "com.amazonaws.elasticbeanstalk#PlatformArn", + "traits": { + "smithy.api#documentation": "

The ARN of the platform version.

" + } + }, + "OperatingSystemName": { + "target": "com.amazonaws.elasticbeanstalk#OperatingSystemName", + "traits": { + "smithy.api#documentation": "

The operating system used by the platform version.

" + } + }, + "PlatformCategory": { + "target": "com.amazonaws.elasticbeanstalk#PlatformCategory", + "traits": { + "smithy.api#documentation": "

The category of platform version.

" + } + }, "PlatformLifecycleState": { "target": "com.amazonaws.elasticbeanstalk#PlatformLifecycleState", "traits": { @@ -4895,24 +4913,6 @@ "traits": { "smithy.api#documentation": "

The version string of the platform version.

" } - }, - "OperatingSystemName": { - "target": "com.amazonaws.elasticbeanstalk#OperatingSystemName", - "traits": { - "smithy.api#documentation": "

The operating system used by the platform version.

" - } - }, - "PlatformCategory": { - "target": "com.amazonaws.elasticbeanstalk#PlatformCategory", - "traits": { - "smithy.api#documentation": "

The category of platform version.

" - } - }, - "PlatformArn": { - "target": "com.amazonaws.elasticbeanstalk#PlatformArn", - "traits": { - "smithy.api#documentation": "

The ARN of the platform version.

" - } } }, "traits": { @@ -4987,17 +4987,17 @@ "com.amazonaws.elasticbeanstalk#RebuildEnvironmentMessage": { "type": "structure", "members": { - "EnvironmentName": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the environment to rebuild.

\n

Condition: You must specify either this or an EnvironmentId, or both. If you do not\n specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n

" - } - }, "EnvironmentId": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", "traits": { "smithy.api#documentation": "

The ID of the environment to rebuild.

\n

Condition: You must specify either this or an EnvironmentName, or both. If you do not\n specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n

" } + }, + "EnvironmentName": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the environment to rebuild.

\n

Condition: You must specify either this or an EnvironmentId, or both. If you do not\n specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n

" + } } }, "traits": { @@ -5103,34 +5103,34 @@ "com.amazonaws.elasticbeanstalk#ResourceQuotas": { "type": "structure", "members": { - "EnvironmentQuota": { + "ApplicationQuota": { "target": "com.amazonaws.elasticbeanstalk#ResourceQuota", "traits": { - "smithy.api#documentation": "

The quota for environments in the AWS account.

" + "smithy.api#documentation": "

The quota for applications in the AWS account.

" } }, - "CustomPlatformQuota": { + "ConfigurationTemplateQuota": { "target": "com.amazonaws.elasticbeanstalk#ResourceQuota", "traits": { - "smithy.api#documentation": "

The quota for custom platforms in the AWS account.

" + "smithy.api#documentation": "

The quota for configuration templates in the AWS account.

" } }, - "ApplicationVersionQuota": { + "CustomPlatformQuota": { "target": "com.amazonaws.elasticbeanstalk#ResourceQuota", "traits": { - "smithy.api#documentation": "

The quota for application versions in the AWS account.

" + "smithy.api#documentation": "

The quota for custom platforms in the AWS account.

" } }, - "ConfigurationTemplateQuota": { + "ApplicationVersionQuota": { "target": "com.amazonaws.elasticbeanstalk#ResourceQuota", "traits": { - "smithy.api#documentation": "

The quota for configuration templates in the AWS account.

" + "smithy.api#documentation": "

The quota for application versions in the AWS account.

" } }, - "ApplicationQuota": { + "EnvironmentQuota": { "target": "com.amazonaws.elasticbeanstalk#ResourceQuota", "traits": { - "smithy.api#documentation": "

The quota for applications in the AWS account.

" + "smithy.api#documentation": "

The quota for environments in the AWS account.

" } } }, @@ -5329,18 +5329,18 @@ "com.amazonaws.elasticbeanstalk#SearchFilter": { "type": "structure", "members": { - "Operator": { - "target": "com.amazonaws.elasticbeanstalk#SearchFilterOperator", - "traits": { - "smithy.api#documentation": "

The operator to apply to the Attribute with each of the Values.\n Valid values vary by Attribute.

" - } - }, "Values": { "target": "com.amazonaws.elasticbeanstalk#SearchFilterValues", "traits": { "smithy.api#documentation": "

The list of values applied to the Attribute and Operator\n attributes. Number of values and valid values vary by Attribute.

" } }, + "Operator": { + "target": "com.amazonaws.elasticbeanstalk#SearchFilterOperator", + "traits": { + "smithy.api#documentation": "

The operator to apply to the Attribute with each of the Values.\n Valid values vary by Attribute.

" + } + }, "Attribute": { "target": "com.amazonaws.elasticbeanstalk#SearchFilterAttribute", "traits": { @@ -5376,40 +5376,40 @@ "com.amazonaws.elasticbeanstalk#SingleInstanceHealth": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.elasticbeanstalk#InstanceId", + "Deployment": { + "target": "com.amazonaws.elasticbeanstalk#Deployment", "traits": { - "smithy.api#documentation": "

The ID of the Amazon EC2 instance.

" + "smithy.api#documentation": "

Information about the most recent deployment to an instance.

" } }, - "LaunchedAt": { - "target": "com.amazonaws.elasticbeanstalk#LaunchedAt", + "AvailabilityZone": { + "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The time at which the EC2 instance was launched.

" + "smithy.api#documentation": "

The availability zone in which the instance runs.

" } }, - "InstanceType": { - "target": "com.amazonaws.elasticbeanstalk#String", + "Causes": { + "target": "com.amazonaws.elasticbeanstalk#Causes", "traits": { - "smithy.api#documentation": "

The instance's type.

" + "smithy.api#documentation": "

Represents the causes, which provide more information about the current health\n status.

" } }, - "AvailabilityZone": { + "HealthStatus": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

The availability zone in which the instance runs.

" + "smithy.api#documentation": "

Returns the health status of the specified instance. For more information, see Health\n Colors and Statuses.

" } }, - "HealthStatus": { + "InstanceType": { "target": "com.amazonaws.elasticbeanstalk#String", "traits": { - "smithy.api#documentation": "

Returns the health status of the specified instance. For more information, see Health\n Colors and Statuses.

" + "smithy.api#documentation": "

The instance's type.

" } }, - "Causes": { - "target": "com.amazonaws.elasticbeanstalk#Causes", + "InstanceId": { + "target": "com.amazonaws.elasticbeanstalk#InstanceId", "traits": { - "smithy.api#documentation": "

Represents the causes, which provide more information about the current health\n status.

" + "smithy.api#documentation": "

The ID of the Amazon EC2 instance.

" } }, "Color": { @@ -5424,16 +5424,16 @@ "smithy.api#documentation": "

Request metrics from your application.

" } }, - "System": { - "target": "com.amazonaws.elasticbeanstalk#SystemStatus", + "LaunchedAt": { + "target": "com.amazonaws.elasticbeanstalk#LaunchedAt", "traits": { - "smithy.api#documentation": "

Operating system metrics from the instance.

" + "smithy.api#documentation": "

The time at which the EC2 instance was launched.

" } }, - "Deployment": { - "target": "com.amazonaws.elasticbeanstalk#Deployment", + "System": { + "target": "com.amazonaws.elasticbeanstalk#SystemStatus", "traits": { - "smithy.api#documentation": "

Information about the most recent deployment to an instance.

" + "smithy.api#documentation": "

Operating system metrics from the instance.

" } } }, @@ -5473,6 +5473,13 @@ "com.amazonaws.elasticbeanstalk#SourceBuildInformation": { "type": "structure", "members": { + "SourceRepository": { + "target": "com.amazonaws.elasticbeanstalk#SourceRepository", + "traits": { + "smithy.api#documentation": "

Location where the repository is stored.

\n ", + "smithy.api#required": {} + } + }, "SourceLocation": { "target": "com.amazonaws.elasticbeanstalk#SourceLocation", "traits": { @@ -5486,13 +5493,6 @@ "smithy.api#documentation": "

The type of repository.

\n ", "smithy.api#required": {} } - }, - "SourceRepository": { - "target": "com.amazonaws.elasticbeanstalk#SourceRepository", - "traits": { - "smithy.api#documentation": "

Location where the repository is stored.

\n ", - "smithy.api#required": {} - } } }, "traits": { @@ -5518,17 +5518,17 @@ "com.amazonaws.elasticbeanstalk#SourceConfiguration": { "type": "structure", "members": { - "TemplateName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the configuration template.

" - } - }, "ApplicationName": { "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { "smithy.api#documentation": "

The name of the application associated with the configuration.

" } + }, + "TemplateName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the configuration template.

" + } } }, "traits": { @@ -5636,6 +5636,12 @@ "com.amazonaws.elasticbeanstalk#SwapEnvironmentCNAMEsMessage": { "type": "structure", "members": { + "SourceEnvironmentName": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the source environment.

\n

Condition: You must specify at least the SourceEnvironmentID or the\n SourceEnvironmentName. You may also specify both. If you specify the\n SourceEnvironmentName, you must specify the\n DestinationEnvironmentName.

" + } + }, "SourceEnvironmentId": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", "traits": { @@ -5653,12 +5659,6 @@ "traits": { "smithy.api#documentation": "

The ID of the destination environment.

\n

Condition: You must specify at least the DestinationEnvironmentID or the\n DestinationEnvironmentName. You may also specify both. You must specify the\n SourceEnvironmentId with the DestinationEnvironmentId.

" } - }, - "SourceEnvironmentName": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the source environment.

\n

Condition: You must specify at least the SourceEnvironmentID or the\n SourceEnvironmentName. You may also specify both. If you specify the\n SourceEnvironmentName, you must specify the\n DestinationEnvironmentName.

" - } } }, "traits": { @@ -5688,17 +5688,17 @@ "com.amazonaws.elasticbeanstalk#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.elasticbeanstalk#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

" - } - }, "Key": { "target": "com.amazonaws.elasticbeanstalk#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

" } + }, + "Value": { + "target": "com.amazonaws.elasticbeanstalk#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

" + } } }, "traits": { @@ -5773,6 +5773,12 @@ "smithy.api#documentation": "

Terminates the target environment even if another environment in the same group is\n dependent on it.

" } }, + "TerminateResources": { + "target": "com.amazonaws.elasticbeanstalk#TerminateEnvironmentResources", + "traits": { + "smithy.api#documentation": "

Indicates whether the associated AWS resources should shut down when the environment is\n terminated:

\n \n

For more information, see the AWS Elastic Beanstalk User Guide. \n

\n

Default: true\n

\n

Valid Values: true | false\n

" + } + }, "EnvironmentId": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", "traits": { @@ -5784,12 +5790,6 @@ "traits": { "smithy.api#documentation": "

The name of the environment to terminate.

\n

Condition: You must specify either this or an EnvironmentId, or both. If you do not\n specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n

" } - }, - "TerminateResources": { - "target": "com.amazonaws.elasticbeanstalk#TerminateEnvironmentResources", - "traits": { - "smithy.api#documentation": "

Indicates whether the associated AWS resources should shut down when the environment is\n terminated:

\n \n

For more information, see the AWS Elastic Beanstalk User Guide. \n

\n

Default: true\n

\n

Valid Values: true | false\n

" - } } }, "traits": { @@ -5998,17 +5998,17 @@ "com.amazonaws.elasticbeanstalk#UpdateApplicationResourceLifecycleMessage": { "type": "structure", "members": { - "ResourceLifecycleConfig": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationResourceLifecycleConfig", + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { - "smithy.api#documentation": "

The lifecycle configuration.

", + "smithy.api#documentation": "

The name of the application.

", "smithy.api#required": {} } }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "ResourceLifecycleConfig": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationResourceLifecycleConfig", "traits": { - "smithy.api#documentation": "

The name of the application.

", + "smithy.api#documentation": "

The lifecycle configuration.

", "smithy.api#required": {} } } @@ -6035,17 +6035,17 @@ "smithy.api#documentation": "

A new description for this version.

" } }, - "ApplicationName": { - "target": "com.amazonaws.elasticbeanstalk#ApplicationName", + "VersionLabel": { + "target": "com.amazonaws.elasticbeanstalk#VersionLabel", "traits": { - "smithy.api#documentation": "

The name of the application associated with this version.

\n

If no application is found with this name, UpdateApplication returns an\n InvalidParameterValue error.

", + "smithy.api#documentation": "

The name of the version to update.

\n

If no application version is found with this label, UpdateApplication\n returns an InvalidParameterValue error.

", "smithy.api#required": {} } }, - "VersionLabel": { - "target": "com.amazonaws.elasticbeanstalk#VersionLabel", + "ApplicationName": { + "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { - "smithy.api#documentation": "

The name of the version to update.

\n

If no application version is found with this label, UpdateApplication\n returns an InvalidParameterValue error.

", + "smithy.api#documentation": "

The name of the application associated with this version.

\n

If no application is found with this name, UpdateApplication returns an\n InvalidParameterValue error.

", "smithy.api#required": {} } } @@ -6083,12 +6083,6 @@ "smithy.api#documentation": "

A list of configuration option settings to update with the new specified option\n value.

" } }, - "OptionsToRemove": { - "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", - "traits": { - "smithy.api#documentation": "

A list of configuration options to remove from the configuration set.

\n

Constraint: You can remove only UserDefined configuration options.\n

" - } - }, "ApplicationName": { "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { @@ -6103,6 +6097,12 @@ "smithy.api#required": {} } }, + "OptionsToRemove": { + "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", + "traits": { + "smithy.api#documentation": "

A list of configuration options to remove from the configuration set.

\n

Constraint: You can remove only UserDefined configuration options.\n

" + } + }, "Description": { "target": "com.amazonaws.elasticbeanstalk#Description", "traits": { @@ -6140,22 +6140,16 @@ "com.amazonaws.elasticbeanstalk#UpdateEnvironmentMessage": { "type": "structure", "members": { - "OptionsToRemove": { - "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", - "traits": { - "smithy.api#documentation": "

A list of custom user-defined configuration options to remove from the configuration\n set for this environment.

" - } - }, "TemplateName": { "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", "traits": { "smithy.api#documentation": "

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration\n template to the environment. If no such configuration template is found, AWS Elastic Beanstalk\n returns an InvalidParameterValue error.

" } }, - "OptionSettings": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSettingsList", + "OptionsToRemove": { + "target": "com.amazonaws.elasticbeanstalk#OptionsSpecifierList", "traits": { - "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk updates the configuration set associated with the\n running environment and sets the specified configuration options to the requested\n value.

" + "smithy.api#documentation": "

A list of custom user-defined configuration options to remove from the configuration\n set for this environment.

" } }, "ApplicationName": { @@ -6170,12 +6164,30 @@ "smithy.api#documentation": "

The ARN of the platform, if used.

" } }, + "Description": { + "target": "com.amazonaws.elasticbeanstalk#Description", + "traits": { + "smithy.api#documentation": "

If this parameter is specified, AWS Elastic Beanstalk updates the description of this\n environment.

" + } + }, "GroupName": { "target": "com.amazonaws.elasticbeanstalk#GroupName", "traits": { "smithy.api#documentation": "

The name of the group to which the target environment belongs. Specify a group name\n only if the environment's name is specified in an environment manifest and not with the\n environment name or environment ID parameters. See Environment Manifest\n (env.yaml) for details.

" } }, + "OptionSettings": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionSettingsList", + "traits": { + "smithy.api#documentation": "

If specified, AWS Elastic Beanstalk updates the configuration set associated with the\n running environment and sets the specified configuration options to the requested\n value.

" + } + }, + "SolutionStackName": { + "target": "com.amazonaws.elasticbeanstalk#SolutionStackName", + "traits": { + "smithy.api#documentation": "

This specifies the platform version that the environment will run after the environment\n is updated.

" + } + }, "VersionLabel": { "target": "com.amazonaws.elasticbeanstalk#VersionLabel", "traits": { @@ -6188,28 +6200,16 @@ "smithy.api#documentation": "

The name of the environment to update. If no environment with this name exists, AWS\n Elastic Beanstalk returns an InvalidParameterValue error.

\n

Condition: You must specify either this or an EnvironmentId, or both. If you do not\n specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n

" } }, - "EnvironmentId": { - "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", - "traits": { - "smithy.api#documentation": "

The ID of the environment to update.

\n

If no environment with this ID exists, AWS Elastic Beanstalk returns an\n InvalidParameterValue error.

\n

Condition: You must specify either this or an EnvironmentName, or both. If you do not\n specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n

" - } - }, "Tier": { "target": "com.amazonaws.elasticbeanstalk#EnvironmentTier", "traits": { "smithy.api#documentation": "

This specifies the tier to use to update the environment.

\n

Condition: At this time, if you change the tier version, name, or type, AWS Elastic\n Beanstalk returns InvalidParameterValue error.

" } }, - "Description": { - "target": "com.amazonaws.elasticbeanstalk#Description", - "traits": { - "smithy.api#documentation": "

If this parameter is specified, AWS Elastic Beanstalk updates the description of this\n environment.

" - } - }, - "SolutionStackName": { - "target": "com.amazonaws.elasticbeanstalk#SolutionStackName", + "EnvironmentId": { + "target": "com.amazonaws.elasticbeanstalk#EnvironmentId", "traits": { - "smithy.api#documentation": "

This specifies the platform version that the environment will run after the environment\n is updated.

" + "smithy.api#documentation": "

The ID of the environment to update.

\n

If no environment with this ID exists, AWS Elastic Beanstalk returns an\n InvalidParameterValue error.

\n

Condition: You must specify either this or an EnvironmentName, or both. If you do not\n specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n

" } } }, @@ -6246,18 +6246,18 @@ "com.amazonaws.elasticbeanstalk#UpdateTagsForResourceMessage": { "type": "structure", "members": { - "TagsToAdd": { - "target": "com.amazonaws.elasticbeanstalk#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags to add or update. If a key of an existing tag is added, the tag's value is\n updated.

\n

Specify at least one of these parameters: TagsToAdd,\n TagsToRemove.

" - } - }, "TagsToRemove": { "target": "com.amazonaws.elasticbeanstalk#TagKeyList", "traits": { "smithy.api#documentation": "

A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.

\n

Specify at least one of these parameters: TagsToAdd,\n TagsToRemove.

" } }, + "TagsToAdd": { + "target": "com.amazonaws.elasticbeanstalk#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to add or update. If a key of an existing tag is added, the tag's value is\n updated.

\n

Specify at least one of these parameters: TagsToAdd,\n TagsToRemove.

" + } + }, "ResourceArn": { "target": "com.amazonaws.elasticbeanstalk#ResourceArn", "traits": { @@ -6302,12 +6302,6 @@ "smithy.api#documentation": "

The name of the environment to validate the settings against.

\n

Condition: You cannot specify both this and a configuration template name.

" } }, - "TemplateName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the configuration template to validate the settings against.

\n

Condition: You cannot specify both this and an environment name.

" - } - }, "ApplicationName": { "target": "com.amazonaws.elasticbeanstalk#ApplicationName", "traits": { @@ -6321,6 +6315,12 @@ "smithy.api#documentation": "

A list of the options and desired values to evaluate.

", "smithy.api#required": {} } + }, + "TemplateName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the configuration template to validate the settings against.

\n

Condition: You cannot specify both this and an environment name.

" + } } }, "traits": { @@ -6330,10 +6330,10 @@ "com.amazonaws.elasticbeanstalk#ValidationMessage": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.elasticbeanstalk#ValidationMessageString", + "OptionName": { + "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionName", "traits": { - "smithy.api#documentation": "

A message describing the error or warning.

" + "smithy.api#documentation": "

The name of the option.

" } }, "Namespace": { @@ -6348,10 +6348,10 @@ "smithy.api#documentation": "

An indication of the severity of this message:

\n " } }, - "OptionName": { - "target": "com.amazonaws.elasticbeanstalk#ConfigurationOptionName", + "Message": { + "target": "com.amazonaws.elasticbeanstalk#ValidationMessageString", "traits": { - "smithy.api#documentation": "

The name of the option.

" + "smithy.api#documentation": "

A message describing the error or warning.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/elastic-inference.2017-07-25.json b/codegen/sdk-codegen/aws-models/elastic-inference.2017-07-25.json index af831fdf5e5b..412c42c169ae 100644 --- a/codegen/sdk-codegen/aws-models/elastic-inference.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/elastic-inference.2017-07-25.json @@ -69,17 +69,17 @@ "smithy.api#documentation": "

\n The throughput information of the Elastic Inference Accelerator type.\n

" } }, - "acceleratorTypeName": { - "target": "com.amazonaws.elasticinference#AcceleratorTypeName", - "traits": { - "smithy.api#documentation": "

\n The name of the Elastic Inference Accelerator type.\n

" - } - }, "memoryInfo": { "target": "com.amazonaws.elasticinference#MemoryInfo", "traits": { "smithy.api#documentation": "

\n The memory information of the Elastic Inference Accelerator type.\n

" } + }, + "acceleratorTypeName": { + "target": "com.amazonaws.elasticinference#AcceleratorTypeName", + "traits": { + "smithy.api#documentation": "

\n The name of the Elastic Inference Accelerator type.\n

" + } } }, "traits": { @@ -310,18 +310,18 @@ "com.amazonaws.elasticinference#DescribeAcceleratorsRequest": { "type": "structure", "members": { - "filters": { - "target": "com.amazonaws.elasticinference#FilterList", - "traits": { - "smithy.api#documentation": "

\n One or more filters. Filter names and values are case-sensitive. Valid filter names are:\n accelerator-types: can provide a list of accelerator type names to filter for.\n instance-id: can provide a list of EC2 instance ids to filter for.\n

" - } - }, "maxResults": { "target": "com.amazonaws.elasticinference#MaxResults", "traits": { "smithy.api#documentation": "

\n The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output.\n To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.\n Do not use the NextToken response element directly outside of the AWS CLI.\n

" } }, + "filters": { + "target": "com.amazonaws.elasticinference#FilterList", + "traits": { + "smithy.api#documentation": "

\n One or more filters. Filter names and values are case-sensitive. Valid filter names are:\n accelerator-types: can provide a list of accelerator type names to filter for.\n instance-id: can provide a list of EC2 instance ids to filter for.\n

" + } + }, "nextToken": { "target": "com.amazonaws.elasticinference#NextToken", "traits": { @@ -381,7 +381,7 @@ "sdkId": "Elastic Inference", "arnNamespace": "elastic-inference", "cloudFormationName": "ElasticInference", - "cloudTrailEventSource": "ec2matterhorncfsoothsayerapigatewaylambda.amazon.com" + "cloudTrailEventSource": "elasticinference.amazonaws.com" }, "aws.auth#sigv4": { "name": "elastic-inference" @@ -406,12 +406,6 @@ "smithy.api#documentation": "

\n The availability zone where the Elastic Inference Accelerator is present.\n

" } }, - "acceleratorId": { - "target": "com.amazonaws.elasticinference#AcceleratorId", - "traits": { - "smithy.api#documentation": "

\n The ID of the Elastic Inference Accelerator.\n

" - } - }, "attachedResource": { "target": "com.amazonaws.elasticinference#ResourceARN2", "traits": { @@ -423,6 +417,12 @@ "traits": { "smithy.api#documentation": "

\n The health of the Elastic Inference Accelerator.\n

" } + }, + "acceleratorId": { + "target": "com.amazonaws.elasticinference#AcceleratorId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Elastic Inference Accelerator.\n

" + } } }, "traits": { @@ -840,14 +840,6 @@ "com.amazonaws.elasticinference#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.elasticinference#TagKeyList", - "traits": { - "smithy.api#documentation": "

\n The list of tags to remove from the Elastic Inference Accelerator.\n

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.elasticinference#ResourceARN", "traits": { @@ -855,6 +847,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tagKeys": { + "target": "com.amazonaws.elasticinference#TagKeyList", + "traits": { + "smithy.api#documentation": "

\n The list of tags to remove from the Elastic Inference Accelerator.\n

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json index aeab1437cc6c..3aed8cd57150 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json @@ -45,22 +45,23 @@ "com.amazonaws.elasticloadbalancingv2#Action": { "type": "structure", "members": { - "ForwardConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#ForwardActionConfig", + "Type": { + "target": "com.amazonaws.elasticloadbalancingv2#ActionTypeEnum", "traits": { - "smithy.api#documentation": "

Information for creating an action that distributes requests among one or more target groups.\n For Network Load Balancers, you can specify a single target group.\n Specify only when Type is forward.\n If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group\n using ForwardConfig and it must be the same target group specified in TargetGroupArn.

" + "smithy.api#documentation": "

The type of action.

", + "smithy.api#required": {} } }, - "RedirectConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionConfig", + "AuthenticateCognitoConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConfig", "traits": { - "smithy.api#documentation": "

[Application Load Balancer] Information for creating a redirect action. \n Specify only when Type is redirect.

" + "smithy.api#documentation": "

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. \n Specify only when Type is authenticate-cognito.

" } }, - "FixedResponseConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionConfig", + "RedirectConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionConfig", "traits": { - "smithy.api#documentation": "

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. \n Specify only when Type is fixed-response.

" + "smithy.api#documentation": "

[Application Load Balancer] Information for creating a redirect action. \n Specify only when Type is redirect.

" } }, "TargetGroupArn": { @@ -72,20 +73,13 @@ "Order": { "target": "com.amazonaws.elasticloadbalancingv2#ActionOrder", "traits": { - "smithy.api#documentation": "

The order for the action. This value is required for rules with multiple actions. \n The action with the lowest value for order is performed first. The last action to be\n performed must be one of the following types of actions: a forward, \n fixed-response, or redirect.

" + "smithy.api#documentation": "

The order for the action. This value is required for rules with multiple actions. \n The action with the lowest value for order is performed first.

" } }, - "AuthenticateCognitoConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConfig", - "traits": { - "smithy.api#documentation": "

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. \n Specify only when Type is authenticate-cognito.

" - } - }, - "Type": { - "target": "com.amazonaws.elasticloadbalancingv2#ActionTypeEnum", + "FixedResponseConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionConfig", "traits": { - "smithy.api#documentation": "

The type of action.

", - "smithy.api#required": {} + "smithy.api#documentation": "

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. \n Specify only when Type is fixed-response.

" } }, "AuthenticateOidcConfig": { @@ -93,10 +87,16 @@ "traits": { "smithy.api#documentation": "

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). \n Specify only when Type is authenticate-oidc.

" } + }, + "ForwardConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#ForwardActionConfig", + "traits": { + "smithy.api#documentation": "

Information for creating an action that distributes requests among one or more target groups.\n For Network Load Balancers, you can specify a single target group.\n Specify only when Type is forward.\n If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group\n using ForwardConfig and it must be the same target group specified in TargetGroupArn.

" + } } }, "traits": { - "smithy.api#documentation": "

Information about an action.

" + "smithy.api#documentation": "

Information about an action.

\n

Each rule must include exactly one of the following types of actions: forward, \n fixed-response, or redirect, and it must be the last action to be\n performed.

" } }, "com.amazonaws.elasticloadbalancingv2#ActionOrder": { @@ -168,17 +168,17 @@ "com.amazonaws.elasticloadbalancingv2#AddListenerCertificatesInput": { "type": "structure", "members": { - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", + "smithy.api#documentation": "

The certificate to add. You can specify one certificate per call.\n Set CertificateArn to the certificate ARN but do not set IsDefault.

", "smithy.api#required": {} } }, - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { - "smithy.api#documentation": "

The certificate to add. You can specify one certificate per call.\n Set CertificateArn to the certificate ARN but do not set IsDefault.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } } @@ -218,23 +218,23 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag\n your Application Load Balancers, Network Load Balancers, and your target groups.

\n

Each tag consists of a key and an optional value. If a resource already has a tag with\n the same key, AddTags updates its value.

\n

To list the current tags for your resources, use DescribeTags. To\n remove tags from your resources, use RemoveTags.

" + "smithy.api#documentation": "

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag\n your Application Load Balancers, Network Load Balancers, target groups, listeners, and\n rules.

\n

Each tag consists of a key and an optional value. If a resource already has a tag with\n the same key, AddTags updates its value.

\n

To list the current tags for your resources, use DescribeTags. To\n remove tags from your resources, use RemoveTags.

" } }, "com.amazonaws.elasticloadbalancingv2#AddTagsInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.elasticloadbalancingv2#TagList", + "ResourceArns": { + "target": "com.amazonaws.elasticloadbalancingv2#ResourceArns", "traits": { - "smithy.api#documentation": "

The tags.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } }, - "ResourceArns": { - "target": "com.amazonaws.elasticloadbalancingv2#ResourceArns", + "Tags": { + "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#documentation": "

The tags.

", "smithy.api#required": {} } } @@ -306,10 +306,23 @@ "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConfig": { "type": "structure", "members": { - "AuthenticationRequestExtraParams": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestExtraParams", + "SessionCookieName": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionSessionCookieName", "traits": { - "smithy.api#documentation": "

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

" + "smithy.api#documentation": "

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

" + } + }, + "Scope": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionScope", + "traits": { + "smithy.api#documentation": "

The set of user claims to be requested from the IdP. The default is openid.

\n

To verify which scope values your IdP supports and how to separate multiple values,\n see the documentation for your IdP.

" + } + }, + "UserPoolDomain": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolDomain", + "traits": { + "smithy.api#documentation": "

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

", + "smithy.api#required": {} } }, "UserPoolArn": { @@ -319,11 +332,10 @@ "smithy.api#required": {} } }, - "UserPoolClientId": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolClientId", + "AuthenticationRequestExtraParams": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestExtraParams", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito user pool client.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

" } }, "SessionTimeout": { @@ -332,30 +344,18 @@ "smithy.api#documentation": "

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

" } }, - "Scope": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionScope", + "OnUnauthenticatedRequest": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConditionalBehaviorEnum", "traits": { - "smithy.api#documentation": "

The set of user claims to be requested from the IdP. The default is openid.

\n

To verify which scope values your IdP supports and how to separate multiple values,\n see the documentation for your IdP.

" + "smithy.api#documentation": "

The behavior if the user is not authenticated. The following are possible values:

\n " } }, - "UserPoolDomain": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolDomain", + "UserPoolClientId": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolClientId", "traits": { - "smithy.api#documentation": "

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

", + "smithy.api#documentation": "

The ID of the Amazon Cognito user pool client.

", "smithy.api#required": {} } - }, - "SessionCookieName": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionSessionCookieName", - "traits": { - "smithy.api#documentation": "

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

" - } - }, - "OnUnauthenticatedRequest": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConditionalBehaviorEnum", - "traits": { - "smithy.api#documentation": "

The behavior if the user is not authenticated. The following are possible values:

\n " - } } }, "traits": { @@ -429,12 +429,39 @@ "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConfig": { "type": "structure", "members": { + "AuthorizationEndpoint": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthorizationEndpoint", + "traits": { + "smithy.api#documentation": "

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

", + "smithy.api#required": {} + } + }, + "UserInfoEndpoint": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUserInfoEndpoint", + "traits": { + "smithy.api#documentation": "

The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionClientId", + "traits": { + "smithy.api#documentation": "

The OAuth 2.0 client identifier.

", + "smithy.api#required": {} + } + }, "ClientSecret": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionClientSecret", "traits": { "smithy.api#documentation": "

The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule,\n you can omit this parameter if you set UseExistingClientSecret to true.

" } }, + "UseExistingClientSecret": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUseExistingClientSecret", + "traits": { + "smithy.api#documentation": "

Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule,\n you can omit this parameter or set it to false.

" + } + }, "TokenEndpoint": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionTokenEndpoint", "traits": { @@ -449,11 +476,10 @@ "smithy.api#required": {} } }, - "AuthorizationEndpoint": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthorizationEndpoint", + "Scope": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionScope", "traits": { - "smithy.api#documentation": "

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The set of user claims to be requested from the IdP. The default is openid.

\n

To verify which scope values your IdP supports and how to separate multiple values,\n see the documentation for your IdP.

" } }, "SessionTimeout": { @@ -462,48 +488,22 @@ "smithy.api#documentation": "

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

" } }, - "AuthenticationRequestExtraParams": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestExtraParams", - "traits": { - "smithy.api#documentation": "

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

" - } - }, "OnUnauthenticatedRequest": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConditionalBehaviorEnum", "traits": { "smithy.api#documentation": "

The behavior if the user is not authenticated. The following are possible values:

\n " } }, - "SessionCookieName": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionCookieName", - "traits": { - "smithy.api#documentation": "

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

" - } - }, - "Scope": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionScope", - "traits": { - "smithy.api#documentation": "

The set of user claims to be requested from the IdP. The default is openid.

\n

To verify which scope values your IdP supports and how to separate multiple values,\n see the documentation for your IdP.

" - } - }, - "UserInfoEndpoint": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUserInfoEndpoint", - "traits": { - "smithy.api#documentation": "

The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

", - "smithy.api#required": {} - } - }, - "ClientId": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionClientId", + "AuthenticationRequestExtraParams": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthenticationRequestExtraParams", "traits": { - "smithy.api#documentation": "

The OAuth 2.0 client identifier.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

" } }, - "UseExistingClientSecret": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUseExistingClientSecret", + "SessionCookieName": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionCookieName", "traits": { - "smithy.api#documentation": "

Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule,\n you can omit this parameter or set it to false.

" + "smithy.api#documentation": "

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

" } } }, @@ -541,12 +541,6 @@ "com.amazonaws.elasticloadbalancingv2#AvailabilityZone": { "type": "structure", "members": { - "LoadBalancerAddresses": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddresses", - "traits": { - "smithy.api#documentation": "

[Network Load Balancers] If you need static IP addresses for your load balancer, \n you can specify one Elastic IP address per Availability Zone when you create an \n internal-facing load balancer. For internal load balancers, you can specify a private \n IP address from the IPv4 range of the subnet.

" - } - }, "SubnetId": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetId", "traits": { @@ -558,6 +552,18 @@ "traits": { "smithy.api#documentation": "

The name of the Availability Zone.

" } + }, + "LoadBalancerAddresses": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddresses", + "traits": { + "smithy.api#documentation": "

[Network Load Balancers] If you need static IP addresses for your load balancer, \n you can specify one Elastic IP address per Availability Zone when you create an \n internal-facing load balancer. For internal load balancers, you can specify a private \n IP address from the IPv4 range of the subnet.

" + } + }, + "OutpostId": { + "target": "com.amazonaws.elasticloadbalancingv2#OutpostId", + "traits": { + "smithy.api#documentation": "

[Application Load Balancers on Outposts] The ID of the Outpost.

" + } } }, "traits": { @@ -589,17 +595,17 @@ "com.amazonaws.elasticloadbalancingv2#Certificate": { "type": "structure", "members": { - "IsDefault": { - "target": "com.amazonaws.elasticloadbalancingv2#Default", - "traits": { - "smithy.api#documentation": "

Indicates whether the certificate is the default certificate. Do not set this value \n when specifying a certificate as an input. This value is not included in the output \n when describing a listener, but is included when describing listener certificates.

" - } - }, "CertificateArn": { "target": "com.amazonaws.elasticloadbalancingv2#CertificateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" } + }, + "IsDefault": { + "target": "com.amazonaws.elasticloadbalancingv2#Default", + "traits": { + "smithy.api#documentation": "

Indicates whether the certificate is the default certificate. Do not set this value \n when specifying a certificate as an input. This value is not included in the output \n when describing a listener, but is included when describing listener certificates.

" + } } }, "traits": { @@ -631,17 +637,17 @@ "com.amazonaws.elasticloadbalancingv2#Cipher": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.elasticloadbalancingv2#CipherName", - "traits": { - "smithy.api#documentation": "

The name of the cipher.

" - } - }, "Priority": { "target": "com.amazonaws.elasticloadbalancingv2#CipherPriority", "traits": { "smithy.api#documentation": "

The priority of the cipher.

" } + }, + "Name": { + "target": "com.amazonaws.elasticloadbalancingv2#CipherName", + "traits": { + "smithy.api#documentation": "

The name of the cipher.

" + } } }, "traits": { @@ -720,6 +726,9 @@ { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRegistrationsForTargetIdException" }, + { + "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" + }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetsException" }, @@ -737,6 +746,13 @@ "com.amazonaws.elasticloadbalancingv2#CreateListenerInput": { "type": "structure", "members": { + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", + "traits": { + "smithy.api#documentation": "

The port on which the load balancer is listening.

", + "smithy.api#required": {} + } + }, "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { @@ -744,23 +760,22 @@ "smithy.api#required": {} } }, - "SslPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { - "smithy.api#documentation": "

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are\n supported. The following are the possible values:

\n \n

For more information, see Security Policies in the Application Load Balancers Guide and\n Security Policies in the Network Load Balancers Guide.

" + "smithy.api#documentation": "

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn to the certificate ARN but do not set IsDefault.

\n

To create a certificate list for the listener, use AddListenerCertificates.

" } }, - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", + "Tags": { + "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { - "smithy.api#documentation": "

The port on which the load balancer is listening.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to assign to the listener.

" } }, - "DefaultActions": { - "target": "com.amazonaws.elasticloadbalancingv2#Actions", + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

\n

If the action type is forward, you specify one or more target groups.\n The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer.\n The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

\n

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider \n that is OpenID Connect (OIDC) compliant.

\n

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools\n supported by Amazon Cognito.

\n

[Application Load Balancer] If the action type is redirect, you redirect specified client requests \n from one URL to another.

\n

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests \n and return a custom HTTP response.

", + "smithy.api#documentation": "

The protocol for connections from clients to the load balancer. For Application Load\n Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the\n supported protocols are TCP, TLS, UDP, and TCP_UDP.

", "smithy.api#required": {} } }, @@ -770,17 +785,17 @@ "smithy.api#documentation": "

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.\n You can specify one policy name. The following are the possible values:

\n \n

For more information, see ALPN Policies in the Network Load Balancers Guide.

" } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "DefaultActions": { + "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { - "smithy.api#documentation": "

The protocol for connections from clients to the load balancer. For Application Load\n Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the\n supported protocols are TCP, TLS, UDP, and TCP_UDP.

", + "smithy.api#documentation": "

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

\n

If the action type is forward, you specify one or more target groups.\n The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer.\n The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

\n

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider \n that is OpenID Connect (OIDC) compliant.

\n

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools\n supported by Amazon Cognito.

\n

[Application Load Balancer] If the action type is redirect, you redirect specified client requests \n from one URL to another.

\n

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests \n and return a custom HTTP response.

", "smithy.api#required": {} } }, - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "SslPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { - "smithy.api#documentation": "

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn to the certificate ARN but do not set IsDefault.

\n

To create a certificate list for the listener, use AddListenerCertificates.

" + "smithy.api#documentation": "

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are\n supported. The following are the possible values:

\n \n

For more information, see Security Policies in the Application Load Balancers Guide and\n Security Policies in the Network Load Balancers Guide.

" } } } @@ -852,6 +867,12 @@ "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancerInput": { "type": "structure", "members": { + "Scheme": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", + "traits": { + "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.

\n

The nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.

\n

The default is an Internet-facing load balancer.

" + } + }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { @@ -861,44 +882,44 @@ "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { - "smithy.api#documentation": "

One or more tags to assign to the load balancer.

" + "smithy.api#documentation": "

The tags to assign to the load balancer.

" } }, - "Type": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool", "traits": { - "smithy.api#documentation": "

The type of load balancer. The default is application.

" + "smithy.api#documentation": "

[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP \n pool).

" } }, - "SecurityGroups": { - "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", + "Name": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName", "traits": { - "smithy.api#documentation": "

[Application Load Balancers] The IDs of the security groups for the load balancer.

" + "smithy.api#documentation": "

The name of the load balancer.

\n

This name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, must not begin or end with a\n hyphen, and must not begin with \"internal-\".

", + "smithy.api#required": {} } }, - "Scheme": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", + "SubnetMappings": { + "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.

\n

The nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.

\n

The default is an Internet-facing load balancer.

" + "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones.\n You can specify one Elastic IP address per subnet if you need static IP addresses for\n your internet-facing load balancer. For internal load balancers, you can specify one \n private IP address per subnet from the IPv4 range of the subnet.

" } }, "Subnets": { "target": "com.amazonaws.elasticloadbalancingv2#Subnets", "traits": { - "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.

" + "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.

" } }, - "SubnetMappings": { - "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", + "Type": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", "traits": { - "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones.\n You can specify one Elastic IP address per subnet if you need static IP addresses for\n your internet-facing load balancer. For internal load balancers, you can specify one \n private IP address per subnet from the IPv4 range of the subnet.

" + "smithy.api#documentation": "

The type of load balancer. The default is application.

" } }, - "Name": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName", + "SecurityGroups": { + "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

\n

This name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, must not begin or end with a\n hyphen, and must not begin with \"internal-\".

", - "smithy.api#required": {} + "smithy.api#documentation": "

[Application Load Balancers] The IDs of the security groups for the load balancer.

" } } } @@ -953,6 +974,9 @@ { "target": "com.amazonaws.elasticloadbalancingv2#TooManyRulesException" }, + { + "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" + }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetGroupsException" }, @@ -967,12 +991,19 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a rule for the specified listener. The listener must be associated with an\n Application Load Balancer.

\n

Rules are evaluated in priority order, from the lowest value to the highest value. \n When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, \n the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.

\n

To view your current rules, use DescribeRules. To update a rule, use\n ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.

" + "smithy.api#documentation": "

Creates a rule for the specified listener. The listener must be associated with an\n Application Load Balancer.

\n

Each rule consists of a priority, one or more actions, and one or more conditions.\n Rules are evaluated in priority order, from the lowest value to the highest value. \n When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, \n the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.

\n

To view your current rules, use DescribeRules. To update a rule, use\n ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.

" } }, "com.amazonaws.elasticloadbalancingv2#CreateRuleInput": { "type": "structure", "members": { + "Priority": { + "target": "com.amazonaws.elasticloadbalancingv2#RulePriority", + "traits": { + "smithy.api#documentation": "

The rule priority. A listener can't have multiple rules with the same priority.

", + "smithy.api#required": {} + } + }, "Actions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { @@ -980,24 +1011,23 @@ "smithy.api#required": {} } }, - "Conditions": { - "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { - "smithy.api#documentation": "

The conditions. Each rule can include zero or one of the following conditions:\n http-request-method, host-header, path-pattern,\n and source-ip, and zero or more of the following conditions:\n http-header and query-string.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, - "Priority": { - "target": "com.amazonaws.elasticloadbalancingv2#RulePriority", + "Tags": { + "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { - "smithy.api#documentation": "

The rule priority. A listener can't have multiple rules with the same priority.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to assign to the rule.

" } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "Conditions": { + "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", + "smithy.api#documentation": "

The conditions. \n Each rule can optionally include up to one of each of the following conditions:\n http-request-method, host-header, path-pattern, and source-ip. \n Each rule can also optionally include one or more of each of the following conditions:\n http-header and query-string.

", "smithy.api#required": {} } } @@ -1029,6 +1059,9 @@ { "target": "com.amazonaws.elasticloadbalancingv2#InvalidConfigurationRequestException" }, + { + "target": "com.amazonaws.elasticloadbalancingv2#TooManyTagsException" + }, { "target": "com.amazonaws.elasticloadbalancingv2#TooManyTargetGroupsException" } @@ -1040,22 +1073,23 @@ "com.amazonaws.elasticloadbalancingv2#CreateTargetGroupInput": { "type": "structure", "members": { - "Matcher": { - "target": "com.amazonaws.elasticloadbalancingv2#Matcher", + "HealthyThresholdCount": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { - "smithy.api#documentation": "

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.

" + "smithy.api#documentation": "

The number of consecutive health checks successes required before considering an unhealthy target healthy. \n For target groups with a protocol of HTTP or HTTPS, the default is 5. \n For target groups with a protocol of TCP or TLS, the default is 3.\n If the target type is lambda, the default is 5.

" } }, - "HealthCheckEnabled": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", + "HealthCheckProtocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "

Indicates whether health checks are enabled. If the target type is lambda,\n health checks are disabled by default but can be enabled. If the target type is instance \n or ip, health checks are always enabled and cannot be disabled.

" + "smithy.api#documentation": "

The protocol the load balancer uses when performing health checks on targets.\n For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.\n The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP.\n The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

" } }, - "TargetType": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", + "Name": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", "traits": { - "smithy.api#documentation": "

The type of target that you must specify when registering targets with this target group.\n You can't specify targets for a target group using more than one target type.

\n " + "smithy.api#documentation": "

The name of the target group.

\n

This name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, and must not begin or end with a\n hyphen.

", + "smithy.api#required": {} } }, "UnhealthyThresholdCount": { @@ -1064,22 +1098,16 @@ "smithy.api#documentation": "

The number of consecutive health check failures required before considering a target unhealthy. \n For target groups with a protocol of HTTP or HTTPS, the default is 2. \n For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.\n If the target type is lambda, the default is 2.

" } }, - "HealthCheckIntervalSeconds": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", - "traits": { - "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual target. \n For HTTP and HTTPS health checks, the range is 5–300 seconds. \n For TCP health checks, the supported values are 10 and 30 seconds. \n If the target type is instance or ip, the default is 30 seconds. \n If the target type is lambda, the default is 35 seconds.

" - } - }, - "HealthCheckPort": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", + "HealthCheckEnabled": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { - "smithy.api#documentation": "

The port the load balancer uses when performing health checks on targets. The default\n is traffic-port, which is the port on which each target receives traffic from the\n load balancer.

" + "smithy.api#documentation": "

Indicates whether health checks are enabled. If the target type is lambda,\n health checks are disabled by default but can be enabled. If the target type is instance \n or ip, health checks are always enabled and cannot be disabled.

" } }, - "HealthCheckProtocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "HealthCheckTimeoutSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { - "smithy.api#documentation": "

The protocol the load balancer uses when performing health checks on targets.\n For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.\n The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP.\n The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

" + "smithy.api#documentation": "

The amount of time, in seconds, during which no response from a target means a failed health check. \n For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. \n For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks \n and 10 seconds for TCP and HTTPS health checks.\n If the target type is lambda, the default is 30 seconds.

" } }, "HealthCheckPath": { @@ -1088,41 +1116,52 @@ "smithy.api#documentation": "

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for\n health checks. The default is /.

" } }, - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", + "Matcher": { + "target": "com.amazonaws.elasticloadbalancingv2#Matcher", "traits": { - "smithy.api#documentation": "

The port on which the targets receive traffic. This port is used unless you specify a\n port override when registering the target. If the target is a Lambda function, this \n parameter does not apply.

" + "smithy.api#documentation": "

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.

" } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "VpcId": { + "target": "com.amazonaws.elasticloadbalancingv2#VpcId", "traits": { - "smithy.api#documentation": "

The protocol to use for routing traffic to the targets. For Application Load Balancers,\n the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols\n are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group.\n If the target is a Lambda function, this parameter does not apply.

" + "smithy.api#documentation": "

The identifier of the virtual private cloud (VPC). If the target is a Lambda function, \n this parameter does not apply. Otherwise, this parameter is required.

" } }, - "HealthCheckTimeoutSeconds": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", + "HealthCheckPort": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, during which no response from a target means a failed health check. \n For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. \n For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks \n and 10 seconds for TCP and HTTPS health checks.\n If the target type is lambda, the default is 30 seconds.

" + "smithy.api#documentation": "

The port the load balancer uses when performing health checks on targets. The default\n is traffic-port, which is the port on which each target receives traffic from the\n load balancer.

" } }, - "Name": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "

The name of the target group.

\n

This name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, and must not begin or end with a\n hyphen.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The port on which the targets receive traffic. This port is used unless you specify a\n port override when registering the target. If the target is a Lambda function, this \n parameter does not apply.

" } }, - "HealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", + "Tags": { + "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { - "smithy.api#documentation": "

The number of consecutive health checks successes required before considering an unhealthy target healthy. \n For target groups with a protocol of HTTP or HTTPS, the default is 5. \n For target groups with a protocol of TCP or TLS, the default is 3.\n If the target type is lambda, the default is 5.

" + "smithy.api#documentation": "

The tags to assign to the target group.

" } }, - "VpcId": { - "target": "com.amazonaws.elasticloadbalancingv2#VpcId", + "HealthCheckIntervalSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", "traits": { - "smithy.api#documentation": "

The identifier of the virtual private cloud (VPC). If the target is a Lambda function, \n this parameter does not apply. Otherwise, this parameter is required.

" + "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual target. \n For HTTP and HTTPS health checks, the range is 5–300 seconds. \n For TCP health checks, the supported values are 10 and 30 seconds. \n If the target type is instance or ip, the default is 30 seconds. \n If the target type is lambda, the default is 35 seconds.

" + } + }, + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "traits": { + "smithy.api#documentation": "

The protocol to use for routing traffic to the targets. For Application Load Balancers,\n the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols\n are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group.\n If the target is a Lambda function, this parameter does not apply.

" + } + }, + "TargetType": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", + "traits": { + "smithy.api#documentation": "

The type of target that you must specify when registering targets with this target group.\n You can't specify targets for a target group using more than one target type.

\n " } } } @@ -1138,9 +1177,19 @@ } } }, - "com.amazonaws.elasticloadbalancingv2#CreatedTime": { - "type": "timestamp" - }, + "com.amazonaws.elasticloadbalancingv2#CreatedTime": { + "type": "timestamp" + }, + "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(ipv4pool-coip-)[a-zA-Z0-9]+$" + } + }, "com.amazonaws.elasticloadbalancingv2#DNSName": { "type": "string" }, @@ -1239,7 +1288,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified rule.

" + "smithy.api#documentation": "

Deletes the specified rule.

\n

You can't delete the default rule.

" } }, "com.amazonaws.elasticloadbalancingv2#DeleteRuleInput": { @@ -1314,17 +1363,17 @@ "com.amazonaws.elasticloadbalancingv2#DeregisterTargetsInput": { "type": "structure", "members": { - "Targets": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", + "TargetGroupArn": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { - "smithy.api#documentation": "

The targets. If you specified a port override when you registered a target, you must\n specify both the target ID and the port when you deregister it.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } }, - "TargetGroupArn": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", + "Targets": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", + "smithy.api#documentation": "

The targets. If you specified a port override when you registered a target, you must\n specify both the target ID and the port when you deregister it.

", "smithy.api#required": {} } } @@ -1349,17 +1398,17 @@ "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimitsInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" - } - }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } + }, + "Marker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" + } } } }, @@ -1400,10 +1449,11 @@ "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificatesInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { - "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the listener.

", + "smithy.api#required": {} } }, "PageSize": { @@ -1412,11 +1462,10 @@ "smithy.api#documentation": "

The maximum number of results to return with this call.

" } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "Marker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the listener.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } } } @@ -1475,12 +1524,6 @@ "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" } }, - "ListenerArns": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArns", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the listeners.

" - } - }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { @@ -1492,6 +1535,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } + }, + "ListenerArns": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the listeners.

" + } } } }, @@ -1577,10 +1626,10 @@ "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "Names": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNames", "traits": { - "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" + "smithy.api#documentation": "

The names of the load balancers.

" } }, "PageSize": { @@ -1589,34 +1638,34 @@ "smithy.api#documentation": "

The maximum number of results to return with this call.

" } }, - "Names": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNames", - "traits": { - "smithy.api#documentation": "

The names of the load balancers.

" - } - }, "LoadBalancerArns": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", "traits": { "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load\n balancers in a single call.

" } + }, + "Marker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" + } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersOutput": { "type": "structure", "members": { - "LoadBalancers": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancers", - "traits": { - "smithy.api#documentation": "

Information about the load balancers.

" - } - }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.

" } + }, + "LoadBalancers": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancers", + "traits": { + "smithy.api#documentation": "

Information about the load balancers.

" + } } } }, @@ -1658,34 +1707,34 @@ "smithy.api#documentation": "

The maximum number of results to return with this call.

" } }, - "RuleArns": { - "target": "com.amazonaws.elasticloadbalancingv2#RuleArns", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the rules.

" - } - }, "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

" } + }, + "RuleArns": { + "target": "com.amazonaws.elasticloadbalancingv2#RuleArns", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the rules.

" + } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeRulesOutput": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.elasticloadbalancingv2#Rules", - "traits": { - "smithy.api#documentation": "

Information about the rules.

" - } - }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.

" } + }, + "Rules": { + "target": "com.amazonaws.elasticloadbalancingv2#Rules", + "traits": { + "smithy.api#documentation": "

Information about the rules.

" + } } } }, @@ -1732,17 +1781,17 @@ "com.amazonaws.elasticloadbalancingv2#DescribeSSLPoliciesOutput": { "type": "structure", "members": { - "SslPolicies": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicies", - "traits": { - "smithy.api#documentation": "

Information about the security policies.

" - } - }, "NextMarker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.

" } + }, + "SslPolicies": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicies", + "traits": { + "smithy.api#documentation": "

Information about the security policies.

" + } } } }, @@ -1769,7 +1818,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the tags for the specified resources. You can describe the tags for one or\n more Application Load Balancers, Network Load Balancers, and target groups.

" + "smithy.api#documentation": "

Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for \n one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.

" } }, "com.amazonaws.elasticloadbalancingv2#DescribeTagsInput": { @@ -1863,16 +1912,10 @@ "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupsInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" - } - }, - "Names": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNames", + "TargetGroupArns": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArns", "traits": { - "smithy.api#documentation": "

The names of the target groups.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups.

" } }, "LoadBalancerArn": { @@ -1881,16 +1924,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } }, + "Marker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous\n call.)

" + } + }, "PageSize": { "target": "com.amazonaws.elasticloadbalancingv2#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return with this call.

" } }, - "TargetGroupArns": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArns", + "Names": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNames", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups.

" + "smithy.api#documentation": "

The names of the target groups.

" } } } @@ -1898,17 +1947,17 @@ "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupsOutput": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.

" - } - }, "TargetGroups": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroups", "traits": { "smithy.api#documentation": "

Information about the target groups.

" } + }, + "NextMarker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.

" + } } } }, @@ -1938,18 +1987,18 @@ "com.amazonaws.elasticloadbalancingv2#DescribeTargetHealthInput": { "type": "structure", "members": { - "Targets": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", - "traits": { - "smithy.api#documentation": "

The targets.

" - } - }, "TargetGroupArn": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } + }, + "Targets": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", + "traits": { + "smithy.api#documentation": "

The targets.

" + } } } }, @@ -2131,7 +2180,7 @@ "sdkId": "Elastic Load Balancing v2", "arnNamespace": "elasticloadbalancing", "cloudFormationName": "ElasticLoadBalancingV2", - "cloudTrailEventSource": "version_2015_12_01.elb.amazon.com" + "cloudTrailEventSource": "elasticloadbalancingv2.amazonaws.com" }, "aws.auth#sigv4": { "name": "elasticloadbalancing" @@ -2150,11 +2199,10 @@ "com.amazonaws.elasticloadbalancingv2#FixedResponseActionConfig": { "type": "structure", "members": { - "StatusCode": { - "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionStatusCode", + "ContentType": { + "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionContentType", "traits": { - "smithy.api#documentation": "

The HTTP response code (2XX, 4XX, or 5XX).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The content type.

\n

Valid Values: text/plain | text/css | text/html | application/javascript | application/json

" } }, "MessageBody": { @@ -2163,10 +2211,11 @@ "smithy.api#documentation": "

The message.

" } }, - "ContentType": { - "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionContentType", + "StatusCode": { + "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionStatusCode", "traits": { - "smithy.api#documentation": "

The content type.

\n

Valid Values: text/plain | text/css | text/html | application/javascript | application/json

" + "smithy.api#documentation": "

The HTTP response code (2XX, 4XX, or 5XX).

", + "smithy.api#required": {} } } }, @@ -2201,17 +2250,17 @@ "com.amazonaws.elasticloadbalancingv2#ForwardActionConfig": { "type": "structure", "members": { - "TargetGroupStickinessConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessConfig", - "traits": { - "smithy.api#documentation": "

The target group stickiness for the rule.

" - } - }, "TargetGroups": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupList", "traits": { "smithy.api#documentation": "

One or more target groups. For Network Load Balancers, you can specify a single target group.

" } + }, + "TargetGroupStickinessConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupStickinessConfig", + "traits": { + "smithy.api#documentation": "

The target group stickiness for the rule.

" + } } }, "traits": { @@ -2439,17 +2488,17 @@ "com.amazonaws.elasticloadbalancingv2#Limit": { "type": "structure", "members": { - "Max": { - "target": "com.amazonaws.elasticloadbalancingv2#Max", - "traits": { - "smithy.api#documentation": "

The maximum value of the limit.

" - } - }, "Name": { "target": "com.amazonaws.elasticloadbalancingv2#Name", "traits": { "smithy.api#documentation": "

The name of the limit. The possible values are:

\n " } + }, + "Max": { + "target": "com.amazonaws.elasticloadbalancingv2#Max", + "traits": { + "smithy.api#documentation": "

The maximum value of the limit.

" + } } }, "traits": { @@ -2471,16 +2520,10 @@ "com.amazonaws.elasticloadbalancingv2#Listener": { "type": "structure", "members": { - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", - "traits": { - "smithy.api#documentation": "

[HTTPS or TLS listener] The default certificate for the listener.

" - } - }, - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", + "SslPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { - "smithy.api#documentation": "

The port on which the load balancer is listening.

" + "smithy.api#documentation": "

[HTTPS or TLS listener] The security policy that defines which protocols and ciphers \n are supported.

" } }, "Protocol": { @@ -2489,22 +2532,22 @@ "smithy.api#documentation": "

The protocol for connections from clients to the load balancer.

" } }, - "SslPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", - "traits": { - "smithy.api#documentation": "

[HTTPS or TLS listener] The security policy that defines which protocols and ciphers \n are supported.

" - } - }, "DefaultActions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#documentation": "

The default actions for the listener.

" } }, - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

" + } + }, + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "traits": { + "smithy.api#documentation": "

[HTTPS or TLS listener] The default certificate for the listener.

" } }, "AlpnPolicy": { @@ -2513,10 +2556,16 @@ "smithy.api#documentation": "

[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

" } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" + } + }, + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", + "traits": { + "smithy.api#documentation": "

The port on which the load balancer is listening.

" } } }, @@ -2555,6 +2604,24 @@ "com.amazonaws.elasticloadbalancingv2#LoadBalancer": { "type": "structure", "members": { + "Type": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", + "traits": { + "smithy.api#documentation": "

The type of load balancer.

" + } + }, + "VpcId": { + "target": "com.amazonaws.elasticloadbalancingv2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC for the load balancer.

" + } + }, + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" + } + }, "State": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerState", "traits": { @@ -2573,22 +2640,16 @@ "smithy.api#documentation": "

The name of the load balancer.

" } }, - "DNSName": { - "target": "com.amazonaws.elasticloadbalancingv2#DNSName", - "traits": { - "smithy.api#documentation": "

The public DNS name of the load balancer.

" - } - }, - "Scheme": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", + "CustomerOwnedIpv4Pool": { + "target": "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool", "traits": { - "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.

\n

The nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.

" + "smithy.api#documentation": "

[Application Load Balancers on Outposts] The ID of the customer-owned address pool.

" } }, - "CreatedTime": { - "target": "com.amazonaws.elasticloadbalancingv2#CreatedTime", + "AvailabilityZones": { + "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZones", "traits": { - "smithy.api#documentation": "

The date and time the load balancer was created.

" + "smithy.api#documentation": "

The subnets for the load balancer.

" } }, "SecurityGroups": { @@ -2597,34 +2658,28 @@ "smithy.api#documentation": "

The IDs of the security groups for the load balancer.

" } }, - "IpAddressType": { - "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", - "traits": { - "smithy.api#documentation": "

The type of IP addresses used by the subnets for your load balancer. The possible\n values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and\n IPv6 addresses).

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZones", + "CreatedTime": { + "target": "com.amazonaws.elasticloadbalancingv2#CreatedTime", "traits": { - "smithy.api#documentation": "

The Availability Zones for the load balancer.

" + "smithy.api#documentation": "

The date and time the load balancer was created.

" } }, - "Type": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", + "Scheme": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", "traits": { - "smithy.api#documentation": "

The type of load balancer.

" + "smithy.api#documentation": "

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.

\n

The nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.

" } }, - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "IpAddressType": { + "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" + "smithy.api#documentation": "

The type of IP addresses used by the subnets for your load balancer. The possible\n values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and\n IPv6 addresses).

" } }, - "VpcId": { - "target": "com.amazonaws.elasticloadbalancingv2#VpcId", + "DNSName": { + "target": "com.amazonaws.elasticloadbalancingv2#DNSName", "traits": { - "smithy.api#documentation": "

The ID of the VPC for the load balancer.

" + "smithy.api#documentation": "

The public DNS name of the load balancer.

" } } }, @@ -2635,6 +2690,12 @@ "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddress": { "type": "structure", "members": { + "PrivateIPv4Address": { + "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", + "traits": { + "smithy.api#documentation": "

[Network Load Balancers] The private IPv4 address for an internal load balancer.

" + } + }, "IpAddress": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddress", "traits": { @@ -2646,12 +2707,6 @@ "traits": { "smithy.api#documentation": "

[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.

" } - }, - "PrivateIPv4Address": { - "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", - "traits": { - "smithy.api#documentation": "

[Network Load Balancers] The private IPv4 address for an internal load balancer.

" - } } }, "traits": { @@ -2676,17 +2731,17 @@ "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttribute": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey", - "traits": { - "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by both Application Load Balancers and Network Load Balancers:

\n \n

The following attributes are supported by only Application Load Balancers:

\n \n

The following attributes are supported by only Network Load Balancers:

\n " - } - }, "Value": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeValue", "traits": { "smithy.api#documentation": "

The value of the attribute.

" } + }, + "Key": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by both Application Load Balancers and Network Load Balancers:

\n \n

The following attributes are supported by only Application Load Balancers:

\n \n

The following attributes are supported by only Network Load Balancers:

\n " + } } }, "traits": { @@ -2914,22 +2969,10 @@ "com.amazonaws.elasticloadbalancingv2#ModifyListenerInput": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", - "traits": { - "smithy.api#documentation": "

The port for connections from clients to the load balancer.

" - } - }, - "DefaultActions": { - "target": "com.amazonaws.elasticloadbalancingv2#Actions", - "traits": { - "smithy.api#documentation": "

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

\n

If the action type is forward, you specify one or more target groups.\n The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. \n The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

\n

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider \n that is OpenID Connect (OIDC) compliant.

\n

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools\n supported by Amazon Cognito.

\n

[Application Load Balancer] If the action type is redirect, you redirect specified client requests \n from one URL to another.

\n

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests \n and return a custom HTTP response.

" - } - }, - "SslPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", + "AlpnPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", "traits": { - "smithy.api#documentation": "

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers \n are supported. The following are the possible values:

\n \n

For more information, see Security Policies in the Application Load Balancers Guide and\n Security Policies in the Network Load Balancers Guide.

" + "smithy.api#documentation": "

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.\n You can specify one policy name. The following are the possible values:

\n \n

For more information, see ALPN Policies in the Network Load Balancers Guide.

" } }, "Protocol": { @@ -2938,10 +2981,10 @@ "smithy.api#documentation": "

The protocol for connections from clients to the load balancer. Application Load\n Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the\n TCP, TLS, UDP, and TCP_UDP protocols.

" } }, - "AlpnPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { - "smithy.api#documentation": "

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.\n You can specify one policy name. The following are the possible values:

\n \n

For more information, see ALPN Policies in the Network Load Balancers Guide.

" + "smithy.api#documentation": "

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn to the certificate ARN but do not set IsDefault.

\n

To create a certificate list, use AddListenerCertificates.

" } }, "ListenerArn": { @@ -2951,10 +2994,22 @@ "smithy.api#required": {} } }, - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn to the certificate ARN but do not set IsDefault.

\n

To create a certificate list, use AddListenerCertificates.

" + "smithy.api#documentation": "

The port for connections from clients to the load balancer.

" + } + }, + "DefaultActions": { + "target": "com.amazonaws.elasticloadbalancingv2#Actions", + "traits": { + "smithy.api#documentation": "

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

\n

If the action type is forward, you specify one or more target groups.\n The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. \n The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

\n

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider \n that is OpenID Connect (OIDC) compliant.

\n

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools\n supported by Amazon Cognito.

\n

[Application Load Balancer] If the action type is redirect, you redirect specified client requests \n from one URL to another.

\n

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests \n and return a custom HTTP response.

" + } + }, + "SslPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", + "traits": { + "smithy.api#documentation": "

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers \n are supported. The following are the possible values:

\n \n

For more information, see Security Policies in the Application Load Balancers Guide and\n Security Policies in the Network Load Balancers Guide.

" } } } @@ -2993,17 +3048,17 @@ "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributesInput": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributes", + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { - "smithy.api#documentation": "

The load balancer attributes.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } }, - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "Attributes": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributes", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", + "smithy.api#documentation": "

The load balancer attributes.

", "smithy.api#required": {} } } @@ -3070,13 +3125,6 @@ "com.amazonaws.elasticloadbalancingv2#ModifyRuleInput": { "type": "structure", "members": { - "RuleArn": { - "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", - "smithy.api#required": {} - } - }, "Conditions": { "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", "traits": { @@ -3088,6 +3136,13 @@ "traits": { "smithy.api#documentation": "

The actions. Each rule must include exactly one of the following types of actions: \n forward, fixed-response, or redirect, and it must be the\n last action to be performed.

\n

If the action type is forward, you specify one or more target groups.\n The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer.\n The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

\n

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider \n that is OpenID Connect (OIDC) compliant.

\n

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools\n supported by Amazon Cognito.

\n

[Application Load Balancer] If the action type is redirect, you redirect specified client requests \n from one URL to another.

\n

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests \n and return a custom HTTP response.

" } + }, + "RuleArn": { + "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", + "smithy.api#required": {} + } } } }, @@ -3145,17 +3200,17 @@ "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributesInput": { "type": "structure", "members": { - "TargetGroupArn": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", + "Attributes": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", + "smithy.api#documentation": "

The attributes.

", "smithy.api#required": {} } }, - "Attributes": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes", + "TargetGroupArn": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { - "smithy.api#documentation": "

The attributes.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", "smithy.api#required": {} } } @@ -3175,16 +3230,11 @@ "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupInput": { "type": "structure", "members": { - "UnhealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", - "traits": { - "smithy.api#documentation": "

The number of consecutive health check failures required before considering the target\n unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold\n count.

" - } - }, - "HealthCheckTimeoutSeconds": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", + "TargetGroupArn": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { - "smithy.api#documentation": "

[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response\n means a failed health check.

\n

With Network Load Balancers, you can't modify this setting.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", + "smithy.api#required": {} } }, "HealthCheckIntervalSeconds": { @@ -3193,16 +3243,22 @@ "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual\n target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load\n Balancers, the supported values are 10 or 30 seconds.

\n

With Network Load Balancers, you can't modify this setting.

" } }, - "HealthCheckEnabled": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", + "HealthCheckPort": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { - "smithy.api#documentation": "

Indicates whether health checks are enabled.

" + "smithy.api#documentation": "

The port the load balancer uses when performing health checks on targets.

" } }, - "Matcher": { - "target": "com.amazonaws.elasticloadbalancingv2#Matcher", + "HealthCheckProtocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "traits": { + "smithy.api#documentation": "

The protocol the load balancer uses when performing health checks on targets. \n The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP.\n The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

\n

With Network Load Balancers, you can't modify this setting.

" + } + }, + "HealthCheckTimeoutSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { - "smithy.api#documentation": "

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful\n response from a target.

\n

With Network Load Balancers, you can't modify this setting.

" + "smithy.api#documentation": "

[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response\n means a failed health check.

\n

With Network Load Balancers, you can't modify this setting.

" } }, "HealthyThresholdCount": { @@ -3217,23 +3273,22 @@ "smithy.api#documentation": "

[HTTP/HTTPS health checks] The ping path that is the destination for the health check\n request.

" } }, - "TargetGroupArn": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", + "HealthCheckEnabled": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates whether health checks are enabled.

" } }, - "HealthCheckProtocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "UnhealthyThresholdCount": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { - "smithy.api#documentation": "

The protocol the load balancer uses when performing health checks on targets. \n The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP.\n The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

\n

With Network Load Balancers, you can't modify this setting.

" + "smithy.api#documentation": "

The number of consecutive health check failures required before considering the target\n unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold\n count.

" } }, - "HealthCheckPort": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", + "Matcher": { + "target": "com.amazonaws.elasticloadbalancingv2#Matcher", "traits": { - "smithy.api#documentation": "

The port the load balancer uses when performing health checks on targets.

" + "smithy.api#documentation": "

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful\n response from a target. The possible values are from 200 to 499. You can specify multiple\n values (for example, \"200,202\") or a range of values (for example, \"200-299\"). The default\n is 200.

\n

With Network Load Balancers, you can't modify this setting.

" } } } @@ -3265,6 +3320,9 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.elasticloadbalancingv2#OutpostId": { + "type": "string" + }, "com.amazonaws.elasticloadbalancingv2#PageSize": { "type": "integer", "traits": { @@ -3366,16 +3424,16 @@ "com.amazonaws.elasticloadbalancingv2#QueryStringKeyValuePair": { "type": "structure", "members": { - "Key": { + "Value": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { - "smithy.api#documentation": "

The key. You can omit the key.

" + "smithy.api#documentation": "

The value.

" } }, - "Value": { + "Key": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { - "smithy.api#documentation": "

The value.

" + "smithy.api#documentation": "

The key. You can omit the key.

" } } }, @@ -3392,12 +3450,6 @@ "com.amazonaws.elasticloadbalancingv2#RedirectActionConfig": { "type": "structure", "members": { - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionProtocol", - "traits": { - "smithy.api#documentation": "

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP,\n HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

" - } - }, "StatusCode": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionStatusCodeEnum", "traits": { @@ -3417,16 +3469,22 @@ "smithy.api#documentation": "

The port. You can specify a value from 1 to 65535 or #{port}.

" } }, + "Path": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionPath", + "traits": { + "smithy.api#documentation": "

The absolute path, starting with the leading \"/\". This component is not percent-encoded.\n The path can contain #{host}, #{path}, and #{port}.

" + } + }, "Host": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionHost", "traits": { "smithy.api#documentation": "

The hostname. This component is not percent-encoded. The hostname can contain #{host}.

" } }, - "Path": { - "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionPath", + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionProtocol", "traits": { - "smithy.api#documentation": "

The absolute path, starting with the leading \"/\". This component is not percent-encoded.\n The path can contain #{host}, #{path}, and #{port}.

" + "smithy.api#documentation": "

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP,\n HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

" } } }, @@ -3557,17 +3615,17 @@ "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificatesInput": { "type": "structure", "members": { - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { - "smithy.api#documentation": "

The certificate to remove. You can specify one certificate per call.\n Set CertificateArn to the certificate ARN but do not set IsDefault.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", + "smithy.api#documentation": "

The certificate to remove. You can specify one certificate per call.\n Set CertificateArn to the certificate ARN but do not set IsDefault.

", "smithy.api#required": {} } } @@ -3603,7 +3661,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified Elastic Load Balancing\n resource.

\n

To list the current tags for your resources, use DescribeTags.

" + "smithy.api#documentation": "

Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags \n for one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.

\n

To list the current tags for your resources, use DescribeTags.

" } }, "com.amazonaws.elasticloadbalancingv2#RemoveTagsInput": { @@ -3654,16 +3712,22 @@ "com.amazonaws.elasticloadbalancingv2#Rule": { "type": "structure", "members": { + "RuleArn": { + "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" + } + }, "IsDefault": { "target": "com.amazonaws.elasticloadbalancingv2#IsDefault", "traits": { "smithy.api#documentation": "

Indicates whether this is the default rule.

" } }, - "RuleArn": { - "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", + "Conditions": { + "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" + "smithy.api#documentation": "

The conditions. Each rule can include zero or one of the following conditions:\n http-request-method, host-header, path-pattern,\n and source-ip, and zero or more of the following conditions:\n http-header and query-string.

" } }, "Priority": { @@ -3677,12 +3741,6 @@ "traits": { "smithy.api#documentation": "

The actions. Each rule must include exactly one of the following types of actions: forward, \n redirect, or fixed-response, and it must be the last action to be performed.

" } - }, - "Conditions": { - "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", - "traits": { - "smithy.api#documentation": "

The conditions. Each rule can include zero or one of the following conditions:\n http-request-method, host-header, path-pattern,\n and source-ip, and zero or more of the following conditions:\n http-header and query-string.

" - } } }, "traits": { @@ -3701,57 +3759,57 @@ "com.amazonaws.elasticloadbalancingv2#RuleCondition": { "type": "structure", "members": { - "HttpHeaderConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#HttpHeaderConditionConfig", + "HostHeaderConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#HostHeaderConditionConfig", "traits": { - "smithy.api#documentation": "

Information for an HTTP header condition.\n Specify only when Field is http-header.

" + "smithy.api#documentation": "

Information for a host header condition.\n Specify only when Field is host-header.

" } }, - "HttpRequestMethodConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#HttpRequestMethodConditionConfig", + "PathPatternConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#PathPatternConditionConfig", "traits": { - "smithy.api#documentation": "

Information for an HTTP method condition.\n Specify only when Field is http-request-method.

" + "smithy.api#documentation": "

Information for a path pattern condition.\n Specify only when Field is path-pattern.

" } }, - "Values": { - "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", + "Field": { + "target": "com.amazonaws.elasticloadbalancingv2#ConditionFieldName", "traits": { - "smithy.api#documentation": "

The condition value. You can use Values if the rule contains only \n host-header and path-pattern conditions. Otherwise, you \n can use HostHeaderConfig for host-header conditions and \n PathPatternConfig for path-pattern conditions.

\n

If Field is host-header, you can specify a single host name \n (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in\n length, and can contain any of the following characters.

\n \n

If Field is path-pattern, you can specify a single path pattern\n (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in\n length, and can contain any of the following characters.

\n " + "smithy.api#documentation": "

The field in the HTTP request. The following are the possible values:

\n " } }, - "SourceIpConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#SourceIpConditionConfig", + "HttpRequestMethodConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#HttpRequestMethodConditionConfig", "traits": { - "smithy.api#documentation": "

Information for a source IP condition.\n Specify only when Field is source-ip.

" + "smithy.api#documentation": "

Information for an HTTP method condition.\n Specify only when Field is http-request-method.

" } }, - "QueryStringConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#QueryStringConditionConfig", + "SourceIpConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#SourceIpConditionConfig", "traits": { - "smithy.api#documentation": "

Information for a query string condition.\n Specify only when Field is query-string.

" + "smithy.api#documentation": "

Information for a source IP condition.\n Specify only when Field is source-ip.

" } }, - "PathPatternConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#PathPatternConditionConfig", + "HttpHeaderConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#HttpHeaderConditionConfig", "traits": { - "smithy.api#documentation": "

Information for a path pattern condition.\n Specify only when Field is path-pattern.

" + "smithy.api#documentation": "

Information for an HTTP header condition.\n Specify only when Field is http-header.

" } }, - "Field": { - "target": "com.amazonaws.elasticloadbalancingv2#ConditionFieldName", + "QueryStringConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#QueryStringConditionConfig", "traits": { - "smithy.api#documentation": "

The field in the HTTP request. The following are the possible values:

\n " + "smithy.api#documentation": "

Information for a query string condition.\n Specify only when Field is query-string.

" } }, - "HostHeaderConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#HostHeaderConditionConfig", + "Values": { + "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { - "smithy.api#documentation": "

Information for a host header condition.\n Specify only when Field is host-header.

" + "smithy.api#documentation": "

The condition value. \n Specify only when Field is host-header or path-pattern. \n Alternatively, to specify multiple host names or multiple path patterns, \n use HostHeaderConfig or PathPatternConfig.

\n

If Field is host-header and you are not using HostHeaderConfig, \n you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be \n up to 128 characters in length, and can contain any of the following characters.

\n \n

If Field is path-pattern and you are not using PathPatternConfig, \n you can specify a single path pattern (for example, /img/*) in Values. A path pattern is \n case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

\n " } } }, "traits": { - "smithy.api#documentation": "

Information about a condition for a rule.

" + "smithy.api#documentation": "

Information about a condition for a rule.

\n

Each rule can optionally include up to one of each of the following conditions:\n http-request-method, host-header, path-pattern, and source-ip. \n Each rule can also optionally include one or more of each of the following conditions:\n http-header and query-string.

" } }, "com.amazonaws.elasticloadbalancingv2#RuleConditionList": { @@ -3863,17 +3921,17 @@ "com.amazonaws.elasticloadbalancingv2#SetIpAddressTypeInput": { "type": "structure", "members": { - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "IpAddressType": { + "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", + "smithy.api#documentation": "

The IP address type. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use\n ipv4. Network Load Balancers must use ipv4.

", "smithy.api#required": {} } }, - "IpAddressType": { - "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { - "smithy.api#documentation": "

The IP address type. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use\n ipv4. Network Load Balancers must use ipv4.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", "smithy.api#required": {} } } @@ -4024,11 +4082,10 @@ "com.amazonaws.elasticloadbalancingv2#SetSubnetsInput": { "type": "structure", "members": { - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "SubnetMappings": { + "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must \n specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability Zones.\n You cannot specify Elastic IP addresses for your subnets.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. If you \n need static IP addresses for your internet-facing load balancer, you can specify one Elastic IP \n address per subnet. For internal load balancers, you can specify one private IP address per \n subnet from the IPv4 range of the subnet.

" } }, "Subnets": { @@ -4037,10 +4094,11 @@ "smithy.api#documentation": "

The IDs of the public subnets. You must specify subnets from at least two Availability Zones.\n You can specify only one subnet per Availability Zone. You must specify either subnets or\n subnet mappings.

" } }, - "SubnetMappings": { - "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { - "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must \n specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability Zones.\n You cannot specify Elastic IP addresses for your subnets.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. If you \n need static IP addresses for your internet-facing load balancer, you can specify one Elastic IP \n address per subnet. For internal load balancers, you can specify one private IP address per \n subnet from the IPv4 range of the subnet.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

", + "smithy.api#required": {} } } } @@ -4051,7 +4109,7 @@ "AvailabilityZones": { "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZones", "traits": { - "smithy.api#documentation": "

Information about the subnet and Availability Zone.

" + "smithy.api#documentation": "

Information about the subnets.

" } } } @@ -4079,10 +4137,10 @@ "com.amazonaws.elasticloadbalancingv2#SslPolicy": { "type": "structure", "members": { - "Ciphers": { - "target": "com.amazonaws.elasticloadbalancingv2#Ciphers", + "Name": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { - "smithy.api#documentation": "

The ciphers.

" + "smithy.api#documentation": "

The name of the policy.

" } }, "SslProtocols": { @@ -4091,10 +4149,10 @@ "smithy.api#documentation": "

The protocols.

" } }, - "Name": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", + "Ciphers": { + "target": "com.amazonaws.elasticloadbalancingv2#Ciphers", "traits": { - "smithy.api#documentation": "

The name of the policy.

" + "smithy.api#documentation": "

The ciphers.

" } } }, @@ -4135,6 +4193,12 @@ "com.amazonaws.elasticloadbalancingv2#SubnetMapping": { "type": "structure", "members": { + "PrivateIPv4Address": { + "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", + "traits": { + "smithy.api#documentation": "

[Network Load Balancers] The private IPv4 address for an internal load balancer.

" + } + }, "AllocationId": { "target": "com.amazonaws.elasticloadbalancingv2#AllocationId", "traits": { @@ -4146,12 +4210,6 @@ "traits": { "smithy.api#documentation": "

The ID of the subnet.

" } - }, - "PrivateIPv4Address": { - "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", - "traits": { - "smithy.api#documentation": "

[Network Load Balancers] The private IPv4 address for an internal load balancer.

" - } } }, "traits": { @@ -4186,18 +4244,18 @@ "com.amazonaws.elasticloadbalancingv2#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.elasticloadbalancingv2#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

" - } - }, "Key": { "target": "com.amazonaws.elasticloadbalancingv2#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } + }, + "Value": { + "target": "com.amazonaws.elasticloadbalancingv2#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

" + } } }, "traits": { @@ -4207,17 +4265,17 @@ "com.amazonaws.elasticloadbalancingv2#TagDescription": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "

Information about the tags.

" } + }, + "ResourceArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } } }, "traits": { @@ -4270,6 +4328,12 @@ "com.amazonaws.elasticloadbalancingv2#TargetDescription": { "type": "structure", "members": { + "AvailabilityZone": { + "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", + "traits": { + "smithy.api#documentation": "

An Availability Zone or all. This determines whether the target receives\n traffic from the load balancer nodes in the specified Availability Zone or from all enabled\n Availability Zones for the load balancer.

\n

This parameter is not supported if the target type of the target group is instance.

\n

If the target type is ip and the IP address is in a subnet of the VPC for the \n target group, the Availability Zone is automatically detected and this parameter is optional. \n If the IP address is outside the VPC, this parameter is required.

\n

With an Application Load Balancer, if the target type is ip and the IP address \n is outside the VPC for the target group, the only supported value is all.

\n

If the target type is lambda, this parameter is optional and the only supported value is all.

" + } + }, "Id": { "target": "com.amazonaws.elasticloadbalancingv2#TargetId", "traits": { @@ -4282,12 +4346,6 @@ "traits": { "smithy.api#documentation": "

The port on which the target is listening. Not used if the target is a Lambda function.

" } - }, - "AvailabilityZone": { - "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", - "traits": { - "smithy.api#documentation": "

An Availability Zone or all. This determines whether the target receives\n traffic from the load balancer nodes in the specified Availability Zone or from all enabled\n Availability Zones for the load balancer.

\n

This parameter is not supported if the target type of the target group is instance.

\n

If the target type is ip and the IP address is in a subnet of the VPC for the \n target group, the Availability Zone is automatically detected and this parameter is optional. \n If the IP address is outside the VPC, this parameter is required.

\n

With an Application Load Balancer, if the target type is ip and the IP address \n is outside the VPC for the target group, the only supported value is all.

\n

If the target type is lambda, this parameter is optional and the only supported value is all.

" - } } }, "traits": { @@ -4303,40 +4361,40 @@ "com.amazonaws.elasticloadbalancingv2#TargetGroup": { "type": "structure", "members": { - "UnhealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", + "TargetGroupName": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", "traits": { - "smithy.api#documentation": "

The number of consecutive health check failures required before considering the target\n unhealthy.

" + "smithy.api#documentation": "

The name of the target group.

" } }, - "HealthCheckTimeoutSeconds": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", + "VpcId": { + "target": "com.amazonaws.elasticloadbalancingv2#VpcId", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health\n check.

" + "smithy.api#documentation": "

The ID of the VPC for the targets.

" } }, - "HealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", + "HealthCheckPort": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { - "smithy.api#documentation": "

The number of consecutive health checks successes required before considering an\n unhealthy target healthy.

" + "smithy.api#documentation": "

The port to use to connect with the target.

" } }, - "HealthCheckIntervalSeconds": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", + "TargetType": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", "traits": { - "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual\n target.

" + "smithy.api#documentation": "

The type of target that you must specify when registering targets with this target\n group. The possible values are instance (targets are specified by instance ID) or\n ip (targets are specified by IP address).

" } }, - "HealthCheckEnabled": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", + "HealthCheckProtocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "

Indicates whether health checks are enabled.

" + "smithy.api#documentation": "

The protocol to use to connect with the target.

" } }, - "VpcId": { - "target": "com.amazonaws.elasticloadbalancingv2#VpcId", + "HealthyThresholdCount": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { - "smithy.api#documentation": "

The ID of the VPC for the targets.

" + "smithy.api#documentation": "

The number of consecutive health checks successes required before considering an\n unhealthy target healthy.

" } }, "Protocol": { @@ -4345,34 +4403,34 @@ "smithy.api#documentation": "

The protocol to use for routing traffic to the targets.

" } }, - "TargetGroupName": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", + "TargetGroupArn": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { - "smithy.api#documentation": "

The name of the target group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

" } }, - "TargetType": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", + "HealthCheckIntervalSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", "traits": { - "smithy.api#documentation": "

The type of target that you must specify when registering targets with this target\n group. The possible values are instance (targets are specified by instance ID) or\n ip (targets are specified by IP address).

" + "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual\n target.

" } }, - "Matcher": { - "target": "com.amazonaws.elasticloadbalancingv2#Matcher", + "LoadBalancerArns": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", "traits": { - "smithy.api#documentation": "

The HTTP codes to use when checking for a successful response from a target.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target\n group.

" } }, - "HealthCheckPath": { - "target": "com.amazonaws.elasticloadbalancingv2#Path", + "HealthCheckTimeoutSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { - "smithy.api#documentation": "

The destination for the health check request.

" + "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health\n check.

" } }, - "TargetGroupArn": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", + "HealthCheckPath": { + "target": "com.amazonaws.elasticloadbalancingv2#Path", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

" + "smithy.api#documentation": "

The destination for the health check request.

" } }, "Port": { @@ -4381,22 +4439,22 @@ "smithy.api#documentation": "

The port on which the targets are listening. Not used if the target is a Lambda function.

" } }, - "HealthCheckProtocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "UnhealthyThresholdCount": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { - "smithy.api#documentation": "

The protocol to use to connect with the target.

" + "smithy.api#documentation": "

The number of consecutive health check failures required before considering the target\n unhealthy.

" } }, - "HealthCheckPort": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", + "HealthCheckEnabled": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { - "smithy.api#documentation": "

The port to use to connect with the target.

" + "smithy.api#documentation": "

Indicates whether health checks are enabled.

" } }, - "LoadBalancerArns": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", + "Matcher": { + "target": "com.amazonaws.elasticloadbalancingv2#Matcher", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target\n group.

" + "smithy.api#documentation": "

The HTTP codes to use when checking for a successful response from a target.

" } } }, @@ -4429,16 +4487,16 @@ "com.amazonaws.elasticloadbalancingv2#TargetGroupAttribute": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeValue", + "Key": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeKey", "traits": { - "smithy.api#documentation": "

The value of the attribute.

" + "smithy.api#documentation": "

The name of the attribute.

\n\n

The following attributes are supported by both Application Load Balancers and Network Load Balancers:

\n \n\n

The following attributes are supported only if the load balancer is an Application Load Balancer\n and the target is an instance or an IP address:

\n \n\n

The following attribute is supported only if the load balancer is an Application Load Balancer \n and the target is a Lambda function:

\n \n\n

The following attribute is supported only by Network Load Balancers:

\n " } }, - "Key": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeKey", + "Value": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeValue", "traits": { - "smithy.api#documentation": "

The name of the attribute.

\n\n

The following attributes are supported by both Application Load Balancers and Network Load Balancers:

\n \n\n

The following attributes are supported only if the load balancer is an Application Load Balancer\n and the target is an instance or an IP address:

\n \n\n

The following attribute is supported only if the load balancer is an Application Load Balancer \n and the target is a Lambda function:

\n \n\n

The following attribute is supported only by Network Load Balancers:

\n " + "smithy.api#documentation": "

The value of the attribute.

" } } }, @@ -4560,18 +4618,18 @@ "com.amazonaws.elasticloadbalancingv2#TargetHealth": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthReasonEnum", - "traits": { - "smithy.api#documentation": "

The reason code.

\n\n

If the target state is healthy, a reason code is not provided.

\n \n

If the target state is initial, the reason code can be one of the\n following values:

\n \n\n

If the target state is unhealthy, the reason code can be one of the\n following values:

\n \n\n

If the target state is unused, the reason code can be one of the following values:

\n \n\n

If the target state is draining, the reason code can be the following value:

\n \n\n

If the target state is unavailable, the reason code can be the following value:

\n " - } - }, "Description": { "target": "com.amazonaws.elasticloadbalancingv2#Description", "traits": { "smithy.api#documentation": "

A description of the target health that provides additional details. If the state is\n healthy, a description is not provided.

" } }, + "Reason": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthReasonEnum", + "traits": { + "smithy.api#documentation": "

The reason code.

\n\n

If the target state is healthy, a reason code is not provided.

\n \n

If the target state is initial, the reason code can be one of the\n following values:

\n \n\n

If the target state is unhealthy, the reason code can be one of the\n following values:

\n \n\n

If the target state is unused, the reason code can be one of the following values:

\n \n\n

If the target state is draining, the reason code can be the following value:

\n \n\n

If the target state is unavailable, the reason code can be the following value:

\n " + } + }, "State": { "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthStateEnum", "traits": { @@ -4586,6 +4644,12 @@ "com.amazonaws.elasticloadbalancingv2#TargetHealthDescription": { "type": "structure", "members": { + "TargetHealth": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetHealth", + "traits": { + "smithy.api#documentation": "

The health information for the target.

" + } + }, "HealthCheckPort": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { @@ -4597,12 +4661,6 @@ "traits": { "smithy.api#documentation": "

The description of the target.

" } - }, - "TargetHealth": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetHealth", - "traits": { - "smithy.api#documentation": "

The health information for the target.

" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing.2012-06-01.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing.2012-06-01.json index 8f5421121332..aa6c96eecbc1 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing.2012-06-01.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing.2012-06-01.json @@ -32,10 +32,10 @@ "com.amazonaws.elasticloadbalancing#AccessLog": { "type": "structure", "members": { - "EmitInterval": { - "target": "com.amazonaws.elasticloadbalancing#AccessLogInterval", + "S3BucketPrefix": { + "target": "com.amazonaws.elasticloadbalancing#AccessLogPrefix", "traits": { - "smithy.api#documentation": "

The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

\n

Default: 60 minutes

" + "smithy.api#documentation": "

The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. \n If the prefix is not provided, the log is placed at the root level of the bucket.

" } }, "S3BucketName": { @@ -44,10 +44,10 @@ "smithy.api#documentation": "

The name of the Amazon S3 bucket where the access logs are stored.

" } }, - "S3BucketPrefix": { - "target": "com.amazonaws.elasticloadbalancing#AccessLogPrefix", + "EmitInterval": { + "target": "com.amazonaws.elasticloadbalancing#AccessLogInterval", "traits": { - "smithy.api#documentation": "

The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. \n If the prefix is not provided, the log is placed at the root level of the bucket.

" + "smithy.api#documentation": "

The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

\n

Default: 60 minutes

" } }, "Enabled": { @@ -96,17 +96,17 @@ "com.amazonaws.elasticloadbalancing#AddAvailabilityZonesInput": { "type": "structure", "members": { - "AvailabilityZones": { - "target": "com.amazonaws.elasticloadbalancing#AvailabilityZones", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The Availability Zones. These must be in the same region as the load balancer.

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } }, - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "AvailabilityZones": { + "target": "com.amazonaws.elasticloadbalancing#AvailabilityZones", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

The Availability Zones. These must be in the same region as the load balancer.

", "smithy.api#required": {} } } @@ -155,17 +155,17 @@ "com.amazonaws.elasticloadbalancing#AddTagsInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.elasticloadbalancing#TagList", + "LoadBalancerNames": { + "target": "com.amazonaws.elasticloadbalancing#LoadBalancerNames", "traits": { - "smithy.api#documentation": "

The tags.

", + "smithy.api#documentation": "

The name of the load balancer. You can specify one load balancer only.

", "smithy.api#required": {} } }, - "LoadBalancerNames": { - "target": "com.amazonaws.elasticloadbalancing#LoadBalancerNames", + "Tags": { + "target": "com.amazonaws.elasticloadbalancing#TagList", "traits": { - "smithy.api#documentation": "

The name of the load balancer. You can specify one load balancer only.

", + "smithy.api#documentation": "

The tags.

", "smithy.api#required": {} } } @@ -184,21 +184,21 @@ "com.amazonaws.elasticloadbalancing#AdditionalAttribute": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.elasticloadbalancing#AdditionalAttributeValue", + "Key": { + "target": "com.amazonaws.elasticloadbalancing#AdditionalAttributeKey", "traits": { - "smithy.api#documentation": "

This parameter is reserved.

" + "smithy.api#documentation": "

The name of the attribute.

\n

The following attribute is supported.

\n " } }, - "Key": { - "target": "com.amazonaws.elasticloadbalancing#AdditionalAttributeKey", + "Value": { + "target": "com.amazonaws.elasticloadbalancing#AdditionalAttributeValue", "traits": { - "smithy.api#documentation": "

This parameter is reserved.

" + "smithy.api#documentation": "

This value of the attribute.

" } } }, "traits": { - "smithy.api#documentation": "

This data type is reserved.

" + "smithy.api#documentation": "

Information about additional load balancer attributes.

" } }, "com.amazonaws.elasticloadbalancing#AdditionalAttributeKey": { @@ -285,17 +285,17 @@ "com.amazonaws.elasticloadbalancing#ApplySecurityGroupsToLoadBalancerInput": { "type": "structure", "members": { - "SecurityGroups": { - "target": "com.amazonaws.elasticloadbalancing#SecurityGroups", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } }, - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "SecurityGroups": { + "target": "com.amazonaws.elasticloadbalancing#SecurityGroups", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.

", "smithy.api#required": {} } } @@ -496,18 +496,18 @@ "com.amazonaws.elasticloadbalancing#ConnectionDraining": { "type": "structure", "members": { + "Timeout": { + "target": "com.amazonaws.elasticloadbalancing#ConnectionDrainingTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

" + } + }, "Enabled": { "target": "com.amazonaws.elasticloadbalancing#ConnectionDrainingEnabled", "traits": { "smithy.api#documentation": "

Specifies whether connection draining is enabled for the load balancer.

", "smithy.api#required": {} } - }, - "Timeout": { - "target": "com.amazonaws.elasticloadbalancing#ConnectionDrainingTimeout", - "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

" - } } }, "traits": { @@ -550,24 +550,16 @@ "com.amazonaws.elasticloadbalancing#CreateAccessPointInput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

\n

This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.elasticloadbalancing#TagList", + "AvailabilityZones": { + "target": "com.amazonaws.elasticloadbalancing#AvailabilityZones", "traits": { - "smithy.api#documentation": "

A list of tags to assign to the load balancer.

\n

For more information about tagging your load balancer, see Tag Your Classic Load Balancer\n in the Classic Load Balancers Guide.

" + "smithy.api#documentation": "

One or more Availability Zones from the same region as the load balancer.

\n

You must specify at least one Availability Zone.

\n

You can add more Availability Zones after you create the load balancer using \n EnableAvailabilityZonesForLoadBalancer.

" } }, - "Listeners": { - "target": "com.amazonaws.elasticloadbalancing#Listeners", + "Subnets": { + "target": "com.amazonaws.elasticloadbalancing#Subnets", "traits": { - "smithy.api#documentation": "

The listeners.

\n

For more information, see Listeners for Your Classic Load Balancer\n in the Classic Load Balancers Guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IDs of the subnets in your VPC to attach to the load balancer.\n Specify one subnet per Availability Zone specified in AvailabilityZones.

" } }, "SecurityGroups": { @@ -582,16 +574,24 @@ "smithy.api#documentation": "

The type of a load balancer. Valid only for load balancers in a VPC.

\n

By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses.\n For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme\n in the Elastic Load Balancing User Guide.

\n

Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.

" } }, - "Subnets": { - "target": "com.amazonaws.elasticloadbalancing#Subnets", + "Tags": { + "target": "com.amazonaws.elasticloadbalancing#TagList", "traits": { - "smithy.api#documentation": "

The IDs of the subnets in your VPC to attach to the load balancer.\n Specify one subnet per Availability Zone specified in AvailabilityZones.

" + "smithy.api#documentation": "

A list of tags to assign to the load balancer.

\n

For more information about tagging your load balancer, see Tag Your Classic Load Balancer\n in the Classic Load Balancers Guide.

" } }, - "AvailabilityZones": { - "target": "com.amazonaws.elasticloadbalancing#AvailabilityZones", + "Listeners": { + "target": "com.amazonaws.elasticloadbalancing#Listeners", "traits": { - "smithy.api#documentation": "

One or more Availability Zones from the same region as the load balancer.

\n

You must specify at least one Availability Zone.

\n

You can add more Availability Zones after you create the load balancer using \n EnableAvailabilityZonesForLoadBalancer.

" + "smithy.api#documentation": "

The listeners.

\n

For more information, see Listeners for Your Classic Load Balancer\n in the Classic Load Balancers Guide.

", + "smithy.api#required": {} + } + }, + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

\n

This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

", + "smithy.api#required": {} } } }, @@ -642,10 +642,10 @@ "com.amazonaws.elasticloadbalancing#CreateAppCookieStickinessPolicyInput": { "type": "structure", "members": { - "CookieName": { - "target": "com.amazonaws.elasticloadbalancing#CookieName", + "PolicyName": { + "target": "com.amazonaws.elasticloadbalancing#PolicyName", "traits": { - "smithy.api#documentation": "

The name of the application cookie used for stickiness.

", + "smithy.api#documentation": "

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

", "smithy.api#required": {} } }, @@ -656,10 +656,10 @@ "smithy.api#required": {} } }, - "PolicyName": { - "target": "com.amazonaws.elasticloadbalancing#PolicyName", + "CookieName": { + "target": "com.amazonaws.elasticloadbalancing#CookieName", "traits": { - "smithy.api#documentation": "

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

", + "smithy.api#documentation": "

The name of the application cookie used for stickiness.

", "smithy.api#required": {} } } @@ -704,6 +704,13 @@ "com.amazonaws.elasticloadbalancing#CreateLBCookieStickinessPolicyInput": { "type": "structure", "members": { + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#required": {} + } + }, "PolicyName": { "target": "com.amazonaws.elasticloadbalancing#PolicyName", "traits": { @@ -716,13 +723,6 @@ "traits": { "smithy.api#documentation": "

The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

" } - }, - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } } }, "traits": { @@ -789,17 +789,17 @@ "com.amazonaws.elasticloadbalancing#CreateLoadBalancerListenerInput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "Listeners": { + "target": "com.amazonaws.elasticloadbalancing#Listeners", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

The listeners.

", "smithy.api#required": {} } }, - "Listeners": { - "target": "com.amazonaws.elasticloadbalancing#Listeners", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The listeners.

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } } @@ -876,13 +876,6 @@ "com.amazonaws.elasticloadbalancing#CreateLoadBalancerPolicyInput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } - }, "PolicyName": { "target": "com.amazonaws.elasticloadbalancing#PolicyName", "traits": { @@ -890,10 +883,10 @@ "smithy.api#required": {} } }, - "PolicyTypeName": { - "target": "com.amazonaws.elasticloadbalancing#PolicyTypeName", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The name of the base policy type.\n \t To get the list of policy types, use DescribeLoadBalancerPolicyTypes.

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } }, @@ -902,6 +895,13 @@ "traits": { "smithy.api#documentation": "

The policy attributes.

" } + }, + "PolicyTypeName": { + "target": "com.amazonaws.elasticloadbalancing#PolicyTypeName", + "traits": { + "smithy.api#documentation": "

The name of the base policy type.\n \t To get the list of policy types, use DescribeLoadBalancerPolicyTypes.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1087,17 +1087,17 @@ "com.amazonaws.elasticloadbalancing#DeregisterEndPointsInput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "Instances": { + "target": "com.amazonaws.elasticloadbalancing#Instances", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

The IDs of the instances.

", "smithy.api#required": {} } }, - "Instances": { - "target": "com.amazonaws.elasticloadbalancing#Instances", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } } @@ -1143,18 +1143,18 @@ "com.amazonaws.elasticloadbalancing#DescribeAccessPointsInput": { "type": "structure", "members": { - "LoadBalancerNames": { - "target": "com.amazonaws.elasticloadbalancing#LoadBalancerNames", - "traits": { - "smithy.api#documentation": "

The names of the load balancers.

" - } - }, "Marker": { "target": "com.amazonaws.elasticloadbalancing#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results. (You received this marker from a previous call.)

" } }, + "LoadBalancerNames": { + "target": "com.amazonaws.elasticloadbalancing#LoadBalancerNames", + "traits": { + "smithy.api#documentation": "

The names of the load balancers.

" + } + }, "PageSize": { "target": "com.amazonaws.elasticloadbalancing#PageSize", "traits": { @@ -1169,17 +1169,17 @@ "com.amazonaws.elasticloadbalancing#DescribeAccessPointsOutput": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.elasticloadbalancing#Marker", - "traits": { - "smithy.api#documentation": "

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" - } - }, "LoadBalancerDescriptions": { "target": "com.amazonaws.elasticloadbalancing#LoadBalancerDescriptions", "traits": { "smithy.api#documentation": "

Information about the load balancers.

" } + }, + "NextMarker": { + "target": "com.amazonaws.elasticloadbalancing#Marker", + "traits": { + "smithy.api#documentation": "

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" + } } }, "traits": { @@ -1359,17 +1359,17 @@ "com.amazonaws.elasticloadbalancing#DescribeLoadBalancerPoliciesInput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

" - } - }, "PolicyNames": { "target": "com.amazonaws.elasticloadbalancing#PolicyNames", "traits": { "smithy.api#documentation": "

The names of the policies.

" } + }, + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

" + } } }, "traits": { @@ -1734,7 +1734,7 @@ "sdkId": "Elastic Load Balancing", "arnNamespace": "elasticloadbalancing", "cloudFormationName": "ElasticLoadBalancing", - "cloudTrailEventSource": "version_2012_06_01.elb.amazon.com" + "cloudTrailEventSource": "elasticloadbalancing.amazonaws.com" }, "aws.auth#sigv4": { "name": "elasticloadbalancing" @@ -1776,13 +1776,6 @@ "com.amazonaws.elasticloadbalancing#HealthCheck": { "type": "structure", "members": { - "Target": { - "target": "com.amazonaws.elasticloadbalancing#HealthCheckTarget", - "traits": { - "smithy.api#documentation": "

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

\n

TCP is the default, specified as a TCP: port pair, for example \"TCP:5000\". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

\n

SSL is also specified as SSL: port pair, for example, SSL:5000.

\n

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than \"200 OK\" within the timeout period is considered unhealthy.

\n

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

", - "smithy.api#required": {} - } - }, "HealthyThreshold": { "target": "com.amazonaws.elasticloadbalancing#HealthyThreshold", "traits": { @@ -1797,10 +1790,10 @@ "smithy.api#required": {} } }, - "Timeout": { - "target": "com.amazonaws.elasticloadbalancing#HealthCheckTimeout", + "Target": { + "target": "com.amazonaws.elasticloadbalancing#HealthCheckTarget", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health check.

\n

This value must be less than the Interval value.

", + "smithy.api#documentation": "

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

\n

TCP is the default, specified as a TCP: port pair, for example \"TCP:5000\". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

\n

SSL is also specified as SSL: port pair, for example, SSL:5000.

\n

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than \"200 OK\" within the timeout period is considered unhealthy.

\n

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

", "smithy.api#required": {} } }, @@ -1810,6 +1803,13 @@ "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual instance.

", "smithy.api#required": {} } + }, + "Timeout": { + "target": "com.amazonaws.elasticloadbalancing#HealthCheckTimeout", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health check.

\n

This value must be less than the Interval value.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1885,12 +1885,6 @@ "com.amazonaws.elasticloadbalancing#InstanceState": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.elasticloadbalancing#Description", - "traits": { - "smithy.api#documentation": "

A description of the instance state. This string can contain one or more of the following messages.

\n " - } - }, "InstanceId": { "target": "com.amazonaws.elasticloadbalancing#InstanceId", "traits": { @@ -1903,6 +1897,12 @@ "smithy.api#documentation": "

The current state of the instance.

\n

Valid values: InService | OutOfService | Unknown\n

" } }, + "Description": { + "target": "com.amazonaws.elasticloadbalancing#Description", + "traits": { + "smithy.api#documentation": "

A description of the instance state. This string can contain one or more of the following messages.

\n " + } + }, "ReasonCode": { "target": "com.amazonaws.elasticloadbalancing#ReasonCode", "traits": { @@ -2046,12 +2046,6 @@ "com.amazonaws.elasticloadbalancing#Listener": { "type": "structure", "members": { - "SSLCertificateId": { - "target": "com.amazonaws.elasticloadbalancing#SSLCertificateId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the server certificate.

" - } - }, "LoadBalancerPort": { "target": "com.amazonaws.elasticloadbalancing#AccessPointPort", "traits": { @@ -2059,17 +2053,23 @@ "smithy.api#required": {} } }, - "InstanceProtocol": { - "target": "com.amazonaws.elasticloadbalancing#Protocol", + "InstancePort": { + "target": "com.amazonaws.elasticloadbalancing#InstancePort", "traits": { - "smithy.api#documentation": "

The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

\n \t

If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.

\n \t

If there is another listener with the same InstancePort whose InstanceProtocol is secure,\n \t (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

\n

If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP,\n the listener's InstanceProtocol must be HTTP or TCP.

" + "smithy.api#documentation": "

The port on which the instance is listening.

", + "smithy.api#required": {} } }, - "InstancePort": { - "target": "com.amazonaws.elasticloadbalancing#InstancePort", + "InstanceProtocol": { + "target": "com.amazonaws.elasticloadbalancing#Protocol", "traits": { - "smithy.api#documentation": "

The port on which the instance is listening.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

\n

If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. \n If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.

\n

If there is another listener with the same InstancePort whose InstanceProtocol is secure,\n (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

\n

If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP,\n the listener's InstanceProtocol must be HTTP or TCP.

" + } + }, + "SSLCertificateId": { + "target": "com.amazonaws.elasticloadbalancing#SSLCertificateId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the server certificate.

" } }, "Protocol": { @@ -2087,17 +2087,17 @@ "com.amazonaws.elasticloadbalancing#ListenerDescription": { "type": "structure", "members": { - "Listener": { - "target": "com.amazonaws.elasticloadbalancing#Listener", - "traits": { - "smithy.api#documentation": "

The listener.

" - } - }, "PolicyNames": { "target": "com.amazonaws.elasticloadbalancing#PolicyNames", "traits": { "smithy.api#documentation": "

The policies. If there are no policies enabled, the list is empty.

" } + }, + "Listener": { + "target": "com.amazonaws.elasticloadbalancing#Listener", + "traits": { + "smithy.api#documentation": "

The listener.

" + } } }, "traits": { @@ -2145,22 +2145,22 @@ "com.amazonaws.elasticloadbalancing#LoadBalancerAttributes": { "type": "structure", "members": { - "ConnectionSettings": { - "target": "com.amazonaws.elasticloadbalancing#ConnectionSettings", - "traits": { - "smithy.api#documentation": "

If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

\n

By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer.\n For more information, see Configure Idle Connection Timeout\n in the Classic Load Balancers Guide.

" - } - }, "AccessLog": { "target": "com.amazonaws.elasticloadbalancing#AccessLog", "traits": { "smithy.api#documentation": "

If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.

\n

For more information, see Enable Access Logs\n in the Classic Load Balancers Guide.

" } }, + "ConnectionSettings": { + "target": "com.amazonaws.elasticloadbalancing#ConnectionSettings", + "traits": { + "smithy.api#documentation": "

If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

\n

By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer.\n For more information, see Configure Idle Connection Timeout\n in the Classic Load Balancers Guide.

" + } + }, "AdditionalAttributes": { "target": "com.amazonaws.elasticloadbalancing#AdditionalAttributes", "traits": { - "smithy.api#documentation": "

This parameter is reserved.

" + "smithy.api#documentation": "

Any additional attributes.

" } }, "CrossZoneLoadBalancing": { @@ -2183,64 +2183,64 @@ "com.amazonaws.elasticloadbalancing#LoadBalancerDescription": { "type": "structure", "members": { - "BackendServerDescriptions": { - "target": "com.amazonaws.elasticloadbalancing#BackendServerDescriptions", + "CanonicalHostedZoneNameID": { + "target": "com.amazonaws.elasticloadbalancing#DNSName", "traits": { - "smithy.api#documentation": "

Information about your EC2 instances.

" + "smithy.api#documentation": "

The ID of the Amazon Route 53 hosted zone for the load balancer.

" } }, - "DNSName": { - "target": "com.amazonaws.elasticloadbalancing#DNSName", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The DNS name of the load balancer.

" + "smithy.api#documentation": "

The name of the load balancer.

" } }, - "CreatedTime": { - "target": "com.amazonaws.elasticloadbalancing#CreatedTime", + "VPCId": { + "target": "com.amazonaws.elasticloadbalancing#VPCId", "traits": { - "smithy.api#documentation": "

The date and time the load balancer was created.

" + "smithy.api#documentation": "

The ID of the VPC for the load balancer.

" } }, - "Scheme": { - "target": "com.amazonaws.elasticloadbalancing#LoadBalancerScheme", + "Subnets": { + "target": "com.amazonaws.elasticloadbalancing#Subnets", "traits": { - "smithy.api#documentation": "

The type of load balancer. Valid only for load balancers in a VPC.

\n

If Scheme is internet-facing, the load balancer\n has a public DNS name that resolves to a public IP address.

\n

If Scheme is internal, the load balancer has a public \n DNS name that resolves to a private IP address.

" + "smithy.api#documentation": "

The IDs of the subnets for the load balancer.

" } }, - "SecurityGroups": { - "target": "com.amazonaws.elasticloadbalancing#SecurityGroups", + "DNSName": { + "target": "com.amazonaws.elasticloadbalancing#DNSName", "traits": { - "smithy.api#documentation": "

The security groups for the load balancer. Valid only for load balancers in a VPC.

" + "smithy.api#documentation": "

The DNS name of the load balancer.

" } }, - "CanonicalHostedZoneName": { - "target": "com.amazonaws.elasticloadbalancing#DNSName", + "Policies": { + "target": "com.amazonaws.elasticloadbalancing#Policies", "traits": { - "smithy.api#documentation": "

The DNS name of the load balancer.

\n

For more information, see Configure a Custom Domain Name \n in the Classic Load Balancers Guide.

" + "smithy.api#documentation": "

The policies defined for the load balancer.

" } }, - "CanonicalHostedZoneNameID": { + "CanonicalHostedZoneName": { "target": "com.amazonaws.elasticloadbalancing#DNSName", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Route 53 hosted zone for the load balancer.

" + "smithy.api#documentation": "

The DNS name of the load balancer.

\n

For more information, see Configure a Custom Domain Name \n in the Classic Load Balancers Guide.

" } }, - "Instances": { - "target": "com.amazonaws.elasticloadbalancing#Instances", + "BackendServerDescriptions": { + "target": "com.amazonaws.elasticloadbalancing#BackendServerDescriptions", "traits": { - "smithy.api#documentation": "

The IDs of the instances for the load balancer.

" + "smithy.api#documentation": "

Information about your EC2 instances.

" } }, - "ListenerDescriptions": { - "target": "com.amazonaws.elasticloadbalancing#ListenerDescriptions", + "SecurityGroups": { + "target": "com.amazonaws.elasticloadbalancing#SecurityGroups", "traits": { - "smithy.api#documentation": "

The listeners for the load balancer.

" + "smithy.api#documentation": "

The security groups for the load balancer. Valid only for load balancers in a VPC.

" } }, - "HealthCheck": { - "target": "com.amazonaws.elasticloadbalancing#HealthCheck", + "SourceSecurityGroup": { + "target": "com.amazonaws.elasticloadbalancing#SourceSecurityGroup", "traits": { - "smithy.api#documentation": "

Information about the health checks conducted on the load balancer.

" + "smithy.api#documentation": "

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. \n To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

" } }, "AvailabilityZones": { @@ -2249,34 +2249,34 @@ "smithy.api#documentation": "

The Availability Zones for the load balancer.

" } }, - "SourceSecurityGroup": { - "target": "com.amazonaws.elasticloadbalancing#SourceSecurityGroup", + "Instances": { + "target": "com.amazonaws.elasticloadbalancing#Instances", "traits": { - "smithy.api#documentation": "

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. \n To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

" + "smithy.api#documentation": "

The IDs of the instances for the load balancer.

" } }, - "VPCId": { - "target": "com.amazonaws.elasticloadbalancing#VPCId", + "Scheme": { + "target": "com.amazonaws.elasticloadbalancing#LoadBalancerScheme", "traits": { - "smithy.api#documentation": "

The ID of the VPC for the load balancer.

" + "smithy.api#documentation": "

The type of load balancer. Valid only for load balancers in a VPC.

\n

If Scheme is internet-facing, the load balancer\n has a public DNS name that resolves to a public IP address.

\n

If Scheme is internal, the load balancer has a public \n DNS name that resolves to a private IP address.

" } }, - "Policies": { - "target": "com.amazonaws.elasticloadbalancing#Policies", + "CreatedTime": { + "target": "com.amazonaws.elasticloadbalancing#CreatedTime", "traits": { - "smithy.api#documentation": "

The policies defined for the load balancer.

" + "smithy.api#documentation": "

The date and time the load balancer was created.

" } }, - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "HealthCheck": { + "target": "com.amazonaws.elasticloadbalancing#HealthCheck", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

" + "smithy.api#documentation": "

Information about the health checks conducted on the load balancer.

" } }, - "Subnets": { - "target": "com.amazonaws.elasticloadbalancing#Subnets", + "ListenerDescriptions": { + "target": "com.amazonaws.elasticloadbalancing#ListenerDescriptions", "traits": { - "smithy.api#documentation": "

The IDs of the subnets for the load balancer.

" + "smithy.api#documentation": "

The listeners for the load balancer.

" } } }, @@ -2365,17 +2365,17 @@ "com.amazonaws.elasticloadbalancing#ModifyLoadBalancerAttributesOutput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

" - } - }, "LoadBalancerAttributes": { "target": "com.amazonaws.elasticloadbalancing#LoadBalancerAttributes", "traits": { "smithy.api#documentation": "

Information about the load balancer attributes.

" } + }, + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

" + } } }, "traits": { @@ -2411,18 +2411,18 @@ "com.amazonaws.elasticloadbalancing#Policies": { "type": "structure", "members": { - "OtherPolicies": { - "target": "com.amazonaws.elasticloadbalancing#PolicyNames", - "traits": { - "smithy.api#documentation": "

The policies other than the stickiness policies.

" - } - }, "LBCookieStickinessPolicies": { "target": "com.amazonaws.elasticloadbalancing#LBCookieStickinessPolicies", "traits": { "smithy.api#documentation": "

The stickiness policies created using CreateLBCookieStickinessPolicy.

" } }, + "OtherPolicies": { + "target": "com.amazonaws.elasticloadbalancing#PolicyNames", + "traits": { + "smithy.api#documentation": "

The policies other than the stickiness policies.

" + } + }, "AppCookieStickinessPolicies": { "target": "com.amazonaws.elasticloadbalancing#AppCookieStickinessPolicies", "traits": { @@ -2483,10 +2483,16 @@ "com.amazonaws.elasticloadbalancing#PolicyAttributeTypeDescription": { "type": "structure", "members": { - "AttributeType": { - "target": "com.amazonaws.elasticloadbalancing#AttributeType", + "Description": { + "target": "com.amazonaws.elasticloadbalancing#Description", "traits": { - "smithy.api#documentation": "

The type of the attribute. For example, Boolean or Integer.

" + "smithy.api#documentation": "

A description of the attribute.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.elasticloadbalancing#DefaultValue", + "traits": { + "smithy.api#documentation": "

The default value of the attribute, if applicable.

" } }, "AttributeName": { @@ -2495,10 +2501,10 @@ "smithy.api#documentation": "

The name of the attribute.

" } }, - "DefaultValue": { - "target": "com.amazonaws.elasticloadbalancing#DefaultValue", + "AttributeType": { + "target": "com.amazonaws.elasticloadbalancing#AttributeType", "traits": { - "smithy.api#documentation": "

The default value of the attribute, if applicable.

" + "smithy.api#documentation": "

The type of the attribute. For example, Boolean or Integer.

" } }, "Cardinality": { @@ -2506,12 +2512,6 @@ "traits": { "smithy.api#documentation": "

The cardinality of the attribute.

\n

Valid values:

\n " } - }, - "Description": { - "target": "com.amazonaws.elasticloadbalancing#Description", - "traits": { - "smithy.api#documentation": "

A description of the attribute.

" - } } }, "traits": { @@ -2533,18 +2533,18 @@ "com.amazonaws.elasticloadbalancing#PolicyDescription": { "type": "structure", "members": { - "PolicyTypeName": { - "target": "com.amazonaws.elasticloadbalancing#PolicyTypeName", - "traits": { - "smithy.api#documentation": "

The name of the policy type.

" - } - }, "PolicyName": { "target": "com.amazonaws.elasticloadbalancing#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy.

" } }, + "PolicyTypeName": { + "target": "com.amazonaws.elasticloadbalancing#PolicyTypeName", + "traits": { + "smithy.api#documentation": "

The name of the policy type.

" + } + }, "PolicyAttributeDescriptions": { "target": "com.amazonaws.elasticloadbalancing#PolicyAttributeDescriptions", "traits": { @@ -2587,18 +2587,18 @@ "com.amazonaws.elasticloadbalancing#PolicyTypeDescription": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.elasticloadbalancing#Description", - "traits": { - "smithy.api#documentation": "

A description of the policy type.

" - } - }, "PolicyAttributeTypeDescriptions": { "target": "com.amazonaws.elasticloadbalancing#PolicyAttributeTypeDescriptions", "traits": { "smithy.api#documentation": "

The description of the policy attributes associated with the policies defined by Elastic Load Balancing.

" } }, + "Description": { + "target": "com.amazonaws.elasticloadbalancing#Description", + "traits": { + "smithy.api#documentation": "

A description of the policy type.

" + } + }, "PolicyTypeName": { "target": "com.amazonaws.elasticloadbalancing#PolicyTypeName", "traits": { @@ -2653,17 +2653,17 @@ "com.amazonaws.elasticloadbalancing#RegisterEndPointsInput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "Instances": { + "target": "com.amazonaws.elasticloadbalancing#Instances", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

The IDs of the instances.

", "smithy.api#required": {} } }, - "Instances": { - "target": "com.amazonaws.elasticloadbalancing#Instances", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The IDs of the instances.

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } } @@ -2841,10 +2841,10 @@ "com.amazonaws.elasticloadbalancing#SetLoadBalancerListenerSSLCertificateInput": { "type": "structure", "members": { - "LoadBalancerName": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointName", + "LoadBalancerPort": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointPort", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

The port that uses the specified SSL certificate.

", "smithy.api#required": {} } }, @@ -2855,10 +2855,10 @@ "smithy.api#required": {} } }, - "LoadBalancerPort": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointPort", + "LoadBalancerName": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointName", "traits": { - "smithy.api#documentation": "

The port that uses the specified SSL certificate.

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } } @@ -2900,6 +2900,13 @@ "com.amazonaws.elasticloadbalancing#SetLoadBalancerPoliciesForBackendServerInput": { "type": "structure", "members": { + "PolicyNames": { + "target": "com.amazonaws.elasticloadbalancing#PolicyNames", + "traits": { + "smithy.api#documentation": "

The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.

", + "smithy.api#required": {} + } + }, "InstancePort": { "target": "com.amazonaws.elasticloadbalancing#EndPointPort", "traits": { @@ -2913,13 +2920,6 @@ "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } - }, - "PolicyNames": { - "target": "com.amazonaws.elasticloadbalancing#PolicyNames", - "traits": { - "smithy.api#documentation": "

The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2962,13 +2962,6 @@ "com.amazonaws.elasticloadbalancing#SetLoadBalancerPoliciesOfListenerInput": { "type": "structure", "members": { - "LoadBalancerPort": { - "target": "com.amazonaws.elasticloadbalancing#AccessPointPort", - "traits": { - "smithy.api#documentation": "

The external port of the load balancer.

", - "smithy.api#required": {} - } - }, "PolicyNames": { "target": "com.amazonaws.elasticloadbalancing#PolicyNames", "traits": { @@ -2982,6 +2975,13 @@ "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } + }, + "LoadBalancerPort": { + "target": "com.amazonaws.elasticloadbalancing#AccessPointPort", + "traits": { + "smithy.api#documentation": "

The external port of the load balancer.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2998,17 +2998,17 @@ "com.amazonaws.elasticloadbalancing#SourceSecurityGroup": { "type": "structure", "members": { - "OwnerAlias": { - "target": "com.amazonaws.elasticloadbalancing#SecurityGroupOwnerAlias", - "traits": { - "smithy.api#documentation": "

The owner of the security group.

" - } - }, "GroupName": { "target": "com.amazonaws.elasticloadbalancing#SecurityGroupName", "traits": { "smithy.api#documentation": "

The name of the security group.

" } + }, + "OwnerAlias": { + "target": "com.amazonaws.elasticloadbalancing#SecurityGroupOwnerAlias", + "traits": { + "smithy.api#documentation": "

The owner of the security group.

" + } } }, "traits": { @@ -3043,18 +3043,18 @@ "com.amazonaws.elasticloadbalancing#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.elasticloadbalancing#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

" - } - }, "Key": { "target": "com.amazonaws.elasticloadbalancing#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } + }, + "Value": { + "target": "com.amazonaws.elasticloadbalancing#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/elastic-transcoder.2012-09-25.json b/codegen/sdk-codegen/aws-models/elastic-transcoder.2012-09-25.json index ad49d5aa2a20..3c1638daf9c4 100644 --- a/codegen/sdk-codegen/aws-models/elastic-transcoder.2012-09-25.json +++ b/codegen/sdk-codegen/aws-models/elastic-transcoder.2012-09-25.json @@ -66,12 +66,6 @@ "com.amazonaws.elastictranscoder#Artwork": { "type": "structure", "members": { - "InputKey": { - "target": "com.amazonaws.elastictranscoder#WatermarkKey", - "traits": { - "smithy.api#documentation": "

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

" - } - }, "PaddingPolicy": { "target": "com.amazonaws.elastictranscoder#PaddingPolicy", "traits": { @@ -84,10 +78,16 @@ "smithy.api#documentation": "

Specify one of the following values to control scaling of the output album art:

\n \n " } }, - "Encryption": { - "target": "com.amazonaws.elastictranscoder#Encryption", + "MaxHeight": { + "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", "traits": { - "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.

" + "smithy.api#documentation": "

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

" + } + }, + "MaxWidth": { + "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", + "traits": { + "smithy.api#documentation": "

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

" } }, "AlbumArtFormat": { @@ -96,16 +96,16 @@ "smithy.api#documentation": "

The format of album art, if any. Valid formats are .jpg and .png.

" } }, - "MaxHeight": { - "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", + "Encryption": { + "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { - "smithy.api#documentation": "

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

" + "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.

" } }, - "MaxWidth": { - "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", + "InputKey": { + "target": "com.amazonaws.elastictranscoder#WatermarkKey", "traits": { - "smithy.api#documentation": "

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

" + "smithy.api#documentation": "

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

" } } }, @@ -164,6 +164,12 @@ "com.amazonaws.elastictranscoder#AudioCodecOptions": { "type": "structure", "members": { + "BitDepth": { + "target": "com.amazonaws.elastictranscoder#AudioBitDepth", + "traits": { + "smithy.api#documentation": "

You can only choose an audio bit depth when you specify flac or \n pcm for the value of Audio:Codec.

\n

The bit depth of a sample is how many bits of information are included in the \n audio samples. The higher the bit depth, the better the audio, but the larger the file.

\n

Valid values are 16 and 24.

\n

The most common bit depth is 24.

" + } + }, "Profile": { "target": "com.amazonaws.elastictranscoder#AudioCodecProfile", "traits": { @@ -181,12 +187,6 @@ "traits": { "smithy.api#documentation": "

You can only choose an audio bit order when you specify \n pcm for the value of Audio:Codec.

\n

The order the bits of a PCM sample are stored in.

\n

The supported value is LittleEndian.

" } - }, - "BitDepth": { - "target": "com.amazonaws.elastictranscoder#AudioBitDepth", - "traits": { - "smithy.api#documentation": "

You can only choose an audio bit depth when you specify flac or \n pcm for the value of Audio:Codec.

\n

The bit depth of a sample is how many bits of information are included in the \n audio samples. The higher the bit depth, the better the audio, but the larger the file.

\n

Valid values are 16 and 24.

\n

The most common bit depth is 24.

" - } } }, "traits": { @@ -208,24 +208,6 @@ "com.amazonaws.elastictranscoder#AudioParameters": { "type": "structure", "members": { - "Channels": { - "target": "com.amazonaws.elastictranscoder#AudioChannels", - "traits": { - "smithy.api#documentation": "

The number of audio channels in the output file. The following values are valid:

\n

\n auto, 0, 1, 2\n

\n

One channel carries the information played by a single speaker. For example, a stereo\n track with two channels sends one channel to the left speaker, and the other\n channel to the right speaker. The output channels are organized into tracks.\n If you want Elastic Transcoder to automatically detect the number\n of audio channels in the input file and use that value for the output file, select\n auto.

\n \n

The output of a specific channel value and inputs are as follows:

\n\n \n\n

For more information about how Elastic Transcoder organizes channels and tracks, see\n Audio:AudioPackingMode.

" - } - }, - "SampleRate": { - "target": "com.amazonaws.elastictranscoder#AudioSampleRate", - "traits": { - "smithy.api#documentation": "

The sample rate of the audio stream in the output file, in Hertz. Valid values include:

\n

\n auto, 22050, 32000, 44100,\n 48000, 96000\n

\n

If you specify auto, Elastic Transcoder automatically detects the sample rate.

" - } - }, - "AudioPackingMode": { - "target": "com.amazonaws.elastictranscoder#AudioPackingMode", - "traits": { - "smithy.api#documentation": "

The method of organizing audio channels and tracks. Use Audio:Channels to\n specify the number of channels in your output, and Audio:AudioPackingMode\n to specify the number of tracks and their relation to the channels. If you do not specify\n an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.

\n

The following values are valid:

\n

\n SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks\n

\n \n

When you specify SingleTrack, Elastic Transcoder creates a single track for your output. \n The track can have up to eight channels. Use SingleTrack for all non-mxf\n containers.

\n \n

The outputs of SingleTrack for a specific channel value and inputs \n are as follows:

\n \n \n\n

When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output\n can have up to eight single-channel tracks.

\n

The outputs of OneChannelPerTrack for a specific channel value and inputs\n are as follows:

\n \n\n

When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel \n tracks for your output. All tracks that do not contain audio data from an input channel are\n MOS, or Mit Out Sound, tracks.

\n

The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs\n are as follows:

\n " - } - }, "CodecOptions": { "target": "com.amazonaws.elastictranscoder#AudioCodecOptions", "traits": { @@ -243,6 +225,24 @@ "traits": { "smithy.api#documentation": "

The audio codec for the output file. Valid values include aac, \n flac, mp2, mp3, pcm, \n and vorbis.

" } + }, + "Channels": { + "target": "com.amazonaws.elastictranscoder#AudioChannels", + "traits": { + "smithy.api#documentation": "

The number of audio channels in the output file. The following values are valid:

\n

\n auto, 0, 1, 2\n

\n

One channel carries the information played by a single speaker. For example, a stereo\n track with two channels sends one channel to the left speaker, and the other\n channel to the right speaker. The output channels are organized into tracks.\n If you want Elastic Transcoder to automatically detect the number\n of audio channels in the input file and use that value for the output file, select\n auto.

\n \n

The output of a specific channel value and inputs are as follows:

\n\n \n\n

For more information about how Elastic Transcoder organizes channels and tracks, see\n Audio:AudioPackingMode.

" + } + }, + "SampleRate": { + "target": "com.amazonaws.elastictranscoder#AudioSampleRate", + "traits": { + "smithy.api#documentation": "

The sample rate of the audio stream in the output file, in Hertz. Valid values include:

\n

\n auto, 22050, 32000, 44100,\n 48000, 96000\n

\n

If you specify auto, Elastic Transcoder automatically detects the sample rate.

" + } + }, + "AudioPackingMode": { + "target": "com.amazonaws.elastictranscoder#AudioPackingMode", + "traits": { + "smithy.api#documentation": "

The method of organizing audio channels and tracks. Use Audio:Channels to\n specify the number of channels in your output, and Audio:AudioPackingMode\n to specify the number of tracks and their relation to the channels. If you do not specify\n an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.

\n

The following values are valid:

\n

\n SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks\n

\n \n

When you specify SingleTrack, Elastic Transcoder creates a single track for your output. \n The track can have up to eight channels. Use SingleTrack for all non-mxf\n containers.

\n \n

The outputs of SingleTrack for a specific channel value and inputs \n are as follows:

\n \n \n\n

When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output\n can have up to eight single-channel tracks.

\n

The outputs of OneChannelPerTrack for a specific channel value and inputs\n are as follows:

\n \n\n

When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel \n tracks for your output. All tracks that do not contain audio data from an input channel are\n MOS, or Mit Out Sound, tracks.

\n

The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs\n are as follows:

\n " + } } }, "traits": { @@ -336,10 +336,10 @@ "com.amazonaws.elastictranscoder#CaptionFormat": { "type": "structure", "members": { - "Format": { - "target": "com.amazonaws.elastictranscoder#CaptionFormatFormat", + "Encryption": { + "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { - "smithy.api#documentation": "

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

\n " + "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

" } }, "Pattern": { @@ -348,10 +348,10 @@ "smithy.api#documentation": "

The prefix for caption filenames, in the form description-{language}, where:

\n \n

If you don't include {language} in the file name pattern, Elastic Transcoder automatically\n appends \"{language}\" to the value that you specify for the description. In addition,\n Elastic Transcoder automatically appends the count to the end of the segment files.

\n

For example, suppose you're transcoding into srt format. When you enter \"Sydney-{language}-sunrise\", \n and the language of the captions is English (en), the name of the first caption file is be \n Sydney-en-sunrise00000.srt.

" } }, - "Encryption": { - "target": "com.amazonaws.elastictranscoder#Encryption", + "Format": { + "target": "com.amazonaws.elastictranscoder#CaptionFormatFormat", "traits": { - "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

" + "smithy.api#documentation": "

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

\n " } } }, @@ -392,34 +392,34 @@ "com.amazonaws.elastictranscoder#CaptionSource": { "type": "structure", "members": { - "Label": { - "target": "com.amazonaws.elastictranscoder#Name", + "Key": { + "target": "com.amazonaws.elastictranscoder#LongKey", "traits": { - "smithy.api#documentation": "

The label of the caption shown in the player when choosing a language. We recommend that you \n put the caption language name here, in the language of the captions.

" + "smithy.api#documentation": "

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

" } }, - "TimeOffset": { - "target": "com.amazonaws.elastictranscoder#TimeOffset", + "Language": { + "target": "com.amazonaws.elastictranscoder#Key", "traits": { - "smithy.api#documentation": "

For clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode\n before including captions.

\n

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

" + "smithy.api#documentation": "

A string that specifies the language of the caption. If you specified multiple inputs with captions, \n the caption language must match in order to be included in the output. Specify this as one of:

\n \n

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

" } }, - "Encryption": { - "target": "com.amazonaws.elastictranscoder#Encryption", + "Label": { + "target": "com.amazonaws.elastictranscoder#Name", "traits": { - "smithy.api#documentation": "

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you \n want Elastic Transcoder to apply to your caption sources.

" + "smithy.api#documentation": "

The label of the caption shown in the player when choosing a language. We recommend that you \n put the caption language name here, in the language of the captions.

" } }, - "Key": { - "target": "com.amazonaws.elastictranscoder#LongKey", + "Encryption": { + "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { - "smithy.api#documentation": "

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

" + "smithy.api#documentation": "

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you \n want Elastic Transcoder to apply to your caption sources.

" } }, - "Language": { - "target": "com.amazonaws.elastictranscoder#Key", + "TimeOffset": { + "target": "com.amazonaws.elastictranscoder#TimeOffset", "traits": { - "smithy.api#documentation": "

A string that specifies the language of the caption. If you specified multiple inputs with captions, \n the caption language must match in order to be included in the output. Specify this as one of:

\n \n

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

" + "smithy.api#documentation": "

For clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode\n before including captions.

\n

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

" } } }, @@ -442,6 +442,13 @@ "com.amazonaws.elastictranscoder#Captions": { "type": "structure", "members": { + "CaptionSources": { + "target": "com.amazonaws.elastictranscoder#CaptionSources", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources blank.

" + } + }, "MergePolicy": { "target": "com.amazonaws.elastictranscoder#CaptionMergePolicy", "traits": { @@ -454,13 +461,6 @@ "traits": { "smithy.api#documentation": "

The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

" } - }, - "CaptionSources": { - "target": "com.amazonaws.elastictranscoder#CaptionSources", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources blank.

" - } } }, "traits": { @@ -555,23 +555,10 @@ "com.amazonaws.elastictranscoder#CreateJobOutput": { "type": "structure", "members": { - "ThumbnailPattern": { - "target": "com.amazonaws.elastictranscoder#ThumbnailPattern", - "traits": { - "smithy.api#documentation": "

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include \n in the file name for each thumbnail. You can specify the following values in any sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

" - } - }, - "ThumbnailEncryption": { + "Encryption": { "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { - "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" - } - }, - "Composition": { - "target": "com.amazonaws.elastictranscoder#Composition", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

You can create an output file that contains an excerpt from the input file. This excerpt, called a \n clip, can come from the beginning, middle, or end of the file. The Composition object contains settings \n for the clips that make up an output file. For the current release, you can only specify settings for a \n single clip per output file. The Composition object cannot be null.

" + "smithy.api#documentation": "

You can specify encryption settings for any output files that you want to use for a \n transcoding job. This includes the output file and any watermarks, thumbnails, album art, \n or captions that you want to use. You must specify encryption settings for each file \n individually.

" } }, "AlbumArt": { @@ -580,28 +567,16 @@ "smithy.api#documentation": "

Information about the album art that you want Elastic Transcoder to add to the file during transcoding. \n You can specify up to twenty album artworks for each output. Settings for each artwork must be \n defined in the job for the current output.

" } }, - "Key": { - "target": "com.amazonaws.elastictranscoder#Key", - "traits": { - "smithy.api#documentation": "

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID. If a file with the specified name already exists in the output bucket,\n the job fails.

" - } - }, - "SegmentDuration": { - "target": "com.amazonaws.elastictranscoder#FloatString", - "traits": { - "smithy.api#documentation": "\n

(Outputs in Fragmented MP4 or MPEG-TS format only.

\n \n

If you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or\n ts (MPEG-TS), SegmentDuration is the target maximum duration of\n each segment in seconds. For HLSv3 format playlists,\n each media segment is stored in a separate .ts file. For HLSv4 and Smooth\n playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of\n the SegmentDuration, though individual segments might be shorter or longer.

\n\n

The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration.

\n

Elastic Transcoder\n creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in the OutputKeys of\n the associated playlist.

" - } - }, "Rotate": { "target": "com.amazonaws.elastictranscoder#Rotate", "traits": { "smithy.api#documentation": "

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values: auto, 0,\n 90, 180, 270. The value auto\n generally works only if the file that you're transcoding contains rotation metadata.\n

" } }, - "Encryption": { - "target": "com.amazonaws.elastictranscoder#Encryption", + "Watermarks": { + "target": "com.amazonaws.elastictranscoder#JobWatermarks", "traits": { - "smithy.api#documentation": "

You can specify encryption settings for any output files that you want to use for a \n transcoding job. This includes the output file and any watermarks, thumbnails, album art, \n or captions that you want to use. You must specify encryption settings for each file \n individually.

" + "smithy.api#documentation": "

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. \n You can specify up to four watermarks for each output. Settings for each watermark must be defined \n in the preset for the current output.

" } }, "PresetId": { @@ -616,10 +591,35 @@ "smithy.api#documentation": "

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All \n captions must be in UTF-8. Elastic Transcoder supports two types of captions:

\n \n

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

\n

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures \n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does \n not preserve text formatting (for example, italics) during the transcoding process.

\n

To remove captions or leave the captions empty, set Captions to null. To pass through\n existing captions unchanged, set the MergePolicy to MergeRetain,\n and pass in a null CaptionSources array.

\n

For more information on embedded files, see the Subtitles Wikipedia page.

\n

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" } }, - "Watermarks": { - "target": "com.amazonaws.elastictranscoder#JobWatermarks", + "Composition": { + "target": "com.amazonaws.elastictranscoder#Composition", "traits": { - "smithy.api#documentation": "

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. \n You can specify up to four watermarks for each output. Settings for each watermark must be defined \n in the preset for the current output.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

You can create an output file that contains an excerpt from the input file. This excerpt, called a \n clip, can come from the beginning, middle, or end of the file. The Composition object contains settings \n for the clips that make up an output file. For the current release, you can only specify settings for a \n single clip per output file. The Composition object cannot be null.

" + } + }, + "ThumbnailPattern": { + "target": "com.amazonaws.elastictranscoder#ThumbnailPattern", + "traits": { + "smithy.api#documentation": "

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include \n in the file name for each thumbnail. You can specify the following values in any sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

" + } + }, + "ThumbnailEncryption": { + "target": "com.amazonaws.elastictranscoder#Encryption", + "traits": { + "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" + } + }, + "Key": { + "target": "com.amazonaws.elastictranscoder#Key", + "traits": { + "smithy.api#documentation": "

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID. If a file with the specified name already exists in the output bucket,\n the job fails.

" + } + }, + "SegmentDuration": { + "target": "com.amazonaws.elastictranscoder#FloatString", + "traits": { + "smithy.api#documentation": "\n

(Outputs in Fragmented MP4 or MPEG-TS format only.

\n \n

If you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or\n ts (MPEG-TS), SegmentDuration is the target maximum duration of\n each segment in seconds. For HLSv3 format playlists,\n each media segment is stored in a separate .ts file. For HLSv4 and Smooth\n playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of\n the SegmentDuration, though individual segments might be shorter or longer.

\n\n

The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration.

\n

Elastic Transcoder\n creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in the OutputKeys of\n the associated playlist.

" } } }, @@ -642,18 +642,6 @@ "com.amazonaws.elastictranscoder#CreateJobPlaylist": { "type": "structure", "members": { - "PlayReadyDrm": { - "target": "com.amazonaws.elastictranscoder#PlayReadyDrm", - "traits": { - "smithy.api#documentation": "

The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" - } - }, - "Format": { - "target": "com.amazonaws.elastictranscoder#PlaylistFormat", - "traits": { - "smithy.api#documentation": "

The format of the output playlist. Valid formats include HLSv3, \n HLSv4, and Smooth.

" - } - }, "Name": { "target": "com.amazonaws.elastictranscoder#Filename", "traits": { @@ -666,11 +654,23 @@ "smithy.api#documentation": "

For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object.

\n \n\n

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a \n file extension in Output Key, the file name will have two extensions.

\n\n

If you include more than one output in a playlist,\n any segment duration settings, clip settings, or caption settings must be the\n same for all outputs in the playlist. For Smooth playlists, the Audio:Profile,\n Video:Profile, and Video:FrameRate to\n Video:KeyframesMaxDist ratio must be the same for all outputs.

" } }, + "Format": { + "target": "com.amazonaws.elastictranscoder#PlaylistFormat", + "traits": { + "smithy.api#documentation": "

The format of the output playlist. Valid formats include HLSv3, \n HLSv4, and Smooth.

" + } + }, "HlsContentProtection": { "target": "com.amazonaws.elastictranscoder#HlsContentProtection", "traits": { "smithy.api#documentation": "

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output \n files associated with this playlist.

" } + }, + "PlayReadyDrm": { + "target": "com.amazonaws.elastictranscoder#PlayReadyDrm", + "traits": { + "smithy.api#documentation": "

The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + } } }, "traits": { @@ -692,12 +692,6 @@ "com.amazonaws.elastictranscoder#CreateJobRequest": { "type": "structure", "members": { - "Playlists": { - "target": "com.amazonaws.elastictranscoder#CreateJobPlaylists", - "traits": { - "smithy.api#documentation": "

If you specify a preset in PresetId for which the value of\n Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains \n information about the master playlists that you want Elastic Transcoder to create.

\n

The maximum number of master playlists in a job is 30.

" - } - }, "PipelineId": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { @@ -705,24 +699,6 @@ "smithy.api#required": {} } }, - "OutputKeyPrefix": { - "target": "com.amazonaws.elastictranscoder#Key", - "traits": { - "smithy.api#documentation": "

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this \n job creates, including output files, thumbnails, and playlists.

" - } - }, - "Input": { - "target": "com.amazonaws.elastictranscoder#JobInput", - "traits": { - "smithy.api#documentation": "

A section of the request body that provides information about the file that is being\n transcoded.

" - } - }, - "Output": { - "target": "com.amazonaws.elastictranscoder#CreateJobOutput", - "traits": { - "smithy.api#documentation": "

A section of the request body that provides information about the transcoded (target)\n file. We strongly recommend that you use the Outputs syntax instead of the\n Output syntax.

" - } - }, "Outputs": { "target": "com.amazonaws.elastictranscoder#CreateJobOutputs", "traits": { @@ -735,13 +711,37 @@ "smithy.api#documentation": "

User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in \n key/value pairs, and you can add up to 10 key/value pairs per job. \n Elastic Transcoder does not guarantee that key/value pairs are returned in the same \n order in which you specify them.

" } }, + "Playlists": { + "target": "com.amazonaws.elastictranscoder#CreateJobPlaylists", + "traits": { + "smithy.api#documentation": "

If you specify a preset in PresetId for which the value of\n Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains \n information about the master playlists that you want Elastic Transcoder to create.

\n

The maximum number of master playlists in a job is 30.

" + } + }, "Inputs": { "target": "com.amazonaws.elastictranscoder#JobInputs", "traits": { "smithy.api#documentation": "

A section of the request body that provides information about the files that are being \n transcoded.

" } - } - }, + }, + "Input": { + "target": "com.amazonaws.elastictranscoder#JobInput", + "traits": { + "smithy.api#documentation": "

A section of the request body that provides information about the file that is being\n transcoded.

" + } + }, + "Output": { + "target": "com.amazonaws.elastictranscoder#CreateJobOutput", + "traits": { + "smithy.api#documentation": "

A section of the request body that provides information about the transcoded (target)\n file. We strongly recommend that you use the Outputs syntax instead of the\n Output syntax.

" + } + }, + "OutputKeyPrefix": { + "target": "com.amazonaws.elastictranscoder#Key", + "traits": { + "smithy.api#documentation": "

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this \n job creates, including output files, thumbnails, and playlists.

" + } + } + }, "traits": { "smithy.api#documentation": "

The CreateJobRequest structure.

" } @@ -800,30 +800,30 @@ "com.amazonaws.elastictranscoder#CreatePipelineRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.elastictranscoder#Name", + "AwsKmsKeyArn": { + "target": "com.amazonaws.elastictranscoder#KeyArn", "traits": { - "smithy.api#documentation": "

The name of the pipeline. We recommend that the name be unique within the AWS account, \n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

\n

If you use either s3 or s3-aws-kms as your \n Encryption:Mode, you don't need to provide a key with\n your job because a default key, known as an AWS-KMS key, is created for you automatically.\n You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are\n using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.

" } }, - "ContentConfig": { - "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", + "Role": { + "target": "com.amazonaws.elastictranscoder#Role", "traits": { - "smithy.api#documentation": "

The optional ContentConfig object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n " + "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

", + "smithy.api#required": {} } }, - "Notifications": { - "target": "com.amazonaws.elastictranscoder#Notifications", + "InputBucket": { + "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { - "smithy.api#documentation": "

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n \n

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

\n \n " + "smithy.api#documentation": "

The Amazon S3 bucket in which you saved the media files that you want to transcode.

", + "smithy.api#required": {} } }, - "Role": { - "target": "com.amazonaws.elastictranscoder#Role", + "OutputBucket": { + "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { - "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use \n\t\t this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

\n

Specify this value when all of the following are true:

\n\t\t \n\n

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket\n and specify values for ContentConfig and ThumbnailConfig\n instead.

" } }, "ThumbnailConfig": { @@ -832,23 +832,23 @@ "smithy.api#documentation": "

The ThumbnailConfig object specifies several values, including the Amazon S3\n bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have\n access to the files, the type of access you want users to have, and the storage class\n that you want to assign to the files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig even if you don't want to create thumbnails.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n " } }, - "OutputBucket": { - "target": "com.amazonaws.elastictranscoder#BucketName", + "Name": { + "target": "com.amazonaws.elastictranscoder#Name", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use \n\t\t this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

\n

Specify this value when all of the following are true:

\n\t\t \n\n

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket\n and specify values for ContentConfig and ThumbnailConfig\n instead.

" + "smithy.api#documentation": "

The name of the pipeline. We recommend that the name be unique within the AWS account, \n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters.

", + "smithy.api#required": {} } }, - "InputBucket": { - "target": "com.amazonaws.elastictranscoder#BucketName", + "ContentConfig": { + "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket in which you saved the media files that you want to transcode.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The optional ContentConfig object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n " } }, - "AwsKmsKeyArn": { - "target": "com.amazonaws.elastictranscoder#KeyArn", + "Notifications": { + "target": "com.amazonaws.elastictranscoder#Notifications", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

\n

If you use either s3 or s3-aws-kms as your \n Encryption:Mode, you don't need to provide a key with\n your job because a default key, known as an AWS-KMS key, is created for you automatically.\n You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are\n using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.

" + "smithy.api#documentation": "

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n \n

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

\n \n " } } }, @@ -859,17 +859,17 @@ "com.amazonaws.elastictranscoder#CreatePipelineResponse": { "type": "structure", "members": { - "Pipeline": { - "target": "com.amazonaws.elastictranscoder#Pipeline", - "traits": { - "smithy.api#documentation": "

A section of the response body that provides information about the pipeline that is created.

" - } - }, "Warnings": { "target": "com.amazonaws.elastictranscoder#Warnings", "traits": { "smithy.api#documentation": "

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as \n the pipeline.

\n

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and \n AWS KMS key, reduces processing time and prevents cross-regional charges.

" } + }, + "Pipeline": { + "target": "com.amazonaws.elastictranscoder#Pipeline", + "traits": { + "smithy.api#documentation": "

A section of the response body that provides information about the pipeline that is created.

" + } } }, "traits": { @@ -913,19 +913,6 @@ "com.amazonaws.elastictranscoder#CreatePresetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.elastictranscoder#Name", - "traits": { - "smithy.api#documentation": "

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.elastictranscoder#Description", - "traits": { - "smithy.api#documentation": "

A description of the preset.

" - } - }, "Container": { "target": "com.amazonaws.elastictranscoder#PresetContainer", "traits": { @@ -933,6 +920,12 @@ "smithy.api#required": {} } }, + "Audio": { + "target": "com.amazonaws.elastictranscoder#AudioParameters", + "traits": { + "smithy.api#documentation": "

A section of the request body that specifies the audio parameters.

" + } + }, "Video": { "target": "com.amazonaws.elastictranscoder#VideoParameters", "traits": { @@ -945,10 +938,17 @@ "smithy.api#documentation": "

A section of the request body that specifies the thumbnail parameters, if any.

" } }, - "Audio": { - "target": "com.amazonaws.elastictranscoder#AudioParameters", + "Name": { + "target": "com.amazonaws.elastictranscoder#Name", "traits": { - "smithy.api#documentation": "

A section of the request body that specifies the audio parameters.

" + "smithy.api#documentation": "

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.elastictranscoder#Description", + "traits": { + "smithy.api#documentation": "

A description of the preset.

" } } }, @@ -959,17 +959,17 @@ "com.amazonaws.elastictranscoder#CreatePresetResponse": { "type": "structure", "members": { - "Preset": { - "target": "com.amazonaws.elastictranscoder#Preset", - "traits": { - "smithy.api#documentation": "

A section of the response body that provides information about the preset that is created.

" - } - }, "Warning": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "

If the preset settings don't comply with the standards for the video codec but Elastic Transcoder \n created the preset, this message explains the reason the preset settings don't meet the \n standard. Elastic Transcoder created the preset because the settings might produce \n acceptable output.

" } + }, + "Preset": { + "target": "com.amazonaws.elastictranscoder#Preset", + "traits": { + "smithy.api#documentation": "

A section of the response body that provides information about the preset that is created.

" + } } }, "traits": { @@ -1105,16 +1105,16 @@ "com.amazonaws.elastictranscoder#DetectedProperties": { "type": "structure", "members": { - "Width": { - "target": "com.amazonaws.elastictranscoder#NullableInteger", + "DurationMillis": { + "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { - "smithy.api#documentation": "

The detected width of the input file, in pixels.

" + "smithy.api#documentation": "

The detected duration of the input file, in milliseconds.

" } }, - "FileSize": { - "target": "com.amazonaws.elastictranscoder#NullableLong", + "FrameRate": { + "target": "com.amazonaws.elastictranscoder#FloatString", "traits": { - "smithy.api#documentation": "

The detected file size of the input file, in bytes.

" + "smithy.api#documentation": "

The detected frame rate of the input file, in frames per second.

" } }, "Height": { @@ -1123,16 +1123,16 @@ "smithy.api#documentation": "

The detected height of the input file, in pixels.

" } }, - "DurationMillis": { - "target": "com.amazonaws.elastictranscoder#NullableLong", + "Width": { + "target": "com.amazonaws.elastictranscoder#NullableInteger", "traits": { - "smithy.api#documentation": "

The detected duration of the input file, in milliseconds.

" + "smithy.api#documentation": "

The detected width of the input file, in pixels.

" } }, - "FrameRate": { - "target": "com.amazonaws.elastictranscoder#FloatString", + "FileSize": { + "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { - "smithy.api#documentation": "

The detected frame rate of the input file, in frames per second.

" + "smithy.api#documentation": "

The detected file size of the input file, in bytes.

" } } }, @@ -1155,10 +1155,10 @@ "com.amazonaws.elastictranscoder#Encryption": { "type": "structure", "members": { - "Mode": { - "target": "com.amazonaws.elastictranscoder#EncryptionMode", + "InitializationVector": { + "target": "com.amazonaws.elastictranscoder#ZeroTo255String", "traits": { - "smithy.api#documentation": "

The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting \n your input files or encrypting your output files. Elastic Transcoder supports the following options:

\n \n

For all three AES options, you must provide the following settings, which must be base64-encoded:

\n \n \n

For the AES modes, your private encryption keys and your unencrypted data are never \n stored by AWS; therefore, it is important that you safely manage your encryption keys. \n If you lose them, you won't be able to unencrypt your data.

\n " + "smithy.api#documentation": "

The series of random bits created by a random bit generator, unique for every encryption \n operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt \n your output files. The initialization vector must be base64-encoded, and it must be exactly \n 16 bytes long before being base64-encoded.

" } }, "Key": { @@ -1167,16 +1167,16 @@ "smithy.api#documentation": "

The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that \n was used to encrypt your input file. The key must be base64-encoded and it must be one of the \n following bit lengths before being base64-encoded:

\n

\n 128, 192, or 256.

\n

The key must also be encrypted by using the Amazon Key Management Service.

" } }, - "KeyMd5": { - "target": "com.amazonaws.elastictranscoder#Base64EncodedString", + "Mode": { + "target": "com.amazonaws.elastictranscoder#EncryptionMode", "traits": { - "smithy.api#documentation": "

The MD5 digest of the key that you used to encrypt your input file, or that you want \n Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a \n checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, \n and it must be exactly 16 bytes long before being base64-encoded.

" + "smithy.api#documentation": "

The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting \n your input files or encrypting your output files. Elastic Transcoder supports the following options:

\n \n

For all three AES options, you must provide the following settings, which must be base64-encoded:

\n \n \n

For the AES modes, your private encryption keys and your unencrypted data are never \n stored by AWS; therefore, it is important that you safely manage your encryption keys. \n If you lose them, you won't be able to unencrypt your data.

\n " } }, - "InitializationVector": { - "target": "com.amazonaws.elastictranscoder#ZeroTo255String", + "KeyMd5": { + "target": "com.amazonaws.elastictranscoder#Base64EncodedString", "traits": { - "smithy.api#documentation": "

The series of random bits created by a random bit generator, unique for every encryption \n operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt \n your output files. The initialization vector must be base64-encoded, and it must be exactly \n 16 bytes long before being base64-encoded.

" + "smithy.api#documentation": "

The MD5 digest of the key that you used to encrypt your input file, or that you want \n Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a \n checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, \n and it must be exactly 16 bytes long before being base64-encoded.

" } } }, @@ -1251,7 +1251,7 @@ "sdkId": "Elastic Transcoder", "arnNamespace": "elastictranscoder", "cloudFormationName": "ElasticTranscoder", - "cloudTrailEventSource": "v20120925.etscustomer.amazonaws.com" + "cloudTrailEventSource": "elastictranscoder.amazonaws.com" }, "aws.auth#sigv4": { "name": "elastictranscoder" @@ -1318,40 +1318,40 @@ "com.amazonaws.elastictranscoder#HlsContentProtection": { "type": "structure", "members": { - "KeyMd5": { - "target": "com.amazonaws.elastictranscoder#Base64EncodedString", + "InitializationVector": { + "target": "com.amazonaws.elastictranscoder#ZeroTo255String", "traits": { - "smithy.api#documentation": "

If Elastic Transcoder is generating your key for you, you must leave this field blank.

\n

The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want \n Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be \n base64-encoded, and it must be exactly 16 bytes before being base64- encoded.

" + "smithy.api#documentation": "

If Elastic Transcoder is generating your key for you, you must leave this field blank.

\n

The series of random bits created by a random bit generator, unique for every encryption operation, \n that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, \n and it must be exactly 16 bytes before being base64-encoded.

" } }, - "LicenseAcquisitionUrl": { - "target": "com.amazonaws.elastictranscoder#ZeroTo512String", + "Method": { + "target": "com.amazonaws.elastictranscoder#HlsContentProtectionMethod", "traits": { - "smithy.api#documentation": "

The location of the license key required to decrypt your HLS playlist. The URL must be an absolute \n path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.

" + "smithy.api#documentation": "

The content protection method for your output. The only valid value is:\naes-128.

\n

This value is written into the method attribute of the EXT-X-KEY metadata tag in the output\nplaylist.

" } }, - "Key": { + "KeyMd5": { "target": "com.amazonaws.elastictranscoder#Base64EncodedString", "traits": { - "smithy.api#documentation": "

If you want Elastic Transcoder to generate a key for you, leave this field blank.

\n

If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be \n base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

\n

\n 128, 192, or 256.

" + "smithy.api#documentation": "

If Elastic Transcoder is generating your key for you, you must leave this field blank.

\n

The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want \n Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be \n base64-encoded, and it must be exactly 16 bytes before being base64- encoded.

" } }, - "KeyStoragePolicy": { - "target": "com.amazonaws.elastictranscoder#KeyStoragePolicy", + "Key": { + "target": "com.amazonaws.elastictranscoder#Base64EncodedString", "traits": { - "smithy.api#documentation": "

Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If \nyou choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder \nwrites your data key into the same bucket as the associated playlist.

" + "smithy.api#documentation": "

If you want Elastic Transcoder to generate a key for you, leave this field blank.

\n

If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be \n base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

\n

\n 128, 192, or 256.

" } }, - "Method": { - "target": "com.amazonaws.elastictranscoder#HlsContentProtectionMethod", + "LicenseAcquisitionUrl": { + "target": "com.amazonaws.elastictranscoder#ZeroTo512String", "traits": { - "smithy.api#documentation": "

The content protection method for your output. The only valid value is:\naes-128.

\n

This value is written into the method attribute of the EXT-X-KEY metadata tag in the output\nplaylist.

" + "smithy.api#documentation": "

The location of the license key required to decrypt your HLS playlist. The URL must be an absolute \n path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.

" } }, - "InitializationVector": { - "target": "com.amazonaws.elastictranscoder#ZeroTo255String", + "KeyStoragePolicy": { + "target": "com.amazonaws.elastictranscoder#KeyStoragePolicy", "traits": { - "smithy.api#documentation": "

If Elastic Transcoder is generating your key for you, you must leave this field blank.

\n

The series of random bits created by a random bit generator, unique for every encryption operation, \n that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, \n and it must be exactly 16 bytes before being base64-encoded.

" + "smithy.api#documentation": "

Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If \nyou choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder \nwrites your data key into the same bucket as the associated playlist.

" } } }, @@ -1395,17 +1395,17 @@ "com.amazonaws.elastictranscoder#InputCaptions": { "type": "structure", "members": { - "CaptionSources": { - "target": "com.amazonaws.elastictranscoder#CaptionSources", - "traits": { - "smithy.api#documentation": "

Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources blank.

" - } - }, "MergePolicy": { "target": "com.amazonaws.elastictranscoder#CaptionMergePolicy", "traits": { "smithy.api#documentation": "

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

\n \n

\n MergePolicy cannot be null.

" } + }, + "CaptionSources": { + "target": "com.amazonaws.elastictranscoder#CaptionSources", + "traits": { + "smithy.api#documentation": "

Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources blank.

" + } } }, "traits": { @@ -1436,30 +1436,6 @@ "com.amazonaws.elastictranscoder#Job": { "type": "structure", "members": { - "Input": { - "target": "com.amazonaws.elastictranscoder#JobInput", - "traits": { - "smithy.api#documentation": "

A section of the request or response body that provides information about the file that is being transcoded.

" - } - }, - "Inputs": { - "target": "com.amazonaws.elastictranscoder#JobInputs", - "traits": { - "smithy.api#documentation": "

Information about the files that you're transcoding. If you specified multiple files for this \n job, Elastic Transcoder stitches the files together to make one output.

" - } - }, - "Arn": { - "target": "com.amazonaws.elastictranscoder#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the job.

" - } - }, - "Id": { - "target": "com.amazonaws.elastictranscoder#Id", - "traits": { - "smithy.api#documentation": "

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

" - } - }, "Outputs": { "target": "com.amazonaws.elastictranscoder#JobOutputs", "traits": { @@ -1472,12 +1448,6 @@ "smithy.api#documentation": "

User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in\n key/value pairs, and you can add up to 10 key/value pairs per job.\n Elastic Transcoder does not guarantee that key/value pairs are returned in the same\n order in which you specify them.

\n

Metadata keys and values must use characters from the following list:

\n " } }, - "Playlists": { - "target": "com.amazonaws.elastictranscoder#Playlists", - "traits": { - "smithy.api#documentation": "\n

Outputs in Fragmented MP4 or MPEG-TS format only.

\n \n\t\t

If you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),\n Playlists contains information about the master playlists that you want\n Elastic Transcoder to create.

\n

The maximum number of master playlists in a job is 30.

" - } - }, "Timing": { "target": "com.amazonaws.elastictranscoder#Timing", "traits": { @@ -1507,6 +1477,36 @@ "traits": { "smithy.api#documentation": "

The status of the job: Submitted, Progressing, Complete,\n Canceled, or Error.

" } + }, + "Input": { + "target": "com.amazonaws.elastictranscoder#JobInput", + "traits": { + "smithy.api#documentation": "

A section of the request or response body that provides information about the file that is being transcoded.

" + } + }, + "Id": { + "target": "com.amazonaws.elastictranscoder#Id", + "traits": { + "smithy.api#documentation": "

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

" + } + }, + "Playlists": { + "target": "com.amazonaws.elastictranscoder#Playlists", + "traits": { + "smithy.api#documentation": "\n

Outputs in Fragmented MP4 or MPEG-TS format only.

\n \n\t\t

If you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),\n Playlists contains information about the master playlists that you want\n Elastic Transcoder to create.

\n

The maximum number of master playlists in a job is 30.

" + } + }, + "Inputs": { + "target": "com.amazonaws.elastictranscoder#JobInputs", + "traits": { + "smithy.api#documentation": "

Information about the files that you're transcoding. If you specified multiple files for this \n job, Elastic Transcoder stitches the files together to make one output.

" + } + }, + "Arn": { + "target": "com.amazonaws.elastictranscoder#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the job.

" + } } }, "traits": { @@ -1516,17 +1516,17 @@ "com.amazonaws.elastictranscoder#JobAlbumArt": { "type": "structure", "members": { - "Artwork": { - "target": "com.amazonaws.elastictranscoder#Artworks", - "traits": { - "smithy.api#documentation": "

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png\n

" - } - }, "MergePolicy": { "target": "com.amazonaws.elastictranscoder#MergePolicy", "traits": { "smithy.api#documentation": "

A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files.

\n \n " } + }, + "Artwork": { + "target": "com.amazonaws.elastictranscoder#Artworks", + "traits": { + "smithy.api#documentation": "

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png\n

" + } } }, "traits": { @@ -1542,16 +1542,16 @@ "com.amazonaws.elastictranscoder#JobInput": { "type": "structure", "members": { - "Encryption": { - "target": "com.amazonaws.elastictranscoder#Encryption", + "Interlaced": { + "target": "com.amazonaws.elastictranscoder#Interlaced", "traits": { - "smithy.api#documentation": "

The encryption settings, if any, that are used for decrypting your input files. If \n your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

" + "smithy.api#documentation": "

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto. If you want to specify whether\n the input file is interlaced, enter one of the following values:

\n

\n true, false\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n interlacing.

" } }, - "Resolution": { - "target": "com.amazonaws.elastictranscoder#Resolution", + "AspectRatio": { + "target": "com.amazonaws.elastictranscoder#AspectRatio", "traits": { - "smithy.api#documentation": "

This value must be auto, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.

" + "smithy.api#documentation": "

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto. If you want to specify the aspect\n ratio for the output file, enter one of the following values:

\n

\n 1:1, 4:3, 3:2, 16:9\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection\n of the aspect ratio.

" } }, "TimeSpan": { @@ -1560,46 +1560,46 @@ "smithy.api#documentation": "

Settings for clipping an input. Each input can have different clip settings.

" } }, - "Container": { - "target": "com.amazonaws.elastictranscoder#JobContainer", + "FrameRate": { + "target": "com.amazonaws.elastictranscoder#FrameRate", "traits": { - "smithy.api#documentation": "

The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto. If you want to specify the\n container type for the input file, enter one of the following values:

\n

\n 3gp, aac, asf, avi, \n divx, flv, m4a, mkv, \n mov, mp3, mp4, mpeg, \n mpeg-ps, mpeg-ts, mxf, ogg, \n vob, wav, webm\n

" + "smithy.api#documentation": "

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto. If you want to specify the frame rate for\n the input file, enter one of the following values:

\n

\n 10, 15, 23.97, 24, 25,\n 29.97, 30, 60\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n the frame rate.

" } }, - "Key": { - "target": "com.amazonaws.elastictranscoder#LongKey", + "InputCaptions": { + "target": "com.amazonaws.elastictranscoder#InputCaptions", "traits": { - "smithy.api#documentation": "

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

\n

If the file name includes a prefix, such as cooking/lasagna.mpg, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" + "smithy.api#documentation": "

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. \n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

\n \n

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

\n

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures \n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does \n not preserve text formatting (for example, italics) during the transcoding process.

\n

To remove captions or leave the captions empty, set Captions to null. To pass through\n existing captions unchanged, set the MergePolicy to MergeRetain,\n and pass in a null CaptionSources array.

\n

For more information on embedded files, see the Subtitles Wikipedia page.

\n

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" } }, - "DetectedProperties": { - "target": "com.amazonaws.elastictranscoder#DetectedProperties", + "Encryption": { + "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { - "smithy.api#documentation": "

The detected properties of the input file.

" + "smithy.api#documentation": "

The encryption settings, if any, that are used for decrypting your input files. If \n your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

" } }, - "Interlaced": { - "target": "com.amazonaws.elastictranscoder#Interlaced", + "Resolution": { + "target": "com.amazonaws.elastictranscoder#Resolution", "traits": { - "smithy.api#documentation": "

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto. If you want to specify whether\n the input file is interlaced, enter one of the following values:

\n

\n true, false\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n interlacing.

" + "smithy.api#documentation": "

This value must be auto, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.

" } }, - "AspectRatio": { - "target": "com.amazonaws.elastictranscoder#AspectRatio", + "Key": { + "target": "com.amazonaws.elastictranscoder#LongKey", "traits": { - "smithy.api#documentation": "

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto. If you want to specify the aspect\n ratio for the output file, enter one of the following values:

\n

\n 1:1, 4:3, 3:2, 16:9\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection\n of the aspect ratio.

" + "smithy.api#documentation": "

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

\n

If the file name includes a prefix, such as cooking/lasagna.mpg, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" } }, - "FrameRate": { - "target": "com.amazonaws.elastictranscoder#FrameRate", + "Container": { + "target": "com.amazonaws.elastictranscoder#JobContainer", "traits": { - "smithy.api#documentation": "

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto. If you want to specify the frame rate for\n the input file, enter one of the following values:

\n

\n 10, 15, 23.97, 24, 25,\n 29.97, 30, 60\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n the frame rate.

" + "smithy.api#documentation": "

The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto. If you want to specify the\n container type for the input file, enter one of the following values:

\n

\n 3gp, aac, asf, avi, \n divx, flv, m4a, mkv, \n mov, mp3, mp4, mpeg, \n mpeg-ps, mpeg-ts, mxf, ogg, \n vob, wav, webm\n

" } }, - "InputCaptions": { - "target": "com.amazonaws.elastictranscoder#InputCaptions", + "DetectedProperties": { + "target": "com.amazonaws.elastictranscoder#DetectedProperties", "traits": { - "smithy.api#documentation": "

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. \n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

\n \n

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

\n

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures \n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does \n not preserve text formatting (for example, italics) during the transcoding process.

\n

To remove captions or leave the captions empty, set Captions to null. To pass through\n existing captions unchanged, set the MergePolicy to MergeRetain,\n and pass in a null CaptionSources array.

\n

For more information on embedded files, see the Subtitles Wikipedia page.

\n

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" + "smithy.api#documentation": "

The detected properties of the input file.

" } } }, @@ -1622,40 +1622,34 @@ "com.amazonaws.elastictranscoder#JobOutput": { "type": "structure", "members": { - "ThumbnailEncryption": { - "target": "com.amazonaws.elastictranscoder#Encryption", - "traits": { - "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" - } - }, - "Duration": { + "FileSize": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { - "smithy.api#documentation": "

Duration of the output file, in seconds.

" + "smithy.api#documentation": "

File size of the output file, in bytes.

" } }, - "Captions": { - "target": "com.amazonaws.elastictranscoder#Captions", + "Encryption": { + "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { - "smithy.api#documentation": "

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. \n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

\n \n

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

\n

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures \n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does \n not preserve text formatting (for example, italics) during the transcoding process.

\n

To remove captions or leave the captions empty, set Captions to null. To pass through\n existing captions unchanged, set the MergePolicy to MergeRetain,\n and pass in a null CaptionSources array.

\n

For more information on embedded files, see the Subtitles Wikipedia page.

\n

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" + "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. \n If you choose to use encryption, you must specify a mode to use. If you choose not to \n use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.

" } }, - "Watermarks": { - "target": "com.amazonaws.elastictranscoder#JobWatermarks", + "Id": { + "target": "com.amazonaws.elastictranscoder#String", "traits": { - "smithy.api#documentation": "

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them \n in the job output—the first watermark in the list is added to the output video first, \n the second watermark in the list is added next, and so on. As a result, if the settings \n in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark \n that you add covers the first one, the third one covers the second, and the \n fourth one covers the third.

" + "smithy.api#documentation": "

A sequential counter, starting with 1, that identifies an output among the outputs from \n the current job. In the Output syntax, this value is always 1.

" } }, - "StatusDetail": { - "target": "com.amazonaws.elastictranscoder#Description", + "Rotate": { + "target": "com.amazonaws.elastictranscoder#Rotate", "traits": { - "smithy.api#documentation": "

Information that further explains Status.

" + "smithy.api#documentation": "

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative \n to the input. Enter one of the following values:

\n

\n auto, 0, 90, 180,\n 270\n

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

" } }, - "Encryption": { - "target": "com.amazonaws.elastictranscoder#Encryption", + "PresetId": { + "target": "com.amazonaws.elastictranscoder#Id", "traits": { - "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. \n If you choose to use encryption, you must specify a mode to use. If you choose not to \n use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.

" + "smithy.api#documentation": "

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

" } }, "SegmentDuration": { @@ -1664,10 +1658,16 @@ "smithy.api#documentation": "\n

(Outputs in Fragmented MP4 or MPEG-TS format only.

\n \n\t\t

If you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or \n ts (MPEG-TS), SegmentDuration is the target maximum duration of\n each segment in seconds. For HLSv3 format playlists,\n each media segment is stored in a separate .ts file. For HLSv4, MPEG-DASH, and Smooth\n playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of\n the SegmentDuration, though individual segments might be shorter or longer.

\n \n

The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration.

\n

Elastic Transcoder\n creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in the OutputKeys of \n the associated playlist.

" } }, - "DurationMillis": { + "Key": { + "target": "com.amazonaws.elastictranscoder#Key", + "traits": { + "smithy.api#documentation": "

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

" + } + }, + "Duration": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { - "smithy.api#documentation": "

Duration of the output file, in milliseconds.

" + "smithy.api#documentation": "

Duration of the output file, in seconds.

" } }, "Composition": { @@ -1677,76 +1677,76 @@ "smithy.api#documentation": "

You can create an output file that contains an excerpt from the input file. This excerpt, called \n a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings \n for the clips that make up an output file. For the current release, you can only specify settings for a \n single clip per output file. The Composition object cannot be null.

" } }, - "Status": { - "target": "com.amazonaws.elastictranscoder#JobStatus", + "FrameRate": { + "target": "com.amazonaws.elastictranscoder#FloatString", "traits": { - "smithy.api#documentation": "

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

\n\t\t\t \n\t\t\t

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

" + "smithy.api#documentation": "

Frame rate of the output file, in frames per second.

" } }, - "ThumbnailPattern": { - "target": "com.amazonaws.elastictranscoder#ThumbnailPattern", + "StatusDetail": { + "target": "com.amazonaws.elastictranscoder#Description", "traits": { - "smithy.api#documentation": "

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want \n Elastic Transcoder to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to \n include in the file name for each thumbnail. You can specify the following values in any sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

" + "smithy.api#documentation": "

Information that further explains Status.

" } }, - "Width": { + "Height": { "target": "com.amazonaws.elastictranscoder#NullableInteger", "traits": { - "smithy.api#documentation": "

Specifies the width of the output file in pixels.

" + "smithy.api#documentation": "

Height of the output file, in pixels.

" } }, - "AppliedColorSpaceConversion": { - "target": "com.amazonaws.elastictranscoder#String", + "AlbumArt": { + "target": "com.amazonaws.elastictranscoder#JobAlbumArt", "traits": { - "smithy.api#documentation": "

If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output\n file, the AppliedColorSpaceConversion parameter shows the conversion used. If no \n ColorSpaceConversionMode was defined in the preset, this parameter is not be \n included in the job response.

" + "smithy.api#documentation": "

The album art to be associated with the output file, if any.

" } }, - "Id": { - "target": "com.amazonaws.elastictranscoder#String", + "Width": { + "target": "com.amazonaws.elastictranscoder#NullableInteger", "traits": { - "smithy.api#documentation": "

A sequential counter, starting with 1, that identifies an output among the outputs from \n the current job. In the Output syntax, this value is always 1.

" + "smithy.api#documentation": "

Specifies the width of the output file in pixels.

" } }, - "Rotate": { - "target": "com.amazonaws.elastictranscoder#Rotate", + "AppliedColorSpaceConversion": { + "target": "com.amazonaws.elastictranscoder#String", "traits": { - "smithy.api#documentation": "

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative \n to the input. Enter one of the following values:

\n

\n auto, 0, 90, 180,\n 270\n

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

" + "smithy.api#documentation": "

If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output\n file, the AppliedColorSpaceConversion parameter shows the conversion used. If no \n ColorSpaceConversionMode was defined in the preset, this parameter is not be \n included in the job response.

" } }, - "FrameRate": { - "target": "com.amazonaws.elastictranscoder#FloatString", + "DurationMillis": { + "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { - "smithy.api#documentation": "

Frame rate of the output file, in frames per second.

" + "smithy.api#documentation": "

Duration of the output file, in milliseconds.

" } }, - "PresetId": { - "target": "com.amazonaws.elastictranscoder#Id", + "ThumbnailEncryption": { + "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { - "smithy.api#documentation": "

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

" + "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" } }, - "Height": { - "target": "com.amazonaws.elastictranscoder#NullableInteger", + "ThumbnailPattern": { + "target": "com.amazonaws.elastictranscoder#ThumbnailPattern", "traits": { - "smithy.api#documentation": "

Height of the output file, in pixels.

" + "smithy.api#documentation": "

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want \n Elastic Transcoder to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to \n include in the file name for each thumbnail. You can specify the following values in any sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

" } }, - "FileSize": { - "target": "com.amazonaws.elastictranscoder#NullableLong", + "Status": { + "target": "com.amazonaws.elastictranscoder#JobStatus", "traits": { - "smithy.api#documentation": "

File size of the output file, in bytes.

" + "smithy.api#documentation": "

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

\n\t\t\t \n\t\t\t

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

" } }, - "AlbumArt": { - "target": "com.amazonaws.elastictranscoder#JobAlbumArt", + "Watermarks": { + "target": "com.amazonaws.elastictranscoder#JobWatermarks", "traits": { - "smithy.api#documentation": "

The album art to be associated with the output file, if any.

" + "smithy.api#documentation": "

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them \n in the job output—the first watermark in the list is added to the output video first, \n the second watermark in the list is added next, and so on. As a result, if the settings \n in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark \n that you add covers the first one, the third one covers the second, and the \n fourth one covers the third.

" } }, - "Key": { - "target": "com.amazonaws.elastictranscoder#Key", + "Captions": { + "target": "com.amazonaws.elastictranscoder#Captions", "traits": { - "smithy.api#documentation": "

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

" + "smithy.api#documentation": "

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. \n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

\n \n

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

\n

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures \n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does \n not preserve text formatting (for example, italics) during the transcoding process.

\n

To remove captions or leave the captions empty, set Captions to null. To pass through\n existing captions unchanged, set the MergePolicy to MergeRetain,\n and pass in a null CaptionSources array.

\n

For more information on embedded files, see the Subtitles Wikipedia page.

\n

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" } } }, @@ -1769,6 +1769,12 @@ "com.amazonaws.elastictranscoder#JobWatermark": { "type": "structure", "members": { + "PresetWatermarkId": { + "target": "com.amazonaws.elastictranscoder#PresetWatermarkId", + "traits": { + "smithy.api#documentation": "

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. \n The settings are in the preset specified by Preset for the current output. In that preset, the value \n of Watermarks Id tells Elastic Transcoder which settings to use.

" + } + }, "InputKey": { "target": "com.amazonaws.elastictranscoder#WatermarkKey", "traits": { @@ -1780,12 +1786,6 @@ "traits": { "smithy.api#documentation": "

The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.

" } - }, - "PresetWatermarkId": { - "target": "com.amazonaws.elastictranscoder#PresetWatermarkId", - "traits": { - "smithy.api#documentation": "

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. \n The settings are in the preset specified by Preset for the current output. In that preset, the value \n of Watermarks Id tells Elastic Transcoder which settings to use.

" - } } }, "traits": { @@ -1904,13 +1904,6 @@ "com.amazonaws.elastictranscoder#ListJobsByPipelineRequest": { "type": "structure", "members": { - "Ascending": { - "target": "com.amazonaws.elastictranscoder#Ascending", - "traits": { - "smithy.api#documentation": "

To list jobs in chronological order by the date and time that they were submitted, enter\n true. To list jobs in reverse chronological order, enter\n false.

", - "smithy.api#httpQuery": "Ascending" - } - }, "PipelineId": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { @@ -1925,6 +1918,13 @@ "smithy.api#documentation": "

When Elastic Transcoder returns more than one page of results, use pageToken in\n subsequent GET requests to get each successive page of results.

", "smithy.api#httpQuery": "PageToken" } + }, + "Ascending": { + "target": "com.amazonaws.elastictranscoder#Ascending", + "traits": { + "smithy.api#documentation": "

To list jobs in chronological order by the date and time that they were submitted, enter\n true. To list jobs in reverse chronological order, enter\n false.

", + "smithy.api#httpQuery": "Ascending" + } } }, "traits": { @@ -1993,6 +1993,13 @@ "com.amazonaws.elastictranscoder#ListJobsByStatusRequest": { "type": "structure", "members": { + "PageToken": { + "target": "com.amazonaws.elastictranscoder#Id", + "traits": { + "smithy.api#documentation": "

When Elastic Transcoder returns more than one page of results, use pageToken in\n subsequent GET requests to get each successive page of results.

", + "smithy.api#httpQuery": "PageToken" + } + }, "Ascending": { "target": "com.amazonaws.elastictranscoder#Ascending", "traits": { @@ -2007,13 +2014,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "PageToken": { - "target": "com.amazonaws.elastictranscoder#Id", - "traits": { - "smithy.api#documentation": "

When Elastic Transcoder returns more than one page of results, use pageToken in\n subsequent GET requests to get each successive page of results.

", - "smithy.api#httpQuery": "PageToken" - } } }, "traits": { @@ -2101,17 +2101,17 @@ "com.amazonaws.elastictranscoder#ListPipelinesResponse": { "type": "structure", "members": { - "Pipelines": { - "target": "com.amazonaws.elastictranscoder#Pipelines", - "traits": { - "smithy.api#documentation": "

An array of Pipeline objects.

" - } - }, "NextPageToken": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "

A value that you use to access the second and subsequent pages of results, if any. When\n the pipelines fit on one page or when you've reached the last page\n of results, the value of NextPageToken is null.

" } + }, + "Pipelines": { + "target": "com.amazonaws.elastictranscoder#Pipelines", + "traits": { + "smithy.api#documentation": "

An array of Pipeline objects.

" + } } }, "traits": { @@ -2241,12 +2241,6 @@ "smithy.api#documentation": "

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

" } }, - "Completed": { - "target": "com.amazonaws.elastictranscoder#SnsTopic", - "traits": { - "smithy.api#documentation": "

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

" - } - }, "Error": { "target": "com.amazonaws.elastictranscoder#SnsTopic", "traits": { @@ -2258,6 +2252,12 @@ "traits": { "smithy.api#documentation": "

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

" } + }, + "Completed": { + "target": "com.amazonaws.elastictranscoder#SnsTopic", + "traits": { + "smithy.api#documentation": "

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

" + } } }, "traits": { @@ -2318,17 +2318,17 @@ "smithy.api#documentation": "

The AWS user or group that you want to have access to transcoded files and playlists. To \n identify the user or group, you can specify the canonical user ID for an AWS account, an origin \n access identity for a CloudFront distribution, the registered email address of an AWS account, \n or a predefined Amazon S3 group.

" } }, - "GranteeType": { - "target": "com.amazonaws.elastictranscoder#GranteeType", - "traits": { - "smithy.api#documentation": "

The type of value that appears in the Grantee object:

\n\t\t " - } - }, "Access": { "target": "com.amazonaws.elastictranscoder#AccessControls", "traits": { "smithy.api#documentation": "

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n\t\t\t " } + }, + "GranteeType": { + "target": "com.amazonaws.elastictranscoder#GranteeType", + "traits": { + "smithy.api#documentation": "

The type of value that appears in the Grantee object:

\n\t\t " + } } }, "traits": { @@ -2350,70 +2350,70 @@ "com.amazonaws.elastictranscoder#Pipeline": { "type": "structure", "members": { - "ThumbnailConfig": { - "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", + "Id": { + "target": "com.amazonaws.elastictranscoder#Id", "traits": { - "smithy.api#documentation": "

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n " + "smithy.api#documentation": "

The identifier for the pipeline. You use this value to identify the pipeline in \n which you want to perform a variety of operations, such as creating a job or a preset.

" } }, - "Name": { - "target": "com.amazonaws.elastictranscoder#Name", + "Status": { + "target": "com.amazonaws.elastictranscoder#PipelineStatus", "traits": { - "smithy.api#documentation": "

The name of the pipeline. We recommend that the name be unique within the AWS account, \n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

" + "smithy.api#documentation": "

The current status of the pipeline:

\n " } }, - "ContentConfig": { - "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", + "InputBucket": { + "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { - "smithy.api#documentation": "

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n " + "smithy.api#documentation": "

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics \n files, if any, that you want to use for watermarks.

" } }, - "Notifications": { - "target": "com.amazonaws.elastictranscoder#Notifications", + "AwsKmsKeyArn": { + "target": "com.amazonaws.elastictranscoder#KeyArn", "traits": { - "smithy.api#documentation": "

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n \n

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

\n \n " + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

\n

If you use either s3 or s3-aws-kms as your\n Encryption:Mode, you don't need to provide a key with\n your job because a default key, known as an AWS-KMS key, is created for you automatically.\n You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are\n using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.

" } }, - "Id": { - "target": "com.amazonaws.elastictranscoder#Id", + "ThumbnailConfig": { + "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", "traits": { - "smithy.api#documentation": "

The identifier for the pipeline. You use this value to identify the pipeline in \n which you want to perform a variety of operations, such as creating a job or a preset.

" + "smithy.api#documentation": "

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n " } }, - "Arn": { - "target": "com.amazonaws.elastictranscoder#String", + "OutputBucket": { + "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the pipeline.

" + "smithy.api#documentation": "

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

" } }, - "Role": { - "target": "com.amazonaws.elastictranscoder#Role", + "ContentConfig": { + "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", "traits": { - "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

" + "smithy.api#documentation": "

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n " } }, - "AwsKmsKeyArn": { - "target": "com.amazonaws.elastictranscoder#KeyArn", + "Name": { + "target": "com.amazonaws.elastictranscoder#Name", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

\n

If you use either s3 or s3-aws-kms as your\n Encryption:Mode, you don't need to provide a key with\n your job because a default key, known as an AWS-KMS key, is created for you automatically.\n You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are\n using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.

" + "smithy.api#documentation": "

The name of the pipeline. We recommend that the name be unique within the AWS account, \n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

" } }, - "InputBucket": { - "target": "com.amazonaws.elastictranscoder#BucketName", + "Role": { + "target": "com.amazonaws.elastictranscoder#Role", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics \n files, if any, that you want to use for watermarks.

" + "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

" } }, - "OutputBucket": { - "target": "com.amazonaws.elastictranscoder#BucketName", + "Arn": { + "target": "com.amazonaws.elastictranscoder#String", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the pipeline.

" } }, - "Status": { - "target": "com.amazonaws.elastictranscoder#PipelineStatus", + "Notifications": { + "target": "com.amazonaws.elastictranscoder#Notifications", "traits": { - "smithy.api#documentation": "

The current status of the pipeline:

\n " + "smithy.api#documentation": "

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n \n

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

\n \n " } } }, @@ -2424,12 +2424,6 @@ "com.amazonaws.elastictranscoder#PipelineOutputConfig": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.elastictranscoder#Permissions", - "traits": { - "smithy.api#documentation": "

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

" - } - }, "Bucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { @@ -2441,6 +2435,12 @@ "traits": { "smithy.api#documentation": "

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

" } + }, + "Permissions": { + "target": "com.amazonaws.elastictranscoder#Permissions", + "traits": { + "smithy.api#documentation": "

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

" + } } }, "traits": { @@ -2468,16 +2468,10 @@ "com.amazonaws.elastictranscoder#PlayReadyDrm": { "type": "structure", "members": { - "Format": { - "target": "com.amazonaws.elastictranscoder#PlayReadyDrmFormatString", - "traits": { - "smithy.api#documentation": "

The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" - } - }, - "LicenseAcquisitionUrl": { - "target": "com.amazonaws.elastictranscoder#OneTo512String", + "KeyId": { + "target": "com.amazonaws.elastictranscoder#KeyIdGuid", "traits": { - "smithy.api#documentation": "

The location of the license key required to play DRM content. The URL must be an absolute path,\nand is referenced by the PlayReady header. The PlayReady header is referenced in the protection\nheader of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO\nmetadata tags for HLS playlist outputs. An example URL looks like this:\nhttps://www.example.com/exampleKey/\n

" + "smithy.api#documentation": "

The ID for your DRM key, so that your DRM license provider knows which key to provide.

\n

The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting \n it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in \n big or little endian, check with your DRM provider.

" } }, "InitializationVector": { @@ -2486,12 +2480,6 @@ "smithy.api#documentation": "

The series of random bits created by a random bit generator, unique for every encryption operation, \n that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it \n must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder \n generates one for you.

" } }, - "KeyId": { - "target": "com.amazonaws.elastictranscoder#KeyIdGuid", - "traits": { - "smithy.api#documentation": "

The ID for your DRM key, so that your DRM license provider knows which key to provide.

\n

The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting \n it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in \n big or little endian, check with your DRM provider.

" - } - }, "KeyMd5": { "target": "com.amazonaws.elastictranscoder#NonEmptyBase64EncodedString", "traits": { @@ -2503,6 +2491,18 @@ "traits": { "smithy.api#documentation": "

The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, \n and it must be one of the following bit lengths before being base64-encoded:

\n

\n 128, 192, or 256.

\n

The key must also be encrypted by using AWS KMS.

" } + }, + "Format": { + "target": "com.amazonaws.elastictranscoder#PlayReadyDrmFormatString", + "traits": { + "smithy.api#documentation": "

The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + } + }, + "LicenseAcquisitionUrl": { + "target": "com.amazonaws.elastictranscoder#OneTo512String", + "traits": { + "smithy.api#documentation": "

The location of the license key required to play DRM content. The URL must be an absolute path,\nand is referenced by the PlayReady header. The PlayReady header is referenced in the protection\nheader of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO\nmetadata tags for HLS playlist outputs. An example URL looks like this:\nhttps://www.example.com/exampleKey/\n

" + } } }, "traits": { @@ -2518,16 +2518,16 @@ "com.amazonaws.elastictranscoder#Playlist": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.elastictranscoder#Filename", + "StatusDetail": { + "target": "com.amazonaws.elastictranscoder#Description", "traits": { - "smithy.api#documentation": "

The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. If the name includes a / character, the \n section of the name before the last / must be identical for all \n Name objects. If you create more than one\n master playlist, the values of all Name objects must be\n unique.

\n \n

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8\n for HLSv3 and HLSv4 playlists, and \n .ism and .ismc for Smooth playlists).\n If you include a file extension in Name, the file name will have\n two extensions.

\n " + "smithy.api#documentation": "

Information that further explains the status.

" } }, - "Format": { - "target": "com.amazonaws.elastictranscoder#PlaylistFormat", + "HlsContentProtection": { + "target": "com.amazonaws.elastictranscoder#HlsContentProtection", "traits": { - "smithy.api#documentation": "

The format of the output playlist. Valid formats include HLSv3, HLSv4,\nand Smooth.

" + "smithy.api#documentation": "

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" } }, "PlayReadyDrm": { @@ -2542,22 +2542,22 @@ "smithy.api#documentation": "

The status of the job with which the playlist is associated.

" } }, - "HlsContentProtection": { - "target": "com.amazonaws.elastictranscoder#HlsContentProtection", + "OutputKeys": { + "target": "com.amazonaws.elastictranscoder#OutputKeys", "traits": { - "smithy.api#documentation": "

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + "smithy.api#documentation": "

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.

\n \n\n

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file \n extension in Output Key, the file name will have two extensions.

\n

If you include more than one output in a playlist, \n any segment duration settings, clip settings, or caption settings must be the\n same for all outputs in the playlist. For Smooth playlists, the Audio:Profile,\n Video:Profile, and Video:FrameRate to\n Video:KeyframesMaxDist ratio must be the same for all outputs.

" } }, - "StatusDetail": { - "target": "com.amazonaws.elastictranscoder#Description", + "Name": { + "target": "com.amazonaws.elastictranscoder#Filename", "traits": { - "smithy.api#documentation": "

Information that further explains the status.

" + "smithy.api#documentation": "

The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. If the name includes a / character, the \n section of the name before the last / must be identical for all \n Name objects. If you create more than one\n master playlist, the values of all Name objects must be\n unique.

\n \n

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8\n for HLSv3 and HLSv4 playlists, and \n .ism and .ismc for Smooth playlists).\n If you include a file extension in Name, the file name will have\n two extensions.

\n " } }, - "OutputKeys": { - "target": "com.amazonaws.elastictranscoder#OutputKeys", + "Format": { + "target": "com.amazonaws.elastictranscoder#PlaylistFormat", "traits": { - "smithy.api#documentation": "

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.

\n \n\n

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file \n extension in Output Key, the file name will have two extensions.

\n

If you include more than one output in a playlist, \n any segment duration settings, clip settings, or caption settings must be the\n same for all outputs in the playlist. For Smooth playlists, the Audio:Profile,\n Video:Profile, and Video:FrameRate to\n Video:KeyframesMaxDist ratio must be the same for all outputs.

" + "smithy.api#documentation": "

The format of the output playlist. Valid formats include HLSv3, HLSv4,\nand Smooth.

" } } }, @@ -2580,58 +2580,58 @@ "com.amazonaws.elastictranscoder#Preset": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.elastictranscoder#PresetType", + "Id": { + "target": "com.amazonaws.elastictranscoder#Id", "traits": { - "smithy.api#documentation": "

Whether the preset is a default preset provided by Elastic Transcoder\n (System) or a preset that you have defined (Custom).

" + "smithy.api#documentation": "

Identifier for the new preset. You use this value to get settings for the preset or to delete it.

" } }, - "Video": { - "target": "com.amazonaws.elastictranscoder#VideoParameters", + "Thumbnails": { + "target": "com.amazonaws.elastictranscoder#Thumbnails", "traits": { - "smithy.api#documentation": "

A section of the response body that provides information about the video preset values.

" + "smithy.api#documentation": "

A section of the response body that provides information about the thumbnail preset values, if any.

" } }, - "Container": { - "target": "com.amazonaws.elastictranscoder#PresetContainer", + "Arn": { + "target": "com.amazonaws.elastictranscoder#String", "traits": { - "smithy.api#documentation": "

The container type for the output file. Valid values include flac, \n flv, fmp4, gif, mp3, \n mp4, mpg, mxf, oga, \n ogg, ts, and webm.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the preset.

" } }, - "Thumbnails": { - "target": "com.amazonaws.elastictranscoder#Thumbnails", + "Name": { + "target": "com.amazonaws.elastictranscoder#Name", "traits": { - "smithy.api#documentation": "

A section of the response body that provides information about the thumbnail preset values, if any.

" + "smithy.api#documentation": "

The name of the preset.

" } }, - "Description": { - "target": "com.amazonaws.elastictranscoder#Description", + "Audio": { + "target": "com.amazonaws.elastictranscoder#AudioParameters", "traits": { - "smithy.api#documentation": "

A description of the preset.

" + "smithy.api#documentation": "

A section of the response body that provides information about the audio preset values.

" } }, - "Id": { - "target": "com.amazonaws.elastictranscoder#Id", + "Type": { + "target": "com.amazonaws.elastictranscoder#PresetType", "traits": { - "smithy.api#documentation": "

Identifier for the new preset. You use this value to get settings for the preset or to delete it.

" + "smithy.api#documentation": "

Whether the preset is a default preset provided by Elastic Transcoder\n (System) or a preset that you have defined (Custom).

" } }, - "Arn": { - "target": "com.amazonaws.elastictranscoder#String", + "Container": { + "target": "com.amazonaws.elastictranscoder#PresetContainer", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the preset.

" + "smithy.api#documentation": "

The container type for the output file. Valid values include flac, \n flv, fmp4, gif, mp3, \n mp4, mpg, mxf, oga, \n ogg, ts, and webm.

" } }, - "Audio": { - "target": "com.amazonaws.elastictranscoder#AudioParameters", + "Description": { + "target": "com.amazonaws.elastictranscoder#Description", "traits": { - "smithy.api#documentation": "

A section of the response body that provides information about the audio preset values.

" + "smithy.api#documentation": "

A description of the preset.

" } }, - "Name": { - "target": "com.amazonaws.elastictranscoder#Name", + "Video": { + "target": "com.amazonaws.elastictranscoder#VideoParameters", "traits": { - "smithy.api#documentation": "

The name of the preset.

" + "smithy.api#documentation": "

A section of the response body that provides information about the video preset values.

" } } }, @@ -2652,26 +2652,8 @@ } }, "com.amazonaws.elastictranscoder#PresetWatermark": { - "type": "structure", - "members": { - "HorizontalAlign": { - "target": "com.amazonaws.elastictranscoder#HorizontalAlign", - "traits": { - "smithy.api#documentation": "

The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset:

\n\t\t\t " - } - }, - "MaxWidth": { - "target": "com.amazonaws.elastictranscoder#PixelsOrPercent", - "traits": { - "smithy.api#documentation": "

The maximum width of the watermark in one of the following formats:

\n\t\t " - } - }, - "HorizontalOffset": { - "target": "com.amazonaws.elastictranscoder#PixelsOrPercent", - "traits": { - "smithy.api#documentation": "

The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:

\n\t\t\t \n\t\t\t

For example, if you specify Left for HorizontalAlign and 5px for\n HorizontalOffset, the left side of the watermark appears 5 pixels from\n the left border of the output video.

\n

\n HorizontalOffset is only valid when the value of\n HorizontalAlign is Left or Right. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.

\n

Use the value of Target to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.

" - } - }, + "type": "structure", + "members": { "Target": { "target": "com.amazonaws.elastictranscoder#Target", "traits": { @@ -2684,16 +2666,22 @@ "smithy.api#documentation": "

A unique identifier for the settings for one\n watermark. The value of Id can be up to 40 characters long.

" } }, + "Opacity": { + "target": "com.amazonaws.elastictranscoder#Opacity", + "traits": { + "smithy.api#documentation": "

A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity is float.

\n

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity. The .jpg file format doesn't support transparency.

" + } + }, "MaxHeight": { "target": "com.amazonaws.elastictranscoder#PixelsOrPercent", "traits": { "smithy.api#documentation": "

The maximum height of the watermark in one of the following formats:

\n\t\t \n

If you specify the value in pixels, it must be less than or equal to the value of\n MaxHeight.

" } }, - "Opacity": { - "target": "com.amazonaws.elastictranscoder#Opacity", + "VerticalAlign": { + "target": "com.amazonaws.elastictranscoder#VerticalAlign", "traits": { - "smithy.api#documentation": "

A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity is float.

\n

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity. The .jpg file format doesn't support transparency.

" + "smithy.api#documentation": "

The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset:

\n\t\t\t " } }, "SizingPolicy": { @@ -2702,16 +2690,28 @@ "smithy.api#documentation": "

A value that controls scaling of the watermark:

\n\t\t " } }, - "VerticalAlign": { - "target": "com.amazonaws.elastictranscoder#VerticalAlign", + "VerticalOffset": { + "target": "com.amazonaws.elastictranscoder#PixelsOrPercent", "traits": { - "smithy.api#documentation": "

The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset:

\n\t\t\t " + "smithy.api#documentation": "

\n VerticalOffset\n

\n

The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:

\n\t\t\t \n\t\t\t

For example, if you specify Top for VerticalAlign and\n 5px for VerticalOffset, the top of the watermark appears 5\n pixels from the top border of the output video.

\n

\n VerticalOffset is only valid when the value of VerticalAlign is Top or\n Bottom.

\n

If you specify an offset that causes the watermark to extend beyond the top or\n bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has \n added black bars, the watermark extends into the black bars. If the watermark extends \n beyond the black bars, it is cropped.

\n\n

Use the value of Target to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.

" } }, - "VerticalOffset": { + "HorizontalAlign": { + "target": "com.amazonaws.elastictranscoder#HorizontalAlign", + "traits": { + "smithy.api#documentation": "

The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset:

\n\t\t\t " + } + }, + "HorizontalOffset": { "target": "com.amazonaws.elastictranscoder#PixelsOrPercent", "traits": { - "smithy.api#documentation": "

\n VerticalOffset\n

\n

The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:

\n\t\t\t \n\t\t\t

For example, if you specify Top for VerticalAlign and\n 5px for VerticalOffset, the top of the watermark appears 5\n pixels from the top border of the output video.

\n

\n VerticalOffset is only valid when the value of VerticalAlign is Top or\n Bottom.

\n

If you specify an offset that causes the watermark to extend beyond the top or\n bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has \n added black bars, the watermark extends into the black bars. If the watermark extends \n beyond the black bars, it is cropped.

\n\n

Use the value of Target to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.

" + "smithy.api#documentation": "

The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:

\n\t\t\t \n\t\t\t

For example, if you specify Left for HorizontalAlign and 5px for\n HorizontalOffset, the left side of the watermark appears 5 pixels from\n the left border of the output video.

\n

\n HorizontalOffset is only valid when the value of\n HorizontalAlign is Left or Right. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.

\n

Use the value of Target to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.

" + } + }, + "MaxWidth": { + "target": "com.amazonaws.elastictranscoder#PixelsOrPercent", + "traits": { + "smithy.api#documentation": "

The maximum width of the watermark in one of the following formats:

\n\t\t " } } }, @@ -3071,31 +3071,31 @@ "com.amazonaws.elastictranscoder#TestRoleRequest": { "type": "structure", "members": { - "Role": { - "target": "com.amazonaws.elastictranscoder#Role", + "OutputBucket": { + "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { - "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

", + "smithy.api#documentation": "

The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.

", "smithy.api#required": {} } }, - "OutputBucket": { + "InputBucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.

", + "smithy.api#documentation": "

The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

", "smithy.api#required": {} } }, - "Topics": { - "target": "com.amazonaws.elastictranscoder#SnsTopics", + "Role": { + "target": "com.amazonaws.elastictranscoder#Role", "traits": { - "smithy.api#documentation": "

The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

", + "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

", "smithy.api#required": {} } }, - "InputBucket": { - "target": "com.amazonaws.elastictranscoder#BucketName", + "Topics": { + "target": "com.amazonaws.elastictranscoder#SnsTopics", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

", + "smithy.api#documentation": "

The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

", "smithy.api#required": {} } } @@ -3108,17 +3108,17 @@ "com.amazonaws.elastictranscoder#TestRoleResponse": { "type": "structure", "members": { - "Success": { - "target": "com.amazonaws.elastictranscoder#Success", - "traits": { - "smithy.api#documentation": "

If the operation is successful, this value is true; otherwise, the value is\n false.

" - } - }, "Messages": { "target": "com.amazonaws.elastictranscoder#ExceptionMessages", "traits": { "smithy.api#documentation": "

If the Success element contains false, this value is an array\n of one or more error messages that were generated during the test process.

" } + }, + "Success": { + "target": "com.amazonaws.elastictranscoder#Success", + "traits": { + "smithy.api#documentation": "

If the operation is successful, this value is true; otherwise, the value is\n false.

" + } } }, "traits": { @@ -3141,52 +3141,52 @@ "com.amazonaws.elastictranscoder#Thumbnails": { "type": "structure", "members": { - "Interval": { - "target": "com.amazonaws.elastictranscoder#Digits", + "Format": { + "target": "com.amazonaws.elastictranscoder#JpgOrPng", "traits": { - "smithy.api#documentation": "

The approximate number of seconds between thumbnails. Specify an integer value.

" + "smithy.api#documentation": "

The format of thumbnails, if any. Valid values are jpg and png.

\n

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

" } }, - "MaxHeight": { - "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", + "SizingPolicy": { + "target": "com.amazonaws.elastictranscoder#SizingPolicy", "traits": { - "smithy.api#documentation": "

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 \n (Full HD) as the default value. If you specify a numeric value, enter an even integer \n between 32 and 3072.

" + "smithy.api#documentation": "

Specify one of the following values to control scaling of thumbnails:

\n \n " } }, - "MaxWidth": { - "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", + "PaddingPolicy": { + "target": "com.amazonaws.elastictranscoder#PaddingPolicy", "traits": { - "smithy.api#documentation": "

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) \n as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.

" + "smithy.api#documentation": "

When you set PaddingPolicy to Pad, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth and MaxHeight settings.

" } }, - "Resolution": { - "target": "com.amazonaws.elastictranscoder#ThumbnailResolution", + "AspectRatio": { + "target": "com.amazonaws.elastictranscoder#AspectRatio", "traits": { - "smithy.api#documentation": "\n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The width and height of thumbnail files in pixels. Specify a value in the format\n \n width\n x \n height\n where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution object.

" + "smithy.api#documentation": "\n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The aspect ratio of thumbnails. Valid values include:

\n

\n auto, 1:1, 4:3, 3:2,\n 16:9\n

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.

" } }, - "SizingPolicy": { - "target": "com.amazonaws.elastictranscoder#SizingPolicy", + "MaxWidth": { + "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", "traits": { - "smithy.api#documentation": "

Specify one of the following values to control scaling of thumbnails:

\n \n " + "smithy.api#documentation": "

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) \n as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.

" } }, - "Format": { - "target": "com.amazonaws.elastictranscoder#JpgOrPng", + "MaxHeight": { + "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", "traits": { - "smithy.api#documentation": "

The format of thumbnails, if any. Valid values are jpg and png.

\n

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

" + "smithy.api#documentation": "

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 \n (Full HD) as the default value. If you specify a numeric value, enter an even integer \n between 32 and 3072.

" } }, - "PaddingPolicy": { - "target": "com.amazonaws.elastictranscoder#PaddingPolicy", + "Interval": { + "target": "com.amazonaws.elastictranscoder#Digits", "traits": { - "smithy.api#documentation": "

When you set PaddingPolicy to Pad, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth and MaxHeight settings.

" + "smithy.api#documentation": "

The approximate number of seconds between thumbnails. Specify an integer value.

" } }, - "AspectRatio": { - "target": "com.amazonaws.elastictranscoder#AspectRatio", + "Resolution": { + "target": "com.amazonaws.elastictranscoder#ThumbnailResolution", "traits": { - "smithy.api#documentation": "\n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The aspect ratio of thumbnails. Valid values include:

\n

\n auto, 1:1, 4:3, 3:2,\n 16:9\n

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.

" + "smithy.api#documentation": "\n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The width and height of thumbnail files in pixels. Specify a value in the format\n \n width\n x \n height\n where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution object.

" } } }, @@ -3209,16 +3209,16 @@ "com.amazonaws.elastictranscoder#TimeSpan": { "type": "structure", "members": { - "Duration": { + "StartTime": { "target": "com.amazonaws.elastictranscoder#Time", "traits": { - "smithy.api#documentation": "

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; \n SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a \n value, Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the \n file and returns a warning message.

" + "smithy.api#documentation": "

The place in the input file where you want a clip to start. The format can be either \n HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS \n (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of \n the input file.

" } }, - "StartTime": { + "Duration": { "target": "com.amazonaws.elastictranscoder#Time", "traits": { - "smithy.api#documentation": "

The place in the input file where you want a clip to start. The format can be either \n HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS \n (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of \n the input file.

" + "smithy.api#documentation": "

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; \n SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a \n value, Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the \n file and returns a warning message.

" } } }, @@ -3229,12 +3229,6 @@ "com.amazonaws.elastictranscoder#Timing": { "type": "structure", "members": { - "StartTimeMillis": { - "target": "com.amazonaws.elastictranscoder#NullableLong", - "traits": { - "smithy.api#documentation": "

The time the job began transcoding, in epoch milliseconds.

" - } - }, "FinishTimeMillis": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { @@ -3246,6 +3240,12 @@ "traits": { "smithy.api#documentation": "

The time the job was submitted to Elastic Transcoder, in epoch milliseconds.

" } + }, + "StartTimeMillis": { + "target": "com.amazonaws.elastictranscoder#NullableLong", + "traits": { + "smithy.api#documentation": "

The time the job began transcoding, in epoch milliseconds.

" + } } }, "traits": { @@ -3329,18 +3329,18 @@ "com.amazonaws.elastictranscoder#UpdatePipelineNotificationsRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.elastictranscoder#Id", + "Notifications": { + "target": "com.amazonaws.elastictranscoder#Notifications", "traits": { - "smithy.api#documentation": "

The identifier of the pipeline for which you want to change notification settings.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n \n

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

\n \n ", "smithy.api#required": {} } }, - "Notifications": { - "target": "com.amazonaws.elastictranscoder#Notifications", + "Id": { + "target": "com.amazonaws.elastictranscoder#Id", "traits": { - "smithy.api#documentation": "

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n \n

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

\n \n ", + "smithy.api#documentation": "

The identifier of the pipeline for which you want to change notification settings.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -3366,24 +3366,22 @@ "com.amazonaws.elastictranscoder#UpdatePipelineRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.elastictranscoder#Id", + "ContentConfig": { + "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", "traits": { - "smithy.api#documentation": "

The ID of the pipeline that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The optional ContentConfig object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n " } }, - "AwsKmsKeyArn": { - "target": "com.amazonaws.elastictranscoder#KeyArn", + "Name": { + "target": "com.amazonaws.elastictranscoder#Name", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

\n

If you use either s3 or s3-aws-kms as your Encryption:Mode,\n you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is \n created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default \n AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.

" + "smithy.api#documentation": "

The name of the pipeline. We recommend that the name be unique within the AWS account, but \n uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

" } }, - "ThumbnailConfig": { - "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", + "Role": { + "target": "com.amazonaws.elastictranscoder#Role", "traits": { - "smithy.api#documentation": "

The ThumbnailConfig object specifies several values, including the Amazon S3\n bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have\n access to the files, the type of access you want users to have, and the storage class\n that you want to assign to the files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig even if you don't want to create thumbnails.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n " + "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for \n this pipeline.

" } }, "Notifications": { @@ -3392,28 +3390,30 @@ "smithy.api#documentation": "

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n \n

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

\n \n " } }, - "InputBucket": { - "target": "com.amazonaws.elastictranscoder#BucketName", + "Id": { + "target": "com.amazonaws.elastictranscoder#Id", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics \n that you want to use as watermarks.

" + "smithy.api#documentation": "

The ID of the pipeline that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ContentConfig": { + "ThumbnailConfig": { "target": "com.amazonaws.elastictranscoder#PipelineOutputConfig", "traits": { - "smithy.api#documentation": "

The optional ContentConfig object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n " + "smithy.api#documentation": "

The ThumbnailConfig object specifies several values, including the Amazon S3\n bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have\n access to the files, the type of access you want users to have, and the storage class\n that you want to assign to the files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig even if you don't want to create thumbnails.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n " } }, - "Name": { - "target": "com.amazonaws.elastictranscoder#Name", + "InputBucket": { + "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { - "smithy.api#documentation": "

The name of the pipeline. We recommend that the name be unique within the AWS account, but \n uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

" + "smithy.api#documentation": "

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics \n that you want to use as watermarks.

" } }, - "Role": { - "target": "com.amazonaws.elastictranscoder#Role", + "AwsKmsKeyArn": { + "target": "com.amazonaws.elastictranscoder#KeyArn", "traits": { - "smithy.api#documentation": "

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for \n this pipeline.

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

\n

If you use either s3 or s3-aws-kms as your Encryption:Mode,\n you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is \n created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default \n AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.

" } } }, @@ -3561,22 +3561,22 @@ "com.amazonaws.elastictranscoder#VideoParameters": { "type": "structure", "members": { - "FrameRate": { - "target": "com.amazonaws.elastictranscoder#FrameRate", + "MaxWidth": { + "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", "traits": { - "smithy.api#documentation": "

The frames per second for the video stream in the output file. Valid values include:

\n

\n auto, 10, 15, 23.97, 24,\n 25, 29.97, 30, 60\n

\n

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:

\n

\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)\n

\n

where:

\n \n

The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):

\n " + "smithy.api#documentation": "

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.

" } }, - "KeyframesMaxDist": { - "target": "com.amazonaws.elastictranscoder#KeyframesMaxDist", + "FrameRate": { + "target": "com.amazonaws.elastictranscoder#FrameRate", "traits": { - "smithy.api#documentation": "

Applicable only when the value of Video:Codec is one of H.264, MPEG2, \n or VP8.

\n

The maximum number of frames between key frames. Key frames are fully encoded frames; \n the frames between key frames are encoded based, in part, on the content of the key frames. \n The value is an integer formatted as a string; valid values are between 1 (every frame is a \n key frame) and 100000, inclusive. A higher value results in higher compression but may also \n discernibly decrease video quality.

\n

For Smooth outputs, the FrameRate must have a constant ratio to the\n KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels\n while the file is being played.

\n

For example, an input file can have a FrameRate of\n 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3.\n Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist\n of 90, 75, and 30, respectively.

\n

Alternately, this can be achieved by setting FrameRate\n to auto and having the same values for MaxFrameRate and KeyframesMaxDist.

" + "smithy.api#documentation": "

The frames per second for the video stream in the output file. Valid values include:

\n

\n auto, 10, 15, 23.97, 24,\n 25, 29.97, 30, 60\n

\n

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:

\n

\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)\n

\n

where:

\n \n

The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):

\n " } }, - "CodecOptions": { - "target": "com.amazonaws.elastictranscoder#CodecOptions", + "MaxHeight": { + "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", "traits": { - "smithy.api#documentation": "

\n Profile (H.264/VP8/VP9 Only)\n

\n

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:

\n \n

\n Level (H.264 Only)\n

\n

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:

\n

\n 1, 1b, 1.1, 1.2, 1.3,\n 2, 2.1, 2.2, 3,\n 3.1, 3.2, 4, 4.1\n

\n

\n MaxReferenceFrames (H.264 Only)\n

\n

Applicable only when the value of Video:Codec is H.264. The maximum number of \n previously decoded frames to use as a reference for decoding future frames. Valid \n values are integers 0 through 16, but we recommend that you not use a value greater \n than the following:

\n

\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)\n

\n

where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)

\n \n

\n MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)\n

\n

The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.

\n

\n BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)\n

\n

The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate and omit BufferSize, Elastic Transcoder sets\n BufferSize to 10 times the value of MaxBitRate.

\n

\n InterlacedMode (Optional, H.264/MPEG2 Only)\n

\n

The interlace mode for the output video.

\n

Interlaced video is used to double the perceived frame rate for a video by interlacing \n two fields (one field on every other line, the other field on the other lines) so that the \n human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required \n for transmitting a video, but can result in blurred images and flickering.

\n

Valid values include Progressive (no interlacing, top to bottom),\n TopFirst (top field first), BottomFirst (bottom field\n first), and Auto.

\n

If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output. If\n Auto is specified, Elastic Transcoder interlaces the output.

\n

\n ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)\n

\n

The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms\n used by the computer to store information about how to render color. Bt.601 is the\n standard for standard definition video, while Bt.709 is the standard for high definition\n video.

\n

Valid values include None,\n Bt709toBt601, Bt601toBt709, and Auto.

\n

If you chose Auto for ColorSpaceConversionMode and your output\n is interlaced, your frame rate is one of 23.97, 24,\n 25, 29.97, 50, or 60, your\n SegmentDuration is null, and you are using one of the resolution\n changes from the list below, Elastic Transcoder applies the following color space\n conversions:

\n \n \n

Elastic Transcoder may change the behavior of the ColorspaceConversionMode\n Auto mode in the future. All outputs in a playlist must use the same\n ColorSpaceConversionMode.

\n \n

If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the\n color space of a file. If you are unsure what ColorSpaceConversionMode was applied to \n your output file, you can check the AppliedColorSpaceConversion parameter included in \n your job response. If your job does not have an AppliedColorSpaceConversion in its \n response, no ColorSpaceConversionMode was applied.

\n

\n ChromaSubsampling\n

\n

The sampling pattern for the chroma (color) channels of the output video.\n Valid values include yuv420p and yuv422p.

\n

\n yuv420p samples the chroma information of every other horizontal and every other vertical\n line, yuv422p samples the color information of every horizontal line and every other \n vertical line.

\n\n

\n LoopCount (Gif Only)\n

\n

The number of times you want the output gif to loop. Valid values include Infinite and \n integers between 0 and 100, inclusive.

" + "smithy.api#documentation": "

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.

" } }, "SizingPolicy": { @@ -3585,12 +3585,6 @@ "smithy.api#documentation": "

Specify one of the following values to control scaling of the output video:

\n \n " } }, - "MaxHeight": { - "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", - "traits": { - "smithy.api#documentation": "

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.

" - } - }, "Resolution": { "target": "com.amazonaws.elastictranscoder#Resolution", "traits": { @@ -3615,10 +3609,16 @@ "smithy.api#documentation": "

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth\n and MaxHeight.

" } }, - "MaxWidth": { - "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", + "Codec": { + "target": "com.amazonaws.elastictranscoder#VideoCodec", "traits": { - "smithy.api#documentation": "

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.

" + "smithy.api#documentation": "

The video codec for the output file. Valid values include gif, \n H.264, mpeg2, vp8, and vp9. \n You can only specify vp8 and vp9 when the container type is\n webm, gif when the container type is gif, \n and mpeg2 when the container type is mpg.

" + } + }, + "FixedGOP": { + "target": "com.amazonaws.elastictranscoder#FixedGOP", + "traits": { + "smithy.api#documentation": "

Applicable only when the value of Video:Codec is one of H.264, MPEG2,\n or VP8.

\n

Whether to use a fixed value for FixedGOP. Valid values are\n true and false:

\n \n \n

\n FixedGOP must be set to true for fmp4 containers.

\n " } }, "AspectRatio": { @@ -3627,28 +3627,28 @@ "smithy.api#documentation": "\n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The display aspect ratio of the video in the output file. Valid values include:

\n

\n auto, 1:1, 4:3, 3:2,\n 16:9\n

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.

\n

If you specify an aspect ratio for the output file that differs from aspect ratio \n of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing \n (black bars on the top and bottom) to maintain the aspect ratio of the active region \n of the video.

" } }, - "DisplayAspectRatio": { - "target": "com.amazonaws.elastictranscoder#AspectRatio", + "Watermarks": { + "target": "com.amazonaws.elastictranscoder#PresetWatermarks", "traits": { - "smithy.api#documentation": "

The value that Elastic Transcoder adds to the metadata in the output file.

" + "smithy.api#documentation": "

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay \n over videos that are transcoded using this preset. You can specify settings for up to four \n watermarks. Watermarks appear in the specified size and location, and with the specified \n opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not \n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that \n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job \n than you specify watermark settings in the preset, which allows you to use the same preset \n for up to four watermarks that have different dimensions.

" } }, - "FixedGOP": { - "target": "com.amazonaws.elastictranscoder#FixedGOP", + "KeyframesMaxDist": { + "target": "com.amazonaws.elastictranscoder#KeyframesMaxDist", "traits": { - "smithy.api#documentation": "

Applicable only when the value of Video:Codec is one of H.264, MPEG2,\n or VP8.

\n

Whether to use a fixed value for FixedGOP. Valid values are\n true and false:

\n \n \n

\n FixedGOP must be set to true for fmp4 containers.

\n " + "smithy.api#documentation": "

Applicable only when the value of Video:Codec is one of H.264, MPEG2, \n or VP8.

\n

The maximum number of frames between key frames. Key frames are fully encoded frames; \n the frames between key frames are encoded based, in part, on the content of the key frames. \n The value is an integer formatted as a string; valid values are between 1 (every frame is a \n key frame) and 100000, inclusive. A higher value results in higher compression but may also \n discernibly decrease video quality.

\n

For Smooth outputs, the FrameRate must have a constant ratio to the\n KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels\n while the file is being played.

\n

For example, an input file can have a FrameRate of\n 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3.\n Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist\n of 90, 75, and 30, respectively.

\n

Alternately, this can be achieved by setting FrameRate\n to auto and having the same values for MaxFrameRate and KeyframesMaxDist.

" } }, - "Codec": { - "target": "com.amazonaws.elastictranscoder#VideoCodec", + "CodecOptions": { + "target": "com.amazonaws.elastictranscoder#CodecOptions", "traits": { - "smithy.api#documentation": "

The video codec for the output file. Valid values include gif, \n H.264, mpeg2, vp8, and vp9. \n You can only specify vp8 and vp9 when the container type is\n webm, gif when the container type is gif, \n and mpeg2 when the container type is mpg.

" + "smithy.api#documentation": "

\n Profile (H.264/VP8/VP9 Only)\n

\n

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:

\n \n

\n Level (H.264 Only)\n

\n

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:

\n

\n 1, 1b, 1.1, 1.2, 1.3,\n 2, 2.1, 2.2, 3,\n 3.1, 3.2, 4, 4.1\n

\n

\n MaxReferenceFrames (H.264 Only)\n

\n

Applicable only when the value of Video:Codec is H.264. The maximum number of \n previously decoded frames to use as a reference for decoding future frames. Valid \n values are integers 0 through 16, but we recommend that you not use a value greater \n than the following:

\n

\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)\n

\n

where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)

\n \n

\n MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)\n

\n

The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.

\n

\n BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)\n

\n

The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate and omit BufferSize, Elastic Transcoder sets\n BufferSize to 10 times the value of MaxBitRate.

\n

\n InterlacedMode (Optional, H.264/MPEG2 Only)\n

\n

The interlace mode for the output video.

\n

Interlaced video is used to double the perceived frame rate for a video by interlacing \n two fields (one field on every other line, the other field on the other lines) so that the \n human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required \n for transmitting a video, but can result in blurred images and flickering.

\n

Valid values include Progressive (no interlacing, top to bottom),\n TopFirst (top field first), BottomFirst (bottom field\n first), and Auto.

\n

If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output. If\n Auto is specified, Elastic Transcoder interlaces the output.

\n

\n ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)\n

\n

The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms\n used by the computer to store information about how to render color. Bt.601 is the\n standard for standard definition video, while Bt.709 is the standard for high definition\n video.

\n

Valid values include None,\n Bt709toBt601, Bt601toBt709, and Auto.

\n

If you chose Auto for ColorSpaceConversionMode and your output\n is interlaced, your frame rate is one of 23.97, 24,\n 25, 29.97, 50, or 60, your\n SegmentDuration is null, and you are using one of the resolution\n changes from the list below, Elastic Transcoder applies the following color space\n conversions:

\n \n \n

Elastic Transcoder may change the behavior of the ColorspaceConversionMode\n Auto mode in the future. All outputs in a playlist must use the same\n ColorSpaceConversionMode.

\n \n

If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the\n color space of a file. If you are unsure what ColorSpaceConversionMode was applied to \n your output file, you can check the AppliedColorSpaceConversion parameter included in \n your job response. If your job does not have an AppliedColorSpaceConversion in its \n response, no ColorSpaceConversionMode was applied.

\n

\n ChromaSubsampling\n

\n

The sampling pattern for the chroma (color) channels of the output video.\n Valid values include yuv420p and yuv422p.

\n

\n yuv420p samples the chroma information of every other horizontal and every other vertical\n line, yuv422p samples the color information of every horizontal line and every other \n vertical line.

\n\n

\n LoopCount (Gif Only)\n

\n

The number of times you want the output gif to loop. Valid values include Infinite and \n integers between 0 and 100, inclusive.

" } }, - "Watermarks": { - "target": "com.amazonaws.elastictranscoder#PresetWatermarks", + "DisplayAspectRatio": { + "target": "com.amazonaws.elastictranscoder#AspectRatio", "traits": { - "smithy.api#documentation": "

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay \n over videos that are transcoded using this preset. You can specify settings for up to four \n watermarks. Watermarks appear in the specified size and location, and with the specified \n opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not \n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that \n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job \n than you specify watermark settings in the preset, which allows you to use the same preset \n for up to four watermarks that have different dimensions.

" + "smithy.api#documentation": "

The value that Elastic Transcoder adds to the metadata in the output file.

" } } }, 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 ebbe68737b1d..684aa89645e6 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json +++ b/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json @@ -57,6 +57,12 @@ ] } }, + "com.amazonaws.elasticache#AccessString": { + "type": "string", + "traits": { + "smithy.api#pattern": ".*\\S.*" + } + }, "com.amazonaws.elasticache#AddTagsToResource": { "type": "operation", "input": { @@ -86,17 +92,17 @@ "com.amazonaws.elasticache#AddTagsToResourceMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.elasticache#TagList", + "ResourceName": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. \n A tag key must be accompanied by a tag value.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and snapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } }, - "ResourceName": { - "target": "com.amazonaws.elasticache#String", + "Tags": { + "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and snapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#documentation": "

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. \n A tag key must be accompanied by a tag value.

", "smithy.api#required": {} } } @@ -178,6 +184,12 @@ { "target": "com.amazonaws.elasticache#CreateSnapshot" }, + { + "target": "com.amazonaws.elasticache#CreateUser" + }, + { + "target": "com.amazonaws.elasticache#CreateUserGroup" + }, { "target": "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroup" }, @@ -205,6 +217,12 @@ { "target": "com.amazonaws.elasticache#DeleteSnapshot" }, + { + "target": "com.amazonaws.elasticache#DeleteUser" + }, + { + "target": "com.amazonaws.elasticache#DeleteUserGroup" + }, { "target": "com.amazonaws.elasticache#DescribeCacheClusters" }, @@ -250,6 +268,12 @@ { "target": "com.amazonaws.elasticache#DescribeUpdateActions" }, + { + "target": "com.amazonaws.elasticache#DescribeUserGroups" + }, + { + "target": "com.amazonaws.elasticache#DescribeUsers" + }, { "target": "com.amazonaws.elasticache#DisassociateGlobalReplicationGroup" }, @@ -286,6 +310,12 @@ { "target": "com.amazonaws.elasticache#ModifyReplicationGroupShardConfiguration" }, + { + "target": "com.amazonaws.elasticache#ModifyUser" + }, + { + "target": "com.amazonaws.elasticache#ModifyUserGroup" + }, { "target": "com.amazonaws.elasticache#PurchaseReservedCacheNodesOffering" }, @@ -316,7 +346,7 @@ "sdkId": "ElastiCache", "arnNamespace": "elasticache", "cloudFormationName": "ElastiCache", - "cloudTrailEventSource": "v20150202.admin.elmo" + "cloudTrailEventSource": "elasticache.amazonaws.com" }, "aws.auth#sigv4": { "name": "elasticache" @@ -351,6 +381,44 @@ }, { "value": "ROTATE" + }, + { + "value": "DELETE" + } + ] + } + }, + "com.amazonaws.elasticache#Authentication": { + "type": "structure", + "members": { + "PasswordCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of passwords belonging to the user. The maximum is two.

" + } + }, + "Type": { + "target": "com.amazonaws.elasticache#AuthenticationType", + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate.

" + } + }, + "com.amazonaws.elasticache#AuthenticationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "password", + "name": "PASSWORD" + }, + { + "value": "no-password", + "name": "NO_PASSWORD" } ] } @@ -519,12 +587,6 @@ "com.amazonaws.elasticache#BatchApplyUpdateActionMessage": { "type": "structure", "members": { - "ReplicationGroupIds": { - "target": "com.amazonaws.elasticache#ReplicationGroupIdList", - "traits": { - "smithy.api#documentation": "

The replication group IDs

" - } - }, "CacheClusterIds": { "target": "com.amazonaws.elasticache#CacheClusterIdList", "traits": { @@ -537,6 +599,12 @@ "smithy.api#documentation": "

The unique ID of the service update

", "smithy.api#required": {} } + }, + "ReplicationGroupIds": { + "target": "com.amazonaws.elasticache#ReplicationGroupIdList", + "traits": { + "smithy.api#documentation": "

The replication group IDs

" + } } } }, @@ -563,12 +631,6 @@ "com.amazonaws.elasticache#BatchStopUpdateActionMessage": { "type": "structure", "members": { - "ReplicationGroupIds": { - "target": "com.amazonaws.elasticache#ReplicationGroupIdList", - "traits": { - "smithy.api#documentation": "

The replication group IDs

" - } - }, "CacheClusterIds": { "target": "com.amazonaws.elasticache#CacheClusterIdList", "traits": { @@ -581,6 +643,12 @@ "smithy.api#documentation": "

The unique ID of the service update

", "smithy.api#required": {} } + }, + "ReplicationGroupIds": { + "target": "com.amazonaws.elasticache#ReplicationGroupIdList", + "traits": { + "smithy.api#documentation": "

The replication group IDs

" + } } } }, @@ -596,163 +664,169 @@ "com.amazonaws.elasticache#CacheCluster": { "type": "structure", "members": { - "ClientDownloadLandingPage": { - "target": "com.amazonaws.elasticache#String", + "AuthTokenLastModifiedDate": { + "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The URL of the web page where you can download the latest ElastiCache client library.

" + "smithy.api#documentation": "

The date the auth token was last modified

" } }, - "ConfigurationEndpoint": { - "target": "com.amazonaws.elasticache#Endpoint", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on\n the cluster, can be used by an application to connect to any node in the cluster.\n The configuration endpoint will always have .cfg in it.

\n

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n

" + "smithy.api#documentation": "

This parameter is currently disabled.

" } }, - "PendingModifiedValues": { - "target": "com.amazonaws.elasticache#PendingModifiedValues" + "NotificationConfiguration": { + "target": "com.amazonaws.elasticache#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "

Describes a notification topic and its status. \n Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" + } }, - "SnapshotRetentionLimit": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "Engine": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " + "smithy.api#documentation": "

The name of the cache engine (memcached or \n redis) to be used for this cluster.

" } }, - "CacheClusterCreateTime": { - "target": "com.amazonaws.elasticache#TStamp", + "CacheParameterGroup": { + "target": "com.amazonaws.elasticache#CacheParameterGroupStatus", "traits": { - "smithy.api#documentation": "

The date and time when the cluster was created.

" + "smithy.api#documentation": "

Status of the cache parameter group.

" } }, - "ARN": { + "CacheClusterStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache cluster.

" + "smithy.api#documentation": "

The current state of this cluster, one of the following values: \n available, \n creating, \n deleted, \n deleting,\n incompatible-network,\n modifying,\n rebooting cluster nodes,\n restore-failed, or \n snapshotting.

" } }, - "AuthTokenEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "CacheSubnetGroupName": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A flag that enables using an AuthToken (password)\n when issuing Redis commands.

\n

Default: false\n

" + "smithy.api#documentation": "

The name of the cache subnet group associated with the cluster.

" } }, - "ReplicationGroupId": { + "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The replication group to which this cluster belongs. \n If this field is empty, the cluster is not associated with any replication group.

" + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a \n daily snapshot of your cluster.

\n

Example: 05:00-09:00\n

" } }, - "CacheClusterStatus": { + "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The current state of this cluster, one of the following values: \n available, \n creating, \n deleted, \n deleting,\n incompatible-network,\n modifying,\n rebooting cluster nodes,\n restore-failed, or \n snapshotting.

" + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache cluster.

" } }, - "SecurityGroups": { - "target": "com.amazonaws.elasticache#SecurityGroupMembershipList", + "AtRestEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A list of VPC Security Groups associated with the cluster.

" + "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled\n after the cluster is created. To enable at-rest encryption on a cluster\n you must set AtRestEncryptionEnabled to true\n when you create a cluster.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" } }, - "CacheClusterId": { - "target": "com.amazonaws.elasticache#String", + "CacheNodes": { + "target": "com.amazonaws.elasticache#CacheNodeList", "traits": { - "smithy.api#documentation": "

The user-supplied identifier of the cluster. \n This identifier is a unique key that identifies a cluster.

" + "smithy.api#documentation": "

A list of cache nodes that are members of the cluster.

" } }, - "TransitEncryptionEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

You cannot modify the value of TransitEncryptionEnabled\n after the cluster is created. To enable in-transit encryption on a cluster\n you must set TransitEncryptionEnabled to true\n when you create a cluster.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, - "CacheSecurityGroups": { - "target": "com.amazonaws.elasticache#CacheSecurityGroupMembershipList", + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of cache security group elements, composed of name and status sub-elements.

" + "smithy.api#documentation": "

The version of the cache engine that is used in this cluster.

" } }, - "NumCacheNodes": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "CacheClusterCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The number of cache nodes in the cluster.

\n

For clusters running Redis, this value must be 1. For clusters running Memcached, \n this value must be between 1 and 20.

" + "smithy.api#documentation": "

The date and time when the cluster was created.

" } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.elasticache#String", + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " } }, - "PreferredAvailabilityZone": { + "ClientDownloadLandingPage": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the Availability Zone in which the cluster is located or \"Multiple\" \n if the cache nodes are located in different Availability Zones.

" + "smithy.api#documentation": "

The URL of the web page where you can download the latest ElastiCache client library.

" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.elasticache#Boolean", + "ConfigurationEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "

This parameter is currently disabled.

" + "smithy.api#documentation": "

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on\n the cluster, can be used by an application to connect to any node in the cluster.\n The configuration endpoint will always have .cfg in it.

\n

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n

" } }, - "NotificationConfiguration": { - "target": "com.amazonaws.elasticache#NotificationConfiguration", + "PendingModifiedValues": { + "target": "com.amazonaws.elasticache#PendingModifiedValues" + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Describes a notification topic and its status. \n Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" + "smithy.api#documentation": "

The user-supplied identifier of the cluster. \n This identifier is a unique key that identifies a cluster.

" } }, - "AuthTokenLastModifiedDate": { - "target": "com.amazonaws.elasticache#TStamp", + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The date the auth token was last modified

" + "smithy.api#documentation": "

The number of cache nodes in the cluster.

\n

For clusters running Redis, this value must be 1. For clusters running Memcached, \n this value must be between 1 and 20.

" } }, - "SnapshotWindow": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a \n daily snapshot of your cluster.

\n

Example: 05:00-09:00\n

" + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" } }, - "CacheSubnetGroupName": { - "target": "com.amazonaws.elasticache#String", + "CacheSecurityGroups": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

The name of the cache subnet group associated with the cluster.

" + "smithy.api#documentation": "

A list of cache security group elements, composed of name and status sub-elements.

" } }, - "Engine": { + "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache engine (memcached or \n redis) to be used for this cluster.

" + "smithy.api#documentation": "

The name of the Availability Zone in which the cluster is located or \"Multiple\" \n if the cache nodes are located in different Availability Zones.

" } }, - "CacheParameterGroup": { - "target": "com.amazonaws.elasticache#CacheParameterGroupStatus", + "SecurityGroups": { + "target": "com.amazonaws.elasticache#SecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

Status of the cache parameter group.

" + "smithy.api#documentation": "

A list of VPC Security Groups associated with the cluster.

" } }, - "AtRestEncryptionEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled\n after the cluster is created. To enable at-rest encryption on a cluster\n you must set AtRestEncryptionEnabled to true\n when you create a cluster.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" + "smithy.api#documentation": "

The replication group to which this cluster belongs. \n If this field is empty, the cluster is not associated with any replication group.

" } }, - "CacheNodeType": { + "PreferredOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The outpost ARN in which the cache cluster is created.

" } }, - "EngineVersion": { - "target": "com.amazonaws.elasticache#String", + "AuthTokenEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

The version of the cache engine that is used in this cluster.

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password)\n when issuing Redis commands.

\n

Default: false\n

" } }, - "CacheNodes": { - "target": "com.amazonaws.elasticache#CacheNodeList", + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A list of cache nodes that are members of the cluster.

" + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

You cannot modify the value of TransitEncryptionEnabled\n after the cluster is created. To enable in-transit encryption on a cluster\n you must set TransitEncryptionEnabled to true\n when you create a cluster.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" } } }, @@ -797,17 +871,17 @@ "com.amazonaws.elasticache#CacheClusterMessage": { "type": "structure", "members": { - "CacheClusters": { - "target": "com.amazonaws.elasticache#CacheClusterList", - "traits": { - "smithy.api#documentation": "

A list of clusters. Each item in the list contains detailed information about one cluster.

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" } + }, + "CacheClusters": { + "target": "com.amazonaws.elasticache#CacheClusterList", + "traits": { + "smithy.api#documentation": "

A list of clusters. Each item in the list contains detailed information about one cluster.

" + } } }, "traits": { @@ -836,6 +910,12 @@ "smithy.api#documentation": "

The name of the cache engine.

" } }, + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The version number of the cache engine.

" + } + }, "CacheEngineDescription": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -853,12 +933,6 @@ "traits": { "smithy.api#documentation": "

The description of the cache engine version.

" } - }, - "EngineVersion": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The version number of the cache engine.

" - } } }, "traits": { @@ -877,17 +951,17 @@ "com.amazonaws.elasticache#CacheEngineVersionMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" - } - }, "CacheEngineVersions": { "target": "com.amazonaws.elasticache#CacheEngineVersionList", "traits": { "smithy.api#documentation": "

A list of cache engine version details. \n Each element in the list contains detailed information about one cache engine version.

" } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } } }, "traits": { @@ -897,16 +971,16 @@ "com.amazonaws.elasticache#CacheNode": { "type": "structure", "members": { - "SourceCacheNodeId": { + "CustomerOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the primary node to which this read replica node is synchronized. \n If this field is empty, this node is not associated with a primary cluster.

" + "smithy.api#documentation": "

The customer outpost ARN of the cache node.

" } }, - "CacheNodeCreateTime": { - "target": "com.amazonaws.elasticache#TStamp", + "Endpoint": { + "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "

The date and time when the cache node was created.

" + "smithy.api#documentation": "

The hostname for connecting to this cache node.

" } }, "ParameterGroupStatus": { @@ -915,10 +989,10 @@ "smithy.api#documentation": "

The status of the parameter group applied to this cache node.

" } }, - "CacheNodeId": { + "CustomerAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

" + "smithy.api#documentation": "

The Availability Zone where this node was created and now resides.

" } }, "CacheNodeStatus": { @@ -927,16 +1001,22 @@ "smithy.api#documentation": "

The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

" } }, - "Endpoint": { - "target": "com.amazonaws.elasticache#Endpoint", + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The hostname for connecting to this cache node.

" + "smithy.api#documentation": "

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

" } }, - "CustomerAvailabilityZone": { + "CacheNodeCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cache node was created.

" + } + }, + "SourceCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Availability Zone where this node was created and now resides.

" + "smithy.api#documentation": "

The ID of the primary node to which this read replica node is synchronized. \n If this field is empty, this node is not associated with a primary cluster.

" } } }, @@ -965,16 +1045,16 @@ "com.amazonaws.elasticache#CacheNodeTypeSpecificParameter": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.elasticache#String", + "CacheNodeTypeSpecificValues": { + "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificValueList", "traits": { - "smithy.api#documentation": "

A description of the parameter.

" + "smithy.api#documentation": "

A list of cache node types and their corresponding values for this parameter.

" } }, - "ChangeType": { - "target": "com.amazonaws.elasticache#ChangeType", + "AllowedValues": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.

" + "smithy.api#documentation": "

The valid range of values for the parameter.

" } }, "IsModifiable": { @@ -983,40 +1063,40 @@ "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.

" } }, - "ParameterName": { + "Description": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the parameter.

" + "smithy.api#documentation": "

A description of the parameter.

" } }, - "Source": { + "MinimumEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The source of the parameter value.

" + "smithy.api#documentation": "

The earliest cache engine version to which the parameter can apply.

" } }, - "DataType": { - "target": "com.amazonaws.elasticache#String", + "ChangeType": { + "target": "com.amazonaws.elasticache#ChangeType", "traits": { - "smithy.api#documentation": "

The valid data type for the parameter.

" + "smithy.api#documentation": "

Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.

" } }, - "MinimumEngineVersion": { + "ParameterName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The earliest cache engine version to which the parameter can apply.

" + "smithy.api#documentation": "

The name of the parameter.

" } }, - "CacheNodeTypeSpecificValues": { - "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificValueList", + "Source": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of cache node types and their corresponding values for this parameter.

" + "smithy.api#documentation": "

The source of the parameter value.

" } }, - "AllowedValues": { + "DataType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The valid range of values for the parameter.

" + "smithy.api#documentation": "

The valid data type for the parameter.

" } } }, @@ -1065,6 +1145,12 @@ "com.amazonaws.elasticache#CacheNodeUpdateStatus": { "type": "structure", "members": { + "NodeDeletionDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The deletion date of the node

" + } + }, "NodeUpdateStatusModifiedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { @@ -1083,6 +1169,12 @@ "smithy.api#documentation": "

The end date of the update for a node

" } }, + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The node ID of the cache cluster

" + } + }, "NodeUpdateStartDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { @@ -1100,18 +1192,6 @@ "traits": { "smithy.api#documentation": "

The date when the update is triggered

" } - }, - "CacheNodeId": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The node ID of the cache cluster

" - } - }, - "NodeDeletionDate": { - "target": "com.amazonaws.elasticache#TStamp", - "traits": { - "smithy.api#documentation": "

The deletion date of the node

" - } } }, "traits": { @@ -1130,24 +1210,12 @@ "com.amazonaws.elasticache#CacheParameterGroup": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The description for this cache parameter group.

" - } - }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The name of the cache parameter group.

" } }, - "IsGlobal": { - "target": "com.amazonaws.elasticache#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the parameter group is associated with a Global Datastore

" - } - }, "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -1159,6 +1227,18 @@ "traits": { "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache parameter group.

" } + }, + "IsGlobal": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the parameter group is associated with a Global Datastore

" + } + }, + "Description": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The description for this cache parameter group.

" + } } }, "traits": { @@ -1181,6 +1261,12 @@ "com.amazonaws.elasticache#CacheParameterGroupDetails": { "type": "structure", "members": { + "CacheNodeTypeSpecificParameters": { + "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameters specific to a particular cache node type. \n Each element in the list contains detailed information about one parameter.

" + } + }, "Parameters": { "target": "com.amazonaws.elasticache#ParametersList", "traits": { @@ -1192,12 +1278,6 @@ "traits": { "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" } - }, - "CacheNodeTypeSpecificParameters": { - "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", - "traits": { - "smithy.api#documentation": "

A list of parameters specific to a particular cache node type. \n Each element in the list contains detailed information about one parameter.

" - } } }, "traits": { @@ -1256,12 +1336,6 @@ "com.amazonaws.elasticache#CacheParameterGroupStatus": { "type": "structure", "members": { - "CacheParameterGroupName": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The name of the cache parameter group.

" - } - }, "ParameterApplyStatus": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -1273,6 +1347,12 @@ "traits": { "smithy.api#documentation": "

A list of the cache node IDs which need to be rebooted for parameter changes to be applied. \n A node ID is a numeric identifier (0001, 0002, etc.).

" } + }, + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the cache parameter group.

" + } } }, "traits": { @@ -1282,17 +1362,17 @@ "com.amazonaws.elasticache#CacheParameterGroupsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" - } - }, "CacheParameterGroups": { "target": "com.amazonaws.elasticache#CacheParameterGroupList", "traits": { "smithy.api#documentation": "

A list of cache parameter groups. Each element in the list contains detailed information \n about one cache parameter group.

" } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + } } }, "traits": { @@ -1302,16 +1382,16 @@ "com.amazonaws.elasticache#CacheSecurityGroup": { "type": "structure", "members": { - "CacheSecurityGroupName": { + "Description": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache security group.

" + "smithy.api#documentation": "

The description of the cache security group.

" } }, - "ARN": { + "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache security group.

" + "smithy.api#documentation": "

The name of the cache security group.

" } }, "OwnerId": { @@ -1320,17 +1400,17 @@ "smithy.api#documentation": "

The AWS account ID of the cache security group owner.

" } }, - "Description": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The description of the cache security group.

" - } - }, "EC2SecurityGroups": { "target": "com.amazonaws.elasticache#EC2SecurityGroupList", "traits": { "smithy.api#documentation": "

A list of Amazon EC2 security groups that are associated with this cache security group.

" } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ARN of the cache security group,

" + } } }, "traits": { @@ -1382,17 +1462,17 @@ "com.amazonaws.elasticache#CacheSecurityGroupMessage": { "type": "structure", "members": { - "CacheSecurityGroups": { - "target": "com.amazonaws.elasticache#CacheSecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of cache security groups. Each element in the list contains detailed information about one group.

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" } + }, + "CacheSecurityGroups": { + "target": "com.amazonaws.elasticache#CacheSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of cache security groups. Each element in the list contains detailed information about one group.

" + } } }, "traits": { @@ -1446,16 +1526,16 @@ "com.amazonaws.elasticache#CacheSubnetGroup": { "type": "structure", "members": { - "Subnets": { - "target": "com.amazonaws.elasticache#SubnetList", + "VpcId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of subnets associated with the cache subnet group.

" + "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" } }, - "CacheSubnetGroupName": { - "target": "com.amazonaws.elasticache#String", + "Subnets": { + "target": "com.amazonaws.elasticache#SubnetList", "traits": { - "smithy.api#documentation": "

The name of the cache subnet group.

" + "smithy.api#documentation": "

A list of subnets associated with the cache subnet group.

" } }, "ARN": { @@ -1464,16 +1544,16 @@ "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the cache subnet group.

" } }, - "CacheSubnetGroupDescription": { + "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The description of the cache subnet group.

" + "smithy.api#documentation": "

The name of the cache subnet group.

" } }, - "VpcId": { + "CacheSubnetGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" + "smithy.api#documentation": "

The description of the cache subnet group.

" } } }, @@ -1636,18 +1716,18 @@ "com.amazonaws.elasticache#CompleteMigrationMessage": { "type": "structure", "members": { - "Force": { - "target": "com.amazonaws.elasticache#Boolean", - "traits": { - "smithy.api#documentation": "

Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

" - } - }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The ID of the replication group to which data is being migrated.

", "smithy.api#required": {} } + }, + "Force": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

" + } } } }, @@ -1675,6 +1755,12 @@ "smithy.api#required": {} } }, + "PreferredOutpostArns": { + "target": "com.amazonaws.elasticache#PreferredOutpostArnList", + "traits": { + "smithy.api#documentation": "

The outpost ARNs in which the cache cluster is created.

" + } + }, "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { @@ -1722,12 +1808,6 @@ "com.amazonaws.elasticache#CopySnapshotMessage": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key used to encrypt the target snapshot.

" - } - }, "SourceSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -1747,6 +1827,12 @@ "smithy.api#documentation": "

A name for the snapshot copy.\n ElastiCache does not permit overwriting a snapshot, therefore\n this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

", "smithy.api#required": {} } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the target snapshot.

" + } } }, "traits": { @@ -1820,41 +1906,28 @@ "com.amazonaws.elasticache#CreateCacheClusterMessage": { "type": "structure", "members": { - "PreferredAvailabilityZone": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The EC2 Availability Zone in which the cluster is created.

\n

All nodes belonging to this cluster are placed in the preferred Availability Zone. \n If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

\n

Default: System chosen Availability Zone.

" - } - }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The name of the cache engine to be used for this cluster.

\n

Valid values for this parameter are: memcached | redis\n

" } }, - "CacheSecurityGroupNames": { - "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { - "smithy.api#documentation": "

A list of security group names to associate with this cluster.

\n

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

" + "smithy.api#documentation": "

One or more VPC security groups associated with the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

" } }, - "Port": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

The port number on which each of the cache nodes accepts connections.

" - } - }, - "CacheClusterId": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The node group (shard) identifier. This parameter is stored as a lowercase string.

\n

\n Constraints:\n

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

This parameter is currently disabled.

" } }, - "SnapshotName": { + "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of a Redis snapshot from which to restore data into the new node group (shard).\n The snapshot status changes to restoring while the new node group (shard) is being created.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n " + "smithy.api#documentation": "

The EC2 Availability Zone in which the cluster is created.

\n

All nodes belonging to this cluster are placed in the preferred Availability Zone. \n If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

\n

Default: System chosen Availability Zone.

" } }, "PreferredAvailabilityZones": { @@ -1863,16 +1936,10 @@ "smithy.api#documentation": "

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

\n

This option is only supported on Memcached.

\n \n

If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

\n

The number of Availability Zones listed must equal the value of NumCacheNodes.

\n \n

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or \n repeat the Availability Zone multiple times in the list.

\n

Default: System chosen Availability Zones.

" } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n Valid values for ddd are:

\n \n

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "PreferredOutpostArns": { + "target": "com.amazonaws.elasticache#PreferredOutpostArnList", "traits": { - "smithy.api#documentation": "

This parameter is currently disabled.

" + "smithy.api#documentation": "

The outpost ARNs in which the cache cluster is created.

" } }, "EngineVersion": { @@ -1881,16 +1948,16 @@ "smithy.api#documentation": "

The version number of the cache engine to be used for this cluster. \n To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

\n \n

\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster or replication group and create it anew with the earlier engine version.

" } }, - "NotificationTopicArn": { + "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, - "SecurityGroupIds": { - "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

One or more VPC security groups associated with the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

" + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n Valid values for ddd are:

\n \n

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" } }, "CacheParameterGroupName": { @@ -1899,16 +1966,34 @@ "smithy.api#documentation": "

The name of the parameter group to associate with this cluster. \n If this argument is omitted, the default parameter group for the specified engine is used.\n You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

" } }, - "NumCacheNodes": { + "AZMode": { + "target": "com.amazonaws.elasticache#AZMode", + "traits": { + "smithy.api#documentation": "

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or \n created across multiple Availability Zones in the cluster's region.

\n

This parameter is only supported for Memcached clusters.

\n

If the AZMode and PreferredAvailabilityZones are not specified, \n ElastiCache assumes single-az mode.

" + } + }, + "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The initial number of cache nodes that the cluster has.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 20.

\n

If you need more than 20 nodes for your Memcached cluster, \n please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

" + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit to 5,\n a snapshot taken today is retained for 5 days before being deleted.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n \n

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" } }, - "CacheNodeType": { + "SnapshotArns": { + "target": "com.amazonaws.elasticache#SnapshotArnsList", + "traits": { + "smithy.api#documentation": "

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies \n a Redis RDB snapshot file stored in Amazon S3.\n The snapshot file is used to populate the node group (shard). \n The Amazon S3 object name in the ARN cannot contain any commas.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n \n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + } + }, + "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The name of the subnet group to be used for the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

\n \n

If you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.

\n " + } + }, + "AuthToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

\n Reserved parameter. \n The password used to access a password protected server.

\n

Password constraints:

\n \n

For more information, see AUTH password at http://redis.io/commands/AUTH.

" } }, "SnapshotWindow": { @@ -1917,46 +2002,65 @@ "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n " } }, - "Tags": { - "target": "com.amazonaws.elasticache#TagList", + "NotificationTopicArn": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of cost allocation tags to be added to this resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " } }, - "ReplicationGroupId": { + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The initial number of cache nodes that the cluster has.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 20.

\n

If you need more than 20 nodes for your Memcached cluster, \n please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

" + } + }, + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

\n

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n " + "smithy.api#documentation": "

The node group (shard) identifier. This parameter is stored as a lowercase string.

\n

\n Constraints:\n

\n ", + "smithy.api#required": {} } }, - "SnapshotRetentionLimit": { + "PreferredOutpostArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The outpost ARN in which the cache cluster is created.

" + } + }, + "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit to 5,\n a snapshot taken today is retained for 5 days before being deleted.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n \n

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" + "smithy.api#documentation": "

The port number on which each of the cache nodes accepts connections.

" } }, - "AuthToken": { + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

\n Reserved parameter. \n The password used to access a password protected server.

\n

Password constraints:

\n \n

For more information, see AUTH password at http://redis.io/commands/AUTH.

" + "smithy.api#documentation": "

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

\n

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n " } }, - "CacheSubnetGroupName": { + "Tags": { + "target": "com.amazonaws.elasticache#TagList", + "traits": { + "smithy.api#documentation": "

A list of cost allocation tags to be added to this resource.

" + } + }, + "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the subnet group to be used for the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

\n \n

If you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.

\n " + "smithy.api#documentation": "

The name of a Redis snapshot from which to restore data into the new node group (shard).\n The snapshot status changes to restoring while the new node group (shard) is being created.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n " } }, - "SnapshotArns": { - "target": "com.amazonaws.elasticache#SnapshotArnsList", + "OutpostMode": { + "target": "com.amazonaws.elasticache#OutpostMode", "traits": { - "smithy.api#documentation": "

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies \n a Redis RDB snapshot file stored in Amazon S3.\n The snapshot file is used to populate the node group (shard). \n The Amazon S3 object name in the ARN cannot contain any commas.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n \n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + "smithy.api#documentation": "

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

" } }, - "AZMode": { - "target": "com.amazonaws.elasticache#AZMode", + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or \n created across multiple Availability Zones in the cluster's region.

\n

This parameter is only supported for Memcached clusters.

\n

If the AZMode and PreferredAvailabilityZones are not specified, \n ElastiCache assumes single-az mode.

" + "smithy.api#documentation": "

A list of security group names to associate with this cluster.

\n

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

" } } }, @@ -2004,24 +2108,24 @@ "com.amazonaws.elasticache#CreateCacheParameterGroupMessage": { "type": "structure", "members": { - "CacheParameterGroupName": { + "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A user-specified name for the cache parameter group.

", + "smithy.api#documentation": "

The name of the cache parameter group family that the cache parameter group can be used with.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n

", "smithy.api#required": {} } }, - "CacheParameterGroupFamily": { + "Description": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache parameter group family that the cache parameter group can be used with.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n

", + "smithy.api#documentation": "

A user-specified description for the cache parameter group.

", "smithy.api#required": {} } }, - "Description": { + "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A user-specified description for the cache parameter group.

", + "smithy.api#documentation": "

A user-specified name for the cache parameter group.

", "smithy.api#required": {} } } @@ -2067,17 +2171,17 @@ "com.amazonaws.elasticache#CreateCacheSecurityGroupMessage": { "type": "structure", "members": { - "CacheSecurityGroupName": { + "Description": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A name for the cache security group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".

\n

Example: mysecuritygroup\n

", + "smithy.api#documentation": "

A description for the cache security group.

", "smithy.api#required": {} } }, - "Description": { + "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A description for the cache security group.

", + "smithy.api#documentation": "

A name for the cache security group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".

\n

Example: mysecuritygroup\n

", "smithy.api#required": {} } } @@ -2114,6 +2218,9 @@ }, { "target": "com.amazonaws.elasticache#InvalidSubnet" + }, + { + "target": "com.amazonaws.elasticache#SubnetNotAllowedFault" } ], "traits": { @@ -2123,13 +2230,6 @@ "com.amazonaws.elasticache#CreateCacheSubnetGroupMessage": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.elasticache#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

A list of VPC subnet IDs for the cache subnet group.

", - "smithy.api#required": {} - } - }, "CacheSubnetGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -2143,6 +2243,13 @@ "smithy.api#documentation": "

A name for the cache subnet group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n

Example: mysubnetgroup\n

", "smithy.api#required": {} } + }, + "SubnetIds": { + "target": "com.amazonaws.elasticache#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs for the cache subnet group.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2189,24 +2296,24 @@ "com.amazonaws.elasticache#CreateGlobalReplicationGroupMessage": { "type": "structure", "members": { - "GlobalReplicationGroupIdSuffix": { + "GlobalReplicationGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The suffix name of a Global Datastore. The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Provides details of the Global Datastore

" } }, - "PrimaryReplicationGroupId": { + "GlobalReplicationGroupIdSuffix": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

", + "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": {} } }, - "GlobalReplicationGroupDescription": { + "PrimaryReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Provides details of the Global Datastore

" + "smithy.api#documentation": "

The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

", + "smithy.api#required": {} } } } @@ -2261,6 +2368,9 @@ { "target": "com.amazonaws.elasticache#InvalidParameterValueException" }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, { "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" }, @@ -2278,6 +2388,9 @@ }, { "target": "com.amazonaws.elasticache#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" } ], "traits": { @@ -2287,113 +2400,95 @@ "com.amazonaws.elasticache#CreateReplicationGroupMessage": { "type": "structure", "members": { - "TransitEncryptionEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

You cannot modify the value of TransitEncryptionEnabled\n after the cluster is created. To enable in-transit encryption on a cluster\n you must set TransitEncryptionEnabled to true\n when you create a cluster.

\n

This parameter is valid only if the Engine parameter is redis,\n the EngineVersion parameter is 3.2.6, 4.x or later,\n and the cluster is being created in an Amazon VPC.

\n

If you enable in-transit encryption, you must also specify a value for \n CacheSubnetGroup.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.

\n " - } - }, - "Engine": { - "target": "com.amazonaws.elasticache#String", + "Tags": { + "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "

The name of the cache engine to be used for the clusters in this replication group.

" + "smithy.api#documentation": "

A list of cost allocation tags to be added to this resource. \n Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: \n Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

" } }, - "SnapshotWindow": { - "target": "com.amazonaws.elasticache#String", + "UserGroupIds": { + "target": "com.amazonaws.elasticache#UserGroupIdListInput", "traits": { - "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

" + "smithy.api#documentation": "

The list of user groups to associate with the replication group.

" } }, - "AuthToken": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

\n Reserved parameter. \n The password used to access a password protected server.

\n

\n AuthToken can be specified only on replication groups where TransitEncryptionEnabled is \n true.

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.

\n \n

Password constraints:

\n \n

For more information, see AUTH password at http://redis.io/commands/AUTH.

" + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n Valid values for ddd are:

\n \n

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" } }, - "CacheSubnetGroupName": { + "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache subnet group to be used for the replication group.

\n \n

If you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.

\n " + "smithy.api#documentation": "

The identifier of the cluster that serves as the primary for this replication\n group. This cluster must already exist and have a status of available.

\n

This parameter is not required if NumCacheClusters,\n NumNodeGroups, or\n ReplicasPerNodeGroup is specified.

" } }, - "Port": { + "ReplicasPerNodeGroup": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which each member of the replication group accepts connections.

" - } - }, - "AtRestEncryptionEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled after the replication\n group is created. \n To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to \n true when you create the replication group.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" + "smithy.api#documentation": "

An optional parameter that specifies the number of replica nodes in each node group (shard).\n Valid values are 0 to 5.

" } }, - "PrimaryClusterId": { + "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the cluster that serves as the primary for this replication\n group. This cluster must already exist and have a status of available.

\n

This parameter is not required if NumCacheClusters,\n NumNodeGroups, or\n ReplicasPerNodeGroup is specified.

" + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the disk in the cluster.

" } }, - "GlobalReplicationGroupId": { + "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

" + "smithy.api#documentation": "

The name of a snapshot from which to restore data into the new replication group.\n The snapshot status changes to restoring while the new replication group is being created.

" } }, - "AutomaticFailoverEnabled": { + "AtRestEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

\n \n

\n AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

\n \n

Default: false

" + "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled after the replication\n group is created. \n To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to \n true when you create the replication group.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" } }, - "PreferredCacheClusterAZs": { - "target": "com.amazonaws.elasticache#AvailabilityZonesList", + "NumNodeGroups": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

A list of EC2 Availability Zones in which the replication group's clusters are created. \n The order of the Availability Zones in the list is the order in which clusters are allocated. \n The primary cluster is created in the first AZ in the list.

\n

This parameter is not used if there is more than one node group (shard). \n You should use NodeGroupConfiguration instead.

\n \n

If you are creating your replication group in an Amazon VPC (recommended), \n you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

\n

The number of Availability Zones listed must equal the value of NumCacheClusters.

\n \n

Default: system chosen Availability Zones.

" + "smithy.api#documentation": "

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. \n For Redis (cluster mode disabled) either omit this parameter or set it to 1.

\n

Default: 1

" } }, - "ReplicationGroupDescription": { - "target": "com.amazonaws.elasticache#String", + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

A user-created description for the replication group.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit to 5, \n a snapshot that was taken today is retained for 5 days before being deleted.

\n

Default: 0 (i.e., automatic backups are disabled for this cluster).

" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

One or more Amazon VPC security groups associated with this replication group.

\n

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

" + "smithy.api#documentation": "

A list of cache security group names to associate with this replication group.

" } }, - "EngineVersion": { + "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The version number of the cache engine to be used for the clusters in this replication group. \n To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

\n\n

\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, \n but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster or replication group and \n create it anew with the earlier engine version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) \n topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " } }, - "CacheNodeType": { + "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The name of the parameter group to associate with this replication group. \n If this argument is omitted, the default cache parameter group for the specified engine is\n used.

\n \n

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

\n \n

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, \n we recommend that you specify the parameter group by name.

\n " } }, - "SnapshotName": { + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of a snapshot from which to restore data into the new replication group.\n The snapshot status changes to restoring while the new replication group is being created.

" - } - }, - "SnapshotRetentionLimit": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit to 5, \n a snapshot that was taken today is retained for 5 days before being deleted.

\n

Default: 0 (i.e., automatic backups are disabled for this cluster).

" + "smithy.api#documentation": "

The replication group identifier. This parameter is stored as a lowercase string.

\n \n

Constraints:

\n ", + "smithy.api#required": {} } }, - "ReplicasPerNodeGroup": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "Engine": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

An optional parameter that specifies the number of replica nodes in each node group (shard).\n Valid values are 0 to 5.

" + "smithy.api#documentation": "

The name of the cache engine to be used for the clusters in this replication group.

" } }, "NumCacheClusters": { @@ -2402,22 +2497,46 @@ "smithy.api#documentation": "

The number of clusters this replication group initially has.

\n

This parameter is not used if there is more than one node group (shard). \n You should use ReplicasPerNodeGroup instead.

\n

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2.\n If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you\n can explicitly set it to a value between 2 and 6.

\n

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

" } }, - "Tags": { - "target": "com.amazonaws.elasticache#TagList", + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of cost allocation tags to be added to this resource. \n Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: \n Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

" + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

" } }, - "NumNodeGroups": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. \n For Redis (cluster mode disabled) either omit this parameter or set it to 1.

\n

Default: 1

" + "MultiAZEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

" } }, - "CacheSecurityGroupNames": { - "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A list of cache security group names to associate with this replication group.

" + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

You cannot modify the value of TransitEncryptionEnabled\n after the cluster is created. To enable in-transit encryption on a cluster\n you must set TransitEncryptionEnabled to true\n when you create a cluster.

\n

This parameter is valid only if the Engine parameter is redis,\n the EngineVersion parameter is 3.2.6, 4.x or later,\n and the cluster is being created in an Amazon VPC.

\n

If you enable in-transit encryption, you must also specify a value for \n CacheSubnetGroup.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.

\n " + } + }, + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

This parameter is currently disabled.

" + } + }, + "AuthToken": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

\n Reserved parameter. \n The password used to access a password protected server.

\n

\n AuthToken can be specified only on replication groups where TransitEncryptionEnabled is \n true.

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.

\n \n

Password constraints:

\n \n

For more information, see AUTH password at http://redis.io/commands/AUTH.

" + } + }, + "AutomaticFailoverEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

\n \n

\n AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

\n \n

Default: false

" } }, "NodeGroupConfiguration": { @@ -2426,10 +2545,10 @@ "smithy.api#documentation": "

A list of node group (shard) configuration options. \n Each node group (shard) configuration has the following members:\n PrimaryAvailabilityZone,\n ReplicaAvailabilityZones,\n ReplicaCount, and \n Slots.

\n

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to \n individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a \n Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter \n because you must specify the slots for each node group.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.elasticache#String", + "PreferredCacheClusterAZs": { + "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { - "smithy.api#documentation": "

The ID of the KMS key used to encrypt the disk in the cluster.

" + "smithy.api#documentation": "

A list of EC2 Availability Zones in which the replication group's clusters are created. \n The order of the Availability Zones in the list is the order in which clusters are allocated. \n The primary cluster is created in the first AZ in the list.

\n

This parameter is not used if there is more than one node group (shard). \n You should use NodeGroupConfiguration instead.

\n \n

If you are creating your replication group in an Amazon VPC (recommended), \n you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

\n

The number of Availability Zones listed must equal the value of NumCacheClusters.

\n \n

Default: system chosen Availability Zones.

" } }, "SnapshotArns": { @@ -2438,41 +2557,41 @@ "smithy.api#documentation": "

A list of Amazon Resource Names (ARN) that uniquely identify \n the Redis RDB snapshot files stored in Amazon S3. \n The snapshot files are used to populate the new replication group. \n The Amazon S3 object name in the ARN cannot contain any commas. \n The new replication group will have the number of node groups (console: shards)\n specified by the parameter NumNodeGroups or the number of\n node groups configured by NodeGroupConfiguration regardless \n of the number of ARNs specified here.

\n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" } }, - "CacheParameterGroupName": { + "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the parameter group to associate with this replication group. \n If this argument is omitted, the default cache parameter group for the specified engine is\n used.

\n \n

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

\n \n

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, \n we recommend that you specify the parameter group by name.

\n " + "smithy.api#documentation": "

The name of the Global Datastore

" } }, - "NotificationTopicArn": { + "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) \n topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " + "smithy.api#documentation": "

The name of the cache subnet group to be used for the replication group.

\n \n

If you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.

\n " } }, - "MultiAZEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "ReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

" + "smithy.api#documentation": "

A user-created description for the replication group.

", + "smithy.api#required": {} } }, - "ReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { - "smithy.api#documentation": "

The replication group identifier. This parameter is stored as a lowercase string.

\n \n

Constraints:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more Amazon VPC security groups associated with this replication group.

\n

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

" } }, - "PreferredMaintenanceWindow": { + "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n Valid values for ddd are:

\n \n

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" + "smithy.api#documentation": "

The version number of the cache engine to be used for the clusters in this replication group. \n To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

\n\n

\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, \n but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster or replication group and \n create it anew with the earlier engine version.

" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "Port": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

This parameter is currently disabled.

" + "smithy.api#documentation": "

The port number on which each member of the replication group accepts connections.

" } } }, @@ -2532,17 +2651,17 @@ "com.amazonaws.elasticache#CreateSnapshotMessage": { "type": "structure", "members": { - "CacheClusterId": { + "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of an existing cluster. The snapshot is created from this cluster.

" + "smithy.api#documentation": "

A name for the snapshot being created.

", + "smithy.api#required": {} } }, - "SnapshotName": { + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A name for the snapshot being created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The identifier of an existing cluster. The snapshot is created from this cluster.

" } }, "KmsKeyId": { @@ -2570,20 +2689,151 @@ } } }, - "com.amazonaws.elasticache#CustomerNodeEndpoint": { + "com.amazonaws.elasticache#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateUserMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#User" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#UserAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#UserQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Redis engine version 6.04 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

" + } + }, + "com.amazonaws.elasticache#CreateUserGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#CreateUserGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UserGroup" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DefaultUserRequired" + }, + { + "target": "com.amazonaws.elasticache#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#UserGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Redis engine version 6.04 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) \n

" + } + }, + "com.amazonaws.elasticache#CreateUserGroupMessage": { "type": "structure", "members": { - "Address": { + "UserIds": { + "target": "com.amazonaws.elasticache#UserIdListInput", + "traits": { + "smithy.api#documentation": "

The list of user IDs that belong to the user group.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

Must be Redis.

", + "smithy.api#required": {} + } + }, + "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The address of the node endpoint

" + "smithy.api#documentation": "

The ID of the user group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.elasticache#CreateUserMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

Must be Redis.

", + "smithy.api#required": {} + } + }, + "NoPasswordRequired": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates a password is not required for this user account.

" + } + }, + "UserName": { + "target": "com.amazonaws.elasticache#UserName", + "traits": { + "smithy.api#documentation": "

The username of the user.

", + "smithy.api#required": {} + } + }, + "AccessString": { + "target": "com.amazonaws.elasticache#AccessString", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user account.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#documentation": "

The ID of the user.

", + "smithy.api#required": {} } }, + "Passwords": { + "target": "com.amazonaws.elasticache#PasswordListInput", + "traits": { + "smithy.api#documentation": "

Passwords used for this user account. You can create up to two passwords for each user.

" + } + } + } + }, + "com.amazonaws.elasticache#CustomerNodeEndpoint": { + "type": "structure", + "members": { "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "

The port of the node endpoint

" } + }, + "Address": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The address of the node endpoint

" + } } }, "traits": { @@ -2625,12 +2875,6 @@ "com.amazonaws.elasticache#DecreaseNodeGroupsInGlobalReplicationGroupMessage": { "type": "structure", "members": { - "GlobalNodeGroupsToRemove": { - "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", - "traits": { - "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n \n ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

" - } - }, "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -2657,6 +2901,12 @@ "traits": { "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n \n ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

" } + }, + "GlobalNodeGroupsToRemove": { + "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", + "traits": { + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n \n ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

" + } } } }, @@ -2721,35 +2971,35 @@ "com.amazonaws.elasticache#DecreaseReplicaCountMessage": { "type": "structure", "members": { + "NewReplicaCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.

\n

The minimum number of replicas in a shard or replication group is:

\n " + } + }, "ReplicasToRemove": { "target": "com.amazonaws.elasticache#RemoveReplicasList", "traits": { "smithy.api#documentation": "

A list of the node ids to remove from the replication group or node group (shard).

" } }, - "ApplyImmediately": { - "target": "com.amazonaws.elasticache#Boolean", + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

If True, the number of replica nodes is decreased immediately. \n\n ApplyImmediately=False is not currently supported.

", + "smithy.api#documentation": "

The id of the replication group from which you want to remove replica nodes.

", "smithy.api#required": {} } }, - "NewReplicaCount": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.

\n

The minimum number of replicas in a shard or replication group is:

\n " - } - }, "ReplicaConfiguration": { "target": "com.amazonaws.elasticache#ReplicaConfigurationList", "traits": { "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each shard\n in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members:\n NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

" } }, - "ReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

The id of the replication group from which you want to remove replica nodes.

", + "smithy.api#documentation": "

If True, the number of replica nodes is decreased immediately. \n\n ApplyImmediately=False is not currently supported.

", "smithy.api#required": {} } } @@ -2763,6 +3013,32 @@ } } }, + "com.amazonaws.elasticache#DefaultUserAssociatedToUserGroupFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#DefaultUserRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You must add default user to a user group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.elasticache#DeleteCacheCluster": { "type": "operation", "input": { @@ -2801,17 +3077,17 @@ "com.amazonaws.elasticache#DeleteCacheClusterMessage": { "type": "structure", "members": { - "FinalSnapshotIdentifier": { + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. \n ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

" + "smithy.api#documentation": "

The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

", + "smithy.api#required": {} } }, - "CacheClusterId": { + "FinalSnapshotIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. \n ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

" } } }, @@ -2961,21 +3237,21 @@ "com.amazonaws.elasticache#DeleteGlobalReplicationGroupMessage": { "type": "structure", "members": { - "GlobalReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

", - "smithy.api#required": {} - } - }, "RetainPrimaryReplicationGroup": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "

The primary replication group is retained as a standalone replication group.

", "smithy.api#required": {} } - } - } + }, + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Global Datastore

", + "smithy.api#required": {} + } + } + } }, "com.amazonaws.elasticache#DeleteGlobalReplicationGroupResult": { "type": "structure", @@ -3023,10 +3299,10 @@ "com.amazonaws.elasticache#DeleteReplicationGroupMessage": { "type": "structure", "members": { - "RetainPrimaryCluster": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "FinalSnapshotIdentifier": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

If set to true, all of the read replicas are deleted, \n but the primary node is retained.

" + "smithy.api#documentation": "

The name of a final node group (shard) snapshot. \n ElastiCache creates the snapshot from the primary node in the cluster, \n rather than one of the replicas; this is to ensure that it captures the freshest data. \n After the final snapshot is taken, the replication group is immediately deleted.

" } }, "ReplicationGroupId": { @@ -3036,10 +3312,10 @@ "smithy.api#required": {} } }, - "FinalSnapshotIdentifier": { - "target": "com.amazonaws.elasticache#String", + "RetainPrimaryCluster": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

The name of a final node group (shard) snapshot. \n ElastiCache creates the snapshot from the primary node in the cluster, \n rather than one of the replicas; this is to ensure that it captures the freshest data. \n After the final snapshot is taken, the replication group is immediately deleted.

" + "smithy.api#documentation": "

If set to true, all of the read replicas are deleted, \n but the primary node is retained.

" } } }, @@ -3104,6 +3380,79 @@ } } }, + "com.amazonaws.elasticache#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteUserMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#User" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DefaultUserAssociatedToUserGroupFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Redis engine version 6.04 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).

" + } + }, + "com.amazonaws.elasticache#DeleteUserGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DeleteUserGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UserGroup" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

For Redis engine version 6.04 onwards: Deletes a ser group. The user group must first be disassociated from the replcation group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

" + } + }, + "com.amazonaws.elasticache#DeleteUserGroupMessage": { + "type": "structure", + "members": { + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the user group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.elasticache#DeleteUserMessage": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#documentation": "

The ID of the user.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.elasticache#DescribeCacheClusters": { "type": "operation", "input": { @@ -3136,22 +3485,16 @@ "com.amazonaws.elasticache#DescribeCacheClustersMessage": { "type": "structure", "members": { - "ShowCacheNodeInfo": { - "target": "com.amazonaws.elasticache#BooleanOptional", - "traits": { - "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request \n to retrieve information about the individual cache nodes.

" - } - }, "ShowCacheClustersNotInReplicationGroups": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request\n to show only nodes (API/CLI: clusters) that are not members of a replication group.\n In practice, this mean Memcached and single node Redis clusters.

" } }, - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + "smithy.api#documentation": "

The user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cluster is returned. This parameter isn't case sensitive.

" } }, "Marker": { @@ -3160,10 +3503,16 @@ "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } }, - "CacheClusterId": { - "target": "com.amazonaws.elasticache#String", + "ShowCacheNodeInfo": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

The user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cluster is returned. This parameter isn't case sensitive.

" + "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request \n to retrieve information about the individual cache nodes.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" } } }, @@ -3192,22 +3541,16 @@ "com.amazonaws.elasticache#DescribeCacheEngineVersionsMessage": { "type": "structure", "members": { - "EngineVersion": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The cache engine version to return.

\n

Example: 1.4.14\n

" - } - }, "DefaultOnly": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#documentation": "

If true, specifies that only the default version of the specified engine or engine\n and major version combination is to be returned.

" } }, - "Engine": { + "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache engine to return. Valid values: memcached | redis\n

" + "smithy.api#documentation": "

The cache engine version to return.

\n

Example: 1.4.14\n

" } }, "Marker": { @@ -3216,16 +3559,22 @@ "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The name of a specific cache parameter group family to return details for.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n

\n

Constraints:

\n " } }, - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "Engine": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + "smithy.api#documentation": "

The cache engine to return. Valid values: memcached | redis\n

" } } }, @@ -3265,12 +3614,6 @@ "com.amazonaws.elasticache#DescribeCacheParameterGroupsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -3282,6 +3625,12 @@ "traits": { "smithy.api#documentation": "

The name of a specific cache parameter group to return details for.

" } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } } }, "traits": { @@ -3382,18 +3731,18 @@ "com.amazonaws.elasticache#DescribeCacheSecurityGroupsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -3431,12 +3780,6 @@ "com.amazonaws.elasticache#DescribeCacheSubnetGroupsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -3448,6 +3791,12 @@ "traits": { "smithy.api#documentation": "

The name of the cache subnet group to return details for.

" } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } } }, "traits": { @@ -3471,17 +3820,22 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the default engine and\n system parameter information for the specified cache engine.

" + "smithy.api#documentation": "

Returns the default engine and\n system parameter information for the specified cache engine.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "EngineDefaults.Marker", + "items": "EngineDefaults.Parameters", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.elasticache#DescribeEngineDefaultParametersMessage": { "type": "structure", "members": { - "CacheParameterGroupFamily": { - "target": "com.amazonaws.elasticache#String", + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The name of the cache parameter group family.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" } }, "Marker": { @@ -3490,10 +3844,11 @@ "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } }, - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + "smithy.api#documentation": "

The name of the cache parameter group family.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n

", + "smithy.api#required": {} } } }, @@ -3538,30 +3893,18 @@ "com.amazonaws.elasticache#DescribeEventsMessage": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.elasticache#TStamp", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

\n

\n Example: 2017-03-30T07:03:49.555Z

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.

" - } - }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { "smithy.api#documentation": "

The event source to retrieve events for. \n If no value is specified, all events are returned.

" } }, + "EndTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

\n

\n Example: 2017-03-30T07:03:49.555Z

" + } + }, "StartTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { @@ -3574,11 +3917,23 @@ "smithy.api#documentation": "

The identifier of the event source for which events are returned. \n If not specified, all sources are included in the response.

" } }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.

" + } + }, "Duration": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "

The number of minutes worth of events to retrieve.

" } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } } }, "traits": { @@ -3617,18 +3972,18 @@ "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

" - } - }, "ShowMemberInfo": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "

Returns the list of members that comprise the Global Datastore.

" } }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

" + } + }, "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -3646,17 +4001,17 @@ "com.amazonaws.elasticache#DescribeGlobalReplicationGroupsResult": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

" - } - }, "GlobalReplicationGroups": { "target": "com.amazonaws.elasticache#GlobalReplicationGroupList", "traits": { "smithy.api#documentation": "

Indicates the slot configuration and global identifier for each slice group.

" } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

" + } } } }, @@ -3747,16 +4102,16 @@ "com.amazonaws.elasticache#DescribeReservedCacheNodesMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, - "ReservedCacheNodesOfferingId": { + "Duration": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The offering identifier filter value. \n Use this parameter to show only purchased reservations matching the specified offering identifier.

" + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" } }, "OfferingType": { @@ -3765,6 +4120,18 @@ "smithy.api#documentation": "

The offering type filter value. \n Use this parameter to show only the available offerings matching the specified offering type.

\n

Valid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"\n

" } }, + "ReservedCacheNodesOfferingId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. \n Use this parameter to show only purchased reservations matching the specified offering identifier.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n\n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" + } + }, "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -3777,18 +4144,6 @@ "smithy.api#documentation": "

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

" } }, - "Duration": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" - } - }, - "CacheNodeType": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -3832,34 +4187,40 @@ "com.amazonaws.elasticache#DescribeReservedCacheNodesOfferingsMessage": { "type": "structure", "members": { + "Duration": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for a given duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, - "OfferingType": { + "ProductDescription": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The offering type filter value. \n Use this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"\n

" + "smithy.api#documentation": "

The product description filter value. \n Use this parameter to show only the available offerings matching the specified product description.

" } }, - "ReservedCacheNodesOfferingId": { + "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The offering identifier filter value. \n Use this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" + "smithy.api#documentation": "

The offering type filter value. \n Use this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"\n

" } }, - "Duration": { + "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for a given duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + "smithy.api#documentation": "

The offering identifier filter value. \n Use this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" } }, - "ProductDescription": { - "target": "com.amazonaws.elasticache#String", + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The product description filter value. \n Use this parameter to show only the available offerings matching the specified product description.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" } }, "Marker": { @@ -3867,12 +4228,6 @@ "traits": { "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.

" } - }, - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n \n

Default: 100

\n

Constraints: minimum 20; maximum 100.

" - } } }, "traits": { @@ -3911,10 +4266,16 @@ "com.amazonaws.elasticache#DescribeServiceUpdatesMessage": { "type": "structure", "members": { - "Marker": { + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response

" + } + }, + "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" + "smithy.api#documentation": "

The unique ID of the service update

" } }, "ServiceUpdateStatus": { @@ -3923,16 +4284,10 @@ "smithy.api#documentation": "

The status of the service update

" } }, - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response

" - } - }, - "ServiceUpdateName": { + "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The unique ID of the service update

" + "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } } } @@ -3992,28 +4347,22 @@ "com.amazonaws.elasticache#DescribeSnapshotsMessage": { "type": "structure", "members": { - "ShowNodeGroupConfig": { - "target": "com.amazonaws.elasticache#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

" - } - }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

A user-supplied replication group identifier.\n If this parameter is specified, only snapshots associated with that specific replication group are described.

" } }, - "SnapshotSource": { + "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

If set to system, the output shows snapshots that were automatically created by ElastiCache. \n If set to user the output shows snapshots that were manually created. \n If omitted, the output shows both automatically and manually created snapshots.

" + "smithy.api#documentation": "

A user-supplied name of the snapshot. \n If this parameter is specified, only this snapshot are described.

" } }, - "Marker": { - "target": "com.amazonaws.elasticache#String", + "ShowNodeGroupConfig": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.

" + "smithy.api#documentation": "

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

" } }, "CacheClusterId": { @@ -4022,16 +4371,22 @@ "smithy.api#documentation": "

A user-supplied cluster identifier. \n If this parameter is specified, only snapshots associated with that specific cluster are described.

" } }, - "SnapshotName": { + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 50

\n

Constraints: minimum 20; maximum 50.

" + } + }, + "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A user-supplied name of the snapshot. \n If this parameter is specified, only this snapshot are described.

" + "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.

" } }, - "MaxRecords": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "SnapshotSource": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 50

\n

Constraints: minimum 20; maximum 50.

" + "smithy.api#documentation": "

If set to system, the output shows snapshots that were automatically created by ElastiCache. \n If set to user the output shows snapshots that were manually created. \n If omitted, the output shows both automatically and manually created snapshots.

" } } }, @@ -4074,28 +4429,28 @@ "smithy.api#documentation": "

Dictates whether to include node level update status in the response

" } }, - "Engine": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Redis or Memcached

" - } - }, "UpdateActionStatus": { "target": "com.amazonaws.elasticache#UpdateActionStatusList", "traits": { "smithy.api#documentation": "

The status of the update action.

" } }, - "CacheClusterIds": { - "target": "com.amazonaws.elasticache#CacheClusterIdList", + "Marker": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache cluster IDs

" + "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } }, - "Marker": { + "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ServiceUpdateTimeRange": { + "target": "com.amazonaws.elasticache#TimeRangeFilter", + "traits": { + "smithy.api#documentation": "

The range of time specified to search for service updates that are in available status

" } }, "ServiceUpdateStatus": { @@ -4104,28 +4459,172 @@ "smithy.api#documentation": "

The status of the service update

" } }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Redis or Memcached

" + } + }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response

" } }, + "CacheClusterIds": { + "target": "com.amazonaws.elasticache#CacheClusterIdList", + "traits": { + "smithy.api#documentation": "

The cache cluster IDs

" + } + }, "ReplicationGroupIds": { "target": "com.amazonaws.elasticache#ReplicationGroupIdList", "traits": { "smithy.api#documentation": "

The replication group IDs

" } + } + } + }, + "com.amazonaws.elasticache#DescribeUserGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeUserGroupsMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeUserGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" }, - "ServiceUpdateName": { + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of user groups.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "UserGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeUserGroupsMessage": { + "type": "structure", + "members": { + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

" + } + }, + "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The unique ID of the service update

" + "smithy.api#documentation": "

The ID of the user group.

" } }, - "ServiceUpdateTimeRange": { - "target": "com.amazonaws.elasticache#TimeRangeFilter", + "Marker": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The range of time specified to search for service updates that are in available status

" + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

" + } + } + } + }, + "com.amazonaws.elasticache#DescribeUserGroupsResult": { + "type": "structure", + "members": { + "UserGroups": { + "target": "com.amazonaws.elasticache#UserGroupList", + "traits": { + "smithy.api#documentation": "

Returns a list of user groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

" + } + } + } + }, + "com.amazonaws.elasticache#DescribeUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#DescribeUsersMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#DescribeUsersResult" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of users.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Users", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.elasticache#DescribeUsersMessage": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#documentation": "

The ID of the user.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

The Redis engine.

" + } + }, + "Filters": { + "target": "com.amazonaws.elasticache#FilterList", + "traits": { + "smithy.api#documentation": "

Filter to determine the list of User IDs to return.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

" + } + } + } + }, + "com.amazonaws.elasticache#DescribeUsersResult": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.elasticache#UserList", + "traits": { + "smithy.api#documentation": "

A list of users.

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

" } } } @@ -4159,24 +4658,24 @@ "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage": { "type": "structure", "members": { - "ReplicationGroupId": { + "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the secondary cluster you wish to remove from the Global Datastore

", + "smithy.api#documentation": "

The name of the Global Datastore

", "smithy.api#required": {} } }, - "ReplicationGroupRegion": { + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS region of secondary cluster you wish to remove from the Global Datastore

", + "smithy.api#documentation": "

The name of the secondary cluster you wish to remove from the Global Datastore

", "smithy.api#required": {} } }, - "GlobalReplicationGroupId": { + "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

", + "smithy.api#documentation": "

The AWS region of secondary cluster you wish to remove from the Global Datastore

", "smithy.api#required": {} } } @@ -4193,15 +4692,22 @@ "com.amazonaws.elasticache#Double": { "type": "double" }, - "com.amazonaws.elasticache#EC2SecurityGroup": { + "com.amazonaws.elasticache#DuplicateUserNameFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A user with this username already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#EC2SecurityGroup": { "type": "structure", "members": { - "EC2SecurityGroupName": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon EC2 security group.

" - } - }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -4213,6 +4719,12 @@ "traits": { "smithy.api#documentation": "

The AWS account ID of the Amazon EC2 security group owner.

" } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon EC2 security group.

" + } } }, "traits": { @@ -4231,17 +4743,17 @@ "com.amazonaws.elasticache#Endpoint": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.elasticache#Integer", - "traits": { - "smithy.api#documentation": "

The port number that the cache engine is listening on.

" - } - }, "Address": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The DNS hostname of the cache node.

" } + }, + "Port": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#documentation": "

The port number that the cache engine is listening on.

" + } } }, "traits": { @@ -4251,16 +4763,10 @@ "com.amazonaws.elasticache#EngineDefaults": { "type": "structure", "members": { - "CacheParameterGroupFamily": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the cache parameter group family to which the engine default parameters apply.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n

" - } - }, - "Marker": { - "target": "com.amazonaws.elasticache#String", + "Parameters": { + "target": "com.amazonaws.elasticache#ParametersList", "traits": { - "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" + "smithy.api#documentation": "

Contains a list of engine default parameters.

" } }, "CacheNodeTypeSpecificParameters": { @@ -4269,10 +4775,16 @@ "smithy.api#documentation": "

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" } }, - "Parameters": { - "target": "com.amazonaws.elasticache#ParametersList", + "CacheParameterGroupFamily": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Contains a list of engine default parameters.

" + "smithy.api#documentation": "

Specifies the name of the cache parameter group family to which the engine default parameters apply.

\n

Valid values are: \n memcached1.4 | \n memcached1.5 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n

" + } + }, + "Marker": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" } } }, @@ -4280,6 +4792,12 @@ "smithy.api#documentation": "

Represents the output of a DescribeEngineDefaultParameters operation.

" } }, + "com.amazonaws.elasticache#EngineType": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-zA-Z]*" + } + }, "com.amazonaws.elasticache#Event": { "type": "structure", "members": { @@ -4289,12 +4807,6 @@ "smithy.api#documentation": "

The date and time when the event occurred.

" } }, - "SourceIdentifier": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source of the event. \n For example, if the event occurred at the cluster level, \n the identifier would be the name of the cluster.

" - } - }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { @@ -4306,6 +4818,12 @@ "traits": { "smithy.api#documentation": "

The text of the event.

" } + }, + "SourceIdentifier": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source of the event. \n For example, if the event occurred at the cluster level, \n the identifier would be the name of the cluster.

" + } } }, "traits": { @@ -4373,24 +4891,24 @@ "com.amazonaws.elasticache#FailoverGlobalReplicationGroupMessage": { "type": "structure", "members": { - "PrimaryReplicationGroupId": { + "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the primary replication group

", + "smithy.api#documentation": "

The name of the Global Datastore

", "smithy.api#required": {} } }, - "GlobalReplicationGroupId": { + "PrimaryRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

", + "smithy.api#documentation": "

The AWS region of the primary cluster of the Global Datastore

", "smithy.api#required": {} } }, - "PrimaryRegion": { + "PrimaryReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS region of the primary cluster of the Global Datastore

", + "smithy.api#documentation": "

The name of the primary replication group

", "smithy.api#required": {} } } @@ -4404,6 +4922,57 @@ } } }, + "com.amazonaws.elasticache#Filter": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.elasticache#FilterValueList", + "traits": { + "smithy.api#documentation": "

The property values to filter on. For example, \"user-123\".

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.elasticache#FilterName", + "traits": { + "smithy.api#documentation": "

The property being filtered. For example, UserId.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to streamline results of a search based on the property being filtered.

" + } + }, + "com.amazonaws.elasticache#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#Filter" + } + }, + "com.amazonaws.elasticache#FilterName": { + "type": "string", + "traits": { + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.elasticache#FilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.elasticache#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.elasticache#GlobalNodeGroup": { "type": "structure", "members": { @@ -4445,10 +5014,16 @@ "com.amazonaws.elasticache#GlobalReplicationGroup": { "type": "structure", "members": { - "TransitEncryptionEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "Members": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupMemberList", "traits": { - "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.\n \n You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

" + "smithy.api#documentation": "

The replication groups that comprise the Global Datastore.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Elasticache engine. For Redis only.

" } }, "ClusterEnabled": { @@ -4463,16 +5038,16 @@ "smithy.api#documentation": "

The optional description of the Global Datastore

" } }, - "Members": { - "target": "com.amazonaws.elasticache#GlobalReplicationGroupMemberList", + "Status": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The replication groups that comprise the Global Datastore.

" + "smithy.api#documentation": "

The status of the Global Datastore

" } }, - "GlobalReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", + "GlobalNodeGroups": { + "target": "com.amazonaws.elasticache#GlobalNodeGroupList", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

" + "smithy.api#documentation": "

Indicates the slot configuration and global identifier for each slice group.

" } }, "ARN": { @@ -4481,34 +5056,16 @@ "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the global replication group.

" } }, - "Engine": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The Elasticache engine. For Redis only.

" - } - }, "AtRestEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled after the replication\n group is created. \n To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to \n true when you create the replication group.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

" } }, - "AuthTokenEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A flag that enables using an AuthToken (password)\n when issuing Redis commands.

\n

Default: false\n

" - } - }, - "Status": { + "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The status of the Global Datastore

" - } - }, - "GlobalNodeGroups": { - "target": "com.amazonaws.elasticache#GlobalNodeGroupList", - "traits": { - "smithy.api#documentation": "

Indicates the slot configuration and global identifier for each slice group.

" + "smithy.api#documentation": "

The name of the Global Datastore

" } }, "EngineVersion": { @@ -4522,6 +5079,18 @@ "traits": { "smithy.api#documentation": "

The cache node type of the Global Datastore

" } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.\n \n You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

" + } + }, + "AuthTokenEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag that enables using an AuthToken (password)\n when issuing Redis commands.

\n

Default: false\n

" + } } }, "traits": { @@ -4544,16 +5113,16 @@ "com.amazonaws.elasticache#GlobalReplicationGroupInfo": { "type": "structure", "members": { - "GlobalReplicationGroupMemberRole": { + "GlobalReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The role of the replication group in a Global Datastore. Can be primary or secondary.

" + "smithy.api#documentation": "

The name of the Global Datastore

" } }, - "GlobalReplicationGroupId": { + "GlobalReplicationGroupMemberRole": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

" + "smithy.api#documentation": "

The role of the replication group in a Global Datastore. Can be primary or secondary.

" } } }, @@ -4573,16 +5142,16 @@ "com.amazonaws.elasticache#GlobalReplicationGroupMember": { "type": "structure", "members": { - "Role": { + "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Indicates the role of the replication group, primary or secondary.

" + "smithy.api#documentation": "

The AWS region of the Global Datastore member.

" } }, - "ReplicationGroupRegion": { - "target": "com.amazonaws.elasticache#String", + "AutomaticFailover": { + "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { - "smithy.api#documentation": "

The AWS region of the Global Datastore member.

" + "smithy.api#documentation": "

Indicates whether automatic failover is enabled for the replication group.

" } }, "Status": { @@ -4597,10 +5166,10 @@ "smithy.api#documentation": "

The replication group id of the Global Datastore member.

" } }, - "AutomaticFailover": { - "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", + "Role": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Indicates whether automatic failover is enabled for the replication group.

" + "smithy.api#documentation": "

Indicates the role of the replication group, primary or secondary.

" } } }, @@ -4656,13 +5225,19 @@ "com.amazonaws.elasticache#IncreaseNodeGroupsInGlobalReplicationGroupMessage": { "type": "structure", "members": { - "NodeGroupCount": { - "target": "com.amazonaws.elasticache#Integer", + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The number of node groups you wish to add

", + "smithy.api#documentation": "

The name of the Global Datastore

", "smithy.api#required": {} } }, + "RegionalConfigurations": { + "target": "com.amazonaws.elasticache#RegionalConfigurationList", + "traits": { + "smithy.api#documentation": "

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

" + } + }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { @@ -4670,16 +5245,10 @@ "smithy.api#required": {} } }, - "RegionalConfigurations": { - "target": "com.amazonaws.elasticache#RegionalConfigurationList", - "traits": { - "smithy.api#documentation": "

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

" - } - }, - "GlobalReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", + "NodeGroupCount": { + "target": "com.amazonaws.elasticache#Integer", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

", + "smithy.api#documentation": "

The number of node groups you wish to add

", "smithy.api#required": {} } } @@ -4746,10 +5315,11 @@ "com.amazonaws.elasticache#IncreaseReplicaCountMessage": { "type": "structure", "members": { - "ReplicaConfiguration": { - "target": "com.amazonaws.elasticache#ReplicaConfigurationList", + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each shard\n in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members:\n NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

" + "smithy.api#documentation": "

If True, the number of replica nodes is increased immediately. \n\n ApplyImmediately=False is not currently supported.

", + "smithy.api#required": {} } }, "ReplicationGroupId": { @@ -4759,17 +5329,16 @@ "smithy.api#required": {} } }, - "NewReplicaCount": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "ReplicaConfiguration": { + "target": "com.amazonaws.elasticache#ReplicaConfigurationList", "traits": { - "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.

" + "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each shard\n in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members:\n NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

" } }, - "ApplyImmediately": { - "target": "com.amazonaws.elasticache#Boolean", + "NewReplicaCount": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

If True, the number of replica nodes is increased immediately. \n\n ApplyImmediately=False is not currently supported.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.

" } } } @@ -4953,7 +5522,7 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.elasticache#InvalidVPCNetworkStateFault": { + "com.amazonaws.elasticache#InvalidUserGroupStateFault": { "type": "structure", "members": { "message": { @@ -4961,21 +5530,47 @@ } }, "traits": { - "smithy.api#documentation": "

The VPC network is in an invalid state.

", + "smithy.api#documentation": "

The user group is not in an active state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, - "com.amazonaws.elasticache#KeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.elasticache#String" - } - }, - "com.amazonaws.elasticache#ListAllowedNodeTypeModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.elasticache#ListAllowedNodeTypeModificationsMessage" + "com.amazonaws.elasticache#InvalidUserStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The user is not in active state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#InvalidVPCNetworkStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The VPC network is in an invalid state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + } + }, + "com.amazonaws.elasticache#ListAllowedNodeTypeModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ListAllowedNodeTypeModificationsMessage" }, "output": { "target": "com.amazonaws.elasticache#AllowedNodeTypeModificationsMessage" @@ -5001,16 +5596,16 @@ "com.amazonaws.elasticache#ListAllowedNodeTypeModificationsMessage": { "type": "structure", "members": { - "ReplicationGroupId": { + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the replication group want to scale up to a larger node type.\n ElastiCache uses the replication group id to identify the current node type being used by\n this replication group, and from that to create a list of node types you can scale up to.

\n\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

\n " + "smithy.api#documentation": "

The name of the cluster you want to scale up to a larger node instanced type. \n ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

\n \n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

\n " } }, - "CacheClusterId": { + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cluster you want to scale up to a larger node instanced type. \n ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

\n \n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

\n " + "smithy.api#documentation": "

The name of the replication group want to scale up to a larger node type.\n ElastiCache uses the replication group id to identify the current node type being used by\n this replication group, and from that to create a list of node types you can scale up to.

\n\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

\n " } } }, @@ -5106,40 +5701,16 @@ "com.amazonaws.elasticache#ModifyCacheClusterMessage": { "type": "structure", "members": { - "EngineVersion": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The upgraded version of the cache engine to be run on the cache nodes.

\n \n

\n Important: You can upgrade to a newer engine version \n (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster and create it anew with the earlier engine version.

" - } - }, - "CacheSecurityGroupNames": { - "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of cache security group names to authorize on this cluster. \n This change is asynchronously applied as soon as possible.

\n

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.elasticache#Boolean", - "traits": { - "smithy.api#documentation": "

If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cluster.

\n

If false, changes to the cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.

\n \n

If you perform a ModifyCacheCluster before a pending modification is applied, \n the pending modification is replaced by the newer modification.

\n \n

Valid values: true | false\n

\n

Default: false\n

" - } - }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "

This parameter is currently disabled.

" } }, - "CacheParameterGroupName": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this request.

" - } - }, - "PreferredMaintenanceWindow": { + "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" + "smithy.api#documentation": "

The upgraded version of the cache engine to be run on the cache nodes.

\n \n

\n Important: You can upgrade to a newer engine version \n (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster and create it anew with the earlier engine version.

" } }, "NewAvailabilityZones": { @@ -5148,34 +5719,34 @@ "smithy.api#documentation": "

The list of Availability Zones where the new Memcached cache nodes are created.

\n

This parameter is only valid when NumCacheNodes in the request is greater \n than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). \n The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

\n

This option is only supported on Memcached clusters.

\n

Scenarios:

\n \n\n

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, \n add 0 nodes by setting NumCacheNodes to the number of current nodes.

\n

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. \n Only newly created nodes can be located in different Availability Zones. \n For guidance on how to move existing Memcached nodes to different Availability Zones, see the\n Availability Zone Considerations section of Cache Node Considerations for Memcached.

\n \n

\n Impact of new add/remove requests upon pending requests\n

\n " } }, - "NotificationTopicArn": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be same as the cluster owner.

\n " - } - }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { "smithy.api#documentation": "

Specifies the VPC Security Groups associated with the cluster.

\n

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

" } }, + "NotificationTopicArn": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be same as the cluster owner.

\n " + } + }, "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { "smithy.api#documentation": "

The number of cache nodes that the cluster should have. \n If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and \n the number of cache nodes pending creation (which may be zero), more nodes are added. \n If the value is less than the number of existing cache nodes, nodes are removed. \n If the value is equal to the number of current cache nodes, \n any pending add or remove requests are canceled.

\n

If you are removing cache nodes, you must\n use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 20.

\n \n \n

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

\n

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, \n whether by adding or removing nodes in accordance with the scale out architecture, is not queued. \n The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the \n number of cache nodes in the cluster. \n For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. \n Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. \n As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, \n a request to add nodes does not automatically override a previous pending operation to add nodes. \n The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and \n retry the new request. \n To cancel pending operations to modify the number of cache nodes in a cluster, \n use the ModifyCacheCluster request and \n set NumCacheNodes equal to the number of cache nodes currently in the cluster.

\n " } }, - "CacheNodeIdsToRemove": { - "target": "com.amazonaws.elasticache#CacheNodeIdsList", + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the existing number\n of cache nodes. The number of cache node IDs supplied in this parameter must match the\n difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is\n greater, and the value of NumCacheNodes in the request.

\n

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this \n ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

" + "smithy.api#documentation": "

If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cluster.

\n

If false, changes to the cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.

\n \n

If you perform a ModifyCacheCluster before a pending modification is applied, \n the pending modification is replaced by the newer modification.

\n \n

Valid values: true | false\n

\n

Default: false\n

" } }, - "CacheNodeType": { + "NotificationTopicStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A valid cache node type that you want to scale this cluster up to.

" + "smithy.api#documentation": "

The status of the Amazon SNS notification topic. Notifications are sent only if the\n status is active.

\n

Valid values: active | inactive\n

" } }, "CacheClusterId": { @@ -5185,28 +5756,40 @@ "smithy.api#required": {} } }, - "SnapshotWindow": { + "CacheNodeIdsToRemove": { + "target": "com.amazonaws.elasticache#CacheNodeIdsList", + "traits": { + "smithy.api#documentation": "

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the existing number\n of cache nodes. The number of cache node IDs supplied in this parameter must match the\n difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is\n greater, and the value of NumCacheNodes in the request.

\n

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this \n ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

" + } + }, + "AuthTokenUpdateStrategy": { + "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", + "traits": { + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter.\n Possible values:

\n \n

\n For more information, see Authenticating Users with Redis AUTH\n

" + } + }, + "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n your cluster.

" + "smithy.api#documentation": "

A valid cache node type that you want to scale this cluster up to.

" } }, - "SnapshotRetentionLimit": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "AZMode": { + "target": "com.amazonaws.elasticache#AZMode", "traits": { - "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " + "smithy.api#documentation": "

Specifies whether the new nodes in this Memcached cluster are all created in a \n single Availability Zone or created across multiple Availability Zones.

\n

Valid values: single-az | cross-az.

\n

This option is only supported for Memcached clusters.

\n \n

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. \n If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

\n

Only newly created nodes are located in different Availability Zones. \n

\n " } }, - "NotificationTopicStatus": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The status of the Amazon SNS notification topic. Notifications are sent only if the\n status is active.

\n

Valid values: active | inactive\n

" + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" } }, - "AuthTokenUpdateStrategy": { - "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", + "CacheParameterGroupName": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter.\n Possible values:

\n \n

\n For more information, see Authenticating Users with Redis AUTH\n

" + "smithy.api#documentation": "

The name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this request.

" } }, "AuthToken": { @@ -5215,10 +5798,22 @@ "smithy.api#documentation": "

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter.\n Password constraints:

\n \n

\n \n For more information, see AUTH password at AUTH.

" } }, - "AZMode": { - "target": "com.amazonaws.elasticache#AZMode", + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Specifies whether the new nodes in this Memcached cluster are all created in a \n single Availability Zone or created across multiple Availability Zones.

\n

Valid values: single-az | cross-az.

\n

This option is only supported for Memcached clusters.

\n \n

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. \n If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

\n

Only newly created nodes are located in different Availability Zones. \n

\n " + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n your cluster.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " + } + }, + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of cache security group names to authorize on this cluster. \n This change is asynchronously applied as soon as possible.

\n

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" } } }, @@ -5305,6 +5900,9 @@ }, { "target": "com.amazonaws.elasticache#SubnetInUse" + }, + { + "target": "com.amazonaws.elasticache#SubnetNotAllowedFault" } ], "traits": { @@ -5372,10 +5970,11 @@ "com.amazonaws.elasticache#ModifyGlobalReplicationGroupMessage": { "type": "structure", "members": { - "CacheNodeType": { - "target": "com.amazonaws.elasticache#String", + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

A valid cache node type that you want to scale this Global Datastore to.

" + "smithy.api#documentation": "

This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global \n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n

", + "smithy.api#required": {} } }, "EngineVersion": { @@ -5384,11 +5983,10 @@ "smithy.api#documentation": "

The upgraded version of the cache engine to be run on the clusters in the Global Datastore.

" } }, - "GlobalReplicationGroupId": { + "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore

", - "smithy.api#required": {} + "smithy.api#documentation": "

A valid cache node type that you want to scale this Global Datastore to.

" } }, "GlobalReplicationGroupDescription": { @@ -5397,18 +5995,18 @@ "smithy.api#documentation": "

A description of the Global Datastore

" } }, - "ApplyImmediately": { - "target": "com.amazonaws.elasticache#Boolean", - "traits": { - "smithy.api#documentation": "

This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global \n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n

", - "smithy.api#required": {} - } - }, "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { "smithy.api#documentation": "

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

" } + }, + "GlobalReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The name of the Global Datastore

", + "smithy.api#required": {} + } } } }, @@ -5459,6 +6057,9 @@ { "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, { "target": "com.amazonaws.elasticache#InvalidVPCNetworkStateFault" }, @@ -5470,6 +6071,9 @@ }, { "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" } ], "traits": { @@ -5479,18 +6083,6 @@ "com.amazonaws.elasticache#ModifyReplicationGroupMessage": { "type": "structure", "members": { - "SnapshotWindow": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n the node group (shard) specified by SnapshottingClusterId.

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

" - } - }, - "SnapshotRetentionLimit": { - "target": "com.amazonaws.elasticache#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic node group (shard) snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n

\n Important If the value of SnapshotRetentionLimit is set to zero (0), \n backups are turned off.

" - } - }, "MultiAZEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { @@ -5503,22 +6095,54 @@ "smithy.api#documentation": "

A valid cache node type that you want to scale this replication group to.

" } }, + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n the node group (shard) specified by SnapshottingClusterId.

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

" + } + }, "SnapshottingClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The cluster ID that is used as the daily snapshot source for the replication group.\n This parameter cannot be set for Redis (cluster mode enabled) replication groups.

" } }, - "AuthToken": { + "AuthTokenUpdateStrategy": { + "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", + "traits": { + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter.\n Possible values:

\n \n

\n For more information, see Authenticating Users with Redis AUTH\n

" + } + }, + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy \n parameter.\n Password constraints:

\n \n

\n \n For more information, see AUTH password at AUTH.

" + "smithy.api#documentation": "

The identifier of the replication group to modify.

", + "smithy.api#required": {} } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "UserGroupIdsToAdd": { + "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { - "smithy.api#documentation": "

This parameter is currently disabled.

" + "smithy.api#documentation": "

A list of user group IDs.

" + } + }, + "UserGroupIdsToRemove": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of users groups to remove, meaning the users in the group no longer can access thereplication group.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic node group (shard) snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n

\n Important If the value of SnapshotRetentionLimit is set to zero (0), \n backups are turned off.

" + } + }, + "NodeGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

Deprecated. This parameter is not used.

" } }, "AutomaticFailoverEnabled": { @@ -5527,28 +6151,28 @@ "smithy.api#documentation": "

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

\n

Valid values: true | false\n

" } }, - "NotificationTopicArn": { - "target": "com.amazonaws.elasticache#String", + "RemoveUserGroups": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be same as the replication group owner.

\n " + "smithy.api#documentation": "

Removes the user groups that can access this replication group.

" } }, - "CacheParameterGroupName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache parameter group to apply to all of the clusters in this replication group. \n This change is asynchronously applied as soon as possible for parameters when the \n ApplyImmediately parameter is specified as true for this request.

" + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" } }, - "PreferredMaintenanceWindow": { + "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be same as the replication group owner.

\n " } }, - "SecurityGroupIds": { - "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies the VPC Security Groups associated with the clusters in the replication group.

\n

This parameter can be used only with replication group containing clusters running in \n an Amazon Virtual Private Cloud (Amazon VPC).

" + "smithy.api#documentation": "

This parameter is currently disabled.

" } }, "PrimaryClusterId": { @@ -5557,10 +6181,16 @@ "smithy.api#documentation": "

For replication groups with a single primary, \n if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. \n The nodes of all other clusters in the replication group are read replicas.

" } }, - "ReplicationGroupDescription": { + "SecurityGroupIds": { + "target": "com.amazonaws.elasticache#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

Specifies the VPC Security Groups associated with the clusters in the replication group.

\n

This parameter can be used only with replication group containing clusters running in \n an Amazon Virtual Private Cloud (Amazon VPC).

" + } + }, + "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A description for the replication group. Maximum length is 255 characters.

" + "smithy.api#documentation": "

The name of the cache parameter group to apply to all of the clusters in this replication group. \n This change is asynchronously applied as soon as possible for parameters when the \n ApplyImmediately parameter is specified as true for this request.

" } }, "EngineVersion": { @@ -5569,10 +6199,10 @@ "smithy.api#documentation": "

The upgraded version of the cache engine to be run on the clusters in the replication group.

\n \n

\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing replication group and create it anew with the earlier engine version.

" } }, - "CacheSecurityGroupNames": { - "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", + "ReplicationGroupDescription": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

\n

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

" + "smithy.api#documentation": "

A description for the replication group. Maximum length is 255 characters.

" } }, "ApplyImmediately": { @@ -5581,24 +6211,16 @@ "smithy.api#documentation": "

If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the replication group.

\n

If false, changes to the nodes in the replication group are applied on\n the next maintenance reboot, or the next failure reboot, whichever occurs first.

\n

Valid values: true | false\n

\n

Default: false\n

" } }, - "AuthTokenUpdateStrategy": { - "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", - "traits": { - "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter.\n Possible values:

\n \n

\n For more information, see Authenticating Users with Redis AUTH\n

" - } - }, - "NodeGroupId": { - "target": "com.amazonaws.elasticache#String", + "CacheSecurityGroupNames": { + "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Deprecated. This parameter is not used.

" + "smithy.api#documentation": "

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

\n

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

" } }, - "ReplicationGroupId": { + "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the replication group to modify.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy \n parameter.\n Password constraints:

\n \n

\n \n For more information, see AUTH password at AUTH.

" } }, "NotificationTopicStatus": { @@ -5667,25 +6289,19 @@ "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationMessage": { "type": "structure", "members": { - "NodeGroupsToRetain": { - "target": "com.amazonaws.elasticache#NodeGroupsToRetainList", + "NodeGroupsToRemove": { + "target": "com.amazonaws.elasticache#NodeGroupsToRemoveList", "traits": { - "smithy.api#documentation": "

If the value of NodeGroupCount is less than the \n current number of node groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required.\n NodeGroupsToRetain is a list of NodeGroupIds to retain \n in the cluster.

\n

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain\n from the cluster.

" + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the \n current number of node groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required.\n NodeGroupsToRemove is a list of NodeGroupIds to remove \n from the cluster.

\n

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove\n from the cluster.

" } }, - "ApplyImmediately": { - "target": "com.amazonaws.elasticache#Boolean", + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Indicates that the shard reconfiguration process begins immediately. \n At present, the only permitted value for this parameter is true.

\n

Value: true

", + "smithy.api#documentation": "

The name of the Redis (cluster mode enabled) cluster (replication group)\n on which the shards are to be configured.

", "smithy.api#required": {} } }, - "NodeGroupsToRemove": { - "target": "com.amazonaws.elasticache#NodeGroupsToRemoveList", - "traits": { - "smithy.api#documentation": "

If the value of NodeGroupCount is less than the \n current number of node groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required.\n NodeGroupsToRemove is a list of NodeGroupIds to remove \n from the cluster.

\n

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove\n from the cluster.

" - } - }, "NodeGroupCount": { "target": "com.amazonaws.elasticache#Integer", "traits": { @@ -5693,17 +6309,23 @@ "smithy.api#required": {} } }, - "ReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", + "ReshardingConfiguration": { + "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { - "smithy.api#documentation": "

The name of the Redis (cluster mode enabled) cluster (replication group)\n on which the shards are to be configured.

", + "smithy.api#documentation": "

Specifies the preferred availability zones for each node group in the cluster.\n If the value of NodeGroupCount is greater than the current number\n of node groups (shards), you can use this parameter to specify the preferred \n availability zones of the cluster's shards. \n If you omit this parameter ElastiCache selects availability zones for you.

\n

You can specify this parameter only if the value of NodeGroupCount\n is greater than the current number of node groups (shards).

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates that the shard reconfiguration process begins immediately. \n At present, the only permitted value for this parameter is true.

\n

Value: true

", "smithy.api#required": {} } }, - "ReshardingConfiguration": { - "target": "com.amazonaws.elasticache#ReshardingConfigurationList", + "NodeGroupsToRetain": { + "target": "com.amazonaws.elasticache#NodeGroupsToRetainList", "traits": { - "smithy.api#documentation": "

Specifies the preferred availability zones for each node group in the cluster.\n If the value of NodeGroupCount is greater than the current number\n of node groups (shards), you can use this parameter to specify the preferred \n availability zones of the cluster's shards. \n If you omit this parameter ElastiCache selects availability zones for you.

\n

You can specify this parameter only if the value of NodeGroupCount\n is greater than the current number of node groups (shards).

" + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the \n current number of node groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required.\n NodeGroupsToRetain is a list of NodeGroupIds to retain \n in the cluster.

\n

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain\n from the cluster.

" } } }, @@ -5719,6 +6341,127 @@ } } }, + "com.amazonaws.elasticache#ModifyUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyUserMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#User" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes user password(s) and/or access string.

" + } + }, + "com.amazonaws.elasticache#ModifyUserGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#ModifyUserGroupMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#UserGroup" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#DefaultUserRequired" + }, + { + "target": "com.amazonaws.elasticache#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidUserGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#UserGroupNotFoundFault" + }, + { + "target": "com.amazonaws.elasticache#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the list of users that belong to the user group.

" + } + }, + "com.amazonaws.elasticache#ModifyUserGroupMessage": { + "type": "structure", + "members": { + "UserIdsToRemove": { + "target": "com.amazonaws.elasticache#UserIdListInput", + "traits": { + "smithy.api#documentation": "

The list of user IDs to remove from the user group.

" + } + }, + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the user group.

", + "smithy.api#required": {} + } + }, + "UserIdsToAdd": { + "target": "com.amazonaws.elasticache#UserIdListInput", + "traits": { + "smithy.api#documentation": "

The list of user IDs to add to the user group.

" + } + } + } + }, + "com.amazonaws.elasticache#ModifyUserMessage": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.elasticache#UserId", + "traits": { + "smithy.api#documentation": "

The ID of the user.

", + "smithy.api#required": {} + } + }, + "NoPasswordRequired": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates no password is required for the user account.

" + } + }, + "AccessString": { + "target": "com.amazonaws.elasticache#AccessString", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user account.

" + } + }, + "AppendAccessString": { + "target": "com.amazonaws.elasticache#AccessString", + "traits": { + "smithy.api#documentation": "

Adds additional user permissions to the access string.

" + } + }, + "Passwords": { + "target": "com.amazonaws.elasticache#PasswordListInput", + "traits": { + "smithy.api#documentation": "

The passwords belonging to the user account. You are allowed up to two.

" + } + } + } + }, "com.amazonaws.elasticache#MultiAZStatus": { "type": "string", "traits": { @@ -5750,40 +6493,40 @@ "com.amazonaws.elasticache#NodeGroup": { "type": "structure", "members": { - "NodeGroupMembers": { - "target": "com.amazonaws.elasticache#NodeGroupMemberList", + "Status": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list containing information about individual nodes within the node group (shard).

" + "smithy.api#documentation": "

The current state of this replication group - creating, \n available, modifying, deleting.

" } }, - "PrimaryEndpoint": { + "ReaderEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "

The endpoint of the primary node in this node group (shard).

" + "smithy.api#documentation": "

The endpoint of the replica nodes in this node group (shard).

" } }, - "Slots": { - "target": "com.amazonaws.elasticache#String", + "PrimaryEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "

The keyspace for this node group (shard).

" + "smithy.api#documentation": "

The endpoint of the primary node in this node group (shard).

" } }, - "Status": { + "NodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The current state of this replication group - creating, \n available, modifying, deleting.

" + "smithy.api#documentation": "

The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001.\n A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for\n a node group.

" } }, - "NodeGroupId": { - "target": "com.amazonaws.elasticache#String", + "NodeGroupMembers": { + "target": "com.amazonaws.elasticache#NodeGroupMemberList", "traits": { - "smithy.api#documentation": "

The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001.\n A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for\n a node group.

" + "smithy.api#documentation": "

A list containing information about individual nodes within the node group (shard).

" } }, - "ReaderEndpoint": { - "target": "com.amazonaws.elasticache#Endpoint", + "Slots": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The endpoint of the replica nodes in this node group (shard).

" + "smithy.api#documentation": "

The keyspace for this node group (shard).

" } } }, @@ -5794,16 +6537,28 @@ "com.amazonaws.elasticache#NodeGroupConfiguration": { "type": "structure", "members": { - "NodeGroupId": { - "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "PrimaryOutpostArn": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.

" + "smithy.api#documentation": "

The output ARN of the primary node.

" } }, - "ReplicaAvailabilityZones": { - "target": "com.amazonaws.elasticache#AvailabilityZonesList", + "Slots": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of Availability Zones to be used for the read replicas.\n The number of Availability Zones in this list must match the value of ReplicaCount\n or ReplicasPerNodeGroup if not specified.

" + "smithy.api#documentation": "

A string that specifies the keyspace for a particular node group.\n Keyspaces range from 0 to 16,383.\n The string is in the format startkey-endkey.

\n

Example: \"0-3999\"\n

" + } + }, + "PrimaryAvailabilityZone": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the primary node of this node group (shard) is launched.

" + } + }, + "ReplicaOutpostArns": { + "target": "com.amazonaws.elasticache#OutpostArnsList", + "traits": { + "smithy.api#documentation": "

The outpost ARN of the node replicas.

" } }, "ReplicaCount": { @@ -5812,16 +6567,16 @@ "smithy.api#documentation": "

The number of read replica nodes in this node group (shard).

" } }, - "PrimaryAvailabilityZone": { - "target": "com.amazonaws.elasticache#String", + "NodeGroupId": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "

The Availability Zone where the primary node of this node group (shard) is launched.

" + "smithy.api#documentation": "

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.

" } }, - "Slots": { - "target": "com.amazonaws.elasticache#String", + "ReplicaAvailabilityZones": { + "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { - "smithy.api#documentation": "

A string that specifies the keyspace for a particular node group.\n Keyspaces range from 0 to 16,383.\n The string is in the format startkey-endkey.

\n

Example: \"0-3999\"\n

" + "smithy.api#documentation": "

A list of Availability Zones to be used for the read replicas.\n The number of Availability Zones in this list must match the value of ReplicaCount\n or ReplicasPerNodeGroup if not specified.

" } } }, @@ -5856,10 +6611,10 @@ "smithy.api#documentation": "

The role that is currently assigned to the node - primary or \n replica. This member is only applicable for Redis (cluster mode disabled) \n replication groups.

" } }, - "CacheNodeId": { + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" + "smithy.api#documentation": "

The ID of the cluster to which the node belongs.

" } }, "PreferredAvailabilityZone": { @@ -5874,10 +6629,16 @@ "smithy.api#documentation": "

The information required for client programs to connect to a node for read operations.\n The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

" } }, - "CacheClusterId": { + "PreferredOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the cluster to which the node belongs.

" + "smithy.api#documentation": "

The outpost ARN of the node group member.

" + } + }, + "CacheNodeId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" } } }, @@ -5897,34 +6658,22 @@ "com.amazonaws.elasticache#NodeGroupMemberUpdateStatus": { "type": "structure", "members": { - "NodeUpdateStatus": { - "target": "com.amazonaws.elasticache#NodeUpdateStatus", - "traits": { - "smithy.api#documentation": "

The update status of the node

" - } - }, - "NodeUpdateStartDate": { + "NodeDeletionDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The start date of the update for a node

" - } - }, - "CacheClusterId": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The cache cluster ID

" + "smithy.api#documentation": "

The deletion date of the node

" } }, - "NodeDeletionDate": { - "target": "com.amazonaws.elasticache#TStamp", + "NodeUpdateStatus": { + "target": "com.amazonaws.elasticache#NodeUpdateStatus", "traits": { - "smithy.api#documentation": "

The deletion date of the node

" + "smithy.api#documentation": "

The update status of the node

" } }, - "NodeUpdateStatusModifiedDate": { + "NodeUpdateInitiatedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The date when the NodeUpdateStatus was last modified

" + "smithy.api#documentation": "

The date when the update is triggered

" } }, "NodeUpdateInitiatedBy": { @@ -5933,28 +6682,40 @@ "smithy.api#documentation": "

Reflects whether the update was initiated by the customer or automatically applied

" } }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The cache cluster ID

" + } + }, "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The node ID of the cache cluster

" } }, - "NodeUpdateInitiatedDate": { + "NodeUpdateEndDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The date when the update is triggered

" + "smithy.api#documentation": "

The end date of the update for a node

" } }, - "NodeUpdateEndDate": { + "NodeUpdateStatusModifiedDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The end date of the update for a node

" + "smithy.api#documentation": "

The date when the NodeUpdateStatus was last modified

" } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the service update on the node group member

" - } + }, + "NodeUpdateStartDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The start date of the update for a node

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the service update on the node group member

" + } }, "com.amazonaws.elasticache#NodeGroupMemberUpdateStatusList": { "type": "list", @@ -6067,16 +6828,10 @@ "com.amazonaws.elasticache#NodeSnapshot": { "type": "structure", "members": { - "CacheNodeId": { + "NodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node identifier for the node in the source cluster.

" - } - }, - "SnapshotCreateTime": { - "target": "com.amazonaws.elasticache#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

" + "smithy.api#documentation": "

A unique identifier for the source node group (shard).

" } }, "NodeGroupConfiguration": { @@ -6085,22 +6840,22 @@ "smithy.api#documentation": "

The configuration for the source node group (shard).

" } }, - "CacheNodeCreateTime": { - "target": "com.amazonaws.elasticache#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the cache node was created in the source cluster.

" - } - }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

A unique identifier for the source cluster.

" } }, - "NodeGroupId": { + "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the source node group (shard).

" + "smithy.api#documentation": "

The cache node identifier for the node in the source cluster.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

" } }, "CacheSize": { @@ -6108,6 +6863,12 @@ "traits": { "smithy.api#documentation": "

The size of the cache on the source cache node.

" } + }, + "CacheNodeCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cache node was created in the source cluster.

" + } } }, "traits": { @@ -6178,16 +6939,16 @@ "com.amazonaws.elasticache#NotificationConfiguration": { "type": "structure", "members": { - "TopicStatus": { + "TopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The current state of the topic.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the topic.

" } }, - "TopicArn": { + "TopicStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the topic.

" + "smithy.api#documentation": "

The current state of the topic.

" } } }, @@ -6195,19 +6956,37 @@ "smithy.api#documentation": "

Describes a notification topic and its status. \n Notification topics are used for publishing ElastiCache events to subscribers \n using Amazon Simple Notification Service (SNS).

" } }, + "com.amazonaws.elasticache#OutpostArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "OutpostArn" + } + } + }, + "com.amazonaws.elasticache#OutpostMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "single-outpost", + "name": "SINGLE_OUTPOST" + }, + { + "value": "cross-outpost", + "name": "CROSS_OUTPOST" + } + ] + } + }, "com.amazonaws.elasticache#Parameter": { "type": "structure", "members": { - "Description": { + "AllowedValues": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A description of the parameter.

" - } - }, - "ChangeType": { - "target": "com.amazonaws.elasticache#ChangeType", - "traits": { - "smithy.api#documentation": "

Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.

" + "smithy.api#documentation": "

The valid range of values for the parameter.

" } }, "IsModifiable": { @@ -6216,40 +6995,46 @@ "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be modified. \n Some parameters have security or operational implications that prevent them from being changed.

" } }, - "ParameterName": { + "Description": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the parameter.

" + "smithy.api#documentation": "

A description of the parameter.

" } }, - "Source": { + "ChangeType": { + "target": "com.amazonaws.elasticache#ChangeType", + "traits": { + "smithy.api#documentation": "

Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.

" + } + }, + "MinimumEngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The source of the parameter.

" + "smithy.api#documentation": "

The earliest cache engine version to which the parameter can apply.

" } }, - "DataType": { + "ParameterValue": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The valid data type for the parameter.

" + "smithy.api#documentation": "

The value of the parameter.

" } }, - "MinimumEngineVersion": { + "ParameterName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The earliest cache engine version to which the parameter can apply.

" + "smithy.api#documentation": "

The name of the parameter.

" } }, - "AllowedValues": { + "DataType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The valid range of values for the parameter.

" + "smithy.api#documentation": "

The valid data type for the parameter.

" } }, - "ParameterValue": { + "Source": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The value of the parameter.

" + "smithy.api#documentation": "

The source of the parameter.

" } } }, @@ -6260,16 +7045,16 @@ "com.amazonaws.elasticache#ParameterNameValue": { "type": "structure", "members": { - "ParameterValue": { + "ParameterName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The value of the parameter.

" + "smithy.api#documentation": "

The name of the parameter.

" } }, - "ParameterName": { + "ParameterValue": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the parameter.

" + "smithy.api#documentation": "

The value of the parameter.

" } } }, @@ -6295,6 +7080,17 @@ } } }, + "com.amazonaws.elasticache#PasswordListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.elasticache#PendingAutomaticFailoverStatus": { "type": "string", "traits": { @@ -6313,16 +7109,16 @@ "com.amazonaws.elasticache#PendingModifiedValues": { "type": "structure", "members": { - "NumCacheNodes": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "CacheNodeType": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The new number of cache nodes for the cluster.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 20.

" + "smithy.api#documentation": "

The cache node type that this cluster or replication group is scaled to.

" } }, - "CacheNodeIdsToRemove": { - "target": "com.amazonaws.elasticache#CacheNodeIdsList", + "AuthTokenStatus": { + "target": "com.amazonaws.elasticache#AuthTokenUpdateStatus", "traits": { - "smithy.api#documentation": "

A list of cache node IDs that are being removed (or will be removed) from the cluster. \n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

" + "smithy.api#documentation": "

The auth token status

" } }, "EngineVersion": { @@ -6331,16 +7127,16 @@ "smithy.api#documentation": "

The new cache engine version that the cluster runs.

" } }, - "CacheNodeType": { - "target": "com.amazonaws.elasticache#String", + "CacheNodeIdsToRemove": { + "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "

The cache node type that this cluster or replication group is scaled to.

" + "smithy.api#documentation": "

A list of cache node IDs that are being removed (or will be removed) from the cluster. \n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

" } }, - "AuthTokenStatus": { - "target": "com.amazonaws.elasticache#AuthTokenUpdateStatus", + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The auth token status

" + "smithy.api#documentation": "

The new number of cache nodes for the cluster.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 20.

" } } }, @@ -6357,25 +7153,28 @@ } } }, + "com.amazonaws.elasticache#PreferredOutpostArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "PreferredOutpostArn" + } + } + }, "com.amazonaws.elasticache#ProcessedUpdateAction": { "type": "structure", "members": { - "ServiceUpdateName": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The unique ID of the service update

" - } - }, - "CacheClusterId": { + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the cache cluster

" + "smithy.api#documentation": "

The ID of the replication group

" } }, - "ReplicationGroupId": { + "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the replication group

" + "smithy.api#documentation": "

The unique ID of the service update

" } }, "UpdateActionStatus": { @@ -6383,6 +7182,12 @@ "traits": { "smithy.api#documentation": "

The status of the update action on the Redis cluster

" } + }, + "CacheClusterId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the cache cluster

" + } } }, "traits": { @@ -6430,11 +7235,10 @@ "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingMessage": { "type": "structure", "members": { - "ReservedCacheNodesOfferingId": { + "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the reserved cache node offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

\n \n

The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. \n If this parameter is not specified, \n ElastiCache automatically generates an identifier for the reservation.

\n \n

Example: myreservationID

" } }, "CacheNodeCount": { @@ -6443,10 +7247,11 @@ "smithy.api#documentation": "

The number of cache node instances to reserve.

\n

Default: 1\n

" } }, - "ReservedCacheNodeId": { + "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

\n \n

The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. \n If this parameter is not specified, \n ElastiCache automatically generates an identifier for the reservation.

\n \n

Example: myreservationID

" + "smithy.api#documentation": "

The ID of the reserved cache node offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

", + "smithy.api#required": {} } } }, @@ -6565,17 +7370,17 @@ "com.amazonaws.elasticache#RecurringCharge": { "type": "structure", "members": { - "RecurringChargeAmount": { - "target": "com.amazonaws.elasticache#Double", - "traits": { - "smithy.api#documentation": "

The monetary amount of the recurring charge.

" - } - }, "RecurringChargeFrequency": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The frequency of the recurring charge.

" } + }, + "RecurringChargeAmount": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The monetary amount of the recurring charge.

" + } } }, "traits": { @@ -6594,17 +7399,17 @@ "com.amazonaws.elasticache#RegionalConfiguration": { "type": "structure", "members": { - "ReplicationGroupRegion": { - "target": "com.amazonaws.elasticache#String", + "ReshardingConfiguration": { + "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { - "smithy.api#documentation": "

The AWS region where the cluster is stored

", + "smithy.api#documentation": "

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

", "smithy.api#required": {} } }, - "ReshardingConfiguration": { - "target": "com.amazonaws.elasticache#ReshardingConfigurationList", + "ReplicationGroupRegion": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

", + "smithy.api#documentation": "

The AWS region where the cluster is stored

", "smithy.api#required": {} } }, @@ -6664,17 +7469,17 @@ "com.amazonaws.elasticache#RemoveTagsFromResourceMessage": { "type": "structure", "members": { - "ResourceName": { - "target": "com.amazonaws.elasticache#String", + "TagKeys": { + "target": "com.amazonaws.elasticache#KeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#documentation": "

A list of TagKeys identifying the tags you want removed from the named resource.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.elasticache#KeyList", + "ResourceName": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of TagKeys identifying the tags you want removed from the named resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } } @@ -6695,10 +7500,10 @@ "com.amazonaws.elasticache#ReplicationGroup": { "type": "structure", "members": { - "AutomaticFailover": { - "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", + "PendingModifiedValues": { + "target": "com.amazonaws.elasticache#ReplicationGroupPendingModifiedValues", "traits": { - "smithy.api#documentation": "

Indicates the status of automatic failover for this Redis replication group.

" + "smithy.api#documentation": "

A group of settings to be applied to the replication group, \n either immediately or during the next maintenance window.

" } }, "AuthTokenLastModifiedDate": { @@ -6707,34 +7512,28 @@ "smithy.api#documentation": "

The date the auth token was last modified

" } }, - "ConfigurationEndpoint": { - "target": "com.amazonaws.elasticache#Endpoint", + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The configuration endpoint for this replication group. \n Use the configuration endpoint to connect to this replication group.

" + "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " } }, - "MemberClusters": { - "target": "com.amazonaws.elasticache#ClusterIdList", + "SnapshotWindow": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The names of all the cache clusters that are part of this replication group.

" + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n " } }, - "GlobalReplicationGroupInfo": { - "target": "com.amazonaws.elasticache#GlobalReplicationGroupInfo", + "UserGroupIds": { + "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { - "smithy.api#documentation": "

The name of the Global Datastore and role of this replication group in the Global Datastore.

" + "smithy.api#documentation": "

The list of user group IDs that have access to the replication group.

" } }, - "Status": { + "SnapshottingClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The current state of this replication group - \n creating, \n available, \n modifying, \n deleting, \n create-failed,\n snapshotting.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.elasticache#MultiAZStatus", - "traits": { - "smithy.api#documentation": "

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ\n

" + "smithy.api#documentation": "

The cluster ID that is used as the daily snapshot source for the replication group.

" } }, "CacheNodeType": { @@ -6749,34 +7548,40 @@ "smithy.api#documentation": "

A flag that enables in-transit encryption when set to true.

\n

You cannot modify the value of TransitEncryptionEnabled\n after the cluster is created. To enable in-transit encryption on a cluster\n you must set TransitEncryptionEnabled to true\n when you create a cluster.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" } }, - "ReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The identifier for the replication group.

" + "ClusterEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A flag indicating whether or not this replication group is cluster enabled; \n i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

\n

Valid values: true | false\n

" } }, - "AtRestEncryptionEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled\n after the cluster is created. To enable encryption at-rest on a cluster\n you must set AtRestEncryptionEnabled to true\n when you create a cluster.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" + "smithy.api#documentation": "

The identifier for the replication group.

" } }, - "AuthTokenEnabled": { - "target": "com.amazonaws.elasticache#BooleanOptional", + "MemberClusters": { + "target": "com.amazonaws.elasticache#ClusterIdList", "traits": { - "smithy.api#documentation": "

A flag that enables using an AuthToken (password)\n when issuing Redis commands.

\n

Default: false\n

" + "smithy.api#documentation": "

The names of all the cache clusters that are part of this replication group.

" } }, - "Description": { + "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The user supplied description of the replication group.

" + "smithy.api#documentation": "

The current state of this replication group - \n creating, \n available, \n modifying, \n deleting, \n create-failed,\n snapshotting.

" } }, - "NodeGroups": { - "target": "com.amazonaws.elasticache#NodeGroupList", + "MultiAZ": { + "target": "com.amazonaws.elasticache#MultiAZStatus", "traits": { - "smithy.api#documentation": "

A list of node groups in this replication group.\n For Redis (cluster mode disabled) replication groups, this is a single-element list.\n For Redis (cluster mode enabled) replication groups, the list contains an entry for each\n node group (shard).

" + "smithy.api#documentation": "

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the disk in the cluster.

" } }, "ARN": { @@ -6785,40 +7590,52 @@ "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the replication group.

" } }, - "SnapshotWindow": { + "NodeGroups": { + "target": "com.amazonaws.elasticache#NodeGroupList", + "traits": { + "smithy.api#documentation": "

A list of node groups in this replication group.\n For Redis (cluster mode disabled) replication groups, this is a single-element list.\n For Redis (cluster mode enabled) replication groups, the list contains an entry for each\n node group (shard).

" + } + }, + "Description": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n " + "smithy.api#documentation": "

The user supplied description of the replication group.

" } }, - "ClusterEnabled": { + "AtRestEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag indicating whether or not this replication group is cluster enabled; \n i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

\n

Valid values: true | false\n

" + "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

You cannot modify the value of AtRestEncryptionEnabled\n after the cluster is created. To enable encryption at-rest on a cluster\n you must set AtRestEncryptionEnabled to true\n when you create a cluster.

\n

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" } }, - "PendingModifiedValues": { - "target": "com.amazonaws.elasticache#ReplicationGroupPendingModifiedValues", + "GlobalReplicationGroupInfo": { + "target": "com.amazonaws.elasticache#GlobalReplicationGroupInfo", "traits": { - "smithy.api#documentation": "

A group of settings to be applied to the replication group, \n either immediately or during the next maintenance window.

" + "smithy.api#documentation": "

The name of the Global Datastore and role of this replication group in the Global Datastore.

" } }, - "SnapshotRetentionLimit": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "MemberClustersOutpostArns": { + "target": "com.amazonaws.elasticache#ReplicationGroupOutpostArnList", "traits": { - "smithy.api#documentation": "

The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.

\n \n

\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " + "smithy.api#documentation": "

The outpost ARNs of the replication group's member clusters.

" } }, - "SnapshottingClusterId": { - "target": "com.amazonaws.elasticache#String", + "AuthTokenEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

The cluster ID that is used as the daily snapshot source for the replication group.

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password)\n when issuing Redis commands.

\n

Default: false\n

" } }, - "KmsKeyId": { - "target": "com.amazonaws.elasticache#String", + "ConfigurationEndpoint": { + "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "

The ID of the KMS key used to encrypt the disk in the cluster.

" + "smithy.api#documentation": "

The configuration endpoint for this replication group. \n Use the configuration endpoint to connect to this replication group.

" + } + }, + "AutomaticFailover": { + "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of automatic failover for this Redis replication group.

" } } }, @@ -6876,17 +7693,17 @@ "com.amazonaws.elasticache#ReplicationGroupMessage": { "type": "structure", "members": { - "ReplicationGroups": { - "target": "com.amazonaws.elasticache#ReplicationGroupList", - "traits": { - "smithy.api#documentation": "

A list of replication groups. Each item in the list contains detailed information about one replication group.

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" } + }, + "ReplicationGroups": { + "target": "com.amazonaws.elasticache#ReplicationGroupList", + "traits": { + "smithy.api#documentation": "

A list of replication groups. Each item in the list contains detailed information about one replication group.

" + } } }, "traits": { @@ -6919,25 +7736,28 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.elasticache#ReplicationGroupOutpostArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#xmlName": "ReplicationGroupOutpostArn" + } + } + }, "com.amazonaws.elasticache#ReplicationGroupPendingModifiedValues": { "type": "structure", "members": { - "Resharding": { - "target": "com.amazonaws.elasticache#ReshardingStatus", - "traits": { - "smithy.api#documentation": "

The status of an online resharding operation.

" - } - }, "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

The primary cluster ID that is applied immediately (if --apply-immediately \n was specified), or during the next maintenance window.

" } }, - "AutomaticFailoverStatus": { - "target": "com.amazonaws.elasticache#PendingAutomaticFailoverStatus", + "Resharding": { + "target": "com.amazonaws.elasticache#ReshardingStatus", "traits": { - "smithy.api#documentation": "

Indicates the status of automatic failover for this Redis replication group.

" + "smithy.api#documentation": "

The status of an online resharding operation.

" } }, "AuthTokenStatus": { @@ -6945,6 +7765,18 @@ "traits": { "smithy.api#documentation": "

The auth token status

" } + }, + "UserGroups": { + "target": "com.amazonaws.elasticache#UserGroupsUpdateStatus", + "traits": { + "smithy.api#documentation": "

The user groups being modified.

" + } + }, + "AutomaticFailoverStatus": { + "target": "com.amazonaws.elasticache#PendingAutomaticFailoverStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of automatic failover for this Redis replication group.

" + } } }, "traits": { @@ -6954,10 +7786,10 @@ "com.amazonaws.elasticache#ReservedCacheNode": { "type": "structure", "members": { - "FixedPrice": { - "target": "com.amazonaws.elasticache#Double", + "OfferingType": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The fixed price charged for this reserved cache node.

" + "smithy.api#documentation": "

The offering type of this reserved cache node.

" } }, "ReservationARN": { @@ -6966,28 +7798,28 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reserved cache node.

\n

Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582\n

" } }, - "StartTime": { - "target": "com.amazonaws.elasticache#TStamp", + "Duration": { + "target": "com.amazonaws.elasticache#Integer", "traits": { - "smithy.api#documentation": "

The time the reservation started.

" + "smithy.api#documentation": "

The duration of the reservation in seconds.

" } }, - "State": { + "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The state of the reserved cache node.

" + "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, - "CacheNodeType": { - "target": "com.amazonaws.elasticache#String", + "RecurringCharges": { + "target": "com.amazonaws.elasticache#RecurringChargeList", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

The recurring price charged to run this reserved cache node.

" } }, - "OfferingType": { - "target": "com.amazonaws.elasticache#String", + "UsagePrice": { + "target": "com.amazonaws.elasticache#Double", "traits": { - "smithy.api#documentation": "

The offering type of this reserved cache node.

" + "smithy.api#documentation": "

The hourly price charged for this reserved cache node.

" } }, "ReservedCacheNodesOfferingId": { @@ -6996,40 +7828,40 @@ "smithy.api#documentation": "

The offering identifier.

" } }, - "Duration": { - "target": "com.amazonaws.elasticache#Integer", + "ReservedCacheNodeId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The duration of the reservation in seconds.

" + "smithy.api#documentation": "

The unique identifier for the reservation.

" } }, - "UsagePrice": { - "target": "com.amazonaws.elasticache#Double", + "ProductDescription": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The hourly price charged for this reserved cache node.

" + "smithy.api#documentation": "

The description of the reserved cache node.

" } }, - "CacheNodeCount": { - "target": "com.amazonaws.elasticache#Integer", + "StartTime": { + "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The number of cache nodes that have been reserved.

" + "smithy.api#documentation": "

The time the reservation started.

" } }, - "ReservedCacheNodeId": { + "State": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The unique identifier for the reservation.

" + "smithy.api#documentation": "

The state of the reserved cache node.

" } }, - "RecurringCharges": { - "target": "com.amazonaws.elasticache#RecurringChargeList", + "FixedPrice": { + "target": "com.amazonaws.elasticache#Double", "traits": { - "smithy.api#documentation": "

The recurring price charged to run this reserved cache node.

" + "smithy.api#documentation": "

The fixed price charged for this reserved cache node.

" } }, - "ProductDescription": { - "target": "com.amazonaws.elasticache#String", + "CacheNodeCount": { + "target": "com.amazonaws.elasticache#Integer", "traits": { - "smithy.api#documentation": "

The description of the reserved cache node.

" + "smithy.api#documentation": "

The number of cache nodes that have been reserved.

" } } }, @@ -7062,17 +7894,17 @@ "com.amazonaws.elasticache#ReservedCacheNodeMessage": { "type": "structure", "members": { - "ReservedCacheNodes": { - "target": "com.amazonaws.elasticache#ReservedCacheNodeList", - "traits": { - "smithy.api#documentation": "

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

Provides an identifier to allow retrieval of paginated results.

" } + }, + "ReservedCacheNodes": { + "target": "com.amazonaws.elasticache#ReservedCacheNodeList", + "traits": { + "smithy.api#documentation": "

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

" + } } }, "traits": { @@ -7108,18 +7940,6 @@ "com.amazonaws.elasticache#ReservedCacheNodesOffering": { "type": "structure", "members": { - "CacheNodeType": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " - } - }, - "Duration": { - "target": "com.amazonaws.elasticache#Integer", - "traits": { - "smithy.api#documentation": "

The duration of the offering. in seconds.

" - } - }, "ProductDescription": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -7132,16 +7952,16 @@ "smithy.api#documentation": "

The recurring price charged to run this reserved cache node.

" } }, - "OfferingType": { + "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The offering type.

" + "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, - "FixedPrice": { - "target": "com.amazonaws.elasticache#Double", + "OfferingType": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The fixed price charged for this offering.

" + "smithy.api#documentation": "

The offering type.

" } }, "ReservedCacheNodesOfferingId": { @@ -7150,11 +7970,23 @@ "smithy.api#documentation": "

A unique identifier for the reserved cache node offering.

" } }, + "FixedPrice": { + "target": "com.amazonaws.elasticache#Double", + "traits": { + "smithy.api#documentation": "

The fixed price charged for this offering.

" + } + }, "UsagePrice": { "target": "com.amazonaws.elasticache#Double", "traits": { "smithy.api#documentation": "

The hourly price charged for this offering.

" } + }, + "Duration": { + "target": "com.amazonaws.elasticache#Integer", + "traits": { + "smithy.api#documentation": "

The duration of the offering. in seconds.

" + } } }, "traits": { @@ -7242,17 +8074,17 @@ "smithy.api#required": {} } }, - "ResetAllParameters": { - "target": "com.amazonaws.elasticache#Boolean", - "traits": { - "smithy.api#documentation": "

If true, \n all parameters in the cache parameter group are reset to their default values.\n If false, only the parameters listed by ParameterNameValues\n are reset to their default values.

\n

Valid values: true | false\n

" - } - }, "ParameterNameValues": { "target": "com.amazonaws.elasticache#ParameterNameValueList", "traits": { "smithy.api#documentation": "

An array of parameter names to reset to their default values. \n If ResetAllParameters is true, \n do not use ParameterNameValues.\n If ResetAllParameters is false, \n you must specify the name of at least one parameter to reset.

" } + }, + "ResetAllParameters": { + "target": "com.amazonaws.elasticache#Boolean", + "traits": { + "smithy.api#documentation": "

If true, \n all parameters in the cache parameter group are reset to their default values.\n If false, only the parameters listed by ParameterNameValues\n are reset to their default values.

\n

Valid values: true | false\n

" + } } }, "traits": { @@ -7262,17 +8094,17 @@ "com.amazonaws.elasticache#ReshardingConfiguration": { "type": "structure", "members": { - "NodeGroupId": { - "target": "com.amazonaws.elasticache#AllowedNodeGroupId", - "traits": { - "smithy.api#documentation": "

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.

" - } - }, "PreferredAvailabilityZones": { "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { "smithy.api#documentation": "

A list of preferred availability zones for the nodes in this cluster.

" } + }, + "NodeGroupId": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "traits": { + "smithy.api#documentation": "

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.

" + } } }, "traits": { @@ -7334,6 +8166,13 @@ "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressMessage": { "type": "structure", "members": { + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The AWS account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an AWS access key ID - you must provide \n a valid AWS account number for this parameter.

", + "smithy.api#required": {} + } + }, "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -7347,13 +8186,6 @@ "smithy.api#documentation": "

The name of the Amazon EC2 security group to revoke access from.

", "smithy.api#required": {} } - }, - "EC2SecurityGroupOwnerId": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The AWS account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an AWS access key ID - you must provide \n a valid AWS account number for this parameter.

", - "smithy.api#required": {} - } } }, "traits": { @@ -7380,16 +8212,16 @@ "com.amazonaws.elasticache#SecurityGroupMembership": { "type": "structure", "members": { - "SecurityGroupId": { + "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the cache security group.

" + "smithy.api#documentation": "

The status of the cache security group membership. \n The status changes whenever a cache security group is modified, \n or when the cache security groups assigned to a cluster are modified.

" } }, - "Status": { + "SecurityGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The status of the cache security group membership. \n The status changes whenever a cache security group is modified, \n or when the cache security groups assigned to a cluster are modified.

" + "smithy.api#documentation": "

The identifier of the cache security group.

" } } }, @@ -7425,40 +8257,46 @@ "smithy.api#documentation": "

Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.

" } }, - "ServiceUpdateSeverity": { - "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", + "EngineVersion": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The severity of the service update

" + "smithy.api#documentation": "

The Elasticache engine version to which the update applies. Either Redis or Memcached engine version

" } }, - "ServiceUpdateEndDate": { - "target": "com.amazonaws.elasticache#TStamp", + "ServiceUpdateType": { + "target": "com.amazonaws.elasticache#ServiceUpdateType", "traits": { - "smithy.api#documentation": "

The date after which the service update is no longer available

" + "smithy.api#documentation": "

Reflects the nature of the service update

" } }, - "Engine": { + "EstimatedUpdateTime": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Redis or Memcached

" + "smithy.api#documentation": "

The estimated length of time the service update will take

" } }, - "ServiceUpdateName": { - "target": "com.amazonaws.elasticache#String", + "ServiceUpdateStatus": { + "target": "com.amazonaws.elasticache#ServiceUpdateStatus", "traits": { - "smithy.api#documentation": "

The unique ID of the service update

" + "smithy.api#documentation": "

The status of the service update

" } }, - "EngineVersion": { + "ServiceUpdateSeverity": { + "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", + "traits": { + "smithy.api#documentation": "

The severity of the service update

" + } + }, + "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache engine version to which the update applies. Either Redis or Memcached engine version

" + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Redis or Memcached

" } }, - "ServiceUpdateStatus": { - "target": "com.amazonaws.elasticache#ServiceUpdateStatus", + "ServiceUpdateRecommendedApplyByDate": { + "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The status of the service update

" + "smithy.api#documentation": "

The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" } }, "ServiceUpdateReleaseDate": { @@ -7467,10 +8305,10 @@ "smithy.api#documentation": "

The date when the service update is initially available

" } }, - "ServiceUpdateType": { - "target": "com.amazonaws.elasticache#ServiceUpdateType", + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Reflects the nature of the service update

" + "smithy.api#documentation": "

The unique ID of the service update

" } }, "ServiceUpdateDescription": { @@ -7479,16 +8317,10 @@ "smithy.api#documentation": "

Provides details of the service update

" } }, - "ServiceUpdateRecommendedApplyByDate": { + "ServiceUpdateEndDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" - } - }, - "EstimatedUpdateTime": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The estimated length of time the service update will take

" + "smithy.api#documentation": "

The date after which the service update is no longer available

" } } }, @@ -7586,17 +8418,17 @@ "com.amazonaws.elasticache#ServiceUpdatesMessage": { "type": "structure", "members": { - "ServiceUpdates": { - "target": "com.amazonaws.elasticache#ServiceUpdateList", - "traits": { - "smithy.api#documentation": "

A list of service updates

" - } - }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#documentation": "

An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } + }, + "ServiceUpdates": { + "target": "com.amazonaws.elasticache#ServiceUpdateList", + "traits": { + "smithy.api#documentation": "

A list of service updates

" + } } } }, @@ -7636,160 +8468,166 @@ "com.amazonaws.elasticache#Snapshot": { "type": "structure", "members": { - "CacheSubnetGroupName": { + "ReplicationGroupDescription": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache subnet group associated with the source cluster.

" + "smithy.api#documentation": "

A description of the source replication group.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.elasticache#String", + "NumNodeGroups": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" + "smithy.api#documentation": "

The number of node groups (shards) in this snapshot.\n When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored \n replication group must be the same.

" } }, - "EngineVersion": { - "target": "com.amazonaws.elasticache#String", + "AutomaticFailover": { + "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { - "smithy.api#documentation": "

The version of the cache engine version that is used by the source cluster.

" + "smithy.api#documentation": "

Indicates the status of automatic failover for the source Redis replication group.

" } }, - "SnapshotSource": { + "PreferredOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Indicates whether the snapshot is from an automatic backup (automated) \n or was created manually (manual).

" + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the preferred outpost.

" } }, - "PreferredAvailabilityZone": { + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the Availability Zone in which the source cluster is located.

" + "smithy.api#documentation": "

The unique identifier of the source replication group.

" } }, - "PreferredMaintenanceWindow": { + "Port": { + "target": "com.amazonaws.elasticache#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number used by each cache nodes in the source cluster.

" + } + }, + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" + "smithy.api#documentation": "

The user-supplied identifier of the source cluster.

" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.elasticache#Boolean", + "NumCacheNodes": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

This parameter is currently disabled.

" + "smithy.api#documentation": "

The number of cache nodes in the source cluster.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 20.

" } }, - "VpcId": { + "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

" + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, - "CacheParameterGroupName": { + "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache parameter group that is associated with the source cluster.

" + "smithy.api#documentation": "

The name of a snapshot. \n For an automatic snapshot, the name is system-generated. \n For a manual snapshot, this is the user-provided name.

" } }, - "CacheClusterCreateTime": { - "target": "com.amazonaws.elasticache#TStamp", + "Engine": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The date and time when the source cluster was created.

" + "smithy.api#documentation": "

The name of the cache engine (memcached or \n redis) used by the source cluster.

" } }, - "SnapshotRetentionLimit": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "TopicArn": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

\n

For manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n operation.

\n

\n Important\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

" } }, - "SnapshotStatus": { + "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The status of the snapshot. Valid values: creating | available\n | restoring | copying | deleting.

" + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" } }, - "CacheNodeType": { - "target": "com.amazonaws.elasticache#String", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " + "smithy.api#documentation": "

This parameter is currently disabled.

" } }, - "SnapshotWindow": { + "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

" + "smithy.api#documentation": "

The cache parameter group that is associated with the source cluster.

" } }, - "NodeSnapshots": { - "target": "com.amazonaws.elasticache#NodeSnapshotList", + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A list of the cache nodes in the source cluster.

" + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.

\n

Valid values for ddd are:

\n \n

Example: sun:23:00-mon:01:30\n

" } }, - "NumCacheNodes": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "SnapshotSource": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The number of cache nodes in the source cluster.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 20.

" + "smithy.api#documentation": "

Indicates whether the snapshot is from an automatic backup (automated) \n or was created manually (manual).

" } }, - "ARN": { + "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the snapshot.

" + "smithy.api#documentation": "

The name of the Availability Zone in which the source cluster is located.

" } }, - "CacheClusterId": { + "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The user-supplied identifier of the source cluster.

" + "smithy.api#documentation": "

The version of the cache engine version that is used by the source cluster.

" } }, - "TopicArn": { + "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

" + "smithy.api#documentation": "

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

" } }, - "Port": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "SnapshotStatus": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The port number used by each cache nodes in the source cluster.

" + "smithy.api#documentation": "

The status of the snapshot. Valid values: creating | available\n | restoring | copying | deleting.

" } }, - "NumNodeGroups": { - "target": "com.amazonaws.elasticache#IntegerOptional", + "VpcId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The number of node groups (shards) in this snapshot.\n When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored \n replication group must be the same.

" + "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

" } }, - "AutomaticFailover": { - "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", + "CacheClusterCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

Indicates the status of automatic failover for the source Redis replication group.

" + "smithy.api#documentation": "

The date and time when the source cluster was created.

" } }, - "ReplicationGroupDescription": { - "target": "com.amazonaws.elasticache#String", + "SnapshotRetentionLimit": { + "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

A description of the source replication group.

" + "smithy.api#documentation": "

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

\n

For manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n operation.

\n

\n Important\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" } }, - "SnapshotName": { - "target": "com.amazonaws.elasticache#String", + "NodeSnapshots": { + "target": "com.amazonaws.elasticache#NodeSnapshotList", "traits": { - "smithy.api#documentation": "

The name of a snapshot. \n For an automatic snapshot, the name is system-generated. \n For a manual snapshot, this is the user-provided name.

" + "smithy.api#documentation": "

A list of the cache nodes in the source cluster.

" } }, - "Engine": { + "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache engine (memcached or \n redis) used by the source cluster.

" + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the snapshot.

" } }, - "ReplicationGroupId": { + "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the source replication group.

" + "smithy.api#documentation": "

The name of the cache subnet group associated with the source cluster.

" } } }, @@ -7885,6 +8723,12 @@ }, { "value": "replication-group" + }, + { + "value": "user" + }, + { + "value": "user-group" } ] } @@ -7918,17 +8762,17 @@ "com.amazonaws.elasticache#StartMigrationMessage": { "type": "structure", "members": { - "CustomerNodeEndpointList": { - "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.

", + "smithy.api#documentation": "

The ID of the replication group to which data should be migrated.

", "smithy.api#required": {} } }, - "ReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", + "CustomerNodeEndpointList": { + "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", "traits": { - "smithy.api#documentation": "

The ID of the replication group to which data should be migrated.

", + "smithy.api#documentation": "

List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.

", "smithy.api#required": {} } } @@ -7954,6 +8798,12 @@ "smithy.api#documentation": "

The unique identifier for the subnet.

" } }, + "SubnetOutpost": { + "target": "com.amazonaws.elasticache#SubnetOutpost", + "traits": { + "smithy.api#documentation": "

The outpost ARN of the subnet.

" + } + }, "SubnetAvailabilityZone": { "target": "com.amazonaws.elasticache#AvailabilityZone", "traits": { @@ -7996,32 +8846,59 @@ } } }, - "com.amazonaws.elasticache#TStamp": { - "type": "timestamp" + "com.amazonaws.elasticache#SubnetNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a\n user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - "com.amazonaws.elasticache#Tag": { + "com.amazonaws.elasticache#SubnetOutpost": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The key for the tag. May not be null.

" - } - }, - "Value": { + "SubnetOutpostArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The tag's value. May be null.

" + "smithy.api#documentation": "

The outpost ARN of the subnet.

" } } }, "traits": { - "smithy.api#documentation": "

A cost allocation Tag that can be added to an ElastiCache cluster or replication group. \n Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

" + "smithy.api#documentation": "

The ID of the outpost subnet.

" } }, - "com.amazonaws.elasticache#TagList": { - "type": "list", - "member": { + "com.amazonaws.elasticache#TStamp": { + "type": "timestamp" + }, + "com.amazonaws.elasticache#Tag": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The tag's value. May be null.

" + } + }, + "Key": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The key for the tag. May not be null.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A cost allocation Tag that can be added to an ElastiCache cluster or replication group. \n Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

" + } + }, + "com.amazonaws.elasticache#TagList": { + "type": "list", + "member": { "target": "com.amazonaws.elasticache#Tag", "traits": { "smithy.api#xmlName": "Tag" @@ -8112,17 +8989,17 @@ "com.amazonaws.elasticache#TestFailoverMessage": { "type": "structure", "members": { - "NodeGroupId": { - "target": "com.amazonaws.elasticache#AllowedNodeGroupId", + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested.\n You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

", + "smithy.api#documentation": "

The name of the replication group (console: cluster) whose automatic failover is being\n tested by this operation.

", "smithy.api#required": {} } }, - "ReplicationGroupId": { - "target": "com.amazonaws.elasticache#String", + "NodeGroupId": { + "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "

The name of the replication group (console: cluster) whose automatic failover is being\n tested by this operation.

", + "smithy.api#documentation": "

The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested.\n You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

", "smithy.api#required": {} } } @@ -8152,16 +9029,16 @@ "com.amazonaws.elasticache#TimeRangeFilter": { "type": "structure", "members": { - "StartTime": { + "EndTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The start time of the time range filter

" + "smithy.api#documentation": "

The end time of the time range filter

" } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The end time of the time range filter

" + "smithy.api#documentation": "

The start time of the time range filter

" } } }, @@ -8169,6 +9046,12 @@ "smithy.api#documentation": "

Filters update actions from the service updates that are in available status during the time range.

" } }, + "com.amazonaws.elasticache#UGReplicationGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#String" + } + }, "com.amazonaws.elasticache#UnprocessedUpdateAction": { "type": "structure", "members": { @@ -8178,28 +9061,28 @@ "smithy.api#documentation": "

The replication group ID

" } }, - "ServiceUpdateName": { + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The unique ID of the service update

" + "smithy.api#documentation": "

The ID of the cache cluster

" } }, - "CacheClusterId": { + "ErrorType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the cache cluster

" + "smithy.api#documentation": "

The error type for requests that are not processed

" } }, - "ErrorMessage": { + "ServiceUpdateName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The error message that describes the reason the request was not processed

" + "smithy.api#documentation": "

The unique ID of the service update

" } }, - "ErrorType": { + "ErrorMessage": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The error type for requests that are not processed

" + "smithy.api#documentation": "

The error message that describes the reason the request was not processed

" } } }, @@ -8225,40 +9108,16 @@ "smithy.api#documentation": "

Reflects the nature of the service update

" } }, - "UpdateActionStatusModifiedDate": { - "target": "com.amazonaws.elasticache#TStamp", - "traits": { - "smithy.api#documentation": "

The date when the UpdateActionStatus was last modified

" - } - }, - "ServiceUpdateSeverity": { - "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", - "traits": { - "smithy.api#documentation": "

The severity of the service update

" - } - }, - "ServiceUpdateName": { - "target": "com.amazonaws.elasticache#String", - "traits": { - "smithy.api#documentation": "

The unique ID of the service update

" - } - }, "CacheNodeUpdateStatus": { "target": "com.amazonaws.elasticache#CacheNodeUpdateStatusList", "traits": { "smithy.api#documentation": "

The status of the service update on the cache node

" } }, - "UpdateActionAvailableDate": { - "target": "com.amazonaws.elasticache#TStamp", - "traits": { - "smithy.api#documentation": "

The date that the service update is available to a replication group

" - } - }, - "NodesUpdated": { + "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The progress of the service update on the replication group

" + "smithy.api#documentation": "

The ID of the replication group

" } }, "ServiceUpdateStatus": { @@ -8267,16 +9126,16 @@ "smithy.api#documentation": "

The status of the service update

" } }, - "CacheClusterId": { - "target": "com.amazonaws.elasticache#String", + "UpdateActionAvailableDate": { + "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The ID of the cache cluster

" + "smithy.api#documentation": "

The date that the service update is available to a replication group

" } }, - "ServiceUpdateRecommendedApplyByDate": { - "target": "com.amazonaws.elasticache#TStamp", + "NodesUpdated": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" + "smithy.api#documentation": "

The progress of the service update on the replication group

" } }, "UpdateActionStatus": { @@ -8291,10 +9150,10 @@ "smithy.api#documentation": "

The date the update is first available

" } }, - "ReplicationGroupId": { + "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the replication group

" + "smithy.api#documentation": "

The ID of the cache cluster

" } }, "EstimatedUpdateTime": { @@ -8303,10 +9162,22 @@ "smithy.api#documentation": "

The estimated length of time for the update to complete

" } }, - "SlaMet": { - "target": "com.amazonaws.elasticache#SlaMet", + "ServiceUpdateName": { + "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.

" + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "UpdateActionStatusModifiedDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the UpdateActionStatus was last modified

" + } + }, + "ServiceUpdateRecommendedApplyByDate": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" } }, "Engine": { @@ -8320,6 +9191,18 @@ "traits": { "smithy.api#documentation": "

The status of the service update on the node group

" } + }, + "ServiceUpdateSeverity": { + "target": "com.amazonaws.elasticache#ServiceUpdateSeverity", + "traits": { + "smithy.api#documentation": "

The severity of the service update

" + } + }, + "SlaMet": { + "target": "com.amazonaws.elasticache#SlaMet", + "traits": { + "smithy.api#documentation": "

If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.

" + } } }, "traits": { @@ -8423,6 +9306,296 @@ } } } + }, + "com.amazonaws.elasticache#User": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".

" + } + }, + "UserName": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The username of the user.

" + } + }, + "UserGroupIds": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

Returns a list of the user group IDs the user belongs to.

" + } + }, + "AccessString": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user account.

" + } + }, + "UserId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the user.

" + } + }, + "Authentication": { + "target": "com.amazonaws.elasticache#Authentication", + "traits": { + "smithy.api#documentation": "

Denotes whether the user requires a password to authenticate.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

Must be Redis.

" + } + } + } + }, + "com.amazonaws.elasticache#UserAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A user with this ID already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#UserGroup": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Indicates user group status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#EngineType", + "traits": { + "smithy.api#documentation": "

Must be Redis.

" + } + }, + "UserIds": { + "target": "com.amazonaws.elasticache#UserIdList", + "traits": { + "smithy.api#documentation": "

The list of user IDs that belong to the user group.

" + } + }, + "ARN": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user group.

" + } + }, + "UserGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The ID of the user group.

" + } + }, + "PendingChanges": { + "target": "com.amazonaws.elasticache#UserGroupPendingChanges", + "traits": { + "smithy.api#documentation": "

A list of updates being applied to the user groups.

" + } + }, + "ReplicationGroups": { + "target": "com.amazonaws.elasticache#UGReplicationGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of replication groups that the user group can access.

" + } + } + } + }, + "com.amazonaws.elasticache#UserGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The user group with this ID already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#UserGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "[a-zA-Z][a-zA-Z0-9\\-]*" + } + }, + "com.amazonaws.elasticache#UserGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserGroupId" + } + }, + "com.amazonaws.elasticache#UserGroupIdListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#UserGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserGroup" + } + }, + "com.amazonaws.elasticache#UserGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The user group was not found or does not exist

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#UserGroupPendingChanges": { + "type": "structure", + "members": { + "UserIdsToAdd": { + "target": "com.amazonaws.elasticache#UserIdList", + "traits": { + "smithy.api#documentation": "

The list of user IDs to add.

" + } + }, + "UserIdsToRemove": { + "target": "com.amazonaws.elasticache#UserIdList", + "traits": { + "smithy.api#documentation": "

The list of user group IDs ro remove.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the updates being applied to the user group.

" + } + }, + "com.amazonaws.elasticache#UserGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The number of users exceeds the user group limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.elasticache#UserGroupsUpdateStatus": { + "type": "structure", + "members": { + "UserGroupIdsToRemove": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

The list of user group IDs to remove.

" + } + }, + "UserGroupIdsToAdd": { + "target": "com.amazonaws.elasticache#UserGroupIdList", + "traits": { + "smithy.api#documentation": "

The list of user group IDs to add.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the user group update.

" + } + }, + "com.amazonaws.elasticache#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "[a-zA-Z][a-zA-Z0-9\\-]*" + } + }, + "com.amazonaws.elasticache#UserIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserId" + } + }, + "com.amazonaws.elasticache#UserIdListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#UserId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticache#User" + } + }, + "com.amazonaws.elasticache#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.elasticache#UserNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The user does not exist or could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.elasticache#UserQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.elasticache#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The quota of users has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } } } } diff --git a/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json b/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json index 396d0b6bf874..86ed832a9bc6 100644 --- a/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json +++ b/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json @@ -112,17 +112,17 @@ "com.amazonaws.elasticsearchservice#AccessPoliciesStatus": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#PolicyDocument", "traits": { - "smithy.api#documentation": "

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

", + "smithy.api#documentation": "

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See \n Configuring Access Policiesfor more information.

", "smithy.api#required": {} } }, - "Options": { - "target": "com.amazonaws.elasticsearchservice#PolicyDocument", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See \n Configuring Access Policiesfor more information.

", + "smithy.api#documentation": "

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

", "smithy.api#required": {} } } @@ -162,17 +162,17 @@ "com.amazonaws.elasticsearchservice#AddTagsRequest": { "type": "structure", "members": { - "ARN": { - "target": "com.amazonaws.elasticsearchservice#ARN", + "TagList": { + "target": "com.amazonaws.elasticsearchservice#TagList", "traits": { - "smithy.api#documentation": "

Specify the ARN for which you want to add the tags.

", + "smithy.api#documentation": "

List of Tag that need to be added for the Elasticsearch domain.

", "smithy.api#required": {} } }, - "TagList": { - "target": "com.amazonaws.elasticsearchservice#TagList", + "ARN": { + "target": "com.amazonaws.elasticsearchservice#ARN", "traits": { - "smithy.api#documentation": "

List of Tag that need to be added for the Elasticsearch domain.

", + "smithy.api#documentation": "

Specify the ARN for which you want to add the tags.

", "smithy.api#required": {} } } @@ -222,17 +222,17 @@ "com.amazonaws.elasticsearchservice#AdvancedOptionsStatus": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", "traits": { - "smithy.api#documentation": "

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the status of advanced options for the specified Elasticsearch domain.

", "smithy.api#required": {} } }, - "Options": { - "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Specifies the status of advanced options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

", "smithy.api#required": {} } } @@ -244,16 +244,16 @@ "com.amazonaws.elasticsearchservice#AdvancedSecurityOptions": { "type": "structure", "members": { - "Enabled": { + "InternalUserDatabaseEnabled": { "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { - "smithy.api#documentation": "

True if advanced security is enabled.

" + "smithy.api#documentation": "

True if the internal user database is enabled.

" } }, - "InternalUserDatabaseEnabled": { + "Enabled": { "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { - "smithy.api#documentation": "

True if the internal user database is enabled.

" + "smithy.api#documentation": "

True if advanced security is enabled.

" } } }, @@ -290,17 +290,17 @@ "com.amazonaws.elasticsearchservice#AdvancedSecurityOptionsStatus": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptions", "traits": { - "smithy.api#documentation": "

Status of the advanced security options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies advanced security options for the specified Elasticsearch domain.

", "smithy.api#required": {} } }, - "Options": { - "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Specifies advanced security options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Status of the advanced security options for the specified Elasticsearch domain.

", "smithy.api#required": {} } } @@ -430,7 +430,7 @@ "sdkId": "Elasticsearch Service", "arnNamespace": "es", "cloudFormationName": "Elasticsearch", - "cloudTrailEventSource": "config2015.es.a9.com" + "cloudTrailEventSource": "elasticsearchservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "es" @@ -608,10 +608,10 @@ "com.amazonaws.elasticsearchservice#CognitoOptions": { "type": "structure", "members": { - "IdentityPoolId": { - "target": "com.amazonaws.elasticsearchservice#IdentityPoolId", + "RoleArn": { + "target": "com.amazonaws.elasticsearchservice#RoleArn", "traits": { - "smithy.api#documentation": "

Specifies the Cognito identity pool ID for Kibana authentication.

" + "smithy.api#documentation": "

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

" } }, "Enabled": { @@ -620,17 +620,17 @@ "smithy.api#documentation": "

Specifies the option to enable Cognito for Kibana authentication.

" } }, - "RoleArn": { - "target": "com.amazonaws.elasticsearchservice#RoleArn", - "traits": { - "smithy.api#documentation": "

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

" - } - }, "UserPoolId": { "target": "com.amazonaws.elasticsearchservice#UserPoolId", "traits": { "smithy.api#documentation": "

Specifies the Cognito user pool ID for Kibana authentication.

" } + }, + "IdentityPoolId": { + "target": "com.amazonaws.elasticsearchservice#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

Specifies the Cognito identity pool ID for Kibana authentication.

" + } } }, "traits": { @@ -640,17 +640,17 @@ "com.amazonaws.elasticsearchservice#CognitoOptionsStatus": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.elasticsearchservice#CognitoOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Specifies the Cognito options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the status of the Cognito options for the specified Elasticsearch domain.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#CognitoOptions", "traits": { - "smithy.api#documentation": "

Specifies the status of the Cognito options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the Cognito options for the specified Elasticsearch domain.

", "smithy.api#required": {} } } @@ -668,14 +668,14 @@ "com.amazonaws.elasticsearchservice#CompatibleVersionsMap": { "type": "structure", "members": { - "TargetVersions": { - "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionList" - }, "SourceVersion": { "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionString", "traits": { "smithy.api#documentation": "

The current version of Elasticsearch on which a domain is.

" } + }, + "TargetVersions": { + "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionList" } }, "traits": { @@ -762,16 +762,10 @@ "smithy.api#documentation": "

Options to specify configuration that will be applied to the domain endpoint.

" } }, - "EBSOptions": { - "target": "com.amazonaws.elasticsearchservice#EBSOptions", - "traits": { - "smithy.api#documentation": "

Options to enable, disable and specify the type and size of EBS storage volumes.

" - } - }, - "ElasticsearchVersion": { - "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionString", + "SnapshotOptions": { + "target": "com.amazonaws.elasticsearchservice#SnapshotOptions", "traits": { - "smithy.api#documentation": "

String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information,\n see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

" + "smithy.api#documentation": "

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

" } }, "ElasticsearchClusterConfig": { @@ -780,47 +774,46 @@ "smithy.api#documentation": "

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

" } }, - "SnapshotOptions": { - "target": "com.amazonaws.elasticsearchservice#SnapshotOptions", + "LogPublishingOptions": { + "target": "com.amazonaws.elasticsearchservice#LogPublishingOptions", "traits": { - "smithy.api#documentation": "

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

" + "smithy.api#documentation": "

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

" } }, - "AdvancedSecurityOptions": { - "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptionsInput", + "CognitoOptions": { + "target": "com.amazonaws.elasticsearchservice#CognitoOptions", "traits": { - "smithy.api#documentation": "

Specifies advanced security options.

" + "smithy.api#documentation": "

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

" } }, - "LogPublishingOptions": { - "target": "com.amazonaws.elasticsearchservice#LogPublishingOptions", + "AdvancedOptions": { + "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", "traits": { - "smithy.api#documentation": "

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

" + "smithy.api#documentation": "

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true.\n See Configuration Advanced Options for more information.

" } }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.elasticsearchservice#EncryptionAtRestOptions", + "AdvancedSecurityOptions": { + "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptionsInput", "traits": { - "smithy.api#documentation": "

Specifies the Encryption At Rest Options.

" + "smithy.api#documentation": "

Specifies advanced security options.

" } }, - "CognitoOptions": { - "target": "com.amazonaws.elasticsearchservice#CognitoOptions", + "EncryptionAtRestOptions": { + "target": "com.amazonaws.elasticsearchservice#EncryptionAtRestOptions", "traits": { - "smithy.api#documentation": "

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

" + "smithy.api#documentation": "

Specifies the Encryption At Rest Options.

" } }, - "DomainName": { - "target": "com.amazonaws.elasticsearchservice#DomainName", + "VPCOptions": { + "target": "com.amazonaws.elasticsearchservice#VPCOptions", "traits": { - "smithy.api#documentation": "

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

", - "smithy.api#required": {} + "smithy.api#documentation": "

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

" } }, - "AdvancedOptions": { - "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", + "EBSOptions": { + "target": "com.amazonaws.elasticsearchservice#EBSOptions", "traits": { - "smithy.api#documentation": "

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true.\n See Configuration Advanced Options for more information.

" + "smithy.api#documentation": "

Options to enable, disable and specify the type and size of EBS storage volumes.

" } }, "NodeToNodeEncryptionOptions": { @@ -829,10 +822,17 @@ "smithy.api#documentation": "

Specifies the NodeToNodeEncryptionOptions.

" } }, - "VPCOptions": { - "target": "com.amazonaws.elasticsearchservice#VPCOptions", + "ElasticsearchVersion": { + "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionString", "traits": { - "smithy.api#documentation": "

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

" + "smithy.api#documentation": "

String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information,\n see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

" + } + }, + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

", + "smithy.api#required": {} } } } @@ -885,6 +885,13 @@ "com.amazonaws.elasticsearchservice#CreateOutboundCrossClusterSearchConnectionRequest": { "type": "structure", "members": { + "DestinationDomainInfo": { + "target": "com.amazonaws.elasticsearchservice#DomainInformation", + "traits": { + "smithy.api#documentation": "

Specifies the DomainInformation for the destination Elasticsearch domain.

", + "smithy.api#required": {} + } + }, "SourceDomainInfo": { "target": "com.amazonaws.elasticsearchservice#DomainInformation", "traits": { @@ -898,13 +905,6 @@ "smithy.api#documentation": "

Specifies the connection alias that will be used by the customer for this connection.

", "smithy.api#required": {} } - }, - "DestinationDomainInfo": { - "target": "com.amazonaws.elasticsearchservice#DomainInformation", - "traits": { - "smithy.api#documentation": "

Specifies the DomainInformation for the destination Elasticsearch domain.

", - "smithy.api#required": {} - } } }, "traits": { @@ -914,10 +914,10 @@ "com.amazonaws.elasticsearchservice#CreateOutboundCrossClusterSearchConnectionResponse": { "type": "structure", "members": { - "SourceDomainInfo": { - "target": "com.amazonaws.elasticsearchservice#DomainInformation", + "ConnectionAlias": { + "target": "com.amazonaws.elasticsearchservice#ConnectionAlias", "traits": { - "smithy.api#documentation": "

Specifies the DomainInformation for the source Elasticsearch domain.

" + "smithy.api#documentation": "

Specifies the connection alias provided during the create connection request.

" } }, "DestinationDomainInfo": { @@ -938,10 +938,10 @@ "smithy.api#documentation": "

Unique id for the created outbound connection, which is used for subsequent operations on connection.

" } }, - "ConnectionAlias": { - "target": "com.amazonaws.elasticsearchservice#ConnectionAlias", + "SourceDomainInfo": { + "target": "com.amazonaws.elasticsearchservice#DomainInformation", "traits": { - "smithy.api#documentation": "

Specifies the connection alias provided during the create connection request.

" + "smithy.api#documentation": "

Specifies the DomainInformation for the source Elasticsearch domain.

" } } }, @@ -992,19 +992,6 @@ "com.amazonaws.elasticsearchservice#CreatePackageRequest": { "type": "structure", "members": { - "PackageSource": { - "target": "com.amazonaws.elasticsearchservice#PackageSource", - "traits": { - "smithy.api#documentation": "

The customer S3 location PackageSource for importing the package.

", - "smithy.api#required": {} - } - }, - "PackageDescription": { - "target": "com.amazonaws.elasticsearchservice#PackageDescription", - "traits": { - "smithy.api#documentation": "

Description of the package.

" - } - }, "PackageName": { "target": "com.amazonaws.elasticsearchservice#PackageName", "traits": { @@ -1018,6 +1005,19 @@ "smithy.api#documentation": "

Type of package. Currently supports only TXT-DICTIONARY.

", "smithy.api#required": {} } + }, + "PackageSource": { + "target": "com.amazonaws.elasticsearchservice#PackageSource", + "traits": { + "smithy.api#documentation": "

The customer S3 location PackageSource for importing the package.

", + "smithy.api#required": {} + } + }, + "PackageDescription": { + "target": "com.amazonaws.elasticsearchservice#PackageDescription", + "traits": { + "smithy.api#documentation": "

Description of the package.

" + } } }, "traits": { @@ -1554,14 +1554,6 @@ "com.amazonaws.elasticsearchservice#DescribeElasticsearchInstanceTypeLimitsRequest": { "type": "structure", "members": { - "InstanceType": { - "target": "com.amazonaws.elasticsearchservice#ESPartitionInstanceType", - "traits": { - "smithy.api#documentation": "

\n The instance type for an Elasticsearch cluster for which Elasticsearch\n \n Limits\n \n are needed.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "ElasticsearchVersion": { "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionString", "traits": { @@ -1576,6 +1568,14 @@ "smithy.api#documentation": "

\n DomainName represents the name of the Domain that we are trying to\n modify. This should be present only if we are\n querying for Elasticsearch\n \n Limits\n \n for existing domain.\n

", "smithy.api#httpQuery": "domainName" } + }, + "InstanceType": { + "target": "com.amazonaws.elasticsearchservice#ESPartitionInstanceType", + "traits": { + "smithy.api#documentation": "

\n The instance type for an Elasticsearch cluster for which Elasticsearch\n \n Limits\n \n are needed.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -1626,12 +1626,6 @@ "com.amazonaws.elasticsearchservice#DescribeInboundCrossClusterSearchConnectionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

" - } - }, "MaxResults": { "target": "com.amazonaws.elasticsearchservice#MaxResults", "traits": { @@ -1643,6 +1637,12 @@ "traits": { "smithy.api#documentation": "

\n A list of filters used to match properties for inbound cross-cluster search connection.\n Available Filter names for this operation are:\n

\n

" } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", + "traits": { + "smithy.api#documentation": "

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

" + } } }, "traits": { @@ -1652,17 +1652,17 @@ "com.amazonaws.elasticsearchservice#DescribeInboundCrossClusterSearchConnectionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken", - "traits": { - "smithy.api#documentation": "

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.\n

" - } - }, "CrossClusterSearchConnections": { "target": "com.amazonaws.elasticsearchservice#InboundCrossClusterSearchConnections", "traits": { "smithy.api#documentation": "

Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

" } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", + "traits": { + "smithy.api#documentation": "

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.\n

" + } } }, "traits": { @@ -1702,14 +1702,8 @@ "com.amazonaws.elasticsearchservice#DescribeOutboundCrossClusterSearchConnectionsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.elasticsearchservice#MaxResults", - "traits": { - "smithy.api#documentation": "

Set this value to limit the number of results returned. If not specified, defaults to 100.

" - } - }, - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken", + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", "traits": { "smithy.api#documentation": "

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

" } @@ -1719,6 +1713,12 @@ "traits": { "smithy.api#documentation": "

\n A list of filters used to match properties for outbound cross-cluster search connection.\n Available Filter names for this operation are:\n

\n

" } + }, + "MaxResults": { + "target": "com.amazonaws.elasticsearchservice#MaxResults", + "traits": { + "smithy.api#documentation": "

Set this value to limit the number of results returned. If not specified, defaults to 100.

" + } } }, "traits": { @@ -1787,17 +1787,17 @@ "com.amazonaws.elasticsearchservice#DescribePackagesFilter": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.elasticsearchservice#DescribePackagesFilterValues", - "traits": { - "smithy.api#documentation": "

A list of values for the specified field.

" - } - }, "Name": { "target": "com.amazonaws.elasticsearchservice#DescribePackagesFilterName", "traits": { "smithy.api#documentation": "

Any field from PackageDetails.

" } + }, + "Value": { + "target": "com.amazonaws.elasticsearchservice#DescribePackagesFilterValues", + "traits": { + "smithy.api#documentation": "

A list of values for the specified field.

" + } } }, "traits": { @@ -1847,6 +1847,12 @@ "com.amazonaws.elasticsearchservice#DescribePackagesRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.elasticsearchservice#DescribePackagesFilterList", + "traits": { + "smithy.api#documentation": "

Only returns packages that match the DescribePackagesFilterList values.

" + } + }, "MaxResults": { "target": "com.amazonaws.elasticsearchservice#MaxResults", "traits": { @@ -1858,12 +1864,6 @@ "traits": { "smithy.api#documentation": "

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

" } - }, - "Filters": { - "target": "com.amazonaws.elasticsearchservice#DescribePackagesFilterList", - "traits": { - "smithy.api#documentation": "

Only returns packages that match the DescribePackagesFilterList values.

" - } } }, "traits": { @@ -2011,13 +2011,6 @@ "com.amazonaws.elasticsearchservice#DescribeReservedElasticsearchInstancesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken should be sent in case if earlier API call produced result\n\t\tcontaining NextToken. It is used for pagination.

", - "smithy.api#httpQuery": "nextToken" - } - }, "ReservedElasticsearchInstanceId": { "target": "com.amazonaws.elasticsearchservice#GUID", "traits": { @@ -2031,6 +2024,13 @@ "smithy.api#documentation": "

Set this value to limit the number of results returned. If not specified, defaults to 100.

", "smithy.api#httpQuery": "maxResults" } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", + "traits": { + "smithy.api#documentation": "

NextToken should be sent in case if earlier API call produced result\n\t\tcontaining NextToken. It is used for pagination.

", + "smithy.api#httpQuery": "nextToken" + } } }, "traits": { @@ -2113,18 +2113,18 @@ "com.amazonaws.elasticsearchservice#DissociatePackageRequest": { "type": "structure", "members": { - "PackageID": { - "target": "com.amazonaws.elasticsearchservice#PackageID", + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", "traits": { - "smithy.api#documentation": "

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

", + "smithy.api#documentation": "

Name of the domain that you want to associate the package with.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.elasticsearchservice#DomainName", + "PackageID": { + "target": "com.amazonaws.elasticsearchservice#PackageID", "traits": { - "smithy.api#documentation": "

Name of the domain that you want to associate the package with.

", + "smithy.api#documentation": "

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2151,17 +2151,17 @@ "com.amazonaws.elasticsearchservice#DomainEndpointOptions": { "type": "structure", "members": { - "TLSSecurityPolicy": { - "target": "com.amazonaws.elasticsearchservice#TLSSecurityPolicy", - "traits": { - "smithy.api#documentation": "

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.\n

It can be one of the following values:\n

\n

" - } - }, "EnforceHTTPS": { "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { "smithy.api#documentation": "

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

" } + }, + "TLSSecurityPolicy": { + "target": "com.amazonaws.elasticsearchservice#TLSSecurityPolicy", + "traits": { + "smithy.api#documentation": "

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.\n

It can be one of the following values:\n

\n

" + } } }, "traits": { @@ -2171,17 +2171,17 @@ "com.amazonaws.elasticsearchservice#DomainEndpointOptionsStatus": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Options to configure endpoint for the Elasticsearch domain.

", + "smithy.api#documentation": "

The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptions", "traits": { - "smithy.api#documentation": "

The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.

", + "smithy.api#documentation": "

Options to configure endpoint for the Elasticsearch domain.

", "smithy.api#required": {} } } @@ -2223,6 +2223,9 @@ "com.amazonaws.elasticsearchservice#DomainInformation": { "type": "structure", "members": { + "Region": { + "target": "com.amazonaws.elasticsearchservice#Region" + }, "DomainName": { "target": "com.amazonaws.elasticsearchservice#DomainName", "traits": { @@ -2231,9 +2234,6 @@ }, "OwnerId": { "target": "com.amazonaws.elasticsearchservice#OwnerId" - }, - "Region": { - "target": "com.amazonaws.elasticsearchservice#Region" } } }, @@ -2260,53 +2260,53 @@ "com.amazonaws.elasticsearchservice#DomainPackageDetails": { "type": "structure", "members": { - "PackageName": { - "target": "com.amazonaws.elasticsearchservice#PackageName", - "traits": { - "smithy.api#documentation": "

User specified name of the package.

" - } - }, - "ErrorDetails": { - "target": "com.amazonaws.elasticsearchservice#ErrorDetails", - "traits": { - "smithy.api#documentation": "

Additional information if the package is in an error state. Null otherwise.

" - } - }, - "PackageType": { - "target": "com.amazonaws.elasticsearchservice#PackageType", - "traits": { - "smithy.api#documentation": "

Currently supports only TXT-DICTIONARY.

" - } - }, "DomainName": { "target": "com.amazonaws.elasticsearchservice#DomainName", "traits": { "smithy.api#documentation": "

Name of the domain you've associated a package with.

" } }, - "ReferencePath": { - "target": "com.amazonaws.elasticsearchservice#ReferencePath", - "traits": { - "smithy.api#documentation": "

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

" - } - }, "PackageID": { "target": "com.amazonaws.elasticsearchservice#PackageID", "traits": { "smithy.api#documentation": "

Internal ID of the package.

" } }, + "ReferencePath": { + "target": "com.amazonaws.elasticsearchservice#ReferencePath", + "traits": { + "smithy.api#documentation": "

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

" + } + }, "LastUpdated": { "target": "com.amazonaws.elasticsearchservice#LastUpdated", "traits": { "smithy.api#documentation": "

Timestamp of the most-recent update to the association status.

" } }, + "ErrorDetails": { + "target": "com.amazonaws.elasticsearchservice#ErrorDetails", + "traits": { + "smithy.api#documentation": "

Additional information if the package is in an error state. Null otherwise.

" + } + }, "DomainPackageStatus": { "target": "com.amazonaws.elasticsearchservice#DomainPackageStatus", "traits": { "smithy.api#documentation": "

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

" } + }, + "PackageName": { + "target": "com.amazonaws.elasticsearchservice#PackageName", + "traits": { + "smithy.api#documentation": "

User specified name of the package.

" + } + }, + "PackageType": { + "target": "com.amazonaws.elasticsearchservice#PackageType", + "traits": { + "smithy.api#documentation": "

Currently supports only TXT-DICTIONARY.

" + } } }, "traits": { @@ -2350,10 +2350,16 @@ "com.amazonaws.elasticsearchservice#EBSOptions": { "type": "structure", "members": { - "Iops": { + "VolumeSize": { "target": "com.amazonaws.elasticsearchservice#IntegerClass", "traits": { - "smithy.api#documentation": "

Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

" + "smithy.api#documentation": "

Integer to specify the size of an EBS volume.

" + } + }, + "EBSEnabled": { + "target": "com.amazonaws.elasticsearchservice#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether EBS-based storage is enabled.

" } }, "VolumeType": { @@ -2362,16 +2368,10 @@ "smithy.api#documentation": "

Specifies the volume type for EBS-based storage.

" } }, - "VolumeSize": { + "Iops": { "target": "com.amazonaws.elasticsearchservice#IntegerClass", "traits": { - "smithy.api#documentation": "

Integer to specify the size of an EBS volume.

" - } - }, - "EBSEnabled": { - "target": "com.amazonaws.elasticsearchservice#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether EBS-based storage is enabled.

" + "smithy.api#documentation": "

Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

" } } }, @@ -2382,17 +2382,17 @@ "com.amazonaws.elasticsearchservice#EBSOptionsStatus": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.elasticsearchservice#EBSOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Specifies the EBS options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the status of the EBS options for the specified Elasticsearch domain.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#EBSOptions", "traits": { - "smithy.api#documentation": "

Specifies the status of the EBS options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the EBS options for the specified Elasticsearch domain.

", "smithy.api#required": {} } } @@ -2598,22 +2598,16 @@ "com.amazonaws.elasticsearchservice#ElasticsearchClusterConfig": { "type": "structure", "members": { - "ZoneAwarenessEnabled": { - "target": "com.amazonaws.elasticsearchservice#Boolean", - "traits": { - "smithy.api#documentation": "

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

" - } - }, - "WarmEnabled": { - "target": "com.amazonaws.elasticsearchservice#Boolean", + "ZoneAwarenessConfig": { + "target": "com.amazonaws.elasticsearchservice#ZoneAwarenessConfig", "traits": { - "smithy.api#documentation": "

True to enable warm storage.

" + "smithy.api#documentation": "

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

" } }, - "InstanceCount": { + "DedicatedMasterCount": { "target": "com.amazonaws.elasticsearchservice#IntegerClass", "traits": { - "smithy.api#documentation": "

The number of instances in the specified domain cluster.

" + "smithy.api#documentation": "

Total number of dedicated master nodes, active and on standby, for the cluster.

" } }, "DedicatedMasterEnabled": { @@ -2622,16 +2616,28 @@ "smithy.api#documentation": "

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

" } }, + "DedicatedMasterType": { + "target": "com.amazonaws.elasticsearchservice#ESPartitionInstanceType", + "traits": { + "smithy.api#documentation": "

The instance type for a dedicated master node.

" + } + }, "WarmCount": { "target": "com.amazonaws.elasticsearchservice#IntegerClass", "traits": { "smithy.api#documentation": "

The number of warm nodes in the cluster.

" } }, - "ZoneAwarenessConfig": { - "target": "com.amazonaws.elasticsearchservice#ZoneAwarenessConfig", + "WarmEnabled": { + "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

" + "smithy.api#documentation": "

True to enable warm storage.

" + } + }, + "ZoneAwarenessEnabled": { + "target": "com.amazonaws.elasticsearchservice#Boolean", + "traits": { + "smithy.api#documentation": "

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

" } }, "WarmType": { @@ -2646,16 +2652,10 @@ "smithy.api#documentation": "

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

" } }, - "DedicatedMasterCount": { + "InstanceCount": { "target": "com.amazonaws.elasticsearchservice#IntegerClass", "traits": { - "smithy.api#documentation": "

Total number of dedicated master nodes, active and on standby, for the cluster.

" - } - }, - "DedicatedMasterType": { - "target": "com.amazonaws.elasticsearchservice#ESPartitionInstanceType", - "traits": { - "smithy.api#documentation": "

The instance type for a dedicated master node.

" + "smithy.api#documentation": "

The number of instances in the specified domain cluster.

" } } }, @@ -2688,16 +2688,10 @@ "com.amazonaws.elasticsearchservice#ElasticsearchDomainConfig": { "type": "structure", "members": { - "ElasticsearchClusterConfig": { - "target": "com.amazonaws.elasticsearchservice#ElasticsearchClusterConfigStatus", - "traits": { - "smithy.api#documentation": "

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

" - } - }, - "DomainEndpointOptions": { - "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptionsStatus", + "LogPublishingOptions": { + "target": "com.amazonaws.elasticsearchservice#LogPublishingOptionsStatus", "traits": { - "smithy.api#documentation": "

Specifies the DomainEndpointOptions for the Elasticsearch domain.

" + "smithy.api#documentation": "

Log publishing options for the given domain.

" } }, "NodeToNodeEncryptionOptions": { @@ -2706,34 +2700,16 @@ "smithy.api#documentation": "

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

" } }, - "SnapshotOptions": { - "target": "com.amazonaws.elasticsearchservice#SnapshotOptionsStatus", - "traits": { - "smithy.api#documentation": "

Specifies the SnapshotOptions for the Elasticsearch domain.

" - } - }, - "AccessPolicies": { - "target": "com.amazonaws.elasticsearchservice#AccessPoliciesStatus", - "traits": { - "smithy.api#documentation": "

IAM access policy as a JSON-formatted string.

" - } - }, - "AdvancedSecurityOptions": { - "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptionsStatus", - "traits": { - "smithy.api#documentation": "

Specifies AdvancedSecurityOptions for the domain.

" - } - }, "AdvancedOptions": { "target": "com.amazonaws.elasticsearchservice#AdvancedOptionsStatus", "traits": { "smithy.api#documentation": "

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

" } }, - "LogPublishingOptions": { - "target": "com.amazonaws.elasticsearchservice#LogPublishingOptionsStatus", + "AdvancedSecurityOptions": { + "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptionsStatus", "traits": { - "smithy.api#documentation": "

Log publishing options for the given domain.

" + "smithy.api#documentation": "

Specifies AdvancedSecurityOptions for the domain.

" } }, "CognitoOptions": { @@ -2742,16 +2718,40 @@ "smithy.api#documentation": "

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

" } }, - "VPCOptions": { - "target": "com.amazonaws.elasticsearchservice#VPCDerivedInfoStatus", + "AccessPolicies": { + "target": "com.amazonaws.elasticsearchservice#AccessPoliciesStatus", + "traits": { + "smithy.api#documentation": "

IAM access policy as a JSON-formatted string.

" + } + }, + "DomainEndpointOptions": { + "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptionsStatus", + "traits": { + "smithy.api#documentation": "

Specifies the DomainEndpointOptions for the Elasticsearch domain.

" + } + }, + "SnapshotOptions": { + "target": "com.amazonaws.elasticsearchservice#SnapshotOptionsStatus", + "traits": { + "smithy.api#documentation": "

Specifies the SnapshotOptions for the Elasticsearch domain.

" + } + }, + "EBSOptions": { + "target": "com.amazonaws.elasticsearchservice#EBSOptionsStatus", + "traits": { + "smithy.api#documentation": "

Specifies the EBSOptions for the Elasticsearch domain.

" + } + }, + "VPCOptions": { + "target": "com.amazonaws.elasticsearchservice#VPCDerivedInfoStatus", "traits": { "smithy.api#documentation": "

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" } }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.elasticsearchservice#EncryptionAtRestOptionsStatus", + "ElasticsearchClusterConfig": { + "target": "com.amazonaws.elasticsearchservice#ElasticsearchClusterConfigStatus", "traits": { - "smithy.api#documentation": "

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

" + "smithy.api#documentation": "

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

" } }, "ElasticsearchVersion": { @@ -2760,10 +2760,10 @@ "smithy.api#documentation": "

String of format X.Y to specify version for the Elasticsearch domain.

" } }, - "EBSOptions": { - "target": "com.amazonaws.elasticsearchservice#EBSOptionsStatus", + "EncryptionAtRestOptions": { + "target": "com.amazonaws.elasticsearchservice#EncryptionAtRestOptionsStatus", "traits": { - "smithy.api#documentation": "

Specifies the EBSOptions for the Elasticsearch domain.

" + "smithy.api#documentation": "

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

" } } }, @@ -2774,36 +2774,34 @@ "com.amazonaws.elasticsearchservice#ElasticsearchDomainStatus": { "type": "structure", "members": { - "NodeToNodeEncryptionOptions": { - "target": "com.amazonaws.elasticsearchservice#NodeToNodeEncryptionOptions", + "ServiceSoftwareOptions": { + "target": "com.amazonaws.elasticsearchservice#ServiceSoftwareOptions", "traits": { - "smithy.api#documentation": "

Specifies the status of the NodeToNodeEncryptionOptions.

" + "smithy.api#documentation": "

The current status of the Elasticsearch domain's service software.

" } }, - "DomainName": { - "target": "com.amazonaws.elasticsearchservice#DomainName", + "LogPublishingOptions": { + "target": "com.amazonaws.elasticsearchservice#LogPublishingOptions", "traits": { - "smithy.api#documentation": "

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

", - "smithy.api#required": {} + "smithy.api#documentation": "

Log publishing options for the given domain.

" } }, - "ElasticsearchClusterConfig": { - "target": "com.amazonaws.elasticsearchservice#ElasticsearchClusterConfig", + "NodeToNodeEncryptionOptions": { + "target": "com.amazonaws.elasticsearchservice#NodeToNodeEncryptionOptions", "traits": { - "smithy.api#documentation": "

The type and number of instances in the domain cluster.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the status of the NodeToNodeEncryptionOptions.

" } }, - "Created": { + "UpgradeProcessing": { "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { - "smithy.api#documentation": "

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

" + "smithy.api#documentation": "

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

" } }, - "DomainEndpointOptions": { - "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptions", + "Created": { + "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { - "smithy.api#documentation": "

The current status of the Elasticsearch domain's endpoint options.

" + "smithy.api#documentation": "

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

" } }, "SnapshotOptions": { @@ -2812,11 +2810,22 @@ "smithy.api#documentation": "

Specifies the status of the SnapshotOptions

" } }, - "ARN": { - "target": "com.amazonaws.elasticsearchservice#ARN", + "Endpoints": { + "target": "com.amazonaws.elasticsearchservice#EndpointsMap", "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

" + } + }, + "DomainEndpointOptions": { + "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptions", + "traits": { + "smithy.api#documentation": "

The current status of the Elasticsearch domain's endpoint options.

" + } + }, + "AdvancedOptions": { + "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", + "traits": { + "smithy.api#documentation": "

Specifies the status of the AdvancedOptions

" } }, "AccessPolicies": { @@ -2825,47 +2834,55 @@ "smithy.api#documentation": "

IAM access policy as a JSON-formatted string.

" } }, + "CognitoOptions": { + "target": "com.amazonaws.elasticsearchservice#CognitoOptions", + "traits": { + "smithy.api#documentation": "

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

" + } + }, "AdvancedSecurityOptions": { "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptions", "traits": { "smithy.api#documentation": "

The current status of the Elasticsearch domain's advanced security options.

" } }, - "AdvancedOptions": { - "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", + "DomainId": { + "target": "com.amazonaws.elasticsearchservice#DomainId", "traits": { - "smithy.api#documentation": "

Specifies the status of the AdvancedOptions

" + "smithy.api#documentation": "

The unique identifier for the specified Elasticsearch domain.

", + "smithy.api#required": {} } }, - "LogPublishingOptions": { - "target": "com.amazonaws.elasticsearchservice#LogPublishingOptions", + "ARN": { + "target": "com.amazonaws.elasticsearchservice#ARN", "traits": { - "smithy.api#documentation": "

Log publishing options for the given domain.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

", + "smithy.api#required": {} } }, - "Endpoint": { - "target": "com.amazonaws.elasticsearchservice#ServiceUrl", + "Processing": { + "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { - "smithy.api#documentation": "

The Elasticsearch domain endpoint that you use to submit index and search requests.

" + "smithy.api#documentation": "

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

" } }, - "DomainId": { - "target": "com.amazonaws.elasticsearchservice#DomainId", + "VPCOptions": { + "target": "com.amazonaws.elasticsearchservice#VPCDerivedInfo", "traits": { - "smithy.api#documentation": "

The unique identifier for the specified Elasticsearch domain.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" } }, - "Endpoints": { - "target": "com.amazonaws.elasticsearchservice#EndpointsMap", + "Endpoint": { + "target": "com.amazonaws.elasticsearchservice#ServiceUrl", "traits": { - "smithy.api#documentation": "

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

" + "smithy.api#documentation": "

The Elasticsearch domain endpoint that you use to submit index and search requests.

" } }, - "CognitoOptions": { - "target": "com.amazonaws.elasticsearchservice#CognitoOptions", + "ElasticsearchClusterConfig": { + "target": "com.amazonaws.elasticsearchservice#ElasticsearchClusterConfig", "traits": { - "smithy.api#documentation": "

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

" + "smithy.api#documentation": "

The type and number of instances in the domain cluster.

", + "smithy.api#required": {} } }, "Deleted": { @@ -2874,16 +2891,17 @@ "smithy.api#documentation": "

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

" } }, - "Processing": { - "target": "com.amazonaws.elasticsearchservice#Boolean", + "EBSOptions": { + "target": "com.amazonaws.elasticsearchservice#EBSOptions", "traits": { - "smithy.api#documentation": "

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

" + "smithy.api#documentation": "

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

" } }, - "UpgradeProcessing": { - "target": "com.amazonaws.elasticsearchservice#Boolean", + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", "traits": { - "smithy.api#documentation": "

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

" + "smithy.api#documentation": "

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

", + "smithy.api#required": {} } }, "EncryptionAtRestOptions": { @@ -2892,26 +2910,8 @@ "smithy.api#documentation": "

Specifies the status of the EncryptionAtRestOptions.

" } }, - "ServiceSoftwareOptions": { - "target": "com.amazonaws.elasticsearchservice#ServiceSoftwareOptions", - "traits": { - "smithy.api#documentation": "

The current status of the Elasticsearch domain's service software.

" - } - }, - "VPCOptions": { - "target": "com.amazonaws.elasticsearchservice#VPCDerivedInfo", - "traits": { - "smithy.api#documentation": "

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" - } - }, "ElasticsearchVersion": { "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionString" - }, - "EBSOptions": { - "target": "com.amazonaws.elasticsearchservice#EBSOptions", - "traits": { - "smithy.api#documentation": "

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

" - } } }, "traits": { @@ -2993,17 +2993,17 @@ "com.amazonaws.elasticsearchservice#EncryptionAtRestOptionsStatus": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#EncryptionAtRestOptions", "traits": { - "smithy.api#documentation": "

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

", "smithy.api#required": {} } }, - "Options": { - "target": "com.amazonaws.elasticsearchservice#EncryptionAtRestOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

", "smithy.api#required": {} } } @@ -3024,11 +3024,11 @@ "com.amazonaws.elasticsearchservice#ErrorDetails": { "type": "structure", "members": { - "ErrorType": { - "target": "com.amazonaws.elasticsearchservice#ErrorType" - }, "ErrorMessage": { "target": "com.amazonaws.elasticsearchservice#ErrorMessage" + }, + "ErrorType": { + "target": "com.amazonaws.elasticsearchservice#ErrorType" } } }, @@ -3041,17 +3041,17 @@ "com.amazonaws.elasticsearchservice#Filter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.elasticsearchservice#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n Specifies the name of the filter.\n

" - } - }, "Values": { "target": "com.amazonaws.elasticsearchservice#ValueStringList", "traits": { "smithy.api#documentation": "

\n Contains one or more values for the filter.\n

" } + }, + "Name": { + "target": "com.amazonaws.elasticsearchservice#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Specifies the name of the filter.\n

" + } } }, "traits": { @@ -3174,10 +3174,10 @@ "com.amazonaws.elasticsearchservice#GetUpgradeHistoryRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.elasticsearchservice#MaxResults", + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", "traits": { - "smithy.api#httpQuery": "maxResults" + "smithy.api#httpQuery": "nextToken" } }, "DomainName": { @@ -3187,10 +3187,10 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken", + "MaxResults": { + "target": "com.amazonaws.elasticsearchservice#MaxResults", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#httpQuery": "maxResults" } } }, @@ -3270,18 +3270,18 @@ "com.amazonaws.elasticsearchservice#GetUpgradeStatusResponse": { "type": "structure", "members": { - "UpgradeName": { - "target": "com.amazonaws.elasticsearchservice#UpgradeName", - "traits": { - "smithy.api#documentation": "

A string that describes the update briefly

" - } - }, "UpgradeStep": { "target": "com.amazonaws.elasticsearchservice#UpgradeStep", "traits": { "smithy.api#documentation": "

\n Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:\n

\n

" } }, + "UpgradeName": { + "target": "com.amazonaws.elasticsearchservice#UpgradeName", + "traits": { + "smithy.api#documentation": "

A string that describes the update briefly

" + } + }, "StepStatus": { "target": "com.amazonaws.elasticsearchservice#UpgradeStatus", "traits": { @@ -3306,28 +3306,28 @@ "com.amazonaws.elasticsearchservice#InboundCrossClusterSearchConnection": { "type": "structure", "members": { + "CrossClusterSearchConnectionId": { + "target": "com.amazonaws.elasticsearchservice#CrossClusterSearchConnectionId", + "traits": { + "smithy.api#documentation": "

Specifies the connection id for the inbound cross-cluster search connection.

" + } + }, "ConnectionStatus": { "target": "com.amazonaws.elasticsearchservice#InboundCrossClusterSearchConnectionStatus", "traits": { "smithy.api#documentation": "

Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

" } }, - "DestinationDomainInfo": { + "SourceDomainInfo": { "target": "com.amazonaws.elasticsearchservice#DomainInformation", "traits": { - "smithy.api#documentation": "

Specifies the DomainInformation for the destination Elasticsearch domain.

" - } - }, - "CrossClusterSearchConnectionId": { - "target": "com.amazonaws.elasticsearchservice#CrossClusterSearchConnectionId", - "traits": { - "smithy.api#documentation": "

Specifies the connection id for the inbound cross-cluster search connection.

" + "smithy.api#documentation": "

Specifies the DomainInformation for the source Elasticsearch domain.

" } }, - "SourceDomainInfo": { + "DestinationDomainInfo": { "target": "com.amazonaws.elasticsearchservice#DomainInformation", "traits": { - "smithy.api#documentation": "

Specifies the DomainInformation for the source Elasticsearch domain.

" + "smithy.api#documentation": "

Specifies the DomainInformation for the destination Elasticsearch domain.

" } } }, @@ -3338,17 +3338,17 @@ "com.amazonaws.elasticsearchservice#InboundCrossClusterSearchConnectionStatus": { "type": "structure", "members": { - "StatusCode": { - "target": "com.amazonaws.elasticsearchservice#InboundCrossClusterSearchConnectionStatusCode", - "traits": { - "smithy.api#documentation": "

The state code for inbound connection. This can be one of the following:

\n " - } - }, "Message": { "target": "com.amazonaws.elasticsearchservice#CrossClusterSearchConnectionStatusMessage", "traits": { "smithy.api#documentation": "

Specifies verbose information for the inbound connection status.

" } + }, + "StatusCode": { + "target": "com.amazonaws.elasticsearchservice#InboundCrossClusterSearchConnectionStatusCode", + "traits": { + "smithy.api#documentation": "

The state code for inbound connection. This can be one of the following:

\n " + } } }, "traits": { @@ -3544,14 +3544,14 @@ "smithy.api#documentation": "

StorageType represents the list of storage related types and attributes\n that are available for given InstanceType.\n

" } }, + "InstanceLimits": { + "target": "com.amazonaws.elasticsearchservice#InstanceLimits" + }, "AdditionalLimits": { "target": "com.amazonaws.elasticsearchservice#AdditionalLimitList", "traits": { "smithy.api#documentation": "

\n List of additional limits that are specific to a given InstanceType and for each of it's\n \n InstanceRole\n \n .\n

" } - }, - "InstanceLimits": { - "target": "com.amazonaws.elasticsearchservice#InstanceLimits" } }, "traits": { @@ -3648,8 +3648,16 @@ "com.amazonaws.elasticsearchservice#ListDomainsForPackageRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken", + "PackageID": { + "target": "com.amazonaws.elasticsearchservice#PackageID", + "traits": { + "smithy.api#documentation": "

The package for which to list domains.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", "traits": { "smithy.api#documentation": "

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

", "smithy.api#httpQuery": "nextToken" @@ -3661,14 +3669,6 @@ "smithy.api#documentation": "

Limits results to a maximum number of domains.

", "smithy.api#httpQuery": "maxResults" } - }, - "PackageID": { - "target": "com.amazonaws.elasticsearchservice#PackageID", - "traits": { - "smithy.api#documentation": "

The package for which to list domains.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -3678,14 +3678,14 @@ "com.amazonaws.elasticsearchservice#ListDomainsForPackageResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#String" - }, "DomainPackageDetailsList": { "target": "com.amazonaws.elasticsearchservice#DomainPackageDetailsList", "traits": { "smithy.api#documentation": "

List of DomainPackageDetails objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#String" } }, "traits": { @@ -3731,20 +3731,6 @@ "com.amazonaws.elasticsearchservice#ListElasticsearchInstanceTypesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken should be sent in case if earlier API call produced result\n containing NextToken. It is used for pagination.\n

", - "smithy.api#httpQuery": "nextToken" - } - }, - "DomainName": { - "target": "com.amazonaws.elasticsearchservice#DomainName", - "traits": { - "smithy.api#documentation": "

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are\n querying for list of available Elasticsearch instance types when modifying existing domain.\n

", - "smithy.api#httpQuery": "domainName" - } - }, "MaxResults": { "target": "com.amazonaws.elasticsearchservice#MaxResults", "traits": { @@ -3759,6 +3745,20 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", + "traits": { + "smithy.api#documentation": "

NextToken should be sent in case if earlier API call produced result\n containing NextToken. It is used for pagination.\n

", + "smithy.api#httpQuery": "nextToken" + } + }, + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", + "traits": { + "smithy.api#documentation": "

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are\n querying for list of available Elasticsearch instance types when modifying existing domain.\n

", + "smithy.api#httpQuery": "domainName" + } } }, "traits": { @@ -3768,17 +3768,17 @@ "com.amazonaws.elasticsearchservice#ListElasticsearchInstanceTypesResponse": { "type": "structure", "members": { - "ElasticsearchInstanceTypes": { - "target": "com.amazonaws.elasticsearchservice#ElasticsearchInstanceTypeList", - "traits": { - "smithy.api#documentation": "

\n List of instance types supported by Amazon Elasticsearch service for\n given\n \n ElasticsearchVersion\n \n

" - } - }, "NextToken": { "target": "com.amazonaws.elasticsearchservice#NextToken", "traits": { "smithy.api#documentation": "

In case if there are more results available NextToken would be\n present, make further request to the same API with\n received NextToken to paginate remaining results.\n

" } + }, + "ElasticsearchInstanceTypes": { + "target": "com.amazonaws.elasticsearchservice#ElasticsearchInstanceTypeList", + "traits": { + "smithy.api#documentation": "

\n List of instance types supported by Amazon Elasticsearch service for\n given\n \n ElasticsearchVersion\n \n

" + } } }, "traits": { @@ -3845,11 +3845,11 @@ "com.amazonaws.elasticsearchservice#ListElasticsearchVersionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#NextToken" - }, "ElasticsearchVersions": { "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionList" + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken" } }, "traits": { @@ -3898,6 +3898,13 @@ "com.amazonaws.elasticsearchservice#ListPackagesForDomainRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.elasticsearchservice#MaxResults", + "traits": { + "smithy.api#documentation": "

Limits results to a maximum number of packages.

", + "smithy.api#httpQuery": "maxResults" + } + }, "DomainName": { "target": "com.amazonaws.elasticsearchservice#DomainName", "traits": { @@ -3906,13 +3913,6 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.elasticsearchservice#MaxResults", - "traits": { - "smithy.api#documentation": "

Limits results to a maximum number of packages.

", - "smithy.api#httpQuery": "maxResults" - } - }, "NextToken": { "target": "com.amazonaws.elasticsearchservice#NextToken", "traits": { @@ -3928,17 +3928,17 @@ "com.amazonaws.elasticsearchservice#ListPackagesForDomainResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.elasticsearchservice#String", - "traits": { - "smithy.api#documentation": "

Pagination token that needs to be supplied to the next call to get the next page of results.

" - } - }, "DomainPackageDetailsList": { "target": "com.amazonaws.elasticsearchservice#DomainPackageDetailsList", "traits": { "smithy.api#documentation": "

List of DomainPackageDetails objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#String", + "traits": { + "smithy.api#documentation": "

Pagination token that needs to be supplied to the next call to get the next page of results.

" + } } }, "traits": { @@ -4055,7 +4055,7 @@ "com.amazonaws.elasticsearchservice#LogType": { "type": "string", "traits": { - "smithy.api#documentation": "

Type of Log File, it can be one of the following:\n

\n

", + "smithy.api#documentation": "

Type of Log File, it can be one of the following:\n

\n

", "smithy.api#enum": [ { "value": "INDEX_SLOW_LOGS" @@ -4065,6 +4065,9 @@ }, { "value": "ES_APPLICATION_LOGS" + }, + { + "value": "AUDIT_LOGS" } ] } @@ -4072,12 +4075,6 @@ "com.amazonaws.elasticsearchservice#MasterUserOptions": { "type": "structure", "members": { - "MasterUserPassword": { - "target": "com.amazonaws.elasticsearchservice#Password", - "traits": { - "smithy.api#documentation": "

The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.

" - } - }, "MasterUserARN": { "target": "com.amazonaws.elasticsearchservice#ARN", "traits": { @@ -4089,6 +4086,12 @@ "traits": { "smithy.api#documentation": "

The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.

" } + }, + "MasterUserPassword": { + "target": "com.amazonaws.elasticsearchservice#Password", + "traits": { + "smithy.api#documentation": "

The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.

" + } } }, "traits": { @@ -4139,17 +4142,17 @@ "com.amazonaws.elasticsearchservice#NodeToNodeEncryptionOptionsStatus": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.elasticsearchservice#NodeToNodeEncryptionOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#NodeToNodeEncryptionOptions", "traits": { - "smithy.api#documentation": "

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

", "smithy.api#required": {} } } @@ -4186,29 +4189,23 @@ "com.amazonaws.elasticsearchservice#OptionStatus": { "type": "structure", "members": { - "CreationDate": { - "target": "com.amazonaws.elasticsearchservice#UpdateTimestamp", + "State": { + "target": "com.amazonaws.elasticsearchservice#OptionState", "traits": { - "smithy.api#documentation": "

Timestamp which tells the creation date for the entity.

", + "smithy.api#documentation": "

Provides the OptionState for the Elasticsearch domain.

", "smithy.api#required": {} } }, - "PendingDeletion": { - "target": "com.amazonaws.elasticsearchservice#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the Elasticsearch domain is being deleted.

" - } - }, "UpdateVersion": { "target": "com.amazonaws.elasticsearchservice#UIntValue", "traits": { "smithy.api#documentation": "

Specifies the latest version for the entity.

" } }, - "State": { - "target": "com.amazonaws.elasticsearchservice#OptionState", + "CreationDate": { + "target": "com.amazonaws.elasticsearchservice#UpdateTimestamp", "traits": { - "smithy.api#documentation": "

Provides the OptionState for the Elasticsearch domain.

", + "smithy.api#documentation": "

Timestamp which tells the creation date for the entity.

", "smithy.api#required": {} } }, @@ -4218,6 +4215,12 @@ "smithy.api#documentation": "

Timestamp which tells the last updated time for the entity.

", "smithy.api#required": {} } + }, + "PendingDeletion": { + "target": "com.amazonaws.elasticsearchservice#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the Elasticsearch domain is being deleted.

" + } } }, "traits": { @@ -4227,16 +4230,16 @@ "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnection": { "type": "structure", "members": { - "CrossClusterSearchConnectionId": { - "target": "com.amazonaws.elasticsearchservice#CrossClusterSearchConnectionId", + "ConnectionStatus": { + "target": "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnectionStatus", "traits": { - "smithy.api#documentation": "

Specifies the connection id for the outbound cross-cluster search connection.

" + "smithy.api#documentation": "

Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

" } }, - "SourceDomainInfo": { + "DestinationDomainInfo": { "target": "com.amazonaws.elasticsearchservice#DomainInformation", "traits": { - "smithy.api#documentation": "

Specifies the DomainInformation for the source Elasticsearch domain.

" + "smithy.api#documentation": "

Specifies the DomainInformation for the destination Elasticsearch domain.

" } }, "ConnectionAlias": { @@ -4245,16 +4248,16 @@ "smithy.api#documentation": "

Specifies the connection alias for the outbound cross-cluster search connection.

" } }, - "ConnectionStatus": { - "target": "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnectionStatus", + "SourceDomainInfo": { + "target": "com.amazonaws.elasticsearchservice#DomainInformation", "traits": { - "smithy.api#documentation": "

Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

" + "smithy.api#documentation": "

Specifies the DomainInformation for the source Elasticsearch domain.

" } }, - "DestinationDomainInfo": { - "target": "com.amazonaws.elasticsearchservice#DomainInformation", + "CrossClusterSearchConnectionId": { + "target": "com.amazonaws.elasticsearchservice#CrossClusterSearchConnectionId", "traits": { - "smithy.api#documentation": "

Specifies the DomainInformation for the destination Elasticsearch domain.

" + "smithy.api#documentation": "

Specifies the connection id for the outbound cross-cluster search connection.

" } } }, @@ -4265,17 +4268,17 @@ "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnectionStatus": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.elasticsearchservice#CrossClusterSearchConnectionStatusMessage", - "traits": { - "smithy.api#documentation": "

Specifies verbose information for the outbound connection status.

" - } - }, "StatusCode": { "target": "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnectionStatusCode", "traits": { "smithy.api#documentation": "

The state code for outbound connection. This can be one of the following:

\n " } + }, + "Message": { + "target": "com.amazonaws.elasticsearchservice#CrossClusterSearchConnectionStatusMessage", + "traits": { + "smithy.api#documentation": "

Specifies verbose information for the outbound connection status.

" + } } }, "traits": { @@ -4348,28 +4351,22 @@ "com.amazonaws.elasticsearchservice#PackageDetails": { "type": "structure", "members": { - "PackageType": { - "target": "com.amazonaws.elasticsearchservice#PackageType", - "traits": { - "smithy.api#documentation": "

Currently supports only TXT-DICTIONARY.

" - } - }, - "ErrorDetails": { - "target": "com.amazonaws.elasticsearchservice#ErrorDetails", + "CreatedAt": { + "target": "com.amazonaws.elasticsearchservice#CreatedAt", "traits": { - "smithy.api#documentation": "

Additional information if the package is in an error state. Null otherwise.

" + "smithy.api#documentation": "

Timestamp which tells creation date of the package.

" } }, - "PackageName": { - "target": "com.amazonaws.elasticsearchservice#PackageName", + "PackageDescription": { + "target": "com.amazonaws.elasticsearchservice#PackageDescription", "traits": { - "smithy.api#documentation": "

User specified name of the package.

" + "smithy.api#documentation": "

User-specified description of the package.

" } }, - "CreatedAt": { - "target": "com.amazonaws.elasticsearchservice#CreatedAt", + "ErrorDetails": { + "target": "com.amazonaws.elasticsearchservice#ErrorDetails", "traits": { - "smithy.api#documentation": "

Timestamp which tells creation date of the package.

" + "smithy.api#documentation": "

Additional information if the package is in an error state. Null otherwise.

" } }, "PackageID": { @@ -4384,10 +4381,16 @@ "smithy.api#documentation": "

Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

" } }, - "PackageDescription": { - "target": "com.amazonaws.elasticsearchservice#PackageDescription", + "PackageType": { + "target": "com.amazonaws.elasticsearchservice#PackageType", "traits": { - "smithy.api#documentation": "

User-specified description of the package.

" + "smithy.api#documentation": "

Currently supports only TXT-DICTIONARY.

" + } + }, + "PackageName": { + "target": "com.amazonaws.elasticsearchservice#PackageName", + "traits": { + "smithy.api#documentation": "

User specified name of the package.

" } } }, @@ -4530,12 +4533,6 @@ "com.amazonaws.elasticsearchservice#PurchaseReservedElasticsearchInstanceOfferingRequest": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.elasticsearchservice#InstanceCount", - "traits": { - "smithy.api#documentation": "

The number of Elasticsearch instances to reserve.

" - } - }, "ReservedElasticsearchInstanceOfferingId": { "target": "com.amazonaws.elasticsearchservice#GUID", "traits": { @@ -4549,6 +4546,12 @@ "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

", "smithy.api#required": {} } + }, + "InstanceCount": { + "target": "com.amazonaws.elasticsearchservice#InstanceCount", + "traits": { + "smithy.api#documentation": "

The number of Elasticsearch instances to reserve.

" + } } }, "traits": { @@ -4578,17 +4581,17 @@ "com.amazonaws.elasticsearchservice#RecurringCharge": { "type": "structure", "members": { - "RecurringChargeFrequency": { - "target": "com.amazonaws.elasticsearchservice#String", - "traits": { - "smithy.api#documentation": "

The frequency of the recurring charge.

" - } - }, "RecurringChargeAmount": { "target": "com.amazonaws.elasticsearchservice#Double", "traits": { "smithy.api#documentation": "

The monetary amount of the recurring charge.

" } + }, + "RecurringChargeFrequency": { + "target": "com.amazonaws.elasticsearchservice#String", + "traits": { + "smithy.api#documentation": "

The frequency of the recurring charge.

" + } } }, "traits": { @@ -4724,16 +4727,16 @@ "com.amazonaws.elasticsearchservice#ReservedElasticsearchInstance": { "type": "structure", "members": { - "State": { + "CurrencyCode": { "target": "com.amazonaws.elasticsearchservice#String", "traits": { - "smithy.api#documentation": "

The state of the reserved Elasticsearch instance.

" + "smithy.api#documentation": "

The currency code for the reserved Elasticsearch instance offering.

" } }, - "ReservationName": { - "target": "com.amazonaws.elasticsearchservice#ReservationToken", + "FixedPrice": { + "target": "com.amazonaws.elasticsearchservice#Double", "traits": { - "smithy.api#documentation": "

The customer-specified identifier to track this reservation.

" + "smithy.api#documentation": "

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

" } }, "StartTime": { @@ -4742,16 +4745,22 @@ "smithy.api#documentation": "

The time the reservation started.

" } }, - "FixedPrice": { - "target": "com.amazonaws.elasticsearchservice#Double", + "Duration": { + "target": "com.amazonaws.elasticsearchservice#Integer", "traits": { - "smithy.api#documentation": "

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

" + "smithy.api#documentation": "

The duration, in seconds, for which the Elasticsearch instance is reserved.

" } }, - "CurrencyCode": { + "ReservedElasticsearchInstanceOfferingId": { "target": "com.amazonaws.elasticsearchservice#String", "traits": { - "smithy.api#documentation": "

The currency code for the reserved Elasticsearch instance offering.

" + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "PaymentOption": { + "target": "com.amazonaws.elasticsearchservice#ReservedElasticsearchInstancePaymentOption", + "traits": { + "smithy.api#documentation": "

The payment option as defined in the reserved Elasticsearch instance offering.

" } }, "ReservedElasticsearchInstanceId": { @@ -4760,22 +4769,22 @@ "smithy.api#documentation": "

The unique identifier for the reservation.

" } }, - "UsagePrice": { - "target": "com.amazonaws.elasticsearchservice#Double", + "State": { + "target": "com.amazonaws.elasticsearchservice#String", "traits": { - "smithy.api#documentation": "

The rate you are charged for each hour for the domain that is using this reserved instance.

" + "smithy.api#documentation": "

The state of the reserved Elasticsearch instance.

" } }, - "Duration": { - "target": "com.amazonaws.elasticsearchservice#Integer", + "UsagePrice": { + "target": "com.amazonaws.elasticsearchservice#Double", "traits": { - "smithy.api#documentation": "

The duration, in seconds, for which the Elasticsearch instance is reserved.

" + "smithy.api#documentation": "

The rate you are charged for each hour for the domain that is using this reserved instance.

" } }, - "PaymentOption": { - "target": "com.amazonaws.elasticsearchservice#ReservedElasticsearchInstancePaymentOption", + "ReservationName": { + "target": "com.amazonaws.elasticsearchservice#ReservationToken", "traits": { - "smithy.api#documentation": "

The payment option as defined in the reserved Elasticsearch instance offering.

" + "smithy.api#documentation": "

The customer-specified identifier to track this reservation.

" } }, "RecurringCharges": { @@ -4784,10 +4793,10 @@ "smithy.api#documentation": "

The charge to your account regardless of whether you are creating any domains using the instance offering.

" } }, - "ReservedElasticsearchInstanceOfferingId": { - "target": "com.amazonaws.elasticsearchservice#String", + "ElasticsearchInstanceCount": { + "target": "com.amazonaws.elasticsearchservice#Integer", "traits": { - "smithy.api#documentation": "

The offering identifier.

" + "smithy.api#documentation": "

The number of Elasticsearch instances that have been reserved.

" } }, "ElasticsearchInstanceType": { @@ -4795,12 +4804,6 @@ "traits": { "smithy.api#documentation": "

The Elasticsearch instance type offered by the reserved instance offering.

" } - }, - "ElasticsearchInstanceCount": { - "target": "com.amazonaws.elasticsearchservice#Integer", - "traits": { - "smithy.api#documentation": "

The number of Elasticsearch instances that have been reserved.

" - } } }, "traits": { @@ -4816,22 +4819,22 @@ "com.amazonaws.elasticsearchservice#ReservedElasticsearchInstanceOffering": { "type": "structure", "members": { - "PaymentOption": { - "target": "com.amazonaws.elasticsearchservice#ReservedElasticsearchInstancePaymentOption", + "CurrencyCode": { + "target": "com.amazonaws.elasticsearchservice#String", "traits": { - "smithy.api#documentation": "

Payment option for the reserved Elasticsearch instance offering

" + "smithy.api#documentation": "

The currency code for the reserved Elasticsearch instance offering.

" } }, - "RecurringCharges": { - "target": "com.amazonaws.elasticsearchservice#RecurringChargeList", + "UsagePrice": { + "target": "com.amazonaws.elasticsearchservice#Double", "traits": { - "smithy.api#documentation": "

The charge to your account regardless of whether you are creating any domains using the instance offering.

" + "smithy.api#documentation": "

The rate you are charged for each hour the domain that is using the offering is running.

" } }, - "ReservedElasticsearchInstanceOfferingId": { - "target": "com.amazonaws.elasticsearchservice#GUID", + "ElasticsearchInstanceType": { + "target": "com.amazonaws.elasticsearchservice#ESPartitionInstanceType", "traits": { - "smithy.api#documentation": "

The Elasticsearch reserved instance offering identifier.

" + "smithy.api#documentation": "

The Elasticsearch instance type offered by the reserved instance offering.

" } }, "Duration": { @@ -4840,28 +4843,28 @@ "smithy.api#documentation": "

The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

" } }, - "FixedPrice": { - "target": "com.amazonaws.elasticsearchservice#Double", + "PaymentOption": { + "target": "com.amazonaws.elasticsearchservice#ReservedElasticsearchInstancePaymentOption", "traits": { - "smithy.api#documentation": "

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

" + "smithy.api#documentation": "

Payment option for the reserved Elasticsearch instance offering

" } }, - "CurrencyCode": { - "target": "com.amazonaws.elasticsearchservice#String", + "FixedPrice": { + "target": "com.amazonaws.elasticsearchservice#Double", "traits": { - "smithy.api#documentation": "

The currency code for the reserved Elasticsearch instance offering.

" + "smithy.api#documentation": "

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

" } }, - "UsagePrice": { - "target": "com.amazonaws.elasticsearchservice#Double", + "ReservedElasticsearchInstanceOfferingId": { + "target": "com.amazonaws.elasticsearchservice#GUID", "traits": { - "smithy.api#documentation": "

The rate you are charged for each hour the domain that is using the offering is running.

" + "smithy.api#documentation": "

The Elasticsearch reserved instance offering identifier.

" } }, - "ElasticsearchInstanceType": { - "target": "com.amazonaws.elasticsearchservice#ESPartitionInstanceType", + "RecurringCharges": { + "target": "com.amazonaws.elasticsearchservice#RecurringChargeList", "traits": { - "smithy.api#documentation": "

The Elasticsearch instance type offered by the reserved instance offering.

" + "smithy.api#documentation": "

The charge to your account regardless of whether you are creating any domains using the instance offering.

" } } }, @@ -4950,10 +4953,16 @@ "com.amazonaws.elasticsearchservice#ServiceSoftwareOptions": { "type": "structure", "members": { - "UpdateAvailable": { - "target": "com.amazonaws.elasticsearchservice#Boolean", + "CurrentVersion": { + "target": "com.amazonaws.elasticsearchservice#String", "traits": { - "smithy.api#documentation": "

True if you are able to update you service software version. False if you are not able to update your service software version.

" + "smithy.api#documentation": "

The current service software version that is present on the domain.

" + } + }, + "AutomatedUpdateDate": { + "target": "com.amazonaws.elasticsearchservice#DeploymentCloseDateTimeStamp", + "traits": { + "smithy.api#documentation": "

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

" } }, "Cancellable": { @@ -4968,16 +4977,16 @@ "smithy.api#documentation": "

The new service software version if one is available.

" } }, - "UpdateStatus": { - "target": "com.amazonaws.elasticsearchservice#DeploymentStatus", + "Description": { + "target": "com.amazonaws.elasticsearchservice#String", "traits": { - "smithy.api#documentation": "

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

" + "smithy.api#documentation": "

The description of the UpdateStatus.

" } }, - "AutomatedUpdateDate": { - "target": "com.amazonaws.elasticsearchservice#DeploymentCloseDateTimeStamp", + "UpdateStatus": { + "target": "com.amazonaws.elasticsearchservice#DeploymentStatus", "traits": { - "smithy.api#documentation": "

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

" + "smithy.api#documentation": "

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

" } }, "OptionalDeployment": { @@ -4986,16 +4995,10 @@ "smithy.api#documentation": "

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

" } }, - "CurrentVersion": { - "target": "com.amazonaws.elasticsearchservice#String", - "traits": { - "smithy.api#documentation": "

The current service software version that is present on the domain.

" - } - }, - "Description": { - "target": "com.amazonaws.elasticsearchservice#String", + "UpdateAvailable": { + "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { - "smithy.api#documentation": "

The description of the UpdateStatus.

" + "smithy.api#documentation": "

True if you are able to update you service software version. False if you are not able to update your service software version.

" } } }, @@ -5026,17 +5029,17 @@ "com.amazonaws.elasticsearchservice#SnapshotOptionsStatus": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.elasticsearchservice#OptionStatus", + "Options": { + "target": "com.amazonaws.elasticsearchservice#SnapshotOptions", "traits": { - "smithy.api#documentation": "

Specifies the status of a daily automated snapshot.

", + "smithy.api#documentation": "

Specifies the daily snapshot options specified for the Elasticsearch domain.

", "smithy.api#required": {} } }, - "Options": { - "target": "com.amazonaws.elasticsearchservice#SnapshotOptions", + "Status": { + "target": "com.amazonaws.elasticsearchservice#OptionStatus", "traits": { - "smithy.api#documentation": "

Specifies the daily snapshot options specified for the Elasticsearch domain.

", + "smithy.api#documentation": "

Specifies the status of a daily automated snapshot.

", "smithy.api#required": {} } } @@ -5117,17 +5120,17 @@ "com.amazonaws.elasticsearchservice#StorageType": { "type": "structure", "members": { - "StorageSubTypeName": { - "target": "com.amazonaws.elasticsearchservice#StorageSubTypeName" - }, - "StorageTypeName": { - "target": "com.amazonaws.elasticsearchservice#StorageTypeName" - }, "StorageTypeLimits": { "target": "com.amazonaws.elasticsearchservice#StorageTypeLimitList", "traits": { "smithy.api#documentation": "

List of limits that are applicable for given storage type.\n

" } + }, + "StorageSubTypeName": { + "target": "com.amazonaws.elasticsearchservice#StorageSubTypeName" + }, + "StorageTypeName": { + "target": "com.amazonaws.elasticsearchservice#StorageTypeName" } }, "traits": { @@ -5199,17 +5202,17 @@ "com.amazonaws.elasticsearchservice#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.elasticsearchservice#TagKey", + "Value": { + "target": "com.amazonaws.elasticsearchservice#TagValue", "traits": { - "smithy.api#documentation": "

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

", + "smithy.api#documentation": "

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value\n pair in a tag set of project : Trinity and cost-center : Trinity

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.elasticsearchservice#TagValue", + "Key": { + "target": "com.amazonaws.elasticsearchservice#TagKey", "traits": { - "smithy.api#documentation": "

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value\n pair in a tag set of project : Trinity and cost-center : Trinity

", + "smithy.api#documentation": "

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

", "smithy.api#required": {} } } @@ -5295,72 +5298,72 @@ "com.amazonaws.elasticsearchservice#UpdateElasticsearchDomainConfigRequest": { "type": "structure", "members": { - "AdvancedSecurityOptions": { - "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptionsInput", + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", "traits": { - "smithy.api#documentation": "

Specifies advanced security options.

" + "smithy.api#documentation": "

The name of the Elasticsearch domain that you are updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AccessPolicies": { - "target": "com.amazonaws.elasticsearchservice#PolicyDocument", + "CognitoOptions": { + "target": "com.amazonaws.elasticsearchservice#CognitoOptions", "traits": { - "smithy.api#documentation": "

IAM access policy as a JSON-formatted string.

" + "smithy.api#documentation": "

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

" } }, - "DomainEndpointOptions": { - "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptions", + "AdvancedOptions": { + "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", "traits": { - "smithy.api#documentation": "

Options to specify configuration that will be applied to the domain endpoint.

" + "smithy.api#documentation": "

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true.\n See Configuration Advanced Options for more information.

" } }, - "VPCOptions": { - "target": "com.amazonaws.elasticsearchservice#VPCOptions", + "EBSOptions": { + "target": "com.amazonaws.elasticsearchservice#EBSOptions", "traits": { - "smithy.api#documentation": "

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

" + "smithy.api#documentation": "

Specify the type and size of the EBS volume that you want to use.

" } }, - "ElasticsearchClusterConfig": { - "target": "com.amazonaws.elasticsearchservice#ElasticsearchClusterConfig", + "LogPublishingOptions": { + "target": "com.amazonaws.elasticsearchservice#LogPublishingOptions", "traits": { - "smithy.api#documentation": "

The type and number of instances to instantiate for the domain cluster.

" + "smithy.api#documentation": "

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

" } }, - "DomainName": { - "target": "com.amazonaws.elasticsearchservice#DomainName", + "AccessPolicies": { + "target": "com.amazonaws.elasticsearchservice#PolicyDocument", "traits": { - "smithy.api#documentation": "

The name of the Elasticsearch domain that you are updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

IAM access policy as a JSON-formatted string.

" } }, - "SnapshotOptions": { - "target": "com.amazonaws.elasticsearchservice#SnapshotOptions", + "VPCOptions": { + "target": "com.amazonaws.elasticsearchservice#VPCOptions", "traits": { - "smithy.api#documentation": "

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

" + "smithy.api#documentation": "

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

" } }, - "CognitoOptions": { - "target": "com.amazonaws.elasticsearchservice#CognitoOptions", + "AdvancedSecurityOptions": { + "target": "com.amazonaws.elasticsearchservice#AdvancedSecurityOptionsInput", "traits": { - "smithy.api#documentation": "

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

" + "smithy.api#documentation": "

Specifies advanced security options.

" } }, - "LogPublishingOptions": { - "target": "com.amazonaws.elasticsearchservice#LogPublishingOptions", + "ElasticsearchClusterConfig": { + "target": "com.amazonaws.elasticsearchservice#ElasticsearchClusterConfig", "traits": { - "smithy.api#documentation": "

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

" + "smithy.api#documentation": "

The type and number of instances to instantiate for the domain cluster.

" } }, - "AdvancedOptions": { - "target": "com.amazonaws.elasticsearchservice#AdvancedOptions", + "DomainEndpointOptions": { + "target": "com.amazonaws.elasticsearchservice#DomainEndpointOptions", "traits": { - "smithy.api#documentation": "

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true.\n See Configuration Advanced Options for more information.

" + "smithy.api#documentation": "

Options to specify configuration that will be applied to the domain endpoint.

" } }, - "EBSOptions": { - "target": "com.amazonaws.elasticsearchservice#EBSOptions", + "SnapshotOptions": { + "target": "com.amazonaws.elasticsearchservice#SnapshotOptions", "traits": { - "smithy.api#documentation": "

Specify the type and size of the EBS volume that you want to use.

" + "smithy.api#documentation": "

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

" } } }, @@ -5426,6 +5429,12 @@ "com.amazonaws.elasticsearchservice#UpgradeElasticsearchDomainRequest": { "type": "structure", "members": { + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", + "traits": { + "smithy.api#required": {} + } + }, "PerformCheckOnly": { "target": "com.amazonaws.elasticsearchservice#Boolean", "traits": { @@ -5438,12 +5447,6 @@ "smithy.api#documentation": "

The version of Elasticsearch that you intend to upgrade the domain to.

", "smithy.api#required": {} } - }, - "DomainName": { - "target": "com.amazonaws.elasticsearchservice#DomainName", - "traits": { - "smithy.api#required": {} - } } }, "traits": { @@ -5453,18 +5456,18 @@ "com.amazonaws.elasticsearchservice#UpgradeElasticsearchDomainResponse": { "type": "structure", "members": { - "PerformCheckOnly": { - "target": "com.amazonaws.elasticsearchservice#Boolean", - "traits": { - "smithy.api#documentation": "

\n This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed.\n This will not actually perform the Upgrade.\n

" - } - }, "TargetVersion": { "target": "com.amazonaws.elasticsearchservice#ElasticsearchVersionString", "traits": { "smithy.api#documentation": "

The version of Elasticsearch that you intend to upgrade the domain to.

" } }, + "PerformCheckOnly": { + "target": "com.amazonaws.elasticsearchservice#Boolean", + "traits": { + "smithy.api#documentation": "

\n This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed.\n This will not actually perform the Upgrade.\n

" + } + }, "DomainName": { "target": "com.amazonaws.elasticsearchservice#DomainName" } @@ -5482,6 +5485,12 @@ "smithy.api#documentation": "

\n A list of\n \n UpgradeStepItem\n \n s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.\n

" } }, + "StartTimestamp": { + "target": "com.amazonaws.elasticsearchservice#StartTimestamp", + "traits": { + "smithy.api#documentation": "

UTC Timestamp at which the Upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.

" + } + }, "UpgradeStatus": { "target": "com.amazonaws.elasticsearchservice#UpgradeStatus", "traits": { @@ -5493,12 +5502,6 @@ "traits": { "smithy.api#documentation": "

A string that describes the update briefly

" } - }, - "StartTimestamp": { - "target": "com.amazonaws.elasticsearchservice#StartTimestamp", - "traits": { - "smithy.api#documentation": "

UTC Timestamp at which the Upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.

" - } } }, "traits": { @@ -5552,16 +5555,10 @@ "com.amazonaws.elasticsearchservice#UpgradeStepItem": { "type": "structure", "members": { - "UpgradeStepStatus": { - "target": "com.amazonaws.elasticsearchservice#UpgradeStatus", - "traits": { - "smithy.api#documentation": "

\n The status of a particular step during an upgrade. The status can take one of the following values:\n

\n

" - } - }, - "Issues": { - "target": "com.amazonaws.elasticsearchservice#Issues", + "UpgradeStep": { + "target": "com.amazonaws.elasticsearchservice#UpgradeStep", "traits": { - "smithy.api#documentation": "

A list of strings containing detailed information about the errors encountered in a particular step.

" + "smithy.api#documentation": "

\n Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:\n

\n

" } }, "ProgressPercent": { @@ -5570,10 +5567,16 @@ "smithy.api#documentation": "

The Floating point value representing progress percentage of a particular step.

" } }, - "UpgradeStep": { - "target": "com.amazonaws.elasticsearchservice#UpgradeStep", + "UpgradeStepStatus": { + "target": "com.amazonaws.elasticsearchservice#UpgradeStatus", "traits": { - "smithy.api#documentation": "

\n Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:\n

\n

" + "smithy.api#documentation": "

\n The status of a particular step during an upgrade. The status can take one of the following values:\n

\n

" + } + }, + "Issues": { + "target": "com.amazonaws.elasticsearchservice#Issues", + "traits": { + "smithy.api#documentation": "

A list of strings containing detailed information about the errors encountered in a particular step.

" } } }, @@ -5609,12 +5612,6 @@ "com.amazonaws.elasticsearchservice#VPCDerivedInfo": { "type": "structure", "members": { - "VPCId": { - "target": "com.amazonaws.elasticsearchservice#String", - "traits": { - "smithy.api#documentation": "

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

" - } - }, "AvailabilityZones": { "target": "com.amazonaws.elasticsearchservice#StringList", "traits": { @@ -5632,6 +5629,12 @@ "traits": { "smithy.api#documentation": "

Specifies the subnets for VPC endpoint.

" } + }, + "VPCId": { + "target": "com.amazonaws.elasticsearchservice#String", + "traits": { + "smithy.api#documentation": "

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

" + } } }, "traits": { 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 f979d4ae2d97..1a47bb9b1b26 100644 --- a/codegen/sdk-codegen/aws-models/emr.2009-03-31.json +++ b/codegen/sdk-codegen/aws-models/emr.2009-03-31.json @@ -75,17 +75,17 @@ "com.amazonaws.emr#AddInstanceFleetInput": { "type": "structure", "members": { - "InstanceFleet": { - "target": "com.amazonaws.emr#InstanceFleetConfig", + "ClusterId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Specifies the configuration of the instance fleet.

", + "smithy.api#documentation": "

The unique identifier of the cluster.

", "smithy.api#required": {} } }, - "ClusterId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "InstanceFleet": { + "target": "com.amazonaws.emr#InstanceFleetConfig", "traits": { - "smithy.api#documentation": "

The unique identifier of the cluster.

", + "smithy.api#documentation": "

Specifies the configuration of the instance fleet.

", "smithy.api#required": {} } } @@ -372,6 +372,12 @@ "com.amazonaws.emr#AutoScalingPolicyDescription": { "type": "structure", "members": { + "Constraints": { + "target": "com.amazonaws.emr#ScalingConstraints", + "traits": { + "smithy.api#documentation": "

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

" + } + }, "Status": { "target": "com.amazonaws.emr#AutoScalingPolicyStatus", "traits": { @@ -383,12 +389,6 @@ "traits": { "smithy.api#documentation": "

The scale-in and scale-out rules that comprise the automatic scaling policy.

" } - }, - "Constraints": { - "target": "com.amazonaws.emr#ScalingConstraints", - "traits": { - "smithy.api#documentation": "

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

" - } } }, "traits": { @@ -429,17 +429,17 @@ "com.amazonaws.emr#AutoScalingPolicyStateChangeReason": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.emr#AutoScalingPolicyStateChangeReasonCode", - "traits": { - "smithy.api#documentation": "

The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.

" - } - }, "Message": { "target": "com.amazonaws.emr#String", "traits": { "smithy.api#documentation": "

A friendly, more verbose message that accompanies an automatic scaling policy state change.

" } + }, + "Code": { + "target": "com.amazonaws.emr#AutoScalingPolicyStateChangeReasonCode", + "traits": { + "smithy.api#documentation": "

The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.

" + } } }, "traits": { @@ -488,12 +488,6 @@ "com.amazonaws.emr#BlockPublicAccessConfiguration": { "type": "structure", "members": { - "Properties": { - "target": "com.amazonaws.emr#StringMap", - "traits": { - "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" - } - }, "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { @@ -507,6 +501,12 @@ "smithy.api#required": {} } }, + "Properties": { + "target": "com.amazonaws.emr#StringMap", + "traits": { + "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" + } + }, "PermittedPublicSecurityGroupRuleRanges": { "target": "com.amazonaws.emr#PortRanges", "traits": { @@ -558,17 +558,17 @@ "com.amazonaws.emr#BootstrapActionConfig": { "type": "structure", "members": { - "ScriptBootstrapAction": { - "target": "com.amazonaws.emr#ScriptBootstrapActionConfig", + "Name": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The script run by the bootstrap action.

", + "smithy.api#documentation": "

The name of the bootstrap action.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "ScriptBootstrapAction": { + "target": "com.amazonaws.emr#ScriptBootstrapActionConfig", "traits": { - "smithy.api#documentation": "

The name of the bootstrap action.

", + "smithy.api#documentation": "

The script run by the bootstrap action.

", "smithy.api#required": {} } } @@ -626,18 +626,18 @@ "com.amazonaws.emr#CancelStepsInfo": { "type": "structure", "members": { - "StepId": { - "target": "com.amazonaws.emr#StepId", - "traits": { - "smithy.api#documentation": "

The encrypted StepId of a step.

" - } - }, "Status": { "target": "com.amazonaws.emr#CancelStepsRequestStatus", "traits": { "smithy.api#documentation": "

The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.

" } }, + "StepId": { + "target": "com.amazonaws.emr#StepId", + "traits": { + "smithy.api#documentation": "

The encrypted StepId of a step.

" + } + }, "Reason": { "target": "com.amazonaws.emr#String", "traits": { @@ -658,17 +658,17 @@ "com.amazonaws.emr#CancelStepsInput": { "type": "structure", "members": { - "ClusterId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "StepIds": { + "target": "com.amazonaws.emr#StepIdsList", "traits": { - "smithy.api#documentation": "

The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

", + "smithy.api#documentation": "

The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

", "smithy.api#required": {} } }, - "StepIds": { - "target": "com.amazonaws.emr#StepIdsList", + "ClusterId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

", + "smithy.api#documentation": "

The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

", "smithy.api#required": {} } }, @@ -715,11 +715,10 @@ "com.amazonaws.emr#CloudWatchAlarmDefinition": { "type": "structure", "members": { - "Period": { - "target": "com.amazonaws.emr#Integer", + "Namespace": { + "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

" } }, "Threshold": { @@ -729,22 +728,17 @@ "smithy.api#required": {} } }, - "EvaluationPeriods": { - "target": "com.amazonaws.emr#Integer", - "traits": { - "smithy.api#documentation": "

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

" - } - }, - "Dimensions": { - "target": "com.amazonaws.emr#MetricDimensionList", + "Unit": { + "target": "com.amazonaws.emr#Unit", "traits": { - "smithy.api#documentation": "

A CloudWatch metric dimension.

" + "smithy.api#documentation": "

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

" } }, - "Namespace": { - "target": "com.amazonaws.emr#String", + "Period": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

" + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

", + "smithy.api#required": {} } }, "ComparisonOperator": { @@ -754,12 +748,6 @@ "smithy.api#required": {} } }, - "Unit": { - "target": "com.amazonaws.emr#Unit", - "traits": { - "smithy.api#documentation": "

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

" - } - }, "MetricName": { "target": "com.amazonaws.emr#String", "traits": { @@ -772,6 +760,18 @@ "traits": { "smithy.api#documentation": "

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

" } + }, + "Dimensions": { + "target": "com.amazonaws.emr#MetricDimensionList", + "traits": { + "smithy.api#documentation": "

A CloudWatch metric dimension.

" + } + }, + "EvaluationPeriods": { + "target": "com.amazonaws.emr#Integer", + "traits": { + "smithy.api#documentation": "

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

" + } } }, "traits": { @@ -781,28 +781,16 @@ "com.amazonaws.emr#Cluster": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.emr#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags associated with a cluster.

" - } - }, - "OutpostArn": { - "target": "com.amazonaws.emr#OptionalArnType", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.\n

" - } - }, - "Configurations": { - "target": "com.amazonaws.emr#ConfigurationList", + "InstanceCollectionType": { + "target": "com.amazonaws.emr#InstanceCollectionType", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

" + "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

\n \n

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

" } }, - "Status": { - "target": "com.amazonaws.emr#ClusterStatus", + "ReleaseLabel": { + "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The current status details about the cluster.

" + "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

" } }, "ClusterArn": { @@ -811,28 +799,34 @@ "smithy.api#documentation": "

The Amazon Resource Name of the cluster.

" } }, - "LogEncryptionKmsKeyId": { + "Ec2InstanceAttributes": { + "target": "com.amazonaws.emr#Ec2InstanceAttributes", + "traits": { + "smithy.api#documentation": "

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

" + } + }, + "Name": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The AWS KMS customer master key (CMK) used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" + "smithy.api#documentation": "

The name of the cluster.

" } }, - "KerberosAttributes": { - "target": "com.amazonaws.emr#KerberosAttributes", + "EbsRootVolumeSize": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

" + "smithy.api#documentation": "

The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

" } }, - "Ec2InstanceAttributes": { - "target": "com.amazonaws.emr#Ec2InstanceAttributes", + "RunningAmiVersion": { + "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

" + "smithy.api#documentation": "

The AMI version running on this cluster.

" } }, - "AutoTerminate": { - "target": "com.amazonaws.emr#Boolean", + "PlacementGroups": { + "target": "com.amazonaws.emr#PlacementGroupConfigList", "traits": { - "smithy.api#documentation": "

Specifies whether the cluster should terminate after completing all steps.

" + "smithy.api#documentation": "

Placement group configured for an Amazon EMR cluster.

" } }, "TerminationProtected": { @@ -841,22 +835,22 @@ "smithy.api#documentation": "

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

" } }, - "Name": { - "target": "com.amazonaws.emr#String", - "traits": { - "smithy.api#documentation": "

The name of the cluster.

" - } - }, "ScaleDownBehavior": { "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, - "VisibleToAllUsers": { - "target": "com.amazonaws.emr#Boolean", + "Tags": { + "target": "com.amazonaws.emr#TagList", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.

" + "smithy.api#documentation": "

A list of tags associated with a cluster.

" + } + }, + "OutpostArn": { + "target": "com.amazonaws.emr#OptionalArnType", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.\n

" } }, "LogUri": { @@ -871,40 +865,28 @@ "smithy.api#documentation": "

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" } }, - "SecurityConfiguration": { - "target": "com.amazonaws.emr#XmlString", - "traits": { - "smithy.api#documentation": "

The name of the security configuration applied to the cluster.

" - } - }, - "RepoUpgradeOnBoot": { - "target": "com.amazonaws.emr#RepoUpgradeOnBoot", - "traits": { - "smithy.api#documentation": "

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

" - } - }, - "ReleaseLabel": { + "RequestedAmiVersion": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

" + "smithy.api#documentation": "

The AMI version requested for this cluster.

" } }, - "Id": { - "target": "com.amazonaws.emr#ClusterId", + "Configurations": { + "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "

The unique identifier for the cluster.

" + "smithy.api#documentation": "

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

" } }, - "RequestedAmiVersion": { + "LogEncryptionKmsKeyId": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The AMI version requested for this cluster.

" + "smithy.api#documentation": "

The AWS KMS customer master key (CMK) used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" } }, - "InstanceCollectionType": { - "target": "com.amazonaws.emr#InstanceCollectionType", + "KerberosAttributes": { + "target": "com.amazonaws.emr#KerberosAttributes", "traits": { - "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

\n \n

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

" + "smithy.api#documentation": "

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

" } }, "MasterPublicDnsName": { @@ -913,34 +895,28 @@ "smithy.api#documentation": "

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

" } }, - "CustomAmiId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "Status": { + "target": "com.amazonaws.emr#ClusterStatus", "traits": { - "smithy.api#documentation": "

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

" + "smithy.api#documentation": "

The current status details about the cluster.

" } }, - "AutoScalingRole": { - "target": "com.amazonaws.emr#XmlString", + "CustomAmiId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" + "smithy.api#documentation": "

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

" } }, - "StepConcurrencyLevel": { + "NormalizedInstanceHours": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

Specifies the number of steps that can be executed concurrently.

" - } - }, - "RunningAmiVersion": { - "target": "com.amazonaws.emr#String", - "traits": { - "smithy.api#documentation": "

The AMI version running on this cluster.

" + "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" } }, - "NormalizedInstanceHours": { - "target": "com.amazonaws.emr#Integer", + "AutoTerminate": { + "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" + "smithy.api#documentation": "

Specifies whether the cluster should terminate after completing all steps.

" } }, "Applications": { @@ -949,10 +925,40 @@ "smithy.api#documentation": "

The applications installed on this cluster.

" } }, - "EbsRootVolumeSize": { + "VisibleToAllUsers": { + "target": "com.amazonaws.emr#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.

" + } + }, + "SecurityConfiguration": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The name of the security configuration applied to the cluster.

" + } + }, + "StepConcurrencyLevel": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

" + "smithy.api#documentation": "

Specifies the number of steps that can be executed concurrently.

" + } + }, + "RepoUpgradeOnBoot": { + "target": "com.amazonaws.emr#RepoUpgradeOnBoot", + "traits": { + "smithy.api#documentation": "

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

" + } + }, + "AutoScalingRole": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" + } + }, + "Id": { + "target": "com.amazonaws.emr#ClusterId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the cluster.

" } } }, @@ -1001,17 +1007,17 @@ "com.amazonaws.emr#ClusterStateChangeReason": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.emr#ClusterStateChangeReasonCode", - "traits": { - "smithy.api#documentation": "

The programmatic code for the state change reason.

" - } - }, "Message": { "target": "com.amazonaws.emr#String", "traits": { "smithy.api#documentation": "

The descriptive message for the state change reason.

" } + }, + "Code": { + "target": "com.amazonaws.emr#ClusterStateChangeReasonCode", + "traits": { + "smithy.api#documentation": "

The programmatic code for the state change reason.

" + } } }, "traits": { @@ -1092,16 +1098,10 @@ "com.amazonaws.emr#ClusterSummary": { "type": "structure", "members": { - "NormalizedInstanceHours": { - "target": "com.amazonaws.emr#Integer", - "traits": { - "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" - } - }, - "Name": { - "target": "com.amazonaws.emr#String", + "ClusterArn": { + "target": "com.amazonaws.emr#ArnType", "traits": { - "smithy.api#documentation": "

The name of the cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name of the cluster.

" } }, "Id": { @@ -1110,12 +1110,6 @@ "smithy.api#documentation": "

The unique identifier for the cluster.

" } }, - "ClusterArn": { - "target": "com.amazonaws.emr#ArnType", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the cluster.

" - } - }, "OutpostArn": { "target": "com.amazonaws.emr#OptionalArnType", "traits": { @@ -1127,6 +1121,18 @@ "traits": { "smithy.api#documentation": "

The details about the current status of the cluster.

" } + }, + "Name": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster.

" + } + }, + "NormalizedInstanceHours": { + "target": "com.amazonaws.emr#Integer", + "traits": { + "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" + } } }, "traits": { @@ -1148,16 +1154,16 @@ "smithy.api#documentation": "

The date and time when the cluster was ready to execute steps.

" } }, - "EndDateTime": { + "CreationDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The date and time when the cluster was terminated.

" + "smithy.api#documentation": "

The creation date and time of the cluster.

" } }, - "CreationDateTime": { + "EndDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The creation date and time of the cluster.

" + "smithy.api#documentation": "

The date and time when the cluster was terminated.

" } } }, @@ -1230,16 +1236,16 @@ "smithy.api#required": {} } }, - "MaximumCoreCapacityUnits": { + "MaximumOnDemandCapacityUnits": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

\n The upper boundary of EC2 units for core node type in a cluster. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes.\n

" + "smithy.api#documentation": "

\n The upper boundary of On-Demand EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot instances.\n

" } }, - "MaximumOnDemandCapacityUnits": { + "MaximumCoreCapacityUnits": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

\n The upper boundary of On-Demand EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The On-Demand units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between On-Demand and Spot instances.\n

" + "smithy.api#documentation": "

\n The upper boundary of EC2 units for core node type in a cluster. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The core units are not allowed to scale beyond this boundary. The parameter is used to split capacity allocation between core and task nodes.\n

" } }, "MinimumCapacityUnits": { @@ -1289,17 +1295,17 @@ "smithy.api#documentation": "

The classification within a configuration.

" } }, - "Configurations": { - "target": "com.amazonaws.emr#ConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

" - } - }, "Properties": { "target": "com.amazonaws.emr#StringMap", "traits": { "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" } + }, + "Configurations": { + "target": "com.amazonaws.emr#ConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

" + } } }, "traits": { @@ -1479,16 +1485,22 @@ "com.amazonaws.emr#DescribeJobFlowsInput": { "type": "structure", "members": { + "CreatedBefore": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "

Return only job flows created before this date and time.

" + } + }, "JobFlowStates": { "target": "com.amazonaws.emr#JobFlowExecutionStateList", "traits": { "smithy.api#documentation": "

Return only job flows whose state is contained in this list.

" } }, - "CreatedBefore": { + "CreatedAfter": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

Return only job flows created before this date and time.

" + "smithy.api#documentation": "

Return only job flows created after this date and time.

" } }, "JobFlowIds": { @@ -1496,12 +1508,6 @@ "traits": { "smithy.api#documentation": "

Return only job flows whose job flow ID is contained in this list.

" } - }, - "CreatedAfter": { - "target": "com.amazonaws.emr#Date", - "traits": { - "smithy.api#documentation": "

Return only job flows created after this date and time.

" - } } }, "traits": { @@ -1522,6 +1528,49 @@ "smithy.api#documentation": "

The output for the DescribeJobFlows operation.

" } }, + "com.amazonaws.emr#DescribeNotebookExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#DescribeNotebookExecutionInput" + }, + "output": { + "target": "com.amazonaws.emr#DescribeNotebookExecutionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.emr#InternalServerError" + }, + { + "target": "com.amazonaws.emr#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides details of a notebook execution.

" + } + }, + "com.amazonaws.emr#DescribeNotebookExecutionInput": { + "type": "structure", + "members": { + "NotebookExecutionId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the notebook execution.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emr#DescribeNotebookExecutionOutput": { + "type": "structure", + "members": { + "NotebookExecution": { + "target": "com.amazonaws.emr#NotebookExecution", + "traits": { + "smithy.api#documentation": "

Properties of the notebook execution.

" + } + } + } + }, "com.amazonaws.emr#DescribeSecurityConfiguration": { "type": "operation", "input": { @@ -1600,17 +1649,17 @@ "com.amazonaws.emr#DescribeStepInput": { "type": "structure", "members": { - "StepId": { - "target": "com.amazonaws.emr#StepId", + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

The identifier of the step to describe.

", + "smithy.api#documentation": "

The identifier of the cluster with steps to describe.

", "smithy.api#required": {} } }, - "ClusterId": { - "target": "com.amazonaws.emr#ClusterId", + "StepId": { + "target": "com.amazonaws.emr#StepId", "traits": { - "smithy.api#documentation": "

The identifier of the cluster with steps to describe.

", + "smithy.api#documentation": "

The identifier of the step to describe.

", "smithy.api#required": {} } } @@ -1668,18 +1717,18 @@ "com.amazonaws.emr#EbsBlockDeviceConfig": { "type": "structure", "members": { + "VolumesPerInstance": { + "target": "com.amazonaws.emr#Integer", + "traits": { + "smithy.api#documentation": "

Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group

" + } + }, "VolumeSpecification": { "target": "com.amazonaws.emr#VolumeSpecification", "traits": { "smithy.api#documentation": "

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

", "smithy.api#required": {} } - }, - "VolumesPerInstance": { - "target": "com.amazonaws.emr#Integer", - "traits": { - "smithy.api#documentation": "

Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group

" - } } }, "traits": { @@ -1747,18 +1796,6 @@ "com.amazonaws.emr#Ec2InstanceAttributes": { "type": "structure", "members": { - "Ec2SubnetId": { - "target": "com.amazonaws.emr#String", - "traits": { - "smithy.api#documentation": "

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

" - } - }, - "EmrManagedMasterSecurityGroup": { - "target": "com.amazonaws.emr#String", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the master node.

" - } - }, "Ec2KeyName": { "target": "com.amazonaws.emr#String", "traits": { @@ -1771,10 +1808,10 @@ "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the core and task nodes.

" } }, - "RequestedEc2SubnetIds": { - "target": "com.amazonaws.emr#XmlStringMaxLen256List", + "IamInstanceProfile": { + "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

" + "smithy.api#documentation": "

The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.

" } }, "RequestedEc2AvailabilityZones": { @@ -1783,16 +1820,16 @@ "smithy.api#documentation": "

Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

" } }, - "Ec2AvailabilityZone": { - "target": "com.amazonaws.emr#String", + "RequestedEc2SubnetIds": { + "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

The Availability Zone in which the cluster will run.

" + "smithy.api#documentation": "

Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

" } }, - "IamInstanceProfile": { + "Ec2SubnetId": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.

" + "smithy.api#documentation": "

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

" } }, "AdditionalSlaveSecurityGroups": { @@ -1801,16 +1838,28 @@ "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the core and task nodes.

" } }, + "ServiceAccessSecurityGroup": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" + } + }, + "Ec2AvailabilityZone": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the cluster will run.

" + } + }, "AdditionalMasterSecurityGroups": { "target": "com.amazonaws.emr#StringList", "traits": { "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the master node.

" } }, - "ServiceAccessSecurityGroup": { + "EmrManagedMasterSecurityGroup": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the master node.

" } } }, @@ -1849,6 +1898,9 @@ { "target": "com.amazonaws.emr#DescribeJobFlows" }, + { + "target": "com.amazonaws.emr#DescribeNotebookExecution" + }, { "target": "com.amazonaws.emr#DescribeSecurityConfiguration" }, @@ -1876,6 +1928,9 @@ { "target": "com.amazonaws.emr#ListInstances" }, + { + "target": "com.amazonaws.emr#ListNotebookExecutions" + }, { "target": "com.amazonaws.emr#ListSecurityConfigurations" }, @@ -1918,6 +1973,12 @@ { "target": "com.amazonaws.emr#SetVisibleToAllUsers" }, + { + "target": "com.amazonaws.emr#StartNotebookExecution" + }, + { + "target": "com.amazonaws.emr#StopNotebookExecution" + }, { "target": "com.amazonaws.emr#TerminateJobFlows" } @@ -1927,7 +1988,7 @@ "sdkId": "EMR", "arnNamespace": "elasticmapreduce", "cloudFormationName": "EMR", - "cloudTrailEventSource": "webservice.elasticmapreduce" + "cloudTrailEventSource": "emr.amazonaws.com" }, "aws.auth#sigv4": { "name": "elasticmapreduce" @@ -1952,15 +2013,47 @@ "com.amazonaws.emr#ErrorMessage": { "type": "string" }, - "com.amazonaws.emr#FailureDetails": { + "com.amazonaws.emr#ExecutionEngineConfig": { "type": "structure", "members": { - "LogFile": { - "target": "com.amazonaws.emr#String", + "MasterInstanceSecurityGroupId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The path to the log file where the step failure root cause was originally recorded.

" + "smithy.api#documentation": "

An optional unique ID of an EC2 security group to associate with the master instance of the EMR cluster for this notebook execution. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.

" } }, + "Id": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the execution engine. For an EMR cluster, this is the cluster ID.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.emr#ExecutionEngineType", + "traits": { + "smithy.api#documentation": "

The type of execution engine. A value of EMR specifies an EMR cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the execution engine (cluster) to run the notebook and perform the notebook execution, for example, an EMR cluster.

" + } + }, + "com.amazonaws.emr#ExecutionEngineType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EMR", + "name": "EMR" + } + ] + } + }, + "com.amazonaws.emr#FailureDetails": { + "type": "structure", + "members": { "Reason": { "target": "com.amazonaws.emr#String", "traits": { @@ -1972,6 +2065,12 @@ "traits": { "smithy.api#documentation": "

The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.

" } + }, + "LogFile": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "

The path to the log file where the step failure root cause was originally recorded.

" + } } }, "traits": { @@ -2059,17 +2158,16 @@ "com.amazonaws.emr#HadoopJarStepConfig": { "type": "structure", "members": { - "MainClass": { - "target": "com.amazonaws.emr#XmlString", + "Properties": { + "target": "com.amazonaws.emr#KeyValueList", "traits": { - "smithy.api#documentation": "

The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.

" + "smithy.api#documentation": "

A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" } }, - "Jar": { + "MainClass": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

A path to a JAR file run during the step.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.

" } }, "Args": { @@ -2078,10 +2176,11 @@ "smithy.api#documentation": "

A list of command line arguments passed to the JAR file's main function when executed.

" } }, - "Properties": { - "target": "com.amazonaws.emr#KeyValueList", + "Jar": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" + "smithy.api#documentation": "

A path to a JAR file run during the step.

", + "smithy.api#required": {} } } }, @@ -2092,18 +2191,18 @@ "com.amazonaws.emr#HadoopStepConfig": { "type": "structure", "members": { - "Properties": { - "target": "com.amazonaws.emr#StringMap", - "traits": { - "smithy.api#documentation": "

The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" - } - }, "MainClass": { "target": "com.amazonaws.emr#String", "traits": { "smithy.api#documentation": "

The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.

" } }, + "Properties": { + "target": "com.amazonaws.emr#StringMap", + "traits": { + "smithy.api#documentation": "

The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" + } + }, "Args": { "target": "com.amazonaws.emr#StringList", "traits": { @@ -2124,16 +2223,22 @@ "com.amazonaws.emr#Instance": { "type": "structure", "members": { - "InstanceGroupId": { + "PublicDnsName": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The identifier of the instance group to which this instance belongs.

" + "smithy.api#documentation": "

The public DNS name of the instance.

" } }, - "Id": { - "target": "com.amazonaws.emr#InstanceId", + "EbsVolumes": { + "target": "com.amazonaws.emr#EbsVolumeList", "traits": { - "smithy.api#documentation": "

The unique identifier for the instance in Amazon EMR.

" + "smithy.api#documentation": "

The list of EBS volumes that are attached to this instance.

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "

The private IP address of the instance.

" } }, "PublicIpAddress": { @@ -2148,28 +2253,22 @@ "smithy.api#documentation": "

The unique identifier of the instance in Amazon EC2.

" } }, - "PrivateDnsName": { - "target": "com.amazonaws.emr#String", + "Status": { + "target": "com.amazonaws.emr#InstanceStatus", "traits": { - "smithy.api#documentation": "

The private DNS name of the instance.

" + "smithy.api#documentation": "

The current status of the instance.

" } }, - "PrivateIpAddress": { + "InstanceGroupId": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The private IP address of the instance.

" - } - }, - "Status": { - "target": "com.amazonaws.emr#InstanceStatus", - "traits": { - "smithy.api#documentation": "

The current status of the instance.

" + "smithy.api#documentation": "

The identifier of the instance group to which this instance belongs.

" } }, - "Market": { - "target": "com.amazonaws.emr#MarketType", + "PrivateDnsName": { + "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The instance purchasing option. Valid values are ON_DEMAND or SPOT.\n

" + "smithy.api#documentation": "

The private DNS name of the instance.

" } }, "InstanceType": { @@ -2178,16 +2277,10 @@ "smithy.api#documentation": "

The EC2 instance type, for example m3.xlarge.

" } }, - "EbsVolumes": { - "target": "com.amazonaws.emr#EbsVolumeList", - "traits": { - "smithy.api#documentation": "

The list of EBS volumes that are attached to this instance.

" - } - }, - "PublicDnsName": { - "target": "com.amazonaws.emr#String", + "Id": { + "target": "com.amazonaws.emr#InstanceId", "traits": { - "smithy.api#documentation": "

The public DNS name of the instance.

" + "smithy.api#documentation": "

The unique identifier for the instance in Amazon EMR.

" } }, "InstanceFleetId": { @@ -2195,6 +2288,12 @@ "traits": { "smithy.api#documentation": "

The unique identifier of the instance fleet to which an EC2 instance belongs.

" } + }, + "Market": { + "target": "com.amazonaws.emr#MarketType", + "traits": { + "smithy.api#documentation": "

The instance purchasing option. Valid values are ON_DEMAND or SPOT.\n

" + } } }, "traits": { @@ -2219,22 +2318,10 @@ "com.amazonaws.emr#InstanceFleet": { "type": "structure", "members": { - "ProvisionedSpotCapacity": { - "target": "com.amazonaws.emr#WholeNumber", - "traits": { - "smithy.api#documentation": "

The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.

" - } - }, - "Id": { - "target": "com.amazonaws.emr#InstanceFleetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the instance fleet.

" - } - }, - "TargetOnDemandCapacity": { - "target": "com.amazonaws.emr#WholeNumber", + "InstanceTypeSpecifications": { + "target": "com.amazonaws.emr#InstanceTypeSpecificationList", "traits": { - "smithy.api#documentation": "

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.

\n \n

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

\n " + "smithy.api#documentation": "

The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet. \n

" } }, "Name": { @@ -2249,16 +2336,16 @@ "smithy.api#documentation": "

The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity.

" } }, - "InstanceTypeSpecifications": { - "target": "com.amazonaws.emr#InstanceTypeSpecificationList", + "TargetOnDemandCapacity": { + "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet. \n

" + "smithy.api#documentation": "

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.

\n \n

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

\n " } }, - "LaunchSpecifications": { - "target": "com.amazonaws.emr#InstanceFleetProvisioningSpecifications", + "Id": { + "target": "com.amazonaws.emr#InstanceFleetId", "traits": { - "smithy.api#documentation": "

Describes the launch specification for an instance fleet.\n

" + "smithy.api#documentation": "

The unique identifier of the instance fleet.

" } }, "Status": { @@ -2273,11 +2360,23 @@ "smithy.api#documentation": "

The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.\n

" } }, + "LaunchSpecifications": { + "target": "com.amazonaws.emr#InstanceFleetProvisioningSpecifications", + "traits": { + "smithy.api#documentation": "

Describes the launch specification for an instance fleet.\n

" + } + }, "TargetSpotCapacity": { "target": "com.amazonaws.emr#WholeNumber", "traits": { "smithy.api#documentation": "

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.

\n \n

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

\n " } + }, + "ProvisionedSpotCapacity": { + "target": "com.amazonaws.emr#WholeNumber", + "traits": { + "smithy.api#documentation": "

The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.

" + } } }, "traits": { @@ -2287,10 +2386,10 @@ "com.amazonaws.emr#InstanceFleetConfig": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "TargetSpotCapacity": { + "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The friendly name of the instance fleet.

" + "smithy.api#documentation": "

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

\n \n

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

\n " } }, "InstanceTypeConfigs": { @@ -2299,10 +2398,10 @@ "smithy.api#documentation": "

The instance type configurations that define the EC2 instances in the instance fleet.

" } }, - "LaunchSpecifications": { - "target": "com.amazonaws.emr#InstanceFleetProvisioningSpecifications", + "Name": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The launch specification for the instance fleet.

" + "smithy.api#documentation": "

The friendly name of the instance fleet.

" } }, "TargetOnDemandCapacity": { @@ -2311,18 +2410,18 @@ "smithy.api#documentation": "

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

\n \n

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

\n " } }, + "LaunchSpecifications": { + "target": "com.amazonaws.emr#InstanceFleetProvisioningSpecifications", + "traits": { + "smithy.api#documentation": "

The launch specification for the instance fleet.

" + } + }, "InstanceFleetType": { "target": "com.amazonaws.emr#InstanceFleetType", "traits": { "smithy.api#documentation": "

The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.

", "smithy.api#required": {} } - }, - "TargetSpotCapacity": { - "target": "com.amazonaws.emr#WholeNumber", - "traits": { - "smithy.api#documentation": "

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

\n \n

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

\n " - } } }, "traits": { @@ -2374,17 +2473,17 @@ "com.amazonaws.emr#InstanceFleetProvisioningSpecifications": { "type": "structure", "members": { - "OnDemandSpecification": { - "target": "com.amazonaws.emr#OnDemandProvisioningSpecification", - "traits": { - "smithy.api#documentation": "

\n The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy. \n

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand instances allocation strategy is available in Amazon EMR version 5.12.1 and later.

\n " - } - }, "SpotSpecification": { "target": "com.amazonaws.emr#SpotProvisioningSpecification", "traits": { "smithy.api#documentation": "

The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.

" } + }, + "OnDemandSpecification": { + "target": "com.amazonaws.emr#OnDemandProvisioningSpecification", + "traits": { + "smithy.api#documentation": "

\n The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy. \n

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand instances allocation strategy is available in Amazon EMR version 5.12.1 and later.

\n " + } } }, "traits": { @@ -2478,17 +2577,17 @@ "smithy.api#documentation": "

A code representing the instance fleet status.

\n " } }, - "StateChangeReason": { - "target": "com.amazonaws.emr#InstanceFleetStateChangeReason", - "traits": { - "smithy.api#documentation": "

Provides status change reason details for the instance fleet.

" - } - }, "Timeline": { "target": "com.amazonaws.emr#InstanceFleetTimeline", "traits": { "smithy.api#documentation": "

Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.

" } + }, + "StateChangeReason": { + "target": "com.amazonaws.emr#InstanceFleetStateChangeReason", + "traits": { + "smithy.api#documentation": "

Provides status change reason details for the instance fleet.

" + } } }, "traits": { @@ -2504,16 +2603,16 @@ "smithy.api#documentation": "

The time and date the instance fleet was created.

" } }, - "EndDateTime": { + "ReadyDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The time and date the instance fleet terminated.

" + "smithy.api#documentation": "

The time and date the instance fleet was ready to run jobs.

" } }, - "ReadyDateTime": { + "EndDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The time and date the instance fleet was ready to run jobs.

" + "smithy.api#documentation": "

The time and date the instance fleet terminated.

" } } }, @@ -2543,10 +2642,46 @@ "com.amazonaws.emr#InstanceGroup": { "type": "structure", "members": { - "Market": { - "target": "com.amazonaws.emr#MarketType", + "RequestedInstanceCount": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

" + "smithy.api#documentation": "

The target number of instances for the instance group.

" + } + }, + "Id": { + "target": "com.amazonaws.emr#InstanceGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the instance group.

" + } + }, + "LastSuccessfullyAppliedConfigurations": { + "target": "com.amazonaws.emr#ConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of configurations that were successfully applied for an instance group last time.

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "

If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

" + } + }, + "ConfigurationsVersion": { + "target": "com.amazonaws.emr#Long", + "traits": { + "smithy.api#documentation": "

The version number of the requested configuration specification for this instance group.

" + } + }, + "EbsBlockDevices": { + "target": "com.amazonaws.emr#EbsBlockDeviceList", + "traits": { + "smithy.api#documentation": "

The EBS block devices that are mapped to this instance group.

" + } + }, + "ShrinkPolicy": { + "target": "com.amazonaws.emr#ShrinkPolicy", + "traits": { + "smithy.api#documentation": "

Policy for customizing shrink operations.

" } }, "LastSuccessfullyAppliedConfigurationsVersion": { @@ -2561,22 +2696,22 @@ "smithy.api#documentation": "

The name of the instance group.

" } }, - "BidPrice": { - "target": "com.amazonaws.emr#String", + "Market": { + "target": "com.amazonaws.emr#MarketType", "traits": { - "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in\n USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,\n BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" + "smithy.api#documentation": "

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

" } }, - "LastSuccessfullyAppliedConfigurations": { - "target": "com.amazonaws.emr#ConfigurationList", + "BidPrice": { + "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

A list of configurations that were successfully applied for an instance group last time.

" + "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in\n USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,\n BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" } }, - "RunningInstanceCount": { - "target": "com.amazonaws.emr#Integer", + "Status": { + "target": "com.amazonaws.emr#InstanceGroupStatus", "traits": { - "smithy.api#documentation": "

The number of instances currently running in this instance group.

" + "smithy.api#documentation": "

The current status of the instance group.

" } }, "AutoScalingPolicy": { @@ -2591,10 +2726,10 @@ "smithy.api#documentation": "

The EC2 instance type for all instances in the instance group.

" } }, - "Status": { - "target": "com.amazonaws.emr#InstanceGroupStatus", + "Configurations": { + "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "

The current status of the instance group.

" + "smithy.api#documentation": "\n

Amazon EMR releases 4.x or later.

\n \n

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

" } }, "InstanceGroupType": { @@ -2603,46 +2738,10 @@ "smithy.api#documentation": "

The type of the instance group. Valid values are MASTER, CORE or TASK.

" } }, - "EbsBlockDevices": { - "target": "com.amazonaws.emr#EbsBlockDeviceList", - "traits": { - "smithy.api#documentation": "

The EBS block devices that are mapped to this instance group.

" - } - }, - "RequestedInstanceCount": { + "RunningInstanceCount": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The target number of instances for the instance group.

" - } - }, - "Configurations": { - "target": "com.amazonaws.emr#ConfigurationList", - "traits": { - "smithy.api#documentation": "\n

Amazon EMR releases 4.x or later.

\n \n

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

" - } - }, - "Id": { - "target": "com.amazonaws.emr#InstanceGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the instance group.

" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.emr#BooleanObject", - "traits": { - "smithy.api#documentation": "

If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

" - } - }, - "ShrinkPolicy": { - "target": "com.amazonaws.emr#ShrinkPolicy", - "traits": { - "smithy.api#documentation": "

Policy for customizing shrink operations.

" - } - }, - "ConfigurationsVersion": { - "target": "com.amazonaws.emr#Long", - "traits": { - "smithy.api#documentation": "

The version number of the requested configuration specification for this instance group.

" + "smithy.api#documentation": "

The number of instances currently running in this instance group.

" } } }, @@ -2653,6 +2752,12 @@ "com.amazonaws.emr#InstanceGroupConfig": { "type": "structure", "members": { + "BidPrice": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" + } + }, "AutoScalingPolicy": { "target": "com.amazonaws.emr#AutoScalingPolicy", "traits": { @@ -2665,12 +2770,6 @@ "smithy.api#documentation": "\n

Amazon EMR releases 4.x or later.

\n \n

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

" } }, - "Name": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", - "traits": { - "smithy.api#documentation": "

Friendly name given to the instance group.

" - } - }, "InstanceRole": { "target": "com.amazonaws.emr#InstanceRoleType", "traits": { @@ -2684,6 +2783,12 @@ "smithy.api#documentation": "

Market type of the EC2 instances used to create a cluster node.

" } }, + "Name": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

Friendly name given to the instance group.

" + } + }, "InstanceType": { "target": "com.amazonaws.emr#InstanceType", "traits": { @@ -2703,12 +2808,6 @@ "smithy.api#documentation": "

Target number of instances for the instance group.

", "smithy.api#required": {} } - }, - "BidPrice": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", - "traits": { - "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" - } } }, "traits": { @@ -2724,95 +2823,95 @@ "com.amazonaws.emr#InstanceGroupDetail": { "type": "structure", "members": { - "LastStateChangeReason": { - "target": "com.amazonaws.emr#XmlString", + "Name": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Details regarding the state of the instance group.

" + "smithy.api#documentation": "

Friendly name for the instance group.

" } }, - "EndDateTime": { - "target": "com.amazonaws.emr#Date", + "State": { + "target": "com.amazonaws.emr#InstanceGroupState", "traits": { - "smithy.api#documentation": "

The date/time the instance group was terminated.

" + "smithy.api#documentation": "

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

", + "smithy.api#required": {} } }, - "InstanceRole": { - "target": "com.amazonaws.emr#InstanceRoleType", + "CreationDateTime": { + "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

Instance group role in the cluster

", + "smithy.api#documentation": "

The date/time the instance group was created.

", "smithy.api#required": {} } }, - "InstanceRunningCount": { - "target": "com.amazonaws.emr#Integer", + "InstanceType": { + "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "

Actual count of running instances.

", + "smithy.api#documentation": "

EC2 instance type.

", "smithy.api#required": {} } }, - "InstanceGroupId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "InstanceRequestCount": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

Unique identifier for the instance group.

" + "smithy.api#documentation": "

Target number of instances to run in the instance group.

", + "smithy.api#required": {} } }, - "ReadyDateTime": { - "target": "com.amazonaws.emr#Date", + "LastStateChangeReason": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The date/time the instance group was available to the cluster.

" + "smithy.api#documentation": "

Details regarding the state of the instance group.

" } }, - "Name": { + "InstanceGroupId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Friendly name for the instance group.

" + "smithy.api#documentation": "

Unique identifier for the instance group.

" } }, - "InstanceRequestCount": { - "target": "com.amazonaws.emr#Integer", + "InstanceRole": { + "target": "com.amazonaws.emr#InstanceRoleType", "traits": { - "smithy.api#documentation": "

Target number of instances to run in the instance group.

", + "smithy.api#documentation": "

Instance group role in the cluster

", "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.emr#InstanceGroupState", + "InstanceRunningCount": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

", + "smithy.api#documentation": "

Actual count of running instances.

", "smithy.api#required": {} } }, - "Market": { - "target": "com.amazonaws.emr#MarketType", + "BidPrice": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Market type of the EC2 instances used to create a cluster node.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" } }, - "StartDateTime": { + "EndDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The date/time the instance group was started.

" + "smithy.api#documentation": "

The date/time the instance group was terminated.

" } }, - "BidPrice": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "StartDateTime": { + "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" + "smithy.api#documentation": "

The date/time the instance group was started.

" } }, - "InstanceType": { - "target": "com.amazonaws.emr#InstanceType", + "Market": { + "target": "com.amazonaws.emr#MarketType", "traits": { - "smithy.api#documentation": "

EC2 instance type.

", + "smithy.api#documentation": "

Market type of the EC2 instances used to create a cluster node.

", "smithy.api#required": {} } }, - "CreationDateTime": { + "ReadyDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The date/time the instance group was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The date/time the instance group was available to the cluster.

" } } }, @@ -2844,10 +2943,10 @@ "com.amazonaws.emr#InstanceGroupModifyConfig": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.emr#Integer", + "Configurations": { + "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "

Target size for the instance group.

" + "smithy.api#documentation": "

A list of new or modified configurations to apply for an instance group.

" } }, "EC2InstanceIdsToTerminate": { @@ -2856,10 +2955,11 @@ "smithy.api#documentation": "

The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.

" } }, - "Configurations": { - "target": "com.amazonaws.emr#ConfigurationList", + "InstanceGroupId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

A list of new or modified configurations to apply for an instance group.

" + "smithy.api#documentation": "

Unique ID of the instance group to expand or shrink.

", + "smithy.api#required": {} } }, "ShrinkPolicy": { @@ -2868,11 +2968,10 @@ "smithy.api#documentation": "

Policy for customizing shrink operations.

" } }, - "InstanceGroupId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "InstanceCount": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

Unique ID of the instance group to expand or shrink.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Target size for the instance group.

" } } }, @@ -3009,16 +3108,16 @@ "com.amazonaws.emr#InstanceGroupTimeline": { "type": "structure", "members": { - "EndDateTime": { + "CreationDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The date and time when the instance group terminated.

" + "smithy.api#documentation": "

The creation date and time of the instance group.

" } }, - "CreationDateTime": { + "EndDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The creation date and time of the instance group.

" + "smithy.api#documentation": "

The date and time when the instance group terminated.

" } }, "ReadyDateTime": { @@ -3138,17 +3237,17 @@ "com.amazonaws.emr#InstanceStateChangeReason": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.emr#InstanceStateChangeReasonCode", - "traits": { - "smithy.api#documentation": "

The programmable code for the state change reason.

" - } - }, "Message": { "target": "com.amazonaws.emr#String", "traits": { "smithy.api#documentation": "

The status change reason description.

" } + }, + "Code": { + "target": "com.amazonaws.emr#InstanceStateChangeReasonCode", + "traits": { + "smithy.api#documentation": "

The programmable code for the state change reason.

" + } } }, "traits": { @@ -3191,6 +3290,12 @@ "com.amazonaws.emr#InstanceStatus": { "type": "structure", "members": { + "Timeline": { + "target": "com.amazonaws.emr#InstanceTimeline", + "traits": { + "smithy.api#documentation": "

The timeline of the instance status over time.

" + } + }, "State": { "target": "com.amazonaws.emr#InstanceState", "traits": { @@ -3202,12 +3307,6 @@ "traits": { "smithy.api#documentation": "

The details of the status change reason for the instance.

" } - }, - "Timeline": { - "target": "com.amazonaws.emr#InstanceTimeline", - "traits": { - "smithy.api#documentation": "

The timeline of the instance status over time.

" - } } }, "traits": { @@ -3217,22 +3316,22 @@ "com.amazonaws.emr#InstanceTimeline": { "type": "structure", "members": { - "CreationDateTime": { + "EndDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The creation date and time of the instance.

" + "smithy.api#documentation": "

The date and time when the instance was terminated.

" } }, - "ReadyDateTime": { + "CreationDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The date and time when the instance was ready to perform tasks.

" + "smithy.api#documentation": "

The creation date and time of the instance.

" } }, - "EndDateTime": { + "ReadyDateTime": { "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The date and time when the instance was terminated.

" + "smithy.api#documentation": "

The date and time when the instance was ready to perform tasks.

" } } }, @@ -3253,6 +3352,19 @@ "com.amazonaws.emr#InstanceTypeConfig": { "type": "structure", "members": { + "InstanceType": { + "target": "com.amazonaws.emr#InstanceType", + "traits": { + "smithy.api#documentation": "

An EC2 instance type, such as m3.xlarge.\n

", + "smithy.api#required": {} + } + }, + "Configurations": { + "target": "com.amazonaws.emr#ConfigurationList", + "traits": { + "smithy.api#documentation": "

A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.

" + } + }, "EbsConfiguration": { "target": "com.amazonaws.emr#EbsConfiguration", "traits": { @@ -3265,12 +3377,6 @@ "smithy.api#documentation": "

The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.\n

" } }, - "Configurations": { - "target": "com.amazonaws.emr#ConfigurationList", - "traits": { - "smithy.api#documentation": "

A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.

" - } - }, "BidPrice": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { @@ -3282,13 +3388,6 @@ "traits": { "smithy.api#documentation": "

The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" } - }, - "InstanceType": { - "target": "com.amazonaws.emr#InstanceType", - "traits": { - "smithy.api#documentation": "

An EC2 instance type, such as m3.xlarge.\n

", - "smithy.api#required": {} - } } }, "traits": { @@ -3304,6 +3403,12 @@ "com.amazonaws.emr#InstanceTypeSpecification": { "type": "structure", "members": { + "BidPrice": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD.

" + } + }, "EbsOptimized": { "target": "com.amazonaws.emr#BooleanObject", "traits": { @@ -3334,12 +3439,6 @@ "smithy.api#documentation": "

The EC2 instance type, for example m3.xlarge.

" } }, - "BidPrice": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", - "traits": { - "smithy.api#documentation": "

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD.

" - } - }, "WeightedCapacity": { "target": "com.amazonaws.emr#WholeNumber", "traits": { @@ -3390,19 +3489,19 @@ "com.amazonaws.emr#InvalidRequestException": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.emr#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code associated with the exception.

" - } - }, "Message": { "target": "com.amazonaws.emr#ErrorMessage", "traits": { "smithy.api#documentation": "

The message associated with the exception.

" } - } - }, + }, + "ErrorCode": { + "target": "com.amazonaws.emr#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code associated with the exception.

" + } + } + }, "traits": { "smithy.api#documentation": "

This exception occurs when there is something wrong with user input.

", "smithy.api#error": "client" @@ -3411,98 +3510,98 @@ "com.amazonaws.emr#JobFlowDetail": { "type": "structure", "members": { - "ExecutionStatusDetail": { - "target": "com.amazonaws.emr#JobFlowExecutionStatusDetail", + "Name": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Describes the execution status of the job flow.

", + "smithy.api#documentation": "

The name of the job flow.

", "smithy.api#required": {} } }, - "BootstrapActions": { - "target": "com.amazonaws.emr#BootstrapActionDetailList", + "JobFlowRole": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

A list of the bootstrap actions run by the job flow.

" + "smithy.api#documentation": "

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

" } }, - "JobFlowId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "LogUri": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The job flow identifier.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The location in Amazon S3 where log files for the job are stored.

" } }, - "Instances": { - "target": "com.amazonaws.emr#JobFlowInstancesDetail", + "AutoScalingRole": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

Describes the Amazon EC2 instances of the job flow.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.

" } }, - "ScaleDownBehavior": { - "target": "com.amazonaws.emr#ScaleDownBehavior", + "VisibleToAllUsers": { + "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" + "smithy.api#documentation": "

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.

" } }, - "Steps": { - "target": "com.amazonaws.emr#StepDetailList", + "LogEncryptionKmsKeyId": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

A list of steps run by the job flow.

" + "smithy.api#documentation": "

The AWS KMS customer master key (CMK) used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" } }, - "Name": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "ExecutionStatusDetail": { + "target": "com.amazonaws.emr#JobFlowExecutionStatusDetail", "traits": { - "smithy.api#documentation": "

The name of the job flow.

", + "smithy.api#documentation": "

Describes the execution status of the job flow.

", "smithy.api#required": {} } }, - "JobFlowRole": { - "target": "com.amazonaws.emr#XmlString", + "SupportedProducts": { + "target": "com.amazonaws.emr#SupportedProductsList", "traits": { - "smithy.api#documentation": "

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

" + "smithy.api#documentation": "

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

" } }, - "AmiVersion": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "ServiceRole": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

" + "smithy.api#documentation": "

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" } }, - "LogUri": { - "target": "com.amazonaws.emr#XmlString", + "BootstrapActions": { + "target": "com.amazonaws.emr#BootstrapActionDetailList", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where log files for the job are stored.

" + "smithy.api#documentation": "

A list of the bootstrap actions run by the job flow.

" } }, - "AutoScalingRole": { - "target": "com.amazonaws.emr#XmlString", + "Steps": { + "target": "com.amazonaws.emr#StepDetailList", "traits": { - "smithy.api#documentation": "

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.

" + "smithy.api#documentation": "

A list of steps run by the job flow.

" } }, - "VisibleToAllUsers": { - "target": "com.amazonaws.emr#Boolean", + "JobFlowId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.

" + "smithy.api#documentation": "

The job flow identifier.

", + "smithy.api#required": {} } }, - "ServiceRole": { - "target": "com.amazonaws.emr#XmlString", + "Instances": { + "target": "com.amazonaws.emr#JobFlowInstancesDetail", "traits": { - "smithy.api#documentation": "

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + "smithy.api#documentation": "

Describes the Amazon EC2 instances of the job flow.

", + "smithy.api#required": {} } }, - "SupportedProducts": { - "target": "com.amazonaws.emr#SupportedProductsList", + "AmiVersion": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

" + "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

" } }, - "LogEncryptionKmsKeyId": { - "target": "com.amazonaws.emr#XmlString", + "ScaleDownBehavior": { + "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { - "smithy.api#documentation": "

The AWS KMS customer master key (CMK) used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" + "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } } }, @@ -3578,10 +3677,10 @@ "smithy.api#documentation": "

The date and time when the job flow was ready to start running bootstrap actions.

" } }, - "EndDateTime": { - "target": "com.amazonaws.emr#Date", + "LastStateChangeReason": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The completion date and time of the job flow.

" + "smithy.api#documentation": "

Description of the job flow last changed state.

" } }, "StartDateTime": { @@ -3597,10 +3696,10 @@ "smithy.api#required": {} } }, - "LastStateChangeReason": { - "target": "com.amazonaws.emr#XmlString", + "EndDateTime": { + "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

Description of the job flow last changed state.

" + "smithy.api#documentation": "

The completion date and time of the job flow.

" } } }, @@ -3611,70 +3710,64 @@ "com.amazonaws.emr#JobFlowInstancesConfig": { "type": "structure", "members": { - "InstanceFleets": { - "target": "com.amazonaws.emr#InstanceFleetConfigList", - "traits": { - "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

\n \n

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

" - } - }, - "Ec2SubnetIds": { - "target": "com.amazonaws.emr#XmlStringMaxLen256List", + "Placement": { + "target": "com.amazonaws.emr#PlacementType", "traits": { - "smithy.api#documentation": "

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

\n " + "smithy.api#documentation": "

The Availability Zone in which the cluster runs.

" } }, - "SlaveInstanceType": { - "target": "com.amazonaws.emr#InstanceType", + "Ec2SubnetId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The EC2 instance type of the core and task nodes.

" + "smithy.api#documentation": "

Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

" } }, - "InstanceGroups": { - "target": "com.amazonaws.emr#InstanceGroupConfigList", + "InstanceCount": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

Configuration for the instance groups in a cluster.

" + "smithy.api#documentation": "

The number of EC2 instances in the cluster.

" } }, - "AdditionalSlaveSecurityGroups": { - "target": "com.amazonaws.emr#SecurityGroupsList", + "EmrManagedSlaveSecurityGroup": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the core and task nodes.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the core and task nodes.

" } }, - "TerminationProtected": { - "target": "com.amazonaws.emr#Boolean", + "ServiceAccessSecurityGroup": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" } }, - "Ec2KeyName": { + "EmrManagedMasterSecurityGroup": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the EC2 key pair that can be used to ssh to the master node as the user called \"hadoop.\"

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the master node.

" } }, - "KeepJobFlowAliveWhenNoSteps": { - "target": "com.amazonaws.emr#Boolean", + "AdditionalMasterSecurityGroups": { + "target": "com.amazonaws.emr#SecurityGroupsList", "traits": { - "smithy.api#documentation": "

Specifies whether the cluster should remain available after completing all steps.

" + "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the master node.

" } }, - "MasterInstanceType": { - "target": "com.amazonaws.emr#InstanceType", + "AdditionalSlaveSecurityGroups": { + "target": "com.amazonaws.emr#SecurityGroupsList", "traits": { - "smithy.api#documentation": "

The EC2 instance type of the master node.

" + "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the core and task nodes.

" } }, - "Placement": { - "target": "com.amazonaws.emr#PlacementType", + "InstanceGroups": { + "target": "com.amazonaws.emr#InstanceGroupConfigList", "traits": { - "smithy.api#documentation": "

The Availability Zone in which the cluster runs.

" + "smithy.api#documentation": "

Configuration for the instance groups in a cluster.

" } }, - "Ec2SubnetId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "SlaveInstanceType": { + "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "

Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

" + "smithy.api#documentation": "

The EC2 instance type of the core and task nodes.

" } }, "HadoopVersion": { @@ -3683,34 +3776,40 @@ "smithy.api#documentation": "

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are \"0.18\" (deprecated), \"0.20\" (deprecated), \"0.20.205\" (deprecated), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

" } }, - "InstanceCount": { - "target": "com.amazonaws.emr#Integer", + "Ec2SubnetIds": { + "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

The number of EC2 instances in the cluster.

" + "smithy.api#documentation": "

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

\n " } }, - "EmrManagedSlaveSecurityGroup": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "KeepJobFlowAliveWhenNoSteps": { + "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the core and task nodes.

" + "smithy.api#documentation": "

Specifies whether the cluster should remain available after completing all steps.

" } }, - "AdditionalMasterSecurityGroups": { - "target": "com.amazonaws.emr#SecurityGroupsList", + "TerminationProtected": { + "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the master node.

" + "smithy.api#documentation": "

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

" } }, - "ServiceAccessSecurityGroup": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "InstanceFleets": { + "target": "com.amazonaws.emr#InstanceFleetConfigList", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" + "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

\n \n

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

" } }, - "EmrManagedMasterSecurityGroup": { + "Ec2KeyName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the master node.

" + "smithy.api#documentation": "

The name of the EC2 key pair that can be used to ssh to the master node as the user called \"hadoop.\"

" + } + }, + "MasterInstanceType": { + "target": "com.amazonaws.emr#InstanceType", + "traits": { + "smithy.api#documentation": "

The EC2 instance type of the master node.

" } } }, @@ -3721,28 +3820,17 @@ "com.amazonaws.emr#JobFlowInstancesDetail": { "type": "structure", "members": { - "HadoopVersion": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", - "traits": { - "smithy.api#documentation": "

The Hadoop version for the cluster.

" - } - }, - "Placement": { - "target": "com.amazonaws.emr#PlacementType", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 Availability Zone for the cluster.

" - } - }, "MasterInstanceId": { "target": "com.amazonaws.emr#XmlString", "traits": { "smithy.api#documentation": "

The Amazon EC2 instance identifier of the master node.

" } }, - "Ec2SubnetId": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "SlaveInstanceType": { + "target": "com.amazonaws.emr#InstanceType", "traits": { - "smithy.api#documentation": "

For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.

" + "smithy.api#documentation": "

The Amazon EC2 core and task node instance type.

", + "smithy.api#required": {} } }, "InstanceCount": { @@ -3752,11 +3840,10 @@ "smithy.api#required": {} } }, - "SlaveInstanceType": { - "target": "com.amazonaws.emr#InstanceType", + "MasterPublicDnsName": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The Amazon EC2 core and task node instance type.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

" } }, "MasterInstanceType": { @@ -3766,16 +3853,28 @@ "smithy.api#required": {} } }, - "NormalizedInstanceHours": { - "target": "com.amazonaws.emr#Integer", + "HadoopVersion": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" + "smithy.api#documentation": "

The Hadoop version for the cluster.

" } }, - "MasterPublicDnsName": { - "target": "com.amazonaws.emr#XmlString", + "Ec2SubnetId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

" + "smithy.api#documentation": "

For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.

" + } + }, + "Ec2KeyName": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The name of an Amazon EC2 key pair that can be used to ssh to the master node.

" + } + }, + "KeepJobFlowAliveWhenNoSteps": { + "target": "com.amazonaws.emr#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the cluster should remain available after completing all steps.

" } }, "InstanceGroups": { @@ -3790,16 +3889,16 @@ "smithy.api#documentation": "

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.

" } }, - "Ec2KeyName": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "NormalizedInstanceHours": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The name of an Amazon EC2 key pair that can be used to ssh to the master node.

" + "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" } }, - "KeepJobFlowAliveWhenNoSteps": { - "target": "com.amazonaws.emr#Boolean", + "Placement": { + "target": "com.amazonaws.emr#PlacementType", "traits": { - "smithy.api#documentation": "

Specifies whether the cluster should remain available after completing all steps.

" + "smithy.api#documentation": "

The Amazon EC2 Availability Zone for the cluster.

" } } }, @@ -3901,18 +4000,18 @@ "com.amazonaws.emr#ListBootstrapActionsInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.emr#Marker", - "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" - } - }, "ClusterId": { "target": "com.amazonaws.emr#ClusterId", "traits": { "smithy.api#documentation": "

The cluster identifier for the bootstrap actions to list.

", "smithy.api#required": {} } + }, + "Marker": { + "target": "com.amazonaws.emr#Marker", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + } } }, "traits": { @@ -3922,17 +4021,17 @@ "com.amazonaws.emr#ListBootstrapActionsOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.emr#Marker", - "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" - } - }, "BootstrapActions": { "target": "com.amazonaws.emr#CommandList", "traits": { "smithy.api#documentation": "

The bootstrap actions associated with the cluster.

" } + }, + "Marker": { + "target": "com.amazonaws.emr#Marker", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + } } }, "traits": { @@ -3967,10 +4066,10 @@ "com.amazonaws.emr#ListClustersInput": { "type": "structure", "members": { - "CreatedAfter": { - "target": "com.amazonaws.emr#Date", + "ClusterStates": { + "target": "com.amazonaws.emr#ClusterStateList", "traits": { - "smithy.api#documentation": "

The creation date and time beginning value filter for listing clusters.

" + "smithy.api#documentation": "

The cluster state filters to apply when listing clusters.

" } }, "CreatedBefore": { @@ -3985,10 +4084,10 @@ "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" } }, - "ClusterStates": { - "target": "com.amazonaws.emr#ClusterStateList", + "CreatedAfter": { + "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The cluster state filters to apply when listing clusters.

" + "smithy.api#documentation": "

The creation date and time beginning value filter for listing clusters.

" } } }, @@ -4102,6 +4201,72 @@ } }, "com.amazonaws.emr#ListInstanceGroupsInput": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", + "traits": { + "smithy.api#documentation": "

The identifier of the cluster for which to list the instance groups.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.emr#Marker", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This input determines which instance groups to retrieve.

" + } + }, + "com.amazonaws.emr#ListInstanceGroupsOutput": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.emr#Marker", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "InstanceGroups": { + "target": "com.amazonaws.emr#InstanceGroupList", + "traits": { + "smithy.api#documentation": "

The list of instance groups for the cluster and given filters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This input determines which instance groups to retrieve.

" + } + }, + "com.amazonaws.emr#ListInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#ListInstancesInput" + }, + "output": { + "target": "com.amazonaws.emr#ListInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.emr#InternalServerException" + }, + { + "target": "com.amazonaws.emr#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Instances" + } + } + }, + "com.amazonaws.emr#ListInstancesInput": { "type": "structure", "members": { "Marker": { @@ -4110,132 +4275,143 @@ "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" } }, + "InstanceGroupTypes": { + "target": "com.amazonaws.emr#InstanceGroupTypeList", + "traits": { + "smithy.api#documentation": "

The type of instance group for which to list the instances.

" + } + }, + "InstanceStates": { + "target": "com.amazonaws.emr#InstanceStateList", + "traits": { + "smithy.api#documentation": "

A list of instance states that will filter the instances returned with this request.

" + } + }, "ClusterId": { "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

The identifier of the cluster for which to list the instance groups.

", + "smithy.api#documentation": "

The identifier of the cluster for which to list the instances.

", "smithy.api#required": {} } + }, + "InstanceGroupId": { + "target": "com.amazonaws.emr#InstanceGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the instance group for which to list the instances.

" + } + }, + "InstanceFleetType": { + "target": "com.amazonaws.emr#InstanceFleetType", + "traits": { + "smithy.api#documentation": "

The node type of the instance fleet. For example MASTER, CORE, or TASK.

" + } + }, + "InstanceFleetId": { + "target": "com.amazonaws.emr#InstanceFleetId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the instance fleet.

" + } } }, "traits": { - "smithy.api#documentation": "

This input determines which instance groups to retrieve.

" + "smithy.api#documentation": "

This input determines which instances to list.

" } }, - "com.amazonaws.emr#ListInstanceGroupsOutput": { + "com.amazonaws.emr#ListInstancesOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.emr#Marker", + "Instances": { + "target": "com.amazonaws.emr#InstanceList", "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + "smithy.api#documentation": "

The list of instances for the cluster and given filters.

" } }, - "InstanceGroups": { - "target": "com.amazonaws.emr#InstanceGroupList", + "Marker": { + "target": "com.amazonaws.emr#Marker", "traits": { - "smithy.api#documentation": "

The list of instance groups for the cluster and given filters.

" + "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" } } }, "traits": { - "smithy.api#documentation": "

This input determines which instance groups to retrieve.

" + "smithy.api#documentation": "

This output contains the list of instances.

" } }, - "com.amazonaws.emr#ListInstances": { + "com.amazonaws.emr#ListNotebookExecutions": { "type": "operation", "input": { - "target": "com.amazonaws.emr#ListInstancesInput" + "target": "com.amazonaws.emr#ListNotebookExecutionsInput" }, "output": { - "target": "com.amazonaws.emr#ListInstancesOutput" + "target": "com.amazonaws.emr#ListNotebookExecutionsOutput" }, "errors": [ { - "target": "com.amazonaws.emr#InternalServerException" + "target": "com.amazonaws.emr#InternalServerError" }, { "target": "com.amazonaws.emr#InvalidRequestException" } ], "traits": { - "smithy.api#documentation": "

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

", + "smithy.api#documentation": "

Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecution calls.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", - "items": "Instances" + "items": "NotebookExecutions" } } }, - "com.amazonaws.emr#ListInstancesInput": { + "com.amazonaws.emr#ListNotebookExecutionsInput": { "type": "structure", "members": { - "InstanceFleetType": { - "target": "com.amazonaws.emr#InstanceFleetType", - "traits": { - "smithy.api#documentation": "

The node type of the instance fleet. For example MASTER, CORE, or TASK.

" - } - }, - "Marker": { - "target": "com.amazonaws.emr#Marker", - "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" - } - }, - "InstanceGroupTypes": { - "target": "com.amazonaws.emr#InstanceGroupTypeList", + "To": { + "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The type of instance group for which to list the instances.

" + "smithy.api#documentation": "

The end of time range filter for listing notebook executions. The default is the current timestamp.

" } }, - "InstanceGroupId": { - "target": "com.amazonaws.emr#InstanceGroupId", + "From": { + "target": "com.amazonaws.emr#Date", "traits": { - "smithy.api#documentation": "

The identifier of the instance group for which to list the instances.

" + "smithy.api#documentation": "

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

" } }, - "InstanceStates": { - "target": "com.amazonaws.emr#InstanceStateList", + "EditorId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

A list of instance states that will filter the instances returned with this request.

" + "smithy.api#documentation": "

The unique ID of the editor associated with the notebook execution.

" } }, - "ClusterId": { - "target": "com.amazonaws.emr#ClusterId", + "Marker": { + "target": "com.amazonaws.emr#Marker", "traits": { - "smithy.api#documentation": "

The identifier of the cluster for which to list the instances.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

" } }, - "InstanceFleetId": { - "target": "com.amazonaws.emr#InstanceFleetId", + "Status": { + "target": "com.amazonaws.emr#NotebookExecutionStatus", "traits": { - "smithy.api#documentation": "

The unique identifier of the instance fleet.

" + "smithy.api#documentation": "

The status filter for listing notebook executions.

\n " } } - }, - "traits": { - "smithy.api#documentation": "

This input determines which instances to list.

" } }, - "com.amazonaws.emr#ListInstancesOutput": { + "com.amazonaws.emr#ListNotebookExecutionsOutput": { "type": "structure", "members": { - "Instances": { - "target": "com.amazonaws.emr#InstanceList", + "Marker": { + "target": "com.amazonaws.emr#Marker", "traits": { - "smithy.api#documentation": "

The list of instances for the cluster and given filters.

" + "smithy.api#documentation": "

A pagination token that a subsequent ListNotebookExecutions can use to determine the next set of results to retrieve.

" } }, - "Marker": { - "target": "com.amazonaws.emr#Marker", + "NotebookExecutions": { + "target": "com.amazonaws.emr#NotebookExecutionSummaryList", "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + "smithy.api#documentation": "

A list of notebook executions.

" } } - }, - "traits": { - "smithy.api#documentation": "

This output contains the list of instances.

" } }, "com.amazonaws.emr#ListSecurityConfigurations": { @@ -4325,6 +4501,12 @@ "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" } }, + "StepIds": { + "target": "com.amazonaws.emr#XmlStringList", + "traits": { + "smithy.api#documentation": "

The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.

" + } + }, "StepStates": { "target": "com.amazonaws.emr#StepStateList", "traits": { @@ -4337,12 +4519,6 @@ "smithy.api#documentation": "

The identifier of the cluster for which to list the steps.

", "smithy.api#required": {} } - }, - "StepIds": { - "target": "com.amazonaws.emr#XmlStringList", - "traits": { - "smithy.api#documentation": "

The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.

" - } } }, "traits": { @@ -4378,7 +4554,7 @@ "ComputeLimits": { "target": "com.amazonaws.emr#ComputeLimits", "traits": { - "smithy.api#documentation": "

\n The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.\n

" + "smithy.api#documentation": "

The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

" } } }, @@ -4407,16 +4583,16 @@ "com.amazonaws.emr#MetricDimension": { "type": "structure", "members": { - "Key": { + "Value": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The dimension name.

" + "smithy.api#documentation": "

The dimension value.

" } }, - "Value": { + "Key": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The dimension value.

" + "smithy.api#documentation": "

The dimension name.

" } } }, @@ -4453,18 +4629,18 @@ "com.amazonaws.emr#ModifyClusterInput": { "type": "structure", "members": { + "StepConcurrencyLevel": { + "target": "com.amazonaws.emr#Integer", + "traits": { + "smithy.api#documentation": "

The number of steps that can be executed concurrently. You can specify a maximum of 256 steps.

" + } + }, "ClusterId": { "target": "com.amazonaws.emr#String", "traits": { "smithy.api#documentation": "

The unique identifier of the cluster.

", "smithy.api#required": {} } - }, - "StepConcurrencyLevel": { - "target": "com.amazonaws.emr#Integer", - "traits": { - "smithy.api#documentation": "

The number of steps that can be executed concurrently. You can specify a maximum of 256 steps.

" - } } } }, @@ -4499,17 +4675,17 @@ "com.amazonaws.emr#ModifyInstanceFleetInput": { "type": "structure", "members": { - "ClusterId": { - "target": "com.amazonaws.emr#ClusterId", + "InstanceFleet": { + "target": "com.amazonaws.emr#InstanceFleetModifyConfig", "traits": { - "smithy.api#documentation": "

The unique identifier of the cluster.

", + "smithy.api#documentation": "

The unique identifier of the instance fleet.

", "smithy.api#required": {} } }, - "InstanceFleet": { - "target": "com.amazonaws.emr#InstanceFleetModifyConfig", + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

The unique identifier of the instance fleet.

", + "smithy.api#documentation": "

The unique identifier of the cluster.

", "smithy.api#required": {} } } @@ -4541,27 +4717,210 @@ "InstanceGroups": { "target": "com.amazonaws.emr#InstanceGroupModifyConfigList", "traits": { - "smithy.api#documentation": "

Instance groups to change.

" + "smithy.api#documentation": "

Instance groups to change.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Change the size of some instance groups.

" + } + }, + "com.amazonaws.emr#NewSupportedProductsList": { + "type": "list", + "member": { + "target": "com.amazonaws.emr#SupportedProductConfig" + } + }, + "com.amazonaws.emr#NonNegativeDouble": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0.0 + } + } + }, + "com.amazonaws.emr#NotebookExecution": { + "type": "structure", + "members": { + "EndTime": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "

The timestamp when notebook execution ended.

" + } + }, + "Arn": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notebook execution.

" + } + }, + "NotebookInstanceSecurityGroupId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the EC2 security group associated with the EMR Notebook instance. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.

" + } + }, + "NotebookExecutionId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of a notebook execution.

" + } + }, + "EditorId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the EMR Notebook that is used for the notebook execution.

" + } + }, + "ExecutionEngine": { + "target": "com.amazonaws.emr#ExecutionEngineConfig", + "traits": { + "smithy.api#documentation": "

The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.

" + } + }, + "Status": { + "target": "com.amazonaws.emr#NotebookExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the notebook execution.

\n " + } + }, + "LastStateChangeReason": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The reason for the latest status change of the notebook execution.

" + } + }, + "OutputNotebookURI": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The location of the notebook execution's output file in Amazon S3.

" + } + }, + "NotebookParams": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

Input parameters in JSON format passed to the EMR Notebook at runtime for execution.

" + } + }, + "NotebookExecutionName": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

A name for the notebook execution.

" + } + }, + "Tags": { + "target": "com.amazonaws.emr#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags associated with a notebook execution. Tags are user-defined key value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

" + } + }, + "StartTime": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "

The timestamp when notebook execution started.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A notebook execution. An execution is a specific instance that an EMR Notebook is run using the StartNotebookExecution action.

" + } + }, + "com.amazonaws.emr#NotebookExecutionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "START_PENDING", + "name": "START_PENDING" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "FINISHING", + "name": "FINISHING" + }, + { + "value": "FINISHED", + "name": "FINISHED" + }, + { + "value": "FAILING", + "name": "FAILING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "STOP_PENDING", + "name": "STOP_PENDING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.emr#NotebookExecutionSummary": { + "type": "structure", + "members": { + "NotebookExecutionName": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The name of the notebook execution.

" + } + }, + "EditorId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the editor associated with the notebook execution.

" + } + }, + "NotebookExecutionId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the notebook execution.

" + } + }, + "StartTime": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "

The timestamp when notebook execution started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "

The timestamp when notebook execution started.

" + } + }, + "Status": { + "target": "com.amazonaws.emr#NotebookExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the notebook execution.

\n " } } }, "traits": { - "smithy.api#documentation": "

Change the size of some instance groups.

" + "smithy.api#documentation": "

" } }, - "com.amazonaws.emr#NewSupportedProductsList": { + "com.amazonaws.emr#NotebookExecutionSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.emr#SupportedProductConfig" - } - }, - "com.amazonaws.emr#NonNegativeDouble": { - "type": "double", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 0.0 - } + "target": "com.amazonaws.emr#NotebookExecutionSummary" } }, "com.amazonaws.emr#OnDemandProvisioningAllocationStrategy": { @@ -4599,6 +4958,56 @@ } } }, + "com.amazonaws.emr#PlacementGroupConfig": { + "type": "structure", + "members": { + "InstanceRole": { + "target": "com.amazonaws.emr#InstanceRoleType", + "traits": { + "smithy.api#documentation": "

Role of the instance in the cluster.

\n

Starting with Amazon EMR version 5.23.0, the only supported instance role is MASTER.

", + "smithy.api#required": {} + } + }, + "PlacementStrategy": { + "target": "com.amazonaws.emr#PlacementGroupStrategy", + "traits": { + "smithy.api#documentation": "

EC2 Placement Group strategy associated with instance role.

\n

Starting with Amazon EMR version 5.23.0, the only supported placement strategy is SPREAD for the MASTER instance role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.

\n

To use this configuration, consider attaching managed policy AmazonElasticMapReducePlacementGroupPolicy to the EMR role.

" + } + }, + "com.amazonaws.emr#PlacementGroupConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.emr#PlacementGroupConfig" + } + }, + "com.amazonaws.emr#PlacementGroupStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SPREAD", + "name": "SPREAD" + }, + { + "value": "PARTITION", + "name": "PARTITION" + }, + { + "value": "CLUSTER", + "name": "CLUSTER" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.emr#PlacementType": { "type": "structure", "members": { @@ -4624,7 +5033,7 @@ "traits": { "smithy.api#box": {}, "smithy.api#range": { - "min": 0, + "min": -1, "max": 65535 } } @@ -4632,17 +5041,17 @@ "com.amazonaws.emr#PortRange": { "type": "structure", "members": { - "MaxRange": { + "MinRange": { "target": "com.amazonaws.emr#Port", "traits": { - "smithy.api#documentation": "

The smallest port number in a specified range of port numbers.

" + "smithy.api#documentation": "

The smallest port number in a specified range of port numbers.

", + "smithy.api#required": {} } }, - "MinRange": { + "MaxRange": { "target": "com.amazonaws.emr#Port", "traits": { - "smithy.api#documentation": "

The smallest port number in a specified range of port numbers.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The smallest port number in a specified range of port numbers.

" } } }, @@ -4671,10 +5080,10 @@ "com.amazonaws.emr#PutAutoScalingPolicyInput": { "type": "structure", "members": { - "InstanceGroupId": { - "target": "com.amazonaws.emr#InstanceGroupId", + "AutoScalingPolicy": { + "target": "com.amazonaws.emr#AutoScalingPolicy", "traits": { - "smithy.api#documentation": "

Specifies the ID of the instance group to which the automatic scaling policy is applied.

", + "smithy.api#documentation": "

Specifies the definition of the automatic scaling policy.

", "smithy.api#required": {} } }, @@ -4685,10 +5094,10 @@ "smithy.api#required": {} } }, - "AutoScalingPolicy": { - "target": "com.amazonaws.emr#AutoScalingPolicy", + "InstanceGroupId": { + "target": "com.amazonaws.emr#InstanceGroupId", "traits": { - "smithy.api#documentation": "

Specifies the definition of the automatic scaling policy.

", + "smithy.api#documentation": "

Specifies the ID of the instance group to which the automatic scaling policy is applied.

", "smithy.api#required": {} } } @@ -4703,18 +5112,18 @@ "smithy.api#documentation": "

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

" } }, - "InstanceGroupId": { - "target": "com.amazonaws.emr#InstanceGroupId", - "traits": { - "smithy.api#documentation": "

Specifies the ID of the instance group to which the scaling policy is applied.

" - } - }, "ClusterArn": { "target": "com.amazonaws.emr#ArnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name of the cluster.

" } }, + "InstanceGroupId": { + "target": "com.amazonaws.emr#InstanceGroupId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the instance group to which the scaling policy is applied.

" + } + }, "AutoScalingPolicy": { "target": "com.amazonaws.emr#AutoScalingPolicyDescription", "traits": { @@ -4774,17 +5183,17 @@ "com.amazonaws.emr#PutManagedScalingPolicyInput": { "type": "structure", "members": { - "ManagedScalingPolicy": { - "target": "com.amazonaws.emr#ManagedScalingPolicy", + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

\n Specifies the constraints for the managed scaling policy.\n

", + "smithy.api#documentation": "

\n Specifies the ID of an EMR cluster where the managed scaling policy is attached.\n

", "smithy.api#required": {} } }, - "ClusterId": { - "target": "com.amazonaws.emr#ClusterId", + "ManagedScalingPolicy": { + "target": "com.amazonaws.emr#ManagedScalingPolicy", "traits": { - "smithy.api#documentation": "

\n Specifies the ID of an EMR cluster where the managed scaling policy is attached.\n

", + "smithy.api#documentation": "

\n Specifies the constraints for the managed scaling policy.\n

", "smithy.api#required": {} } } @@ -4809,17 +5218,17 @@ "com.amazonaws.emr#RemoveAutoScalingPolicyInput": { "type": "structure", "members": { - "ClusterId": { - "target": "com.amazonaws.emr#ClusterId", + "InstanceGroupId": { + "target": "com.amazonaws.emr#InstanceGroupId", "traits": { - "smithy.api#documentation": "

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

", + "smithy.api#documentation": "

Specifies the ID of the instance group to which the scaling policy is applied.

", "smithy.api#required": {} } }, - "InstanceGroupId": { - "target": "com.amazonaws.emr#InstanceGroupId", + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

Specifies the ID of the instance group to which the scaling policy is applied.

", + "smithy.api#documentation": "

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

", "smithy.api#required": {} } } @@ -4944,22 +5353,46 @@ "com.amazonaws.emr#RunJobFlowInput": { "type": "structure", "members": { - "LogEncryptionKmsKeyId": { - "target": "com.amazonaws.emr#XmlString", + "Tags": { + "target": "com.amazonaws.emr#TagList", "traits": { - "smithy.api#documentation": "

The AWS KMS customer master key (CMK) used for encrypting log files. If a value is not provided, the logs will remain encrypted by AES-256. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" + "smithy.api#documentation": "

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

" } }, - "KerberosAttributes": { - "target": "com.amazonaws.emr#KerberosAttributes", + "StepConcurrencyLevel": { + "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

" + "smithy.api#documentation": "

Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.

" } }, - "AdditionalInfo": { + "SupportedProducts": { + "target": "com.amazonaws.emr#SupportedProductsList", + "traits": { + "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

\n \n

A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:

\n " + } + }, + "ManagedScalingPolicy": { + "target": "com.amazonaws.emr#ManagedScalingPolicy", + "traits": { + "smithy.api#documentation": "

\n The specified managed scaling policy for an Amazon EMR cluster. \n

" + } + }, + "JobFlowRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

A JSON string for selecting additional features.

" + "smithy.api#documentation": "

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

" + } + }, + "ReleaseLabel": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

" + } + }, + "Configurations": { + "target": "com.amazonaws.emr#ConfigurationList", + "traits": { + "smithy.api#documentation": "

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

" } }, "CustomAmiId": { @@ -4968,10 +5401,22 @@ "smithy.api#documentation": "

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

\n

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.

" } }, - "AutoScalingRole": { - "target": "com.amazonaws.emr#XmlString", + "BootstrapActions": { + "target": "com.amazonaws.emr#BootstrapActionConfigList", "traits": { - "smithy.api#documentation": "

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" + "smithy.api#documentation": "

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

" + } + }, + "PlacementGroupConfigs": { + "target": "com.amazonaws.emr#PlacementGroupConfigList", + "traits": { + "smithy.api#documentation": "

The specified placement group configuration for an Amazon EMR cluster.

" + } + }, + "EbsRootVolumeSize": { + "target": "com.amazonaws.emr#Integer", + "traits": { + "smithy.api#documentation": "

The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

" } }, "Applications": { @@ -4986,52 +5431,52 @@ "smithy.api#documentation": "

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, - "AmiVersion": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "NewSupportedProducts": { + "target": "com.amazonaws.emr#NewSupportedProductsList", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

" + "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

\n \n

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported values are:

\n " } }, - "Tags": { - "target": "com.amazonaws.emr#TagList", + "VisibleToAllUsers": { + "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

" + "smithy.api#documentation": "

A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.

" } }, - "ServiceRole": { + "LogUri": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + "smithy.api#documentation": "

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

" } }, - "LogUri": { + "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

" + "smithy.api#documentation": "

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" } }, - "ManagedScalingPolicy": { - "target": "com.amazonaws.emr#ManagedScalingPolicy", + "SecurityConfiguration": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

\n The specified managed scaling policy for an Amazon EMR cluster. \n

" + "smithy.api#documentation": "

The name of a security configuration to apply to the cluster.

" } }, - "Configurations": { - "target": "com.amazonaws.emr#ConfigurationList", + "AutoScalingRole": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

" + "smithy.api#documentation": "

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" } }, - "ReleaseLabel": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", + "RepoUpgradeOnBoot": { + "target": "com.amazonaws.emr#RepoUpgradeOnBoot", "traits": { - "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

" + "smithy.api#documentation": "

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

" } }, - "SupportedProducts": { - "target": "com.amazonaws.emr#SupportedProductsList", + "LogEncryptionKmsKeyId": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

\n \n

A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:

\n " + "smithy.api#documentation": "

The AWS KMS customer master key (CMK) used for encrypting log files. If a value is not provided, the logs will remain encrypted by AES-256. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" } }, "Steps": { @@ -5040,10 +5485,10 @@ "smithy.api#documentation": "

A list of steps to run.

" } }, - "BootstrapActions": { - "target": "com.amazonaws.emr#BootstrapActionConfigList", + "KerberosAttributes": { + "target": "com.amazonaws.emr#KerberosAttributes", "traits": { - "smithy.api#documentation": "

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

" + "smithy.api#documentation": "

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

" } }, "Name": { @@ -5053,16 +5498,16 @@ "smithy.api#required": {} } }, - "StepConcurrencyLevel": { - "target": "com.amazonaws.emr#Integer", + "AmiVersion": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.

" + "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

" } }, - "EbsRootVolumeSize": { - "target": "com.amazonaws.emr#Integer", + "AdditionalInfo": { + "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

" + "smithy.api#documentation": "

A JSON string for selecting additional features.

" } }, "Instances": { @@ -5071,36 +5516,6 @@ "smithy.api#documentation": "

A specification of the number and type of Amazon EC2 instances.

", "smithy.api#required": {} } - }, - "VisibleToAllUsers": { - "target": "com.amazonaws.emr#Boolean", - "traits": { - "smithy.api#documentation": "

A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.

" - } - }, - "NewSupportedProducts": { - "target": "com.amazonaws.emr#NewSupportedProductsList", - "traits": { - "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

\n \n

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported values are:

\n " - } - }, - "SecurityConfiguration": { - "target": "com.amazonaws.emr#XmlString", - "traits": { - "smithy.api#documentation": "

The name of a security configuration to apply to the cluster.

" - } - }, - "JobFlowRole": { - "target": "com.amazonaws.emr#XmlString", - "traits": { - "smithy.api#documentation": "

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

" - } - }, - "RepoUpgradeOnBoot": { - "target": "com.amazonaws.emr#RepoUpgradeOnBoot", - "traits": { - "smithy.api#documentation": "

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

" - } } }, "traits": { @@ -5188,6 +5603,12 @@ "com.amazonaws.emr#ScalingRule": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "

A friendly, more verbose description of the automatic scaling rule.

" + } + }, "Trigger": { "target": "com.amazonaws.emr#ScalingTrigger", "traits": { @@ -5202,12 +5623,6 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.emr#String", - "traits": { - "smithy.api#documentation": "

A friendly, more verbose description of the automatic scaling rule.

" - } - }, "Action": { "target": "com.amazonaws.emr#ScalingAction", "traits": { @@ -5244,18 +5659,18 @@ "com.amazonaws.emr#ScriptBootstrapActionConfig": { "type": "structure", "members": { - "Args": { - "target": "com.amazonaws.emr#XmlStringList", - "traits": { - "smithy.api#documentation": "

A list of command line arguments to pass to the bootstrap action script.

" - } - }, "Path": { "target": "com.amazonaws.emr#XmlString", "traits": { "smithy.api#documentation": "

Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.

", "smithy.api#required": {} } + }, + "Args": { + "target": "com.amazonaws.emr#XmlStringList", + "traits": { + "smithy.api#documentation": "

A list of command line arguments to pass to the bootstrap action script.

" + } } }, "traits": { @@ -5369,17 +5784,17 @@ "com.amazonaws.emr#ShrinkPolicy": { "type": "structure", "members": { - "InstanceResizePolicy": { - "target": "com.amazonaws.emr#InstanceResizePolicy", - "traits": { - "smithy.api#documentation": "

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

" - } - }, "DecommissionTimeout": { "target": "com.amazonaws.emr#Integer", "traits": { "smithy.api#documentation": "

The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.

" } + }, + "InstanceResizePolicy": { + "target": "com.amazonaws.emr#InstanceResizePolicy", + "traits": { + "smithy.api#documentation": "

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

" + } } }, "traits": { @@ -5427,30 +5842,30 @@ "com.amazonaws.emr#SpotProvisioningSpecification": { "type": "structure", "members": { - "TimeoutAction": { - "target": "com.amazonaws.emr#SpotProvisioningTimeoutAction", + "TimeoutDurationMinutes": { + "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

", + "smithy.api#documentation": "

The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

", "smithy.api#required": {} } }, - "BlockDurationMinutes": { - "target": "com.amazonaws.emr#WholeNumber", + "AllocationStrategy": { + "target": "com.amazonaws.emr#SpotProvisioningAllocationStrategy", "traits": { - "smithy.api#documentation": "

The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.\n

" + "smithy.api#documentation": "

\n Specifies the strategy to use in launching Spot instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot instance pools with optimal capacity for the number of instances that are launching. \n

" } }, - "TimeoutDurationMinutes": { - "target": "com.amazonaws.emr#WholeNumber", + "TimeoutAction": { + "target": "com.amazonaws.emr#SpotProvisioningTimeoutAction", "traits": { - "smithy.api#documentation": "

The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

", + "smithy.api#documentation": "

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

", "smithy.api#required": {} } }, - "AllocationStrategy": { - "target": "com.amazonaws.emr#SpotProvisioningAllocationStrategy", + "BlockDurationMinutes": { + "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

\n Specifies the strategy to use in launching Spot instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot instance pools with optimal capacity for the number of instances that are launching. \n

" + "smithy.api#documentation": "

The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.\n

" } } }, @@ -5471,6 +5886,94 @@ ] } }, + "com.amazonaws.emr#StartNotebookExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#StartNotebookExecutionInput" + }, + "output": { + "target": "com.amazonaws.emr#StartNotebookExecutionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.emr#InternalServerException" + }, + { + "target": "com.amazonaws.emr#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a notebook execution.

" + } + }, + "com.amazonaws.emr#StartNotebookExecutionInput": { + "type": "structure", + "members": { + "ServiceRole": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook execution.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.emr#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags associated with a notebook execution. Tags are user-defined key value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

" + } + }, + "NotebookExecutionName": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

An optional name for the notebook execution.

" + } + }, + "RelativePath": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

The path and file name of the notebook file for this execution, relative to the path specified for the EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb.

", + "smithy.api#required": {} + } + }, + "NotebookParams": { + "target": "com.amazonaws.emr#XmlString", + "traits": { + "smithy.api#documentation": "

Input parameters in JSON format passed to the EMR Notebook at runtime for execution.

" + } + }, + "ExecutionEngine": { + "target": "com.amazonaws.emr#ExecutionEngineConfig", + "traits": { + "smithy.api#documentation": "

Specifies the execution engine (cluster) that runs the notebook execution.

", + "smithy.api#required": {} + } + }, + "EditorId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the EMR Notebook to use for notebook execution.

", + "smithy.api#required": {} + } + }, + "NotebookInstanceSecurityGroupId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for this notebook execution.

" + } + } + } + }, + "com.amazonaws.emr#StartNotebookExecutionOutput": { + "type": "structure", + "members": { + "NotebookExecutionId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the notebook execution.

" + } + } + } + }, "com.amazonaws.emr#Statistic": { "type": "string", "traits": { @@ -5501,6 +6004,12 @@ "com.amazonaws.emr#Step": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.emr#StepId", + "traits": { + "smithy.api#documentation": "

The identifier of the cluster step.

" + } + }, "Config": { "target": "com.amazonaws.emr#HadoopStepConfig", "traits": { @@ -5524,12 +6033,6 @@ "traits": { "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" } - }, - "Id": { - "target": "com.amazonaws.emr#StepId", - "traits": { - "smithy.api#documentation": "

The identifier of the cluster step.

" - } } }, "traits": { @@ -5552,6 +6055,12 @@ "com.amazonaws.emr#StepConfig": { "type": "structure", "members": { + "ActionOnFailure": { + "target": "com.amazonaws.emr#ActionOnFailure", + "traits": { + "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" + } + }, "HadoopJarStep": { "target": "com.amazonaws.emr#HadoopJarStepConfig", "traits": { @@ -5559,12 +6068,6 @@ "smithy.api#required": {} } }, - "ActionOnFailure": { - "target": "com.amazonaws.emr#ActionOnFailure", - "traits": { - "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" - } - }, "Name": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { @@ -5586,17 +6089,17 @@ "com.amazonaws.emr#StepDetail": { "type": "structure", "members": { - "ExecutionStatusDetail": { - "target": "com.amazonaws.emr#StepExecutionStatusDetail", + "StepConfig": { + "target": "com.amazonaws.emr#StepConfig", "traits": { - "smithy.api#documentation": "

The description of the step status.

", + "smithy.api#documentation": "

The step configuration.

", "smithy.api#required": {} } }, - "StepConfig": { - "target": "com.amazonaws.emr#StepConfig", + "ExecutionStatusDetail": { + "target": "com.amazonaws.emr#StepExecutionStatusDetail", "traits": { - "smithy.api#documentation": "

The step configuration.

", + "smithy.api#documentation": "

The description of the step status.

", "smithy.api#required": {} } } @@ -5642,6 +6145,13 @@ "com.amazonaws.emr#StepExecutionStatusDetail": { "type": "structure", "members": { + "State": { + "target": "com.amazonaws.emr#StepExecutionState", + "traits": { + "smithy.api#documentation": "

The state of the step.

", + "smithy.api#required": {} + } + }, "StartDateTime": { "target": "com.amazonaws.emr#Date", "traits": { @@ -5660,13 +6170,6 @@ "smithy.api#documentation": "

A description of the step's current state.

" } }, - "State": { - "target": "com.amazonaws.emr#StepExecutionState", - "traits": { - "smithy.api#documentation": "

The state of the step.

", - "smithy.api#required": {} - } - }, "CreationDateTime": { "target": "com.amazonaws.emr#Date", "traits": { @@ -5768,18 +6271,18 @@ "smithy.api#documentation": "

The reason for the step execution status change.

" } }, - "State": { - "target": "com.amazonaws.emr#StepState", - "traits": { - "smithy.api#documentation": "

The execution state of the cluster step.

" - } - }, "Timeline": { "target": "com.amazonaws.emr#StepTimeline", "traits": { "smithy.api#documentation": "

The timeline of the cluster step status over time.

" } }, + "State": { + "target": "com.amazonaws.emr#StepState", + "traits": { + "smithy.api#documentation": "

The execution state of the cluster step.

" + } + }, "FailureDetails": { "target": "com.amazonaws.emr#FailureDetails", "traits": { @@ -5794,30 +6297,30 @@ "com.amazonaws.emr#StepSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.emr#StepStatus", - "traits": { - "smithy.api#documentation": "

The current execution status details of the cluster step.

" - } - }, - "ActionOnFailure": { - "target": "com.amazonaws.emr#ActionOnFailure", - "traits": { - "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" - } - }, "Config": { "target": "com.amazonaws.emr#HadoopStepConfig", "traits": { "smithy.api#documentation": "

The Hadoop job configuration of the cluster step.

" } }, + "Status": { + "target": "com.amazonaws.emr#StepStatus", + "traits": { + "smithy.api#documentation": "

The current execution status details of the cluster step.

" + } + }, "Name": { "target": "com.amazonaws.emr#String", "traits": { "smithy.api#documentation": "

The name of the cluster step.

" } }, + "ActionOnFailure": { + "target": "com.amazonaws.emr#ActionOnFailure", + "traits": { + "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" + } + }, "Id": { "target": "com.amazonaws.emr#StepId", "traits": { @@ -5838,12 +6341,6 @@ "com.amazonaws.emr#StepTimeline": { "type": "structure", "members": { - "StartDateTime": { - "target": "com.amazonaws.emr#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the cluster step execution started.

" - } - }, "EndDateTime": { "target": "com.amazonaws.emr#Date", "traits": { @@ -5855,12 +6352,47 @@ "traits": { "smithy.api#documentation": "

The date and time when the cluster step was created.

" } + }, + "StartDateTime": { + "target": "com.amazonaws.emr#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the cluster step execution started.

" + } } }, "traits": { "smithy.api#documentation": "

The timeline of the cluster step lifecycle.

" } }, + "com.amazonaws.emr#StopNotebookExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#StopNotebookExecutionInput" + }, + "errors": [ + { + "target": "com.amazonaws.emr#InternalServerError" + }, + { + "target": "com.amazonaws.emr#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a notebook execution.

" + } + }, + "com.amazonaws.emr#StopNotebookExecutionInput": { + "type": "structure", + "members": { + "NotebookExecutionId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the notebook execution.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.emr#String": { "type": "string" }, @@ -5882,17 +6414,17 @@ "com.amazonaws.emr#SupportedProductConfig": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.emr#XmlStringMaxLen256", - "traits": { - "smithy.api#documentation": "

The name of the product configuration.

" - } - }, "Args": { "target": "com.amazonaws.emr#XmlStringList", "traits": { "smithy.api#documentation": "

The list of user-supplied arguments.

" } + }, + "Name": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The name of the product configuration.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/eventbridge.2015-10-07.json b/codegen/sdk-codegen/aws-models/eventbridge.2015-10-07.json index 7332a849a42d..e438f683e244 100644 --- a/codegen/sdk-codegen/aws-models/eventbridge.2015-10-07.json +++ b/codegen/sdk-codegen/aws-models/eventbridge.2015-10-07.json @@ -132,7 +132,7 @@ "sdkId": "EventBridge", "arnNamespace": "events", "cloudFormationName": "Events", - "cloudTrailEventSource": "v20151007.jetstream.amazon.com" + "cloudTrailEventSource": "eventbridge.amazonaws.com" }, "aws.auth#sigv4": { "name": "events" @@ -230,10 +230,11 @@ "com.amazonaws.eventbridge#AwsVpcConfiguration": { "type": "structure", "members": { - "AssignPublicIp": { - "target": "com.amazonaws.eventbridge#AssignPublicIp", + "Subnets": { + "target": "com.amazonaws.eventbridge#StringList", "traits": { - "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address.\n You can specify ENABLED only when LaunchType in\n EcsParameters is set to FARGATE.

" + "smithy.api#documentation": "

Specifies the subnets associated with the task. These subnets must all be in the same\n VPC. You can specify as many as 16 subnets.

", + "smithy.api#required": {} } }, "SecurityGroups": { @@ -242,11 +243,10 @@ "smithy.api#documentation": "

Specifies the security groups associated with the task. These security groups must all\n be in the same VPC. You can specify as many as five security groups. If you do not\n specify a security group, the default security group for the VPC is used.

" } }, - "Subnets": { - "target": "com.amazonaws.eventbridge#StringList", + "AssignPublicIp": { + "target": "com.amazonaws.eventbridge#AssignPublicIp", "traits": { - "smithy.api#documentation": "

Specifies the subnets associated with the task. These subnets must all be in the same\n VPC. You can specify as many as 16 subnets.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address.\n You can specify ENABLED only when LaunchType in\n EcsParameters is set to FARGATE.

" } } }, @@ -271,10 +271,11 @@ "com.amazonaws.eventbridge#BatchParameters": { "type": "structure", "members": { - "ArrayProperties": { - "target": "com.amazonaws.eventbridge#BatchArrayProperties", + "JobName": { + "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The\n array size can be between 2 and 10,000. If you specify array properties for a job, it\n becomes an array job. This parameter is used only if the target is an AWS Batch\n job.

" + "smithy.api#documentation": "

The name to use for this execution of the job, if the target is an AWS Batch\n job.

", + "smithy.api#required": {} } }, "JobDefinition": { @@ -284,11 +285,10 @@ "smithy.api#required": {} } }, - "JobName": { - "target": "com.amazonaws.eventbridge#String", + "ArrayProperties": { + "target": "com.amazonaws.eventbridge#BatchArrayProperties", "traits": { - "smithy.api#documentation": "

The name to use for this execution of the job, if the target is an AWS Batch\n job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The\n array size can be between 2 and 10,000. If you specify array properties for a job, it\n becomes an array job. This parameter is used only if the target is an AWS Batch\n job.

" } }, "RetryStrategy": { @@ -334,24 +334,24 @@ "com.amazonaws.eventbridge#Condition": { "type": "structure", "members": { - "Type": { + "Value": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

Specifies the type of condition. Currently the only supported value is\n StringEquals.

", + "smithy.api#documentation": "

Specifies the value for the key. Currently, this must be the ID of the\n organization.

", "smithy.api#required": {} } }, - "Value": { + "Key": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

Specifies the value for the key. Currently, this must be the ID of the\n organization.

", + "smithy.api#documentation": "

Specifies the key for the condition. Currently the only supported key is\n aws:PrincipalOrgID.

", "smithy.api#required": {} } }, - "Key": { + "Type": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

Specifies the key for the condition. Currently the only supported key is\n aws:PrincipalOrgID.

", + "smithy.api#documentation": "

Specifies the type of condition. Currently the only supported value is\n StringEquals.

", "smithy.api#required": {} } } @@ -404,18 +404,18 @@ "smithy.api#documentation": "

If you are creating a partner event bus, this specifies the partner event source that\n the new event bus will be matched with.

" } }, + "Tags": { + "target": "com.amazonaws.eventbridge#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the event bus.

" + } + }, "Name": { "target": "com.amazonaws.eventbridge#EventBusName", "traits": { "smithy.api#documentation": "

The name of the new event bus.

\n

Event bus names cannot contain the / character. You can't use the name\n default for a custom event bus, as this name is already used for your\n account's default event bus.

\n

If this is a partner event bus, the name must exactly match the name of the partner\n event source that this event bus is matched to.

", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.eventbridge#TagList", - "traits": { - "smithy.api#documentation": "

Tags to associate with the event bus.

" - } } } }, @@ -462,17 +462,17 @@ "com.amazonaws.eventbridge#CreatePartnerEventSourceRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.eventbridge#EventSourceName", + "Account": { + "target": "com.amazonaws.eventbridge#AccountId", "traits": { - "smithy.api#documentation": "

The name of the partner event source. This name must be unique and must be in the\n format\n \n partner_name/event_namespace/event_name\n .\n The AWS account that wants to use this partner event source must create a partner event\n bus with a name that matches the name of the partner event source.

", + "smithy.api#documentation": "

The AWS account ID that is permitted to create a matching partner event bus for this\n partner event source.

", "smithy.api#required": {} } }, - "Account": { - "target": "com.amazonaws.eventbridge#AccountId", + "Name": { + "target": "com.amazonaws.eventbridge#EventSourceName", "traits": { - "smithy.api#documentation": "

The AWS account ID that is permitted to create a matching partner event bus for this\n partner event source.

", + "smithy.api#documentation": "

The name of the partner event source. This name must be unique and must be in the\n format\n \n partner_name/event_namespace/event_name\n .\n The AWS account that wants to use this partner event source must create a partner event\n bus with a name that matches the name of the partner event source.

", "smithy.api#required": {} } } @@ -489,6 +489,26 @@ } } }, + "com.amazonaws.eventbridge#Database": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "([a-zA-Z0-9]+)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + } + }, + "com.amazonaws.eventbridge#DbUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "([a-zA-Z0-9]+)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + } + }, "com.amazonaws.eventbridge#DeactivateEventSource": { "type": "operation", "input": { @@ -527,6 +547,20 @@ } } }, + "com.amazonaws.eventbridge#DeadLetterConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.eventbridge#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SQS queue specified as the target for the dead-letter queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

" + } + }, "com.amazonaws.eventbridge#DeleteEventBus": { "type": "operation", "input": { @@ -621,6 +655,12 @@ "com.amazonaws.eventbridge#DeleteRuleRequest": { "type": "structure", "members": { + "Force": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to delete the rule. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed\n rule by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" + } + }, "EventBusName": { "target": "com.amazonaws.eventbridge#EventBusName", "traits": { @@ -633,12 +673,6 @@ "smithy.api#documentation": "

The name of the rule.

", "smithy.api#required": {} } - }, - "Force": { - "target": "com.amazonaws.eventbridge#Boolean", - "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to delete the rule. This parameter is\n ignored for rules that are not managed rules. You can check whether a rule is a managed\n rule by using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" - } } } }, @@ -676,16 +710,16 @@ "com.amazonaws.eventbridge#DescribeEventBusResponse": { "type": "structure", "members": { - "Name": { + "Arn": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The name of the event bus. Currently, this is always\n default.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account permitted to write events to the\n current account.

" } }, - "Arn": { + "Name": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account permitted to write events to the\n current account.

" + "smithy.api#documentation": "

The name of the event bus. Currently, this is always\n default.

" } }, "Policy": { @@ -734,10 +768,16 @@ "com.amazonaws.eventbridge#DescribeEventSourceResponse": { "type": "structure", "members": { - "CreatedBy": { + "ExpirationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source will expire if you do not create a matching\n event bus.

" + } + }, + "Arn": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The name of the SaaS partner that created the event source.

" + "smithy.api#documentation": "

The ARN of the partner event source.

" } }, "Name": { @@ -746,16 +786,16 @@ "smithy.api#documentation": "

The name of the partner event source.

" } }, - "ExpirationTime": { + "CreationTime": { "target": "com.amazonaws.eventbridge#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire if you do not create a matching\n event bus.

" + "smithy.api#documentation": "

The date and time that the event source was created.

" } }, - "Arn": { + "CreatedBy": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The ARN of the partner event source.

" + "smithy.api#documentation": "

The name of the SaaS partner that created the event source.

" } }, "State": { @@ -763,12 +803,6 @@ "traits": { "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching\n event bus for this event source, and that event bus is active. If it is PENDING, either\n you haven't yet created a matching event bus, or that event bus is deactivated. If it is\n DELETED, you have created a matching event bus, but the event source has since been\n deleted.

" } - }, - "CreationTime": { - "target": "com.amazonaws.eventbridge#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the event source was created.

" - } } } }, @@ -847,40 +881,34 @@ "com.amazonaws.eventbridge#DescribeRuleRequest": { "type": "structure", "members": { - "EventBusName": { - "target": "com.amazonaws.eventbridge#EventBusName", - "traits": { - "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" - } - }, "Name": { "target": "com.amazonaws.eventbridge#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

", "smithy.api#required": {} } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" + } } } }, "com.amazonaws.eventbridge#DescribeRuleResponse": { "type": "structure", "members": { - "ScheduleExpression": { - "target": "com.amazonaws.eventbridge#ScheduleExpression", - "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" - } - }, - "Name": { - "target": "com.amazonaws.eventbridge#RuleName", + "State": { + "target": "com.amazonaws.eventbridge#RuleState", "traits": { - "smithy.api#documentation": "

The name of the rule.

" + "smithy.api#documentation": "

Specifies whether the rule is enabled or disabled.

" } }, - "RoleArn": { - "target": "com.amazonaws.eventbridge#RoleArn", + "ManagedBy": { + "target": "com.amazonaws.eventbridge#ManagedBy", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, this field\n displays the principal name of the AWS service that created the rule.

" } }, "EventBusName": { @@ -889,16 +917,22 @@ "smithy.api#documentation": "

The event bus associated with the rule.

" } }, - "State": { - "target": "com.amazonaws.eventbridge#RuleState", + "Description": { + "target": "com.amazonaws.eventbridge#RuleDescription", "traits": { - "smithy.api#documentation": "

Specifies whether the rule is enabled or disabled.

" + "smithy.api#documentation": "

The description of the rule.

" } }, - "Arn": { - "target": "com.amazonaws.eventbridge#RuleArn", + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + } + }, + "Name": { + "target": "com.amazonaws.eventbridge#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

" } }, "EventPattern": { @@ -907,16 +941,16 @@ "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

" } }, - "ManagedBy": { - "target": "com.amazonaws.eventbridge#ManagedBy", + "Arn": { + "target": "com.amazonaws.eventbridge#RuleArn", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, this field\n displays the principal name of the AWS service that created the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" } }, - "Description": { - "target": "com.amazonaws.eventbridge#RuleDescription", + "ScheduleExpression": { + "target": "com.amazonaws.eventbridge#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The description of the rule.

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" } } } @@ -965,16 +999,16 @@ "com.amazonaws.eventbridge#EcsParameters": { "type": "structure", "members": { - "Group": { - "target": "com.amazonaws.eventbridge#String", + "NetworkConfiguration": { + "target": "com.amazonaws.eventbridge#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

Specifies an ECS task group for the task. The maximum length is 255 characters.

" + "smithy.api#documentation": "

Use this structure if the ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and\n whether a public IP address is to be used. This structure is required if\n LaunchType is FARGATE because the awsvpc mode\n is required for Fargate tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use\n the awsvpc network mode, the task fails.

" } }, - "TaskCount": { - "target": "com.amazonaws.eventbridge#LimitMin1", + "Group": { + "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is\n 1.

" + "smithy.api#documentation": "

Specifies an ECS task group for the task. The maximum length is 255 characters.

" } }, "PlatformVersion": { @@ -983,10 +1017,10 @@ "smithy.api#documentation": "

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For\n more information about valid platform versions, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

" } }, - "NetworkConfiguration": { - "target": "com.amazonaws.eventbridge#NetworkConfiguration", + "TaskCount": { + "target": "com.amazonaws.eventbridge#LimitMin1", "traits": { - "smithy.api#documentation": "

Use this structure if the ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and\n whether a public IP address is to be used. This structure is required if\n LaunchType is FARGATE because the awsvpc mode\n is required for Fargate tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use\n the awsvpc network mode, the task fails.

" + "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is\n 1.

" } }, "TaskDefinitionArn": { @@ -1057,16 +1091,16 @@ "com.amazonaws.eventbridge#EventBus": { "type": "structure", "members": { - "Arn": { + "Name": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The ARN of the event bus.

" + "smithy.api#documentation": "

The name of the event bus.

" } }, - "Name": { + "Arn": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The name of the event bus.

" + "smithy.api#documentation": "

The ARN of the event bus.

" } }, "Policy": { @@ -1114,10 +1148,16 @@ "com.amazonaws.eventbridge#EventSource": { "type": "structure", "members": { - "Name": { + "Arn": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The name of the event source.

" + "smithy.api#documentation": "

The ARN of the event source.

" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" } }, "State": { @@ -1132,22 +1172,16 @@ "smithy.api#documentation": "

The name of the partner that created the event source.

" } }, - "CreationTime": { - "target": "com.amazonaws.eventbridge#Timestamp", + "Name": { + "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The date and time the event source was created.

" + "smithy.api#documentation": "

The name of the event source.

" } }, - "ExpirationTime": { + "CreationTime": { "target": "com.amazonaws.eventbridge#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" - } - }, - "Arn": { - "target": "com.amazonaws.eventbridge#String", - "traits": { - "smithy.api#documentation": "

The ARN of the event source.

" + "smithy.api#documentation": "

The date and time the event source was created.

" } } }, @@ -1235,20 +1269,20 @@ "com.amazonaws.eventbridge#HttpParameters": { "type": "structure", "members": { - "HeaderParameters": { - "target": "com.amazonaws.eventbridge#HeaderParametersMap", - "traits": { - "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST \n API.

" - } - }, "PathParameterValues": { "target": "com.amazonaws.eventbridge#PathParameterList", "traits": { "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API\n path wildcards (\"*\").

" } }, - "QueryStringParameters": { - "target": "com.amazonaws.eventbridge#QueryStringParametersMap", + "HeaderParameters": { + "target": "com.amazonaws.eventbridge#HeaderParametersMap", + "traits": { + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST \n API.

" + } + }, + "QueryStringParameters": { + "target": "com.amazonaws.eventbridge#QueryStringParametersMap", "traits": { "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the \n API Gateway REST API.

" } @@ -1409,6 +1443,12 @@ "com.amazonaws.eventbridge#ListEventBusesRequest": { "type": "structure", "members": { + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", + "traits": { + "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" + } + }, "NamePrefix": { "target": "com.amazonaws.eventbridge#EventBusName", "traits": { @@ -1420,29 +1460,23 @@ "traits": { "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

" } - }, - "Limit": { - "target": "com.amazonaws.eventbridge#LimitMax100", - "traits": { - "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" - } } } }, "com.amazonaws.eventbridge#ListEventBusesResponse": { "type": "structure", "members": { - "EventBuses": { - "target": "com.amazonaws.eventbridge#EventBusList", - "traits": { - "smithy.api#documentation": "

This list of event buses.

" - } - }, "NextToken": { "target": "com.amazonaws.eventbridge#NextToken", "traits": { "smithy.api#documentation": "

A token you can use in a subsequent operation to retrieve the next set of\n results.

" } + }, + "EventBuses": { + "target": "com.amazonaws.eventbridge#EventBusList", + "traits": { + "smithy.api#documentation": "

This list of event buses.

" + } } } }, @@ -1469,10 +1503,10 @@ "com.amazonaws.eventbridge#ListEventSourcesRequest": { "type": "structure", "members": { - "NamePrefix": { - "target": "com.amazonaws.eventbridge#EventSourceNamePrefix", + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", "traits": { - "smithy.api#documentation": "

Specifying this limits the results to only those partner event sources with names that\n start with the specified prefix.

" + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

" } }, "Limit": { @@ -1481,10 +1515,10 @@ "smithy.api#documentation": "

Specifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" } }, - "NextToken": { - "target": "com.amazonaws.eventbridge#NextToken", + "NamePrefix": { + "target": "com.amazonaws.eventbridge#EventSourceNamePrefix", "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

" + "smithy.api#documentation": "

Specifying this limits the results to only those partner event sources with names that\n start with the specified prefix.

" } } } @@ -1532,12 +1566,6 @@ "com.amazonaws.eventbridge#ListPartnerEventSourceAccountsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.eventbridge#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" - } - }, "EventSourceName": { "target": "com.amazonaws.eventbridge#EventSourceName", "traits": { @@ -1545,6 +1573,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" + } + }, "Limit": { "target": "com.amazonaws.eventbridge#LimitMax100", "traits": { @@ -1593,6 +1627,12 @@ "com.amazonaws.eventbridge#ListPartnerEventSourcesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" + } + }, "NamePrefix": { "target": "com.amazonaws.eventbridge#PartnerEventSourceNamePrefix", "traits": { @@ -1605,12 +1645,6 @@ "traits": { "smithy.api#documentation": "

pecifying this limits the number of results returned by this operation. The operation\n also returns a NextToken which you can use in a subsequent operation to retrieve the\n next set of results.

" } - }, - "NextToken": { - "target": "com.amazonaws.eventbridge#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to this operation. Specifying this retrieves the\n next set of results.

" - } } } }, @@ -1654,22 +1688,16 @@ "com.amazonaws.eventbridge#ListRuleNamesByTargetRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.eventbridge#LimitMax100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, "NextToken": { "target": "com.amazonaws.eventbridge#NextToken", "traits": { "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" } }, - "EventBusName": { - "target": "com.amazonaws.eventbridge#EventBusName", + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", "traits": { - "smithy.api#documentation": "

Limits the results to show only the rules associated with the specified event\n bus.

" + "smithy.api#documentation": "

The maximum number of results to return.

" } }, "TargetArn": { @@ -1678,6 +1706,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target resource.

", "smithy.api#required": {} } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

Limits the results to show only the rules associated with the specified event\n bus.

" + } } } }, @@ -1721,10 +1755,10 @@ "com.amazonaws.eventbridge#ListRulesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.eventbridge#NextToken", + "Limit": { + "target": "com.amazonaws.eventbridge#LimitMax100", "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" + "smithy.api#documentation": "

The maximum number of results to return.

" } }, "EventBusName": { @@ -1739,10 +1773,10 @@ "smithy.api#documentation": "

The prefix matching the rule name.

" } }, - "Limit": { - "target": "com.amazonaws.eventbridge#LimitMax100", + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" } } } @@ -1750,17 +1784,17 @@ "com.amazonaws.eventbridge#ListRulesResponse": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.eventbridge#RuleResponseList", - "traits": { - "smithy.api#documentation": "

The rules that match the specified criteria.

" - } - }, "NextToken": { "target": "com.amazonaws.eventbridge#NextToken", "traits": { "smithy.api#documentation": "

Indicates whether there are additional results to retrieve. If there are no more\n results, the value is null.

" } + }, + "Rules": { + "target": "com.amazonaws.eventbridge#RuleResponseList", + "traits": { + "smithy.api#documentation": "

The rules that match the specified criteria.

" + } } } }, @@ -1830,18 +1864,6 @@ "com.amazonaws.eventbridge#ListTargetsByRuleRequest": { "type": "structure", "members": { - "EventBusName": { - "target": "com.amazonaws.eventbridge#EventBusName", - "traits": { - "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" - } - }, - "NextToken": { - "target": "com.amazonaws.eventbridge#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" - } - }, "Rule": { "target": "com.amazonaws.eventbridge#RuleName", "traits": { @@ -1854,23 +1876,35 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return.

" } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of\n results.

" + } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" + } } } }, "com.amazonaws.eventbridge#ListTargetsByRuleResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.eventbridge#NextToken", - "traits": { - "smithy.api#documentation": "

Indicates whether there are additional results to retrieve. If there are no more\n results, the value is null.

" - } - }, "Targets": { "target": "com.amazonaws.eventbridge#TargetList", "traits": { "smithy.api#documentation": "

The targets assigned to the rule.

" } + }, + "NextToken": { + "target": "com.amazonaws.eventbridge#NextToken", + "traits": { + "smithy.api#documentation": "

Indicates whether there are additional results to retrieve. If there are no more\n results, the value is null.

" + } } } }, @@ -1895,6 +1929,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.eventbridge#MaximumEventAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 60, + "max": 86400 + } + } + }, + "com.amazonaws.eventbridge#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 185 + } + } + }, "com.amazonaws.eventbridge#MessageGroupId": { "type": "string" }, @@ -1946,16 +2000,16 @@ "com.amazonaws.eventbridge#PartnerEventSource": { "type": "structure", "members": { - "Name": { + "Arn": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The name of the partner event source.

" + "smithy.api#documentation": "

The ARN of the partner event source.

" } }, - "Arn": { + "Name": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The ARN of the partner event source.

" + "smithy.api#documentation": "

The name of the partner event source.

" } } }, @@ -1972,10 +2026,10 @@ "smithy.api#documentation": "

The date and time the event source was created.

" } }, - "ExpirationTime": { - "target": "com.amazonaws.eventbridge#Timestamp", + "State": { + "target": "com.amazonaws.eventbridge#EventSourceState", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" + "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching\n event bus for this event source, and that event bus is active. If it is PENDING, either\n you haven't yet created a matching event bus, or that event bus is deactivated. If it is\n DELETED, you have created a matching event bus, but the event source has since been\n deleted.

" } }, "Account": { @@ -1984,10 +2038,10 @@ "smithy.api#documentation": "

The AWS account ID that the partner event source was offered to.

" } }, - "State": { - "target": "com.amazonaws.eventbridge#EventSourceState", + "ExpirationTime": { + "target": "com.amazonaws.eventbridge#Timestamp", "traits": { - "smithy.api#documentation": "

The state of the event source. If it is ACTIVE, you have already created a matching\n event bus for this event source, and that event bus is active. If it is PENDING, either\n you haven't yet created a matching event bus, or that event bus is deactivated. If it is\n DELETED, you have created a matching event bus, but the event source has since been\n deleted.

" + "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create\n a matching event bus for it.

" } } }, @@ -2083,40 +2137,40 @@ "com.amazonaws.eventbridge#PutEventsRequestEntry": { "type": "structure", "members": { - "Source": { + "DetailType": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The source of the event.

" + "smithy.api#documentation": "

Free-form string used to decide what fields to expect in the event\n detail.

" } }, - "Time": { - "target": "com.amazonaws.eventbridge#EventTime", + "Detail": { + "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp\n is provided, the time stamp of the PutEvents call is used.

" + "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. The JSON string may contain\n fields and nested subobjects.

" } }, - "Resources": { - "target": "com.amazonaws.eventbridge#EventResourceList", + "Source": { + "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + "smithy.api#documentation": "

The source of the event.

" } }, - "DetailType": { - "target": "com.amazonaws.eventbridge#String", + "EventBusName": { + "target": "com.amazonaws.eventbridge#NonPartnerEventBusName", "traits": { - "smithy.api#documentation": "

Free-form string used to decide what fields to expect in the event\n detail.

" + "smithy.api#documentation": "

The event bus that will receive the event. Only the rules that are associated with\n this event bus will be able to match the event.

" } }, - "Detail": { - "target": "com.amazonaws.eventbridge#String", + "Time": { + "target": "com.amazonaws.eventbridge#EventTime", "traits": { - "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. The JSON string may contain\n fields and nested subobjects.

" + "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp\n is provided, the time stamp of the PutEvents call is used.

" } }, - "EventBusName": { - "target": "com.amazonaws.eventbridge#NonPartnerEventBusName", + "Resources": { + "target": "com.amazonaws.eventbridge#EventResourceList", "traits": { - "smithy.api#documentation": "

The event bus that will receive the event. Only the rules that are associated with\n this event bus will be able to match the event.

" + "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" } } }, @@ -2139,23 +2193,29 @@ "com.amazonaws.eventbridge#PutEventsResponse": { "type": "structure", "members": { - "FailedEntryCount": { - "target": "com.amazonaws.eventbridge#Integer", - "traits": { - "smithy.api#documentation": "

The number of failed entries.

" - } - }, "Entries": { "target": "com.amazonaws.eventbridge#PutEventsResultEntryList", "traits": { "smithy.api#documentation": "

The successfully and unsuccessfully ingested events results. If the ingestion was\n successful, the entry has the event ID in it. Otherwise, you can use the error code and\n error message to identify the problem with the entry.

" } + }, + "FailedEntryCount": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#documentation": "

The number of failed entries.

" + } } } }, "com.amazonaws.eventbridge#PutEventsResultEntry": { "type": "structure", "members": { + "ErrorMessage": { + "target": "com.amazonaws.eventbridge#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the event submission failed.

" + } + }, "ErrorCode": { "target": "com.amazonaws.eventbridge#ErrorCode", "traits": { @@ -2167,12 +2227,6 @@ "traits": { "smithy.api#documentation": "

The ID of the event.

" } - }, - "ErrorMessage": { - "target": "com.amazonaws.eventbridge#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message that explains why the event submission failed.

" - } } }, "traits": { @@ -2220,6 +2274,18 @@ "com.amazonaws.eventbridge#PutPartnerEventsRequestEntry": { "type": "structure", "members": { + "Resources": { + "target": "com.amazonaws.eventbridge#EventResourceList", + "traits": { + "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + } + }, + "Source": { + "target": "com.amazonaws.eventbridge#EventSourceName", + "traits": { + "smithy.api#documentation": "

The event source that is generating the evntry.

" + } + }, "Detail": { "target": "com.amazonaws.eventbridge#String", "traits": { @@ -2232,23 +2298,11 @@ "smithy.api#documentation": "

A free-form string used to decide what fields to expect in the event detail.

" } }, - "Source": { - "target": "com.amazonaws.eventbridge#EventSourceName", - "traits": { - "smithy.api#documentation": "

The event source that is generating the evntry.

" - } - }, "Time": { "target": "com.amazonaws.eventbridge#EventTime", "traits": { "smithy.api#documentation": "

The date and time of the event.

" } - }, - "Resources": { - "target": "com.amazonaws.eventbridge#EventResourceList", - "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" - } } }, "traits": { @@ -2287,18 +2341,18 @@ "com.amazonaws.eventbridge#PutPartnerEventsResultEntry": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.eventbridge#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message that explains why the event submission failed.

" - } - }, "EventId": { "target": "com.amazonaws.eventbridge#EventId", "traits": { "smithy.api#documentation": "

The ID of the event.

" } }, + "ErrorMessage": { + "target": "com.amazonaws.eventbridge#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the event submission failed.

" + } + }, "ErrorCode": { "target": "com.amazonaws.eventbridge#ErrorCode", "traits": { @@ -2342,24 +2396,24 @@ "com.amazonaws.eventbridge#PutPermissionRequest": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.eventbridge#Action", + "Principal": { + "target": "com.amazonaws.eventbridge#Principal", "traits": { - "smithy.api#documentation": "

The action that you are enabling the other account to perform. Currently, this must\n be events:PutEvents.

", + "smithy.api#documentation": "

The 12-digit AWS account ID that you are permitting to put events to your default\n event bus. Specify \"*\" to permit any account to put events to your default event\n bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules\n that may match undesirable events. To create more secure rules, make sure that the event\n pattern for each rule contains an account field with a specific account ID\n from which to receive events. Rules with an account field do not match any events sent\n from other accounts.

", "smithy.api#required": {} } }, - "EventBusName": { - "target": "com.amazonaws.eventbridge#NonPartnerEventBusName", + "StatementId": { + "target": "com.amazonaws.eventbridge#StatementId", "traits": { - "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" + "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to.\n If you later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

", + "smithy.api#required": {} } }, - "Principal": { - "target": "com.amazonaws.eventbridge#Principal", + "EventBusName": { + "target": "com.amazonaws.eventbridge#NonPartnerEventBusName", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account ID that you are permitting to put events to your default\n event bus. Specify \"*\" to permit any account to put events to your default event\n bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules\n that may match undesirable events. To create more secure rules, make sure that the event\n pattern for each rule contains an account field with a specific account ID\n from which to receive events. Rules with an account field do not match any events sent\n from other accounts.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The event bus associated with the rule. If you omit this, the default event bus is\n used.

" } }, "Condition": { @@ -2368,10 +2422,10 @@ "smithy.api#documentation": "

This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain AWS organization. For more information\n about AWS Organizations, see What Is AWS\n Organizations in the AWS Organizations User\n Guide.

\n

If you specify Condition with an AWS organization ID, and specify \"*\" as\n the value for Principal, you grant permission to all the accounts in the\n named organization.

\n\n

The Condition is a JSON string which must contain Type,\n Key, and Value fields.

" } }, - "StatementId": { - "target": "com.amazonaws.eventbridge#StatementId", + "Action": { + "target": "com.amazonaws.eventbridge#Action", "traits": { - "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to.\n If you later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

", + "smithy.api#documentation": "

The action that you are enabling the other account to perform. Currently, this must\n be events:PutEvents.

", "smithy.api#required": {} } } @@ -2412,22 +2466,16 @@ "com.amazonaws.eventbridge#PutRuleRequest": { "type": "structure", "members": { - "ScheduleExpression": { - "target": "com.amazonaws.eventbridge#ScheduleExpression", - "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\" or \"rate(5\n minutes)\".

" - } - }, "State": { "target": "com.amazonaws.eventbridge#RuleState", "traits": { "smithy.api#documentation": "

Indicates whether the rule is enabled or disabled.

" } }, - "Description": { - "target": "com.amazonaws.eventbridge#RuleDescription", + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", "traits": { - "smithy.api#documentation": "

A description of the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } }, "EventPattern": { @@ -2436,22 +2484,22 @@ "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

" } }, - "EventBusName": { - "target": "com.amazonaws.eventbridge#EventBusName", + "Description": { + "target": "com.amazonaws.eventbridge#RuleDescription", "traits": { - "smithy.api#documentation": "

The event bus to associate with this rule. If you omit this, the default event bus is\n used.

" + "smithy.api#documentation": "

A description of the rule.

" } }, - "Tags": { - "target": "com.amazonaws.eventbridge#TagList", + "ScheduleExpression": { + "target": "com.amazonaws.eventbridge#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The list of key-value pairs to associate with the rule.

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\" or \"rate(5\n minutes)\".

" } }, - "RoleArn": { - "target": "com.amazonaws.eventbridge#RoleArn", + "Tags": { + "target": "com.amazonaws.eventbridge#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + "smithy.api#documentation": "

The list of key-value pairs to associate with the rule.

" } }, "Name": { @@ -2460,6 +2508,12 @@ "smithy.api#documentation": "

The name of the rule that you are creating or updating.

", "smithy.api#required": {} } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus to associate with this rule. If you omit this, the default event bus is\n used.

" + } } } }, @@ -2500,18 +2554,12 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they\n are already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n\n\n

Creating rules with built-in targets is supported only in the AWS Management\n Console. The built-in targets are EC2 CreateSnapshot API call, EC2\n RebootInstances API call, EC2 StopInstances API call, and\n EC2 TerminateInstances API call.

\n\n

For some target types, PutTargets provides target-specific parameters.\n If the target is a Kinesis data stream, you can optionally specify which shard the event\n goes to by using the KinesisParameters argument. To invoke a command on\n multiple EC2 instances with one rule, you can use the RunCommandParameters\n field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge \n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources,\n EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles\n that you specify in the RoleARN argument in PutTargets. For more information, \n see Authentication and Access Control in the Amazon EventBridge User\n Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's\n event bus as a target of the rules in your account. To send the matched events to the\n other account, specify that account's event bus as the Arn value when you\n run PutTargets. If your account sends events to another account, your\n account is charged for each sent event. Each event sent to another account is charged as\n a custom event. The account receiving the event is not charged. For more information,\n see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are\n not available with PutTarget if the target is an event bus of a\n different AWS account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the\n account ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon\n EventBridge User Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and\n optional parameters of a target. When a rule is triggered due to a matched\n event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must\n use JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or\n updated targets might not be immediately invoked. Allow a short period of time for\n changes to take effect.

\n\n

This action can partially fail if too many requests are made at the same time. If\n that happens, FailedEntryCount is non-zero in the response and each entry\n in FailedEntries provides the ID of the failed target and the error\n code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they\n are already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n\n\n

Creating rules with built-in targets is supported only in the AWS Management\n Console. The built-in targets are EC2 CreateSnapshot API call, EC2\n RebootInstances API call, EC2 StopInstances API call, and\n EC2 TerminateInstances API call.

\n\n

For some target types, PutTargets provides target-specific parameters.\n If the target is a Kinesis data stream, you can optionally specify which shard the event\n goes to by using the KinesisParameters argument. To invoke a command on\n multiple EC2 instances with one rule, you can use the RunCommandParameters\n field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge \n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources,\n EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles\n that you specify in the RoleARN argument in PutTargets. For more information, \n see Authentication and Access Control in the Amazon EventBridge User\n Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's\n event bus as a target of the rules in your account. To send the matched events to the\n other account, specify that account's event bus as the Arn value when you\n run PutTargets. If your account sends events to another account, your\n account is charged for each sent event. Each event sent to another account is charged as\n a custom event. The account receiving the event is not charged. For more information,\n see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are\n not available with PutTarget if the target is an event bus of a\n different AWS account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the\n account ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon\n EventBridge User Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and\n optional parameters of a target. When a rule is triggered due to a matched\n event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must\n use JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or\n updated targets might not be immediately invoked. Allow a short period of time for\n changes to take effect.

\n\n

This action can partially fail if too many requests are made at the same time. If\n that happens, FailedEntryCount is non-zero in the response and each entry\n in FailedEntries provides the ID of the failed target and the error\n code.

" } }, "com.amazonaws.eventbridge#PutTargetsRequest": { "type": "structure", "members": { - "EventBusName": { - "target": "com.amazonaws.eventbridge#EventBusName", - "traits": { - "smithy.api#documentation": "

The name of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" - } - }, "Rule": { "target": "com.amazonaws.eventbridge#RuleName", "traits": { @@ -2519,6 +2567,12 @@ "smithy.api#required": {} } }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The name of the event bus associated with the rule. If you omit this, the default\n event bus is used.

" + } + }, "Targets": { "target": "com.amazonaws.eventbridge#TargetList", "traits": { @@ -2531,35 +2585,35 @@ "com.amazonaws.eventbridge#PutTargetsResponse": { "type": "structure", "members": { - "FailedEntries": { - "target": "com.amazonaws.eventbridge#PutTargetsResultEntryList", - "traits": { - "smithy.api#documentation": "

The failed target entries.

" - } - }, "FailedEntryCount": { "target": "com.amazonaws.eventbridge#Integer", "traits": { "smithy.api#documentation": "

The number of failed entries.

" } + }, + "FailedEntries": { + "target": "com.amazonaws.eventbridge#PutTargetsResultEntryList", + "traits": { + "smithy.api#documentation": "

The failed target entries.

" + } } } }, "com.amazonaws.eventbridge#PutTargetsResultEntry": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.eventbridge#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message that explains why the target addition failed.

" - } - }, "ErrorCode": { "target": "com.amazonaws.eventbridge#ErrorCode", "traits": { "smithy.api#documentation": "

The error code that indicates why the target addition failed. If the value is\n ConcurrentModificationException, too many requests were made at the\n same time.

" } }, + "ErrorMessage": { + "target": "com.amazonaws.eventbridge#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that explains why the target addition failed.

" + } + }, "TargetId": { "target": "com.amazonaws.eventbridge#TargetId", "traits": { @@ -2606,6 +2660,62 @@ "smithy.api#pattern": "[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+" } }, + "com.amazonaws.eventbridge#RedshiftDataParameters": { + "type": "structure", + "members": { + "SecretManagerArn": { + "target": "com.amazonaws.eventbridge#RedshiftSecretManagerArn", + "traits": { + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database.\n Required when authenticating using AWS Secrets Manager.

" + } + }, + "DbUser": { + "target": "com.amazonaws.eventbridge#DbUser", + "traits": { + "smithy.api#documentation": "

The database user name. Required when authenticating using temporary credentials.

" + } + }, + "WithEvent": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to send an event back to EventBridge after the SQL statement runs.

" + } + }, + "Sql": { + "target": "com.amazonaws.eventbridge#Sql", + "traits": { + "smithy.api#documentation": "

The SQL statement text to run.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.eventbridge#Database", + "traits": { + "smithy.api#documentation": "

The name of the database. Required when authenticating using temporary credentials.

", + "smithy.api#required": {} + } + }, + "StatementName": { + "target": "com.amazonaws.eventbridge#StatementName", + "traits": { + "smithy.api#documentation": "

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Redshift cluster\n to invoke the Redshift Data API ExecuteStatement based on EventBridge events.

" + } + }, + "com.amazonaws.eventbridge#RedshiftSecretManagerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + } + }, "com.amazonaws.eventbridge#RemovePermission": { "type": "operation", "input": { @@ -2673,12 +2783,6 @@ "com.amazonaws.eventbridge#RemoveTargetsRequest": { "type": "structure", "members": { - "Force": { - "target": "com.amazonaws.eventbridge#Boolean", - "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored\n for rules that are not managed rules. You can check whether a rule is a managed rule by\n using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" - } - }, "Ids": { "target": "com.amazonaws.eventbridge#TargetIdList", "traits": { @@ -2686,6 +2790,12 @@ "smithy.api#required": {} } }, + "Force": { + "target": "com.amazonaws.eventbridge#Boolean", + "traits": { + "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored\n for rules that are not managed rules. You can check whether a rule is a managed rule by\n using DescribeRule or ListRules and checking the\n ManagedBy field of the response.

" + } + }, "Rule": { "target": "com.amazonaws.eventbridge#RuleName", "traits": { @@ -2704,29 +2814,23 @@ "com.amazonaws.eventbridge#RemoveTargetsResponse": { "type": "structure", "members": { - "FailedEntryCount": { - "target": "com.amazonaws.eventbridge#Integer", - "traits": { - "smithy.api#documentation": "

The number of failed entries.

" - } - }, "FailedEntries": { "target": "com.amazonaws.eventbridge#RemoveTargetsResultEntryList", "traits": { "smithy.api#documentation": "

The failed target entries.

" } + }, + "FailedEntryCount": { + "target": "com.amazonaws.eventbridge#Integer", + "traits": { + "smithy.api#documentation": "

The number of failed entries.

" + } } } }, "com.amazonaws.eventbridge#RemoveTargetsResultEntry": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.eventbridge#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code that indicates why the target removal failed. If the value is\n ConcurrentModificationException, too many requests were made at the\n same time.

" - } - }, "TargetId": { "target": "com.amazonaws.eventbridge#TargetId", "traits": { @@ -2738,6 +2842,12 @@ "traits": { "smithy.api#documentation": "

The error message that explains why the target removal failed.

" } + }, + "ErrorCode": { + "target": "com.amazonaws.eventbridge#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that indicates why the target removal failed. If the value is\n ConcurrentModificationException, too many requests were made at the\n same time.

" + } } }, "traits": { @@ -2762,6 +2872,15 @@ "smithy.api#error": "client" } }, + "com.amazonaws.eventbridge#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, "com.amazonaws.eventbridge#ResourceNotFoundException": { "type": "structure", "members": { @@ -2774,6 +2893,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.eventbridge#RetryPolicy": { + "type": "structure", + "members": { + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.eventbridge#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, to continue to make retry attempts.

" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.eventbridge#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "

The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A RetryPolicy object that includes information about the retry policy settings.

" + } + }, "com.amazonaws.eventbridge#RoleArn": { "type": "string", "traits": { @@ -2786,16 +2925,10 @@ "com.amazonaws.eventbridge#Rule": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.eventbridge#RuleState", - "traits": { - "smithy.api#documentation": "

The state of the rule.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.eventbridge#RoleArn", + "Description": { + "target": "com.amazonaws.eventbridge#RuleDescription", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target\n invocation.

" + "smithy.api#documentation": "

The description of the rule.

" } }, "Arn": { @@ -2804,16 +2937,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

" } }, + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target\n invocation.

" + } + }, "EventPattern": { "target": "com.amazonaws.eventbridge#EventPattern", "traits": { "smithy.api#documentation": "

The event pattern of the rule. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

" } }, - "EventBusName": { - "target": "com.amazonaws.eventbridge#EventBusName", + "ScheduleExpression": { + "target": "com.amazonaws.eventbridge#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The event bus associated with the rule.

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" } }, "ManagedBy": { @@ -2822,16 +2961,10 @@ "smithy.api#documentation": "

If the rule was created on behalf of your account by an AWS service, this field\n displays the principal name of the service that created the rule.

" } }, - "Description": { - "target": "com.amazonaws.eventbridge#RuleDescription", - "traits": { - "smithy.api#documentation": "

The description of the rule.

" - } - }, - "ScheduleExpression": { - "target": "com.amazonaws.eventbridge#ScheduleExpression", + "State": { + "target": "com.amazonaws.eventbridge#RuleState", "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5\n minutes)\".

" + "smithy.api#documentation": "

The state of the rule.

" } }, "Name": { @@ -2839,6 +2972,12 @@ "traits": { "smithy.api#documentation": "

The name of the rule.

" } + }, + "EventBusName": { + "target": "com.amazonaws.eventbridge#EventBusName", + "traits": { + "smithy.api#documentation": "

The event bus associated with the rule.

" + } } }, "traits": { @@ -2989,6 +3128,15 @@ } } }, + "com.amazonaws.eventbridge#Sql": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + }, "com.amazonaws.eventbridge#SqsParameters": { "type": "structure", "members": { @@ -3013,6 +3161,15 @@ "smithy.api#pattern": "[a-zA-Z0-9-_]+" } }, + "com.amazonaws.eventbridge#StatementName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, "com.amazonaws.eventbridge#String": { "type": "string" }, @@ -3025,17 +3182,17 @@ "com.amazonaws.eventbridge#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.eventbridge#TagValue", + "Key": { + "target": "com.amazonaws.eventbridge#TagKey", "traits": { - "smithy.api#documentation": "

The value for the specified tag key.

", + "smithy.api#documentation": "

A string you can use to assign a value. The combination of tag keys and values can\n help you organize and categorize your resources.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.eventbridge#TagKey", + "Value": { + "target": "com.amazonaws.eventbridge#TagValue", "traits": { - "smithy.api#documentation": "

A string you can use to assign a value. The combination of tag keys and values can\n help you organize and categorize your resources.

", + "smithy.api#documentation": "

The value for the specified tag key.

", "smithy.api#required": {} } } @@ -3126,54 +3283,46 @@ "com.amazonaws.eventbridge#Target": { "type": "structure", "members": { - "Input": { - "target": "com.amazonaws.eventbridge#TargetInput", - "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself\n is passed to the target. For more information, see The JavaScript Object Notation\n (JSON) Data Interchange Format.

" - } - }, - "InputPath": { - "target": "com.amazonaws.eventbridge#TargetInputPath", - "traits": { - "smithy.api#documentation": "

The value of the JSONPath that is used for extracting part of the matched event\n when passing it to the target. You must use JSON dot notation, not bracket notation. For\n more information about JSON paths, see JSONPath.

" - } - }, "BatchParameters": { "target": "com.amazonaws.eventbridge#BatchParameters", "traits": { "smithy.api#documentation": "

If the event target is an AWS Batch job, this contains the job definition, job\n name, and other parameters. For more information, see Jobs in the AWS Batch User\n Guide.

" } }, + "InputTransformer": { + "target": "com.amazonaws.eventbridge#InputTransformer", + "traits": { + "smithy.api#documentation": "

Settings to enable you to provide custom input to a target based on certain event\n data. You can extract one or more key-value pairs from the event and then use that data\n to send customized input to the target.

" + } + }, "KinesisParameters": { "target": "com.amazonaws.eventbridge#KinesisParameters", "traits": { "smithy.api#documentation": "

The custom parameter you can use to control the shard assignment, when the target\n is a Kinesis data stream. If you do not include this parameter, the default is to use\n the eventId as the partition key.

" } }, - "RoleArn": { - "target": "com.amazonaws.eventbridge#RoleArn", + "EcsParameters": { + "target": "com.amazonaws.eventbridge#EcsParameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the\n rule is triggered. If one rule triggers multiple targets, you can use a different IAM\n role for each target.

" + "smithy.api#documentation": "

Contains the Amazon ECS task definition and task count to be used, if the event\n target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task\n Definitions in the Amazon EC2 Container Service Developer\n Guide.

" } }, - "Id": { - "target": "com.amazonaws.eventbridge#TargetId", + "SqsParameters": { + "target": "com.amazonaws.eventbridge#SqsParameters", "traits": { - "smithy.api#documentation": "

The ID of the target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains the message group ID to use when the target is a FIFO queue.

\n

If you specify an SQS FIFO queue as a target, the queue must have content-based\n deduplication enabled.

" } }, - "InputTransformer": { - "target": "com.amazonaws.eventbridge#InputTransformer", + "RedshiftDataParameters": { + "target": "com.amazonaws.eventbridge#RedshiftDataParameters", "traits": { - "smithy.api#documentation": "

Settings to enable you to provide custom input to a target based on certain event\n data. You can extract one or more key-value pairs from the event and then use that data\n to send customized input to the target.

" + "smithy.api#documentation": "

Contains the Redshift Data API parameters to use when the target is a Redshift cluster.

\n

If you specify a Redshift Cluster as a Target, you can use this\n to specify parameters to invoke the Redshift Data API ExecuteStatement based on\n EventBridge events.

" } }, - "Arn": { - "target": "com.amazonaws.eventbridge#TargetArn", + "HttpParameters": { + "target": "com.amazonaws.eventbridge#HttpParameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST \n endpoint.

\n

If you specify an API Gateway REST API as a target, you can use this \n parameter to specify headers, path parameter, query string keys/values as part of your target \n invoking request.

" } }, "RunCommandParameters": { @@ -3182,22 +3331,48 @@ "smithy.api#documentation": "

Parameters used when you are using the rule to invoke Amazon EC2 Run\n Command.

" } }, - "HttpParameters": { - "target": "com.amazonaws.eventbridge#HttpParameters", + "RoleArn": { + "target": "com.amazonaws.eventbridge#RoleArn", "traits": { - "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST \n endpoint.

\n

If you specify an API Gateway REST API as a target, you can use this \n parameter to specify headers, path parameter, query string keys/values as part of your target \n invoking request.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the\n rule is triggered. If one rule triggers multiple targets, you can use a different IAM\n role for each target.

" } }, - "SqsParameters": { - "target": "com.amazonaws.eventbridge#SqsParameters", + "InputPath": { + "target": "com.amazonaws.eventbridge#TargetInputPath", "traits": { - "smithy.api#documentation": "

Contains the message group ID to use when the target is a FIFO queue.

\n

If you specify an SQS FIFO queue as a target, the queue must have content-based\n deduplication enabled.

" + "smithy.api#documentation": "

The value of the JSONPath that is used for extracting part of the matched event\n when passing it to the target. You must use JSON dot notation, not bracket notation. For\n more information about JSON paths, see JSONPath.

" } }, - "EcsParameters": { - "target": "com.amazonaws.eventbridge#EcsParameters", + "RetryPolicy": { + "target": "com.amazonaws.eventbridge#RetryPolicy", "traits": { - "smithy.api#documentation": "

Contains the Amazon ECS task definition and task count to be used, if the event\n target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task\n Definitions in the Amazon EC2 Container Service Developer\n Guide.

" + "smithy.api#documentation": "

The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.

" + } + }, + "Input": { + "target": "com.amazonaws.eventbridge#TargetInput", + "traits": { + "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself\n is passed to the target. For more information, see The JavaScript Object Notation\n (JSON) Data Interchange Format.

" + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.eventbridge#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "

The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

" + } + }, + "Arn": { + "target": "com.amazonaws.eventbridge#TargetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.eventbridge#TargetId", + "traits": { + "smithy.api#documentation": "

The ID of the target.

", + "smithy.api#required": {} } } }, @@ -3298,17 +3473,17 @@ "com.amazonaws.eventbridge#TestEventPatternRequest": { "type": "structure", "members": { - "Event": { - "target": "com.amazonaws.eventbridge#String", + "EventPattern": { + "target": "com.amazonaws.eventbridge#EventPattern", "traits": { - "smithy.api#documentation": "

The event, in JSON format, to test against the event pattern.

", + "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

", "smithy.api#required": {} } }, - "EventPattern": { - "target": "com.amazonaws.eventbridge#EventPattern", + "Event": { + "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The event pattern. For more information, see Events and\n Event Patterns in the Amazon EventBridge User\n Guide.

", + "smithy.api#documentation": "

The event, in JSON format, to test against the event pattern.

", "smithy.api#required": {} } } @@ -3381,17 +3556,17 @@ "com.amazonaws.eventbridge#UntagResourceRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.eventbridge#Arn", + "TagKeys": { + "target": "com.amazonaws.eventbridge#TagKeyList", "traits": { - "smithy.api#documentation": "

The ARN of the EventBridge resource from which you are removing tags.

", + "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.eventbridge#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.eventbridge#Arn", "traits": { - "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", + "smithy.api#documentation": "

The ARN of the EventBridge resource from which you are removing tags.

", "smithy.api#required": {} } } 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 15ab34c982c6..52f66362b9b6 100644 --- a/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json +++ b/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json @@ -87,10 +87,10 @@ "com.amazonaws.firehose#CloudWatchLoggingOptions": { "type": "structure", "members": { - "LogStreamName": { - "target": "com.amazonaws.firehose#LogStreamName", + "LogGroupName": { + "target": "com.amazonaws.firehose#LogGroupName", "traits": { - "smithy.api#documentation": "

The CloudWatch log stream name for logging. This value is required if CloudWatch\n logging is enabled.

" + "smithy.api#documentation": "

The CloudWatch group name for logging. This value is required if CloudWatch logging\n is enabled.

" } }, "Enabled": { @@ -99,10 +99,10 @@ "smithy.api#documentation": "

Enables or disables CloudWatch logging.

" } }, - "LogGroupName": { - "target": "com.amazonaws.firehose#LogGroupName", + "LogStreamName": { + "target": "com.amazonaws.firehose#LogStreamName", "traits": { - "smithy.api#documentation": "

The CloudWatch group name for logging. This value is required if CloudWatch logging\n is enabled.

" + "smithy.api#documentation": "

The CloudWatch log stream name for logging. This value is required if CloudWatch\n logging is enabled.

" } } }, @@ -189,6 +189,12 @@ "com.amazonaws.firehose#CopyCommand": { "type": "structure", "members": { + "CopyOptions": { + "target": "com.amazonaws.firehose#CopyOptions", + "traits": { + "smithy.api#documentation": "

Optional parameters to use with the Amazon Redshift COPY command. For\n more information, see the \"Optional Parameters\" section of Amazon Redshift COPY command. Some possible\n examples that would apply to Kinesis Data Firehose are as follows:

\n

\n delimiter '\\t' lzop; - fields are delimited with \"\\t\" (TAB character) and\n compressed using lzop.

\n

\n delimiter '|' - fields are delimited with \"|\" (this is the default\n delimiter).

\n

\n delimiter '|' escape - the delimiter should be escaped.

\n

\n fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' -\n fields are fixed width in the source, with each width specified after every column in the\n table.

\n

\n JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path\n specified is the format of the data.

\n

For more examples, see Amazon Redshift COPY command\n examples.

" + } + }, "DataTableName": { "target": "com.amazonaws.firehose#DataTableName", "traits": { @@ -196,12 +202,6 @@ "smithy.api#required": {} } }, - "CopyOptions": { - "target": "com.amazonaws.firehose#CopyOptions", - "traits": { - "smithy.api#documentation": "

Optional parameters to use with the Amazon Redshift COPY command. For\n more information, see the \"Optional Parameters\" section of Amazon Redshift COPY command. Some possible\n examples that would apply to Kinesis Data Firehose are as follows:

\n

\n delimiter '\\t' lzop; - fields are delimited with \"\\t\" (TAB character) and\n compressed using lzop.

\n

\n delimiter '|' - fields are delimited with \"|\" (this is the default\n delimiter).

\n

\n delimiter '|' escape - the delimiter should be escaped.

\n

\n fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' -\n fields are fixed width in the source, with each width specified after every column in the\n table.

\n

\n JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path\n specified is the format of the data.

\n

For more examples, see Amazon Redshift COPY command\n examples.

" - } - }, "DataTableColumns": { "target": "com.amazonaws.firehose#DataTableColumns", "traits": { @@ -252,12 +252,6 @@ "com.amazonaws.firehose#CreateDeliveryStreamInput": { "type": "structure", "members": { - "RedshiftDestinationConfiguration": { - "target": "com.amazonaws.firehose#RedshiftDestinationConfiguration", - "traits": { - "smithy.api#documentation": "

The destination in Amazon Redshift. You can specify only one destination.

" - } - }, "S3DestinationConfiguration": { "target": "com.amazonaws.firehose#S3DestinationConfiguration", "traits": { @@ -265,16 +259,10 @@ "smithy.api#documentation": "

[Deprecated]\n The destination in Amazon S3. You can specify only one destination.

" } }, - "DeliveryStreamType": { - "target": "com.amazonaws.firehose#DeliveryStreamType", - "traits": { - "smithy.api#documentation": "

The delivery stream type. This parameter can be one of the following\n values:

\n " - } - }, - "SplunkDestinationConfiguration": { - "target": "com.amazonaws.firehose#SplunkDestinationConfiguration", + "DeliveryStreamEncryptionConfigurationInput": { + "target": "com.amazonaws.firehose#DeliveryStreamEncryptionConfigurationInput", "traits": { - "smithy.api#documentation": "

The destination in Splunk. You can specify only one destination.

" + "smithy.api#documentation": "

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for\n Server-Side Encryption (SSE).

" } }, "DeliveryStreamName": { @@ -290,22 +278,22 @@ "smithy.api#documentation": "

When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon\n Resource Name (ARN) and the role ARN for the source stream.

" } }, - "ElasticsearchDestinationConfiguration": { - "target": "com.amazonaws.firehose#ElasticsearchDestinationConfiguration", + "ExtendedS3DestinationConfiguration": { + "target": "com.amazonaws.firehose#ExtendedS3DestinationConfiguration", "traits": { - "smithy.api#documentation": "

The destination in Amazon ES. You can specify only one destination.

" + "smithy.api#documentation": "

The destination in Amazon S3. You can specify only one destination.

" } }, - "DeliveryStreamEncryptionConfigurationInput": { - "target": "com.amazonaws.firehose#DeliveryStreamEncryptionConfigurationInput", + "SplunkDestinationConfiguration": { + "target": "com.amazonaws.firehose#SplunkDestinationConfiguration", "traits": { - "smithy.api#documentation": "

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for\n Server-Side Encryption (SSE).

" + "smithy.api#documentation": "

The destination in Splunk. You can specify only one destination.

" } }, - "HttpEndpointDestinationConfiguration": { - "target": "com.amazonaws.firehose#HttpEndpointDestinationConfiguration", + "DeliveryStreamType": { + "target": "com.amazonaws.firehose#DeliveryStreamType", "traits": { - "smithy.api#documentation": "

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.\n You can specify only one destination.

" + "smithy.api#documentation": "

The delivery stream type. This parameter can be one of the following\n values:

\n " } }, "Tags": { @@ -314,10 +302,22 @@ "smithy.api#documentation": "

A set of tags to assign to the delivery stream. A tag is a key-value pair that you can\n define and assign to AWS resources. Tags are metadata. For example, you can add friendly\n names and descriptions or other types of information that can help you distinguish the\n delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

\n\n

You can specify up to 50 tags when creating a delivery stream.

" } }, - "ExtendedS3DestinationConfiguration": { - "target": "com.amazonaws.firehose#ExtendedS3DestinationConfiguration", + "HttpEndpointDestinationConfiguration": { + "target": "com.amazonaws.firehose#HttpEndpointDestinationConfiguration", "traits": { - "smithy.api#documentation": "

The destination in Amazon S3. You can specify only one destination.

" + "smithy.api#documentation": "

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.\n You can specify only one destination.

" + } + }, + "RedshiftDestinationConfiguration": { + "target": "com.amazonaws.firehose#RedshiftDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

The destination in Amazon Redshift. You can specify only one destination.

" + } + }, + "ElasticsearchDestinationConfiguration": { + "target": "com.amazonaws.firehose#ElasticsearchDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

The destination in Amazon ES. You can specify only one destination.

" } } } @@ -345,22 +345,16 @@ "com.amazonaws.firehose#DataFormatConversionConfiguration": { "type": "structure", "members": { - "OutputFormatConfiguration": { - "target": "com.amazonaws.firehose#OutputFormatConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the serializer that you want Kinesis Data Firehose to use to convert the\n format of your data to the Parquet or ORC format. This parameter is required if\n Enabled is set to true.

" - } - }, "Enabled": { "target": "com.amazonaws.firehose#BooleanObject", "traits": { "smithy.api#documentation": "

Defaults to true. Set it to false if you want to disable\n format conversion while preserving the configuration details.

" } }, - "InputFormatConfiguration": { - "target": "com.amazonaws.firehose#InputFormatConfiguration", + "OutputFormatConfiguration": { + "target": "com.amazonaws.firehose#OutputFormatConfiguration", "traits": { - "smithy.api#documentation": "

Specifies the deserializer that you want Kinesis Data Firehose to use to convert the\n format of your data from JSON. This parameter is required if Enabled is set to\n true.

" + "smithy.api#documentation": "

Specifies the serializer that you want Kinesis Data Firehose to use to convert the\n format of your data to the Parquet or ORC format. This parameter is required if\n Enabled is set to true.

" } }, "SchemaConfiguration": { @@ -368,6 +362,12 @@ "traits": { "smithy.api#documentation": "

Specifies the AWS Glue Data Catalog table that contains the column information. This\n parameter is required if Enabled is set to true.

" } + }, + "InputFormatConfiguration": { + "target": "com.amazonaws.firehose#InputFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the deserializer that you want Kinesis Data Firehose to use to convert the\n format of your data from JSON. This parameter is required if Enabled is set to\n true.

" + } } }, "traits": { @@ -452,20 +452,38 @@ "com.amazonaws.firehose#DeliveryStreamDescription": { "type": "structure", "members": { - "DeliveryStreamName": { - "target": "com.amazonaws.firehose#DeliveryStreamName", + "DeliveryStreamEncryptionConfiguration": { + "target": "com.amazonaws.firehose#DeliveryStreamEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The name of the delivery stream.

", + "smithy.api#documentation": "

Indicates the server-side encryption (SSE) status for the delivery stream.

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.firehose#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the delivery stream was last updated.

" + } + }, + "HasMoreDestinations": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether there are more destinations available to list.

", "smithy.api#required": {} } }, - "Destinations": { - "target": "com.amazonaws.firehose#DestinationDescriptionList", + "DeliveryStreamStatus": { + "target": "com.amazonaws.firehose#DeliveryStreamStatus", "traits": { - "smithy.api#documentation": "

The destinations.

", + "smithy.api#documentation": "

The status of the delivery stream. If the status of a delivery stream is\n CREATING_FAILED, this status doesn't change, and you can't invoke\n CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

", "smithy.api#required": {} } }, + "FailureDescription": { + "target": "com.amazonaws.firehose#FailureDescription", + "traits": { + "smithy.api#documentation": "

Provides details in case one of the following operations fails due to an error related\n to KMS: CreateDeliveryStream, DeleteDeliveryStream,\n StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

" + } + }, "DeliveryStreamARN": { "target": "com.amazonaws.firehose#DeliveryStreamARN", "traits": { @@ -473,10 +491,10 @@ "smithy.api#required": {} } }, - "DeliveryStreamType": { - "target": "com.amazonaws.firehose#DeliveryStreamType", + "DeliveryStreamName": { + "target": "com.amazonaws.firehose#DeliveryStreamName", "traits": { - "smithy.api#documentation": "

The delivery stream type. This can be one of the following values:

\n ", + "smithy.api#documentation": "

The name of the delivery stream.

", "smithy.api#required": {} } }, @@ -487,48 +505,30 @@ "smithy.api#required": {} } }, - "DeliveryStreamStatus": { - "target": "com.amazonaws.firehose#DeliveryStreamStatus", + "DeliveryStreamType": { + "target": "com.amazonaws.firehose#DeliveryStreamType", "traits": { - "smithy.api#documentation": "

The status of the delivery stream. If the status of a delivery stream is\n CREATING_FAILED, this status doesn't change, and you can't invoke\n CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

", + "smithy.api#documentation": "

The delivery stream type. This can be one of the following values:

\n ", "smithy.api#required": {} } }, - "CreateTimestamp": { - "target": "com.amazonaws.firehose#Timestamp", + "Source": { + "target": "com.amazonaws.firehose#SourceDescription", "traits": { - "smithy.api#documentation": "

The date and time that the delivery stream was created.

" + "smithy.api#documentation": "

If the DeliveryStreamType parameter is\n KinesisStreamAsSource, a SourceDescription object\n describing the source Kinesis data stream.

" } }, - "HasMoreDestinations": { - "target": "com.amazonaws.firehose#BooleanObject", + "Destinations": { + "target": "com.amazonaws.firehose#DestinationDescriptionList", "traits": { - "smithy.api#documentation": "

Indicates whether there are more destinations available to list.

", + "smithy.api#documentation": "

The destinations.

", "smithy.api#required": {} } }, - "FailureDescription": { - "target": "com.amazonaws.firehose#FailureDescription", - "traits": { - "smithy.api#documentation": "

Provides details in case one of the following operations fails due to an error related\n to KMS: CreateDeliveryStream, DeleteDeliveryStream,\n StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

" - } - }, - "DeliveryStreamEncryptionConfiguration": { - "target": "com.amazonaws.firehose#DeliveryStreamEncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

Indicates the server-side encryption (SSE) status for the delivery stream.

" - } - }, - "LastUpdateTimestamp": { + "CreateTimestamp": { "target": "com.amazonaws.firehose#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the delivery stream was last updated.

" - } - }, - "Source": { - "target": "com.amazonaws.firehose#SourceDescription", - "traits": { - "smithy.api#documentation": "

If the DeliveryStreamType parameter is\n KinesisStreamAsSource, a SourceDescription object\n describing the source Kinesis data stream.

" + "smithy.api#documentation": "

The date and time that the delivery stream was created.

" } } }, @@ -539,22 +539,16 @@ "com.amazonaws.firehose#DeliveryStreamEncryptionConfiguration": { "type": "structure", "members": { - "FailureDescription": { - "target": "com.amazonaws.firehose#FailureDescription", - "traits": { - "smithy.api#documentation": "

Provides details in case one of the following operations fails due to an error related\n to KMS: CreateDeliveryStream, DeleteDeliveryStream,\n StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

" - } - }, "KeyARN": { "target": "com.amazonaws.firehose#AWSKMSKeyARN", "traits": { "smithy.api#documentation": "

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the\n ARN of the customer managed CMK. If KeyType is AWS_OWNED_CMK,\n DeliveryStreamEncryptionConfiguration doesn't contain a value for\n KeyARN.

" } }, - "KeyType": { - "target": "com.amazonaws.firehose#KeyType", + "FailureDescription": { + "target": "com.amazonaws.firehose#FailureDescription", "traits": { - "smithy.api#documentation": "

Indicates the type of customer master key (CMK) that is used for encryption. The default\n setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

" + "smithy.api#documentation": "

Provides details in case one of the following operations fails due to an error related\n to KMS: CreateDeliveryStream, DeleteDeliveryStream,\n StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

" } }, "Status": { @@ -562,6 +556,12 @@ "traits": { "smithy.api#documentation": "

This is the server-side encryption (SSE) status for the delivery stream. For a full\n description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED\n or DISABLING_FAILED, it is the status of the most recent attempt to enable or\n disable SSE, respectively.

" } + }, + "KeyType": { + "target": "com.amazonaws.firehose#KeyType", + "traits": { + "smithy.api#documentation": "

Indicates the type of customer master key (CMK) that is used for encryption. The default\n setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

" + } } }, "traits": { @@ -571,18 +571,18 @@ "com.amazonaws.firehose#DeliveryStreamEncryptionConfigurationInput": { "type": "structure", "members": { + "KeyARN": { + "target": "com.amazonaws.firehose#AWSKMSKeyARN", + "traits": { + "smithy.api#documentation": "

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify\n the Amazon Resource Name (ARN) of the CMK. If you set KeyType to\n AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

" + } + }, "KeyType": { "target": "com.amazonaws.firehose#KeyType", "traits": { "smithy.api#documentation": "

Indicates the type of customer master key (CMK) to use for encryption. The default\n setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with\n KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the\n Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to\n use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose\n manages that grant.

\n

When you invoke StartDeliveryStreamEncryption to change the CMK for a\n delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose\n schedules the grant it had on the old CMK for retirement.

\n

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If\n a CreateDeliveryStream or StartDeliveryStreamEncryption\n operation exceeds this limit, Kinesis Data Firehose throws a\n LimitExceededException.

\n \n

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't\n support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service\n developer guide.

\n ", "smithy.api#required": {} } - }, - "KeyARN": { - "target": "com.amazonaws.firehose#AWSKMSKeyARN", - "traits": { - "smithy.api#documentation": "

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify\n the Amazon Resource Name (ARN) of the CMK. If you set KeyType to\n AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

" - } } }, "traits": { @@ -779,18 +779,18 @@ "smithy.api#documentation": "

The limit on the number of destinations to return. You can have one destination per\n delivery stream.

" } }, - "ExclusiveStartDestinationId": { - "target": "com.amazonaws.firehose#DestinationId", - "traits": { - "smithy.api#documentation": "

The ID of the destination to start returning the destination information. Kinesis\n Data Firehose supports one destination per delivery stream.

" - } - }, "DeliveryStreamName": { "target": "com.amazonaws.firehose#DeliveryStreamName", "traits": { "smithy.api#documentation": "

The name of the delivery stream.

", "smithy.api#required": {} } + }, + "ExclusiveStartDestinationId": { + "target": "com.amazonaws.firehose#DestinationId", + "traits": { + "smithy.api#documentation": "

The ID of the destination to start returning the destination information. Kinesis\n Data Firehose supports one destination per delivery stream.

" + } } } }, @@ -819,17 +819,17 @@ "com.amazonaws.firehose#Deserializer": { "type": "structure", "members": { - "HiveJsonSerDe": { - "target": "com.amazonaws.firehose#HiveJsonSerDe", - "traits": { - "smithy.api#documentation": "

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing\n data, which means converting it from the JSON format in preparation for serializing it to\n the Parquet or ORC format. This is one of two deserializers you can choose, depending on\n which one offers the functionality you need. The other option is the OpenX SerDe.

" - } - }, "OpenXJsonSerDe": { "target": "com.amazonaws.firehose#OpenXJsonSerDe", "traits": { "smithy.api#documentation": "

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means\n converting it from the JSON format in preparation for serializing it to the Parquet or ORC\n format. This is one of two deserializers you can choose, depending on which one offers the\n functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

" } + }, + "HiveJsonSerDe": { + "target": "com.amazonaws.firehose#HiveJsonSerDe", + "traits": { + "smithy.api#documentation": "

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing\n data, which means converting it from the JSON format in preparation for serializing it to\n the Parquet or ORC format. This is one of two deserializers you can choose, depending on\n which one offers the functionality you need. The other option is the OpenX SerDe.

" + } } }, "traits": { @@ -839,10 +839,16 @@ "com.amazonaws.firehose#DestinationDescription": { "type": "structure", "members": { - "RedshiftDestinationDescription": { - "target": "com.amazonaws.firehose#RedshiftDestinationDescription", + "SplunkDestinationDescription": { + "target": "com.amazonaws.firehose#SplunkDestinationDescription", "traits": { - "smithy.api#documentation": "

The destination in Amazon Redshift.

" + "smithy.api#documentation": "

The destination in Splunk.

" + } + }, + "S3DestinationDescription": { + "target": "com.amazonaws.firehose#S3DestinationDescription", + "traits": { + "smithy.api#documentation": "

[Deprecated] The destination in Amazon S3.

" } }, "DestinationId": { @@ -852,28 +858,22 @@ "smithy.api#required": {} } }, - "HttpEndpointDestinationDescription": { - "target": "com.amazonaws.firehose#HttpEndpointDestinationDescription", - "traits": { - "smithy.api#documentation": "

Describes the specified HTTP endpoint destination.

" - } - }, "ElasticsearchDestinationDescription": { "target": "com.amazonaws.firehose#ElasticsearchDestinationDescription", "traits": { "smithy.api#documentation": "

The destination in Amazon ES.

" } }, - "SplunkDestinationDescription": { - "target": "com.amazonaws.firehose#SplunkDestinationDescription", + "HttpEndpointDestinationDescription": { + "target": "com.amazonaws.firehose#HttpEndpointDestinationDescription", "traits": { - "smithy.api#documentation": "

The destination in Splunk.

" + "smithy.api#documentation": "

Describes the specified HTTP endpoint destination.

" } }, - "S3DestinationDescription": { - "target": "com.amazonaws.firehose#S3DestinationDescription", + "RedshiftDestinationDescription": { + "target": "com.amazonaws.firehose#RedshiftDestinationDescription", "traits": { - "smithy.api#documentation": "

[Deprecated] The destination in Amazon S3.

" + "smithy.api#documentation": "

The destination in Amazon Redshift.

" } }, "ExtendedS3DestinationDescription": { @@ -906,17 +906,17 @@ "com.amazonaws.firehose#ElasticsearchBufferingHints": { "type": "structure", "members": { - "SizeInMBs": { - "target": "com.amazonaws.firehose#ElasticsearchBufferingSizeInMBs", - "traits": { - "smithy.api#documentation": "

Buffer incoming data to the specified size, in MBs, before delivering it to the\n destination. The default value is 5.

\n

We recommend setting this parameter to a value greater than the amount of data you\n typically ingest into the delivery stream in 10 seconds. For example, if you typically\n ingest data at 1 MB/sec, the value should be 10 MB or higher.

" - } - }, "IntervalInSeconds": { "target": "com.amazonaws.firehose#ElasticsearchBufferingIntervalInSeconds", "traits": { "smithy.api#documentation": "

Buffer incoming data for the specified period of time, in seconds, before delivering\n it to the destination. The default value is 300 (5 minutes).

" } + }, + "SizeInMBs": { + "target": "com.amazonaws.firehose#ElasticsearchBufferingSizeInMBs", + "traits": { + "smithy.api#documentation": "

Buffer incoming data to the specified size, in MBs, before delivering it to the\n destination. The default value is 5.

\n

We recommend setting this parameter to a value greater than the amount of data you\n typically ingest into the delivery stream in 10 seconds. For example, if you typically\n ingest data at 1 MB/sec, the value should be 10 MB or higher.

" + } } }, "traits": { @@ -956,36 +956,42 @@ "com.amazonaws.firehose#ElasticsearchDestinationConfiguration": { "type": "structure", "members": { - "IndexName": { - "target": "com.amazonaws.firehose#ElasticsearchIndexName", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The Elasticsearch index name.

", + "smithy.api#documentation": "

The data processing configuration.

" + } + }, + "S3Configuration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the backup Amazon S3 location.

", "smithy.api#required": {} } }, - "ClusterEndpoint": { - "target": "com.amazonaws.firehose#ElasticsearchClusterEndpoint", + "VpcConfiguration": { + "target": "com.amazonaws.firehose#VpcConfiguration", "traits": { - "smithy.api#documentation": "

The endpoint to use when communicating with the cluster. Specify either this\n ClusterEndpoint or the DomainARN field.

" + "smithy.api#documentation": "

The details of the VPC of the Amazon ES destination.

" } }, - "S3Configuration": { - "target": "com.amazonaws.firehose#S3DestinationConfiguration", + "IndexName": { + "target": "com.amazonaws.firehose#ElasticsearchIndexName", "traits": { - "smithy.api#documentation": "

The configuration for the backup Amazon S3 location.

", + "smithy.api#documentation": "

The Elasticsearch index name.

", "smithy.api#required": {} } }, - "BufferingHints": { - "target": "com.amazonaws.firehose#ElasticsearchBufferingHints", + "IndexRotationPeriod": { + "target": "com.amazonaws.firehose#ElasticsearchIndexRotationPeriod", "traits": { - "smithy.api#documentation": "

The buffering options. If no value is specified, the default values for\n ElasticsearchBufferingHints are used.

" + "smithy.api#documentation": "

The Elasticsearch index rotation period. Index rotation appends a timestamp to the\n IndexName to facilitate the expiration of old data. For more information,\n see Index Rotation for the\n Amazon ES Destination. The default value is OneDay.

" } }, - "VpcConfiguration": { - "target": "com.amazonaws.firehose#VpcConfiguration", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The details of the VPC of the Amazon ES destination.

" + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } }, "RetryOptions": { @@ -994,10 +1000,16 @@ "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to\n Amazon ES. The default value is 300 (5 minutes).

" } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "BufferingHints": { + "target": "com.amazonaws.firehose#ElasticsearchBufferingHints", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + "smithy.api#documentation": "

The buffering options. If no value is specified, the default values for\n ElasticsearchBufferingHints are used.

" + } + }, + "ClusterEndpoint": { + "target": "com.amazonaws.firehose#ElasticsearchClusterEndpoint", + "traits": { + "smithy.api#documentation": "

The endpoint to use when communicating with the cluster. Specify either this\n ClusterEndpoint or the DomainARN field.

" } }, "TypeName": { @@ -1006,6 +1018,12 @@ "smithy.api#documentation": "

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per\n index. If you try to specify a new type for an existing index that already has another\n type, Kinesis Data Firehose returns an error during run time.

\n\n

For Elasticsearch 7.x, don't specify a TypeName.

" } }, + "DomainARN": { + "target": "com.amazonaws.firehose#ElasticsearchDomainARN", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeElasticsearchDomain, DescribeElasticsearchDomains,\n and DescribeElasticsearchDomainConfig after assuming the role specified in\n RoleARN. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

\n\n

Specify either ClusterEndpoint or DomainARN.

" + } + }, "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { @@ -1013,29 +1031,11 @@ "smithy.api#required": {} } }, - "IndexRotationPeriod": { - "target": "com.amazonaws.firehose#ElasticsearchIndexRotationPeriod", - "traits": { - "smithy.api#documentation": "

The Elasticsearch index rotation period. Index rotation appends a timestamp to the\n IndexName to facilitate the expiration of old data. For more information,\n see Index Rotation for the\n Amazon ES Destination. The default value is OneDay.

" - } - }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", - "traits": { - "smithy.api#documentation": "

The data processing configuration.

" - } - }, "S3BackupMode": { "target": "com.amazonaws.firehose#ElasticsearchS3BackupMode", "traits": { "smithy.api#documentation": "

Defines how documents should be delivered to Amazon S3. When it is set to\n FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could\n not be indexed to the configured Amazon S3 destination, with\n elasticsearch-failed/ appended to the key prefix. When set to\n AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon\n S3, and also writes failed documents with elasticsearch-failed/ appended to\n the prefix. For more information, see Amazon S3 Backup for the\n Amazon ES Destination. Default value is\n FailedDocumentsOnly.

\n

You can't change this backup mode after you create the delivery stream.

" } - }, - "DomainARN": { - "target": "com.amazonaws.firehose#ElasticsearchDomainARN", - "traits": { - "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeElasticsearchDomain, DescribeElasticsearchDomains,\n and DescribeElasticsearchDomainConfig after assuming the role specified in\n RoleARN. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

\n\n

Specify either ClusterEndpoint or DomainARN.

" - } } }, "traits": { @@ -1045,10 +1045,10 @@ "com.amazonaws.firehose#ElasticsearchDestinationDescription": { "type": "structure", "members": { - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "IndexRotationPeriod": { + "target": "com.amazonaws.firehose#ElasticsearchIndexRotationPeriod", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options.

" + "smithy.api#documentation": "

The Elasticsearch index rotation period

" } }, "IndexName": { @@ -1057,10 +1057,10 @@ "smithy.api#documentation": "

The Elasticsearch index name.

" } }, - "VpcConfigurationDescription": { - "target": "com.amazonaws.firehose#VpcConfigurationDescription", + "DomainARN": { + "target": "com.amazonaws.firehose#ElasticsearchDomainARN", "traits": { - "smithy.api#documentation": "

The details of the VPC of the Amazon ES destination.

" + "smithy.api#documentation": "

The ARN of the Amazon ES domain. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

\n\n

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN\n to send data to Amazon ES.

" } }, "ProcessingConfiguration": { @@ -1069,22 +1069,10 @@ "smithy.api#documentation": "

The data processing configuration.

" } }, - "BufferingHints": { - "target": "com.amazonaws.firehose#ElasticsearchBufferingHints", - "traits": { - "smithy.api#documentation": "

The buffering options.

" - } - }, - "S3BackupMode": { - "target": "com.amazonaws.firehose#ElasticsearchS3BackupMode", - "traits": { - "smithy.api#documentation": "

The Amazon S3 backup mode.

" - } - }, - "IndexRotationPeriod": { - "target": "com.amazonaws.firehose#ElasticsearchIndexRotationPeriod", + "VpcConfigurationDescription": { + "target": "com.amazonaws.firehose#VpcConfigurationDescription", "traits": { - "smithy.api#documentation": "

The Elasticsearch index rotation period

" + "smithy.api#documentation": "

The details of the VPC of the Amazon ES destination.

" } }, "ClusterEndpoint": { @@ -1105,10 +1093,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } }, - "DomainARN": { - "target": "com.amazonaws.firehose#ElasticsearchDomainARN", + "S3BackupMode": { + "target": "com.amazonaws.firehose#ElasticsearchS3BackupMode", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon ES domain. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

\n\n

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN\n to send data to Amazon ES.

" + "smithy.api#documentation": "

The Amazon S3 backup mode.

" + } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#ElasticsearchBufferingHints", + "traits": { + "smithy.api#documentation": "

The buffering options.

" } }, "RetryOptions": { @@ -1122,6 +1116,12 @@ "traits": { "smithy.api#documentation": "

The Amazon S3 destination.

" } + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch logging options.

" + } } }, "traits": { @@ -1131,22 +1131,22 @@ "com.amazonaws.firehose#ElasticsearchDestinationUpdate": { "type": "structure", "members": { - "TypeName": { - "target": "com.amazonaws.firehose#ElasticsearchTypeName", + "IndexName": { + "target": "com.amazonaws.firehose#ElasticsearchIndexName", "traits": { - "smithy.api#documentation": "

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per\n index. If you try to specify a new type for an existing index that already has another\n type, Kinesis Data Firehose returns an error during runtime.

\n\n

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream,\n Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type\n name. If you want to update your delivery stream with a new index name, provide an empty\n string for TypeName.

" + "smithy.api#documentation": "

The Elasticsearch index name.

" } }, - "ClusterEndpoint": { - "target": "com.amazonaws.firehose#ElasticsearchClusterEndpoint", + "TypeName": { + "target": "com.amazonaws.firehose#ElasticsearchTypeName", "traits": { - "smithy.api#documentation": "

The endpoint to use when communicating with the cluster. Specify either this\n ClusterEndpoint or the DomainARN field.

" + "smithy.api#documentation": "

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per\n index. If you try to specify a new type for an existing index that already has another\n type, Kinesis Data Firehose returns an error during runtime.

\n\n

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream,\n Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type\n name. If you want to update your delivery stream with a new index name, provide an empty\n string for TypeName.

" } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The CloudWatch logging options for your delivery stream.

" + "smithy.api#documentation": "

The data processing configuration.

" } }, "RoleARN": { @@ -1155,22 +1155,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose\n for calling the Amazon ES Configuration API and for indexing documents. For more\n information, see Grant Kinesis Data\n Firehose Access to an Amazon S3 Destination and Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" } }, - "DomainARN": { - "target": "com.amazonaws.firehose#ElasticsearchDomainARN", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeElasticsearchDomain, DescribeElasticsearchDomains,\n and DescribeElasticsearchDomainConfig after assuming the IAM role specified in\n RoleARN. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

\n\n

Specify either ClusterEndpoint or DomainARN.

" + "smithy.api#documentation": "

The CloudWatch logging options for your delivery stream.

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", + "DomainARN": { + "target": "com.amazonaws.firehose#ElasticsearchDomainARN", "traits": { - "smithy.api#documentation": "

The data processing configuration.

" + "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeElasticsearchDomain, DescribeElasticsearchDomains,\n and DescribeElasticsearchDomainConfig after assuming the IAM role specified in\n RoleARN. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

\n\n

Specify either ClusterEndpoint or DomainARN.

" } }, - "S3Update": { - "target": "com.amazonaws.firehose#S3DestinationUpdate", + "ClusterEndpoint": { + "target": "com.amazonaws.firehose#ElasticsearchClusterEndpoint", "traits": { - "smithy.api#documentation": "

The Amazon S3 destination.

" + "smithy.api#documentation": "

The endpoint to use when communicating with the cluster. Specify either this\n ClusterEndpoint or the DomainARN field.

" } }, "RetryOptions": { @@ -1179,10 +1179,10 @@ "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to\n Amazon ES. The default value is 300 (5 minutes).

" } }, - "IndexName": { - "target": "com.amazonaws.firehose#ElasticsearchIndexName", + "S3Update": { + "target": "com.amazonaws.firehose#S3DestinationUpdate", "traits": { - "smithy.api#documentation": "

The Elasticsearch index name.

" + "smithy.api#documentation": "

The Amazon S3 destination.

" } }, "BufferingHints": { @@ -1330,29 +1330,28 @@ "com.amazonaws.firehose#ExtendedS3DestinationConfiguration": { "type": "structure", "members": { - "S3BackupConfiguration": { - "target": "com.amazonaws.firehose#S3DestinationConfiguration", + "CompressionFormat": { + "target": "com.amazonaws.firehose#CompressionFormat", "traits": { - "smithy.api#documentation": "

The configuration for backup in Amazon S3.

" + "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

" } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "DataFormatConversionConfiguration": { + "target": "com.amazonaws.firehose#DataFormatConversionConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" } }, - "EncryptionConfiguration": { - "target": "com.amazonaws.firehose#EncryptionConfiguration", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

" + "smithy.api#documentation": "

The data processing configuration.

" } }, - "S3BackupMode": { - "target": "com.amazonaws.firehose#S3BackupMode", + "Prefix": { + "target": "com.amazonaws.firehose#Prefix", "traits": { - "smithy.api#documentation": "

The Amazon S3 backup mode. After you create a delivery stream, you can update it to\n enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the\n delivery stream to disable it.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" } }, "CloudWatchLoggingOptions": { @@ -1361,22 +1360,16 @@ "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } }, - "DataFormatConversionConfiguration": { - "target": "com.amazonaws.firehose#DataFormatConversionConfiguration", - "traits": { - "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" - } - }, - "Prefix": { - "target": "com.amazonaws.firehose#Prefix", + "S3BackupMode": { + "target": "com.amazonaws.firehose#S3BackupMode", "traits": { - "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The Amazon S3 backup mode. After you create a delivery stream, you can update it to\n enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the\n delivery stream to disable it.

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", + "EncryptionConfiguration": { + "target": "com.amazonaws.firehose#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The data processing configuration.

" + "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

" } }, "BufferingHints": { @@ -1385,10 +1378,11 @@ "smithy.api#documentation": "

The buffering option.

" } }, - "CompressionFormat": { - "target": "com.amazonaws.firehose#CompressionFormat", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#required": {} } }, "BucketARN": { @@ -1398,6 +1392,12 @@ "smithy.api#required": {} } }, + "S3BackupConfiguration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for backup in Amazon S3.

" + } + }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { @@ -1412,37 +1412,35 @@ "com.amazonaws.firehose#ExtendedS3DestinationDescription": { "type": "structure", "members": { - "BufferingHints": { - "target": "com.amazonaws.firehose#BufferingHints", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The buffering option.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } }, - "EncryptionConfiguration": { - "target": "com.amazonaws.firehose#EncryptionConfiguration", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The data processing configuration.

" } }, - "S3BackupMode": { - "target": "com.amazonaws.firehose#S3BackupMode", + "DataFormatConversionConfiguration": { + "target": "com.amazonaws.firehose#DataFormatConversionConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon S3 backup mode.

" + "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "ErrorOutputPrefix": { + "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" } }, - "ErrorOutputPrefix": { - "target": "com.amazonaws.firehose#ErrorOutputPrefix", + "CompressionFormat": { + "target": "com.amazonaws.firehose#CompressionFormat", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

", + "smithy.api#required": {} } }, "BucketARN": { @@ -1452,41 +1450,43 @@ "smithy.api#required": {} } }, - "CompressionFormat": { - "target": "com.amazonaws.firehose#CompressionFormat", + "Prefix": { + "target": "com.amazonaws.firehose#Prefix", "traits": { - "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", + "S3BackupMode": { + "target": "com.amazonaws.firehose#S3BackupMode", "traits": { - "smithy.api#documentation": "

The data processing configuration.

" + "smithy.api#documentation": "

The Amazon S3 backup mode.

" } }, - "S3BackupDescription": { - "target": "com.amazonaws.firehose#S3DestinationDescription", + "BufferingHints": { + "target": "com.amazonaws.firehose#BufferingHints", "traits": { - "smithy.api#documentation": "

The configuration for backup in Amazon S3.

" + "smithy.api#documentation": "

The buffering option.

", + "smithy.api#required": {} } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "EncryptionConfiguration": { + "target": "com.amazonaws.firehose#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

", + "smithy.api#required": {} } }, - "DataFormatConversionConfiguration": { - "target": "com.amazonaws.firehose#DataFormatConversionConfiguration", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#required": {} } }, - "Prefix": { - "target": "com.amazonaws.firehose#Prefix", + "S3BackupDescription": { + "target": "com.amazonaws.firehose#S3DestinationDescription", "traits": { - "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The configuration for backup in Amazon S3.

" } } }, @@ -1497,28 +1497,22 @@ "com.amazonaws.firehose#ExtendedS3DestinationUpdate": { "type": "structure", "members": { - "EncryptionConfiguration": { - "target": "com.amazonaws.firehose#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

" - } - }, - "BufferingHints": { - "target": "com.amazonaws.firehose#BufferingHints", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The buffering option.

" + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The data processing configuration.

" } }, - "S3BackupUpdate": { - "target": "com.amazonaws.firehose#S3DestinationUpdate", + "DataFormatConversionConfiguration": { + "target": "com.amazonaws.firehose#DataFormatConversionConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon S3 destination for backup.

" + "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" } }, "BucketARN": { @@ -1527,28 +1521,40 @@ "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" } }, + "CompressionFormat": { + "target": "com.amazonaws.firehose#CompressionFormat", + "traits": { + "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

" + } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#BufferingHints", + "traits": { + "smithy.api#documentation": "

The buffering option.

" + } + }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" } }, - "CompressionFormat": { - "target": "com.amazonaws.firehose#CompressionFormat", + "S3BackupMode": { + "target": "com.amazonaws.firehose#S3BackupMode", "traits": { - "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

" + "smithy.api#documentation": "

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If\n backup is enabled, you can't update the delivery stream to disable it.

" } }, - "DataFormatConversionConfiguration": { - "target": "com.amazonaws.firehose#DataFormatConversionConfiguration", + "S3BackupUpdate": { + "target": "com.amazonaws.firehose#S3DestinationUpdate", "traits": { - "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" + "smithy.api#documentation": "

The Amazon S3 destination for backup.

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", + "EncryptionConfiguration": { + "target": "com.amazonaws.firehose#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The data processing configuration.

" + "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

" } }, "Prefix": { @@ -1557,16 +1563,10 @@ "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" - } - }, - "S3BackupMode": { - "target": "com.amazonaws.firehose#S3BackupMode", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If\n backup is enabled, you can't update the delivery stream to disable it.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } } }, @@ -1577,17 +1577,17 @@ "com.amazonaws.firehose#FailureDescription": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.firehose#DeliveryStreamFailureType", + "Details": { + "target": "com.amazonaws.firehose#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of error that caused the failure.

", + "smithy.api#documentation": "

A message providing details about the error that caused the failure.

", "smithy.api#required": {} } }, - "Details": { - "target": "com.amazonaws.firehose#NonEmptyString", + "Type": { + "target": "com.amazonaws.firehose#DeliveryStreamFailureType", "traits": { - "smithy.api#documentation": "

A message providing details about the error that caused the failure.

", + "smithy.api#documentation": "

The type of error that caused the failure.

", "smithy.api#required": {} } } @@ -1642,7 +1642,7 @@ "sdkId": "Firehose", "arnNamespace": "firehose", "cloudFormationName": "KinesisFirehose", - "cloudTrailEventSource": "v20150804.firehose.amazonaws.com" + "cloudTrailEventSource": "firehose.amazonaws.com" }, "aws.auth#sigv4": { "name": "firehose" @@ -1822,12 +1822,6 @@ "com.amazonaws.firehose#HttpEndpointConfiguration": { "type": "structure", "members": { - "AccessKey": { - "target": "com.amazonaws.firehose#HttpEndpointAccessKey", - "traits": { - "smithy.api#documentation": "

The access key required for Kinesis Firehose to authenticate with the HTTP endpoint\n selected as the destination.

" - } - }, "Url": { "target": "com.amazonaws.firehose#HttpEndpointUrl", "traits": { @@ -1840,6 +1834,12 @@ "traits": { "smithy.api#documentation": "

The name of the HTTP endpoint selected as the destination.

" } + }, + "AccessKey": { + "target": "com.amazonaws.firehose#HttpEndpointAccessKey", + "traits": { + "smithy.api#documentation": "

The access key required for Kinesis Firehose to authenticate with the HTTP endpoint\n selected as the destination.

" + } } }, "traits": { @@ -1849,17 +1849,17 @@ "com.amazonaws.firehose#HttpEndpointDescription": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.firehose#HttpEndpointName", - "traits": { - "smithy.api#documentation": "

The name of the HTTP endpoint selected as the destination.

" - } - }, "Url": { "target": "com.amazonaws.firehose#HttpEndpointUrl", "traits": { "smithy.api#documentation": "

The URL of the HTTP endpoint selected as the destination.

" } + }, + "Name": { + "target": "com.amazonaws.firehose#HttpEndpointName", + "traits": { + "smithy.api#documentation": "

The name of the HTTP endpoint selected as the destination.

" + } } }, "traits": { @@ -1869,28 +1869,6 @@ "com.amazonaws.firehose#HttpEndpointDestinationConfiguration": { "type": "structure", "members": { - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration" - }, - "RetryOptions": { - "target": "com.amazonaws.firehose#HttpEndpointRetryOptions", - "traits": { - "smithy.api#documentation": "

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to\n the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of\n receipt from the specified HTTP endpoint destination.

" - } - }, - "EndpointConfiguration": { - "target": "com.amazonaws.firehose#HttpEndpointConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the HTTP endpoint selected as the destination.

", - "smithy.api#required": {} - } - }, - "RequestConfiguration": { - "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the requeste sent to the HTTP endpoint specified as the\n destination.

" - } - }, "S3BackupMode": { "target": "com.amazonaws.firehose#HttpEndpointS3BackupMode", "traits": { @@ -1906,12 +1884,34 @@ "smithy.api#documentation": "

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery\n stream needs.

" } }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, "S3Configuration": { "target": "com.amazonaws.firehose#S3DestinationConfiguration", "traits": { "smithy.api#required": {} } }, + "RequestConfiguration": { + "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the requeste sent to the HTTP endpoint specified as the\n destination.

" + } + }, + "EndpointConfiguration": { + "target": "com.amazonaws.firehose#HttpEndpointConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the HTTP endpoint selected as the destination.

", + "smithy.api#required": {} + } + }, + "RetryOptions": { + "target": "com.amazonaws.firehose#HttpEndpointRetryOptions", + "traits": { + "smithy.api#documentation": "

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to\n the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of\n receipt from the specified HTTP endpoint destination.

" + } + }, "BufferingHints": { "target": "com.amazonaws.firehose#HttpEndpointBufferingHints", "traits": { @@ -1926,21 +1926,6 @@ "com.amazonaws.firehose#HttpEndpointDestinationDescription": { "type": "structure", "members": { - "S3DestinationDescription": { - "target": "com.amazonaws.firehose#S3DestinationDescription" - }, - "RetryOptions": { - "target": "com.amazonaws.firehose#HttpEndpointRetryOptions", - "traits": { - "smithy.api#documentation": "

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to\n the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of\n receipt from the specified HTTP endpoint destination.

" - } - }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" - }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration" - }, "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { @@ -1959,17 +1944,32 @@ "smithy.api#documentation": "

Describes buffering options that can be applied to the data before it is delivered to\n the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it\n might choose to use more optimal values. The SizeInMBs and\n IntervalInSeconds parameters are optional. However, if specify a value for\n one of them, you must also provide a value for the other.

" } }, - "RequestConfiguration": { - "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", + "RetryOptions": { + "target": "com.amazonaws.firehose#HttpEndpointRetryOptions", "traits": { - "smithy.api#documentation": "

The configuration of request sent to the HTTP endpoint specified as the\n destination.

" + "smithy.api#documentation": "

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to\n the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of\n receipt from the specified HTTP endpoint destination.

" } }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "S3DestinationDescription": { + "target": "com.amazonaws.firehose#S3DestinationDescription" + }, "EndpointConfiguration": { "target": "com.amazonaws.firehose#HttpEndpointDescription", "traits": { "smithy.api#documentation": "

The configuration of the specified HTTP endpoint destination.

" } + }, + "RequestConfiguration": { + "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of request sent to the HTTP endpoint specified as the\n destination.

" + } } }, "traits": { @@ -1979,19 +1979,16 @@ "com.amazonaws.firehose#HttpEndpointDestinationUpdate": { "type": "structure", "members": { - "EndpointConfiguration": { - "target": "com.amazonaws.firehose#HttpEndpointConfiguration", + "S3BackupMode": { + "target": "com.amazonaws.firehose#HttpEndpointS3BackupMode", "traits": { - "smithy.api#documentation": "

Describes the configuration of the HTTP endpoint destination.

" + "smithy.api#documentation": "

Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to\n the HTTP endpoint destination. You can back up all documents (AllData) or only\n the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint\n destination (FailedDataOnly).

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration" - }, - "RetryOptions": { - "target": "com.amazonaws.firehose#HttpEndpointRetryOptions", + "BufferingHints": { + "target": "com.amazonaws.firehose#HttpEndpointBufferingHints", "traits": { - "smithy.api#documentation": "

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to\n the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of\n receipt from the specified HTTP endpoint destination.

" + "smithy.api#documentation": "

Describes buffering options that can be applied to the data before it is delivered to\n the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it\n might choose to use more optimal values. The SizeInMBs and\n IntervalInSeconds parameters are optional. However, if specify a value for\n one of them, you must also provide a value for the other.

" } }, "RoleARN": { @@ -2000,25 +1997,28 @@ "smithy.api#documentation": "

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery\n stream needs.

" } }, - "BufferingHints": { - "target": "com.amazonaws.firehose#HttpEndpointBufferingHints", + "RetryOptions": { + "target": "com.amazonaws.firehose#HttpEndpointRetryOptions", "traits": { - "smithy.api#documentation": "

Describes buffering options that can be applied to the data before it is delivered to\n the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it\n might choose to use more optimal values. The SizeInMBs and\n IntervalInSeconds parameters are optional. However, if specify a value for\n one of them, you must also provide a value for the other.

" + "smithy.api#documentation": "

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to\n the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of\n receipt from the specified HTTP endpoint destination.

" } }, - "RequestConfiguration": { - "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the request sent to the HTTP endpoint specified as the\n destination.

" - } + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" }, "CloudWatchLoggingOptions": { "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" }, - "S3BackupMode": { - "target": "com.amazonaws.firehose#HttpEndpointS3BackupMode", + "EndpointConfiguration": { + "target": "com.amazonaws.firehose#HttpEndpointConfiguration", "traits": { - "smithy.api#documentation": "

Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to\n the HTTP endpoint destination. You can back up all documents (AllData) or only\n the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint\n destination (FailedDataOnly).

" + "smithy.api#documentation": "

Describes the configuration of the HTTP endpoint destination.

" + } + }, + "RequestConfiguration": { + "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the request sent to the HTTP endpoint specified as the\n destination.

" } }, "S3Update": { @@ -2149,11 +2149,11 @@ "com.amazonaws.firehose#InvalidKMSResourceException": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.firehose#ErrorCode" - }, "message": { "target": "com.amazonaws.firehose#ErrorMessage" + }, + "code": { + "target": "com.amazonaws.firehose#ErrorCode" } }, "traits": { @@ -2204,17 +2204,17 @@ "com.amazonaws.firehose#KinesisStreamSourceConfiguration": { "type": "structure", "members": { - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "KinesisStreamARN": { + "target": "com.amazonaws.firehose#KinesisStreamARN", "traits": { - "smithy.api#documentation": "

The ARN of the role that provides access to the source Kinesis data stream. For more\n information, see AWS Identity and Access Management (IAM) ARN Format.

", + "smithy.api#documentation": "

The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

", "smithy.api#required": {} } }, - "KinesisStreamARN": { - "target": "com.amazonaws.firehose#KinesisStreamARN", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

", + "smithy.api#documentation": "

The ARN of the role that provides access to the source Kinesis data stream. For more\n information, see AWS Identity and Access Management (IAM) ARN Format.

", "smithy.api#required": {} } } @@ -2226,18 +2226,18 @@ "com.amazonaws.firehose#KinesisStreamSourceDescription": { "type": "structure", "members": { - "DeliveryStartTimestamp": { - "target": "com.amazonaws.firehose#DeliveryStartTimestamp", - "traits": { - "smithy.api#documentation": "

Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting\n with this timestamp.

" - } - }, "KinesisStreamARN": { "target": "com.amazonaws.firehose#KinesisStreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source Kinesis data stream. For more\n information, see Amazon Kinesis Data Streams ARN Format.

" } }, + "DeliveryStartTimestamp": { + "target": "com.amazonaws.firehose#DeliveryStartTimestamp", + "traits": { + "smithy.api#documentation": "

Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting\n with this timestamp.

" + } + }, "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { @@ -2279,18 +2279,18 @@ "com.amazonaws.firehose#ListDeliveryStreamsInput": { "type": "structure", "members": { - "ExclusiveStartDeliveryStreamName": { - "target": "com.amazonaws.firehose#DeliveryStreamName", - "traits": { - "smithy.api#documentation": "

The list of delivery streams returned by this call to\n ListDeliveryStreams will start with the delivery stream whose name comes\n alphabetically immediately after the name you specify in\n ExclusiveStartDeliveryStreamName.

" - } - }, "DeliveryStreamType": { "target": "com.amazonaws.firehose#DeliveryStreamType", "traits": { "smithy.api#documentation": "

The delivery stream type. This can be one of the following values:

\n \n

This parameter is optional. If this parameter is omitted, delivery streams of all\n types are returned.

" } }, + "ExclusiveStartDeliveryStreamName": { + "target": "com.amazonaws.firehose#DeliveryStreamName", + "traits": { + "smithy.api#documentation": "

The list of delivery streams returned by this call to\n ListDeliveryStreams will start with the delivery stream whose name comes\n alphabetically immediately after the name you specify in\n ExclusiveStartDeliveryStreamName.

" + } + }, "Limit": { "target": "com.amazonaws.firehose#ListDeliveryStreamsInputLimit", "traits": { @@ -2312,17 +2312,17 @@ "com.amazonaws.firehose#ListDeliveryStreamsOutput": { "type": "structure", "members": { - "HasMoreDeliveryStreams": { - "target": "com.amazonaws.firehose#BooleanObject", + "DeliveryStreamNames": { + "target": "com.amazonaws.firehose#DeliveryStreamNameList", "traits": { - "smithy.api#documentation": "

Indicates whether there are more delivery streams available to list.

", + "smithy.api#documentation": "

The names of the delivery streams.

", "smithy.api#required": {} } }, - "DeliveryStreamNames": { - "target": "com.amazonaws.firehose#DeliveryStreamNameList", + "HasMoreDeliveryStreams": { + "target": "com.amazonaws.firehose#BooleanObject", "traits": { - "smithy.api#documentation": "

The names of the delivery streams.

", + "smithy.api#documentation": "

Indicates whether there are more delivery streams available to list.

", "smithy.api#required": {} } } @@ -2400,17 +2400,17 @@ "com.amazonaws.firehose#ListTagsForDeliveryStreamOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.firehose#ListTagsForDeliveryStreamOutputTagList", + "HasMoreTags": { + "target": "com.amazonaws.firehose#BooleanObject", "traits": { - "smithy.api#documentation": "

A list of tags associated with DeliveryStreamName, starting with the\n first tag after ExclusiveStartTagKey and up to the specified\n Limit.

", + "smithy.api#documentation": "

If this is true in the response, more tags are available. To list the\n remaining tags, set ExclusiveStartTagKey to the key of the last tag returned\n and call ListTagsForDeliveryStream again.

", "smithy.api#required": {} } }, - "HasMoreTags": { - "target": "com.amazonaws.firehose#BooleanObject", + "Tags": { + "target": "com.amazonaws.firehose#ListTagsForDeliveryStreamOutputTagList", "traits": { - "smithy.api#documentation": "

If this is true in the response, more tags are available. To list the\n remaining tags, set ExclusiveStartTagKey to the key of the last tag returned\n and call ListTagsForDeliveryStream again.

", + "smithy.api#documentation": "

A list of tags associated with DeliveryStreamName, starting with the\n first tag after ExclusiveStartTagKey and up to the specified\n Limit.

", "smithy.api#required": {} } } @@ -2490,10 +2490,10 @@ "com.amazonaws.firehose#OpenXJsonSerDe": { "type": "structure", "members": { - "ColumnToJsonKeyMappings": { - "target": "com.amazonaws.firehose#ColumnToJsonKeyMappings", + "ConvertDotsInJsonKeysToUnderscores": { + "target": "com.amazonaws.firehose#BooleanObject", "traits": { - "smithy.api#documentation": "

Maps column names to JSON keys that aren't identical to the column names. This is\n useful when the JSON contains keys that are Hive keywords. For example,\n timestamp is a Hive keyword. If you have a JSON key named\n timestamp, set this parameter to {\"ts\": \"timestamp\"} to map\n this key to a column named ts.

" + "smithy.api#documentation": "

When set to true, specifies that the names of the keys include dots and\n that you want Kinesis Data Firehose to replace them with underscores. This is useful\n because Apache Hive does not allow dots in column names. For example, if the JSON contains\n a key whose name is \"a.b\", you can define the column name to be \"a_b\" when using this\n option.

\n

The default is false.

" } }, "CaseInsensitive": { @@ -2502,10 +2502,10 @@ "smithy.api#documentation": "

When set to true, which is the default, Kinesis Data Firehose converts\n JSON keys to lowercase before deserializing them.

" } }, - "ConvertDotsInJsonKeysToUnderscores": { - "target": "com.amazonaws.firehose#BooleanObject", + "ColumnToJsonKeyMappings": { + "target": "com.amazonaws.firehose#ColumnToJsonKeyMappings", "traits": { - "smithy.api#documentation": "

When set to true, specifies that the names of the keys include dots and\n that you want Kinesis Data Firehose to replace them with underscores. This is useful\n because Apache Hive does not allow dots in column names. For example, if the JSON contains\n a key whose name is \"a.b\", you can define the column name to be \"a_b\" when using this\n option.

\n

The default is false.

" + "smithy.api#documentation": "

Maps column names to JSON keys that aren't identical to the column names. This is\n useful when the JSON contains keys that are Hive keywords. For example,\n timestamp is a Hive keyword. If you have a JSON key named\n timestamp, set this parameter to {\"ts\": \"timestamp\"} to map\n this key to a column named ts.

" } } }, @@ -2559,30 +2559,6 @@ "com.amazonaws.firehose#OrcSerDe": { "type": "structure", "members": { - "BloomFilterColumns": { - "target": "com.amazonaws.firehose#ListOfNonEmptyStringsWithoutWhitespace", - "traits": { - "smithy.api#documentation": "

The column names for which you want Kinesis Data Firehose to create bloom filters. The\n default is null.

" - } - }, - "PaddingTolerance": { - "target": "com.amazonaws.firehose#Proportion", - "traits": { - "smithy.api#documentation": "

A number between 0 and 1 that defines the tolerance for block padding as a decimal\n fraction of stripe size. The default value is 0.05, which means 5 percent of stripe\n size.

\n

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block\n padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB\n block. In such a case, if the available size within the block is more than 3.2 MiB, a new,\n smaller stripe is inserted to fit within that space. This ensures that no stripe crosses\n block boundaries and causes remote reads within a node-local task.

\n

Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

" - } - }, - "DictionaryKeyThreshold": { - "target": "com.amazonaws.firehose#Proportion", - "traits": { - "smithy.api#documentation": "

Represents the fraction of the total number of non-null rows. To turn off dictionary\n encoding, set this fraction to a number that is less than the number of distinct keys in a\n dictionary. To always use dictionary encoding, set this threshold to 1.

" - } - }, - "BlockSizeBytes": { - "target": "com.amazonaws.firehose#BlockSizeBytes", - "traits": { - "smithy.api#documentation": "

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to\n copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the\n minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

" - } - }, "RowIndexStride": { "target": "com.amazonaws.firehose#OrcRowIndexStride", "traits": { @@ -2601,16 +2577,34 @@ "smithy.api#documentation": "

The version of the file to write. The possible values are V0_11 and\n V0_12. The default is V0_12.

" } }, + "BlockSizeBytes": { + "target": "com.amazonaws.firehose#BlockSizeBytes", + "traits": { + "smithy.api#documentation": "

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to\n copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the\n minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

" + } + }, "Compression": { "target": "com.amazonaws.firehose#OrcCompression", "traits": { "smithy.api#documentation": "

The compression code to use over data blocks. The default is SNAPPY.

" } }, - "BloomFilterFalsePositiveProbability": { + "DictionaryKeyThreshold": { "target": "com.amazonaws.firehose#Proportion", "traits": { - "smithy.api#documentation": "

The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the\n Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

" + "smithy.api#documentation": "

Represents the fraction of the total number of non-null rows. To turn off dictionary\n encoding, set this fraction to a number that is less than the number of distinct keys in a\n dictionary. To always use dictionary encoding, set this threshold to 1.

" + } + }, + "PaddingTolerance": { + "target": "com.amazonaws.firehose#Proportion", + "traits": { + "smithy.api#documentation": "

A number between 0 and 1 that defines the tolerance for block padding as a decimal\n fraction of stripe size. The default value is 0.05, which means 5 percent of stripe\n size.

\n

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block\n padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB\n block. In such a case, if the available size within the block is more than 3.2 MiB, a new,\n smaller stripe is inserted to fit within that space. This ensures that no stripe crosses\n block boundaries and causes remote reads within a node-local task.

\n

Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

" + } + }, + "BloomFilterColumns": { + "target": "com.amazonaws.firehose#ListOfNonEmptyStringsWithoutWhitespace", + "traits": { + "smithy.api#documentation": "

The column names for which you want Kinesis Data Firehose to create bloom filters. The\n default is null.

" } }, "EnablePadding": { @@ -2618,6 +2612,12 @@ "traits": { "smithy.api#documentation": "

Set this to true to indicate that you want stripes to be padded to the HDFS\n block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS\n before querying. The default is false.

" } + }, + "BloomFilterFalsePositiveProbability": { + "target": "com.amazonaws.firehose#Proportion", + "traits": { + "smithy.api#documentation": "

The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the\n Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

" + } } }, "traits": { @@ -2678,16 +2678,10 @@ "com.amazonaws.firehose#ParquetSerDe": { "type": "structure", "members": { - "Compression": { - "target": "com.amazonaws.firehose#ParquetCompression", - "traits": { - "smithy.api#documentation": "

The compression code to use over data blocks. The possible values are\n UNCOMPRESSED, SNAPPY, and GZIP, with the default\n being SNAPPY. Use SNAPPY for higher decompression speed. Use\n GZIP if the compression ratio is more important than speed.

" - } - }, - "BlockSizeBytes": { - "target": "com.amazonaws.firehose#BlockSizeBytes", + "WriterVersion": { + "target": "com.amazonaws.firehose#ParquetWriterVersion", "traits": { - "smithy.api#documentation": "

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to\n copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the\n minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

" + "smithy.api#documentation": "

Indicates the version of row format to output. The possible values are V1\n and V2. The default is V1.

" } }, "PageSizeBytes": { @@ -2696,10 +2690,16 @@ "smithy.api#documentation": "

The Parquet page size. Column chunks are divided into pages. A page is conceptually an\n indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and\n the default is 1 MiB.

" } }, - "WriterVersion": { - "target": "com.amazonaws.firehose#ParquetWriterVersion", + "BlockSizeBytes": { + "target": "com.amazonaws.firehose#BlockSizeBytes", "traits": { - "smithy.api#documentation": "

Indicates the version of row format to output. The possible values are V1\n and V2. The default is V1.

" + "smithy.api#documentation": "

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to\n copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the\n minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

" + } + }, + "MaxPaddingBytes": { + "target": "com.amazonaws.firehose#NonNegativeIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum amount of padding to apply. This is useful if you intend to copy the data\n from Amazon S3 to HDFS before querying. The default is 0.

" } }, "EnableDictionaryCompression": { @@ -2708,10 +2708,10 @@ "smithy.api#documentation": "

Indicates whether to enable dictionary compression.

" } }, - "MaxPaddingBytes": { - "target": "com.amazonaws.firehose#NonNegativeIntegerObject", + "Compression": { + "target": "com.amazonaws.firehose#ParquetCompression", "traits": { - "smithy.api#documentation": "

The maximum amount of padding to apply. This is useful if you intend to copy the data\n from Amazon S3 to HDFS before querying. The default is 0.

" + "smithy.api#documentation": "

The compression code to use over data blocks. The possible values are\n UNCOMPRESSED, SNAPPY, and GZIP, with the default\n being SNAPPY. Use SNAPPY for higher decompression speed. Use\n GZIP if the compression ratio is more important than speed.

" } } }, @@ -2758,17 +2758,17 @@ "com.amazonaws.firehose#ProcessingConfiguration": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.firehose#BooleanObject", - "traits": { - "smithy.api#documentation": "

Enables or disables data processing.

" - } - }, "Processors": { "target": "com.amazonaws.firehose#ProcessorList", "traits": { "smithy.api#documentation": "

The data processors.

" } + }, + "Enabled": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Enables or disables data processing.

" + } } }, "traits": { @@ -2942,17 +2942,17 @@ "com.amazonaws.firehose#PutRecordBatchInput": { "type": "structure", "members": { - "Records": { - "target": "com.amazonaws.firehose#PutRecordBatchRequestEntryList", + "DeliveryStreamName": { + "target": "com.amazonaws.firehose#DeliveryStreamName", "traits": { - "smithy.api#documentation": "

One or more records.

", + "smithy.api#documentation": "

The name of the delivery stream.

", "smithy.api#required": {} } }, - "DeliveryStreamName": { - "target": "com.amazonaws.firehose#DeliveryStreamName", + "Records": { + "target": "com.amazonaws.firehose#PutRecordBatchRequestEntryList", "traits": { - "smithy.api#documentation": "

The name of the delivery stream.

", + "smithy.api#documentation": "

One or more records.

", "smithy.api#required": {} } } @@ -2961,12 +2961,6 @@ "com.amazonaws.firehose#PutRecordBatchOutput": { "type": "structure", "members": { - "Encrypted": { - "target": "com.amazonaws.firehose#BooleanObject", - "traits": { - "smithy.api#documentation": "

Indicates whether server-side encryption (SSE) was enabled during this operation.

" - } - }, "FailedPutCount": { "target": "com.amazonaws.firehose#NonNegativeIntegerObject", "traits": { @@ -2974,6 +2968,12 @@ "smithy.api#required": {} } }, + "Encrypted": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether server-side encryption (SSE) was enabled during this operation.

" + } + }, "RequestResponses": { "target": "com.amazonaws.firehose#PutRecordBatchResponseEntryList", "traits": { @@ -2998,12 +2998,6 @@ "com.amazonaws.firehose#PutRecordBatchResponseEntry": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.firehose#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message for an individual record result.

" - } - }, "RecordId": { "target": "com.amazonaws.firehose#PutResponseRecordId", "traits": { @@ -3015,6 +3009,12 @@ "traits": { "smithy.api#documentation": "

The error code for an individual record result.

" } + }, + "ErrorMessage": { + "target": "com.amazonaws.firehose#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message for an individual record result.

" + } } }, "traits": { @@ -3096,39 +3096,19 @@ "com.amazonaws.firehose#RedshiftDestinationConfiguration": { "type": "structure", "members": { - "S3Configuration": { - "target": "com.amazonaws.firehose#S3DestinationConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for the intermediate Amazon S3 location from which Amazon Redshift\n obtains data. Restrictions are described in the topic for CreateDeliveryStream.

\n

The compression formats SNAPPY or ZIP cannot be specified\n in RedshiftDestinationConfiguration.S3Configuration because the Amazon\n Redshift COPY operation that reads from the S3 bucket doesn't support these\n compression formats.

", - "smithy.api#required": {} - } - }, - "Username": { - "target": "com.amazonaws.firehose#Username", + "RetryOptions": { + "target": "com.amazonaws.firehose#RedshiftRetryOptions", "traits": { - "smithy.api#documentation": "

The name of the user.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to\n Amazon Redshift. Default value is 3600 (60 minutes).

" } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "CopyCommand": { + "target": "com.amazonaws.firehose#CopyCommand", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#documentation": "

The COPY command.

", "smithy.api#required": {} } }, - "S3BackupConfiguration": { - "target": "com.amazonaws.firehose#S3DestinationConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for backup in Amazon S3.

" - } - }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", - "traits": { - "smithy.api#documentation": "

The CloudWatch logging options for your delivery stream.

" - } - }, "ClusterJDBCURL": { "target": "com.amazonaws.firehose#ClusterJDBCURL", "traits": { @@ -3143,30 +3123,50 @@ "smithy.api#required": {} } }, + "Username": { + "target": "com.amazonaws.firehose#Username", + "traits": { + "smithy.api#documentation": "

The name of the user.

", + "smithy.api#required": {} + } + }, "S3BackupMode": { "target": "com.amazonaws.firehose#RedshiftS3BackupMode", "traits": { "smithy.api#documentation": "

The Amazon S3 backup mode. After you create a delivery stream, you can update it to\n enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the\n delivery stream to disable it.

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", + "S3Configuration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration", "traits": { - "smithy.api#documentation": "

The data processing configuration.

" + "smithy.api#documentation": "

The configuration for the intermediate Amazon S3 location from which Amazon Redshift\n obtains data. Restrictions are described in the topic for CreateDeliveryStream.

\n

The compression formats SNAPPY or ZIP cannot be specified\n in RedshiftDestinationConfiguration.S3Configuration because the Amazon\n Redshift COPY operation that reads from the S3 bucket doesn't support these\n compression formats.

", + "smithy.api#required": {} } }, - "RetryOptions": { - "target": "com.amazonaws.firehose#RedshiftRetryOptions", + "S3BackupConfiguration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration", "traits": { - "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to\n Amazon Redshift. Default value is 3600 (60 minutes).

" + "smithy.api#documentation": "

The configuration for backup in Amazon S3.

" } }, - "CopyCommand": { - "target": "com.amazonaws.firehose#CopyCommand", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The COPY command.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "traits": { + "smithy.api#documentation": "

The CloudWatch logging options for your delivery stream.

" + } + }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", + "traits": { + "smithy.api#documentation": "

The data processing configuration.

" + } } }, "traits": { @@ -3176,16 +3176,22 @@ "com.amazonaws.firehose#RedshiftDestinationDescription": { "type": "structure", "members": { - "S3BackupMode": { - "target": "com.amazonaws.firehose#RedshiftS3BackupMode", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The Amazon S3 backup mode.

" + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#documentation": "

The data processing configuration.

" + } + }, + "Username": { + "target": "com.amazonaws.firehose#Username", + "traits": { + "smithy.api#documentation": "

The name of the user.

", "smithy.api#required": {} } }, @@ -3209,29 +3215,23 @@ "smithy.api#required": {} } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", - "traits": { - "smithy.api#documentation": "

The data processing configuration.

" - } - }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "S3BackupMode": { + "target": "com.amazonaws.firehose#RedshiftS3BackupMode", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + "smithy.api#documentation": "

The Amazon S3 backup mode.

" } }, - "Username": { - "target": "com.amazonaws.firehose#Username", + "ClusterJDBCURL": { + "target": "com.amazonaws.firehose#ClusterJDBCURL", "traits": { - "smithy.api#documentation": "

The name of the user.

", + "smithy.api#documentation": "

The database connection string.

", "smithy.api#required": {} } }, - "ClusterJDBCURL": { - "target": "com.amazonaws.firehose#ClusterJDBCURL", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The database connection string.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } }, @@ -3249,10 +3249,16 @@ "com.amazonaws.firehose#RedshiftDestinationUpdate": { "type": "structure", "members": { - "S3BackupUpdate": { - "target": "com.amazonaws.firehose#S3DestinationUpdate", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The Amazon S3 destination for backup.

" + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "Username": { + "target": "com.amazonaws.firehose#Username", + "traits": { + "smithy.api#documentation": "

The name of the user.

" } }, "CopyCommand": { @@ -3261,22 +3267,22 @@ "smithy.api#documentation": "

The COPY command.

" } }, - "RetryOptions": { - "target": "com.amazonaws.firehose#RedshiftRetryOptions", + "S3BackupUpdate": { + "target": "com.amazonaws.firehose#S3DestinationUpdate", "traits": { - "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to\n Amazon Redshift. Default value is 3600 (60 minutes).

" + "smithy.api#documentation": "

The Amazon S3 destination for backup.

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", + "RetryOptions": { + "target": "com.amazonaws.firehose#RedshiftRetryOptions", "traits": { - "smithy.api#documentation": "

The data processing configuration.

" + "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to\n Amazon Redshift. Default value is 3600 (60 minutes).

" } }, - "Username": { - "target": "com.amazonaws.firehose#Username", + "ClusterJDBCURL": { + "target": "com.amazonaws.firehose#ClusterJDBCURL", "traits": { - "smithy.api#documentation": "

The name of the user.

" + "smithy.api#documentation": "

The database connection string.

" } }, "S3Update": { @@ -3285,34 +3291,28 @@ "smithy.api#documentation": "

The Amazon S3 destination.

\n

The compression formats SNAPPY or ZIP cannot be specified\n in RedshiftDestinationUpdate.S3Update because the Amazon Redshift\n COPY operation that reads from the S3 bucket doesn't support these\n compression formats.

" } }, - "Password": { - "target": "com.amazonaws.firehose#Password", - "traits": { - "smithy.api#documentation": "

The user password.

" - } - }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The data processing configuration.

" } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "S3BackupMode": { + "target": "com.amazonaws.firehose#RedshiftS3BackupMode", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + "smithy.api#documentation": "

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If\n backup is enabled, you can't update the delivery stream to disable it.

" } }, - "ClusterJDBCURL": { - "target": "com.amazonaws.firehose#ClusterJDBCURL", + "Password": { + "target": "com.amazonaws.firehose#Password", "traits": { - "smithy.api#documentation": "

The database connection string.

" + "smithy.api#documentation": "

The user password.

" } }, - "S3BackupMode": { - "target": "com.amazonaws.firehose#RedshiftS3BackupMode", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If\n backup is enabled, you can't update the delivery stream to disable it.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } } }, @@ -3413,18 +3413,6 @@ "com.amazonaws.firehose#S3DestinationConfiguration": { "type": "structure", "members": { - "CompressionFormat": { - "target": "com.amazonaws.firehose#CompressionFormat", - "traits": { - "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

\n

The compression formats SNAPPY or ZIP cannot be specified\n for Amazon Redshift destinations because they are not supported by the Amazon Redshift\n COPY operation that reads from the S3 bucket.

" - } - }, - "Prefix": { - "target": "com.amazonaws.firehose#Prefix", - "traits": { - "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" - } - }, "BufferingHints": { "target": "com.amazonaws.firehose#BufferingHints", "traits": { @@ -3437,17 +3425,10 @@ "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

" } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", - "smithy.api#required": {} - } - }, - "ErrorOutputPrefix": { - "target": "com.amazonaws.firehose#ErrorOutputPrefix", + "Prefix": { + "target": "com.amazonaws.firehose#Prefix", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" } }, "CloudWatchLoggingOptions": { @@ -3462,6 +3443,25 @@ "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } + }, + "ErrorOutputPrefix": { + "target": "com.amazonaws.firehose#ErrorOutputPrefix", + "traits": { + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + } + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#required": {} + } + }, + "CompressionFormat": { + "target": "com.amazonaws.firehose#CompressionFormat", + "traits": { + "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

\n

The compression formats SNAPPY or ZIP cannot be specified\n for Amazon Redshift destinations because they are not supported by the Amazon Redshift\n COPY operation that reads from the S3 bucket.

" + } } }, "traits": { @@ -3471,23 +3471,10 @@ "com.amazonaws.firehose#S3DestinationDescription": { "type": "structure", "members": { - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" - } - }, - "ErrorOutputPrefix": { - "target": "com.amazonaws.firehose#ErrorOutputPrefix", - "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" - } - }, - "BucketARN": { - "target": "com.amazonaws.firehose#BucketARN", + "Prefix": { + "target": "com.amazonaws.firehose#Prefix", "traits": { - "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" } }, "CompressionFormat": { @@ -3504,10 +3491,23 @@ "smithy.api#required": {} } }, - "Prefix": { - "target": "com.amazonaws.firehose#Prefix", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "ErrorOutputPrefix": { + "target": "com.amazonaws.firehose#ErrorOutputPrefix", + "traits": { + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + } + }, + "BucketARN": { + "target": "com.amazonaws.firehose#BucketARN", + "traits": { + "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#required": {} } }, "BufferingHints": { @@ -3532,22 +3532,16 @@ "com.amazonaws.firehose#S3DestinationUpdate": { "type": "structure", "members": { - "EncryptionConfiguration": { - "target": "com.amazonaws.firehose#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

" - } - }, - "BufferingHints": { - "target": "com.amazonaws.firehose#BufferingHints", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

The buffering option. If no value is specified, BufferingHints object\n default values are used.

" + "smithy.api#documentation": "

The CloudWatch logging options for your delivery stream.

" } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "ErrorOutputPrefix": { + "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" } }, "BucketARN": { @@ -3556,28 +3550,34 @@ "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" } }, - "ErrorOutputPrefix": { - "target": "com.amazonaws.firehose#ErrorOutputPrefix", - "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" - } - }, "CompressionFormat": { "target": "com.amazonaws.firehose#CompressionFormat", "traits": { "smithy.api#documentation": "

The compression format. If no value is specified, the default is\n UNCOMPRESSED.

\n

The compression formats SNAPPY or ZIP cannot be specified\n for Amazon Redshift destinations because they are not supported by the Amazon Redshift\n COPY operation that reads from the S3 bucket.

" } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "Prefix": { + "target": "com.amazonaws.firehose#Prefix", + "traits": { + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.firehose#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration. If no value is specified, the default is no\n encryption.

" + } + }, + "BufferingHints": { + "target": "com.amazonaws.firehose#BufferingHints", "traits": { - "smithy.api#documentation": "

The CloudWatch logging options for your delivery stream.

" + "smithy.api#documentation": "

The buffering option. If no value is specified, BufferingHints object\n default values are used.

" } }, - "Prefix": { - "target": "com.amazonaws.firehose#Prefix", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } } }, @@ -3594,16 +3594,16 @@ "smithy.api#documentation": "

Specifies the name of the AWS Glue database that contains the schema for the output\n data.

" } }, - "RoleARN": { + "CatalogId": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in\n the same account you use for Kinesis Data Firehose. Cross-account roles aren't\n allowed.

" + "smithy.api#documentation": "

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is\n used by default.

" } }, - "TableName": { + "RoleARN": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

Specifies the AWS Glue table that contains the column information that constitutes your\n data schema.

" + "smithy.api#documentation": "

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in\n the same account you use for Kinesis Data Firehose. Cross-account roles aren't\n allowed.

" } }, "Region": { @@ -3612,10 +3612,10 @@ "smithy.api#documentation": "

If you don't specify an AWS Region, the default is the current Region.

" } }, - "CatalogId": { + "TableName": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is\n used by default.

" + "smithy.api#documentation": "

Specifies the AWS Glue table that contains the column information that constitutes your\n data schema.

" } }, "VersionId": { @@ -3704,29 +3704,23 @@ "com.amazonaws.firehose#SplunkDestinationConfiguration": { "type": "structure", "members": { - "HECAcknowledgmentTimeoutInSeconds": { - "target": "com.amazonaws.firehose#HECAcknowledgmentTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from\n Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose\n either tries to send the data again or considers it an error, based on your retry\n settings.

" - } - }, - "HECToken": { - "target": "com.amazonaws.firehose#HECToken", + "S3Configuration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration", "traits": { - "smithy.api#documentation": "

This is a GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.

", + "smithy.api#documentation": "

The configuration for the backup Amazon S3 location.

", "smithy.api#required": {} } }, - "RetryOptions": { - "target": "com.amazonaws.firehose#SplunkRetryOptions", + "S3BackupMode": { + "target": "com.amazonaws.firehose#SplunkS3BackupMode", "traits": { - "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk,\n or if it doesn't receive an acknowledgment of receipt from Splunk.

" + "smithy.api#documentation": "

Defines how documents should be delivered to Amazon S3. When set to\n FailedEventsOnly, Kinesis Data Firehose writes any data that could not be\n indexed to the configured Amazon S3 destination. When set to AllEvents,\n Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed\n documents to Amazon S3. The default value is FailedEventsOnly.

\n

You can update this backup mode from FailedEventsOnly to\n AllEvents. You can't update it from AllEvents to\n FailedEventsOnly.

" } }, - "HECEndpointType": { - "target": "com.amazonaws.firehose#HECEndpointType", + "HECEndpoint": { + "target": "com.amazonaws.firehose#HECEndpoint", "traits": { - "smithy.api#documentation": "

This type can be either \"Raw\" or \"Event.\"

", + "smithy.api#documentation": "

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your\n data.

", "smithy.api#required": {} } }, @@ -3736,29 +3730,35 @@ "smithy.api#documentation": "

The data processing configuration.

" } }, - "S3BackupMode": { - "target": "com.amazonaws.firehose#SplunkS3BackupMode", - "traits": { - "smithy.api#documentation": "

Defines how documents should be delivered to Amazon S3. When set to\n FailedEventsOnly, Kinesis Data Firehose writes any data that could not be\n indexed to the configured Amazon S3 destination. When set to AllEvents,\n Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed\n documents to Amazon S3. The default value is FailedEventsOnly.

\n

You can update this backup mode from FailedEventsOnly to\n AllEvents. You can't update it from AllEvents to\n FailedEventsOnly.

" - } - }, "CloudWatchLoggingOptions": { "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } }, - "S3Configuration": { - "target": "com.amazonaws.firehose#S3DestinationConfiguration", + "RetryOptions": { + "target": "com.amazonaws.firehose#SplunkRetryOptions", "traits": { - "smithy.api#documentation": "

The configuration for the backup Amazon S3 location.

", + "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk,\n or if it doesn't receive an acknowledgment of receipt from Splunk.

" + } + }, + "HECToken": { + "target": "com.amazonaws.firehose#HECToken", + "traits": { + "smithy.api#documentation": "

This is a GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.

", "smithy.api#required": {} } }, - "HECEndpoint": { - "target": "com.amazonaws.firehose#HECEndpoint", + "HECAcknowledgmentTimeoutInSeconds": { + "target": "com.amazonaws.firehose#HECAcknowledgmentTimeoutInSeconds", "traits": { - "smithy.api#documentation": "

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your\n data.

", + "smithy.api#documentation": "

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from\n Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose\n either tries to send the data again or considers it an error, based on your retry\n settings.

" + } + }, + "HECEndpointType": { + "target": "com.amazonaws.firehose#HECEndpointType", + "traits": { + "smithy.api#documentation": "

This type can be either \"Raw\" or \"Event.\"

", "smithy.api#required": {} } } @@ -3770,28 +3770,28 @@ "com.amazonaws.firehose#SplunkDestinationDescription": { "type": "structure", "members": { - "S3BackupMode": { - "target": "com.amazonaws.firehose#SplunkS3BackupMode", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

Defines how documents should be delivered to Amazon S3. When set to\n FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not\n be indexed to the configured Amazon S3 destination. When set to AllDocuments,\n Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed\n documents to Amazon S3. Default value is FailedDocumentsOnly.

" + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } }, - "HECToken": { - "target": "com.amazonaws.firehose#HECToken", + "HECEndpointType": { + "target": "com.amazonaws.firehose#HECEndpointType", "traits": { - "smithy.api#documentation": "

A GUID you obtain from your Splunk cluster when you create a new HEC\n endpoint.

" + "smithy.api#documentation": "

This type can be either \"Raw\" or \"Event.\"

" } }, - "RetryOptions": { - "target": "com.amazonaws.firehose#SplunkRetryOptions", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk\n or if it doesn't receive an acknowledgment of receipt from Splunk.

" + "smithy.api#documentation": "

The data processing configuration.

" } }, - "HECEndpointType": { - "target": "com.amazonaws.firehose#HECEndpointType", + "HECEndpoint": { + "target": "com.amazonaws.firehose#HECEndpoint", "traits": { - "smithy.api#documentation": "

This type can be either \"Raw\" or \"Event.\"

" + "smithy.api#documentation": "

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your\n data.

" } }, "HECAcknowledgmentTimeoutInSeconds": { @@ -3800,22 +3800,22 @@ "smithy.api#documentation": "

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from\n Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose\n either tries to send the data again or considers it an error, based on your retry\n settings.

" } }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", + "HECToken": { + "target": "com.amazonaws.firehose#HECToken", "traits": { - "smithy.api#documentation": "

The data processing configuration.

" + "smithy.api#documentation": "

A GUID you obtain from your Splunk cluster when you create a new HEC\n endpoint.

" } }, - "HECEndpoint": { - "target": "com.amazonaws.firehose#HECEndpoint", + "RetryOptions": { + "target": "com.amazonaws.firehose#SplunkRetryOptions", "traits": { - "smithy.api#documentation": "

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your\n data.

" + "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk\n or if it doesn't receive an acknowledgment of receipt from Splunk.

" } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "S3BackupMode": { + "target": "com.amazonaws.firehose#SplunkS3BackupMode", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + "smithy.api#documentation": "

Defines how documents should be delivered to Amazon S3. When set to\n FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not\n be indexed to the configured Amazon S3 destination. When set to AllDocuments,\n Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed\n documents to Amazon S3. Default value is FailedDocumentsOnly.

" } }, "S3DestinationDescription": { @@ -3832,30 +3832,18 @@ "com.amazonaws.firehose#SplunkDestinationUpdate": { "type": "structure", "members": { - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" - } - }, - "HECEndpoint": { - "target": "com.amazonaws.firehose#HECEndpoint", - "traits": { - "smithy.api#documentation": "

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your\n data.

" - } - }, - "ProcessingConfiguration": { - "target": "com.amazonaws.firehose#ProcessingConfiguration", - "traits": { - "smithy.api#documentation": "

The data processing configuration.

" - } - }, "HECEndpointType": { "target": "com.amazonaws.firehose#HECEndpointType", "traits": { "smithy.api#documentation": "

This type can be either \"Raw\" or \"Event.\"

" } }, + "S3Update": { + "target": "com.amazonaws.firehose#S3DestinationUpdate", + "traits": { + "smithy.api#documentation": "

Your update to the configuration of the backup Amazon S3 location.

" + } + }, "RetryOptions": { "target": "com.amazonaws.firehose#SplunkRetryOptions", "traits": { @@ -3868,16 +3856,28 @@ "smithy.api#documentation": "

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from\n Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either\n tries to send the data again or considers it an error, based on your retry\n settings.

" } }, - "HECToken": { - "target": "com.amazonaws.firehose#HECToken", + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration", "traits": { - "smithy.api#documentation": "

A GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.

" + "smithy.api#documentation": "

The data processing configuration.

" } }, - "S3Update": { - "target": "com.amazonaws.firehose#S3DestinationUpdate", + "HECEndpoint": { + "target": "com.amazonaws.firehose#HECEndpoint", "traits": { - "smithy.api#documentation": "

Your update to the configuration of the backup Amazon S3 location.

" + "smithy.api#documentation": "

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your\n data.

" + } + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "HECToken": { + "target": "com.amazonaws.firehose#HECToken", + "traits": { + "smithy.api#documentation": "

A GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.

" } }, "S3BackupMode": { @@ -4083,17 +4083,17 @@ "com.amazonaws.firehose#TagDeliveryStreamInput": { "type": "structure", "members": { - "DeliveryStreamName": { - "target": "com.amazonaws.firehose#DeliveryStreamName", + "Tags": { + "target": "com.amazonaws.firehose#TagDeliveryStreamInputTagList", "traits": { - "smithy.api#documentation": "

The name of the delivery stream to which you want to add the tags.

", + "smithy.api#documentation": "

A set of key-value pairs to use to create the tags.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.firehose#TagDeliveryStreamInputTagList", + "DeliveryStreamName": { + "target": "com.amazonaws.firehose#DeliveryStreamName", "traits": { - "smithy.api#documentation": "

A set of key-value pairs to use to create the tags.

", + "smithy.api#documentation": "

The name of the delivery stream to which you want to add the tags.

", "smithy.api#required": {} } } @@ -4179,17 +4179,17 @@ "com.amazonaws.firehose#UntagDeliveryStreamInput": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.firehose#TagKeyList", + "DeliveryStreamName": { + "target": "com.amazonaws.firehose#DeliveryStreamName", "traits": { - "smithy.api#documentation": "

A list of tag keys. Each corresponding tag is removed from the delivery\n stream.

", + "smithy.api#documentation": "

The name of the delivery stream.

", "smithy.api#required": {} } }, - "DeliveryStreamName": { - "target": "com.amazonaws.firehose#DeliveryStreamName", + "TagKeys": { + "target": "com.amazonaws.firehose#TagKeyList", "traits": { - "smithy.api#documentation": "

The name of the delivery stream.

", + "smithy.api#documentation": "

A list of tag keys. Each corresponding tag is removed from the delivery\n stream.

", "smithy.api#required": {} } } @@ -4228,36 +4228,31 @@ "com.amazonaws.firehose#UpdateDestinationInput": { "type": "structure", "members": { - "HttpEndpointDestinationUpdate": { - "target": "com.amazonaws.firehose#HttpEndpointDestinationUpdate", - "traits": { - "smithy.api#documentation": "

Describes an update to the specified HTTP endpoint destination.

" - } - }, - "DeliveryStreamName": { - "target": "com.amazonaws.firehose#DeliveryStreamName", + "DestinationId": { + "target": "com.amazonaws.firehose#DestinationId", "traits": { - "smithy.api#documentation": "

The name of the delivery stream.

", + "smithy.api#documentation": "

The ID of the destination.

", "smithy.api#required": {} } }, - "ElasticsearchDestinationUpdate": { - "target": "com.amazonaws.firehose#ElasticsearchDestinationUpdate", + "S3DestinationUpdate": { + "target": "com.amazonaws.firehose#S3DestinationUpdate", "traits": { - "smithy.api#documentation": "

Describes an update for a destination in Amazon ES.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

[Deprecated] Describes an update for a destination in Amazon S3.

" } }, - "ExtendedS3DestinationUpdate": { - "target": "com.amazonaws.firehose#ExtendedS3DestinationUpdate", + "HttpEndpointDestinationUpdate": { + "target": "com.amazonaws.firehose#HttpEndpointDestinationUpdate", "traits": { - "smithy.api#documentation": "

Describes an update for a destination in Amazon S3.

" + "smithy.api#documentation": "

Describes an update to the specified HTTP endpoint destination.

" } }, - "S3DestinationUpdate": { - "target": "com.amazonaws.firehose#S3DestinationUpdate", + "DeliveryStreamName": { + "target": "com.amazonaws.firehose#DeliveryStreamName", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

[Deprecated] Describes an update for a destination in Amazon S3.

" + "smithy.api#documentation": "

The name of the delivery stream.

", + "smithy.api#required": {} } }, "RedshiftDestinationUpdate": { @@ -4273,17 +4268,22 @@ "smithy.api#required": {} } }, - "SplunkDestinationUpdate": { - "target": "com.amazonaws.firehose#SplunkDestinationUpdate", + "ExtendedS3DestinationUpdate": { + "target": "com.amazonaws.firehose#ExtendedS3DestinationUpdate", "traits": { - "smithy.api#documentation": "

Describes an update for a destination in Splunk.

" + "smithy.api#documentation": "

Describes an update for a destination in Amazon S3.

" } }, - "DestinationId": { - "target": "com.amazonaws.firehose#DestinationId", + "ElasticsearchDestinationUpdate": { + "target": "com.amazonaws.firehose#ElasticsearchDestinationUpdate", "traits": { - "smithy.api#documentation": "

The ID of the destination.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Describes an update for a destination in Amazon ES.

" + } + }, + "SplunkDestinationUpdate": { + "target": "com.amazonaws.firehose#SplunkDestinationUpdate", + "traits": { + "smithy.api#documentation": "

Describes an update for a destination in Splunk.

" } } } @@ -4335,10 +4335,10 @@ "com.amazonaws.firehose#VpcConfigurationDescription": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.firehose#SubnetIdList", + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the\n Amazon ES destination. Make sure that the routing tables and inbound and outbound rules\n allow traffic to flow from the subnets whose IDs are specified here to the subnets that\n have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in\n each of the subnets that are specified here. Do not delete or modify these ENIs.

\n

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Kinesis Data Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Kinesis Data Firehose can create up to\n three ENIs for this delivery stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

", + "smithy.api#documentation": "

The ARN of the IAM role that the delivery stream uses to create endpoints in the\n destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can\n specify a new role. In either case, make sure that the role trusts the Kinesis Data\n Firehose service principal and that it grants the following permissions:

\n \n

If you revoke these permissions after you create the delivery stream, Kinesis Data\n Firehose can't scale out by creating more ENIs when necessary. You might therefore see a\n degradation in performance.

", "smithy.api#required": {} } }, @@ -4349,10 +4349,10 @@ "smithy.api#required": {} } }, - "RoleARN": { - "target": "com.amazonaws.firehose#RoleARN", + "SubnetIds": { + "target": "com.amazonaws.firehose#SubnetIdList", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that the delivery stream uses to create endpoints in the\n destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can\n specify a new role. In either case, make sure that the role trusts the Kinesis Data\n Firehose service principal and that it grants the following permissions:

\n \n

If you revoke these permissions after you create the delivery stream, Kinesis Data\n Firehose can't scale out by creating more ENIs when necessary. You might therefore see a\n degradation in performance.

", + "smithy.api#documentation": "

The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the\n Amazon ES destination. Make sure that the routing tables and inbound and outbound rules\n allow traffic to flow from the subnets whose IDs are specified here to the subnets that\n have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in\n each of the subnets that are specified here. Do not delete or modify these ENIs.

\n

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Kinesis Data Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Kinesis Data Firehose can create up to\n three ENIs for this delivery stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/fms.2018-01-01.json b/codegen/sdk-codegen/aws-models/fms.2018-01-01.json index 80ae5589a8c7..98d75f6a37e5 100644 --- a/codegen/sdk-codegen/aws-models/fms.2018-01-01.json +++ b/codegen/sdk-codegen/aws-models/fms.2018-01-01.json @@ -127,7 +127,7 @@ "sdkId": "FMS", "arnNamespace": "fms", "cloudFormationName": "FMS", - "cloudTrailEventSource": "v20180101.customerapi.roshi.amazonaws.com" + "cloudTrailEventSource": "fms.amazonaws.com" }, "aws.auth#sigv4": { "name": "fms" @@ -202,10 +202,10 @@ "com.amazonaws.fms#AppsListData": { "type": "structure", "members": { - "PreviousAppsList": { - "target": "com.amazonaws.fms#PreviousAppsList", + "LastUpdateTime": { + "target": "com.amazonaws.fms#TimeStamp", "traits": { - "smithy.api#documentation": "

A map of previous version numbers to their corresponding App object arrays.

" + "smithy.api#documentation": "

The time that the AWS Firewall Manager applications list was last updated.

" } }, "AppsList": { @@ -215,6 +215,12 @@ "smithy.api#required": {} } }, + "PreviousAppsList": { + "target": "com.amazonaws.fms#PreviousAppsList", + "traits": { + "smithy.api#documentation": "

A map of previous version numbers to their corresponding App object arrays.

" + } + }, "ListUpdateToken": { "target": "com.amazonaws.fms#UpdateToken", "traits": { @@ -228,10 +234,10 @@ "smithy.api#required": {} } }, - "LastUpdateTime": { + "CreateTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { - "smithy.api#documentation": "

The time that the AWS Firewall Manager applications list was last updated.

" + "smithy.api#documentation": "

The time that the AWS Firewall Manager applications list was created.

" } }, "ListId": { @@ -239,12 +245,6 @@ "traits": { "smithy.api#documentation": "

The ID of the AWS Firewall Manager applications list.

" } - }, - "CreateTime": { - "target": "com.amazonaws.fms#TimeStamp", - "traits": { - "smithy.api#documentation": "

The time that the AWS Firewall Manager applications list was created.

" - } } }, "traits": { @@ -327,17 +327,17 @@ "com.amazonaws.fms#AwsEc2InstanceViolation": { "type": "structure", "members": { - "AwsEc2NetworkInterfaceViolations": { - "target": "com.amazonaws.fms#AwsEc2NetworkInterfaceViolations", - "traits": { - "smithy.api#documentation": "

Violations for network interfaces associated with the EC2 instance.

" - } - }, "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "

The resource ID of the EC2 instance.

" } + }, + "AwsEc2NetworkInterfaceViolations": { + "target": "com.amazonaws.fms#AwsEc2NetworkInterfaceViolations", + "traits": { + "smithy.api#documentation": "

Violations for network interfaces associated with the EC2 instance.

" + } } }, "traits": { @@ -373,10 +373,10 @@ "com.amazonaws.fms#AwsVPCSecurityGroupViolation": { "type": "structure", "members": { - "ViolationTargetDescription": { - "target": "com.amazonaws.fms#LengthBoundedString", + "PossibleSecurityGroupRemediationActions": { + "target": "com.amazonaws.fms#SecurityGroupRemediationActions", "traits": { - "smithy.api#documentation": "

A description of the security group that violates the policy.

" + "smithy.api#documentation": "

Remediation options for the rule specified in the ViolationTarget.

" } }, "PartialMatches": { @@ -391,10 +391,10 @@ "smithy.api#documentation": "

The security group rule that is being evaluated.

" } }, - "PossibleSecurityGroupRemediationActions": { - "target": "com.amazonaws.fms#SecurityGroupRemediationActions", + "ViolationTargetDescription": { + "target": "com.amazonaws.fms#LengthBoundedString", "traits": { - "smithy.api#documentation": "

Remediation options for the rule specified in the ViolationTarget.

" + "smithy.api#documentation": "

A description of the security group that violates the policy.

" } } }, @@ -418,12 +418,6 @@ "com.amazonaws.fms#ComplianceViolator": { "type": "structure", "members": { - "ViolationReason": { - "target": "com.amazonaws.fms#ViolationReason", - "traits": { - "smithy.api#documentation": "

The reason that the resource is not protected by the policy.

" - } - }, "ResourceId": { "target": "com.amazonaws.fms#ResourceId", "traits": { @@ -435,6 +429,12 @@ "traits": { "smithy.api#documentation": "

The resource type. This is in the format shown in the AWS Resource Types Reference. For example:\n AWS::ElasticLoadBalancingV2::LoadBalancer or\n AWS::CloudFront::Distribution.

" } + }, + "ViolationReason": { + "target": "com.amazonaws.fms#ViolationReason", + "traits": { + "smithy.api#documentation": "

The reason that the resource is not protected by the policy.

" + } } }, "traits": { @@ -676,18 +676,18 @@ "com.amazonaws.fms#EvaluationResult": { "type": "structure", "members": { - "ComplianceStatus": { - "target": "com.amazonaws.fms#PolicyComplianceStatusType", - "traits": { - "smithy.api#documentation": "

Describes an AWS account's compliance with the AWS Firewall Manager policy.

" - } - }, "ViolatorCount": { "target": "com.amazonaws.fms#ResourceCount", "traits": { "smithy.api#documentation": "

The number of resources that are noncompliant with the specified policy. For AWS WAF and\n Shield Advanced policies, a resource is considered noncompliant if it is not associated with\n the policy. For security group policies, a resource is considered noncompliant if it doesn't\n comply with the rules of the policy and remediation is disabled or not possible.

" } }, + "ComplianceStatus": { + "target": "com.amazonaws.fms#PolicyComplianceStatusType", + "traits": { + "smithy.api#documentation": "

Describes an AWS account's compliance with the AWS Firewall Manager policy.

" + } + }, "EvaluationLimitExceeded": { "target": "com.amazonaws.fms#Boolean", "traits": { @@ -775,18 +775,18 @@ "com.amazonaws.fms#GetAppsListRequest": { "type": "structure", "members": { + "DefaultList": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the list to retrieve is a default list owned by AWS Firewall Manager.

" + } + }, "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "

The ID of the AWS Firewall Manager applications list that you want the details for.

", "smithy.api#required": {} } - }, - "DefaultList": { - "target": "com.amazonaws.fms#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the list to retrieve is a default list owned by AWS Firewall Manager.

" - } } } }, @@ -948,17 +948,17 @@ "com.amazonaws.fms#GetPolicyResponse": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.fms#Policy", - "traits": { - "smithy.api#documentation": "

Information about the specified AWS Firewall Manager policy.

" - } - }, "PolicyArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the specified policy.

" } + }, + "Policy": { + "target": "com.amazonaws.fms#Policy", + "traits": { + "smithy.api#documentation": "

Information about the specified AWS Firewall Manager policy.

" + } } } }, @@ -988,16 +988,11 @@ "com.amazonaws.fms#GetProtectionStatusRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.fms#PaginationMaxResults", - "traits": { - "smithy.api#documentation": "

Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more \n objects than the number that you specify for MaxResults, the response includes a \n NextToken value that you can use to get another batch of objects.

" - } - }, - "EndTime": { - "target": "com.amazonaws.fms#TimeStamp", + "PolicyId": { + "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The end of the time period to query for the attacks. This is a timestamp type. The\n request syntax listing indicates a number type because the default used by AWS Firewall\n Manager is Unix time in seconds. However, any valid timestamp format is\n allowed.

" + "smithy.api#documentation": "

The ID of the policy for which you want to get the attack information.

", + "smithy.api#required": {} } }, "MemberAccountId": { @@ -1006,11 +1001,10 @@ "smithy.api#documentation": "

The AWS account that is in scope of the policy that you want to get the details\n for.

" } }, - "PolicyId": { - "target": "com.amazonaws.fms#PolicyId", + "EndTime": { + "target": "com.amazonaws.fms#TimeStamp", "traits": { - "smithy.api#documentation": "

The ID of the policy for which you want to get the attack information.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The end of the time period to query for the attacks. This is a timestamp type. The\n request syntax listing indicates a number type because the default used by AWS Firewall\n Manager is Unix time in seconds. However, any valid timestamp format is\n allowed.

" } }, "StartTime": { @@ -1019,6 +1013,12 @@ "smithy.api#documentation": "

The start of the time period to query for the attacks. This is a timestamp type. The\n request syntax listing indicates a number type because the default used by AWS Firewall\n Manager is Unix time in seconds. However, any valid timestamp format is\n allowed.

" } }, + "MaxResults": { + "target": "com.amazonaws.fms#PaginationMaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more \n objects than the number that you specify for MaxResults, the response includes a \n NextToken value that you can use to get another batch of objects.

" + } + }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { @@ -1030,12 +1030,6 @@ "com.amazonaws.fms#GetProtectionStatusResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.fms#PaginationToken", - "traits": { - "smithy.api#documentation": "

If you have more objects than the number that you specified for MaxResults in the request, \n the response includes a NextToken value. To list more objects, submit another \n GetProtectionStatus request, and specify the NextToken value from the response in the \n NextToken value in the next request.

\n

AWS SDKs provide auto-pagination that identify NextToken in a response and\n make subsequent request calls automatically on your behalf. However, this feature is not\n supported by GetProtectionStatus. You must submit subsequent requests with\n NextToken using your own processes.

" - } - }, "AdminAccountId": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { @@ -1048,6 +1042,12 @@ "smithy.api#documentation": "

Details about the attack, including the following:

\n \n

The details are in JSON format.

" } }, + "NextToken": { + "target": "com.amazonaws.fms#PaginationToken", + "traits": { + "smithy.api#documentation": "

If you have more objects than the number that you specified for MaxResults in the request, \n the response includes a NextToken value. To list more objects, submit another \n GetProtectionStatus request, and specify the NextToken value from the response in the \n NextToken value in the next request.

\n

AWS SDKs provide auto-pagination that identify NextToken in a response and\n make subsequent request calls automatically on your behalf. However, this feature is not\n supported by GetProtectionStatus. You must submit subsequent requests with\n NextToken using your own processes.

" + } + }, "ServiceType": { "target": "com.amazonaws.fms#SecurityServiceType", "traits": { @@ -1100,17 +1100,17 @@ "com.amazonaws.fms#GetProtocolsListResponse": { "type": "structure", "members": { - "ProtocolsList": { - "target": "com.amazonaws.fms#ProtocolsListData", - "traits": { - "smithy.api#documentation": "

Information about the specified AWS Firewall Manager protocols list.

" - } - }, "ProtocolsListArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the specified protocols list.

" } + }, + "ProtocolsList": { + "target": "com.amazonaws.fms#ProtocolsListData", + "traits": { + "smithy.api#documentation": "

Information about the specified AWS Firewall Manager protocols list.

" + } } } }, @@ -1140,17 +1140,17 @@ "com.amazonaws.fms#GetViolationDetailsRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.fms#ResourceId", + "PolicyId": { + "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The ID of the resource that has violations.

", + "smithy.api#documentation": "

The ID of the AWS Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.

", "smithy.api#required": {} } }, - "PolicyId": { - "target": "com.amazonaws.fms#PolicyId", + "ResourceId": { + "target": "com.amazonaws.fms#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the AWS Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.

", + "smithy.api#documentation": "

The ID of the resource that has violations.

", "smithy.api#required": {} } }, @@ -1298,6 +1298,13 @@ "com.amazonaws.fms#ListAppsListsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.fms#PaginationMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want AWS Firewall Manager to return for this request. If more\n objects are available, in the response, AWS Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

\n

If you don't specify this, AWS Firewall Manager returns all available objects.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { @@ -1309,13 +1316,6 @@ "traits": { "smithy.api#documentation": "

Specifies whether the lists to retrieve are default lists owned by AWS Firewall Manager.

" } - }, - "MaxResults": { - "target": "com.amazonaws.fms#PaginationMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS Firewall Manager to return for this request. If more\n objects are available, in the response, AWS Firewall Manager provides a\n NextToken value that you can use in a subsequent call to get the next batch of objects.

\n

If you don't specify this, AWS Firewall Manager returns all available objects.

", - "smithy.api#required": {} - } } } }, @@ -1372,34 +1372,34 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.fms#PaginationToken", - "traits": { - "smithy.api#documentation": "

If you specify a value for MaxResults and you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, AWS Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicyComplianceStatus objects.\n For the second and subsequent ListComplianceStatus requests, specify the value of\n NextToken from the previous response to get information about another batch of\n PolicyComplianceStatus objects.

" - } - }, "MaxResults": { "target": "com.amazonaws.fms#PaginationMaxResults", "traits": { "smithy.api#documentation": "

Specifies the number of PolicyComplianceStatus objects that you want AWS\n Firewall Manager to return for this request. If you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, the response includes a NextToken value that you can\n use to get another batch of PolicyComplianceStatus objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.fms#PaginationToken", + "traits": { + "smithy.api#documentation": "

If you specify a value for MaxResults and you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, AWS Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicyComplianceStatus objects.\n For the second and subsequent ListComplianceStatus requests, specify the value of\n NextToken from the previous response to get information about another batch of\n PolicyComplianceStatus objects.

" + } } } }, "com.amazonaws.fms#ListComplianceStatusResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.fms#PaginationToken", - "traits": { - "smithy.api#documentation": "

If you have more PolicyComplianceStatus objects than the number that you\n specified for MaxResults in the request, the response includes a\n NextToken value. To list more PolicyComplianceStatus objects,\n submit another ListComplianceStatus request, and specify the\n NextToken value from the response in the NextToken value in the\n next request.

" - } - }, "PolicyComplianceStatusList": { "target": "com.amazonaws.fms#PolicyComplianceStatusList", "traits": { "smithy.api#documentation": "

An array of PolicyComplianceStatus objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.fms#PaginationToken", + "traits": { + "smithy.api#documentation": "

If you have more PolicyComplianceStatus objects than the number that you\n specified for MaxResults in the request, the response includes a\n NextToken value. To list more PolicyComplianceStatus objects,\n submit another ListComplianceStatus request, and specify the\n NextToken value from the response in the NextToken value in the\n next request.

" + } } } }, @@ -1459,17 +1459,17 @@ "com.amazonaws.fms#ListMemberAccountsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.fms#PaginationToken", - "traits": { - "smithy.api#documentation": "

If you have more member account IDs than the number that you specified for\n MaxResults in the request, the response includes a NextToken\n value. To list more IDs, submit another ListMemberAccounts request, and specify\n the NextToken value from the response in the NextToken value in the\n next request.

" - } - }, "MemberAccounts": { "target": "com.amazonaws.fms#MemberAccounts", "traits": { "smithy.api#documentation": "

An array of account IDs.

" } + }, + "NextToken": { + "target": "com.amazonaws.fms#PaginationToken", + "traits": { + "smithy.api#documentation": "

If you have more member account IDs than the number that you specified for\n MaxResults in the request, the response includes a NextToken\n value. To list more IDs, submit another ListMemberAccounts request, and specify\n the NextToken value from the response in the NextToken value in the\n next request.

" + } } } }, @@ -1508,17 +1508,17 @@ "com.amazonaws.fms#ListPoliciesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.fms#PaginationMaxResults", - "traits": { - "smithy.api#documentation": "

Specifies the number of PolicySummary objects that you want AWS Firewall\n Manager to return for this request. If you have more PolicySummary objects than\n the number that you specify for MaxResults, the response includes a\n NextToken value that you can use to get another batch of\n PolicySummary objects.

" - } - }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { "smithy.api#documentation": "

If you specify a value for MaxResults and you have more\n PolicySummary objects than the number that you specify for\n MaxResults, AWS Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicySummary objects. For the\n second and subsequent ListPolicies requests, specify the value of\n NextToken from the previous response to get information about another batch of\n PolicySummary objects.

" } + }, + "MaxResults": { + "target": "com.amazonaws.fms#PaginationMaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the number of PolicySummary objects that you want AWS Firewall\n Manager to return for this request. If you have more PolicySummary objects than\n the number that you specify for MaxResults, the response includes a\n NextToken value that you can use to get another batch of\n PolicySummary objects.

" + } } } }, @@ -1691,17 +1691,17 @@ "com.amazonaws.fms#PartialMatch": { "type": "structure", "members": { - "TargetViolationReasons": { - "target": "com.amazonaws.fms#TargetViolationReasons", - "traits": { - "smithy.api#documentation": "

The violation reason.

" - } - }, "Reference": { "target": "com.amazonaws.fms#ReferenceRule", "traits": { "smithy.api#documentation": "

The reference rule from the master security group of the AWS Firewall Manager policy.

" } + }, + "TargetViolationReasons": { + "target": "com.amazonaws.fms#TargetViolationReasons", + "traits": { + "smithy.api#documentation": "

The violation reason.

" + } } }, "traits": { @@ -1717,10 +1717,11 @@ "com.amazonaws.fms#Policy": { "type": "structure", "members": { - "PolicyUpdateToken": { - "target": "com.amazonaws.fms#PolicyUpdateToken", + "ExcludeResourceTags": { + "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

A unique identifier for each update to the policy. When issuing a PutPolicy\n request, the PolicyUpdateToken in the request must match the\n PolicyUpdateToken of the current policy version. To get the\n PolicyUpdateToken of the current policy version, use a GetPolicy\n request.

" + "smithy.api#documentation": "

If set to True, resources with the tags that are specified in the\n ResourceTag array are not in scope of the policy. If set to False,\n and the ResourceTag array is not null, only resources with the specified tags are\n in scope of the policy.

", + "smithy.api#required": {} } }, "IncludeMap": { @@ -1729,11 +1730,10 @@ "smithy.api#documentation": "

Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. \n Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

\n

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager \n applies the policy to all accounts specified by the IncludeMap, and \n does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager \n applies the policy to all accounts except for those specified by the ExcludeMap.

\n

You can specify account IDs, OUs, or a combination:

\n " } }, - "PolicyName": { - "target": "com.amazonaws.fms#ResourceName", + "PolicyId": { + "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The name of the AWS Firewall Manager policy.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the AWS Firewall Manager policy.

" } }, "ResourceTypeList": { @@ -1742,30 +1742,16 @@ "smithy.api#documentation": "

An array of ResourceType.

" } }, - "SecurityServicePolicyData": { - "target": "com.amazonaws.fms#SecurityServicePolicyData", + "ResourceTags": { + "target": "com.amazonaws.fms#ResourceTags", "traits": { - "smithy.api#documentation": "

Details about the security service that is being used to protect the resources.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of ResourceTag objects.

" } }, - "ExcludeResourceTags": { - "target": "com.amazonaws.fms#Boolean", + "ExcludeMap": { + "target": "com.amazonaws.fms#CustomerPolicyScopeMap", "traits": { - "smithy.api#documentation": "

If set to True, resources with the tags that are specified in the\n ResourceTag array are not in scope of the policy. If set to False,\n and the ResourceTag array is not null, only resources with the specified tags are\n in scope of the policy.

", - "smithy.api#required": {} - } - }, - "PolicyId": { - "target": "com.amazonaws.fms#PolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the AWS Firewall Manager policy.

" - } - }, - "ResourceTags": { - "target": "com.amazonaws.fms#ResourceTags", - "traits": { - "smithy.api#documentation": "

An array of ResourceTag objects.

" + "smithy.api#documentation": "

Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. \n Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

\n

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager \n applies the policy to all accounts specified by the IncludeMap, and \n does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager \n applies the policy to all accounts except for those specified by the ExcludeMap.

\n

You can specify account IDs, OUs, or a combination:

\n " } }, "ResourceType": { @@ -1775,10 +1761,18 @@ "smithy.api#required": {} } }, - "ExcludeMap": { - "target": "com.amazonaws.fms#CustomerPolicyScopeMap", + "PolicyName": { + "target": "com.amazonaws.fms#ResourceName", "traits": { - "smithy.api#documentation": "

Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. \n Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

\n

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager \n applies the policy to all accounts specified by the IncludeMap, and \n does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager \n applies the policy to all accounts except for those specified by the ExcludeMap.

\n

You can specify account IDs, OUs, or a combination:

\n " + "smithy.api#documentation": "

The name of the AWS Firewall Manager policy.

", + "smithy.api#required": {} + } + }, + "SecurityServicePolicyData": { + "target": "com.amazonaws.fms#SecurityServicePolicyData", + "traits": { + "smithy.api#documentation": "

Details about the security service that is being used to protect the resources.

", + "smithy.api#required": {} } }, "RemediationEnabled": { @@ -1787,6 +1781,12 @@ "smithy.api#documentation": "

Indicates if the policy should be automatically applied to new resources.

", "smithy.api#required": {} } + }, + "PolicyUpdateToken": { + "target": "com.amazonaws.fms#PolicyUpdateToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for each update to the policy. When issuing a PutPolicy\n request, the PolicyUpdateToken in the request must match the\n PolicyUpdateToken of the current policy version. To get the\n PolicyUpdateToken of the current policy version, use a GetPolicy\n request.

" + } } }, "traits": { @@ -1796,22 +1796,22 @@ "com.amazonaws.fms#PolicyComplianceDetail": { "type": "structure", "members": { - "MemberAccount": { + "PolicyOwner": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID.

" + "smithy.api#documentation": "

The AWS account that created the AWS Firewall Manager policy.

" } }, - "Violators": { - "target": "com.amazonaws.fms#ComplianceViolators", + "EvaluationLimitExceeded": { + "target": "com.amazonaws.fms#Boolean", "traits": { - "smithy.api#documentation": "

An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or\n that aren't in compliance with the security group policy.

" + "smithy.api#documentation": "

Indicates if over 100 resources are noncompliant with the AWS Firewall Manager\n policy.

" } }, - "ExpiredAt": { - "target": "com.amazonaws.fms#TimeStamp", + "MemberAccount": { + "target": "com.amazonaws.fms#AWSAccountId", "traits": { - "smithy.api#documentation": "

A timestamp that indicates when the returned information should be considered out of\n date.

" + "smithy.api#documentation": "

The AWS account ID.

" } }, "PolicyId": { @@ -1826,16 +1826,16 @@ "smithy.api#documentation": "

Details about problems with dependent services, such as AWS WAF or AWS Config, that are\n causing a resource to be noncompliant. The details include the name of the dependent service\n and the error message received that indicates the problem with the service.

" } }, - "EvaluationLimitExceeded": { - "target": "com.amazonaws.fms#Boolean", + "ExpiredAt": { + "target": "com.amazonaws.fms#TimeStamp", "traits": { - "smithy.api#documentation": "

Indicates if over 100 resources are noncompliant with the AWS Firewall Manager\n policy.

" + "smithy.api#documentation": "

A timestamp that indicates when the returned information should be considered out of\n date.

" } }, - "PolicyOwner": { - "target": "com.amazonaws.fms#AWSAccountId", + "Violators": { + "target": "com.amazonaws.fms#ComplianceViolators", "traits": { - "smithy.api#documentation": "

The AWS account that created the AWS Firewall Manager policy.

" + "smithy.api#documentation": "

An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or\n that aren't in compliance with the security group policy.

" } } }, @@ -1846,16 +1846,10 @@ "com.amazonaws.fms#PolicyComplianceStatus": { "type": "structure", "members": { - "MemberAccount": { - "target": "com.amazonaws.fms#AWSAccountId", - "traits": { - "smithy.api#documentation": "

The member account ID.

" - } - }, - "LastUpdated": { - "target": "com.amazonaws.fms#TimeStamp", + "PolicyName": { + "target": "com.amazonaws.fms#ResourceName", "traits": { - "smithy.api#documentation": "

Timestamp of the last update to the EvaluationResult objects.

" + "smithy.api#documentation": "

The name of the AWS Firewall Manager policy.

" } }, "EvaluationResults": { @@ -1864,12 +1858,6 @@ "smithy.api#documentation": "

An array of EvaluationResult objects.

" } }, - "PolicyName": { - "target": "com.amazonaws.fms#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the AWS Firewall Manager policy.

" - } - }, "IssueInfoMap": { "target": "com.amazonaws.fms#IssueInfoMap", "traits": { @@ -1882,6 +1870,18 @@ "smithy.api#documentation": "

The ID of the AWS Firewall Manager policy.

" } }, + "LastUpdated": { + "target": "com.amazonaws.fms#TimeStamp", + "traits": { + "smithy.api#documentation": "

Timestamp of the last update to the EvaluationResult objects.

" + } + }, + "MemberAccount": { + "target": "com.amazonaws.fms#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The member account ID.

" + } + }, "PolicyOwner": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { @@ -1927,22 +1927,16 @@ "com.amazonaws.fms#PolicySummary": { "type": "structure", "members": { - "PolicyId": { - "target": "com.amazonaws.fms#PolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the specified policy.

" - } - }, - "RemediationEnabled": { - "target": "com.amazonaws.fms#Boolean", + "ResourceType": { + "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "

Indicates if the policy should be automatically applied to new resources.

" + "smithy.api#documentation": "

The type of resource protected by or in scope of the policy. This is in the format shown\n in the AWS Resource Types Reference. \n For AWS WAF and Shield Advanced, examples include\n AWS::ElasticLoadBalancingV2::LoadBalancer and\n AWS::CloudFront::Distribution. For a security group common policy, valid values\n are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a\n security group content audit policy, valid values are AWS::EC2::SecurityGroup,\n AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security\n group usage audit policy, the value is AWS::EC2::SecurityGroup.

" } }, - "SecurityServiceType": { - "target": "com.amazonaws.fms#SecurityServiceType", + "PolicyName": { + "target": "com.amazonaws.fms#ResourceName", "traits": { - "smithy.api#documentation": "

The service that the policy is using to protect the resources. This specifies the type of\n policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security\n group policy.

" + "smithy.api#documentation": "

The name of the specified policy.

" } }, "PolicyArn": { @@ -1951,16 +1945,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the specified policy.

" } }, - "ResourceType": { - "target": "com.amazonaws.fms#ResourceType", + "SecurityServiceType": { + "target": "com.amazonaws.fms#SecurityServiceType", "traits": { - "smithy.api#documentation": "

The type of resource protected by or in scope of the policy. This is in the format shown\n in the AWS Resource Types Reference. \n For AWS WAF and Shield Advanced, examples include\n AWS::ElasticLoadBalancingV2::LoadBalancer and\n AWS::CloudFront::Distribution. For a security group common policy, valid values\n are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a\n security group content audit policy, valid values are AWS::EC2::SecurityGroup,\n AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security\n group usage audit policy, the value is AWS::EC2::SecurityGroup.

" + "smithy.api#documentation": "

The service that the policy is using to protect the resources. This specifies the type of\n policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security\n group policy.

" } }, - "PolicyName": { - "target": "com.amazonaws.fms#ResourceName", + "PolicyId": { + "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The name of the specified policy.

" + "smithy.api#documentation": "

The ID of the specified policy.

" + } + }, + "RemediationEnabled": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if the policy should be automatically applied to new resources.

" } } }, @@ -2040,6 +2040,12 @@ "smithy.api#documentation": "

A map of previous version numbers to their corresponding protocol arrays.

" } }, + "LastUpdateTime": { + "target": "com.amazonaws.fms#TimeStamp", + "traits": { + "smithy.api#documentation": "

The time that the AWS Firewall Manager protocols list was last updated.

" + } + }, "ProtocolsList": { "target": "com.amazonaws.fms#ProtocolsList", "traits": { @@ -2047,10 +2053,10 @@ "smithy.api#required": {} } }, - "ListUpdateToken": { - "target": "com.amazonaws.fms#UpdateToken", + "ListId": { + "target": "com.amazonaws.fms#ListId", "traits": { - "smithy.api#documentation": "

A unique identifier for each update to the list. When you update \n the list, the update token must match the token of the current version of the application list. \n You can retrieve the update token by getting the list.

" + "smithy.api#documentation": "

The ID of the AWS Firewall Manager protocols list.

" } }, "CreateTime": { @@ -2059,16 +2065,10 @@ "smithy.api#documentation": "

The time that the AWS Firewall Manager protocols list was created.

" } }, - "ListId": { - "target": "com.amazonaws.fms#ListId", - "traits": { - "smithy.api#documentation": "

The ID of the AWS Firewall Manager protocols list.

" - } - }, - "LastUpdateTime": { - "target": "com.amazonaws.fms#TimeStamp", + "ListUpdateToken": { + "target": "com.amazonaws.fms#UpdateToken", "traits": { - "smithy.api#documentation": "

The time that the AWS Firewall Manager protocols list was last updated.

" + "smithy.api#documentation": "

A unique identifier for each update to the list. When you update \n the list, the update token must match the token of the current version of the application list. \n You can retrieve the update token by getting the list.

" } }, "ListName": { @@ -2086,10 +2086,10 @@ "com.amazonaws.fms#ProtocolsListDataSummary": { "type": "structure", "members": { - "ProtocolsList": { - "target": "com.amazonaws.fms#ProtocolsList", + "ListName": { + "target": "com.amazonaws.fms#ResourceName", "traits": { - "smithy.api#documentation": "

An array of protocols in the AWS Firewall Manager protocols list.

" + "smithy.api#documentation": "

The name of the specified protocols list.

" } }, "ListArn": { @@ -2098,16 +2098,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the specified protocols list.

" } }, - "ListId": { - "target": "com.amazonaws.fms#ListId", + "ProtocolsList": { + "target": "com.amazonaws.fms#ProtocolsList", "traits": { - "smithy.api#documentation": "

The ID of the specified protocols list.

" + "smithy.api#documentation": "

An array of protocols in the AWS Firewall Manager protocols list.

" } }, - "ListName": { - "target": "com.amazonaws.fms#ResourceName", + "ListId": { + "target": "com.amazonaws.fms#ListId", "traits": { - "smithy.api#documentation": "

The name of the specified protocols list.

" + "smithy.api#documentation": "

The ID of the specified protocols list.

" } } }, @@ -2153,18 +2153,18 @@ "com.amazonaws.fms#PutAppsListRequest": { "type": "structure", "members": { + "TagList": { + "target": "com.amazonaws.fms#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the resource.

" + } + }, "AppsList": { "target": "com.amazonaws.fms#AppsListData", "traits": { "smithy.api#documentation": "

The details of the AWS Firewall Manager applications list to be created.

", "smithy.api#required": {} } - }, - "TagList": { - "target": "com.amazonaws.fms#TagList", - "traits": { - "smithy.api#documentation": "

The tags associated with the resource.

" - } } } }, @@ -2277,17 +2277,17 @@ "com.amazonaws.fms#PutPolicyResponse": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.fms#Policy", - "traits": { - "smithy.api#documentation": "

The details of the AWS Firewall Manager policy.

" - } - }, "PolicyArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" } + }, + "Policy": { + "target": "com.amazonaws.fms#Policy", + "traits": { + "smithy.api#documentation": "

The details of the AWS Firewall Manager policy.

" + } } } }, @@ -2341,17 +2341,17 @@ "com.amazonaws.fms#PutProtocolsListResponse": { "type": "structure", "members": { - "ProtocolsListArn": { - "target": "com.amazonaws.fms#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protocols list.

" - } - }, "ProtocolsList": { "target": "com.amazonaws.fms#ProtocolsListData", "traits": { "smithy.api#documentation": "

The details of the AWS Firewall Manager protocols list.

" } + }, + "ProtocolsListArn": { + "target": "com.amazonaws.fms#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the protocols list.

" + } } } }, @@ -2543,10 +2543,10 @@ "com.amazonaws.fms#SecurityGroupRemediationAction": { "type": "structure", "members": { - "RemediationActionType": { - "target": "com.amazonaws.fms#RemediationActionType", + "RemediationResult": { + "target": "com.amazonaws.fms#SecurityGroupRuleDescription", "traits": { - "smithy.api#documentation": "

The remediation action that will be performed.

" + "smithy.api#documentation": "

The final state of the rule specified in the ViolationTarget after it is remediated.

" } }, "Description": { @@ -2555,10 +2555,10 @@ "smithy.api#documentation": "

Brief description of the action that will be performed.

" } }, - "RemediationResult": { - "target": "com.amazonaws.fms#SecurityGroupRuleDescription", + "RemediationActionType": { + "target": "com.amazonaws.fms#RemediationActionType", "traits": { - "smithy.api#documentation": "

The final state of the rule specified in the ViolationTarget after it is remediated.

" + "smithy.api#documentation": "

The remediation action that will be performed.

" } }, "IsDefaultAction": { @@ -2581,10 +2581,10 @@ "com.amazonaws.fms#SecurityGroupRuleDescription": { "type": "structure", "members": { - "FromPort": { - "target": "com.amazonaws.fms#IPPortNumber", + "PrefixListId": { + "target": "com.amazonaws.fms#ResourceId", "traits": { - "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

" + "smithy.api#documentation": "

The ID of the prefix list for the security group rule.

" } }, "ToPort": { @@ -2593,18 +2593,18 @@ "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes.

" } }, - "PrefixListId": { - "target": "com.amazonaws.fms#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the prefix list for the security group rule.

" - } - }, "IPV6Range": { "target": "com.amazonaws.fms#CIDR", "traits": { "smithy.api#documentation": "

The IPv6 ranges for the security group rule.

" } }, + "FromPort": { + "target": "com.amazonaws.fms#IPPortNumber", + "traits": { + "smithy.api#documentation": "

The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

" + } + }, "Protocol": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { @@ -2625,18 +2625,18 @@ "com.amazonaws.fms#SecurityServicePolicyData": { "type": "structure", "members": { + "ManagedServiceData": { + "target": "com.amazonaws.fms#ManagedServiceData", + "traits": { + "smithy.api#documentation": "

Details about the service that are specific to the service type, in JSON format. For\n service type SHIELD_ADVANCED, this is an empty string.

\n " + } + }, "Type": { "target": "com.amazonaws.fms#SecurityServiceType", "traits": { "smithy.api#documentation": "

The service that the policy is using to protect the resources. This specifies the type of\n policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security\n group policy. For security group policies, Firewall Manager supports one security group for\n each common policy and for each content audit policy. This is an adjustable limit that you can\n increase by contacting AWS Support.

", "smithy.api#required": {} } - }, - "ManagedServiceData": { - "target": "com.amazonaws.fms#ManagedServiceData", - "traits": { - "smithy.api#documentation": "

Details about the service that are specific to the service type, in JSON format. For\n service type SHIELD_ADVANCED, this is an empty string.

\n " - } } }, "traits": { @@ -2840,17 +2840,17 @@ "com.amazonaws.fms#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.fms#ResourceArn", + "TagKeys": { + "target": "com.amazonaws.fms#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to return tags for. The AWS Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

", + "smithy.api#documentation": "

The keys of the tags to remove from the resource.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.fms#TagKeyList", + "ResourceArn": { + "target": "com.amazonaws.fms#ResourceArn", "traits": { - "smithy.api#documentation": "

The keys of the tags to remove from the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to return tags for. The AWS Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

", "smithy.api#required": {} } } @@ -2873,17 +2873,10 @@ "com.amazonaws.fms#ViolationDetail": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.fms#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type that the violation details were requested for.

", - "smithy.api#required": {} - } - }, - "ResourceTags": { - "target": "com.amazonaws.fms#TagList", + "ResourceDescription": { + "target": "com.amazonaws.fms#LengthBoundedString", "traits": { - "smithy.api#documentation": "

The ResourceTag objects associated with the resource.

" + "smithy.api#documentation": "

Brief description for the requested resource.

" } }, "MemberAccount": { @@ -2900,10 +2893,17 @@ "smithy.api#required": {} } }, - "ResourceDescription": { - "target": "com.amazonaws.fms#LengthBoundedString", + "ResourceType": { + "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "

Brief description for the requested resource.

" + "smithy.api#documentation": "

The resource type that the violation details were requested for.

", + "smithy.api#required": {} + } + }, + "ResourceTags": { + "target": "com.amazonaws.fms#TagList", + "traits": { + "smithy.api#documentation": "

The ResourceTag objects associated with the resource.

" } }, "ResourceId": { diff --git a/codegen/sdk-codegen/aws-models/forecast.2018-06-26.json b/codegen/sdk-codegen/aws-models/forecast.2018-06-26.json index bf1b35d10c06..29186a176ade 100644 --- a/codegen/sdk-codegen/aws-models/forecast.2018-06-26.json +++ b/codegen/sdk-codegen/aws-models/forecast.2018-06-26.json @@ -126,7 +126,7 @@ "sdkId": "forecast", "arnNamespace": "forecast", "cloudFormationName": "Forecast", - "cloudTrailEventSource": "service.seer.amazonaws.com" + "cloudTrailEventSource": "forecast.amazonaws.com" }, "aws.auth#sigv4": { "name": "forecast" @@ -184,17 +184,17 @@ "com.amazonaws.forecast#CategoricalParameterRange": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.forecast#Values", + "Name": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

A list of the tunable categories for the hyperparameter.

", + "smithy.api#documentation": "

The name of the categorical hyperparameter to tune.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.forecast#Name", + "Values": { + "target": "com.amazonaws.forecast#Values", "traits": { - "smithy.api#documentation": "

The name of the categorical hyperparameter to tune.

", + "smithy.api#documentation": "

A list of the tunable categories for the hyperparameter.

", "smithy.api#required": {} } } @@ -218,6 +218,12 @@ "com.amazonaws.forecast#ContinuousParameterRange": { "type": "structure", "members": { + "ScalingType": { + "target": "com.amazonaws.forecast#ScalingType", + "traits": { + "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range.\n Valid values:

\n
\n
Auto
\n
\n

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by using a\n linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by using a\n logarithmic scale.

\n

Logarithmic scaling works only for ranges that have values greater than 0.

\n
\n
ReverseLogarithmic
\n
\n

hyperparameter tuning searches the values in the hyperparameter range by using a\n reverse logarithmic scale.

\n

Reverse logarithmic scaling works only for ranges that are entirely within the\n range 0 <= x < 1.0.

\n
\n
\n

For information about choosing a hyperparameter scale, see\n Hyperparameter Scaling.\n One of the following values:

" + } + }, "Name": { "target": "com.amazonaws.forecast#Name", "traits": { @@ -232,12 +238,6 @@ "smithy.api#required": {} } }, - "ScalingType": { - "target": "com.amazonaws.forecast#ScalingType", - "traits": { - "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range.\n Valid values:

\n
\n
Auto
\n
\n

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by using a\n linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by using a\n logarithmic scale.

\n

Logarithmic scaling works only for ranges that have values greater than 0.

\n
\n
ReverseLogarithmic
\n
\n

hyperparameter tuning searches the values in the hyperparameter range by using a\n reverse logarithmic scale.

\n

Reverse logarithmic scaling works only for ranges that are entirely within the\n range 0 <= x < 1.0.

\n
\n
\n

For information about choosing a hyperparameter scale, see\n Hyperparameter Scaling.\n One of the following values:

" - } - }, "MaxValue": { "target": "com.amazonaws.forecast#Double", "traits": { @@ -317,6 +317,12 @@ "com.amazonaws.forecast#CreateDatasetGroupRequest": { "type": "structure", "members": { + "DatasetArns": { + "target": "com.amazonaws.forecast#ArnList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the\n dataset group.

" + } + }, "DatasetGroupName": { "target": "com.amazonaws.forecast#Name", "traits": { @@ -336,12 +342,6 @@ "smithy.api#documentation": "

The domain associated with the dataset group. When you add a dataset to a dataset group,\n this value and the value specified for the Domain parameter of the CreateDataset operation must match.

\n

The Domain and DatasetType that you choose determine the fields\n that must be present in training data that you import to a dataset. For example, if you choose\n the RETAIL domain and TARGET_TIME_SERIES as the\n DatasetType, Amazon Forecast requires that item_id,\n timestamp, and demand fields are present in your data. For more\n information, see howitworks-datasets-groups.

", "smithy.api#required": {} } - }, - "DatasetArns": { - "target": "com.amazonaws.forecast#ArnList", - "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the\n dataset group.

" - } } } }, @@ -388,24 +388,23 @@ "com.amazonaws.forecast#CreateDatasetImportJobRequest": { "type": "structure", "members": { - "DataSource": { - "target": "com.amazonaws.forecast#DataSource", + "DatasetImportJobName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.

\n

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the\n IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must\n match those specified in the EncryptionConfig parameter of the CreateDataset operation.

", + "smithy.api#documentation": "

The name for the dataset import job. We recommend including the current timestamp in the\n name, for example, 20190721DatasetImport. This can help you avoid getting a\n ResourceAlreadyExistsException exception.

", "smithy.api#required": {} } }, - "DatasetArn": { - "target": "com.amazonaws.forecast#Arn", + "TimestampFormat": { + "target": "com.amazonaws.forecast#TimestampFormat", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data\n to.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The format of timestamps in the dataset. The format that you specify depends on the\n DataFrequency specified when the dataset was created. The following formats are\n supported

\n \n

If the format isn't specified, Amazon Forecast expects the format to be \"yyyy-MM-dd\n HH:mm:ss\".

" } }, - "DatasetImportJobName": { - "target": "com.amazonaws.forecast#Name", + "DatasetArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The name for the dataset import job. We recommend including the current timestamp in the\n name, for example, 20190721DatasetImport. This can help you avoid getting a\n ResourceAlreadyExistsException exception.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data\n to.

", "smithy.api#required": {} } }, @@ -415,10 +414,11 @@ "smithy.api#documentation": "

The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, - "TimestampFormat": { - "target": "com.amazonaws.forecast#TimestampFormat", + "DataSource": { + "target": "com.amazonaws.forecast#DataSource", "traits": { - "smithy.api#documentation": "

The format of timestamps in the dataset. The format that you specify depends on the\n DataFrequency specified when the dataset was created. The following formats are\n supported

\n \n

If the format isn't specified, Amazon Forecast expects the format to be \"yyyy-MM-dd\n HH:mm:ss\".

" + "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.

\n

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the\n IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must\n match those specified in the EncryptionConfig parameter of the CreateDataset operation.

", + "smithy.api#required": {} } } } @@ -437,10 +437,11 @@ "com.amazonaws.forecast#CreateDatasetRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.forecast#Tags", + "Domain": { + "target": "com.amazonaws.forecast#Domain", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

\n

The Domain and DatasetType that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL domain and TARGET_TIME_SERIES as the\n DatasetType, Amazon Forecast requires item_id, timestamp,\n and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

", + "smithy.api#required": {} } }, "EncryptionConfig": { @@ -449,17 +450,16 @@ "smithy.api#documentation": "

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.

" } }, - "Domain": { - "target": "com.amazonaws.forecast#Domain", + "Tags": { + "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

\n

The Domain and DatasetType that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL domain and TARGET_TIME_SERIES as the\n DatasetType, Amazon Forecast requires item_id, timestamp,\n and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, - "DatasetName": { - "target": "com.amazonaws.forecast#Name", + "DatasetType": { + "target": "com.amazonaws.forecast#DatasetType", "traits": { - "smithy.api#documentation": "

A name for the dataset.

", + "smithy.api#documentation": "

The dataset type. Valid values depend on the chosen Domain.

", "smithy.api#required": {} } }, @@ -476,10 +476,10 @@ "smithy.api#documentation": "

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES\n datasets.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"D\" indicates every day and \"15min\" indicates every 15 minutes.

" } }, - "DatasetType": { - "target": "com.amazonaws.forecast#DatasetType", + "DatasetName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The dataset type. Valid values depend on the chosen Domain.

", + "smithy.api#documentation": "

A name for the dataset.

", "smithy.api#required": {} } } @@ -564,13 +564,6 @@ "smithy.api#required": {} } }, - "ForecastArn": { - "target": "com.amazonaws.forecast#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast that you want to export.

", - "smithy.api#required": {} - } - }, "Destination": { "target": "com.amazonaws.forecast#DataDestination", "traits": { @@ -583,6 +576,13 @@ "traits": { "smithy.api#documentation": "

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } + }, + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast that you want to export.

", + "smithy.api#required": {} + } } } }, @@ -607,6 +607,12 @@ "smithy.api#required": {} } }, + "ForecastTypes": { + "target": "com.amazonaws.forecast#ForecastTypes", + "traits": { + "smithy.api#documentation": "

The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

" + } + }, "PredictorArn": { "target": "com.amazonaws.forecast#Arn", "traits": { @@ -614,12 +620,6 @@ "smithy.api#required": {} } }, - "ForecastTypes": { - "target": "com.amazonaws.forecast#ForecastTypes", - "traits": { - "smithy.api#documentation": "

The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

" - } - }, "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { @@ -671,35 +671,30 @@ "com.amazonaws.forecast#CreatePredictorRequest": { "type": "structure", "members": { - "PredictorName": { - "target": "com.amazonaws.forecast#Name", + "InputDataConfig": { + "target": "com.amazonaws.forecast#InputDataConfig", "traits": { - "smithy.api#documentation": "

A name for the predictor.

", + "smithy.api#documentation": "

Describes the dataset group that contains the data to use to train the predictor.

", "smithy.api#required": {} } }, - "PerformAutoML": { - "target": "com.amazonaws.forecast#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it\n provides and chooses the best algorithm and configuration for your training dataset.

\n

The default value is false. In this case, you are required to specify an\n algorithm.

\n

Set PerformAutoML to true to have Amazon Forecast perform AutoML. This\n is a good option if you aren't sure which algorithm is suitable for your training data. In\n this case, PerformHPO must be false.

" - } - }, - "TrainingParameters": { - "target": "com.amazonaws.forecast#TrainingParameters", + "EncryptionConfig": { + "target": "com.amazonaws.forecast#EncryptionConfig", "traits": { - "smithy.api#documentation": "

The hyperparameters to override for model training. The hyperparameters that you can\n override are listed in the individual algorithms. For the list of supported algorithms, see\n aws-forecast-choosing-recipes.

" + "smithy.api#documentation": "

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.

" } }, - "Tags": { - "target": "com.amazonaws.forecast#Tags", + "ForecastHorizon": { + "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

Specifies the number of time-steps that the model is trained to predict. The forecast\n horizon is also called the prediction length.

\n

For example, if you configure a dataset for daily data collection (using the\n DataFrequency parameter of the CreateDataset operation) and\n set the forecast horizon to 10, the model returns predictions for 10 days.

\n

The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the\n TARGET_TIME_SERIES dataset length.

", + "smithy.api#required": {} } }, - "EncryptionConfig": { - "target": "com.amazonaws.forecast#EncryptionConfig", + "EvaluationParameters": { + "target": "com.amazonaws.forecast#EvaluationParameters", "traits": { - "smithy.api#documentation": "

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.

" + "smithy.api#documentation": "

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.

" } }, "AlgorithmArn": { @@ -708,23 +703,35 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if\n PerformAutoML is not set to true.

\n

\n Supported algorithms:\n

\n " } }, + "HPOConfig": { + "target": "com.amazonaws.forecast#HyperParameterTuningJobConfig", + "traits": { + "smithy.api#documentation": "

Provides hyperparameter override values for the algorithm. If you don't provide this\n parameter, Amazon Forecast uses default values. The individual algorithms specify which\n hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.

\n

If you included the HPOConfig object, you must set PerformHPO to\n true.

" + } + }, + "PerformAutoML": { + "target": "com.amazonaws.forecast#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it\n provides and chooses the best algorithm and configuration for your training dataset.

\n

The default value is false. In this case, you are required to specify an\n algorithm.

\n

Set PerformAutoML to true to have Amazon Forecast perform AutoML. This\n is a good option if you aren't sure which algorithm is suitable for your training data. In\n this case, PerformHPO must be false.

" + } + }, "PerformHPO": { "target": "com.amazonaws.forecast#Boolean", "traits": { "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter\n values for your training data. The process of performing HPO is known as running a\n hyperparameter tuning job.

\n

The default value is false. In this case, Amazon Forecast uses default\n hyperparameter values from the chosen algorithm.

\n

To override the default values, set PerformHPO to true and,\n optionally, supply the HyperParameterTuningJobConfig object. The tuning job\n specifies a metric to optimize, which hyperparameters participate in tuning, and the valid\n range for each tunable hyperparameter. In this case, you are required to specify an algorithm\n and PerformAutoML must be false.

\n

The following algorithm supports HPO:

\n " } }, - "EvaluationParameters": { - "target": "com.amazonaws.forecast#EvaluationParameters", + "PredictorName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.

" + "smithy.api#documentation": "

A name for the predictor.

", + "smithy.api#required": {} } }, - "InputDataConfig": { - "target": "com.amazonaws.forecast#InputDataConfig", + "Tags": { + "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

Describes the dataset group that contains the data to use to train the predictor.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, "FeaturizationConfig": { @@ -734,17 +741,10 @@ "smithy.api#required": {} } }, - "ForecastHorizon": { - "target": "com.amazonaws.forecast#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the number of time-steps that the model is trained to predict. The forecast\n horizon is also called the prediction length.

\n

For example, if you configure a dataset for daily data collection (using the\n DataFrequency parameter of the CreateDataset operation) and\n set the forecast horizon to 10, the model returns predictions for 10 days.

\n

The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the\n TARGET_TIME_SERIES dataset length.

", - "smithy.api#required": {} - } - }, - "HPOConfig": { - "target": "com.amazonaws.forecast#HyperParameterTuningJobConfig", + "TrainingParameters": { + "target": "com.amazonaws.forecast#TrainingParameters", "traits": { - "smithy.api#documentation": "

Provides hyperparameter override values for the algorithm. If you don't provide this\n parameter, Amazon Forecast uses default values. The individual algorithms specify which\n hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.

\n

If you included the HPOConfig object, you must set PerformHPO to\n true.

" + "smithy.api#documentation": "

The hyperparameters to override for model training. The hyperparameters that you can\n override are listed in the individual algorithms. For the list of supported algorithms, see\n aws-forecast-choosing-recipes.

" } } } @@ -793,10 +793,10 @@ "com.amazonaws.forecast#DatasetGroupSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

When the dataset group was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" } }, "DatasetGroupName": { @@ -805,10 +805,10 @@ "smithy.api#documentation": "

The name of the dataset group.

" } }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#Arn", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" + "smithy.api#documentation": "

When the dataset group was created.

" } }, "LastModificationTime": { @@ -831,6 +831,24 @@ "com.amazonaws.forecast#DatasetImportJobSummary": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "

The status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS, the\n status of the dataset is UPDATE_IN_PROGRESS. States include:

\n " + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that the dataset was modified. The time depends on the status of the job, as\n follows:

\n " + } + }, + "DataSource": { + "target": "com.amazonaws.forecast#DataSource", + "traits": { + "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.

\n

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

" + } + }, "Message": { "target": "com.amazonaws.forecast#ErrorMessage", "traits": { @@ -843,35 +861,17 @@ "smithy.api#documentation": "

When the dataset import job was created.

" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the dataset was modified. The time depends on the status of the job, as\n follows:

\n " - } - }, "DatasetImportJobName": { "target": "com.amazonaws.forecast#Name", "traits": { "smithy.api#documentation": "

The name of the dataset import job.

" } }, - "DataSource": { - "target": "com.amazonaws.forecast#DataSource", - "traits": { - "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.

\n

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

" - } - }, "DatasetImportJobArn": { "target": "com.amazonaws.forecast#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset import job.

" } - }, - "Status": { - "target": "com.amazonaws.forecast#Status", - "traits": { - "smithy.api#documentation": "

The status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS, the\n status of the dataset is UPDATE_IN_PROGRESS. States include:

\n " - } } }, "traits": { @@ -887,10 +887,16 @@ "com.amazonaws.forecast#DatasetSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "DatasetArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

When the dataset was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" } }, "DatasetType": { @@ -905,22 +911,16 @@ "smithy.api#documentation": "

The domain associated with the dataset.

" } }, - "DatasetName": { - "target": "com.amazonaws.forecast#Name", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.forecast#Arn", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the ListDatasets call.\n After a CreateDatasetImportJob operation has finished,\n LastModificationTime is when the import job completed or failed.

" } }, - "LastModificationTime": { + "CreationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the ListDatasets call.\n After a CreateDatasetImportJob operation has finished,\n LastModificationTime is when the import job completed or failed.

" + "smithy.api#documentation": "

When the dataset was created.

" } } }, @@ -1208,22 +1208,22 @@ "com.amazonaws.forecast#DescribeDatasetGroupResponse": { "type": "structure", "members": { - "LastModificationTime": { + "CreationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime is the current time of the\n DescribeDatasetGroup call.

" + "smithy.api#documentation": "

When the dataset group was created.

" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The status of the dataset group. States include:

\n \n

The UPDATE states apply when you call the UpdateDatasetGroup operation.

\n \n

The Status of the dataset group must be ACTIVE before you can\n use the dataset group to create a predictor.

\n " + "smithy.api#documentation": "

The ARN of the dataset group.

" } }, - "DatasetArns": { - "target": "com.amazonaws.forecast#ArnList", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset\n group.

" + "smithy.api#documentation": "

The status of the dataset group. States include:

\n \n

The UPDATE states apply when you call the UpdateDatasetGroup operation.

\n \n

The Status of the dataset group must be ACTIVE before you can\n use the dataset group to create a predictor.

\n " } }, "DatasetGroupName": { @@ -1232,22 +1232,22 @@ "smithy.api#documentation": "

The name of the dataset group.

" } }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#Arn", + "DatasetArns": { + "target": "com.amazonaws.forecast#ArnList", "traits": { - "smithy.api#documentation": "

The ARN of the dataset group.

" + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset\n group.

" } }, - "Domain": { - "target": "com.amazonaws.forecast#Domain", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The domain associated with the dataset group.

" + "smithy.api#documentation": "

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime is the current time of the\n DescribeDatasetGroup call.

" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "Domain": { + "target": "com.amazonaws.forecast#Domain", "traits": { - "smithy.api#documentation": "

When the dataset group was created.

" + "smithy.api#documentation": "

The domain associated with the dataset group.

" } } } @@ -1288,28 +1288,22 @@ "com.amazonaws.forecast#DescribeDatasetImportJobResponse": { "type": "structure", "members": { - "DataSize": { - "target": "com.amazonaws.forecast#Double", - "traits": { - "smithy.api#documentation": "

The size of the dataset in gigabytes (GB) after the import job has finished.

" - } - }, - "FieldStatistics": { - "target": "com.amazonaws.forecast#FieldStatistics", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

Statistical information about each field in the input data.

" + "smithy.api#documentation": "

When the dataset import job was created.

" } }, - "DatasetArn": { - "target": "com.amazonaws.forecast#Arn", + "DataSource": { + "target": "com.amazonaws.forecast#DataSource", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that the training data was imported\n to.

" + "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data.

\n

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "DatasetImportJobName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS, the\n status of the dataset is UPDATE_IN_PROGRESS. States include:

\n " + "smithy.api#documentation": "

The name of the dataset import job.

" } }, "TimestampFormat": { @@ -1318,40 +1312,46 @@ "smithy.api#documentation": "

The format of timestamps in the dataset. The format that you specify depends on the\n DataFrequency specified when the dataset was created. The following formats are\n supported

\n " } }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "

The status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS, the\n status of the dataset is UPDATE_IN_PROGRESS. States include:

\n " + } + }, "DatasetImportJobArn": { "target": "com.amazonaws.forecast#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset import job.

" } }, - "Message": { - "target": "com.amazonaws.forecast#Message", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" + "smithy.api#documentation": "

The last time that the dataset was modified. The time depends on the status of the job, as\n follows:

\n " } }, - "DataSource": { - "target": "com.amazonaws.forecast#DataSource", + "DataSize": { + "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data.

\n

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

" + "smithy.api#documentation": "

The size of the dataset in gigabytes (GB) after the import job has finished.

" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "DatasetArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

When the dataset import job was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that the training data was imported\n to.

" } }, - "DatasetImportJobName": { - "target": "com.amazonaws.forecast#Name", + "Message": { + "target": "com.amazonaws.forecast#Message", "traits": { - "smithy.api#documentation": "

The name of the dataset import job.

" + "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "FieldStatistics": { + "target": "com.amazonaws.forecast#FieldStatistics", "traits": { - "smithy.api#documentation": "

The last time that the dataset was modified. The time depends on the status of the job, as\n follows:

\n " + "smithy.api#documentation": "

Statistical information about each field in the input data.

" } } } @@ -1371,22 +1371,22 @@ "com.amazonaws.forecast#DescribeDatasetResponse": { "type": "structure", "members": { - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "DataFrequency": { + "target": "com.amazonaws.forecast#Frequency", "traits": { - "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the DescribeDataset\n call. After a CreateDatasetImportJob operation has finished,\n LastModificationTime is when the import job completed or failed.

" + "smithy.api#documentation": "

The frequency of data collection.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"M\" indicates every month and \"30min\" indicates every 30 minutes.

" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "Domain": { + "target": "com.amazonaws.forecast#Domain", "traits": { - "smithy.api#documentation": "

The status of the dataset. States include:

\n \n

The UPDATE states apply while data is imported to the dataset from a call to\n the CreateDatasetImportJob operation and reflect the status of the dataset\n import job. For example, when the import job status is CREATE_IN_PROGRESS, the\n status of the dataset is UPDATE_IN_PROGRESS.

\n \n

The Status of the dataset must be ACTIVE before you can import\n training data.

\n " + "smithy.api#documentation": "

The domain associated with the dataset.

" } }, - "DatasetName": { - "target": "com.amazonaws.forecast#Name", + "DatasetType": { + "target": "com.amazonaws.forecast#DatasetType", "traits": { - "smithy.api#documentation": "

The name of the dataset.

" + "smithy.api#documentation": "

The dataset type.

" } }, "DatasetArn": { @@ -1407,28 +1407,28 @@ "smithy.api#documentation": "

When the dataset was created.

" } }, - "Domain": { - "target": "com.amazonaws.forecast#Domain", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The domain associated with the dataset.

" + "smithy.api#documentation": "

When you create a dataset, LastModificationTime is the same as\n CreationTime. While data is being imported to the dataset,\n LastModificationTime is the current time of the DescribeDataset\n call. After a CreateDatasetImportJob operation has finished,\n LastModificationTime is when the import job completed or failed.

" } }, - "Schema": { - "target": "com.amazonaws.forecast#Schema", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

An array of SchemaAttribute objects that specify the dataset fields. Each\n SchemaAttribute specifies the name and data type of a field.

" + "smithy.api#documentation": "

The status of the dataset. States include:

\n \n

The UPDATE states apply while data is imported to the dataset from a call to\n the CreateDatasetImportJob operation and reflect the status of the dataset\n import job. For example, when the import job status is CREATE_IN_PROGRESS, the\n status of the dataset is UPDATE_IN_PROGRESS.

\n \n

The Status of the dataset must be ACTIVE before you can import\n training data.

\n " } }, - "DataFrequency": { - "target": "com.amazonaws.forecast#Frequency", + "DatasetName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The frequency of data collection.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"M\" indicates every month and \"30min\" indicates every 30 minutes.

" + "smithy.api#documentation": "

The name of the dataset.

" } }, - "DatasetType": { - "target": "com.amazonaws.forecast#DatasetType", + "Schema": { + "target": "com.amazonaws.forecast#Schema", "traits": { - "smithy.api#documentation": "

The dataset type.

" + "smithy.api#documentation": "

An array of SchemaAttribute objects that specify the dataset fields. Each\n SchemaAttribute specifies the name and data type of a field.

" } } } @@ -1490,16 +1490,16 @@ "com.amazonaws.forecast#DescribeForecastExportJobResponse": { "type": "structure", "members": { - "ForecastArn": { - "target": "com.amazonaws.forecast#Arn", + "Message": { + "target": "com.amazonaws.forecast#Message", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the exported forecast.

" + "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

When the forecast export job was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the exported forecast.

" } }, "ForecastExportJobName": { @@ -1508,10 +1508,10 @@ "smithy.api#documentation": "

The name of the forecast export job.

" } }, - "Message": { - "target": "com.amazonaws.forecast#Message", + "ForecastExportJobArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" + "smithy.api#documentation": "

The ARN of the forecast export job.

" } }, "Destination": { @@ -1520,22 +1520,22 @@ "smithy.api#documentation": "

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

When the last successful export job finished.

" + "smithy.api#documentation": "

The status of the forecast export job. States include:

\n \n \n

The Status of the forecast export job must be ACTIVE before\n you can access the forecast in your S3 bucket.

\n " } }, - "ForecastExportJobArn": { - "target": "com.amazonaws.forecast#Arn", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the forecast export job.

" + "smithy.api#documentation": "

When the last successful export job finished.

" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the forecast export job. States include:

\n \n \n

The Status of the forecast export job must be ACTIVE before\n you can access the forecast in your S3 bucket.

\n " + "smithy.api#documentation": "

When the forecast export job was created.

" } } } @@ -1555,22 +1555,22 @@ "com.amazonaws.forecast#DescribeForecastResponse": { "type": "structure", "members": { - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#Arn", + "Status": { + "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "

The ARN of the dataset group that provided the data used to train the predictor.

" + "smithy.api#documentation": "

The status of the forecast. States include:

\n \n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast.

\n " } }, - "ForecastArn": { - "target": "com.amazonaws.forecast#Arn", + "ForecastName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The forecast ARN as specified in the request.

" + "smithy.api#documentation": "

The name of the forecast.

" } }, - "PredictorArn": { - "target": "com.amazonaws.forecast#Arn", + "ForecastTypes": { + "target": "com.amazonaws.forecast#ForecastTypes", "traits": { - "smithy.api#documentation": "

The ARN of the predictor used to generate the forecast.

" + "smithy.api#documentation": "

The quantiles at which probabilistic forecasts were generated.

" } }, "Message": { @@ -1579,34 +1579,34 @@ "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" } }, - "ForecastTypes": { - "target": "com.amazonaws.forecast#ForecastTypes", + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The quantiles at which probabilistic forecasts were generated.

" + "smithy.api#documentation": "

The ARN of the dataset group that provided the data used to train the predictor.

" } }, - "ForecastName": { - "target": "com.amazonaws.forecast#Name", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the forecast.

" + "smithy.api#documentation": "

When the forecast creation task was created.

" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

Initially, the same as CreationTime (status is CREATE_PENDING).\n Updated when inference (creating the forecast) starts (status changed to\n CREATE_IN_PROGRESS), and when inference is complete (status changed to\n ACTIVE) or fails (status changed to CREATE_FAILED).

" + "smithy.api#documentation": "

The ARN of the predictor used to generate the forecast.

" } }, - "Status": { - "target": "com.amazonaws.forecast#String", + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The status of the forecast. States include:

\n \n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast.

\n " + "smithy.api#documentation": "

The forecast ARN as specified in the request.

" } }, - "CreationTime": { + "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When the forecast creation task was created.

" + "smithy.api#documentation": "

Initially, the same as CreationTime (status is CREATE_PENDING).\n Updated when inference (creating the forecast) starts (status changed to\n CREATE_IN_PROGRESS), and when inference is complete (status changed to\n ACTIVE) or fails (status changed to CREATE_FAILED).

" } } } @@ -1647,16 +1647,10 @@ "com.amazonaws.forecast#DescribePredictorResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.forecast#Message", - "traits": { - "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" - } - }, - "AutoMLAlgorithmArns": { - "target": "com.amazonaws.forecast#ArnList", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When PerformAutoML is specified, the ARN of the chosen algorithm.

" + "smithy.api#documentation": "

Initially, the same as CreationTime (when the status is\n CREATE_PENDING). This value is updated when training starts (when the status\n changes to CREATE_IN_PROGRESS), and when training has completed (when the status\n changes to ACTIVE) or fails (when the status changes to\n CREATE_FAILED).

" } }, "Status": { @@ -1665,16 +1659,22 @@ "smithy.api#documentation": "

The status of the predictor. States include:

\n \n \n

The Status of the predictor must be ACTIVE before you can use\n the predictor to create a forecast.

\n " } }, + "PerformAutoML": { + "target": "com.amazonaws.forecast#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the predictor is set to perform AutoML.

" + } + }, "EncryptionConfig": { "target": "com.amazonaws.forecast#EncryptionConfig", "traits": { "smithy.api#documentation": "

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.

" } }, - "AlgorithmArn": { - "target": "com.amazonaws.forecast#Arn", + "PredictorName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm used for model training.

" + "smithy.api#documentation": "

The name of the predictor.

" } }, "InputDataConfig": { @@ -1689,16 +1689,10 @@ "smithy.api#documentation": "

Details on the the status and results of the backtests performed to evaluate the accuracy\n of the predictor. You specify the number of backtests to perform when you call the operation.

" } }, - "PredictorName": { - "target": "com.amazonaws.forecast#Name", - "traits": { - "smithy.api#documentation": "

The name of the predictor.

" - } - }, - "FeaturizationConfig": { - "target": "com.amazonaws.forecast#FeaturizationConfig", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The featurization configuration.

" + "smithy.api#documentation": "

When the model training task was created.

" } }, "DatasetImportJobArns": { @@ -1707,58 +1701,64 @@ "smithy.api#documentation": "

An array of the ARNs of the dataset import jobs used to import training data for the\n predictor.

" } }, - "TrainingParameters": { - "target": "com.amazonaws.forecast#TrainingParameters", - "traits": { - "smithy.api#documentation": "

The default training parameters or overrides selected during model training. If using the\n AutoML algorithm or if HPO is turned on while using the DeepAR+ algorithms, the optimized\n values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

" - } - }, - "ForecastHorizon": { - "target": "com.amazonaws.forecast#Integer", - "traits": { - "smithy.api#documentation": "

The number of time-steps of the forecast. The forecast horizon is also called the\n prediction length.

" - } - }, "HPOConfig": { "target": "com.amazonaws.forecast#HyperParameterTuningJobConfig", "traits": { "smithy.api#documentation": "

The hyperparameter override values for the algorithm.

" } }, + "FeaturizationConfig": { + "target": "com.amazonaws.forecast#FeaturizationConfig", + "traits": { + "smithy.api#documentation": "

The featurization configuration.

" + } + }, "PredictorArn": { "target": "com.amazonaws.forecast#Name", "traits": { "smithy.api#documentation": "

The ARN of the predictor.

" } }, - "PerformAutoML": { + "TrainingParameters": { + "target": "com.amazonaws.forecast#TrainingParameters", + "traits": { + "smithy.api#documentation": "

The default training parameters or overrides selected during model training. If using the\n AutoML algorithm or if HPO is turned on while using the DeepAR+ algorithms, the optimized\n values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

" + } + }, + "EvaluationParameters": { + "target": "com.amazonaws.forecast#EvaluationParameters", + "traits": { + "smithy.api#documentation": "

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.

" + } + }, + "PerformHPO": { "target": "com.amazonaws.forecast#Boolean", "traits": { - "smithy.api#documentation": "

Whether the predictor is set to perform AutoML.

" + "smithy.api#documentation": "

Whether the predictor is set to perform hyperparameter optimization (HPO).

" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "AlgorithmArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

When the model training task was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm used for model training.

" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "AutoMLAlgorithmArns": { + "target": "com.amazonaws.forecast#ArnList", "traits": { - "smithy.api#documentation": "

Initially, the same as CreationTime (when the status is\n CREATE_PENDING). This value is updated when training starts (when the status\n changes to CREATE_IN_PROGRESS), and when training has completed (when the status\n changes to ACTIVE) or fails (when the status changes to\n CREATE_FAILED).

" + "smithy.api#documentation": "

When PerformAutoML is specified, the ARN of the chosen algorithm.

" } }, - "PerformHPO": { - "target": "com.amazonaws.forecast#Boolean", + "ForecastHorizon": { + "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

Whether the predictor is set to perform hyperparameter optimization (HPO).

" + "smithy.api#documentation": "

The number of time-steps of the forecast. The forecast horizon is also called the\n prediction length.

" } }, - "EvaluationParameters": { - "target": "com.amazonaws.forecast#EvaluationParameters", + "Message": { + "target": "com.amazonaws.forecast#Message", "traits": { - "smithy.api#documentation": "

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.

" + "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" } } } @@ -1807,17 +1807,17 @@ "com.amazonaws.forecast#EncryptionConfig": { "type": "structure", "members": { - "RoleArn": { - "target": "com.amazonaws.forecast#Arn", + "KMSKeyArn": { + "target": "com.amazonaws.forecast#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

\n

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your\n account, you get an InvalidInputException error.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key.

", "smithy.api#required": {} } }, - "KMSKeyArn": { - "target": "com.amazonaws.forecast#KMSKeyArn", + "RoleArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key.

", + "smithy.api#documentation": "

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

\n

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your\n account, you get an InvalidInputException error.

", "smithy.api#required": {} } } @@ -1832,16 +1832,16 @@ "com.amazonaws.forecast#EvaluationParameters": { "type": "structure", "members": { - "BackTestWindowOffset": { + "NumberOfBacktestWindows": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The point from the end of the dataset where you want to split the data for model training\n and testing (evaluation). Specify the value as the number of data points. The default is the\n value of the forecast horizon. BackTestWindowOffset can be used to mimic a past\n virtual forecast start date. This value must be greater than or equal to the forecast horizon\n and less than half of the TARGET_TIME_SERIES dataset length.

\n

\n ForecastHorizon <= BackTestWindowOffset < 1/2 *\n TARGET_TIME_SERIES dataset length

" + "smithy.api#documentation": "

The number of times to split the input data. The default is 1. Valid values are 1 through\n 5.

" } }, - "NumberOfBacktestWindows": { + "BackTestWindowOffset": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of times to split the input data. The default is 1. Valid values are 1 through\n 5.

" + "smithy.api#documentation": "

The point from the end of the dataset where you want to split the data for model training\n and testing (evaluation). Specify the value as the number of data points. The default is the\n value of the forecast horizon. BackTestWindowOffset can be used to mimic a past\n virtual forecast start date. This value must be greater than or equal to the forecast horizon\n and less than half of the TARGET_TIME_SERIES dataset length.

\n

\n ForecastHorizon <= BackTestWindowOffset < 1/2 *\n TARGET_TIME_SERIES dataset length

" } } }, @@ -1852,17 +1852,17 @@ "com.amazonaws.forecast#EvaluationResult": { "type": "structure", "members": { - "TestWindows": { - "target": "com.amazonaws.forecast#TestWindows", - "traits": { - "smithy.api#documentation": "

The array of test windows used for evaluating the algorithm. The\n NumberOfBacktestWindows from the EvaluationParameters\n object determines the number of windows in the array.

" - } - }, "AlgorithmArn": { "target": "com.amazonaws.forecast#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

" } + }, + "TestWindows": { + "target": "com.amazonaws.forecast#TestWindows", + "traits": { + "smithy.api#documentation": "

The array of test windows used for evaluating the algorithm. The\n NumberOfBacktestWindows from the EvaluationParameters\n object determines the number of windows in the array.

" + } } }, "traits": { @@ -1908,12 +1908,6 @@ "com.amazonaws.forecast#FeaturizationConfig": { "type": "structure", "members": { - "ForecastDimensions": { - "target": "com.amazonaws.forecast#ForecastDimensions", - "traits": { - "smithy.api#documentation": "

An array of dimension (field) names that specify how to group the generated forecast.

\n

For example, suppose that you are generating a forecast for item sales across all of\n your stores, and your dataset contains a store_id field. If you want the sales\n forecast for each item by store, you would specify store_id as the dimension.

\n

All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't\n need to be specified in the CreatePredictor request.\n All forecast dimensions specified in the RELATED_TIME_SERIES dataset must\n be specified in the CreatePredictor request.

" - } - }, "ForecastFrequency": { "target": "com.amazonaws.forecast#Frequency", "traits": { @@ -1926,6 +1920,12 @@ "traits": { "smithy.api#documentation": "

An array of featurization (transformation) information for the fields of a dataset.

" } + }, + "ForecastDimensions": { + "target": "com.amazonaws.forecast#ForecastDimensions", + "traits": { + "smithy.api#documentation": "

An array of dimension (field) names that specify how to group the generated forecast.

\n

For example, suppose that you are generating a forecast for item sales across all of\n your stores, and your dataset contains a store_id field. If you want the sales\n forecast for each item by store, you would specify store_id as the dimension.

\n

All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't\n need to be specified in the CreatePredictor request.\n All forecast dimensions specified in the RELATED_TIME_SERIES dataset must\n be specified in the CreatePredictor request.

" + } } }, "traits": { @@ -2015,10 +2015,10 @@ "com.amazonaws.forecast#Filter": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.forecast#String", + "Value": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The name of the parameter to filter on.

", + "smithy.api#documentation": "

The value to match.

", "smithy.api#required": {} } }, @@ -2029,10 +2029,10 @@ "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.forecast#Arn", + "Key": { + "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "

The value to match.

", + "smithy.api#documentation": "

The name of the parameter to filter on.

", "smithy.api#required": {} } } @@ -2077,22 +2077,16 @@ "com.amazonaws.forecast#ForecastExportJobSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", - "traits": { - "smithy.api#documentation": "

When the forecast export job was created.

" - } - }, - "ForecastExportJobName": { - "target": "com.amazonaws.forecast#Name", + "Message": { + "target": "com.amazonaws.forecast#ErrorMessage", "traits": { - "smithy.api#documentation": "

The name of the forecast export job.

" + "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" } }, - "ForecastExportJobArn": { - "target": "com.amazonaws.forecast#Arn", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast export job.

" + "smithy.api#documentation": "

When the last successful export job finished.

" } }, "Status": { @@ -2101,16 +2095,16 @@ "smithy.api#documentation": "

The status of the forecast export job. States include:

\n \n \n

The Status of the forecast export job must be ACTIVE before\n you can access the forecast in your S3 bucket.

\n " } }, - "LastModificationTime": { + "CreationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When the last successful export job finished.

" + "smithy.api#documentation": "

When the forecast export job was created.

" } }, - "Message": { - "target": "com.amazonaws.forecast#ErrorMessage", + "ForecastExportJobArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast export job.

" } }, "Destination": { @@ -2118,6 +2112,12 @@ "traits": { "smithy.api#documentation": "

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

" } + }, + "ForecastExportJobName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the forecast export job.

" + } } }, "traits": { @@ -2133,28 +2133,28 @@ "com.amazonaws.forecast#ForecastSummary": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.forecast#ErrorMessage", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" + "smithy.api#documentation": "

The status of the forecast. States include:

\n \n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast.

\n " } }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#String", + "ForecastName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train\n the predictor.

" + "smithy.api#documentation": "

The name of the forecast.

" } }, - "CreationTime": { + "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

When the forecast creation task was created.

" + "smithy.api#documentation": "

Initially, the same as CreationTime (status is CREATE_PENDING).\n Updated when inference (creating the forecast) starts (status changed to\n CREATE_IN_PROGRESS), and when inference is complete (status changed to\n ACTIVE) or fails (status changed to CREATE_FAILED).

" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the forecast. States include:

\n \n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast.

\n " + "smithy.api#documentation": "

When the forecast creation task was created.

" } }, "ForecastArn": { @@ -2163,16 +2163,16 @@ "smithy.api#documentation": "

The ARN of the forecast.

" } }, - "ForecastName": { - "target": "com.amazonaws.forecast#Name", + "Message": { + "target": "com.amazonaws.forecast#ErrorMessage", "traits": { - "smithy.api#documentation": "

The name of the forecast.

" + "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "

Initially, the same as CreationTime (status is CREATE_PENDING).\n Updated when inference (creating the forecast) starts (status changed to\n CREATE_IN_PROGRESS), and when inference is complete (status changed to\n ACTIVE) or fails (status changed to CREATE_FAILED).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train\n the predictor.

" } }, "PredictorArn": { @@ -2320,17 +2320,17 @@ "smithy.api#required": {} } }, - "MinValue": { - "target": "com.amazonaws.forecast#Integer", + "Name": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The minimum tunable value of the hyperparameter.

", + "smithy.api#documentation": "

The name of the hyperparameter to tune.

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.forecast#Name", + "MinValue": { + "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The name of the hyperparameter to tune.

", + "smithy.api#documentation": "

The minimum tunable value of the hyperparameter.

", "smithy.api#required": {} } } @@ -2440,21 +2440,21 @@ } } } - }, - "com.amazonaws.forecast#ListDatasetGroupsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.

" - } - }, + }, + "com.amazonaws.forecast#ListDatasetGroupsResponse": { + "type": "structure", + "members": { "DatasetGroups": { "target": "com.amazonaws.forecast#DatasetGroups", "traits": { "smithy.api#documentation": "

An array of objects that summarize each dataset group's properties.

" } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.

" + } } } }, @@ -2552,17 +2552,17 @@ "com.amazonaws.forecast#ListDatasetsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", - "traits": { - "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" - } - }, "MaxResults": { "target": "com.amazonaws.forecast#MaxResults", "traits": { "smithy.api#documentation": "

The number of items to return in the response.

" } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" + } } } }, @@ -2619,34 +2619,34 @@ "smithy.api#documentation": "

The number of items to return in the response.

" } }, - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", - "traits": { - "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" - } - }, "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { "smithy.api#documentation": "

An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to include\n or exclude the forecast export jobs that match the statement from the list, respectively. The\n match statement consists of a key and a value.

\n

\n Filter properties\n

\n \n

For example, to list all jobs that export a forecast named\n electricityforecast, specify the following filter:

\n

\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"ForecastArn\", \"Value\":\n \"arn:aws:forecast:us-west-2::forecast/electricityforecast\" } ]\n

" } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" + } } } }, "com.amazonaws.forecast#ListForecastExportJobsResponse": { "type": "structure", "members": { - "ForecastExportJobs": { - "target": "com.amazonaws.forecast#ForecastExportJobs", - "traits": { - "smithy.api#documentation": "

An array of objects that summarize each export job's properties.

" - } - }, "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.

" } + }, + "ForecastExportJobs": { + "target": "com.amazonaws.forecast#ForecastExportJobs", + "traits": { + "smithy.api#documentation": "

An array of objects that summarize each export job's properties.

" + } } } }, @@ -2680,12 +2680,6 @@ "com.amazonaws.forecast#ListForecastsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.forecast#Filters", - "traits": { - "smithy.api#documentation": "

An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to include\n or exclude the forecasts that match the statement from the list, respectively. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n \n

For example, to list all forecasts whose status is not ACTIVE, you would specify:

\n

\n \"Filters\": [ { \"Condition\": \"IS_NOT\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]\n

" - } - }, "MaxResults": { "target": "com.amazonaws.forecast#MaxResults", "traits": { @@ -2697,23 +2691,29 @@ "traits": { "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" } + }, + "Filters": { + "target": "com.amazonaws.forecast#Filters", + "traits": { + "smithy.api#documentation": "

An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to include\n or exclude the forecasts that match the statement from the list, respectively. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n \n

For example, to list all forecasts whose status is not ACTIVE, you would specify:

\n

\n \"Filters\": [ { \"Condition\": \"IS_NOT\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]\n

" + } } } }, "com.amazonaws.forecast#ListForecastsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set\n of results, use the token in the next request.

" - } - }, "Forecasts": { "target": "com.amazonaws.forecast#Forecasts", "traits": { "smithy.api#documentation": "

An array of objects that summarize each forecast's properties.

" } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set\n of results, use the token in the next request.

" + } } } }, @@ -2747,18 +2747,18 @@ "com.amazonaws.forecast#ListPredictorsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.forecast#MaxResults", - "traits": { - "smithy.api#documentation": "

The number of items to return in the response.

" - } - }, "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" } }, + "MaxResults": { + "target": "com.amazonaws.forecast#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of items to return in the response.

" + } + }, "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { @@ -2770,17 +2770,17 @@ "com.amazonaws.forecast#ListPredictorsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.

" - } - }, "Predictors": { "target": "com.amazonaws.forecast#Predictors", "traits": { "smithy.api#documentation": "

An array of objects that summarize each predictor's properties.

" } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.

" + } } } }, @@ -2843,17 +2843,17 @@ "com.amazonaws.forecast#Metrics": { "type": "structure", "members": { - "RMSE": { - "target": "com.amazonaws.forecast#Double", - "traits": { - "smithy.api#documentation": "

The root mean square error (RMSE).

" - } - }, "WeightedQuantileLosses": { "target": "com.amazonaws.forecast#WeightedQuantileLosses", "traits": { "smithy.api#documentation": "

An array of weighted quantile losses. Quantiles divide a probability distribution into\n regions of equal probability. The distribution in this case is the loss function.

" } + }, + "RMSE": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#documentation": "

The root mean square error (RMSE).

" + } } }, "traits": { @@ -2892,12 +2892,6 @@ "com.amazonaws.forecast#ParameterRanges": { "type": "structure", "members": { - "ContinuousParameterRanges": { - "target": "com.amazonaws.forecast#ContinuousParameterRanges", - "traits": { - "smithy.api#documentation": "

Specifies the tunable range for each continuous hyperparameter.

" - } - }, "CategoricalParameterRanges": { "target": "com.amazonaws.forecast#CategoricalParameterRanges", "traits": { @@ -2909,6 +2903,12 @@ "traits": { "smithy.api#documentation": "

Specifies the tunable range for each integer hyperparameter.

" } + }, + "ContinuousParameterRanges": { + "target": "com.amazonaws.forecast#ContinuousParameterRanges", + "traits": { + "smithy.api#documentation": "

Specifies the tunable range for each continuous hyperparameter.

" + } } }, "traits": { @@ -2980,16 +2980,10 @@ "com.amazonaws.forecast#PredictorSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", - "traits": { - "smithy.api#documentation": "

When the model training task was created.

" - } - }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#Arn", + "PredictorName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train\n the predictor.

" + "smithy.api#documentation": "

The name of the predictor.

" } }, "Status": { @@ -2998,10 +2992,10 @@ "smithy.api#documentation": "

The status of the predictor. States include:

\n \n \n

The Status of the predictor must be ACTIVE before you can use\n the predictor to create a forecast.

\n " } }, - "PredictorName": { - "target": "com.amazonaws.forecast#Name", + "Message": { + "target": "com.amazonaws.forecast#ErrorMessage", "traits": { - "smithy.api#documentation": "

The name of the predictor.

" + "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" } }, "LastModificationTime": { @@ -3010,16 +3004,22 @@ "smithy.api#documentation": "

Initially, the same as CreationTime (status is CREATE_PENDING).\n Updated when training starts (status changed to CREATE_IN_PROGRESS), and when\n training is complete (status changed to ACTIVE) or fails (status changed to\n CREATE_FAILED).

" } }, + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

When the model training task was created.

" + } + }, "PredictorArn": { "target": "com.amazonaws.forecast#Arn", "traits": { "smithy.api#documentation": "

The ARN of the predictor.

" } }, - "Message": { - "target": "com.amazonaws.forecast#ErrorMessage", + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

If an error occurred, an informational message about the error.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train\n the predictor.

" } } }, @@ -3075,10 +3075,10 @@ "com.amazonaws.forecast#S3Config": { "type": "structure", "members": { - "RoleArn": { - "target": "com.amazonaws.forecast#Arn", + "Path": { + "target": "com.amazonaws.forecast#S3Path", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket or files. If you provide a value for the KMSKeyArn key, the role must\n allow access to the key.

\n

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your\n account, you get an InvalidInputException error.

", + "smithy.api#documentation": "

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

", "smithy.api#required": {} } }, @@ -3088,10 +3088,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

" } }, - "Path": { - "target": "com.amazonaws.forecast#S3Path", + "RoleArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

", + "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket or files. If you provide a value for the KMSKeyArn key, the role must\n allow access to the key.

\n

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your\n account, you get an InvalidInputException error.

", "smithy.api#required": {} } } @@ -3146,17 +3146,17 @@ "com.amazonaws.forecast#SchemaAttribute": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.forecast#Name", - "traits": { - "smithy.api#documentation": "

The name of the dataset field.

" - } - }, "AttributeType": { "target": "com.amazonaws.forecast#AttributeType", "traits": { "smithy.api#documentation": "

The data type of the field.

" } + }, + "AttributeName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the dataset field.

" + } } }, "traits": { @@ -3178,10 +3178,10 @@ "com.amazonaws.forecast#Statistics": { "type": "structure", "members": { - "CountNan": { + "Count": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of NAN (not a number) values in the field.

" + "smithy.api#documentation": "

The number of values in the field.

" } }, "Stddev": { @@ -3208,22 +3208,22 @@ "smithy.api#documentation": "

For a numeric field, the maximum value in the field.

" } }, - "CountNull": { + "CountDistinct": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of null values in the field.

" + "smithy.api#documentation": "

The number of distinct values in the field.

" } }, - "Count": { + "CountNull": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of values in the field.

" + "smithy.api#documentation": "

The number of null values in the field.

" } }, - "CountDistinct": { + "CountNan": { "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "

The number of distinct values in the field.

" + "smithy.api#documentation": "

The number of NAN (not a number) values in the field.

" } } }, @@ -3253,17 +3253,17 @@ "com.amazonaws.forecast#SupplementaryFeature": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.forecast#Name", + "Value": { + "target": "com.amazonaws.forecast#Value", "traits": { - "smithy.api#documentation": "

The name of the feature. This must be \"holiday\".

", + "smithy.api#documentation": "

One of the following 2 letter country codes:

\n ", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.forecast#Value", + "Name": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

One of the following 2 letter country codes:

\n ", + "smithy.api#documentation": "

The name of the feature. This must be \"holiday\".

", "smithy.api#required": {} } } @@ -3405,18 +3405,18 @@ "com.amazonaws.forecast#TestWindowSummary": { "type": "structure", "members": { - "TestWindowEnd": { - "target": "com.amazonaws.forecast#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the test ended.

" - } - }, "Status": { "target": "com.amazonaws.forecast#Status", "traits": { "smithy.api#documentation": "

The status of the test. Possible status values are:

\n " } }, + "TestWindowEnd": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the test ended.

" + } + }, "TestWindowStart": { "target": "com.amazonaws.forecast#Timestamp", "traits": { @@ -3491,17 +3491,17 @@ "com.amazonaws.forecast#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.forecast#TagKeys", + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The keys of the tags to be removed.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast exports.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.forecast#Arn", + "TagKeys": { + "target": "com.amazonaws.forecast#TagKeys", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast exports.

", + "smithy.api#documentation": "

The keys of the tags to be removed.

", "smithy.api#required": {} } } @@ -3583,16 +3583,16 @@ "com.amazonaws.forecast#WeightedQuantileLoss": { "type": "structure", "members": { - "LossValue": { + "Quantile": { "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "

The difference between the predicted value and the actual value over the quantile,\n weighted (normalized) by dividing by the sum over all quantiles.

" + "smithy.api#documentation": "

The quantile. Quantiles divide a probability distribution into regions of equal\n probability. For example, if the distribution was divided into 5 regions of equal\n probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.

" } }, - "Quantile": { + "LossValue": { "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "

The quantile. Quantiles divide a probability distribution into regions of equal\n probability. For example, if the distribution was divided into 5 regions of equal\n probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.

" + "smithy.api#documentation": "

The difference between the predicted value and the actual value over the quantile,\n weighted (normalized) by dividing by the sum over all quantiles.

" } } }, @@ -3609,12 +3609,24 @@ "com.amazonaws.forecast#WindowSummary": { "type": "structure", "members": { + "ItemCount": { + "target": "com.amazonaws.forecast#Integer", + "traits": { + "smithy.api#documentation": "

The number of data points within the window.

" + } + }, "EvaluationType": { "target": "com.amazonaws.forecast#EvaluationType", "traits": { "smithy.api#documentation": "

The type of evaluation.

\n " } }, + "TestWindowEnd": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp that defines the end of the window.

" + } + }, "Metrics": { "target": "com.amazonaws.forecast#Metrics", "traits": { @@ -3626,18 +3638,6 @@ "traits": { "smithy.api#documentation": "

The timestamp that defines the start of the window.

" } - }, - "TestWindowEnd": { - "target": "com.amazonaws.forecast#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp that defines the end of the window.

" - } - }, - "ItemCount": { - "target": "com.amazonaws.forecast#Integer", - "traits": { - "smithy.api#documentation": "

The number of data points within the window.

" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/forecastquery.2018-06-26.json b/codegen/sdk-codegen/aws-models/forecastquery.2018-06-26.json index 2162b7b6eb1a..cc3816d25bbc 100644 --- a/codegen/sdk-codegen/aws-models/forecastquery.2018-06-26.json +++ b/codegen/sdk-codegen/aws-models/forecastquery.2018-06-26.json @@ -42,7 +42,7 @@ "sdkId": "forecastquery", "arnNamespace": "forecast", "cloudFormationName": "Forecastquery", - "cloudTrailEventSource": "queryservice.seer.amazonaws.com" + "cloudTrailEventSource": "forecastquery.amazonaws.com" }, "aws.auth#sigv4": { "name": "forecast" @@ -84,17 +84,17 @@ "com.amazonaws.forecastquery#DataPoint": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.forecastquery#Double", - "traits": { - "smithy.api#documentation": "

The forecast value.

" - } - }, "Timestamp": { "target": "com.amazonaws.forecastquery#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp of the specific forecast.

" } + }, + "Value": { + "target": "com.amazonaws.forecastquery#Double", + "traits": { + "smithy.api#documentation": "

The forecast value.

" + } } }, "traits": { @@ -102,7 +102,10 @@ } }, "com.amazonaws.forecastquery#DateTime": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{4}-\\d{2}-\\d{2}[Tt]\\d{2}:\\d{2}[a-zA-Z0-9\\:\\+\\-\\[\\]\\.\\/]*$" + } }, "com.amazonaws.forecastquery#Double": { "type": "double", @@ -231,17 +234,16 @@ "com.amazonaws.forecastquery#QueryForecastRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.forecastquery#Filters", + "StartDate": { + "target": "com.amazonaws.forecastquery#DateTime", "traits": { - "smithy.api#documentation": "

The filtering criteria to apply when retrieving the forecast. For example, to get the\n forecast for client_21 in the electricity usage dataset, specify the\n following:

\n

\n {\"item_id\" : \"client_21\"}\n

\n \n \n

To get the full forecast, use the CreateForecastExportJob operation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T08:00:00.

" } }, - "NextToken": { - "target": "com.amazonaws.forecastquery#NextToken", + "EndDate": { + "target": "com.amazonaws.forecastquery#DateTime", "traits": { - "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" + "smithy.api#documentation": "

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T20:00:00.

" } }, "ForecastArn": { @@ -251,16 +253,17 @@ "smithy.api#required": {} } }, - "StartDate": { - "target": "com.amazonaws.forecastquery#DateTime", + "NextToken": { + "target": "com.amazonaws.forecastquery#NextToken", "traits": { - "smithy.api#documentation": "

The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T08:00:00.

" + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" } }, - "EndDate": { - "target": "com.amazonaws.forecastquery#DateTime", + "Filters": { + "target": "com.amazonaws.forecastquery#Filters", "traits": { - "smithy.api#documentation": "

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss\n (ISO 8601 format). For example, 2015-01-01T20:00:00.

" + "smithy.api#documentation": "

The filtering criteria to apply when retrieving the forecast. For example, to get the\n forecast for client_21 in the electricity usage dataset, specify the\n following:

\n

\n {\"item_id\" : \"client_21\"}\n

\n \n \n

To get the full forecast, use the CreateForecastExportJob operation.

", + "smithy.api#required": {} } } } diff --git a/codegen/sdk-codegen/aws-models/frauddetector.2019-11-15.json b/codegen/sdk-codegen/aws-models/frauddetector.2019-11-15.json index ad992505c9bb..a553e1c1360d 100644 --- a/codegen/sdk-codegen/aws-models/frauddetector.2019-11-15.json +++ b/codegen/sdk-codegen/aws-models/frauddetector.2019-11-15.json @@ -232,18 +232,18 @@ "com.amazonaws.frauddetector#BatchCreateVariableError": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.frauddetector#integer", - "traits": { - "smithy.api#documentation": "

The error code.

" - } - }, "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name.

" } }, + "code": { + "target": "com.amazonaws.frauddetector#integer", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, "message": { "target": "com.amazonaws.frauddetector#string", "traits": { @@ -319,18 +319,18 @@ "com.amazonaws.frauddetector#BatchGetVariableError": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.frauddetector#string", - "traits": { - "smithy.api#documentation": "

The error name.

" - } - }, "code": { "target": "com.amazonaws.frauddetector#integer", "traits": { "smithy.api#documentation": "

The error code.

" } }, + "name": { + "target": "com.amazonaws.frauddetector#string", + "traits": { + "smithy.api#documentation": "

The error name.

" + } + }, "message": { "target": "com.amazonaws.frauddetector#string", "traits": { @@ -425,10 +425,16 @@ "com.amazonaws.frauddetector#CreateDetectorVersionRequest": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.frauddetector#description", + "ruleExecutionMode": { + "target": "com.amazonaws.frauddetector#RuleExecutionMode", "traits": { - "smithy.api#documentation": "

The description of the detector version.

" + "smithy.api#documentation": "

The rule execution mode for the rules included in the detector version.

\n\t

You can define and edit the rule mode at the detector version level, when it is in draft status.

\n\t

If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

\n\t

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

\n

The default behavior is FIRST_MATCHED.

" + } + }, + "modelVersions": { + "target": "com.amazonaws.frauddetector#ListOfModelVersions", + "traits": { + "smithy.api#documentation": "

The model versions to include in the detector version.

" } }, "tags": { @@ -443,29 +449,23 @@ "smithy.api#documentation": "

The Amazon Sagemaker model endpoints to include in the detector version.

" } }, - "modelVersions": { - "target": "com.amazonaws.frauddetector#ListOfModelVersions", + "description": { + "target": "com.amazonaws.frauddetector#description", "traits": { - "smithy.api#documentation": "

The model versions to include in the detector version.

" + "smithy.api#documentation": "

The description of the detector version.

" } }, - "detectorId": { - "target": "com.amazonaws.frauddetector#identifier", + "rules": { + "target": "com.amazonaws.frauddetector#RuleList", "traits": { - "smithy.api#documentation": "

The ID of the detector under which you want to create a new version.

", + "smithy.api#documentation": "

The rules to include in the detector version.

", "smithy.api#required": {} } }, - "ruleExecutionMode": { - "target": "com.amazonaws.frauddetector#RuleExecutionMode", - "traits": { - "smithy.api#documentation": "

The rule execution mode for the rules included in the detector version.

\n\t

You can define and edit the rule mode at the detector version level, when it is in draft status.

\n\t

If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

\n\t

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

\n

The default behavior is FIRST_MATCHED.

" - } - }, - "rules": { - "target": "com.amazonaws.frauddetector#RuleList", + "detectorId": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The rules to include in the detector version.

", + "smithy.api#documentation": "

The ID of the detector under which you want to create a new version.

", "smithy.api#required": {} } } @@ -474,12 +474,6 @@ "com.amazonaws.frauddetector#CreateDetectorVersionResult": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.frauddetector#DetectorVersionStatus", - "traits": { - "smithy.api#documentation": "

The status of the detector version.

" - } - }, "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { @@ -491,6 +485,12 @@ "traits": { "smithy.api#documentation": "

The ID for the created detector.

" } + }, + "status": { + "target": "com.amazonaws.frauddetector#DetectorVersionStatus", + "traits": { + "smithy.api#documentation": "

The status of the detector version.

" + } } } }, @@ -520,12 +520,25 @@ "com.amazonaws.frauddetector#CreateModelRequest": { "type": "structure", "members": { + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "traits": { + "smithy.api#documentation": "

The model type.

", + "smithy.api#required": {} + } + }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } }, + "description": { + "target": "com.amazonaws.frauddetector#description", + "traits": { + "smithy.api#documentation": "

The model description.

" + } + }, "eventTypeName": { "target": "com.amazonaws.frauddetector#string", "traits": { @@ -539,19 +552,6 @@ "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } - }, - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", - "traits": { - "smithy.api#documentation": "

The model type.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.frauddetector#description", - "traits": { - "smithy.api#documentation": "

The model description.

" - } } } }, @@ -588,20 +588,6 @@ "com.amazonaws.frauddetector#CreateModelVersionRequest": { "type": "structure", "members": { - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", - "traits": { - "smithy.api#documentation": "

The model type.

", - "smithy.api#required": {} - } - }, - "trainingDataSource": { - "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", - "traits": { - "smithy.api#documentation": "

The training data source location in Amazon S3.

", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { @@ -622,27 +608,35 @@ "smithy.api#required": {} } }, + "trainingDataSource": { + "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", + "traits": { + "smithy.api#documentation": "

The training data source location in Amazon S3.

", + "smithy.api#required": {} + } + }, "externalEventsDetail": { "target": "com.amazonaws.frauddetector#ExternalEventsDetail", "traits": { "smithy.api#documentation": "

Details for the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.

" } + }, + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "traits": { + "smithy.api#documentation": "

The model type.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.frauddetector#CreateModelVersionResult": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", - "traits": { - "smithy.api#documentation": "

The model ID.

" - } - }, - "status": { - "target": "com.amazonaws.frauddetector#string", + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { - "smithy.api#documentation": "

The model version status.

" + "smithy.api#documentation": "

The model type.

" } }, "modelVersionNumber": { @@ -651,10 +645,16 @@ "smithy.api#documentation": "

The model version number of the model version created.

" } }, - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { - "smithy.api#documentation": "

The model type.

" + "smithy.api#documentation": "

The model ID.

" + } + }, + "status": { + "target": "com.amazonaws.frauddetector#string", + "traits": { + "smithy.api#documentation": "

The model version status.

" } } } @@ -688,25 +688,13 @@ "com.amazonaws.frauddetector#CreateRuleRequest": { "type": "structure", "members": { - "language": { - "target": "com.amazonaws.frauddetector#Language", + "detectorId": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The language of the rule.

", + "smithy.api#documentation": "

The detector ID for the rule's parent detector.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.frauddetector#description", - "traits": { - "smithy.api#documentation": "

The rule description.

" - } - }, - "tags": { - "target": "com.amazonaws.frauddetector#tagList", - "traits": { - "smithy.api#documentation": "

A collection of key and value pairs.

" - } - }, "outcomes": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { @@ -714,13 +702,6 @@ "smithy.api#required": {} } }, - "detectorId": { - "target": "com.amazonaws.frauddetector#identifier", - "traits": { - "smithy.api#documentation": "

The detector ID for the rule's parent detector.

", - "smithy.api#required": {} - } - }, "ruleId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { @@ -734,6 +715,25 @@ "smithy.api#documentation": "

The rule expression.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.frauddetector#tagList", + "traits": { + "smithy.api#documentation": "

A collection of key and value pairs.

" + } + }, + "description": { + "target": "com.amazonaws.frauddetector#description", + "traits": { + "smithy.api#documentation": "

The rule description.

" + } + }, + "language": { + "target": "com.amazonaws.frauddetector#Language", + "traits": { + "smithy.api#documentation": "

The language of the rule.

", + "smithy.api#required": {} + } } } }, @@ -777,50 +777,50 @@ "com.amazonaws.frauddetector#CreateVariableRequest": { "type": "structure", "members": { - "defaultValue": { + "description": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The default value for the variable when no value is received.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description.

" } }, - "dataSource": { - "target": "com.amazonaws.frauddetector#DataSource", + "tags": { + "target": "com.amazonaws.frauddetector#tagList", "traits": { - "smithy.api#documentation": "

The source of the data.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A collection of key and value pairs.

" } }, - "variableType": { + "name": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The variable type. For more information see Variable types.\n\t\t\t\t

\n

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT | SHIPPING_ZIP | USERAGENT\n

" + "smithy.api#documentation": "

The name of the variable.

", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.frauddetector#tagList", + "variableType": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

A collection of key and value pairs.

" + "smithy.api#documentation": "

The variable type. For more information see Variable types.\n\t\t\t\t

\n

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT\n

" } }, - "dataType": { - "target": "com.amazonaws.frauddetector#DataType", + "dataSource": { + "target": "com.amazonaws.frauddetector#DataSource", "traits": { - "smithy.api#documentation": "

The data type.

", + "smithy.api#documentation": "

The source of the data.

", "smithy.api#required": {} } }, - "name": { + "defaultValue": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The name of the variable.

", + "smithy.api#documentation": "

The default value for the variable when no value is received.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.frauddetector#string", + "dataType": { + "target": "com.amazonaws.frauddetector#DataType", "traits": { - "smithy.api#documentation": "

The description.

" + "smithy.api#documentation": "

The data type.

", + "smithy.api#required": {} } } } @@ -1026,17 +1026,17 @@ "com.amazonaws.frauddetector#DeleteEventRequest": { "type": "structure", "members": { - "eventId": { + "eventTypeName": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The ID of the event to delete.

", + "smithy.api#documentation": "

The name of the event type.

", "smithy.api#required": {} } }, - "eventTypeName": { + "eventId": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The name of the event type.

", + "smithy.api#documentation": "

The ID of the event to delete.

", "smithy.api#required": {} } } @@ -1129,27 +1129,27 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.frauddetector#DetectorVersionMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return for the request.

" - } - }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token from the previous response.

" } + }, + "maxResults": { + "target": "com.amazonaws.frauddetector#DetectorVersionMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for the request.

" + } } } }, "com.amazonaws.frauddetector#DescribeDetectorResult": { "type": "structure", "members": { - "detectorVersionSummaries": { - "target": "com.amazonaws.frauddetector#DetectorVersionSummaryList", + "nextToken": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The status and description for each detector version.

" + "smithy.api#documentation": "

The next token to be used for subsequent requests.

" } }, "arn": { @@ -1164,10 +1164,10 @@ "smithy.api#documentation": "

The detector ID.

" } }, - "nextToken": { - "target": "com.amazonaws.frauddetector#string", + "detectorVersionSummaries": { + "target": "com.amazonaws.frauddetector#DetectorVersionSummaryList", "traits": { - "smithy.api#documentation": "

The next token to be used for subsequent requests.

" + "smithy.api#documentation": "

The status and description for each detector version.

" } } } @@ -1206,10 +1206,10 @@ "com.amazonaws.frauddetector#DescribeModelVersionsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.frauddetector#modelsMaxPageSize", + "nextToken": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" + "smithy.api#documentation": "

The next token from the previous results.

" } }, "modelVersionNumber": { @@ -1224,16 +1224,16 @@ "smithy.api#documentation": "

The model type.

" } }, - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "maxResults": { + "target": "com.amazonaws.frauddetector#modelsMaxPageSize", "traits": { - "smithy.api#documentation": "

The model ID.

" + "smithy.api#documentation": "

The maximum number of results to return.

" } }, - "nextToken": { - "target": "com.amazonaws.frauddetector#string", + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { - "smithy.api#documentation": "

The next token from the previous results.

" + "smithy.api#documentation": "

The model ID.

" } } } @@ -1241,33 +1241,33 @@ "com.amazonaws.frauddetector#DescribeModelVersionsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.frauddetector#string", - "traits": { - "smithy.api#documentation": "

The next token.

" - } - }, "modelVersionDetails": { "target": "com.amazonaws.frauddetector#modelVersionDetailList", "traits": { "smithy.api#documentation": "

The model version details.

" } + }, + "nextToken": { + "target": "com.amazonaws.frauddetector#string", + "traits": { + "smithy.api#documentation": "

The next token.

" + } } } }, "com.amazonaws.frauddetector#Detector": { "type": "structure", "members": { - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "eventTypeName": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

Timestamp of when the detector was created.

" + "smithy.api#documentation": "

The name of the event type.

" } }, - "eventTypeName": { + "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The name of the event type.

" + "smithy.api#documentation": "

The detector ID.

" } }, "description": { @@ -1276,16 +1276,10 @@ "smithy.api#documentation": "

The detector description.

" } }, - "detectorId": { - "target": "com.amazonaws.frauddetector#identifier", - "traits": { - "smithy.api#documentation": "

The detector ID.

" - } - }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The detector ARN.

" + "smithy.api#documentation": "

Timestamp of when the detector was created.

" } }, "lastUpdatedTime": { @@ -1293,6 +1287,12 @@ "traits": { "smithy.api#documentation": "

Timestamp of when the detector was last updated.

" } + }, + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "traits": { + "smithy.api#documentation": "

The detector ARN.

" + } } }, "traits": { @@ -1337,12 +1337,6 @@ "com.amazonaws.frauddetector#DetectorVersionSummary": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.frauddetector#DetectorVersionStatus", - "traits": { - "smithy.api#documentation": "

The detector version status.

" - } - }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#nonEmptyString", "traits": { @@ -1355,6 +1349,12 @@ "smithy.api#documentation": "

Timestamp of when the detector version was last updated.

" } }, + "status": { + "target": "com.amazonaws.frauddetector#DetectorVersionStatus", + "traits": { + "smithy.api#documentation": "

The detector version status.

" + } + }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { @@ -1385,17 +1385,17 @@ "com.amazonaws.frauddetector#Entity": { "type": "structure", "members": { - "entityId": { - "target": "com.amazonaws.frauddetector#identifier", + "entityType": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.

", + "smithy.api#documentation": "

The entity type.

", "smithy.api#required": {} } }, - "entityType": { - "target": "com.amazonaws.frauddetector#string", + "entityId": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The entity type.

", + "smithy.api#documentation": "

The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.

", "smithy.api#required": {} } } @@ -1407,10 +1407,10 @@ "com.amazonaws.frauddetector#EntityType": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The entity type ARN.

" + "smithy.api#documentation": "

Timestamp of when the entity type was created.

" } }, "lastUpdatedTime": { @@ -1419,22 +1419,22 @@ "smithy.api#documentation": "

Timestamp of when the entity type was last updated.

" } }, - "description": { - "target": "com.amazonaws.frauddetector#description", - "traits": { - "smithy.api#documentation": "

The entity type description.

" - } - }, "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The entity type name.

" } }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "description": { + "target": "com.amazonaws.frauddetector#description", "traits": { - "smithy.api#documentation": "

Timestamp of when the entity type was created.

" + "smithy.api#documentation": "

The entity type description.

" + } + }, + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "traits": { + "smithy.api#documentation": "

The entity type ARN.

" } } }, @@ -1445,22 +1445,22 @@ "com.amazonaws.frauddetector#EventType": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.frauddetector#description", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The event type description.

" + "smithy.api#documentation": "

Timestamp of when the event type was created.

" } }, - "name": { - "target": "com.amazonaws.frauddetector#string", + "description": { + "target": "com.amazonaws.frauddetector#description", "traits": { - "smithy.api#documentation": "

The event type name.

" + "smithy.api#documentation": "

The event type description.

" } }, - "createdTime": { + "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

Timestamp of when the event type was created.

" + "smithy.api#documentation": "

Timestamp of when the event type was last updated.

" } }, "entityTypes": { @@ -1469,28 +1469,28 @@ "smithy.api#documentation": "

The event type entity types.

" } }, - "labels": { + "eventVariables": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { - "smithy.api#documentation": "

The event type labels.

" + "smithy.api#documentation": "

The event type event variables.

" } }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "labels": { + "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { - "smithy.api#documentation": "

The entity type ARN.

" + "smithy.api#documentation": "

The event type labels.

" } }, - "lastUpdatedTime": { - "target": "com.amazonaws.frauddetector#time", + "name": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

Timestamp of when the event type was last updated.

" + "smithy.api#documentation": "

The event type name.

" } }, - "eventVariables": { - "target": "com.amazonaws.frauddetector#ListOfStrings", + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

The event type event variables.

" + "smithy.api#documentation": "

The entity type ARN.

" } } }, @@ -1515,17 +1515,17 @@ "com.amazonaws.frauddetector#ExternalEventsDetail": { "type": "structure", "members": { - "dataAccessRoleArn": { - "target": "com.amazonaws.frauddetector#iamRoleArn", + "dataLocation": { + "target": "com.amazonaws.frauddetector#s3BucketLocation", "traits": { - "smithy.api#documentation": "

The ARN of the role that provides Amazon Fraud Detector access to the data location.

", + "smithy.api#documentation": "

The Amazon S3 bucket location for the data.

", "smithy.api#required": {} } }, - "dataLocation": { - "target": "com.amazonaws.frauddetector#s3BucketLocation", + "dataAccessRoleArn": { + "target": "com.amazonaws.frauddetector#iamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket location for the data.

", + "smithy.api#documentation": "

The ARN of the role that provides Amazon Fraud Detector access to the data location.

", "smithy.api#required": {} } } @@ -1537,22 +1537,16 @@ "com.amazonaws.frauddetector#ExternalModel": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", - "traits": { - "smithy.api#documentation": "

The model ARN.

" - } - }, - "modelEndpoint": { - "target": "com.amazonaws.frauddetector#string", + "outputConfiguration": { + "target": "com.amazonaws.frauddetector#ModelOutputConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon SageMaker model endpoints.

" + "smithy.api#documentation": "

The output configuration.

" } }, - "inputConfiguration": { - "target": "com.amazonaws.frauddetector#ModelInputConfiguration", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The input configuration.

" + "smithy.api#documentation": "

Timestamp of when the model was last created.

" } }, "lastUpdatedTime": { @@ -1561,34 +1555,40 @@ "smithy.api#documentation": "

Timestamp of when the model was last updated.

" } }, - "invokeModelEndpointRoleArn": { - "target": "com.amazonaws.frauddetector#string", + "modelEndpointStatus": { + "target": "com.amazonaws.frauddetector#ModelEndpointStatus", "traits": { - "smithy.api#documentation": "

The role used to invoke the model.

" + "smithy.api#documentation": "

The Amazon Fraud Detector status for the external model endpoint

" } }, - "modelSource": { - "target": "com.amazonaws.frauddetector#ModelSource", + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

The source of the model.

" + "smithy.api#documentation": "

The model ARN.

" } }, - "modelEndpointStatus": { - "target": "com.amazonaws.frauddetector#ModelEndpointStatus", + "invokeModelEndpointRoleArn": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The Amazon Fraud Detector status for the external model endpoint

" + "smithy.api#documentation": "

The role used to invoke the model.

" } }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "modelEndpoint": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

Timestamp of when the model was last created.

" + "smithy.api#documentation": "

The Amazon SageMaker model endpoints.

" } }, - "outputConfiguration": { - "target": "com.amazonaws.frauddetector#ModelOutputConfiguration", + "inputConfiguration": { + "target": "com.amazonaws.frauddetector#ModelInputConfiguration", "traits": { - "smithy.api#documentation": "

The output configuration.

" + "smithy.api#documentation": "

The input configuration.

" + } + }, + "modelSource": { + "target": "com.amazonaws.frauddetector#ModelSource", + "traits": { + "smithy.api#documentation": "

The source of the model.

" } } }, @@ -1627,10 +1627,10 @@ "com.amazonaws.frauddetector#FieldValidationMessage": { "type": "structure", "members": { - "type": { + "identifier": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The message type.

" + "smithy.api#documentation": "

The message ID.

" } }, "fieldName": { @@ -1639,22 +1639,22 @@ "smithy.api#documentation": "

The field name.

" } }, - "identifier": { + "type": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The message ID.

" + "smithy.api#documentation": "

The message type.

" } }, - "content": { + "title": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The message content.

" + "smithy.api#documentation": "

The message title.

" } }, - "title": { + "content": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The message title.

" + "smithy.api#documentation": "

The message content.

" } } }, @@ -1665,16 +1665,16 @@ "com.amazonaws.frauddetector#FileValidationMessage": { "type": "structure", "members": { - "content": { + "type": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The message content.

" + "smithy.api#documentation": "

The message type.

" } }, - "type": { + "content": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The message type.

" + "smithy.api#documentation": "

The message content.

" } }, "title": { @@ -1739,70 +1739,70 @@ "com.amazonaws.frauddetector#GetDetectorVersionResult": { "type": "structure", "members": { - "externalModelEndpoints": { - "target": "com.amazonaws.frauddetector#ListOfStrings", + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

The Amazon SageMaker model endpoints included in the detector version.

" + "smithy.api#documentation": "

The detector version ARN.

" } }, - "ruleExecutionMode": { - "target": "com.amazonaws.frauddetector#RuleExecutionMode", + "rules": { + "target": "com.amazonaws.frauddetector#RuleList", "traits": { - "smithy.api#documentation": "

The execution mode of the rule in the dectector

\n\t

\n FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

\n\t

\n ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

" + "smithy.api#documentation": "

The rules included in the detector version.

" } }, - "detectorVersionId": { - "target": "com.amazonaws.frauddetector#wholeNumberVersionString", + "modelVersions": { + "target": "com.amazonaws.frauddetector#ListOfModelVersions", "traits": { - "smithy.api#documentation": "

The detector version ID.

" + "smithy.api#documentation": "

The model versions included in the detector version.

" } }, - "description": { - "target": "com.amazonaws.frauddetector#description", + "detectorVersionId": { + "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { - "smithy.api#documentation": "

The detector version description.

" + "smithy.api#documentation": "

The detector version ID.

" } }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "detectorId": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The detector version ARN.

" + "smithy.api#documentation": "

The detector ID.

" } }, - "status": { - "target": "com.amazonaws.frauddetector#DetectorVersionStatus", + "ruleExecutionMode": { + "target": "com.amazonaws.frauddetector#RuleExecutionMode", "traits": { - "smithy.api#documentation": "

The status of the detector version.

" + "smithy.api#documentation": "

The execution mode of the rule in the dectector

\n\t

\n FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

\n\t

\n ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

" } }, - "rules": { - "target": "com.amazonaws.frauddetector#RuleList", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The rules included in the detector version.

" + "smithy.api#documentation": "

The timestamp when the detector version was created.

" } }, - "lastUpdatedTime": { - "target": "com.amazonaws.frauddetector#time", + "description": { + "target": "com.amazonaws.frauddetector#description", "traits": { - "smithy.api#documentation": "

The timestamp when the detector version was last updated.\n

" + "smithy.api#documentation": "

The detector version description.

" } }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "externalModelEndpoints": { + "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { - "smithy.api#documentation": "

The timestamp when the detector version was created.

" + "smithy.api#documentation": "

The Amazon SageMaker model endpoints included in the detector version.

" } }, - "modelVersions": { - "target": "com.amazonaws.frauddetector#ListOfModelVersions", + "status": { + "target": "com.amazonaws.frauddetector#DetectorVersionStatus", "traits": { - "smithy.api#documentation": "

The model versions included in the detector version.

" + "smithy.api#documentation": "

The status of the detector version.

" } }, - "detectorId": { - "target": "com.amazonaws.frauddetector#identifier", + "lastUpdatedTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The detector ID.

" + "smithy.api#documentation": "

The timestamp when the detector version was last updated.\n

" } } } @@ -1844,18 +1844,18 @@ "com.amazonaws.frauddetector#GetDetectorsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.frauddetector#DetectorsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of objects to return for the request.

" - } - }, "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

" } }, + "maxResults": { + "target": "com.amazonaws.frauddetector#DetectorsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of objects to return for the request.

" + } + }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { @@ -1984,13 +1984,19 @@ "com.amazonaws.frauddetector#GetEventPredictionRequest": { "type": "structure", "members": { - "eventId": { + "eventTimestamp": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The unique ID used to identify the event.

", + "smithy.api#documentation": "

Timestamp that defines when the event under evaluation occurred.

", "smithy.api#required": {} } }, + "detectorVersionId": { + "target": "com.amazonaws.frauddetector#wholeNumberVersionString", + "traits": { + "smithy.api#documentation": "

The detector version ID.

" + } + }, "eventVariables": { "target": "com.amazonaws.frauddetector#EventVariableMap", "traits": { @@ -1998,29 +2004,23 @@ "smithy.api#required": {} } }, - "detectorVersionId": { - "target": "com.amazonaws.frauddetector#wholeNumberVersionString", - "traits": { - "smithy.api#documentation": "

The detector version ID.

" - } - }, "externalModelEndpointDataBlobs": { "target": "com.amazonaws.frauddetector#ExternalModelEndpointDataBlobMap", "traits": { "smithy.api#documentation": "

The Amazon SageMaker model endpoint input data blobs.

" } }, - "eventTypeName": { + "eventId": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The event type associated with the detector specified for the prediction.

", + "smithy.api#documentation": "

The unique ID used to identify the event.

", "smithy.api#required": {} } }, - "eventTimestamp": { + "eventTypeName": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

Timestamp that defines when the event under evaluation occurred.

", + "smithy.api#documentation": "

The event type associated with the detector specified for the prediction.

", "smithy.api#required": {} } }, @@ -2043,17 +2043,17 @@ "com.amazonaws.frauddetector#GetEventPredictionResult": { "type": "structure", "members": { - "modelScores": { - "target": "com.amazonaws.frauddetector#ListOfModelScores", - "traits": { - "smithy.api#documentation": "

The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.

" - } - }, "ruleResults": { "target": "com.amazonaws.frauddetector#ListOfRuleResults", "traits": { "smithy.api#documentation": "

The results.

" } + }, + "modelScores": { + "target": "com.amazonaws.frauddetector#ListOfModelScores", + "traits": { + "smithy.api#documentation": "

The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.

" + } } } }, @@ -2165,12 +2165,6 @@ "com.amazonaws.frauddetector#GetExternalModelsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.frauddetector#ExternalModelsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of objects to return for the request.

" - } - }, "modelEndpoint": { "target": "com.amazonaws.frauddetector#string", "traits": { @@ -2182,23 +2176,29 @@ "traits": { "smithy.api#documentation": "

The next page token for the request.

" } + }, + "maxResults": { + "target": "com.amazonaws.frauddetector#ExternalModelsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of objects to return for the request.

" + } } } }, "com.amazonaws.frauddetector#GetExternalModelsResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.frauddetector#string", - "traits": { - "smithy.api#documentation": "

The next page token to be used in subsequent requests.

" - } - }, "externalModels": { "target": "com.amazonaws.frauddetector#ExternalModelList", "traits": { "smithy.api#documentation": "

Gets the Amazon SageMaker models.

" } + }, + "nextToken": { + "target": "com.amazonaws.frauddetector#string", + "traits": { + "smithy.api#documentation": "

The next page token to be used in subsequent requests.

" + } } } }, @@ -2273,17 +2273,17 @@ "smithy.api#documentation": "

The name of the label or labels to get.

" } }, - "maxResults": { - "target": "com.amazonaws.frauddetector#labelsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of objects to return for the request.

" - } - }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for the subsequent request.

" } + }, + "maxResults": { + "target": "com.amazonaws.frauddetector#labelsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of objects to return for the request.

" + } } } }, @@ -2333,24 +2333,24 @@ "com.amazonaws.frauddetector#GetModelVersionRequest": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "modelVersionNumber": { + "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { - "smithy.api#documentation": "

The model ID.

", + "smithy.api#documentation": "

The model version number.

", "smithy.api#required": {} } }, - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { - "smithy.api#documentation": "

The model type.

", + "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } }, - "modelVersionNumber": { - "target": "com.amazonaws.frauddetector#floatVersionString", + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { - "smithy.api#documentation": "

The model version number.

", + "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } } @@ -2359,22 +2359,10 @@ "com.amazonaws.frauddetector#GetModelVersionResult": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", - "traits": { - "smithy.api#documentation": "

The model version ARN.

" - } - }, - "trainingDataSource": { - "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", - "traits": { - "smithy.api#documentation": "

The training data source.

" - } - }, - "trainingDataSchema": { - "target": "com.amazonaws.frauddetector#TrainingDataSchema", + "modelVersionNumber": { + "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { - "smithy.api#documentation": "

The training data schema.

" + "smithy.api#documentation": "

The model version number.

" } }, "status": { @@ -2389,10 +2377,16 @@ "smithy.api#documentation": "

The model ID.

" } }, - "modelVersionNumber": { - "target": "com.amazonaws.frauddetector#floatVersionString", + "trainingDataSchema": { + "target": "com.amazonaws.frauddetector#TrainingDataSchema", "traits": { - "smithy.api#documentation": "

The model version number.

" + "smithy.api#documentation": "

The training data schema.

" + } + }, + "trainingDataSource": { + "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", + "traits": { + "smithy.api#documentation": "

The training data source.

" } }, "externalEventsDetail": { @@ -2406,6 +2400,12 @@ "traits": { "smithy.api#documentation": "

The model type.

" } + }, + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "traits": { + "smithy.api#documentation": "

The model version ARN.

" + } } } }, @@ -2443,16 +2443,16 @@ "com.amazonaws.frauddetector#GetModelsRequest": { "type": "structure", "members": { - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { - "smithy.api#documentation": "

The model type.

" + "smithy.api#documentation": "

The model ID.

" } }, - "nextToken": { - "target": "com.amazonaws.frauddetector#string", + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { - "smithy.api#documentation": "

The next token for the subsequent request.

" + "smithy.api#documentation": "

The model type.

" } }, "maxResults": { @@ -2461,10 +2461,10 @@ "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } }, - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "nextToken": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The model ID.

" + "smithy.api#documentation": "

The next token for the subsequent request.

" } } } @@ -2597,17 +2597,16 @@ "com.amazonaws.frauddetector#GetRulesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.frauddetector#RulesMaxResults", + "nextToken": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The maximum number of rules to return for the request.

" + "smithy.api#documentation": "

The next page token.

" } }, - "detectorId": { - "target": "com.amazonaws.frauddetector#identifier", + "maxResults": { + "target": "com.amazonaws.frauddetector#RulesMaxResults", "traits": { - "smithy.api#documentation": "

The detector ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of rules to return for the request.

" } }, "ruleVersion": { @@ -2616,16 +2615,17 @@ "smithy.api#documentation": "

The rule version.

" } }, - "nextToken": { - "target": "com.amazonaws.frauddetector#string", + "ruleId": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The next page token.

" + "smithy.api#documentation": "

The rule ID.

" } }, - "ruleId": { + "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The rule ID.

" + "smithy.api#documentation": "

The detector ID.

", + "smithy.api#required": {} } } } @@ -2690,17 +2690,17 @@ "smithy.api#documentation": "

The name of the variable.

" } }, - "maxResults": { - "target": "com.amazonaws.frauddetector#VariablesMaxResults", - "traits": { - "smithy.api#documentation": "

The max size per page determined for the get variable request.

" - } - }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token of the get variable request.

" } + }, + "maxResults": { + "target": "com.amazonaws.frauddetector#VariablesMaxResults", + "traits": { + "smithy.api#documentation": "

The max size per page determined for the get variable request.

" + } } } }, @@ -2765,24 +2765,18 @@ "traits": { "smithy.api#length": { "min": 7, - "max": 80 + "max": 90 }, - "smithy.api#pattern": "^\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}$|DEFAULT|arn:[a-zA-Z0-9-]+:kms:[a-zA-Z0-9-]+:\\d{12}:key:[a-zA-Z0-9-_]+|[a-zA-Z0-9-_]\\S+" + "smithy.api#pattern": "^\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}|DEFAULT|arn:[a-zA-Z0-9-]+:kms:[a-zA-Z0-9-]+:\\d{12}:key\\/\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}$" } }, "com.amazonaws.frauddetector#Label": { "type": "structure", "members": { - "lastUpdatedTime": { + "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

Timestamp of when the label was last updated.

" - } - }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", - "traits": { - "smithy.api#documentation": "

The label ARN.

" + "smithy.api#documentation": "

Timestamp of when the event type was created.

" } }, "description": { @@ -2791,16 +2785,22 @@ "smithy.api#documentation": "

The label description.

" } }, + "lastUpdatedTime": { + "target": "com.amazonaws.frauddetector#time", + "traits": { + "smithy.api#documentation": "

Timestamp of when the label was last updated.

" + } + }, "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The label name.

" } }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

Timestamp of when the event type was created.

" + "smithy.api#documentation": "

The label ARN.

" } } }, @@ -2889,6 +2889,13 @@ "com.amazonaws.frauddetector#ListTagsForResourceRequest": { "type": "structure", "members": { + "resourceARN": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "traits": { + "smithy.api#documentation": "

The ARN that specifies the resource whose tags you want to list.

", + "smithy.api#required": {} + } + }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { @@ -2900,13 +2907,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } - }, - "resourceARN": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", - "traits": { - "smithy.api#documentation": "

The ARN that specifies the resource whose tags you want to list.

", - "smithy.api#required": {} - } } } }, @@ -2942,16 +2942,16 @@ "smithy.api#documentation": "

The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.

" } }, - "tpr": { + "precision": { "target": "com.amazonaws.frauddetector#float", "traits": { - "smithy.api#documentation": "

The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.

" + "smithy.api#documentation": "

The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.

" } }, - "precision": { + "tpr": { "target": "com.amazonaws.frauddetector#float", "traits": { - "smithy.api#documentation": "

The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.

" + "smithy.api#documentation": "

The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.

" } } }, @@ -2962,10 +2962,16 @@ "com.amazonaws.frauddetector#Model": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.frauddetector#description", + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

The model description.

" + "smithy.api#documentation": "

The ARN of the model.

" + } + }, + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "traits": { + "smithy.api#documentation": "

The model type.

" } }, "eventTypeName": { @@ -2980,16 +2986,16 @@ "smithy.api#documentation": "

Timestamp of last time the model was updated.

" } }, - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "description": { + "target": "com.amazonaws.frauddetector#description", "traits": { - "smithy.api#documentation": "

The model type.

" + "smithy.api#documentation": "

The model description.

" } }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The ARN of the model.

" + "smithy.api#documentation": "

Timestamp of when the model was created.

" } }, "modelId": { @@ -2997,12 +3003,6 @@ "traits": { "smithy.api#documentation": "

The model ID.

" } - }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", - "traits": { - "smithy.api#documentation": "

Timestamp of when the model was created.

" - } } }, "traits": { @@ -3047,10 +3047,10 @@ "com.amazonaws.frauddetector#ModelInputConfiguration": { "type": "structure", "members": { - "csvInputTemplate": { - "target": "com.amazonaws.frauddetector#string", + "eventTypeName": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

Template for constructing the CSV input-data sent to SageMaker. At event-evaluation,\n the placeholders for variable-names in the template will be replaced with the variable\n values before being sent to SageMaker.

" + "smithy.api#documentation": "

The event type name.

" } }, "format": { @@ -3065,10 +3065,10 @@ "smithy.api#documentation": "

Template for constructing the JSON input-data sent to SageMaker. At event-evaluation,\n the placeholders for variable names in the template will be replaced with the variable\n values before being sent to SageMaker.

" } }, - "eventTypeName": { - "target": "com.amazonaws.frauddetector#identifier", + "csvInputTemplate": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The event type name.

" + "smithy.api#documentation": "

Template for constructing the CSV input-data sent to SageMaker. At event-evaluation,\n the placeholders for variable-names in the template will be replaced with the variable\n values before being sent to SageMaker.

" } }, "useEventVariables": { @@ -3107,18 +3107,18 @@ "smithy.api#documentation": "

A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.

" } }, - "jsonKeyToVariableMap": { - "target": "com.amazonaws.frauddetector#JsonKeyToVariableMap", - "traits": { - "smithy.api#documentation": "

A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.

" - } - }, "format": { "target": "com.amazonaws.frauddetector#ModelOutputDataFormat", "traits": { "smithy.api#documentation": "

The format of the model output configuration.

", "smithy.api#required": {} } + }, + "jsonKeyToVariableMap": { + "target": "com.amazonaws.frauddetector#JsonKeyToVariableMap", + "traits": { + "smithy.api#documentation": "

A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.

" + } } }, "traits": { @@ -3152,17 +3152,17 @@ "com.amazonaws.frauddetector#ModelScores": { "type": "structure", "members": { - "scores": { - "target": "com.amazonaws.frauddetector#ModelPredictionMap", - "traits": { - "smithy.api#documentation": "

The model's fraud prediction scores.

" - } - }, "modelVersion": { "target": "com.amazonaws.frauddetector#ModelVersion", "traits": { "smithy.api#documentation": "

The model version.

" } + }, + "scores": { + "target": "com.amazonaws.frauddetector#ModelPredictionMap", + "traits": { + "smithy.api#documentation": "

The model's fraud prediction scores.

" + } } }, "traits": { @@ -3194,10 +3194,10 @@ "com.amazonaws.frauddetector#ModelVersion": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { - "smithy.api#documentation": "

The model ID.

", + "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, @@ -3208,17 +3208,17 @@ "smithy.api#required": {} } }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { - "smithy.api#documentation": "

The model version ARN.

" + "smithy.api#documentation": "

The model ID.

", + "smithy.api#required": {} } }, - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

The model type.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The model version ARN.

" } } }, @@ -3229,16 +3229,10 @@ "com.amazonaws.frauddetector#ModelVersionDetail": { "type": "structure", "members": { - "modelVersionNumber": { - "target": "com.amazonaws.frauddetector#floatVersionString", - "traits": { - "smithy.api#documentation": "

The model version number.

" - } - }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "externalEventsDetail": { + "target": "com.amazonaws.frauddetector#ExternalEventsDetail", "traits": { - "smithy.api#documentation": "

The timestamp when the model was created.

" + "smithy.api#documentation": "

The event details.

" } }, "status": { @@ -3247,46 +3241,46 @@ "smithy.api#documentation": "

The status of the model version.

" } }, - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", - "traits": { - "smithy.api#documentation": "

The model type.

" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.frauddetector#time", - "traits": { - "smithy.api#documentation": "

The timestamp when the model was last updated.

" - } - }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The model version ARN.

" } }, + "trainingResult": { + "target": "com.amazonaws.frauddetector#TrainingResult", + "traits": { + "smithy.api#documentation": "

The training results.

" + } + }, "trainingDataSource": { "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", "traits": { "smithy.api#documentation": "

The model version training data source.

" } }, - "trainingResult": { - "target": "com.amazonaws.frauddetector#TrainingResult", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The training results.

" + "smithy.api#documentation": "

The timestamp when the model was created.

" } }, - "externalEventsDetail": { - "target": "com.amazonaws.frauddetector#ExternalEventsDetail", + "modelVersionNumber": { + "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { - "smithy.api#documentation": "

The event details.

" + "smithy.api#documentation": "

The model version number.

" } }, - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "lastUpdatedTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The model ID.

" + "smithy.api#documentation": "

The timestamp when the model was last updated.

" + } + }, + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "traits": { + "smithy.api#documentation": "

The model type.

" } }, "trainingDataSchema": { @@ -3294,6 +3288,12 @@ "traits": { "smithy.api#documentation": "

The training data schema.

" } + }, + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", + "traits": { + "smithy.api#documentation": "

The model ID.

" + } } }, "traits": { @@ -3341,16 +3341,22 @@ "com.amazonaws.frauddetector#Outcome": { "type": "structure", "members": { + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "traits": { + "smithy.api#documentation": "

The outcome ARN.

" + } + }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp when the outcome was last updated.

" } }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "name": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The timestamp when the outcome was created.

" + "smithy.api#documentation": "

The outcome name.

" } }, "description": { @@ -3359,16 +3365,10 @@ "smithy.api#documentation": "

The outcome description.

" } }, - "name": { - "target": "com.amazonaws.frauddetector#identifier", - "traits": { - "smithy.api#documentation": "

The outcome name.

" - } - }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "createdTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The outcome ARN.

" + "smithy.api#documentation": "

The timestamp when the outcome was created.

" } } }, @@ -3421,18 +3421,6 @@ "com.amazonaws.frauddetector#PutDetectorRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.frauddetector#tagList", - "traits": { - "smithy.api#documentation": "

A collection of key and value pairs.

" - } - }, - "description": { - "target": "com.amazonaws.frauddetector#description", - "traits": { - "smithy.api#documentation": "

The description of the detector.

" - } - }, "eventTypeName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { @@ -3446,6 +3434,18 @@ "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.frauddetector#description", + "traits": { + "smithy.api#documentation": "

The description of the detector.

" + } + }, + "tags": { + "target": "com.amazonaws.frauddetector#tagList", + "traits": { + "smithy.api#documentation": "

A collection of key and value pairs.

" + } } } }, @@ -3479,11 +3479,10 @@ "com.amazonaws.frauddetector#PutEntityTypeRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.frauddetector#identifier", + "tags": { + "target": "com.amazonaws.frauddetector#tagList", "traits": { - "smithy.api#documentation": "

The name of the entity type.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A collection of key and value pairs.

" } }, "description": { @@ -3492,10 +3491,11 @@ "smithy.api#documentation": "

The description.

" } }, - "tags": { - "target": "com.amazonaws.frauddetector#tagList", + "name": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

A collection of key and value pairs.

" + "smithy.api#documentation": "

The name of the entity type.

", + "smithy.api#required": {} } } } @@ -3530,25 +3530,13 @@ "com.amazonaws.frauddetector#PutEventTypeRequest": { "type": "structure", "members": { - "labels": { - "target": "com.amazonaws.frauddetector#ListOfStrings", - "traits": { - "smithy.api#documentation": "

The event type labels.

" - } - }, - "eventVariables": { - "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", + "name": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The event type variables.

", + "smithy.api#documentation": "

The name.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.frauddetector#tagList", - "traits": { - "smithy.api#documentation": "

A collection of key and value pairs.

" - } - }, "entityTypes": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { @@ -3562,10 +3550,22 @@ "smithy.api#documentation": "

The description of the event type.

" } }, - "name": { - "target": "com.amazonaws.frauddetector#identifier", + "tags": { + "target": "com.amazonaws.frauddetector#tagList", "traits": { - "smithy.api#documentation": "

The name.

", + "smithy.api#documentation": "

A collection of key and value pairs.

" + } + }, + "labels": { + "target": "com.amazonaws.frauddetector#ListOfStrings", + "traits": { + "smithy.api#documentation": "

The event type labels.

" + } + }, + "eventVariables": { + "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", + "traits": { + "smithy.api#documentation": "

The event type variables.

", "smithy.api#required": {} } } @@ -3604,18 +3604,10 @@ "com.amazonaws.frauddetector#PutExternalModelRequest": { "type": "structure", "members": { - "invokeModelEndpointRoleArn": { - "target": "com.amazonaws.frauddetector#string", - "traits": { - "smithy.api#documentation": "

The IAM role used to invoke the model endpoint.

", - "smithy.api#required": {} - } - }, - "modelEndpointStatus": { - "target": "com.amazonaws.frauddetector#ModelEndpointStatus", + "tags": { + "target": "com.amazonaws.frauddetector#tagList", "traits": { - "smithy.api#documentation": "

The model endpoint’s status in Amazon Fraud Detector.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A collection of key and value pairs.

" } }, "inputConfiguration": { @@ -3632,16 +3624,17 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.frauddetector#tagList", + "invokeModelEndpointRoleArn": { + "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

A collection of key and value pairs.

" + "smithy.api#documentation": "

The IAM role used to invoke the model endpoint.

", + "smithy.api#required": {} } }, - "modelSource": { - "target": "com.amazonaws.frauddetector#ModelSource", + "modelEndpointStatus": { + "target": "com.amazonaws.frauddetector#ModelEndpointStatus", "traits": { - "smithy.api#documentation": "

The source of the model.

", + "smithy.api#documentation": "

The model endpoint’s status in Amazon Fraud Detector.

", "smithy.api#required": {} } }, @@ -3651,6 +3644,13 @@ "smithy.api#documentation": "

The model endpoint output configuration.

", "smithy.api#required": {} } + }, + "modelSource": { + "target": "com.amazonaws.frauddetector#ModelSource", + "traits": { + "smithy.api#documentation": "

The source of the model.

", + "smithy.api#required": {} + } } } }, @@ -3780,6 +3780,13 @@ "com.amazonaws.frauddetector#PutOutcomeRequest": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.frauddetector#identifier", + "traits": { + "smithy.api#documentation": "

The name of the outcome.

", + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { @@ -3791,13 +3798,6 @@ "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } - }, - "name": { - "target": "com.amazonaws.frauddetector#identifier", - "traits": { - "smithy.api#documentation": "

The name of the outcome.

", - "smithy.api#required": {} - } } } }, @@ -3824,6 +3824,13 @@ "com.amazonaws.frauddetector#Rule": { "type": "structure", "members": { + "ruleVersion": { + "target": "com.amazonaws.frauddetector#wholeNumberVersionString", + "traits": { + "smithy.api#documentation": "

The rule version.

", + "smithy.api#required": {} + } + }, "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { @@ -3837,13 +3844,6 @@ "smithy.api#documentation": "

The rule ID.

", "smithy.api#required": {} } - }, - "ruleVersion": { - "target": "com.amazonaws.frauddetector#wholeNumberVersionString", - "traits": { - "smithy.api#documentation": "

The rule version.

", - "smithy.api#required": {} - } } }, "traits": { @@ -3853,22 +3853,10 @@ "com.amazonaws.frauddetector#RuleDetail": { "type": "structure", "members": { - "language": { - "target": "com.amazonaws.frauddetector#Language", - "traits": { - "smithy.api#documentation": "

The rule language.

" - } - }, - "description": { - "target": "com.amazonaws.frauddetector#description", - "traits": { - "smithy.api#documentation": "

The rule description.

" - } - }, - "createdTime": { - "target": "com.amazonaws.frauddetector#time", + "ruleVersion": { + "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { - "smithy.api#documentation": "

The timestamp of when the rule was created.

" + "smithy.api#documentation": "

The rule version.

" } }, "ruleId": { @@ -3895,22 +3883,34 @@ "smithy.api#documentation": "

The rule outcomes.

" } }, - "arn": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "language": { + "target": "com.amazonaws.frauddetector#Language", "traits": { - "smithy.api#documentation": "

The rule ARN.

" + "smithy.api#documentation": "

The rule language.

" } }, - "ruleVersion": { - "target": "com.amazonaws.frauddetector#wholeNumberVersionString", + "lastUpdatedTime": { + "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The rule version.

" + "smithy.api#documentation": "

Timestamp of the last time the rule was updated.

" } }, - "lastUpdatedTime": { + "description": { + "target": "com.amazonaws.frauddetector#description", + "traits": { + "smithy.api#documentation": "

The rule description.

" + } + }, + "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

Timestamp of the last time the rule was updated.

" + "smithy.api#documentation": "

The timestamp of when the rule was created.

" + } + }, + "arn": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "traits": { + "smithy.api#documentation": "

The rule ARN.

" } } }, @@ -4023,17 +4023,17 @@ "com.amazonaws.frauddetector#TagResourceRequest": { "type": "structure", "members": { - "resourceARN": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "tags": { + "target": "com.amazonaws.frauddetector#tagList", "traits": { - "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#documentation": "

The tags to assign to the resource.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.frauddetector#tagList", + "resourceARN": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

The tags to assign to the resource.

", + "smithy.api#documentation": "

The resource ARN.

", "smithy.api#required": {} } } @@ -4122,19 +4122,19 @@ } }, "com.amazonaws.frauddetector#TrainingResult": { - "type": "structure", - "members": { - "dataValidationMetrics": { - "target": "com.amazonaws.frauddetector#DataValidationMetrics", - "traits": { - "smithy.api#documentation": "

The validation metrics.

" - } - }, + "type": "structure", + "members": { "trainingMetrics": { "target": "com.amazonaws.frauddetector#TrainingMetrics", "traits": { "smithy.api#documentation": "

The training metric details.

" } + }, + "dataValidationMetrics": { + "target": "com.amazonaws.frauddetector#DataValidationMetrics", + "traits": { + "smithy.api#documentation": "

The validation metrics.

" + } } }, "traits": { @@ -4167,17 +4167,17 @@ "com.amazonaws.frauddetector#UntagResourceRequest": { "type": "structure", "members": { - "resourceARN": { - "target": "com.amazonaws.frauddetector#fraudDetectorArn", + "tagKeys": { + "target": "com.amazonaws.frauddetector#tagKeyList", "traits": { - "smithy.api#documentation": "

The ARN of the resource from which to remove the tag.

", + "smithy.api#documentation": "

The resource ARN.

", "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.frauddetector#tagKeyList", + "resourceARN": { + "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { - "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#documentation": "

The ARN of the resource from which to remove the tag.

", "smithy.api#required": {} } } @@ -4245,10 +4245,10 @@ "com.amazonaws.frauddetector#UpdateDetectorVersionMetadataRequest": { "type": "structure", "members": { - "detectorVersionId": { - "target": "com.amazonaws.frauddetector#wholeNumberVersionString", + "description": { + "target": "com.amazonaws.frauddetector#description", "traits": { - "smithy.api#documentation": "

The detector version ID.

", + "smithy.api#documentation": "

The description.

", "smithy.api#required": {} } }, @@ -4259,10 +4259,10 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.frauddetector#description", + "detectorVersionId": { + "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { - "smithy.api#documentation": "

The description.

", + "smithy.api#documentation": "

The detector version ID.

", "smithy.api#required": {} } } @@ -4275,19 +4275,13 @@ "com.amazonaws.frauddetector#UpdateDetectorVersionRequest": { "type": "structure", "members": { - "detectorVersionId": { - "target": "com.amazonaws.frauddetector#wholeNumberVersionString", + "rules": { + "target": "com.amazonaws.frauddetector#RuleList", "traits": { - "smithy.api#documentation": "

The detector version ID.

", + "smithy.api#documentation": "

The rules to include in the detector version.

", "smithy.api#required": {} } }, - "modelVersions": { - "target": "com.amazonaws.frauddetector#ListOfModelVersions", - "traits": { - "smithy.api#documentation": "

The model versions to include in the detector version.

" - } - }, "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { @@ -4295,17 +4289,17 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.frauddetector#description", + "detectorVersionId": { + "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { - "smithy.api#documentation": "

The detector version description.

" + "smithy.api#documentation": "

The detector version ID.

", + "smithy.api#required": {} } }, - "rules": { - "target": "com.amazonaws.frauddetector#RuleList", + "modelVersions": { + "target": "com.amazonaws.frauddetector#ListOfModelVersions", "traits": { - "smithy.api#documentation": "

The rules to include in the detector version.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The model versions to include in the detector version.

" } }, "externalModelEndpoints": { @@ -4320,6 +4314,12 @@ "traits": { "smithy.api#documentation": "

The rule execution mode to add to the detector.

\n\t

If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

\n\t

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

\n

The default behavior is FIRST_MATCHED.

" } + }, + "description": { + "target": "com.amazonaws.frauddetector#description", + "traits": { + "smithy.api#documentation": "

The detector version description.

" + } } } }, @@ -4359,17 +4359,17 @@ "com.amazonaws.frauddetector#UpdateDetectorVersionStatusRequest": { "type": "structure", "members": { - "detectorId": { - "target": "com.amazonaws.frauddetector#identifier", + "status": { + "target": "com.amazonaws.frauddetector#DetectorVersionStatus", "traits": { - "smithy.api#documentation": "

The detector ID.

", + "smithy.api#documentation": "

The new status.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.frauddetector#DetectorVersionStatus", + "detectorId": { + "target": "com.amazonaws.frauddetector#identifier", "traits": { - "smithy.api#documentation": "

The new status.

", + "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, @@ -4415,6 +4415,12 @@ "com.amazonaws.frauddetector#UpdateModelRequest": { "type": "structure", "members": { + "description": { + "target": "com.amazonaws.frauddetector#description", + "traits": { + "smithy.api#documentation": "

The new model description.

" + } + }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { @@ -4428,12 +4434,6 @@ "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.frauddetector#description", - "traits": { - "smithy.api#documentation": "

The new model description.

" - } } } }, @@ -4470,6 +4470,13 @@ "com.amazonaws.frauddetector#UpdateModelVersionRequest": { "type": "structure", "members": { + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", + "traits": { + "smithy.api#documentation": "

The model ID.

", + "smithy.api#required": {} + } + }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { @@ -4483,11 +4490,10 @@ "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "externalEventsDetail": { + "target": "com.amazonaws.frauddetector#ExternalEventsDetail", "traits": { - "smithy.api#documentation": "

The model ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The event details.

" } }, "modelType": { @@ -4496,22 +4502,16 @@ "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } - }, - "externalEventsDetail": { - "target": "com.amazonaws.frauddetector#ExternalEventsDetail", - "traits": { - "smithy.api#documentation": "

The event details.

" - } } } }, "com.amazonaws.frauddetector#UpdateModelVersionResult": { "type": "structure", "members": { - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { - "smithy.api#documentation": "

The model type.

" + "smithy.api#documentation": "

The model ID.

" } }, "status": { @@ -4520,10 +4520,10 @@ "smithy.api#documentation": "

The status of the updated model version.

" } }, - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { - "smithy.api#documentation": "

The model ID.

" + "smithy.api#documentation": "

The model type.

" } }, "modelVersionNumber": { @@ -4563,10 +4563,10 @@ "com.amazonaws.frauddetector#UpdateModelVersionStatusRequest": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.frauddetector#modelIdentifier", + "modelType": { + "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { - "smithy.api#documentation": "

The model ID of the model version to update.

", + "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, @@ -4577,17 +4577,17 @@ "smithy.api#required": {} } }, - "modelType": { - "target": "com.amazonaws.frauddetector#ModelTypeEnum", + "status": { + "target": "com.amazonaws.frauddetector#ModelVersionStatus", "traits": { - "smithy.api#documentation": "

The model type.

", + "smithy.api#documentation": "

The model version status.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.frauddetector#ModelVersionStatus", + "modelId": { + "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { - "smithy.api#documentation": "

The model version status.

", + "smithy.api#documentation": "

The model ID of the model version to update.

", "smithy.api#required": {} } } @@ -4629,17 +4629,17 @@ "com.amazonaws.frauddetector#UpdateRuleMetadataRequest": { "type": "structure", "members": { - "rule": { - "target": "com.amazonaws.frauddetector#Rule", + "description": { + "target": "com.amazonaws.frauddetector#description", "traits": { - "smithy.api#documentation": "

The rule to update.

", + "smithy.api#documentation": "

The rule description.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.frauddetector#description", + "rule": { + "target": "com.amazonaws.frauddetector#Rule", "traits": { - "smithy.api#documentation": "

The rule description.

", + "smithy.api#documentation": "

The rule to update.

", "smithy.api#required": {} } } @@ -4681,10 +4681,11 @@ "com.amazonaws.frauddetector#UpdateRuleVersionRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.frauddetector#tagList", + "outcomes": { + "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { - "smithy.api#documentation": "

The tags to assign to the rule version.

" + "smithy.api#documentation": "

The outcomes.

", + "smithy.api#required": {} } }, "language": { @@ -4694,17 +4695,16 @@ "smithy.api#required": {} } }, - "outcomes": { - "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", + "tags": { + "target": "com.amazonaws.frauddetector#tagList", "traits": { - "smithy.api#documentation": "

The outcomes.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to assign to the rule version.

" } }, - "expression": { - "target": "com.amazonaws.frauddetector#ruleExpression", + "rule": { + "target": "com.amazonaws.frauddetector#Rule", "traits": { - "smithy.api#documentation": "

The rule expression.

", + "smithy.api#documentation": "

The rule to update.

", "smithy.api#required": {} } }, @@ -4714,10 +4714,10 @@ "smithy.api#documentation": "

The description.

" } }, - "rule": { - "target": "com.amazonaws.frauddetector#Rule", + "expression": { + "target": "com.amazonaws.frauddetector#ruleExpression", "traits": { - "smithy.api#documentation": "

The rule to update.

", + "smithy.api#documentation": "

The rule expression.

", "smithy.api#required": {} } } @@ -4766,29 +4766,29 @@ "com.amazonaws.frauddetector#UpdateVariableRequest": { "type": "structure", "members": { - "variableType": { + "defaultValue": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The variable type. For more information see Variable types.

" + "smithy.api#documentation": "

The new default value of the variable.

" } }, - "description": { + "name": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The new description.

" + "smithy.api#documentation": "

The name of the variable.

", + "smithy.api#required": {} } }, - "name": { + "description": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The name of the variable.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The new description.

" } }, - "defaultValue": { + "variableType": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The new default value of the variable.

" + "smithy.api#documentation": "

The variable type. For more information see Variable types.

" } } } @@ -4822,18 +4822,6 @@ "com.amazonaws.frauddetector#Variable": { "type": "structure", "members": { - "defaultValue": { - "target": "com.amazonaws.frauddetector#string", - "traits": { - "smithy.api#documentation": "

The default value of the variable.

" - } - }, - "dataType": { - "target": "com.amazonaws.frauddetector#DataType", - "traits": { - "smithy.api#documentation": "

The data type of the variable. For more information see Variable types.

" - } - }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { @@ -4846,22 +4834,40 @@ "smithy.api#documentation": "

The data source of the variable.

" } }, + "variableType": { + "target": "com.amazonaws.frauddetector#string", + "traits": { + "smithy.api#documentation": "

The variable type of the variable.

\n

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT \n

" + } + }, + "defaultValue": { + "target": "com.amazonaws.frauddetector#string", + "traits": { + "smithy.api#documentation": "

The default value of the variable.

" + } + }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The time when variable was last updated.

" } }, + "dataType": { + "target": "com.amazonaws.frauddetector#DataType", + "traits": { + "smithy.api#documentation": "

The data type of the variable. For more information see Variable types.

" + } + }, "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable.

" } }, - "variableType": { + "description": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The variable type of the variable.

\n

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT | SHIPPING_ZIP | USERAGENT\n

" + "smithy.api#documentation": "

The description of the variable.

" } }, "createdTime": { @@ -4869,12 +4875,6 @@ "traits": { "smithy.api#documentation": "

The time when the variable was created.

" } - }, - "description": { - "target": "com.amazonaws.frauddetector#string", - "traits": { - "smithy.api#documentation": "

The description of the variable.

" - } } }, "traits": { @@ -4884,40 +4884,40 @@ "com.amazonaws.frauddetector#VariableEntry": { "type": "structure", "members": { - "name": { + "dataType": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The name of the variable.

" + "smithy.api#documentation": "

The data type of the variable.

" } }, - "description": { + "variableType": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The description of the variable.

" + "smithy.api#documentation": "

The type of the variable. For more information see Variable types.

\n

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT \n

" } }, - "dataSource": { + "description": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The data source of the variable.

" + "smithy.api#documentation": "

The description of the variable.

" } }, - "variableType": { + "defaultValue": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The type of the variable. For more information see Variable types.

\n

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT | SHIPPING_ZIP | USERAGENT\n

" + "smithy.api#documentation": "

The default value of the variable.

" } }, - "defaultValue": { + "name": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The default value of the variable.

" + "smithy.api#documentation": "

The name of the variable.

" } }, - "dataType": { + "dataSource": { "target": "com.amazonaws.frauddetector#string", "traits": { - "smithy.api#documentation": "

The data type of the variable.

" + "smithy.api#documentation": "

The data source of the variable.

" } } }, @@ -5237,7 +5237,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 256 + "max": 1024 }, "smithy.api#sensitive": {} } diff --git a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json index 4e8cc3771af0..cbaa4aaee4e6 100644 --- a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json +++ b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json @@ -92,7 +92,7 @@ "sdkId": "FSx", "arnNamespace": "fsx", "cloudFormationName": "FSx", - "cloudTrailEventSource": "v20180301.api.simba.amazonaws.com" + "cloudTrailEventSource": "fsx.amazonaws.com" }, "aws.auth#sigv4": { "name": "fsx" @@ -125,8 +125,11 @@ "com.amazonaws.fsx#ActiveDirectoryError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" + "Type": { + "target": "com.amazonaws.fsx#ActiveDirectoryErrorType", + "traits": { + "smithy.api#documentation": "

The type of Active Directory error.

" + } }, "ActiveDirectoryId": { "target": "com.amazonaws.fsx#DirectoryId", @@ -135,11 +138,8 @@ "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.fsx#ActiveDirectoryErrorType", - "traits": { - "smithy.api#documentation": "

The type of Active Directory error.

" - } + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" } }, "traits": { @@ -184,6 +184,15 @@ "com.amazonaws.fsx#AdministrativeAction": { "type": "structure", "members": { + "AdministrativeActionType": { + "target": "com.amazonaws.fsx#AdministrativeActionType" + }, + "Status": { + "target": "com.amazonaws.fsx#Status", + "traits": { + "smithy.api#documentation": "

Describes the status of the administrative action, as follows:

\n " + } + }, "RequestTime": { "target": "com.amazonaws.fsx#RequestTime", "traits": { @@ -204,15 +213,6 @@ }, "FailureDetails": { "target": "com.amazonaws.fsx#AdministrativeActionFailureDetails" - }, - "AdministrativeActionType": { - "target": "com.amazonaws.fsx#AdministrativeActionType" - }, - "Status": { - "target": "com.amazonaws.fsx#Status", - "traits": { - "smithy.api#documentation": "

Describes the status of the administrative action, as follows:

\n " - } } }, "traits": { @@ -294,49 +294,55 @@ "type": "integer", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this to 0 disables\n automatic backups. You can retain automatic backups for a maximum of 35 days. The default is 0.

", + "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this to 0 disables\n automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

", "smithy.api#range": { "min": 0, - "max": 35 + "max": 90 } } }, "com.amazonaws.fsx#Backup": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.fsx#CreationTime", + "FileSystem": { + "target": "com.amazonaws.fsx#FileSystem", "traits": { - "smithy.api#documentation": "

The time when a particular backup was created.

", + "smithy.api#documentation": "

Metadata of the file system associated with the backup. This metadata is persisted\n even if the file system is deleted.

", "smithy.api#required": {} } }, - "BackupId": { - "target": "com.amazonaws.fsx#BackupId", + "Lifecycle": { + "target": "com.amazonaws.fsx#BackupLifecycle", "traits": { - "smithy.api#documentation": "

The ID of the backup.

", + "smithy.api#documentation": "

The lifecycle status of the backup.

\n ", "smithy.api#required": {} } }, - "FailureDetails": { - "target": "com.amazonaws.fsx#BackupFailureDetails", + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", "traits": { - "smithy.api#documentation": "

Details explaining any failures that occur when creating a backup.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the backup resource.

" } }, - "ProgressPercent": { - "target": "com.amazonaws.fsx#ProgressPercent" + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the \n backup of the Amazon FSx file system's data at rest. \n

" + } }, - "Tags": { - "target": "com.amazonaws.fsx#Tags", + "DirectoryInformation": { + "target": "com.amazonaws.fsx#ActiveDirectoryBackupAttributes", "traits": { - "smithy.api#documentation": "

Tags associated with a particular file system.

" + "smithy.api#documentation": "

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

" } }, - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", + "ProgressPercent": { + "target": "com.amazonaws.fsx#ProgressPercent" + }, + "FailureDetails": { + "target": "com.amazonaws.fsx#BackupFailureDetails", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the backup resource.

" + "smithy.api#documentation": "

Details explaining any failures that occur when creating a backup.

" } }, "Type": { @@ -346,30 +352,24 @@ "smithy.api#required": {} } }, - "KmsKeyId": { - "target": "com.amazonaws.fsx#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this \n backup of the Amazon FSx for Windows file system's data at rest. \n Amazon FSx for Lustre does not support KMS encryption.

" - } - }, - "DirectoryInformation": { - "target": "com.amazonaws.fsx#ActiveDirectoryBackupAttributes", + "CreationTime": { + "target": "com.amazonaws.fsx#CreationTime", "traits": { - "smithy.api#documentation": "

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

" + "smithy.api#documentation": "

The time when a particular backup was created.

", + "smithy.api#required": {} } }, - "Lifecycle": { - "target": "com.amazonaws.fsx#BackupLifecycle", + "BackupId": { + "target": "com.amazonaws.fsx#BackupId", "traits": { - "smithy.api#documentation": "

The lifecycle status of the backup.

", + "smithy.api#documentation": "

The ID of the backup.

", "smithy.api#required": {} } }, - "FileSystem": { - "target": "com.amazonaws.fsx#FileSystem", + "Tags": { + "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "

Metadata of the file system associated with the backup. This metadata is persisted\n even if the file system is deleted.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Tags associated with a particular file system.

" } } }, @@ -430,7 +430,7 @@ "com.amazonaws.fsx#BackupLifecycle": { "type": "string", "traits": { - "smithy.api#documentation": "

The lifecycle status of the backup.

", + "smithy.api#documentation": "

The lifecycle status of the backup.

\n ", "smithy.api#enum": [ { "value": "AVAILABLE", @@ -440,6 +440,10 @@ "value": "CREATING", "name": "CREATING" }, + { + "value": "TRANSFERRING", + "name": "TRANSFERRING" + }, { "value": "DELETED", "name": "DELETED" @@ -598,6 +602,18 @@ "com.amazonaws.fsx#CompletionReport": { "type": "structure", "members": { + "Path": { + "target": "com.amazonaws.fsx#ArchivePath", + "traits": { + "smithy.api#documentation": "

Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The Path you provide must be located within the file system’s ExportPath. \n An example Path value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .\n

" + } + }, + "Format": { + "target": "com.amazonaws.fsx#ReportFormat", + "traits": { + "smithy.api#documentation": "

Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported.\n When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to\n {path}/task-{id}/failures.csv. \n

" + } + }, "Enabled": { "target": "com.amazonaws.fsx#Flag", "traits": { @@ -610,18 +626,6 @@ "traits": { "smithy.api#documentation": "

Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. \n When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.

" } - }, - "Path": { - "target": "com.amazonaws.fsx#ArchivePath", - "traits": { - "smithy.api#documentation": "

Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The Path you provide must be located within the file system’s ExportPath. \n An example Path value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .\n

" - } - }, - "Format": { - "target": "com.amazonaws.fsx#ReportFormat", - "traits": { - "smithy.api#documentation": "

Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported.\n When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to\n {path}/task-{id}/failures.csv. \n

" - } } }, "traits": { @@ -660,7 +664,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a backup of an existing Amazon FSx file system.\n Creating regular backups for your file system is a best practice, enabling you to restore a file system\n from a backup if an issue arises with the original file system.

\n

For Amazon FSx for Lustre file systems, you can create a backup only \n for file systems with the following configuration:

\n \n

For more information about backing up Amazon FSx for Lustre file systems, \n see Working with FSx for Lustre backups.

\n

For more information about backing up Amazon FSx for Lustre file systems, \n see Working with FSx for Windows backups.

\n\n

If a backup with the specified client request token exists, and the parameters\n match, this operation returns the description of the existing backup. If a backup\n specified client request token exists, and the parameters don't match, this\n operation returns IncompatibleParameterError. If a backup with the\n specified client request token doesn't exist, CreateBackup does the\n following:

\n \n\n

By using the idempotent operation, you can retry a CreateBackup\n operation without the risk of creating an extra backup. This approach can be useful when\n an initial call fails in a way that makes it unclear whether a backup was created. If\n you use the same client request token and the initial call created a backup, the\n operation returns a successful result because all the parameters are the same.

\n\n

The CreateBackup operation returns while the backup's\n lifecycle state is still CREATING. You can check the backup creation\n status by calling the DescribeBackups operation, which returns the\n backup state along with other information.

", + "smithy.api#documentation": "

Creates a backup of an existing Amazon FSx file system.\n Creating regular backups for your file system is a best practice, enabling you to restore a file system\n from a backup if an issue arises with the original file system.

\n

For Amazon FSx for Lustre file systems, you can create a backup only \n for file systems with the following configuration:

\n \n

For more information about backing up Amazon FSx for Lustre file systems, \n see Working with FSx for Lustre backups.

\n

For more information about backing up Amazon FSx for Lustre file systems, \n see Working with FSx for Windows backups.

\n\n

If a backup with the specified client request token exists, and the parameters\n match, this operation returns the description of the existing backup. If a backup\n specified client request token exists, and the parameters don't match, this\n operation returns IncompatibleParameterError. If a backup with the\n specified client request token doesn't exist, CreateBackup does the\n following:

\n \n\n

By using the idempotent operation, you can retry a CreateBackup\n operation without the risk of creating an extra backup. This approach can be useful when\n an initial call fails in a way that makes it unclear whether a backup was created. If\n you use the same client request token and the initial call created a backup, the\n operation returns a successful result because all the parameters are the same.

\n\n

The CreateBackup operation returns while the backup's\n lifecycle state is still CREATING. You can check the backup creation\n status by calling the DescribeBackups operation, which returns the\n backup state along with other information.

", "smithy.api#idempotent": {} } }, @@ -670,13 +674,13 @@ "Tags": { "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "

The tags to apply to the backup at backup creation. The key value of the\n Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and \n you specify one or more tags using the CreateBackup action, no existing tags on the file system are copied from the file system to the backup.

" + "smithy.api#documentation": "

(Optional) The tags to apply to the backup at backup creation. The key value of the\n Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and \n you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.

" } }, "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "smithy.api#documentation": "

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.

", "smithy.api#idempotencyToken": {} } }, @@ -745,38 +749,38 @@ "com.amazonaws.fsx#CreateDataRepositoryTaskRequest": { "type": "structure", "members": { - "FileSystemId": { - "target": "com.amazonaws.fsx#FileSystemId", + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#required": {} + "smithy.api#idempotencyToken": {} } }, - "Paths": { - "target": "com.amazonaws.fsx#DataRepositoryTaskPaths", + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", "traits": { - "smithy.api#documentation": "

(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. \n The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. \n If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or \n file on the file system you want to export, then the path to provide is path1.\n If a path that you provide isn't valid, the task fails.

" + "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.fsx#DataRepositoryTaskType", + "Report": { + "target": "com.amazonaws.fsx#CompletionReport", "traits": { - "smithy.api#documentation": "

Specifies the type of data repository task to create.

", + "smithy.api#documentation": "

Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. \n A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the \n Scope parameter. For more information, see \n Working with Task Completion Reports.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.fsx#Tags" }, - "ClientRequestToken": { - "target": "com.amazonaws.fsx#ClientRequestToken", + "Paths": { + "target": "com.amazonaws.fsx#DataRepositoryTaskPaths", "traits": { - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. \n The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. \n If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or \n file on the file system you want to export, then the path to provide is path1.\n If a path that you provide isn't valid, the task fails.

" } }, - "Report": { - "target": "com.amazonaws.fsx#CompletionReport", + "Type": { + "target": "com.amazonaws.fsx#DataRepositoryTaskType", "traits": { - "smithy.api#documentation": "

Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. \n A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the \n Scope parameter. For more information, see \n Working with Task Completion Reports.

", + "smithy.api#documentation": "

Specifies the type of data repository task to create.

", "smithy.api#required": {} } } @@ -881,19 +885,6 @@ "com.amazonaws.fsx#CreateFileSystemFromBackupRequest": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.fsx#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.

", - "smithy.api#idempotencyToken": {} - } - }, - "Tags": { - "target": "com.amazonaws.fsx#Tags", - "traits": { - "smithy.api#documentation": "

The tags to be applied to the file system at file system creation. The key value of\n the Name tag appears in the console as the file system\n name.

" - } - }, "SubnetIds": { "target": "com.amazonaws.fsx#SubnetIds", "traits": { @@ -901,15 +892,15 @@ "smithy.api#required": {} } }, - "LustreConfiguration": { - "target": "com.amazonaws.fsx#CreateFileSystemLustreConfiguration" - }, "BackupId": { "target": "com.amazonaws.fsx#BackupId", "traits": { "smithy.api#required": {} } }, + "LustreConfiguration": { + "target": "com.amazonaws.fsx#CreateFileSystemLustreConfiguration" + }, "WindowsConfiguration": { "target": "com.amazonaws.fsx#CreateFileSystemWindowsConfiguration", "traits": { @@ -927,6 +918,19 @@ "traits": { "smithy.api#documentation": "

Sets the storage type for the Windows file system you're creating from a backup. \n Valid values are SSD and HDD.

\n \n

\n Default value is SSD. \n

\n \n

HDD and SSD storage types have different minimum storage capacity requirements. \n A restored file system's storage capacity is tied to the file system that was backed up. \n You can create a file system that uses HDD storage from a backup of a file system that \n used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB. \n

\n " } + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.fsx#Tags", + "traits": { + "smithy.api#documentation": "

The tags to be applied to the file system at file system creation. The key value of\n the Name tag appears in the console as the file system\n name.

" + } } }, "traits": { @@ -950,58 +954,64 @@ "com.amazonaws.fsx#CreateFileSystemLustreConfiguration": { "type": "structure", "members": { - "DeploymentType": { - "target": "com.amazonaws.fsx#LustreDeploymentType", + "ImportPath": { + "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "

\n Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.

\n \n

Choose PERSISTENT_1 deployment type for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options.

\n

Encryption of data in-transit is automatically \n enabled when you access a SCRATCH_2 or PERSISTENT_1\n file system from Amazon EC2 instances that support this feature.\n (Default = SCRATCH_1)\n

\n \n

Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 \n deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, \n Encrypting Data in Transit.

" + "smithy.api#documentation": "

(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.

" } }, - "ImportedFileChunkSize": { - "target": "com.amazonaws.fsx#Megabytes", + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime", "traits": { - "smithy.api#documentation": "

(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.

\n \n

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.

" + "smithy.api#documentation": "

(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" } }, - "CopyTagsToBackups": { - "target": "com.amazonaws.fsx#Flag", + "DriveCacheType": { + "target": "com.amazonaws.fsx#DriveCacheType", "traits": { - "smithy.api#documentation": "

A boolean flag indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true, all tags for the file\n system are copied to all automatic and user-initiated backups where the user\n doesn't specify tags. If this value is true, and you specify one or more tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.

\n

For more information, see Working with backups.

" + "smithy.api#documentation": "

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set to\n READ, improve the performance for frequently accessed files and allows 20%\n of the total storage capacity of the file system to be cached.

\n

This parameter is required when StorageType is set to HDD.

" } }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime" - }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + "AutoImportPolicy": { + "target": "com.amazonaws.fsx#AutoImportPolicyType", + "traits": { + "smithy.api#documentation": "

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:

\n \n \n \n \n

For more information, see Automatically import updates from your S3 bucket.

" + } }, - "ExportPath": { - "target": "com.amazonaws.fsx#ArchivePath", + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. \n The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which\n new and changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z.

\n\n

The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath. If you only specify a bucket name, such as\n s3://import-bucket, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.

" + "smithy.api#documentation": "

(Optional) Not available to use with file systems that are linked to a data repository. \n A boolean flag indicating whether tags for the file system should be copied to\n backups. The default value is false. If it's set to true, all file system\n tags are copied to all automatic and user-initiated backups when the user\n doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.

\n

For more information, see Working with backups.

" } }, - "PerUnitStorageThroughput": { - "target": "com.amazonaws.fsx#PerUnitStorageThroughput", + "DeploymentType": { + "target": "com.amazonaws.fsx#LustreDeploymentType", "traits": { - "smithy.api#documentation": "

\n Required for the PERSISTENT_1 deployment type, describes the amount of read and write \n throughput for each 1 tebibyte of storage, in MB/s/TiB. \n File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput\n (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput\n yields 117 MB/s of file system throughput. You pay for the amount of throughput that you\n provision.\n

\n

Valid values are 50, 100, 200.

" + "smithy.api#documentation": "

\n Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.

\n \n

Choose PERSISTENT_1 deployment type for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options.

\n

Encryption of data in-transit is automatically \n enabled when you access a SCRATCH_2 or PERSISTENT_1\n file system from Amazon EC2 instances that support this feature.\n (Default = SCRATCH_1)\n

\n

Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 \n deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, \n Encrypting Data in Transit.

" } }, - "ImportPath": { - "target": "com.amazonaws.fsx#ArchivePath", + "ImportedFileChunkSize": { + "target": "com.amazonaws.fsx#Megabytes", "traits": { - "smithy.api#documentation": "

(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.

" + "smithy.api#documentation": "

(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.

\n \n

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.

" } }, - "WeeklyMaintenanceStartTime": { - "target": "com.amazonaws.fsx#WeeklyTime", + "PerUnitStorageThroughput": { + "target": "com.amazonaws.fsx#PerUnitStorageThroughput", "traits": { - "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" + "smithy.api#documentation": "

\n Required for the PERSISTENT_1 deployment type, describes the amount of read and write \n throughput for each 1 tebibyte of storage, in MB/s/TiB. \n File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput\n (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput\n yields 120 MB/s of file system throughput. You pay for the amount of throughput that you\n provision.\n

\n

Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.

" } }, - "AutoImportPolicy": { - "target": "com.amazonaws.fsx#AutoImportPolicyType", + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + }, + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime" + }, + "ExportPath": { + "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "

(Optional) Use this property to configure the AutoImport feature on the \n file system's linked Amazon S3 data repository. You use\n AutoImport to update the contents of your FSx for Lustre file system automatically \n with changes that occur in the linked S3 data repository. AutoImportPolicy can\n have the following values:

\n \n

For more information, see Automatically import updates from your S3 bucket.

" + "smithy.api#documentation": "

(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. \n The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which\n new and changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z.

\n\n

The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath. If you only specify a bucket name, such as\n s3://import-bucket, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.

" } } }, @@ -1012,11 +1022,8 @@ "com.amazonaws.fsx#CreateFileSystemRequest": { "type": "structure", "members": { - "WindowsConfiguration": { - "target": "com.amazonaws.fsx#CreateFileSystemWindowsConfiguration", - "traits": { - "smithy.api#documentation": "

The Microsoft Windows configuration for the file system being created. \n

" - } + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId" }, "SubnetIds": { "target": "com.amazonaws.fsx#SubnetIds", @@ -1025,22 +1032,18 @@ "smithy.api#required": {} } }, - "SecurityGroupIds": { - "target": "com.amazonaws.fsx#SecurityGroupIds", + "Tags": { + "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "

A list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.

" + "smithy.api#documentation": "

The tags to apply to the file system being created. The key value of\n the Name tag appears in the console as the file system name.

" } }, - "ClientRequestToken": { - "target": "com.amazonaws.fsx#ClientRequestToken", + "WindowsConfiguration": { + "target": "com.amazonaws.fsx#CreateFileSystemWindowsConfiguration", "traits": { - "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The Microsoft Windows configuration for the file system being created. \n

" } }, - "LustreConfiguration": { - "target": "com.amazonaws.fsx#CreateFileSystemLustreConfiguration" - }, "FileSystemType": { "target": "com.amazonaws.fsx#FileSystemType", "traits": { @@ -1051,23 +1054,30 @@ "StorageCapacity": { "target": "com.amazonaws.fsx#StorageCapacity", "traits": { - "smithy.api#documentation": "

Sets the storage capacity of the file system that you're creating.

\n

For Lustre file systems:

\n \n

For Windows file systems:

\n ", + "smithy.api#documentation": "

Sets the storage capacity of the file system that you're creating.

\n

For Lustre file systems:

\n \n

For Windows file systems:

\n ", "smithy.api#required": {} } }, - "KmsKeyId": { - "target": "com.amazonaws.fsx#KmsKeyId" + "SecurityGroupIds": { + "target": "com.amazonaws.fsx#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.

" + } }, "StorageType": { "target": "com.amazonaws.fsx#StorageType", "traits": { - "smithy.api#documentation": "

Sets the storage type for the Amazon FSx for Windows file system you're creating. \n Valid values are SSD and HDD.

\n \n

\n Default value is SSD. For more information, see \n \n Storage Type Options in the Amazon FSx for Windows User Guide.\n

" + "smithy.api#documentation": "

Sets the storage type for the file system you're creating. \n Valid values are SSD and HDD.

\n \n

\n Default value is SSD. For more information, see \n \n Storage Type Options in the Amazon FSx for Windows User Guide and \n Multiple Storage Options \n in the Amazon FSx for Lustre User Guide.\n

" } }, - "Tags": { - "target": "com.amazonaws.fsx#Tags", + "LustreConfiguration": { + "target": "com.amazonaws.fsx#CreateFileSystemLustreConfiguration" + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The tags to apply to the file system being created. The key value of\n the Name tag appears in the console as the file system name.

" + "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "smithy.api#idempotencyToken": {} } } }, @@ -1092,23 +1102,16 @@ "com.amazonaws.fsx#CreateFileSystemWindowsConfiguration": { "type": "structure", "members": { - "ThroughputCapacity": { - "target": "com.amazonaws.fsx#MegabytesPerSecond", - "traits": { - "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to\n the nth increments, between 2^3 (8) and 2^11 (2048).

", - "smithy.api#required": {} - } - }, - "ActiveDirectoryId": { - "target": "com.amazonaws.fsx#DirectoryId", + "PreferredSubnetId": { + "target": "com.amazonaws.fsx#SubnetId", "traits": { - "smithy.api#documentation": "

The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the\n file system should join when it's created.

" + "smithy.api#documentation": "

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet \n in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch \n your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ \n data transfer costs and minimize latency.

" } }, - "CopyTagsToBackups": { - "target": "com.amazonaws.fsx#Flag", + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", "traits": { - "smithy.api#documentation": "

A boolean flag indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true, all tags for the file\n system are copied to all automatic and user-initiated backups where the user\n doesn't specify tags. If this value is true, and you specify one or more tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.

" + "smithy.api#documentation": "

The number of days to retain automatic backups. The default is to retain backups for 7\n days. Setting this value to 0 disables the creation of automatic backups. The maximum\n retention period for backups is 90 days.

" } }, "DailyAutomaticBackupStartTime": { @@ -1123,16 +1126,10 @@ "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" } }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", - "traits": { - "smithy.api#documentation": "

The number of days to retain automatic backups. The default is to retain backups for 7\n days. Setting this value to 0 disables the creation of automatic backups. The maximum\n retention period for backups is 35 days.

" - } - }, - "PreferredSubnetId": { - "target": "com.amazonaws.fsx#SubnetId", + "ActiveDirectoryId": { + "target": "com.amazonaws.fsx#DirectoryId", "traits": { - "smithy.api#documentation": "

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet \n in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch \n your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ \n data transfer costs and minimize latency.

" + "smithy.api#documentation": "

The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the\n file system should join when it's created.

" } }, "SelfManagedActiveDirectoryConfiguration": { @@ -1143,6 +1140,19 @@ "traits": { "smithy.api#documentation": "

Specifies the file system deployment type, valid values are the following:

\n \n

For more information, see \n \n Availability and Durability: Single-AZ and Multi-AZ File Systems.

" } + }, + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "

A boolean flag indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true, all tags for the file\n system are copied to all automatic and user-initiated backups where the user\n doesn't specify tags. If this value is true, and you specify one or more tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.

" + } + }, + "ThroughputCapacity": { + "target": "com.amazonaws.fsx#MegabytesPerSecond", + "traits": { + "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to\n the nth increments, between 2^3 (8) and 2^11 (2048).

", + "smithy.api#required": {} + } } }, "traits": { @@ -1180,37 +1190,37 @@ "com.amazonaws.fsx#DataRepositoryConfiguration": { "type": "structure", "members": { - "AutoImportPolicy": { - "target": "com.amazonaws.fsx#AutoImportPolicyType", + "Lifecycle": { + "target": "com.amazonaws.fsx#DataRepositoryLifecycle", "traits": { - "smithy.api#documentation": "

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how your FSx\n for Lustre file system automatically updates its contents \n with changes that occur in the linked S3 data repository. AutoImportPolicy can have the following values:

\n \n

For more information, see Automatically import updates from your S3 bucket.

" + "smithy.api#documentation": "

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. \n The lifecycle can have the following values:

\n " } }, - "FailureDetails": { - "target": "com.amazonaws.fsx#DataRepositoryFailureDetails" - }, - "ImportedFileChunkSize": { - "target": "com.amazonaws.fsx#Megabytes", + "ImportPath": { + "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "

For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.

\n\n

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.

" + "smithy.api#documentation": "

The import path to the Amazon S3 bucket (and optional prefix) that you're using\n as the data repository for your FSx for Lustre file system, for example\n s3://import-bucket/optional-prefix. If a prefix is specified after the\n Amazon S3 bucket name, only object keys with that prefix are loaded into the file\n system.

" } }, + "FailureDetails": { + "target": "com.amazonaws.fsx#DataRepositoryFailureDetails" + }, "ExportPath": { "target": "com.amazonaws.fsx#ArchivePath", "traits": { "smithy.api#documentation": "

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and\n changed Lustre file system files in S3.

" } }, - "ImportPath": { - "target": "com.amazonaws.fsx#ArchivePath", + "AutoImportPolicy": { + "target": "com.amazonaws.fsx#AutoImportPolicyType", "traits": { - "smithy.api#documentation": "

The import path to the Amazon S3 bucket (and optional prefix) that you're using\n as the data repository for your FSx for Lustre file system, for example\n s3://import-bucket/optional-prefix. If a prefix is specified after the\n Amazon S3 bucket name, only object keys with that prefix are loaded into the file\n system.

" + "smithy.api#documentation": "

Describes the file system's linked S3 data repository's AutoImportPolicy. \n The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

\n \n

For more information, see Automatically import updates from your S3 bucket.

" } }, - "Lifecycle": { - "target": "com.amazonaws.fsx#DataRepositoryLifecycle", + "ImportedFileChunkSize": { + "target": "com.amazonaws.fsx#Megabytes", "traits": { - "smithy.api#documentation": "

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. \n The lifecycle can have the following values:

\n " + "smithy.api#documentation": "

For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.

\n\n

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.

" } } }, @@ -1259,33 +1269,14 @@ "com.amazonaws.fsx#DataRepositoryTask": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN" - }, - "Type": { - "target": "com.amazonaws.fsx#DataRepositoryTaskType", - "traits": { - "smithy.api#documentation": "

The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.fsx#Tags" - }, - "Report": { - "target": "com.amazonaws.fsx#CompletionReport" - }, "FailureDetails": { "target": "com.amazonaws.fsx#DataRepositoryTaskFailureDetails", "traits": { "smithy.api#documentation": "

Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

" } }, - "FileSystemId": { - "target": "com.amazonaws.fsx#FileSystemId", - "traits": { - "smithy.api#required": {} - } + "Report": { + "target": "com.amazonaws.fsx#CompletionReport" }, "Status": { "target": "com.amazonaws.fsx#DataRepositoryTaskStatus", @@ -1293,42 +1284,61 @@ "smithy.api#documentation": "

Provides the status of the number of files that the task has processed successfully and failed to process.

" } }, - "TaskId": { - "target": "com.amazonaws.fsx#TaskId", + "Lifecycle": { + "target": "com.amazonaws.fsx#DataRepositoryTaskLifecycle", "traits": { - "smithy.api#documentation": "

The system-generated, unique 17-digit ID of the data repository task.

", + "smithy.api#documentation": "

The lifecycle status of the data repository task, as follows:

\n \n \n

You cannot delete an FSx for Lustre file system if there are data \n repository tasks for the file system in the PENDING or EXECUTING states.\n Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). \n You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.

\n ", "smithy.api#required": {} } }, + "StartTime": { + "target": "com.amazonaws.fsx#StartTime", + "traits": { + "smithy.api#documentation": "

The time that Amazon FSx began processing the task.

" + } + }, "EndTime": { "target": "com.amazonaws.fsx#EndTime", "traits": { "smithy.api#documentation": "

The time that Amazon FSx completed processing the task, populated after the task is complete.

" } }, + "Tags": { + "target": "com.amazonaws.fsx#Tags" + }, + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN" + }, + "Type": { + "target": "com.amazonaws.fsx#DataRepositoryTaskType", + "traits": { + "smithy.api#documentation": "

The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.

", + "smithy.api#required": {} + } + }, "Paths": { "target": "com.amazonaws.fsx#DataRepositoryTaskPaths", "traits": { "smithy.api#documentation": "

An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to process. \n For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.

\n

(Default) If Paths is not specified, Amazon FSx uses the file system root directory.

" } }, - "CreationTime": { - "target": "com.amazonaws.fsx#CreationTime", + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", "traits": { "smithy.api#required": {} } }, - "Lifecycle": { - "target": "com.amazonaws.fsx#DataRepositoryTaskLifecycle", + "TaskId": { + "target": "com.amazonaws.fsx#TaskId", "traits": { - "smithy.api#documentation": "

The lifecycle status of the data repository task, as follows:

\n \n \n

You cannot delete an FSx for Lustre file system if there are data \n repository tasks for the file system in the PENDING or EXECUTING states.\n Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). \n You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.

\n ", + "smithy.api#documentation": "

The system-generated, unique 17-digit ID of the data repository task.

", "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.fsx#StartTime", + "CreationTime": { + "target": "com.amazonaws.fsx#CreationTime", "traits": { - "smithy.api#documentation": "

The time that Amazon FSx began processing the task.

" + "smithy.api#required": {} } } }, @@ -1374,17 +1384,17 @@ "com.amazonaws.fsx#DataRepositoryTaskFilter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.fsx#DataRepositoryTaskFilterValues", - "traits": { - "smithy.api#documentation": "

Use Values to include the specific file system IDs and task \n lifecycle states for the filters you are using.

" - } - }, "Name": { "target": "com.amazonaws.fsx#DataRepositoryTaskFilterName", "traits": { "smithy.api#documentation": "

Name of the task property to use in filtering the tasks returned in the response.

\n " } + }, + "Values": { + "target": "com.amazonaws.fsx#DataRepositoryTaskFilterValues", + "traits": { + "smithy.api#documentation": "

Use Values to include the specific file system IDs and task \n lifecycle states for the filters you are using.

" + } } }, "traits": { @@ -1508,16 +1518,10 @@ "com.amazonaws.fsx#DataRepositoryTaskStatus": { "type": "structure", "members": { - "FailedCount": { - "target": "com.amazonaws.fsx#FailedCount", - "traits": { - "smithy.api#documentation": "

A running total of the number of files that the task failed to process.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.fsx#LastUpdatedTime", + "TotalCount": { + "target": "com.amazonaws.fsx#TotalCount", "traits": { - "smithy.api#documentation": "

The time at which the task status was last updated.

" + "smithy.api#documentation": "

The total number of files that the task will process. While a task is executing, the sum of \n SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, \n TotalCount equals the sum of SucceededCount plus FailedCount.

" } }, "SucceededCount": { @@ -1526,10 +1530,16 @@ "smithy.api#documentation": "

A running total of the number of files that the task has successfully processed.

" } }, - "TotalCount": { - "target": "com.amazonaws.fsx#TotalCount", + "FailedCount": { + "target": "com.amazonaws.fsx#FailedCount", "traits": { - "smithy.api#documentation": "

The total number of files that the task will process. While a task is executing, the sum of \n SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, \n TotalCount equals the sum of SucceededCount plus FailedCount.

" + "smithy.api#documentation": "

A running total of the number of files that the task failed to process.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.fsx#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "

The time at which the task status was last updated.

" } } }, @@ -1596,19 +1606,19 @@ "com.amazonaws.fsx#DeleteBackupRequest": { "type": "structure", "members": { - "BackupId": { - "target": "com.amazonaws.fsx#BackupId", - "traits": { - "smithy.api#documentation": "

The ID of the backup you want to delete.

", - "smithy.api#required": {} - } - }, "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This is automatically filled on your behalf when using the AWS CLI\n or SDK.

", "smithy.api#idempotencyToken": {} } + }, + "BackupId": { + "target": "com.amazonaws.fsx#BackupId", + "traits": { + "smithy.api#documentation": "

The ID of the backup you want to delete.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1618,17 +1628,17 @@ "com.amazonaws.fsx#DeleteBackupResponse": { "type": "structure", "members": { - "Lifecycle": { - "target": "com.amazonaws.fsx#BackupLifecycle", - "traits": { - "smithy.api#documentation": "

The lifecycle of the backup. Should be DELETED.

" - } - }, "BackupId": { "target": "com.amazonaws.fsx#BackupId", "traits": { "smithy.api#documentation": "

The ID of the backup deleted.

" } + }, + "Lifecycle": { + "target": "com.amazonaws.fsx#BackupLifecycle", + "traits": { + "smithy.api#documentation": "

The lifecycle of the backup. Should be DELETED.

" + } } }, "traits": { @@ -1668,17 +1678,17 @@ "com.amazonaws.fsx#DeleteFileSystemLustreConfiguration": { "type": "structure", "members": { - "SkipFinalBackup": { - "target": "com.amazonaws.fsx#Flag", - "traits": { - "smithy.api#documentation": "

Set SkipFinalBackup to false if you want to take a final backup of the file \n system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the\n DeleteFileSystem operation is invoked. (Default = true)

" - } - }, "FinalBackupTags": { "target": "com.amazonaws.fsx#Tags", "traits": { "smithy.api#documentation": "

Use if SkipFinalBackup is set to false, \n and you want to apply an array of tags to the final backup. If you have set the file system property\n CopyTagsToBackups to true, and \n you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.

" } + }, + "SkipFinalBackup": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "

Set SkipFinalBackup to false if you want to take a final backup of the file \n system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the\n DeleteFileSystem operation is invoked. (Default = true)

" + } } }, "traits": { @@ -1688,17 +1698,17 @@ "com.amazonaws.fsx#DeleteFileSystemLustreResponse": { "type": "structure", "members": { - "FinalBackupId": { - "target": "com.amazonaws.fsx#BackupId", - "traits": { - "smithy.api#documentation": "

The ID of the final backup for this file system.

" - } - }, "FinalBackupTags": { "target": "com.amazonaws.fsx#Tags", "traits": { "smithy.api#documentation": "

The set of tags applied to the final backup.

" } + }, + "FinalBackupId": { + "target": "com.amazonaws.fsx#BackupId", + "traits": { + "smithy.api#documentation": "

The ID of the final backup for this file system.

" + } } }, "traits": { @@ -1708,6 +1718,9 @@ "com.amazonaws.fsx#DeleteFileSystemRequest": { "type": "structure", "members": { + "LustreConfiguration": { + "target": "com.amazonaws.fsx#DeleteFileSystemLustreConfiguration" + }, "WindowsConfiguration": { "target": "com.amazonaws.fsx#DeleteFileSystemWindowsConfiguration" }, @@ -1724,9 +1737,6 @@ "smithy.api#documentation": "

The ID of the file system you want to delete.

", "smithy.api#required": {} } - }, - "LustreConfiguration": { - "target": "com.amazonaws.fsx#DeleteFileSystemLustreConfiguration" } }, "traits": { @@ -1736,23 +1746,23 @@ "com.amazonaws.fsx#DeleteFileSystemResponse": { "type": "structure", "members": { - "FileSystemId": { - "target": "com.amazonaws.fsx#FileSystemId", - "traits": { - "smithy.api#documentation": "

The ID of the file system being deleted.

" - } - }, "Lifecycle": { "target": "com.amazonaws.fsx#FileSystemLifecycle", "traits": { "smithy.api#documentation": "

The file system lifecycle for the deletion request. Should be\n DELETING.

" } }, - "WindowsResponse": { - "target": "com.amazonaws.fsx#DeleteFileSystemWindowsResponse" + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", + "traits": { + "smithy.api#documentation": "

The ID of the file system being deleted.

" + } }, "LustreResponse": { "target": "com.amazonaws.fsx#DeleteFileSystemLustreResponse" + }, + "WindowsResponse": { + "target": "com.amazonaws.fsx#DeleteFileSystemWindowsResponse" } }, "traits": { @@ -1782,17 +1792,17 @@ "com.amazonaws.fsx#DeleteFileSystemWindowsResponse": { "type": "structure", "members": { - "FinalBackupTags": { - "target": "com.amazonaws.fsx#Tags", - "traits": { - "smithy.api#documentation": "

The set of tags applied to the final backup.

" - } - }, "FinalBackupId": { "target": "com.amazonaws.fsx#BackupId", "traits": { "smithy.api#documentation": "

The ID of the final backup for this file system.

" } + }, + "FinalBackupTags": { + "target": "com.amazonaws.fsx#Tags", + "traits": { + "smithy.api#documentation": "

The set of tags applied to the final backup.

" + } } }, "traits": { @@ -1832,19 +1842,7 @@ }, "com.amazonaws.fsx#DescribeBackupsRequest": { "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.fsx#NextToken", - "traits": { - "smithy.api#documentation": "

Opaque pagination token returned from a previous\n DescribeBackups operation (String). If a token present, the action\n continues the list from where the returning call left off.

" - } - }, - "Filters": { - "target": "com.amazonaws.fsx#Filters", - "traits": { - "smithy.api#documentation": "

Filters structure. Supported names are file-system-id and\n backup-type.

" - } - }, + "members": { "BackupIds": { "target": "com.amazonaws.fsx#BackupIds", "traits": { @@ -1856,6 +1854,18 @@ "traits": { "smithy.api#documentation": "

Maximum number of backups to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults parameter specified in the request and the\n service's internal maximum number of items per page.

" } + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken", + "traits": { + "smithy.api#documentation": "

Opaque pagination token returned from a previous\n DescribeBackups operation (String). If a token present, the action\n continues the list from where the returning call left off.

" + } + }, + "Filters": { + "target": "com.amazonaws.fsx#Filters", + "traits": { + "smithy.api#documentation": "

Filters structure. Supported names are file-system-id and\n backup-type.

" + } } }, "traits": { @@ -1865,17 +1875,17 @@ "com.amazonaws.fsx#DescribeBackupsResponse": { "type": "structure", "members": { - "Backups": { - "target": "com.amazonaws.fsx#Backups", - "traits": { - "smithy.api#documentation": "

Any array of backups.

" - } - }, "NextToken": { "target": "com.amazonaws.fsx#NextToken", "traits": { "smithy.api#documentation": "

This is present if there are more backups than returned in the response (String).\n You can use the NextToken value in the later request to fetch the backups.\n

" } + }, + "Backups": { + "target": "com.amazonaws.fsx#Backups", + "traits": { + "smithy.api#documentation": "

Any array of backups.

" + } } }, "traits": { @@ -1916,8 +1926,11 @@ "com.amazonaws.fsx#DescribeDataRepositoryTasksRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.fsx#NextToken" + "TaskIds": { + "target": "com.amazonaws.fsx#TaskIds", + "traits": { + "smithy.api#documentation": "

(Optional) IDs of the tasks whose descriptions you want to retrieve\n (String).

" + } }, "Filters": { "target": "com.amazonaws.fsx#DataRepositoryTaskFilters", @@ -1928,11 +1941,8 @@ "MaxResults": { "target": "com.amazonaws.fsx#MaxResults" }, - "TaskIds": { - "target": "com.amazonaws.fsx#TaskIds", - "traits": { - "smithy.api#documentation": "

(Optional) IDs of the tasks whose descriptions you want to retrieve\n (String).

" - } + "NextToken": { + "target": "com.amazonaws.fsx#NextToken" } } }, @@ -1981,10 +1991,10 @@ "com.amazonaws.fsx#DescribeFileSystemsRequest": { "type": "structure", "members": { - "FileSystemIds": { - "target": "com.amazonaws.fsx#FileSystemIds", + "NextToken": { + "target": "com.amazonaws.fsx#NextToken", "traits": { - "smithy.api#documentation": "

IDs of the file systems whose descriptions you want to retrieve\n (String).

" + "smithy.api#documentation": "

Opaque pagination token returned from a previous\n DescribeFileSystems operation (String). If a token present, the action\n continues the list from where the returning call left off.

" } }, "MaxResults": { @@ -1993,10 +2003,10 @@ "smithy.api#documentation": "

Maximum number of file systems to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults parameter specified in the request and the\n service's internal maximum number of items per page.

" } }, - "NextToken": { - "target": "com.amazonaws.fsx#NextToken", + "FileSystemIds": { + "target": "com.amazonaws.fsx#FileSystemIds", "traits": { - "smithy.api#documentation": "

Opaque pagination token returned from a previous\n DescribeFileSystems operation (String). If a token present, the action\n continues the list from where the returning call left off.

" + "smithy.api#documentation": "

IDs of the file systems whose descriptions you want to retrieve\n (String).

" } } }, @@ -2007,17 +2017,17 @@ "com.amazonaws.fsx#DescribeFileSystemsResponse": { "type": "structure", "members": { - "FileSystems": { - "target": "com.amazonaws.fsx#FileSystems", - "traits": { - "smithy.api#documentation": "

An array of file system descriptions.

" - } - }, "NextToken": { "target": "com.amazonaws.fsx#NextToken", "traits": { "smithy.api#documentation": "

Present if there are more file systems than returned in the response (String). You\n can use the NextToken value in the later request to fetch the\n descriptions.

" } + }, + "FileSystems": { + "target": "com.amazonaws.fsx#FileSystems", + "traits": { + "smithy.api#documentation": "

An array of file system descriptions.

" + } } }, "traits": { @@ -2067,6 +2077,21 @@ } } }, + "com.amazonaws.fsx#DriveCacheType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "READ", + "name": "READ" + } + ] + } + }, "com.amazonaws.fsx#EndTime": { "type": "timestamp" }, @@ -2089,25 +2114,34 @@ "com.amazonaws.fsx#FileSystem": { "type": "structure", "members": { - "FailureDetails": { - "target": "com.amazonaws.fsx#FileSystemFailureDetails" + "CreationTime": { + "target": "com.amazonaws.fsx#CreationTime", + "traits": { + "smithy.api#documentation": "

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z),\n also known as Unix time.

" + } }, - "StorageCapacity": { - "target": "com.amazonaws.fsx#StorageCapacity", + "WindowsConfiguration": { + "target": "com.amazonaws.fsx#WindowsFileSystemConfiguration", "traits": { - "smithy.api#documentation": "

The storage capacity of the file system in gigabytes (GB).

" + "smithy.api#documentation": "

The configuration for this Microsoft Windows file system.

" } }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.fsx#NetworkInterfaceIds", + "DNSName": { + "target": "com.amazonaws.fsx#DNSName", "traits": { - "smithy.api#documentation": "

The IDs of the elastic network interface from which a specific file system is\n accessible. The elastic network interface is automatically created in the same VPC that\n the Amazon FSx file system was created in. For more information, see Elastic Network\n Interfaces in the Amazon EC2 User Guide.\n

\n\n

For an Amazon FSx for Windows File Server file system, you can have one network\n interface ID. For an Amazon FSx for Lustre file system, you can have more than\n one.

" + "smithy.api#documentation": "

The DNS name for the file system.

" } }, - "FileSystemId": { - "target": "com.amazonaws.fsx#FileSystemId", + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", "traits": { - "smithy.api#documentation": "

The system-generated, unique 17-digit ID of the file system.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the file system resource.

" + } + }, + "FileSystemType": { + "target": "com.amazonaws.fsx#FileSystemType", + "traits": { + "smithy.api#documentation": "

The type of Amazon FSx file system, either LUSTRE or WINDOWS.

" } }, "SubnetIds": { @@ -2116,37 +2150,40 @@ "smithy.api#documentation": "

Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 \n file system deployment type, there are two subnet IDs, one for the preferred file server \n and one for the standby file server. The preferred file server subnet identified in the \n PreferredSubnetID property. All other file systems have only one subnet ID.

\n

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of \n the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems,\n the endpoint for the file system is available in the PreferredSubnetID.

" } }, - "AdministrativeActions": { - "target": "com.amazonaws.fsx#AdministrativeActions", + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId", "traits": { - "smithy.api#documentation": "

A list of administrative actions for the file system that are in process or waiting to be processed. \n Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.\n

" + "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data\n for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file\n systems at rest. In either case, if not specified, the Amazon FSx managed key\n is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using\n Amazon FSx managed keys. For more information, see Encrypt\n in the AWS Key Management Service API Reference.

" } }, - "DNSName": { - "target": "com.amazonaws.fsx#DNSName", + "Lifecycle": { + "target": "com.amazonaws.fsx#FileSystemLifecycle", "traits": { - "smithy.api#documentation": "

The DNS name for the file system.

" + "smithy.api#documentation": "

The lifecycle status of the file system, following are the possible values and what they mean:

\n " } }, - "LustreConfiguration": { - "target": "com.amazonaws.fsx#LustreFileSystemConfiguration" - }, - "StorageType": { - "target": "com.amazonaws.fsx#StorageType", + "NetworkInterfaceIds": { + "target": "com.amazonaws.fsx#NetworkInterfaceIds", "traits": { - "smithy.api#documentation": "

The storage type of the file system. \n Valid values are SSD and HDD.\n If set to SSD, the file system uses solid state drive storage. \n If set to HDD, the file system uses hard disk drive storage.\n

" + "smithy.api#documentation": "

The IDs of the elastic network interface from which a specific file system is\n accessible. The elastic network interface is automatically created in the same VPC that\n the Amazon FSx file system was created in. For more information, see Elastic Network\n Interfaces in the Amazon EC2 User Guide.\n

\n\n

For an Amazon FSx for Windows File Server file system, you can have one network\n interface ID. For an Amazon FSx for Lustre file system, you can have more than\n one.

" } }, - "Tags": { - "target": "com.amazonaws.fsx#Tags", + "VpcId": { + "target": "com.amazonaws.fsx#VpcId", "traits": { - "smithy.api#documentation": "

The tags to associate with the file system. For more information, see Tagging Your\n Amazon EC2 Resources in the Amazon EC2 User\n Guide.

" + "smithy.api#documentation": "

The ID of the primary VPC for the file system.

" } }, - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", + "LustreConfiguration": { + "target": "com.amazonaws.fsx#LustreFileSystemConfiguration" + }, + "FailureDetails": { + "target": "com.amazonaws.fsx#FileSystemFailureDetails" + }, + "StorageType": { + "target": "com.amazonaws.fsx#StorageType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the file system resource.

" + "smithy.api#documentation": "

The storage type of the file system. \n Valid values are SSD and HDD.\n If set to SSD, the file system uses solid state drive storage. \n If set to HDD, the file system uses hard disk drive storage.\n

" } }, "OwnerId": { @@ -2155,40 +2192,28 @@ "smithy.api#documentation": "

The AWS account that created the file system. If the file system was created by an AWS\n Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs\n is the owner.

" } }, - "FileSystemType": { - "target": "com.amazonaws.fsx#FileSystemType", - "traits": { - "smithy.api#documentation": "

The type of Amazon FSx file system, either LUSTRE or WINDOWS.

" - } - }, - "WindowsConfiguration": { - "target": "com.amazonaws.fsx#WindowsFileSystemConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for this Microsoft Windows file system.

" - } - }, - "VpcId": { - "target": "com.amazonaws.fsx#VpcId", + "Tags": { + "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "

The ID of the primary VPC for the file system.

" + "smithy.api#documentation": "

The tags to associate with the file system. For more information, see Tagging Your\n Amazon EC2 Resources in the Amazon EC2 User\n Guide.

" } }, - "CreationTime": { - "target": "com.amazonaws.fsx#CreationTime", + "StorageCapacity": { + "target": "com.amazonaws.fsx#StorageCapacity", "traits": { - "smithy.api#documentation": "

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z),\n also known as Unix time.

" + "smithy.api#documentation": "

The storage capacity of the file system in gigabytes (GB).

" } }, - "KmsKeyId": { - "target": "com.amazonaws.fsx#KmsKeyId", + "AdministrativeActions": { + "target": "com.amazonaws.fsx#AdministrativeActions", "traits": { - "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data\n for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file\n systems at rest. In either case, if not specified, the Amazon FSx managed key\n is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using\n Amazon FSx managed keys. For more information, see Encrypt\n in the AWS Key Management Service API Reference.

" + "smithy.api#documentation": "

A list of administrative actions for the file system that are in process or waiting to be processed. \n Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.\n

" } }, - "Lifecycle": { - "target": "com.amazonaws.fsx#FileSystemLifecycle", + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", "traits": { - "smithy.api#documentation": "

The lifecycle status of the file system, following are the possible values and what they mean:

\n " + "smithy.api#documentation": "

The system-generated, unique 17-digit ID of the file system.

" } } }, @@ -2349,17 +2374,17 @@ "com.amazonaws.fsx#Filter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.fsx#FilterValues", - "traits": { - "smithy.api#documentation": "

The values of the filter. These are all the values for any of the applied\n filters.

" - } - }, "Name": { "target": "com.amazonaws.fsx#FilterName", "traits": { "smithy.api#documentation": "

The name for this filter.

" } + }, + "Values": { + "target": "com.amazonaws.fsx#FilterValues", + "traits": { + "smithy.api#documentation": "

The values of the filter. These are all the values for any of the applied\n filters.

" + } } }, "traits": { @@ -2487,12 +2512,12 @@ "com.amazonaws.fsx#InvalidNetworkSettings": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" - }, "InvalidSubnetId": { "target": "com.amazonaws.fsx#SubnetId" }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + }, "InvalidSecurityGroupId": { "target": "com.amazonaws.fsx#SecurityGroupId" } @@ -2570,10 +2595,10 @@ "com.amazonaws.fsx#ListTagsForResourceRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.fsx#NextToken", + "MaxResults": { + "target": "com.amazonaws.fsx#MaxResults", "traits": { - "smithy.api#documentation": "

Opaque pagination token returned from a previous\n ListTagsForResource operation (String). If a token present, the action\n continues the list from where the returning call left off.

" + "smithy.api#documentation": "

Maximum number of tags to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults parameter specified in the request and the\n service's internal maximum number of items per page.

" } }, "ResourceARN": { @@ -2583,10 +2608,10 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.fsx#MaxResults", + "NextToken": { + "target": "com.amazonaws.fsx#NextToken", "traits": { - "smithy.api#documentation": "

Maximum number of tags to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults parameter specified in the request and the\n service's internal maximum number of items per page.

" + "smithy.api#documentation": "

Opaque pagination token returned from a previous\n ListTagsForResource operation (String). If a token present, the action\n continues the list from where the returning call left off.

" } } }, @@ -2636,6 +2661,27 @@ "com.amazonaws.fsx#LustreFileSystemConfiguration": { "type": "structure", "members": { + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "

A boolean flag indicating whether tags on the file system should be copied to backups.\n If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value. (Default = false)

" + } + }, + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime" + }, + "PerUnitStorageThroughput": { + "target": "com.amazonaws.fsx#PerUnitStorageThroughput", + "traits": { + "smithy.api#documentation": "

Per unit storage throughput represents the megabytes per second of read or write\n throughput per 1 tebibyte of storage provisioned. File system throughput capacity is\n equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is\n only valid for PERSISTENT_1 deployment types.

\n

Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.

" + } + }, + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + }, + "DataRepositoryConfiguration": { + "target": "com.amazonaws.fsx#DataRepositoryConfiguration" + }, "MountName": { "target": "com.amazonaws.fsx#LustreFileSystemMountName", "traits": { @@ -2648,31 +2694,16 @@ "smithy.api#documentation": "

The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage\n and shorter-term processing of data.

\n

\n SCRATCH_1 and SCRATCH_2 deployment \n types are best suited for when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.

\n

The PERSISTENT_1 deployment type is used for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options. (Default = SCRATCH_1)

" } }, - "WeeklyMaintenanceStartTime": { - "target": "com.amazonaws.fsx#WeeklyTime", - "traits": { - "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" - } - }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime" - }, - "CopyTagsToBackups": { - "target": "com.amazonaws.fsx#Flag", + "DriveCacheType": { + "target": "com.amazonaws.fsx#DriveCacheType", "traits": { - "smithy.api#documentation": "

A boolean flag indicating whether tags on the file system should be copied to backups.\n If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value. (Default = false)

" + "smithy.api#documentation": "

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set to\n READ, improve the performance for frequently accessed files and allows 20%\n of the total storage capacity of the file system to be cached.

\n

This parameter is required when StorageType is set to HDD.

" } }, - "DataRepositoryConfiguration": { - "target": "com.amazonaws.fsx#DataRepositoryConfiguration" - }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" - }, - "PerUnitStorageThroughput": { - "target": "com.amazonaws.fsx#PerUnitStorageThroughput", + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime", "traits": { - "smithy.api#documentation": "

\n Per unit storage throughput represents the megabytes per second of read or write throughput per \n 1 tebibyte of storage provisioned. \n File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). \n This option is only valid for PERSISTENT_1 deployment types. Valid values are 50, 100, 200. \n

" + "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" } } }, @@ -2812,7 +2843,7 @@ "traits": { "smithy.api#box": {}, "smithy.api#range": { - "min": 50, + "min": 12, "max": 200 } } @@ -2886,15 +2917,15 @@ "com.amazonaws.fsx#ResourceNotFound": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" + }, "ResourceARN": { "target": "com.amazonaws.fsx#ResourceARN", "traits": { "smithy.api#documentation": "

The resource ARN of the resource that can't be found.

", "smithy.api#required": {} } - }, - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" } }, "traits": { @@ -2929,34 +2960,34 @@ "com.amazonaws.fsx#SelfManagedActiveDirectoryAttributes": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", + "FileSystemAdministratorsGroup": { + "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", "traits": { - "smithy.api#documentation": "

The fully qualified domain name of the self-managed AD directory.

" + "smithy.api#documentation": "

The name of the domain group whose members have administrative privileges for the FSx\n file system.

" } }, - "OrganizationalUnitDistinguishedName": { - "target": "com.amazonaws.fsx#OrganizationalUnitDistinguishedName", + "UserName": { + "target": "com.amazonaws.fsx#DirectoryUserName", "traits": { - "smithy.api#documentation": "

The fully qualified distinguished name of the organizational unit within the\n self-managed AD directory to which the Windows File Server instance is joined.

" + "smithy.api#documentation": "

The user name for the service account on your self-managed AD domain that FSx uses to\n join to your AD domain.

" } }, - "DnsIps": { - "target": "com.amazonaws.fsx#DnsIps", + "OrganizationalUnitDistinguishedName": { + "target": "com.amazonaws.fsx#OrganizationalUnitDistinguishedName", "traits": { - "smithy.api#documentation": "

A list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory.

" + "smithy.api#documentation": "

The fully qualified distinguished name of the organizational unit within the\n self-managed AD directory to which the Windows File Server instance is joined.

" } }, - "FileSystemAdministratorsGroup": { - "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", + "DomainName": { + "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", "traits": { - "smithy.api#documentation": "

The name of the domain group whose members have administrative privileges for the FSx\n file system.

" + "smithy.api#documentation": "

The fully qualified domain name of the self-managed AD directory.

" } }, - "UserName": { - "target": "com.amazonaws.fsx#DirectoryUserName", + "DnsIps": { + "target": "com.amazonaws.fsx#DnsIps", "traits": { - "smithy.api#documentation": "

The user name for the service account on your self-managed AD domain that FSx uses to\n join to your AD domain.

" + "smithy.api#documentation": "

A list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory.

" } } }, @@ -2967,17 +2998,10 @@ "com.amazonaws.fsx#SelfManagedActiveDirectoryConfiguration": { "type": "structure", "members": { - "FileSystemAdministratorsGroup": { - "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", - "traits": { - "smithy.api#documentation": "

(Optional) The name of the domain group whose members are granted administrative\n privileges for the file system. Administrative privileges include taking ownership of\n files and folders, setting audit controls (audit ACLs) on files and folders, and \n administering the file system remotely by using the FSx Remote PowerShell.\n The group that you specify must already exist in your domain. If you don't provide one,\n your AD domain's Domain Admins group is used.

" - } - }, - "UserName": { - "target": "com.amazonaws.fsx#DirectoryUserName", + "OrganizationalUnitDistinguishedName": { + "target": "com.amazonaws.fsx#OrganizationalUnitDistinguishedName", "traits": { - "smithy.api#documentation": "

The user name for the service account on your self-managed AD domain that Amazon FSx\n will use to join to your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName, or in the default location of your\n AD domain.

", - "smithy.api#required": {} + "smithy.api#documentation": "

(Optional) The fully qualified distinguished name of the organizational unit within\n your self-managed AD directory that the Windows File Server instance will join. Amazon\n FSx only accepts OU as the direct parent of the file system. An example is\n OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the\n FSx file system is created in the default location of your self-managed AD directory.

\n \n

Only Organizational Unit (OU) objects can be the direct parent of the file system\n that you're creating.

\n " } }, "DomainName": { @@ -3001,10 +3025,17 @@ "smithy.api#required": {} } }, - "OrganizationalUnitDistinguishedName": { - "target": "com.amazonaws.fsx#OrganizationalUnitDistinguishedName", + "FileSystemAdministratorsGroup": { + "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", "traits": { - "smithy.api#documentation": "

(Optional) The fully qualified distinguished name of the organizational unit within\n your self-managed AD directory that the Windows File Server instance will join. Amazon\n FSx only accepts OU as the direct parent of the file system. An example is\n OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the\n FSx file system is created in the default location of your self-managed AD directory.

\n \n

Only Organizational Unit (OU) objects can be the direct parent of the file system\n that you're creating.

\n " + "smithy.api#documentation": "

(Optional) The name of the domain group whose members are granted administrative\n privileges for the file system. Administrative privileges include taking ownership of\n files and folders, setting audit controls (audit ACLs) on files and folders, and \n administering the file system remotely by using the FSx Remote PowerShell.\n The group that you specify must already exist in your domain. If you don't provide one,\n your AD domain's Domain Admins group is used.

" + } + }, + "UserName": { + "target": "com.amazonaws.fsx#DirectoryUserName", + "traits": { + "smithy.api#documentation": "

The user name for the service account on your self-managed AD domain that Amazon FSx\n will use to join to your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName, or in the default location of your\n AD domain.

", + "smithy.api#required": {} } } }, @@ -3015,10 +3046,10 @@ "com.amazonaws.fsx#SelfManagedActiveDirectoryConfigurationUpdates": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.fsx#DirectoryUserName", + "DnsIps": { + "target": "com.amazonaws.fsx#DnsIps", "traits": { - "smithy.api#documentation": "

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName.

" + "smithy.api#documentation": "

A list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory.

" } }, "Password": { @@ -3027,10 +3058,10 @@ "smithy.api#documentation": "

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain.

" } }, - "DnsIps": { - "target": "com.amazonaws.fsx#DnsIps", + "UserName": { + "target": "com.amazonaws.fsx#DirectoryUserName", "traits": { - "smithy.api#documentation": "

A list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory.

" + "smithy.api#documentation": "

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName.

" } } }, @@ -3065,15 +3096,15 @@ "com.amazonaws.fsx#ServiceLimitExceeded": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" - }, "Limit": { "target": "com.amazonaws.fsx#ServiceLimit", "traits": { "smithy.api#documentation": "

Enumeration of the service limit that was exceeded.

", "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" } }, "traits": { @@ -3171,17 +3202,17 @@ "com.amazonaws.fsx#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.fsx#TagKey", + "Value": { + "target": "com.amazonaws.fsx#TagValue", "traits": { - "smithy.api#documentation": "

A value that specifies the TagKey, the name of the tag. Tag keys must\n be unique for the resource to which they are attached.

", + "smithy.api#documentation": "

A value that specifies the TagValue, the value assigned to the\n corresponding tag key. Tag values can be null and don't have to be unique in a tag set.\n For example, you can have a key-value pair in a tag set of finances : April\n and also of payroll : April.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.fsx#TagValue", + "Key": { + "target": "com.amazonaws.fsx#TagKey", "traits": { - "smithy.api#documentation": "

A value that specifies the TagValue, the value assigned to the\n corresponding tag key. Tag values can be null and don't have to be unique in a tag set.\n For example, you can have a key-value pair in a tag set of finances : April\n and also of payroll : April.

", + "smithy.api#documentation": "

A value that specifies the TagKey, the name of the tag. Tag keys must\n be unique for the resource to which they are attached.

", "smithy.api#required": {} } } @@ -3247,17 +3278,17 @@ "com.amazonaws.fsx#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.fsx#Tags", + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", "traits": { - "smithy.api#documentation": "

A list of tags for the resource. If a tag with a given key already exists, the\n value is replaced by the one specified in this parameter.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to\n tag.

", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", + "Tags": { + "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to\n tag.

", + "smithy.api#documentation": "

A list of tags for the resource. If a tag with a given key already exists, the\n value is replaced by the one specified in this parameter.

", "smithy.api#required": {} } } @@ -3370,17 +3401,17 @@ "com.amazonaws.fsx#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.fsx#TagKeys", + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", "traits": { - "smithy.api#documentation": "

A list of keys of tags on the resource to untag. In case the tag key doesn't exist,\n the call will still succeed to be idempotent.

", + "smithy.api#documentation": "

The ARN of the Amazon FSx resource to untag.

", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", + "TagKeys": { + "target": "com.amazonaws.fsx#TagKeys", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon FSx resource to untag.

", + "smithy.api#documentation": "

A list of keys of tags on the resource to untag. In case the tag key doesn't exist,\n the call will still succeed to be idempotent.

", "smithy.api#required": {} } } @@ -3434,23 +3465,23 @@ "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration": { "type": "structure", "members": { - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" - }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime" - }, "AutoImportPolicy": { "target": "com.amazonaws.fsx#AutoImportPolicyType", "traits": { - "smithy.api#documentation": "

(Optional) Use this property to configure the AutoImport feature on the \n file system's linked Amazon S3 data repository. You use\n AutoImport to update the contents of your FSx for Lustre file system automatically \n with changes that occur in the linked S3 data repository. AutoImportPolicy can\n have the following values:

\n \n

For more information, see Automatically import updates from your S3 bucket.

" + "smithy.api#documentation": "

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listing up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy can\n have the following values:

\n \n

For more information, see Automatically import updates from your S3 bucket.

" } }, + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime" + }, "WeeklyMaintenanceStartTime": { "target": "com.amazonaws.fsx#WeeklyTime", "traits": { - "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" + "smithy.api#documentation": "

(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" } + }, + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" } }, "traits": { @@ -3460,17 +3491,10 @@ "com.amazonaws.fsx#UpdateFileSystemRequest": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.fsx#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent updates. This string is automatically filled on your behalf when you use the AWS\n Command Line Interface (AWS CLI) or an AWS SDK.

", - "smithy.api#idempotencyToken": {} - } - }, - "StorageCapacity": { - "target": "com.amazonaws.fsx#StorageCapacity", + "WindowsConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration", "traits": { - "smithy.api#documentation": "

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server file system. \n Specifies the storage capacity target value, GiB, for the file system you're updating. \n The storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value.\n In order to increase storage capacity, the file system needs to have at least 16 MB/s of throughput capacity. You cannot \n make a storage capacity increase request if there is an existing storage capacity increase request in progress. \n For more information, see \n Managing Storage Capacity.

" + "smithy.api#documentation": "

The configuration updates for an Amazon FSx for Windows File Server file system.

" } }, "FileSystemId": { @@ -3480,14 +3504,21 @@ "smithy.api#required": {} } }, - "WindowsConfiguration": { - "target": "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration", + "LustreConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration" + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The configuration updates for an Amazon FSx for Windows File Server file system.

" + "smithy.api#documentation": "

A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent updates. This string is automatically filled on your behalf when you use the AWS\n Command Line Interface (AWS CLI) or an AWS SDK.

", + "smithy.api#idempotencyToken": {} } }, - "LustreConfiguration": { - "target": "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration" + "StorageCapacity": { + "target": "com.amazonaws.fsx#StorageCapacity", + "traits": { + "smithy.api#documentation": "

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server file system. \n Specifies the storage capacity target value, GiB, for the file system you're updating. \n The storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value.\n In order to increase storage capacity, the file system needs to have at least 16 MB/s of throughput capacity. You cannot \n make a storage capacity increase request if there is an existing storage capacity increase request in progress. \n For more information, see \n Managing Storage Capacity.

" + } } }, "traits": { @@ -3511,34 +3542,34 @@ "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration": { "type": "structure", "members": { - "ThroughputCapacity": { - "target": "com.amazonaws.fsx#MegabytesPerSecond", + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", "traits": { - "smithy.api#documentation": "

Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are \n 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, \n see Managing Throughput Capacity.

" + "smithy.api#documentation": "

The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily\n backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see\n Working with Automatic Daily Backups.

" } }, - "SelfManagedActiveDirectoryConfiguration": { - "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryConfigurationUpdates", + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime", "traits": { - "smithy.api#documentation": "

The configuration Amazon FSx uses to join the Windows File Server instance to the\n self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.

" + "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.

" } }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime", + "ThroughputCapacity": { + "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "

The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00\n

" + "smithy.api#documentation": "

Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are \n 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, \n see Managing Throughput Capacity.

" } }, - "WeeklyMaintenanceStartTime": { - "target": "com.amazonaws.fsx#WeeklyTime", + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime", "traits": { - "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.

" + "smithy.api#documentation": "

The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00\n

" } }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", + "SelfManagedActiveDirectoryConfiguration": { + "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryConfigurationUpdates", "traits": { - "smithy.api#documentation": "

The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily\n backups. You can retain automatic daily backups for a maximum of 35 days. For more information, see\n Working with Automatic Daily Backups.

" + "smithy.api#documentation": "

The configuration Amazon FSx uses to join the Windows File Server instance to the\n self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.

" } } }, @@ -3590,73 +3621,73 @@ "com.amazonaws.fsx#WindowsFileSystemConfiguration": { "type": "structure", "members": { - "MaintenanceOperationsInProgress": { - "target": "com.amazonaws.fsx#FileSystemMaintenanceOperations", + "ActiveDirectoryId": { + "target": "com.amazonaws.fsx#DirectoryId", "traits": { - "smithy.api#documentation": "

The list of maintenance operations in progress for this file system.

" + "smithy.api#documentation": "

The ID for an existing Microsoft Active Directory instance that the file system should join when\n it's created.

" } }, - "DeploymentType": { - "target": "com.amazonaws.fsx#WindowsDeploymentType", + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", "traits": { - "smithy.api#documentation": "

Specifies the file system deployment type, valid values are the following:

\n \n

For more information, see \n Single-AZ and Multi-AZ File Systems.

" + "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this to 0 disables automatic\n backups. You can retain automatic backups for a maximum of 90 days.

" } }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime", + "PreferredSubnetId": { + "target": "com.amazonaws.fsx#SubnetId", "traits": { - "smithy.api#documentation": "

The preferred time to take daily automatic backups, in the UTC time zone.

" + "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. \n Must be one of the two subnet IDs specified in SubnetIds property.\n Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

\n

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs.\n For more information, see \n Availability and Durability: Single-AZ and Multi-AZ File Systems\n

" } }, - "PreferredFileServerIp": { - "target": "com.amazonaws.fsx#IpAddress", + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

\n

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that \n are not joined to a Microsoft Active Directory. \n Applicable for all Windows file system deployment types. \n This IP address is temporarily unavailable \n when the file system is undergoing maintenance. For Linux and Windows \n SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information\n on mapping and mounting file shares, see \n Accessing File Shares.

" + "smithy.api#documentation": "

A boolean flag indicating whether tags on the file system should be copied to backups.\n This value defaults to false. If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value.

" } }, - "SelfManagedActiveDirectoryConfiguration": { - "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryAttributes" - }, - "ActiveDirectoryId": { - "target": "com.amazonaws.fsx#DirectoryId", + "ThroughputCapacity": { + "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "

The ID for an existing Microsoft Active Directory instance that the file system should join when\n it's created.

" + "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per\n second.

" } }, - "WeeklyMaintenanceStartTime": { - "target": "com.amazonaws.fsx#WeeklyTime", + "RemoteAdministrationEndpoint": { + "target": "com.amazonaws.fsx#DNSName", "traits": { - "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" + "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using \n Amazon FSx Remote PowerShell.

\n

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

\n

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

" } }, - "ThroughputCapacity": { - "target": "com.amazonaws.fsx#MegabytesPerSecond", + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime", "traits": { - "smithy.api#documentation": "

The throughput of an Amazon FSx file system, measured in megabytes per\n second.

" + "smithy.api#documentation": "

The preferred time to take daily automatic backups, in the UTC time zone.

" } }, - "PreferredSubnetId": { - "target": "com.amazonaws.fsx#SubnetId", + "MaintenanceOperationsInProgress": { + "target": "com.amazonaws.fsx#FileSystemMaintenanceOperations", "traits": { - "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. \n Must be one of the two subnet IDs specified in SubnetIds property.\n Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

\n

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs.\n For more information, see \n Availability and Durability: Single-AZ and Multi-AZ File Systems\n

" + "smithy.api#documentation": "

The list of maintenance operations in progress for this file system.

" } }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", + "WeeklyMaintenanceStartTime": { + "target": "com.amazonaws.fsx#WeeklyTime", "traits": { - "smithy.api#documentation": "

The number of days to retain automatic backups. Setting this to 0 disables automatic\n backups. You can retain automatic backups for a maximum of 35 days.

" + "smithy.api#documentation": "

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" } }, - "CopyTagsToBackups": { - "target": "com.amazonaws.fsx#Flag", + "DeploymentType": { + "target": "com.amazonaws.fsx#WindowsDeploymentType", "traits": { - "smithy.api#documentation": "

A boolean flag indicating whether tags on the file system should be copied to backups.\n This value defaults to false. If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value.

" + "smithy.api#documentation": "

Specifies the file system deployment type, valid values are the following:

\n \n

For more information, see \n Single-AZ and Multi-AZ File Systems.

" } }, - "RemoteAdministrationEndpoint": { - "target": "com.amazonaws.fsx#DNSName", + "SelfManagedActiveDirectoryConfiguration": { + "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryAttributes" + }, + "PreferredFileServerIp": { + "target": "com.amazonaws.fsx#IpAddress", "traits": { - "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using \n Amazon FSx Remote PowerShell.

\n

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

\n

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

" + "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

\n

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that \n are not joined to a Microsoft Active Directory. \n Applicable for all Windows file system deployment types. \n This IP address is temporarily unavailable \n when the file system is undergoing maintenance. For Linux and Windows \n SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information\n on mapping and mounting file shares, see \n Accessing File Shares.

" } } }, 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 b29d330bca8f..88675a414e5d 100644 --- a/codegen/sdk-codegen/aws-models/gamelift.2015-10-01.json +++ b/codegen/sdk-codegen/aws-models/gamelift.2015-10-01.json @@ -58,13 +58,6 @@ "com.amazonaws.gamelift#AcceptMatchInput": { "type": "structure", "members": { - "TicketId": { - "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", - "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this\n request will fail.

", - "smithy.api#required": {} - } - }, "PlayerIds": { "target": "com.amazonaws.gamelift#StringList", "traits": { @@ -78,10 +71,17 @@ "smithy.api#documentation": "

Player response to the proposed match.

", "smithy.api#required": {} } + }, + "TicketId": { + "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", + "traits": { + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this\n request will fail.

", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#AcceptMatchOutput": { @@ -104,40 +104,40 @@ "com.amazonaws.gamelift#Alias": { "type": "structure", "members": { - "RoutingStrategy": { - "target": "com.amazonaws.gamelift#RoutingStrategy", + "Name": { + "target": "com.amazonaws.gamelift#NonBlankAndLengthConstraintString", "traits": { - "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the alias.

" + "smithy.api#documentation": "

A descriptive label that is associated with an alias. Alias names do not need to be unique.

" } }, - "LastUpdatedTime": { + "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "AliasId": { - "target": "com.amazonaws.gamelift#AliasId", + "Description": { + "target": "com.amazonaws.gamelift#FreeText", "traits": { - "smithy.api#documentation": "

A unique identifier for an alias. Alias IDs are unique within a Region.

" + "smithy.api#documentation": "

A human-readable description of an alias.

" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonBlankAndLengthConstraintString", + "LastUpdatedTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with an alias. Alias names do not need to be unique.

" + "smithy.api#documentation": "

The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "RoutingStrategy": { + "target": "com.amazonaws.gamelift#RoutingStrategy", "traits": { - "smithy.api#documentation": "

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the alias.

" } }, - "Description": { - "target": "com.amazonaws.gamelift#FreeText", + "AliasId": { + "target": "com.amazonaws.gamelift#AliasId", "traits": { - "smithy.api#documentation": "

A human-readable description of an alias.

" + "smithy.api#documentation": "

A unique identifier for an alias. Alias IDs are unique within a Region.

" } }, "AliasArn": { @@ -197,28 +197,28 @@ "com.amazonaws.gamelift#AttributeValue": { "type": "structure", "members": { - "SL": { - "target": "com.amazonaws.gamelift#StringList", - "traits": { - "smithy.api#documentation": "

For a list of up to 10 strings. Maximum length for each string is 100 characters.\n Duplicate values are not recognized; all occurrences of the repeated value after the\n first of a repeated value are ignored.

" - } - }, "SDM": { "target": "com.amazonaws.gamelift#StringDoubleMap", "traits": { "smithy.api#documentation": "

For a map of up to 10 data type:value pairs. Maximum length for each string value\n is 100 characters.

" } }, + "N": { + "target": "com.amazonaws.gamelift#DoubleObject", + "traits": { + "smithy.api#documentation": "

For number values, expressed as double.

" + } + }, "S": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "

For single string values. Maximum string length is 100 characters.

" } }, - "N": { - "target": "com.amazonaws.gamelift#DoubleObject", + "SL": { + "target": "com.amazonaws.gamelift#StringList", "traits": { - "smithy.api#documentation": "

For number values, expressed as double.

" + "smithy.api#documentation": "

For a list of up to 10 strings. Maximum length for each string is 100 characters.\n Duplicate values are not recognized; all occurrences of the repeated value after the\n first of a repeated value are ignored.

" } } }, @@ -245,16 +245,16 @@ "smithy.api#documentation": "

Temporary key allowing access to the Amazon GameLift S3 account.

" } }, - "SessionToken": { + "SecretAccessKey": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Token used to associate a specific build ID with the files uploaded using these\n credentials.

" + "smithy.api#documentation": "

Temporary secret key allowing access to the Amazon GameLift S3 account.

" } }, - "SecretAccessKey": { + "SessionToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Temporary secret key allowing access to the Amazon GameLift S3 account.

" + "smithy.api#documentation": "

Token used to associate a specific build ID with the files uploaded using these\n credentials.

" } } }, @@ -289,6 +289,10 @@ { "value": "SPOT_PREFERRED", "name": "SPOT_PREFERRED" + }, + { + "value": "ON_DEMAND_ONLY", + "name": "ON_DEMAND_ONLY" } ] } @@ -302,6 +306,12 @@ "com.amazonaws.gamelift#Build": { "type": "structure", "members": { + "OperatingSystem": { + "target": "com.amazonaws.gamelift#OperatingSystem", + "traits": { + "smithy.api#documentation": "

Operating system that the game server binaries are built to run on. This value\n determines the type of fleet resources that you can use for this build.

" + } + }, "BuildId": { "target": "com.amazonaws.gamelift#BuildId", "traits": { @@ -314,16 +324,16 @@ "smithy.api#documentation": "

Current status of the build.

\n

Possible build statuses include the following:

\n " } }, - "Version": { - "target": "com.amazonaws.gamelift#FreeText", + "CreationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

" + "smithy.api#documentation": "

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "Name": { + "Version": { "target": "com.amazonaws.gamelift#FreeText", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

" + "smithy.api#documentation": "

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

" } }, "BuildArn": { @@ -332,22 +342,16 @@ "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift build ARN, the resource ID matches the\n BuildId value.

" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", - "traits": { - "smithy.api#documentation": "

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" - } - }, "SizeOnDisk": { "target": "com.amazonaws.gamelift#PositiveLong", "traits": { "smithy.api#documentation": "

File size of the uploaded game build, expressed in bytes. When the build status is\n INITIALIZED, this value is 0.

" } }, - "OperatingSystem": { - "target": "com.amazonaws.gamelift#OperatingSystem", + "Name": { + "target": "com.amazonaws.gamelift#FreeText", "traits": { - "smithy.api#documentation": "

Operating system that the game server binaries are built to run on. This value\n determines the type of fleet resources that you can use for this build.

" + "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

" } } }, @@ -457,7 +461,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Locates an available game server and temporarily reserves it to host gameplay and\n players. This action is called by a game client or client service (such as a matchmaker)\n to request hosting resources for a new game session. In response, GameLift FleetIQ searches for an\n available game server in the specified game server group, places the game server in\n \"claimed\" status for 60 seconds, and returns connection information back to the\n requester so that players can connect to the game server.

\n

There are two ways you can claim a game server. For the first option, you provide a\n game server group ID only, which prompts GameLift FleetIQ to search for an available game server in\n the specified group and claim it. With this option, GameLift FleetIQ attempts to consolidate\n gameplay on as few instances as possible to minimize hosting costs. For the second\n option, you request a specific game server by its ID. This option results in a less\n efficient claiming process because it does not take advantage of consolidation and may\n fail if the requested game server is unavailable.

\n

To claim a game server, identify a game server group and (optionally) a game server\n ID. If your game requires that game data be provided to the game server at the start of\n a game, such as a game map or player information, you can provide it in your claim\n request.

\n

When a game server is successfully claimed, connection information is returned. A\n claimed game server's utilization status remains AVAILABLE, while the claim status is\n set to CLAIMED for up to 60 seconds. This time period allows the game server to be\n prompted to update its status to UTILIZED (using UpdateGameServer). If\n the game server's status is not updated within 60 seconds, the game server reverts to\n unclaimed status and is available to be claimed by another request.

\n

If you try to claim a specific game server, this request will fail in the following\n cases: (1) if the game server utilization status is UTILIZED, (2) if the game server\n claim status is CLAIMED, or (3) if the instance that the game server is running on is\n flagged as draining.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Locates an available game server and temporarily reserves it to host gameplay and\n players. This operation is called from a game client or client service (such as a\n matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ\n locates an available game server, places it in CLAIMED status for 60\n seconds, and returns connection information that players can use to connect to the game\n server.

\n

To claim a game server, identify a game server group. You can also specify a game\n server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally,\n include game data to pass to the game server at the start of a game session, such as a\n game map or player information.

\n

When a game server is successfully claimed, connection information is returned. A\n claimed game server's utilization status remains AVAILABLE while the claim\n status is set to CLAIMED for up to 60 seconds. This time period gives the\n game server time to update its status to UTILIZED (using UpdateGameServer) once players join. If the game server's status is not\n updated within 60 seconds, the game server reverts to unclaimed status and is available\n to be claimed by another request. The claim time period is a fixed value and is not\n configurable.

\n

If you try to claim a specific game server, this request will fail in the following\n cases:

\n \n \n

When claiming a specific game server, this request will succeed even if the game\n server is running on an instance in DRAINING status. To avoid this,\n first check the instance status by calling DescribeGameServerInstances.

\n \n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#ClaimGameServerInput": { @@ -466,14 +470,14 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

An identifier for the game server group. When claiming a specific game server, this is\n the game server group whether the game server is located. When requesting that GameLift FleetIQ\n locate an available game server, this is the game server group to search on. You can use\n either the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.. If you are not specifying a game server to claim, \n this value identifies where you want GameLift FleetIQ to look for an available \n game server to claim.

", "smithy.api#required": {} } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value, to be\n passed to the claimed game server.

" + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" } }, "GameServerId": { @@ -490,7 +494,7 @@ "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { - "smithy.api#documentation": "

Object that describes the newly claimed game server resource.

" + "smithy.api#documentation": "

Object that describes the newly claimed game server.

" } } } @@ -593,7 +597,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateAliasOutput": { @@ -607,7 +611,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateBuild": { @@ -636,7 +640,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon GameLift build resource for your game server binary files. Game server\n binaries must be combined into a zip file for use with Amazon GameLift.

\n \n

When setting up a new game build for GameLift, we recommend using the AWS CLI\n command \n upload-build\n . This helper command combines two tasks: (1) it\n uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)\n it creates a new build resource.

\n \n

The CreateBuild operation can used in the following scenarios:

\n \n

If successful, this operation creates a new build resource with a unique build ID and\n places it in INITIALIZED status. A build must be in READY\n status before you can create fleets with it.

\n

\n Learn more\n

\n

\n Uploading Your\n Game\n

\n

\n Create a Build with Files in Amazon S3\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Creates a new Amazon GameLift build resource for your game server binary files. Game server\n binaries must be combined into a zip file for use with Amazon GameLift.

\n \n

When setting up a new game build for GameLift, we recommend using the AWS CLI\n command \n upload-build\n . This helper command combines two tasks: (1) it\n uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)\n it creates a new build resource.

\n \n

The CreateBuild operation can used in the following scenarios:

\n \n

If successful, this operation creates a new build resource with a unique build ID and\n places it in INITIALIZED status. A build must be in READY\n status before you can create fleets with it.

\n

\n Learn more\n

\n

\n Uploading Your\n Game\n

\n

\n Create a Build with Files in Amazon S3\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#CreateBuildInput": { @@ -648,18 +652,18 @@ "smithy.api#documentation": "

Information indicating where your game build files are stored. Use this parameter only\n when creating a build with files stored in an S3 bucket that you own. The storage\n location must specify an S3 bucket name and key. The location must also specify a role\n ARN that you set up to allow Amazon GameLift to access your S3 bucket. The S3 bucket and your\n new build must be in the same Region.

" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.\n

" - } - }, "OperatingSystem": { "target": "com.amazonaws.gamelift#OperatingSystem", "traits": { "smithy.api#documentation": "

The operating system that the game server binaries are built to run on. This value\n determines the type of fleet resources that you can use for this build. If your game\n build contains multiple executables, they all must run on the same operating system. If\n an operating system is not specified when creating a build, Amazon GameLift uses the\n default value (WINDOWS_2012). This value cannot be changed later.

" } }, + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.\n

" + } + }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { @@ -674,16 +678,16 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateBuildOutput": { "type": "structure", "members": { - "StorageLocation": { - "target": "com.amazonaws.gamelift#S3Location", + "UploadCredentials": { + "target": "com.amazonaws.gamelift#AwsCredentials", "traits": { - "smithy.api#documentation": "

Amazon S3 location for your game build file, including bucket name and\n key.

" + "smithy.api#documentation": "

This element is returned only when the operation is called without a storage\n location. It contains credentials to use when you are uploading a build file to an S3\n bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these\n credentials, call RequestUploadCredentials.

" } }, "Build": { @@ -692,15 +696,15 @@ "smithy.api#documentation": "

The newly created build resource, including a unique build IDs and status.

" } }, - "UploadCredentials": { - "target": "com.amazonaws.gamelift#AwsCredentials", + "StorageLocation": { + "target": "com.amazonaws.gamelift#S3Location", "traits": { - "smithy.api#documentation": "

This element is returned only when the operation is called without a storage\n location. It contains credentials to use when you are uploading a build file to an S3\n bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these\n credentials, call RequestUploadCredentials.

" + "smithy.api#documentation": "

Amazon S3 location for your game build file, including bucket name and\n key.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateFleet": { @@ -741,52 +745,65 @@ "com.amazonaws.gamelift#CreateFleetInput": { "type": "structure", "members": { - "PeerVpcAwsAccountId": { + "ServerLaunchParameters": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift\n fleet with. You can find your account ID in the AWS Management Console under account settings.

" + "smithy.api#documentation": "

This parameter is no longer used. Instead, specify server launch parameters in the\n RuntimeConfiguration parameter. (Requests that specify a server launch\n path and launch parameters instead of a runtime configuration will continue to\n work.)

" } }, - "RuntimeConfiguration": { - "target": "com.amazonaws.gamelift#RuntimeConfiguration", + "CertificateConfiguration": { + "target": "com.amazonaws.gamelift#CertificateConfiguration", "traits": { - "smithy.api#documentation": "

Instructions for launching server processes on each instance in the fleet. Server\n processes run either a custom game build executable or a Realtime script. The runtime\n configuration defines the server executables or launch script file, launch parameters,\n and the number of processes to run concurrently on each instance. When creating a fleet,\n the runtime configuration must have at least one server process configuration; otherwise\n the request fails with an invalid request exception. (This parameter replaces the\n parameters ServerLaunchPath and ServerLaunchParameters,\n although requests that contain values for these parameters instead of a runtime\n configuration will continue to work.) This parameter is required unless the parameters \n ServerLaunchPath and ServerLaunchParameters are defined. Runtime \n configuration replaced these parameters, but fleets that use them will continue to work.

" + "smithy.api#documentation": "

Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS\n certificates are used for encrypting traffic between game clients and game servers\n running on GameLift. If this parameter is not specified, the default value, DISABLED, is\n used. This fleet setting cannot be changed once the fleet is created. Learn more at\n Securing Client/Server Communication.

\n

Note: This feature requires the AWS Certificate Manager (ACM) service, which is\n available in the AWS global partition but not in all other partitions. When working in a\n partition that does not support this feature, a request for a new fleet with certificate\n generation results fails with a 4xx unsupported Region error.

\n

Valid values include:

\n " } }, - "InstanceRoleArn": { - "target": "com.amazonaws.gamelift#NonEmptyString", + "ServerLaunchPath": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for an AWS IAM role that manages access to your AWS services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN from the IAM dashboard in the AWS Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server.

" + "smithy.api#documentation": "

This parameter is no longer used. Instead, specify a server launch path using the\n RuntimeConfiguration parameter. Requests that specify a server launch\n path and launch parameters instead of a runtime configuration will continue to\n work.

" } }, - "Tags": { - "target": "com.amazonaws.gamelift#TagList", + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new fleet resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

", + "smithy.api#required": {} } }, - "MetricGroups": { - "target": "com.amazonaws.gamelift#MetricGroupList", + "PeerVpcId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

The name of an Amazon CloudWatch metric group to add this fleet to. A metric group\n aggregates the metrics for all fleets in the group. Specify an existing metric group\n name, or provide a new name to create a new metric group. A fleet can only be included\n in one metric group at a time.

" + "smithy.api#documentation": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" } }, - "ResourceCreationLimitPolicy": { - "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", + "LogPaths": { + "target": "com.amazonaws.gamelift#StringList", "traits": { - "smithy.api#documentation": "

A policy that limits the number of game sessions an individual player can create over\n a span of time for this fleet.

" + "smithy.api#documentation": "

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log\n files once a server process shuts down, use the Amazon GameLift server API\n ProcessReady() and specify one or more directory paths in\n logParameters. See more information in the Server API Reference.

" } }, - "BuildId": { - "target": "com.amazonaws.gamelift#BuildIdOrArn", + "RuntimeConfiguration": { + "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "

A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value.\n The custom game server build must have been successfully uploaded to Amazon GameLift and be in a\n READY status. This fleet setting cannot be changed once the fleet is\n created.

" + "smithy.api#documentation": "

Instructions for launching server processes on each instance in the fleet. Server\n processes run either a custom game build executable or a Realtime script. The runtime\n configuration defines the server executables or launch script file, launch parameters,\n and the number of processes to run concurrently on each instance. When creating a fleet,\n the runtime configuration must have at least one server process configuration; otherwise\n the request fails with an invalid request exception. (This parameter replaces the\n parameters ServerLaunchPath and ServerLaunchParameters,\n although requests that contain values for these parameters instead of a runtime\n configuration will continue to work.) This parameter is required unless the parameters \n ServerLaunchPath and ServerLaunchParameters are defined. Runtime \n configuration replaced these parameters, but fleets that use them will continue to work.

" } }, - "NewGameSessionProtectionPolicy": { - "target": "com.amazonaws.gamelift#ProtectionPolicy", + "Tags": { + "target": "com.amazonaws.gamelift#TagList", "traits": { - "smithy.api#documentation": "

A game session protection policy to apply to all instances in this fleet. If this\n parameter is not set, instances in this fleet default to no protection. You can change a\n fleet's protection policy using UpdateFleetAttributes, but this change\n will only affect sessions created after the policy change. You can also set protection\n for individual instances using UpdateGameSession.

\n " + "smithy.api#documentation": "

A list of labels to assign to the new fleet resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" + } + }, + "InstanceRoleArn": { + "target": "com.amazonaws.gamelift#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for an AWS IAM role that manages access to your AWS services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN from the IAM dashboard in the AWS Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server.

" + } + }, + "ResourceCreationLimitPolicy": { + "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", + "traits": { + "smithy.api#documentation": "

A policy that limits the number of game sessions an individual player can create over\n a span of time for this fleet.

" } }, "ScriptId": { @@ -795,29 +812,28 @@ "smithy.api#documentation": "

A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value.\n The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting\n cannot be changed once the fleet is created.

" } }, - "EC2InboundPermissions": { - "target": "com.amazonaws.gamelift#IpPermissionsList", + "PeerVpcAwsAccountId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Range of IP addresses and port settings that permit inbound traffic to access game\n sessions that are running on the fleet. For fleets using a custom game build, this\n parameter is required before game sessions running on the fleet can accept connections.\n For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime\n servers. You can specify multiple permission settings or add more by updating the\n fleet.

" + "smithy.api#documentation": "

A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift\n fleet with. You can find your account ID in the AWS Management Console under account settings.

" } }, - "EC2InstanceType": { - "target": "com.amazonaws.gamelift#EC2InstanceType", + "MetricGroups": { + "target": "com.amazonaws.gamelift#MetricGroupList", "traits": { - "smithy.api#documentation": "

The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type\n determines the computing resources of each instance in the fleet, including CPU, memory,\n storage, and networking capacity. Amazon GameLift supports the following EC2 instance types.\n See Amazon EC2 Instance Types\n for detailed descriptions.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of an Amazon CloudWatch metric group to add this fleet to. A metric group\n aggregates the metrics for all fleets in the group. Specify an existing metric group\n name, or provide a new name to create a new metric group. A fleet can only be included\n in one metric group at a time.

" } }, - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "BuildId": { + "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { - "smithy.api#documentation": "

A human-readable description of a fleet.

" + "smithy.api#documentation": "

A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value.\n The custom game server build must have been successfully uploaded to Amazon GameLift and be in a\n READY status. This fleet setting cannot be changed once the fleet is\n created.

" } }, - "ServerLaunchParameters": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "NewGameSessionProtectionPolicy": { + "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "

This parameter is no longer used. Instead, specify server launch parameters in the\n RuntimeConfiguration parameter. (Requests that specify a server launch\n path and launch parameters instead of a runtime configuration will continue to\n work.)

" + "smithy.api#documentation": "

A game session protection policy to apply to all instances in this fleet. If this\n parameter is not set, instances in this fleet default to no protection. You can change a\n fleet's protection policy using UpdateFleetAttributes, but this change\n will only affect sessions created after the policy change. You can also set protection\n for individual instances using UpdateGameSession.

\n " } }, "FleetType": { @@ -826,40 +842,28 @@ "smithy.api#documentation": "

Indicates whether to use On-Demand instances or Spot instances for this fleet. If\n empty, the default is ON_DEMAND. Both categories of instances use identical\n hardware and configurations based on the instance type selected for this fleet. Learn\n more about On-Demand versus Spot Instances.

" } }, - "CertificateConfiguration": { - "target": "com.amazonaws.gamelift#CertificateConfiguration", + "EC2InboundPermissions": { + "target": "com.amazonaws.gamelift#IpPermissionsList", "traits": { - "smithy.api#documentation": "

Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS\n certificates are used for encrypting traffic between game clients and game servers\n running on GameLift. If this parameter is not specified, the default value, DISABLED, is\n used. This fleet setting cannot be changed once the fleet is created. Learn more at\n Securing Client/Server Communication.

\n

Note: This feature requires the AWS Certificate Manager (ACM) service, which is\n available in the AWS global partition but not in all other partitions. When working in a\n partition that does not support this feature, a request for a new fleet with certificate\n generation results fails with a 4xx unsupported Region error.

\n

Valid values include:

\n " + "smithy.api#documentation": "

Range of IP addresses and port settings that permit inbound traffic to access game\n sessions that are running on the fleet. For fleets using a custom game build, this\n parameter is required before game sessions running on the fleet can accept connections.\n For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime\n servers. You can specify multiple permission settings or add more by updating the\n fleet.

" } }, - "ServerLaunchPath": { + "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

This parameter is no longer used. Instead, specify a server launch path using the\n RuntimeConfiguration parameter. Requests that specify a server launch\n path and launch parameters instead of a runtime configuration will continue to\n work.

" + "smithy.api#documentation": "

A human-readable description of a fleet.

" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "EC2InstanceType": { + "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

", + "smithy.api#documentation": "

The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type\n determines the computing resources of each instance in the fleet, including CPU, memory,\n storage, and networking capacity. Amazon GameLift supports the following EC2 instance types.\n See Amazon EC2 Instance Types\n for detailed descriptions.

", "smithy.api#required": {} } - }, - "LogPaths": { - "target": "com.amazonaws.gamelift#StringList", - "traits": { - "smithy.api#documentation": "

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log\n files once a server process shuts down, use the Amazon GameLift server API\n ProcessReady() and specify one or more directory paths in\n logParameters. See more information in the Server API Reference.

" - } - }, - "PeerVpcId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" - } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateFleetOutput": { @@ -873,7 +877,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateGameServerGroup": { @@ -902,82 +906,82 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Creates a GameLift FleetIQ game server group to manage a collection of EC2 instances for game\n hosting. In addition to creating the game server group, this action also creates an Auto\n Scaling group in your AWS account and establishes a link between the two groups. You\n have full control over configuration of the Auto Scaling group, but GameLift FleetIQ routinely\n certain Auto Scaling group properties in order to optimize the group's instances for\n low-cost game hosting. You can view the status of your game server groups in the GameLift\n Console. Game server group metrics and events are emitted to Amazon CloudWatch.

\n

Prior creating a new game server group, you must set up the following:

\n \n

To create a new game server group, provide a name and specify the IAM role and EC2\n launch template. You also need to provide a list of instance types to be used in the\n group and set initial maximum and minimum limits on the group's instance count. You can\n optionally set an autoscaling policy with target tracking based on a GameLift FleetIQ metric.

\n

Once the game server group and corresponding Auto Scaling group are created, you have\n full access to change the Auto Scaling group's configuration as needed. Keep in mind,\n however, that some properties are periodically updated by GameLift FleetIQ as it balances the\n group's instances based on availability and cost.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Updating a GameLift FleetIQ-Linked Auto Scaling Group\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Creates a GameLift FleetIQ game server group for managing game hosting on a collection of\n Amazon EC2 instances for game hosting. This operation creates the game server group,\n creates an Auto Scaling group in your AWS account, and establishes a link between the\n two groups. You can view the status of your game server groups in the GameLift console.\n Game server group metrics and events are emitted to Amazon CloudWatch.

\n

Before creating a new game server group, you must have the following:

\n \n

To create a new game server group, specify a unique group name, IAM role and Amazon EC2\n launch template, and provide a list of instance types that can be used in the group. You\n must also set initial maximum and minimum limits on the group's instance count. You can\n optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ\n metric.

\n

Once the game server group and corresponding Auto Scaling group are created, you have\n full access to change the Auto Scaling group's configuration as needed. Several\n properties that are set when creating a game server group, including maximum/minimum\n size and auto-scaling policy settings, must be updated directly in the Auto Scaling\n group. Keep in mind that some Auto Scaling group properties are periodically updated by\n GameLift FleetIQ as part of its balancing activities to optimize for availability and\n cost.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#CreateGameServerGroupInput": { "type": "structure", "members": { - "MaxSize": { - "target": "com.amazonaws.gamelift#PositiveInteger", + "RoleArn": { + "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { - "smithy.api#documentation": "

The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling\n events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups.

", "smithy.api#required": {} } }, - "VpcSubnets": { - "target": "com.amazonaws.gamelift#VpcSubnets", + "MaxSize": { + "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

A list of virtual private cloud (VPC) subnets to use with instances in the game server\n group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter\n allows you to specify VPCs that you've set up.

" + "smithy.api#documentation": "

The maximum number of instances allowed in the EC2 Auto Scaling group. During\n automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.\n After the Auto Scaling group is created, update this value directly in the Auto Scaling\n group using the AWS console or APIs.

", + "smithy.api#required": {} } }, - "InstanceDefinitions": { - "target": "com.amazonaws.gamelift#InstanceDefinitions", + "AutoScalingPolicy": { + "target": "com.amazonaws.gamelift#GameServerGroupAutoScalingPolicy", "traits": { - "smithy.api#documentation": "

A set of EC2 instance types to use when creating instances in the group. The instance\n definitions must specify at least two different instance types that are supported by\n GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the\n Amazon EC2 User Guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Configuration settings to define a scaling policy for the Auto Scaling group that is\n optimized for game hosting. The scaling policy uses the metric\n \"PercentUtilizedGameServers\" to maintain a buffer of idle game servers\n that can immediately accommodate new games and players. After the Auto Scaling group is\n created, update this value directly in the Auto Scaling group using the AWS console or\n APIs.

" } }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new game server group resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management, and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A list of labels to assign to the new game server group resource. Tags are\n developer-defined key-value pairs. Tagging AWS resources is useful for resource\n management, access management, and cost allocation. For more information, see Tagging AWS\n Resources in the AWS General Reference. Once the\n resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove,\n and view tags, respectively. The maximum tag limit may be lower than stated. See the\n AWS General Reference for actual tagging limits.

" } }, - "RoleArn": { - "target": "com.amazonaws.gamelift#IamRoleArn", + "InstanceDefinitions": { + "target": "com.amazonaws.gamelift#InstanceDefinitions", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to\n ensure that it contains the necessary permissions for game server groups.

", + "smithy.api#documentation": "

The EC2 instance types and sizes to use in the Auto Scaling group. The instance\n definitions must specify at least two different instance types that are supported by\n GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the\n Amazon EC2 User Guide. You can optionally specify capacity\n weighting for each instance type. If no weight value is specified for an instance type,\n it is set to the default value \"1\". For more information about capacity weighting, see\n Instance Weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", "smithy.api#required": {} } }, - "BalancingStrategy": { - "target": "com.amazonaws.gamelift#BalancingStrategy", - "traits": { - "smithy.api#documentation": "

The fallback balancing method to use for the game server group when Spot instances in\n a Region become unavailable or are not viable for game hosting. Once triggered, this\n method remains active until Spot instances can once again be used. Method options\n include:

\n " - } - }, "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { - "smithy.api#documentation": "

An identifier for the new game server group. This value is used to generate unique \n ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. \n The name must be unique per Region per AWS account.

", + "smithy.api#documentation": "

An identifier for the new game server group. This value is used to generate unique ARN\n identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name\n must be unique per Region per AWS account.

", "smithy.api#required": {} } }, - "MinSize": { - "target": "com.amazonaws.gamelift#WholeNumber", + "BalancingStrategy": { + "target": "com.amazonaws.gamelift#BalancingStrategy", "traits": { - "smithy.api#documentation": "

The minimum number of instances allowed in the EC2 Auto Scaling group. During\n autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In\n production, this value should be set to at least 1.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:

\n " } }, - "AutoScalingPolicy": { - "target": "com.amazonaws.gamelift#GameServerGroupAutoScalingPolicy", + "VpcSubnets": { + "target": "com.amazonaws.gamelift#VpcSubnets", "traits": { - "smithy.api#documentation": "

Configuration settings to define a scaling policy for the Auto Scaling group that is\n optimized for game hosting. The scaling policy uses the metric\n \"PercentUtilizedGameServers\" to maintain a buffer of idle game servers that can\n immediately accommodate new games and players. Once the game server and Auto Scaling\n groups are created, you can update the scaling policy settings directly in Auto Scaling\n Groups.

" + "smithy.api#documentation": "

A list of virtual private cloud (VPC) subnets to use with instances in the game server\n group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this\n parameter to specify VPCs that you've set up. This property cannot be updated after the\n game server group is created, and the corresponding Auto Scaling group will always use\n the property value that is set with this request, even if the Auto Scaling group is\n updated directly

" } }, "LaunchTemplate": { "target": "com.amazonaws.gamelift#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in the game server group. You can specify the template\n using either the template name or ID. For help with creating a launch template, see\n Creating a Launch\n Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling\n User Guide.

", + "smithy.api#documentation": "

The EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in the game server group. You can specify the template\n using either the template name or ID. For help with creating a launch template, see\n Creating a Launch\n Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling\n User Guide. After the Auto Scaling group is created, update this value\n directly in the Auto Scaling group using the AWS console or APIs.

", + "smithy.api#required": {} + } + }, + "MinSize": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The minimum number of instances allowed in the EC2 Auto Scaling group. During\n automatic scaling events, GameLift FleetIQ and EC2 do not scale down the group below this\n minimum. In production, this value should be set to at least 1. After the Auto Scaling\n group is created, update this value directly in the Auto Scaling group using the AWS\n console or APIs.

", "smithy.api#required": {} } }, "GameServerProtectionPolicy": { "target": "com.amazonaws.gamelift#GameServerProtectionPolicy", "traits": { - "smithy.api#documentation": "

A flag that indicates whether instances in the game server group are protected from\n early termination. Unprotected instances that have active game servers running may by\n terminated during a scale-down event, causing players to be dropped from the game.\n Protected instances cannot be terminated while there are active game servers running. An\n exception to this is Spot Instances, which may be terminated by AWS regardless of\n protection status. This property is set to NO_PROTECTION by default.

" + "smithy.api#documentation": "

A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

" } } } @@ -988,7 +992,7 @@ "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { - "smithy.api#documentation": "

The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group\n and the object's status. \n The EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is \n added once the game server group status reaches ACTIVE.

" + "smithy.api#documentation": "

The newly created game server group object, including the new ARN value for the GameLift FleetIQ\n game server group and the object's status. The EC2 Auto Scaling group ARN is initially\n null, since the group has not yet been created. This value is added once the game server\n group status reaches ACTIVE.

" } } } @@ -1034,12 +1038,18 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a multiplayer game session for players. This action creates a game session\n record and assigns an available server process in the specified fleet to host the game\n session. A fleet must have an ACTIVE status before a game session can be\n created in it.

\n

To create a game session, specify either fleet ID or alias ID and indicate a\n maximum number of players to allow in the game session. You can also provide a name and\n game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties\n and other settings you specified.

\n

\n Idempotency tokens. You can add a token that\n uniquely identifies game session requests. This is useful for ensuring that game session\n requests are idempotent. Multiple requests with the same idempotency token are processed\n only once; subsequent requests return the original result. All response values are the\n same with the exception of game session status, which may change.

\n

\n Resource creation limits. If you are creating a\n game session on a fleet with a resource creation limit policy in force, then you must\n specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this\n new game session request.

\n

\n Player acceptance policy. By default, newly created\n game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation\n policy.

\n

\n Game session logs. Logs are retained for all\n active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

\n

\n Available in Amazon GameLift Local.\n

\n " + "smithy.api#documentation": "

Creates a multiplayer game session for players. This operation creates a game session\n record and assigns an available server process in the specified fleet to host the game\n session. A fleet must have an ACTIVE status before a game session can be\n created in it.

\n

To create a game session, specify either fleet ID or alias ID and indicate a\n maximum number of players to allow in the game session. You can also provide a name and\n game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties\n and other settings you specified.

\n

\n Idempotency tokens. You can add a token that\n uniquely identifies game session requests. This is useful for ensuring that game session\n requests are idempotent. Multiple requests with the same idempotency token are processed\n only once; subsequent requests return the original result. All response values are the\n same with the exception of game session status, which may change.

\n

\n Resource creation limits. If you are creating a\n game session on a fleet with a resource creation limit policy in force, then you must\n specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this\n new game session request.

\n

\n Player acceptance policy. By default, newly created\n game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation\n policy.

\n

\n Game session logs. Logs are retained for all\n active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

\n

\n Available in Amazon GameLift Local.\n

\n " } }, "com.amazonaws.gamelift#CreateGameSessionInput": { "type": "structure", "members": { + "AliasId": { + "target": "com.amazonaws.gamelift#AliasIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the\n alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but\n not both.

" + } + }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -1047,10 +1057,10 @@ "smithy.api#required": {} } }, - "AliasId": { - "target": "com.amazonaws.gamelift#AliasIdOrArn", + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the\n alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but\n not both.

" + "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" } }, "CreatorId": { @@ -1058,11 +1068,11 @@ "traits": { "smithy.api#documentation": "

A unique identifier for a player or entity creating the game session. This ID is used to enforce a\n resource protection policy (if one exists) that limits the number of concurrent active\n game sessions one player can have.

" } - }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + }, + "GameSessionData": { + "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" + "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, "GameProperties": { @@ -1071,16 +1081,16 @@ "smithy.api#documentation": "

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, - "GameSessionData": { - "target": "com.amazonaws.gamelift#GameSessionData", + "GameSessionId": { + "target": "com.amazonaws.gamelift#IdStringModel", "traits": { - "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

\n This parameter is no longer preferred. Please use\n IdempotencyToken instead. Custom string that uniquely\n identifies a request for a new game session. Maximum token length is 48 characters. If\n provided, this string is included in the new game session's ID. (A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//.)

" } }, - "GameSessionId": { + "IdempotencyToken": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { - "smithy.api#documentation": "

\n This parameter is no longer preferred. Please use\n IdempotencyToken instead. Custom string that uniquely\n identifies a request for a new game session. Maximum token length is 48 characters. If\n provided, this string is included in the new game session's ID. (A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//.)

" + "smithy.api#documentation": "

Custom string that uniquely identifies a request for a new game session. Maximum\n token length is 48 characters. If provided, this string is included in the new game\n session's ID. (A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//.) Idempotency tokens remain in use for 30 days after a game\n session has ended; game session objects are retained for this time period and then\n deleted.

" } }, "FleetId": { @@ -1088,16 +1098,10 @@ "traits": { "smithy.api#documentation": "

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each\n request must reference either a fleet ID or alias ID, but not both.

" } - }, - "IdempotencyToken": { - "target": "com.amazonaws.gamelift#IdStringModel", - "traits": { - "smithy.api#documentation": "

Custom string that uniquely identifies a request for a new game session. Maximum\n token length is 48 characters. If provided, this string is included in the new game\n session's ID. (A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//.) Idempotency tokens remain in use for 30 days after a game\n session has ended; game session objects are retained for this time period and then\n deleted.

" - } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateGameSessionOutput": { @@ -1111,7 +1115,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateGameSessionQueue": { @@ -1146,10 +1150,16 @@ "com.amazonaws.gamelift#CreateGameSessionQueueInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.gamelift#TagList", + "PlayerLatencyPolicies": { + "target": "com.amazonaws.gamelift#PlayerLatencyPolicyList", "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new game session queue resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

A collection of latency policies to apply when processing game sessions placement requests with \n player latency information. Multiple policies are evaluated in order of the maximum latency value, \n starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session \n placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. \n For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the \n remainder of the placement. A player latency policy must set a value for\n MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API\n request fails.

" + } + }, + "Destinations": { + "target": "com.amazonaws.gamelift#GameSessionQueueDestinationList", + "traits": { + "smithy.api#documentation": "

A list of fleets that can be used to fulfill game session placement requests in the queue. \n Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

" } }, "Name": { @@ -1159,10 +1169,10 @@ "smithy.api#required": {} } }, - "Destinations": { - "target": "com.amazonaws.gamelift#GameSessionQueueDestinationList", + "Tags": { + "target": "com.amazonaws.gamelift#TagList", "traits": { - "smithy.api#documentation": "

A list of fleets that can be used to fulfill game session placement requests in the queue. \n Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

" + "smithy.api#documentation": "

A list of labels to assign to the new game session queue resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" } }, "TimeoutInSeconds": { @@ -1170,16 +1180,10 @@ "traits": { "smithy.api#documentation": "

The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

" } - }, - "PlayerLatencyPolicies": { - "target": "com.amazonaws.gamelift#PlayerLatencyPolicyList", - "traits": { - "smithy.api#documentation": "

A collection of latency policies to apply when processing game sessions placement requests with \n player latency information. Multiple policies are evaluated in order of the maximum latency value, \n starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session \n placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. \n For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the \n remainder of the placement. A player latency policy must set a value for\n MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API\n request fails.

" - } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateGameSessionQueueOutput": { @@ -1193,7 +1197,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateMatchmakingConfiguration": { @@ -1225,74 +1229,68 @@ } ], "traits": { - "smithy.api#documentation": "

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking\n configuration sets out guidelines for matching players and getting the matches into\n games. You can set up multiple matchmaking configurations to handle the scenarios needed\n for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides\n player attributes to support the configuration being used.

\n

To create a matchmaking configuration, at a minimum you must specify the following:\n configuration name; a rule set that governs how to evaluate players and find acceptable\n matches; a game session queue to use when placing a new game session for the match; and\n the maximum time allowed for a matchmaking attempt.

\n

There are two ways to track the progress of matchmaking tickets: (1) polling ticket\n status with DescribeMatchmaking; or (2) receiving notifications with\n Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the\n notifications, and provide the topic ARN in the matchmaking configuration. Since\n notifications promise only \"best effort\" delivery, we recommend calling\n DescribeMatchmaking if no notifications are received within 30\n seconds.

\n

\n Learn more\n

\n

\n \n Design a FlexMatch Matchmaker\n

\n

\n Setting up\n Notifications for Matchmaking\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking\n configuration sets out guidelines for matching players and getting the matches into\n games. You can set up multiple matchmaking configurations to handle the scenarios needed\n for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides\n player attributes to support the configuration being used.

\n

To create a matchmaking configuration, at a minimum you must specify the following:\n configuration name; a rule set that governs how to evaluate players and find acceptable\n matches; a game session queue to use when placing a new game session for the match; and\n the maximum time allowed for a matchmaking attempt.

\n

To track the progress of matchmaking tickets, set up an Amazon Simple Notification Service (SNS) to receive\n notifications, and provide the topic ARN in the matchmaking configuration. An\n alternative method, continuously poling ticket status with DescribeMatchmaking, should only be used for games in development with\n low matchmaking usage.

\n

\n Learn more\n

\n

\n \n Design a FlexMatch Matchmaker\n

\n

\n \n Set Up FlexMatch Event Notification\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#CreateMatchmakingConfigurationInput": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

A human-readable description of the matchmaking configuration.

" - } - }, - "GameProperties": { - "target": "com.amazonaws.gamelift#GamePropertyList", + "RequestTimeoutSeconds": { + "target": "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + "smithy.api#documentation": "

The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.

", + "smithy.api#required": {} } }, - "NotificationTarget": { - "target": "com.amazonaws.gamelift#SnsArnStringModel", + "BackfillMode": { + "target": "com.amazonaws.gamelift#BackfillMode", "traits": { - "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications.

" + "smithy.api#documentation": "

The method used to backfill game sessions that are created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests\n manually or does not use the match backfill feature. Specify AUTOMATIC to\n have GameLift create a StartMatchBackfill request whenever a game\n session has one or more open slots. Learn more about manual and automatic backfill in\n Backfill Existing Games with FlexMatch.

" } }, - "Name": { - "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", + "AcceptanceRequired": { + "target": "com.amazonaws.gamelift#BooleanModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.

", + "smithy.api#documentation": "

A flag that determines whether a match that was created with this configuration must\n be accepted by the matched players. To require acceptance, set to\n TRUE.

", "smithy.api#required": {} } }, - "CustomEventData": { - "target": "com.amazonaws.gamelift#CustomEventData", + "RuleSetName": { + "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", "traits": { - "smithy.api#documentation": "

Information to be added to all events related to this matchmaking configuration.\n

" + "smithy.api#documentation": "

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN\n value. A matchmaking configuration can only use rule sets that are defined in the same\n Region.

", + "smithy.api#required": {} } }, - "RequestTimeoutSeconds": { - "target": "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger", + "AcceptanceTimeoutSeconds": { + "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", "traits": { - "smithy.api#documentation": "

The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The length of time (in seconds) to wait for players to accept a proposed match. If any\n player rejects the match or fails to accept before the timeout, the ticket continues to\n look for an acceptable match.

" } }, - "BackfillMode": { - "target": "com.amazonaws.gamelift#BackfillMode", + "AdditionalPlayerCount": { + "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

The method used to backfill game sessions that are created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests\n manually or does not use the match backfill feature. Specify AUTOMATIC to\n have GameLift create a StartMatchBackfill request whenever a game\n session has one or more open slots. Learn more about manual and automatic backfill in\n Backfill Existing Games with FlexMatch.

" + "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, \n assume that the configuration's rule set specifies a match for a single 12-person team. If\n the additional player count is set to 2, only 10 players are initially selected for the match.

" } }, - "AcceptanceTimeoutSeconds": { - "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", + "GameSessionQueueArns": { + "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { - "smithy.api#documentation": "

The length of time (in seconds) to wait for players to accept a proposed match. If any\n player rejects the match or fails to accept before the timeout, the ticket continues to\n look for an acceptable match.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues are used when placing game sessions for matches that are created\n with this matchmaking configuration. Queues can be located in any Region.

", + "smithy.api#required": {} } }, - "RuleSetName": { - "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", + "Tags": { + "target": "com.amazonaws.gamelift#TagList", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN\n value. A matchmaking configuration can only use rule sets that are defined in the same\n Region.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" } }, - "AcceptanceRequired": { - "target": "com.amazonaws.gamelift#BooleanModel", + "Description": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A flag that determines whether a match that was created with this configuration must\n be accepted by the matched players. To require acceptance, set to\n TRUE.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A human-readable description of the matchmaking configuration.

" } }, "GameSessionData": { @@ -1301,28 +1299,34 @@ "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match.

" } }, - "AdditionalPlayerCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "GameProperties": { + "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, \n assume that the configuration's rule set specifies a match for a single 12-person team. If\n the additional player count is set to 2, only 10 players are initially selected for the match.

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" } }, - "Tags": { - "target": "com.amazonaws.gamelift#TagList", + "NotificationTarget": { + "target": "com.amazonaws.gamelift#SnsArnStringModel", "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" + "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications.

" } }, - "GameSessionQueueArns": { - "target": "com.amazonaws.gamelift#QueueArnsList", + "Name": { + "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues are used when placing game sessions for matches that are created\n with this matchmaking configuration. Queues can be located in any Region.

", + "smithy.api#documentation": "

A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.

", "smithy.api#required": {} } + }, + "CustomEventData": { + "target": "com.amazonaws.gamelift#CustomEventData", + "traits": { + "smithy.api#documentation": "

Information to be added to all events related to this matchmaking configuration.\n

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateMatchmakingConfigurationOutput": { @@ -1336,7 +1340,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSet": { @@ -1368,12 +1372,6 @@ "com.amazonaws.gamelift#CreateMatchmakingRuleSetInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.gamelift#TagList", - "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" - } - }, "RuleSetBody": { "target": "com.amazonaws.gamelift#RuleSetBody", "traits": { @@ -1381,6 +1379,12 @@ "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.gamelift#TagList", + "traits": { + "smithy.api#documentation": "

A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" + } + }, "Name": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { @@ -1390,7 +1394,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSetOutput": { @@ -1405,7 +1409,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSession": { @@ -1446,12 +1450,6 @@ "com.amazonaws.gamelift#CreatePlayerSessionInput": { "type": "structure", "members": { - "PlayerData": { - "target": "com.amazonaws.gamelift#PlayerData", - "traits": { - "smithy.api#documentation": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" - } - }, "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { @@ -1459,6 +1457,12 @@ "smithy.api#required": {} } }, + "PlayerData": { + "target": "com.amazonaws.gamelift#PlayerData", + "traits": { + "smithy.api#documentation": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" + } + }, "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { @@ -1468,7 +1472,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSessionOutput": { @@ -1482,7 +1486,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSessions": { @@ -1530,22 +1534,22 @@ "smithy.api#required": {} } }, + "PlayerDataMap": { + "target": "com.amazonaws.gamelift#PlayerDataMap", + "traits": { + "smithy.api#documentation": "

Map of string pairs, each specifying a player ID and a set of developer-defined\n information related to the player. Amazon GameLift does not use this data, so it can be formatted\n as needed for use in the game. Player data strings for player IDs not included in the\n PlayerIds parameter are ignored.

" + } + }, "PlayerIds": { "target": "com.amazonaws.gamelift#PlayerIdList", "traits": { "smithy.api#documentation": "

List of unique identifiers for the players to be added.

", "smithy.api#required": {} } - }, - "PlayerDataMap": { - "target": "com.amazonaws.gamelift#PlayerDataMap", - "traits": { - "smithy.api#documentation": "

Map of string pairs, each specifying a player ID and a set of developer-defined\n information related to the player. Amazon GameLift does not use this data, so it can be formatted\n as needed for use in the game. Player data strings for player IDs not included in the\n PlayerIds parameter are ignored.

" - } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreatePlayerSessionsOutput": { @@ -1559,7 +1563,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateScript": { @@ -1600,10 +1604,10 @@ "smithy.api#documentation": "

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.\n

" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "ZipFile": { + "target": "com.amazonaws.gamelift#ZipBlob", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.\n

" + "smithy.api#documentation": "

A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.

\n

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the \n string \"fileb://\" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

" } }, "Tags": { @@ -1612,10 +1616,10 @@ "smithy.api#documentation": "

A list of labels to assign to the new script resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" } }, - "ZipFile": { - "target": "com.amazonaws.gamelift#ZipBlob", + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.

\n

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the \n string \"fileb://\" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

" + "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.\n

" } }, "StorageLocation": { @@ -1666,23 +1670,23 @@ "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationInput": { "type": "structure", "members": { - "PeerVpcId": { + "GameLiftAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The\n VPC must be in the same Region where your fleet is deployed. Look up a VPC ID using the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", + "smithy.api#documentation": "

A unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. \n You can find your Account ID in the AWS Management Console under account settings.

", "smithy.api#required": {} } }, - "GameLiftAwsAccountId": { + "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. \n You can find your Account ID in the AWS Management Console under account settings.

", + "smithy.api#documentation": "

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The\n VPC must be in the same Region where your fleet is deployed. Look up a VPC ID using the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationOutput": { @@ -1696,7 +1700,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnection": { @@ -1728,13 +1732,6 @@ "com.amazonaws.gamelift#CreateVpcPeeringConnectionInput": { "type": "structure", "members": { - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift\n VPC to peer with.

", - "smithy.api#required": {} - } - }, "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { @@ -1748,10 +1745,17 @@ "smithy.api#documentation": "

A unique identifier for the AWS account with the VPC that you want to peer your\n Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account\n settings.

", "smithy.api#required": {} } + }, + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", + "traits": { + "smithy.api#documentation": "

A unique identifier for a fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift\n VPC to peer with.

", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnectionOutput": { @@ -1790,7 +1794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an alias. This action removes all record of the alias. Game clients\n attempting to access a server process using the deleted alias receive an error. To\n delete an alias, specify the alias ID to be deleted.

\n " + "smithy.api#documentation": "

Deletes an alias. This operation removes all record of the alias. Game clients\n attempting to access a server process using the deleted alias receive an error. To\n delete an alias, specify the alias ID to be deleted.

\n " } }, "com.amazonaws.gamelift#DeleteAliasInput": { @@ -1805,7 +1809,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteBuild": { @@ -1831,7 +1835,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a build. This action permanently deletes the build resource and any uploaded\n build files. Deleting a build does not affect the status of any active fleets using the\n build, but you can no longer create new fleets with the deleted build.

\n

To delete a build, specify the build ID.

\n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Deletes a build. This operation permanently deletes the build resource and any uploaded\n build files. Deleting a build does not affect the status of any active fleets using the\n build, but you can no longer create new fleets with the deleted build.

\n

To delete a build, specify the build ID.

\n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DeleteBuildInput": { @@ -1846,7 +1850,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteFleet": { @@ -1875,7 +1879,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes everything related to a fleet. Before deleting a fleet, you must set the\n fleet's desired capacity to zero. See UpdateFleetCapacity.

\n

If the fleet being deleted has a VPC peering connection, you first need to get a \n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. \n You do not need to explicitly delete the VPC peering connection--this is done as part of the \n delete fleet process.

\n

This action removes the fleet and its resources. Once a fleet is deleted, you can no\n longer use any of the resource in that fleet.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Deletes everything related to a fleet. Before deleting a fleet, you must set the\n fleet's desired capacity to zero. See UpdateFleetCapacity.

\n

If the fleet being deleted has a VPC peering connection, you first need to get a \n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. \n You do not need to explicitly delete the VPC peering connection--this is done as part of the \n delete fleet process.

\n

This operation removes the fleet and its resources. Once a fleet is deleted, you can no\n longer use any of the resource in that fleet.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DeleteFleetInput": { @@ -1890,7 +1894,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteGameServerGroup": { @@ -1916,7 +1920,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Terminates a game server group and permanently deletes the game server group record.\n You have several options for how these resources are impacted when deleting the game\n server group. Depending on the type of delete action selected, this action may affect\n three types of resources: the game server group, the corresponding Auto Scaling group,\n and all game servers currently running in the group.

\n

To delete a game server group, identify the game server group to delete and specify\n the type of delete action to initiate. Game server groups can only be deleted if they\n are in ACTIVE or ERROR status.

\n

If the delete request is successful, a series of actions are kicked off. The game\n server group status is changed to DELETE_SCHEDULED, which prevents new game servers from\n being registered and stops autoscaling activity. Once all game servers in the game\n server group are de-registered, GameLift FleetIQ can begin deleting resources. If any of the delete\n actions fail, the game server group is placed in ERROR status.

\n

GameLift FleetIQ emits delete events to Amazon CloudWatch.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Terminates a game server group and permanently deletes the game server group record.\n You have several options for how these resources are impacted when deleting the game\n server group. Depending on the type of delete operation selected, this operation might\n affect these resources:

\n \n

To delete a game server group, identify the game server group to delete and specify\n the type of delete operation to initiate. Game server groups can only be deleted if they\n are in ACTIVE or ERROR status.

\n

If the delete request is successful, a series of operations are kicked off. The game\n server group status is changed to DELETE_SCHEDULED, which prevents new game\n servers from being registered and stops automatic scaling activity. Once all game\n servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources.\n If any of the delete operations fail, the game server group is placed in\n ERROR status.

\n

GameLift FleetIQ emits delete events to Amazon CloudWatch.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DeleteGameServerGroupInput": { @@ -1925,13 +1929,13 @@ "DeleteOption": { "target": "com.amazonaws.gamelift#GameServerGroupDeleteOption", "traits": { - "smithy.api#documentation": "

The type of delete to perform. Options include:

\n " + "smithy.api#documentation": "

The type of delete to perform. Options include the following:

\n " } }, "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the game server group to delete. Use either the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } } @@ -1943,7 +1947,7 @@ "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { - "smithy.api#documentation": "

An object that describes the deleted game server group resource, with status updated\n to DELETE_SCHEDULED.

" + "smithy.api#documentation": "

An object that describes the deleted game server group resource, with status updated\n to DELETE_SCHEDULED.

" } } } @@ -1974,7 +1978,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail.\n To delete a queue, specify the queue name.

\n

\n Learn more\n

\n

\n \n Using Multi-Region Queues\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail.\n To delete a queue, specify the queue name.

\n

\n Learn more\n

\n

\n \n Using Multi-Region Queues\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DeleteGameSessionQueueInput": { @@ -1989,7 +1993,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteGameSessionQueueOutput": { @@ -2037,7 +2041,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteMatchmakingConfigurationOutput": { @@ -2085,14 +2089,14 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteMatchmakingRuleSetOutput": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DeleteScalingPolicy": { @@ -2115,7 +2119,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a fleet scaling policy. This action means that the policy is no longer in\n force and removes all record of it. To delete a scaling policy, specify both the scaling\n policy name and the fleet ID it is associated with.

\n

To temporarily suspend scaling policies, call StopFleetActions.\n This operation suspends all policies for the fleet.

\n " + "smithy.api#documentation": "

Deletes a fleet scaling policy. Once deleted, the policy is no longer in\n force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling\n policy name and the fleet ID it is associated with.

\n

To temporarily suspend scaling policies, call StopFleetActions.\n This operation suspends all policies for the fleet.

\n " } }, "com.amazonaws.gamelift#DeleteScalingPolicyInput": { @@ -2137,7 +2141,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteScript": { @@ -2163,7 +2167,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Realtime script. This action permanently deletes the script record. If\n script files were uploaded, they are also deleted (files stored in an S3 bucket are not\n deleted).

\n

To delete a script, specify the script ID. Before deleting a script, be sure to\n terminate all fleets that are deployed with the script being deleted. Fleet instances\n periodically check for script updates, and if the script record no longer exists, the\n instance will go into an error state and be unable to host game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Deletes a Realtime script. This operation permanently deletes the script record. If\n script files were uploaded, they are also deleted (files stored in an S3 bucket are not\n deleted).

\n

To delete a script, specify the script ID. Before deleting a script, be sure to\n terminate all fleets that are deployed with the script being deleted. Fleet instances\n periodically check for script updates, and if the script record no longer exists, the\n instance will go into an error state and be unable to host game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DeleteScriptInput": { @@ -2223,7 +2227,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteVpcPeeringAuthorizationOutput": { @@ -2259,23 +2263,23 @@ "com.amazonaws.gamelift#DeleteVpcPeeringConnectionInput": { "type": "structure", "members": { - "VpcPeeringConnectionId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", "traits": { - "smithy.api#documentation": "

A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

", + "smithy.api#documentation": "

A unique identifier for a fleet. This fleet specified must match the fleet referenced in the VPC peering\n connection record. You can use either the fleet ID or ARN value.

", "smithy.api#required": {} } }, - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + "VpcPeeringConnectionId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet. This fleet specified must match the fleet referenced in the VPC peering\n connection record. You can use either the fleet ID or ARN value.

", + "smithy.api#documentation": "

A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DeleteVpcPeeringConnectionOutput": { @@ -2302,23 +2306,23 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Removes the game server resource from the game server group. As a result of this\n action, the de-registered game server can no longer be claimed and will not returned in\n a list of active game servers.

\n

To de-register a game server, specify the game server group and game server ID. If\n successful, this action emits a CloudWatch event with termination time stamp and\n reason.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Removes the game server from a game server group. As a result of this operation, the\n deregistered game server can no longer be claimed and will not be returned in a list of\n active game servers.

\n

To deregister a game server, specify the game server group and game server ID. If\n successful, this operation emits a CloudWatch event with termination timestamp and\n reason.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DeregisterGameServerInput": { "type": "structure", "members": { - "GameServerGroupName": { - "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", + "GameServerId": { + "target": "com.amazonaws.gamelift#GameServerId", "traits": { - "smithy.api#documentation": "

An identifier for the game server group where the game server to be de-registered is\n running. Use either the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A custom string that uniquely identifies the game server to deregister.

", "smithy.api#required": {} } }, - "GameServerId": { - "target": "com.amazonaws.gamelift#GameServerId", + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

The identifier for the game server to be de-registered.

", + "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } } @@ -2362,7 +2366,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeAliasOutput": { @@ -2376,7 +2380,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeBuild": { @@ -2417,7 +2421,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeBuildOutput": { @@ -2431,7 +2435,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimits": { @@ -2468,7 +2472,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimitsOutput": { @@ -2482,7 +2486,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetAttributes": { @@ -2508,16 +2512,21 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves core properties, including configuration, status, and metadata, for a fleet.

\n

To get attributes for one or more fleets, provide a list of fleet IDs or fleet ARNs.\n To get attributes for all fleets, do not specify a fleet identifier. When requesting\n attributes for multiple fleets, use the pagination parameters to retrieve results as a\n set of sequential pages. If successful, a FleetAttributes object is\n returned for each fleet requested, unless the fleet identifier is not found.

\n \n

Some API actions may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed number.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves core properties, including configuration, status, and metadata, for a fleet.

\n

To get attributes for one or more fleets, provide a list of fleet IDs or fleet ARNs.\n To get attributes for all fleets, do not specify a fleet identifier. When requesting\n attributes for multiple fleets, use the pagination parameters to retrieve results as a\n set of sequential pages. If successful, a FleetAttributes object is\n returned for each fleet requested, unless the fleet identifier is not found.

\n \n

Some API operations may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed number.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeFleetAttributesInput": { "type": "structure", "members": { - "FleetIds": { - "target": "com.amazonaws.gamelift#FleetIdOrArnList", + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A list of unique fleet identifiers to retrieve attributes for. You can use either the\n fleet ID or ARN value. To retrieve attributes for all current fleets, do not include\n this parameter. If the list of fleet identifiers includes fleets that don't currently\n exist, the request succeeds but no attributes for that fleet are returned.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

" } }, "Limit": { @@ -2526,15 +2535,15 @@ "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

" } }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "FleetIds": { + "target": "com.amazonaws.gamelift#FleetIdOrArnList", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

" + "smithy.api#documentation": "

A list of unique fleet identifiers to retrieve attributes for. You can use either the\n fleet ID or ARN value. To retrieve attributes for all current fleets, do not include\n this parameter. If the list of fleet identifiers includes fleets that don't currently\n exist, the request succeeds but no attributes for that fleet are returned.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetAttributesOutput": { @@ -2549,12 +2558,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetCapacity": { @@ -2580,7 +2589,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the current capacity statistics for one or more fleets. These statistics\n present a snapshot of the fleet's instances and provide insight on current or imminent\n scaling activity. To get statistics on game hosting activity in the fleet, see DescribeFleetUtilization.

\n

You can request capacity for all fleets or specify a list of one or more fleet\n identifiers. When requesting multiple fleets, use the pagination parameters to retrieve\n results as a set of sequential pages. If successful, a FleetCapacity\n object is returned for each requested fleet ID. When a list of fleet IDs is provided,\n attribute objects are returned only for fleets that currently exist.

\n \n

Some API actions may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n GameLift Metrics for Fleets\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves the current capacity statistics for one or more fleets. These statistics\n present a snapshot of the fleet's instances and provide insight on current or imminent\n scaling activity. To get statistics on game hosting activity in the fleet, see DescribeFleetUtilization.

\n

You can request capacity for all fleets or specify a list of one or more fleet\n identifiers. When requesting multiple fleets, use the pagination parameters to retrieve\n results as a set of sequential pages. If successful, a FleetCapacity\n object is returned for each requested fleet ID. When a list of fleet IDs is provided,\n attribute objects are returned only for fleets that currently exist.

\n \n

Some API operations may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n GameLift Metrics for Fleets\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeFleetCapacityInput": { @@ -2601,12 +2615,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetCapacityOutput": { @@ -2621,12 +2635,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetEvents": { @@ -2652,22 +2666,21 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves entries from the specified fleet's event log. You can specify a time\n range to limit the result set. Use the pagination parameters to retrieve results as a\n set of sequential pages. If successful, a collection of event log entries matching the\n request are returned.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves entries from the specified fleet's event log. You can specify a time\n range to limit the result set. Use the pagination parameters to retrieve results as a\n set of sequential pages. If successful, a collection of event log entries matching the\n request are returned.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeFleetEventsInput": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.gamelift#Timestamp", - "traits": { - "smithy.api#documentation": "

Most recent date to retrieve event logs for. If no end time is specified, this call\n returns entries from the specified start time up to the present. Format is a number\n expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" - } - }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } }, "StartTime": { @@ -2688,10 +2701,16 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" } + }, + "EndTime": { + "target": "com.amazonaws.gamelift#Timestamp", + "traits": { + "smithy.api#documentation": "

Most recent date to retrieve event logs for. If no end time is specified, this call\n returns entries from the specified start time up to the present. Format is a number\n expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetEventsOutput": { @@ -2700,7 +2719,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, "Events": { @@ -2711,7 +2730,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetPortSettings": { @@ -2752,7 +2771,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsOutput": { @@ -2766,7 +2785,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetUtilization": { @@ -2792,12 +2811,23 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves utilization statistics for one or more fleets. These statistics provide\n insight into how available hosting resources are currently being used. To get statistics\n on available hosting resources, see DescribeFleetCapacity.

\n

You can request utilization data for all fleets, or specify a list of one or more\n fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve\n results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not\n found.

\n \n

Some API actions may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n GameLift Metrics for Fleets\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves utilization statistics for one or more fleets. These statistics provide\n insight into how available hosting resources are currently being used. To get statistics\n on available hosting resources, see DescribeFleetCapacity.

\n

You can request utilization data for all fleets, or specify a list of one or more\n fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve\n results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not\n found.

\n \n

Some API operations may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n GameLift Metrics for Fleets\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeFleetUtilizationInput": { "type": "structure", "members": { + "FleetIds": { + "target": "com.amazonaws.gamelift#FleetIdOrArnList", + "traits": { + "smithy.api#documentation": "

A unique identifier for a fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN\n value. To retrieve attributes for all current fleets, do not include this parameter. If\n the list of fleet identifiers includes fleets that don't currently exist, the request\n succeeds but no attributes for that fleet are returned.

" + } + }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { @@ -2807,18 +2837,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

" - } - }, - "FleetIds": { - "target": "com.amazonaws.gamelift#FleetIdOrArnList", - "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN\n value. To retrieve attributes for all current fleets, do not include this parameter. If\n the list of fleet identifiers includes fleets that don't currently exist, the request\n succeeds but no attributes for that fleet are returned.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeFleetUtilizationOutput": { @@ -2827,7 +2851,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, "FleetUtilization": { @@ -2838,7 +2862,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameServer": { @@ -2864,7 +2888,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Retrieves information for a game server resource. Information includes the game server\n statuses, health check info, and the instance the game server is running on.

\n

To retrieve game server information, specify the game server ID. If successful, the\n requested game server object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information for a registered game server. Information includes game server\n status, health check info, and the instance that the game server is running on.

\n

To retrieve game server information, specify the game server ID. If successful, the\n requested game server object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DescribeGameServerGroup": { @@ -2890,7 +2914,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Retrieves information on a game server group.

\n

To get attributes for a game server group, provide a group name or ARN value. If\n successful, a GameServerGroup object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on a game server group. This operation returns only properties\n related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group,\n such as launch template, auto scaling policies, and maximum/minimum group size, access\n the Auto Scaling group directly.

\n

To get attributes for a game server group, provide a group name or ARN value. If\n successful, a GameServerGroup object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#DescribeGameServerGroupInput": { @@ -2899,7 +2923,7 @@ "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier for the game server group being requested. Use either the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } } @@ -2911,7 +2935,7 @@ "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { - "smithy.api#documentation": "

An object that describes the requested game server group resource.

" + "smithy.api#documentation": "

An object with the property settings for the requested game server group resource.

" } } } @@ -2922,16 +2946,94 @@ "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { - "smithy.api#documentation": "

The identifier for the game server to be retrieved.

", + "smithy.api#documentation": "

A custom string that uniquely identifies the game server information to be retrieved.

", + "smithy.api#required": {} + } + }, + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.gamelift#DescribeGameServerInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.gamelift#DescribeGameServerInstancesInput" + }, + "output": { + "target": "com.amazonaws.gamelift#DescribeGameServerInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.gamelift#InternalServiceException" }, + { + "target": "com.amazonaws.gamelift#InvalidRequestException" + }, + { + "target": "com.amazonaws.gamelift#NotFoundException" + }, + { + "target": "com.amazonaws.gamelift#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ\n game server group. Use this operation to detect when instances are active or not\n available to host new game servers. If you are looking for instance configuration\n information, call DescribeGameServerGroup or access the corresponding\n Auto Scaling group properties.

\n

To request status for all instances in the game server group, provide a game server\n group ID only. To request status for specific instances, provide the game server group\n ID and one or more instance IDs. Use the pagination parameters to retrieve results in\n sequential segments. If successful, a collection of GameServerInstance\n objects is returned.\n \n

\n

This operation is not designed to be called with every game server claim request; this\n practice can cause you to exceed your API limit, which results in errors. Instead, as a\n best practice, cache the results and refresh your cache no more than once every 10\n seconds.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.gamelift#DescribeGameServerInstancesInput": { + "type": "structure", + "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

An identifier for the game server group where the game server is running. Use either\n the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

\n A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.\n

" + } + }, + "Limit": { + "target": "com.amazonaws.gamelift#PositiveInteger", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.\n

" + } + }, + "InstanceIds": { + "target": "com.amazonaws.gamelift#GameServerInstanceIds", + "traits": { + "smithy.api#documentation": "

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a\n 17-character format, for example: i-1234567890abcdef0. To retrieve all\n instances in the game server group, leave this parameter empty.

" + } + } + } + }, + "com.amazonaws.gamelift#DescribeGameServerInstancesOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

\n A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.\n

" + } + }, + "GameServerInstances": { + "target": "com.amazonaws.gamelift#GameServerInstances", + "traits": { + "smithy.api#documentation": "

\n The collection of requested game server instances. \n

" + } } } }, @@ -2941,7 +3043,7 @@ "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { - "smithy.api#documentation": "

Object that describes the requested game server resource.

" + "smithy.api#documentation": "

Object that describes the requested game server.

" } } } @@ -2972,7 +3074,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves properties, including the protection policy in force, for one or more\n game sessions. This action can be used in several ways: (1) provide a\n GameSessionId or GameSessionArn to request details for a\n specific game session; (2) provide either a FleetId or an\n AliasId to request properties for all game sessions running on a fleet.

\n

To get game session record(s), specify just one of the following: game session ID,\n fleet ID, or alias ID. You can filter this request by game session status. Use the\n pagination parameters to retrieve results as a set of sequential pages. If successful, a\n GameSessionDetail object is returned for each session matching the\n request.

\n " + "smithy.api#documentation": "

Retrieves properties, including the protection policy in force, for one or more\n game sessions. This operation can be used in several ways: (1) provide a\n GameSessionId or GameSessionArn to request details for a\n specific game session; (2) provide either a FleetId or an\n AliasId to request properties for all game sessions running on a fleet.

\n

To get game session record(s), specify just one of the following: game session ID,\n fleet ID, or alias ID. You can filter this request by game session status. Use the\n pagination parameters to retrieve results as a set of sequential pages. If successful, a\n GameSessionDetail object is returned for each session matching the\n request.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeGameSessionDetailsInput": { @@ -2984,12 +3091,6 @@ "smithy.api#documentation": "

A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet\n ID or ARN value.

" } }, - "AliasId": { - "target": "com.amazonaws.gamelift#AliasIdOrArn", - "traits": { - "smithy.api#documentation": "

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either\n the alias ID or ARN value.

" - } - }, "StatusFilter": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { @@ -2999,7 +3100,13 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" + } + }, + "AliasId": { + "target": "com.amazonaws.gamelift#AliasIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either\n the alias ID or ARN value.

" } }, "Limit": { @@ -3016,7 +3123,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionDetailsOutput": { @@ -3025,7 +3132,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, "GameSessionDetails": { @@ -3036,7 +3143,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacement": { @@ -3077,7 +3184,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacementOutput": { @@ -3091,7 +3198,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionQueues": { @@ -3117,7 +3224,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the properties for one or more game session queues. When requesting\n multiple queues, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a GameSessionQueue object is returned\n for each requested queue. When specifying a list of queues, objects are returned only\n for queues that currently exist in the Region.

\n

\n Learn more\n

\n

\n \n View Your Queues\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves the properties for one or more game session queues. When requesting\n multiple queues, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a GameSessionQueue object is returned\n for each requested queue. When specifying a list of queues, objects are returned only\n for queues that currently exist in the Region.

\n

\n Learn more\n

\n

\n \n View Your Queues\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeGameSessionQueuesInput": { @@ -3132,38 +3244,38 @@ "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.

" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionQueuesOutput": { "type": "structure", "members": { - "GameSessionQueues": { - "target": "com.amazonaws.gamelift#GameSessionQueueList", + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A collection of objects that describe the requested game session queues.

" + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "GameSessionQueues": { + "target": "com.amazonaws.gamelift#GameSessionQueueList", "traits": { - "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A collection of objects that describe the requested game session queues.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessions": { @@ -3192,7 +3304,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a set of one or more game sessions. Request a specific game session or\n request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are\n filtered by certain criteria. To retrieve protection policy settings for game sessions,\n use DescribeGameSessionDetails.

\n

To get game sessions, specify one of the following: game session ID, fleet ID, or\n alias ID. You can filter this request by game session status. Use the pagination\n parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the\n request.

\n

\n Available in Amazon GameLift Local.\n

\n " + "smithy.api#documentation": "

Retrieves a set of one or more game sessions. Request a specific game session or\n request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are\n filtered by certain criteria. To retrieve protection policy settings for game sessions,\n use DescribeGameSessionDetails.

\n

To get game sessions, specify one of the following: game session ID, fleet ID, or\n alias ID. You can filter this request by game session status. Use the pagination\n parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the\n request.

\n

\n Available in Amazon GameLift Local.\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeGameSessionsInput": { @@ -3213,7 +3330,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } }, "GameSessionId": { @@ -3236,27 +3353,27 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeGameSessionsOutput": { "type": "structure", "members": { - "GameSessions": { - "target": "com.amazonaws.gamelift#GameSessionList", + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A collection of objects containing game session properties for each session matching\n the request.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "GameSessions": { + "target": "com.amazonaws.gamelift#GameSessionList", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A collection of objects containing game session properties for each session matching\n the request.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeInstances": { @@ -3282,7 +3399,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a fleet's instances, including instance IDs. Use this\n action to get details on all instances in the fleet or get details on one specific\n instance.

\n

To get a specific instance, specify fleet ID and instance ID. To get all instances\n in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results\n as a set of sequential pages. If successful, an Instance object is\n returned for each result.

\n

\n Learn more\n

\n

\n Remotely Access Fleet Instances\n

\n

\n Debug Fleet Issues\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves information about a fleet's instances, including instance IDs. Use this\n operation to get details on all instances in the fleet or get details on one specific\n instance.

\n

To get a specific instance, specify fleet ID and instance ID. To get all instances\n in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results\n as a set of sequential pages. If successful, an Instance object is\n returned for each result.

\n

\n Learn more\n

\n

\n Remotely Access Fleet Instances\n

\n

\n Debug Fleet Issues\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeInstancesInput": { @@ -3291,7 +3413,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } }, "FleetId": { @@ -3315,27 +3437,27 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeInstancesOutput": { "type": "structure", "members": { - "Instances": { - "target": "com.amazonaws.gamelift#InstanceList", + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A collection of objects containing properties for each instance returned.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "Instances": { + "target": "com.amazonaws.gamelift#InstanceList", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A collection of objects containing properties for each instance returned.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmaking": { @@ -3358,7 +3480,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket\n information, including status and--once a successful match is made--acquire connection\n information for the resulting new game session.

\n

You can use this operation to track the progress of matchmaking requests (through\n polling) as an alternative to using event notifications. See more details on tracking\n matchmaking requests through polling or notifications in StartMatchmaking.

\n

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the\n request is successful, a ticket object is returned for each requested ID that currently\n exists.

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a Game Client\n

\n

\n \n Set Up FlexMatch Event Notification\n

\n

\n Related operations\n

\n \n " + "smithy.api#documentation": "

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket\n information, including--after a successful match is made--connection information for the\n resulting new game session.

\n

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the\n request is successful, a ticket object is returned for each requested ID that currently\n exists.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously poling ticket status with\n DescribeMatchmaking should only be used for games in development\n with low matchmaking usage.

\n

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a Game Client\n

\n

\n \n Set Up FlexMatch Event Notification\n

\n

\n Related operations\n

\n \n " } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurations": { @@ -3381,7 +3503,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details of FlexMatch matchmaking configurations. With this operation, you\n have the following options: (1) retrieve all existing configurations, (2) provide the\n names of one or more configurations to retrieve, or (3) retrieve all configurations that\n use a specified rule set name. When requesting multiple items, use the pagination\n parameters to retrieve results as a set of sequential pages. If successful, a\n configuration is returned for each requested name. When specifying a list of names, only\n configurations that currently exist are returned.

\n

\n Learn more\n

\n

\n Setting Up FlexMatch\n Matchmakers\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves the details of FlexMatch matchmaking configurations.

\n

This operation offers the following options: (1) retrieve all matchmaking\n configurations, (2) retrieve configurations for a specified list, or (3) retrieve all\n configurations that use a specified rule set name. When requesting multiple items, use\n the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a configuration is returned for each requested name. When specifying a\n list of names, only configurations that currently exist are returned.

\n

\n Learn more\n

\n

\n Setting Up FlexMatch\n Matchmakers\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurationsInput": { @@ -3396,13 +3523,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" - } - }, - "RuleSetName": { - "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", - "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to\n retrieve all matchmaking configurations that use this rule set.

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } }, "Names": { @@ -3410,10 +3531,16 @@ "traits": { "smithy.api#documentation": "

A unique identifier for a matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To\n request all existing configurations, leave this parameter empty.

" } + }, + "RuleSetName": { + "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", + "traits": { + "smithy.api#documentation": "

A unique identifier for a matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to\n retrieve all matchmaking configurations that use this rule set.

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurationsOutput": { @@ -3422,7 +3549,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, "Configurations": { @@ -3433,7 +3560,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingInput": { @@ -3448,7 +3575,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingOutput": { @@ -3462,7 +3589,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSets": { @@ -3488,7 +3615,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details for FlexMatch matchmaking rule sets. You can request all\n existing rule sets for the Region, or provide a list of one or more rule set names. When\n requesting multiple items, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a rule set is returned for each requested name.

\n

\n Learn more\n

\n \n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves the details for FlexMatch matchmaking rule sets. You can request all\n existing rule sets for the Region, or provide a list of one or more rule set names. When\n requesting multiple items, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a rule set is returned for each requested name.

\n

\n Learn more\n

\n \n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSetsInput": { @@ -3503,7 +3635,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } }, "Limit": { @@ -3514,28 +3646,28 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSetsOutput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" + } + }, "RuleSets": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetList", "traits": { "smithy.api#documentation": "

A collection of requested matchmaking rule set objects.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" - } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribePlayerSessions": { @@ -3561,7 +3693,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves properties for one or more player sessions. This action can be used in\n several ways: (1) provide a PlayerSessionId to request properties for a\n specific player session; (2) provide a GameSessionId to request properties\n for all player sessions in the specified game session; (3) provide a\n PlayerId to request properties for all player sessions of a specified\n player.

\n

To get game session record(s), specify only one of the following: a player session\n ID, a game session ID, or a player ID. You can filter this request by player session\n status. Use the pagination parameters to retrieve results as a set of sequential pages.\n If successful, a PlayerSession object is returned for each session\n matching the request.

\n

\n Available in Amazon GameLift Local.\n

\n " + "smithy.api#documentation": "

Retrieves properties for one or more player sessions. This operation can be used in\n several ways: (1) provide a PlayerSessionId to request properties for a\n specific player session; (2) provide a GameSessionId to request properties\n for all player sessions in the specified game session; (3) provide a\n PlayerId to request properties for all player sessions of a specified\n player.

\n

To get game session record(s), specify only one of the following: a player session\n ID, a game session ID, or a player ID. You can filter this request by player session\n status. Use the pagination parameters to retrieve results as a set of sequential pages.\n If successful, a PlayerSession object is returned for each session\n matching the request.

\n

\n Available in Amazon GameLift Local.\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribePlayerSessionsInput": { @@ -3588,7 +3725,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

" } }, "GameSessionId": { @@ -3605,27 +3742,27 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribePlayerSessionsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" - } - }, "PlayerSessions": { "target": "com.amazonaws.gamelift#PlayerSessionList", "traits": { "smithy.api#documentation": "

A collection of objects containing properties for each player session that matches\n the request.

" } + }, + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeRuntimeConfiguration": { @@ -3666,7 +3803,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeRuntimeConfigurationOutput": { @@ -3680,7 +3817,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeScalingPolicies": { @@ -3706,12 +3843,23 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all scaling policies applied to a fleet.

\n

To get a fleet's scaling policies, specify the fleet ID. You can filter this\n request by policy status, such as to retrieve only active scaling policies. Use the\n pagination parameters to retrieve results as a set of sequential pages. If successful,\n set of ScalingPolicy objects is returned for the fleet.

\n

A fleet may have all of its scaling policies suspended (StopFleetActions). This action does not affect the status of the scaling\n policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force\n or suspended, call DescribeFleetAttributes and check the stopped\n actions.

\n " + "smithy.api#documentation": "

Retrieves all scaling policies applied to a fleet.

\n

To get a fleet's scaling policies, specify the fleet ID. You can filter this\n request by policy status, such as to retrieve only active scaling policies. Use the\n pagination parameters to retrieve results as a set of sequential pages. If successful,\n set of ScalingPolicy objects is returned for the fleet.

\n

A fleet may have all of its scaling policies suspended (StopFleetActions). This operation does not affect the status of the scaling\n policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force\n or suspended, call DescribeFleetAttributes and check the stopped\n actions.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#DescribeScalingPoliciesInput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" + } + }, "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { @@ -3725,12 +3873,6 @@ "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" } }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" - } - }, "StatusFilter": { "target": "com.amazonaws.gamelift#ScalingStatusType", "traits": { @@ -3739,7 +3881,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeScalingPoliciesOutput": { @@ -3754,12 +3896,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DescribeScript": { @@ -3886,7 +4028,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsOutput": { @@ -3900,23 +4042,23 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#DesiredPlayerSession": { "type": "structure", "members": { - "PlayerData": { - "target": "com.amazonaws.gamelift#PlayerData", - "traits": { - "smithy.api#documentation": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" - } - }, "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "

A unique identifier for a player to associate with the player session.

" } + }, + "PlayerData": { + "target": "com.amazonaws.gamelift#PlayerData", + "traits": { + "smithy.api#documentation": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" + } } }, "traits": { @@ -3962,12 +4104,6 @@ "smithy.api#documentation": "

Number of active instances in the fleet that are not currently hosting a game\n session.

" } }, - "MAXIMUM": { - "target": "com.amazonaws.gamelift#WholeNumber", - "traits": { - "smithy.api#documentation": "

The maximum value allowed for the fleet's instance count.

" - } - }, "PENDING": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -3980,6 +4116,12 @@ "smithy.api#documentation": "

Ideal number of active instances in the fleet.

" } }, + "MAXIMUM": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The maximum value allowed for the fleet's instance count.

" + } + }, "MINIMUM": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -4219,6 +4361,12 @@ "smithy.api#documentation": "

Location of stored logs with additional detail that is related to the event. This\n is useful for debugging issues. The URL is valid for 15 minutes. You can also access\n fleet creation logs through the Amazon GameLift console.

" } }, + "EventTime": { + "target": "com.amazonaws.gamelift#Timestamp", + "traits": { + "smithy.api#documentation": "

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } + }, "ResourceId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { @@ -4231,12 +4379,6 @@ "smithy.api#documentation": "

Additional information related to the event.

" } }, - "EventTime": { - "target": "com.amazonaws.gamelift#Timestamp", - "traits": { - "smithy.api#documentation": "

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" - } - }, "EventCode": { "target": "com.amazonaws.gamelift#EventCode", "traits": { @@ -4425,142 +4567,142 @@ "com.amazonaws.gamelift#FleetAttributes": { "type": "structure", "members": { - "StoppedActions": { - "target": "com.amazonaws.gamelift#FleetActionList", + "MetricGroups": { + "target": "com.amazonaws.gamelift#MetricGroupList", "traits": { - "smithy.api#documentation": "

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

" + "smithy.api#documentation": "

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you\n can view metrics for an individual fleet or aggregated metrics for fleets that are in a\n fleet metric group. A fleet can be included in only one metric group at a\n time.

" } }, - "Status": { - "target": "com.amazonaws.gamelift#FleetStatus", + "TerminationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Current status of the fleet.

\n

Possible fleet statuses include the following:

\n " + "smithy.api#documentation": "

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "InstanceRoleArn": { + "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Human-readable description of the fleet.

" + "smithy.api#documentation": "

A unique identifier for an AWS IAM role that manages access to your AWS services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN from the IAM dashboard in the AWS Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server.

" } }, - "ScriptArn": { - "target": "com.amazonaws.gamelift#ScriptArn", + "CertificateConfiguration": { + "target": "com.amazonaws.gamelift#CertificateConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances\n in this fleet. In a GameLift script ARN, the resource ID matches the\n ScriptId value.

" + "smithy.api#documentation": "

Indicates whether a TLS/SSL certificate was generated for the fleet.

" } }, - "FleetType": { - "target": "com.amazonaws.gamelift#FleetType", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", "traits": { - "smithy.api#documentation": "

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use\n may be interrupted with a two-minute notification.

" + "smithy.api#documentation": "

A unique identifier for a fleet.

" } }, - "NewGameSessionProtectionPolicy": { - "target": "com.amazonaws.gamelift#ProtectionPolicy", + "InstanceType": { + "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { - "smithy.api#documentation": "

The type of game session protection to set for all new instances started in the\n fleet.

\n " + "smithy.api#documentation": "

EC2 instance type indicating the computing resources of each instance in the\n fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for\n detailed descriptions.

" } }, - "ResourceCreationLimitPolicy": { - "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", + "BuildArn": { + "target": "com.amazonaws.gamelift#BuildArn", "traits": { - "smithy.api#documentation": "

Fleet policy to limit the number of game sessions an individual player can create\n over a span of time.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances\n in this fleet. In a GameLift build ARN, the resource ID matches the\n BuildId value.

" } }, - "ScriptId": { - "target": "com.amazonaws.gamelift#ScriptId", + "BuildId": { + "target": "com.amazonaws.gamelift#BuildId", "traits": { - "smithy.api#documentation": "

A unique identifier for a Realtime script.

" + "smithy.api#documentation": "

A unique identifier for a build.

" } }, - "LogPaths": { - "target": "com.amazonaws.gamelift#StringList", + "ServerLaunchParameters": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Location of default log files. When a server process is shut down, Amazon GameLift captures\n and stores any log files in this location. These logs are in addition to game session\n logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified,\n Amazon GameLift automatically uploads logs that are stored on each instance at\n C:\\game\\logs (for Windows) or /local/game/logs (for\n Linux). Use the Amazon GameLift console to access stored logs.

" + "smithy.api#documentation": "

Game server launch parameters specified for fleets created before 2016-08-04 (or\n AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are\n specified in the fleet's RuntimeConfiguration.

" } }, - "TerminationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "OperatingSystem": { + "target": "com.amazonaws.gamelift#OperatingSystem", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Operating system of the fleet's computing resources. A fleet's operating system\n depends on the OS specified for the build that is deployed on this fleet.

" } - }, - "ServerLaunchPath": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + }, + "CreationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Path to a game server executable in the fleet's build, specified for fleets created\n before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after\n this date are specified in the fleet's RuntimeConfiguration.

" + "smithy.api#documentation": "

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the\n FleetId value.

" } }, - "MetricGroups": { - "target": "com.amazonaws.gamelift#MetricGroupList", + "StoppedActions": { + "target": "com.amazonaws.gamelift#FleetActionList", "traits": { - "smithy.api#documentation": "

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you\n can view metrics for an individual fleet or aggregated metrics for fleets that are in a\n fleet metric group. A fleet can be included in only one metric group at a\n time.

" + "smithy.api#documentation": "

List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

" } }, - "BuildId": { - "target": "com.amazonaws.gamelift#BuildId", + "Status": { + "target": "com.amazonaws.gamelift#FleetStatus", "traits": { - "smithy.api#documentation": "

A unique identifier for a build.

" + "smithy.api#documentation": "

Current status of the fleet.

\n

Possible fleet statuses include the following:

\n " } }, - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + "Description": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet.

" + "smithy.api#documentation": "

Human-readable description of the fleet.

" } }, - "InstanceRoleArn": { - "target": "com.amazonaws.gamelift#NonEmptyString", + "ScriptArn": { + "target": "com.amazonaws.gamelift#ScriptArn", "traits": { - "smithy.api#documentation": "

A unique identifier for an AWS IAM role that manages access to your AWS services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN from the IAM dashboard in the AWS Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances\n in this fleet. In a GameLift script ARN, the resource ID matches the\n ScriptId value.

" } }, - "BuildArn": { - "target": "com.amazonaws.gamelift#BuildArn", + "FleetType": { + "target": "com.amazonaws.gamelift#FleetType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances\n in this fleet. In a GameLift build ARN, the resource ID matches the\n BuildId value.

" + "smithy.api#documentation": "

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use\n may be interrupted with a two-minute notification.

" } }, - "CertificateConfiguration": { - "target": "com.amazonaws.gamelift#CertificateConfiguration", + "ResourceCreationLimitPolicy": { + "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", "traits": { - "smithy.api#documentation": "

Indicates whether a TLS/SSL certificate was generated for the fleet.

" + "smithy.api#documentation": "

Fleet policy to limit the number of game sessions an individual player can create\n over a span of time.

" } }, - "ServerLaunchParameters": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "ScriptId": { + "target": "com.amazonaws.gamelift#ScriptId", "traits": { - "smithy.api#documentation": "

Game server launch parameters specified for fleets created before 2016-08-04 (or\n AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are\n specified in the fleet's RuntimeConfiguration.

" + "smithy.api#documentation": "

A unique identifier for a Realtime script.

" } }, - "InstanceType": { - "target": "com.amazonaws.gamelift#EC2InstanceType", + "NewGameSessionProtectionPolicy": { + "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { - "smithy.api#documentation": "

EC2 instance type indicating the computing resources of each instance in the\n fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for\n detailed descriptions.

" + "smithy.api#documentation": "

The type of game session protection to set for all new instances started in the\n fleet.

\n " } }, - "OperatingSystem": { - "target": "com.amazonaws.gamelift#OperatingSystem", + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Operating system of the fleet's computing resources. A fleet's operating system\n depends on the OS specified for the build that is deployed on this fleet.

" + "smithy.api#documentation": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

" } }, - "FleetArn": { - "target": "com.amazonaws.gamelift#FleetArn", + "ServerLaunchPath": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the\n FleetId value.

" + "smithy.api#documentation": "

Path to a game server executable in the fleet's build, specified for fleets created\n before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after\n this date are specified in the fleet's RuntimeConfiguration.

" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "LogPaths": { + "target": "com.amazonaws.gamelift#StringList", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Location of default log files. When a server process is shut down, Amazon GameLift captures\n and stores any log files in this location. These logs are in addition to game session\n logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified,\n Amazon GameLift automatically uploads logs that are stored on each instance at\n C:\\game\\logs (for Windows) or /local/game/logs (for\n Linux). Use the Amazon GameLift console to access stored logs.

" } } }, @@ -4719,6 +4861,12 @@ "smithy.api#documentation": "

The maximum number of players allowed across all game sessions currently being hosted on all\n instances in the fleet.

" } }, + "ActiveGameSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

Number of active game sessions currently being hosted on all instances in the\n fleet.

" + } + }, "CurrentPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -4731,12 +4879,6 @@ "smithy.api#documentation": "

A unique identifier for a fleet.

" } }, - "ActiveGameSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", - "traits": { - "smithy.api#documentation": "

Number of active game sessions currently being hosted on all instances in the\n fleet.

" - } - }, "ActiveServerProcessCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -4875,6 +5017,9 @@ { "target": "com.amazonaws.gamelift#DescribeGameServerGroup" }, + { + "target": "com.amazonaws.gamelift#DescribeGameServerInstances" + }, { "target": "com.amazonaws.gamelift#DescribeGameSessionDetails" }, @@ -5037,13 +5182,13 @@ "sdkId": "GameLift", "arnNamespace": "gamelift", "cloudFormationName": "GameLift", - "cloudTrailEventSource": "v20151001.gameliftapi.amazonaws.com" + "cloudTrailEventSource": "gamelift.amazonaws.com" }, "aws.auth#sigv4": { "name": "gamelift" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon GameLift Service\n

Amazon GameLift provides a range of multiplayer game hosting solutions. As a fully managed\n service, GameLift helps you:

\n \n \n

With GameLift as a managed service, you have the option to deploy your custom game\n server or use Amazon GameLift Realtime Servers to quickly stand up lightweight game servers for your game.\n Realtime Servers provides an efficient game server framework with core Amazon GameLift infrastructure\n already built in.

\n \n

\n Now in Public Preview:\n

\n

Use GameLift FleetIQ as a standalone feature with EC2 instances and Auto Scaling groups. GameLift FleetIQ\n provides optimizations that make low-cost Spot instances viable for game hosting. This\n extension of GameLift FleetIQ gives you access to these optimizations while managing your EC2\n instances and Auto Scaling groups within your own AWS account.

\n \n

\n Get Amazon GameLift Tools and Resources\n

\n

This reference guide describes the low-level service API for Amazon GameLift and provides links to\n language-specific SDK reference topics. See also \n \n Amazon GameLift Tools and Resources.

\n

\n API Summary\n

\n

The Amazon GameLift service API includes two key sets of actions:

\n \n

\n \n \n Task-based list of API actions\n \n

", + "smithy.api#documentation": "Amazon GameLift Service\n

GameLift provides solutions for hosting session-based multiplayer game servers in the\n cloud, including tools for deploying, operating, and scaling game servers. Built on AWS\n global computing infrastructure, GameLift helps you deliver high-performance,\n high-reliability, low-cost game servers while dynamically scaling your resource usage to\n meet player demand.

\n

\n About GameLift solutions\n

\n

Get more information on these GameLift solutions in the Amazon GameLift Developer Guide.

\n \n

\n About this API Reference\n

\n

This reference guide describes the low-level service API for Amazon GameLift. You can find\n links to language-specific SDK guides and the AWS CLI reference with each operation and\n data type topic. Useful links:

\n ", "smithy.api#title": "Amazon GameLift", "smithy.api#xmlNamespace": { "uri": "http://gamelift.amazonaws.com/doc/" @@ -5105,28 +5250,16 @@ "com.amazonaws.gamelift#GameServer": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.gamelift#GameServerInstanceId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the instance where the game server is located.

" - } - }, "RegistrationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Time stamp indicating when the game server resource was created with a RegisterGameServer request. Format is a number expressed in Unix time as\n milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix\n time as milliseconds (for example \"1469498468.057\").

" } }, "UtilizationStatus": { "target": "com.amazonaws.gamelift#GameServerUtilizationStatus", "traits": { - "smithy.api#documentation": "

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

\n " - } - }, - "GameServerId": { - "target": "com.amazonaws.gamelift#GameServerId", - "traits": { - "smithy.api#documentation": "

A custom string that uniquely identifies the game server. Game server IDs are developer-defined\n and are unique across all game server groups in an AWS account.

" + "smithy.api#documentation": "

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

\n " } }, "GameServerGroupArn": { @@ -5138,48 +5271,54 @@ "LastHealthCheckTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Time stamp indicating the last time the game server was updated with health status\n using an UpdateGameServer request. Format is a number expressed in\n Unix time as milliseconds (for example \"1469498468.057\"). After game server\n registration, this property is only changed when a game server update specifies a health\n check value.

" + "smithy.api#documentation": "

Timestamp that indicates the last time the game server was updated with health status\n using an UpdateGameServer request. The format is a number expressed in\n Unix time as milliseconds (for example \"1469498468.057\"). After game server\n registration, this property is only changed when a game server update specifies a health\n check value.

" } }, - "ClaimStatus": { - "target": "com.amazonaws.gamelift#GameServerClaimStatus", + "GameServerId": { + "target": "com.amazonaws.gamelift#GameServerId", "traits": { - "smithy.api#documentation": "

Indicates when an available game server has been reserved but has not yet started hosting a game.\n Once it is claimed, game server remains in CLAIMED status for a maximum of one minute. During this time, \n game clients must connect to the game server and start the game, which triggers the game server to update its \n utilization status. After one minute, the game server claim status reverts to null.

" + "smithy.api#documentation": "

A custom string that uniquely identifies the game server. Game server IDs are\n developer-defined and are unique across all game server groups in an AWS\n account.

" } }, - "ConnectionInfo": { - "target": "com.amazonaws.gamelift#GameServerConnectionInfo", + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { - "smithy.api#documentation": "

The port and IP address that must be used to establish a client connection to the game server.

" + "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

" } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data is \n passed to a game client or service in response to requests \n ListGameServers or ClaimGameServer.\n This property can be updated using UpdateGameServer.

" + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" } }, - "GameServerGroupName": { - "target": "com.amazonaws.gamelift#GameServerGroupName", + "ClaimStatus": { + "target": "com.amazonaws.gamelift#GameServerClaimStatus", + "traits": { + "smithy.api#documentation": "

Indicates when an available game server has been reserved for gameplay but has not yet\n started hosting a game. Once it is claimed, the game server remains in\n CLAIMED status for a maximum of one minute. During this time, game\n clients connect to the game server to start the game and trigger the game server to\n update its utilization status. After one minute, the game server claim status reverts to\n null.

" + } + }, + "ConnectionInfo": { + "target": "com.amazonaws.gamelift#GameServerConnectionInfo", "traits": { - "smithy.api#documentation": "

The name identifier for the game server group where the game server is located.

" + "smithy.api#documentation": "

The port and IP address that must be used to establish a client connection to the game server.

" } }, "LastClaimTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Time stamp indicating the last time the game server was claimed with a ClaimGameServer request. Format is a number expressed in Unix time as\n milliseconds (for example \"1469498468.057\"). This value is used to calculate when the\n game server's claim status.

" + "smithy.api#documentation": "

Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time\n as milliseconds (for example \"1469498468.057\"). This value is used to\n calculate when a claimed game server's status should revert to null.

" } }, - "CustomSortKey": { - "target": "com.amazonaws.gamelift#GameServerSortKey", + "InstanceId": { + "target": "com.amazonaws.gamelift#GameServerInstanceId", "traits": { - "smithy.api#documentation": "

A game server tag that can be used to request sorted lists of game servers when calling \n ListGameServers. Custom sort keys\n are developer-defined.\n This property can be updated using UpdateGameServer.

" + "smithy.api#documentation": "

The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.

" } } }, "traits": { - "smithy.api#documentation": "

\n This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Properties describing a game server resource.

\n

A game server resource is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer.

" + "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift FleetIQ and game server groups.\n

\n

Properties describing a game server that is running on an instance in a GameServerGroup.

\n

A game server is created by a successful call to RegisterGameServer and\n deleted by calling DeregisterGameServer. A game server is claimed to host a\n game session by calling ClaimGameServer.

\n " } }, "com.amazonaws.gamelift#GameServerClaimStatus": { @@ -5216,16 +5355,10 @@ "com.amazonaws.gamelift#GameServerGroup": { "type": "structure", "members": { - "LastUpdatedTime": { + "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

A time stamp indicating when this game server group was last updated.

" - } - }, - "StatusReason": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

Additional information about the current game server group status. This information\n may provide additional insight on groups that in ERROR status.

" + "smithy.api#documentation": "

A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, "GameServerGroupArn": { @@ -5234,34 +5367,46 @@ "smithy.api#documentation": "

A generated unique ID for the game server group.

" } }, + "GameServerProtectionPolicy": { + "target": "com.amazonaws.gamelift#GameServerProtectionPolicy", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by AWS regardless of protection status.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.gamelift#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp that indicates when this game server group was last updated.

" + } + }, "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { - "smithy.api#documentation": "

A developer-defined identifier for the game server group. The name is unique per\n Region per AWS account.

" + "smithy.api#documentation": "

A developer-defined identifier for the game server group. The name is unique for each\n Region in each AWS account.

" } }, - "BalancingStrategy": { - "target": "com.amazonaws.gamelift#BalancingStrategy", + "StatusReason": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

The fallback balancing method to use for the game server group when Spot instances in\n a Region become unavailable or are not viable for game hosting. Once triggered, this\n method remains active until Spot instances can once again be used. Method options\n include:

\n " + "smithy.api#documentation": "

Additional information about the current game server group status. This information\n might provide additional insight on groups that are in ERROR status.

" } }, "AutoScalingGroupArn": { "target": "com.amazonaws.gamelift#AutoScalingGroupArn", "traits": { - "smithy.api#documentation": "

A generated unique ID for the EC2 Auto Scaling group with is associated with \n this game server group.

" + "smithy.api#documentation": "

A generated unique ID for the EC2 Auto Scaling group that is associated with this\n game server group.

" } }, - "GameServerProtectionPolicy": { - "target": "com.amazonaws.gamelift#GameServerProtectionPolicy", + "Status": { + "target": "com.amazonaws.gamelift#GameServerGroupStatus", "traits": { - "smithy.api#documentation": "

A flag that indicates whether instances in the game server group are protected from\n early termination. Unprotected instances that have active game servers running may be\n terminated during a scale-down event, causing players to be dropped from the game.\n Protected instances cannot be terminated while there are active game servers running\n except in the event of a forced game server group deletion \n (see DeleteGameServerGroup). An\n exception to this is Spot Instances, which may be terminated by AWS regardless of\n protection status.

" + "smithy.api#documentation": "

The current status of the game server group. Possible statuses include:

\n " } }, - "Status": { - "target": "com.amazonaws.gamelift#GameServerGroupStatus", + "BalancingStrategy": { + "target": "com.amazonaws.gamelift#BalancingStrategy", "traits": { - "smithy.api#documentation": "

The current status of the game server group. Possible statuses include:

\n " + "smithy.api#documentation": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:

\n " } }, "SuspendedActions": { @@ -5273,24 +5418,18 @@ "InstanceDefinitions": { "target": "com.amazonaws.gamelift#InstanceDefinitions", "traits": { - "smithy.api#documentation": "

The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and autoscaling\n instances in the group.

" + "smithy.api#documentation": "

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically\n scaling instances in the corresponding Auto Scaling group.

" } }, "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to\n ensure that it contains the necessary permissions for game server groups.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", - "traits": { - "smithy.api#documentation": "

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups.

" } } }, "traits": { - "smithy.api#documentation": "

\n This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Properties describing a game server group resource. A game server group manages\n certain properties of a corresponding EC2 Auto Scaling group.

\n

A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily\n suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup.

" + "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift FleetIQ and game server groups.\n

\n

Properties that describe a game server group resource. A game server group manages\n certain properties related to a corresponding EC2 Auto Scaling group.

\n

A game server group is created by a successful call to\n CreateGameServerGroup and deleted by calling\n DeleteGameServerGroup. Game server group activity can be temporarily\n suspended and resumed by calling SuspendGameServerGroup and\n ResumeGameServerGroup, respectively.

\n " } }, "com.amazonaws.gamelift#GameServerGroupAction": { @@ -5329,22 +5468,22 @@ "com.amazonaws.gamelift#GameServerGroupAutoScalingPolicy": { "type": "structure", "members": { - "TargetTrackingConfiguration": { - "target": "com.amazonaws.gamelift#TargetTrackingConfiguration", + "EstimatedInstanceWarmup": { + "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

Settings for a target-based scaling policy applied to Auto Scaling group. These\n settings are used to create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player\n usage changes, the policy triggers to adjust the game server group capacity so that the\n metric returns to the target value.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Length of time, in seconds, it takes for a new instance to start new game server\n processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly\n with game servers that take a long time to start up, because it avoids prematurely\n starting new instances.

" } }, - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.gamelift#PositiveInteger", + "TargetTrackingConfiguration": { + "target": "com.amazonaws.gamelift#TargetTrackingConfiguration", "traits": { - "smithy.api#documentation": "

Length of time, in seconds, it takes for a new instance to start new game server\n processes and register with GameLift FleetIQ. Specifying a warm-up time can be\n useful, particularly with game servers that take a long time to start up, because it\n avoids prematurely starting new instances

" + "smithy.api#documentation": "

Settings for a target-based scaling policy applied to Auto Scaling group. These\n settings are used to create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Configuration settings for intelligent autoscaling that uses target\n tracking. An autoscaling policy can be specified when a new game server group is\n created with CreateGameServerGroup. If a group has an autoscaling\n policy, the Auto Scaling group takes action based on this policy, in addition to (and potentially in\n conflict with) any other autoscaling policies that are separately applied to the Auto\n Scaling group.

" + "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift FleetIQ and game server groups.\n

\n

Configuration settings for intelligent automatic scaling that uses target tracking.\n These settings are used to add an Auto Scaling policy when creating the corresponding\n Auto Scaling group with CreateGameServerGroup. After the Auto Scaling\n group is created, all updates to Auto Scaling policies, including changing this policy\n and adding or removing other policies, is done directly on the Auto Scaling group.

" } }, "com.amazonaws.gamelift#GameServerGroupDeleteOption": { @@ -5575,6 +5714,38 @@ "smithy.api#pattern": "[a-zA-Z0-9-\\.]+" } }, + "com.amazonaws.gamelift#GameServerInstance": { + "type": "structure", + "members": { + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupName", + "traits": { + "smithy.api#documentation": "

A developer-defined identifier for the game server group that includes the game\n server instance. The name is unique for each Region in each AWS account.

" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.gamelift#GameServerInstanceStatus", + "traits": { + "smithy.api#documentation": "

\n Current status of the game server instance. \n

\n " + } + }, + "GameServerGroupArn": { + "target": "com.amazonaws.gamelift#GameServerGroupArn", + "traits": { + "smithy.api#documentation": "

A generated unique identifier for the game server group that includes the game\n server instance.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.gamelift#GameServerInstanceId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift FleetIQ and game server groups.\n

\n

Additional properties, including status, that describe an EC2 instance in a game\n server group. Instance configurations are set with game server group properties (see\n DescribeGameServerGroup and with the EC2 launch template that was used\n when creating the game server group.

\n

Retrieve game server instances for a game server group by calling\n DescribeGameServerInstances.

\n " + } + }, "com.amazonaws.gamelift#GameServerInstanceId": { "type": "string", "traits": { @@ -5585,6 +5756,43 @@ "smithy.api#pattern": "^i-[0-9a-zA-Z]{17}$" } }, + "com.amazonaws.gamelift#GameServerInstanceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#GameServerInstanceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.gamelift#GameServerInstanceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DRAINING", + "name": "DRAINING" + }, + { + "value": "SPOT_TERMINATING", + "name": "SPOT_TERMINATING" + } + ] + } + }, + "com.amazonaws.gamelift#GameServerInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.gamelift#GameServerInstance" + } + }, "com.amazonaws.gamelift#GameServerProtectionPolicy": { "type": "string", "traits": { @@ -5600,16 +5808,6 @@ ] } }, - "com.amazonaws.gamelift#GameServerSortKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "[a-zA-Z0-9-\\.]+" - } - }, "com.amazonaws.gamelift#GameServerUtilizationStatus": { "type": "string", "traits": { @@ -5634,64 +5832,52 @@ "com.amazonaws.gamelift#GameSession": { "type": "structure", "members": { - "GameSessionData": { - "target": "com.amazonaws.gamelift#GameSessionData", - "traits": { - "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" - } - }, - "Status": { - "target": "com.amazonaws.gamelift#GameSessionStatus", - "traits": { - "smithy.api#documentation": "

Current status of the game session. A game session must have an ACTIVE\n status to have player sessions.

" - } - }, - "GameProperties": { - "target": "com.amazonaws.gamelift#GamePropertyList", - "traits": { - "smithy.api#documentation": "

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data\n with SearchGameSessions.

" - } - }, - "DnsName": { - "target": "com.amazonaws.gamelift#DnsName", + "MaximumPlayerSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" + "smithy.api#documentation": "

The maximum number of players that can be connected simultaneously to the game session.

" } }, - "FleetArn": { - "target": "com.amazonaws.gamelift#FleetArn", + "GameSessionId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on. \n

" + "smithy.api#documentation": "

A unique identifier for the game session. A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//.

" } }, - "MatchmakerData": { - "target": "com.amazonaws.gamelift#MatchmakerData", + "TerminationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Information about the matchmaking process that was used to create the game session.\n It is in JSON syntax, formatted as a string. In addition the matchmaking configuration\n used, it contains data on all players assigned to the match, including player attributes\n and team assignments. For more details on matchmaker data, see Match\n Data. Matchmaker data is useful when requesting match backfills, and is\n updated whenever new players are added during a successful backfill (see StartMatchBackfill).

" + "smithy.api#documentation": "

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "CreationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" + "smithy.api#documentation": "

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "CurrentPlayerSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", "traits": { - "smithy.api#documentation": "

Number of players currently in the game session.

" + "smithy.api#documentation": "

A unique identifier for a fleet that the game session is running on.

" } }, - "GameSessionId": { + "CreatorId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for the game session. A game session ARN has the following format: \n arn:aws:gamelift:::gamesession//.

" + "smithy.api#documentation": "

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one\n exists), that limits the number of game sessions a player can create.

" } }, - "TerminationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "PlayerSessionCreationPolicy": { + "target": "com.amazonaws.gamelift#PlayerSessionCreationPolicy", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Indicates whether or not the game session is accepting new players.

" + } + }, + "Port": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

" } }, "StatusReason": { @@ -5700,46 +5886,58 @@ "smithy.api#documentation": "

Provides additional information about game session status. INTERRUPTED\n indicates that the game session was hosted on a spot instance that was reclaimed,\n causing the active game session to be terminated.

" } }, - "PlayerSessionCreationPolicy": { - "target": "com.amazonaws.gamelift#PlayerSessionCreationPolicy", + "Status": { + "target": "com.amazonaws.gamelift#GameSessionStatus", "traits": { - "smithy.api#documentation": "

Indicates whether or not the game session is accepting new players.

" + "smithy.api#documentation": "

Current status of the game session. A game session must have an ACTIVE\n status to have player sessions.

" } }, - "MaximumPlayerSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "IpAddress": { + "target": "com.amazonaws.gamelift#IpAddress", "traits": { - "smithy.api#documentation": "

The maximum number of players that can be connected simultaneously to the game session.

" + "smithy.api#documentation": "

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.

" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "GameProperties": { + "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data\n with SearchGameSessions.

" } }, - "CreatorId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

A unique identifier for a player. This ID is used to enforce a resource protection policy (if one\n exists), that limits the number of game sessions a player can create.

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on. \n

" } }, - "Port": { - "target": "com.amazonaws.gamelift#PortNumber", + "DnsName": { + "target": "com.amazonaws.gamelift#DnsName", "traits": { - "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

" + "smithy.api#documentation": "

DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" } }, - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + "GameSessionData": { + "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet that the game session is running on.

" + "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, - "IpAddress": { - "target": "com.amazonaws.gamelift#IpAddress", + "MatchmakerData": { + "target": "com.amazonaws.gamelift#MatchmakerData", "traits": { - "smithy.api#documentation": "

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.

" + "smithy.api#documentation": "

Information about the matchmaking process that was used to create the game session.\n It is in JSON syntax, formatted as a string. In addition the matchmaking configuration\n used, it contains data on all players assigned to the match, including player attributes\n and team assignments. For more details on matchmaker data, see Match\n Data. Matchmaker data is useful when requesting match backfills, and is\n updated whenever new players are added during a successful backfill (see StartMatchBackfill).

" + } + }, + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" + } + }, + "CurrentPlayerSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

Number of players currently in the game session.

" } } }, @@ -5772,12 +5970,6 @@ "smithy.api#documentation": "

DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" } }, - "MatchedPlayerSessions": { - "target": "com.amazonaws.gamelift#MatchedPlayerSessionList", - "traits": { - "smithy.api#documentation": "

A collection of player session IDs, one for each player ID that was included in the\n original matchmaking request.

" - } - }, "GameSessionArn": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { @@ -5789,6 +5981,12 @@ "traits": { "smithy.api#documentation": "

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.

" } + }, + "MatchedPlayerSessions": { + "target": "com.amazonaws.gamelift#MatchedPlayerSessionList", + "traits": { + "smithy.api#documentation": "

A collection of player session IDs, one for each player ID that was included in the\n original matchmaking request.

" + } } }, "traits": { @@ -5851,112 +6049,112 @@ "com.amazonaws.gamelift#GameSessionPlacement": { "type": "structure", "members": { - "GameSessionQueueName": { - "target": "com.amazonaws.gamelift#GameSessionQueueName", + "StartTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

" + "smithy.api#documentation": "

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "GameSessionArn": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "GameSessionData": { + "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

Identifier for the game session created by this placement request. This value is\n set once the new game session is placed (placement status is FULFILLED).\n This identifier is unique across all Regions. You can use this value as a\n GameSessionId value as needed.

" + "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, - "MaximumPlayerSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "PlacedPlayerSessions": { + "target": "com.amazonaws.gamelift#PlacedPlayerSessionList", "traits": { - "smithy.api#documentation": "

The maximum number of players that can be connected simultaneously to the game session.

" + "smithy.api#documentation": "

A collection of information on player sessions created in response to the game\n session placement request. These player sessions are created only once a new game\n session is successfully placed (placement status is FULFILLED). This\n information includes the player ID (as provided in the placement request) and the\n corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

" } }, - "PlacementId": { - "target": "com.amazonaws.gamelift#IdStringModel", + "EndTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

A unique identifier for a game session placement.

" + "smithy.api#documentation": "

Time stamp indicating when this request was completed, canceled, or timed\n out.

" } }, - "MatchmakerData": { - "target": "com.amazonaws.gamelift#MatchmakerData", + "PlayerLatencies": { + "target": "com.amazonaws.gamelift#PlayerLatencyList", "traits": { - "smithy.api#documentation": "

Information on the matchmaking process for this game. Data is in JSON syntax,\n formatted as a string. It identifies the matchmaking configuration used to create the\n match, and contains data on all players assigned to the match, including player\n attributes and team assignments. For more details on matchmaker data, see Match\n Data.

" + "smithy.api#documentation": "

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions.

" } }, - "GameSessionId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "IpAddress": { + "target": "com.amazonaws.gamelift#IpAddress", "traits": { - "smithy.api#documentation": "

A unique identifier for the game session. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, - "DnsName": { - "target": "com.amazonaws.gamelift#DnsName", + "GameSessionQueueName": { + "target": "com.amazonaws.gamelift#GameSessionQueueName", "traits": { - "smithy.api#documentation": "

DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" + "smithy.api#documentation": "

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

" } }, - "GameSessionName": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "MatchmakerData": { + "target": "com.amazonaws.gamelift#MatchmakerData", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" + "smithy.api#documentation": "

Information on the matchmaking process for this game. Data is in JSON syntax,\n formatted as a string. It identifies the matchmaking configuration used to create the\n match, and contains data on all players assigned to the match, including player\n attributes and team assignments. For more details on matchmaker data, see Match\n Data.

" } }, - "Port": { - "target": "com.amazonaws.gamelift#PortNumber", + "MaximumPlayerSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

The maximum number of players that can be connected simultaneously to the game session.

" } }, - "GameSessionRegion": { + "GameSessionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Name of the Region where the game session created by this placement request is\n running. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

A unique identifier for the game session. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, - "IpAddress": { - "target": "com.amazonaws.gamelift#IpAddress", + "GameSessionArn": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" + "smithy.api#documentation": "

Identifier for the game session created by this placement request. This value is\n set once the new game session is placed (placement status is FULFILLED).\n This identifier is unique across all Regions. You can use this value as a\n GameSessionId value as needed.

" } }, - "Status": { - "target": "com.amazonaws.gamelift#GameSessionPlacementState", + "PlacementId": { + "target": "com.amazonaws.gamelift#IdStringModel", "traits": { - "smithy.api#documentation": "

Current status of the game session placement request.

\n " + "smithy.api#documentation": "

A unique identifier for a game session placement.

" } }, - "GameProperties": { - "target": "com.amazonaws.gamelift#GamePropertyList", + "DnsName": { + "target": "com.amazonaws.gamelift#DnsName", "traits": { - "smithy.api#documentation": "

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" } }, - "GameSessionData": { - "target": "com.amazonaws.gamelift#GameSessionData", + "GameProperties": { + "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, - "StartTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "GameSessionRegion": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Name of the Region where the game session created by this placement request is\n running. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, - "PlacedPlayerSessions": { - "target": "com.amazonaws.gamelift#PlacedPlayerSessionList", + "GameSessionName": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A collection of information on player sessions created in response to the game\n session placement request. These player sessions are created only once a new game\n session is successfully placed (placement status is FULFILLED). This\n information includes the player ID (as provided in the placement request) and the\n corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

" + "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" } }, - "PlayerLatencies": { - "target": "com.amazonaws.gamelift#PlayerLatencyList", + "Port": { + "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#documentation": "

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions.

" + "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).

" } }, - "EndTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "Status": { + "target": "com.amazonaws.gamelift#GameSessionPlacementState", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this request was completed, canceled, or timed\n out.

" + "smithy.api#documentation": "

Current status of the game session placement request.

\n " } } }, @@ -5994,6 +6192,12 @@ "com.amazonaws.gamelift#GameSessionQueue": { "type": "structure", "members": { + "Destinations": { + "target": "com.amazonaws.gamelift#GameSessionQueueDestinationList", + "traits": { + "smithy.api#documentation": "

A list of fleets that can be used to fulfill game session placement requests in the queue. \n Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

" + } + }, "Name": { "target": "com.amazonaws.gamelift#GameSessionQueueName", "traits": { @@ -6012,12 +6216,6 @@ "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift game session queue ARN, the resource ID matches the\n Name value.

" } }, - "Destinations": { - "target": "com.amazonaws.gamelift#GameSessionQueueDestinationList", - "traits": { - "smithy.api#documentation": "

A list of fleets that can be used to fulfill game session placement requests in the queue. \n Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

" - } - }, "TimeoutInSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -6167,7 +6365,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#GetGameSessionLogUrlOutput": { @@ -6181,7 +6379,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#GetInstanceAccess": { @@ -6207,7 +6405,7 @@ } ], "traits": { - "smithy.api#documentation": "

Requests remote access to a fleet instance. Remote access is useful for debugging,\n gathering benchmarking data, or observing activity in real time.

\n

To remotely access an instance, you need credentials that match the operating system\n of the instance. For a Windows instance, Amazon GameLift returns a user name and password as\n strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift\n returns a user name and RSA private key, also as strings, for use with an SSH client.\n The private key must be saved in the proper format to a .pem file before\n using. If you're making this request using the AWS CLI, saving the secret can be handled\n as part of the GetInstanceAccess request, as shown in one of the examples for this\n action.

\n

To request access to a specific instance, specify the IDs of both the instance and the\n fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess\n object is returned that contains the instance's IP address and a set of\n credentials.

\n

\n Learn more\n

\n

\n Remotely Access Fleet\n Instances\n

\n

\n Debug Fleet\n Issues\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Requests remote access to a fleet instance. Remote access is useful for debugging,\n gathering benchmarking data, or observing activity in real time.

\n

To remotely access an instance, you need credentials that match the operating system\n of the instance. For a Windows instance, Amazon GameLift returns a user name and password as\n strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift\n returns a user name and RSA private key, also as strings, for use with an SSH client.\n The private key must be saved in the proper format to a .pem file before\n using. If you're making this request using the AWS CLI, saving the secret can be handled\n as part of the GetInstanceAccess request, as shown in one of the examples for this\n operation.

\n

To request access to a specific instance, specify the IDs of both the instance and the\n fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess\n object is returned that contains the instance's IP address and a set of\n credentials.

\n

\n Learn more\n

\n

\n Remotely Access Fleet\n Instances\n

\n

\n Debug Fleet\n Issues\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#GetInstanceAccessInput": { @@ -6229,7 +6427,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#GetInstanceAccessOutput": { @@ -6243,7 +6441,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#IamRoleArn": { @@ -6287,6 +6485,12 @@ "smithy.api#documentation": "

EC2 instance type that defines the computing resources of this instance.\n

" } }, + "IpAddress": { + "target": "com.amazonaws.gamelift#IpAddress", + "traits": { + "smithy.api#documentation": "

IP address that is assigned to the instance.

" + } + }, "Status": { "target": "com.amazonaws.gamelift#InstanceStatus", "traits": { @@ -6299,12 +6503,6 @@ "smithy.api#documentation": "

DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" } }, - "IpAddress": { - "target": "com.amazonaws.gamelift#IpAddress", - "traits": { - "smithy.api#documentation": "

IP address that is assigned to the instance.

" - } - }, "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { @@ -6337,16 +6535,16 @@ "com.amazonaws.gamelift#InstanceAccess": { "type": "structure", "members": { - "OperatingSystem": { - "target": "com.amazonaws.gamelift#OperatingSystem", + "IpAddress": { + "target": "com.amazonaws.gamelift#IpAddress", "traits": { - "smithy.api#documentation": "

Operating system that is running on the instance.

" + "smithy.api#documentation": "

IP address that is assigned to the instance.

" } }, - "Credentials": { - "target": "com.amazonaws.gamelift#InstanceCredentials", + "OperatingSystem": { + "target": "com.amazonaws.gamelift#OperatingSystem", "traits": { - "smithy.api#documentation": "

Credentials required to access the instance.

" + "smithy.api#documentation": "

Operating system that is running on the instance.

" } }, "InstanceId": { @@ -6355,17 +6553,17 @@ "smithy.api#documentation": "

A unique identifier for an instance being accessed.

" } }, - "IpAddress": { - "target": "com.amazonaws.gamelift#IpAddress", - "traits": { - "smithy.api#documentation": "

IP address that is assigned to the instance.

" - } - }, "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "

A unique identifier for a fleet containing the instance being accessed.

" } + }, + "Credentials": { + "target": "com.amazonaws.gamelift#InstanceCredentials", + "traits": { + "smithy.api#documentation": "

Credentials required to access the instance.

" + } } }, "traits": { @@ -6411,7 +6609,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

An allowed instance type for your game server group. GameLift FleetIQ periodically evaluates each\n defined instance type for viability. It then updates the Auto Scaling group with the\n list of viable instance types.

" + "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift FleetIQ and game server groups.\n

\n

An allowed instance type for a GameServerGroup. All game server groups must have at least two\n instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type\n for viability. It then updates the Auto Scaling group with the list of viable instance\n types.

" } }, "com.amazonaws.gamelift#InstanceDefinitions": { @@ -6606,27 +6804,27 @@ "com.amazonaws.gamelift#LaunchTemplateSpecification": { "type": "structure", "members": { - "LaunchTemplateName": { - "target": "com.amazonaws.gamelift#LaunchTemplateName", + "LaunchTemplateId": { + "target": "com.amazonaws.gamelift#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

A readable identifier for an existing EC2 launch template.

" + "smithy.api#documentation": "

A unique identifier for an existing EC2 launch template.

" } }, "Version": { "target": "com.amazonaws.gamelift#LaunchTemplateVersion", "traits": { - "smithy.api#documentation": "

The version of the EC2 launch template to use. If no version is specified, the default\n version will be used. EC2 allows you to specify a default version for a launch template,\n if none is set, the default is the first version created.

" + "smithy.api#documentation": "

The version of the EC2 launch template to use. If no version is specified, the\n default version will be used. With Amazon EC2, you can specify a default version for a\n launch template. If none is set, the default is the first version created.

" } }, - "LaunchTemplateId": { - "target": "com.amazonaws.gamelift#LaunchTemplateId", + "LaunchTemplateName": { + "target": "com.amazonaws.gamelift#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

A unique identifier for an existing EC2 launch template.

" + "smithy.api#documentation": "

A readable identifier for an existing EC2 launch template.

" } } }, "traits": { - "smithy.api#documentation": "

\n This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

An EC2 launch template that contains configuration settings and game server code to be\n deployed to all instances in a game server group.

" + "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift FleetIQ and game server groups.\n

\n

An EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in a game server group. The launch template is specified\n when creating a new game server group with CreateGameServerGroup.

" } }, "com.amazonaws.gamelift#LaunchTemplateVersion": { @@ -6671,7 +6869,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all aliases for this AWS account. You can filter the result set by\n alias name and/or routing strategy type. Use the pagination parameters to retrieve\n results in sequential pages.

\n \n

Returned aliases are not listed in any particular order.

\n \n " + "smithy.api#documentation": "

Retrieves all aliases for this AWS account. You can filter the result set by\n alias name and/or routing strategy type. Use the pagination parameters to retrieve\n results in sequential pages.

\n \n

Returned aliases are not listed in any particular order.

\n \n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#ListAliasesInput": { @@ -6698,12 +6901,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ListAliasesOutput": { @@ -6712,7 +6915,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, "Aliases": { @@ -6723,7 +6926,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ListBuilds": { @@ -6746,33 +6949,38 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves build resources for all builds associated with the AWS account in use. You\n can limit results to builds that are in a specific status by using the\n Status parameter. Use the pagination parameters to retrieve results in\n a set of sequential pages.

\n \n

Build resources are not listed in any particular order.

\n \n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves build resources for all builds associated with the AWS account in use. You\n can limit results to builds that are in a specific status by using the\n Status parameter. Use the pagination parameters to retrieve results in\n a set of sequential pages.

\n \n

Build resources are not listed in any particular order.

\n \n

\n Learn more\n

\n

\n \n Upload a Custom Server Build\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#ListBuildsInput": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.gamelift#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" - } - }, "Status": { "target": "com.amazonaws.gamelift#BuildStatus", "traits": { "smithy.api#documentation": "

Build status to filter results by. To retrieve all builds, leave this parameter\n empty.

\n

Possible build statuses include the following:

\n " } }, + "Limit": { + "target": "com.amazonaws.gamelift#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + } + }, "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ListBuildsOutput": { @@ -6787,12 +6995,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ListFleets": { @@ -6818,7 +7026,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a collection of fleet resources for this AWS account. You can filter the\n result set to find only those fleets that are deployed with a specific build or script.\n Use the pagination parameters to retrieve results in sequential pages.

\n \n

Fleet resources are not listed in a particular order.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves a collection of fleet resources for this AWS account. You can filter the\n result set to find only those fleets that are deployed with a specific build or script.\n Use the pagination parameters to retrieve results in sequential pages.

\n \n

Fleet resources are not listed in a particular order.

\n \n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#ListFleetsInput": { @@ -6845,12 +7058,12 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ListFleetsOutput": { @@ -6859,7 +7072,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, "FleetIds": { @@ -6870,7 +7083,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ListGameServerGroups": { @@ -6893,7 +7106,12 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Retrieves information on all game servers groups that exist in the current AWS account\n for the selected region. Use the pagination parameters to retrieve results in a set of\n sequential pages.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on all game servers groups that exist in the current AWS\n account for the selected Region. Use the pagination parameters to retrieve results in a\n set of sequential segments.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#ListGameServerGroupsInput": { @@ -6902,13 +7120,13 @@ "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.

" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } } } @@ -6916,16 +7134,16 @@ "com.amazonaws.gamelift#ListGameServerGroupsOutput": { "type": "structure", "members": { - "GameServerGroups": { - "target": "com.amazonaws.gamelift#GameServerGroups", + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A collection of game server group objects that match the request.

" + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "GameServerGroups": { + "target": "com.amazonaws.gamelift#GameServerGroups", "traits": { - "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A collection of game server group objects that match the request.

" } } } @@ -6950,7 +7168,12 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Retrieves information on all game servers that are currently running in a specified\n game server group. If there are custom key sort values for your game servers, you can\n opt to have the returned list sorted based on these values. Use the pagination\n parameters to retrieve results in a set of sequential pages.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Retrieves information on all game servers that are currently active in a specified\n game server group. You can opt to sort the list by game server age. Use the\n pagination parameters to retrieve results in a set of sequential segments.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#ListGameServersInput": { @@ -6959,25 +7182,25 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } }, "SortOrder": { "target": "com.amazonaws.gamelift#SortOrder", "traits": { - "smithy.api#documentation": "

Indicates how to sort the returned data based on the game servers' custom key sort\n value. If this parameter is left empty, the list of game servers is returned in no\n particular order.

" + "smithy.api#documentation": "

Indicates how to sort the returned data based on game server registration timestamp. \n Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve\n newest game servers first. If this parameter is left empty, game servers \n are returned in no particular order.

" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.

" } }, "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

An identifier for the game server group for the game server you want to list. Use\n either the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

An identifier for the game server group to retrieve a list of game servers from. \n Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } } @@ -6995,7 +7218,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } } } @@ -7020,7 +7243,12 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves script records for all Realtime scripts that are associated with the AWS account in use.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Retrieves script records for all Realtime scripts that are associated with the AWS account in use.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related operations\n

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#ListScriptsInput": { @@ -7035,7 +7263,7 @@ "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } } } @@ -7043,16 +7271,16 @@ "com.amazonaws.gamelift#ListScriptsOutput": { "type": "structure", "members": { - "Scripts": { - "target": "com.amazonaws.gamelift#ScriptList", + "NextToken": { + "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

A set of properties describing the requested script.

" + "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" } }, - "NextToken": { - "target": "com.amazonaws.gamelift#NonEmptyString", + "Scripts": { + "target": "com.amazonaws.gamelift#ScriptList", "traits": { - "smithy.api#documentation": "

A token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + "smithy.api#documentation": "

A set of properties describing the requested script.

" } } } @@ -7080,7 +7308,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Retrieves all tags that are assigned to a GameLift resource. \n Resource tags are used to organize AWS resources for a range of purposes. \n This action handles the permissions necessary to manage tags for the following \n GameLift resource types:

\n \n

To list tags for a resource, specify the unique ARN value for the resource.

\n

\n Learn more\n

\n

\n Tagging AWS Resources in the\n AWS General Reference\n

\n

\n \n AWS Tagging Strategies\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n Retrieves all tags that are assigned to a GameLift resource. \n Resource tags are used to organize AWS resources for a range of purposes. \n This operation handles the permissions necessary to manage tags for the following \n GameLift resource types:

\n \n

To list tags for a resource, specify the unique ARN value for the resource.

\n

\n Learn more\n

\n

\n Tagging AWS Resources in the\n AWS General Reference\n

\n

\n \n AWS Tagging Strategies\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#ListTagsForResourceRequest": { @@ -7089,7 +7317,7 @@ "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to retrieve\n tags for. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe action for the resource type.

", + "smithy.api#documentation": "

\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to retrieve\n tags for. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe operation for the resource type.

", "smithy.api#required": {} } } @@ -7154,100 +7382,100 @@ "com.amazonaws.gamelift#MatchmakingConfiguration": { "type": "structure", "members": { - "BackfillMode": { - "target": "com.amazonaws.gamelift#BackfillMode", + "GameProperties": { + "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

The method used to backfill game sessions created with this matchmaking configuration.\n MANUAL indicates that the game makes backfill requests or does not use the match\n backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch.

" + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" } }, - "AcceptanceRequired": { - "target": "com.amazonaws.gamelift#BooleanModel", + "AcceptanceTimeoutSeconds": { + "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", "traits": { - "smithy.api#documentation": "

A flag that indicates whether a match that was created with this configuration must be\n accepted by the matched players. To require acceptance, set to TRUE.

" + "smithy.api#documentation": "

The length of time (in seconds) to wait for players to accept a proposed match. If any\n player rejects the match or fails to accept before the timeout, the ticket continues to\n look for an acceptable match.

" } }, - "ConfigurationArn": { - "target": "com.amazonaws.gamelift#MatchmakingConfigurationArn", + "Name": { + "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift configuration ARN, the resource ID matches the\n Name value.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.

" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "RequestTimeoutSeconds": { + "target": "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger", "traits": { - "smithy.api#documentation": "

The time stamp indicating when this data object was created. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.

" } }, - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "CustomEventData": { + "target": "com.amazonaws.gamelift#CustomEventData", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with matchmaking configuration.

" + "smithy.api#documentation": "

Information to attach to all events related to the matchmaking configuration.

" } }, - "GameSessionQueueArns": { - "target": "com.amazonaws.gamelift#QueueArnsList", + "NotificationTarget": { + "target": "com.amazonaws.gamelift#SnsArnStringModel", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. GameLift uses the listed queues when placing game sessions for matches that are\n created with this matchmaking configuration. Queues can be located in any Region.

" + "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications.

" } }, - "GameSessionData": { - "target": "com.amazonaws.gamelift#GameSessionData", + "AcceptanceRequired": { + "target": "com.amazonaws.gamelift#BooleanModel", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match.

" + "smithy.api#documentation": "

A flag that indicates whether a match that was created with this configuration must be\n accepted by the matched players. To require acceptance, set to TRUE.

" } }, - "RuleSetArn": { - "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", + "BackfillMode": { + "target": "com.amazonaws.gamelift#BackfillMode", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

" + "smithy.api#documentation": "

The method used to backfill game sessions created with this matchmaking configuration.\n MANUAL indicates that the game makes backfill requests or does not use the match\n backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch.

" } }, - "AdditionalPlayerCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "ConfigurationArn": { + "target": "com.amazonaws.gamelift#MatchmakingConfigurationArn", "traits": { - "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, \n assume that the configuration's rule set specifies a match for a single 12-person team. If\n the additional player count is set to 2, only 10 players are initially selected for the match.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift configuration ARN, the resource ID matches the\n Name value.

" } }, - "RuleSetName": { - "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", + "Description": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use\n rule sets that are defined in the same Region.

" + "smithy.api#documentation": "

A descriptive label that is associated with matchmaking configuration.

" } }, - "GameProperties": { - "target": "com.amazonaws.gamelift#GamePropertyList", + "RuleSetArn": { + "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

" } }, - "AcceptanceTimeoutSeconds": { - "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", + "GameSessionQueueArns": { + "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { - "smithy.api#documentation": "

The length of time (in seconds) to wait for players to accept a proposed match. If any\n player rejects the match or fails to accept before the timeout, the ticket continues to\n look for an acceptable match.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. GameLift uses the listed queues when placing game sessions for matches that are\n created with this matchmaking configuration. Queues can be located in any Region.

" } }, - "NotificationTarget": { - "target": "com.amazonaws.gamelift#SnsArnStringModel", + "GameSessionData": { + "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications.

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match.

" } }, - "RequestTimeoutSeconds": { - "target": "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger", + "CreationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.

" + "smithy.api#documentation": "

The time stamp indicating when this data object was created. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "CustomEventData": { - "target": "com.amazonaws.gamelift#CustomEventData", + "AdditionalPlayerCount": { + "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

Information to attach to all events related to the matchmaking configuration.

" + "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, \n assume that the configuration's rule set specifies a match for a single 12-person team. If\n the additional player count is set to 2, only 10 players are initially selected for the match.

" } }, - "Name": { + "RuleSetName": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use\n rule sets that are defined in the same Region.

" } } }, @@ -7350,6 +7578,12 @@ "smithy.api#documentation": "

A unique identifier for a matchmaking rule set

" } }, + "RuleSetArn": { + "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift rule set ARN, the resource ID matches the\n RuleSetName value.

" + } + }, "RuleSetBody": { "target": "com.amazonaws.gamelift#RuleSetBody", "traits": { @@ -7362,12 +7596,6 @@ "traits": { "smithy.api#documentation": "

The time stamp indicating when this data object was created. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } - }, - "RuleSetArn": { - "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift rule set ARN, the resource ID matches the\n RuleSetName value.

" - } } }, "traits": { @@ -7412,22 +7640,16 @@ "com.amazonaws.gamelift#MatchmakingTicket": { "type": "structure", "members": { - "TicketId": { - "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", - "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket.

" - } - }, "ConfigurationName": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "

Name of the MatchmakingConfiguration that is used with this\n ticket. Matchmaking configurations determine how players are grouped into a match and\n how a new game session is created for the match.

" } }, - "EstimatedWaitTime": { - "target": "com.amazonaws.gamelift#WholeNumber", + "Players": { + "target": "com.amazonaws.gamelift#PlayerList", "traits": { - "smithy.api#documentation": "

Average amount of time (in seconds) that players are currently waiting for a match.\n If there is not enough recent data, this property may be empty.

" + "smithy.api#documentation": "

A set of Player objects, each representing a player to find matches\n for. Players are identified by a unique player ID and may include latency data for use\n during matchmaking. If the ticket is in status COMPLETED, the\n Player objects include the team the players were assigned to in the\n resulting match.

" } }, "GameSessionConnectionInfo": { @@ -7436,16 +7658,10 @@ "smithy.api#documentation": "

Identifier and connection information of the game session created for the match.\n This information is added to the ticket only after the matchmaking request has been\n successfully completed.

" } }, - "Status": { - "target": "com.amazonaws.gamelift#MatchmakingConfigurationStatus", - "traits": { - "smithy.api#documentation": "

Current status of the matchmaking request.

\n \n \n

Matchmaking requests that fail to successfully complete (statuses FAILED,\n CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket\n IDs.

\n " - } - }, - "StartTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "TicketId": { + "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket.

" } }, "StatusReason": { @@ -7454,10 +7670,16 @@ "smithy.api#documentation": "

Code to explain the current status. For example, a status reason may indicate when\n a ticket has returned to SEARCHING status after a proposed match fails to\n receive player acceptances.

" } }, - "StatusMessage": { - "target": "com.amazonaws.gamelift#StringModel", + "EstimatedWaitTime": { + "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

Additional information about the current status.

" + "smithy.api#documentation": "

Average amount of time (in seconds) that players are currently waiting for a match.\n If there is not enough recent data, this property may be empty.

" + } + }, + "StartTime": { + "target": "com.amazonaws.gamelift#Timestamp", + "traits": { + "smithy.api#documentation": "

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, "EndTime": { @@ -7466,16 +7688,22 @@ "smithy.api#documentation": "

Time stamp indicating when this matchmaking request stopped being processed due to\n success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, + "StatusMessage": { + "target": "com.amazonaws.gamelift#StringModel", + "traits": { + "smithy.api#documentation": "

Additional information about the current status.

" + } + }, "ConfigurationArn": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.

" } }, - "Players": { - "target": "com.amazonaws.gamelift#PlayerList", + "Status": { + "target": "com.amazonaws.gamelift#MatchmakingConfigurationStatus", "traits": { - "smithy.api#documentation": "

A set of Player objects, each representing a player to find matches\n for. Players are identified by a unique player ID and may include latency data for use\n during matchmaking. If the ticket is in status COMPLETED, the\n Player objects include the team the players were assigned to in the\n resulting match.

" + "smithy.api#documentation": "

Current status of the matchmaking request.

\n \n \n

Matchmaking requests that fail to successfully complete (statuses FAILED,\n CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket\n IDs.

\n " } } }, @@ -7674,10 +7902,10 @@ "com.amazonaws.gamelift#Player": { "type": "structure", "members": { - "LatencyInMs": { - "target": "com.amazonaws.gamelift#LatencyMap", + "Team": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only\n in Regions for which latency is reported.

\n

If a matchmaker has a rule that evaluates player latency, players must report\n latency in order to be matched. If no latency is reported in this scenario, FlexMatch\n assumes that no Regions are available to the player and the ticket is not matchable.\n

" + "smithy.api#documentation": "

Name of the team that the player is assigned to in a match. Team names are defined\n in a matchmaking rule set.

" } }, "PlayerAttributes": { @@ -7686,10 +7914,10 @@ "smithy.api#documentation": "

A collection of key:value pairs containing player information for use in matchmaking.\n Player attribute keys must match the playerAttributes used in a\n matchmaking rule set. Example: \"PlayerAttributes\": {\"skill\": {\"N\": \"23\"},\n \"gameMode\": {\"S\": \"deathmatch\"}}.

" } }, - "Team": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "LatencyInMs": { + "target": "com.amazonaws.gamelift#LatencyMap", "traits": { - "smithy.api#documentation": "

Name of the team that the player is assigned to in a match. Team names are defined\n in a matchmaking rule set.

" + "smithy.api#documentation": "

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only\n in Regions for which latency is reported.

\n

If a matchmaker has a rule that evaluates player latency, players must report\n latency in order to be matched. If no latency is reported in this scenario, FlexMatch\n assumes that no Regions are available to the player and the ticket is not matchable.\n

" } }, "PlayerId": { @@ -7821,22 +8049,16 @@ "smithy.api#documentation": "

Current status of the player session.

\n

Possible player session statuses include the following:

\n " } }, - "Port": { - "target": "com.amazonaws.gamelift#PortNumber", - "traits": { - "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift server process, an app\n needs both the IP address and port number.

" - } - }, - "PlayerId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "TerminationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

A unique identifier for a player that is associated with this player session.

" + "smithy.api#documentation": "

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + "PlayerSessionId": { + "target": "com.amazonaws.gamelift#PlayerSessionId", "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet that the player's game session is running on.

" + "smithy.api#documentation": "

A unique identifier for a player session.

" } }, "DnsName": { @@ -7845,10 +8067,16 @@ "smithy.api#documentation": "

DNS identifier assigned to the instance that is running the game session. Values have\n the following format:

\n \n

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

" } }, - "PlayerSessionId": { - "target": "com.amazonaws.gamelift#PlayerSessionId", + "PlayerId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for a player session.

" + "smithy.api#documentation": "

A unique identifier for a player that is associated with this player session.

" + } + }, + "Port": { + "target": "com.amazonaws.gamelift#PortNumber", + "traits": { + "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift server process, an app\n needs both the IP address and port number.

" } }, "CreationTime": { @@ -7857,10 +8085,16 @@ "smithy.api#documentation": "

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "TerminationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", + "traits": { + "smithy.api#documentation": "

A unique identifier for a fleet that the player's game session is running on.

" + } + }, + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on. \n

" } }, "IpAddress": { @@ -7874,12 +8108,6 @@ "traits": { "smithy.api#documentation": "

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" } - }, - "FleetArn": { - "target": "com.amazonaws.gamelift#FleetArn", - "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on. \n

" - } } }, "traits": { @@ -8029,6 +8257,18 @@ "smithy.api#documentation": "

Amount of adjustment to make, based on the scaling adjustment type.

" } }, + "EvaluationPeriods": { + "target": "com.amazonaws.gamelift#PositiveInteger", + "traits": { + "smithy.api#documentation": "

Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.

" + } + }, + "Threshold": { + "target": "com.amazonaws.gamelift#Double", + "traits": { + "smithy.api#documentation": "

Metric value used to trigger a scaling event.

" + } + }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { @@ -8042,18 +8282,6 @@ "smithy.api#documentation": "

The type of adjustment to make to a fleet's instance count (see FleetCapacity):

\n " } }, - "Threshold": { - "target": "com.amazonaws.gamelift#Double", - "traits": { - "smithy.api#documentation": "

Metric value used to trigger a scaling event.

" - } - }, - "ComparisonOperator": { - "target": "com.amazonaws.gamelift#ComparisonOperatorType", - "traits": { - "smithy.api#documentation": "

Comparison operator to use when measuring the metric against the threshold\n value.

" - } - }, "PolicyType": { "target": "com.amazonaws.gamelift#PolicyType", "traits": { @@ -8066,10 +8294,10 @@ "smithy.api#documentation": "

The settings for a target-based scaling policy.

" } }, - "EvaluationPeriods": { - "target": "com.amazonaws.gamelift#PositiveInteger", + "ComparisonOperator": { + "target": "com.amazonaws.gamelift#ComparisonOperatorType", "traits": { - "smithy.api#documentation": "

Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.

" + "smithy.api#documentation": "

Comparison operator to use when measuring the metric against the threshold\n value.

" } }, "MetricName": { @@ -8088,7 +8316,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#PutScalingPolicyOutput": { @@ -8102,7 +8330,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#QueueArnsList": { @@ -8137,54 +8365,42 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready\n to host gameplay and players. This action is called by a game server process that is\n running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to\n track available game servers and enables game clients and services to claim a game\n server for a new game session.

\n

To register a game server, identify the game server group and instance where the game\n server is running, and provide a unique identifier for the game server. You can also\n include connection and game server data; when a game client or service requests a game\n server by calling ClaimGameServer, this information is returned in\n response.

\n

Once a game server is successfully registered, it is put in status AVAILABLE. A\n request to register a game server may fail if the instance it is in the process of\n shutting down as part of instance rebalancing or scale-down activity.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to\n host gameplay and players. This operation is called by a game server process that is\n running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to\n track available game servers and enables game clients and services to claim a game\n server for a new game session.

\n

To register a game server, identify the game server group and instance where the game\n server is running, and provide a unique identifier for the game server. You can also\n include connection and game server data. When a game client or service requests a game\n server by calling ClaimGameServer, this information is returned in the\n response.

\n

Once a game server is successfully registered, it is put in status\n AVAILABLE. A request to register a game server may fail if the instance\n it is running on is in the process of shutting down as part of instance balancing or\n scale-down activity.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#RegisterGameServerInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.gamelift#TagList", - "traits": { - "smithy.api#documentation": "

A list of labels to assign to the new game server resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management, and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.

" - } - }, - "GameServerId": { - "target": "com.amazonaws.gamelift#GameServerId", + "ConnectionInfo": { + "target": "com.amazonaws.gamelift#GameServerConnectionInfo", "traits": { - "smithy.api#documentation": "

A custom string that uniquely identifies the new game server. Game server IDs are developer-defined\n and must be unique across all game server groups in your AWS account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Information that is needed to make inbound client connections to the game server. This\n might include the IP address and port, DNS name, and other information.

" } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data is \n passed to a game client or service when it requests information on a game servers using \n ListGameServers or ClaimGameServer.

" + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" } }, - "CustomSortKey": { - "target": "com.amazonaws.gamelift#GameServerSortKey", - "traits": { - "smithy.api#documentation": "

A game server tag that can be used to request sorted lists of game servers using\n ListGameServers. Custom sort keys\n are developer-defined based on how you want to organize the retrieved game server information.

" - } - }, - "ConnectionInfo": { - "target": "com.amazonaws.gamelift#GameServerConnectionInfo", + "GameServerId": { + "target": "com.amazonaws.gamelift#GameServerId", "traits": { - "smithy.api#documentation": "

Information needed to make inbound client connections to the game server. This might\n include IP address and port, DNS name, etc.

" + "smithy.api#documentation": "

A custom string that uniquely identifies the game server to register. \n Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

", + "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.gamelift#GameServerInstanceId", "traits": { - "smithy.api#documentation": "

The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata.

", + "smithy.api#documentation": "

The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.

", "smithy.api#required": {} } }, "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

An identifier for the game server group where the game server is running. You can \n use either the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } } @@ -8196,7 +8412,7 @@ "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { - "smithy.api#documentation": "

Object that describes the newly created game server resource.

" + "smithy.api#documentation": "

Object that describes the newly registered game server.

" } } } @@ -8239,7 +8455,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#RequestUploadCredentialsOutput": { @@ -8259,7 +8475,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ResolveAlias": { @@ -8303,7 +8519,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ResolveAliasOutput": { @@ -8323,7 +8539,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ResourceCreationLimitPolicy": { @@ -8369,7 +8585,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Reinstates activity on a game server group after it has been suspended. A game server\n group may be suspended by calling SuspendGameServerGroup, or it may\n have been involuntarily suspended due to a configuration problem. You can manually\n resume activity on the group once the configuration problem has been resolved. Refer to\n the game server group status and status reason for more information on why group\n activity is suspended.

\n

To resume activity, specify a game server group ARN and the type of activity to be resumed.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Reinstates activity on a game server group after it has been suspended. A game server\n group might be suspended by theSuspendGameServerGroup operation, or it\n might be suspended involuntarily due to a configuration problem. In the second case, you\n can manually resume activity on the group once the configuration problem has been\n resolved. Refer to the game server group status and status reason for more information\n on why group activity is suspended.

\n

To resume activity, specify a game server group ARN and the type of activity to be\n resumed. If successful, a GameServerGroup object is returned showing\n that the resumed activity is no longer listed in SuspendedActions.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#ResumeGameServerGroupInput": { @@ -8378,14 +8594,14 @@ "ResumeActions": { "target": "com.amazonaws.gamelift#GameServerGroupActions", "traits": { - "smithy.api#documentation": "

The action to resume for this game server group.

", + "smithy.api#documentation": "

The activity to resume for this game server group.

", "smithy.api#required": {} } }, "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the game server group to resume activity on. Use either the\n GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } } @@ -8397,7 +8613,7 @@ "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { - "smithy.api#documentation": "

An object that describes the game server group resource, with the\n SuspendedActions property updated to reflect the resumed\n activity.

" + "smithy.api#documentation": "

An object that describes the game server group resource, with the\n SuspendedActions property updated to reflect the resumed\n activity.

" } } } @@ -8494,13 +8710,13 @@ "Bucket": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

An S3 bucket identifier. This is the name of the S3 bucket.

" + "smithy.api#documentation": "

An S3 bucket identifier. This is the name of the S3 bucket.

\n \n

GameLift currently does not support uploading from S3 buckets with names that contain a dot (.).

\n " } }, - "Key": { + "ObjectVersion": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the zip file that contains the build files or script files.

" + "smithy.api#documentation": "

The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses\n this information when retrieving files from an S3 bucket that you own. Use this\n parameter to specify a specific version of the file. If not set, the latest version of\n the file is retrieved.

" } }, "RoleArn": { @@ -8509,10 +8725,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access the S3 bucket.

" } }, - "ObjectVersion": { + "Key": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses\n this information when retrieving files from an S3 bucket that you own. Use this\n parameter to specify a specific version of the file. If not set, the latest version of\n the file is retrieved.

" + "smithy.api#documentation": "

The name of the zip file that contains the build files or script files.

" } } }, @@ -8542,34 +8758,28 @@ "com.amazonaws.gamelift#ScalingPolicy": { "type": "structure", "members": { - "MetricName": { - "target": "com.amazonaws.gamelift#MetricName", - "traits": { - "smithy.api#documentation": "

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon GameLift\n with Amazon CloudWatch.

\n " - } - }, "ScalingAdjustment": { "target": "com.amazonaws.gamelift#Integer", "traits": { "smithy.api#documentation": "

Amount of adjustment to make, based on the scaling adjustment type.

" } }, - "Status": { - "target": "com.amazonaws.gamelift#ScalingStatusType", + "MetricName": { + "target": "com.amazonaws.gamelift#MetricName", "traits": { - "smithy.api#documentation": "

Current status of the scaling policy. The scaling policy can be in force only when\n in an ACTIVE status. Scaling policies can be suspended for individual\n fleets (see StopFleetActions; if suspended for a fleet, the policy\n status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.

\n " + "smithy.api#documentation": "

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon GameLift\n with Amazon CloudWatch.

\n " } }, - "TargetConfiguration": { - "target": "com.amazonaws.gamelift#TargetConfiguration", + "Threshold": { + "target": "com.amazonaws.gamelift#Double", "traits": { - "smithy.api#documentation": "

The settings for a target-based scaling policy.

" + "smithy.api#documentation": "

Metric value used to trigger a scaling event.

" } }, - "ComparisonOperator": { - "target": "com.amazonaws.gamelift#ComparisonOperatorType", + "ScalingAdjustmentType": { + "target": "com.amazonaws.gamelift#ScalingAdjustmentType", "traits": { - "smithy.api#documentation": "

Comparison operator to use when measuring a metric against the threshold\n value.

" + "smithy.api#documentation": "

The type of adjustment to make to a fleet's instance count (see FleetCapacity):

\n " } }, "Name": { @@ -8578,22 +8788,28 @@ "smithy.api#documentation": "

A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

" } }, - "Threshold": { - "target": "com.amazonaws.gamelift#Double", + "EvaluationPeriods": { + "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

Metric value used to trigger a scaling event.

" + "smithy.api#documentation": "

Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.

" } }, - "ScalingAdjustmentType": { - "target": "com.amazonaws.gamelift#ScalingAdjustmentType", + "ComparisonOperator": { + "target": "com.amazonaws.gamelift#ComparisonOperatorType", "traits": { - "smithy.api#documentation": "

The type of adjustment to make to a fleet's instance count (see FleetCapacity):

\n " + "smithy.api#documentation": "

Comparison operator to use when measuring a metric against the threshold\n value.

" } }, - "EvaluationPeriods": { - "target": "com.amazonaws.gamelift#PositiveInteger", + "TargetConfiguration": { + "target": "com.amazonaws.gamelift#TargetConfiguration", "traits": { - "smithy.api#documentation": "

Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.

" + "smithy.api#documentation": "

The settings for a target-based scaling policy.

" + } + }, + "Status": { + "target": "com.amazonaws.gamelift#ScalingStatusType", + "traits": { + "smithy.api#documentation": "

Current status of the scaling policy. The scaling policy can be in force only when\n in an ACTIVE status. Scaling policies can be suspended for individual\n fleets (see StopFleetActions; if suspended for a fleet, the policy\n status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.

\n " } }, "PolicyType": { @@ -8657,15 +8873,15 @@ "com.amazonaws.gamelift#Script": { "type": "structure", "members": { - "StorageLocation": { - "target": "com.amazonaws.gamelift#S3Location" - }, - "SizeOnDisk": { - "target": "com.amazonaws.gamelift#PositiveLong", + "Name": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

The file size of the uploaded Realtime script, expressed in bytes. When files are\n uploaded from an S3 location, this value remains at \"0\".

" + "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique.

" } }, + "StorageLocation": { + "target": "com.amazonaws.gamelift#S3Location" + }, "ScriptArn": { "target": "com.amazonaws.gamelift#ScriptArn", "traits": { @@ -8678,16 +8894,16 @@ "smithy.api#documentation": "

The version that is associated with a build or script. Version strings do not need to be unique.

" } }, - "CreationTime": { - "target": "com.amazonaws.gamelift#Timestamp", + "SizeOnDisk": { + "target": "com.amazonaws.gamelift#PositiveLong", "traits": { - "smithy.api#documentation": "

A time stamp indicating when this data object was created. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

The file size of the uploaded Realtime script, expressed in bytes. When files are\n uploaded from an S3 location, this value remains at \"0\".

" } }, - "Name": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "CreationTime": { + "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a script. Script names do not need to be unique.

" + "smithy.api#documentation": "

A time stamp indicating when this data object was created. The format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, "ScriptId": { @@ -8751,28 +8967,39 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all active game sessions that match a set of search criteria and sorts\n them in a specified order. You can search or sort by the following game session\n attributes:

\n \n \n

Returned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.

\n \n

To search or sort, specify either a fleet ID or an alias ID, and provide a search\n filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination\n parameters to retrieve results as a set of sequential pages.

\n

You can search for game sessions one fleet at a time only. To find game sessions\n across multiple fleets, you must search each fleet separately and combine the results.\n This search feature finds only game sessions that are in ACTIVE status. To\n locate games in statuses other than active, use DescribeGameSessionDetails.

\n " + "smithy.api#documentation": "

Retrieves all active game sessions that match a set of search criteria and sorts\n them in a specified order. You can search or sort by the following game session\n attributes:

\n \n \n

Returned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.

\n \n

To search or sort, specify either a fleet ID or an alias ID, and provide a search\n filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination\n parameters to retrieve results as a set of sequential pages.

\n

You can search for game sessions one fleet at a time only. To find game sessions\n across multiple fleets, you must search each fleet separately and combine the results.\n This search feature finds only game sessions that are in ACTIVE status. To\n locate games in statuses other than active, use DescribeGameSessionDetails.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.gamelift#SearchGameSessionsInput": { "type": "structure", "members": { - "FilterExpression": { + "SortExpression": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

String containing the search criteria for the session search. If no filter\n expression is included, the request returns results for all game sessions in the fleet\n that are in ACTIVE status.

\n

A filter expression can contain one or multiple conditions. Each condition consists\n of the following:

\n \n

To chain multiple conditions in a single expression, use the logical keywords\n AND, OR, and NOT and parentheses as needed.\n For example: x AND y AND NOT z, NOT (x OR y).

\n

Session search evaluates conditions from left to right using the following\n precedence rules:

\n
    \n
  1. \n

    \n =, <>, <, >,\n <=, >=\n

    \n
    2. \n
  2. \n

    Parentheses

    \n
    3. \n
  3. \n

    NOT

    \n
    4. \n
  4. \n

    AND

    \n
    5. \n
  5. \n

    OR

    \n
    6. \n
\n

For example, this filter expression retrieves game sessions hosting at least ten\n players that have an open player slot: \"maximumSessions>=10 AND\n hasAvailablePlayerSessions=true\".

" + "smithy.api#documentation": "

Instructions on how to sort the search results. If no sort expression is included,\n the request returns results in random order. A sort expression consists of the following\n elements:

\n \n

For example, this sort expression returns the oldest active sessions first:\n \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value\n for the sort operand are returned at the end of the list.

" } }, - "SortExpression": { + "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Instructions on how to sort the search results. If no sort expression is included,\n the request returns results in random order. A sort expression consists of the following\n elements:

\n \n

For example, this sort expression returns the oldest active sessions first:\n \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value\n for the sort operand are returned at the end of the list.

" + "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

" } }, - "NextToken": { + "FilterExpression": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + "smithy.api#documentation": "

String containing the search criteria for the session search. If no filter\n expression is included, the request returns results for all game sessions in the fleet\n that are in ACTIVE status.

\n

A filter expression can contain one or multiple conditions. Each condition consists\n of the following:

\n \n

To chain multiple conditions in a single expression, use the logical keywords\n AND, OR, and NOT and parentheses as needed.\n For example: x AND y AND NOT z, NOT (x OR y).

\n

Session search evaluates conditions from left to right using the following\n precedence rules:

\n
    \n
  1. \n

    \n =, <>, <, >,\n <=, >=\n

    \n
    2. \n
  2. \n

    Parentheses

    \n
    3. \n
  3. \n

    NOT

    \n
    4. \n
  4. \n

    AND

    \n
    5. \n
  5. \n

    OR

    \n
    6. \n
\n

For example, this filter expression retrieves game sessions hosting at least ten\n players that have an open player slot: \"maximumSessions>=10 AND\n hasAvailablePlayerSessions=true\".

" + } + }, + "AliasId": { + "target": "com.amazonaws.gamelift#AliasIdOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either\n the alias ID or ARN value. Each request must reference either a fleet ID or alias ID,\n but not both.

" } }, "Limit": { @@ -8786,45 +9013,39 @@ "traits": { "smithy.api#documentation": "

A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN\n value. Each request must reference either a fleet ID or alias ID, but not both.

" } - }, - "AliasId": { - "target": "com.amazonaws.gamelift#AliasIdOrArn", - "traits": { - "smithy.api#documentation": "

A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either\n the alias ID or ARN value. Each request must reference either a fleet ID or alias ID,\n but not both.

" - } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#SearchGameSessionsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", - "traits": { - "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" - } - }, "GameSessions": { "target": "com.amazonaws.gamelift#GameSessionList", "traits": { "smithy.api#documentation": "

A collection of objects containing game session properties for each session matching\n the request.

" } + }, + "NextToken": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

Token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#ServerProcess": { "type": "structure", "members": { - "ConcurrentExecutions": { - "target": "com.amazonaws.gamelift#PositiveInteger", + "LaunchPath": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

The number of server processes that use this configuration to run concurrently on an\n instance.

", + "smithy.api#documentation": "

The location of the server executable in a custom game build or the name of the Realtime\n script file that contains the Init() function. Game builds and Realtime\n scripts are installed on instances at the root:

\n ", "smithy.api#required": {} } }, @@ -8834,10 +9055,10 @@ "smithy.api#documentation": "

An optional list of parameters to pass to the server executable or Realtime script on\n launch.

" } }, - "LaunchPath": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "ConcurrentExecutions": { + "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { - "smithy.api#documentation": "

The location of the server executable in a custom game build or the name of the Realtime\n script file that contains the Init() function. Game builds and Realtime\n scripts are installed on instances at the root:

\n ", + "smithy.api#documentation": "

The number of server processes that use this configuration to run concurrently on an\n instance.

", "smithy.api#required": {} } } @@ -8961,16 +9182,16 @@ "com.amazonaws.gamelift#StartGameSessionPlacementInput": { "type": "structure", "members": { - "GameSessionData": { - "target": "com.amazonaws.gamelift#GameSessionData", + "PlayerLatencies": { + "target": "com.amazonaws.gamelift#PlayerLatencyList", "traits": { - "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" + "smithy.api#documentation": "

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions. This information is used to try to place the new game session where\n it can offer the best possible gameplay experience for the players.

" } }, - "GameSessionName": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "GameSessionData": { + "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" + "smithy.api#documentation": "

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, "GameProperties": { @@ -8979,12 +9200,6 @@ "smithy.api#documentation": "

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).

" } }, - "PlayerLatencies": { - "target": "com.amazonaws.gamelift#PlayerLatencyList", - "traits": { - "smithy.api#documentation": "

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS Regions. This information is used to try to place the new game session where\n it can offer the best possible gameplay experience for the players.

" - } - }, "DesiredPlayerSessions": { "target": "com.amazonaws.gamelift#DesiredPlayerSessionList", "traits": { @@ -8998,6 +9213,12 @@ "smithy.api#required": {} } }, + "GameSessionName": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" + } + }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -9014,7 +9235,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StartGameSessionPlacementOutput": { @@ -9028,7 +9249,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StartMatchBackfill": { @@ -9067,11 +9288,10 @@ "smithy.api#required": {} } }, - "ConfigurationName": { - "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", + "TicketId": { + "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

Name of the matchmaker to use for this request. You can use either the configuration\n name or ARN value. The ARN of the matchmaker that was used with the original game\n session is listed in the GameSession object,\n MatchmakerData property.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the match backfill ticket status and retrieve match\n results.

" } }, "GameSessionArn": { @@ -9081,15 +9301,16 @@ "smithy.api#required": {} } }, - "TicketId": { - "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", + "ConfigurationName": { + "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the match backfill ticket status and retrieve match\n results.

" + "smithy.api#documentation": "

Name of the matchmaker to use for this request. You can use either the configuration\n name or ARN value. The ARN of the matchmaker that was used with the original game\n session is listed in the GameSession object,\n MatchmakerData property.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StartMatchBackfillOutput": { @@ -9103,7 +9324,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StartMatchmaking": { @@ -9129,12 +9350,19 @@ } ], "traits": { - "smithy.api#documentation": "

Uses FlexMatch to create a game match for a group of players based on custom\n matchmaking rules, and starts a new game for the matched players. Each matchmaking\n request specifies the type of match to build (team configuration, rules for an\n acceptable match, etc.). The request also specifies the players to find a match for and\n where to host the new game session for optimal performance. A matchmaking request might\n start with a single player or a group of players who want to play together. FlexMatch\n finds additional players as needed to fill the match. Match type, rules, and the queue\n used to place a new game session are defined in a MatchmakingConfiguration.\n

\n

To start matchmaking, provide a unique ticket ID, specify a matchmaking\n configuration, and include the players to be matched. You must also include a set of\n player attributes relevant for the matchmaking configuration. If successful, a\n matchmaking ticket is returned with status set to QUEUED. Track the status\n of the ticket to respond as needed and acquire game session connection information for\n successfully completed matches.

\n

\n Tracking ticket status -- A couple of options are\n available for tracking the status of matchmaking requests:

\n \n

\n Processing a matchmaking request -- FlexMatch\n handles a matchmaking request as follows:

\n
    \n
  1. \n

    Your client code submits a StartMatchmaking request for one or\n more players and tracks the status of the request ticket.

    \n
    2. \n
  2. \n

    FlexMatch uses this ticket and others in process to build an acceptable\n match. When a potential match is identified, all tickets in the proposed match\n are advanced to the next status.

    \n
    3. \n
  3. \n

    If the match requires player acceptance (set in the matchmaking\n configuration), the tickets move into status REQUIRES_ACCEPTANCE.\n This status triggers your client code to solicit acceptance from all players in\n every ticket involved in the match, and then call AcceptMatch\n for each player. If any player rejects or fails to accept the match before a\n specified timeout, the proposed match is dropped (see AcceptMatch\n for more details).

    \n
    4. \n
  4. \n

    Once a match is proposed and accepted, the matchmaking tickets move into\n status PLACING. FlexMatch locates resources for a new game session\n using the game session queue (set in the matchmaking configuration) and creates\n the game session based on the match data.

    \n
    5. \n
  5. \n

    When the match is successfully placed, the matchmaking tickets move into\n COMPLETED status. Connection information (including game\n session endpoint and player session) is added to the matchmaking tickets.\n Matched players can use the connection information to join the game.

    \n
    6. \n
\n

\n Learn more\n

\n

\n \n Add FlexMatch to a Game Client\n

\n

\n \n Set Up FlexMatch Event Notification\n

\n

\n \n FlexMatch Integration Roadmap\n

\n

\n \n How GameLift FlexMatch Works\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Uses FlexMatch to create a game match for a group of players based on custom\n matchmaking rules, and starts a new game for the matched players. Each matchmaking\n request specifies the type of match to build (team configuration, rules for an\n acceptable match, etc.). The request also specifies the players to find a match for and\n where to host the new game session for optimal performance. A matchmaking request might\n start with a single player or a group of players who want to play together. FlexMatch\n finds additional players as needed to fill the match. Match type, rules, and the queue\n used to place a new game session are defined in a MatchmakingConfiguration.\n

\n

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,\n and include the players to be matched. You must also include a set of player attributes\n relevant for the matchmaking configuration. If successful, a matchmaking ticket is\n returned with status set to QUEUED.

\n

Track the status of the ticket to respond as needed and acquire game session\n connection information for successfully completed matches. Ticket status updates are\n tracked using event notification through Amazon Simple Notification Service (SNS), which is defined in the matchmaking\n configuration.

\n

\n Processing a matchmaking request -- FlexMatch\n handles a matchmaking request as follows:

\n
    \n
  1. \n

    Your client code submits a StartMatchmaking request for one or\n more players and tracks the status of the request ticket.

    \n
    2. \n
  2. \n

    FlexMatch uses this ticket and others in process to build an acceptable\n match. When a potential match is identified, all tickets in the proposed match\n are advanced to the next status.

    \n
    3. \n
  3. \n

    If the match requires player acceptance (set in the matchmaking\n configuration), the tickets move into status REQUIRES_ACCEPTANCE.\n This status triggers your client code to solicit acceptance from all players in\n every ticket involved in the match, and then call AcceptMatch\n for each player. If any player rejects or fails to accept the match before a\n specified timeout, the proposed match is dropped (see AcceptMatch\n for more details).

    \n
    4. \n
  4. \n

    Once a match is proposed and accepted, the matchmaking tickets move into\n status PLACING. FlexMatch locates resources for a new game session\n using the game session queue (set in the matchmaking configuration) and creates\n the game session based on the match data.

    \n
    5. \n
  5. \n

    When the match is successfully placed, the matchmaking tickets move into\n COMPLETED status. Connection information (including game\n session endpoint and player session) is added to the matchmaking tickets.\n Matched players can use the connection information to join the game.

    \n
    6. \n
\n

\n Learn more\n

\n

\n \n Add FlexMatch to a Game Client\n

\n

\n \n Set Up FlexMatch Event Notification\n

\n

\n \n FlexMatch Integration Roadmap\n

\n

\n \n How GameLift FlexMatch Works\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#StartMatchmakingInput": { "type": "structure", "members": { + "Players": { + "target": "com.amazonaws.gamelift#PlayerList", + "traits": { + "smithy.api#documentation": "

Information on each player to be matched. This information must include a player\n ID, and may contain player attributes and latency data to be used in the matchmaking\n process. After a successful match, Player objects contain the name of the\n team the player is assigned to.

", + "smithy.api#required": {} + } + }, "ConfigurationName": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { @@ -9147,17 +9375,10 @@ "traits": { "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the matchmaking ticket status and retrieve match\n results.

" } - }, - "Players": { - "target": "com.amazonaws.gamelift#PlayerList", - "traits": { - "smithy.api#documentation": "

Information on each player to be matched. This information must include a player\n ID, and may contain player attributes and latency data to be used in the matchmaking\n process. After a successful match, Player objects contain the name of the\n team the player is assigned to.

", - "smithy.api#required": {} - } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StartMatchmakingOutput": { @@ -9171,7 +9392,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StopFleetActions": { @@ -9203,17 +9424,17 @@ "com.amazonaws.gamelift#StopFleetActionsInput": { "type": "structure", "members": { - "Actions": { - "target": "com.amazonaws.gamelift#FleetActionList", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { - "smithy.api#documentation": "

List of actions to suspend on the fleet.

", + "smithy.api#documentation": "

A unique identifier for a fleet to stop actions on. You can use either the fleet ID or ARN value.

", "smithy.api#required": {} } }, - "FleetId": { - "target": "com.amazonaws.gamelift#FleetIdOrArn", + "Actions": { + "target": "com.amazonaws.gamelift#FleetActionList", "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet to stop actions on. You can use either the fleet ID or ARN value.

", + "smithy.api#documentation": "

List of actions to suspend on the fleet.

", "smithy.api#required": {} } } @@ -9261,7 +9482,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StopGameSessionPlacementOutput": { @@ -9275,7 +9496,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#StopMatchmaking": { @@ -9301,7 +9522,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a matchmaking ticket or match backfill ticket that is currently being\n processed. To stop the matchmaking operation, specify the ticket ID. If successful, work\n on the ticket is stopped, and the ticket status is changed to\n CANCELLED.

\n

This call is also used to turn off automatic backfill for an individual game session.\n This is for game sessions that are created with a matchmaking configuration that has\n automatic backfill enabled. The ticket ID is included in the MatchmakerData\n of an updated game session object, which is provided to the game server.

\n \n

If the action is successful, the service sends back an empty JSON struct with the HTTP 200 response\n (not an empty HTTP body).

\n \n

\n Learn more\n

\n

\n \n Add FlexMatch to a Game Client\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Cancels a matchmaking ticket or match backfill ticket that is currently being\n processed. To stop the matchmaking operation, specify the ticket ID. If successful, work\n on the ticket is stopped, and the ticket status is changed to\n CANCELLED.

\n

This call is also used to turn off automatic backfill for an individual game session.\n This is for game sessions that are created with a matchmaking configuration that has\n automatic backfill enabled. The ticket ID is included in the MatchmakerData\n of an updated game session object, which is provided to the game server.

\n \n

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response\n (not an empty HTTP body).

\n \n

\n Learn more\n

\n

\n \n Add FlexMatch to a Game Client\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#StopMatchmakingInput": { @@ -9316,7 +9537,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#StopMatchmakingOutput": { @@ -9364,23 +9585,23 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Temporarily stops activity on a game server group without terminating instances or the\n game server group. Activity can be restarted by calling ResumeGameServerGroup. Activities that can suspended are:

\n \n

To suspend activity, specify a game server group ARN and the type of activity to be suspended.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Temporarily stops activity on a game server group without terminating instances or the\n game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

\n \n

To suspend activity, specify a game server group ARN and the type of activity to be\n suspended. If successful, a GameServerGroup object is returned showing\n that the activity is listed in SuspendedActions.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#SuspendGameServerGroupInput": { "type": "structure", "members": { - "SuspendActions": { - "target": "com.amazonaws.gamelift#GameServerGroupActions", + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

The action to suspend for this game server group.

", + "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } }, - "GameServerGroupName": { - "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", + "SuspendActions": { + "target": "com.amazonaws.gamelift#GameServerGroupActions", "traits": { - "smithy.api#documentation": "

The unique identifier of the game server group to stop activity on. Use either the\n GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

The activity to suspend for this game server group.

", "smithy.api#required": {} } } @@ -9392,25 +9613,25 @@ "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { - "smithy.api#documentation": "

An object that describes the game server group resource, with the\n SuspendedActions property updated to reflect the suspended\n activity.

" + "smithy.api#documentation": "

An object that describes the game server group resource, with the\n SuspendedActions property updated to reflect the suspended\n activity.

" } } } }, "com.amazonaws.gamelift#Tag": { "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.gamelift#TagKey", + "members": { + "Value": { + "target": "com.amazonaws.gamelift#TagValue", "traits": { - "smithy.api#documentation": "

\n The key for a developer-defined key:value pair for tagging an AWS resource.\n

", + "smithy.api#documentation": "

\n The value for a developer-defined key:value pair for tagging an AWS resource.\n

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.gamelift#TagValue", + "Key": { + "target": "com.amazonaws.gamelift#TagKey", "traits": { - "smithy.api#documentation": "

\n The value for a developer-defined key:value pair for tagging an AWS resource.\n

", + "smithy.api#documentation": "

\n The key for a developer-defined key:value pair for tagging an AWS resource.\n

", "smithy.api#required": {} } } @@ -9475,7 +9696,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns a tag to a GameLift resource. AWS resource tags provide an additional\n management tool set. You can use tags to organize resources, create IAM permissions\n policies to manage access to groups of resources, customize AWS cost breakdowns, etc.\n This action handles the permissions necessary to manage tags for the following GameLift\n resource types:

\n \n

To add a tag to a resource, specify the unique ARN value for the resource and provide\n a tag list containing one or more tags. The operation succeeds even if the list includes\n tags that are already assigned to the specified resource.

\n

\n Learn more\n

\n

\n Tagging AWS Resources in the\n AWS General Reference\n

\n

\n \n AWS Tagging Strategies\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Assigns a tag to a GameLift resource. AWS resource tags provide an additional\n management tool set. You can use tags to organize resources, create IAM permissions\n policies to manage access to groups of resources, customize AWS cost breakdowns, etc.\n This operation handles the permissions necessary to manage tags for the following GameLift\n resource types:

\n \n

To add a tag to a resource, specify the unique ARN value for the resource and provide\n a tag list containing one or more tags. The operation succeeds even if the list includes\n tags that are already assigned to the specified resource.

\n

\n Learn more\n

\n

\n Tagging AWS Resources in the\n AWS General Reference\n

\n

\n \n AWS Tagging Strategies\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#TagResourceRequest": { @@ -9491,7 +9712,7 @@ "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to assign\n tags to. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe action for the resource type.

", + "smithy.api#documentation": "

\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to assign\n tags to. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe operation for the resource type.

", "smithy.api#required": {} } } @@ -9549,7 +9770,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Settings for a target-based scaling policy applied to Auto Scaling group. These\n settings are used to create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the metric. As player\n usage changes, the policy triggers to adjust the game server group capacity so that the\n metric returns to the target value.

" + "smithy.api#documentation": "

\n This data type is used with the Amazon GameLift FleetIQ and game server groups.\n

\n

Settings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy. \n These settings are used to\n create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.

" } }, "com.amazonaws.gamelift#TerminalRoutingStrategyException": { @@ -9614,7 +9835,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a tag that is assigned to a GameLift resource. \n Resource tags are used to organize AWS resources for a range of purposes. \n This action handles the permissions necessary to manage tags for the following \n GameLift resource types:

\n \n

To remove a tag from a resource, specify the unique ARN value for the resource and provide\n a string list containing one or more tags to be removed. \n This action succeeds even if the list includes tags that are not currently assigned to the\n specified resource.

\n

\n Learn more\n

\n

\n Tagging AWS Resources in the\n AWS General Reference\n

\n

\n \n AWS Tagging Strategies\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Removes a tag that is assigned to a GameLift resource. \n Resource tags are used to organize AWS resources for a range of purposes. \n This operation handles the permissions necessary to manage tags for the following \n GameLift resource types:

\n \n

To remove a tag from a resource, specify the unique ARN value for the resource and provide\n a string list containing one or more tags to be removed. \n This operation succeeds even if the list includes tags that are not currently assigned to the\n specified resource.

\n

\n Learn more\n

\n

\n Tagging AWS Resources in the\n AWS General Reference\n

\n

\n \n AWS Tagging Strategies\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#UntagResourceRequest": { @@ -9623,7 +9844,7 @@ "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to and\n uniquely identifies the GameLift resource that you want to remove tags from. GameLift\n resource ARNs are included in the data object for the resource, which can be retrieved\n by calling a List or Describe action for the resource type.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to and\n uniquely identifies the GameLift resource that you want to remove tags from. GameLift\n resource ARNs are included in the data object for the resource, which can be retrieved\n by calling a List or Describe operation for the resource type.

", "smithy.api#required": {} } }, @@ -9669,16 +9890,11 @@ "com.amazonaws.gamelift#UpdateAliasInput": { "type": "structure", "members": { - "RoutingStrategy": { - "target": "com.amazonaws.gamelift#RoutingStrategy", - "traits": { - "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the\n alias.

" - } - }, - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "AliasId": { + "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { - "smithy.api#documentation": "

A human-readable description of the alias.

" + "smithy.api#documentation": "

A unique identifier for the alias that you want to update. You can use either the\n alias ID or ARN value.

", + "smithy.api#required": {} } }, "Name": { @@ -9687,16 +9903,21 @@ "smithy.api#documentation": "

A descriptive label that is associated with an alias. Alias names do not need to be unique.

" } }, - "AliasId": { - "target": "com.amazonaws.gamelift#AliasIdOrArn", + "RoutingStrategy": { + "target": "com.amazonaws.gamelift#RoutingStrategy", "traits": { - "smithy.api#documentation": "

A unique identifier for the alias that you want to update. You can use either the\n alias ID or ARN value.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The routing configuration, including routing type and fleet target, for the\n alias.

" + } + }, + "Description": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "traits": { + "smithy.api#documentation": "

A human-readable description of the alias.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateAliasOutput": { @@ -9710,7 +9931,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateBuild": { @@ -9763,7 +9984,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateBuildOutput": { @@ -9777,7 +9998,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetAttributes": { @@ -9818,28 +10039,28 @@ "com.amazonaws.gamelift#UpdateFleetAttributesInput": { "type": "structure", "members": { - "MetricGroups": { - "target": "com.amazonaws.gamelift#MetricGroupList", - "traits": { - "smithy.api#documentation": "

Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet\n metric group is to aggregate metrics from multiple fleets. Use an existing metric group\n name to add this fleet to the group. Or use a new name to create a new metric group. A\n fleet can only be included in one metric group at a time.

" - } - }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

" } }, - "NewGameSessionProtectionPolicy": { - "target": "com.amazonaws.gamelift#ProtectionPolicy", + "ResourceCreationLimitPolicy": { + "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", "traits": { - "smithy.api#documentation": "

Game session protection policy to apply to all new instances created in this fleet.\n Instances that already exist are not affected. You can set protection for individual\n instances using UpdateGameSession.

\n " + "smithy.api#documentation": "

Policy that limits the number of game sessions an individual player can create over\n a span of time.

" } }, - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "MetricGroups": { + "target": "com.amazonaws.gamelift#MetricGroupList", "traits": { - "smithy.api#documentation": "

Human-readable description of a fleet.

" + "smithy.api#documentation": "

Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet\n metric group is to aggregate metrics from multiple fleets. Use an existing metric group\n name to add this fleet to the group. Or use a new name to create a new metric group. A\n fleet can only be included in one metric group at a time.

" + } + }, + "NewGameSessionProtectionPolicy": { + "target": "com.amazonaws.gamelift#ProtectionPolicy", + "traits": { + "smithy.api#documentation": "

Game session protection policy to apply to all new instances created in this fleet.\n Instances that already exist are not affected. You can set protection for individual\n instances using UpdateGameSession.

\n " } }, "FleetId": { @@ -9849,15 +10070,15 @@ "smithy.api#required": {} } }, - "ResourceCreationLimitPolicy": { - "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", + "Description": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Policy that limits the number of game sessions an individual player can create over\n a span of time.

" + "smithy.api#documentation": "

Human-readable description of a fleet.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetAttributesOutput": { @@ -9871,7 +10092,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetCapacity": { @@ -9906,12 +10127,18 @@ } ], "traits": { - "smithy.api#documentation": "

Updates capacity settings for a fleet. Use this action to specify the number of\n EC2 instances (hosts) that you want this fleet to contain. Before calling this action,\n you may want to call DescribeEC2InstanceLimits to get the maximum\n capacity based on the fleet's EC2 instance type.

\n

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet\n capacity to values fall outside of this range. This is particularly important when using\n auto-scaling (see PutScalingPolicy) to allow capacity to adjust based\n on player demand while imposing limits on automatic adjustments.

\n

To update fleet capacity, specify the fleet ID and the number of instances you want\n the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the\n fleet's active instance count matches the desired instance count. You can view a fleet's\n current capacity information by calling DescribeFleetCapacity. If the\n desired instance count is higher than the instance type's limit, the \"Limit Exceeded\"\n exception occurs.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Updates capacity settings for a fleet. Use this operation to specify the number of\n EC2 instances (hosts) that you want this fleet to contain. Before calling this operation,\n you may want to call DescribeEC2InstanceLimits to get the maximum\n capacity based on the fleet's EC2 instance type.

\n

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet\n capacity to values fall outside of this range. This is particularly important when using\n auto-scaling (see PutScalingPolicy) to allow capacity to adjust based\n on player demand while imposing limits on automatic adjustments.

\n

To update fleet capacity, specify the fleet ID and the number of instances you want\n the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the\n fleet's active instance count matches the desired instance count. You can view a fleet's\n current capacity information by calling DescribeFleetCapacity. If the\n desired instance count is higher than the instance type's limit, the \"Limit Exceeded\"\n exception occurs.

\n

\n Learn more\n

\n

\n Setting up GameLift Fleets\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#UpdateFleetCapacityInput": { "type": "structure", "members": { + "MinSize": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The minimum value allowed for the fleet's instance count. Default if not set is\n 0.

" + } + }, "MaxSize": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -9925,12 +10152,6 @@ "smithy.api#required": {} } }, - "MinSize": { - "target": "com.amazonaws.gamelift#WholeNumber", - "traits": { - "smithy.api#documentation": "

The minimum value allowed for the fleet's instance count. Default if not set is\n 0.

" - } - }, "DesiredInstances": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { @@ -9939,7 +10160,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetCapacityOutput": { @@ -9953,7 +10174,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetPortSettings": { @@ -10015,7 +10236,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateFleetPortSettingsOutput": { @@ -10029,7 +10250,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameServer": { @@ -10055,7 +10276,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Updates information about a registered game server. This action is called by a game\n server process that is running on an instance in a game server group. There are three\n reasons to update game server information: (1) to change the utilization status of the\n game server, (2) to report game server health status, and (3) to change game server\n metadata. A registered game server should regularly report health and should update\n utilization status when it is supporting gameplay so that GameLift FleetIQ can accurately track\n game server availability. You can make all three types of updates in the same\n request.

\n \n

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Updates information about a registered game server to help GameLift FleetIQ to track game server\n availability. This operation is called by a game server process that is running on an\n instance in a game server group.

\n

Use this operation to update the following types of game server information. You can\n make all three types of updates in the same request:

\n \n

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#UpdateGameServerGroup": { @@ -10081,7 +10302,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.\n

\n

Updates GameLift FleetIQ-specific properties for a game server group. These properties include \n instance rebalancing and game server protection. Many Auto Scaling\n group properties are updated directly. These include autoscaling policies,\n minimum/maximum/desired instance counts, and launch template.

\n

To update the game server group, specify the game server group ID and provide the\n updated values.

\n

Updated properties are validated to ensure that GameLift FleetIQ can continue to perform \n its core instance rebalancing activity. When you change Auto Scaling group properties directly and\n the changes cause errors with GameLift FleetIQ activities, an alert is sent.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n

\n Updating a GameLift FleetIQ-Linked Auto Scaling Group\n

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

\n This operation is used with the Amazon GameLift FleetIQ solution and game server groups.\n

\n

Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group\n properties are updated on the Auto Scaling group directly, including the launch\n template, Auto Scaling policies, and maximum/minimum/desired instance counts.

\n

To update the game server group, specify the game server group ID and provide the\n updated values. Before applying the updates, the new values are validated to ensure that\n GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

\n

\n Learn more\n

\n

\n GameLift FleetIQ Guide\n

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.gamelift#UpdateGameServerGroupInput": { @@ -10090,32 +10311,32 @@ "BalancingStrategy": { "target": "com.amazonaws.gamelift#BalancingStrategy", "traits": { - "smithy.api#documentation": "

The fallback balancing method to use for the game server group when Spot instances in\n a Region become unavailable or are not viable for game hosting. Once triggered, this\n method remains active until Spot instances can once again be used. Method options\n include:

\n " + "smithy.api#documentation": "

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:

\n " + } + }, + "GameServerGroupName": { + "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", + "traits": { + "smithy.api#documentation": "

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

", + "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to\n ensure that it contains the necessary permissions for game server groups.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups.

" } }, "InstanceDefinitions": { "target": "com.amazonaws.gamelift#InstanceDefinitions", "traits": { - "smithy.api#documentation": "

An updated list of EC2 instance types to use when creating instances in the group. The\n instance definition must specify instance types that are supported by GameLift FleetIQ, and must\n include at least two instance types. This updated list replaces the entire current list\n of instance definitions for the game server group. For more information on instance\n types, see EC2 Instance Types in the Amazon EC2 User\n Guide..

" + "smithy.api#documentation": "

An updated list of EC2 instance types to use in the Auto Scaling group. The instance\n definitions must specify at least two different instance types that are supported by\n GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for\n the game server group. For more information on instance types, see EC2 Instance\n Types in the Amazon EC2 User Guide. You can optionally\n specify capacity weighting for each instance type. If no weight value is specified for\n an instance type, it is set to the default value \"1\". For more information about\n capacity weighting, see Instance Weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, "GameServerProtectionPolicy": { "target": "com.amazonaws.gamelift#GameServerProtectionPolicy", "traits": { - "smithy.api#documentation": "

A flag that indicates whether instances in the game server group are protected from\n early termination. Unprotected instances that have active game servers running may by\n terminated during a scale-down event, causing players to be dropped from the game.\n Protected instances cannot be terminated while there are active game servers running. An\n exception to this is Spot Instances, which may be terminated by AWS regardless of\n protection status. This property is set to NO_PROTECTION by default.

" - } - }, - "GameServerGroupName": { - "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", - "traits": { - "smithy.api#documentation": "

The unique identifier of the game server group to update. Use either the GameServerGroup name or ARN value.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

" } } } @@ -10140,36 +10361,30 @@ "smithy.api#documentation": "

Indicates whether the game server is available or is currently hosting\n gameplay.

" } }, - "HealthCheck": { - "target": "com.amazonaws.gamelift#GameServerHealthCheck", - "traits": { - "smithy.api#documentation": "

Indicates health status of the game server. An update that explicitly includes this\n parameter updates the game server's LastHealthCheckTime time stamp.

" - } - }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { - "smithy.api#documentation": "

The identifier for the game server to be updated.

", + "smithy.api#documentation": "

A custom string that uniquely identifies the game server to update.

", "smithy.api#required": {} } }, - "GameServerData": { - "target": "com.amazonaws.gamelift#GameServerData", + "HealthCheck": { + "target": "com.amazonaws.gamelift#GameServerHealthCheck", "traits": { - "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data is \n passed to a game client or service when it requests information on a game servers using \n DescribeGameServer or ClaimGameServer.

" + "smithy.api#documentation": "

Indicates health status of the game server. A request that includes this parameter\n updates the game server's LastHealthCheckTime timestamp.

" } }, "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { - "smithy.api#documentation": "

An identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

", + "smithy.api#documentation": "

A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.

", "smithy.api#required": {} } }, - "CustomSortKey": { - "target": "com.amazonaws.gamelift#GameServerSortKey", + "GameServerData": { + "target": "com.amazonaws.gamelift#GameServerData", "traits": { - "smithy.api#documentation": "

A game server tag that can be used to request sorted lists of game servers using\n ListGameServers. Custom sort keys\n are developer-defined based on how you want to organize the retrieved game server information.

" + "smithy.api#documentation": "

A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.

" } } } @@ -10180,7 +10395,7 @@ "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { - "smithy.api#documentation": "

Object that describes the newly updated game server resource.

" + "smithy.api#documentation": "

Object that describes the newly updated game server.

" } } } @@ -10220,6 +10435,19 @@ "com.amazonaws.gamelift#UpdateGameSessionInput": { "type": "structure", "members": { + "GameSessionId": { + "target": "com.amazonaws.gamelift#ArnStringModel", + "traits": { + "smithy.api#documentation": "

A unique identifier for the game session to update.

", + "smithy.api#required": {} + } + }, + "MaximumPlayerSessionCount": { + "target": "com.amazonaws.gamelift#WholeNumber", + "traits": { + "smithy.api#documentation": "

The maximum number of players that can be connected simultaneously to the game session.

" + } + }, "ProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { @@ -10237,23 +10465,10 @@ "traits": { "smithy.api#documentation": "

A descriptive label that is associated with a game session. Session names do not need to be unique.

" } - }, - "MaximumPlayerSessionCount": { - "target": "com.amazonaws.gamelift#WholeNumber", - "traits": { - "smithy.api#documentation": "

The maximum number of players that can be connected simultaneously to the game session.

" - } - }, - "GameSessionId": { - "target": "com.amazonaws.gamelift#ArnStringModel", - "traits": { - "smithy.api#documentation": "

A unique identifier for the game session to update.

", - "smithy.api#required": {} - } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameSessionOutput": { @@ -10267,7 +10482,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameSessionQueue": { @@ -10326,7 +10541,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateGameSessionQueueOutput": { @@ -10340,7 +10555,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfiguration": { @@ -10372,88 +10587,88 @@ "com.amazonaws.gamelift#UpdateMatchmakingConfigurationInput": { "type": "structure", "members": { - "RuleSetName": { - "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", + "AcceptanceRequired": { + "target": "com.amazonaws.gamelift#BooleanModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN\n value. A matchmaking configuration can only use rule sets that are defined in the same\n Region.

" + "smithy.api#documentation": "

A flag that indicates whether a match that was created with this configuration must be\n accepted by the matched players. To require acceptance, set to TRUE.

" } }, - "AcceptanceTimeoutSeconds": { - "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", + "CustomEventData": { + "target": "com.amazonaws.gamelift#CustomEventData", "traits": { - "smithy.api#documentation": "

The length of time (in seconds) to wait for players to accept a proposed match. If any\n player rejects the match or fails to accept before the timeout, the ticket continues to\n look for an acceptable match.

" + "smithy.api#documentation": "

Information to add to all events related to the matchmaking configuration.

" } }, - "GameSessionData": { - "target": "com.amazonaws.gamelift#GameSessionData", + "BackfillMode": { + "target": "com.amazonaws.gamelift#BackfillMode", "traits": { - "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match.

" + "smithy.api#documentation": "

The method that is used to backfill game sessions created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests manually or does\n not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch.

" } }, - "GameProperties": { - "target": "com.amazonaws.gamelift#GamePropertyList", + "AdditionalPlayerCount": { + "target": "com.amazonaws.gamelift#WholeNumber", "traits": { - "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, \n assume that the configuration's rule set specifies a match for a single 12-person team. If\n the additional player count is set to 2, only 10 players are initially selected for the match.

" } }, - "Description": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "RequestTimeoutSeconds": { + "target": "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger", "traits": { - "smithy.api#documentation": "

A descriptive label that is associated with matchmaking configuration.

" + "smithy.api#documentation": "

The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.

" } }, - "GameSessionQueueArns": { - "target": "com.amazonaws.gamelift#QueueArnsList", + "NotificationTarget": { + "target": "com.amazonaws.gamelift#SnsArnStringModel", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues are used when placing game sessions for matches that are\n created with this matchmaking configuration. Queues can be located in any\n Region.

" + "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications. See \n Setting up Notifications for Matchmaking for more information.

" } }, - "AcceptanceRequired": { - "target": "com.amazonaws.gamelift#BooleanModel", + "AcceptanceTimeoutSeconds": { + "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", "traits": { - "smithy.api#documentation": "

A flag that indicates whether a match that was created with this configuration must be\n accepted by the matched players. To require acceptance, set to TRUE.

" + "smithy.api#documentation": "

The length of time (in seconds) to wait for players to accept a proposed match. If any\n player rejects the match or fails to accept before the timeout, the ticket continues to\n look for an acceptable match.

" } }, - "AdditionalPlayerCount": { - "target": "com.amazonaws.gamelift#WholeNumber", + "RuleSetName": { + "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", "traits": { - "smithy.api#documentation": "

The number of player slots in a match to keep open for future players. For example, \n assume that the configuration's rule set specifies a match for a single 12-person team. If\n the additional player count is set to 2, only 10 players are initially selected for the match.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN\n value. A matchmaking configuration can only use rule sets that are defined in the same\n Region.

" } }, - "RequestTimeoutSeconds": { - "target": "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger", + "GameSessionQueueArns": { + "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { - "smithy.api#documentation": "

The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues are used when placing game sessions for matches that are\n created with this matchmaking configuration. Queues can be located in any\n Region.

" } }, - "BackfillMode": { - "target": "com.amazonaws.gamelift#BackfillMode", + "Name": { + "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { - "smithy.api#documentation": "

The method that is used to backfill game sessions created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests manually or does\n not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

", + "smithy.api#required": {} } }, - "NotificationTarget": { - "target": "com.amazonaws.gamelift#SnsArnStringModel", + "GameSessionData": { + "target": "com.amazonaws.gamelift#GameSessionData", "traits": { - "smithy.api#documentation": "

An SNS topic ARN that is set up to receive matchmaking notifications. See \n Setting up Notifications for Matchmaking for more information.

" + "smithy.api#documentation": "

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match.

" } }, - "Name": { - "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", + "GameProperties": { + "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" } }, - "CustomEventData": { - "target": "com.amazonaws.gamelift#CustomEventData", + "Description": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

Information to add to all events related to the matchmaking configuration.

" + "smithy.api#documentation": "

A descriptive label that is associated with matchmaking configuration.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfigurationOutput": { @@ -10467,7 +10682,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateRuntimeConfiguration": { @@ -10518,7 +10733,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#UpdateRuntimeConfigurationOutput": { @@ -10532,7 +10747,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#UpdateScript": { @@ -10564,10 +10779,10 @@ "com.amazonaws.gamelift#UpdateScriptInput": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "StorageLocation": { + "target": "com.amazonaws.gamelift#S3Location", "traits": { - "smithy.api#documentation": "

The version that is associated with a build or script. Version strings do not need to be unique.

" + "smithy.api#documentation": "

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.

" } }, "ScriptId": { @@ -10583,10 +10798,10 @@ "smithy.api#documentation": "

A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.

\n

When using the AWS CLI tool to create a script, this parameter is set to the zip file\n name. It must be prepended with the string \"fileb://\" to indicate that the file data is\n a binary object. For example: --zip-file\n fileb://myRealtimeScript.zip.

" } }, - "StorageLocation": { - "target": "com.amazonaws.gamelift#S3Location", + "Version": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.

" + "smithy.api#documentation": "

The version that is associated with a build or script. Version strings do not need to be unique.

" } }, "Name": { @@ -10643,7 +10858,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the input for a request action.

" + "smithy.api#documentation": "

Represents the input for a request operation.

" } }, "com.amazonaws.gamelift#ValidateMatchmakingRuleSetOutput": { @@ -10657,7 +10872,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the returned data in response to a request action.

" + "smithy.api#documentation": "

Represents the returned data in response to a request operation.

" } }, "com.amazonaws.gamelift#VpcPeeringAuthorization": { @@ -10669,16 +10884,16 @@ "smithy.api#documentation": "

" } }, - "ExpirationTime": { + "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this authorization expires (24 hours after issuance).\n Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, - "CreationTime": { + "ExpirationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { - "smithy.api#documentation": "

Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + "smithy.api#documentation": "

Time stamp indicating when this authorization expires (24 hours after issuance).\n Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" } }, "PeerVpcId": { @@ -10707,22 +10922,22 @@ "com.amazonaws.gamelift#VpcPeeringConnection": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.gamelift#VpcPeeringConnectionStatus", + "FleetId": { + "target": "com.amazonaws.gamelift#FleetId", "traits": { - "smithy.api#documentation": "

The status information about the connection. Status indicates if a\n connection is pending, successful, or failed.

" + "smithy.api#documentation": "

A unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

" } }, - "VpcPeeringConnectionId": { + "GameLiftVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier that is automatically assigned to the connection record. This ID\n is referenced in VPC peering connection events, and is used when deleting a connection\n with DeleteVpcPeeringConnection.

" + "smithy.api#documentation": "

A unique identifier for the VPC that contains the Amazon GameLift fleet for this\n connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.\n

" } }, - "FleetArn": { - "target": "com.amazonaws.gamelift#FleetArn", + "VpcPeeringConnectionId": { + "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.\n

" + "smithy.api#documentation": "

A unique identifier that is automatically assigned to the connection record. This ID\n is referenced in VPC peering connection events, and is used when deleting a connection\n with DeleteVpcPeeringConnection.

" } }, "IpV4CidrBlock": { @@ -10731,16 +10946,16 @@ "smithy.api#documentation": "

CIDR block of IPv4 addresses assigned to the VPC peering connection for the\n GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these\n blocks cannot overlap or the peering connection cannot be created.

" } }, - "GameLiftVpcId": { - "target": "com.amazonaws.gamelift#NonZeroAndMaxString", + "Status": { + "target": "com.amazonaws.gamelift#VpcPeeringConnectionStatus", "traits": { - "smithy.api#documentation": "

A unique identifier for the VPC that contains the Amazon GameLift fleet for this\n connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.\n

" + "smithy.api#documentation": "

The status information about the connection. Status indicates if a\n connection is pending, successful, or failed.

" } }, - "FleetId": { - "target": "com.amazonaws.gamelift#FleetId", + "FleetArn": { + "target": "com.amazonaws.gamelift#FleetArn", "traits": { - "smithy.api#documentation": "

A unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.\n

" } }, "PeerVpcId": { @@ -10785,9 +11000,9 @@ "traits": { "smithy.api#length": { "min": 15, - "max": 15 + "max": 24 }, - "smithy.api#pattern": "^subnet-[0-9a-z]{8}$" + "smithy.api#pattern": "^subnet-[0-9a-z]+$" } }, "com.amazonaws.gamelift#VpcSubnets": { diff --git a/codegen/sdk-codegen/aws-models/glacier.2012-06-01.json b/codegen/sdk-codegen/aws-models/glacier.2012-06-01.json index 6764304506c4..5f1c62047744 100644 --- a/codegen/sdk-codegen/aws-models/glacier.2012-06-01.json +++ b/codegen/sdk-codegen/aws-models/glacier.2012-06-01.json @@ -68,18 +68,18 @@ "smithy.api#required": {} } }, - "accountId": { + "uploadId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The upload ID of the multipart upload to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "uploadId": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The upload ID of the multipart upload to delete.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -200,12 +200,6 @@ "com.amazonaws.glacier#AddTagsToVaultInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.glacier#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the vault. Each tag is composed of a key and a value. The value\n can be an empty string.

" - } - }, "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { @@ -221,6 +215,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.glacier#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the vault. Each tag is composed of a key and a value. The value\n can be an empty string.

" + } } }, "traits": { @@ -230,6 +230,13 @@ "com.amazonaws.glacier#ArchiveCreationOutput": { "type": "structure", "members": { + "location": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The relative URI path of the newly added archive resource.

", + "smithy.api#httpHeader": "Location" + } + }, "checksum": { "target": "com.amazonaws.glacier#string", "traits": { @@ -243,13 +250,6 @@ "smithy.api#documentation": "

The ID of the archive. This value is also included as part of the location.

", "smithy.api#httpHeader": "x-amz-archive-id" } - }, - "location": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The relative URI path of the newly added archive resource.

", - "smithy.api#httpHeader": "Location" - } } }, "traits": { @@ -259,6 +259,18 @@ "com.amazonaws.glacier#CSVInput": { "type": "structure", "members": { + "RecordDelimiter": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

A value used to separate individual records from each other.

" + } + }, + "Comments": { + "target": "com.amazonaws.glacier#string", + "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.

" + } + }, "FileHeaderInfo": { "target": "com.amazonaws.glacier#FileHeaderInfo", "traits": { @@ -271,12 +283,6 @@ "smithy.api#documentation": "

A value used to separate individual fields from each other within a record.

" } }, - "Comments": { - "target": "com.amazonaws.glacier#string", - "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.

" - } - }, "QuoteEscapeCharacter": { "target": "com.amazonaws.glacier#string", "traits": { @@ -288,12 +294,6 @@ "traits": { "smithy.api#documentation": "

A value used as an escape character where the field delimiter is part of the\n value.

" } - }, - "RecordDelimiter": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

A value used to separate individual records from each other.

" - } } }, "traits": { @@ -303,22 +303,22 @@ "com.amazonaws.glacier#CSVOutput": { "type": "structure", "members": { - "RecordDelimiter": { + "QuoteEscapeCharacter": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

A value used to separate individual records from each other.

" + "smithy.api#documentation": "

A single character used for escaping the quotation-mark character inside an already\n escaped value.

" } }, - "QuoteCharacter": { + "RecordDelimiter": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

A value used as an escape character where the field delimiter is part of the\n value.

" + "smithy.api#documentation": "

A value used to separate individual records from each other.

" } }, - "QuoteEscapeCharacter": { + "QuoteCharacter": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

A single character used for escaping the quotation-mark character inside an already\n escaped value.

" + "smithy.api#documentation": "

A value used as an escape character where the field delimiter is part of the\n value.

" } }, "FieldDelimiter": { @@ -407,14 +407,6 @@ "com.amazonaws.glacier#CompleteMultipartUploadInput": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "uploadId": { "target": "com.amazonaws.glacier#string", "traits": { @@ -438,6 +430,14 @@ "smithy.api#httpHeader": "x-amz-archive-size" } }, + "accountId": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "checksum": { "target": "com.amazonaws.glacier#string", "traits": { @@ -481,26 +481,26 @@ "com.amazonaws.glacier#CompleteVaultLockInput": { "type": "structure", "members": { - "vaultName": { + "lockId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The lockId value is the lock ID obtained from a InitiateVaultLock request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "lockId": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The lockId value is the lock ID obtained from a InitiateVaultLock request.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID. This value must match the AWS\n account ID associated with the credentials used to sign the request. You can either specify\n an AWS account ID or optionally a single '-' (hyphen), in which case Amazon\n Glacier uses the AWS account ID associated with the credentials used to sign the request.\n If you specify your account ID, do not include any hyphens ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID. This value must match the AWS\n account ID associated with the credentials used to sign the request. You can either specify\n an AWS account ID or optionally a single '-' (hyphen), in which case Amazon\n Glacier uses the AWS account ID associated with the credentials used to sign the request.\n If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -544,18 +544,18 @@ "com.amazonaws.glacier#CreateVaultInput": { "type": "structure", "members": { - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID. This value must match the AWS\n account ID associated with the credentials used to sign the request. You can either specify\n an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3\n Glacier uses the AWS account ID associated with the credentials used to sign the request.\n If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID. This value must match the AWS\n account ID associated with the credentials used to sign the request. You can either specify\n an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3\n Glacier uses the AWS account ID associated with the credentials used to sign the request.\n If you specify your account ID, do not include any hyphens ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -597,17 +597,17 @@ "com.amazonaws.glacier#DataRetrievalRule": { "type": "structure", "members": { - "BytesPerHour": { - "target": "com.amazonaws.glacier#NullableLong", - "traits": { - "smithy.api#documentation": "

The maximum number of bytes that can be retrieved in an hour.

\n

This field is required only if the value of the Strategy field is\n BytesPerHour. Your PUT operation will be rejected if the Strategy field is\n not set to BytesPerHour and you set this field.

" - } - }, "Strategy": { "target": "com.amazonaws.glacier#string", "traits": { "smithy.api#documentation": "

The type of data retrieval policy to set.

\n

Valid values: BytesPerHour|FreeTier|None

" } + }, + "BytesPerHour": { + "target": "com.amazonaws.glacier#NullableLong", + "traits": { + "smithy.api#documentation": "

The maximum number of bytes that can be retrieved in an hour.

\n

This field is required only if the value of the Strategy field is\n BytesPerHour. Your PUT operation will be rejected if the Strategy field is\n not set to BytesPerHour and you set this field.

" + } } }, "traits": { @@ -654,10 +654,10 @@ "com.amazonaws.glacier#DeleteArchiveInput": { "type": "structure", "members": { - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -670,10 +670,10 @@ "smithy.api#required": {} } }, - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -742,18 +742,18 @@ "com.amazonaws.glacier#DeleteVaultAccessPolicyInput": { "type": "structure", "members": { - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -766,18 +766,18 @@ "com.amazonaws.glacier#DeleteVaultInput": { "type": "structure", "members": { - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -818,18 +818,18 @@ "com.amazonaws.glacier#DeleteVaultNotificationsInput": { "type": "structure", "members": { - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -873,26 +873,26 @@ "com.amazonaws.glacier#DescribeJobInput": { "type": "structure", "members": { - "jobId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The ID of the job to describe.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "accountId": { + "jobId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The ID of the job to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -960,16 +960,22 @@ "com.amazonaws.glacier#DescribeVaultOutput": { "type": "structure", "members": { - "SizeInBytes": { + "VaultARN": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vault.

" + } + }, + "NumberOfArchives": { "target": "com.amazonaws.glacier#long", "traits": { - "smithy.api#documentation": "

Total size, in bytes, of the archives in the vault as of the last inventory date.\n This field will return null if an inventory has not yet run on the vault, for example if\n you just created the vault.

" + "smithy.api#documentation": "

The number of archives in the vault as of the last inventory date. This field will\n return null if an inventory has not yet run on the vault, for example if you\n just created the vault.

" } }, - "LastInventoryDate": { + "CreationDate": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last\n vault inventory. This value should be a string in the ISO 8601 date format, for example\n 2012-03-20T17:03:43.221Z.

" + "smithy.api#documentation": "

The Universal Coordinated Time (UTC) date when the vault was created. This value\n should be a string in the ISO 8601 date format, for example\n 2012-03-20T17:03:43.221Z.

" } }, "VaultName": { @@ -978,22 +984,16 @@ "smithy.api#documentation": "

The name of the vault.

" } }, - "VaultARN": { + "LastInventoryDate": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vault.

" + "smithy.api#documentation": "

The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last\n vault inventory. This value should be a string in the ISO 8601 date format, for example\n 2012-03-20T17:03:43.221Z.

" } }, - "NumberOfArchives": { + "SizeInBytes": { "target": "com.amazonaws.glacier#long", "traits": { - "smithy.api#documentation": "

The number of archives in the vault as of the last inventory date. This field will\n return null if an inventory has not yet run on the vault, for example if you\n just created the vault.

" - } - }, - "CreationDate": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The Universal Coordinated Time (UTC) date when the vault was created. This value\n should be a string in the ISO 8601 date format, for example\n 2012-03-20T17:03:43.221Z.

" + "smithy.api#documentation": "

Total size, in bytes, of the archives in the vault as of the last inventory date.\n This field will return null if an inventory has not yet run on the vault, for example if\n you just created the vault.

" } } }, @@ -1004,18 +1004,18 @@ "com.amazonaws.glacier#Encryption": { "type": "structure", "members": { - "KMSContext": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

Optional. If the encryption type is aws:kms, you can use this value to\n specify the encryption context for the job results.

" - } - }, "EncryptionType": { "target": "com.amazonaws.glacier#EncryptionType", "traits": { "smithy.api#documentation": "

The server-side encryption algorithm used when storing job results in Amazon S3, for\n example AES256 or aws:kms.

" } }, + "KMSContext": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

Optional. If the encryption type is aws:kms, you can use this value to\n specify the encryption context for the job results.

" + } + }, "KMSKeyId": { "target": "com.amazonaws.glacier#string", "traits": { @@ -1164,35 +1164,35 @@ "com.amazonaws.glacier#GetJobOutputInput": { "type": "structure", "members": { - "vaultName": { + "range": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The range of bytes to retrieve from the output. For example, if you want to download\n the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation\n downloads the entire output.

\n \n

If the job output is large, then you can use a range to\n retrieve a portion of the output. This allows you to download the entire output in smaller\n chunks of bytes. For example, suppose you have 1 GB of job output you want to download and\n you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job\n Output requests. You use the following process to download the job output:

\n \n
    \n
  1. \n

    Download a 128 MB chunk of output by specifying the appropriate byte range.\n Verify that all 128 MB of data was received.

    \n
    2. \n
  2. \n

    Along with the data, the response includes a SHA256 tree hash of the payload.\n You compute the checksum of the payload on the client and compare it with the\n checksum you received in the response to ensure you received all the expected\n data.

    \n
    3. \n
  3. \n

    Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time\n specifying the appropriate byte range.

    \n
    4. \n
  4. \n

    After downloading all the parts of the job output, you have a list of eight\n checksum values. Compute the tree hash of these values to find the checksum of the\n entire output. Using the DescribeJob API, obtain job information of\n the job that provided you the output. The response includes the checksum of the\n entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you\n computed to ensure you have downloaded the entire archive content with no\n errors.

    \n

    \n
    5. \n
", + "smithy.api#httpHeader": "Range" } }, - "accountId": { + "jobId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The job ID whose data is downloaded.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "jobId": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The job ID whose data is downloaded.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "range": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The range of bytes to retrieve from the output. For example, if you want to download\n the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation\n downloads the entire output.

\n \n

If the job output is large, then you can use a range to\n retrieve a portion of the output. This allows you to download the entire output in smaller\n chunks of bytes. For example, suppose you have 1 GB of job output you want to download and\n you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job\n Output requests. You use the following process to download the job output:

\n \n
    \n
  1. \n

    Download a 128 MB chunk of output by specifying the appropriate byte range.\n Verify that all 128 MB of data was received.

    \n
    2. \n
  2. \n

    Along with the data, the response includes a SHA256 tree hash of the payload.\n You compute the checksum of the payload on the client and compare it with the\n checksum you received in the response to ensure you received all the expected\n data.

    \n
    3. \n
  3. \n

    Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time\n specifying the appropriate byte range.

    \n
    4. \n
  4. \n

    After downloading all the parts of the job output, you have a list of eight\n checksum values. Compute the tree hash of these values to find the checksum of the\n entire output. Using the DescribeJob API, obtain job information of\n the job that provided you the output. The response includes the checksum of the\n entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you\n computed to ensure you have downloaded the entire archive content with no\n errors.

    \n

    \n
    5. \n
", - "smithy.api#httpHeader": "Range" + "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -1203,32 +1203,39 @@ "com.amazonaws.glacier#GetJobOutputOutput": { "type": "structure", "members": { - "acceptRanges": { + "contentRange": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Indicates the range units accepted. For more information, see RFC2616.

", - "smithy.api#httpHeader": "Accept-Ranges" + "smithy.api#documentation": "

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded,\n the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes\n 0-1048575/8388608 returns the first 1 MB from 8 MB.

", + "smithy.api#httpHeader": "Content-Range" } }, - "contentType": { + "archiveDescription": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The Content-Type depends on whether the job output is an archive or a vault\n inventory. For archive data, the Content-Type is application/octet-stream. For vault\n inventory, if you requested CSV format when you initiated the job, the Content-Type is\n text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type\n is application/json.

", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

The description of an archive.

", + "smithy.api#httpHeader": "x-amz-archive-description" } }, - "contentRange": { + "acceptRanges": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded,\n the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes\n 0-1048575/8388608 returns the first 1 MB from 8 MB.

", - "smithy.api#httpHeader": "Content-Range" + "smithy.api#documentation": "

Indicates the range units accepted. For more information, see RFC2616.

", + "smithy.api#httpHeader": "Accept-Ranges" } }, - "archiveDescription": { + "status": { + "target": "com.amazonaws.glacier#httpstatus", + "traits": { + "smithy.api#documentation": "

The HTTP response code for a job output request. The value depends on whether a range\n was specified in the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "contentType": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The description of an archive.

", - "smithy.api#httpHeader": "x-amz-archive-description" + "smithy.api#documentation": "

The Content-Type depends on whether the job output is an archive or a vault\n inventory. For archive data, the Content-Type is application/octet-stream. For vault\n inventory, if you requested CSV format when you initiated the job, the Content-Type is\n text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type\n is application/json.

", + "smithy.api#httpHeader": "Content-Type" } }, "body": { @@ -1284,18 +1291,18 @@ "com.amazonaws.glacier#GetVaultAccessPolicyInput": { "type": "structure", "members": { - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1354,18 +1361,18 @@ "com.amazonaws.glacier#GetVaultLockInput": { "type": "structure", "members": { - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1378,10 +1385,10 @@ "com.amazonaws.glacier#GetVaultLockOutput": { "type": "structure", "members": { - "State": { + "CreationDate": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The state of the vault lock. InProgress or\n Locked.

" + "smithy.api#documentation": "

The UTC date and time at which the vault lock was put into the\n InProgress state.

" } }, "Policy": { @@ -1396,10 +1403,10 @@ "smithy.api#documentation": "

The UTC date and time at which the lock ID expires. This value can be\n null if the vault lock is in a Locked state.

" } }, - "CreationDate": { + "State": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The UTC date and time at which the vault lock was put into the\n InProgress state.

" + "smithy.api#documentation": "

The state of the vault lock. InProgress or\n Locked.

" } } }, @@ -1441,18 +1448,18 @@ "com.amazonaws.glacier#GetVaultNotificationsInput": { "type": "structure", "members": { - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1586,7 +1593,7 @@ "sdkId": "Glacier", "arnNamespace": "glacier", "cloudFormationName": "Glacier", - "cloudTrailEventSource": "gaws.glacier.amazonaws.com" + "cloudTrailEventSource": "glacier.amazonaws.com" }, "aws.auth#sigv4": { "name": "glacier" @@ -1602,28 +1609,28 @@ "com.amazonaws.glacier#GlacierJobDescription": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.glacier#string", + "ArchiveSizeInBytes": { + "target": "com.amazonaws.glacier#Size", "traits": { - "smithy.api#documentation": "

An opaque string that identifies an Amazon S3 Glacier job.

" + "smithy.api#documentation": "

For an archive retrieval job, this value is the size in bytes of the archive being\n requested for download. For an inventory retrieval or select job, this value is\n null.

" } }, - "StatusCode": { - "target": "com.amazonaws.glacier#StatusCode", + "InventorySizeInBytes": { + "target": "com.amazonaws.glacier#Size", "traits": { - "smithy.api#documentation": "

The status code can be InProgress, Succeeded, or\n Failed, and indicates the status of the job.

" + "smithy.api#documentation": "

For an inventory retrieval job, this value is the size in bytes of the inventory\n requested for download. For an archive retrieval or select job, this value is\n null.

" } }, - "JobOutputPath": { - "target": "com.amazonaws.glacier#string", + "Action": { + "target": "com.amazonaws.glacier#ActionCode", "traits": { - "smithy.api#documentation": "

Contains the job output location.

" + "smithy.api#documentation": "

The job type. This value is either ArchiveRetrieval,\n InventoryRetrieval, or\n Select.

" } }, - "JobDescription": { + "CreationDate": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The job description provided when initiating the job.

" + "smithy.api#documentation": "

The UTC date when the job was created. This value is a string representation of ISO\n 8601 date format, for example \"2012-03-20T17:03:43.221Z\".

" } }, "ArchiveSHA256TreeHash": { @@ -1632,10 +1639,10 @@ "smithy.api#documentation": "

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory\n retrieval or select jobs, this field is null.

" } }, - "RetrievalByteRange": { + "JobId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The retrieved byte range for archive retrieval jobs in the form\n StartByteValue-EndByteValue. If no range\n was specified in the archive retrieval, then the whole archive is retrieved. In this\n case, StartByteValue equals 0 and EndByteValue\n equals the size of the archive minus 1. For inventory retrieval or select jobs, this\n field is null.

" + "smithy.api#documentation": "

An opaque string that identifies an Amazon S3 Glacier job.

" } }, "ArchiveId": { @@ -1644,18 +1651,6 @@ "smithy.api#documentation": "

The archive ID requested for a select job or archive retrieval. Otherwise, this\n field is null.

" } }, - "Completed": { - "target": "com.amazonaws.glacier#boolean", - "traits": { - "smithy.api#documentation": "

The job status. When a job is completed, you get the job's output using Get Job\n Output (GET output).

" - } - }, - "ArchiveSizeInBytes": { - "target": "com.amazonaws.glacier#Size", - "traits": { - "smithy.api#documentation": "

For an archive retrieval job, this value is the size in bytes of the archive being\n requested for download. For an inventory retrieval or select job, this value is\n null.

" - } - }, "SelectParameters": { "target": "com.amazonaws.glacier#SelectParameters", "traits": { @@ -1668,28 +1663,28 @@ "smithy.api#documentation": "

The UTC time that the job request completed. While the job is in progress, the\n value is null.

" } }, - "CreationDate": { + "RetrievalByteRange": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The UTC date when the job was created. This value is a string representation of ISO\n 8601 date format, for example \"2012-03-20T17:03:43.221Z\".

" + "smithy.api#documentation": "

The retrieved byte range for archive retrieval jobs in the form\n StartByteValue-EndByteValue. If no range\n was specified in the archive retrieval, then the whole archive is retrieved. In this\n case, StartByteValue equals 0 and EndByteValue\n equals the size of the archive minus 1. For inventory retrieval or select jobs, this\n field is null.

" } }, - "StatusMessage": { - "target": "com.amazonaws.glacier#string", + "Completed": { + "target": "com.amazonaws.glacier#boolean", "traits": { - "smithy.api#documentation": "

A friendly message that describes the job status.

" + "smithy.api#documentation": "

The job status. When a job is completed, you get the job's output using Get Job\n Output (GET output).

" } }, - "VaultARN": { + "JobDescription": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was\n requested.

" + "smithy.api#documentation": "

The job description provided when initiating the job.

" } }, - "Action": { - "target": "com.amazonaws.glacier#ActionCode", + "VaultARN": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The job type. This value is either ArchiveRetrieval,\n InventoryRetrieval, or\n Select.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was\n requested.

" } }, "Tier": { @@ -1698,22 +1693,22 @@ "smithy.api#documentation": "

The tier to use for a select or an archive retrieval. Valid values are\n Expedited, Standard, or Bulk.\n Standard is the default.

" } }, - "InventorySizeInBytes": { - "target": "com.amazonaws.glacier#Size", + "StatusCode": { + "target": "com.amazonaws.glacier#StatusCode", "traits": { - "smithy.api#documentation": "

For an inventory retrieval job, this value is the size in bytes of the inventory\n requested for download. For an archive retrieval or select job, this value is\n null.

" + "smithy.api#documentation": "

The status code can be InProgress, Succeeded, or\n Failed, and indicates the status of the job.

" } }, - "InventoryRetrievalParameters": { - "target": "com.amazonaws.glacier#InventoryRetrievalJobDescription", + "JobOutputPath": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Parameters used for range inventory retrieval.

" + "smithy.api#documentation": "

Contains the job output location.

" } }, - "SHA256TreeHash": { + "StatusMessage": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

For an archive retrieval job, this value is the checksum of the archive. Otherwise,\n this value is null.

\n

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash\n aligned range, then this field returns a value.

\n

If the whole archive is retrieved, this value is the same as the\n ArchiveSHA256TreeHash value.

\n

This field is null for the following:

\n \n \n " + "smithy.api#documentation": "

A friendly message that describes the job status.

" } }, "OutputLocation": { @@ -1727,6 +1722,18 @@ "traits": { "smithy.api#documentation": "

An Amazon SNS topic that receives notification.

" } + }, + "SHA256TreeHash": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

For an archive retrieval job, this value is the checksum of the archive. Otherwise,\n this value is null.

\n

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash\n aligned range, then this field returns a value.

\n

If the whole archive is retrieved, this value is the same as the\n ArchiveSHA256TreeHash value.

\n

This field is null for the following:

\n \n \n " + } + }, + "InventoryRetrievalParameters": { + "target": "com.amazonaws.glacier#InventoryRetrievalJobDescription", + "traits": { + "smithy.api#documentation": "

Parameters used for range inventory retrieval.

" + } } }, "traits": { @@ -1756,10 +1763,11 @@ "com.amazonaws.glacier#Grantee": { "type": "structure", "members": { - "ID": { - "target": "com.amazonaws.glacier#string", + "Type": { + "target": "com.amazonaws.glacier#Type", "traits": { - "smithy.api#documentation": "

The canonical user ID of the grantee.

" + "smithy.api#documentation": "

Type of grantee

", + "smithy.api#required": {} } }, "DisplayName": { @@ -1768,11 +1776,10 @@ "smithy.api#documentation": "

Screen name of the grantee.

" } }, - "Type": { - "target": "com.amazonaws.glacier#Type", + "ID": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Type of grantee

", - "smithy.api#required": {} + "smithy.api#documentation": "

The canonical user ID of the grantee.

" } }, "URI": { @@ -1832,12 +1839,11 @@ "com.amazonaws.glacier#InitiateJobInput": { "type": "structure", "members": { - "vaultName": { - "target": "com.amazonaws.glacier#string", + "jobParameters": { + "target": "com.amazonaws.glacier#JobParameters", "traits": { - "smithy.api#documentation": "

The name of the vault.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Provides options for specifying job information.

", + "smithy.api#httpPayload": {} } }, "accountId": { @@ -1848,11 +1854,12 @@ "smithy.api#required": {} } }, - "jobParameters": { - "target": "com.amazonaws.glacier#JobParameters", + "vaultName": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Provides options for specifying job information.

", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -1863,18 +1870,18 @@ "com.amazonaws.glacier#InitiateJobOutput": { "type": "structure", "members": { - "location": { + "jobId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The relative URI path of the job.

", - "smithy.api#httpHeader": "Location" + "smithy.api#documentation": "

The ID of the job.

", + "smithy.api#httpHeader": "x-amz-job-id" } }, - "jobId": { + "location": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The ID of the job.

", - "smithy.api#httpHeader": "x-amz-job-id" + "smithy.api#documentation": "

The relative URI path of the job.

", + "smithy.api#httpHeader": "Location" } }, "jobOutputPath": { @@ -1923,34 +1930,34 @@ "com.amazonaws.glacier#InitiateMultipartUploadInput": { "type": "structure", "members": { - "partSize": { + "archiveDescription": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The size of each part except the last, in bytes. The last part can be smaller than\n this part size.

", - "smithy.api#httpHeader": "x-amz-part-size" + "smithy.api#documentation": "

The archive description that you are uploading in parts.

\n

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example\n 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum\n allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

", + "smithy.api#httpHeader": "x-amz-archive-description" } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "archiveDescription": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The archive description that you are uploading in parts.

\n

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example\n 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum\n allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

", - "smithy.api#httpHeader": "x-amz-archive-description" + "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "accountId": { + "partSize": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The size of each part except the last, in bytes. The last part can be smaller than\n this part size.

", + "smithy.api#httpHeader": "x-amz-part-size" } } }, @@ -1961,18 +1968,18 @@ "com.amazonaws.glacier#InitiateMultipartUploadOutput": { "type": "structure", "members": { - "location": { + "uploadId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The relative URI path of the multipart upload ID Amazon S3 Glacier created.

", - "smithy.api#httpHeader": "Location" + "smithy.api#documentation": "

The ID of the multipart upload. This value is also included as part of the\n location.

", + "smithy.api#httpHeader": "x-amz-multipart-upload-id" } }, - "uploadId": { + "location": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The ID of the multipart upload. This value is also included as part of the\n location.

", - "smithy.api#httpHeader": "x-amz-multipart-upload-id" + "smithy.api#documentation": "

The relative URI path of the multipart upload ID Amazon S3 Glacier created.

", + "smithy.api#httpHeader": "Location" } } }, @@ -2014,14 +2021,6 @@ "com.amazonaws.glacier#InitiateVaultLockInput": { "type": "structure", "members": { - "vaultName": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The name of the vault.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "policy": { "target": "com.amazonaws.glacier#VaultLockPolicy", "traits": { @@ -2036,6 +2035,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "vaultName": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -2093,16 +2100,16 @@ "com.amazonaws.glacier#InvalidParameterValueException": { "type": "structure", "members": { - "message": { + "type": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Returned if a parameter of the request is incorrectly specified.

" + "smithy.api#documentation": "

Client

" } }, - "type": { + "message": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Client

" + "smithy.api#documentation": "

Returned if a parameter of the request is incorrectly specified.

" } }, "code": { @@ -2121,18 +2128,6 @@ "com.amazonaws.glacier#InventoryRetrievalJobDescription": { "type": "structure", "members": { - "Format": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault\n inventory. Valid values are CSV and JSON.

" - } - }, - "Limit": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The maximum number of inventory items returned per vault inventory retrieval\n request. This limit is set when initiating the job with the a InitiateJob request.

" - } - }, "Marker": { "target": "com.amazonaws.glacier#string", "traits": { @@ -2150,6 +2145,18 @@ "traits": { "smithy.api#documentation": "

The end of the date range in UTC for vault inventory retrieval that includes\n archives created before this date. This value should be a string in the ISO 8601 date\n format, for example 2013-03-20T17:03:43Z.

" } + }, + "Limit": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The maximum number of inventory items returned per vault inventory retrieval\n request. This limit is set when initiating the job with the a InitiateJob request.

" + } + }, + "Format": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault\n inventory. Valid values are CSV and JSON.

" + } } }, "traits": { @@ -2159,28 +2166,28 @@ "com.amazonaws.glacier#InventoryRetrievalJobInput": { "type": "structure", "members": { - "EndDate": { + "Marker": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The end of the date range in UTC for vault inventory retrieval that includes archives\n created before this date. This value should be a string in the ISO 8601 date format, for\n example 2013-03-20T17:03:43Z.

" + "smithy.api#documentation": "

An opaque string that represents where to continue pagination of the vault inventory\n retrieval results. You use the marker in a new InitiateJob\n request to obtain additional inventory items. If there are no more inventory items, this\n value is null.

" } }, - "StartDate": { + "Limit": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The start of the date range in UTC for vault inventory retrieval that includes\n archives created on or after this date. This value should be a string in the ISO 8601 date\n format, for example 2013-03-20T17:03:43Z.

" + "smithy.api#documentation": "

Specifies the maximum number of inventory items returned per vault inventory\n retrieval request. Valid values are greater than or equal to 1.

" } }, - "Limit": { + "EndDate": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of inventory items returned per vault inventory\n retrieval request. Valid values are greater than or equal to 1.

" + "smithy.api#documentation": "

The end of the date range in UTC for vault inventory retrieval that includes archives\n created before this date. This value should be a string in the ISO 8601 date format, for\n example 2013-03-20T17:03:43Z.

" } }, - "Marker": { + "StartDate": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

An opaque string that represents where to continue pagination of the vault inventory\n retrieval results. You use the marker in a new InitiateJob\n request to obtain additional inventory items. If there are no more inventory items, this\n value is null.

" + "smithy.api#documentation": "

The start of the date range in UTC for vault inventory retrieval that includes\n archives created on or after this date. This value should be a string in the ISO 8601 date\n format, for example 2013-03-20T17:03:43Z.

" } } }, @@ -2197,10 +2204,22 @@ "com.amazonaws.glacier#JobParameters": { "type": "structure", "members": { - "RetrievalByteRange": { + "Tier": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The byte range to retrieve for an archive retrieval. in the form\n \"StartByteValue-EndByteValue\" If not\n specified, the whole archive is retrieved. If specified, the byte range must be megabyte\n (1024*1024) aligned which means that StartByteValue must be divisible\n by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the\n end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange\n is not megabyte aligned, this operation returns a 400 response.

\n

An error occurs if you specify this field for an inventory retrieval job\n request.

" + "smithy.api#documentation": "

The tier to use for a select or an archive retrieval job. Valid values are\n Expedited, Standard, or Bulk.\n Standard is the default.

" + } + }, + "SNSTopic": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is\n completed and the output is ready for you to download. The specified topic publishes the\n notification to its subscribers. The SNS topic must exist.

" + } + }, + "Description": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The optional description for the job. The description must be less than or equal to\n 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically,\n ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

" } }, "InventoryRetrievalParameters": { @@ -2215,16 +2234,16 @@ "smithy.api#documentation": "

When initiating a job to retrieve a vault inventory, you can optionally add this\n parameter to your request to specify the output format. If you are initiating an inventory\n job and do not specify a Format field, JSON is the default format. Valid values are \"CSV\"\n and \"JSON\".

" } }, - "Description": { + "RetrievalByteRange": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The optional description for the job. The description must be less than or equal to\n 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically,\n ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

" + "smithy.api#documentation": "

The byte range to retrieve for an archive retrieval. in the form\n \"StartByteValue-EndByteValue\" If not\n specified, the whole archive is retrieved. If specified, the byte range must be megabyte\n (1024*1024) aligned which means that StartByteValue must be divisible\n by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the\n end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange\n is not megabyte aligned, this operation returns a 400 response.

\n

An error occurs if you specify this field for an inventory retrieval job\n request.

" } }, - "Tier": { + "ArchiveId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The tier to use for a select or an archive retrieval job. Valid values are\n Expedited, Standard, or Bulk.\n Standard is the default.

" + "smithy.api#documentation": "

The ID of the archive that you want to retrieve. This field is required only if\n Type is set to select or archive-retrievalcode>. \n An error occurs if you specify this\n request parameter for an inventory retrieval job request.

" } }, "OutputLocation": { @@ -2233,28 +2252,16 @@ "smithy.api#documentation": "

Contains information about the location where the select job results are stored.

" } }, - "Type": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The job type. You can initiate a job to perform a select query on an archive, \n retrieve an archive, or get an inventory of a vault. \n Valid values are \"select\", \"archive-retrieval\" and \"inventory-retrieval\".

" - } - }, "SelectParameters": { "target": "com.amazonaws.glacier#SelectParameters", "traits": { "smithy.api#documentation": "

Contains the parameters that define a job.

" } }, - "ArchiveId": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The ID of the archive that you want to retrieve. This field is required only if\n Type is set to select or archive-retrievalcode>. \n An error occurs if you specify this\n request parameter for an inventory retrieval job request.

" - } - }, - "SNSTopic": { + "Type": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is\n completed and the output is ready for you to download. The specified topic publishes the\n notification to its subscribers. The SNS topic must exist.

" + "smithy.api#documentation": "

The job type. You can initiate a job to perform a select query on an archive, \n retrieve an archive, or get an inventory of a vault. \n Valid values are \"select\", \"archive-retrieval\" and \"inventory-retrieval\".

" } } }, @@ -2265,12 +2272,6 @@ "com.amazonaws.glacier#LimitExceededException": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

Client

" - } - }, "code": { "target": "com.amazonaws.glacier#string", "traits": { @@ -2282,6 +2283,12 @@ "traits": { "smithy.api#documentation": "

Returned if the request results in a vault limit or tags limit being exceeded.

" } + }, + "type": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

Client

" + } } }, "traits": { @@ -2324,11 +2331,12 @@ "com.amazonaws.glacier#ListJobsInput": { "type": "structure", "members": { - "completed": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The state of the jobs to return. You can specify true or\n false.

", - "smithy.api#httpQuery": "completed" + "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "accountId": { @@ -2346,12 +2354,11 @@ "smithy.api#httpQuery": "marker" } }, - "vaultName": { + "completed": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The state of the jobs to return. You can specify true or\n false.

", + "smithy.api#httpQuery": "completed" } }, "statuscode": { @@ -2427,12 +2434,11 @@ "com.amazonaws.glacier#ListMultipartUploadsInput": { "type": "structure", "members": { - "accountId": { + "limit": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the maximum number of uploads returned in the response body. If this value\n is not specified, the List Uploads operation returns up to 50 uploads.

", + "smithy.api#httpQuery": "limit" } }, "vaultName": { @@ -2443,11 +2449,12 @@ "smithy.api#required": {} } }, - "limit": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of uploads returned in the response body. If this value\n is not specified, the List Uploads operation returns up to 50 uploads.

", - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "marker": { @@ -2465,17 +2472,17 @@ "com.amazonaws.glacier#ListMultipartUploadsOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

An opaque string that represents where to continue pagination of the results. You use\n the marker in a new List Multipart Uploads request to obtain more uploads in the list. If\n there are no more uploads, this value is null.

" - } - }, "UploadsList": { "target": "com.amazonaws.glacier#UploadsList", "traits": { "smithy.api#documentation": "

A list of in-progress multipart uploads.

" } + }, + "Marker": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

An opaque string that represents where to continue pagination of the results. You use\n the marker in a new List Multipart Uploads request to obtain more uploads in the list. If\n there are no more uploads, this value is null.

" + } } }, "traits": { @@ -2516,42 +2523,42 @@ "com.amazonaws.glacier#ListPartsInput": { "type": "structure", "members": { - "marker": { + "uploadId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

An opaque string used for pagination. This value specifies the part at which the\n listing of parts should begin. Get the marker value from the response of a previous List\n Parts response. You need only include the marker if you are continuing the pagination of\n results started in a previous List Parts request.

", - "smithy.api#httpQuery": "marker" + "smithy.api#documentation": "

The upload ID of the multipart upload.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "uploadId": { + "limit": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The upload ID of the multipart upload.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of parts to be returned. The default limit is 50. The number of\n parts returned might be fewer than the specified limit, but the number of returned parts\n never exceeds the limit.

", + "smithy.api#httpQuery": "limit" } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "limit": { + "marker": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The maximum number of parts to be returned. The default limit is 50. The number of\n parts returned might be fewer than the specified limit, but the number of returned parts\n never exceeds the limit.

", - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

An opaque string used for pagination. This value specifies the part at which the\n listing of parts should begin. Get the marker value from the response of a previous List\n Parts response. You need only include the marker if you are continuing the pagination of\n results started in a previous List Parts request.

", + "smithy.api#httpQuery": "marker" } } }, @@ -2562,34 +2569,40 @@ "com.amazonaws.glacier#ListPartsOutput": { "type": "structure", "members": { + "CreationDate": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The UTC time at which the multipart upload was initiated.

" + } + }, "VaultARN": { "target": "com.amazonaws.glacier#string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vault to which the multipart upload was\n initiated.

" } }, - "ArchiveDescription": { + "Marker": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The description of the archive that was specified in the Initiate Multipart Upload\n request.

" + "smithy.api#documentation": "

An opaque string that represents where to continue pagination of the results. You use\n the marker in a new List Parts request to obtain more jobs in the list. If there are no\n more parts, this value is null.

" } }, - "MultipartUploadId": { - "target": "com.amazonaws.glacier#string", + "Parts": { + "target": "com.amazonaws.glacier#PartList", "traits": { - "smithy.api#documentation": "

The ID of the upload to which the parts are associated.

" + "smithy.api#documentation": "

A list of the part sizes of the multipart upload. Each object in the array contains a\n RangeBytes and sha256-tree-hash name/value\n pair.

" } }, - "Marker": { + "ArchiveDescription": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

An opaque string that represents where to continue pagination of the results. You use\n the marker in a new List Parts request to obtain more jobs in the list. If there are no\n more parts, this value is null.

" + "smithy.api#documentation": "

The description of the archive that was specified in the Initiate Multipart Upload\n request.

" } }, - "CreationDate": { + "MultipartUploadId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The UTC time at which the multipart upload was initiated.

" + "smithy.api#documentation": "

The ID of the upload to which the parts are associated.

" } }, "PartSizeInBytes": { @@ -2597,12 +2610,6 @@ "traits": { "smithy.api#documentation": "

The part size in bytes. This is the same value that you specified in the Initiate\n Multipart Upload request.

" } - }, - "Parts": { - "target": "com.amazonaws.glacier#PartList", - "traits": { - "smithy.api#documentation": "

A list of the part sizes of the multipart upload. Each object in the array contains a\n RangeBytes and sha256-tree-hash name/value\n pair.

" - } } }, "traits": { @@ -2695,18 +2702,18 @@ "com.amazonaws.glacier#ListTagsForVaultInput": { "type": "structure", "members": { - "accountId": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The name of the vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "vaultName": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2814,16 +2821,16 @@ "com.amazonaws.glacier#MissingParameterValueException": { "type": "structure", "members": { - "code": { + "type": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

400 Bad Request

" + "smithy.api#documentation": "

Client.

" } }, - "type": { + "code": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Client.

" + "smithy.api#documentation": "

400 Bad Request

" } }, "message": { @@ -2935,16 +2942,16 @@ "com.amazonaws.glacier#PolicyEnforcedException": { "type": "structure", "members": { - "type": { + "message": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Client

" + "smithy.api#documentation": "

InitiateJob request denied by current data retrieval policy.

" } }, - "message": { + "type": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

InitiateJob request denied by current data retrieval policy.

" + "smithy.api#documentation": "

Client

" } }, "code": { @@ -2963,12 +2970,6 @@ "com.amazonaws.glacier#ProvisionedCapacityDescription": { "type": "structure", "members": { - "ExpirationDate": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).

" - } - }, "StartDate": { "target": "com.amazonaws.glacier#string", "traits": { @@ -2980,6 +2981,12 @@ "traits": { "smithy.api#documentation": "

The ID that identifies the provisioned capacity unit.

" } + }, + "ExpirationDate": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).

" + } } }, "traits": { @@ -3094,6 +3101,14 @@ "com.amazonaws.glacier#RemoveTagsFromVaultInput": { "type": "structure", "members": { + "accountId": { + "target": "com.amazonaws.glacier#string", + "traits": { + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { @@ -3107,14 +3122,6 @@ "traits": { "smithy.api#documentation": "

A list of tag keys. Each corresponding tag is removed from the vault.

" } - }, - "accountId": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -3124,10 +3131,10 @@ "com.amazonaws.glacier#RequestTimeoutException": { "type": "structure", "members": { - "type": { + "message": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Client

" + "smithy.api#documentation": "

Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the\n upload.

" } }, "code": { @@ -3136,10 +3143,10 @@ "smithy.api#documentation": "

408 Request Timeout

" } }, - "message": { + "type": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the\n upload.

" + "smithy.api#documentation": "

Client

" } } }, @@ -3158,16 +3165,16 @@ "smithy.api#documentation": "

404 Not Found

" } }, - "type": { + "message": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Client

" + "smithy.api#documentation": "

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't\n exist.

" } }, - "message": { + "type": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't\n exist.

" + "smithy.api#documentation": "

Client

" } } }, @@ -3180,22 +3187,22 @@ "com.amazonaws.glacier#S3Location": { "type": "structure", "members": { - "CannedACL": { - "target": "com.amazonaws.glacier#CannedACL", + "Prefix": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The canned access control list (ACL) to apply to the job results.

" + "smithy.api#documentation": "

The prefix that is prepended to the results for this request.

" } }, - "StorageClass": { - "target": "com.amazonaws.glacier#StorageClass", + "Tagging": { + "target": "com.amazonaws.glacier#hashmap", "traits": { - "smithy.api#documentation": "

The storage class used to store the job results.

" + "smithy.api#documentation": "

The tag-set that is applied to the job results.

" } }, - "AccessControlList": { - "target": "com.amazonaws.glacier#AccessControlPolicyList", + "Encryption": { + "target": "com.amazonaws.glacier#Encryption", "traits": { - "smithy.api#documentation": "

A list of grants that control access to the staged results.

" + "smithy.api#documentation": "

Contains information about the encryption used to store the job results in Amazon S3.

" } }, "UserMetadata": { @@ -3204,28 +3211,28 @@ "smithy.api#documentation": "

A map of metadata to store with the job results in Amazon S3.

" } }, - "Prefix": { - "target": "com.amazonaws.glacier#string", + "CannedACL": { + "target": "com.amazonaws.glacier#CannedACL", "traits": { - "smithy.api#documentation": "

The prefix that is prepended to the results for this request.

" + "smithy.api#documentation": "

The canned access control list (ACL) to apply to the job results.

" } }, - "BucketName": { - "target": "com.amazonaws.glacier#string", + "StorageClass": { + "target": "com.amazonaws.glacier#StorageClass", "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket where the job results are stored.

" + "smithy.api#documentation": "

The storage class used to store the job results.

" } }, - "Encryption": { - "target": "com.amazonaws.glacier#Encryption", + "AccessControlList": { + "target": "com.amazonaws.glacier#AccessControlPolicyList", "traits": { - "smithy.api#documentation": "

Contains information about the encryption used to store the job results in Amazon S3.

" + "smithy.api#documentation": "

A list of grants that control access to the staged results.

" } }, - "Tagging": { - "target": "com.amazonaws.glacier#hashmap", + "BucketName": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The tag-set that is applied to the job results.

" + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the job results are stored.

" } } }, @@ -3236,18 +3243,6 @@ "com.amazonaws.glacier#SelectParameters": { "type": "structure", "members": { - "ExpressionType": { - "target": "com.amazonaws.glacier#ExpressionType", - "traits": { - "smithy.api#documentation": "

The type of the provided expression, for example SQL.

" - } - }, - "InputSerialization": { - "target": "com.amazonaws.glacier#InputSerialization", - "traits": { - "smithy.api#documentation": "

Describes the serialization format of the object.

" - } - }, "Expression": { "target": "com.amazonaws.glacier#string", "traits": { @@ -3259,6 +3254,18 @@ "traits": { "smithy.api#documentation": "

Describes how the results of the select job are serialized.

" } + }, + "InputSerialization": { + "target": "com.amazonaws.glacier#InputSerialization", + "traits": { + "smithy.api#documentation": "

Describes the serialization format of the object.

" + } + }, + "ExpressionType": { + "target": "com.amazonaws.glacier#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of the provided expression, for example SQL.

" + } } }, "traits": { @@ -3268,16 +3275,16 @@ "com.amazonaws.glacier#ServiceUnavailableException": { "type": "structure", "members": { - "code": { + "type": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

500 Internal Server Error

" + "smithy.api#documentation": "

Server

" } }, - "type": { + "code": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Server

" + "smithy.api#documentation": "

500 Internal Server Error

" } }, "message": { @@ -3321,12 +3328,6 @@ "com.amazonaws.glacier#SetDataRetrievalPolicyInput": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.glacier#DataRetrievalPolicy", - "traits": { - "smithy.api#documentation": "

The data retrieval policy in JSON format.

" - } - }, "accountId": { "target": "com.amazonaws.glacier#string", "traits": { @@ -3334,6 +3335,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Policy": { + "target": "com.amazonaws.glacier#DataRetrievalPolicy", + "traits": { + "smithy.api#documentation": "

The data retrieval policy in JSON format.

" + } } }, "traits": { @@ -3371,13 +3378,6 @@ "com.amazonaws.glacier#SetVaultAccessPolicyInput": { "type": "structure", "members": { - "policy": { - "target": "com.amazonaws.glacier#VaultAccessPolicy", - "traits": { - "smithy.api#documentation": "

The vault access policy as a JSON string.

", - "smithy.api#httpPayload": {} - } - }, "accountId": { "target": "com.amazonaws.glacier#string", "traits": { @@ -3386,6 +3386,13 @@ "smithy.api#required": {} } }, + "policy": { + "target": "com.amazonaws.glacier#VaultAccessPolicy", + "traits": { + "smithy.api#documentation": "

The vault access policy as a JSON string.

", + "smithy.api#httpPayload": {} + } + }, "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { @@ -3585,11 +3592,11 @@ "com.amazonaws.glacier#UploadArchiveInput": { "type": "structure", "members": { - "body": { - "target": "com.amazonaws.glacier#Stream", + "checksum": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The data to upload.

", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

The SHA256 tree hash of the data being uploaded.

", + "smithy.api#httpHeader": "x-amz-sha256-tree-hash" } }, "vaultName": { @@ -3600,11 +3607,18 @@ "smithy.api#required": {} } }, - "checksum": { + "archiveDescription": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The SHA256 tree hash of the data being uploaded.

", - "smithy.api#httpHeader": "x-amz-sha256-tree-hash" + "smithy.api#documentation": "

The optional description of the archive you are uploading.

", + "smithy.api#httpHeader": "x-amz-archive-description" + } + }, + "body": { + "target": "com.amazonaws.glacier#Stream", + "traits": { + "smithy.api#documentation": "

The data to upload.

", + "smithy.api#httpPayload": {} } }, "accountId": { @@ -3614,13 +3628,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "archiveDescription": { - "target": "com.amazonaws.glacier#string", - "traits": { - "smithy.api#documentation": "

The optional description of the archive you are uploading.

", - "smithy.api#httpHeader": "x-amz-archive-description" - } } }, "traits": { @@ -3630,10 +3637,10 @@ "com.amazonaws.glacier#UploadListElement": { "type": "structure", "members": { - "PartSizeInBytes": { - "target": "com.amazonaws.glacier#long", + "VaultARN": { + "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The part size, in bytes, specified in the Initiate Multipart Upload request. This is\n the size of all the parts in the upload except the last part, which may be smaller than\n this size.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vault that contains the archive.

" } }, "MultipartUploadId": { @@ -3642,22 +3649,22 @@ "smithy.api#documentation": "

The ID of a multipart upload.

" } }, - "VaultARN": { + "CreationDate": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vault that contains the archive.

" + "smithy.api#documentation": "

The UTC time at which the multipart upload was initiated.

" } }, - "ArchiveDescription": { - "target": "com.amazonaws.glacier#string", + "PartSizeInBytes": { + "target": "com.amazonaws.glacier#long", "traits": { - "smithy.api#documentation": "

The description of the archive that was specified in the Initiate Multipart Upload\n request.

" + "smithy.api#documentation": "

The part size, in bytes, specified in the Initiate Multipart Upload request. This is\n the size of all the parts in the upload except the last part, which may be smaller than\n this size.

" } }, - "CreationDate": { + "ArchiveDescription": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The UTC time at which the multipart upload was initiated.

" + "smithy.api#documentation": "

The description of the archive that was specified in the Initiate Multipart Upload\n request.

" } } }, @@ -3702,27 +3709,26 @@ "com.amazonaws.glacier#UploadMultipartPartInput": { "type": "structure", "members": { - "checksum": { + "accountId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The SHA256 tree hash of the data being uploaded.

", - "smithy.api#httpHeader": "x-amz-sha256-tree-hash" + "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "vaultName": { + "checksum": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The name of the vault.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The SHA256 tree hash of the data being uploaded.

", + "smithy.api#httpHeader": "x-amz-sha256-tree-hash" } }, - "uploadId": { + "range": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The upload ID of the multipart upload.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Identifies the range of bytes in the assembled archive that will be uploaded in this\n part. Amazon S3 Glacier uses this information to assemble the archive in the proper sequence.\n The format of this header follows RFC 2616. An example header is Content-Range:bytes\n 0-4194303/*.

", + "smithy.api#httpHeader": "Content-Range" } }, "body": { @@ -3732,17 +3738,18 @@ "smithy.api#httpPayload": {} } }, - "range": { + "vaultName": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

Identifies the range of bytes in the assembled archive that will be uploaded in this\n part. Amazon S3 Glacier uses this information to assemble the archive in the proper sequence.\n The format of this header follows RFC 2616. An example header is Content-Range:bytes\n 0-4194303/*.

", - "smithy.api#httpHeader": "Content-Range" + "smithy.api#documentation": "

The name of the vault.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "accountId": { + "uploadId": { "target": "com.amazonaws.glacier#string", "traits": { - "smithy.api#documentation": "

The AccountId value is the AWS account ID of the account that owns the\n vault. You can either specify an AWS account ID or optionally a single '-'\n (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the\n credentials used to sign the request. If you use an account ID, do not include any hyphens\n ('-') in the ID.

", + "smithy.api#documentation": "

The upload ID of the multipart upload.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3839,6 +3846,9 @@ "target": "com.amazonaws.glacier#string" } }, + "com.amazonaws.glacier#httpstatus": { + "type": "integer" + }, "com.amazonaws.glacier#long": { "type": "long" }, diff --git a/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json b/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json index 46b537930c02..059a28db2b0c 100644 --- a/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json +++ b/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json @@ -32,28 +32,28 @@ "com.amazonaws.globalaccelerator#Accelerator": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.globalaccelerator#GenericString", + "IpAddressType": { + "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { - "smithy.api#documentation": "

The name of the accelerator. The name must contain only alphanumeric characters or\n\t\t\thyphens (-), and must not begin or end with a hyphen.

" + "smithy.api#documentation": "

The value for the address type must be IPv4.\n\t\t\t

" } }, - "Status": { - "target": "com.amazonaws.globalaccelerator#AcceleratorStatus", + "DnsName": { + "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

Describes the deployment status of the accelerator.

" + "smithy.api#documentation": "

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

\n\t\t

The naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.

\n\t\t

For more information about the default DNS name, see \n\t\t\tSupport for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

" } }, - "Enabled": { - "target": "com.amazonaws.globalaccelerator#GenericBoolean", + "AcceleratorArn": { + "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

\n\t\t

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the accelerator.

" } }, - "LastModifiedTime": { - "target": "com.amazonaws.globalaccelerator#Timestamp", + "IpSets": { + "target": "com.amazonaws.globalaccelerator#IpSets", "traits": { - "smithy.api#documentation": "

The date and time that the accelerator was last modified.

" + "smithy.api#documentation": "

The static IP addresses that Global Accelerator associates with the accelerator.

" } }, "CreatedTime": { @@ -62,28 +62,28 @@ "smithy.api#documentation": "

The date and time that the accelerator was created.

" } }, - "DnsName": { - "target": "com.amazonaws.globalaccelerator#GenericString", + "Enabled": { + "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

\n\t\t

The naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.

\n\t\t

For more information about the default DNS name, see \n\t\t\tSupport for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

" + "smithy.api#documentation": "

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

\n\t\t

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

" } }, - "IpAddressType": { - "target": "com.amazonaws.globalaccelerator#IpAddressType", + "LastModifiedTime": { + "target": "com.amazonaws.globalaccelerator#Timestamp", "traits": { - "smithy.api#documentation": "

The value for the address type must be IPv4.\n\t\t\t

" + "smithy.api#documentation": "

The date and time that the accelerator was last modified.

" } }, - "IpSets": { - "target": "com.amazonaws.globalaccelerator#IpSets", + "Name": { + "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

The static IP addresses that Global Accelerator associates with the accelerator.

" + "smithy.api#documentation": "

The name of the accelerator. The name must contain only alphanumeric characters or\n\t\t\thyphens (-), and must not begin or end with a hyphen.

" } }, - "AcceleratorArn": { - "target": "com.amazonaws.globalaccelerator#GenericString", + "Status": { + "target": "com.amazonaws.globalaccelerator#AcceleratorStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the accelerator.

" + "smithy.api#documentation": "

Describes the deployment status of the accelerator.

" } } }, @@ -94,6 +94,12 @@ "com.amazonaws.globalaccelerator#AcceleratorAttributes": { "type": "structure", "members": { + "FlowLogsEnabled": { + "target": "com.amazonaws.globalaccelerator#GenericBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

\n\t\t

For more information, see Flow Logs in\n\t\t\tthe AWS Global Accelerator Developer Guide.

" + } + }, "FlowLogsS3Prefix": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { @@ -105,12 +111,6 @@ "traits": { "smithy.api#documentation": "

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is\n\t\t\t\ttrue. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the\n\t\t\tbucket.

" } - }, - "FlowLogsEnabled": { - "target": "com.amazonaws.globalaccelerator#GenericBoolean", - "traits": { - "smithy.api#documentation": "

Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

\n\t\t

For more information, see Flow Logs in\n\t\t\tthe AWS Global Accelerator Developer Guide.

" - } } }, "traits": { @@ -262,17 +262,17 @@ "smithy.api#documentation": "

The address range, in CIDR notation.

" } }, - "Events": { - "target": "com.amazonaws.globalaccelerator#ByoipCidrEvents", - "traits": { - "smithy.api#documentation": "

A history of status changes for an IP address range that that you bring to AWS Global Accelerator\n\t\t\tthrough bring your own IP address (BYOIP).

" - } - }, "State": { "target": "com.amazonaws.globalaccelerator#ByoipCidrState", "traits": { "smithy.api#documentation": "

The state of the address pool.

" } + }, + "Events": { + "target": "com.amazonaws.globalaccelerator#ByoipCidrEvents", + "traits": { + "smithy.api#documentation": "

A history of status changes for an IP address range that that you bring to AWS Global Accelerator\n\t\t\tthrough bring your own IP address (BYOIP).

" + } } }, "traits": { @@ -282,17 +282,17 @@ "com.amazonaws.globalaccelerator#ByoipCidrEvent": { "type": "structure", "members": { - "Timestamp": { - "target": "com.amazonaws.globalaccelerator#Timestamp", - "traits": { - "smithy.api#documentation": "

A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through \n\t\t\tbring your own IP address (BYOIP).

" - } - }, "Message": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "

A string that contains an Event message describing changes that you make in the status \n\t\t\tof an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

" } + }, + "Timestamp": { + "target": "com.amazonaws.globalaccelerator#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through \n\t\t\tbring your own IP address (BYOIP).

" + } } }, "traits": { @@ -378,17 +378,17 @@ "com.amazonaws.globalaccelerator#CidrAuthorizationContext": { "type": "structure", "members": { - "Message": { + "Signature": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

", + "smithy.api#documentation": "

The signed authorization message for the prefix and account.

", "smithy.api#required": {} } }, - "Signature": { + "Message": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

The signed authorization message for the prefix and account.

", + "smithy.api#documentation": "

The plain-text authorization message for the prefix and account.

", "smithy.api#required": {} } } @@ -444,16 +444,16 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.globalaccelerator#Tags", + "Enabled": { + "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "

Create tags for an accelerator.

\n\t\t

For more information, see Tagging\n\t\t\tin AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

" + "smithy.api#documentation": "

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

\n\t\t

If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

" } }, - "IpAddressType": { - "target": "com.amazonaws.globalaccelerator#IpAddressType", + "IpAddresses": { + "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { - "smithy.api#documentation": "

The value for the address type must be IPv4.\n\t\t\t

" + "smithy.api#documentation": "

Optionally, if you've added your own IP address pool to Global Accelerator, you can choose IP addresses \n\t\t\tfrom your own pool to use for the accelerator's static IP \n\t\t\taddresses. You can specify one or two addresses, separated by a comma. Do not include the /32\n\t\t\tsuffix.

\n\t\t

If you specify only one IP address from your IP address range, Global Accelerator assigns a second \n\t\t\tstatic IP address for the accelerator from the AWS IP address pool.

\n\t\t

For more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

" } }, "Name": { @@ -463,16 +463,16 @@ "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.globalaccelerator#GenericBoolean", + "Tags": { + "target": "com.amazonaws.globalaccelerator#Tags", "traits": { - "smithy.api#documentation": "

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

\n\t\t

If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

" + "smithy.api#documentation": "

Create tags for an accelerator.

\n\t\t

For more information, see Tagging\n\t\t\tin AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

" } }, - "IpAddresses": { - "target": "com.amazonaws.globalaccelerator#IpAddresses", + "IpAddressType": { + "target": "com.amazonaws.globalaccelerator#IpAddressType", "traits": { - "smithy.api#documentation": "

Optionally, if you've added your own IP address pool to Global Accelerator, you can choose IP addresses \n\t\t\tfrom your own pool to use for the accelerator's static IP \n\t\t\taddresses. You can specify one or two addresses, separated by a comma. Do not include the /32\n\t\t\tsuffix.

\n\t\t

If you specify only one IP address from your IP address range, Global Accelerator assigns a second \n\t\t\tstatic IP address for the accelerator from the AWS IP address pool.

\n\t\t

For more information, see Bring Your Own \n\t\t\tIP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

" + "smithy.api#documentation": "

The value for the address type must be IPv4.\n\t\t\t

" } } } @@ -526,11 +526,10 @@ "com.amazonaws.globalaccelerator#CreateEndpointGroupRequest": { "type": "structure", "members": { - "ListenerArn": { + "HealthCheckPath": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The\n\t\t\tdefault value is slash (/).

" } }, "IdempotencyToken": { @@ -541,23 +540,17 @@ "smithy.api#required": {} } }, - "EndpointGroupRegion": { + "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\t\tspecific Region.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

", "smithy.api#required": {} } }, - "HealthCheckIntervalSeconds": { - "target": "com.amazonaws.globalaccelerator#HealthCheckIntervalSeconds", - "traits": { - "smithy.api#documentation": "

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

" - } - }, - "ThresholdCount": { - "target": "com.amazonaws.globalaccelerator#ThresholdCount", + "TrafficDialPercentage": { + "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { - "smithy.api#documentation": "

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.

" + "smithy.api#documentation": "

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.

\n\t\t

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.

\n\t\t

The default value is 100.

" } }, "HealthCheckPort": { @@ -566,10 +559,17 @@ "smithy.api#documentation": "

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t\t\tis the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the\n\t\t\tfirst port in the list.

" } }, - "HealthCheckProtocol": { - "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", + "ThresholdCount": { + "target": "com.amazonaws.globalaccelerator#ThresholdCount", "traits": { - "smithy.api#documentation": "

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.

" + "smithy.api#documentation": "

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.

" + } + }, + "EndpointGroupRegion": { + "target": "com.amazonaws.globalaccelerator#GenericString", + "traits": { + "smithy.api#documentation": "

The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a\n\t\t\tspecific Region.

", + "smithy.api#required": {} } }, "EndpointConfigurations": { @@ -578,16 +578,16 @@ "smithy.api#documentation": "

The list of endpoint objects.

" } }, - "HealthCheckPath": { - "target": "com.amazonaws.globalaccelerator#GenericString", + "HealthCheckProtocol": { + "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { - "smithy.api#documentation": "

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The\n\t\t\tdefault value is slash (/).

" + "smithy.api#documentation": "

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.

" } }, - "TrafficDialPercentage": { - "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", + "HealthCheckIntervalSeconds": { + "target": "com.amazonaws.globalaccelerator#HealthCheckIntervalSeconds", "traits": { - "smithy.api#documentation": "

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.

\n\t\t

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.

\n\t\t

The default value is 100.

" + "smithy.api#documentation": "

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

" } } } @@ -635,16 +635,10 @@ "com.amazonaws.globalaccelerator#CreateListenerRequest": { "type": "structure", "members": { - "ClientAffinity": { - "target": "com.amazonaws.globalaccelerator#ClientAffinity", - "traits": { - "smithy.api#documentation": "

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.

\n\t\t

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.

\n\t\t

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.

\n\t\t

The default value is NONE.

" - } - }, - "PortRanges": { - "target": "com.amazonaws.globalaccelerator#PortRanges", + "Protocol": { + "target": "com.amazonaws.globalaccelerator#Protocol", "traits": { - "smithy.api#documentation": "

The list of port ranges to support for connections from clients to your accelerator.

", + "smithy.api#documentation": "

The protocol for connections from clients to your accelerator.

", "smithy.api#required": {} } }, @@ -655,11 +649,10 @@ "smithy.api#required": {} } }, - "Protocol": { - "target": "com.amazonaws.globalaccelerator#Protocol", + "ClientAffinity": { + "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "

The protocol for connections from clients to your accelerator.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.

\n\t\t

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.

\n\t\t

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.

\n\t\t

The default value is NONE.

" } }, "IdempotencyToken": { @@ -669,6 +662,13 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "PortRanges": { + "target": "com.amazonaws.globalaccelerator#PortRanges", + "traits": { + "smithy.api#documentation": "

The list of port ranges to support for connections from clients to your accelerator.

", + "smithy.api#required": {} + } } } }, @@ -1027,12 +1027,6 @@ "com.amazonaws.globalaccelerator#EndpointConfiguration": { "type": "structure", "members": { - "Weight": { - "target": "com.amazonaws.globalaccelerator#EndpointWeight", - "traits": { - "smithy.api#documentation": "

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the\n\t\t\t\tAWS Global Accelerator Developer Guide.

" - } - }, "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { @@ -1044,6 +1038,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.

\n\t\t

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

\n\t\t

For more information, see \n\t\t\tPreserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

" } + }, + "Weight": { + "target": "com.amazonaws.globalaccelerator#EndpointWeight", + "traits": { + "smithy.api#documentation": "

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic\n\t\t\tbased on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The\n\t\t\tresult is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second\n\t\t\tand third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the\n\t\t\t\tAWS Global Accelerator Developer Guide.

" + } } }, "traits": { @@ -1065,18 +1065,6 @@ "com.amazonaws.globalaccelerator#EndpointDescription": { "type": "structure", "members": { - "ClientIPPreservationEnabled": { - "target": "com.amazonaws.globalaccelerator#GenericBoolean", - "traits": { - "smithy.api#documentation": "

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.

\n\t\t

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

\n\t\t

For more information, see \n\t\t\tViewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

" - } - }, - "EndpointId": { - "target": "com.amazonaws.globalaccelerator#GenericString", - "traits": { - "smithy.api#documentation": "

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For EC2 instances, this is the EC2 instance ID.

\n\t\t

An Application Load Balancer can be either internal or internet-facing.

" - } - }, "Weight": { "target": "com.amazonaws.globalaccelerator#EndpointWeight", "traits": { @@ -1089,11 +1077,23 @@ "smithy.api#documentation": "

The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is\n\t\t\tnot provided.

\n\t\t

If the endpoint state is unhealthy, the reason code can be one of the following\n\t\t\tvalues:

\n\t\t \n\t\t

If the endpoint state is initial, the reason code can be one of the following\n\t\t\tvalues:

\n\t\t " } }, + "ClientIPPreservationEnabled": { + "target": "com.amazonaws.globalaccelerator#GenericBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.

\n\t\t

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

\n\t\t

For more information, see \n\t\t\tViewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

" + } + }, "HealthState": { "target": "com.amazonaws.globalaccelerator#HealthState", "traits": { "smithy.api#documentation": "

The health status of the endpoint.

" } + }, + "EndpointId": { + "target": "com.amazonaws.globalaccelerator#GenericString", + "traits": { + "smithy.api#documentation": "

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For EC2 instances, this is the EC2 instance ID.

\n\t\t

An Application Load Balancer can be either internal or internet-facing.

" + } } }, "traits": { @@ -1115,22 +1115,22 @@ "smithy.api#documentation": "

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

" } }, - "HealthCheckPath": { - "target": "com.amazonaws.globalaccelerator#GenericString", + "EndpointDescriptions": { + "target": "com.amazonaws.globalaccelerator#EndpointDescriptions", "traits": { - "smithy.api#documentation": "

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the\n\t\t\tendpoints for health checks. The default is slash (/).

" + "smithy.api#documentation": "

The list of endpoint objects.

" } }, - "EndpointGroupRegion": { + "HealthCheckPath": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region that this endpoint group belongs.

" + "smithy.api#documentation": "

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the\n\t\t\tendpoints for health checks. The default is slash (/).

" } }, - "EndpointDescriptions": { - "target": "com.amazonaws.globalaccelerator#EndpointDescriptions", + "HealthCheckProtocol": { + "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { - "smithy.api#documentation": "

The list of endpoint objects.

" + "smithy.api#documentation": "

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.

" } }, "HealthCheckPort": { @@ -1145,12 +1145,6 @@ "smithy.api#documentation": "

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.

" } }, - "HealthCheckProtocol": { - "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", - "traits": { - "smithy.api#documentation": "

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.

" - } - }, "EndpointGroupArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { @@ -1162,6 +1156,12 @@ "traits": { "smithy.api#documentation": "

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.

\n\t\t

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.

\n\t\t

The default value is 100.

" } + }, + "EndpointGroupRegion": { + "target": "com.amazonaws.globalaccelerator#GenericString", + "traits": { + "smithy.api#documentation": "

The AWS Region that this endpoint group belongs.

" + } } }, "traits": { @@ -1313,7 +1313,7 @@ "sdkId": "Global Accelerator", "arnNamespace": "globalaccelerator", "cloudFormationName": "GlobalAccelerator", - "cloudTrailEventSource": "v20180706.globalaccelerator.amazonaws.com" + "cloudTrailEventSource": "globalaccelerator.amazonaws.com" }, "aws.auth#sigv4": { "name": "globalaccelerator" @@ -1481,17 +1481,17 @@ "com.amazonaws.globalaccelerator#IpSet": { "type": "structure", "members": { - "IpFamily": { - "target": "com.amazonaws.globalaccelerator#GenericString", - "traits": { - "smithy.api#documentation": "

The types of IP addresses included in this IP set.

" - } - }, "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { "smithy.api#documentation": "

The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

" } + }, + "IpFamily": { + "target": "com.amazonaws.globalaccelerator#GenericString", + "traits": { + "smithy.api#documentation": "

The types of IP addresses included in this IP set.

" + } } }, "traits": { @@ -1663,6 +1663,12 @@ "com.amazonaws.globalaccelerator#ListEndpointGroupsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.globalaccelerator#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of endpoint group objects that you want to return with this call. The default value is 10.

" + } + }, "ListenerArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { @@ -1675,29 +1681,23 @@ "traits": { "smithy.api#documentation": "

The token for the next set of results. You receive this token from a previous call.

" } - }, - "MaxResults": { - "target": "com.amazonaws.globalaccelerator#MaxResults", - "traits": { - "smithy.api#documentation": "

The number of endpoint group objects that you want to return with this call. The default value is 10.

" - } } } }, "com.amazonaws.globalaccelerator#ListEndpointGroupsResponse": { "type": "structure", "members": { - "EndpointGroups": { - "target": "com.amazonaws.globalaccelerator#EndpointGroups", - "traits": { - "smithy.api#documentation": "

The list of the endpoint groups associated with a listener.

" - } - }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "

The token for the next set of results. You receive this token from a previous call.

" } + }, + "EndpointGroups": { + "target": "com.amazonaws.globalaccelerator#EndpointGroups", + "traits": { + "smithy.api#documentation": "

The list of the endpoint groups associated with a listener.

" + } } } }, @@ -1730,13 +1730,6 @@ "com.amazonaws.globalaccelerator#ListListenersRequest": { "type": "structure", "members": { - "AcceleratorArn": { - "target": "com.amazonaws.globalaccelerator#GenericString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

", - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { @@ -1748,6 +1741,13 @@ "traits": { "smithy.api#documentation": "

The number of listener objects that you want to return with this call. The default value is 10.

" } + }, + "AcceleratorArn": { + "target": "com.amazonaws.globalaccelerator#GenericString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

", + "smithy.api#required": {} + } } } }, @@ -1817,16 +1817,10 @@ "com.amazonaws.globalaccelerator#Listener": { "type": "structure", "members": { - "ClientAffinity": { - "target": "com.amazonaws.globalaccelerator#ClientAffinity", - "traits": { - "smithy.api#documentation": "

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.

\n\t\t

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.

\n\t\t

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.

\n\t\t

The default value is NONE.

" - } - }, - "Protocol": { - "target": "com.amazonaws.globalaccelerator#Protocol", + "PortRanges": { + "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { - "smithy.api#documentation": "

The protocol for the connections from clients to the accelerator.

" + "smithy.api#documentation": "

The list of port ranges for the connections from clients to the accelerator.

" } }, "ListenerArn": { @@ -1835,10 +1829,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the listener.

" } }, - "PortRanges": { - "target": "com.amazonaws.globalaccelerator#PortRanges", + "ClientAffinity": { + "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "

The list of port ranges for the connections from clients to the accelerator.

" + "smithy.api#documentation": "

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.

\n\t\t

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.

\n\t\t

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.

\n\t\t

The default value is NONE.

" + } + }, + "Protocol": { + "target": "com.amazonaws.globalaccelerator#Protocol", + "traits": { + "smithy.api#documentation": "

The protocol for the connections from clients to the accelerator.

" } } }, @@ -1888,16 +1888,16 @@ "com.amazonaws.globalaccelerator#PortRange": { "type": "structure", "members": { - "ToPort": { + "FromPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { - "smithy.api#documentation": "

The last port in the range of ports, inclusive.

" + "smithy.api#documentation": "

The first port in the range of ports, inclusive.

" } }, - "FromPort": { + "ToPort": { "target": "com.amazonaws.globalaccelerator#PortNumber", "traits": { - "smithy.api#documentation": "

The first port in the range of ports, inclusive.

" + "smithy.api#documentation": "

The last port in the range of ports, inclusive.

" } } }, @@ -2069,17 +2069,17 @@ "com.amazonaws.globalaccelerator#TagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.globalaccelerator#ResourceArn", + "Tags": { + "target": "com.amazonaws.globalaccelerator#Tags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.

", + "smithy.api#documentation": "

The tags to add to a resource. A tag consists of a key and a value that you define.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.globalaccelerator#Tags", + "ResourceArn": { + "target": "com.amazonaws.globalaccelerator#ResourceArn", "traits": { - "smithy.api#documentation": "

The tags to add to a resource. A tag consists of a key and a value that you define.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.

", "smithy.api#required": {} } } @@ -2153,17 +2153,17 @@ "com.amazonaws.globalaccelerator#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.globalaccelerator#TagKeys", + "ResourceArn": { + "target": "com.amazonaws.globalaccelerator#ResourceArn", "traits": { - "smithy.api#documentation": "

The tag key pairs that you want to remove from the specified resources.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.globalaccelerator#ResourceArn", + "TagKeys": { + "target": "com.amazonaws.globalaccelerator#TagKeys", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.

", + "smithy.api#documentation": "

The tag key pairs that you want to remove from the specified resources.

", "smithy.api#required": {} } } @@ -2266,30 +2266,30 @@ "com.amazonaws.globalaccelerator#UpdateAcceleratorRequest": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.globalaccelerator#GenericBoolean", - "traits": { - "smithy.api#documentation": "

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

\n\t\t

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

" - } - }, "Name": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "

The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or\n\t\t\thyphens (-), and must not begin or end with a hyphen.

" } }, + "IpAddressType": { + "target": "com.amazonaws.globalaccelerator#IpAddressType", + "traits": { + "smithy.api#documentation": "

The value for the address type must be IPv4.\n\t\t\t

" + } + }, + "Enabled": { + "target": "com.amazonaws.globalaccelerator#GenericBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

\n\t\t

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

" + } + }, "AcceleratorArn": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the accelerator to update.

", "smithy.api#required": {} } - }, - "IpAddressType": { - "target": "com.amazonaws.globalaccelerator#IpAddressType", - "traits": { - "smithy.api#documentation": "

The value for the address type must be IPv4.\n\t\t\t

" - } } } }, @@ -2336,28 +2336,16 @@ "com.amazonaws.globalaccelerator#UpdateEndpointGroupRequest": { "type": "structure", "members": { - "EndpointConfigurations": { - "target": "com.amazonaws.globalaccelerator#EndpointConfigurations", - "traits": { - "smithy.api#documentation": "

The list of endpoint objects.

" - } - }, "HealthCheckIntervalSeconds": { "target": "com.amazonaws.globalaccelerator#HealthCheckIntervalSeconds", "traits": { "smithy.api#documentation": "

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

" } }, - "ThresholdCount": { - "target": "com.amazonaws.globalaccelerator#ThresholdCount", - "traits": { - "smithy.api#documentation": "

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.

" - } - }, - "HealthCheckProtocol": { - "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", + "HealthCheckPath": { + "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.

" + "smithy.api#documentation": "

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The\n\t\t\tdefault value is slash (/).

" } }, "EndpointGroupArn": { @@ -2367,10 +2355,10 @@ "smithy.api#required": {} } }, - "HealthCheckPort": { - "target": "com.amazonaws.globalaccelerator#HealthCheckPort", + "HealthCheckProtocol": { + "target": "com.amazonaws.globalaccelerator#HealthCheckProtocol", "traits": { - "smithy.api#documentation": "

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t\t\tis the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses\n\t\t\tthe first port in the list.

" + "smithy.api#documentation": "

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default\n\t\t\tvalue is TCP.

" } }, "TrafficDialPercentage": { @@ -2379,10 +2367,22 @@ "smithy.api#documentation": "

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.

\n\t\t

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.

\n\t\t

The default value is 100.

" } }, - "HealthCheckPath": { - "target": "com.amazonaws.globalaccelerator#GenericString", + "ThresholdCount": { + "target": "com.amazonaws.globalaccelerator#ThresholdCount", "traits": { - "smithy.api#documentation": "

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The\n\t\t\tdefault value is slash (/).

" + "smithy.api#documentation": "

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an\n\t\t\tunhealthy endpoint to healthy. The default value is 3.

" + } + }, + "HealthCheckPort": { + "target": "com.amazonaws.globalaccelerator#HealthCheckPort", + "traits": { + "smithy.api#documentation": "

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port\n\t\t\tis the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses\n\t\t\tthe first port in the list.

" + } + }, + "EndpointConfigurations": { + "target": "com.amazonaws.globalaccelerator#EndpointConfigurations", + "traits": { + "smithy.api#documentation": "

The list of endpoint objects.

" } } } @@ -2430,16 +2430,10 @@ "com.amazonaws.globalaccelerator#UpdateListenerRequest": { "type": "structure", "members": { - "ClientAffinity": { - "target": "com.amazonaws.globalaccelerator#ClientAffinity", - "traits": { - "smithy.api#documentation": "

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.

\n\t\t

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.

\n\t\t

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.

\n\t\t

The default value is NONE.

" - } - }, - "Protocol": { - "target": "com.amazonaws.globalaccelerator#Protocol", + "PortRanges": { + "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { - "smithy.api#documentation": "

The updated protocol for the connections from clients to the accelerator.

" + "smithy.api#documentation": "

The updated list of port ranges for the connections from clients to the accelerator.

" } }, "ListenerArn": { @@ -2449,10 +2443,16 @@ "smithy.api#required": {} } }, - "PortRanges": { - "target": "com.amazonaws.globalaccelerator#PortRanges", + "Protocol": { + "target": "com.amazonaws.globalaccelerator#Protocol", "traits": { - "smithy.api#documentation": "

The updated list of port ranges for the connections from clients to the accelerator.

" + "smithy.api#documentation": "

The updated protocol for the connections from clients to the accelerator.

" + } + }, + "ClientAffinity": { + "target": "com.amazonaws.globalaccelerator#ClientAffinity", + "traits": { + "smithy.api#documentation": "

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.

\n\t\t

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t\t\taffinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.

\n\t\t

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t\tinstead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.

\n\t\t

The default value is NONE.

" } } } 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 3e039f3a0e2e..0ee8ca1bc4eb 100644 --- a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json +++ b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json @@ -69,6 +69,9 @@ { "target": "com.amazonaws.glue#BatchStopJobRun" }, + { + "target": "com.amazonaws.glue#BatchUpdatePartition" + }, { "target": "com.amazonaws.glue#CancelMLTaskRun" }, @@ -246,6 +249,9 @@ { "target": "com.amazonaws.glue#GetPartition" }, + { + "target": "com.amazonaws.glue#GetPartitionIndexes" + }, { "target": "com.amazonaws.glue#GetPartitions" }, @@ -466,18 +472,6 @@ "com.amazonaws.glue#Action": { "type": "structure", "members": { - "Timeout": { - "target": "com.amazonaws.glue#Timeout", - "traits": { - "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. The default\n is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" - } - }, - "NotificationProperty": { - "target": "com.amazonaws.glue#NotificationProperty", - "traits": { - "smithy.api#documentation": "

Specifies configuration properties of a job run notification.

" - } - }, "Arguments": { "target": "com.amazonaws.glue#GenericMap", "traits": { @@ -496,6 +490,18 @@ "smithy.api#documentation": "

The name of the crawler to be used with this action.

" } }, + "NotificationProperty": { + "target": "com.amazonaws.glue#NotificationProperty", + "traits": { + "smithy.api#documentation": "

Specifies configuration properties of a job run notification.

" + } + }, + "Timeout": { + "target": "com.amazonaws.glue#Timeout", + "traits": { + "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. The default\n is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" + } + }, "JobName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -513,6 +519,15 @@ "target": "com.amazonaws.glue#Action" } }, + "com.amazonaws.glue#AdditionalPlanOptionsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#GenericString" + }, + "value": { + "target": "com.amazonaws.glue#GenericString" + } + }, "com.amazonaws.glue#AlreadyExistsException": { "type": "structure", "members": { @@ -569,12 +584,6 @@ "com.amazonaws.glue#BatchCreatePartitionRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the catalog in which the partition is to be created. Currently, this should be\n the AWS account ID.

" - } - }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -595,6 +604,12 @@ "smithy.api#documentation": "

A list of PartitionInput structures that define\n the partitions to be created.

", "smithy.api#required": {} } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the catalog in which the partition is to be created. Currently, this should be\n the AWS account ID.

" + } } } }, @@ -700,17 +715,17 @@ "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.glue#NameString", + "PartitionsToDelete": { + "target": "com.amazonaws.glue#BatchDeletePartitionValueList", "traits": { - "smithy.api#documentation": "

The name of the table that contains the partitions to be deleted.

", + "smithy.api#documentation": "

A list of PartitionInput structures that define\n the partitions to be deleted.

", "smithy.api#required": {} } }, - "PartitionsToDelete": { - "target": "com.amazonaws.glue#BatchDeletePartitionValueList", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A list of PartitionInput structures that define\n the partitions to be deleted.

", + "smithy.api#documentation": "

The name of the table that contains the partitions to be deleted.

", "smithy.api#required": {} } }, @@ -786,6 +801,12 @@ "com.amazonaws.glue#BatchDeleteTableRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" + } + }, "TablesToDelete": { "target": "com.amazonaws.glue#BatchDeleteTableNameList", "traits": { @@ -799,12 +820,6 @@ "smithy.api#documentation": "

The name of the catalog database in which the tables to delete reside. For Hive\n compatibility, this name is entirely lowercase.

", "smithy.api#required": {} } - }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" - } } } }, @@ -860,13 +875,6 @@ "com.amazonaws.glue#BatchDeleteTableVersionRequest": { "type": "structure", "members": { - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The database in the catalog in which the table resides. For Hive\n compatibility, this name is entirely lowercase.

", - "smithy.api#required": {} - } - }, "VersionIds": { "target": "com.amazonaws.glue#BatchDeleteTableVersionList", "traits": { @@ -886,6 +894,13 @@ "smithy.api#documentation": "

The name of the table. For Hive compatibility, \n this name is entirely lowercase.

", "smithy.api#required": {} } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The database in the catalog in which the table resides. For Hive\n compatibility, this name is entirely lowercase.

", + "smithy.api#required": {} + } } } }, @@ -935,17 +950,17 @@ "com.amazonaws.glue#BatchGetCrawlersResponse": { "type": "structure", "members": { - "Crawlers": { - "target": "com.amazonaws.glue#CrawlerList", - "traits": { - "smithy.api#documentation": "

A list of crawler definitions.

" - } - }, "CrawlersNotFound": { "target": "com.amazonaws.glue#CrawlerNameList", "traits": { "smithy.api#documentation": "

A list of names of crawlers that were not found.

" } + }, + "Crawlers": { + "target": "com.amazonaws.glue#CrawlerList", + "traits": { + "smithy.api#documentation": "

A list of crawler definitions.

" + } } } }, @@ -1088,10 +1103,11 @@ "com.amazonaws.glue#BatchGetPartitionRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", + "smithy.api#required": {} } }, "PartitionsToGet": { @@ -1101,11 +1117,10 @@ "smithy.api#required": {} } }, - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" } }, "TableName": { @@ -1184,17 +1199,17 @@ "com.amazonaws.glue#BatchGetTriggersResponse": { "type": "structure", "members": { - "Triggers": { - "target": "com.amazonaws.glue#TriggerList", - "traits": { - "smithy.api#documentation": "

A list of trigger definitions.

" - } - }, "TriggersNotFound": { "target": "com.amazonaws.glue#TriggerNameList", "traits": { "smithy.api#documentation": "

A list of names of triggers not found.

" } + }, + "Triggers": { + "target": "com.amazonaws.glue#TriggerList", + "traits": { + "smithy.api#documentation": "

A list of trigger definitions.

" + } } } }, @@ -1224,18 +1239,18 @@ "com.amazonaws.glue#BatchGetWorkflowsRequest": { "type": "structure", "members": { + "IncludeGraph": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include a graph when returning the workflow resource metadata.

" + } + }, "Names": { "target": "com.amazonaws.glue#WorkflowNames", "traits": { "smithy.api#documentation": "

A list of workflow names, which may be the names returned from the ListWorkflows operation.

", "smithy.api#required": {} } - }, - "IncludeGraph": { - "target": "com.amazonaws.glue#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to include a graph when returning the workflow resource metadata.

" - } } } }, @@ -1282,10 +1297,10 @@ "com.amazonaws.glue#BatchStopJobRunError": { "type": "structure", "members": { - "JobRunId": { - "target": "com.amazonaws.glue#IdString", + "ErrorDetail": { + "target": "com.amazonaws.glue#ErrorDetail", "traits": { - "smithy.api#documentation": "

The JobRunId of the job run in question.

" + "smithy.api#documentation": "

Specifies details about the error that was encountered.

" } }, "JobName": { @@ -1294,10 +1309,10 @@ "smithy.api#documentation": "

The name of the job definition that is used in the job run in question.

" } }, - "ErrorDetail": { - "target": "com.amazonaws.glue#ErrorDetail", + "JobRunId": { + "target": "com.amazonaws.glue#IdString", "traits": { - "smithy.api#documentation": "

Specifies details about the error that was encountered.

" + "smithy.api#documentation": "

The JobRunId of the job run in question.

" } } }, @@ -1326,17 +1341,17 @@ "com.amazonaws.glue#BatchStopJobRunRequest": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.glue#NameString", + "JobRunIds": { + "target": "com.amazonaws.glue#BatchStopJobRunJobRunIdList", "traits": { - "smithy.api#documentation": "

The name of the job definition for which to stop job runs.

", + "smithy.api#documentation": "

A list of the JobRunIds that should be stopped for that job\n definition.

", "smithy.api#required": {} } }, - "JobRunIds": { - "target": "com.amazonaws.glue#BatchStopJobRunJobRunIdList", + "JobName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A list of the JobRunIds that should be stopped for that job\n definition.

", + "smithy.api#documentation": "

The name of the job definition for which to stop job runs.

", "smithy.api#required": {} } } @@ -1345,17 +1360,17 @@ "com.amazonaws.glue#BatchStopJobRunResponse": { "type": "structure", "members": { - "Errors": { - "target": "com.amazonaws.glue#BatchStopJobRunErrorList", - "traits": { - "smithy.api#documentation": "

A list of the errors that were encountered in trying to stop JobRuns,\n including the JobRunId for which each error was encountered and details about the\n error.

" - } - }, "SuccessfulSubmissions": { "target": "com.amazonaws.glue#BatchStopJobRunSuccessfulSubmissionList", "traits": { "smithy.api#documentation": "

A list of the JobRuns that were successfully submitted for stopping.

" } + }, + "Errors": { + "target": "com.amazonaws.glue#BatchStopJobRunErrorList", + "traits": { + "smithy.api#documentation": "

A list of the errors that were encountered in trying to stop JobRuns,\n including the JobRunId for which each error was encountered and details about the\n error.

" + } } } }, @@ -1385,78 +1400,210 @@ "target": "com.amazonaws.glue#BatchStopJobRunSuccessfulSubmission" } }, - "com.amazonaws.glue#BinaryColumnStatisticsData": { + "com.amazonaws.glue#BatchUpdatePartition": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#BatchUpdatePartitionRequest" + }, + "output": { + "target": "com.amazonaws.glue#BatchUpdatePartitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates one or more partitions in a batch operation.

" + } + }, + "com.amazonaws.glue#BatchUpdatePartitionFailureEntry": { "type": "structure", "members": { - "NumberOfNulls": { - "target": "com.amazonaws.glue#NonNegativeLong", - "traits": { - "smithy.api#documentation": "

Number of nulls.

", - "smithy.api#required": {} - } - }, - "MaximumLength": { - "target": "com.amazonaws.glue#NonNegativeLong", + "PartitionValueList": { + "target": "com.amazonaws.glue#BoundedPartitionValueList", "traits": { - "smithy.api#documentation": "

Maximum length of the column.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of values defining the partitions.

" } }, - "AverageLength": { - "target": "com.amazonaws.glue#NonNegativeDouble", + "ErrorDetail": { + "target": "com.amazonaws.glue#ErrorDetail", "traits": { - "smithy.api#documentation": "

Average length of the column.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The details about the batch update partition error.

" } } }, "traits": { - "smithy.api#documentation": "

Defines a binary column statistics data.

" + "smithy.api#documentation": "

Contains information about a batch update partition error.

" } }, - "com.amazonaws.glue#Blob": { - "type": "blob" - }, - "com.amazonaws.glue#Boolean": { - "type": "boolean" + "com.amazonaws.glue#BatchUpdatePartitionFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#BatchUpdatePartitionFailureEntry" + } }, - "com.amazonaws.glue#BooleanColumnStatisticsData": { + "com.amazonaws.glue#BatchUpdatePartitionRequest": { "type": "structure", "members": { - "NumberOfTrues": { - "target": "com.amazonaws.glue#NonNegativeLong", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Number of true value.

", + "smithy.api#documentation": "

The name of the metadata table in which the partition is to be updated.

", "smithy.api#required": {} } }, - "NumberOfNulls": { - "target": "com.amazonaws.glue#NonNegativeLong", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

Number of nulls.

", + "smithy.api#documentation": "

The ID of the catalog in which the partition is to be updated. Currently, this should be\n the AWS account ID.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the metadata database in which the partition is\n to be updated.

", "smithy.api#required": {} } }, - "NumberOfFalses": { - "target": "com.amazonaws.glue#NonNegativeLong", + "Entries": { + "target": "com.amazonaws.glue#BatchUpdatePartitionRequestEntryList", "traits": { - "smithy.api#documentation": "

Number of false value.

", + "smithy.api#documentation": "

A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.

", "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

Defines a boolean column statistics.

" } }, - "com.amazonaws.glue#BooleanNullable": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.glue#BooleanValue": { - "type": "boolean" + "com.amazonaws.glue#BatchUpdatePartitionRequestEntry": { + "type": "structure", + "members": { + "PartitionValueList": { + "target": "com.amazonaws.glue#BoundedPartitionValueList", + "traits": { + "smithy.api#documentation": "

A list of values defining the partitions.

", + "smithy.api#required": {} + } + }, + "PartitionInput": { + "target": "com.amazonaws.glue#PartitionInput", + "traits": { + "smithy.api#documentation": "

The structure used to update a partition.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the values and structure used to update a partition.

" + } + }, + "com.amazonaws.glue#BatchUpdatePartitionRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#BatchUpdatePartitionRequestEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.glue#BatchUpdatePartitionResponse": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.glue#BatchUpdatePartitionFailureList", + "traits": { + "smithy.api#documentation": "

The errors encountered when trying to update the requested partitions. A list of BatchUpdatePartitionFailureEntry objects.

" + } + } + } + }, + "com.amazonaws.glue#BinaryColumnStatisticsData": { + "type": "structure", + "members": { + "AverageLength": { + "target": "com.amazonaws.glue#NonNegativeDouble", + "traits": { + "smithy.api#documentation": "

Average length of the column.

", + "smithy.api#required": {} + } + }, + "NumberOfNulls": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "

Number of nulls.

", + "smithy.api#required": {} + } + }, + "MaximumLength": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "

Maximum length of the column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a binary column statistics data.

" + } + }, + "com.amazonaws.glue#Blob": { + "type": "blob" + }, + "com.amazonaws.glue#Boolean": { + "type": "boolean" + }, + "com.amazonaws.glue#BooleanColumnStatisticsData": { + "type": "structure", + "members": { + "NumberOfFalses": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "

Number of false value.

", + "smithy.api#required": {} + } + }, + "NumberOfTrues": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "

Number of true value.

", + "smithy.api#required": {} + } + }, + "NumberOfNulls": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "

Number of nulls.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a boolean column statistics.

" + } + }, + "com.amazonaws.glue#BooleanNullable": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.glue#BooleanValue": { + "type": "boolean" }, "com.amazonaws.glue#BoundedPartitionValueList": { "type": "list", @@ -1518,10 +1665,10 @@ "com.amazonaws.glue#CancelMLTaskRunResponse": { "type": "structure", "members": { - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "Status": { + "target": "com.amazonaws.glue#TaskStatusType", "traits": { - "smithy.api#documentation": "

The unique identifier of the machine learning transform.

" + "smithy.api#documentation": "

The status for this run.

" } }, "TaskRunId": { @@ -1530,10 +1677,10 @@ "smithy.api#documentation": "

The unique identifier for the task run.

" } }, - "Status": { - "target": "com.amazonaws.glue#TaskStatusType", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

The status for this run.

" + "smithy.api#documentation": "

The unique identifier of the machine learning transform.

" } } } @@ -1600,17 +1747,17 @@ "smithy.api#documentation": "

\n True if the migration has completed, or False otherwise.

" } }, - "ImportTime": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the migration was started.

" - } - }, "ImportedBy": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the person who initiated the migration.

" } + }, + "ImportTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the migration was started.

" + } } }, "traits": { @@ -1662,16 +1809,16 @@ "com.amazonaws.glue#Classifier": { "type": "structure", "members": { - "CsvClassifier": { - "target": "com.amazonaws.glue#CsvClassifier", + "XMLClassifier": { + "target": "com.amazonaws.glue#XMLClassifier", "traits": { - "smithy.api#documentation": "

A classifier for comma-separated values (CSV).

" + "smithy.api#documentation": "

A classifier for XML content.

" } }, - "GrokClassifier": { - "target": "com.amazonaws.glue#GrokClassifier", + "CsvClassifier": { + "target": "com.amazonaws.glue#CsvClassifier", "traits": { - "smithy.api#documentation": "

A classifier that uses grok.

" + "smithy.api#documentation": "

A classifier for comma-separated values (CSV).

" } }, "JsonClassifier": { @@ -1680,10 +1827,10 @@ "smithy.api#documentation": "

A classifier for JSON content.

" } }, - "XMLClassifier": { - "target": "com.amazonaws.glue#XMLClassifier", + "GrokClassifier": { + "target": "com.amazonaws.glue#GrokClassifier", "traits": { - "smithy.api#documentation": "

A classifier for XML content.

" + "smithy.api#documentation": "

A classifier that uses grok.

" } } }, @@ -1754,18 +1901,18 @@ "smithy.api#required": {} } }, - "TargetParameter": { - "target": "com.amazonaws.glue#CodeGenArgName", - "traits": { - "smithy.api#documentation": "

The target of the edge.

" - } - }, "Target": { "target": "com.amazonaws.glue#CodeGenIdentifier", "traits": { "smithy.api#documentation": "

The ID of the node at which the edge ends.

", "smithy.api#required": {} } + }, + "TargetParameter": { + "target": "com.amazonaws.glue#CodeGenArgName", + "traits": { + "smithy.api#documentation": "

The target of the edge.

" + } } }, "traits": { @@ -1785,12 +1932,6 @@ "com.amazonaws.glue#CodeGenNode": { "type": "structure", "members": { - "LineNumber": { - "target": "com.amazonaws.glue#Integer", - "traits": { - "smithy.api#documentation": "

The line number of the node.

" - } - }, "Args": { "target": "com.amazonaws.glue#CodeGenNodeArgs", "traits": { @@ -1798,11 +1939,10 @@ "smithy.api#required": {} } }, - "NodeType": { - "target": "com.amazonaws.glue#CodeGenNodeType", + "LineNumber": { + "target": "com.amazonaws.glue#Integer", "traits": { - "smithy.api#documentation": "

The type of node that this is.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The line number of the node.

" } }, "Id": { @@ -1811,6 +1951,13 @@ "smithy.api#documentation": "

A node identifier that is unique within the node's graph.

", "smithy.api#required": {} } + }, + "NodeType": { + "target": "com.amazonaws.glue#CodeGenNodeType", + "traits": { + "smithy.api#documentation": "

The type of node that this is.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1820,12 +1967,6 @@ "com.amazonaws.glue#CodeGenNodeArg": { "type": "structure", "members": { - "Param": { - "target": "com.amazonaws.glue#Boolean", - "traits": { - "smithy.api#documentation": "

True if the value is used as a parameter.

" - } - }, "Name": { "target": "com.amazonaws.glue#CodeGenArgName", "traits": { @@ -1833,6 +1974,12 @@ "smithy.api#required": {} } }, + "Param": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#documentation": "

True if the value is used as a parameter.

" + } + }, "Value": { "target": "com.amazonaws.glue#CodeGenArgValue", "traits": { @@ -1863,6 +2010,12 @@ "com.amazonaws.glue#Column": { "type": "structure", "members": { + "Type": { + "target": "com.amazonaws.glue#ColumnTypeString", + "traits": { + "smithy.api#documentation": "

The data type of the Column.

" + } + }, "Parameters": { "target": "com.amazonaws.glue#ParametersMap", "traits": { @@ -1881,12 +2034,6 @@ "smithy.api#documentation": "

The name of the Column.

", "smithy.api#required": {} } - }, - "Type": { - "target": "com.amazonaws.glue#ColumnTypeString", - "traits": { - "smithy.api#documentation": "

The data type of the Column.

" - } } }, "traits": { @@ -1896,17 +2043,17 @@ "com.amazonaws.glue#ColumnError": { "type": "structure", "members": { - "Error": { - "target": "com.amazonaws.glue#ErrorDetail", - "traits": { - "smithy.api#documentation": "

The error message occurred during operation.

" - } - }, "ColumnName": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the column.

" } + }, + "Error": { + "target": "com.amazonaws.glue#ErrorDetail", + "traits": { + "smithy.api#documentation": "

The error message occurred during operation.

" + } } }, "traits": { @@ -1938,10 +2085,10 @@ "com.amazonaws.glue#ColumnStatistics": { "type": "structure", "members": { - "AnalyzedTime": { - "target": "com.amazonaws.glue#Timestamp", + "ColumnName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The analyzed time of the column statistics.

", + "smithy.api#documentation": "

The name of the column.

", "smithy.api#required": {} } }, @@ -1952,17 +2099,17 @@ "smithy.api#required": {} } }, - "ColumnType": { - "target": "com.amazonaws.glue#TypeString", + "AnalyzedTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The type of the column.

", + "smithy.api#documentation": "

The analyzed time of the column statistics.

", "smithy.api#required": {} } }, - "ColumnName": { - "target": "com.amazonaws.glue#NameString", + "ColumnType": { + "target": "com.amazonaws.glue#TypeString", "traits": { - "smithy.api#documentation": "

The name of the column.

", + "smithy.api#documentation": "

The type of the column.

", "smithy.api#required": {} } } @@ -1974,17 +2121,22 @@ "com.amazonaws.glue#ColumnStatisticsData": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.glue#ColumnStatisticsType", + "BooleanColumnStatisticsData": { + "target": "com.amazonaws.glue#BooleanColumnStatisticsData", "traits": { - "smithy.api#documentation": "

The name of the column.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Boolean Column Statistics Data.

" } }, - "StringColumnStatisticsData": { - "target": "com.amazonaws.glue#StringColumnStatisticsData", + "DecimalColumnStatisticsData": { + "target": "com.amazonaws.glue#DecimalColumnStatisticsData", "traits": { - "smithy.api#documentation": "

String Column Statistics Data.

" + "smithy.api#documentation": "

Decimal Column Statistics Data.

" + } + }, + "BinaryColumnStatisticsData": { + "target": "com.amazonaws.glue#BinaryColumnStatisticsData", + "traits": { + "smithy.api#documentation": "

Binary Column Statistics Data.

" } }, "DoubleColumnStatisticsData": { @@ -1999,16 +2151,17 @@ "smithy.api#documentation": "

Long Column Statistics Data.

" } }, - "BooleanColumnStatisticsData": { - "target": "com.amazonaws.glue#BooleanColumnStatisticsData", + "Type": { + "target": "com.amazonaws.glue#ColumnStatisticsType", "traits": { - "smithy.api#documentation": "

Boolean Column Statistics Data.

" + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} } }, - "DecimalColumnStatisticsData": { - "target": "com.amazonaws.glue#DecimalColumnStatisticsData", + "StringColumnStatisticsData": { + "target": "com.amazonaws.glue#StringColumnStatisticsData", "traits": { - "smithy.api#documentation": "

Decimal Column Statistics Data.

" + "smithy.api#documentation": "

String Column Statistics Data.

" } }, "DateColumnStatisticsData": { @@ -2016,12 +2169,6 @@ "traits": { "smithy.api#documentation": "

Date Column Statistics Data.

" } - }, - "BinaryColumnStatisticsData": { - "target": "com.amazonaws.glue#BinaryColumnStatisticsData", - "traits": { - "smithy.api#documentation": "

Binary Column Statistics Data.

" - } } }, "traits": { @@ -2031,17 +2178,17 @@ "com.amazonaws.glue#ColumnStatisticsError": { "type": "structure", "members": { - "ColumnStatistics": { - "target": "com.amazonaws.glue#ColumnStatistics", - "traits": { - "smithy.api#documentation": "

The ColumnStatistics of the column.

" - } - }, "Error": { "target": "com.amazonaws.glue#ErrorDetail", "traits": { "smithy.api#documentation": "

The error message occurred during operation.

" } + }, + "ColumnStatistics": { + "target": "com.amazonaws.glue#ColumnStatistics", + "traits": { + "smithy.api#documentation": "

The ColumnStatistics of the column.

" + } } }, "traits": { @@ -2184,6 +2331,18 @@ "com.amazonaws.glue#Condition": { "type": "structure", "members": { + "State": { + "target": "com.amazonaws.glue#JobRunState", + "traits": { + "smithy.api#documentation": "

The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED, STOPPED, FAILED, and TIMEOUT. The only crawler states that a trigger can listen for are SUCCEEDED, FAILED, and CANCELLED.

" + } + }, + "LogicalOperator": { + "target": "com.amazonaws.glue#LogicalOperator", + "traits": { + "smithy.api#documentation": "

A logical operator.

" + } + }, "CrawlerName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -2196,23 +2355,11 @@ "smithy.api#documentation": "

The state of the crawler to which this condition applies.

" } }, - "LogicalOperator": { - "target": "com.amazonaws.glue#LogicalOperator", - "traits": { - "smithy.api#documentation": "

A logical operator.

" - } - }, "JobName": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the job whose JobRuns this condition applies to, and on which\n this trigger waits.

" } - }, - "State": { - "target": "com.amazonaws.glue#JobRunState", - "traits": { - "smithy.api#documentation": "

The condition state. Currently, the values supported are SUCCEEDED,\n STOPPED, TIMEOUT, and FAILED.

" - } } }, "traits": { @@ -2240,13 +2387,28 @@ "target": "com.amazonaws.glue#Condition" } }, + "com.amazonaws.glue#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

A message describing the problem.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CreatePartitions API was called on a table that has indexes enabled.\t

", + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#ConfusionMatrix": { "type": "structure", "members": { - "NumTruePositives": { + "NumTrueNegatives": { "target": "com.amazonaws.glue#RecordsCount", "traits": { - "smithy.api#documentation": "

The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.

" + "smithy.api#documentation": "

The number of nonmatches in the data that the transform correctly rejected, in the\n confusion matrix for your transform.

" } }, "NumFalsePositives": { @@ -2255,16 +2417,16 @@ "smithy.api#documentation": "

The number of nonmatches in the data that the transform incorrectly classified as a match,\n in the confusion matrix for your transform.

" } }, - "NumFalseNegatives": { + "NumTruePositives": { "target": "com.amazonaws.glue#RecordsCount", "traits": { - "smithy.api#documentation": "

The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.

" + "smithy.api#documentation": "

The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.

" } }, - "NumTrueNegatives": { + "NumFalseNegatives": { "target": "com.amazonaws.glue#RecordsCount", "traits": { - "smithy.api#documentation": "

The number of nonmatches in the data that the transform correctly rejected, in the\n confusion matrix for your transform.

" + "smithy.api#documentation": "

The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.

" } } }, @@ -2275,10 +2437,10 @@ "com.amazonaws.glue#Connection": { "type": "structure", "members": { - "Name": { + "LastUpdatedBy": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the connection definition.

" + "smithy.api#documentation": "

The user, group, or role that last updated this connection definition.

" } }, "PhysicalConnectionRequirements": { @@ -2287,12 +2449,6 @@ "smithy.api#documentation": "

A map of physical connection requirements, such as virtual private cloud (VPC) and\n SecurityGroup, that are needed to make this connection successfully.

" } }, - "ConnectionProperties": { - "target": "com.amazonaws.glue#ConnectionProperties", - "traits": { - "smithy.api#documentation": "

These key-value pairs define parameters for the connection:

\n " - } - }, "ConnectionType": { "target": "com.amazonaws.glue#ConnectionType", "traits": { @@ -2305,28 +2461,34 @@ "smithy.api#documentation": "

A list of criteria that can be used in selecting this connection.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "CreationTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The description of the connection.

" + "smithy.api#documentation": "

The time that this connection definition was created.

" } }, - "LastUpdatedBy": { + "LastUpdatedTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this connection definition was updated.

" + } + }, + "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The user, group, or role that last updated this connection definition.

" + "smithy.api#documentation": "

The name of the connection definition.

" } }, - "CreationTime": { - "target": "com.amazonaws.glue#Timestamp", + "ConnectionProperties": { + "target": "com.amazonaws.glue#ConnectionProperties", "traits": { - "smithy.api#documentation": "

The time that this connection definition was created.

" + "smithy.api#documentation": "

These key-value pairs define parameters for the connection:

\n " } }, - "LastUpdatedTime": { - "target": "com.amazonaws.glue#Timestamp", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

The last time that this connection definition was updated.

" + "smithy.api#documentation": "

The description of the connection.

" } } }, @@ -2337,17 +2499,30 @@ "com.amazonaws.glue#ConnectionInput": { "type": "structure", "members": { - "ConnectionType": { - "target": "com.amazonaws.glue#ConnectionType", + "MatchCriteria": { + "target": "com.amazonaws.glue#MatchCriteria", + "traits": { + "smithy.api#documentation": "

A list of criteria that can be used in selecting this connection.

" + } + }, + "PhysicalConnectionRequirements": { + "target": "com.amazonaws.glue#PhysicalConnectionRequirements", + "traits": { + "smithy.api#documentation": "

A map of physical connection requirements, such as virtual private cloud (VPC) and\n SecurityGroup, that are needed to successfully make this connection.

" + } + }, + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n\t \n

SFTP is not supported.

", + "smithy.api#documentation": "

The name of the connection.

", "smithy.api#required": {} } }, - "MatchCriteria": { - "target": "com.amazonaws.glue#MatchCriteria", + "ConnectionType": { + "target": "com.amazonaws.glue#ConnectionType", "traits": { - "smithy.api#documentation": "

A list of criteria that can be used in selecting this connection.

" + "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n\t \n

SFTP is not supported.

", + "smithy.api#required": {} } }, "ConnectionProperties": { @@ -2357,24 +2532,11 @@ "smithy.api#required": {} } }, - "PhysicalConnectionRequirements": { - "target": "com.amazonaws.glue#PhysicalConnectionRequirements", - "traits": { - "smithy.api#documentation": "

A map of physical connection requirements, such as virtual private cloud (VPC) and\n SecurityGroup, that are needed to successfully make this connection.

" - } - }, "Description": { "target": "com.amazonaws.glue#DescriptionString", "traits": { "smithy.api#documentation": "

The description of the connection.

" } - }, - "Name": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the connection.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2536,6 +2698,10 @@ { "value": "KAFKA", "name": "KAFKA" + }, + { + "value": "NETWORK", + "name": "NETWORK" } ] } @@ -2557,16 +2723,10 @@ "com.amazonaws.glue#Crawl": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.glue#DescriptionString", - "traits": { - "smithy.api#documentation": "

The error message associated with the crawl.

" - } - }, - "StartedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "LogStream": { + "target": "com.amazonaws.glue#LogStream", "traits": { - "smithy.api#documentation": "

The date and time on which the crawl started.

" + "smithy.api#documentation": "

The log stream associated with the crawl.

" } }, "CompletedOn": { @@ -2575,16 +2735,16 @@ "smithy.api#documentation": "

The date and time on which the crawl completed.

" } }, - "LogStream": { - "target": "com.amazonaws.glue#LogStream", + "StartedOn": { + "target": "com.amazonaws.glue#TimestampValue", "traits": { - "smithy.api#documentation": "

The log stream associated with the crawl.

" + "smithy.api#documentation": "

The date and time on which the crawl started.

" } }, - "State": { - "target": "com.amazonaws.glue#CrawlState", + "ErrorMessage": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

The state of the crawler.

" + "smithy.api#documentation": "

The error message associated with the crawl.

" } }, "LogGroup": { @@ -2592,6 +2752,12 @@ "traits": { "smithy.api#documentation": "

The log group associated with the crawl.

" } + }, + "State": { + "target": "com.amazonaws.glue#CrawlState", + "traits": { + "smithy.api#documentation": "

The state of the crawler.

" + } } }, "traits": { @@ -2634,6 +2800,18 @@ "com.amazonaws.glue#Crawler": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the crawler.

" + } + }, + "LastUpdated": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the crawler was last updated.

" + } + }, "LastCrawl": { "target": "com.amazonaws.glue#LastCrawlInfo", "traits": { @@ -2646,40 +2824,52 @@ "smithy.api#documentation": "

Indicates whether the crawler is running, or whether a run is pending.

" } }, + "Configuration": { + "target": "com.amazonaws.glue#CrawlerConfiguration", + "traits": { + "smithy.api#documentation": "

Crawler configuration information. This versioned JSON string allows users\n to specify aspects of a crawler's behavior.\n For more information, see Configuring a Crawler.

" + } + }, + "Classifiers": { + "target": "com.amazonaws.glue#ClassifierNameList", + "traits": { + "smithy.api#documentation": "

A list of UTF-8 strings that specify the custom classifiers that are associated \n with the crawler.

" + } + }, "Role": { "target": "com.amazonaws.glue#Role", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources,\n such as Amazon Simple Storage Service (Amazon S3) data.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "CrawlElapsedTime": { + "target": "com.amazonaws.glue#MillisecondsCount", "traits": { - "smithy.api#documentation": "

The name of the crawler.

" + "smithy.api#documentation": "

If the crawler is running, contains the total time elapsed since the last crawl\n began.

" } }, - "Schedule": { - "target": "com.amazonaws.glue#Schedule", + "TablePrefix": { + "target": "com.amazonaws.glue#TablePrefix", "traits": { - "smithy.api#documentation": "

For scheduled crawlers, the schedule when the crawler runs.

" + "smithy.api#documentation": "

The prefix added to the names of tables that are created.

" } }, - "CrawlerSecurityConfiguration": { - "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", + "Version": { + "target": "com.amazonaws.glue#VersionId", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used by this\n crawler.

" + "smithy.api#documentation": "

The version of the crawler.

" } }, - "DatabaseName": { - "target": "com.amazonaws.glue#DatabaseName", + "Schedule": { + "target": "com.amazonaws.glue#Schedule", "traits": { - "smithy.api#documentation": "

The name of the database in which the crawler's output is stored.

" + "smithy.api#documentation": "

For scheduled crawlers, the schedule when the crawler runs.

" } }, - "CrawlElapsedTime": { - "target": "com.amazonaws.glue#MillisecondsCount", + "CreationTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

If the crawler is running, contains the total time elapsed since the last crawl\n began.

" + "smithy.api#documentation": "

The time that the crawler was created.

" } }, "SchemaChangePolicy": { @@ -2700,40 +2890,16 @@ "smithy.api#documentation": "

A collection of targets to crawl.

" } }, - "CreationTime": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the crawler was created.

" - } - }, - "TablePrefix": { - "target": "com.amazonaws.glue#TablePrefix", + "CrawlerSecurityConfiguration": { + "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", "traits": { - "smithy.api#documentation": "

The prefix added to the names of tables that are created.

" + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used by this\n crawler.

" } }, - "Configuration": { - "target": "com.amazonaws.glue#CrawlerConfiguration", + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", "traits": { - "smithy.api#documentation": "

Crawler configuration information. This versioned JSON string allows users\n to specify aspects of a crawler's behavior.\n For more information, see Configuring a Crawler.

" - } - }, - "LastUpdated": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the crawler was last updated.

" - } - }, - "Classifiers": { - "target": "com.amazonaws.glue#ClassifierNameList", - "traits": { - "smithy.api#documentation": "

A list of UTF-8 strings that specify the custom classifiers that are associated \n with the crawler.

" - } - }, - "Version": { - "target": "com.amazonaws.glue#VersionId", - "traits": { - "smithy.api#documentation": "

The version of the crawler.

" + "smithy.api#documentation": "

The name of the database in which the crawler's output is stored.

" } } }, @@ -2753,46 +2919,40 @@ "com.amazonaws.glue#CrawlerMetrics": { "type": "structure", "members": { - "LastRuntimeSeconds": { + "TimeLeftSeconds": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { - "smithy.api#documentation": "

The duration of the crawler's most recent run, in seconds.

" + "smithy.api#documentation": "

The estimated time left to complete a running crawl.

" } }, - "StillEstimating": { - "target": "com.amazonaws.glue#Boolean", + "MedianRuntimeSeconds": { + "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { - "smithy.api#documentation": "

True if the crawler is still estimating how long it will take to complete this run.

" + "smithy.api#documentation": "

The median duration of this crawler's runs, in seconds.

" } }, - "TablesCreated": { + "TablesDeleted": { "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The number of tables created by this crawler.

" - } - }, - "CrawlerName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the crawler.

" + "smithy.api#documentation": "

The number of tables deleted by this crawler.

" } }, - "MedianRuntimeSeconds": { - "target": "com.amazonaws.glue#NonNegativeDouble", + "TablesCreated": { + "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The median duration of this crawler's runs, in seconds.

" + "smithy.api#documentation": "

The number of tables created by this crawler.

" } }, - "TablesDeleted": { - "target": "com.amazonaws.glue#NonNegativeInteger", + "StillEstimating": { + "target": "com.amazonaws.glue#Boolean", "traits": { - "smithy.api#documentation": "

The number of tables deleted by this crawler.

" + "smithy.api#documentation": "

True if the crawler is still estimating how long it will take to complete this run.

" } }, - "TimeLeftSeconds": { + "LastRuntimeSeconds": { "target": "com.amazonaws.glue#NonNegativeDouble", "traits": { - "smithy.api#documentation": "

The estimated time left to complete a running crawl.

" + "smithy.api#documentation": "

The duration of the crawler's most recent run, in seconds.

" } }, "TablesUpdated": { @@ -2800,6 +2960,12 @@ "traits": { "smithy.api#documentation": "

The number of tables updated by this crawler.

" } + }, + "CrawlerName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the crawler.

" + } } }, "traits": { @@ -2926,16 +3092,22 @@ "smithy.api#documentation": "

Specifies Amazon Simple Storage Service (Amazon S3) targets.

" } }, + "DynamoDBTargets": { + "target": "com.amazonaws.glue#DynamoDBTargetList", + "traits": { + "smithy.api#documentation": "

Specifies Amazon DynamoDB targets.

" + } + }, "CatalogTargets": { "target": "com.amazonaws.glue#CatalogTargetList", "traits": { "smithy.api#documentation": "

Specifies AWS Glue Data Catalog targets.

" } }, - "DynamoDBTargets": { - "target": "com.amazonaws.glue#DynamoDBTargetList", + "MongoDBTargets": { + "target": "com.amazonaws.glue#MongoDBTargetList", "traits": { - "smithy.api#documentation": "

Specifies Amazon DynamoDB targets.

" + "smithy.api#documentation": "

Specifies Amazon DocumentDB or MongoDB targets.

" } } }, @@ -2969,16 +3141,10 @@ "com.amazonaws.glue#CreateClassifierRequest": { "type": "structure", "members": { - "JsonClassifier": { - "target": "com.amazonaws.glue#CreateJsonClassifierRequest", - "traits": { - "smithy.api#documentation": "

A JsonClassifier object specifying the classifier\n to create.

" - } - }, - "CsvClassifier": { - "target": "com.amazonaws.glue#CreateCsvClassifierRequest", + "GrokClassifier": { + "target": "com.amazonaws.glue#CreateGrokClassifierRequest", "traits": { - "smithy.api#documentation": "

A CsvClassifier object specifying the classifier\n to create.

" + "smithy.api#documentation": "

A GrokClassifier object specifying the classifier\n to create.

" } }, "XMLClassifier": { @@ -2987,10 +3153,16 @@ "smithy.api#documentation": "

An XMLClassifier object specifying the classifier\n to create.

" } }, - "GrokClassifier": { - "target": "com.amazonaws.glue#CreateGrokClassifierRequest", + "CsvClassifier": { + "target": "com.amazonaws.glue#CreateCsvClassifierRequest", "traits": { - "smithy.api#documentation": "

A GrokClassifier object specifying the classifier\n to create.

" + "smithy.api#documentation": "

A CsvClassifier object specifying the classifier\n to create.

" + } + }, + "JsonClassifier": { + "target": "com.amazonaws.glue#CreateJsonClassifierRequest", + "traits": { + "smithy.api#documentation": "

A JsonClassifier object specifying the classifier\n to create.

" } } } @@ -3079,47 +3251,48 @@ "com.amazonaws.glue#CreateCrawlerRequest": { "type": "structure", "members": { - "Role": { - "target": "com.amazonaws.glue#Role", + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#SchemaChangePolicy", "traits": { - "smithy.api#documentation": "

The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to\n access customer resources.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The policy for the crawler's update and deletion behavior.

" } }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", + "Targets": { + "target": "com.amazonaws.glue#CrawlerTargets", "traits": { - "smithy.api#documentation": "

The tags to use with this crawler request. You may use tags to limit access to the\n crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer\n guide.

" + "smithy.api#documentation": "

A list of collection of targets to crawl.

", + "smithy.api#required": {} } }, - "Classifiers": { - "target": "com.amazonaws.glue#ClassifierNameList", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

A list of custom classifiers that the user has registered. By default, all built-in\n classifiers are included in a crawl, but these custom classifiers always override the default\n classifiers for a given classification.

" + "smithy.api#documentation": "

A description of the new crawler.

" } }, - "TablePrefix": { - "target": "com.amazonaws.glue#TablePrefix", + "DatabaseName": { + "target": "com.amazonaws.glue#DatabaseName", "traits": { - "smithy.api#documentation": "

The table prefix used for catalog tables that are created.

" + "smithy.api#documentation": "

The AWS Glue database where results are written, such as:\n arn:aws:daylight:us-east-1::database/sometable/*.

" } }, - "CrawlerSecurityConfiguration": { - "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", + "Role": { + "target": "com.amazonaws.glue#Role", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used by this\n crawler.

" + "smithy.api#documentation": "

The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to\n access customer resources.

", + "smithy.api#required": {} } }, - "DatabaseName": { - "target": "com.amazonaws.glue#DatabaseName", + "Tags": { + "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The AWS Glue database where results are written, such as:\n arn:aws:daylight:us-east-1::database/sometable/*.

" + "smithy.api#documentation": "

The tags to use with this crawler request. You may use tags to limit access to the\n crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer\n guide.

" } }, - "Schedule": { - "target": "com.amazonaws.glue#CronExpression", + "TablePrefix": { + "target": "com.amazonaws.glue#TablePrefix", "traits": { - "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" + "smithy.api#documentation": "

The table prefix used for catalog tables that are created.

" } }, "Name": { @@ -3129,29 +3302,28 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", - "traits": { - "smithy.api#documentation": "

A description of the new crawler.

" - } - }, "Configuration": { "target": "com.amazonaws.glue#CrawlerConfiguration", "traits": { "smithy.api#documentation": "

Crawler configuration information. This versioned JSON\n string allows users to specify aspects of a crawler's behavior.\n For more information, see Configuring a Crawler.

" } }, - "Targets": { - "target": "com.amazonaws.glue#CrawlerTargets", + "CrawlerSecurityConfiguration": { + "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", "traits": { - "smithy.api#documentation": "

A list of collection of targets to crawl.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used by this\n crawler.

" } }, - "SchemaChangePolicy": { - "target": "com.amazonaws.glue#SchemaChangePolicy", + "Classifiers": { + "target": "com.amazonaws.glue#ClassifierNameList", "traits": { - "smithy.api#documentation": "

The policy for the crawler's update and deletion behavior.

" + "smithy.api#documentation": "

A list of custom classifiers that the user has registered. By default, all built-in\n classifiers are included in a crawl, but these custom classifiers always override the default\n classifiers for a given classification.

" + } + }, + "Schedule": { + "target": "com.amazonaws.glue#CronExpression", + "traits": { + "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" } } } @@ -3163,17 +3335,10 @@ "com.amazonaws.glue#CreateCsvClassifierRequest": { "type": "structure", "members": { - "DisableValueTrimming": { - "target": "com.amazonaws.glue#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Specifies not to trim values before identifying the type of column values. The default value is true.

" - } - }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "Delimiter": { + "target": "com.amazonaws.glue#CsvColumnDelimiter", "traits": { - "smithy.api#documentation": "

The name of the classifier.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A custom symbol to denote what separates each column entry in the row.

" } }, "AllowSingleColumn": { @@ -3182,16 +3347,17 @@ "smithy.api#documentation": "

Enables the processing of files that contain only one column.

" } }, - "Delimiter": { - "target": "com.amazonaws.glue#CsvColumnDelimiter", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A custom symbol to denote what separates each column entry in the row.

" + "smithy.api#documentation": "

The name of the classifier.

", + "smithy.api#required": {} } }, - "Header": { - "target": "com.amazonaws.glue#CsvHeader", + "DisableValueTrimming": { + "target": "com.amazonaws.glue#NullableBoolean", "traits": { - "smithy.api#documentation": "

A list of strings representing column names.

" + "smithy.api#documentation": "

Specifies not to trim values before identifying the type of column values. The default value is true.

" } }, "ContainsHeader": { @@ -3205,6 +3371,12 @@ "traits": { "smithy.api#documentation": "

A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

" } + }, + "Header": { + "target": "com.amazonaws.glue#CsvHeader", + "traits": { + "smithy.api#documentation": "

A list of strings representing column names.

" + } } }, "traits": { @@ -3246,18 +3418,18 @@ "com.amazonaws.glue#CreateDatabaseRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which to create the database. If none is provided, the AWS\n account ID is used by default.

" + } + }, "DatabaseInput": { "target": "com.amazonaws.glue#DatabaseInput", "traits": { "smithy.api#documentation": "

The metadata for the database.

", "smithy.api#required": {} } - }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which to create the database. If none is provided, the AWS\n account ID is used by default.

" - } } } }, @@ -3306,54 +3478,53 @@ "com.amazonaws.glue#CreateDevEndpointRequest": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.glue#GenericString", + "RoleArn": { + "target": "com.amazonaws.glue#RoleArn", "traits": { - "smithy.api#documentation": "

The subnet ID for the new DevEndpoint to use.

" + "smithy.api#documentation": "

The IAM role for the DevEndpoint.

", + "smithy.api#required": {} } }, - "SecurityConfiguration": { - "target": "com.amazonaws.glue#NameString", + "Arguments": { + "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n DevEndpoint.

" + "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

" } }, - "PublicKey": { + "ExtraPythonLibsS3Path": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The public key to be used by this DevEndpoint for authentication. This\n attribute is provided for backward compatibility because the recommended attribute to use is\n public keys.

" + "smithy.api#documentation": "

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in\n your DevEndpoint. Multiple values must be complete paths separated by a\n comma.

\n \n

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on\n C extensions, such as the pandas Python data\n analysis library, are not yet supported.

\n " } }, - "EndpointName": { + "ExtraJarsS3Path": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The name to be assigned to the new DevEndpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The path to one or more Java .jar files in an S3 bucket that should be loaded\n in your DevEndpoint.

" } }, - "PublicKeys": { - "target": "com.amazonaws.glue#PublicKeysList", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

A list of public keys to be used by the development endpoints for authentication. The use\n of this attribute is preferred over a single public key because the public keys allow you to\n have a different private key per client.

\n \n \n

If you previously created an endpoint with a public key, you must remove that key to be able\n to set a list of public keys. Call the UpdateDevEndpoint API with the public\n key content in the deletePublicKeys attribute, and the list of new keys in the\n addPublicKeys attribute.

\n " + "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t

Known issue: when a development endpoint is created with the G.2X \n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" } }, - "RoleArn": { - "target": "com.amazonaws.glue#RoleArn", + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The IAM role for the DevEndpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n\t\n\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, - "NumberOfNodes": { - "target": "com.amazonaws.glue#IntegerValue", + "PublicKeys": { + "target": "com.amazonaws.glue#PublicKeysList", "traits": { - "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) to allocate to this\n DevEndpoint.

" + "smithy.api#documentation": "

A list of public keys to be used by the development endpoints for authentication. The use\n of this attribute is preferred over a single public key because the public keys allow you to\n have a different private key per client.

\n \n \n

If you previously created an endpoint with a public key, you must remove that key to be able\n to set a list of public keys. Call the UpdateDevEndpoint API with the public\n key content in the deletePublicKeys attribute, and the list of new keys in the\n addPublicKeys attribute.

\n " } }, - "SecurityGroupIds": { - "target": "com.amazonaws.glue#StringList", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Security group IDs for the security groups to be used by the new\n DevEndpoint.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, "Tags": { @@ -3362,40 +3533,41 @@ "smithy.api#documentation": "

The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" } }, - "Arguments": { - "target": "com.amazonaws.glue#MapValue", - "traits": { - "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

" + "EndpointName": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The name to be assigned to the new DevEndpoint.

", + "smithy.api#required": {} } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n DevEndpoint.

" } }, - "ExtraPythonLibsS3Path": { + "PublicKey": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in\n your DevEndpoint. Multiple values must be complete paths separated by a\n comma.

\n \n

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on\n C extensions, such as the pandas Python data\n analysis library, are not yet supported.

\n " + "smithy.api#documentation": "

The public key to be used by this DevEndpoint for authentication. This\n attribute is provided for backward compatibility because the recommended attribute to use is\n public keys.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "SecurityGroupIds": { + "target": "com.amazonaws.glue#StringList", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t

Known issue: when a development endpoint is created with the G.2X \n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" + "smithy.api#documentation": "

Security group IDs for the security groups to be used by the new\n DevEndpoint.

" } }, - "ExtraJarsS3Path": { - "target": "com.amazonaws.glue#GenericString", + "NumberOfNodes": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The path to one or more Java .jar files in an S3 bucket that should be loaded\n in your DevEndpoint.

" + "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) to allocate to this\n DevEndpoint.

" } }, - "NumberOfWorkers": { - "target": "com.amazonaws.glue#NullableInteger", + "SubnetId": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n\t\n\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + "smithy.api#documentation": "

The subnet ID for the new DevEndpoint to use.

" } } } @@ -3403,16 +3575,16 @@ "com.amazonaws.glue#CreateDevEndpointResponse": { "type": "structure", "members": { - "AvailabilityZone": { + "VpcId": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Availability Zone where this DevEndpoint is located.

" + "smithy.api#documentation": "

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

" } }, - "NumberOfNodes": { - "target": "com.amazonaws.glue#IntegerValue", + "FailureReason": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

" + "smithy.api#documentation": "

The reason for a current failure in this DevEndpoint.

" } }, "ZeppelinRemoteSparkInterpreterPort": { @@ -3421,58 +3593,52 @@ "smithy.api#documentation": "

The Apache Zeppelin port for the remote Apache Spark interpreter.

" } }, - "FailureReason": { - "target": "com.amazonaws.glue#GenericString", + "Arguments": { + "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The reason for a current failure in this DevEndpoint.

" + "smithy.api#documentation": "

The map of arguments used to configure this DevEndpoint.

\n\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, - "ExtraPythonLibsS3Path": { - "target": "com.amazonaws.glue#GenericString", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The paths to one or more Python libraries in an S3 bucket that will be loaded in your\n DevEndpoint.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.

" } }, - "Status": { + "ExtraPythonLibsS3Path": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The current status of the new DevEndpoint.

" - } - }, - "Arguments": { - "target": "com.amazonaws.glue#MapValue", - "traits": { - "smithy.api#documentation": "

The map of arguments used to configure this DevEndpoint.

\n\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The paths to one or more Python libraries in an S3 bucket that will be loaded in your\n DevEndpoint.

" } }, - "VpcId": { + "SubnetId": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

" + "smithy.api#documentation": "

The subnet ID assigned to the new DevEndpoint.

" } }, - "CreatedTimestamp": { - "target": "com.amazonaws.glue#TimestampValue", + "NumberOfNodes": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The point in time at which this DevEndpoint was created.

" + "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

" } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "SecurityGroupIds": { + "target": "com.amazonaws.glue#StringList", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

" + "smithy.api#documentation": "

The security groups assigned to the new DevEndpoint.

" } }, - "NumberOfWorkers": { - "target": "com.amazonaws.glue#NullableInteger", + "Status": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

" + "smithy.api#documentation": "

The current status of the new DevEndpoint.

" } }, - "ExtraJarsS3Path": { + "YarnEndpointAddress": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

Path to one or more Java .jar files in an S3 bucket that will be loaded in\n your DevEndpoint.

" + "smithy.api#documentation": "

The address of the YARN endpoint used by this DevEndpoint.

" } }, "SecurityConfiguration": { @@ -3481,40 +3647,46 @@ "smithy.api#documentation": "

The name of the SecurityConfiguration structure being used with this\n DevEndpoint.

" } }, - "YarnEndpointAddress": { + "RoleArn": { + "target": "com.amazonaws.glue#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role assigned to the new\n DevEndpoint.

" + } + }, + "EndpointName": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The address of the YARN endpoint used by this DevEndpoint.

" + "smithy.api#documentation": "

The name assigned to the new DevEndpoint.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

" } }, - "EndpointName": { + "AvailabilityZone": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The name assigned to the new DevEndpoint.

" + "smithy.api#documentation": "

The AWS Availability Zone where this DevEndpoint is located.

" } }, - "RoleArn": { - "target": "com.amazonaws.glue#RoleArn", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role assigned to the new\n DevEndpoint.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

" } }, - "SubnetId": { + "ExtraJarsS3Path": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The subnet ID assigned to the new DevEndpoint.

" + "smithy.api#documentation": "

Path to one or more Java .jar files in an S3 bucket that will be loaded in\n your DevEndpoint.

" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.glue#StringList", + "CreatedTimestamp": { + "target": "com.amazonaws.glue#TimestampValue", "traits": { - "smithy.api#documentation": "

The security groups assigned to the new DevEndpoint.

" + "smithy.api#documentation": "

The point in time at which this DevEndpoint was created.

" } } } @@ -3522,12 +3694,6 @@ "com.amazonaws.glue#CreateGrokClassifierRequest": { "type": "structure", "members": { - "CustomPatterns": { - "target": "com.amazonaws.glue#CustomPatterns", - "traits": { - "smithy.api#documentation": "

Optional custom grok patterns used by this classifier.

" - } - }, "Classification": { "target": "com.amazonaws.glue#Classification", "traits": { @@ -3542,6 +3708,12 @@ "smithy.api#required": {} } }, + "CustomPatterns": { + "target": "com.amazonaws.glue#CustomPatterns", + "traits": { + "smithy.api#documentation": "

Optional custom grok patterns used by this classifier.

" + } + }, "GrokPattern": { "target": "com.amazonaws.glue#GrokPattern", "traits": { @@ -3592,16 +3764,10 @@ "com.amazonaws.glue#CreateJobRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.glue#TagsMap", - "traits": { - "smithy.api#documentation": "

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" - } - }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "LogUri": { + "target": "com.amazonaws.glue#UriString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

This field is reserved for future use.

" } }, "NumberOfWorkers": { @@ -3610,10 +3776,10 @@ "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a job runs.

\n\t\n\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, - "Command": { - "target": "com.amazonaws.glue#JobCommand", + "Role": { + "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The JobCommand that executes this job.

", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

", "smithy.api#required": {} } }, @@ -3623,62 +3789,63 @@ "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" } }, - "Role": { - "target": "com.amazonaws.glue#RoleString", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "Command": { + "target": "com.amazonaws.glue#JobCommand", "traits": { - "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The JobCommand that executes this job.

", + "smithy.api#required": {} } }, - "ExecutionProperty": { - "target": "com.amazonaws.glue#ExecutionProperty", + "NotificationProperty": { + "target": "com.amazonaws.glue#NotificationProperty", "traits": { - "smithy.api#documentation": "

An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.

" + "smithy.api#documentation": "

Specifies configuration properties of a job notification.

" } }, - "AllocatedCapacity": { - "target": "com.amazonaws.glue#IntegerValue", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#deprecated": { - "message": "This property is deprecated, use MaxCapacity instead." - }, - "smithy.api#documentation": "

This parameter is deprecated. Use MaxCapacity instead.

\n\t\n

The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

" + "smithy.api#documentation": "

The name you assign to this job definition. It must be unique in your account.

", + "smithy.api#required": {} } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\t\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n " } }, - "MaxRetries": { - "target": "com.amazonaws.glue#MaxRetries", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

The maximum number of times to retry this job if it fails.

" + "smithy.api#documentation": "

Description of the job being defined.

" } }, - "LogUri": { - "target": "com.amazonaws.glue#UriString", + "Connections": { + "target": "com.amazonaws.glue#ConnectionsList", "traits": { - "smithy.api#documentation": "

This field is reserved for future use.

" + "smithy.api#documentation": "

The connections used for this job.

" } }, - "SecurityConfiguration": { - "target": "com.amazonaws.glue#NameString", + "AllocatedCapacity": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n job.

" + "smithy.api#deprecated": { + "message": "This property is deprecated, use MaxCapacity instead." + }, + "smithy.api#documentation": "

This parameter is deprecated. Use MaxCapacity instead.

\n\t\n

The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

" } }, - "Connections": { - "target": "com.amazonaws.glue#ConnectionsList", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The connections used for this job.

" + "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" } }, "NonOverridableArguments": { @@ -3687,29 +3854,34 @@ "smithy.api#documentation": "

Non-overridable arguments for this job, specified as name-value pairs.

" } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", + "MaxRetries": { + "target": "com.amazonaws.glue#MaxRetries", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\t\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n " + "smithy.api#documentation": "

The maximum number of times to retry this job if it fails.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "ExecutionProperty": { + "target": "com.amazonaws.glue#ExecutionProperty", "traits": { - "smithy.api#documentation": "

Description of the job being defined.

" + "smithy.api#documentation": "

An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.

" } }, - "Name": { + "SecurityConfiguration": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name you assign to this job definition. It must be unique in your account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n job.

" } }, - "NotificationProperty": { - "target": "com.amazonaws.glue#NotificationProperty", + "Tags": { + "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

Specifies configuration properties of a job notification.

" + "smithy.api#documentation": "

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + } + }, + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", + "traits": { + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " } } } @@ -3785,23 +3957,23 @@ "com.amazonaws.glue#CreateMLTransformRequest": { "type": "structure", "members": { - "MaxRetries": { - "target": "com.amazonaws.glue#NullableInteger", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The maximum number of times to retry a task for this transform after a task run fails.

" + "smithy.api#documentation": "

The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" } }, - "Role": { - "target": "com.amazonaws.glue#RoleString", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t ", + "smithy.api#documentation": "

The unique name that you give the transform when you create it.

", "smithy.api#required": {} } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n\t\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

\t \n \n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "Description": { @@ -3810,10 +3982,10 @@ "smithy.api#documentation": "

A description of the machine learning transform that is being defined. The default is an\n empty string.

" } }, - "Parameters": { - "target": "com.amazonaws.glue#TransformParameters", + "Role": { + "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The algorithmic parameters that are specific to the transform type used. Conditionally\n dependent on the transform type.

", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t ", "smithy.api#required": {} } }, @@ -3823,6 +3995,12 @@ "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when this task runs.

\n\t\n\t\t

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

" } }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + } + }, "InputRecordTables": { "target": "com.amazonaws.glue#GlueTables", "traits": { @@ -3830,29 +4008,17 @@ "smithy.api#required": {} } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", - "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n\t\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

\t \n \n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" - } - }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", - "traits": { - "smithy.api#documentation": "

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" - } - }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "Parameters": { + "target": "com.amazonaws.glue#TransformParameters", "traits": { - "smithy.api#documentation": "

The unique name that you give the transform when you create it.

", + "smithy.api#documentation": "

The algorithmic parameters that are specific to the transform type used. Conditionally\n dependent on the transform type.

", "smithy.api#required": {} } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " } }, "GlueVersion": { @@ -3860,6 +4026,12 @@ "traits": { "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" } + }, + "MaxRetries": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of times to retry a task for this transform after a task run fails.

" + } } } }, @@ -3912,13 +4084,6 @@ "com.amazonaws.glue#CreatePartitionRequest": { "type": "structure", "members": { - "TableName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the metadata table in which the partition is to be created.

", - "smithy.api#required": {} - } - }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -3926,10 +4091,11 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The AWS account ID of the catalog in which the partition is to be created.

" + "smithy.api#documentation": "

The name of the metadata table in which the partition is to be created.

", + "smithy.api#required": {} } }, "PartitionInput": { @@ -3938,6 +4104,12 @@ "smithy.api#documentation": "

A PartitionInput structure defining the partition\n to be created.

", "smithy.api#required": {} } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The AWS account ID of the catalog in which the partition is to be created.

" + } } } }, @@ -3977,34 +4149,34 @@ "smithy.api#documentation": "

A list of the nodes in the DAG.

" } }, - "Language": { - "target": "com.amazonaws.glue#Language", - "traits": { - "smithy.api#documentation": "

The programming language of the resulting code from the DAG.

" - } - }, "DagEdges": { "target": "com.amazonaws.glue#DagEdges", "traits": { "smithy.api#documentation": "

A list of the edges in the DAG.

" } + }, + "Language": { + "target": "com.amazonaws.glue#Language", + "traits": { + "smithy.api#documentation": "

The programming language of the resulting code from the DAG.

" + } } } }, "com.amazonaws.glue#CreateScriptResponse": { "type": "structure", "members": { - "ScalaCode": { - "target": "com.amazonaws.glue#ScalaCode", - "traits": { - "smithy.api#documentation": "

The Scala code generated from the DAG.

" - } - }, "PythonScript": { "target": "com.amazonaws.glue#PythonScript", "traits": { "smithy.api#documentation": "

The Python script generated from the DAG.

" } + }, + "ScalaCode": { + "target": "com.amazonaws.glue#ScalaCode", + "traits": { + "smithy.api#documentation": "

The Scala code generated from the DAG.

" + } } } }, @@ -4040,17 +4212,17 @@ "com.amazonaws.glue#CreateSecurityConfigurationRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", + "EncryptionConfiguration": { + "target": "com.amazonaws.glue#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The name for the new security configuration.

", + "smithy.api#documentation": "

The encryption configuration for the new security configuration.

", "smithy.api#required": {} } }, - "EncryptionConfiguration": { - "target": "com.amazonaws.glue#EncryptionConfiguration", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The encryption configuration for the new security configuration.

", + "smithy.api#documentation": "

The name for the new security configuration.

", "smithy.api#required": {} } } @@ -4059,17 +4231,17 @@ "com.amazonaws.glue#CreateSecurityConfigurationResponse": { "type": "structure", "members": { - "CreatedTimestamp": { - "target": "com.amazonaws.glue#TimestampValue", - "traits": { - "smithy.api#documentation": "

The time at which the new security configuration was created.

" - } - }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name assigned to the new security configuration.

" } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The time at which the new security configuration was created.

" + } } } }, @@ -4111,12 +4283,6 @@ "com.amazonaws.glue#CreateTableRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which to create the Table.\n If none is supplied, the AWS account ID is used by default.

" - } - }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -4124,12 +4290,24 @@ "smithy.api#required": {} } }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which to create the Table.\n If none is supplied, the AWS account ID is used by default.

" + } + }, "TableInput": { "target": "com.amazonaws.glue#TableInput", "traits": { "smithy.api#documentation": "

The TableInput object that defines the metadata table\n to create in the catalog.

", "smithy.api#required": {} } + }, + "PartitionIndexes": { + "target": "com.amazonaws.glue#PartitionIndexList", + "traits": { + "smithy.api#documentation": "

A list of partition indexes, PartitionIndex structures, to create in the table.

" + } } } }, @@ -4178,16 +4356,11 @@ "com.amazonaws.glue#CreateTriggerRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.glue#DescriptionString", - "traits": { - "smithy.api#documentation": "

A description of the new trigger.

" - } - }, - "StartOnCreation": { - "target": "com.amazonaws.glue#BooleanValue", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Set to true to start SCHEDULED and CONDITIONAL\n triggers when created. True is not supported for ON_DEMAND triggers.

" + "smithy.api#documentation": "

The name of the trigger.

", + "smithy.api#required": {} } }, "Schedule": { @@ -4196,10 +4369,11 @@ "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

\n

This field is required when the trigger type is SCHEDULED.

" } }, - "WorkflowName": { - "target": "com.amazonaws.glue#NameString", + "Type": { + "target": "com.amazonaws.glue#TriggerType", "traits": { - "smithy.api#documentation": "

The name of the workflow associated with the trigger.

" + "smithy.api#documentation": "

The type of the new trigger.

", + "smithy.api#required": {} } }, "Actions": { @@ -4209,24 +4383,22 @@ "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.glue#TriggerType", + "StartOnCreation": { + "target": "com.amazonaws.glue#BooleanValue", "traits": { - "smithy.api#documentation": "

The type of the new trigger.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Set to true to start SCHEDULED and CONDITIONAL\n triggers when created. True is not supported for ON_DEMAND triggers.

" } }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", + "WorkflowName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The tags to use with this trigger. You may use tags to limit access to the trigger.\n For more information about tags in AWS Glue, see\n AWS Tags in AWS\n Glue in the developer guide.

" + "smithy.api#documentation": "

The name of the workflow associated with the trigger.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "Tags": { + "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The name of the trigger.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to use with this trigger. You may use tags to limit access to the trigger.\n For more information about tags in AWS Glue, see\n AWS Tags in AWS\n Glue in the developer guide.

" } }, "Predicate": { @@ -4234,6 +4406,12 @@ "traits": { "smithy.api#documentation": "

A predicate to specify when the new trigger should fire.

\n

This field is required when the trigger type is CONDITIONAL.

" } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the new trigger.

" + } } } }, @@ -4286,17 +4464,17 @@ "com.amazonaws.glue#CreateUserDefinedFunctionRequest": { "type": "structure", "members": { - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", + "FunctionInput": { + "target": "com.amazonaws.glue#UserDefinedFunctionInput", "traits": { - "smithy.api#documentation": "

The name of the catalog database in which to create the function.

", + "smithy.api#documentation": "

A FunctionInput object that defines the function\n to create in the Data Catalog.

", "smithy.api#required": {} } }, - "FunctionInput": { - "target": "com.amazonaws.glue#UserDefinedFunctionInput", + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A FunctionInput object that defines the function\n to create in the Data Catalog.

", + "smithy.api#documentation": "

The name of the catalog database in which to create the function.

", "smithy.api#required": {} } }, @@ -4347,6 +4525,12 @@ "com.amazonaws.glue#CreateWorkflowRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A description of the workflow.

" + } + }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -4354,16 +4538,10 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", - "traits": { - "smithy.api#documentation": "

The tags to be used with this workflow.

" - } - }, - "Description": { - "target": "com.amazonaws.glue#GenericString", + "MaxConcurrentRuns": { + "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

A description of the workflow.

" + "smithy.api#documentation": "

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

" } }, "DefaultRunProperties": { @@ -4371,6 +4549,12 @@ "traits": { "smithy.api#documentation": "

A collection of properties to be used as part of each execution of the workflow.

" } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags to be used with this workflow.

" + } } } }, @@ -4388,11 +4572,10 @@ "com.amazonaws.glue#CreateXMLClassifierRequest": { "type": "structure", "members": { - "Classification": { - "target": "com.amazonaws.glue#Classification", + "RowTag": { + "target": "com.amazonaws.glue#RowTag", "traits": { - "smithy.api#documentation": "

An identifier of the data format that the classifier matches.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The XML tag designating the element that contains each record in an XML document being\n parsed. This can't identify a self-closing element (closed by />). An empty\n row element that contains only attributes can be parsed as long as it ends with a closing tag\n (for example, is okay, but\n is not).

" } }, "Name": { @@ -4402,10 +4585,11 @@ "smithy.api#required": {} } }, - "RowTag": { - "target": "com.amazonaws.glue#RowTag", + "Classification": { + "target": "com.amazonaws.glue#Classification", "traits": { - "smithy.api#documentation": "

The XML tag designating the element that contains each record in an XML document being\n parsed. This can't identify a self-closing element (closed by />). An empty\n row element that contains only attributes can be parsed as long as it ends with a closing tag\n (for example, is okay, but\n is not).

" + "smithy.api#documentation": "

An identifier of the data format that the classifier matches.

", + "smithy.api#required": {} } } }, @@ -4419,10 +4603,28 @@ "com.amazonaws.glue#CsvClassifier": { "type": "structure", "members": { - "CreationTime": { + "Delimiter": { + "target": "com.amazonaws.glue#CsvColumnDelimiter", + "traits": { + "smithy.api#documentation": "

A custom symbol to denote what separates each column entry in the row.

" + } + }, + "AllowSingleColumn": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Enables the processing of files that contain only one column.

" + } + }, + "LastUpdated": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The time that this classifier was registered.

" + "smithy.api#documentation": "

The time that this classifier was last updated.

" + } + }, + "QuoteSymbol": { + "target": "com.amazonaws.glue#CsvQuoteSymbol", + "traits": { + "smithy.api#documentation": "

A custom symbol to denote what combines content into a single column value. It must be\n different from the column delimiter.

" } }, "Version": { @@ -4437,34 +4639,22 @@ "smithy.api#documentation": "

Specifies not to trim values before identifying the type of column values. The default\n value is true.

" } }, - "ContainsHeader": { - "target": "com.amazonaws.glue#CsvHeaderOption", - "traits": { - "smithy.api#documentation": "

Indicates whether the CSV file contains a header.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.glue#CsvColumnDelimiter", - "traits": { - "smithy.api#documentation": "

A custom symbol to denote what separates each column entry in the row.

" - } - }, - "AllowSingleColumn": { - "target": "com.amazonaws.glue#NullableBoolean", + "Header": { + "target": "com.amazonaws.glue#CsvHeader", "traits": { - "smithy.api#documentation": "

Enables the processing of files that contain only one column.

" + "smithy.api#documentation": "

A list of strings representing column names.

" } }, - "QuoteSymbol": { - "target": "com.amazonaws.glue#CsvQuoteSymbol", + "ContainsHeader": { + "target": "com.amazonaws.glue#CsvHeaderOption", "traits": { - "smithy.api#documentation": "

A custom symbol to denote what combines content into a single column value. It must be\n different from the column delimiter.

" + "smithy.api#documentation": "

Indicates whether the CSV file contains a header.

" } }, - "Header": { - "target": "com.amazonaws.glue#CsvHeader", + "CreationTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

A list of strings representing column names.

" + "smithy.api#documentation": "

The time that this classifier was registered.

" } }, "Name": { @@ -4473,12 +4663,6 @@ "smithy.api#documentation": "

The name of the classifier.

", "smithy.api#required": {} } - }, - "LastUpdated": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this classifier was last updated.

" - } } }, "traits": { @@ -4555,17 +4739,17 @@ "com.amazonaws.glue#DataCatalogEncryptionSettings": { "type": "structure", "members": { - "EncryptionAtRest": { - "target": "com.amazonaws.glue#EncryptionAtRest", - "traits": { - "smithy.api#documentation": "

Specifies the encryption-at-rest configuration for the Data Catalog.

" - } - }, "ConnectionPasswordEncryption": { "target": "com.amazonaws.glue#ConnectionPasswordEncryption", "traits": { "smithy.api#documentation": "

When connection password protection is enabled, the Data Catalog uses a customer-provided\n key to encrypt the password as part of CreateConnection or\n UpdateConnection and store it in the ENCRYPTED_PASSWORD field in\n the connection properties. You can enable catalog encryption or only password\n encryption.

" } + }, + "EncryptionAtRest": { + "target": "com.amazonaws.glue#EncryptionAtRest", + "traits": { + "smithy.api#documentation": "

Specifies the encryption-at-rest configuration for the Data Catalog.

" + } } }, "traits": { @@ -4598,23 +4782,22 @@ "com.amazonaws.glue#Database": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", + "LocationUri": { + "target": "com.amazonaws.glue#URI", "traits": { - "smithy.api#documentation": "

The name of the database. For Hive compatibility, this is folded to lowercase when it is\n stored.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The location of the database (for example, an HDFS path).

" } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "TargetDatabase": { + "target": "com.amazonaws.glue#DatabaseIdentifier", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides.

" + "smithy.api#documentation": "

A DatabaseIdentifier structure that describes a target database for resource linking.

" } }, - "LocationUri": { - "target": "com.amazonaws.glue#URI", + "Parameters": { + "target": "com.amazonaws.glue#ParametersMap", "traits": { - "smithy.api#documentation": "

The location of the database (for example, an HDFS path).

" + "smithy.api#documentation": "

These key-value pairs define parameters and properties\n of the database.

" } }, "CreateTime": { @@ -4623,16 +4806,16 @@ "smithy.api#documentation": "

The time at which the metadata database was created in the catalog.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

A description of the database.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides.

" } }, - "Parameters": { - "target": "com.amazonaws.glue#ParametersMap", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

These key-value pairs define parameters and properties\n of the database.

" + "smithy.api#documentation": "

A description of the database.

" } }, "CreateTableDefaultPermissions": { @@ -4641,10 +4824,11 @@ "smithy.api#documentation": "

Creates a set of default permissions on the table for principals.

" } }, - "TargetDatabase": { - "target": "com.amazonaws.glue#DatabaseIdentifier", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A DatabaseIdentifier structure that describes a target database for resource linking.

" + "smithy.api#documentation": "

The name of the database. For Hive compatibility, this is folded to lowercase when it is\n stored.

", + "smithy.api#required": {} } } }, @@ -4655,17 +4839,17 @@ "com.amazonaws.glue#DatabaseIdentifier": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides.

" - } - }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the catalog database.

" } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides.

" + } } }, "traits": { @@ -4675,22 +4859,10 @@ "com.amazonaws.glue#DatabaseInput": { "type": "structure", "members": { - "TargetDatabase": { - "target": "com.amazonaws.glue#DatabaseIdentifier", - "traits": { - "smithy.api#documentation": "

A DatabaseIdentifier structure that describes a target database for resource linking.

" - } - }, - "CreateTableDefaultPermissions": { - "target": "com.amazonaws.glue#PrincipalPermissionsList", - "traits": { - "smithy.api#documentation": "

Creates a set of default permissions on the table for principals.

" - } - }, - "LocationUri": { - "target": "com.amazonaws.glue#URI", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

The location of the database (for example, an HDFS path).

" + "smithy.api#documentation": "

A description of the database.

" } }, "Parameters": { @@ -4699,10 +4871,10 @@ "smithy.api#documentation": "

These key-value pairs define parameters and properties\n of the database.

\n

These key-value pairs define parameters and properties of the database.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "TargetDatabase": { + "target": "com.amazonaws.glue#DatabaseIdentifier", "traits": { - "smithy.api#documentation": "

A description of the database.

" + "smithy.api#documentation": "

A DatabaseIdentifier structure that describes a target database for resource linking.

" } }, "Name": { @@ -4711,6 +4883,18 @@ "smithy.api#documentation": "

The name of the database. For Hive compatibility, this is folded to lowercase when it is\n stored.

", "smithy.api#required": {} } + }, + "CreateTableDefaultPermissions": { + "target": "com.amazonaws.glue#PrincipalPermissionsList", + "traits": { + "smithy.api#documentation": "

Creates a set of default permissions on the table for principals.

" + } + }, + "LocationUri": { + "target": "com.amazonaws.glue#URI", + "traits": { + "smithy.api#documentation": "

The location of the database (for example, an HDFS path).

" + } } }, "traits": { @@ -4736,13 +4920,6 @@ "smithy.api#required": {} } }, - "NumberOfNulls": { - "target": "com.amazonaws.glue#NonNegativeLong", - "traits": { - "smithy.api#documentation": "

Number of nulls.

", - "smithy.api#required": {} - } - }, "MinimumValue": { "target": "com.amazonaws.glue#Timestamp", "traits": { @@ -4754,6 +4931,13 @@ "traits": { "smithy.api#documentation": "

Maximum value of the column.

" } + }, + "NumberOfNulls": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "

Number of nulls.

", + "smithy.api#required": {} + } } }, "traits": { @@ -4763,29 +4947,29 @@ "com.amazonaws.glue#DecimalColumnStatisticsData": { "type": "structure", "members": { + "MaximumValue": { + "target": "com.amazonaws.glue#DecimalNumber", + "traits": { + "smithy.api#documentation": "

Maximum value of the column.

" + } + }, "MinimumValue": { "target": "com.amazonaws.glue#DecimalNumber", "traits": { "smithy.api#documentation": "

Minimum value of the column.

" } }, - "NumberOfDistinctValues": { + "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { - "smithy.api#documentation": "

Number of distinct values.

", + "smithy.api#documentation": "

Number of nulls.

", "smithy.api#required": {} } }, - "MaximumValue": { - "target": "com.amazonaws.glue#DecimalNumber", - "traits": { - "smithy.api#documentation": "

Maximum value of the column.

" - } - }, - "NumberOfNulls": { + "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { - "smithy.api#documentation": "

Number of nulls.

", + "smithy.api#documentation": "

Number of distinct values.

", "smithy.api#required": {} } } @@ -4903,17 +5087,10 @@ "com.amazonaws.glue#DeleteColumnStatisticsForPartitionRequest": { "type": "structure", "members": { - "TableName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the partitions' table.

", - "smithy.api#required": {} - } - }, - "ColumnName": { - "target": "com.amazonaws.glue#NameString", + "PartitionValues": { + "target": "com.amazonaws.glue#ValueStringList", "traits": { - "smithy.api#documentation": "

Name of the column.

", + "smithy.api#documentation": "

A list of partition values identifying the partition.

", "smithy.api#required": {} } }, @@ -4930,10 +5107,17 @@ "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" } }, - "PartitionValues": { - "target": "com.amazonaws.glue#ValueStringList", + "ColumnName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A list of partition values identifying the partition.

", + "smithy.api#documentation": "

Name of the column.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the partitions' table.

", "smithy.api#required": {} } } @@ -4975,6 +5159,12 @@ "com.amazonaws.glue#DeleteColumnStatisticsForTableRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + } + }, "TableName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -4989,12 +5179,6 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" - } - }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -5043,18 +5227,18 @@ "com.amazonaws.glue#DeleteConnectionRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" + } + }, "ConnectionName": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the connection to delete.

", "smithy.api#required": {} } - }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" - } } } }, @@ -5318,11 +5502,10 @@ "com.amazonaws.glue#DeletePartitionRequest": { "type": "structure", "members": { - "TableName": { - "target": "com.amazonaws.glue#NameString", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The name of the table that contains the partition to be deleted.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be deleted resides. If none is provided,\n the AWS account ID is used by default.

" } }, "PartitionValues": { @@ -5339,10 +5522,11 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be deleted resides. If none is provided,\n the AWS account ID is used by default.

" + "smithy.api#documentation": "

The name of the table that contains the partition to be deleted.

", + "smithy.api#required": {} } } } @@ -5383,17 +5567,17 @@ "com.amazonaws.glue#DeleteResourcePolicyRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.glue#GlueResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the AWS Glue resource for the resource policy to be deleted.

" - } - }, "PolicyHashCondition": { "target": "com.amazonaws.glue#HashString", "traits": { "smithy.api#documentation": "

The hash value returned when this policy was set.

" } + }, + "ResourceArn": { + "target": "com.amazonaws.glue#GlueResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS Glue resource for the resource policy to be deleted.

" + } } } }, @@ -5540,17 +5724,17 @@ "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" } }, - "VersionId": { - "target": "com.amazonaws.glue#VersionString", + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.

", + "smithy.api#documentation": "

The database in the catalog in which the table resides. For Hive\n compatibility, this name is entirely lowercase.

", "smithy.api#required": {} } }, - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", + "VersionId": { + "target": "com.amazonaws.glue#VersionString", "traits": { - "smithy.api#documentation": "

The database in the catalog in which the table resides. For Hive\n compatibility, this name is entirely lowercase.

", + "smithy.api#documentation": "

The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.

", "smithy.api#required": {} } } @@ -5638,12 +5822,6 @@ "com.amazonaws.glue#DeleteUserDefinedFunctionRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the function to be deleted is\n located. If none is supplied, the AWS account ID is used by default.

" - } - }, "FunctionName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -5657,6 +5835,12 @@ "smithy.api#documentation": "

The name of the catalog database where the function is located.

", "smithy.api#required": {} } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog where the function to be deleted is\n located. If none is supplied, the AWS account ID is used by default.

" + } } } }, @@ -5736,10 +5920,22 @@ "com.amazonaws.glue#DevEndpoint": { "type": "structure", "members": { - "PublicKey": { + "RoleArn": { + "target": "com.amazonaws.glue#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used in this\n DevEndpoint.

" + } + }, + "YarnEndpointAddress": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The public key to be used by this DevEndpoint for authentication. This\n attribute is provided for backward compatibility because the recommended attribute to use is\n public keys.

" + "smithy.api#documentation": "

The YARN endpoint address used by this DevEndpoint.

" + } + }, + "ExtraJarsS3Path": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The path to one or more Java .jar files in an S3 bucket that should be loaded\n in your DevEndpoint.

\n \n

You can only use pure Java/Scala libraries with a DevEndpoint.

\n " } }, "SecurityGroupIds": { @@ -5760,58 +5956,64 @@ "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n DevEndpoint.

" } }, - "YarnEndpointAddress": { + "ExtraPythonLibsS3Path": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The YARN endpoint address used by this DevEndpoint.

" + "smithy.api#documentation": "

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in\n your DevEndpoint. Multiple values must be complete paths separated by a\n comma.

\n \n \n

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on\n C extensions, such as the pandas Python data\n analysis library, are not currently supported.

\n " } }, - "ExtraJarsS3Path": { + "PublicKey": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The path to one or more Java .jar files in an S3 bucket that should be loaded\n in your DevEndpoint.

\n \n

You can only use pure Java/Scala libraries with a DevEndpoint.

\n " + "smithy.api#documentation": "

The public key to be used by this DevEndpoint for authentication. This\n attribute is provided for backward compatibility because the recommended attribute to use is\n public keys.

" } }, - "NumberOfNodes": { - "target": "com.amazonaws.glue#IntegerValue", + "FailureReason": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) allocated to this\n DevEndpoint.

" + "smithy.api#documentation": "

The reason for a current failure in this DevEndpoint.

" } }, - "AvailabilityZone": { + "Status": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Availability Zone where this DevEndpoint is located.

" + "smithy.api#documentation": "

The current status of this DevEndpoint.

" } }, - "ExtraPythonLibsS3Path": { - "target": "com.amazonaws.glue#GenericString", + "PublicKeys": { + "target": "com.amazonaws.glue#PublicKeysList", "traits": { - "smithy.api#documentation": "

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in\n your DevEndpoint. Multiple values must be complete paths separated by a\n comma.

\n \n \n

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on\n C extensions, such as the pandas Python data\n analysis library, are not currently supported.

\n " + "smithy.api#documentation": "

A list of public keys to be used by the DevEndpoints for authentication.\n Using this attribute is preferred over a single public key because the public keys allow you\n to have a different private key per client.

\n \n

If you previously created an endpoint with a public key, you must remove that key to be\n able to set a list of public keys. Call the UpdateDevEndpoint API operation\n with the public key content in the deletePublicKeys attribute, and the list of\n new keys in the addPublicKeys attribute.

\n " } }, - "RoleArn": { - "target": "com.amazonaws.glue#RoleArn", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used in this\n DevEndpoint.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, - "ZeppelinRemoteSparkInterpreterPort": { - "target": "com.amazonaws.glue#IntegerValue", + "AvailabilityZone": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The Apache Zeppelin port for the remote Apache Spark interpreter.

" + "smithy.api#documentation": "

The AWS Availability Zone where this DevEndpoint is located.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "EndpointName": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

Known issue: when a development endpoint is created with the G.2X \n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" + "smithy.api#documentation": "

The name of the DevEndpoint.

" } }, - "PublicAddress": { + "VpcId": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The public IP address used by this DevEndpoint. The\n PublicAddress field is present only when you create a non-virtual private cloud\n (VPC) DevEndpoint.

" + "smithy.api#documentation": "

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The point in time at which this DevEndpoint was created.

" } }, "LastUpdateStatus": { @@ -5826,46 +6028,34 @@ "smithy.api#documentation": "

The subnet ID for this DevEndpoint.

" } }, - "PublicKeys": { - "target": "com.amazonaws.glue#PublicKeysList", - "traits": { - "smithy.api#documentation": "

A list of public keys to be used by the DevEndpoints for authentication.\n Using this attribute is preferred over a single public key because the public keys allow you\n to have a different private key per client.

\n \n

If you previously created an endpoint with a public key, you must remove that key to be\n able to set a list of public keys. Call the UpdateDevEndpoint API operation\n with the public key content in the deletePublicKeys attribute, and the list of\n new keys in the addPublicKeys attribute.

\n " - } - }, - "NumberOfWorkers": { - "target": "com.amazonaws.glue#NullableInteger", - "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n\t\n\t\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.glue#TimestampValue", + "PublicAddress": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The point in time at which this DevEndpoint was created.

" + "smithy.api#documentation": "

The public IP address used by this DevEndpoint. The\n PublicAddress field is present only when you create a non-virtual private cloud\n (VPC) DevEndpoint.

" } }, - "VpcId": { - "target": "com.amazonaws.glue#GenericString", + "NumberOfNodes": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

" + "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) allocated to this\n DevEndpoint.

" } }, - "EndpointName": { - "target": "com.amazonaws.glue#GenericString", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The name of the DevEndpoint.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

Known issue: when a development endpoint is created with the G.2X \n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "ZeppelinRemoteSparkInterpreterPort": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The Apache Zeppelin port for the remote Apache Spark interpreter.

" } }, - "Arguments": { - "target": "com.amazonaws.glue#MapValue", + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

\n

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n\t\n\t\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, "LastModifiedTimestamp": { @@ -5874,16 +6064,10 @@ "smithy.api#documentation": "

The point in time at which this DevEndpoint was last modified.

" } }, - "Status": { - "target": "com.amazonaws.glue#GenericString", - "traits": { - "smithy.api#documentation": "

The current status of this DevEndpoint.

" - } - }, - "FailureReason": { - "target": "com.amazonaws.glue#GenericString", + "Arguments": { + "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The reason for a current failure in this DevEndpoint.

" + "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

\n

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } } }, @@ -5941,12 +6125,6 @@ "com.amazonaws.glue#DoubleColumnStatisticsData": { "type": "structure", "members": { - "MinimumValue": { - "target": "com.amazonaws.glue#Double", - "traits": { - "smithy.api#documentation": "

Minimum value of the column.

" - } - }, "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { @@ -5966,6 +6144,12 @@ "traits": { "smithy.api#documentation": "

Maximum value of the column.

" } + }, + "MinimumValue": { + "target": "com.amazonaws.glue#Double", + "traits": { + "smithy.api#documentation": "

Minimum value of the column.

" + } } }, "traits": { @@ -5981,17 +6165,17 @@ "smithy.api#documentation": "

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

\n\t\n\t

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

" } }, - "scanRate": { - "target": "com.amazonaws.glue#NullableDouble", - "traits": { - "smithy.api#documentation": "

The percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

\n\t\n\t

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

" - } - }, "Path": { "target": "com.amazonaws.glue#Path", "traits": { "smithy.api#documentation": "

The name of the DynamoDB table to crawl.

" } + }, + "scanRate": { + "target": "com.amazonaws.glue#NullableDouble", + "traits": { + "smithy.api#documentation": "

The percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

\n\t\n\t

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

" + } } }, "traits": { @@ -6048,18 +6232,18 @@ "com.amazonaws.glue#EncryptionAtRest": { "type": "structure", "members": { - "SseAwsKmsKeyId": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The ID of the AWS KMS key to use for encryption at rest.

" - } - }, "CatalogEncryptionMode": { "target": "com.amazonaws.glue#CatalogEncryptionMode", "traits": { "smithy.api#documentation": "

The encryption-at-rest mode for encrypting Data Catalog data.

", "smithy.api#required": {} } + }, + "SseAwsKmsKeyId": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The ID of the AWS KMS key to use for encryption at rest.

" + } } }, "traits": { @@ -6069,12 +6253,6 @@ "com.amazonaws.glue#EncryptionConfiguration": { "type": "structure", "members": { - "S3Encryption": { - "target": "com.amazonaws.glue#S3EncryptionList", - "traits": { - "smithy.api#documentation": "

The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.

" - } - }, "CloudWatchEncryption": { "target": "com.amazonaws.glue#CloudWatchEncryption", "traits": { @@ -6086,6 +6264,12 @@ "traits": { "smithy.api#documentation": "

The encryption configuration for job bookmarks.

" } + }, + "S3Encryption": { + "target": "com.amazonaws.glue#S3EncryptionList", + "traits": { + "smithy.api#documentation": "

The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.

" + } } }, "traits": { @@ -6119,17 +6303,17 @@ "com.amazonaws.glue#ErrorDetail": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The code associated with this error.

" - } - }, "ErrorMessage": { "target": "com.amazonaws.glue#DescriptionString", "traits": { "smithy.api#documentation": "

A message describing the error.

" } + }, + "ErrorCode": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The code associated with this error.

" + } } }, "traits": { @@ -6226,22 +6410,22 @@ "com.amazonaws.glue#FindMatchesMetrics": { "type": "structure", "members": { - "ConfusionMatrix": { - "target": "com.amazonaws.glue#ConfusionMatrix", + "AreaUnderPRCurve": { + "target": "com.amazonaws.glue#GenericBoundedDouble", "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.

" + "smithy.api#documentation": "

The area under the precision/recall curve (AUPRC) is a single number measuring the overall\n quality of the transform, that is independent of the choice made for precision vs. recall.\n Higher values indicate that you have a more attractive precision vs. recall tradeoff.

\n\t

For more information, see Precision and recall in Wikipedia.

" } }, - "Precision": { + "Recall": { "target": "com.amazonaws.glue#GenericBoundedDouble", "traits": { - "smithy.api#documentation": "

The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.

\n

For more information, see Precision and recall in Wikipedia.

" + "smithy.api#documentation": "

The recall metric indicates that for an actual match, how often your transform predicts\n the match. Specifically, it measures how well the transform finds true positives from the\n total records in the source data.

\n

For more information, see Precision and recall in Wikipedia.

" } }, - "AreaUnderPRCurve": { + "Precision": { "target": "com.amazonaws.glue#GenericBoundedDouble", "traits": { - "smithy.api#documentation": "

The area under the precision/recall curve (AUPRC) is a single number measuring the overall\n quality of the transform, that is independent of the choice made for precision vs. recall.\n Higher values indicate that you have a more attractive precision vs. recall tradeoff.

\n\t

For more information, see Precision and recall in Wikipedia.

" + "smithy.api#documentation": "

The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.

\n

For more information, see Precision and recall in Wikipedia.

" } }, "F1": { @@ -6250,10 +6434,10 @@ "smithy.api#documentation": "

The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.

\n

For more information, see F1 score in Wikipedia.

" } }, - "Recall": { - "target": "com.amazonaws.glue#GenericBoundedDouble", + "ConfusionMatrix": { + "target": "com.amazonaws.glue#ConfusionMatrix", "traits": { - "smithy.api#documentation": "

The recall metric indicates that for an actual match, how often your transform predicts\n the match. Specifically, it measures how well the transform finds true positives from the\n total records in the source data.

\n

For more information, see Precision and recall in Wikipedia.

" + "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.

" } } }, @@ -6270,10 +6454,10 @@ "smithy.api#documentation": "

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

" } }, - "EnforceProvidedLabels": { - "target": "com.amazonaws.glue#NullableBoolean", + "PrecisionRecallTradeoff": { + "target": "com.amazonaws.glue#GenericBoundedDouble", "traits": { - "smithy.api#documentation": "

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.

\n

Note that setting this value to true may increase the conflation execution time.

" + "smithy.api#documentation": "

The value selected when tuning your transform for a balance between precision and recall.\n A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a\n value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0\n means very low recall, and choosing values close to 0.0 results in very low precision.

\n\t\n\t

The precision metric indicates how often your model is correct when it predicts a match.

\n\t\n\t

The recall metric indicates that for an actual match, how often your model predicts the\n match.

" } }, "AccuracyCostTradeoff": { @@ -6282,10 +6466,10 @@ "smithy.api#documentation": "

The value that is selected when tuning your transform for a balance between accuracy and\n cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0\n means a bias purely for accuracy, which typically results in a higher cost, sometimes\n substantially higher. A value of 0.0 means a bias purely for cost, which results in a less\n accurate FindMatches transform, sometimes with unacceptable accuracy.

\n\t\n\t

Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.

\n\t\n\t

Cost measures how many compute resources, and thus money, are consumed to run the\n transform.

" } }, - "PrecisionRecallTradeoff": { - "target": "com.amazonaws.glue#GenericBoundedDouble", + "EnforceProvidedLabels": { + "target": "com.amazonaws.glue#NullableBoolean", "traits": { - "smithy.api#documentation": "

The value selected when tuning your transform for a balance between precision and recall.\n A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a\n value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0\n means very low recall, and choosing values close to 0.0 results in very low precision.

\n\t\n\t

The precision metric indicates how often your model is correct when it predicts a match.

\n\t\n\t

The recall metric indicates that for an actual match, how often your model predicts the\n match.

" + "smithy.api#documentation": "

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.

\n

Note that setting this value to true may increase the conflation execution time.

" } } }, @@ -6296,12 +6480,6 @@ "com.amazonaws.glue#FindMatchesTaskRunProperties": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.glue#HashString", - "traits": { - "smithy.api#documentation": "

The job ID for the Find Matches task run.

" - } - }, "JobRunId": { "target": "com.amazonaws.glue#HashString", "traits": { @@ -6313,6 +6491,12 @@ "traits": { "smithy.api#documentation": "

The name assigned to the job for the Find Matches task run.

" } + }, + "JobId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "

The job ID for the Find Matches task run.

" + } } }, "traits": { @@ -6461,36 +6645,36 @@ "com.amazonaws.glue#GetClassifiersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#Token", - "traits": { - "smithy.api#documentation": "

An optional continuation token.

" - } - }, "MaxResults": { "target": "com.amazonaws.glue#PageSize", "traits": { "smithy.api#documentation": "

The size of the list to return (optional).

" } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

An optional continuation token.

" + } } } }, "com.amazonaws.glue#GetClassifiersResponse": { "type": "structure", "members": { - "Classifiers": { - "target": "com.amazonaws.glue#ClassifierList", - "traits": { - "smithy.api#documentation": "

The requested list of classifier\n objects.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#Token", "traits": { "smithy.api#documentation": "

A continuation token.

" } - } - } + }, + "Classifiers": { + "target": "com.amazonaws.glue#ClassifierList", + "traits": { + "smithy.api#documentation": "

The requested list of classifier\n objects.

" + } + } + } }, "com.amazonaws.glue#GetColumnNamesList": { "type": "list", @@ -6536,17 +6720,17 @@ "com.amazonaws.glue#GetColumnStatisticsForPartitionRequest": { "type": "structure", "members": { - "TableName": { - "target": "com.amazonaws.glue#NameString", + "ColumnNames": { + "target": "com.amazonaws.glue#GetColumnNamesList", "traits": { - "smithy.api#documentation": "

The name of the partitions' table.

", + "smithy.api#documentation": "

A list of the column names.

", "smithy.api#required": {} } }, - "ColumnNames": { - "target": "com.amazonaws.glue#GetColumnNamesList", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A list of the column names.

", + "smithy.api#documentation": "

The name of the partitions' table.

", "smithy.api#required": {} } }, @@ -6575,17 +6759,17 @@ "com.amazonaws.glue#GetColumnStatisticsForPartitionResponse": { "type": "structure", "members": { - "ColumnStatisticsList": { - "target": "com.amazonaws.glue#ColumnStatisticsList", - "traits": { - "smithy.api#documentation": "

List of ColumnStatistics that failed to be retrieved.

" - } - }, "Errors": { "target": "com.amazonaws.glue#ColumnErrors", "traits": { "smithy.api#documentation": "

Error occurred during retrieving column statistics data.

" } + }, + "ColumnStatisticsList": { + "target": "com.amazonaws.glue#ColumnStatisticsList", + "traits": { + "smithy.api#documentation": "

List of ColumnStatistics that failed to be retrieved.

" + } } } }, @@ -6621,11 +6805,10 @@ "com.amazonaws.glue#GetColumnStatisticsForTableRequest": { "type": "structure", "members": { - "TableName": { - "target": "com.amazonaws.glue#NameString", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The name of the partitions' table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" } }, "DatabaseName": { @@ -6635,17 +6818,18 @@ "smithy.api#required": {} } }, - "ColumnNames": { - "target": "com.amazonaws.glue#GetColumnNamesList", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A list of the column names.

", + "smithy.api#documentation": "

The name of the partitions' table.

", "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "ColumnNames": { + "target": "com.amazonaws.glue#GetColumnNamesList", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

A list of the column names.

", + "smithy.api#required": {} } } } @@ -6696,6 +6880,12 @@ "com.amazonaws.glue#GetConnectionRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" + } + }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -6703,12 +6893,6 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" - } - }, "HidePassword": { "target": "com.amazonaws.glue#Boolean", "traits": { @@ -6762,17 +6946,17 @@ "com.amazonaws.glue#GetConnectionsFilter": { "type": "structure", "members": { - "ConnectionType": { - "target": "com.amazonaws.glue#ConnectionType", - "traits": { - "smithy.api#documentation": "

The type of connections to return. Currently, SFTP is not supported.

" - } - }, "MatchCriteria": { "target": "com.amazonaws.glue#MatchCriteria", "traits": { "smithy.api#documentation": "

A criteria string that must match the criteria recorded in the\n connection definition for that connection definition to be returned.

" } + }, + "ConnectionType": { + "target": "com.amazonaws.glue#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of connections to return. Currently, SFTP is not supported.

" + } } }, "traits": { @@ -6782,16 +6966,22 @@ "com.amazonaws.glue#GetConnectionsRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS\n account ID is used by default.

" + } + }, "HidePassword": { "target": "com.amazonaws.glue#Boolean", "traits": { "smithy.api#documentation": "

Allows you to retrieve the connection metadata without returning the password. For\n instance, the AWS Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the AWS KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.

" } }, - "NextToken": { - "target": "com.amazonaws.glue#Token", + "Filter": { + "target": "com.amazonaws.glue#GetConnectionsFilter", "traits": { - "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" + "smithy.api#documentation": "

A filter that controls which connections are returned.

" } }, "MaxResults": { @@ -6800,16 +6990,10 @@ "smithy.api#documentation": "

The maximum number of connections to return in one response.

" } }, - "Filter": { - "target": "com.amazonaws.glue#GetConnectionsFilter", - "traits": { - "smithy.api#documentation": "

A filter that controls which connections are returned.

" - } - }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "NextToken": { + "target": "com.amazonaws.glue#Token", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" } } } @@ -6817,17 +7001,17 @@ "com.amazonaws.glue#GetConnectionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#Token", - "traits": { - "smithy.api#documentation": "

A continuation token, if the list of connections returned does not\n include the last of the filtered connections.

" - } - }, "ConnectionList": { "target": "com.amazonaws.glue#ConnectionList", "traits": { "smithy.api#documentation": "

A list of requested connection definitions.

" } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token, if the list of connections returned does not\n include the last of the filtered connections.

" + } } } }, @@ -6876,12 +7060,6 @@ "com.amazonaws.glue#GetCrawlerMetricsRequest": { "type": "structure", "members": { - "CrawlerNameList": { - "target": "com.amazonaws.glue#CrawlerNameList", - "traits": { - "smithy.api#documentation": "

A list of the names of crawlers about which to retrieve metrics.

" - } - }, "MaxResults": { "target": "com.amazonaws.glue#PageSize", "traits": { @@ -6893,6 +7071,12 @@ "traits": { "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" } + }, + "CrawlerNameList": { + "target": "com.amazonaws.glue#CrawlerNameList", + "traits": { + "smithy.api#documentation": "

A list of the names of crawlers about which to retrieve metrics.

" + } } } }, @@ -6961,17 +7145,17 @@ "com.amazonaws.glue#GetCrawlersRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", - "traits": { - "smithy.api#documentation": "

The number of crawlers to return on each call.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#Token", "traits": { "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The number of crawlers to return on each call.

" + } } } }, @@ -7069,18 +7253,18 @@ "com.amazonaws.glue#GetDatabaseRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides. If none is provided, the AWS\n account ID is used by default.

" + } + }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the database to retrieve. For Hive compatibility, this \n should be all lowercase.

", "smithy.api#required": {} } - }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides. If none is provided, the AWS\n account ID is used by default.

" - } } } }, @@ -7129,18 +7313,18 @@ "com.amazonaws.glue#GetDatabasesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#Token", - "traits": { - "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" - } - }, "ResourceShareType": { "target": "com.amazonaws.glue#ResourceShareType", "traits": { "smithy.api#documentation": "

Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

\n\t\n\t " } }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" + } + }, "MaxResults": { "target": "com.amazonaws.glue#PageSize", "traits": { @@ -7158,18 +7342,18 @@ "com.amazonaws.glue#GetDatabasesResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token for paginating the returned list of tokens,\n returned if the current segment of the list is not the last.

" + } + }, "DatabaseList": { "target": "com.amazonaws.glue#DatabaseList", "traits": { "smithy.api#documentation": "

A list of Database objects from the specified catalog.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.glue#Token", - "traits": { - "smithy.api#documentation": "

A continuation token for paginating the returned list of tokens,\n returned if the current segment of the list is not the last.

" - } } } }, @@ -7481,18 +7665,18 @@ "smithy.api#required": {} } }, + "PredecessorsIncluded": { + "target": "com.amazonaws.glue#BooleanValue", + "traits": { + "smithy.api#documentation": "

True if a list of predecessor runs should be returned.

" + } + }, "JobName": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

Name of the job definition being run.

", "smithy.api#required": {} } - }, - "PredecessorsIncluded": { - "target": "com.amazonaws.glue#BooleanValue", - "traits": { - "smithy.api#documentation": "

True if a list of predecessor runs should be returned.

" - } } } }, @@ -7541,6 +7725,12 @@ "com.amazonaws.glue#GetJobRunsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum size of the response.

" + } + }, "JobName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -7548,12 +7738,6 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum size of the response.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#GenericString", "traits": { @@ -7613,34 +7797,34 @@ "com.amazonaws.glue#GetJobsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#GenericString", - "traits": { - "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" - } - }, "MaxResults": { "target": "com.amazonaws.glue#PageSize", "traits": { "smithy.api#documentation": "

The maximum size of the response.

" } + }, + "NextToken": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" + } } } }, "com.amazonaws.glue#GetJobsResponse": { "type": "structure", "members": { - "Jobs": { - "target": "com.amazonaws.glue#JobList", - "traits": { - "smithy.api#documentation": "

A list of job definitions.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#GenericString", "traits": { "smithy.api#documentation": "

A continuation token, if not all job definitions have yet been returned.

" } + }, + "Jobs": { + "target": "com.amazonaws.glue#JobList", + "traits": { + "smithy.api#documentation": "

A list of job definitions.

" + } } } }, @@ -7692,22 +7876,16 @@ "com.amazonaws.glue#GetMLTaskRunResponse": { "type": "structure", "members": { - "ExecutionTime": { - "target": "com.amazonaws.glue#ExecutionTime", - "traits": { - "smithy.api#documentation": "

The amount of time (in seconds) that the task run consumed resources.

" - } - }, - "Status": { - "target": "com.amazonaws.glue#TaskStatusType", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

The status for this task run.

" + "smithy.api#documentation": "

The unique identifier of the task run.

" } }, - "Properties": { - "target": "com.amazonaws.glue#TaskRunProperties", + "LastModifiedOn": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The list of properties that are associated with the task run.

" + "smithy.api#documentation": "

The date and time when this task run was last modified.

" } }, "TaskRunId": { @@ -7716,28 +7894,16 @@ "smithy.api#documentation": "

The unique run identifier associated with this run.

" } }, - "LastModifiedOn": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when this task run was last modified.

" - } - }, "LogGroupName": { "target": "com.amazonaws.glue#GenericString", "traits": { "smithy.api#documentation": "

The names of the log groups that are associated with the task run.

" } }, - "CompletedOn": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when this task run was completed.

" - } - }, - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "Status": { + "target": "com.amazonaws.glue#TaskStatusType", "traits": { - "smithy.api#documentation": "

The unique identifier of the task run.

" + "smithy.api#documentation": "

The status for this task run.

" } }, "ErrorString": { @@ -7746,11 +7912,29 @@ "smithy.api#documentation": "

The error strings that are associated with the task run.

" } }, + "Properties": { + "target": "com.amazonaws.glue#TaskRunProperties", + "traits": { + "smithy.api#documentation": "

The list of properties that are associated with the task run.

" + } + }, "StartedOn": { "target": "com.amazonaws.glue#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when this task run started.

" } + }, + "ExecutionTime": { + "target": "com.amazonaws.glue#ExecutionTime", + "traits": { + "smithy.api#documentation": "

The amount of time (in seconds) that the task run consumed resources.

" + } + }, + "CompletedOn": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when this task run was completed.

" + } } } }, @@ -7788,10 +7972,10 @@ "com.amazonaws.glue#GetMLTaskRunsRequest": { "type": "structure", "members": { - "Sort": { - "target": "com.amazonaws.glue#TaskRunSortCriteria", + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

The sorting criteria, in the TaskRunSortCriteria structure, for the task run.

" + "smithy.api#documentation": "

The maximum number of results to return.

" } }, "NextToken": { @@ -7800,10 +7984,10 @@ "smithy.api#documentation": "

A token for pagination of the results. The default is empty.

" } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "Sort": { + "target": "com.amazonaws.glue#TaskRunSortCriteria", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" + "smithy.api#documentation": "

The sorting criteria, in the TaskRunSortCriteria structure, for the task run.

" } }, "Filter": { @@ -7824,17 +8008,17 @@ "com.amazonaws.glue#GetMLTaskRunsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#PaginationToken", - "traits": { - "smithy.api#documentation": "

A pagination token, if more results are available.

" - } - }, "TaskRuns": { "target": "com.amazonaws.glue#TaskRunList", "traits": { "smithy.api#documentation": "

A list of task runs that are associated with the transform.

" } + }, + "NextToken": { + "target": "com.amazonaws.glue#PaginationToken", + "traits": { + "smithy.api#documentation": "

A pagination token, if more results are available.

" + } } } }, @@ -7879,30 +8063,6 @@ "com.amazonaws.glue#GetMLTransformResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The unique name given to the transform when it was created.

" - } - }, - "LastModifiedOn": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when the transform was last modified.

" - } - }, - "LabelCount": { - "target": "com.amazonaws.glue#LabelCount", - "traits": { - "smithy.api#documentation": "

The number of labels available for this transform.

" - } - }, - "CreatedOn": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when the transform was created.

" - } - }, "Parameters": { "target": "com.amazonaws.glue#TransformParameters", "traits": { @@ -7921,16 +8081,10 @@ "smithy.api#documentation": "

The last known status of the transform (to indicate whether it can be used or not). One of \"NOT_READY\", \"READY\", or \"DELETING\".

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", - "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " - } - }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "InputRecordTables": { + "target": "com.amazonaws.glue#GlueTables", "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

A list of AWS Glue table definitions used by the transform.

" } }, "MaxCapacity": { @@ -7939,28 +8093,34 @@ "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "EvaluationMetrics": { + "target": "com.amazonaws.glue#EvaluationMetrics", "traits": { - "smithy.api#documentation": "

A description of the transform.

" + "smithy.api#documentation": "

The latest evaluation metrics.

" } }, - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The unique identifier of the transform, generated at the time that the transform was\n created.

" + "smithy.api#documentation": "

The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" } }, - "InputRecordTables": { - "target": "com.amazonaws.glue#GlueTables", + "Schema": { + "target": "com.amazonaws.glue#TransformSchema", "traits": { - "smithy.api#documentation": "

A list of AWS Glue table definitions used by the transform.

" + "smithy.api#documentation": "

The Map object that represents the schema that this\n transform accepts. Has an upper bound of 100 columns.

" } }, - "NumberOfWorkers": { - "target": "com.amazonaws.glue#NullableInteger", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when this task runs.

" + "smithy.api#documentation": "

The unique name given to the transform when it was created.

" + } + }, + "LabelCount": { + "target": "com.amazonaws.glue#LabelCount", + "traits": { + "smithy.api#documentation": "

The number of labels available for this transform.

" } }, "Role": { @@ -7969,22 +8129,46 @@ "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required\n permissions.

" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" } }, - "Schema": { - "target": "com.amazonaws.glue#TransformSchema", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

The Map object that represents the schema that this\n transform accepts. Has an upper bound of 100 columns.

" + "smithy.api#documentation": "

The unique identifier of the transform, generated at the time that the transform was\n created.

" } }, - "EvaluationMetrics": { - "target": "com.amazonaws.glue#EvaluationMetrics", + "CreatedOn": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The latest evaluation metrics.

" + "smithy.api#documentation": "

The date and time when the transform was created.

" + } + }, + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", + "traits": { + "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " + } + }, + "LastModifiedOn": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the transform was last modified.

" + } + }, + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when this task runs.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the transform.

" } } } @@ -8023,10 +8207,10 @@ "com.amazonaws.glue#GetMLTransformsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "Sort": { + "target": "com.amazonaws.glue#TransformSortCriteria", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" + "smithy.api#documentation": "

The sorting criteria.

" } }, "Filter": { @@ -8041,10 +8225,10 @@ "smithy.api#documentation": "

A paginated token to offset the results.

" } }, - "Sort": { - "target": "com.amazonaws.glue#TransformSortCriteria", + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

The sorting criteria.

" + "smithy.api#documentation": "

The maximum number of results to return.

" } } } @@ -8052,18 +8236,18 @@ "com.amazonaws.glue#GetMLTransformsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.glue#PaginationToken", + "traits": { + "smithy.api#documentation": "

A pagination token, if more results are available.

" + } + }, "Transforms": { "target": "com.amazonaws.glue#TransformList", "traits": { "smithy.api#documentation": "

A list of machine learning transforms.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.glue#PaginationToken", - "traits": { - "smithy.api#documentation": "

A pagination token, if more results are available.

" - } } } }, @@ -8096,10 +8280,10 @@ "com.amazonaws.glue#GetMappingRequest": { "type": "structure", "members": { - "Sinks": { - "target": "com.amazonaws.glue#CatalogEntries", + "Location": { + "target": "com.amazonaws.glue#Location", "traits": { - "smithy.api#documentation": "

A list of target tables.

" + "smithy.api#documentation": "

Parameters for the mapping.

" } }, "Source": { @@ -8109,10 +8293,10 @@ "smithy.api#required": {} } }, - "Location": { - "target": "com.amazonaws.glue#Location", + "Sinks": { + "target": "com.amazonaws.glue#CatalogEntries", "traits": { - "smithy.api#documentation": "

Parameters for the mapping.

" + "smithy.api#documentation": "

A list of target tables.

" } } } @@ -8158,63 +8342,20 @@ "smithy.api#documentation": "

Retrieves information about a specified partition.

" } }, - "com.amazonaws.glue#GetPartitionRequest": { - "type": "structure", - "members": { - "PartitionValues": { - "target": "com.amazonaws.glue#ValueStringList", - "traits": { - "smithy.api#documentation": "

The values that define the partition.

", - "smithy.api#required": {} - } - }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partition in question resides. If none is provided,\n the AWS account ID is used by default.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the catalog database where the partition resides.

", - "smithy.api#required": {} - } - }, - "TableName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the partition's table.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.glue#GetPartitionResponse": { - "type": "structure", - "members": { - "Partition": { - "target": "com.amazonaws.glue#Partition", - "traits": { - "smithy.api#documentation": "

The requested information, in the form of a Partition\n object.

" - } - } - } - }, - "com.amazonaws.glue#GetPartitions": { + "com.amazonaws.glue#GetPartitionIndexes": { "type": "operation", "input": { - "target": "com.amazonaws.glue#GetPartitionsRequest" + "target": "com.amazonaws.glue#GetPartitionIndexesRequest" }, "output": { - "target": "com.amazonaws.glue#GetPartitionsResponse" + "target": "com.amazonaws.glue#GetPartitionIndexesResponse" }, "errors": [ { - "target": "com.amazonaws.glue#EntityNotFoundException" + "target": "com.amazonaws.glue#ConflictException" }, { - "target": "com.amazonaws.glue#GlueEncryptionException" + "target": "com.amazonaws.glue#EntityNotFoundException" }, { "target": "com.amazonaws.glue#InternalServiceException" @@ -8227,60 +8368,185 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the partitions in a table.

", + "smithy.api#documentation": "

Retrieves the partition indexes associated with a table.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" + "items": "PartitionIndexDescriptorList" } } }, - "com.amazonaws.glue#GetPartitionsRequest": { + "com.amazonaws.glue#GetPartitionIndexesRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.glue#Token", "traits": { - "smithy.api#documentation": "

A continuation token, if this is not the first call to retrieve\n these partitions.

" - } - }, - "Segment": { - "target": "com.amazonaws.glue#Segment", - "traits": { - "smithy.api#documentation": "

The segment of the table's partitions to scan in this request.

" + "smithy.api#documentation": "

A continuation token, included if this is a continuation call.

" } }, - "DatabaseName": { + "TableName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", + "smithy.api#documentation": "

Specifies the name of a table for which you want to retrieve the partition indexes.

", "smithy.api#required": {} } }, - "TableName": { + "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the partitions' table.

", + "smithy.api#documentation": "

Specifies the name of a database from which you want to retrieve partition indexes.

", "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The maximum number of partitions to return in a single response.

" + "smithy.api#documentation": "

The catalog ID where the table resides.

" + } + } + } + }, + "com.amazonaws.glue#GetPartitionIndexesResponse": { + "type": "structure", + "members": { + "PartitionIndexDescriptorList": { + "target": "com.amazonaws.glue#PartitionIndexDescriptorList", + "traits": { + "smithy.api#documentation": "

A list of index descriptors.

" } }, - "Expression": { - "target": "com.amazonaws.glue#PredicateString", + "NextToken": { + "target": "com.amazonaws.glue#Token", "traits": { - "smithy.api#documentation": "

An expression that filters the partitions to be returned.

\n

The expression uses SQL syntax similar to the SQL WHERE filter clause. The\n SQL statement parser JSQLParser parses the expression.

\n

\n Operators: The following are the operators that you can use in the\n Expression API call:

\n
\n
=
\n
\n

Checks whether the values of the two operands are equal; if yes, then the condition becomes\n true.

\n

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

\n

(a = b) is not true.

\n
\n
< >
\n
\n

Checks whether the values of two operands are equal; if the values are not equal,\n then the condition becomes true.

\n

Example: (a < > b) is true.

\n
\n
>
\n
\n

Checks whether the value of the left operand is greater than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a > b) is not true.

\n
\n
<
\n
\n

Checks whether the value of the left operand is less than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a < b) is true.

\n
\n
>=
\n
\n

Checks whether the value of the left operand is greater than or equal to the value\n of the right operand; if yes, then the condition becomes true.

\n

Example: (a >= b) is not true.

\n
\n
<=
\n
\n

Checks whether the value of the left operand is less than or equal to the value of\n the right operand; if yes, then the condition becomes true.

\n

Example: (a <= b) is true.

\n
\n
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
\n
\n

Logical operators.

\n
\n
\n

\n Supported Partition Key Types: The following are the supported\n partition keys.

\n \n

If an invalid type is encountered, an exception is thrown.

\n

The following list shows the valid operators on each type. When you define a crawler, the\n partitionKey type is created as a STRING, to be compatible with the catalog\n partitions.

\n \n

\n Sample API Call:

" + "smithy.api#documentation": "

A continuation token, present if the current list segment is not the last.

" + } + } + } + }, + "com.amazonaws.glue#GetPartitionRequest": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the partition's table.

", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the catalog database where the partition resides.

", + "smithy.api#required": {} + } + }, + "PartitionValues": { + "target": "com.amazonaws.glue#ValueStringList", + "traits": { + "smithy.api#documentation": "

The values that define the partition.

", + "smithy.api#required": {} + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog where the partition in question resides. If none is provided,\n the AWS account ID is used by default.

" + } + } + } + }, + "com.amazonaws.glue#GetPartitionResponse": { + "type": "structure", + "members": { + "Partition": { + "target": "com.amazonaws.glue#Partition", + "traits": { + "smithy.api#documentation": "

The requested information, in the form of a Partition\n object.

" } + } + } + }, + "com.amazonaws.glue#GetPartitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetPartitionsRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetPartitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the partitions in a table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#GetPartitionsRequest": { + "type": "structure", + "members": { "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside. If none is provided,\n the AWS account ID is used by default.

" } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the partitions' table.

", + "smithy.api#required": {} + } + }, + "Segment": { + "target": "com.amazonaws.glue#Segment", + "traits": { + "smithy.api#documentation": "

The segment of the table's partitions to scan in this request.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.glue#PredicateString", + "traits": { + "smithy.api#documentation": "

An expression that filters the partitions to be returned.

\n

The expression uses SQL syntax similar to the SQL WHERE filter clause. The\n SQL statement parser JSQLParser parses the expression.

\n

\n Operators: The following are the operators that you can use in the\n Expression API call:

\n
\n
=
\n
\n

Checks whether the values of the two operands are equal; if yes, then the condition becomes\n true.

\n

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

\n

(a = b) is not true.

\n
\n
< >
\n
\n

Checks whether the values of two operands are equal; if the values are not equal,\n then the condition becomes true.

\n

Example: (a < > b) is true.

\n
\n
>
\n
\n

Checks whether the value of the left operand is greater than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a > b) is not true.

\n
\n
<
\n
\n

Checks whether the value of the left operand is less than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a < b) is true.

\n
\n
>=
\n
\n

Checks whether the value of the left operand is greater than or equal to the value\n of the right operand; if yes, then the condition becomes true.

\n

Example: (a >= b) is not true.

\n
\n
<=
\n
\n

Checks whether the value of the left operand is less than or equal to the value of\n the right operand; if yes, then the condition becomes true.

\n

Example: (a <= b) is true.

\n
\n
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
\n
\n

Logical operators.

\n
\n
\n

\n Supported Partition Key Types: The following are the supported\n partition keys.

\n \n

If an invalid type is encountered, an exception is thrown.

\n

The following list shows the valid operators on each type. When you define a crawler, the\n partitionKey type is created as a STRING, to be compatible with the catalog\n partitions.

\n \n

\n Sample API Call:

" + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of partitions to return in a single response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is not the first call to retrieve\n these partitions.

" + } } } }, @@ -8327,6 +8593,13 @@ "com.amazonaws.glue#GetPlanRequest": { "type": "structure", "members": { + "Source": { + "target": "com.amazonaws.glue#CatalogEntry", + "traits": { + "smithy.api#documentation": "

The source table.

", + "smithy.api#required": {} + } + }, "Mapping": { "target": "com.amazonaws.glue#MappingList", "traits": { @@ -8340,23 +8613,22 @@ "smithy.api#documentation": "

The programming language of the code to perform the mapping.

" } }, - "Sinks": { - "target": "com.amazonaws.glue#CatalogEntries", + "Location": { + "target": "com.amazonaws.glue#Location", "traits": { - "smithy.api#documentation": "

The target tables.

" + "smithy.api#documentation": "

The parameters for the mapping.

" } }, - "Source": { - "target": "com.amazonaws.glue#CatalogEntry", + "Sinks": { + "target": "com.amazonaws.glue#CatalogEntries", "traits": { - "smithy.api#documentation": "

The source table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The target tables.

" } }, - "Location": { - "target": "com.amazonaws.glue#Location", + "AdditionalPlanOptionsMap": { + "target": "com.amazonaws.glue#AdditionalPlanOptionsMap", "traits": { - "smithy.api#documentation": "

The parameters for the mapping.

" + "smithy.api#documentation": "

A map to hold additional optional key-value parameters.

\n\t\n\t

Currently, these key-value pairs are supported:

\n\t\n\t " } } } @@ -8364,17 +8636,17 @@ "com.amazonaws.glue#GetPlanResponse": { "type": "structure", "members": { - "PythonScript": { - "target": "com.amazonaws.glue#PythonScript", - "traits": { - "smithy.api#documentation": "

A Python script to perform the mapping.

" - } - }, "ScalaCode": { "target": "com.amazonaws.glue#ScalaCode", "traits": { "smithy.api#documentation": "

The Scala code to perform the mapping.

" } + }, + "PythonScript": { + "target": "com.amazonaws.glue#PythonScript", + "traits": { + "smithy.api#documentation": "

A Python script to perform the mapping.

" + } } } }, @@ -8424,17 +8696,17 @@ "com.amazonaws.glue#GetResourcePoliciesResponse": { "type": "structure", "members": { - "GetResourcePoliciesResponseList": { - "target": "com.amazonaws.glue#GetResourcePoliciesResponseList", - "traits": { - "smithy.api#documentation": "

A list of the individual resource policies and the account-level resource policy.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#Token", "traits": { "smithy.api#documentation": "

A continuation token, if the returned list does not contain the last resource policy available.

" } + }, + "GetResourcePoliciesResponseList": { + "target": "com.amazonaws.glue#GetResourcePoliciesResponseList", + "traits": { + "smithy.api#documentation": "

A list of the individual resource policies and the account-level resource policy.

" + } } } }, @@ -8484,16 +8756,10 @@ "com.amazonaws.glue#GetResourcePolicyResponse": { "type": "structure", "members": { - "PolicyHash": { - "target": "com.amazonaws.glue#HashString", - "traits": { - "smithy.api#documentation": "

Contains the hash value associated with this policy.

" - } - }, - "UpdateTime": { + "CreateTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time at which the policy was last updated.

" + "smithy.api#documentation": "

The date and time at which the policy was created.

" } }, "PolicyInJson": { @@ -8502,10 +8768,16 @@ "smithy.api#documentation": "

Contains the requested policy document, in JSON format.

" } }, - "CreateTime": { + "PolicyHash": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "

Contains the hash value associated with this policy.

" + } + }, + "UpdateTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time at which the policy was created.

" + "smithy.api#documentation": "

The date and time at which the policy was last updated.

" } } } @@ -8582,7 +8854,13 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of all security configurations.

" + "smithy.api#documentation": "

Retrieves a list of all security configurations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityConfigurations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.glue#GetSecurityConfigurationsRequest": { @@ -8605,17 +8883,17 @@ "com.amazonaws.glue#GetSecurityConfigurationsResponse": { "type": "structure", "members": { - "SecurityConfigurations": { - "target": "com.amazonaws.glue#SecurityConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of security configurations.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#GenericString", "traits": { "smithy.api#documentation": "

A continuation token, if there are more security\n configurations to return.

" } + }, + "SecurityConfigurations": { + "target": "com.amazonaws.glue#SecurityConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of security configurations.

" + } } } }, @@ -8651,12 +8929,6 @@ "com.amazonaws.glue#GetTableRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" - } - }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -8670,6 +8942,12 @@ "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.\n For Hive compatibility, this name is entirely lowercase.

", "smithy.api#required": {} } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" + } } } }, @@ -8716,13 +8994,6 @@ "com.amazonaws.glue#GetTableVersionRequest": { "type": "structure", "members": { - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The database in the catalog in which the table resides. For Hive\n compatibility, this name is entirely lowercase.

", - "smithy.api#required": {} - } - }, "TableName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -8741,6 +9012,13 @@ "traits": { "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The database in the catalog in which the table resides. For Hive\n compatibility, this name is entirely lowercase.

", + "smithy.api#required": {} + } } } }, @@ -8798,17 +9076,18 @@ "com.amazonaws.glue#GetTableVersionsRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "NextToken": { + "target": "com.amazonaws.glue#Token", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

A continuation token, if this is not the first call.

" } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The maximum number of table versions to return in one response.

" - } + "smithy.api#documentation": "

The name of the table. For Hive\n compatibility, this name is entirely lowercase.

", + "smithy.api#required": {} + } }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", @@ -8817,17 +9096,16 @@ "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.glue#NameString", + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

The name of the table. For Hive\n compatibility, this name is entirely lowercase.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of table versions to return in one response.

" } }, - "NextToken": { - "target": "com.amazonaws.glue#Token", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

A continuation token, if this is not the first call.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" } } } @@ -8835,17 +9113,17 @@ "com.amazonaws.glue#GetTableVersionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#Token", - "traits": { - "smithy.api#documentation": "

A continuation token, if the list of available versions does\n not include the last one.

" - } - }, "TableVersions": { "target": "com.amazonaws.glue#GetTableVersionsList", "traits": { "smithy.api#documentation": "

A list of strings identifying available versions of the\n specified table.

" } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token, if the list of available versions does\n not include the last one.

" + } } } }, @@ -8886,17 +9164,22 @@ "com.amazonaws.glue#GetTablesRequest": { "type": "structure", "members": { + "Expression": { + "target": "com.amazonaws.glue#FilterString", + "traits": { + "smithy.api#documentation": "

A regular expression pattern. If present, only those tables\n whose names match the pattern are returned.

" + } + }, "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" } }, - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

The database in the catalog whose tables to list. For Hive\n compatibility, this name is entirely lowercase.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of tables to return in a single response.

" } }, "NextToken": { @@ -8905,16 +9188,11 @@ "smithy.api#documentation": "

A continuation token, included if this is a continuation call.

" } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of tables to return in a single response.

" - } - }, - "Expression": { - "target": "com.amazonaws.glue#FilterString", + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A regular expression pattern. If present, only those tables\n whose names match the pattern are returned.

" + "smithy.api#documentation": "

The database in the catalog whose tables to list. For Hive\n compatibility, this name is entirely lowercase.

", + "smithy.api#required": {} } } } @@ -9091,17 +9369,17 @@ "com.amazonaws.glue#GetTriggersResponse": { "type": "structure", "members": { - "Triggers": { - "target": "com.amazonaws.glue#TriggerList", - "traits": { - "smithy.api#documentation": "

A list of triggers for the specified job.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#GenericString", "traits": { "smithy.api#documentation": "

A continuation token, if not all the requested triggers\n have yet been returned.

" } + }, + "Triggers": { + "target": "com.amazonaws.glue#TriggerList", + "traits": { + "smithy.api#documentation": "

A list of triggers for the specified job.

" + } } } }, @@ -9137,17 +9415,17 @@ "com.amazonaws.glue#GetUserDefinedFunctionRequest": { "type": "structure", "members": { - "DatabaseName": { + "FunctionName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the catalog database where the function is located.

", + "smithy.api#documentation": "

The name of the function.

", "smithy.api#required": {} } }, - "FunctionName": { + "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the function.

", + "smithy.api#documentation": "

The name of the catalog database where the function is located.

", "smithy.api#required": {} } }, @@ -9207,10 +9485,11 @@ "com.amazonaws.glue#GetUserDefinedFunctionsRequest": { "type": "structure", "members": { - "DatabaseName": { + "Pattern": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the catalog database where the functions are located. If none is provided, functions from all the\n databases across the catalog will be returned.

" + "smithy.api#documentation": "

An optional function-name pattern string that filters the function\n definitions returned.

", + "smithy.api#required": {} } }, "NextToken": { @@ -9225,17 +9504,16 @@ "smithy.api#documentation": "

The maximum number of functions to return in one response.

" } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the functions to be retrieved are located. If none is\n provided, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The name of the catalog database where the functions are located. If none is provided, functions from all the\n databases across the catalog will be returned.

" } }, - "Pattern": { - "target": "com.amazonaws.glue#NameString", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

An optional function-name pattern string that filters the function\n definitions returned.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the Data Catalog where the functions to be retrieved are located. If none is\n provided, the AWS account ID is used by default.

" } } } @@ -9243,17 +9521,17 @@ "com.amazonaws.glue#GetUserDefinedFunctionsResponse": { "type": "structure", "members": { - "UserDefinedFunctions": { - "target": "com.amazonaws.glue#UserDefinedFunctionList", - "traits": { - "smithy.api#documentation": "

A list of requested function definitions.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#Token", "traits": { "smithy.api#documentation": "

A continuation token, if the list of functions returned does\n not include the last requested function.

" } + }, + "UserDefinedFunctions": { + "target": "com.amazonaws.glue#UserDefinedFunctionList", + "traits": { + "smithy.api#documentation": "

A list of requested function definitions.

" + } } } }, @@ -9397,10 +9675,10 @@ "com.amazonaws.glue#GetWorkflowRunRequest": { "type": "structure", "members": { - "RunId": { - "target": "com.amazonaws.glue#IdString", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The ID of the workflow run.

", + "smithy.api#documentation": "

Name of the workflow being run.

", "smithy.api#required": {} } }, @@ -9410,10 +9688,10 @@ "smithy.api#documentation": "

Specifies whether to include the workflow graph in response or not.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "RunId": { + "target": "com.amazonaws.glue#IdString", "traits": { - "smithy.api#documentation": "

Name of the workflow being run.

", + "smithy.api#documentation": "

The ID of the workflow run.

", "smithy.api#required": {} } } @@ -9464,13 +9742,6 @@ "com.amazonaws.glue#GetWorkflowRunsRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

Name of the workflow whose metadata of runs should be returned.

", - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.glue#GenericString", "traits": { @@ -9488,6 +9759,13 @@ "traits": { "smithy.api#documentation": "

The maximum number of workflow runs to be included in the response.

" } + }, + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Name of the workflow whose metadata of runs should be returned.

", + "smithy.api#required": {} + } } } }, @@ -9526,28 +9804,28 @@ "com.amazonaws.glue#GluePolicy": { "type": "structure", "members": { - "UpdateTime": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time at which the policy was last updated.

" - } - }, "PolicyInJson": { "target": "com.amazonaws.glue#PolicyJsonString", "traits": { "smithy.api#documentation": "

Contains the requested policy document, in JSON format.

" } }, + "CreateTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the policy was created.

" + } + }, "PolicyHash": { "target": "com.amazonaws.glue#HashString", "traits": { "smithy.api#documentation": "

Contains the hash value associated with this policy.

" } }, - "CreateTime": { + "UpdateTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time at which the policy was created.

" + "smithy.api#documentation": "

The date and time at which the policy was last updated.

" } } }, @@ -9568,30 +9846,30 @@ "com.amazonaws.glue#GlueTable": { "type": "structure", "members": { - "DatabaseName": { + "TableName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A database name in the AWS Glue Data Catalog.

", + "smithy.api#documentation": "

A table name in the AWS Glue Data Catalog.

", "smithy.api#required": {} } }, - "CatalogId": { + "ConnectionName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS Glue Data Catalog.

" + "smithy.api#documentation": "

The name of the connection to the AWS Glue Data Catalog.

" } }, - "TableName": { + "CatalogId": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A table name in the AWS Glue Data Catalog.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier for the AWS Glue Data Catalog.

" } }, - "ConnectionName": { + "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the connection to the AWS Glue Data Catalog.

" + "smithy.api#documentation": "

A database name in the AWS Glue Data Catalog.

", + "smithy.api#required": {} } } }, @@ -9624,29 +9902,23 @@ "com.amazonaws.glue#GrokClassifier": { "type": "structure", "members": { - "CustomPatterns": { - "target": "com.amazonaws.glue#CustomPatterns", + "LastUpdated": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

Optional custom grok patterns defined by this classifier.\n For more information, see custom patterns in Writing Custom Classifiers.

" + "smithy.api#documentation": "

The time that this classifier was last updated.

" } }, - "GrokPattern": { - "target": "com.amazonaws.glue#GrokPattern", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The grok pattern applied to a data store by this classifier.\n For more information, see built-in patterns in Writing Custom Classifiers.

", + "smithy.api#documentation": "

The name of the classifier.

", "smithy.api#required": {} } }, - "Version": { - "target": "com.amazonaws.glue#VersionId", - "traits": { - "smithy.api#documentation": "

The version of this classifier.

" - } - }, - "LastUpdated": { + "CreationTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The time that this classifier was last updated.

" + "smithy.api#documentation": "

The time that this classifier was registered.

" } }, "Classification": { @@ -9656,18 +9928,24 @@ "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.glue#Timestamp", + "Version": { + "target": "com.amazonaws.glue#VersionId", "traits": { - "smithy.api#documentation": "

The time that this classifier was registered.

" + "smithy.api#documentation": "

The version of this classifier.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "GrokPattern": { + "target": "com.amazonaws.glue#GrokPattern", "traits": { - "smithy.api#documentation": "

The name of the classifier.

", + "smithy.api#documentation": "

The grok pattern applied to a data store by this classifier.\n For more information, see built-in patterns in Writing Custom Classifiers.

", "smithy.api#required": {} } + }, + "CustomPatterns": { + "target": "com.amazonaws.glue#CustomPatterns", + "traits": { + "smithy.api#documentation": "

Optional custom grok patterns defined by this classifier.\n For more information, see custom patterns in Writing Custom Classifiers.

" + } } }, "traits": { @@ -9772,17 +10050,17 @@ "com.amazonaws.glue#ImportLabelsTaskRunProperties": { "type": "structure", "members": { - "InputS3Path": { - "target": "com.amazonaws.glue#UriString", - "traits": { - "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path from where you will import the\n labels.

" - } - }, "Replace": { "target": "com.amazonaws.glue#ReplaceBoolean", "traits": { "smithy.api#documentation": "

Indicates whether to overwrite your existing labels.

" } + }, + "InputS3Path": { + "target": "com.amazonaws.glue#UriString", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path from where you will import the\n labels.

" + } } }, "traits": { @@ -9837,6 +10115,12 @@ "com.amazonaws.glue#JdbcTarget": { "type": "structure", "members": { + "Exclusions": { + "target": "com.amazonaws.glue#PathList", + "traits": { + "smithy.api#documentation": "

A list of glob patterns used to exclude from the crawl.\n For more information, see Catalog Tables with a Crawler.

" + } + }, "ConnectionName": { "target": "com.amazonaws.glue#ConnectionName", "traits": { @@ -9848,12 +10132,6 @@ "traits": { "smithy.api#documentation": "

The path of the JDBC target.

" } - }, - "Exclusions": { - "target": "com.amazonaws.glue#PathList", - "traits": { - "smithy.api#documentation": "

A list of glob patterns used to exclude from the crawl.\n For more information, see Catalog Tables with a Crawler.

" - } } }, "traits": { @@ -9869,34 +10147,40 @@ "com.amazonaws.glue#Job": { "type": "structure", "members": { - "LogUri": { - "target": "com.amazonaws.glue#UriString", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

This field is reserved for future use.

" + "smithy.api#documentation": "

The name you assign to this job definition.

" } }, - "Command": { - "target": "com.amazonaws.glue#JobCommand", + "LastModifiedOn": { + "target": "com.amazonaws.glue#TimestampValue", "traits": { - "smithy.api#documentation": "

The JobCommand that executes this job.

" + "smithy.api#documentation": "

The last point in time when this job definition was modified.

" } }, - "NumberOfWorkers": { - "target": "com.amazonaws.glue#NullableInteger", + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a job runs.

\n\t\n\t\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n job.

" } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "CreatedOn": { + "target": "com.amazonaws.glue#TimestampValue", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

The time and date that this job definition was created.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "NonOverridableArguments": { + "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " + "smithy.api#documentation": "

Non-overridable arguments for this job, specified as name-value pairs.

" + } + }, + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", + "traits": { + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } }, "NotificationProperty": { @@ -9905,55 +10189,52 @@ "smithy.api#documentation": "

Specifies configuration properties of a job notification.

" } }, - "SecurityConfiguration": { - "target": "com.amazonaws.glue#NameString", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n job.

" + "smithy.api#documentation": "

A description of the job.

" } }, - "CreatedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The time and date that this job definition was created.

" + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\t\n\t

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:

\n " } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "DefaultArguments": { + "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

The name you assign to this job definition.

" + "smithy.api#documentation": "

The default arguments for this job, specified as name-value pairs.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" } }, - "Connections": { - "target": "com.amazonaws.glue#ConnectionsList", + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The connections used for this job.

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a job runs.

\n\t\n\t\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "Role": { + "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

" } }, - "AllocatedCapacity": { - "target": "com.amazonaws.glue#IntegerValue", + "ExecutionProperty": { + "target": "com.amazonaws.glue#ExecutionProperty", "traits": { - "smithy.api#deprecated": { - "message": "This property is deprecated, use MaxCapacity instead." - }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\t \n

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

\n\t

" + "smithy.api#documentation": "

An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.

" } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\t\n\t

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:

\n " + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " } }, - "NonOverridableArguments": { - "target": "com.amazonaws.glue#GenericMap", + "LogUri": { + "target": "com.amazonaws.glue#UriString", "traits": { - "smithy.api#documentation": "

Non-overridable arguments for this job, specified as name-value pairs.

" + "smithy.api#documentation": "

This field is reserved for future use.

" } }, "MaxRetries": { @@ -9962,34 +10243,31 @@ "smithy.api#documentation": "

The maximum number of times to retry this job after a JobRun fails.

" } }, - "ExecutionProperty": { - "target": "com.amazonaws.glue#ExecutionProperty", - "traits": { - "smithy.api#documentation": "

An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.

" - } - }, - "LastModifiedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "AllocatedCapacity": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The last point in time when this job definition was modified.

" + "smithy.api#deprecated": { + "message": "This property is deprecated, use MaxCapacity instead." + }, + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\t \n

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

\n\t

" } }, - "DefaultArguments": { - "target": "com.amazonaws.glue#GenericMap", + "Command": { + "target": "com.amazonaws.glue#JobCommand", "traits": { - "smithy.api#documentation": "

The default arguments for this job, specified as name-value pairs.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The JobCommand that executes this job.

" } }, - "Role": { - "target": "com.amazonaws.glue#RoleString", + "Connections": { + "target": "com.amazonaws.glue#ConnectionsList", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

" + "smithy.api#documentation": "

The connections used for this job.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

A description of the job.

" + "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" } } }, @@ -10000,16 +10278,16 @@ "com.amazonaws.glue#JobBookmarkEntry": { "type": "structure", "members": { - "JobBookmark": { - "target": "com.amazonaws.glue#JsonValue", + "PreviousRunId": { + "target": "com.amazonaws.glue#RunId", "traits": { - "smithy.api#documentation": "

The bookmark itself.

" + "smithy.api#documentation": "

The unique run identifier associated with the previous job run.

" } }, - "Run": { - "target": "com.amazonaws.glue#IntegerValue", + "JobName": { + "target": "com.amazonaws.glue#JobName", "traits": { - "smithy.api#documentation": "

The run ID number.

" + "smithy.api#documentation": "

The name of the job in question.

" } }, "RunId": { @@ -10018,28 +10296,28 @@ "smithy.api#documentation": "

The run ID number.

" } }, - "JobName": { - "target": "com.amazonaws.glue#JobName", + "JobBookmark": { + "target": "com.amazonaws.glue#JsonValue", "traits": { - "smithy.api#documentation": "

The name of the job in question.

" + "smithy.api#documentation": "

The bookmark itself.

" } }, - "Version": { + "Run": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The version of the job.

" + "smithy.api#documentation": "

The run ID number.

" } }, - "PreviousRunId": { - "target": "com.amazonaws.glue#RunId", + "Attempt": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The unique run identifier associated with the previous job run.

" + "smithy.api#documentation": "

The attempt ID number.

" } }, - "Attempt": { + "Version": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The attempt ID number.

" + "smithy.api#documentation": "

The version of the job.

" } } }, @@ -10050,17 +10328,17 @@ "com.amazonaws.glue#JobBookmarksEncryption": { "type": "structure", "members": { - "JobBookmarksEncryptionMode": { - "target": "com.amazonaws.glue#JobBookmarksEncryptionMode", - "traits": { - "smithy.api#documentation": "

The encryption mode to use for job bookmarks data.

" - } - }, "KmsKeyArn": { "target": "com.amazonaws.glue#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

" } + }, + "JobBookmarksEncryptionMode": { + "target": "com.amazonaws.glue#JobBookmarksEncryptionMode", + "traits": { + "smithy.api#documentation": "

The encryption mode to use for job bookmarks data.

" + } } }, "traits": { @@ -10085,6 +10363,12 @@ "com.amazonaws.glue#JobCommand": { "type": "structure", "members": { + "PythonVersion": { + "target": "com.amazonaws.glue#PythonVersionString", + "traits": { + "smithy.api#documentation": "

The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

" + } + }, "Name": { "target": "com.amazonaws.glue#GenericString", "traits": { @@ -10096,12 +10380,6 @@ "traits": { "smithy.api#documentation": "

Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a\n job.

" } - }, - "PythonVersion": { - "target": "com.amazonaws.glue#PythonVersionString", - "traits": { - "smithy.api#documentation": "

The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

" - } } }, "traits": { @@ -10140,91 +10418,70 @@ "com.amazonaws.glue#JobRun": { "type": "structure", "members": { - "Attempt": { - "target": "com.amazonaws.glue#AttemptCount", - "traits": { - "smithy.api#documentation": "

The number of the attempt to run this job.

" - } - }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", - "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" - } - }, - "StartedOn": { - "target": "com.amazonaws.glue#TimestampValue", - "traits": { - "smithy.api#documentation": "

The date and time at which this job run was started.

" - } - }, "NumberOfWorkers": { "target": "com.amazonaws.glue#NullableInteger", "traits": { "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a job runs.

\n\n

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, - "ExecutionTime": { - "target": "com.amazonaws.glue#ExecutionTime", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The amount of time (in seconds) that the job run consumed resources.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n " } }, - "AllocatedCapacity": { - "target": "com.amazonaws.glue#IntegerValue", + "PreviousRunId": { + "target": "com.amazonaws.glue#IdString", "traits": { - "smithy.api#deprecated": { - "message": "This property is deprecated, use MaxCapacity instead." - }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of AWS Glue data processing units (DPUs) allocated to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

" + "smithy.api#documentation": "

The ID of the previous run of this job. For example, the JobRunId specified\n in the StartJobRun action.

" } }, - "PredecessorRuns": { - "target": "com.amazonaws.glue#PredecessorList", + "ExecutionTime": { + "target": "com.amazonaws.glue#ExecutionTime", "traits": { - "smithy.api#documentation": "

A list of predecessors to this job run.

" + "smithy.api#documentation": "

The amount of time (in seconds) that the job run consumed resources.

" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. The default\n is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", + "JobName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n " + "smithy.api#documentation": "

The name of the job definition being used in this run.

" } }, - "JobRunState": { - "target": "com.amazonaws.glue#JobRunState", + "LastModifiedOn": { + "target": "com.amazonaws.glue#TimestampValue", "traits": { - "smithy.api#documentation": "

The current state of the job run.

" + "smithy.api#documentation": "

The last time that this job run was modified.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "TriggerName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n " + "smithy.api#documentation": "

The name of the trigger that started this job run.

" } }, - "ErrorMessage": { - "target": "com.amazonaws.glue#ErrorString", + "Arguments": { + "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

An error message associated with this job run.

" + "smithy.api#documentation": "

The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" } }, - "LogGroupName": { - "target": "com.amazonaws.glue#GenericString", + "StartedOn": { + "target": "com.amazonaws.glue#TimestampValue", "traits": { - "smithy.api#documentation": "

The name of the log group for secure logging that can be server-side encrypted in Amazon\n CloudWatch using AWS KMS. This name can be /aws-glue/jobs/, in which case the\n default encryption is NONE. If you add a role name and\n SecurityConfiguration name (in other words,\n /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security\n configuration is used to encrypt the log group.

" + "smithy.api#documentation": "

The date and time at which this job run was started.

" } }, - "SecurityConfiguration": { - "target": "com.amazonaws.glue#NameString", + "NotificationProperty": { + "target": "com.amazonaws.glue#NotificationProperty", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this job\n run.

" + "smithy.api#documentation": "

Specifies configuration properties of a job run notification.

" } }, "CompletedOn": { @@ -10233,10 +10490,16 @@ "smithy.api#documentation": "

The date and time that this job run completed.

" } }, - "JobName": { - "target": "com.amazonaws.glue#NameString", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The name of the job definition being used in this run.

" + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#ErrorString", + "traits": { + "smithy.api#documentation": "

An error message associated with this job run.

" } }, "Id": { @@ -10245,34 +10508,49 @@ "smithy.api#documentation": "

The ID of this job run.

" } }, - "PreviousRunId": { - "target": "com.amazonaws.glue#IdString", + "AllocatedCapacity": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The ID of the previous run of this job. For example, the JobRunId specified\n in the StartJobRun action.

" + "smithy.api#deprecated": { + "message": "This property is deprecated, use MaxCapacity instead." + }, + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of AWS Glue data processing units (DPUs) allocated to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

" } }, - "NotificationProperty": { - "target": "com.amazonaws.glue#NotificationProperty", + "PredecessorRuns": { + "target": "com.amazonaws.glue#PredecessorList", "traits": { - "smithy.api#documentation": "

Specifies configuration properties of a job run notification.

" + "smithy.api#documentation": "

A list of predecessors to this job run.

" } }, - "LastModifiedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The last time that this job run was modified.

" + "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. The default\n is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" } }, - "Arguments": { - "target": "com.amazonaws.glue#GenericMap", + "Attempt": { + "target": "com.amazonaws.glue#AttemptCount", "traits": { - "smithy.api#documentation": "

The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The number of the attempt to run this job.

" } }, - "TriggerName": { + "SecurityConfiguration": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the trigger that started this job run.

" + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this job\n run.

" + } + }, + "LogGroupName": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The name of the log group for secure logging that can be server-side encrypted in Amazon\n CloudWatch using AWS KMS. This name can be /aws-glue/jobs/, in which case the\n default encryption is NONE. If you add a role name and\n SecurityConfiguration name (in other words,\n /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security\n configuration is used to encrypt the log group.

" + } + }, + "JobRunState": { + "target": "com.amazonaws.glue#JobRunState", + "traits": { + "smithy.api#documentation": "

The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see AWS Glue Job Run Statuses.

" } } }, @@ -10323,68 +10601,65 @@ }, "com.amazonaws.glue#JobUpdate": { "type": "structure", - "members": { - "ExecutionProperty": { - "target": "com.amazonaws.glue#ExecutionProperty", + "members": { + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " } }, - "AllocatedCapacity": { - "target": "com.amazonaws.glue#IntegerValue", + "NotificationProperty": { + "target": "com.amazonaws.glue#NotificationProperty", "traits": { - "smithy.api#deprecated": { - "message": "This property is deprecated, use MaxCapacity instead." - }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n \n

The number of AWS Glue data processing units (DPUs) to allocate to this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

" + "smithy.api#documentation": "

Specifies the configuration properties of a job notification.

" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "ExecutionProperty": { + "target": "com.amazonaws.glue#ExecutionProperty", "traits": { - "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

An ExecutionProperty specifying the maximum number of concurrent runs allowed\n for this job.

" } }, - "Connections": { - "target": "com.amazonaws.glue#ConnectionsList", + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The connections used for this job.

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a job runs.

\n\t\n

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, - "NotificationProperty": { - "target": "com.amazonaws.glue#NotificationProperty", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

Specifies the configuration properties of a job notification.

" + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

\n \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\t \n\t \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n\n " } }, - "Command": { - "target": "com.amazonaws.glue#JobCommand", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The JobCommand that executes this job (required).

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" } }, - "SecurityConfiguration": { - "target": "com.amazonaws.glue#NameString", + "Role": { + "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n job.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role associated with this job\n (required).

" } }, - "LogUri": { - "target": "com.amazonaws.glue#UriString", + "DefaultArguments": { + "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

This field is reserved for future use.

" + "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" } }, - "NonOverridableArguments": { - "target": "com.amazonaws.glue#GenericMap", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

Non-overridable arguments for this job, specified as name-value pairs.

" + "smithy.api#documentation": "

Description of the job being defined.

" } }, - "DefaultArguments": { + "NonOverridableArguments": { "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

Non-overridable arguments for this job, specified as name-value pairs.

" } }, "MaxRetries": { @@ -10393,40 +10668,43 @@ "smithy.api#documentation": "

The maximum number of times to retry this job if it fails.

" } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this\n job.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "AllocatedCapacity": { + "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " + "smithy.api#deprecated": { + "message": "This property is deprecated, use MaxCapacity instead." + }, + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n \n

The number of AWS Glue data processing units (DPUs) to allocate to this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "LogUri": { + "target": "com.amazonaws.glue#UriString", "traits": { - "smithy.api#documentation": "

Description of the job being defined.

" + "smithy.api#documentation": "

This field is reserved for future use.

" } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

\n \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\t \n\t \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n\n " + "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" } }, - "NumberOfWorkers": { - "target": "com.amazonaws.glue#NullableInteger", + "Command": { + "target": "com.amazonaws.glue#JobCommand", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a job runs.

\n\t\n

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + "smithy.api#documentation": "

The JobCommand that executes this job (required).

" } }, - "Role": { - "target": "com.amazonaws.glue#RoleString", + "Connections": { + "target": "com.amazonaws.glue#ConnectionsList", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role associated with this job\n (required).

" + "smithy.api#documentation": "

The connections used for this job.

" } } }, @@ -10437,17 +10715,16 @@ "com.amazonaws.glue#JsonClassifier": { "type": "structure", "members": { - "JsonPath": { - "target": "com.amazonaws.glue#JsonPath", + "CreationTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The time that this classifier was registered.

" } }, - "CreationTime": { + "LastUpdated": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The time that this classifier was registered.

" + "smithy.api#documentation": "

The time that this classifier was last updated.

" } }, "Name": { @@ -10457,10 +10734,11 @@ "smithy.api#required": {} } }, - "LastUpdated": { - "target": "com.amazonaws.glue#Timestamp", + "JsonPath": { + "target": "com.amazonaws.glue#JsonPath", "traits": { - "smithy.api#documentation": "

The time that this classifier was last updated.

" + "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

", + "smithy.api#required": {} } }, "Version": { @@ -10480,6 +10758,50 @@ "com.amazonaws.glue#JsonValue": { "type": "string" }, + "com.amazonaws.glue#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.glue#KeySchemaElement": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.glue#ColumnTypeString", + "traits": { + "smithy.api#documentation": "

The type of a partition key.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of a partition key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A partition key pair consisting of a name and a type.

" + } + }, + "com.amazonaws.glue#KeySchemaElementList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#KeySchemaElement" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.glue#KeyString": { "type": "string", "traits": { @@ -10531,16 +10853,16 @@ "com.amazonaws.glue#LastCrawlInfo": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.glue#Timestamp", + "LogStream": { + "target": "com.amazonaws.glue#LogStream", "traits": { - "smithy.api#documentation": "

The time at which the crawl started.

" + "smithy.api#documentation": "

The log stream for the last crawl.

" } }, - "LogGroup": { - "target": "com.amazonaws.glue#LogGroup", + "Status": { + "target": "com.amazonaws.glue#LastCrawlStatus", "traits": { - "smithy.api#documentation": "

The log group for the last crawl.

" + "smithy.api#documentation": "

Status of the last crawl.

" } }, "MessagePrefix": { @@ -10549,16 +10871,16 @@ "smithy.api#documentation": "

The prefix for a message about this crawl.

" } }, - "LogStream": { - "target": "com.amazonaws.glue#LogStream", + "StartTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The log stream for the last crawl.

" + "smithy.api#documentation": "

The time at which the crawl started.

" } }, - "Status": { - "target": "com.amazonaws.glue#LastCrawlStatus", + "LogGroup": { + "target": "com.amazonaws.glue#LogGroup", "traits": { - "smithy.api#documentation": "

Status of the last crawl.

" + "smithy.api#documentation": "

The log group for the last crawl.

" } }, "ErrorMessage": { @@ -10616,10 +10938,10 @@ "com.amazonaws.glue#ListCrawlersRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "Tags": { + "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The maximum size of a list to return.

" + "smithy.api#documentation": "

Specifies to return only these tagged resources.

" } }, "NextToken": { @@ -10628,10 +10950,10 @@ "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" } }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

Specifies to return only these tagged resources.

" + "smithy.api#documentation": "

The maximum size of a list to return.

" } } } @@ -10693,17 +11015,17 @@ "smithy.api#documentation": "

The maximum size of a list to return.

" } }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", - "traits": { - "smithy.api#documentation": "

Specifies to return only these tagged resources.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#GenericString", "traits": { "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

Specifies to return only these tagged resources.

" + } } } }, @@ -10758,18 +11080,18 @@ "com.amazonaws.glue#ListJobsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#GenericString", - "traits": { - "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" - } - }, "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { "smithy.api#documentation": "

Specifies to return only these tagged resources.

" } }, + "NextToken": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" + } + }, "MaxResults": { "target": "com.amazonaws.glue#PageSize", "traits": { @@ -10829,34 +11151,34 @@ "com.amazonaws.glue#ListMLTransformsRequest": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.glue#TransformFilterCriteria", + "NextToken": { + "target": "com.amazonaws.glue#PaginationToken", "traits": { - "smithy.api#documentation": "

A TransformFilterCriteria used to filter the machine learning transforms.

" + "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "Sort": { + "target": "com.amazonaws.glue#TransformSortCriteria", "traits": { - "smithy.api#documentation": "

The maximum size of a list to return.

" + "smithy.api#documentation": "

A TransformSortCriteria used to sort the machine learning transforms.

" } }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

Specifies to return only these tagged resources.

" + "smithy.api#documentation": "

The maximum size of a list to return.

" } }, - "NextToken": { - "target": "com.amazonaws.glue#PaginationToken", + "Filter": { + "target": "com.amazonaws.glue#TransformFilterCriteria", "traits": { - "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" + "smithy.api#documentation": "

A TransformFilterCriteria used to filter the machine learning transforms.

" } }, - "Sort": { - "target": "com.amazonaws.glue#TransformSortCriteria", + "Tags": { + "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

A TransformSortCriteria used to sort the machine learning transforms.

" + "smithy.api#documentation": "

Specifies to return only these tagged resources.

" } } } @@ -10913,22 +11235,16 @@ "com.amazonaws.glue#ListTriggersRequest": { "type": "structure", "members": { - "DependentJobName": { - "target": "com.amazonaws.glue#NameString", + "Tags": { + "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The name of the job for which to retrieve triggers. The trigger that can start this job\n is returned. If there is no such trigger, all triggers are returned.

" + "smithy.api#documentation": "

Specifies to return only these tagged resources.

" } }, "MaxResults": { "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

The maximum size of a list to return.

" - } - }, - "Tags": { - "target": "com.amazonaws.glue#TagsMap", - "traits": { - "smithy.api#documentation": "

Specifies to return only these tagged resources.

" + "smithy.api#documentation": "

The maximum size of a list to return.

" } }, "NextToken": { @@ -10936,6 +11252,12 @@ "traits": { "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" } + }, + "DependentJobName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the job for which to retrieve triggers. The trigger that can start this job\n is returned. If there is no such trigger, all triggers are returned.

" + } } } }, @@ -10987,34 +11309,34 @@ "com.amazonaws.glue#ListWorkflowsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum size of a list to return.

" - } - }, "NextToken": { "target": "com.amazonaws.glue#GenericString", "traits": { "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum size of a list to return.

" + } } } }, "com.amazonaws.glue#ListWorkflowsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#GenericString", - "traits": { - "smithy.api#documentation": "

A continuation token, if not all workflow names have been returned.

" - } - }, "Workflows": { "target": "com.amazonaws.glue#WorkflowNames", "traits": { "smithy.api#documentation": "

List of names of workflows in the account.

" } + }, + "NextToken": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A continuation token, if not all workflow names have been returned.

" + } } } }, @@ -11027,16 +11349,16 @@ "smithy.api#documentation": "

An Amazon Simple Storage Service (Amazon S3) location.

" } }, - "DynamoDB": { + "Jdbc": { "target": "com.amazonaws.glue#CodeGenNodeArgs", "traits": { - "smithy.api#documentation": "

An Amazon DynamoDB table location.

" + "smithy.api#documentation": "

A JDBC location.

" } }, - "Jdbc": { + "DynamoDB": { "target": "com.amazonaws.glue#CodeGenNodeArgs", "traits": { - "smithy.api#documentation": "

A JDBC location.

" + "smithy.api#documentation": "

An Amazon DynamoDB table location.

" } } }, @@ -11115,10 +11437,10 @@ "com.amazonaws.glue#LongColumnStatisticsData": { "type": "structure", "members": { - "NumberOfNulls": { + "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { - "smithy.api#documentation": "

Number of nulls.

", + "smithy.api#documentation": "

Number of distinct values.

", "smithy.api#required": {} } }, @@ -11128,10 +11450,10 @@ "smithy.api#documentation": "

Maximum value of the column.

" } }, - "NumberOfDistinctValues": { + "NumberOfNulls": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { - "smithy.api#documentation": "

Number of distinct values.

", + "smithy.api#documentation": "

Number of nulls.

", "smithy.api#required": {} } }, @@ -11149,16 +11471,10 @@ "com.amazonaws.glue#MLTransform": { "type": "structure", "members": { - "LabelCount": { - "target": "com.amazonaws.glue#LabelCount", - "traits": { - "smithy.api#documentation": "

A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.

" - } - }, - "LastModifiedOn": { - "target": "com.amazonaws.glue#Timestamp", + "InputRecordTables": { + "target": "com.amazonaws.glue#GlueTables", "traits": { - "smithy.api#documentation": "

A timestamp. The last point in time when this machine learning transform was modified.

" + "smithy.api#documentation": "

A list of AWS Glue table definitions used by the transform.

" } }, "Parameters": { @@ -11167,22 +11483,22 @@ "smithy.api#documentation": "

A TransformParameters object. You can use parameters to tune (customize) the\n behavior of the machine learning transform by specifying what data it learns from and your\n preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).

" } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "LastModifiedOn": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

A timestamp. The last point in time when this machine learning transform was modified.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "MaxRetries": { + "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

A user-defined name for the machine learning transform. Names are not guaranteed unique\n and can be changed at any time.

" + "smithy.api#documentation": "

The maximum number of times to retry after an MLTaskRun of the machine\n learning transform fails.

" } }, - "EvaluationMetrics": { - "target": "com.amazonaws.glue#EvaluationMetrics", + "Status": { + "target": "com.amazonaws.glue#TransformStatusType", "traits": { - "smithy.api#documentation": "

An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.

" + "smithy.api#documentation": "

The current status of the machine learning transform.

" } }, "Schema": { @@ -11191,28 +11507,34 @@ "smithy.api#documentation": "

A map of key-value pairs representing the columns and data types that this transform can\n run against. Has an upper bound of 100 columns.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "CreatedOn": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

A user-defined, long-form description text for the machine learning transform.\n Descriptions are not guaranteed to be unique and can be changed at any time.

" + "smithy.api#documentation": "

A timestamp. The time and date that this machine learning transform was created.

" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

The timeout in minutes of the machine learning transform.

" + "smithy.api#documentation": "

The unique transform ID that is generated for the machine learning transform. The ID is\n guaranteed to be unique and does not change.

" } }, - "InputRecordTables": { - "target": "com.amazonaws.glue#GlueTables", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

A list of AWS Glue table definitions used by the transform.

" + "smithy.api#documentation": "

A user-defined, long-form description text for the machine learning transform.\n Descriptions are not guaranteed to be unique and can be changed at any time.

" } }, - "MaxRetries": { - "target": "com.amazonaws.glue#NullableInteger", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The maximum number of times to retry after an MLTaskRun of the machine\n learning transform fails.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " + } + }, + "Role": { + "target": "com.amazonaws.glue#RoleString", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t " } }, "NumberOfWorkers": { @@ -11221,40 +11543,40 @@ "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a task of the transform runs.

\n\t\n\t

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

" } }, - "Role": { - "target": "com.amazonaws.glue#RoleString", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t " + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, - "Status": { - "target": "com.amazonaws.glue#TransformStatusType", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The current status of the machine learning transform.

" + "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" } }, - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The unique transform ID that is generated for the machine learning transform. The ID is\n guaranteed to be unique and does not change.

" + "smithy.api#documentation": "

The timeout in minutes of the machine learning transform.

" } }, - "CreatedOn": { - "target": "com.amazonaws.glue#Timestamp", + "EvaluationMetrics": { + "target": "com.amazonaws.glue#EvaluationMetrics", "traits": { - "smithy.api#documentation": "

A timestamp. The time and date that this machine learning transform was created.

" + "smithy.api#documentation": "

An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.

" } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

A user-defined name for the machine learning transform. Names are not guaranteed unique\n and can be changed at any time.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "LabelCount": { + "target": "com.amazonaws.glue#LabelCount", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " + "smithy.api#documentation": "

A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.

" } } }, @@ -11295,6 +11617,18 @@ "com.amazonaws.glue#MappingEntry": { "type": "structure", "members": { + "SourceType": { + "target": "com.amazonaws.glue#FieldType", + "traits": { + "smithy.api#documentation": "

The source type.

" + } + }, + "SourcePath": { + "target": "com.amazonaws.glue#SchemaPathString", + "traits": { + "smithy.api#documentation": "

The source path.

" + } + }, "SourceTable": { "target": "com.amazonaws.glue#TableName", "traits": { @@ -11313,23 +11647,11 @@ "smithy.api#documentation": "

The target table.

" } }, - "SourcePath": { - "target": "com.amazonaws.glue#SchemaPathString", - "traits": { - "smithy.api#documentation": "

The source path.

" - } - }, "TargetPath": { "target": "com.amazonaws.glue#SchemaPathString", "traits": { "smithy.api#documentation": "

The target path.

" } - }, - "SourceType": { - "target": "com.amazonaws.glue#FieldType", - "traits": { - "smithy.api#documentation": "

The source type.

" - } } }, "traits": { @@ -11376,6 +11698,38 @@ "com.amazonaws.glue#MillisecondsCount": { "type": "long" }, + "com.amazonaws.glue#MongoDBTarget": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.glue#Path", + "traits": { + "smithy.api#documentation": "

The path of the Amazon DocumentDB or MongoDB target (database/collection).

" + } + }, + "ScanAll": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

\n\t\n\t

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an Amazon DocumentDB or MongoDB data store to crawl.

" + } + }, + "com.amazonaws.glue#MongoDBTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#MongoDBTarget" + } + }, "com.amazonaws.glue#NameString": { "type": "string", "traits": { @@ -11410,34 +11764,28 @@ "com.amazonaws.glue#Node": { "type": "structure", "members": { - "JobDetails": { - "target": "com.amazonaws.glue#JobNodeDetails", - "traits": { - "smithy.api#documentation": "

Details of the Job when the node represents a Job.

" - } - }, "TriggerDetails": { "target": "com.amazonaws.glue#TriggerNodeDetails", "traits": { "smithy.api#documentation": "

Details of the Trigger when the node represents a Trigger.

" } }, - "UniqueId": { - "target": "com.amazonaws.glue#NameString", + "CrawlerDetails": { + "target": "com.amazonaws.glue#CrawlerNodeDetails", "traits": { - "smithy.api#documentation": "

The unique Id assigned to the node within the workflow.

" + "smithy.api#documentation": "

Details of the crawler when the node represents a crawler.

" } }, - "Name": { + "UniqueId": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the AWS Glue component represented by the node.

" + "smithy.api#documentation": "

The unique Id assigned to the node within the workflow.

" } }, - "CrawlerDetails": { - "target": "com.amazonaws.glue#CrawlerNodeDetails", + "JobDetails": { + "target": "com.amazonaws.glue#JobNodeDetails", "traits": { - "smithy.api#documentation": "

Details of the crawler when the node represents a crawler.

" + "smithy.api#documentation": "

Details of the Job when the node represents a Job.

" } }, "Type": { @@ -11445,6 +11793,12 @@ "traits": { "smithy.api#documentation": "

The type of AWS Glue component represented by the node.

" } + }, + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the AWS Glue component represented by the node.

" + } } }, "traits": { @@ -11571,17 +11925,17 @@ "com.amazonaws.glue#Order": { "type": "structure", "members": { - "Column": { - "target": "com.amazonaws.glue#NameString", + "SortOrder": { + "target": "com.amazonaws.glue#IntegerFlag", "traits": { - "smithy.api#documentation": "

The name of the column.

", + "smithy.api#documentation": "

Indicates that the column is sorted in ascending order\n (== 1), or in descending order (==0).

", "smithy.api#required": {} } }, - "SortOrder": { - "target": "com.amazonaws.glue#IntegerFlag", + "Column": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Indicates that the column is sorted in ascending order\n (== 1), or in descending order (==0).

", + "smithy.api#documentation": "

The name of the column.

", "smithy.api#required": {} } } @@ -11630,22 +11984,16 @@ "com.amazonaws.glue#Partition": { "type": "structure", "members": { - "LastAccessTime": { + "CreationTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The last time at which the partition was accessed.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the catalog database in which to create the partition.

" + "smithy.api#documentation": "

The time at which the partition was created.

" } }, - "LastAnalyzedTime": { + "LastAccessTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The last time at which column statistics were computed for this\n partition.

" + "smithy.api#documentation": "

The last time at which the partition was accessed.

" } }, "Parameters": { @@ -11653,23 +12001,17 @@ "traits": { "smithy.api#documentation": "

These key-value pairs define partition parameters.

" } - }, - "CreationTime": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the partition was created.

" - } - }, - "StorageDescriptor": { - "target": "com.amazonaws.glue#StorageDescriptor", + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Provides information about the physical\n location where the partition is stored.

" + "smithy.api#documentation": "

The name of the catalog database in which to create the partition.

" } }, - "Values": { - "target": "com.amazonaws.glue#ValueStringList", + "LastAnalyzedTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The values of the partition.

" + "smithy.api#documentation": "

The last time at which column statistics were computed for this\n partition.

" } }, "TableName": { @@ -11683,6 +12025,18 @@ "traits": { "smithy.api#documentation": "

The ID of the Data Catalog in which the partition resides.

" } + }, + "Values": { + "target": "com.amazonaws.glue#ValueStringList", + "traits": { + "smithy.api#documentation": "

The values of the partition.

" + } + }, + "StorageDescriptor": { + "target": "com.amazonaws.glue#StorageDescriptor", + "traits": { + "smithy.api#documentation": "

Provides information about the physical\n location where the partition is stored.

" + } } }, "traits": { @@ -11715,15 +12069,89 @@ "target": "com.amazonaws.glue#PartitionError" } }, - "com.amazonaws.glue#PartitionInput": { + "com.amazonaws.glue#PartitionIndex": { "type": "structure", "members": { - "LastAnalyzedTime": { - "target": "com.amazonaws.glue#Timestamp", + "Keys": { + "target": "com.amazonaws.glue#KeyList", "traits": { - "smithy.api#documentation": "

The last time at which column statistics were computed for this partition.

" + "smithy.api#documentation": "

The keys for the partition index.

", + "smithy.api#required": {} + } + }, + "IndexName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the partition index.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure for a partition index.

" + } + }, + "com.amazonaws.glue#PartitionIndexDescriptor": { + "type": "structure", + "members": { + "IndexStatus": { + "target": "com.amazonaws.glue#PartitionIndexStatus", + "traits": { + "smithy.api#documentation": "

The status of the partition index.

", + "smithy.api#required": {} + } + }, + "Keys": { + "target": "com.amazonaws.glue#KeySchemaElementList", + "traits": { + "smithy.api#documentation": "

A list of one or more keys, as KeySchemaElement structures, for the partition index.

", + "smithy.api#required": {} } }, + "IndexName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the partition index.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A descriptor for a partition index in a table.

" + } + }, + "com.amazonaws.glue#PartitionIndexDescriptorList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#PartitionIndexDescriptor" + } + }, + "com.amazonaws.glue#PartitionIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#PartitionIndex" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.glue#PartitionIndexStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + } + ] + } + }, + "com.amazonaws.glue#PartitionInput": { + "type": "structure", + "members": { "Values": { "target": "com.amazonaws.glue#ValueStringList", "traits": { @@ -11736,6 +12164,12 @@ "smithy.api#documentation": "

Provides information about the physical\n location where the partition is stored.

" } }, + "LastAnalyzedTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time at which column statistics were computed for this partition.

" + } + }, "Parameters": { "target": "com.amazonaws.glue#ParametersMap", "traits": { @@ -11847,6 +12281,12 @@ "com.amazonaws.glue#PhysicalConnectionRequirements": { "type": "structure", "members": { + "AvailabilityZone": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The connection's Availability Zone. This field is redundant because the specified subnet\n implies the Availability Zone to be used. Currently the field must be populated, but it will\n be deprecated in the future.

" + } + }, "SecurityGroupIdList": { "target": "com.amazonaws.glue#SecurityGroupIdList", "traits": { @@ -11858,12 +12298,6 @@ "traits": { "smithy.api#documentation": "

The subnet ID used by the connection.

" } - }, - "AvailabilityZone": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The connection's Availability Zone. This field is redundant because the specified subnet\n implies the Availability Zone to be used. Currently the field must be populated, but it will\n be deprecated in the future.

" - } } }, "traits": { @@ -11989,17 +12423,17 @@ "smithy.api#documentation": "

The value of the property.

" } }, - "Comparator": { - "target": "com.amazonaws.glue#Comparator", - "traits": { - "smithy.api#documentation": "

The comparator used to compare this property to others.

" - } - }, "Key": { "target": "com.amazonaws.glue#ValueString", "traits": { "smithy.api#documentation": "

The key of the property.

" } + }, + "Comparator": { + "target": "com.amazonaws.glue#Comparator", + "traits": { + "smithy.api#documentation": "

The comparator used to compare this property to others.

" + } } }, "traits": { @@ -12044,18 +12478,18 @@ "com.amazonaws.glue#PutDataCatalogEncryptionSettingsRequest": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog to set the security configuration for. If none is provided, the\n AWS account ID is used by default.

" + } + }, "DataCatalogEncryptionSettings": { "target": "com.amazonaws.glue#DataCatalogEncryptionSettings", "traits": { "smithy.api#documentation": "

The security configuration to set.

", "smithy.api#required": {} } - }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog to set the security configuration for. If none is provided, the\n AWS account ID is used by default.

" - } } } }, @@ -12095,6 +12529,18 @@ "com.amazonaws.glue#PutResourcePolicyRequest": { "type": "structure", "members": { + "ResourceArn": { + "target": "com.amazonaws.glue#GlueResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS Glue resource for the resource policy to be set. For more\n information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern\n

" + } + }, + "PolicyExistsCondition": { + "target": "com.amazonaws.glue#ExistCondition", + "traits": { + "smithy.api#documentation": "

A value of MUST_EXIST is used to update a policy. A value of\n NOT_EXIST is used to create a new policy. If a value of NONE or a\n null value is used, the call will not depend on the existence of a policy.

" + } + }, "PolicyHashCondition": { "target": "com.amazonaws.glue#HashString", "traits": { @@ -12113,18 +12559,6 @@ "smithy.api#documentation": "

Contains the policy document to set, in JSON format.

", "smithy.api#required": {} } - }, - "PolicyExistsCondition": { - "target": "com.amazonaws.glue#ExistCondition", - "traits": { - "smithy.api#documentation": "

A value of MUST_EXIST is used to update a policy. A value of\n NOT_EXIST is used to create a new policy. If a value of NONE or a\n null value is used, the call will not depend on the existence of a policy.

" - } - }, - "ResourceArn": { - "target": "com.amazonaws.glue#GlueResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the AWS Glue resource for the resource policy to be set. For more\n information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern\n

" - } } } }, @@ -12177,17 +12611,17 @@ "com.amazonaws.glue#PutWorkflowRunPropertiesRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", + "RunId": { + "target": "com.amazonaws.glue#IdString", "traits": { - "smithy.api#documentation": "

Name of the workflow which was run.

", + "smithy.api#documentation": "

The ID of the workflow run for which the run properties should be updated.

", "smithy.api#required": {} } }, - "RunId": { - "target": "com.amazonaws.glue#IdString", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The ID of the workflow run for which the run properties should be updated.

", + "smithy.api#documentation": "

Name of the workflow which was run.

", "smithy.api#required": {} } }, @@ -12329,17 +12763,17 @@ "com.amazonaws.glue#ResourceUri": { "type": "structure", "members": { - "Uri": { - "target": "com.amazonaws.glue#URI", - "traits": { - "smithy.api#documentation": "

The URI for accessing the resource.

" - } - }, "ResourceType": { "target": "com.amazonaws.glue#ResourceType", "traits": { "smithy.api#documentation": "

The type of the resource.

" } + }, + "Uri": { + "target": "com.amazonaws.glue#URI", + "traits": { + "smithy.api#documentation": "

The URI for accessing the resource.

" + } } }, "traits": { @@ -12387,12 +12821,19 @@ } ], "traits": { - "smithy.api#documentation": "

Restarts any completed nodes in a workflow run and resumes the run execution.

" + "smithy.api#documentation": "

Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.

" } }, "com.amazonaws.glue#ResumeWorkflowRunRequest": { "type": "structure", "members": { + "NodeIds": { + "target": "com.amazonaws.glue#NodeIdList", + "traits": { + "smithy.api#documentation": "

A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.

", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -12406,30 +12847,23 @@ "smithy.api#documentation": "

The ID of the workflow run to resume.

", "smithy.api#required": {} } - }, - "NodeIds": { - "target": "com.amazonaws.glue#NodeIdList", - "traits": { - "smithy.api#documentation": "

A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have an execution attempt in the original run.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.glue#ResumeWorkflowRunResponse": { "type": "structure", "members": { - "NodeIds": { - "target": "com.amazonaws.glue#NodeIdList", - "traits": { - "smithy.api#documentation": "

A list of the node IDs for the nodes that were actually restarted.

" - } - }, "RunId": { "target": "com.amazonaws.glue#IdString", "traits": { "smithy.api#documentation": "

The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.

" } + }, + "NodeIds": { + "target": "com.amazonaws.glue#NodeIdList", + "traits": { + "smithy.api#documentation": "

A list of the node IDs for the nodes that were actually restarted.

" + } } } }, @@ -12454,17 +12888,17 @@ "com.amazonaws.glue#S3Encryption": { "type": "structure", "members": { - "KmsKeyArn": { - "target": "com.amazonaws.glue#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

" - } - }, "S3EncryptionMode": { "target": "com.amazonaws.glue#S3EncryptionMode", "traits": { "smithy.api#documentation": "

The encryption mode to use for Amazon S3 data.

" } + }, + "KmsKeyArn": { + "target": "com.amazonaws.glue#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

" + } } }, "traits": { @@ -12505,6 +12939,12 @@ "smithy.api#documentation": "

A list of glob patterns used to exclude from the crawl.\n For more information, see Catalog Tables with a Crawler.

" } }, + "ConnectionName": { + "target": "com.amazonaws.glue#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

" + } + }, "Path": { "target": "com.amazonaws.glue#Path", "traits": { @@ -12528,17 +12968,17 @@ "com.amazonaws.glue#Schedule": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.glue#ScheduleState", - "traits": { - "smithy.api#documentation": "

The state of the schedule.

" - } - }, "ScheduleExpression": { "target": "com.amazonaws.glue#CronExpression", "traits": { "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" } + }, + "State": { + "target": "com.amazonaws.glue#ScheduleState", + "traits": { + "smithy.api#documentation": "

The state of the schedule.

" + } } }, "traits": { @@ -12632,17 +13072,17 @@ "com.amazonaws.glue#SchemaColumn": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.glue#ColumnNameString", - "traits": { - "smithy.api#documentation": "

The name of the column.

" - } - }, "DataType": { "target": "com.amazonaws.glue#ColumnTypeString", "traits": { "smithy.api#documentation": "

The type of data in the column.

" } + }, + "Name": { + "target": "com.amazonaws.glue#ColumnNameString", + "traits": { + "smithy.api#documentation": "

The name of the column.

" + } } }, "traits": { @@ -12683,27 +13123,15 @@ "traits": { "smithy.api#documentation": "

Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.

\n

You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.

", "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.glue#SearchTablesRequest": { - "type": "structure", - "members": { - "SortCriteria": { - "target": "com.amazonaws.glue#SortCriteria", - "traits": { - "smithy.api#documentation": "

A list of criteria for sorting the results by a field name, in an ascending or descending order.

" - } - }, - "Filters": { - "target": "com.amazonaws.glue#SearchPropertyPredicates", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

\n\t\n\t

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

" - } - }, + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#SearchTablesRequest": { + "type": "structure", + "members": { "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { @@ -12716,10 +13144,16 @@ "smithy.api#documentation": "

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

\n\t\n\t " } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "SearchText": { + "target": "com.amazonaws.glue#ValueString", "traits": { - "smithy.api#documentation": "

The maximum number of tables to return in a single response.

" + "smithy.api#documentation": "

A string used for a text search.

\n\t

Specifying a value in quotes filters based on an exact match to the value.

" + } + }, + "Filters": { + "target": "com.amazonaws.glue#SearchPropertyPredicates", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

\n\t\n\t

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

" } }, "NextToken": { @@ -12728,10 +13162,16 @@ "smithy.api#documentation": "

A continuation token, included if this is a continuation call.

" } }, - "SearchText": { - "target": "com.amazonaws.glue#ValueString", + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", "traits": { - "smithy.api#documentation": "

A string used for a text search.

\n\t

Specifying a value in quotes filters based on an exact match to the value.

" + "smithy.api#documentation": "

The maximum number of tables to return in a single response.

" + } + }, + "SortCriteria": { + "target": "com.amazonaws.glue#SortCriteria", + "traits": { + "smithy.api#documentation": "

A list of criteria for sorting the results by a field name, in an ascending or descending order.

" } } } @@ -12739,29 +13179,23 @@ "com.amazonaws.glue#SearchTablesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#Token", - "traits": { - "smithy.api#documentation": "

A continuation token, present if the current list segment is not the last.

" - } - }, "TableList": { "target": "com.amazonaws.glue#TableList", "traits": { "smithy.api#documentation": "

A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.

" } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token", + "traits": { + "smithy.api#documentation": "

A continuation token, present if the current list segment is not the last.

" + } } } }, "com.amazonaws.glue#SecurityConfiguration": { "type": "structure", "members": { - "EncryptionConfiguration": { - "target": "com.amazonaws.glue#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

The encryption configuration associated with this security configuration.

" - } - }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -12773,6 +13207,12 @@ "traits": { "smithy.api#documentation": "

The time at which this security configuration was created.

" } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.glue#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration associated with this security configuration.

" + } } }, "traits": { @@ -12822,16 +13262,16 @@ "com.amazonaws.glue#SerDeInfo": { "type": "structure", "members": { - "SerializationLibrary": { + "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Usually the class that implements the SerDe. An example is\n org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

" + "smithy.api#documentation": "

Name of the SerDe.

" } }, - "Name": { + "SerializationLibrary": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Name of the SerDe.

" + "smithy.api#documentation": "

Usually the class that implements the SerDe. An example is\n org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

" } }, "Parameters": { @@ -12848,12 +13288,6 @@ "com.amazonaws.glue#SkewedInfo": { "type": "structure", "members": { - "SkewedColumnNames": { - "target": "com.amazonaws.glue#NameStringList", - "traits": { - "smithy.api#documentation": "

A list of names of columns that contain skewed values.

" - } - }, "SkewedColumnValueLocationMaps": { "target": "com.amazonaws.glue#LocationMap", "traits": { @@ -12865,6 +13299,12 @@ "traits": { "smithy.api#documentation": "

A list of values that appear so frequently as to be considered\n skewed.

" } + }, + "SkewedColumnNames": { + "target": "com.amazonaws.glue#NameStringList", + "traits": { + "smithy.api#documentation": "

A list of names of columns that contain skewed values.

" + } } }, "traits": { @@ -13046,17 +13486,17 @@ "com.amazonaws.glue#StartExportLabelsTaskRunRequest": { "type": "structure", "members": { - "OutputS3Path": { - "target": "com.amazonaws.glue#UriString", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

The Amazon S3 path where you export the labels.

", + "smithy.api#documentation": "

The unique identifier of the machine learning transform.

", "smithy.api#required": {} } }, - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "OutputS3Path": { + "target": "com.amazonaws.glue#UriString", "traits": { - "smithy.api#documentation": "

The unique identifier of the machine learning transform.

", + "smithy.api#documentation": "

The Amazon S3 path where you export the labels.

", "smithy.api#required": {} } } @@ -13105,10 +13545,11 @@ "com.amazonaws.glue#StartImportLabelsTaskRunRequest": { "type": "structure", "members": { - "ReplaceAllLabels": { - "target": "com.amazonaws.glue#ReplaceBoolean", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

Indicates whether to overwrite your existing labels.

" + "smithy.api#documentation": "

The unique identifier of the machine learning transform.

", + "smithy.api#required": {} } }, "InputS3Path": { @@ -13118,11 +13559,10 @@ "smithy.api#required": {} } }, - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "ReplaceAllLabels": { + "target": "com.amazonaws.glue#ReplaceBoolean", "traits": { - "smithy.api#documentation": "

The unique identifier of the machine learning transform.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates whether to overwrite your existing labels.

" } } } @@ -13173,38 +13613,28 @@ "com.amazonaws.glue#StartJobRunRequest": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the job definition to use.

", - "smithy.api#required": {} - } - }, - "JobRunId": { - "target": "com.amazonaws.glue#IdString", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The ID of a previous JobRun to retry.

" + "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:

\n " } }, - "SecurityConfiguration": { - "target": "com.amazonaws.glue#NameString", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this job\n run.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n " } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "NotificationProperty": { + "target": "com.amazonaws.glue#NotificationProperty", "traits": { - "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. The default\n is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" + "smithy.api#documentation": "

Specifies configuration properties of a job run notification.

" } }, - "AllocatedCapacity": { - "target": "com.amazonaws.glue#IntegerValue", + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#deprecated": { - "message": "This property is deprecated, use MaxCapacity instead." - }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

" + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used with this job\n run.

" } }, "Arguments": { @@ -13213,22 +13643,32 @@ "smithy.api#documentation": "

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", + "JobName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:

\n " + "smithy.api#documentation": "

The name of the job definition to use.

", + "smithy.api#required": {} } }, - "NotificationProperty": { - "target": "com.amazonaws.glue#NotificationProperty", + "Timeout": { + "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

Specifies configuration properties of a job run notification.

" + "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. The default\n is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" } }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", + "JobRunId": { + "target": "com.amazonaws.glue#IdString", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

\n " + "smithy.api#documentation": "

The ID of a previous JobRun to retry.

" + } + }, + "AllocatedCapacity": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#deprecated": { + "message": "This property is deprecated, use MaxCapacity instead." + }, + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

" } }, "NumberOfWorkers": { @@ -13337,17 +13777,17 @@ "com.amazonaws.glue#StartMLLabelingSetGenerationTaskRunRequest": { "type": "structure", "members": { - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "OutputS3Path": { + "target": "com.amazonaws.glue#UriString", "traits": { - "smithy.api#documentation": "

The unique identifier of the machine learning transform.

", + "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling\n set.

", "smithy.api#required": {} } }, - "OutputS3Path": { - "target": "com.amazonaws.glue#UriString", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling\n set.

", + "smithy.api#documentation": "

The unique identifier of the machine learning transform.

", "smithy.api#required": {} } } @@ -13665,34 +14105,22 @@ "com.amazonaws.glue#StorageDescriptor": { "type": "structure", "members": { - "InputFormat": { - "target": "com.amazonaws.glue#FormatString", - "traits": { - "smithy.api#documentation": "

The input format: SequenceFileInputFormat (binary),\n or TextInputFormat, or a custom format.

" - } - }, - "Columns": { - "target": "com.amazonaws.glue#ColumnList", - "traits": { - "smithy.api#documentation": "

A list of the Columns in the table.

" - } - }, - "NumberOfBuckets": { - "target": "com.amazonaws.glue#Integer", + "SkewedInfo": { + "target": "com.amazonaws.glue#SkewedInfo", "traits": { - "smithy.api#documentation": "

Must be specified if the table contains any dimension columns.

" + "smithy.api#documentation": "

The information about values that appear frequently in a column (skewed values).

" } }, - "Location": { - "target": "com.amazonaws.glue#LocationString", + "Compressed": { + "target": "com.amazonaws.glue#Boolean", "traits": { - "smithy.api#documentation": "

The physical location of the table. By default, this takes the form of the warehouse\n location, followed by the database location in the warehouse, followed by the table\n name.

" + "smithy.api#documentation": "

\n True if the data in the table is compressed, or False if\n not.

" } }, - "SkewedInfo": { - "target": "com.amazonaws.glue#SkewedInfo", + "Parameters": { + "target": "com.amazonaws.glue#ParametersMap", "traits": { - "smithy.api#documentation": "

The information about values that appear frequently in a column (skewed values).

" + "smithy.api#documentation": "

The user-supplied properties in key-value form.

" } }, "OutputFormat": { @@ -13701,22 +14129,22 @@ "smithy.api#documentation": "

The output format: SequenceFileOutputFormat (binary),\n or IgnoreKeyTextOutputFormat, or a custom format.

" } }, - "BucketColumns": { - "target": "com.amazonaws.glue#NameStringList", + "NumberOfBuckets": { + "target": "com.amazonaws.glue#Integer", "traits": { - "smithy.api#documentation": "

A list of reducer grouping columns, clustering columns, and\n bucketing columns in the table.

" + "smithy.api#documentation": "

Must be specified if the table contains any dimension columns.

" } }, - "Parameters": { - "target": "com.amazonaws.glue#ParametersMap", + "InputFormat": { + "target": "com.amazonaws.glue#FormatString", "traits": { - "smithy.api#documentation": "

The user-supplied properties in key-value form.

" + "smithy.api#documentation": "

The input format: SequenceFileInputFormat (binary),\n or TextInputFormat, or a custom format.

" } }, - "Compressed": { - "target": "com.amazonaws.glue#Boolean", + "SerdeInfo": { + "target": "com.amazonaws.glue#SerDeInfo", "traits": { - "smithy.api#documentation": "

\n True if the data in the table is compressed, or False if\n not.

" + "smithy.api#documentation": "

The serialization/deserialization (SerDe) information.

" } }, "SortColumns": { @@ -13725,10 +14153,10 @@ "smithy.api#documentation": "

A list specifying the sort order of each bucket in the table.

" } }, - "SerdeInfo": { - "target": "com.amazonaws.glue#SerDeInfo", + "BucketColumns": { + "target": "com.amazonaws.glue#NameStringList", "traits": { - "smithy.api#documentation": "

The serialization/deserialization (SerDe) information.

" + "smithy.api#documentation": "

A list of reducer grouping columns, clustering columns, and\n bucketing columns in the table.

" } }, "StoredAsSubDirectories": { @@ -13736,6 +14164,18 @@ "traits": { "smithy.api#documentation": "

\n True if the table data is stored in subdirectories, or False if\n not.

" } + }, + "Columns": { + "target": "com.amazonaws.glue#ColumnList", + "traits": { + "smithy.api#documentation": "

A list of the Columns in the table.

" + } + }, + "Location": { + "target": "com.amazonaws.glue#LocationString", + "traits": { + "smithy.api#documentation": "

The physical location of the table. By default, this takes the form of the warehouse\n location, followed by the database location in the warehouse, followed by the table\n name.

" + } } }, "traits": { @@ -13745,13 +14185,6 @@ "com.amazonaws.glue#StringColumnStatisticsData": { "type": "structure", "members": { - "AverageLength": { - "target": "com.amazonaws.glue#NonNegativeDouble", - "traits": { - "smithy.api#documentation": "

Average value of the column.

", - "smithy.api#required": {} - } - }, "NumberOfDistinctValues": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { @@ -13762,7 +14195,14 @@ "MaximumLength": { "target": "com.amazonaws.glue#NonNegativeLong", "traits": { - "smithy.api#documentation": "

Maximum value of the column.

", + "smithy.api#documentation": "

Maximum value of the column.

", + "smithy.api#required": {} + } + }, + "AverageLength": { + "target": "com.amazonaws.glue#NonNegativeDouble", + "traits": { + "smithy.api#documentation": "

Average value of the column.

", "smithy.api#required": {} } }, @@ -13787,10 +14227,10 @@ "com.amazonaws.glue#Table": { "type": "structure", "members": { - "LastAccessTime": { - "target": "com.amazonaws.glue#Timestamp", + "TargetTable": { + "target": "com.amazonaws.glue#TableIdentifier", "traits": { - "smithy.api#documentation": "

The last time that the table was accessed. This is usually taken from HDFS, and might not\n be reliable.

" + "smithy.api#documentation": "

A TableIdentifier structure that describes a target table for resource linking.

" } }, "CatalogId": { @@ -13799,64 +14239,59 @@ "smithy.api#documentation": "

The ID of the Data Catalog in which the table resides.

" } }, - "PartitionKeys": { - "target": "com.amazonaws.glue#ColumnList", - "traits": { - "smithy.api#documentation": "

A list of columns by which the table is partitioned. Only primitive\n types are supported as partition keys.

\n\t

When you create a table used by Amazon Athena, and you do not specify any\n partitionKeys, you must at least set the value of partitionKeys to\n an empty list. For example:

\n

\n \"PartitionKeys\": []\n

" - } - }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", - "traits": { - "smithy.api#documentation": "

A description of the table.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", + "IsRegisteredWithLakeFormation": { + "target": "com.amazonaws.glue#Boolean", "traits": { - "smithy.api#documentation": "

The name of the database where the table metadata resides.\n For Hive compatibility, this must be all lowercase.

" + "smithy.api#documentation": "

Indicates whether the table has been registered with AWS Lake Formation.

" } }, - "TableType": { - "target": "com.amazonaws.glue#TableTypeString", + "LastAnalyzedTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

" + "smithy.api#documentation": "

The last time that column statistics were computed for this table.

" } }, - "TargetTable": { - "target": "com.amazonaws.glue#TableIdentifier", + "ViewExpandedText": { + "target": "com.amazonaws.glue#ViewTextString", "traits": { - "smithy.api#documentation": "

A TableIdentifier structure that describes a target table for resource linking.

" + "smithy.api#documentation": "

If the table is a view, the expanded text of the view; otherwise null.

" } }, - "CreatedBy": { + "Owner": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The person or entity who created the table.

" + "smithy.api#documentation": "

The owner of the table.

" } }, - "Parameters": { - "target": "com.amazonaws.glue#ParametersMap", + "PartitionKeys": { + "target": "com.amazonaws.glue#ColumnList", "traits": { - "smithy.api#documentation": "

These key-value pairs define properties associated with the table.

" + "smithy.api#documentation": "

A list of columns by which the table is partitioned. Only primitive\n types are supported as partition keys.

\n\t

When you create a table used by Amazon Athena, and you do not specify any\n partitionKeys, you must at least set the value of partitionKeys to\n an empty list. For example:

\n

\n \"PartitionKeys\": []\n

" } }, - "CreateTime": { + "UpdateTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The time when the table definition was created in the Data Catalog.

" + "smithy.api#documentation": "

The last time that the table was updated.

" } }, - "ViewExpandedText": { + "ViewOriginalText": { "target": "com.amazonaws.glue#ViewTextString", "traits": { - "smithy.api#documentation": "

If the table is a view, the expanded text of the view; otherwise null.

" + "smithy.api#documentation": "

If the table is a view, the original text of the view; otherwise null.

" } }, - "Retention": { - "target": "com.amazonaws.glue#NonNegativeInteger", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The retention time for this table.

" + "smithy.api#documentation": "

The table name. For Hive compatibility, this must be entirely\n lowercase.

", + "smithy.api#required": {} + } + }, + "CreatedBy": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The person or entity who created the table.

" } }, "StorageDescriptor": { @@ -13865,41 +14300,46 @@ "smithy.api#documentation": "

A storage descriptor containing information about the physical storage\n of this table.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

The table name. For Hive compatibility, this must be entirely\n lowercase.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the table.

" } }, - "IsRegisteredWithLakeFormation": { - "target": "com.amazonaws.glue#Boolean", + "LastAccessTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates whether the table has been registered with AWS Lake Formation.

" + "smithy.api#documentation": "

The last time that the table was accessed. This is usually taken from HDFS, and might not\n be reliable.

" } }, - "ViewOriginalText": { - "target": "com.amazonaws.glue#ViewTextString", + "Retention": { + "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

If the table is a view, the original text of the view; otherwise null.

" + "smithy.api#documentation": "

The retention time for this table.

" } }, - "Owner": { - "target": "com.amazonaws.glue#NameString", + "CreateTime": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The owner of the table.

" + "smithy.api#documentation": "

The time when the table definition was created in the Data Catalog.

" } }, - "UpdateTime": { - "target": "com.amazonaws.glue#Timestamp", + "Parameters": { + "target": "com.amazonaws.glue#ParametersMap", "traits": { - "smithy.api#documentation": "

The last time that the table was updated.

" + "smithy.api#documentation": "

These key-value pairs define properties associated with the table.

" } }, - "LastAnalyzedTime": { - "target": "com.amazonaws.glue#Timestamp", + "TableType": { + "target": "com.amazonaws.glue#TableTypeString", "traits": { - "smithy.api#documentation": "

The last time that column statistics were computed for this table.

" + "smithy.api#documentation": "

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database where the table metadata resides.\n For Hive compatibility, this must be all lowercase.

" } } }, @@ -13936,12 +14376,6 @@ "com.amazonaws.glue#TableIdentifier": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the table resides.

" - } - }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -13953,6 +14387,12 @@ "traits": { "smithy.api#documentation": "

The name of the target table.

" } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which the table resides.

" + } } }, "traits": { @@ -13962,24 +14402,6 @@ "com.amazonaws.glue#TableInput": { "type": "structure", "members": { - "ViewExpandedText": { - "target": "com.amazonaws.glue#ViewTextString", - "traits": { - "smithy.api#documentation": "

If the table is a view, the expanded text of the view; otherwise null.

" - } - }, - "Retention": { - "target": "com.amazonaws.glue#NonNegativeInteger", - "traits": { - "smithy.api#documentation": "

The retention time for this table.

" - } - }, - "LastAnalyzedTime": { - "target": "com.amazonaws.glue#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that column statistics were computed for this table.

" - } - }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -13993,10 +14415,16 @@ "smithy.api#documentation": "

A storage descriptor containing information about the physical storage\n of this table.

" } }, - "TableType": { - "target": "com.amazonaws.glue#TableTypeString", + "Retention": { + "target": "com.amazonaws.glue#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

" + "smithy.api#documentation": "

The retention time for this table.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the table.

" } }, "Parameters": { @@ -14005,16 +14433,16 @@ "smithy.api#documentation": "

These key-value pairs define properties associated with the table.

" } }, - "ViewOriginalText": { - "target": "com.amazonaws.glue#ViewTextString", + "TableType": { + "target": "com.amazonaws.glue#TableTypeString", "traits": { - "smithy.api#documentation": "

If the table is a view, the original text of the view; otherwise null.

" + "smithy.api#documentation": "

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

" } }, - "Owner": { - "target": "com.amazonaws.glue#NameString", + "TargetTable": { + "target": "com.amazonaws.glue#TableIdentifier", "traits": { - "smithy.api#documentation": "

The table owner.

" + "smithy.api#documentation": "

A TableIdentifier structure that describes a target table for resource linking.

" } }, "PartitionKeys": { @@ -14023,22 +14451,34 @@ "smithy.api#documentation": "

A list of columns by which the table is partitioned. Only primitive\n types are supported as partition keys.

\n\t

When you create a table used by Amazon Athena, and you do not specify any\n partitionKeys, you must at least set the value of partitionKeys to\n an empty list. For example:

\n

\n \"PartitionKeys\": []\n

" } }, - "TargetTable": { - "target": "com.amazonaws.glue#TableIdentifier", - "traits": { - "smithy.api#documentation": "

A TableIdentifier structure that describes a target table for resource linking.

" - } - }, "LastAccessTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { "smithy.api#documentation": "

The last time that the table was accessed.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "Owner": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A description of the table.

" + "smithy.api#documentation": "

The table owner.

" + } + }, + "ViewOriginalText": { + "target": "com.amazonaws.glue#ViewTextString", + "traits": { + "smithy.api#documentation": "

If the table is a view, the original text of the view; otherwise null.

" + } + }, + "ViewExpandedText": { + "target": "com.amazonaws.glue#ViewTextString", + "traits": { + "smithy.api#documentation": "

If the table is a view, the expanded text of the view; otherwise null.

" + } + }, + "LastAnalyzedTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that column statistics were computed for this table.

" } } }, @@ -14096,10 +14536,10 @@ "com.amazonaws.glue#TableVersionError": { "type": "structure", "members": { - "ErrorDetail": { - "target": "com.amazonaws.glue#ErrorDetail", + "TableName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The details about the error.

" + "smithy.api#documentation": "

The name of the table in question.

" } }, "VersionId": { @@ -14108,10 +14548,10 @@ "smithy.api#documentation": "

The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.

" } }, - "TableName": { - "target": "com.amazonaws.glue#NameString", + "ErrorDetail": { + "target": "com.amazonaws.glue#ErrorDetail", "traits": { - "smithy.api#documentation": "

The name of the table in question.

" + "smithy.api#documentation": "

The details about the error.

" } } }, @@ -14175,17 +14615,17 @@ "com.amazonaws.glue#TagResourceRequest": { "type": "structure", "members": { - "TagsToAdd": { - "target": "com.amazonaws.glue#TagsMap", + "ResourceArn": { + "target": "com.amazonaws.glue#GlueResourceArn", "traits": { - "smithy.api#documentation": "

Tags to add to this resource.

", + "smithy.api#documentation": "

The ARN of the AWS Glue resource to which to add the tags. For more\n information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.glue#GlueResourceArn", + "TagsToAdd": { + "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Glue resource to which to add the tags. For more\n information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern.

", + "smithy.api#documentation": "

Tags to add to this resource.

", "smithy.api#required": {} } } @@ -14222,10 +14662,10 @@ "com.amazonaws.glue#TaskRun": { "type": "structure", "members": { - "StartedOn": { - "target": "com.amazonaws.glue#Timestamp", + "TransformId": { + "target": "com.amazonaws.glue#HashString", "traits": { - "smithy.api#documentation": "

The date and time that this task run started.

" + "smithy.api#documentation": "

The unique identifier for the transform.

" } }, "ExecutionTime": { @@ -14234,22 +14674,22 @@ "smithy.api#documentation": "

The amount of time (in seconds) that the task run consumed resources.

" } }, - "Status": { - "target": "com.amazonaws.glue#TaskStatusType", - "traits": { - "smithy.api#documentation": "

The current status of the requested task run.

" - } - }, "Properties": { "target": "com.amazonaws.glue#TaskRunProperties", "traits": { "smithy.api#documentation": "

Specifies configuration properties associated with this task run.

" } }, - "TransformId": { - "target": "com.amazonaws.glue#HashString", + "ErrorString": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The unique identifier for the transform.

" + "smithy.api#documentation": "

The list of error strings associated with this task run.

" + } + }, + "StartedOn": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this task run started.

" } }, "CompletedOn": { @@ -14258,16 +14698,16 @@ "smithy.api#documentation": "

The last point in time that the requested task run was completed.

" } }, - "ErrorString": { - "target": "com.amazonaws.glue#GenericString", + "Status": { + "target": "com.amazonaws.glue#TaskStatusType", "traits": { - "smithy.api#documentation": "

The list of error strings associated with this task run.

" + "smithy.api#documentation": "

The current status of the requested task run.

" } }, - "LogGroupName": { - "target": "com.amazonaws.glue#GenericString", + "LastModifiedOn": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The names of the log group for secure logging, associated with this task run.

" + "smithy.api#documentation": "

The last point in time that the requested task run was updated.

" } }, "TaskRunId": { @@ -14276,10 +14716,10 @@ "smithy.api#documentation": "

The unique identifier for this task run.

" } }, - "LastModifiedOn": { - "target": "com.amazonaws.glue#Timestamp", + "LogGroupName": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The last point in time that the requested task run was updated.

" + "smithy.api#documentation": "

The names of the log group for secure logging, associated with this task run.

" } } }, @@ -14290,16 +14730,22 @@ "com.amazonaws.glue#TaskRunFilterCriteria": { "type": "structure", "members": { - "StartedBefore": { + "StartedAfter": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

Filter on task runs started before this date.

" + "smithy.api#documentation": "

Filter on task runs started after this date.

" } }, - "StartedAfter": { + "Status": { + "target": "com.amazonaws.glue#TaskStatusType", + "traits": { + "smithy.api#documentation": "

The current status of the task run.

" + } + }, + "StartedBefore": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

Filter on task runs started after this date.

" + "smithy.api#documentation": "

Filter on task runs started before this date.

" } }, "TaskRunType": { @@ -14307,12 +14753,6 @@ "traits": { "smithy.api#documentation": "

The type of task run.

" } - }, - "Status": { - "target": "com.amazonaws.glue#TaskStatusType", - "traits": { - "smithy.api#documentation": "

The current status of the task run.

" - } } }, "traits": { @@ -14328,10 +14768,16 @@ "com.amazonaws.glue#TaskRunProperties": { "type": "structure", "members": { - "TaskType": { - "target": "com.amazonaws.glue#TaskType", + "FindMatchesTaskRunProperties": { + "target": "com.amazonaws.glue#FindMatchesTaskRunProperties", "traits": { - "smithy.api#documentation": "

The type of task run.

" + "smithy.api#documentation": "

The configuration properties for a find matches task run.

" + } + }, + "ExportLabelsTaskRunProperties": { + "target": "com.amazonaws.glue#ExportLabelsTaskRunProperties", + "traits": { + "smithy.api#documentation": "

The configuration properties for an exporting labels task run.

" } }, "LabelingSetGenerationTaskRunProperties": { @@ -14346,16 +14792,10 @@ "smithy.api#documentation": "

The configuration properties for an importing labels task run.

" } }, - "FindMatchesTaskRunProperties": { - "target": "com.amazonaws.glue#FindMatchesTaskRunProperties", - "traits": { - "smithy.api#documentation": "

The configuration properties for a find matches task run.

" - } - }, - "ExportLabelsTaskRunProperties": { - "target": "com.amazonaws.glue#ExportLabelsTaskRunProperties", + "TaskType": { + "target": "com.amazonaws.glue#TaskType", "traits": { - "smithy.api#documentation": "

The configuration properties for an exporting labels task run.

" + "smithy.api#documentation": "

The type of task run.

" } } }, @@ -14496,16 +14936,16 @@ "com.amazonaws.glue#TransformFilterCriteria": { "type": "structure", "members": { - "Schema": { - "target": "com.amazonaws.glue#TransformSchema", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Filters on datasets with a specific schema. The Map\n object is an array of key-value pairs representing the schema this transform accepts, where\n Column is the name of a column, and Type is the type of the data\n such as an integer or string. Has an upper bound of 100 columns.

" + "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "CreatedAfter": { + "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

A unique transform name that is used to filter the machine learning transforms.

" + "smithy.api#documentation": "

The time and date after which the transforms were created.

" } }, "TransformType": { @@ -14514,28 +14954,22 @@ "smithy.api#documentation": "

The type of machine learning transform that is used to filter the machine learning\n transforms.

" } }, - "LastModifiedBefore": { - "target": "com.amazonaws.glue#Timestamp", + "Schema": { + "target": "com.amazonaws.glue#TransformSchema", "traits": { - "smithy.api#documentation": "

Filter on transforms last modified before this date.

" + "smithy.api#documentation": "

Filters on datasets with a specific schema. The Map\n object is an array of key-value pairs representing the schema this transform accepts, where\n Column is the name of a column, and Type is the type of the data\n such as an integer or string. Has an upper bound of 100 columns.

" } }, - "CreatedAfter": { + "CreatedBefore": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The time and date after which the transforms were created.

" - } - }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", - "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

The time and date before which the transforms were created.

" } }, - "CreatedBefore": { + "LastModifiedBefore": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The time and date before which the transforms were created.

" + "smithy.api#documentation": "

Filter on transforms last modified before this date.

" } }, "Status": { @@ -14549,6 +14983,12 @@ "traits": { "smithy.api#documentation": "

Filter on transforms last modified after this date.

" } + }, + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A unique transform name that is used to filter the machine learning transforms.

" + } } }, "traits": { @@ -14570,18 +15010,18 @@ "com.amazonaws.glue#TransformParameters": { "type": "structure", "members": { - "FindMatchesParameters": { - "target": "com.amazonaws.glue#FindMatchesParameters", - "traits": { - "smithy.api#documentation": "

The parameters for the find matches algorithm.

" - } - }, "TransformType": { "target": "com.amazonaws.glue#TransformType", "traits": { "smithy.api#documentation": "

The type of machine learning transform.

\n\t

For information about the types of machine learning transforms, see Creating Machine Learning Transforms.

", "smithy.api#required": {} } + }, + "FindMatchesParameters": { + "target": "com.amazonaws.glue#FindMatchesParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the find matches algorithm.

" + } } }, "traits": { @@ -14630,17 +15070,17 @@ "com.amazonaws.glue#TransformSortCriteria": { "type": "structure", "members": { - "Column": { - "target": "com.amazonaws.glue#TransformSortColumnType", + "SortDirection": { + "target": "com.amazonaws.glue#SortDirectionType", "traits": { - "smithy.api#documentation": "

The column to be used in the sorting criteria that are associated with the machine\n learning transform.

", + "smithy.api#documentation": "

The sort direction to be used in the sorting criteria that are associated with the machine\n learning transform.

", "smithy.api#required": {} } }, - "SortDirection": { - "target": "com.amazonaws.glue#SortDirectionType", + "Column": { + "target": "com.amazonaws.glue#TransformSortColumnType", "traits": { - "smithy.api#documentation": "

The sort direction to be used in the sorting criteria that are associated with the machine\n learning transform.

", + "smithy.api#documentation": "

The column to be used in the sorting criteria that are associated with the machine\n learning transform.

", "smithy.api#required": {} } } @@ -14682,34 +15122,22 @@ "com.amazonaws.glue#Trigger": { "type": "structure", "members": { - "Predicate": { - "target": "com.amazonaws.glue#Predicate", - "traits": { - "smithy.api#documentation": "

The predicate of this trigger, which defines when it will fire.

" - } - }, "Type": { "target": "com.amazonaws.glue#TriggerType", "traits": { "smithy.api#documentation": "

The type of trigger that this is.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "Predicate": { + "target": "com.amazonaws.glue#Predicate", "traits": { - "smithy.api#documentation": "

The name of the trigger.

" + "smithy.api#documentation": "

The predicate of this trigger, which defines when it will fire.

" } }, - "WorkflowName": { + "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the workflow associated with the trigger.

" - } - }, - "Actions": { - "target": "com.amazonaws.glue#ActionList", - "traits": { - "smithy.api#documentation": "

The actions initiated by this trigger.

" + "smithy.api#documentation": "

The name of the trigger.

" } }, "Id": { @@ -14724,16 +15152,28 @@ "smithy.api#documentation": "

A description of this trigger.

" } }, + "State": { + "target": "com.amazonaws.glue#TriggerState", + "traits": { + "smithy.api#documentation": "

The current state of the trigger.

" + } + }, "Schedule": { "target": "com.amazonaws.glue#GenericString", "traits": { "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based\n Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" } }, - "State": { - "target": "com.amazonaws.glue#TriggerState", + "WorkflowName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The current state of the trigger.

" + "smithy.api#documentation": "

The name of the workflow associated with the trigger.

" + } + }, + "Actions": { + "target": "com.amazonaws.glue#ActionList", + "traits": { + "smithy.api#documentation": "

The actions initiated by this trigger.

" } } }, @@ -14828,16 +15268,16 @@ "com.amazonaws.glue#TriggerUpdate": { "type": "structure", "members": { - "Predicate": { - "target": "com.amazonaws.glue#Predicate", + "Schedule": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The predicate of this trigger, which defines when it will fire.

" + "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based\n Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A description of this trigger.

" + "smithy.api#documentation": "

Reserved for future use.

" } }, "Actions": { @@ -14846,16 +15286,16 @@ "smithy.api#documentation": "

The actions initiated by this trigger.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "Description": { + "target": "com.amazonaws.glue#DescriptionString", "traits": { - "smithy.api#documentation": "

Reserved for future use.

" + "smithy.api#documentation": "

A description of this trigger.

" } }, - "Schedule": { - "target": "com.amazonaws.glue#GenericString", + "Predicate": { + "target": "com.amazonaws.glue#Predicate", "traits": { - "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based\n Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" + "smithy.api#documentation": "

The predicate of this trigger, which defines when it will fire.

" } } }, @@ -14912,17 +15352,17 @@ "com.amazonaws.glue#UntagResourceRequest": { "type": "structure", "members": { - "TagsToRemove": { - "target": "com.amazonaws.glue#TagKeysList", + "ResourceArn": { + "target": "com.amazonaws.glue#GlueResourceArn", "traits": { - "smithy.api#documentation": "

Tags to remove from this resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to remove the tags.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.glue#GlueResourceArn", + "TagsToRemove": { + "target": "com.amazonaws.glue#TagKeysList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to remove the tags.

", + "smithy.api#documentation": "

Tags to remove from this resource.

", "smithy.api#required": {} } } @@ -14976,6 +15416,12 @@ "com.amazonaws.glue#UpdateClassifierRequest": { "type": "structure", "members": { + "XMLClassifier": { + "target": "com.amazonaws.glue#UpdateXMLClassifierRequest", + "traits": { + "smithy.api#documentation": "

An XMLClassifier object with updated fields.

" + } + }, "GrokClassifier": { "target": "com.amazonaws.glue#UpdateGrokClassifierRequest", "traits": { @@ -14988,12 +15434,6 @@ "smithy.api#documentation": "

A CsvClassifier object with updated fields.

" } }, - "XMLClassifier": { - "target": "com.amazonaws.glue#UpdateXMLClassifierRequest", - "traits": { - "smithy.api#documentation": "

An XMLClassifier object with updated fields.

" - } - }, "JsonClassifier": { "target": "com.amazonaws.glue#UpdateJsonClassifierRequest", "traits": { @@ -15038,10 +15478,10 @@ "com.amazonaws.glue#UpdateColumnStatisticsForPartitionRequest": { "type": "structure", "members": { - "DatabaseName": { + "TableName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", + "smithy.api#documentation": "

The name of the partitions' table.

", "smithy.api#required": {} } }, @@ -15052,12 +15492,6 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" - } - }, "PartitionValues": { "target": "com.amazonaws.glue#ValueStringList", "traits": { @@ -15065,12 +15499,18 @@ "smithy.api#required": {} } }, - "TableName": { + "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the partitions' table.

", + "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", "smithy.api#required": {} } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + } } } }, @@ -15117,10 +15557,10 @@ "com.amazonaws.glue#UpdateColumnStatisticsForTableRequest": { "type": "structure", "members": { - "DatabaseName": { + "TableName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", + "smithy.api#documentation": "

The name of the partitions' table.

", "smithy.api#required": {} } }, @@ -15130,17 +15570,17 @@ "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" } }, - "TableName": { - "target": "com.amazonaws.glue#NameString", + "ColumnStatisticsList": { + "target": "com.amazonaws.glue#UpdateColumnStatisticsList", "traits": { - "smithy.api#documentation": "

The name of the partitions' table.

", + "smithy.api#documentation": "

A list of the column statistics.

", "smithy.api#required": {} } }, - "ColumnStatisticsList": { - "target": "com.amazonaws.glue#UpdateColumnStatisticsList", + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A list of the column statistics.

", + "smithy.api#documentation": "

The name of the catalog database where the partitions reside.

", "smithy.api#required": {} } } @@ -15198,10 +15638,11 @@ "com.amazonaws.glue#UpdateConnectionRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "ConnectionInput": { + "target": "com.amazonaws.glue#ConnectionInput", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

A ConnectionInput object that redefines the connection\n in question.

", + "smithy.api#required": {} } }, "Name": { @@ -15211,11 +15652,10 @@ "smithy.api#required": {} } }, - "ConnectionInput": { - "target": "com.amazonaws.glue#ConnectionInput", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

A ConnectionInput object that redefines the connection\n in question.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" } } } @@ -15256,29 +15696,28 @@ "com.amazonaws.glue#UpdateCrawlerRequest": { "type": "structure", "members": { - "CrawlerSecurityConfiguration": { - "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", + "Role": { + "target": "com.amazonaws.glue#Role", "traits": { - "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used by this\n crawler.

" + "smithy.api#documentation": "

The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler\n to access customer resources.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "TablePrefix": { + "target": "com.amazonaws.glue#TablePrefix", "traits": { - "smithy.api#documentation": "

Name of the new crawler.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The table prefix used for catalog tables that are created.

" } }, - "Schedule": { - "target": "com.amazonaws.glue#CronExpression", + "Classifiers": { + "target": "com.amazonaws.glue#ClassifierNameList", "traits": { - "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" + "smithy.api#documentation": "

A list of custom classifiers that the user\n has registered. By default, all built-in classifiers are included in a crawl,\n but these custom classifiers always override the default classifiers\n for a given classification.

" } }, - "Configuration": { - "target": "com.amazonaws.glue#CrawlerConfiguration", + "CrawlerSecurityConfiguration": { + "target": "com.amazonaws.glue#CrawlerSecurityConfiguration", "traits": { - "smithy.api#documentation": "

Crawler configuration information. This versioned JSON string allows users\n to specify aspects of a crawler's behavior.\n For more information, see Configuring a Crawler.

" + "smithy.api#documentation": "

The name of the SecurityConfiguration structure to be used by this\n crawler.

" } }, "DatabaseName": { @@ -15287,40 +15726,41 @@ "smithy.api#documentation": "

The AWS Glue database where results are stored, such as:\n arn:aws:daylight:us-east-1::database/sometable/*.

" } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionStringRemovable", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A description of the new crawler.

" + "smithy.api#documentation": "

Name of the new crawler.

", + "smithy.api#required": {} } }, - "Classifiers": { - "target": "com.amazonaws.glue#ClassifierNameList", + "Schedule": { + "target": "com.amazonaws.glue#CronExpression", "traits": { - "smithy.api#documentation": "

A list of custom classifiers that the user\n has registered. By default, all built-in classifiers are included in a crawl,\n but these custom classifiers always override the default classifiers\n for a given classification.

" + "smithy.api#documentation": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" } }, - "TablePrefix": { - "target": "com.amazonaws.glue#TablePrefix", + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#SchemaChangePolicy", "traits": { - "smithy.api#documentation": "

The table prefix used for catalog tables that are created.

" + "smithy.api#documentation": "

The policy for the crawler's update and deletion behavior.

" } }, - "Targets": { - "target": "com.amazonaws.glue#CrawlerTargets", + "Configuration": { + "target": "com.amazonaws.glue#CrawlerConfiguration", "traits": { - "smithy.api#documentation": "

A list of targets to crawl.

" + "smithy.api#documentation": "

Crawler configuration information. This versioned JSON string allows users\n to specify aspects of a crawler's behavior.\n For more information, see Configuring a Crawler.

" } }, - "Role": { - "target": "com.amazonaws.glue#Role", + "Targets": { + "target": "com.amazonaws.glue#CrawlerTargets", "traits": { - "smithy.api#documentation": "

The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler\n to access customer resources.

" + "smithy.api#documentation": "

A list of targets to crawl.

" } }, - "SchemaChangePolicy": { - "target": "com.amazonaws.glue#SchemaChangePolicy", + "Description": { + "target": "com.amazonaws.glue#DescriptionStringRemovable", "traits": { - "smithy.api#documentation": "

The policy for the crawler's update and deletion behavior.

" + "smithy.api#documentation": "

A description of the new crawler.

" } } } @@ -15361,18 +15801,18 @@ "com.amazonaws.glue#UpdateCrawlerScheduleRequest": { "type": "structure", "members": { + "Schedule": { + "target": "com.amazonaws.glue#CronExpression", + "traits": { + "smithy.api#documentation": "

The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" + } + }, "CrawlerName": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the crawler whose schedule to update.

", "smithy.api#required": {} } - }, - "Schedule": { - "target": "com.amazonaws.glue#CronExpression", - "traits": { - "smithy.api#documentation": "

The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run\n something every day at 12:15 UTC, you would specify:\n cron(15 12 * * ? *).

" - } } } }, @@ -15383,16 +15823,23 @@ "com.amazonaws.glue#UpdateCsvClassifierRequest": { "type": "structure", "members": { - "DisableValueTrimming": { - "target": "com.amazonaws.glue#NullableBoolean", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Specifies not to trim values before identifying the type of column values. The default value is true.

" + "smithy.api#documentation": "

The name of the classifier.

", + "smithy.api#required": {} } }, - "Delimiter": { - "target": "com.amazonaws.glue#CsvColumnDelimiter", + "ContainsHeader": { + "target": "com.amazonaws.glue#CsvHeaderOption", "traits": { - "smithy.api#documentation": "

A custom symbol to denote what separates each column entry in the row.

" + "smithy.api#documentation": "

Indicates whether the CSV file contains a header.

" + } + }, + "DisableValueTrimming": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies not to trim values before identifying the type of column values. The default value is true.

" } }, "Header": { @@ -15407,11 +15854,10 @@ "smithy.api#documentation": "

Enables the processing of files that contain only one column.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "Delimiter": { + "target": "com.amazonaws.glue#CsvColumnDelimiter", "traits": { - "smithy.api#documentation": "

The name of the classifier.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A custom symbol to denote what separates each column entry in the row.

" } }, "QuoteSymbol": { @@ -15419,12 +15865,6 @@ "traits": { "smithy.api#documentation": "

A custom symbol to denote what combines content into a single column value. It must be\n different from the column delimiter.

" } - }, - "ContainsHeader": { - "target": "com.amazonaws.glue#CsvHeaderOption", - "traits": { - "smithy.api#documentation": "

Indicates whether the CSV file contains a header.

" - } } }, "traits": { @@ -15463,12 +15903,6 @@ "com.amazonaws.glue#UpdateDatabaseRequest": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the metadata database resides. If none is provided,\n the AWS account ID is used by default.

" - } - }, "DatabaseInput": { "target": "com.amazonaws.glue#DatabaseInput", "traits": { @@ -15482,6 +15916,12 @@ "smithy.api#documentation": "

The name of the database to update in the catalog. For Hive\n compatibility, this is folded to lowercase.

", "smithy.api#required": {} } + }, + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The ID of the Data Catalog in which the metadata database resides. If none is provided,\n the AWS account ID is used by default.

" + } } } }, @@ -15521,23 +15961,22 @@ "com.amazonaws.glue#UpdateDevEndpointRequest": { "type": "structure", "members": { - "EndpointName": { - "target": "com.amazonaws.glue#GenericString", + "AddArguments": { + "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The name of the DevEndpoint to be updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The map of arguments to add the map of arguments used to configure the\n DevEndpoint.

\n\t\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, - "DeletePublicKeys": { - "target": "com.amazonaws.glue#PublicKeysList", + "PublicKey": { + "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The list of public keys to be deleted from the DevEndpoint.

" + "smithy.api#documentation": "

The public key for the DevEndpoint to use.

" } }, - "DeleteArguments": { - "target": "com.amazonaws.glue#StringList", + "CustomLibraries": { + "target": "com.amazonaws.glue#DevEndpointCustomLibraries", "traits": { - "smithy.api#documentation": "

The list of argument keys to be deleted from the map of arguments used to configure the\n DevEndpoint.

" + "smithy.api#documentation": "

Custom Python or Java libraries to be loaded in the DevEndpoint.

" } }, "AddPublicKeys": { @@ -15546,22 +15985,17 @@ "smithy.api#documentation": "

The list of public keys for the DevEndpoint to use.

" } }, - "PublicKey": { + "EndpointName": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The public key for the DevEndpoint to use.

" - } - }, - "AddArguments": { - "target": "com.amazonaws.glue#MapValue", - "traits": { - "smithy.api#documentation": "

The map of arguments to add the map of arguments used to configure the\n DevEndpoint.

\n\t\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The name of the DevEndpoint to be updated.

", + "smithy.api#required": {} } }, - "CustomLibraries": { - "target": "com.amazonaws.glue#DevEndpointCustomLibraries", + "DeletePublicKeys": { + "target": "com.amazonaws.glue#PublicKeysList", "traits": { - "smithy.api#documentation": "

Custom Python or Java libraries to be loaded in the DevEndpoint.

" + "smithy.api#documentation": "

The list of public keys to be deleted from the DevEndpoint.

" } }, "UpdateEtlLibraries": { @@ -15569,6 +16003,12 @@ "traits": { "smithy.api#documentation": "

\n True if the list of custom libraries to be loaded in the development endpoint\n needs to be updated, or False if otherwise.

" } + }, + "DeleteArguments": { + "target": "com.amazonaws.glue#StringList", + "traits": { + "smithy.api#documentation": "

The list of argument keys to be deleted from the map of arguments used to configure the\n DevEndpoint.

" + } } } }, @@ -15579,10 +16019,11 @@ "com.amazonaws.glue#UpdateGrokClassifierRequest": { "type": "structure", "members": { - "CustomPatterns": { - "target": "com.amazonaws.glue#CustomPatterns", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Optional custom grok patterns used by this classifier.

" + "smithy.api#documentation": "

The name of the GrokClassifier.

", + "smithy.api#required": {} } }, "GrokPattern": { @@ -15597,11 +16038,10 @@ "smithy.api#documentation": "

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs,\n Amazon CloudWatch Logs, and so on.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", + "CustomPatterns": { + "target": "com.amazonaws.glue#CustomPatterns", "traits": { - "smithy.api#documentation": "

The name of the GrokClassifier.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Optional custom grok patterns used by this classifier.

" } } }, @@ -15671,18 +16111,18 @@ "com.amazonaws.glue#UpdateJsonClassifierRequest": { "type": "structure", "members": { - "JsonPath": { - "target": "com.amazonaws.glue#JsonPath", - "traits": { - "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" - } - }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

The name of the classifier.

", "smithy.api#required": {} } + }, + "JsonPath": { + "target": "com.amazonaws.glue#JsonPath", + "traits": { + "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" + } } }, "traits": { @@ -15721,16 +16161,22 @@ "com.amazonaws.glue#UpdateMLTransformRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

The unique name that you gave the transform when you created it.

" + "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" } }, - "Timeout": { - "target": "com.amazonaws.glue#Timeout", + "Role": { + "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required\n permissions.

" + } + }, + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when this task runs.

" } }, "Description": { @@ -15739,22 +16185,35 @@ "smithy.api#documentation": "

A description of the transform. The default is an empty string.

" } }, + "Timeout": { + "target": "com.amazonaws.glue#Timeout", + "traits": { + "smithy.api#documentation": "

The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + } + }, "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, - "NumberOfWorkers": { - "target": "com.amazonaws.glue#NullableInteger", + "WorkerType": { + "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when this task runs.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " } }, - "Role": { - "target": "com.amazonaws.glue#RoleString", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required\n permissions.

" + "smithy.api#documentation": "

The unique name that you gave the transform when you created it.

" + } + }, + "TransformId": { + "target": "com.amazonaws.glue#HashString", + "traits": { + "smithy.api#documentation": "

A unique identifier that was generated when the transform was created.

", + "smithy.api#required": {} } }, "MaxRetries": { @@ -15768,25 +16227,6 @@ "traits": { "smithy.api#documentation": "

The configuration parameters that are specific to the transform type (algorithm) used.\n Conditionally dependent on the transform type.

" } - }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", - "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" - } - }, - "WorkerType": { - "target": "com.amazonaws.glue#WorkerType", - "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " - } - }, - "TransformId": { - "target": "com.amazonaws.glue#HashString", - "traits": { - "smithy.api#documentation": "

A unique identifier that was generated when the transform was created.

", - "smithy.api#required": {} - } } } }, @@ -15833,6 +16273,20 @@ "com.amazonaws.glue#UpdatePartitionRequest": { "type": "structure", "members": { + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table in which the partition to be updated is located.

", + "smithy.api#required": {} + } + }, + "PartitionInput": { + "target": "com.amazonaws.glue#PartitionInput", + "traits": { + "smithy.api#documentation": "

The new partition object to update the partition to.

\n\t\n\t

The Values property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.

", + "smithy.api#required": {} + } + }, "PartitionValueList": { "target": "com.amazonaws.glue#BoundedPartitionValueList", "traits": { @@ -15852,20 +16306,6 @@ "smithy.api#documentation": "

The name of the catalog database in which the table in question\n resides.

", "smithy.api#required": {} } - }, - "TableName": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the table in which the partition to be updated is located.

", - "smithy.api#required": {} - } - }, - "PartitionInput": { - "target": "com.amazonaws.glue#PartitionInput", - "traits": { - "smithy.api#documentation": "

The new partition object to update the partition to.

\n\t\n\t

The Values property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.

", - "smithy.api#required": {} - } } } }, @@ -15911,10 +16351,10 @@ "com.amazonaws.glue#UpdateTableRequest": { "type": "structure", "members": { - "SkipArchive": { - "target": "com.amazonaws.glue#BooleanNullable", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

By default, UpdateTable always creates an archived version of the table\n before updating it. However, if skipArchive is set to true,\n UpdateTable does not create the archived version.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" } }, "DatabaseName": { @@ -15924,10 +16364,10 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", + "SkipArchive": { + "target": "com.amazonaws.glue#BooleanNullable", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

By default, UpdateTable always creates an archived version of the table\n before updating it. However, if skipArchive is set to true,\n UpdateTable does not create the archived version.

" } }, "TableInput": { @@ -16034,19 +16474,13 @@ "com.amazonaws.glue#UpdateUserDefinedFunctionRequest": { "type": "structure", "members": { - "FunctionInput": { - "target": "com.amazonaws.glue#UserDefinedFunctionInput", + "FunctionName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A FunctionInput object that redefines the function in the Data\n Catalog.

", + "smithy.api#documentation": "

The name of the function.

", "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.glue#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the function to be updated is located. If none is\n provided, the AWS account ID is used by default.

" - } - }, "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { @@ -16054,10 +16488,16 @@ "smithy.api#required": {} } }, - "FunctionName": { - "target": "com.amazonaws.glue#NameString", + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The name of the function.

", + "smithy.api#documentation": "

The ID of the Data Catalog where the function to be updated is located. If none is\n provided, the AWS account ID is used by default.

" + } + }, + "FunctionInput": { + "target": "com.amazonaws.glue#UserDefinedFunctionInput", + "traits": { + "smithy.api#documentation": "

A FunctionInput object that redefines the function in the Data\n Catalog.

", "smithy.api#required": {} } } @@ -16105,18 +16545,24 @@ "smithy.api#documentation": "

A collection of properties to be used as part of each execution of the workflow.

" } }, - "Description": { - "target": "com.amazonaws.glue#GenericString", - "traits": { - "smithy.api#documentation": "

The description of the workflow.

" - } - }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { "smithy.api#documentation": "

Name of the workflow to be updated.

", "smithy.api#required": {} } + }, + "MaxConcurrentRuns": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

The description of the workflow.

" + } } } }, @@ -16164,16 +16610,22 @@ "com.amazonaws.glue#UserDefinedFunction": { "type": "structure", "members": { - "DatabaseName": { + "ResourceUris": { + "target": "com.amazonaws.glue#ResourceUriList", + "traits": { + "smithy.api#documentation": "

The resource URIs for the function.

" + } + }, + "OwnerName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the catalog database that contains the function.

" + "smithy.api#documentation": "

The owner of the function.

" } }, - "ClassName": { + "FunctionName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The Java class that contains the function code.

" + "smithy.api#documentation": "

The name of the function.

" } }, "CatalogId": { @@ -16188,22 +16640,16 @@ "smithy.api#documentation": "

The time at which the function was created.

" } }, - "FunctionName": { + "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the function.

" - } - }, - "ResourceUris": { - "target": "com.amazonaws.glue#ResourceUriList", - "traits": { - "smithy.api#documentation": "

The resource URIs for the function.

" + "smithy.api#documentation": "

The name of the catalog database that contains the function.

" } }, - "OwnerName": { + "ClassName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The owner of the function.

" + "smithy.api#documentation": "

The Java class that contains the function code.

" } }, "OwnerType": { @@ -16220,10 +16666,10 @@ "com.amazonaws.glue#UserDefinedFunctionInput": { "type": "structure", "members": { - "OwnerType": { - "target": "com.amazonaws.glue#PrincipalType", + "ClassName": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The owner type.

" + "smithy.api#documentation": "

The Java class that contains the function code.

" } }, "FunctionName": { @@ -16232,16 +16678,16 @@ "smithy.api#documentation": "

The name of the function.

" } }, - "ResourceUris": { - "target": "com.amazonaws.glue#ResourceUriList", + "OwnerType": { + "target": "com.amazonaws.glue#PrincipalType", "traits": { - "smithy.api#documentation": "

The resource URIs for the function.

" + "smithy.api#documentation": "

The owner type.

" } }, - "ClassName": { - "target": "com.amazonaws.glue#NameString", + "ResourceUris": { + "target": "com.amazonaws.glue#ResourceUriList", "traits": { - "smithy.api#documentation": "

The Java class that contains the function code.

" + "smithy.api#documentation": "

The resource URIs for the function.

" } }, "OwnerName": { @@ -16347,16 +16793,16 @@ "com.amazonaws.glue#Workflow": { "type": "structure", "members": { - "Graph": { - "target": "com.amazonaws.glue#WorkflowGraph", + "CreatedOn": { + "target": "com.amazonaws.glue#TimestampValue", "traits": { - "smithy.api#documentation": "

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed\n connections between them as edges.

" + "smithy.api#documentation": "

The date and time when the workflow was created.

" } }, - "DefaultRunProperties": { - "target": "com.amazonaws.glue#WorkflowRunProperties", + "LastRun": { + "target": "com.amazonaws.glue#WorkflowRun", "traits": { - "smithy.api#documentation": "

A collection of properties to be used as part of each execution of the workflow.

" + "smithy.api#documentation": "

The information about the last execution of the workflow.

" } }, "Description": { @@ -16365,28 +16811,34 @@ "smithy.api#documentation": "

A description of the workflow.

" } }, - "Name": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

The name of the workflow representing the flow.

" - } - }, "LastModifiedOn": { "target": "com.amazonaws.glue#TimestampValue", "traits": { "smithy.api#documentation": "

The date and time when the workflow was last modified.

" } }, - "LastRun": { - "target": "com.amazonaws.glue#WorkflowRun", + "DefaultRunProperties": { + "target": "com.amazonaws.glue#WorkflowRunProperties", "traits": { - "smithy.api#documentation": "

The information about the last execution of the workflow.

" + "smithy.api#documentation": "

A collection of properties to be used as part of each execution of the workflow.

" } }, - "CreatedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "Graph": { + "target": "com.amazonaws.glue#WorkflowGraph", "traits": { - "smithy.api#documentation": "

The date and time when the workflow was created.

" + "smithy.api#documentation": "

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed\n connections between them as edges.

" + } + }, + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the workflow representing the flow.

" + } + }, + "MaxConcurrentRuns": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

" } } }, @@ -16397,17 +16849,17 @@ "com.amazonaws.glue#WorkflowGraph": { "type": "structure", "members": { - "Edges": { - "target": "com.amazonaws.glue#EdgeList", - "traits": { - "smithy.api#documentation": "

A list of all the directed connections between the nodes belonging to the workflow.

" - } - }, "Nodes": { "target": "com.amazonaws.glue#NodeList", "traits": { "smithy.api#documentation": "

A list of the the AWS Glue components belong to the workflow represented as nodes.

" } + }, + "Edges": { + "target": "com.amazonaws.glue#EdgeList", + "traits": { + "smithy.api#documentation": "

A list of all the directed connections between the nodes belonging to the workflow.

" + } } }, "traits": { @@ -16429,22 +16881,10 @@ "com.amazonaws.glue#WorkflowRun": { "type": "structure", "members": { - "Statistics": { - "target": "com.amazonaws.glue#WorkflowRunStatistics", - "traits": { - "smithy.api#documentation": "

The statistics of the run.

" - } - }, - "Name": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "

Name of the workflow that was executed.

" - } - }, - "CompletedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "Status": { + "target": "com.amazonaws.glue#WorkflowRunStatus", "traits": { - "smithy.api#documentation": "

The date and time when the workflow run completed.

" + "smithy.api#documentation": "

The status of the workflow run.

" } }, "Graph": { @@ -16453,34 +16893,52 @@ "smithy.api#documentation": "

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed\n connections between them as edges.

" } }, + "WorkflowRunProperties": { + "target": "com.amazonaws.glue#WorkflowRunProperties", + "traits": { + "smithy.api#documentation": "

The workflow run properties which were set during the run.

" + } + }, "StartedOn": { "target": "com.amazonaws.glue#TimestampValue", "traits": { "smithy.api#documentation": "

The date and time when the workflow run was started.

" } }, - "WorkflowRunProperties": { - "target": "com.amazonaws.glue#WorkflowRunProperties", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The workflow run properties which were set during the run.

" + "smithy.api#documentation": "

Name of the workflow that was executed.

" } }, - "WorkflowRunId": { + "PreviousRunId": { "target": "com.amazonaws.glue#IdString", "traits": { - "smithy.api#documentation": "

The ID of this workflow run.

" + "smithy.api#documentation": "

The ID of the previous workflow run.

" } }, - "PreviousRunId": { + "CompletedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The date and time when the workflow run completed.

" + } + }, + "Statistics": { + "target": "com.amazonaws.glue#WorkflowRunStatistics", + "traits": { + "smithy.api#documentation": "

The statistics of the run.

" + } + }, + "WorkflowRunId": { "target": "com.amazonaws.glue#IdString", "traits": { - "smithy.api#documentation": "

The ID of the previous workflow run.

" + "smithy.api#documentation": "

The ID of this workflow run.

" } }, - "Status": { - "target": "com.amazonaws.glue#WorkflowRunStatus", + "ErrorMessage": { + "target": "com.amazonaws.glue#ErrorString", "traits": { - "smithy.api#documentation": "

The status of the workflow run.

" + "smithy.api#documentation": "

This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is \"Concurrent runs exceeded for workflow: foo.\"

" } } }, @@ -16500,28 +16958,28 @@ "com.amazonaws.glue#WorkflowRunStatistics": { "type": "structure", "members": { - "TimeoutActions": { + "FailedActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

Total number of Actions that timed out.

" + "smithy.api#documentation": "

Total number of Actions that have failed.

" } }, - "RunningActions": { + "TotalActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

Total number Actions in running state.

" + "smithy.api#documentation": "

Total number of Actions in the workflow run.

" } }, - "SucceededActions": { + "TimeoutActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

Total number of Actions that have succeeded.

" + "smithy.api#documentation": "

Total number of Actions that timed out.

" } }, - "FailedActions": { + "SucceededActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

Total number of Actions that have failed.

" + "smithy.api#documentation": "

Total number of Actions that have succeeded.

" } }, "StoppedActions": { @@ -16530,10 +16988,10 @@ "smithy.api#documentation": "

Total number of Actions that have stopped.

" } }, - "TotalActions": { + "RunningActions": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

Total number of Actions in the workflow run.

" + "smithy.api#documentation": "

Total number Actions in running state.

" } } }, @@ -16560,6 +17018,10 @@ { "value": "STOPPED", "name": "STOPPED" + }, + { + "value": "ERROR", + "name": "ERROR" } ] } @@ -16591,12 +17053,6 @@ "com.amazonaws.glue#XMLClassifier": { "type": "structure", "members": { - "RowTag": { - "target": "com.amazonaws.glue#RowTag", - "traits": { - "smithy.api#documentation": "

The XML tag designating the element that contains each record in an XML document being\n parsed. This can't identify a self-closing element (closed by />). An empty\n row element that contains only attributes can be parsed as long as it ends with a closing tag\n (for example, is okay, but\n is not).

" - } - }, "Version": { "target": "com.amazonaws.glue#VersionId", "traits": { @@ -16609,6 +17065,12 @@ "smithy.api#documentation": "

The time that this classifier was last updated.

" } }, + "RowTag": { + "target": "com.amazonaws.glue#RowTag", + "traits": { + "smithy.api#documentation": "

The XML tag designating the element that contains each record in an XML document being\n parsed. This can't identify a self-closing element (closed by />). An empty\n row element that contains only attributes can be parsed as long as it ends with a closing tag\n (for example, is okay, but\n is not).

" + } + }, "Name": { "target": "com.amazonaws.glue#NameString", "traits": { diff --git a/codegen/sdk-codegen/aws-models/greengrass.2017-06-07.json b/codegen/sdk-codegen/aws-models/greengrass.2017-06-07.json index cfda721b60d1..56540293a9a5 100644 --- a/codegen/sdk-codegen/aws-models/greengrass.2017-06-07.json +++ b/codegen/sdk-codegen/aws-models/greengrass.2017-06-07.json @@ -136,17 +136,17 @@ "com.amazonaws.greengrass#BadRequestException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "A message containing information about the error." - } - }, "ErrorDetails": { "target": "com.amazonaws.greengrass#ErrorDetails", "traits": { "smithy.api#documentation": "Details about the error." } + }, + "Message": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "A message containing information about the error." + } } }, "traits": { @@ -158,22 +158,22 @@ "com.amazonaws.greengrass#BulkDeployment": { "type": "structure", "members": { - "BulkDeploymentArn": { + "CreatedAt": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the bulk deployment." + "smithy.api#documentation": "The time, in ISO format, when the deployment was created." } }, - "BulkDeploymentId": { + "BulkDeploymentArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the bulk deployment." + "smithy.api#documentation": "The ARN of the bulk deployment." } }, - "CreatedAt": { + "BulkDeploymentId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in ISO format, when the deployment was created." + "smithy.api#documentation": "The ID of the bulk deployment." } } }, @@ -184,10 +184,10 @@ "com.amazonaws.greengrass#BulkDeploymentMetrics": { "type": "structure", "members": { - "RecordsProcessed": { + "InvalidInputRecords": { "target": "com.amazonaws.greengrass#__integer", "traits": { - "smithy.api#documentation": "The total number of group records from the input file that have been processed so far, or attempted." + "smithy.api#documentation": "The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version." } }, "RetryAttempts": { @@ -196,10 +196,10 @@ "smithy.api#documentation": "The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to five times." } }, - "InvalidInputRecords": { + "RecordsProcessed": { "target": "com.amazonaws.greengrass#__integer", "traits": { - "smithy.api#documentation": "The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version." + "smithy.api#documentation": "The total number of group records from the input file that have been processed so far, or attempted." } } }, @@ -210,10 +210,10 @@ "com.amazonaws.greengrass#BulkDeploymentResult": { "type": "structure", "members": { - "DeploymentStatus": { - "target": "com.amazonaws.greengrass#__string", + "ErrorDetails": { + "target": "com.amazonaws.greengrass#ErrorDetails", "traits": { - "smithy.api#documentation": "The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''." + "smithy.api#documentation": "Details about the error." } }, "ErrorMessage": { @@ -222,22 +222,22 @@ "smithy.api#documentation": "The error message for a failed deployment" } }, - "DeploymentId": { - "target": "com.amazonaws.greengrass#__string", + "DeploymentType": { + "target": "com.amazonaws.greengrass#DeploymentType", "traits": { - "smithy.api#documentation": "The ID of the group deployment." + "smithy.api#documentation": "The type of the deployment." } }, - "ErrorDetails": { - "target": "com.amazonaws.greengrass#ErrorDetails", + "GroupArn": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Details about the error." + "smithy.api#documentation": "The ARN of the Greengrass group." } }, - "DeploymentType": { - "target": "com.amazonaws.greengrass#DeploymentType", + "DeploymentArn": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The type of the deployment." + "smithy.api#documentation": "The ARN of the group deployment." } }, "CreatedAt": { @@ -246,16 +246,16 @@ "smithy.api#documentation": "The time, in ISO format, when the deployment was created." } }, - "DeploymentArn": { + "DeploymentId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the group deployment." + "smithy.api#documentation": "The ID of the group deployment." } }, - "GroupArn": { + "DeploymentStatus": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the Greengrass group." + "smithy.api#documentation": "The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''." } } }, @@ -307,6 +307,21 @@ "target": "com.amazonaws.greengrass#BulkDeployment" } }, + "com.amazonaws.greengrass#ConfigurationSyncStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InSync", + "name": "InSync" + }, + { + "value": "OutOfSync", + "name": "OutOfSync" + } + ] + } + }, "com.amazonaws.greengrass#ConnectivityInfo": { "type": "structure", "members": { @@ -316,10 +331,10 @@ "smithy.api#documentation": "The endpoint for the Greengrass core. Can be an IP address or DNS." } }, - "Id": { + "Metadata": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the connectivity information." + "smithy.api#documentation": "Metadata for this endpoint." } }, "PortNumber": { @@ -328,10 +343,10 @@ "smithy.api#documentation": "The port of the Greengrass core. Usually 8883." } }, - "Metadata": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Metadata for this endpoint." + "smithy.api#documentation": "The ID of the connectivity information." } } }, @@ -384,30 +399,30 @@ "com.amazonaws.greengrass#Core": { "type": "structure", "members": { - "CertificateArn": { - "target": "com.amazonaws.greengrass#__string", + "SyncShadow": { + "target": "com.amazonaws.greengrass#__boolean", "traits": { - "smithy.api#documentation": "The ARN of the certificate associated with the core.", - "smithy.api#required": {} + "smithy.api#documentation": "If true, the core's local shadow is automatically synced with the cloud." } }, - "Id": { + "ThingArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", + "smithy.api#documentation": "The ARN of the thing which is the core.", "smithy.api#required": {} } }, - "SyncShadow": { - "target": "com.amazonaws.greengrass#__boolean", + "CertificateArn": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "If true, the core's local shadow is automatically synced with the cloud." + "smithy.api#documentation": "The ARN of the certificate associated with the core.", + "smithy.api#required": {} } }, - "ThingArn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the thing which is the core.", + "smithy.api#documentation": "A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", "smithy.api#required": {} } } @@ -461,12 +476,6 @@ "smithy.api#documentation": "The name of the connector definition." } }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", - "traits": { - "smithy.api#documentation": "Tag(s) to add to the new resource." - } - }, "InitialVersion": { "target": "com.amazonaws.greengrass#ConnectorDefinitionVersion", "traits": { @@ -479,52 +488,58 @@ "smithy.api#documentation": "A client token used to correlate requests and responses.", "smithy.api#httpHeader": "X-Amzn-Client-Token" } + }, + "tags": { + "target": "com.amazonaws.greengrass#Tags", + "traits": { + "smithy.api#documentation": "Tag(s) to add to the new resource." + } } } }, "com.amazonaws.greengrass#CreateConnectorDefinitionResponse": { "type": "structure", "members": { - "Id": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "LastUpdatedTimestamp": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "Name": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "Arn": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "CreationTimestamp": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "LatestVersion": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } } } @@ -560,13 +575,6 @@ "smithy.api#documentation": "A list of references to connectors in this version, with their corresponding configuration settings." } }, - "AmznClientToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" - } - }, "ConnectorDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -574,34 +582,41 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "AmznClientToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" + } } } }, "com.amazonaws.greengrass#CreateConnectorDefinitionVersionResponse": { "type": "structure", "members": { - "CreationTimestamp": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." + "smithy.api#documentation": "The ARN of the version." } }, - "Version": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the version." + "smithy.api#documentation": "The ID of the parent definition that the version is associated with." } }, - "Id": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the parent definition that the version is associated with." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." } }, - "Arn": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the version." + "smithy.api#documentation": "The ID of the version." } } } @@ -631,10 +646,10 @@ "com.amazonaws.greengrass#CreateCoreDefinitionRequest": { "type": "structure", "members": { - "InitialVersion": { - "target": "com.amazonaws.greengrass#CoreDefinitionVersion", + "Name": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Information about the initial version of the core definition." + "smithy.api#documentation": "The name of the core definition." } }, "tags": { @@ -643,18 +658,18 @@ "smithy.api#documentation": "Tag(s) to add to the new resource." } }, - "Name": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The name of the core definition." - } - }, "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "A client token used to correlate requests and responses.", "smithy.api#httpHeader": "X-Amzn-Client-Token" } + }, + "InitialVersion": { + "target": "com.amazonaws.greengrass#CoreDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information about the initial version of the core definition." + } } }, "traits": { @@ -664,46 +679,46 @@ "com.amazonaws.greengrass#CreateCoreDefinitionResponse": { "type": "structure", "members": { - "LatestVersionArn": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "LastUpdatedTimestamp": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The ID of the definition." } }, - "LatestVersion": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, - "Name": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "Arn": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "CreationTimestamp": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The name of the definition." } }, - "Id": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } } } @@ -733,6 +748,14 @@ "com.amazonaws.greengrass#CreateCoreDefinitionVersionRequest": { "type": "structure", "members": { + "CoreDefinitionId": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the core definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -745,30 +768,22 @@ "traits": { "smithy.api#documentation": "A list of cores in the core definition version." } - }, - "CoreDefinitionId": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The ID of the core definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.greengrass#CreateCoreDefinitionVersionResponse": { "type": "structure", "members": { - "Id": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the parent definition that the version is associated with." + "smithy.api#documentation": "The ID of the version." } }, - "Arn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the version." + "smithy.api#documentation": "The ID of the parent definition that the version is associated with." } }, "CreationTimestamp": { @@ -777,10 +792,10 @@ "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." } }, - "Version": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the version." + "smithy.api#documentation": "The ARN of the version." } } } @@ -810,24 +825,31 @@ "com.amazonaws.greengrass#CreateDeploymentRequest": { "type": "structure", "members": { - "GroupId": { + "DeploymentId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the Greengrass group.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the deployment if you wish to redeploy a previous deployment." } }, - "GroupVersionId": { + "AmznClientToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" + } + }, + "GroupVersionId": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The ID of the group version to be deployed." } }, - "DeploymentId": { + "GroupId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the deployment if you wish to redeploy a previous deployment." + "smithy.api#documentation": "The ID of the Greengrass group.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "DeploymentType": { @@ -836,13 +858,6 @@ "smithy.api#documentation": "The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.", "smithy.api#required": {} } - }, - "AmznClientToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" - } } } }, @@ -888,12 +903,6 @@ "com.amazonaws.greengrass#CreateDeviceDefinitionRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The name of the device definition." - } - }, "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -912,28 +921,34 @@ "traits": { "smithy.api#documentation": "Tag(s) to add to the new resource." } + }, + "Name": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The name of the device definition." + } } } }, "com.amazonaws.greengrass#CreateDeviceDefinitionResponse": { "type": "structure", "members": { - "LatestVersion": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "LastUpdatedTimestamp": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The name of the definition." } }, - "Id": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The ARN of the definition." } }, "CreationTimestamp": { @@ -942,22 +957,22 @@ "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "LatestVersionArn": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "Arn": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "Name": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } } } @@ -987,12 +1002,10 @@ "com.amazonaws.greengrass#CreateDeviceDefinitionVersionRequest": { "type": "structure", "members": { - "DeviceDefinitionId": { - "target": "com.amazonaws.greengrass#__string", + "Devices": { + "target": "com.amazonaws.greengrass#__listOfDevice", "traits": { - "smithy.api#documentation": "The ID of the device definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A list of devices in the definition version." } }, "AmznClientToken": { @@ -1002,10 +1015,12 @@ "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, - "Devices": { - "target": "com.amazonaws.greengrass#__listOfDevice", + "DeviceDefinitionId": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A list of devices in the definition version." + "smithy.api#documentation": "The ID of the device definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -1013,10 +1028,10 @@ "com.amazonaws.greengrass#CreateDeviceDefinitionVersionResponse": { "type": "structure", "members": { - "Version": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the version." + "smithy.api#documentation": "The ARN of the version." } }, "CreationTimestamp": { @@ -1031,10 +1046,10 @@ "smithy.api#documentation": "The ID of the parent definition that the version is associated with." } }, - "Arn": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the version." + "smithy.api#documentation": "The ID of the version." } } } @@ -1064,40 +1079,40 @@ "com.amazonaws.greengrass#CreateFunctionDefinitionRequest": { "type": "structure", "members": { - "InitialVersion": { - "target": "com.amazonaws.greengrass#FunctionDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information about the initial version of the function definition." - } - }, "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The name of the function definition." } }, + "tags": { + "target": "com.amazonaws.greengrass#Tags", + "traits": { + "smithy.api#documentation": "Tag(s) to add to the new resource." + } + }, + "InitialVersion": { + "target": "com.amazonaws.greengrass#FunctionDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information about the initial version of the function definition." + } + }, "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "A client token used to correlate requests and responses.", "smithy.api#httpHeader": "X-Amzn-Client-Token" } - }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", - "traits": { - "smithy.api#documentation": "Tag(s) to add to the new resource." - } } } }, "com.amazonaws.greengrass#CreateFunctionDefinitionResponse": { "type": "structure", "members": { - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, "LastUpdatedTimestamp": { @@ -1106,34 +1121,34 @@ "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "LatestVersion": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "Name": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "Id": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "Arn": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "CreationTimestamp": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } } } @@ -1177,18 +1192,18 @@ "smithy.api#required": {} } }, + "Functions": { + "target": "com.amazonaws.greengrass#__listOfFunction", + "traits": { + "smithy.api#documentation": "A list of Lambda functions in this function definition version." + } + }, "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "A client token used to correlate requests and responses.", "smithy.api#httpHeader": "X-Amzn-Client-Token" } - }, - "Functions": { - "target": "com.amazonaws.greengrass#__listOfFunction", - "traits": { - "smithy.api#documentation": "A list of Lambda functions in this function definition version." - } } }, "traits": { @@ -1198,12 +1213,6 @@ "com.amazonaws.greengrass#CreateFunctionDefinitionVersionResponse": { "type": "structure", "members": { - "CreationTimestamp": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." - } - }, "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -1221,6 +1230,12 @@ "traits": { "smithy.api#documentation": "The ID of the version." } + }, + "CreationTimestamp": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." + } } } }, @@ -1274,19 +1289,19 @@ "com.amazonaws.greengrass#CreateGroupCertificateAuthorityRequest": { "type": "structure", "members": { - "GroupId": { + "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the Greengrass group.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, - "AmznClientToken": { + "GroupId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" + "smithy.api#documentation": "The ID of the Greengrass group.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -1305,16 +1320,11 @@ "com.amazonaws.greengrass#CreateGroupRequest": { "type": "structure", "members": { - "Name": { + "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the group." - } - }, - "InitialVersion": { - "target": "com.amazonaws.greengrass#GroupVersion", - "traits": { - "smithy.api#documentation": "Information about the initial version of the group." + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, "tags": { @@ -1323,11 +1333,16 @@ "smithy.api#documentation": "Tag(s) to add to the new resource." } }, - "AmznClientToken": { + "InitialVersion": { + "target": "com.amazonaws.greengrass#GroupVersion", + "traits": { + "smithy.api#documentation": "Information about the initial version of the group." + } + }, + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" + "smithy.api#documentation": "The name of the group." } } } @@ -1335,22 +1350,22 @@ "com.amazonaws.greengrass#CreateGroupResponse": { "type": "structure", "members": { - "LastUpdatedTimestamp": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "Id": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "Arn": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, "LatestVersion": { @@ -1359,22 +1374,22 @@ "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "Name": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ARN of the definition." } }, - "LatestVersionArn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "CreationTimestamp": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The name of the definition." } } } @@ -1412,53 +1427,53 @@ "smithy.api#required": {} } }, - "DeviceDefinitionVersionArn": { + "LoggerDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the device definition version for this group." + "smithy.api#documentation": "The ARN of the logger definition version for this group." } }, - "CoreDefinitionVersionArn": { + "SubscriptionDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the core definition version for this group." + "smithy.api#documentation": "The ARN of the subscription definition version for this group." } }, - "AmznClientToken": { + "ConnectorDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" + "smithy.api#documentation": "The ARN of the connector definition version for this group." } }, - "FunctionDefinitionVersionArn": { + "CoreDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the function definition version for this group." + "smithy.api#documentation": "The ARN of the core definition version for this group." } }, - "ConnectorDefinitionVersionArn": { + "ResourceDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the connector definition version for this group." + "smithy.api#documentation": "The ARN of the resource definition version for this group." } }, - "ResourceDefinitionVersionArn": { + "DeviceDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the resource definition version for this group." + "smithy.api#documentation": "The ARN of the device definition version for this group." } }, - "SubscriptionDefinitionVersionArn": { + "FunctionDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the subscription definition version for this group." + "smithy.api#documentation": "The ARN of the function definition version for this group." } }, - "LoggerDefinitionVersionArn": { + "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the logger definition version for this group." + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" } } } @@ -1472,10 +1487,10 @@ "smithy.api#documentation": "The ARN of the version." } }, - "Version": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the version." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." } }, "Id": { @@ -1484,10 +1499,10 @@ "smithy.api#documentation": "The ID of the parent definition that the version is associated with." } }, - "CreationTimestamp": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." + "smithy.api#documentation": "The ID of the version." } } } @@ -1517,12 +1532,6 @@ "com.amazonaws.greengrass#CreateLoggerDefinitionRequest": { "type": "structure", "members": { - "InitialVersion": { - "target": "com.amazonaws.greengrass#LoggerDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information about the initial version of the logger definition." - } - }, "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -1536,6 +1545,12 @@ "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, + "InitialVersion": { + "target": "com.amazonaws.greengrass#LoggerDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information about the initial version of the logger definition." + } + }, "tags": { "target": "com.amazonaws.greengrass#Tags", "traits": { @@ -1547,46 +1562,46 @@ "com.amazonaws.greengrass#CreateLoggerDefinitionResponse": { "type": "structure", "members": { - "Name": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "LastUpdatedTimestamp": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The name of the definition." } }, - "Arn": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "CreationTimestamp": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ID of the definition." } }, - "Id": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, - "LatestVersion": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } } } @@ -1616,6 +1631,13 @@ "com.amazonaws.greengrass#CreateLoggerDefinitionVersionRequest": { "type": "structure", "members": { + "AmznClientToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" + } + }, "LoggerDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -1629,25 +1651,12 @@ "traits": { "smithy.api#documentation": "A list of loggers." } - }, - "AmznClientToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" - } } } }, "com.amazonaws.greengrass#CreateLoggerDefinitionVersionResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The ARN of the version." - } - }, "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -1665,6 +1674,12 @@ "traits": { "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." } + }, + "Arn": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ARN of the version." + } } } }, @@ -1693,10 +1708,17 @@ "com.amazonaws.greengrass#CreateResourceDefinitionRequest": { "type": "structure", "members": { - "Name": { + "InitialVersion": { + "target": "com.amazonaws.greengrass#ResourceDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information about the initial version of the resource definition." + } + }, + "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the resource definition." + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, "tags": { @@ -1705,17 +1727,10 @@ "smithy.api#documentation": "Tag(s) to add to the new resource." } }, - "InitialVersion": { - "target": "com.amazonaws.greengrass#ResourceDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information about the initial version of the resource definition." - } - }, - "AmznClientToken": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" + "smithy.api#documentation": "The name of the resource definition." } } } @@ -1723,16 +1738,10 @@ "com.amazonaws.greengrass#CreateResourceDefinitionResponse": { "type": "structure", "members": { - "CreationTimestamp": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." - } - }, - "LatestVersion": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, "LastUpdatedTimestamp": { @@ -1741,16 +1750,16 @@ "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "LatestVersionArn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "Id": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, "Name": { @@ -1759,10 +1768,16 @@ "smithy.api#documentation": "The name of the definition." } }, - "Arn": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." + } + }, + "LatestVersion": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the latest version associated with the definition." } } } @@ -1792,13 +1807,6 @@ "com.amazonaws.greengrass#CreateResourceDefinitionVersionRequest": { "type": "structure", "members": { - "AmznClientToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" - } - }, "ResourceDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -1812,34 +1820,41 @@ "traits": { "smithy.api#documentation": "A list of resources." } + }, + "AmznClientToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" + } } } }, "com.amazonaws.greengrass#CreateResourceDefinitionVersionResponse": { "type": "structure", "members": { - "Arn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the version." + "smithy.api#documentation": "The ID of the parent definition that the version is associated with." } }, - "CreationTimestamp": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." + "smithy.api#documentation": "The ID of the version." } }, - "Id": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the parent definition that the version is associated with." + "smithy.api#documentation": "The ARN of the version." } }, - "Version": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the version." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." } } } @@ -1872,42 +1887,42 @@ "com.amazonaws.greengrass#CreateSoftwareUpdateJobRequest": { "type": "structure", "members": { - "UpdateTargetsOperatingSystem": { - "target": "com.amazonaws.greengrass#UpdateTargetsOperatingSystem", + "SoftwareToUpdate": { + "target": "com.amazonaws.greengrass#SoftwareToUpdate", "traits": { "smithy.api#required": {} } }, - "UpdateAgentLogLevel": { - "target": "com.amazonaws.greengrass#UpdateAgentLogLevel" - }, - "AmznClientToken": { - "target": "com.amazonaws.greengrass#__string", + "UpdateTargets": { + "target": "com.amazonaws.greengrass#UpdateTargets", "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" + "smithy.api#required": {} } }, - "S3UrlSignerRole": { - "target": "com.amazonaws.greengrass#S3UrlSignerRole", + "UpdateTargetsArchitecture": { + "target": "com.amazonaws.greengrass#UpdateTargetsArchitecture", "traits": { "smithy.api#required": {} } }, - "UpdateTargets": { - "target": "com.amazonaws.greengrass#UpdateTargets", + "UpdateTargetsOperatingSystem": { + "target": "com.amazonaws.greengrass#UpdateTargetsOperatingSystem", "traits": { "smithy.api#required": {} } }, - "UpdateTargetsArchitecture": { - "target": "com.amazonaws.greengrass#UpdateTargetsArchitecture", + "AmznClientToken": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, - "SoftwareToUpdate": { - "target": "com.amazonaws.greengrass#SoftwareToUpdate", + "UpdateAgentLogLevel": { + "target": "com.amazonaws.greengrass#UpdateAgentLogLevel" + }, + "S3UrlSignerRole": { + "target": "com.amazonaws.greengrass#S3UrlSignerRole", "traits": { "smithy.api#required": {} } @@ -1917,10 +1932,10 @@ "com.amazonaws.greengrass#CreateSoftwareUpdateJobResponse": { "type": "structure", "members": { - "PlatformSoftwareVersion": { + "IotJobId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The software version installed on the device or devices after the update." + "smithy.api#documentation": "The IoT Job Id corresponding to this update." } }, "IotJobArn": { @@ -1929,10 +1944,10 @@ "smithy.api#documentation": "The IoT Job ARN corresponding to this update." } }, - "IotJobId": { + "PlatformSoftwareVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The IoT Job Id corresponding to this update." + "smithy.api#documentation": "The software version installed on the device or devices after the update." } } } @@ -1962,10 +1977,17 @@ "com.amazonaws.greengrass#CreateSubscriptionDefinitionRequest": { "type": "structure", "members": { - "Name": { + "InitialVersion": { + "target": "com.amazonaws.greengrass#SubscriptionDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information about the initial version of the subscription definition." + } + }, + "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the subscription definition." + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, "tags": { @@ -1974,17 +1996,10 @@ "smithy.api#documentation": "Tag(s) to add to the new resource." } }, - "InitialVersion": { - "target": "com.amazonaws.greengrass#SubscriptionDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information about the initial version of the subscription definition." - } - }, - "AmznClientToken": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" + "smithy.api#documentation": "The name of the subscription definition." } } } @@ -1992,28 +2007,22 @@ "com.amazonaws.greengrass#CreateSubscriptionDefinitionResponse": { "type": "structure", "members": { - "CreationTimestamp": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." - } - }, - "Name": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "LatestVersionArn": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "LatestVersion": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the definition." } }, "Arn": { @@ -2022,10 +2031,10 @@ "smithy.api#documentation": "The ARN of the definition." } }, - "Id": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The name of the definition." } }, "LastUpdatedTimestamp": { @@ -2033,6 +2042,12 @@ "traits": { "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } + }, + "LatestVersion": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the latest version associated with the definition." + } } } }, @@ -2061,6 +2076,13 @@ "com.amazonaws.greengrass#CreateSubscriptionDefinitionVersionRequest": { "type": "structure", "members": { + "AmznClientToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" + } + }, "Subscriptions": { "target": "com.amazonaws.greengrass#__listOfSubscription", "traits": { @@ -2074,41 +2096,34 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AmznClientToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" - } } } }, "com.amazonaws.greengrass#CreateSubscriptionDefinitionVersionResponse": { "type": "structure", "members": { - "Arn": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the version." + "smithy.api#documentation": "The ID of the version." } }, - "CreationTimestamp": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." + "smithy.api#documentation": "The ID of the parent definition that the version is associated with." } }, - "Id": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the parent definition that the version is associated with." + "smithy.api#documentation": "The ARN of the version." } }, - "Version": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the version." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." } } } @@ -2116,22 +2131,17 @@ "com.amazonaws.greengrass#DefinitionInformation": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The name of the definition." - } - }, - "Id": { - "target": "com.amazonaws.greengrass#__string", + "Tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "Tag(s) attached to the resource arn.", + "smithy.api#jsonName": "tags" } }, - "CreationTimestamp": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, "LatestVersion": { @@ -2140,10 +2150,10 @@ "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "Arn": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The name of the definition." } }, "LastUpdatedTimestamp": { @@ -2152,17 +2162,22 @@ "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "Tags": { - "target": "com.amazonaws.greengrass#Tags", + "Arn": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The ARN of the definition." } }, - "LatestVersionArn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the definition." + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } } }, @@ -2491,6 +2506,12 @@ "smithy.api#documentation": "The ARN of the group for this deployment." } }, + "CreatedAt": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the deployment was created." + } + }, "DeploymentType": { "target": "com.amazonaws.greengrass#DeploymentType", "traits": { @@ -2508,12 +2529,6 @@ "traits": { "smithy.api#documentation": "The ID of the deployment." } - }, - "CreatedAt": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the deployment was created." - } } }, "traits": { @@ -2553,10 +2568,11 @@ "com.amazonaws.greengrass#Device": { "type": "structure", "members": { - "SyncShadow": { - "target": "com.amazonaws.greengrass#__boolean", + "Id": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "If true, the device's local shadow will be automatically synced with the cloud." + "smithy.api#documentation": "A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", + "smithy.api#required": {} } }, "ThingArn": { @@ -2566,18 +2582,17 @@ "smithy.api#required": {} } }, - "Id": { + "CertificateArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", + "smithy.api#documentation": "The ARN of the certificate associated with the device.", "smithy.api#required": {} } }, - "CertificateArn": { - "target": "com.amazonaws.greengrass#__string", + "SyncShadow": { + "target": "com.amazonaws.greengrass#__boolean", "traits": { - "smithy.api#documentation": "The ARN of the certificate associated with the device.", - "smithy.api#required": {} + "smithy.api#documentation": "If true, the device's local shadow will be automatically synced with the cloud." } } }, @@ -2703,16 +2718,16 @@ "com.amazonaws.greengrass#ErrorDetail": { "type": "structure", "members": { - "DetailedErrorCode": { + "DetailedErrorMessage": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A detailed error code." + "smithy.api#documentation": "A detailed error message." } }, - "DetailedErrorMessage": { + "DetailedErrorCode": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A detailed error message." + "smithy.api#documentation": "A detailed error code." } } }, @@ -2732,6 +2747,12 @@ "com.amazonaws.greengrass#Function": { "type": "structure", "members": { + "FunctionArn": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function." + } + }, "FunctionConfiguration": { "target": "com.amazonaws.greengrass#FunctionConfiguration", "traits": { @@ -2744,12 +2765,6 @@ "smithy.api#documentation": "A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", "smithy.api#required": {} } - }, - "FunctionArn": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The ARN of the Lambda function." - } } }, "traits": { @@ -2759,16 +2774,10 @@ "com.amazonaws.greengrass#FunctionConfiguration": { "type": "structure", "members": { - "Timeout": { - "target": "com.amazonaws.greengrass#__integer", - "traits": { - "smithy.api#documentation": "The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request." - } - }, - "Pinned": { - "target": "com.amazonaws.greengrass#__boolean", + "Executable": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "True if the function is pinned. Pinned means the function is long-lived and starts when the core starts." + "smithy.api#documentation": "The name of the function executable." } }, "EncodingType": { @@ -2777,16 +2786,16 @@ "smithy.api#documentation": "The expected encoding type of the input payload for the function. The default is ''json''." } }, - "Executable": { - "target": "com.amazonaws.greengrass#__string", + "Pinned": { + "target": "com.amazonaws.greengrass#__boolean", "traits": { - "smithy.api#documentation": "The name of the function executable." + "smithy.api#documentation": "True if the function is pinned. Pinned means the function is long-lived and starts when the core starts." } }, - "Environment": { - "target": "com.amazonaws.greengrass#FunctionConfigurationEnvironment", + "ExecArgs": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The environment configuration of the function." + "smithy.api#documentation": "The execution arguments." } }, "MemorySize": { @@ -2795,10 +2804,16 @@ "smithy.api#documentation": "The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization." } }, - "ExecArgs": { - "target": "com.amazonaws.greengrass#__string", + "Timeout": { + "target": "com.amazonaws.greengrass#__integer", "traits": { - "smithy.api#documentation": "The execution arguments." + "smithy.api#documentation": "The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request." + } + }, + "Environment": { + "target": "com.amazonaws.greengrass#FunctionConfigurationEnvironment", + "traits": { + "smithy.api#documentation": "The environment configuration of the function." } } }, @@ -2809,16 +2824,16 @@ "com.amazonaws.greengrass#FunctionConfigurationEnvironment": { "type": "structure", "members": { - "Variables": { - "target": "com.amazonaws.greengrass#__mapOf__string", + "Execution": { + "target": "com.amazonaws.greengrass#FunctionExecutionConfig", "traits": { - "smithy.api#documentation": "Environment variables for the Lambda function's configuration." + "smithy.api#documentation": "Configuration related to executing the Lambda function" } }, - "ResourceAccessPolicies": { - "target": "com.amazonaws.greengrass#__listOfResourceAccessPolicy", + "Variables": { + "target": "com.amazonaws.greengrass#__mapOf__string", "traits": { - "smithy.api#documentation": "A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container." + "smithy.api#documentation": "Environment variables for the Lambda function's configuration." } }, "AccessSysfs": { @@ -2827,10 +2842,10 @@ "smithy.api#documentation": "If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container." } }, - "Execution": { - "target": "com.amazonaws.greengrass#FunctionExecutionConfig", + "ResourceAccessPolicies": { + "target": "com.amazonaws.greengrass#__listOfResourceAccessPolicy", "traits": { - "smithy.api#documentation": "Configuration related to executing the Lambda function" + "smithy.api#documentation": "A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container." } } }, @@ -2866,17 +2881,17 @@ "com.amazonaws.greengrass#FunctionDefinitionVersion": { "type": "structure", "members": { - "Functions": { - "target": "com.amazonaws.greengrass#__listOfFunction", - "traits": { - "smithy.api#documentation": "A list of Lambda functions in this function definition version." - } - }, "DefaultConfig": { "target": "com.amazonaws.greengrass#FunctionDefaultConfig", "traits": { "smithy.api#documentation": "The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings." } + }, + "Functions": { + "target": "com.amazonaws.greengrass#__listOfFunction", + "traits": { + "smithy.api#documentation": "A list of Lambda functions in this function definition version." + } } }, "traits": { @@ -2886,11 +2901,11 @@ "com.amazonaws.greengrass#FunctionExecutionConfig": { "type": "structure", "members": { - "IsolationMode": { - "target": "com.amazonaws.greengrass#FunctionIsolationMode" - }, "RunAs": { "target": "com.amazonaws.greengrass#FunctionRunAsConfig" + }, + "IsolationMode": { + "target": "com.amazonaws.greengrass#FunctionIsolationMode" } }, "traits": { @@ -2916,16 +2931,16 @@ "com.amazonaws.greengrass#FunctionRunAsConfig": { "type": "structure", "members": { - "Gid": { + "Uid": { "target": "com.amazonaws.greengrass#__integer", "traits": { - "smithy.api#documentation": "The group ID whose permissions are used to run a Lambda function." + "smithy.api#documentation": "The user ID whose permissions are used to run a Lambda function." } }, - "Uid": { + "Gid": { "target": "com.amazonaws.greengrass#__integer", "traits": { - "smithy.api#documentation": "The user ID whose permissions are used to run a Lambda function." + "smithy.api#documentation": "The group ID whose permissions are used to run a Lambda function." } } }, @@ -2974,16 +2989,16 @@ "com.amazonaws.greengrass#GetAssociatedRoleResponse": { "type": "structure", "members": { - "RoleArn": { + "AssociatedAt": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the role that is associated with the group." + "smithy.api#documentation": "The time when the role was associated with the group." } }, - "AssociatedAt": { + "RoleArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time when the role was associated with the group." + "smithy.api#documentation": "The ARN of the role that is associated with the group." } } } @@ -3026,10 +3041,10 @@ "com.amazonaws.greengrass#GetBulkDeploymentStatusResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "BulkDeploymentStatus": { + "target": "com.amazonaws.greengrass#BulkDeploymentStatus", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "The status of the bulk deployment." } }, "CreatedAt": { @@ -3038,16 +3053,10 @@ "smithy.api#documentation": "The time, in ISO format, when the deployment was created." } }, - "ErrorMessage": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "Error message" - } - }, - "BulkDeploymentStatus": { - "target": "com.amazonaws.greengrass#BulkDeploymentStatus", + "ErrorDetails": { + "target": "com.amazonaws.greengrass#ErrorDetails", "traits": { - "smithy.api#documentation": "The status of the bulk deployment." + "smithy.api#documentation": "Error details" } }, "BulkDeploymentMetrics": { @@ -3056,10 +3065,16 @@ "smithy.api#documentation": "Relevant metrics on input records processed during bulk deployment." } }, - "ErrorDetails": { - "target": "com.amazonaws.greengrass#ErrorDetails", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "Error details" + "smithy.api#documentation": "Tag(s) attached to the resource arn." + } + }, + "ErrorMessage": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "Error message" } } } @@ -3158,52 +3173,52 @@ "com.amazonaws.greengrass#GetConnectorDefinitionResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "LatestVersion": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "LatestVersionArn": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "CreationTimestamp": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ARN of the definition." } }, - "Id": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "Arn": { - "target": "com.amazonaws.greengrass#__string", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "Tag(s) attached to the resource arn." } }, - "LastUpdatedTimestamp": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "Name": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "LatestVersion": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } } } @@ -3267,34 +3282,34 @@ "smithy.api#documentation": "The time, in milliseconds since the epoch, when the connector definition version was created." } }, - "Id": { + "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the connector definition version." + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } }, - "Arn": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the connector definition version." + "smithy.api#documentation": "The version of the connector definition version." } }, - "Definition": { - "target": "com.amazonaws.greengrass#ConnectorDefinitionVersion", + "Id": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Information about the connector definition version." + "smithy.api#documentation": "The ID of the connector definition version." } }, - "Version": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The version of the connector definition version." + "smithy.api#documentation": "The ARN of the connector definition version." } }, - "NextToken": { - "target": "com.amazonaws.greengrass#__string", + "Definition": { + "target": "com.amazonaws.greengrass#ConnectorDefinitionVersion", "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + "smithy.api#documentation": "Information about the connector definition version." } } } @@ -3337,52 +3352,52 @@ "com.amazonaws.greengrass#GetCoreDefinitionResponse": { "type": "structure", "members": { - "Arn": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "Id": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "LastUpdatedTimestamp": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The ID of the definition." } }, - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, - "LatestVersion": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "CreationTimestamp": { - "target": "com.amazonaws.greengrass#__string", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "Tag(s) attached to the resource arn." } }, - "Name": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } - }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", + }, + "LatestVersion": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } } } @@ -3412,18 +3427,18 @@ "com.amazonaws.greengrass#GetCoreDefinitionVersionRequest": { "type": "structure", "members": { - "CoreDefinitionId": { + "CoreDefinitionVersionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the core definition.", + "smithy.api#documentation": "The ID of the core definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "CoreDefinitionVersionId": { + "CoreDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the core definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", + "smithy.api#documentation": "The ID of the core definition.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3433,40 +3448,40 @@ "com.amazonaws.greengrass#GetCoreDefinitionVersionResponse": { "type": "structure", "members": { - "CreationTimestamp": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the core definition version was created." + "smithy.api#documentation": "The ID of the core definition version." } }, - "Arn": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the core definition version." + "smithy.api#documentation": "The version of the core definition version." } }, - "Definition": { - "target": "com.amazonaws.greengrass#CoreDefinitionVersion", + "NextToken": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Information about the core definition version." + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } }, - "Version": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The version of the core definition version." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the core definition version was created." } }, - "Id": { - "target": "com.amazonaws.greengrass#__string", + "Definition": { + "target": "com.amazonaws.greengrass#CoreDefinitionVersion", "traits": { - "smithy.api#documentation": "The ID of the core definition version." + "smithy.api#documentation": "Information about the core definition version." } }, - "NextToken": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + "smithy.api#documentation": "The ARN of the core definition version." } } } @@ -3496,18 +3511,18 @@ "com.amazonaws.greengrass#GetDeploymentStatusRequest": { "type": "structure", "members": { - "DeploymentId": { + "GroupId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the deployment.", + "smithy.api#documentation": "The ID of the Greengrass group.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "GroupId": { + "DeploymentId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the Greengrass group.", + "smithy.api#documentation": "The ID of the deployment.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3523,6 +3538,12 @@ "smithy.api#documentation": "The type of the deployment." } }, + "UpdatedAt": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the deployment status was updated." + } + }, "ErrorDetails": { "target": "com.amazonaws.greengrass#ErrorDetails", "traits": { @@ -3535,12 +3556,6 @@ "smithy.api#documentation": "Error message" } }, - "UpdatedAt": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the deployment status was updated." - } - }, "DeploymentStatus": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -3587,16 +3602,16 @@ "com.amazonaws.greengrass#GetDeviceDefinitionResponse": { "type": "structure", "members": { - "Id": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "LastUpdatedTimestamp": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, "Arn": { @@ -3605,34 +3620,34 @@ "smithy.api#documentation": "The ARN of the definition." } }, - "LatestVersion": { - "target": "com.amazonaws.greengrass#__string", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "Tag(s) attached to the resource arn." } }, - "LatestVersionArn": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "Id": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "The ID of the definition." } }, - "CreationTimestamp": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "Name": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } } } @@ -3662,10 +3677,10 @@ "com.amazonaws.greengrass#GetDeviceDefinitionVersionRequest": { "type": "structure", "members": { - "DeviceDefinitionVersionId": { + "DeviceDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the device definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListDeviceDefinitionVersions'' requests. If the version is the last one that was associated with a device definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", + "smithy.api#documentation": "The ID of the device definition.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3677,10 +3692,10 @@ "smithy.api#httpQuery": "NextToken" } }, - "DeviceDefinitionId": { + "DeviceDefinitionVersionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the device definition.", + "smithy.api#documentation": "The ID of the device definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListDeviceDefinitionVersions'' requests. If the version is the last one that was associated with a device definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3690,16 +3705,16 @@ "com.amazonaws.greengrass#GetDeviceDefinitionVersionResponse": { "type": "structure", "members": { - "Version": { + "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The version of the device definition version." + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } }, - "Id": { - "target": "com.amazonaws.greengrass#__string", + "Definition": { + "target": "com.amazonaws.greengrass#DeviceDefinitionVersion", "traits": { - "smithy.api#documentation": "The ID of the device definition version." + "smithy.api#documentation": "Information about the device definition version." } }, "CreationTimestamp": { @@ -3708,22 +3723,22 @@ "smithy.api#documentation": "The time, in milliseconds since the epoch, when the device definition version was created." } }, - "NextToken": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + "smithy.api#documentation": "The ID of the device definition version." } }, - "Definition": { - "target": "com.amazonaws.greengrass#DeviceDefinitionVersion", + "Arn": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Information about the device definition version." + "smithy.api#documentation": "The ARN of the device definition version." } }, - "Arn": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the device definition version." + "smithy.api#documentation": "The version of the device definition version." } } } @@ -3766,52 +3781,52 @@ "com.amazonaws.greengrass#GetFunctionDefinitionResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.greengrass#__string", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "Tag(s) attached to the resource arn." } }, - "LastUpdatedTimestamp": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The name of the definition." } }, - "LatestVersion": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "Id": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "The ID of the definition." } }, - "CreationTimestamp": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, - "Name": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "Arn": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } } } @@ -3849,13 +3864,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" - } - }, "FunctionDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -3863,28 +3871,29 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" + } } } }, "com.amazonaws.greengrass#GetFunctionDefinitionVersionResponse": { "type": "structure", "members": { - "Id": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the function definition version." - } - }, - "Definition": { - "target": "com.amazonaws.greengrass#FunctionDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information on the definition." + "smithy.api#documentation": "The ARN of the function definition version." } }, - "Arn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the function definition version." + "smithy.api#documentation": "The ID of the function definition version." } }, "Version": { @@ -3904,6 +3913,12 @@ "traits": { "smithy.api#documentation": "The time, in milliseconds since the epoch, when the function definition version was created." } + }, + "Definition": { + "target": "com.amazonaws.greengrass#FunctionDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information on the definition." + } } } }, @@ -3957,20 +3972,20 @@ "com.amazonaws.greengrass#GetGroupCertificateAuthorityRequest": { "type": "structure", "members": { - "CertificateAuthorityId": { + "GroupId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the certificate authority.", + "smithy.api#documentation": "The ID of the Greengrass group.", "smithy.api#httpLabel": {}, - "smithy.api#pattern": "^(?!configuration).*$", "smithy.api#required": {} } }, - "GroupId": { + "CertificateAuthorityId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the Greengrass group.", + "smithy.api#documentation": "The ID of the certificate authority.", "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^(?!configuration).*$", "smithy.api#required": {} } } @@ -3979,10 +3994,10 @@ "com.amazonaws.greengrass#GetGroupCertificateAuthorityResponse": { "type": "structure", "members": { - "GroupCertificateAuthorityArn": { + "GroupCertificateAuthorityId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the certificate authority for the group." + "smithy.api#documentation": "The ID of the certificate authority for the group." } }, "PemEncodedCertificate": { @@ -3991,10 +4006,10 @@ "smithy.api#documentation": "The PEM encoded certificate for the group." } }, - "GroupCertificateAuthorityId": { + "GroupCertificateAuthorityArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the certificate authority for the group." + "smithy.api#documentation": "The ARN of the certificate authority for the group." } } } @@ -4040,12 +4055,6 @@ "com.amazonaws.greengrass#GetGroupCertificateConfigurationResponse": { "type": "structure", "members": { - "CertificateExpiryInMilliseconds": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The amount of time remaining before the certificate expires, in milliseconds." - } - }, "CertificateAuthorityExpiryInMilliseconds": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -4057,6 +4066,12 @@ "traits": { "smithy.api#documentation": "The ID of the group certificate configuration." } + }, + "CertificateExpiryInMilliseconds": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The amount of time remaining before the certificate expires, in milliseconds." + } } } }, @@ -4076,52 +4091,52 @@ "com.amazonaws.greengrass#GetGroupResponse": { "type": "structure", "members": { - "LastUpdatedTimestamp": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "Id": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "CreationTimestamp": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ARN of the definition." } }, - "LatestVersionArn": { - "target": "com.amazonaws.greengrass#__string", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "Tag(s) attached to the resource arn." } }, - "LatestVersion": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "LatestVersion": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "Arn": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "Name": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } } } @@ -4172,10 +4187,10 @@ "com.amazonaws.greengrass#GetGroupVersionResponse": { "type": "structure", "members": { - "Version": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the group version." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the group version was created." } }, "Definition": { @@ -4184,22 +4199,22 @@ "smithy.api#documentation": "Information about the group version definition." } }, - "Arn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the group version." + "smithy.api#documentation": "The ID of the group that the version is associated with." } }, - "CreationTimestamp": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the group version was created." + "smithy.api#documentation": "The ARN of the group version." } }, - "Id": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the group that the version is associated with." + "smithy.api#documentation": "The ID of the group version." } } } @@ -4242,22 +4257,22 @@ "com.amazonaws.greengrass#GetLoggerDefinitionResponse": { "type": "structure", "members": { - "CreationTimestamp": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } }, - "Name": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, "tags": { @@ -4266,28 +4281,28 @@ "smithy.api#documentation": "Tag(s) attached to the resource arn." } }, - "Id": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "Arn": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The ID of the definition." } }, - "LatestVersion": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "LastUpdatedTimestamp": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } } } @@ -4317,10 +4332,10 @@ "com.amazonaws.greengrass#GetLoggerDefinitionVersionRequest": { "type": "structure", "members": { - "LoggerDefinitionId": { + "LoggerDefinitionVersionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the logger definition.", + "smithy.api#documentation": "The ID of the logger definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListLoggerDefinitionVersions'' requests. If the version is the last one that was associated with a logger definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4332,10 +4347,10 @@ "smithy.api#httpQuery": "NextToken" } }, - "LoggerDefinitionVersionId": { + "LoggerDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the logger definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListLoggerDefinitionVersions'' requests. If the version is the last one that was associated with a logger definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", + "smithy.api#documentation": "The ID of the logger definition.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4345,10 +4360,10 @@ "com.amazonaws.greengrass#GetLoggerDefinitionVersionResponse": { "type": "structure", "members": { - "Version": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The version of the logger definition version." + "smithy.api#documentation": "The ARN of the logger definition version." } }, "Id": { @@ -4357,16 +4372,10 @@ "smithy.api#documentation": "The ID of the logger definition version." } }, - "Arn": { + "Version": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the logger definition version." - } - }, - "Definition": { - "target": "com.amazonaws.greengrass#LoggerDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information about the logger definition version." + "smithy.api#documentation": "The version of the logger definition version." } }, "CreationTimestamp": { @@ -4374,6 +4383,12 @@ "traits": { "smithy.api#documentation": "The time, in milliseconds since the epoch, when the logger definition version was created." } + }, + "Definition": { + "target": "com.amazonaws.greengrass#LoggerDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information about the logger definition version." + } } } }, @@ -4415,16 +4430,16 @@ "com.amazonaws.greengrass#GetResourceDefinitionResponse": { "type": "structure", "members": { - "Arn": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The name of the definition." } }, - "LatestVersion": { - "target": "com.amazonaws.greengrass#__string", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the definition." + "smithy.api#documentation": "Tag(s) attached to the resource arn." } }, "Id": { @@ -4433,34 +4448,34 @@ "smithy.api#documentation": "The ID of the definition." } }, - "LastUpdatedTimestamp": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." } }, - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the definition." + "smithy.api#documentation": "The ARN of the definition." } }, - "CreationTimestamp": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, - "Name": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "LatestVersionArn": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "The ARN of the latest version associated with the definition." } } } @@ -4511,24 +4526,12 @@ "com.amazonaws.greengrass#GetResourceDefinitionVersionResponse": { "type": "structure", "members": { - "CreationTimestamp": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the resource definition version was created." - } - }, "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "Arn of the resource definition version." } }, - "Definition": { - "target": "com.amazonaws.greengrass#ResourceDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information about the definition." - } - }, "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -4540,6 +4543,18 @@ "traits": { "smithy.api#documentation": "The version of the resource definition version." } + }, + "CreationTimestamp": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the resource definition version was created." + } + }, + "Definition": { + "target": "com.amazonaws.greengrass#ResourceDefinitionVersion", + "traits": { + "smithy.api#documentation": "Information about the definition." + } } } }, @@ -4572,16 +4587,16 @@ "com.amazonaws.greengrass#GetServiceRoleForAccountResponse": { "type": "structure", "members": { - "RoleArn": { + "AssociatedAt": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the role which is associated with the account." + "smithy.api#documentation": "The time when the service role was associated with the account." } }, - "AssociatedAt": { + "RoleArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time when the service role was associated with the account." + "smithy.api#documentation": "The ARN of the role which is associated with the account." } } } @@ -4624,16 +4639,46 @@ "com.amazonaws.greengrass#GetSubscriptionDefinitionResponse": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the definition." + } + }, + "Name": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The name of the definition." + } + }, + "tags": { + "target": "com.amazonaws.greengrass#Tags", + "traits": { + "smithy.api#documentation": "Tag(s) attached to the resource arn." + } + }, + "Arn": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ARN of the definition." + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + } + }, "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The ID of the latest version associated with the definition." } }, - "Id": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the definition." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." } }, "LatestVersionArn": { @@ -4641,126 +4686,145 @@ "traits": { "smithy.api#documentation": "The ARN of the latest version associated with the definition." } + } + } + }, + "com.amazonaws.greengrass#GetSubscriptionDefinitionVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionRequest" + }, + "output": { + "target": "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrass#BadRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a subscription definition version.", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}", + "code": 200 + } + } + }, + "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionRequest": { + "type": "structure", + "members": { + "SubscriptionDefinitionId": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the subscription definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "LastUpdatedTimestamp": { + "SubscriptionDefinitionVersionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was last updated." + "smithy.api#documentation": "The ID of the subscription definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the version is the last one that was associated with a subscription definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Name": { + "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" + } + } + } + }, + "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionResponse": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The version of the subscription definition version." + } + }, + "Id": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the subscription definition version." } }, "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the definition was created." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the subscription definition version was created." + } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } }, "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the definition." + "smithy.api#documentation": "The ARN of the subscription definition version." } }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "Definition": { + "target": "com.amazonaws.greengrass#SubscriptionDefinitionVersion", "traits": { - "smithy.api#documentation": "Tag(s) attached to the resource arn." + "smithy.api#documentation": "Information about the subscription definition version." } } } }, - "com.amazonaws.greengrass#GetSubscriptionDefinitionVersion": { + "com.amazonaws.greengrass#GetThingRuntimeConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionRequest" + "target": "com.amazonaws.greengrass#GetThingRuntimeConfigurationRequest" }, "output": { - "target": "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionResponse" + "target": "com.amazonaws.greengrass#GetThingRuntimeConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.greengrass#BadRequestException" + }, + { + "target": "com.amazonaws.greengrass#InternalServerErrorException" } ], "traits": { - "smithy.api#documentation": "Retrieves information about a subscription definition version.", + "smithy.api#documentation": "Get the runtime configuration of a thing.", "smithy.api#http": { "method": "GET", - "uri": "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}", + "uri": "/greengrass/things/{ThingName}/runtimeconfig", "code": 200 } } }, - "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionRequest": { + "com.amazonaws.greengrass#GetThingRuntimeConfigurationRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" - } - }, - "SubscriptionDefinitionId": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The ID of the subscription definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SubscriptionDefinitionVersionId": { + "ThingName": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the subscription definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the version is the last one that was associated with a subscription definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.", + "smithy.api#documentation": "The thing name.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.greengrass#GetSubscriptionDefinitionVersionResponse": { + "com.amazonaws.greengrass#GetThingRuntimeConfigurationResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The ID of the subscription definition version." - } - }, - "Arn": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The ARN of the subscription definition version." - } - }, - "Definition": { - "target": "com.amazonaws.greengrass#SubscriptionDefinitionVersion", - "traits": { - "smithy.api#documentation": "Information about the subscription definition version." - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the subscription definition version was created." - } - }, - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." - } - }, - "Version": { - "target": "com.amazonaws.greengrass#__string", + "RuntimeConfiguration": { + "target": "com.amazonaws.greengrass#RuntimeConfiguration", "traits": { - "smithy.api#documentation": "The version of the subscription definition version." + "smithy.api#documentation": "Runtime configuration for a thing." } } } @@ -4931,6 +4995,9 @@ { "target": "com.amazonaws.greengrass#GetSubscriptionDefinitionVersion" }, + { + "target": "com.amazonaws.greengrass#GetThingRuntimeConfiguration" + }, { "target": "com.amazonaws.greengrass#ListBulkDeploymentDetailedReports" }, @@ -5038,6 +5105,9 @@ }, { "target": "com.amazonaws.greengrass#UpdateSubscriptionDefinition" + }, + { + "target": "com.amazonaws.greengrass#UpdateThingRuntimeConfiguration" } ], "traits": { @@ -5078,46 +5148,46 @@ "com.amazonaws.greengrass#GroupInformation": { "type": "structure", "members": { - "CreationTimestamp": { + "LatestVersion": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the group was created." + "smithy.api#documentation": "The ID of the latest version associated with the group." } }, - "LatestVersion": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the latest version associated with the group." + "smithy.api#documentation": "The ID of the group." } }, - "LatestVersionArn": { + "Arn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the latest version associated with the group." + "smithy.api#documentation": "The ARN of the group." } }, - "LastUpdatedTimestamp": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the group was last updated." + "smithy.api#documentation": "The name of the group." } }, - "Id": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the group." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the group was created." } }, - "Name": { + "LatestVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the group." + "smithy.api#documentation": "The ARN of the latest version associated with the group." } }, - "Arn": { + "LastUpdatedTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the group." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the group was last updated." } } }, @@ -5148,46 +5218,46 @@ "com.amazonaws.greengrass#GroupVersion": { "type": "structure", "members": { - "SubscriptionDefinitionVersionArn": { + "LoggerDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the subscription definition version for this group." + "smithy.api#documentation": "The ARN of the logger definition version for this group." } }, - "LoggerDefinitionVersionArn": { + "FunctionDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the logger definition version for this group." + "smithy.api#documentation": "The ARN of the function definition version for this group." } }, - "ConnectorDefinitionVersionArn": { + "ResourceDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the connector definition version for this group." + "smithy.api#documentation": "The ARN of the resource definition version for this group." } }, - "CoreDefinitionVersionArn": { + "DeviceDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the core definition version for this group." + "smithy.api#documentation": "The ARN of the device definition version for this group." } }, - "ResourceDefinitionVersionArn": { + "CoreDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the resource definition version for this group." + "smithy.api#documentation": "The ARN of the core definition version for this group." } }, - "DeviceDefinitionVersionArn": { + "ConnectorDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the device definition version for this group." + "smithy.api#documentation": "The ARN of the connector definition version for this group." } }, - "FunctionDefinitionVersionArn": { + "SubscriptionDefinitionVersionArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the function definition version for this group." + "smithy.api#documentation": "The ARN of the subscription definition version for this group." } } }, @@ -5242,13 +5312,6 @@ "com.amazonaws.greengrass#ListBulkDeploymentDetailedReportsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" - } - }, "MaxResults": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -5263,6 +5326,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" + } } } }, @@ -5308,18 +5378,18 @@ "com.amazonaws.greengrass#ListBulkDeploymentsRequest": { "type": "structure", "members": { - "NextToken": { + "MaxResults": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "The maximum number of results to be returned per request.", + "smithy.api#httpQuery": "MaxResults" } }, - "MaxResults": { + "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The maximum number of results to be returned per request.", - "smithy.api#httpQuery": "MaxResults" + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" } } } @@ -5327,17 +5397,17 @@ "com.amazonaws.greengrass#ListBulkDeploymentsResponse": { "type": "structure", "members": { - "BulkDeployments": { - "target": "com.amazonaws.greengrass#BulkDeployments", - "traits": { - "smithy.api#documentation": "A list of bulk deployments." - } - }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } + }, + "BulkDeployments": { + "target": "com.amazonaws.greengrass#BulkDeployments", + "traits": { + "smithy.api#documentation": "A list of bulk deployments." + } } } }, @@ -5366,13 +5436,6 @@ "com.amazonaws.greengrass#ListConnectorDefinitionVersionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" - } - }, "ConnectorDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -5381,6 +5444,13 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" + } + }, "MaxResults": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -5393,17 +5463,17 @@ "com.amazonaws.greengrass#ListConnectorDefinitionVersionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." - } - }, "Versions": { "target": "com.amazonaws.greengrass#__listOfVersionInformation", "traits": { "smithy.api#documentation": "Information about a version." } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + } } } }, @@ -5485,6 +5555,14 @@ "com.amazonaws.greengrass#ListCoreDefinitionVersionsRequest": { "type": "structure", "members": { + "CoreDefinitionId": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the core definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -5498,14 +5576,6 @@ "smithy.api#documentation": "The maximum number of results to be returned per request.", "smithy.api#httpQuery": "MaxResults" } - }, - "CoreDefinitionId": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The ID of the core definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -5546,18 +5616,18 @@ "com.amazonaws.greengrass#ListCoreDefinitionsRequest": { "type": "structure", "members": { - "MaxResults": { + "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The maximum number of results to be returned per request.", - "smithy.api#httpQuery": "MaxResults" + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" } }, - "NextToken": { + "MaxResults": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "The maximum number of results to be returned per request.", + "smithy.api#httpQuery": "MaxResults" } } } @@ -5565,17 +5635,17 @@ "com.amazonaws.greengrass#ListCoreDefinitionsResponse": { "type": "structure", "members": { - "Definitions": { - "target": "com.amazonaws.greengrass#__listOfDefinitionInformation", - "traits": { - "smithy.api#documentation": "Information about a definition." - } - }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } + }, + "Definitions": { + "target": "com.amazonaws.greengrass#__listOfDefinitionInformation", + "traits": { + "smithy.api#documentation": "Information about a definition." + } } } }, @@ -5604,13 +5674,6 @@ "com.amazonaws.greengrass#ListDeploymentsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" - } - }, "MaxResults": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -5625,23 +5688,30 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" + } } } }, "com.amazonaws.greengrass#ListDeploymentsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." - } - }, "Deployments": { "target": "com.amazonaws.greengrass#Deployments", "traits": { "smithy.api#documentation": "A list of deployments for the requested groups." } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + } } } }, @@ -5670,6 +5740,13 @@ "com.amazonaws.greengrass#ListDeviceDefinitionVersionsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" + } + }, "DeviceDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -5678,13 +5755,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" - } - }, "MaxResults": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -5697,17 +5767,17 @@ "com.amazonaws.greengrass#ListDeviceDefinitionVersionsResponse": { "type": "structure", "members": { - "Versions": { - "target": "com.amazonaws.greengrass#__listOfVersionInformation", - "traits": { - "smithy.api#documentation": "Information about a version." - } - }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } + }, + "Versions": { + "target": "com.amazonaws.greengrass#__listOfVersionInformation", + "traits": { + "smithy.api#documentation": "Information about a version." + } } } }, @@ -5816,17 +5886,17 @@ "com.amazonaws.greengrass#ListFunctionDefinitionVersionsResponse": { "type": "structure", "members": { - "Versions": { - "target": "com.amazonaws.greengrass#__listOfVersionInformation", - "traits": { - "smithy.api#documentation": "Information about a version." - } - }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } + }, + "Versions": { + "target": "com.amazonaws.greengrass#__listOfVersionInformation", + "traits": { + "smithy.api#documentation": "Information about a version." + } } } }, @@ -5869,17 +5939,17 @@ "com.amazonaws.greengrass#ListFunctionDefinitionsResponse": { "type": "structure", "members": { - "Definitions": { - "target": "com.amazonaws.greengrass#__listOfDefinitionInformation", - "traits": { - "smithy.api#documentation": "Information about a definition." - } - }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } + }, + "Definitions": { + "target": "com.amazonaws.greengrass#__listOfDefinitionInformation", + "traits": { + "smithy.api#documentation": "Information about a definition." + } } } }, @@ -5984,17 +6054,17 @@ "com.amazonaws.greengrass#ListGroupVersionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." - } - }, "Versions": { "target": "com.amazonaws.greengrass#__listOfVersionInformation", "traits": { "smithy.api#documentation": "Information about a version." } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + } } } }, @@ -6076,11 +6146,11 @@ "com.amazonaws.greengrass#ListLoggerDefinitionVersionsRequest": { "type": "structure", "members": { - "NextToken": { + "MaxResults": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "The maximum number of results to be returned per request.", + "smithy.api#httpQuery": "MaxResults" } }, "LoggerDefinitionId": { @@ -6091,11 +6161,11 @@ "smithy.api#required": {} } }, - "MaxResults": { + "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The maximum number of results to be returned per request.", - "smithy.api#httpQuery": "MaxResults" + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results.", + "smithy.api#httpQuery": "NextToken" } } } @@ -6103,17 +6173,17 @@ "com.amazonaws.greengrass#ListLoggerDefinitionVersionsResponse": { "type": "structure", "members": { - "Versions": { - "target": "com.amazonaws.greengrass#__listOfVersionInformation", - "traits": { - "smithy.api#documentation": "Information about a version." - } - }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." } + }, + "Versions": { + "target": "com.amazonaws.greengrass#__listOfVersionInformation", + "traits": { + "smithy.api#documentation": "Information about a version." + } } } }, @@ -6156,17 +6226,17 @@ "com.amazonaws.greengrass#ListLoggerDefinitionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." - } - }, "Definitions": { "target": "com.amazonaws.greengrass#__listOfDefinitionInformation", "traits": { "smithy.api#documentation": "Information about a definition." } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + } } } }, @@ -6195,13 +6265,6 @@ "com.amazonaws.greengrass#ListResourceDefinitionVersionsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The maximum number of results to be returned per request.", - "smithy.api#httpQuery": "MaxResults" - } - }, "ResourceDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6210,6 +6273,13 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.", + "smithy.api#httpQuery": "MaxResults" + } + }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6222,17 +6292,17 @@ "com.amazonaws.greengrass#ListResourceDefinitionVersionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." - } - }, "Versions": { "target": "com.amazonaws.greengrass#__listOfVersionInformation", "traits": { "smithy.api#documentation": "Information about a version." } + }, + "NextToken": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or ''null'' if there are no additional results." + } } } }, @@ -6314,13 +6384,6 @@ "com.amazonaws.greengrass#ListSubscriptionDefinitionVersionsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The maximum number of results to be returned per request.", - "smithy.api#httpQuery": "MaxResults" - } - }, "SubscriptionDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6329,6 +6392,13 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.", + "smithy.api#httpQuery": "MaxResults" + } + }, "NextToken": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6454,17 +6524,17 @@ "com.amazonaws.greengrass#LocalDeviceResourceData": { "type": "structure", "members": { - "GroupOwnerSetting": { - "target": "com.amazonaws.greengrass#GroupOwnerSetting", - "traits": { - "smithy.api#documentation": "Group/owner related settings for local resources." - } - }, "SourcePath": { "target": "com.amazonaws.greengrass#__string", "traits": { "smithy.api#documentation": "The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''." } + }, + "GroupOwnerSetting": { + "target": "com.amazonaws.greengrass#GroupOwnerSetting", + "traits": { + "smithy.api#documentation": "Group/owner related settings for local resources." + } } }, "traits": { @@ -6474,12 +6544,6 @@ "com.amazonaws.greengrass#LocalVolumeResourceData": { "type": "structure", "members": { - "DestinationPath": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The absolute local path of the resource inside the Lambda environment." - } - }, "SourcePath": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6491,6 +6555,12 @@ "traits": { "smithy.api#documentation": "Allows you to configure additional group privileges for the Lambda process. This field is optional." } + }, + "DestinationPath": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The absolute local path of the resource inside the Lambda environment." + } } }, "traits": { @@ -6500,37 +6570,37 @@ "com.amazonaws.greengrass#Logger": { "type": "structure", "members": { - "Space": { - "target": "com.amazonaws.greengrass#__integer", + "Id": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The amount of file space, in KB, to use if the local file system is used for logging purposes." + "smithy.api#documentation": "A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", + "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.greengrass#LoggerType", + "Component": { + "target": "com.amazonaws.greengrass#LoggerComponent", "traits": { - "smithy.api#documentation": "The type of log output which will be used.", + "smithy.api#documentation": "The component that will be subject to logging.", "smithy.api#required": {} } }, - "Level": { - "target": "com.amazonaws.greengrass#LoggerLevel", + "Space": { + "target": "com.amazonaws.greengrass#__integer", "traits": { - "smithy.api#documentation": "The level of the logs.", - "smithy.api#required": {} + "smithy.api#documentation": "The amount of file space, in KB, to use if the local file system is used for logging purposes." } }, - "Component": { - "target": "com.amazonaws.greengrass#LoggerComponent", + "Level": { + "target": "com.amazonaws.greengrass#LoggerLevel", "traits": { - "smithy.api#documentation": "The component that will be subject to logging.", + "smithy.api#documentation": "The level of the logs.", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.greengrass#__string", + "Type": { + "target": "com.amazonaws.greengrass#LoggerType", "traits": { - "smithy.api#documentation": "A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", + "smithy.api#documentation": "The type of log output which will be used.", "smithy.api#required": {} } } @@ -6651,6 +6721,12 @@ "com.amazonaws.greengrass#ResetDeploymentsRequest": { "type": "structure", "members": { + "Force": { + "target": "com.amazonaws.greengrass#__boolean", + "traits": { + "smithy.api#documentation": "If true, performs a best-effort only core reset." + } + }, "AmznClientToken": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6665,12 +6741,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Force": { - "target": "com.amazonaws.greengrass#__boolean", - "traits": { - "smithy.api#documentation": "If true, performs a best-effort only core reset." - } } }, "traits": { @@ -6680,16 +6750,16 @@ "com.amazonaws.greengrass#ResetDeploymentsResponse": { "type": "structure", "members": { - "DeploymentId": { + "DeploymentArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the deployment." + "smithy.api#documentation": "The ARN of the deployment." } }, - "DeploymentArn": { + "DeploymentId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the deployment." + "smithy.api#documentation": "The ID of the deployment." } } } @@ -6697,13 +6767,6 @@ "com.amazonaws.greengrass#Resource": { "type": "structure", "members": { - "ResourceDataContainer": { - "target": "com.amazonaws.greengrass#ResourceDataContainer", - "traits": { - "smithy.api#documentation": "A container of data for all resource types.", - "smithy.api#required": {} - } - }, "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6717,6 +6780,13 @@ "smithy.api#documentation": "The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.", "smithy.api#required": {} } + }, + "ResourceDataContainer": { + "target": "com.amazonaws.greengrass#ResourceDataContainer", + "traits": { + "smithy.api#documentation": "A container of data for all resource types.", + "smithy.api#required": {} + } } }, "traits": { @@ -6747,18 +6817,18 @@ "com.amazonaws.greengrass#ResourceDataContainer": { "type": "structure", "members": { - "SageMakerMachineLearningModelResourceData": { - "target": "com.amazonaws.greengrass#SageMakerMachineLearningModelResourceData", - "traits": { - "smithy.api#documentation": "Attributes that define an Amazon SageMaker machine learning resource." - } - }, "SecretsManagerSecretResourceData": { "target": "com.amazonaws.greengrass#SecretsManagerSecretResourceData", "traits": { "smithy.api#documentation": "Attributes that define a secret resource, which references a secret from AWS Secrets Manager." } }, + "SageMakerMachineLearningModelResourceData": { + "target": "com.amazonaws.greengrass#SageMakerMachineLearningModelResourceData", + "traits": { + "smithy.api#documentation": "Attributes that define an Amazon SageMaker machine learning resource." + } + }, "S3MachineLearningModelResourceData": { "target": "com.amazonaws.greengrass#S3MachineLearningModelResourceData", "traits": { @@ -6793,40 +6863,48 @@ } }, "traits": { - "smithy.api#documentation": "Information about a resource definition version." + "smithy.api#documentation": "Information about a resource definition version." + } + }, + "com.amazonaws.greengrass#ResourceDownloadOwnerSetting": { + "type": "structure", + "members": { + "GroupOwner": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.", + "smithy.api#required": {} + } + }, + "GroupPermission": { + "target": "com.amazonaws.greengrass#Permission", + "traits": { + "smithy.api#documentation": "The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The owner setting for downloaded machine learning resources." } }, - "com.amazonaws.greengrass#ResourceDownloadOwnerSetting": { + "com.amazonaws.greengrass#RuntimeConfiguration": { "type": "structure", "members": { - "GroupPermission": { - "target": "com.amazonaws.greengrass#Permission", - "traits": { - "smithy.api#documentation": "The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).", - "smithy.api#required": {} - } - }, - "GroupOwner": { - "target": "com.amazonaws.greengrass#__string", + "TelemetryConfiguration": { + "target": "com.amazonaws.greengrass#TelemetryConfiguration", "traits": { - "smithy.api#documentation": "The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.", - "smithy.api#required": {} + "smithy.api#documentation": "Configuration for telemetry service." } } }, "traits": { - "smithy.api#documentation": "The owner setting for downloaded machine learning resources." + "smithy.api#documentation": "Runtime configuration for a thing." } }, "com.amazonaws.greengrass#S3MachineLearningModelResourceData": { "type": "structure", "members": { - "S3Uri": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format." - } - }, "DestinationPath": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6835,6 +6913,12 @@ }, "OwnerSetting": { "target": "com.amazonaws.greengrass#ResourceDownloadOwnerSetting" + }, + "S3Uri": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format." + } } }, "traits": { @@ -6850,6 +6934,12 @@ "com.amazonaws.greengrass#SageMakerMachineLearningModelResourceData": { "type": "structure", "members": { + "DestinationPath": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The absolute local path of the resource inside the Lambda environment." + } + }, "SageMakerJobArn": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -6858,12 +6948,6 @@ }, "OwnerSetting": { "target": "com.amazonaws.greengrass#ResourceDownloadOwnerSetting" - }, - "DestinationPath": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The absolute local path of the resource inside the Lambda environment." - } } }, "traits": { @@ -6931,31 +7015,31 @@ "com.amazonaws.greengrass#StartBulkDeploymentRequest": { "type": "structure", "members": { - "InputFileUri": { + "ExecutionRoleArn": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.", + "smithy.api#documentation": "The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.greengrass#Tags", + "AmznClientToken": { + "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Tag(s) to add to the new resource." + "smithy.api#documentation": "A client token used to correlate requests and responses.", + "smithy.api#httpHeader": "X-Amzn-Client-Token" } }, - "ExecutionRoleArn": { + "InputFileUri": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.", + "smithy.api#documentation": "The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.", "smithy.api#required": {} } }, - "AmznClientToken": { - "target": "com.amazonaws.greengrass#__string", + "tags": { + "target": "com.amazonaws.greengrass#Tags", "traits": { - "smithy.api#documentation": "A client token used to correlate requests and responses.", - "smithy.api#httpHeader": "X-Amzn-Client-Token" + "smithy.api#documentation": "Tag(s) to add to the new resource." } } } @@ -7019,17 +7103,17 @@ "com.amazonaws.greengrass#Subscription": { "type": "structure", "members": { - "Source": { + "Id": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.", + "smithy.api#documentation": "A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", "smithy.api#required": {} } }, - "Target": { + "Source": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.", + "smithy.api#documentation": "The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.", "smithy.api#required": {} } }, @@ -7040,10 +7124,10 @@ "smithy.api#required": {} } }, - "Id": { + "Target": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.", + "smithy.api#documentation": "Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.", "smithy.api#required": {} } } @@ -7116,6 +7200,57 @@ "smithy.api#documentation": "The key-value pair for the resource tag." } }, + "com.amazonaws.greengrass#Telemetry": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "On", + "name": "On" + }, + { + "value": "Off", + "name": "Off" + } + ] + } + }, + "com.amazonaws.greengrass#TelemetryConfiguration": { + "type": "structure", + "members": { + "ConfigurationSyncStatus": { + "target": "com.amazonaws.greengrass#ConfigurationSyncStatus", + "traits": { + "smithy.api#documentation": "Synchronization status of the device reported configuration with the desired configuration." + } + }, + "Telemetry": { + "target": "com.amazonaws.greengrass#Telemetry", + "traits": { + "smithy.api#documentation": "Configure telemetry to be on or off.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for running telemetry." + } + }, + "com.amazonaws.greengrass#TelemetryConfigurationUpdate": { + "type": "structure", + "members": { + "Telemetry": { + "target": "com.amazonaws.greengrass#Telemetry", + "traits": { + "smithy.api#documentation": "Configure telemetry to be on or off.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration settings for running telemetry." + } + }, "com.amazonaws.greengrass#UntagResource": { "type": "operation", "input": { @@ -7138,14 +7273,6 @@ "com.amazonaws.greengrass#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "TagKeys": { "target": "com.amazonaws.greengrass#__listOf__string", "traits": { @@ -7153,6 +7280,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "ResourceArn": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -7286,18 +7421,18 @@ "com.amazonaws.greengrass#UpdateConnectorDefinitionRequest": { "type": "structure", "members": { - "ConnectorDefinitionId": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the connector definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The name of the definition." } }, - "Name": { + "ConnectorDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the connector definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -7331,18 +7466,18 @@ "com.amazonaws.greengrass#UpdateCoreDefinitionRequest": { "type": "structure", "members": { - "CoreDefinitionId": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the core definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The name of the definition." } }, - "Name": { + "CoreDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the core definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -7491,12 +7626,6 @@ "com.amazonaws.greengrass#UpdateGroupCertificateConfigurationRequest": { "type": "structure", "members": { - "CertificateExpiryInMilliseconds": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The amount of time remaining before the certificate expires, in milliseconds." - } - }, "GroupId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -7504,6 +7633,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "CertificateExpiryInMilliseconds": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The amount of time remaining before the certificate expires, in milliseconds." + } } } }, @@ -7516,16 +7651,16 @@ "smithy.api#documentation": "The ID of the group certificate configuration." } }, - "CertificateAuthorityExpiryInMilliseconds": { + "CertificateExpiryInMilliseconds": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The amount of time remaining before the certificate authority expires, in milliseconds." + "smithy.api#documentation": "The amount of time remaining before the certificate expires, in milliseconds." } }, - "CertificateExpiryInMilliseconds": { + "CertificateAuthorityExpiryInMilliseconds": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The amount of time remaining before the certificate expires, in milliseconds." + "smithy.api#documentation": "The amount of time remaining before the certificate authority expires, in milliseconds." } } } @@ -7533,12 +7668,6 @@ "com.amazonaws.greengrass#UpdateGroupRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.greengrass#__string", - "traits": { - "smithy.api#documentation": "The name of the definition." - } - }, "GroupId": { "target": "com.amazonaws.greengrass#__string", "traits": { @@ -7546,6 +7675,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The name of the definition." + } } } }, @@ -7578,18 +7713,18 @@ "com.amazonaws.greengrass#UpdateLoggerDefinitionRequest": { "type": "structure", "members": { - "LoggerDefinitionId": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the logger definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The name of the definition." } }, - "Name": { + "LoggerDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the logger definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -7623,18 +7758,18 @@ "com.amazonaws.greengrass#UpdateResourceDefinitionRequest": { "type": "structure", "members": { - "ResourceDefinitionId": { + "Name": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ID of the resource definition.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The name of the definition." } }, - "Name": { + "ResourceDefinitionId": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The name of the definition." + "smithy.api#documentation": "The ID of the resource definition.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -7745,19 +7880,61 @@ ] } }, - "com.amazonaws.greengrass#VersionInformation": { + "com.amazonaws.greengrass#UpdateThingRuntimeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrass#UpdateThingRuntimeConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.greengrass#UpdateThingRuntimeConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrass#BadRequestException" + }, + { + "target": "com.amazonaws.greengrass#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the runtime configuration of a thing.", + "smithy.api#http": { + "method": "PUT", + "uri": "/greengrass/things/{ThingName}/runtimeconfig", + "code": 200 + } + } + }, + "com.amazonaws.greengrass#UpdateThingRuntimeConfigurationRequest": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.greengrass#__string", + "TelemetryConfiguration": { + "target": "com.amazonaws.greengrass#TelemetryConfigurationUpdate", "traits": { - "smithy.api#documentation": "The ID of the version." + "smithy.api#documentation": "Configuration for telemetry service." } }, - "CreationTimestamp": { + "ThingName": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." + "smithy.api#documentation": "The thing name.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrass#UpdateThingRuntimeConfigurationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.greengrass#VersionInformation": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ARN of the version." } }, "Id": { @@ -7766,10 +7943,16 @@ "smithy.api#documentation": "The ID of the parent definition that the version is associated with." } }, - "Arn": { + "CreationTimestamp": { "target": "com.amazonaws.greengrass#__string", "traits": { - "smithy.api#documentation": "The ARN of the version." + "smithy.api#documentation": "The time, in milliseconds since the epoch, when the version was created." + } + }, + "Version": { + "target": "com.amazonaws.greengrass#__string", + "traits": { + "smithy.api#documentation": "The ID of the version." } } }, diff --git a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json index fad106a8fa17..98944b46351f 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json +++ b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json @@ -57,15 +57,6 @@ "com.amazonaws.guardduty#AcceptInvitationRequest": { "type": "structure", "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, "InvitationId": { "target": "com.amazonaws.guardduty#String", "traits": { @@ -81,6 +72,15 @@ "smithy.api#jsonName": "masterId", "smithy.api#required": {} } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } } } }, @@ -91,18 +91,18 @@ "com.amazonaws.guardduty#AccessControlList": { "type": "structure", "members": { - "AllowsPublicReadAccess": { + "AllowsPublicWriteAccess": { "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether public read access for the bucket is enabled through an\n Access Control List (ACL).

", - "smithy.api#jsonName": "allowsPublicReadAccess" + "smithy.api#documentation": "

A value that indicates whether public write access for the bucket is enabled through an\n Access Control List (ACL).

", + "smithy.api#jsonName": "allowsPublicWriteAccess" } }, - "AllowsPublicWriteAccess": { + "AllowsPublicReadAccess": { "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether public write access for the bucket is enabled through an\n Access Control List (ACL).

", - "smithy.api#jsonName": "allowsPublicWriteAccess" + "smithy.api#documentation": "

A value that indicates whether public read access for the bucket is enabled through an\n Access Control List (ACL).

", + "smithy.api#jsonName": "allowsPublicReadAccess" } } }, @@ -113,18 +113,18 @@ "com.amazonaws.guardduty#AccessKeyDetails": { "type": "structure", "members": { - "UserName": { + "UserType": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The name of the user.

", - "smithy.api#jsonName": "userName" + "smithy.api#documentation": "

The type of the user.

", + "smithy.api#jsonName": "userType" } }, - "UserType": { + "UserName": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The type of the user.

", - "smithy.api#jsonName": "userType" + "smithy.api#documentation": "

The name of the user.

", + "smithy.api#jsonName": "userName" } }, "PrincipalId": { @@ -221,6 +221,20 @@ "com.amazonaws.guardduty#Action": { "type": "structure", "members": { + "ActionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The GuardDuty finding activity type.

", + "smithy.api#jsonName": "actionType" + } + }, + "PortProbeAction": { + "target": "com.amazonaws.guardduty#PortProbeAction", + "traits": { + "smithy.api#documentation": "

Information about the PORT_PROBE action described in this finding.

", + "smithy.api#jsonName": "portProbeAction" + } + }, "AwsApiCallAction": { "target": "com.amazonaws.guardduty#AwsApiCallAction", "traits": { @@ -235,20 +249,6 @@ "smithy.api#jsonName": "networkConnectionAction" } }, - "PortProbeAction": { - "target": "com.amazonaws.guardduty#PortProbeAction", - "traits": { - "smithy.api#documentation": "

Information about the PORT_PROBE action described in this finding.

", - "smithy.api#jsonName": "portProbeAction" - } - }, - "ActionType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The GuardDuty finding activity type.

", - "smithy.api#jsonName": "actionType" - } - }, "DnsRequestAction": { "target": "com.amazonaws.guardduty#DnsRequestAction", "traits": { @@ -342,6 +342,14 @@ "com.amazonaws.guardduty#ArchiveFindingsRequest": { "type": "structure", "members": { + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", + "traits": { + "smithy.api#documentation": "

The IDs of the findings that you want to archive.

", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -350,14 +358,6 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } - }, - "FindingIds": { - "target": "com.amazonaws.guardduty#FindingIds", - "traits": { - "smithy.api#documentation": "

The IDs of the findings that you want to archive.

", - "smithy.api#jsonName": "findingIds", - "smithy.api#required": {} - } } } }, @@ -368,11 +368,11 @@ "com.amazonaws.guardduty#AwsApiCallAction": { "type": "structure", "members": { - "RemoteIpDetails": { - "target": "com.amazonaws.guardduty#RemoteIpDetails", + "Api": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The remote IP information of the connection.

", - "smithy.api#jsonName": "remoteIpDetails" + "smithy.api#documentation": "

The AWS API name.

", + "smithy.api#jsonName": "api" } }, "ServiceName": { @@ -382,18 +382,18 @@ "smithy.api#jsonName": "serviceName" } }, - "CallerType": { + "ErrorCode": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The AWS API caller type.

", - "smithy.api#jsonName": "callerType" + "smithy.api#documentation": "

The error code of the failed AWS API action.

", + "smithy.api#jsonName": "errorCode" } }, - "Api": { + "CallerType": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The AWS API name.

", - "smithy.api#jsonName": "api" + "smithy.api#documentation": "

The AWS API caller type.

", + "smithy.api#jsonName": "callerType" } }, "DomainDetails": { @@ -402,27 +402,34 @@ "smithy.api#documentation": "

The domain information for the AWS API call.

", "smithy.api#jsonName": "domainDetails" } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#documentation": "

The remote IP information of the connection that initiated the AWS API call.

", + "smithy.api#jsonName": "remoteIpDetails" + } } }, "traits": { - "smithy.api#documentation": "

Contains information about the API operation.

" + "smithy.api#documentation": "

Contains information about the API action.

" } }, "com.amazonaws.guardduty#BadRequestException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The error type.

", - "smithy.api#jsonName": "__type" + "smithy.api#documentation": "

The error message.

", + "smithy.api#jsonName": "message" } }, - "Message": { + "Type": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The error message.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

The error type.

", + "smithy.api#jsonName": "__type" } } }, @@ -435,6 +442,13 @@ "com.amazonaws.guardduty#BlockPublicAccess": { "type": "structure", "members": { + "IgnorePublicAcls": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if S3 Block Public Access is set to IgnorePublicAcls.

", + "smithy.api#jsonName": "ignorePublicAcls" + } + }, "BlockPublicPolicy": { "target": "com.amazonaws.guardduty#Boolean", "traits": { @@ -455,13 +469,6 @@ "smithy.api#documentation": "

Indicates if S3 Block Public Access is set to BlockPublicAcls.

", "smithy.api#jsonName": "blockPublicAcls" } - }, - "IgnorePublicAcls": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates if S3 Block Public Access is set to IgnorePublicAcls.

", - "smithy.api#jsonName": "ignorePublicAcls" - } } }, "traits": { @@ -474,6 +481,13 @@ "com.amazonaws.guardduty#BucketLevelPermissions": { "type": "structure", "members": { + "BlockPublicAccess": { + "target": "com.amazonaws.guardduty#BlockPublicAccess", + "traits": { + "smithy.api#documentation": "

Contains information on which account level S3 Block Public Access settings are applied to\n the S3 bucket.

", + "smithy.api#jsonName": "blockPublicAccess" + } + }, "AccessControlList": { "target": "com.amazonaws.guardduty#AccessControlList", "traits": { @@ -487,13 +501,6 @@ "smithy.api#documentation": "

Contains information on the bucket policies for the S3 bucket.

", "smithy.api#jsonName": "bucketPolicy" } - }, - "BlockPublicAccess": { - "target": "com.amazonaws.guardduty#BlockPublicAccess", - "traits": { - "smithy.api#documentation": "

Contains information on which account level S3 Block Public Access settings are applied to\n the S3 bucket.

", - "smithy.api#jsonName": "blockPublicAccess" - } } }, "traits": { @@ -565,50 +572,49 @@ "com.amazonaws.guardduty#Condition": { "type": "structure", "members": { - "Gte": { + "Lte": { "target": "com.amazonaws.guardduty#Integer", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Represents a greater than or equal condition to be applied to a\n single field when querying for findings.

", - "smithy.api#jsonName": "gte" + "smithy.api#documentation": "

Represents a less than or equal condition to be applied to a single\n field when querying for findings.

", + "smithy.api#jsonName": "lte" } }, - "Lt": { - "target": "com.amazonaws.guardduty#Integer", + "Eq": { + "target": "com.amazonaws.guardduty#Eq", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Represents a less than condition to be applied to a single field when\n querying for findings.

", - "smithy.api#jsonName": "lt" + "smithy.api#documentation": "

Represents the equal condition to be applied to a single field when\n querying for findings.

", + "smithy.api#jsonName": "eq" } }, - "GreaterThanOrEqual": { - "target": "com.amazonaws.guardduty#Long", + "Gt": { + "target": "com.amazonaws.guardduty#Integer", "traits": { - "smithy.api#documentation": "

Represents a greater than or equal condition to be applied to a\n single field when querying for findings.

", - "smithy.api#jsonName": "greaterThanOrEqual" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

Represents a greater than condition to be applied to a single field\n when querying for findings.

", + "smithy.api#jsonName": "gt" } }, - "Neq": { - "target": "com.amazonaws.guardduty#Neq", + "LessThan": { + "target": "com.amazonaws.guardduty#Long", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Represents the not equal condition to be applied to a single field\n when querying for findings.

", - "smithy.api#jsonName": "neq" + "smithy.api#documentation": "

Represents a less than condition to be applied to a single field when\n querying for findings.

", + "smithy.api#jsonName": "lessThan" } }, - "LessThanOrEqual": { + "GreaterThanOrEqual": { "target": "com.amazonaws.guardduty#Long", "traits": { - "smithy.api#documentation": "

Represents a less than or equal condition to be applied to a single\n field when querying for findings.

", - "smithy.api#jsonName": "lessThanOrEqual" + "smithy.api#documentation": "

Represents a greater than or equal condition to be applied to a\n single field when querying for findings.

", + "smithy.api#jsonName": "greaterThanOrEqual" } }, - "Eq": { - "target": "com.amazonaws.guardduty#Eq", + "NotEquals": { + "target": "com.amazonaws.guardduty#NotEquals", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Represents the equal condition to be applied to a single field when\n querying for findings.

", - "smithy.api#jsonName": "eq" + "smithy.api#documentation": "

Represents a not equal\n condition to be applied\n to a single field when querying for findings.

", + "smithy.api#jsonName": "notEquals" } }, "Equals": { @@ -618,27 +624,27 @@ "smithy.api#jsonName": "equals" } }, - "Gt": { - "target": "com.amazonaws.guardduty#Integer", + "Neq": { + "target": "com.amazonaws.guardduty#Neq", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Represents a greater than condition to be applied to a single field\n when querying for findings.

", - "smithy.api#jsonName": "gt" + "smithy.api#documentation": "

Represents the not equal condition to be applied to a single field\n when querying for findings.

", + "smithy.api#jsonName": "neq" } }, - "NotEquals": { - "target": "com.amazonaws.guardduty#NotEquals", + "LessThanOrEqual": { + "target": "com.amazonaws.guardduty#Long", "traits": { - "smithy.api#documentation": "

Represents a not equal\n condition to be applied\n to a single field when querying for findings.

", - "smithy.api#jsonName": "notEquals" + "smithy.api#documentation": "

Represents a less than or equal condition to be applied to a single\n field when querying for findings.

", + "smithy.api#jsonName": "lessThanOrEqual" } }, - "Lte": { + "Lt": { "target": "com.amazonaws.guardduty#Integer", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Represents a less than or equal condition to be applied to a single\n field when querying for findings.

", - "smithy.api#jsonName": "lte" + "smithy.api#documentation": "

Represents a less than condition to be applied to a single field when\n querying for findings.

", + "smithy.api#jsonName": "lt" } }, "GreaterThan": { @@ -648,11 +654,12 @@ "smithy.api#jsonName": "greaterThan" } }, - "LessThan": { - "target": "com.amazonaws.guardduty#Long", + "Gte": { + "target": "com.amazonaws.guardduty#Integer", "traits": { - "smithy.api#documentation": "

Represents a less than condition to be applied to a single field when\n querying for findings.

", - "smithy.api#jsonName": "lessThan" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

Represents a greater than or equal condition to be applied to a\n single field when querying for findings.

", + "smithy.api#jsonName": "gte" } } }, @@ -719,11 +726,11 @@ "com.amazonaws.guardduty#CreateDetectorRequest": { "type": "structure", "members": { - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "FindingPublishingFrequency": { + "target": "com.amazonaws.guardduty#FindingPublishingFrequency", "traits": { - "smithy.api#documentation": "

An object that describes which data sources will be enabled for the detector.

", - "smithy.api#jsonName": "dataSources" + "smithy.api#documentation": "

An enum value that specifies how frequently updated findings are exported.

", + "smithy.api#jsonName": "findingPublishingFrequency" } }, "ClientToken": { @@ -741,11 +748,11 @@ "smithy.api#jsonName": "tags" } }, - "FindingPublishingFrequency": { - "target": "com.amazonaws.guardduty#FindingPublishingFrequency", + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", "traits": { - "smithy.api#documentation": "

An enum value that specifies how frequently updated findings are exported.

", - "smithy.api#jsonName": "findingPublishingFrequency" + "smithy.api#documentation": "

An object that describes which data sources will be enabled for the detector.

", + "smithy.api#jsonName": "dataSources" } }, "Enable": { @@ -798,28 +805,25 @@ "com.amazonaws.guardduty#CreateFilterRequest": { "type": "structure", "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "Action": { + "target": "com.amazonaws.guardduty#FilterAction", "traits": { - "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account that you want to create a filter\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the action that is to be applied to the findings that match the filter.

", + "smithy.api#jsonName": "action" } }, - "ClientToken": { - "target": "com.amazonaws.guardduty#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token for the create request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be added to a new filter resource.

", + "smithy.api#jsonName": "tags" } }, - "FindingCriteria": { - "target": "com.amazonaws.guardduty#FindingCriteria", + "Name": { + "target": "com.amazonaws.guardduty#FilterName", "traits": { - "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

\n ", - "smithy.api#jsonName": "findingCriteria", + "smithy.api#documentation": "

The name of the filter.

", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, @@ -830,26 +834,29 @@ "smithy.api#jsonName": "description" } }, - "Action": { - "target": "com.amazonaws.guardduty#FilterAction", + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

Specifies the action that is to be applied to the findings that match the filter.

", - "smithy.api#jsonName": "action" + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account that you want to create a filter\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.guardduty#FilterName", + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", "traits": { - "smithy.api#documentation": "

The name of the filter.

", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "

The idempotency token for the create request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" } }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", "traits": { - "smithy.api#documentation": "

The tags to be added to a new filter resource.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

\n ", + "smithy.api#jsonName": "findingCriteria", + "smithy.api#required": {} } }, "Rank": { @@ -902,19 +909,12 @@ "com.amazonaws.guardduty#CreateIPSetRequest": { "type": "structure", "members": { - "Format": { - "target": "com.amazonaws.guardduty#IpSetFormat", - "traits": { - "smithy.api#documentation": "

The format of the file that contains the IPSet.

", - "smithy.api#jsonName": "format", - "smithy.api#required": {} - } - }, - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether GuardDuty is to start using the uploaded\n IPSet.

", - "smithy.api#jsonName": "activate", + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account that you want to create an IPSet\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } }, @@ -926,13 +926,12 @@ "smithy.api#required": {} } }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", "traits": { - "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account that you want to create an IPSet\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} + "smithy.api#documentation": "

The idempotency token for the create request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" } }, "Name": { @@ -943,12 +942,20 @@ "smithy.api#required": {} } }, - "ClientToken": { - "target": "com.amazonaws.guardduty#ClientToken", + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

The idempotency token for the create request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" + "smithy.api#documentation": "

A Boolean value that indicates whether GuardDuty is to start using the uploaded\n IPSet.

", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#IpSetFormat", + "traits": { + "smithy.api#documentation": "

The format of the file that contains the IPSet.

", + "smithy.api#jsonName": "format", + "smithy.api#required": {} } }, "Tags": { @@ -1001,14 +1008,6 @@ "com.amazonaws.guardduty#CreateMembersRequest": { "type": "structure", "members": { - "AccountDetails": { - "target": "com.amazonaws.guardduty#AccountDetails", - "traits": { - "smithy.api#documentation": "

A list of account ID and email address pairs of the accounts that you want to associate\n with the master GuardDuty account.

", - "smithy.api#jsonName": "accountDetails", - "smithy.api#required": {} - } - }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -1017,6 +1016,14 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } + }, + "AccountDetails": { + "target": "com.amazonaws.guardduty#AccountDetails", + "traits": { + "smithy.api#documentation": "

A list of account ID and email address pairs of the accounts that you want to associate\n with the master GuardDuty account.

", + "smithy.api#jsonName": "accountDetails", + "smithy.api#required": {} + } } } }, @@ -1061,6 +1068,14 @@ "com.amazonaws.guardduty#CreatePublishingDestinationRequest": { "type": "structure", "members": { + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, "DestinationType": { "target": "com.amazonaws.guardduty#DestinationType", "traits": { @@ -1069,6 +1084,14 @@ "smithy.api#required": {} } }, + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", + "traits": { + "smithy.api#documentation": "

The properties of the publishing destination, including the ARNs for the destination and\n the KMS key used for encryption.

", + "smithy.api#jsonName": "destinationProperties", + "smithy.api#required": {} + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -1077,22 +1100,6 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } - }, - "ClientToken": { - "target": "com.amazonaws.guardduty#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token for the request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" - } - }, - "DestinationProperties": { - "target": "com.amazonaws.guardduty#DestinationProperties", - "traits": { - "smithy.api#documentation": "

The properties of the publishing destination, including the ARNs for the destination and\n the KMS key used for encryption.

", - "smithy.api#jsonName": "destinationProperties", - "smithy.api#required": {} - } } } }, @@ -1187,6 +1194,31 @@ "com.amazonaws.guardduty#CreateThreatIntelSetRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "

A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account that you want to create a\n threatIntelSet for.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether GuardDuty is to start using the uploaded\n ThreatIntelSet.

", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, "ClientToken": { "target": "com.amazonaws.guardduty#ClientToken", "traits": { @@ -1195,14 +1227,6 @@ "smithy.api#jsonName": "clientToken" } }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#documentation": "

The URI of the file that contains the ThreatIntelSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", - "smithy.api#jsonName": "location", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.guardduty#TagMap", "traits": { @@ -1210,11 +1234,11 @@ "smithy.api#jsonName": "tags" } }, - "Name": { - "target": "com.amazonaws.guardduty#Name", + "Location": { + "target": "com.amazonaws.guardduty#Location", "traits": { - "smithy.api#documentation": "

A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.

", - "smithy.api#jsonName": "name", + "smithy.api#documentation": "

The URI of the file that contains the ThreatIntelSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", + "smithy.api#jsonName": "location", "smithy.api#required": {} } }, @@ -1225,23 +1249,6 @@ "smithy.api#jsonName": "format", "smithy.api#required": {} } - }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account that you want to create a\n threatIntelSet for.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether GuardDuty is to start using the uploaded\n ThreatIntelSet.

", - "smithy.api#jsonName": "activate", - "smithy.api#required": {} - } } } }, @@ -1324,19 +1331,11 @@ "com.amazonaws.guardduty#DataSourceConfigurationsResult": { "type": "structure", "members": { - "CloudTrail": { - "target": "com.amazonaws.guardduty#CloudTrailConfigurationResult", - "traits": { - "smithy.api#documentation": "

An object that contains information on the status of CloudTrail as a data source.

", - "smithy.api#jsonName": "cloudTrail", - "smithy.api#required": {} - } - }, - "DNSLogs": { - "target": "com.amazonaws.guardduty#DNSLogsConfigurationResult", + "S3Logs": { + "target": "com.amazonaws.guardduty#S3LogsConfigurationResult", "traits": { - "smithy.api#documentation": "

An object that contains information on the status of DNS logs as a data source.

", - "smithy.api#jsonName": "dnsLogs", + "smithy.api#documentation": "

An object that contains information on the status of S3 Data event logs as a data\n source.

", + "smithy.api#jsonName": "s3Logs", "smithy.api#required": {} } }, @@ -1348,11 +1347,19 @@ "smithy.api#required": {} } }, - "S3Logs": { - "target": "com.amazonaws.guardduty#S3LogsConfigurationResult", + "CloudTrail": { + "target": "com.amazonaws.guardduty#CloudTrailConfigurationResult", "traits": { - "smithy.api#documentation": "

An object that contains information on the status of S3 Data event logs as a data\n source.

", - "smithy.api#jsonName": "s3Logs", + "smithy.api#documentation": "

An object that contains information on the status of CloudTrail as a data source.

", + "smithy.api#jsonName": "cloudTrail", + "smithy.api#required": {} + } + }, + "DNSLogs": { + "target": "com.amazonaws.guardduty#DNSLogsConfigurationResult", + "traits": { + "smithy.api#documentation": "

An object that contains information on the status of DNS logs as a data source.

", + "smithy.api#jsonName": "dnsLogs", "smithy.api#required": {} } } @@ -1440,23 +1447,23 @@ "com.amazonaws.guardduty#DefaultServerSideEncryption": { "type": "structure", "members": { - "KmsMasterKeyArn": { + "EncryptionType": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket\n EncryptionType is aws:kms.

", - "smithy.api#jsonName": "kmsMasterKeyArn" + "smithy.api#documentation": "

The type of encryption used for objects within the S3 bucket.

", + "smithy.api#jsonName": "encryptionType" } }, - "EncryptionType": { + "KmsMasterKeyArn": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The type of encryption used for objects within the S3 bucket.

", - "smithy.api#jsonName": "encryptionType" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket\n EncryptionType is aws:kms.

", + "smithy.api#jsonName": "kmsMasterKeyArn" } } }, "traits": { - "smithy.api#documentation": "

Contains information on the server side encryption method used in the S3 bucket. See\n S3\n Server-Side Encryption for more information.

" + "smithy.api#documentation": "

Contains information on the server side encryption method used in the S3 bucket. See\n S3\n Server-Side Encryption for more information.

" } }, "com.amazonaws.guardduty#DeleteDetector": { @@ -1530,15 +1537,6 @@ "com.amazonaws.guardduty#DeleteFilterRequest": { "type": "structure", "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "

The unique ID of the detector that the filter is associated with.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, "FilterName": { "target": "com.amazonaws.guardduty#String", "traits": { @@ -1547,12 +1545,21 @@ "smithy.api#jsonName": "filterName", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.guardduty#DeleteFilterResponse": { - "type": "structure", - "members": {} + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector that the filter is associated with.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.guardduty#DeleteFilterResponse": { + "type": "structure", + "members": {} }, "com.amazonaws.guardduty#DeleteIPSet": { "type": "operation", @@ -1685,6 +1692,14 @@ "com.amazonaws.guardduty#DeleteMembersRequest": { "type": "structure", "members": { + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "

A list of account IDs of the GuardDuty member accounts that you want to delete.

", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -1693,14 +1708,6 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#documentation": "

A list of account IDs of the GuardDuty member accounts that you want to delete.

", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } } } }, @@ -1797,21 +1804,21 @@ "com.amazonaws.guardduty#DeleteThreatIntelSetRequest": { "type": "structure", "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "ThreatIntelSetId": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The unique ID of the detector that the threatIntelSet is associated with.

", + "smithy.api#documentation": "

The unique ID of the threatIntelSet that you want to delete.

", "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", + "smithy.api#jsonName": "threatIntelSetId", "smithy.api#required": {} } }, - "ThreatIntelSetId": { - "target": "com.amazonaws.guardduty#String", + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

The unique ID of the threatIntelSet that you want to delete.

", + "smithy.api#documentation": "

The unique ID of the detector that the threatIntelSet is associated with.

", "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "threatIntelSetId", + "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } } @@ -1863,11 +1870,11 @@ "com.amazonaws.guardduty#DescribeOrganizationConfigurationResponse": { "type": "structure", "members": { - "AutoEnable": { + "MemberAccountLimitReached": { "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether GuardDuty is automatically enabled for accounts added to the\n organization.

", - "smithy.api#jsonName": "autoEnable", + "smithy.api#documentation": "

Indicates whether the maximum number of allowed member accounts are already associated\n with the delegated administrator master account.

", + "smithy.api#jsonName": "memberAccountLimitReached", "smithy.api#required": {} } }, @@ -1878,11 +1885,11 @@ "smithy.api#jsonName": "dataSources" } }, - "MemberAccountLimitReached": { + "AutoEnable": { "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the maximum number of allowed member accounts are already associated\n with the delegated administrator master account.

", - "smithy.api#jsonName": "memberAccountLimitReached", + "smithy.api#documentation": "

Indicates whether GuardDuty is automatically enabled for accounts added to the\n organization.

", + "smithy.api#jsonName": "autoEnable", "smithy.api#required": {} } } @@ -1916,21 +1923,21 @@ "com.amazonaws.guardduty#DescribePublishingDestinationRequest": { "type": "structure", "members": { - "DestinationId": { - "target": "com.amazonaws.guardduty#String", + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

The ID of the publishing destination to retrieve.

", + "smithy.api#documentation": "

The unique ID of the detector associated with the publishing destination to\n retrieve.

", "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "destinationId", + "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "DestinationId": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The unique ID of the detector associated with the publishing destination to\n retrieve.

", + "smithy.api#documentation": "

The ID of the publishing destination to retrieve.

", "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", + "smithy.api#jsonName": "destinationId", "smithy.api#required": {} } } @@ -1939,19 +1946,11 @@ "com.amazonaws.guardduty#DescribePublishingDestinationResponse": { "type": "structure", "members": { - "DestinationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The ID of the publishing destination.

", - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } - }, - "PublishingFailureStartTimestamp": { - "target": "com.amazonaws.guardduty#Long", + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", "traits": { - "smithy.api#documentation": "

The time, in epoch millisecond format, at which GuardDuty was first unable to publish\n findings to the destination.

", - "smithy.api#jsonName": "publishingFailureStartTimestamp", + "smithy.api#documentation": "

A DestinationProperties object that includes the DestinationArn\n and KmsKeyArn of the publishing destination.

", + "smithy.api#jsonName": "destinationProperties", "smithy.api#required": {} } }, @@ -1963,11 +1962,11 @@ "smithy.api#required": {} } }, - "DestinationProperties": { - "target": "com.amazonaws.guardduty#DestinationProperties", + "PublishingFailureStartTimestamp": { + "target": "com.amazonaws.guardduty#Long", "traits": { - "smithy.api#documentation": "

A DestinationProperties object that includes the DestinationArn\n and KmsKeyArn of the publishing destination.

", - "smithy.api#jsonName": "destinationProperties", + "smithy.api#documentation": "

The time, in epoch millisecond format, at which GuardDuty was first unable to publish\n findings to the destination.

", + "smithy.api#jsonName": "publishingFailureStartTimestamp", "smithy.api#required": {} } }, @@ -1978,12 +1977,28 @@ "smithy.api#jsonName": "destinationType", "smithy.api#required": {} } + }, + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The ID of the publishing destination.

", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } } } }, "com.amazonaws.guardduty#Destination": { "type": "structure", "members": { + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the publishing destination.

", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + }, "Status": { "target": "com.amazonaws.guardduty#PublishingStatus", "traits": { @@ -1999,14 +2014,6 @@ "smithy.api#jsonName": "destinationType", "smithy.api#required": {} } - }, - "DestinationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The unique ID of the publishing destination.

", - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } } }, "traits": { @@ -2016,18 +2023,18 @@ "com.amazonaws.guardduty#DestinationProperties": { "type": "structure", "members": { - "DestinationArn": { + "KmsKeyArn": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The ARN of the resource to publish to.

", - "smithy.api#jsonName": "destinationArn" + "smithy.api#documentation": "

The ARN of the KMS key to use for encryption.

", + "smithy.api#jsonName": "kmsKeyArn" } }, - "KmsKeyArn": { + "DestinationArn": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The ARN of the KMS key to use for encryption.

", - "smithy.api#jsonName": "kmsKeyArn" + "smithy.api#documentation": "

The ARN of the resource to publish to.

", + "smithy.api#jsonName": "destinationArn" } } }, @@ -2209,14 +2216,6 @@ "com.amazonaws.guardduty#DisassociateMembersRequest": { "type": "structure", "members": { - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#documentation": "

A list of account IDs of the GuardDuty member accounts that you want to disassociate from\n the master account.

", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -2225,6 +2224,14 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "

A list of account IDs of the GuardDuty member accounts that you want to disassociate from\n the master account.

", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } } } }, @@ -2428,25 +2435,11 @@ "com.amazonaws.guardduty#Finding": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.guardduty#FindingType", - "traits": { - "smithy.api#documentation": "

The type of finding.

", - "smithy.api#jsonName": "type", - "smithy.api#required": {} - } - }, - "Service": { - "target": "com.amazonaws.guardduty#Service", - "traits": { - "smithy.api#jsonName": "service" - } - }, - "AccountId": { + "UpdatedAt": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The ID of the account in which the finding was generated.

", - "smithy.api#jsonName": "accountId", + "smithy.api#documentation": "

The time and date when the finding was last updated.

", + "smithy.api#jsonName": "updatedAt", "smithy.api#required": {} } }, @@ -2457,49 +2450,65 @@ "smithy.api#jsonName": "confidence" } }, - "SchemaVersion": { + "Resource": { + "target": "com.amazonaws.guardduty#Resource", + "traits": { + "smithy.api#jsonName": "resource", + "smithy.api#required": {} + } + }, + "Region": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The version of the schema used for the finding.

", - "smithy.api#jsonName": "schemaVersion", + "smithy.api#documentation": "

The Region where the finding was generated.

", + "smithy.api#jsonName": "region", "smithy.api#required": {} } }, - "Severity": { - "target": "com.amazonaws.guardduty#Double", + "Type": { + "target": "com.amazonaws.guardduty#FindingType", "traits": { - "smithy.api#documentation": "

The severity of the finding.

", - "smithy.api#jsonName": "severity", + "smithy.api#documentation": "

The type of finding.

", + "smithy.api#jsonName": "type", "smithy.api#required": {} } }, - "Title": { + "Arn": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The title of the finding.

", - "smithy.api#jsonName": "title" + "smithy.api#documentation": "

The ARN of the finding.

", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} } }, - "Region": { + "AccountId": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The Region where the finding was generated.

", - "smithy.api#jsonName": "region", + "smithy.api#documentation": "

The ID of the account in which the finding was generated.

", + "smithy.api#jsonName": "accountId", "smithy.api#required": {} } }, - "UpdatedAt": { + "Description": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The time and date when the finding was last updated.

", - "smithy.api#jsonName": "updatedAt", + "smithy.api#documentation": "

The description of the finding.

", + "smithy.api#jsonName": "description" + } + }, + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The ID of the finding.

", + "smithy.api#jsonName": "id", "smithy.api#required": {} } }, - "Resource": { - "target": "com.amazonaws.guardduty#Resource", + "CreatedAt": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#jsonName": "resource", + "smithy.api#documentation": "

The time and date when the finding was created.

", + "smithy.api#jsonName": "createdAt", "smithy.api#required": {} } }, @@ -2510,35 +2519,33 @@ "smithy.api#jsonName": "partition" } }, - "Arn": { - "target": "com.amazonaws.guardduty#String", + "Severity": { + "target": "com.amazonaws.guardduty#Double", "traits": { - "smithy.api#documentation": "

The ARN of the finding.

", - "smithy.api#jsonName": "arn", + "smithy.api#documentation": "

The severity of the finding.

", + "smithy.api#jsonName": "severity", "smithy.api#required": {} } }, - "CreatedAt": { + "Title": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The time and date when the finding was created.

", - "smithy.api#jsonName": "createdAt", - "smithy.api#required": {} + "smithy.api#documentation": "

The title of the finding.

", + "smithy.api#jsonName": "title" } }, - "Description": { + "SchemaVersion": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The description of the finding.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The version of the schema used for the finding.

", + "smithy.api#jsonName": "schemaVersion", + "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.guardduty#String", + "Service": { + "target": "com.amazonaws.guardduty#Service", "traits": { - "smithy.api#documentation": "

The ID of the finding.

", - "smithy.api#jsonName": "id", - "smithy.api#required": {} + "smithy.api#jsonName": "service" } } }, @@ -2752,18 +2759,12 @@ "com.amazonaws.guardduty#GetDetectorResponse": { "type": "structure", "members": { - "UpdatedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The last-updated timestamp for the detector.

", - "smithy.api#jsonName": "updatedAt" - } - }, - "CreatedAt": { - "target": "com.amazonaws.guardduty#String", + "Status": { + "target": "com.amazonaws.guardduty#DetectorStatus", "traits": { - "smithy.api#documentation": "

The timestamp of when the detector was created.

", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "

The detector status.

", + "smithy.api#jsonName": "status", + "smithy.api#required": {} } }, "Tags": { @@ -2773,6 +2774,13 @@ "smithy.api#jsonName": "tags" } }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The timestamp of when the detector was created.

", + "smithy.api#jsonName": "createdAt" + } + }, "DataSources": { "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", "traits": { @@ -2780,20 +2788,11 @@ "smithy.api#jsonName": "dataSources" } }, - "ServiceRole": { + "UpdatedAt": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The GuardDuty service role.

", - "smithy.api#jsonName": "serviceRole", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.guardduty#DetectorStatus", - "traits": { - "smithy.api#documentation": "

The detector status.

", - "smithy.api#jsonName": "status", - "smithy.api#required": {} + "smithy.api#documentation": "

The last-updated timestamp for the detector.

", + "smithy.api#jsonName": "updatedAt" } }, "FindingPublishingFrequency": { @@ -2802,6 +2801,14 @@ "smithy.api#documentation": "

The publishing frequency of the finding.

", "smithy.api#jsonName": "findingPublishingFrequency" } + }, + "ServiceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The GuardDuty service role.

", + "smithy.api#jsonName": "serviceRole", + "smithy.api#required": {} + } } } }, @@ -2833,21 +2840,21 @@ "com.amazonaws.guardduty#GetFilterRequest": { "type": "structure", "members": { - "FilterName": { - "target": "com.amazonaws.guardduty#String", + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

The name of the filter you want to get.

", + "smithy.api#documentation": "

The unique ID of the detector that the filter is associated with.

", "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "filterName", + "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "FilterName": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The unique ID of the detector that the filter is associated with.

", + "smithy.api#documentation": "

The name of the filter you want to get.

", "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", + "smithy.api#jsonName": "filterName", "smithy.api#required": {} } } @@ -2864,6 +2871,14 @@ "smithy.api#required": {} } }, + "Name": { + "target": "com.amazonaws.guardduty#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, "Description": { "target": "com.amazonaws.guardduty#FilterDescription", "traits": { @@ -2879,14 +2894,6 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.guardduty#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the filter.

", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.guardduty#TagMap", "traits": { @@ -2931,13 +2938,6 @@ "com.amazonaws.guardduty#GetFindingsRequest": { "type": "structure", "members": { - "SortCriteria": { - "target": "com.amazonaws.guardduty#SortCriteria", - "traits": { - "smithy.api#documentation": "

Represents the criteria used for sorting findings.

", - "smithy.api#jsonName": "sortCriteria" - } - }, "FindingIds": { "target": "com.amazonaws.guardduty#FindingIds", "traits": { @@ -2946,6 +2946,13 @@ "smithy.api#required": {} } }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "

Represents the criteria used for sorting findings.

", + "smithy.api#jsonName": "sortCriteria" + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -2998,6 +3005,14 @@ "com.amazonaws.guardduty#GetFindingsStatisticsRequest": { "type": "structure", "members": { + "FindingStatisticTypes": { + "target": "com.amazonaws.guardduty#FindingStatisticTypes", + "traits": { + "smithy.api#documentation": "

The types of finding statistics to retrieve.

", + "smithy.api#jsonName": "findingStatisticTypes", + "smithy.api#required": {} + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -3007,14 +3022,6 @@ "smithy.api#required": {} } }, - "FindingStatisticTypes": { - "target": "com.amazonaws.guardduty#FindingStatisticTypes", - "traits": { - "smithy.api#documentation": "

The types of finding statistics to retrieve.

", - "smithy.api#jsonName": "findingStatisticTypes", - "smithy.api#required": {} - } - }, "FindingCriteria": { "target": "com.amazonaws.guardduty#FindingCriteria", "traits": { @@ -3088,14 +3095,21 @@ "com.amazonaws.guardduty#GetIPSetResponse": { "type": "structure", "members": { - "Location": { - "target": "com.amazonaws.guardduty#Location", + "Format": { + "target": "com.amazonaws.guardduty#IpSetFormat", "traits": { - "smithy.api#documentation": "

The URI of the file that contains the IPSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", - "smithy.api#jsonName": "location", + "smithy.api#documentation": "

The format of the file that contains the IPSet.

", + "smithy.api#jsonName": "format", "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the IPSet resource.

", + "smithy.api#jsonName": "tags" + } + }, "Status": { "target": "com.amazonaws.guardduty#IpSetStatus", "traits": { @@ -3104,13 +3118,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the IPSet resource.

", - "smithy.api#jsonName": "tags" - } - }, "Name": { "target": "com.amazonaws.guardduty#Name", "traits": { @@ -3119,11 +3126,11 @@ "smithy.api#required": {} } }, - "Format": { - "target": "com.amazonaws.guardduty#IpSetFormat", + "Location": { + "target": "com.amazonaws.guardduty#Location", "traits": { - "smithy.api#documentation": "

The format of the file that contains the IPSet.

", - "smithy.api#jsonName": "format", + "smithy.api#documentation": "

The URI of the file that contains the IPSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", + "smithy.api#jsonName": "location", "smithy.api#required": {} } } @@ -3272,14 +3279,6 @@ "com.amazonaws.guardduty#GetMemberDetectorsResponse": { "type": "structure", "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#documentation": "

A list of member account IDs that were unable to be processed along with an explanation\n for why they were not processed.

", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - }, "MemberDataSourceConfigurations": { "target": "com.amazonaws.guardduty#MemberDataSourceConfigurations", "traits": { @@ -3287,6 +3286,14 @@ "smithy.api#jsonName": "members", "smithy.api#required": {} } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#documentation": "

A list of member account IDs that were unable to be processed along with an explanation\n for why they were not processed.

", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } } } }, @@ -3340,14 +3347,6 @@ "com.amazonaws.guardduty#GetMembersResponse": { "type": "structure", "members": { - "Members": { - "target": "com.amazonaws.guardduty#Members", - "traits": { - "smithy.api#documentation": "

A list of members.

", - "smithy.api#jsonName": "members", - "smithy.api#required": {} - } - }, "UnprocessedAccounts": { "target": "com.amazonaws.guardduty#UnprocessedAccounts", "traits": { @@ -3355,6 +3354,14 @@ "smithy.api#jsonName": "unprocessedAccounts", "smithy.api#required": {} } + }, + "Members": { + "target": "com.amazonaws.guardduty#Members", + "traits": { + "smithy.api#documentation": "

A list of members.

", + "smithy.api#jsonName": "members", + "smithy.api#required": {} + } } } }, @@ -3409,12 +3416,11 @@ "com.amazonaws.guardduty#GetThreatIntelSetResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.guardduty#Name", + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", "traits": { - "smithy.api#documentation": "

A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.

", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags of the threat list resource.

", + "smithy.api#jsonName": "tags" } }, "Format": { @@ -3425,14 +3431,6 @@ "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.guardduty#ThreatIntelSetStatus", - "traits": { - "smithy.api#documentation": "

The status of threatIntelSet file uploaded.

", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - }, "Location": { "target": "com.amazonaws.guardduty#Location", "traits": { @@ -3441,11 +3439,20 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", + "Name": { + "target": "com.amazonaws.guardduty#Name", "traits": { - "smithy.api#documentation": "

The tags of the threat list resource.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#ThreatIntelSetStatus", + "traits": { + "smithy.api#documentation": "

The status of threatIntelSet file uploaded.

", + "smithy.api#jsonName": "status", + "smithy.api#required": {} } } } @@ -3483,14 +3490,6 @@ "com.amazonaws.guardduty#GetUsageStatisticsRequest": { "type": "structure", "members": { - "UsageCriteria": { - "target": "com.amazonaws.guardduty#UsageCriteria", - "traits": { - "smithy.api#documentation": "

Represents the criteria used for querying usage.

", - "smithy.api#jsonName": "usageCriteria", - "smithy.api#required": {} - } - }, "UsageStatisticType": { "target": "com.amazonaws.guardduty#UsageStatisticType", "traits": { @@ -3499,6 +3498,13 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

", + "smithy.api#jsonName": "maxResults" + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -3508,18 +3514,12 @@ "smithy.api#required": {} } }, - "Unit": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The currency unit you would like to view your usage statistics in. Current valid values\n are USD.

", - "smithy.api#jsonName": "unit" - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", + "UsageCriteria": { + "target": "com.amazonaws.guardduty#UsageCriteria", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

", - "smithy.api#jsonName": "maxResults" + "smithy.api#documentation": "

Represents the criteria used for querying usage.

", + "smithy.api#jsonName": "usageCriteria", + "smithy.api#required": {} } }, "NextToken": { @@ -3528,25 +3528,32 @@ "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results after the first\n page.

", "smithy.api#jsonName": "nextToken" } + }, + "Unit": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The currency unit you would like to view your usage statistics in. Current valid values\n are USD.

", + "smithy.api#jsonName": "unit" + } } } }, "com.amazonaws.guardduty#GetUsageStatisticsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", - "smithy.api#jsonName": "nextToken" - } - }, "UsageStatistics": { "target": "com.amazonaws.guardduty#UsageStatistics", "traits": { "smithy.api#documentation": "

The usage statistics object. If a UsageStatisticType was provided, the objects\n representing other types will be null.

", "smithy.api#jsonName": "usageStatistics" } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -3775,32 +3782,32 @@ "com.amazonaws.guardduty#InstanceDetails": { "type": "structure", "members": { - "ProductCodes": { - "target": "com.amazonaws.guardduty#ProductCodes", + "InstanceId": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The product code of the EC2 instance.

", - "smithy.api#jsonName": "productCodes" + "smithy.api#documentation": "

The ID of the EC2 instance.

", + "smithy.api#jsonName": "instanceId" } }, - "ImageDescription": { + "Platform": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The image description of the EC2 instance.

", - "smithy.api#jsonName": "imageDescription" + "smithy.api#documentation": "

The platform of the EC2 instance.

", + "smithy.api#jsonName": "platform" } }, - "IamInstanceProfile": { - "target": "com.amazonaws.guardduty#IamInstanceProfile", + "InstanceType": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The profile information of the EC2 instance.

", - "smithy.api#jsonName": "iamInstanceProfile" + "smithy.api#documentation": "

The type of the EC2 instance.

", + "smithy.api#jsonName": "instanceType" } }, - "OutpostArn": { + "LaunchTime": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS Outposts\n instances.

", - "smithy.api#jsonName": "outpostArn" + "smithy.api#documentation": "

The launch time of the EC2 instance.

", + "smithy.api#jsonName": "launchTime" } }, "AvailabilityZone": { @@ -3810,39 +3817,32 @@ "smithy.api#jsonName": "availabilityZone" } }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "

The tags of the EC2 instance.

", - "smithy.api#jsonName": "tags" - } - }, - "InstanceType": { - "target": "com.amazonaws.guardduty#String", + "ProductCodes": { + "target": "com.amazonaws.guardduty#ProductCodes", "traits": { - "smithy.api#documentation": "

The type of the EC2 instance.

", - "smithy.api#jsonName": "instanceType" + "smithy.api#documentation": "

The product code of the EC2 instance.

", + "smithy.api#jsonName": "productCodes" } }, - "Platform": { + "InstanceState": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The platform of the EC2 instance.

", - "smithy.api#jsonName": "platform" + "smithy.api#documentation": "

The state of the EC2 instance.

", + "smithy.api#jsonName": "instanceState" } }, - "LaunchTime": { - "target": "com.amazonaws.guardduty#String", + "NetworkInterfaces": { + "target": "com.amazonaws.guardduty#NetworkInterfaces", "traits": { - "smithy.api#documentation": "

The launch time of the EC2 instance.

", - "smithy.api#jsonName": "launchTime" + "smithy.api#documentation": "

The elastic network interface information of the EC2 instance.

", + "smithy.api#jsonName": "networkInterfaces" } }, - "InstanceState": { + "OutpostArn": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The state of the EC2 instance.

", - "smithy.api#jsonName": "instanceState" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS Outposts\n instances.

", + "smithy.api#jsonName": "outpostArn" } }, "ImageId": { @@ -3852,18 +3852,25 @@ "smithy.api#jsonName": "imageId" } }, - "NetworkInterfaces": { - "target": "com.amazonaws.guardduty#NetworkInterfaces", + "IamInstanceProfile": { + "target": "com.amazonaws.guardduty#IamInstanceProfile", "traits": { - "smithy.api#documentation": "

The elastic network interface information of the EC2 instance.

", - "smithy.api#jsonName": "networkInterfaces" + "smithy.api#documentation": "

The profile information of the EC2 instance.

", + "smithy.api#jsonName": "iamInstanceProfile" } }, - "InstanceId": { + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "

The tags of the EC2 instance.

", + "smithy.api#jsonName": "tags" + } + }, + "ImageDescription": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The ID of the EC2 instance.

", - "smithy.api#jsonName": "instanceId" + "smithy.api#documentation": "

The image description of the EC2 instance.

", + "smithy.api#jsonName": "imageDescription" } } }, @@ -3901,18 +3908,18 @@ "com.amazonaws.guardduty#Invitation": { "type": "structure", "members": { - "InvitedAt": { + "RelationshipStatus": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The timestamp when the invitation was sent.

", - "smithy.api#jsonName": "invitedAt" + "smithy.api#documentation": "

The status of the relationship between the inviter and invitee accounts.

", + "smithy.api#jsonName": "relationshipStatus" } }, - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The ID of the account that the invitation was sent from.

", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "

The timestamp when the invitation was sent.

", + "smithy.api#jsonName": "invitedAt" } }, "InvitationId": { @@ -3922,11 +3929,11 @@ "smithy.api#jsonName": "invitationId" } }, - "RelationshipStatus": { - "target": "com.amazonaws.guardduty#String", + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", "traits": { - "smithy.api#documentation": "

The status of the relationship between the inviter and invitee accounts.

", - "smithy.api#jsonName": "relationshipStatus" + "smithy.api#documentation": "

The ID of the account that the invitation was sent from.

", + "smithy.api#jsonName": "accountId" } } }, @@ -3974,11 +3981,12 @@ "com.amazonaws.guardduty#InviteMembersRequest": { "type": "structure", "members": { - "DisableEmailNotification": { - "target": "com.amazonaws.guardduty#Boolean", + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", "traits": { - "smithy.api#documentation": "

A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

", - "smithy.api#jsonName": "disableEmailNotification" + "smithy.api#documentation": "

A list of account IDs of the accounts that you want to invite to GuardDuty as\n members.

", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} } }, "Message": { @@ -3988,12 +3996,11 @@ "smithy.api#jsonName": "message" } }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", + "DisableEmailNotification": { + "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

A list of account IDs of the accounts that you want to invite to GuardDuty as\n members.

", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} + "smithy.api#documentation": "

A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

", + "smithy.api#jsonName": "disableEmailNotification" } }, "DetectorId": { @@ -4166,6 +4173,13 @@ "com.amazonaws.guardduty#ListDetectorsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", + "smithy.api#jsonName": "nextToken" + } + }, "DetectorIds": { "target": "com.amazonaws.guardduty#DetectorIds", "traits": { @@ -4173,13 +4187,6 @@ "smithy.api#jsonName": "detectorIds", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", - "smithy.api#jsonName": "nextToken" - } } } }, @@ -4246,6 +4253,13 @@ "com.amazonaws.guardduty#ListFiltersResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", + "smithy.api#jsonName": "nextToken" + } + }, "FilterNames": { "target": "com.amazonaws.guardduty#FilterNames", "traits": { @@ -4253,13 +4267,6 @@ "smithy.api#jsonName": "filterNames", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", - "smithy.api#jsonName": "nextToken" - } } } }, @@ -4296,6 +4303,20 @@ "com.amazonaws.guardduty#ListFindingsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.

", + "smithy.api#jsonName": "nextToken" + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "

Represents the criteria used for sorting findings.

", + "smithy.api#jsonName": "sortCriteria" + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -4312,26 +4333,12 @@ "smithy.api#jsonName": "maxResults" } }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.

", - "smithy.api#jsonName": "nextToken" - } - }, "FindingCriteria": { "target": "com.amazonaws.guardduty#FindingCriteria", "traits": { "smithy.api#documentation": "

Represents the criteria used for querying findings. Valid values include:

\n ", "smithy.api#jsonName": "findingCriteria" } - }, - "SortCriteria": { - "target": "com.amazonaws.guardduty#SortCriteria", - "traits": { - "smithy.api#documentation": "

Represents the criteria used for sorting findings.

", - "smithy.api#jsonName": "sortCriteria" - } } } }, @@ -4397,14 +4404,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.

", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.guardduty#MaxResults", "traits": { @@ -4412,6 +4411,14 @@ "smithy.api#httpQuery": "maxResults", "smithy.api#jsonName": "maxResults" } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -4538,6 +4545,22 @@ "com.amazonaws.guardduty#ListMembersRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + }, + "OnlyAssociated": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

Specifies whether to only return associated members or to return all members (including\n members who haven't been invited yet or have been disassociated).

", + "smithy.api#httpQuery": "onlyAssociated", + "smithy.api#jsonName": "onlyAssociated" + } + }, "MaxResults": { "target": "com.amazonaws.guardduty#MaxResults", "traits": { @@ -4554,41 +4577,25 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.

", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - }, - "OnlyAssociated": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

Specifies whether to only return associated members or to return all members (including\n members who haven't been invited yet or have been disassociated).

", - "smithy.api#httpQuery": "onlyAssociated", - "smithy.api#jsonName": "onlyAssociated" - } } } }, "com.amazonaws.guardduty#ListMembersResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", - "smithy.api#jsonName": "nextToken" - } - }, "Members": { "target": "com.amazonaws.guardduty#Members", "traits": { "smithy.api#documentation": "

A list of members.

", "smithy.api#jsonName": "members" } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -4625,14 +4632,6 @@ "com.amazonaws.guardduty#ListOrganizationAdminAccountsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, "NextToken": { "target": "com.amazonaws.guardduty#String", "traits": { @@ -4640,25 +4639,33 @@ "smithy.api#httpQuery": "nextToken", "smithy.api#jsonName": "nextToken" } - } - } - }, - "com.amazonaws.guardduty#ListOrganizationAdminAccountsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.guardduty#String", + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "

The maximum number of results to return in the response.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" } - }, + } + } + }, + "com.amazonaws.guardduty#ListOrganizationAdminAccountsResponse": { + "type": "structure", + "members": { "AdminAccounts": { "target": "com.amazonaws.guardduty#AdminAccounts", "traits": { "smithy.api#documentation": "

An AdminAccounts object that includes a list of accounts configured as GuardDuty delegated\n administrators.

", "smithy.api#jsonName": "adminAccounts" } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -4695,13 +4702,12 @@ "com.amazonaws.guardduty#ListPublishingDestinationsRequest": { "type": "structure", "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "NextToken": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The ID of the detector to retrieve publishing destinations for.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" } }, "MaxResults": { @@ -4712,12 +4718,13 @@ "smithy.api#jsonName": "maxResults" } }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.

", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "

The ID of the detector to retrieve publishing destinations for.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} } } } @@ -4725,6 +4732,13 @@ "com.amazonaws.guardduty#ListPublishingDestinationsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.

", + "smithy.api#jsonName": "nextToken" + } + }, "Destinations": { "target": "com.amazonaws.guardduty#Destinations", "traits": { @@ -4732,13 +4746,6 @@ "smithy.api#jsonName": "destinations", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.

", - "smithy.api#jsonName": "nextToken" - } } } }, @@ -4826,12 +4833,12 @@ "com.amazonaws.guardduty#ListThreatIntelSetsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.guardduty#String", + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", "traits": { - "smithy.api#documentation": "

You can use this parameter to paginate results in the response. Set the value of this\n parameter to null on your first call to the list action. For subsequent calls to the action,\n fill nextToken in the request with the value of NextToken from the previous response to\n continue listing data.

", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" } }, "DetectorId": { @@ -4843,12 +4850,12 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", + "NextToken": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" + "smithy.api#documentation": "

You can use this parameter to paginate results in the response. Set the value of this\n parameter to null on your first call to the list action. For subsequent calls to the action,\n fill nextToken in the request with the value of NextToken from the previous response to\n continue listing data.

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" } } } @@ -4925,18 +4932,11 @@ "com.amazonaws.guardduty#Master": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the account used as the master account.

", - "smithy.api#jsonName": "accountId" - } - }, - "InvitedAt": { + "InvitationId": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The timestamp when the invitation was sent.

", - "smithy.api#jsonName": "invitedAt" + "smithy.api#documentation": "

The value used to validate the master account to the member account.

", + "smithy.api#jsonName": "invitationId" } }, "RelationshipStatus": { @@ -4946,11 +4946,18 @@ "smithy.api#jsonName": "relationshipStatus" } }, - "InvitationId": { + "InvitedAt": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The value used to validate the master account to the member account.

", - "smithy.api#jsonName": "invitationId" + "smithy.api#documentation": "

The timestamp when the invitation was sent.

", + "smithy.api#jsonName": "invitedAt" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account used as the master account.

", + "smithy.api#jsonName": "accountId" } } }, @@ -4970,11 +4977,11 @@ "com.amazonaws.guardduty#Member": { "type": "structure", "members": { - "RelationshipStatus": { + "UpdatedAt": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The status of the relationship between the member and the master.

", - "smithy.api#jsonName": "relationshipStatus", + "smithy.api#documentation": "

The last-updated timestamp of the member.

", + "smithy.api#jsonName": "updatedAt", "smithy.api#required": {} } }, @@ -4994,11 +5001,11 @@ "smithy.api#required": {} } }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#String", + "Email": { + "target": "com.amazonaws.guardduty#Email", "traits": { - "smithy.api#documentation": "

The last-updated timestamp of the member.

", - "smithy.api#jsonName": "updatedAt", + "smithy.api#documentation": "

The email address of the member account.

", + "smithy.api#jsonName": "email", "smithy.api#required": {} } }, @@ -5009,19 +5016,19 @@ "smithy.api#jsonName": "detectorId" } }, - "InvitedAt": { + "RelationshipStatus": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The timestamp when the invitation was sent.

", - "smithy.api#jsonName": "invitedAt" + "smithy.api#documentation": "

The status of the relationship between the member and the master.

", + "smithy.api#jsonName": "relationshipStatus", + "smithy.api#required": {} } }, - "Email": { - "target": "com.amazonaws.guardduty#Email", + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The email address of the member account.

", - "smithy.api#jsonName": "email", - "smithy.api#required": {} + "smithy.api#documentation": "

The timestamp when the invitation was sent.

", + "smithy.api#jsonName": "invitedAt" } } }, @@ -5032,14 +5039,6 @@ "com.amazonaws.guardduty#MemberDataSourceConfiguration": { "type": "structure", "members": { - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", - "traits": { - "smithy.api#documentation": "

Contains information on the status of data sources for the account.

", - "smithy.api#jsonName": "dataSources", - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.guardduty#AccountId", "traits": { @@ -5047,6 +5046,14 @@ "smithy.api#jsonName": "accountId", "smithy.api#required": {} } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", + "traits": { + "smithy.api#documentation": "

Contains information on the status of data sources for the account.

", + "smithy.api#jsonName": "dataSources", + "smithy.api#required": {} + } } }, "traits": { @@ -5095,20 +5102,6 @@ "com.amazonaws.guardduty#NetworkConnectionAction": { "type": "structure", "members": { - "Blocked": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether EC2 blocked the network connection to your instance.

", - "smithy.api#jsonName": "blocked" - } - }, - "LocalIpDetails": { - "target": "com.amazonaws.guardduty#LocalIpDetails", - "traits": { - "smithy.api#documentation": "

The local IP information of the connection.

", - "smithy.api#jsonName": "localIpDetails" - } - }, "Protocol": { "target": "com.amazonaws.guardduty#String", "traits": { @@ -5123,13 +5116,6 @@ "smithy.api#jsonName": "connectionDirection" } }, - "LocalPortDetails": { - "target": "com.amazonaws.guardduty#LocalPortDetails", - "traits": { - "smithy.api#documentation": "

The local port information of the connection.

", - "smithy.api#jsonName": "localPortDetails" - } - }, "RemotePortDetails": { "target": "com.amazonaws.guardduty#RemotePortDetails", "traits": { @@ -5137,12 +5123,33 @@ "smithy.api#jsonName": "remotePortDetails" } }, + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether EC2 blocked the network connection to your instance.

", + "smithy.api#jsonName": "blocked" + } + }, "RemoteIpDetails": { "target": "com.amazonaws.guardduty#RemoteIpDetails", "traits": { "smithy.api#documentation": "

The remote IP information of the connection.

", "smithy.api#jsonName": "remoteIpDetails" } + }, + "LocalIpDetails": { + "target": "com.amazonaws.guardduty#LocalIpDetails", + "traits": { + "smithy.api#documentation": "

The local IP information of the connection.

", + "smithy.api#jsonName": "localIpDetails" + } + }, + "LocalPortDetails": { + "target": "com.amazonaws.guardduty#LocalPortDetails", + "traits": { + "smithy.api#documentation": "

The local port information of the connection.

", + "smithy.api#jsonName": "localPortDetails" + } } }, "traits": { @@ -5152,25 +5159,25 @@ "com.amazonaws.guardduty#NetworkInterface": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.guardduty#String", + "PrivateIpAddresses": { + "target": "com.amazonaws.guardduty#PrivateIpAddresses", "traits": { - "smithy.api#documentation": "

The subnet ID of the EC2 instance.

", - "smithy.api#jsonName": "subnetId" + "smithy.api#documentation": "

Other private IP address information of the EC2 instance.

", + "smithy.api#jsonName": "privateIpAddresses" } }, - "PublicDnsName": { + "NetworkInterfaceId": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The public DNS name of the EC2 instance.

", - "smithy.api#jsonName": "publicDnsName" + "smithy.api#documentation": "

The ID of the network interface.

", + "smithy.api#jsonName": "networkInterfaceId" } }, - "VpcId": { + "PublicIp": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The VPC ID of the EC2 instance.

", - "smithy.api#jsonName": "vpcId" + "smithy.api#documentation": "

The public IP address of the EC2 instance.

", + "smithy.api#jsonName": "publicIp" } }, "PrivateIpAddress": { @@ -5180,20 +5187,6 @@ "smithy.api#jsonName": "privateIpAddress" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

", - "smithy.api#jsonName": "networkInterfaceId" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.guardduty#Ipv6Addresses", - "traits": { - "smithy.api#documentation": "

A list of IPv6 addresses for the EC2 instance.

", - "smithy.api#jsonName": "ipv6Addresses" - } - }, "PrivateDnsName": { "target": "com.amazonaws.guardduty#String", "traits": { @@ -5201,18 +5194,18 @@ "smithy.api#jsonName": "privateDnsName" } }, - "PublicIp": { + "PublicDnsName": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The public IP address of the EC2 instance.

", - "smithy.api#jsonName": "publicIp" + "smithy.api#documentation": "

The public DNS name of the EC2 instance.

", + "smithy.api#jsonName": "publicDnsName" } }, - "PrivateIpAddresses": { - "target": "com.amazonaws.guardduty#PrivateIpAddresses", + "VpcId": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

Other private IP address information of the EC2 instance.

", - "smithy.api#jsonName": "privateIpAddresses" + "smithy.api#documentation": "

The VPC ID of the EC2 instance.

", + "smithy.api#jsonName": "vpcId" } }, "SecurityGroups": { @@ -5221,6 +5214,20 @@ "smithy.api#documentation": "

The security groups associated with the EC2 instance.

", "smithy.api#jsonName": "securityGroups" } + }, + "SubnetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The subnet ID of the EC2 instance.

", + "smithy.api#jsonName": "subnetId" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.guardduty#Ipv6Addresses", + "traits": { + "smithy.api#documentation": "

A list of IPv6 addresses for the EC2 instance.

", + "smithy.api#jsonName": "ipv6Addresses" + } } }, "traits": { @@ -5257,11 +5264,11 @@ "com.amazonaws.guardduty#Organization": { "type": "structure", "members": { - "Org": { + "AsnOrg": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The name of the internet provider.

", - "smithy.api#jsonName": "org" + "smithy.api#documentation": "

The organization that registered this ASN.

", + "smithy.api#jsonName": "asnOrg" } }, "Isp": { @@ -5271,11 +5278,11 @@ "smithy.api#jsonName": "isp" } }, - "AsnOrg": { + "Org": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The organization that registered this ASN.

", - "smithy.api#jsonName": "asnOrg" + "smithy.api#documentation": "

The name of the internet provider.

", + "smithy.api#jsonName": "org" } }, "Asn": { @@ -5415,13 +5422,6 @@ "com.amazonaws.guardduty#PortProbeDetail": { "type": "structure", "members": { - "LocalPortDetails": { - "target": "com.amazonaws.guardduty#LocalPortDetails", - "traits": { - "smithy.api#documentation": "

The local port information of the connection.

", - "smithy.api#jsonName": "localPortDetails" - } - }, "LocalIpDetails": { "target": "com.amazonaws.guardduty#LocalIpDetails", "traits": { @@ -5429,6 +5429,13 @@ "smithy.api#jsonName": "localIpDetails" } }, + "LocalPortDetails": { + "target": "com.amazonaws.guardduty#LocalPortDetails", + "traits": { + "smithy.api#documentation": "

The local port information of the connection.

", + "smithy.api#jsonName": "localPortDetails" + } + }, "RemoteIpDetails": { "target": "com.amazonaws.guardduty#RemoteIpDetails", "traits": { @@ -5450,18 +5457,18 @@ "com.amazonaws.guardduty#PrivateIpAddressDetails": { "type": "structure", "members": { - "PrivateDnsName": { + "PrivateIpAddress": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The private DNS name of the EC2 instance.

", - "smithy.api#jsonName": "privateDnsName" + "smithy.api#documentation": "

The private IP address of the EC2 instance.

", + "smithy.api#jsonName": "privateIpAddress" } }, - "PrivateIpAddress": { + "PrivateDnsName": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The private IP address of the EC2 instance.

", - "smithy.api#jsonName": "privateIpAddress" + "smithy.api#documentation": "

The private DNS name of the EC2 instance.

", + "smithy.api#jsonName": "privateDnsName" } } }, @@ -5506,19 +5513,19 @@ "com.amazonaws.guardduty#PublicAccess": { "type": "structure", "members": { - "PermissionConfiguration": { - "target": "com.amazonaws.guardduty#PermissionConfiguration", - "traits": { - "smithy.api#documentation": "

Contains information about how permissions are configured for the S3 bucket.

", - "smithy.api#jsonName": "permissionConfiguration" - } - }, "EffectivePermission": { "target": "com.amazonaws.guardduty#String", "traits": { "smithy.api#documentation": "

Describes the effective permission on this bucket after factoring all attached\n policies.

", "smithy.api#jsonName": "effectivePermission" } + }, + "PermissionConfiguration": { + "target": "com.amazonaws.guardduty#PermissionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains information about how permissions are configured for the S3 bucket.

", + "smithy.api#jsonName": "permissionConfiguration" + } } }, "traits": { @@ -5555,11 +5562,11 @@ "com.amazonaws.guardduty#RemoteIpDetails": { "type": "structure", "members": { - "GeoLocation": { - "target": "com.amazonaws.guardduty#GeoLocation", + "Organization": { + "target": "com.amazonaws.guardduty#Organization", "traits": { - "smithy.api#documentation": "

The location information of the remote IP address.

", - "smithy.api#jsonName": "geoLocation" + "smithy.api#documentation": "

The ISP organization information of the remote IP address.

", + "smithy.api#jsonName": "organization" } }, "IpAddressV4": { @@ -5569,13 +5576,6 @@ "smithy.api#jsonName": "ipAddressV4" } }, - "Organization": { - "target": "com.amazonaws.guardduty#Organization", - "traits": { - "smithy.api#documentation": "

The ISP organization information of the remote IP address.

", - "smithy.api#jsonName": "organization" - } - }, "Country": { "target": "com.amazonaws.guardduty#Country", "traits": { @@ -5583,6 +5583,13 @@ "smithy.api#jsonName": "country" } }, + "GeoLocation": { + "target": "com.amazonaws.guardduty#GeoLocation", + "traits": { + "smithy.api#documentation": "

The location information of the remote IP address.

", + "smithy.api#jsonName": "geoLocation" + } + }, "City": { "target": "com.amazonaws.guardduty#City", "traits": { @@ -5598,19 +5605,19 @@ "com.amazonaws.guardduty#RemotePortDetails": { "type": "structure", "members": { - "PortName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The port name of the remote connection.

", - "smithy.api#jsonName": "portName" - } - }, "Port": { "target": "com.amazonaws.guardduty#Integer", "traits": { "smithy.api#documentation": "

The port number of the remote connection.

", "smithy.api#jsonName": "port" } + }, + "PortName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The port name of the remote connection.

", + "smithy.api#jsonName": "portName" + } } }, "traits": { @@ -5620,11 +5627,11 @@ "com.amazonaws.guardduty#Resource": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.guardduty#String", + "InstanceDetails": { + "target": "com.amazonaws.guardduty#InstanceDetails", "traits": { - "smithy.api#documentation": "

The type of AWS resource.

", - "smithy.api#jsonName": "resourceType" + "smithy.api#documentation": "

The information about the EC2 instance associated with the activity that prompted\n GuardDuty to generate a finding.

", + "smithy.api#jsonName": "instanceDetails" } }, "S3BucketDetails": { @@ -5641,11 +5648,11 @@ "smithy.api#jsonName": "accessKeyDetails" } }, - "InstanceDetails": { - "target": "com.amazonaws.guardduty#InstanceDetails", + "ResourceType": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The information about the EC2 instance associated with the activity that prompted\n GuardDuty to generate a finding.

", - "smithy.api#jsonName": "instanceDetails" + "smithy.api#documentation": "

The type of AWS resource.

", + "smithy.api#jsonName": "resourceType" } } }, @@ -5662,6 +5669,27 @@ "com.amazonaws.guardduty#S3BucketDetail": { "type": "structure", "members": { + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

Describes whether the bucket is a source or destination bucket.

", + "smithy.api#jsonName": "type" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "

All tags attached to the S3 bucket

", + "smithy.api#jsonName": "tags" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#jsonName": "name" + } + }, "Arn": { "target": "com.amazonaws.guardduty#String", "traits": { @@ -5676,20 +5704,6 @@ "smithy.api#jsonName": "createdAt" } }, - "PublicAccess": { - "target": "com.amazonaws.guardduty#PublicAccess", - "traits": { - "smithy.api#documentation": "

Describes the public access policies that apply to the S3 bucket.

", - "smithy.api#jsonName": "publicAccess" - } - }, - "Owner": { - "target": "com.amazonaws.guardduty#Owner", - "traits": { - "smithy.api#documentation": "

The owner of the S3 bucket.

", - "smithy.api#jsonName": "owner" - } - }, "DefaultServerSideEncryption": { "target": "com.amazonaws.guardduty#DefaultServerSideEncryption", "traits": { @@ -5697,25 +5711,18 @@ "smithy.api#jsonName": "defaultServerSideEncryption" } }, - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", - "smithy.api#jsonName": "name" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", + "Owner": { + "target": "com.amazonaws.guardduty#Owner", "traits": { - "smithy.api#documentation": "

Describes whether the bucket is a source or destination bucket.

", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "

The owner of the S3 bucket.

", + "smithy.api#jsonName": "owner" } }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", + "PublicAccess": { + "target": "com.amazonaws.guardduty#PublicAccess", "traits": { - "smithy.api#documentation": "

All tags attached to the S3 bucket

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

Describes the public access policies that apply to the S3 bucket.

", + "smithy.api#jsonName": "publicAccess" } } }, @@ -5792,39 +5799,25 @@ "com.amazonaws.guardduty#Service": { "type": "structure", "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "Action": { + "target": "com.amazonaws.guardduty#Action", "traits": { - "smithy.api#documentation": "

The detector ID for the GuardDuty service.

", - "smithy.api#jsonName": "detectorId" + "smithy.api#documentation": "

Information about the activity that is described in a finding.

", + "smithy.api#jsonName": "action" } }, - "ServiceName": { + "EventLastSeen": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The name of the AWS service (GuardDuty) that generated a finding.

", - "smithy.api#jsonName": "serviceName" - } - }, - "Count": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "

The total count of the occurrences of this finding type.

", - "smithy.api#jsonName": "count" - } - }, - "Evidence": { - "target": "com.amazonaws.guardduty#Evidence", - "traits": { - "smithy.api#documentation": "

An evidence object associated with the service.

", - "smithy.api#jsonName": "evidence" + "smithy.api#documentation": "

The last-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.

", + "smithy.api#jsonName": "eventLastSeen" } }, - "EventLastSeen": { + "EventFirstSeen": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The last-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.

", - "smithy.api#jsonName": "eventLastSeen" + "smithy.api#documentation": "

The first-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.

", + "smithy.api#jsonName": "eventFirstSeen" } }, "ResourceRole": { @@ -5841,25 +5834,39 @@ "smithy.api#jsonName": "userFeedback" } }, - "Action": { - "target": "com.amazonaws.guardduty#Action", + "Evidence": { + "target": "com.amazonaws.guardduty#Evidence", "traits": { - "smithy.api#documentation": "

Information about the activity that is described in a finding.

", - "smithy.api#jsonName": "action" + "smithy.api#documentation": "

An evidence object associated with the service.

", + "smithy.api#jsonName": "evidence" } }, - "Archived": { - "target": "com.amazonaws.guardduty#Boolean", + "Count": { + "target": "com.amazonaws.guardduty#Integer", "traits": { - "smithy.api#documentation": "

Indicates whether this finding is archived.

", - "smithy.api#jsonName": "archived" + "smithy.api#documentation": "

The total count of the occurrences of this finding type.

", + "smithy.api#jsonName": "count" } }, - "EventFirstSeen": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The detector ID for the GuardDuty service.

", + "smithy.api#jsonName": "detectorId" + } + }, + "ServiceName": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The first-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.

", - "smithy.api#jsonName": "eventFirstSeen" + "smithy.api#documentation": "

The name of the AWS service (GuardDuty) that generated a finding.

", + "smithy.api#jsonName": "serviceName" + } + }, + "Archived": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether this finding is archived.

", + "smithy.api#jsonName": "archived" } } }, @@ -5917,14 +5924,6 @@ "com.amazonaws.guardduty#StartMonitoringMembersRequest": { "type": "structure", "members": { - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#documentation": "

A list of account IDs of the GuardDuty member accounts to start monitoring.

", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -5933,6 +5932,14 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "

A list of account IDs of the GuardDuty member accounts to start monitoring.

", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } } } }, @@ -6015,18 +6022,18 @@ "com.amazonaws.guardduty#Tag": { "type": "structure", "members": { - "Value": { + "Key": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The EC2 instance tag value.

", - "smithy.api#jsonName": "value" + "smithy.api#documentation": "

The EC2 instance tag key.

", + "smithy.api#jsonName": "key" } }, - "Key": { + "Value": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The EC2 instance tag key.

", - "smithy.api#jsonName": "key" + "smithy.api#documentation": "

The EC2 instance tag value.

", + "smithy.api#jsonName": "value" } } }, @@ -6099,6 +6106,14 @@ "com.amazonaws.guardduty#TagResourceRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be added to a resource.

", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } + }, "ResourceArn": { "target": "com.amazonaws.guardduty#GuardDutyArn", "traits": { @@ -6107,14 +6122,6 @@ "smithy.api#jsonName": "resourceArn", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to be added to a resource.

", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } } } }, @@ -6336,14 +6343,6 @@ "com.amazonaws.guardduty#UnprocessedAccount": { "type": "structure", "members": { - "Result": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "

A reason why the account hasn't been processed.

", - "smithy.api#jsonName": "result", - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.guardduty#AccountId", "traits": { @@ -6351,6 +6350,14 @@ "smithy.api#jsonName": "accountId", "smithy.api#required": {} } + }, + "Result": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

A reason why the account hasn't been processed.

", + "smithy.api#jsonName": "result", + "smithy.api#required": {} + } } }, "traits": { @@ -6397,15 +6404,6 @@ "com.amazonaws.guardduty#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.guardduty#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#jsonName": "tagKeys", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.guardduty#GuardDutyArn", "traits": { @@ -6414,6 +6412,15 @@ "smithy.api#jsonName": "resourceArn", "smithy.api#required": {} } + }, + "TagKeys": { + "target": "com.amazonaws.guardduty#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#jsonName": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -6449,11 +6456,11 @@ "com.amazonaws.guardduty#UpdateDetectorRequest": { "type": "structure", "members": { - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

An object that describes which data sources will be updated.

", - "smithy.api#jsonName": "dataSources" + "smithy.api#documentation": "

Specifies whether the detector is enabled or not enabled.

", + "smithy.api#jsonName": "enable" } }, "DetectorId": { @@ -6465,11 +6472,11 @@ "smithy.api#required": {} } }, - "Enable": { - "target": "com.amazonaws.guardduty#Boolean", + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", "traits": { - "smithy.api#documentation": "

Specifies whether the detector is enabled or not enabled.

", - "smithy.api#jsonName": "enable" + "smithy.api#documentation": "

An object that describes which data sources will be updated.

", + "smithy.api#jsonName": "dataSources" } }, "FindingPublishingFrequency": { @@ -6513,18 +6520,11 @@ "com.amazonaws.guardduty#UpdateFilterRequest": { "type": "structure", "members": { - "FindingCriteria": { - "target": "com.amazonaws.guardduty#FindingCriteria", - "traits": { - "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

", - "smithy.api#jsonName": "findingCriteria" - } - }, - "Rank": { - "target": "com.amazonaws.guardduty#FilterRank", + "Description": { + "target": "com.amazonaws.guardduty#FilterDescription", "traits": { - "smithy.api#documentation": "

Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.

", - "smithy.api#jsonName": "rank" + "smithy.api#documentation": "

The description of the filter.

", + "smithy.api#jsonName": "description" } }, "DetectorId": { @@ -6543,11 +6543,18 @@ "smithy.api#jsonName": "action" } }, - "Description": { - "target": "com.amazonaws.guardduty#FilterDescription", + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", "traits": { - "smithy.api#documentation": "

The description of the filter.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

", + "smithy.api#jsonName": "findingCriteria" + } + }, + "Rank": { + "target": "com.amazonaws.guardduty#FilterRank", + "traits": { + "smithy.api#documentation": "

Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.

", + "smithy.api#jsonName": "rank" } }, "FilterName": { @@ -6602,6 +6609,13 @@ "com.amazonaws.guardduty#UpdateFindingsFeedbackRequest": { "type": "structure", "members": { + "Comments": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

Additional feedback about the GuardDuty findings.

", + "smithy.api#jsonName": "comments" + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -6611,14 +6625,6 @@ "smithy.api#required": {} } }, - "FindingIds": { - "target": "com.amazonaws.guardduty#FindingIds", - "traits": { - "smithy.api#documentation": "

The IDs of the findings that you want to mark as useful or not useful.

", - "smithy.api#jsonName": "findingIds", - "smithy.api#required": {} - } - }, "Feedback": { "target": "com.amazonaws.guardduty#Feedback", "traits": { @@ -6627,11 +6633,12 @@ "smithy.api#required": {} } }, - "Comments": { - "target": "com.amazonaws.guardduty#String", + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", "traits": { - "smithy.api#documentation": "

Additional feedback about the GuardDuty findings.

", - "smithy.api#jsonName": "comments" + "smithy.api#documentation": "

The IDs of the findings that you want to mark as useful or not useful.

", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} } } } @@ -6668,11 +6675,11 @@ "com.amazonaws.guardduty#UpdateIPSetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.guardduty#Name", + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

The unique ID that specifies the IPSet that you want to update.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The updated Boolean value that specifies whether the IPSet is active or not.

", + "smithy.api#jsonName": "activate" } }, "IpSetId": { @@ -6684,11 +6691,18 @@ "smithy.api#required": {} } }, - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", + "Location": { + "target": "com.amazonaws.guardduty#Location", "traits": { - "smithy.api#documentation": "

The updated Boolean value that specifies whether the IPSet is active or not.

", - "smithy.api#jsonName": "activate" + "smithy.api#documentation": "

The updated URI of the file that contains the IPSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", + "smithy.api#jsonName": "location" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "

The unique ID that specifies the IPSet that you want to update.

", + "smithy.api#jsonName": "name" } }, "DetectorId": { @@ -6699,13 +6713,6 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#documentation": "

The updated URI of the file that contains the IPSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", - "smithy.api#jsonName": "location" - } } } }, @@ -6741,14 +6748,6 @@ "com.amazonaws.guardduty#UpdateMemberDetectorsRequest": { "type": "structure", "members": { - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#documentation": "

A list of member account IDs to be updated.

", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -6764,6 +6763,14 @@ "smithy.api#documentation": "

An object describes which data sources will be updated.

", "smithy.api#jsonName": "dataSources" } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "

A list of member account IDs to be updated.

", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } } } }, @@ -6808,13 +6815,11 @@ "com.amazonaws.guardduty#UpdateOrganizationConfigurationRequest": { "type": "structure", "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", + "DataSources": { + "target": "com.amazonaws.guardduty#OrganizationDataSourceConfigurations", "traits": { - "smithy.api#documentation": "

The ID of the detector to update the delegated administrator for.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} + "smithy.api#documentation": "

An object describes which data sources will be updated.

", + "smithy.api#jsonName": "dataSources" } }, "AutoEnable": { @@ -6825,11 +6830,13 @@ "smithy.api#required": {} } }, - "DataSources": { - "target": "com.amazonaws.guardduty#OrganizationDataSourceConfigurations", + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

An object describes which data sources will be updated.

", - "smithy.api#jsonName": "dataSources" + "smithy.api#documentation": "

The ID of the detector to update the delegated administrator for.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} } } } @@ -6866,6 +6873,15 @@ "com.amazonaws.guardduty#UpdatePublishingDestinationRequest": { "type": "structure", "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The ID of the detector associated with the publishing destinations to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, "DestinationProperties": { "target": "com.amazonaws.guardduty#DestinationProperties", "traits": { @@ -6881,15 +6897,6 @@ "smithy.api#jsonName": "destinationId", "smithy.api#required": {} } - }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "

The ID of the detector associated with the publishing destinations to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } } } }, @@ -6925,13 +6932,6 @@ "com.amazonaws.guardduty#UpdateThreatIntelSetRequest": { "type": "structure", "members": { - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "

The updated Boolean value that specifies whether the ThreateIntelSet is active or\n not.

", - "smithy.api#jsonName": "activate" - } - }, "ThreatIntelSetId": { "target": "com.amazonaws.guardduty#String", "traits": { @@ -6948,6 +6948,20 @@ "smithy.api#jsonName": "name" } }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "

The updated URI of the file that contains the ThreateIntelSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", + "smithy.api#jsonName": "location" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

The updated Boolean value that specifies whether the ThreateIntelSet is active or\n not.

", + "smithy.api#jsonName": "activate" + } + }, "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { @@ -6956,13 +6970,6 @@ "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#documentation": "

The updated URI of the file that contains the ThreateIntelSet. For example:\n https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

", - "smithy.api#jsonName": "location" - } } } }, @@ -6973,19 +6980,19 @@ "com.amazonaws.guardduty#UsageAccountResult": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "

The Account ID that generated usage.

", - "smithy.api#jsonName": "accountId" - } - }, "Total": { "target": "com.amazonaws.guardduty#Total", "traits": { "smithy.api#documentation": "

Represents the total of usage for the Account ID.

", "smithy.api#jsonName": "total" } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "

The Account ID that generated usage.

", + "smithy.api#jsonName": "accountId" + } } }, "traits": { @@ -7001,12 +7008,11 @@ "com.amazonaws.guardduty#UsageCriteria": { "type": "structure", "members": { - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceList", + "Resources": { + "target": "com.amazonaws.guardduty#ResourceList", "traits": { - "smithy.api#documentation": "

The data sources to aggregate usage statistics from.

", - "smithy.api#jsonName": "dataSources", - "smithy.api#required": {} + "smithy.api#documentation": "

The resources to aggregate usage statistics from. Only accepts exact resource\n names.

", + "smithy.api#jsonName": "resources" } }, "AccountIds": { @@ -7016,11 +7022,12 @@ "smithy.api#jsonName": "accountIds" } }, - "Resources": { - "target": "com.amazonaws.guardduty#ResourceList", + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceList", "traits": { - "smithy.api#documentation": "

The resources to aggregate usage statistics from. Only accepts exact resource\n names.

", - "smithy.api#jsonName": "resources" + "smithy.api#documentation": "

The data sources to aggregate usage statistics from.

", + "smithy.api#jsonName": "dataSources", + "smithy.api#required": {} } } }, @@ -7059,19 +7066,19 @@ "com.amazonaws.guardduty#UsageResourceResult": { "type": "structure", "members": { - "Total": { - "target": "com.amazonaws.guardduty#Total", - "traits": { - "smithy.api#documentation": "

Represents the sum total of usage for the specified resource type.

", - "smithy.api#jsonName": "total" - } - }, "Resource": { "target": "com.amazonaws.guardduty#String", "traits": { "smithy.api#documentation": "

The AWS resource that generated usage.

", "smithy.api#jsonName": "resource" } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#documentation": "

Represents the sum total of usage for the specified resource type.

", + "smithy.api#jsonName": "total" + } } }, "traits": { @@ -7110,25 +7117,18 @@ "com.amazonaws.guardduty#UsageStatistics": { "type": "structure", "members": { - "TopResources": { + "SumByResource": { "target": "com.amazonaws.guardduty#UsageResourceResultList", "traits": { - "smithy.api#documentation": "

Lists the top 50 resources that have generated the most GuardDuty usage, in order from\n most to least expensive.

", - "smithy.api#jsonName": "topResources" - } - }, - "SumByDataSource": { - "target": "com.amazonaws.guardduty#UsageDataSourceResultList", - "traits": { - "smithy.api#documentation": "

The usage statistic sum organized by on data source.

", - "smithy.api#jsonName": "sumByDataSource" + "smithy.api#documentation": "

The usage statistic sum organized by resource.

", + "smithy.api#jsonName": "sumByResource" } }, - "SumByResource": { + "TopResources": { "target": "com.amazonaws.guardduty#UsageResourceResultList", "traits": { - "smithy.api#documentation": "

The usage statistic sum organized by resource.

", - "smithy.api#jsonName": "sumByResource" + "smithy.api#documentation": "

Lists the top 50 resources that have generated the most GuardDuty usage, in order from\n most to least expensive.

", + "smithy.api#jsonName": "topResources" } }, "SumByAccount": { @@ -7137,6 +7137,13 @@ "smithy.api#documentation": "

The usage statistic sum organized by account ID.

", "smithy.api#jsonName": "sumByAccount" } + }, + "SumByDataSource": { + "target": "com.amazonaws.guardduty#UsageDataSourceResultList", + "traits": { + "smithy.api#documentation": "

The usage statistic sum organized by on data source.

", + "smithy.api#jsonName": "sumByDataSource" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/health.2016-08-04.json b/codegen/sdk-codegen/aws-models/health.2016-08-04.json index aa760da99c17..300a432b7ca7 100644 --- a/codegen/sdk-codegen/aws-models/health.2016-08-04.json +++ b/codegen/sdk-codegen/aws-models/health.2016-08-04.json @@ -78,43 +78,43 @@ "sdkId": "Health", "arnNamespace": "health", "cloudFormationName": "Health", - "cloudTrailEventSource": "v20160804.silvermineunifiedapi.amazonaws.com" + "cloudTrailEventSource": "health.amazonaws.com" }, "aws.auth#sigv4": { "name": "health" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Health\n \n

The AWS Health API provides programmatic access to the AWS Health information\n that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS\n resources:

\n \n

In addition, these operations provide information about event types and summary\n counts of events or affected entities:

\n \n\n \n

AWS Health integrates with AWS Organizations to provide a centralized view of AWS Health\n events across all accounts in your organization.

\n \n

You can use the following operations to enable or disable AWS Health from working\n with AWS Organizations.

\n \n \n\n

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API\n from an account that does not have a Business or Enterprise support plan causes a\n SubscriptionRequiredException.

\n

For authentication of requests, AWS Health uses the Signature Version 4 Signing\n Process.

\n

See the AWS Health User Guide for information about how to use the API.

\n

\n Service Endpoint\n

\n

The HTTP endpoint for the AWS Health API is:

\n ", + "smithy.api#documentation": "AWS Health\n \n

The AWS Health API provides programmatic access to the AWS Health information that\n appears in the AWS Personal Health Dashboard. You\n can use the API operations to get information about AWS Health events that affect your\n AWS services and resources.

\n \n

You must have a Business or Enterprise support plan from AWS Support to use the AWS Health API. If you call the\n AWS Health API from an AWS account that doesn't have a Business or Enterprise support\n plan, you receive a SubscriptionRequiredException error.

\n \n

AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). Use this\n endpoint to call the AWS Health API operations.

\n

For authentication of requests, AWS Health uses the Signature Version 4 Signing\n Process.

\n

If your AWS account is part of AWS Organizations, you can use the AWS Health organizational\n view feature. This feature provides a centralized view of AWS Health events across all\n accounts in your organization. You can aggregate AWS Health events in real time to\n identify accounts in your organization that are affected by an operational event or get\n notified of security vulnerabilities. Use the organizational view API operations to enable\n this feature and return event information. For more information, see Aggregating\n AWS Health events in the AWS Health User Guide.

\n \n

When you use the AWS Health API operations to return AWS Health events, see the\n following recommendations:

\n
    \n
  • \n

    Use the eventScopeCode parameter to specify whether to return AWS Health\n events that are public or account-specific.

    \n
    • \n
  • \n

    Use pagination to view all events from the response. For example, if you call\n the DescribeEventsForOrganization operation to get all events in your\n organization, you might receive several page results. Specify the\n nextToken in the next request to return more results.

    \n
    • \n
\n ", "smithy.api#title": "AWS Health APIs and Notifications" } }, "com.amazonaws.health#AffectedEntity": { "type": "structure", "members": { - "awsAccountId": { - "target": "com.amazonaws.health#accountId", - "traits": { - "smithy.api#documentation": "

The 12-digit AWS account number that contains the affected entity.

" - } - }, - "tags": { - "target": "com.amazonaws.health#tagSet", - "traits": { - "smithy.api#documentation": "

A map of entity tags attached to the affected entity.

" - } - }, "entityUrl": { "target": "com.amazonaws.health#entityUrl", "traits": { "smithy.api#documentation": "

The URL of the affected entity.

" } }, + "entityValue": { + "target": "com.amazonaws.health#entityValue", + "traits": { + "smithy.api#documentation": "

The ID of the affected entity.

" + } + }, "entityArn": { "target": "com.amazonaws.health#entityArn", "traits": { "smithy.api#documentation": "

The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id\n . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K\n

" } }, + "tags": { + "target": "com.amazonaws.health#tagSet", + "traits": { + "smithy.api#documentation": "

A map of entity tags attached to the affected entity.

\n \n

Currently, the tags property isn't supported.

\n " + } + }, "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { @@ -127,16 +127,16 @@ "smithy.api#documentation": "

The most recent status of the entity affected by the event. The possible values are\n IMPAIRED, UNIMPAIRED, and UNKNOWN.

" } }, - "lastUpdatedTime": { - "target": "com.amazonaws.health#timestamp", + "awsAccountId": { + "target": "com.amazonaws.health#accountId", "traits": { - "smithy.api#documentation": "

The most recent time that the entity was updated.

" + "smithy.api#documentation": "

The 12-digit AWS account number that contains the affected entity.

" } }, - "entityValue": { - "target": "com.amazonaws.health#entityValue", + "lastUpdatedTime": { + "target": "com.amazonaws.health#timestamp", "traits": { - "smithy.api#documentation": "

The ID of the affected entity.

" + "smithy.api#documentation": "

The most recent time that the entity was updated.

" } } }, @@ -152,28 +152,28 @@ } }, "traits": { - "smithy.api#documentation": "

\n EnableHealthServiceAccessForOrganization is already in progress. Wait\n for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

", + "smithy.api#documentation": "

\n EnableHealthServiceAccessForOrganization is already in progress. Wait\n for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

", "smithy.api#error": "client" } }, "com.amazonaws.health#DateTimeRange": { "type": "structure", "members": { - "to": { + "from": { "target": "com.amazonaws.health#timestamp", "traits": { - "smithy.api#documentation": "

The ending date and time of a time range.

" + "smithy.api#documentation": "

The starting date and time of a time range.

" } }, - "from": { + "to": { "target": "com.amazonaws.health#timestamp", "traits": { - "smithy.api#documentation": "

The starting date and time of a time range.

" + "smithy.api#documentation": "

The ending date and time of a time range.

" } } }, "traits": { - "smithy.api#documentation": "

A range of dates and times that is used by the EventFilter and\n EntityFilter objects. If from is set and to\n is set: match items where the timestamp (startTime, endTime, or\n lastUpdatedTime) is between from and to\n inclusive. If from is set and to is not set: match items where\n the timestamp value is equal to or after from. If from is not set\n and to is set: match items where the timestamp value is equal to or before\n to.

" + "smithy.api#documentation": "

A range of dates and times that is used by the EventFilter and \n EntityFilter objects. If from is set and to is\n set: match items where the timestamp (startTime, endTime, or\n lastUpdatedTime) is between from and to\n inclusive. If from is set and to is not set: match items where\n the timestamp value is equal to or after from. If from is not set\n and to is set: match items where the timestamp value is equal to or before\n to.

" } }, "com.amazonaws.health#DescribeAffectedAccountsForOrganization": { @@ -190,13 +190,25 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of accounts in the organization from AWS Organizations that are affected by the\n provided event.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's master account.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Returns a list of accounts in the organization from AWS Organizations that are affected by the\n provided event. For more information about the different types of AWS Health events, see\n Event.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's master account.

\n \n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "affectedAccounts", + "pageSize": "maxResults" + } } }, "com.amazonaws.health#DescribeAffectedAccountsForOrganizationRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.health#maxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" + } + }, "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { @@ -204,12 +216,6 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.health#maxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" - } - }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { @@ -228,7 +234,10 @@ } }, "eventScopeCode": { - "target": "com.amazonaws.health#eventScopeCode" + "target": "com.amazonaws.health#eventScopeCode", + "traits": { + "smithy.api#documentation": "

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

\n " + } }, "affectedAccounts": { "target": "com.amazonaws.health#affectedAccountsList", @@ -255,8 +264,14 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of entities that have been affected by the specified events, based on\n the specified filter criteria. Entities can refer to individual customer resources, groups\n of customer resources, or any other construct, depending on the AWS service. Events that\n have impact beyond that of the affected entities, or where the extent of impact is unknown,\n include at least one entity indicating this.

\n

At least one event ARN is required. Results are sorted by the\n lastUpdatedTime of the entity, starting with the most recent.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Returns a list of entities that have been affected by the specified events, based on the\n specified filter criteria. Entities can refer to individual customer resources, groups of\n customer resources, or any other construct, depending on the AWS service. Events that have\n impact beyond that of the affected entities, or where the extent of impact is unknown,\n include at least one entity indicating this.

\n

At least one event ARN is required. Results are sorted by the\n lastUpdatedTime of the entity, starting with the most recent.

\n \n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "entities", + "pageSize": "maxResults" + } } }, "com.amazonaws.health#DescribeAffectedEntitiesForOrganization": { @@ -276,8 +291,14 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of entities that have been affected by one or more events for one or more\n accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer\n to individual customer resources, groups of customer resources, or any other construct,\n depending on the AWS service.

\n

At least one event ARN and account ID are required. Results are sorted by the\n lastUpdatedTime of the entity, starting with the most recent.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's master account.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Returns a list of entities that have been affected by one or more events for one or more\n accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer\n to individual customer resources, groups of customer resources, or any other construct,\n depending on the AWS service.

\n

At least one event Amazon Resource Name (ARN) and account ID are required. Results are\n sorted by the lastUpdatedTime of the entity, starting with the most\n recent.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's master account.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "entities", + "pageSize": "maxResults" + } } }, "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationFailedSet": { @@ -289,12 +310,6 @@ "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationRequest": { "type": "structure", "members": { - "locale": { - "target": "com.amazonaws.health#locale", - "traits": { - "smithy.api#documentation": "

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" - } - }, "organizationEntityFilters": { "target": "com.amazonaws.health#OrganizationEntityFiltersList", "traits": { @@ -302,6 +317,12 @@ "smithy.api#required": {} } }, + "locale": { + "target": "com.amazonaws.health#locale", + "traits": { + "smithy.api#documentation": "

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" + } + }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { @@ -328,7 +349,7 @@ "entities": { "target": "com.amazonaws.health#EntityList", "traits": { - "smithy.api#documentation": "

A JSON set of elements including the awsAccountId and its\n entityArn, entityValue and its entityArn,\n lastUpdatedTime, statusCode, and tags.

" + "smithy.api#documentation": "

A JSON set of elements including the awsAccountId and its\n entityArn, entityValue and its entityArn,\n lastUpdatedTime, and statusCode.

" } }, "failedSet": { @@ -348,6 +369,13 @@ "smithy.api#documentation": "

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" } }, + "filter": { + "target": "com.amazonaws.health#EntityFilter", + "traits": { + "smithy.api#documentation": "

Values to narrow the results returned. At least one event ARN is required.

", + "smithy.api#required": {} + } + }, "maxResults": { "target": "com.amazonaws.health#maxResults", "traits": { @@ -359,30 +387,23 @@ "traits": { "smithy.api#documentation": "

If the results of a search are large, only a portion of the\nresults are returned, and a nextToken pagination token is returned in the response. To\nretrieve the next batch of results, reissue the search request and include the returned token.\nWhen all results have been returned, the response does not contain a pagination token value.

" } - }, - "filter": { - "target": "com.amazonaws.health#EntityFilter", - "traits": { - "smithy.api#documentation": "

Values to narrow the results returned. At least one event ARN is required.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.health#DescribeAffectedEntitiesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.health#nextToken", - "traits": { - "smithy.api#documentation": "

If the results of a search are large, only a portion of the\nresults are returned, and a nextToken pagination token is returned in the response. To\nretrieve the next batch of results, reissue the search request and include the returned token.\nWhen all results have been returned, the response does not contain a pagination token value.

" - } - }, "entities": { "target": "com.amazonaws.health#EntityList", "traits": { "smithy.api#documentation": "

The entities that match the filter criteria.

" } + }, + "nextToken": { + "target": "com.amazonaws.health#nextToken", + "traits": { + "smithy.api#documentation": "

If the results of a search are large, only a portion of the\nresults are returned, and a nextToken pagination token is returned in the response. To\nretrieve the next batch of results, reissue the search request and include the returned token.\nWhen all results have been returned, the response does not contain a pagination token value.

" + } } } }, @@ -395,7 +416,7 @@ "target": "com.amazonaws.health#DescribeEntityAggregatesResponse" }, "traits": { - "smithy.api#documentation": "

Returns the number of entities that are affected by each of the specified events. If\n no events are specified, the counts of all affected entities are returned.

", + "smithy.api#documentation": "

Returns the number of entities that are affected by each of the specified events. If no\n events are specified, the counts of all affected entities are returned.

", "smithy.api#idempotent": {} } }, @@ -435,8 +456,14 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the number of events of each event type (issue, scheduled change, and account\n notification). If no filter is specified, the counts of all events in each category are\n returned.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Returns the number of events of each event type (issue, scheduled change, and account\n notification). If no filter is specified, the counts of all events in each category are\n returned.

\n \n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "eventAggregates", + "pageSize": "maxResults" + } } }, "com.amazonaws.health#DescribeEventAggregatesRequest": { @@ -481,7 +508,7 @@ "eventAggregates": { "target": "com.amazonaws.health#EventAggregateList", "traits": { - "smithy.api#documentation": "

The number of events in each category that meet the optional filter\n criteria.

" + "smithy.api#documentation": "

The number of events in each category that meet the optional filter criteria.

" } } } @@ -500,7 +527,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about one or more specified events. Information includes\n standard event data (region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional\n metadata that depends upon the nature of the event. Affected entities are not included; to\n retrieve those, use the DescribeAffectedEntities operation.

\n

If a specified event cannot be retrieved, an error message is returned for that\n event.

", + "smithy.api#documentation": "

Returns detailed information about one or more specified events. Information includes\n standard event data (Region, service, and so on, as returned by DescribeEvents), a\n detailed event description, and possible additional metadata that depends upon the nature\n of the event. Affected entities are not included. To retrieve those, use the DescribeAffectedEntities operation.

\n

If a specified event cannot be retrieved, an error message is returned for that\n event.

", "smithy.api#idempotent": {} } }, @@ -524,7 +551,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about one or more specified events for one or more accounts\n in your organization. Information includes standard event data (Region, service, and so on,\n as returned by DescribeEventsForOrganization, a detailed event\n description, and possible additional metadata that depends upon the nature of the event.\n Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's master account.

", + "smithy.api#documentation": "

Returns detailed information about one or more specified events for one or more accounts\n in your organization. Information includes standard event data (Region, service, and so on,\n as returned by DescribeEventsForOrganization), a detailed event description, and possible\n additional metadata that depends upon the nature of the event. Affected entities are not\n included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's master account.

\n

When you call the DescribeEventDetailsForOrganization operation, you\n specify the organizationEventDetailFilters object in the request. Depending on\n the AWS Health event type, note the following differences:

\n \n

For more information, see Event.

", "smithy.api#idempotent": {} } }, @@ -633,8 +660,14 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the event types that meet the specified filter criteria. If no filter\n criteria are specified, all event types are returned, in no particular order.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Returns the event types that meet the specified filter criteria. If no filter criteria\n are specified, all event types are returned, in no particular order.

\n \n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "eventTypes", + "pageSize": "maxResults" + } } }, "com.amazonaws.health#DescribeEventTypesRequest": { @@ -646,10 +679,10 @@ "smithy.api#documentation": "

Values to narrow the results returned.

" } }, - "locale": { - "target": "com.amazonaws.health#locale", + "maxResults": { + "target": "com.amazonaws.health#maxResults", "traits": { - "smithy.api#documentation": "

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" + "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } }, "nextToken": { @@ -658,10 +691,10 @@ "smithy.api#documentation": "

If the results of a search are large, only a portion of the\nresults are returned, and a nextToken pagination token is returned in the response. To\nretrieve the next batch of results, reissue the search request and include the returned token.\nWhen all results have been returned, the response does not contain a pagination token value.

" } }, - "maxResults": { - "target": "com.amazonaws.health#maxResults", + "locale": { + "target": "com.amazonaws.health#locale", "traits": { - "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" + "smithy.api#documentation": "

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" } } } @@ -700,8 +733,14 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about events that meet the specified filter criteria. Events are\n returned in a summary form and do not include the detailed description, any additional\n metadata that depends on the event type, or any affected resources. To retrieve that\n information, use the DescribeEventDetails and DescribeAffectedEntities operations.

\n

If no filter criteria are specified, all events are returned. Results are sorted by\n lastModifiedTime, starting with the most recent.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Returns information about events that meet the specified filter criteria. Events are\n returned in a summary form and do not include the detailed description, any additional\n metadata that depends on the event type, or any affected resources. To retrieve that\n information, use the DescribeEventDetails and DescribeAffectedEntities operations.

\n

If no filter criteria are specified, all events are returned. Results are sorted by\n lastModifiedTime, starting with the most recent event.

\n \n
    \n
  • \n

    When you call the DescribeEvents operation and specify an entity for the\n entityValues parameter, AWS Health might return public events that\n aren't specific to that resource. For example, if you call DescribeEvents\n and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events\n that aren't specific to that resource or service. To get events that are specific to a\n service, use the services parameter in the filter object. For\n more information, see Event.

    \n
    • \n
  • \n

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    \n
    • \n
\n \n \n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "events", + "pageSize": "maxResults" + } } }, "com.amazonaws.health#DescribeEventsForOrganization": { @@ -721,8 +760,14 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about events across your organization in AWS Organizations, meeting the\n specified filter criteria. Events are returned in a summary form and do not include the\n accounts impacted, detailed description, any additional metadata that depends on the event\n type, or any affected resources. To retrieve that information, use the DescribeAffectedAccountsForOrganization, DescribeEventDetailsForOrganization, and DescribeAffectedEntitiesForOrganization operations.

\n

If no filter criteria are specified, all events across your organization are returned.\n Results are sorted by lastModifiedTime, starting with the most recent.

\n

Before you can call this operation, you must first enable Health to work with AWS\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n master account.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Returns information about events across your organization in AWS Organizations. You can use\n thefilters parameter to specify the events that you want to return. Events\n are returned in a summary form and don't include the affected accounts, detailed\n description, any additional metadata that depends on the event type, or any affected\n resources. To retrieve that information, use the following operations:

\n \n

If you don't specify a filter, the\n DescribeEventsForOrganizations returns all events across your organization.\n Results are sorted by lastModifiedTime, starting with the most recent event.

\n

For more information about the different types of AWS Health events, see Event.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n master AWS account.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "events", + "pageSize": "maxResults" + } } }, "com.amazonaws.health#DescribeEventsForOrganizationRequest": { @@ -757,17 +802,17 @@ "com.amazonaws.health#DescribeEventsForOrganizationResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.health#nextToken", - "traits": { - "smithy.api#documentation": "

If the results of a search are large, only a portion of the\nresults are returned, and a nextToken pagination token is returned in the response. To\nretrieve the next batch of results, reissue the search request and include the returned token.\nWhen all results have been returned, the response does not contain a pagination token value.

" - } - }, "events": { "target": "com.amazonaws.health#OrganizationEventList", "traits": { "smithy.api#documentation": "

The events that match the specified filter criteria.

" } + }, + "nextToken": { + "target": "com.amazonaws.health#nextToken", + "traits": { + "smithy.api#documentation": "

If the results of a search are large, only a portion of the\nresults are returned, and a nextToken pagination token is returned in the response. To\nretrieve the next batch of results, reissue the search request and include the returned token.\nWhen all results have been returned, the response does not contain a pagination token value.

" + } } } }, @@ -780,6 +825,12 @@ "smithy.api#documentation": "

If the results of a search are large, only a portion of the\nresults are returned, and a nextToken pagination token is returned in the response. To\nretrieve the next batch of results, reissue the search request and include the returned token.\nWhen all results have been returned, the response does not contain a pagination token value.

" } }, + "filter": { + "target": "com.amazonaws.health#EventFilter", + "traits": { + "smithy.api#documentation": "

Values to narrow the results returned.

" + } + }, "maxResults": { "target": "com.amazonaws.health#maxResults", "traits": { @@ -791,12 +842,6 @@ "traits": { "smithy.api#documentation": "

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" } - }, - "filter": { - "target": "com.amazonaws.health#EventFilter", - "traits": { - "smithy.api#documentation": "

Values to narrow the results returned.

" - } } } }, @@ -846,7 +891,7 @@ } ], "traits": { - "smithy.api#documentation": "

Calling this operation disables Health from working with AWS Organizations. This does not remove\n the Service Linked Role (SLR) from the the master account in your organization. Use the\n IAM console, API, or AWS CLI to remove the SLR if desired. To call this operation, you\n must sign in as an IAM user, assume an IAM role, or sign in as the root user (not\n recommended) in the organization's master account.

", + "smithy.api#documentation": "

Disables AWS Health from working with AWS Organizations. To call this operation, you must sign\n in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not\n recommended) in the organization's master AWS account. For more information, see Aggregating\n AWS Health events in the\n AWS Health User Guide.

\n

This operation doesn't remove the service-linked role (SLR) from the AWS master\n account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to\n remove the SLR. For more information, see Deleting a Service-Linked Role in the\n IAM User Guide.

\n \n

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation,\n AWS Health stops aggregating events for all other AWS accounts in your organization.\n If you call the AWS Health API operations for organizational view, AWS Health returns\n an error. AWS Health continues to aggregate health events for your AWS\n account.

\n ", "smithy.api#idempotent": {} } }, @@ -858,7 +903,7 @@ } ], "traits": { - "smithy.api#documentation": "

Calling this operation enables AWS Health to work with AWS Organizations. This applies a Service\n Linked Role (SLR) to the master account in the organization. To learn more about the steps\n in this process, visit enabling service access for AWS Health in AWS Organizations. To call this\n operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root\n user (not recommended) in the organization's master account.

", + "smithy.api#documentation": "

Calling this operation enables AWS Health to work with AWS Organizations. This applies a\n service-linked role (SLR) to the master account in the organization. To call this\n operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root\n user (not recommended) in the organization's master account.

\n

For more information, see Aggregating AWS Health events in the AWS Health User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -868,7 +913,7 @@ "count": { "target": "com.amazonaws.health#count", "traits": { - "smithy.api#documentation": "

The number entities that match the criteria for the specified events.

" + "smithy.api#documentation": "

The number of entities that match the criteria for the specified events.

" } }, "eventArn": { @@ -879,7 +924,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

" + "smithy.api#documentation": "

The number of entities that are affected by one or more events. Returned by the \n DescribeEntityAggregates operation.

" } }, "com.amazonaws.health#EntityAggregateList": { @@ -891,16 +936,22 @@ "com.amazonaws.health#EntityFilter": { "type": "structure", "members": { + "statusCodes": { + "target": "com.amazonaws.health#entityStatusCodeList", + "traits": { + "smithy.api#documentation": "

A list of entity status codes (IMPAIRED, UNIMPAIRED, or\n UNKNOWN).

" + } + }, "tags": { "target": "com.amazonaws.health#tagFilter", "traits": { - "smithy.api#documentation": "

A map of entity tags attached to the affected entity.

" + "smithy.api#documentation": "

A map of entity tags attached to the affected entity.

\n \n

Currently, the tags property isn't supported.

\n " } }, - "statusCodes": { - "target": "com.amazonaws.health#entityStatusCodeList", + "entityValues": { + "target": "com.amazonaws.health#entityValueList", "traits": { - "smithy.api#documentation": "

A list of entity status codes (IMPAIRED, UNIMPAIRED, or\n UNKNOWN).

" + "smithy.api#documentation": "

A list of IDs for affected entities.

" } }, "entityArns": { @@ -915,12 +966,6 @@ "smithy.api#documentation": "

A list of the most recent dates and times that the entity was updated.

" } }, - "entityValues": { - "target": "com.amazonaws.health#entityValueList", - "traits": { - "smithy.api#documentation": "

A list of IDs for affected entities.

" - } - }, "eventArns": { "target": "com.amazonaws.health#eventArnList", "traits": { @@ -930,7 +975,7 @@ } }, "traits": { - "smithy.api#documentation": "

The values to use to filter results from the DescribeAffectedEntities operation.

" + "smithy.api#documentation": "

The values to use to filter results from the EntityFilter\n operation.

" } }, "com.amazonaws.health#EntityList": { @@ -942,12 +987,6 @@ "com.amazonaws.health#Event": { "type": "structure", "members": { - "endTime": { - "target": "com.amazonaws.health#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the event ended.

" - } - }, "service": { "target": "com.amazonaws.health#service", "traits": { @@ -960,22 +999,34 @@ "smithy.api#documentation": "

The category of the event. Possible values are issue,\n scheduledChange, and accountNotification.

" } }, + "region": { + "target": "com.amazonaws.health#region", + "traits": { + "smithy.api#documentation": "

The AWS region name of the event.

" + } + }, + "endTime": { + "target": "com.amazonaws.health#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the event ended.

" + } + }, "lastUpdatedTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The most recent date and time that the event was updated.

" } }, - "region": { - "target": "com.amazonaws.health#region", + "startTime": { + "target": "com.amazonaws.health#timestamp", "traits": { - "smithy.api#documentation": "

The AWS region name of the event.

" + "smithy.api#documentation": "

The date and time that the event began.

" } }, - "availabilityZone": { - "target": "com.amazonaws.health#availabilityZone", + "eventScopeCode": { + "target": "com.amazonaws.health#eventScopeCode", "traits": { - "smithy.api#documentation": "

The AWS Availability Zone of the event. For example, us-east-1a.

" + "smithy.api#documentation": "

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

\n " } }, "arn": { @@ -990,45 +1041,42 @@ "smithy.api#documentation": "

The most recent status of the event. Possible values are open,\n closed, and upcoming.

" } }, - "eventTypeCode": { - "target": "com.amazonaws.health#eventTypeCode", + "availabilityZone": { + "target": "com.amazonaws.health#availabilityZone", "traits": { - "smithy.api#documentation": "

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION\n ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" + "smithy.api#documentation": "

The AWS Availability Zone of the event. For example, us-east-1a.

" } }, - "startTime": { - "target": "com.amazonaws.health#timestamp", + "eventTypeCode": { + "target": "com.amazonaws.health#eventTypeCode", "traits": { - "smithy.api#documentation": "

The date and time that the event began.

" + "smithy.api#documentation": "

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION\n ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" } - }, - "eventScopeCode": { - "target": "com.amazonaws.health#eventScopeCode" } }, "traits": { - "smithy.api#documentation": "

Summary information about an AWS Health event.

" + "smithy.api#documentation": "

Summary information about an AWS Health event.

\n

AWS Health events can be public or account-specific:

\n \n

You can determine if an event is public or account-specific by using the\n eventScopeCode parameter. For more information, see eventScopeCode.

" } }, "com.amazonaws.health#EventAccountFilter": { "type": "structure", "members": { + "awsAccountId": { + "target": "com.amazonaws.health#accountId", + "traits": { + "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" + } + }, "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456\n

", "smithy.api#required": {} } - }, - "awsAccountId": { - "target": "com.amazonaws.health#accountId", - "traits": { - "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" - } } }, "traits": { - "smithy.api#documentation": "

The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.

" + "smithy.api#documentation": "

The values used to filter results from the DescribeEventDetailsForOrganization and \n DescribeAffectedEntitiesForOrganization operations.

" } }, "com.amazonaws.health#EventAggregate": { @@ -1048,7 +1096,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

" + "smithy.api#documentation": "

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

" } }, "com.amazonaws.health#EventAggregateList": { @@ -1080,7 +1128,7 @@ } }, "traits": { - "smithy.api#documentation": "

The detailed description of the event. Included in the information returned by the\n DescribeEventDetails operation.

" + "smithy.api#documentation": "

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

" } }, "com.amazonaws.health#EventDescription2": { @@ -1089,12 +1137,6 @@ "com.amazonaws.health#EventDetails": { "type": "structure", "members": { - "eventDescription": { - "target": "com.amazonaws.health#EventDescription", - "traits": { - "smithy.api#documentation": "

The most recent description of the event.

" - } - }, "event": { "target": "com.amazonaws.health#Event", "traits": { @@ -1106,10 +1148,16 @@ "traits": { "smithy.api#documentation": "

Additional metadata about the event.

" } + }, + "eventDescription": { + "target": "com.amazonaws.health#EventDescription", + "traits": { + "smithy.api#documentation": "

The most recent description of the event.

" + } } }, "traits": { - "smithy.api#documentation": "

Detailed information about an event. A combination of an Event\n object, an EventDescription object, and additional metadata about the\n event. Returned by the DescribeEventDetails operation.

" + "smithy.api#documentation": "

Detailed information about an event. A combination of an Event object,\n an EventDescription object, and additional metadata about the event.\n Returned by the DescribeEventDetails operation.

" } }, "com.amazonaws.health#EventDetailsErrorItem": { @@ -1121,21 +1169,21 @@ "smithy.api#documentation": "

A message that describes the error.

" } }, - "eventArn": { - "target": "com.amazonaws.health#eventArn", - "traits": { - "smithy.api#documentation": "

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456\n

" - } - }, "errorName": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

The name of the error.

" } + }, + "eventArn": { + "target": "com.amazonaws.health#eventArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456\n

" + } } }, "traits": { - "smithy.api#documentation": "

Error information returned when a DescribeEventDetails operation\n cannot find a specified event.

" + "smithy.api#documentation": "

Error information returned when a DescribeEventDetails operation\n cannot find a specified event.

" } }, "com.amazonaws.health#EventFilter": { @@ -1147,16 +1195,10 @@ "smithy.api#documentation": "

A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".\n

" } }, - "endTimes": { - "target": "com.amazonaws.health#dateTimeRangeList", - "traits": { - "smithy.api#documentation": "

A list of dates and times that the event ended.

" - } - }, "entityValues": { "target": "com.amazonaws.health#entityValueList", "traits": { - "smithy.api#documentation": "

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or\n EBS volumes (vol-426ab23e).

" + "smithy.api#documentation": "

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS\n volumes (vol-426ab23e).

" } }, "startTimes": { @@ -1165,10 +1207,34 @@ "smithy.api#documentation": "

A list of dates and times that the event began.

" } }, - "services": { - "target": "com.amazonaws.health#serviceList", + "entityArns": { + "target": "com.amazonaws.health#entityArnList", "traits": { - "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" + "smithy.api#documentation": "

A list of entity ARNs (unique identifiers).

" + } + }, + "lastUpdatedTimes": { + "target": "com.amazonaws.health#dateTimeRangeList", + "traits": { + "smithy.api#documentation": "

A list of dates and times that the event was last updated.

" + } + }, + "eventTypeCategories": { + "target": "com.amazonaws.health#eventTypeCategoryList2", + "traits": { + "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange,\n or accountNotification).

" + } + }, + "endTimes": { + "target": "com.amazonaws.health#dateTimeRangeList", + "traits": { + "smithy.api#documentation": "

A list of dates and times that the event ended.

" + } + }, + "eventArns": { + "target": "com.amazonaws.health#eventArnList", + "traits": { + "smithy.api#documentation": "

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"\n

" } }, "eventStatusCodes": { @@ -1186,7 +1252,7 @@ "tags": { "target": "com.amazonaws.health#tagFilter", "traits": { - "smithy.api#documentation": "

A map of entity tags attached to the affected entity.

" + "smithy.api#documentation": "

A map of entity tags attached to the affected entity.

\n \n

Currently, the tags property isn't supported.

\n " } }, "availabilityZones": { @@ -1195,33 +1261,15 @@ "smithy.api#documentation": "

A list of AWS availability zones.

" } }, - "lastUpdatedTimes": { - "target": "com.amazonaws.health#dateTimeRangeList", - "traits": { - "smithy.api#documentation": "

A list of dates and times that the event was last updated.

" - } - }, - "eventArns": { - "target": "com.amazonaws.health#eventArnList", - "traits": { - "smithy.api#documentation": "

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"\n

" - } - }, - "entityArns": { - "target": "com.amazonaws.health#entityArnList", - "traits": { - "smithy.api#documentation": "

A list of entity ARNs (unique identifiers).

" - } - }, - "eventTypeCategories": { - "target": "com.amazonaws.health#eventTypeCategoryList2", + "services": { + "target": "com.amazonaws.health#serviceList", "traits": { - "smithy.api#documentation": "

A list of event type category codes (issue,\n scheduledChange, or accountNotification).

" + "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" } } }, "traits": { - "smithy.api#documentation": "

The values to use to filter results from the DescribeEvents and\n DescribeEventAggregates operations.

" + "smithy.api#documentation": "

The values to use to filter results from the DescribeEvents and \n DescribeEventAggregates operations.

" } }, "com.amazonaws.health#EventList": { @@ -1233,16 +1281,16 @@ "com.amazonaws.health#EventType": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.health#eventTypeCode", + "category": { + "target": "com.amazonaws.health#eventTypeCategory", "traits": { - "smithy.api#documentation": "

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION\n ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" + "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange,\n or accountNotification).

" } }, - "category": { - "target": "com.amazonaws.health#eventTypeCategory", + "code": { + "target": "com.amazonaws.health#eventTypeCode", "traits": { - "smithy.api#documentation": "

A list of event type category codes (issue,\n scheduledChange, or accountNotification).

" + "smithy.api#documentation": "

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION\n ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" } }, "service": { @@ -1253,7 +1301,7 @@ } }, "traits": { - "smithy.api#documentation": "

Metadata about a type of event that is reported by AWS Health. Data consists of\n the category (for example, issue), the service (for example,\n EC2), and the event type code (for example,\n AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

" + "smithy.api#documentation": "

Metadata about a type of event that is reported by AWS Health. Data consists of the\n category (for example, issue), the service (for example, EC2),\n and the event type code (for example,\n AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

" } }, "com.amazonaws.health#EventType2": { @@ -1296,13 +1344,7 @@ "eventTypeCategories": { "target": "com.amazonaws.health#EventTypeCategoryList", "traits": { - "smithy.api#documentation": "

A list of event type category codes (issue,\n scheduledChange, or accountNotification).

" - } - }, - "eventTypeCodes": { - "target": "com.amazonaws.health#EventTypeCodeList", - "traits": { - "smithy.api#documentation": "

A list of event type codes.

" + "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange,\n or accountNotification).

" } }, "services": { @@ -1310,10 +1352,16 @@ "traits": { "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" } + }, + "eventTypeCodes": { + "target": "com.amazonaws.health#EventTypeCodeList", + "traits": { + "smithy.api#documentation": "

A list of event type codes.

" + } } }, "traits": { - "smithy.api#documentation": "

The values to use to filter results from the DescribeEventTypes\n operation.

" + "smithy.api#documentation": "

The values to use to filter results from the DescribeEventTypes\n operation.

" } }, "com.amazonaws.health#EventTypeList": { @@ -1337,33 +1385,33 @@ "com.amazonaws.health#OrganizationAffectedEntitiesErrorItem": { "type": "structure", "members": { - "errorMessage": { - "target": "com.amazonaws.health#string", + "awsAccountId": { + "target": "com.amazonaws.health#accountId", "traits": { - "smithy.api#documentation": "

The unique identifier for the event type. The format is\n AWS_SERVICE_DESCRIPTION. For example,\n AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" + "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" } }, - "eventArn": { - "target": "com.amazonaws.health#eventArn", + "errorName": { + "target": "com.amazonaws.health#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456\n

" + "smithy.api#documentation": "

The name of the error.

" } }, - "errorName": { + "errorMessage": { "target": "com.amazonaws.health#string", "traits": { - "smithy.api#documentation": "

The name of the error.

" + "smithy.api#documentation": "

The unique identifier for the event type. The format is\n AWS_SERVICE_DESCRIPTION. For example,\n AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" } }, - "awsAccountId": { - "target": "com.amazonaws.health#accountId", + "eventArn": { + "target": "com.amazonaws.health#eventArn", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" + "smithy.api#documentation": "

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456\n

" } } }, "traits": { - "smithy.api#documentation": "

Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a\n specific entity.

" + "smithy.api#documentation": "

Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a\n specific entity.

" } }, "com.amazonaws.health#OrganizationEntityFiltersList": { @@ -1381,20 +1429,29 @@ "com.amazonaws.health#OrganizationEvent": { "type": "structure", "members": { - "eventTypeCategory": { - "target": "com.amazonaws.health#eventTypeCategory", - "traits": { - "smithy.api#documentation": "

The category of the event type.

" - } - }, "service": { "target": "com.amazonaws.health#service", "traits": { "smithy.api#documentation": "

The AWS service that is affected by the event. For example, EC2, RDS.

" } }, - "eventScopeCode": { - "target": "com.amazonaws.health#eventScopeCode" + "statusCode": { + "target": "com.amazonaws.health#eventStatusCode", + "traits": { + "smithy.api#documentation": "

The most recent status of the event. Possible values are open,\n closed, and upcoming.

" + } + }, + "eventTypeCode": { + "target": "com.amazonaws.health#eventTypeCode", + "traits": { + "smithy.api#documentation": "

The unique identifier for the event type. The format is\n AWS_SERVICE_DESCRIPTION. For example,\n AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" + } + }, + "eventTypeCategory": { + "target": "com.amazonaws.health#eventTypeCategory", + "traits": { + "smithy.api#documentation": "

The category of the event type.

" + } }, "startTime": { "target": "com.amazonaws.health#timestamp", @@ -1402,10 +1459,10 @@ "smithy.api#documentation": "

The date and time that the event began.

" } }, - "eventTypeCode": { - "target": "com.amazonaws.health#eventTypeCode", + "lastUpdatedTime": { + "target": "com.amazonaws.health#timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier for the event type. The format is\n AWS_SERVICE_DESCRIPTION. For example,\n AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" + "smithy.api#documentation": "

The most recent date and time that the event was updated.

" } }, "arn": { @@ -1420,16 +1477,10 @@ "smithy.api#documentation": "

The AWS Region name of the event.

" } }, - "statusCode": { - "target": "com.amazonaws.health#eventStatusCode", - "traits": { - "smithy.api#documentation": "

The most recent status of the event. Possible values are open,\n closed, and upcoming.

" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.health#timestamp", + "eventScopeCode": { + "target": "com.amazonaws.health#eventScopeCode", "traits": { - "smithy.api#documentation": "

The most recent date and time that the event was updated.

" + "smithy.api#documentation": "

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

\n " } }, "endTime": { @@ -1440,7 +1491,7 @@ } }, "traits": { - "smithy.api#documentation": "

Summary information about an event, returned by the DescribeEventsForOrganization operation.

" + "smithy.api#documentation": "

Summary information about an event, returned by the DescribeEventsForOrganization operation.

" } }, "com.amazonaws.health#OrganizationEventDetailFiltersList": { @@ -1458,27 +1509,27 @@ "com.amazonaws.health#OrganizationEventDetails": { "type": "structure", "members": { - "awsAccountId": { - "target": "com.amazonaws.health#accountId", - "traits": { - "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" - } - }, "eventMetadata": { "target": "com.amazonaws.health#eventMetadata", "traits": { "smithy.api#documentation": "

Additional metadata about the event.

" } }, + "eventDescription": { + "target": "com.amazonaws.health#EventDescription" + }, "event": { "target": "com.amazonaws.health#Event" }, - "eventDescription": { - "target": "com.amazonaws.health#EventDescription" + "awsAccountId": { + "target": "com.amazonaws.health#accountId", + "traits": { + "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" + } } }, "traits": { - "smithy.api#documentation": "

Detailed information about an event. A combination of an Event object,\n an EventDescription object, and additional metadata about the event.\n Returned by the DescribeEventDetailsForOrganization operation.

" + "smithy.api#documentation": "

Detailed information about an event. A combination of an Event object,\n an EventDescription object, and additional metadata about the event.\n Returned by the DescribeEventDetailsForOrganization operation.

" } }, "com.amazonaws.health#OrganizationEventDetailsErrorItem": { @@ -1499,7 +1550,7 @@ "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { - "smithy.api#documentation": "

Error information returned when a DescribeEventDetailsForOrganization\n operation cannot find a specified event.

" + "smithy.api#documentation": "

Error information returned when a DescribeEventDetailsForOrganization\n operation cannot find a specified event.

" } }, "errorName": { @@ -1510,14 +1561,17 @@ } }, "traits": { - "smithy.api#documentation": "

Error information returned when a DescribeEventDetailsForOrganization\n operation cannot find a specified event.

" + "smithy.api#documentation": "

Error information returned when a DescribeEventDetailsForOrganization\n operation cannot find a specified event.

" } }, "com.amazonaws.health#OrganizationEventFilter": { "type": "structure", "members": { - "endTime": { - "target": "com.amazonaws.health#DateTimeRange" + "regions": { + "target": "com.amazonaws.health#regionList", + "traits": { + "smithy.api#documentation": "

A list of AWS Regions.

" + } }, "awsAccountIds": { "target": "com.amazonaws.health#awsAccountIdsList", @@ -1531,11 +1585,8 @@ "smithy.api#documentation": "

A list of event status codes.

" } }, - "services": { - "target": "com.amazonaws.health#serviceList", - "traits": { - "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" - } + "endTime": { + "target": "com.amazonaws.health#DateTimeRange" }, "eventTypeCodes": { "target": "com.amazonaws.health#eventTypeList2", @@ -1543,7 +1594,13 @@ "smithy.api#documentation": "

A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".\n

" } }, - "startTime": { + "eventTypeCategories": { + "target": "com.amazonaws.health#eventTypeCategoryList2", + "traits": { + "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange, or accountNotification).

" + } + }, + "lastUpdatedTime": { "target": "com.amazonaws.health#DateTimeRange" }, "entityValues": { @@ -1552,30 +1609,24 @@ "smithy.api#documentation": "

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

" } }, - "eventTypeCategories": { - "target": "com.amazonaws.health#eventTypeCategoryList2", + "services": { + "target": "com.amazonaws.health#serviceList", "traits": { - "smithy.api#documentation": "

REPLACEME

" + "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" } }, - "regions": { - "target": "com.amazonaws.health#regionList", - "traits": { - "smithy.api#documentation": "

A list of AWS Regions.

" - } + "startTime": { + "target": "com.amazonaws.health#DateTimeRange" }, "entityArns": { "target": "com.amazonaws.health#entityArnList", "traits": { - "smithy.api#documentation": "

REPLACEME

" + "smithy.api#documentation": "

A list of entity ARNs (unique identifiers).

" } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.health#DateTimeRange" } }, "traits": { - "smithy.api#documentation": "

The values to filter results from the DescribeEventsForOrganization\n operation.

" + "smithy.api#documentation": "

The values to filter results from the DescribeEventsForOrganization\n operation.

" } }, "com.amazonaws.health#OrganizationEventList": { diff --git a/codegen/sdk-codegen/aws-models/honeycode.2020-03-01.json b/codegen/sdk-codegen/aws-models/honeycode.2020-03-01.json index 29919de3049d..e4dfbeb390c3 100644 --- a/codegen/sdk-codegen/aws-models/honeycode.2020-03-01.json +++ b/codegen/sdk-codegen/aws-models/honeycode.2020-03-01.json @@ -232,18 +232,18 @@ "com.amazonaws.honeycode#GetScreenDataRequest": { "type": "structure", "members": { - "variables": { - "target": "com.amazonaws.honeycode#VariableValueMap", - "traits": { - "smithy.api#documentation": "

\n Variables are optional and are needed only if the screen requires them to render correctly. Variables are\n specified as a map where the key is the name of the variable as defined on the screen. The value is an\n object which currently has only one property, rawValue, which holds the value of the variable to be passed\n to the screen.\n

" - } - }, "nextToken": { "target": "com.amazonaws.honeycode#PaginationToken", "traits": { "smithy.api#documentation": "

\n This parameter is optional. If a nextToken is not specified, the API returns the first page of data.\n

\n

\n Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API\n will throw ValidationException.\n

" } }, + "variables": { + "target": "com.amazonaws.honeycode#VariableValueMap", + "traits": { + "smithy.api#documentation": "

\n Variables are optional and are needed only if the screen requires them to render correctly. Variables are\n specified as a map where the key is the name of the variable as defined on the screen. The value is an\n object which currently has only one property, rawValue, which holds the value of the variable to be passed\n to the screen.\n

" + } + }, "appId": { "target": "com.amazonaws.honeycode#ResourceId", "traits": { @@ -360,20 +360,18 @@ "com.amazonaws.honeycode#InvokeScreenAutomationRequest": { "type": "structure", "members": { - "screenAutomationId": { + "workbookId": { "target": "com.amazonaws.honeycode#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the automation action to be performed.

", + "smithy.api#documentation": "

The ID of the workbook that contains the screen automation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.honeycode#ResourceId", + "rowId": { + "target": "com.amazonaws.honeycode#RowId", "traits": { - "smithy.api#documentation": "

The ID of the app that contains the screen automation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

\n The row ID for the automation if the automation is defined inside a block with source or list.\n

" } }, "clientRequestToken": { @@ -382,33 +380,35 @@ "smithy.api#documentation": "

\n The request token for performing the automation action.\n Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error\n like a failed network connection, you can retry the call with the same request token. The service ensures\n that if the first call using that request token is successfully performed, the second call will return the\n response of the previous call rather than performing the action again.\n

\n

\n Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests\n spanning hours or days.\n

" } }, - "workbookId": { + "screenId": { "target": "com.amazonaws.honeycode#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the workbook that contains the screen automation.

", + "smithy.api#documentation": "

The ID of the screen that contains the screen automation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "variables": { - "target": "com.amazonaws.honeycode#VariableValueMap", - "traits": { - "smithy.api#documentation": "

\n Variables are optional and are needed only if the screen requires them to render correctly. Variables are\n specified as a map where the key is the name of the variable as defined on the screen. The value is an\n object which currently has only one property, rawValue, which holds the value of the variable to be passed\n to the screen.\n

" - } - }, - "rowId": { - "target": "com.amazonaws.honeycode#RowId", + "appId": { + "target": "com.amazonaws.honeycode#ResourceId", "traits": { - "smithy.api#documentation": "

\n The row ID for the automation if the automation is defined inside a block with source or list.\n

" + "smithy.api#documentation": "

The ID of the app that contains the screen automation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "screenId": { + "screenAutomationId": { "target": "com.amazonaws.honeycode#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the screen that contains the screen automation.

", + "smithy.api#documentation": "

The ID of the automation action to be performed.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "variables": { + "target": "com.amazonaws.honeycode#VariableValueMap", + "traits": { + "smithy.api#documentation": "

\n Variables are optional and are needed only if the screen requires them to render correctly. Variables are\n specified as a map where the key is the name of the variable as defined on the screen. The value is an\n object which currently has only one property, rawValue, which holds the value of the variable to be passed\n to the screen.\n

" + } } } }, @@ -520,17 +520,17 @@ "com.amazonaws.honeycode#ResultSet": { "type": "structure", "members": { - "headers": { - "target": "com.amazonaws.honeycode#ResultHeader", + "rows": { + "target": "com.amazonaws.honeycode#ResultRows", "traits": { - "smithy.api#documentation": "

\n List of headers for all the data cells in the block. The header identifies the name and default format of\n the data cell. Data cells appear in the same order in all rows as defined in the header. The names and\n formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank\n value is used.\n

\n

\n For example, a task list that displays the task name, due date and assigned person might have headers\n [ { \"name\": \"Task Name\"}, {\"name\": \"Due Date\", \"format\": \"DATE\"}, {\"name\": \"Assigned\", \"format\": \"CONTACT\"} ].\n Every row in the result will have the task name as the first item, due date as the second item and assigned\n person as the third item. If a particular task does not have a due date, that row will still have a blank\n value in the second element and the assigned person will still be in the third element.\n

", + "smithy.api#documentation": "

\n List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data\n cells will be present in the same order as they are defined in the header.\n

", "smithy.api#required": {} } }, - "rows": { - "target": "com.amazonaws.honeycode#ResultRows", + "headers": { + "target": "com.amazonaws.honeycode#ResultHeader", "traits": { - "smithy.api#documentation": "

\n List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data\n cells will be present in the same order as they are defined in the header.\n

", + "smithy.api#documentation": "

\n List of headers for all the data cells in the block. The header identifies the name and default format of\n the data cell. Data cells appear in the same order in all rows as defined in the header. The names and\n formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank\n value is used.\n

\n

\n For example, a task list that displays the task name, due date and assigned person might have headers\n [ { \"name\": \"Task Name\"}, {\"name\": \"Due Date\", \"format\": \"DATE\"}, {\"name\": \"Assigned\", \"format\": \"CONTACT\"} ].\n Every row in the result will have the task name as the first item, due date as the second item and assigned\n person as the third item. If a particular task does not have a due date, that row will still have a blank\n value in the second element and the assigned person will still be in the third element.\n

", "smithy.api#required": {} } } @@ -583,7 +583,7 @@ "sdkId": "Honeycode", "arnNamespace": "honeycode", "cloudFormationName": "Honeycode", - "cloudTrailEventSource": "model.honeycode.services.amazonaws.com" + "cloudTrailEventSource": "honeycode.amazonaws.com" }, "aws.auth#sigv4": { "name": "honeycode" 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 15cbc78caab8..77f58140495c 100644 --- a/codegen/sdk-codegen/aws-models/iam.2010-05-08.json +++ b/codegen/sdk-codegen/aws-models/iam.2010-05-08.json @@ -459,7 +459,7 @@ "sdkId": "IAM", "arnNamespace": "iam", "cloudFormationName": "IAM", - "cloudTrailEventSource": "v20100508.identity.auth.webservices.amazon.com" + "cloudTrailEventSource": "iam.amazonaws.com" }, "aws.auth#sigv4": { "name": "iam" @@ -490,19 +490,13 @@ "com.amazonaws.iam#AccessDetail": { "type": "structure", "members": { - "ServiceName": { - "target": "com.amazonaws.iam#serviceNameType", + "ServiceNamespace": { + "target": "com.amazonaws.iam#serviceNamespaceType", "traits": { - "smithy.api#documentation": "

The name of the service in which access was attempted.

", + "smithy.api#documentation": "

The namespace of the service in which access was attempted.

\n

To learn the service namespace of a service, go to Actions,\n Resources, and Condition Keys for AWS Services in the\n IAM User Guide. Choose the name of the service to view details\n for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b). For more information about service namespaces, see\n AWS\n Service Namespaces in the AWS General Reference.

", "smithy.api#required": {} } }, - "EntityPath": { - "target": "com.amazonaws.iam#organizationsEntityPathType", - "traits": { - "smithy.api#documentation": "

The path of the Organizations entity (root, organizational unit, or account) from which an\n authenticated principal last attempted to access the service. AWS does not report\n unauthenticated requests.

\n

This field is null if no principals (IAM users, IAM roles, or root users) in the\n reported Organizations entity attempted to access the service within the reporting period.

" - } - }, "TotalAuthenticatedEntities": { "target": "com.amazonaws.iam#integerType", "traits": { @@ -515,17 +509,23 @@ "smithy.api#documentation": "

The Region where the last service access attempt occurred.

\n

This field is null if no principals in the reported Organizations entity attempted to access the\n service within the reporting period.

" } }, - "LastAuthenticatedTime": { - "target": "com.amazonaws.iam#dateType", + "ServiceName": { + "target": "com.amazonaws.iam#serviceNameType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated principal most recently attempted to access the\n service. AWS does not report unauthenticated requests.

\n

This field is null if no principals in the reported Organizations entity attempted to access the\n service within the reporting period.

" + "smithy.api#documentation": "

The name of the service in which access was attempted.

", + "smithy.api#required": {} } }, - "ServiceNamespace": { - "target": "com.amazonaws.iam#serviceNamespaceType", + "EntityPath": { + "target": "com.amazonaws.iam#organizationsEntityPathType", "traits": { - "smithy.api#documentation": "

The namespace of the service in which access was attempted.

\n

To learn the service namespace of a service, go to Actions,\n Resources, and Condition Keys for AWS Services in the\n IAM User Guide. Choose the name of the service to view details\n for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b). For more information about service namespaces, see\n AWS\n Service Namespaces in the AWS General Reference.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The path of the Organizations entity (root, organizational unit, or account) from which an\n authenticated principal last attempted to access the service. AWS does not report\n unauthenticated requests.

\n

This field is null if no principals (IAM users, IAM roles, or root users) in the\n reported Organizations entity attempted to access the service within the reporting period.

" + } + }, + "LastAuthenticatedTime": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated principal most recently attempted to access the\n service. AWS does not report unauthenticated requests.

\n

This field is null if no principals in the reported Organizations entity attempted to access the\n service within the reporting period.

" } } }, @@ -542,18 +542,17 @@ "com.amazonaws.iam#AccessKey": { "type": "structure", "members": { - "AccessKeyId": { - "target": "com.amazonaws.iam#accessKeyIdType", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The ID for this access key.

", + "smithy.api#documentation": "

The name of the IAM user that the access key is associated with.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.iam#statusType", + "CreateDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The status of the access key. Active means that the key is valid for API\n calls, while Inactive means it is not.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The date when the access key was created.

" } }, "SecretAccessKey": { @@ -563,17 +562,18 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", "traits": { - "smithy.api#documentation": "

The name of the IAM user that the access key is associated with.

", + "smithy.api#documentation": "

The ID for this access key.

", "smithy.api#required": {} } }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The date when the access key was created.

" + "smithy.api#documentation": "

The status of the access key. Active means that the key is valid for API\n calls, while Inactive means it is not.

", + "smithy.api#required": {} } } }, @@ -584,10 +584,10 @@ "com.amazonaws.iam#AccessKeyLastUsed": { "type": "structure", "members": { - "ServiceName": { + "Region": { "target": "com.amazonaws.iam#stringType", "traits": { - "smithy.api#documentation": "

The name of the AWS service with which this access key was most recently used. The value\n of this field is \"N/A\" in the following situations:

\n ", + "smithy.api#documentation": "

The AWS Region where this access key was most recently used. The value for this field is\n \"N/A\" in the following situations:

\n \n

For more information about AWS Regions, see Regions and Endpoints in the Amazon Web Services\n General Reference.

", "smithy.api#required": {} } }, @@ -598,10 +598,10 @@ "smithy.api#required": {} } }, - "Region": { + "ServiceName": { "target": "com.amazonaws.iam#stringType", "traits": { - "smithy.api#documentation": "

The AWS Region where this access key was most recently used. The value for this field is\n \"N/A\" in the following situations:

\n \n

For more information about AWS Regions, see Regions and Endpoints in the Amazon Web Services\n General Reference.

", + "smithy.api#documentation": "

The name of the AWS service with which this access key was most recently used. The value\n of this field is \"N/A\" in the following situations:

\n ", "smithy.api#required": {} } } @@ -613,28 +613,28 @@ "com.amazonaws.iam#AccessKeyMetadata": { "type": "structure", "members": { - "AccessKeyId": { - "target": "com.amazonaws.iam#accessKeyIdType", - "traits": { - "smithy.api#documentation": "

The ID for this access key.

" - } - }, "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "

The name of the IAM user that the key is associated with.

" } }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the access key was created.

" + } + }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "

The status of the access key. Active means that the key is valid for API\n calls; Inactive means it is not.

" } }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", "traits": { - "smithy.api#documentation": "

The date when the access key was created.

" + "smithy.api#documentation": "

The ID for this access key.

" } } }, @@ -683,17 +683,17 @@ "com.amazonaws.iam#AddClientIDToOpenIDConnectProviderRequest": { "type": "structure", "members": { - "ClientID": { - "target": "com.amazonaws.iam#clientIDType", + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The client ID (also known as audience) to add to the IAM OpenID Connect provider\n resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to\n add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

", "smithy.api#required": {} } }, - "OpenIDConnectProviderArn": { - "target": "com.amazonaws.iam#arnType", + "ClientID": { + "target": "com.amazonaws.iam#clientIDType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to\n add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

", + "smithy.api#documentation": "

The client ID (also known as audience) to add to the IAM OpenID Connect provider\n resource.

", "smithy.api#required": {} } } @@ -728,17 +728,17 @@ "com.amazonaws.iam#AddRoleToInstanceProfileRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "InstanceProfileName": { + "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { - "smithy.api#documentation": "

The name of the role to add.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the instance profile to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "InstanceProfileName": { - "target": "com.amazonaws.iam#instanceProfileNameType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The name of the instance profile to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the role to add.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -767,17 +767,17 @@ "com.amazonaws.iam#AddUserToGroupRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#existingUserNameType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The name of the user to add.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the group to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", "traits": { - "smithy.api#documentation": "

The name of the group to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the user to add.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -818,17 +818,17 @@ "com.amazonaws.iam#AttachGroupPolicyRequest": { "type": "structure", "members": { - "PolicyArn": { - "target": "com.amazonaws.iam#arnType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#documentation": "

The name (friendly name, not ARN) of the group to attach the policy to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The name (friendly name, not ARN) of the group to attach the policy to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } } @@ -930,17 +930,17 @@ "com.amazonaws.iam#AttachedPermissionsBoundary": { "type": "structure", "members": { - "PermissionsBoundaryArn": { - "target": "com.amazonaws.iam#arnType", - "traits": { - "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user or role.

" - } - }, "PermissionsBoundaryType": { "target": "com.amazonaws.iam#PermissionsBoundaryAttachmentType", "traits": { "smithy.api#documentation": "

The permissions boundary usage type that indicates what type of IAM resource is used\n as the permissions boundary for an entity. This data type can only have a value of\n Policy.

" } + }, + "PermissionsBoundaryArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user or role.

" + } } }, "traits": { @@ -950,14 +950,14 @@ "com.amazonaws.iam#AttachedPolicy": { "type": "structure", "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType" + }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "

The friendly name of the attached policy.

" } - }, - "PolicyArn": { - "target": "com.amazonaws.iam#arnType" } }, "traits": { @@ -1002,17 +1002,17 @@ "com.amazonaws.iam#ChangePasswordRequest": { "type": "structure", "members": { - "OldPassword": { + "NewPassword": { "target": "com.amazonaws.iam#passwordType", "traits": { - "smithy.api#documentation": "

The IAM user's current password.

", + "smithy.api#documentation": "

The new password. The new password must conform to the AWS account's password policy,\n if one exists.

\n

The regex pattern \n that is used to validate this parameter is a string of characters. That string can include almost any printable \n ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). \n You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) \n characters. Any of these characters are valid in a password. However, many tools, such \n as the AWS Management Console, might restrict the ability to type certain characters because they have \n special meaning within that tool.

", "smithy.api#required": {} } }, - "NewPassword": { + "OldPassword": { "target": "com.amazonaws.iam#passwordType", "traits": { - "smithy.api#documentation": "

The new password. The new password must conform to the AWS account's password policy,\n if one exists.

\n

The regex pattern \n that is used to validate this parameter is a string of characters. That string can include almost any printable \n ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). \n You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) \n characters. Any of these characters are valid in a password. However, many tools, such \n as the AWS Management Console, might restrict the ability to type certain characters because they have \n special meaning within that tool.

", + "smithy.api#documentation": "

The IAM user's current password.

", "smithy.api#required": {} } } @@ -1040,6 +1040,12 @@ "com.amazonaws.iam#ContextEntry": { "type": "structure", "members": { + "ContextKeyName": { + "target": "com.amazonaws.iam#ContextKeyNameType", + "traits": { + "smithy.api#documentation": "

The full name of a condition context key, including the service prefix. For example,\n aws:SourceIp or s3:VersionId.

" + } + }, "ContextKeyType": { "target": "com.amazonaws.iam#ContextKeyTypeEnum", "traits": { @@ -1051,12 +1057,6 @@ "traits": { "smithy.api#documentation": "

The value (or values, if the condition context key supports multiple values) to provide\n to the simulation when the key is referenced by a Condition element in an\n input policy.

" } - }, - "ContextKeyName": { - "target": "com.amazonaws.iam#ContextKeyNameType", - "traits": { - "smithy.api#documentation": "

The full name of a condition context key, including the service prefix. For example,\n aws:SourceIp or s3:VersionId.

" - } } }, "traits": { @@ -1258,18 +1258,18 @@ "com.amazonaws.iam#CreateGroupRequest": { "type": "structure", "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "

The name of the group to create. Do not include the path in this value.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

", "smithy.api#required": {} } - }, - "Path": { - "target": "com.amazonaws.iam#pathType", - "traits": { - "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" - } } } }, @@ -1314,18 +1314,18 @@ "com.amazonaws.iam#CreateInstanceProfileRequest": { "type": "structure", "members": { + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the instance profile. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "

The name of the instance profile to create.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } - }, - "Path": { - "target": "com.amazonaws.iam#pathType", - "traits": { - "smithy.api#documentation": "

The path to the instance profile. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" - } } } }, @@ -1376,13 +1376,6 @@ "com.amazonaws.iam#CreateLoginProfileRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#userNameType", - "traits": { - "smithy.api#documentation": "

The name of the IAM user to create a password for. The user must already exist.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "smithy.api#required": {} - } - }, "Password": { "target": "com.amazonaws.iam#passwordType", "traits": { @@ -1395,6 +1388,13 @@ "traits": { "smithy.api#documentation": "

Specifies whether the user is required to set a new password on next sign-in.

" } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user to create a password for. The user must already exist.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } } } }, @@ -1449,18 +1449,18 @@ "smithy.api#required": {} } }, + "ClientIDList": { + "target": "com.amazonaws.iam#clientIDListType", + "traits": { + "smithy.api#documentation": "

A list of client IDs (also known as audiences). When a mobile or web app registers with\n an OpenID Connect provider, they establish a value that identifies the application. (This\n is the value that's sent as the client_id parameter on OAuth requests.)

\n

You can register multiple client IDs with the same provider. For example, you might have\n multiple applications that use the same OIDC provider. You cannot register more than 100\n client IDs with a single IAM OIDC provider.

\n

There is no defined format for a client ID. The\n CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255\n characters long.

" + } + }, "ThumbprintList": { "target": "com.amazonaws.iam#thumbprintListType", "traits": { "smithy.api#documentation": "

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity\n provider's server certificates. Typically this list includes only one entry. However, IAM\n lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple\n thumbprints if the identity provider is rotating certificates.

\n

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509\n certificate used by the domain where the OpenID Connect provider makes its keys available.\n It is always a 40-character string.

\n

You must provide at least one thumbprint when creating an IAM OIDC provider. For\n example, assume that the OIDC provider is server.example.com and the provider\n stores its keys at https://keys.server.example.com/openid-connect. In that case, the\n thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by\n https://keys.server.example.com.

\n

For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM\n User Guide.

", "smithy.api#required": {} } - }, - "ClientIDList": { - "target": "com.amazonaws.iam#clientIDListType", - "traits": { - "smithy.api#documentation": "

A list of client IDs (also known as audiences). When a mobile or web app registers with\n an OpenID Connect provider, they establish a value that identifies the application. (This\n is the value that's sent as the client_id parameter on OAuth requests.)

\n

You can register multiple client IDs with the same provider. For example, you might have\n multiple applications that use the same OIDC provider. You cannot register more than 100\n client IDs with a single IAM OIDC provider.

\n

There is no defined format for a client ID. The\n CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255\n characters long.

" - } } } }, @@ -1510,23 +1510,17 @@ "com.amazonaws.iam#CreatePolicyRequest": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

The friendly name of the policy.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

", + "smithy.api#documentation": "

The JSON policy document that you want to use as the content for the new policy.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", "smithy.api#required": {} } }, - "Path": { - "target": "com.amazonaws.iam#policyPathType", - "traits": { - "smithy.api#documentation": "

The path for the policy.

\n

For more information about paths, see IAM Identifiers in the\n IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" - } - }, - "PolicyDocument": { - "target": "com.amazonaws.iam#policyDocumentType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The JSON policy document that you want to use as the content for the new policy.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", + "smithy.api#documentation": "

The friendly name of the policy.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

", "smithy.api#required": {} } }, @@ -1535,6 +1529,12 @@ "traits": { "smithy.api#documentation": "

A friendly description of the policy.

\n

Typically used to store information about the permissions defined in the policy. For\n example, \"Grants access to production DynamoDB tables.\"

\n

The policy description is immutable. After a value is assigned, it cannot be\n changed.

" } + }, + "Path": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path for the policy.

\n

For more information about paths, see IAM Identifiers in the\n IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } } } }, @@ -1591,18 +1591,18 @@ "smithy.api#required": {} } }, - "SetAsDefault": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

Specifies whether to set this version as the policy's default version.

\n

When this parameter is true, the new policy version becomes the operative\n version. That is, it becomes the version that is in effect for the IAM users, groups, and\n roles that the policy is attached to.

\n

For more information about managed policy versions, see Versioning for Managed\n Policies in the IAM User Guide.

" - } - }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new\n version.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } + }, + "SetAsDefault": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

Specifies whether to set this version as the policy's default version.

\n

When this parameter is true, the new policy version becomes the operative\n version. That is, it becomes the version that is in effect for the IAM users, groups, and\n roles that the policy is attached to.

\n

For more information about managed policy versions, see Versioning for Managed\n Policies in the IAM User Guide.

" + } } } }, @@ -1655,10 +1655,16 @@ "com.amazonaws.iam#CreateRoleRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.iam#tagListType", + "PermissionsBoundary": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

A list of tags that you want to attach to the newly created role. Each tag consists of\n a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed number of tags per\n role, then the entire request fails and the role is not created.

\n " + "smithy.api#documentation": "

The ARN of the policy that is used to set the permissions boundary for the role.

" + } + }, + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", + "traits": { + "smithy.api#documentation": "

A description of the role.

" } }, "Path": { @@ -1673,17 +1679,10 @@ "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default maximum of one hour is applied.\n This setting can have a value from 1 hour to 12 hours.

\n

Anyone who assumes the role from the AWS CLI or API can use the\n DurationSeconds API parameter or the duration-seconds CLI\n parameter to request a longer session. The MaxSessionDuration setting\n determines the maximum duration that can be requested using the\n DurationSeconds parameter. If users don't specify a value for the\n DurationSeconds parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole* API operations or\n the assume-role* CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM Roles in the\n IAM User Guide.

" } }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", - "traits": { - "smithy.api#documentation": "

The name of the role to create.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.iam#roleDescriptionType", + "Tags": { + "target": "com.amazonaws.iam#tagListType", "traits": { - "smithy.api#documentation": "

A description of the role.

" + "smithy.api#documentation": "

A list of tags that you want to attach to the newly created role. Each tag consists of\n a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the\n IAM User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed number of tags per\n role, then the entire request fails and the role is not created.

\n " } }, "AssumeRolePolicyDocument": { @@ -1693,10 +1692,11 @@ "smithy.api#required": {} } }, - "PermissionsBoundary": { - "target": "com.amazonaws.iam#arnType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The ARN of the policy that is used to set the permissions boundary for the role.

" + "smithy.api#documentation": "

The name of the role to create.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

", + "smithy.api#required": {} } } } @@ -1804,6 +1804,12 @@ "com.amazonaws.iam#CreateServiceLinkedRoleRequest": { "type": "structure", "members": { + "CustomSuffix": { + "target": "com.amazonaws.iam#customSuffixType", + "traits": { + "smithy.api#documentation": "

\n

A string that you provide, which is combined with the service-provided prefix to form\n the complete role name. If you make multiple requests for the same service, then you must\n supply a different CustomSuffix for each request. Otherwise the request fails\n with a duplicate role name error. For example, you could add -1 or\n -debug to the suffix.

\n

Some services do not support the CustomSuffix parameter. If you provide an\n optional suffix and the operation fails, try the operation again without the suffix.

" + } + }, "AWSServiceName": { "target": "com.amazonaws.iam#groupNameType", "traits": { @@ -1816,12 +1822,6 @@ "traits": { "smithy.api#documentation": "

The description of the role.

" } - }, - "CustomSuffix": { - "target": "com.amazonaws.iam#customSuffixType", - "traits": { - "smithy.api#documentation": "

\n

A string that you provide, which is combined with the service-provided prefix to form\n the complete role name. If you make multiple requests for the same service, then you must\n supply a different CustomSuffix for each request. Otherwise the request fails\n with a duplicate role name error. For example, you could add -1 or\n -debug to the suffix.

\n

Some services do not support the CustomSuffix parameter. If you provide an\n optional suffix and the operation fails, try the operation again without the suffix.

" - } } } }, @@ -1862,17 +1862,17 @@ "com.amazonaws.iam#CreateServiceSpecificCredentialRequest": { "type": "structure", "members": { - "ServiceName": { - "target": "com.amazonaws.iam#serviceName", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The name of the AWS service that is to be associated with the credentials. The service\n you specify here is the only service that can be accessed using these credentials.

", + "smithy.api#documentation": "

The name of the IAM user that is to be associated with the credentials. The new\n service-specific credentials have the same permissions as the associated user except that\n they can be used only to access the specified service.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "ServiceName": { + "target": "com.amazonaws.iam#serviceName", "traits": { - "smithy.api#documentation": "

The name of the IAM user that is to be associated with the credentials. The new\n service-specific credentials have the same permissions as the associated user except that\n they can be used only to access the specified service.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the AWS service that is to be associated with the credentials. The service\n you specify here is the only service that can be accessed using these credentials.

", "smithy.api#required": {} } } @@ -1924,12 +1924,6 @@ "com.amazonaws.iam#CreateUserRequest": { "type": "structure", "members": { - "Path": { - "target": "com.amazonaws.iam#pathType", - "traits": { - "smithy.api#documentation": "

The path for the user name. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" - } - }, "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { @@ -1937,6 +1931,12 @@ "smithy.api#required": {} } }, + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path for the user name. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } + }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { @@ -2125,18 +2125,18 @@ "com.amazonaws.iam#DeleteAccessKeyRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#existingUserNameType", - "traits": { - "smithy.api#documentation": "

The name of the user whose access key pair you want to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, "AccessKeyId": { "target": "com.amazonaws.iam#accessKeyIdType", "traits": { "smithy.api#documentation": "

The access key ID for the access key ID and secret access key you want to delete.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", "smithy.api#required": {} } + }, + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose access key pair you want to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } } } }, @@ -2248,17 +2248,17 @@ "com.amazonaws.iam#DeleteGroupPolicyRequest": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The name identifying the policy document to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the group that the policy is embedded\n in.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the group that the policy is embedded\n in.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name identifying the policy document to delete.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -2548,17 +2548,17 @@ "com.amazonaws.iam#DeleteRolePolicyRequest": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The name of the inline policy to delete from the specified IAM role.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the role that the policy is embedded\n in.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The name (friendly name, not ARN) identifying the role that the policy is embedded\n in.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the inline policy to delete from the specified IAM role.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -2628,17 +2628,17 @@ "com.amazonaws.iam#DeleteSSHPublicKeyRequest": { "type": "structure", "members": { - "SSHPublicKeyId": { - "target": "com.amazonaws.iam#publicKeyIdType", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", "traits": { - "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", "smithy.api#required": {} } } @@ -2781,18 +2781,18 @@ "com.amazonaws.iam#DeleteSigningCertificateRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#existingUserNameType", - "traits": { - "smithy.api#documentation": "

The name of the user the signing certificate belongs to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, "CertificateId": { "target": "com.amazonaws.iam#certificateIdType", "traits": { "smithy.api#documentation": "

The ID of the signing certificate to delete.

\n

The format of this parameter, as described by its regex pattern, is a string of characters\n that can be upper- or lower-cased letters or digits.

", "smithy.api#required": {} } + }, + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", + "traits": { + "smithy.api#documentation": "

The name of the user the signing certificate belongs to.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } } } }, @@ -2940,17 +2940,17 @@ "com.amazonaws.iam#DeletionTaskFailureReasonType": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.iam#ReasonType", - "traits": { - "smithy.api#documentation": "

A short description of the reason that the service-linked role deletion failed.

" - } - }, "RoleUsageList": { "target": "com.amazonaws.iam#RoleUsageListType", "traits": { "smithy.api#documentation": "

A list of objects that contains details about the service-linked role deletion failure,\n if that information is returned by the service. If the service-linked role has active\n sessions or if any resources that were used by the role have not been deleted from the\n linked service, the role can't be deleted. This parameter includes a list of the resources\n that are associated with the role and the Region in which the resources are being\n used.

" } + }, + "Reason": { + "target": "com.amazonaws.iam#ReasonType", + "traits": { + "smithy.api#documentation": "

A short description of the reason that the service-linked role deletion failed.

" + } } }, "traits": { @@ -3060,17 +3060,17 @@ "com.amazonaws.iam#DetachRolePolicyRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM role to detach the policy from.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } }, - "PolicyArn": { - "target": "com.amazonaws.iam#arnType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM role to detach the policy from.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -3176,17 +3176,17 @@ "com.amazonaws.iam#EnableMFADeviceRequest": { "type": "structure", "members": { - "SerialNumber": { - "target": "com.amazonaws.iam#serialNumberType", + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", "traits": { - "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n serial number is the device ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-

", + "smithy.api#documentation": "

The name of the IAM user for whom you want to enable the MFA device.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "AuthenticationCode1": { - "target": "com.amazonaws.iam#authenticationCodeType", + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", "traits": { - "smithy.api#documentation": "

An authentication code emitted by the device.

\n

The format for this parameter is a string of six digits.

\n \n

Submit your request immediately after generating the authentication codes. If you\n generate the codes and then wait too long to submit the request, the MFA device\n successfully associates with the user but the MFA device becomes out of sync. This\n happens because time-based one-time passwords (TOTP) expire after a short period of\n time. If this happens, you can resync the device.

\n ", + "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n serial number is the device ARN.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-

", "smithy.api#required": {} } }, @@ -3197,10 +3197,10 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#existingUserNameType", + "AuthenticationCode1": { + "target": "com.amazonaws.iam#authenticationCodeType", "traits": { - "smithy.api#documentation": "

The name of the IAM user for whom you want to enable the MFA device.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

An authentication code emitted by the device.

\n

The format for this parameter is a string of six digits.

\n \n

Submit your request immediately after generating the authentication codes. If you\n generate the codes and then wait too long to submit the request, the MFA device\n successfully associates with the user but the MFA device becomes out of sync. This\n happens because time-based one-time passwords (TOTP) expire after a short period of\n time. If this happens, you can resync the device.

\n ", "smithy.api#required": {} } } @@ -3243,17 +3243,10 @@ "com.amazonaws.iam#EntityInfo": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.iam#userNameType", - "traits": { - "smithy.api#documentation": "

The name of the entity (user or role).

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.iam#idType", + "Type": { + "target": "com.amazonaws.iam#policyOwnerEntityType", "traits": { - "smithy.api#documentation": "

The identifier of the entity (user or role).

", + "smithy.api#documentation": "

The type of entity (user or role).

", "smithy.api#required": {} } }, @@ -3263,16 +3256,23 @@ "smithy.api#documentation": "

The path to the entity (user or role). For more information about paths, see IAM\n Identifiers in the IAM User Guide.

" } }, + "Name": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the entity (user or role).

", + "smithy.api#required": {} + } + }, "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.iam#policyOwnerEntityType", + "Id": { + "target": "com.amazonaws.iam#idType", "traits": { - "smithy.api#documentation": "

The type of entity (user or role).

", + "smithy.api#documentation": "

The identifier of the entity (user or role).

", "smithy.api#required": {} } } @@ -3324,17 +3324,17 @@ "com.amazonaws.iam#ErrorDetails": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.iam#stringType", "traits": { - "smithy.api#documentation": "

The error code associated with the operation failure.

", + "smithy.api#documentation": "

Detailed information about the reason that the operation failed.

", "smithy.api#required": {} } }, - "Message": { + "Code": { "target": "com.amazonaws.iam#stringType", "traits": { - "smithy.api#documentation": "

Detailed information about the reason that the operation failed.

", + "smithy.api#documentation": "

The error code associated with the operation failure.

", "smithy.api#required": {} } } @@ -3364,13 +3364,6 @@ "com.amazonaws.iam#EvaluationResult": { "type": "structure", "members": { - "EvalDecision": { - "target": "com.amazonaws.iam#PolicyEvaluationDecisionType", - "traits": { - "smithy.api#documentation": "

The result of the simulation.

", - "smithy.api#required": {} - } - }, "EvalActionName": { "target": "com.amazonaws.iam#ActionNameType", "traits": { @@ -3378,40 +3371,41 @@ "smithy.api#required": {} } }, - "EvalDecisionDetails": { - "target": "com.amazonaws.iam#EvalDecisionDetailsType", + "MissingContextValues": { + "target": "com.amazonaws.iam#ContextKeyNamesResultListType", "traits": { - "smithy.api#documentation": "

Additional details about the results of the cross-account evaluation decision. This\n parameter is populated for only cross-account simulations. It contains a brief summary of\n how each policy type contributes to the final evaluation decision.

\n

If the simulation evaluates policies within the same account and includes a resource\n ARN, then the parameter is present but the response is empty. If the simulation evaluates\n policies within the same account and specifies all resources (*), then the\n parameter is not returned.

\n

When you make a cross-account request, AWS evaluates the request in the trusting\n account and the trusted account. The request is allowed only if both evaluations return\n true. For more information about how policies are evaluated, see Evaluating Policies Within a Single Account.

\n

If an AWS Organizations SCP included in the evaluation denies access, the simulation ends. In\n this case, policy evaluation does not proceed any further and this parameter is not\n returned.

" + "smithy.api#documentation": "

A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when the resource in a\n simulation is \"*\", either explicitly, or when the ResourceArns parameter\n blank. If you include a list of resources, then any missing context values are instead\n included under the ResourceSpecificResults section. To discover the context\n keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" } }, - "OrganizationsDecisionDetail": { - "target": "com.amazonaws.iam#OrganizationsDecisionDetail", + "PermissionsBoundaryDecisionDetail": { + "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", "traits": { - "smithy.api#documentation": "

A structure that details how Organizations and its service control policies affect the results of\n the simulation. Only applies if the simulated user's account is part of an\n organization.

" + "smithy.api#documentation": "

Contains information about the effect that a permissions boundary has on a policy\n simulation when the boundary is applied to an IAM entity.

" } }, - "EvalResourceName": { - "target": "com.amazonaws.iam#ResourceNameType", + "EvalDecision": { + "target": "com.amazonaws.iam#PolicyEvaluationDecisionType", "traits": { - "smithy.api#documentation": "

The ARN of the resource that the indicated API operation was tested on.

" + "smithy.api#documentation": "

The result of the simulation.

", + "smithy.api#required": {} } }, - "MatchedStatements": { - "target": "com.amazonaws.iam#StatementListType", + "EvalResourceName": { + "target": "com.amazonaws.iam#ResourceNameType", "traits": { - "smithy.api#documentation": "

A list of the statements in the input policies that determine the result for this\n scenario. Remember that even if multiple statements allow the operation on the resource, if\n only one statement denies that operation, then the explicit deny overrides any allow. In\n addition, the deny statement is the only entry included in the result.

" + "smithy.api#documentation": "

The ARN of the resource that the indicated API operation was tested on.

" } }, - "MissingContextValues": { - "target": "com.amazonaws.iam#ContextKeyNamesResultListType", + "OrganizationsDecisionDetail": { + "target": "com.amazonaws.iam#OrganizationsDecisionDetail", "traits": { - "smithy.api#documentation": "

A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when the resource in a\n simulation is \"*\", either explicitly, or when the ResourceArns parameter\n blank. If you include a list of resources, then any missing context values are instead\n included under the ResourceSpecificResults section. To discover the context\n keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" + "smithy.api#documentation": "

A structure that details how Organizations and its service control policies affect the results of\n the simulation. Only applies if the simulated user's account is part of an\n organization.

" } }, - "PermissionsBoundaryDecisionDetail": { - "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", + "MatchedStatements": { + "target": "com.amazonaws.iam#StatementListType", "traits": { - "smithy.api#documentation": "

Contains information about the effect that a permissions boundary has on a policy\n simulation when the boundary is applied to an IAM entity.

" + "smithy.api#documentation": "

A list of the statements in the input policies that determine the result for this\n scenario. Remember that even if multiple statements allow the operation on the resource, if\n only one statement denies that operation, then the explicit deny overrides any allow. In\n addition, the deny statement is the only entry included in the result.

" } }, "ResourceSpecificResults": { @@ -3419,6 +3413,12 @@ "traits": { "smithy.api#documentation": "

The individual results of the simulation of the API operation specified in\n EvalActionName on each resource.

" } + }, + "EvalDecisionDetails": { + "target": "com.amazonaws.iam#EvalDecisionDetailsType", + "traits": { + "smithy.api#documentation": "

Additional details about the results of the cross-account evaluation decision. This\n parameter is populated for only cross-account simulations. It contains a brief summary of\n how each policy type contributes to the final evaluation decision.

\n

If the simulation evaluates policies within the same account and includes a resource\n ARN, then the parameter is present but the response is empty. If the simulation evaluates\n policies within the same account and specifies all resources (*), then the\n parameter is not returned.

\n

When you make a cross-account request, AWS evaluates the request in the trusting\n account and the trusted account. The request is allowed only if both evaluations return\n true. For more information about how policies are evaluated, see Evaluating Policies Within a Single Account.

\n

If an AWS Organizations SCP included in the evaluation denies access, the simulation ends. In\n this case, policy evaluation does not proceed any further and this parameter is not\n returned.

" + } } }, "traits": { @@ -3451,17 +3451,17 @@ "com.amazonaws.iam#GenerateCredentialReportResponse": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.iam#ReportStateType", - "traits": { - "smithy.api#documentation": "

Information about the state of the credential report.

" - } - }, "Description": { "target": "com.amazonaws.iam#ReportStateDescriptionType", "traits": { "smithy.api#documentation": "

Information about the credential report.

" } + }, + "State": { + "target": "com.amazonaws.iam#ReportStateType", + "traits": { + "smithy.api#documentation": "

Information about the state of the credential report.

" + } } }, "traits": { @@ -3537,18 +3537,18 @@ "com.amazonaws.iam#GenerateServiceLastAccessedDetailsRequest": { "type": "structure", "members": { + "Granularity": { + "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", + "traits": { + "smithy.api#documentation": "

The level of detail that you want to generate. You can specify whether you want to\n generate information about the last attempt to access services or actions. If you specify\n service-level granularity, this operation generates only service data. If you specify\n action-level granularity, it generates service and action data. If you don't include this\n optional parameter, the operation generates service data.

" + } + }, "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "

The ARN of the IAM resource (user, group, role, or managed policy) used to generate\n information about when the resource was last used in an attempt to access an AWS\n service.

", "smithy.api#required": {} } - }, - "Granularity": { - "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", - "traits": { - "smithy.api#documentation": "

The level of detail that you want to generate. You can specify whether you want to\n generate information about the last attempt to access services or actions. If you specify\n service-level granularity, this operation generates only service data. If you specify\n action-level granularity, it generates service and action data. If you don't include this\n optional parameter, the operation generates service data.

" - } } } }, @@ -3590,17 +3590,17 @@ "com.amazonaws.iam#GetAccessKeyLastUsedResponse": { "type": "structure", "members": { - "AccessKeyLastUsed": { - "target": "com.amazonaws.iam#AccessKeyLastUsed", - "traits": { - "smithy.api#documentation": "

Contains information about the last time the access key was used.

" - } - }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "

The name of the AWS IAM user that owns this access key.

\n

" } + }, + "AccessKeyLastUsed": { + "target": "com.amazonaws.iam#AccessKeyLastUsed", + "traits": { + "smithy.api#documentation": "

Contains information about the last time the access key was used.

" + } } }, "traits": { @@ -3655,10 +3655,10 @@ "com.amazonaws.iam#GetAccountAuthorizationDetailsResponse": { "type": "structure", "members": { - "RoleDetailList": { - "target": "com.amazonaws.iam#roleDetailListType", + "Policies": { + "target": "com.amazonaws.iam#ManagedPolicyDetailListType", "traits": { - "smithy.api#documentation": "

A list containing information about IAM roles.

" + "smithy.api#documentation": "

A list containing information about managed policies.

" } }, "IsTruncated": { @@ -3673,22 +3673,22 @@ "smithy.api#documentation": "

A list containing information about IAM users.

" } }, - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", + "GroupDetailList": { + "target": "com.amazonaws.iam#groupDetailListType", "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + "smithy.api#documentation": "

A list containing information about IAM groups.

" } }, - "Policies": { - "target": "com.amazonaws.iam#ManagedPolicyDetailListType", + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", "traits": { - "smithy.api#documentation": "

A list containing information about managed policies.

" + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } }, - "GroupDetailList": { - "target": "com.amazonaws.iam#groupDetailListType", + "RoleDetailList": { + "target": "com.amazonaws.iam#roleDetailListType", "traits": { - "smithy.api#documentation": "

A list containing information about IAM groups.

" + "smithy.api#documentation": "

A list containing information about IAM roles.

" } } }, @@ -3822,18 +3822,18 @@ "com.amazonaws.iam#GetContextKeysForPrincipalPolicyRequest": { "type": "structure", "members": { + "PolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

An optional list of additional policies for which you want the list of context keys that\n are referenced.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " + } + }, "PolicySourceArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "

The ARN of a user, group, or role whose policies contain the context keys that you want\n listed. If you specify a user, the list includes context keys that are found in all\n policies that are attached to the user. The list also includes all groups that the user is\n a member of. If you pick a group or a role, then it includes only those context keys that\n are found in policies attached to that entity. Note that all parameters are shown in\n unencoded form here for clarity, but must be URL encoded to be included as a part of a real\n HTML request.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } - }, - "PolicyInputList": { - "target": "com.amazonaws.iam#SimulationPolicyListType", - "traits": { - "smithy.api#documentation": "

An optional list of additional policies for which you want the list of context keys that\n are referenced.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " - } } } }, @@ -3869,17 +3869,17 @@ "smithy.api#documentation": "

Contains the credential report. The report is Base64-encoded.

" } }, - "ReportFormat": { - "target": "com.amazonaws.iam#ReportFormatType", - "traits": { - "smithy.api#documentation": "

The format (MIME type) of the credential report.

" - } - }, "GeneratedTime": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "

The date and time when the credential report was created, in ISO 8601 date-time format.

" } + }, + "ReportFormat": { + "target": "com.amazonaws.iam#ReportFormatType", + "traits": { + "smithy.api#documentation": "

The format (MIME type) of the credential report.

" + } } }, "traits": { @@ -3935,17 +3935,17 @@ "com.amazonaws.iam#GetGroupPolicyRequest": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The name of the policy document to get.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the group the policy is associated with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The name of the group the policy is associated with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the policy document to get.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -3954,10 +3954,10 @@ "com.amazonaws.iam#GetGroupPolicyResponse": { "type": "structure", "members": { - "PolicyDocument": { - "target": "com.amazonaws.iam#policyDocumentType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The policy document.

\n

IAM stores policies in JSON format. However, resources that were created using AWS\n CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a\n YAML policy to JSON format before submitting it to IAM.

", + "smithy.api#documentation": "

The group the policy is associated with.

", "smithy.api#required": {} } }, @@ -3968,10 +3968,10 @@ "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

The group the policy is associated with.

", + "smithy.api#documentation": "

The policy document.

\n

IAM stores policies in JSON format. However, resources that were created using AWS\n CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a\n YAML policy to JSON format before submitting it to IAM.

", "smithy.api#required": {} } } @@ -3983,12 +3983,6 @@ "com.amazonaws.iam#GetGroupRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { @@ -4001,6 +3995,12 @@ "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } } } }, @@ -4014,6 +4014,12 @@ "smithy.api#required": {} } }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, "Marker": { "target": "com.amazonaws.iam#responseMarkerType", "traits": { @@ -4026,12 +4032,6 @@ "smithy.api#documentation": "

A list of users in the group.

", "smithy.api#required": {} } - }, - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } } }, "traits": { @@ -4170,16 +4170,10 @@ "com.amazonaws.iam#GetOpenIDConnectProviderResponse": { "type": "structure", "members": { - "ThumbprintList": { - "target": "com.amazonaws.iam#thumbprintListType", - "traits": { - "smithy.api#documentation": "

A list of certificate thumbprints that are associated with the specified IAM OIDC\n provider resource object. For more information, see CreateOpenIDConnectProvider.

" - } - }, - "Url": { - "target": "com.amazonaws.iam#OpenIDConnectProviderUrlType", + "ClientIDList": { + "target": "com.amazonaws.iam#clientIDListType", "traits": { - "smithy.api#documentation": "

The URL that the IAM OIDC provider resource object is associated with. For more\n information, see CreateOpenIDConnectProvider.

" + "smithy.api#documentation": "

A list of client IDs (also known as audiences) that are associated with the specified\n IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" } }, "CreateDate": { @@ -4188,10 +4182,16 @@ "smithy.api#documentation": "

The date and time when the IAM OIDC provider resource object was created in the AWS\n account.

" } }, - "ClientIDList": { - "target": "com.amazonaws.iam#clientIDListType", + "Url": { + "target": "com.amazonaws.iam#OpenIDConnectProviderUrlType", "traits": { - "smithy.api#documentation": "

A list of client IDs (also known as audiences) that are associated with the specified\n IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" + "smithy.api#documentation": "

The URL that the IAM OIDC provider resource object is associated with. For more\n information, see CreateOpenIDConnectProvider.

" + } + }, + "ThumbprintList": { + "target": "com.amazonaws.iam#thumbprintListType", + "traits": { + "smithy.api#documentation": "

A list of certificate thumbprints that are associated with the specified IAM OIDC\n provider resource object. For more information, see CreateOpenIDConnectProvider.

" } } }, @@ -4219,18 +4219,18 @@ "com.amazonaws.iam#GetOrganizationsAccessReportRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, "SortKey": { "target": "com.amazonaws.iam#sortKeyType", "traits": { "smithy.api#documentation": "

The key that is used to sort the results. If you choose the namespace key, the results\n are returned in alphabetical order. If you choose the time key, the results are sorted\n numerically by the date and time.

" } }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, "JobId": { "target": "com.amazonaws.iam#jobIDType", "traits": { @@ -4238,10 +4238,10 @@ "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } } } @@ -4249,25 +4249,14 @@ "com.amazonaws.iam#GetOrganizationsAccessReportResponse": { "type": "structure", "members": { - "JobCreationDate": { - "target": "com.amazonaws.iam#dateType", - "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", - "smithy.api#required": {} - } - }, - "JobStatus": { - "target": "com.amazonaws.iam#jobStatusType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

The status of the job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } }, - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } + "ErrorDetails": { + "target": "com.amazonaws.iam#ErrorDetails" }, "NumberOfServicesAccessible": { "target": "com.amazonaws.iam#integerType", @@ -4275,31 +4264,42 @@ "smithy.api#documentation": "

The number of services that the applicable SCPs allow account principals to\n access.

" } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", + "JobCompletionDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.

\n

This field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS.

" } }, - "ErrorDetails": { - "target": "com.amazonaws.iam#ErrorDetails" - }, "NumberOfServicesNotAccessed": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "

The number of services that account principals are allowed but did not attempt to\n access.

" } }, - "JobCompletionDate": { + "AccessDetails": { + "target": "com.amazonaws.iam#AccessDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the most recent attempt to access the\n service.

" + } + }, + "JobCreationDate": { "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.

\n

This field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", + "smithy.api#required": {} } }, - "AccessDetails": { - "target": "com.amazonaws.iam#AccessDetails", + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

An object that contains details about the most recent attempt to access the\n service.

" + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.iam#jobStatusType", + "traits": { + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} } } } @@ -4379,17 +4379,17 @@ "com.amazonaws.iam#GetPolicyVersionRequest": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.iam#policyVersionIdType", + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

Identifies the policy version to retrieve.

\n

This parameter allows (through its regex pattern) a string of characters that \n consists of the lowercase letter 'v' followed by one or two digits, and optionally \n followed by a period '.' and a string of letters and digits.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the managed policy that you want information\n about.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } }, - "PolicyArn": { - "target": "com.amazonaws.iam#arnType", + "VersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the managed policy that you want information\n about.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#documentation": "

Identifies the policy version to retrieve.

\n

This parameter allows (through its regex pattern) a string of characters that \n consists of the lowercase letter 'v' followed by one or two digits, and optionally \n followed by a period '.' and a string of letters and digits.

", "smithy.api#required": {} } } @@ -4452,17 +4452,17 @@ "com.amazonaws.iam#GetRolePolicyRequest": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The name of the policy document to get.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the role associated with the policy.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The name of the role associated with the policy.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the policy document to get.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -4471,24 +4471,24 @@ "com.amazonaws.iam#GetRolePolicyResponse": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#documentation": "

The role the policy is associated with.

", "smithy.api#required": {} } }, - "PolicyDocument": { - "target": "com.amazonaws.iam#policyDocumentType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The policy document.

\n

IAM stores policies in JSON format. However, resources that were created using AWS\n CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a\n YAML policy to JSON format before submitting it to IAM.

", + "smithy.api#documentation": "

The name of the policy.

", "smithy.api#required": {} } }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

The role the policy is associated with.

", + "smithy.api#documentation": "

The policy document.

\n

IAM stores policies in JSON format. However, resources that were created using AWS\n CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a\n YAML policy to JSON format before submitting it to IAM.

", "smithy.api#required": {} } } @@ -4568,17 +4568,17 @@ "smithy.api#documentation": "

The expiration date and time for the SAML provider.

" } }, - "SAMLMetadataDocument": { - "target": "com.amazonaws.iam#SAMLMetadataDocumentType", - "traits": { - "smithy.api#documentation": "

The XML metadata document that includes information about an identity provider.

" - } - }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "

The date and time when the SAML provider was created.

" } + }, + "SAMLMetadataDocument": { + "target": "com.amazonaws.iam#SAMLMetadataDocumentType", + "traits": { + "smithy.api#documentation": "

The XML metadata document that includes information about an identity provider.

" + } } }, "traits": { @@ -4608,17 +4608,17 @@ "com.amazonaws.iam#GetSSHPublicKeyRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", "traits": { - "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", "smithy.api#required": {} } }, - "SSHPublicKeyId": { - "target": "com.amazonaws.iam#publicKeyIdType", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, @@ -4715,6 +4715,12 @@ "com.amazonaws.iam#GetServiceLastAccessedDetailsRequest": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, "JobId": { "target": "com.amazonaws.iam#jobIDType", "traits": { @@ -4727,37 +4733,23 @@ "traits": { "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } - }, - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } } } }, "com.amazonaws.iam#GetServiceLastAccessedDetailsResponse": { "type": "structure", "members": { - "JobCreationDate": { + "JobCompletionDate": { "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", - "smithy.api#required": {} - } - }, - "ServicesLastAccessed": { - "target": "com.amazonaws.iam#ServicesLastAccessed", - "traits": { - "smithy.api#documentation": "

A ServiceLastAccessed object that contains details about the most recent\n attempt to access the service.

", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.

\n

This field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS.

", "smithy.api#required": {} } }, - "JobStatus": { - "target": "com.amazonaws.iam#jobStatusType", + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", "traits": { - "smithy.api#documentation": "

The status of the job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } }, "IsTruncated": { @@ -4766,29 +4758,37 @@ "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" } }, - "JobType": { - "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", + "Error": { + "target": "com.amazonaws.iam#ErrorDetails", "traits": { - "smithy.api#documentation": "

The type of job. Service jobs return information about when each service was last\n accessed. Action jobs also include information about when tracked actions within the\n service were last accessed.

" + "smithy.api#documentation": "

An object that contains details about the reason the operation failed.

" } }, - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", + "JobCreationDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", + "smithy.api#required": {} } }, - "JobCompletionDate": { - "target": "com.amazonaws.iam#dateType", + "ServicesLastAccessed": { + "target": "com.amazonaws.iam#ServicesLastAccessed", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.

\n

This field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS.

", + "smithy.api#documentation": "

A ServiceLastAccessed object that contains details about the most recent\n attempt to access the service.

", "smithy.api#required": {} } }, - "Error": { - "target": "com.amazonaws.iam#ErrorDetails", + "JobStatus": { + "target": "com.amazonaws.iam#jobStatusType", "traits": { - "smithy.api#documentation": "

An object that contains details about the reason the operation failed.

" + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", + "traits": { + "smithy.api#documentation": "

The type of job. Service jobs return information about when each service was last\n accessed. Action jobs also include information about when tracked actions within the\n service were last accessed.

" } } } @@ -4816,11 +4816,10 @@ "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.iam#jobIDType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

The ID of the request generated by the GenerateServiceLastAccessedDetails\n operation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, "ServiceNamespace": { @@ -4836,10 +4835,11 @@ "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", + "JobId": { + "target": "com.amazonaws.iam#jobIDType", "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + "smithy.api#documentation": "

The ID of the request generated by the GenerateServiceLastAccessedDetails\n operation.

", + "smithy.api#required": {} } } } @@ -4847,6 +4847,26 @@ "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesResponse": { "type": "structure", "members": { + "EntityDetailsList": { + "target": "com.amazonaws.iam#entityDetailsListType", + "traits": { + "smithy.api#documentation": "

An EntityDetailsList object that contains details about when an IAM\n entity (user or role) used group or policy permissions in an attempt to access the\n specified AWS service.

", + "smithy.api#required": {} + } + }, + "JobStatus": { + "target": "com.amazonaws.iam#jobStatusType", + "traits": { + "smithy.api#documentation": "

The status of the job.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -4866,32 +4886,12 @@ "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", - "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" - } - }, "JobCreationDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the report job was created.

", "smithy.api#required": {} } - }, - "JobStatus": { - "target": "com.amazonaws.iam#jobStatusType", - "traits": { - "smithy.api#documentation": "

The status of the job.

", - "smithy.api#required": {} - } - }, - "EntityDetailsList": { - "target": "com.amazonaws.iam#entityDetailsListType", - "traits": { - "smithy.api#documentation": "

An EntityDetailsList object that contains details about when an IAM\n entity (user or role) used group or policy permissions in an attempt to access the\n specified AWS service.

", - "smithy.api#required": {} - } } } }, @@ -5065,38 +5065,38 @@ "com.amazonaws.iam#Group": { "type": "structure", "members": { - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "Arn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the group was created.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs\n and how to use them in policies, see IAM Identifiers in the\n IAM User Guide.

", "smithy.api#required": {} } }, - "GroupId": { - "target": "com.amazonaws.iam#idType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The stable and unique string identifying the group. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

", + "smithy.api#documentation": "

The friendly name that identifies the group.

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "Path": { + "target": "com.amazonaws.iam#pathType", "traits": { - "smithy.api#documentation": "

The friendly name that identifies the group.

", + "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.iam#arnType", + "GroupId": { + "target": "com.amazonaws.iam#idType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs\n and how to use them in policies, see IAM Identifiers in the\n IAM User Guide.

", + "smithy.api#documentation": "

The stable and unique string identifying the group. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

", "smithy.api#required": {} } }, - "Path": { - "target": "com.amazonaws.iam#pathType", + "CreateDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the group was created.

", "smithy.api#required": {} } } @@ -5108,25 +5108,31 @@ "com.amazonaws.iam#GroupDetail": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.iam#arnType" + "GroupId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the group. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

" + } }, - "GroupPolicyList": { - "target": "com.amazonaws.iam#policyDetailListType", + "CreateDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

A list of the inline policies embedded in the group.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the group was created.

" } }, + "Arn": { + "target": "com.amazonaws.iam#arnType" + }, "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "

The path to the group. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

" } }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the group was created.

" + "smithy.api#documentation": "

The friendly name that identifies the group.

" } }, "AttachedManagedPolicies": { @@ -5135,16 +5141,10 @@ "smithy.api#documentation": "

A list of the managed policies attached to the group.

" } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", - "traits": { - "smithy.api#documentation": "

The friendly name that identifies the group.

" - } - }, - "GroupId": { - "target": "com.amazonaws.iam#idType", + "GroupPolicyList": { + "target": "com.amazonaws.iam#policyDetailListType", "traits": { - "smithy.api#documentation": "

The stable and unique string identifying the group. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

" + "smithy.api#documentation": "

A list of the inline policies embedded in the group.

" } } }, @@ -5162,6 +5162,13 @@ "smithy.api#required": {} } }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date when the instance profile was created.

", + "smithy.api#required": {} + } + }, "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { @@ -5169,10 +5176,10 @@ "smithy.api#required": {} } }, - "Path": { - "target": "com.amazonaws.iam#pathType", + "Roles": { + "target": "com.amazonaws.iam#roleListType", "traits": { - "smithy.api#documentation": "

The path to the instance profile. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

", + "smithy.api#documentation": "

The role associated with the instance profile.

", "smithy.api#required": {} } }, @@ -5183,17 +5190,10 @@ "smithy.api#required": {} } }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", - "traits": { - "smithy.api#documentation": "

The date when the instance profile was created.

", - "smithy.api#required": {} - } - }, - "Roles": { - "target": "com.amazonaws.iam#roleListType", + "Path": { + "target": "com.amazonaws.iam#pathType", "traits": { - "smithy.api#documentation": "

The role associated with the instance profile.

", + "smithy.api#documentation": "

The path to the instance profile. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

", "smithy.api#required": {} } } @@ -5325,12 +5325,6 @@ "com.amazonaws.iam#ListAccessKeysRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { @@ -5342,25 +5336,31 @@ "traits": { "smithy.api#documentation": "

The name of the user.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } } } }, "com.amazonaws.iam#ListAccessKeysResponse": { "type": "structure", "members": { - "AccessKeyMetadata": { - "target": "com.amazonaws.iam#accessKeyMetadataListType", - "traits": { - "smithy.api#documentation": "

A list of objects containing metadata about the access keys.

", - "smithy.api#required": {} - } - }, "Marker": { "target": "com.amazonaws.iam#responseMarkerType", "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } }, + "AccessKeyMetadata": { + "target": "com.amazonaws.iam#accessKeyMetadataListType", + "traits": { + "smithy.api#documentation": "

A list of objects containing metadata about the access keys.

", + "smithy.api#required": {} + } + }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -5398,29 +5398,23 @@ "com.amazonaws.iam#ListAccountAliasesRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } } } }, "com.amazonaws.iam#ListAccountAliasesResponse": { "type": "structure", "members": { - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } - }, "AccountAliases": { "target": "com.amazonaws.iam#accountAliasListType", "traits": { @@ -5428,6 +5422,12 @@ "smithy.api#required": {} } }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, "Marker": { "target": "com.amazonaws.iam#responseMarkerType", "traits": { @@ -5471,6 +5471,18 @@ "com.amazonaws.iam#ListAttachedGroupPoliciesRequest": { "type": "structure", "members": { + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { @@ -5483,30 +5495,12 @@ "traits": { "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } - }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } } } }, "com.amazonaws.iam#ListAttachedGroupPoliciesResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", - "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" - } - }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -5518,6 +5512,12 @@ "traits": { "smithy.api#documentation": "

A list of the attached policies.

" } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } } }, "traits": { @@ -5556,10 +5556,16 @@ "com.amazonaws.iam#ListAttachedRolePoliciesRequest": { "type": "structure", "members": { - "PathPrefix": { - "target": "com.amazonaws.iam#policyPathType", + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", "traits": { - "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, "RoleName": { @@ -5569,16 +5575,10 @@ "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", + "PathPrefix": { + "target": "com.amazonaws.iam#policyPathType", "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } } } @@ -5647,6 +5647,13 @@ "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name (friendly name, not ARN) of the user to list attached policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } + }, "PathPrefix": { "target": "com.amazonaws.iam#policyPathType", "traits": { @@ -5658,13 +5665,6 @@ "traits": { "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } - }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", - "traits": { - "smithy.api#documentation": "

The name (friendly name, not ARN) of the user to list attached policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "smithy.api#required": {} - } } } }, @@ -5725,16 +5725,16 @@ "com.amazonaws.iam#ListEntitiesForPolicyRequest": { "type": "structure", "members": { - "PathPrefix": { - "target": "com.amazonaws.iam#pathType", + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", "traits": { - "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all entities.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } }, - "PolicyUsageFilter": { - "target": "com.amazonaws.iam#PolicyUsageType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

The policy usage method to use for filtering the results.

\n

To list only permissions policies,\n set PolicyUsageFilter to PermissionsPolicy. To list only the\n policies used to set permissions boundaries, set the value\n to PermissionsBoundary.

\n

This parameter is optional. If it is not included, all policies are returned.

" + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, "EntityFilter": { @@ -5743,23 +5743,23 @@ "smithy.api#documentation": "

The entity type to use for filtering the results.

\n

For example, when EntityFilter is Role, only the roles that\n are attached to the specified policy are returned. This parameter is optional. If it is not\n included, all attached entities (users, groups, and roles) are returned. The argument for\n this parameter must be one of the valid values listed below.

" } }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy for which you want the\n versions.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", + "PathPrefix": { + "target": "com.amazonaws.iam#pathType", "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all entities.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } }, - "PolicyArn": { - "target": "com.amazonaws.iam#arnType", + "PolicyUsageFilter": { + "target": "com.amazonaws.iam#PolicyUsageType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy for which you want the\n versions.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The policy usage method to use for filtering the results.

\n

To list only permissions policies,\n set PolicyUsageFilter to PermissionsPolicy. To list only the\n policies used to set permissions boundaries, set the value\n to PermissionsBoundary.

\n

This parameter is optional. If it is not included, all policies are returned.

" } } } @@ -5767,6 +5767,12 @@ "com.amazonaws.iam#ListEntitiesForPolicyResponse": { "type": "structure", "members": { + "PolicyRoles": { + "target": "com.amazonaws.iam#PolicyRoleListType", + "traits": { + "smithy.api#documentation": "

A list of IAM roles that the policy is attached to.

" + } + }, "Marker": { "target": "com.amazonaws.iam#responseMarkerType", "traits": { @@ -5785,12 +5791,6 @@ "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" } }, - "PolicyRoles": { - "target": "com.amazonaws.iam#PolicyRoleListType", - "traits": { - "smithy.api#documentation": "

A list of IAM roles that the policy is attached to.

" - } - }, "PolicyGroups": { "target": "com.amazonaws.iam#PolicyGroupListType", "traits": { @@ -5831,12 +5831,6 @@ "com.amazonaws.iam#ListGroupPoliciesRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, "MaxItems": { "target": "com.amazonaws.iam#maxItemsType", "traits": { @@ -5849,12 +5843,24 @@ "smithy.api#documentation": "

The name of the group to list policies for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } } } }, "com.amazonaws.iam#ListGroupPoliciesResponse": { "type": "structure", "members": { + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, "PolicyNames": { "target": "com.amazonaws.iam#policyNameListType", "traits": { @@ -5867,12 +5873,6 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } - }, - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } } }, "traits": { @@ -5931,10 +5931,10 @@ "com.amazonaws.iam#ListGroupsForUserRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, "UserName": { @@ -5944,10 +5944,10 @@ "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } } } @@ -5955,6 +5955,12 @@ "com.amazonaws.iam#ListGroupsForUserResponse": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -5967,12 +5973,6 @@ "smithy.api#documentation": "

A list of groups.

", "smithy.api#required": {} } - }, - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", - "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" - } } }, "traits": { @@ -5982,12 +5982,6 @@ "com.amazonaws.iam#ListGroupsRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "PathPrefix": { "target": "com.amazonaws.iam#pathPrefixType", "traits": { @@ -5999,12 +5993,25 @@ "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } } } }, "com.amazonaws.iam#ListGroupsResponse": { "type": "structure", "members": { + "Groups": { + "target": "com.amazonaws.iam#groupListType", + "traits": { + "smithy.api#documentation": "

A list of groups.

", + "smithy.api#required": {} + } + }, "Marker": { "target": "com.amazonaws.iam#responseMarkerType", "traits": { @@ -6016,13 +6023,6 @@ "traits": { "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" } - }, - "Groups": { - "target": "com.amazonaws.iam#groupListType", - "traits": { - "smithy.api#documentation": "

A list of groups.

", - "smithy.api#required": {} - } } }, "traits": { @@ -6081,13 +6081,6 @@ "com.amazonaws.iam#ListInstanceProfilesForRoleRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", - "traits": { - "smithy.api#documentation": "

The name of the role to list instance profiles for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "smithy.api#required": {} - } - }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { @@ -6099,12 +6092,25 @@ "traits": { "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } + }, + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", + "traits": { + "smithy.api#documentation": "

The name of the role to list instance profiles for.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} + } } } }, "com.amazonaws.iam#ListInstanceProfilesForRoleResponse": { "type": "structure", "members": { + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, "InstanceProfiles": { "target": "com.amazonaws.iam#instanceProfileListType", "traits": { @@ -6117,12 +6123,6 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } - }, - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } } }, "traits": { @@ -6132,8 +6132,14 @@ "com.amazonaws.iam#ListInstanceProfilesRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#markerType", + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } @@ -6143,18 +6149,18 @@ "traits": { "smithy.api#documentation": "

The path prefix for filtering the results. For example, the prefix\n /application_abc/component_xyz/ gets all instance profiles whose path\n starts with /application_abc/component_xyz/.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } - }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } } } }, "com.amazonaws.iam#ListInstanceProfilesResponse": { "type": "structure", "members": { + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, "Marker": { "target": "com.amazonaws.iam#responseMarkerType", "traits": { @@ -6167,12 +6173,6 @@ "smithy.api#documentation": "

A list of instance profiles.

", "smithy.api#required": {} } - }, - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } } }, "traits": { @@ -6208,6 +6208,12 @@ "com.amazonaws.iam#ListMFADevicesRequest": { "type": "structure", "members": { + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { @@ -6219,18 +6225,18 @@ "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } - }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } } } }, "com.amazonaws.iam#ListMFADevicesResponse": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } + }, "MFADevices": { "target": "com.amazonaws.iam#mfaDeviceListType", "traits": { @@ -6238,12 +6244,6 @@ "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", - "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" - } - }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -6356,13 +6356,6 @@ "com.amazonaws.iam#ListPoliciesGrantingServiceAccessRequest": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.iam#arnType", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM identity (user, group, or role) whose policies you want to\n list.

", - "smithy.api#required": {} - } - }, "ServiceNamespaces": { "target": "com.amazonaws.iam#serviceNamespaceListType", "traits": { @@ -6375,6 +6368,13 @@ "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM identity (user, group, or role) whose policies you want to\n list.

", + "smithy.api#required": {} + } } } }, @@ -6405,40 +6405,40 @@ "com.amazonaws.iam#ListPoliciesRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, "PolicyUsageFilter": { "target": "com.amazonaws.iam#PolicyUsageType", "traits": { "smithy.api#documentation": "

The policy usage method to use for filtering the results.

\n

To list only permissions policies,\n set PolicyUsageFilter to PermissionsPolicy. To list only the\n policies used to set permissions boundaries, set the value\n to PermissionsBoundary.

\n

This parameter is optional. If it is not included, all policies are returned.

" } }, + "Scope": { + "target": "com.amazonaws.iam#policyScopeType", + "traits": { + "smithy.api#documentation": "

The scope to use for filtering the results.

\n

To list only AWS managed policies, set Scope to AWS. To list\n only the customer managed policies in your AWS account, set Scope to\n Local.

\n

This parameter is optional. If it is not included, or if it is set to All,\n all policies are returned.

" + } + }, "PathPrefix": { "target": "com.amazonaws.iam#policyPathType", "traits": { "smithy.api#documentation": "

The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, "OnlyAttached": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "

A flag to filter the results to only the attached policies.

\n

When OnlyAttached is true, the returned list contains only the\n policies that are attached to an IAM user, group, or role. When OnlyAttached\n is false, or when the parameter is not included, all policies are\n returned.

" } }, - "Scope": { - "target": "com.amazonaws.iam#policyScopeType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

The scope to use for filtering the results.

\n

To list only AWS managed policies, set Scope to AWS. To list\n only the customer managed policies in your AWS account, set Scope to\n Local.

\n

This parameter is optional. If it is not included, or if it is set to All,\n all policies are returned.

" + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } } } @@ -6446,12 +6446,6 @@ "com.amazonaws.iam#ListPoliciesResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", - "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" - } - }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -6463,6 +6457,12 @@ "traits": { "smithy.api#documentation": "

A list of policies.

" } + }, + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + } } }, "traits": { @@ -6501,12 +6501,6 @@ "com.amazonaws.iam#ListPolicyVersionsRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, "MaxItems": { "target": "com.amazonaws.iam#maxItemsType", "traits": { @@ -6519,18 +6513,18 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy for which you want the\n versions.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } } } }, "com.amazonaws.iam#ListPolicyVersionsResponse": { "type": "structure", "members": { - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } - }, "Versions": { "target": "com.amazonaws.iam#policyDocumentVersionListType", "traits": { @@ -6542,6 +6536,12 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } + }, + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } } }, "traits": { @@ -6577,12 +6577,6 @@ "com.amazonaws.iam#ListRolePoliciesRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { @@ -6595,6 +6589,12 @@ "traits": { "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } + }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } } } }, @@ -6648,11 +6648,10 @@ "com.amazonaws.iam#ListRoleTagsRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

The name of the IAM role for which you want to see the list of tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "smithy.api#required": {} + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, "MaxItems": { @@ -6661,10 +6660,11 @@ "smithy.api#documentation": "

(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + "smithy.api#documentation": "

The name of the IAM role for which you want to see the list of tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} } } } @@ -6672,6 +6672,13 @@ "com.amazonaws.iam#ListRoleTagsResponse": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.iam#tagListType", + "traits": { + "smithy.api#documentation": "

The list of tags currently that is attached to the role. Each tag consists of a key\n name and an associated value. If no tags are attached to the specified role, the response\n contains an empty list.

", + "smithy.api#required": {} + } + }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -6683,13 +6690,6 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } - }, - "Tags": { - "target": "com.amazonaws.iam#tagListType", - "traits": { - "smithy.api#documentation": "

The list of tags currently that is attached to the role. Each tag consists of a key\n name and an associated value. If no tags are attached to the specified role, the response\n contains an empty list.

", - "smithy.api#required": {} - } } } }, @@ -6719,18 +6719,18 @@ "com.amazonaws.iam#ListRolesRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "PathPrefix": { "target": "com.amazonaws.iam#pathPrefixType", "traits": { "smithy.api#documentation": "

The path prefix for filtering the results. For example, the prefix\n /application_abc/component_xyz/ gets all roles whose path starts with\n /application_abc/component_xyz/.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all roles. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { @@ -6742,10 +6742,11 @@ "com.amazonaws.iam#ListRolesResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", + "Roles": { + "target": "com.amazonaws.iam#roleListType", "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + "smithy.api#documentation": "

A list of roles.

", + "smithy.api#required": {} } }, "IsTruncated": { @@ -6754,11 +6755,10 @@ "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" } }, - "Roles": { - "target": "com.amazonaws.iam#roleListType", + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", "traits": { - "smithy.api#documentation": "

A list of roles.

", - "smithy.api#required": {} + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } } }, @@ -6827,12 +6827,6 @@ "com.amazonaws.iam#ListSSHPublicKeysRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { @@ -6844,6 +6838,12 @@ "traits": { "smithy.api#documentation": "

The name of the IAM user to list SSH public keys for. If none is specified, the\n UserName field is determined implicitly based on the AWS access key used\n to sign the request.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } } } }, @@ -6899,18 +6899,18 @@ "com.amazonaws.iam#ListServerCertificatesRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, "PathPrefix": { "target": "com.amazonaws.iam#pathPrefixType", "traits": { "smithy.api#documentation": "

The path prefix for filtering the results. For example:\n /company/servercerts would get all server certificates for which the path\n starts with /company/servercerts.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all server certificates. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } }, + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, "MaxItems": { "target": "com.amazonaws.iam#maxItemsType", "traits": { @@ -6922,13 +6922,6 @@ "com.amazonaws.iam#ListServerCertificatesResponse": { "type": "structure", "members": { - "ServerCertificateMetadataList": { - "target": "com.amazonaws.iam#serverCertificateMetadataListType", - "traits": { - "smithy.api#documentation": "

A list of server certificates.

", - "smithy.api#required": {} - } - }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -6940,6 +6933,13 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } + }, + "ServerCertificateMetadataList": { + "target": "com.amazonaws.iam#serverCertificateMetadataListType", + "traits": { + "smithy.api#documentation": "

A list of server certificates.

", + "smithy.api#required": {} + } } }, "traits": { @@ -6969,17 +6969,17 @@ "com.amazonaws.iam#ListServiceSpecificCredentialsRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#userNameType", - "traits": { - "smithy.api#documentation": "

The name of the user whose service-specific credentials you want information about. If\n this value is not specified, then the operation assumes the user whose credentials are used\n to call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, "ServiceName": { "target": "com.amazonaws.iam#serviceName", "traits": { "smithy.api#documentation": "

Filters the returned results to only those for the specified AWS service. If not\n specified, then AWS returns service-specific credentials for all services.

" } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user whose service-specific credentials you want information about. If\n this value is not specified, then the operation assumes the user whose credentials are used\n to call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } } } }, @@ -7029,21 +7029,21 @@ "smithy.api#documentation": "

The name of the IAM user whose signing certificates you want to examine.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" } }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } - } - } - }, - "com.amazonaws.iam#ListSigningCertificatesResponse": { + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } + } + } + }, + "com.amazonaws.iam#ListSigningCertificatesResponse": { "type": "structure", "members": { "Marker": { @@ -7099,6 +7099,12 @@ "com.amazonaws.iam#ListUserPoliciesRequest": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.iam#markerType", + "traits": { + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + } + }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { @@ -7111,25 +7117,12 @@ "traits": { "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } - }, - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } } } }, "com.amazonaws.iam#ListUserPoliciesResponse": { "type": "structure", "members": { - "PolicyNames": { - "target": "com.amazonaws.iam#policyNameListType", - "traits": { - "smithy.api#documentation": "

A list of policy names.

", - "smithy.api#required": {} - } - }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -7141,6 +7134,13 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } + }, + "PolicyNames": { + "target": "com.amazonaws.iam#policyNameListType", + "traits": { + "smithy.api#documentation": "

A list of policy names.

", + "smithy.api#required": {} + } } }, "traits": { @@ -7170,12 +7170,6 @@ "com.amazonaws.iam#ListUserTagsRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { @@ -7188,17 +7182,22 @@ "traits": { "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } } } }, "com.amazonaws.iam#ListUserTagsResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.iam#tagListType", + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", "traits": { - "smithy.api#documentation": "

The list of tags that are currently attached to the user. Each tag consists of a key\n name and an associated value. If no tags are attached to the specified user, the response\n contains an empty list.

", - "smithy.api#required": {} + "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } }, "IsTruncated": { @@ -7207,10 +7206,11 @@ "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems number of results even when more results are available. Check IsTruncated after every call to ensure that you receive all of your \n results.

" } }, - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", + "Tags": { + "target": "com.amazonaws.iam#tagListType", "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" + "smithy.api#documentation": "

The list of tags that are currently attached to the user. Each tag consists of a key\n name and an associated value. If no tags are attached to the specified user, the response\n contains an empty list.

", + "smithy.api#required": {} } } } @@ -7241,12 +7241,6 @@ "com.amazonaws.iam#ListUsersRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", - "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" - } - }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { @@ -7258,12 +7252,24 @@ "traits": { "smithy.api#documentation": "

The path prefix for filtering the results. For example:\n /division_abc/subdivision_xyz/, which would get all user names whose path\n starts with /division_abc/subdivision_xyz/.

\n

This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all user names. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } + }, + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", + "traits": { + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + } } } }, "com.amazonaws.iam#ListUsersResponse": { "type": "structure", "members": { + "IsTruncated": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" + } + }, "Users": { "target": "com.amazonaws.iam#userListType", "traits": { @@ -7276,12 +7282,6 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } - }, - "IsTruncated": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems number of results even when there are more results available. We recommend \n that you check IsTruncated after every call to ensure that you receive all your \n results.

" - } } }, "traits": { @@ -7309,10 +7309,10 @@ "com.amazonaws.iam#ListVirtualMFADevicesRequest": { "type": "structure", "members": { - "AssignmentStatus": { - "target": "com.amazonaws.iam#assignmentStatusType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

The status (Unassigned or Assigned) of the devices to list.\n If you do not specify an AssignmentStatus, the operation defaults to\n Any, which lists both assigned and unassigned virtual MFA devices.,

" + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, "MaxItems": { @@ -7321,10 +7321,10 @@ "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", + "AssignmentStatus": { + "target": "com.amazonaws.iam#assignmentStatusType", "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" + "smithy.api#documentation": "

The status (Unassigned or Assigned) of the devices to list.\n If you do not specify an AssignmentStatus, the operation defaults to\n Any, which lists both assigned and unassigned virtual MFA devices.,

" } } } @@ -7332,6 +7332,12 @@ "com.amazonaws.iam#ListVirtualMFADevicesResponse": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.iam#responseMarkerType", + "traits": { + "smithy.api#documentation": "

When IsTruncated is true, this element is present and contains\n the value to use for the Marker parameter in a subsequent pagination\n request.

" + } + }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -7344,12 +7350,6 @@ "smithy.api#documentation": "

The list of virtual MFA devices in the current account that match the\n AssignmentStatus value that was passed in the request.

", "smithy.api#required": {} } - }, - "Marker": { - "target": "com.amazonaws.iam#responseMarkerType", - "traits": { - "smithy.api#documentation": "

When IsTruncated is true, this element is present and contains\n the value to use for the Marker parameter in a subsequent pagination\n request.

" - } } }, "traits": { @@ -7366,18 +7366,18 @@ "smithy.api#required": {} } }, - "PasswordResetRequired": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

Specifies whether the user is required to set a new password on next sign-in.

" - } - }, "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "

The name of the user, which can be used for signing in to the AWS Management\n Console.

", "smithy.api#required": {} } + }, + "PasswordResetRequired": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

Specifies whether the user is required to set a new password on next sign-in.

" + } } }, "traits": { @@ -7394,17 +7394,17 @@ "smithy.api#required": {} } }, - "SerialNumber": { - "target": "com.amazonaws.iam#serialNumberType", + "EnableDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n serial number is the device ARN.

", + "smithy.api#documentation": "

The date when the MFA device was enabled for the user.

", "smithy.api#required": {} } }, - "EnableDate": { - "target": "com.amazonaws.iam#dateType", + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", "traits": { - "smithy.api#documentation": "

The date when the MFA device was enabled for the user.

", + "smithy.api#documentation": "

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n serial number is the device ARN.

", "smithy.api#required": {} } } @@ -7442,30 +7442,6 @@ "com.amazonaws.iam#ManagedPolicyDetail": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", - "traits": { - "smithy.api#documentation": "

The friendly name (not ARN) identifying the policy.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", - "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was created.

" - } - }, - "IsAttachable": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

Specifies whether the policy can be attached to an IAM user, group, or role.

" - } - }, - "Path": { - "target": "com.amazonaws.iam#policyPathType", - "traits": { - "smithy.api#documentation": "

The path to the policy.

\n

For more information about paths, see IAM Identifiers in the\n IAM User Guide.

" - } - }, "Description": { "target": "com.amazonaws.iam#policyDescriptionType", "traits": { @@ -7487,12 +7463,6 @@ "Arn": { "target": "com.amazonaws.iam#arnType" }, - "DefaultVersionId": { - "target": "com.amazonaws.iam#policyVersionIdType", - "traits": { - "smithy.api#documentation": "

The identifier for the version of the policy that is set as the default (operative)\n version.

\n

For more information about policy versions, see Versioning for Managed\n Policies in the IAM User Guide.

" - } - }, "UpdateDate": { "target": "com.amazonaws.iam#dateType", "traits": { @@ -7505,11 +7475,41 @@ "smithy.api#documentation": "

The stable and unique string identifying the policy.

\n

For more information about IDs, see IAM Identifiers in the\n IAM User Guide.

" } }, + "IsAttachable": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy can be attached to an IAM user, group, or role.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was created.

" + } + }, "AttachmentCount": { "target": "com.amazonaws.iam#attachmentCountType", "traits": { "smithy.api#documentation": "

The number of principal entities (users, groups, and roles) that the policy is attached\n to.

" } + }, + "DefaultVersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", + "traits": { + "smithy.api#documentation": "

The identifier for the version of the policy that is set as the default (operative)\n version.

\n

For more information about policy versions, see Versioning for Managed\n Policies in the IAM User Guide.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The friendly name (not ARN) identifying the policy.

" + } + }, + "Path": { + "target": "com.amazonaws.iam#policyPathType", + "traits": { + "smithy.api#documentation": "

The path to the policy.

\n

For more information about paths, see IAM Identifiers in the\n IAM User Guide.

" + } } }, "traits": { @@ -7582,34 +7582,40 @@ "com.amazonaws.iam#PasswordPolicy": { "type": "structure", "members": { - "RequireLowercaseCharacters": { + "RequireSymbols": { "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

Specifies whether to require lowercase characters for IAM user passwords.

" + "smithy.api#documentation": "

Specifies whether to require symbols for IAM user passwords.

" } }, - "MinimumPasswordLength": { - "target": "com.amazonaws.iam#minimumPasswordLengthType", + "PasswordReusePrevention": { + "target": "com.amazonaws.iam#passwordReusePreventionType", "traits": { - "smithy.api#documentation": "

Minimum length to require for IAM user passwords.

" + "smithy.api#documentation": "

Specifies the number of previous passwords that IAM users are prevented from\n reusing.

" } }, - "RequireNumbers": { + "AllowUsersToChangePassword": { "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

Specifies whether to require numbers for IAM user passwords.

" + "smithy.api#documentation": "

Specifies whether IAM users are allowed to change their own password.

" } }, - "ExpirePasswords": { + "MinimumPasswordLength": { + "target": "com.amazonaws.iam#minimumPasswordLengthType", + "traits": { + "smithy.api#documentation": "

Minimum length to require for IAM user passwords.

" + } + }, + "RequireLowercaseCharacters": { "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

Indicates whether passwords in the account expire. Returns true if\n MaxPasswordAge contains a value greater than 0. Returns false if\n MaxPasswordAge is 0 or not present.

" + "smithy.api#documentation": "

Specifies whether to require lowercase characters for IAM user passwords.

" } }, - "PasswordReusePrevention": { - "target": "com.amazonaws.iam#passwordReusePreventionType", + "RequireNumbers": { + "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

Specifies the number of previous passwords that IAM users are prevented from\n reusing.

" + "smithy.api#documentation": "

Specifies whether to require numbers for IAM user passwords.

" } }, "HardExpiry": { @@ -7618,28 +7624,22 @@ "smithy.api#documentation": "

Specifies whether IAM users are prevented from setting a new password after their\n password has expired.

" } }, - "MaxPasswordAge": { - "target": "com.amazonaws.iam#maxPasswordAgeType", - "traits": { - "smithy.api#documentation": "

The number of days that an IAM user password is valid.

" - } - }, "RequireUppercaseCharacters": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "

Specifies whether to require uppercase characters for IAM user passwords.

" } }, - "AllowUsersToChangePassword": { - "target": "com.amazonaws.iam#booleanType", + "MaxPasswordAge": { + "target": "com.amazonaws.iam#maxPasswordAgeType", "traits": { - "smithy.api#documentation": "

Specifies whether IAM users are allowed to change their own password.

" + "smithy.api#documentation": "

The number of days that an IAM user password is valid.

" } }, - "RequireSymbols": { + "ExpirePasswords": { "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

Specifies whether to require symbols for IAM user passwords.

" + "smithy.api#documentation": "

Indicates whether passwords in the account expire. Returns true if\n MaxPasswordAge contains a value greater than 0. Returns false if\n MaxPasswordAge is 0 or not present.

" } } }, @@ -7688,19 +7688,10 @@ "com.amazonaws.iam#Policy": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.iam#arnType" - }, - "PolicyId": { - "target": "com.amazonaws.iam#idType", - "traits": { - "smithy.api#documentation": "

The stable and unique string identifying the policy.

\n

For more information about IDs, see IAM Identifiers in the\n IAM User Guide.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "DefaultVersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was created.

" + "smithy.api#documentation": "

The identifier for the version of the policy that is set as the default version.

" } }, "AttachmentCount": { @@ -7709,12 +7700,6 @@ "smithy.api#documentation": "

The number of entities (users, groups, and roles) that the policy is attached to.

" } }, - "IsAttachable": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

Specifies whether the policy can be attached to an IAM user, group, or role.

" - } - }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { @@ -7727,10 +7712,10 @@ "smithy.api#documentation": "

The path to the policy.

\n

For more information about paths, see IAM Identifiers in the\n IAM User Guide.

" } }, - "DefaultVersionId": { - "target": "com.amazonaws.iam#policyVersionIdType", + "PermissionsBoundaryUsageCount": { + "target": "com.amazonaws.iam#attachmentCountType", "traits": { - "smithy.api#documentation": "

The identifier for the version of the policy that is set as the default version.

" + "smithy.api#documentation": "

The number of entities (users and roles) for which the policy is used to set the\n permissions boundary.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" } }, "UpdateDate": { @@ -7745,10 +7730,25 @@ "smithy.api#documentation": "

A friendly description of the policy.

\n

This element is included in the response to the GetPolicy operation.\n It is not included in the response to the ListPolicies operation.

" } }, - "PermissionsBoundaryUsageCount": { - "target": "com.amazonaws.iam#attachmentCountType", + "Arn": { + "target": "com.amazonaws.iam#arnType" + }, + "IsAttachable": { + "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

The number of entities (users and roles) for which the policy is used to set the\n permissions boundary.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" + "smithy.api#documentation": "

Specifies whether the policy can be attached to an IAM user, group, or role.

" + } + }, + "PolicyId": { + "target": "com.amazonaws.iam#idType", + "traits": { + "smithy.api#documentation": "

The stable and unique string identifying the policy.

\n

For more information about IDs, see IAM Identifiers in the\n IAM User Guide.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the policy was created.

" } } }, @@ -7811,6 +7811,9 @@ "com.amazonaws.iam#PolicyGrantingServiceAccess": { "type": "structure", "members": { + "PolicyArn": { + "target": "com.amazonaws.iam#arnType" + }, "PolicyType": { "target": "com.amazonaws.iam#policyType", "traits": { @@ -7818,21 +7821,18 @@ "smithy.api#required": {} } }, - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", - "traits": { - "smithy.api#documentation": "

The policy name.

", - "smithy.api#required": {} - } - }, "EntityName": { "target": "com.amazonaws.iam#entityNameType", "traits": { "smithy.api#documentation": "

The name of the entity (user or role) to which the inline policy is attached.

\n

This field is null for managed policies. For more information about these policy types,\n see Managed Policies and Inline Policies in the\n IAM User Guide.

" } }, - "PolicyArn": { - "target": "com.amazonaws.iam#arnType" + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", + "traits": { + "smithy.api#documentation": "

The policy name.

", + "smithy.api#required": {} + } }, "EntityType": { "target": "com.amazonaws.iam#policyOwnerEntityType", @@ -7991,12 +7991,6 @@ "com.amazonaws.iam#PolicyVersion": { "type": "structure", "members": { - "IsDefaultVersion": { - "target": "com.amazonaws.iam#booleanType", - "traits": { - "smithy.api#documentation": "

Specifies whether the policy version is set as the policy's default version.

" - } - }, "Document": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { @@ -8014,6 +8008,12 @@ "traits": { "smithy.api#documentation": "

The identifier for the policy version.

\n

Policy version identifiers always begin with v (always lowercase). When a\n policy is created, the first policy version is v1.

" } + }, + "IsDefaultVersion": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

Specifies whether the policy version is set as the policy's default version.

" + } } }, "traits": { @@ -8073,17 +8073,17 @@ "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

The name of the group to associate the policy with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-.

", + "smithy.api#documentation": "

The policy document.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", "smithy.api#required": {} } }, - "PolicyDocument": { - "target": "com.amazonaws.iam#policyDocumentType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The policy document.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", + "smithy.api#documentation": "

The name of the group to associate the policy with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-.

", "smithy.api#required": {} } } @@ -8118,17 +8118,17 @@ "com.amazonaws.iam#PutRolePermissionsBoundaryRequest": { "type": "structure", "members": { - "PermissionsBoundary": { - "target": "com.amazonaws.iam#arnType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The ARN of the policy that is used to set the permissions boundary for the role.

", + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM role for which you want to set the\n permissions boundary.

", "smithy.api#required": {} } }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "PermissionsBoundary": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM role for which you want to set the\n permissions boundary.

", + "smithy.api#documentation": "

The ARN of the policy that is used to set the permissions boundary for the role.

", "smithy.api#required": {} } } @@ -8163,17 +8163,17 @@ "com.amazonaws.iam#PutRolePolicyRequest": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The name of the policy document.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the role to associate the policy with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The name of the role to associate the policy with.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the policy document.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, @@ -8212,17 +8212,17 @@ "com.amazonaws.iam#PutUserPermissionsBoundaryRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "PermissionsBoundary": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM user for which you want to set the\n permissions boundary.

", + "smithy.api#documentation": "

The ARN of the policy that is used to set the permissions boundary for the user.

", "smithy.api#required": {} } }, - "PermissionsBoundary": { - "target": "com.amazonaws.iam#arnType", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The ARN of the policy that is used to set the permissions boundary for the user.

", + "smithy.api#documentation": "

The name (friendly name, not ARN) of the IAM user for which you want to set the\n permissions boundary.

", "smithy.api#required": {} } } @@ -8261,17 +8261,17 @@ "smithy.api#required": {} } }, - "PolicyName": { - "target": "com.amazonaws.iam#policyNameType", + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

The name of the policy document.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The policy document.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", "smithy.api#required": {} } }, - "PolicyDocument": { - "target": "com.amazonaws.iam#policyDocumentType", + "PolicyName": { + "target": "com.amazonaws.iam#policyNameType", "traits": { - "smithy.api#documentation": "

The policy document.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", + "smithy.api#documentation": "

The name of the policy document.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -8318,17 +8318,17 @@ "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProviderRequest": { "type": "structure", "members": { - "ClientID": { - "target": "com.amazonaws.iam#clientIDType", + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The client ID (also known as audience) to remove from the IAM OIDC provider resource.\n For more information about client IDs, see CreateOpenIDConnectProvider.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client\n ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } }, - "OpenIDConnectProviderArn": { - "target": "com.amazonaws.iam#arnType", + "ClientID": { + "target": "com.amazonaws.iam#clientIDType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client\n ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#documentation": "

The client ID (also known as audience) to remove from the IAM OIDC provider resource.\n For more information about client IDs, see CreateOpenIDConnectProvider.

", "smithy.api#required": {} } } @@ -8399,17 +8399,17 @@ "com.amazonaws.iam#RemoveUserFromGroupRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#existingUserNameType", + "GroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

The name of the user to remove.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the group to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.iam#groupNameType", + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", "traits": { - "smithy.api#documentation": "

The name of the group to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The name of the user to remove.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -8483,18 +8483,18 @@ "com.amazonaws.iam#ResetServiceSpecificCredentialRequest": { "type": "structure", "members": { + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential. If this\n value is not specified, then the operation assumes the user whose credentials are used to\n call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, "ServiceSpecificCredentialId": { "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { "smithy.api#documentation": "

The unique identifier of the service-specific credential.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", "smithy.api#required": {} } - }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", - "traits": { - "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential. If this\n value is not specified, then the operation assumes the user whose credentials are used to\n call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } } } }, @@ -8536,24 +8536,6 @@ "com.amazonaws.iam#ResourceSpecificResult": { "type": "structure", "members": { - "PermissionsBoundaryDecisionDetail": { - "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", - "traits": { - "smithy.api#documentation": "

Contains information about the effect that a permissions boundary has on a policy\n simulation when that boundary is applied to an IAM entity.

" - } - }, - "MissingContextValues": { - "target": "com.amazonaws.iam#ContextKeyNamesResultListType", - "traits": { - "smithy.api#documentation": "

A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when a list of ARNs is\n included in the ResourceArns parameter instead of \"*\". If you do not specify\n individual resources, by setting ResourceArns to \"*\" or by not including the\n ResourceArns parameter, then any missing context values are instead\n included under the EvaluationResults section. To discover the context keys\n used by a set of policies, you can call GetContextKeysForCustomPolicy or\n GetContextKeysForPrincipalPolicy.

" - } - }, - "EvalDecisionDetails": { - "target": "com.amazonaws.iam#EvalDecisionDetailsType", - "traits": { - "smithy.api#documentation": "

Additional details about the results of the evaluation decision on a single resource.\n This parameter is returned only for cross-account simulations. This parameter explains how\n each policy type contributes to the resource-specific evaluation decision.

" - } - }, "EvalResourceName": { "target": "com.amazonaws.iam#ResourceNameType", "traits": { @@ -8573,6 +8555,24 @@ "smithy.api#documentation": "

The result of the simulation of the simulated API operation on the resource specified in\n EvalResourceName.

", "smithy.api#required": {} } + }, + "EvalDecisionDetails": { + "target": "com.amazonaws.iam#EvalDecisionDetailsType", + "traits": { + "smithy.api#documentation": "

Additional details about the results of the evaluation decision on a single resource.\n This parameter is returned only for cross-account simulations. This parameter explains how\n each policy type contributes to the resource-specific evaluation decision.

" + } + }, + "PermissionsBoundaryDecisionDetail": { + "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", + "traits": { + "smithy.api#documentation": "

Contains information about the effect that a permissions boundary has on a policy\n simulation when that boundary is applied to an IAM entity.

" + } + }, + "MissingContextValues": { + "target": "com.amazonaws.iam#ContextKeyNamesResultListType", + "traits": { + "smithy.api#documentation": "

A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when a list of ARNs is\n included in the ResourceArns parameter instead of \"*\". If you do not specify\n individual resources, by setting ResourceArns to \"*\" or by not including the\n ResourceArns parameter, then any missing context values are instead\n included under the EvaluationResults section. To discover the context keys\n used by a set of policies, you can call GetContextKeysForCustomPolicy or\n GetContextKeysForPrincipalPolicy.

" + } } }, "traits": { @@ -8611,31 +8611,31 @@ "com.amazonaws.iam#ResyncMFADeviceRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#existingUserNameType", + "AuthenticationCode2": { + "target": "com.amazonaws.iam#authenticationCodeType", "traits": { - "smithy.api#documentation": "

The name of the user whose MFA device you want to resynchronize.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

A subsequent authentication code emitted by the device.

\n

The format for this parameter is a sequence of six digits.

", "smithy.api#required": {} } }, - "SerialNumber": { - "target": "com.amazonaws.iam#serialNumberType", + "AuthenticationCode1": { + "target": "com.amazonaws.iam#authenticationCodeType", "traits": { - "smithy.api#documentation": "

Serial number that uniquely identifies the MFA device.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

An authentication code emitted by the device.

\n

The format for this parameter is a sequence of six digits.

", "smithy.api#required": {} } }, - "AuthenticationCode1": { - "target": "com.amazonaws.iam#authenticationCodeType", + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", "traits": { - "smithy.api#documentation": "

An authentication code emitted by the device.

\n

The format for this parameter is a sequence of six digits.

", + "smithy.api#documentation": "

The name of the user whose MFA device you want to resynchronize.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "AuthenticationCode2": { - "target": "com.amazonaws.iam#authenticationCodeType", + "SerialNumber": { + "target": "com.amazonaws.iam#serialNumberType", "traits": { - "smithy.api#documentation": "

A subsequent authentication code emitted by the device.

\n

The format for this parameter is a sequence of six digits.

", + "smithy.api#documentation": "

Serial number that uniquely identifies the MFA device.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -8644,29 +8644,16 @@ "com.amazonaws.iam#Role": { "type": "structure", "members": { - "CreateDate": { - "target": "com.amazonaws.iam#dateType", - "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the role was created.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.iam#tagListType", - "traits": { - "smithy.api#documentation": "

A list of tags that are attached to the specified role. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" - } - }, - "AssumeRolePolicyDocument": { - "target": "com.amazonaws.iam#policyDocumentType", + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", "traits": { - "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

" + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the role.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" } }, - "RoleLastUsed": { - "target": "com.amazonaws.iam#RoleLastUsed", + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", "traits": { - "smithy.api#documentation": "

Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions Where Data Is Tracked in the IAM User\n Guide.

" + "smithy.api#documentation": "

A description of the role that you provide.

" } }, "RoleName": { @@ -8676,10 +8663,17 @@ "smithy.api#required": {} } }, - "PermissionsBoundary": { - "target": "com.amazonaws.iam#AttachedPermissionsBoundary", + "MaxSessionDuration": { + "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { - "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the role.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" + "smithy.api#documentation": "

The maximum session duration (in seconds) for the specified role. Anyone who uses the\n AWS CLI, or API to assume the role can specify the duration using the optional\n DurationSeconds API parameter or duration-seconds CLI\n parameter.

" + } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and\n how to use them in policies, see IAM Identifiers in the\n IAM User Guide guide.

", + "smithy.api#required": {} } }, "Path": { @@ -8689,17 +8683,10 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.iam#roleDescriptionType", - "traits": { - "smithy.api#documentation": "

A description of the role that you provide.

" - } - }, - "Arn": { - "target": "com.amazonaws.iam#arnType", + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and\n how to use them in policies, see IAM Identifiers in the\n IAM User Guide guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

" } }, "RoleId": { @@ -8709,10 +8696,23 @@ "smithy.api#required": {} } }, - "MaxSessionDuration": { - "target": "com.amazonaws.iam#roleMaxSessionDurationType", + "Tags": { + "target": "com.amazonaws.iam#tagListType", "traits": { - "smithy.api#documentation": "

The maximum session duration (in seconds) for the specified role. Anyone who uses the\n AWS CLI, or API to assume the role can specify the duration using the optional\n DurationSeconds API parameter or duration-seconds CLI\n parameter.

" + "smithy.api#documentation": "

A list of tags that are attached to the specified role. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" + } + }, + "RoleLastUsed": { + "target": "com.amazonaws.iam#RoleLastUsed", + "traits": { + "smithy.api#documentation": "

Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions Where Data Is Tracked in the IAM User\n Guide.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the role was created.

", + "smithy.api#required": {} } } }, @@ -8723,25 +8723,10 @@ "com.amazonaws.iam#RoleDetail": { "type": "structure", "members": { - "PermissionsBoundary": { - "target": "com.amazonaws.iam#AttachedPermissionsBoundary", - "traits": { - "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the role.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" - } - }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", - "traits": { - "smithy.api#documentation": "

The friendly name that identifies the role.

" - } - }, - "Arn": { - "target": "com.amazonaws.iam#arnType" - }, - "Path": { - "target": "com.amazonaws.iam#pathType", + "InstanceProfileList": { + "target": "com.amazonaws.iam#instanceProfileListType", "traits": { - "smithy.api#documentation": "

The path to the role. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

" + "smithy.api#documentation": "

A list of instance profiles that contain this role.

" } }, "AssumeRolePolicyDocument": { @@ -8756,16 +8741,16 @@ "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the role was created.

" } }, - "RolePolicyList": { - "target": "com.amazonaws.iam#policyDetailListType", + "Tags": { + "target": "com.amazonaws.iam#tagListType", "traits": { - "smithy.api#documentation": "

A list of inline policies embedded in the role. These policies are the role's access\n (permissions) policies.

" + "smithy.api#documentation": "

A list of tags that are attached to the specified role. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" } }, - "AttachedManagedPolicies": { - "target": "com.amazonaws.iam#attachedPoliciesListType", + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", "traits": { - "smithy.api#documentation": "

A list of managed policies attached to the role. These policies are the role's access\n (permissions) policies.

" + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the role.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" } }, "RoleId": { @@ -8774,11 +8759,8 @@ "smithy.api#documentation": "

The stable and unique string identifying the role. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

" } }, - "InstanceProfileList": { - "target": "com.amazonaws.iam#instanceProfileListType", - "traits": { - "smithy.api#documentation": "

A list of instance profiles that contain this role.

" - } + "Arn": { + "target": "com.amazonaws.iam#arnType" }, "RoleLastUsed": { "target": "com.amazonaws.iam#RoleLastUsed", @@ -8786,10 +8768,28 @@ "smithy.api#documentation": "

Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions Where Data Is Tracked in the IAM User\n Guide.

" } }, - "Tags": { - "target": "com.amazonaws.iam#tagListType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

A list of tags that are attached to the specified role. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" + "smithy.api#documentation": "

The friendly name that identifies the role.

" + } + }, + "Path": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

The path to the role. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

" + } + }, + "AttachedManagedPolicies": { + "target": "com.amazonaws.iam#attachedPoliciesListType", + "traits": { + "smithy.api#documentation": "

A list of managed policies attached to the role. These policies are the role's access\n (permissions) policies.

" + } + }, + "RolePolicyList": { + "target": "com.amazonaws.iam#policyDetailListType", + "traits": { + "smithy.api#documentation": "

A list of inline policies embedded in the role. These policies are the role's access\n (permissions) policies.

" } } }, @@ -8800,17 +8800,17 @@ "com.amazonaws.iam#RoleLastUsed": { "type": "structure", "members": { - "Region": { - "target": "com.amazonaws.iam#stringType", - "traits": { - "smithy.api#documentation": "

The name of the AWS Region in which the role was last used.

" - } - }, "LastUsedDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format that the role was last used.

\n

This field is null if the role has not been used within the IAM tracking period. For\n more information about the tracking period, see Regions Where Data Is Tracked in the IAM User Guide.\n

" } + }, + "Region": { + "target": "com.amazonaws.iam#stringType", + "traits": { + "smithy.api#documentation": "

The name of the AWS Region in which the role was last used.

" + } } }, "traits": { @@ -8897,10 +8897,11 @@ "com.amazonaws.iam#SSHPublicKey": { "type": "structure", "members": { - "UploadDate": { - "target": "com.amazonaws.iam#dateType", + "SSHPublicKeyBody": { + "target": "com.amazonaws.iam#publicKeyMaterialType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.

" + "smithy.api#documentation": "

The SSH public key.

", + "smithy.api#required": {} } }, "UserName": { @@ -8910,17 +8911,16 @@ "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.iam#statusType", + "UploadDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The status of the SSH public key. Active means that the key can be used for\n authentication with an AWS CodeCommit repository. Inactive means that the key\n cannot be used.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.

" } }, - "SSHPublicKeyBody": { - "target": "com.amazonaws.iam#publicKeyMaterialType", + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", "traits": { - "smithy.api#documentation": "

The SSH public key.

", + "smithy.api#documentation": "

The unique identifier for the SSH public key.

", "smithy.api#required": {} } }, @@ -8931,10 +8931,10 @@ "smithy.api#required": {} } }, - "SSHPublicKeyId": { - "target": "com.amazonaws.iam#publicKeyIdType", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The unique identifier for the SSH public key.

", + "smithy.api#documentation": "

The status of the SSH public key. Active means that the key can be used for\n authentication with an AWS CodeCommit repository. Inactive means that the key\n cannot be used.

", "smithy.api#required": {} } } @@ -8952,31 +8952,31 @@ "com.amazonaws.iam#SSHPublicKeyMetadata": { "type": "structure", "members": { - "UploadDate": { - "target": "com.amazonaws.iam#dateType", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.

", + "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.iam#statusType", + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", "traits": { - "smithy.api#documentation": "

The status of the SSH public key. Active means that the key can be used for\n authentication with an AWS CodeCommit repository. Inactive means that the key\n cannot be used.

", + "smithy.api#documentation": "

The unique identifier for the SSH public key.

", "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "UploadDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The name of the IAM user associated with the SSH public key.

", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.

", "smithy.api#required": {} } }, - "SSHPublicKeyId": { - "target": "com.amazonaws.iam#publicKeyIdType", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The unique identifier for the SSH public key.

", + "smithy.api#documentation": "

The status of the SSH public key. Active means that the key can be used for\n authentication with an AWS CodeCommit repository. Inactive means that the key\n cannot be used.

", "smithy.api#required": {} } } @@ -8988,10 +8988,10 @@ "com.amazonaws.iam#ServerCertificate": { "type": "structure", "members": { - "ServerCertificateMetadata": { - "target": "com.amazonaws.iam#ServerCertificateMetadata", + "CertificateBody": { + "target": "com.amazonaws.iam#certificateBodyType", "traits": { - "smithy.api#documentation": "

The meta information of the server certificate, such as its name, path, ID, and\n ARN.

", + "smithy.api#documentation": "

The contents of the public key certificate.

", "smithy.api#required": {} } }, @@ -9001,10 +9001,10 @@ "smithy.api#documentation": "

The contents of the public key certificate chain.

" } }, - "CertificateBody": { - "target": "com.amazonaws.iam#certificateBodyType", + "ServerCertificateMetadata": { + "target": "com.amazonaws.iam#ServerCertificateMetadata", "traits": { - "smithy.api#documentation": "

The contents of the public key certificate.

", + "smithy.api#documentation": "

The meta information of the server certificate, such as its name, path, ID, and\n ARN.

", "smithy.api#required": {} } } @@ -9016,43 +9016,43 @@ "com.amazonaws.iam#ServerCertificateMetadata": { "type": "structure", "members": { - "ServerCertificateId": { - "target": "com.amazonaws.iam#idType", + "Arn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The stable and unique string identifying the server certificate. For more information\n about IDs, see IAM Identifiers in the IAM User Guide.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the server certificate. For more information\n about ARNs and how to use them in policies, see IAM Identifiers in the\n IAM User Guide.

", "smithy.api#required": {} } }, - "ServerCertificateName": { - "target": "com.amazonaws.iam#serverCertificateNameType", + "Path": { + "target": "com.amazonaws.iam#pathType", "traits": { - "smithy.api#documentation": "

The name that identifies the server certificate.

", + "smithy.api#documentation": "

The path to the server certificate. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

", "smithy.api#required": {} } }, - "Expiration": { + "UploadDate": { "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The date on which the certificate is set to expire.

" + "smithy.api#documentation": "

The date when the server certificate was uploaded.

" } }, - "Path": { - "target": "com.amazonaws.iam#pathType", + "ServerCertificateId": { + "target": "com.amazonaws.iam#idType", "traits": { - "smithy.api#documentation": "

The path to the server certificate. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

", + "smithy.api#documentation": "

The stable and unique string identifying the server certificate. For more information\n about IDs, see IAM Identifiers in the IAM User Guide.

", "smithy.api#required": {} } }, - "UploadDate": { + "Expiration": { "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The date when the server certificate was uploaded.

" + "smithy.api#documentation": "

The date on which the certificate is set to expire.

" } }, - "Arn": { - "target": "com.amazonaws.iam#arnType", + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) specifying the server certificate. For more information\n about ARNs and how to use them in policies, see IAM Identifiers in the\n IAM User Guide.

", + "smithy.api#documentation": "

The name that identifies the server certificate.

", "smithy.api#required": {} } } @@ -9077,23 +9077,28 @@ "com.amazonaws.iam#ServiceLastAccessed": { "type": "structure", "members": { - "TrackedActionsLastAccessed": { - "target": "com.amazonaws.iam#TrackedActionsLastAccessed", + "LastAuthenticated": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

An object that contains details about the most recent attempt to access a tracked action\n within the service.

\n

This field is null if there no tracked actions or if the principal did not use the\n tracked actions within the reporting period. This field is also null if the report was generated at the\n service level and not the action level. For more information, see the\n Granularity field in GenerateServiceLastAccessedDetails.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n service. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" } }, - "ServiceName": { - "target": "com.amazonaws.iam#serviceNameType", + "TotalAuthenticatedEntities": { + "target": "com.amazonaws.iam#integerType", "traits": { - "smithy.api#documentation": "

The name of the service in which access was attempted.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The total number of authenticated principals (root user, IAM users, or IAM roles)\n that have attempted to access the service.

\n

This field is null if no principals attempted to access the service within the reporting period.

" } }, - "LastAuthenticated": { - "target": "com.amazonaws.iam#dateType", + "TrackedActionsLastAccessed": { + "target": "com.amazonaws.iam#TrackedActionsLastAccessed", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n service. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" + "smithy.api#documentation": "

An object that contains details about the most recent attempt to access a tracked action\n within the service.

\n

This field is null if there no tracked actions or if the principal did not use the\n tracked actions within the reporting period. This field is also null if the report was generated at the\n service level and not the action level. For more information, see the\n Granularity field in GenerateServiceLastAccessedDetails.

" + } + }, + "LastAuthenticatedEntity": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The ARN of the authenticated entity (user or role) that last attempted to access the\n service. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" } }, "LastAuthenticatedRegion": { @@ -9102,23 +9107,18 @@ "smithy.api#documentation": "

The Region from which the authenticated entity (user or role) last attempted to access\n the service. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" } }, - "ServiceNamespace": { - "target": "com.amazonaws.iam#serviceNamespaceType", + "ServiceName": { + "target": "com.amazonaws.iam#serviceNameType", "traits": { - "smithy.api#documentation": "

The namespace of the service in which access was attempted.

\n

To learn the service namespace of a service, go to Actions,\n Resources, and Condition Keys for AWS Services in the\n IAM User Guide. Choose the name of the service to view details\n for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b). For more information about service namespaces, see\n AWS\n Service Namespaces in the AWS General Reference.

", + "smithy.api#documentation": "

The name of the service in which access was attempted.

", "smithy.api#required": {} } }, - "LastAuthenticatedEntity": { - "target": "com.amazonaws.iam#arnType", - "traits": { - "smithy.api#documentation": "

The ARN of the authenticated entity (user or role) that last attempted to access the\n service. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" - } - }, - "TotalAuthenticatedEntities": { - "target": "com.amazonaws.iam#integerType", + "ServiceNamespace": { + "target": "com.amazonaws.iam#serviceNamespaceType", "traits": { - "smithy.api#documentation": "

The total number of authenticated principals (root user, IAM users, or IAM roles)\n that have attempted to access the service.

\n

This field is null if no principals attempted to access the service within the reporting period.

" + "smithy.api#documentation": "

The namespace of the service in which access was attempted.

\n

To learn the service namespace of a service, go to Actions,\n Resources, and Condition Keys for AWS Services in the\n IAM User Guide. Choose the name of the service to view details\n for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b). For more information about service namespaces, see\n AWS\n Service Namespaces in the AWS General Reference.

", + "smithy.api#required": {} } } }, @@ -9142,52 +9142,52 @@ "com.amazonaws.iam#ServiceSpecificCredential": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "ServiceName": { + "target": "com.amazonaws.iam#serviceName", "traits": { - "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential.

", + "smithy.api#documentation": "

The name of the service associated with the service-specific credential.

", "smithy.api#required": {} } }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "ServicePassword": { + "target": "com.amazonaws.iam#servicePassword", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.

", + "smithy.api#documentation": "

The generated password for the service-specific credential.

", "smithy.api#required": {} } }, - "ServiceUserName": { - "target": "com.amazonaws.iam#serviceUserName", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The generated user name for the service-specific credential. This value is generated by\n combining the IAM user's name combined with the ID number of the AWS account, as in\n jane-at-123456789012, for example. This value cannot be configured by the\n user.

", + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.iam#statusType", + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { - "smithy.api#documentation": "

The status of the service-specific credential. Active means that the key is\n valid for API calls, while Inactive means it is not.

", + "smithy.api#documentation": "

The unique identifier for the service-specific credential.

", "smithy.api#required": {} } }, - "ServiceName": { - "target": "com.amazonaws.iam#serviceName", + "CreateDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The name of the service associated with the service-specific credential.

", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.

", "smithy.api#required": {} } }, - "ServicePassword": { - "target": "com.amazonaws.iam#servicePassword", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The generated password for the service-specific credential.

", + "smithy.api#documentation": "

The status of the service-specific credential. Active means that the key is\n valid for API calls, while Inactive means it is not.

", "smithy.api#required": {} } }, - "ServiceSpecificCredentialId": { - "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "ServiceUserName": { + "target": "com.amazonaws.iam#serviceUserName", "traits": { - "smithy.api#documentation": "

The unique identifier for the service-specific credential.

", + "smithy.api#documentation": "

The generated user name for the service-specific credential. This value is generated by\n combining the IAM user's name combined with the ID number of the AWS account, as in\n jane-at-123456789012, for example. This value cannot be configured by the\n user.

", "smithy.api#required": {} } } @@ -9199,10 +9199,10 @@ "com.amazonaws.iam#ServiceSpecificCredentialMetadata": { "type": "structure", "members": { - "ServiceSpecificCredentialId": { - "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The unique identifier for the service-specific credential.

", + "smithy.api#documentation": "

The status of the service-specific credential. Active means that the key is\n valid for API calls, while Inactive means it is not.

", "smithy.api#required": {} } }, @@ -9213,31 +9213,31 @@ "smithy.api#required": {} } }, - "ServiceName": { - "target": "com.amazonaws.iam#serviceName", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The name of the service associated with the service-specific credential.

", + "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential.

", "smithy.api#required": {} } }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "ServiceName": { + "target": "com.amazonaws.iam#serviceName", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.

", + "smithy.api#documentation": "

The name of the service associated with the service-specific credential.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.iam#statusType", + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { - "smithy.api#documentation": "

The status of the service-specific credential. Active means that the key is\n valid for API calls, while Inactive means it is not.

", + "smithy.api#documentation": "

The unique identifier for the service-specific credential.

", "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "CreateDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential.

", + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.

", "smithy.api#required": {} } } @@ -9284,17 +9284,17 @@ "com.amazonaws.iam#SetDefaultPolicyVersionRequest": { "type": "structure", "members": { - "PolicyArn": { - "target": "com.amazonaws.iam#arnType", + "VersionId": { + "target": "com.amazonaws.iam#policyVersionIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to\n set.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#documentation": "

The version of the policy to set as the default (operative) version.

\n

For more information about managed policy versions, see Versioning for Managed\n Policies in the IAM User Guide.

", "smithy.api#required": {} } }, - "VersionId": { - "target": "com.amazonaws.iam#policyVersionIdType", + "PolicyArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

The version of the policy to set as the default (operative) version.

\n

For more information about managed policy versions, see Versioning for Managed\n Policies in the IAM User Guide.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to\n set.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } } @@ -9329,10 +9329,16 @@ "com.amazonaws.iam#SigningCertificate": { "type": "structure", "members": { - "CertificateBody": { - "target": "com.amazonaws.iam#certificateBodyType", + "UploadDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The contents of the signing certificate.

", + "smithy.api#documentation": "

The date when the signing certificate was uploaded.

" + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The name of the user the signing certificate is associated with.

", "smithy.api#required": {} } }, @@ -9350,18 +9356,12 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "CertificateBody": { + "target": "com.amazonaws.iam#certificateBodyType", "traits": { - "smithy.api#documentation": "

The name of the user the signing certificate is associated with.

", + "smithy.api#documentation": "

The contents of the signing certificate.

", "smithy.api#required": {} } - }, - "UploadDate": { - "target": "com.amazonaws.iam#dateType", - "traits": { - "smithy.api#documentation": "

The date when the signing certificate was uploaded.

" - } } }, "traits": { @@ -9397,23 +9397,16 @@ "com.amazonaws.iam#SimulateCustomPolicyRequest": { "type": "structure", "members": { - "ContextEntries": { - "target": "com.amazonaws.iam#ContextEntryListType", - "traits": { - "smithy.api#documentation": "

A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.

" - } - }, - "ActionNames": { - "target": "com.amazonaws.iam#ActionNameListType", + "ResourcePolicy": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated against each resource. Each operation must include the service identifier, such\n as iam:CreateUser. This operation does not support using wildcards (*) in an\n action name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A resource-based policy to include in the simulation provided as a string. Each resource\n in the simulation is treated as if it had this policy attached. You can include only one\n resource-based policy in a simulation.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " } }, - "ResourceOwner": { + "CallerArn": { "target": "com.amazonaws.iam#ResourceNameType", "traits": { - "smithy.api#documentation": "

An ARN representing the AWS account ID that specifies the owner of any simulated\n resource that does not identify its owner in the resource ARN. Examples of resource ARNs\n include an S3 bucket or object. If ResourceOwner is specified, it is also used\n as the account owner of any ResourcePolicy included in the simulation. If the\n ResourceOwner parameter is not specified, then the owner of the resources\n and the resource policy defaults to the account of the identity provided in\n CallerArn. This parameter is required only if you specify a resource-based\n policy and account that owns the resource is different from the account that owns the\n simulated calling user CallerArn.

\n

The ARN for an account uses the following syntax:\n arn:aws:iam::AWS-account-ID:root. For example, to\n represent the account with the 112233445566 ID, use the following ARN:\n arn:aws:iam::112233445566-ID:root.

" + "smithy.api#documentation": "

The ARN of the IAM user that you want to use as the simulated caller of the API\n operations. CallerArn is required if you include a ResourcePolicy\n so that the policy's Principal element has a value to use in evaluating the\n policy.

\n

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed\n role, federated user, or a service principal.

" } }, "ResourceHandlingOption": { @@ -9422,16 +9415,17 @@ "smithy.api#documentation": "

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the type\n of simulation to run, you enable the policy simulator to enforce the presence of the\n required resources to ensure reliable simulation results. If your simulation does not match\n one of the following scenarios, then you can omit this parameter. The following list shows\n each of the supported scenario values and the resources that you must define to run the\n simulation.

\n

Each of the EC2 scenarios requires that you specify instance, image, and security-group\n resources. If your scenario includes an EBS volume, then you must specify that volume as a\n resource. If the EC2 scenario includes VPC, then you must supply the network-interface\n resource. If it includes an IP subnet, then you must specify the subnet resource. For more\n information on the EC2 scenario options, see Supported Platforms\n in the Amazon EC2 User Guide.

\n " } }, - "MaxItems": { - "target": "com.amazonaws.iam#maxItemsType", + "ResourceArns": { + "target": "com.amazonaws.iam#ResourceNameListType", "traits": { - "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" + "smithy.api#documentation": "

A list of ARNs of AWS resources to include in the simulation. If this parameter is not\n provided, then the value defaults to * (all resources). Each API in the\n ActionNames parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and reports\n it in the response.

\n

The simulation does not automatically retrieve policies for the specified resources. If\n you want to include a resource policy in the simulation, then you must include the policy\n as a string in the ResourcePolicy parameter.

\n

If you include a ResourcePolicy, then it must be applicable to all of the\n resources included in the simulation or you receive an invalid input error.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

" } }, - "ResourcePolicy": { - "target": "com.amazonaws.iam#policyDocumentType", + "ActionNames": { + "target": "com.amazonaws.iam#ActionNameListType", "traits": { - "smithy.api#documentation": "

A resource-based policy to include in the simulation provided as a string. Each resource\n in the simulation is treated as if it had this policy attached. You can include only one\n resource-based policy in a simulation.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " + "smithy.api#documentation": "

A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated against each resource. Each operation must include the service identifier, such\n as iam:CreateUser. This operation does not support using wildcards (*) in an\n action name.

", + "smithy.api#required": {} } }, "PolicyInputList": { @@ -9447,22 +9441,28 @@ "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, - "CallerArn": { + "PermissionsBoundaryPolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", + "traits": { + "smithy.api#documentation": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that an IAM entity can have. You can input only one permissions\n boundary when you pass a policy to this operation. For more information about permissions\n boundaries, see Permissions Boundaries for IAM\n Entities in the IAM User Guide. The policy input is\n specified as a string that contains the complete, valid JSON text of a permissions boundary\n policy.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " + } + }, + "ResourceOwner": { "target": "com.amazonaws.iam#ResourceNameType", "traits": { - "smithy.api#documentation": "

The ARN of the IAM user that you want to use as the simulated caller of the API\n operations. CallerArn is required if you include a ResourcePolicy\n so that the policy's Principal element has a value to use in evaluating the\n policy.

\n

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed\n role, federated user, or a service principal.

" + "smithy.api#documentation": "

An ARN representing the AWS account ID that specifies the owner of any simulated\n resource that does not identify its owner in the resource ARN. Examples of resource ARNs\n include an S3 bucket or object. If ResourceOwner is specified, it is also used\n as the account owner of any ResourcePolicy included in the simulation. If the\n ResourceOwner parameter is not specified, then the owner of the resources\n and the resource policy defaults to the account of the identity provided in\n CallerArn. This parameter is required only if you specify a resource-based\n policy and account that owns the resource is different from the account that owns the\n simulated calling user CallerArn.

\n

The ARN for an account uses the following syntax:\n arn:aws:iam::AWS-account-ID:root. For example, to\n represent the account with the 112233445566 ID, use the following ARN:\n arn:aws:iam::112233445566-ID:root.

" } }, - "ResourceArns": { - "target": "com.amazonaws.iam#ResourceNameListType", + "ContextEntries": { + "target": "com.amazonaws.iam#ContextEntryListType", "traits": { - "smithy.api#documentation": "

A list of ARNs of AWS resources to include in the simulation. If this parameter is not\n provided, then the value defaults to * (all resources). Each API in the\n ActionNames parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and reports\n it in the response.

\n

The simulation does not automatically retrieve policies for the specified resources. If\n you want to include a resource policy in the simulation, then you must include the policy\n as a string in the ResourcePolicy parameter.

\n

If you include a ResourcePolicy, then it must be applicable to all of the\n resources included in the simulation or you receive an invalid input error.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

" + "smithy.api#documentation": "

A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.

" } }, - "PermissionsBoundaryPolicyInputList": { - "target": "com.amazonaws.iam#SimulationPolicyListType", + "MaxItems": { + "target": "com.amazonaws.iam#maxItemsType", "traits": { - "smithy.api#documentation": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that an IAM entity can have. You can input only one permissions\n boundary when you pass a policy to this operation. For more information about permissions\n boundaries, see Permissions Boundaries for IAM\n Entities in the IAM User Guide. The policy input is\n specified as a string that contains the complete, valid JSON text of a permissions boundary\n policy.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " + "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } } } @@ -9470,6 +9470,12 @@ "com.amazonaws.iam#SimulatePolicyResponse": { "type": "structure", "members": { + "EvaluationResults": { + "target": "com.amazonaws.iam#EvaluationResultsListType", + "traits": { + "smithy.api#documentation": "

The results of the simulation.

" + } + }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { @@ -9481,12 +9487,6 @@ "traits": { "smithy.api#documentation": "

When IsTruncated is true, this element\n is present and contains the value to use for the Marker parameter in a subsequent \n pagination request.

" } - }, - "EvaluationResults": { - "target": "com.amazonaws.iam#EvaluationResultsListType", - "traits": { - "smithy.api#documentation": "

The results of the simulation.

" - } } }, "traits": { @@ -9525,28 +9525,23 @@ "com.amazonaws.iam#SimulatePrincipalPolicyRequest": { "type": "structure", "members": { - "ContextEntries": { - "target": "com.amazonaws.iam#ContextEntryListType", - "traits": { - "smithy.api#documentation": "

A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.

" - } - }, - "PermissionsBoundaryPolicyInputList": { - "target": "com.amazonaws.iam#SimulationPolicyListType", + "Marker": { + "target": "com.amazonaws.iam#markerType", "traits": { - "smithy.api#documentation": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that the entity can have. You can input only one permissions boundary\n when you pass a policy to this operation. An IAM entity can only have one permissions\n boundary in effect at a time. For example, if a permissions boundary is attached to an\n entity and you pass in a different permissions boundary policy using this parameter, then\n the new permissions boundary policy is used for the simulation. For more information about\n permissions boundaries, see Permissions Boundaries for IAM\n Entities in the IAM User Guide. The policy input is\n specified as a string containing the complete, valid JSON text of a permissions boundary\n policy.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " + "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" } }, - "ResourceArns": { - "target": "com.amazonaws.iam#ResourceNameListType", + "ResourceHandlingOption": { + "target": "com.amazonaws.iam#ResourceHandlingOptionType", "traits": { - "smithy.api#documentation": "

A list of ARNs of AWS resources to include in the simulation. If this parameter is not\n provided, then the value defaults to * (all resources). Each API in the\n ActionNames parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and reports\n it in the response.

\n

The simulation does not automatically retrieve policies for the specified resources. If\n you want to include a resource policy in the simulation, then you must include the policy\n as a string in the ResourcePolicy parameter.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

" + "smithy.api#documentation": "

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the type\n of simulation to run, you enable the policy simulator to enforce the presence of the\n required resources to ensure reliable simulation results. If your simulation does not match\n one of the following scenarios, then you can omit this parameter. The following list shows\n each of the supported scenario values and the resources that you must define to run the\n simulation.

\n

Each of the EC2 scenarios requires that you specify instance, image, and security group\n resources. If your scenario includes an EBS volume, then you must specify that volume as a\n resource. If the EC2 scenario includes VPC, then you must supply the network interface\n resource. If it includes an IP subnet, then you must specify the subnet resource. For more\n information on the EC2 scenario options, see Supported Platforms\n in the Amazon EC2 User Guide.

\n " } }, - "CallerArn": { - "target": "com.amazonaws.iam#ResourceNameType", + "ActionNames": { + "target": "com.amazonaws.iam#ActionNameListType", "traits": { - "smithy.api#documentation": "

The ARN of the IAM user that you want to specify as the simulated caller of the API\n operations. If you do not specify a CallerArn, it defaults to the ARN of the\n user that you specify in PolicySourceArn, if you specified a user. If you\n include both a PolicySourceArn (for example,\n arn:aws:iam::123456789012:user/David) and a CallerArn (for\n example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate\n calling the API operations as Bob, as if Bob had David's policies.

\n

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed\n role, federated user, or a service principal.

\n

\n CallerArn is required if you include a ResourcePolicy and the\n PolicySourceArn is not the ARN for an IAM user. This is required so that\n the resource-based policy's Principal element has a value to use in evaluating\n the policy.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

" + "smithy.api#documentation": "

A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated for each resource. Each operation must include the service identifier, such as\n iam:CreateUser.

", + "smithy.api#required": {} } }, "ResourcePolicy": { @@ -9555,36 +9550,22 @@ "smithy.api#documentation": "

A resource-based policy to include in the simulation provided as a string. Each resource\n in the simulation is treated as if it had this policy attached. You can include only one\n resource-based policy in a simulation.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " } }, - "PolicySourceArn": { - "target": "com.amazonaws.iam#arnType", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to\n include in the simulation. If you specify a user, group, or role, the simulation includes\n all policies that are associated with that entity. If you specify a user, the simulation\n also includes all policies that are attached to any groups the user belongs to.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", - "smithy.api#required": {} - } - }, "MaxItems": { "target": "com.amazonaws.iam#maxItemsType", "traits": { "smithy.api#documentation": "

Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated response element is true.

\n

If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated response element returns true, and Marker \n contains a value to include in the subsequent call that tells the service where to continue \n from.

" } }, - "Marker": { - "target": "com.amazonaws.iam#markerType", - "traits": { - "smithy.api#documentation": "

Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker element in the response that you received to indicate where the next call \n should start.

" - } - }, - "ResourceHandlingOption": { - "target": "com.amazonaws.iam#ResourceHandlingOptionType", + "ContextEntries": { + "target": "com.amazonaws.iam#ContextEntryListType", "traits": { - "smithy.api#documentation": "

Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the type\n of simulation to run, you enable the policy simulator to enforce the presence of the\n required resources to ensure reliable simulation results. If your simulation does not match\n one of the following scenarios, then you can omit this parameter. The following list shows\n each of the supported scenario values and the resources that you must define to run the\n simulation.

\n

Each of the EC2 scenarios requires that you specify instance, image, and security group\n resources. If your scenario includes an EBS volume, then you must specify that volume as a\n resource. If the EC2 scenario includes VPC, then you must supply the network interface\n resource. If it includes an IP subnet, then you must specify the subnet resource. For more\n information on the EC2 scenario options, see Supported Platforms\n in the Amazon EC2 User Guide.

\n " + "smithy.api#documentation": "

A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.

" } }, - "ActionNames": { - "target": "com.amazonaws.iam#ActionNameListType", + "PermissionsBoundaryPolicyInputList": { + "target": "com.amazonaws.iam#SimulationPolicyListType", "traits": { - "smithy.api#documentation": "

A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated for each resource. Each operation must include the service identifier, such as\n iam:CreateUser.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that the entity can have. You can input only one permissions boundary\n when you pass a policy to this operation. An IAM entity can only have one permissions\n boundary in effect at a time. For example, if a permissions boundary is attached to an\n entity and you pass in a different permissions boundary policy using this parameter, then\n the new permissions boundary policy is used for the simulation. For more information about\n permissions boundaries, see Permissions Boundaries for IAM\n Entities in the IAM User Guide. The policy input is\n specified as a string containing the complete, valid JSON text of a permissions boundary\n policy.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " } }, "PolicyInputList": { @@ -9598,6 +9579,25 @@ "traits": { "smithy.api#documentation": "

An AWS account ID that specifies the owner of any simulated resource that does not\n identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or\n object. If ResourceOwner is specified, it is also used as the account owner of\n any ResourcePolicy included in the simulation. If the\n ResourceOwner parameter is not specified, then the owner of the resources\n and the resource policy defaults to the account of the identity provided in\n CallerArn. This parameter is required only if you specify a resource-based\n policy and account that owns the resource is different from the account that owns the\n simulated calling user CallerArn.

" } + }, + "PolicySourceArn": { + "target": "com.amazonaws.iam#arnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to\n include in the simulation. If you specify a user, group, or role, the simulation includes\n all policies that are associated with that entity. If you specify a user, the simulation\n also includes all policies that are attached to any groups the user belongs to.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#required": {} + } + }, + "ResourceArns": { + "target": "com.amazonaws.iam#ResourceNameListType", + "traits": { + "smithy.api#documentation": "

A list of ARNs of AWS resources to include in the simulation. If this parameter is not\n provided, then the value defaults to * (all resources). Each API in the\n ActionNames parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and reports\n it in the response.

\n

The simulation does not automatically retrieve policies for the specified resources. If\n you want to include a resource policy in the simulation, then you must include the policy\n as a string in the ResourcePolicy parameter.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

" + } + }, + "CallerArn": { + "target": "com.amazonaws.iam#ResourceNameType", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM user that you want to specify as the simulated caller of the API\n operations. If you do not specify a CallerArn, it defaults to the ARN of the\n user that you specify in PolicySourceArn, if you specified a user. If you\n include both a PolicySourceArn (for example,\n arn:aws:iam::123456789012:user/David) and a CallerArn (for\n example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate\n calling the API operations as Bob, as if Bob had David's policies.

\n

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed\n role, federated user, or a service principal.

\n

\n CallerArn is required if you include a ResourcePolicy and the\n PolicySourceArn is not the ARN for an IAM user. This is required so that\n the resource-based policy's Principal element has a value to use in evaluating\n the policy.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

" + } } } }, @@ -9610,10 +9610,10 @@ "com.amazonaws.iam#Statement": { "type": "structure", "members": { - "SourcePolicyId": { - "target": "com.amazonaws.iam#PolicyIdentifierType", + "SourcePolicyType": { + "target": "com.amazonaws.iam#PolicySourceType", "traits": { - "smithy.api#documentation": "

The identifier of the policy that was provided as an input.

" + "smithy.api#documentation": "

The type of the policy.

" } }, "EndPosition": { @@ -9622,17 +9622,17 @@ "smithy.api#documentation": "

The row and column of the end of a Statement in an IAM policy.

" } }, - "SourcePolicyType": { - "target": "com.amazonaws.iam#PolicySourceType", - "traits": { - "smithy.api#documentation": "

The type of the policy.

" - } - }, "StartPosition": { "target": "com.amazonaws.iam#Position", "traits": { "smithy.api#documentation": "

The row and column of the beginning of the Statement in an IAM\n policy.

" } + }, + "SourcePolicyId": { + "target": "com.amazonaws.iam#PolicyIdentifierType", + "traits": { + "smithy.api#documentation": "

The identifier of the policy that was provided as an input.

" + } } }, "traits": { @@ -9648,17 +9648,17 @@ "com.amazonaws.iam#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.iam#tagKeyType", + "Value": { + "target": "com.amazonaws.iam#tagValueType", "traits": { - "smithy.api#documentation": "

The key name that can be used to look up or retrieve the associated value. For example,\n Department or Cost Center are common choices.

", + "smithy.api#documentation": "

The value associated with this tag. For example, tags with a key name of\n Department could have values such as Human Resources,\n Accounting, and Support. Tags with a key name of Cost\n Center might have values that consist of the number associated with the different\n cost centers in your company. Typically, many resources have tags with the same key name but\n with different values.

\n \n

AWS always interprets the tag Value as a single string. If you need to\n store an array, you can store comma-separated values in the string. However, you must\n interpret the value in your code.

\n ", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.iam#tagValueType", + "Key": { + "target": "com.amazonaws.iam#tagKeyType", "traits": { - "smithy.api#documentation": "

The value associated with this tag. For example, tags with a key name of\n Department could have values such as Human Resources,\n Accounting, and Support. Tags with a key name of Cost\n Center might have values that consist of the number associated with the different\n cost centers in your company. Typically, many resources have tags with the same key name but\n with different values.

\n \n

AWS always interprets the tag Value as a single string. If you need to\n store an array, you can store comma-separated values in the string. However, you must\n interpret the value in your code.

\n ", + "smithy.api#documentation": "

The key name that can be used to look up or retrieve the associated value. For example,\n Department or Cost Center are common choices.

", "smithy.api#required": {} } } @@ -9760,19 +9760,19 @@ "com.amazonaws.iam#TrackedActionLastAccessed": { "type": "structure", "members": { - "LastAccessedTime": { - "target": "com.amazonaws.iam#dateType", + "LastAccessedRegion": { + "target": "com.amazonaws.iam#stringType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n tracked service. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" + "smithy.api#documentation": "

The Region from which the authenticated entity (user or role) last attempted to access\n the tracked action. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" } }, "LastAccessedEntity": { "target": "com.amazonaws.iam#arnType" }, - "LastAccessedRegion": { - "target": "com.amazonaws.iam#stringType", + "LastAccessedTime": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The Region from which the authenticated entity (user or role) last attempted to access\n the tracked action. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n tracked service. AWS does not report unauthenticated requests.

\n

This field is null if no IAM entities attempted to access the service within the\n reporting period.

" } }, "ActionName": { @@ -9841,17 +9841,17 @@ "com.amazonaws.iam#UntagRoleRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", "traits": { - "smithy.api#documentation": "

The name of the IAM role from which you want to remove tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified role.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.iam#tagKeyListType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified role.

", + "smithy.api#documentation": "

The name of the IAM role from which you want to remove tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } } @@ -9880,17 +9880,17 @@ "com.amazonaws.iam#UntagUserRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.iam#existingUserNameType", + "TagKeys": { + "target": "com.amazonaws.iam#tagKeyListType", "traits": { - "smithy.api#documentation": "

The name of the IAM user from which you want to remove tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-

", + "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified user.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.iam#tagKeyListType", + "UserName": { + "target": "com.amazonaws.iam#existingUserNameType", "traits": { - "smithy.api#documentation": "

A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified user.

", + "smithy.api#documentation": "

The name of the IAM user from which you want to remove tags.

\n

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-

", "smithy.api#required": {} } } @@ -9925,17 +9925,17 @@ "smithy.api#documentation": "

The name of the user whose key you want to update.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" } }, - "Status": { - "target": "com.amazonaws.iam#statusType", + "AccessKeyId": { + "target": "com.amazonaws.iam#accessKeyIdType", "traits": { - "smithy.api#documentation": "

The status you want to assign to the secret access key. Active means that\n the key can be used for API calls to AWS, while Inactive means that the key\n cannot be used.

", + "smithy.api#documentation": "

The access key ID of the secret access key you want to update.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", "smithy.api#required": {} } }, - "AccessKeyId": { - "target": "com.amazonaws.iam#accessKeyIdType", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The access key ID of the secret access key you want to update.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#documentation": "

The status you want to assign to the secret access key. Active means that\n the key can be used for API calls to AWS, while Inactive means that the key\n cannot be used.

", "smithy.api#required": {} } } @@ -9967,22 +9967,34 @@ "com.amazonaws.iam#UpdateAccountPasswordPolicyRequest": { "type": "structure", "members": { + "RequireLowercaseCharacters": { + "target": "com.amazonaws.iam#booleanType", + "traits": { + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one lowercase character\n from the ISO basic Latin alphabet (a to z).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n lowercase character.

" + } + }, + "PasswordReusePrevention": { + "target": "com.amazonaws.iam#passwordReusePreventionType", + "traits": { + "smithy.api#documentation": "

Specifies the number of previous passwords that IAM users are prevented from\n reusing.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 0. The result is that IAM users are not prevented from reusing\n previous passwords.

" + } + }, "HardExpiry": { "target": "com.amazonaws.iam#booleanObjectType", "traits": { "smithy.api#documentation": "

Prevents IAM users from setting a new password after their password has expired. The\n IAM user cannot be accessed until an administrator resets the password.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that IAM users can change their passwords\n after they expire and continue to sign in as the user.

" } }, - "RequireUppercaseCharacters": { - "target": "com.amazonaws.iam#booleanType", + "MaxPasswordAge": { + "target": "com.amazonaws.iam#maxPasswordAgeType", "traits": { - "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one uppercase character\n from the ISO basic Latin alphabet (A to Z).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n uppercase character.

" + "smithy.api#documentation": "

The number of days that an IAM user password is valid.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 0. The result is that IAM user passwords never expire.

" } }, - "RequireNumbers": { + "RequireUppercaseCharacters": { "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one numeric character (0 to\n 9).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n numeric character.

" + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one uppercase character\n from the ISO basic Latin alphabet (A to Z).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n uppercase character.

" } }, "RequireSymbols": { @@ -9991,34 +10003,22 @@ "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one of the following\n non-alphanumeric characters:

\n

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n symbol character.

" } }, - "MinimumPasswordLength": { - "target": "com.amazonaws.iam#minimumPasswordLengthType", - "traits": { - "smithy.api#documentation": "

The minimum number of characters allowed in an IAM user password.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 6.

" - } - }, - "PasswordReusePrevention": { - "target": "com.amazonaws.iam#passwordReusePreventionType", - "traits": { - "smithy.api#documentation": "

Specifies the number of previous passwords that IAM users are prevented from\n reusing.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 0. The result is that IAM users are not prevented from reusing\n previous passwords.

" - } - }, "AllowUsersToChangePassword": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "

Allows all IAM users in your account to use the AWS Management Console to change their own\n passwords. For more information, see Letting IAM Users Change Their Own\n Passwords in the IAM User Guide.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that IAM users in the account do not\n automatically have permissions to change their own password.

" } }, - "MaxPasswordAge": { - "target": "com.amazonaws.iam#maxPasswordAgeType", + "RequireNumbers": { + "target": "com.amazonaws.iam#booleanType", "traits": { - "smithy.api#documentation": "

The number of days that an IAM user password is valid.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 0. The result is that IAM user passwords never expire.

" + "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one numeric character (0 to\n 9).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n numeric character.

" } }, - "RequireLowercaseCharacters": { - "target": "com.amazonaws.iam#booleanType", + "MinimumPasswordLength": { + "target": "com.amazonaws.iam#minimumPasswordLengthType", "traits": { - "smithy.api#documentation": "

Specifies whether IAM user passwords must contain at least one lowercase character\n from the ISO basic Latin alphabet (a to z).

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of false. The result is that passwords do not require at least one\n lowercase character.

" + "smithy.api#documentation": "

The minimum number of characters allowed in an IAM user password.

\n

If you do not specify a value for this parameter, then the operation uses the default\n value of 6.

" } } } @@ -10052,17 +10052,17 @@ "com.amazonaws.iam#UpdateAssumeRolePolicyRequest": { "type": "structure", "members": { - "PolicyDocument": { - "target": "com.amazonaws.iam#policyDocumentType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", + "smithy.api#documentation": "

The name of the role to update with the new policy.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", "smithy.api#required": {} } }, - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "PolicyDocument": { + "target": "com.amazonaws.iam#policyDocumentType", "traits": { - "smithy.api#documentation": "

The name of the role to update with the new policy.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#documentation": "

The policy that grants an entity permission to assume the role.

\n

You must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", "smithy.api#required": {} } } @@ -10094,10 +10094,10 @@ "com.amazonaws.iam#UpdateGroupRequest": { "type": "structure", "members": { - "NewPath": { - "target": "com.amazonaws.iam#pathType", + "NewGroupName": { + "target": "com.amazonaws.iam#groupNameType", "traits": { - "smithy.api#documentation": "

New path for the IAM group. Only include this if changing the group's path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + "smithy.api#documentation": "

New name for the IAM group. Only include this if changing the group's name.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

" } }, "GroupName": { @@ -10107,10 +10107,10 @@ "smithy.api#required": {} } }, - "NewGroupName": { - "target": "com.amazonaws.iam#groupNameType", + "NewPath": { + "target": "com.amazonaws.iam#pathType", "traits": { - "smithy.api#documentation": "

New name for the IAM group. Only include this if changing the group's name.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

" + "smithy.api#documentation": "

New path for the IAM group. Only include this if changing the group's path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } } } @@ -10188,17 +10188,17 @@ "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprintRequest": { "type": "structure", "members": { - "OpenIDConnectProviderArn": { - "target": "com.amazonaws.iam#arnType", + "ThumbprintList": { + "target": "com.amazonaws.iam#thumbprintListType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you\n want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", + "smithy.api#documentation": "

A list of certificate thumbprints that are associated with the specified IAM OpenID\n Connect provider. For more information, see CreateOpenIDConnectProvider.\n

", "smithy.api#required": {} } }, - "ThumbprintList": { - "target": "com.amazonaws.iam#thumbprintListType", + "OpenIDConnectProviderArn": { + "target": "com.amazonaws.iam#arnType", "traits": { - "smithy.api#documentation": "

A list of certificate thumbprints that are associated with the specified IAM OpenID\n Connect provider. For more information, see CreateOpenIDConnectProvider.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you\n want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service \n Namespaces in the AWS General Reference.

", "smithy.api#required": {} } } @@ -10253,17 +10253,17 @@ "com.amazonaws.iam#UpdateRoleDescriptionRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.iam#roleNameType", + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", "traits": { - "smithy.api#documentation": "

The name of the role that you want to modify.

", + "smithy.api#documentation": "

The new description that you want to apply to the specified role.

", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.iam#roleDescriptionType", + "RoleName": { + "target": "com.amazonaws.iam#roleNameType", "traits": { - "smithy.api#documentation": "

The new description that you want to apply to the specified role.

", + "smithy.api#documentation": "

The name of the role that you want to modify.

", "smithy.api#required": {} } } @@ -10283,12 +10283,6 @@ "com.amazonaws.iam#UpdateRoleRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.iam#roleDescriptionType", - "traits": { - "smithy.api#documentation": "

The new description that you want to apply to the specified role.

" - } - }, "MaxSessionDuration": { "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { @@ -10301,6 +10295,12 @@ "smithy.api#documentation": "

The name of the role that you want to modify.

", "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.iam#roleDescriptionType", + "traits": { + "smithy.api#documentation": "

The new description that you want to apply to the specified role.

" + } } } }, @@ -10384,10 +10384,10 @@ "com.amazonaws.iam#UpdateSSHPublicKeyRequest": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.iam#statusType", + "SSHPublicKeyId": { + "target": "com.amazonaws.iam#publicKeyIdType", "traits": { - "smithy.api#documentation": "

The status to assign to the SSH public key. Active means that the key can\n be used for authentication with an AWS CodeCommit repository. Inactive means that the\n key cannot be used.

", + "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", "smithy.api#required": {} } }, @@ -10398,10 +10398,10 @@ "smithy.api#required": {} } }, - "SSHPublicKeyId": { - "target": "com.amazonaws.iam#publicKeyIdType", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The unique identifier for the SSH public key.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#documentation": "

The status to assign to the SSH public key. Active means that the key can\n be used for authentication with an AWS CodeCommit repository. Inactive means that the\n key cannot be used.

", "smithy.api#required": {} } } @@ -10433,18 +10433,18 @@ "com.amazonaws.iam#UpdateServerCertificateRequest": { "type": "structure", "members": { - "NewServerCertificateName": { - "target": "com.amazonaws.iam#serverCertificateNameType", - "traits": { - "smithy.api#documentation": "

The new name for the server certificate. Include this only if you are updating the\n server certificate's name. The name of the certificate cannot contain any spaces.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" - } - }, "NewPath": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "

The new path for the server certificate. Include this only if you are updating the\n server certificate's path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" } }, + "NewServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", + "traits": { + "smithy.api#documentation": "

The new name for the server certificate. Include this only if you are updating the\n server certificate's name. The name of the certificate cannot contain any spaces.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + }, "ServerCertificateName": { "target": "com.amazonaws.iam#serverCertificateNameType", "traits": { @@ -10471,10 +10471,10 @@ "com.amazonaws.iam#UpdateServiceSpecificCredentialRequest": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.iam#statusType", + "ServiceSpecificCredentialId": { + "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { - "smithy.api#documentation": "

The status to be assigned to the service-specific credential.

", + "smithy.api#documentation": "

The unique identifier of the service-specific credential.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", "smithy.api#required": {} } }, @@ -10484,10 +10484,10 @@ "smithy.api#documentation": "

The name of the IAM user associated with the service-specific credential. If you do\n not specify this value, then the operation assumes the user whose credentials are used to\n call the operation.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

" } }, - "ServiceSpecificCredentialId": { - "target": "com.amazonaws.iam#serviceSpecificCredentialId", + "Status": { + "target": "com.amazonaws.iam#statusType", "traits": { - "smithy.api#documentation": "

The unique identifier of the service-specific credential.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#documentation": "

The status to be assigned to the service-specific credential.

", "smithy.api#required": {} } } @@ -10516,6 +10516,13 @@ "com.amazonaws.iam#UpdateSigningCertificateRequest": { "type": "structure", "members": { + "CertificateId": { + "target": "com.amazonaws.iam#certificateIdType", + "traits": { + "smithy.api#documentation": "

The ID of the signing certificate you want to update.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", + "smithy.api#required": {} + } + }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { @@ -10528,13 +10535,6 @@ "smithy.api#documentation": "

The status you want to assign to the certificate. Active means that the\n certificate can be used for API calls to AWS Inactive means that the\n certificate cannot be used.

", "smithy.api#required": {} } - }, - "CertificateId": { - "target": "com.amazonaws.iam#certificateIdType", - "traits": { - "smithy.api#documentation": "

The ID of the signing certificate you want to update.

\n

This parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.

", - "smithy.api#required": {} - } } } }, @@ -10570,12 +10570,6 @@ "com.amazonaws.iam#UpdateUserRequest": { "type": "structure", "members": { - "NewPath": { - "target": "com.amazonaws.iam#pathType", - "traits": { - "smithy.api#documentation": "

New path for the IAM user. Include this parameter only if you're changing the user's\n path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" - } - }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { @@ -10588,6 +10582,12 @@ "traits": { "smithy.api#documentation": "

New name for the user. Include this parameter only if you're changing the user's\n name.

\n

IAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both \"MyResource\"\n and \"myresource\".

" } + }, + "NewPath": { + "target": "com.amazonaws.iam#pathType", + "traits": { + "smithy.api#documentation": "

New path for the IAM user. Include this parameter only if you're changing the user's\n path.

\n

This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

" + } } } }, @@ -10685,17 +10685,17 @@ "com.amazonaws.iam#UploadServerCertificateRequest": { "type": "structure", "members": { - "PrivateKey": { - "target": "com.amazonaws.iam#privateKeyType", + "CertificateChain": { + "target": "com.amazonaws.iam#certificateChainType", "traits": { - "smithy.api#documentation": "

The contents of the private key in PEM-encoded format.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The contents of the certificate chain. This is typically a concatenation of the\n PEM-encoded public key certificates of the chain.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " } }, - "Path": { - "target": "com.amazonaws.iam#pathType", + "ServerCertificateName": { + "target": "com.amazonaws.iam#serverCertificateNameType", "traits": { - "smithy.api#documentation": "

The path for the server certificate. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

\n \n

If you are uploading a server certificate specifically for use with Amazon\n CloudFront distributions, you must specify a path using the path parameter.\n The path must begin with /cloudfront and must include a trailing slash (for\n example, /cloudfront/test/).

\n " + "smithy.api#documentation": "

The name for the server certificate. Do not include the path in this value. The name of\n the certificate cannot contain any spaces.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", + "smithy.api#required": {} } }, "CertificateBody": { @@ -10705,17 +10705,17 @@ "smithy.api#required": {} } }, - "CertificateChain": { - "target": "com.amazonaws.iam#certificateChainType", + "PrivateKey": { + "target": "com.amazonaws.iam#privateKeyType", "traits": { - "smithy.api#documentation": "

The contents of the certificate chain. This is typically a concatenation of the\n PEM-encoded public key certificates of the chain.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n " + "smithy.api#documentation": "

The contents of the private key in PEM-encoded format.

\n

The regex pattern \n used to validate this parameter is a string of characters consisting of the following:

\n ", + "smithy.api#required": {} } }, - "ServerCertificateName": { - "target": "com.amazonaws.iam#serverCertificateNameType", + "Path": { + "target": "com.amazonaws.iam#pathType", "traits": { - "smithy.api#documentation": "

The name for the server certificate. Do not include the path in this value. The name of\n the certificate cannot contain any spaces.

\n

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-

", - "smithy.api#required": {} + "smithy.api#documentation": "

The path for the server certificate. For more information about paths, see IAM\n Identifiers in the IAM User Guide.

\n

This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including \n most punctuation characters, digits, and upper and lowercased letters.

\n \n

If you are uploading a server certificate specifically for use with Amazon\n CloudFront distributions, you must specify a path using the path parameter.\n The path must begin with /cloudfront and must include a trailing slash (for\n example, /cloudfront/test/).

\n " } } } @@ -10805,30 +10805,31 @@ "com.amazonaws.iam#User": { "type": "structure", "members": { - "UserId": { - "target": "com.amazonaws.iam#idType", + "UserName": { + "target": "com.amazonaws.iam#userNameType", "traits": { - "smithy.api#documentation": "

The stable and unique string identifying the user. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

", + "smithy.api#documentation": "

The friendly name identifying the user.

", "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "Path": { + "target": "com.amazonaws.iam#pathType", "traits": { - "smithy.api#documentation": "

The friendly name identifying the user.

", + "smithy.api#documentation": "

The path to the user. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

", "smithy.api#required": {} } }, - "PasswordLastUsed": { - "target": "com.amazonaws.iam#dateType", + "Tags": { + "target": "com.amazonaws.iam#tagListType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user's password was last used to sign in to an AWS website. For\n a list of AWS websites that capture a user's last sign-in time, see the Credential\n Reports topic in the IAM User Guide. If a password is\n used more than once in a five-minute span, only the first use is returned in this field. If\n the field is null (no value), then it indicates that they never signed in with a password.\n This can be because:

\n \n

A null value does not mean that the user never had a password.\n Also, if the user does not currently have a password but had one in the past, then this\n field contains the date and time the most recent password was used.

\n

This value is returned only in the GetUser and ListUsers operations.

" + "smithy.api#documentation": "

A list of tags that are associated with the specified user. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" } }, - "PermissionsBoundary": { - "target": "com.amazonaws.iam#AttachedPermissionsBoundary", + "CreateDate": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user was created.

", + "smithy.api#required": {} } }, "Arn": { @@ -10838,23 +10839,22 @@ "smithy.api#required": {} } }, - "Path": { - "target": "com.amazonaws.iam#pathType", + "PasswordLastUsed": { + "target": "com.amazonaws.iam#dateType", "traits": { - "smithy.api#documentation": "

The path to the user. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user's password was last used to sign in to an AWS website. For\n a list of AWS websites that capture a user's last sign-in time, see the Credential\n Reports topic in the IAM User Guide. If a password is\n used more than once in a five-minute span, only the first use is returned in this field. If\n the field is null (no value), then it indicates that they never signed in with a password.\n This can be because:

\n \n

A null value does not mean that the user never had a password.\n Also, if the user does not currently have a password but had one in the past, then this\n field contains the date and time the most recent password was used.

\n

This value is returned only in the GetUser and ListUsers operations.

" } }, - "Tags": { - "target": "com.amazonaws.iam#tagListType", + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", "traits": { - "smithy.api#documentation": "

A list of tags that are associated with the specified user. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" } }, - "CreateDate": { - "target": "com.amazonaws.iam#dateType", + "UserId": { + "target": "com.amazonaws.iam#idType", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user was created.

", + "smithy.api#documentation": "

The stable and unique string identifying the user. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

", "smithy.api#required": {} } } @@ -10866,25 +10866,16 @@ "com.amazonaws.iam#UserDetail": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.iam#arnType" - }, - "PermissionsBoundary": { - "target": "com.amazonaws.iam#AttachedPermissionsBoundary", - "traits": { - "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" - } - }, - "Tags": { - "target": "com.amazonaws.iam#tagListType", + "UserId": { + "target": "com.amazonaws.iam#idType", "traits": { - "smithy.api#documentation": "

A list of tags that are associated with the specified user. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" + "smithy.api#documentation": "

The stable and unique string identifying the user. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

" } }, - "GroupList": { - "target": "com.amazonaws.iam#groupNameListType", + "UserPolicyList": { + "target": "com.amazonaws.iam#policyDetailListType", "traits": { - "smithy.api#documentation": "

A list of IAM groups that the user is in.

" + "smithy.api#documentation": "

A list of the inline policies embedded in the user.

" } }, "CreateDate": { @@ -10893,10 +10884,10 @@ "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the user was created.

" } }, - "UserPolicyList": { - "target": "com.amazonaws.iam#policyDetailListType", + "GroupList": { + "target": "com.amazonaws.iam#groupNameListType", "traits": { - "smithy.api#documentation": "

A list of the inline policies embedded in the user.

" + "smithy.api#documentation": "

A list of IAM groups that the user is in.

" } }, "AttachedManagedPolicies": { @@ -10905,10 +10896,10 @@ "smithy.api#documentation": "

A list of the managed policies attached to the user.

" } }, - "UserName": { - "target": "com.amazonaws.iam#userNameType", + "PermissionsBoundary": { + "target": "com.amazonaws.iam#AttachedPermissionsBoundary", "traits": { - "smithy.api#documentation": "

The friendly name identifying the user.

" + "smithy.api#documentation": "

The ARN of the policy used to set the permissions boundary for the user.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

" } }, "Path": { @@ -10917,11 +10908,20 @@ "smithy.api#documentation": "

The path to the user. For more information about paths, see IAM Identifiers in the\n IAM User Guide.

" } }, - "UserId": { - "target": "com.amazonaws.iam#idType", + "Tags": { + "target": "com.amazonaws.iam#tagListType", "traits": { - "smithy.api#documentation": "

The stable and unique string identifying the user. For more information about IDs, see\n IAM\n Identifiers in the IAM User Guide.

" + "smithy.api#documentation": "

A list of tags that are associated with the specified user. For more information about\n tagging, see Tagging IAM\n Identities in the IAM User Guide.

" + } + }, + "UserName": { + "target": "com.amazonaws.iam#userNameType", + "traits": { + "smithy.api#documentation": "

The friendly name identifying the user.

" } + }, + "Arn": { + "target": "com.amazonaws.iam#arnType" } }, "traits": { @@ -10931,16 +10931,10 @@ "com.amazonaws.iam#VirtualMFADevice": { "type": "structure", "members": { - "QRCodePNG": { - "target": "com.amazonaws.iam#BootstrapDatum", - "traits": { - "smithy.api#documentation": "

A QR code PNG image that encodes\n otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String\n where $virtualMFADeviceName is one of the create call arguments.\n AccountName is the user name if set (otherwise, the account ID otherwise),\n and Base32String is the seed in base32 format. The Base32String\n value is base64-encoded.

" - } - }, - "EnableDate": { - "target": "com.amazonaws.iam#dateType", + "User": { + "target": "com.amazonaws.iam#User", "traits": { - "smithy.api#documentation": "

The date and time on which the virtual MFA device was enabled.

" + "smithy.api#documentation": "

The IAM user associated with this virtual MFA device.

" } }, "SerialNumber": { @@ -10950,16 +10944,22 @@ "smithy.api#required": {} } }, + "EnableDate": { + "target": "com.amazonaws.iam#dateType", + "traits": { + "smithy.api#documentation": "

The date and time on which the virtual MFA device was enabled.

" + } + }, "Base32StringSeed": { "target": "com.amazonaws.iam#BootstrapDatum", "traits": { "smithy.api#documentation": "

The base32 seed defined as specified in RFC3548. The Base32StringSeed is base64-encoded.

" } }, - "User": { - "target": "com.amazonaws.iam#User", + "QRCodePNG": { + "target": "com.amazonaws.iam#BootstrapDatum", "traits": { - "smithy.api#documentation": "

The IAM user associated with this virtual MFA device.

" + "smithy.api#documentation": "

A QR code PNG image that encodes\n otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String\n where $virtualMFADeviceName is one of the create call arguments.\n AccountName is the user name if set (otherwise, the account ID otherwise),\n and Base32String is the seed in base32 format. The Base32String\n value is base64-encoded.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/identitystore.2020-06-15.json b/codegen/sdk-codegen/aws-models/identitystore.2020-06-15.json new file mode 100644 index 000000000000..7a94889629d5 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/identitystore.2020-06-15.json @@ -0,0 +1,669 @@ +{ + "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.identitystore#AWSIdentityStore": { + "type": "service", + "version": "2020-06-15", + "operations": [ + { + "target": "com.amazonaws.identitystore#DescribeGroup" + }, + { + "target": "com.amazonaws.identitystore#DescribeUser" + }, + { + "target": "com.amazonaws.identitystore#ListGroups" + }, + { + "target": "com.amazonaws.identitystore#ListUsers" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "identitystore", + "arnNamespace": "identitystore", + "cloudFormationName": "Identitystore", + "cloudTrailEventSource": "identitystore.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "identitystore" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#title": "AWS SSO Identity Store" + } + }, + "com.amazonaws.identitystore#AccessDeniedException": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.identitystore#RequestId", + "traits": { + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + } + }, + "Message": { + "target": "com.amazonaws.identitystore#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.identitystore#AttributePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}  ]+" + } + }, + "com.amazonaws.identitystore#DescribeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.identitystore#DescribeGroupRequest" + }, + "output": { + "target": "com.amazonaws.identitystore#DescribeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.identitystore#AccessDeniedException" + }, + { + "target": "com.amazonaws.identitystore#InternalServerException" + }, + { + "target": "com.amazonaws.identitystore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.identitystore#ThrottlingException" + }, + { + "target": "com.amazonaws.identitystore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the group metadata and attributes from GroupId in an identity store.

" + } + }, + "com.amazonaws.identitystore#DescribeGroupRequest": { + "type": "structure", + "members": { + "IdentityStoreId": { + "target": "com.amazonaws.identitystore#IdentityStoreId", + "traits": { + "smithy.api#documentation": "

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

", + "smithy.api#required": {} + } + }, + "GroupId": { + "target": "com.amazonaws.identitystore#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for a group in the identity store.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.identitystore#DescribeGroupResponse": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.identitystore#GroupDisplayName", + "traits": { + "smithy.api#documentation": "

Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “<>;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

", + "smithy.api#required": {} + } + }, + "GroupId": { + "target": "com.amazonaws.identitystore#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for a group in the identity store.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.identitystore#DescribeUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.identitystore#DescribeUserRequest" + }, + "output": { + "target": "com.amazonaws.identitystore#DescribeUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.identitystore#AccessDeniedException" + }, + { + "target": "com.amazonaws.identitystore#InternalServerException" + }, + { + "target": "com.amazonaws.identitystore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.identitystore#ThrottlingException" + }, + { + "target": "com.amazonaws.identitystore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the user metadata and attributes from UserId in an identity store.

" + } + }, + "com.amazonaws.identitystore#DescribeUserRequest": { + "type": "structure", + "members": { + "IdentityStoreId": { + "target": "com.amazonaws.identitystore#IdentityStoreId", + "traits": { + "smithy.api#documentation": "

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.identitystore#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for a user in the identity store.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.identitystore#DescribeUserResponse": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.identitystore#UserName", + "traits": { + "smithy.api#documentation": "

Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “<>;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.identitystore#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for a user in the identity store.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.identitystore#Filter": { + "type": "structure", + "members": { + "AttributeValue": { + "target": "com.amazonaws.identitystore#SensitiveStringType", + "traits": { + "smithy.api#documentation": "

Represents the data for an attribute. Each attribute value is described as a name-value pair.

", + "smithy.api#required": {} + } + }, + "AttributePath": { + "target": "com.amazonaws.identitystore#AttributePath", + "traits": { + "smithy.api#documentation": "

The attribute path used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A query filter used by ListUsers and ListGroup. This filter object provides the attribute name and attribute value to search users or groups.

" + } + }, + "com.amazonaws.identitystore#Filters": { + "type": "list", + "member": { + "target": "com.amazonaws.identitystore#Filter" + } + }, + "com.amazonaws.identitystore#Group": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.identitystore#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for a group in the identity store.

", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.identitystore#GroupDisplayName", + "traits": { + "smithy.api#documentation": "

Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “<>;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A group object, which contains a specified group’s metadata and attributes.

" + } + }, + "com.amazonaws.identitystore#GroupDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r  ]+" + } + }, + "com.amazonaws.identitystore#Groups": { + "type": "list", + "member": { + "target": "com.amazonaws.identitystore#Group" + } + }, + "com.amazonaws.identitystore#IdentityStoreId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 12 + }, + "smithy.api#pattern": "^d-[0-9a-f]{10}$" + } + }, + "com.amazonaws.identitystore#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.identitystore#Message" + }, + "RequestId": { + "target": "com.amazonaws.identitystore#RequestId", + "traits": { + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure with an internal server.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.identitystore#ListGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.identitystore#ListGroupsRequest" + }, + "output": { + "target": "com.amazonaws.identitystore#ListGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.identitystore#AccessDeniedException" + }, + { + "target": "com.amazonaws.identitystore#InternalServerException" + }, + { + "target": "com.amazonaws.identitystore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.identitystore#ThrottlingException" + }, + { + "target": "com.amazonaws.identitystore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.identitystore#ListGroupsRequest": { + "type": "structure", + "members": { + "IdentityStoreId": { + "target": "com.amazonaws.identitystore#IdentityStoreId", + "traits": { + "smithy.api#documentation": "

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.identitystore#Filters", + "traits": { + "smithy.api#documentation": "

A list of Filter objects, which is used in the ListUsers and ListGroups request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.identitystore#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.identitystore#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

" + } + } + } + }, + "com.amazonaws.identitystore#ListGroupsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.identitystore#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

" + } + }, + "Groups": { + "target": "com.amazonaws.identitystore#Groups", + "traits": { + "smithy.api#documentation": "

A list of Group objects in the identity store.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.identitystore#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.identitystore#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.identitystore#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.identitystore#AccessDeniedException" + }, + { + "target": "com.amazonaws.identitystore#InternalServerException" + }, + { + "target": "com.amazonaws.identitystore#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.identitystore#ThrottlingException" + }, + { + "target": "com.amazonaws.identitystore#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.identitystore#ListUsersRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.identitystore#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

" + } + }, + "IdentityStoreId": { + "target": "com.amazonaws.identitystore#IdentityStoreId", + "traits": { + "smithy.api#documentation": "

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.identitystore#Filters", + "traits": { + "smithy.api#documentation": "

A list of Filter objects, which is used in the ListUsers and ListGroups request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.identitystore#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

" + } + } + } + }, + "com.amazonaws.identitystore#ListUsersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.identitystore#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

" + } + }, + "Users": { + "target": "com.amazonaws.identitystore#Users", + "traits": { + "smithy.api#documentation": "

A list of User objects in the identity store.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.identitystore#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.identitystore#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.identitystore#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9+=/:]*" + } + }, + "com.amazonaws.identitystore#RequestId": { + "type": "string", + "traits": { + "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.identitystore#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 47 + }, + "smithy.api#pattern": "^([0-9a-f]{10}-|)[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.identitystore#ResourceNotFoundException": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.identitystore#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource in the Identity Store service, which is an enum object. Valid values include USER, GROUP, and IDENTITY_STORE.

" + } + }, + "RequestId": { + "target": "com.amazonaws.identitystore#RequestId", + "traits": { + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + } + }, + "Message": { + "target": "com.amazonaws.identitystore#Message" + }, + "ResourceId": { + "target": "com.amazonaws.identitystore#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for a resource in the identity store, which can be used as UserId or GroupId. The format for ResourceId is either UUID or 1234567890-UUID, where UUID is a randomly generated value for each resource when it is created and 1234567890 represents the IdentityStoreId string value. In the case that the identity store is migrated from a legacy SSO identity store, the ResourceId for that identity store will be in the format of UUID. Otherwise, it will be in the 1234567890-UUID format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates that a requested resource is not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.identitystore#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GROUP", + "name": "GROUP" + }, + { + "value": "USER", + "name": "USER" + }, + { + "value": "IDENTITY_STORE", + "name": "IDENTITY_STORE" + } + ] + } + }, + "com.amazonaws.identitystore#SensitiveStringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r  ]+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.identitystore#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.identitystore#Message" + }, + "RequestId": { + "target": "com.amazonaws.identitystore#RequestId", + "traits": { + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates that the principal has crossed the throttling limits of the API operations.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.identitystore#User": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.identitystore#UserName", + "traits": { + "smithy.api#documentation": "

Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “<>;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.identitystore#ResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for a user in the identity store.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A user object, which contains a specified user’s metadata and attributes.

" + } + }, + "com.amazonaws.identitystore#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.identitystore#Users": { + "type": "list", + "member": { + "target": "com.amazonaws.identitystore#User" + } + }, + "com.amazonaws.identitystore#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.identitystore#Message" + }, + "RequestId": { + "target": "com.amazonaws.identitystore#RequestId", + "traits": { + "smithy.api#documentation": "

The identifier for each request. This value is a globally unique ID that is generated by the Identity Store service for each sent request, and is then returned inside the exception if the request fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because it contains a syntax error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} 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 cb89a28fb34b..c0b1d9bc0f9c 100644 --- a/codegen/sdk-codegen/aws-models/imagebuilder.2019-12-02.json +++ b/codegen/sdk-codegen/aws-models/imagebuilder.2019-12-02.json @@ -29,40 +29,58 @@ ] }, "shapes": { + "com.amazonaws.imagebuilder#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, "com.amazonaws.imagebuilder#AccountList": { "type": "list", "member": { - "target": "com.amazonaws.imagebuilder#NonEmptyString" + "target": "com.amazonaws.imagebuilder#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } } }, "com.amazonaws.imagebuilder#Ami": { "type": "structure", "members": { + "state": { + "target": "com.amazonaws.imagebuilder#ImageState" + }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the EC2 AMI.

" } }, - "image": { + "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AMI ID of the EC2 AMI.

" + "smithy.api#documentation": "

The AWS Region of the EC2 AMI.

" } }, - "state": { - "target": "com.amazonaws.imagebuilder#ImageState" - }, "name": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the EC2 AMI.

" } }, - "region": { + "image": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Region of the EC2 AMI.

" + "smithy.api#documentation": "

The AMI ID of the EC2 AMI.

" + } + }, + "accountId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The account ID of the owner of the AMI.\n

" } } }, @@ -73,16 +91,22 @@ "com.amazonaws.imagebuilder#AmiDistributionConfiguration": { "type": "structure", "members": { - "amiTags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "targetAccountIds": { + "target": "com.amazonaws.imagebuilder#AccountList", "traits": { - "smithy.api#documentation": "

The tags to apply to AMIs distributed to this Region.

" + "smithy.api#documentation": "

\n The ID of an account to which you want to distribute an image.\n

" } }, - "description": { + "launchPermission": { + "target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration", + "traits": { + "smithy.api#documentation": "

Launch permissions can be used to configure which AWS accounts can use the AMI to launch\n instances.

" + } + }, + "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" + "smithy.api#documentation": "

\n The KMS key identifier used to encrypt the distributed image. \n

" } }, "name": { @@ -91,16 +115,16 @@ "smithy.api#documentation": "

The name of the distribution configuration.

" } }, - "launchPermission": { - "target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration", + "amiTags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.

" + "smithy.api#documentation": "

The tags to apply to AMIs distributed to this Region.

" } }, - "kmsKeyId": { + "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key identifier used to encrypt the distributed image.

" + "smithy.api#documentation": "

The description of the distribution configuration.

" } } }, @@ -127,12 +151,6 @@ "com.amazonaws.imagebuilder#Arn": { "type": "string" }, - "com.amazonaws.imagebuilder#ArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.imagebuilder#Arn" - } - }, "com.amazonaws.imagebuilder#CallRateLimitExceededException": { "type": "structure", "members": { @@ -181,7 +199,7 @@ } ], "traits": { - "smithy.api#documentation": "

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

", + "smithy.api#documentation": "

CancelImageCreation cancels the creation of Image. This operation can only be used on\n images in a non-terminal state.

", "smithy.api#http": { "method": "PUT", "uri": "/CancelImageCreation", @@ -212,10 +230,10 @@ "com.amazonaws.imagebuilder#CancelImageCreationResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

" } }, "clientToken": { @@ -224,10 +242,10 @@ "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

" + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } } } @@ -240,7 +258,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 doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

", + "smithy.api#documentation": "

These errors are usually caused by a client action, such as using an action or resource on\n behalf of a user that doesn't have permissions to use the action or resource, or specifying an\n invalid resource identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -257,88 +275,88 @@ "com.amazonaws.imagebuilder#Component": { "type": "structure", "members": { - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", "traits": { - "smithy.api#documentation": "

The owner of the component.

" + "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n available, a prefix match is performed against the parent image OS version during image recipe\n creation.

" } }, - "changeDescription": { + "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The change description of the component.

" + "smithy.api#documentation": "

The KMS key identifier used to encrypt the component.

" } }, - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" + "smithy.api#documentation": "

The name of the component.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The tags associated with the component.

" + "smithy.api#documentation": "

The date that the component was created.

" } }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", + "changeDescription": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only to test it.

" + "smithy.api#documentation": "

The change description of the component.

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The platform of the component.

" + "smithy.api#documentation": "

The owner of the component.

" } }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "

The version of the component.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" } }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", + "data": { + "target": "com.amazonaws.imagebuilder#ComponentData", "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 data of the component.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The date that the component was created.

" + "smithy.api#documentation": "

The platform of the component.

" } }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "encrypted": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

The description of the component.

" + "smithy.api#documentation": "

The encryption status of the component.

" } }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { - "smithy.api#documentation": "

The KMS key identifier used to encrypt the component.

" + "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only\n to test it.

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { - "smithy.api#documentation": "

The name of the component.

" + "smithy.api#documentation": "

The version of the component.

" } }, - "encrypted": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The encryption status of the component.

" + "smithy.api#documentation": "

The tags associated with the component.

" } }, - "data": { - "target": "com.amazonaws.imagebuilder#ComponentData", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The data of the component.

" + "smithy.api#documentation": "

The description of the component.

" } } }, @@ -395,34 +413,40 @@ "com.amazonaws.imagebuilder#ComponentSummary": { "type": "structure", "members": { + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the component.

" + } + }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the component.

" } }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { - "smithy.api#documentation": "

The description of the component.

" + "smithy.api#documentation": "

The version of the component.

" } }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", "traits": { - "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only to test it.

" + "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n available, a prefix match is performed against the parent image OS version during image recipe\n creation.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tags associated with the component.

" + "smithy.api#documentation": "

The owner of the component.

" } }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The version of the component.

" + "smithy.api#documentation": "

The date that the component was created.

" } }, "arn": { @@ -431,34 +455,28 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the component.

" - } - }, - "owner": { + "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The owner of the component.

" + "smithy.api#documentation": "

The change description of the component.

" } }, - "changeDescription": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The change description of the component.

" + "smithy.api#documentation": "

The tags associated with the component.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { - "smithy.api#documentation": "

The date that the component was created.

" + "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only\n to test it.

" } }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "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 description of the component.

" } } }, @@ -490,34 +508,28 @@ "com.amazonaws.imagebuilder#ComponentVersion": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

" - } - }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The owner of the component.

" + "smithy.api#documentation": "

The name of the component.

" } }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "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 Amazon Resource Name (ARN) of the component.

" } }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The semantic version of the component.

" + "smithy.api#documentation": "

The platform of the component.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { - "smithy.api#documentation": "

The date that the component was created.

" + "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only\n to test it.

" } }, "description": { @@ -526,22 +538,28 @@ "smithy.api#documentation": "

The description of the component.

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", "traits": { - "smithy.api#documentation": "

The name of the component.

" + "smithy.api#documentation": "

\n The operating system (OS) version supported by the component. If the OS information is\n available, a prefix match is performed against the parent image OS version during image recipe\n creation. \n

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The platform of the component.

" + "smithy.api#documentation": "

The date that the component was created.

" } }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { - "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only to test it.

" + "smithy.api#documentation": "

The semantic version of the component.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the component.

" } } }, @@ -611,7 +629,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new component that can be used to build, validate, test, and assess your image.

", + "smithy.api#documentation": "

Creates a new component that can be used to build, validate, test, and assess your\n image.

", "smithy.api#http": { "method": "PUT", "uri": "/CreateComponent", @@ -622,75 +640,75 @@ "com.amazonaws.imagebuilder#CreateComponentRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the component.

" - } - }, "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.

" + "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is\n available, a prefix match is performed against the parent image OS version during image recipe\n creation.

" } }, - "semanticVersion": { - "target": "com.amazonaws.imagebuilder#VersionNumber", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "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 idempotency token of the component.

", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" + "smithy.api#documentation": "

The name of the component.

", + "smithy.api#required": {} } }, - "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 component. This version follows the semantic version syntax.\n For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date\n (2019.12.01).

", + "smithy.api#required": {} } }, - "uri": { - "target": "com.amazonaws.imagebuilder#Uri", + "platform": { + "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": "

The platform of the component.

", + "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the component.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" } }, "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.

" + "smithy.api#documentation": "

The data of the component. Used to specify the data inline. Either data or\n uri can be used to specify the data within the component.

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "changeDescription": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The platform of the component.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The change description of the component. Describes what change has been made in this\n version, or what makes this version different from other versions of this component.

" } }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The idempotency token of the component.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The tags of the component.

" } }, - "description": { + "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" + "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this 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\n access the S3 bucket. If you use S3, you can specify component content up to your service\n quota. Either data or uri can be used to specify the data within the\n component.

" } } } @@ -762,7 +780,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

", + "smithy.api#documentation": "

Creates a new distribution configuration. Distribution configurations define and configure\n the outputs of your pipeline.

", "smithy.api#http": { "method": "PUT", "uri": "/CreateDistributionConfiguration", @@ -773,12 +791,6 @@ "com.amazonaws.imagebuilder#CreateDistributionConfigurationRequest": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" - } - }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { @@ -794,17 +806,23 @@ "smithy.api#required": {} } }, + "distributions": { + "target": "com.amazonaws.imagebuilder#DistributionList", + "traits": { + "smithy.api#documentation": "

The distributions of the distribution configuration.

", + "smithy.api#required": {} + } + }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the distribution configuration.

" } }, - "distributions": { - "target": "com.amazonaws.imagebuilder#DistributionList", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The distributions of the distribution configuration.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the distribution configuration.

" } } } @@ -812,10 +830,10 @@ "com.amazonaws.imagebuilder#CreateDistributionConfigurationResponse": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was created by this\n request.

" } }, "requestId": { @@ -824,10 +842,10 @@ "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.

" + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } } } @@ -870,7 +888,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.

", + "smithy.api#documentation": "

Creates a new image. This request will create a new image along with all of the\n configured output resources defined in the distribution configuration.

", "smithy.api#http": { "method": "PUT", "uri": "/CreateImage", @@ -919,7 +937,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

", + "smithy.api#documentation": "

Creates a new image pipeline. Image pipelines enable you to automate the creation and\n distribution of images.

", "smithy.api#http": { "method": "PUT", "uri": "/CreateImagePipeline", @@ -936,11 +954,10 @@ "smithy.api#documentation": "

The tags of the image pipeline.

" } }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "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 image test configuration of the image pipeline.

" } }, "status": { @@ -949,6 +966,12 @@ "smithy.api#documentation": "

The status of the image pipeline.

" } }, + "schedule": { + "target": "com.amazonaws.imagebuilder#Schedule", + "traits": { + "smithy.api#documentation": "

The schedule of the image pipeline.

" + } + }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { @@ -957,35 +980,23 @@ "smithy.api#required": {} } }, - "schedule": { - "target": "com.amazonaws.imagebuilder#Schedule", - "traits": { - "smithy.api#documentation": "

The schedule of the image pipeline.

" - } - }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The image test configuration of the image pipeline.

" + "smithy.api#documentation": "

The description of the image pipeline.

" } }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images\n created by this image pipeline.

", "smithy.api#required": {} } }, "enhancedImageMetadataEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

" - } - }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

" + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n system (OS) version and package list. This information is used to enhance the overall\n experience of using EC2 Image Builder. Enabled by default.

" } }, "name": { @@ -995,10 +1006,17 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { - "smithy.api#documentation": "

The description of the image pipeline.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that will be used to\n configure and distribute images created by this image pipeline.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to\n build images created by this image pipeline.

", + "smithy.api#required": {} } } } @@ -1012,17 +1030,17 @@ "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } }, - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was created by this request.

" - } - }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } + }, + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was created by this request.\n

" + } } } }, @@ -1070,7 +1088,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

", + "smithy.api#documentation": "

Creates a new image recipe. Image recipes define how images are configured, tested, and\n assessed.

", "smithy.api#http": { "method": "PUT", "uri": "/CreateImageRecipe", @@ -1088,31 +1106,10 @@ "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "workingDirectory": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The working directory to be used during build and test workflows.

" - } - }, - "blockDeviceMappings": { - "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

The block device mappings of the image recipe.

" - } - }, - "parentImage": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags of the image recipe.

" } }, "name": { @@ -1128,10 +1125,11 @@ "smithy.api#documentation": "

The description of the image recipe.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tags of the image recipe.

" + "smithy.api#documentation": "

The parent image of the image recipe. The value of the string can be the ARN of the parent\n image or an AMI ID. The format for the ARN follows this example:\n arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x.\n You can provide the specific version that you want to use, or you can use a wildcard in all of\n the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and\n the AMI must be in the same Region in which you are using Image Builder.

", + "smithy.api#required": {} } }, "semanticVersion": { @@ -1140,12 +1138,38 @@ "smithy.api#documentation": "

The semantic version of the image recipe.

", "smithy.api#required": {} } + }, + "blockDeviceMappings": { + "target": "com.amazonaws.imagebuilder#InstanceBlockDeviceMappings", + "traits": { + "smithy.api#documentation": "

The block device mappings of the image recipe.

" + } + }, + "workingDirectory": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory to be used during build and test workflows.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.imagebuilder#CreateImageRecipeResponse": { "type": "structure", "members": { + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { @@ -1157,12 +1181,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was created by this request.

" } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" - } } } }, @@ -1172,26 +1190,22 @@ "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the\n environment in which your image will be built and tested.

", "smithy.api#required": {} } }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

" - } - }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

" + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { - "smithy.api#documentation": "

The tags of the image.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that defines and\n configures the outputs of your pipeline.

" } }, "imageTestsConfiguration": { @@ -1203,16 +1217,20 @@ "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#documentation": "

The Amazon Resource Name (ARN) of the image recipe that defines how images are\n configured, tested, and assessed.

", "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The tags of the image.

" + } + }, + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n system (OS) version and package list. This information is used to enhance the overall\n experience of using EC2 Image Builder. Enabled by default.

" } } } @@ -1226,17 +1244,17 @@ "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } }, - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, "imageBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that was created by this request.

" } + }, + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } } } }, @@ -1281,7 +1299,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

", + "smithy.api#documentation": "

Creates a new infrastructure configuration. An infrastructure configuration defines the\n environment in which your image will be built and tested.

", "smithy.api#http": { "method": "PUT", "uri": "/CreateInfrastructureConfiguration", @@ -1292,23 +1310,16 @@ "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationRequest": { "type": "structure", "members": { - "subnetId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subnet ID in which to place the instance used to customize your EC2 AMI.

" - } - }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "instanceProfileName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your EC2 AMI.

", "smithy.api#required": {} } }, @@ -1318,60 +1329,67 @@ "smithy.api#documentation": "

The tags of the infrastructure configuration.

" } }, - "terminateInstanceOnFailure": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "securityGroupIds": { + "target": "com.amazonaws.imagebuilder#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

" + "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your EC2 AMI.

" } }, - "resourceTags": { - "target": "com.amazonaws.imagebuilder#ResourceTagMap", + "subnetId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" + "smithy.api#documentation": "

The subnet ID in which to place the instance used to customize your EC2 AMI.

" } }, - "snsTopicArn": { - "target": "com.amazonaws.imagebuilder#SnsTopicArn", + "logging": { + "target": "com.amazonaws.imagebuilder#Logging", "traits": { - "smithy.api#documentation": "

The SNS topic on which to send image build events.

" + "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" } }, - "securityGroupIds": { - "target": "com.amazonaws.imagebuilder#SecurityGroupIds", + "instanceTypes": { + "target": "com.amazonaws.imagebuilder#InstanceTypeList", "traits": { - "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your EC2 AMI.

" + "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n instance types to use for this build. The service will pick one of these instance types based\n on availability.

" } }, - "instanceProfileName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The instance profile to associate with the instance used to customize your EC2 AMI.

", + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, - "keyPair": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the infrastructure configuration.

", + "smithy.api#required": {} + } + }, + "snsTopicArn": { + "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { - "smithy.api#documentation": "

The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.

" + "smithy.api#documentation": "

The SNS topic on which to send image build events.

" } }, - "logging": { - "target": "com.amazonaws.imagebuilder#Logging", + "resourceTags": { + "target": "com.amazonaws.imagebuilder#ResourceTagMap", "traits": { - "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" + "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "terminateInstanceOnFailure": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

The name of the infrastructure configuration.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to\n false if you want Image Builder to retain the instance used to configure your AMI if the build\n or test phase of your workflow fails.

" } }, - "instanceTypes": { - "target": "com.amazonaws.imagebuilder#InstanceTypeList", + "keyPair": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

" + "smithy.api#documentation": "

The key pair of the infrastructure configuration. This can be used to log on to and debug\n the instance used to create your image.

" } } } @@ -1379,6 +1397,12 @@ "com.amazonaws.imagebuilder#CreateInfrastructureConfigurationResponse": { "type": "structure", "members": { + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by\n this request.

" + } + }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { @@ -1390,12 +1414,6 @@ "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.

" - } } } }, @@ -1458,17 +1476,17 @@ "com.amazonaws.imagebuilder#DeleteComponentResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, "componentBuildVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component build version that was deleted.

" } + }, + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } } } }, @@ -1638,17 +1656,17 @@ "com.amazonaws.imagebuilder#DeleteImagePipelineResponse": { "type": "structure", "members": { - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was deleted.

" - } - }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } + }, + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was deleted.

" + } } } }, @@ -1708,17 +1726,17 @@ "com.amazonaws.imagebuilder#DeleteImageRecipeResponse": { "type": "structure", "members": { - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was deleted.

" - } - }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } + }, + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that was deleted.

" + } } } }, @@ -1808,17 +1826,17 @@ "com.amazonaws.imagebuilder#DeleteInfrastructureConfigurationResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.

" } + }, + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } } } }, @@ -1831,18 +1849,18 @@ "smithy.api#documentation": "

The specific AMI settings (for example, launch permissions, AMI tags).

" } }, - "licenseConfigurationArns": { - "target": "com.amazonaws.imagebuilder#ArnList", - "traits": { - "smithy.api#documentation": "

The License Manager Configuration to associate with the AMI in the specified Region.

" - } - }, "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The target Region.

", "smithy.api#required": {} } + }, + "licenseConfigurationArns": { + "target": "com.amazonaws.imagebuilder#LicenseConfigurationArnList", + "traits": { + "smithy.api#documentation": "

The License Manager Configuration to associate with the AMI in the specified\n Region.

" + } } }, "traits": { @@ -1852,10 +1870,16 @@ "com.amazonaws.imagebuilder#DistributionConfiguration": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which this distribution configuration was created.

" } }, "timeoutMinutes": { @@ -1871,10 +1895,10 @@ "smithy.api#documentation": "

The name of the distribution configuration.

" } }, - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" + "smithy.api#documentation": "

The description of the distribution configuration.

" } }, "dateUpdated": { @@ -1894,12 +1918,6 @@ "traits": { "smithy.api#documentation": "

The distributions of the distribution configuration.

" } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which this distribution configuration was created.

" - } } }, "traits": { @@ -1920,23 +1938,11 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration.

" } - }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the distribution configuration was updated.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", - "traits": { - "smithy.api#documentation": "

The date on which the distribution configuration was created.

" - } - }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + }, + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The description of the distribution configuration.

" + "smithy.api#documentation": "

The date on which the distribution configuration was updated.

" } }, "name": { @@ -1945,11 +1951,23 @@ "smithy.api#documentation": "

The name of the distribution configuration.

" } }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the distribution configuration.

" + } + }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the distribution configuration.

" } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the distribution configuration was created.

" + } } }, "traits": { @@ -1971,6 +1989,7 @@ "com.amazonaws.imagebuilder#DistributionTimeoutMinutes": { "type": "integer", "traits": { + "smithy.api#box": {}, "smithy.api#range": { "min": 30, "max": 720 @@ -1986,40 +2005,40 @@ "smithy.api#documentation": "

Use to configure delete on termination of the associated device.

" } }, - "volumeType": { - "target": "com.amazonaws.imagebuilder#EbsVolumeType", + "volumeSize": { + "target": "com.amazonaws.imagebuilder#EbsVolumeSizeInteger", "traits": { - "smithy.api#documentation": "

Use to override the device's volume type.

" + "smithy.api#documentation": "

Use to override the device's volume size.

" } }, - "kmsKeyId": { + "snapshotId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

Use to configure the KMS key to use when encrypting the device.

" + "smithy.api#documentation": "

The snapshot that defines the device contents.

" } }, - "iops": { - "target": "com.amazonaws.imagebuilder#EbsIopsInteger", + "encrypted": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

Use to configure device IOPS.

" + "smithy.api#documentation": "

Use to configure device encryption.

" } }, - "snapshotId": { + "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The snapshot that defines the device contents.

" + "smithy.api#documentation": "

Use to configure the KMS key to use when encrypting the device.

" } }, - "encrypted": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "iops": { + "target": "com.amazonaws.imagebuilder#EbsIopsInteger", "traits": { - "smithy.api#documentation": "

Use to configure device encryption.

" + "smithy.api#documentation": "

Use to configure device IOPS.

" } }, - "volumeSize": { - "target": "com.amazonaws.imagebuilder#EbsVolumeSizeInteger", + "volumeType": { + "target": "com.amazonaws.imagebuilder#EbsVolumeType", "traits": { - "smithy.api#documentation": "

Use to override the device's volume size.

" + "smithy.api#documentation": "

Use to override the device's volume type.

" } } }, @@ -2030,6 +2049,7 @@ "com.amazonaws.imagebuilder#EbsIopsInteger": { "type": "integer", "traits": { + "smithy.api#box": {}, "smithy.api#range": { "min": 100, "max": 10000 @@ -2039,6 +2059,7 @@ "com.amazonaws.imagebuilder#EbsVolumeSizeInteger": { "type": "integer", "traits": { + "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 16000 @@ -2051,23 +2072,27 @@ "smithy.api#enum": [ { "value": "standard", - "name": "standard" + "name": "STANDARD" }, { "value": "io1", - "name": "io1" + "name": "IO1" + }, + { + "value": "io2", + "name": "IO2" }, { "value": "gp2", - "name": "gp2" + "name": "GP2" }, { "value": "sc1", - "name": "sc1" + "name": "SC1" }, { "value": "st1", - "name": "st1" + "name": "ST1" } ] } @@ -2101,7 +2126,7 @@ } }, "traits": { - "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

" + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results from a\n list operation. Filters can be used to match a set of resources by specific criteria, such as\n tags, attributes, or IDs.

" } }, "com.amazonaws.imagebuilder#FilterList": { @@ -2263,7 +2288,7 @@ "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#documentation": "

The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires\n \"/\\d+$\" suffix.

", "smithy.api#httpQuery": "componentBuildVersionArn", "smithy.api#required": {} } @@ -2273,17 +2298,17 @@ "com.amazonaws.imagebuilder#GetComponentResponse": { "type": "structure", "members": { - "component": { - "target": "com.amazonaws.imagebuilder#Component", - "traits": { - "smithy.api#documentation": "

The component object associated with the specified ARN.

" - } - }, "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.

" + } } } }, @@ -2330,7 +2355,7 @@ "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that you want to\n retrieve.

", "smithy.api#httpQuery": "distributionConfigurationArn", "smithy.api#required": {} } @@ -2444,17 +2469,17 @@ "com.amazonaws.imagebuilder#GetImagePipelineResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, "imagePipeline": { "target": "com.amazonaws.imagebuilder#ImagePipeline", "traits": { "smithy.api#documentation": "

The image pipeline object.

" } + }, + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } } } }, @@ -2732,7 +2757,7 @@ "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n retrieve.

", "smithy.api#httpQuery": "infrastructureConfigurationArn", "smithy.api#required": {} } @@ -2745,17 +2770,17 @@ "com.amazonaws.imagebuilder#GetInfrastructureConfigurationResponse": { "type": "structure", "members": { - "infrastructureConfiguration": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", - "traits": { - "smithy.api#documentation": "

The infrastructure configuration object.

" - } - }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } + }, + "infrastructureConfiguration": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", + "traits": { + "smithy.api#documentation": "

The infrastructure configuration object.

" + } } }, "traits": { @@ -2770,7 +2795,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

", + "smithy.api#documentation": "

You have specified a client token for an operation using parameter values that differ from\n a previous request that used the same client token.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2778,16 +2803,22 @@ "com.amazonaws.imagebuilder#Image": { "type": "structure", "members": { - "distributionConfiguration": { - "target": "com.amazonaws.imagebuilder#DistributionConfiguration", + "infrastructureConfiguration": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", "traits": { - "smithy.api#documentation": "

The distribution configuration used when creating this image.

" + "smithy.api#documentation": "

The infrastructure used when creating this image.

" } }, - "sourcePipelineName": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "imageRecipe": { + "target": "com.amazonaws.imagebuilder#ImageRecipe", "traits": { - "smithy.api#documentation": "

The name of the image pipeline that created this image.

" + "smithy.api#documentation": "

The image recipe used when creating the image.

" + } + }, + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "traits": { + "smithy.api#documentation": "

The image tests configuration used when creating this image.

" } }, "outputResources": { @@ -2796,58 +2827,58 @@ "smithy.api#documentation": "

The output resources produced when creating this image.

" } }, - "sourcePipelineArn": { - "target": "com.amazonaws.imagebuilder#Arn", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that created this image.

" + "smithy.api#documentation": "

The date on which this image was created.

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "distributionConfiguration": { + "target": "com.amazonaws.imagebuilder#DistributionConfiguration", "traits": { - "smithy.api#documentation": "

The platform of the image.

" + "smithy.api#documentation": "

The distribution configuration used when creating this image.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "sourcePipelineArn": { + "target": "com.amazonaws.imagebuilder#Arn", "traits": { - "smithy.api#documentation": "

The tags of the image.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that created this image.

" } }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The semantic version of the image.

" + "smithy.api#documentation": "

The tags of the image.

" } }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

The image tests configuration used when creating this image.

" + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n system (OS) version and package list. This information is used to enhance the overall\n experience of using EC2 Image Builder. Enabled by default.

" } }, - "infrastructureConfiguration": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfiguration", + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { - "smithy.api#documentation": "

The infrastructure used when creating this image.

" + "smithy.api#documentation": "

The semantic version of the image.

" } }, - "imageRecipe": { - "target": "com.amazonaws.imagebuilder#ImageRecipe", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The image recipe used when creating the image.

" + "smithy.api#documentation": "

The name of the image.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "

The date on which this image was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" } }, - "osVersion": { - "target": "com.amazonaws.imagebuilder#OsVersion", + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" + "smithy.api#documentation": "

The platform of the image.

" } }, "state": { @@ -2856,22 +2887,16 @@ "smithy.api#documentation": "

The state of the image.

" } }, - "name": { + "sourcePipelineName": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the image.

" - } - }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

" + "smithy.api#documentation": "

The name of the image pipeline that created this image.

" } }, - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" + "smithy.api#documentation": "

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or\n Microsoft Windows Server 2019.

" } } }, @@ -2894,100 +2919,100 @@ "com.amazonaws.imagebuilder#ImagePipeline": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "schedule": { + "target": "com.amazonaws.imagebuilder#Schedule", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline.

" + "smithy.api#documentation": "

The schedule of the image pipeline.

" } }, - "status": { - "target": "com.amazonaws.imagebuilder#PipelineStatus", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The status of the image pipeline.

" + "smithy.api#documentation": "

The date on which this image pipeline was created.

" } }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#Arn", "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration associated with this\n image pipeline.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "dateNextRun": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The tags of this image pipeline.

" + "smithy.api#documentation": "

The date on which this image pipeline will next be run.

" } }, - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#Arn", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

" + "smithy.api#documentation": "

The name of the image pipeline.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

The date on which this image pipeline was created.

" + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n system (OS) version and package list. This information is used to enhance the overall\n experience of using EC2 Image Builder. Enabled by default.

" } }, - "schedule": { - "target": "com.amazonaws.imagebuilder#Schedule", + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "

The schedule of the image pipeline.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline.

" } }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "status": { + "target": "com.amazonaws.imagebuilder#PipelineStatus", "traits": { - "smithy.api#documentation": "

The image tests configuration of the image pipeline.

" + "smithy.api#documentation": "

The status of the image pipeline.

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#Arn", "traits": { - "smithy.api#documentation": "

The platform of the image pipeline.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this\n image pipeline.

" } }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date on which this image pipeline was last updated.

" + "smithy.api#documentation": "

The description of the image pipeline.

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#Arn", "traits": { - "smithy.api#documentation": "

The name of the image pipeline.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe associated with this image\n pipeline.

" } }, - "dateNextRun": { + "dateLastRun": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The date on which this image pipeline will next be run.

" + "smithy.api#documentation": "

The date on which this image pipeline was last run.

" } }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The description of the image pipeline.

" + "smithy.api#documentation": "

The date on which this image pipeline was last updated.

" } }, - "dateLastRun": { - "target": "com.amazonaws.imagebuilder#DateTime", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The date on which this image pipeline was last run.

" + "smithy.api#documentation": "

The tags of this image pipeline.

" } }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#Arn", + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

" + "smithy.api#documentation": "

The image tests configuration of the image pipeline.

" } }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#Arn", + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

" + "smithy.api#documentation": "

The platform of the image pipeline.

" } } }, @@ -3016,10 +3041,10 @@ "smithy.api#documentation": "

The owner of the image recipe.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "

The date on which this image recipe was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

" } }, "blockDeviceMappings": { @@ -3028,16 +3053,16 @@ "smithy.api#documentation": "

The block device mappings to apply when creating images from this recipe.

" } }, - "workingDirectory": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The working directory to be used during build and test workflows.

" + "smithy.api#documentation": "

The date on which this image recipe was created.

" } }, - "components": { - "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The components of the image recipe.

" + "smithy.api#documentation": "

The tags of the image recipe.

" } }, "description": { @@ -3046,22 +3071,22 @@ "smithy.api#documentation": "

The description of the image recipe.

" } }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the image recipe.

" + } + }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { "smithy.api#documentation": "

The name of the image recipe.

" } }, - "parentImage": { + "workingDirectory": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The parent image of the image recipe.

" - } - }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the image recipe.

" + "smithy.api#documentation": "

The working directory to be used during build and test workflows.

" } }, "version": { @@ -3070,16 +3095,16 @@ "smithy.api#documentation": "

The version of the image recipe.

" } }, - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "components": { + "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

" + "smithy.api#documentation": "

The components of the image recipe.

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The platform of the image recipe.

" + "smithy.api#documentation": "

The parent image of the image recipe.

" } } }, @@ -3096,34 +3121,28 @@ "com.amazonaws.imagebuilder#ImageRecipeSummary": { "type": "structure", "members": { - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the image recipe.

" - } - }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { "smithy.api#documentation": "

The tags of the image recipe.

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The name of the image recipe.

" + "smithy.api#documentation": "

The platform of the image recipe.

" } }, - "parentImage": { + "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The parent image of the image recipe.

" + "smithy.api#documentation": "

The owner of the image recipe.

" } }, - "owner": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The owner of the image recipe.

" + "smithy.api#documentation": "

The date on which this image recipe was created.

" } }, "arn": { @@ -3132,10 +3151,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date on which this image recipe was created.

" + "smithy.api#documentation": "

The parent image of the image recipe.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the image recipe.

" } } }, @@ -3235,22 +3260,16 @@ "smithy.api#documentation": "

The output resources produced when creating this image.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the image.

" - } - }, "owner": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The owner of the image.

" } }, - "osVersion": { - "target": "com.amazonaws.imagebuilder#OsVersion", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" + "smithy.api#documentation": "

The tags of the image.

" } }, "version": { @@ -3259,10 +3278,10 @@ "smithy.api#documentation": "

The version of the image.

" } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "state": { + "target": "com.amazonaws.imagebuilder#ImageState", "traits": { - "smithy.api#documentation": "

The platform of the image.

" + "smithy.api#documentation": "

The state of the image.

" } }, "arn": { @@ -3277,10 +3296,16 @@ "smithy.api#documentation": "

The name of the image.

" } }, - "state": { - "target": "com.amazonaws.imagebuilder#ImageState", + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { - "smithy.api#documentation": "

The state of the image.

" + "smithy.api#documentation": "

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or\n Microsoft Windows Server 2019.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the image.

" } } }, @@ -3317,6 +3342,7 @@ "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes": { "type": "integer", "traits": { + "smithy.api#box": {}, "smithy.api#range": { "min": 60, "max": 1440 @@ -3326,28 +3352,28 @@ "com.amazonaws.imagebuilder#ImageVersion": { "type": "structure", "members": { - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "version": { + "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { - "smithy.api#documentation": "

The platform of the image semantic version.

" + "smithy.api#documentation": "

The semantic version of the image semantic version.

" } }, "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { - "smithy.api#documentation": "

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

" + "smithy.api#documentation": "

\n The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or\n Microsoft Windows Server 2019. \n

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The name of the image semantic version.

" + "smithy.api#documentation": "

The platform of the image semantic version.

" } }, - "version": { - "target": "com.amazonaws.imagebuilder#VersionNumber", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The semantic version of the image semantic version.

" + "smithy.api#documentation": "

The date at which this image semantic version was created.

" } }, "arn": { @@ -3362,10 +3388,10 @@ "smithy.api#documentation": "

The owner of the image semantic version.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The date at which this image semantic version was created.

" + "smithy.api#documentation": "

The name of the image semantic version.

" } } }, @@ -3446,80 +3472,80 @@ "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#documentation": "

The semantic version of the component. This version follows the semantic version syntax.\n For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date\n (2019.12.01).

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "uri": { + "target": "com.amazonaws.imagebuilder#Uri", "traits": { - "smithy.api#documentation": "

The name of the component.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The uri of the component. Must be an S3 URL and the requester must have permission to\n access the S3 bucket. If you use S3, you can specify component content up to your service\n quota. Either data or uri can be used to specify the data within the\n component.

" } }, - "uri": { - "target": "com.amazonaws.imagebuilder#Uri", + "format": { + "target": "com.amazonaws.imagebuilder#ComponentFormat", "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": "

The format of the resource that you want to import as a component.

", + "smithy.api#required": {} } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The platform of the component.

", + "smithy.api#documentation": "

The idempotency token of the component.

", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.imagebuilder#ComponentType", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only to test it.

", + "smithy.api#documentation": "

The name of the component.

", "smithy.api#required": {} } }, - "description": { + "changeDescription": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" + "smithy.api#documentation": "

The change description of the component. Describes what change has been made in this\n version, or what makes this version different from other versions of this component.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "data": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tags of the component.

" + "smithy.api#documentation": "

The data of the component. Used to specify the data inline. Either data or\n uri can be used to specify the data within the component.

" } }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The idempotency token of the component.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" } }, - "changeDescription": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "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 tags of the component.

" } }, - "kmsKeyId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" + "smithy.api#documentation": "

The platform of the component.

", + "smithy.api#required": {} } }, - "format": { - "target": "com.amazonaws.imagebuilder#ComponentFormat", + "type": { + "target": "com.amazonaws.imagebuilder#ComponentType", "traits": { - "smithy.api#documentation": "

The format of the resource that you want to import as a component.

", + "smithy.api#documentation": "

The type of the component denotes whether the component is used to build the image or only\n to test it.

", "smithy.api#required": {} } }, - "data": { + "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "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 description of the component. Describes the contents of the component.

" } } } @@ -3533,51 +3559,51 @@ "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 imported component.

" } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } } } }, "com.amazonaws.imagebuilder#InfrastructureConfiguration": { "type": "structure", "members": { - "description": { + "keyPair": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The description of the infrastructure configuration.

" + "smithy.api#documentation": "

The EC2 key pair of the infrastructure configuration.

" } }, - "securityGroupIds": { - "target": "com.amazonaws.imagebuilder#SecurityGroupIds", + "snsTopicArn": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The security group IDs of the infrastructure configuration.

" + "smithy.api#documentation": "

The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.

" } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The tags of the infrastructure configuration.

" + "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" } }, - "dateUpdated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "instanceProfileName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" + "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" } }, - "terminateInstanceOnFailure": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "logging": { + "target": "com.amazonaws.imagebuilder#Logging", "traits": { - "smithy.api#documentation": "

The terminate instance on failure configuration of the infrastructure configuration.

" + "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" } }, "subnetId": { @@ -3586,58 +3612,58 @@ "smithy.api#documentation": "

The subnet ID of the infrastructure configuration.

" } }, - "instanceProfileName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The instance profile of the infrastructure configuration.

" + "smithy.api#documentation": "

The tags of the infrastructure configuration.

" } }, - "keyPair": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "dateUpdated": { + "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "

The EC2 key pair of the infrastructure configuration.

" + "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the infrastructure configuration.

" + "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, - "snsTopicArn": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "securityGroupIds": { + "target": "com.amazonaws.imagebuilder#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.

" + "smithy.api#documentation": "

The security group IDs of the infrastructure configuration.

" } }, - "arn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "instanceTypes": { + "target": "com.amazonaws.imagebuilder#InstanceTypeList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" + "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" } }, - "resourceTags": { - "target": "com.amazonaws.imagebuilder#ResourceTagMap", + "terminateInstanceOnFailure": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" + "smithy.api#documentation": "

The terminate instance on failure configuration of the infrastructure\n configuration.

" } }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" } }, - "logging": { - "target": "com.amazonaws.imagebuilder#Logging", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" + "smithy.api#documentation": "

The name of the infrastructure configuration.

" } }, - "instanceTypes": { - "target": "com.amazonaws.imagebuilder#InstanceTypeList", + "resourceTags": { + "target": "com.amazonaws.imagebuilder#ResourceTagMap", "traits": { - "smithy.api#documentation": "

The instance types of the infrastructure configuration.

" + "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" } } }, @@ -3660,6 +3686,18 @@ "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" + } + }, + "resourceTags": { + "target": "com.amazonaws.imagebuilder#ResourceTagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the image created by Image Builder.

" + } + }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { @@ -3672,28 +3710,16 @@ "smithy.api#documentation": "

The date on which the infrastructure configuration was last updated.

" } }, - "name": { - "target": "com.amazonaws.imagebuilder#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the infrastructure configuration.

" - } - }, "arn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration.

" } }, - "resourceTags": { - "target": "com.amazonaws.imagebuilder#ResourceTagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the image created by Image Builder.

" - } - }, - "dateCreated": { - "target": "com.amazonaws.imagebuilder#DateTime", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The date on which the infrastructure configuration was created.

" + "smithy.api#documentation": "

The name of the infrastructure configuration.

" } } }, @@ -3719,10 +3745,10 @@ "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping": { "type": "structure", "members": { - "noDevice": { - "target": "com.amazonaws.imagebuilder#EmptyString", + "virtualName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

Use to remove a mapping from the parent image.

" + "smithy.api#documentation": "

Use to manage instance ephemeral devices.

" } }, "deviceName": { @@ -3737,10 +3763,10 @@ "smithy.api#documentation": "

Use to manage Amazon EBS-specific configuration for this mapping.

" } }, - "virtualName": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "noDevice": { + "target": "com.amazonaws.imagebuilder#EmptyString", "traits": { - "smithy.api#documentation": "

Use to manage instance ephemeral devices.

" + "smithy.api#documentation": "

Use to remove a mapping from the parent image.

" } } }, @@ -3784,7 +3810,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have specified two or more mutually exclusive parameters. Review the error message for details.

", + "smithy.api#documentation": "

You have specified two or more mutually exclusive parameters. Review the error message for\n details.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3797,7 +3823,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API request.

", + "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3858,7 +3884,25 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the configuration for a launch permission. The launch permission modification request is sent to the EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at EC2 ModifyImageAttribute.

" + "smithy.api#documentation": "

Describes the configuration for a launch permission. The launch permission modification\n request is sent to the EC2 ModifyImageAttribute API on behalf of the user for each Region they have\n selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at EC2 ModifyImageAttribute.

" + } + }, + "com.amazonaws.imagebuilder#LicenseConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:license-manager:[^:]+:\\d{12}:license-configuration:lic-[a-z0-9-_]{32}$" + } + }, + "com.amazonaws.imagebuilder#LicenseConfigurationArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#LicenseConfigurationArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } } }, "com.amazonaws.imagebuilder#ListComponentBuildVersions": { @@ -3898,30 +3942,35 @@ "method": "POST", "uri": "/ListComponentBuildVersions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListComponentBuildVersionsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "componentVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentVersionArn", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

The component version Amazon Resource Name (ARN) whose versions you want to list.

", + "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, - "componentVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentVersionArn", + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The component version Amazon Resource Name (ARN) whose versions you want to list.

", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum items to return in a request.

" } } } @@ -3935,17 +3984,17 @@ "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" - } - }, "componentSummaryList": { "target": "com.amazonaws.imagebuilder#ComponentSummaryList", "traits": { "smithy.api#documentation": "

The list of component summaries for the specified semantic version.

" } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" + } } } }, @@ -3986,12 +4035,23 @@ "method": "POST", "uri": "/ListComponents", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListComponentsRequest": { "type": "structure", "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "

The owner defines which components you want to list. By default, this request will only\n show components owned by your account. You can use this field to specify if you want to view\n components owned by yourself, by Amazon, or those components that have been shared with you by\n other customers.

" + } + }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { @@ -3999,22 +4059,16 @@ "smithy.api#documentation": "

The maximum items to return in a request.

" } }, - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.

" + "smithy.api#documentation": "

The filters.

" } }, "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } } } @@ -4022,22 +4076,22 @@ "com.amazonaws.imagebuilder#ListComponentsResponse": { "type": "structure", "members": { - "componentVersionList": { - "target": "com.amazonaws.imagebuilder#ComponentVersionList", - "traits": { - "smithy.api#documentation": "

The list of component semantic versions.

" - } - }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, + "componentVersionList": { + "target": "com.amazonaws.imagebuilder#ComponentVersionList", + "traits": { + "smithy.api#documentation": "

The list of component semantic versions.

" + } + }, "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" } } } @@ -4079,6 +4133,11 @@ "method": "POST", "uri": "/ListDistributionConfigurations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, @@ -4095,13 +4154,13 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

The filters.

\n " } } } @@ -4112,13 +4171,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" - } - }, - "distributionConfigurationSummaryList": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList", - "traits": { - "smithy.api#documentation": "

The list of distributions.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" } }, "requestId": { @@ -4126,6 +4179,12 @@ "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } + }, + "distributionConfigurationSummaryList": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "

The list of distributions.

" + } } } }, @@ -4166,6 +4225,11 @@ "method": "POST", "uri": "/ListImageBuildVersions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, @@ -4175,13 +4239,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" - } - }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, "imageVersionArn": { @@ -4197,22 +4255,22 @@ "smithy.api#box": {}, "smithy.api#documentation": "

The maximum items to return in a request.

" } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

" + } } } }, "com.amazonaws.imagebuilder#ListImageBuildVersionsResponse": { "type": "structure", "members": { - "imageSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageSummaryList", - "traits": { - "smithy.api#documentation": "

The list of image build versions.

" - } - }, "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" } }, "requestId": { @@ -4220,6 +4278,12 @@ "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } + }, + "imageSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageSummaryList", + "traits": { + "smithy.api#documentation": "

The list of image build versions.

" + } } } }, @@ -4263,6 +4327,11 @@ "method": "POST", "uri": "/ListImagePipelineImages", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, @@ -4283,16 +4352,16 @@ "smithy.api#required": {} } }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + "smithy.api#documentation": "

The filters.

" } } } @@ -4300,6 +4369,12 @@ "com.amazonaws.imagebuilder#ListImagePipelineImagesResponse": { "type": "structure", "members": { + "imageSummaryList": { + "target": "com.amazonaws.imagebuilder#ImageSummaryList", + "traits": { + "smithy.api#documentation": "

The list of images built by this pipeline.

" + } + }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { @@ -4309,13 +4384,7 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" - } - }, - "imageSummaryList": { - "target": "com.amazonaws.imagebuilder#ImageSummaryList", - "traits": { - "smithy.api#documentation": "

The list of images built by this pipeline.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" } } } @@ -4357,16 +4426,28 @@ "method": "POST", "uri": "/ListImagePipelines", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImagePipelinesRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum items to return in a request.

" + } + }, "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, "filters": { @@ -4374,13 +4455,6 @@ "traits": { "smithy.api#documentation": "

The filters.

" } - }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum items to return in a request.

" - } } } }, @@ -4393,17 +4467,17 @@ "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" - } - }, "imagePipelineList": { "target": "com.amazonaws.imagebuilder#ImagePipelineList", "traits": { "smithy.api#documentation": "

The list of image pipelines.

" } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" + } } } }, @@ -4444,12 +4518,23 @@ "method": "POST", "uri": "/ListImageRecipes", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImageRecipesRequest": { "type": "structure", "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "

The owner defines which image recipes you want to list. By default, this request will only\n show image recipes owned by your account. You can use this field to specify if you want to\n view image recipes owned by yourself, by Amazon, or those image recipes that have been shared\n with you by other customers.

" + } + }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { @@ -4457,10 +4542,10 @@ "smithy.api#documentation": "

The maximum items to return in a request.

" } }, - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, "filters": { @@ -4468,12 +4553,6 @@ "traits": { "smithy.api#documentation": "

The filters.

" } - }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" - } } } }, @@ -4486,17 +4565,17 @@ "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" - } - }, "imageRecipeSummaryList": { "target": "com.amazonaws.imagebuilder#ImageRecipeSummaryList", "traits": { "smithy.api#documentation": "

The list of image pipelines.

" } + }, + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" + } } } }, @@ -4537,35 +4616,40 @@ "method": "POST", "uri": "/ListImages", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, "com.amazonaws.imagebuilder#ListImagesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + "smithy.api#documentation": "

The filters.

" } }, - "maxResults": { - "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

The owner defines which images you want to list. By default, this request will only show\n images owned by your account. You can use this field to specify if you want to view images\n owned by yourself, by Amazon, or those images that have been shared with you by other\n customers.

" } }, - "owner": { - "target": "com.amazonaws.imagebuilder#Ownership", + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum items to return in a request.

" } } } @@ -4579,16 +4663,16 @@ "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "imageVersionList": { - "target": "com.amazonaws.imagebuilder#ImageVersionList", + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The list of image semantic versions.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" } }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "imageVersionList": { + "target": "com.amazonaws.imagebuilder#ImageVersionList", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The list of image semantic versions.

" } } } @@ -4630,6 +4714,11 @@ "method": "POST", "uri": "/ListInfrastructureConfigurations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, @@ -4643,16 +4732,16 @@ "smithy.api#documentation": "

The maximum items to return in a request.

" } }, - "filters": { - "target": "com.amazonaws.imagebuilder#FilterList", + "nextToken": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously\n truncated response.

" } }, - "nextToken": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" + "smithy.api#documentation": "

The filters.

" } } } @@ -4660,12 +4749,6 @@ "com.amazonaws.imagebuilder#ListInfrastructureConfigurationsResponse": { "type": "structure", "members": { - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, "infrastructureConfigurationSummaryList": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationSummaryList", "traits": { @@ -4675,7 +4758,13 @@ "nextToken": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this is not empty, there are additional\n elements that the service has not included in this request. Use this token with the next\n request to retrieve additional objects.

" + } + }, + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } } } @@ -4756,7 +4845,10 @@ } }, "com.amazonaws.imagebuilder#NullableBoolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#box": {} + } }, "com.amazonaws.imagebuilder#OsVersion": { "type": "string", @@ -4798,15 +4890,15 @@ "smithy.api#enum": [ { "value": "Self", - "name": "Self" + "name": "SELF" }, { "value": "Shared", - "name": "Shared" + "name": "SHARED" }, { "value": "Amazon", - "name": "Amazon" + "name": "AMAZON" } ] } @@ -4847,11 +4939,11 @@ "smithy.api#enum": [ { "value": "Windows", - "name": "Windows" + "name": "WINDOWS" }, { "value": "Linux", - "name": "Linux" + "name": "LINUX" } ] } @@ -4891,7 +4983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

", + "smithy.api#documentation": "

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to\n all principals with whom the resource is shared.

", "smithy.api#http": { "method": "PUT", "uri": "/PutComponentPolicy", @@ -4902,17 +4994,17 @@ "com.amazonaws.imagebuilder#PutComponentPolicyRequest": { "type": "structure", "members": { - "policy": { - "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "componentArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", "traits": { - "smithy.api#documentation": "

The policy to apply.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy should be applied to.

", "smithy.api#required": {} } }, - "componentArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that this policy should be applied to.

", + "smithy.api#documentation": "

The policy to apply.

", "smithy.api#required": {} } } @@ -4970,7 +5062,7 @@ } ], "traits": { - "smithy.api#documentation": "

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

", + "smithy.api#documentation": "

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to\n all principals with whom the resource is shared.

", "smithy.api#http": { "method": "PUT", "uri": "/PutImagePolicy", @@ -5049,7 +5141,7 @@ } ], "traits": { - "smithy.api#documentation": "

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

", + "smithy.api#documentation": "

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API\n PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to\n all principals with whom the resource is shared.

", "smithy.api#http": { "method": "PUT", "uri": "/PutImageRecipePolicy", @@ -5114,7 +5206,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

", + "smithy.api#documentation": "

You have attempted to mutate or delete a resource with a dependency that prohibits this\n action. See the error message for more details.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5127,7 +5219,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource that you are trying to operate on is currently in use. Review the message details and retry later.

", + "smithy.api#documentation": "

The resource that you are trying to operate on is currently in use. Review the message\n details and retry later.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5187,16 +5279,16 @@ "com.amazonaws.imagebuilder#S3Logs": { "type": "structure", "members": { - "s3KeyPrefix": { + "s3BucketName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon S3 path in which to store the logs.

" + "smithy.api#documentation": "

The Amazon S3 bucket in which to store the logs.

" } }, - "s3BucketName": { + "s3KeyPrefix": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket in which to store the logs.

" + "smithy.api#documentation": "

The Amazon S3 path in which to store the logs.

" } } }, @@ -5207,16 +5299,16 @@ "com.amazonaws.imagebuilder#Schedule": { "type": "structure", "members": { - "scheduleExpression": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "pipelineExecutionStartCondition": { + "target": "com.amazonaws.imagebuilder#PipelineExecutionStartCondition", "traits": { - "smithy.api#documentation": "

The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

" + "smithy.api#documentation": "

The condition configures when the pipeline should trigger a new image build. When the\n pipelineExecutionStartCondition is set to\n EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version\n filters on the source image or components in your image recipe, EC2 Image Builder will build a\n new image only when there are new versions of the image or components in your recipe that\n match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it\n will build a new image every time the CRON expression matches the current time. For semantic\n version syntax, see CreateComponent in the EC2 Image Builder API\n Reference.

" } }, - "pipelineExecutionStartCondition": { - "target": "com.amazonaws.imagebuilder#PipelineExecutionStartCondition", + "scheduleExpression": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, EC2 Image Builder will build a new image only when there are known changes pending. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time.

" + "smithy.api#documentation": "

The cron expression determines how often EC2 Image Builder evaluates your\n pipelineExecutionStartCondition.

\n

For information on how to format a cron expression in Image Builder, see Use cron\n expressions in EC2 Image Builder.

" } } }, @@ -5324,18 +5416,18 @@ "com.amazonaws.imagebuilder#StartImagePipelineExecutionRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

", "smithy.api#required": {} } }, - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

", + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } @@ -5344,10 +5436,10 @@ "com.amazonaws.imagebuilder#StartImagePipelineExecutionResponse": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "imageBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that was created by this request.

" } }, "requestId": { @@ -5356,10 +5448,10 @@ "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "imageBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ImageBuildVersionArn", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image that was created by this request.

" + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } } } @@ -5438,18 +5530,18 @@ "com.amazonaws.imagebuilder#TagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The tags to apply to the resource.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.imagebuilder#TagMap", + "resourceArn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { - "smithy.api#documentation": "

The tags to apply to the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -5499,14 +5591,6 @@ "com.amazonaws.imagebuilder#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.imagebuilder#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.imagebuilder#ImageBuilderArn", "traits": { @@ -5514,6 +5598,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tagKeys": { + "target": "com.amazonaws.imagebuilder#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -5559,7 +5651,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

", + "smithy.api#documentation": "

Updates a new distribution configuration. Distribution configurations define and\n configure the outputs of your pipeline.

", "smithy.api#http": { "method": "PUT", "uri": "/UpdateDistributionConfiguration", @@ -5577,6 +5669,14 @@ "smithy.api#required": {} } }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token of the distribution configuration.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { @@ -5589,24 +5689,16 @@ "smithy.api#documentation": "

The distributions of the distribution configuration.

", "smithy.api#required": {} } - }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token of the distribution configuration.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.imagebuilder#UpdateDistributionConfigurationResponse": { "type": "structure", "members": { - "distributionConfigurationArn": { - "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.

" + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } }, "requestId": { @@ -5615,10 +5707,10 @@ "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "clientToken": { - "target": "com.amazonaws.imagebuilder#ClientToken", + "distributionConfigurationArn": { + "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that was updated by this\n request.

" } } } @@ -5658,7 +5750,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

", + "smithy.api#documentation": "

Updates a new image pipeline. Image pipelines enable you to automate the creation and\n distribution of images.

", "smithy.api#http": { "method": "PUT", "uri": "/UpdateImagePipeline", @@ -5689,36 +5781,37 @@ "smithy.api#documentation": "

The status of the image pipeline.

" } }, - "imageTestsConfiguration": { - "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", + "imageRecipeArn": { + "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { - "smithy.api#documentation": "

The image test configuration of the image pipeline.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images\n updated by this image pipeline.

", + "smithy.api#required": {} } }, - "enhancedImageMetadataEnabled": { - "target": "com.amazonaws.imagebuilder#NullableBoolean", + "imagePipelineArn": { + "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { - "smithy.api#documentation": "

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

", + "smithy.api#required": {} } }, "distributionConfigurationArn": { "target": "com.amazonaws.imagebuilder#DistributionConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution configuration that will be used to\n configure and distribute images updated by this image pipeline.

" } }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to\n build images updated by this image pipeline.

", "smithy.api#required": {} } }, - "imagePipelineArn": { - "target": "com.amazonaws.imagebuilder#ImagePipelineArn", + "enhancedImageMetadataEnabled": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Collects additional information about the image being created, including the operating\n system (OS) version and package list. This information is used to enhance the overall\n experience of using EC2 Image Builder. Enabled by default.

" } }, "schedule": { @@ -5727,11 +5820,10 @@ "smithy.api#documentation": "

The schedule of the image pipeline.

" } }, - "imageRecipeArn": { - "target": "com.amazonaws.imagebuilder#ImageRecipeArn", + "imageTestsConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageTestsConfiguration", "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 image test configuration of the image pipeline.

" } } } @@ -5745,17 +5837,17 @@ "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } }, - "requestId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" - } - }, "imagePipelineArn": { "target": "com.amazonaws.imagebuilder#ImagePipelineArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.

" } + }, + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } } } }, @@ -5794,7 +5886,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

", + "smithy.api#documentation": "

Updates a new infrastructure configuration. An infrastructure configuration defines the\n environment in which your image will be built and tested.

", "smithy.api#http": { "method": "PUT", "uri": "/UpdateInfrastructureConfiguration", @@ -5808,7 +5900,7 @@ "terminateInstanceOnFailure": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

" + "smithy.api#documentation": "

The terminate instance on failure setting of the infrastructure configuration. Set to\n false if you want Image Builder to retain the instance used to configure your AMI if the build\n or test phase of your workflow fails.

" } }, "resourceTags": { @@ -5817,22 +5909,35 @@ "smithy.api#documentation": "

The tags attached to the resource created by Image Builder.

" } }, - "subnetId": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "securityGroupIds": { + "target": "com.amazonaws.imagebuilder#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The subnet ID to place the instance used to customize your EC2 AMI in.

" + "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your EC2 AMI.

" } }, - "description": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "snsTopicArn": { + "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { - "smithy.api#documentation": "

The description of the infrastructure configuration.

" + "smithy.api#documentation": "

The SNS topic on which to send image build events.

" + } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to\n update.

", + "smithy.api#required": {} + } + }, + "instanceTypes": { + "target": "com.amazonaws.imagebuilder#InstanceTypeList", + "traits": { + "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more\n instance types to use for this build. The service will pick one of these instance types based\n on availability.

" } }, "keyPair": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.

" + "smithy.api#documentation": "

The key pair of the infrastructure configuration. This can be used to log on to and debug\n the instance used to create your image.

" } }, "instanceProfileName": { @@ -5856,29 +5961,16 @@ "smithy.api#documentation": "

The logging configuration of the infrastructure configuration.

" } }, - "instanceTypes": { - "target": "com.amazonaws.imagebuilder#InstanceTypeList", - "traits": { - "smithy.api#documentation": "

The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

" - } - }, - "snsTopicArn": { - "target": "com.amazonaws.imagebuilder#SnsTopicArn", - "traits": { - "smithy.api#documentation": "

The SNS topic on which to send image build events.

" - } - }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the infrastructure configuration.

" } }, - "securityGroupIds": { - "target": "com.amazonaws.imagebuilder#SecurityGroupIds", + "subnetId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The security group IDs to associate with the instance used to customize your EC2 AMI.

" + "smithy.api#documentation": "

The subnet ID to place the instance used to customize your EC2 AMI in.

" } } } @@ -5892,17 +5984,17 @@ "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" } }, - "infrastructureConfigurationArn": { - "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.

" - } - }, "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } + }, + "infrastructureConfigurationArn": { + "target": "com.amazonaws.imagebuilder#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by\n this request.

" + } } } }, @@ -6057,7 +6149,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\n creation, management, and deployment of customized, secure, and up-to-date “golden” server\n images that are pre-installed and pre-configured with software and settings to meet specific\n IT standards.

", "smithy.api#title": "EC2 Image Builder" } } diff --git a/codegen/sdk-codegen/aws-models/inspector.2016-02-16.json b/codegen/sdk-codegen/aws-models/inspector.2016-02-16.json index 9bfcea5e1cf1..23f5dc078e14 100644 --- a/codegen/sdk-codegen/aws-models/inspector.2016-02-16.json +++ b/codegen/sdk-codegen/aws-models/inspector.2016-02-16.json @@ -325,30 +325,24 @@ "com.amazonaws.inspector#AgentPreview": { "type": "structure", "members": { - "agentHealth": { - "target": "com.amazonaws.inspector#AgentHealth", - "traits": { - "smithy.api#documentation": "

The health status of the Amazon Inspector Agent.

" - } - }, "kernelVersion": { "target": "com.amazonaws.inspector#KernelVersion", "traits": { "smithy.api#documentation": "

The kernel version of the operating system running on the EC2 instance on which the\n Amazon Inspector Agent is installed.

" } }, - "operatingSystem": { - "target": "com.amazonaws.inspector#OperatingSystem", - "traits": { - "smithy.api#documentation": "

The operating system running on the EC2 instance on which the Amazon Inspector Agent\n is installed.

" - } - }, "autoScalingGroup": { "target": "com.amazonaws.inspector#AutoScalingGroup", "traits": { "smithy.api#documentation": "

The Auto Scaling group for the EC2 instance where the agent is installed.

" } }, + "operatingSystem": { + "target": "com.amazonaws.inspector#OperatingSystem", + "traits": { + "smithy.api#documentation": "

The operating system running on the EC2 instance on which the Amazon Inspector Agent\n is installed.

" + } + }, "agentVersion": { "target": "com.amazonaws.inspector#AgentVersion", "traits": { @@ -367,6 +361,12 @@ "smithy.api#documentation": "

The hostname of the EC2 instance on which the Amazon Inspector Agent is\n installed.

" } }, + "agentHealth": { + "target": "com.amazonaws.inspector#AgentHealth", + "traits": { + "smithy.api#documentation": "

The health status of the Amazon Inspector Agent.

" + } + }, "agentId": { "target": "com.amazonaws.inspector#AgentId", "traits": { @@ -410,10 +410,10 @@ "smithy.api#required": {} } }, - "agentsTruncated": { + "canRetry": { "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

You can immediately retry your request.

", "smithy.api#required": {} } }, @@ -424,10 +424,10 @@ "smithy.api#required": {} } }, - "canRetry": { + "agentsTruncated": { "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

You can immediately retry your request.

", + "smithy.api#documentation": "

", "smithy.api#required": {} } } @@ -476,107 +476,107 @@ "com.amazonaws.inspector#AssessmentRun": { "type": "structure", "members": { - "findingCounts": { - "target": "com.amazonaws.inspector#AssessmentRunFindingCounts", + "dataCollected": { + "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

Provides a total count of generated findings per severity.

", + "smithy.api#documentation": "

A Boolean value (true or false) that specifies whether the process of collecting data\n from the agents is completed.

", "smithy.api#required": {} } }, - "userAttributesForFindings": { - "target": "com.amazonaws.inspector#UserAttributeList", + "arn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The user-defined attributes that are assigned to every generated finding.

", + "smithy.api#documentation": "

The ARN of the assessment run.

", "smithy.api#required": {} } }, - "rulesPackageArns": { - "target": "com.amazonaws.inspector#AssessmentRulesPackageArnList", + "name": { + "target": "com.amazonaws.inspector#AssessmentRunName", "traits": { - "smithy.api#documentation": "

The rules packages selected for the assessment run.

", + "smithy.api#documentation": "

The auto-generated name for the assessment run.

", "smithy.api#required": {} } }, - "assessmentTemplateArn": { - "target": "com.amazonaws.inspector#Arn", + "stateChangedAt": { + "target": "com.amazonaws.inspector#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the assessment template that is associated with the assessment\n run.

", + "smithy.api#documentation": "

The last time when the assessment run's state changed.

", "smithy.api#required": {} } }, - "notifications": { - "target": "com.amazonaws.inspector#AssessmentRunNotificationList", + "stateChanges": { + "target": "com.amazonaws.inspector#AssessmentRunStateChangeList", "traits": { - "smithy.api#documentation": "

A list of notifications for the event subscriptions. A notification about a\n particular generated finding is added to this list only once.

", + "smithy.api#documentation": "

A list of the assessment run state changes.

", "smithy.api#required": {} } }, - "state": { - "target": "com.amazonaws.inspector#AssessmentRunState", + "startedAt": { + "target": "com.amazonaws.inspector#Timestamp", "traits": { - "smithy.api#documentation": "

The state of the assessment run.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The time when StartAssessmentRun was called.

" } }, - "completedAt": { + "createdAt": { "target": "com.amazonaws.inspector#Timestamp", "traits": { - "smithy.api#documentation": "

The assessment run completion time that corresponds to the rules packages evaluation\n completion time or failure.

" + "smithy.api#documentation": "

The time when StartAssessmentRun was called.

", + "smithy.api#required": {} } }, - "stateChangedAt": { - "target": "com.amazonaws.inspector#Timestamp", + "durationInSeconds": { + "target": "com.amazonaws.inspector#AssessmentRunDuration", "traits": { - "smithy.api#documentation": "

The last time when the assessment run's state changed.

", + "smithy.api#documentation": "

The duration of the assessment run.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.inspector#AssessmentRunName", + "rulesPackageArns": { + "target": "com.amazonaws.inspector#AssessmentRulesPackageArnList", "traits": { - "smithy.api#documentation": "

The auto-generated name for the assessment run.

", + "smithy.api#documentation": "

The rules packages selected for the assessment run.

", "smithy.api#required": {} } }, - "arn": { - "target": "com.amazonaws.inspector#Arn", + "userAttributesForFindings": { + "target": "com.amazonaws.inspector#UserAttributeList", "traits": { - "smithy.api#documentation": "

The ARN of the assessment run.

", + "smithy.api#documentation": "

The user-defined attributes that are assigned to every generated finding.

", "smithy.api#required": {} } }, - "startedAt": { - "target": "com.amazonaws.inspector#Timestamp", + "findingCounts": { + "target": "com.amazonaws.inspector#AssessmentRunFindingCounts", "traits": { - "smithy.api#documentation": "

The time when StartAssessmentRun was called.

" + "smithy.api#documentation": "

Provides a total count of generated findings per severity.

", + "smithy.api#required": {} } }, - "stateChanges": { - "target": "com.amazonaws.inspector#AssessmentRunStateChangeList", + "assessmentTemplateArn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

A list of the assessment run state changes.

", + "smithy.api#documentation": "

The ARN of the assessment template that is associated with the assessment\n run.

", "smithy.api#required": {} } }, - "durationInSeconds": { - "target": "com.amazonaws.inspector#AssessmentRunDuration", + "notifications": { + "target": "com.amazonaws.inspector#AssessmentRunNotificationList", "traits": { - "smithy.api#documentation": "

The duration of the assessment run.

", + "smithy.api#documentation": "

A list of notifications for the event subscriptions. A notification about a\n particular generated finding is added to this list only once.

", "smithy.api#required": {} } }, - "createdAt": { - "target": "com.amazonaws.inspector#Timestamp", + "state": { + "target": "com.amazonaws.inspector#AssessmentRunState", "traits": { - "smithy.api#documentation": "

The time when StartAssessmentRun was called.

", + "smithy.api#documentation": "

The state of the assessment run.

", "smithy.api#required": {} } }, - "dataCollected": { - "target": "com.amazonaws.inspector#Bool", + "completedAt": { + "target": "com.amazonaws.inspector#Timestamp", "traits": { - "smithy.api#documentation": "

A Boolean value (true or false) that specifies whether the process of collecting data\n from the agents is completed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The assessment run completion time that corresponds to the rules packages evaluation\n completion time or failure.

" } } }, @@ -594,23 +594,16 @@ "smithy.api#required": {} } }, - "agentHealthCode": { - "target": "com.amazonaws.inspector#AgentHealthCode", - "traits": { - "smithy.api#documentation": "

The detailed health state of the agent.

", - "smithy.api#required": {} - } - }, "autoScalingGroup": { "target": "com.amazonaws.inspector#AutoScalingGroup", "traits": { "smithy.api#documentation": "

The Auto Scaling group of the EC2 instance that is specified by the agent\n ID.

" } }, - "agentId": { - "target": "com.amazonaws.inspector#AgentId", + "agentHealthCode": { + "target": "com.amazonaws.inspector#AgentHealthCode", "traits": { - "smithy.api#documentation": "

The AWS account of the EC2 instance where the agent is installed.

", + "smithy.api#documentation": "

The detailed health state of the agent.

", "smithy.api#required": {} } }, @@ -621,6 +614,13 @@ "smithy.api#required": {} } }, + "agentId": { + "target": "com.amazonaws.inspector#AgentId", + "traits": { + "smithy.api#documentation": "

The AWS account of the EC2 instance where the agent is installed.

", + "smithy.api#required": {} + } + }, "telemetryMetadata": { "target": "com.amazonaws.inspector#TelemetryMetadataList", "traits": { @@ -663,22 +663,22 @@ "com.amazonaws.inspector#AssessmentRunFilter": { "type": "structure", "members": { - "namePattern": { - "target": "com.amazonaws.inspector#NamePattern", + "startTimeRange": { + "target": "com.amazonaws.inspector#TimestampRange", "traits": { - "smithy.api#documentation": "

For a record to match a filter, an explicit value or a string containing a wildcard\n that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun\n data type.

" + "smithy.api#documentation": "

For a record to match a filter, the value that is specified for this data type\n property must inclusively match any value between the specified minimum and maximum values\n of the startTime property of the AssessmentRun data type.

" } }, - "states": { - "target": "com.amazonaws.inspector#AssessmentRunStateList", + "namePattern": { + "target": "com.amazonaws.inspector#NamePattern", "traits": { - "smithy.api#documentation": "

For a record to match a filter, one of the values specified for this data type\n property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data\n type.

" + "smithy.api#documentation": "

For a record to match a filter, an explicit value or a string containing a wildcard\n that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun\n data type.

" } }, - "startTimeRange": { - "target": "com.amazonaws.inspector#TimestampRange", + "rulesPackageArns": { + "target": "com.amazonaws.inspector#FilterRulesPackageArnList", "traits": { - "smithy.api#documentation": "

For a record to match a filter, the value that is specified for this data type\n property must inclusively match any value between the specified minimum and maximum values\n of the startTime property of the AssessmentRun data type.

" + "smithy.api#documentation": "

For a record to match a filter, the value that is specified for this data type\n property must be contained in the list of values of the rulesPackages property of the AssessmentRun data\n type.

" } }, "durationRange": { @@ -687,10 +687,10 @@ "smithy.api#documentation": "

For a record to match a filter, the value that is specified for this data type\n property must inclusively match any value between the specified minimum and maximum values\n of the durationInSeconds property of the AssessmentRun data type.

" } }, - "rulesPackageArns": { - "target": "com.amazonaws.inspector#FilterRulesPackageArnList", + "states": { + "target": "com.amazonaws.inspector#AssessmentRunStateList", "traits": { - "smithy.api#documentation": "

For a record to match a filter, the value that is specified for this data type\n property must be contained in the list of values of the rulesPackages property of the AssessmentRun data\n type.

" + "smithy.api#documentation": "

For a record to match a filter, one of the values specified for this data type\n property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data\n type.

" } }, "stateChangeTimeRange": { @@ -734,31 +734,31 @@ "com.amazonaws.inspector#AssessmentRunInProgressException": { "type": "structure", "members": { - "assessmentRunArns": { - "target": "com.amazonaws.inspector#AssessmentRunInProgressArnList", + "canRetry": { + "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

The ARNs of the assessment runs that are currently in progress.

", + "smithy.api#documentation": "

You can immediately retry your request.

", "smithy.api#required": {} } }, - "assessmentRunArnsTruncated": { - "target": "com.amazonaws.inspector#Bool", + "message": { + "target": "com.amazonaws.inspector#ErrorMessage", "traits": { - "smithy.api#documentation": "

Boolean value that indicates whether the ARN list of the assessment runs is\n truncated.

", + "smithy.api#documentation": "

Details of the exception error.

", "smithy.api#required": {} } }, - "canRetry": { - "target": "com.amazonaws.inspector#Bool", + "assessmentRunArns": { + "target": "com.amazonaws.inspector#AssessmentRunInProgressArnList", "traits": { - "smithy.api#documentation": "

You can immediately retry your request.

", + "smithy.api#documentation": "

The ARNs of the assessment runs that are currently in progress.

", "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.inspector#ErrorMessage", + "assessmentRunArnsTruncated": { + "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

Details of the exception error.

", + "smithy.api#documentation": "

Boolean value that indicates whether the ARN list of the assessment runs is\n truncated.

", "smithy.api#required": {} } } @@ -792,10 +792,10 @@ "com.amazonaws.inspector#AssessmentRunNotification": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.inspector#Message", + "snsPublishStatusCode": { + "target": "com.amazonaws.inspector#AssessmentRunNotificationSnsStatusCode", "traits": { - "smithy.api#documentation": "

The message included in the notification.

" + "smithy.api#documentation": "

The status code of the SNS notification.

" } }, "date": { @@ -805,16 +805,10 @@ "smithy.api#required": {} } }, - "snsPublishStatusCode": { - "target": "com.amazonaws.inspector#AssessmentRunNotificationSnsStatusCode", - "traits": { - "smithy.api#documentation": "

The status code of the SNS notification.

" - } - }, - "event": { - "target": "com.amazonaws.inspector#InspectorEvent", + "error": { + "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

The event for which a notification is sent.

", + "smithy.api#documentation": "

The Boolean value that specifies whether the notification represents an\n error.

", "smithy.api#required": {} } }, @@ -824,12 +818,18 @@ "smithy.api#documentation": "

The SNS topic to which the SNS notification is sent.

" } }, - "error": { - "target": "com.amazonaws.inspector#Bool", + "event": { + "target": "com.amazonaws.inspector#InspectorEvent", "traits": { - "smithy.api#documentation": "

The Boolean value that specifies whether the notification represents an\n error.

", + "smithy.api#documentation": "

The event for which a notification is sent.

", "smithy.api#required": {} } + }, + "message": { + "target": "com.amazonaws.inspector#Message", + "traits": { + "smithy.api#documentation": "

The message included in the notification.

" + } } }, "traits": { @@ -979,31 +979,31 @@ "com.amazonaws.inspector#AssessmentTarget": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.inspector#Arn", + "updatedAt": { + "target": "com.amazonaws.inspector#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN that specifies the Amazon Inspector assessment target.

", + "smithy.api#documentation": "

The time at which UpdateAssessmentTarget is called.

", "smithy.api#required": {} } }, - "updatedAt": { - "target": "com.amazonaws.inspector#Timestamp", + "name": { + "target": "com.amazonaws.inspector#AssessmentTargetName", "traits": { - "smithy.api#documentation": "

The time at which UpdateAssessmentTarget is called.

", + "smithy.api#documentation": "

The name of the Amazon Inspector assessment target.

", "smithy.api#required": {} } }, - "resourceGroupArn": { + "arn": { "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The ARN that specifies the resource group that is associated with the assessment\n target.

" + "smithy.api#documentation": "

The ARN that specifies the Amazon Inspector assessment target.

", + "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.inspector#AssessmentTargetName", + "resourceGroupArn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The name of the Amazon Inspector assessment target.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN that specifies the resource group that is associated with the assessment\n target.

" } }, "createdAt": { @@ -1056,11 +1056,10 @@ "com.amazonaws.inspector#AssessmentTemplate": { "type": "structure", "members": { - "assessmentTargetArn": { + "lastAssessmentRunArn": { "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the assessment target that corresponds to this assessment\n template.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the most recent assessment run associated with this\n assessment template. This value exists only when the value of assessmentRunCount is\n greaterpa than zero.

" } }, "durationInSeconds": { @@ -1070,10 +1069,11 @@ "smithy.api#required": {} } }, - "lastAssessmentRunArn": { - "target": "com.amazonaws.inspector#Arn", + "userAttributesForFindings": { + "target": "com.amazonaws.inspector#UserAttributeList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the most recent assessment run associated with this\n assessment template. This value exists only when the value of assessmentRunCount is\n greaterpa than zero.

" + "smithy.api#documentation": "

The user-defined attributes that are assigned to every generated finding from the\n assessment run that uses this assessment template.

", + "smithy.api#required": {} } }, "createdAt": { @@ -1083,38 +1083,38 @@ "smithy.api#required": {} } }, - "assessmentRunCount": { - "target": "com.amazonaws.inspector#ArnCount", + "name": { + "target": "com.amazonaws.inspector#AssessmentTemplateName", "traits": { - "smithy.api#documentation": "

The number of existing assessment runs associated with this assessment template. This\n value can be zero or a positive integer.

", + "smithy.api#documentation": "

The name of the assessment template.

", "smithy.api#required": {} } }, - "rulesPackageArns": { - "target": "com.amazonaws.inspector#AssessmentTemplateRulesPackageArnList", + "assessmentRunCount": { + "target": "com.amazonaws.inspector#ArnCount", "traits": { - "smithy.api#documentation": "

The rules packages that are specified for this assessment template.

", + "smithy.api#documentation": "

The number of existing assessment runs associated with this assessment template. This\n value can be zero or a positive integer.

", "smithy.api#required": {} } }, - "userAttributesForFindings": { - "target": "com.amazonaws.inspector#UserAttributeList", + "arn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The user-defined attributes that are assigned to every generated finding from the\n assessment run that uses this assessment template.

", + "smithy.api#documentation": "

The ARN of the assessment template.

", "smithy.api#required": {} } }, - "arn": { + "assessmentTargetArn": { "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the assessment template.

", + "smithy.api#documentation": "

The ARN of the assessment target that corresponds to this assessment\n template.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.inspector#AssessmentTemplateName", + "rulesPackageArns": { + "target": "com.amazonaws.inspector#AssessmentTemplateRulesPackageArnList", "traits": { - "smithy.api#documentation": "

The name of the assessment template.

", + "smithy.api#documentation": "

The rules packages that are specified for this assessment template.

", "smithy.api#required": {} } } @@ -1132,17 +1132,17 @@ "smithy.api#documentation": "

For a record to match a filter, an explicit value or a string that contains a\n wildcard that is specified for this data type property must match the value of the\n assessmentTemplateName property of the AssessmentTemplate data type.

" } }, - "rulesPackageArns": { - "target": "com.amazonaws.inspector#FilterRulesPackageArnList", - "traits": { - "smithy.api#documentation": "

For a record to match a filter, the values that are specified for this data type\n property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data\n type.

" - } - }, "durationRange": { "target": "com.amazonaws.inspector#DurationRange", "traits": { "smithy.api#documentation": "

For a record to match a filter, the value specified for this data type property must\n inclusively match any value between the specified minimum and maximum values of the\n durationInSeconds property of the AssessmentTemplate data type.

" } + }, + "rulesPackageArns": { + "target": "com.amazonaws.inspector#FilterRulesPackageArnList", + "traits": { + "smithy.api#documentation": "

For a record to match a filter, the values that are specified for this data type\n property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data\n type.

" + } } }, "traits": { @@ -1185,22 +1185,16 @@ "com.amazonaws.inspector#AssetAttributes": { "type": "structure", "members": { - "amiId": { - "target": "com.amazonaws.inspector#AmiId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where\n the finding is generated.

" - } - }, "hostname": { "target": "com.amazonaws.inspector#Hostname", "traits": { "smithy.api#documentation": "

The hostname of the EC2 instance where the finding is generated.

" } }, - "networkInterfaces": { - "target": "com.amazonaws.inspector#NetworkInterfaces", + "amiId": { + "target": "com.amazonaws.inspector#AmiId", "traits": { - "smithy.api#documentation": "

An array of the network interfaces interacting with the EC2 instance where the\n finding is generated.

" + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where\n the finding is generated.

" } }, "agentId": { @@ -1209,10 +1203,10 @@ "smithy.api#documentation": "

The ID of the agent that is installed on the EC2 instance where the finding is\n generated.

" } }, - "tags": { - "target": "com.amazonaws.inspector#Tags", + "networkInterfaces": { + "target": "com.amazonaws.inspector#NetworkInterfaces", "traits": { - "smithy.api#documentation": "

The tags related to the EC2 instance where the finding is generated.

" + "smithy.api#documentation": "

An array of the network interfaces interacting with the EC2 instance where the\n finding is generated.

" } }, "autoScalingGroup": { @@ -1221,6 +1215,12 @@ "smithy.api#documentation": "

The Auto Scaling group of the EC2 instance where the finding is generated.

" } }, + "tags": { + "target": "com.amazonaws.inspector#Tags", + "traits": { + "smithy.api#documentation": "

The tags related to the EC2 instance where the finding is generated.

" + } + }, "ipv4Addresses": { "target": "com.amazonaws.inspector#Ipv4AddressList", "traits": { @@ -1452,17 +1452,17 @@ "com.amazonaws.inspector#CreateAssessmentTemplateRequest": { "type": "structure", "members": { - "rulesPackageArns": { - "target": "com.amazonaws.inspector#AssessmentTemplateRulesPackageArnList", + "assessmentTemplateName": { + "target": "com.amazonaws.inspector#AssessmentTemplateName", "traits": { - "smithy.api#documentation": "

The ARNs that specify the rules packages that you want to attach to the assessment\n template.

", + "smithy.api#documentation": "

The user-defined name that identifies the assessment template that you want to\n create. You can create several assessment templates for an assessment target. The names of\n the assessment templates that correspond to a particular assessment target must be\n unique.

", "smithy.api#required": {} } }, - "assessmentTemplateName": { - "target": "com.amazonaws.inspector#AssessmentTemplateName", + "rulesPackageArns": { + "target": "com.amazonaws.inspector#AssessmentTemplateRulesPackageArnList", "traits": { - "smithy.api#documentation": "

The user-defined name that identifies the assessment template that you want to\n create. You can create several assessment templates for an assessment target. The names of\n the assessment templates that correspond to a particular assessment target must be\n unique.

", + "smithy.api#documentation": "

The ARNs that specify the rules packages that you want to attach to the assessment\n template.

", "smithy.api#required": {} } }, @@ -2022,17 +2022,17 @@ "com.amazonaws.inspector#DescribeFindingsResponse": { "type": "structure", "members": { - "findings": { - "target": "com.amazonaws.inspector#FindingList", + "failedItems": { + "target": "com.amazonaws.inspector#FailedItems", "traits": { - "smithy.api#documentation": "

Information about the finding.

", + "smithy.api#documentation": "

Finding details that cannot be described. An error code is provided for each failed\n item.

", "smithy.api#required": {} } }, - "failedItems": { - "target": "com.amazonaws.inspector#FailedItems", + "findings": { + "target": "com.amazonaws.inspector#FindingList", "traits": { - "smithy.api#documentation": "

Finding details that cannot be described. An error code is provided for each failed\n item.

", + "smithy.api#documentation": "

Information about the finding.

", "smithy.api#required": {} } } @@ -2112,35 +2112,35 @@ "com.amazonaws.inspector#DescribeRulesPackagesRequest": { "type": "structure", "members": { - "locale": { - "target": "com.amazonaws.inspector#Locale", - "traits": { - "smithy.api#documentation": "

The locale that you want to translate a rules package description into.

" - } - }, "rulesPackageArns": { "target": "com.amazonaws.inspector#BatchDescribeArnList", "traits": { "smithy.api#documentation": "

The ARN that specifies the rules package that you want to describe.

", "smithy.api#required": {} } + }, + "locale": { + "target": "com.amazonaws.inspector#Locale", + "traits": { + "smithy.api#documentation": "

The locale that you want to translate a rules package description into.

" + } } } }, "com.amazonaws.inspector#DescribeRulesPackagesResponse": { "type": "structure", "members": { - "rulesPackages": { - "target": "com.amazonaws.inspector#RulesPackageList", + "failedItems": { + "target": "com.amazonaws.inspector#FailedItems", "traits": { - "smithy.api#documentation": "

Information about the rules package.

", + "smithy.api#documentation": "

Rules package details that cannot be described. An error code is provided for each\n failed item.

", "smithy.api#required": {} } }, - "failedItems": { - "target": "com.amazonaws.inspector#FailedItems", + "rulesPackages": { + "target": "com.amazonaws.inspector#RulesPackageList", "traits": { - "smithy.api#documentation": "

Rules package details that cannot be described. An error code is provided for each\n failed item.

", + "smithy.api#documentation": "

Information about the rules package.

", "smithy.api#required": {} } } @@ -2212,10 +2212,10 @@ "com.amazonaws.inspector#Exclusion": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.inspector#Text", + "arn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The description of the exclusion.

", + "smithy.api#documentation": "

The ARN that specifies the exclusion.

", "smithy.api#required": {} } }, @@ -2232,24 +2232,24 @@ "smithy.api#documentation": "

The system-defined attributes for the exclusion.

" } }, - "recommendation": { + "description": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The recommendation for the exclusion.

", + "smithy.api#documentation": "

The description of the exclusion.

", "smithy.api#required": {} } }, - "arn": { - "target": "com.amazonaws.inspector#Arn", + "title": { + "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The ARN that specifies the exclusion.

", + "smithy.api#documentation": "

The name of the exclusion.

", "smithy.api#required": {} } }, - "title": { + "recommendation": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The name of the exclusion.

", + "smithy.api#documentation": "

The recommendation for the exclusion.

", "smithy.api#required": {} } } @@ -2276,17 +2276,17 @@ "com.amazonaws.inspector#ExclusionPreview": { "type": "structure", "members": { - "description": { + "title": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The description of the exclusion preview.

", + "smithy.api#documentation": "

The name of the exclusion preview.

", "smithy.api#required": {} } }, - "recommendation": { + "description": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The recommendation for the exclusion preview.

", + "smithy.api#documentation": "

The description of the exclusion preview.

", "smithy.api#required": {} } }, @@ -2303,10 +2303,10 @@ "smithy.api#documentation": "

The system-defined attributes for the exclusion preview.

" } }, - "title": { + "recommendation": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The name of the exclusion preview.

", + "smithy.api#documentation": "

The recommendation for the exclusion preview.

", "smithy.api#required": {} } } @@ -2404,10 +2404,34 @@ "com.amazonaws.inspector#Finding": { "type": "structure", "members": { - "severity": { - "target": "com.amazonaws.inspector#Severity", + "assetAttributes": { + "target": "com.amazonaws.inspector#AssetAttributes", "traits": { - "smithy.api#documentation": "

The finding severity. Values can be set to High, Medium, Low, and\n Informational.

" + "smithy.api#documentation": "

A collection of attributes of the host from which the finding is generated.

" + } + }, + "assetType": { + "target": "com.amazonaws.inspector#AssetType", + "traits": { + "smithy.api#documentation": "

The type of the host from which the finding is generated.

" + } + }, + "description": { + "target": "com.amazonaws.inspector#Text", + "traits": { + "smithy.api#documentation": "

The description of the finding.

" + } + }, + "service": { + "target": "com.amazonaws.inspector#ServiceName", + "traits": { + "smithy.api#documentation": "

The data element is set to \"Inspector\".

" + } + }, + "indicatorOfCompromise": { + "target": "com.amazonaws.inspector#Bool", + "traits": { + "smithy.api#documentation": "

This data element is currently not used.

" } }, "numericSeverity": { @@ -2416,10 +2440,36 @@ "smithy.api#documentation": "

The numeric value of the finding severity.

" } }, - "title": { - "target": "com.amazonaws.inspector#Text", + "confidence": { + "target": "com.amazonaws.inspector#IocConfidence", "traits": { - "smithy.api#documentation": "

The name of the finding.

" + "smithy.api#documentation": "

This data element is currently not used.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when AddAttributesToFindings is called.

", + "smithy.api#required": {} + } + }, + "userAttributes": { + "target": "com.amazonaws.inspector#UserAttributeList", + "traits": { + "smithy.api#documentation": "

The user-defined attributes that are assigned to the finding.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.inspector#FindingId", + "traits": { + "smithy.api#documentation": "

The ID of the finding.

" + } + }, + "severity": { + "target": "com.amazonaws.inspector#Severity", + "traits": { + "smithy.api#documentation": "

The finding severity. Values can be set to High, Medium, Low, and\n Informational.

" } }, "arn": { @@ -2429,10 +2479,10 @@ "smithy.api#required": {} } }, - "assetType": { - "target": "com.amazonaws.inspector#AssetType", + "title": { + "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The type of the host from which the finding is generated.

" + "smithy.api#documentation": "

The name of the finding.

" } }, "schemaVersion": { @@ -2441,36 +2491,16 @@ "smithy.api#documentation": "

The schema version of this data type.

" } }, - "id": { - "target": "com.amazonaws.inspector#FindingId", - "traits": { - "smithy.api#documentation": "

The ID of the finding.

" - } - }, - "updatedAt": { - "target": "com.amazonaws.inspector#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when AddAttributesToFindings is called.

", - "smithy.api#required": {} - } - }, - "serviceAttributes": { - "target": "com.amazonaws.inspector#InspectorServiceAttributes", - "traits": { - "smithy.api#documentation": "

This data type is used in the Finding data type.

" - } - }, "recommendation": { "target": "com.amazonaws.inspector#Text", "traits": { "smithy.api#documentation": "

The recommendation for the finding.

" } }, - "userAttributes": { - "target": "com.amazonaws.inspector#UserAttributeList", + "serviceAttributes": { + "target": "com.amazonaws.inspector#InspectorServiceAttributes", "traits": { - "smithy.api#documentation": "

The user-defined attributes that are assigned to the finding.

", - "smithy.api#required": {} + "smithy.api#documentation": "

This data type is used in the Finding data type.

" } }, "attributes": { @@ -2486,36 +2516,6 @@ "smithy.api#documentation": "

The time when the finding was generated.

", "smithy.api#required": {} } - }, - "assetAttributes": { - "target": "com.amazonaws.inspector#AssetAttributes", - "traits": { - "smithy.api#documentation": "

A collection of attributes of the host from which the finding is generated.

" - } - }, - "service": { - "target": "com.amazonaws.inspector#ServiceName", - "traits": { - "smithy.api#documentation": "

The data element is set to \"Inspector\".

" - } - }, - "indicatorOfCompromise": { - "target": "com.amazonaws.inspector#Bool", - "traits": { - "smithy.api#documentation": "

This data element is currently not used.

" - } - }, - "description": { - "target": "com.amazonaws.inspector#Text", - "traits": { - "smithy.api#documentation": "

The description of the finding.

" - } - }, - "confidence": { - "target": "com.amazonaws.inspector#IocConfidence", - "traits": { - "smithy.api#documentation": "

This data element is currently not used.

" - } } }, "traits": { @@ -2531,34 +2531,34 @@ "com.amazonaws.inspector#FindingFilter": { "type": "structure", "members": { - "rulesPackageArns": { - "target": "com.amazonaws.inspector#FilterRulesPackageArnList", + "creationTimeRange": { + "target": "com.amazonaws.inspector#TimestampRange", "traits": { - "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the rulesPackageArn property of the Finding data\n type.

" + "smithy.api#documentation": "

The time range during which the finding is generated.

" } }, - "severities": { - "target": "com.amazonaws.inspector#SeverityList", + "userAttributes": { + "target": "com.amazonaws.inspector#AttributeList", "traits": { - "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the severity property of the Finding data type.

" + "smithy.api#documentation": "

For a record to match a filter, the value that is specified for this data type\n property must be contained in the list of values of the userAttributes property of the Finding data\n type.

" } }, - "ruleNames": { - "target": "com.amazonaws.inspector#RuleNameList", + "attributes": { + "target": "com.amazonaws.inspector#AttributeList", "traits": { - "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the ruleName property of the Finding data type.

" + "smithy.api#documentation": "

For a record to match a filter, the list of values that are specified for this data\n type property must be contained in the list of values of the attributes property of the Finding data type.

" } }, - "autoScalingGroups": { - "target": "com.amazonaws.inspector#AutoScalingGroupList", + "severities": { + "target": "com.amazonaws.inspector#SeverityList", "traits": { - "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the autoScalingGroup property of the Finding data\n type.

" + "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the severity property of the Finding data type.

" } }, - "attributes": { - "target": "com.amazonaws.inspector#AttributeList", + "rulesPackageArns": { + "target": "com.amazonaws.inspector#FilterRulesPackageArnList", "traits": { - "smithy.api#documentation": "

For a record to match a filter, the list of values that are specified for this data\n type property must be contained in the list of values of the attributes property of the Finding data type.

" + "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the rulesPackageArn property of the Finding data\n type.

" } }, "agentIds": { @@ -2567,16 +2567,16 @@ "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the agentId property of the Finding data type.

" } }, - "userAttributes": { - "target": "com.amazonaws.inspector#AttributeList", + "autoScalingGroups": { + "target": "com.amazonaws.inspector#AutoScalingGroupList", "traits": { - "smithy.api#documentation": "

For a record to match a filter, the value that is specified for this data type\n property must be contained in the list of values of the userAttributes property of the Finding data\n type.

" + "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the autoScalingGroup property of the Finding data\n type.

" } }, - "creationTimeRange": { - "target": "com.amazonaws.inspector#TimestampRange", + "ruleNames": { + "target": "com.amazonaws.inspector#RuleNameList", "traits": { - "smithy.api#documentation": "

The time range during which the finding is generated.

" + "smithy.api#documentation": "

For a record to match a filter, one of the values that is specified for this data\n type property must be the exact match of the value of the ruleName property of the Finding data type.

" } } }, @@ -2643,10 +2643,10 @@ "com.amazonaws.inspector#GetAssessmentReportRequest": { "type": "structure", "members": { - "reportFileFormat": { - "target": "com.amazonaws.inspector#ReportFileFormat", + "reportType": { + "target": "com.amazonaws.inspector#ReportType", "traits": { - "smithy.api#documentation": "

Specifies the file format (html or pdf) of the assessment report that you want to\n generate.

", + "smithy.api#documentation": "

Specifies the type of the assessment report that you want to generate. There are two\n types of assessment reports: a finding report and a full report. For more information, see\n Assessment Reports.

", "smithy.api#required": {} } }, @@ -2657,10 +2657,10 @@ "smithy.api#required": {} } }, - "reportType": { - "target": "com.amazonaws.inspector#ReportType", + "reportFileFormat": { + "target": "com.amazonaws.inspector#ReportFileFormat", "traits": { - "smithy.api#documentation": "

Specifies the type of the assessment report that you want to generate. There are two\n types of assessment reports: a finding report and a full report. For more information, see\n Assessment Reports.

", + "smithy.api#documentation": "

Specifies the file format (html or pdf) of the assessment report that you want to\n generate.

", "smithy.api#required": {} } } @@ -2669,18 +2669,18 @@ "com.amazonaws.inspector#GetAssessmentReportResponse": { "type": "structure", "members": { + "url": { + "target": "com.amazonaws.inspector#Url", + "traits": { + "smithy.api#documentation": "

Specifies the URL where you can find the generated assessment report. This parameter\n is only returned if the report is successfully generated.

" + } + }, "status": { "target": "com.amazonaws.inspector#ReportStatus", "traits": { "smithy.api#documentation": "

Specifies the status of the request to generate an assessment report.

", "smithy.api#required": {} } - }, - "url": { - "target": "com.amazonaws.inspector#Url", - "traits": { - "smithy.api#documentation": "

Specifies the URL where you can find the generated assessment report. This parameter\n is only returned if the report is successfully generated.

" - } } } }, @@ -2718,10 +2718,10 @@ "com.amazonaws.inspector#GetExclusionsPreviewRequest": { "type": "structure", "members": { - "assessmentTemplateArn": { - "target": "com.amazonaws.inspector#Arn", + "previewToken": { + "target": "com.amazonaws.inspector#UUID", "traits": { - "smithy.api#documentation": "

The ARN that specifies the assessment template for which the exclusions preview was\n requested.

", + "smithy.api#documentation": "

The unique identifier associated of the exclusions preview.

", "smithy.api#required": {} } }, @@ -2731,42 +2731,42 @@ "smithy.api#documentation": "

The locale into which you want to translate the exclusion's title, description, and\n recommendation.

" } }, - "previewToken": { - "target": "com.amazonaws.inspector#UUID", + "assessmentTemplateArn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

The unique identifier associated of the exclusions preview.

", + "smithy.api#documentation": "

The ARN that specifies the assessment template for which the exclusions preview was\n requested.

", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", - "traits": { - "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to\n the action fill nextToken in the request with the value of nextToken from the previous\n response to continue listing data.

" - } - }, "maxResults": { "target": "com.amazonaws.inspector#ListMaxResults", "traits": { "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 100. The maximum value is 500.

" } + }, + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to\n the action fill nextToken in the request with the value of nextToken from the previous\n response to continue listing data.

" + } } } }, "com.amazonaws.inspector#GetExclusionsPreviewResponse": { "type": "structure", "members": { - "exclusionPreviews": { - "target": "com.amazonaws.inspector#ExclusionPreviewList", - "traits": { - "smithy.api#documentation": "

Information about the exclusions included in the preview.

" - } - }, "nextToken": { "target": "com.amazonaws.inspector#PaginationToken", "traits": { "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameters is\n present in the response and contains the value to use for the nextToken parameter in a\n subsequent pagination request. If there is no more data to be listed, this parameter is set\n to null.

" } }, + "exclusionPreviews": { + "target": "com.amazonaws.inspector#ExclusionPreviewList", + "traits": { + "smithy.api#documentation": "

Information about the exclusions included in the preview.

" + } + }, "previewStatus": { "target": "com.amazonaws.inspector#PreviewStatus", "traits": { @@ -2983,7 +2983,7 @@ "sdkId": "Inspector", "arnNamespace": "inspector", "cloudFormationName": "Inspector", - "cloudTrailEventSource": "v20160216.inspector.amazonaws.com" + "cloudTrailEventSource": "inspector.amazonaws.com" }, "aws.auth#sigv4": { "name": "inspector" @@ -2996,12 +2996,6 @@ "com.amazonaws.inspector#InspectorServiceAttributes": { "type": "structure", "members": { - "assessmentRunArn": { - "target": "com.amazonaws.inspector#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the assessment run during which the finding is generated.

" - } - }, "schemaVersion": { "target": "com.amazonaws.inspector#NumericVersion", "traits": { @@ -3014,6 +3008,12 @@ "traits": { "smithy.api#documentation": "

The ARN of the rules package that is used to generate the finding.

" } + }, + "assessmentRunArn": { + "target": "com.amazonaws.inspector#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the assessment run during which the finding is generated.

" + } } }, "traits": { @@ -3023,17 +3023,17 @@ "com.amazonaws.inspector#InternalException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.inspector#ErrorMessage", + "canRetry": { + "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

Details of the exception error.

", + "smithy.api#documentation": "

You can immediately retry your request.

", "smithy.api#required": {} } }, - "canRetry": { - "target": "com.amazonaws.inspector#Bool", + "message": { + "target": "com.amazonaws.inspector#ErrorMessage", "traits": { - "smithy.api#documentation": "

You can immediately retry your request.

", + "smithy.api#documentation": "

Details of the exception error.

", "smithy.api#required": {} } } @@ -3068,17 +3068,17 @@ "smithy.api#required": {} } }, - "errorCode": { - "target": "com.amazonaws.inspector#InvalidCrossAccountRoleErrorCode", + "canRetry": { + "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

Code that indicates the type of error that is generated.

", + "smithy.api#documentation": "

You can immediately retry your request.

", "smithy.api#required": {} } }, - "canRetry": { - "target": "com.amazonaws.inspector#Bool", + "errorCode": { + "target": "com.amazonaws.inspector#InvalidCrossAccountRoleErrorCode", "traits": { - "smithy.api#documentation": "

You can immediately retry your request.

", + "smithy.api#documentation": "

Code that indicates the type of error that is generated.

", "smithy.api#required": {} } } @@ -3423,17 +3423,17 @@ "smithy.api#required": {} } }, - "errorCode": { - "target": "com.amazonaws.inspector#LimitExceededErrorCode", + "canRetry": { + "target": "com.amazonaws.inspector#Bool", "traits": { - "smithy.api#documentation": "

Code that indicates the type of error that is generated.

", + "smithy.api#documentation": "

You can immediately retry your request.

", "smithy.api#required": {} } }, - "canRetry": { - "target": "com.amazonaws.inspector#Bool", + "errorCode": { + "target": "com.amazonaws.inspector#LimitExceededErrorCode", "traits": { - "smithy.api#documentation": "

You can immediately retry your request.

", + "smithy.api#documentation": "

Code that indicates the type of error that is generated.

", "smithy.api#required": {} } } @@ -3507,18 +3507,18 @@ "com.amazonaws.inspector#ListAssessmentRunAgentsResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", + "traits": { + "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" + } + }, "assessmentRunAgents": { "target": "com.amazonaws.inspector#AssessmentRunAgentList", "traits": { "smithy.api#documentation": "

A list of ARNs that specifies the agents returned by the action.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", - "traits": { - "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" - } } } }, @@ -3568,17 +3568,17 @@ "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items that you want in\n the response. The default value is 10. The maximum value is 500.

" } }, - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", - "traits": { - "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListAssessmentRuns\n action. Subsequent calls to the action fill nextToken in\n the request with the value of NextToken from the previous\n response to continue listing data.

" - } - }, "assessmentTemplateArns": { "target": "com.amazonaws.inspector#ListParentArnList", "traits": { "smithy.api#documentation": "

The ARNs that specify the assessment templates whose assessment runs you want to\n list.

" } + }, + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListAssessmentRuns\n action. Subsequent calls to the action fill nextToken in\n the request with the value of NextToken from the previous\n response to continue listing data.

" + } } } }, @@ -3637,17 +3637,17 @@ "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListAssessmentTargets\n action. Subsequent calls to the action fill nextToken in\n the request with the value of NextToken from the previous\n response to continue listing data.

" } }, - "maxResults": { - "target": "com.amazonaws.inspector#ListMaxResults", - "traits": { - "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 10. The maximum value is 500.

" - } - }, "filter": { "target": "com.amazonaws.inspector#AssessmentTargetFilter", "traits": { "smithy.api#documentation": "

You can use this parameter to specify a subset of data to be included in the action's\n response.

\n

For a record to match a filter, all specified filter attributes must match. When\n multiple values are specified for a filter attribute, any of the values can\n match.

" } + }, + "maxResults": { + "target": "com.amazonaws.inspector#ListMaxResults", + "traits": { + "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 10. The maximum value is 500.

" + } } } }, @@ -3703,16 +3703,16 @@ "com.amazonaws.inspector#ListAssessmentTemplatesRequest": { "type": "structure", "members": { - "assessmentTargetArns": { - "target": "com.amazonaws.inspector#ListParentArnList", + "filter": { + "target": "com.amazonaws.inspector#AssessmentTemplateFilter", "traits": { - "smithy.api#documentation": "

A list of ARNs that specifies the assessment targets whose assessment templates you\n want to list.

" + "smithy.api#documentation": "

You can use this parameter to specify a subset of data to be included in the action's\n response.

\n

For a record to match a filter, all specified filter attributes must match. When\n multiple values are specified for a filter attribute, any of the values can\n match.

" } }, - "filter": { - "target": "com.amazonaws.inspector#AssessmentTemplateFilter", + "assessmentTargetArns": { + "target": "com.amazonaws.inspector#ListParentArnList", "traits": { - "smithy.api#documentation": "

You can use this parameter to specify a subset of data to be included in the action's\n response.

\n

For a record to match a filter, all specified filter attributes must match. When\n multiple values are specified for a filter attribute, any of the values can\n match.

" + "smithy.api#documentation": "

A list of ARNs that specifies the assessment targets whose assessment templates you\n want to list.

" } }, "maxResults": { @@ -3732,18 +3732,18 @@ "com.amazonaws.inspector#ListAssessmentTemplatesResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", + "traits": { + "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" + } + }, "assessmentTemplateArns": { "target": "com.amazonaws.inspector#ListReturnedArnList", "traits": { "smithy.api#documentation": "

A list of ARNs that specifies the assessment templates returned by the\n action.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", - "traits": { - "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" - } } } }, @@ -3787,10 +3787,10 @@ "com.amazonaws.inspector#ListEventSubscriptionsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", + "resourceArn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListEventSubscriptions\n action. Subsequent calls to the action fill nextToken in\n the request with the value of NextToken from the previous\n response to continue listing data.

" + "smithy.api#documentation": "

The ARN of the assessment template for which you want to list the existing event\n subscriptions.

" } }, "maxResults": { @@ -3799,10 +3799,10 @@ "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 10. The maximum value is 500.

" } }, - "resourceArn": { - "target": "com.amazonaws.inspector#Arn", + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", "traits": { - "smithy.api#documentation": "

The ARN of the assessment template for which you want to list the existing event\n subscriptions.

" + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListEventSubscriptions\n action. Subsequent calls to the action fill nextToken in\n the request with the value of NextToken from the previous\n response to continue listing data.

" } } } @@ -3859,10 +3859,11 @@ "com.amazonaws.inspector#ListExclusionsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.inspector#ListMaxResults", + "assessmentRunArn": { + "target": "com.amazonaws.inspector#Arn", "traits": { - "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 100. The maximum value is 500.

" + "smithy.api#documentation": "

The ARN of the assessment run that generated the exclusions that you want to\n list.

", + "smithy.api#required": {} } }, "nextToken": { @@ -3871,11 +3872,10 @@ "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListExclusionsRequest action. Subsequent calls to the\n action fill nextToken in the request with the value of nextToken from the previous response\n to continue listing data.

" } }, - "assessmentRunArn": { - "target": "com.amazonaws.inspector#Arn", + "maxResults": { + "target": "com.amazonaws.inspector#ListMaxResults", "traits": { - "smithy.api#documentation": "

The ARN of the assessment run that generated the exclusions that you want to\n list.

", - "smithy.api#required": {} + "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 100. The maximum value is 500.

" } } } @@ -3932,29 +3932,29 @@ "com.amazonaws.inspector#ListFindingsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", - "traits": { - "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListFindings action.\n Subsequent calls to the action fill nextToken in the\n request with the value of NextToken from the previous\n response to continue listing data.

" - } - }, "assessmentRunArns": { "target": "com.amazonaws.inspector#ListParentArnList", "traits": { "smithy.api#documentation": "

The ARNs of the assessment runs that generate the findings that you want to\n list.

" } }, - "maxResults": { - "target": "com.amazonaws.inspector#ListMaxResults", - "traits": { - "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 10. The maximum value is 500.

" - } - }, "filter": { "target": "com.amazonaws.inspector#FindingFilter", "traits": { "smithy.api#documentation": "

You can use this parameter to specify a subset of data to be included in the action's\n response.

\n

For a record to match a filter, all specified filter attributes must match. When\n multiple values are specified for a filter attribute, any of the values can\n match.

" } + }, + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value of this parameter\n to null on your first call to the ListFindings action.\n Subsequent calls to the action fill nextToken in the\n request with the value of NextToken from the previous\n response to continue listing data.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector#ListMaxResults", + "traits": { + "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 10. The maximum value is 500.

" + } } } }, @@ -4054,18 +4054,18 @@ "com.amazonaws.inspector#ListRulesPackagesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", - "traits": { - "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" - } - }, "rulesPackageArns": { "target": "com.amazonaws.inspector#ListReturnedArnList", "traits": { "smithy.api#documentation": "

The list of ARNs that specifies the rules packages returned by the action.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", + "traits": { + "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" + } } } }, @@ -4166,24 +4166,6 @@ "com.amazonaws.inspector#NetworkInterface": { "type": "structure", "members": { - "networkInterfaceId": { - "target": "com.amazonaws.inspector#Text", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "subnetId": { - "target": "com.amazonaws.inspector#Text", - "traits": { - "smithy.api#documentation": "

The ID of a subnet associated with the network interface.

" - } - }, - "privateIpAddresses": { - "target": "com.amazonaws.inspector#PrivateIpAddresses", - "traits": { - "smithy.api#documentation": "

A list of the private IP addresses associated with the network interface. Includes\n the privateDnsName and privateIpAddress.

" - } - }, "vpcId": { "target": "com.amazonaws.inspector#Text", "traits": { @@ -4196,6 +4178,12 @@ "smithy.api#documentation": "

The IP addresses associated with the network interface.

" } }, + "networkInterfaceId": { + "target": "com.amazonaws.inspector#Text", + "traits": { + "smithy.api#documentation": "

The ID of the network interface.

" + } + }, "publicIp": { "target": "com.amazonaws.inspector#Text", "traits": { @@ -4214,10 +4202,16 @@ "smithy.api#documentation": "

The private IP address associated with the network interface.

" } }, - "publicDnsName": { + "privateIpAddresses": { + "target": "com.amazonaws.inspector#PrivateIpAddresses", + "traits": { + "smithy.api#documentation": "

A list of the private IP addresses associated with the network interface. Includes\n the privateDnsName and privateIpAddress.

" + } + }, + "subnetId": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The name of a public DNS associated with the network interface.

" + "smithy.api#documentation": "

The ID of a subnet associated with the network interface.

" } }, "securityGroups": { @@ -4225,6 +4219,12 @@ "traits": { "smithy.api#documentation": "

A list of the security groups associated with the network interface. Includes the\n groupId and groupName.

" } + }, + "publicDnsName": { + "target": "com.amazonaws.inspector#Text", + "traits": { + "smithy.api#documentation": "

The name of a public DNS associated with the network interface.

" + } } }, "traits": { @@ -4286,17 +4286,17 @@ "smithy.api#required": {} } }, - "errorCode": { - "target": "com.amazonaws.inspector#NoSuchEntityErrorCode", + "message": { + "target": "com.amazonaws.inspector#ErrorMessage", "traits": { - "smithy.api#documentation": "

Code that indicates the type of error that is generated.

", + "smithy.api#documentation": "

Details of the exception error.

", "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.inspector#ErrorMessage", + "errorCode": { + "target": "com.amazonaws.inspector#NoSuchEntityErrorCode", "traits": { - "smithy.api#documentation": "

Details of the exception error.

", + "smithy.api#documentation": "

Code that indicates the type of error that is generated.

", "smithy.api#required": {} } } @@ -4384,6 +4384,12 @@ "com.amazonaws.inspector#PreviewAgentsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.inspector#PreviewAgentsMaxResults", + "traits": { + "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 10. The maximum value is 500.

" + } + }, "previewAgentsArn": { "target": "com.amazonaws.inspector#Arn", "traits": { @@ -4391,12 +4397,6 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.inspector#PreviewAgentsMaxResults", - "traits": { - "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 10. The maximum value is 500.

" - } - }, "nextToken": { "target": "com.amazonaws.inspector#PaginationToken", "traits": { @@ -4408,18 +4408,18 @@ "com.amazonaws.inspector#PreviewAgentsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.inspector#PaginationToken", - "traits": { - "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" - } - }, "agentPreviews": { "target": "com.amazonaws.inspector#AgentPreviewList", "traits": { "smithy.api#documentation": "

The resulting list of agents.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.inspector#PaginationToken", + "traits": { + "smithy.api#documentation": "

When a response is generated, if there is more data to be listed, this parameter is\n present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more\n data to be listed, this parameter is set to null.

" + } } } }, @@ -4456,16 +4456,16 @@ "com.amazonaws.inspector#PrivateIp": { "type": "structure", "members": { - "privateIpAddress": { + "privateDnsName": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The full IP address of the network inteface.

" + "smithy.api#documentation": "

The DNS name of the private IP address.

" } }, - "privateDnsName": { + "privateIpAddress": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The DNS name of the private IP address.

" + "smithy.api#documentation": "

The full IP address of the network inteface.

" } } }, @@ -4638,17 +4638,17 @@ "com.amazonaws.inspector#ResourceGroup": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.inspector#ResourceGroupTags", + "createdAt": { + "target": "com.amazonaws.inspector#Timestamp", "traits": { - "smithy.api#documentation": "

The tags (key and value pairs) of the resource group. This data type property is used\n in the CreateResourceGroup action.

", + "smithy.api#documentation": "

The time at which resource group is created.

", "smithy.api#required": {} } }, - "createdAt": { - "target": "com.amazonaws.inspector#Timestamp", + "tags": { + "target": "com.amazonaws.inspector#ResourceGroupTags", "traits": { - "smithy.api#documentation": "

The time at which resource group is created.

", + "smithy.api#documentation": "

The tags (key and value pairs) of the resource group. This data type property is used\n in the CreateResourceGroup action.

", "smithy.api#required": {} } }, @@ -4733,6 +4733,13 @@ "com.amazonaws.inspector#RulesPackage": { "type": "structure", "members": { + "version": { + "target": "com.amazonaws.inspector#Version", + "traits": { + "smithy.api#documentation": "

The version ID of the rules package.

", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.inspector#RulesPackageName", "traits": { @@ -4747,13 +4754,6 @@ "smithy.api#required": {} } }, - "version": { - "target": "com.amazonaws.inspector#Version", - "traits": { - "smithy.api#documentation": "

The version ID of the rules package.

", - "smithy.api#required": {} - } - }, "arn": { "target": "com.amazonaws.inspector#Arn", "traits": { @@ -4845,16 +4845,16 @@ "com.amazonaws.inspector#SecurityGroup": { "type": "structure", "members": { - "groupName": { + "groupId": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The name of the security group.

" + "smithy.api#documentation": "

The ID of the security group.

" } }, - "groupId": { + "groupName": { "target": "com.amazonaws.inspector#Text", "traits": { - "smithy.api#documentation": "

The ID of the security group.

" + "smithy.api#documentation": "

The name of the security group.

" } } }, @@ -5096,18 +5096,18 @@ "com.amazonaws.inspector#StopAssessmentRunRequest": { "type": "structure", "members": { + "stopAction": { + "target": "com.amazonaws.inspector#StopAction", + "traits": { + "smithy.api#documentation": "

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION.\n START_EVALUATION (the default value), stops the AWS agent from collecting data and begins\n the results evaluation and the findings generation process. SKIP_EVALUATION cancels the\n assessment run immediately, after which no findings are generated.

" + } + }, "assessmentRunArn": { "target": "com.amazonaws.inspector#Arn", "traits": { "smithy.api#documentation": "

The ARN of the assessment run that you want to stop.

", "smithy.api#required": {} } - }, - "stopAction": { - "target": "com.amazonaws.inspector#StopAction", - "traits": { - "smithy.api#documentation": "

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION.\n START_EVALUATION (the default value), stops the AWS agent from collecting data and begins\n the results evaluation and the findings generation process. SKIP_EVALUATION cancels the\n assessment run immediately, after which no findings are generated.

" - } } } }, @@ -5274,18 +5274,18 @@ "smithy.api#required": {} } }, - "dataSize": { - "target": "com.amazonaws.inspector#Long", - "traits": { - "smithy.api#documentation": "

The data size of messages that the agent sends to the Amazon Inspector\n service.

" - } - }, "messageType": { "target": "com.amazonaws.inspector#MessageType", "traits": { "smithy.api#documentation": "

A specific type of behavioral data that is collected by the agent.

", "smithy.api#required": {} } + }, + "dataSize": { + "target": "com.amazonaws.inspector#Long", + "traits": { + "smithy.api#documentation": "

The data size of messages that the agent sends to the Amazon Inspector\n service.

" + } } }, "traits": { @@ -5371,6 +5371,13 @@ "com.amazonaws.inspector#UnsubscribeFromEventRequest": { "type": "structure", "members": { + "topicArn": { + "target": "com.amazonaws.inspector#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the SNS topic to which SNS notifications are sent.

", + "smithy.api#required": {} + } + }, "resourceArn": { "target": "com.amazonaws.inspector#Arn", "traits": { @@ -5384,27 +5391,20 @@ "smithy.api#documentation": "

The event for which you want to stop receiving SNS notifications.

", "smithy.api#required": {} } - }, - "topicArn": { - "target": "com.amazonaws.inspector#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the SNS topic to which SNS notifications are sent.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.inspector#UnsupportedFeatureException": { "type": "structure", "members": { - "canRetry": { - "target": "com.amazonaws.inspector#Bool", + "message": { + "target": "com.amazonaws.inspector#ErrorMessage", "traits": { "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.inspector#ErrorMessage", + "canRetry": { + "target": "com.amazonaws.inspector#Bool", "traits": { "smithy.api#required": {} } @@ -5444,6 +5444,13 @@ "com.amazonaws.inspector#UpdateAssessmentTargetRequest": { "type": "structure", "members": { + "assessmentTargetName": { + "target": "com.amazonaws.inspector#AssessmentTargetName", + "traits": { + "smithy.api#documentation": "

The name of the assessment target that you want to update.

", + "smithy.api#required": {} + } + }, "assessmentTargetArn": { "target": "com.amazonaws.inspector#Arn", "traits": { @@ -5456,13 +5463,6 @@ "traits": { "smithy.api#documentation": "

The ARN of the resource group that is used to specify the new resource group to\n associate with the assessment target.

" } - }, - "assessmentTargetName": { - "target": "com.amazonaws.inspector#AssessmentTargetName", - "traits": { - "smithy.api#documentation": "

The name of the assessment target that you want to update.

", - "smithy.api#required": {} - } } } }, diff --git a/codegen/sdk-codegen/aws-models/iot-1click-devices-service.2018-05-14.json b/codegen/sdk-codegen/aws-models/iot-1click-devices-service.2018-05-14.json index 2ee5ffd4684a..777ef8b189ff 100644 --- a/codegen/sdk-codegen/aws-models/iot-1click-devices-service.2018-05-14.json +++ b/codegen/sdk-codegen/aws-models/iot-1click-devices-service.2018-05-14.json @@ -77,19 +77,19 @@ "com.amazonaws.iot1clickdevicesservice#ClaimDevicesByClaimCodeResponse": { "type": "structure", "members": { - "ClaimCode": { - "target": "com.amazonaws.iot1clickdevicesservice#__stringMin12Max40", - "traits": { - "smithy.api#documentation": "

The claim code provided by the device manufacturer.

", - "smithy.api#jsonName": "claimCode" - } - }, "Total": { "target": "com.amazonaws.iot1clickdevicesservice#__integer", "traits": { "smithy.api#documentation": "

The total number of devices associated with the claim code that has been processed in\n the claim request.

", "smithy.api#jsonName": "total" } + }, + "ClaimCode": { + "target": "com.amazonaws.iot1clickdevicesservice#__stringMin12Max40", + "traits": { + "smithy.api#documentation": "

The claim code provided by the device manufacturer.

", + "smithy.api#jsonName": "claimCode" + } } } }, @@ -149,13 +149,6 @@ "com.amazonaws.iot1clickdevicesservice#Device": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.iot1clickdevicesservice#__string", - "traits": { - "smithy.api#documentation": "

The device type, such as \"button\".

", - "smithy.api#jsonName": "type" - } - }, "DeviceId": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { @@ -169,6 +162,13 @@ "smithy.api#documentation": "

The user specified attributes associated with the device for an event.

", "smithy.api#jsonName": "attributes" } + }, + "Type": { + "target": "com.amazonaws.iot1clickdevicesservice#__string", + "traits": { + "smithy.api#documentation": "

The device type, such as \"button\".

", + "smithy.api#jsonName": "type" + } } } }, @@ -187,18 +187,18 @@ "com.amazonaws.iot1clickdevicesservice#DeviceDescription": { "type": "structure", "members": { - "DeviceId": { - "target": "com.amazonaws.iot1clickdevicesservice#__string", + "Enabled": { + "target": "com.amazonaws.iot1clickdevicesservice#__boolean", "traits": { - "smithy.api#documentation": "

The unique identifier of the device.

", - "smithy.api#jsonName": "deviceId" + "smithy.api#documentation": "

A Boolean value indicating whether or not the device is enabled.

", + "smithy.api#jsonName": "enabled" } }, - "Arn": { + "DeviceId": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

The ARN of the device.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The unique identifier of the device.

", + "smithy.api#jsonName": "deviceId" } }, "Attributes": { @@ -208,18 +208,11 @@ "smithy.api#jsonName": "attributes" } }, - "Enabled": { - "target": "com.amazonaws.iot1clickdevicesservice#__boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether or not the device is enabled.

", - "smithy.api#jsonName": "enabled" - } - }, - "RemainingLife": { - "target": "com.amazonaws.iot1clickdevicesservice#__doubleMin0Max100", + "Type": { + "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

A value between 0 and 1 inclusive, representing the fraction of life remaining for the\n device.

", - "smithy.api#jsonName": "remainingLife" + "smithy.api#documentation": "

The type of the device, such as \"button\".

", + "smithy.api#jsonName": "type" } }, "Tags": { @@ -229,11 +222,18 @@ "smithy.api#jsonName": "tags" } }, - "Type": { + "Arn": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

The type of the device, such as \"button\".

", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "

The ARN of the device.

", + "smithy.api#jsonName": "arn" + } + }, + "RemainingLife": { + "target": "com.amazonaws.iot1clickdevicesservice#__doubleMin0Max100", + "traits": { + "smithy.api#documentation": "

A value between 0 and 1 inclusive, representing the fraction of life remaining for the\n device.

", + "smithy.api#jsonName": "remainingLife" } } } @@ -241,19 +241,19 @@ "com.amazonaws.iot1clickdevicesservice#DeviceEvent": { "type": "structure", "members": { - "Device": { - "target": "com.amazonaws.iot1clickdevicesservice#Device", - "traits": { - "smithy.api#documentation": "

An object representing the device associated with the event.

", - "smithy.api#jsonName": "device" - } - }, "StdEvent": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { "smithy.api#documentation": "

A serialized JSON object representing the device-type specific event.

", "smithy.api#jsonName": "stdEvent" } + }, + "Device": { + "target": "com.amazonaws.iot1clickdevicesservice#Device", + "traits": { + "smithy.api#documentation": "

An object representing the device associated with the event.

", + "smithy.api#jsonName": "device" + } } } }, @@ -313,6 +313,13 @@ "com.amazonaws.iot1clickdevicesservice#FinalizeDeviceClaimRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.iot1clickdevicesservice#__mapOf__string", + "traits": { + "smithy.api#documentation": "

A collection of key/value pairs defining the resource tags. For example, {\n \"tags\": {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS\n Tagging Strategies.

\n \n

", + "smithy.api#jsonName": "tags" + } + }, "DeviceId": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { @@ -320,13 +327,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.iot1clickdevicesservice#__mapOf__string", - "traits": { - "smithy.api#documentation": "

A collection of key/value pairs defining the resource tags. For example, {\n \"tags\": {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS\n Tagging Strategies.

\n \n

", - "smithy.api#jsonName": "tags" - } } } }, @@ -645,7 +645,7 @@ "sdkId": "IoT 1Click Devices Service", "arnNamespace": "iot1click", "cloudFormationName": "IoT1ClickDevicesService", - "cloudTrailEventSource": "iot_1click_devices_service.amazonaws.com" + "cloudTrailEventSource": "iot1clickdevicesservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "iot1click" @@ -689,14 +689,21 @@ "com.amazonaws.iot1clickdevicesservice#ListDeviceEventsRequest": { "type": "structure", "members": { - "DeviceId": { - "target": "com.amazonaws.iot1clickdevicesservice#__string", + "FromTimeStamp": { + "target": "com.amazonaws.iot1clickdevicesservice#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The unique identifier of the device.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The start date for the device event query, in ISO8061 format. For example,\n 2018-03-28T15:45:12.880Z\n

", + "smithy.api#httpQuery": "fromTimeStamp", "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.iot1clickdevicesservice#__string", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, "MaxResults": { "target": "com.amazonaws.iot1clickdevicesservice#MaxResults", "traits": { @@ -704,11 +711,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "FromTimeStamp": { - "target": "com.amazonaws.iot1clickdevicesservice#__timestampIso8601", + "DeviceId": { + "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

The start date for the device event query, in ISO8061 format. For example,\n 2018-03-28T15:45:12.880Z\n

", - "smithy.api#httpQuery": "fromTimeStamp", + "smithy.api#documentation": "

The unique identifier of the device.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -719,32 +726,25 @@ "smithy.api#httpQuery": "toTimeStamp", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.iot1clickdevicesservice#__string", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } } } }, "com.amazonaws.iot1clickdevicesservice#ListDeviceEventsResponse": { "type": "structure", "members": { - "Events": { - "target": "com.amazonaws.iot1clickdevicesservice#__listOfDeviceEvent", - "traits": { - "smithy.api#documentation": "

An array of zero or more elements describing the event(s) associated with the\n device.

", - "smithy.api#jsonName": "events" - } - }, "NextToken": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results.

", "smithy.api#jsonName": "nextToken" } + }, + "Events": { + "target": "com.amazonaws.iot1clickdevicesservice#__listOfDeviceEvent", + "traits": { + "smithy.api#documentation": "

An array of zero or more elements describing the event(s) associated with the\n device.

", + "smithy.api#jsonName": "events" + } } } }, @@ -805,19 +805,19 @@ "com.amazonaws.iot1clickdevicesservice#ListDevicesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.iot1clickdevicesservice#__string", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#jsonName": "nextToken" - } - }, "Devices": { "target": "com.amazonaws.iot1clickdevicesservice#__listOfDeviceDescription", "traits": { "smithy.api#documentation": "

A list of devices.

", "smithy.api#jsonName": "devices" } + }, + "NextToken": { + "target": "com.amazonaws.iot1clickdevicesservice#__string", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -906,18 +906,18 @@ "com.amazonaws.iot1clickdevicesservice#RangeNotSatisfiableException": { "type": "structure", "members": { - "Message": { + "Code": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

The requested number of results specified by nextToken cannot be\n satisfied.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

416

", + "smithy.api#jsonName": "code" } }, - "Code": { + "Message": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

416

", - "smithy.api#jsonName": "code" + "smithy.api#documentation": "

The requested number of results specified by nextToken cannot be\n satisfied.

", + "smithy.api#jsonName": "message" } } }, @@ -952,18 +952,18 @@ "com.amazonaws.iot1clickdevicesservice#ResourceNotFoundException": { "type": "structure", "members": { - "Message": { + "Code": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

The requested device could not be found.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

404

", + "smithy.api#jsonName": "code" } }, - "Code": { + "Message": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { - "smithy.api#documentation": "

404

", - "smithy.api#jsonName": "code" + "smithy.api#documentation": "

The requested device could not be found.

", + "smithy.api#jsonName": "message" } } }, @@ -1000,14 +1000,6 @@ "com.amazonaws.iot1clickdevicesservice#TagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.iot1clickdevicesservice#__string", - "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.iot1clickdevicesservice#__mapOf__string", "traits": { @@ -1015,6 +1007,14 @@ "smithy.api#jsonName": "tags", "smithy.api#required": {} } + }, + "ResourceArn": { + "target": "com.amazonaws.iot1clickdevicesservice#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -1099,14 +1099,6 @@ "com.amazonaws.iot1clickdevicesservice#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.iot1clickdevicesservice#__string", - "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "TagKeys": { "target": "com.amazonaws.iot1clickdevicesservice#__listOf__string", "traits": { @@ -1114,6 +1106,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "ResourceArn": { + "target": "com.amazonaws.iot1clickdevicesservice#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -1148,13 +1148,6 @@ "com.amazonaws.iot1clickdevicesservice#UpdateDeviceStateRequest": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.iot1clickdevicesservice#__boolean", - "traits": { - "smithy.api#documentation": "

If true, the device is enabled. If false, the device is\n disabled.

", - "smithy.api#jsonName": "enabled" - } - }, "DeviceId": { "target": "com.amazonaws.iot1clickdevicesservice#__string", "traits": { @@ -1162,6 +1155,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Enabled": { + "target": "com.amazonaws.iot1clickdevicesservice#__boolean", + "traits": { + "smithy.api#documentation": "

If true, the device is enabled. If false, the device is\n disabled.

", + "smithy.api#jsonName": "enabled" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/iot-1click-projects.2018-05-14.json b/codegen/sdk-codegen/aws-models/iot-1click-projects.2018-05-14.json index 5957d37652b7..98ec95bc1b22 100644 --- a/codegen/sdk-codegen/aws-models/iot-1click-projects.2018-05-14.json +++ b/codegen/sdk-codegen/aws-models/iot-1click-projects.2018-05-14.json @@ -87,7 +87,7 @@ "sdkId": "IoT 1Click Projects", "arnNamespace": "iot1click", "cloudFormationName": "IoT1Click", - "cloudTrailEventSource": "projects.iot1click.amazonaws.com" + "cloudTrailEventSource": "iot1clickprojects.amazonaws.com" }, "aws.auth#sigv4": { "name": "iot1click" @@ -131,34 +131,34 @@ "com.amazonaws.iot1clickprojects#AssociateDeviceWithPlacementRequest": { "type": "structure", "members": { - "projectName": { - "target": "com.amazonaws.iot1clickprojects#ProjectName", + "placementName": { + "target": "com.amazonaws.iot1clickprojects#PlacementName", "traits": { - "smithy.api#documentation": "

The name of the project containing the placement in which to associate the device.

", + "smithy.api#documentation": "

The name of the placement in which to associate the device.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "placementName": { - "target": "com.amazonaws.iot1clickprojects#PlacementName", + "deviceTemplateName": { + "target": "com.amazonaws.iot1clickprojects#DeviceTemplateName", "traits": { - "smithy.api#documentation": "

The name of the placement in which to associate the device.

", + "smithy.api#documentation": "

The device template name to associate with the device ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "deviceId": { - "target": "com.amazonaws.iot1clickprojects#DeviceId", + "projectName": { + "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { - "smithy.api#documentation": "

The ID of the physical device to be associated with the given placement in the project.\n Note that a mandatory 4 character prefix is required for all deviceId\n values.

", + "smithy.api#documentation": "

The name of the project containing the placement in which to associate the device.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "deviceTemplateName": { - "target": "com.amazonaws.iot1clickprojects#DeviceTemplateName", + "deviceId": { + "target": "com.amazonaws.iot1clickprojects#DeviceId", "traits": { - "smithy.api#documentation": "

The device template name to associate with the device ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of the physical device to be associated with the given placement in the project.\n Note that a mandatory 4 character prefix is required for all deviceId\n values.

", "smithy.api#required": {} } } @@ -297,18 +297,18 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.iot1clickprojects#Description", - "traits": { - "smithy.api#documentation": "

An optional description for the project.

" - } - }, "placementTemplate": { "target": "com.amazonaws.iot1clickprojects#PlacementTemplate", "traits": { "smithy.api#documentation": "

The schema defining the placement to be created. A placement template defines placement\n default attributes and device templates. You cannot add or remove device templates after the\n project has been created. However, you can update callbackOverrides for the\n device templates using the UpdateProject API.

" } }, + "description": { + "target": "com.amazonaws.iot1clickprojects#Description", + "traits": { + "smithy.api#documentation": "

An optional description for the project.

" + } + }, "tags": { "target": "com.amazonaws.iot1clickprojects#TagMap", "traits": { @@ -364,18 +364,18 @@ "com.amazonaws.iot1clickprojects#DeletePlacementRequest": { "type": "structure", "members": { - "placementName": { - "target": "com.amazonaws.iot1clickprojects#PlacementName", + "projectName": { + "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the empty placement to delete.

", + "smithy.api#documentation": "

The project containing the empty placement to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "projectName": { - "target": "com.amazonaws.iot1clickprojects#ProjectName", + "placementName": { + "target": "com.amazonaws.iot1clickprojects#PlacementName", "traits": { - "smithy.api#documentation": "

The project containing the empty placement to delete.

", + "smithy.api#documentation": "

The name of the empty placement to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -465,18 +465,18 @@ "com.amazonaws.iot1clickprojects#DescribePlacementRequest": { "type": "structure", "members": { - "placementName": { - "target": "com.amazonaws.iot1clickprojects#PlacementName", + "projectName": { + "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the placement within a project.

", + "smithy.api#documentation": "

The project containing the placement to be described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "projectName": { - "target": "com.amazonaws.iot1clickprojects#ProjectName", + "placementName": { + "target": "com.amazonaws.iot1clickprojects#PlacementName", "traits": { - "smithy.api#documentation": "

The project containing the placement to be described.

", + "smithy.api#documentation": "

The name of the placement within a project.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -605,17 +605,17 @@ "com.amazonaws.iot1clickprojects#DeviceTemplate": { "type": "structure", "members": { - "callbackOverrides": { - "target": "com.amazonaws.iot1clickprojects#DeviceCallbackOverrideMap", - "traits": { - "smithy.api#documentation": "

An optional Lambda function to invoke instead of the default Lambda function provided by\n the placement template.

" - } - }, "deviceType": { "target": "com.amazonaws.iot1clickprojects#DeviceType", "traits": { "smithy.api#documentation": "

The device type, which currently must be \"button\".

" } + }, + "callbackOverrides": { + "target": "com.amazonaws.iot1clickprojects#DeviceCallbackOverrideMap", + "traits": { + "smithy.api#documentation": "

An optional Lambda function to invoke instead of the default Lambda function provided by\n the placement template.

" + } } }, "traits": { @@ -684,6 +684,14 @@ "com.amazonaws.iot1clickprojects#DisassociateDeviceFromPlacementRequest": { "type": "structure", "members": { + "placementName": { + "target": "com.amazonaws.iot1clickprojects#PlacementName", + "traits": { + "smithy.api#documentation": "

The name of the placement that the device should be removed from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "projectName": { "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { @@ -699,14 +707,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "placementName": { - "target": "com.amazonaws.iot1clickprojects#PlacementName", - "traits": { - "smithy.api#documentation": "

The name of the placement that the device should be removed from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -745,18 +745,18 @@ "com.amazonaws.iot1clickprojects#GetDevicesInPlacementRequest": { "type": "structure", "members": { - "projectName": { - "target": "com.amazonaws.iot1clickprojects#ProjectName", + "placementName": { + "target": "com.amazonaws.iot1clickprojects#PlacementName", "traits": { - "smithy.api#documentation": "

The name of the project containing the placement.

", + "smithy.api#documentation": "

The name of the placement to get the devices from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "placementName": { - "target": "com.amazonaws.iot1clickprojects#PlacementName", + "projectName": { + "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the placement to get the devices from.

", + "smithy.api#documentation": "

The name of the project containing the placement.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -800,14 +800,14 @@ "com.amazonaws.iot1clickprojects#InvalidRequestException": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.iot1clickprojects#Code", + "message": { + "target": "com.amazonaws.iot1clickprojects#Message", "traits": { "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.iot1clickprojects#Message", + "code": { + "target": "com.amazonaws.iot1clickprojects#Code", "traits": { "smithy.api#required": {} } @@ -864,37 +864,37 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.iot1clickprojects#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iot1clickprojects#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per request. If not set, a default value of 100 is\n used.

", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.iot1clickprojects#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, "com.amazonaws.iot1clickprojects#ListPlacementsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot1clickprojects#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to retrieve the next set of results - will be effectively empty if there\n are no further results.

" - } - }, "placements": { "target": "com.amazonaws.iot1clickprojects#PlacementSummaryList", "traits": { "smithy.api#documentation": "

An object listing the requested placements.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.iot1clickprojects#NextToken", + "traits": { + "smithy.api#documentation": "

The token used to retrieve the next set of results - will be effectively empty if there\n are no further results.

" + } } } }, @@ -1052,10 +1052,10 @@ "com.amazonaws.iot1clickprojects#PlacementDescription": { "type": "structure", "members": { - "createdDate": { - "target": "com.amazonaws.iot1clickprojects#Time", + "projectName": { + "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { - "smithy.api#documentation": "

The date when the placement was initially created, in UNIX epoch time format.

", + "smithy.api#documentation": "

The name of the project containing the placement.

", "smithy.api#required": {} } }, @@ -1066,24 +1066,24 @@ "smithy.api#required": {} } }, - "attributes": { - "target": "com.amazonaws.iot1clickprojects#PlacementAttributeMap", + "updatedDate": { + "target": "com.amazonaws.iot1clickprojects#Time", "traits": { - "smithy.api#documentation": "

The user-defined attributes associated with the placement.

", + "smithy.api#documentation": "

The date when the placement was last updated, in UNIX epoch time format. If the placement\n was not updated, then createdDate and updatedDate are the\n same.

", "smithy.api#required": {} } }, - "updatedDate": { + "createdDate": { "target": "com.amazonaws.iot1clickprojects#Time", "traits": { - "smithy.api#documentation": "

The date when the placement was last updated, in UNIX epoch time format. If the placement\n was not updated, then createdDate and updatedDate are the\n same.

", + "smithy.api#documentation": "

The date when the placement was initially created, in UNIX epoch time format.

", "smithy.api#required": {} } }, - "projectName": { - "target": "com.amazonaws.iot1clickprojects#ProjectName", + "attributes": { + "target": "com.amazonaws.iot1clickprojects#PlacementAttributeMap", "traits": { - "smithy.api#documentation": "

The name of the project containing the placement.

", + "smithy.api#documentation": "

The user-defined attributes associated with the placement.

", "smithy.api#required": {} } } @@ -1112,13 +1112,6 @@ "smithy.api#required": {} } }, - "updatedDate": { - "target": "com.amazonaws.iot1clickprojects#Time", - "traits": { - "smithy.api#documentation": "

The date when the placement was last updated, in UNIX epoch time format. If the placement\n was not updated, then createdDate and updatedDate are the\n same.

", - "smithy.api#required": {} - } - }, "projectName": { "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { @@ -1132,6 +1125,13 @@ "smithy.api#documentation": "

The name of the placement being summarized.

", "smithy.api#required": {} } + }, + "updatedDate": { + "target": "com.amazonaws.iot1clickprojects#Time", + "traits": { + "smithy.api#documentation": "

The date when the placement was last updated, in UNIX epoch time format. If the placement\n was not updated, then createdDate and updatedDate are the\n same.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1173,13 +1173,6 @@ "com.amazonaws.iot1clickprojects#ProjectDescription": { "type": "structure", "members": { - "createdDate": { - "target": "com.amazonaws.iot1clickprojects#Time", - "traits": { - "smithy.api#documentation": "

The date when the project was originally created, in UNIX epoch time format.

", - "smithy.api#required": {} - } - }, "projectName": { "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { @@ -1187,18 +1180,18 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.iot1clickprojects#TagMap", - "traits": { - "smithy.api#documentation": "

The tags (metadata key/value pairs) associated with the project.

" - } - }, "arn": { "target": "com.amazonaws.iot1clickprojects#ProjectArn", "traits": { "smithy.api#documentation": "

The ARN of the project.

" } }, + "description": { + "target": "com.amazonaws.iot1clickprojects#Description", + "traits": { + "smithy.api#documentation": "

The description of the project.

" + } + }, "updatedDate": { "target": "com.amazonaws.iot1clickprojects#Time", "traits": { @@ -1206,17 +1199,24 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.iot1clickprojects#Description", - "traits": { - "smithy.api#documentation": "

The description of the project.

" - } - }, "placementTemplate": { "target": "com.amazonaws.iot1clickprojects#PlacementTemplate", "traits": { "smithy.api#documentation": "

An object describing the project's placement specifications.

" } + }, + "tags": { + "target": "com.amazonaws.iot1clickprojects#TagMap", + "traits": { + "smithy.api#documentation": "

The tags (metadata key/value pairs) associated with the project.

" + } + }, + "createdDate": { + "target": "com.amazonaws.iot1clickprojects#Time", + "traits": { + "smithy.api#documentation": "

The date when the project was originally created, in UNIX epoch time format.

", + "smithy.api#required": {} + } } }, "traits": { @@ -1249,6 +1249,12 @@ "smithy.api#required": {} } }, + "tags": { + "target": "com.amazonaws.iot1clickprojects#TagMap", + "traits": { + "smithy.api#documentation": "

The tags (metadata key/value pairs) associated with the project.

" + } + }, "createdDate": { "target": "com.amazonaws.iot1clickprojects#Time", "traits": { @@ -1262,12 +1268,6 @@ "smithy.api#documentation": "

The date when the project was last updated, in UNIX epoch time format. If the project was\n not updated, then createdDate and updatedDate are the same.

", "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.iot1clickprojects#TagMap", - "traits": { - "smithy.api#documentation": "

The tags (metadata key/value pairs) associated with the project.

" - } } }, "traits": { @@ -1283,14 +1283,14 @@ "com.amazonaws.iot1clickprojects#ResourceConflictException": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.iot1clickprojects#Code", + "message": { + "target": "com.amazonaws.iot1clickprojects#Message", "traits": { "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.iot1clickprojects#Message", + "code": { + "target": "com.amazonaws.iot1clickprojects#Code", "traits": { "smithy.api#required": {} } @@ -1534,6 +1534,12 @@ "com.amazonaws.iot1clickprojects#UpdatePlacementRequest": { "type": "structure", "members": { + "attributes": { + "target": "com.amazonaws.iot1clickprojects#PlacementAttributeMap", + "traits": { + "smithy.api#documentation": "

The user-defined object of attributes used to update the placement. The maximum number of\n key/value pairs is 50.

" + } + }, "placementName": { "target": "com.amazonaws.iot1clickprojects#PlacementName", "traits": { @@ -1549,12 +1555,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "attributes": { - "target": "com.amazonaws.iot1clickprojects#PlacementAttributeMap", - "traits": { - "smithy.api#documentation": "

The user-defined object of attributes used to update the placement. The maximum number of\n key/value pairs is 50.

" - } } } }, @@ -1596,10 +1596,12 @@ "com.amazonaws.iot1clickprojects#UpdateProjectRequest": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.iot1clickprojects#Description", + "projectName": { + "target": "com.amazonaws.iot1clickprojects#ProjectName", "traits": { - "smithy.api#documentation": "

An optional user-defined description for the project.

" + "smithy.api#documentation": "

The name of the project to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "placementTemplate": { @@ -1608,12 +1610,10 @@ "smithy.api#documentation": "

An object defining the project update. Once a project has been created, you cannot add\n device template names to the project. However, for a given placementTemplate, you\n can update the associated callbackOverrides for the device definition using this\n API.

" } }, - "projectName": { - "target": "com.amazonaws.iot1clickprojects#ProjectName", + "description": { + "target": "com.amazonaws.iot1clickprojects#Description", "traits": { - "smithy.api#documentation": "

The name of the project to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

An optional user-defined description for the project.

" } } } diff --git a/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json b/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json index b1759f2f01c2..e8d1bdd951d6 100644 --- a/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json +++ b/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json @@ -265,7 +265,7 @@ "sdkId": "IoT Data Plane", "arnNamespace": "iotdata", "cloudFormationName": "IoTDataPlane", - "cloudTrailEventSource": "moonraker.iot.amazonaws.com" + "cloudTrailEventSource": "iotdataplane.amazonaws.com" }, "aws.auth#sigv4": { "name": "iotdata" @@ -321,13 +321,6 @@ "com.amazonaws.iotdataplane#ListNamedShadowsForThingRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotdataplane#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "thingName": { "target": "com.amazonaws.iotdataplane#ThingName", "traits": { @@ -342,18 +335,19 @@ "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } + }, + "nextToken": { + "target": "com.amazonaws.iotdataplane#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, "com.amazonaws.iotdataplane#ListNamedShadowsForThingResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotdataplane#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" - } - }, "results": { "target": "com.amazonaws.iotdataplane#NamedShadowList", "traits": { @@ -365,6 +359,12 @@ "traits": { "smithy.api#documentation": "

The Epoch date and time the response was generated by AWS IoT.

" } + }, + "nextToken": { + "target": "com.amazonaws.iotdataplane#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/iot-events-data.2018-10-23.json b/codegen/sdk-codegen/aws-models/iot-events-data.2018-10-23.json index 9adcb805dfa7..7d5f055a77e5 100644 --- a/codegen/sdk-codegen/aws-models/iot-events-data.2018-10-23.json +++ b/codegen/sdk-codegen/aws-models/iot-events-data.2018-10-23.json @@ -69,6 +69,12 @@ "com.amazonaws.ioteventsdata#BatchPutMessageErrorEntry": { "type": "structure", "members": { + "errorMessage": { + "target": "com.amazonaws.ioteventsdata#ErrorMessage", + "traits": { + "smithy.api#documentation": "

More information about the error.

" + } + }, "messageId": { "target": "com.amazonaws.ioteventsdata#MessageId", "traits": { @@ -80,12 +86,6 @@ "traits": { "smithy.api#documentation": "

The code associated with the error.

" } - }, - "errorMessage": { - "target": "com.amazonaws.ioteventsdata#ErrorMessage", - "traits": { - "smithy.api#documentation": "

More information about the error.

" - } } }, "traits": { @@ -155,6 +155,12 @@ "com.amazonaws.ioteventsdata#BatchUpdateDetectorErrorEntry": { "type": "structure", "members": { + "messageId": { + "target": "com.amazonaws.ioteventsdata#MessageId", + "traits": { + "smithy.api#documentation": "

The \"messageId\" of the update request that caused the error. (The value of the \n \"messageId\" in the update request \"Detector\" object.)

" + } + }, "errorMessage": { "target": "com.amazonaws.ioteventsdata#ErrorMessage", "traits": { @@ -166,12 +172,6 @@ "traits": { "smithy.api#documentation": "

The code of the error.

" } - }, - "messageId": { - "target": "com.amazonaws.ioteventsdata#MessageId", - "traits": { - "smithy.api#documentation": "

The \"messageId\" of the update request that caused the error. (The value of the \n \"messageId\" in the update request \"Detector\" object.)

" - } } }, "traits": { @@ -269,24 +269,12 @@ "com.amazonaws.ioteventsdata#Detector": { "type": "structure", "members": { - "lastUpdateTime": { - "target": "com.amazonaws.ioteventsdata#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the detector (instance) was last updated.

" - } - }, "state": { "target": "com.amazonaws.ioteventsdata#DetectorState", "traits": { "smithy.api#documentation": "

The current state of the detector (instance).

" } }, - "keyValue": { - "target": "com.amazonaws.ioteventsdata#KeyValue", - "traits": { - "smithy.api#documentation": "

The value of the key (identifying the device or system) that caused the creation of this \n detector (instance).

" - } - }, "creationTime": { "target": "com.amazonaws.ioteventsdata#Timestamp", "traits": { @@ -299,11 +287,23 @@ "smithy.api#documentation": "

The name of the detector model that created this detector (instance).

" } }, + "lastUpdateTime": { + "target": "com.amazonaws.ioteventsdata#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the detector (instance) was last updated.

" + } + }, "detectorModelVersion": { "target": "com.amazonaws.ioteventsdata#DetectorModelVersion", "traits": { "smithy.api#documentation": "

The version of the detector model that created this detector (instance).

" } + }, + "keyValue": { + "target": "com.amazonaws.ioteventsdata#KeyValue", + "traits": { + "smithy.api#documentation": "

The value of the key (identifying the device or system) that caused the creation of this \n detector (instance).

" + } } }, "traits": { @@ -339,17 +339,17 @@ "smithy.api#required": {} } }, - "timers": { - "target": "com.amazonaws.ioteventsdata#Timers", + "variables": { + "target": "com.amazonaws.ioteventsdata#Variables", "traits": { - "smithy.api#documentation": "

The current state of the detector's timers.

", + "smithy.api#documentation": "

The current values of the detector's variables.

", "smithy.api#required": {} } }, - "variables": { - "target": "com.amazonaws.ioteventsdata#Variables", + "timers": { + "target": "com.amazonaws.ioteventsdata#Timers", "traits": { - "smithy.api#documentation": "

The current values of the detector's variables.

", + "smithy.api#documentation": "

The current state of the detector's timers.

", "smithy.api#required": {} } } @@ -361,10 +361,10 @@ "com.amazonaws.ioteventsdata#DetectorStateDefinition": { "type": "structure", "members": { - "variables": { - "target": "com.amazonaws.ioteventsdata#VariableDefinitions", + "stateName": { + "target": "com.amazonaws.ioteventsdata#StateName", "traits": { - "smithy.api#documentation": "

The new values of the detector's variables. Any variable whose value isn't specified is cleared.

", + "smithy.api#documentation": "

The name of the new state of the detector (instance).

", "smithy.api#required": {} } }, @@ -375,10 +375,10 @@ "smithy.api#required": {} } }, - "stateName": { - "target": "com.amazonaws.ioteventsdata#StateName", + "variables": { + "target": "com.amazonaws.ioteventsdata#VariableDefinitions", "traits": { - "smithy.api#documentation": "

The name of the new state of the detector (instance).

", + "smithy.api#documentation": "

The new values of the detector's variables. Any variable whose value isn't specified is cleared.

", "smithy.api#required": {} } } @@ -416,16 +416,16 @@ "smithy.api#documentation": "

The time the detector (instance) was created.

" } }, - "state": { - "target": "com.amazonaws.ioteventsdata#DetectorStateSummary", + "detectorModelVersion": { + "target": "com.amazonaws.ioteventsdata#DetectorModelVersion", "traits": { - "smithy.api#documentation": "

The current state of the detector (instance).

" + "smithy.api#documentation": "

The version of the detector model that created this detector (instance).

" } }, - "keyValue": { - "target": "com.amazonaws.ioteventsdata#KeyValue", + "detectorModelName": { + "target": "com.amazonaws.ioteventsdata#DetectorModelName", "traits": { - "smithy.api#documentation": "

The value of the key (identifying the device or system) that caused the creation of this \n detector (instance).

" + "smithy.api#documentation": "

The name of the detector model that created this detector (instance).

" } }, "lastUpdateTime": { @@ -434,16 +434,16 @@ "smithy.api#documentation": "

The time the detector (instance) was last updated.

" } }, - "detectorModelName": { - "target": "com.amazonaws.ioteventsdata#DetectorModelName", + "state": { + "target": "com.amazonaws.ioteventsdata#DetectorStateSummary", "traits": { - "smithy.api#documentation": "

The name of the detector model that created this detector (instance).

" + "smithy.api#documentation": "

The current state of the detector (instance).

" } }, - "detectorModelVersion": { - "target": "com.amazonaws.ioteventsdata#DetectorModelVersion", + "keyValue": { + "target": "com.amazonaws.ioteventsdata#KeyValue", "traits": { - "smithy.api#documentation": "

The version of the detector model that created this detector (instance).

" + "smithy.api#documentation": "

The value of the key (identifying the device or system) that caused the creation of this \n detector (instance).

" } } }, @@ -545,7 +545,7 @@ "sdkId": "IoT Events Data", "arnNamespace": "ioteventsdata", "cloudFormationName": "IoTEventsData", - "cloudTrailEventSource": "data.columbo.iot.amazon.com" + "cloudTrailEventSource": "ioteventsdata.amazonaws.com" }, "aws.auth#sigv4": { "name": "ioteventsdata" @@ -602,6 +602,13 @@ "com.amazonaws.ioteventsdata#ListDetectorsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.ioteventsdata#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" + } + }, "stateName": { "target": "com.amazonaws.ioteventsdata#StateName", "traits": { @@ -623,30 +630,23 @@ "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } - }, - "maxResults": { - "target": "com.amazonaws.ioteventsdata#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "maxResults" - } } } }, "com.amazonaws.ioteventsdata#ListDetectorsResponse": { "type": "structure", "members": { - "detectorSummaries": { - "target": "com.amazonaws.ioteventsdata#DetectorSummaries", - "traits": { - "smithy.api#documentation": "

A list of summary information about the detectors (instances).

" - } - }, "nextToken": { "target": "com.amazonaws.ioteventsdata#NextToken", "traits": { "smithy.api#documentation": "

A token to retrieve the next set of results, or null if there are no additional \n results.

" } + }, + "detectorSummaries": { + "target": "com.amazonaws.ioteventsdata#DetectorSummaries", + "traits": { + "smithy.api#documentation": "

A list of summary information about the detectors (instances).

" + } } } }, @@ -670,17 +670,17 @@ "smithy.api#required": {} } }, - "payload": { - "target": "com.amazonaws.ioteventsdata#Payload", + "inputName": { + "target": "com.amazonaws.ioteventsdata#InputName", "traits": { - "smithy.api#documentation": "

The payload of the message. This can be a JSON string or a Base-64-encoded string representing\n binary data (in which case you must decode it).

", + "smithy.api#documentation": "

The name of the input into which the message payload is transformed.

", "smithy.api#required": {} } }, - "inputName": { - "target": "com.amazonaws.ioteventsdata#InputName", + "payload": { + "target": "com.amazonaws.ioteventsdata#Payload", "traits": { - "smithy.api#documentation": "

The name of the input into which the message payload is transformed.

", + "smithy.api#documentation": "

The payload of the message. This can be a JSON string or a Base-64-encoded string representing\n binary data (in which case you must decode it).

", "smithy.api#required": {} } } @@ -850,17 +850,17 @@ "com.amazonaws.ioteventsdata#UpdateDetectorRequest": { "type": "structure", "members": { - "messageId": { - "target": "com.amazonaws.ioteventsdata#MessageId", + "state": { + "target": "com.amazonaws.ioteventsdata#DetectorStateDefinition", "traits": { - "smithy.api#documentation": "

The ID to assign to the detector update \"message\". Each \"messageId\" \n must be unique within each batch sent.

", + "smithy.api#documentation": "

The new state, variable values, and timer settings of the detector (instance).

", "smithy.api#required": {} } }, - "state": { - "target": "com.amazonaws.ioteventsdata#DetectorStateDefinition", + "messageId": { + "target": "com.amazonaws.ioteventsdata#MessageId", "traits": { - "smithy.api#documentation": "

The new state, variable values, and timer settings of the detector (instance).

", + "smithy.api#documentation": "

The ID to assign to the detector update \"message\". Each \"messageId\" \n must be unique within each batch sent.

", "smithy.api#required": {} } }, @@ -918,17 +918,17 @@ "com.amazonaws.ioteventsdata#VariableDefinition": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.ioteventsdata#VariableValue", + "name": { + "target": "com.amazonaws.ioteventsdata#VariableName", "traits": { - "smithy.api#documentation": "

The new value of the variable.

", + "smithy.api#documentation": "

The name of the variable.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.ioteventsdata#VariableName", + "value": { + "target": "com.amazonaws.ioteventsdata#VariableValue", "traits": { - "smithy.api#documentation": "

The name of the variable.

", + "smithy.api#documentation": "

The new value of the variable.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/iot-events.2018-07-27.json b/codegen/sdk-codegen/aws-models/iot-events.2018-07-27.json index 3da739fbce82..89b4c9df0582 100644 --- a/codegen/sdk-codegen/aws-models/iot-events.2018-07-27.json +++ b/codegen/sdk-codegen/aws-models/iot-events.2018-07-27.json @@ -32,16 +32,22 @@ "com.amazonaws.iotevents#Action": { "type": "structure", "members": { - "firehose": { - "target": "com.amazonaws.iotevents#FirehoseAction", + "setTimer": { + "target": "com.amazonaws.iotevents#SetTimerAction", "traits": { - "smithy.api#documentation": "

Sends information about the detector model instance and the event that triggered the\n action to an Amazon Kinesis Data Firehose delivery stream.

" + "smithy.api#documentation": "

Information needed to set the timer.

" } }, - "iotTopicPublish": { - "target": "com.amazonaws.iotevents#IotTopicPublishAction", + "resetTimer": { + "target": "com.amazonaws.iotevents#ResetTimerAction", "traits": { - "smithy.api#documentation": "

Publishes an MQTT message with the given topic to the AWS IoT message broker.

" + "smithy.api#documentation": "

Information needed to reset the timer.

" + } + }, + "dynamoDB": { + "target": "com.amazonaws.iotevents#DynamoDBAction", + "traits": { + "smithy.api#documentation": "

Writes to the DynamoDB table that you created. The default action payload contains all\n attribute-value pairs that have the information about the detector model instance and the\n event that triggered the action. You can also customize the payload. One column of the\n DynamoDB table receives all attribute-value pairs in the payload that you specify. For more\n information, see Actions in\n AWS IoT Events Developer Guide.

" } }, "dynamoDBv2": { @@ -50,10 +56,10 @@ "smithy.api#documentation": "

Writes to the DynamoDB table that you created. The default action payload contains all\n attribute-value pairs that have the information about the detector model instance and the\n event that triggered the action. You can also customize the payload. A separate column of\n the DynamoDB table receives one attribute-value pair in the payload that you specify. For more\n information, see Actions in\n AWS IoT Events Developer Guide.

" } }, - "setTimer": { - "target": "com.amazonaws.iotevents#SetTimerAction", + "setVariable": { + "target": "com.amazonaws.iotevents#SetVariableAction", "traits": { - "smithy.api#documentation": "

Information needed to set the timer.

" + "smithy.api#documentation": "

Sets a variable to a specified value.

" } }, "clearTimer": { @@ -62,52 +68,46 @@ "smithy.api#documentation": "

Information needed to clear the timer.

" } }, - "dynamoDB": { - "target": "com.amazonaws.iotevents#DynamoDBAction", - "traits": { - "smithy.api#documentation": "

Writes to the DynamoDB table that you created. The default action payload contains all\n attribute-value pairs that have the information about the detector model instance and the\n event that triggered the action. You can also customize the payload. One column of the\n DynamoDB table receives all attribute-value pairs in the payload that you specify. For more\n information, see Actions in\n AWS IoT Events Developer Guide.

" - } - }, - "resetTimer": { - "target": "com.amazonaws.iotevents#ResetTimerAction", + "iotEvents": { + "target": "com.amazonaws.iotevents#IotEventsAction", "traits": { - "smithy.api#documentation": "

Information needed to reset the timer.

" + "smithy.api#documentation": "

Sends AWS IoT Events input, which passes information about the detector model instance and the\n event that triggered the action.

" } }, - "sns": { - "target": "com.amazonaws.iotevents#SNSTopicPublishAction", + "sqs": { + "target": "com.amazonaws.iotevents#SqsAction", "traits": { - "smithy.api#documentation": "

Sends an Amazon SNS message.

" + "smithy.api#documentation": "

Sends information about the detector model instance and the event that triggered the\n action to an Amazon SQS queue.

" } }, - "setVariable": { - "target": "com.amazonaws.iotevents#SetVariableAction", + "iotTopicPublish": { + "target": "com.amazonaws.iotevents#IotTopicPublishAction", "traits": { - "smithy.api#documentation": "

Sets a variable to a specified value.

" + "smithy.api#documentation": "

Publishes an MQTT message with the given topic to the AWS IoT message broker.

" } }, - "sqs": { - "target": "com.amazonaws.iotevents#SqsAction", + "iotSiteWise": { + "target": "com.amazonaws.iotevents#IotSiteWiseAction", "traits": { - "smithy.api#documentation": "

Sends information about the detector model instance and the event that triggered the\n action to an Amazon SQS queue.

" + "smithy.api#documentation": "

Sends information about the detector model instance and the event that triggered the\n action to an asset property in AWS IoT SiteWise .

" } }, - "lambda": { - "target": "com.amazonaws.iotevents#LambdaAction", + "firehose": { + "target": "com.amazonaws.iotevents#FirehoseAction", "traits": { - "smithy.api#documentation": "

Calls a Lambda function, passing in information about the detector model instance and the\n event that triggered the action.

" + "smithy.api#documentation": "

Sends information about the detector model instance and the event that triggered the\n action to an Amazon Kinesis Data Firehose delivery stream.

" } }, - "iotEvents": { - "target": "com.amazonaws.iotevents#IotEventsAction", + "sns": { + "target": "com.amazonaws.iotevents#SNSTopicPublishAction", "traits": { - "smithy.api#documentation": "

Sends AWS IoT Events input, which passes information about the detector model instance and the\n event that triggered the action.

" + "smithy.api#documentation": "

Sends an Amazon SNS message.

" } }, - "iotSiteWise": { - "target": "com.amazonaws.iotevents#IotSiteWiseAction", + "lambda": { + "target": "com.amazonaws.iotevents#LambdaAction", "traits": { - "smithy.api#documentation": "

Sends information about the detector model instance and the event that triggered the\n action to an asset property in AWS IoT SiteWise .

" + "smithy.api#documentation": "

Calls a Lambda function, passing in information about the detector model instance and the\n event that triggered the action.

" } } }, @@ -187,11 +187,10 @@ "com.amazonaws.iotevents#AssetPropertyValue": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotevents#AssetPropertyVariant", + "quality": { + "target": "com.amazonaws.iotevents#AssetPropertyQuality", "traits": { - "smithy.api#documentation": "

The value to send to an asset property.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The quality of the asset property value. The value must be GOOD,\n BAD, or UNCERTAIN. You can also specify an expression.

" } }, "timestamp": { @@ -200,10 +199,11 @@ "smithy.api#documentation": "

The timestamp associated with the asset property value. The default is the current event\n time.

" } }, - "quality": { - "target": "com.amazonaws.iotevents#AssetPropertyQuality", + "value": { + "target": "com.amazonaws.iotevents#AssetPropertyVariant", "traits": { - "smithy.api#documentation": "

The quality of the asset property value. The value must be GOOD,\n BAD, or UNCERTAIN. You can also specify an expression.

" + "smithy.api#documentation": "

The value to send to an asset property.

", + "smithy.api#required": {} } } }, @@ -214,18 +214,6 @@ "com.amazonaws.iotevents#AssetPropertyVariant": { "type": "structure", "members": { - "booleanValue": { - "target": "com.amazonaws.iotevents#AssetPropertyBooleanValue", - "traits": { - "smithy.api#documentation": "

The asset property value is a Boolean value that must be TRUE or\n FALSE. You can also specify an expression. If you use an expression, the\n evaluated result should be a Boolean value.

" - } - }, - "doubleValue": { - "target": "com.amazonaws.iotevents#AssetPropertyDoubleValue", - "traits": { - "smithy.api#documentation": "

The asset property value is a double. You can also specify an expression. If you use an\n expression, the evaluated result should be a double.

" - } - }, "stringValue": { "target": "com.amazonaws.iotevents#AssetPropertyStringValue", "traits": { @@ -237,6 +225,18 @@ "traits": { "smithy.api#documentation": "

The asset property value is an integer. You can also specify an expression. If you use an\n expression, the evaluated result should be an integer.

" } + }, + "doubleValue": { + "target": "com.amazonaws.iotevents#AssetPropertyDoubleValue", + "traits": { + "smithy.api#documentation": "

The asset property value is a double. You can also specify an expression. If you use an\n expression, the evaluated result should be a double.

" + } + }, + "booleanValue": { + "target": "com.amazonaws.iotevents#AssetPropertyBooleanValue", + "traits": { + "smithy.api#documentation": "

The asset property value is a Boolean value that must be TRUE or\n FALSE. You can also specify an expression. If you use an expression, the\n evaluated result should be a Boolean value.

" + } } }, "traits": { @@ -355,16 +355,11 @@ "com.amazonaws.iotevents#CreateDetectorModelRequest": { "type": "structure", "members": { - "evaluationMethod": { - "target": "com.amazonaws.iotevents#EvaluationMethod", - "traits": { - "smithy.api#documentation": "

Information about the order in which events are evaluated and how actions are executed.\n

" - } - }, - "key": { - "target": "com.amazonaws.iotevents#AttributeJsonPath", + "roleArn": { + "target": "com.amazonaws.iotevents#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The input attribute key used to identify a device or system to create a detector (an\n instance of the detector model) and then to route each input received to the appropriate\n detector (instance). This parameter uses a JSON-path expression in the message payload of each\n input to specify the attribute-value pair that is used to identify the device associated with\n the input.

" + "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

", + "smithy.api#required": {} } }, "detectorModelDescription": { @@ -373,23 +368,22 @@ "smithy.api#documentation": "

A brief description of the detector model.

" } }, - "detectorModelDefinition": { - "target": "com.amazonaws.iotevents#DetectorModelDefinition", - "traits": { - "smithy.api#documentation": "

Information that defines how the detectors operate.

", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.iotevents#Tags", "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the detector model.

" } }, - "roleArn": { - "target": "com.amazonaws.iotevents#AmazonResourceName", + "key": { + "target": "com.amazonaws.iotevents#AttributeJsonPath", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

", + "smithy.api#documentation": "

The input attribute key used to identify a device or system to create a detector (an\n instance of the detector model) and then to route each input received to the appropriate\n detector (instance). This parameter uses a JSON-path expression in the message payload of each\n input to specify the attribute-value pair that is used to identify the device associated with\n the input.

" + } + }, + "detectorModelDefinition": { + "target": "com.amazonaws.iotevents#DetectorModelDefinition", + "traits": { + "smithy.api#documentation": "

Information that defines how the detectors operate.

", "smithy.api#required": {} } }, @@ -399,6 +393,12 @@ "smithy.api#documentation": "

The name of the detector model.

", "smithy.api#required": {} } + }, + "evaluationMethod": { + "target": "com.amazonaws.iotevents#EvaluationMethod", + "traits": { + "smithy.api#documentation": "

Information about the order in which events are evaluated and how actions are executed.\n

" + } } } }, @@ -450,19 +450,6 @@ "com.amazonaws.iotevents#CreateInputRequest": { "type": "structure", "members": { - "inputDescription": { - "target": "com.amazonaws.iotevents#InputDescription", - "traits": { - "smithy.api#documentation": "

A brief description of the input.

" - } - }, - "inputName": { - "target": "com.amazonaws.iotevents#InputName", - "traits": { - "smithy.api#documentation": "

The name you want to give to the input.

", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.iotevents#Tags", "traits": { @@ -475,6 +462,19 @@ "smithy.api#documentation": "

The definition of the input.

", "smithy.api#required": {} } + }, + "inputName": { + "target": "com.amazonaws.iotevents#InputName", + "traits": { + "smithy.api#documentation": "

The name you want to give to the input.

", + "smithy.api#required": {} + } + }, + "inputDescription": { + "target": "com.amazonaws.iotevents#InputDescription", + "traits": { + "smithy.api#documentation": "

A brief description of the input.

" + } } } }, @@ -833,6 +833,12 @@ "com.amazonaws.iotevents#DetectorModelConfiguration": { "type": "structure", "members": { + "roleArn": { + "target": "com.amazonaws.iotevents#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

" + } + }, "creationTime": { "target": "com.amazonaws.iotevents#Timestamp", "traits": { @@ -845,22 +851,22 @@ "smithy.api#documentation": "

Information about the order in which events are evaluated and how actions are executed.\n

" } }, - "roleArn": { - "target": "com.amazonaws.iotevents#AmazonResourceName", + "key": { + "target": "com.amazonaws.iotevents#AttributeJsonPath", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

" + "smithy.api#documentation": "

The value used to identify a detector instance. When a device or system sends input, a new\n detector instance with a unique key value is created. AWS IoT Events can continue to route input to its\n corresponding detector instance based on this identifying information.

\n

This parameter uses a JSON-path expression to select the attribute-value pair in the\n message payload that is used for identification. To route the message to the correct detector\n instance, the device must send a message payload that contains the same\n attribute-value.

" } }, - "detectorModelVersion": { - "target": "com.amazonaws.iotevents#DetectorModelVersion", + "lastUpdateTime": { + "target": "com.amazonaws.iotevents#Timestamp", "traits": { - "smithy.api#documentation": "

The version of the detector model.

" + "smithy.api#documentation": "

The time the detector model was last updated.

" } }, - "detectorModelArn": { - "target": "com.amazonaws.iotevents#DetectorModelArn", + "detectorModelVersion": { + "target": "com.amazonaws.iotevents#DetectorModelVersion", "traits": { - "smithy.api#documentation": "

The ARN of the detector model.

" + "smithy.api#documentation": "

The version of the detector model.

" } }, "detectorModelName": { @@ -869,10 +875,10 @@ "smithy.api#documentation": "

The name of the detector model.

" } }, - "key": { - "target": "com.amazonaws.iotevents#AttributeJsonPath", + "detectorModelArn": { + "target": "com.amazonaws.iotevents#DetectorModelArn", "traits": { - "smithy.api#documentation": "

The value used to identify a detector instance. When a device or system sends input, a new\n detector instance with a unique key value is created. AWS IoT Events can continue to route input to its\n corresponding detector instance based on this identifying information.

\n

This parameter uses a JSON-path expression to select the attribute-value pair in the\n message payload that is used for identification. To route the message to the correct detector\n instance, the device must send a message payload that contains the same\n attribute-value.

" + "smithy.api#documentation": "

The ARN of the detector model.

" } }, "detectorModelDescription": { @@ -886,12 +892,6 @@ "traits": { "smithy.api#documentation": "

The status of the detector model.

" } - }, - "lastUpdateTime": { - "target": "com.amazonaws.iotevents#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the detector model was last updated.

" - } } }, "traits": { @@ -948,18 +948,18 @@ "com.amazonaws.iotevents#DetectorModelSummary": { "type": "structure", "members": { - "creationTime": { - "target": "com.amazonaws.iotevents#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the detector model was created.

" - } - }, "detectorModelDescription": { "target": "com.amazonaws.iotevents#DetectorModelDescription", "traits": { "smithy.api#documentation": "

A brief description of the detector model.

" } }, + "creationTime": { + "target": "com.amazonaws.iotevents#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the detector model was created.

" + } + }, "detectorModelName": { "target": "com.amazonaws.iotevents#DetectorModelName", "traits": { @@ -1024,10 +1024,16 @@ "com.amazonaws.iotevents#DetectorModelVersionSummary": { "type": "structure", "members": { - "lastUpdateTime": { + "detectorModelArn": { + "target": "com.amazonaws.iotevents#DetectorModelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the detector model version.

" + } + }, + "creationTime": { "target": "com.amazonaws.iotevents#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the detector model version was updated.

" + "smithy.api#documentation": "

The time the detector model version was created.

" } }, "status": { @@ -1036,12 +1042,6 @@ "smithy.api#documentation": "

The status of the detector model version.

" } }, - "detectorModelArn": { - "target": "com.amazonaws.iotevents#DetectorModelArn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector model version.

" - } - }, "detectorModelName": { "target": "com.amazonaws.iotevents#DetectorModelName", "traits": { @@ -1054,16 +1054,16 @@ "smithy.api#documentation": "

The ID of the detector model version.

" } }, - "evaluationMethod": { - "target": "com.amazonaws.iotevents#EvaluationMethod", + "lastUpdateTime": { + "target": "com.amazonaws.iotevents#Timestamp", "traits": { - "smithy.api#documentation": "

Information about the order in which events are evaluated and how actions are executed.\n

" + "smithy.api#documentation": "

The last time the detector model version was updated.

" } }, - "creationTime": { - "target": "com.amazonaws.iotevents#Timestamp", + "evaluationMethod": { + "target": "com.amazonaws.iotevents#EvaluationMethod", "traits": { - "smithy.api#documentation": "

The time the detector model version was created.

" + "smithy.api#documentation": "

Information about the order in which events are evaluated and how actions are executed.\n

" } }, "roleArn": { @@ -1080,10 +1080,16 @@ "com.amazonaws.iotevents#DynamoDBAction": { "type": "structure", "members": { - "rangeKeyValue": { - "target": "com.amazonaws.iotevents#DynamoKeyValue", + "rangeKeyField": { + "target": "com.amazonaws.iotevents#DynamoKeyField", "traits": { - "smithy.api#documentation": "

The value of the range key (also called the sort key).

" + "smithy.api#documentation": "

The name of the range key (also called the sort key).

" + } + }, + "operation": { + "target": "com.amazonaws.iotevents#DynamoOperation", + "traits": { + "smithy.api#documentation": "

The type of operation to perform. You can specify the following values:

\n \n

If you don't specify this parameter, AWS IoT Events triggers the INSERT\n operation.

" } }, "payloadField": { @@ -1092,52 +1098,46 @@ "smithy.api#documentation": "

The name of the DynamoDB column that receives the action payload.

\n

If you don't specify this parameter, the name of the DynamoDB column is\n payload.

" } }, - "tableName": { - "target": "com.amazonaws.iotevents#DynamoTableName", + "hashKeyField": { + "target": "com.amazonaws.iotevents#DynamoKeyField", "traits": { - "smithy.api#documentation": "

The name of the DynamoDB table.

", + "smithy.api#documentation": "

The name of the hash key (also called the partition key).

", "smithy.api#required": {} } }, - "hashKeyValue": { - "target": "com.amazonaws.iotevents#DynamoKeyValue", + "rangeKeyType": { + "target": "com.amazonaws.iotevents#DynamoKeyType", "traits": { - "smithy.api#documentation": "

The value of the hash key (also called the partition key).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The data type for the range key (also called the sort key), You can specify the following\n values:

\n \n

If you don't specify rangeKeyField, the default value is\n STRING.

" } }, - "payload": { - "target": "com.amazonaws.iotevents#Payload" - }, "hashKeyType": { "target": "com.amazonaws.iotevents#DynamoKeyType", "traits": { "smithy.api#documentation": "

The data type for the hash key (also called the partition key). You can specify the\n following values:

\n \n

If you don't specify hashKeyType, the default value is\n STRING.

" } }, - "hashKeyField": { - "target": "com.amazonaws.iotevents#DynamoKeyField", + "tableName": { + "target": "com.amazonaws.iotevents#DynamoTableName", "traits": { - "smithy.api#documentation": "

The name of the hash key (also called the partition key).

", + "smithy.api#documentation": "

The name of the DynamoDB table.

", "smithy.api#required": {} } }, - "rangeKeyType": { - "target": "com.amazonaws.iotevents#DynamoKeyType", + "rangeKeyValue": { + "target": "com.amazonaws.iotevents#DynamoKeyValue", "traits": { - "smithy.api#documentation": "

The data type for the range key (also called the sort key), You can specify the following\n values:

\n \n

If you don't specify rangeKeyField, the default value is\n STRING.

" + "smithy.api#documentation": "

The value of the range key (also called the sort key).

" } }, - "operation": { - "target": "com.amazonaws.iotevents#DynamoOperation", - "traits": { - "smithy.api#documentation": "

The type of operation to perform. You can specify the following values:

\n \n

If you don't specify this parameter, AWS IoT Events triggers the INSERT\n operation.

" - } + "payload": { + "target": "com.amazonaws.iotevents#Payload" }, - "rangeKeyField": { - "target": "com.amazonaws.iotevents#DynamoKeyField", + "hashKeyValue": { + "target": "com.amazonaws.iotevents#DynamoKeyValue", "traits": { - "smithy.api#documentation": "

The name of the range key (also called the sort key).

" + "smithy.api#documentation": "

The value of the hash key (also called the partition key).

", + "smithy.api#required": {} } } }, @@ -1196,11 +1196,10 @@ "com.amazonaws.iotevents#Event": { "type": "structure", "members": { - "eventName": { - "target": "com.amazonaws.iotevents#EventName", + "condition": { + "target": "com.amazonaws.iotevents#Condition", "traits": { - "smithy.api#documentation": "

The name of the event.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Optional. The Boolean expression that, when TRUE, causes the actions to be\n performed. If not present, the actions are performed (=TRUE). If the expression result is not\n a Boolean value, the actions are not performed (=FALSE).

" } }, "actions": { @@ -1209,10 +1208,11 @@ "smithy.api#documentation": "

The actions to be performed.

" } }, - "condition": { - "target": "com.amazonaws.iotevents#Condition", + "eventName": { + "target": "com.amazonaws.iotevents#EventName", "traits": { - "smithy.api#documentation": "

Optional. The Boolean expression that, when TRUE, causes the actions to be\n performed. If not present, the actions are performed (=TRUE). If the expression result is not\n a Boolean value, the actions are not performed (=FALSE).

" + "smithy.api#documentation": "

The name of the event.

", + "smithy.api#required": {} } } }, @@ -1241,14 +1241,8 @@ "deliveryStreamName": { "target": "com.amazonaws.iotevents#DeliveryStreamName", "traits": { - "smithy.api#documentation": "

The name of the Kinesis Data Firehose delivery stream where the data is written.

", - "smithy.api#required": {} - } - }, - "payload": { - "target": "com.amazonaws.iotevents#Payload", - "traits": { - "smithy.api#documentation": "

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery\n stream.

" + "smithy.api#documentation": "

The name of the Kinesis Data Firehose delivery stream where the data is written.

", + "smithy.api#required": {} } }, "separator": { @@ -1256,6 +1250,12 @@ "traits": { "smithy.api#documentation": "

A character separator that is used to separate records written to the Kinesis Data\n Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows\n newline), ',' (comma).

" } + }, + "payload": { + "target": "com.amazonaws.iotevents#Payload", + "traits": { + "smithy.api#documentation": "

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery\n stream.

" + } } }, "traits": { @@ -1271,17 +1271,17 @@ "com.amazonaws.iotevents#Input": { "type": "structure", "members": { - "inputConfiguration": { - "target": "com.amazonaws.iotevents#InputConfiguration", - "traits": { - "smithy.api#documentation": "

Information about the configuration of an input.

" - } - }, "inputDefinition": { "target": "com.amazonaws.iotevents#InputDefinition", "traits": { "smithy.api#documentation": "

The definition of the input.

" } + }, + "inputConfiguration": { + "target": "com.amazonaws.iotevents#InputConfiguration", + "traits": { + "smithy.api#documentation": "

Information about the configuration of an input.

" + } } }, "traits": { @@ -1294,17 +1294,17 @@ "com.amazonaws.iotevents#InputConfiguration": { "type": "structure", "members": { - "inputArn": { - "target": "com.amazonaws.iotevents#InputArn", + "inputName": { + "target": "com.amazonaws.iotevents#InputName", "traits": { - "smithy.api#documentation": "

The ARN of the input.

", + "smithy.api#documentation": "

The name of the input.

", "smithy.api#required": {} } }, - "inputName": { - "target": "com.amazonaws.iotevents#InputName", + "lastUpdateTime": { + "target": "com.amazonaws.iotevents#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the input.

", + "smithy.api#documentation": "

The last time the input was updated.

", "smithy.api#required": {} } }, @@ -1315,24 +1315,24 @@ "smithy.api#required": {} } }, - "lastUpdateTime": { + "creationTime": { "target": "com.amazonaws.iotevents#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the input was updated.

", + "smithy.api#documentation": "

The time the input was created.

", "smithy.api#required": {} } }, - "inputDescription": { - "target": "com.amazonaws.iotevents#InputDescription", + "inputArn": { + "target": "com.amazonaws.iotevents#InputArn", "traits": { - "smithy.api#documentation": "

A brief description of the input.

" + "smithy.api#documentation": "

The ARN of the input.

", + "smithy.api#required": {} } }, - "creationTime": { - "target": "com.amazonaws.iotevents#Timestamp", + "inputDescription": { + "target": "com.amazonaws.iotevents#InputDescription", "traits": { - "smithy.api#documentation": "

The time the input was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A brief description of the input.

" } } }, @@ -1406,16 +1406,16 @@ "com.amazonaws.iotevents#InputSummary": { "type": "structure", "members": { - "inputArn": { - "target": "com.amazonaws.iotevents#InputArn", + "lastUpdateTime": { + "target": "com.amazonaws.iotevents#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the input.

" + "smithy.api#documentation": "

The last time the input was updated.

" } }, - "creationTime": { - "target": "com.amazonaws.iotevents#Timestamp", + "inputArn": { + "target": "com.amazonaws.iotevents#InputArn", "traits": { - "smithy.api#documentation": "

The time the input was created.

" + "smithy.api#documentation": "

The ARN of the input.

" } }, "inputName": { @@ -1430,10 +1430,10 @@ "smithy.api#documentation": "

The status of the input.

" } }, - "lastUpdateTime": { + "creationTime": { "target": "com.amazonaws.iotevents#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the input was updated.

" + "smithy.api#documentation": "

The time the input was created.

" } }, "inputDescription": { @@ -1537,7 +1537,7 @@ "sdkId": "IoT Events", "arnNamespace": "iotevents", "cloudFormationName": "IoTEvents", - "cloudTrailEventSource": "columbo.iot.amazon.com" + "cloudTrailEventSource": "iotevents.amazonaws.com" }, "aws.auth#sigv4": { "name": "iotevents" @@ -1550,18 +1550,18 @@ "com.amazonaws.iotevents#IotEventsAction": { "type": "structure", "members": { - "payload": { - "target": "com.amazonaws.iotevents#Payload", - "traits": { - "smithy.api#documentation": "

You can configure the action payload when you send a message to an AWS IoT Events input.

" - } - }, "inputName": { "target": "com.amazonaws.iotevents#InputName", "traits": { "smithy.api#documentation": "

The name of the AWS IoT Events input where the data is sent.

", "smithy.api#required": {} } + }, + "payload": { + "target": "com.amazonaws.iotevents#Payload", + "traits": { + "smithy.api#documentation": "

You can configure the action payload when you send a message to an AWS IoT Events input.

" + } } }, "traits": { @@ -1577,10 +1577,10 @@ "smithy.api#documentation": "

The ID of the asset property. You can specify an expression.

" } }, - "entryId": { - "target": "com.amazonaws.iotevents#AssetPropertyEntryId", + "propertyAlias": { + "target": "com.amazonaws.iotevents#AssetPropertyAlias", "traits": { - "smithy.api#documentation": "

A unique identifier for this entry. You can use the entry ID to track which data entry\n causes an error in case of failure. The default is a new unique identifier. You can also\n specify an expression.

" + "smithy.api#documentation": "

The alias of the asset property. You can also specify an expression.

" } }, "propertyValue": { @@ -1590,10 +1590,10 @@ "smithy.api#required": {} } }, - "propertyAlias": { - "target": "com.amazonaws.iotevents#AssetPropertyAlias", + "entryId": { + "target": "com.amazonaws.iotevents#AssetPropertyEntryId", "traits": { - "smithy.api#documentation": "

The alias of the asset property. You can also specify an expression.

" + "smithy.api#documentation": "

A unique identifier for this entry. You can use the entry ID to track which data entry\n causes an error in case of failure. The default is a new unique identifier. You can also\n specify an expression.

" } }, "assetId": { @@ -1712,6 +1712,13 @@ "com.amazonaws.iotevents#ListDetectorModelVersionsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.iotevents#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, "detectorModelName": { "target": "com.amazonaws.iotevents#DetectorModelName", "traits": { @@ -1720,13 +1727,6 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.iotevents#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iotevents#MaxResults", "traits": { @@ -1787,19 +1787,19 @@ "com.amazonaws.iotevents#ListDetectorModelsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotevents#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iotevents#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.iotevents#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -1984,18 +1984,18 @@ "smithy.api#required": {} } }, - "detectorDebugOptions": { - "target": "com.amazonaws.iotevents#DetectorDebugOptions", - "traits": { - "smithy.api#documentation": "

Information that identifies those detector models and their detectors (instances) for\n which the logging level is given.

" - } - }, "enabled": { "target": "com.amazonaws.iotevents#LoggingEnabled", "traits": { "smithy.api#documentation": "

If TRUE, logging is enabled for AWS IoT Events.

", "smithy.api#required": {} } + }, + "detectorDebugOptions": { + "target": "com.amazonaws.iotevents#DetectorDebugOptions", + "traits": { + "smithy.api#documentation": "

Information that identifies those detector models and their detectors (instances) for\n which the logging level is given.

" + } } }, "traits": { @@ -2182,17 +2182,17 @@ "smithy.api#documentation": "

The ARN of the resource.

" } }, - "resourceId": { - "target": "com.amazonaws.iotevents#resourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, "message": { "target": "com.amazonaws.iotevents#errorMessage", "traits": { "smithy.api#documentation": "

The message for the exception.

" } + }, + "resourceId": { + "target": "com.amazonaws.iotevents#resourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } } }, "traits": { @@ -2236,18 +2236,18 @@ "com.amazonaws.iotevents#SNSTopicPublishAction": { "type": "structure", "members": { - "payload": { - "target": "com.amazonaws.iotevents#Payload", - "traits": { - "smithy.api#documentation": "

You can configure the action payload when you send a message as an Amazon SNS push\n notification.

" - } - }, "targetArn": { "target": "com.amazonaws.iotevents#AmazonResourceName", "traits": { "smithy.api#documentation": "

The ARN of the Amazon SNS target where the message is sent.

", "smithy.api#required": {} } + }, + "payload": { + "target": "com.amazonaws.iotevents#Payload", + "traits": { + "smithy.api#documentation": "

You can configure the action payload when you send a message as an Amazon SNS push\n notification.

" + } } }, "traits": { @@ -2283,15 +2283,6 @@ "com.amazonaws.iotevents#SetTimerAction": { "type": "structure", "members": { - "seconds": { - "target": "com.amazonaws.iotevents#Seconds", - "traits": { - "smithy.api#deprecated": { - "message": "seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression." - }, - "smithy.api#documentation": "

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure\n accuracy. The maximum value is 31622400 seconds.

" - } - }, "timerName": { "target": "com.amazonaws.iotevents#TimerName", "traits": { @@ -2304,6 +2295,15 @@ "traits": { "smithy.api#documentation": "

The duration of the timer, in seconds. You can use a string expression that includes\n numbers, variables ($variable.), and input values\n ($input..) as the duration. The range of\n the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds.\n The evaluated result of the duration is rounded down to the nearest whole number.

" } + }, + "seconds": { + "target": "com.amazonaws.iotevents#Seconds", + "traits": { + "smithy.api#deprecated": { + "message": "seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression." + }, + "smithy.api#documentation": "

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure\n accuracy. The maximum value is 31622400 seconds.

" + } } }, "traits": { @@ -2335,10 +2335,11 @@ "com.amazonaws.iotevents#SqsAction": { "type": "structure", "members": { - "payload": { - "target": "com.amazonaws.iotevents#Payload", + "queueUrl": { + "target": "com.amazonaws.iotevents#QueueUrl", "traits": { - "smithy.api#documentation": "

You can configure the action payload when you send a message to an Amazon SQS\n queue.

" + "smithy.api#documentation": "

The URL of the SQS queue where the data is written.

", + "smithy.api#required": {} } }, "useBase64": { @@ -2347,11 +2348,10 @@ "smithy.api#documentation": "

Set this to TRUE if you want the data to be base-64 encoded before it is written to the\n queue. Otherwise, set this to FALSE.

" } }, - "queueUrl": { - "target": "com.amazonaws.iotevents#QueueUrl", + "payload": { + "target": "com.amazonaws.iotevents#Payload", "traits": { - "smithy.api#documentation": "

The URL of the SQS queue where the data is written.

", - "smithy.api#required": {} + "smithy.api#documentation": "

You can configure the action payload when you send a message to an Amazon SQS\n queue.

" } } }, @@ -2362,6 +2362,13 @@ "com.amazonaws.iotevents#State": { "type": "structure", "members": { + "stateName": { + "target": "com.amazonaws.iotevents#StateName", + "traits": { + "smithy.api#documentation": "

The name of the state.

", + "smithy.api#required": {} + } + }, "onEnter": { "target": "com.amazonaws.iotevents#OnEnterLifecycle", "traits": { @@ -2374,13 +2381,6 @@ "smithy.api#documentation": "

When an input is received and the condition is TRUE, perform the specified\n actions.

" } }, - "stateName": { - "target": "com.amazonaws.iotevents#StateName", - "traits": { - "smithy.api#documentation": "

The name of the state.

", - "smithy.api#required": {} - } - }, "onExit": { "target": "com.amazonaws.iotevents#OnExitLifecycle", "traits": { @@ -2415,17 +2415,17 @@ "com.amazonaws.iotevents#Tag": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotevents#TagValue", + "key": { + "target": "com.amazonaws.iotevents#TagKey", "traits": { - "smithy.api#documentation": "

The tag's value.

", + "smithy.api#documentation": "

The tag's key.

", "smithy.api#required": {} } }, - "key": { - "target": "com.amazonaws.iotevents#TagKey", + "value": { + "target": "com.amazonaws.iotevents#TagValue", "traits": { - "smithy.api#documentation": "

The tag's key.

", + "smithy.api#documentation": "

The tag's value.

", "smithy.api#required": {} } } @@ -2556,10 +2556,10 @@ "com.amazonaws.iotevents#TransitionEvent": { "type": "structure", "members": { - "condition": { - "target": "com.amazonaws.iotevents#Condition", + "nextState": { + "target": "com.amazonaws.iotevents#StateName", "traits": { - "smithy.api#documentation": "

Required. A Boolean expression that when TRUE causes the actions to be performed and the\n nextState to be entered.

", + "smithy.api#documentation": "

The next state to enter.

", "smithy.api#required": {} } }, @@ -2576,10 +2576,10 @@ "smithy.api#documentation": "

The actions to be performed.

" } }, - "nextState": { - "target": "com.amazonaws.iotevents#StateName", + "condition": { + "target": "com.amazonaws.iotevents#Condition", "traits": { - "smithy.api#documentation": "

The next state to enter.

", + "smithy.api#documentation": "

Required. A Boolean expression that when TRUE causes the actions to be performed and the\n nextState to be entered.

", "smithy.api#required": {} } } @@ -2647,14 +2647,6 @@ "com.amazonaws.iotevents#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.iotevents#TagKeys", - "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": {} - } - }, "resourceArn": { "target": "com.amazonaws.iotevents#AmazonResourceName", "traits": { @@ -2662,6 +2654,14 @@ "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } + }, + "tagKeys": { + "target": "com.amazonaws.iotevents#TagKeys", + "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": {} + } } } }, @@ -2709,10 +2709,12 @@ "com.amazonaws.iotevents#UpdateDetectorModelRequest": { "type": "structure", "members": { - "detectorModelDescription": { - "target": "com.amazonaws.iotevents#DetectorModelDescription", + "detectorModelName": { + "target": "com.amazonaws.iotevents#DetectorModelName", "traits": { - "smithy.api#documentation": "

A brief description of the detector model.

" + "smithy.api#documentation": "

The name of the detector model that is updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "detectorModelDefinition": { @@ -2722,12 +2724,10 @@ "smithy.api#required": {} } }, - "detectorModelName": { - "target": "com.amazonaws.iotevents#DetectorModelName", + "detectorModelDescription": { + "target": "com.amazonaws.iotevents#DetectorModelDescription", "traits": { - "smithy.api#documentation": "

The name of the detector model that is updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A brief description of the detector model.

" } }, "evaluationMethod": { diff --git a/codegen/sdk-codegen/aws-models/iot-jobs-data-plane.2017-09-29.json b/codegen/sdk-codegen/aws-models/iot-jobs-data-plane.2017-09-29.json index c1761c2f6213..0bbb63f86a81 100644 --- a/codegen/sdk-codegen/aws-models/iot-jobs-data-plane.2017-09-29.json +++ b/codegen/sdk-codegen/aws-models/iot-jobs-data-plane.2017-09-29.json @@ -108,13 +108,6 @@ "smithy.api#required": {} } }, - "executionNumber": { - "target": "com.amazonaws.iotjobsdataplane#ExecutionNumber", - "traits": { - "smithy.api#documentation": "

Optional. A number that identifies a particular job execution on a particular device. If not specified,\n the latest job execution is returned.

", - "smithy.api#httpQuery": "executionNumber" - } - }, "thingName": { "target": "com.amazonaws.iotjobsdataplane#ThingName", "traits": { @@ -123,6 +116,13 @@ "smithy.api#required": {} } }, + "executionNumber": { + "target": "com.amazonaws.iotjobsdataplane#ExecutionNumber", + "traits": { + "smithy.api#documentation": "

Optional. A number that identifies a particular job execution on a particular device. If not specified,\n the latest job execution is returned.

", + "smithy.api#httpQuery": "executionNumber" + } + }, "includeJobDocument": { "target": "com.amazonaws.iotjobsdataplane#IncludeJobDocument", "traits": { @@ -234,16 +234,16 @@ "com.amazonaws.iotjobsdataplane#GetPendingJobExecutionsResponse": { "type": "structure", "members": { - "inProgressJobs": { + "queuedJobs": { "target": "com.amazonaws.iotjobsdataplane#JobExecutionSummaryList", "traits": { - "smithy.api#documentation": "

A list of JobExecutionSummary objects with status IN_PROGRESS.

" + "smithy.api#documentation": "

A list of JobExecutionSummary objects with status QUEUED.

" } }, - "queuedJobs": { + "inProgressJobs": { "target": "com.amazonaws.iotjobsdataplane#JobExecutionSummaryList", "traits": { - "smithy.api#documentation": "

A list of JobExecutionSummary objects with status QUEUED.

" + "smithy.api#documentation": "

A list of JobExecutionSummary objects with status IN_PROGRESS.

" } } } @@ -311,7 +311,7 @@ "sdkId": "IoT Jobs Data Plane", "arnNamespace": "iot-jobs-data", "cloudFormationName": "IoTJobsDataPlane", - "cloudTrailEventSource": "external.thingjobmanagerservice.laser.iot.amazonaws.com" + "cloudTrailEventSource": "iotjobsdataplane.amazonaws.com" }, "aws.auth#sigv4": { "name": "iot-jobs-data" @@ -339,34 +339,28 @@ "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time they are updated by a\n device.

" } }, - "jobId": { - "target": "com.amazonaws.iotjobsdataplane#JobId", - "traits": { - "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" - } - }, - "status": { - "target": "com.amazonaws.iotjobsdataplane#JobExecutionStatus", - "traits": { - "smithy.api#documentation": "

The status of the job execution. Can be one of: \"QUEUED\", \"IN_PROGRESS\", \"FAILED\", \"SUCCESS\", \"CANCELED\",\n \"REJECTED\", or \"REMOVED\".

" - } - }, "jobDocument": { "target": "com.amazonaws.iotjobsdataplane#JobDocument", "traits": { "smithy.api#documentation": "

The content of the job document.

" } }, + "jobId": { + "target": "com.amazonaws.iotjobsdataplane#JobId", + "traits": { + "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" + } + }, "queuedAt": { "target": "com.amazonaws.iotjobsdataplane#QueuedAt", "traits": { "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the job execution was enqueued.

" } }, - "statusDetails": { - "target": "com.amazonaws.iotjobsdataplane#DetailsMap", + "approximateSecondsBeforeTimedOut": { + "target": "com.amazonaws.iotjobsdataplane#ApproximateSecondsBeforeTimedOut", "traits": { - "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution.

" + "smithy.api#documentation": "

The estimated number of seconds that remain before the job execution status will be\n changed to TIMED_OUT.

" } }, "startedAt": { @@ -375,10 +369,16 @@ "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the job execution was started.

" } }, - "approximateSecondsBeforeTimedOut": { - "target": "com.amazonaws.iotjobsdataplane#ApproximateSecondsBeforeTimedOut", + "status": { + "target": "com.amazonaws.iotjobsdataplane#JobExecutionStatus", "traits": { - "smithy.api#documentation": "

The estimated number of seconds that remain before the job execution status will be\n changed to TIMED_OUT.

" + "smithy.api#documentation": "

The status of the job execution. Can be one of: \"QUEUED\", \"IN_PROGRESS\", \"FAILED\", \"SUCCESS\", \"CANCELED\",\n \"REJECTED\", or \"REMOVED\".

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.iotjobsdataplane#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the job execution was last updated.

" } }, "thingName": { @@ -393,10 +393,10 @@ "smithy.api#documentation": "

A number that identifies a particular job execution on a particular device. It can be used later in\n commands that return or update job execution information.

" } }, - "lastUpdatedAt": { - "target": "com.amazonaws.iotjobsdataplane#LastUpdatedAt", + "statusDetails": { + "target": "com.amazonaws.iotjobsdataplane#DetailsMap", "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the job execution was last updated.

" + "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution.

" } } }, @@ -407,10 +407,10 @@ "com.amazonaws.iotjobsdataplane#JobExecutionState": { "type": "structure", "members": { - "statusDetails": { - "target": "com.amazonaws.iotjobsdataplane#DetailsMap", + "versionNumber": { + "target": "com.amazonaws.iotjobsdataplane#VersionNumber", "traits": { - "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution.

" + "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time they are updated by a\n device.

" } }, "status": { @@ -419,10 +419,10 @@ "smithy.api#documentation": "

The status of the job execution. Can be one of: \"QUEUED\", \"IN_PROGRESS\", \"FAILED\", \"SUCCESS\", \"CANCELED\",\n \"REJECTED\", or \"REMOVED\".

" } }, - "versionNumber": { - "target": "com.amazonaws.iotjobsdataplane#VersionNumber", + "statusDetails": { + "target": "com.amazonaws.iotjobsdataplane#DetailsMap", "traits": { - "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time they are updated by a\n device.

" + "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution.

" } } }, @@ -472,22 +472,16 @@ "com.amazonaws.iotjobsdataplane#JobExecutionSummary": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.iotjobsdataplane#JobId", - "traits": { - "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" - } - }, "queuedAt": { "target": "com.amazonaws.iotjobsdataplane#QueuedAt", "traits": { "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the job execution was enqueued.

" } }, - "versionNumber": { - "target": "com.amazonaws.iotjobsdataplane#VersionNumber", + "jobId": { + "target": "com.amazonaws.iotjobsdataplane#JobId", "traits": { - "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives\n an update from a device.

" + "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, "startedAt": { @@ -496,10 +490,10 @@ "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the job execution started.

" } }, - "executionNumber": { - "target": "com.amazonaws.iotjobsdataplane#ExecutionNumber", + "versionNumber": { + "target": "com.amazonaws.iotjobsdataplane#VersionNumber", "traits": { - "smithy.api#documentation": "

A number that identifies a particular job execution on a particular device.

" + "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives\n an update from a device.

" } }, "lastUpdatedAt": { @@ -507,6 +501,12 @@ "traits": { "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the job execution was last updated.

" } + }, + "executionNumber": { + "target": "com.amazonaws.iotjobsdataplane#ExecutionNumber", + "traits": { + "smithy.api#documentation": "

A number that identifies a particular job execution on a particular device.

" + } } }, "traits": { @@ -734,6 +734,18 @@ "com.amazonaws.iotjobsdataplane#UpdateJobExecutionRequest": { "type": "structure", "members": { + "includeJobDocument": { + "target": "com.amazonaws.iotjobsdataplane#IncludeJobDocument", + "traits": { + "smithy.api#documentation": "

Optional. When set to true, the response contains the job document. The default is false.

" + } + }, + "expectedVersion": { + "target": "com.amazonaws.iotjobsdataplane#ExpectedVersion", + "traits": { + "smithy.api#documentation": "

Optional. The expected current version of the job execution. Each time you update the job execution, its\n version is incremented. If the version of the job execution stored in Jobs does not match, the update is\n rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data\n is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain\n the job execution status data.)

" + } + }, "jobId": { "target": "com.amazonaws.iotjobsdataplane#JobId", "traits": { @@ -749,28 +761,18 @@ "smithy.api#required": {} } }, - "statusDetails": { - "target": "com.amazonaws.iotjobsdataplane#DetailsMap", - "traits": { - "smithy.api#documentation": "

Optional. A collection of name/value pairs that describe the status of the job execution. If not\n specified, the statusDetails are unchanged.

" - } - }, - "expectedVersion": { - "target": "com.amazonaws.iotjobsdataplane#ExpectedVersion", - "traits": { - "smithy.api#documentation": "

Optional. The expected current version of the job execution. Each time you update the job execution, its\n version is incremented. If the version of the job execution stored in Jobs does not match, the update is\n rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data\n is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain\n the job execution status data.)

" - } - }, - "includeJobExecutionState": { - "target": "com.amazonaws.iotjobsdataplane#IncludeExecutionState", + "executionNumber": { + "target": "com.amazonaws.iotjobsdataplane#ExecutionNumber", "traits": { - "smithy.api#documentation": "

Optional. When included and set to true, the response contains the JobExecutionState data. The default is\n false.

" + "smithy.api#documentation": "

Optional. A number that identifies a particular job execution on a particular device.

" } }, - "includeJobDocument": { - "target": "com.amazonaws.iotjobsdataplane#IncludeJobDocument", + "thingName": { + "target": "com.amazonaws.iotjobsdataplane#ThingName", "traits": { - "smithy.api#documentation": "

Optional. When set to true, the response contains the job document. The default is false.

" + "smithy.api#documentation": "

The name of the thing associated with the device.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "stepTimeoutInMinutes": { @@ -779,18 +781,16 @@ "smithy.api#documentation": "

Specifies the amount of time this device has to finish execution of this job. If the job \n execution status is not set to a terminal state before this timer expires, or before the \n timer is reset (by again calling UpdateJobExecution, setting the status to\n IN_PROGRESS and specifying a new timeout value in this field) the job execution\n status will be automatically set to TIMED_OUT. Note that setting or resetting \n this timeout has no effect on that job execution timeout which may have been specified when \n the job was created (CreateJob using field timeoutConfig).

" } }, - "executionNumber": { - "target": "com.amazonaws.iotjobsdataplane#ExecutionNumber", + "includeJobExecutionState": { + "target": "com.amazonaws.iotjobsdataplane#IncludeExecutionState", "traits": { - "smithy.api#documentation": "

Optional. A number that identifies a particular job execution on a particular device.

" + "smithy.api#documentation": "

Optional. When included and set to true, the response contains the JobExecutionState data. The default is\n false.

" } }, - "thingName": { - "target": "com.amazonaws.iotjobsdataplane#ThingName", + "statusDetails": { + "target": "com.amazonaws.iotjobsdataplane#DetailsMap", "traits": { - "smithy.api#documentation": "

The name of the thing associated with the device.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Optional. A collection of name/value pairs that describe the status of the job execution. If not\n specified, the statusDetails are unchanged.

" } } } @@ -798,17 +798,17 @@ "com.amazonaws.iotjobsdataplane#UpdateJobExecutionResponse": { "type": "structure", "members": { - "executionState": { - "target": "com.amazonaws.iotjobsdataplane#JobExecutionState", - "traits": { - "smithy.api#documentation": "

A JobExecutionState object.

" - } - }, "jobDocument": { "target": "com.amazonaws.iotjobsdataplane#JobDocument", "traits": { "smithy.api#documentation": "

The contents of the Job Documents.

" } + }, + "executionState": { + "target": "com.amazonaws.iotjobsdataplane#JobExecutionState", + "traits": { + "smithy.api#documentation": "

A JobExecutionState object.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/iot.2015-05-28.json b/codegen/sdk-codegen/aws-models/iot.2015-05-28.json index 1598cf63ea54..4b82714d587a 100644 --- a/codegen/sdk-codegen/aws-models/iot.2015-05-28.json +++ b/codegen/sdk-codegen/aws-models/iot.2015-05-28.json @@ -78,6 +78,9 @@ { "target": "com.amazonaws.iot#ConfirmTopicRuleDestination" }, + { + "target": "com.amazonaws.iot#CreateAuditSuppression" + }, { "target": "com.amazonaws.iot#CreateAuthorizer" }, @@ -153,6 +156,9 @@ { "target": "com.amazonaws.iot#DeleteAccountAuditConfiguration" }, + { + "target": "com.amazonaws.iot#DeleteAuditSuppression" + }, { "target": "com.amazonaws.iot#DeleteAuthorizer" }, @@ -243,6 +249,9 @@ { "target": "com.amazonaws.iot#DescribeAuditMitigationActionsTask" }, + { + "target": "com.amazonaws.iot#DescribeAuditSuppression" + }, { "target": "com.amazonaws.iot#DescribeAuditTask" }, @@ -390,6 +399,9 @@ { "target": "com.amazonaws.iot#ListAuditMitigationActionsTasks" }, + { + "target": "com.amazonaws.iot#ListAuditSuppressions" + }, { "target": "com.amazonaws.iot#ListAuditTasks" }, @@ -591,6 +603,9 @@ { "target": "com.amazonaws.iot#UpdateAccountAuditConfiguration" }, + { + "target": "com.amazonaws.iot#UpdateAuditSuppression" + }, { "target": "com.amazonaws.iot#UpdateAuthorizer" }, @@ -658,7 +673,7 @@ "traits": { "aws.api#service": { "sdkId": "IoT", - "arnNamespace": "execute-api", + "arnNamespace": "iot", "cloudFormationName": "IoT", "cloudTrailEventSource": "iot.amazonaws.com" }, @@ -699,17 +714,17 @@ "com.amazonaws.iot#AbortCriteria": { "type": "structure", "members": { - "action": { - "target": "com.amazonaws.iot#AbortAction", + "minNumberOfExecutedThings": { + "target": "com.amazonaws.iot#MinimumNumberOfExecutedThings", "traits": { - "smithy.api#documentation": "

The type of job action to take to initiate the job abort.

", + "smithy.api#documentation": "

The minimum number of things which must receive job execution notifications before the job \n can be aborted.

", "smithy.api#required": {} } }, - "minNumberOfExecutedThings": { - "target": "com.amazonaws.iot#MinimumNumberOfExecutedThings", + "action": { + "target": "com.amazonaws.iot#AbortAction", "traits": { - "smithy.api#documentation": "

The minimum number of things which must receive job execution notifications before the job \n can be aborted.

", + "smithy.api#documentation": "

The type of job action to take to initiate the job abort.

", "smithy.api#required": {} } }, @@ -792,6 +807,13 @@ "com.amazonaws.iot#AcceptCertificateTransferRequest": { "type": "structure", "members": { + "setAsActive": { + "target": "com.amazonaws.iot#SetAsActive", + "traits": { + "smithy.api#documentation": "

Specifies whether the certificate is active.

", + "smithy.api#httpQuery": "setAsActive" + } + }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { @@ -799,13 +821,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "setAsActive": { - "target": "com.amazonaws.iot#SetAsActive", - "traits": { - "smithy.api#documentation": "

Specifies whether the certificate is active.

", - "smithy.api#httpQuery": "setAsActive" - } } }, "traits": { @@ -819,40 +834,22 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:aws:acm:[a-z]{2}-(gov-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/?[a-zA-Z0-9/-]+" + "smithy.api#pattern": "arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\\d{1}:\\d{12}:certificate/[a-zA-Z0-9/-]+" } }, "com.amazonaws.iot#Action": { "type": "structure", "members": { - "stepFunctions": { - "target": "com.amazonaws.iot#StepFunctionsAction", - "traits": { - "smithy.api#documentation": "

Starts execution of a Step Functions state machine.

" - } - }, - "kinesis": { - "target": "com.amazonaws.iot#KinesisAction", - "traits": { - "smithy.api#documentation": "

Write data to an Amazon Kinesis stream.

" - } - }, - "firehose": { - "target": "com.amazonaws.iot#FirehoseAction", - "traits": { - "smithy.api#documentation": "

Write to an Amazon Kinesis Firehose stream.

" - } - }, - "s3": { - "target": "com.amazonaws.iot#S3Action", + "lambda": { + "target": "com.amazonaws.iot#LambdaAction", "traits": { - "smithy.api#documentation": "

Write to an Amazon S3 bucket.

" + "smithy.api#documentation": "

Invoke a Lambda function.

" } }, - "dynamoDBv2": { - "target": "com.amazonaws.iot#DynamoDBv2Action", + "salesforce": { + "target": "com.amazonaws.iot#SalesforceAction", "traits": { - "smithy.api#documentation": "

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows\n you to write each attribute in an MQTT message payload into a separate DynamoDB\n column.

" + "smithy.api#documentation": "

Send a message to a Salesforce IoT Cloud Input Stream.

" } }, "cloudwatchMetric": { @@ -861,22 +858,28 @@ "smithy.api#documentation": "

Capture a CloudWatch metric.

" } }, + "iotEvents": { + "target": "com.amazonaws.iot#IotEventsAction", + "traits": { + "smithy.api#documentation": "

Sends an input to an AWS IoT Events detector.

" + } + }, "republish": { "target": "com.amazonaws.iot#RepublishAction", "traits": { "smithy.api#documentation": "

Publish to another MQTT topic.

" } }, - "sns": { - "target": "com.amazonaws.iot#SnsAction", + "cloudwatchAlarm": { + "target": "com.amazonaws.iot#CloudwatchAlarmAction", "traits": { - "smithy.api#documentation": "

Publish to an Amazon SNS topic.

" + "smithy.api#documentation": "

Change the state of a CloudWatch alarm.

" } }, - "http": { - "target": "com.amazonaws.iot#HttpAction", + "sns": { + "target": "com.amazonaws.iot#SnsAction", "traits": { - "smithy.api#documentation": "

Send data to an HTTPS endpoint.

" + "smithy.api#documentation": "

Publish to an Amazon SNS topic.

" } }, "sqs": { @@ -891,28 +894,46 @@ "smithy.api#documentation": "

Write data to an Amazon Elasticsearch Service domain.

" } }, - "lambda": { - "target": "com.amazonaws.iot#LambdaAction", + "http": { + "target": "com.amazonaws.iot#HttpAction", "traits": { - "smithy.api#documentation": "

Invoke a Lambda function.

" + "smithy.api#documentation": "

Send data to an HTTPS endpoint.

" } }, - "cloudwatchAlarm": { - "target": "com.amazonaws.iot#CloudwatchAlarmAction", + "timestream": { + "target": "com.amazonaws.iot#TimestreamAction", "traits": { - "smithy.api#documentation": "

Change the state of a CloudWatch alarm.

" + "smithy.api#documentation": "

The Timestream rule action writes attributes (measures) from an MQTT message\n into an Amazon Timestream table. For more information, see the Timestream\n topic rule action documentation.

" } }, - "iotEvents": { - "target": "com.amazonaws.iot#IotEventsAction", + "dynamoDB": { + "target": "com.amazonaws.iot#DynamoDBAction", "traits": { - "smithy.api#documentation": "

Sends an input to an AWS IoT Events detector.

" + "smithy.api#documentation": "

Write to a DynamoDB table.

" } }, - "iotSiteWise": { - "target": "com.amazonaws.iot#IotSiteWiseAction", + "iotAnalytics": { + "target": "com.amazonaws.iot#IotAnalyticsAction", "traits": { - "smithy.api#documentation": "

Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset\n properties.

" + "smithy.api#documentation": "

Sends message data to an AWS IoT Analytics channel.

" + } + }, + "dynamoDBv2": { + "target": "com.amazonaws.iot#DynamoDBv2Action", + "traits": { + "smithy.api#documentation": "

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows\n you to write each attribute in an MQTT message payload into a separate DynamoDB\n column.

" + } + }, + "firehose": { + "target": "com.amazonaws.iot#FirehoseAction", + "traits": { + "smithy.api#documentation": "

Write to an Amazon Kinesis Firehose stream.

" + } + }, + "kinesis": { + "target": "com.amazonaws.iot#KinesisAction", + "traits": { + "smithy.api#documentation": "

Write data to an Amazon Kinesis stream.

" } }, "cloudwatchLogs": { @@ -921,22 +942,22 @@ "smithy.api#documentation": "

Send data to CloudWatch Logs.

" } }, - "salesforce": { - "target": "com.amazonaws.iot#SalesforceAction", + "stepFunctions": { + "target": "com.amazonaws.iot#StepFunctionsAction", "traits": { - "smithy.api#documentation": "

Send a message to a Salesforce IoT Cloud Input Stream.

" + "smithy.api#documentation": "

Starts execution of a Step Functions state machine.

" } }, - "dynamoDB": { - "target": "com.amazonaws.iot#DynamoDBAction", + "iotSiteWise": { + "target": "com.amazonaws.iot#IotSiteWiseAction", "traits": { - "smithy.api#documentation": "

Write to a DynamoDB table.

" + "smithy.api#documentation": "

Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset\n properties.

" } }, - "iotAnalytics": { - "target": "com.amazonaws.iot#IotAnalyticsAction", + "s3": { + "target": "com.amazonaws.iot#S3Action", "traits": { - "smithy.api#documentation": "

Sends message data to an AWS IoT Analytics channel.

" + "smithy.api#documentation": "

Write to an Amazon S3 bucket.

" } } }, @@ -982,22 +1003,16 @@ "com.amazonaws.iot#ActiveViolation": { "type": "structure", "members": { - "thingName": { - "target": "com.amazonaws.iot#DeviceDefenderThingName", + "behavior": { + "target": "com.amazonaws.iot#Behavior", "traits": { - "smithy.api#documentation": "

The name of the thing responsible for the active violation.

" + "smithy.api#documentation": "

The behavior which is being violated.

" } }, - "violationStartTime": { + "lastViolationTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The time the violation started.

" - } - }, - "behavior": { - "target": "com.amazonaws.iot#Behavior", - "traits": { - "smithy.api#documentation": "

The behavior which is being violated.

" + "smithy.api#documentation": "

The time the most recent violation occurred.

" } }, "violationId": { @@ -1012,16 +1027,22 @@ "smithy.api#documentation": "

The security profile whose behavior is in violation.

" } }, - "lastViolationValue": { - "target": "com.amazonaws.iot#MetricValue", + "thingName": { + "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { - "smithy.api#documentation": "

The value of the metric (the measurement) which caused the most recent violation.

" + "smithy.api#documentation": "

The name of the thing responsible for the active violation.

" } }, - "lastViolationTime": { + "violationStartTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The time the most recent violation occurred.

" + "smithy.api#documentation": "

The time the violation started.

" + } + }, + "lastViolationValue": { + "target": "com.amazonaws.iot#MetricValue", + "traits": { + "smithy.api#documentation": "

The value of the metric (the measurement) which caused the most recent violation.

" } } }, @@ -1069,10 +1090,10 @@ "com.amazonaws.iot#AddThingToBillingGroupRequest": { "type": "structure", "members": { - "billingGroupArn": { - "target": "com.amazonaws.iot#BillingGroupArn", + "billingGroupName": { + "target": "com.amazonaws.iot#BillingGroupName", "traits": { - "smithy.api#documentation": "

The ARN of the billing group.

" + "smithy.api#documentation": "

The name of the billing group.

" } }, "thingName": { @@ -1081,16 +1102,16 @@ "smithy.api#documentation": "

The name of the thing to be added to the billing group.

" } }, - "thingArn": { - "target": "com.amazonaws.iot#ThingArn", + "billingGroupArn": { + "target": "com.amazonaws.iot#BillingGroupArn", "traits": { - "smithy.api#documentation": "

The ARN of the thing to be added to the billing group.

" + "smithy.api#documentation": "

The ARN of the billing group.

" } }, - "billingGroupName": { - "target": "com.amazonaws.iot#BillingGroupName", + "thingArn": { + "target": "com.amazonaws.iot#ThingArn", "traits": { - "smithy.api#documentation": "

The name of the billing group.

" + "smithy.api#documentation": "

The ARN of the thing to be added to the billing group.

" } } } @@ -1133,34 +1154,34 @@ "com.amazonaws.iot#AddThingToThingGroupRequest": { "type": "structure", "members": { - "thingName": { - "target": "com.amazonaws.iot#ThingName", - "traits": { - "smithy.api#documentation": "

The name of the thing to add to a group.

" - } - }, - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", - "traits": { - "smithy.api#documentation": "

The name of the group to which you are adding a thing.

" - } - }, "overrideDynamicGroups": { "target": "com.amazonaws.iot#OverrideDynamicGroups", "traits": { "smithy.api#documentation": "

Override dynamic thing groups with static thing groups when 10-group limit is\n\t\t\treached. If a thing belongs to 10 thing groups, and one or more of those groups are\n\t\t\tdynamic thing groups, adding a thing to a static group removes the thing from the last\n\t\t\tdynamic group.

" } }, + "thingGroupArn": { + "target": "com.amazonaws.iot#ThingGroupArn", + "traits": { + "smithy.api#documentation": "

The ARN of the group to which you are adding a thing.

" + } + }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing to add to a group.

" } }, - "thingGroupArn": { - "target": "com.amazonaws.iot#ThingGroupArn", + "thingName": { + "target": "com.amazonaws.iot#ThingName", "traits": { - "smithy.api#documentation": "

The ARN of the group to which you are adding a thing.

" + "smithy.api#documentation": "

The name of the thing to add to a group.

" + } + }, + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", + "traits": { + "smithy.api#documentation": "

The name of the group to which you are adding a thing.

" } } } @@ -1225,17 +1246,17 @@ "com.amazonaws.iot#AlertTarget": { "type": "structure", "members": { - "alertTargetArn": { - "target": "com.amazonaws.iot#AlertTargetArn", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the notification target to which alerts are sent.

", + "smithy.api#documentation": "

The ARN of the role that grants permission to send alerts to the \n notification target.

", "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "alertTargetArn": { + "target": "com.amazonaws.iot#AlertTargetArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to send alerts to the \n notification target.

", + "smithy.api#documentation": "

The ARN of the notification target to which alerts are sent.

", "smithy.api#required": {} } } @@ -1304,8 +1325,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 2048 + "min": 1 } } }, @@ -1366,12 +1386,6 @@ "com.amazonaws.iot#AssetPropertyValue": { "type": "structure", "members": { - "quality": { - "target": "com.amazonaws.iot#AssetPropertyQuality", - "traits": { - "smithy.api#documentation": "

Optional. A string that describes the quality of the value. Accepts substitution\n templates. Must be GOOD, BAD, or UNCERTAIN.

" - } - }, "timestamp": { "target": "com.amazonaws.iot#AssetPropertyTimestamp", "traits": { @@ -1379,6 +1393,12 @@ "smithy.api#required": {} } }, + "quality": { + "target": "com.amazonaws.iot#AssetPropertyQuality", + "traits": { + "smithy.api#documentation": "

Optional. A string that describes the quality of the value. Accepts substitution\n templates. Must be GOOD, BAD, or UNCERTAIN.

" + } + }, "value": { "target": "com.amazonaws.iot#AssetPropertyVariant", "traits": { @@ -1405,28 +1425,28 @@ "com.amazonaws.iot#AssetPropertyVariant": { "type": "structure", "members": { - "stringValue": { - "target": "com.amazonaws.iot#AssetPropertyStringValue", - "traits": { - "smithy.api#documentation": "

Optional. The string value of the value entry. Accepts substitution templates.

" - } - }, "integerValue": { "target": "com.amazonaws.iot#AssetPropertyIntegerValue", "traits": { "smithy.api#documentation": "

Optional. A string that contains the integer value of the value entry. Accepts\n substitution templates.

" } }, - "doubleValue": { - "target": "com.amazonaws.iot#AssetPropertyDoubleValue", + "booleanValue": { + "target": "com.amazonaws.iot#AssetPropertyBooleanValue", + "traits": { + "smithy.api#documentation": "

Optional. A string that contains the boolean value (true or\n false) of the value entry. Accepts substitution templates.

" + } + }, + "doubleValue": { + "target": "com.amazonaws.iot#AssetPropertyDoubleValue", "traits": { "smithy.api#documentation": "

Optional. A string that contains the double value of the value entry. Accepts substitution\n templates.

" } }, - "booleanValue": { - "target": "com.amazonaws.iot#AssetPropertyBooleanValue", + "stringValue": { + "target": "com.amazonaws.iot#AssetPropertyStringValue", "traits": { - "smithy.api#documentation": "

Optional. A string that contains the boolean value (true or\n false) of the value entry. Accepts substitution templates.

" + "smithy.api#documentation": "

Optional. The string value of the value entry. Accepts substitution templates.

" } } }, @@ -1471,14 +1491,6 @@ "com.amazonaws.iot#AssociateTargetsWithJobRequest": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.iot#JobId", - "traits": { - "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "targets": { "target": "com.amazonaws.iot#JobTargets", "traits": { @@ -1491,18 +1503,20 @@ "traits": { "smithy.api#documentation": "

An optional comment string describing why the job was associated with the targets.

" } + }, + "jobId": { + "target": "com.amazonaws.iot#JobId", + "traits": { + "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.iot#AssociateTargetsWithJobResponse": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.iot#JobArn", - "traits": { - "smithy.api#documentation": "

An ARN identifying the job.

" - } - }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { @@ -1514,6 +1528,12 @@ "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } + }, + "jobArn": { + "target": "com.amazonaws.iot#JobArn", + "traits": { + "smithy.api#documentation": "

An ARN identifying the job.

" + } } } }, @@ -1557,13 +1577,6 @@ "com.amazonaws.iot#AttachPolicyRequest": { "type": "structure", "members": { - "target": { - "target": "com.amazonaws.iot#PolicyTarget", - "traits": { - "smithy.api#documentation": "

The identity to which the policy is attached.

", - "smithy.api#required": {} - } - }, "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { @@ -1571,6 +1584,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "target": { + "target": "com.amazonaws.iot#PolicyTarget", + "traits": { + "smithy.api#documentation": "

The identity to which the policy is attached.

", + "smithy.api#required": {} + } } } }, @@ -1615,14 +1635,6 @@ "com.amazonaws.iot#AttachPrincipalPolicyRequest": { "type": "structure", "members": { - "policyName": { - "target": "com.amazonaws.iot#PolicyName", - "traits": { - "smithy.api#documentation": "

The policy name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { @@ -1630,6 +1642,14 @@ "smithy.api#httpHeader": "x-amzn-iot-principal", "smithy.api#required": {} } + }, + "policyName": { + "target": "com.amazonaws.iot#PolicyName", + "traits": { + "smithy.api#documentation": "

The policy name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -1676,14 +1696,6 @@ "com.amazonaws.iot#AttachSecurityProfileRequest": { "type": "structure", "members": { - "securityProfileTargetArn": { - "target": "com.amazonaws.iot#SecurityProfileTargetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the target (thing group) to which the security profile is attached.

", - "smithy.api#httpQuery": "securityProfileTargetArn", - "smithy.api#required": {} - } - }, "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { @@ -1691,6 +1703,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "securityProfileTargetArn": { + "target": "com.amazonaws.iot#SecurityProfileTargetArn", + "traits": { + "smithy.api#documentation": "

The ARN of the target (thing group) to which the security profile is attached.

", + "smithy.api#httpQuery": "securityProfileTargetArn", + "smithy.api#required": {} + } } } }, @@ -1738,14 +1758,6 @@ "com.amazonaws.iot#AttachThingPrincipalRequest": { "type": "structure", "members": { - "principal": { - "target": "com.amazonaws.iot#Principal", - "traits": { - "smithy.api#documentation": "

The principal, which can be a certificate ARN (as returned from the\n\t\t\tCreateCertificate operation) or an Amazon Cognito ID.

", - "smithy.api#httpHeader": "x-amzn-principal", - "smithy.api#required": {} - } - }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { @@ -1753,6 +1765,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "principal": { + "target": "com.amazonaws.iot#Principal", + "traits": { + "smithy.api#documentation": "

The principal, which can be a certificate ARN (as returned from the\n\t\t\tCreateCertificate operation) or an Amazon Cognito ID.

", + "smithy.api#httpHeader": "x-amzn-principal", + "smithy.api#required": {} + } } }, "traits": { @@ -1853,10 +1873,10 @@ "com.amazonaws.iot#AuditCheckDetails": { "type": "structure", "members": { - "nonCompliantResourcesCount": { - "target": "com.amazonaws.iot#NonCompliantResourcesCount", + "errorCode": { + "target": "com.amazonaws.iot#ErrorCode", "traits": { - "smithy.api#documentation": "

The number of resources that were found noncompliant during the check.

" + "smithy.api#documentation": "

The code of any error encountered when this check is performed during this audit.\n One of \"INSUFFICIENT_PERMISSIONS\" or \"AUDIT_CHECK_DISABLED\".

" } }, "message": { @@ -1865,16 +1885,22 @@ "smithy.api#documentation": "

The message associated with any error encountered when this check is performed during this audit.

" } }, + "totalResourcesCount": { + "target": "com.amazonaws.iot#TotalResourcesCount", + "traits": { + "smithy.api#documentation": "

The number of resources on which the check was performed.

" + } + }, "checkCompliant": { "target": "com.amazonaws.iot#CheckCompliant", "traits": { "smithy.api#documentation": "

True if the check is complete and found all resources compliant.

" } }, - "errorCode": { - "target": "com.amazonaws.iot#ErrorCode", + "nonCompliantResourcesCount": { + "target": "com.amazonaws.iot#NonCompliantResourcesCount", "traits": { - "smithy.api#documentation": "

The code of any error encountered when this check is performed during this audit.\n One of \"INSUFFICIENT_PERMISSIONS\" or \"AUDIT_CHECK_DISABLED\".

" + "smithy.api#documentation": "

The number of resources that were found noncompliant during the check.

" } }, "checkRunStatus": { @@ -1883,10 +1909,10 @@ "smithy.api#documentation": "

The completion status of this check. One of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\",\n \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".

" } }, - "totalResourcesCount": { - "target": "com.amazonaws.iot#TotalResourcesCount", + "suppressedNonCompliantResourcesCount": { + "target": "com.amazonaws.iot#SuppressedNonCompliantResourcesCount", "traits": { - "smithy.api#documentation": "

The number of resources on which the check was performed.

" + "smithy.api#documentation": "

\n Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.\n

" } } }, @@ -1949,6 +1975,16 @@ "target": "com.amazonaws.iot#ReasonForNonComplianceCodes" } }, + "com.amazonaws.iot#AuditDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "[\\p{Graph}\\x20]*" + } + }, "com.amazonaws.iot#AuditDetails": { "type": "map", "key": { @@ -1961,22 +1997,34 @@ "com.amazonaws.iot#AuditFinding": { "type": "structure", "members": { + "severity": { + "target": "com.amazonaws.iot#AuditFindingSeverity", + "traits": { + "smithy.api#documentation": "

The severity of the result (finding).

" + } + }, "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#documentation": "

The audit check that generated this result.

" } }, - "taskStartTime": { + "isSuppressed": { + "target": "com.amazonaws.iot#IsSuppressed", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the audit finding was suppressed or not during reporting.\n

" + } + }, + "findingTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The time the audit started.

" + "smithy.api#documentation": "

The time the result (finding) was discovered.

" } }, - "relatedResources": { - "target": "com.amazonaws.iot#RelatedResources", + "reasonForNonComplianceCode": { + "target": "com.amazonaws.iot#ReasonForNonComplianceCode", "traits": { - "smithy.api#documentation": "

The list of related resources.

" + "smithy.api#documentation": "

A code that indicates the reason that the resource was noncompliant.

" } }, "reasonForNonCompliance": { @@ -1985,22 +2033,22 @@ "smithy.api#documentation": "

The reason the resource was noncompliant.

" } }, - "severity": { - "target": "com.amazonaws.iot#AuditFindingSeverity", + "findingId": { + "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

The severity of the result (finding).

" + "smithy.api#documentation": "

A unique identifier for this set of audit findings. This identifier is used to apply\n mitigation tasks to one or more sets of findings.

" } }, - "findingTime": { - "target": "com.amazonaws.iot#Timestamp", + "nonCompliantResource": { + "target": "com.amazonaws.iot#NonCompliantResource", "traits": { - "smithy.api#documentation": "

The time the result (finding) was discovered.

" + "smithy.api#documentation": "

The resource that was found to be noncompliant with the\n audit check.

" } }, - "reasonForNonComplianceCode": { - "target": "com.amazonaws.iot#ReasonForNonComplianceCode", + "relatedResources": { + "target": "com.amazonaws.iot#RelatedResources", "traits": { - "smithy.api#documentation": "

A code that indicates the reason that the resource was noncompliant.

" + "smithy.api#documentation": "

The list of related resources.

" } }, "taskId": { @@ -2009,16 +2057,10 @@ "smithy.api#documentation": "

The ID of the audit that generated this result (finding).

" } }, - "findingId": { - "target": "com.amazonaws.iot#FindingId", - "traits": { - "smithy.api#documentation": "

A unique identifier for this set of audit findings. This identifier is used to apply\n mitigation tasks to one or more sets of findings.

" - } - }, - "nonCompliantResource": { - "target": "com.amazonaws.iot#NonCompliantResource", + "taskStartTime": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The resource that was found to be noncompliant with the\n audit check.

" + "smithy.api#documentation": "

The time the audit started.

" } } }, @@ -2081,22 +2123,22 @@ "com.amazonaws.iot#AuditMitigationActionExecutionMetadata": { "type": "structure", "members": { - "findingId": { - "target": "com.amazonaws.iot#FindingId", + "actionName": { + "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "

The unique identifier for the findings to which the task and associated mitigation action are applied.

" + "smithy.api#documentation": "

The friendly name of the mitigation action being applied by the task.

" } }, - "actionId": { - "target": "com.amazonaws.iot#MitigationActionId", + "taskId": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier for the mitigation action being applied by the task.

" + "smithy.api#documentation": "

The unique identifier for the task that applies the mitigation action.

" } }, - "errorCode": { - "target": "com.amazonaws.iot#ErrorCode", + "endTime": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

If an error occurred, the code that indicates which type of error occurred.

" + "smithy.api#documentation": "

The date and time when the task was completed or canceled. Blank if the task is still running.

" } }, "status": { @@ -2105,34 +2147,34 @@ "smithy.api#documentation": "

The current status of the task being executed.

" } }, - "message": { - "target": "com.amazonaws.iot#ErrorMessage", + "errorCode": { + "target": "com.amazonaws.iot#ErrorCode", "traits": { - "smithy.api#documentation": "

If an error occurred, a message that describes the error.

" + "smithy.api#documentation": "

If an error occurred, the code that indicates which type of error occurred.

" } }, - "startTime": { - "target": "com.amazonaws.iot#Timestamp", + "findingId": { + "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

The date and time when the task was started.

" + "smithy.api#documentation": "

The unique identifier for the findings to which the task and associated mitigation action are applied.

" } }, - "taskId": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", + "message": { + "target": "com.amazonaws.iot#ErrorMessage", "traits": { - "smithy.api#documentation": "

The unique identifier for the task that applies the mitigation action.

" + "smithy.api#documentation": "

If an error occurred, a message that describes the error.

" } }, - "actionName": { - "target": "com.amazonaws.iot#MitigationActionName", + "startTime": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The friendly name of the mitigation action being applied by the task.

" + "smithy.api#documentation": "

The date and time when the task was started.

" } }, - "endTime": { - "target": "com.amazonaws.iot#Timestamp", + "actionId": { + "target": "com.amazonaws.iot#MitigationActionId", "traits": { - "smithy.api#documentation": "

The date and time when the task was completed or canceled. Blank if the task is still running.

" + "smithy.api#documentation": "

The unique identifier for the mitigation action being applied by the task.

" } } }, @@ -2190,10 +2232,10 @@ "com.amazonaws.iot#AuditMitigationActionsTaskMetadata": { "type": "structure", "members": { - "taskId": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", + "taskStatus": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatus", "traits": { - "smithy.api#documentation": "

The unique identifier for the task.

" + "smithy.api#documentation": "

The current state of the audit mitigation actions task.

" } }, "startTime": { @@ -2202,10 +2244,10 @@ "smithy.api#documentation": "

The time at which the audit mitigation actions task was started.

" } }, - "taskStatus": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatus", + "taskId": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The current state of the audit mitigation actions task.

" + "smithy.api#documentation": "

The unique identifier for the task.

" } } }, @@ -2254,6 +2296,12 @@ "com.amazonaws.iot#AuditMitigationActionsTaskTarget": { "type": "structure", "members": { + "auditTaskId": { + "target": "com.amazonaws.iot#AuditTaskId", + "traits": { + "smithy.api#documentation": "

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

" + } + }, "findingIds": { "target": "com.amazonaws.iot#FindingIds", "traits": { @@ -2265,12 +2313,6 @@ "traits": { "smithy.api#documentation": "

Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

" } - }, - "auditTaskId": { - "target": "com.amazonaws.iot#AuditTaskId", - "traits": { - "smithy.api#documentation": "

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

" - } } }, "traits": { @@ -2280,12 +2322,6 @@ "com.amazonaws.iot#AuditNotificationTarget": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to send notifications to the target.

" - } - }, "targetArn": { "target": "com.amazonaws.iot#TargetArn", "traits": { @@ -2297,6 +2333,12 @@ "traits": { "smithy.api#documentation": "

True if notifications to the target are enabled.

" } + }, + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role that grants permission to send notifications to the target.

" + } } }, "traits": { @@ -2323,6 +2365,50 @@ ] } }, + "com.amazonaws.iot#AuditSuppression": { + "type": "structure", + "members": { + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "suppressIndefinitely": { + "target": "com.amazonaws.iot#SuppressIndefinitely", + "traits": { + "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" + } + }, + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iot#AuditDescription", + "traits": { + "smithy.api#documentation": "

\n The description of the audit suppression.\n

" + } + }, + "expirationDate": { + "target": "com.amazonaws.iot#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Filters out specific findings of a Device Defender audit.\n

" + } + }, + "com.amazonaws.iot#AuditSuppressionList": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#AuditSuppression" + } + }, "com.amazonaws.iot#AuditTaskId": { "type": "string", "traits": { @@ -2336,10 +2422,10 @@ "com.amazonaws.iot#AuditTaskMetadata": { "type": "structure", "members": { - "taskStatus": { - "target": "com.amazonaws.iot#AuditTaskStatus", + "taskType": { + "target": "com.amazonaws.iot#AuditTaskType", "traits": { - "smithy.api#documentation": "

The status of this audit. One of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" + "smithy.api#documentation": "

The type of this audit. One of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".

" } }, "taskId": { @@ -2348,10 +2434,10 @@ "smithy.api#documentation": "

The ID of this audit.

" } }, - "taskType": { - "target": "com.amazonaws.iot#AuditTaskType", + "taskStatus": { + "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "

The type of this audit. One of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".

" + "smithy.api#documentation": "

The status of this audit. One of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" } } }, @@ -2425,18 +2511,18 @@ "com.amazonaws.iot#AuthInfo": { "type": "structure", "members": { - "actionType": { - "target": "com.amazonaws.iot#ActionType", - "traits": { - "smithy.api#documentation": "

The type of action for which the principal is being authorized.

" - } - }, "resources": { "target": "com.amazonaws.iot#Resources", "traits": { "smithy.api#documentation": "

The resources for which the principal is being authorized to perform the specified\n action.

", "smithy.api#required": {} } + }, + "actionType": { + "target": "com.amazonaws.iot#ActionType", + "traits": { + "smithy.api#documentation": "

The type of action for which the principal is being authorized.

" + } } }, "traits": { @@ -2458,18 +2544,6 @@ "com.amazonaws.iot#AuthResult": { "type": "structure", "members": { - "denied": { - "target": "com.amazonaws.iot#Denied", - "traits": { - "smithy.api#documentation": "

The policies and statements that denied the specified action.

" - } - }, - "authDecision": { - "target": "com.amazonaws.iot#AuthDecision", - "traits": { - "smithy.api#documentation": "

The final authorization decision of this scenario. Multiple statements are taken into\n account when determining the authorization decision. An explicit deny statement can\n override multiple allow statements.

" - } - }, "authInfo": { "target": "com.amazonaws.iot#AuthInfo", "traits": { @@ -2482,6 +2556,18 @@ "smithy.api#documentation": "

Contains any missing context values found while evaluating policy.

" } }, + "authDecision": { + "target": "com.amazonaws.iot#AuthDecision", + "traits": { + "smithy.api#documentation": "

The final authorization decision of this scenario. Multiple statements are taken into\n account when determining the authorization decision. An explicit deny statement can\n override multiple allow statements.

" + } + }, + "denied": { + "target": "com.amazonaws.iot#Denied", + "traits": { + "smithy.api#documentation": "

The policies and statements that denied the specified action.

" + } + }, "allowed": { "target": "com.amazonaws.iot#Allowed", "traits": { @@ -2500,23 +2586,29 @@ } }, "com.amazonaws.iot#AuthorizerArn": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } }, "com.amazonaws.iot#AuthorizerConfig": { "type": "structure", "members": { - "defaultAuthorizerName": { - "target": "com.amazonaws.iot#AuthorizerName", - "traits": { - "smithy.api#documentation": "

The name of the authorization service for a domain configuration.

" - } - }, "allowAuthorizerOverride": { "target": "com.amazonaws.iot#AllowAuthorizerOverride", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

A Boolean that specifies whether the domain configuration's authorization service can be overridden.

" } + }, + "defaultAuthorizerName": { + "target": "com.amazonaws.iot#AuthorizerName", + "traits": { + "smithy.api#documentation": "

The name of the authorization service for a domain configuration.

" + } } }, "traits": { @@ -2532,16 +2624,10 @@ "smithy.api#documentation": "

The status of the authorizer.

" } }, - "authorizerArn": { - "target": "com.amazonaws.iot#AuthorizerArn", - "traits": { - "smithy.api#documentation": "

The authorizer ARN.

" - } - }, - "lastModifiedDate": { + "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The UNIX timestamp of when the authorizer was last updated.

" + "smithy.api#documentation": "

The UNIX timestamp of when the authorizer was created.

" } }, "authorizerFunctionArn": { @@ -2556,28 +2642,34 @@ "smithy.api#documentation": "

The authorizer name.

" } }, - "tokenSigningPublicKeys": { - "target": "com.amazonaws.iot#PublicKeyMap", + "signingDisabled": { + "target": "com.amazonaws.iot#BooleanKey", "traits": { - "smithy.api#documentation": "

The public keys used to validate the token signature returned by your custom\n authentication service.

" + "smithy.api#documentation": "

Specifies whether AWS IoT validates the token signature in an authorization request.

" } }, - "creationDate": { + "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The UNIX timestamp of when the authorizer was created.

" + "smithy.api#documentation": "

The UNIX timestamp of when the authorizer was last updated.

" } }, - "tokenKeyName": { - "target": "com.amazonaws.iot#TokenKeyName", + "authorizerArn": { + "target": "com.amazonaws.iot#AuthorizerArn", "traits": { - "smithy.api#documentation": "

The key used to extract the token from the HTTP headers.

" + "smithy.api#documentation": "

The authorizer ARN.

" } }, - "signingDisabled": { - "target": "com.amazonaws.iot#BooleanKey", + "tokenSigningPublicKeys": { + "target": "com.amazonaws.iot#PublicKeyMap", "traits": { - "smithy.api#documentation": "

Specifies whether AWS IoT validates the token signature in an authorization request.

" + "smithy.api#documentation": "

The public keys used to validate the token signature returned by your custom\n authentication service.

" + } + }, + "tokenKeyName": { + "target": "com.amazonaws.iot#TokenKeyName", + "traits": { + "smithy.api#documentation": "

The key used to extract the token from the HTTP headers.

" } } }, @@ -2586,7 +2678,13 @@ } }, "com.amazonaws.iot#AuthorizerFunctionArn": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } }, "com.amazonaws.iot#AuthorizerName": { "type": "string", @@ -2616,17 +2714,17 @@ "com.amazonaws.iot#AuthorizerSummary": { "type": "structure", "members": { - "authorizerArn": { - "target": "com.amazonaws.iot#AuthorizerArn", - "traits": { - "smithy.api#documentation": "

The authorizer ARN.

" - } - }, "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

" } + }, + "authorizerArn": { + "target": "com.amazonaws.iot#AuthorizerArn", + "traits": { + "smithy.api#documentation": "

The authorizer ARN.

" + } } }, "traits": { @@ -2697,10 +2795,10 @@ "com.amazonaws.iot#AwsJobAbortCriteria": { "type": "structure", "members": { - "action": { - "target": "com.amazonaws.iot#AwsJobAbortCriteriaAbortAction", + "minNumberOfExecutedThings": { + "target": "com.amazonaws.iot#AwsJobAbortCriteriaMinimumNumberOfExecutedThings", "traits": { - "smithy.api#documentation": "

The type of job action to take to initiate the job abort.

", + "smithy.api#documentation": "

The minimum number of things which must receive job execution notifications before the job \n can be aborted.

", "smithy.api#required": {} } }, @@ -2718,10 +2816,10 @@ "smithy.api#required": {} } }, - "minNumberOfExecutedThings": { - "target": "com.amazonaws.iot#AwsJobAbortCriteriaMinimumNumberOfExecutedThings", + "action": { + "target": "com.amazonaws.iot#AwsJobAbortCriteriaAbortAction", "traits": { - "smithy.api#documentation": "

The minimum number of things which must receive job execution notifications before the job \n can be aborted.

", + "smithy.api#documentation": "

The type of job action to take to initiate the job abort.

", "smithy.api#required": {} } } @@ -2796,17 +2894,17 @@ "com.amazonaws.iot#AwsJobExecutionsRolloutConfig": { "type": "structure", "members": { - "maximumPerMinute": { - "target": "com.amazonaws.iot#MaximumPerMinute", - "traits": { - "smithy.api#documentation": "

The maximum number of OTA update job executions started per minute.

" - } - }, "exponentialRate": { "target": "com.amazonaws.iot#AwsJobExponentialRolloutRate", "traits": { "smithy.api#documentation": "

The rate of increase for a job rollout. This parameter allows you to define an exponential rate \n increase for a job rollout.

" } + }, + "maximumPerMinute": { + "target": "com.amazonaws.iot#MaximumPerMinute", + "traits": { + "smithy.api#documentation": "

The maximum number of OTA update job executions started per minute.

" + } } }, "traits": { @@ -2816,17 +2914,17 @@ "com.amazonaws.iot#AwsJobExponentialRolloutRate": { "type": "structure", "members": { - "rateIncreaseCriteria": { - "target": "com.amazonaws.iot#AwsJobRateIncreaseCriteria", + "incrementFactor": { + "target": "com.amazonaws.iot#AwsJobRolloutIncrementFactor", "traits": { - "smithy.api#documentation": "

The criteria to initiate the increase in rate of rollout for a job.

\n

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

", + "smithy.api#documentation": "

The rate of increase for a job rollout. The number of things notified is multiplied by this \n factor.

", "smithy.api#required": {} } }, - "incrementFactor": { - "target": "com.amazonaws.iot#AwsJobRolloutIncrementFactor", + "rateIncreaseCriteria": { + "target": "com.amazonaws.iot#AwsJobRateIncreaseCriteria", "traits": { - "smithy.api#documentation": "

The rate of increase for a job rollout. The number of things notified is multiplied by this \n factor.

", + "smithy.api#documentation": "

The criteria to initiate the increase in rate of rollout for a job.

\n

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

", "smithy.api#required": {} } }, @@ -2921,6 +3019,12 @@ "com.amazonaws.iot#Behavior": { "type": "structure", "members": { + "metricDimension": { + "target": "com.amazonaws.iot#MetricDimension", + "traits": { + "smithy.api#documentation": "

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

" + } + }, "criteria": { "target": "com.amazonaws.iot#BehaviorCriteria", "traits": { @@ -2934,12 +3038,6 @@ "smithy.api#required": {} } }, - "metricDimension": { - "target": "com.amazonaws.iot#MetricDimension", - "traits": { - "smithy.api#documentation": "

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

" - } - }, "metric": { "target": "com.amazonaws.iot#BehaviorMetric", "traits": { @@ -2954,16 +3052,16 @@ "com.amazonaws.iot#BehaviorCriteria": { "type": "structure", "members": { - "consecutiveDatapointsToAlarm": { - "target": "com.amazonaws.iot#ConsecutiveDatapointsToAlarm", + "value": { + "target": "com.amazonaws.iot#MetricValue", "traits": { - "smithy.api#documentation": "

If a device is in violation of the behavior for the specified number of consecutive \n datapoints, an alarm occurs. If not specified, the default is 1.

" + "smithy.api#documentation": "

The value to be compared with the metric.

" } }, - "consecutiveDatapointsToClear": { - "target": "com.amazonaws.iot#ConsecutiveDatapointsToClear", + "comparisonOperator": { + "target": "com.amazonaws.iot#ComparisonOperator", "traits": { - "smithy.api#documentation": "

If an alarm has occurred and the offending device is no longer in violation of the behavior \n for the specified number of consecutive datapoints, the alarm is cleared. If not specified,\n the default is 1.

" + "smithy.api#documentation": "

The operator that relates the thing measured (metric) to the criteria \n (containing a value or statisticalThreshold).

" } }, "durationSeconds": { @@ -2972,16 +3070,10 @@ "smithy.api#documentation": "

Use this to specify the time duration over which the behavior is evaluated,\n for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT).\n For a statisticalThreshhold metric comparison, measurements from all devices are \n accumulated over this time duration before being used to calculate percentiles, and later,\n measurements from an individual device are also accumulated over this time duration before being\n given a percentile rank.

" } }, - "value": { - "target": "com.amazonaws.iot#MetricValue", - "traits": { - "smithy.api#documentation": "

The value to be compared with the metric.

" - } - }, - "comparisonOperator": { - "target": "com.amazonaws.iot#ComparisonOperator", + "consecutiveDatapointsToAlarm": { + "target": "com.amazonaws.iot#ConsecutiveDatapointsToAlarm", "traits": { - "smithy.api#documentation": "

The operator that relates the thing measured (metric) to the criteria \n (containing a value or statisticalThreshold).

" + "smithy.api#documentation": "

If a device is in violation of the behavior for the specified number of consecutive \n datapoints, an alarm occurs. If not specified, the default is 1.

" } }, "statisticalThreshold": { @@ -2989,6 +3081,12 @@ "traits": { "smithy.api#documentation": "

A statistical ranking (percentile) which indicates a threshold value by which a behavior \n is determined to be in compliance or in violation of the behavior.

" } + }, + "consecutiveDatapointsToClear": { + "target": "com.amazonaws.iot#ConsecutiveDatapointsToClear", + "traits": { + "smithy.api#documentation": "

If an alarm has occurred and the offending device is no longer in violation of the behavior \n for the specified number of consecutive datapoints, the alarm is cleared. If not specified,\n the default is 1.

" + } } }, "traits": { @@ -3102,20 +3200,20 @@ "com.amazonaws.iot#CACertificate": { "type": "structure", "members": { - "certificateId": { - "target": "com.amazonaws.iot#CertificateId", - "traits": { - "smithy.api#documentation": "

The ID of the CA certificate.

" - } - }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the CA certificate was created.

" } }, - "certificateArn": { - "target": "com.amazonaws.iot#CertificateArn", + "certificateId": { + "target": "com.amazonaws.iot#CertificateId", + "traits": { + "smithy.api#documentation": "

The ID of the CA certificate.

" + } + }, + "certificateArn": { + "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The ARN of the CA certificate.

" } @@ -3134,10 +3232,10 @@ "com.amazonaws.iot#CACertificateDescription": { "type": "structure", "members": { - "validity": { - "target": "com.amazonaws.iot#CertificateValidity", + "lastModifiedDate": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

When the CA certificate is valid.

" + "smithy.api#documentation": "

The date the CA certificate was last modified.

" } }, "status": { @@ -3146,24 +3244,6 @@ "smithy.api#documentation": "

The status of a CA certificate.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The date the CA certificate was created.

" - } - }, - "ownedBy": { - "target": "com.amazonaws.iot#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The owner of the CA certificate.

" - } - }, - "customerVersion": { - "target": "com.amazonaws.iot#CustomerVersion", - "traits": { - "smithy.api#documentation": "

The customer version of the CA certificate.

" - } - }, "autoRegistrationStatus": { "target": "com.amazonaws.iot#AutoRegistrationStatus", "traits": { @@ -3176,10 +3256,16 @@ "smithy.api#documentation": "

The CA certificate ARN.

" } }, - "certificatePem": { - "target": "com.amazonaws.iot#CertificatePem", + "customerVersion": { + "target": "com.amazonaws.iot#CustomerVersion", "traits": { - "smithy.api#documentation": "

The CA certificate data, in PEM format.

" + "smithy.api#documentation": "

The customer version of the CA certificate.

" + } + }, + "validity": { + "target": "com.amazonaws.iot#CertificateValidity", + "traits": { + "smithy.api#documentation": "

When the CA certificate is valid.

" } }, "certificateId": { @@ -3188,10 +3274,16 @@ "smithy.api#documentation": "

The CA certificate ID.

" } }, - "lastModifiedDate": { + "ownedBy": { + "target": "com.amazonaws.iot#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The owner of the CA certificate.

" + } + }, + "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date the CA certificate was last modified.

" + "smithy.api#documentation": "

The date the CA certificate was created.

" } }, "generationId": { @@ -3199,6 +3291,12 @@ "traits": { "smithy.api#documentation": "

The generation ID of the CA certificate.

" } + }, + "certificatePem": { + "target": "com.amazonaws.iot#CertificatePem", + "traits": { + "smithy.api#documentation": "

The CA certificate data, in PEM format.

" + } } }, "traits": { @@ -3454,10 +3552,10 @@ "com.amazonaws.iot#CancelJobExecutionRequest": { "type": "structure", "members": { - "statusDetails": { - "target": "com.amazonaws.iot#DetailsMap", + "expectedVersion": { + "target": "com.amazonaws.iot#ExpectedVersion", "traits": { - "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution. If not \n specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

" + "smithy.api#documentation": "

(Optional) The expected current version of the job execution. Each time you update the job \n execution, its version is incremented. If the version of the job execution stored in Jobs does \n not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that \n contains the current job execution status data is returned. (This makes it unnecessary to \n perform a separate DescribeJobExecution request in order to obtain the job execution status \n data.)

" } }, "force": { @@ -3467,24 +3565,24 @@ "smithy.api#httpQuery": "force" } }, - "expectedVersion": { - "target": "com.amazonaws.iot#ExpectedVersion", + "thingName": { + "target": "com.amazonaws.iot#ThingName", "traits": { - "smithy.api#documentation": "

(Optional) The expected current version of the job execution. Each time you update the job \n execution, its version is incremented. If the version of the job execution stored in Jobs does \n not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that \n contains the current job execution status data is returned. (This makes it unnecessary to \n perform a separate DescribeJobExecution request in order to obtain the job execution status \n data.)

" + "smithy.api#documentation": "

The name of the thing whose execution of the job will be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "jobId": { - "target": "com.amazonaws.iot#JobId", + "statusDetails": { + "target": "com.amazonaws.iot#DetailsMap", "traits": { - "smithy.api#documentation": "

The ID of the job to be canceled.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution. If not \n specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

" } }, - "thingName": { - "target": "com.amazonaws.iot#ThingName", + "jobId": { + "target": "com.amazonaws.iot#JobId", "traits": { - "smithy.api#documentation": "

The name of the thing whose execution of the job will be canceled.

", + "smithy.api#documentation": "

The ID of the job to be canceled.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3494,6 +3592,19 @@ "com.amazonaws.iot#CancelJobRequest": { "type": "structure", "members": { + "comment": { + "target": "com.amazonaws.iot#Comment", + "traits": { + "smithy.api#documentation": "

An optional comment string describing why the job was canceled.

" + } + }, + "force": { + "target": "com.amazonaws.iot#ForceFlag", + "traits": { + "smithy.api#documentation": "

(Optional) If true job executions with status \"IN_PROGRESS\" and \"QUEUED\" \n are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default \n is false.

\n

Canceling a job which is \"IN_PROGRESS\", will cause a device which is executing \n the job to be unable to update the job execution status. Use caution and ensure that each \n device executing a job which is canceled is able to recover to a valid state.

", + "smithy.api#httpQuery": "force" + } + }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { @@ -3502,30 +3613,23 @@ "smithy.api#required": {} } }, - "comment": { - "target": "com.amazonaws.iot#Comment", - "traits": { - "smithy.api#documentation": "

An optional comment string describing why the job was canceled.

" - } - }, "reasonCode": { "target": "com.amazonaws.iot#ReasonCode", "traits": { "smithy.api#documentation": "

(Optional)A reason code string that explains why the job was canceled.

" } - }, - "force": { - "target": "com.amazonaws.iot#ForceFlag", - "traits": { - "smithy.api#documentation": "

(Optional) If true job executions with status \"IN_PROGRESS\" and \"QUEUED\" \n are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default \n is false.

\n

Canceling a job which is \"IN_PROGRESS\", will cause a device which is executing \n the job to be unable to update the job execution status. Use caution and ensure that each \n device executing a job which is canceled is able to recover to a valid state.

", - "smithy.api#httpQuery": "force" - } } } }, "com.amazonaws.iot#CancelJobResponse": { "type": "structure", "members": { + "description": { + "target": "com.amazonaws.iot#JobDescription", + "traits": { + "smithy.api#documentation": "

A short text description of the job.

" + } + }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { @@ -3537,12 +3641,6 @@ "traits": { "smithy.api#documentation": "

The job ARN.

" } - }, - "description": { - "target": "com.amazonaws.iot#JobDescription", - "traits": { - "smithy.api#documentation": "

A short text description of the job.

" - } } } }, @@ -3606,18 +3704,6 @@ "com.amazonaws.iot#Certificate": { "type": "structure", "members": { - "certificateArn": { - "target": "com.amazonaws.iot#CertificateArn", - "traits": { - "smithy.api#documentation": "

The ARN of the certificate.

" - } - }, - "status": { - "target": "com.amazonaws.iot#CertificateStatus", - "traits": { - "smithy.api#documentation": "

The status of the certificate.

\n

The status value REGISTER_INACTIVE is deprecated and should not be used.

" - } - }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { @@ -3630,6 +3716,18 @@ "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

" } }, + "status": { + "target": "com.amazonaws.iot#CertificateStatus", + "traits": { + "smithy.api#documentation": "

The status of the certificate.

\n

The status value REGISTER_INACTIVE is deprecated and should not be used.

" + } + }, + "certificateArn": { + "target": "com.amazonaws.iot#CertificateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the certificate.

" + } + }, "certificateMode": { "target": "com.amazonaws.iot#CertificateMode", "traits": { @@ -3663,30 +3761,12 @@ "com.amazonaws.iot#CertificateDescription": { "type": "structure", "members": { - "certificateMode": { - "target": "com.amazonaws.iot#CertificateMode", - "traits": { - "smithy.api#documentation": "

The mode of the certificate.

" - } - }, - "certificatePem": { - "target": "com.amazonaws.iot#CertificatePem", - "traits": { - "smithy.api#documentation": "

The certificate data, in PEM format.

" - } - }, "caCertificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The certificate ID of the CA certificate used to sign this certificate.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The date and time the certificate was created.

" - } - }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { @@ -3699,10 +3779,22 @@ "smithy.api#documentation": "

The transfer data.

" } }, - "previousOwnedBy": { + "ownedBy": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account of the previous owner of the certificate.

" + "smithy.api#documentation": "

The ID of the AWS account that owns the certificate.

" + } + }, + "customerVersion": { + "target": "com.amazonaws.iot#CustomerVersion", + "traits": { + "smithy.api#documentation": "

The customer version of the certificate.

" + } + }, + "certificateArn": { + "target": "com.amazonaws.iot#CertificateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the certificate.

" } }, "lastModifiedDate": { @@ -3711,16 +3803,22 @@ "smithy.api#documentation": "

The date and time the certificate was last modified.

" } }, - "generationId": { - "target": "com.amazonaws.iot#GenerationId", + "certificatePem": { + "target": "com.amazonaws.iot#CertificatePem", "traits": { - "smithy.api#documentation": "

The generation ID of the certificate.

" + "smithy.api#documentation": "

The certificate data, in PEM format.

" } }, - "customerVersion": { - "target": "com.amazonaws.iot#CustomerVersion", + "validity": { + "target": "com.amazonaws.iot#CertificateValidity", "traits": { - "smithy.api#documentation": "

The customer version of the certificate.

" + "smithy.api#documentation": "

When the certificate is valid.

" + } + }, + "creationDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date and time the certificate was created.

" } }, "status": { @@ -3729,22 +3827,22 @@ "smithy.api#documentation": "

The status of the certificate.

" } }, - "ownedBy": { + "previousOwnedBy": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the certificate.

" + "smithy.api#documentation": "

The ID of the AWS account of the previous owner of the certificate.

" } }, - "validity": { - "target": "com.amazonaws.iot#CertificateValidity", + "certificateMode": { + "target": "com.amazonaws.iot#CertificateMode", "traits": { - "smithy.api#documentation": "

When the certificate is valid.

" + "smithy.api#documentation": "

The mode of the certificate.

" } }, - "certificateArn": { - "target": "com.amazonaws.iot#CertificateArn", + "generationId": { + "target": "com.amazonaws.iot#GenerationId", "traits": { - "smithy.api#documentation": "

The ARN of the certificate.

" + "smithy.api#documentation": "

The generation ID of the certificate.

" } } }, @@ -3867,16 +3965,16 @@ "com.amazonaws.iot#CertificateValidity": { "type": "structure", "members": { - "notAfter": { + "notBefore": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The certificate is not valid after this date.

" + "smithy.api#documentation": "

The certificate is not valid before this date.

" } }, - "notBefore": { + "notAfter": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The certificate is not valid before this date.

" + "smithy.api#documentation": "

The certificate is not valid after this date.

" } } }, @@ -3976,10 +4074,10 @@ "com.amazonaws.iot#CloudwatchAlarmAction": { "type": "structure", "members": { - "alarmName": { - "target": "com.amazonaws.iot#AlarmName", + "stateValue": { + "target": "com.amazonaws.iot#StateValue", "traits": { - "smithy.api#documentation": "

The CloudWatch alarm name.

", + "smithy.api#documentation": "

The value of the alarm state. Acceptable values are: OK, ALARM,\n INSUFFICIENT_DATA.

", "smithy.api#required": {} } }, @@ -3997,10 +4095,10 @@ "smithy.api#required": {} } }, - "stateValue": { - "target": "com.amazonaws.iot#StateValue", + "alarmName": { + "target": "com.amazonaws.iot#AlarmName", "traits": { - "smithy.api#documentation": "

The value of the alarm state. Acceptable values are: OK, ALARM,\n INSUFFICIENT_DATA.

", + "smithy.api#documentation": "

The CloudWatch alarm name.

", "smithy.api#required": {} } } @@ -4012,17 +4110,17 @@ "com.amazonaws.iot#CloudwatchLogsAction": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iot#AwsArn", + "logGroupName": { + "target": "com.amazonaws.iot#LogGroupName", "traits": { - "smithy.api#documentation": "

The IAM role that allows access to the CloudWatch log.

", + "smithy.api#documentation": "

The CloudWatch log group to which the action sends data.

", "smithy.api#required": {} } }, - "logGroupName": { - "target": "com.amazonaws.iot#LogGroupName", + "roleArn": { + "target": "com.amazonaws.iot#AwsArn", "traits": { - "smithy.api#documentation": "

The CloudWatch log group to which the action sends data.

", + "smithy.api#documentation": "

The IAM role that allows access to the CloudWatch log.

", "smithy.api#required": {} } } @@ -4034,17 +4132,17 @@ "com.amazonaws.iot#CloudwatchMetricAction": { "type": "structure", "members": { - "metricNamespace": { - "target": "com.amazonaws.iot#String", + "roleArn": { + "target": "com.amazonaws.iot#AwsArn", "traits": { - "smithy.api#documentation": "

The CloudWatch metric namespace name.

", + "smithy.api#documentation": "

The IAM role that allows access to the CloudWatch metric.

", "smithy.api#required": {} } }, - "metricUnit": { + "metricValue": { "target": "com.amazonaws.iot#String", "traits": { - "smithy.api#documentation": "

The metric\n unit supported by CloudWatch.

", + "smithy.api#documentation": "

The CloudWatch metric value.

", "smithy.api#required": {} } }, @@ -4055,24 +4153,24 @@ "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.iot#AwsArn", + "metricNamespace": { + "target": "com.amazonaws.iot#String", "traits": { - "smithy.api#documentation": "

The IAM role that allows access to the CloudWatch metric.

", + "smithy.api#documentation": "

The CloudWatch metric namespace name.

", "smithy.api#required": {} } }, - "metricTimestamp": { + "metricUnit": { "target": "com.amazonaws.iot#String", "traits": { - "smithy.api#documentation": "

An optional Unix timestamp.

" + "smithy.api#documentation": "

The metric\n unit supported by CloudWatch.

", + "smithy.api#required": {} } }, - "metricValue": { + "metricTimestamp": { "target": "com.amazonaws.iot#String", "traits": { - "smithy.api#documentation": "

The CloudWatch metric value.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional Unix timestamp.

" } } }, @@ -4086,12 +4184,6 @@ "com.amazonaws.iot#CodeSigning": { "type": "structure", "members": { - "customCodeSigning": { - "target": "com.amazonaws.iot#CustomCodeSigning", - "traits": { - "smithy.api#documentation": "

A custom method for code signing a file.

" - } - }, "startSigningJobParameter": { "target": "com.amazonaws.iot#StartSigningJobParameter", "traits": { @@ -4103,6 +4195,12 @@ "traits": { "smithy.api#documentation": "

The ID of the AWSSignerJob which was created to sign the file.

" } + }, + "customCodeSigning": { + "target": "com.amazonaws.iot#CustomCodeSigning", + "traits": { + "smithy.api#documentation": "

A custom method for code signing a file.

" + } } }, "traits": { @@ -4112,17 +4210,17 @@ "com.amazonaws.iot#CodeSigningCertificateChain": { "type": "structure", "members": { - "certificateName": { - "target": "com.amazonaws.iot#CertificateName", - "traits": { - "smithy.api#documentation": "

The name of the certificate.

" - } - }, "inlineDocument": { "target": "com.amazonaws.iot#InlineDocument", "traits": { "smithy.api#documentation": "

A base64 encoded binary representation of the code signing certificate chain.

" } + }, + "certificateName": { + "target": "com.amazonaws.iot#CertificateName", + "traits": { + "smithy.api#documentation": "

The name of the certificate.

" + } } }, "traits": { @@ -4320,6 +4418,87 @@ "com.amazonaws.iot#Count": { "type": "integer" }, + "com.amazonaws.iot#CreateAuditSuppression": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#CreateAuditSuppressionRequest" + }, + "output": { + "target": "com.amazonaws.iot#CreateAuditSuppressionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#LimitExceededException" + }, + { + "target": "com.amazonaws.iot#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates a Device Defender audit suppression.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/audit/suppressions/create", + "code": 200 + } + } + }, + "com.amazonaws.iot#CreateAuditSuppressionRequest": { + "type": "structure", + "members": { + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName", + "traits": { + "smithy.api#required": {} + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iot#AuditDescription", + "traits": { + "smithy.api#documentation": "

\n The description of the audit suppression.\n

" + } + }, + "suppressIndefinitely": { + "target": "com.amazonaws.iot#SuppressIndefinitely", + "traits": { + "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.iot#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

\n The epoch timestamp in seconds at which this suppression expires.\n

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "expirationDate": { + "target": "com.amazonaws.iot#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The epoch timestamp in seconds at which this suppression expires.\n

" + } + } + } + }, + "com.amazonaws.iot#CreateAuditSuppressionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iot#CreateAuthorizer": { "type": "operation", "input": { @@ -4363,6 +4542,19 @@ "com.amazonaws.iot#CreateAuthorizerRequest": { "type": "structure", "members": { + "authorizerFunctionArn": { + "target": "com.amazonaws.iot#AuthorizerFunctionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

", + "smithy.api#required": {} + } + }, + "signingDisabled": { + "target": "com.amazonaws.iot#BooleanKey", + "traits": { + "smithy.api#documentation": "

Specifies whether AWS IoT validates the token signature in an authorization request.

" + } + }, "tokenSigningPublicKeys": { "target": "com.amazonaws.iot#PublicKeyMap", "traits": { @@ -4375,12 +4567,6 @@ "smithy.api#documentation": "

The name of the token key used to extract the token from the HTTP headers.

" } }, - "signingDisabled": { - "target": "com.amazonaws.iot#BooleanKey", - "traits": { - "smithy.api#documentation": "

Specifies whether AWS IoT validates the token signature in an authorization request.

" - } - }, "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { @@ -4389,41 +4575,34 @@ "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.iot#AuthorizerStatus", - "traits": { - "smithy.api#documentation": "

The status of the create authorizer request.

" - } - }, - "authorizerFunctionArn": { - "target": "com.amazonaws.iot#AuthorizerFunctionArn", - "traits": { - "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the custom authorizer.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " } + }, + "status": { + "target": "com.amazonaws.iot#AuthorizerStatus", + "traits": { + "smithy.api#documentation": "

The status of the create authorizer request.

" + } } } }, "com.amazonaws.iot#CreateAuthorizerResponse": { "type": "structure", "members": { - "authorizerArn": { - "target": "com.amazonaws.iot#AuthorizerArn", - "traits": { - "smithy.api#documentation": "

The authorizer ARN.

" - } - }, "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer's name.

" } + }, + "authorizerArn": { + "target": "com.amazonaws.iot#AuthorizerArn", + "traits": { + "smithy.api#documentation": "

The authorizer ARN.

" + } } } }, @@ -4461,12 +4640,6 @@ "com.amazonaws.iot#CreateBillingGroupRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iot#TagList", - "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the billing group.

" - } - }, "billingGroupProperties": { "target": "com.amazonaws.iot#BillingGroupProperties", "traits": { @@ -4480,16 +4653,22 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.iot#TagList", + "traits": { + "smithy.api#documentation": "

Metadata which can be used to manage the billing group.

" + } } } }, "com.amazonaws.iot#CreateBillingGroupResponse": { "type": "structure", "members": { - "billingGroupId": { - "target": "com.amazonaws.iot#BillingGroupId", + "billingGroupArn": { + "target": "com.amazonaws.iot#BillingGroupArn", "traits": { - "smithy.api#documentation": "

The ID of the billing group.

" + "smithy.api#documentation": "

The ARN of the billing group.

" } }, "billingGroupName": { @@ -4498,10 +4677,10 @@ "smithy.api#documentation": "

The name you gave to the billing group.

" } }, - "billingGroupArn": { - "target": "com.amazonaws.iot#BillingGroupArn", + "billingGroupId": { + "target": "com.amazonaws.iot#BillingGroupId", "traits": { - "smithy.api#documentation": "

The ARN of the billing group.

" + "smithy.api#documentation": "

The ID of the billing group.

" } } } @@ -4543,19 +4722,19 @@ "com.amazonaws.iot#CreateCertificateFromCsrRequest": { "type": "structure", "members": { - "setAsActive": { - "target": "com.amazonaws.iot#SetAsActive", - "traits": { - "smithy.api#documentation": "

Specifies whether the certificate is active.

", - "smithy.api#httpQuery": "setAsActive" - } - }, "certificateSigningRequest": { "target": "com.amazonaws.iot#CertificateSigningRequest", "traits": { "smithy.api#documentation": "

The certificate signing request (CSR).

", "smithy.api#required": {} } + }, + "setAsActive": { + "target": "com.amazonaws.iot#SetAsActive", + "traits": { + "smithy.api#documentation": "

Specifies whether the certificate is active.

", + "smithy.api#httpQuery": "setAsActive" + } } }, "traits": { @@ -4565,12 +4744,6 @@ "com.amazonaws.iot#CreateCertificateFromCsrResponse": { "type": "structure", "members": { - "certificatePem": { - "target": "com.amazonaws.iot#CertificatePem", - "traits": { - "smithy.api#documentation": "

The certificate data, in PEM format.

" - } - }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { @@ -4582,6 +4755,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal\n for policy operations.

" } + }, + "certificatePem": { + "target": "com.amazonaws.iot#CertificatePem", + "traits": { + "smithy.api#documentation": "

The certificate data, in PEM format.

" + } } }, "traits": { @@ -4625,19 +4804,14 @@ "com.amazonaws.iot#CreateDimensionRequest": { "type": "structure", "members": { - "stringValues": { - "target": "com.amazonaws.iot#DimensionStringValues", + "name": { + "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", + "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.iot#TagList", - "traits": { - "smithy.api#documentation": "

Metadata that can be used to manage the dimension.

" - } - }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { @@ -4646,6 +4820,12 @@ "smithy.api#required": {} } }, + "tags": { + "target": "com.amazonaws.iot#TagList", + "traits": { + "smithy.api#documentation": "

Metadata that can be used to manage the dimension.

" + } + }, "type": { "target": "com.amazonaws.iot#DimensionType", "traits": { @@ -4653,11 +4833,10 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iot#DimensionName", + "stringValues": { + "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } } @@ -4666,17 +4845,17 @@ "com.amazonaws.iot#CreateDimensionResponse": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.iot#DimensionName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension.

" - } - }, "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { "smithy.api#documentation": "

The ARN (Amazon resource name) of the created dimension.

" } + }, + "name": { + "target": "com.amazonaws.iot#DimensionName", + "traits": { + "smithy.api#documentation": "

A unique identifier for the dimension.

" + } } } }, @@ -4726,6 +4905,12 @@ "com.amazonaws.iot#CreateDomainConfigurationRequest": { "type": "structure", "members": { + "serviceType": { + "target": "com.amazonaws.iot#ServiceType", + "traits": { + "smithy.api#documentation": "

The type of service delivered by the endpoint.

\n \n

AWS IoT Core currently supports only the DATA service type.

\n " + } + }, "domainConfigurationName": { "target": "com.amazonaws.iot#DomainConfigurationName", "traits": { @@ -4734,34 +4919,22 @@ "smithy.api#required": {} } }, - "domainName": { - "target": "com.amazonaws.iot#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, "validationCertificateArn": { "target": "com.amazonaws.iot#AcmCertificateArn", "traits": { "smithy.api#documentation": "

The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. \n This value is not required for AWS-managed domains.

" } }, - "serverCertificateArns": { - "target": "com.amazonaws.iot#ServerCertificateArns", - "traits": { - "smithy.api#documentation": "

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. \n This value is not required for AWS-managed domains.

" - } - }, "authorizerConfig": { "target": "com.amazonaws.iot#AuthorizerConfig", "traits": { "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" } }, - "serviceType": { - "target": "com.amazonaws.iot#ServiceType", + "domainName": { + "target": "com.amazonaws.iot#DomainName", "traits": { - "smithy.api#documentation": "

The type of service delivered by the endpoint.

\n \n

AWS IoT Core currently supports only the DATA service type.

\n " + "smithy.api#documentation": "

The name of the domain.

" } }, "tags": { @@ -4769,6 +4942,12 @@ "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the domain configuration.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " } + }, + "serverCertificateArns": { + "target": "com.amazonaws.iot#ServerCertificateArns", + "traits": { + "smithy.api#documentation": "

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. \n This value is not required for AWS-managed domains.

" + } } } }, @@ -4832,24 +5011,18 @@ "com.amazonaws.iot#CreateDynamicThingGroupRequest": { "type": "structure", "members": { - "queryVersion": { - "target": "com.amazonaws.iot#QueryVersion", - "traits": { - "smithy.api#documentation": "

The dynamic thing group query version.

\n\t\t \n\t\t\t

Currently one query version is supported: \"2017-09-30\". If not specified, the\n\t\t\t\tquery version defaults to this value.

\n\t\t " - } - }, - "indexName": { - "target": "com.amazonaws.iot#IndexName", - "traits": { - "smithy.api#documentation": "

The dynamic thing group index name.

\n\t\t \n\t\t\t

Currently one index is supported: \"AWS_Things\".

\n\t\t " - } - }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { "smithy.api#documentation": "

The dynamic thing group properties.

" } }, + "tags": { + "target": "com.amazonaws.iot#TagList", + "traits": { + "smithy.api#documentation": "

Metadata which can be used to manage the dynamic thing group.

" + } + }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { @@ -4857,6 +5030,12 @@ "smithy.api#required": {} } }, + "indexName": { + "target": "com.amazonaws.iot#IndexName", + "traits": { + "smithy.api#documentation": "

The dynamic thing group index name.

\n\t\t \n\t\t\t

Currently one index is supported: \"AWS_Things\".

\n\t\t " + } + }, "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { @@ -4865,10 +5044,10 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.iot#TagList", + "queryVersion": { + "target": "com.amazonaws.iot#QueryVersion", "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the dynamic thing group.

" + "smithy.api#documentation": "

The dynamic thing group query version.

\n\t\t \n\t\t\t

Currently one query version is supported: \"2017-09-30\". If not specified, the\n\t\t\t\tquery version defaults to this value.

\n\t\t " } } } @@ -4876,10 +5055,10 @@ "com.amazonaws.iot#CreateDynamicThingGroupResponse": { "type": "structure", "members": { - "thingGroupArn": { - "target": "com.amazonaws.iot#ThingGroupArn", + "indexName": { + "target": "com.amazonaws.iot#IndexName", "traits": { - "smithy.api#documentation": "

The dynamic thing group ARN.

" + "smithy.api#documentation": "

The dynamic thing group index name.

" } }, "queryString": { @@ -4894,22 +5073,22 @@ "smithy.api#documentation": "

The dynamic thing group query version.

" } }, - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", + "thingGroupId": { + "target": "com.amazonaws.iot#ThingGroupId", "traits": { - "smithy.api#documentation": "

The dynamic thing group name.

" + "smithy.api#documentation": "

The dynamic thing group ID.

" } }, - "indexName": { - "target": "com.amazonaws.iot#IndexName", + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", "traits": { - "smithy.api#documentation": "

The dynamic thing group index name.

" + "smithy.api#documentation": "

The dynamic thing group name.

" } }, - "thingGroupId": { - "target": "com.amazonaws.iot#ThingGroupId", + "thingGroupArn": { + "target": "com.amazonaws.iot#ThingGroupArn", "traits": { - "smithy.api#documentation": "

The dynamic thing group ID.

" + "smithy.api#documentation": "

The dynamic thing group ARN.

" } } } @@ -4954,43 +5133,40 @@ "com.amazonaws.iot#CreateJobRequest": { "type": "structure", "members": { - "document": { - "target": "com.amazonaws.iot#JobDocument", + "presignedUrlConfig": { + "target": "com.amazonaws.iot#PresignedUrlConfig", "traits": { - "smithy.api#documentation": "

The job document.

\n \n

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

\n

The placeholder link is of the following form:

\n

\n ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}\n

\n

where bucket is your bucket name and key is the object in the bucket to which you are linking.

\n " + "smithy.api#documentation": "

Configuration information for pre-signed S3 URLs.

" } }, - "jobId": { - "target": "com.amazonaws.iot#JobId", + "description": { + "target": "com.amazonaws.iot#JobDescription", "traits": { - "smithy.api#documentation": "

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric\n characters, \"-\" and \"_\" are valid for use here.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A short text description of the job.

" } }, - "timeoutConfig": { - "target": "com.amazonaws.iot#TimeoutConfig", + "documentSource": { + "target": "com.amazonaws.iot#JobDocumentSource", "traits": { - "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. The timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the time expires, it will be \n automatically set to TIMED_OUT.

" + "smithy.api#documentation": "

An S3 link to the job document.

" } }, - "targets": { - "target": "com.amazonaws.iot#JobTargets", + "targetSelection": { + "target": "com.amazonaws.iot#TargetSelection", "traits": { - "smithy.api#documentation": "

A list of things and thing groups to which the job should be sent.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.

" } }, - "tags": { - "target": "com.amazonaws.iot#TagList", + "jobExecutionsRolloutConfig": { + "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the job.

" + "smithy.api#documentation": "

Allows you to create a staged rollout of the job.

" } }, - "documentSource": { - "target": "com.amazonaws.iot#JobDocumentSource", + "tags": { + "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "

An S3 link to the job document.

" + "smithy.api#documentation": "

Metadata which can be used to manage the job.

" } }, "abortConfig": { @@ -4999,28 +5175,31 @@ "smithy.api#documentation": "

Allows you to create criteria to abort a job.

" } }, - "description": { - "target": "com.amazonaws.iot#JobDescription", + "jobId": { + "target": "com.amazonaws.iot#JobId", "traits": { - "smithy.api#documentation": "

A short text description of the job.

" + "smithy.api#documentation": "

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric\n characters, \"-\" and \"_\" are valid for use here.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "targetSelection": { - "target": "com.amazonaws.iot#TargetSelection", + "targets": { + "target": "com.amazonaws.iot#JobTargets", "traits": { - "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.

" + "smithy.api#documentation": "

A list of things and thing groups to which the job should be sent.

", + "smithy.api#required": {} } }, - "jobExecutionsRolloutConfig": { - "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", + "document": { + "target": "com.amazonaws.iot#JobDocument", "traits": { - "smithy.api#documentation": "

Allows you to create a staged rollout of the job.

" + "smithy.api#documentation": "

The job document.

\n \n

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

\n

The placeholder link is of the following form:

\n

\n ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}\n

\n

where bucket is your bucket name and key is the object in the bucket to which you are linking.

\n " } }, - "presignedUrlConfig": { - "target": "com.amazonaws.iot#PresignedUrlConfig", + "timeoutConfig": { + "target": "com.amazonaws.iot#TimeoutConfig", "traits": { - "smithy.api#documentation": "

Configuration information for pre-signed S3 URLs.

" + "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. The timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the time expires, it will be \n automatically set to TIMED_OUT.

" } } } @@ -5100,18 +5279,6 @@ "com.amazonaws.iot#CreateKeysAndCertificateResponse": { "type": "structure", "members": { - "certificateArn": { - "target": "com.amazonaws.iot#CertificateArn", - "traits": { - "smithy.api#documentation": "

The ARN of the certificate.

" - } - }, - "keyPair": { - "target": "com.amazonaws.iot#KeyPair", - "traits": { - "smithy.api#documentation": "

The generated key pair.

" - } - }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { @@ -5123,6 +5290,18 @@ "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

" } + }, + "certificateArn": { + "target": "com.amazonaws.iot#CertificateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the certificate.

" + } + }, + "keyPair": { + "target": "com.amazonaws.iot#KeyPair", + "traits": { + "smithy.api#documentation": "

The generated key pair.

" + } } }, "traits": { @@ -5155,7 +5334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.

", + "smithy.api#documentation": "

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

", "smithy.api#http": { "method": "POST", "uri": "/mitigationactions/actions/{actionName}", @@ -5166,20 +5345,6 @@ "com.amazonaws.iot#CreateMitigationActionRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iot#TagList", - "traits": { - "smithy.api#documentation": "

Metadata that can be used to manage the mitigation action.

" - } - }, - "actionName": { - "target": "com.amazonaws.iot#MitigationActionName", - "traits": { - "smithy.api#documentation": "

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { @@ -5193,23 +5358,37 @@ "smithy.api#documentation": "

Defines the type of action and the parameters for that action.

", "smithy.api#required": {} } + }, + "actionName": { + "target": "com.amazonaws.iot#MitigationActionName", + "traits": { + "smithy.api#documentation": "

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iot#TagList", + "traits": { + "smithy.api#documentation": "

Metadata that can be used to manage the mitigation action.

" + } } } }, "com.amazonaws.iot#CreateMitigationActionResponse": { "type": "structure", "members": { - "actionId": { - "target": "com.amazonaws.iot#MitigationActionId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the new mitigation action.

" - } - }, "actionArn": { "target": "com.amazonaws.iot#MitigationActionArn", "traits": { "smithy.api#documentation": "

The ARN for the new mitigation action.

" } + }, + "actionId": { + "target": "com.amazonaws.iot#MitigationActionId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new mitigation action.

" + } } } }, @@ -5259,36 +5438,35 @@ "com.amazonaws.iot#CreateOTAUpdateRequest": { "type": "structure", "members": { - "awsJobExecutionsRolloutConfig": { - "target": "com.amazonaws.iot#AwsJobExecutionsRolloutConfig", + "tags": { + "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "

Configuration for the rollout of OTA updates.

" + "smithy.api#documentation": "

Metadata which can be used to manage updates.

" } }, - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "awsJobTimeoutConfig": { + "target": "com.amazonaws.iot#AwsJobTimeoutConfig", "traits": { - "smithy.api#documentation": "

The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources \n to create an OTA update job.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer is \n started when the job execution status is set to IN_PROGRESS. If the job execution \n status is not set to another terminal state before the timer expires, it will be automatically \n set to TIMED_OUT.

" } }, - "targets": { - "target": "com.amazonaws.iot#Targets", + "description": { + "target": "com.amazonaws.iot#OTAUpdateDescription", "traits": { - "smithy.api#documentation": "

The devices targeted to receive OTA updates.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the OTA update.

" } }, - "protocols": { - "target": "com.amazonaws.iot#Protocols", + "files": { + "target": "com.amazonaws.iot#OTAUpdateFiles", "traits": { - "smithy.api#documentation": "

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both\n HTTP and MQTT are specified, the target device can choose the protocol.

" + "smithy.api#documentation": "

The files to be streamed by the OTA update.

", + "smithy.api#required": {} } }, - "awsJobPresignedUrlConfig": { - "target": "com.amazonaws.iot#AwsJobPresignedUrlConfig", + "targetSelection": { + "target": "com.amazonaws.iot#TargetSelection", "traits": { - "smithy.api#documentation": "

Configuration information for pre-signed URLs.

" + "smithy.api#documentation": "

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things\n specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a\n thing when a change is detected in a target. For example, an update will run on a thing when the thing is\n added to a target group, even after the update was completed by all things originally in the group. Valid\n values: CONTINUOUS | SNAPSHOT.

" } }, "awsJobAbortConfig": { @@ -5297,49 +5475,50 @@ "smithy.api#documentation": "

The criteria that determine when and how a job abort takes place.

" } }, - "additionalParameters": { - "target": "com.amazonaws.iot#AdditionalParameterMap", + "otaUpdateId": { + "target": "com.amazonaws.iot#OTAUpdateId", "traits": { - "smithy.api#documentation": "

A list of additional OTA update parameters which are name-value pairs.

" + "smithy.api#documentation": "

The ID of the OTA update to be created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.iot#OTAUpdateDescription", + "protocols": { + "target": "com.amazonaws.iot#Protocols", "traits": { - "smithy.api#documentation": "

The description of the OTA update.

" + "smithy.api#documentation": "

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both\n HTTP and MQTT are specified, the target device can choose the protocol.

" } }, - "awsJobTimeoutConfig": { - "target": "com.amazonaws.iot#AwsJobTimeoutConfig", - "traits": { - "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer is \n started when the job execution status is set to IN_PROGRESS. If the job execution \n status is not set to another terminal state before the timer expires, it will be automatically \n set to TIMED_OUT.

" + "targets": { + "target": "com.amazonaws.iot#Targets", + "traits": { + "smithy.api#documentation": "

The devices targeted to receive OTA updates.

", + "smithy.api#required": {} } }, - "files": { - "target": "com.amazonaws.iot#OTAUpdateFiles", + "awsJobPresignedUrlConfig": { + "target": "com.amazonaws.iot#AwsJobPresignedUrlConfig", "traits": { - "smithy.api#documentation": "

The files to be streamed by the OTA update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Configuration information for pre-signed URLs.

" } }, - "tags": { - "target": "com.amazonaws.iot#TagList", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage updates.

" + "smithy.api#documentation": "

The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources \n to create an OTA update job.

", + "smithy.api#required": {} } }, - "targetSelection": { - "target": "com.amazonaws.iot#TargetSelection", + "awsJobExecutionsRolloutConfig": { + "target": "com.amazonaws.iot#AwsJobExecutionsRolloutConfig", "traits": { - "smithy.api#documentation": "

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things\n specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a\n thing when a change is detected in a target. For example, an update will run on a thing when the thing is\n added to a target group, even after the update was completed by all things originally in the group. Valid\n values: CONTINUOUS | SNAPSHOT.

" + "smithy.api#documentation": "

Configuration for the rollout of OTA updates.

" } }, - "otaUpdateId": { - "target": "com.amazonaws.iot#OTAUpdateId", + "additionalParameters": { + "target": "com.amazonaws.iot#AdditionalParameterMap", "traits": { - "smithy.api#documentation": "

The ID of the OTA update to be created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A list of additional OTA update parameters which are name-value pairs.

" } } } @@ -5347,18 +5526,24 @@ "com.amazonaws.iot#CreateOTAUpdateResponse": { "type": "structure", "members": { - "otaUpdateId": { - "target": "com.amazonaws.iot#OTAUpdateId", - "traits": { - "smithy.api#documentation": "

The OTA update ID.

" - } - }, "awsIotJobId": { "target": "com.amazonaws.iot#AwsIotJobId", "traits": { "smithy.api#documentation": "

The AWS IoT job ID associated with the OTA update.

" } }, + "awsIotJobArn": { + "target": "com.amazonaws.iot#AwsIotJobArn", + "traits": { + "smithy.api#documentation": "

The AWS IoT job ARN associated with the OTA update.

" + } + }, + "otaUpdateId": { + "target": "com.amazonaws.iot#OTAUpdateId", + "traits": { + "smithy.api#documentation": "

The OTA update ID.

" + } + }, "otaUpdateArn": { "target": "com.amazonaws.iot#OTAUpdateArn", "traits": { @@ -5370,12 +5555,6 @@ "traits": { "smithy.api#documentation": "

The OTA update status.

" } - }, - "awsIotJobArn": { - "target": "com.amazonaws.iot#AwsIotJobArn", - "traits": { - "smithy.api#documentation": "

The AWS IoT job ARN associated with the OTA update.

" - } } } }, @@ -5422,10 +5601,11 @@ "com.amazonaws.iot#CreatePolicyRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iot#TagList", + "policyDocument": { + "target": "com.amazonaws.iot#PolicyDocument", "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the policy.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " + "smithy.api#documentation": "

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of\n 2048, excluding whitespace.

", + "smithy.api#required": {} } }, "policyName": { @@ -5436,11 +5616,10 @@ "smithy.api#required": {} } }, - "policyDocument": { - "target": "com.amazonaws.iot#PolicyDocument", + "tags": { + "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of\n 2048, excluding whitespace.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Metadata which can be used to manage the policy.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " } } }, @@ -5451,6 +5630,12 @@ "com.amazonaws.iot#CreatePolicyResponse": { "type": "structure", "members": { + "policyVersionId": { + "target": "com.amazonaws.iot#PolicyVersionId", + "traits": { + "smithy.api#documentation": "

The policy version ID.

" + } + }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { @@ -5463,12 +5648,6 @@ "smithy.api#documentation": "

The policy name.

" } }, - "policyVersionId": { - "target": "com.amazonaws.iot#PolicyVersionId", - "traits": { - "smithy.api#documentation": "

The policy version ID.

" - } - }, "policyArn": { "target": "com.amazonaws.iot#PolicyArn", "traits": { @@ -5526,11 +5705,12 @@ "com.amazonaws.iot#CreatePolicyVersionRequest": { "type": "structure", "members": { - "setAsDefault": { - "target": "com.amazonaws.iot#SetAsDefault", + "policyName": { + "target": "com.amazonaws.iot#PolicyName", "traits": { - "smithy.api#documentation": "

Specifies whether the policy version is set as the default. When this parameter is\n true, the new policy version becomes the operative version (that is, the version that is in\n effect for the certificates to which the policy is attached).

", - "smithy.api#httpQuery": "setAsDefault" + "smithy.api#documentation": "

The policy name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "policyDocument": { @@ -5540,12 +5720,11 @@ "smithy.api#required": {} } }, - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "setAsDefault": { + "target": "com.amazonaws.iot#SetAsDefault", "traits": { - "smithy.api#documentation": "

The policy name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether the policy version is set as the default. When this parameter is\n true, the new policy version becomes the operative version (that is, the version that is in\n effect for the certificates to which the policy is attached).

", + "smithy.api#httpQuery": "setAsDefault" } } }, @@ -5638,12 +5817,6 @@ "com.amazonaws.iot#CreateProvisioningClaimResponse": { "type": "structure", "members": { - "certificatePem": { - "target": "com.amazonaws.iot#CertificatePem", - "traits": { - "smithy.api#documentation": "

The provisioning claim certificate.

" - } - }, "expiration": { "target": "com.amazonaws.iot#DateType", "traits": { @@ -5656,6 +5829,12 @@ "smithy.api#documentation": "

The ID of the certificate.

" } }, + "certificatePem": { + "target": "com.amazonaws.iot#CertificatePem", + "traits": { + "smithy.api#documentation": "

The provisioning claim certificate.

" + } + }, "keyPair": { "target": "com.amazonaws.iot#KeyPair", "traits": { @@ -5704,18 +5883,6 @@ "com.amazonaws.iot#CreateProvisioningTemplateRequest": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.iot#TemplateDescription", - "traits": { - "smithy.api#documentation": "

The description of the fleet provisioning template.

" - } - }, - "enabled": { - "target": "com.amazonaws.iot#Enabled", - "traits": { - "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" - } - }, "provisioningRoleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { @@ -5729,23 +5896,35 @@ "smithy.api#documentation": "

Metadata which can be used to manage the fleet provisioning template.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " } }, + "enabled": { + "target": "com.amazonaws.iot#Enabled", + "traits": { + "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" + } + }, + "templateBody": { + "target": "com.amazonaws.iot#TemplateBody", + "traits": { + "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

", + "smithy.api#required": {} + } + }, "preProvisioningHook": { "target": "com.amazonaws.iot#ProvisioningHook", "traits": { "smithy.api#documentation": "

Creates a pre-provisioning hook template.

" } }, - "templateName": { - "target": "com.amazonaws.iot#TemplateName", + "description": { + "target": "com.amazonaws.iot#TemplateDescription", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the fleet provisioning template.

" } }, - "templateBody": { - "target": "com.amazonaws.iot#TemplateBody", + "templateName": { + "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

", + "smithy.api#documentation": "

The name of the fleet provisioning template.

", "smithy.api#required": {} } } @@ -5754,10 +5933,10 @@ "com.amazonaws.iot#CreateProvisioningTemplateResponse": { "type": "structure", "members": { - "templateName": { - "target": "com.amazonaws.iot#TemplateName", + "templateArn": { + "target": "com.amazonaws.iot#TemplateArn", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

" + "smithy.api#documentation": "

The ARN that identifies the provisioning template.

" } }, "defaultVersionId": { @@ -5766,10 +5945,10 @@ "smithy.api#documentation": "

The default version of the fleet provisioning template.

" } }, - "templateArn": { - "target": "com.amazonaws.iot#TemplateArn", + "templateName": { + "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The ARN that identifies the provisioning template.

" + "smithy.api#documentation": "

The name of the fleet provisioning template.

" } } } @@ -5817,13 +5996,6 @@ "com.amazonaws.iot#CreateProvisioningTemplateVersionRequest": { "type": "structure", "members": { - "setAsDefault": { - "target": "com.amazonaws.iot#SetAsDefault", - "traits": { - "smithy.api#documentation": "

Sets a fleet provision template version as the default version.

", - "smithy.api#httpQuery": "setAsDefault" - } - }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { @@ -5838,18 +6010,19 @@ "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

", "smithy.api#required": {} } + }, + "setAsDefault": { + "target": "com.amazonaws.iot#SetAsDefault", + "traits": { + "smithy.api#documentation": "

Sets a fleet provision template version as the default version.

", + "smithy.api#httpQuery": "setAsDefault" + } } } }, "com.amazonaws.iot#CreateProvisioningTemplateVersionResponse": { "type": "structure", "members": { - "isDefaultVersion": { - "target": "com.amazonaws.iot#IsDefaultVersion", - "traits": { - "smithy.api#documentation": "

True if the fleet provisioning template version is the default version, otherwise\n false.

" - } - }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { @@ -5862,6 +6035,12 @@ "smithy.api#documentation": "

The version of the fleet provisioning template.

" } }, + "isDefaultVersion": { + "target": "com.amazonaws.iot#IsDefaultVersion", + "traits": { + "smithy.api#documentation": "

True if the fleet provisioning template version is the default version, otherwise\n false.

" + } + }, "templateArn": { "target": "com.amazonaws.iot#TemplateArn", "traits": { @@ -5913,11 +6092,10 @@ "com.amazonaws.iot#CreateRoleAliasRequest": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "tags": { + "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "

The role ARN.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Metadata which can be used to manage the role alias.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " } }, "credentialDurationSeconds": { @@ -5934,10 +6112,11 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.iot#TagList", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the role alias.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " + "smithy.api#documentation": "

The role ARN.

", + "smithy.api#required": {} } } } @@ -5996,12 +6175,25 @@ "com.amazonaws.iot#CreateScheduledAuditRequest": { "type": "structure", "members": { + "targetCheckNames": { + "target": "com.amazonaws.iot#TargetAuditCheckNames", + "traits": { + "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

", + "smithy.api#required": {} + } + }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place. Can be one of\n \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the\n \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".

" } }, + "dayOfMonth": { + "target": "com.amazonaws.iot#DayOfMonth", + "traits": { + "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. Can be \"1\" \n through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is\n set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many\n days, the audit takes place on the \"LAST\" day of the month.

" + } + }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { @@ -6015,12 +6207,6 @@ "smithy.api#required": {} } }, - "dayOfMonth": { - "target": "com.amazonaws.iot#DayOfMonth", - "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. Can be \"1\" \n through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is\n set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many\n days, the audit takes place on the \"LAST\" day of the month.

" - } - }, "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { @@ -6028,13 +6214,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "targetCheckNames": { - "target": "com.amazonaws.iot#TargetAuditCheckNames", - "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

", - "smithy.api#required": {} - } } } }, @@ -6083,10 +6262,12 @@ "com.amazonaws.iot#CreateSecurityProfileRequest": { "type": "structure", "members": { - "alertTargets": { - "target": "com.amazonaws.iot#AlertTargets", + "securityProfileName": { + "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

Specifies the destinations to which alerts are sent. (Alerts are always sent to the \n console.) Alerts are generated when a device (thing) violates a behavior.

" + "smithy.api#documentation": "

The name you are giving to the security profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "tags": { @@ -6101,15 +6282,7 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here.

\n

\n Note: This API field is deprecated. Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

" - } - }, - "securityProfileName": { - "target": "com.amazonaws.iot#SecurityProfileName", - "traits": { - "smithy.api#documentation": "

The name you are giving to the security profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here.

" } }, "securityProfileDescription": { @@ -6129,6 +6302,12 @@ "traits": { "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } + }, + "alertTargets": { + "target": "com.amazonaws.iot#AlertTargets", + "traits": { + "smithy.api#documentation": "

Specifies the destinations to which alerts are sent. (Alerts are always sent to the \n console.) Alerts are generated when a device (thing) violates a behavior.

" + } } } }, @@ -6195,30 +6374,24 @@ "com.amazonaws.iot#CreateStreamRequest": { "type": "structure", "members": { - "streamId": { - "target": "com.amazonaws.iot#StreamId", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The stream ID.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

An IAM role that allows the IoT service principal assumes to access your S3 files.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.iot#StreamDescription", - "traits": { - "smithy.api#documentation": "

A description of the stream.

" - } - }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage streams.

" } }, - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "streamId": { + "target": "com.amazonaws.iot#StreamId", "traits": { - "smithy.api#documentation": "

An IAM role that allows the IoT service principal assumes to access your S3 files.

", + "smithy.api#documentation": "

The stream ID.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -6228,24 +6401,18 @@ "smithy.api#documentation": "

The files to stream.

", "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.iot#StreamDescription", + "traits": { + "smithy.api#documentation": "

A description of the stream.

" + } } } }, "com.amazonaws.iot#CreateStreamResponse": { "type": "structure", "members": { - "streamArn": { - "target": "com.amazonaws.iot#StreamArn", - "traits": { - "smithy.api#documentation": "

The stream ARN.

" - } - }, - "streamId": { - "target": "com.amazonaws.iot#StreamId", - "traits": { - "smithy.api#documentation": "

The stream ID.

" - } - }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { @@ -6257,6 +6424,18 @@ "traits": { "smithy.api#documentation": "

The version of the stream.

" } + }, + "streamArn": { + "target": "com.amazonaws.iot#StreamArn", + "traits": { + "smithy.api#documentation": "

The stream ARN.

" + } + }, + "streamId": { + "target": "com.amazonaws.iot#StreamId", + "traits": { + "smithy.api#documentation": "

The stream ID.

" + } } } }, @@ -6334,18 +6513,18 @@ "com.amazonaws.iot#CreateThingGroupRequest": { "type": "structure", "members": { - "parentGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", - "traits": { - "smithy.api#documentation": "

The name of the parent thing group.

" - } - }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the thing group.

" } }, + "parentGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", + "traits": { + "smithy.api#documentation": "

The name of the parent thing group.

" + } + }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { @@ -6365,10 +6544,10 @@ "com.amazonaws.iot#CreateThingGroupResponse": { "type": "structure", "members": { - "thingGroupId": { - "target": "com.amazonaws.iot#ThingGroupId", + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", "traits": { - "smithy.api#documentation": "

The thing group ID.

" + "smithy.api#documentation": "

The thing group name.

" } }, "thingGroupArn": { @@ -6377,10 +6556,10 @@ "smithy.api#documentation": "

The thing group ARN.

" } }, - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", + "thingGroupId": { + "target": "com.amazonaws.iot#ThingGroupId", "traits": { - "smithy.api#documentation": "

The thing group name.

" + "smithy.api#documentation": "

The thing group ID.

" } } } @@ -6422,18 +6601,18 @@ "com.amazonaws.iot#CreateThingResponse": { "type": "structure", "members": { - "thingArn": { - "target": "com.amazonaws.iot#ThingArn", - "traits": { - "smithy.api#documentation": "

The ARN of the new thing.

" - } - }, "thingId": { "target": "com.amazonaws.iot#ThingId", "traits": { "smithy.api#documentation": "

The thing ID.

" } }, + "thingArn": { + "target": "com.amazonaws.iot#ThingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the new thing.

" + } + }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { @@ -6485,12 +6664,6 @@ "com.amazonaws.iot#CreateThingTypeRequest": { "type": "structure", "members": { - "thingTypeProperties": { - "target": "com.amazonaws.iot#ThingTypeProperties", - "traits": { - "smithy.api#documentation": "

The ThingTypeProperties for the thing type to create. It contains information about\n\t\t\tthe new thing type including a description, and a list of searchable thing attribute\n\t\t\tnames.

" - } - }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { @@ -6499,6 +6672,12 @@ "smithy.api#required": {} } }, + "thingTypeProperties": { + "target": "com.amazonaws.iot#ThingTypeProperties", + "traits": { + "smithy.api#documentation": "

The ThingTypeProperties for the thing type to create. It contains information about\n\t\t\tthe new thing type including a description, and a list of searchable thing attribute\n\t\t\tnames.

" + } + }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { @@ -6513,12 +6692,6 @@ "com.amazonaws.iot#CreateThingTypeResponse": { "type": "structure", "members": { - "thingTypeId": { - "target": "com.amazonaws.iot#ThingTypeId", - "traits": { - "smithy.api#documentation": "

The thing type ID.

" - } - }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { @@ -6530,6 +6703,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the thing type.

" } + }, + "thingTypeId": { + "target": "com.amazonaws.iot#ThingTypeId", + "traits": { + "smithy.api#documentation": "

The thing type ID.

" + } } }, "traits": { @@ -6630,6 +6809,13 @@ "com.amazonaws.iot#CreateTopicRuleRequest": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.iot#String", + "traits": { + "smithy.api#documentation": "

Metadata which can be used to manage the topic rule.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: --tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n ", + "smithy.api#httpHeader": "x-amz-tagging" + } + }, "topicRulePayload": { "target": "com.amazonaws.iot#TopicRulePayload", "traits": { @@ -6645,13 +6831,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.iot#String", - "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the topic rule.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: --tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n ", - "smithy.api#httpHeader": "x-amz-tagging" - } } }, "traits": { @@ -6677,10 +6856,10 @@ "com.amazonaws.iot#CustomCodeSigning": { "type": "structure", "members": { - "signatureAlgorithm": { - "target": "com.amazonaws.iot#SignatureAlgorithm", + "signature": { + "target": "com.amazonaws.iot#CodeSigningSignature", "traits": { - "smithy.api#documentation": "

The signature algorithm used to code sign the file.

" + "smithy.api#documentation": "

The signature for the file.

" } }, "certificateChain": { @@ -6695,10 +6874,10 @@ "smithy.api#documentation": "

The hash algorithm used to code sign the file.

" } }, - "signature": { - "target": "com.amazonaws.iot#CodeSigningSignature", + "signatureAlgorithm": { + "target": "com.amazonaws.iot#SignatureAlgorithm", "traits": { - "smithy.api#documentation": "

The signature for the file.

" + "smithy.api#documentation": "

The signature algorithm used to code sign the file.

" } } }, @@ -6812,6 +6991,55 @@ "com.amazonaws.iot#DeleteAlertTargets": { "type": "boolean" }, + "com.amazonaws.iot#DeleteAuditSuppression": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#DeleteAuditSuppressionRequest" + }, + "output": { + "target": "com.amazonaws.iot#DeleteAuditSuppressionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes a Device Defender audit suppression.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/audit/suppressions/delete", + "code": 200 + } + } + }, + "com.amazonaws.iot#DeleteAuditSuppressionRequest": { + "type": "structure", + "members": { + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName", + "traits": { + "smithy.api#required": {} + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iot#DeleteAuditSuppressionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iot#DeleteAuthorizer": { "type": "operation", "input": { @@ -7202,13 +7430,6 @@ "com.amazonaws.iot#DeleteDynamicThingGroupRequest": { "type": "structure", "members": { - "expectedVersion": { - "target": "com.amazonaws.iot#OptionalVersion", - "traits": { - "smithy.api#documentation": "

The expected version of the dynamic thing group to delete.

", - "smithy.api#httpQuery": "expectedVersion" - } - }, "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { @@ -7216,6 +7437,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "expectedVersion": { + "target": "com.amazonaws.iot#OptionalVersion", + "traits": { + "smithy.api#documentation": "

The expected version of the dynamic thing group to delete.

", + "smithy.api#httpQuery": "expectedVersion" + } } } }, @@ -7299,13 +7527,6 @@ "smithy.api#required": {} } }, - "force": { - "target": "com.amazonaws.iot#ForceFlag", - "traits": { - "smithy.api#documentation": "

(Optional) When true, you can delete a job execution which is \"IN_PROGRESS\". Otherwise, \n you can only delete a job execution which is in a terminal state (\"SUCCEEDED\", \"FAILED\",\n \"REJECTED\", \"REMOVED\" or \"CANCELED\") or an exception will occur. The default is false.

\n \n

Deleting a job execution which is \"IN_PROGRESS\", will cause the device \n to be unable to access job information or update the job execution status.\n Use caution and ensure that the device is able to recover to a valid state.

\n ", - "smithy.api#httpQuery": "force" - } - }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { @@ -7314,6 +7535,13 @@ "smithy.api#required": {} } }, + "force": { + "target": "com.amazonaws.iot#ForceFlag", + "traits": { + "smithy.api#documentation": "

(Optional) When true, you can delete a job execution which is \"IN_PROGRESS\". Otherwise, \n you can only delete a job execution which is in a terminal state (\"SUCCEEDED\", \"FAILED\",\n \"REJECTED\", \"REMOVED\" or \"CANCELED\") or an exception will occur. The default is false.

\n \n

Deleting a job execution which is \"IN_PROGRESS\", will cause the device \n to be unable to access job information or update the job execution status.\n Use caution and ensure that the device is able to recover to a valid state.

\n ", + "smithy.api#httpQuery": "force" + } + }, "executionNumber": { "target": "com.amazonaws.iot#ExecutionNumber", "traits": { @@ -7327,13 +7555,6 @@ "com.amazonaws.iot#DeleteJobRequest": { "type": "structure", "members": { - "force": { - "target": "com.amazonaws.iot#ForceFlag", - "traits": { - "smithy.api#documentation": "

(Optional) When true, you can delete a job which is \"IN_PROGRESS\". Otherwise, you can\n only delete a job which is in a terminal state (\"COMPLETED\" or \"CANCELED\") or an exception \n will occur. The default is false.

\n \n

Deleting a job which is \"IN_PROGRESS\", will cause a device which is executing \n the job to be unable to access job information or update the job execution status.\n Use caution and ensure that each device executing a job which is deleted is able to recover to \n a valid state.

\n ", - "smithy.api#httpQuery": "force" - } - }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { @@ -7341,6 +7562,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "force": { + "target": "com.amazonaws.iot#ForceFlag", + "traits": { + "smithy.api#documentation": "

(Optional) When true, you can delete a job which is \"IN_PROGRESS\". Otherwise, you can\n only delete a job which is in a terminal state (\"COMPLETED\" or \"CANCELED\") or an exception \n will occur. The default is false.

\n \n

Deleting a job which is \"IN_PROGRESS\", will cause a device which is executing \n the job to be unable to access job information or update the job execution status.\n Use caution and ensure that each device executing a job which is deleted is able to recover to \n a valid state.

\n ", + "smithy.api#httpQuery": "force" + } } } }, @@ -7432,11 +7660,12 @@ "com.amazonaws.iot#DeleteOTAUpdateRequest": { "type": "structure", "members": { - "deleteStream": { - "target": "com.amazonaws.iot#Boolean", + "otaUpdateId": { + "target": "com.amazonaws.iot#OTAUpdateId", "traits": { - "smithy.api#documentation": "

Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.

", - "smithy.api#httpQuery": "deleteStream" + "smithy.api#documentation": "

The ID of the OTA update to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "forceDeleteAWSJob": { @@ -7446,12 +7675,11 @@ "smithy.api#httpQuery": "forceDeleteAWSJob" } }, - "otaUpdateId": { - "target": "com.amazonaws.iot#OTAUpdateId", + "deleteStream": { + "target": "com.amazonaws.iot#DeleteStream_", "traits": { - "smithy.api#documentation": "

The ID of the OTA update to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.

", + "smithy.api#httpQuery": "deleteStream" } } } @@ -7553,18 +7781,18 @@ "com.amazonaws.iot#DeletePolicyVersionRequest": { "type": "structure", "members": { - "policyVersionId": { - "target": "com.amazonaws.iot#PolicyVersionId", + "policyName": { + "target": "com.amazonaws.iot#PolicyName", "traits": { - "smithy.api#documentation": "

The policy version ID.

", + "smithy.api#documentation": "

The name of the policy.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "policyVersionId": { + "target": "com.amazonaws.iot#PolicyVersionId", "traits": { - "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#documentation": "

The policy version ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7583,6 +7811,9 @@ "target": "com.amazonaws.iot#DeleteProvisioningTemplateResponse" }, "errors": [ + { + "target": "com.amazonaws.iot#ConflictingResourceUpdateException" + }, { "target": "com.amazonaws.iot#DeleteConflictException" }, @@ -7637,6 +7868,9 @@ "target": "com.amazonaws.iot#DeleteProvisioningTemplateVersionResponse" }, "errors": [ + { + "target": "com.amazonaws.iot#ConflictingResourceUpdateException" + }, { "target": "com.amazonaws.iot#DeleteConflictException" }, @@ -7880,20 +8114,20 @@ "com.amazonaws.iot#DeleteSecurityProfileRequest": { "type": "structure", "members": { - "expectedVersion": { - "target": "com.amazonaws.iot#OptionalVersion", - "traits": { - "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", - "smithy.api#httpQuery": "expectedVersion" - } - }, - "securityProfileName": { - "target": "com.amazonaws.iot#SecurityProfileName", + "securityProfileName": { + "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the security profile to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "expectedVersion": { + "target": "com.amazonaws.iot#OptionalVersion", + "traits": { + "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", + "smithy.api#httpQuery": "expectedVersion" + } } } }, @@ -7958,6 +8192,9 @@ "type": "structure", "members": {} }, + "com.amazonaws.iot#DeleteStream_": { + "type": "boolean" + }, "com.amazonaws.iot#DeleteThing": { "type": "operation", "input": { @@ -8269,14 +8506,6 @@ "com.amazonaws.iot#DeleteV2LoggingLevelRequest": { "type": "structure", "members": { - "targetType": { - "target": "com.amazonaws.iot#LogTargetType", - "traits": { - "smithy.api#documentation": "

The type of resource for which you are configuring logging. Must be\n THING_Group.

", - "smithy.api#httpQuery": "targetType", - "smithy.api#required": {} - } - }, "targetName": { "target": "com.amazonaws.iot#LogTargetName", "traits": { @@ -8284,6 +8513,14 @@ "smithy.api#httpQuery": "targetName", "smithy.api#required": {} } + }, + "targetType": { + "target": "com.amazonaws.iot#LogTargetType", + "traits": { + "smithy.api#documentation": "

The type of resource for which you are configuring logging. Must be\n THING_Group.

", + "smithy.api#httpQuery": "targetType", + "smithy.api#required": {} + } } } }, @@ -8530,10 +8767,10 @@ "com.amazonaws.iot#DescribeAuditMitigationActionsTaskResponse": { "type": "structure", "members": { - "auditCheckToActionsMapping": { - "target": "com.amazonaws.iot#AuditCheckToActionsMapping", + "taskStatistics": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatistics", "traits": { - "smithy.api#documentation": "

Specifies the mitigation actions that should be applied to specific audit checks.

" + "smithy.api#documentation": "

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

" } }, "endTime": { @@ -8542,16 +8779,28 @@ "smithy.api#documentation": "

The date and time when the task was completed or canceled.

" } }, + "startTime": { + "target": "com.amazonaws.iot#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the task was started.

" + } + }, + "actionsDefinition": { + "target": "com.amazonaws.iot#MitigationActionList", + "traits": { + "smithy.api#documentation": "

Specifies the mitigation actions and their parameters that are applied as part of this task.

" + } + }, "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { "smithy.api#documentation": "

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

" } }, - "taskStatistics": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatistics", + "auditCheckToActionsMapping": { + "target": "com.amazonaws.iot#AuditCheckToActionsMapping", "traits": { - "smithy.api#documentation": "

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

" + "smithy.api#documentation": "

Specifies the mitigation actions that should be applied to specific audit checks.

" } }, "taskStatus": { @@ -8559,18 +8808,83 @@ "traits": { "smithy.api#documentation": "

The current status of the task.

" } + } + } + }, + "com.amazonaws.iot#DescribeAuditSuppression": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#DescribeAuditSuppressionRequest" + }, + "output": { + "target": "com.amazonaws.iot#DescribeAuditSuppressionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Gets information about a Device Defender audit suppression.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/audit/suppressions/describe", + "code": 200 + } + } + }, + "com.amazonaws.iot#DescribeAuditSuppressionRequest": { + "type": "structure", + "members": { + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier", + "traits": { + "smithy.api#required": {} + } }, - "actionsDefinition": { - "target": "com.amazonaws.iot#MitigationActionList", + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName", "traits": { - "smithy.api#documentation": "

Specifies the mitigation actions and their parameters that are applied as part of this task.

" + "smithy.api#required": {} } + } + } + }, + "com.amazonaws.iot#DescribeAuditSuppressionResponse": { + "type": "structure", + "members": { + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier" }, - "startTime": { + "description": { + "target": "com.amazonaws.iot#AuditDescription", + "traits": { + "smithy.api#documentation": "

\n The description of the audit suppression.\n

" + } + }, + "suppressIndefinitely": { + "target": "com.amazonaws.iot#SuppressIndefinitely", + "traits": { + "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" + } + }, + "expirationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the task was started.

" + "smithy.api#documentation": "

\n The epoch timestamp in seconds at which this suppression expires.\n

" } + }, + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName" } } }, @@ -8621,22 +8935,10 @@ "com.amazonaws.iot#DescribeAuditTaskResponse": { "type": "structure", "members": { - "auditDetails": { - "target": "com.amazonaws.iot#AuditDetails", - "traits": { - "smithy.api#documentation": "

Detailed information about each check performed during this audit.

" - } - }, - "taskStatus": { - "target": "com.amazonaws.iot#AuditTaskStatus", - "traits": { - "smithy.api#documentation": "

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" - } - }, - "scheduledAuditName": { - "target": "com.amazonaws.iot#ScheduledAuditName", + "taskStartTime": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the scheduled audit (only if the audit was a scheduled audit).

" + "smithy.api#documentation": "

The time the audit started.

" } }, "taskType": { @@ -8651,10 +8953,22 @@ "smithy.api#documentation": "

Statistical information about the audit.

" } }, - "taskStartTime": { - "target": "com.amazonaws.iot#Timestamp", + "taskStatus": { + "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "

The time the audit started.

" + "smithy.api#documentation": "

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" + } + }, + "scheduledAuditName": { + "target": "com.amazonaws.iot#ScheduledAuditName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled audit (only if the audit was a scheduled audit).

" + } + }, + "auditDetails": { + "target": "com.amazonaws.iot#AuditDetails", + "traits": { + "smithy.api#documentation": "

Detailed information about each check performed during this audit.

" } } } @@ -8767,10 +9081,10 @@ "com.amazonaws.iot#DescribeBillingGroupResponse": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.iot#Version", + "billingGroupArn": { + "target": "com.amazonaws.iot#BillingGroupArn", "traits": { - "smithy.api#documentation": "

The version of the billing group.

" + "smithy.api#documentation": "

The ARN of the billing group.

" } }, "billingGroupProperties": { @@ -8797,10 +9111,10 @@ "smithy.api#documentation": "

The name of the billing group.

" } }, - "billingGroupArn": { - "target": "com.amazonaws.iot#BillingGroupArn", + "version": { + "target": "com.amazonaws.iot#Version", "traits": { - "smithy.api#documentation": "

The ARN of the billing group.

" + "smithy.api#documentation": "

The version of the billing group.

" } } } @@ -8861,17 +9175,17 @@ "com.amazonaws.iot#DescribeCACertificateResponse": { "type": "structure", "members": { - "registrationConfig": { - "target": "com.amazonaws.iot#RegistrationConfig", - "traits": { - "smithy.api#documentation": "

Information about the registration configuration.

" - } - }, "certificateDescription": { "target": "com.amazonaws.iot#CACertificateDescription", "traits": { "smithy.api#documentation": "

The CA certificate description.

" } + }, + "registrationConfig": { + "target": "com.amazonaws.iot#RegistrationConfig", + "traits": { + "smithy.api#documentation": "

Information about the registration configuration.

" + } } }, "traits": { @@ -9044,16 +9358,10 @@ "com.amazonaws.iot#DescribeDimensionResponse": { "type": "structure", "members": { - "lastModifiedDate": { - "target": "com.amazonaws.iot#Timestamp", - "traits": { - "smithy.api#documentation": "

The date the dimension was last modified.

" - } - }, - "type": { - "target": "com.amazonaws.iot#DimensionType", + "stringValues": { + "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

The type of the dimension.

" + "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" } }, "name": { @@ -9062,6 +9370,12 @@ "smithy.api#documentation": "

The unique identifier for the dimension.

" } }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the dimension was last modified.

" + } + }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { @@ -9074,10 +9388,10 @@ "smithy.api#documentation": "

The ARN (Amazon resource name) for the dimension.

" } }, - "stringValues": { - "target": "com.amazonaws.iot#DimensionStringValues", + "type": { + "target": "com.amazonaws.iot#DimensionType", "traits": { - "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" + "smithy.api#documentation": "

The type of the dimension.

" } } } @@ -9135,16 +9449,28 @@ "com.amazonaws.iot#DescribeDomainConfigurationResponse": { "type": "structure", "members": { + "domainConfigurationArn": { + "target": "com.amazonaws.iot#DomainConfigurationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the domain configuration.

" + } + }, "authorizerConfig": { "target": "com.amazonaws.iot#AuthorizerConfig", "traits": { "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" } }, - "domainName": { - "target": "com.amazonaws.iot#DomainName", + "serviceType": { + "target": "com.amazonaws.iot#ServiceType", "traits": { - "smithy.api#documentation": "

The name of the domain.

" + "smithy.api#documentation": "

The type of service delivered by the endpoint.

" + } + }, + "lastStatusChangeDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date and time the domain configuration's status was last changed.

" } }, "domainConfigurationStatus": { @@ -9159,10 +9485,10 @@ "smithy.api#documentation": "

A list containing summary information about the server certificate included in the domain configuration.

" } }, - "domainConfigurationArn": { - "target": "com.amazonaws.iot#DomainConfigurationArn", + "domainConfigurationName": { + "target": "com.amazonaws.iot#ReservedDomainConfigurationName", "traits": { - "smithy.api#documentation": "

The ARN of the domain configuration.

" + "smithy.api#documentation": "

The name of the domain configuration.

" } }, "domainType": { @@ -9171,16 +9497,10 @@ "smithy.api#documentation": "

The type of the domain.

" } }, - "serviceType": { - "target": "com.amazonaws.iot#ServiceType", - "traits": { - "smithy.api#documentation": "

The type of service delivered by the endpoint.

" - } - }, - "domainConfigurationName": { - "target": "com.amazonaws.iot#ReservedDomainConfigurationName", + "domainName": { + "target": "com.amazonaws.iot#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain configuration.

" + "smithy.api#documentation": "

The name of the domain.

" } } } @@ -9277,12 +9597,6 @@ "com.amazonaws.iot#DescribeEventConfigurationsResponse": { "type": "structure", "members": { - "lastModifiedDate": { - "target": "com.amazonaws.iot#LastModifiedDate", - "traits": { - "smithy.api#documentation": "

The date the event configurations were last modified.

" - } - }, "eventConfigurations": { "target": "com.amazonaws.iot#EventConfigurations", "traits": { @@ -9294,6 +9608,12 @@ "traits": { "smithy.api#documentation": "

The creation date of the event configuration.

" } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#LastModifiedDate", + "traits": { + "smithy.api#documentation": "

The date the event configurations were last modified.

" + } } } }, @@ -9350,18 +9670,18 @@ "com.amazonaws.iot#DescribeIndexResponse": { "type": "structure", "members": { - "indexStatus": { - "target": "com.amazonaws.iot#IndexStatus", - "traits": { - "smithy.api#documentation": "

The index status.

" - } - }, "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The index name.

" } }, + "indexStatus": { + "target": "com.amazonaws.iot#IndexStatus", + "traits": { + "smithy.api#documentation": "

The index status.

" + } + }, "schema": { "target": "com.amazonaws.iot#IndexSchema", "traits": { @@ -9435,14 +9755,6 @@ "com.amazonaws.iot#DescribeJobExecutionRequest": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.iot#JobId", - "traits": { - "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { @@ -9457,6 +9769,14 @@ "smithy.api#documentation": "

A string (consisting of the digits \"0\" through \"9\" which is used to specify a particular job execution\n on a particular device.

", "smithy.api#httpQuery": "executionNumber" } + }, + "jobId": { + "target": "com.amazonaws.iot#JobId", + "traits": { + "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -9548,52 +9868,52 @@ "com.amazonaws.iot#DescribeMitigationActionResponse": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "actionName": { + "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role used to apply this action.

" + "smithy.api#documentation": "

The friendly name that uniquely identifies the mitigation action.

" } }, - "actionArn": { - "target": "com.amazonaws.iot#MitigationActionArn", + "actionType": { + "target": "com.amazonaws.iot#MitigationActionType", "traits": { - "smithy.api#documentation": "

The ARN that identifies this migration action.

" + "smithy.api#documentation": "

The type of mitigation action.

" } }, - "lastModifiedDate": { + "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the mitigation action was last changed.

" + "smithy.api#documentation": "

The date and time when the mitigation action was added to your AWS account.

" } }, - "actionParams": { - "target": "com.amazonaws.iot#MitigationActionParams", + "actionId": { + "target": "com.amazonaws.iot#MitigationActionId", "traits": { - "smithy.api#documentation": "

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

" + "smithy.api#documentation": "

A unique identifier for this action.

" } }, - "actionName": { - "target": "com.amazonaws.iot#MitigationActionName", + "actionArn": { + "target": "com.amazonaws.iot#MitigationActionArn", "traits": { - "smithy.api#documentation": "

The friendly name that uniquely identifies the mitigation action.

" + "smithy.api#documentation": "

The ARN that identifies this migration action.

" } }, - "actionType": { - "target": "com.amazonaws.iot#MitigationActionType", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The type of mitigation action.

" + "smithy.api#documentation": "

The ARN of the IAM role used to apply this action.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#Timestamp", + "actionParams": { + "target": "com.amazonaws.iot#MitigationActionParams", "traits": { - "smithy.api#documentation": "

The date and time when the mitigation action was added to your AWS account.

" + "smithy.api#documentation": "

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

" } }, - "actionId": { - "target": "com.amazonaws.iot#MitigationActionId", + "lastModifiedDate": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A unique identifier for this action.

" + "smithy.api#documentation": "

The date and time when the mitigation action was last changed.

" } } } @@ -9648,22 +9968,22 @@ "com.amazonaws.iot#DescribeProvisioningTemplateResponse": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.iot#TemplateDescription", + "enabled": { + "target": "com.amazonaws.iot#Enabled", "traits": { - "smithy.api#documentation": "

The description of the fleet provisioning template.

" + "smithy.api#documentation": "

True if the fleet provisioning template is enabled, otherwise false.

" } }, - "lastModifiedDate": { - "target": "com.amazonaws.iot#DateType", + "provisioningRoleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template was last modified.

" + "smithy.api#documentation": "

The ARN of the role associated with the provisioning template. This IoT role grants\n permission to provision a device.

" } }, - "templateArn": { - "target": "com.amazonaws.iot#TemplateArn", + "templateBody": { + "target": "com.amazonaws.iot#TemplateBody", "traits": { - "smithy.api#documentation": "

The ARN of the fleet provisioning template.

" + "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

" } }, "creationDate": { @@ -9672,22 +9992,16 @@ "smithy.api#documentation": "

The date when the fleet provisioning template was created.

" } }, - "provisioningRoleArn": { - "target": "com.amazonaws.iot#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of the role associated with the provisioning template. This IoT role grants\n permission to provision a device.

" - } - }, - "enabled": { - "target": "com.amazonaws.iot#Enabled", + "templateArn": { + "target": "com.amazonaws.iot#TemplateArn", "traits": { - "smithy.api#documentation": "

True if the fleet provisioning template is enabled, otherwise false.

" + "smithy.api#documentation": "

The ARN of the fleet provisioning template.

" } }, - "templateName": { - "target": "com.amazonaws.iot#TemplateName", + "defaultVersionId": { + "target": "com.amazonaws.iot#TemplateVersionId", "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

" + "smithy.api#documentation": "

The default fleet template version ID.

" } }, "preProvisioningHook": { @@ -9696,16 +10010,22 @@ "smithy.api#documentation": "

Gets information about a pre-provisioned hook.

" } }, - "templateBody": { - "target": "com.amazonaws.iot#TemplateBody", + "description": { + "target": "com.amazonaws.iot#TemplateDescription", "traits": { - "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

" + "smithy.api#documentation": "

The description of the fleet provisioning template.

" } }, - "defaultVersionId": { - "target": "com.amazonaws.iot#TemplateVersionId", + "templateName": { + "target": "com.amazonaws.iot#TemplateName", "traits": { - "smithy.api#documentation": "

The default fleet template version ID.

" + "smithy.api#documentation": "

The name of the fleet provisioning template.

" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date when the fleet provisioning template was last modified.

" } } } @@ -9768,18 +10088,6 @@ "com.amazonaws.iot#DescribeProvisioningTemplateVersionResponse": { "type": "structure", "members": { - "templateBody": { - "target": "com.amazonaws.iot#TemplateBody", - "traits": { - "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template version.

" - } - }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template version was created.

" - } - }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { @@ -9791,6 +10099,18 @@ "traits": { "smithy.api#documentation": "

The fleet provisioning template version ID.

" } + }, + "templateBody": { + "target": "com.amazonaws.iot#TemplateBody", + "traits": { + "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template version.

" + } + }, + "creationDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date when the fleet provisioning template version was created.

" + } } } }, @@ -9902,40 +10222,40 @@ "com.amazonaws.iot#DescribeScheduledAuditResponse": { "type": "structure", "members": { - "frequency": { - "target": "com.amazonaws.iot#AuditFrequency", - "traits": { - "smithy.api#documentation": "

How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\",\n \"BIWEEKLY\", or \"MONTHLY\". The start time of each audit is determined by\n the system.

" - } - }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place. One of\n \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\".

" } }, - "scheduledAuditArn": { - "target": "com.amazonaws.iot#ScheduledAuditArn", - "traits": { - "smithy.api#documentation": "

The ARN of the scheduled audit.

" - } - }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. Will be \"1\" \n through \"31\" or \"LAST\". If days 29-31 are specified, and the month does not have that many\n days, the audit takes place on the \"LAST\" day of the month.

" } }, + "targetCheckNames": { + "target": "com.amazonaws.iot#TargetAuditCheckNames", + "traits": { + "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be \n enabled for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" + } + }, "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name of the scheduled audit.

" } }, - "targetCheckNames": { - "target": "com.amazonaws.iot#TargetAuditCheckNames", + "frequency": { + "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be \n enabled for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" + "smithy.api#documentation": "

How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\",\n \"BIWEEKLY\", or \"MONTHLY\". The start time of each audit is determined by\n the system.

" + } + }, + "scheduledAuditArn": { + "target": "com.amazonaws.iot#ScheduledAuditArn", + "traits": { + "smithy.api#documentation": "

The ARN of the scheduled audit.

" } } } @@ -9987,31 +10307,10 @@ "com.amazonaws.iot#DescribeSecurityProfileResponse": { "type": "structure", "members": { - "securityProfileName": { - "target": "com.amazonaws.iot#SecurityProfileName", - "traits": { - "smithy.api#documentation": "

The name of the security profile.

" - } - }, - "additionalMetricsToRetain": { - "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", - "traits": { - "smithy.api#deprecated": { - "message": "Use additionalMetricsToRetainV2." - }, - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here.

\n

\n Note: This API field is deprecated. Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.

" - } - }, - "securityProfileDescription": { - "target": "com.amazonaws.iot#SecurityProfileDescription", - "traits": { - "smithy.api#documentation": "

A description of the security profile (associated with the security profile\n when it was created or updated).

" - } - }, - "version": { - "target": "com.amazonaws.iot#Version", + "additionalMetricsToRetainV2": { + "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

The version of the security profile. A new version is generated whenever the\n security profile is updated.

" + "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

" } }, "creationDate": { @@ -10026,16 +10325,31 @@ "smithy.api#documentation": "

Where the alerts are sent. (Alerts are always sent to the console.)

" } }, + "additionalMetricsToRetain": { + "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", + "traits": { + "smithy.api#deprecated": { + "message": "Use additionalMetricsToRetainV2." + }, + "smithy.api#documentation": "

\n Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here.

" + } + }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, - "additionalMetricsToRetainV2": { - "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", + "securityProfileName": { + "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

" + "smithy.api#documentation": "

The name of the security profile.

" + } + }, + "securityProfileDescription": { + "target": "com.amazonaws.iot#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

A description of the security profile (associated with the security profile\n when it was created or updated).

" } }, "lastModifiedDate": { @@ -10044,6 +10358,12 @@ "smithy.api#documentation": "

The time the security profile was last modified.

" } }, + "version": { + "target": "com.amazonaws.iot#Version", + "traits": { + "smithy.api#documentation": "

The version of the security profile. A new version is generated whenever the\n security profile is updated.

" + } + }, "securityProfileArn": { "target": "com.amazonaws.iot#SecurityProfileArn", "traits": { @@ -10197,22 +10517,28 @@ "com.amazonaws.iot#DescribeThingGroupResponse": { "type": "structure", "members": { - "queryVersion": { - "target": "com.amazonaws.iot#QueryVersion", + "thingGroupProperties": { + "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { - "smithy.api#documentation": "

The dynamic thing group query version.

" + "smithy.api#documentation": "

The thing group properties.

" } }, - "thingGroupId": { - "target": "com.amazonaws.iot#ThingGroupId", + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", "traits": { - "smithy.api#documentation": "

The thing group ID.

" + "smithy.api#documentation": "

The name of the thing group.

" } }, - "indexName": { - "target": "com.amazonaws.iot#IndexName", + "queryString": { + "target": "com.amazonaws.iot#QueryString", "traits": { - "smithy.api#documentation": "

The dynamic thing group index name.

" + "smithy.api#documentation": "

The dynamic thing group search query string.

" + } + }, + "status": { + "target": "com.amazonaws.iot#DynamicGroupStatus", + "traits": { + "smithy.api#documentation": "

The dynamic thing group status.

" } }, "thingGroupArn": { @@ -10221,40 +10547,34 @@ "smithy.api#documentation": "

The thing group ARN.

" } }, - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", + "queryVersion": { + "target": "com.amazonaws.iot#QueryVersion", "traits": { - "smithy.api#documentation": "

The name of the thing group.

" + "smithy.api#documentation": "

The dynamic thing group query version.

" } }, - "thingGroupMetadata": { - "target": "com.amazonaws.iot#ThingGroupMetadata", + "version": { + "target": "com.amazonaws.iot#Version", "traits": { - "smithy.api#documentation": "

Thing group metadata.

" - } - }, - "thingGroupProperties": { - "target": "com.amazonaws.iot#ThingGroupProperties", - "traits": { - "smithy.api#documentation": "

The thing group properties.

" + "smithy.api#documentation": "

The version of the thing group.

" } }, - "status": { - "target": "com.amazonaws.iot#DynamicGroupStatus", + "indexName": { + "target": "com.amazonaws.iot#IndexName", "traits": { - "smithy.api#documentation": "

The dynamic thing group status.

" + "smithy.api#documentation": "

The dynamic thing group index name.

" } }, - "queryString": { - "target": "com.amazonaws.iot#QueryString", + "thingGroupMetadata": { + "target": "com.amazonaws.iot#ThingGroupMetadata", "traits": { - "smithy.api#documentation": "

The dynamic thing group search query string.

" + "smithy.api#documentation": "

Thing group metadata.

" } }, - "version": { - "target": "com.amazonaws.iot#Version", + "thingGroupId": { + "target": "com.amazonaws.iot#ThingGroupId", "traits": { - "smithy.api#documentation": "

The version of the thing group.

" + "smithy.api#documentation": "

The thing group ID.

" } } } @@ -10309,16 +10629,22 @@ "com.amazonaws.iot#DescribeThingRegistrationTaskResponse": { "type": "structure", "members": { - "inputFileKey": { - "target": "com.amazonaws.iot#RegistryS3KeyName", + "percentageProgress": { + "target": "com.amazonaws.iot#Percentage", "traits": { - "smithy.api#documentation": "

The input file key.

" + "smithy.api#documentation": "

The progress of the bulk provisioning task expressed as a percentage.

" } }, - "lastModifiedDate": { - "target": "com.amazonaws.iot#LastModifiedDate", + "taskId": { + "target": "com.amazonaws.iot#TaskId", "traits": { - "smithy.api#documentation": "

The date when the task was last modified.

" + "smithy.api#documentation": "

The task ID.

" + } + }, + "templateBody": { + "target": "com.amazonaws.iot#TemplateBody", + "traits": { + "smithy.api#documentation": "

The task's template.

" } }, "status": { @@ -10327,10 +10653,16 @@ "smithy.api#documentation": "

The status of the bulk thing provisioning task.

" } }, - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "message": { + "target": "com.amazonaws.iot#ErrorMessage", "traits": { - "smithy.api#documentation": "

The role ARN that grants access to the input file bucket.

" + "smithy.api#documentation": "

The message.

" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#LastModifiedDate", + "traits": { + "smithy.api#documentation": "

The date when the task was last modified.

" } }, "successCount": { @@ -10345,34 +10677,16 @@ "smithy.api#documentation": "

The S3 bucket that contains the input file.

" } }, - "templateBody": { - "target": "com.amazonaws.iot#TemplateBody", - "traits": { - "smithy.api#documentation": "

The task's template.

" - } - }, - "message": { - "target": "com.amazonaws.iot#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The message.

" - } - }, "failureCount": { "target": "com.amazonaws.iot#Count", "traits": { "smithy.api#documentation": "

The number of things that failed to be provisioned.

" } }, - "percentageProgress": { - "target": "com.amazonaws.iot#Percentage", - "traits": { - "smithy.api#documentation": "

The progress of the bulk provisioning task expressed as a percentage.

" - } - }, - "taskId": { - "target": "com.amazonaws.iot#TaskId", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The task ID.

" + "smithy.api#documentation": "

The role ARN that grants access to the input file bucket.

" } }, "creationDate": { @@ -10380,6 +10694,12 @@ "traits": { "smithy.api#documentation": "

The task creation date.

" } + }, + "inputFileKey": { + "target": "com.amazonaws.iot#RegistryS3KeyName", + "traits": { + "smithy.api#documentation": "

The input file key.

" + } } } }, @@ -10402,34 +10722,22 @@ "com.amazonaws.iot#DescribeThingResponse": { "type": "structure", "members": { - "thingArn": { - "target": "com.amazonaws.iot#ThingArn", - "traits": { - "smithy.api#documentation": "

The ARN of the thing to describe.

" - } - }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The thing type name.

" } }, - "billingGroupName": { - "target": "com.amazonaws.iot#BillingGroupName", - "traits": { - "smithy.api#documentation": "

The name of the billing group the thing belongs to.

" - } - }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing.

" } }, - "defaultClientId": { - "target": "com.amazonaws.iot#ClientId", + "billingGroupName": { + "target": "com.amazonaws.iot#BillingGroupName", "traits": { - "smithy.api#documentation": "

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. \n\t\t\tAlthough we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or \n\t\t\tshadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

\n\t\t

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

" + "smithy.api#documentation": "

The name of the billing group the thing belongs to.

" } }, "attributes": { @@ -10438,6 +10746,12 @@ "smithy.api#documentation": "

The thing attributes.

" } }, + "defaultClientId": { + "target": "com.amazonaws.iot#ClientId", + "traits": { + "smithy.api#documentation": "

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. \n\t\t\tAlthough we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or \n\t\t\tshadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

\n\t\t

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

" + } + }, "version": { "target": "com.amazonaws.iot#Version", "traits": { @@ -10449,6 +10763,12 @@ "traits": { "smithy.api#documentation": "

The ID of the thing to describe.

" } + }, + "thingArn": { + "target": "com.amazonaws.iot#ThingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the thing to describe.

" + } } }, "traits": { @@ -10511,18 +10831,18 @@ "com.amazonaws.iot#DescribeThingTypeResponse": { "type": "structure", "members": { - "thingTypeId": { - "target": "com.amazonaws.iot#ThingTypeId", - "traits": { - "smithy.api#documentation": "

The thing type ID.

" - } - }, "thingTypeMetadata": { "target": "com.amazonaws.iot#ThingTypeMetadata", "traits": { "smithy.api#documentation": "

The ThingTypeMetadata contains additional information about the thing type\n\t\t\tincluding: creation date and time, a value indicating whether the thing type is\n\t\t\tdeprecated, and a date and time when it was deprecated.

" } }, + "thingTypeProperties": { + "target": "com.amazonaws.iot#ThingTypeProperties", + "traits": { + "smithy.api#documentation": "

The ThingTypeProperties contains information about the thing type including\n\t\t\tdescription, and a list of searchable thing attribute names.

" + } + }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { @@ -10535,10 +10855,10 @@ "smithy.api#documentation": "

The thing type ARN.

" } }, - "thingTypeProperties": { - "target": "com.amazonaws.iot#ThingTypeProperties", + "thingTypeId": { + "target": "com.amazonaws.iot#ThingTypeId", "traits": { - "smithy.api#documentation": "

The ThingTypeProperties contains information about the thing type including\n\t\t\tdescription, and a list of searchable thing attribute names.

" + "smithy.api#documentation": "

The thing type ID.

" } } }, @@ -10600,13 +10920,6 @@ "com.amazonaws.iot#DetachPolicyRequest": { "type": "structure", "members": { - "target": { - "target": "com.amazonaws.iot#PolicyTarget", - "traits": { - "smithy.api#documentation": "

The target from which the policy will be detached.

", - "smithy.api#required": {} - } - }, "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { @@ -10614,6 +10927,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "target": { + "target": "com.amazonaws.iot#PolicyTarget", + "traits": { + "smithy.api#documentation": "

The target from which the policy will be detached.

", + "smithy.api#required": {} + } } } }, @@ -10655,14 +10975,6 @@ "com.amazonaws.iot#DetachPrincipalPolicyRequest": { "type": "structure", "members": { - "principal": { - "target": "com.amazonaws.iot#Principal", - "traits": { - "smithy.api#documentation": "

The principal.

\n

If the principal is a certificate, specify the certificate ARN. If the principal is\n an Amazon Cognito identity, specify the identity ID.

", - "smithy.api#httpHeader": "x-amzn-iot-principal", - "smithy.api#required": {} - } - }, "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { @@ -10670,6 +10982,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "principal": { + "target": "com.amazonaws.iot#Principal", + "traits": { + "smithy.api#documentation": "

The principal.

\n

Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

", + "smithy.api#httpHeader": "x-amzn-iot-principal", + "smithy.api#required": {} + } } }, "traits": { @@ -10772,14 +11092,6 @@ "com.amazonaws.iot#DetachThingPrincipalRequest": { "type": "structure", "members": { - "thingName": { - "target": "com.amazonaws.iot#ThingName", - "traits": { - "smithy.api#documentation": "

The name of the thing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { @@ -10787,6 +11099,14 @@ "smithy.api#httpHeader": "x-amzn-principal", "smithy.api#required": {} } + }, + "thingName": { + "target": "com.amazonaws.iot#ThingName", + "traits": { + "smithy.api#documentation": "

The name of the thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -11081,10 +11401,16 @@ "com.amazonaws.iot#DynamoDBAction": { "type": "structure", "members": { - "hashKeyValue": { - "target": "com.amazonaws.iot#HashKeyValue", + "hashKeyType": { + "target": "com.amazonaws.iot#DynamoKeyType", "traits": { - "smithy.api#documentation": "

The hash key value.

", + "smithy.api#documentation": "

The hash key type. Valid values are \"STRING\" or \"NUMBER\"

" + } + }, + "hashKeyField": { + "target": "com.amazonaws.iot#HashKeyField", + "traits": { + "smithy.api#documentation": "

The hash key name.

", "smithy.api#required": {} } }, @@ -11100,10 +11426,10 @@ "smithy.api#documentation": "

The type of operation to be performed. This follows the substitution template, so it\n can be ${operation}, but the substitution must result in one of the following:\n INSERT, UPDATE, or DELETE.

" } }, - "roleArn": { - "target": "com.amazonaws.iot#AwsArn", + "tableName": { + "target": "com.amazonaws.iot#TableName", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that grants access to the DynamoDB table.

", + "smithy.api#documentation": "

The name of the DynamoDB table.

", "smithy.api#required": {} } }, @@ -11113,24 +11439,17 @@ "smithy.api#documentation": "

The action payload. This name can be customized.

" } }, - "tableName": { - "target": "com.amazonaws.iot#TableName", + "hashKeyValue": { + "target": "com.amazonaws.iot#HashKeyValue", "traits": { - "smithy.api#documentation": "

The name of the DynamoDB table.

", + "smithy.api#documentation": "

The hash key value.

", "smithy.api#required": {} } }, - "hashKeyType": { + "rangeKeyType": { "target": "com.amazonaws.iot#DynamoKeyType", "traits": { - "smithy.api#documentation": "

The hash key type. Valid values are \"STRING\" or \"NUMBER\"

" - } - }, - "hashKeyField": { - "target": "com.amazonaws.iot#HashKeyField", - "traits": { - "smithy.api#documentation": "

The hash key name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The range key type. Valid values are \"STRING\" or \"NUMBER\"

" } }, "rangeKeyValue": { @@ -11139,10 +11458,11 @@ "smithy.api#documentation": "

The range key value.

" } }, - "rangeKeyType": { - "target": "com.amazonaws.iot#DynamoKeyType", + "roleArn": { + "target": "com.amazonaws.iot#AwsArn", "traits": { - "smithy.api#documentation": "

The range key type. Valid values are \"STRING\" or \"NUMBER\"

" + "smithy.api#documentation": "

The ARN of the IAM role that grants access to the DynamoDB table.

", + "smithy.api#required": {} } } }, @@ -11232,31 +11552,31 @@ "smithy.api#required": {} } }, - "endpoint": { - "target": "com.amazonaws.iot#ElasticsearchEndpoint", + "id": { + "target": "com.amazonaws.iot#ElasticsearchId", "traits": { - "smithy.api#documentation": "

The endpoint of your Elasticsearch domain.

", + "smithy.api#documentation": "

The unique identifier for the document you are storing.

", "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.iot#ElasticsearchId", + "roleArn": { + "target": "com.amazonaws.iot#AwsArn", "traits": { - "smithy.api#documentation": "

The unique identifier for the document you are storing.

", + "smithy.api#documentation": "

The IAM role ARN that has access to Elasticsearch.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.iot#ElasticsearchType", + "endpoint": { + "target": "com.amazonaws.iot#ElasticsearchEndpoint", "traits": { - "smithy.api#documentation": "

The type of document you are storing.

", + "smithy.api#documentation": "

The endpoint of your Elasticsearch domain.

", "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.iot#AwsArn", + "type": { + "target": "com.amazonaws.iot#ElasticsearchType", "traits": { - "smithy.api#documentation": "

The IAM role ARN that has access to Elasticsearch.

", + "smithy.api#documentation": "

The type of document you are storing.

", "smithy.api#required": {} } } @@ -11283,17 +11603,17 @@ "com.amazonaws.iot#EnableIoTLoggingParams": { "type": "structure", "members": { - "roleArnForLogging": { - "target": "com.amazonaws.iot#RoleArn", + "logLevel": { + "target": "com.amazonaws.iot#LogLevel", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role used for logging.

", + "smithy.api#documentation": "

Specifies the types of information to be logged.

", "smithy.api#required": {} } }, - "logLevel": { - "target": "com.amazonaws.iot#LogLevel", + "roleArnForLogging": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

Specifies the types of information to be logged.

", + "smithy.api#documentation": "

The ARN of the IAM role used for logging.

", "smithy.api#required": {} } } @@ -11516,7 +11836,7 @@ "rateIncreaseCriteria": { "target": "com.amazonaws.iot#RateIncreaseCriteria", "traits": { - "smithy.api#documentation": "

The criteria to initiate the increase in rate of rollout for a job.

\n

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

", + "smithy.api#documentation": "

The criteria to initiate the increase in rate of rollout for a job.

", "smithy.api#required": {} } }, @@ -11530,7 +11850,7 @@ "incrementFactor": { "target": "com.amazonaws.iot#IncrementFactor", "traits": { - "smithy.api#documentation": "

The exponential factor to increase the rate of rollout for a job.

", + "smithy.api#documentation": "

The exponential factor to increase the rate of rollout for a job.

\n

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

", "smithy.api#required": {} } } @@ -11560,17 +11880,17 @@ "com.amazonaws.iot#Field": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.iot#FieldType", - "traits": { - "smithy.api#documentation": "

The datatype of the field.

" - } - }, "name": { "target": "com.amazonaws.iot#FieldName", "traits": { "smithy.api#documentation": "

The name of the field.

" } + }, + "type": { + "target": "com.amazonaws.iot#FieldType", + "traits": { + "smithy.api#documentation": "

The datatype of the field.

" + } } }, "traits": { @@ -11767,10 +12087,10 @@ "com.amazonaws.iot#GetCardinalityRequest": { "type": "structure", "members": { - "queryVersion": { - "target": "com.amazonaws.iot#QueryVersion", + "aggregationField": { + "target": "com.amazonaws.iot#AggregationField", "traits": { - "smithy.api#documentation": "

The query version.

" + "smithy.api#documentation": "

The field to aggregate.

" } }, "queryString": { @@ -11780,10 +12100,10 @@ "smithy.api#required": {} } }, - "aggregationField": { - "target": "com.amazonaws.iot#AggregationField", + "queryVersion": { + "target": "com.amazonaws.iot#QueryVersion", "traits": { - "smithy.api#documentation": "

The field to aggregate.

" + "smithy.api#documentation": "

The query version.

" } }, "indexName": { @@ -11855,16 +12175,16 @@ "smithy.api#httpQuery": "thingName" } }, - "cognitoIdentityPoolId": { - "target": "com.amazonaws.iot#CognitoIdentityPoolId", + "principal": { + "target": "com.amazonaws.iot#Principal", "traits": { - "smithy.api#documentation": "

The Cognito identity pool ID.

" + "smithy.api#documentation": "

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

" } }, - "principal": { - "target": "com.amazonaws.iot#Principal", + "cognitoIdentityPoolId": { + "target": "com.amazonaws.iot#CognitoIdentityPoolId", "traits": { - "smithy.api#documentation": "

The principal.

" + "smithy.api#documentation": "

The Cognito identity pool ID.

" } } } @@ -11921,17 +12241,17 @@ "com.amazonaws.iot#GetIndexingConfigurationResponse": { "type": "structure", "members": { - "thingIndexingConfiguration": { - "target": "com.amazonaws.iot#ThingIndexingConfiguration", - "traits": { - "smithy.api#documentation": "

Thing indexing configuration.

" - } - }, "thingGroupIndexingConfiguration": { "target": "com.amazonaws.iot#ThingGroupIndexingConfiguration", "traits": { "smithy.api#documentation": "

The index configuration.

" } + }, + "thingIndexingConfiguration": { + "target": "com.amazonaws.iot#ThingIndexingConfiguration", + "traits": { + "smithy.api#documentation": "

Thing indexing configuration.

" + } } } }, @@ -12155,16 +12475,17 @@ "com.amazonaws.iot#GetPercentilesRequest": { "type": "structure", "members": { - "percents": { - "target": "com.amazonaws.iot#PercentList", + "aggregationField": { + "target": "com.amazonaws.iot#AggregationField", "traits": { - "smithy.api#documentation": "

The percentile groups returned.

" + "smithy.api#documentation": "

The field to aggregate.

" } }, - "indexName": { - "target": "com.amazonaws.iot#IndexName", + "queryString": { + "target": "com.amazonaws.iot#QueryString", "traits": { - "smithy.api#documentation": "

The name of the index to search.

" + "smithy.api#documentation": "

The query string.

", + "smithy.api#required": {} } }, "queryVersion": { @@ -12173,17 +12494,16 @@ "smithy.api#documentation": "

The query version.

" } }, - "queryString": { - "target": "com.amazonaws.iot#QueryString", + "percents": { + "target": "com.amazonaws.iot#PercentList", "traits": { - "smithy.api#documentation": "

The query string.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The percentile groups returned.

" } }, - "aggregationField": { - "target": "com.amazonaws.iot#AggregationField", + "indexName": { + "target": "com.amazonaws.iot#IndexName", "traits": { - "smithy.api#documentation": "

The field to aggregate.

" + "smithy.api#documentation": "

The name of the index to search.

" } } } @@ -12255,12 +12575,6 @@ "com.amazonaws.iot#GetPolicyResponse": { "type": "structure", "members": { - "creationDate": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The date the policy was created.

" - } - }, "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { @@ -12273,29 +12587,35 @@ "smithy.api#documentation": "

The date the policy was last modified.

" } }, - "policyArn": { - "target": "com.amazonaws.iot#PolicyArn", - "traits": { - "smithy.api#documentation": "

The policy ARN.

" - } - }, - "generationId": { - "target": "com.amazonaws.iot#GenerationId", - "traits": { - "smithy.api#documentation": "

The generation ID of the policy.

" - } - }, "defaultVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The default policy version ID.

" } }, + "creationDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date the policy was created.

" + } + }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The JSON document that describes the policy.

" } + }, + "generationId": { + "target": "com.amazonaws.iot#GenerationId", + "traits": { + "smithy.api#documentation": "

The generation ID of the policy.

" + } + }, + "policyArn": { + "target": "com.amazonaws.iot#PolicyArn", + "traits": { + "smithy.api#documentation": "

The policy ARN.

" + } } }, "traits": { @@ -12342,18 +12662,18 @@ "com.amazonaws.iot#GetPolicyVersionRequest": { "type": "structure", "members": { - "policyVersionId": { - "target": "com.amazonaws.iot#PolicyVersionId", + "policyName": { + "target": "com.amazonaws.iot#PolicyName", "traits": { - "smithy.api#documentation": "

The policy version ID.

", + "smithy.api#documentation": "

The name of the policy.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "policyVersionId": { + "target": "com.amazonaws.iot#PolicyVersionId", "traits": { - "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#documentation": "

The policy version ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12366,10 +12686,10 @@ "com.amazonaws.iot#GetPolicyVersionResponse": { "type": "structure", "members": { - "policyVersionId": { - "target": "com.amazonaws.iot#PolicyVersionId", + "generationId": { + "target": "com.amazonaws.iot#GenerationId", "traits": { - "smithy.api#documentation": "

The policy version ID.

" + "smithy.api#documentation": "

The generation ID of the policy version.

" } }, "policyArn": { @@ -12396,16 +12716,10 @@ "smithy.api#documentation": "

The date the policy was last modified.

" } }, - "generationId": { - "target": "com.amazonaws.iot#GenerationId", - "traits": { - "smithy.api#documentation": "

The generation ID of the policy version.

" - } - }, - "policyDocument": { - "target": "com.amazonaws.iot#PolicyDocument", + "policyVersionId": { + "target": "com.amazonaws.iot#PolicyVersionId", "traits": { - "smithy.api#documentation": "

The JSON document that describes the policy.

" + "smithy.api#documentation": "

The policy version ID.

" } }, "creationDate": { @@ -12413,6 +12727,12 @@ "traits": { "smithy.api#documentation": "

The date the policy was created.

" } + }, + "policyDocument": { + "target": "com.amazonaws.iot#PolicyDocument", + "traits": { + "smithy.api#documentation": "

The JSON document that describes the policy.

" + } } }, "traits": { @@ -12523,10 +12843,16 @@ "com.amazonaws.iot#GetStatisticsRequest": { "type": "structure", "members": { - "indexName": { - "target": "com.amazonaws.iot#IndexName", + "aggregationField": { + "target": "com.amazonaws.iot#AggregationField", "traits": { - "smithy.api#documentation": "

The name of the index to search. The default value is AWS_Things.

" + "smithy.api#documentation": "

The aggregation field name.

" + } + }, + "queryVersion": { + "target": "com.amazonaws.iot#QueryVersion", + "traits": { + "smithy.api#documentation": "

The version of the query used to search.

" } }, "queryString": { @@ -12536,16 +12862,10 @@ "smithy.api#required": {} } }, - "queryVersion": { - "target": "com.amazonaws.iot#QueryVersion", - "traits": { - "smithy.api#documentation": "

The version of the query used to search.

" - } - }, - "aggregationField": { - "target": "com.amazonaws.iot#AggregationField", + "indexName": { + "target": "com.amazonaws.iot#IndexName", "traits": { - "smithy.api#documentation": "

The aggregation field name.

" + "smithy.api#documentation": "

The name of the index to search. The default value is AWS_Things.

" } } } @@ -12718,12 +13038,6 @@ "com.amazonaws.iot#GetV2LoggingOptionsResponse": { "type": "structure", "members": { - "defaultLogLevel": { - "target": "com.amazonaws.iot#LogLevel", - "traits": { - "smithy.api#documentation": "

The default log level.

" - } - }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { @@ -12735,6 +13049,12 @@ "traits": { "smithy.api#documentation": "

Disables all logs.

" } + }, + "defaultLogLevel": { + "target": "com.amazonaws.iot#LogLevel", + "traits": { + "smithy.api#documentation": "

The default log level.

" + } } } }, @@ -12794,10 +13114,10 @@ "com.amazonaws.iot#HttpAction": { "type": "structure", "members": { - "headers": { - "target": "com.amazonaws.iot#HeaderList", + "confirmationUrl": { + "target": "com.amazonaws.iot#Url", "traits": { - "smithy.api#documentation": "

The HTTP headers to send with the message data.

" + "smithy.api#documentation": "

The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL\n must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses\n the endpoint URL as the confirmation URL. If you use substitution templates in the\n confirmationUrl, you must create and enable topic rule destinations that match each\n possible value of the substitution template before traffic is allowed to your endpoint\n URL.

" } }, "url": { @@ -12807,16 +13127,16 @@ "smithy.api#required": {} } }, - "auth": { - "target": "com.amazonaws.iot#HttpAuthorization", + "headers": { + "target": "com.amazonaws.iot#HeaderList", "traits": { - "smithy.api#documentation": "

The authentication method to use when sending data to an HTTPS endpoint.

" + "smithy.api#documentation": "

The HTTP headers to send with the message data.

" } }, - "confirmationUrl": { - "target": "com.amazonaws.iot#Url", + "auth": { + "target": "com.amazonaws.iot#HttpAuthorization", "traits": { - "smithy.api#documentation": "

The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL\n must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses\n the endpoint URL as the confirmation URL. If you use substitution templates in the\n confirmationUrl, you must create and enable topic rule destinations that match each\n possible value of the substitution template before traffic is allowed to your endpoint\n URL.

" + "smithy.api#documentation": "

The authentication method to use when sending data to an HTTPS endpoint.

" } } }, @@ -12827,17 +13147,17 @@ "com.amazonaws.iot#HttpActionHeader": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iot#HeaderValue", + "key": { + "target": "com.amazonaws.iot#HeaderKey", "traits": { - "smithy.api#documentation": "

The HTTP header value. Substitution templates are supported.

", + "smithy.api#documentation": "

The HTTP header key.

", "smithy.api#required": {} } }, - "key": { - "target": "com.amazonaws.iot#HeaderKey", + "value": { + "target": "com.amazonaws.iot#HeaderValue", "traits": { - "smithy.api#documentation": "

The HTTP header key.

", + "smithy.api#documentation": "

The HTTP header value. Substitution templates are supported.

", "smithy.api#required": {} } } @@ -13178,12 +13498,6 @@ "com.amazonaws.iot#IotAnalyticsAction": { "type": "structure", "members": { - "channelName": { - "target": "com.amazonaws.iot#ChannelName", - "traits": { - "smithy.api#documentation": "

The name of the IoT Analytics channel to which message data will be sent.

" - } - }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { @@ -13195,6 +13509,12 @@ "traits": { "smithy.api#documentation": "

(deprecated) The ARN of the IoT Analytics channel to which message data will be\n sent.

" } + }, + "channelName": { + "target": "com.amazonaws.iot#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the IoT Analytics channel to which message data will be sent.

" + } } }, "traits": { @@ -13211,18 +13531,18 @@ "smithy.api#required": {} } }, - "messageId": { - "target": "com.amazonaws.iot#MessageId", - "traits": { - "smithy.api#documentation": "

[Optional] Use this to ensure that only one input (message) with a given messageId will\n be processed by an AWS IoT Events detector.

" - } - }, "inputName": { "target": "com.amazonaws.iot#InputName", "traits": { "smithy.api#documentation": "

The name of the AWS IoT Events input.

", "smithy.api#required": {} } + }, + "messageId": { + "target": "com.amazonaws.iot#MessageId", + "traits": { + "smithy.api#documentation": "

[Optional] Use this to ensure that only one input (message) with a given messageId will\n be processed by an AWS IoT Events detector.

" + } } }, "traits": { @@ -13266,109 +13586,115 @@ "smithy.api#box": {} } }, + "com.amazonaws.iot#IsSuppressed": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.iot#Job": { "type": "structure", "members": { - "presignedUrlConfig": { - "target": "com.amazonaws.iot#PresignedUrlConfig", + "jobArn": { + "target": "com.amazonaws.iot#JobArn", "traits": { - "smithy.api#documentation": "

Configuration for pre-signed S3 URLs.

" + "smithy.api#documentation": "

An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".

" } }, - "jobExecutionsRolloutConfig": { - "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", + "targets": { + "target": "com.amazonaws.iot#JobTargets", "traits": { - "smithy.api#documentation": "

Allows you to create a staged rollout of a job.

" + "smithy.api#documentation": "

A list of IoT things and thing groups to which the job should be sent.

" } }, - "reasonCode": { - "target": "com.amazonaws.iot#ReasonCode", + "lastUpdatedAt": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

If the job was updated, provides the reason code for the update.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was last updated.

" } }, - "targets": { - "target": "com.amazonaws.iot#JobTargets", + "comment": { + "target": "com.amazonaws.iot#Comment", "traits": { - "smithy.api#documentation": "

A list of IoT things and thing groups to which the job should be sent.

" + "smithy.api#documentation": "

If the job was updated, describes the reason for the update.

" } }, - "jobProcessDetails": { - "target": "com.amazonaws.iot#JobProcessDetails", + "createdAt": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

Details about the job process.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was created.

" } }, - "description": { - "target": "com.amazonaws.iot#JobDescription", + "presignedUrlConfig": { + "target": "com.amazonaws.iot#PresignedUrlConfig", "traits": { - "smithy.api#documentation": "

A short text description of the job.

" + "smithy.api#documentation": "

Configuration for pre-signed S3 URLs.

" } }, - "targetSelection": { - "target": "com.amazonaws.iot#TargetSelection", + "jobId": { + "target": "com.amazonaws.iot#JobId", "traits": { - "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a device when the thing representing\n the device is added to a target group, even after the job was completed by all things originally in the \n group.

" + "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, - "comment": { - "target": "com.amazonaws.iot#Comment", + "forceCanceled": { + "target": "com.amazonaws.iot#Forced", "traits": { - "smithy.api#documentation": "

If the job was updated, describes the reason for the update.

" + "smithy.api#documentation": "

Will be true if the job was canceled with the optional force parameter set to \n true.

" } }, - "lastUpdatedAt": { + "completedAt": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was last updated.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was completed.

" } }, - "jobArn": { - "target": "com.amazonaws.iot#JobArn", + "reasonCode": { + "target": "com.amazonaws.iot#ReasonCode", "traits": { - "smithy.api#documentation": "

An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".

" + "smithy.api#documentation": "

If the job was updated, provides the reason code for the update.

" } }, - "timeoutConfig": { - "target": "com.amazonaws.iot#TimeoutConfig", + "status": { + "target": "com.amazonaws.iot#JobStatus", "traits": { - "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the timer expires, it will\n be automatically set to TIMED_OUT.

" + "smithy.api#documentation": "

The status of the job, one of IN_PROGRESS, CANCELED, \n DELETION_IN_PROGRESS or COMPLETED.

" } }, - "createdAt": { - "target": "com.amazonaws.iot#DateType", + "abortConfig": { + "target": "com.amazonaws.iot#AbortConfig", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was created.

" + "smithy.api#documentation": "

Configuration for criteria to abort the job.

" } }, - "completedAt": { - "target": "com.amazonaws.iot#DateType", + "description": { + "target": "com.amazonaws.iot#JobDescription", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was completed.

" + "smithy.api#documentation": "

A short text description of the job.

" } }, - "jobId": { - "target": "com.amazonaws.iot#JobId", + "timeoutConfig": { + "target": "com.amazonaws.iot#TimeoutConfig", "traits": { - "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" + "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the timer expires, it will\n be automatically set to TIMED_OUT.

" } }, - "forceCanceled": { - "target": "com.amazonaws.iot#Forced", + "jobProcessDetails": { + "target": "com.amazonaws.iot#JobProcessDetails", "traits": { - "smithy.api#documentation": "

Will be true if the job was canceled with the optional force parameter set to \n true.

" + "smithy.api#documentation": "

Details about the job process.

" } }, - "status": { - "target": "com.amazonaws.iot#JobStatus", + "targetSelection": { + "target": "com.amazonaws.iot#TargetSelection", "traits": { - "smithy.api#documentation": "

The status of the job, one of IN_PROGRESS, CANCELED, \n DELETION_IN_PROGRESS or COMPLETED.

" + "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a device when the thing representing\n the device is added to a target group, even after the job was completed by all things originally in the \n group.

" } }, - "abortConfig": { - "target": "com.amazonaws.iot#AbortConfig", + "jobExecutionsRolloutConfig": { + "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", "traits": { - "smithy.api#documentation": "

Configuration for criteria to abort the job.

" + "smithy.api#documentation": "

Allows you to create a staged rollout of a job.

" } } }, @@ -13410,22 +13736,16 @@ "com.amazonaws.iot#JobExecution": { "type": "structure", "members": { - "versionNumber": { - "target": "com.amazonaws.iot#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time they are updated\n by a device.

" - } - }, - "jobId": { - "target": "com.amazonaws.iot#JobId", + "lastUpdatedAt": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The unique identifier you assigned to the job when it was created.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was last updated.

" } }, - "lastUpdatedAt": { + "startedAt": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was last updated.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution started.

" } }, "forceCanceled": { @@ -13434,34 +13754,34 @@ "smithy.api#documentation": "

Will be true if the job execution was canceled with the optional force \n parameter set to true.

" } }, - "statusDetails": { - "target": "com.amazonaws.iot#JobExecutionStatusDetails", + "versionNumber": { + "target": "com.amazonaws.iot#VersionNumber", "traits": { - "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution.

" + "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time they are updated\n by a device.

" } }, - "startedAt": { - "target": "com.amazonaws.iot#DateType", + "jobId": { + "target": "com.amazonaws.iot#JobId", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution started.

" + "smithy.api#documentation": "

The unique identifier you assigned to the job when it was created.

" } }, - "executionNumber": { - "target": "com.amazonaws.iot#ExecutionNumber", + "status": { + "target": "com.amazonaws.iot#JobExecutionStatus", "traits": { - "smithy.api#documentation": "

A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on\n this particular device. It can be used in commands which return or update job execution information.\n

" + "smithy.api#documentation": "

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, \n CANCELED, or REJECTED).

" } }, - "thingArn": { - "target": "com.amazonaws.iot#ThingArn", + "statusDetails": { + "target": "com.amazonaws.iot#JobExecutionStatusDetails", "traits": { - "smithy.api#documentation": "

The ARN of the thing on which the job execution is running.

" + "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution.

" } }, - "status": { - "target": "com.amazonaws.iot#JobExecutionStatus", + "queuedAt": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, \n CANCELED, or REJECTED).

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was queued.

" } }, "approximateSecondsBeforeTimedOut": { @@ -13470,10 +13790,16 @@ "smithy.api#documentation": "

The estimated number of seconds that remain before the job execution status will be\n changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). \n The actual job execution timeout can occur up to 60 seconds later than the estimated duration. \n This value will not be included if the job execution has reached a terminal status.

" } }, - "queuedAt": { - "target": "com.amazonaws.iot#DateType", + "executionNumber": { + "target": "com.amazonaws.iot#ExecutionNumber", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was queued.

" + "smithy.api#documentation": "

A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on\n this particular device. It can be used in commands which return or update job execution information.\n

" + } + }, + "thingArn": { + "target": "com.amazonaws.iot#ThingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the thing on which the job execution is running.

" } } }, @@ -13560,18 +13886,6 @@ "com.amazonaws.iot#JobExecutionSummary": { "type": "structure", "members": { - "queuedAt": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was queued.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was last updated.

" - } - }, "executionNumber": { "target": "com.amazonaws.iot#ExecutionNumber", "traits": { @@ -13584,11 +13898,23 @@ "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution started.

" } }, + "lastUpdatedAt": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was last updated.

" + } + }, "status": { "target": "com.amazonaws.iot#JobExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the job execution.

" } + }, + "queuedAt": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was queued.

" + } } }, "traits": { @@ -13650,17 +13976,17 @@ "com.amazonaws.iot#JobExecutionsRolloutConfig": { "type": "structure", "members": { - "exponentialRate": { - "target": "com.amazonaws.iot#ExponentialRolloutRate", - "traits": { - "smithy.api#documentation": "

The rate of increase for a job rollout.\n This parameter allows you to define an exponential rate for a job rollout.

" - } - }, "maximumPerMinute": { "target": "com.amazonaws.iot#MaxJobExecutionsPerMin", "traits": { "smithy.api#documentation": "

The maximum number of things that will be notified of a pending job, per minute.\n This parameter allows you to create a staged rollout.

" } + }, + "exponentialRate": { + "target": "com.amazonaws.iot#ExponentialRolloutRate", + "traits": { + "smithy.api#documentation": "

The rate of increase for a job rollout.\n This parameter allows you to define an exponential rate for a job rollout.

" + } } }, "traits": { @@ -13680,22 +14006,28 @@ "com.amazonaws.iot#JobProcessDetails": { "type": "structure", "members": { - "numberOfRejectedThings": { - "target": "com.amazonaws.iot#RejectedThings", + "numberOfCanceledThings": { + "target": "com.amazonaws.iot#CanceledThings", "traits": { - "smithy.api#documentation": "

The number of things that rejected the job.

" + "smithy.api#documentation": "

The number of things that cancelled the job.

" } }, - "numberOfTimedOutThings": { - "target": "com.amazonaws.iot#TimedOutThings", + "numberOfSucceededThings": { + "target": "com.amazonaws.iot#SucceededThings", "traits": { - "smithy.api#documentation": "

The number of things whose job execution status is TIMED_OUT.

" + "smithy.api#documentation": "

The number of things which successfully completed the job.

" } }, - "numberOfInProgressThings": { - "target": "com.amazonaws.iot#InProgressThings", + "numberOfRemovedThings": { + "target": "com.amazonaws.iot#RemovedThings", "traits": { - "smithy.api#documentation": "

The number of things currently executing the job.

" + "smithy.api#documentation": "

The number of things that are no longer scheduled to execute the job because they have been deleted or\n have been removed from the group that was a target of the job.

" + } + }, + "numberOfRejectedThings": { + "target": "com.amazonaws.iot#RejectedThings", + "traits": { + "smithy.api#documentation": "

The number of things that rejected the job.

" } }, "numberOfQueuedThings": { @@ -13704,16 +14036,16 @@ "smithy.api#documentation": "

The number of things that are awaiting execution of the job.

" } }, - "processingTargets": { - "target": "com.amazonaws.iot#ProcessingTargetNameList", + "numberOfTimedOutThings": { + "target": "com.amazonaws.iot#TimedOutThings", "traits": { - "smithy.api#documentation": "

The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

" + "smithy.api#documentation": "

The number of things whose job execution status is TIMED_OUT.

" } }, - "numberOfRemovedThings": { - "target": "com.amazonaws.iot#RemovedThings", + "processingTargets": { + "target": "com.amazonaws.iot#ProcessingTargetNameList", "traits": { - "smithy.api#documentation": "

The number of things that are no longer scheduled to execute the job because they have been deleted or\n have been removed from the group that was a target of the job.

" + "smithy.api#documentation": "

The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

" } }, "numberOfFailedThings": { @@ -13722,16 +14054,10 @@ "smithy.api#documentation": "

The number of things that failed executing the job.

" } }, - "numberOfSucceededThings": { - "target": "com.amazonaws.iot#SucceededThings", - "traits": { - "smithy.api#documentation": "

The number of things which successfully completed the job.

" - } - }, - "numberOfCanceledThings": { - "target": "com.amazonaws.iot#CanceledThings", + "numberOfInProgressThings": { + "target": "com.amazonaws.iot#InProgressThings", "traits": { - "smithy.api#documentation": "

The number of things that cancelled the job.

" + "smithy.api#documentation": "

The number of things currently executing the job.

" } } }, @@ -13765,28 +14091,22 @@ "com.amazonaws.iot#JobSummary": { "type": "structure", "members": { - "targetSelection": { - "target": "com.amazonaws.iot#TargetSelection", - "traits": { - "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.

" - } - }, - "lastUpdatedAt": { + "createdAt": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was last updated.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was created.

" } }, - "status": { - "target": "com.amazonaws.iot#JobStatus", + "jobArn": { + "target": "com.amazonaws.iot#JobArn", "traits": { - "smithy.api#documentation": "

The job summary status.

" + "smithy.api#documentation": "

The job ARN.

" } }, - "thingGroupId": { - "target": "com.amazonaws.iot#ThingGroupId", + "completedAt": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The ID of the thing group.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job completed.

" } }, "jobId": { @@ -13795,22 +14115,28 @@ "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, - "createdAt": { - "target": "com.amazonaws.iot#DateType", + "status": { + "target": "com.amazonaws.iot#JobStatus", + "traits": { + "smithy.api#documentation": "

The job summary status.

" + } + }, + "targetSelection": { + "target": "com.amazonaws.iot#TargetSelection", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was created.

" + "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.

" } }, - "jobArn": { - "target": "com.amazonaws.iot#JobArn", + "lastUpdatedAt": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The job ARN.

" + "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was last updated.

" } }, - "completedAt": { - "target": "com.amazonaws.iot#DateType", + "thingGroupId": { + "target": "com.amazonaws.iot#ThingGroupId", "traits": { - "smithy.api#documentation": "

The time, in seconds since the epoch, when the job completed.

" + "smithy.api#documentation": "

The ID of the thing group.

" } } }, @@ -13883,13 +14209,6 @@ "com.amazonaws.iot#KinesisAction": { "type": "structure", "members": { - "streamName": { - "target": "com.amazonaws.iot#StreamName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis stream.

", - "smithy.api#required": {} - } - }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { @@ -13902,6 +14221,13 @@ "traits": { "smithy.api#documentation": "

The partition key.

" } + }, + "streamName": { + "target": "com.amazonaws.iot#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis stream.

", + "smithy.api#required": {} + } } }, "traits": { @@ -13980,17 +14306,23 @@ "method": "GET", "uri": "/active-violations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "activeViolations", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListActiveViolationsRequest": { "type": "structure", "members": { - "thingName": { - "target": "com.amazonaws.iot#DeviceDefenderThingName", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The name of the thing whose active violations are listed.

", - "smithy.api#httpQuery": "thingName" + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" } }, "maxResults": { @@ -14000,19 +14332,19 @@ "smithy.api#httpQuery": "maxResults" } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the Device Defender security profile for which violations are listed.

", "smithy.api#httpQuery": "securityProfileName" } + }, + "thingName": { + "target": "com.amazonaws.iot#DeviceDefenderThingName", + "traits": { + "smithy.api#documentation": "

The name of the thing whose active violations are listed.

", + "smithy.api#httpQuery": "thingName" + } } } }, @@ -14070,19 +14402,18 @@ "method": "POST", "uri": "/attached-policies/{target}", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "policies", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListAttachedPoliciesRequest": { "type": "structure", "members": { - "marker": { - "target": "com.amazonaws.iot#Marker", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "marker" - } - }, "recursive": { "target": "com.amazonaws.iot#Recursive", "traits": { @@ -14090,20 +14421,27 @@ "smithy.api#httpQuery": "recursive" } }, - "pageSize": { - "target": "com.amazonaws.iot#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "pageSize" - } - }, "target": { "target": "com.amazonaws.iot#PolicyTarget", "traits": { - "smithy.api#documentation": "

The group or principal for which the policies will be listed.

", + "smithy.api#documentation": "

The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "marker": { + "target": "com.amazonaws.iot#Marker", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "marker" + } + }, + "pageSize": { + "target": "com.amazonaws.iot#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "pageSize" + } } } }, @@ -14144,39 +14482,45 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the findings (results) of a Device Defender audit or of the audits\n performed during a specified time period. (Findings are retained for 180 days.)

", + "smithy.api#documentation": "

Lists the findings (results) of a Device Defender audit or of the audits\n performed during a specified time period. (Findings are retained for 90 days.)

", "smithy.api#http": { "method": "POST", "uri": "/audit/findings", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "findings", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditFindingsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", + "listSuppressedFindings": { + "target": "com.amazonaws.iot#ListSuppressedFindings", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" + "smithy.api#documentation": "

\n Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.\n

" } }, - "startTime": { + "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" + "smithy.api#documentation": "

A filter to limit results to those found before the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" } }, - "checkName": { - "target": "com.amazonaws.iot#AuditCheckName", + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

A filter to limit results to the findings for the specified audit check.

" + "smithy.api#documentation": "

Information identifying the noncompliant resource.

" } }, - "maxResults": { - "target": "com.amazonaws.iot#MaxResults", + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

" + "smithy.api#documentation": "

A filter to limit results to the findings for the specified audit check.

" } }, "taskId": { @@ -14185,16 +14529,22 @@ "smithy.api#documentation": "

A filter to limit results to the audit with the specified ID. You must\n specify either the taskId or the startTime and endTime, but not both.

" } }, - "resourceIdentifier": { - "target": "com.amazonaws.iot#ResourceIdentifier", + "startTime": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

Information identifying the noncompliant resource.

" + "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" } }, - "endTime": { - "target": "com.amazonaws.iot#Timestamp", + "maxResults": { + "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found before the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" + "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" } } } @@ -14241,27 +14591,26 @@ "method": "GET", "uri": "/audit/mitigationactions/executions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "actionsExecutions", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditMitigationActionsExecutionsRequest": { "type": "structure", "members": { - "findingId": { - "target": "com.amazonaws.iot#FindingId", + "taskId": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to those that were applied to a specific audit finding.

", - "smithy.api#httpQuery": "findingId", + "smithy.api#documentation": "

Specify this filter to limit results to actions for a specific audit mitigation actions task.

", + "smithy.api#httpQuery": "taskId", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { @@ -14269,12 +14618,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "taskId": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to actions for a specific audit mitigation actions task.

", - "smithy.api#httpQuery": "taskId", - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" } }, "actionStatus": { @@ -14283,6 +14631,14 @@ "smithy.api#documentation": "

Specify this filter to limit results to those with a specific status.

", "smithy.api#httpQuery": "actionStatus" } + }, + "findingId": { + "target": "com.amazonaws.iot#FindingId", + "traits": { + "smithy.api#documentation": "

Specify this filter to limit results to those that were applied to a specific audit finding.

", + "smithy.api#httpQuery": "findingId", + "smithy.api#required": {} + } } } }, @@ -14328,33 +14684,18 @@ "method": "GET", "uri": "/audit/mitigationactions/tasks", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "tasks", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditMitigationActionsTasksRequest": { "type": "structure", "members": { - "auditTaskId": { - "target": "com.amazonaws.iot#AuditTaskId", - "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to results for a specific audit.

", - "smithy.api#httpQuery": "auditTaskId" - } - }, - "taskStatus": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatus", - "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that are in a specific state.

", - "smithy.api#httpQuery": "taskStatus" - } - }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { @@ -14370,6 +14711,13 @@ "smithy.api#required": {} } }, + "auditTaskId": { + "target": "com.amazonaws.iot#AuditTaskId", + "traits": { + "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to results for a specific audit.

", + "smithy.api#httpQuery": "auditTaskId" + } + }, "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { @@ -14377,6 +14725,13 @@ "smithy.api#httpQuery": "findingId" } }, + "taskStatus": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatus", + "traits": { + "smithy.api#documentation": "

Specify this filter to limit results to tasks that are in a specific state.

", + "smithy.api#httpQuery": "taskStatus" + } + }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { @@ -14384,6 +14739,13 @@ "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -14393,13 +14755,93 @@ "tasks": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskMetadataList", "traits": { - "smithy.api#documentation": "

The collection of audit mitigation tasks that matched the filter criteria.

" + "smithy.api#documentation": "

The collection of audit mitigation tasks that matched the filter criteria.

" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + } + } + }, + "com.amazonaws.iot#ListAuditSuppressions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#ListAuditSuppressionsRequest" + }, + "output": { + "target": "com.amazonaws.iot#ListAuditSuppressionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists your Device Defender audit listings.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/audit/suppressions/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "suppressions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iot#ListAuditSuppressionsRequest": { + "type": "structure", + "members": { + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier" + }, + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName" + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

\n The token for the next set of results.\n

" + } + }, + "maxResults": { + "target": "com.amazonaws.iot#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

" + } + }, + "ascendingOrder": { + "target": "com.amazonaws.iot#AscendingOrder", + "traits": { + "smithy.api#documentation": "

\n Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true.\n

" + } + } + } + }, + "com.amazonaws.iot#ListAuditSuppressionsResponse": { + "type": "structure", + "members": { + "suppressions": { + "target": "com.amazonaws.iot#AuditSuppressionList", + "traits": { + "smithy.api#documentation": "

\n List of audit suppressions.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" + "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } } @@ -14429,40 +14871,39 @@ "method": "GET", "uri": "/audit/tasks", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "tasks", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditTasksRequest": { "type": "structure", "members": { - "taskType": { - "target": "com.amazonaws.iot#AuditTaskType", - "traits": { - "smithy.api#documentation": "

A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

", - "smithy.api#httpQuery": "taskType" - } - }, - "endTime": { - "target": "com.amazonaws.iot#Timestamp", + "maxResults": { + "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "

The end of the time period.

", - "smithy.api#httpQuery": "endTime", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", + "smithy.api#httpQuery": "maxResults" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The beginning of the time period. Audit information is retained for a \n limited time (180 days). Requesting a start time prior to what is retained \n results in an \"InvalidRequestException\".

", + "smithy.api#documentation": "

The beginning of the time period. Audit information is retained for a \n limited time (90 days). Requesting a start time prior to what is retained \n results in an \"InvalidRequestException\".

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } }, - "taskStatus": { - "target": "com.amazonaws.iot#AuditTaskStatus", + "endTime": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit the output to audits with the specified completion\n status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

", - "smithy.api#httpQuery": "taskStatus" + "smithy.api#documentation": "

The end of the time period.

", + "smithy.api#httpQuery": "endTime", + "smithy.api#required": {} } }, "nextToken": { @@ -14472,11 +14913,18 @@ "smithy.api#httpQuery": "nextToken" } }, - "maxResults": { - "target": "com.amazonaws.iot#MaxResults", + "taskType": { + "target": "com.amazonaws.iot#AuditTaskType", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

", + "smithy.api#httpQuery": "taskType" + } + }, + "taskStatus": { + "target": "com.amazonaws.iot#AuditTaskStatus", + "traits": { + "smithy.api#documentation": "

A filter to limit the output to audits with the specified completion\n status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

", + "smithy.api#httpQuery": "taskStatus" } } } @@ -14484,17 +14932,17 @@ "com.amazonaws.iot#ListAuditTasksResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" - } - }, "tasks": { "target": "com.amazonaws.iot#AuditTaskMetadataList", "traits": { "smithy.api#documentation": "

The audits that were performed during the specified time period.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" + } } } }, @@ -14529,19 +14977,18 @@ "method": "GET", "uri": "/authorizers", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "authorizers", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListAuthorizersRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.iot#AuthorizerStatus", - "traits": { - "smithy.api#documentation": "

The status of the list authorizers request.

", - "smithy.api#httpQuery": "status" - } - }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { @@ -14549,36 +14996,43 @@ "smithy.api#httpQuery": "marker" } }, - "pageSize": { - "target": "com.amazonaws.iot#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "pageSize" - } - }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Return the list of authorizers in ascending alphabetical order.

", "smithy.api#httpQuery": "isAscendingOrder" } + }, + "status": { + "target": "com.amazonaws.iot#AuthorizerStatus", + "traits": { + "smithy.api#documentation": "

The status of the list authorizers request.

", + "smithy.api#httpQuery": "status" + } + }, + "pageSize": { + "target": "com.amazonaws.iot#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "pageSize" + } } } }, "com.amazonaws.iot#ListAuthorizersResponse": { "type": "structure", "members": { - "authorizers": { - "target": "com.amazonaws.iot#Authorizers", - "traits": { - "smithy.api#documentation": "

The authorizers.

" - } - }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

" } + }, + "authorizers": { + "target": "com.amazonaws.iot#Authorizers", + "traits": { + "smithy.api#documentation": "

The authorizers.

" + } } } }, @@ -14610,19 +15064,18 @@ "method": "GET", "uri": "/billing-groups", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "billingGroups", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListBillingGroupsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.iot#RegistryMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return per request.

", - "smithy.api#httpQuery": "maxResults" - } - }, "namePrefixFilter": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { @@ -14636,23 +15089,30 @@ "smithy.api#documentation": "

The token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.iot#RegistryMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per request.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.iot#ListBillingGroupsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" - } - }, "billingGroups": { "target": "com.amazonaws.iot#BillingGroupNameAndArnList", "traits": { "smithy.api#documentation": "

The list of billing groups.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" + } } } }, @@ -14687,12 +15147,25 @@ "method": "GET", "uri": "/cacertificates", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "certificates", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListCACertificatesRequest": { "type": "structure", "members": { + "pageSize": { + "target": "com.amazonaws.iot#PageSize", + "traits": { + "smithy.api#documentation": "

The result page size.

", + "smithy.api#httpQuery": "pageSize" + } + }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { @@ -14706,13 +15179,6 @@ "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } - }, - "pageSize": { - "target": "com.amazonaws.iot#PageSize", - "traits": { - "smithy.api#documentation": "

The result page size.

", - "smithy.api#httpQuery": "pageSize" - } } }, "traits": { @@ -14722,17 +15188,17 @@ "com.amazonaws.iot#ListCACertificatesResponse": { "type": "structure", "members": { - "certificates": { - "target": "com.amazonaws.iot#CACertificates", - "traits": { - "smithy.api#documentation": "

The CA certificates registered in your AWS account.

" - } - }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The current position within the list of CA certificates.

" } + }, + "certificates": { + "target": "com.amazonaws.iot#CACertificates", + "traits": { + "smithy.api#documentation": "

The CA certificates registered in your AWS account.

" + } } }, "traits": { @@ -14770,6 +15236,12 @@ "method": "GET", "uri": "/certificates", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "certificates", + "pageSize": "pageSize" } } }, @@ -14804,17 +15276,24 @@ "method": "GET", "uri": "/certificates-by-ca/{caCertificateId}", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "certificates", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListCertificatesByCARequest": { "type": "structure", "members": { - "pageSize": { - "target": "com.amazonaws.iot#PageSize", + "caCertificateId": { + "target": "com.amazonaws.iot#CertificateId", "traits": { - "smithy.api#documentation": "

The result page size.

", - "smithy.api#httpQuery": "pageSize" + "smithy.api#documentation": "

The ID of the CA certificate. This operation will list all registered device\n certificate that were signed by this CA certificate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "marker": { @@ -14831,12 +15310,11 @@ "smithy.api#httpQuery": "isAscendingOrder" } }, - "caCertificateId": { - "target": "com.amazonaws.iot#CertificateId", + "pageSize": { + "target": "com.amazonaws.iot#PageSize", "traits": { - "smithy.api#documentation": "

The ID of the CA certificate. This operation will list all registered device\n certificate that were signed by this CA certificate.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The result page size.

", + "smithy.api#httpQuery": "pageSize" } } }, @@ -14867,6 +15345,13 @@ "com.amazonaws.iot#ListCertificatesRequest": { "type": "structure", "members": { + "marker": { + "target": "com.amazonaws.iot#Marker", + "traits": { + "smithy.api#documentation": "

The marker for the next set of results.

", + "smithy.api#httpQuery": "marker" + } + }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { @@ -14880,13 +15365,6 @@ "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } - }, - "marker": { - "target": "com.amazonaws.iot#Marker", - "traits": { - "smithy.api#documentation": "

The marker for the next set of results.

", - "smithy.api#httpQuery": "marker" - } } }, "traits": { @@ -14896,17 +15374,17 @@ "com.amazonaws.iot#ListCertificatesResponse": { "type": "structure", "members": { - "nextMarker": { - "target": "com.amazonaws.iot#Marker", - "traits": { - "smithy.api#documentation": "

The marker for the next set of results, or null if there are no additional\n results.

" - } - }, "certificates": { "target": "com.amazonaws.iot#Certificates", "traits": { "smithy.api#documentation": "

The descriptions of the certificates.

" } + }, + "nextMarker": { + "target": "com.amazonaws.iot#Marker", + "traits": { + "smithy.api#documentation": "

The marker for the next set of results, or null if there are no additional\n results.

" + } } }, "traits": { @@ -14938,6 +15416,12 @@ "method": "GET", "uri": "/dimensions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "dimensionNames", + "pageSize": "maxResults" } } }, @@ -15008,17 +15492,23 @@ "method": "GET", "uri": "/domainConfigurations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "domainConfigurations", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListDomainConfigurationsRequest": { "type": "structure", "members": { - "marker": { - "target": "com.amazonaws.iot#Marker", + "pageSize": { + "target": "com.amazonaws.iot#PageSize", "traits": { - "smithy.api#documentation": "

The marker for the next set of results.

", - "smithy.api#httpQuery": "marker" + "smithy.api#documentation": "

The result page size.

", + "smithy.api#httpQuery": "pageSize" } }, "serviceType": { @@ -15028,11 +15518,11 @@ "smithy.api#httpQuery": "serviceType" } }, - "pageSize": { - "target": "com.amazonaws.iot#PageSize", + "marker": { + "target": "com.amazonaws.iot#Marker", "traits": { - "smithy.api#documentation": "

The result page size.

", - "smithy.api#httpQuery": "pageSize" + "smithy.api#documentation": "

The marker for the next set of results.

", + "smithy.api#httpQuery": "marker" } } } @@ -15085,6 +15575,12 @@ "method": "GET", "uri": "/indices", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "indexNames", + "pageSize": "maxResults" } } }, @@ -15152,12 +15648,25 @@ "method": "GET", "uri": "/jobs/{jobId}/things", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "executionSummaries", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListJobExecutionsForJobRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, "maxResults": { "target": "com.amazonaws.iot#LaserMaxResults", "traits": { @@ -15165,14 +15674,6 @@ "smithy.api#httpQuery": "maxResults" } }, - "jobId": { - "target": "com.amazonaws.iot#JobId", - "traits": { - "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "status": { "target": "com.amazonaws.iot#JobExecutionStatus", "traits": { @@ -15180,11 +15681,12 @@ "smithy.api#httpQuery": "status" } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", + "jobId": { + "target": "com.amazonaws.iot#JobId", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -15234,6 +15736,12 @@ "method": "GET", "uri": "/things/{thingName}/jobs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "executionSummaries", + "pageSize": "maxResults" } } }, @@ -15274,17 +15782,17 @@ "com.amazonaws.iot#ListJobExecutionsForThingResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" - } - }, "executionSummaries": { "target": "com.amazonaws.iot#JobExecutionSummaryForThingList", "traits": { "smithy.api#documentation": "

A list of job execution summaries.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" + } } } }, @@ -15316,12 +15824,32 @@ "method": "GET", "uri": "/jobs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobs", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListJobsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.iot#LaserMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "thingGroupId": { + "target": "com.amazonaws.iot#ThingGroupId", + "traits": { + "smithy.api#documentation": "

A filter that limits the returned jobs to those for the specified group.

", + "smithy.api#httpQuery": "thingGroupId" + } + }, "status": { "target": "com.amazonaws.iot#JobStatus", "traits": { @@ -15329,11 +15857,11 @@ "smithy.api#httpQuery": "status" } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

A filter that limits the returned jobs to those for the specified group.

", + "smithy.api#httpQuery": "thingGroupName" } }, "targetSelection": { @@ -15343,25 +15871,11 @@ "smithy.api#httpQuery": "targetSelection" } }, - "maxResults": { - "target": "com.amazonaws.iot#LaserMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return per request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", - "traits": { - "smithy.api#documentation": "

A filter that limits the returned jobs to those for the specified group.

", - "smithy.api#httpQuery": "thingGroupName" - } - }, - "thingGroupId": { - "target": "com.amazonaws.iot#ThingGroupId", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A filter that limits the returned jobs to those for the specified group.

", - "smithy.api#httpQuery": "thingGroupId" + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -15369,17 +15883,17 @@ "com.amazonaws.iot#ListJobsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" - } - }, "jobs": { "target": "com.amazonaws.iot#JobSummaryList", "traits": { "smithy.api#documentation": "

A list of jobs.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" + } } } }, @@ -15408,19 +15922,18 @@ "method": "GET", "uri": "/mitigationactions/actions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "actionIdentifiers", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListMitigationActionsRequest": { "type": "structure", "members": { - "actionType": { - "target": "com.amazonaws.iot#MitigationActionType", - "traits": { - "smithy.api#documentation": "

Specify a value to limit the result to mitigation actions with a specific action type.

", - "smithy.api#httpQuery": "actionType" - } - }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { @@ -15434,23 +15947,30 @@ "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "actionType": { + "target": "com.amazonaws.iot#MitigationActionType", + "traits": { + "smithy.api#documentation": "

Specify a value to limit the result to mitigation actions with a specific action type.

", + "smithy.api#httpQuery": "actionType" + } } } }, "com.amazonaws.iot#ListMitigationActionsResponse": { "type": "structure", "members": { - "actionIdentifiers": { - "target": "com.amazonaws.iot#MitigationActionIdentifierList", - "traits": { - "smithy.api#documentation": "

A set of actions that matched the specified filter criteria.

" - } - }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

" } + }, + "actionIdentifiers": { + "target": "com.amazonaws.iot#MitigationActionIdentifierList", + "traits": { + "smithy.api#documentation": "

A set of actions that matched the specified filter criteria.

" + } } } }, @@ -15485,17 +16005,23 @@ "method": "GET", "uri": "/otaUpdates", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "otaUpdates", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListOTAUpdatesRequest": { "type": "structure", "members": { - "otaUpdateStatus": { - "target": "com.amazonaws.iot#OTAUpdateStatus", + "maxResults": { + "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "

The OTA update job status.

", - "smithy.api#httpQuery": "otaUpdateStatus" + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" } }, "nextToken": { @@ -15505,11 +16031,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "maxResults": { - "target": "com.amazonaws.iot#MaxResults", + "otaUpdateStatus": { + "target": "com.amazonaws.iot#OTAUpdateStatus", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The OTA update job status.

", + "smithy.api#httpQuery": "otaUpdateStatus" } } } @@ -15517,17 +16043,17 @@ "com.amazonaws.iot#ListOTAUpdatesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use to get the next set of results.

" - } - }, "otaUpdates": { "target": "com.amazonaws.iot#OTAUpdatesSummary", "traits": { "smithy.api#documentation": "

A list of OTA update jobs.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use to get the next set of results.

" + } } } }, @@ -15562,17 +16088,23 @@ "method": "GET", "uri": "/certificates-out-going", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "outgoingCertificates", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListOutgoingCertificatesRequest": { "type": "structure", "members": { - "ascendingOrder": { - "target": "com.amazonaws.iot#AscendingOrder", + "pageSize": { + "target": "com.amazonaws.iot#PageSize", "traits": { - "smithy.api#documentation": "

Specifies the order for results. If True, the results are returned in ascending\n order, based on the creation date.

", - "smithy.api#httpQuery": "isAscendingOrder" + "smithy.api#documentation": "

The result page size.

", + "smithy.api#httpQuery": "pageSize" } }, "marker": { @@ -15582,11 +16114,11 @@ "smithy.api#httpQuery": "marker" } }, - "pageSize": { - "target": "com.amazonaws.iot#PageSize", + "ascendingOrder": { + "target": "com.amazonaws.iot#AscendingOrder", "traits": { - "smithy.api#documentation": "

The result page size.

", - "smithy.api#httpQuery": "pageSize" + "smithy.api#documentation": "

Specifies the order for results. If True, the results are returned in ascending\n order, based on the creation date.

", + "smithy.api#httpQuery": "isAscendingOrder" } } }, @@ -15597,17 +16129,17 @@ "com.amazonaws.iot#ListOutgoingCertificatesResponse": { "type": "structure", "members": { - "nextMarker": { - "target": "com.amazonaws.iot#Marker", - "traits": { - "smithy.api#documentation": "

The marker for the next set of results.

" - } - }, "outgoingCertificates": { "target": "com.amazonaws.iot#OutgoingCertificates", "traits": { "smithy.api#documentation": "

The certificates that are being transferred but not yet accepted.

" } + }, + "nextMarker": { + "target": "com.amazonaws.iot#Marker", + "traits": { + "smithy.api#documentation": "

The marker for the next set of results.

" + } } }, "traits": { @@ -15645,17 +16177,23 @@ "method": "GET", "uri": "/policies", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "policies", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListPoliciesRequest": { "type": "structure", "members": { - "pageSize": { - "target": "com.amazonaws.iot#PageSize", + "ascendingOrder": { + "target": "com.amazonaws.iot#AscendingOrder", "traits": { - "smithy.api#documentation": "

The result page size.

", - "smithy.api#httpQuery": "pageSize" + "smithy.api#documentation": "

Specifies the order for results. If true, the results are returned in ascending\n creation order.

", + "smithy.api#httpQuery": "isAscendingOrder" } }, "marker": { @@ -15665,11 +16203,11 @@ "smithy.api#httpQuery": "marker" } }, - "ascendingOrder": { - "target": "com.amazonaws.iot#AscendingOrder", + "pageSize": { + "target": "com.amazonaws.iot#PageSize", "traits": { - "smithy.api#documentation": "

Specifies the order for results. If true, the results are returned in ascending\n creation order.

", - "smithy.api#httpQuery": "isAscendingOrder" + "smithy.api#documentation": "

The result page size.

", + "smithy.api#httpQuery": "pageSize" } } }, @@ -15732,12 +16270,32 @@ "method": "GET", "uri": "/policy-principals", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "principals", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListPolicyPrincipalsRequest": { "type": "structure", "members": { + "ascendingOrder": { + "target": "com.amazonaws.iot#AscendingOrder", + "traits": { + "smithy.api#documentation": "

Specifies the order for results. If true, the results are returned in ascending\n creation order.

", + "smithy.api#httpQuery": "isAscendingOrder" + } + }, + "marker": { + "target": "com.amazonaws.iot#Marker", + "traits": { + "smithy.api#documentation": "

The marker for the next set of results.

", + "smithy.api#httpQuery": "marker" + } + }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { @@ -15752,20 +16310,6 @@ "smithy.api#httpHeader": "x-amzn-iot-policy", "smithy.api#required": {} } - }, - "ascendingOrder": { - "target": "com.amazonaws.iot#AscendingOrder", - "traits": { - "smithy.api#documentation": "

Specifies the order for results. If true, the results are returned in ascending\n creation order.

", - "smithy.api#httpQuery": "isAscendingOrder" - } - }, - "marker": { - "target": "com.amazonaws.iot#Marker", - "traits": { - "smithy.api#documentation": "

The marker for the next set of results.

", - "smithy.api#httpQuery": "marker" - } } }, "traits": { @@ -15894,6 +16438,12 @@ "method": "GET", "uri": "/principal-policies", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "policies", + "pageSize": "pageSize" } } }, @@ -15907,26 +16457,26 @@ "smithy.api#httpQuery": "marker" } }, - "pageSize": { - "target": "com.amazonaws.iot#PageSize", + "ascendingOrder": { + "target": "com.amazonaws.iot#AscendingOrder", "traits": { - "smithy.api#documentation": "

The result page size.

", - "smithy.api#httpQuery": "pageSize" + "smithy.api#documentation": "

Specifies the order for results. If true, results are returned in ascending creation\n order.

", + "smithy.api#httpQuery": "isAscendingOrder" } }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { - "smithy.api#documentation": "

The principal.

", + "smithy.api#documentation": "

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

", "smithy.api#httpHeader": "x-amzn-iot-principal", "smithy.api#required": {} } }, - "ascendingOrder": { - "target": "com.amazonaws.iot#AscendingOrder", + "pageSize": { + "target": "com.amazonaws.iot#PageSize", "traits": { - "smithy.api#documentation": "

Specifies the order for results. If true, results are returned in ascending creation\n order.

", - "smithy.api#httpQuery": "isAscendingOrder" + "smithy.api#documentation": "

The result page size.

", + "smithy.api#httpQuery": "pageSize" } } }, @@ -15988,18 +16538,23 @@ "method": "GET", "uri": "/principals/things", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "things", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListPrincipalThingsRequest": { "type": "structure", "members": { - "principal": { - "target": "com.amazonaws.iot#Principal", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The principal.

", - "smithy.api#httpHeader": "x-amzn-principal", - "smithy.api#required": {} + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" } }, "maxResults": { @@ -16009,11 +16564,12 @@ "smithy.api#httpQuery": "maxResults" } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", + "principal": { + "target": "com.amazonaws.iot#Principal", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The principal.

", + "smithy.api#httpHeader": "x-amzn-principal", + "smithy.api#required": {} } } }, @@ -16024,17 +16580,17 @@ "com.amazonaws.iot#ListPrincipalThingsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" - } - }, "things": { "target": "com.amazonaws.iot#ThingNameList", "traits": { "smithy.api#documentation": "

The things.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" + } } }, "traits": { @@ -16072,12 +16628,25 @@ "method": "GET", "uri": "/provisioning-templates/{templateName}/versions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "versions", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListProvisioningTemplateVersionsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.iot#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" + } + }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { @@ -16092,30 +16661,23 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "maxResults": { - "target": "com.amazonaws.iot#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "maxResults" - } } } }, "com.amazonaws.iot#ListProvisioningTemplateVersionsResponse": { "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

A token to retrieve the next set of results.

" - } - }, + "members": { "versions": { "target": "com.amazonaws.iot#ProvisioningTemplateVersionListing", "traits": { "smithy.api#documentation": "

The list of fleet provisioning template versions.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

A token to retrieve the next set of results.

" + } } } }, @@ -16147,6 +16709,12 @@ "method": "GET", "uri": "/provisioning-templates", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "templates", + "pageSize": "maxResults" } } }, @@ -16172,17 +16740,17 @@ "com.amazonaws.iot#ListProvisioningTemplatesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

A token to retrieve the next set of results.

" - } - }, "templates": { "target": "com.amazonaws.iot#ProvisioningTemplateListing", "traits": { "smithy.api#documentation": "

A list of fleet provisioning templates

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

A token to retrieve the next set of results.

" + } } } }, @@ -16217,12 +16785,25 @@ "method": "GET", "uri": "/role-aliases", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "roleAliases", + "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListRoleAliasesRequest": { "type": "structure", "members": { + "marker": { + "target": "com.amazonaws.iot#Marker", + "traits": { + "smithy.api#documentation": "

A marker used to get the next set of results.

", + "smithy.api#httpQuery": "marker" + } + }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { @@ -16236,30 +16817,23 @@ "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "pageSize" } - }, - "marker": { - "target": "com.amazonaws.iot#Marker", - "traits": { - "smithy.api#documentation": "

A marker used to get the next set of results.

", - "smithy.api#httpQuery": "marker" - } } } }, "com.amazonaws.iot#ListRoleAliasesResponse": { "type": "structure", "members": { - "roleAliases": { - "target": "com.amazonaws.iot#RoleAliases", - "traits": { - "smithy.api#documentation": "

The role aliases.

" - } - }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

" } + }, + "roleAliases": { + "target": "com.amazonaws.iot#RoleAliases", + "traits": { + "smithy.api#documentation": "

The role aliases.

" + } } } }, @@ -16288,42 +16862,48 @@ "method": "GET", "uri": "/audit/scheduledaudits", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "scheduledAudits", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListScheduledAuditsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, "com.amazonaws.iot#ListScheduledAuditsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" - } - }, "scheduledAudits": { "target": "com.amazonaws.iot#ScheduledAuditMetadataList", "traits": { "smithy.api#documentation": "

The list of scheduled audits.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" + } } } }, @@ -16355,6 +16935,12 @@ "method": "GET", "uri": "/security-profiles", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "securityProfileIdentifiers", + "pageSize": "maxResults" } } }, @@ -16386,17 +16972,23 @@ "method": "GET", "uri": "/security-profiles-for-target", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "securityProfileTargetMappings", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListSecurityProfilesForTargetRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.iot#MaxResults", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" } }, "recursive": { @@ -16406,13 +16998,6 @@ "smithy.api#httpQuery": "recursive" } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "securityProfileTargetArn": { "target": "com.amazonaws.iot#SecurityProfileTargetArn", "traits": { @@ -16420,34 +17005,41 @@ "smithy.api#httpQuery": "securityProfileTargetArn", "smithy.api#required": {} } + }, + "maxResults": { + "target": "com.amazonaws.iot#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.iot#ListSecurityProfilesForTargetResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" - } - }, "securityProfileTargetMappings": { "target": "com.amazonaws.iot#SecurityProfileTargetMappings", "traits": { "smithy.api#documentation": "

A list of security profiles and their associated targets.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" + } } } }, "com.amazonaws.iot#ListSecurityProfilesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", + "dimensionName": { + "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

A filter to limit results to the security profiles that use the defined dimension.

", + "smithy.api#httpQuery": "dimensionName" } }, "maxResults": { @@ -16457,11 +17049,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "dimensionName": { - "target": "com.amazonaws.iot#DimensionName", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A filter to limit results to the security profiles that use the defined dimension.

", - "smithy.api#httpQuery": "dimensionName" + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -16514,6 +17106,12 @@ "method": "GET", "uri": "/streams", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "streams", + "pageSize": "maxResults" } } }, @@ -16560,6 +17158,9 @@ } } }, + "com.amazonaws.iot#ListSuppressedFindings": { + "type": "boolean" + }, "com.amazonaws.iot#ListTagsForResource": { "type": "operation", "input": { @@ -16588,6 +17189,11 @@ "method": "GET", "uri": "/tags", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "tags" } } }, @@ -16665,6 +17271,12 @@ "method": "POST", "uri": "/policy-targets/{policyName}", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "marker", + "outputToken": "nextMarker", + "items": "targets", + "pageSize": "pageSize" } } }, @@ -16679,36 +17291,36 @@ "smithy.api#required": {} } }, - "pageSize": { - "target": "com.amazonaws.iot#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "pageSize" - } - }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

", "smithy.api#httpQuery": "marker" } + }, + "pageSize": { + "target": "com.amazonaws.iot#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "pageSize" + } } } }, "com.amazonaws.iot#ListTargetsForPolicyResponse": { "type": "structure", "members": { - "targets": { - "target": "com.amazonaws.iot#PolicyTargets", - "traits": { - "smithy.api#documentation": "

The policy targets.

" - } - }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

" } + }, + "targets": { + "target": "com.amazonaws.iot#PolicyTargets", + "traits": { + "smithy.api#documentation": "

The policy targets.

" + } } } }, @@ -16740,6 +17352,12 @@ "method": "GET", "uri": "/security-profiles/{securityProfileName}/targets", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "securityProfileTargets", + "pageSize": "maxResults" } } }, @@ -16754,36 +17372,36 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, "com.amazonaws.iot#ListTargetsForSecurityProfileResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" - } - }, "securityProfileTargets": { "target": "com.amazonaws.iot#SecurityProfileTargets", "traits": { "smithy.api#documentation": "

The thing groups to which the security profile is attached.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" + } } } }, @@ -16812,6 +17430,12 @@ "method": "GET", "uri": "/thing-groups", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "thingGroups", + "pageSize": "maxResults" } } }, @@ -16840,19 +17464,18 @@ "method": "GET", "uri": "/things/{thingName}/thing-groups", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "thingGroups", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingGroupsForThingRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.iot#RegistryMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "maxResults" - } - }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { @@ -16867,6 +17490,13 @@ "smithy.api#documentation": "

The token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.iot#RegistryMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -16933,7 +17563,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" + "smithy.api#documentation": "

The token used to get the next set of results. Will not be returned if operation has returned all results.

" } }, "thingGroups": { @@ -17039,19 +17669,18 @@ "method": "GET", "uri": "/thing-registration-tasks/{taskId}/reports", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "resourceLinks", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingRegistrationTaskReportsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.iot#RegistryMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return per request.

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { @@ -17074,18 +17703,19 @@ "smithy.api#httpQuery": "reportType", "smithy.api#required": {} } + }, + "maxResults": { + "target": "com.amazonaws.iot#RegistryMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per request.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.iot#ListThingRegistrationTaskReportsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" - } - }, "reportType": { "target": "com.amazonaws.iot#ReportType", "traits": { @@ -17097,6 +17727,12 @@ "traits": { "smithy.api#documentation": "

Links to the task resources.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" + } } } }, @@ -17128,6 +17764,12 @@ "method": "GET", "uri": "/thing-registration-tasks", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "taskIds", + "pageSize": "maxResults" } } }, @@ -17160,17 +17802,17 @@ "com.amazonaws.iot#ListThingRegistrationTasksResponse": { "type": "structure", "members": { - "taskIds": { - "target": "com.amazonaws.iot#TaskIdList", - "traits": { - "smithy.api#documentation": "

A list of bulk thing provisioning task IDs.

" - } - }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" } + }, + "taskIds": { + "target": "com.amazonaws.iot#TaskIdList", + "traits": { + "smithy.api#documentation": "

A list of bulk thing provisioning task IDs.

" + } } } }, @@ -17205,19 +17847,18 @@ "method": "GET", "uri": "/thing-types", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "thingTypes", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingTypesRequest": { "type": "structure", "members": { - "thingTypeName": { - "target": "com.amazonaws.iot#ThingTypeName", - "traits": { - "smithy.api#documentation": "

The name of the thing type.

", - "smithy.api#httpQuery": "thingTypeName" - } - }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { @@ -17231,6 +17872,13 @@ "smithy.api#documentation": "

The maximum number of results to return in this operation.

", "smithy.api#httpQuery": "maxResults" } + }, + "thingTypeName": { + "target": "com.amazonaws.iot#ThingTypeName", + "traits": { + "smithy.api#documentation": "

The name of the thing type.

", + "smithy.api#httpQuery": "thingTypeName" + } } }, "traits": { @@ -17240,16 +17888,16 @@ "com.amazonaws.iot#ListThingTypesResponse": { "type": "structure", "members": { - "thingTypes": { - "target": "com.amazonaws.iot#ThingTypeList", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The thing types.

" + "smithy.api#documentation": "

The token for the next set of results. Will not be returned if operation has returned all results.

" } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", + "thingTypes": { + "target": "com.amazonaws.iot#ThingTypeList", "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if\n\t\t\tthere are no additional results.

" + "smithy.api#documentation": "

The thing types.

" } } }, @@ -17283,11 +17931,17 @@ } ], "traits": { - "smithy.api#documentation": "

Lists your things. Use the attributeName and\n\t\t\t\tattributeValue parameters to filter your things.\n\t\t\tFor example, calling ListThings with attributeName=Color and\n\t\t\tattributeValue=Red retrieves all things in the registry that contain an attribute\n\t\t\t\tColor with the value Red.

", + "smithy.api#documentation": "

Lists your things. Use the attributeName and\n\t\t\t\tattributeValue parameters to filter your things.\n\t\t\tFor example, calling ListThings with attributeName=Color and\n\t\t\tattributeValue=Red retrieves all things in the registry that contain an attribute\n\t\t\t\tColor with the value Red.

\n\t\t \n\t\t\t

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

\n\t\t ", "smithy.api#http": { "method": "GET", "uri": "/things", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "things", + "pageSize": "maxResults" } } }, @@ -17319,20 +17973,18 @@ "method": "GET", "uri": "/billing-groups/{billingGroupName}/things", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "things", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingsInBillingGroupRequest": { "type": "structure", "members": { - "billingGroupName": { - "target": "com.amazonaws.iot#BillingGroupName", - "traits": { - "smithy.api#documentation": "

The name of the billing group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { @@ -17346,23 +17998,31 @@ "smithy.api#documentation": "

The maximum number of results to return per request.

", "smithy.api#httpQuery": "maxResults" } + }, + "billingGroupName": { + "target": "com.amazonaws.iot#BillingGroupName", + "traits": { + "smithy.api#documentation": "

The name of the billing group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.iot#ListThingsInBillingGroupResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" - } - }, "things": { "target": "com.amazonaws.iot#ThingNameList", "traits": { "smithy.api#documentation": "

A list of things in the billing group.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token used to get the next set of results. Will not be returned if operation has returned all results.

" + } } } }, @@ -17391,24 +18051,23 @@ "method": "GET", "uri": "/thing-groups/{thingGroupName}/things", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "things", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingsInThingGroupRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "recursive": { - "target": "com.amazonaws.iot#Recursive", + "maxResults": { + "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { - "smithy.api#documentation": "

When true, list things in this thing group and in all child groups as\n\t\t\twell.

", - "smithy.api#httpQuery": "recursive" + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" } }, "thingGroupName": { @@ -17419,11 +18078,18 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.iot#RegistryMaxResults", + "nextToken": { + "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "recursive": { + "target": "com.amazonaws.iot#Recursive", + "traits": { + "smithy.api#documentation": "

When true, list things in this thing group and in all child groups as\n\t\t\twell.

", + "smithy.api#httpQuery": "recursive" } } } @@ -17448,13 +18114,6 @@ "com.amazonaws.iot#ListThingsRequest": { "type": "structure", "members": { - "attributeValue": { - "target": "com.amazonaws.iot#AttributeValue", - "traits": { - "smithy.api#documentation": "

The attribute value used to search for things.

", - "smithy.api#httpQuery": "attributeValue" - } - }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { @@ -17476,6 +18135,13 @@ "smithy.api#httpQuery": "nextToken" } }, + "attributeValue": { + "target": "com.amazonaws.iot#AttributeValue", + "traits": { + "smithy.api#documentation": "

The attribute value used to search for things.

", + "smithy.api#httpQuery": "attributeValue" + } + }, "attributeName": { "target": "com.amazonaws.iot#AttributeName", "traits": { @@ -17491,17 +18157,17 @@ "com.amazonaws.iot#ListThingsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional results.

" - } - }, "things": { "target": "com.amazonaws.iot#ThingAttributeList", "traits": { "smithy.api#documentation": "

The things.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token used to get the next set of results. Will not be returned if operation has returned all results.

" + } } }, "traits": { @@ -17536,42 +18202,48 @@ "method": "GET", "uri": "/destinations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "destinationSummaries", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListTopicRuleDestinationsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iot#TopicRuleDestinationMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, "com.amazonaws.iot#ListTopicRuleDestinationsResponse": { "type": "structure", "members": { - "destinationSummaries": { - "target": "com.amazonaws.iot#TopicRuleDestinationSummaries", - "traits": { - "smithy.api#documentation": "

Information about a topic rule destination.

" - } - }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results.

" } + }, + "destinationSummaries": { + "target": "com.amazonaws.iot#TopicRuleDestinationSummaries", + "traits": { + "smithy.api#documentation": "

Information about a topic rule destination.

" + } } } }, @@ -17600,12 +18272,25 @@ "method": "GET", "uri": "/rules", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "rules", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListTopicRulesRequest": { "type": "structure", "members": { + "ruleDisabled": { + "target": "com.amazonaws.iot#IsDisabled", + "traits": { + "smithy.api#documentation": "

Specifies whether the rule is disabled.

", + "smithy.api#httpQuery": "ruleDisabled" + } + }, "topic": { "target": "com.amazonaws.iot#Topic", "traits": { @@ -17620,13 +18305,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "ruleDisabled": { - "target": "com.amazonaws.iot#IsDisabled", - "traits": { - "smithy.api#documentation": "

Specifies whether the rule is disabled.

", - "smithy.api#httpQuery": "ruleDisabled" - } - }, "maxResults": { "target": "com.amazonaws.iot#TopicRuleMaxResults", "traits": { @@ -17687,12 +18365,25 @@ "method": "GET", "uri": "/v2LoggingLevel", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logTargetConfigurations", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListV2LoggingLevelsRequest": { "type": "structure", "members": { + "targetType": { + "target": "com.amazonaws.iot#LogTargetType", + "traits": { + "smithy.api#documentation": "

The type of resource for which you are configuring logging. Must be\n THING_Group.

", + "smithy.api#httpQuery": "targetType" + } + }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { @@ -17706,13 +18397,6 @@ "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } - }, - "targetType": { - "target": "com.amazonaws.iot#LogTargetType", - "traits": { - "smithy.api#documentation": "

The type of resource for which you are configuring logging. Must be\n THING_Group.

", - "smithy.api#httpQuery": "targetType" - } } } }, @@ -17758,25 +18442,23 @@ "method": "GET", "uri": "/violation-events", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "violationEvents", + "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListViolationEventsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.iot#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "endTime": { - "target": "com.amazonaws.iot#Timestamp", + "thingName": { + "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { - "smithy.api#documentation": "

The end time for the alerts to be listed.

", - "smithy.api#httpQuery": "endTime", - "smithy.api#required": {} + "smithy.api#documentation": "

A filter to limit results to those alerts caused by the specified thing.

", + "smithy.api#httpQuery": "thingName" } }, "securityProfileName": { @@ -17786,13 +18468,6 @@ "smithy.api#httpQuery": "securityProfileName" } }, - "thingName": { - "target": "com.amazonaws.iot#DeviceDefenderThingName", - "traits": { - "smithy.api#documentation": "

A filter to limit results to those alerts caused by the specified thing.

", - "smithy.api#httpQuery": "thingName" - } - }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { @@ -17807,6 +18482,21 @@ "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.iot#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "endTime": { + "target": "com.amazonaws.iot#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time for the alerts to be listed.

", + "smithy.api#httpQuery": "endTime", + "smithy.api#required": {} + } } } }, @@ -17860,18 +18550,18 @@ "com.amazonaws.iot#LogTarget": { "type": "structure", "members": { - "targetName": { - "target": "com.amazonaws.iot#LogTargetName", - "traits": { - "smithy.api#documentation": "

The target name.

" - } - }, "targetType": { "target": "com.amazonaws.iot#LogTargetType", "traits": { "smithy.api#documentation": "

The target type.

", "smithy.api#required": {} } + }, + "targetName": { + "target": "com.amazonaws.iot#LogTargetName", + "traits": { + "smithy.api#documentation": "

The target name.

" + } } }, "traits": { @@ -17925,18 +18615,18 @@ "com.amazonaws.iot#LoggingOptionsPayload": { "type": "structure", "members": { + "logLevel": { + "target": "com.amazonaws.iot#LogLevel", + "traits": { + "smithy.api#documentation": "

The log level.

" + } + }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", "smithy.api#required": {} } - }, - "logLevel": { - "target": "com.amazonaws.iot#LogLevel", - "traits": { - "smithy.api#documentation": "

The log level.

" - } } }, "traits": { @@ -17962,6 +18652,10 @@ "com.amazonaws.iot#Marker": { "type": "string", "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, "smithy.api#pattern": "[A-Za-z0-9+/]+={0,2}" } }, @@ -18076,6 +18770,12 @@ "com.amazonaws.iot#MetricValue": { "type": "structure", "members": { + "count": { + "target": "com.amazonaws.iot#UnsignedLong", + "traits": { + "smithy.api#documentation": "

If the comparisonOperator calls for a numeric value, use this \n to specify that numeric value to be compared with the metric.

" + } + }, "ports": { "target": "com.amazonaws.iot#Ports", "traits": { @@ -18087,12 +18787,6 @@ "traits": { "smithy.api#documentation": "

If the comparisonOperator calls for a set of CIDRs, use this\n to specify that set to be compared with the metric.

" } - }, - "count": { - "target": "com.amazonaws.iot#UnsignedLong", - "traits": { - "smithy.api#documentation": "

If the comparisonOperator calls for a numeric value, use this \n to specify that numeric value to be compared with the metric.

" - } } }, "traits": { @@ -18123,12 +18817,6 @@ "com.amazonaws.iot#MitigationAction": { "type": "structure", "members": { - "actionParams": { - "target": "com.amazonaws.iot#MitigationActionParams", - "traits": { - "smithy.api#documentation": "

The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

" - } - }, "id": { "target": "com.amazonaws.iot#MitigationActionId", "traits": { @@ -18141,6 +18829,12 @@ "smithy.api#documentation": "

The IAM role ARN used to apply this mitigation action.

" } }, + "actionParams": { + "target": "com.amazonaws.iot#MitigationActionParams", + "traits": { + "smithy.api#documentation": "

The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

" + } + }, "name": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { @@ -18161,6 +18855,12 @@ "com.amazonaws.iot#MitigationActionIdentifier": { "type": "structure", "members": { + "creationDate": { + "target": "com.amazonaws.iot#Timestamp", + "traits": { + "smithy.api#documentation": "

The date when this mitigation action was created.

" + } + }, "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { @@ -18168,15 +18868,9 @@ } }, "actionArn": { - "target": "com.amazonaws.iot#MitigationActionArn", - "traits": { - "smithy.api#documentation": "

The IAM role ARN used to apply this mitigation action.

" - } - }, - "creationDate": { - "target": "com.amazonaws.iot#Timestamp", + "target": "com.amazonaws.iot#MitigationActionArn", "traits": { - "smithy.api#documentation": "

The date when this mitigation action was created.

" + "smithy.api#documentation": "

The IAM role ARN used to apply this mitigation action.

" } } }, @@ -18221,10 +18915,16 @@ "com.amazonaws.iot#MitigationActionParams": { "type": "structure", "members": { - "addThingsToThingGroupParams": { - "target": "com.amazonaws.iot#AddThingsToThingGroupParams", + "updateCACertificateParams": { + "target": "com.amazonaws.iot#UpdateCACertificateParams", "traits": { - "smithy.api#documentation": "

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

" + "smithy.api#documentation": "

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

" + } + }, + "replaceDefaultPolicyVersionParams": { + "target": "com.amazonaws.iot#ReplaceDefaultPolicyVersionParams", + "traits": { + "smithy.api#documentation": "

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

" } }, "updateDeviceCertificateParams": { @@ -18245,16 +18945,10 @@ "smithy.api#documentation": "

Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

" } }, - "updateCACertificateParams": { - "target": "com.amazonaws.iot#UpdateCACertificateParams", - "traits": { - "smithy.api#documentation": "

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

" - } - }, - "replaceDefaultPolicyVersionParams": { - "target": "com.amazonaws.iot#ReplaceDefaultPolicyVersionParams", + "addThingsToThingGroupParams": { + "target": "com.amazonaws.iot#AddThingsToThingGroupParams", "traits": { - "smithy.api#documentation": "

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

" + "smithy.api#documentation": "

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

" } } }, @@ -18305,18 +18999,18 @@ "com.amazonaws.iot#MqttContext": { "type": "structure", "members": { - "username": { - "target": "com.amazonaws.iot#MqttUsername", - "traits": { - "smithy.api#documentation": "

The value of the username key in an MQTT authorization request.

" - } - }, "clientId": { "target": "com.amazonaws.iot#MqttClientId", "traits": { "smithy.api#documentation": "

The value of the clientId key in an MQTT authorization request.

" } }, + "username": { + "target": "com.amazonaws.iot#MqttUsername", + "traits": { + "smithy.api#documentation": "

The value of the username key in an MQTT authorization request.

" + } + }, "password": { "target": "com.amazonaws.iot#MqttPassword", "traits": { @@ -18358,18 +19052,18 @@ "com.amazonaws.iot#NonCompliantResource": { "type": "structure", "members": { - "additionalInfo": { - "target": "com.amazonaws.iot#StringMap", - "traits": { - "smithy.api#documentation": "

Other information about the noncompliant resource.

" - } - }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#documentation": "

Information that identifies the noncompliant resource.

" } }, + "additionalInfo": { + "target": "com.amazonaws.iot#StringMap", + "traits": { + "smithy.api#documentation": "

Other information about the noncompliant resource.

" + } + }, "resourceType": { "target": "com.amazonaws.iot#ResourceType", "traits": { @@ -18431,18 +19125,6 @@ "com.amazonaws.iot#OTAUpdateFile": { "type": "structure", "members": { - "attributes": { - "target": "com.amazonaws.iot#AttributesMap", - "traits": { - "smithy.api#documentation": "

A list of name/attribute pairs.

" - } - }, - "fileVersion": { - "target": "com.amazonaws.iot#OTAUpdateFileVersion", - "traits": { - "smithy.api#documentation": "

The file version.

" - } - }, "fileLocation": { "target": "com.amazonaws.iot#FileLocation", "traits": { @@ -18455,11 +19137,23 @@ "smithy.api#documentation": "

The name of the file.

" } }, + "attributes": { + "target": "com.amazonaws.iot#AttributesMap", + "traits": { + "smithy.api#documentation": "

A list of name/attribute pairs.

" + } + }, "codeSigning": { "target": "com.amazonaws.iot#CodeSigning", "traits": { "smithy.api#documentation": "

The code signing method of the file.

" } + }, + "fileVersion": { + "target": "com.amazonaws.iot#OTAUpdateFileVersion", + "traits": { + "smithy.api#documentation": "

The file version.

" + } } }, "traits": { @@ -18494,64 +19188,58 @@ "com.amazonaws.iot#OTAUpdateInfo": { "type": "structure", "members": { - "awsIotJobId": { - "target": "com.amazonaws.iot#AwsIotJobId", - "traits": { - "smithy.api#documentation": "

The AWS IoT job ID associated with the OTA update.

" - } - }, - "otaUpdateFiles": { - "target": "com.amazonaws.iot#OTAUpdateFiles", + "awsIotJobArn": { + "target": "com.amazonaws.iot#AwsIotJobArn", "traits": { - "smithy.api#documentation": "

A list of files associated with the OTA update.

" + "smithy.api#documentation": "

The AWS IoT job ARN associated with the OTA update.

" } }, - "description": { - "target": "com.amazonaws.iot#OTAUpdateDescription", + "targetSelection": { + "target": "com.amazonaws.iot#TargetSelection", "traits": { - "smithy.api#documentation": "

A description of the OTA update.

" + "smithy.api#documentation": "

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those\n things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also\n be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when\n the thing is added to a target group, even after the OTA update was completed by all things originally in\n the group.

" } }, - "otaUpdateArn": { - "target": "com.amazonaws.iot#OTAUpdateArn", + "additionalParameters": { + "target": "com.amazonaws.iot#AdditionalParameterMap", "traits": { - "smithy.api#documentation": "

The OTA update ARN.

" + "smithy.api#documentation": "

A collection of name/value pairs

" } }, - "lastModifiedDate": { + "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date when the OTA update was last updated.

" + "smithy.api#documentation": "

The date when the OTA update was created.

" } }, - "additionalParameters": { - "target": "com.amazonaws.iot#AdditionalParameterMap", + "otaUpdateId": { + "target": "com.amazonaws.iot#OTAUpdateId", "traits": { - "smithy.api#documentation": "

A collection of name/value pairs

" + "smithy.api#documentation": "

The OTA update ID.

" } }, - "errorInfo": { - "target": "com.amazonaws.iot#ErrorInfo", + "otaUpdateFiles": { + "target": "com.amazonaws.iot#OTAUpdateFiles", "traits": { - "smithy.api#documentation": "

Error information associated with the OTA update.

" + "smithy.api#documentation": "

A list of files associated with the OTA update.

" } }, - "awsJobExecutionsRolloutConfig": { - "target": "com.amazonaws.iot#AwsJobExecutionsRolloutConfig", + "protocols": { + "target": "com.amazonaws.iot#Protocols", "traits": { - "smithy.api#documentation": "

Configuration for the rollout of OTA updates.

" + "smithy.api#documentation": "

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both\n HTTP and MQTT are specified, the target device can choose the protocol.

" } }, - "awsIotJobArn": { - "target": "com.amazonaws.iot#AwsIotJobArn", + "awsIotJobId": { + "target": "com.amazonaws.iot#AwsIotJobId", "traits": { - "smithy.api#documentation": "

The AWS IoT job ARN associated with the OTA update.

" + "smithy.api#documentation": "

The AWS IoT job ID associated with the OTA update.

" } }, - "otaUpdateStatus": { - "target": "com.amazonaws.iot#OTAUpdateStatus", + "awsJobExecutionsRolloutConfig": { + "target": "com.amazonaws.iot#AwsJobExecutionsRolloutConfig", "traits": { - "smithy.api#documentation": "

The status of the OTA update.

" + "smithy.api#documentation": "

Configuration for the rollout of OTA updates.

" } }, "awsJobPresignedUrlConfig": { @@ -18560,34 +19248,40 @@ "smithy.api#documentation": "

Configuration information for pre-signed URLs. Valid when protocols\n contains HTTP.

" } }, - "otaUpdateId": { - "target": "com.amazonaws.iot#OTAUpdateId", + "targets": { + "target": "com.amazonaws.iot#Targets", "traits": { - "smithy.api#documentation": "

The OTA update ID.

" + "smithy.api#documentation": "

The targets of the OTA update.

" } }, - "protocols": { - "target": "com.amazonaws.iot#Protocols", + "description": { + "target": "com.amazonaws.iot#OTAUpdateDescription", "traits": { - "smithy.api#documentation": "

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both\n HTTP and MQTT are specified, the target device can choose the protocol.

" + "smithy.api#documentation": "

A description of the OTA update.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", + "errorInfo": { + "target": "com.amazonaws.iot#ErrorInfo", "traits": { - "smithy.api#documentation": "

The date when the OTA update was created.

" + "smithy.api#documentation": "

Error information associated with the OTA update.

" } }, - "targets": { - "target": "com.amazonaws.iot#Targets", + "otaUpdateStatus": { + "target": "com.amazonaws.iot#OTAUpdateStatus", "traits": { - "smithy.api#documentation": "

The targets of the OTA update.

" + "smithy.api#documentation": "

The status of the OTA update.

" } }, - "targetSelection": { - "target": "com.amazonaws.iot#TargetSelection", + "otaUpdateArn": { + "target": "com.amazonaws.iot#OTAUpdateArn", "traits": { - "smithy.api#documentation": "

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those\n things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also\n be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when\n the thing is added to a target group, even after the OTA update was completed by all things originally in\n the group.

" + "smithy.api#documentation": "

The OTA update ARN.

" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date when the OTA update was last updated.

" } } }, @@ -18627,17 +19321,17 @@ "smithy.api#documentation": "

The OTA update ARN.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The date when the OTA update was created.

" - } - }, "otaUpdateId": { "target": "com.amazonaws.iot#OTAUpdateId", "traits": { "smithy.api#documentation": "

The OTA update ID.

" } + }, + "creationDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date when the OTA update was created.

" + } } }, "traits": { @@ -18659,10 +19353,16 @@ "com.amazonaws.iot#OutgoingCertificate": { "type": "structure", "members": { - "certificateArn": { - "target": "com.amazonaws.iot#CertificateArn", + "creationDate": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The certificate ARN.

" + "smithy.api#documentation": "

The certificate creation date.

" + } + }, + "transferMessage": { + "target": "com.amazonaws.iot#Message", + "traits": { + "smithy.api#documentation": "

The transfer message.

" } }, "certificateId": { @@ -18671,16 +19371,16 @@ "smithy.api#documentation": "

The certificate ID.

" } }, - "transferredTo": { - "target": "com.amazonaws.iot#AwsAccountId", + "certificateArn": { + "target": "com.amazonaws.iot#CertificateArn", "traits": { - "smithy.api#documentation": "

The AWS account to which the transfer was made.

" + "smithy.api#documentation": "

The certificate ARN.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", + "transferredTo": { + "target": "com.amazonaws.iot#AwsAccountId", "traits": { - "smithy.api#documentation": "

The certificate creation date.

" + "smithy.api#documentation": "

The AWS account to which the transfer was made.

" } }, "transferDate": { @@ -18688,12 +19388,6 @@ "traits": { "smithy.api#documentation": "

The date the transfer was initiated.

" } - }, - "transferMessage": { - "target": "com.amazonaws.iot#Message", - "traits": { - "smithy.api#documentation": "

The transfer message.

" - } } }, "traits": { @@ -18765,17 +19459,17 @@ "com.amazonaws.iot#PercentPair": { "type": "structure", "members": { - "percent": { - "target": "com.amazonaws.iot#Percent", - "traits": { - "smithy.api#documentation": "

The percentile.

" - } - }, "value": { "target": "com.amazonaws.iot#PercentValue", "traits": { "smithy.api#documentation": "

The value of the percentile.

" } + }, + "percent": { + "target": "com.amazonaws.iot#Percent", + "traits": { + "smithy.api#documentation": "

The percentile.

" + } } }, "traits": { @@ -18880,10 +19574,10 @@ "com.amazonaws.iot#PolicyVersion": { "type": "structure", "members": { - "createDate": { - "target": "com.amazonaws.iot#DateType", + "versionId": { + "target": "com.amazonaws.iot#PolicyVersionId", "traits": { - "smithy.api#documentation": "

The date and time the policy was created.

" + "smithy.api#documentation": "

The policy version ID.

" } }, "isDefaultVersion": { @@ -18892,10 +19586,10 @@ "smithy.api#documentation": "

Specifies whether the policy version is the default.

" } }, - "versionId": { - "target": "com.amazonaws.iot#PolicyVersionId", + "createDate": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The policy version ID.

" + "smithy.api#documentation": "

The date and time the policy was created.

" } } }, @@ -18912,17 +19606,17 @@ "com.amazonaws.iot#PolicyVersionIdentifier": { "type": "structure", "members": { - "policyName": { - "target": "com.amazonaws.iot#PolicyName", - "traits": { - "smithy.api#documentation": "

The name of the policy.

" - } - }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The ID of the version of the policy associated with the resource.

" } + }, + "policyName": { + "target": "com.amazonaws.iot#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy.

" + } } }, "traits": { @@ -19071,12 +19765,6 @@ "com.amazonaws.iot#ProvisioningTemplateSummary": { "type": "structure", "members": { - "enabled": { - "target": "com.amazonaws.iot#Enabled", - "traits": { - "smithy.api#documentation": "

True if the fleet provision template is enabled, otherwise false.

" - } - }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { @@ -19089,10 +19777,10 @@ "smithy.api#documentation": "

The ARN of the fleet provisioning template.

" } }, - "description": { - "target": "com.amazonaws.iot#TemplateDescription", + "lastModifiedDate": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The description of the fleet provisioning template.

" + "smithy.api#documentation": "

The date when the fleet provisioning template summary was last modified.

" } }, "templateName": { @@ -19101,10 +19789,16 @@ "smithy.api#documentation": "

The name of the fleet provisioning template.

" } }, - "lastModifiedDate": { - "target": "com.amazonaws.iot#DateType", + "enabled": { + "target": "com.amazonaws.iot#Enabled", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template summary was last modified.

" + "smithy.api#documentation": "

True if the fleet provision template is enabled, otherwise false.

" + } + }, + "description": { + "target": "com.amazonaws.iot#TemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the fleet provisioning template.

" } } }, @@ -19121,10 +19815,10 @@ "com.amazonaws.iot#ProvisioningTemplateVersionSummary": { "type": "structure", "members": { - "versionId": { - "target": "com.amazonaws.iot#TemplateVersionId", + "creationDate": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The ID of the fleet privisioning template version.

" + "smithy.api#documentation": "

The date when the fleet provisioning template version was created

" } }, "isDefaultVersion": { @@ -19133,10 +19827,10 @@ "smithy.api#documentation": "

True if the fleet provisioning template version is the default version, otherwise\n false.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", + "versionId": { + "target": "com.amazonaws.iot#TemplateVersionId", "traits": { - "smithy.api#documentation": "

The date when the fleet provisioning template version was created

" + "smithy.api#documentation": "

The ID of the fleet privisioning template version.

" } } }, @@ -19179,6 +19873,12 @@ "com.amazonaws.iot#PutAssetPropertyValueEntry": { "type": "structure", "members": { + "propertyId": { + "target": "com.amazonaws.iot#AssetPropertyId", + "traits": { + "smithy.api#documentation": "

The ID of the asset's property. You must specify either a propertyAlias or\n both an aliasId and a propertyId. Accepts substitution\n templates.

" + } + }, "propertyValues": { "target": "com.amazonaws.iot#AssetPropertyValueList", "traits": { @@ -19186,28 +19886,22 @@ "smithy.api#required": {} } }, - "entryId": { - "target": "com.amazonaws.iot#AssetPropertyEntryId", - "traits": { - "smithy.api#documentation": "

Optional. A unique identifier for this entry that you can define to better track which\n message caused an error in case of failure. Accepts substitution templates. Defaults to a new\n UUID.

" - } - }, "assetId": { "target": "com.amazonaws.iot#AssetId", "traits": { "smithy.api#documentation": "

The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias\n or both an aliasId and a propertyId. Accepts substitution\n templates.

" } }, - "propertyAlias": { - "target": "com.amazonaws.iot#AssetPropertyAlias", + "entryId": { + "target": "com.amazonaws.iot#AssetPropertyEntryId", "traits": { - "smithy.api#documentation": "

The name of the property alias associated with your asset property. You must specify\n either a propertyAlias or both an aliasId and a\n propertyId. Accepts substitution templates.

" + "smithy.api#documentation": "

Optional. A unique identifier for this entry that you can define to better track which\n message caused an error in case of failure. Accepts substitution templates. Defaults to a new\n UUID.

" } }, - "propertyId": { - "target": "com.amazonaws.iot#AssetPropertyId", + "propertyAlias": { + "target": "com.amazonaws.iot#AssetPropertyAlias", "traits": { - "smithy.api#documentation": "

The ID of the asset's property. You must specify either a propertyAlias or\n both an aliasId and a propertyId. Accepts substitution\n templates.

" + "smithy.api#documentation": "

The name of the property alias associated with your asset property. You must specify\n either a propertyAlias or both an aliasId and a\n propertyId. Accepts substitution templates.

" } } }, @@ -19290,16 +19984,16 @@ "com.amazonaws.iot#RateIncreaseCriteria": { "type": "structure", "members": { - "numberOfNotifiedThings": { + "numberOfSucceededThings": { "target": "com.amazonaws.iot#NumberOfThings", "traits": { - "smithy.api#documentation": "

The threshold for number of notified things that will initiate the increase in rate of rollout.

" + "smithy.api#documentation": "

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

" } }, - "numberOfSucceededThings": { + "numberOfNotifiedThings": { "target": "com.amazonaws.iot#NumberOfThings", "traits": { - "smithy.api#documentation": "

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

" + "smithy.api#documentation": "

The threshold for number of notified things that will initiate the increase in rate of rollout.

" } } }, @@ -19393,10 +20087,18 @@ "com.amazonaws.iot#RegisterCACertificateRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iot#TagList", + "allowAutoRegistration": { + "target": "com.amazonaws.iot#AllowAutoRegistration", "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the CA certificate.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " + "smithy.api#documentation": "

Allows this CA certificate to be used for auto registration of device\n certificates.

", + "smithy.api#httpQuery": "allowAutoRegistration" + } + }, + "verificationCertificate": { + "target": "com.amazonaws.iot#CertificatePem", + "traits": { + "smithy.api#documentation": "

The private key verification certificate.

", + "smithy.api#required": {} } }, "registrationConfig": { @@ -19412,26 +20114,18 @@ "smithy.api#required": {} } }, - "verificationCertificate": { - "target": "com.amazonaws.iot#CertificatePem", - "traits": { - "smithy.api#documentation": "

The private key verification certificate.

", - "smithy.api#required": {} - } - }, - "allowAutoRegistration": { - "target": "com.amazonaws.iot#AllowAutoRegistration", - "traits": { - "smithy.api#documentation": "

Allows this CA certificate to be used for auto registration of device\n certificates.

", - "smithy.api#httpQuery": "allowAutoRegistration" - } - }, "setAsActive": { "target": "com.amazonaws.iot#SetAsActive", "traits": { "smithy.api#documentation": "

A boolean value that specifies if the CA certificate is set to active.

", "smithy.api#httpQuery": "setAsActive" } + }, + "tags": { + "target": "com.amazonaws.iot#TagList", + "traits": { + "smithy.api#documentation": "

Metadata which can be used to manage the CA certificate.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n " + } } }, "traits": { @@ -19507,6 +20201,13 @@ "com.amazonaws.iot#RegisterCertificateRequest": { "type": "structure", "members": { + "certificatePem": { + "target": "com.amazonaws.iot#CertificatePem", + "traits": { + "smithy.api#documentation": "

The certificate data, in PEM format.

", + "smithy.api#required": {} + } + }, "status": { "target": "com.amazonaws.iot#CertificateStatus", "traits": { @@ -19526,13 +20227,6 @@ "traits": { "smithy.api#documentation": "

The CA certificate used to sign the device certificate being registered.

" } - }, - "certificatePem": { - "target": "com.amazonaws.iot#CertificatePem", - "traits": { - "smithy.api#documentation": "

The certificate data, in PEM format.

", - "smithy.api#required": {} - } } }, "traits": { @@ -19542,17 +20236,17 @@ "com.amazonaws.iot#RegisterCertificateResponse": { "type": "structure", "members": { - "certificateArn": { - "target": "com.amazonaws.iot#CertificateArn", - "traits": { - "smithy.api#documentation": "

The certificate ARN.

" - } - }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The certificate identifier.

" } + }, + "certificateArn": { + "target": "com.amazonaws.iot#CertificateArn", + "traits": { + "smithy.api#documentation": "

The certificate ARN.

" + } } }, "traits": { @@ -19605,35 +20299,35 @@ "com.amazonaws.iot#RegisterCertificateWithoutCARequest": { "type": "structure", "members": { + "status": { + "target": "com.amazonaws.iot#CertificateStatus", + "traits": { + "smithy.api#documentation": "

The status of the register certificate request.

" + } + }, "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

", "smithy.api#required": {} } - }, - "status": { - "target": "com.amazonaws.iot#CertificateStatus", - "traits": { - "smithy.api#documentation": "

The status of the register certificate request.

" - } } } }, "com.amazonaws.iot#RegisterCertificateWithoutCAResponse": { "type": "structure", "members": { - "certificateId": { - "target": "com.amazonaws.iot#CertificateId", - "traits": { - "smithy.api#documentation": "

The ID of the registered certificate. (The last part of the certificate ARN contains the\n certificate ID.

" - } - }, "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the registered certificate.

" } + }, + "certificateId": { + "target": "com.amazonaws.iot#CertificateId", + "traits": { + "smithy.api#documentation": "

The ID of the registered certificate. (The last part of the certificate ARN contains the\n certificate ID.

" + } } } }, @@ -19741,17 +20435,17 @@ "com.amazonaws.iot#RegistrationConfig": { "type": "structure", "members": { - "templateBody": { - "target": "com.amazonaws.iot#TemplateBody", - "traits": { - "smithy.api#documentation": "

The template body.

" - } - }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role.

" } + }, + "templateBody": { + "target": "com.amazonaws.iot#TemplateBody", + "traits": { + "smithy.api#documentation": "

The template body.

" + } } }, "traits": { @@ -19856,12 +20550,6 @@ "com.amazonaws.iot#RelatedResource": { "type": "structure", "members": { - "resourceIdentifier": { - "target": "com.amazonaws.iot#ResourceIdentifier", - "traits": { - "smithy.api#documentation": "

Information that identifies the resource.

" - } - }, "additionalInfo": { "target": "com.amazonaws.iot#StringMap", "traits": { @@ -19873,6 +20561,12 @@ "traits": { "smithy.api#documentation": "

The type of resource.

" } + }, + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "

Information that identifies the resource.

" + } } }, "traits": { @@ -19931,10 +20625,10 @@ "com.amazonaws.iot#RemoveThingFromBillingGroupRequest": { "type": "structure", "members": { - "thingArn": { - "target": "com.amazonaws.iot#ThingArn", + "billingGroupArn": { + "target": "com.amazonaws.iot#BillingGroupArn", "traits": { - "smithy.api#documentation": "

The ARN of the thing to be removed from the billing group.

" + "smithy.api#documentation": "

The ARN of the billing group.

" } }, "thingName": { @@ -19943,10 +20637,10 @@ "smithy.api#documentation": "

The name of the thing to be removed from the billing group.

" } }, - "billingGroupArn": { - "target": "com.amazonaws.iot#BillingGroupArn", + "thingArn": { + "target": "com.amazonaws.iot#ThingArn", "traits": { - "smithy.api#documentation": "

The ARN of the billing group.

" + "smithy.api#documentation": "

The ARN of the thing to be removed from the billing group.

" } }, "billingGroupName": { @@ -19995,22 +20689,16 @@ "com.amazonaws.iot#RemoveThingFromThingGroupRequest": { "type": "structure", "members": { - "thingArn": { - "target": "com.amazonaws.iot#ThingArn", - "traits": { - "smithy.api#documentation": "

The ARN of the thing to remove from the group.

" - } - }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to remove from the group.

" } }, - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", + "thingArn": { + "target": "com.amazonaws.iot#ThingArn", "traits": { - "smithy.api#documentation": "

The group name.

" + "smithy.api#documentation": "

The ARN of the thing to remove from the group.

" } }, "thingGroupArn": { @@ -20018,6 +20706,12 @@ "traits": { "smithy.api#documentation": "

The group ARN.

" } + }, + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", + "traits": { + "smithy.api#documentation": "

The group name.

" + } } } }, @@ -20125,10 +20819,10 @@ "com.amazonaws.iot#RepublishAction": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iot#AwsArn", + "topic": { + "target": "com.amazonaws.iot#TopicPattern", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", + "smithy.api#documentation": "

The name of the MQTT topic.

", "smithy.api#required": {} } }, @@ -20138,10 +20832,10 @@ "smithy.api#documentation": "

The Quality of Service (QoS) level to use when republishing messages. The default value\n is 0.

" } }, - "topic": { - "target": "com.amazonaws.iot#TopicPattern", + "roleArn": { + "target": "com.amazonaws.iot#AwsArn", "traits": { - "smithy.api#documentation": "

The name of the MQTT topic.

", + "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", "smithy.api#required": {} } } @@ -20161,7 +20855,13 @@ } }, "com.amazonaws.iot#Resource": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } }, "com.amazonaws.iot#ResourceAlreadyExistsException": { "type": "structure", @@ -20172,17 +20872,17 @@ "smithy.api#documentation": "

The message for the exception.

" } }, - "resourceId": { - "target": "com.amazonaws.iot#resourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource that caused the exception.

" - } - }, "resourceArn": { "target": "com.amazonaws.iot#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource that caused the exception.

" } + }, + "resourceId": { + "target": "com.amazonaws.iot#resourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource that caused the exception.

" + } } }, "traits": { @@ -20206,22 +20906,22 @@ "com.amazonaws.iot#ResourceIdentifier": { "type": "structure", "members": { - "policyVersionIdentifier": { - "target": "com.amazonaws.iot#PolicyVersionIdentifier", + "clientId": { + "target": "com.amazonaws.iot#ClientId", "traits": { - "smithy.api#documentation": "

The version of the policy associated with the resource.

" + "smithy.api#documentation": "

The client ID.

" } }, - "account": { - "target": "com.amazonaws.iot#AwsAccountId", + "cognitoIdentityPoolId": { + "target": "com.amazonaws.iot#CognitoIdentityPoolId", "traits": { - "smithy.api#documentation": "

The account with which the resource is associated.

" + "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

" } }, - "deviceCertificateId": { - "target": "com.amazonaws.iot#CertificateId", + "account": { + "target": "com.amazonaws.iot#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the certificate attached to the resource.

" + "smithy.api#documentation": "

The account with which the resource is associated.

" } }, "iamRoleArn": { @@ -20230,28 +20930,28 @@ "smithy.api#documentation": "

The ARN of the IAM role that has overly permissive actions.

" } }, - "roleAliasArn": { - "target": "com.amazonaws.iot#RoleAliasArn", + "caCertificateId": { + "target": "com.amazonaws.iot#CertificateId", "traits": { - "smithy.api#documentation": "

The ARN of the role alias that has overly permissive actions.

" + "smithy.api#documentation": "

The ID of the CA certificate used to authorize the certificate.

" } - }, - "clientId": { - "target": "com.amazonaws.iot#ClientId", + }, + "policyVersionIdentifier": { + "target": "com.amazonaws.iot#PolicyVersionIdentifier", "traits": { - "smithy.api#documentation": "

The client ID.

" + "smithy.api#documentation": "

The version of the policy associated with the resource.

" } }, - "caCertificateId": { + "deviceCertificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { - "smithy.api#documentation": "

The ID of the CA certificate used to authorize the certificate.

" + "smithy.api#documentation": "

The ID of the certificate attached to the resource.

" } }, - "cognitoIdentityPoolId": { - "target": "com.amazonaws.iot#CognitoIdentityPoolId", + "roleAliasArn": { + "target": "com.amazonaws.iot#RoleAliasArn", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

" + "smithy.api#documentation": "

The ARN of the role alias that has overly permissive actions.

" } } }, @@ -20361,6 +21061,18 @@ "com.amazonaws.iot#RoleAliasDescription": { "type": "structure", "members": { + "creationDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The UNIX timestamp of when the role alias was created.

" + } + }, + "roleAliasArn": { + "target": "com.amazonaws.iot#RoleAliasArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role alias.

" + } + }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { @@ -20390,18 +21102,6 @@ "traits": { "smithy.api#documentation": "

The number of seconds for which the credential is valid.

" } - }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The UNIX timestamp of when the role alias was created.

" - } - }, - "roleAliasArn": { - "target": "com.amazonaws.iot#RoleAliasArn", - "traits": { - "smithy.api#documentation": "

The ARN of the role alias.

" - } } }, "traits": { @@ -20449,13 +21149,6 @@ "com.amazonaws.iot#S3Action": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.iot#Key", - "traits": { - "smithy.api#documentation": "

The object key.

", - "smithy.api#required": {} - } - }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { @@ -20469,6 +21162,13 @@ "smithy.api#documentation": "

The Amazon S3 canned ACL that controls access to the object identified by the object\n key. For more information, see S3 canned ACLs.

" } }, + "key": { + "target": "com.amazonaws.iot#Key", + "traits": { + "smithy.api#documentation": "

The object key.

", + "smithy.api#required": {} + } + }, "bucketName": { "target": "com.amazonaws.iot#BucketName", "traits": { @@ -20535,10 +21235,10 @@ "com.amazonaws.iot#S3Location": { "type": "structure", "members": { - "bucket": { - "target": "com.amazonaws.iot#S3Bucket", + "key": { + "target": "com.amazonaws.iot#S3Key", "traits": { - "smithy.api#documentation": "

The S3 bucket.

" + "smithy.api#documentation": "

The S3 key.

" } }, "version": { @@ -20547,10 +21247,10 @@ "smithy.api#documentation": "

The S3 bucket version.

" } }, - "key": { - "target": "com.amazonaws.iot#S3Key", + "bucket": { + "target": "com.amazonaws.iot#S3Bucket", "traits": { - "smithy.api#documentation": "

The S3 key.

" + "smithy.api#documentation": "

The S3 bucket.

" } } }, @@ -20567,17 +21267,17 @@ "com.amazonaws.iot#SalesforceAction": { "type": "structure", "members": { - "token": { - "target": "com.amazonaws.iot#SalesforceToken", + "url": { + "target": "com.amazonaws.iot#SalesforceEndpoint", "traits": { - "smithy.api#documentation": "

The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The\n token is available from the Salesforce IoT Cloud platform after creation of the Input\n Stream.

", + "smithy.api#documentation": "

The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from\n the Salesforce IoT Cloud platform after creation of the Input Stream.

", "smithy.api#required": {} } }, - "url": { - "target": "com.amazonaws.iot#SalesforceEndpoint", + "token": { + "target": "com.amazonaws.iot#SalesforceToken", "traits": { - "smithy.api#documentation": "

The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from\n the Salesforce IoT Cloud platform after creation of the Input Stream.

", + "smithy.api#documentation": "

The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The\n token is available from the Salesforce IoT Cloud platform after creation of the Input\n Stream.

", "smithy.api#required": {} } } @@ -20610,10 +21310,10 @@ "com.amazonaws.iot#ScheduledAuditMetadata": { "type": "structure", "members": { - "dayOfMonth": { - "target": "com.amazonaws.iot#DayOfMonth", + "scheduledAuditName": { + "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit is run (if the\n frequency is \"MONTHLY\").\n If days 29-31 are specified, and the month does not have that many\n days, the audit takes place on the \"LAST\" day of the month.

" + "smithy.api#documentation": "

The name of the scheduled audit.

" } }, "dayOfWeek": { @@ -20622,16 +21322,10 @@ "smithy.api#documentation": "

The day of the week on which the scheduled audit is run (if the\n frequency is \"WEEKLY\" or \"BIWEEKLY\").

" } }, - "scheduledAuditArn": { - "target": "com.amazonaws.iot#ScheduledAuditArn", - "traits": { - "smithy.api#documentation": "

The ARN of the scheduled audit.

" - } - }, - "scheduledAuditName": { - "target": "com.amazonaws.iot#ScheduledAuditName", + "dayOfMonth": { + "target": "com.amazonaws.iot#DayOfMonth", "traits": { - "smithy.api#documentation": "

The name of the scheduled audit.

" + "smithy.api#documentation": "

The day of the month on which the scheduled audit is run (if the\n frequency is \"MONTHLY\").\n If days 29-31 are specified, and the month does not have that many\n days, the audit takes place on the \"LAST\" day of the month.

" } }, "frequency": { @@ -20639,6 +21333,12 @@ "traits": { "smithy.api#documentation": "

How often the scheduled audit occurs.

" } + }, + "scheduledAuditArn": { + "target": "com.amazonaws.iot#ScheduledAuditArn", + "traits": { + "smithy.api#documentation": "

The ARN of the scheduled audit.

" + } } }, "traits": { @@ -20726,17 +21426,17 @@ "smithy.api#documentation": "

The search index name.

" } }, - "nextToken": { - "target": "com.amazonaws.iot#NextToken", - "traits": { - "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional\n results.

" - } - }, "maxResults": { "target": "com.amazonaws.iot#QueryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

" } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional\n results.

" + } } } }, @@ -20749,17 +21449,17 @@ "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional\n results.

" } }, - "things": { - "target": "com.amazonaws.iot#ThingDocumentList", - "traits": { - "smithy.api#documentation": "

The things that match the search query.

" - } - }, "thingGroups": { "target": "com.amazonaws.iot#ThingGroupDocumentList", "traits": { "smithy.api#documentation": "

The thing groups that match the search query.

" } + }, + "things": { + "target": "com.amazonaws.iot#ThingDocumentList", + "traits": { + "smithy.api#documentation": "

The things that match the search query.

" + } } } }, @@ -20847,17 +21547,17 @@ "com.amazonaws.iot#SecurityProfileTargetMapping": { "type": "structure", "members": { - "target": { - "target": "com.amazonaws.iot#SecurityProfileTarget", - "traits": { - "smithy.api#documentation": "

Information about the target (thing group) associated with the security profile.

" - } - }, "securityProfileIdentifier": { "target": "com.amazonaws.iot#SecurityProfileIdentifier", "traits": { "smithy.api#documentation": "

Information that identifies the security profile.

" } + }, + "target": { + "target": "com.amazonaws.iot#SecurityProfileTarget", + "traits": { + "smithy.api#documentation": "

Information about the target (thing group) associated with the security profile.

" + } } }, "traits": { @@ -20909,10 +21609,10 @@ "com.amazonaws.iot#ServerCertificateSummary": { "type": "structure", "members": { - "serverCertificateStatusDetail": { - "target": "com.amazonaws.iot#ServerCertificateStatusDetail", + "serverCertificateArn": { + "target": "com.amazonaws.iot#AcmCertificateArn", "traits": { - "smithy.api#documentation": "

Details that explain the status of the server certificate.

" + "smithy.api#documentation": "

The ARN of the server certificate.

" } }, "serverCertificateStatus": { @@ -20921,10 +21621,10 @@ "smithy.api#documentation": "

The status of the server certificate.

" } }, - "serverCertificateArn": { - "target": "com.amazonaws.iot#AcmCertificateArn", + "serverCertificateStatusDetail": { + "target": "com.amazonaws.iot#ServerCertificateStatusDetail", "traits": { - "smithy.api#documentation": "

The ARN of the server certificate.

" + "smithy.api#documentation": "

Details that explain the status of the server certificate.

" } } }, @@ -21177,6 +21877,9 @@ { "target": "com.amazonaws.iot#InvalidRequestException" }, + { + "target": "com.amazonaws.iot#LimitExceededException" + }, { "target": "com.amazonaws.iot#NotConfiguredException" }, @@ -21246,30 +21949,23 @@ "smithy.api#documentation": "

The default logging level.

" } }, - "roleArn": { - "target": "com.amazonaws.iot#AwsArn", - "traits": { - "smithy.api#documentation": "

The ARN of the role that allows IoT to write to Cloudwatch logs.

" - } - }, "disableAllLogs": { "target": "com.amazonaws.iot#DisableAllLogs", "traits": { "smithy.api#documentation": "

If true all logs are disabled. The default is false.

" } + }, + "roleArn": { + "target": "com.amazonaws.iot#AwsArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role that allows IoT to write to Cloudwatch logs.

" + } } } }, "com.amazonaws.iot#SigV4Authorization": { "type": "structure", "members": { - "serviceName": { - "target": "com.amazonaws.iot#ServiceName", - "traits": { - "smithy.api#documentation": "

The service name to use while signing with Sig V4.

", - "smithy.api#required": {} - } - }, "signingRegion": { "target": "com.amazonaws.iot#SigningRegion", "traits": { @@ -21283,6 +21979,13 @@ "smithy.api#documentation": "

The ARN of the signing role.

", "smithy.api#required": {} } + }, + "serviceName": { + "target": "com.amazonaws.iot#ServiceName", + "traits": { + "smithy.api#documentation": "

The service name to use while signing with Sig V4.

", + "smithy.api#required": {} + } } }, "traits": { @@ -21310,17 +22013,17 @@ "smithy.api#documentation": "

Certificate ARN.

" } }, - "certificatePathOnDevice": { - "target": "com.amazonaws.iot#CertificatePathOnDevice", - "traits": { - "smithy.api#documentation": "

The location of the code-signing certificate on your device.

" - } - }, "platform": { "target": "com.amazonaws.iot#Platform", "traits": { "smithy.api#documentation": "

The hardware platform of your device.

" } + }, + "certificatePathOnDevice": { + "target": "com.amazonaws.iot#CertificatePathOnDevice", + "traits": { + "smithy.api#documentation": "

The location of the code-signing certificate on your device.

" + } } }, "traits": { @@ -21356,18 +22059,18 @@ "smithy.api#required": {} } }, - "messageFormat": { - "target": "com.amazonaws.iot#MessageFormat", - "traits": { - "smithy.api#documentation": "

(Optional) The message format of the message to publish. Accepted values are \"JSON\"\n and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine\n if the payload should be parsed and relevant platform-specific bits of the payload should\n be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

" - } - }, "targetArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the SNS topic.

", "smithy.api#required": {} } + }, + "messageFormat": { + "target": "com.amazonaws.iot#MessageFormat", + "traits": { + "smithy.api#documentation": "

(Optional) The message format of the message to publish. Accepted values are \"JSON\"\n and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine\n if the payload should be parsed and relevant platform-specific bits of the payload should\n be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

" + } } }, "traits": { @@ -21409,18 +22112,18 @@ "smithy.api#required": {} } }, - "useBase64": { - "target": "com.amazonaws.iot#UseBase64", - "traits": { - "smithy.api#documentation": "

Specifies whether to use Base64 encoding.

" - } - }, "queueUrl": { "target": "com.amazonaws.iot#QueueUrl", "traits": { "smithy.api#documentation": "

The URL of the Amazon SQS queue.

", "smithy.api#required": {} } + }, + "useBase64": { + "target": "com.amazonaws.iot#UseBase64", + "traits": { + "smithy.api#documentation": "

Specifies whether to use Base64 encoding.

" + } } }, "traits": { @@ -21464,33 +22167,33 @@ "com.amazonaws.iot#StartAuditMitigationActionsTaskRequest": { "type": "structure", "members": { - "clientRequestToken": { - "target": "com.amazonaws.iot#ClientRequestToken", + "target": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.

", "smithy.api#required": {} } }, - "target": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", + "auditCheckToActionsMapping": { + "target": "com.amazonaws.iot#AuditCheckToActionsMapping", "traits": { - "smithy.api#documentation": "

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.

", + "smithy.api#documentation": "

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.

", "smithy.api#required": {} } }, - "taskId": { - "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", + "clientRequestToken": { + "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, - "auditCheckToActionsMapping": { - "target": "com.amazonaws.iot#AuditCheckToActionsMapping", + "taskId": { + "target": "com.amazonaws.iot#AuditMitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.

", + "smithy.api#documentation": "

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -21564,18 +22267,18 @@ "com.amazonaws.iot#StartSigningJobParameter": { "type": "structure", "members": { - "signingProfileParameter": { - "target": "com.amazonaws.iot#SigningProfileParameter", - "traits": { - "smithy.api#documentation": "

Describes the code-signing profile.

" - } - }, "signingProfileName": { "target": "com.amazonaws.iot#SigningProfileName", "traits": { "smithy.api#documentation": "

The code-signing profile name.

" } }, + "signingProfileParameter": { + "target": "com.amazonaws.iot#SigningProfileParameter", + "traits": { + "smithy.api#documentation": "

Describes the code-signing profile.

" + } + }, "destination": { "target": "com.amazonaws.iot#Destination", "traits": { @@ -21621,17 +22324,17 @@ "com.amazonaws.iot#StartThingRegistrationTaskRequest": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "inputFileKey": { + "target": "com.amazonaws.iot#RegistryS3KeyName", "traits": { - "smithy.api#documentation": "

The IAM role ARN that grants permission the input file.

", + "smithy.api#documentation": "

The name of input file within the S3 bucket. This file contains a newline delimited\n\t\t\tJSON file. Each line contains the parameter values to provision one device\n\t\t\t(thing).

", "smithy.api#required": {} } }, - "inputFileKey": { - "target": "com.amazonaws.iot#RegistryS3KeyName", + "templateBody": { + "target": "com.amazonaws.iot#TemplateBody", "traits": { - "smithy.api#documentation": "

The name of input file within the S3 bucket. This file contains a newline delimited\n\t\t\tJSON file. Each line contains the parameter values to provision one device\n\t\t\t(thing).

", + "smithy.api#documentation": "

The provisioning template.

", "smithy.api#required": {} } }, @@ -21642,10 +22345,10 @@ "smithy.api#required": {} } }, - "templateBody": { - "target": "com.amazonaws.iot#TemplateBody", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The provisioning template.

", + "smithy.api#documentation": "

The IAM role ARN that grants permission the input file.

", "smithy.api#required": {} } } @@ -21688,19 +22391,6 @@ "com.amazonaws.iot#Statistics": { "type": "structure", "members": { - "maximum": { - "target": "com.amazonaws.iot#Maximum", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum aggregated field value.

" - } - }, - "count": { - "target": "com.amazonaws.iot#Count", - "traits": { - "smithy.api#documentation": "

The count of things that match the query.

" - } - }, "stdDeviation": { "target": "com.amazonaws.iot#StdDeviation", "traits": { @@ -21708,13 +22398,6 @@ "smithy.api#documentation": "

The standard deviation of the aggregated field values.

" } }, - "sum": { - "target": "com.amazonaws.iot#Sum", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The sum of the aggregated field values.

" - } - }, "sumOfSquares": { "target": "com.amazonaws.iot#SumOfSquares", "traits": { @@ -21729,11 +22412,18 @@ "smithy.api#documentation": "

The average of the aggregated field values.

" } }, - "minimum": { - "target": "com.amazonaws.iot#Minimum", + "maximum": { + "target": "com.amazonaws.iot#Maximum", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The minimum aggregated field value.

" + "smithy.api#documentation": "

The maximum aggregated field value.

" + } + }, + "sum": { + "target": "com.amazonaws.iot#Sum", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The sum of the aggregated field values.

" } }, "variance": { @@ -21742,6 +22432,19 @@ "smithy.api#box": {}, "smithy.api#documentation": "

The variance of the aggregated field values.

" } + }, + "count": { + "target": "com.amazonaws.iot#Count", + "traits": { + "smithy.api#documentation": "

The count of things that match the query.

" + } + }, + "minimum": { + "target": "com.amazonaws.iot#Minimum", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The minimum aggregated field value.

" + } } }, "traits": { @@ -21781,10 +22484,11 @@ "com.amazonaws.iot#StepFunctionsAction": { "type": "structure", "members": { - "executionNamePrefix": { - "target": "com.amazonaws.iot#ExecutionNamePrefix", + "stateMachineName": { + "target": "com.amazonaws.iot#StateMachineName", "traits": { - "smithy.api#documentation": "

(Optional) A name will be given to the state machine execution consisting of this\n prefix followed by a UUID. Step Functions automatically creates a unique name for each state\n machine execution if one is not provided.

" + "smithy.api#documentation": "

The name of the Step Functions state machine whose execution will be started.

", + "smithy.api#required": {} } }, "roleArn": { @@ -21794,11 +22498,10 @@ "smithy.api#required": {} } }, - "stateMachineName": { - "target": "com.amazonaws.iot#StateMachineName", + "executionNamePrefix": { + "target": "com.amazonaws.iot#ExecutionNamePrefix", "traits": { - "smithy.api#documentation": "

The name of the Step Functions state machine whose execution will be started.

", - "smithy.api#required": {} + "smithy.api#documentation": "

(Optional) A name will be given to the state machine execution consisting of this\n prefix followed by a UUID. Step Functions automatically creates a unique name for each state\n machine execution if one is not provided.

" } } }, @@ -21860,17 +22563,17 @@ "com.amazonaws.iot#Stream": { "type": "structure", "members": { - "fileId": { - "target": "com.amazonaws.iot#FileId", - "traits": { - "smithy.api#documentation": "

The ID of a file associated with a stream.

" - } - }, "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

" } + }, + "fileId": { + "target": "com.amazonaws.iot#FileId", + "traits": { + "smithy.api#documentation": "

The ID of a file associated with a stream.

" + } } }, "traits": { @@ -21935,22 +22638,10 @@ "com.amazonaws.iot#StreamInfo": { "type": "structure", "members": { - "lastUpdatedAt": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "

The date when the stream was last updated.

" - } - }, - "files": { - "target": "com.amazonaws.iot#StreamFiles", - "traits": { - "smithy.api#documentation": "

The files to stream.

" - } - }, - "streamId": { - "target": "com.amazonaws.iot#StreamId", + "description": { + "target": "com.amazonaws.iot#StreamDescription", "traits": { - "smithy.api#documentation": "

The stream ID.

" + "smithy.api#documentation": "

The description of the stream.

" } }, "roleArn": { @@ -21959,22 +22650,28 @@ "smithy.api#documentation": "

An IAM role AWS IoT assumes to access your S3 files.

" } }, + "files": { + "target": "com.amazonaws.iot#StreamFiles", + "traits": { + "smithy.api#documentation": "

The files to stream.

" + } + }, "createdAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the stream was created.

" } }, - "streamArn": { - "target": "com.amazonaws.iot#StreamArn", + "lastUpdatedAt": { + "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The stream ARN.

" + "smithy.api#documentation": "

The date when the stream was last updated.

" } }, - "description": { - "target": "com.amazonaws.iot#StreamDescription", + "streamId": { + "target": "com.amazonaws.iot#StreamId", "traits": { - "smithy.api#documentation": "

The description of the stream.

" + "smithy.api#documentation": "

The stream ID.

" } }, "streamVersion": { @@ -21982,6 +22679,12 @@ "traits": { "smithy.api#documentation": "

The stream version.

" } + }, + "streamArn": { + "target": "com.amazonaws.iot#StreamArn", + "traits": { + "smithy.api#documentation": "

The stream ARN.

" + } } }, "traits": { @@ -21994,12 +22697,6 @@ "com.amazonaws.iot#StreamSummary": { "type": "structure", "members": { - "streamId": { - "target": "com.amazonaws.iot#StreamId", - "traits": { - "smithy.api#documentation": "

The stream ID.

" - } - }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { @@ -22017,6 +22714,12 @@ "traits": { "smithy.api#documentation": "

The stream version.

" } + }, + "streamId": { + "target": "com.amazonaws.iot#StreamId", + "traits": { + "smithy.api#documentation": "

The stream ID.

" + } } }, "traits": { @@ -22069,6 +22772,18 @@ "com.amazonaws.iot#SumOfSquares": { "type": "double" }, + "com.amazonaws.iot#SuppressIndefinitely": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iot#SuppressedNonCompliantResourcesCount": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.iot#TableName": { "type": "string" }, @@ -22256,28 +22971,16 @@ "com.amazonaws.iot#TaskStatistics": { "type": "structure", "members": { - "totalChecks": { - "target": "com.amazonaws.iot#TotalChecksCount", - "traits": { - "smithy.api#documentation": "

The number of checks in this audit.

" - } - }, - "compliantChecks": { - "target": "com.amazonaws.iot#CompliantChecksCount", - "traits": { - "smithy.api#documentation": "

The number of checks that found compliant resources.

" - } - }, "nonCompliantChecks": { "target": "com.amazonaws.iot#NonCompliantChecksCount", "traits": { "smithy.api#documentation": "

The number of checks that found noncompliant resources.

" } }, - "failedChecks": { - "target": "com.amazonaws.iot#FailedChecksCount", + "inProgressChecks": { + "target": "com.amazonaws.iot#InProgressChecksCount", "traits": { - "smithy.api#documentation": "

The number of checks.

" + "smithy.api#documentation": "

The number of checks in progress.

" } }, "waitingForDataCollectionChecks": { @@ -22286,10 +22989,10 @@ "smithy.api#documentation": "

The number of checks waiting for data collection.

" } }, - "inProgressChecks": { - "target": "com.amazonaws.iot#InProgressChecksCount", + "failedChecks": { + "target": "com.amazonaws.iot#FailedChecksCount", "traits": { - "smithy.api#documentation": "

The number of checks in progress.

" + "smithy.api#documentation": "

The number of checks.

" } }, "canceledChecks": { @@ -22297,6 +23000,18 @@ "traits": { "smithy.api#documentation": "

The number of checks that did not run because the audit was canceled.

" } + }, + "compliantChecks": { + "target": "com.amazonaws.iot#CompliantChecksCount", + "traits": { + "smithy.api#documentation": "

The number of checks that found compliant resources.

" + } + }, + "totalChecks": { + "target": "com.amazonaws.iot#TotalChecksCount", + "traits": { + "smithy.api#documentation": "

The number of checks in this audit.

" + } } }, "traits": { @@ -22306,24 +23021,12 @@ "com.amazonaws.iot#TaskStatisticsForAuditCheck": { "type": "structure", "members": { - "failedFindingsCount": { - "target": "com.amazonaws.iot#FailedFindingsCount", - "traits": { - "smithy.api#documentation": "

The number of findings for which at least one of the actions failed when applied.

" - } - }, "canceledFindingsCount": { "target": "com.amazonaws.iot#CanceledFindingsCount", "traits": { "smithy.api#documentation": "

The number of findings to which the mitigation action task was canceled when applied.

" } }, - "succeededFindingsCount": { - "target": "com.amazonaws.iot#SucceededFindingsCount", - "traits": { - "smithy.api#documentation": "

The number of findings for which all mitigation actions succeeded when applied.

" - } - }, "skippedFindingsCount": { "target": "com.amazonaws.iot#SkippedFindingsCount", "traits": { @@ -22335,6 +23038,18 @@ "traits": { "smithy.api#documentation": "

The total number of findings to which a task is being applied.

" } + }, + "failedFindingsCount": { + "target": "com.amazonaws.iot#FailedFindingsCount", + "traits": { + "smithy.api#documentation": "

The number of findings for which at least one of the actions failed when applied.

" + } + }, + "succeededFindingsCount": { + "target": "com.amazonaws.iot#SucceededFindingsCount", + "traits": { + "smithy.api#documentation": "

The number of findings for which all mitigation actions succeeded when applied.

" + } } }, "traits": { @@ -22416,12 +23131,6 @@ "com.amazonaws.iot#TestAuthorizationRequest": { "type": "structure", "members": { - "policyNamesToAdd": { - "target": "com.amazonaws.iot#PolicyNames", - "traits": { - "smithy.api#documentation": "

When testing custom authorization, the policies specified here are treated as if they\n are attached to the principal being authorized.

" - } - }, "policyNamesToSkip": { "target": "com.amazonaws.iot#PolicyNames", "traits": { @@ -22431,7 +23140,7 @@ "principal": { "target": "com.amazonaws.iot#Principal", "traits": { - "smithy.api#documentation": "

The principal.

" + "smithy.api#documentation": "

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

" } }, "cognitoIdentityPoolId": { @@ -22447,6 +23156,12 @@ "smithy.api#httpQuery": "clientId" } }, + "policyNamesToAdd": { + "target": "com.amazonaws.iot#PolicyNames", + "traits": { + "smithy.api#documentation": "

When testing custom authorization, the policies specified here are treated as if they\n are attached to the principal being authorized.

" + } + }, "authInfos": { "target": "com.amazonaws.iot#AuthInfos", "traits": { @@ -22510,16 +23225,12 @@ "com.amazonaws.iot#TestInvokeAuthorizerRequest": { "type": "structure", "members": { - "token": { - "target": "com.amazonaws.iot#Token", - "traits": { - "smithy.api#documentation": "

The token returned by your custom authentication service.

" - } - }, - "tokenSignature": { - "target": "com.amazonaws.iot#TokenSignature", + "authorizerName": { + "target": "com.amazonaws.iot#AuthorizerName", "traits": { - "smithy.api#documentation": "

The signature made with the token and your custom authentication service's private\n key. This value must be Base-64-encoded.

" + "smithy.api#documentation": "

The custom authorizer name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "mqttContext": { @@ -22528,24 +23239,28 @@ "smithy.api#documentation": "

Specifies a test MQTT authorization request.

" } }, - "authorizerName": { - "target": "com.amazonaws.iot#AuthorizerName", - "traits": { - "smithy.api#documentation": "

The custom authorizer name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "tlsContext": { "target": "com.amazonaws.iot#TlsContext", "traits": { "smithy.api#documentation": "

Specifies a test TLS authorization request.

" } }, + "token": { + "target": "com.amazonaws.iot#Token", + "traits": { + "smithy.api#documentation": "

The token returned by your custom authentication service.

" + } + }, "httpContext": { "target": "com.amazonaws.iot#HttpContext", "traits": { - "smithy.api#documentation": "

Specifies a test HTTP authorization request.

" + "smithy.api#documentation": "

Specifies a test HTTP authorization request.

" + } + }, + "tokenSignature": { + "target": "com.amazonaws.iot#TokenSignature", + "traits": { + "smithy.api#documentation": "

The signature made with the token and your custom authentication service's private\n key. This value must be Base-64-encoded.

" } } } @@ -22553,12 +23268,6 @@ "com.amazonaws.iot#TestInvokeAuthorizerResponse": { "type": "structure", "members": { - "policyDocuments": { - "target": "com.amazonaws.iot#PolicyDocuments", - "traits": { - "smithy.api#documentation": "

IAM policy documents.

" - } - }, "refreshAfterInSeconds": { "target": "com.amazonaws.iot#Seconds", "traits": { @@ -22582,6 +23291,12 @@ "traits": { "smithy.api#documentation": "

The principal ID.

" } + }, + "policyDocuments": { + "target": "com.amazonaws.iot#PolicyDocuments", + "traits": { + "smithy.api#documentation": "

IAM policy documents.

" + } } } }, @@ -22591,22 +23306,22 @@ "com.amazonaws.iot#ThingAttribute": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.iot#Version", + "thingTypeName": { + "target": "com.amazonaws.iot#ThingTypeName", "traits": { - "smithy.api#documentation": "

The version of the thing record in the registry.

" + "smithy.api#documentation": "

The name of the thing type, if the thing has been associated with a type.

" } }, - "thingName": { - "target": "com.amazonaws.iot#ThingName", + "attributes": { + "target": "com.amazonaws.iot#Attributes", "traits": { - "smithy.api#documentation": "

The name of the thing.

" + "smithy.api#documentation": "

A list of thing attributes which are name-value pairs.

" } }, - "thingTypeName": { - "target": "com.amazonaws.iot#ThingTypeName", + "thingName": { + "target": "com.amazonaws.iot#ThingName", "traits": { - "smithy.api#documentation": "

The name of the thing type, if the thing has been associated with a type.

" + "smithy.api#documentation": "

The name of the thing.

" } }, "thingArn": { @@ -22615,10 +23330,10 @@ "smithy.api#documentation": "

The thing ARN.

" } }, - "attributes": { - "target": "com.amazonaws.iot#Attributes", + "version": { + "target": "com.amazonaws.iot#Version", "traits": { - "smithy.api#documentation": "

A list of thing attributes which are name-value pairs.

" + "smithy.api#documentation": "

The version of the thing record in the registry.

" } } }, @@ -22670,24 +23385,6 @@ "com.amazonaws.iot#ThingDocument": { "type": "structure", "members": { - "thingGroupNames": { - "target": "com.amazonaws.iot#ThingGroupNameList", - "traits": { - "smithy.api#documentation": "

Thing group names.

" - } - }, - "shadow": { - "target": "com.amazonaws.iot#JsonDocument", - "traits": { - "smithy.api#documentation": "

The shadow.

" - } - }, - "connectivity": { - "target": "com.amazonaws.iot#ThingConnectivity", - "traits": { - "smithy.api#documentation": "

Indicates whether the thing is connected to the AWS IoT service.

" - } - }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { @@ -22706,11 +23403,29 @@ "smithy.api#documentation": "

The attributes.

" } }, + "shadow": { + "target": "com.amazonaws.iot#JsonDocument", + "traits": { + "smithy.api#documentation": "

The shadow.

" + } + }, "thingId": { "target": "com.amazonaws.iot#ThingId", "traits": { "smithy.api#documentation": "

The thing ID.

" } + }, + "connectivity": { + "target": "com.amazonaws.iot#ThingConnectivity", + "traits": { + "smithy.api#documentation": "

Indicates whether the thing is connected to the AWS IoT service.

" + } + }, + "thingGroupNames": { + "target": "com.amazonaws.iot#ThingGroupNameList", + "traits": { + "smithy.api#documentation": "

Thing group names.

" + } } }, "traits": { @@ -22739,10 +23454,10 @@ "com.amazonaws.iot#ThingGroupDocument": { "type": "structure", "members": { - "thingGroupId": { - "target": "com.amazonaws.iot#ThingGroupId", + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", "traits": { - "smithy.api#documentation": "

The thing group ID.

" + "smithy.api#documentation": "

The thing group name.

" } }, "attributes": { @@ -22751,22 +23466,22 @@ "smithy.api#documentation": "

The thing group attributes.

" } }, - "thingGroupDescription": { - "target": "com.amazonaws.iot#ThingGroupDescription", - "traits": { - "smithy.api#documentation": "

The thing group description.

" - } - }, "parentGroupNames": { "target": "com.amazonaws.iot#ThingGroupNameList", "traits": { "smithy.api#documentation": "

Parent group names.

" } }, - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", + "thingGroupDescription": { + "target": "com.amazonaws.iot#ThingGroupDescription", "traits": { - "smithy.api#documentation": "

The thing group name.

" + "smithy.api#documentation": "

The thing group description.

" + } + }, + "thingGroupId": { + "target": "com.amazonaws.iot#ThingGroupId", + "traits": { + "smithy.api#documentation": "

The thing group ID.

" } } }, @@ -22799,18 +23514,18 @@ "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service.

" } }, - "customFields": { - "target": "com.amazonaws.iot#Fields", - "traits": { - "smithy.api#documentation": "

A list of thing group fields to index. This list cannot contain any managed fields. Use\n the GetIndexingConfiguration API to get a list of managed fields.

\n

Contains custom field names and their data type.

" - } - }, "thingGroupIndexingMode": { "target": "com.amazonaws.iot#ThingGroupIndexingMode", "traits": { "smithy.api#documentation": "

Thing group indexing mode.

", "smithy.api#required": {} } + }, + "customFields": { + "target": "com.amazonaws.iot#Fields", + "traits": { + "smithy.api#documentation": "

A list of thing group fields to index. This list cannot contain any managed fields. Use\n the GetIndexingConfiguration API to get a list of managed fields.

\n

Contains custom field names and their data type.

" + } } }, "traits": { @@ -22841,12 +23556,6 @@ "com.amazonaws.iot#ThingGroupMetadata": { "type": "structure", "members": { - "creationDate": { - "target": "com.amazonaws.iot#CreationDate", - "traits": { - "smithy.api#documentation": "

The UNIX timestamp of when the thing group was created.

" - } - }, "parentGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { @@ -22858,6 +23567,12 @@ "traits": { "smithy.api#documentation": "

The root parent thing group.

" } + }, + "creationDate": { + "target": "com.amazonaws.iot#CreationDate", + "traits": { + "smithy.api#documentation": "

The UNIX timestamp of when the thing group was created.

" + } } }, "traits": { @@ -22901,17 +23616,17 @@ "com.amazonaws.iot#ThingGroupProperties": { "type": "structure", "members": { - "thingGroupDescription": { - "target": "com.amazonaws.iot#ThingGroupDescription", - "traits": { - "smithy.api#documentation": "

The thing group description.

" - } - }, "attributePayload": { "target": "com.amazonaws.iot#AttributePayload", "traits": { "smithy.api#documentation": "

The thing group attributes in JSON format.

" } + }, + "thingGroupDescription": { + "target": "com.amazonaws.iot#ThingGroupDescription", + "traits": { + "smithy.api#documentation": "

The thing group description.

" + } } }, "traits": { @@ -22924,12 +23639,6 @@ "com.amazonaws.iot#ThingIndexingConfiguration": { "type": "structure", "members": { - "managedFields": { - "target": "com.amazonaws.iot#Fields", - "traits": { - "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service.

" - } - }, "thingIndexingMode": { "target": "com.amazonaws.iot#ThingIndexingMode", "traits": { @@ -22948,6 +23657,12 @@ "traits": { "smithy.api#documentation": "

Contains custom field names and their data type.

" } + }, + "managedFields": { + "target": "com.amazonaws.iot#Fields", + "traits": { + "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service.

" + } } }, "traits": { @@ -22995,29 +23710,29 @@ "com.amazonaws.iot#ThingTypeDefinition": { "type": "structure", "members": { - "thingTypeName": { - "target": "com.amazonaws.iot#ThingTypeName", - "traits": { - "smithy.api#documentation": "

The name of the thing type.

" - } - }, "thingTypeMetadata": { "target": "com.amazonaws.iot#ThingTypeMetadata", "traits": { "smithy.api#documentation": "

The ThingTypeMetadata contains additional information about the thing type including: creation date and\n\t\t\ttime, a value indicating whether the thing type is deprecated, and a date and time when it was\n\t\t\tdeprecated.

" } }, - "thingTypeArn": { - "target": "com.amazonaws.iot#ThingTypeArn", - "traits": { - "smithy.api#documentation": "

The thing type ARN.

" - } - }, "thingTypeProperties": { "target": "com.amazonaws.iot#ThingTypeProperties", "traits": { "smithy.api#documentation": "

The ThingTypeProperties for the thing type.

" } + }, + "thingTypeName": { + "target": "com.amazonaws.iot#ThingTypeName", + "traits": { + "smithy.api#documentation": "

The name of the thing type.

" + } + }, + "thingTypeArn": { + "target": "com.amazonaws.iot#ThingTypeArn", + "traits": { + "smithy.api#documentation": "

The thing type ARN.

" + } } }, "traits": { @@ -23046,18 +23761,18 @@ "com.amazonaws.iot#ThingTypeMetadata": { "type": "structure", "members": { - "deprecated": { - "target": "com.amazonaws.iot#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the thing type is deprecated. If true, no new things could be\n\t\t\tassociated with this type.

" - } - }, "creationDate": { "target": "com.amazonaws.iot#CreationDate", "traits": { "smithy.api#documentation": "

The date and time when the thing type was created.

" } }, + "deprecated": { + "target": "com.amazonaws.iot#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the thing type is deprecated. If true, no new things could be\n\t\t\tassociated with this type.

" + } + }, "deprecationDate": { "target": "com.amazonaws.iot#DeprecationDate", "traits": { @@ -23110,33 +23825,149 @@ } }, "traits": { - "smithy.api#documentation": "

The rate exceeds the limit.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "

The rate exceeds the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iot#TimedOutThings": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iot#TimeoutConfig": { + "type": "structure", + "members": { + "inProgressTimeoutInMinutes": { + "target": "com.amazonaws.iot#InProgressTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "

Specifies the amount of time, in minutes, this device has to finish execution of this job. \n The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The \n in progress timer can't be updated and will apply to all job executions for the job. Whenever a job \n execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail \n and switch to the terminal TIMED_OUT status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the timer expires, it will\n be automatically set to TIMED_OUT.

" + } + }, + "com.amazonaws.iot#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.iot#TimestreamAction": { + "type": "structure", + "members": { + "databaseName": { + "target": "com.amazonaws.iot#TimestreamDatabaseName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon Timestream database.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.iot#AwsArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role that grants permission to write to the\n Amazon Timestream database table.

", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.iot#TimestreamTableName", + "traits": { + "smithy.api#documentation": "

The name of the database table into which to write the measure records.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.iot#TimestreamTimestamp", + "traits": { + "smithy.api#documentation": "

Specifies an application-defined value to replace the default value assigned to the\n Timestream record's timestamp in the time column.

\n

You can use this property to specify the value and the precision of the Timestream\n record's timestamp. You can specify a value from the message payload or a value computed by\n a substitution template.

\n

If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it\n processed the rule.

" + } + }, + "dimensions": { + "target": "com.amazonaws.iot#TimestreamDimensionList", + "traits": { + "smithy.api#documentation": "

Metadata attributes of the time series that are written in each measure record.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Timestream rule action writes attributes (measures) from an MQTT message\n into an Amazon Timestream table. For more information, see the Timestream\n topic rule action documentation.

" + } + }, + "com.amazonaws.iot#TimestreamDatabaseName": { + "type": "string" + }, + "com.amazonaws.iot#TimestreamDimension": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.iot#TimestreamDimensionValue", + "traits": { + "smithy.api#documentation": "

The value to write in this column of the database record.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.iot#TimestreamDimensionName", + "traits": { + "smithy.api#documentation": "

The metadata dimension name. This is the name of the column in the\n Amazon Timestream database table record.

\n

Dimensions cannot be named: measure_name,\n measure_value, or time.\n These names are reserved. Dimension names cannot start\n with ts_ or measure_value and\n they cannot contain the colon (:)\n character.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata attributes of the time series that are written in each measure record.

" } }, - "com.amazonaws.iot#TimedOutThings": { - "type": "integer", + "com.amazonaws.iot#TimestreamDimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#TimestreamDimension" + }, "traits": { - "smithy.api#box": {} + "smithy.api#length": { + "min": 1, + "max": 128 + } } }, - "com.amazonaws.iot#TimeoutConfig": { + "com.amazonaws.iot#TimestreamDimensionName": { + "type": "string" + }, + "com.amazonaws.iot#TimestreamDimensionValue": { + "type": "string" + }, + "com.amazonaws.iot#TimestreamTableName": { + "type": "string" + }, + "com.amazonaws.iot#TimestreamTimestamp": { "type": "structure", "members": { - "inProgressTimeoutInMinutes": { - "target": "com.amazonaws.iot#InProgressTimeoutInMinutes", + "unit": { + "target": "com.amazonaws.iot#TimestreamTimestampUnit", "traits": { - "smithy.api#documentation": "

Specifies the amount of time, in minutes, this device has to finish execution of this job. \n The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The \n in progress timer can't be updated and will apply to all job executions for the job. Whenever a job \n execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail \n and switch to the terminal TIMED_OUT status.

" + "smithy.api#documentation": "

The precision of the timestamp value that results from the expression\n described in value.

\n

Valid values: SECONDS | MILLISECONDS |\n MICROSECONDS | NANOSECONDS. The default is\n MILLISECONDS.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.iot#TimestreamTimestampValue", + "traits": { + "smithy.api#documentation": "

An expression that returns a long epoch time value.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the timer expires, it will\n be automatically set to TIMED_OUT.

" + "smithy.api#documentation": "

Describes how to interpret an application-defined timestamp value from an MQTT message\n payload and the precision of that value.

" } }, - "com.amazonaws.iot#Timestamp": { - "type": "timestamp" + "com.amazonaws.iot#TimestreamTimestampUnit": { + "type": "string" + }, + "com.amazonaws.iot#TimestreamTimestampValue": { + "type": "string" }, "com.amazonaws.iot#TlsContext": { "type": "structure", @@ -23190,10 +24021,10 @@ "com.amazonaws.iot#TopicRule": { "type": "structure", "members": { - "ruleDisabled": { - "target": "com.amazonaws.iot#IsDisabled", + "ruleName": { + "target": "com.amazonaws.iot#RuleName", "traits": { - "smithy.api#documentation": "

Specifies whether the rule is disabled.

" + "smithy.api#documentation": "

The name of the rule.

" } }, "sql": { @@ -23202,16 +24033,16 @@ "smithy.api#documentation": "

The SQL statement used to query the topic. When using a SQL query with multiple\n lines, be sure to escape the newline characters.

" } }, - "actions": { - "target": "com.amazonaws.iot#ActionList", + "awsIotSqlVersion": { + "target": "com.amazonaws.iot#AwsIotSqlVersion", "traits": { - "smithy.api#documentation": "

The actions associated with the rule.

" + "smithy.api#documentation": "

The version of the SQL rules engine to use when evaluating the rule.

" } }, - "description": { - "target": "com.amazonaws.iot#Description", + "actions": { + "target": "com.amazonaws.iot#ActionList", "traits": { - "smithy.api#documentation": "

The description of the rule.

" + "smithy.api#documentation": "

The actions associated with the rule.

" } }, "createdAt": { @@ -23220,22 +24051,22 @@ "smithy.api#documentation": "

The date and time the rule was created.

" } }, - "errorAction": { - "target": "com.amazonaws.iot#Action", + "ruleDisabled": { + "target": "com.amazonaws.iot#IsDisabled", "traits": { - "smithy.api#documentation": "

The action to perform when an error occurs.

" + "smithy.api#documentation": "

Specifies whether the rule is disabled.

" } }, - "ruleName": { - "target": "com.amazonaws.iot#RuleName", + "errorAction": { + "target": "com.amazonaws.iot#Action", "traits": { - "smithy.api#documentation": "

The name of the rule.

" + "smithy.api#documentation": "

The action to perform when an error occurs.

" } }, - "awsIotSqlVersion": { - "target": "com.amazonaws.iot#AwsIotSqlVersion", + "description": { + "target": "com.amazonaws.iot#Description", "traits": { - "smithy.api#documentation": "

The version of the SQL rules engine to use when evaluating the rule.

" + "smithy.api#documentation": "

The description of the rule.

" } } }, @@ -23246,22 +24077,16 @@ "com.amazonaws.iot#TopicRuleDestination": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.iot#AwsArn", - "traits": { - "smithy.api#documentation": "

The topic rule destination URL.

" - } - }, "statusReason": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

Additional details or reason why the topic rule destination is in the current\n status.

" } }, - "status": { - "target": "com.amazonaws.iot#TopicRuleDestinationStatus", + "arn": { + "target": "com.amazonaws.iot#AwsArn", "traits": { - "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
" + "smithy.api#documentation": "

The topic rule destination URL.

" } }, "httpUrlProperties": { @@ -23269,6 +24094,12 @@ "traits": { "smithy.api#documentation": "

Properties of the HTTP URL.

" } + }, + "status": { + "target": "com.amazonaws.iot#TopicRuleDestinationStatus", + "traits": { + "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
" + } } }, "traits": { @@ -23337,12 +24168,6 @@ "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
" } }, - "arn": { - "target": "com.amazonaws.iot#AwsArn", - "traits": { - "smithy.api#documentation": "

The topic rule destination ARN.

" - } - }, "httpUrlSummary": { "target": "com.amazonaws.iot#HttpUrlDestinationSummary", "traits": { @@ -23354,6 +24179,12 @@ "traits": { "smithy.api#documentation": "

The reason the topic rule destination is in the current status.

" } + }, + "arn": { + "target": "com.amazonaws.iot#AwsArn", + "traits": { + "smithy.api#documentation": "

The topic rule destination ARN.

" + } } }, "traits": { @@ -23369,18 +24200,18 @@ "com.amazonaws.iot#TopicRuleListItem": { "type": "structure", "members": { - "ruleDisabled": { - "target": "com.amazonaws.iot#IsDisabled", - "traits": { - "smithy.api#documentation": "

Specifies whether the rule is disabled.

" - } - }, "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

" } }, + "ruleDisabled": { + "target": "com.amazonaws.iot#IsDisabled", + "traits": { + "smithy.api#documentation": "

Specifies whether the rule is disabled.

" + } + }, "createdAt": { "target": "com.amazonaws.iot#CreatedAtDate", "traits": { @@ -23417,17 +24248,16 @@ "com.amazonaws.iot#TopicRulePayload": { "type": "structure", "members": { - "sql": { - "target": "com.amazonaws.iot#SQL", + "errorAction": { + "target": "com.amazonaws.iot#Action", "traits": { - "smithy.api#documentation": "

The SQL statement used to query the topic. For more information, see AWS IoT SQL\n Reference in the AWS IoT Developer Guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The action to take when an error occurs.

" } }, - "awsIotSqlVersion": { - "target": "com.amazonaws.iot#AwsIotSqlVersion", + "description": { + "target": "com.amazonaws.iot#Description", "traits": { - "smithy.api#documentation": "

The version of the SQL rules engine to use when evaluating the rule.

" + "smithy.api#documentation": "

The description of the rule.

" } }, "ruleDisabled": { @@ -23436,23 +24266,24 @@ "smithy.api#documentation": "

Specifies whether the rule is disabled.

" } }, - "actions": { - "target": "com.amazonaws.iot#ActionList", + "awsIotSqlVersion": { + "target": "com.amazonaws.iot#AwsIotSqlVersion", "traits": { - "smithy.api#documentation": "

The actions associated with the rule.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The version of the SQL rules engine to use when evaluating the rule.

" } }, - "errorAction": { - "target": "com.amazonaws.iot#Action", + "sql": { + "target": "com.amazonaws.iot#SQL", "traits": { - "smithy.api#documentation": "

The action to take when an error occurs.

" + "smithy.api#documentation": "

The SQL statement used to query the topic. For more information, see AWS IoT SQL\n Reference in the AWS IoT Developer Guide.

", + "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.iot#Description", + "actions": { + "target": "com.amazonaws.iot#ActionList", "traits": { - "smithy.api#documentation": "

The description of the rule.

" + "smithy.api#documentation": "

The actions associated with the rule.

", + "smithy.api#required": {} } } }, @@ -23540,6 +24371,14 @@ "com.amazonaws.iot#TransferCertificateRequest": { "type": "structure", "members": { + "targetAwsAccount": { + "target": "com.amazonaws.iot#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS account.

", + "smithy.api#httpQuery": "targetAwsAccount", + "smithy.api#required": {} + } + }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { @@ -23553,14 +24392,6 @@ "traits": { "smithy.api#documentation": "

The transfer message.

" } - }, - "targetAwsAccount": { - "target": "com.amazonaws.iot#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The AWS account.

", - "smithy.api#httpQuery": "targetAwsAccount", - "smithy.api#required": {} - } } }, "traits": { @@ -23600,34 +24431,34 @@ "com.amazonaws.iot#TransferData": { "type": "structure", "members": { - "transferDate": { + "acceptDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date the transfer took place.

" + "smithy.api#documentation": "

The date the transfer was accepted.

" } }, - "rejectDate": { + "transferDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date the transfer was rejected.

" + "smithy.api#documentation": "

The date the transfer took place.

" } }, - "rejectReason": { + "transferMessage": { "target": "com.amazonaws.iot#Message", "traits": { - "smithy.api#documentation": "

The reason why the transfer was rejected.

" + "smithy.api#documentation": "

The transfer message.

" } }, - "acceptDate": { + "rejectDate": { "target": "com.amazonaws.iot#DateType", "traits": { - "smithy.api#documentation": "

The date the transfer was accepted.

" + "smithy.api#documentation": "

The date the transfer was rejected.

" } }, - "transferMessage": { + "rejectReason": { "target": "com.amazonaws.iot#Message", "traits": { - "smithy.api#documentation": "

The transfer message.

" + "smithy.api#documentation": "

The reason why the transfer was rejected.

" } } }, @@ -23748,10 +24579,10 @@ "com.amazonaws.iot#UpdateAccountAuditConfigurationRequest": { "type": "structure", "members": { - "auditCheckConfigurations": { - "target": "com.amazonaws.iot#AuditCheckConfigurations", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

Specifies which audit checks are enabled and disabled for this account. Use \n DescribeAccountAuditConfiguration to see the list of all checks, including those \n that are currently enabled.

\n

Some data collection might start immediately when certain checks are enabled. \n When a check is disabled, any data collected so far in relation to the check is deleted.

\n

You cannot disable a check if it is used by any scheduled audit. You must first delete the check\n from the scheduled audit or delete the scheduled audit itself.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required and must specify at least one enabled check.

" + "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT to access information\n about your devices, policies, certificates and other items as required when \n performing an audit.

" } }, "auditNotificationTargetConfigurations": { @@ -23760,10 +24591,10 @@ "smithy.api#documentation": "

Information about the targets to which audit notifications are sent.

" } }, - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "auditCheckConfigurations": { + "target": "com.amazonaws.iot#AuditCheckConfigurations", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT to access information\n about your devices, policies, certificates and other items as required when \n performing an audit.

" + "smithy.api#documentation": "

Specifies which audit checks are enabled and disabled for this account. Use \n DescribeAccountAuditConfiguration to see the list of all checks, including those \n that are currently enabled.

\n

Some data collection might start immediately when certain checks are enabled. \n When a check is disabled, any data collected so far in relation to the check is deleted.

\n

You cannot disable a check if it is used by any scheduled audit. You must first delete the check\n from the scheduled audit or delete the scheduled audit itself.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required and must specify at least one enabled check.

" } } } @@ -23772,6 +24603,76 @@ "type": "structure", "members": {} }, + "com.amazonaws.iot#UpdateAuditSuppression": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#UpdateAuditSuppressionRequest" + }, + "output": { + "target": "com.amazonaws.iot#UpdateAuditSuppressionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates a Device Defender audit suppression.\n

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/audit/suppressions/update", + "code": 200 + } + } + }, + "com.amazonaws.iot#UpdateAuditSuppressionRequest": { + "type": "structure", + "members": { + "suppressIndefinitely": { + "target": "com.amazonaws.iot#SuppressIndefinitely", + "traits": { + "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" + } + }, + "checkName": { + "target": "com.amazonaws.iot#AuditCheckName", + "traits": { + "smithy.api#required": {} + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.iot#ResourceIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iot#AuditDescription", + "traits": { + "smithy.api#documentation": "

\n The description of the audit suppression.\n

" + } + }, + "expirationDate": { + "target": "com.amazonaws.iot#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.\n

" + } + } + } + }, + "com.amazonaws.iot#UpdateAuditSuppressionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iot#UpdateAuthorizer": { "type": "operation", "input": { @@ -23815,10 +24716,18 @@ "com.amazonaws.iot#UpdateAuthorizerRequest": { "type": "structure", "members": { - "authorizerFunctionArn": { - "target": "com.amazonaws.iot#AuthorizerFunctionArn", + "status": { + "target": "com.amazonaws.iot#AuthorizerStatus", + "traits": { + "smithy.api#documentation": "

The status of the update authorizer request.

" + } + }, + "authorizerName": { + "target": "com.amazonaws.iot#AuthorizerName", "traits": { - "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

" + "smithy.api#documentation": "

The authorizer name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "tokenKeyName": { @@ -23833,18 +24742,10 @@ "smithy.api#documentation": "

The public keys used to verify the token signature.

" } }, - "status": { - "target": "com.amazonaws.iot#AuthorizerStatus", - "traits": { - "smithy.api#documentation": "

The status of the update authorizer request.

" - } - }, - "authorizerName": { - "target": "com.amazonaws.iot#AuthorizerName", + "authorizerFunctionArn": { + "target": "com.amazonaws.iot#AuthorizerFunctionArn", "traits": { - "smithy.api#documentation": "

The authorizer name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

" } } } @@ -23852,17 +24753,17 @@ "com.amazonaws.iot#UpdateAuthorizerResponse": { "type": "structure", "members": { - "authorizerName": { - "target": "com.amazonaws.iot#AuthorizerName", - "traits": { - "smithy.api#documentation": "

The authorizer name.

" - } - }, "authorizerArn": { "target": "com.amazonaws.iot#AuthorizerArn", "traits": { "smithy.api#documentation": "

The authorizer ARN.

" } + }, + "authorizerName": { + "target": "com.amazonaws.iot#AuthorizerName", + "traits": { + "smithy.api#documentation": "

The authorizer name.

" + } } } }, @@ -23989,10 +24890,11 @@ "com.amazonaws.iot#UpdateCACertificateRequest": { "type": "structure", "members": { - "removeAutoRegistration": { - "target": "com.amazonaws.iot#RemoveAutoRegistration", + "newAutoRegistrationStatus": { + "target": "com.amazonaws.iot#AutoRegistrationStatus", "traits": { - "smithy.api#documentation": "

If true, removes auto registration.

" + "smithy.api#documentation": "

The new value for the auto registration status. Valid values are: \"ENABLE\" or\n \"DISABLE\".

", + "smithy.api#httpQuery": "newAutoRegistrationStatus" } }, "certificateId": { @@ -24003,24 +24905,23 @@ "smithy.api#required": {} } }, - "newStatus": { - "target": "com.amazonaws.iot#CACertificateStatus", + "registrationConfig": { + "target": "com.amazonaws.iot#RegistrationConfig", "traits": { - "smithy.api#documentation": "

The updated status of the CA certificate.

\n

\n Note: The status value REGISTER_INACTIVE is deprecated and\n should not be used.

", - "smithy.api#httpQuery": "newStatus" + "smithy.api#documentation": "

Information about the registration configuration.

" } }, - "newAutoRegistrationStatus": { - "target": "com.amazonaws.iot#AutoRegistrationStatus", + "removeAutoRegistration": { + "target": "com.amazonaws.iot#RemoveAutoRegistration", "traits": { - "smithy.api#documentation": "

The new value for the auto registration status. Valid values are: \"ENABLE\" or\n \"DISABLE\".

", - "smithy.api#httpQuery": "newAutoRegistrationStatus" + "smithy.api#documentation": "

If true, removes auto registration.

" } }, - "registrationConfig": { - "target": "com.amazonaws.iot#RegistrationConfig", + "newStatus": { + "target": "com.amazonaws.iot#CACertificateStatus", "traits": { - "smithy.api#documentation": "

Information about the registration configuration.

" + "smithy.api#documentation": "

The updated status of the CA certificate.

\n

\n Note: The status value REGISTER_INACTIVE is deprecated and\n should not be used.

", + "smithy.api#httpQuery": "newStatus" } } }, @@ -24057,7 +24958,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status of the specified certificate. This operation is\n idempotent.

\n

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect\n currently connected devices, but these devices will be unable to reconnect.

\n

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a\n certificate.

", + "smithy.api#documentation": "

Updates the status of the specified certificate. This operation is\n idempotent.

\n

Certificates must be in the ACTIVE state to authenticate devices that use\n a certificate to connect to AWS IoT.

\n

Within a few minutes of updating a certificate from the ACTIVE state to any other\n state, AWS IoT disconnects all devices that used that certificate to connect. Devices cannot\n use a certificate that is not in the ACTIVE state to reconnect.

", "smithy.api#http": { "method": "PUT", "uri": "/certificates/{certificateId}", @@ -24068,14 +24969,6 @@ "com.amazonaws.iot#UpdateCertificateRequest": { "type": "structure", "members": { - "certificateId": { - "target": "com.amazonaws.iot#CertificateId", - "traits": { - "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "newStatus": { "target": "com.amazonaws.iot#CertificateStatus", "traits": { @@ -24083,6 +24976,14 @@ "smithy.api#httpQuery": "newStatus", "smithy.api#required": {} } + }, + "certificateId": { + "target": "com.amazonaws.iot#CertificateId", + "traits": { + "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -24138,18 +25039,18 @@ "com.amazonaws.iot#UpdateDimensionRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.iot#DimensionName", + "stringValues": { + "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } }, - "stringValues": { - "target": "com.amazonaws.iot#DimensionStringValues", + "name": { + "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", + "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -24158,40 +25059,40 @@ "com.amazonaws.iot#UpdateDimensionResponse": { "type": "structure", "members": { - "stringValues": { - "target": "com.amazonaws.iot#DimensionStringValues", + "creationDate": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" + "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was initially created.

" } }, - "type": { - "target": "com.amazonaws.iot#DimensionType", + "arn": { + "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "

The type of the dimension.

" + "smithy.api#documentation": "

The ARN (Amazon resource name) of the created dimension.

" } }, - "creationDate": { + "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was initially created.

" + "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

" } }, - "name": { - "target": "com.amazonaws.iot#DimensionName", + "stringValues": { + "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension.

" + "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" } }, - "arn": { - "target": "com.amazonaws.iot#DimensionArn", + "name": { + "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

The ARN (Amazon resource name) of the created dimension.

" + "smithy.api#documentation": "

A unique identifier for the dimension.

" } }, - "lastModifiedDate": { - "target": "com.amazonaws.iot#Timestamp", + "type": { + "target": "com.amazonaws.iot#DimensionType", "traits": { - "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

" + "smithy.api#documentation": "

The type of the dimension.

" } } } @@ -24239,12 +25140,10 @@ "com.amazonaws.iot#UpdateDomainConfigurationRequest": { "type": "structure", "members": { - "domainConfigurationName": { - "target": "com.amazonaws.iot#ReservedDomainConfigurationName", + "authorizerConfig": { + "target": "com.amazonaws.iot#AuthorizerConfig", "traits": { - "smithy.api#documentation": "

The name of the domain configuration to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" } }, "domainConfigurationStatus": { @@ -24253,10 +25152,12 @@ "smithy.api#documentation": "

The status to which the domain configuration should be updated.

" } }, - "authorizerConfig": { - "target": "com.amazonaws.iot#AuthorizerConfig", + "domainConfigurationName": { + "target": "com.amazonaws.iot#ReservedDomainConfigurationName", "traits": { - "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" + "smithy.api#documentation": "

The name of the domain configuration to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "removeAuthorizerConfig": { @@ -24324,14 +25225,6 @@ "com.amazonaws.iot#UpdateDynamicThingGroupRequest": { "type": "structure", "members": { - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", - "traits": { - "smithy.api#documentation": "

The name of the dynamic thing group to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { @@ -24345,12 +25238,6 @@ "smithy.api#documentation": "

The expected version of the dynamic thing group to update.

" } }, - "indexName": { - "target": "com.amazonaws.iot#IndexName", - "traits": { - "smithy.api#documentation": "

The dynamic thing group index to update.

\n\t\t \n\t\t\t

Currently one index is supported: 'AWS_Things'.

\n\t\t " - } - }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { @@ -24362,6 +25249,20 @@ "traits": { "smithy.api#documentation": "

The dynamic thing group query version to update.

\n\t\t \n\t\t\t

Currently one query version is supported: \"2017-09-30\". If not specified, the\n\t\t\t\tquery version defaults to this value.

\n\t\t " } + }, + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", + "traits": { + "smithy.api#documentation": "

The name of the dynamic thing group to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexName": { + "target": "com.amazonaws.iot#IndexName", + "traits": { + "smithy.api#documentation": "

The dynamic thing group index to update.

\n\t\t \n\t\t\t

Currently one index is supported: 'AWS_Things'.

\n\t\t " + } } } }, @@ -24456,17 +25357,17 @@ "com.amazonaws.iot#UpdateIndexingConfigurationRequest": { "type": "structure", "members": { - "thingIndexingConfiguration": { - "target": "com.amazonaws.iot#ThingIndexingConfiguration", - "traits": { - "smithy.api#documentation": "

Thing indexing configuration.

" - } - }, "thingGroupIndexingConfiguration": { "target": "com.amazonaws.iot#ThingGroupIndexingConfiguration", "traits": { "smithy.api#documentation": "

Thing group indexing configuration.

" } + }, + "thingIndexingConfiguration": { + "target": "com.amazonaws.iot#ThingIndexingConfiguration", + "traits": { + "smithy.api#documentation": "

Thing indexing configuration.

" + } } } }, @@ -24505,24 +25406,16 @@ "com.amazonaws.iot#UpdateJobRequest": { "type": "structure", "members": { - "jobId": { - "target": "com.amazonaws.iot#JobId", - "traits": { - "smithy.api#documentation": "

The ID of the job to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "presignedUrlConfig": { "target": "com.amazonaws.iot#PresignedUrlConfig", "traits": { "smithy.api#documentation": "

Configuration information for pre-signed S3 URLs.

" } }, - "timeoutConfig": { - "target": "com.amazonaws.iot#TimeoutConfig", + "jobExecutionsRolloutConfig": { + "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", "traits": { - "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. \n If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

" + "smithy.api#documentation": "

Allows you to create a staged rollout of the job.

" } }, "description": { @@ -24531,10 +25424,18 @@ "smithy.api#documentation": "

A short text description of the job.

" } }, - "jobExecutionsRolloutConfig": { - "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", + "jobId": { + "target": "com.amazonaws.iot#JobId", "traits": { - "smithy.api#documentation": "

Allows you to create a staged rollout of the job.

" + "smithy.api#documentation": "

The ID of the job to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "timeoutConfig": { + "target": "com.amazonaws.iot#TimeoutConfig", + "traits": { + "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. \n If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

" } }, "abortConfig": { @@ -24579,6 +25480,14 @@ "com.amazonaws.iot#UpdateMitigationActionRequest": { "type": "structure", "members": { + "actionName": { + "target": "com.amazonaws.iot#MitigationActionName", + "traits": { + "smithy.api#documentation": "

The friendly name for the mitigation action. You can't change the name by using UpdateMitigationAction. Instead, you must delete and re-create the mitigation action with the new name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { @@ -24590,31 +25499,23 @@ "traits": { "smithy.api#documentation": "

Defines the type of action and the parameters for that action.

" } - }, - "actionName": { - "target": "com.amazonaws.iot#MitigationActionName", - "traits": { - "smithy.api#documentation": "

The friendly name for the mitigation action. You can't change the name by using UpdateMitigationAction. Instead, you must delete and re-create the mitigation action with the new name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.iot#UpdateMitigationActionResponse": { "type": "structure", "members": { - "actionId": { - "target": "com.amazonaws.iot#MitigationActionId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the mitigation action.

" - } - }, "actionArn": { "target": "com.amazonaws.iot#MitigationActionArn", "traits": { "smithy.api#documentation": "

The ARN for the new mitigation action.

" } + }, + "actionId": { + "target": "com.amazonaws.iot#MitigationActionId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the mitigation action.

" + } } } }, @@ -24655,20 +25556,6 @@ "com.amazonaws.iot#UpdateProvisioningTemplateRequest": { "type": "structure", "members": { - "templateName": { - "target": "com.amazonaws.iot#TemplateName", - "traits": { - "smithy.api#documentation": "

The name of the fleet provisioning template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "enabled": { - "target": "com.amazonaws.iot#Enabled", - "traits": { - "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" - } - }, "removePreProvisioningHook": { "target": "com.amazonaws.iot#RemoveHook", "traits": { @@ -24678,7 +25565,15 @@ "preProvisioningHook": { "target": "com.amazonaws.iot#ProvisioningHook", "traits": { - "smithy.api#documentation": "

Updates the pre-provisioning hook template.

" + "smithy.api#documentation": "

Updates the pre-provisioning hook template.

" + } + }, + "templateName": { + "target": "com.amazonaws.iot#TemplateName", + "traits": { + "smithy.api#documentation": "

The name of the fleet provisioning template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "defaultVersionId": { @@ -24698,6 +25593,12 @@ "traits": { "smithy.api#documentation": "

The ARN of the role associated with the provisioning template. This IoT role grants\n permission to provision a device.

" } + }, + "enabled": { + "target": "com.amazonaws.iot#Enabled", + "traits": { + "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" + } } } }, @@ -24745,10 +25646,10 @@ "com.amazonaws.iot#UpdateRoleAliasRequest": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iot#RoleArn", + "credentialDurationSeconds": { + "target": "com.amazonaws.iot#CredentialDurationSeconds", "traits": { - "smithy.api#documentation": "

The role ARN.

" + "smithy.api#documentation": "

The number of seconds the credential will be valid.

" } }, "roleAlias": { @@ -24759,10 +25660,10 @@ "smithy.api#required": {} } }, - "credentialDurationSeconds": { - "target": "com.amazonaws.iot#CredentialDurationSeconds", + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The number of seconds the credential will be valid.

" + "smithy.api#documentation": "

The role ARN.

" } } } @@ -24770,17 +25671,17 @@ "com.amazonaws.iot#UpdateRoleAliasResponse": { "type": "structure", "members": { - "roleAliasArn": { - "target": "com.amazonaws.iot#RoleAliasArn", - "traits": { - "smithy.api#documentation": "

The role alias ARN.

" - } - }, "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias.

" } + }, + "roleAliasArn": { + "target": "com.amazonaws.iot#RoleAliasArn", + "traits": { + "smithy.api#documentation": "

The role alias ARN.

" + } } } }, @@ -24818,12 +25719,6 @@ "com.amazonaws.iot#UpdateScheduledAuditRequest": { "type": "structure", "members": { - "dayOfWeek": { - "target": "com.amazonaws.iot#DayOfWeek", - "traits": { - "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place. Can be one of\n \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the\n \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".

" - } - }, "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { @@ -24849,6 +25744,12 @@ "traits": { "smithy.api#documentation": "

How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\",\n \"BIWEEKLY\", or \"MONTHLY\". The start time of each audit is determined by\n the system.

" } + }, + "dayOfWeek": { + "target": "com.amazonaws.iot#DayOfWeek", + "traits": { + "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place. Can be one of\n \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the\n \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".

" + } } } }, @@ -24900,40 +25801,19 @@ "com.amazonaws.iot#UpdateSecurityProfileRequest": { "type": "structure", "members": { - "deleteBehaviors": { - "target": "com.amazonaws.iot#DeleteBehaviors", - "traits": { - "smithy.api#documentation": "

If true, delete all behaviors defined for this security profile. \n If any behaviors are defined in the current invocation, an exception occurs.

" - } - }, "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { "smithy.api#documentation": "

A description of the security profile.

" } }, - "expectedVersion": { - "target": "com.amazonaws.iot#OptionalVersion", - "traits": { - "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", - "smithy.api#httpQuery": "expectedVersion" - } - }, - "securityProfileName": { - "target": "com.amazonaws.iot#SecurityProfileName", - "traits": { - "smithy.api#documentation": "

The name of the security profile you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "additionalMetricsToRetain": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", "traits": { "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here.

\n

\n Note: This API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

" + "smithy.api#documentation": "

\n Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here.

" } }, "deleteAdditionalMetricsToRetain": { @@ -24948,42 +25828,72 @@ "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, - "deleteAlertTargets": { - "target": "com.amazonaws.iot#DeleteAlertTargets", - "traits": { - "smithy.api#documentation": "

If true, delete all alertTargets defined for this security profile. \n If any alertTargets are defined in the current invocation, an exception occurs.

" - } - }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { "smithy.api#documentation": "

Where the alerts are sent. (Alerts are always sent to the console.)

" } }, + "securityProfileName": { + "target": "com.amazonaws.iot#SecurityProfileName", + "traits": { + "smithy.api#documentation": "

The name of the security profile you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "deleteAlertTargets": { + "target": "com.amazonaws.iot#DeleteAlertTargets", + "traits": { + "smithy.api#documentation": "

If true, delete all alertTargets defined for this security profile. \n If any alertTargets are defined in the current invocation, an exception occurs.

" + } + }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

" } + }, + "expectedVersion": { + "target": "com.amazonaws.iot#OptionalVersion", + "traits": { + "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", + "smithy.api#httpQuery": "expectedVersion" + } + }, + "deleteBehaviors": { + "target": "com.amazonaws.iot#DeleteBehaviors", + "traits": { + "smithy.api#documentation": "

If true, delete all behaviors defined for this security profile. \n If any behaviors are defined in the current invocation, an exception occurs.

" + } } } }, "com.amazonaws.iot#UpdateSecurityProfileResponse": { "type": "structure", "members": { - "additionalMetricsToRetain": { - "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", + "behaviors": { + "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#deprecated": { - "message": "Use additionalMetricsToRetainV2." - }, - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the security profile's behaviors, but it is also retained for \n any metric specified here.

\n

\n Note: This API field is deprecated. Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, - "creationDate": { - "target": "com.amazonaws.iot#Timestamp", + "securityProfileArn": { + "target": "com.amazonaws.iot#SecurityProfileArn", "traits": { - "smithy.api#documentation": "

The time the security profile was created.

" + "smithy.api#documentation": "

The ARN of the security profile that was updated.

" + } + }, + "securityProfileDescription": { + "target": "com.amazonaws.iot#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

" + } + }, + "alertTargets": { + "target": "com.amazonaws.iot#AlertTargets", + "traits": { + "smithy.api#documentation": "

Where the alerts are sent. (Alerts are always sent to the console.)

" } }, "additionalMetricsToRetainV2": { @@ -24992,10 +25902,10 @@ "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

" } }, - "behaviors": { - "target": "com.amazonaws.iot#Behaviors", + "lastModifiedDate": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + "smithy.api#documentation": "

The time the security profile was last modified.

" } }, "securityProfileName": { @@ -25004,22 +25914,19 @@ "smithy.api#documentation": "

The name of the security profile that was updated.

" } }, - "securityProfileDescription": { - "target": "com.amazonaws.iot#SecurityProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the security profile.

" - } - }, - "securityProfileArn": { - "target": "com.amazonaws.iot#SecurityProfileArn", + "additionalMetricsToRetain": { + "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", "traits": { - "smithy.api#documentation": "

The ARN of the security profile that was updated.

" + "smithy.api#deprecated": { + "message": "Use additionalMetricsToRetainV2." + }, + "smithy.api#documentation": "

\n Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the security profile's behaviors, but it is also retained for \n any metric specified here.

" } }, - "lastModifiedDate": { + "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The time the security profile was last modified.

" + "smithy.api#documentation": "

The time the security profile was created.

" } }, "version": { @@ -25027,12 +25934,6 @@ "traits": { "smithy.api#documentation": "

The updated version of the security profile.

" } - }, - "alertTargets": { - "target": "com.amazonaws.iot#AlertTargets", - "traits": { - "smithy.api#documentation": "

Where the alerts are sent. (Alerts are always sent to the console.)

" - } } } }, @@ -25113,10 +26014,10 @@ "smithy.api#documentation": "

The stream ID.

" } }, - "streamArn": { - "target": "com.amazonaws.iot#StreamArn", + "streamVersion": { + "target": "com.amazonaws.iot#StreamVersion", "traits": { - "smithy.api#documentation": "

The stream ARN.

" + "smithy.api#documentation": "

The stream version.

" } }, "description": { @@ -25125,10 +26026,10 @@ "smithy.api#documentation": "

A description of the stream.

" } }, - "streamVersion": { - "target": "com.amazonaws.iot#StreamVersion", + "streamArn": { + "target": "com.amazonaws.iot#StreamArn", "traits": { - "smithy.api#documentation": "

The stream version.

" + "smithy.api#documentation": "

The stream ARN.

" } } } @@ -25210,11 +26111,10 @@ "com.amazonaws.iot#UpdateThingGroupRequest": { "type": "structure", "members": { - "thingGroupName": { - "target": "com.amazonaws.iot#ThingGroupName", + "thingGroupProperties": { + "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { - "smithy.api#documentation": "

The thing group to update.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The thing group properties.

", "smithy.api#required": {} } }, @@ -25224,10 +26124,11 @@ "smithy.api#documentation": "

The expected version of the thing group. If this does not match the version of the\n\t\t\tthing group being updated, the update will fail.

" } }, - "thingGroupProperties": { - "target": "com.amazonaws.iot#ThingGroupProperties", + "thingGroupName": { + "target": "com.amazonaws.iot#ThingGroupName", "traits": { - "smithy.api#documentation": "

The thing group properties.

", + "smithy.api#documentation": "

The thing group to update.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -25278,10 +26179,10 @@ "com.amazonaws.iot#UpdateThingGroupsForThingRequest": { "type": "structure", "members": { - "overrideDynamicGroups": { - "target": "com.amazonaws.iot#OverrideDynamicGroups", + "thingName": { + "target": "com.amazonaws.iot#ThingName", "traits": { - "smithy.api#documentation": "

Override dynamic thing groups with static thing groups when 10-group limit is\n\t\t\treached. If a thing belongs to 10 thing groups, and one or more of those groups are\n\t\t\tdynamic thing groups, adding a thing to a static group removes the thing from the last\n\t\t\tdynamic group.

" + "smithy.api#documentation": "

The thing whose group memberships will be updated.

" } }, "thingGroupsToRemove": { @@ -25290,10 +26191,10 @@ "smithy.api#documentation": "

The groups from which the thing will be removed.

" } }, - "thingName": { - "target": "com.amazonaws.iot#ThingName", + "overrideDynamicGroups": { + "target": "com.amazonaws.iot#OverrideDynamicGroups", "traits": { - "smithy.api#documentation": "

The thing whose group memberships will be updated.

" + "smithy.api#documentation": "

Override dynamic thing groups with static thing groups when 10-group limit is\n\t\t\treached. If a thing belongs to 10 thing groups, and one or more of those groups are\n\t\t\tdynamic thing groups, adding a thing to a static group removes the thing from the last\n\t\t\tdynamic group.

" } }, "thingGroupsToAdd": { @@ -25311,18 +26212,18 @@ "com.amazonaws.iot#UpdateThingRequest": { "type": "structure", "members": { - "thingTypeName": { - "target": "com.amazonaws.iot#ThingTypeName", - "traits": { - "smithy.api#documentation": "

The name of the thing type.

" - } - }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the thing record in the registry. If the version of the\n\t\t\trecord in the registry does not match the expected version specified in the request, the\n\t\t\t\tUpdateThing request is rejected with a\n\t\t\t\tVersionConflictException.

" } }, + "thingTypeName": { + "target": "com.amazonaws.iot#ThingTypeName", + "traits": { + "smithy.api#documentation": "

The name of the thing type.

" + } + }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { @@ -25392,17 +26293,17 @@ "com.amazonaws.iot#UpdateTopicRuleDestinationRequest": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.iot#AwsArn", + "status": { + "target": "com.amazonaws.iot#TopicRuleDestinationStatus", "traits": { - "smithy.api#documentation": "

The ARN of the topic rule destination.

", + "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.iot#TopicRuleDestinationStatus", + "arn": { + "target": "com.amazonaws.iot#AwsArn", "traits": { - "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
", + "smithy.api#documentation": "

The ARN of the topic rule destination.

", "smithy.api#required": {} } } @@ -25554,28 +26455,28 @@ "com.amazonaws.iot#ViolationEvent": { "type": "structure", "members": { - "violationEventTime": { - "target": "com.amazonaws.iot#Timestamp", + "metricValue": { + "target": "com.amazonaws.iot#MetricValue", "traits": { - "smithy.api#documentation": "

The time the violation event occurred.

" + "smithy.api#documentation": "

The value of the metric (the measurement).

" } }, - "violationId": { - "target": "com.amazonaws.iot#ViolationId", + "thingName": { + "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { - "smithy.api#documentation": "

The ID of the violation event.

" + "smithy.api#documentation": "

The name of the thing responsible for the violation event.

" } }, - "behavior": { - "target": "com.amazonaws.iot#Behavior", + "violationEventType": { + "target": "com.amazonaws.iot#ViolationEventType", "traits": { - "smithy.api#documentation": "

The behavior which was violated.

" + "smithy.api#documentation": "

The type of violation event.

" } }, - "metricValue": { - "target": "com.amazonaws.iot#MetricValue", + "violationEventTime": { + "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The value of the metric (the measurement).

" + "smithy.api#documentation": "

The time the violation event occurred.

" } }, "securityProfileName": { @@ -25584,16 +26485,16 @@ "smithy.api#documentation": "

The name of the security profile whose behavior was violated.

" } }, - "thingName": { - "target": "com.amazonaws.iot#DeviceDefenderThingName", + "violationId": { + "target": "com.amazonaws.iot#ViolationId", "traits": { - "smithy.api#documentation": "

The name of the thing responsible for the violation event.

" + "smithy.api#documentation": "

The ID of the violation event.

" } }, - "violationEventType": { - "target": "com.amazonaws.iot#ViolationEventType", + "behavior": { + "target": "com.amazonaws.iot#Behavior", "traits": { - "smithy.api#documentation": "

The type of violation event.

" + "smithy.api#documentation": "

The behavior which was violated.

" } } }, 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 d81226da9153..ad347e6aa2b8 100644 --- a/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json +++ b/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json @@ -173,13 +173,6 @@ "com.amazonaws.iotanalytics#AddAttributesActivity": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "

The name of the 'addAttributes' activity.

", - "smithy.api#required": {} - } - }, "attributes": { "target": "com.amazonaws.iotanalytics#AttributeNameMapping", "traits": { @@ -192,6 +185,13 @@ "traits": { "smithy.api#documentation": "

The next activity in the pipeline.

" } + }, + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "

The name of the 'addAttributes' activity.

", + "smithy.api#required": {} + } } }, "traits": { @@ -303,17 +303,17 @@ "com.amazonaws.iotanalytics#BatchPutMessageRequest": { "type": "structure", "members": { - "messages": { - "target": "com.amazonaws.iotanalytics#Messages", + "channelName": { + "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { - "smithy.api#documentation": "

The list of messages to be sent. Each message has format:\n '{ \"messageId\": \"string\", \"payload\": \"string\"}'.

\n

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

\n \n

For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29},\n {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.

", + "smithy.api#documentation": "

The name of the channel where the messages are sent.

", "smithy.api#required": {} } }, - "channelName": { - "target": "com.amazonaws.iotanalytics#ChannelName", + "messages": { + "target": "com.amazonaws.iotanalytics#Messages", "traits": { - "smithy.api#documentation": "

The name of the channel where the messages are sent.

", + "smithy.api#documentation": "

The list of messages to be sent. Each message has format:\n '{ \"messageId\": \"string\", \"payload\": \"string\"}'.

\n

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

\n \n

For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29},\n {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.

", "smithy.api#required": {} } } @@ -412,10 +412,10 @@ "com.amazonaws.iotanalytics#Channel": { "type": "structure", "members": { - "lastUpdateTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "arn": { + "target": "com.amazonaws.iotanalytics#ChannelArn", "traits": { - "smithy.api#documentation": "

When the channel was last updated.

" + "smithy.api#documentation": "

The ARN of the channel.

" } }, "storage": { @@ -424,16 +424,22 @@ "smithy.api#documentation": "

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.

" } }, + "lastUpdateTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "

When the channel was last updated.

" + } + }, "name": { "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { "smithy.api#documentation": "

The name of the channel.

" } }, - "arn": { - "target": "com.amazonaws.iotanalytics#ChannelArn", + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "

The ARN of the channel.

" + "smithy.api#documentation": "

How long, in days, message data is kept for the channel.

" } }, "status": { @@ -442,12 +448,6 @@ "smithy.api#documentation": "

The status of the channel.

" } }, - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

How long, in days, message data is kept for the channel.

" - } - }, "creationTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -462,13 +462,6 @@ "com.amazonaws.iotanalytics#ChannelActivity": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "

The name of the 'channel' activity.

", - "smithy.api#required": {} - } - }, "channelName": { "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { @@ -481,6 +474,13 @@ "traits": { "smithy.api#documentation": "

The next activity in the pipeline.

" } + }, + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "

The name of the 'channel' activity.

", + "smithy.api#required": {} + } } }, "traits": { @@ -582,12 +582,6 @@ "com.amazonaws.iotanalytics#ChannelSummary": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.iotanalytics#ChannelStatus", - "traits": { - "smithy.api#documentation": "

The status of the channel.

" - } - }, "creationTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -606,6 +600,12 @@ "smithy.api#documentation": "

The name of the channel.

" } }, + "status": { + "target": "com.amazonaws.iotanalytics#ChannelStatus", + "traits": { + "smithy.api#documentation": "

The status of the channel.

" + } + }, "lastUpdateTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -635,13 +635,6 @@ "com.amazonaws.iotanalytics#ContainerDatasetAction": { "type": "structure", "members": { - "executionRoleArn": { - "target": "com.amazonaws.iotanalytics#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of the role which gives permission to the system to access needed resources in order\n to run the \"containerAction\". This includes, at minimum, permission to retrieve the data set\n contents which are the input to the containerized application.

", - "smithy.api#required": {} - } - }, "variables": { "target": "com.amazonaws.iotanalytics#Variables", "traits": { @@ -661,6 +654,13 @@ "smithy.api#documentation": "

The ARN of the Docker container stored in your account. The Docker container contains an\n application and needed support libraries and is used to generate data set contents.

", "smithy.api#required": {} } + }, + "executionRoleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role which gives permission to the system to access needed resources in order\n to run the \"containerAction\". This includes, at minimum, permission to retrieve the data set\n contents which are the input to the containerized application.

", + "smithy.api#required": {} + } } }, "traits": { @@ -707,12 +707,6 @@ "com.amazonaws.iotanalytics#CreateChannelRequest": { "type": "structure", "members": { - "channelStorage": { - "target": "com.amazonaws.iotanalytics#ChannelStorage", - "traits": { - "smithy.api#documentation": "

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.

" - } - }, "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { @@ -731,24 +725,30 @@ "smithy.api#documentation": "

The name of the channel.

", "smithy.api#required": {} } + }, + "channelStorage": { + "target": "com.amazonaws.iotanalytics#ChannelStorage", + "traits": { + "smithy.api#documentation": "

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.

" + } } } }, "com.amazonaws.iotanalytics#CreateChannelResponse": { "type": "structure", "members": { - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

How long, in days, message data is kept for the channel.

" - } - }, "channelArn": { "target": "com.amazonaws.iotanalytics#ChannelArn", "traits": { "smithy.api#documentation": "

The ARN of the channel.

" } }, + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

How long, in days, message data is kept for the channel.

" + } + }, "channelName": { "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { @@ -855,12 +855,24 @@ "com.amazonaws.iotanalytics#CreateDatasetRequest": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.iotanalytics#TagList", + "traits": { + "smithy.api#documentation": "

Metadata which can be used to manage the data set.

" + } + }, "versioningConfiguration": { "target": "com.amazonaws.iotanalytics#VersioningConfiguration", "traits": { "smithy.api#documentation": "

[Optional] How many versions of data set contents are kept. If not specified or set to null, only the \n 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, see\n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" } }, + "contentDeliveryRules": { + "target": "com.amazonaws.iotanalytics#DatasetContentDeliveryRules", + "traits": { + "smithy.api#documentation": "

When data set contents are created they are delivered to destinations specified here.

" + } + }, "actions": { "target": "com.amazonaws.iotanalytics#DatasetActions", "traits": { @@ -868,12 +880,6 @@ "smithy.api#required": {} } }, - "contentDeliveryRules": { - "target": "com.amazonaws.iotanalytics#DatasetContentDeliveryRules", - "traits": { - "smithy.api#documentation": "

When data set contents are created they are delivered to destinations specified here.

" - } - }, "datasetName": { "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { @@ -881,41 +887,35 @@ "smithy.api#required": {} } }, - "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 \n be empty or contain up to five DataSetTrigger objects.

" - } - }, - "tags": { - "target": "com.amazonaws.iotanalytics#TagList", - "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the data set.

" - } - }, "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { "smithy.api#documentation": "

[Optional] How long, in days, versions of data set contents are kept for the data set. If \n not specified or set to null, versions of data set contents are retained for at most 90 days. \n The number of versions of data set contents retained is determined by the \n versioningConfiguration parameter. (For more information, see \n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" } + }, + "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 \n be empty or contain up to five DataSetTrigger objects.

" + } } } }, "com.amazonaws.iotanalytics#CreateDatasetResponse": { "type": "structure", "members": { - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", - "traits": { - "smithy.api#documentation": "

How long, in days, data set contents are kept for the data set.

" - } - }, "datasetName": { "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { "smithy.api#documentation": "

The name of the data set.

" } }, + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

How long, in days, data set contents are kept for the data set.

" + } + }, "datasetArn": { "target": "com.amazonaws.iotanalytics#DatasetArn", "traits": { @@ -994,18 +994,18 @@ "com.amazonaws.iotanalytics#CreateDatastoreResponse": { "type": "structure", "members": { - "datastoreArn": { - "target": "com.amazonaws.iotanalytics#DatastoreArn", - "traits": { - "smithy.api#documentation": "

The ARN of the data store.

" - } - }, "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { "smithy.api#documentation": "

How long, in days, message data is kept for the data store.

" } }, + "datastoreArn": { + "target": "com.amazonaws.iotanalytics#DatastoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the data store.

" + } + }, "datastoreName": { "target": "com.amazonaws.iotanalytics#DatastoreName", "traits": { @@ -1054,12 +1054,6 @@ "com.amazonaws.iotanalytics#CreatePipelineRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iotanalytics#TagList", - "traits": { - "smithy.api#documentation": "

Metadata which can be used to manage the pipeline.

" - } - }, "pipelineActivities": { "target": "com.amazonaws.iotanalytics#PipelineActivities", "traits": { @@ -1073,23 +1067,29 @@ "smithy.api#documentation": "

The name of the pipeline.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.iotanalytics#TagList", + "traits": { + "smithy.api#documentation": "

Metadata which can be used to manage the pipeline.

" + } } } }, "com.amazonaws.iotanalytics#CreatePipelineResponse": { "type": "structure", "members": { - "pipelineName": { - "target": "com.amazonaws.iotanalytics#PipelineName", - "traits": { - "smithy.api#documentation": "

The name of the pipeline.

" - } - }, "pipelineArn": { "target": "com.amazonaws.iotanalytics#PipelineArn", "traits": { "smithy.api#documentation": "

The ARN of the pipeline.

" } + }, + "pipelineName": { + "target": "com.amazonaws.iotanalytics#PipelineName", + "traits": { + "smithy.api#documentation": "

The name of the pipeline.

" + } } } }, @@ -1103,18 +1103,18 @@ "smithy.api#required": {} } }, - "keyPrefix": { - "target": "com.amazonaws.iotanalytics#S3KeyPrefix", - "traits": { - "smithy.api#documentation": "

[Optional] The prefix used to create the keys of the channel data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in \n a bucket has exactly one key). The prefix must end with a '/'.

" - } - }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

", "smithy.api#required": {} } + }, + "keyPrefix": { + "target": "com.amazonaws.iotanalytics#S3KeyPrefix", + "traits": { + "smithy.api#documentation": "

[Optional] The prefix used to create the keys of the channel data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in \n a bucket has exactly one key). The prefix must end with a '/'.

" + } } }, "traits": { @@ -1124,12 +1124,6 @@ "com.amazonaws.iotanalytics#CustomerManagedChannelS3StorageSummary": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iotanalytics#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon \n S3 resources.

" - } - }, "keyPrefix": { "target": "com.amazonaws.iotanalytics#S3KeyPrefix", "traits": { @@ -1141,6 +1135,12 @@ "traits": { "smithy.api#documentation": "

The name of the Amazon S3 bucket in which channel data is stored.

" } + }, + "roleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon \n S3 resources.

" + } } }, "traits": { @@ -1150,6 +1150,12 @@ "com.amazonaws.iotanalytics#CustomerManagedDatastoreS3Storage": { "type": "structure", "members": { + "keyPrefix": { + "target": "com.amazonaws.iotanalytics#S3KeyPrefix", + "traits": { + "smithy.api#documentation": "

[Optional] The prefix used to create the keys of the data store data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a \n bucket has exactly one key). The prefix must end with a '/'.

" + } + }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { @@ -1157,12 +1163,6 @@ "smithy.api#required": {} } }, - "keyPrefix": { - "target": "com.amazonaws.iotanalytics#S3KeyPrefix", - "traits": { - "smithy.api#documentation": "

[Optional] The prefix used to create the keys of the data store data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a \n bucket has exactly one key). The prefix must end with a '/'.

" - } - }, "bucket": { "target": "com.amazonaws.iotanalytics#BucketName", "traits": { @@ -1184,17 +1184,17 @@ "smithy.api#documentation": "

The name of the Amazon S3 bucket in which data store data is stored.

" } }, - "keyPrefix": { - "target": "com.amazonaws.iotanalytics#S3KeyPrefix", - "traits": { - "smithy.api#documentation": "

[Optional] The prefix used to create the keys of the data store data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a \n bucket has exactly one key). The prefix must end with a '/'.

" - } - }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

" } + }, + "keyPrefix": { + "target": "com.amazonaws.iotanalytics#S3KeyPrefix", + "traits": { + "smithy.api#documentation": "

[Optional] The prefix used to create the keys of the data store data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a \n bucket has exactly one key). The prefix must end with a '/'.

" + } } }, "traits": { @@ -1204,12 +1204,6 @@ "com.amazonaws.iotanalytics#Dataset": { "type": "structure", "members": { - "versioningConfiguration": { - "target": "com.amazonaws.iotanalytics#VersioningConfiguration", - "traits": { - "smithy.api#documentation": "

[Optional] How many versions of data set contents are kept. If not specified or set to null, only the \n 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, see\n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" - } - }, "status": { "target": "com.amazonaws.iotanalytics#DatasetStatus", "traits": { @@ -1222,10 +1216,16 @@ "smithy.api#documentation": "

The \"DatasetTrigger\" objects\n that specify when the data set is automatically updated.

" } }, - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", + "lastUpdateTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

[Optional] How long, in days, message data is kept for the data set.

" + "smithy.api#documentation": "

The last time the data set was updated.

" + } + }, + "arn": { + "target": "com.amazonaws.iotanalytics#DatasetArn", + "traits": { + "smithy.api#documentation": "

The ARN of the data set.

" } }, "name": { @@ -1240,22 +1240,22 @@ "smithy.api#documentation": "

The \"DatasetAction\" objects that automatically create the data set contents.

" } }, - "arn": { - "target": "com.amazonaws.iotanalytics#DatasetArn", + "contentDeliveryRules": { + "target": "com.amazonaws.iotanalytics#DatasetContentDeliveryRules", "traits": { - "smithy.api#documentation": "

The ARN of the data set.

" + "smithy.api#documentation": "

When data set contents are created they are delivered to destinations specified here.

" } }, - "lastUpdateTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "

The last time the data set was updated.

" + "smithy.api#documentation": "

[Optional] How long, in days, message data is kept for the data set.

" } }, - "contentDeliveryRules": { - "target": "com.amazonaws.iotanalytics#DatasetContentDeliveryRules", + "versioningConfiguration": { + "target": "com.amazonaws.iotanalytics#VersioningConfiguration", "traits": { - "smithy.api#documentation": "

When data set contents are created they are delivered to destinations specified here.

" + "smithy.api#documentation": "

[Optional] How many versions of data set contents are kept. If not specified or set to null, only the \n 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, see\n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" } }, "creationTime": { @@ -1272,18 +1272,18 @@ "com.amazonaws.iotanalytics#DatasetAction": { "type": "structure", "members": { - "containerAction": { - "target": "com.amazonaws.iotanalytics#ContainerDatasetAction", - "traits": { - "smithy.api#documentation": "

Information which allows the system to run a containerized application in order to create\n the data set contents. The application must be in a Docker container along with any needed\n support libraries.

" - } - }, "queryAction": { "target": "com.amazonaws.iotanalytics#SqlQueryDatasetAction", "traits": { "smithy.api#documentation": "

An \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.

" } }, + "containerAction": { + "target": "com.amazonaws.iotanalytics#ContainerDatasetAction", + "traits": { + "smithy.api#documentation": "

Information which allows the system to run a containerized application in order to create\n the data set contents. The application must be in a Docker container along with any needed\n support libraries.

" + } + }, "actionName": { "target": "com.amazonaws.iotanalytics#DatasetActionName", "traits": { @@ -1370,17 +1370,17 @@ "com.amazonaws.iotanalytics#DatasetContentDeliveryDestination": { "type": "structure", "members": { - "s3DestinationConfiguration": { - "target": "com.amazonaws.iotanalytics#S3DestinationConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration information for delivery of data set contents to Amazon S3.

" - } - }, "iotEventsDestinationConfiguration": { "target": "com.amazonaws.iotanalytics#IotEventsDestinationConfiguration", "traits": { "smithy.api#documentation": "

Configuration information for delivery of data set contents to AWS IoT Events.

" } + }, + "s3DestinationConfiguration": { + "target": "com.amazonaws.iotanalytics#S3DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for delivery of data set contents to Amazon S3.

" + } } }, "traits": { @@ -1468,34 +1468,34 @@ "com.amazonaws.iotanalytics#DatasetContentSummary": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.iotanalytics#DatasetContentStatus", + "scheduleTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the data set contents.

" + "smithy.api#documentation": "

The time the creation of the data set contents was scheduled to start.

" } }, - "version": { - "target": "com.amazonaws.iotanalytics#DatasetContentVersion", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The version of the data set contents.

" + "smithy.api#documentation": "

The actual time the creation of the data set contents was started.

" } }, - "completionTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "version": { + "target": "com.amazonaws.iotanalytics#DatasetContentVersion", "traits": { - "smithy.api#documentation": "

The time the dataset content status was updated to SUCCEEDED or FAILED.

" + "smithy.api#documentation": "

The version of the data set contents.

" } }, - "scheduleTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "status": { + "target": "com.amazonaws.iotanalytics#DatasetContentStatus", "traits": { - "smithy.api#documentation": "

The time the creation of the data set contents was scheduled to start.

" + "smithy.api#documentation": "

The status of the data set contents.

" } }, - "creationTime": { + "completionTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The actual time the creation of the data set contents was started.

" + "smithy.api#documentation": "

The time the dataset content status was updated to SUCCEEDED or FAILED.

" } } }, @@ -1536,17 +1536,17 @@ "com.amazonaws.iotanalytics#DatasetEntry": { "type": "structure", "members": { - "entryName": { - "target": "com.amazonaws.iotanalytics#EntryName", - "traits": { - "smithy.api#documentation": "

The name of the data set item.

" - } - }, "dataURI": { "target": "com.amazonaws.iotanalytics#PresignedURI", "traits": { "smithy.api#documentation": "

The pre-signed URI of the data set item.

" } + }, + "entryName": { + "target": "com.amazonaws.iotanalytics#EntryName", + "traits": { + "smithy.api#documentation": "

The name of the data set item.

" + } } }, "traits": { @@ -1591,22 +1591,22 @@ "com.amazonaws.iotanalytics#DatasetSummary": { "type": "structure", "members": { - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the data set was created.

" - } - }, "status": { "target": "com.amazonaws.iotanalytics#DatasetStatus", "traits": { "smithy.api#documentation": "

The status of the data set.

" } }, - "triggers": { - "target": "com.amazonaws.iotanalytics#DatasetTriggers", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "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": "

The time the data set was created.

" + } + }, + "datasetName": { + "target": "com.amazonaws.iotanalytics#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the data set.

" } }, "lastUpdateTime": { @@ -1615,10 +1615,10 @@ "smithy.api#documentation": "

The last time the data set was updated.

" } }, - "datasetName": { - "target": "com.amazonaws.iotanalytics#DatasetName", + "triggers": { + "target": "com.amazonaws.iotanalytics#DatasetTriggers", "traits": { - "smithy.api#documentation": "

The name of the data set.

" + "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

" } }, "actions": { @@ -1635,17 +1635,17 @@ "com.amazonaws.iotanalytics#DatasetTrigger": { "type": "structure", "members": { - "schedule": { - "target": "com.amazonaws.iotanalytics#Schedule", - "traits": { - "smithy.api#documentation": "

The \"Schedule\" when the trigger is initiated.

" - } - }, "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.

" } + }, + "schedule": { + "target": "com.amazonaws.iotanalytics#Schedule", + "traits": { + "smithy.api#documentation": "

The \"Schedule\" when the trigger is initiated.

" + } } }, "traits": { @@ -1667,28 +1667,28 @@ "com.amazonaws.iotanalytics#Datastore": { "type": "structure", "members": { - "storage": { - "target": "com.amazonaws.iotanalytics#DatastoreStorage", + "arn": { + "target": "com.amazonaws.iotanalytics#DatastoreArn", "traits": { - "smithy.api#documentation": "

Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data\n store is created.

" + "smithy.api#documentation": "

The ARN of the data store.

" } }, - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "storage": { + "target": "com.amazonaws.iotanalytics#DatastoreStorage", "traits": { - "smithy.api#documentation": "

When the data store was created.

" + "smithy.api#documentation": "

Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data\n store is created.

" } }, - "name": { - "target": "com.amazonaws.iotanalytics#DatastoreName", + "status": { + "target": "com.amazonaws.iotanalytics#DatastoreStatus", "traits": { - "smithy.api#documentation": "

The name of the data store.

" + "smithy.api#documentation": "

The status of a data store:

\n
\n
CREATING
\n
\n

The data store is being created.

\n
\n
ACTIVE
\n
\n

The data store has been created and can be used.

\n
\n
DELETING
\n
\n

The data store is being deleted.

\n
\n
" } }, - "arn": { - "target": "com.amazonaws.iotanalytics#DatastoreArn", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the data store.

" + "smithy.api#documentation": "

When the data store was created.

" } }, "lastUpdateTime": { @@ -1697,16 +1697,16 @@ "smithy.api#documentation": "

The last time the data store was updated.

" } }, - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", + "name": { + "target": "com.amazonaws.iotanalytics#DatastoreName", "traits": { - "smithy.api#documentation": "

How long, in days, message data is kept for the data store. When \"customerManagedS3\" storage \n is selected, this parameter is ignored.

" + "smithy.api#documentation": "

The name of the data store.

" } }, - "status": { - "target": "com.amazonaws.iotanalytics#DatastoreStatus", + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "

The status of a data store:

\n
\n
CREATING
\n
\n

The data store is being created.

\n
\n
ACTIVE
\n
\n

The data store has been created and can be used.

\n
\n
DELETING
\n
\n

The data store is being deleted.

\n
\n
" + "smithy.api#documentation": "

How long, in days, message data is kept for the data store. When \"customerManagedS3\" storage \n is selected, this parameter is ignored.

" } } }, @@ -1717,17 +1717,17 @@ "com.amazonaws.iotanalytics#DatastoreActivity": { "type": "structure", "members": { - "datastoreName": { - "target": "com.amazonaws.iotanalytics#DatastoreName", + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "

The name of the data store where processed messages are stored.

", + "smithy.api#documentation": "

The name of the 'datastore' activity.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", + "datastoreName": { + "target": "com.amazonaws.iotanalytics#DatastoreName", "traits": { - "smithy.api#documentation": "

The name of the 'datastore' activity.

", + "smithy.api#documentation": "

The name of the data store where processed messages are stored.

", "smithy.api#required": {} } } @@ -1785,17 +1785,17 @@ "com.amazonaws.iotanalytics#DatastoreStorage": { "type": "structure", "members": { - "customerManagedS3": { - "target": "com.amazonaws.iotanalytics#CustomerManagedDatastoreS3Storage", - "traits": { - "smithy.api#documentation": "

Use this to store data store data in an S3 bucket that you manage. When customer managed storage is \n selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed \n S3 storage cannot be changed after creation of the data store.

" - } - }, "serviceManagedS3": { "target": "com.amazonaws.iotanalytics#ServiceManagedDatastoreS3Storage", "traits": { "smithy.api#documentation": "

Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service.\n The choice of service-managed or customer-managed S3 storage cannot be changed after creation\n of the data store.

" } + }, + "customerManagedS3": { + "target": "com.amazonaws.iotanalytics#CustomerManagedDatastoreS3Storage", + "traits": { + "smithy.api#documentation": "

Use this to store data store data in an S3 bucket that you manage. When customer managed storage is \n selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed \n S3 storage cannot be changed after creation of the data store.

" + } } }, "traits": { @@ -1805,17 +1805,17 @@ "com.amazonaws.iotanalytics#DatastoreStorageSummary": { "type": "structure", "members": { - "customerManagedS3": { - "target": "com.amazonaws.iotanalytics#CustomerManagedDatastoreS3StorageSummary", - "traits": { - "smithy.api#documentation": "

Used to store data store data in an S3 bucket that you manage.

" - } - }, "serviceManagedS3": { "target": "com.amazonaws.iotanalytics#ServiceManagedDatastoreS3StorageSummary", "traits": { "smithy.api#documentation": "

Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.

" } + }, + "customerManagedS3": { + "target": "com.amazonaws.iotanalytics#CustomerManagedDatastoreS3StorageSummary", + "traits": { + "smithy.api#documentation": "

Used to store data store data in an S3 bucket that you manage.

" + } } }, "traits": { @@ -1831,12 +1831,6 @@ "com.amazonaws.iotanalytics#DatastoreSummary": { "type": "structure", "members": { - "datastoreStorage": { - "target": "com.amazonaws.iotanalytics#DatastoreStorageSummary", - "traits": { - "smithy.api#documentation": "

Where data store data is stored.

" - } - }, "creationTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -1849,6 +1843,12 @@ "smithy.api#documentation": "

The status of the data store.

" } }, + "datastoreStorage": { + "target": "com.amazonaws.iotanalytics#DatastoreStorageSummary", + "traits": { + "smithy.api#documentation": "

Where data store data is stored.

" + } + }, "lastUpdateTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -2425,13 +2425,6 @@ "com.amazonaws.iotanalytics#DeviceRegistryEnrichActivity": { "type": "structure", "members": { - "attribute": { - "target": "com.amazonaws.iotanalytics#AttributeName", - "traits": { - "smithy.api#documentation": "

The name of the attribute that is added to the message.

", - "smithy.api#required": {} - } - }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { @@ -2439,10 +2432,10 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", + "attribute": { + "target": "com.amazonaws.iotanalytics#AttributeName", "traits": { - "smithy.api#documentation": "

The name of the 'deviceRegistryEnrich' activity.

", + "smithy.api#documentation": "

The name of the attribute that is added to the message.

", "smithy.api#required": {} } }, @@ -2453,6 +2446,13 @@ "smithy.api#required": {} } }, + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "

The name of the 'deviceRegistryEnrich' activity.

", + "smithy.api#required": {} + } + }, "next": { "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { @@ -2467,13 +2467,6 @@ "com.amazonaws.iotanalytics#DeviceShadowEnrichActivity": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "

The name of the 'deviceShadowEnrich' activity.

", - "smithy.api#required": {} - } - }, "thingName": { "target": "com.amazonaws.iotanalytics#AttributeName", "traits": { @@ -2500,6 +2493,13 @@ "traits": { "smithy.api#documentation": "

The next activity in the pipeline.

" } + }, + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "

The name of the 'deviceShadowEnrich' activity.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2738,17 +2738,17 @@ "com.amazonaws.iotanalytics#IotEventsDestinationConfiguration": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iotanalytics#RoleArn", + "inputName": { + "target": "com.amazonaws.iotanalytics#IotEventsInputName", "traits": { - "smithy.api#documentation": "

The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents\n to an AWS IoT Events input.

", + "smithy.api#documentation": "

The name of the AWS IoT Events input to which data set contents are delivered.

", "smithy.api#required": {} } }, - "inputName": { - "target": "com.amazonaws.iotanalytics#IotEventsInputName", + "roleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The name of the AWS IoT Events input to which data set contents are delivered.

", + "smithy.api#documentation": "

The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents\n to an AWS IoT Events input.

", "smithy.api#required": {} } } @@ -2770,12 +2770,6 @@ "com.amazonaws.iotanalytics#LambdaActivity": { "type": "structure", "members": { - "next": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "

The next activity in the pipeline.

" - } - }, "batchSize": { "target": "com.amazonaws.iotanalytics#ActivityBatchSize", "traits": { @@ -2783,11 +2777,10 @@ "smithy.api#required": {} } }, - "name": { + "next": { "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "

The name of the 'lambda' activity.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The next activity in the pipeline.

" } }, "lambdaName": { @@ -2796,6 +2789,13 @@ "smithy.api#documentation": "

The name of the Lambda function that is run on the message.

", "smithy.api#required": {} } + }, + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "

The name of the 'lambda' activity.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2864,19 +2864,19 @@ "com.amazonaws.iotanalytics#ListChannelsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.iotanalytics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

\n

The default value is 100.

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.iotanalytics#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

\n

The default value is 100.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -2939,13 +2939,6 @@ "com.amazonaws.iotanalytics#ListDatasetContentsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotanalytics#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "datasetName": { "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { @@ -2954,13 +2947,6 @@ "smithy.api#required": {} } }, - "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#httpQuery": "scheduledOnOrAfter" - } - }, "maxResults": { "target": "com.amazonaws.iotanalytics#MaxResults", "traits": { @@ -2968,6 +2954,20 @@ "smithy.api#httpQuery": "maxResults" } }, + "nextToken": { + "target": "com.amazonaws.iotanalytics#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "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#httpQuery": "scheduledOnOrAfter" + } + }, "scheduledBefore": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -3033,19 +3033,19 @@ "com.amazonaws.iotanalytics#ListDatasetsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotanalytics#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.iotanalytics#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in this request.

\n

The default value is 100.

", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.iotanalytics#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -3196,17 +3196,17 @@ "com.amazonaws.iotanalytics#ListPipelinesResponse": { "type": "structure", "members": { - "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.

" - } - }, "pipelineSummaries": { "target": "com.amazonaws.iotanalytics#PipelineSummaries", "traits": { "smithy.api#documentation": "

A list of \"PipelineSummary\" 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.

" + } } } }, @@ -3291,10 +3291,10 @@ "com.amazonaws.iotanalytics#LoggingOptions": { "type": "structure", "members": { - "level": { - "target": "com.amazonaws.iotanalytics#LoggingLevel", + "roleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The logging level. Currently, only \"ERROR\" is supported.

", + "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT Analytics to\n perform logging.

", "smithy.api#required": {} } }, @@ -3305,10 +3305,10 @@ "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.iotanalytics#RoleArn", + "level": { + "target": "com.amazonaws.iotanalytics#LoggingLevel", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT Analytics to\n perform logging.

", + "smithy.api#documentation": "

The logging level. Currently, only \"ERROR\" is supported.

", "smithy.api#required": {} } } @@ -3320,17 +3320,17 @@ "com.amazonaws.iotanalytics#MathActivity": { "type": "structure", "members": { - "attribute": { - "target": "com.amazonaws.iotanalytics#AttributeName", + "math": { + "target": "com.amazonaws.iotanalytics#MathExpression", "traits": { - "smithy.api#documentation": "

The name of the attribute that contains the result of the math operation.

", + "smithy.api#documentation": "

An expression that uses one or more existing attributes and must return an integer value.

", "smithy.api#required": {} } }, - "math": { - "target": "com.amazonaws.iotanalytics#MathExpression", + "attribute": { + "target": "com.amazonaws.iotanalytics#AttributeName", "traits": { - "smithy.api#documentation": "

An expression that uses one or more existing attributes and must return an integer value.

", + "smithy.api#documentation": "

The name of the attribute that contains the result of the math operation.

", "smithy.api#required": {} } }, @@ -3394,17 +3394,17 @@ "com.amazonaws.iotanalytics#Message": { "type": "structure", "members": { - "messageId": { - "target": "com.amazonaws.iotanalytics#MessageId", + "payload": { + "target": "com.amazonaws.iotanalytics#MessagePayload", "traits": { - "smithy.api#documentation": "

The ID you wish to assign to the message. Each \"messageId\" must be unique \n within each batch sent.

", + "smithy.api#documentation": "

The payload of the message. This may be a JSON string or a Base64-encoded string \n representing binary data (in which case you must decode it by means of a pipeline activity).

", "smithy.api#required": {} } }, - "payload": { - "target": "com.amazonaws.iotanalytics#MessagePayload", + "messageId": { + "target": "com.amazonaws.iotanalytics#MessageId", "traits": { - "smithy.api#documentation": "

The payload of the message. This may be a JSON string or a Base64-encoded string \n representing binary data (in which case you must decode it by means of a pipeline activity).

", + "smithy.api#documentation": "

The ID you wish to assign to the message. Each \"messageId\" must be unique \n within each batch sent.

", "smithy.api#required": {} } } @@ -3476,6 +3476,12 @@ "com.amazonaws.iotanalytics#Pipeline": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.iotanalytics#PipelineName", + "traits": { + "smithy.api#documentation": "

The name of the pipeline.

" + } + }, "creationTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -3494,12 +3500,6 @@ "smithy.api#documentation": "

The ARN of the pipeline.

" } }, - "name": { - "target": "com.amazonaws.iotanalytics#PipelineName", - "traits": { - "smithy.api#documentation": "

The name of the pipeline.

" - } - }, "lastUpdateTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -3526,22 +3526,16 @@ "smithy.api#length": { "min": 1, "max": 25 - } - } - }, - "com.amazonaws.iotanalytics#PipelineActivity": { - "type": "structure", - "members": { - "deviceShadowEnrich": { - "target": "com.amazonaws.iotanalytics#DeviceShadowEnrichActivity", - "traits": { - "smithy.api#documentation": "

Adds information from the AWS IoT Device Shadows service to a message.

" - } - }, - "filter": { - "target": "com.amazonaws.iotanalytics#FilterActivity", + } + } + }, + "com.amazonaws.iotanalytics#PipelineActivity": { + "type": "structure", + "members": { + "lambda": { + "target": "com.amazonaws.iotanalytics#LambdaActivity", "traits": { - "smithy.api#documentation": "

Filters a message based on its attributes.

" + "smithy.api#documentation": "

Runs a Lambda function to modify the message.

" } }, "math": { @@ -3550,16 +3544,16 @@ "smithy.api#documentation": "

Computes an arithmetic expression using the message's attributes and adds\n it to the message.

" } }, - "removeAttributes": { - "target": "com.amazonaws.iotanalytics#RemoveAttributesActivity", + "filter": { + "target": "com.amazonaws.iotanalytics#FilterActivity", "traits": { - "smithy.api#documentation": "

Removes attributes from a message.

" + "smithy.api#documentation": "

Filters a message based on its attributes.

" } }, - "lambda": { - "target": "com.amazonaws.iotanalytics#LambdaActivity", + "selectAttributes": { + "target": "com.amazonaws.iotanalytics#SelectAttributesActivity", "traits": { - "smithy.api#documentation": "

Runs a Lambda function to modify the message.

" + "smithy.api#documentation": "

Creates a new message using only the specified attributes from the original message.\n

" } }, "channel": { @@ -3568,22 +3562,16 @@ "smithy.api#documentation": "

Determines the source of the messages to be processed.

" } }, - "addAttributes": { - "target": "com.amazonaws.iotanalytics#AddAttributesActivity", - "traits": { - "smithy.api#documentation": "

Adds other attributes based on existing attributes in the message.

" - } - }, - "datastore": { - "target": "com.amazonaws.iotanalytics#DatastoreActivity", + "removeAttributes": { + "target": "com.amazonaws.iotanalytics#RemoveAttributesActivity", "traits": { - "smithy.api#documentation": "

Specifies where to store the processed message data.

" + "smithy.api#documentation": "

Removes attributes from a message.

" } }, - "selectAttributes": { - "target": "com.amazonaws.iotanalytics#SelectAttributesActivity", + "deviceShadowEnrich": { + "target": "com.amazonaws.iotanalytics#DeviceShadowEnrichActivity", "traits": { - "smithy.api#documentation": "

Creates a new message using only the specified attributes from the original message.\n

" + "smithy.api#documentation": "

Adds information from the AWS IoT Device Shadows service to a message.

" } }, "deviceRegistryEnrich": { @@ -3591,6 +3579,18 @@ "traits": { "smithy.api#documentation": "

Adds data from the AWS IoT device registry to your message.

" } + }, + "datastore": { + "target": "com.amazonaws.iotanalytics#DatastoreActivity", + "traits": { + "smithy.api#documentation": "

Specifies where to store the processed message data.

" + } + }, + "addAttributes": { + "target": "com.amazonaws.iotanalytics#AddAttributesActivity", + "traits": { + "smithy.api#documentation": "

Adds other attributes based on existing attributes in the message.

" + } } }, "traits": { @@ -3619,16 +3619,16 @@ "com.amazonaws.iotanalytics#PipelineSummary": { "type": "structure", "members": { - "creationTime": { + "lastUpdateTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

When the pipeline was created.

" + "smithy.api#documentation": "

When the pipeline was last updated.

" } }, - "lastUpdateTime": { + "creationTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

When the pipeline was last updated.

" + "smithy.api#documentation": "

When the pipeline was created.

" } }, "reprocessingSummaries": { @@ -3723,6 +3723,13 @@ "com.amazonaws.iotanalytics#RemoveAttributesActivity": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "

The name of the 'removeAttributes' activity.

", + "smithy.api#required": {} + } + }, "next": { "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { @@ -3735,13 +3742,6 @@ "smithy.api#documentation": "

A list of 1-50 attributes to remove from the message.

", "smithy.api#required": {} } - }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "

The name of the 'removeAttributes' activity.

", - "smithy.api#required": {} - } } }, "traits": { @@ -3783,6 +3783,12 @@ "com.amazonaws.iotanalytics#ReprocessingSummary": { "type": "structure", "members": { + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the pipeline reprocessing was created.

" + } + }, "status": { "target": "com.amazonaws.iotanalytics#ReprocessingStatus", "traits": { @@ -3794,12 +3800,6 @@ "traits": { "smithy.api#documentation": "

The 'reprocessingId' returned by \"StartPipelineReprocessing\".

" } - }, - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the pipeline reprocessing was created.

" - } } }, "traits": { @@ -3809,15 +3809,15 @@ "com.amazonaws.iotanalytics#ResourceAlreadyExistsException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.iotanalytics#ErrorMessage" - }, "resourceId": { "target": "com.amazonaws.iotanalytics#resourceId", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } }, + "message": { + "target": "com.amazonaws.iotanalytics#ErrorMessage" + }, "resourceArn": { "target": "com.amazonaws.iotanalytics#ResourceArn2", "traits": { @@ -3846,17 +3846,17 @@ "com.amazonaws.iotanalytics#ResourceConfiguration": { "type": "structure", "members": { - "volumeSizeInGB": { - "target": "com.amazonaws.iotanalytics#VolumeSizeInGB", + "computeType": { + "target": "com.amazonaws.iotanalytics#ComputeType", "traits": { - "smithy.api#documentation": "

The size (in GB) of the persistent storage available to the resource instance used to\n execute the \"containerAction\" (min: 1, max: 50).

", + "smithy.api#documentation": "

The type of the compute resource used to execute the \"containerAction\". Possible values \n are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).

", "smithy.api#required": {} } }, - "computeType": { - "target": "com.amazonaws.iotanalytics#ComputeType", + "volumeSizeInGB": { + "target": "com.amazonaws.iotanalytics#VolumeSizeInGB", "traits": { - "smithy.api#documentation": "

The type of the compute resource used to execute the \"containerAction\". Possible values \n are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).

", + "smithy.api#documentation": "

The size (in GB) of the persistent storage available to the resource instance used to\n execute the \"containerAction\" (min: 1, max: 50).

", "smithy.api#required": {} } } @@ -3986,12 +3986,6 @@ "com.amazonaws.iotanalytics#S3DestinationConfiguration": { "type": "structure", "members": { - "glueConfiguration": { - "target": "com.amazonaws.iotanalytics#GlueConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration information for coordination with the AWS Glue ETL (extract, transform and \n load) service.

" - } - }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { @@ -3999,6 +3993,12 @@ "smithy.api#required": {} } }, + "glueConfiguration": { + "target": "com.amazonaws.iotanalytics#GlueConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for coordination with the AWS Glue ETL (extract, transform and \n load) service.

" + } + }, "key": { "target": "com.amazonaws.iotanalytics#BucketKeyExpression", "traits": { @@ -4065,11 +4065,12 @@ "com.amazonaws.iotanalytics#SampleChannelDataRequest": { "type": "structure", "members": { - "endTime": { - "target": "com.amazonaws.iotanalytics#EndTime", + "channelName": { + "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { - "smithy.api#documentation": "

The end of the time window from which sample messages are retrieved.

", - "smithy.api#httpQuery": "endTime" + "smithy.api#documentation": "

The name of the channel whose message samples are retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "startTime": { @@ -4079,20 +4080,19 @@ "smithy.api#httpQuery": "startTime" } }, - "channelName": { - "target": "com.amazonaws.iotanalytics#ChannelName", - "traits": { - "smithy.api#documentation": "

The name of the channel whose message samples are retrieved.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "maxMessages": { "target": "com.amazonaws.iotanalytics#MaxMessages", "traits": { "smithy.api#documentation": "

The number of sample messages to be retrieved. The limit is 10, the default\n is also 10.

", "smithy.api#httpQuery": "maxMessages" } + }, + "endTime": { + "target": "com.amazonaws.iotanalytics#EndTime", + "traits": { + "smithy.api#documentation": "

The end of the time window from which sample messages are retrieved.

", + "smithy.api#httpQuery": "endTime" + } } } }, @@ -4127,13 +4127,6 @@ "com.amazonaws.iotanalytics#SelectAttributesActivity": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "

The name of the 'selectAttributes' activity.

", - "smithy.api#required": {} - } - }, "attributes": { "target": "com.amazonaws.iotanalytics#AttributeNames", "traits": { @@ -4146,6 +4139,13 @@ "traits": { "smithy.api#documentation": "

The next activity in the pipeline.

" } + }, + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "

The name of the 'selectAttributes' activity.

", + "smithy.api#required": {} + } } }, "traits": { @@ -4263,10 +4263,10 @@ "com.amazonaws.iotanalytics#StartPipelineReprocessingRequest": { "type": "structure", "members": { - "endTime": { - "target": "com.amazonaws.iotanalytics#EndTime", + "startTime": { + "target": "com.amazonaws.iotanalytics#StartTime", "traits": { - "smithy.api#documentation": "

The end time (exclusive) of raw message data that is reprocessed.

" + "smithy.api#documentation": "

The start time (inclusive) of raw message data that is reprocessed.

" } }, "pipelineName": { @@ -4277,10 +4277,10 @@ "smithy.api#required": {} } }, - "startTime": { - "target": "com.amazonaws.iotanalytics#StartTime", + "endTime": { + "target": "com.amazonaws.iotanalytics#EndTime", "traits": { - "smithy.api#documentation": "

The start time (inclusive) of raw message data that is reprocessed.

" + "smithy.api#documentation": "

The end time (exclusive) of raw message data that is reprocessed.

" } } } @@ -4403,13 +4403,6 @@ "com.amazonaws.iotanalytics#TagResourceRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iotanalytics#TagList", - "traits": { - "smithy.api#documentation": "

The new or modified tags for the resource.

", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.iotanalytics#ResourceArn", "traits": { @@ -4417,6 +4410,13 @@ "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.iotanalytics#TagList", + "traits": { + "smithy.api#documentation": "

The new or modified tags for the resource.

", + "smithy.api#required": {} + } } } }, @@ -4569,12 +4569,10 @@ "com.amazonaws.iotanalytics#UpdateChannelRequest": { "type": "structure", "members": { - "channelName": { - "target": "com.amazonaws.iotanalytics#ChannelName", + "channelStorage": { + "target": "com.amazonaws.iotanalytics#ChannelStorage", "traits": { - "smithy.api#documentation": "

The name of the channel to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.

" } }, "retentionPeriod": { @@ -4583,10 +4581,12 @@ "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.

" } }, - "channelStorage": { - "target": "com.amazonaws.iotanalytics#ChannelStorage", + "channelName": { + "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { - "smithy.api#documentation": "

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.

" + "smithy.api#documentation": "

The name of the channel to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -4633,6 +4633,13 @@ "smithy.api#required": {} } }, + "actions": { + "target": "com.amazonaws.iotanalytics#DatasetActions", + "traits": { + "smithy.api#documentation": "

A list of \"DatasetAction\" objects.

", + "smithy.api#required": {} + } + }, "versioningConfiguration": { "target": "com.amazonaws.iotanalytics#VersioningConfiguration", "traits": { @@ -4645,13 +4652,6 @@ "smithy.api#documentation": "

When data set contents are created they are delivered to destinations specified here.

" } }, - "actions": { - "target": "com.amazonaws.iotanalytics#DatasetActions", - "traits": { - "smithy.api#documentation": "

A list of \"DatasetAction\" objects.

", - "smithy.api#required": {} - } - }, "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { @@ -4759,18 +4759,18 @@ "com.amazonaws.iotanalytics#UpdatePipelineRequest": { "type": "structure", "members": { - "pipelineName": { - "target": "com.amazonaws.iotanalytics#PipelineName", + "pipelineActivities": { + "target": "com.amazonaws.iotanalytics#PipelineActivities", "traits": { - "smithy.api#documentation": "

The name of the pipeline to update.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A list of \"PipelineActivity\" objects. Activities perform transformations on your messages, \n such as removing, renaming or adding message attributes; filtering messages based on attribute \n values; invoking your Lambda functions on messages for advanced processing; or performing \n mathematical transformations to normalize device data.

\n

The list can be 2-25 PipelineActivity objects and must \n contain both a channel and a datastore activity. Each entry in the \n list must contain only one activity, for example:

\n

\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]\n

", "smithy.api#required": {} } }, - "pipelineActivities": { - "target": "com.amazonaws.iotanalytics#PipelineActivities", + "pipelineName": { + "target": "com.amazonaws.iotanalytics#PipelineName", "traits": { - "smithy.api#documentation": "

A list of \"PipelineActivity\" objects. Activities perform transformations on your messages, \n such as removing, renaming or adding message attributes; filtering messages based on attribute \n values; invoking your Lambda functions on messages for advanced processing; or performing \n mathematical transformations to normalize device data.

\n

The list can be 2-25 PipelineActivity objects and must \n contain both a channel and a datastore activity. Each entry in the \n list must contain only one activity, for example:

\n

\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]\n

", + "smithy.api#documentation": "

The name of the pipeline to update.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -4779,12 +4779,6 @@ "com.amazonaws.iotanalytics#Variable": { "type": "structure", "members": { - "stringValue": { - "target": "com.amazonaws.iotanalytics#StringValue", - "traits": { - "smithy.api#documentation": "

The value of the variable as a string.

" - } - }, "outputFileUriValue": { "target": "com.amazonaws.iotanalytics#OutputFileUriValue", "traits": { @@ -4798,17 +4792,23 @@ "smithy.api#documentation": "

The value of the variable as a double (numeric).

" } }, + "name": { + "target": "com.amazonaws.iotanalytics#VariableName", + "traits": { + "smithy.api#documentation": "

The name of the variable.

", + "smithy.api#required": {} + } + }, "datasetContentVersionValue": { "target": "com.amazonaws.iotanalytics#DatasetContentVersionValue", "traits": { "smithy.api#documentation": "

The value of the variable as a structure that specifies a data set content version.

" } }, - "name": { - "target": "com.amazonaws.iotanalytics#VariableName", + "stringValue": { + "target": "com.amazonaws.iotanalytics#StringValue", "traits": { - "smithy.api#documentation": "

The name of the variable.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The value of the variable as a string.

" } } }, @@ -4840,17 +4840,17 @@ "com.amazonaws.iotanalytics#VersioningConfiguration": { "type": "structure", "members": { - "maxVersions": { - "target": "com.amazonaws.iotanalytics#MaxVersions", - "traits": { - "smithy.api#documentation": "

How many versions of data set contents will be kept. The \"unlimited\" parameter must be false.

" - } - }, "unlimited": { "target": "com.amazonaws.iotanalytics#UnlimitedVersioning", "traits": { "smithy.api#documentation": "

If true, unlimited versions of data set contents will be kept.

" } + }, + "maxVersions": { + "target": "com.amazonaws.iotanalytics#MaxVersions", + "traits": { + "smithy.api#documentation": "

How many versions of data set contents will be kept. The \"unlimited\" parameter must be false.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/iotsecuretunneling.2018-10-05.json b/codegen/sdk-codegen/aws-models/iotsecuretunneling.2018-10-05.json index 517e4cf834dc..50f8973b4603 100644 --- a/codegen/sdk-codegen/aws-models/iotsecuretunneling.2018-10-05.json +++ b/codegen/sdk-codegen/aws-models/iotsecuretunneling.2018-10-05.json @@ -69,14 +69,6 @@ "com.amazonaws.iotsecuretunneling#CloseTunnelRequest": { "type": "structure", "members": { - "tunnelId": { - "target": "com.amazonaws.iotsecuretunneling#TunnelId", - "traits": { - "smithy.api#documentation": "

The ID of the tunnel to close.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "delete": { "target": "com.amazonaws.iotsecuretunneling#DeleteFlag", "traits": { @@ -84,6 +76,14 @@ "smithy.api#documentation": "

When set to true, AWS IoT Secure Tunneling deletes the tunnel data\n\t\t\timmediately.

", "smithy.api#httpQuery": "delete" } + }, + "tunnelId": { + "target": "com.amazonaws.iotsecuretunneling#TunnelId", + "traits": { + "smithy.api#documentation": "

The ID of the tunnel to close.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -94,17 +94,17 @@ "com.amazonaws.iotsecuretunneling#ConnectionState": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.iotsecuretunneling#ConnectionStatus", - "traits": { - "smithy.api#documentation": "

The connection status of the tunnel. Valid values are CONNECTED and\n\t\t\t\tDISCONNECTED.

" - } - }, "lastUpdatedAt": { "target": "com.amazonaws.iotsecuretunneling#DateType", "traits": { "smithy.api#documentation": "

The last time the connection status was updated.

" } + }, + "status": { + "target": "com.amazonaws.iotsecuretunneling#ConnectionStatus", + "traits": { + "smithy.api#documentation": "

The connection status of the tunnel. Valid values are CONNECTED and\n\t\t\t\tDISCONNECTED.

" + } } }, "traits": { @@ -240,7 +240,7 @@ "sdkId": "IoTSecureTunneling", "arnNamespace": "iotsecuredtunneling", "cloudFormationName": "IoTSecureTunneling", - "cloudTrailEventSource": "frontend.envoy.amazonaws.com" + "cloudTrailEventSource": "iotsecuretunneling.amazonaws.com" }, "aws.auth#sigv4": { "name": "iotsecuredtunneling" @@ -334,11 +334,11 @@ "com.amazonaws.iotsecuretunneling#ListTunnelsRequest": { "type": "structure", "members": { - "thingName": { - "target": "com.amazonaws.iotsecuretunneling#ThingName", + "nextToken": { + "target": "com.amazonaws.iotsecuretunneling#NextToken", "traits": { - "smithy.api#documentation": "

The name of the IoT thing associated with the destination device.

", - "smithy.api#httpQuery": "thingName" + "smithy.api#documentation": "

A token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" } }, "maxResults": { @@ -349,11 +349,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "nextToken": { - "target": "com.amazonaws.iotsecuretunneling#NextToken", + "thingName": { + "target": "com.amazonaws.iotsecuretunneling#ThingName", "traits": { - "smithy.api#documentation": "

A token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The name of the IoT thing associated with the destination device.

", + "smithy.api#httpQuery": "thingName" } } } @@ -415,10 +415,10 @@ "com.amazonaws.iotsecuretunneling#OpenTunnelRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iotsecuretunneling#TagList", + "description": { + "target": "com.amazonaws.iotsecuretunneling#Description", "traits": { - "smithy.api#documentation": "

A collection of tag metadata.

" + "smithy.api#documentation": "

A short text description of the tunnel.

" } }, "timeoutConfig": { @@ -433,10 +433,10 @@ "smithy.api#documentation": "

The destination configuration for the OpenTunnel request.

" } }, - "description": { - "target": "com.amazonaws.iotsecuretunneling#Description", + "tags": { + "target": "com.amazonaws.iotsecuretunneling#TagList", "traits": { - "smithy.api#documentation": "

A short text description of the tunnel.

" + "smithy.api#documentation": "

A collection of tag metadata.

" } } } @@ -444,28 +444,28 @@ "com.amazonaws.iotsecuretunneling#OpenTunnelResponse": { "type": "structure", "members": { - "tunnelArn": { - "target": "com.amazonaws.iotsecuretunneling#TunnelArn", + "tunnelId": { + "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name for the tunnel. The tunnel ARN format is\n\t\t\t\tarn:aws:tunnel:::tunnel/\n

" + "smithy.api#documentation": "

A unique alpha-numeric tunnel ID.

" } }, - "destinationAccessToken": { + "sourceAccessToken": { "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { - "smithy.api#documentation": "

The access token the destination local proxy uses to connect to AWS IoT Secure\n\t\t\tTunneling.

" + "smithy.api#documentation": "

The access token the source local proxy uses to connect to AWS IoT Secure\n\t\t\tTunneling.

" } }, - "sourceAccessToken": { - "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", + "tunnelArn": { + "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { - "smithy.api#documentation": "

The access token the source local proxy uses to connect to AWS IoT Secure\n\t\t\tTunneling.

" + "smithy.api#documentation": "

The Amazon Resource Name for the tunnel. The tunnel ARN format is\n\t\t\t\tarn:aws:tunnel:::tunnel/\n

" } }, - "tunnelId": { - "target": "com.amazonaws.iotsecuretunneling#TunnelId", + "destinationAccessToken": { + "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { - "smithy.api#documentation": "

A unique alpha-numeric tunnel ID.

" + "smithy.api#documentation": "

The access token the destination local proxy uses to connect to AWS IoT Secure\n\t\t\tTunneling.

" } } } @@ -508,17 +508,17 @@ "com.amazonaws.iotsecuretunneling#Tag": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.iotsecuretunneling#TagKey", + "value": { + "target": "com.amazonaws.iotsecuretunneling#TagValue", "traits": { - "smithy.api#documentation": "

The key of the tag.

", + "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } }, - "value": { - "target": "com.amazonaws.iotsecuretunneling#TagValue", + "key": { + "target": "com.amazonaws.iotsecuretunneling#TagKey", "traits": { - "smithy.api#documentation": "

The value of the tag.

", + "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } } @@ -586,17 +586,17 @@ "com.amazonaws.iotsecuretunneling#TagResourceRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iotsecuretunneling#TagList", + "resourceArn": { + "target": "com.amazonaws.iotsecuretunneling#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The tags for the resource.

", + "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.iotsecuretunneling#AmazonResourceName", + "tags": { + "target": "com.amazonaws.iotsecuretunneling#TagList", "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#documentation": "

The tags for the resource.

", "smithy.api#required": {} } } @@ -653,16 +653,10 @@ "com.amazonaws.iotsecuretunneling#Tunnel": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.iotsecuretunneling#DateType", - "traits": { - "smithy.api#documentation": "

The time when the tunnel was created.

" - } - }, - "timeoutConfig": { - "target": "com.amazonaws.iotsecuretunneling#TimeoutConfig", + "description": { + "target": "com.amazonaws.iotsecuretunneling#Description", "traits": { - "smithy.api#documentation": "

Timeout configuration for the tunnel.

" + "smithy.api#documentation": "

A description of the tunnel.

" } }, "tunnelArn": { @@ -677,16 +671,22 @@ "smithy.api#documentation": "

The last time the tunnel was updated.

" } }, + "tags": { + "target": "com.amazonaws.iotsecuretunneling#TagList", + "traits": { + "smithy.api#documentation": "

A list of tag metadata associated with the secure tunnel.

" + } + }, "sourceConnectionState": { "target": "com.amazonaws.iotsecuretunneling#ConnectionState", "traits": { "smithy.api#documentation": "

The connection state of the source application.

" } }, - "tunnelId": { - "target": "com.amazonaws.iotsecuretunneling#TunnelId", + "status": { + "target": "com.amazonaws.iotsecuretunneling#TunnelStatus", "traits": { - "smithy.api#documentation": "

A unique alpha-numeric ID that identifies a tunnel.

" + "smithy.api#documentation": "

The status of a tunnel. Valid values are: Open and Closed.

" } }, "destinationConnectionState": { @@ -695,16 +695,16 @@ "smithy.api#documentation": "

The connection state of the destination application.

" } }, - "description": { - "target": "com.amazonaws.iotsecuretunneling#Description", + "tunnelId": { + "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { - "smithy.api#documentation": "

A description of the tunnel.

" + "smithy.api#documentation": "

A unique alpha-numeric ID that identifies a tunnel.

" } }, - "status": { - "target": "com.amazonaws.iotsecuretunneling#TunnelStatus", + "timeoutConfig": { + "target": "com.amazonaws.iotsecuretunneling#TimeoutConfig", "traits": { - "smithy.api#documentation": "

The status of a tunnel. Valid values are: Open and Closed.

" + "smithy.api#documentation": "

Timeout configuration for the tunnel.

" } }, "destinationConfig": { @@ -713,10 +713,10 @@ "smithy.api#documentation": "

The destination configuration that specifies the thing name of the destination\n\t\t\tdevice and a service name that the local proxy uses to connect to the destination\n\t\t\tapplication.

" } }, - "tags": { - "target": "com.amazonaws.iotsecuretunneling#TagList", + "createdAt": { + "target": "com.amazonaws.iotsecuretunneling#DateType", "traits": { - "smithy.api#documentation": "

A list of tag metadata associated with the secure tunnel.

" + "smithy.api#documentation": "

The time when the tunnel was created.

" } } }, @@ -757,10 +757,10 @@ "com.amazonaws.iotsecuretunneling#TunnelSummary": { "type": "structure", "members": { - "lastUpdatedAt": { - "target": "com.amazonaws.iotsecuretunneling#DateType", + "tunnelId": { + "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { - "smithy.api#documentation": "

The time the tunnel was last updated.

" + "smithy.api#documentation": "

The unique alpha-numeric identifier for the tunnel.

" } }, "status": { @@ -769,16 +769,22 @@ "smithy.api#documentation": "

The status of a tunnel. Valid values are: Open and Closed.

" } }, + "description": { + "target": "com.amazonaws.iotsecuretunneling#Description", + "traits": { + "smithy.api#documentation": "

A description of the tunnel.

" + } + }, "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name of the tunnel. The tunnel ARN format is\n\t\t\t\tarn:aws:tunnel:::tunnel/\n

" } }, - "description": { - "target": "com.amazonaws.iotsecuretunneling#Description", + "lastUpdatedAt": { + "target": "com.amazonaws.iotsecuretunneling#DateType", "traits": { - "smithy.api#documentation": "

A description of the tunnel.

" + "smithy.api#documentation": "

The time the tunnel was last updated.

" } }, "createdAt": { @@ -786,12 +792,6 @@ "traits": { "smithy.api#documentation": "

The time the tunnel was created.

" } - }, - "tunnelId": { - "target": "com.amazonaws.iotsecuretunneling#TunnelId", - "traits": { - "smithy.api#documentation": "

The unique alpha-numeric identifier for the tunnel.

" - } } }, "traits": { @@ -829,17 +829,17 @@ "com.amazonaws.iotsecuretunneling#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.iotsecuretunneling#TagKeyList", + "resourceArn": { + "target": "com.amazonaws.iotsecuretunneling#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The keys of the tags to remove.

", + "smithy.api#documentation": "

The resource ARN.

", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.iotsecuretunneling#AmazonResourceName", + "tagKeys": { + "target": "com.amazonaws.iotsecuretunneling#TagKeyList", "traits": { - "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#documentation": "

The keys of the tags to remove.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/iotsitewise.2019-12-02.json b/codegen/sdk-codegen/aws-models/iotsitewise.2019-12-02.json index dd7eb60d028b..4bc0010fc4f7 100644 --- a/codegen/sdk-codegen/aws-models/iotsitewise.2019-12-02.json +++ b/codegen/sdk-codegen/aws-models/iotsitewise.2019-12-02.json @@ -73,6 +73,9 @@ { "target": "com.amazonaws.iotsitewise#CreatePortal" }, + { + "target": "com.amazonaws.iotsitewise#CreatePresignedPortalUrl" + }, { "target": "com.amazonaws.iotsitewise#CreateProject" }, @@ -243,13 +246,6 @@ "smithy.api#documentation": "

The date the access policy was last updated, in Unix epoch time.

" } }, - "identity": { - "target": "com.amazonaws.iotsitewise#Identity", - "traits": { - "smithy.api#documentation": "

The AWS SSO identity (a user or group).

", - "smithy.api#required": {} - } - }, "permission": { "target": "com.amazonaws.iotsitewise#Permission", "traits": { @@ -257,10 +253,10 @@ "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.iotsitewise#ID", + "identity": { + "target": "com.amazonaws.iotsitewise#Identity", "traits": { - "smithy.api#documentation": "

The ID of the access policy.

", + "smithy.api#documentation": "

The identity (an AWS SSO user, an AWS SSO group, or an IAM user).

", "smithy.api#required": {} } }, @@ -269,10 +265,17 @@ "traits": { "smithy.api#documentation": "

The date the access policy was created, in Unix epoch time.

" } + }, + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the access policy.

", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "

Contains an access policy that defines an AWS SSO identity's access to an AWS IoT SiteWise Monitor\n resource.

" + "smithy.api#documentation": "

Contains an access policy that defines an identity's access to an AWS IoT SiteWise Monitor\n resource.

" } }, "com.amazonaws.iotsitewise#AggregateType": { @@ -326,13 +329,6 @@ "com.amazonaws.iotsitewise#AggregatedValue": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotsitewise#Aggregates", - "traits": { - "smithy.api#documentation": "

The value of the aggregates.

", - "smithy.api#required": {} - } - }, "timestamp": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { @@ -345,6 +341,13 @@ "traits": { "smithy.api#documentation": "

The quality of the aggregated data.

" } + }, + "value": { + "target": "com.amazonaws.iotsitewise#Aggregates", + "traits": { + "smithy.api#documentation": "

The value of the aggregates.

", + "smithy.api#required": {} + } } }, "traits": { @@ -360,12 +363,6 @@ "com.amazonaws.iotsitewise#Aggregates": { "type": "structure", "members": { - "sum": { - "target": "com.amazonaws.iotsitewise#AggregatedDoubleValue", - "traits": { - "smithy.api#documentation": "

The sum of the time series over a time interval window.

" - } - }, "average": { "target": "com.amazonaws.iotsitewise#AggregatedDoubleValue", "traits": { @@ -378,10 +375,10 @@ "smithy.api#documentation": "

The maximum value of the time series over a time interval window.

" } }, - "count": { + "sum": { "target": "com.amazonaws.iotsitewise#AggregatedDoubleValue", "traits": { - "smithy.api#documentation": "

The count of data points in the time series over a time interval window.

" + "smithy.api#documentation": "

The sum of the time series over a time interval window.

" } }, "standardDeviation": { @@ -395,6 +392,12 @@ "traits": { "smithy.api#documentation": "

The minimum value of the time series over a time interval window.

" } + }, + "count": { + "target": "com.amazonaws.iotsitewise#AggregatedDoubleValue", + "traits": { + "smithy.api#documentation": "

The count of data points in the time series over a time interval window.

" + } } }, "traits": { @@ -424,17 +427,17 @@ "com.amazonaws.iotsitewise#AssetErrorDetails": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.iotsitewise#AssetErrorCode", + "message": { + "target": "com.amazonaws.iotsitewise#AssetErrorMessage", "traits": { - "smithy.api#documentation": "

The error code.

", + "smithy.api#documentation": "

The error message.

", "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.iotsitewise#AssetErrorMessage", + "code": { + "target": "com.amazonaws.iotsitewise#AssetErrorCode", "traits": { - "smithy.api#documentation": "

The error message.

", + "smithy.api#documentation": "

The error code.

", "smithy.api#required": {} } }, @@ -462,18 +465,18 @@ "com.amazonaws.iotsitewise#AssetHierarchy": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.iotsitewise#Name", - "traits": { - "smithy.api#documentation": "

The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API.

", - "smithy.api#required": {} - } - }, "id": { "target": "com.amazonaws.iotsitewise#ID", "traits": { "smithy.api#documentation": "

The ID of the hierarchy. This ID is a hierarchyId.

" } + }, + "name": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

The hierarchy name provided in the CreateAssetModel or UpdateAssetModel\n API operation.

", + "smithy.api#required": {} + } } }, "traits": { @@ -495,23 +498,23 @@ "com.amazonaws.iotsitewise#AssetModelHierarchy": { "type": "structure", "members": { - "childAssetModelId": { + "id": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the asset model. All assets in this hierarchy must be instances of the\n childAssetModelId asset model.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the asset model hierarchy. This ID is a hierarchyId.

" } }, - "id": { + "childAssetModelId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the asset model hierarchy. This ID is a hierarchyId.

" + "smithy.api#documentation": "

The ID of the asset model. All assets in this hierarchy must be instances of the\n childAssetModelId asset model.

", + "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API.

", + "smithy.api#documentation": "

The name of the asset model hierarchy that you specify by using the CreateAssetModel or\n UpdateAssetModel API operation.

", "smithy.api#required": {} } } @@ -523,17 +526,17 @@ "com.amazonaws.iotsitewise#AssetModelHierarchyDefinition": { "type": "structure", "members": { - "childAssetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "name": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The ID of an asset model for this hierarchy.

", + "smithy.api#documentation": "

The name of the asset model hierarchy definition (as specified in the CreateAssetModel or\n UpdateAssetModel API operation).

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "childAssetModelId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The name of the asset model hierarchy definition (as specified in CreateAssetModel or UpdateAssetModel).

", + "smithy.api#documentation": "

The ID of an asset model for this hierarchy.

", "smithy.api#required": {} } } @@ -557,16 +560,18 @@ "com.amazonaws.iotsitewise#AssetModelProperty": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.iotsitewise#ID", + "dataType": { + "target": "com.amazonaws.iotsitewise#PropertyDataType", "traits": { - "smithy.api#documentation": "

The ID of the asset model property.

" + "smithy.api#documentation": "

The data type of the asset model property.

", + "smithy.api#required": {} } }, - "unit": { - "target": "com.amazonaws.iotsitewise#PropertyUnit", + "type": { + "target": "com.amazonaws.iotsitewise#PropertyType", "traits": { - "smithy.api#documentation": "

The unit of the asset model property, such as Newtons or\n RPM.

" + "smithy.api#documentation": "

The property type (see PropertyType).

", + "smithy.api#required": {} } }, "name": { @@ -576,18 +581,16 @@ "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.iotsitewise#PropertyType", + "id": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The property type (see PropertyType).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the asset model property.

" } }, - "dataType": { - "target": "com.amazonaws.iotsitewise#PropertyDataType", + "unit": { + "target": "com.amazonaws.iotsitewise#PropertyUnit", "traits": { - "smithy.api#documentation": "

The data type of the asset model property.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unit of the asset model property, such as Newtons or\n RPM.

" } } }, @@ -612,18 +615,18 @@ "smithy.api#required": {} } }, + "unit": { + "target": "com.amazonaws.iotsitewise#PropertyUnit", + "traits": { + "smithy.api#documentation": "

The unit of the property definition, such as Newtons or\n RPM.

" + } + }, "name": { "target": "com.amazonaws.iotsitewise#Name", "traits": { "smithy.api#documentation": "

The name of the property definition.

", "smithy.api#required": {} } - }, - "unit": { - "target": "com.amazonaws.iotsitewise#PropertyUnit", - "traits": { - "smithy.api#documentation": "

The unit of the property definition, such as Newtons or\n RPM.

" - } } }, "traits": { @@ -685,7 +688,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains current status information for an asset model. For more information, see Asset and Model States in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

Contains current status information for an asset model. For more information, see Asset and model\n states in the AWS IoT SiteWise User Guide.

" } }, "com.amazonaws.iotsitewise#AssetModelSummaries": { @@ -697,24 +700,10 @@ "com.amazonaws.iotsitewise#AssetModelSummary": { "type": "structure", "members": { - "creationDate": { + "lastUpdateDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The date the asset model was created, in Unix epoch time.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.iotsitewise#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the asset model, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}\n

", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the asset model (used with AWS IoT SiteWise APIs).

", + "smithy.api#documentation": "

The date the asset model was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, @@ -739,10 +728,24 @@ "smithy.api#required": {} } }, - "lastUpdateDate": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model (used with AWS IoT SiteWise APIs).

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the asset model, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}\n

", + "smithy.api#required": {} + } + }, + "creationDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The date the asset model was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The date the asset model was created, in Unix epoch time.

", "smithy.api#required": {} } } @@ -760,43 +763,43 @@ "com.amazonaws.iotsitewise#AssetProperty": { "type": "structure", "members": { - "notification": { - "target": "com.amazonaws.iotsitewise#PropertyNotification", + "alias": { + "target": "com.amazonaws.iotsitewise#PropertyAlias", "traits": { - "smithy.api#documentation": "

The asset property's notification topic and state. For more information, see UpdateAssetProperty\n

" + "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n AWS IoT SiteWise User Guide.

" } }, - "dataType": { - "target": "com.amazonaws.iotsitewise#PropertyDataType", + "name": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The data type of the asset property.

", + "smithy.api#documentation": "

The name of the property.

", "smithy.api#required": {} } }, - "unit": { - "target": "com.amazonaws.iotsitewise#PropertyUnit", + "id": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The unit (such as Newtons or RPM) of the asset property.

" + "smithy.api#documentation": "

The ID of the asset property.

", + "smithy.api#required": {} } }, - "alias": { - "target": "com.amazonaws.iotsitewise#PropertyAlias", + "unit": { + "target": "com.amazonaws.iotsitewise#PropertyUnit", "traits": { - "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping Industrial Data Streams to Asset Properties in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The unit (such as Newtons or RPM) of the asset property.

" } }, - "id": { - "target": "com.amazonaws.iotsitewise#ID", + "dataType": { + "target": "com.amazonaws.iotsitewise#PropertyDataType", "traits": { - "smithy.api#documentation": "

The ID of the asset property.

", + "smithy.api#documentation": "

The data type of the asset property.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "notification": { + "target": "com.amazonaws.iotsitewise#PropertyNotification", "traits": { - "smithy.api#documentation": "

The name of the property.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

" } } }, @@ -817,11 +820,10 @@ "com.amazonaws.iotsitewise#AssetPropertyValue": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotsitewise#Variant", + "quality": { + "target": "com.amazonaws.iotsitewise#Quality", "traits": { - "smithy.api#documentation": "

The value of the asset property (see Variant).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The quality of the asset property value.

" } }, "timestamp": { @@ -831,10 +833,11 @@ "smithy.api#required": {} } }, - "quality": { - "target": "com.amazonaws.iotsitewise#Quality", + "value": { + "target": "com.amazonaws.iotsitewise#Variant", "traits": { - "smithy.api#documentation": "

The quality of the asset property value.

" + "smithy.api#documentation": "

The value of the asset property (see Variant).

", + "smithy.api#required": {} } } }, @@ -899,7 +902,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the current status of an asset. For more information, see\n Asset and Model States in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

Contains information about the current status of an asset. For more information, see\n Asset and model\n states in the AWS IoT SiteWise User Guide.

" } }, "com.amazonaws.iotsitewise#AssetSummaries": { @@ -911,24 +914,17 @@ "com.amazonaws.iotsitewise#AssetSummary": { "type": "structure", "members": { - "hierarchies": { - "target": "com.amazonaws.iotsitewise#AssetHierarchies", - "traits": { - "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.iotsitewise#ID", + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the asset.

", + "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "creationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the asset.

", + "smithy.api#documentation": "

The date the asset was created, in Unix epoch time.

", "smithy.api#required": {} } }, @@ -939,10 +935,10 @@ "smithy.api#required": {} } }, - "creationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The date the asset was created, in Unix epoch time.

", + "smithy.api#documentation": "

The ID of the asset model used to create this asset.

", "smithy.api#required": {} } }, @@ -953,17 +949,24 @@ "smithy.api#required": {} } }, - "assetModelId": { + "name": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

The name of the asset.

", + "smithy.api#required": {} + } + }, + "id": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the asset model used to create this asset.

", + "smithy.api#documentation": "

The ID of the asset.

", "smithy.api#required": {} } }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "hierarchies": { + "target": "com.amazonaws.iotsitewise#AssetHierarchies", "traits": { - "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", "smithy.api#required": {} } } @@ -998,7 +1001,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a child asset with the given parent asset through a hierarchy defined in the\n parent asset's model. For more information, see Associating Assets in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

Associates a child asset with the given parent asset through a hierarchy defined in the\n parent asset's model. For more information, see Associating assets in the\n AWS IoT SiteWise User Guide.

", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -1012,17 +1015,18 @@ "com.amazonaws.iotsitewise#AssociateAssetsRequest": { "type": "structure", "members": { - "childAssetId": { + "assetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the child asset to be associated.

", + "smithy.api#documentation": "

The ID of the parent asset.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "hierarchyId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. For more information, see\n Asset Hierarchies in the AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. For more information, see\n Asset hierarchies in the AWS IoT SiteWise User Guide.

", "smithy.api#required": {} } }, @@ -1033,11 +1037,10 @@ "smithy.api#idempotencyToken": {} } }, - "assetId": { + "childAssetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the parent asset.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of the child asset to be associated.

", "smithy.api#required": {} } } @@ -1052,59 +1055,59 @@ "com.amazonaws.iotsitewise#AssociatedAssetsSummary": { "type": "structure", "members": { - "creationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "id": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The date the asset was created, in Unix epoch time.

", + "smithy.api#documentation": "

The ID of the asset.

", "smithy.api#required": {} } }, - "assetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "hierarchies": { + "target": "com.amazonaws.iotsitewise#AssetHierarchies", "traits": { - "smithy.api#documentation": "

The ID of the asset model used to create the asset.

", + "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the asset.

", + "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, - "arn": { - "target": "com.amazonaws.iotsitewise#ARN", + "status": { + "target": "com.amazonaws.iotsitewise#AssetStatus", "traits": { - "smithy.api#documentation": "

The ARN of the asset, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}\n

", + "smithy.api#documentation": "

The current status of the asset.

", "smithy.api#required": {} } }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The ID of the asset model used to create the asset.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.iotsitewise#AssetStatus", + "name": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The current status of the asset.

", + "smithy.api#documentation": "

The name of the asset.

", "smithy.api#required": {} } }, - "hierarchies": { - "target": "com.amazonaws.iotsitewise#AssetHierarchies", + "arn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", + "smithy.api#documentation": "

The ARN of the asset, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}\n

", "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.iotsitewise#ID", + "creationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the asset.

", + "smithy.api#documentation": "

The date the asset was created, in Unix epoch time.

", "smithy.api#required": {} } } @@ -1119,7 +1122,7 @@ "defaultValue": { "target": "com.amazonaws.iotsitewise#DefaultValue", "traits": { - "smithy.api#documentation": "

The default value of the asset model property attribute. All assets that you create from\n the asset model contain this attribute value. You can update an attribute's value after you\n create an asset. For more information, see Updating Attribute Values in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The default value of the asset model property attribute. All assets that you create from\n the asset model contain this attribute value. You can update an attribute's value after you\n create an asset. For more information, see Updating attribute values in the\n AWS IoT SiteWise User Guide.

" } } }, @@ -1127,6 +1130,21 @@ "smithy.api#documentation": "

Contains an asset attribute property. For more information, see\n Attributes in the AWS IoT SiteWise User Guide.

" } }, + "com.amazonaws.iotsitewise#AuthMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IAM", + "name": "IAM" + }, + { + "value": "SSO", + "name": "SSO" + } + ] + } + }, "com.amazonaws.iotsitewise#BatchAssociateProjectAssets": { "type": "operation", "input": { @@ -1173,13 +1191,6 @@ "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest": { "type": "structure", "members": { - "assetIds": { - "target": "com.amazonaws.iotsitewise#IDs", - "traits": { - "smithy.api#documentation": "

The IDs of the assets to be associated to the project.

", - "smithy.api#required": {} - } - }, "projectId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -1194,6 +1205,13 @@ "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", "smithy.api#idempotencyToken": {} } + }, + "assetIds": { + "target": "com.amazonaws.iotsitewise#IDs", + "traits": { + "smithy.api#documentation": "

The IDs of the assets to be associated to the project.

", + "smithy.api#required": {} + } } } }, @@ -1289,10 +1307,10 @@ "com.amazonaws.iotsitewise#BatchPutAssetPropertyError": { "type": "structure", "members": { - "timestamps": { - "target": "com.amazonaws.iotsitewise#Timestamps", + "errorMessage": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", "traits": { - "smithy.api#documentation": "

A list of timestamps for each error, if any.

", + "smithy.api#documentation": "

The associated error message.

", "smithy.api#required": {} } }, @@ -1303,10 +1321,10 @@ "smithy.api#required": {} } }, - "errorMessage": { - "target": "com.amazonaws.iotsitewise#ErrorMessage", + "timestamps": { + "target": "com.amazonaws.iotsitewise#Timestamps", "traits": { - "smithy.api#documentation": "

The associated error message.

", + "smithy.api#documentation": "

A list of timestamps for each error, if any.

", "smithy.api#required": {} } } @@ -1381,7 +1399,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value\n (TQV) data point. For more information, see Ingesting\n Data Using the API in the AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n \n \n

With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more\n than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects\n timestamps outside of the inclusive range of [-15, +5] minutes and returns a\n TimestampOutOfRangeException error.

\n

For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer\n TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1},\n then storing {T1, GOOD, V2} replaces the existing TQV.

\n ", + "smithy.api#documentation": "

Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value\n (TQV) data point. For more information, see Ingesting data using the API in the\n AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n \n \n

With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more\n than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects\n timestamps outside of the inclusive range of [-15, +5] minutes and returns a\n TimestampOutOfRangeException error.

\n

For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer\n TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1},\n then storing {T1, GOOD, V2} replaces the existing TQV.

\n \n

AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually.\n For more information, see BatchPutAssetPropertyValue authorization in the\n AWS IoT SiteWise User Guide.

", "smithy.api#endpoint": { "hostPrefix": "data." }, @@ -1510,17 +1528,17 @@ "com.amazonaws.iotsitewise#ConflictingOperationException": { "type": "structure", "members": { - "resourceId": { - "target": "com.amazonaws.iotsitewise#ResourceId", + "resourceArn": { + "target": "com.amazonaws.iotsitewise#ResourceArn", "traits": { - "smithy.api#documentation": "

The ID of the resource that conflicts with this operation.

", + "smithy.api#documentation": "

The ARN of the resource that conflicts with this operation.

", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.iotsitewise#ResourceArn", + "resourceId": { + "target": "com.amazonaws.iotsitewise#ResourceId", "traits": { - "smithy.api#documentation": "

The ARN of the resource that conflicts with this operation.

", + "smithy.api#documentation": "

The ID of the resource that conflicts with this operation.

", "smithy.api#required": {} } }, @@ -1563,7 +1581,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an access policy that grants the specified AWS Single Sign-On user or group access to the\n specified AWS IoT SiteWise Monitor portal or project resource.

", + "smithy.api#documentation": "

Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or\n IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.

", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -1577,13 +1595,6 @@ "com.amazonaws.iotsitewise#CreateAccessPolicyRequest": { "type": "structure", "members": { - "accessPolicyIdentity": { - "target": "com.amazonaws.iotsitewise#Identity", - "traits": { - "smithy.api#documentation": "

The identity for this access policy. Choose either a user or a group but not both.

", - "smithy.api#required": {} - } - }, "clientToken": { "target": "com.amazonaws.iotsitewise#ClientToken", "traits": { @@ -1594,7 +1605,7 @@ "accessPolicyResource": { "target": "com.amazonaws.iotsitewise#Resource", "traits": { - "smithy.api#documentation": "

The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.

", + "smithy.api#documentation": "

The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

", "smithy.api#required": {} } }, @@ -1608,7 +1619,14 @@ "tags": { "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the access policy. For more\n information, see Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the access policy. For more\n information, see Tagging your\n AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

" + } + }, + "accessPolicyIdentity": { + "target": "com.amazonaws.iotsitewise#Identity", + "traits": { + "smithy.api#documentation": "

The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

", + "smithy.api#required": {} } } } @@ -1664,7 +1682,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an asset from an existing asset model. For more information, see Creating Assets in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

Creates an asset from an existing asset model. For more information, see Creating assets in the\n AWS IoT SiteWise User Guide.

", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -1707,7 +1725,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an asset model from specified property and hierarchy definitions. You create\n assets from asset models. With asset models, you can easily create assets of the same type\n that have standardized definitions. Each asset created from a model inherits the asset model's\n property and hierarchy definitions. For more information, see Defining Asset Models in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

Creates an asset model from specified property and hierarchy definitions. You create\n assets from asset models. With asset models, you can easily create assets of the same type\n that have standardized definitions. Each asset created from a model inherits the asset model's\n property and hierarchy definitions. For more information, see Defining asset models in the\n AWS IoT SiteWise User Guide.

", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -1727,17 +1745,23 @@ "smithy.api#documentation": "

A description for the asset model.

" } }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + }, "assetModelProperties": { "target": "com.amazonaws.iotsitewise#AssetModelPropertyDefinitions", "traits": { - "smithy.api#documentation": "

The property definitions of the asset model. For more information, see\n Asset Properties in the AWS IoT SiteWise User Guide.

\n

You can specify up to 200 properties per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The property definitions of the asset model. For more information, see\n Asset properties in the AWS IoT SiteWise User Guide.

\n

You can specify up to 200 properties per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "assetModelHierarchies": { + "target": "com.amazonaws.iotsitewise#AssetModelHierarchyDefinitions", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model\n whose assets can be children of any other assets created from this asset model. For more\n information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

\n

You can specify up to 10 hierarchies per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" } }, "assetModelName": { @@ -1750,13 +1774,7 @@ "tags": { "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the asset model. For more information,\n see Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

" - } - }, - "assetModelHierarchies": { - "target": "com.amazonaws.iotsitewise#AssetModelHierarchyDefinitions", - "traits": { - "smithy.api#documentation": "

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model\n whose assets can be children of any other assets created from this asset model. For more\n information, see Asset Hierarchies in the AWS IoT SiteWise User Guide.

\n

You can specify up to 10 hierarchies per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the asset model. For more information,\n see Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" } } } @@ -1764,17 +1782,17 @@ "com.amazonaws.iotsitewise#CreateAssetModelResponse": { "type": "structure", "members": { - "assetModelArn": { - "target": "com.amazonaws.iotsitewise#ARN", + "assetModelStatus": { + "target": "com.amazonaws.iotsitewise#AssetModelStatus", "traits": { - "smithy.api#documentation": "

The ARN of the asset model, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}\n

", + "smithy.api#documentation": "

The status of the asset model, which contains a state (CREATING after\n successfully calling this operation) and any error message.

", "smithy.api#required": {} } }, - "assetModelStatus": { - "target": "com.amazonaws.iotsitewise#AssetModelStatus", + "assetModelArn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The status of the asset model, which contains a state (CREATING after\n successfully calling this operation) and any error message.

", + "smithy.api#documentation": "

The ARN of the asset model, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}\n

", "smithy.api#required": {} } }, @@ -1790,13 +1808,6 @@ "com.amazonaws.iotsitewise#CreateAssetRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} - } - }, "assetModelId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -1807,7 +1818,7 @@ "tags": { "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the asset. For more information, see\n Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the asset. For more information, see\n Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" } }, "assetName": { @@ -1816,19 +1827,19 @@ "smithy.api#documentation": "

A unique, friendly name for the asset.

", "smithy.api#required": {} } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } } } }, "com.amazonaws.iotsitewise#CreateAssetResponse": { "type": "structure", "members": { - "assetId": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the asset. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other\n AWS IoT SiteWise APIs.

", - "smithy.api#required": {} - } - }, "assetStatus": { "target": "com.amazonaws.iotsitewise#AssetStatus", "traits": { @@ -1842,6 +1853,13 @@ "smithy.api#documentation": "

The ARN of the asset, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}\n

", "smithy.api#required": {} } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other\n AWS IoT SiteWise APIs.

", + "smithy.api#required": {} + } } } }, @@ -1885,24 +1903,31 @@ "com.amazonaws.iotsitewise#CreateDashboardRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "projectId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The ID of the project in which to create the dashboard.

", + "smithy.api#required": {} + } + }, + "dashboardDescription": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A description for the dashboard.

" } }, "dashboardDefinition": { "target": "com.amazonaws.iotsitewise#DashboardDefinition", "traits": { - "smithy.api#documentation": "

The dashboard definition specified in a JSON literal. For detailed information, see\n Creating Dashboards (CLI) in the AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The dashboard definition specified in a JSON literal. For detailed information, see\n Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.iotsitewise#TagMap", + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the dashboard. For more information,\n see Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} } }, "dashboardName": { @@ -1912,17 +1937,10 @@ "smithy.api#required": {} } }, - "projectId": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the project in which to create the dashboard.

", - "smithy.api#required": {} - } - }, - "dashboardDescription": { - "target": "com.amazonaws.iotsitewise#Description", + "tags": { + "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

A description for the dashboard.

" + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the dashboard. For more information,\n see Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" } } } @@ -1986,17 +2004,10 @@ "com.amazonaws.iotsitewise#CreateGatewayRequest": { "type": "structure", "members": { - "gatewayPlatform": { - "target": "com.amazonaws.iotsitewise#GatewayPlatform", - "traits": { - "smithy.api#documentation": "

The gateway's platform. You can only specify one platform in a gateway.

", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the gateway. For more information, see\n Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the gateway. For more information, see\n Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" } }, "gatewayName": { @@ -2005,23 +2016,30 @@ "smithy.api#documentation": "

A unique, friendly name for the gateway.

", "smithy.api#required": {} } + }, + "gatewayPlatform": { + "target": "com.amazonaws.iotsitewise#GatewayPlatform", + "traits": { + "smithy.api#documentation": "

The gateway's platform. You can only specify one platform in a gateway.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.iotsitewise#CreateGatewayResponse": { "type": "structure", "members": { - "gatewayId": { - "target": "com.amazonaws.iotsitewise#ID", + "gatewayArn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The ID of the gateway device. You can use this ID when you call other AWS IoT SiteWise APIs.

", + "smithy.api#documentation": "

The ARN of the gateway, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}\n

", "smithy.api#required": {} } }, - "gatewayArn": { - "target": "com.amazonaws.iotsitewise#ARN", + "gatewayId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ARN of the gateway, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}\n

", + "smithy.api#documentation": "

The ID of the gateway device. You can use this ID when you call other AWS IoT SiteWise APIs.

", "smithy.api#required": {} } } @@ -2053,7 +2071,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a portal, which can contain projects and dashboards. Before you can create a\n portal, you must configure AWS Single Sign-On in the current Region. AWS IoT SiteWise Monitor uses AWS SSO to manage\n user permissions. For more information, see Enabling AWS SSO in the\n AWS IoT SiteWise User Guide.

\n \n

Before you can sign in to a new portal, you must add at least one AWS SSO user or group to\n that portal. For more information, see Adding or Removing Portal\n Administrators in the AWS IoT SiteWise User Guide.

\n ", + "smithy.api#documentation": "

Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO or IAM\n to authenticate portal users and manage user permissions.

\n \n

Before you can sign in to a new portal, you must add at least one identity to that\n portal. For more information, see Adding or removing portal\n administrators in the AWS IoT SiteWise User Guide.

\n ", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -2067,26 +2085,13 @@ "com.amazonaws.iotsitewise#CreatePortalRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iotsitewise#TagMap", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the portal. For more information, see\n Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

" - } - }, - "portalName": { - "target": "com.amazonaws.iotsitewise#Name", + "portalContactEmail": { + "target": "com.amazonaws.iotsitewise#Email", "traits": { - "smithy.api#documentation": "

A friendly name for the portal.

", + "smithy.api#documentation": "

The AWS administrator's contact email address.

", "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} - } - }, "roleArn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { @@ -2094,10 +2099,16 @@ "smithy.api#required": {} } }, - "portalContactEmail": { - "target": "com.amazonaws.iotsitewise#Email", + "portalDescription": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A description for the portal.

" + } + }, + "portalName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The AWS administrator's contact email address.

", + "smithy.api#documentation": "

A friendly name for the portal.

", "smithy.api#required": {} } }, @@ -2107,10 +2118,23 @@ "smithy.api#documentation": "

A logo image to display in the portal. Upload a square, high-resolution image. The\n image is displayed on a dark background.

" } }, - "portalDescription": { - "target": "com.amazonaws.iotsitewise#Description", + "portalAuthMode": { + "target": "com.amazonaws.iotsitewise#AuthMode", "traits": { - "smithy.api#documentation": "

A description for the portal.

" + "smithy.api#documentation": "

The service to use to authenticate users to the portal. Choose from the following\n options:

\n \n

You can't change this value after you create a portal.

\n

Default: SSO\n

" + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.iotsitewise#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the portal. For more information, see\n Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" } } } @@ -2118,10 +2142,10 @@ "com.amazonaws.iotsitewise#CreatePortalResponse": { "type": "structure", "members": { - "ssoApplicationId": { - "target": "com.amazonaws.iotsitewise#SSOApplicationId", + "portalId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The associated AWS SSO application Id.

", + "smithy.api#documentation": "

The ID of the created portal.

", "smithy.api#required": {} } }, @@ -2139,17 +2163,80 @@ "smithy.api#required": {} } }, + "ssoApplicationId": { + "target": "com.amazonaws.iotsitewise#SSOApplicationId", + "traits": { + "smithy.api#documentation": "

The associated AWS SSO application ID, if the portal uses AWS SSO.

", + "smithy.api#required": {} + } + }, "portalStartUrl": { "target": "com.amazonaws.iotsitewise#Url", "traits": { - "smithy.api#documentation": "

The public URL for the AWS IoT SiteWise Monitor portal.

", + "smithy.api#documentation": "

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that\n use AWS SSO for authentication. For portals that use IAM for authentication, you must use the \n CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.iotsitewise#CreatePresignedPortalUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#CreatePresignedPortalUrlRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#CreatePresignedPortalUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a pre-signed URL to a portal. Use this operation to create URLs to portals that\n use AWS Identity and Access Management (IAM) to authenticate users. An IAM user with access to a portal can call this API\n to get a URL to that portal. The URL contains a session token that lets the IAM user access\n the portal.

", + "smithy.api#endpoint": { + "hostPrefix": "monitor." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/portals/{portalId}/presigned-url", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#CreatePresignedPortalUrlRequest": { + "type": "structure", + "members": { + "sessionDurationSeconds": { + "target": "com.amazonaws.iotsitewise#SessionDurationSeconds", + "traits": { + "smithy.api#documentation": "

The duration (in seconds) for which the session at the URL is valid.

\n

Default: 900 seconds (15 minutes)

", + "smithy.api#httpQuery": "sessionDurationSeconds" + } }, "portalId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the created portal.

", + "smithy.api#documentation": "

The ID of the portal to access.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotsitewise#CreatePresignedPortalUrlResponse": { + "type": "structure", + "members": { + "presignedPortalUrl": { + "target": "com.amazonaws.iotsitewise#Url", + "traits": { + "smithy.api#documentation": "

The pre-signed URL to the portal. The URL contains the portal ID and a session token that\n lets you access the portal. The URL has the following format.

\n

\n https://.app.iotsitewise.aws/auth?token=\n

", "smithy.api#required": {} } } @@ -2195,10 +2282,18 @@ "com.amazonaws.iotsitewise#CreateProjectRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iotsitewise#TagMap", + "portalId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the portal in which to create the project.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the project. For more information, see\n Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} } }, "projectDescription": { @@ -2207,26 +2302,18 @@ "smithy.api#documentation": "

A description for the project.

" } }, - "projectName": { - "target": "com.amazonaws.iotsitewise#Name", + "tags": { + "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

A friendly name for the project.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the project. For more information, see\n Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" } }, - "portalId": { - "target": "com.amazonaws.iotsitewise#ID", + "projectName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The ID of the portal in which to create the project.

", + "smithy.api#documentation": "

A friendly name for the project.

", "smithy.api#required": {} } - }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} - } } } }, @@ -2275,12 +2362,6 @@ "smithy.api#required": {} } }, - "creationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", - "traits": { - "smithy.api#documentation": "

The date the dashboard was created, in Unix epoch time.

" - } - }, "lastUpdateDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { @@ -2299,6 +2380,12 @@ "smithy.api#documentation": "

The name of the dashboard

", "smithy.api#required": {} } + }, + "creationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the dashboard was created, in Unix epoch time.

" + } } }, "traits": { @@ -2338,7 +2425,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an access policy that grants the specified AWS Single Sign-On identity access to the\n specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor\n resource.

", + "smithy.api#documentation": "

Deletes an access policy that grants the specified identity access to the specified\n AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor\n resource.

", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -2400,7 +2487,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an asset. This action can't be undone. For more information, see Deleting Assets and Models in the\n AWS IoT SiteWise User Guide.\n

\n \n

You can't delete an asset that's associated to another asset. For more information, see\n DisassociateAssets.

\n ", + "smithy.api#documentation": "

Deletes an asset. This action can't be undone. For more information, see Deleting assets and\n models in the AWS IoT SiteWise User Guide.\n

\n \n

You can't delete an asset that's associated to another asset. For more information, see\n DisassociateAssets.

\n ", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -2437,7 +2524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an asset model. This action can't be undone. You must delete all assets created\n from an asset model before you can delete the model. Also, you can't delete an asset model if\n a parent asset model exists that contains a property formula expression that depends on the\n asset model that you want to delete. For more information, see Deleting Assets and Models in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

Deletes an asset model. This action can't be undone. You must delete all assets created\n from an asset model before you can delete the model. Also, you can't delete an asset model if\n a parent asset model exists that contains a property formula expression that depends on the\n asset model that you want to delete. For more information, see Deleting assets and models in the\n AWS IoT SiteWise User Guide.

", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -2484,14 +2571,6 @@ "com.amazonaws.iotsitewise#DeleteAssetRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - }, "assetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -2499,6 +2578,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } } } }, @@ -2593,7 +2680,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain\n in your gateway's file system. For more information, see Data retention in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain\n in your gateway's file system.

", "smithy.api#endpoint": { "hostPrefix": "edge." }, @@ -2724,14 +2811,6 @@ "com.amazonaws.iotsitewise#DeleteProjectRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - }, "projectId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -2739,6 +2818,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } } } }, @@ -2769,7 +2856,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes an access policy, which specifies an AWS SSO user or group's access to an\n AWS IoT SiteWise Monitor portal or project.

", + "smithy.api#documentation": "

Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or\n project.

", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -2796,6 +2883,20 @@ "com.amazonaws.iotsitewise#DescribeAccessPolicyResponse": { "type": "structure", "members": { + "accessPolicyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the access policy.

", + "smithy.api#required": {} + } + }, + "accessPolicyPermission": { + "target": "com.amazonaws.iotsitewise#Permission", + "traits": { + "smithy.api#documentation": "

The access policy permission. Note that a project ADMINISTRATOR is also known\n as a project owner.

", + "smithy.api#required": {} + } + }, "accessPolicyCreationDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { @@ -2810,13 +2911,6 @@ "smithy.api#required": {} } }, - "accessPolicyPermission": { - "target": "com.amazonaws.iotsitewise#Permission", - "traits": { - "smithy.api#documentation": "

The access policy permission. Note that a project ADMINISTRATOR is also known\n as a project owner.

", - "smithy.api#required": {} - } - }, "accessPolicyArn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { @@ -2831,17 +2925,10 @@ "smithy.api#required": {} } }, - "accessPolicyId": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the access policy.

", - "smithy.api#required": {} - } - }, "accessPolicyIdentity": { "target": "com.amazonaws.iotsitewise#Identity", "traits": { - "smithy.api#documentation": "

The AWS SSO identity (user or group) to which this access policy applies.

", + "smithy.api#documentation": "

The identity (AWS SSO user, AWS SSO group, or IAM user) to which this access policy\n applies.

", "smithy.api#required": {} } } @@ -2931,31 +3018,31 @@ "com.amazonaws.iotsitewise#DescribeAssetModelResponse": { "type": "structure", "members": { - "assetModelHierarchies": { - "target": "com.amazonaws.iotsitewise#AssetModelHierarchies", + "assetModelStatus": { + "target": "com.amazonaws.iotsitewise#AssetModelStatus", "traits": { - "smithy.api#documentation": "

A list of asset model hierarchies that each contain a childAssetModelId and a\n hierarchyId (named id). A hierarchy specifies allowed parent/child\n asset relationships for an asset model.

", + "smithy.api#documentation": "

The current status of the asset model, which contains a state and any error\n message.

", "smithy.api#required": {} } }, - "assetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "assetModelLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the asset model.

", + "smithy.api#documentation": "

The date the asset model was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, - "assetModelName": { - "target": "com.amazonaws.iotsitewise#Name", + "assetModelHierarchies": { + "target": "com.amazonaws.iotsitewise#AssetModelHierarchies", "traits": { - "smithy.api#documentation": "

The name of the asset model.

", + "smithy.api#documentation": "

A list of asset model hierarchies that each contain a childAssetModelId and a\n hierarchyId (named id). A hierarchy specifies allowed parent/child\n asset relationships for an asset model.

", "smithy.api#required": {} } }, - "assetModelLastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "assetModelProperties": { + "target": "com.amazonaws.iotsitewise#AssetModelProperties", "traits": { - "smithy.api#documentation": "

The date the asset model was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The list of asset properties for the asset model.

", "smithy.api#required": {} } }, @@ -2966,31 +3053,31 @@ "smithy.api#required": {} } }, - "assetModelProperties": { - "target": "com.amazonaws.iotsitewise#AssetModelProperties", + "assetModelDescription": { + "target": "com.amazonaws.iotsitewise#Description", "traits": { - "smithy.api#documentation": "

The list of asset properties for the asset model.

", + "smithy.api#documentation": "

The asset model's description.

", "smithy.api#required": {} } }, - "assetModelDescription": { - "target": "com.amazonaws.iotsitewise#Description", + "assetModelCreationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The asset model's description.

", + "smithy.api#documentation": "

The date the asset model was created, in Unix epoch time.

", "smithy.api#required": {} } }, - "assetModelStatus": { - "target": "com.amazonaws.iotsitewise#AssetModelStatus", + "assetModelName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The current status of the asset model, which contains a state and any error\n message.

", + "smithy.api#documentation": "

The name of the asset model.

", "smithy.api#required": {} } }, - "assetModelCreationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The date the asset model was created, in Unix epoch time.

", + "smithy.api#documentation": "

The ID of the asset model.

", "smithy.api#required": {} } } @@ -3019,7 +3106,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about an asset's property.

", + "smithy.api#documentation": "

Retrieves information about an asset property.

\n \n

When you call this operation for an attribute property, this response includes the\n default attribute value that you define in the asset model. If you update the default value\n in the model, this operation's response includes the new default value.

\n \n

This operation doesn't return the value of the asset property. To get the value of an\n asset property, use GetAssetPropertyValue.

", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -3054,6 +3141,13 @@ "com.amazonaws.iotsitewise#DescribeAssetPropertyResponse": { "type": "structure", "members": { + "assetProperty": { + "target": "com.amazonaws.iotsitewise#Property", + "traits": { + "smithy.api#documentation": "

The asset property's definition, alias, and notification state.

", + "smithy.api#required": {} + } + }, "assetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -3068,13 +3162,6 @@ "smithy.api#required": {} } }, - "assetProperty": { - "target": "com.amazonaws.iotsitewise#Property", - "traits": { - "smithy.api#documentation": "

The asset property's definition, alias, and notification state.

", - "smithy.api#required": {} - } - }, "assetName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { @@ -3100,17 +3187,10 @@ "com.amazonaws.iotsitewise#DescribeAssetResponse": { "type": "structure", "members": { - "assetHierarchies": { - "target": "com.amazonaws.iotsitewise#AssetHierarchies", - "traits": { - "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", - "smithy.api#required": {} - } - }, - "assetLastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The ID of the asset.

", "smithy.api#required": {} } }, @@ -3128,10 +3208,17 @@ "smithy.api#required": {} } }, - "assetName": { - "target": "com.amazonaws.iotsitewise#Name", + "assetLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the asset.

", + "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "assetStatus": { + "target": "com.amazonaws.iotsitewise#AssetStatus", + "traits": { + "smithy.api#documentation": "

The current status of the asset, which contains a state and any error message.

", "smithy.api#required": {} } }, @@ -3142,10 +3229,10 @@ "smithy.api#required": {} } }, - "assetStatus": { - "target": "com.amazonaws.iotsitewise#AssetStatus", + "assetName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The current status of the asset, which contains a state and any error message.

", + "smithy.api#documentation": "

The name of the asset.

", "smithy.api#required": {} } }, @@ -3156,10 +3243,10 @@ "smithy.api#required": {} } }, - "assetId": { - "target": "com.amazonaws.iotsitewise#ID", + "assetHierarchies": { + "target": "com.amazonaws.iotsitewise#AssetHierarchies", "traits": { - "smithy.api#documentation": "

The ID of the asset.

", + "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", "smithy.api#required": {} } } @@ -3215,6 +3302,13 @@ "com.amazonaws.iotsitewise#DescribeDashboardResponse": { "type": "structure", "members": { + "dashboardName": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

The name of the dashboard.

", + "smithy.api#required": {} + } + }, "projectId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -3222,17 +3316,17 @@ "smithy.api#required": {} } }, - "dashboardCreationDate": { + "dashboardLastUpdateDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The date the dashboard was created, in Unix epoch time.

", + "smithy.api#documentation": "

The date the dashboard was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, - "dashboardId": { - "target": "com.amazonaws.iotsitewise#ID", + "dashboardCreationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the dashboard.

", + "smithy.api#documentation": "

The date the dashboard was created, in Unix epoch time.

", "smithy.api#required": {} } }, @@ -3242,17 +3336,17 @@ "smithy.api#documentation": "

The dashboard's description.

" } }, - "dashboardLastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "dashboardId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The date the dashboard was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The ID of the dashboard.

", "smithy.api#required": {} } }, "dashboardDefinition": { "target": "com.amazonaws.iotsitewise#DashboardDefinition", "traits": { - "smithy.api#documentation": "

The dashboard's definition JSON literal. For detailed information, see Creating Dashboards (CLI) in\n the AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The dashboard's definition JSON literal. For detailed information, see Creating\n dashboards (CLI) in the AWS IoT SiteWise User Guide.

", "smithy.api#required": {} } }, @@ -3262,13 +3356,6 @@ "smithy.api#documentation": "

The ARN of the dashboard, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}\n

", "smithy.api#required": {} } - }, - "dashboardName": { - "target": "com.amazonaws.iotsitewise#Name", - "traits": { - "smithy.api#documentation": "

The name of the dashboard.

", - "smithy.api#required": {} - } } } }, @@ -3364,17 +3451,17 @@ "com.amazonaws.iotsitewise#DescribeGatewayCapabilityConfigurationResponse": { "type": "structure", "members": { - "capabilityNamespace": { - "target": "com.amazonaws.iotsitewise#CapabilityNamespace", + "gatewayId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The namespace of the gateway capability.

", + "smithy.api#documentation": "

The ID of the gateway that defines the capability configuration.

", "smithy.api#required": {} } }, - "capabilityConfiguration": { - "target": "com.amazonaws.iotsitewise#CapabilityConfiguration", + "capabilityNamespace": { + "target": "com.amazonaws.iotsitewise#CapabilityNamespace", "traits": { - "smithy.api#documentation": "

The JSON document that defines the gateway capability's configuration. For more\n information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The namespace of the gateway capability.

", "smithy.api#required": {} } }, @@ -3385,10 +3472,10 @@ "smithy.api#required": {} } }, - "gatewayId": { - "target": "com.amazonaws.iotsitewise#ID", + "capabilityConfiguration": { + "target": "com.amazonaws.iotsitewise#CapabilityConfiguration", "traits": { - "smithy.api#documentation": "

The ID of the gateway that defines the capability configuration.

", + "smithy.api#documentation": "

The JSON document that defines the gateway capability's configuration. For more\n information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.

", "smithy.api#required": {} } } @@ -3410,10 +3497,10 @@ "com.amazonaws.iotsitewise#DescribeGatewayResponse": { "type": "structure", "members": { - "gatewayName": { - "target": "com.amazonaws.iotsitewise#Name", + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the gateway.

", + "smithy.api#documentation": "

The date the gateway was last updated, in Unix epoch time.

", "smithy.api#required": {} } }, @@ -3424,17 +3511,24 @@ "smithy.api#required": {} } }, - "gatewayId": { - "target": "com.amazonaws.iotsitewise#ID", + "gatewayName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The ID of the gateway device.

", + "smithy.api#documentation": "

The name of the gateway.

", "smithy.api#required": {} } }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "gatewayCapabilitySummaries": { + "target": "com.amazonaws.iotsitewise#GatewayCapabilitySummaries", "traits": { - "smithy.api#documentation": "

The date the gateway was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

A list of gateway capability summaries that each contain a namespace and status. Each\n gateway capability defines data sources for the gateway. To retrieve a capability\n configuration's definition, use DescribeGatewayCapabilityConfiguration.

", + "smithy.api#required": {} + } + }, + "gatewayId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the gateway device.

", "smithy.api#required": {} } }, @@ -3450,13 +3544,6 @@ "smithy.api#documentation": "

The date the gateway was created, in Unix epoch time.

", "smithy.api#required": {} } - }, - "gatewayCapabilitySummaries": { - "target": "com.amazonaws.iotsitewise#GatewayCapabilitySummaries", - "traits": { - "smithy.api#documentation": "

A list of gateway capability summaries that each contain a namespace and status. Each\n gateway capability defines data sources for the gateway. To retrieve a capability\n configuration's definition, use DescribeGatewayCapabilityConfiguration.

", - "smithy.api#required": {} - } } } }, @@ -3560,37 +3647,35 @@ "com.amazonaws.iotsitewise#DescribePortalResponse": { "type": "structure", "members": { - "portalCreationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "portalLogoImageLocation": { + "target": "com.amazonaws.iotsitewise#ImageLocation", "traits": { - "smithy.api#documentation": "

The date the portal was created, in Unix epoch time.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The portal's logo image, which is available at a URL.

" } }, - "portalLastUpdateDate": { + "portalCreationDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The date the portal was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The date the portal was created, in Unix epoch time.

", "smithy.api#required": {} } }, - "portalArn": { - "target": "com.amazonaws.iotsitewise#ARN", + "portalDescription": { + "target": "com.amazonaws.iotsitewise#Description", "traits": { - "smithy.api#documentation": "

The ARN of the portal, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The portal's description.

" } }, - "portalLogoImageLocation": { - "target": "com.amazonaws.iotsitewise#ImageLocation", + "roleArn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The portal's logo image, which is available at a URL.

" + "smithy.api#documentation": "

The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise\n resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the\n AWS IoT SiteWise User Guide.

" } }, - "portalClientId": { - "target": "com.amazonaws.iotsitewise#PortalClientId", + "portalName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The AWS SSO application generated client ID (used with AWS SSO APIs).

", + "smithy.api#documentation": "

The name of the portal.

", "smithy.api#required": {} } }, @@ -3601,30 +3686,37 @@ "smithy.api#required": {} } }, - "portalId": { - "target": "com.amazonaws.iotsitewise#ID", + "portalAuthMode": { + "target": "com.amazonaws.iotsitewise#AuthMode", "traits": { - "smithy.api#documentation": "

The ID of the portal.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The service to use to authenticate users to the portal.

" } }, "portalStartUrl": { "target": "com.amazonaws.iotsitewise#Url", "traits": { - "smithy.api#documentation": "

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

", + "smithy.api#documentation": "

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that\n use AWS SSO for authentication. For portals that use IAM for authentication, you must use the \n CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

", "smithy.api#required": {} } }, - "roleArn": { + "portalId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the portal.

", + "smithy.api#required": {} + } + }, + "portalArn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise\n resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The ARN of the portal, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}\n

", + "smithy.api#required": {} } }, - "portalName": { - "target": "com.amazonaws.iotsitewise#Name", + "portalClientId": { + "target": "com.amazonaws.iotsitewise#PortalClientId", "traits": { - "smithy.api#documentation": "

The name of the portal.

", + "smithy.api#documentation": "

The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes\n portalClientId for only portals that use AWS SSO to authenticate users.

", "smithy.api#required": {} } }, @@ -3635,10 +3727,11 @@ "smithy.api#required": {} } }, - "portalDescription": { - "target": "com.amazonaws.iotsitewise#Description", + "portalLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The portal's description.

" + "smithy.api#documentation": "

The date the portal was last updated, in Unix epoch time.

", + "smithy.api#required": {} } } } @@ -3693,10 +3786,16 @@ "com.amazonaws.iotsitewise#DescribeProjectResponse": { "type": "structure", "members": { - "projectLastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "projectDescription": { + "target": "com.amazonaws.iotsitewise#Description", "traits": { - "smithy.api#documentation": "

The date the project was last updated, in Unix epoch time.

", + "smithy.api#documentation": "

The project's description.

" + } + }, + "projectId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the project.

", "smithy.api#required": {} } }, @@ -3707,10 +3806,11 @@ "smithy.api#required": {} } }, - "projectDescription": { - "target": "com.amazonaws.iotsitewise#Description", + "projectLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The project's description.

" + "smithy.api#documentation": "

The date the project was last updated, in Unix epoch time.

", + "smithy.api#required": {} } }, "projectCreationDate": { @@ -3720,24 +3820,17 @@ "smithy.api#required": {} } }, - "projectName": { - "target": "com.amazonaws.iotsitewise#Name", - "traits": { - "smithy.api#documentation": "

The name of the project.

", - "smithy.api#required": {} - } - }, - "projectId": { - "target": "com.amazonaws.iotsitewise#ID", + "projectArn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The ID of the project.

", + "smithy.api#documentation": "

The ARN of the project, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}\n

", "smithy.api#required": {} } }, - "projectArn": { - "target": "com.amazonaws.iotsitewise#ARN", + "projectName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The ARN of the project, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}\n

", + "smithy.api#documentation": "

The name of the project.

", "smithy.api#required": {} } } @@ -3790,17 +3883,17 @@ "com.amazonaws.iotsitewise#DisassociateAssetsRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "hierarchyId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. You can use the hierarchy ID\n to identify the correct asset to disassociate. For more information, see\n Asset hierarchies in the AWS IoT SiteWise User Guide.

", + "smithy.api#required": {} } }, - "hierarchyId": { + "childAssetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings\n of assets to be formed that all come from the same asset model. You can use the hierarchy ID\n to identify the correct asset to disassociate. For more information, see\n Asset Hierarchies in the AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The ID of the child asset to disassociate.

", "smithy.api#required": {} } }, @@ -3812,11 +3905,11 @@ "smithy.api#required": {} } }, - "childAssetId": { - "target": "com.amazonaws.iotsitewise#ID", + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", "traits": { - "smithy.api#documentation": "

The ID of the child asset to disassociate.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} } } } @@ -3859,17 +3952,17 @@ "com.amazonaws.iotsitewise#ErrorDetails": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.iotsitewise#ErrorCode", + "message": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", "traits": { - "smithy.api#documentation": "

The error code.

", + "smithy.api#documentation": "

The error message.

", "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.iotsitewise#ErrorMessage", + "code": { + "target": "com.amazonaws.iotsitewise#ErrorCode", "traits": { - "smithy.api#documentation": "

The error message.

", + "smithy.api#documentation": "

The error code.

", "smithy.api#required": {} } } @@ -3931,17 +4024,17 @@ "com.amazonaws.iotsitewise#GatewayCapabilitySummary": { "type": "structure", "members": { - "capabilityNamespace": { - "target": "com.amazonaws.iotsitewise#CapabilityNamespace", + "capabilitySyncStatus": { + "target": "com.amazonaws.iotsitewise#CapabilitySyncStatus", "traits": { - "smithy.api#documentation": "

The namespace of the capability configuration.\n For example, if you configure OPC-UA\n sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:version, where version is a number such as\n 1.

", + "smithy.api#documentation": "

The synchronization status of the capability configuration. The sync status can be one of the following:

\n ", "smithy.api#required": {} } }, - "capabilitySyncStatus": { - "target": "com.amazonaws.iotsitewise#CapabilitySyncStatus", + "capabilityNamespace": { + "target": "com.amazonaws.iotsitewise#CapabilityNamespace", "traits": { - "smithy.api#documentation": "

The synchronization status of the capability configuration. The sync status can be one of the following:

\n ", + "smithy.api#documentation": "

The namespace of the capability configuration.\n For example, if you configure OPC-UA\n sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:version, where version is a number such as\n 1.

", "smithy.api#required": {} } } @@ -3974,6 +4067,12 @@ "com.amazonaws.iotsitewise#GatewaySummary": { "type": "structure", "members": { + "gatewayCapabilitySummaries": { + "target": "com.amazonaws.iotsitewise#GatewayCapabilitySummaries", + "traits": { + "smithy.api#documentation": "

A list of gateway capability summaries that each contain a namespace and status. Each\n gateway capability defines data sources for the gateway. To retrieve a capability\n configuration's definition, use DescribeGatewayCapabilityConfiguration.

" + } + }, "lastUpdateDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { @@ -3992,13 +4091,7 @@ "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { "smithy.api#documentation": "

The date the gateway was created, in Unix epoch time.

", - "smithy.api#required": {} - } - }, - "gatewayCapabilitySummaries": { - "target": "com.amazonaws.iotsitewise#GatewayCapabilitySummaries", - "traits": { - "smithy.api#documentation": "

A list of gateway capability summaries that each contain a namespace and status. Each\n gateway capability defines data sources for the gateway. To retrieve a capability\n configuration's definition, use DescribeGatewayCapabilityConfiguration.

" + "smithy.api#required": {} } }, "gatewayId": { @@ -4039,7 +4132,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets aggregated values for an asset property. For more information, see Querying Aggregated Property\n Values in the AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n ", + "smithy.api#documentation": "

Gets aggregated values for an asset property. For more information, see Querying\n aggregates in the AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n ", "smithy.api#endpoint": { "hostPrefix": "data." }, @@ -4058,6 +4151,13 @@ "com.amazonaws.iotsitewise#GetAssetPropertyAggregatesRequest": { "type": "structure", "members": { + "timeOrdering": { + "target": "com.amazonaws.iotsitewise#TimeOrdering", + "traits": { + "smithy.api#documentation": "

The chronological sorting order of the requested information.

\n

Default: ASCENDING\n

", + "smithy.api#httpQuery": "timeOrdering" + } + }, "propertyId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -4065,6 +4165,13 @@ "smithy.api#httpQuery": "propertyId" } }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + }, "startDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { @@ -4073,27 +4180,26 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#httpQuery": "propertyAlias" } }, - "endDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "resolution": { + "target": "com.amazonaws.iotsitewise#Resolution", "traits": { - "smithy.api#documentation": "

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

", - "smithy.api#httpQuery": "endDate", + "smithy.api#documentation": "

The time interval over which to aggregate data.

", + "smithy.api#httpQuery": "resolution", "smithy.api#required": {} } }, - "aggregateTypes": { - "target": "com.amazonaws.iotsitewise#AggregateTypes", + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", "traits": { - "smithy.api#documentation": "

The data aggregating function.

", - "smithy.api#httpQuery": "aggregateTypes", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 100

", + "smithy.api#httpQuery": "maxResults" } }, "assetId": { @@ -4103,41 +4209,28 @@ "smithy.api#httpQuery": "assetId" } }, - "propertyAlias": { - "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", - "traits": { - "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping Industrial Data Streams to Asset Properties in the\n AWS IoT SiteWise User Guide.

", - "smithy.api#httpQuery": "propertyAlias" - } - }, - "resolution": { - "target": "com.amazonaws.iotsitewise#Resolution", + "aggregateTypes": { + "target": "com.amazonaws.iotsitewise#AggregateTypes", "traits": { - "smithy.api#documentation": "

The time interval over which to aggregate data.

", - "smithy.api#httpQuery": "resolution", + "smithy.api#documentation": "

The data aggregating function.

", + "smithy.api#httpQuery": "aggregateTypes", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.iotsitewise#NextToken", - "traits": { - "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "timeOrdering": { - "target": "com.amazonaws.iotsitewise#TimeOrdering", - "traits": { - "smithy.api#documentation": "

The chronological sorting order of the requested information.

", - "smithy.api#httpQuery": "timeOrdering" - } - }, "qualities": { "target": "com.amazonaws.iotsitewise#Qualities", "traits": { "smithy.api#documentation": "

The quality by which to filter asset data.

", "smithy.api#httpQuery": "qualities" } + }, + "endDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

", + "smithy.api#httpQuery": "endDate", + "smithy.api#required": {} + } } } }, @@ -4185,7 +4278,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an asset property's current value. For more information, see Querying Current Property\n Values in the AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n ", + "smithy.api#documentation": "

Gets an asset property's current value. For more information, see Querying\n current values in the AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n ", "smithy.api#endpoint": { "hostPrefix": "data." }, @@ -4222,7 +4315,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the history of an asset property's values. For more information, see Querying Historical Property\n Values in the AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n ", + "smithy.api#documentation": "

Gets the history of an asset property's values. For more information, see Querying\n historical values in the AWS IoT SiteWise User Guide.

\n

To identify an asset property, you must specify one of the following:

\n ", "smithy.api#endpoint": { "hostPrefix": "data." }, @@ -4241,32 +4334,32 @@ "com.amazonaws.iotsitewise#GetAssetPropertyValueHistoryRequest": { "type": "structure", "members": { - "qualities": { - "target": "com.amazonaws.iotsitewise#Qualities", + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The quality by which to filter asset data.

", - "smithy.api#httpQuery": "qualities" + "smithy.api#documentation": "

The ID of the asset.

", + "smithy.api#httpQuery": "assetId" } }, - "timeOrdering": { - "target": "com.amazonaws.iotsitewise#TimeOrdering", + "endDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The chronological sorting order of the requested information.

", - "smithy.api#httpQuery": "timeOrdering" + "smithy.api#documentation": "

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

", + "smithy.api#httpQuery": "endDate" } }, - "propertyAlias": { - "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", "traits": { - "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping Industrial Data Streams to Asset Properties in the\n AWS IoT SiteWise User Guide.

", - "smithy.api#httpQuery": "propertyAlias" + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 100

", + "smithy.api#httpQuery": "maxResults" } }, - "propertyId": { - "target": "com.amazonaws.iotsitewise#ID", + "qualities": { + "target": "com.amazonaws.iotsitewise#Qualities", "traits": { - "smithy.api#documentation": "

The ID of the asset property.

", - "smithy.api#httpQuery": "propertyId" + "smithy.api#documentation": "

The quality by which to filter asset data.

", + "smithy.api#httpQuery": "qualities" } }, "startDate": { @@ -4276,25 +4369,25 @@ "smithy.api#httpQuery": "startDate" } }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#httpQuery": "propertyAlias" } }, - "assetId": { + "propertyId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the asset.

", - "smithy.api#httpQuery": "assetId" + "smithy.api#documentation": "

The ID of the asset property.

", + "smithy.api#httpQuery": "propertyId" } }, - "endDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "timeOrdering": { + "target": "com.amazonaws.iotsitewise#TimeOrdering", "traits": { - "smithy.api#documentation": "

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

", - "smithy.api#httpQuery": "endDate" + "smithy.api#documentation": "

The chronological sorting order of the requested information.

\n

Default: ASCENDING\n

", + "smithy.api#httpQuery": "timeOrdering" } }, "nextToken": { @@ -4309,24 +4402,31 @@ "com.amazonaws.iotsitewise#GetAssetPropertyValueHistoryResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } + }, "assetPropertyValueHistory": { "target": "com.amazonaws.iotsitewise#AssetPropertyValueHistory", "traits": { "smithy.api#documentation": "

The asset property's value history.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.iotsitewise#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" - } } } }, "com.amazonaws.iotsitewise#GetAssetPropertyValueRequest": { "type": "structure", "members": { + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

", + "smithy.api#httpQuery": "propertyId" + } + }, "assetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -4337,16 +4437,9 @@ "propertyAlias": { "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", "traits": { - "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping Industrial Data Streams to Asset Properties in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n AWS IoT SiteWise User Guide.

", "smithy.api#httpQuery": "propertyAlias" } - }, - "propertyId": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the asset property.

", - "smithy.api#httpQuery": "propertyId" - } } } }, @@ -4367,13 +4460,13 @@ "groupArn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The ARN of the Greengrass group. For more information about how to find a group's\n ARN, see ListGroups and GetGroup in\n the AWS IoT Greengrass API Reference.

", + "smithy.api#documentation": "

The ARN of the Greengrass group. For more information about how to find a group's\n ARN, see ListGroups and GetGroup in the\n AWS IoT Greengrass API Reference.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains details for a gateway that runs on AWS IoT Greengrass. To create a gateway that runs on AWS IoT Greengrass,\n you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass\n group must also have permissions to upload data to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

Contains details for a gateway that runs on AWS IoT Greengrass. To create a gateway that runs on AWS IoT Greengrass,\n you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass\n group must also have permissions to upload data to AWS IoT SiteWise. For more information, see Ingesting data using a\n gateway in the AWS IoT SiteWise User Guide.

" } }, "com.amazonaws.iotsitewise#GroupIdentity": { @@ -4391,6 +4484,21 @@ "smithy.api#documentation": "

Contains information for a group identity in an access policy.

" } }, + "com.amazonaws.iotsitewise#IAMUserIdentity": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM user. IAM users must have the\n iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For more information, see IAM\n ARNs in the IAM User Guide.

\n \n

If you delete the IAM user, access policies that contain this identity include an\n empty arn. You can delete the access policy for the IAM user that no longer\n exists.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an AWS Identity and Access Management (IAM) user.

" + } + }, "com.amazonaws.iotsitewise#ID": { "type": "string", "traits": { @@ -4416,21 +4524,27 @@ "com.amazonaws.iotsitewise#Identity": { "type": "structure", "members": { - "group": { - "target": "com.amazonaws.iotsitewise#GroupIdentity", + "iamUser": { + "target": "com.amazonaws.iotsitewise#IAMUserIdentity", "traits": { - "smithy.api#documentation": "

A group identity.

" + "smithy.api#documentation": "

An IAM user identity.

" } }, "user": { "target": "com.amazonaws.iotsitewise#UserIdentity", "traits": { - "smithy.api#documentation": "

A user identity.

" + "smithy.api#documentation": "

An AWS SSO user identity.

" + } + }, + "group": { + "target": "com.amazonaws.iotsitewise#GroupIdentity", + "traits": { + "smithy.api#documentation": "

An AWS SSO group identity.

" } } }, "traits": { - "smithy.api#documentation": "

Contains an AWS SSO identity ID for a user or group.

\n \n

Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO\n identity IDs in the URL of user and group pages in the AWS SSO console.

\n " + "smithy.api#documentation": "

Contains an identity that can access an AWS IoT SiteWise Monitor resource.

\n \n

Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO\n identity IDs in the URL of user and group pages in the AWS SSO console.

\n " } }, "com.amazonaws.iotsitewise#IdentityId": { @@ -4454,6 +4568,10 @@ { "value": "GROUP", "name": "GROUP" + }, + { + "value": "IAM", + "name": "IAM" } ] } @@ -4478,17 +4596,17 @@ "com.amazonaws.iotsitewise#ImageFile": { "type": "structure", "members": { - "data": { - "target": "com.amazonaws.iotsitewise#ImageFileData", + "type": { + "target": "com.amazonaws.iotsitewise#ImageFileType", "traits": { - "smithy.api#documentation": "

The image file contents, represented as a base64-encoded string. The file size must be\n less than 1 MB.

", + "smithy.api#documentation": "

The file type of the image.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.iotsitewise#ImageFileType", + "data": { + "target": "com.amazonaws.iotsitewise#ImageFileData", "traits": { - "smithy.api#documentation": "

The file type of the image.

", + "smithy.api#documentation": "

The image file contents, represented as a base64-encoded string. The file size must be\n less than 1 MB.

", "smithy.api#required": {} } } @@ -4617,7 +4735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a paginated list of access policies for an AWS SSO identity (a user or group) or\n an AWS IoT SiteWise Monitor resource (a portal or project).

", + "smithy.api#documentation": "

Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO\n group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).

", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -4639,17 +4757,31 @@ "identityId": { "target": "com.amazonaws.iotsitewise#IdentityId", "traits": { - "smithy.api#documentation": "

The ID of the identity. This parameter is required if you specify\n identityType.

", + "smithy.api#documentation": "

The ID of the identity. This parameter is required if you specify USER or\n GROUP for identityType.

", "smithy.api#httpQuery": "identityId" } }, + "resourceId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the resource. This parameter is required if you specify\n resourceType.

", + "smithy.api#httpQuery": "resourceId" + } + }, "identityType": { "target": "com.amazonaws.iotsitewise#IdentityType", "traits": { - "smithy.api#documentation": "

The type of identity (user or group). This parameter is required if you specify\n identityId.

", + "smithy.api#documentation": "

The type of identity (AWS SSO user, AWS SSO group, or IAM user). This parameter is required\n if you specify identityId.

", "smithy.api#httpQuery": "identityType" } }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" + } + }, "nextToken": { "target": "com.amazonaws.iotsitewise#NextToken", "traits": { @@ -4657,13 +4789,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "resourceId": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the resource. This parameter is required if you specify\n resourceType.

", - "smithy.api#httpQuery": "resourceId" - } - }, "resourceType": { "target": "com.amazonaws.iotsitewise#ResourceType", "traits": { @@ -4671,11 +4796,11 @@ "smithy.api#httpQuery": "resourceType" } }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", + "iamArn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ARN of the IAM user. For more information, see IAM ARNs in the\n IAM User Guide. This parameter is required if you specify\n IAM for identityType.

", + "smithy.api#httpQuery": "iamArn" } } } @@ -4737,19 +4862,19 @@ "com.amazonaws.iotsitewise#ListAssetModelsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" + } + }, "nextToken": { "target": "com.amazonaws.iotsitewise#NextToken", "traits": { "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", "smithy.api#httpQuery": "nextToken" } - }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" - } } } }, @@ -4794,7 +4919,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a paginated list of asset summaries.

\n

You can use this operation to do the following:

\n \n

You can't use this operation to list all assets. To retrieve summaries for all of your\n assets, use ListAssetModels to get\n all of your asset model IDs. Then, use ListAssets to get all assets for each asset\n model.

", + "smithy.api#documentation": "

Retrieves a paginated list of asset summaries.

\n

You can use this operation to do the following:

\n \n

You can't use this operation to list all assets. To retrieve summaries for all of your\n assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all\n assets for each asset model.

", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -4828,17 +4953,17 @@ "com.amazonaws.iotsitewise#ListAssetsRequest": { "type": "structure", "members": { - "assetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", "traits": { - "smithy.api#documentation": "

The ID of the asset model by which to filter the list of assets. This parameter is\n required if you choose ALL for filter.

", - "smithy.api#httpQuery": "assetModelId" + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" } }, "filter": { "target": "com.amazonaws.iotsitewise#ListAssetsFilter", "traits": { - "smithy.api#documentation": "

The filter for the requested list of assets. Choose one of the following options. Defaults\n to ALL.

\n ", + "smithy.api#documentation": "

The filter for the requested list of assets. Choose one of the following options:

\n \n

Default: ALL\n

", "smithy.api#httpQuery": "filter" } }, @@ -4849,11 +4974,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ID of the asset model by which to filter the list of assets. This parameter is\n required if you choose ALL for filter.

", + "smithy.api#httpQuery": "assetModelId" } } } @@ -4899,7 +5024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a paginated list of the assets associated to a parent asset\n (assetId) by a given hierarchy (hierarchyId).

", + "smithy.api#documentation": "

Retrieves a paginated list of associated assets.

\n

You can use this operation to do the following:

\n ", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -4921,24 +5046,23 @@ "assetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the parent asset.

", + "smithy.api#documentation": "

The ID of the asset to query.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", + "hierarchyId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ID of the hierarchy by which child assets are associated to the asset. To find a\n hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This\n parameter is required if you choose CHILD for\n traversalDirection.

\n

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

", + "smithy.api#httpQuery": "hierarchyId" } }, - "hierarchyId": { - "target": "com.amazonaws.iotsitewise#ID", + "traversalDirection": { + "target": "com.amazonaws.iotsitewise#TraversalDirection", "traits": { - "smithy.api#documentation": "

The hierarchy ID (of the parent asset model) whose associated assets are returned. To find\n a hierarchy ID, use the DescribeAsset\n or DescribeAssetModel\n actions.

\n

For more information, see Asset Hierarchies in the AWS IoT SiteWise User Guide.

", - "smithy.api#httpQuery": "hierarchyId", - "smithy.api#required": {} + "smithy.api#documentation": "

The direction to list associated assets. Choose one of the following options:

\n \n

Default: CHILD\n

", + "smithy.api#httpQuery": "traversalDirection" } }, "nextToken": { @@ -4947,24 +5071,31 @@ "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.iotsitewise#ListAssociatedAssetsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotsitewise#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" - } - }, "assetSummaries": { "target": "com.amazonaws.iotsitewise#AssociatedAssetsSummaries", "traits": { "smithy.api#documentation": "

A list that summarizes the associated assets.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } } } }, @@ -5007,6 +5138,13 @@ "com.amazonaws.iotsitewise#ListDashboardsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + }, "projectId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -5018,16 +5156,9 @@ "maxResults": { "target": "com.amazonaws.iotsitewise#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", "smithy.api#httpQuery": "maxResults" } - }, - "nextToken": { - "target": "com.amazonaws.iotsitewise#NextToken", - "traits": { - "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", - "smithy.api#httpQuery": "nextToken" - } } } }, @@ -5088,37 +5219,37 @@ "com.amazonaws.iotsitewise#ListGatewaysRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" + } + }, "nextToken": { "target": "com.amazonaws.iotsitewise#NextToken", "traits": { "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", "smithy.api#httpQuery": "nextToken" } - }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" - } } } }, "com.amazonaws.iotsitewise#ListGatewaysResponse": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } + }, "gatewaySummaries": { "target": "com.amazonaws.iotsitewise#GatewaySummaries", "traits": { "smithy.api#documentation": "

A list that summarizes each gateway.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.iotsitewise#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" - } } } }, @@ -5161,19 +5292,19 @@ "com.amazonaws.iotsitewise#ListPortalsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.iotsitewise#NextToken", "traits": { "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -5233,10 +5364,17 @@ "com.amazonaws.iotsitewise#ListProjectAssetsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + }, "maxResults": { "target": "com.amazonaws.iotsitewise#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", "smithy.api#httpQuery": "maxResults" } }, @@ -5247,31 +5385,24 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.iotsitewise#NextToken", - "traits": { - "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", - "smithy.api#httpQuery": "nextToken" - } } } }, "com.amazonaws.iotsitewise#ListProjectAssetsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotsitewise#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" - } - }, "assetIds": { "target": "com.amazonaws.iotsitewise#AssetIDs", "traits": { "smithy.api#documentation": "

A list that contains the IDs of each asset associated with the project.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } } } }, @@ -5314,12 +5445,11 @@ "com.amazonaws.iotsitewise#ListProjectsRequest": { "type": "structure", "members": { - "portalId": { - "target": "com.amazonaws.iotsitewise#ID", + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", "traits": { - "smithy.api#documentation": "

The ID of the portal.

", - "smithy.api#httpQuery": "portalId", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" } }, "nextToken": { @@ -5329,11 +5459,12 @@ "smithy.api#httpQuery": "nextToken" } }, - "maxResults": { - "target": "com.amazonaws.iotsitewise#MaxResults", + "portalId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ID of the portal.

", + "smithy.api#httpQuery": "portalId", + "smithy.api#required": {} } } } @@ -5406,7 +5537,7 @@ "tags": { "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

The list of key-value pairs that contain metadata for the resource. For more information,\n see Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The list of key-value pairs that contain metadata for the resource. For more information,\n see Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

" } } } @@ -5475,6 +5606,13 @@ "com.amazonaws.iotsitewise#Metric": { "type": "structure", "members": { + "expression": { + "target": "com.amazonaws.iotsitewise#Expression", + "traits": { + "smithy.api#documentation": "

The mathematical expression that defines the metric aggregation function. You can specify\n up to 10 variables per expression. You can specify up to 10 functions\n per expression.

\n

For more information, see Quotas in the AWS IoT SiteWise User Guide.

", + "smithy.api#required": {} + } + }, "window": { "target": "com.amazonaws.iotsitewise#MetricWindow", "traits": { @@ -5488,13 +5626,6 @@ "smithy.api#documentation": "

The list of variables used in the expression.

", "smithy.api#required": {} } - }, - "expression": { - "target": "com.amazonaws.iotsitewise#Expression", - "traits": { - "smithy.api#documentation": "

The mathematical expression that defines the metric aggregation function. You can specify\n up to 10 variables per expression. You can specify up to 10 functions\n per expression.

\n

For more information, see Quotas in the\n AWS IoT SiteWise User Guide.

", - "smithy.api#required": {} - } } }, "traits": { @@ -5522,6 +5653,14 @@ { "value": "INTERNAL_FAILURE", "name": "INTERNAL_FAILURE" + }, + { + "value": "VALIDATION_ERROR", + "name": "VALIDATION_ERROR" + }, + { + "value": "LIMIT_EXCEEDED", + "name": "LIMIT_EXCEEDED" } ] } @@ -5529,17 +5668,17 @@ "com.amazonaws.iotsitewise#MonitorErrorDetails": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.iotsitewise#MonitorErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, "code": { "target": "com.amazonaws.iotsitewise#MonitorErrorCode", "traits": { "smithy.api#documentation": "

The error code.

" } + }, + "message": { + "target": "com.amazonaws.iotsitewise#MonitorErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message.

" + } } }, "traits": { @@ -5649,18 +5788,18 @@ "com.amazonaws.iotsitewise#PortalStatus": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.iotsitewise#MonitorErrorDetails", - "traits": { - "smithy.api#documentation": "

Contains associated error information, if any.

" - } - }, "state": { "target": "com.amazonaws.iotsitewise#PortalState", "traits": { "smithy.api#documentation": "

The current state of the portal.

", "smithy.api#required": {} } + }, + "error": { + "target": "com.amazonaws.iotsitewise#MonitorErrorDetails", + "traits": { + "smithy.api#documentation": "

Contains associated error information, if any.

" + } } }, "traits": { @@ -5676,49 +5815,55 @@ "com.amazonaws.iotsitewise#PortalSummary": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

The name of the portal.

", + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.iotsitewise#Description", "traits": { "smithy.api#documentation": "

The portal's description.

" } }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "id": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The date the portal was last updated, in Unix epoch time.

" + "smithy.api#documentation": "

The ID of the portal.

", + "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.iotsitewise#ARN", + "creationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise\n resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the\n AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The date the portal was created, in Unix epoch time.

" } }, - "startUrl": { - "target": "com.amazonaws.iotsitewise#Url", + "status": { + "target": "com.amazonaws.iotsitewise#PortalStatus", "traits": { - "smithy.api#documentation": "

The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the portal.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The date the portal was last updated, in Unix epoch time.

" } }, - "id": { - "target": "com.amazonaws.iotsitewise#ID", + "startUrl": { + "target": "com.amazonaws.iotsitewise#Url", "traits": { - "smithy.api#documentation": "

The ID of the portal.

", + "smithy.api#documentation": "

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that\n use AWS SSO for authentication. For portals that use IAM for authentication, you must use the \n CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

", "smithy.api#required": {} } }, - "creationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "roleArn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

The date the portal was created, in Unix epoch time.

" + "smithy.api#documentation": "

The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise\n resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the\n AWS IoT SiteWise User Guide.

" } } }, @@ -5750,16 +5895,11 @@ "com.amazonaws.iotsitewise#ProjectSummary": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.iotsitewise#Description", - "traits": { - "smithy.api#documentation": "

The project's description.

" - } - }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "name": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The date the project was last updated, in Unix epoch time.

" + "smithy.api#documentation": "

The name of the project.

", + "smithy.api#required": {} } }, "id": { @@ -5769,17 +5909,22 @@ "smithy.api#required": {} } }, + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the project was last updated, in Unix epoch time.

" + } + }, "creationDate": { "target": "com.amazonaws.iotsitewise#Timestamp", "traits": { "smithy.api#documentation": "

The date the project was created, in Unix epoch time.

" } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "description": { + "target": "com.amazonaws.iotsitewise#Description", "traits": { - "smithy.api#documentation": "

The name of the project.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The project's description.

" } } }, @@ -5790,23 +5935,17 @@ "com.amazonaws.iotsitewise#Property": { "type": "structure", "members": { - "alias": { - "target": "com.amazonaws.iotsitewise#PropertyAlias", - "traits": { - "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping Industrial Data Streams to Asset Properties in the\n AWS IoT SiteWise User Guide.

" - } - }, - "dataType": { - "target": "com.amazonaws.iotsitewise#PropertyDataType", + "id": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The property data type.

", + "smithy.api#documentation": "

The ID of the asset property.

", "smithy.api#required": {} } }, - "notification": { - "target": "com.amazonaws.iotsitewise#PropertyNotification", + "alias": { + "target": "com.amazonaws.iotsitewise#PropertyAlias", "traits": { - "smithy.api#documentation": "

The asset property's notification topic and state. For more information, see UpdateAssetProperty\n

" + "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n AWS IoT SiteWise User Guide.

" } }, "unit": { @@ -5815,17 +5954,17 @@ "smithy.api#documentation": "

The unit (such as Newtons or RPM) of the asset property.

" } }, - "id": { - "target": "com.amazonaws.iotsitewise#ID", + "dataType": { + "target": "com.amazonaws.iotsitewise#PropertyDataType", "traits": { - "smithy.api#documentation": "

The ID of the asset property.

", + "smithy.api#documentation": "

The property data type.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.iotsitewise#PropertyType", + "notification": { + "target": "com.amazonaws.iotsitewise#PropertyNotification", "traits": { - "smithy.api#documentation": "

The property type (see PropertyType). A property contains one type.

" + "smithy.api#documentation": "

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

" } }, "name": { @@ -5834,6 +5973,12 @@ "smithy.api#documentation": "

The name of the property.

", "smithy.api#required": {} } + }, + "type": { + "target": "com.amazonaws.iotsitewise#PropertyType", + "traits": { + "smithy.api#documentation": "

The property type (see PropertyType). A property contains one type.

" + } } }, "traits": { @@ -5844,8 +5989,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 2048 + "min": 1 }, "smithy.api#pattern": "[^\\u0000-\\u001F\\u007F]+" } @@ -5876,23 +6020,23 @@ "com.amazonaws.iotsitewise#PropertyNotification": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.iotsitewise#PropertyNotificationState", + "topic": { + "target": "com.amazonaws.iotsitewise#PropertyNotificationTopic", "traits": { - "smithy.api#documentation": "

The current notification state.

", + "smithy.api#documentation": "

The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

", "smithy.api#required": {} } }, - "topic": { - "target": "com.amazonaws.iotsitewise#PropertyNotificationTopic", + "state": { + "target": "com.amazonaws.iotsitewise#PropertyNotificationState", "traits": { - "smithy.api#documentation": "

The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

", + "smithy.api#documentation": "

The current notification state.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains asset property value notification information. When the notification state is enabled, AWS IoT SiteWise publishes property value\n updates to a unique MQTT topic. For more information, see Interacting with Other Services in the AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

Contains asset property value notification information. When the notification state is enabled, AWS IoT SiteWise publishes property value\n updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.

" } }, "com.amazonaws.iotsitewise#PropertyNotificationState": { @@ -5914,20 +6058,20 @@ "type": "string" }, "com.amazonaws.iotsitewise#PropertyType": { - "type": "structure", - "members": { - "measurement": { - "target": "com.amazonaws.iotsitewise#Measurement", - "traits": { - "smithy.api#documentation": "

Specifies an asset measurement property. A measurement represents a device's raw sensor\n data stream, such as timestamped temperature values or timestamped power values.

" - } - }, + "type": "structure", + "members": { "metric": { "target": "com.amazonaws.iotsitewise#Metric", "traits": { "smithy.api#documentation": "

Specifies an asset metric property. A metric contains a mathematical expression that uses\n aggregate functions to process all input data points over a time interval and output a single\n data point, such as to calculate the average hourly temperature.

" } }, + "measurement": { + "target": "com.amazonaws.iotsitewise#Measurement", + "traits": { + "smithy.api#documentation": "

Specifies an asset measurement property. A measurement represents a device's raw sensor\n data stream, such as timestamped temperature values or timestamped power values.

" + } + }, "attribute": { "target": "com.amazonaws.iotsitewise#Attribute", "traits": { @@ -5992,18 +6136,6 @@ "com.amazonaws.iotsitewise#PutAssetPropertyValueEntry": { "type": "structure", "members": { - "propertyId": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the asset property for this entry.

" - } - }, - "propertyAlias": { - "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", - "traits": { - "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping Industrial Data Streams to Asset Properties in the\n AWS IoT SiteWise User Guide.

" - } - }, "propertyValues": { "target": "com.amazonaws.iotsitewise#AssetPropertyValues", "traits": { @@ -6023,10 +6155,22 @@ "traits": { "smithy.api#documentation": "

The ID of the asset to update.

" } + }, + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "traits": { + "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n AWS IoT SiteWise User Guide.

" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property for this entry.

" + } } }, "traits": { - "smithy.api#documentation": "

Contains a list of value updates for an asset property in the list of asset entries\n consumed by the BatchPutAssetPropertyValue API.

" + "smithy.api#documentation": "

Contains a list of value updates for an asset property in the list of asset entries\n consumed by the BatchPutAssetPropertyValue API\n operation.

" } }, "com.amazonaws.iotsitewise#PutLoggingOptions": { @@ -6146,6 +6290,12 @@ "com.amazonaws.iotsitewise#ResourceAlreadyExistsException": { "type": "structure", "members": { + "message": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, "resourceId": { "target": "com.amazonaws.iotsitewise#ResourceId", "traits": { @@ -6159,12 +6309,6 @@ "smithy.api#documentation": "

The ARN of the resource that already exists.

", "smithy.api#required": {} } - }, - "message": { - "target": "com.amazonaws.iotsitewise#ErrorMessage", - "traits": { - "smithy.api#required": {} - } } }, "traits": { @@ -6236,6 +6380,15 @@ "smithy.api#httpError": 503 } }, + "com.amazonaws.iotsitewise#SessionDurationSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 900, + "max": 43200 + } + } + }, "com.amazonaws.iotsitewise#TagKey": { "type": "string", "traits": { @@ -6309,18 +6462,18 @@ "com.amazonaws.iotsitewise#TagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.iotsitewise#AmazonResourceName", + "tags": { + "target": "com.amazonaws.iotsitewise#TagMap", "traits": { - "smithy.api#documentation": "

The ARN of the resource to tag.

", - "smithy.api#httpQuery": "resourceArn", + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more information,\n see Tagging your AWS IoT SiteWise\n resources in the AWS IoT SiteWise User Guide.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.iotsitewise#TagMap", + "resourceArn": { + "target": "com.amazonaws.iotsitewise#AmazonResourceName", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more information,\n see Tagging your AWS IoT SiteWise resources in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The ARN of the resource to tag.

", + "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } } @@ -6424,7 +6577,7 @@ } }, "traits": { - "smithy.api#documentation": "

You've reached the limit for the number of tags allowed for a resource. For more\n information, see Tag naming limits\n and requirements in the AWS General Reference.

", + "smithy.api#documentation": "

You've reached the limit for the number of tags allowed for a resource. For more\n information, see Tag naming limits and\n requirements in the AWS General Reference.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6435,7 +6588,7 @@ "expression": { "target": "com.amazonaws.iotsitewise#Expression", "traits": { - "smithy.api#documentation": "

The mathematical expression that defines the transformation function. You can specify up\n to 10 variables per expression. You can specify up to 10 functions per\n expression.

\n

For more information, see Quotas in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The mathematical expression that defines the transformation function. You can specify up\n to 10 variables per expression. You can specify up to 10 functions per\n expression.

\n

For more information, see Quotas in the AWS IoT SiteWise User Guide.

", "smithy.api#required": {} } }, @@ -6451,6 +6604,21 @@ "smithy.api#documentation": "

Contains an asset transform property. A transform is a one-to-one mapping of a property's\n data points from one form to another. For example, you can use a transform to convert a\n Celsius data stream to Fahrenheit by applying the transformation expression to each data point\n of the Celsius stream. A transform can only have a data type of DOUBLE and\n consume properties with data types of INTEGER or DOUBLE.

\n

For more information, see Transforms in the AWS IoT SiteWise User Guide.

" } }, + "com.amazonaws.iotsitewise#TraversalDirection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PARENT", + "name": "PARENT" + }, + { + "value": "CHILD", + "name": "CHILD" + } + ] + } + }, "com.amazonaws.iotsitewise#TumblingWindow": { "type": "structure", "members": { @@ -6500,14 +6668,6 @@ "com.amazonaws.iotsitewise#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.iotsitewise#TagKeyList", - "traits": { - "smithy.api#documentation": "

A list of keys for tags to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.iotsitewise#AmazonResourceName", "traits": { @@ -6515,6 +6675,14 @@ "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } + }, + "tagKeys": { + "target": "com.amazonaws.iotsitewise#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of keys for tags to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -6545,7 +6713,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing access policy that specifies an AWS SSO user or group's access to an\n AWS IoT SiteWise Monitor portal or project resource.

", + "smithy.api#documentation": "

Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor\n portal or project resource.

", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -6559,6 +6727,13 @@ "com.amazonaws.iotsitewise#UpdateAccessPolicyRequest": { "type": "structure", "members": { + "accessPolicyResource": { + "target": "com.amazonaws.iotsitewise#Resource", + "traits": { + "smithy.api#documentation": "

The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

", + "smithy.api#required": {} + } + }, "accessPolicyPermission": { "target": "com.amazonaws.iotsitewise#Permission", "traits": { @@ -6581,17 +6756,10 @@ "smithy.api#required": {} } }, - "accessPolicyResource": { - "target": "com.amazonaws.iotsitewise#Resource", - "traits": { - "smithy.api#documentation": "

The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.

", - "smithy.api#required": {} - } - }, "accessPolicyIdentity": { "target": "com.amazonaws.iotsitewise#Identity", "traits": { - "smithy.api#documentation": "

The identity for this access policy. Choose either a user or a group but not both.

", + "smithy.api#documentation": "

The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

", "smithy.api#required": {} } } @@ -6630,7 +6798,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an asset's name. For more information, see Updating Assets and Models in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

Updates an asset's name. For more information, see Updating assets and models in the\n AWS IoT SiteWise User Guide.

", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -6673,7 +6841,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an asset model and all of the assets that were created from the model. Each asset\n created from the model inherits the updated asset model's property and hierarchy definitions.\n For more information, see Updating\n Assets and Models in the AWS IoT SiteWise User Guide.

\n \n

This operation overwrites the existing model with the provided model. To avoid deleting\n your asset model's properties or hierarchies, you must include their IDs and definitions in\n the updated asset model payload. For more information, see DescribeAssetModel.

\n

If you remove a property from an asset model or update a property's formula expression,\n AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from\n an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't\n change the type or data type of an existing property.

\n ", + "smithy.api#documentation": "

Updates an asset model and all of the assets that were created from the model. Each asset\n created from the model inherits the updated asset model's property and hierarchy definitions.\n For more information, see Updating assets and models in the\n AWS IoT SiteWise User Guide.

\n \n

This operation overwrites the existing model with the provided model. To avoid deleting\n your asset model's properties or hierarchies, you must include their IDs and definitions in\n the updated asset model payload. For more information, see DescribeAssetModel.

\n

If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that\n property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every\n asset associated with that hierarchy. You can't change the type or data type of an existing\n property.

\n ", "smithy.api#endpoint": { "hostPrefix": "model." }, @@ -6687,19 +6855,16 @@ "com.amazonaws.iotsitewise#UpdateAssetModelRequest": { "type": "structure", "members": { - "assetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "assetModelProperties": { + "target": "com.amazonaws.iotsitewise#AssetModelProperties", "traits": { - "smithy.api#documentation": "

The ID of the asset model to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The updated property definitions of the asset model. For more information, see\n Asset properties in the AWS IoT SiteWise User Guide.

\n

You can specify up to 200 properties per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" } }, - "assetModelName": { - "target": "com.amazonaws.iotsitewise#Name", + "assetModelDescription": { + "target": "com.amazonaws.iotsitewise#Description", "traits": { - "smithy.api#documentation": "

A unique, friendly name for the asset model.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the asset model.

" } }, "clientToken": { @@ -6709,22 +6874,25 @@ "smithy.api#idempotencyToken": {} } }, - "assetModelDescription": { - "target": "com.amazonaws.iotsitewise#Description", + "assetModelHierarchies": { + "target": "com.amazonaws.iotsitewise#AssetModelHierarchies", "traits": { - "smithy.api#documentation": "

A description for the asset model.

" + "smithy.api#documentation": "

The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset\n model whose assets can be children of any other assets created from this asset model. For more\n information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

\n

You can specify up to 10 hierarchies per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" } }, - "assetModelProperties": { - "target": "com.amazonaws.iotsitewise#AssetModelProperties", + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The updated property definitions of the asset model. For more information, see\n Asset Properties in the AWS IoT SiteWise User Guide.

\n

You can specify up to 200 properties per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The ID of the asset model to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "assetModelHierarchies": { - "target": "com.amazonaws.iotsitewise#AssetModelHierarchies", + "assetModelName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset\n model whose assets can be children of any other assets created from this asset model. For more\n information, see Asset Hierarchies in the AWS IoT SiteWise User Guide.

\n

You can specify up to 10 hierarchies per asset model. For more\n information, see Quotas in the AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

A unique, friendly name for the asset model.

", + "smithy.api#required": {} } } } @@ -6778,17 +6946,10 @@ "com.amazonaws.iotsitewise#UpdateAssetPropertyRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} - } - }, "propertyAlias": { "target": "com.amazonaws.iotsitewise#PropertyAlias", "traits": { - "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping Industrial Data Streams to Asset Properties in the\n AWS IoT SiteWise User Guide.

\n

If you omit this parameter, the alias is removed from the property.

" + "smithy.api#documentation": "

The property alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n AWS IoT SiteWise User Guide.

\n

If you omit this parameter, the alias is removed from the property.

" } }, "propertyId": { @@ -6807,10 +6968,17 @@ "smithy.api#required": {} } }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + }, "propertyNotificationState": { "target": "com.amazonaws.iotsitewise#PropertyNotificationState", "traits": { - "smithy.api#documentation": "

The MQTT notification state (enabled or disabled) for this asset property.\n When the notification state is enabled, AWS IoT SiteWise publishes property value\n updates to a unique MQTT topic. For more information, see Interacting with Other Services in the AWS IoT SiteWise User Guide.

\n

If you omit this parameter, the notification state is set to DISABLED.

" + "smithy.api#documentation": "

The MQTT notification state (enabled or disabled) for this asset property.\n When the notification state is enabled, AWS IoT SiteWise publishes property value\n updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.

\n

If you omit this parameter, the notification state is set to DISABLED.

" } } } @@ -6818,13 +6986,6 @@ "com.amazonaws.iotsitewise#UpdateAssetRequest": { "type": "structure", "members": { - "assetName": { - "target": "com.amazonaws.iotsitewise#Name", - "traits": { - "smithy.api#documentation": "

A unique, friendly name for the asset.

", - "smithy.api#required": {} - } - }, "assetId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -6833,6 +6994,13 @@ "smithy.api#required": {} } }, + "assetName": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

A unique, friendly name for the asset.

", + "smithy.api#required": {} + } + }, "clientToken": { "target": "com.amazonaws.iotsitewise#ClientToken", "traits": { @@ -6891,18 +7059,17 @@ "com.amazonaws.iotsitewise#UpdateDashboardRequest": { "type": "structure", "members": { - "dashboardName": { - "target": "com.amazonaws.iotsitewise#Name", + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", "traits": { - "smithy.api#documentation": "

A new friendly name for the dashboard.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} } }, - "dashboardId": { - "target": "com.amazonaws.iotsitewise#ID", + "dashboardDefinition": { + "target": "com.amazonaws.iotsitewise#DashboardDefinition", "traits": { - "smithy.api#documentation": "

The ID of the dashboard to update.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The new dashboard definition, as specified in a JSON literal. For detailed information,\n see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

", "smithy.api#required": {} } }, @@ -6912,18 +7079,19 @@ "smithy.api#documentation": "

A new description for the dashboard.

" } }, - "dashboardDefinition": { - "target": "com.amazonaws.iotsitewise#DashboardDefinition", + "dashboardId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The new dashboard definition, as specified in a JSON literal. For detailed information,\n see Creating Dashboards (CLI) in the AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

The ID of the dashboard to update.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "dashboardName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

A new friendly name for the dashboard.

", + "smithy.api#required": {} } } } @@ -7036,17 +7204,17 @@ "com.amazonaws.iotsitewise#UpdateGatewayCapabilityConfigurationResponse": { "type": "structure", "members": { - "capabilitySyncStatus": { - "target": "com.amazonaws.iotsitewise#CapabilitySyncStatus", + "capabilityNamespace": { + "target": "com.amazonaws.iotsitewise#CapabilityNamespace", "traits": { - "smithy.api#documentation": "

The synchronization status of the capability configuration. The sync status can be one of the following:

\n \n

After you update a capability configuration, its sync status is\n OUT_OF_SYNC until the gateway receives and applies or rejects the updated\n configuration.

", + "smithy.api#documentation": "

The namespace of the gateway capability.

", "smithy.api#required": {} } }, - "capabilityNamespace": { - "target": "com.amazonaws.iotsitewise#CapabilityNamespace", + "capabilitySyncStatus": { + "target": "com.amazonaws.iotsitewise#CapabilitySyncStatus", "traits": { - "smithy.api#documentation": "

The namespace of the gateway capability.

", + "smithy.api#documentation": "

The synchronization status of the capability configuration. The sync status can be one of the following:

\n \n

After you update a capability configuration, its sync status is\n OUT_OF_SYNC until the gateway receives and applies or rejects the updated\n configuration.

", "smithy.api#required": {} } } @@ -7112,27 +7280,17 @@ "com.amazonaws.iotsitewise#UpdatePortalRequest": { "type": "structure", "members": { - "portalName": { - "target": "com.amazonaws.iotsitewise#Name", - "traits": { - "smithy.api#documentation": "

A new friendly name for the portal.

", - "smithy.api#required": {} - } - }, "portalDescription": { "target": "com.amazonaws.iotsitewise#Description", "traits": { "smithy.api#documentation": "

A new description for the portal.

" } }, - "portalLogoImage": { - "target": "com.amazonaws.iotsitewise#Image" - }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "roleArn": { + "target": "com.amazonaws.iotsitewise#ARN", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise\n resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#required": {} } }, "portalId": { @@ -7143,6 +7301,16 @@ "smithy.api#required": {} } }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + }, + "portalLogoImage": { + "target": "com.amazonaws.iotsitewise#Image" + }, "portalContactEmail": { "target": "com.amazonaws.iotsitewise#Email", "traits": { @@ -7150,10 +7318,10 @@ "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.iotsitewise#ARN", + "portalName": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise\n resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the\n AWS IoT SiteWise User Guide.

", + "smithy.api#documentation": "

A new friendly name for the portal.

", "smithy.api#required": {} } } @@ -7208,12 +7376,6 @@ "com.amazonaws.iotsitewise#UpdateProjectRequest": { "type": "structure", "members": { - "projectDescription": { - "target": "com.amazonaws.iotsitewise#Description", - "traits": { - "smithy.api#documentation": "

A new description for the project.

" - } - }, "projectName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { @@ -7221,6 +7383,12 @@ "smithy.api#required": {} } }, + "projectDescription": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A new description for the project.

" + } + }, "projectId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { @@ -7290,7 +7458,7 @@ "hierarchyId": { "target": "com.amazonaws.iotsitewise#Macro", "traits": { - "smithy.api#documentation": "

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name\n instead of the hierarchy's ID.

\n

You use a hierarchy ID instead of a model ID because you can have several hierarchies\n using the same model and therefore the same propertyId. For example, you might\n have separately grouped assets that come from the same asset model. For more information, see\n Asset Hierarchies in the AWS IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name\n instead of the hierarchy's ID.

\n

You use a hierarchy ID instead of a model ID because you can have several hierarchies\n using the same model and therefore the same propertyId. For example, you might\n have separately grouped assets that come from the same asset model. For more information, see\n Asset hierarchies in the AWS IoT SiteWise User Guide.

" } } }, @@ -7307,12 +7475,6 @@ "smithy.api#documentation": "

Asset property data of type string (sequence of characters).

" } }, - "booleanValue": { - "target": "com.amazonaws.iotsitewise#PropertyValueBooleanValue", - "traits": { - "smithy.api#documentation": "

Asset property data of type Boolean (true or false).

" - } - }, "integerValue": { "target": "com.amazonaws.iotsitewise#PropertyValueIntegerValue", "traits": { @@ -7324,6 +7486,12 @@ "traits": { "smithy.api#documentation": "

Asset property data of type double (floating point number).

" } + }, + "booleanValue": { + "target": "com.amazonaws.iotsitewise#PropertyValueBooleanValue", + "traits": { + "smithy.api#documentation": "

Asset property data of type Boolean (true or false).

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/iotthingsgraph.2018-09-06.json b/codegen/sdk-codegen/aws-models/iotthingsgraph.2018-09-06.json index bbc2fe442d6a..02864be804d6 100644 --- a/codegen/sdk-codegen/aws-models/iotthingsgraph.2018-09-06.json +++ b/codegen/sdk-codegen/aws-models/iotthingsgraph.2018-09-06.json @@ -177,15 +177,6 @@ "com.amazonaws.iotthingsgraph#CreateSystemInstanceRequest": { "type": "structure", "members": { - "s3BucketName": { - "target": "com.amazonaws.iotthingsgraph#S3BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if \n the value of the target parameter is GREENGRASS.

" - } - }, - "metricsConfiguration": { - "target": "com.amazonaws.iotthingsgraph#MetricsConfiguration" - }, "greengrassGroupName": { "target": "com.amazonaws.iotthingsgraph#GroupName", "traits": { @@ -216,6 +207,15 @@ "traits": { "smithy.api#documentation": "

The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have \n read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This \n value is required if the value of the target parameter is CLOUD.

" } + }, + "metricsConfiguration": { + "target": "com.amazonaws.iotthingsgraph#MetricsConfiguration" + }, + "s3BucketName": { + "target": "com.amazonaws.iotthingsgraph#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if \n the value of the target parameter is GREENGRASS.

" + } } } }, @@ -259,18 +259,18 @@ "com.amazonaws.iotthingsgraph#CreateSystemTemplateRequest": { "type": "structure", "members": { + "compatibleNamespaceVersion": { + "target": "com.amazonaws.iotthingsgraph#Version", + "traits": { + "smithy.api#documentation": "

The namespace version in which the system is to be created.

\n

If no value is specified, the latest version is used by default.

" + } + }, "definition": { "target": "com.amazonaws.iotthingsgraph#DefinitionDocument", "traits": { "smithy.api#documentation": "

The DefinitionDocument used to create the system.

", "smithy.api#required": {} } - }, - "compatibleNamespaceVersion": { - "target": "com.amazonaws.iotthingsgraph#Version", - "traits": { - "smithy.api#documentation": "

The namespace version in which the system is to be created.

\n

If no value is specified, the latest version is used by default.

" - } } } }, @@ -288,17 +288,17 @@ "com.amazonaws.iotthingsgraph#DefinitionDocument": { "type": "structure", "members": { - "language": { - "target": "com.amazonaws.iotthingsgraph#DefinitionLanguage", + "text": { + "target": "com.amazonaws.iotthingsgraph#DefinitionText", "traits": { - "smithy.api#documentation": "

The language used to define the entity. GRAPHQL is the only valid value.

", + "smithy.api#documentation": "

The GraphQL text that defines the entity.

", "smithy.api#required": {} } }, - "text": { - "target": "com.amazonaws.iotthingsgraph#DefinitionText", + "language": { + "target": "com.amazonaws.iotthingsgraph#DefinitionLanguage", "traits": { - "smithy.api#documentation": "

The GraphQL text that defines the entity.

", + "smithy.api#documentation": "

The language used to define the entity. GRAPHQL is the only valid value.

", "smithy.api#required": {} } } @@ -725,22 +725,16 @@ "smithy.api#documentation": "

The version of the public namespace that the latest version is tracking.

" } }, - "trackingNamespaceName": { - "target": "com.amazonaws.iotthingsgraph#NamespaceName", - "traits": { - "smithy.api#documentation": "

The name of the public namespace that the latest namespace version is tracking.

" - } - }, "namespaceVersion": { "target": "com.amazonaws.iotthingsgraph#Version", "traits": { "smithy.api#documentation": "

The version of the user's namespace to describe.

" } }, - "namespaceName": { + "trackingNamespaceName": { "target": "com.amazonaws.iotthingsgraph#NamespaceName", "traits": { - "smithy.api#documentation": "

The name of the namespace.

" + "smithy.api#documentation": "

The name of the public namespace that the latest namespace version is tracking.

" } }, "namespaceArn": { @@ -748,6 +742,12 @@ "traits": { "smithy.api#documentation": "

The ARN of the namespace.

" } + }, + "namespaceName": { + "target": "com.amazonaws.iotthingsgraph#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

" + } } } }, @@ -806,18 +806,6 @@ "com.amazonaws.iotthingsgraph#EntityDescription": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.iotthingsgraph#Urn", - "traits": { - "smithy.api#documentation": "

The entity ID.

" - } - }, - "arn": { - "target": "com.amazonaws.iotthingsgraph#Arn", - "traits": { - "smithy.api#documentation": "

The entity ARN.

" - } - }, "createdAt": { "target": "com.amazonaws.iotthingsgraph#Timestamp", "traits": { @@ -835,6 +823,18 @@ "traits": { "smithy.api#documentation": "

The definition document of the entity.

" } + }, + "id": { + "target": "com.amazonaws.iotthingsgraph#Urn", + "traits": { + "smithy.api#documentation": "

The entity ID.

" + } + }, + "arn": { + "target": "com.amazonaws.iotthingsgraph#Arn", + "traits": { + "smithy.api#documentation": "

The entity ARN.

" + } } }, "traits": { @@ -850,17 +850,17 @@ "com.amazonaws.iotthingsgraph#EntityFilter": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotthingsgraph#EntityFilterValues", - "traits": { - "smithy.api#documentation": "

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" - } - }, "name": { "target": "com.amazonaws.iotthingsgraph#EntityFilterName", "traits": { "smithy.api#documentation": "

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, \n you can filter on the ID of a property that is used in a state.

" } + }, + "value": { + "target": "com.amazonaws.iotthingsgraph#EntityFilterValues", + "traits": { + "smithy.api#documentation": "

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" + } } }, "traits": { @@ -1048,12 +1048,6 @@ "com.amazonaws.iotthingsgraph#FlowExecutionMessage": { "type": "structure", "members": { - "eventType": { - "target": "com.amazonaws.iotthingsgraph#FlowExecutionEventType", - "traits": { - "smithy.api#documentation": "

The type of flow event .

" - } - }, "messageId": { "target": "com.amazonaws.iotthingsgraph#FlowExecutionMessageId", "traits": { @@ -1066,6 +1060,12 @@ "smithy.api#documentation": "

A string containing information about the flow event.

" } }, + "eventType": { + "target": "com.amazonaws.iotthingsgraph#FlowExecutionEventType", + "traits": { + "smithy.api#documentation": "

The type of flow event .

" + } + }, "timestamp": { "target": "com.amazonaws.iotthingsgraph#Timestamp", "traits": { @@ -1121,10 +1121,10 @@ "com.amazonaws.iotthingsgraph#FlowExecutionSummary": { "type": "structure", "members": { - "flowTemplateId": { - "target": "com.amazonaws.iotthingsgraph#Urn", + "createdAt": { + "target": "com.amazonaws.iotthingsgraph#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the flow.

" + "smithy.api#documentation": "

The date and time when the flow execution summary was created.

" } }, "updatedAt": { @@ -1133,12 +1133,6 @@ "smithy.api#documentation": "

The date and time when the flow execution summary was last updated.

" } }, - "createdAt": { - "target": "com.amazonaws.iotthingsgraph#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time when the flow execution summary was created.

" - } - }, "flowExecutionId": { "target": "com.amazonaws.iotthingsgraph#FlowExecutionId", "traits": { @@ -1156,6 +1150,12 @@ "traits": { "smithy.api#documentation": "

The current status of the flow execution.

" } + }, + "flowTemplateId": { + "target": "com.amazonaws.iotthingsgraph#Urn", + "traits": { + "smithy.api#documentation": "

The ID of the flow.

" + } } }, "traits": { @@ -1191,17 +1191,17 @@ "com.amazonaws.iotthingsgraph#FlowTemplateFilter": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotthingsgraph#FlowTemplateFilterValues", + "name": { + "target": "com.amazonaws.iotthingsgraph#FlowTemplateFilterName", "traits": { - "smithy.api#documentation": "

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

", + "smithy.api#documentation": "

The name of the search filter field.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotthingsgraph#FlowTemplateFilterName", + "value": { + "target": "com.amazonaws.iotthingsgraph#FlowTemplateFilterValues", "traits": { - "smithy.api#documentation": "

The name of the search filter field.

", + "smithy.api#documentation": "

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

", "smithy.api#required": {} } } @@ -1248,12 +1248,6 @@ "com.amazonaws.iotthingsgraph#FlowTemplateSummary": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.iotthingsgraph#Timestamp", - "traits": { - "smithy.api#documentation": "

The date when the workflow was created.

" - } - }, "revisionNumber": { "target": "com.amazonaws.iotthingsgraph#Version", "traits": { @@ -1271,6 +1265,12 @@ "traits": { "smithy.api#documentation": "

The ARN of the workflow.

" } + }, + "createdAt": { + "target": "com.amazonaws.iotthingsgraph#Timestamp", + "traits": { + "smithy.api#documentation": "

The date when the workflow was created.

" + } } }, "traits": { @@ -1306,18 +1306,18 @@ "com.amazonaws.iotthingsgraph#GetEntitiesRequest": { "type": "structure", "members": { - "namespaceVersion": { - "target": "com.amazonaws.iotthingsgraph#Version", - "traits": { - "smithy.api#documentation": "

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" - } - }, "ids": { "target": "com.amazonaws.iotthingsgraph#Urns", "traits": { "smithy.api#documentation": "

An array of entity IDs.

\n

The IDs should be in the following format.

\n

\n urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME\n

", "smithy.api#required": {} } + }, + "namespaceVersion": { + "target": "com.amazonaws.iotthingsgraph#Version", + "traits": { + "smithy.api#documentation": "

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" + } } } }, @@ -1446,17 +1446,17 @@ "com.amazonaws.iotthingsgraph#GetFlowTemplateRevisionsResponse": { "type": "structure", "members": { - "summaries": { - "target": "com.amazonaws.iotthingsgraph#FlowTemplateSummaries", - "traits": { - "smithy.api#documentation": "

An array of objects that provide summary data about each revision.

" - } - }, "nextToken": { "target": "com.amazonaws.iotthingsgraph#NextToken", "traits": { "smithy.api#documentation": "

The string to specify as nextToken when you request the next page of results.

" } + }, + "summaries": { + "target": "com.amazonaws.iotthingsgraph#FlowTemplateSummaries", + "traits": { + "smithy.api#documentation": "

An array of objects that provide summary data about each revision.

" + } } } }, @@ -1490,18 +1490,6 @@ "com.amazonaws.iotthingsgraph#GetNamespaceDeletionStatusResponse": { "type": "structure", "members": { - "namespaceName": { - "target": "com.amazonaws.iotthingsgraph#NamespaceName", - "traits": { - "smithy.api#documentation": "

The name of the namespace that is being deleted.

" - } - }, - "errorCode": { - "target": "com.amazonaws.iotthingsgraph#NamespaceDeletionStatusErrorCodes", - "traits": { - "smithy.api#documentation": "

An error code returned by the namespace deletion task.

" - } - }, "status": { "target": "com.amazonaws.iotthingsgraph#NamespaceDeletionStatus", "traits": { @@ -1514,6 +1502,18 @@ "smithy.api#documentation": "

The ARN of the namespace that is being deleted.

" } }, + "errorCode": { + "target": "com.amazonaws.iotthingsgraph#NamespaceDeletionStatusErrorCodes", + "traits": { + "smithy.api#documentation": "

An error code returned by the namespace deletion task.

" + } + }, + "namespaceName": { + "target": "com.amazonaws.iotthingsgraph#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace that is being deleted.

" + } + }, "errorMessage": { "target": "com.amazonaws.iotthingsgraph#String", "traits": { @@ -1600,18 +1600,18 @@ "com.amazonaws.iotthingsgraph#GetSystemTemplateRequest": { "type": "structure", "members": { - "revisionNumber": { - "target": "com.amazonaws.iotthingsgraph#Version", - "traits": { - "smithy.api#documentation": "

The number that specifies the revision of the system to get.

" - } - }, "id": { "target": "com.amazonaws.iotthingsgraph#Urn", "traits": { "smithy.api#documentation": "

The ID of the system to get. This ID must be in the user's namespace.

\n

The ID should be in the following format.

\n

\n urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME\n

", "smithy.api#required": {} } + }, + "revisionNumber": { + "target": "com.amazonaws.iotthingsgraph#Version", + "traits": { + "smithy.api#documentation": "

The number that specifies the revision of the system to get.

" + } } } }, @@ -1661,11 +1661,10 @@ "com.amazonaws.iotthingsgraph#GetSystemTemplateRevisionsRequest": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.iotthingsgraph#Urn", + "nextToken": { + "target": "com.amazonaws.iotthingsgraph#NextToken", "traits": { - "smithy.api#documentation": "

The ID of the system template.

\n

The ID should be in the following format.

\n

\n urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" } }, "maxResults": { @@ -1674,10 +1673,11 @@ "smithy.api#documentation": "

The maximum number of results to return in the response.

" } }, - "nextToken": { - "target": "com.amazonaws.iotthingsgraph#NextToken", + "id": { + "target": "com.amazonaws.iotthingsgraph#Urn", "traits": { - "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" + "smithy.api#documentation": "

The ID of the system template.

\n

The ID should be in the following format.

\n

\n urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME\n

", + "smithy.api#required": {} } } } @@ -1740,10 +1740,11 @@ "com.amazonaws.iotthingsgraph#GetUploadStatusResponse": { "type": "structure", "members": { - "namespaceArn": { - "target": "com.amazonaws.iotthingsgraph#Arn", + "uploadStatus": { + "target": "com.amazonaws.iotthingsgraph#UploadStatus", "traits": { - "smithy.api#documentation": "

The ARN of the upload.

" + "smithy.api#documentation": "

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

", + "smithy.api#required": {} } }, "failureReason": { @@ -1759,10 +1760,11 @@ "smithy.api#required": {} } }, - "namespaceName": { - "target": "com.amazonaws.iotthingsgraph#NamespaceName", + "createdDate": { + "target": "com.amazonaws.iotthingsgraph#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the upload's namespace.

" + "smithy.api#documentation": "

The date at which the upload was created.

", + "smithy.api#required": {} } }, "namespaceVersion": { @@ -1771,18 +1773,16 @@ "smithy.api#documentation": "

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" } }, - "uploadStatus": { - "target": "com.amazonaws.iotthingsgraph#UploadStatus", + "namespaceName": { + "target": "com.amazonaws.iotthingsgraph#NamespaceName", "traits": { - "smithy.api#documentation": "

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the upload's namespace.

" } }, - "createdDate": { - "target": "com.amazonaws.iotthingsgraph#Timestamp", + "namespaceArn": { + "target": "com.amazonaws.iotthingsgraph#Arn", "traits": { - "smithy.api#documentation": "

The date at which the upload was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of the upload.

" } } } @@ -1940,7 +1940,7 @@ "sdkId": "IoTThingsGraph", "arnNamespace": "iotthingsgraph", "cloudFormationName": "IoTThingsGraph", - "cloudTrailEventSource": "thingsgraph.iot.amazonaws.com" + "cloudTrailEventSource": "iotthingsgraph.amazonaws.com" }, "aws.auth#sigv4": { "name": "iotthingsgraph" @@ -2004,18 +2004,18 @@ "smithy.api#documentation": "

The maximum number of results to return in the response.

" } }, + "nextToken": { + "target": "com.amazonaws.iotthingsgraph#NextToken", + "traits": { + "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" + } + }, "flowExecutionId": { "target": "com.amazonaws.iotthingsgraph#FlowExecutionId", "traits": { "smithy.api#documentation": "

The ID of the flow execution.

", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.iotthingsgraph#NextToken", - "traits": { - "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" - } } } }, @@ -2122,17 +2122,17 @@ "com.amazonaws.iotthingsgraph#MetricsConfiguration": { "type": "structure", "members": { - "metricRuleRoleArn": { - "target": "com.amazonaws.iotthingsgraph#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of the role that is used to collect cloud metrics.

" - } - }, "cloudMetricEnabled": { "target": "com.amazonaws.iotthingsgraph#Enabled", "traits": { "smithy.api#documentation": "

A Boolean that specifies whether cloud metrics are collected.

" } + }, + "metricRuleRoleArn": { + "target": "com.amazonaws.iotthingsgraph#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the role that is used to collect cloud metrics.

" + } } }, "traits": { @@ -2273,10 +2273,10 @@ "com.amazonaws.iotthingsgraph#SearchEntitiesRequest": { "type": "structure", "members": { - "filters": { - "target": "com.amazonaws.iotthingsgraph#EntityFilters", + "nextToken": { + "target": "com.amazonaws.iotthingsgraph#NextToken", "traits": { - "smithy.api#documentation": "

Optional filter to apply to the search. Valid filters are NAME \n NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. \n REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, \n you can filter on the ID of a property that is used in a state.

\n

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

" + "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" } }, "entityTypes": { @@ -2286,10 +2286,10 @@ "smithy.api#required": {} } }, - "namespaceVersion": { - "target": "com.amazonaws.iotthingsgraph#Version", + "filters": { + "target": "com.amazonaws.iotthingsgraph#EntityFilters", "traits": { - "smithy.api#documentation": "

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" + "smithy.api#documentation": "

Optional filter to apply to the search. Valid filters are NAME \n NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. \n REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, \n you can filter on the ID of a property that is used in a state.

\n

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

" } }, "maxResults": { @@ -2298,10 +2298,10 @@ "smithy.api#documentation": "

The maximum number of results to return in the response.

" } }, - "nextToken": { - "target": "com.amazonaws.iotthingsgraph#NextToken", + "namespaceVersion": { + "target": "com.amazonaws.iotthingsgraph#Version", "traits": { - "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" + "smithy.api#documentation": "

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" } } } @@ -2364,10 +2364,10 @@ "smithy.api#documentation": "

The maximum number of results to return in the response.

" } }, - "startTime": { - "target": "com.amazonaws.iotthingsgraph#Timestamp", + "nextToken": { + "target": "com.amazonaws.iotthingsgraph#NextToken", "traits": { - "smithy.api#documentation": "

The date and time of the earliest flow execution to return.

" + "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" } }, "flowExecutionId": { @@ -2376,10 +2376,10 @@ "smithy.api#documentation": "

The ID of a flow execution.

" } }, - "nextToken": { - "target": "com.amazonaws.iotthingsgraph#NextToken", + "startTime": { + "target": "com.amazonaws.iotthingsgraph#Timestamp", "traits": { - "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" + "smithy.api#documentation": "

The date and time of the earliest flow execution to return.

" } }, "systemInstanceId": { @@ -2400,17 +2400,17 @@ "com.amazonaws.iotthingsgraph#SearchFlowExecutionsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotthingsgraph#NextToken", - "traits": { - "smithy.api#documentation": "

The string to specify as nextToken when you request the next page of results.

" - } - }, "summaries": { "target": "com.amazonaws.iotthingsgraph#FlowExecutionSummaries", "traits": { "smithy.api#documentation": "

An array of objects that contain summary information about each workflow execution in the result set.

" } + }, + "nextToken": { + "target": "com.amazonaws.iotthingsgraph#NextToken", + "traits": { + "smithy.api#documentation": "

The string to specify as nextToken when you request the next page of results.

" + } } } }, @@ -2452,17 +2452,17 @@ "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" } }, - "maxResults": { - "target": "com.amazonaws.iotthingsgraph#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" - } - }, "filters": { "target": "com.amazonaws.iotthingsgraph#FlowTemplateFilters", "traits": { "smithy.api#documentation": "

An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.

" } + }, + "maxResults": { + "target": "com.amazonaws.iotthingsgraph#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

" + } } } }, @@ -2538,17 +2538,17 @@ "com.amazonaws.iotthingsgraph#SearchSystemInstancesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotthingsgraph#NextToken", - "traits": { - "smithy.api#documentation": "

The string to specify as nextToken when you request the next page of results.

" - } - }, "summaries": { "target": "com.amazonaws.iotthingsgraph#SystemInstanceSummaries", "traits": { "smithy.api#documentation": "

An array of objects that contain summary data abour the system instances in the result set.

" } + }, + "nextToken": { + "target": "com.amazonaws.iotthingsgraph#NextToken", + "traits": { + "smithy.api#documentation": "

The string to specify as nextToken when you request the next page of results.

" + } } } }, @@ -2590,17 +2590,17 @@ "smithy.api#documentation": "

The string that specifies the next page of results. Use this when you're paginating results.

" } }, - "filters": { - "target": "com.amazonaws.iotthingsgraph#SystemTemplateFilters", - "traits": { - "smithy.api#documentation": "

An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

" - } - }, "maxResults": { "target": "com.amazonaws.iotthingsgraph#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in the response.

" } + }, + "filters": { + "target": "com.amazonaws.iotthingsgraph#SystemTemplateFilters", + "traits": { + "smithy.api#documentation": "

An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

" + } } } }, @@ -2656,6 +2656,12 @@ "com.amazonaws.iotthingsgraph#SearchThingsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.iotthingsgraph#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

" + } + }, "entityId": { "target": "com.amazonaws.iotthingsgraph#Urn", "traits": { @@ -2663,12 +2669,6 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.iotthingsgraph#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" - } - }, "nextToken": { "target": "com.amazonaws.iotthingsgraph#NextToken", "traits": { @@ -2686,17 +2686,17 @@ "com.amazonaws.iotthingsgraph#SearchThingsResponse": { "type": "structure", "members": { - "things": { - "target": "com.amazonaws.iotthingsgraph#Things", - "traits": { - "smithy.api#documentation": "

An array of things in the result set.

" - } - }, "nextToken": { "target": "com.amazonaws.iotthingsgraph#NextToken", "traits": { "smithy.api#documentation": "

The string to specify as nextToken when you request the next page of results.

" } + }, + "things": { + "target": "com.amazonaws.iotthingsgraph#Things", + "traits": { + "smithy.api#documentation": "

An array of things in the result set.

" + } } } }, @@ -2754,6 +2754,12 @@ "com.amazonaws.iotthingsgraph#SystemInstanceDescription": { "type": "structure", "members": { + "flowActionsRoleArn": { + "target": "com.amazonaws.iotthingsgraph#RoleArn", + "traits": { + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a \n cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other \n AWS services that the flow uses.

" + } + }, "validatedDependencyRevisions": { "target": "com.amazonaws.iotthingsgraph#DependencyRevisions", "traits": { @@ -2766,15 +2772,12 @@ "smithy.api#documentation": "

The Amazon Simple Storage Service bucket where information about a system instance is stored.

" } }, - "flowActionsRoleArn": { - "target": "com.amazonaws.iotthingsgraph#RoleArn", - "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a \n cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other \n AWS services that the flow uses.

" - } - }, "metricsConfiguration": { "target": "com.amazonaws.iotthingsgraph#MetricsConfiguration" }, + "definition": { + "target": "com.amazonaws.iotthingsgraph#DefinitionDocument" + }, "validatedNamespaceVersion": { "target": "com.amazonaws.iotthingsgraph#Version", "traits": { @@ -2786,9 +2789,6 @@ "traits": { "smithy.api#documentation": "

An object that contains summary information about a system instance.

" } - }, - "definition": { - "target": "com.amazonaws.iotthingsgraph#DefinitionDocument" } }, "traits": { @@ -2798,17 +2798,17 @@ "com.amazonaws.iotthingsgraph#SystemInstanceFilter": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotthingsgraph#SystemInstanceFilterValues", - "traits": { - "smithy.api#documentation": "

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" - } - }, "name": { "target": "com.amazonaws.iotthingsgraph#SystemInstanceFilterName", "traits": { "smithy.api#documentation": "

The name of the search filter field.

" } + }, + "value": { + "target": "com.amazonaws.iotthingsgraph#SystemInstanceFilterValues", + "traits": { + "smithy.api#documentation": "

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" + } } }, "traits": { @@ -2858,16 +2858,10 @@ "com.amazonaws.iotthingsgraph#SystemInstanceSummary": { "type": "structure", "members": { - "greengrassGroupId": { - "target": "com.amazonaws.iotthingsgraph#GreengrassGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the Greengrass group where the system instance is deployed.

" - } - }, - "createdAt": { - "target": "com.amazonaws.iotthingsgraph#Timestamp", + "target": { + "target": "com.amazonaws.iotthingsgraph#DeploymentTarget", "traits": { - "smithy.api#documentation": "

The date when the system instance was created.

" + "smithy.api#documentation": "

The target of the system instance.

" } }, "greengrassGroupVersionId": { @@ -2876,16 +2870,22 @@ "smithy.api#documentation": "

The version of the Greengrass group where the system instance is deployed.

" } }, - "arn": { - "target": "com.amazonaws.iotthingsgraph#Arn", + "createdAt": { + "target": "com.amazonaws.iotthingsgraph#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the system instance.

" + "smithy.api#documentation": "

The date when the system instance was created.

" } }, - "updatedAt": { - "target": "com.amazonaws.iotthingsgraph#Timestamp", + "id": { + "target": "com.amazonaws.iotthingsgraph#Urn", "traits": { - "smithy.api#documentation": "

\n \n The date and time when the system instance was last updated.

" + "smithy.api#documentation": "

The ID of the system instance.

" + } + }, + "greengrassGroupId": { + "target": "com.amazonaws.iotthingsgraph#GreengrassGroupId", + "traits": { + "smithy.api#documentation": "

The ID of the Greengrass group where the system instance is deployed.

" } }, "status": { @@ -2894,16 +2894,16 @@ "smithy.api#documentation": "

The status of the system instance.

" } }, - "id": { - "target": "com.amazonaws.iotthingsgraph#Urn", + "updatedAt": { + "target": "com.amazonaws.iotthingsgraph#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the system instance.

" + "smithy.api#documentation": "

\n \n The date and time when the system instance was last updated.

" } }, - "target": { - "target": "com.amazonaws.iotthingsgraph#DeploymentTarget", + "arn": { + "target": "com.amazonaws.iotthingsgraph#Arn", "traits": { - "smithy.api#documentation": "

The target of the system instance.

" + "smithy.api#documentation": "

The ARN of the system instance.

" } }, "greengrassGroupName": { @@ -2926,17 +2926,17 @@ "smithy.api#documentation": "

The namespace version against which the system was validated. Use this value in your system instance.

" } }, - "definition": { - "target": "com.amazonaws.iotthingsgraph#DefinitionDocument", - "traits": { - "smithy.api#documentation": "

The definition document of a system.

" - } - }, "summary": { "target": "com.amazonaws.iotthingsgraph#SystemTemplateSummary", "traits": { "smithy.api#documentation": "

An object that contains summary information about a system.

" } + }, + "definition": { + "target": "com.amazonaws.iotthingsgraph#DefinitionDocument", + "traits": { + "smithy.api#documentation": "

The definition document of a system.

" + } } }, "traits": { @@ -3003,12 +3003,6 @@ "com.amazonaws.iotthingsgraph#SystemTemplateSummary": { "type": "structure", "members": { - "revisionNumber": { - "target": "com.amazonaws.iotthingsgraph#Version", - "traits": { - "smithy.api#documentation": "

The revision number of the system.

" - } - }, "id": { "target": "com.amazonaws.iotthingsgraph#Urn", "traits": { @@ -3026,6 +3020,12 @@ "traits": { "smithy.api#documentation": "

The date when the system was created.

" } + }, + "revisionNumber": { + "target": "com.amazonaws.iotthingsgraph#Version", + "traits": { + "smithy.api#documentation": "

The revision number of the system.

" + } } }, "traits": { @@ -3035,17 +3035,17 @@ "com.amazonaws.iotthingsgraph#Tag": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotthingsgraph#TagValue", + "key": { + "target": "com.amazonaws.iotthingsgraph#TagKey", "traits": { - "smithy.api#documentation": "

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.

", + "smithy.api#documentation": "

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.

", "smithy.api#required": {} } }, - "key": { - "target": "com.amazonaws.iotthingsgraph#TagKey", + "value": { + "target": "com.amazonaws.iotthingsgraph#TagValue", "traits": { - "smithy.api#documentation": "

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.

", + "smithy.api#documentation": "

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.

", "smithy.api#required": {} } } @@ -3330,10 +3330,10 @@ "com.amazonaws.iotthingsgraph#UpdateFlowTemplateRequest": { "type": "structure", "members": { - "definition": { - "target": "com.amazonaws.iotthingsgraph#DefinitionDocument", + "id": { + "target": "com.amazonaws.iotthingsgraph#Urn", "traits": { - "smithy.api#documentation": "

The DefinitionDocument that contains the updated workflow definition.

", + "smithy.api#documentation": "

The ID of the workflow to be updated.

\n

The ID should be in the following format.

\n

\n urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME\n

", "smithy.api#required": {} } }, @@ -3343,10 +3343,10 @@ "smithy.api#documentation": "

The version of the user's namespace.

\n

If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow \n to update.

" } }, - "id": { - "target": "com.amazonaws.iotthingsgraph#Urn", + "definition": { + "target": "com.amazonaws.iotthingsgraph#DefinitionDocument", "traits": { - "smithy.api#documentation": "

The ID of the workflow to be updated.

\n

The ID should be in the following format.

\n

\n urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME\n

", + "smithy.api#documentation": "

The DefinitionDocument that contains the updated workflow definition.

", "smithy.api#required": {} } } @@ -3451,6 +3451,12 @@ "com.amazonaws.iotthingsgraph#UploadEntityDefinitionsRequest": { "type": "structure", "members": { + "syncWithPublicNamespace": { + "target": "com.amazonaws.iotthingsgraph#SyncWithPublicNamespace", + "traits": { + "smithy.api#documentation": "

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

" + } + }, "deprecateExistingEntities": { "target": "com.amazonaws.iotthingsgraph#DeprecateExistingEntities", "traits": { @@ -3462,12 +3468,6 @@ "traits": { "smithy.api#documentation": "

The DefinitionDocument that defines the updated entities.

" } - }, - "syncWithPublicNamespace": { - "target": "com.amazonaws.iotthingsgraph#SyncWithPublicNamespace", - "traits": { - "smithy.api#documentation": "

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

" - } } } }, diff --git a/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json b/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json index c301ddab0eae..2c23cf2a4e32 100644 --- a/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json +++ b/codegen/sdk-codegen/aws-models/ivs.2020-07-14.json @@ -63,21 +63,33 @@ { "target": "com.amazonaws.ivs#DeleteChannel" }, + { + "target": "com.amazonaws.ivs#DeletePlaybackKeyPair" + }, { "target": "com.amazonaws.ivs#DeleteStreamKey" }, { "target": "com.amazonaws.ivs#GetChannel" }, + { + "target": "com.amazonaws.ivs#GetPlaybackKeyPair" + }, { "target": "com.amazonaws.ivs#GetStream" }, { "target": "com.amazonaws.ivs#GetStreamKey" }, + { + "target": "com.amazonaws.ivs#ImportPlaybackKeyPair" + }, { "target": "com.amazonaws.ivs#ListChannels" }, + { + "target": "com.amazonaws.ivs#ListPlaybackKeyPairs" + }, { "target": "com.amazonaws.ivs#ListStreamKeys" }, @@ -114,17 +126,17 @@ "name": "ivs" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

\n Introduction\n

\n\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an AWS SNS event stream for responses. JSON\n is used for both requests and responses, including errors.

\n\n

The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and\n eu-west-1.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n\n

For a summary of notable documentation changes in each release, see Document\n History.

\n \n

\n Service Endpoints\n

\n

The following are the Amazon IVS service endpoints (all HTTPS):

\n

Region name: US West (Oregon)

\n \n

Region name: US East (Virginia)

\n \n

Region name: EU West (Dublin)

\n \n \n

\n Allowed Header Values\n

\n\n \n\n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with Amazon\n IVS):

\n\n \n\n\n\n

\n Tagging\n

\n\n

A tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS\n Resources for more information, including restrictions that apply to tags.

\n\n

Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see \n Access Tags).

\n\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels and Stream Keys.

\n\n

\n API Endpoints\n

\n\n

\n Channel:

\n \n\n

\n StreamKey:

\n \n\n\n

\n Stream:

\n \n\n \n\n

\n AWS\n Tags:

\n ", + "smithy.api#documentation": "

\n Introduction\n

\n\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an AWS SNS event stream for responses. JSON\n is used for both requests and responses, including errors.

\n\n

The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and\n eu-west-1.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n\n

For a summary of notable documentation changes in each release, see Document\n History.

\n \n

\n Service Endpoints\n

\n

The following are the Amazon IVS service endpoints (all HTTPS):

\n

Region name: US West (Oregon)

\n \n

Region name: US East (Virginia)

\n \n

Region name: EU West (Dublin)

\n \n \n

\n Allowed Header Values\n

\n\n \n\n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with Amazon\n IVS):

\n\n \n\n\n\n

\n Tagging\n

\n\n

A tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS\n Resources for more information, including restrictions that apply to tags.

\n\n

Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see \n Access Tags).

\n\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, and Playback Key Pairs.

\n\n

\n Channel Endpoints\n

\n \n\n

\n StreamKey Endpoints\n

\n \n\n\n

\n Stream Endpoints\n

\n \n\n

\n PlaybackKeyPair Endpoints\n

\n \n\n

\n AWS Tags Endpoints\n

\n ", "smithy.api#title": "Amazon Interactive Video Service" } }, "com.amazonaws.ivs#BatchError": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.ivs#errorCode", + "message": { + "target": "com.amazonaws.ivs#errorMessage", "traits": { - "smithy.api#documentation": "

Error code.

" + "smithy.api#documentation": "

Error message, determined by the application.

" } }, "arn": { @@ -133,10 +145,10 @@ "smithy.api#documentation": "

Channel ARN.

" } }, - "message": { - "target": "com.amazonaws.ivs#errorMessage", + "code": { + "target": "com.amazonaws.ivs#errorCode", "traits": { - "smithy.api#documentation": "

Error message, determined by the application.

" + "smithy.api#documentation": "

Error code.

" } } }, @@ -182,14 +194,14 @@ "com.amazonaws.ivs#BatchGetChannelResponse": { "type": "structure", "members": { + "channels": { + "target": "com.amazonaws.ivs#Channels" + }, "errors": { "target": "com.amazonaws.ivs#BatchErrors", "traits": { "smithy.api#documentation": "

Each error object is related to a specific ARN in the request.

" } - }, - "channels": { - "target": "com.amazonaws.ivs#Channels" } } }, @@ -233,25 +245,28 @@ } } }, + "com.amazonaws.ivs#Boolean": { + "type": "boolean" + }, "com.amazonaws.ivs#Channel": { "type": "structure", "members": { - "playbackUrl": { - "target": "com.amazonaws.ivs#PlaybackURL", - "traits": { - "smithy.api#documentation": "

Channel playback URL.

" - } - }, "type": { "target": "com.amazonaws.ivs#ChannelType", "traits": { "smithy.api#documentation": "

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:

\n \n

Default: STANDARD.

" } }, - "ingestEndpoint": { - "target": "com.amazonaws.ivs#IngestEndpoint", + "playbackUrl": { + "target": "com.amazonaws.ivs#PlaybackURL", "traits": { - "smithy.api#documentation": "

Channel ingest endpoint, part of the definition of an ingest server, used when you set up\n streaming software.

" + "smithy.api#documentation": "

Channel playback URL.

" + } + }, + "authorized": { + "target": "com.amazonaws.ivs#IsAuthorized", + "traits": { + "smithy.api#documentation": "

Whether the channel is authorized.

" } }, "arn": { @@ -260,10 +275,16 @@ "smithy.api#documentation": "

Channel ARN.

" } }, - "tags": { - "target": "com.amazonaws.ivs#Tags", + "latencyMode": { + "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + "smithy.api#documentation": "

Channel latency mode. Default: LOW.

" + } + }, + "ingestEndpoint": { + "target": "com.amazonaws.ivs#IngestEndpoint", + "traits": { + "smithy.api#documentation": "

Channel ingest endpoint, part of the definition of an ingest server, used when you set up\n streaming software.

" } }, "name": { @@ -272,10 +293,10 @@ "smithy.api#documentation": "

Channel name.

" } }, - "latencyMode": { - "target": "com.amazonaws.ivs#ChannelLatencyMode", + "tags": { + "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Channel latency mode. Default: LOW.

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" } } }, @@ -354,18 +375,18 @@ "com.amazonaws.ivs#ChannelSummary": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.ivs#ChannelArn", - "traits": { - "smithy.api#documentation": "

Channel ARN.

" - } - }, "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { "smithy.api#documentation": "

Channel latency mode. Default: LOW.

" } }, + "authorized": { + "target": "com.amazonaws.ivs#IsAuthorized", + "traits": { + "smithy.api#documentation": "

Whether the channel is authorized.

" + } + }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { @@ -377,6 +398,12 @@ "traits": { "smithy.api#documentation": "

Channel name.

" } + }, + "arn": { + "target": "com.amazonaws.ivs#ChannelArn", + "traits": { + "smithy.api#documentation": "

Channel ARN.

" + } } }, "traits": { @@ -453,16 +480,16 @@ "com.amazonaws.ivs#CreateChannelRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.ivs#ChannelName", + "authorized": { + "target": "com.amazonaws.ivs#Boolean", "traits": { - "smithy.api#documentation": "

Channel name.

" + "smithy.api#documentation": "

Whether the channel is authorized. Default: false.

" } }, - "tags": { - "target": "com.amazonaws.ivs#Tags", + "latencyMode": { + "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

See Channel$tags.

" + "smithy.api#documentation": "

Channel latency mode. Default: LOW.

" } }, "type": { @@ -471,10 +498,16 @@ "smithy.api#documentation": "

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:

\n \n

Default: STANDARD.

" } }, - "latencyMode": { - "target": "com.amazonaws.ivs#ChannelLatencyMode", + "tags": { + "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Channel latency mode. Default: LOW.

" + "smithy.api#documentation": "

See Channel$tags.

" + } + }, + "name": { + "target": "com.amazonaws.ivs#ChannelName", + "traits": { + "smithy.api#documentation": "

Channel name.

" } } } @@ -527,18 +560,18 @@ "com.amazonaws.ivs#CreateStreamKeyRequest": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.ivs#Tags", + "traits": { + "smithy.api#documentation": "

See Channel$tags.

" + } + }, "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "

ARN of the channel for which to create the stream key.

", "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.ivs#Tags", - "traits": { - "smithy.api#documentation": "

See Channel$tags.

" - } } } }, @@ -596,6 +629,53 @@ } } }, + "com.amazonaws.ivs#DeletePlaybackKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#DeletePlaybackKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ivs#DeletePlaybackKeyPairResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivs#PendingVerification" + }, + { + "target": "com.amazonaws.ivs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified authorization key pair. This invalidates future viewer tokens\n generated using the key pair’s privateKey.

", + "smithy.api#http": { + "method": "POST", + "uri": "/DeletePlaybackKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.ivs#DeletePlaybackKeyPairRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivs#PlaybackKeyPairArn", + "traits": { + "smithy.api#documentation": "

ARN of the key pair to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivs#DeletePlaybackKeyPairResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.ivs#DeleteStreamKey": { "type": "operation", "input": { @@ -684,6 +764,54 @@ } } }, + "com.amazonaws.ivs#GetPlaybackKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#GetPlaybackKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ivs#GetPlaybackKeyPairResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a specified playback authorization key pair and returns the arn and\n fingerprint. The privateKey held by the caller can be used to\n generate viewer authorization tokens, to grant viewers access to authorized channels.

", + "smithy.api#http": { + "method": "POST", + "uri": "/GetPlaybackKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.ivs#GetPlaybackKeyPairRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivs#PlaybackKeyPairArn", + "traits": { + "smithy.api#documentation": "

ARN of the key pair to be returned.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivs#GetPlaybackKeyPairResponse": { + "type": "structure", + "members": { + "keyPair": { + "target": "com.amazonaws.ivs#PlaybackKeyPair" + } + } + }, "com.amazonaws.ivs#GetStream": { "type": "operation", "input": { @@ -783,6 +911,72 @@ } } }, + "com.amazonaws.ivs#ImportPlaybackKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#ImportPlaybackKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.ivs#ImportPlaybackKeyPairResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivs#ConflictException" + }, + { + "target": "com.amazonaws.ivs#PendingVerification" + }, + { + "target": "com.amazonaws.ivs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports the public portion of a new key pair and returns its arn and\n fingerprint. The privateKey can then be used to generate viewer\n authorization tokens, to grant viewers access to authorized channels.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ImportPlaybackKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.ivs#ImportPlaybackKeyPairRequest": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.ivs#Tags", + "traits": { + "smithy.api#documentation": "

Any tags provided with the request are added to the playback key pair tags.

" + } + }, + "name": { + "target": "com.amazonaws.ivs#PlaybackKeyPairName", + "traits": { + "smithy.api#documentation": "

An arbitrary string (a nickname) assigned to a playback key pair that helps the customer\n identify that resource. The value does not need to be unique.

" + } + }, + "publicKeyMaterial": { + "target": "com.amazonaws.ivs#PlaybackPublicKeyMaterial", + "traits": { + "smithy.api#documentation": "

The public portion of a customer-generated key pair.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivs#ImportPlaybackKeyPairResponse": { + "type": "structure", + "members": { + "keyPair": { + "target": "com.amazonaws.ivs#PlaybackKeyPair" + } + } + }, "com.amazonaws.ivs#IngestEndpoint": { "type": "string" }, @@ -792,22 +986,96 @@ "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { - "smithy.api#documentation": "

Unexpected error during processing of request.

" + "smithy.api#documentation": "

Unexpected error during processing of request.

" + } + } + }, + "traits": { + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.ivs#IsAuthorized": { + "type": "boolean" + }, + "com.amazonaws.ivs#ListChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#ListChannelsRequest" + }, + "output": { + "target": "com.amazonaws.ivs#ListChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets summary information about all channels in your account, in the AWS region where the\n API request is processed. This list can be filtered to match a specified string.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListChannels", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.ivs#ListChannelsRequest": { + "type": "structure", + "members": { + "filterByName": { + "target": "com.amazonaws.ivs#ChannelName", + "traits": { + "smithy.api#documentation": "

Filters the channel list to match the specified name.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ivs#MaxChannelResults", + "traits": { + "smithy.api#documentation": "

Maximum number of channels to return.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ivs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The first channel to retrieve. This is used for pagination; see the nextToken\n response field.

" + } + } + } + }, + "com.amazonaws.ivs#ListChannelsResponse": { + "type": "structure", + "members": { + "channels": { + "target": "com.amazonaws.ivs#ChannelList", + "traits": { + "smithy.api#documentation": "

List of the matching channels.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ivs#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more channels than maxResults, use nextToken in the\n request to get the next set.

" } } - }, - "traits": { - "smithy.api#error": "server", - "smithy.api#httpError": 500 } }, - "com.amazonaws.ivs#ListChannels": { + "com.amazonaws.ivs#ListPlaybackKeyPairs": { "type": "operation", "input": { - "target": "com.amazonaws.ivs#ListChannelsRequest" + "target": "com.amazonaws.ivs#ListPlaybackKeyPairsRequest" }, "output": { - "target": "com.amazonaws.ivs#ListChannelsResponse" + "target": "com.amazonaws.ivs#ListPlaybackKeyPairsResponse" }, "errors": [ { @@ -818,10 +1086,10 @@ } ], "traits": { - "smithy.api#documentation": "

Gets summary information about all channels in your account, in the AWS region where the\n API request is processed. This list can be filtered to match a specified string.

", + "smithy.api#documentation": "

Gets summary information about playback key pairs.

", "smithy.api#http": { "method": "POST", - "uri": "/ListChannels", + "uri": "/ListPlaybackKeyPairs", "code": 200 }, "smithy.api#paginated": { @@ -831,43 +1099,37 @@ } } }, - "com.amazonaws.ivs#ListChannelsRequest": { + "com.amazonaws.ivs#ListPlaybackKeyPairsRequest": { "type": "structure", "members": { "maxResults": { - "target": "com.amazonaws.ivs#MaxChannelResults", + "target": "com.amazonaws.ivs#MaxPlaybackKeyPairResults", "traits": { - "smithy.api#documentation": "

Maximum number of channels to return.

" + "smithy.api#documentation": "

The first key pair to retrieve. This is used for pagination; see the\n nextToken response field.

" } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { - "smithy.api#documentation": "

The first channel to retrieve. This is used for pagination; see the nextToken\n response field.

" - } - }, - "filterByName": { - "target": "com.amazonaws.ivs#ChannelName", - "traits": { - "smithy.api#documentation": "

Filters the channel list to match the specified name.

" + "smithy.api#documentation": "

Maximum number of key pairs to return.

" } } } }, - "com.amazonaws.ivs#ListChannelsResponse": { + "com.amazonaws.ivs#ListPlaybackKeyPairsResponse": { "type": "structure", "members": { - "channels": { - "target": "com.amazonaws.ivs#ChannelList", + "keyPairs": { + "target": "com.amazonaws.ivs#PlaybackKeyPairList", "traits": { - "smithy.api#documentation": "

List of the matching channels.

", + "smithy.api#documentation": "

List of key pairs.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { - "smithy.api#documentation": "

If there are more channels than maxResults, use nextToken in the\n request to get the next set.

" + "smithy.api#documentation": "

If there are more key pairs than maxResults, use nextToken in\n the request to get the next set.

" } } } @@ -915,17 +1177,17 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.ivs#MaxStreamKeyResults", - "traits": { - "smithy.api#documentation": "

Maximum number of streamKeys to return.

" - } - }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "

The first stream key to retrieve. This is used for pagination; see the\n nextToken response field.

" } + }, + "maxResults": { + "target": "com.amazonaws.ivs#MaxStreamKeyResults", + "traits": { + "smithy.api#documentation": "

Maximum number of streamKeys to return.

" + } } } }, @@ -1045,10 +1307,12 @@ "com.amazonaws.ivs#ListTagsForResourceRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ivs#String", + "resourceArn": { + "target": "com.amazonaws.ivs#ResourceArn", "traits": { - "smithy.api#documentation": "

The first tag to retrieve. This is used for pagination; see the nextToken\n response field.

" + "smithy.api#documentation": "

The ARN of the resource to be retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "maxResults": { @@ -1057,12 +1321,10 @@ "smithy.api#documentation": "

Maximum number of tags to return.

" } }, - "resourceArn": { - "target": "com.amazonaws.ivs#ResourceArn", + "nextToken": { + "target": "com.amazonaws.ivs#String", "traits": { - "smithy.api#documentation": "

The ARN of the resource to be retrieved.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The first tag to retrieve. This is used for pagination; see the nextToken\n response field.

" } } } @@ -1070,17 +1332,17 @@ "com.amazonaws.ivs#ListTagsForResourceResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ivs#String", - "traits": { - "smithy.api#documentation": "

If there are more tags than maxResults, use nextToken in the\n request to get the next set.

" - } - }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

If there are more tags than maxResults, use nextToken in the\n request to get the next set.

" + } } } }, @@ -1093,6 +1355,15 @@ } } }, + "com.amazonaws.ivs#MaxPlaybackKeyPairResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.ivs#MaxStreamKeyResults": { "type": "integer", "traits": { @@ -1144,6 +1415,96 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.ivs#PlaybackKeyPair": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivs#PlaybackKeyPairArn", + "traits": { + "smithy.api#documentation": "

Key-pair ARN.

" + } + }, + "name": { + "target": "com.amazonaws.ivs#PlaybackKeyPairName", + "traits": { + "smithy.api#documentation": "

Key-pair name.

" + } + }, + "tags": { + "target": "com.amazonaws.ivs#Tags", + "traits": { + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + } + }, + "fingerprint": { + "target": "com.amazonaws.ivs#PlaybackKeyPairFingerprint", + "traits": { + "smithy.api#documentation": "

Key-pair identifier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A key pair used to sign and validate a playback authorization token.

" + } + }, + "com.amazonaws.ivs#PlaybackKeyPairArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivs#PlaybackKeyPairFingerprint": { + "type": "string" + }, + "com.amazonaws.ivs#PlaybackKeyPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivs#PlaybackKeyPairSummary" + } + }, + "com.amazonaws.ivs#PlaybackKeyPairName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.ivs#PlaybackKeyPairSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivs#PlaybackKeyPairName", + "traits": { + "smithy.api#documentation": "

Key-pair name.

" + } + }, + "arn": { + "target": "com.amazonaws.ivs#PlaybackKeyPairArn", + "traits": { + "smithy.api#documentation": "

Key-pair ARN.

" + } + }, + "tags": { + "target": "com.amazonaws.ivs#Tags", + "traits": { + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value)\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a playback key pair.

" + } + }, + "com.amazonaws.ivs#PlaybackPublicKeyMaterial": { + "type": "string" + }, "com.amazonaws.ivs#PlaybackURL": { "type": "string" }, @@ -1181,17 +1542,17 @@ "com.amazonaws.ivs#PutMetadataRequest": { "type": "structure", "members": { - "metadata": { - "target": "com.amazonaws.ivs#StreamMetadata", + "channelArn": { + "target": "com.amazonaws.ivs#ChannelArn", "traits": { - "smithy.api#documentation": "

Metadata to insert into the stream. Maximum: 1 KB per request.

", + "smithy.api#documentation": "

ARN of the channel into which metadata is inserted. This channel must have an active\n stream.

", "smithy.api#required": {} } }, - "channelArn": { - "target": "com.amazonaws.ivs#ChannelArn", + "metadata": { + "target": "com.amazonaws.ivs#StreamMetadata", "traits": { - "smithy.api#documentation": "

ARN of the channel into which metadata is inserted. This channel must have an active\n stream.

", + "smithy.api#documentation": "

Metadata to insert into the stream. Maximum: 1 KB per request.

", "smithy.api#required": {} } } @@ -1290,10 +1651,10 @@ "com.amazonaws.ivs#Stream": { "type": "structure", "members": { - "startTime": { - "target": "com.amazonaws.ivs#StreamStartTime", + "channelArn": { + "target": "com.amazonaws.ivs#ChannelArn", "traits": { - "smithy.api#documentation": "

ISO-8601 formatted timestamp of the stream’s start.

" + "smithy.api#documentation": "

Channel ARN for the stream.

" } }, "playbackUrl": { @@ -1302,6 +1663,12 @@ "smithy.api#documentation": "

URL of the video master manifest, required by the video player to play the HLS\n stream.

" } }, + "health": { + "target": "com.amazonaws.ivs#StreamHealth", + "traits": { + "smithy.api#documentation": "

The stream’s health.

" + } + }, "state": { "target": "com.amazonaws.ivs#StreamState", "traits": { @@ -1314,16 +1681,10 @@ "smithy.api#documentation": "

Number of current viewers of the stream.

" } }, - "channelArn": { - "target": "com.amazonaws.ivs#ChannelArn", - "traits": { - "smithy.api#documentation": "

Channel ARN for the stream.

" - } - }, - "health": { - "target": "com.amazonaws.ivs#StreamHealth", + "startTime": { + "target": "com.amazonaws.ivs#StreamStartTime", "traits": { - "smithy.api#documentation": "

The stream’s health.

" + "smithy.api#documentation": "

ISO-8601 formatted timestamp of the stream’s start.

" } } }, @@ -1359,6 +1720,12 @@ "smithy.api#documentation": "

Channel ARN for the stream.

" } }, + "tags": { + "target": "com.amazonaws.ivs#Tags", + "traits": { + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" + } + }, "arn": { "target": "com.amazonaws.ivs#StreamKeyArn", "traits": { @@ -1370,12 +1737,6 @@ "traits": { "smithy.api#documentation": "

Stream-key value.

" } - }, - "tags": { - "target": "com.amazonaws.ivs#Tags", - "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value)\n

" - } } }, "traits": { @@ -1422,7 +1783,7 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value)\n

" + "smithy.api#documentation": "

Array of 1-50 maps, each of the form string:string (key:value).

" } }, "arn": { @@ -1475,34 +1836,34 @@ "com.amazonaws.ivs#StreamSummary": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.ivs#StreamState", - "traits": { - "smithy.api#documentation": "

The stream’s state.

" - } - }, - "health": { - "target": "com.amazonaws.ivs#StreamHealth", - "traits": { - "smithy.api#documentation": "

The stream’s health.

" - } - }, "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "

Channel ARN for the stream.

" } }, + "startTime": { + "target": "com.amazonaws.ivs#StreamStartTime", + "traits": { + "smithy.api#documentation": "

ISO-8601 formatted timestamp of the stream’s start.

" + } + }, "viewerCount": { "target": "com.amazonaws.ivs#StreamViewerCount", "traits": { "smithy.api#documentation": "

Number of current viewers of the stream.

" } }, - "startTime": { - "target": "com.amazonaws.ivs#StreamStartTime", + "health": { + "target": "com.amazonaws.ivs#StreamHealth", "traits": { - "smithy.api#documentation": "

ISO-8601 formatted timestamp of the stream’s start.

" + "smithy.api#documentation": "

The stream’s health.

" + } + }, + "state": { + "target": "com.amazonaws.ivs#StreamState", + "traits": { + "smithy.api#documentation": "

The stream’s state.

" } } }, @@ -1583,18 +1944,18 @@ "com.amazonaws.ivs#TagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.ivs#ResourceArn", + "tags": { + "target": "com.amazonaws.ivs#Tags", "traits": { - "smithy.api#documentation": "

ARN of the resource for which tags are to be added or updated.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Array of tags to be added or updated.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.ivs#Tags", + "resourceArn": { + "target": "com.amazonaws.ivs#ResourceArn", "traits": { - "smithy.api#documentation": "

Array of tags to be added or updated.

", + "smithy.api#documentation": "

ARN of the resource for which tags are to be added or updated.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -1739,11 +2100,10 @@ "smithy.api#documentation": "

Channel latency mode. Default: LOW.

" } }, - "arn": { - "target": "com.amazonaws.ivs#ChannelArn", + "authorized": { + "target": "com.amazonaws.ivs#Boolean", "traits": { - "smithy.api#documentation": "

ARN of the channel to be updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Whether the channel is authorized. Default: false.

" } }, "name": { @@ -1757,6 +2117,13 @@ "traits": { "smithy.api#documentation": "

Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:

\n \n

Default: STANDARD.

" } + }, + "arn": { + "target": "com.amazonaws.ivs#ChannelArn", + "traits": { + "smithy.api#documentation": "

ARN of the channel to be updated.

", + "smithy.api#required": {} + } } } }, diff --git a/codegen/sdk-codegen/aws-models/kafka.2018-11-14.json b/codegen/sdk-codegen/aws-models/kafka.2018-11-14.json index 524d6b976fa2..e0616d0dc17d 100644 --- a/codegen/sdk-codegen/aws-models/kafka.2018-11-14.json +++ b/codegen/sdk-codegen/aws-models/kafka.2018-11-14.json @@ -53,6 +53,172 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.kafka#BatchAssociateScramSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#BatchAssociateScramSecretRequest" + }, + "output": { + "target": "com.amazonaws.kafka#BatchAssociateScramSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates one or more Scram Secrets with an Amazon MSK cluster.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/clusters/{ClusterArn}/scram-secrets", + "code": 200 + } + } + }, + "com.amazonaws.kafka#BatchAssociateScramSecretRequest": { + "type": "structure", + "members": { + "SecretArnList": { + "target": "com.amazonaws.kafka#__listOf__string", + "traits": { + "smithy.api#documentation": "

List of AWS Secrets Manager secret ARNs.

", + "smithy.api#jsonName": "secretArnList", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Associates sasl scram secrets to cluster.

" + } + }, + "com.amazonaws.kafka#BatchAssociateScramSecretResponse": { + "type": "structure", + "members": { + "UnprocessedScramSecrets": { + "target": "com.amazonaws.kafka#__listOfUnprocessedScramSecret", + "traits": { + "smithy.api#documentation": "

List of errors when associating secrets to cluster.

", + "smithy.api#jsonName": "unprocessedScramSecrets" + } + }, + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" + } + } + } + }, + "com.amazonaws.kafka#BatchDisassociateScramSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#BatchDisassociateScramSecretRequest" + }, + "output": { + "target": "com.amazonaws.kafka#BatchDisassociateScramSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/v1/clusters/{ClusterArn}/scram-secrets", + "code": 200 + } + } + }, + "com.amazonaws.kafka#BatchDisassociateScramSecretRequest": { + "type": "structure", + "members": { + "SecretArnList": { + "target": "com.amazonaws.kafka#__listOf__string", + "traits": { + "smithy.api#documentation": "

List of AWS Secrets Manager secret ARNs.

", + "smithy.api#jsonName": "secretArnList", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Disassociates sasl scram secrets to cluster.

" + } + }, + "com.amazonaws.kafka#BatchDisassociateScramSecretResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" + } + }, + "UnprocessedScramSecrets": { + "target": "com.amazonaws.kafka#__listOfUnprocessedScramSecret", + "traits": { + "smithy.api#documentation": "

List of errors when disassociating secrets to cluster.

", + "smithy.api#jsonName": "unprocessedScramSecrets" + } + } + } + }, "com.amazonaws.kafka#BrokerAZDistribution": { "type": "string", "traits": { @@ -68,14 +234,6 @@ "com.amazonaws.kafka#BrokerEBSVolumeInfo": { "type": "structure", "members": { - "KafkaBrokerNodeId": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The ID of the broker to update.

", - "smithy.api#jsonName": "kafkaBrokerNodeId", - "smithy.api#required": {} - } - }, "VolumeSizeGB": { "target": "com.amazonaws.kafka#__integer", "traits": { @@ -83,6 +241,14 @@ "smithy.api#jsonName": "volumeSizeGB", "smithy.api#required": {} } + }, + "KafkaBrokerNodeId": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The ID of the broker to update.

", + "smithy.api#jsonName": "kafkaBrokerNodeId", + "smithy.api#required": {} + } } }, "traits": { @@ -92,6 +258,12 @@ "com.amazonaws.kafka#BrokerLogs": { "type": "structure", "members": { + "S3": { + "target": "com.amazonaws.kafka#S3", + "traits": { + "smithy.api#jsonName": "s3" + } + }, "Firehose": { "target": "com.amazonaws.kafka#Firehose", "traits": { @@ -103,32 +275,17 @@ "traits": { "smithy.api#jsonName": "cloudWatchLogs" } - }, - "S3": { - "target": "com.amazonaws.kafka#S3", - "traits": { - "smithy.api#jsonName": "s3" - } } } }, "com.amazonaws.kafka#BrokerNodeGroupInfo": { "type": "structure", "members": { - "ClientSubnets": { + "SecurityGroups": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { - "smithy.api#documentation": "

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.

", - "smithy.api#jsonName": "clientSubnets", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.kafka#__stringMin5Max32", - "traits": { - "smithy.api#documentation": "

The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

", - "smithy.api#jsonName": "instanceType", - "smithy.api#required": {} + "smithy.api#documentation": "

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

", + "smithy.api#jsonName": "securityGroups" } }, "StorageInfo": { @@ -145,11 +302,20 @@ "smithy.api#jsonName": "brokerAZDistribution" } }, - "SecurityGroups": { + "ClientSubnets": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { - "smithy.api#documentation": "

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

", - "smithy.api#jsonName": "securityGroups" + "smithy.api#documentation": "

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.

", + "smithy.api#jsonName": "clientSubnets", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.kafka#__stringMin5Max32", + "traits": { + "smithy.api#documentation": "

The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

", + "smithy.api#jsonName": "instanceType", + "smithy.api#required": {} } } }, @@ -160,13 +326,6 @@ "com.amazonaws.kafka#BrokerNodeInfo": { "type": "structure", "members": { - "CurrentBrokerSoftwareInfo": { - "target": "com.amazonaws.kafka#BrokerSoftwareInfo", - "traits": { - "smithy.api#documentation": "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

", - "smithy.api#jsonName": "currentBrokerSoftwareInfo" - } - }, "AttachedENIId": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -174,18 +333,11 @@ "smithy.api#jsonName": "attachedENIId" } }, - "Endpoints": { - "target": "com.amazonaws.kafka#__listOf__string", - "traits": { - "smithy.api#documentation": "

Endpoints for accessing the broker.

", - "smithy.api#jsonName": "endpoints" - } - }, - "ClientVpcIpAddress": { - "target": "com.amazonaws.kafka#__string", + "CurrentBrokerSoftwareInfo": { + "target": "com.amazonaws.kafka#BrokerSoftwareInfo", "traits": { - "smithy.api#documentation": "

The virtual private cloud (VPC) of the client.

", - "smithy.api#jsonName": "clientVpcIpAddress" + "smithy.api#documentation": "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

", + "smithy.api#jsonName": "currentBrokerSoftwareInfo" } }, "BrokerId": { @@ -201,6 +353,20 @@ "smithy.api#documentation": "

The client subnet to which this broker node belongs.

", "smithy.api#jsonName": "clientSubnet" } + }, + "ClientVpcIpAddress": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The virtual private cloud (VPC) of the client.

", + "smithy.api#jsonName": "clientVpcIpAddress" + } + }, + "Endpoints": { + "target": "com.amazonaws.kafka#__listOf__string", + "traits": { + "smithy.api#documentation": "

Endpoints for accessing the broker.

", + "smithy.api#jsonName": "endpoints" + } } }, "traits": { @@ -217,19 +383,19 @@ "smithy.api#jsonName": "kafkaVersion" } }, - "ConfigurationRevision": { - "target": "com.amazonaws.kafka#__long", - "traits": { - "smithy.api#documentation": "

The revision of the configuration to use. This field isn't visible in this preview release.

", - "smithy.api#jsonName": "configurationRevision" - } - }, "ConfigurationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

", "smithy.api#jsonName": "configurationArn" } + }, + "ConfigurationRevision": { + "target": "com.amazonaws.kafka#__long", + "traits": { + "smithy.api#documentation": "

The revision of the configuration to use. This field isn't visible in this preview release.

", + "smithy.api#jsonName": "configurationRevision" + } } }, "traits": { @@ -245,6 +411,13 @@ "smithy.api#documentation": "

Details for ClientAuthentication using TLS.

", "smithy.api#jsonName": "tls" } + }, + "Sasl": { + "target": "com.amazonaws.kafka#Sasl", + "traits": { + "smithy.api#documentation": "

Details for ClientAuthentication using SASL.

", + "smithy.api#jsonName": "sasl" + } } }, "traits": { @@ -292,73 +465,59 @@ "com.amazonaws.kafka#ClusterInfo": { "type": "structure", "members": { - "LoggingInfo": { - "target": "com.amazonaws.kafka#LoggingInfo", - "traits": { - "smithy.api#jsonName": "loggingInfo" - } - }, - "EncryptionInfo": { - "target": "com.amazonaws.kafka#EncryptionInfo", + "ZookeeperConnectStringTls": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Includes all encryption-related information.

", - "smithy.api#jsonName": "encryptionInfo" + "smithy.api#documentation": "

The connection string to use to connect to zookeeper cluster on Tls port.

", + "smithy.api#jsonName": "zookeeperConnectStringTls" } }, - "NumberOfBrokerNodes": { - "target": "com.amazonaws.kafka#__integer", + "ActiveOperationArn": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The number of broker nodes in the cluster.

", - "smithy.api#jsonName": "numberOfBrokerNodes" + "smithy.api#documentation": "

Arn of active cluster operation.

", + "smithy.api#jsonName": "activeOperationArn" } }, - "CurrentBrokerSoftwareInfo": { - "target": "com.amazonaws.kafka#BrokerSoftwareInfo", + "BrokerNodeGroupInfo": { + "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", "traits": { - "smithy.api#documentation": "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

", - "smithy.api#jsonName": "currentBrokerSoftwareInfo" + "smithy.api#documentation": "

Information about the broker nodes.

", + "smithy.api#jsonName": "brokerNodeGroupInfo" } }, - "ClusterArn": { + "ClusterName": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "smithy.api#jsonName": "clusterArn" + "smithy.api#documentation": "

The name of the cluster.

", + "smithy.api#jsonName": "clusterName" } }, - "ZookeeperConnectString": { - "target": "com.amazonaws.kafka#__string", + "Tags": { + "target": "com.amazonaws.kafka#__mapOf__string", "traits": { - "smithy.api#documentation": "

The connection string to use to connect to the Apache ZooKeeper cluster.

", - "smithy.api#jsonName": "zookeeperConnectString" + "smithy.api#documentation": "

Tags attached to the cluster.

", + "smithy.api#jsonName": "tags" } }, - "OpenMonitoring": { - "target": "com.amazonaws.kafka#OpenMonitoring", + "ClientAuthentication": { + "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { - "smithy.api#documentation": "

Settings for open monitoring using Prometheus.

", - "smithy.api#jsonName": "openMonitoring" + "smithy.api#documentation": "

Includes all client authentication information.

", + "smithy.api#jsonName": "clientAuthentication" } }, - "ActiveOperationArn": { + "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Arn of active cluster operation.

", - "smithy.api#jsonName": "activeOperationArn" - } - }, - "EnhancedMonitoring": { - "target": "com.amazonaws.kafka#EnhancedMonitoring", - "traits": { - "smithy.api#documentation": "

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

", - "smithy.api#jsonName": "enhancedMonitoring" + "smithy.api#documentation": "

The current version of the MSK cluster.

", + "smithy.api#jsonName": "currentVersion" } }, - "BrokerNodeGroupInfo": { - "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", + "StateInfo": { + "target": "com.amazonaws.kafka#StateInfo", "traits": { - "smithy.api#documentation": "

Information about the broker nodes.

", - "smithy.api#jsonName": "brokerNodeGroupInfo" + "smithy.api#jsonName": "stateInfo" } }, "State": { @@ -368,38 +527,45 @@ "smithy.api#jsonName": "state" } }, - "CurrentVersion": { - "target": "com.amazonaws.kafka#__string", + "NumberOfBrokerNodes": { + "target": "com.amazonaws.kafka#__integer", "traits": { - "smithy.api#documentation": "

The current version of the MSK cluster.

", - "smithy.api#jsonName": "currentVersion" + "smithy.api#documentation": "

The number of broker nodes in the cluster.

", + "smithy.api#jsonName": "numberOfBrokerNodes" } }, - "StateInfo": { - "target": "com.amazonaws.kafka#StateInfo", + "EncryptionInfo": { + "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { - "smithy.api#jsonName": "stateInfo" + "smithy.api#documentation": "

Includes all encryption-related information.

", + "smithy.api#jsonName": "encryptionInfo" } }, - "ClientAuthentication": { - "target": "com.amazonaws.kafka#ClientAuthentication", + "OpenMonitoring": { + "target": "com.amazonaws.kafka#OpenMonitoring", "traits": { - "smithy.api#documentation": "

Includes all client authentication information.

", - "smithy.api#jsonName": "clientAuthentication" + "smithy.api#documentation": "

Settings for open monitoring using Prometheus.

", + "smithy.api#jsonName": "openMonitoring" } }, - "Tags": { - "target": "com.amazonaws.kafka#__mapOf__string", + "LoggingInfo": { + "target": "com.amazonaws.kafka#LoggingInfo", "traits": { - "smithy.api#documentation": "

Tags attached to the cluster.

", - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "loggingInfo" } }, - "ClusterName": { + "CurrentBrokerSoftwareInfo": { + "target": "com.amazonaws.kafka#BrokerSoftwareInfo", + "traits": { + "smithy.api#documentation": "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

", + "smithy.api#jsonName": "currentBrokerSoftwareInfo" + } + }, + "ZookeeperConnectString": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The name of the cluster.

", - "smithy.api#jsonName": "clusterName" + "smithy.api#documentation": "

The connection string to use to connect to the Apache ZooKeeper cluster.

", + "smithy.api#jsonName": "zookeeperConnectString" } }, "CreationTime": { @@ -408,6 +574,20 @@ "smithy.api#documentation": "

The time when the cluster was created.

", "smithy.api#jsonName": "creationTime" } + }, + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", + "smithy.api#jsonName": "clusterArn" + } + }, + "EnhancedMonitoring": { + "target": "com.amazonaws.kafka#EnhancedMonitoring", + "traits": { + "smithy.api#documentation": "

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

", + "smithy.api#jsonName": "enhancedMonitoring" + } } }, "traits": { @@ -431,6 +611,20 @@ "smithy.api#jsonName": "clientRequestId" } }, + "OperationSteps": { + "target": "com.amazonaws.kafka#__listOfClusterOperationStep", + "traits": { + "smithy.api#documentation": "

Steps completed during the operation.

", + "smithy.api#jsonName": "operationSteps" + } + }, + "EndTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time at which the operation finished.

", + "smithy.api#jsonName": "endTime" + } + }, "SourceClusterInfo": { "target": "com.amazonaws.kafka#MutableClusterInfo", "traits": { @@ -445,18 +639,11 @@ "smithy.api#jsonName": "errorInfo" } }, - "OperationType": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

Type of the cluster operation.

", - "smithy.api#jsonName": "operationType" - } - }, - "OperationState": { + "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

State of the cluster operation.

", - "smithy.api#jsonName": "operationState" + "smithy.api#documentation": "

ARN of the cluster.

", + "smithy.api#jsonName": "clusterArn" } }, "CreationTime": { @@ -466,32 +653,25 @@ "smithy.api#jsonName": "creationTime" } }, - "ClusterArn": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

ARN of the cluster.

", - "smithy.api#jsonName": "clusterArn" - } - }, - "EndTime": { - "target": "com.amazonaws.kafka#__timestampIso8601", + "TargetClusterInfo": { + "target": "com.amazonaws.kafka#MutableClusterInfo", "traits": { - "smithy.api#documentation": "

The time at which the operation finished.

", - "smithy.api#jsonName": "endTime" + "smithy.api#documentation": "

Information about cluster attributes after a cluster is updated.

", + "smithy.api#jsonName": "targetClusterInfo" } }, - "OperationSteps": { - "target": "com.amazonaws.kafka#__listOfClusterOperationStep", + "OperationType": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Steps completed during the operation.

", - "smithy.api#jsonName": "operationSteps" + "smithy.api#documentation": "

Type of the cluster operation.

", + "smithy.api#jsonName": "operationType" } }, - "TargetClusterInfo": { - "target": "com.amazonaws.kafka#MutableClusterInfo", + "OperationState": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Information about cluster attributes after a cluster is updated.

", - "smithy.api#jsonName": "targetClusterInfo" + "smithy.api#documentation": "

State of the cluster operation.

", + "smithy.api#jsonName": "operationState" } } }, @@ -502,19 +682,19 @@ "com.amazonaws.kafka#ClusterOperationStep": { "type": "structure", "members": { - "StepName": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The name of the step.

", - "smithy.api#jsonName": "stepName" - } - }, "StepInfo": { "target": "com.amazonaws.kafka#ClusterOperationStepInfo", "traits": { "smithy.api#documentation": "

Information about the step and its status.

", "smithy.api#jsonName": "stepInfo" } + }, + "StepName": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The name of the step.

", + "smithy.api#jsonName": "stepName" + } } }, "traits": { @@ -589,19 +769,19 @@ "com.amazonaws.kafka#Configuration": { "type": "structure", "members": { - "LatestRevision": { - "target": "com.amazonaws.kafka#ConfigurationRevision", + "Arn": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Latest revision of the configuration.

", - "smithy.api#jsonName": "latestRevision", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", + "smithy.api#jsonName": "arn", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.kafka#__string", + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The description of the configuration.

", - "smithy.api#jsonName": "description", + "smithy.api#documentation": "

The time when the configuration was created.

", + "smithy.api#jsonName": "creationTime", "smithy.api#required": {} } }, @@ -621,38 +801,38 @@ "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.kafka#__string", + "LatestRevision": { + "target": "com.amazonaws.kafka#ConfigurationRevision", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", - "smithy.api#jsonName": "arn", + "smithy.api#documentation": "

Latest revision of the configuration.

", + "smithy.api#jsonName": "latestRevision", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.kafka#__timestampIso8601", + "Description": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The time when the configuration was created.

", - "smithy.api#jsonName": "creationTime", + "smithy.api#documentation": "

The description of the configuration.

", + "smithy.api#jsonName": "description", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

Represents an MSK Configuration.

" - } - }, - "com.amazonaws.kafka#ConfigurationInfo": { - "type": "structure", - "members": { - "Revision": { - "target": "com.amazonaws.kafka#__long", + }, + "State": { + "target": "com.amazonaws.kafka#ConfigurationState", "traits": { - "smithy.api#documentation": "

The revision of the configuration to use.

", - "smithy.api#jsonName": "revision", + "smithy.api#documentation": "

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

", + "smithy.api#jsonName": "state", "smithy.api#required": {} } - }, + } + }, + "traits": { + "smithy.api#documentation": "

Represents an MSK Configuration.

" + } + }, + "com.amazonaws.kafka#ConfigurationInfo": { + "type": "structure", + "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -660,6 +840,14 @@ "smithy.api#jsonName": "arn", "smithy.api#required": {} } + }, + "Revision": { + "target": "com.amazonaws.kafka#__long", + "traits": { + "smithy.api#documentation": "

The revision of the configuration to use.

", + "smithy.api#jsonName": "revision", + "smithy.api#required": {} + } } }, "traits": { @@ -669,11 +857,11 @@ "com.amazonaws.kafka#ConfigurationRevision": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.kafka#__timestampIso8601", + "Revision": { + "target": "com.amazonaws.kafka#__long", "traits": { - "smithy.api#documentation": "

The time when the configuration revision was created.

", - "smithy.api#jsonName": "creationTime", + "smithy.api#documentation": "

The revision number.

", + "smithy.api#jsonName": "revision", "smithy.api#required": {} } }, @@ -684,11 +872,11 @@ "smithy.api#jsonName": "description" } }, - "Revision": { - "target": "com.amazonaws.kafka#__long", + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The revision number.

", - "smithy.api#jsonName": "revision", + "smithy.api#documentation": "

The time when the configuration revision was created.

", + "smithy.api#jsonName": "creationTime", "smithy.api#required": {} } } @@ -697,21 +885,41 @@ "smithy.api#documentation": "

Describes a configuration revision.

" } }, + "com.amazonaws.kafka#ConfigurationState": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The state of a configuration.

", + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + } + ] + } + }, "com.amazonaws.kafka#ConflictException": { "type": "structure", "members": { - "InvalidParameter": { + "Message": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The parameter that caused the error.

", - "smithy.api#jsonName": "invalidParameter" + "smithy.api#documentation": "

The description of the error.

", + "smithy.api#jsonName": "message" } }, - "Message": { + "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The description of the error.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

The parameter that caused the error.

", + "smithy.api#jsonName": "invalidParameter" } } }, @@ -764,13 +972,6 @@ "com.amazonaws.kafka#CreateClusterRequest": { "type": "structure", "members": { - "ClientAuthentication": { - "target": "com.amazonaws.kafka#ClientAuthentication", - "traits": { - "smithy.api#documentation": "

Includes all client authentication related information.

", - "smithy.api#jsonName": "clientAuthentication" - } - }, "KafkaVersion": { "target": "com.amazonaws.kafka#__stringMin1Max128", "traits": { @@ -779,11 +980,18 @@ "smithy.api#required": {} } }, - "ClusterName": { - "target": "com.amazonaws.kafka#__stringMin1Max64", + "Tags": { + "target": "com.amazonaws.kafka#__mapOf__string", "traits": { - "smithy.api#documentation": "

The name of the cluster.

", - "smithy.api#jsonName": "clusterName", + "smithy.api#documentation": "

Create tags when creating the cluster.

", + "smithy.api#jsonName": "tags" + } + }, + "BrokerNodeGroupInfo": { + "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", + "traits": { + "smithy.api#documentation": "

Information about the broker nodes in the cluster.

", + "smithy.api#jsonName": "brokerNodeGroupInfo", "smithy.api#required": {} } }, @@ -794,11 +1002,11 @@ "smithy.api#jsonName": "enhancedMonitoring" } }, - "Tags": { - "target": "com.amazonaws.kafka#__mapOf__string", + "OpenMonitoring": { + "target": "com.amazonaws.kafka#OpenMonitoringInfo", "traits": { - "smithy.api#documentation": "

Create tags when creating the cluster.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The settings for open monitoring.

", + "smithy.api#jsonName": "openMonitoring" } }, "ConfigurationInfo": { @@ -808,40 +1016,40 @@ "smithy.api#jsonName": "configurationInfo" } }, - "NumberOfBrokerNodes": { - "target": "com.amazonaws.kafka#__integerMin1Max15", + "ClusterName": { + "target": "com.amazonaws.kafka#__stringMin1Max64", "traits": { - "smithy.api#documentation": "

The number of broker nodes in the cluster.

", - "smithy.api#jsonName": "numberOfBrokerNodes", + "smithy.api#documentation": "

The name of the cluster.

", + "smithy.api#jsonName": "clusterName", "smithy.api#required": {} } }, - "LoggingInfo": { - "target": "com.amazonaws.kafka#LoggingInfo", + "EncryptionInfo": { + "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { - "smithy.api#jsonName": "loggingInfo" + "smithy.api#documentation": "

Includes all encryption-related information.

", + "smithy.api#jsonName": "encryptionInfo" } }, - "BrokerNodeGroupInfo": { - "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", + "NumberOfBrokerNodes": { + "target": "com.amazonaws.kafka#__integerMin1Max15", "traits": { - "smithy.api#documentation": "

Information about the broker nodes in the cluster.

", - "smithy.api#jsonName": "brokerNodeGroupInfo", + "smithy.api#documentation": "

The number of broker nodes in the cluster.

", + "smithy.api#jsonName": "numberOfBrokerNodes", "smithy.api#required": {} } }, - "EncryptionInfo": { - "target": "com.amazonaws.kafka#EncryptionInfo", + "LoggingInfo": { + "target": "com.amazonaws.kafka#LoggingInfo", "traits": { - "smithy.api#documentation": "

Includes all encryption-related information.

", - "smithy.api#jsonName": "encryptionInfo" + "smithy.api#jsonName": "loggingInfo" } }, - "OpenMonitoring": { - "target": "com.amazonaws.kafka#OpenMonitoringInfo", + "ClientAuthentication": { + "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { - "smithy.api#documentation": "

The settings for open monitoring.

", - "smithy.api#jsonName": "openMonitoring" + "smithy.api#documentation": "

Includes all client authentication related information.

", + "smithy.api#jsonName": "clientAuthentication" } } } @@ -849,13 +1057,6 @@ "com.amazonaws.kafka#CreateClusterResponse": { "type": "structure", "members": { - "ClusterName": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The name of the MSK cluster.

", - "smithy.api#jsonName": "clusterName" - } - }, "State": { "target": "com.amazonaws.kafka#ClusterState", "traits": { @@ -869,6 +1070,13 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } + }, + "ClusterName": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The name of the MSK cluster.

", + "smithy.api#jsonName": "clusterName" + } } } }, @@ -915,6 +1123,13 @@ "com.amazonaws.kafka#CreateConfigurationRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The description of the configuration.

", + "smithy.api#jsonName": "description" + } + }, "ServerProperties": { "target": "com.amazonaws.kafka#__blob", "traits": { @@ -930,13 +1145,6 @@ "smithy.api#jsonName": "kafkaVersions" } }, - "Description": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The description of the configuration.

", - "smithy.api#jsonName": "description" - } - }, "Name": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -950,6 +1158,27 @@ "com.amazonaws.kafka#CreateConfigurationResponse": { "type": "structure", "members": { + "LatestRevision": { + "target": "com.amazonaws.kafka#ConfigurationRevision", + "traits": { + "smithy.api#documentation": "

Latest revision of the configuration.

", + "smithy.api#jsonName": "latestRevision" + } + }, + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time when the configuration was created.

", + "smithy.api#jsonName": "creationTime" + } + }, + "State": { + "target": "com.amazonaws.kafka#ConfigurationState", + "traits": { + "smithy.api#documentation": "

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

", + "smithy.api#jsonName": "state" + } + }, "Name": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -963,20 +1192,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#jsonName": "arn" } - }, - "CreationTime": { - "target": "com.amazonaws.kafka#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The time when the configuration was created.

", - "smithy.api#jsonName": "creationTime" - } - }, - "LatestRevision": { - "target": "com.amazonaws.kafka#ConfigurationRevision", - "traits": { - "smithy.api#documentation": "

Latest revision of the configuration.

", - "smithy.api#jsonName": "latestRevision" - } } } }, @@ -1014,6 +1229,13 @@ "com.amazonaws.kafka#DeleteClusterRequest": { "type": "structure", "members": { + "CurrentVersion": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The current version of the MSK cluster.

", + "smithy.api#httpQuery": "currentVersion" + } + }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -1021,31 +1243,87 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + } + } + }, + "com.amazonaws.kafka#DeleteClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" + } }, - "CurrentVersion": { + "State": { + "target": "com.amazonaws.kafka#ClusterState", + "traits": { + "smithy.api#documentation": "

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

", + "smithy.api#jsonName": "state" + } + } + } + }, + "com.amazonaws.kafka#DeleteConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#DeleteConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.kafka#DeleteConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an MSK Configuration.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/configurations/{Arn}", + "code": 200 + } + } + }, + "com.amazonaws.kafka#DeleteConfigurationRequest": { + "type": "structure", + "members": { + "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The current version of the MSK cluster.

", - "smithy.api#httpQuery": "currentVersion" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } }, - "com.amazonaws.kafka#DeleteClusterResponse": { + "com.amazonaws.kafka#DeleteConfigurationResponse": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.kafka#ClusterState", + "Arn": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

", - "smithy.api#jsonName": "state" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

", + "smithy.api#jsonName": "arn" } }, - "ClusterArn": { - "target": "com.amazonaws.kafka#__string", + "State": { + "target": "com.amazonaws.kafka#ConfigurationState", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", - "smithy.api#jsonName": "clusterArn" + "smithy.api#documentation": "

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

", + "smithy.api#jsonName": "state" } } } @@ -1221,11 +1499,18 @@ "com.amazonaws.kafka#DescribeConfigurationResponse": { "type": "structure", "members": { - "KafkaVersions": { - "target": "com.amazonaws.kafka#__listOf__string", + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The versions of Apache Kafka with which you can use this MSK configuration.

", - "smithy.api#jsonName": "kafkaVersions" + "smithy.api#documentation": "

The time when the configuration was created.

", + "smithy.api#jsonName": "creationTime" + } + }, + "Name": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The name of the configuration.

", + "smithy.api#jsonName": "name" } }, "LatestRevision": { @@ -1235,13 +1520,6 @@ "smithy.api#jsonName": "latestRevision" } }, - "Description": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The description of the configuration.

", - "smithy.api#jsonName": "description" - } - }, "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -1249,18 +1527,25 @@ "smithy.api#jsonName": "arn" } }, - "Name": { - "target": "com.amazonaws.kafka#__string", + "KafkaVersions": { + "target": "com.amazonaws.kafka#__listOf__string", "traits": { - "smithy.api#documentation": "

The name of the configuration.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The versions of Apache Kafka with which you can use this MSK configuration.

", + "smithy.api#jsonName": "kafkaVersions" } }, - "CreationTime": { - "target": "com.amazonaws.kafka#__timestampIso8601", + "State": { + "target": "com.amazonaws.kafka#ConfigurationState", "traits": { - "smithy.api#documentation": "

The time when the configuration was created.

", - "smithy.api#jsonName": "creationTime" + "smithy.api#documentation": "

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

", + "smithy.api#jsonName": "state" + } + }, + "Description": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The description of the configuration.

", + "smithy.api#jsonName": "description" } } } @@ -1305,18 +1590,18 @@ "com.amazonaws.kafka#DescribeConfigurationRevisionRequest": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.kafka#__string", + "Revision": { + "target": "com.amazonaws.kafka#__long", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

", + "smithy.api#documentation": "

A string that uniquely identifies a revision of an MSK configuration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Revision": { - "target": "com.amazonaws.kafka#__long", + "Arn": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

A string that uniquely identifies a revision of an MSK configuration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1326,18 +1611,11 @@ "com.amazonaws.kafka#DescribeConfigurationRevisionResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", - "smithy.api#jsonName": "arn" - } - }, - "CreationTime": { - "target": "com.amazonaws.kafka#__timestampIso8601", + "ServerProperties": { + "target": "com.amazonaws.kafka#__blob", "traits": { - "smithy.api#documentation": "

The time when the configuration was created.

", - "smithy.api#jsonName": "creationTime" + "smithy.api#documentation": "

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

", + "smithy.api#jsonName": "serverProperties" } }, "Description": { @@ -1354,11 +1632,18 @@ "smithy.api#jsonName": "revision" } }, - "ServerProperties": { - "target": "com.amazonaws.kafka#__blob", + "Arn": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

", - "smithy.api#jsonName": "serverProperties" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", + "smithy.api#jsonName": "arn" + } + }, + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time when the configuration was created.

", + "smithy.api#jsonName": "creationTime" } } } @@ -1397,19 +1682,19 @@ "com.amazonaws.kafka#EncryptionInTransit": { "type": "structure", "members": { - "ClientBroker": { - "target": "com.amazonaws.kafka#ClientBroker", - "traits": { - "smithy.api#documentation": "

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

\n

\n TLS means that client-broker communication is enabled with TLS only.

\n

\n TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

\n

\n PLAINTEXT means that client-broker communication is enabled in plaintext only.

\n

The default value is TLS_PLAINTEXT.

", - "smithy.api#jsonName": "clientBroker" - } - }, "InCluster": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

\n

The default value is true.

", "smithy.api#jsonName": "inCluster" } + }, + "ClientBroker": { + "target": "com.amazonaws.kafka#ClientBroker", + "traits": { + "smithy.api#documentation": "

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

\n

\n TLS means that client-broker communication is enabled with TLS only.

\n

\n TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

\n

\n PLAINTEXT means that client-broker communication is enabled in plaintext only.

\n

The default value is TLS_PLAINTEXT.

", + "smithy.api#jsonName": "clientBroker" + } } }, "traits": { @@ -1419,19 +1704,19 @@ "com.amazonaws.kafka#EncryptionInfo": { "type": "structure", "members": { - "EncryptionInTransit": { - "target": "com.amazonaws.kafka#EncryptionInTransit", - "traits": { - "smithy.api#documentation": "

The details for encryption in transit.

", - "smithy.api#jsonName": "encryptionInTransit" - } - }, "EncryptionAtRest": { "target": "com.amazonaws.kafka#EncryptionAtRest", "traits": { "smithy.api#documentation": "

The data-volume encryption details.

", "smithy.api#jsonName": "encryptionAtRest" } + }, + "EncryptionInTransit": { + "target": "com.amazonaws.kafka#EncryptionInTransit", + "traits": { + "smithy.api#documentation": "

The details for encryption in transit.

", + "smithy.api#jsonName": "encryptionInTransit" + } } }, "traits": { @@ -1572,11 +1857,11 @@ "com.amazonaws.kafka#GetBootstrapBrokersResponse": { "type": "structure", "members": { - "BootstrapBrokerStringTls": { + "BootstrapBrokerStringSaslScram": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

A string containing one or more DNS names (or IP) and TLS port pairs.

", - "smithy.api#jsonName": "bootstrapBrokerStringTls" + "smithy.api#documentation": "

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

", + "smithy.api#jsonName": "bootstrapBrokerStringSaslScram" } }, "BootstrapBrokerString": { @@ -1585,6 +1870,13 @@ "smithy.api#documentation": "

A string containing one or more hostname:port pairs.

", "smithy.api#jsonName": "bootstrapBrokerString" } + }, + "BootstrapBrokerStringTls": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

A string containing one or more DNS names (or IP) and TLS port pairs.

", + "smithy.api#jsonName": "bootstrapBrokerStringTls" + } } } }, @@ -1655,18 +1947,18 @@ "com.amazonaws.kafka#InternalServerErrorException": { "type": "structure", "members": { - "Message": { + "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The description of the error.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

The parameter that caused the error.

", + "smithy.api#jsonName": "invalidParameter" } }, - "InvalidParameter": { + "Message": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The parameter that caused the error.

", - "smithy.api#jsonName": "invalidParameter" + "smithy.api#documentation": "

The description of the error.

", + "smithy.api#jsonName": "message" } } }, @@ -1712,6 +2004,12 @@ "type": "service", "version": "2018-11-14", "operations": [ + { + "target": "com.amazonaws.kafka#BatchAssociateScramSecret" + }, + { + "target": "com.amazonaws.kafka#BatchDisassociateScramSecret" + }, { "target": "com.amazonaws.kafka#CreateCluster" }, @@ -1721,6 +2019,9 @@ { "target": "com.amazonaws.kafka#DeleteCluster" }, + { + "target": "com.amazonaws.kafka#DeleteConfiguration" + }, { "target": "com.amazonaws.kafka#DescribeCluster" }, @@ -1757,6 +2058,9 @@ { "target": "com.amazonaws.kafka#ListNodes" }, + { + "target": "com.amazonaws.kafka#ListScramSecrets" + }, { "target": "com.amazonaws.kafka#ListTagsForResource" }, @@ -1781,6 +2085,9 @@ { "target": "com.amazonaws.kafka#UpdateClusterKafkaVersion" }, + { + "target": "com.amazonaws.kafka#UpdateConfiguration" + }, { "target": "com.amazonaws.kafka#UpdateMonitoring" } @@ -1803,17 +2110,17 @@ "com.amazonaws.kafka#KafkaVersion": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.kafka#KafkaVersionStatus", - "traits": { - "smithy.api#jsonName": "status" - } - }, "Version": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "version" } + }, + "Status": { + "target": "com.amazonaws.kafka#KafkaVersionStatus", + "traits": { + "smithy.api#jsonName": "status" + } } } }, @@ -1860,17 +2167,24 @@ "method": "GET", "uri": "/v1/clusters/{ClusterArn}/operations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterOperationInfoList", + "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListClusterOperationsRequest": { "type": "structure", "members": { - "NextToken": { + "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "MaxResults": { @@ -1880,12 +2194,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "ClusterArn": { + "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -1893,19 +2206,19 @@ "com.amazonaws.kafka#ListClusterOperationsResponse": { "type": "structure", "members": { - "ClusterOperationInfoList": { - "target": "com.amazonaws.kafka#__listOfClusterOperationInfo", - "traits": { - "smithy.api#documentation": "

An array of cluster operation information objects.

", - "smithy.api#jsonName": "clusterOperationInfoList" - } - }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

", "smithy.api#jsonName": "nextToken" } + }, + "ClusterOperationInfoList": { + "target": "com.amazonaws.kafka#__listOfClusterOperationInfo", + "traits": { + "smithy.api#documentation": "

An array of cluster operation information objects.

", + "smithy.api#jsonName": "clusterOperationInfoList" + } } } }, @@ -1937,6 +2250,12 @@ "method": "GET", "uri": "/v1/clusters", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterInfoList", + "pageSize": "MaxResults" } } }, @@ -1950,38 +2269,38 @@ "smithy.api#httpQuery": "nextToken" } }, - "ClusterNameFilter": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

", - "smithy.api#httpQuery": "clusterNameFilter" - } - }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

", "smithy.api#httpQuery": "maxResults" } + }, + "ClusterNameFilter": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

", + "smithy.api#httpQuery": "clusterNameFilter" + } } } }, "com.amazonaws.kafka#ListClustersResponse": { "type": "structure", "members": { - "ClusterInfoList": { - "target": "com.amazonaws.kafka#__listOfClusterInfo", - "traits": { - "smithy.api#documentation": "

Information on each of the MSK clusters in the response.

", - "smithy.api#jsonName": "clusterInfoList" - } - }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.

", "smithy.api#jsonName": "nextToken" } + }, + "ClusterInfoList": { + "target": "com.amazonaws.kafka#__listOfClusterInfo", + "traits": { + "smithy.api#documentation": "

Information on each of the MSK clusters in the response.

", + "smithy.api#jsonName": "clusterInfoList" + } } } }, @@ -2019,12 +2338,26 @@ "method": "GET", "uri": "/v1/configurations/{Arn}/revisions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Revisions", + "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListConfigurationRevisionsRequest": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -2038,33 +2371,25 @@ "smithy.api#documentation": "

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

", "smithy.api#httpQuery": "maxResults" } - }, - "Arn": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.kafka#ListConfigurationRevisionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

Paginated results marker.

", - "smithy.api#jsonName": "nextToken" - } - }, "Revisions": { "target": "com.amazonaws.kafka#__listOfConfigurationRevision", "traits": { "smithy.api#documentation": "

List of ConfigurationRevision objects.

", "smithy.api#jsonName": "revisions" } + }, + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

Paginated results marker.

", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -2099,6 +2424,12 @@ "method": "GET", "uri": "/v1/configurations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Configurations", + "pageSize": "MaxResults" } } }, @@ -2168,6 +2499,12 @@ "method": "GET", "uri": "/v1/kafka-versions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "KafkaVersions", + "pageSize": "MaxResults" } } }, @@ -2235,17 +2572,23 @@ "method": "GET", "uri": "/v1/clusters/{ClusterArn}/nodes", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NodeInfoList", + "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListNodesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.kafka#__string", + "MaxResults": { + "target": "com.amazonaws.kafka#MaxResults", "traits": { - "smithy.api#documentation": "

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

", + "smithy.api#httpQuery": "maxResults" } }, "ClusterArn": { @@ -2256,11 +2599,11 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.kafka#MaxResults", + "NextToken": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -2284,6 +2627,98 @@ } } }, + "com.amazonaws.kafka#ListScramSecrets": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#ListScramSecretsRequest" + }, + "output": { + "target": "com.amazonaws.kafka#ListScramSecretsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/clusters/{ClusterArn}/scram-secrets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecretArnList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kafka#ListScramSecretsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The nextToken of the query.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.kafka#MaxResults", + "traits": { + "smithy.api#documentation": "

The maxResults of the query.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The arn of the cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kafka#ListScramSecretsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

Paginated results marker.

", + "smithy.api#jsonName": "nextToken" + } + }, + "SecretArnList": { + "target": "com.amazonaws.kafka#__listOf__string", + "traits": { + "smithy.api#documentation": "

The list of scram secrets associated with the cluster.

", + "smithy.api#jsonName": "secretArnList" + } + } + } + }, "com.amazonaws.kafka#ListTagsForResource": { "type": "operation", "input": { @@ -2361,6 +2796,20 @@ "com.amazonaws.kafka#MutableClusterInfo": { "type": "structure", "members": { + "OpenMonitoring": { + "target": "com.amazonaws.kafka#OpenMonitoring", + "traits": { + "smithy.api#documentation": "

The settings for open monitoring.

", + "smithy.api#jsonName": "openMonitoring" + } + }, + "ConfigurationInfo": { + "target": "com.amazonaws.kafka#ConfigurationInfo", + "traits": { + "smithy.api#documentation": "

Information about the changes in the configuration of the brokers.

", + "smithy.api#jsonName": "configurationInfo" + } + }, "LoggingInfo": { "target": "com.amazonaws.kafka#LoggingInfo", "traits": { @@ -2374,13 +2823,6 @@ "smithy.api#jsonName": "enhancedMonitoring" } }, - "OpenMonitoring": { - "target": "com.amazonaws.kafka#OpenMonitoring", - "traits": { - "smithy.api#documentation": "

The settings for open monitoring.

", - "smithy.api#jsonName": "openMonitoring" - } - }, "KafkaVersion": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -2388,13 +2830,6 @@ "smithy.api#jsonName": "kafkaVersion" } }, - "NumberOfBrokerNodes": { - "target": "com.amazonaws.kafka#__integer", - "traits": { - "smithy.api#documentation": "

The number of broker nodes in the cluster.

", - "smithy.api#jsonName": "numberOfBrokerNodes" - } - }, "BrokerEBSVolumeInfo": { "target": "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo", "traits": { @@ -2402,11 +2837,11 @@ "smithy.api#jsonName": "brokerEBSVolumeInfo" } }, - "ConfigurationInfo": { - "target": "com.amazonaws.kafka#ConfigurationInfo", + "NumberOfBrokerNodes": { + "target": "com.amazonaws.kafka#__integer", "traits": { - "smithy.api#documentation": "

Information about the changes in the configuration of the brokers.

", - "smithy.api#jsonName": "configurationInfo" + "smithy.api#documentation": "

The number of broker nodes in the cluster.

", + "smithy.api#jsonName": "numberOfBrokerNodes" } } }, @@ -2456,25 +2891,25 @@ "smithy.api#jsonName": "nodeType" } }, - "AddedToClusterTime": { - "target": "com.amazonaws.kafka#__string", + "ZookeeperNodeInfo": { + "target": "com.amazonaws.kafka#ZookeeperNodeInfo", "traits": { - "smithy.api#documentation": "

The start time.

", - "smithy.api#jsonName": "addedToClusterTime" + "smithy.api#documentation": "

The ZookeeperNodeInfo.

", + "smithy.api#jsonName": "zookeeperNodeInfo" } }, - "InstanceType": { + "NodeARN": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The instance type.

", - "smithy.api#jsonName": "instanceType" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the node.

", + "smithy.api#jsonName": "nodeARN" } }, - "NodeARN": { + "AddedToClusterTime": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the node.

", - "smithy.api#jsonName": "nodeARN" + "smithy.api#documentation": "

The start time.

", + "smithy.api#jsonName": "addedToClusterTime" } }, "BrokerNodeInfo": { @@ -2484,11 +2919,11 @@ "smithy.api#jsonName": "brokerNodeInfo" } }, - "ZookeeperNodeInfo": { - "target": "com.amazonaws.kafka#ZookeeperNodeInfo", + "InstanceType": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The ZookeeperNodeInfo.

", - "smithy.api#jsonName": "zookeeperNodeInfo" + "smithy.api#documentation": "

The instance type.

", + "smithy.api#jsonName": "instanceType" } } }, @@ -2511,18 +2946,18 @@ "com.amazonaws.kafka#NotFoundException": { "type": "structure", "members": { - "Message": { + "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The description of the error.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

The parameter that caused the error.

", + "smithy.api#jsonName": "invalidParameter" } }, - "InvalidParameter": { + "Message": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The parameter that caused the error.

", - "smithy.api#jsonName": "invalidParameter" + "smithy.api#documentation": "

The description of the error.

", + "smithy.api#jsonName": "message" } } }, @@ -2589,19 +3024,19 @@ "com.amazonaws.kafka#PrometheusInfo": { "type": "structure", "members": { - "NodeExporter": { - "target": "com.amazonaws.kafka#NodeExporterInfo", - "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

", - "smithy.api#jsonName": "nodeExporter" - } - }, "JmxExporter": { "target": "com.amazonaws.kafka#JmxExporterInfo", "traits": { "smithy.api#documentation": "

Indicates whether you want to enable or disable the JMX Exporter.

", "smithy.api#jsonName": "jmxExporter" } + }, + "NodeExporter": { + "target": "com.amazonaws.kafka#NodeExporterInfo", + "traits": { + "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

", + "smithy.api#jsonName": "nodeExporter" + } } }, "traits": { @@ -2654,7 +3089,7 @@ "BrokerIds": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { - "smithy.api#documentation": "

The list of broker IDs to be rebooted.

", + "smithy.api#documentation": "

The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.

", "smithy.api#jsonName": "brokerIds", "smithy.api#required": {} } @@ -2675,18 +3110,18 @@ "com.amazonaws.kafka#RebootBrokerResponse": { "type": "structure", "members": { - "ClusterArn": { + "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", - "smithy.api#jsonName": "clusterArn" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", + "smithy.api#jsonName": "clusterOperationArn" } }, - "ClusterOperationArn": { + "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", - "smithy.api#jsonName": "clusterOperationArn" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" } } } @@ -2694,12 +3129,6 @@ "com.amazonaws.kafka#S3": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#jsonName": "prefix" - } - }, "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { @@ -2712,7 +3141,43 @@ "traits": { "smithy.api#jsonName": "bucket" } + }, + "Prefix": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#jsonName": "prefix" + } + } + } + }, + "com.amazonaws.kafka#Sasl": { + "type": "structure", + "members": { + "Scram": { + "target": "com.amazonaws.kafka#Scram", + "traits": { + "smithy.api#documentation": "

Details for SASL/SCRAM client authentication.

", + "smithy.api#jsonName": "scram" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for client authentication using SASL.

" + } + }, + "com.amazonaws.kafka#Scram": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.kafka#__boolean", + "traits": { + "smithy.api#documentation": "

SASL/SCRAM authentication is enabled or not.

", + "smithy.api#jsonName": "enabled" + } } + }, + "traits": { + "smithy.api#documentation": "

Details for SASL/SCRAM client authentication.

" } }, "com.amazonaws.kafka#ServiceUnavailableException": { @@ -2742,16 +3207,16 @@ "com.amazonaws.kafka#StateInfo": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#jsonName": "code" + "smithy.api#jsonName": "message" } }, - "Message": { + "Code": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#jsonName": "message" + "smithy.api#jsonName": "code" } } } @@ -2832,7 +3297,31 @@ "smithy.api#documentation": "

Details for client authentication using TLS.

" } }, - "com.amazonaws.kafka#TooManyRequestsException": { + "com.amazonaws.kafka#TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The description of the error.

", + "smithy.api#jsonName": "message" + } + }, + "InvalidParameter": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The parameter that caused the error.

", + "smithy.api#jsonName": "invalidParameter" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns information about an error.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.kafka#UnauthorizedException": { "type": "structure", "members": { "Message": { @@ -2853,31 +3342,36 @@ "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", - "smithy.api#httpError": 429 + "smithy.api#httpError": 401 } }, - "com.amazonaws.kafka#UnauthorizedException": { + "com.amazonaws.kafka#UnprocessedScramSecret": { "type": "structure", "members": { - "InvalidParameter": { + "ErrorMessage": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The parameter that caused the error.

", - "smithy.api#jsonName": "invalidParameter" + "smithy.api#documentation": "

Error message for associate/disassociate failure.

", + "smithy.api#jsonName": "errorMessage" } }, - "Message": { + "ErrorCode": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The description of the error.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

Error code for associate/disassociate failure.

", + "smithy.api#jsonName": "errorCode" + } + }, + "SecretArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

AWS Secrets Manager secret ARN.

", + "smithy.api#jsonName": "secretArn" } } }, "traits": { - "smithy.api#documentation": "

Returns information about an error.

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 + "smithy.api#documentation": "

Error info for scram secret associate/disassociate failure.

" } }, "com.amazonaws.kafka#UntagResource": { @@ -2971,14 +3465,6 @@ "smithy.api#required": {} } }, - "TargetNumberOfBrokerNodes": { - "target": "com.amazonaws.kafka#__integerMin1Max15", - "traits": { - "smithy.api#documentation": "

The number of broker nodes that you want the cluster to have after this operation completes successfully.

", - "smithy.api#jsonName": "targetNumberOfBrokerNodes", - "smithy.api#required": {} - } - }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -2986,24 +3472,32 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TargetNumberOfBrokerNodes": { + "target": "com.amazonaws.kafka#__integerMin1Max15", + "traits": { + "smithy.api#documentation": "

The number of broker nodes that you want the cluster to have after this operation completes successfully.

", + "smithy.api#jsonName": "targetNumberOfBrokerNodes", + "smithy.api#required": {} + } } } }, "com.amazonaws.kafka#UpdateBrokerCountResponse": { "type": "structure", "members": { - "ClusterArn": { + "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", - "smithy.api#jsonName": "clusterArn" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", + "smithy.api#jsonName": "clusterOperationArn" } }, - "ClusterOperationArn": { + "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", - "smithy.api#jsonName": "clusterOperationArn" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" } } } @@ -3045,11 +3539,11 @@ "com.amazonaws.kafka#UpdateBrokerStorageRequest": { "type": "structure", "members": { - "TargetBrokerEBSVolumeInfo": { - "target": "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo", + "CurrentVersion": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Describes the target volume size and the ID of the broker to apply the update to.

", - "smithy.api#jsonName": "targetBrokerEBSVolumeInfo", + "smithy.api#documentation": "

The version of cluster to update from. A successful operation will then generate a new version.

", + "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, @@ -3061,11 +3555,11 @@ "smithy.api#required": {} } }, - "CurrentVersion": { - "target": "com.amazonaws.kafka#__string", + "TargetBrokerEBSVolumeInfo": { + "target": "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo", "traits": { - "smithy.api#documentation": "

The version of cluster to update from. A successful operation will then generate a new version.

", - "smithy.api#jsonName": "currentVersion", + "smithy.api#documentation": "

Describes the target volume size and the ID of the broker to apply the update to.

", + "smithy.api#jsonName": "targetBrokerEBSVolumeInfo", "smithy.api#required": {} } } @@ -3130,11 +3624,11 @@ "com.amazonaws.kafka#UpdateClusterConfigurationRequest": { "type": "structure", "members": { - "ClusterArn": { - "target": "com.amazonaws.kafka#__string", + "ConfigurationInfo": { + "target": "com.amazonaws.kafka#ConfigurationInfo", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Represents the configuration that you want MSK to use for the brokers in a cluster.

", + "smithy.api#jsonName": "configurationInfo", "smithy.api#required": {} } }, @@ -3146,11 +3640,11 @@ "smithy.api#required": {} } }, - "ConfigurationInfo": { - "target": "com.amazonaws.kafka#ConfigurationInfo", + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

Represents the configuration that you want MSK to use for the brokers in a cluster.

", - "smithy.api#jsonName": "configurationInfo", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -3159,18 +3653,18 @@ "com.amazonaws.kafka#UpdateClusterConfigurationResponse": { "type": "structure", "members": { - "ClusterOperationArn": { + "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", - "smithy.api#jsonName": "clusterOperationArn" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" } }, - "ClusterArn": { + "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", - "smithy.api#jsonName": "clusterArn" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", + "smithy.api#jsonName": "clusterOperationArn" } } } @@ -3226,6 +3720,13 @@ "smithy.api#required": {} } }, + "ConfigurationInfo": { + "target": "com.amazonaws.kafka#ConfigurationInfo", + "traits": { + "smithy.api#documentation": "

The custom configuration that should be applied on the new version of cluster.

", + "smithy.api#jsonName": "configurationInfo" + } + }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -3241,31 +3742,108 @@ "smithy.api#jsonName": "targetKafkaVersion", "smithy.api#required": {} } - }, - "ConfigurationInfo": { - "target": "com.amazonaws.kafka#ConfigurationInfo", - "traits": { - "smithy.api#documentation": "

The custom configuration that should be applied on the new version of cluster.

", - "smithy.api#jsonName": "configurationInfo" - } } } }, "com.amazonaws.kafka#UpdateClusterKafkaVersionResponse": { "type": "structure", "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" + } + }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", "smithy.api#jsonName": "clusterOperationArn" } + } + } + }, + "com.amazonaws.kafka#UpdateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#UpdateConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.kafka#UpdateConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" }, - "ClusterArn": { + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an MSK configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/configurations/{Arn}", + "code": 200 + } + } + }, + "com.amazonaws.kafka#UpdateConfigurationRequest": { + "type": "structure", + "members": { + "Description": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", - "smithy.api#jsonName": "clusterArn" + "smithy.api#documentation": "

The description of the configuration revision.

", + "smithy.api#jsonName": "description" + } + }, + "ServerProperties": { + "target": "com.amazonaws.kafka#__blob", + "traits": { + "smithy.api#documentation": "

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

", + "smithy.api#jsonName": "serverProperties", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kafka#UpdateConfigurationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", + "smithy.api#jsonName": "arn" + } + }, + "LatestRevision": { + "target": "com.amazonaws.kafka#ConfigurationRevision", + "traits": { + "smithy.api#documentation": "

Latest revision of the configuration.

", + "smithy.api#jsonName": "latestRevision" } } } @@ -3307,17 +3885,11 @@ "com.amazonaws.kafka#UpdateMonitoringRequest": { "type": "structure", "members": { - "EnhancedMonitoring": { - "target": "com.amazonaws.kafka#EnhancedMonitoring", - "traits": { - "smithy.api#documentation": "

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

", - "smithy.api#jsonName": "enhancedMonitoring" - } - }, - "LoggingInfo": { - "target": "com.amazonaws.kafka#LoggingInfo", + "OpenMonitoring": { + "target": "com.amazonaws.kafka#OpenMonitoringInfo", "traits": { - "smithy.api#jsonName": "loggingInfo" + "smithy.api#documentation": "

The settings for open monitoring.

", + "smithy.api#jsonName": "openMonitoring" } }, "ClusterArn": { @@ -3328,13 +3900,6 @@ "smithy.api#required": {} } }, - "OpenMonitoring": { - "target": "com.amazonaws.kafka#OpenMonitoringInfo", - "traits": { - "smithy.api#documentation": "

The settings for open monitoring.

", - "smithy.api#jsonName": "openMonitoring" - } - }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { @@ -3342,6 +3907,19 @@ "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } + }, + "EnhancedMonitoring": { + "target": "com.amazonaws.kafka#EnhancedMonitoring", + "traits": { + "smithy.api#documentation": "

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

", + "smithy.api#jsonName": "enhancedMonitoring" + } + }, + "LoggingInfo": { + "target": "com.amazonaws.kafka#LoggingInfo", + "traits": { + "smithy.api#jsonName": "loggingInfo" + } } }, "traits": { @@ -3377,25 +3955,18 @@ "smithy.api#jsonName": "zookeeperId" } }, - "ClientVpcIpAddress": { - "target": "com.amazonaws.kafka#__string", - "traits": { - "smithy.api#documentation": "

The virtual private cloud (VPC) IP address of the client.

", - "smithy.api#jsonName": "clientVpcIpAddress" - } - }, - "ZookeeperVersion": { + "AttachedENIId": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The version of Zookeeper.

", - "smithy.api#jsonName": "zookeeperVersion" + "smithy.api#documentation": "

The attached elastic network interface of the broker.

", + "smithy.api#jsonName": "attachedENIId" } }, - "AttachedENIId": { + "ClientVpcIpAddress": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The attached elastic network interface of the broker.

", - "smithy.api#jsonName": "attachedENIId" + "smithy.api#documentation": "

The virtual private cloud (VPC) IP address of the client.

", + "smithy.api#jsonName": "clientVpcIpAddress" } }, "Endpoints": { @@ -3404,6 +3975,13 @@ "smithy.api#documentation": "

Endpoints for accessing the ZooKeeper.

", "smithy.api#jsonName": "endpoints" } + }, + "ZookeeperVersion": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The version of Zookeeper.

", + "smithy.api#jsonName": "zookeeperVersion" + } } }, "traits": { @@ -3494,6 +4072,12 @@ "target": "com.amazonaws.kafka#NodeInfo" } }, + "com.amazonaws.kafka#__listOfUnprocessedScramSecret": { + "type": "list", + "member": { + "target": "com.amazonaws.kafka#UnprocessedScramSecret" + } + }, "com.amazonaws.kafka#__listOf__string": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json b/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json index 5d64b2852ce8..9bf2b70712b6 100644 --- a/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json +++ b/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json @@ -166,10 +166,10 @@ "com.amazonaws.kendra#AdditionalResultAttribute": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.kendra#String", + "ValueType": { + "target": "com.amazonaws.kendra#AdditionalResultAttributeValueType", "traits": { - "smithy.api#documentation": "

The key that identifies the attribute.

", + "smithy.api#documentation": "

The data type of the Value property.

", "smithy.api#required": {} } }, @@ -180,10 +180,10 @@ "smithy.api#required": {} } }, - "ValueType": { - "target": "com.amazonaws.kendra#AdditionalResultAttributeValueType", + "Key": { + "target": "com.amazonaws.kendra#String", "traits": { - "smithy.api#documentation": "

The data type of the Value property.

", + "smithy.api#documentation": "

The key that identifies the attribute.

", "smithy.api#required": {} } } @@ -235,6 +235,18 @@ "com.amazonaws.kendra#AttributeFilter": { "type": "structure", "members": { + "GreaterThan": { + "target": "com.amazonaws.kendra#DocumentAttribute", + "traits": { + "smithy.api#documentation": "

Performs a greater than operation on two document attributes. Use with a document\n attribute of type Integer or Long.

" + } + }, + "ContainsAny": { + "target": "com.amazonaws.kendra#DocumentAttribute", + "traits": { + "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes. This\n filter is only applicable to StringListValue metadata.

" + } + }, "EqualsTo": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { @@ -247,22 +259,16 @@ "smithy.api#documentation": "

Performs a logical AND operation on all supplied filters.

" } }, - "GreaterThan": { - "target": "com.amazonaws.kendra#DocumentAttribute", - "traits": { - "smithy.api#documentation": "

Performs a greater than operation on two document attributes. Use with a document\n attribute of type Integer or Long.

" - } - }, - "ContainsAny": { + "ContainsAll": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes.This\n filter is only appicable to StringListValue metadata.

" + "smithy.api#documentation": "

Returns true when a document contains all of the specified document attributes. This\n filter is only applicable to StringListValue metadata.

" } }, - "LessThanOrEquals": { + "LessThan": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes. Use with a document\n attribute of type Integer or Long.

" + "smithy.api#documentation": "

Performs a less than operation on two document attributes. Use with a document attribute\n of type Integer or Long.

" } }, "NotFilter": { @@ -271,28 +277,22 @@ "smithy.api#documentation": "

Performs a logical NOT operation on all supplied filters.

" } }, - "GreaterThanOrEquals": { - "target": "com.amazonaws.kendra#DocumentAttribute", - "traits": { - "smithy.api#documentation": "

Performs a greater or equals than operation on two document attributes. Use with a\n document attribute of type Integer or Long.

" - } - }, "OrAllFilters": { "target": "com.amazonaws.kendra#AttributeFilterList", "traits": { "smithy.api#documentation": "

Performs a logical OR operation on all supplied filters.

" } }, - "ContainsAll": { + "GreaterThanOrEquals": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains all of the specified document attributes. This\n filter is only appicable to StringListValue metadata.

" + "smithy.api#documentation": "

Performs a greater or equals than operation on two document attributes. Use with a\n document attribute of type Integer or Long.

" } }, - "LessThan": { + "LessThanOrEquals": { "target": "com.amazonaws.kendra#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than operation on two document attributes. Use with a document attribute\n of type Integer or Long.

" + "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes. Use with a document\n attribute of type Integer or Long.

" } } }, @@ -348,15 +348,15 @@ "smithy.api#required": {} } }, - "DataSourceSyncJobMetricTarget": { - "target": "com.amazonaws.kendra#DataSourceSyncJobMetricTarget" - }, "DocumentIdList": { "target": "com.amazonaws.kendra#DocumentIdList", "traits": { "smithy.api#documentation": "

One or more identifiers for documents to delete from the index.

", "smithy.api#required": {} } + }, + "DataSourceSyncJobMetricTarget": { + "target": "com.amazonaws.kendra#DataSourceSyncJobMetricTarget" } } }, @@ -380,17 +380,17 @@ "smithy.api#documentation": "

The error code for why the document couldn't be removed from the index.

" } }, - "ErrorMessage": { - "target": "com.amazonaws.kendra#ErrorMessage", - "traits": { - "smithy.api#documentation": "

An explanation for why the document couldn't be removed from the index.

" - } - }, "Id": { "target": "com.amazonaws.kendra#DocumentId", "traits": { "smithy.api#documentation": "

The identifier of the document that couldn't be removed from the index.

" } + }, + "ErrorMessage": { + "target": "com.amazonaws.kendra#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An explanation for why the document couldn't be removed from the index.

" + } } }, "traits": { @@ -448,18 +448,18 @@ "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.kendra#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role that is allowed to run the\n BatchPutDocument operation. For more information, see IAM Roles for\n Amazon Kendra.

" - } - }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { "smithy.api#documentation": "

The identifier of the index to add the documents to. You need to create the index first\n using the CreateIndex operation.

", "smithy.api#required": {} } + }, + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role that is allowed to run the\n BatchPutDocument operation. For more information, see IAM Roles for\n Amazon Kendra.

" + } } } }, @@ -483,17 +483,17 @@ "smithy.api#documentation": "

The type of error that caused the document to fail to be indexed.

" } }, - "ErrorMessage": { - "target": "com.amazonaws.kendra#ErrorMessage", - "traits": { - "smithy.api#documentation": "

A description of the reason why the document could not be indexed.

" - } - }, "Id": { "target": "com.amazonaws.kendra#DocumentId", "traits": { "smithy.api#documentation": "

The unique identifier of the document.

" } + }, + "ErrorMessage": { + "target": "com.amazonaws.kendra#ErrorMessage", + "traits": { + "smithy.api#documentation": "

A description of the reason why the document could not be indexed.

" + } } }, "traits": { @@ -515,17 +515,17 @@ "com.amazonaws.kendra#CapacityUnitsConfiguration": { "type": "structure", "members": { - "QueryCapacityUnits": { - "target": "com.amazonaws.kendra#QueryCapacityUnit", + "StorageCapacityUnits": { + "target": "com.amazonaws.kendra#StorageCapacityUnit", "traits": { - "smithy.api#documentation": "

The amount of extra query capacity for an index. Each capacity unit provides 0.5\n queries per second and 40,000 queries per day.

", + "smithy.api#documentation": "

The amount of extra storage capacity for an index. Each capacity unit provides 150 Gb\n of storage space or 500,000 documents, whichever is reached first.

", "smithy.api#required": {} } }, - "StorageCapacityUnits": { - "target": "com.amazonaws.kendra#StorageCapacityUnit", + "QueryCapacityUnits": { + "target": "com.amazonaws.kendra#QueryCapacityUnit", "traits": { - "smithy.api#documentation": "

The amount of extra storage capacity for an index. Each capacity unit provides 150 Gb\n of storage space or 500,000 documents, whichever is reached first.

", + "smithy.api#documentation": "

The amount of extra query capacity for an index. Each capacity unit provides 0.5\n queries per second and 40,000 queries per day.

", "smithy.api#required": {} } } @@ -549,17 +549,17 @@ "com.amazonaws.kendra#ClickFeedback": { "type": "structure", "members": { - "ClickTime": { - "target": "com.amazonaws.kendra#Timestamp", + "ResultId": { + "target": "com.amazonaws.kendra#ResultId", "traits": { - "smithy.api#documentation": "

The Unix timestamp of the date and time that the result was clicked.

", + "smithy.api#documentation": "

The unique identifier of the search result that was clicked.

", "smithy.api#required": {} } }, - "ResultId": { - "target": "com.amazonaws.kendra#ResultId", + "ClickTime": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier of the search result that was clicked.

", + "smithy.api#documentation": "

The Unix timestamp of the date and time that the result was clicked.

", "smithy.api#required": {} } } @@ -600,6 +600,12 @@ "smithy.api#required": {} } }, + "FieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

An array of objects that map database column names to the corresponding fields in an\n index. You must first create the fields in the index using the UpdateIndex operation.

" + } + }, "DocumentTitleColumnName": { "target": "com.amazonaws.kendra#ColumnName", "traits": { @@ -612,12 +618,6 @@ "smithy.api#documentation": "

The column that provides the document's unique identifier.

", "smithy.api#required": {} } - }, - "FieldMappings": { - "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", - "traits": { - "smithy.api#documentation": "

An array of objects that map database column names to the corresponding fields in an\n index. You must first create the fields in the index using the UpdateIndex operation.

" - } } }, "traits": { @@ -657,10 +657,10 @@ "smithy.api#required": {} } }, - "DatabaseName": { - "target": "com.amazonaws.kendra#DatabaseName", + "DatabaseHost": { + "target": "com.amazonaws.kendra#DatabaseHost", "traits": { - "smithy.api#documentation": "

The name of the database containing the document data.

", + "smithy.api#documentation": "

The name of the host for the database. Can be either a string\n (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

", "smithy.api#required": {} } }, @@ -671,17 +671,17 @@ "smithy.api#required": {} } }, - "DatabaseHost": { - "target": "com.amazonaws.kendra#DatabaseHost", + "TableName": { + "target": "com.amazonaws.kendra#TableName", "traits": { - "smithy.api#documentation": "

The name of the host for the database. Can be either a string\n (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

", + "smithy.api#documentation": "

The name of the table that contains the document data.

", "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.kendra#TableName", + "DatabaseName": { + "target": "com.amazonaws.kendra#DatabaseName", "traits": { - "smithy.api#documentation": "

The name of the table that contains the document data.

", + "smithy.api#documentation": "

The name of the database containing the document data.

", "smithy.api#required": {} } } @@ -752,16 +752,17 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data source that you use to with an Amazon Kendra index.

\n

You specify a name, connector type and description for your data source. You can choose\n between an S3 connector, a SharePoint Online connector, and a database connector.

\n

You also specify configuration information such as document metadata (author, source URI,\n and so on) and user context information.

\n

\n CreateDataSource is a synchronous operation. The operation returns 200 if the\n data source was successfully created. Otherwise, an exception is raised.

" + "smithy.api#documentation": "

Creates a data source that you use to with an Amazon Kendra index.

\n

You specify a name, data source connector type and description for your data source. You\n also specify configuration information such as document metadata (author, source URI, and so\n on) and user context information.

\n

\n CreateDataSource is a synchronous operation. The operation returns 200 if the\n data source was successfully created. Otherwise, an exception is raised.

" } }, "com.amazonaws.kendra#CreateDataSourceRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.kendra#Description", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

A description for the data source.

" + "smithy.api#documentation": "

The identifier of the index that should be associated with this data source.

", + "smithy.api#required": {} } }, "Type": { @@ -774,7 +775,7 @@ "Tags": { "target": "com.amazonaws.kendra#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that identify the data source. You can use the tags\n to identify and organize your resources and to control access to resources.

" + "smithy.api#documentation": "

A list of key-value pairs that identify the data source. You can use the tags to identify\n and organize your resources and to control access to resources.

" } }, "RoleArn": { @@ -784,6 +785,13 @@ "smithy.api#required": {} } }, + "Configuration": { + "target": "com.amazonaws.kendra#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The data source connector configuration information that is required to access the repository.

", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.kendra#DataSourceName", "traits": { @@ -797,18 +805,10 @@ "smithy.api#documentation": "

Sets the frequency that Amazon Kendra will check the documents in your repository and\n update the index. If you don't set a schedule Amazon Kendra will not periodically update the\n index. You can call the StartDataSourceSyncJob operation to update the\n index.

" } }, - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", - "traits": { - "smithy.api#documentation": "

The identifier of the index that should be associated with this data source.

", - "smithy.api#required": {} - } - }, - "Configuration": { - "target": "com.amazonaws.kendra#DataSourceConfiguration", + "Description": { + "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "

The connector configuration information that is required to access the repository.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the data source.

" } } } @@ -870,19 +870,25 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.kendra#TagList", + "FileFormat": { + "target": "com.amazonaws.kendra#FaqFileFormat", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that identify the FAQ. You can use the tags\n to identify and organize your resources and to control access to resources.

" + "smithy.api#documentation": "

The format of the input file. You can choose between a basic CSV format, a CSV format\n that includes customs attributes in a header, and a JSON format that includes custom\n attributes.

\n

The format must match the format of the file stored in the S3 bucket identified in the\n S3Path parameter.

\n

For more information, see Adding questions and\n answers.

" } }, - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "

The identifier of the index that contains the FAQ.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that\n contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

", "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.kendra#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that identify the FAQ. You can use the tags to identify and\n organize your resources and to control access to resources.

" + } + }, "S3Path": { "target": "com.amazonaws.kendra#S3Path", "traits": { @@ -896,10 +902,10 @@ "smithy.api#documentation": "

A description of the FAQ.

" } }, - "RoleArn": { - "target": "com.amazonaws.kendra#RoleArn", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to\n access the S3 bucket that contains the FAQs. For more information, see IAM Roles for\n Amazon Kendra.

", + "smithy.api#documentation": "

The identifier of the index that contains the FAQ.

", "smithy.api#required": {} } } @@ -960,43 +966,43 @@ "smithy.api#documentation": "

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by\n Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

" } }, - "Name": { - "target": "com.amazonaws.kendra#IndexName", + "Description": { + "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "

The name for the new index.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the index.

" } }, - "Tags": { - "target": "com.amazonaws.kendra#TagList", + "ClientToken": { + "target": "com.amazonaws.kendra#ClientTokenName", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that identify the index. You can use the tags to identify and\n organize your resources and to control access to resources.

" + "smithy.api#documentation": "

A token that you provide to identify the request to create an index. Multiple calls to the\n CreateIndex operation with the same client token will create only one\n index.”

", + "smithy.api#idempotencyToken": {} } }, - "Edition": { - "target": "com.amazonaws.kendra#IndexEdition", + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for\n indexes intended for development, testing, or proof of concept. Use\n ENTERPRISE_EDITION for your production databases. Once you set the edition for\n an index, it can't be changed.

" + "smithy.api#documentation": "

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and\n metrics. This is also the role used when you use the BatchPutDocument operation\n to index documents from an Amazon S3 bucket.

", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.kendra#Description", + "Edition": { + "target": "com.amazonaws.kendra#IndexEdition", "traits": { - "smithy.api#documentation": "

A description for the index.

" + "smithy.api#documentation": "

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for\n indexes intended for development, testing, or proof of concept. Use\n ENTERPRISE_EDITION for your production databases. Once you set the edition for\n an index, it can't be changed.

\n

The Edition parameter is optional. If you don't supply a value, the default\n is ENTERPRISE_EDITION.

" } }, - "RoleArn": { - "target": "com.amazonaws.kendra#RoleArn", + "Tags": { + "target": "com.amazonaws.kendra#TagList", "traits": { - "smithy.api#documentation": "

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and\n metrics. This is also the role used when you use the BatchPutDocument operation\n to index documents from an Amazon S3 bucket.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of key-value pairs that identify the index. You can use the tags to identify and\n organize your resources and to control access to resources.

" } }, - "ClientToken": { - "target": "com.amazonaws.kendra#ClientTokenName", + "Name": { + "target": "com.amazonaws.kendra#IndexName", "traits": { - "smithy.api#documentation": "

A token that you provide to identify the request to create an index. Multiple calls to the\n CreateIndex operation with the same client token will create only one\n index.”

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The name for the new index.

", + "smithy.api#required": {} } } } @@ -1015,10 +1021,16 @@ "com.amazonaws.kendra#DataSourceConfiguration": { "type": "structure", "members": { + "ServiceNowConfiguration": { + "target": "com.amazonaws.kendra#ServiceNowConfiguration", + "traits": { + "smithy.api#documentation": "

Provides configuration for data sources that connect to ServiceNow instances.

" + } + }, "SharePointConfiguration": { "target": "com.amazonaws.kendra#SharePointConfiguration", "traits": { - "smithy.api#documentation": "

Provides information necessary to create a connector for a Microsoft SharePoint\n site.

" + "smithy.api#documentation": "

Provides information necessary to create a data source connector for a Microsoft SharePoint\n site.

" } }, "SalesforceConfiguration": { @@ -1027,28 +1039,22 @@ "smithy.api#documentation": "

Provides configuration information for data sources that connect to a Salesforce\n site.

" } }, - "ServiceNowConfiguration": { - "target": "com.amazonaws.kendra#ServiceNowConfiguration", - "traits": { - "smithy.api#documentation": "

Provides configuration for data sources that connect to ServiceNow instances.

" - } - }, - "OneDriveConfiguration": { - "target": "com.amazonaws.kendra#OneDriveConfiguration", + "S3Configuration": { + "target": "com.amazonaws.kendra#S3DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Provided configuration for data sources that connect to Microsoft OneDrive.

" + "smithy.api#documentation": "

Provides information to create a data source connector for a document repository in an Amazon S3\n bucket.

" } }, "DatabaseConfiguration": { "target": "com.amazonaws.kendra#DatabaseConfiguration", "traits": { - "smithy.api#documentation": "

Provides information necessary to create a connector for a database.

" + "smithy.api#documentation": "

Provides information necessary to create a data source connector for a database.

" } }, - "S3Configuration": { - "target": "com.amazonaws.kendra#S3DataSourceConfiguration", + "OneDriveConfiguration": { + "target": "com.amazonaws.kendra#OneDriveConfiguration", "traits": { - "smithy.api#documentation": "

Provides information to create a connector for a document repository in an Amazon S3\n bucket.

" + "smithy.api#documentation": "

Provided configuration for data sources that connect to Microsoft OneDrive.

" } } }, @@ -1103,7 +1109,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 150 + "max": 50 } } }, @@ -1147,22 +1153,16 @@ "com.amazonaws.kendra#DataSourceSummary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#DataSourceId", + "CreatedAt": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier for the data source.

" + "smithy.api#documentation": "

The UNIX datetime that the data source was created.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.kendra#Timestamp", - "traits": { - "smithy.api#documentation": "

The UNIX datetime that the data source was lasted updated.

" - } - }, - "Name": { - "target": "com.amazonaws.kendra#DataSourceName", + "Status": { + "target": "com.amazonaws.kendra#DataSourceStatus", "traits": { - "smithy.api#documentation": "

The name of the data source.

" + "smithy.api#documentation": "

The status of the data source. When the status is ATIVE the data source\n is ready to use.

" } }, "Type": { @@ -1171,16 +1171,22 @@ "smithy.api#documentation": "

The type of the data source.

" } }, - "Status": { - "target": "com.amazonaws.kendra#DataSourceStatus", + "UpdatedAt": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the data source. When the status is ATIVE the data source\n is ready to use.

" + "smithy.api#documentation": "

The UNIX datetime that the data source was lasted updated.

" } }, - "CreatedAt": { - "target": "com.amazonaws.kendra#Timestamp", + "Name": { + "target": "com.amazonaws.kendra#DataSourceName", "traits": { - "smithy.api#documentation": "

The UNIX datetime that the data source was created.

" + "smithy.api#documentation": "

The name of the data source.

" + } + }, + "Id": { + "target": "com.amazonaws.kendra#DataSourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the data source.

" } } }, @@ -1203,10 +1209,10 @@ "smithy.api#documentation": "

The UNIX datetime that the synchronization job was started.

" } }, - "ExecutionId": { - "target": "com.amazonaws.kendra#String", + "ErrorCode": { + "target": "com.amazonaws.kendra#ErrorCode", "traits": { - "smithy.api#documentation": "

A unique identifier for the synchronization job.

" + "smithy.api#documentation": "

If the Status field is set to FAILED, the\n ErrorCode field contains a the reason that the synchronization\n failed.

" } }, "DataSourceErrorCode": { @@ -1221,10 +1227,10 @@ "smithy.api#documentation": "

If the Status field is set to ERROR, the\n ErrorMessage field contains a description of the error that caused the\n synchronization to fail.

" } }, - "Metrics": { - "target": "com.amazonaws.kendra#DataSourceSyncJobMetrics", + "ExecutionId": { + "target": "com.amazonaws.kendra#String", "traits": { - "smithy.api#documentation": "

Maps a batch delete document request to a specific data source sync job. This is\n optional and should only be supplied when documents are deleted by a connector.

" + "smithy.api#documentation": "

A unique identifier for the synchronization job.

" } }, "Status": { @@ -1233,16 +1239,16 @@ "smithy.api#documentation": "

The execution status of the synchronization job. When the Status field is\n set to SUCCEEDED, the synchronization job is done. If the status code is\n set to FAILED, the ErrorCode and ErrorMessage\n fields give you the reason for the failure.

" } }, - "EndTime": { - "target": "com.amazonaws.kendra#Timestamp", + "Metrics": { + "target": "com.amazonaws.kendra#DataSourceSyncJobMetrics", "traits": { - "smithy.api#documentation": "

The UNIX datetime that the synchronization job was completed.

" + "smithy.api#documentation": "

Maps a batch delete document request to a specific data source sync job. This is\n optional and should only be supplied when documents are deleted by a data source connector.

" } }, - "ErrorCode": { - "target": "com.amazonaws.kendra#ErrorCode", + "EndTime": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

If the Status field is set to FAILED, the\n ErrorCode field contains a the reason that the synchronization\n failed.

" + "smithy.api#documentation": "

The UNIX datetime that the synchronization job was completed.

" } } }, @@ -1303,12 +1309,6 @@ "smithy.api#documentation": "

The number of documents modified in the data source up to now in the data source sync\n run.

" } }, - "DocumentsScanned": { - "target": "com.amazonaws.kendra#MetricValue", - "traits": { - "smithy.api#documentation": "

The current number of documents crawled by the current sync job in the data\n source.

" - } - }, "DocumentsDeleted": { "target": "com.amazonaws.kendra#MetricValue", "traits": { @@ -1320,10 +1320,16 @@ "traits": { "smithy.api#documentation": "

The number of documents added from the data source up to now in the data source\n sync.

" } + }, + "DocumentsScanned": { + "target": "com.amazonaws.kendra#MetricValue", + "traits": { + "smithy.api#documentation": "

The current number of documents crawled by the current sync job in the data\n source.

" + } } }, "traits": { - "smithy.api#documentation": "

Maps a batch delete document request to a specific data source sync job. This is\n optional and should only be supplied when documents are deleted by a connector.

" + "smithy.api#documentation": "

Maps a batch delete document request to a specific data source sync job. This is\n optional and should only be supplied when documents are deleted by a data source connector.

" } }, "com.amazonaws.kendra#DataSourceSyncJobStatus": { @@ -1364,6 +1370,13 @@ "com.amazonaws.kendra#DataSourceToIndexFieldMapping": { "type": "structure", "members": { + "IndexFieldName": { + "target": "com.amazonaws.kendra#IndexFieldName", + "traits": { + "smithy.api#documentation": "

The name of the field in the index.

", + "smithy.api#required": {} + } + }, "DataSourceFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { @@ -1376,13 +1389,6 @@ "traits": { "smithy.api#documentation": "

The type of data stored in the column or attribute.

" } - }, - "IndexFieldName": { - "target": "com.amazonaws.kendra#IndexFieldName", - "traits": { - "smithy.api#documentation": "

The name of the field in the index.

", - "smithy.api#required": {} - } } }, "traits": { @@ -1435,17 +1441,17 @@ "com.amazonaws.kendra#DataSourceVpcConfiguration": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.kendra#SecurityGroupIdList", + "SubnetIds": { + "target": "com.amazonaws.kendra#SubnetIdList", "traits": { - "smithy.api#documentation": "

A list of identifiers of security groups within your Amazon VPC. The security groups\n should enable Amazon Kendra to connect to the data source.

", + "smithy.api#documentation": "

A list of identifiers for subnets within your Amazon VPC. The subnets should be able\n to connect to each other in the VPC, and they should have outgoing access to the\n Internet through a NAT device.

", "smithy.api#required": {} } }, - "SubnetIds": { - "target": "com.amazonaws.kendra#SubnetIdList", + "SecurityGroupIds": { + "target": "com.amazonaws.kendra#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of identifiers for subnets within your Amazon VPC. The subnets should be able\n to connect to each other in the VPC, and they should have outgoing access to the\n Internet through a NAT device.

", + "smithy.api#documentation": "

A list of identifiers of security groups within your Amazon VPC. The security groups\n should enable Amazon Kendra to connect to the data source.

", "smithy.api#required": {} } } @@ -1457,10 +1463,16 @@ "com.amazonaws.kendra#DatabaseConfiguration": { "type": "structure", "members": { - "ConnectionConfiguration": { - "target": "com.amazonaws.kendra#ConnectionConfiguration", + "SqlConfiguration": { + "target": "com.amazonaws.kendra#SqlConfiguration", "traits": { - "smithy.api#documentation": "

The information necessary to connect to a database.

", + "smithy.api#documentation": "

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when\n querying a database data source.

" + } + }, + "DatabaseEngineType": { + "target": "com.amazonaws.kendra#DatabaseEngineType", + "traits": { + "smithy.api#documentation": "

The type of database engine that runs the database.

", "smithy.api#required": {} } }, @@ -1471,6 +1483,13 @@ "smithy.api#required": {} } }, + "ConnectionConfiguration": { + "target": "com.amazonaws.kendra#ConnectionConfiguration", + "traits": { + "smithy.api#documentation": "

The information necessary to connect to a database.

", + "smithy.api#required": {} + } + }, "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration" }, @@ -1479,19 +1498,6 @@ "traits": { "smithy.api#documentation": "

Information about the database column that provides information for user context\n filtering.

" } - }, - "DatabaseEngineType": { - "target": "com.amazonaws.kendra#DatabaseEngineType", - "traits": { - "smithy.api#documentation": "

The type of database engine that runs the database.

", - "smithy.api#required": {} - } - }, - "SqlConfiguration": { - "target": "com.amazonaws.kendra#SqlConfiguration", - "traits": { - "smithy.api#documentation": "

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when\n querying a database data source.

" - } } }, "traits": { @@ -1582,17 +1588,17 @@ "com.amazonaws.kendra#DeleteDataSourceRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#DataSourceId", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source to delete.

", + "smithy.api#documentation": "

The unique identifier of the index associated with the data source.

", "smithy.api#required": {} } }, - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "Id": { + "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "

The unique identifier of the index associated with the data source.

", + "smithy.api#documentation": "

The unique identifier of the data source to delete.

", "smithy.api#required": {} } } @@ -1719,17 +1725,17 @@ "com.amazonaws.kendra#DescribeDataSourceRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#DataSourceId", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source to describe.

", + "smithy.api#documentation": "

The identifier of the index that contains the data source.

", "smithy.api#required": {} } }, - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "Id": { + "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "

The identifier of the index that contains the data source.

", + "smithy.api#documentation": "

The unique identifier of the data source to describe.

", "smithy.api#required": {} } } @@ -1738,46 +1744,46 @@ "com.amazonaws.kendra#DescribeDataSourceResponse": { "type": "structure", "members": { - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "Type": { + "target": "com.amazonaws.kendra#DataSourceType", "traits": { - "smithy.api#documentation": "

The identifier of the index that contains the data source.

" + "smithy.api#documentation": "

The type of the data source.

" } }, - "Status": { - "target": "com.amazonaws.kendra#DataSourceStatus", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

The current status of the data source. When the status is ACTIVE the data\n source is ready to use. When the status is FAILED, the ErrorMessage\n field contains the reason that the data source failed.

" + "smithy.api#documentation": "

The identifier of the index that contains the data source.

" } }, - "Description": { - "target": "com.amazonaws.kendra#Description", + "Configuration": { + "target": "com.amazonaws.kendra#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

The description of the data source.

" + "smithy.api#documentation": "

Information that describes where the data source is located and how the data source is\n configured. The specific information in the description depends on the data source\n provider.

" } }, - "Id": { - "target": "com.amazonaws.kendra#DataSourceId", + "Name": { + "target": "com.amazonaws.kendra#DataSourceName", "traits": { - "smithy.api#documentation": "

The identifier of the data source.

" + "smithy.api#documentation": "

The name that you gave the data source when it was created.

" } }, - "Schedule": { - "target": "com.amazonaws.kendra#ScanSchedule", + "Description": { + "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "

The schedule that Amazon Kendra will update the data source.

" + "smithy.api#documentation": "

The description of the data source.

" } }, - "CreatedAt": { + "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp of when the data source was created.

" + "smithy.api#documentation": "

The Unix timestamp of when the data source was last updated.

" } }, - "Configuration": { - "target": "com.amazonaws.kendra#DataSourceConfiguration", + "Id": { + "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "

Information that describes where the data source is located and how the data source is\n configured. The specific information in the description depends on the data source\n provider.

" + "smithy.api#documentation": "

The identifier of the data source.

" } }, "ErrorMessage": { @@ -1786,28 +1792,28 @@ "smithy.api#documentation": "

When the Status field value is FAILED, the\n ErrorMessage field contains a description of the error that caused the data\n source to fail.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.kendra#Timestamp", + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "

The Unix timestamp of when the data source was last updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that enables the data source to access its\n resources.

" } }, - "Name": { - "target": "com.amazonaws.kendra#DataSourceName", + "CreatedAt": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The name that you gave the data source when it was created.

" + "smithy.api#documentation": "

The Unix timestamp of when the data source was created.

" } }, - "Type": { - "target": "com.amazonaws.kendra#DataSourceType", + "Schedule": { + "target": "com.amazonaws.kendra#ScanSchedule", "traits": { - "smithy.api#documentation": "

The type of the data source.

" + "smithy.api#documentation": "

The schedule that Amazon Kendra will update the data source.

" } }, - "RoleArn": { - "target": "com.amazonaws.kendra#RoleArn", + "Status": { + "target": "com.amazonaws.kendra#DataSourceStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that enables the data source to access its\n resources.

" + "smithy.api#documentation": "

The current status of the data source. When the status is ACTIVE the data\n source is ready to use. When the status is FAILED, the ErrorMessage\n field contains the reason that the data source failed.

" } } } @@ -1844,17 +1850,17 @@ "com.amazonaws.kendra#DescribeFaqRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#FaqId", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

The unique identifier of the FAQ.

", + "smithy.api#documentation": "

The identifier of the index that contains the FAQ.

", "smithy.api#required": {} } }, - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "Id": { + "target": "com.amazonaws.kendra#FaqId", "traits": { - "smithy.api#documentation": "

The identifier of the index that contains the FAQ.

", + "smithy.api#documentation": "

The unique identifier of the FAQ.

", "smithy.api#required": {} } } @@ -1863,10 +1869,10 @@ "com.amazonaws.kendra#DescribeFaqResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#FaqId", + "ErrorMessage": { + "target": "com.amazonaws.kendra#ErrorMessage", "traits": { - "smithy.api#documentation": "

The identifier of the FAQ.

" + "smithy.api#documentation": "

If the Status field is FAILED, the ErrorMessage\n field contains the reason why the FAQ failed.

" } }, "Description": { @@ -1875,13 +1881,22 @@ "smithy.api#documentation": "

The description of the FAQ that you provided when it was created.

" } }, - "S3Path": { - "target": "com.amazonaws.kendra#S3Path" + "Id": { + "target": "com.amazonaws.kendra#FaqId", + "traits": { + "smithy.api#documentation": "

The identifier of the FAQ.

" + } }, - "CreatedAt": { + "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the FAQ was created.

" + "smithy.api#documentation": "

The date and time that the FAQ was last updated.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket\n containing the input files for the FAQ.

" } }, "IndexId": { @@ -1890,10 +1905,13 @@ "smithy.api#documentation": "

The identifier of the index that contains the FAQ.

" } }, - "Status": { - "target": "com.amazonaws.kendra#FaqStatus", + "S3Path": { + "target": "com.amazonaws.kendra#S3Path" + }, + "FileFormat": { + "target": "com.amazonaws.kendra#FaqFileFormat", "traits": { - "smithy.api#documentation": "

The status of the FAQ. It is ready to use when the status is\n ACTIVE.

" + "smithy.api#documentation": "

The file format used by the input files for the FAQ.

" } }, "Name": { @@ -1902,22 +1920,16 @@ "smithy.api#documentation": "

The name that you gave the FAQ when it was created.

" } }, - "RoleArn": { - "target": "com.amazonaws.kendra#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that provides access to\n the S3 bucket containing the input files for the FAQ.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.kendra#ErrorMessage", + "CreatedAt": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

If the Status field is FAILED, the ErrorMessage\n field contains the reason why the FAQ failed.

" + "smithy.api#documentation": "

The date and time that the FAQ was created.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.kendra#Timestamp", + "Status": { + "target": "com.amazonaws.kendra#FaqStatus", "traits": { - "smithy.api#documentation": "

The date and time that the FAQ was last updated.

" + "smithy.api#documentation": "

The status of the FAQ. It is ready to use when the status is\n ACTIVE.

" } } } @@ -1966,10 +1978,16 @@ "com.amazonaws.kendra#DescribeIndexResponse": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.kendra#ErrorMessage", + "CreatedAt": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

When th eStatus field value is FAILED, the\n ErrorMessage field contains a message that explains why.

" + "smithy.api#documentation": "

The Unix datetime that the index was created.

" + } + }, + "Status": { + "target": "com.amazonaws.kendra#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current status of the index. When the value is ACTIVE, the index is ready\n for use. If the Status field value is FAILED, the\n ErrorMessage field contains a message that explains why.

" } }, "RoleArn": { @@ -1984,34 +2002,40 @@ "smithy.api#documentation": "

Configuration settings for any metadata applied to the documents in the index.

" } }, - "Id": { - "target": "com.amazonaws.kendra#IndexId", - "traits": { - "smithy.api#documentation": "

the name of the index.

" - } - }, - "Description": { - "target": "com.amazonaws.kendra#Description", - "traits": { - "smithy.api#documentation": "

The description of the index.

" - } - }, "CapacityUnits": { "target": "com.amazonaws.kendra#CapacityUnitsConfiguration", "traits": { "smithy.api#documentation": "

For enterprise edtion indexes, you can choose to use additional capacity to meet the needs\n of your application. This contains the capacity units used for the index. A 0 for the query\n capacity or the storage capacity indicates that the index is using the default capacity for\n the index.

" } }, + "ErrorMessage": { + "target": "com.amazonaws.kendra#ErrorMessage", + "traits": { + "smithy.api#documentation": "

When th eStatus field value is FAILED, the\n ErrorMessage field contains a message that explains why.

" + } + }, "IndexStatistics": { "target": "com.amazonaws.kendra#IndexStatistics", "traits": { "smithy.api#documentation": "

Provides information about the number of FAQ questions and answers and the number of text\n documents indexed.

" } }, - "CreatedAt": { - "target": "com.amazonaws.kendra#Timestamp", + "Description": { + "target": "com.amazonaws.kendra#Description", + "traits": { + "smithy.api#documentation": "

The description of the index.

" + } + }, + "Id": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "

the name of the index.

" + } + }, + "Edition": { + "target": "com.amazonaws.kendra#IndexEdition", "traits": { - "smithy.api#documentation": "

The Unix datetime that the index was created.

" + "smithy.api#documentation": "

The Amazon Kendra edition used for the index. You decide the edition when you create the\n index.

" } }, "UpdatedAt": { @@ -2026,23 +2050,11 @@ "smithy.api#documentation": "

The name of the index.

" } }, - "Edition": { - "target": "com.amazonaws.kendra#IndexEdition", - "traits": { - "smithy.api#documentation": "

The Amazon Kendra edition used for the index. You decide the edition when you create the\n index.

" - } - }, "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.kendra#ServerSideEncryptionConfiguration", "traits": { "smithy.api#documentation": "

The identifier of the AWS KMS customer master key (CMK) used to encrypt your data.\n Amazon Kendra doesn't support asymmetric CMKs.

" } - }, - "Status": { - "target": "com.amazonaws.kendra#IndexStatus", - "traits": { - "smithy.api#documentation": "

The current status of the index. When the value is ACTIVE, the index is ready\n for use. If the Status field value is FAILED, the\n ErrorMessage field contains a message that explains why.

" - } } } }, @@ -2059,12 +2071,21 @@ "com.amazonaws.kendra#Document": { "type": "structure", "members": { - "AccessControlList": { - "target": "com.amazonaws.kendra#PrincipalList", + "Attributes": { + "target": "com.amazonaws.kendra#DocumentAttributeList", "traits": { - "smithy.api#documentation": "

Information to use for user context filtering.

" + "smithy.api#documentation": "

Custom attributes to apply to the document. Use the custom attributes to provide\n additional information for searching, to provide facets for refining searches, and to\n provide additional information in the query response.

" + } + }, + "Title": { + "target": "com.amazonaws.kendra#Title", + "traits": { + "smithy.api#documentation": "

The title of the document.

" } }, + "S3Path": { + "target": "com.amazonaws.kendra#S3Path" + }, "ContentType": { "target": "com.amazonaws.kendra#ContentType", "traits": { @@ -2078,26 +2099,17 @@ "smithy.api#required": {} } }, - "S3Path": { - "target": "com.amazonaws.kendra#S3Path" + "AccessControlList": { + "target": "com.amazonaws.kendra#PrincipalList", + "traits": { + "smithy.api#documentation": "

Information to use for user context filtering.

" + } }, "Blob": { "target": "com.amazonaws.kendra#Blob", "traits": { "smithy.api#documentation": "

The contents of the document.

\n

Documents passed to the Blob parameter must be base64 encoded. Your code\n might not need to encode the document file bytes if you're using an AWS SDK to call\n Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you\n must base64 encode the contents before sending.

" } - }, - "Attributes": { - "target": "com.amazonaws.kendra#DocumentAttributeList", - "traits": { - "smithy.api#documentation": "

Custom attributes to apply to the document. Use the custom attributes to provide\n additional information for searching, to provide facets for refining searches, and to\n provide additional information in the query response.

" - } - }, - "Title": { - "target": "com.amazonaws.kendra#Title", - "traits": { - "smithy.api#documentation": "

The title of the document.

" - } } }, "traits": { @@ -2172,6 +2184,12 @@ "com.amazonaws.kendra#DocumentAttributeValue": { "type": "structure", "members": { + "StringListValue": { + "target": "com.amazonaws.kendra#DocumentAttributeStringListValue", + "traits": { + "smithy.api#documentation": "

A list of strings.

" + } + }, "StringValue": { "target": "com.amazonaws.kendra#DocumentAttributeStringValue", "traits": { @@ -2189,12 +2207,6 @@ "traits": { "smithy.api#documentation": "

A long integer value.

" } - }, - "StringListValue": { - "target": "com.amazonaws.kendra#DocumentAttributeStringListValue", - "traits": { - "smithy.api#documentation": "

A list of strings.

" - } } }, "traits": { @@ -2292,10 +2304,11 @@ "com.amazonaws.kendra#DocumentMetadataConfiguration": { "type": "structure", "members": { - "Search": { - "target": "com.amazonaws.kendra#Search", + "Type": { + "target": "com.amazonaws.kendra#DocumentAttributeValueType", "traits": { - "smithy.api#documentation": "

Provides information about how the field is used during a search.

" + "smithy.api#documentation": "

The data type of the index field.

", + "smithy.api#required": {} } }, "Name": { @@ -2311,11 +2324,10 @@ "smithy.api#documentation": "

Provides manual tuning parameters to determine how the field affects the search\n results.

" } }, - "Type": { - "target": "com.amazonaws.kendra#DocumentAttributeValueType", + "Search": { + "target": "com.amazonaws.kendra#Search", "traits": { - "smithy.api#documentation": "

The data type of the index field.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Provides information about how the field is used during a search.

" } } }, @@ -2427,6 +2439,12 @@ "traits": { "smithy.api#documentation": "

The key for the facet values. This is the same as the DocumentAttributeKey\n provided in the query.

" } + }, + "DocumentAttributeValueType": { + "target": "com.amazonaws.kendra#DocumentAttributeValueType", + "traits": { + "smithy.api#documentation": "

The data type of the facet value. This is the same as the type defined for the index\n field when it was created.

" + } } }, "traits": { @@ -2439,6 +2457,25 @@ "target": "com.amazonaws.kendra#FacetResult" } }, + "com.amazonaws.kendra#FaqFileFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "CSV_WITH_HEADER", + "name": "CSV_WITH_HEADER" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, "com.amazonaws.kendra#FaqId": { "type": "string", "traits": { @@ -2504,16 +2541,28 @@ "com.amazonaws.kendra#FaqSummary": { "type": "structure", "members": { + "CreatedAt": { + "target": "com.amazonaws.kendra#Timestamp", + "traits": { + "smithy.api#documentation": "

The UNIX datetime that the FAQ was added to the index.

" + } + }, + "Status": { + "target": "com.amazonaws.kendra#FaqStatus", + "traits": { + "smithy.api#documentation": "

The current status of the FAQ. When the status is ACTIVE the FAQ is ready\n for use.

" + } + }, "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { "smithy.api#documentation": "

The UNIX datetime that the FAQ was last updated.

" } }, - "Id": { - "target": "com.amazonaws.kendra#FaqId", + "FileFormat": { + "target": "com.amazonaws.kendra#FaqFileFormat", "traits": { - "smithy.api#documentation": "

The unique identifier of the FAQ.

" + "smithy.api#documentation": "

The file type used to create the FAQ.

" } }, "Name": { @@ -2522,16 +2571,10 @@ "smithy.api#documentation": "

The name that you assigned the FAQ when you created or updated the FAQ.

" } }, - "Status": { - "target": "com.amazonaws.kendra#FaqStatus", - "traits": { - "smithy.api#documentation": "

The current status of the FAQ. When the status is ACTIVE the FAQ is ready\n for use.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.kendra#Timestamp", + "Id": { + "target": "com.amazonaws.kendra#FaqId", "traits": { - "smithy.api#documentation": "

The UNIX datetime that the FAQ was added to the index.

" + "smithy.api#documentation": "

The unique identifier of the FAQ.

" } } }, @@ -2554,17 +2597,17 @@ "smithy.api#documentation": "

Indicates whether the response is the best response. True if this is the best\n response; otherwise, false.

" } }, - "EndOffset": { + "BeginOffset": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

The zero-based location in the response string where the highlight ends.

", + "smithy.api#documentation": "

The zero-based location in the response string where the highlight starts.

", "smithy.api#required": {} } }, - "BeginOffset": { + "EndOffset": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

The zero-based location in the response string where the highlight starts.

", + "smithy.api#documentation": "

The zero-based location in the response string where the highlight ends.

", "smithy.api#required": {} } } @@ -2598,36 +2641,36 @@ "smithy.api#documentation": "

A unique identifier for the index. Use this to identify the index when you are using\n operations such as Query, DescribeIndex,\n UpdateIndex, and DeleteIndex.

" } }, - "UpdatedAt": { - "target": "com.amazonaws.kendra#Timestamp", - "traits": { - "smithy.api#documentation": "

The Unix timestamp when the index was last updated by the UpdateIndex\n operation.

", - "smithy.api#required": {} - } - }, "Edition": { "target": "com.amazonaws.kendra#IndexEdition", "traits": { "smithy.api#documentation": "

Indicates whether the index is a enterprise edition index or a developer edition\n index.

" } }, + "Status": { + "target": "com.amazonaws.kendra#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current status of the index. When the status is ACTIVE, the index is\n ready to search.

", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.kendra#IndexName", "traits": { "smithy.api#documentation": "

The name of the index.

" } }, - "CreatedAt": { + "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp when the index was created.

", + "smithy.api#documentation": "

The Unix timestamp when the index was last updated by the UpdateIndex\n operation.

", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.kendra#IndexStatus", + "CreatedAt": { + "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "

The current status of the index. When the status is ACTIVE, the index is\n ready to search.

", + "smithy.api#documentation": "

The Unix timestamp when the index was created.

", "smithy.api#required": {} } } @@ -2690,17 +2733,17 @@ "com.amazonaws.kendra#IndexStatistics": { "type": "structure", "members": { - "FaqStatistics": { - "target": "com.amazonaws.kendra#FaqStatistics", + "TextDocumentStatistics": { + "target": "com.amazonaws.kendra#TextDocumentStatistics", "traits": { - "smithy.api#documentation": "

The number of question and answer topics in the index.

", + "smithy.api#documentation": "

The number of text documents indexed.

", "smithy.api#required": {} } }, - "TextDocumentStatistics": { - "target": "com.amazonaws.kendra#TextDocumentStatistics", + "FaqStatistics": { + "target": "com.amazonaws.kendra#FaqStatistics", "traits": { - "smithy.api#documentation": "

The number of text documents indexed.

", + "smithy.api#documentation": "

The number of question and answer topics in the index.

", "smithy.api#required": {} } } @@ -2833,13 +2876,6 @@ "com.amazonaws.kendra#ListDataSourceSyncJobsRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#DataSourceId", - "traits": { - "smithy.api#documentation": "

The identifier of the data source.

", - "smithy.api#required": {} - } - }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { @@ -2847,18 +2883,19 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.kendra#NextToken", - "traits": { - "smithy.api#documentation": "

If the result of the previous request to GetDataSourceSyncJobHistory was\n truncated, include the NextToken to fetch the next set of jobs.

" - } - }, "MaxResults": { "target": "com.amazonaws.kendra#MaxResultsIntegerForListDataSourceSyncJobsRequest", "traits": { "smithy.api#documentation": "

The maximum number of synchronization jobs to return in the response. If there are fewer\n results in the list, this response contains only the actual results.

" } }, + "Id": { + "target": "com.amazonaws.kendra#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source.

", + "smithy.api#required": {} + } + }, "StartTimeFilter": { "target": "com.amazonaws.kendra#TimeRange", "traits": { @@ -2870,23 +2907,29 @@ "traits": { "smithy.api#documentation": "

When specified, only returns synchronization jobs with the Status field equal\n to the specified status.

" } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous request to GetDataSourceSyncJobHistory was\n truncated, include the NextToken to fetch the next set of jobs.

" + } } } }, "com.amazonaws.kendra#ListDataSourceSyncJobsResponse": { "type": "structure", "members": { - "History": { - "target": "com.amazonaws.kendra#DataSourceSyncJobHistoryList", - "traits": { - "smithy.api#documentation": "

A history of synchronization jobs for the data source.

" - } - }, "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { "smithy.api#documentation": "

The GetDataSourceSyncJobHistory operation returns a page of vocabularies at a\n time. The maximum size of the page is set by the MaxResults parameter. If there\n are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include\n the token in the next request to the GetDataSourceSyncJobHistory operation to\n return in the next page of jobs.

" } + }, + "History": { + "target": "com.amazonaws.kendra#DataSourceSyncJobHistoryList", + "traits": { + "smithy.api#documentation": "

A history of synchronization jobs for the data source.

" + } } } }, @@ -2951,17 +2994,17 @@ "com.amazonaws.kendra#ListDataSourcesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.kendra#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Kendra returns this token that you can use in the\n subsequent request to retrieve the next set of data sources.

" - } - }, "SummaryItems": { "target": "com.amazonaws.kendra#DataSourceSummaryList", "traits": { "smithy.api#documentation": "

An array of summary information for one or more data sources.

" } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, Amazon Kendra returns this token that you can use in the\n subsequent request to retrieve the next set of data sources.

" + } } } }, @@ -3004,34 +3047,34 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.kendra#MaxResultsIntegerForListFaqsRequest", - "traits": { - "smithy.api#documentation": "

The maximum number of FAQs to return in the response. If there are fewer results in\n the list, this response contains only the actual results.

" - } - }, "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { "smithy.api#documentation": "

If the result of the previous request to ListFaqs was truncated, include\n the NextToken to fetch the next set of FAQs.

" } + }, + "MaxResults": { + "target": "com.amazonaws.kendra#MaxResultsIntegerForListFaqsRequest", + "traits": { + "smithy.api#documentation": "

The maximum number of FAQs to return in the response. If there are fewer results in\n the list, this response contains only the actual results.

" + } } } }, "com.amazonaws.kendra#ListFaqsResponse": { "type": "structure", "members": { - "FaqSummaryItems": { - "target": "com.amazonaws.kendra#FaqSummaryItems", - "traits": { - "smithy.api#documentation": "

information about the FAQs associated with the specified index.

" - } - }, "NextToken": { "target": "com.amazonaws.kendra#NextToken", "traits": { "smithy.api#documentation": "

The ListFaqs operation returns a page of FAQs at a time. The maximum size\n of the page is set by the MaxResults parameter. If there are more jobs in\n the list than the page size, Amazon Kendra returns the NextPage token.\n Include the token in the next request to the ListFaqs operation to return\n the next page of FAQs.

" } + }, + "FaqSummaryItems": { + "target": "com.amazonaws.kendra#FaqSummaryItems", + "traits": { + "smithy.api#documentation": "

information about the FAQs associated with the specified index.

" + } } } }, @@ -3069,17 +3112,17 @@ "com.amazonaws.kendra#ListIndicesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.kendra#NextToken", - "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more data to retrieve),\n Amazon Kendra returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of indexes (DataSourceSummaryItems).

" - } - }, "MaxResults": { "target": "com.amazonaws.kendra#MaxResultsIntegerForListIndicesRequest", "traits": { "smithy.api#documentation": "

The maximum number of data sources to return.

" } + }, + "NextToken": { + "target": "com.amazonaws.kendra#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was incomplete (because there is more data to retrieve),\n Amazon Kendra returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of indexes (DataSourceSummaryItems).

" + } } } }, @@ -3216,10 +3259,16 @@ "com.amazonaws.kendra#OneDriveConfiguration": { "type": "structure", "members": { - "SecretArn": { - "target": "com.amazonaws.kendra#SecretArn", + "ExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user\n name and password to connect to OneDrive. The user namd should be the application ID for\n the OneDrive application, and the password is the application key for the OneDrive\n application.

", + "smithy.api#documentation": "

List of regular expressions applied to documents. Items that match the exclusion\n pattern are not indexed. If you provide both an inclusion pattern and an exclusion\n pattern, any item that matches the exclusion pattern isn't indexed.

\n

The exclusion pattern is applied to the file name.

" + } + }, + "OneDriveUsers": { + "target": "com.amazonaws.kendra#OneDriveUsers", + "traits": { + "smithy.api#documentation": "

A list of user accounts whose documents should be indexed.

", "smithy.api#required": {} } }, @@ -3230,16 +3279,10 @@ "smithy.api#required": {} } }, - "ExclusionPatterns": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", - "traits": { - "smithy.api#documentation": "

List of regular expressions applied to documents. Items that match the exclusion\n pattern are not indexed. If you provide both an inclusion pattern and an exclusion\n pattern, any item that matches the exclusion pattern isn't indexed.

\n

The exclusion pattern is applied to the file name.

" - } - }, - "OneDriveUsers": { - "target": "com.amazonaws.kendra#OneDriveUsers", + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "

A list of user accounts whose documents should be indexed.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user\n name and password to connect to OneDrive. The user namd should be the application ID for\n the OneDrive application, and the password is the application key for the OneDrive\n application.

", "smithy.api#required": {} } }, @@ -3285,17 +3328,17 @@ "com.amazonaws.kendra#OneDriveUsers": { "type": "structure", "members": { - "OneDriveUserList": { - "target": "com.amazonaws.kendra#OneDriveUserList", - "traits": { - "smithy.api#documentation": "

A list of users whose documents should be indexed. Specify the user names in email\n format, for example, username@tenantdomain. If you need to index the\n documents of more than 100 users, use the OneDriveUserS3Path field to\n specify the location of a file containing a list of users.

" - } - }, "OneDriveUserS3Path": { "target": "com.amazonaws.kendra#S3Path", "traits": { "smithy.api#documentation": "

The S3 bucket location of a file containing a list of users whose documents should be\n indexed.

" } + }, + "OneDriveUserList": { + "target": "com.amazonaws.kendra#OneDriveUserList", + "traits": { + "smithy.api#documentation": "

A list of users whose documents should be indexed. Specify the user names in email\n format, for example, username@tenantdomain. If you need to index the\n documents of more than 100 users, use the OneDriveUserS3Path field to\n specify the location of a file containing a list of users.

" + } } }, "traits": { @@ -3409,7 +3452,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches an active index. Use this API to search your documents using query. The\n Query operation enables to do faceted search and to filter results based on\n document attributes.

\n

It also enables you to provide user context that Amazon Kendra uses to enforce document\n access control in the search results.

\n

Amazon Kendra searches your index for text content and question and answer (FAQ) content.\n By default the response contains three types of results.

\n \n

You can specify that the query return only one type of result using the\n QueryResultTypeConfig parameter.

" + "smithy.api#documentation": "

Searches an active index. Use this API to search your documents using query. The\n Query operation enables to do faceted search and to filter results based on\n document attributes.

\n

It also enables you to provide user context that Amazon Kendra uses to enforce document\n access control in the search results.

\n

Amazon Kendra searches your index for text content and question and answer (FAQ) content.\n By default the response contains three types of results.

\n \n

You can specify that the query return only one type of result using the\n QueryResultTypeConfig parameter.

\n

Each query returns the 100 most relevant results.

" } }, "com.amazonaws.kendra#QueryCapacityUnit": { @@ -3454,11 +3497,10 @@ "smithy.api#documentation": "

Provides information that determines how the results of the query are sorted. You can\n set the field that Amazon Kendra should sort the results on, and specify whether the results should\n be sorted in ascending or descending order. In the case of ties in sorting the results, the\n results are sorted by relevance.

\n

If you don't provide sorting configuration, the results are sorted by the relevance that\n Amazon Kendra determines for the result.

" } }, - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "PageSize": { + "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

The unique identifier of the index to search. The identifier is returned in the response\n from the operation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Sets the number of results that are returned in each page of results. The default page\n size is 10. The maximum number of results returned is 100. If you ask for more than 100\n results, only 100 are returned.

" } }, "QueryText": { @@ -3468,24 +3510,6 @@ "smithy.api#required": {} } }, - "AttributeFilter": { - "target": "com.amazonaws.kendra#AttributeFilter", - "traits": { - "smithy.api#documentation": "

Enables filtered searches based on document attributes. You can only provide one\n attribute filter; however, the AndAllFilters, NotFilter, and\n OrAllFilters parameters contain a list of other filters.

\n

The AttributeFilter parameter enables you to create a set of filtering\n rules that a document must satisfy to be included in the query results.

" - } - }, - "PageNumber": { - "target": "com.amazonaws.kendra#Integer", - "traits": { - "smithy.api#documentation": "

Query results are returned in pages the size of the PageSize parameter. By\n default, Amazon Kendra returns the first page of results. Use this parameter to get result\n pages after the first one.

" - } - }, - "PageSize": { - "target": "com.amazonaws.kendra#Integer", - "traits": { - "smithy.api#documentation": "

Sets the number of results that are returned in each page of results. The default page\n size is 10. The maximum number of results returned is 100. If you ask for more than 100\n results, only 100 are returned.

" - } - }, "Facets": { "target": "com.amazonaws.kendra#FacetList", "traits": { @@ -3498,11 +3522,30 @@ "smithy.api#documentation": "

Sets the type of query. Only results for the specified query type are returned.

" } }, + "AttributeFilter": { + "target": "com.amazonaws.kendra#AttributeFilter", + "traits": { + "smithy.api#documentation": "

Enables filtered searches based on document attributes. You can only provide one\n attribute filter; however, the AndAllFilters, NotFilter, and\n OrAllFilters parameters contain a list of other filters.

\n

The AttributeFilter parameter enables you to create a set of filtering\n rules that a document must satisfy to be included in the query results.

" + } + }, + "PageNumber": { + "target": "com.amazonaws.kendra#Integer", + "traits": { + "smithy.api#documentation": "

Query results are returned in pages the size of the PageSize parameter. By\n default, Amazon Kendra returns the first page of results. Use this parameter to get result\n pages after the first one.

" + } + }, "RequestedDocumentAttributes": { "target": "com.amazonaws.kendra#DocumentAttributeKeyList", "traits": { "smithy.api#documentation": "

An array of document attributes to include in the response. No other document attributes\n are included in the response. By default all document attributes are included in the\n response.

" } + }, + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the index to search. The identifier is returned in the response\n from the operation.

", + "smithy.api#required": {} + } } } }, @@ -3515,6 +3558,12 @@ "smithy.api#documentation": "

The results of the search.

" } }, + "QueryId": { + "target": "com.amazonaws.kendra#QueryId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the search. You use QueryId to identify the\n search when using the feedback API.

" + } + }, "FacetResults": { "target": "com.amazonaws.kendra#FacetResultList", "traits": { @@ -3524,13 +3573,7 @@ "TotalNumberOfResults": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "

The number of items returned by the search. Use this to determine when you have\n requested the last set of results.

" - } - }, - "QueryId": { - "target": "com.amazonaws.kendra#QueryId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the search. You use QueryId to identify the\n search when using the feedback API.

" + "smithy.api#documentation": "

The total number of items found by the search; however, you can only retrieve up to 100\n items. For example, if the search found 192 items, you can only retrieve the first 100 of\n the items.

" } } } @@ -3538,16 +3581,10 @@ "com.amazonaws.kendra#QueryResultItem": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.kendra#ResultId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the query result.

" - } - }, - "DocumentTitle": { - "target": "com.amazonaws.kendra#TextWithHighlights", + "Type": { + "target": "com.amazonaws.kendra#QueryResultType", "traits": { - "smithy.api#documentation": "

The title of the document. Contains the text of the title and information for\n highlighting the relevant terms in the title.

" + "smithy.api#documentation": "

The type of document.

" } }, "DocumentURI": { @@ -3562,10 +3599,16 @@ "smithy.api#documentation": "

An array of document attributes for the document that the query result maps to. For\n example, the document author (Author) or the source URI (SourceUri) of the document.

" } }, - "Type": { - "target": "com.amazonaws.kendra#QueryResultType", + "DocumentTitle": { + "target": "com.amazonaws.kendra#TextWithHighlights", "traits": { - "smithy.api#documentation": "

The type of document.

" + "smithy.api#documentation": "

The title of the document. Contains the text of the title and information for\n highlighting the relevant terms in the title.

" + } + }, + "Id": { + "target": "com.amazonaws.kendra#ResultId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the query result.

" } }, "DocumentId": { @@ -3574,16 +3617,22 @@ "smithy.api#documentation": "

The unique identifier for the document.

" } }, + "DocumentExcerpt": { + "target": "com.amazonaws.kendra#TextWithHighlights", + "traits": { + "smithy.api#documentation": "

An extract of the text in the document. Contains information about highlighting the\n relevant terms in the excerpt.

" + } + }, "AdditionalAttributes": { "target": "com.amazonaws.kendra#AdditionalResultAttributeList", "traits": { - "smithy.api#documentation": "

One or more additional attribues associated with the query result.

" + "smithy.api#documentation": "

One or more additional attributes associated with the query result.

" } }, - "DocumentExcerpt": { - "target": "com.amazonaws.kendra#TextWithHighlights", + "ScoreAttributes": { + "target": "com.amazonaws.kendra#ScoreAttributes", "traits": { - "smithy.api#documentation": "

An extract of the text in the document. Contains information about highlighting the\n relevant terms in the excerpt.

" + "smithy.api#documentation": "

Indicates the confidence that Amazon Kendra has that a result matches the query that you\n provided. Each result is placed into a bin that indicates the confidence,\n VERY_HIGH, HIGH, MEDIUM and LOW. You\n can use the score to determine if a response meets the confidence needed for your\n application.

\n

The field is only set to LOW when the Type field is set to\n DOCUMENT and Amazon Kendra is not confident that the result matches the\n query.

" } } }, @@ -3650,6 +3699,12 @@ "smithy.api#documentation": "

Indicates that this field determines how \"fresh\" a document is. For example, if\n document 1 was created on November 5, and document 2 was created on October 31, document\n 1 is \"fresher\" than document 2. You can only set the Freshness field on one\n DATE type field. Only applies to DATE fields.

" } }, + "RankOrder": { + "target": "com.amazonaws.kendra#Order", + "traits": { + "smithy.api#documentation": "

Determines how values should be interpreted.

\n

When the RankOrder field is ASCENDING, higher numbers are\n better. For example, a document with a rating score of 10 is higher ranking than a\n document with a rating score of 1.

\n

When the RankOrder field is DESCENDING, lower numbers are\n better. For example, in a task tracking application, a priority 1 task is more important\n than a priority 5 task.

\n

Only applies to LONG and DOUBLE fields.

" + } + }, "ValueImportanceMap": { "target": "com.amazonaws.kendra#ValueImportanceMap", "traits": { @@ -3662,12 +3717,6 @@ "smithy.api#documentation": "

Specifies the time period that the boost applies to. For example, to make the boost\n apply to documents with the field value within the last month, you would use \"2628000s\".\n Once the field value is beyond the specified range, the effect of the boost drops off.\n The higher the importance, the faster the effect drops off. If you don't specify a\n value, the default is 3 months. The value of the field is a numeric string followed by\n the character \"s\", for example \"86400s\" for one day, or \"604800s\" for one week.

\n

Only applies to DATE fields.

" } }, - "RankOrder": { - "target": "com.amazonaws.kendra#Order", - "traits": { - "smithy.api#documentation": "

Determines how values should be interpreted.

\n

When the RankOrder field is ASCENDING, higher numbers are\n better. For example, a document with a rating score of 10 is higher ranking than a\n document with a rating score of 1.

\n

When the RankOrder field is DESCENDING, lower numbers are\n better. For example, in a task tracking application, a priority 1 task is more important\n than a priority 5 task.

\n

Only applies to LONG and DOUBLE fields.

" - } - }, "Importance": { "target": "com.amazonaws.kendra#Importance", "traits": { @@ -3806,16 +3855,11 @@ "com.amazonaws.kendra#S3DataSourceConfiguration": { "type": "structure", "members": { - "ExclusionPatterns": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", - "traits": { - "smithy.api#documentation": "

A list of glob patterns for documents that should not be indexed. If a document that\n matches an inclusion prefix also matches an exclusion pattern, the document is not\n indexed.

\n

For more information about glob patterns, see glob (programming) in\n Wikipedia.

" - } - }, - "InclusionPrefixes": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "BucketName": { + "target": "com.amazonaws.kendra#S3BucketName", "traits": { - "smithy.api#documentation": "

A list of S3 prefixes for the documents that should be included in the index.

" + "smithy.api#documentation": "

The name of the bucket that contains the documents.

", + "smithy.api#required": {} } }, "AccessControlListConfiguration": { @@ -3824,15 +3868,20 @@ "smithy.api#documentation": "

Provides the path to the S3 bucket that contains the user context filtering files for\n the data source.

" } }, - "BucketName": { - "target": "com.amazonaws.kendra#S3BucketName", + "DocumentsMetadataConfiguration": { + "target": "com.amazonaws.kendra#DocumentsMetadataConfiguration" + }, + "InclusionPrefixes": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

The name of the bucket that contains the documents.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of S3 prefixes for the documents that should be included in the index.

" } }, - "DocumentsMetadataConfiguration": { - "target": "com.amazonaws.kendra#DocumentsMetadataConfiguration" + "ExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

A list of glob patterns for documents that should not be indexed. If a document that\n matches an inclusion prefix also matches an exclusion pattern, the document is not\n indexed.

\n

For more information about glob patterns, see glob (programming) in\n Wikipedia.

" + } } }, "traits": { @@ -3873,23 +3922,16 @@ "com.amazonaws.kendra#SalesforceChatterFeedConfiguration": { "type": "structure", "members": { - "IncludeFilterTypes": { - "target": "com.amazonaws.kendra#SalesforceChatterFeedIncludeFilterTypes", - "traits": { - "smithy.api#documentation": "

Filters the documents in the feed based on status of the user. When you specify\n ACTIVE_USERS only documents from users who have an active account are\n indexed. When you specify STANDARD_USER only documents for Salesforce\n standard users are documented. You can specify both.

" - } - }, - "DocumentDataFieldName": { + "DocumentTitleFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "

The name of the column in the Salesforce FeedItem table that contains the content to\n index. Typically this is the Body column.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the column in the Salesforce FeedItem table that contains the title of the\n document. This is typically the Title collumn.

" } }, - "DocumentTitleFieldName": { - "target": "com.amazonaws.kendra#DataSourceFieldName", + "IncludeFilterTypes": { + "target": "com.amazonaws.kendra#SalesforceChatterFeedIncludeFilterTypes", "traits": { - "smithy.api#documentation": "

The name of the column in the Salesforce FeedItem table that contains the title of the\n document. This is typically the Title collumn.

" + "smithy.api#documentation": "

Filters the documents in the feed based on status of the user. When you specify\n ACTIVE_USERS only documents from users who have an active account are\n indexed. When you specify STANDARD_USER only documents for Salesforce\n standard users are documented. You can specify both.

" } }, "FieldMappings": { @@ -3897,6 +3939,13 @@ "traits": { "smithy.api#documentation": "

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

" } + }, + "DocumentDataFieldName": { + "target": "com.amazonaws.kendra#DataSourceFieldName", + "traits": { + "smithy.api#documentation": "

The name of the column in the Salesforce FeedItem table that contains the content to\n index. Typically this is the Body column.

", + "smithy.api#required": {} + } } }, "traits": { @@ -3933,30 +3982,22 @@ "com.amazonaws.kendra#SalesforceConfiguration": { "type": "structure", "members": { - "IncludeAttachmentFilePatterns": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", - "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are included\n in the index. Documents that don't match the patterns are excluded from the index. If a\n document matches both an inclusion pattern and an exclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the name of the attached file.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.kendra#SecretArn", + "CrawlAttachments": { + "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the\n key/value pairs required to connect to your Salesforce instance. The secret must contain\n a JSON structure with the following keys:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

" } }, - "ServerUrl": { - "target": "com.amazonaws.kendra#Url", + "IncludeAttachmentFilePatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

The instance URL for the Salesforce site that you want to index.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are included\n in the index. Documents that don't match the patterns are excluded from the index. If a\n document matches both an inclusion pattern and an exclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the name of the attached file.

" } }, - "CrawlAttachments": { - "target": "com.amazonaws.kendra#Boolean", + "ExcludeAttachmentFilePatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

" + "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are excluded\n from the index. Documents that don't match the patterns are included in the index. If a\n document matches both an exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the name of the attached file.

" } }, "KnowledgeArticleConfiguration": { @@ -3965,16 +4006,10 @@ "smithy.api#documentation": "

Specifies configuration information for the knowlege article types that Amazon Kendra\n indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of\n knowledge articles, or the custom fields of custom knowledge articles, but not\n both.

" } }, - "StandardObjectAttachmentConfiguration": { - "target": "com.amazonaws.kendra#SalesforceStandardObjectAttachmentConfiguration", - "traits": { - "smithy.api#documentation": "

Provides configuration information for processing attachments to Salesforce standard\n objects.

" - } - }, - "ExcludeAttachmentFilePatterns": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "ChatterFeedConfiguration": { + "target": "com.amazonaws.kendra#SalesforceChatterFeedConfiguration", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are excluded\n from the index. Documents that don't match the patterns are included in the index. If a\n document matches both an exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the name of the attached file.

" + "smithy.api#documentation": "

Specifies configuration information for Salesforce chatter feeds.

" } }, "StandardObjectConfigurations": { @@ -3983,10 +4018,24 @@ "smithy.api#documentation": "

Specifies the Salesforce standard objects that Amazon Kendra indexes.

" } }, - "ChatterFeedConfiguration": { - "target": "com.amazonaws.kendra#SalesforceChatterFeedConfiguration", + "ServerUrl": { + "target": "com.amazonaws.kendra#Url", "traits": { - "smithy.api#documentation": "

Specifies configuration information for Salesforce chatter feeds.

" + "smithy.api#documentation": "

The instance URL for the Salesforce site that you want to index.

", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the\n key/value pairs required to connect to your Salesforce instance. The secret must contain\n a JSON structure with the following keys:

\n ", + "smithy.api#required": {} + } + }, + "StandardObjectAttachmentConfiguration": { + "target": "com.amazonaws.kendra#SalesforceStandardObjectAttachmentConfiguration", + "traits": { + "smithy.api#documentation": "

Provides configuration information for processing attachments to Salesforce standard\n objects.

" } } }, @@ -3997,10 +4046,10 @@ "com.amazonaws.kendra#SalesforceCustomKnowledgeArticleTypeConfiguration": { "type": "structure", "members": { - "FieldMappings": { - "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "DocumentTitleFieldName": { + "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "

One or more objects that map fields in the custom knowledge article to fields in the\n Amazon Kendra index.

" + "smithy.api#documentation": "

The name of the field in the custom knowledge article that contains the document\n title.

" } }, "DocumentDataFieldName": { @@ -4017,10 +4066,10 @@ "smithy.api#required": {} } }, - "DocumentTitleFieldName": { - "target": "com.amazonaws.kendra#DataSourceFieldName", + "FieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

The name of the field in the custom knowledge article that contains the document\n title.

" + "smithy.api#documentation": "

One or more objects that map fields in the custom knowledge article to fields in the\n Amazon Kendra index.

" } } }, @@ -4053,12 +4102,6 @@ "com.amazonaws.kendra#SalesforceKnowledgeArticleConfiguration": { "type": "structure", "members": { - "StandardKnowledgeArticleTypeConfiguration": { - "target": "com.amazonaws.kendra#SalesforceStandardKnowledgeArticleTypeConfiguration", - "traits": { - "smithy.api#documentation": "

Provides configuration information for standard Salesforce knowledge articles.

" - } - }, "IncludedStates": { "target": "com.amazonaws.kendra#SalesforceKnowledgeArticleStateList", "traits": { @@ -4071,6 +4114,12 @@ "traits": { "smithy.api#documentation": "

Provides configuration information for custom Salesforce knowledge articles.

" } + }, + "StandardKnowledgeArticleTypeConfiguration": { + "target": "com.amazonaws.kendra#SalesforceStandardKnowledgeArticleTypeConfiguration", + "traits": { + "smithy.api#documentation": "

Provides configuration information for standard Salesforce knowledge articles.

" + } } }, "traits": { @@ -4111,18 +4160,18 @@ "com.amazonaws.kendra#SalesforceStandardKnowledgeArticleTypeConfiguration": { "type": "structure", "members": { - "DocumentTitleFieldName": { - "target": "com.amazonaws.kendra#DataSourceFieldName", - "traits": { - "smithy.api#documentation": "

The name of the field that contains the document title.

" - } - }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { "smithy.api#documentation": "

One or more objects that map fields in the knowledge article to Amazon Kendra index fields.\n The index field must exist before you can map a Salesforce field to it.

" } }, + "DocumentTitleFieldName": { + "target": "com.amazonaws.kendra#DataSourceFieldName", + "traits": { + "smithy.api#documentation": "

The name of the field that contains the document title.

" + } + }, "DocumentDataFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { @@ -4158,16 +4207,17 @@ "com.amazonaws.kendra#SalesforceStandardObjectConfiguration": { "type": "structure", "members": { - "DocumentTitleFieldName": { + "DocumentDataFieldName": { "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "

The name of the field in the standard object table that contains the document\n titleB.

" + "smithy.api#documentation": "

The name of the field in the standard object table that contains the document\n contents.

", + "smithy.api#required": {} } }, - "FieldMappings": { - "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "DocumentTitleFieldName": { + "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "

One or more objects that map fields in the standard object to Amazon Kendra index fields.\n The index field must exist before you can map a Salesforce field to it.

" + "smithy.api#documentation": "

The name of the field in the standard object table that contains the document\n titleB.

" } }, "Name": { @@ -4177,11 +4227,10 @@ "smithy.api#required": {} } }, - "DocumentDataFieldName": { - "target": "com.amazonaws.kendra#DataSourceFieldName", + "FieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

The name of the field in the standard object table that contains the document\n contents.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more objects that map fields in the standard object to Amazon Kendra index fields.\n The index field must exist before you can map a Salesforce field to it.

" } } }, @@ -4279,9 +4328,53 @@ "com.amazonaws.kendra#ScanSchedule": { "type": "string" }, + "com.amazonaws.kendra#ScoreAttributes": { + "type": "structure", + "members": { + "ScoreConfidence": { + "target": "com.amazonaws.kendra#ScoreConfidence", + "traits": { + "smithy.api#documentation": "

A relative ranking for how well the response matches the query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a relative ranking that indicates how confident Amazon Kendra is that the response\n matches the query.

" + } + }, + "com.amazonaws.kendra#ScoreConfidence": { + "type": "string", + "traits": { + "smithy.api#documentation": "Enumeration for query score confidence.", + "smithy.api#enum": [ + { + "value": "VERY_HIGH", + "name": "VERY_HIGH" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "LOW", + "name": "LOW" + } + ] + } + }, "com.amazonaws.kendra#Search": { "type": "structure", "members": { + "Searchable": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

Determines whether the field is used in the search. If the Searchable\n field is true, you can use relevance tuning to manually tune how Amazon Kendra\n weights the field in the search. The default is true for string fields and\n false for number and date fields.

" + } + }, "Facetable": { "target": "com.amazonaws.kendra#Boolean", "traits": { @@ -4299,12 +4392,6 @@ "traits": { "smithy.api#documentation": "

Determines whether the field can be used to sort the results of a query. If you\n specify sorting on a field that does not have Sortable set to\n true, Amazon Kendra returns an exception. The default is\n false.

" } - }, - "Searchable": { - "target": "com.amazonaws.kendra#Boolean", - "traits": { - "smithy.api#documentation": "

Determines whether the field is used in the search. If the Searchable\n field is true, you can use relevance tuning to manually tune how Amazon Kendra\n weights the field in the search. The default is true for string fields and\n false for number and date fields.

" - } } }, "traits": { @@ -4365,11 +4452,10 @@ "com.amazonaws.kendra#ServiceNowConfiguration": { "type": "structure", "members": { - "ServiceNowBuildVersion": { - "target": "com.amazonaws.kendra#ServiceNowBuildVersionType", + "KnowledgeArticleConfiguration": { + "target": "com.amazonaws.kendra#ServiceNowKnowledgeArticleConfiguration", "traits": { - "smithy.api#documentation": "

The identifier of the release that the ServiceNow host is running. If the host is not\n running the LONDON release, use OTHERS.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Provides configuration information for crawling knowledge articles in the ServiceNow\n site.

" } }, "ServiceCatalogConfiguration": { @@ -4378,10 +4464,10 @@ "smithy.api#documentation": "

Provides configuration information for crawling service catalogs in the ServiceNow\n site.

" } }, - "SecretArn": { - "target": "com.amazonaws.kendra#SecretArn", + "ServiceNowBuildVersion": { + "target": "com.amazonaws.kendra#ServiceNowBuildVersionType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user\n name and password required to connect to the ServiceNow instance.

", + "smithy.api#documentation": "

The identifier of the release that the ServiceNow host is running. If the host is not\n running the LONDON release, use OTHERS.

", "smithy.api#required": {} } }, @@ -4392,10 +4478,11 @@ "smithy.api#required": {} } }, - "KnowledgeArticleConfiguration": { - "target": "com.amazonaws.kendra#ServiceNowKnowledgeArticleConfiguration", + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "

Provides configuration information for crawling knowledge articles in the ServiceNow\n site.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user\n name and password required to connect to the ServiceNow instance.

", + "smithy.api#required": {} } } }, @@ -4416,16 +4503,16 @@ "com.amazonaws.kendra#ServiceNowKnowledgeArticleConfiguration": { "type": "structure", "members": { - "DocumentTitleFieldName": { - "target": "com.amazonaws.kendra#DataSourceFieldName", + "CrawlAttachments": { + "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

The name of the ServiceNow field that is mapped to the index document title\n field.

" + "smithy.api#documentation": "

Indicates whether Amazon Kendra should index attachments to knowledge articles.

" } }, - "ExcludeAttachmentFilePatterns": { + "IncludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

List of regular expressions applied to knowledge articles. Items that don't match the\n inclusion pattern are not indexed. The regex is applied to the field specified in the\n PatternTargetField\n

" + "smithy.api#documentation": "

List of regular expressions applied to knowledge articles. Items that don't match the\n inclusion pattern are not indexed. The regex is applied to the field specified in the\n PatternTargetField.

" } }, "DocumentDataFieldName": { @@ -4435,22 +4522,22 @@ "smithy.api#required": {} } }, - "CrawlAttachments": { - "target": "com.amazonaws.kendra#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether Amazon Kendra should index attachments to knowledge articles.

" - } - }, "FieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { "smithy.api#documentation": "

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index\n field before you map the field.

" } }, - "IncludeAttachmentFilePatterns": { + "ExcludeAttachmentFilePatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

List of regular expressions applied to knowledge articles. Items that don't match the\n inclusion pattern are not indexed. The regex is applied to the field specified in the\n PatternTargetField.

" + "smithy.api#documentation": "

List of regular expressions applied to knowledge articles. Items that don't match the\n inclusion pattern are not indexed. The regex is applied to the field specified in the\n PatternTargetField\n

" + } + }, + "DocumentTitleFieldName": { + "target": "com.amazonaws.kendra#DataSourceFieldName", + "traits": { + "smithy.api#documentation": "

The name of the ServiceNow field that is mapped to the index document title\n field.

" } } }, @@ -4461,10 +4548,10 @@ "com.amazonaws.kendra#ServiceNowServiceCatalogConfiguration": { "type": "structure", "members": { - "DocumentTitleFieldName": { - "target": "com.amazonaws.kendra#DataSourceFieldName", + "IncludeAttachmentFilePatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

The name of the ServiceNow field that is mapped to the index document title\n field.

" + "smithy.api#documentation": "

Determines the types of file attachments that are included in the index.

" } }, "DocumentDataFieldName": { @@ -4474,10 +4561,10 @@ "smithy.api#required": {} } }, - "CrawlAttachments": { - "target": "com.amazonaws.kendra#Boolean", + "DocumentTitleFieldName": { + "target": "com.amazonaws.kendra#DataSourceFieldName", "traits": { - "smithy.api#documentation": "

Indicates whether Amazon Kendra should crawl attachments to the service catalog items.\n

" + "smithy.api#documentation": "

The name of the ServiceNow field that is mapped to the index document title\n field.

" } }, "ExcludeAttachmentFilePatterns": { @@ -4486,10 +4573,10 @@ "smithy.api#documentation": "

Determines the types of file attachments that are excluded from the index.

" } }, - "IncludeAttachmentFilePatterns": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "CrawlAttachments": { + "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

Determines the types of file attachments that are included in the index.

" + "smithy.api#documentation": "

Indicates whether Amazon Kendra should crawl attachments to the service catalog items.\n

" } }, "FieldMappings": { @@ -4519,30 +4606,25 @@ "com.amazonaws.kendra#SharePointConfiguration": { "type": "structure", "members": { - "ExclusionPatterns": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", - "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are excluded\n from the index. Documents that don't match the patterns are included in the index. If a\n document matches both an exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the display URL of the SharePoint document.

" - } + "VpcConfiguration": { + "target": "com.amazonaws.kendra#DataSourceVpcConfiguration" }, - "SecretArn": { - "target": "com.amazonaws.kendra#SecretArn", + "CrawlAttachments": { + "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The\n credentials should be a user/password pair. For more information, see Using a\n Microsoft SharePoint Data Source. For more information about AWS Secrets\n Manager, see What Is AWS Secrets Manager\n in the AWS Secrets Manager user guide.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n TRUE to include attachments to documents stored in your Microsoft\n SharePoint site in the index; otherwise, FALSE.

" } }, - "Urls": { - "target": "com.amazonaws.kendra#SharePointUrlList", + "InclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

The URLs of the Microsoft SharePoint site that contains the documents that should be\n indexed.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are included\n in the index. Documents that don't match the patterns are excluded from the index. If a\n document matches both an inclusion pattern and an exclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the display URL of the SharePoint document.

" } }, - "CrawlAttachments": { - "target": "com.amazonaws.kendra#Boolean", + "FieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

\n TRUE to include attachments to documents stored in your Microsoft\n SharePoint site in the index; otherwise, FALSE.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map Microsoft\n SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the\n index fields using the operation before you map\n SharePoint attributes. For more information, see Mapping Data Source Fields.

" } }, "UseChangeLog": { @@ -4551,10 +4633,16 @@ "smithy.api#documentation": "

Set to TRUE to use the Microsoft SharePoint change log to determine the\n documents that need to be updated in the index. Depending on the size of the SharePoint\n change log, it may take longer for Amazon Kendra to use the change log than it takes it\n to determine the changed documents using the Amazon Kendra document crawler.

" } }, - "FieldMappings": { - "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "ExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map Microsoft\n SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the\n index fields using the operation before you map\n SharePoint attributes. For more information, see Mapping Data Source Fields.

" + "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are excluded\n from the index. Documents that don't match the patterns are included in the index. If a\n document matches both an exclusion pattern and an inclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the display URL of the SharePoint document.

" + } + }, + "DocumentTitleFieldName": { + "target": "com.amazonaws.kendra#DataSourceFieldName", + "traits": { + "smithy.api#documentation": "

The Microsoft SharePoint attribute field that contains the title of the\n document.

" } }, "SharePointVersion": { @@ -4564,19 +4652,18 @@ "smithy.api#required": {} } }, - "DocumentTitleFieldName": { - "target": "com.amazonaws.kendra#DataSourceFieldName", + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "

The Microsoft SharePoint attribute field that contains the title of the\n document.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The\n credentials should be a user/password pair. For more information, see Using a\n Microsoft SharePoint Data Source. For more information about AWS Secrets\n Manager, see What Is AWS Secrets Manager\n in the AWS Secrets Manager user guide.

", + "smithy.api#required": {} } }, - "VpcConfiguration": { - "target": "com.amazonaws.kendra#DataSourceVpcConfiguration" - }, - "InclusionPatterns": { - "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "Urls": { + "target": "com.amazonaws.kendra#SharePointUrlList", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns. Documents that match the patterns are included\n in the index. Documents that don't match the patterns are excluded from the index. If a\n document matches both an inclusion pattern and an exclusion pattern, the document is not\n included in the index.

\n

The regex is applied to the display URL of the SharePoint document.

" + "smithy.api#documentation": "

The URLs of the Microsoft SharePoint site that contains the documents that should be\n indexed.

", + "smithy.api#required": {} } } }, @@ -4641,7 +4728,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can\n specify a single attribute for sorting. The attribute must have the\n Sortable flag set to true, otherwise Amazon Kendra returns an\n exception.

" + "smithy.api#documentation": "

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can\n specify a single attribute for sorting. The attribute must have the\n Sortable flag set to true, otherwise Amazon Kendra returns an\n exception.

\n

You can sort attributes of the following types.

\n \n

You can't sort attributes of the following type.

\n " } }, "com.amazonaws.kendra#SqlConfiguration": { @@ -4650,7 +4737,7 @@ "QueryIdentifiersEnclosingOption": { "target": "com.amazonaws.kendra#QueryIdentifiersEnclosingOption", "traits": { - "smithy.api#documentation": "

Determines whether Amazon Kendra encloses SQL identifiers in double quotes (\") when making a\n database query.

\n

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data\n source configuration. It does not change the case of identifiers or enclose them in\n quotes.

\n

PostgreSQL internally converts uppercase characters to lower case characters in\n identifiers unless they are quoted. Choosing this option encloses identifiers in quotes\n so that PostgreSQL does not convert the character's case.

\n

For MySQL databases, you must enable the ansi_quotes option when you\n choose this option.

" + "smithy.api#documentation": "

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in\n double quotes (\") when making a database query.

\n

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data\n source configuration. It does not change the case of identifiers or enclose them in\n quotes.

\n

PostgreSQL internally converts uppercase characters to lower case characters in\n identifiers unless they are quoted. Choosing this option encloses identifiers in quotes\n so that PostgreSQL does not convert the character's case.

\n

For MySQL databases, you must enable the ansi_quotes option when you set\n this field to DOUBLE_QUOTES.

" } } }, @@ -4818,17 +4905,17 @@ "com.amazonaws.kendra#SubmitFeedbackRequest": { "type": "structure", "members": { - "IndexId": { - "target": "com.amazonaws.kendra#IndexId", + "QueryId": { + "target": "com.amazonaws.kendra#QueryId", "traits": { - "smithy.api#documentation": "

The identifier of the index that was queried.

", + "smithy.api#documentation": "

The identifier of the specific query for which you are submitting feedback. The \n query ID is returned in the response to the operation.

", "smithy.api#required": {} } }, - "QueryId": { - "target": "com.amazonaws.kendra#QueryId", + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "

The identifier of the specific query for which you are submitting feedback. The \n query ID is returned in the response to the operation.

", + "smithy.api#documentation": "

The identifier of the index that was queried.

", "smithy.api#required": {} } }, @@ -5182,6 +5269,15 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new role to use when the data source is accessing\n resources on your behalf.

" } }, + "Configuration": { + "target": "com.amazonaws.kendra#DataSourceConfiguration" + }, + "Schedule": { + "target": "com.amazonaws.kendra#ScanSchedule", + "traits": { + "smithy.api#documentation": "

The new update schedule for the data source.

" + } + }, "Name": { "target": "com.amazonaws.kendra#DataSourceName", "traits": { @@ -5200,15 +5296,6 @@ "traits": { "smithy.api#documentation": "

The new description for the data source.

" } - }, - "Configuration": { - "target": "com.amazonaws.kendra#DataSourceConfiguration" - }, - "Schedule": { - "target": "com.amazonaws.kendra#ScanSchedule", - "traits": { - "smithy.api#documentation": "

The new update schedule for the data source.

" - } } } }, @@ -5247,12 +5334,6 @@ "com.amazonaws.kendra#UpdateIndexRequest": { "type": "structure", "members": { - "CapacityUnits": { - "target": "com.amazonaws.kendra#CapacityUnitsConfiguration", - "traits": { - "smithy.api#documentation": "

Sets the number of addtional storage and query capacity units that should be\n used by the index. You can change the capacity of the index up to 5 times per day.

\n

If you are using extra storage units, you can't reduce the storage capacity\n below that required to meet the storage needs for your index.

" - } - }, "Id": { "target": "com.amazonaws.kendra#IndexId", "traits": { @@ -5260,22 +5341,22 @@ "smithy.api#required": {} } }, - "DocumentMetadataConfigurationUpdates": { - "target": "com.amazonaws.kendra#DocumentMetadataConfigurationList", - "traits": { - "smithy.api#documentation": "

The document metadata to update.

" - } - }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { "smithy.api#documentation": "

A new description for the index.

" } }, - "RoleArn": { - "target": "com.amazonaws.kendra#RoleArn", + "DocumentMetadataConfigurationUpdates": { + "target": "com.amazonaws.kendra#DocumentMetadataConfigurationList", "traits": { - "smithy.api#documentation": "

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch\n logs.

" + "smithy.api#documentation": "

The document metadata to update.

" + } + }, + "CapacityUnits": { + "target": "com.amazonaws.kendra#CapacityUnitsConfiguration", + "traits": { + "smithy.api#documentation": "

Sets the number of addtional storage and query capacity units that should be used by the\n index. You can change the capacity of the index up to 5 times per day.

\n

If you are using extra storage units, you can't reduce the storage capacity below that\n required to meet the storage needs for your index.

" } }, "Name": { @@ -5283,6 +5364,12 @@ "traits": { "smithy.api#documentation": "

The name of the index to update.

" } + }, + "RoleArn": { + "target": "com.amazonaws.kendra#RoleArn", + "traits": { + "smithy.api#documentation": "

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch\n logs.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json b/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json index 72ec46d1b28c..fbec4b439514 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json +++ b/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.2018-05-23.json @@ -64,10 +64,10 @@ "com.amazonaws.kinesisanalyticsv2#AddApplicationCloudWatchLoggingOptionRequest": { "type": "structure", "members": { - "CloudWatchLoggingOption": { - "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOption", + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

", + "smithy.api#documentation": "

The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using \n DescribeApplication.

", "smithy.api#required": {} } }, @@ -78,10 +78,10 @@ "smithy.api#required": {} } }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "CloudWatchLoggingOption": { + "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOption", "traits": { - "smithy.api#documentation": "

The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using DescribeApplication.

", + "smithy.api#documentation": "

Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

", "smithy.api#required": {} } } @@ -96,17 +96,17 @@ "smithy.api#documentation": "

The application's ARN.

" } }, - "CloudWatchLoggingOptionDescriptions": { - "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptionDescriptions", - "traits": { - "smithy.api#documentation": "

The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

" - } - }, "ApplicationVersionId": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { "smithy.api#documentation": "

The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics\n updates the ApplicationVersionId each time you change the CloudWatch logging\n options.

" } + }, + "CloudWatchLoggingOptionDescriptions": { + "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptionDescriptions", + "traits": { + "smithy.api#documentation": "

The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

" + } } } }, @@ -139,7 +139,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application. \n

\n

You can add a streaming source when you create an application, or you can use this\n operation to add a streaming source after you create an application. For more information, see\n CreateApplication.

\n

Any configuration update, including adding a streaming source using this operation, \n results in a new version of the application. You can use the DescribeApplication operation \n to find the current application version.\n

" + "smithy.api#documentation": "

\n Adds a streaming source to your SQL-based Kinesis Data Analytics application. \n

\n

You can add a streaming source when you create an application, or you can use this\n operation to add a streaming source after you create an application. For more information, see\n CreateApplication.

\n

Any configuration update, including adding a streaming source using this operation, \n results in a new version of the application. You can use the DescribeApplication operation \n to find the current application version.\n

" } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationInputProcessingConfiguration": { @@ -168,7 +168,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an InputProcessingConfiguration to an SQL-based Kinesis Data\n Analytics application. An input processor pre-processes records on the input stream before the\n application's SQL code executes. Currently, the only input processor available is AWS Lambda.

" + "smithy.api#documentation": "

Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records \n on the input stream before the\n application's SQL code executes. Currently, the only input processor available is AWS Lambda.

" } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationInputProcessingConfigurationRequest": { @@ -181,10 +181,10 @@ "smithy.api#required": {} } }, - "InputProcessingConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfiguration", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { - "smithy.api#documentation": "

The InputProcessingConfiguration to add to the application.

", + "smithy.api#documentation": "

The name of the application to which you want to add the input processing\n configuration.

", "smithy.api#required": {} } }, @@ -195,10 +195,10 @@ "smithy.api#required": {} } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "InputProcessingConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The name of the application to which you want to add the input processing\n configuration.

", + "smithy.api#documentation": "

The InputProcessingConfiguration to add to the application.

", "smithy.api#required": {} } } @@ -207,28 +207,28 @@ "com.amazonaws.kinesisanalyticsv2#AddApplicationInputProcessingConfigurationResponse": { "type": "structure", "members": { - "InputProcessingConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationDescription", + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

The description of the preprocessor that executes on records in this input before the application's code is run.

" + "smithy.api#documentation": "

Provides the current application version.

" } }, - "ApplicationARN": { - "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", + "InputId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" + "smithy.api#documentation": "

The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns \n to each input configuration that you add to your\n application.

" } }, - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "ApplicationARN": { + "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

Provides the current application version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" } }, - "InputId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", + "InputProcessingConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationDescription", "traits": { - "smithy.api#documentation": "

The input ID that is associated with the application input. This is the ID that Amazon\n Kinesis Data Analytics assigns to each input configuration that you add to your\n application.

" + "smithy.api#documentation": "

The description of the preprocessor that executes on records in this input before the application's code is run.

" } } } @@ -236,13 +236,6 @@ "com.amazonaws.kinesisanalyticsv2#AddApplicationInputRequest": { "type": "structure", "members": { - "Input": { - "target": "com.amazonaws.kinesisanalyticsv2#Input", - "traits": { - "smithy.api#documentation": "

The Input to add.

", - "smithy.api#required": {} - } - }, "ApplicationName": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { @@ -256,6 +249,13 @@ "smithy.api#documentation": "

The current version of your application. You can use the DescribeApplication operation to find the current application version.

", "smithy.api#required": {} } + }, + "Input": { + "target": "com.amazonaws.kinesisanalyticsv2#Input", + "traits": { + "smithy.api#documentation": "

The Input to add.

", + "smithy.api#required": {} + } } } }, @@ -268,17 +268,17 @@ "smithy.api#documentation": "

Describes the application input configuration. \n \n \n

" } }, - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

Provides the current application version.

" - } - }, "ApplicationARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" } + }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

Provides the current application version.

" + } } } }, @@ -308,12 +308,19 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application.

\n

If you want Kinesis Data Analytics to deliver data from an in-application stream within\n your application to an external destination (such as an Kinesis data stream, a Kinesis Data\n Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to\n your application using this operation. You can configure one or more outputs for your\n application. Each output configuration maps an in-application stream and an external\n destination.

\n

You can use one of the output configurations to deliver data from your\n in-application error stream to an external destination so that you can analyze the\n errors.

\n

Any configuration update, including adding a streaming source using this\n operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application\n version.

" + "smithy.api#documentation": "

Adds an external destination to your SQL-based Kinesis Data Analytics application.

\n

If you want Kinesis Data Analytics to deliver data from an in-application stream within\n your application to an external destination (such as an Kinesis data stream, a Kinesis Data\n Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to\n your application using this operation. You can configure one or more outputs for your\n application. Each output configuration maps an in-application stream and an external\n destination.

\n

You can use one of the output configurations to deliver data from your\n in-application error stream to an external destination so that you can analyze the\n errors.

\n

Any configuration update, including adding a streaming source using this\n operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application\n version.

" } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationOutputRequest": { "type": "structure", "members": { + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The version of the application to which you want to add the output configuration. You can\n use the DescribeApplication operation to get the current application\n version. If the version specified is not the current version, the\n ConcurrentModificationException is returned.

", + "smithy.api#required": {} + } + }, "ApplicationName": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { @@ -327,25 +334,12 @@ "smithy.api#documentation": "

An array of objects, each describing one output configuration. In the output\n configuration, you specify the name of an in-application stream, a destination (that is, a\n Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), and\n record the formation to use when writing to the destination.

", "smithy.api#required": {} } - }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The version of the application to which you want to add the output configuration. You can\n use the DescribeApplication operation to get the current application\n version. If the version specified is not the current version, the\n ConcurrentModificationException is returned.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationOutputResponse": { "type": "structure", "members": { - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The updated application version ID. Kinesis Data Analytics increments this ID when the\n application is updated.

" - } - }, "ApplicationARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { @@ -357,6 +351,12 @@ "traits": { "smithy.api#documentation": "

Describes the application output configuration.\n For more information, \n see Configuring Application Output. \n \n

" } + }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The updated application version ID. Kinesis Data Analytics increments this ID when the\n application is updated.

" + } } } }, @@ -386,23 +386,23 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application.

\n

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an\n in-application table within your application. In the request, you provide the source (S3\n bucket name and object key name), name of the in-application table to create, and the\n necessary mapping information that describes how data in an Amazon S3 object maps to columns\n in the resulting in-application table.

" + "smithy.api#documentation": "

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

\n

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an\n in-application table within your application. In the request, you provide the source (S3\n bucket name and object key name), name of the in-application table to create, and the\n necessary mapping information that describes how data in an Amazon S3 object maps to columns\n in the resulting in-application table.

" } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationReferenceDataSourceRequest": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "ReferenceDataSource": { + "target": "com.amazonaws.kinesisanalyticsv2#ReferenceDataSource", "traits": { - "smithy.api#documentation": "

The name of an existing application.

", + "smithy.api#documentation": "

The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data \n into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting \n in-application table that is \n created.

", "smithy.api#required": {} } }, - "ReferenceDataSource": { - "target": "com.amazonaws.kinesisanalyticsv2#ReferenceDataSource", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { - "smithy.api#documentation": "

The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data \n into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is \n created.

", + "smithy.api#documentation": "

The name of an existing application.

", "smithy.api#required": {} } }, @@ -418,18 +418,18 @@ "com.amazonaws.kinesisanalyticsv2#AddApplicationReferenceDataSourceResponse": { "type": "structure", "members": { - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The updated application version ID. Amazon Kinesis Data Analytics increments this ID when\n the application is updated.

" - } - }, "ReferenceDataSourceDescriptions": { "target": "com.amazonaws.kinesisanalyticsv2#ReferenceDataSourceDescriptions", "traits": { "smithy.api#documentation": "

Describes reference data sources configured for the application. \n \n \n \n

" } }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The updated application version ID. Kinesis Data Analytics increments this ID when\n the application is updated.

" + } + }, "ApplicationARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { @@ -450,6 +450,9 @@ { "target": "com.amazonaws.kinesisanalyticsv2#ConcurrentModificationException" }, + { + "target": "com.amazonaws.kinesisanalyticsv2#InvalidApplicationConfigurationException" + }, { "target": "com.amazonaws.kinesisanalyticsv2#InvalidArgumentException" }, @@ -461,12 +464,19 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.

\n

Note the following about VPC configurations for Kinesis Data Analytics applications:

\n " + "smithy.api#documentation": "

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store \n and access resources securely.

\n

Note the following about VPC configurations for Kinesis Data Analytics applications:

\n " } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationVpcConfigurationRequest": { "type": "structure", "members": { + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The version of the application to which you want to add the VPC\n configuration. You can use the DescribeApplication operation to get the\n current application version. If the version specified is not the current version, the\n ConcurrentModificationException is returned.

", + "smithy.api#required": {} + } + }, "ApplicationName": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { @@ -480,25 +490,12 @@ "smithy.api#documentation": "

Description of the VPC to add to the application.

", "smithy.api#required": {} } - }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The version of the application to which you want to add the input processing\n configuration. You can use the DescribeApplication operation to get the\n current application version. If the version specified is not the current version, the\n ConcurrentModificationException is returned.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationVpcConfigurationResponse": { "type": "structure", "members": { - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

" - } - }, "VpcConfigurationDescription": { "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurationDescription", "traits": { @@ -510,28 +507,34 @@ "traits": { "smithy.api#documentation": "

The ARN of the application.

" } + }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

" + } } } }, "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfiguration": { "type": "structure", "members": { + "CodeContent": { + "target": "com.amazonaws.kinesisanalyticsv2#CodeContent", + "traits": { + "smithy.api#documentation": "

The location and type of the application code.

" + } + }, "CodeContentType": { "target": "com.amazonaws.kinesisanalyticsv2#CodeContentType", "traits": { "smithy.api#documentation": "

Specifies whether the code content is in text or zip format.

", "smithy.api#required": {} } - }, - "CodeContent": { - "target": "com.amazonaws.kinesisanalyticsv2#CodeContent", - "traits": { - "smithy.api#documentation": "

The location and type of the application code.

" - } } }, "traits": { - "smithy.api#documentation": "

Describes code configuration for a Java-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes code configuration for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfigurationDescription": { @@ -552,7 +555,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes code configuration for a Java-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes code configuration for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfigurationUpdate": { @@ -572,35 +575,23 @@ } }, "traits": { - "smithy.api#documentation": "

Describes updates to a Java-based Amazon Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes code configuration updates to a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationConfiguration": { "type": "structure", "members": { - "ApplicationCodeConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfiguration", - "traits": { - "smithy.api#documentation": "

The code location and type parameters for a Java-based Kinesis Data Analytics application.

", - "smithy.api#required": {} - } - }, - "FlinkApplicationConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#FlinkApplicationConfiguration", - "traits": { - "smithy.api#documentation": "

The creation and update parameters for a Java-based Kinesis Data Analytics\n application.

" - } - }, "EnvironmentProperties": { "target": "com.amazonaws.kinesisanalyticsv2#EnvironmentProperties", "traits": { - "smithy.api#documentation": "

Describes execution properties for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes execution properties for a Flink-based Kinesis Data Analytics application.

" } }, - "ApplicationSnapshotConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSnapshotConfiguration", + "ApplicationCodeConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfiguration", "traits": { - "smithy.api#documentation": "

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

The code location and type parameters for a Flink-based Kinesis Data Analytics application.

", + "smithy.api#required": {} } }, "VpcConfigurations": { @@ -612,27 +603,33 @@ "SqlApplicationConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfiguration", "traits": { - "smithy.api#documentation": "

The creation and update parameters for an SQL-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

The creation and update parameters for a SQL-based Kinesis Data Analytics application.

" + } + }, + "FlinkApplicationConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#FlinkApplicationConfiguration", + "traits": { + "smithy.api#documentation": "

The creation and update parameters for a Flink-based Kinesis Data Analytics application.

" + } + }, + "ApplicationSnapshotConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSnapshotConfiguration", + "traits": { + "smithy.api#documentation": "

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the creation parameters for an Amazon Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Specifies the creation parameters for a Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationConfigurationDescription": { "type": "structure", "members": { - "FlinkApplicationConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#FlinkApplicationConfigurationDescription", - "traits": { - "smithy.api#documentation": "

The details about a Java-based Kinesis Data Analytics application.

" - } - }, - "EnvironmentPropertyDescriptions": { - "target": "com.amazonaws.kinesisanalyticsv2#EnvironmentPropertyDescriptions", + "ApplicationCodeConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfigurationDescription", "traits": { - "smithy.api#documentation": "

Describes execution properties for a Java-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

The details about the application code for a Flink-based Kinesis Data Analytics application.

" } }, "VpcConfigurationDescriptions": { @@ -644,13 +641,13 @@ "ApplicationSnapshotConfigurationDescription": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSnapshotConfigurationDescription", "traits": { - "smithy.api#documentation": "

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

" } }, - "ApplicationCodeConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfigurationDescription", + "SqlApplicationConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfigurationDescription", "traits": { - "smithy.api#documentation": "

The details about the application code for a Java-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

" } }, "RunConfigurationDescription": { @@ -659,54 +656,60 @@ "smithy.api#documentation": "

The details about the starting properties for a Kinesis Data Analytics application.

" } }, - "SqlApplicationConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfigurationDescription", + "FlinkApplicationConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#FlinkApplicationConfigurationDescription", "traits": { - "smithy.api#documentation": "

The details about inputs, outputs, and reference data sources for an SQL-based Kinesis\n Data Analytics application.

" + "smithy.api#documentation": "

The details about a Flink-based Kinesis Data Analytics application.

" + } + }, + "EnvironmentPropertyDescriptions": { + "target": "com.amazonaws.kinesisanalyticsv2#EnvironmentPropertyDescriptions", + "traits": { + "smithy.api#documentation": "

Describes execution properties for a Flink-based Kinesis Data Analytics application.

" } } }, "traits": { - "smithy.api#documentation": "

Describes details about the application code and starting parameters for an Amazon Kinesis\n Data Analytics application.

" + "smithy.api#documentation": "

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationConfigurationUpdate": { "type": "structure", "members": { + "EnvironmentPropertyUpdates": { + "target": "com.amazonaws.kinesisanalyticsv2#EnvironmentPropertyUpdates", + "traits": { + "smithy.api#documentation": "

Describes updates to the environment properties for a Flink-based Kinesis Data Analytics application.

" + } + }, "ApplicationCodeConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationCodeConfigurationUpdate", "traits": { - "smithy.api#documentation": "

Describes updates to a Java-based Kinesis Data Analytics application's code\n configuration.

" + "smithy.api#documentation": "

Describes updates to a Flink-based Kinesis Data Analytics application's code\n configuration.

" } }, - "VpcConfigurationUpdates": { - "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurationUpdates", + "SqlApplicationConfigurationUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfigurationUpdate", "traits": { - "smithy.api#documentation": "

Updates to the array of descriptions of VPC configurations available to the application.

" + "smithy.api#documentation": "

Describes updates to a SQL-based Kinesis Data Analytics application's\n configuration.

" } }, "ApplicationSnapshotConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSnapshotConfigurationUpdate", "traits": { - "smithy.api#documentation": "

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

" } }, - "SqlApplicationConfigurationUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfigurationUpdate", - "traits": { - "smithy.api#documentation": "

Describes updates to an SQL-based Kinesis Data Analytics application's\n configuration.

" - } - }, - "EnvironmentPropertyUpdates": { - "target": "com.amazonaws.kinesisanalyticsv2#EnvironmentPropertyUpdates", + "VpcConfigurationUpdates": { + "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurationUpdates", "traits": { - "smithy.api#documentation": "

Describes updates to the environment properties for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Updates to the array of descriptions of VPC configurations available to the application.

" } }, "FlinkApplicationConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#FlinkApplicationConfigurationUpdate", "traits": { - "smithy.api#documentation": "

Describes updates to a Java-based Kinesis Data Analytics application's configuration.

" + "smithy.api#documentation": "

Describes updates to a Flink-based Kinesis Data Analytics application's configuration.

" } } }, @@ -726,74 +729,74 @@ "com.amazonaws.kinesisanalyticsv2#ApplicationDetail": { "type": "structure", "members": { - "LastUpdateTimestamp": { - "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "RuntimeEnvironment": { + "target": "com.amazonaws.kinesisanalyticsv2#RuntimeEnvironment", "traits": { - "smithy.api#documentation": "

The current timestamp when the application was last updated.

" + "smithy.api#documentation": "

The runtime environment for the application (SQL-1.0, FLINK-1_6, or FLINK-1_8).

", + "smithy.api#required": {} } }, - "ApplicationStatus": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationStatus", + "ServiceExecutionRole": { + "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", "traits": { - "smithy.api#documentation": "

The status of the application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the IAM role that the application uses to access external resources.

" } }, - "ApplicationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationDescription", + "LastUpdateTimestamp": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "

The description of the application.

" + "smithy.api#documentation": "

The current timestamp when the application was last updated.

" } }, - "ApplicationConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationConfigurationDescription", + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

Provides details about the application's SQL or Java code and starting parameters.

" + "smithy.api#documentation": "

Provides the current application version. Kinesis Data Analytics updates the\n ApplicationVersionId each time you update the application.

", + "smithy.api#required": {} } }, - "CloudWatchLoggingOptionDescriptions": { - "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptionDescriptions", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { - "smithy.api#documentation": "

Describes the application Amazon CloudWatch logging options.

" + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} } }, - "ApplicationARN": { - "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", + "CreateTimestamp": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The current timestamp when the application was created.

" } }, - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "ApplicationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationDescription", "traits": { - "smithy.api#documentation": "

Provides the current application version. Kinesis Data Analytics updates the\n ApplicationVersionId each time you update the application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the application.

" } }, - "ServiceExecutionRole": { - "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "CloudWatchLoggingOptionDescriptions": { + "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptionDescriptions", "traits": { - "smithy.api#documentation": "

Specifies the IAM role that the application uses to access external resources.

" + "smithy.api#documentation": "

Describes the application Amazon CloudWatch logging options.

" } }, - "RuntimeEnvironment": { - "target": "com.amazonaws.kinesisanalyticsv2#RuntimeEnvironment", + "ApplicationStatus": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationStatus", "traits": { - "smithy.api#documentation": "

The runtime environment for the application (SQL-1.0 or FLINK-1_6).

", + "smithy.api#documentation": "

The status of the application.

", "smithy.api#required": {} } }, - "CreateTimestamp": { - "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "ApplicationConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationConfigurationDescription", "traits": { - "smithy.api#documentation": "

The current timestamp when the application was created.

" + "smithy.api#documentation": "

Provides details about the application's Java, SQL, or Scala code and starting parameters.

" } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "ApplicationARN": { + "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The name of the application.

", + "smithy.api#documentation": "

The ARN of the application.

", "smithy.api#required": {} } } @@ -815,18 +818,18 @@ "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreConfiguration": { "type": "structure", "members": { - "SnapshotName": { - "target": "com.amazonaws.kinesisanalyticsv2#SnapshotName", - "traits": { - "smithy.api#documentation": "

The identifier of an existing snapshot of application state to use to restart an application.\n The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

" - } - }, "ApplicationRestoreType": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreType", "traits": { "smithy.api#documentation": "

Specifies how the application should be restored.

", "smithy.api#required": {} } + }, + "SnapshotName": { + "target": "com.amazonaws.kinesisanalyticsv2#SnapshotName", + "traits": { + "smithy.api#documentation": "

The identifier of an existing snapshot of application state to use to restart an application.\n The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the \n ApplicationRestoreType.

" + } } }, "traits": { @@ -858,13 +861,13 @@ "SnapshotsEnabled": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

", + "smithy.api#documentation": "

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationSnapshotConfigurationDescription": { @@ -873,13 +876,13 @@ "SnapshotsEnabled": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

", + "smithy.api#documentation": "

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationSnapshotConfigurationUpdate": { @@ -888,13 +891,13 @@ "SnapshotsEnabledUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

", + "smithy.api#documentation": "

Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationStatus": { @@ -924,6 +927,14 @@ { "value": "UPDATING", "name": "UPDATING" + }, + { + "value": "AUTOSCALING", + "name": "AUTOSCALING" + }, + { + "value": "FORCE_STOPPING", + "name": "FORCE_STOPPING" } ] } @@ -944,31 +955,31 @@ "smithy.api#required": {} } }, - "RuntimeEnvironment": { - "target": "com.amazonaws.kinesisanalyticsv2#RuntimeEnvironment", + "ApplicationARN": { + "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The runtime environment for the application (SQL-1.0 or FLINK-1_6).

", + "smithy.api#documentation": "

The ARN of the application.

", "smithy.api#required": {} } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

The name of the application.

", + "smithy.api#documentation": "

Provides the current application version.

", "smithy.api#required": {} } }, - "ApplicationARN": { - "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", + "RuntimeEnvironment": { + "target": "com.amazonaws.kinesisanalyticsv2#RuntimeEnvironment", "traits": { - "smithy.api#documentation": "

The ARN of the application.

", + "smithy.api#documentation": "

The runtime environment for the application (SQL-1.0, FLINK-1_6, or FLINK-1_8).

", "smithy.api#required": {} } }, - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { - "smithy.api#documentation": "

Provides the current application version.

", + "smithy.api#documentation": "

The name of the application.

", "smithy.api#required": {} } } @@ -1006,56 +1017,56 @@ "com.amazonaws.kinesisanalyticsv2#CSVMappingParameters": { "type": "structure", "members": { - "RecordRowDelimiter": { - "target": "com.amazonaws.kinesisanalyticsv2#RecordRowDelimiter", + "RecordColumnDelimiter": { + "target": "com.amazonaws.kinesisanalyticsv2#RecordColumnDelimiter", "traits": { - "smithy.api#documentation": "

The row delimiter. For example, in a CSV format, '\\n' is the typical\n row delimiter.

", + "smithy.api#documentation": "

The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column\n delimiter.

", "smithy.api#required": {} } }, - "RecordColumnDelimiter": { - "target": "com.amazonaws.kinesisanalyticsv2#RecordColumnDelimiter", + "RecordRowDelimiter": { + "target": "com.amazonaws.kinesisanalyticsv2#RecordRowDelimiter", "traits": { - "smithy.api#documentation": "

The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column\n delimiter.

", + "smithy.api#documentation": "

The row delimiter. For example, in a CSV format, '\\n' is the typical\n row delimiter.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based application, provides additional mapping information when the record\n format uses delimiters, such as CSV. For example, the following sample records use CSV format,\n where the records use the '\\n' as the row delimiter and a comma (\",\") as\n the column delimiter:

\n \n

\n \"name1\", \"address1\"\n

\n

\n \"name2\", \"address2\"\n

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record\n format uses delimiters, such as CSV. For example, the following sample records use CSV format,\n where the records use the '\\n' as the row delimiter and a comma (\",\") as\n the column delimiter:

\n \n

\n \"name1\", \"address1\"\n

\n

\n \"name2\", \"address2\"\n

" } }, "com.amazonaws.kinesisanalyticsv2#CheckpointConfiguration": { "type": "structure", "members": { - "CheckpointInterval": { - "target": "com.amazonaws.kinesisanalyticsv2#CheckpointInterval", + "MinPauseBetweenCheckpoints": { + "target": "com.amazonaws.kinesisanalyticsv2#MinPauseBetweenCheckpoints", "traits": { - "smithy.api#documentation": "

Describes the interval in milliseconds between checkpoint operations.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.

\n " + "smithy.api#documentation": "

Describes the minimum time in milliseconds after a checkpoint operation completes that a\n new checkpoint operation can start. If a checkpoint operation takes longer than the\n CheckpointInterval, the application otherwise performs continual checkpoint\n operations. For more information, see Tuning Checkpointing in the Apache Flink\n Documentation.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this \n API or in application code.

\n " } }, - "ConfigurationType": { - "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", + "CheckpointInterval": { + "target": "com.amazonaws.kinesisanalyticsv2#CheckpointInterval", "traits": { - "smithy.api#documentation": "

Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior. \n You must set this property to CUSTOM in order to set the\n CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

\n \n

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or\n application code:

\n
    \n
  • \n

    \n CheckpointingEnabled: true

    \n
    • \n
  • \n

    \n CheckpointInterval: 60000

    \n
    • \n
  • \n

    \n MinPauseBetweenCheckpoints: 5000

    \n
    • \n
\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

Describes the interval in milliseconds between checkpoint operations.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointInterval vaue of 60000, even if this value is set \n to another value using this API or in application code.

\n " } }, - "MinPauseBetweenCheckpoints": { - "target": "com.amazonaws.kinesisanalyticsv2#MinPauseBetweenCheckpoints", + "CheckpointingEnabled": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Describes the minimum time in milliseconds after a checkpoint operation completes that a\n new checkpoint operation can start. If a checkpoint operation takes longer than the\n CheckpointInterval, the application otherwise performs continual checkpoint\n operations. For more information, see Tuning Checkpointing in the Apache Flink\n Documentation.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

\n " + "smithy.api#documentation": "

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointingEnabled value of true, even if this value \n is set to another value using this API or in application code.

\n " } }, - "CheckpointingEnabled": { - "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "ConfigurationType": { + "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { - "smithy.api#documentation": "

Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointingEnabled value of true, even if this value \n is set to another value using this API or in application code.

\n " + "smithy.api#documentation": "

Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. \n You must set this property to CUSTOM in order to set the\n CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

\n \n

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or\n application code:

\n
    \n
  • \n

    \n CheckpointingEnabled: true

    \n
    • \n
  • \n

    \n CheckpointInterval: 60000

    \n
    • \n
  • \n

    \n MinPauseBetweenCheckpoints: 5000

    \n
    • \n
\n ", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.

" + "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault \n tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.

" } }, "com.amazonaws.kinesisanalyticsv2#CheckpointConfigurationDescription": { @@ -1064,62 +1075,62 @@ "CheckpointingEnabled": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.

\n " + "smithy.api#documentation": "

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointingEnabled value of true, even if this value is set to \n another value using this API or in application code.

\n " } }, - "MinPauseBetweenCheckpoints": { - "target": "com.amazonaws.kinesisanalyticsv2#MinPauseBetweenCheckpoints", + "ConfigurationType": { + "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { - "smithy.api#documentation": "

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation\n can start.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

\n " + "smithy.api#documentation": "

Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

\n \n

If this value is set to DEFAULT, the application will use the following values, \n even if they are set to other values using APIs or\n application code:

\n
    \n
  • \n

    \n CheckpointingEnabled: true

    \n
    • \n
  • \n

    \n CheckpointInterval: 60000

    \n
    • \n
  • \n

    \n MinPauseBetweenCheckpoints: 5000

    \n
    • \n
\n " } }, "CheckpointInterval": { "target": "com.amazonaws.kinesisanalyticsv2#CheckpointInterval", "traits": { - "smithy.api#documentation": "

Describes the interval in milliseconds between checkpoint operations.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.

\n " + "smithy.api#documentation": "

Describes the interval in milliseconds between checkpoint operations.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value \n using this API or in application code.

\n " } }, - "ConfigurationType": { - "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", + "MinPauseBetweenCheckpoints": { + "target": "com.amazonaws.kinesisanalyticsv2#MinPauseBetweenCheckpoints", "traits": { - "smithy.api#documentation": "

Describes whether the application uses the default checkpointing behavior in Kinesis Data\n Analytics.

\n \n

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or\n application code:

\n
    \n
  • \n

    \n CheckpointingEnabled: true

    \n
    • \n
  • \n

    \n CheckpointInterval: 60000

    \n
    • \n
  • \n

    \n MinPauseBetweenCheckpoints: 5000

    \n
    • \n
\n " + "smithy.api#documentation": "

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation\n can start.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this \n API or in application code.

\n " } } }, "traits": { - "smithy.api#documentation": "

Describes checkpointing parameters for a Java-based Amazon Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#CheckpointConfigurationUpdate": { "type": "structure", "members": { - "CheckpointingEnabledUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "MinPauseBetweenCheckpointsUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#MinPauseBetweenCheckpoints", "traits": { - "smithy.api#documentation": "

Describes updates to whether checkpointing is enabled for an application.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.

\n " + "smithy.api#documentation": "

Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation\n can start.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or \n in application code.

\n " } }, - "CheckpointIntervalUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#CheckpointInterval", + "ConfigurationTypeUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { - "smithy.api#documentation": "

Describes updates to the interval in milliseconds between checkpoint operations.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.

\n " + "smithy.api#documentation": "

Describes updates to whether the application uses the default checkpointing behavior of\n Kinesis Data Analytics. You must set this property to CUSTOM in order to set the\n CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.\n

\n \n

If this value is set to DEFAULT, the application will use the following values, even if they are \n set to other values using APIs or\n application code:

\n
    \n
  • \n

    \n CheckpointingEnabled: true

    \n
    • \n
  • \n

    \n CheckpointInterval: 60000

    \n
    • \n
  • \n

    \n MinPauseBetweenCheckpoints: 5000

    \n
    • \n
\n " } }, - "ConfigurationTypeUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", + "CheckpointIntervalUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#CheckpointInterval", "traits": { - "smithy.api#documentation": "

Describes updates to whether the application uses the default checkpointing behavior of\n Kinesis Data Analytics. You must set this property to CUSTOM in order to set the\n CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.\n

\n \n

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or\n application code:

\n
    \n
  • \n

    \n CheckpointingEnabled: true

    \n
    • \n
  • \n

    \n CheckpointInterval: 60000

    \n
    • \n
  • \n

    \n MinPauseBetweenCheckpoints: 5000

    \n
    • \n
\n " + "smithy.api#documentation": "

Describes updates to the interval in milliseconds between checkpoint operations.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value \n using this API or in application code.

\n " } }, - "MinPauseBetweenCheckpointsUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#MinPauseBetweenCheckpoints", + "CheckpointingEnabledUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation\n can start.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

\n " + "smithy.api#documentation": "

Describes updates to whether checkpointing is enabled for an application.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a CheckpointingEnabled value of true, even if this value is set to \n another value using this API or in application code.

\n " } } }, "traits": { - "smithy.api#documentation": "

Describes updates to the checkpointing parameters for a Java-based Amazon Kinesis\n Data Analytics application.

" + "smithy.api#documentation": "

Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#CheckpointInterval": { @@ -1155,18 +1166,18 @@ "smithy.api#documentation": "

The ID of the CloudWatch logging option description.

" } }, + "RoleARN": { + "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "traits": { + "smithy.api#documentation": "

The IAM ARN of the role to use to send application messages.

\n \n

Provided for backward compatibility. Applications created with the current API version have an\n application-level service execution role rather than a resource-level role.

\n " + } + }, "LogStreamARN": { "target": "com.amazonaws.kinesisanalyticsv2#LogStreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log to receive application\n messages.

", "smithy.api#required": {} } - }, - "RoleARN": { - "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", - "traits": { - "smithy.api#documentation": "

The IAM ARN of the role to use to send application messages.

\n \n

Provided for backward compatibility. Applications created with the current API version have an\n application-level service execution role rather than a resource-level role.

\n " - } } }, "traits": { @@ -1182,18 +1193,18 @@ "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptionUpdate": { "type": "structure", "members": { + "LogStreamARNUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#LogStreamARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log to receive application\n messages.

" + } + }, "CloudWatchLoggingOptionId": { "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { "smithy.api#documentation": "

The ID of the CloudWatch logging option to update

", "smithy.api#required": {} } - }, - "LogStreamARNUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#LogStreamARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch log to receive application\n messages.

" - } } }, "traits": { @@ -1215,36 +1226,36 @@ "com.amazonaws.kinesisanalyticsv2#CodeContent": { "type": "structure", "members": { + "S3ContentLocation": { + "target": "com.amazonaws.kinesisanalyticsv2#S3ContentLocation", + "traits": { + "smithy.api#documentation": "

Information about the Amazon S3 bucket containing the application code.

" + } + }, "ZipFileContent": { "target": "com.amazonaws.kinesisanalyticsv2#ZipFileContent", "traits": { - "smithy.api#documentation": "

The zip-format code for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

The zip-format code for a Flink-based Kinesis Data Analytics application.

" } }, "TextContent": { "target": "com.amazonaws.kinesisanalyticsv2#TextContent", "traits": { - "smithy.api#documentation": "

The text-format code for a Java-based Kinesis Data Analytics application.

" - } - }, - "S3ContentLocation": { - "target": "com.amazonaws.kinesisanalyticsv2#S3ContentLocation", - "traits": { - "smithy.api#documentation": "

Information about the Amazon S3 bucket containing the application code.

" + "smithy.api#documentation": "

The text-format code for a Flink-based Kinesis Data Analytics application.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies either the application code, or the location of the application code, for a\n Java-based Amazon Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Specifies either the application code, or the location of the application code, for a\n Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#CodeContentDescription": { "type": "structure", "members": { - "CodeSize": { - "target": "com.amazonaws.kinesisanalyticsv2#CodeSize", + "TextContent": { + "target": "com.amazonaws.kinesisanalyticsv2#TextContent", "traits": { - "smithy.api#documentation": "

The size in bytes of the application code. Can be used to validate zip-format code.

" + "smithy.api#documentation": "

The text-format code

" } }, "S3ApplicationCodeLocationDescription": { @@ -1253,10 +1264,10 @@ "smithy.api#documentation": "

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application\n code stored in Amazon S3.

" } }, - "TextContent": { - "target": "com.amazonaws.kinesisanalyticsv2#TextContent", + "CodeSize": { + "target": "com.amazonaws.kinesisanalyticsv2#CodeSize", "traits": { - "smithy.api#documentation": "

The text-format code

" + "smithy.api#documentation": "

The size in bytes of the application code. Can be used to validate zip-format code.

" } }, "CodeMD5": { @@ -1267,7 +1278,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes details about the application code for a Java-based Kinesis Data\n Analytics application.

" + "smithy.api#documentation": "

Describes details about the application code for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#CodeContentType": { @@ -1288,18 +1299,18 @@ "com.amazonaws.kinesisanalyticsv2#CodeContentUpdate": { "type": "structure", "members": { - "ZipFileContentUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#ZipFileContent", - "traits": { - "smithy.api#documentation": "

Describes an update to the zipped code for an application.

" - } - }, "TextContentUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#TextContent", "traits": { "smithy.api#documentation": "

Describes an update to the text code for an application.

" } }, + "ZipFileContentUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#ZipFileContent", + "traits": { + "smithy.api#documentation": "

Describes an update to the zipped code for an application.

" + } + }, "S3ContentLocationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#S3ContentLocationUpdate", "traits": { @@ -1308,7 +1319,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an update to the code of a Java-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes an update to the code of a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#CodeMD5": { @@ -1402,12 +1413,30 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Kinesis Data Analytics application. For information about creating a\n Kinesis Data Analytics application, see Creating an\n Application.\n

" + "smithy.api#documentation": "

Creates a Kinesis Data Analytics application. For information about creating a\n Kinesis Data Analytics application, see Creating an\n Application.

" } }, "com.amazonaws.kinesisanalyticsv2#CreateApplicationRequest": { "type": "structure", "members": { + "ApplicationConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationConfiguration", + "traits": { + "smithy.api#documentation": "

Use this parameter to configure the application.

" + } + }, + "Tags": { + "target": "com.amazonaws.kinesisanalyticsv2#Tags", + "traits": { + "smithy.api#documentation": "

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an \n application. Note that the maximum number of application tags includes system tags. The maximum number of \n user-defined application tags is 50.\n For more information, see \n Using Tagging.

" + } + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptions", + "traits": { + "smithy.api#documentation": "

Use this parameter to configure an Amazon CloudWatch log stream to monitor application\n configuration errors.\n

" + } + }, "ApplicationName": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { @@ -1418,22 +1447,10 @@ "RuntimeEnvironment": { "target": "com.amazonaws.kinesisanalyticsv2#RuntimeEnvironment", "traits": { - "smithy.api#documentation": "

The runtime environment for the application (SQL-1.0 or FLINK-1_6).

", + "smithy.api#documentation": "

The runtime environment for the application (SQL-1.0, FLINK-1_6, or FLINK-1_8).

", "smithy.api#required": {} } }, - "ApplicationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationDescription", - "traits": { - "smithy.api#documentation": "

A summary description of the application.

" - } - }, - "ApplicationConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationConfiguration", - "traits": { - "smithy.api#documentation": "

Use this parameter to configure the application.

" - } - }, "ServiceExecutionRole": { "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", "traits": { @@ -1441,16 +1458,10 @@ "smithy.api#required": {} } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptions", - "traits": { - "smithy.api#documentation": "

Use this parameter to configure an Amazon CloudWatch log stream to monitor application\n configuration errors.\n

" - } - }, - "Tags": { - "target": "com.amazonaws.kinesisanalyticsv2#Tags", + "ApplicationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationDescription", "traits": { - "smithy.api#documentation": "

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.\n For more information, see Using Tagging.

" + "smithy.api#documentation": "

A summary description of the application.

" } } } @@ -1476,6 +1487,9 @@ "target": "com.amazonaws.kinesisanalyticsv2#CreateApplicationSnapshotResponse" }, "errors": [ + { + "target": "com.amazonaws.kinesisanalyticsv2#InvalidApplicationConfigurationException" + }, { "target": "com.amazonaws.kinesisanalyticsv2#InvalidArgumentException" }, @@ -1583,7 +1597,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationCloudWatchLoggingOptionRequest": { @@ -1596,17 +1610,17 @@ "smithy.api#required": {} } }, - "CloudWatchLoggingOptionId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to\n delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

", + "smithy.api#documentation": "

The version ID of the application. You can retrieve the application version ID using \n DescribeApplication.

", "smithy.api#required": {} } }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "CloudWatchLoggingOptionId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { - "smithy.api#documentation": "

The version ID of the application. You can retrieve the application version ID using \n DescribeApplication.

", + "smithy.api#documentation": "

The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to\n delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

", "smithy.api#required": {} } } @@ -1615,12 +1629,6 @@ "com.amazonaws.kinesisanalyticsv2#DeleteApplicationCloudWatchLoggingOptionResponse": { "type": "structure", "members": { - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The version ID of the application. Kinesis Data Analytics updates the\n ApplicationVersionId each time you change the CloudWatch logging\n options.

" - } - }, "CloudWatchLoggingOptionDescriptions": { "target": "com.amazonaws.kinesisanalyticsv2#CloudWatchLoggingOptionDescriptions", "traits": { @@ -1632,6 +1640,12 @@ "traits": { "smithy.api#documentation": "

The application's Amazon Resource Name (ARN).

" } + }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the application. Kinesis Data Analytics updates the\n ApplicationVersionId each time you change the CloudWatch logging\n options.

" + } } } }, @@ -1667,6 +1681,13 @@ "com.amazonaws.kinesisanalyticsv2#DeleteApplicationInputProcessingConfigurationRequest": { "type": "structure", "members": { + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} + } + }, "InputId": { "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { @@ -1680,30 +1701,23 @@ "smithy.api#documentation": "

The application version. \n You can use the DescribeApplication operation to get the current application version.\n If the version specified is not the current version, the \n ConcurrentModificationException is returned.\n

", "smithy.api#required": {} } - }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationInputProcessingConfigurationResponse": { "type": "structure", "members": { - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The current application version ID.

" - } - }, "ApplicationARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" } + }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The current application version ID.

" + } } } }, @@ -1733,19 +1747,12 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the output destination configuration from your SQL-based Amazon Kinesis Data\n Analytics application's configuration. Kinesis Data Analytics will no longer write data from\n the corresponding in-application stream to the external output destination.

" + "smithy.api#documentation": "

Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. \n Kinesis Data Analytics will no longer write data from\n the corresponding in-application stream to the external output destination.

" } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationOutputRequest": { "type": "structure", "members": { - "OutputId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", - "traits": { - "smithy.api#documentation": "

The ID of the configuration to delete. Each output configuration that is added to the\n application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to\n uniquely identify the output configuration that you want to delete from the application\n configuration. You can use the DescribeApplication operation to get the\n specific OutputId.

", - "smithy.api#required": {} - } - }, "ApplicationName": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { @@ -1759,23 +1766,30 @@ "smithy.api#documentation": "

The application version. \n You can use the DescribeApplication operation to get the current application version.\n If the version specified is not the current version, the \n ConcurrentModificationException is returned.\n

", "smithy.api#required": {} } + }, + "OutputId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", + "traits": { + "smithy.api#documentation": "

The ID of the configuration to delete. Each output configuration that is added to the\n application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to\n uniquely identify the output configuration that you want to delete from the application\n configuration. You can use the DescribeApplication operation to get the\n specific OutputId.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationOutputResponse": { "type": "structure", "members": { - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The current application version ID.

" - } - }, "ApplicationARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { "smithy.api#documentation": "

The application Amazon Resource Name (ARN).

" } + }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The current application version ID.

" + } } } }, @@ -1805,16 +1819,23 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration.

\n

If the application is running, Kinesis Data Analytics immediately removes the in-application table \n that you created using the AddApplicationReferenceDataSource operation.

" + "smithy.api#documentation": "

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.

\n

If the application is running, Kinesis Data Analytics immediately removes the in-application table \n that you created using the AddApplicationReferenceDataSource operation.

" } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationReferenceDataSourceRequest": { "type": "structure", "members": { + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The current application version. \n You can use the DescribeApplication operation to get the current application version.\n If the version specified \n is not the current version, the ConcurrentModificationException is returned.

", + "smithy.api#required": {} + } + }, "ReferenceId": { "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { - "smithy.api#documentation": "

The ID of the reference data source. When you add a reference data source to your\n application using the AddApplicationReferenceDataSource, Kinesis Data\n Analytics assigns an ID. You can use the DescribeApplication operation to\n get the reference ID.

", + "smithy.api#documentation": "

The ID of the reference data source. When you add a reference data source to your\n application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. \n You can use the DescribeApplication operation to\n get the reference ID.

", "smithy.api#required": {} } }, @@ -1824,30 +1845,23 @@ "smithy.api#documentation": "

The name of an existing application.

", "smithy.api#required": {} } - }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The current application version. \n You can use the DescribeApplication operation to get the current application version.\n If the version specified \n is not the current version, the ConcurrentModificationException is returned.

", - "smithy.api#required": {} - } } } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplicationReferenceDataSourceResponse": { "type": "structure", "members": { - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The updated version ID of the application.

" - } - }, "ApplicationARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { "smithy.api#documentation": "

The application Amazon Resource Name (ARN).

" } + }, + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The updated version ID of the application.

" + } } } }, @@ -1906,10 +1920,10 @@ "com.amazonaws.kinesisanalyticsv2#DeleteApplicationSnapshotRequest": { "type": "structure", "members": { - "SnapshotCreationTimestamp": { - "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "SnapshotName": { + "target": "com.amazonaws.kinesisanalyticsv2#SnapshotName", "traits": { - "smithy.api#documentation": "

The creation timestamp of the application snapshot to delete. You can retrieve this value using \n or .

", + "smithy.api#documentation": "

The identifier for the snapshot delete.

", "smithy.api#required": {} } }, @@ -1920,10 +1934,10 @@ "smithy.api#required": {} } }, - "SnapshotName": { - "target": "com.amazonaws.kinesisanalyticsv2#SnapshotName", + "SnapshotCreationTimestamp": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "

The identifier for the snapshot delete.

", + "smithy.api#documentation": "

The creation timestamp of the application snapshot to delete. You can retrieve this value \n using \n or .

", "smithy.api#required": {} } } @@ -1945,6 +1959,9 @@ { "target": "com.amazonaws.kinesisanalyticsv2#ConcurrentModificationException" }, + { + "target": "com.amazonaws.kinesisanalyticsv2#InvalidApplicationConfigurationException" + }, { "target": "com.amazonaws.kinesisanalyticsv2#InvalidArgumentException" }, @@ -1965,7 +1982,7 @@ "CurrentApplicationVersionId": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

The current application version ID. You can retrieve the application version ID using DescribeApplication.

", + "smithy.api#documentation": "

The current application version ID. You can retrieve the application version ID using \n DescribeApplication.

", "smithy.api#required": {} } }, @@ -1988,17 +2005,17 @@ "com.amazonaws.kinesisanalyticsv2#DeleteApplicationVpcConfigurationResponse": { "type": "structure", "members": { - "ApplicationARN": { - "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", - "traits": { - "smithy.api#documentation": "

The ARN of the Kinesis Data Analytics application.

" - } - }, "ApplicationVersionId": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { "smithy.api#documentation": "

The updated version ID of the application.

" } + }, + "ApplicationARN": { + "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", + "traits": { + "smithy.api#documentation": "

The ARN of the Kinesis Data Analytics application.

" + } } } }, @@ -2022,24 +2039,24 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a specific Amazon Kinesis Data Analytics application.

\n

If you want to retrieve a list of all applications in your account,\n use the ListApplications operation.

" + "smithy.api#documentation": "

Returns information about a specific Kinesis Data Analytics application.

\n

If you want to retrieve a list of all applications in your account,\n use the ListApplications operation.

" } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationRequest": { "type": "structure", "members": { - "IncludeAdditionalDetails": { - "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", - "traits": { - "smithy.api#documentation": "

Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.

" - } - }, "ApplicationName": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { "smithy.api#documentation": "

The name of the application.

", "smithy.api#required": {} } + }, + "IncludeAdditionalDetails": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "traits": { + "smithy.api#documentation": "

Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.

" + } } } }, @@ -2091,7 +2108,7 @@ "SnapshotName": { "target": "com.amazonaws.kinesisanalyticsv2#SnapshotName", "traits": { - "smithy.api#documentation": "

The identifier of an application snapshot. You can retrieve this value using .

", + "smithy.api#documentation": "

The identifier of an application snapshot. You can retrieve this value using \n .

", "smithy.api#required": {} } } @@ -2121,7 +2138,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the data format when records are written to the destination in an SQL-based\n Amazon Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#DiscoverInputSchema": { @@ -2150,41 +2167,41 @@ } ], "traits": { - "smithy.api#documentation": "

Infers a schema for an SQL-based Amazon Kinesis Data Analytics application by evaluating\n sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose\n delivery stream) or Amazon S3 object. In the response, the operation returns the inferred\n schema and also the sample records that the operation used to infer the schema.

\n

You can use the inferred schema when configuring a streaming source for your application.\n When you create an application using the Kinesis Data Analytics console, the console uses this\n operation to infer a schema and show it in the console user interface.

" + "smithy.api#documentation": "

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating\n sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose\n delivery stream) or Amazon S3 object. In the response, the operation returns the inferred\n schema and also the sample records that the operation used to infer the schema.

\n

You can use the inferred schema when configuring a streaming source for your application.\n When you create an application using the Kinesis Data Analytics console, the console uses this\n operation to infer a schema and show it in the console user interface.

" } }, "com.amazonaws.kinesisanalyticsv2#DiscoverInputSchemaRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the streaming source.

" - } - }, "S3Configuration": { "target": "com.amazonaws.kinesisanalyticsv2#S3Configuration", "traits": { "smithy.api#documentation": "

Specify this parameter to discover a schema from data in an Amazon S3\n object.

" } }, - "ServiceExecutionRole": { - "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "InputStartingPositionConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#InputStartingPositionConfiguration", "traits": { - "smithy.api#documentation": "

The ARN of the role that is used to access the streaming source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The point at which you want Kinesis Data Analytics to start reading records from the\n specified streaming source discovery purposes.

" } }, "InputProcessingConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfiguration", "traits": { - "smithy.api#documentation": "

The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

" + "smithy.api#documentation": "

The InputProcessingConfiguration to use to preprocess the records \n before discovering the schema of the records.

" } }, - "InputStartingPositionConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#InputStartingPositionConfiguration", + "ResourceARN": { + "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The point at which you want Kinesis Data Analytics to start reading records from the\n specified streaming source discovery purposes.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the streaming source.

" + } + }, + "ServiceExecutionRole": { + "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "traits": { + "smithy.api#documentation": "

The ARN of the role that is used to access the streaming source.

", + "smithy.api#required": {} } } } @@ -2198,10 +2215,10 @@ "smithy.api#documentation": "

The schema inferred from the streaming source. It identifies the format of the data in the\n streaming source and how each data element maps to corresponding columns in the in-application\n stream that you can create.

" } }, - "ProcessedInputRecords": { - "target": "com.amazonaws.kinesisanalyticsv2#ProcessedInputRecords", + "ParsedInputRecords": { + "target": "com.amazonaws.kinesisanalyticsv2#ParsedInputRecords", "traits": { - "smithy.api#documentation": "

The stream data that was modified by the processor specified in the\n InputProcessingConfiguration parameter.

" + "smithy.api#documentation": "

An array of elements, where each element corresponds to a row in a stream record \n (a stream record can have more than one row).

" } }, "RawInputRecords": { @@ -2210,10 +2227,10 @@ "smithy.api#documentation": "

The raw stream data that was sampled to infer the schema.

" } }, - "ParsedInputRecords": { - "target": "com.amazonaws.kinesisanalyticsv2#ParsedInputRecords", + "ProcessedInputRecords": { + "target": "com.amazonaws.kinesisanalyticsv2#ProcessedInputRecords", "traits": { - "smithy.api#documentation": "

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

" + "smithy.api#documentation": "

The stream data that was modified by the processor specified in the\n InputProcessingConfiguration parameter.

" } } } @@ -2230,7 +2247,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes execution properties for a Java-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes execution properties for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#EnvironmentPropertyDescriptions": { @@ -2244,7 +2261,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the execution properties for a Java-based Amazon Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes the execution properties for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#EnvironmentPropertyUpdates": { @@ -2259,7 +2276,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes updates to the execution property groups for a Java-based Amazon\n Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes updates to the execution property groups for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#ErrorMessage": { @@ -2280,7 +2297,7 @@ "CheckpointConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#CheckpointConfiguration", "traits": { - "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the \n process of persisting application state for fault tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.

" + "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the \n process of persisting application state for fault tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.

" } }, "MonitoringConfiguration": { @@ -2297,50 +2314,44 @@ } }, "traits": { - "smithy.api#documentation": "

Describes configuration parameters for a Java-based Amazon Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes configuration parameters for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#FlinkApplicationConfigurationDescription": { "type": "structure", "members": { - "JobPlanDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#JobPlanDescription", - "traits": { - "smithy.api#documentation": "

The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink\n Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

" - } - }, "ParallelismConfigurationDescription": { "target": "com.amazonaws.kinesisanalyticsv2#ParallelismConfigurationDescription", "traits": { "smithy.api#documentation": "

Describes parameters for how an application executes multiple tasks simultaneously.

" } }, + "CheckpointConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#CheckpointConfigurationDescription", + "traits": { + "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state \n for fault tolerance.

" + } + }, "MonitoringConfigurationDescription": { "target": "com.amazonaws.kinesisanalyticsv2#MonitoringConfigurationDescription", "traits": { "smithy.api#documentation": "

Describes configuration parameters for Amazon CloudWatch logging for an\n application.

" } }, - "CheckpointConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#CheckpointConfigurationDescription", + "JobPlanDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#JobPlanDescription", "traits": { - "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

" + "smithy.api#documentation": "

The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink\n Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

" } } }, "traits": { - "smithy.api#documentation": "

Describes configuration parameters for a Java-based Amazon Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes configuration parameters for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#FlinkApplicationConfigurationUpdate": { "type": "structure", "members": { - "ParallelismConfigurationUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#ParallelismConfigurationUpdate", - "traits": { - "smithy.api#documentation": "

Describes updates to the parameters for how an application executes multiple tasks simultaneously.

" - } - }, "MonitoringConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#MonitoringConfigurationUpdate", "traits": { @@ -2350,12 +2361,18 @@ "CheckpointConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#CheckpointConfigurationUpdate", "traits": { - "smithy.api#documentation": "

Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

" + "smithy.api#documentation": "

Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting \n application state for fault tolerance.

" + } + }, + "ParallelismConfigurationUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#ParallelismConfigurationUpdate", + "traits": { + "smithy.api#documentation": "

Describes updates to the parameters for how an application executes multiple tasks simultaneously.

" } } }, "traits": { - "smithy.api#documentation": "

Describes updates to the configuration parameters for a Java-based Amazon Kinesis\n Data Analytics application.

" + "smithy.api#documentation": "

Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#FlinkRunConfiguration": { @@ -2364,12 +2381,12 @@ "AllowNonRestoredState": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

When restoring from a savepoint, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program.\n This will happen if the program is updated between savepoints to remove stateful parameters, and state data in the savepoint no longer \n corresponds to valid application data. For more information, see \n \n Allowing Non-Restored State in the Apache Flink \n documentation.

" + "smithy.api#documentation": "

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot \n be mapped to the new program.\n This will happen if the program is updated between snapshots to remove stateful parameters, and \n state data in the snapshot no longer \n corresponds to valid application data. For more information, see \n \n Allowing Non-Restored State in the Apache Flink \n documentation.

\n \n

This value defaults to false. If you update your application without\n specifying this parameter, AllowNonRestoredState will be set to false,\n even if it was previously set to true.

\n " } } }, "traits": { - "smithy.api#documentation": "

Describes the starting parameters for an Apache Flink-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#Id": { @@ -2388,7 +2405,8 @@ "smithy.api#length": { "min": 1, "max": 32 - } + }, + "smithy.api#pattern": "[^-\\s<>&]*" } }, "com.amazonaws.kinesisanalyticsv2#InAppStreamNames": { @@ -2409,11 +2427,10 @@ "com.amazonaws.kinesisanalyticsv2#Input": { "type": "structure", "members": { - "InputSchema": { - "target": "com.amazonaws.kinesisanalyticsv2#SourceSchema", + "InputParallelism": { + "target": "com.amazonaws.kinesisanalyticsv2#InputParallelism", "traits": { - "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps\n to corresponding columns in the in-application stream that is being created.

\n

Also used to describe the format of the reference data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Describes the number of in-application streams to create.

" } }, "KinesisStreamsInput": { @@ -2429,54 +2446,55 @@ "smithy.api#required": {} } }, - "InputProcessingConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfiguration", - "traits": { - "smithy.api#documentation": "

The InputProcessingConfiguration for the input. An input processor transforms records as they are received \n from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is \n InputLambdaProcessor.

" - } - }, "KinesisFirehoseInput": { "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseInput", "traits": { "smithy.api#documentation": "

If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.

" } }, - "InputParallelism": { - "target": "com.amazonaws.kinesisanalyticsv2#InputParallelism", + "InputSchema": { + "target": "com.amazonaws.kinesisanalyticsv2#SourceSchema", "traits": { - "smithy.api#documentation": "

Describes the number of in-application streams to create.

" + "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps\n to corresponding columns in the in-application stream that is being created.

\n

Also used to describe the format of the reference data source.

", + "smithy.api#required": {} + } + }, + "InputProcessingConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfiguration", + "traits": { + "smithy.api#documentation": "

The InputProcessingConfiguration for the input. An input processor transforms records as they are received \n from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is \n InputLambdaProcessor.

" } } }, "traits": { - "smithy.api#documentation": "

When you configure the application input for an SQL-based Amazon Kinesis Data Analytics\n application, you specify the streaming source, the in-application stream name that is created,\n and the mapping between the two.

" + "smithy.api#documentation": "

When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream \n name that is created,\n and the mapping between the two.

" } }, "com.amazonaws.kinesisanalyticsv2#InputDescription": { "type": "structure", "members": { - "KinesisStreamsInputDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisStreamsInputDescription", + "InputId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { - "smithy.api#documentation": "

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data\n stream's Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input \n configuration that you add to your application.

" } }, - "InputSchema": { - "target": "com.amazonaws.kinesisanalyticsv2#SourceSchema", + "KinesisFirehoseInputDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseInputDescription", "traits": { - "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

" + "smithy.api#documentation": "

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

" } }, - "InputParallelism": { - "target": "com.amazonaws.kinesisanalyticsv2#InputParallelism", + "InputProcessingConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationDescription", "traits": { - "smithy.api#documentation": "

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

" + "smithy.api#documentation": "

The description of the preprocessor that executes on records in this input before the application's code is run.

" } }, - "InputId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", + "InputStartingPositionConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#InputStartingPositionConfiguration", "traits": { - "smithy.api#documentation": "

The input ID that is associated with the application input. This is the ID that Kinesis\n Data Analytics assigns to each input configuration that you add to your application.

" + "smithy.api#documentation": "

The point at which the application is configured to read from the input stream.

" } }, "InAppStreamNames": { @@ -2485,33 +2503,33 @@ "smithy.api#documentation": "

Returns the in-application stream names that are mapped to the stream source.

" } }, - "InputStartingPositionConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#InputStartingPositionConfiguration", - "traits": { - "smithy.api#documentation": "

The point at which the application is configured to read from the input stream.

" - } - }, "NamePrefix": { "target": "com.amazonaws.kinesisanalyticsv2#InAppStreamName", "traits": { "smithy.api#documentation": "

The in-application name prefix.

" } }, - "KinesisFirehoseInputDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseInputDescription", + "InputSchema": { + "target": "com.amazonaws.kinesisanalyticsv2#SourceSchema", "traits": { - "smithy.api#documentation": "

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

" + "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns \n in the in-application stream that is being created.

" } }, - "InputProcessingConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationDescription", + "KinesisStreamsInputDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisStreamsInputDescription", "traits": { - "smithy.api#documentation": "

The description of the preprocessor that executes on records in this input before the application's code is run.

" + "smithy.api#documentation": "

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data\n stream's Amazon Resource Name (ARN).

" + } + }, + "InputParallelism": { + "target": "com.amazonaws.kinesisanalyticsv2#InputParallelism", + "traits": { + "smithy.api#documentation": "

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

" } } }, "traits": { - "smithy.api#documentation": "

Describes the application input configuration for an SQL-based Amazon Kinesis Data\n Analytics application.

" + "smithy.api#documentation": "

Describes the application input configuration for a SQL-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#InputDescriptions": { @@ -2526,13 +2544,13 @@ "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Lambda function that operates on records in the stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", + "smithy.api#documentation": "

The ARN of the AWS Lambda function that operates on records in the stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is\n used to preprocess records in the stream in an SQL-based Amazon Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is\n used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#InputLambdaProcessorDescription": { @@ -2541,7 +2559,7 @@ "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Lambda function that is used to preprocess the records in the\n stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", + "smithy.api#documentation": "

The ARN of the AWS Lambda function that is used to preprocess the records in the\n stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", "smithy.api#required": {} } }, @@ -2553,7 +2571,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, an object that contains the\n Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in\n the stream.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, an object that contains the\n Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in\n the stream.

" } }, "com.amazonaws.kinesisanalyticsv2#InputLambdaProcessorUpdate": { @@ -2562,13 +2580,13 @@ "ResourceARNUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess\n the records in the stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess\n the records in the stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, represents an update to the\n InputLambdaProcessor that is used to preprocess the records in the\n stream.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, represents an update to the\n InputLambdaProcessor that is used to preprocess the records in the\n stream.

" } }, "com.amazonaws.kinesisanalyticsv2#InputParallelism": { @@ -2582,7 +2600,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the number of\n in-application streams to create for a given streaming source.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the number of\n in-application streams to create for a given streaming source.

" } }, "com.amazonaws.kinesisanalyticsv2#InputParallelismCount": { @@ -2607,7 +2625,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, provides updates to the\n parallelism count.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides updates to the\n parallelism count.

" } }, "com.amazonaws.kinesisanalyticsv2#InputProcessingConfiguration": { @@ -2622,7 +2640,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is\n used to preprocess the records in the stream before being processed by your application code.\n Currently, the only input processor available is AWS Lambda.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes a processor that is\n used to preprocess the records in the stream before being processed by your application code.\n Currently, the only input processor available is AWS Lambda.

" } }, "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationDescription": { @@ -2636,7 +2654,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, provides the configuration\n information about an input processor. Currently, the only input processor available is AWS Lambda.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides the configuration\n information about an input processor. Currently, the only input processor available is AWS Lambda.

" } }, "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationUpdate": { @@ -2651,7 +2669,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration.

" } }, "com.amazonaws.kinesisanalyticsv2#InputSchemaUpdate": { @@ -2663,21 +2681,21 @@ "smithy.api#documentation": "

A list of RecordColumn objects. Each object describes the mapping \n of the streaming source element to the corresponding column in the in-application stream.

" } }, - "RecordFormatUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#RecordFormat", - "traits": { - "smithy.api#documentation": "

Specifies the format of the records on the streaming source.

" - } - }, "RecordEncodingUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#RecordEncoding", "traits": { "smithy.api#documentation": "

Specifies the encoding of the records in the streaming source; for example, UTF-8.

" } + }, + "RecordFormatUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#RecordFormat", + "traits": { + "smithy.api#documentation": "

Specifies the format of the records on the streaming source.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes updates for an SQL-based Amazon Kinesis Data Analytics application's input\n schema.

" + "smithy.api#documentation": "

Describes updates for an SQL-based Kinesis Data Analytics application's input\n schema.

" } }, "com.amazonaws.kinesisanalyticsv2#InputStartingPosition": { @@ -2716,16 +2734,23 @@ "com.amazonaws.kinesisanalyticsv2#InputUpdate": { "type": "structure", "members": { + "KinesisFirehoseInputUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseInputUpdate", + "traits": { + "smithy.api#documentation": "

If a Kinesis Data Firehose delivery stream is the streaming source to be\n updated, provides an updated stream ARN.

" + } + }, "InputSchemaUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#InputSchemaUpdate", "traits": { "smithy.api#documentation": "

Describes the data format on the streaming source, and \n how record elements on the streaming source map to columns of the in-application stream that is created.

" } }, - "KinesisFirehoseInputUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseInputUpdate", + "InputId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { - "smithy.api#documentation": "

If a Kinesis Data Firehose delivery stream is the streaming source to be\n updated, provides an updated stream ARN.

" + "smithy.api#documentation": "

The input ID of the application input to be updated.

", + "smithy.api#required": {} } }, "NamePrefixUpdate": { @@ -2734,12 +2759,6 @@ "smithy.api#documentation": "

The name prefix for in-application streams that Kinesis Data Analytics creates for the\n specific streaming source.

" } }, - "KinesisStreamsInputUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisStreamsInputUpdate", - "traits": { - "smithy.api#documentation": "

If a Kinesis data stream is the streaming source to be updated, provides an\n updated stream Amazon Resource Name (ARN).

" - } - }, "InputProcessingConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationUpdate", "traits": { @@ -2749,19 +2768,18 @@ "InputParallelismUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#InputParallelismUpdate", "traits": { - "smithy.api#documentation": "

Describes the parallelism updates (the number of in-application streams Kinesis Data\n Analytics creates for the specific streaming source).

" + "smithy.api#documentation": "

Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).

" } }, - "InputId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", + "KinesisStreamsInputUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisStreamsInputUpdate", "traits": { - "smithy.api#documentation": "

The input ID of the application input to be updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If a Kinesis data stream is the streaming source to be updated, provides an\n updated stream Amazon Resource Name (ARN).

" } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes updates to a\n specific input configuration (identified by the InputId of an application).

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes updates to a\n specific input configuration (identified by the InputId of an application).

" } }, "com.amazonaws.kinesisanalyticsv2#InputUpdates": { @@ -2824,7 +2842,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, provides additional mapping\n information when JSON is the record format on the streaming source.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides additional mapping\n information when JSON is the record format on the streaming source.

" } }, "com.amazonaws.kinesisanalyticsv2#JobPlanDescription": { @@ -2837,7 +2855,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:aws:kinesisanalytics:[a-z]{2}-[a-z]+-\\d{1}+:\\d{12}+:application/[a-zA-Z0-9_.-]{1,128}" + "smithy.api#pattern": "arn:.*" } }, "com.amazonaws.kinesisanalyticsv2#KinesisAnalytics_20180523": { @@ -2934,7 +2952,7 @@ "name": "kinesisanalytics" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using SQL or Java. The service\n enables you to quickly author and run SQL or Java code against streaming sources to perform time\n series analytics, feed real-time dashboards, and create real-time metrics.

", + "smithy.api#documentation": "

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service\n enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time\n series analytics, feed real-time dashboards, and create real-time metrics.

", "smithy.api#title": "Amazon Kinesis Analytics", "smithy.api#xmlNamespace": { "uri": "http://analytics.kinesis.amazonaws.com/doc/2018-05-23" @@ -2953,24 +2971,24 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, identifies a Kinesis Data\n Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon\n Resource Name (ARN).

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data\n Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon\n Resource Name (ARN).

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseInputDescription": { "type": "structure", "members": { - "RoleARN": { - "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

\n \n

Provided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.

\n " - } - }, "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the delivery stream.

", "smithy.api#required": {} } + }, + "RoleARN": { + "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

\n \n

Provided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.

\n " + } } }, "traits": { @@ -2989,7 +3007,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, when updating application\n input configuration, provides information about a Kinesis Data Firehose delivery stream as the\n streaming source.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, when updating application\n input configuration, provides information about a Kinesis Data Firehose delivery stream as the\n streaming source.

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutput": { @@ -3004,7 +3022,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, when configuring application\n output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the\n stream Amazon Resource Name (ARN) of the delivery stream.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, when configuring application\n output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the\n stream Amazon Resource Name (ARN) of the delivery stream.

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutputDescription": { @@ -3025,7 +3043,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application's output, describes the Kinesis\n Data Firehose delivery stream that is configured as its destination.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application's output, describes the Kinesis\n Data Firehose delivery stream that is configured as its destination.

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutputUpdate": { @@ -3040,7 +3058,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, when updating an output\n configuration using the UpdateApplication operation, provides information\n about a Kinesis Data Firehose delivery stream that is configured as the destination.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, when updating an output\n configuration using the UpdateApplication operation, provides information\n about a Kinesis Data Firehose delivery stream that is configured as the destination.

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisStreamsInput": { @@ -3055,28 +3073,28 @@ } }, "traits": { - "smithy.api#documentation": "

Identifies an Amazon Kinesis data stream as the streaming source. You provide the\n stream's Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

Identifies a Kinesis data stream as the streaming source. You provide the\n stream's Amazon Resource Name (ARN).

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisStreamsInputDescription": { "type": "structure", "members": { + "RoleARN": { + "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that Kinesis Data Analytics can assume to access the\n stream.

\n \n

Provided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.

\n " + } + }, "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis data stream.

", "smithy.api#required": {} } - }, - "RoleARN": { - "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that Kinesis Data Analytics can assume to access the\n stream.

\n \n

Provided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.

\n " - } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the Kinesis data\n stream that is configured as the streaming source in the application input configuration.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the Kinesis data\n stream that is configured as the streaming source in the application input configuration.

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisStreamsInputUpdate": { @@ -3091,7 +3109,7 @@ } }, "traits": { - "smithy.api#documentation": "

When you update the input configuration for an SQL-based Amazon Kinesis Data Analytics\n application, provides information about an Amazon Kinesis stream as the streaming\n source.

" + "smithy.api#documentation": "

When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a \n Kinesis stream as the streaming\n source.

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisStreamsOutput": { @@ -3106,7 +3124,7 @@ } }, "traits": { - "smithy.api#documentation": "

When you configure an SQL-based Amazon Kinesis Data Analytics application's output,\n identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource\n Name (ARN).

" + "smithy.api#documentation": "

When you configure a SQL-based Kinesis Data Analytics application's output,\n identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource\n Name (ARN).

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisStreamsOutputDescription": { @@ -3127,7 +3145,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application's output, describes the Kinesis\n data stream that is configured as its destination.

" + "smithy.api#documentation": "

For an SQL-based Kinesis Data Analytics application's output, describes the Kinesis\n data stream that is configured as its destination.

" } }, "com.amazonaws.kinesisanalyticsv2#KinesisStreamsOutputUpdate": { @@ -3142,7 +3160,7 @@ } }, "traits": { - "smithy.api#documentation": "

When you update an SQL-based Amazon Kinesis Data Analytics application's output\n configuration using the UpdateApplication operation, provides information\n about a Kinesis data stream that is configured as the destination.

" + "smithy.api#documentation": "

When you update a SQL-based Kinesis Data Analytics application's output\n configuration using the UpdateApplication operation, provides information\n about a Kinesis data stream that is configured as the destination.

" } }, "com.amazonaws.kinesisanalyticsv2#LambdaOutput": { @@ -3151,13 +3169,13 @@ "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination Lambda function to write to.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination Lambda function to write to.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

When you configure an SQL-based Amazon Kinesis Data Analytics application's output,\n identifies an AWS Lambda function as the destination. You provide the function Amazon Resource\n Name (ARN) of the Lambda function.

" + "smithy.api#documentation": "

When you configure a SQL-based Kinesis Data Analytics application's output,\n identifies an AWS Lambda function as the destination. You provide the function Amazon Resource\n Name (ARN) of the Lambda function.

" } }, "com.amazonaws.kinesisanalyticsv2#LambdaOutputDescription": { @@ -3178,7 +3196,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application output, describes the AWS\n Lambda function that is configured as its destination.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application's output, describes the AWS\n Lambda function that is configured as its destination.

" } }, "com.amazonaws.kinesisanalyticsv2#LambdaOutputUpdate": { @@ -3187,13 +3205,13 @@ "ResourceARNUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination AWS Lambda function.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination AWS Lambda function.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

When you update an SQL-based Amazon Kinesis Data Analytics application's output\n configuration using the UpdateApplication operation, provides information\n about an AWS Lambda function that is configured as the destination.

" + "smithy.api#documentation": "

When you update an SQL-based Kinesis Data Analytics application's output\n configuration using the UpdateApplication operation, provides information\n about an AWS Lambda function that is configured as the destination.

" } }, "com.amazonaws.kinesisanalyticsv2#LimitExceededException": { @@ -3231,23 +3249,23 @@ "com.amazonaws.kinesisanalyticsv2#ListApplicationSnapshotsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.kinesisanalyticsv2#ListSnapshotsInputLimit", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { - "smithy.api#documentation": "

The maximum number of application snapshots to list.

" + "smithy.api#documentation": "

The name of an existing application.

", + "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.kinesisanalyticsv2#NextToken", "traits": { - "smithy.api#documentation": "

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more \n output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + "smithy.api#documentation": "

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more \n output available. Set it to the value of the previous call's NextToken response to indicate where the output should \n continue from.

" } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "Limit": { + "target": "com.amazonaws.kinesisanalyticsv2#ListSnapshotsInputLimit", "traits": { - "smithy.api#documentation": "

The name of an existing application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of application snapshots to list.

" } } } @@ -3255,17 +3273,17 @@ "com.amazonaws.kinesisanalyticsv2#ListApplicationSnapshotsResponse": { "type": "structure", "members": { - "SnapshotSummaries": { - "target": "com.amazonaws.kinesisanalyticsv2#SnapshotSummaries", - "traits": { - "smithy.api#documentation": "

A collection of objects containing information about the application snapshots.

" - } - }, "NextToken": { "target": "com.amazonaws.kinesisanalyticsv2#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" } + }, + "SnapshotSummaries": { + "target": "com.amazonaws.kinesisanalyticsv2#SnapshotSummaries", + "traits": { + "smithy.api#documentation": "

A collection of objects containing information about the application snapshots.

" + } } } }, @@ -3283,7 +3301,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Amazon Kinesis Data Analytics applications in your account. For each\n application, the response includes the application name, Amazon Resource Name (ARN), and\n status.

\n

If you want detailed information about a specific application, use \n DescribeApplication.

" + "smithy.api#documentation": "

Returns a list of Kinesis Data Analytics applications in your account. For each\n application, the response includes the application name, Amazon Resource Name (ARN), and\n status.

\n

If you want detailed information about a specific application, use \n DescribeApplication.

" } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationsInputLimit": { @@ -3361,7 +3379,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

" + "smithy.api#documentation": "

Retrieves the list of key-value tags assigned to the application. For more information, see \n Using Tagging.

" } }, "com.amazonaws.kinesisanalyticsv2#ListTagsForResourceRequest": { @@ -3423,21 +3441,21 @@ "com.amazonaws.kinesisanalyticsv2#MappingParameters": { "type": "structure", "members": { - "CSVMappingParameters": { - "target": "com.amazonaws.kinesisanalyticsv2#CSVMappingParameters", - "traits": { - "smithy.api#documentation": "

Provides additional mapping information when the record format uses delimiters \n (for example, CSV).

" - } - }, "JSONMappingParameters": { "target": "com.amazonaws.kinesisanalyticsv2#JSONMappingParameters", "traits": { "smithy.api#documentation": "

Provides additional mapping information when JSON is the record format on the streaming source.

" } + }, + "CSVMappingParameters": { + "target": "com.amazonaws.kinesisanalyticsv2#CSVMappingParameters", + "traits": { + "smithy.api#documentation": "

Provides additional mapping information when the record format uses delimiters \n (for example, CSV).

" + } } }, "traits": { - "smithy.api#documentation": "

When you configure an SQL-based Amazon Kinesis Data Analytics application's input at the\n time of creating or updating an application, provides additional mapping information specific\n to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the\n streaming source.

" + "smithy.api#documentation": "

When you configure a SQL-based Kinesis Data Analytics application's input at the\n time of creating or updating an application, provides additional mapping information specific\n to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the\n streaming source.

" } }, "com.amazonaws.kinesisanalyticsv2#MetricsLevel": { @@ -3475,16 +3493,10 @@ "com.amazonaws.kinesisanalyticsv2#MonitoringConfiguration": { "type": "structure", "members": { - "LogLevel": { - "target": "com.amazonaws.kinesisanalyticsv2#LogLevel", - "traits": { - "smithy.api#documentation": "

Describes the verbosity of the CloudWatch Logs for an application.

" - } - }, "MetricsLevel": { "target": "com.amazonaws.kinesisanalyticsv2#MetricsLevel", "traits": { - "smithy.api#documentation": "

Describes the granularity of the CloudWatch Logs for an application.

" + "smithy.api#documentation": "

Describes the granularity of the CloudWatch Logs for an application. The Parallelism\n level is not recommended for applications with a Parallelism over 64 due to excessive costs.

" } }, "ConfigurationType": { @@ -3493,27 +3505,33 @@ "smithy.api#documentation": "

Describes whether to use the default CloudWatch logging configuration for an application. \n You must set this property to CUSTOM in order to set the LogLevel or\n MetricsLevel parameters.

", "smithy.api#required": {} } + }, + "LogLevel": { + "target": "com.amazonaws.kinesisanalyticsv2#LogLevel", + "traits": { + "smithy.api#documentation": "

Describes the verbosity of the CloudWatch Logs for an application.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes configuration parameters for Amazon CloudWatch logging for a Java-based\n Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring.

" + "smithy.api#documentation": "

Describes configuration parameters for Amazon CloudWatch logging for a Flink-based\n Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring.

" } }, "com.amazonaws.kinesisanalyticsv2#MonitoringConfigurationDescription": { "type": "structure", "members": { - "LogLevel": { - "target": "com.amazonaws.kinesisanalyticsv2#LogLevel", - "traits": { - "smithy.api#documentation": "

Describes the verbosity of the CloudWatch Logs for an application.

" - } - }, "ConfigurationType": { "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { "smithy.api#documentation": "

Describes whether to use the default CloudWatch logging configuration for an application.

" } }, + "LogLevel": { + "target": "com.amazonaws.kinesisanalyticsv2#LogLevel", + "traits": { + "smithy.api#documentation": "

Describes the verbosity of the CloudWatch Logs for an application.

" + } + }, "MetricsLevel": { "target": "com.amazonaws.kinesisanalyticsv2#MetricsLevel", "traits": { @@ -3522,24 +3540,24 @@ } }, "traits": { - "smithy.api#documentation": "

Describes configuration parameters for CloudWatch logging for a Java-based\n Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes configuration parameters for CloudWatch logging for a Flink-based\n Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#MonitoringConfigurationUpdate": { "type": "structure", "members": { - "MetricsLevelUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#MetricsLevel", - "traits": { - "smithy.api#documentation": "

Describes updates to the granularity of the CloudWatch Logs for an application.

" - } - }, "LogLevelUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#LogLevel", "traits": { "smithy.api#documentation": "

Describes updates to the verbosity of the CloudWatch Logs for an application.

" } }, + "MetricsLevelUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#MetricsLevel", + "traits": { + "smithy.api#documentation": "

Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism\n level is not recommended for applications with a Parallelism over 64 due to excessive costs.

" + } + }, "ConfigurationTypeUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { @@ -3548,7 +3566,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes updates to configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes updates to configuration parameters for Amazon CloudWatch logging for a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#NextToken": { @@ -3561,69 +3579,57 @@ } }, "com.amazonaws.kinesisanalyticsv2#ObjectVersion": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } }, "com.amazonaws.kinesisanalyticsv2#Output": { "type": "structure", "members": { - "KinesisFirehoseOutput": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutput", + "LambdaOutput": { + "target": "com.amazonaws.kinesisanalyticsv2#LambdaOutput", "traits": { - "smithy.api#documentation": "

Identifies an Amazon Kinesis Data Firehose delivery stream as the destination.

" + "smithy.api#documentation": "

Identifies an AWS Lambda function as the destination.

" } }, - "LambdaOutput": { - "target": "com.amazonaws.kinesisanalyticsv2#LambdaOutput", + "Name": { + "target": "com.amazonaws.kinesisanalyticsv2#InAppStreamName", "traits": { - "smithy.api#documentation": "

Identifies an AWS Lambda function as the destination.

" + "smithy.api#documentation": "

The name of the in-application stream.

", + "smithy.api#required": {} } }, "KinesisStreamsOutput": { "target": "com.amazonaws.kinesisanalyticsv2#KinesisStreamsOutput", "traits": { - "smithy.api#documentation": "

Identifies an Amazon Kinesis data stream \n as the destination.

" + "smithy.api#documentation": "

Identifies a Kinesis data stream \n as the destination.

" } }, - "DestinationSchema": { - "target": "com.amazonaws.kinesisanalyticsv2#DestinationSchema", + "KinesisFirehoseOutput": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutput", "traits": { - "smithy.api#documentation": "

Describes the data format when records are written to the destination. \n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifies a Kinesis Data Firehose delivery stream as the destination.

" } }, - "Name": { - "target": "com.amazonaws.kinesisanalyticsv2#InAppStreamName", + "DestinationSchema": { + "target": "com.amazonaws.kinesisanalyticsv2#DestinationSchema", "traits": { - "smithy.api#documentation": "

The name of the in-application stream.

", + "smithy.api#documentation": "

Describes the data format when records are written to the destination. \n

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes an SQL-based Amazon Kinesis Data Analytics application's output configuration,\n in which you identify an in-application stream and a destination where you want the\n in-application stream data to be written. The destination can be a Kinesis data stream or a\n Kinesis Data Firehose delivery stream.

\n \n

" + "smithy.api#documentation": "

Describes a SQL-based Kinesis Data Analytics application's output configuration,\n in which you identify an in-application stream and a destination where you want the\n in-application stream data to be written. The destination can be a Kinesis data stream or a\n Kinesis Data Firehose delivery stream.

\n \n

" } }, "com.amazonaws.kinesisanalyticsv2#OutputDescription": { "type": "structure", "members": { - "KinesisStreamsOutputDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisStreamsOutputDescription", - "traits": { - "smithy.api#documentation": "

Describes the Kinesis data stream that is configured as the destination where output is\n written.

" - } - }, - "KinesisFirehoseOutputDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutputDescription", - "traits": { - "smithy.api#documentation": "

Describes the Kinesis Data Firehose delivery stream that is configured as the destination\n where output is written.

" - } - }, - "DestinationSchema": { - "target": "com.amazonaws.kinesisanalyticsv2#DestinationSchema", - "traits": { - "smithy.api#documentation": "

The data format used for writing data to the destination.

" - } - }, "OutputId": { "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { @@ -3641,10 +3647,28 @@ "traits": { "smithy.api#documentation": "

Describes the Lambda function that is configured as the destination where output is\n written.

" } + }, + "DestinationSchema": { + "target": "com.amazonaws.kinesisanalyticsv2#DestinationSchema", + "traits": { + "smithy.api#documentation": "

The data format used for writing data to the destination.

" + } + }, + "KinesisFirehoseOutputDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutputDescription", + "traits": { + "smithy.api#documentation": "

Describes the Kinesis Data Firehose delivery stream that is configured as the destination\n where output is written.

" + } + }, + "KinesisStreamsOutputDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisStreamsOutputDescription", + "traits": { + "smithy.api#documentation": "

Describes the Kinesis data stream that is configured as the destination where output is\n written.

" + } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the application\n output configuration, which includes the in-application stream name and the destination where\n the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data\n Firehose delivery stream.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the application\n output configuration, which includes the in-application stream name and the destination where\n the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data\n Firehose delivery stream.

" } }, "com.amazonaws.kinesisanalyticsv2#OutputDescriptions": { @@ -3656,17 +3680,10 @@ "com.amazonaws.kinesisanalyticsv2#OutputUpdate": { "type": "structure", "members": { - "OutputId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", - "traits": { - "smithy.api#documentation": "

Identifies the specific output configuration that you want to update.

", - "smithy.api#required": {} - } - }, - "LambdaOutputUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#LambdaOutputUpdate", + "NameUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#InAppStreamName", "traits": { - "smithy.api#documentation": "

Describes an AWS Lambda function as the destination for the output.

" + "smithy.api#documentation": "

If you want to specify a different in-application stream \n for this output configuration, use this field to \n specify the new in-application stream name.

" } }, "KinesisStreamsOutputUpdate": { @@ -3681,21 +3698,28 @@ "smithy.api#documentation": "

Describes the data format when records are written to the destination. \n

" } }, + "OutputId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", + "traits": { + "smithy.api#documentation": "

Identifies the specific output configuration that you want to update.

", + "smithy.api#required": {} + } + }, "KinesisFirehoseOutputUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#KinesisFirehoseOutputUpdate", "traits": { "smithy.api#documentation": "

Describes a Kinesis Data Firehose delivery stream as the destination for the\n output.

" } }, - "NameUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#InAppStreamName", + "LambdaOutputUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#LambdaOutputUpdate", "traits": { - "smithy.api#documentation": "

If you want to specify a different in-application stream \n for this output configuration, use this field to \n specify the new in-application stream name.

" + "smithy.api#documentation": "

Describes an AWS Lambda function as the destination for the output.

" } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes updates to the\n output configuration identified by the OutputId.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes updates to the\n output configuration identified by the OutputId.

" } }, "com.amazonaws.kinesisanalyticsv2#OutputUpdates": { @@ -3722,49 +3746,49 @@ "com.amazonaws.kinesisanalyticsv2#ParallelismConfiguration": { "type": "structure", "members": { - "AutoScalingEnabled": { - "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "ConfigurationType": { + "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { - "smithy.api#documentation": "

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" + "smithy.api#documentation": "

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM\n in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

", + "smithy.api#required": {} } }, "ParallelismPerKPU": { "target": "com.amazonaws.kinesisanalyticsv2#ParallelismPerKPU", "traits": { - "smithy.api#documentation": "

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics\n application can perform per Kinesis Processing Unit (KPU) used by the application. For more\n information about KPUs, see Amazon Kinesis Data Analytics Pricing.

" + "smithy.api#documentation": "

Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit \n (KPU) used by the application. For more\n information about KPUs, see Amazon Kinesis Data Analytics Pricing.

" } }, - "ConfigurationType": { - "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", + "Parallelism": { + "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", "traits": { - "smithy.api#documentation": "

Describes whether the application uses the default parallelism for the Kinesis Data\n Analytics service. You must set this property to CUSTOM\n in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled \n is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application\n load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is \n ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If \n application load is reduced, the service can\n reduce the CurrentParallelism value down to the Parallelism setting.

" } }, - "Parallelism": { - "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", + "AutoScalingEnabled": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics\n application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application\n load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can\n reduce the CurrentParallelism value down to the Parallelism setting.

" + "smithy.api#documentation": "

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" } } }, "traits": { - "smithy.api#documentation": "

Describes parameters for how a Java-based Amazon Kinesis Data Analytics\n application executes multiple tasks simultaneously. For more information about parallelism,\n see Parallel Execution in the Apache Flink\n Documentation.

" + "smithy.api#documentation": "

Describes parameters for how a Flink-based Kinesis Data Analytics application\n application executes multiple tasks simultaneously. For more information about parallelism,\n see Parallel Execution in the Apache Flink\n Documentation.

" } }, "com.amazonaws.kinesisanalyticsv2#ParallelismConfigurationDescription": { "type": "structure", "members": { - "ConfigurationType": { - "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", + "Parallelism": { + "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", "traits": { - "smithy.api#documentation": "

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

" + "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. \n If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application\n load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can\n reduce the CurrentParallelism value down to the Parallelism setting.

" } }, - "Parallelism": { + "CurrentParallelism": { "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", "traits": { - "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics\n application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application\n load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can\n reduce the CurrentParallelism value down to the Parallelism setting.

" + "smithy.api#documentation": "

Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. \n If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application\n load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce\n the CurrentParallelism value down to the Parallelism setting.

" } }, "AutoScalingEnabled": { @@ -3773,38 +3797,26 @@ "smithy.api#documentation": "

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" } }, - "CurrentParallelism": { - "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", + "ConfigurationType": { + "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { - "smithy.api#documentation": "

Describes the current number of parallel tasks that a Java-based Kinesis Data Analytics\n application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application\n load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce\n the CurrentParallelism value down to the Parallelism setting.

" + "smithy.api#documentation": "

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

" } }, "ParallelismPerKPU": { "target": "com.amazonaws.kinesisanalyticsv2#ParallelismPerKPU", "traits": { - "smithy.api#documentation": "

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics\n application can perform per Kinesis Processing Unit (KPU) used by the application.

" + "smithy.api#documentation": "

Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per \n Kinesis Processing Unit (KPU) used by the application.

" } } }, "traits": { - "smithy.api#documentation": "

Describes parameters for how a Java-based Kinesis Data Analytics application\n executes multiple tasks simultaneously.

" + "smithy.api#documentation": "

Describes parameters for how a Flink-based Kinesis Data Analytics application\n executes multiple tasks simultaneously.

" } }, "com.amazonaws.kinesisanalyticsv2#ParallelismConfigurationUpdate": { "type": "structure", "members": { - "AutoScalingEnabledUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", - "traits": { - "smithy.api#documentation": "

Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" - } - }, - "ParallelismUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", - "traits": { - "smithy.api#documentation": "

Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Kinesis \n Data Analytics can increase the CurrentParallelism value in response to application\n load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will\n reduce CurrentParallelism down to the Parallelism setting.

" - } - }, "ConfigurationTypeUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ConfigurationType", "traits": { @@ -3816,10 +3828,22 @@ "traits": { "smithy.api#documentation": "

Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.

" } + }, + "AutoScalingEnabledUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "traits": { + "smithy.api#documentation": "

Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" + } + }, + "ParallelismUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", + "traits": { + "smithy.api#documentation": "

Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then \n Kinesis Data Analytics can increase the CurrentParallelism value in response to application\n load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will\n reduce CurrentParallelism down to the Parallelism setting.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes updates to parameters for how a Java-based Kinesis Data Analytics\n application executes multiple tasks simultaneously.

" + "smithy.api#documentation": "

Describes updates to parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.

" } }, "com.amazonaws.kinesisanalyticsv2#ParallelismPerKPU": { @@ -3858,23 +3882,23 @@ "com.amazonaws.kinesisanalyticsv2#PropertyGroup": { "type": "structure", "members": { - "PropertyGroupId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", + "PropertyMap": { + "target": "com.amazonaws.kinesisanalyticsv2#PropertyMap", "traits": { - "smithy.api#documentation": "

Describes the key of an application execution property key-value pair.

", + "smithy.api#documentation": "

Describes the value of an application execution property key-value pair.

", "smithy.api#required": {} } }, - "PropertyMap": { - "target": "com.amazonaws.kinesisanalyticsv2#PropertyMap", + "PropertyGroupId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { - "smithy.api#documentation": "

Describes the value of an application execution property key-value pair.

", + "smithy.api#documentation": "

Describes the key of an application execution property key-value pair.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Property key-value pairs passed into a Java-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Property key-value pairs passed into a Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#PropertyGroups": { @@ -3934,11 +3958,10 @@ "com.amazonaws.kinesisanalyticsv2#RecordColumn": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.kinesisanalyticsv2#RecordColumnName", + "Mapping": { + "target": "com.amazonaws.kinesisanalyticsv2#RecordColumnMapping", "traits": { - "smithy.api#documentation": "

The name of the column that is created in the in-application input stream or reference\n table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A reference to the data element in the streaming input or the reference data\n source.

" } }, "SqlType": { @@ -3948,36 +3971,52 @@ "smithy.api#required": {} } }, - "Mapping": { - "target": "com.amazonaws.kinesisanalyticsv2#RecordColumnMapping", + "Name": { + "target": "com.amazonaws.kinesisanalyticsv2#RecordColumnName", "traits": { - "smithy.api#documentation": "

A reference to the data element in the streaming input or the reference data\n source.

" + "smithy.api#documentation": "

The name of the column that is created in the in-application input stream or reference\n table.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the mapping of each\n data element in the streaming source to the corresponding column in the in-application\n stream.

\n

Also used to describe the format of the reference data source.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the mapping of each\n data element in the streaming source to the corresponding column in the in-application\n stream.

\n

Also used to describe the format of the reference data source.

" } }, "com.amazonaws.kinesisanalyticsv2#RecordColumnDelimiter": { "type": "string", "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 1024 } } }, "com.amazonaws.kinesisanalyticsv2#RecordColumnMapping": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65535 + } + } }, "com.amazonaws.kinesisanalyticsv2#RecordColumnName": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "[^-\\s<>&]*" + } }, "com.amazonaws.kinesisanalyticsv2#RecordColumnSqlType": { "type": "string", "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 100 } } }, @@ -3996,28 +4035,32 @@ "com.amazonaws.kinesisanalyticsv2#RecordEncoding": { "type": "string", "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 + }, "smithy.api#pattern": "UTF-8" } }, "com.amazonaws.kinesisanalyticsv2#RecordFormat": { "type": "structure", "members": { + "MappingParameters": { + "target": "com.amazonaws.kinesisanalyticsv2#MappingParameters", + "traits": { + "smithy.api#documentation": "

When you configure application input at the time of creating or updating an application,\n provides additional mapping information specific to the record format (such as JSON, CSV, or\n record fields delimited by some delimiter) on the streaming source.

" + } + }, "RecordFormatType": { "target": "com.amazonaws.kinesisanalyticsv2#RecordFormatType", "traits": { "smithy.api#documentation": "

The type of record format.

", "smithy.api#required": {} } - }, - "MappingParameters": { - "target": "com.amazonaws.kinesisanalyticsv2#MappingParameters", - "traits": { - "smithy.api#documentation": "

When you configure application input at the time of creating or updating an application,\n provides additional mapping information specific to the record format (such as JSON, CSV, or\n record fields delimited by some delimiter) on the streaming source.

" - } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the record format\n and relevant mapping information that should be applied to schematize the records on the\n stream.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the record format\n and relevant mapping information that should be applied to schematize the records on the\n stream.

" } }, "com.amazonaws.kinesisanalyticsv2#RecordFormatType": { @@ -4039,7 +4082,8 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 1024 } } }, @@ -4047,13 +4091,21 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1 - } + "min": 1, + "max": 65535 + }, + "smithy.api#pattern": "^(?=^\\$)(?=^\\S+$).*$" } }, "com.amazonaws.kinesisanalyticsv2#ReferenceDataSource": { "type": "structure", "members": { + "S3ReferenceDataSource": { + "target": "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSource", + "traits": { + "smithy.api#documentation": "

Identifies the S3 bucket and object that contains the reference data.\n \n A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" + } + }, "TableName": { "target": "com.amazonaws.kinesisanalyticsv2#InAppTableName", "traits": { @@ -4067,25 +4119,19 @@ "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

", "smithy.api#required": {} } - }, - "S3ReferenceDataSource": { - "target": "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSource", - "traits": { - "smithy.api#documentation": "

Identifies the S3 bucket and object that contains the reference data.\n \n A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" - } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data\n source by providing the source information (Amazon S3 bucket name and object key name), the\n resulting in-application table name that is created, and the necessary schema to map the data\n elements in the Amazon S3 object to the in-application table.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the reference data\n source by providing the source information (Amazon S3 bucket name and object key name), the\n resulting in-application table name that is created, and the necessary schema to map the data\n elements in the Amazon S3 object to the in-application table.

" } }, "com.amazonaws.kinesisanalyticsv2#ReferenceDataSourceDescription": { "type": "structure", "members": { - "S3ReferenceDataSourceDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSourceDescription", + "TableName": { + "target": "com.amazonaws.kinesisanalyticsv2#InAppTableName", "traits": { - "smithy.api#documentation": "

Provides the Amazon S3 bucket name, the object key name that contains the reference data.

", + "smithy.api#documentation": "

The in-application table name created by the specific reference data source configuration.

", "smithy.api#required": {} } }, @@ -4102,16 +4148,16 @@ "smithy.api#required": {} } }, - "TableName": { - "target": "com.amazonaws.kinesisanalyticsv2#InAppTableName", + "S3ReferenceDataSourceDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSourceDescription", "traits": { - "smithy.api#documentation": "

The in-application table name created by the specific reference data source configuration.

", + "smithy.api#documentation": "

Provides the Amazon S3 bucket name, the object key name that contains the reference data.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data\n source configured for an application.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the reference data\n source configured for an application.

" } }, "com.amazonaws.kinesisanalyticsv2#ReferenceDataSourceDescriptions": { @@ -4123,10 +4169,16 @@ "com.amazonaws.kinesisanalyticsv2#ReferenceDataSourceUpdate": { "type": "structure", "members": { - "ReferenceSchemaUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#SourceSchema", + "TableNameUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#InAppTableName", + "traits": { + "smithy.api#documentation": "

The in-application table name that is created by this update.

" + } + }, + "S3ReferenceDataSourceUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSourceUpdate", "traits": { - "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + "smithy.api#documentation": "

Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the \n Amazon S3 object on your behalf and populate the in-application reference table.

" } }, "ReferenceId": { @@ -4136,21 +4188,15 @@ "smithy.api#required": {} } }, - "S3ReferenceDataSourceUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSourceUpdate", - "traits": { - "smithy.api#documentation": "

Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

" - } - }, - "TableNameUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#InAppTableName", + "ReferenceSchemaUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#SourceSchema", "traits": { - "smithy.api#documentation": "

The in-application table name that is created by this update.

" + "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to \n corresponding columns created in the in-application stream.

" } } }, "traits": { - "smithy.api#documentation": "

When you update a reference data source configuration for a\n SQL-based Amazon Kinesis Data Analytics application, this object provides all the updated values \n (such as the source bucket name and object key name), the in-application table name that is created, \n and updated mapping information that maps the data in the Amazon S3 object to the in-application \n reference table that is created.

" + "smithy.api#documentation": "

When you update a reference data source configuration for a\n SQL-based Kinesis Data Analytics application, this object provides all the updated values \n (such as the source bucket name and object key name), the in-application table name that is created, \n and updated mapping information that maps the data in the Amazon S3 object to the in-application \n reference table that is created.

" } }, "com.amazonaws.kinesisanalyticsv2#ReferenceDataSourceUpdates": { @@ -4207,7 +4253,7 @@ } }, "traits": { - "smithy.api#documentation": "

Discovery failed to get a record from the streaming source because of the Amazon Kinesis\n Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.

", + "smithy.api#documentation": "

Discovery failed to get a record from the streaming source because of the Kinesis\n Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.

", "smithy.api#error": "client" } }, @@ -4218,33 +4264,33 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + "smithy.api#pattern": "arn:.*" } }, "com.amazonaws.kinesisanalyticsv2#RunConfiguration": { "type": "structure", "members": { - "ApplicationRestoreConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreConfiguration", + "SqlRunConfigurations": { + "target": "com.amazonaws.kinesisanalyticsv2#SqlRunConfigurations", "traits": { - "smithy.api#documentation": "

Describes the restore behavior of a restarting application.

" + "smithy.api#documentation": "

Describes the starting parameters for a SQL-based Kinesis Data Analytics application\n application.

" } }, "FlinkRunConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#FlinkRunConfiguration", "traits": { - "smithy.api#documentation": "

Describes the starting parameters for an Apache Flink-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

" } }, - "SqlRunConfigurations": { - "target": "com.amazonaws.kinesisanalyticsv2#SqlRunConfigurations", + "ApplicationRestoreConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreConfiguration", "traits": { - "smithy.api#documentation": "

Describes the starting parameters for an SQL-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes the restore behavior of a restarting application.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the starting parameters for an Amazon Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes the starting parameters for an Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#RunConfigurationDescription": { @@ -4255,6 +4301,9 @@ "traits": { "smithy.api#documentation": "

Describes the restore behavior of a restarting application.

" } + }, + "FlinkRunConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#FlinkRunConfiguration" } }, "traits": { @@ -4264,21 +4313,21 @@ "com.amazonaws.kinesisanalyticsv2#RunConfigurationUpdate": { "type": "structure", "members": { - "FlinkRunConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#FlinkRunConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the starting parameters for an Apache Flink-based Kinesis Data Analytics application.

" - } - }, "ApplicationRestoreConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreConfiguration", "traits": { "smithy.api#documentation": "

Describes updates to the restore behavior of a restarting application.

" } + }, + "FlinkRunConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#FlinkRunConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes the updates to the starting parameters for a Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes the updates to the starting parameters for a Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#RuntimeEnvironment": { @@ -4303,12 +4352,6 @@ "com.amazonaws.kinesisanalyticsv2#S3ApplicationCodeLocationDescription": { "type": "structure", "members": { - "ObjectVersion": { - "target": "com.amazonaws.kinesisanalyticsv2#ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the object containing the application code.

" - } - }, "FileKey": { "target": "com.amazonaws.kinesisanalyticsv2#FileKey", "traits": { @@ -4322,10 +4365,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

", "smithy.api#required": {} } + }, + "ObjectVersion": { + "target": "com.amazonaws.kinesisanalyticsv2#ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the object containing the application code.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes the location of a Java-based Amazon Kinesis Data Analytics\n application's code stored in an S3 bucket.

" + "smithy.api#documentation": "

Describes the location of a Flink-based Kinesis Data Analytics application's code stored in an S3 bucket.

" } }, "com.amazonaws.kinesisanalyticsv2#S3Configuration": { @@ -4347,18 +4396,12 @@ } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, provides a description of an\n Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name\n of the Amazon S3 object that contains the data.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides a description of an\n Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name\n of the Amazon S3 object that contains the data.

" } }, "com.amazonaws.kinesisanalyticsv2#S3ContentLocation": { "type": "structure", "members": { - "ObjectVersion": { - "target": "com.amazonaws.kinesisanalyticsv2#ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the object containing the application code.

" - } - }, "FileKey": { "target": "com.amazonaws.kinesisanalyticsv2#FileKey", "traits": { @@ -4366,6 +4409,12 @@ "smithy.api#required": {} } }, + "ObjectVersion": { + "target": "com.amazonaws.kinesisanalyticsv2#ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the object containing the application code.

" + } + }, "BucketARN": { "target": "com.amazonaws.kinesisanalyticsv2#BucketARN", "traits": { @@ -4375,18 +4424,12 @@ } }, "traits": { - "smithy.api#documentation": "

For a Java-based Amazon Kinesis Data Analytics application, provides a\n description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket,\n the name of the Amazon S3 object that contains the data, and the version number of the Amazon\n S3 object that contains the data.

" + "smithy.api#documentation": "

For a Flink-based Kinesis Data Analytics application, provides a\n description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket,\n the name of the Amazon S3 object that contains the data, and the version number of the Amazon\n S3 object that contains the data.

" } }, "com.amazonaws.kinesisanalyticsv2#S3ContentLocationUpdate": { "type": "structure", "members": { - "FileKeyUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#FileKey", - "traits": { - "smithy.api#documentation": "

The new file key for the object containing the application code.

" - } - }, "ObjectVersionUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ObjectVersion", "traits": { @@ -4398,35 +4441,47 @@ "traits": { "smithy.api#documentation": "

The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.

" } + }, + "FileKeyUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#FileKey", + "traits": { + "smithy.api#documentation": "

The new file key for the object containing the application code.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes an update for the Amazon S3 code content location for a Java-based\n Amazon Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes an update for the Amazon S3 code content location for a \n Flink-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSource": { "type": "structure", "members": { - "BucketARN": { - "target": "com.amazonaws.kinesisanalyticsv2#BucketARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 bucket.

" - } - }, "FileKey": { "target": "com.amazonaws.kinesisanalyticsv2#FileKey", "traits": { "smithy.api#documentation": "

The object key name containing the reference data.

" } + }, + "BucketARN": { + "target": "com.amazonaws.kinesisanalyticsv2#BucketARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 bucket.

" + } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, identifies the Amazon S3\n bucket and object that contains the reference data.

\n \n

A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3\n bucket and object that contains the reference data.

\n \n

A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication \n operation to trigger reloading of data into your application.

" } }, "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSourceDescription": { "type": "structure", "members": { + "ReferenceRoleARN": { + "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3\n object on your behalf to populate the in-application reference table.

\n \n

Provided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.

\n " + } + }, "FileKey": { "target": "com.amazonaws.kinesisanalyticsv2#FileKey", "traits": { @@ -4440,36 +4495,30 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 bucket.

", "smithy.api#required": {} } - }, - "ReferenceRoleARN": { - "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3\n object on your behalf to populate the in-application reference table.

\n \n

Provided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.

\n " - } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, provides the bucket name and\n object key name that stores the reference data.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides the bucket name and\n object key name that stores the reference data.

" } }, "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSourceUpdate": { "type": "structure", "members": { - "FileKeyUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#FileKey", - "traits": { - "smithy.api#documentation": "

The object key name.

" - } - }, "BucketARNUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#BucketARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 bucket.

" } + }, + "FileKeyUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#FileKey", + "traits": { + "smithy.api#documentation": "

The object key name.

" + } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the Amazon S3 bucket\n name and object key name for an in-application reference table.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket\n name and object key name for an in-application reference table.

" } }, "com.amazonaws.kinesisanalyticsv2#SecurityGroupId": { @@ -4503,16 +4552,10 @@ "com.amazonaws.kinesisanalyticsv2#SnapshotDetails": { "type": "structure", "members": { - "SnapshotCreationTimestamp": { - "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the application snapshot.

" - } - }, - "SnapshotStatus": { - "target": "com.amazonaws.kinesisanalyticsv2#SnapshotStatus", + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

The status of the application snapshot.

", + "smithy.api#documentation": "

The current application version ID when the snapshot was created.

", "smithy.api#required": {} } }, @@ -4523,12 +4566,18 @@ "smithy.api#required": {} } }, - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "SnapshotStatus": { + "target": "com.amazonaws.kinesisanalyticsv2#SnapshotStatus", "traits": { - "smithy.api#documentation": "

The current application version ID when the snapshot was created.

", + "smithy.api#documentation": "

The status of the application snapshot.

", "smithy.api#required": {} } + }, + "SnapshotCreationTimestamp": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the application snapshot.

" + } } }, "traits": { @@ -4577,10 +4626,10 @@ "com.amazonaws.kinesisanalyticsv2#SourceSchema": { "type": "structure", "members": { - "RecordFormat": { - "target": "com.amazonaws.kinesisanalyticsv2#RecordFormat", + "RecordColumns": { + "target": "com.amazonaws.kinesisanalyticsv2#RecordColumns", "traits": { - "smithy.api#documentation": "

Specifies the format of the records on the streaming source.

", + "smithy.api#documentation": "

A list of RecordColumn objects.

", "smithy.api#required": {} } }, @@ -4590,16 +4639,16 @@ "smithy.api#documentation": "

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" } }, - "RecordColumns": { - "target": "com.amazonaws.kinesisanalyticsv2#RecordColumns", + "RecordFormat": { + "target": "com.amazonaws.kinesisanalyticsv2#RecordFormat", "traits": { - "smithy.api#documentation": "

A list of RecordColumn objects.

", + "smithy.api#documentation": "

Specifies the format of the records on the streaming source.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

For an SQL-based Amazon Kinesis Data Analytics application, describes the format of the\n data in the streaming source, and how each data element maps to corresponding columns created\n in the in-application stream.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, describes the format of the\n data in the streaming source, and how each data element maps to corresponding columns created\n in the in-application stream.

" } }, "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfiguration": { @@ -4625,24 +4674,24 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the inputs, outputs, and reference data sources for an SQL-based Kinesis Data\n Analytics application.

" + "smithy.api#documentation": "

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfigurationDescription": { "type": "structure", "members": { - "OutputDescriptions": { - "target": "com.amazonaws.kinesisanalyticsv2#OutputDescriptions", - "traits": { - "smithy.api#documentation": "

The array of OutputDescription objects describing the destination\n streams used by the application.

" - } - }, "ReferenceDataSourceDescriptions": { "target": "com.amazonaws.kinesisanalyticsv2#ReferenceDataSourceDescriptions", "traits": { "smithy.api#documentation": "

The array of ReferenceDataSourceDescription objects describing the\n reference data sources used by the application.

" } }, + "OutputDescriptions": { + "target": "com.amazonaws.kinesisanalyticsv2#OutputDescriptions", + "traits": { + "smithy.api#documentation": "

The array of OutputDescription objects describing the destination\n streams used by the application.

" + } + }, "InputDescriptions": { "target": "com.amazonaws.kinesisanalyticsv2#InputDescriptions", "traits": { @@ -4651,18 +4700,12 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the inputs, outputs, and reference data sources for an SQL-based Kinesis Data\n Analytics application.

" + "smithy.api#documentation": "

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#SqlApplicationConfigurationUpdate": { "type": "structure", "members": { - "InputUpdates": { - "target": "com.amazonaws.kinesisanalyticsv2#InputUpdates", - "traits": { - "smithy.api#documentation": "

The array of InputUpdate objects describing the new input streams used\n by the application.

" - } - }, "OutputUpdates": { "target": "com.amazonaws.kinesisanalyticsv2#OutputUpdates", "traits": { @@ -4674,32 +4717,38 @@ "traits": { "smithy.api#documentation": "

The array of ReferenceDataSourceUpdate objects describing the new\n reference data sources used by the application.

" } + }, + "InputUpdates": { + "target": "com.amazonaws.kinesisanalyticsv2#InputUpdates", + "traits": { + "smithy.api#documentation": "

The array of InputUpdate objects describing the new input streams used\n by the application.

" + } } }, "traits": { - "smithy.api#documentation": "

Describes updates to the input streams, destination streams, and reference data sources\n for an SQL-based Kinesis Data Analytics application.

" + "smithy.api#documentation": "

Describes updates to the input streams, destination streams, and reference data sources\n for a SQL-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#SqlRunConfiguration": { "type": "structure", "members": { - "InputStartingPositionConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#InputStartingPositionConfiguration", + "InputId": { + "target": "com.amazonaws.kinesisanalyticsv2#Id", "traits": { - "smithy.api#documentation": "

The point at which you want the application to start processing records from the streaming\n source.

", + "smithy.api#documentation": "

The input source ID. You can get this ID by calling the DescribeApplication operation.

", "smithy.api#required": {} } }, - "InputId": { - "target": "com.amazonaws.kinesisanalyticsv2#Id", + "InputStartingPositionConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#InputStartingPositionConfiguration", "traits": { - "smithy.api#documentation": "

The input source ID. You can get this ID by calling the DescribeApplication operation.

", + "smithy.api#documentation": "

The point at which you want the application to start processing records from the streaming\n source.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes the starting parameters for an SQL-based Kinesis Data Analytics\n application.

" + "smithy.api#documentation": "

Describes the starting parameters for a SQL-based Kinesis Data Analytics application.

" } }, "com.amazonaws.kinesisanalyticsv2#SqlRunConfigurations": { @@ -4734,23 +4783,23 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to \n start your application.

" + "smithy.api#documentation": "

Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to \n start your application.

" } }, "com.amazonaws.kinesisanalyticsv2#StartApplicationRequest": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "RunConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#RunConfiguration", "traits": { - "smithy.api#documentation": "

The name of the application.

", + "smithy.api#documentation": "

Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.

", "smithy.api#required": {} } }, - "RunConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#RunConfiguration", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { - "smithy.api#documentation": "

Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.

", + "smithy.api#documentation": "

The name of the application.

", "smithy.api#required": {} } } @@ -4769,6 +4818,9 @@ "target": "com.amazonaws.kinesisanalyticsv2#StopApplicationResponse" }, "errors": [ + { + "target": "com.amazonaws.kinesisanalyticsv2#ConcurrentModificationException" + }, { "target": "com.amazonaws.kinesisanalyticsv2#InvalidApplicationConfigurationException" }, @@ -4792,6 +4844,12 @@ "com.amazonaws.kinesisanalyticsv2#StopApplicationRequest": { "type": "structure", "members": { + "Force": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "traits": { + "smithy.api#documentation": "

Set to true to force the application to stop. If you set Force\n to true, Kinesis Data Analytics stops the application without taking a snapshot.

\n

You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.

\n

The application must be in the\n STARTING, UPDATING, STOPPING, AUTOSCALING, or\n RUNNING state.

" + } + }, "ApplicationName": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { @@ -4838,7 +4896,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that \n the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.\n For more information, see Using Tagging.

" + "smithy.api#documentation": "

A key-value pair (the value is optional) that you can define and assign to AWS resources. \n If you specify a tag that already exists, the tag value is replaced with the value that you \n specify in the request. Note that \n the maximum number of application tags includes system tags. The maximum number of user-defined \n application tags is 50.\n For more information, see \n Using Tagging.

" } }, "com.amazonaws.kinesisanalyticsv2#TagKey": { @@ -4888,23 +4946,23 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.\n For more information, see Using Tagging.

" + "smithy.api#documentation": "

Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number of application \n tags includes system tags. The maximum number of user-defined application tags is 50.\n For more information, see Using Tagging.

" } }, "com.amazonaws.kinesisanalyticsv2#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.kinesisanalyticsv2#Tags", + "ResourceARN": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisAnalyticsARN", "traits": { - "smithy.api#documentation": "

The key-value tags to assign to the application.

", + "smithy.api#documentation": "

The ARN of the application to assign the tags.

", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisAnalyticsARN", + "Tags": { + "target": "com.amazonaws.kinesisanalyticsv2#Tags", "traits": { - "smithy.api#documentation": "

The ARN of the application to assign the tags.

", + "smithy.api#documentation": "

The key-value tags to assign to the application.

", "smithy.api#required": {} } } @@ -4955,18 +5013,15 @@ } }, "traits": { - "smithy.api#documentation": "

Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

", + "smithy.api#documentation": "

Application created with too many tags, or too many tags added to an application. Note that the maximum \n number of application tags includes system tags. The maximum number of user-defined application tags is 50.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesisanalyticsv2#UnableToDetectSchemaException": { "type": "structure", "members": { - "RawInputRecords": { - "target": "com.amazonaws.kinesisanalyticsv2#RawInputRecords", - "traits": { - "smithy.api#documentation": "

Raw stream data that was sampled to infer the schema.

" - } + "Message": { + "target": "com.amazonaws.kinesisanalyticsv2#ErrorMessage" }, "ProcessedInputRecords": { "target": "com.amazonaws.kinesisanalyticsv2#ProcessedInputRecords", @@ -4974,12 +5029,15 @@ "smithy.api#documentation": "

Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

" } }, - "Message": { - "target": "com.amazonaws.kinesisanalyticsv2#ErrorMessage" + "RawInputRecords": { + "target": "com.amazonaws.kinesisanalyticsv2#RawInputRecords", + "traits": { + "smithy.api#documentation": "

Raw stream data that was sampled to infer the schema.

" + } } }, "traits": { - "smithy.api#documentation": "

The data format is not valid. Amazon Kinesis Data Analytics cannot detect the schema for\n the given streaming source.

", + "smithy.api#documentation": "

The data format is not valid. Kinesis Data Analytics cannot detect the schema for\n the given streaming source.

", "smithy.api#error": "client" } }, @@ -4991,7 +5049,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

", + "smithy.api#documentation": "

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this \n operation.

", "smithy.api#error": "client" } }, @@ -5021,23 +5079,23 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

" + "smithy.api#documentation": "

Removes one or more tags from a Kinesis Data Analytics application. For more information, see \n Using Tagging.

" } }, "com.amazonaws.kinesisanalyticsv2#UntagResourceRequest": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.kinesisanalyticsv2#KinesisAnalyticsARN", + "TagKeys": { + "target": "com.amazonaws.kinesisanalyticsv2#TagKeys", "traits": { - "smithy.api#documentation": "

The ARN of the Kinesis Analytics application from which to remove the tags.

", + "smithy.api#documentation": "

A list of keys of tags to remove from the specified application.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.kinesisanalyticsv2#TagKeys", + "ResourceARN": { + "target": "com.amazonaws.kinesisanalyticsv2#KinesisAnalyticsARN", "traits": { - "smithy.api#documentation": "

A list of keys of tags to remove from the specified application.

", + "smithy.api#documentation": "

The ARN of the Kinesis Data Analytics application from which to remove the tags.

", "smithy.api#required": {} } } @@ -5079,7 +5137,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you\n can update application code, input configuration, and output configuration.

\n

Kinesis Data Analytics updates the ApplicationVersionId each time you update\n your application.

" + "smithy.api#documentation": "

Updates an existing Kinesis Data Analytics application. Using this operation, you\n can update application code, input configuration, and output configuration.

\n

Kinesis Data Analytics updates the ApplicationVersionId each time you update\n your application.

\n \n

You cannot update the RuntimeEnvironment of an existing application. If you\n need to update an application's RuntimeEnvironment, you must delete the application\n and create it again.

\n " } }, "com.amazonaws.kinesisanalyticsv2#UpdateApplicationRequest": { @@ -5091,17 +5149,10 @@ "smithy.api#documentation": "

Describes application Amazon CloudWatch logging option updates. You can only update\n existing CloudWatch logging options with this action. To add a new CloudWatch logging option,\n use AddApplicationCloudWatchLoggingOption.

" } }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

The current application version ID. You can retrieve the application version ID using DescribeApplication.

", - "smithy.api#required": {} - } - }, - "RunConfigurationUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#RunConfigurationUpdate", + "ServiceExecutionRoleUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", "traits": { - "smithy.api#documentation": "

Describes updates to the application's starting parameters.

" + "smithy.api#documentation": "

Describes updates to the service execution role.

" } }, "ApplicationName": { @@ -5111,16 +5162,23 @@ "smithy.api#required": {} } }, + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

The current application version ID. You can retrieve the application version ID using \n DescribeApplication.

", + "smithy.api#required": {} + } + }, "ApplicationConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationConfigurationUpdate", "traits": { "smithy.api#documentation": "

Describes application configuration updates.

" } }, - "ServiceExecutionRoleUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#RoleARN", + "RunConfigurationUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#RunConfigurationUpdate", "traits": { - "smithy.api#documentation": "

Describes updates to the service execution role.

" + "smithy.api#documentation": "

Describes updates to the application's starting parameters.

" } } } @@ -5140,17 +5198,17 @@ "com.amazonaws.kinesisanalyticsv2#VpcConfiguration": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.kinesisanalyticsv2#SubnetIds", + "SecurityGroupIds": { + "target": "com.amazonaws.kinesisanalyticsv2#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The array of Subnet IDs used by the VPC configuration.

", + "smithy.api#documentation": "

The array of SecurityGroup \n IDs used by the VPC configuration.

", "smithy.api#required": {} } }, - "SecurityGroupIds": { - "target": "com.amazonaws.kinesisanalyticsv2#SecurityGroupIds", + "SubnetIds": { + "target": "com.amazonaws.kinesisanalyticsv2#SubnetIds", "traits": { - "smithy.api#documentation": "

The array of SecurityGroup IDs used by the VPC configuration.

", + "smithy.api#documentation": "

The array of Subnet IDs \n used by the VPC configuration.

", "smithy.api#required": {} } } @@ -5165,7 +5223,14 @@ "SubnetIds": { "target": "com.amazonaws.kinesisanalyticsv2#SubnetIds", "traits": { - "smithy.api#documentation": "

The array of Subnet IDs used by the VPC configuration.

", + "smithy.api#documentation": "

The array of Subnet \n IDs used by the VPC configuration.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.kinesisanalyticsv2#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The array of SecurityGroup \n IDs used by the VPC configuration.

", "smithy.api#required": {} } }, @@ -5182,13 +5247,6 @@ "smithy.api#documentation": "

The ID of the VPC configuration.

", "smithy.api#required": {} } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.kinesisanalyticsv2#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

The array of SecurityGroup IDs used by the VPC configuration.

", - "smithy.api#required": {} - } } }, "traits": { @@ -5211,16 +5269,16 @@ "smithy.api#required": {} } }, - "SubnetIdUpdates": { - "target": "com.amazonaws.kinesisanalyticsv2#SubnetIds", + "SecurityGroupIdUpdates": { + "target": "com.amazonaws.kinesisanalyticsv2#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

Describes updates to the array of Subnet IDs \n used by the VPC configuration.

" + "smithy.api#documentation": "

Describes updates to the array of \n SecurityGroup IDs used by the VPC configuration.

" } }, - "SecurityGroupIdUpdates": { - "target": "com.amazonaws.kinesisanalyticsv2#SecurityGroupIds", + "SubnetIdUpdates": { + "target": "com.amazonaws.kinesisanalyticsv2#SubnetIds", "traits": { - "smithy.api#documentation": "

Describes updates to the array of SecurityGroup IDs used by the VPC configuration.

" + "smithy.api#documentation": "

Describes updates to the array of Subnet \n IDs \n used by the VPC configuration.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/kinesis-analytics.2015-08-14.json b/codegen/sdk-codegen/aws-models/kinesis-analytics.2015-08-14.json index 26ac5466b563..5435b1195d0b 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-analytics.2015-08-14.json +++ b/codegen/sdk-codegen/aws-models/kinesis-analytics.2015-08-14.json @@ -61,13 +61,6 @@ "com.amazonaws.kinesisanalytics#AddApplicationCloudWatchLoggingOptionRequest": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", - "traits": { - "smithy.api#documentation": "

The Kinesis Analytics application name.

", - "smithy.api#required": {} - } - }, "CurrentApplicationVersionId": { "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", "traits": { @@ -81,6 +74,13 @@ "smithy.api#documentation": "

Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN.\n Note: To write application messages to CloudWatch, the IAM role that is used must have\n the PutLogEvents policy action enabled.

", "smithy.api#required": {} } + }, + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "traits": { + "smithy.api#documentation": "

The Kinesis Analytics application name.

", + "smithy.api#required": {} + } } } }, @@ -159,17 +159,17 @@ "smithy.api#required": {} } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "InputId": { + "target": "com.amazonaws.kinesisanalytics#Id", "traits": { - "smithy.api#documentation": "

Name of the application to which you want to add the input processing configuration.

", + "smithy.api#documentation": "

The ID of the input configuration to add the input processing configuration to. You\n can get a list of the input IDs for an application using the DescribeApplication operation.

", "smithy.api#required": {} } }, - "InputId": { - "target": "com.amazonaws.kinesisanalytics#Id", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

The ID of the input configuration to add the input processing configuration to. You\n can get a list of the input IDs for an application using the DescribeApplication operation.

", + "smithy.api#documentation": "

Name of the application to which you want to add the input processing configuration.

", "smithy.api#required": {} } }, @@ -189,13 +189,6 @@ "com.amazonaws.kinesisanalytics#AddApplicationInputRequest": { "type": "structure", "members": { - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", - "traits": { - "smithy.api#documentation": "

Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation \n to find the current application version.

", - "smithy.api#required": {} - } - }, "ApplicationName": { "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { @@ -209,6 +202,13 @@ "smithy.api#documentation": "

The Input to add.

", "smithy.api#required": {} } + }, + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "

Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation \n to find the current application version.

", + "smithy.api#required": {} + } } }, "traits": { @@ -261,17 +261,17 @@ "smithy.api#required": {} } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "Output": { + "target": "com.amazonaws.kinesisanalytics#Output", "traits": { - "smithy.api#documentation": "

Name of the application to which you want to add the output configuration.

", + "smithy.api#documentation": "

An array of objects, each describing one output configuration. In the output\n configuration, you specify the name of an in-application stream, a destination (that is,\n an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda\n function), and record the formation to use when writing to the destination.

", "smithy.api#required": {} } }, - "Output": { - "target": "com.amazonaws.kinesisanalytics#Output", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

An array of objects, each describing one output configuration. In the output\n configuration, you specify the name of an in-application stream, a destination (that is,\n an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda\n function), and record the formation to use when writing to the destination.

", + "smithy.api#documentation": "

Name of the application to which you want to add the output configuration.

", "smithy.api#required": {} } } @@ -319,6 +319,13 @@ "com.amazonaws.kinesisanalytics#AddApplicationReferenceDataSourceRequest": { "type": "structure", "members": { + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "traits": { + "smithy.api#documentation": "

Name of an existing application.

", + "smithy.api#required": {} + } + }, "CurrentApplicationVersionId": { "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", "traits": { @@ -332,13 +339,6 @@ "smithy.api#documentation": "

The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.

", "smithy.api#required": {} } - }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", - "traits": { - "smithy.api#documentation": "

Name of an existing application.

", - "smithy.api#required": {} - } } }, "traits": { @@ -373,29 +373,23 @@ "com.amazonaws.kinesisanalytics#ApplicationDetail": { "type": "structure", "members": { - "InputDescriptions": { - "target": "com.amazonaws.kinesisanalytics#InputDescriptions", - "traits": { - "smithy.api#documentation": "

Describes the application input configuration. \n For more information, \n see Configuring Application Input. \n \n

" - } - }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "ApplicationStatus": { + "target": "com.amazonaws.kinesisanalytics#ApplicationStatus", "traits": { - "smithy.api#documentation": "

Name of the application.

", + "smithy.api#documentation": "

Status of the application.

", "smithy.api#required": {} } }, - "CreateTimestamp": { - "target": "com.amazonaws.kinesisanalytics#Timestamp", + "ApplicationCode": { + "target": "com.amazonaws.kinesisanalytics#ApplicationCode", "traits": { - "smithy.api#documentation": "

Time stamp when the application version was created.

" + "smithy.api#documentation": "

Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

" } }, - "ApplicationVersionId": { - "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", + "ApplicationARN": { + "target": "com.amazonaws.kinesisanalytics#ResourceARN", "traits": { - "smithy.api#documentation": "

Provides the current application version.

", + "smithy.api#documentation": "

ARN of the application.

", "smithy.api#required": {} } }, @@ -405,17 +399,10 @@ "smithy.api#documentation": "

Time stamp when the application was last updated.

" } }, - "ApplicationStatus": { - "target": "com.amazonaws.kinesisanalytics#ApplicationStatus", - "traits": { - "smithy.api#documentation": "

Status of the application.

", - "smithy.api#required": {} - } - }, - "ApplicationCode": { - "target": "com.amazonaws.kinesisanalytics#ApplicationCode", + "CloudWatchLoggingOptionDescriptions": { + "target": "com.amazonaws.kinesisanalytics#CloudWatchLoggingOptionDescriptions", "traits": { - "smithy.api#documentation": "

Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

" + "smithy.api#documentation": "

Describes the CloudWatch log streams that are configured to receive application\n messages. For more information about using CloudWatch log streams with Amazon Kinesis\n Analytics applications, see Working with Amazon\n CloudWatch Logs.

" } }, "ApplicationDescription": { @@ -424,23 +411,36 @@ "smithy.api#documentation": "

Description of the application.

" } }, - "ReferenceDataSourceDescriptions": { - "target": "com.amazonaws.kinesisanalytics#ReferenceDataSourceDescriptions", + "InputDescriptions": { + "target": "com.amazonaws.kinesisanalytics#InputDescriptions", "traits": { - "smithy.api#documentation": "

Describes reference data sources configured for the application. \n \n For more information, \n see Configuring Application Input. \n \n

" + "smithy.api#documentation": "

Describes the application input configuration. \n For more information, \n see Configuring Application Input. \n \n

" } }, - "ApplicationARN": { - "target": "com.amazonaws.kinesisanalytics#ResourceARN", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

ARN of the application.

", + "smithy.api#documentation": "

Name of the application.

", "smithy.api#required": {} } }, - "CloudWatchLoggingOptionDescriptions": { - "target": "com.amazonaws.kinesisanalytics#CloudWatchLoggingOptionDescriptions", + "ApplicationVersionId": { + "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

Describes the CloudWatch log streams that are configured to receive application\n messages. For more information about using CloudWatch log streams with Amazon Kinesis\n Analytics applications, see Working with Amazon\n CloudWatch Logs.

" + "smithy.api#documentation": "

Provides the current application version.

", + "smithy.api#required": {} + } + }, + "CreateTimestamp": { + "target": "com.amazonaws.kinesisanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "

Time stamp when the application version was created.

" + } + }, + "ReferenceDataSourceDescriptions": { + "target": "com.amazonaws.kinesisanalytics#ReferenceDataSourceDescriptions", + "traits": { + "smithy.api#documentation": "

Describes reference data sources configured for the application. \n \n For more information, \n see Configuring Application Input. \n \n

" } }, "OutputDescriptions": { @@ -504,17 +504,17 @@ "com.amazonaws.kinesisanalytics#ApplicationSummary": { "type": "structure", "members": { - "ApplicationARN": { - "target": "com.amazonaws.kinesisanalytics#ResourceARN", + "ApplicationStatus": { + "target": "com.amazonaws.kinesisanalytics#ApplicationStatus", "traits": { - "smithy.api#documentation": "

ARN of the application.

", + "smithy.api#documentation": "

Status of the application.

", "smithy.api#required": {} } }, - "ApplicationStatus": { - "target": "com.amazonaws.kinesisanalytics#ApplicationStatus", + "ApplicationARN": { + "target": "com.amazonaws.kinesisanalytics#ResourceARN", "traits": { - "smithy.api#documentation": "

Status of the application.

", + "smithy.api#documentation": "

ARN of the application.

", "smithy.api#required": {} } }, @@ -533,16 +533,16 @@ "com.amazonaws.kinesisanalytics#ApplicationUpdate": { "type": "structure", "members": { - "InputUpdates": { - "target": "com.amazonaws.kinesisanalytics#InputUpdates", + "ReferenceDataSourceUpdates": { + "target": "com.amazonaws.kinesisanalytics#ReferenceDataSourceUpdates", "traits": { - "smithy.api#documentation": "

Describes application input configuration updates.

" + "smithy.api#documentation": "

Describes application reference data source updates.

" } }, - "ApplicationCodeUpdate": { - "target": "com.amazonaws.kinesisanalytics#ApplicationCode", + "OutputUpdates": { + "target": "com.amazonaws.kinesisanalytics#OutputUpdates", "traits": { - "smithy.api#documentation": "

Describes application code updates.

" + "smithy.api#documentation": "

Describes application output configuration updates.

" } }, "CloudWatchLoggingOptionUpdates": { @@ -551,16 +551,16 @@ "smithy.api#documentation": "

Describes application CloudWatch logging option updates.

" } }, - "ReferenceDataSourceUpdates": { - "target": "com.amazonaws.kinesisanalytics#ReferenceDataSourceUpdates", + "InputUpdates": { + "target": "com.amazonaws.kinesisanalytics#InputUpdates", "traits": { - "smithy.api#documentation": "

Describes application reference data source updates.

" + "smithy.api#documentation": "

Describes application input configuration updates.

" } }, - "OutputUpdates": { - "target": "com.amazonaws.kinesisanalytics#OutputUpdates", + "ApplicationCodeUpdate": { + "target": "com.amazonaws.kinesisanalytics#ApplicationCode", "traits": { - "smithy.api#documentation": "

Describes application output configuration updates.

" + "smithy.api#documentation": "

Describes application code updates.

" } } }, @@ -619,17 +619,17 @@ "com.amazonaws.kinesisanalytics#CloudWatchLoggingOption": { "type": "structure", "members": { - "LogStreamARN": { - "target": "com.amazonaws.kinesisanalytics#LogStreamARN", + "RoleARN": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", "traits": { - "smithy.api#documentation": "

ARN of the CloudWatch log to receive application messages.

", + "smithy.api#documentation": "

IAM ARN of the role to use to send application messages. Note: To write application\n messages to CloudWatch, the IAM role that is used must have the\n PutLogEvents policy action enabled.

", "smithy.api#required": {} } }, - "RoleARN": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", + "LogStreamARN": { + "target": "com.amazonaws.kinesisanalytics#LogStreamARN", "traits": { - "smithy.api#documentation": "

IAM ARN of the role to use to send application messages. Note: To write application\n messages to CloudWatch, the IAM role that is used must have the\n PutLogEvents policy action enabled.

", + "smithy.api#documentation": "

ARN of the CloudWatch log to receive application messages.

", "smithy.api#required": {} } } @@ -777,22 +777,17 @@ "com.amazonaws.kinesisanalytics#CreateApplicationRequest": { "type": "structure", "members": { - "ApplicationDescription": { - "target": "com.amazonaws.kinesisanalytics#ApplicationDescription", - "traits": { - "smithy.api#documentation": "

Summary description of the application.

" - } - }, - "ApplicationCode": { - "target": "com.amazonaws.kinesisanalytics#ApplicationCode", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

One or more SQL statements that read input data, transform it, and generate output.\n For example, you can write a SQL statement that reads data from one in-application\n stream, generates a running average of the number of advertisement clicks by vendor, and\n insert resulting rows in another in-application stream using pumps. For more information\n about the typical pattern, see Application\n Code.

\n \n

You can provide such series of SQL statements, \n where output of one statement can be\n used as the input for the next statement. You store \n intermediate results by creating in-application streams and pumps.

\n \n

Note that the application code must create the streams with names \n specified in the Outputs. For example, \n if your Outputs defines output streams named \n ExampleOutputStream1 and ExampleOutputStream2,\n then your application code must create these streams.

" + "smithy.api#documentation": "

Name of your Amazon Kinesis Analytics application (for example, sample-app).

", + "smithy.api#required": {} } }, - "Outputs": { - "target": "com.amazonaws.kinesisanalytics#Outputs", + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.kinesisanalytics#CloudWatchLoggingOptions", "traits": { - "smithy.api#documentation": "

You can configure application output to write data from any of the in-application streams to up to three destinations.

\n

These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery\n streams, AWS Lambda destinations, or any combination of the three.

\n

In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the \n destination stream or Lambda function on your behalf.

\n

In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format\n of data in the stream (for example, JSON, CSV). You also must provide an IAM role that\n Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.

" + "smithy.api#documentation": "

Use this parameter to configure a CloudWatch log stream to monitor application\n configuration errors. For more information, see Working with Amazon\n CloudWatch Logs.

" } }, "Tags": { @@ -801,23 +796,28 @@ "smithy.api#documentation": "

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.\n For more information, see Using Tagging.

" } }, - "CloudWatchLoggingOptions": { - "target": "com.amazonaws.kinesisanalytics#CloudWatchLoggingOptions", + "Inputs": { + "target": "com.amazonaws.kinesisanalytics#Inputs", "traits": { - "smithy.api#documentation": "

Use this parameter to configure a CloudWatch log stream to monitor application\n configuration errors. For more information, see Working with Amazon\n CloudWatch Logs.

" + "smithy.api#documentation": "

Use this parameter to configure the application input.

\n

You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).

\n

For the streaming source, you provide its Amazon Resource Name (ARN) and format of\n data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role\n that Amazon Kinesis Analytics can assume to read this stream on your behalf.

\n

To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

" } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "ApplicationDescription": { + "target": "com.amazonaws.kinesisanalytics#ApplicationDescription", "traits": { - "smithy.api#documentation": "

Name of your Amazon Kinesis Analytics application (for example, sample-app).

", - "smithy.api#required": {} + "smithy.api#documentation": "

Summary description of the application.

" } }, - "Inputs": { - "target": "com.amazonaws.kinesisanalytics#Inputs", + "ApplicationCode": { + "target": "com.amazonaws.kinesisanalytics#ApplicationCode", "traits": { - "smithy.api#documentation": "

Use this parameter to configure the application input.

\n

You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).

\n

For the streaming source, you provide its Amazon Resource Name (ARN) and format of\n data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role\n that Amazon Kinesis Analytics can assume to read this stream on your behalf.

\n

To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

" + "smithy.api#documentation": "

One or more SQL statements that read input data, transform it, and generate output.\n For example, you can write a SQL statement that reads data from one in-application\n stream, generates a running average of the number of advertisement clicks by vendor, and\n insert resulting rows in another in-application stream using pumps. For more information\n about the typical pattern, see Application\n Code.

\n \n

You can provide such series of SQL statements, \n where output of one statement can be\n used as the input for the next statement. You store \n intermediate results by creating in-application streams and pumps.

\n \n

Note that the application code must create the streams with names \n specified in the Outputs. For example, \n if your Outputs defines output streams named \n ExampleOutputStream1 and ExampleOutputStream2,\n then your application code must create these streams.

" + } + }, + "Outputs": { + "target": "com.amazonaws.kinesisanalytics#Outputs", + "traits": { + "smithy.api#documentation": "

You can configure application output to write data from any of the in-application streams to up to three destinations.

\n

These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery\n streams, AWS Lambda destinations, or any combination of the three.

\n

In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the \n destination stream or Lambda function on your behalf.

\n

In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format\n of data in the stream (for example, JSON, CSV). You also must provide an IAM role that\n Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.

" } } }, @@ -898,6 +898,13 @@ "com.amazonaws.kinesisanalytics#DeleteApplicationCloudWatchLoggingOptionRequest": { "type": "structure", "members": { + "CloudWatchLoggingOptionId": { + "target": "com.amazonaws.kinesisanalytics#Id", + "traits": { + "smithy.api#documentation": "

The CloudWatchLoggingOptionId of the CloudWatch logging option to\n delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

", + "smithy.api#required": {} + } + }, "CurrentApplicationVersionId": { "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", "traits": { @@ -911,13 +918,6 @@ "smithy.api#documentation": "

The Kinesis Analytics application name.

", "smithy.api#required": {} } - }, - "CloudWatchLoggingOptionId": { - "target": "com.amazonaws.kinesisanalytics#Id", - "traits": { - "smithy.api#documentation": "

The CloudWatchLoggingOptionId of the CloudWatch logging option to\n delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

", - "smithy.api#required": {} - } } } }, @@ -957,13 +957,6 @@ "com.amazonaws.kinesisanalytics#DeleteApplicationInputProcessingConfigurationRequest": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", - "traits": { - "smithy.api#documentation": "

The Kinesis Analytics application name.

", - "smithy.api#required": {} - } - }, "CurrentApplicationVersionId": { "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", "traits": { @@ -977,6 +970,13 @@ "smithy.api#documentation": "

The ID of the input configuration from which to delete the input processing\n configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.

", "smithy.api#required": {} } + }, + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "traits": { + "smithy.api#documentation": "

The Kinesis Analytics application name.

", + "smithy.api#required": {} + } } } }, @@ -1023,17 +1023,17 @@ "smithy.api#required": {} } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "OutputId": { + "target": "com.amazonaws.kinesisanalytics#Id", "traits": { - "smithy.api#documentation": "

Amazon Kinesis Analytics application name.

", + "smithy.api#documentation": "

The ID of the configuration to delete. \n Each output configuration that is added to the application, either when the application is \n created or later using the AddApplicationOutput operation, has a unique ID. \n You need to provide the ID to uniquely identify the output configuration that you want to \n delete from the application configuration. \n You can use the DescribeApplication operation to get the specific\n OutputId. \n

", "smithy.api#required": {} } }, - "OutputId": { - "target": "com.amazonaws.kinesisanalytics#Id", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

The ID of the configuration to delete. \n Each output configuration that is added to the application, either when the application is \n created or later using the AddApplicationOutput operation, has a unique ID. \n You need to provide the ID to uniquely identify the output configuration that you want to \n delete from the application configuration. \n You can use the DescribeApplication operation to get the specific\n OutputId. \n

", + "smithy.api#documentation": "

Amazon Kinesis Analytics application name.

", "smithy.api#required": {} } } @@ -1081,10 +1081,10 @@ "com.amazonaws.kinesisanalytics#DeleteApplicationReferenceDataSourceRequest": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

Name of an existing application.

", + "smithy.api#documentation": "

Version of the application. \n You can use the DescribeApplication operation to get the current application version.\n If the version specified \n is not the current version, the ConcurrentModificationException is returned.

", "smithy.api#required": {} } }, @@ -1095,10 +1095,10 @@ "smithy.api#required": {} } }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

Version of the application. \n You can use the DescribeApplication operation to get the current application version.\n If the version specified \n is not the current version, the ConcurrentModificationException is returned.

", + "smithy.api#documentation": "

Name of an existing application.

", "smithy.api#required": {} } } @@ -1243,6 +1243,12 @@ "smithy.api#documentation": "

The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

" } }, + "ResourceARN": { + "target": "com.amazonaws.kinesisanalytics#ResourceARN", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the streaming source.

" + } + }, "InputStartingPositionConfiguration": { "target": "com.amazonaws.kinesisanalytics#InputStartingPositionConfiguration", "traits": { @@ -1254,22 +1260,16 @@ "traits": { "smithy.api#documentation": "

Specify this parameter to discover a schema from data in an Amazon S3\n object.

" } - }, - "ResourceARN": { - "target": "com.amazonaws.kinesisanalytics#ResourceARN", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the streaming source.

" - } } } }, "com.amazonaws.kinesisanalytics#DiscoverInputSchemaResponse": { "type": "structure", "members": { - "ParsedInputRecords": { - "target": "com.amazonaws.kinesisanalytics#ParsedInputRecords", + "RawInputRecords": { + "target": "com.amazonaws.kinesisanalytics#RawInputRecords", "traits": { - "smithy.api#documentation": "

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

" + "smithy.api#documentation": "

Raw stream data that was sampled to infer the schema.

" } }, "ProcessedInputRecords": { @@ -1278,16 +1278,16 @@ "smithy.api#documentation": "

Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

" } }, - "InputSchema": { - "target": "com.amazonaws.kinesisanalytics#SourceSchema", + "ParsedInputRecords": { + "target": "com.amazonaws.kinesisanalytics#ParsedInputRecords", "traits": { - "smithy.api#documentation": "

Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

" + "smithy.api#documentation": "

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

" } }, - "RawInputRecords": { - "target": "com.amazonaws.kinesisanalytics#RawInputRecords", + "InputSchema": { + "target": "com.amazonaws.kinesisanalytics#SourceSchema", "traits": { - "smithy.api#documentation": "

Raw stream data that was sampled to infer the schema.

" + "smithy.api#documentation": "

Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

" } } }, @@ -1344,23 +1344,23 @@ "com.amazonaws.kinesisanalytics#Input": { "type": "structure", "members": { - "InputParallelism": { - "target": "com.amazonaws.kinesisanalytics#InputParallelism", + "NamePrefix": { + "target": "com.amazonaws.kinesisanalytics#InAppStreamName", "traits": { - "smithy.api#documentation": "

Describes the number of in-application streams to create.

\n

Data from your source is routed to these in-application input streams.

\n

(see Configuring Application Input.

" + "smithy.api#documentation": "

Name prefix to use when creating an in-application stream. Suppose that you specify\n a prefix \"MyInApplicationStream.\" Amazon Kinesis Analytics then creates one or more (as\n per the InputParallelism count you specified) in-application streams with\n names \"MyInApplicationStream_001,\" \"MyInApplicationStream_002,\" and so on.

", + "smithy.api#required": {} } }, - "KinesisStreamsInput": { - "target": "com.amazonaws.kinesisanalytics#KinesisStreamsInput", + "InputProcessingConfiguration": { + "target": "com.amazonaws.kinesisanalytics#InputProcessingConfiguration", "traits": { - "smithy.api#documentation": "

If the streaming source is an Amazon Kinesis stream, \n identifies the stream's Amazon Resource Name (ARN) and an IAM role \n that enables Amazon Kinesis Analytics to access the stream on your behalf.

\n

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

" + "smithy.api#documentation": "

The InputProcessingConfiguration for the input. An input\n processor transforms records as they are received from the stream, before the\n application's SQL code executes. Currently, the only input processing configuration\n available is InputLambdaProcessor.

" } }, - "NamePrefix": { - "target": "com.amazonaws.kinesisanalytics#InAppStreamName", + "KinesisStreamsInput": { + "target": "com.amazonaws.kinesisanalytics#KinesisStreamsInput", "traits": { - "smithy.api#documentation": "

Name prefix to use when creating an in-application stream. Suppose that you specify\n a prefix \"MyInApplicationStream.\" Amazon Kinesis Analytics then creates one or more (as\n per the InputParallelism count you specified) in-application streams with\n names \"MyInApplicationStream_001,\" \"MyInApplicationStream_002,\" and so on.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If the streaming source is an Amazon Kinesis stream, \n identifies the stream's Amazon Resource Name (ARN) and an IAM role \n that enables Amazon Kinesis Analytics to access the stream on your behalf.

\n

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

" } }, "KinesisFirehoseInput": { @@ -1376,10 +1376,10 @@ "smithy.api#required": {} } }, - "InputProcessingConfiguration": { - "target": "com.amazonaws.kinesisanalytics#InputProcessingConfiguration", + "InputParallelism": { + "target": "com.amazonaws.kinesisanalytics#InputParallelism", "traits": { - "smithy.api#documentation": "

The InputProcessingConfiguration for the input. An input\n processor transforms records as they are received from the stream, before the\n application's SQL code executes. Currently, the only input processing configuration\n available is InputLambdaProcessor.

" + "smithy.api#documentation": "

Describes the number of in-application streams to create.

\n

Data from your source is routed to these in-application input streams.

\n

(see Configuring Application Input.

" } } }, @@ -1418,34 +1418,34 @@ "com.amazonaws.kinesisanalytics#InputDescription": { "type": "structure", "members": { - "KinesisStreamsInputDescription": { - "target": "com.amazonaws.kinesisanalytics#KinesisStreamsInputDescription", + "InputSchema": { + "target": "com.amazonaws.kinesisanalytics#SourceSchema", "traits": { - "smithy.api#documentation": "

If an Amazon Kinesis stream is configured as streaming source, provides Amazon\n Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis\n Analytics to access the stream on your behalf.

" + "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding \n columns in the in-application stream that is being created.

" } }, - "InputStartingPositionConfiguration": { - "target": "com.amazonaws.kinesisanalytics#InputStartingPositionConfiguration", + "InputParallelism": { + "target": "com.amazonaws.kinesisanalytics#InputParallelism", "traits": { - "smithy.api#documentation": "

Point at which the application is configured to read from the input stream.

" + "smithy.api#documentation": "

Describes the configured parallelism (number of in-application streams \n mapped to the streaming source).

" } }, - "KinesisFirehoseInputDescription": { - "target": "com.amazonaws.kinesisanalytics#KinesisFirehoseInputDescription", + "InputId": { + "target": "com.amazonaws.kinesisanalytics#Id", "traits": { - "smithy.api#documentation": "

If an Amazon Kinesis Firehose delivery stream is configured as a streaming source,\n provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics\n to access the stream on your behalf.

" + "smithy.api#documentation": "

Input ID associated with the application input. \n This is the ID that Amazon Kinesis Analytics assigns to each \n input configuration you add to your application.

" } }, - "InAppStreamNames": { - "target": "com.amazonaws.kinesisanalytics#InAppStreamNames", + "KinesisStreamsInputDescription": { + "target": "com.amazonaws.kinesisanalytics#KinesisStreamsInputDescription", "traits": { - "smithy.api#documentation": "

Returns the in-application stream names that are mapped to the \n stream source.

" + "smithy.api#documentation": "

If an Amazon Kinesis stream is configured as streaming source, provides Amazon\n Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis\n Analytics to access the stream on your behalf.

" } }, - "NamePrefix": { - "target": "com.amazonaws.kinesisanalytics#InAppStreamName", + "InputStartingPositionConfiguration": { + "target": "com.amazonaws.kinesisanalytics#InputStartingPositionConfiguration", "traits": { - "smithy.api#documentation": "

In-application name prefix.

" + "smithy.api#documentation": "

Point at which the application is configured to read from the input stream.

" } }, "InputProcessingConfigurationDescription": { @@ -1454,22 +1454,22 @@ "smithy.api#documentation": "

The description of the preprocessor that executes on records in this input before the application's code is run.

" } }, - "InputSchema": { - "target": "com.amazonaws.kinesisanalytics#SourceSchema", + "KinesisFirehoseInputDescription": { + "target": "com.amazonaws.kinesisanalytics#KinesisFirehoseInputDescription", "traits": { - "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding \n columns in the in-application stream that is being created.

" + "smithy.api#documentation": "

If an Amazon Kinesis Firehose delivery stream is configured as a streaming source,\n provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics\n to access the stream on your behalf.

" } }, - "InputId": { - "target": "com.amazonaws.kinesisanalytics#Id", + "NamePrefix": { + "target": "com.amazonaws.kinesisanalytics#InAppStreamName", "traits": { - "smithy.api#documentation": "

Input ID associated with the application input. \n This is the ID that Amazon Kinesis Analytics assigns to each \n input configuration you add to your application.

" + "smithy.api#documentation": "

In-application name prefix.

" } }, - "InputParallelism": { - "target": "com.amazonaws.kinesisanalytics#InputParallelism", + "InAppStreamNames": { + "target": "com.amazonaws.kinesisanalytics#InAppStreamNames", "traits": { - "smithy.api#documentation": "

Describes the configured parallelism (number of in-application streams \n mapped to the streaming source).

" + "smithy.api#documentation": "

Returns the in-application stream names that are mapped to the \n stream source.

" } } }, @@ -1486,17 +1486,17 @@ "com.amazonaws.kinesisanalytics#InputLambdaProcessor": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.kinesisanalytics#ResourceARN", + "RoleARN": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Lambda function that operates\n on records in the stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", + "smithy.api#documentation": "

The ARN of the IAM role that is used to access the AWS Lambda function.

", "smithy.api#required": {} } }, - "RoleARN": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", + "ResourceARN": { + "target": "com.amazonaws.kinesisanalytics#ResourceARN", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that is used to access the AWS Lambda function.

", + "smithy.api#documentation": "

The ARN of the AWS Lambda function that operates\n on records in the stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n ", "smithy.api#required": {} } } @@ -1528,17 +1528,17 @@ "com.amazonaws.kinesisanalytics#InputLambdaProcessorUpdate": { "type": "structure", "members": { - "RoleARNUpdate": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", - "traits": { - "smithy.api#documentation": "

The ARN of the new IAM role that is used to access the AWS Lambda\n function.

" - } - }, "ResourceARNUpdate": { "target": "com.amazonaws.kinesisanalytics#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new AWS Lambda function that\n is used to preprocess the records in the stream.

\n \n

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n

\n " } + }, + "RoleARNUpdate": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", + "traits": { + "smithy.api#documentation": "

The ARN of the new IAM role that is used to access the AWS Lambda\n function.

" + } } }, "traits": { @@ -1630,18 +1630,18 @@ "com.amazonaws.kinesisanalytics#InputSchemaUpdate": { "type": "structure", "members": { - "RecordEncodingUpdate": { - "target": "com.amazonaws.kinesisanalytics#RecordEncoding", - "traits": { - "smithy.api#documentation": "

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" - } - }, "RecordFormatUpdate": { "target": "com.amazonaws.kinesisanalytics#RecordFormat", "traits": { "smithy.api#documentation": "

Specifies the format of the records on the streaming source.

" } }, + "RecordEncodingUpdate": { + "target": "com.amazonaws.kinesisanalytics#RecordEncoding", + "traits": { + "smithy.api#documentation": "

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" + } + }, "RecordColumnUpdates": { "target": "com.amazonaws.kinesisanalytics#RecordColumns", "traits": { @@ -1689,12 +1689,6 @@ "com.amazonaws.kinesisanalytics#InputUpdate": { "type": "structure", "members": { - "NamePrefixUpdate": { - "target": "com.amazonaws.kinesisanalytics#InAppStreamName", - "traits": { - "smithy.api#documentation": "

Name prefix for in-application streams that Amazon Kinesis Analytics creates \n for the specific streaming source.

" - } - }, "InputId": { "target": "com.amazonaws.kinesisanalytics#Id", "traits": { @@ -1714,10 +1708,10 @@ "smithy.api#documentation": "

Describes updates for an input processing configuration.

" } }, - "InputSchemaUpdate": { - "target": "com.amazonaws.kinesisanalytics#InputSchemaUpdate", + "NamePrefixUpdate": { + "target": "com.amazonaws.kinesisanalytics#InAppStreamName", "traits": { - "smithy.api#documentation": "

Describes the data format on the streaming source, and \n how record elements on the streaming source map to columns of the in-application stream that is created.

" + "smithy.api#documentation": "

Name prefix for in-application streams that Amazon Kinesis Analytics creates \n for the specific streaming source.

" } }, "KinesisFirehoseInputUpdate": { @@ -1731,6 +1725,12 @@ "traits": { "smithy.api#documentation": "

Describes the parallelism updates (the number in-application \n streams Amazon Kinesis Analytics creates for the specific streaming source).

" } + }, + "InputSchemaUpdate": { + "target": "com.amazonaws.kinesisanalytics#InputSchemaUpdate", + "traits": { + "smithy.api#documentation": "

Describes the data format on the streaming source, and \n how record elements on the streaming source map to columns of the in-application stream that is created.

" + } } }, "traits": { @@ -1874,7 +1874,7 @@ "sdkId": "Kinesis Analytics", "arnNamespace": "kinesisanalytics", "cloudFormationName": "KinesisAnalytics", - "cloudTrailEventSource": "v20150814.analytics.kinesis.amazonaws.com" + "cloudTrailEventSource": "kinesisanalytics.amazonaws.com" }, "aws.auth#sigv4": { "name": "kinesisanalytics" @@ -1912,17 +1912,17 @@ "com.amazonaws.kinesisanalytics#KinesisFirehoseInputDescription": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.kinesisanalytics#ResourceARN", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

" - } - }, "RoleARN": { "target": "com.amazonaws.kinesisanalytics#RoleARN", "traits": { "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.

" } + }, + "ResourceARN": { + "target": "com.amazonaws.kinesisanalytics#ResourceARN", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

" + } } }, "traits": { @@ -1974,17 +1974,17 @@ "com.amazonaws.kinesisanalytics#KinesisFirehoseOutputDescription": { "type": "structure", "members": { - "RoleARN": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", - "traits": { - "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" - } - }, "ResourceARN": { "target": "com.amazonaws.kinesisanalytics#ResourceARN", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

" } + }, + "RoleARN": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", + "traits": { + "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" + } } }, "traits": { @@ -1994,17 +1994,17 @@ "com.amazonaws.kinesisanalytics#KinesisFirehoseOutputUpdate": { "type": "structure", "members": { - "ResourceARNUpdate": { - "target": "com.amazonaws.kinesisanalytics#ResourceARN", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.

" - } - }, "RoleARNUpdate": { "target": "com.amazonaws.kinesisanalytics#RoleARN", "traits": { "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream\n on your behalf. You need to grant the necessary permissions to this role.

" } + }, + "ResourceARNUpdate": { + "target": "com.amazonaws.kinesisanalytics#ResourceARN", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.

" + } } }, "traits": { @@ -2036,17 +2036,17 @@ "com.amazonaws.kinesisanalytics#KinesisStreamsInputDescription": { "type": "structure", "members": { - "RoleARN": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", - "traits": { - "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" - } - }, "ResourceARN": { "target": "com.amazonaws.kinesisanalytics#ResourceARN", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon Kinesis stream.

" } + }, + "RoleARN": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", + "traits": { + "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" + } } }, "traits": { @@ -2160,17 +2160,17 @@ "com.amazonaws.kinesisanalytics#LambdaOutputDescription": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.kinesisanalytics#ResourceARN", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the destination Lambda function.

" - } - }, "RoleARN": { "target": "com.amazonaws.kinesisanalytics#RoleARN", "traits": { "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.

" } + }, + "ResourceARN": { + "target": "com.amazonaws.kinesisanalytics#ResourceARN", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the destination Lambda function.

" + } } }, "traits": { @@ -2350,18 +2350,11 @@ }, "traits": { "smithy.api#documentation": "

When configuring application input \n at the time of creating or updating an application, \n provides additional mapping information specific to \n the record format (such as JSON, CSV, or record fields delimited \n by some delimiter) on the streaming source.

" - } - }, - "com.amazonaws.kinesisanalytics#Output": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.kinesisanalytics#InAppStreamName", - "traits": { - "smithy.api#documentation": "

Name of the in-application stream.

", - "smithy.api#required": {} - } - }, + } + }, + "com.amazonaws.kinesisanalytics#Output": { + "type": "structure", + "members": { "KinesisFirehoseOutput": { "target": "com.amazonaws.kinesisanalytics#KinesisFirehoseOutput", "traits": { @@ -2374,6 +2367,13 @@ "smithy.api#documentation": "

Identifies an AWS Lambda function as the destination.

" } }, + "Name": { + "target": "com.amazonaws.kinesisanalytics#InAppStreamName", + "traits": { + "smithy.api#documentation": "

Name of the in-application stream.

", + "smithy.api#required": {} + } + }, "KinesisStreamsOutput": { "target": "com.amazonaws.kinesisanalytics#KinesisStreamsOutput", "traits": { @@ -2395,22 +2395,10 @@ "com.amazonaws.kinesisanalytics#OutputDescription": { "type": "structure", "members": { - "KinesisFirehoseOutputDescription": { - "target": "com.amazonaws.kinesisanalytics#KinesisFirehoseOutputDescription", - "traits": { - "smithy.api#documentation": "

Describes the Amazon Kinesis Firehose delivery stream configured as the \n destination where output is written.

" - } - }, - "Name": { - "target": "com.amazonaws.kinesisanalytics#InAppStreamName", - "traits": { - "smithy.api#documentation": "

Name of the in-application stream configured as output.

" - } - }, - "LambdaOutputDescription": { - "target": "com.amazonaws.kinesisanalytics#LambdaOutputDescription", + "KinesisStreamsOutputDescription": { + "target": "com.amazonaws.kinesisanalytics#KinesisStreamsOutputDescription", "traits": { - "smithy.api#documentation": "

Describes the AWS Lambda function configured as the destination where output is\n written.

" + "smithy.api#documentation": "

Describes Amazon Kinesis stream configured as the \n destination where output is written.

" } }, "DestinationSchema": { @@ -2425,10 +2413,22 @@ "smithy.api#documentation": "

A unique identifier for the output configuration.

" } }, - "KinesisStreamsOutputDescription": { - "target": "com.amazonaws.kinesisanalytics#KinesisStreamsOutputDescription", + "Name": { + "target": "com.amazonaws.kinesisanalytics#InAppStreamName", "traits": { - "smithy.api#documentation": "

Describes Amazon Kinesis stream configured as the \n destination where output is written.

" + "smithy.api#documentation": "

Name of the in-application stream configured as output.

" + } + }, + "KinesisFirehoseOutputDescription": { + "target": "com.amazonaws.kinesisanalytics#KinesisFirehoseOutputDescription", + "traits": { + "smithy.api#documentation": "

Describes the Amazon Kinesis Firehose delivery stream configured as the \n destination where output is written.

" + } + }, + "LambdaOutputDescription": { + "target": "com.amazonaws.kinesisanalytics#LambdaOutputDescription", + "traits": { + "smithy.api#documentation": "

Describes the AWS Lambda function configured as the destination where output is\n written.

" } } }, @@ -2445,10 +2445,10 @@ "com.amazonaws.kinesisanalytics#OutputUpdate": { "type": "structure", "members": { - "NameUpdate": { - "target": "com.amazonaws.kinesisanalytics#InAppStreamName", + "LambdaOutputUpdate": { + "target": "com.amazonaws.kinesisanalytics#LambdaOutputUpdate", "traits": { - "smithy.api#documentation": "

If you want to specify a different in-application stream \n for this output configuration, use this field to \n specify the new in-application stream name.

" + "smithy.api#documentation": "

Describes an AWS Lambda function as the destination for the output.

" } }, "KinesisFirehoseOutputUpdate": { @@ -2457,30 +2457,30 @@ "smithy.api#documentation": "

Describes an Amazon Kinesis Firehose delivery stream as the destination for the\n output.

" } }, - "DestinationSchemaUpdate": { - "target": "com.amazonaws.kinesisanalytics#DestinationSchema", - "traits": { - "smithy.api#documentation": "

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

" - } - }, - "LambdaOutputUpdate": { - "target": "com.amazonaws.kinesisanalytics#LambdaOutputUpdate", - "traits": { - "smithy.api#documentation": "

Describes an AWS Lambda function as the destination for the output.

" - } - }, "KinesisStreamsOutputUpdate": { "target": "com.amazonaws.kinesisanalytics#KinesisStreamsOutputUpdate", "traits": { "smithy.api#documentation": "

Describes an Amazon Kinesis stream as the destination for the output.

" } }, + "DestinationSchemaUpdate": { + "target": "com.amazonaws.kinesisanalytics#DestinationSchema", + "traits": { + "smithy.api#documentation": "

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

" + } + }, "OutputId": { "target": "com.amazonaws.kinesisanalytics#Id", "traits": { "smithy.api#documentation": "

Identifies the specific output configuration that you want to update.

", "smithy.api#required": {} } + }, + "NameUpdate": { + "target": "com.amazonaws.kinesisanalytics#InAppStreamName", + "traits": { + "smithy.api#documentation": "

If you want to specify a different in-application stream \n for this output configuration, use this field to \n specify the new in-application stream name.

" + } } }, "traits": { @@ -2535,10 +2535,11 @@ "com.amazonaws.kinesisanalytics#RecordColumn": { "type": "structure", "members": { - "Mapping": { - "target": "com.amazonaws.kinesisanalytics#RecordColumnMapping", + "SqlType": { + "target": "com.amazonaws.kinesisanalytics#RecordColumnSqlType", "traits": { - "smithy.api#documentation": "

Reference to the data element in the streaming input or the reference data source. This element\n is required if the RecordFormatType is JSON.

" + "smithy.api#documentation": "

Type of column created in the in-application input stream or reference table.

", + "smithy.api#required": {} } }, "Name": { @@ -2548,11 +2549,10 @@ "smithy.api#required": {} } }, - "SqlType": { - "target": "com.amazonaws.kinesisanalytics#RecordColumnSqlType", + "Mapping": { + "target": "com.amazonaws.kinesisanalytics#RecordColumnMapping", "traits": { - "smithy.api#documentation": "

Type of column created in the in-application input stream or reference table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Reference to the data element in the streaming input or the reference data source. This element\n is required if the RecordFormatType is JSON.

" } } }, @@ -2655,10 +2655,11 @@ "com.amazonaws.kinesisanalytics#ReferenceDataSource": { "type": "structure", "members": { - "S3ReferenceDataSource": { - "target": "com.amazonaws.kinesisanalytics#S3ReferenceDataSource", + "ReferenceSchema": { + "target": "com.amazonaws.kinesisanalytics#SourceSchema", "traits": { - "smithy.api#documentation": "

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.\n \n An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" + "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

", + "smithy.api#required": {} } }, "TableName": { @@ -2668,11 +2669,10 @@ "smithy.api#required": {} } }, - "ReferenceSchema": { - "target": "com.amazonaws.kinesisanalytics#SourceSchema", + "S3ReferenceDataSource": { + "target": "com.amazonaws.kinesisanalytics#S3ReferenceDataSource", "traits": { - "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.\n \n An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" } } }, @@ -2683,19 +2683,6 @@ "com.amazonaws.kinesisanalytics#ReferenceDataSourceDescription": { "type": "structure", "members": { - "ReferenceSchema": { - "target": "com.amazonaws.kinesisanalytics#SourceSchema", - "traits": { - "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" - } - }, - "TableName": { - "target": "com.amazonaws.kinesisanalytics#InAppTableName", - "traits": { - "smithy.api#documentation": "

The in-application table name created by the specific reference data source configuration.

", - "smithy.api#required": {} - } - }, "ReferenceId": { "target": "com.amazonaws.kinesisanalytics#Id", "traits": { @@ -2703,12 +2690,25 @@ "smithy.api#required": {} } }, + "ReferenceSchema": { + "target": "com.amazonaws.kinesisanalytics#SourceSchema", + "traits": { + "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + } + }, "S3ReferenceDataSourceDescription": { "target": "com.amazonaws.kinesisanalytics#S3ReferenceDataSourceDescription", "traits": { "smithy.api#documentation": "

Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

", "smithy.api#required": {} } + }, + "TableName": { + "target": "com.amazonaws.kinesisanalytics#InAppTableName", + "traits": { + "smithy.api#documentation": "

The in-application table name created by the specific reference data source configuration.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2724,17 +2724,10 @@ "com.amazonaws.kinesisanalytics#ReferenceDataSourceUpdate": { "type": "structure", "members": { - "ReferenceId": { - "target": "com.amazonaws.kinesisanalytics#Id", - "traits": { - "smithy.api#documentation": "

ID of the reference data source being updated. You can use the \n DescribeApplication operation to get this value.

", - "smithy.api#required": {} - } - }, - "TableNameUpdate": { - "target": "com.amazonaws.kinesisanalytics#InAppTableName", + "ReferenceSchemaUpdate": { + "target": "com.amazonaws.kinesisanalytics#SourceSchema", "traits": { - "smithy.api#documentation": "

In-application table name that is created by this update.

" + "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" } }, "S3ReferenceDataSourceUpdate": { @@ -2743,10 +2736,17 @@ "smithy.api#documentation": "

Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

" } }, - "ReferenceSchemaUpdate": { - "target": "com.amazonaws.kinesisanalytics#SourceSchema", + "TableNameUpdate": { + "target": "com.amazonaws.kinesisanalytics#InAppTableName", "traits": { - "smithy.api#documentation": "

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + "smithy.api#documentation": "

In-application table name that is created by this update.

" + } + }, + "ReferenceId": { + "target": "com.amazonaws.kinesisanalytics#Id", + "traits": { + "smithy.api#documentation": "

ID of the reference data source being updated. You can use the \n DescribeApplication operation to get this value.

", + "smithy.api#required": {} } } }, @@ -2825,6 +2825,13 @@ "com.amazonaws.kinesisanalytics#S3Configuration": { "type": "structure", "members": { + "RoleARN": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", + "traits": { + "smithy.api#documentation": "

IAM ARN of the role used to access the data.

", + "smithy.api#required": {} + } + }, "BucketARN": { "target": "com.amazonaws.kinesisanalytics#BucketARN", "traits": { @@ -2838,13 +2845,6 @@ "smithy.api#documentation": "

The name of the object that contains the data.

", "smithy.api#required": {} } - }, - "RoleARN": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", - "traits": { - "smithy.api#documentation": "

IAM ARN of the role used to access the data.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2854,6 +2854,13 @@ "com.amazonaws.kinesisanalytics#S3ReferenceDataSource": { "type": "structure", "members": { + "ReferenceRoleARN": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", + "traits": { + "smithy.api#documentation": "

ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

", + "smithy.api#required": {} + } + }, "BucketARN": { "target": "com.amazonaws.kinesisanalytics#BucketARN", "traits": { @@ -2867,13 +2874,6 @@ "smithy.api#documentation": "

Object key name containing reference data.

", "smithy.api#required": {} } - }, - "ReferenceRoleARN": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", - "traits": { - "smithy.api#documentation": "

ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2883,10 +2883,10 @@ "com.amazonaws.kinesisanalytics#S3ReferenceDataSourceDescription": { "type": "structure", "members": { - "FileKey": { - "target": "com.amazonaws.kinesisanalytics#FileKey", + "ReferenceRoleARN": { + "target": "com.amazonaws.kinesisanalytics#RoleARN", "traits": { - "smithy.api#documentation": "

Amazon S3 object key name.

", + "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

", "smithy.api#required": {} } }, @@ -2897,10 +2897,10 @@ "smithy.api#required": {} } }, - "ReferenceRoleARN": { - "target": "com.amazonaws.kinesisanalytics#RoleARN", + "FileKey": { + "target": "com.amazonaws.kinesisanalytics#FileKey", "traits": { - "smithy.api#documentation": "

ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

", + "smithy.api#documentation": "

Amazon S3 object key name.

", "smithy.api#required": {} } } @@ -2912,18 +2912,18 @@ "com.amazonaws.kinesisanalytics#S3ReferenceDataSourceUpdate": { "type": "structure", "members": { - "BucketARNUpdate": { - "target": "com.amazonaws.kinesisanalytics#BucketARN", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the S3 bucket.

" - } - }, "FileKeyUpdate": { "target": "com.amazonaws.kinesisanalytics#FileKey", "traits": { "smithy.api#documentation": "

Object key name.

" } }, + "BucketARNUpdate": { + "target": "com.amazonaws.kinesisanalytics#BucketARN", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the S3 bucket.

" + } + }, "ReferenceRoleARNUpdate": { "target": "com.amazonaws.kinesisanalytics#RoleARN", "traits": { @@ -2951,10 +2951,11 @@ "com.amazonaws.kinesisanalytics#SourceSchema": { "type": "structure", "members": { - "RecordEncoding": { - "target": "com.amazonaws.kinesisanalytics#RecordEncoding", + "RecordFormat": { + "target": "com.amazonaws.kinesisanalytics#RecordFormat", "traits": { - "smithy.api#documentation": "

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" + "smithy.api#documentation": "

Specifies the format of the records on the streaming source.

", + "smithy.api#required": {} } }, "RecordColumns": { @@ -2964,11 +2965,10 @@ "smithy.api#required": {} } }, - "RecordFormat": { - "target": "com.amazonaws.kinesisanalytics#RecordFormat", + "RecordEncoding": { + "target": "com.amazonaws.kinesisanalytics#RecordEncoding", "traits": { - "smithy.api#documentation": "

Specifies the format of the records on the streaming source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" } } }, @@ -3008,17 +3008,17 @@ "com.amazonaws.kinesisanalytics#StartApplicationRequest": { "type": "structure", "members": { - "InputConfigurations": { - "target": "com.amazonaws.kinesisanalytics#InputConfigurations", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.

", + "smithy.api#documentation": "

Name of the application.

", "smithy.api#required": {} } }, - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "InputConfigurations": { + "target": "com.amazonaws.kinesisanalytics#InputConfigurations", "traits": { - "smithy.api#documentation": "

Name of the application.

", + "smithy.api#documentation": "

Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.

", "smithy.api#required": {} } } @@ -3212,14 +3212,14 @@ "com.amazonaws.kinesisanalytics#UnableToDetectSchemaException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.kinesisanalytics#ErrorMessage" + "ProcessedInputRecords": { + "target": "com.amazonaws.kinesisanalytics#ProcessedInputRecords" }, "RawInputRecords": { "target": "com.amazonaws.kinesisanalytics#RawInputRecords" }, - "ProcessedInputRecords": { - "target": "com.amazonaws.kinesisanalytics#ProcessedInputRecords" + "message": { + "target": "com.amazonaws.kinesisanalytics#ErrorMessage" } }, "traits": { @@ -3326,10 +3326,10 @@ "com.amazonaws.kinesisanalytics#UpdateApplicationRequest": { "type": "structure", "members": { - "ApplicationName": { - "target": "com.amazonaws.kinesisanalytics#ApplicationName", + "CurrentApplicationVersionId": { + "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", "traits": { - "smithy.api#documentation": "

Name of the Amazon Kinesis Analytics application to update.

", + "smithy.api#documentation": "

The current application version ID. You can use the \n DescribeApplication operation to get this value.

", "smithy.api#required": {} } }, @@ -3340,10 +3340,10 @@ "smithy.api#required": {} } }, - "CurrentApplicationVersionId": { - "target": "com.amazonaws.kinesisanalytics#ApplicationVersionId", + "ApplicationName": { + "target": "com.amazonaws.kinesisanalytics#ApplicationName", "traits": { - "smithy.api#documentation": "

The current application version ID. You can use the \n DescribeApplication operation to get this value.

", + "smithy.api#documentation": "

Name of the Amazon Kinesis Analytics application to update.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/kinesis-video-archived-media.2017-09-30.json b/codegen/sdk-codegen/aws-models/kinesis-video-archived-media.2017-09-30.json index 69c8aadf8828..fc4aeed77179 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-video-archived-media.2017-09-30.json +++ b/codegen/sdk-codegen/aws-models/kinesis-video-archived-media.2017-09-30.json @@ -54,7 +54,7 @@ "sdkId": "Kinesis Video Archived Media", "arnNamespace": "kinesisvideo", "cloudFormationName": "KinesisVideoArchivedMedia", - "cloudTrailEventSource": "AWSAcuityReader.amazon.com" + "cloudTrailEventSource": "kinesisvideoarchivedmedia.amazonaws.com" }, "aws.auth#sigv4": { "name": "kinesisvideo" @@ -117,17 +117,17 @@ "com.amazonaws.kinesisvideoarchivedmedia#ClipTimestampRange": { "type": "structure", "members": { - "StartTimestamp": { + "EndTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The starting timestamp in the range of timestamps for which to return fragments.

\n

This value is inclusive. Fragments that start before the StartTimestamp\n and continue past it are included in the session. If FragmentSelectorType\n is SERVER_TIMESTAMP, the StartTimestamp must be later than the\n stream head.

", + "smithy.api#documentation": "

The end of the timestamp range for the requested media.

\n

This value must be within 3 hours of the specified StartTimestamp, and it\n must be later than the StartTimestamp value. If\n FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n

This value is inclusive. The EndTimestamp is compared to the (starting)\n timestamp of the fragment. Fragments that start before the EndTimestamp\n value and continue past it are included in the session.

", "smithy.api#required": {} } }, - "EndTimestamp": { + "StartTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the timestamp range for the requested media.

\n

This value must be within 3 hours of the specified StartTimestamp, and it\n must be later than the StartTimestamp value. If\n FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n

This value is inclusive. The EndTimestamp is compared to the (starting)\n timestamp of the fragment. Fragments that start before the EndTimestamp\n value and continue past it are included in the session.

", + "smithy.api#documentation": "

The starting timestamp in the range of timestamps for which to return fragments.

\n

This value is inclusive. Fragments that start before the StartTimestamp\n and continue past it are included in the session. If FragmentSelectorType\n is SERVER_TIMESTAMP, the StartTimestamp must be later than the\n stream head.

", "smithy.api#required": {} } } @@ -194,17 +194,17 @@ "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelector": { "type": "structure", "members": { - "TimestampRange": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHTimestampRange", - "traits": { - "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" - } - }, "FragmentSelectorType": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelectorType", "traits": { "smithy.api#documentation": "

The source of the timestamps for the requested media.

\n

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetDASHStreamingSessionURLInput$PlaybackMode is\n ON_DEMAND or LIVE_REPLAY, the first fragment ingested with\n a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In\n addition, the fragments with producer timestamps within the TimestampRange\n ingested immediately following the first fragment (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are\n included.

\n

Fragments that have duplicate producer timestamps are deduplicated. This means that if\n producers are producing a stream of fragments with producer timestamps that are\n approximately equal to the true clock time, the MPEG-DASH manifest will contain all of\n the fragments within the requested timestamp range. If some fragments are ingested\n within the same time range and very different points in time, only the oldest ingested\n collection of fragments are returned.

\n

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetDASHStreamingSessionURLInput$PlaybackMode is LIVE,\n the producer timestamps are used in the MP4 fragments and for deduplication. But the\n most recently ingested fragments based on server timestamps are included in the\n MPEG-DASH manifest. This means that even if fragments ingested in the past have producer\n timestamps with values now, they are not included in the HLS media playlist.

\n

The default is SERVER_TIMESTAMP.

" } + }, + "TimestampRange": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHTimestampRange", + "traits": { + "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" + } } }, "traits": { @@ -290,18 +290,6 @@ "smithy.api#documentation": "

The timestamp from the AWS server corresponding to the fragment.

" } }, - "FragmentLengthInMilliseconds": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#Long", - "traits": { - "smithy.api#documentation": "

The playback duration or other time value associated with the fragment.

" - } - }, - "FragmentSizeInBytes": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#Long", - "traits": { - "smithy.api#documentation": "

The total fragment size, including information about the fragment and contained media\n data.

" - } - }, "FragmentNumber": { "target": "com.amazonaws.kinesisvideoarchivedmedia#FragmentNumberString", "traits": { @@ -313,6 +301,18 @@ "traits": { "smithy.api#documentation": "

The timestamp from the producer corresponding to the fragment.

" } + }, + "FragmentLengthInMilliseconds": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Long", + "traits": { + "smithy.api#documentation": "

The playback duration or other time value associated with the fragment.

" + } + }, + "FragmentSizeInBytes": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Long", + "traits": { + "smithy.api#documentation": "

The total fragment size, including information about the fragment and contained media\n data.

" + } } }, "traits": { @@ -525,16 +525,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH\n manifest URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, - "DisplayFragmentTimestamp": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentTimestamp", + "PlaybackMode": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHPlaybackMode", "traits": { - "smithy.api#documentation": "

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file\n can be derived using attributes in the manifest itself. However, typically, MPEG-DASH\n compatible media players do not properly handle gaps in the media timeline. Kinesis\n Video Streams adjusts the media timeline in the manifest file to enable playback of\n media with discontinuities. Therefore, the wall-clock time derived from the manifest\n file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the\n accurate fragment timestamp is added to each S element in the manifest file with the\n attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this\n custom attribute.

\n

The default value is NEVER. When DASHFragmentSelector\n is SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when DASHFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start\n timestamps.

" + "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n \n

In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the larger fragment number (that is, the newer\n fragment) is included in the MPEG-DASH manifest. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media\n player.

\n

The default is LIVE.

" } }, - "DASHFragmentSelector": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelector", + "DisplayFragmentNumber": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentNumber", "traits": { - "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.

" + "smithy.api#documentation": "

Fragments are identified in the manifest file based on their sequence number in the\n session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video\n Streams fragment number is added to each S element in the manifest file with the\n attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with\n other APIs (e.g. GetMedia and GetMediaForFragmentList). A\n custom MPEG-DASH media player is necessary to leverage these this custom\n attribute.

\n

The default value is NEVER.

" } }, "StreamName": { @@ -543,12 +543,6 @@ "smithy.api#documentation": "

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, - "DisplayFragmentNumber": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentNumber", - "traits": { - "smithy.api#documentation": "

Fragments are identified in the manifest file based on their sequence number in the\n session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video\n Streams fragment number is added to each S element in the manifest file with the\n attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with\n other APIs (e.g. GetMedia and GetMediaForFragmentList). A\n custom MPEG-DASH media player is necessary to leverage these this custom\n attribute.

\n

The default value is NEVER.

" - } - }, "Expires": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Expires", "traits": { @@ -561,10 +555,16 @@ "smithy.api#documentation": "

The maximum number of fragments that are returned in the MPEG-DASH manifest.

\n

When the PlaybackMode is LIVE, the most recent fragments are\n returned up to this value. When the PlaybackMode is ON_DEMAND,\n the oldest fragments are returned, up to this maximum number.

\n

When there are a higher number of fragments available in a live MPEG-DASH manifest,\n video players often buffer content before starting playback. Increasing the buffer size\n increases the playback latency, but it decreases the likelihood that rebuffering will\n occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3\n fragments and a maximum of 10 fragments.

\n

The default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.

\n

The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on\n streams with 1-second fragments, and more than 2 1/2 hours of video on streams with\n 10-second fragments.

" } }, - "PlaybackMode": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHPlaybackMode", + "DisplayFragmentTimestamp": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentTimestamp", "traits": { - "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n \n

In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the larger fragment number (that is, the newer\n fragment) is included in the MPEG-DASH manifest. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media\n player.

\n

The default is LIVE.

" + "smithy.api#documentation": "

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file\n can be derived using attributes in the manifest itself. However, typically, MPEG-DASH\n compatible media players do not properly handle gaps in the media timeline. Kinesis\n Video Streams adjusts the media timeline in the manifest file to enable playback of\n media with discontinuities. Therefore, the wall-clock time derived from the manifest\n file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the\n accurate fragment timestamp is added to each S element in the manifest file with the\n attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this\n custom attribute.

\n

The default value is NEVER. When DASHFragmentSelector\n is SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when DASHFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start\n timestamps.

" + } + }, + "DASHFragmentSelector": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelector", + "traits": { + "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.

" } } } @@ -626,58 +626,58 @@ "com.amazonaws.kinesisvideoarchivedmedia#GetHLSStreamingSessionURLInput": { "type": "structure", "members": { - "DiscontinuityMode": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSDiscontinuityMode", + "StreamARN": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ResourceARN", "traits": { - "smithy.api#documentation": "

Specifies when flags marking discontinuities between fragments are added to the media\n playlists.

\n

Media players typically build a timeline of media content to play, based on the\n timestamps of each fragment. This means that if there is any overlap or gap between\n fragments (as is typical if HLSFragmentSelector is set to\n SERVER_TIMESTAMP), the media player timeline will also have small gaps\n between fragments in some places, and will overwrite frames in other places. Gaps in the\n media player timeline can cause playback to stall and overlaps can cause playback to be\n jittery. When there are discontinuity flags between fragments, the media player is\n expected to reset the timeline, resulting in the next fragment being played immediately\n after the previous fragment.

\n

The following modes are supported:

\n \n

The default is ALWAYS when HLSFragmentSelector is set\n to SERVER_TIMESTAMP, and NEVER when it is set to\n PRODUCER_TIMESTAMP.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master\n playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, - "ContainerFormat": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#ContainerFormat", + "PlaybackMode": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSPlaybackMode", "traits": { - "smithy.api#documentation": "

Specifies which format should be used for packaging the media. Specifying the\n FRAGMENTED_MP4 container format packages the media into MP4 fragments\n (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging\n overhead. The other container format option is MPEG_TS. HLS has supported\n MPEG TS chunks since it was released and is sometimes the only supported packaging on\n older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means\n MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

\n

The default is FRAGMENTED_MP4.

" + "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n \n

In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the larger fragment number (that is, the newer\n fragment) is included in the HLS media playlist. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the HLS media playlist. This can lead to unexpected behavior in the media\n player.

\n

The default is LIVE.

" } }, - "DisplayFragmentTimestamp": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSDisplayFragmentTimestamp", + "Expires": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Expires", "traits": { - "smithy.api#documentation": "

Specifies when the fragment start timestamps should be included in the HLS media\n playlist. Typically, media players report the playhead position as a time relative to\n the start of the first fragment in the playback session. However, when the start\n timestamps are included in the HLS media playlist, some media players might report the\n current playhead as an absolute time based on the fragment timestamps. This can be\n useful for creating a playback experience that shows viewers the wall-clock time of the\n media.

\n

The default is NEVER. When HLSFragmentSelector is\n SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when HLSFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.\n

" + "smithy.api#documentation": "

The time in seconds until the requested session expires. This value can be between 300\n (5 minutes) and 43200 (12 hours).

\n

When a session expires, no new calls to GetHLSMasterPlaylist,\n GetHLSMediaPlaylist, GetMP4InitFragment,\n GetMP4MediaFragment, or GetTSFragment can be made for that\n session.

\n

The default is 300 (5 minutes).

" } }, - "MaxMediaPlaylistFragmentResults": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#PageLimit", + "StreamName": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", "traits": { - "smithy.api#documentation": "

The maximum number of fragments that are returned in the HLS media playlists.

\n

When the PlaybackMode is LIVE, the most recent fragments are\n returned up to this value. When the PlaybackMode is ON_DEMAND,\n the oldest fragments are returned, up to this maximum number.

\n

When there are a higher number of fragments available in a live HLS media playlist,\n video players often buffer content before starting playback. Increasing the buffer size\n increases the playback latency, but it decreases the likelihood that rebuffering will\n occur during playback. We recommend that a live HLS media playlist have a minimum of 3\n fragments and a maximum of 10 fragments.

\n

The default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.

\n

The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on\n streams with 1-second fragments, and more than 2 1/2 hours of video on streams with\n 10-second fragments.

" + "smithy.api#documentation": "

The name of the stream for which to retrieve the HLS master playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, - "StreamARN": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#ResourceARN", + "HLSFragmentSelector": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSFragmentSelector", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master\n playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" + "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.

" } }, - "StreamName": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", + "MaxMediaPlaylistFragmentResults": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#PageLimit", "traits": { - "smithy.api#documentation": "

The name of the stream for which to retrieve the HLS master playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" + "smithy.api#documentation": "

The maximum number of fragments that are returned in the HLS media playlists.

\n

When the PlaybackMode is LIVE, the most recent fragments are\n returned up to this value. When the PlaybackMode is ON_DEMAND,\n the oldest fragments are returned, up to this maximum number.

\n

When there are a higher number of fragments available in a live HLS media playlist,\n video players often buffer content before starting playback. Increasing the buffer size\n increases the playback latency, but it decreases the likelihood that rebuffering will\n occur during playback. We recommend that a live HLS media playlist have a minimum of 3\n fragments and a maximum of 10 fragments.

\n

The default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.

\n

The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on\n streams with 1-second fragments, and more than 2 1/2 hours of video on streams with\n 10-second fragments.

" } }, - "PlaybackMode": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSPlaybackMode", + "DiscontinuityMode": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSDiscontinuityMode", "traits": { - "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n \n

In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the larger fragment number (that is, the newer\n fragment) is included in the HLS media playlist. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the HLS media playlist. This can lead to unexpected behavior in the media\n player.

\n

The default is LIVE.

" + "smithy.api#documentation": "

Specifies when flags marking discontinuities between fragments are added to the media\n playlists.

\n

Media players typically build a timeline of media content to play, based on the\n timestamps of each fragment. This means that if there is any overlap or gap between\n fragments (as is typical if HLSFragmentSelector is set to\n SERVER_TIMESTAMP), the media player timeline will also have small gaps\n between fragments in some places, and will overwrite frames in other places. Gaps in the\n media player timeline can cause playback to stall and overlaps can cause playback to be\n jittery. When there are discontinuity flags between fragments, the media player is\n expected to reset the timeline, resulting in the next fragment being played immediately\n after the previous fragment.

\n

The following modes are supported:

\n \n

The default is ALWAYS when HLSFragmentSelector is set\n to SERVER_TIMESTAMP, and NEVER when it is set to\n PRODUCER_TIMESTAMP.

" } }, - "Expires": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#Expires", + "ContainerFormat": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ContainerFormat", "traits": { - "smithy.api#documentation": "

The time in seconds until the requested session expires. This value can be between 300\n (5 minutes) and 43200 (12 hours).

\n

When a session expires, no new calls to GetHLSMasterPlaylist,\n GetHLSMediaPlaylist, GetMP4InitFragment,\n GetMP4MediaFragment, or GetTSFragment can be made for that\n session.

\n

The default is 300 (5 minutes).

" + "smithy.api#documentation": "

Specifies which format should be used for packaging the media. Specifying the\n FRAGMENTED_MP4 container format packages the media into MP4 fragments\n (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging\n overhead. The other container format option is MPEG_TS. HLS has supported\n MPEG TS chunks since it was released and is sometimes the only supported packaging on\n older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means\n MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

\n

The default is FRAGMENTED_MP4.

" } }, - "HLSFragmentSelector": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSFragmentSelector", + "DisplayFragmentTimestamp": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSDisplayFragmentTimestamp", "traits": { - "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.

" + "smithy.api#documentation": "

Specifies when the fragment start timestamps should be included in the HLS media\n playlist. Typically, media players report the playhead position as a time relative to\n the start of the first fragment in the playback session. However, when the start\n timestamps are included in the HLS media playlist, some media players might report the\n current playhead as an absolute time based on the fragment timestamps. This can be\n useful for creating a playback experience that shows viewers the wall-clock time of the\n media.

\n

The default is NEVER. When HLSFragmentSelector is\n SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when HLSFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.\n

" } } } @@ -727,17 +727,17 @@ "com.amazonaws.kinesisvideoarchivedmedia#GetMediaForFragmentListInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", + "Fragments": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#FragmentNumberList", "traits": { - "smithy.api#documentation": "

The name of the stream from which to retrieve fragment media.

", + "smithy.api#documentation": "

A list of the numbers of fragments for which to retrieve media. You retrieve these\n values with ListFragments.

", "smithy.api#required": {} } }, - "Fragments": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#FragmentNumberList", + "StreamName": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", "traits": { - "smithy.api#documentation": "

A list of the numbers of fragments for which to retrieve media. You retrieve these\n values with ListFragments.

", + "smithy.api#documentation": "

The name of the stream from which to retrieve fragment media.

", "smithy.api#required": {} } } @@ -746,19 +746,19 @@ "com.amazonaws.kinesisvideoarchivedmedia#GetMediaForFragmentListOutput": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#ContentType", - "traits": { - "smithy.api#documentation": "

The content type of the requested media.

", - "smithy.api#httpHeader": "Content-Type" - } - }, "Payload": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Payload", "traits": { "smithy.api#documentation": "

The payload that Kinesis Video Streams returns is a sequence of chunks from the\n specified stream. For information about the chunks, see PutMedia. The chunks that\n Kinesis Video Streams returns in the GetMediaForFragmentList call also\n include the following additional Matroska (MKV) tags:

\n \n

The following tags will be included if an exception occurs:

\n ", "smithy.api#httpPayload": {} } + }, + "ContentType": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ContentType", + "traits": { + "smithy.api#documentation": "

The content type of the requested media.

", + "smithy.api#httpHeader": "Content-Type" + } } } }, @@ -856,16 +856,16 @@ "com.amazonaws.kinesisvideoarchivedmedia#HLSTimestampRange": { "type": "structure", "members": { - "StartTimestamp": { + "EndTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the timestamp range for the requested media.

\n

If the HLSTimestampRange value is specified, the\n StartTimestamp value is required.

\n \n

This value is inclusive. Fragments that start before the\n StartTimestamp and continue past it are included in the session. If\n FragmentSelectorType is SERVER_TIMESTAMP, the\n StartTimestamp must be later than the stream head.

\n " + "smithy.api#documentation": "

The end of the timestamp range for the requested media. This value must be within 3\n hours of the specified StartTimestamp, and it must be later than the\n StartTimestamp value.

\n

If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n

The EndTimestamp value is required for ON_DEMAND mode, but\n optional for LIVE_REPLAY mode. If the EndTimestamp is not set\n for LIVE_REPLAY mode then the session will continue to include newly\n ingested fragments until the session expires.

\n \n

This value is inclusive. The EndTimestamp is compared to the\n (starting) timestamp of the fragment. Fragments that start before the\n EndTimestamp value and continue past it are included in the\n session.

\n " } }, - "EndTimestamp": { + "StartTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the timestamp range for the requested media. This value must be within 3\n hours of the specified StartTimestamp, and it must be later than the\n StartTimestamp value.

\n

If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n

The EndTimestamp value is required for ON_DEMAND mode, but\n optional for LIVE_REPLAY mode. If the EndTimestamp is not set\n for LIVE_REPLAY mode then the session will continue to include newly\n ingested fragments until the session expires.

\n \n

This value is inclusive. The EndTimestamp is compared to the\n (starting) timestamp of the fragment. Fragments that start before the\n EndTimestamp value and continue past it are included in the\n session.

\n " + "smithy.api#documentation": "

The start of the timestamp range for the requested media.

\n

If the HLSTimestampRange value is specified, the\n StartTimestamp value is required.

\n \n

This value is inclusive. Fragments that start before the\n StartTimestamp and continue past it are included in the session. If\n FragmentSelectorType is SERVER_TIMESTAMP, the\n StartTimestamp must be later than the stream head.

\n " } } }, @@ -946,11 +946,10 @@ "com.amazonaws.kinesisvideoarchivedmedia#ListFragmentsInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", + "FragmentSelector": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#FragmentSelector", "traits": { - "smithy.api#documentation": "

The name of the stream from which to retrieve a fragment list.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Describes the timestamp range and timestamp origin for the range of fragments to\n return.

" } }, "MaxResults": { @@ -965,10 +964,11 @@ "smithy.api#documentation": "

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated\n response.

" } }, - "FragmentSelector": { - "target": "com.amazonaws.kinesisvideoarchivedmedia#FragmentSelector", + "StreamName": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", "traits": { - "smithy.api#documentation": "

Describes the timestamp range and timestamp origin for the range of fragments to\n return.

" + "smithy.api#documentation": "

The name of the stream from which to retrieve a fragment list.

", + "smithy.api#required": {} } } } @@ -1097,17 +1097,17 @@ "com.amazonaws.kinesisvideoarchivedmedia#TimestampRange": { "type": "structure", "members": { - "StartTimestamp": { + "EndTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The starting timestamp in the range of timestamps for which to return\n fragments.

", + "smithy.api#documentation": "

The ending timestamp in the range of timestamps for which to return fragments.

", "smithy.api#required": {} } }, - "EndTimestamp": { + "StartTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The ending timestamp in the range of timestamps for which to return fragments.

", + "smithy.api#documentation": "

The starting timestamp in the range of timestamps for which to return\n fragments.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/kinesis-video-media.2017-09-30.json b/codegen/sdk-codegen/aws-models/kinesis-video-media.2017-09-30.json index 88550ca3ba75..271e6fe10cfb 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-video-media.2017-09-30.json +++ b/codegen/sdk-codegen/aws-models/kinesis-video-media.2017-09-30.json @@ -42,7 +42,7 @@ "sdkId": "Kinesis Video Media", "arnNamespace": "kinesisvideo", "cloudFormationName": "KinesisVideoMedia", - "cloudTrailEventSource": "model.ats.acuity.aws.amazon.com" + "cloudTrailEventSource": "kinesisvideomedia.amazonaws.com" }, "aws.auth#sigv4": { "name": "kinesisvideo" @@ -151,10 +151,11 @@ "com.amazonaws.kinesisvideomedia#GetMediaInput": { "type": "structure", "members": { - "StreamARN": { - "target": "com.amazonaws.kinesisvideomedia#ResourceARN", + "StartSelector": { + "target": "com.amazonaws.kinesisvideomedia#StartSelector", "traits": { - "smithy.api#documentation": "

The ARN of the stream from where you want to get the media content. If you don't\n specify the streamARN, you must specify the streamName.

" + "smithy.api#documentation": "

Identifies the starting chunk to get from the specified stream.

", + "smithy.api#required": {} } }, "StreamName": { @@ -163,11 +164,10 @@ "smithy.api#documentation": "

The Kinesis video stream name from where you want to get the media content. If you\n don't specify the streamName, you must specify the\n streamARN.

" } }, - "StartSelector": { - "target": "com.amazonaws.kinesisvideomedia#StartSelector", + "StreamARN": { + "target": "com.amazonaws.kinesisvideomedia#ResourceARN", "traits": { - "smithy.api#documentation": "

Identifies the starting chunk to get from the specified stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of the stream from where you want to get the media content. If you don't\n specify the streamARN, you must specify the streamName.

" } } } @@ -175,19 +175,19 @@ "com.amazonaws.kinesisvideomedia#GetMediaOutput": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.kinesisvideomedia#ContentType", - "traits": { - "smithy.api#documentation": "

The content type of the requested media.

", - "smithy.api#httpHeader": "Content-Type" - } - }, "Payload": { "target": "com.amazonaws.kinesisvideomedia#Payload", "traits": { "smithy.api#documentation": "

The payload Kinesis Video Streams returns is a sequence of chunks from the specified\n stream. For information about the chunks, see . The\n chunks that Kinesis Video Streams returns in the GetMedia call also include the\n following additional Matroska (MKV) tags:

\n \n

The following tags will be present if an error occurs:

\n \n

The error codes are as follows:

\n ", "smithy.api#httpPayload": {} } + }, + "ContentType": { + "target": "com.amazonaws.kinesisvideomedia#ContentType", + "traits": { + "smithy.api#documentation": "

The content type of the requested media.

", + "smithy.api#httpHeader": "Content-Type" + } } } }, @@ -262,6 +262,13 @@ "com.amazonaws.kinesisvideomedia#StartSelector": { "type": "structure", "members": { + "StartSelectorType": { + "target": "com.amazonaws.kinesisvideomedia#StartSelectorType", + "traits": { + "smithy.api#documentation": "

Identifies the fragment on the Kinesis video stream where you want to start getting the\n data from.

\n \n \n

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the\n startSelectorType, you don't provide any additional information in the\n startSelector.

\n ", + "smithy.api#required": {} + } + }, "ContinuationToken": { "target": "com.amazonaws.kinesisvideomedia#ContinuationToken", "traits": { @@ -279,13 +286,6 @@ "traits": { "smithy.api#documentation": "

Specifies the fragment number from where you want the GetMedia API to\n start returning the fragments.

" } - }, - "StartSelectorType": { - "target": "com.amazonaws.kinesisvideomedia#StartSelectorType", - "traits": { - "smithy.api#documentation": "

Identifies the fragment on the Kinesis video stream where you want to start getting the\n data from.

\n \n \n

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the\n startSelectorType, you don't provide any additional information in the\n startSelector.

\n ", - "smithy.api#required": {} - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/kinesis-video-signaling.2019-12-04.json b/codegen/sdk-codegen/aws-models/kinesis-video-signaling.2019-12-04.json index b76ac44d389a..7db6b078e62c 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-video-signaling.2019-12-04.json +++ b/codegen/sdk-codegen/aws-models/kinesis-video-signaling.2019-12-04.json @@ -45,7 +45,7 @@ "sdkId": "Kinesis Video Signaling", "arnNamespace": "kinesisvideo", "cloudFormationName": "KinesisVideoSignaling", - "cloudTrailEventSource": "signaling.kinesisvideo.amazonaws.com" + "cloudTrailEventSource": "kinesisvideosignaling.amazonaws.com" }, "aws.auth#sigv4": { "name": "kinesisvideo" @@ -130,10 +130,10 @@ "com.amazonaws.kinesisvideosignaling#GetIceServerConfigRequest": { "type": "structure", "members": { - "Service": { - "target": "com.amazonaws.kinesisvideosignaling#Service", + "Username": { + "target": "com.amazonaws.kinesisvideosignaling#Username", "traits": { - "smithy.api#documentation": "

Specifies the desired service. Currently, TURN is the only valid\n value.

" + "smithy.api#documentation": "

An optional user ID to be associated with the credentials.

" } }, "ClientId": { @@ -142,10 +142,10 @@ "smithy.api#documentation": "

Unique identifier for the viewer. Must be unique within the signaling channel.

" } }, - "Username": { - "target": "com.amazonaws.kinesisvideosignaling#Username", + "Service": { + "target": "com.amazonaws.kinesisvideosignaling#Service", "traits": { - "smithy.api#documentation": "

An optional user ID to be associated with the credentials.

" + "smithy.api#documentation": "

Specifies the desired service. Currently, TURN is the only valid\n value.

" } }, "ChannelARN": { @@ -177,12 +177,6 @@ "smithy.api#documentation": "

The period of time, in seconds, during which the username and password are\n valid.

" } }, - "Uris": { - "target": "com.amazonaws.kinesisvideosignaling#Uris", - "traits": { - "smithy.api#documentation": "

An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec. These URIs provide the different\n addresses and/or protocols that can be used to reach the TURN server.

" - } - }, "Password": { "target": "com.amazonaws.kinesisvideosignaling#Password", "traits": { @@ -194,6 +188,12 @@ "traits": { "smithy.api#documentation": "

A username to login to the ICE server.

" } + }, + "Uris": { + "target": "com.amazonaws.kinesisvideosignaling#Uris", + "traits": { + "smithy.api#documentation": "

An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec. These URIs provide the different\n addresses and/or protocols that can be used to reach the TURN server.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json b/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json index 57d97012e413..8e35213d2639 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json +++ b/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json @@ -106,24 +106,18 @@ "com.amazonaws.kinesisvideo#ChannelInfo": { "type": "structure", "members": { - "ChannelStatus": { - "target": "com.amazonaws.kinesisvideo#Status", - "traits": { - "smithy.api#documentation": "

Current status of the signaling channel.

" - } - }, - "ChannelARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the signaling channel.

" - } - }, "Version": { "target": "com.amazonaws.kinesisvideo#Version", "traits": { "smithy.api#documentation": "

The current version of the signaling channel.

" } }, + "ChannelType": { + "target": "com.amazonaws.kinesisvideo#ChannelType", + "traits": { + "smithy.api#documentation": "

The type of the signaling channel.

" + } + }, "CreationTime": { "target": "com.amazonaws.kinesisvideo#Timestamp", "traits": { @@ -142,10 +136,16 @@ "smithy.api#documentation": "

A structure that contains the configuration for the SINGLE_MASTER channel\n type.

" } }, - "ChannelType": { - "target": "com.amazonaws.kinesisvideo#ChannelType", + "ChannelARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { - "smithy.api#documentation": "

The type of the signaling channel.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the signaling channel.

" + } + }, + "ChannelStatus": { + "target": "com.amazonaws.kinesisvideo#Status", + "traits": { + "smithy.api#documentation": "

Current status of the signaling channel.

" } } }, @@ -172,17 +172,17 @@ "com.amazonaws.kinesisvideo#ChannelNameCondition": { "type": "structure", "members": { - "ComparisonValue": { - "target": "com.amazonaws.kinesisvideo#ChannelName", - "traits": { - "smithy.api#documentation": "

A value to compare.

" - } - }, "ComparisonOperator": { "target": "com.amazonaws.kinesisvideo#ComparisonOperator", "traits": { "smithy.api#documentation": "

A comparison operator. Currently, you can only specify the BEGINS_WITH\n operator, which finds signaling channels whose names begin with a given prefix.

" } + }, + "ComparisonValue": { + "target": "com.amazonaws.kinesisvideo#ChannelName", + "traits": { + "smithy.api#documentation": "

A value to compare.

" + } } }, "traits": { @@ -294,6 +294,12 @@ "com.amazonaws.kinesisvideo#CreateSignalingChannelInput": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.kinesisvideo#TagOnCreateList", + "traits": { + "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to associate with this channel.

" + } + }, "ChannelName": { "target": "com.amazonaws.kinesisvideo#ChannelName", "traits": { @@ -301,12 +307,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.kinesisvideo#TagOnCreateList", - "traits": { - "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to associate with this channel.

" - } - }, "SingleMasterConfiguration": { "target": "com.amazonaws.kinesisvideo#SingleMasterConfiguration", "traits": { @@ -375,6 +375,24 @@ "com.amazonaws.kinesisvideo#CreateStreamInput": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.kinesisvideo#ResourceTags", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with the specified stream. Each tag is a key-value pair\n (the value is optional).

" + } + }, + "DeviceName": { + "target": "com.amazonaws.kinesisvideo#DeviceName", + "traits": { + "smithy.api#documentation": "

The name of the device that is writing to the stream.

\n \n

In the current implementation, Kinesis Video Streams does not use this\n name.

\n " + } + }, + "DataRetentionInHours": { + "target": "com.amazonaws.kinesisvideo#DataRetentionInHours", + "traits": { + "smithy.api#documentation": "

The number of hours that you want to retain the data in the stream. Kinesis Video\n Streams retains the data in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

\n

When the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.

" + } + }, "MediaType": { "target": "com.amazonaws.kinesisvideo#MediaType", "traits": { @@ -393,24 +411,6 @@ "traits": { "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.

\n

If no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.

\n

For more information, see DescribeKey.

" } - }, - "DataRetentionInHours": { - "target": "com.amazonaws.kinesisvideo#DataRetentionInHours", - "traits": { - "smithy.api#documentation": "

The number of hours that you want to retain the data in the stream. Kinesis Video\n Streams retains the data in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

\n

When the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.

" - } - }, - "DeviceName": { - "target": "com.amazonaws.kinesisvideo#DeviceName", - "traits": { - "smithy.api#documentation": "

The name of the device that is writing to the stream.

\n \n

In the current implementation, Kinesis Video Streams does not use this\n name.

\n " - } - }, - "Tags": { - "target": "com.amazonaws.kinesisvideo#ResourceTags", - "traits": { - "smithy.api#documentation": "

A list of tags to associate with the specified stream. Each tag is a key-value pair\n (the value is optional).

" - } } } }, @@ -486,18 +486,18 @@ "com.amazonaws.kinesisvideo#DeleteSignalingChannelInput": { "type": "structure", "members": { + "CurrentVersion": { + "target": "com.amazonaws.kinesisvideo#Version", + "traits": { + "smithy.api#documentation": "

The current version of the signaling channel that you want to delete. You can obtain\n the current version by invoking the DescribeSignalingChannel or\n ListSignalingChannels API operations.

" + } + }, "ChannelARN": { "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the signaling channel that you want to\n delete.

", "smithy.api#required": {} } - }, - "CurrentVersion": { - "target": "com.amazonaws.kinesisvideo#Version", - "traits": { - "smithy.api#documentation": "

The current version of the signaling channel that you want to delete. You can obtain\n the current version by invoking the DescribeSignalingChannel or\n ListSignalingChannels API operations.

" - } } } }, @@ -598,17 +598,17 @@ "com.amazonaws.kinesisvideo#DescribeSignalingChannelInput": { "type": "structure", "members": { - "ChannelARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", - "traits": { - "smithy.api#documentation": "

The ARN of the signaling channel that you want to describe.

" - } - }, "ChannelName": { "target": "com.amazonaws.kinesisvideo#ChannelName", "traits": { "smithy.api#documentation": "

The name of the signaling channel that you want to describe.

" } + }, + "ChannelARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The ARN of the signaling channel that you want to describe.

" + } } } }, @@ -742,10 +742,11 @@ "com.amazonaws.kinesisvideo#GetDataEndpointInput": { "type": "structure", "members": { - "StreamARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", + "APIName": { + "target": "com.amazonaws.kinesisvideo#APIName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for.\n You must specify either this parameter or a StreamName in the request.\n

" + "smithy.api#documentation": "

The name of the API action for which to get an endpoint.

", + "smithy.api#required": {} } }, "StreamName": { @@ -754,11 +755,10 @@ "smithy.api#documentation": "

The name of the stream that you want to get the endpoint for. You must specify\n either this parameter or a StreamARN in the request.

" } }, - "APIName": { - "target": "com.amazonaws.kinesisvideo#APIName", + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { - "smithy.api#documentation": "

The name of the API action for which to get an endpoint.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for.\n You must specify either this parameter or a StreamName in the request.\n

" } } } @@ -811,18 +811,18 @@ "com.amazonaws.kinesisvideo#GetSignalingChannelEndpointInput": { "type": "structure", "members": { - "SingleMasterChannelEndpointConfiguration": { - "target": "com.amazonaws.kinesisvideo#SingleMasterChannelEndpointConfiguration", - "traits": { - "smithy.api#documentation": "

A structure containing the endpoint configuration for the SINGLE_MASTER\n channel type.

" - } - }, "ChannelARN": { "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the signalling channel for which you want to get an\n endpoint.

", "smithy.api#required": {} } + }, + "SingleMasterChannelEndpointConfiguration": { + "target": "com.amazonaws.kinesisvideo#SingleMasterChannelEndpointConfiguration", + "traits": { + "smithy.api#documentation": "

A structure containing the endpoint configuration for the SINGLE_MASTER\n channel type.

" + } } } }, @@ -943,7 +943,7 @@ "sdkId": "Kinesis Video", "arnNamespace": "kinesisvideo", "cloudFormationName": "KinesisVideo", - "cloudTrailEventSource": "v20170930.video.kinesis.amazon.com" + "cloudTrailEventSource": "kinesisvideo.amazonaws.com" }, "aws.auth#sigv4": { "name": "kinesisvideo" @@ -1015,10 +1015,10 @@ "com.amazonaws.kinesisvideo#ListSignalingChannelsInput": { "type": "structure", "members": { - "ChannelNameCondition": { - "target": "com.amazonaws.kinesisvideo#ChannelNameCondition", + "MaxResults": { + "target": "com.amazonaws.kinesisvideo#ListStreamsInputLimit", "traits": { - "smithy.api#documentation": "

Optional: Returns only the channels that satisfy a specific condition.

" + "smithy.api#documentation": "

The maximum number of channels to return in the response. The default is 500.

" } }, "NextToken": { @@ -1027,10 +1027,10 @@ "smithy.api#documentation": "

If you specify this parameter, when the result of a ListSignalingChannels\n operation is truncated, the call returns the NextToken in the response. To\n get another batch of channels, provide this token in your next request.

" } }, - "MaxResults": { - "target": "com.amazonaws.kinesisvideo#ListStreamsInputLimit", + "ChannelNameCondition": { + "target": "com.amazonaws.kinesisvideo#ChannelNameCondition", "traits": { - "smithy.api#documentation": "

The maximum number of channels to return in the response. The default is 500.

" + "smithy.api#documentation": "

Optional: Returns only the channels that satisfy a specific condition.

" } } } @@ -1086,12 +1086,6 @@ "com.amazonaws.kinesisvideo#ListStreamsInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.kinesisvideo#ListStreamsInputLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of streams to return in the response. The default is\n 10,000.

" - } - }, "NextToken": { "target": "com.amazonaws.kinesisvideo#NextToken", "traits": { @@ -1103,6 +1097,12 @@ "traits": { "smithy.api#documentation": "

Optional: Returns only streams that satisfy a specific condition. Currently, you\n can specify only the prefix of a stream name as a condition.

" } + }, + "MaxResults": { + "target": "com.amazonaws.kinesisvideo#ListStreamsInputLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of streams to return in the response. The default is\n 10,000.

" + } } } }, @@ -1119,17 +1119,17 @@ "com.amazonaws.kinesisvideo#ListStreamsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.kinesisvideo#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, the call returns this element with a token. To get\n the next batch of streams, use this token in your next request.

" - } - }, "StreamInfoList": { "target": "com.amazonaws.kinesisvideo#StreamInfoList", "traits": { "smithy.api#documentation": "

An array of StreamInfo objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.kinesisvideo#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, the call returns this element with a token. To get\n the next batch of streams, use this token in your next request.

" + } } } }, @@ -1185,17 +1185,17 @@ "com.amazonaws.kinesisvideo#ListTagsForResourceOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.kinesisvideo#ResourceTags", - "traits": { - "smithy.api#documentation": "

A map of tag keys and values associated with the specified signaling channel.

" - } - }, "NextToken": { "target": "com.amazonaws.kinesisvideo#NextToken", "traits": { "smithy.api#documentation": "

If you specify this parameter and the result of a ListTagsForResource\n call is truncated, the response includes a token that you can use in the next request to\n fetch the next set of tags.

" } + }, + "Tags": { + "target": "com.amazonaws.kinesisvideo#ResourceTags", + "traits": { + "smithy.api#documentation": "

A map of tag keys and values associated with the specified signaling channel.

" + } } } }, @@ -1236,10 +1236,10 @@ "com.amazonaws.kinesisvideo#ListTagsForStreamInput": { "type": "structure", "members": { - "StreamARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", + "NextToken": { + "target": "com.amazonaws.kinesisvideo#NextToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream that you want to list tags\n for.

" + "smithy.api#documentation": "

If you specify this parameter and the result of a ListTagsForStream\n call is truncated, the response includes a token that you can use in the next request to\n fetch the next batch of tags.

" } }, "StreamName": { @@ -1248,10 +1248,10 @@ "smithy.api#documentation": "

The name of the stream that you want to list tags for.

" } }, - "NextToken": { - "target": "com.amazonaws.kinesisvideo#NextToken", + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { - "smithy.api#documentation": "

If you specify this parameter and the result of a ListTagsForStream\n call is truncated, the response includes a token that you can use in the next request to\n fetch the next batch of tags.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream that you want to list tags\n for.

" } } } @@ -1399,17 +1399,17 @@ "com.amazonaws.kinesisvideo#SingleMasterChannelEndpointConfiguration": { "type": "structure", "members": { - "Protocols": { - "target": "com.amazonaws.kinesisvideo#ListOfProtocols", - "traits": { - "smithy.api#documentation": "

This property is used to determine the nature of communication over this\n SINGLE_MASTER signaling channel. If WSS is specified, this\n API returns a websocket endpoint. If HTTPS is specified, this API returns\n an HTTPS endpoint.

" - } - }, "Role": { "target": "com.amazonaws.kinesisvideo#ChannelRole", "traits": { "smithy.api#documentation": "

This property is used to determine messaging permissions in this\n SINGLE_MASTER signaling channel. If MASTER is specified,\n this API returns an endpoint that a client can use to receive offers from and send\n answers to any of the viewers on this signaling channel. If VIEWER is\n specified, this API returns an endpoint that a client can use only to send offers to\n another MASTER client on this signaling channel.

" } + }, + "Protocols": { + "target": "com.amazonaws.kinesisvideo#ListOfProtocols", + "traits": { + "smithy.api#documentation": "

This property is used to determine the nature of communication over this\n SINGLE_MASTER signaling channel. If WSS is specified, this\n API returns a websocket endpoint. If HTTPS is specified, this API returns\n an HTTPS endpoint.

" + } } }, "traits": { @@ -1456,10 +1456,22 @@ "com.amazonaws.kinesisvideo#StreamInfo": { "type": "structure", "members": { - "MediaType": { - "target": "com.amazonaws.kinesisvideo#MediaType", + "DeviceName": { + "target": "com.amazonaws.kinesisvideo#DeviceName", "traits": { - "smithy.api#documentation": "

The MediaType of the stream.

" + "smithy.api#documentation": "

The name of the device that is associated with the stream.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" + } + }, + "DataRetentionInHours": { + "target": "com.amazonaws.kinesisvideo#DataRetentionInHours", + "traits": { + "smithy.api#documentation": "

How long the stream retains data, in hours.

" } }, "CreationTime": { @@ -1486,28 +1498,16 @@ "smithy.api#documentation": "

The version of the stream.

" } }, - "Status": { - "target": "com.amazonaws.kinesisvideo#Status", - "traits": { - "smithy.api#documentation": "

The status of the stream.

" - } - }, - "StreamARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" - } - }, - "DeviceName": { - "target": "com.amazonaws.kinesisvideo#DeviceName", + "MediaType": { + "target": "com.amazonaws.kinesisvideo#MediaType", "traits": { - "smithy.api#documentation": "

The name of the device that is associated with the stream.

" + "smithy.api#documentation": "

The MediaType of the stream.

" } }, - "DataRetentionInHours": { - "target": "com.amazonaws.kinesisvideo#DataRetentionInHours", + "Status": { + "target": "com.amazonaws.kinesisvideo#Status", "traits": { - "smithy.api#documentation": "

How long the stream retains data, in hours.

" + "smithy.api#documentation": "

The status of the stream.

" } } }, @@ -1554,17 +1554,17 @@ "com.amazonaws.kinesisvideo#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.kinesisvideo#TagValue", + "Key": { + "target": "com.amazonaws.kinesisvideo#TagKey", "traits": { - "smithy.api#documentation": "

The value of the tag that is associated with the specified signaling channel.

", + "smithy.api#documentation": "

The key of the tag that is associated with the specified signaling channel.

", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.kinesisvideo#TagKey", + "Value": { + "target": "com.amazonaws.kinesisvideo#TagValue", "traits": { - "smithy.api#documentation": "

The key of the tag that is associated with the specified signaling channel.

", + "smithy.api#documentation": "

The value of the tag that is associated with the specified signaling channel.

", "smithy.api#required": {} } } @@ -1716,10 +1716,11 @@ "com.amazonaws.kinesisvideo#TagStreamInput": { "type": "structure", "members": { - "StreamARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", + "Tags": { + "target": "com.amazonaws.kinesisvideo#ResourceTags", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags\n to.

" + "smithy.api#documentation": "

A list of tags to associate with the specified stream. Each tag is a key-value pair\n (the value is optional).

", + "smithy.api#required": {} } }, "StreamName": { @@ -1728,11 +1729,10 @@ "smithy.api#documentation": "

The name of the stream that you want to add the tag or tags to.

" } }, - "Tags": { - "target": "com.amazonaws.kinesisvideo#ResourceTags", + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { - "smithy.api#documentation": "

A list of tags to associate with the specified stream. Each tag is a key-value pair\n (the value is optional).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags\n to.

" } } } @@ -1801,17 +1801,17 @@ "com.amazonaws.kinesisvideo#UntagResourceInput": { "type": "structure", "members": { - "TagKeyList": { - "target": "com.amazonaws.kinesisvideo#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { - "smithy.api#documentation": "

A list of the keys of the tags that you want to remove.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the signaling channel from which you want to remove\n tags.

", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", + "TagKeyList": { + "target": "com.amazonaws.kinesisvideo#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the signaling channel from which you want to remove\n tags.

", + "smithy.api#documentation": "

A list of the keys of the tags that you want to remove.

", "smithy.api#required": {} } } @@ -1858,6 +1858,12 @@ "com.amazonaws.kinesisvideo#UntagStreamInput": { "type": "structure", "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream that you want to remove tags from.

" + } + }, "StreamARN": { "target": "com.amazonaws.kinesisvideo#ResourceARN", "traits": { @@ -1870,12 +1876,6 @@ "smithy.api#documentation": "

A list of the keys of the tags that you want to remove.

", "smithy.api#required": {} } - }, - "StreamName": { - "target": "com.amazonaws.kinesisvideo#StreamName", - "traits": { - "smithy.api#documentation": "

The name of the stream that you want to remove tags from.

" - } } } }, @@ -1923,6 +1923,19 @@ "com.amazonaws.kinesisvideo#UpdateDataRetentionInput": { "type": "structure", "members": { + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream whose retention period you want to\n change.

" + } + }, + "Operation": { + "target": "com.amazonaws.kinesisvideo#UpdateDataRetentionOperation", + "traits": { + "smithy.api#documentation": "

Indicates whether you want to increase or decrease the retention period.

", + "smithy.api#required": {} + } + }, "StreamName": { "target": "com.amazonaws.kinesisvideo#StreamName", "traits": { @@ -1942,19 +1955,6 @@ "smithy.api#documentation": "

The retention period, in hours. The value you specify replaces the current value.\n The maximum value for this parameter is 87600 (ten years).

", "smithy.api#required": {} } - }, - "Operation": { - "target": "com.amazonaws.kinesisvideo#UpdateDataRetentionOperation", - "traits": { - "smithy.api#documentation": "

Indicates whether you want to increase or decrease the retention period.

", - "smithy.api#required": {} - } - }, - "StreamARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream whose retention period you want to\n change.

" - } } } }, @@ -2017,10 +2017,11 @@ "com.amazonaws.kinesisvideo#UpdateSignalingChannelInput": { "type": "structure", "members": { - "SingleMasterConfiguration": { - "target": "com.amazonaws.kinesisvideo#SingleMasterConfiguration", + "CurrentVersion": { + "target": "com.amazonaws.kinesisvideo#Version", "traits": { - "smithy.api#documentation": "

The structure containing the configuration for the SINGLE_MASTER type of\n the signaling channel that you want to update.

" + "smithy.api#documentation": "

The current version of the signaling channel that you want to update.

", + "smithy.api#required": {} } }, "ChannelARN": { @@ -2030,11 +2031,10 @@ "smithy.api#required": {} } }, - "CurrentVersion": { - "target": "com.amazonaws.kinesisvideo#Version", + "SingleMasterConfiguration": { + "target": "com.amazonaws.kinesisvideo#SingleMasterConfiguration", "traits": { - "smithy.api#documentation": "

The current version of the signaling channel that you want to update.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The structure containing the configuration for the SINGLE_MASTER type of\n the signaling channel that you want to update.

" } } } @@ -2083,12 +2083,6 @@ "com.amazonaws.kinesisvideo#UpdateStreamInput": { "type": "structure", "members": { - "StreamARN": { - "target": "com.amazonaws.kinesisvideo#ResourceARN", - "traits": { - "smithy.api#documentation": "

The ARN of the stream whose metadata you want to update.

" - } - }, "CurrentVersion": { "target": "com.amazonaws.kinesisvideo#Version", "traits": { @@ -2113,6 +2107,12 @@ "traits": { "smithy.api#documentation": "

The name of the stream whose metadata you want to update.

\n

The stream name is an identifier for the stream, and must be unique for each\n account and region.

" } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream whose metadata you want to update.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json b/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json index 51a84129c6e5..674f66bdd879 100644 --- a/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json +++ b/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json @@ -49,23 +49,23 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates tags for the specified Kinesis data stream. Each time you invoke\n this operation, you can specify up to 10 tags. If you want to add more than 10 tags to\n your stream, you can invoke this operation multiple times. In total, each stream can\n have up to 50 tags.

\n

If tags have already been assigned to the stream, AddTagsToStream overwrites\n any existing tags that correspond to the specified tag keys.

\n

\n AddTagsToStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Adds or updates tags for the specified Kinesis data stream. Each time you invoke\n this operation, you can specify up to 10 tags. If you want to add more than 10 tags to\n your stream, you can invoke this operation multiple times. In total, each stream can\n have up to 50 tags.

\n

If tags have already been assigned to the stream, AddTagsToStream\n overwrites any existing tags that correspond to the specified tag keys.

\n

\n AddTagsToStream has a limit of five transactions per second per\n account.

" } }, "com.amazonaws.kinesis#AddTagsToStreamInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "Tags": { + "target": "com.amazonaws.kinesis#TagMap", "traits": { - "smithy.api#documentation": "

The name of the stream.

", + "smithy.api#documentation": "

A set of up to 10 key-value pairs to use to create the tags.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.kinesis#TagMap", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

A set of up to 10 key-value pairs to use to create the tags.

", + "smithy.api#documentation": "

The name of the stream.

", "smithy.api#required": {} } } @@ -80,27 +80,56 @@ "smithy.api#box": {} } }, - "com.amazonaws.kinesis#Consumer": { + "com.amazonaws.kinesis#ChildShard": { "type": "structure", "members": { - "ConsumerARN": { - "target": "com.amazonaws.kinesis#ConsumerARN", + "ParentShards": { + "target": "com.amazonaws.kinesis#ShardIdList", "traits": { - "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", "smithy.api#required": {} } }, - "ConsumerStatus": { - "target": "com.amazonaws.kinesis#ConsumerStatus", + "ShardId": { + "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

A consumer can't read data while in the CREATING or DELETING states.

", "smithy.api#required": {} } }, + "HashKeyRange": { + "target": "com.amazonaws.kinesis#HashKeyRange", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kinesis#ChildShardList": { + "type": "list", + "member": { + "target": "com.amazonaws.kinesis#ChildShard" + } + }, + "com.amazonaws.kinesis#Consumer": { + "type": "structure", + "members": { "ConsumerName": { "target": "com.amazonaws.kinesis#ConsumerName", "traits": { - "smithy.api#documentation": "

The name of the consumer is something you choose when you register the consumer.

", + "smithy.api#documentation": "

The name of the consumer is something you choose when you register the\n consumer.

", + "smithy.api#required": {} + } + }, + "ConsumerARN": { + "target": "com.amazonaws.kinesis#ConsumerARN", + "traits": { + "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", + "smithy.api#required": {} + } + }, + "ConsumerStatus": { + "target": "com.amazonaws.kinesis#ConsumerStatus", + "traits": { + "smithy.api#documentation": "

A consumer can't read data while in the CREATING or DELETING\n states.

", "smithy.api#required": {} } }, @@ -113,7 +142,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that represents the details of the consumer you registered.

" + "smithy.api#documentation": "

An object that represents the details of the consumer you registered. This type of\n object is returned by RegisterStreamConsumer.

" } }, "com.amazonaws.kinesis#ConsumerARN": { @@ -139,13 +168,6 @@ "com.amazonaws.kinesis#ConsumerDescription": { "type": "structure", "members": { - "ConsumerCreationTimestamp": { - "target": "com.amazonaws.kinesis#Timestamp", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { @@ -153,10 +175,10 @@ "smithy.api#required": {} } }, - "ConsumerStatus": { - "target": "com.amazonaws.kinesis#ConsumerStatus", + "ConsumerName": { + "target": "com.amazonaws.kinesis#ConsumerName", "traits": { - "smithy.api#documentation": "

A consumer can't read data while in the CREATING or DELETING\n states.

", + "smithy.api#documentation": "

The name of the consumer is something you choose when you register the\n consumer.

", "smithy.api#required": {} } }, @@ -167,16 +189,23 @@ "smithy.api#required": {} } }, - "ConsumerName": { - "target": "com.amazonaws.kinesis#ConsumerName", + "ConsumerStatus": { + "target": "com.amazonaws.kinesis#ConsumerStatus", + "traits": { + "smithy.api#documentation": "

A consumer can't read data while in the CREATING or DELETING\n states.

", + "smithy.api#required": {} + } + }, + "ConsumerCreationTimestamp": { + "target": "com.amazonaws.kinesis#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the consumer is something you choose when you register the consumer.

", + "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

An object that represents the details of a registered consumer.

" + "smithy.api#documentation": "

An object that represents the details of a registered consumer. This type of object is\n returned by DescribeStreamConsumer.

" } }, "com.amazonaws.kinesis#ConsumerList": { @@ -231,23 +260,23 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that\n are continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You specify and control the number of shards that a stream is composed of. Each\n shard can support reads up to five transactions per second, up to a maximum data read\n total of 2 MB per second. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MB per second. If the amount of data input\n increases or decreases, you can add or remove shards.

\n

The stream name identifies the stream. The name is scoped to the AWS account used\n by the application. It is also scoped by AWS Region. That is, two streams in two\n different accounts can have the same name, and two streams in the same account, but in\n two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an AWS account, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact AWS\n Support.

\n

You can use DescribeStream to check the stream status, which is returned in\n StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that\n are continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You specify and control the number of shards that a stream is composed of. Each\n shard can support reads up to five transactions per second, up to a maximum data read\n total of 2 MiB per second. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MiB per second. If the amount of data input\n increases or decreases, you can add or remove shards.

\n

The stream name identifies the stream. The name is scoped to the AWS account used\n by the application. It is also scoped by AWS Region. That is, two streams in two\n different accounts can have the same name, and two streams in the same account, but in\n two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an AWS account, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact AWS\n Support.

\n

You can use DescribeStream to check the stream status, which is\n returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

" } }, "com.amazonaws.kinesis#CreateStreamInput": { "type": "structure", "members": { - "ShardCount": { - "target": "com.amazonaws.kinesis#PositiveIntegerObject", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

\n

DefaultShardLimit;

", + "smithy.api#documentation": "

A name to identify the stream. The stream name is scoped to the AWS account used by\n the application that creates the stream. It is also scoped by AWS Region. That is, two\n streams in two different AWS accounts can have the same name. Two streams in the same\n AWS account but in two different Regions can also have the same name.

", "smithy.api#required": {} } }, - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "ShardCount": { + "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

A name to identify the stream. The stream name is scoped to the AWS account used by\n the application that creates the stream. It is also scoped by AWS Region. That is, two\n streams in two different AWS accounts can have the same name. Two streams in the same\n AWS account but in two different Regions can also have the same name.

", + "smithy.api#documentation": "

The number of shards that the stream will use. The throughput of the stream is a\n function of the number of shards; more shards are required for greater provisioned\n throughput.

", "smithy.api#required": {} } } @@ -285,23 +314,23 @@ } ], "traits": { - "smithy.api#documentation": "

Decreases the Kinesis data stream's retention period, which is the length of time\n data records are accessible after they are added to the stream. The minimum value of a\n stream's retention period is 24 hours.

\n

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

" + "smithy.api#documentation": "

Decreases the Kinesis data stream's retention period, which is the length of time\n data records are accessible after they are added to the stream. The minimum value of a\n stream's retention period is 24 hours.

\n

This operation may result in lost data. For example, if the stream's retention\n period is 48 hours and is decreased to 24 hours, any data already in the stream that is\n older than 24 hours is inaccessible.

" } }, "com.amazonaws.kinesis#DecreaseStreamRetentionPeriodInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "RetentionPeriodHours": { + "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { - "smithy.api#documentation": "

The name of the stream to modify.

", + "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be less than the current\n retention period.

", "smithy.api#required": {} } }, - "RetentionPeriodHours": { - "target": "com.amazonaws.kinesis#RetentionPeriodHours", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be less than the current retention period.

", + "smithy.api#documentation": "

The name of the stream to modify.

", "smithy.api#required": {} } } @@ -327,7 +356,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Kinesis data stream and all its shards and data. You must shut down any\n applications that are operating on the stream before you delete the stream. If an\n application attempts to operate on a deleted stream, it receives the exception\n ResourceNotFoundException.

\n

If the stream is in the ACTIVE state, you can delete it. After a\n DeleteStream request, the specified stream is in the\n DELETING state until Kinesis Data Streams completes the\n deletion.

\n

\n Note: Kinesis Data Streams might continue to accept\n data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the\n DELETING state until the stream deletion is complete.

\n

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

\n

You can use the DescribeStream operation to check the state of the stream, which\n is returned in StreamStatus.

\n

\n DeleteStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Deletes a Kinesis data stream and all its shards and data. You must shut down any\n applications that are operating on the stream before you delete the stream. If an\n application attempts to operate on a deleted stream, it receives the exception\n ResourceNotFoundException.

\n

If the stream is in the ACTIVE state, you can delete it. After a\n DeleteStream request, the specified stream is in the\n DELETING state until Kinesis Data Streams completes the\n deletion.

\n

\n Note: Kinesis Data Streams might continue to accept\n data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the\n DELETING state until the stream deletion is complete.

\n

When you delete a stream, any shards in that stream are also deleted, and any tags\n are dissociated from the stream.

\n

You can use the DescribeStream operation to check the state of\n the stream, which is returned in StreamStatus.

\n

\n DeleteStream has a limit of five transactions per second per\n account.

" } }, "com.amazonaws.kinesis#DeleteStreamInput": { @@ -368,7 +397,7 @@ } ], "traits": { - "smithy.api#documentation": "

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of\n the data stream and the name you gave the consumer when you registered it. You may also\n provide all three parameters, as long as they don't conflict with each other. If you\n don't know the name or ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of\n all the consumers that are currently registered with a given data stream. The\n description of a consumer contains its name and ARN.

\n

This operation has a limit of five transactions per second per account.

" + "smithy.api#documentation": "

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of\n the data stream and the name you gave the consumer when you registered it. You may also\n provide all three parameters, as long as they don't conflict with each other. If you\n don't know the name or ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of\n all the consumers that are currently registered with a given data stream. The\n description of a consumer contains its name and ARN.

\n

This operation has a limit of five transactions per second per stream.

" } }, "com.amazonaws.kinesis#DeregisterStreamConsumerInput": { @@ -380,17 +409,17 @@ "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } }, - "ConsumerARN": { - "target": "com.amazonaws.kinesis#ConsumerARN", - "traits": { - "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer. If you\n don't know the ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of all the consumers\n that are currently registered with a given data stream. The description of a consumer\n contains its ARN.

" - } - }, "ConsumerName": { "target": "com.amazonaws.kinesis#ConsumerName", "traits": { "smithy.api#documentation": "

The name that you gave to the consumer.

" } + }, + "ConsumerARN": { + "target": "com.amazonaws.kinesis#ConsumerARN", + "traits": { + "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer. If you\n don't know the ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of all the consumers\n that are currently registered with a given data stream. The description of a consumer\n contains its ARN.

" + } } } }, @@ -408,7 +437,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the shard limits and usage for the account.

\n

If you update your account limits, the old limits might be returned for a few minutes.

\n

This operation has a limit of one transaction per second per account.

" + "smithy.api#documentation": "

Describes the shard limits and usage for the account.

\n

If you update your account limits, the old limits might be returned for a few\n minutes.

\n

This operation has a limit of one transaction per second per account.

" } }, "com.amazonaws.kinesis#DescribeLimitsInput": { @@ -451,7 +480,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified Kinesis data stream.

\n \n

The information returned includes the stream name, Amazon Resource Name (ARN), creation \n time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. \n For each shard object, there is the hash key and sequence number ranges that the shard spans, \n and the IDs of any earlier shards that played in a role in creating the shard. Every record \n ingested in the stream is identified by a sequence number, which is assigned when the record \n is put into the stream.

\n \n

You can limit the number of shards returned by each call. For more information, see\n Retrieving\n Shards from a Stream in the Amazon Kinesis Data Streams Developer\n Guide.

\n

There are no guarantees about the chronological order shards returned. To process shards in chronological\n order, use the ID of the parent shard to track the lineage to the oldest shard.

\n

This operation has a limit of 10 transactions per second per account.

" + "smithy.api#documentation": "

Describes the specified Kinesis data stream.

\n\n

The information returned includes the stream name, Amazon Resource Name (ARN),\n creation time, enhanced metric configuration, and shard map. The shard map is an array\n of shard objects. For each shard object, there is the hash key and sequence number\n ranges that the shard spans, and the IDs of any earlier shards that played in a role in\n creating the shard. Every record ingested in the stream is identified by a sequence\n number, which is assigned when the record is put into the stream.

\n\n

You can limit the number of shards returned by each call. For more information, see\n Retrieving\n Shards from a Stream in the Amazon Kinesis Data Streams Developer\n Guide.

\n

There are no guarantees about the chronological order shards returned. To process\n shards in chronological order, use the ID of the parent shard to track the lineage to\n the oldest shard.

\n

This operation has a limit of 10 transactions per second per account.

" } }, "com.amazonaws.kinesis#DescribeStreamConsumer": { @@ -474,24 +503,24 @@ } ], "traits": { - "smithy.api#documentation": "

To get the description of a registered consumer, provide the ARN of the consumer.\n Alternatively, you can provide the ARN of the data stream and the name you gave the\n consumer when you registered it. You may also provide all three parameters, as long as\n they don't conflict with each other. If you don't know the name or ARN of the consumer\n that you want to describe, you can use the ListStreamConsumers\n operation to get a list of the descriptions of all the consumers that are currently\n registered with a given data stream.

\n

This operation has a limit of 20 transactions per second per account.

" + "smithy.api#documentation": "

To get the description of a registered consumer, provide the ARN of the consumer.\n Alternatively, you can provide the ARN of the data stream and the name you gave the\n consumer when you registered it. You may also provide all three parameters, as long as\n they don't conflict with each other. If you don't know the name or ARN of the consumer\n that you want to describe, you can use the ListStreamConsumers\n operation to get a list of the descriptions of all the consumers that are currently\n registered with a given data stream.

\n

This operation has a limit of 20 transactions per second per stream.

" } }, "com.amazonaws.kinesis#DescribeStreamConsumerInput": { "type": "structure", "members": { - "ConsumerName": { - "target": "com.amazonaws.kinesis#ConsumerName", - "traits": { - "smithy.api#documentation": "

The name that you gave to the consumer.

" - } - }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } }, + "ConsumerName": { + "target": "com.amazonaws.kinesis#ConsumerName", + "traits": { + "smithy.api#documentation": "

The name that you gave to the consumer.

" + } + }, "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { @@ -515,10 +544,11 @@ "com.amazonaws.kinesis#DescribeStreamInput": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.kinesis#DescribeStreamInputLimit", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The maximum number of shards to return in a single call. The default value is 100. \n If you specify a value greater than 100, at most 100 shards are returned.

" + "smithy.api#documentation": "

The name of the stream to describe.

", + "smithy.api#required": {} } }, "ExclusiveStartShardId": { @@ -527,11 +557,10 @@ "smithy.api#documentation": "

The shard ID of the shard to start with.

" } }, - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "Limit": { + "target": "com.amazonaws.kinesis#DescribeStreamInputLimit", "traits": { - "smithy.api#documentation": "

The name of the stream to describe.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of shards to return in a single call. The default value is 100.\n If you specify a value greater than 100, at most 100 shards are returned.

" } } }, @@ -581,7 +610,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a summarized description of the specified Kinesis data stream without the\n shard list.

\n

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation \n time, monitoring, encryption details, and open shard count.

" + "smithy.api#documentation": "

Provides a summarized description of the specified Kinesis data stream without the\n shard list.

\n

The information returned includes the stream name, Amazon Resource Name (ARN),\n status, record retention period, approximate creation time, monitoring, encryption\n details, and open shard count.

\n

\n DescribeStreamSummary has a limit of 20 transactions per second\n per account.

" } }, "com.amazonaws.kinesis#DescribeStreamSummaryInput": { @@ -602,7 +631,7 @@ "StreamDescriptionSummary": { "target": "com.amazonaws.kinesis#StreamDescriptionSummary", "traits": { - "smithy.api#documentation": "

A StreamDescriptionSummary containing information about the stream.

", + "smithy.api#documentation": "

A StreamDescriptionSummary containing information about the\n stream.

", "smithy.api#required": {} } } @@ -637,17 +666,17 @@ "com.amazonaws.kinesis#DisableEnhancedMonitoringInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "ShardLevelMetrics": { + "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "

The name of the Kinesis data stream for which to disable enhanced\n monitoring.

", + "smithy.api#documentation": "

List of shard-level metrics to disable.

\n

The following are the valid shard-level metrics. The value \"ALL\"\n disables every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", "smithy.api#required": {} } }, - "ShardLevelMetrics": { - "target": "com.amazonaws.kinesis#MetricsNameList", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

List of shard-level metrics to disable.

\n

The following are the valid shard-level metrics. The value \"ALL\" disables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", + "smithy.api#documentation": "

The name of the Kinesis data stream for which to disable enhanced\n monitoring.

", "smithy.api#required": {} } } @@ -695,7 +724,7 @@ "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "

List of shard-level metrics to enable.

\n

The following are the valid shard-level metrics. The value \"ALL\" enables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", + "smithy.api#documentation": "

List of shard-level metrics to enable.

\n

The following are the valid shard-level metrics. The value \"ALL\"\n enables every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", "smithy.api#required": {} } } @@ -725,7 +754,7 @@ "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "

List of shard-level metrics.

\n

The following are the valid shard-level metrics. The value \"ALL\" enhances\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

" + "smithy.api#documentation": "

List of shard-level metrics.

\n

The following are the valid shard-level metrics. The value \"ALL\"\n enhances every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

" } } }, @@ -742,6 +771,12 @@ "com.amazonaws.kinesis#EnhancedMonitoringOutput": { "type": "structure", "members": { + "DesiredShardLevelMetrics": { + "target": "com.amazonaws.kinesis#MetricsNameList", + "traits": { + "smithy.api#documentation": "

Represents the list of all the metrics that would be in the enhanced state after\n the operation.

" + } + }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { @@ -751,18 +786,12 @@ "CurrentShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "

Represents the current state of the metrics that are in the enhanced state before the operation.

" - } - }, - "DesiredShardLevelMetrics": { - "target": "com.amazonaws.kinesis#MetricsNameList", - "traits": { - "smithy.api#documentation": "

Represents the list of all the metrics that would be in the enhanced state after the operation.

" + "smithy.api#documentation": "

Represents the current state of the metrics that are in the enhanced state before\n the operation.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the output for EnableEnhancedMonitoring and\n DisableEnhancedMonitoring.

" + "smithy.api#documentation": "

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

" } }, "com.amazonaws.kinesis#ErrorCode": { @@ -839,24 +868,24 @@ } ], "traits": { - "smithy.api#documentation": "

Gets data records from a Kinesis data stream's shard.

\n

Specify a shard iterator using the ShardIterator parameter. The shard\n iterator specifies the position in the shard from which you want to start reading data\n records sequentially. If there are no records available in the portion of the shard that\n the iterator points to, GetRecords returns an empty list. It might\n take multiple calls to get to a portion of the shard that contains records.

\n

You can scale by provisioning multiple shards per stream while considering service\n limits (for more information, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide). Your application should have one thread per shard, each reading\n continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the\n shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in\n NextShardIterator. Specify the shard iterator returned in\n NextShardIterator in subsequent calls to GetRecords.\n If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator.\n You can terminate the loop when the shard is closed, or when the shard iterator reaches\n the record with the sequence number or other attribute that marks it as the last record\n to process.

\n

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB\n per second. You can ensure that your calls don't exceed the maximum supported size or\n throughput by using the Limit parameter to specify the maximum number of\n records that GetRecords can return. Consider your average record size\n when determining this limit. The maximum number of records that can be returned per call\n is 10,000.

\n \n

The size of the data returned by GetRecords varies depending on\n the utilization of the shard. The maximum size of data that GetRecords\n can return is 10 MiB. If a call returns this amount of data, subsequent calls made\n within the next 5 seconds throw ProvisionedThroughputExceededException. If\n there is insufficient provisioned throughput on the stream, subsequent calls made within\n the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this\n reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1\n second.

\n

To detect whether the application is falling behind in processing, you can use the\n MillisBehindLatest response attribute. You can also monitor the stream\n using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon\n Kinesis Data Streams Developer Guide).

\n

Each Amazon Kinesis record includes a value,\n ApproximateArrivalTimestamp, that is set when a stream successfully\n receives and stores a record. This is commonly referred to as a server-side time stamp,\n whereas a client-side time stamp is set when a data producer creates or sends the record\n to a stream (a data producer is any data source putting data records into a stream, for\n example with PutRecords). The time stamp has millisecond precision.\n There are no guarantees about the time stamp accuracy, or that the time stamp is always\n increasing. For example, records in a shard or across a stream might have time stamps\n that are out of order.

\n

This operation has a limit of five transactions per second per account.

" + "smithy.api#documentation": "

Gets data records from a Kinesis data stream's shard.

\n

Specify a shard iterator using the ShardIterator parameter. The shard\n iterator specifies the position in the shard from which you want to start reading data\n records sequentially. If there are no records available in the portion of the shard that\n the iterator points to, GetRecords returns an empty list. It might\n take multiple calls to get to a portion of the shard that contains records.

\n

You can scale by provisioning multiple shards per stream while considering service\n limits (for more information, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide). Your application should have one thread per shard, each reading\n continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the\n shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in\n NextShardIterator. Specify the shard iterator returned in\n NextShardIterator in subsequent calls to GetRecords.\n If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator.\n You can terminate the loop when the shard is closed, or when the shard iterator reaches\n the record with the sequence number or other attribute that marks it as the last record\n to process.

\n

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB\n per second. You can ensure that your calls don't exceed the maximum supported size or\n throughput by using the Limit parameter to specify the maximum number of\n records that GetRecords can return. Consider your average record size\n when determining this limit. The maximum number of records that can be returned per call\n is 10,000.

\n\n

The size of the data returned by GetRecords varies depending on\n the utilization of the shard. The maximum size of data that GetRecords\n can return is 10 MiB. If a call returns this amount of data, subsequent calls made\n within the next 5 seconds throw ProvisionedThroughputExceededException. If\n there is insufficient provisioned throughput on the stream, subsequent calls made within\n the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this\n reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1\n second.

\n

To detect whether the application is falling behind in processing, you can use the\n MillisBehindLatest response attribute. You can also monitor the stream\n using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon\n Kinesis Data Streams Developer Guide).

\n

Each Amazon Kinesis record includes a value,\n ApproximateArrivalTimestamp, that is set when a stream successfully\n receives and stores a record. This is commonly referred to as a server-side time stamp,\n whereas a client-side time stamp is set when a data producer creates or sends the record\n to a stream (a data producer is any data source putting data records into a stream, for\n example with PutRecords). The time stamp has millisecond precision.\n There are no guarantees about the time stamp accuracy, or that the time stamp is always\n increasing. For example, records in a shard or across a stream might have time stamps\n that are out of order.

\n

This operation has a limit of five transactions per second per shard.

" } }, "com.amazonaws.kinesis#GetRecordsInput": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.kinesis#GetRecordsInputLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of records to return. Specify a value of up to 10,000. If you specify\n a value that is greater than 10,000, GetRecords throws\n InvalidArgumentException.

" - } - }, "ShardIterator": { "target": "com.amazonaws.kinesis#ShardIterator", "traits": { - "smithy.api#documentation": "

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

", + "smithy.api#documentation": "

The position in the shard from which you want to start sequentially reading data\n records. A shard iterator specifies this position using the sequence number of a data\n record in the shard.

", "smithy.api#required": {} } + }, + "Limit": { + "target": "com.amazonaws.kinesis#GetRecordsInputLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of records to return. Specify a value of up to 10,000. If you\n specify a value that is greater than 10,000, GetRecords throws\n InvalidArgumentException. The default value is 10,000.

" + } } }, "traits": { @@ -876,12 +905,6 @@ "com.amazonaws.kinesis#GetRecordsOutput": { "type": "structure", "members": { - "MillisBehindLatest": { - "target": "com.amazonaws.kinesis#MillisBehindLatest", - "traits": { - "smithy.api#documentation": "

The number of milliseconds the GetRecords response is from the\n tip of the stream, indicating how far behind current time the consumer is. A value of\n zero indicates that record processing is caught up, and there are no new records to\n process at this moment.

" - } - }, "NextShardIterator": { "target": "com.amazonaws.kinesis#ShardIterator", "traits": { @@ -894,6 +917,15 @@ "smithy.api#documentation": "

The data records retrieved from the shard.

", "smithy.api#required": {} } + }, + "MillisBehindLatest": { + "target": "com.amazonaws.kinesis#MillisBehindLatest", + "traits": { + "smithy.api#documentation": "

The number of milliseconds the GetRecords response is from the\n tip of the stream, indicating how far behind current time the consumer is. A value of\n zero indicates that record processing is caught up, and there are no new records to\n process at this moment.

" + } + }, + "ChildShards": { + "target": "com.amazonaws.kinesis#ChildShardList" } }, "traits": { @@ -920,32 +952,19 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it\n is returned to the requester.

\n

A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

\n

You must specify the shard iterator type. For example, you can set the\n ShardIteratorType parameter to read exactly from the position denoted\n by a specific sequence number by using the AT_SEQUENCE_NUMBER shard\n iterator type. Alternatively, the parameter can read right after the sequence number by\n using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers\n returned by earlier calls to PutRecord, PutRecords,\n GetRecords, or DescribeStream. In the request,\n you can specify the shard iterator type AT_TIMESTAMP to read records from\n an arbitrary point in time, TRIM_HORIZON to cause\n ShardIterator to point to the last untrimmed record in the shard in the\n system (the oldest data record in the shard), or LATEST so that you always\n read the most recent data in the shard.

\n

When you read repeatedly from a stream, use a GetShardIterator request to get the\n first shard iterator for use in your first GetRecords request and for subsequent\n reads use the shard iterator returned by the GetRecords request in\n NextShardIterator. A new shard iterator is returned by every\n GetRecords request in NextShardIterator, which you use in the\n ShardIterator parameter of the next GetRecords request.

\n

If a GetShardIterator request is made too often, you receive a\n ProvisionedThroughputExceededException. For more information about\n throughput limits, see GetRecords, and Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide.

\n

If the shard is closed, GetShardIterator returns a valid iterator\n for the last sequence number of the shard. A shard can be closed as a result of using\n SplitShard or MergeShards.

\n

\n GetShardIterator has a limit of five transactions per second per\n account per open shard.

" + "smithy.api#documentation": "

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it\n is returned to the requester.

\n

A shard iterator specifies the shard position from which to start reading data\n records sequentially. The position is specified using the sequence number of a data\n record in a shard. A sequence number is the identifier associated with every record\n ingested in the stream, and is assigned when a record is put into the stream. Each\n stream has one or more shards.

\n

You must specify the shard iterator type. For example, you can set the\n ShardIteratorType parameter to read exactly from the position denoted\n by a specific sequence number by using the AT_SEQUENCE_NUMBER shard\n iterator type. Alternatively, the parameter can read right after the sequence number by\n using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers\n returned by earlier calls to PutRecord, PutRecords,\n GetRecords, or DescribeStream. In the request,\n you can specify the shard iterator type AT_TIMESTAMP to read records from\n an arbitrary point in time, TRIM_HORIZON to cause\n ShardIterator to point to the last untrimmed record in the shard in the\n system (the oldest data record in the shard), or LATEST so that you always\n read the most recent data in the shard.

\n

When you read repeatedly from a stream, use a GetShardIterator\n request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard\n iterator is returned by every GetRecords request in\n NextShardIterator, which you use in the ShardIterator\n parameter of the next GetRecords request.

\n

If a GetShardIterator request is made too often, you receive a\n ProvisionedThroughputExceededException. For more information about\n throughput limits, see GetRecords, and Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide.

\n

If the shard is closed, GetShardIterator returns a valid iterator\n for the last sequence number of the shard. A shard can be closed as a result of using\n SplitShard or MergeShards.

\n

\n GetShardIterator has a limit of five transactions per second per\n account per open shard.

" } }, "com.amazonaws.kinesis#GetShardIteratorInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream.

", - "smithy.api#required": {} - } - }, "ShardIteratorType": { "target": "com.amazonaws.kinesis#ShardIteratorType", "traits": { - "smithy.api#documentation": "

Determines how the shard iterator is used to start reading data records from the shard.

\n

The following are the valid Amazon Kinesis shard iterator types:

\n ", + "smithy.api#documentation": "

Determines how the shard iterator is used to start reading data records from the\n shard.

\n

The following are the valid Amazon Kinesis shard iterator types:

\n ", "smithy.api#required": {} } }, - "Timestamp": { - "target": "com.amazonaws.kinesis#Timestamp", - "traits": { - "smithy.api#documentation": "

The time stamp of the data record from which to start reading. Used with shard\n iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in\n milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or\n 1459799926.480. If a record with this exact time stamp does not exist,\n the iterator returned is for the next (later) record. If the time stamp is older than\n the current trim horizon, the iterator returned is for the oldest untrimmed data record\n (TRIM_HORIZON).

" - } - }, "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { @@ -956,7 +975,20 @@ "StartingSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { - "smithy.api#documentation": "

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

" + "smithy.api#documentation": "

The sequence number of the data record in the shard from which to start reading.\n Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.kinesis#Timestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the data record from which to start reading. Used with shard\n iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in\n milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or\n 1459799926.480. If a record with this exact time stamp does not exist,\n the iterator returned is for the next (later) record. If the time stamp is older than\n the current trim horizon, the iterator returned is for the oldest untrimmed data record\n (TRIM_HORIZON).

" + } + }, + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream.

", + "smithy.api#required": {} } } }, @@ -970,7 +1002,7 @@ "ShardIterator": { "target": "com.amazonaws.kinesis#ShardIterator", "traits": { - "smithy.api#documentation": "

The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

" + "smithy.api#documentation": "

The position in the shard from which to start reading data records sequentially. A\n shard iterator specifies this position using the sequence number of a data record in a\n shard.

" } } }, @@ -987,23 +1019,23 @@ "com.amazonaws.kinesis#HashKeyRange": { "type": "structure", "members": { - "EndingHashKey": { + "StartingHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { - "smithy.api#documentation": "

The ending hash key of the hash key range.

", + "smithy.api#documentation": "

The starting hash key of the hash key range.

", "smithy.api#required": {} } }, - "StartingHashKey": { + "EndingHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { - "smithy.api#documentation": "

The starting hash key of the hash key range.

", + "smithy.api#documentation": "

The ending hash key of the hash key range.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

" + "smithy.api#documentation": "

The range of possible hash key values for the shard, which is a set of ordered\n contiguous positive integers.

" } }, "com.amazonaws.kinesis#IncreaseStreamRetentionPeriod": { @@ -1026,7 +1058,7 @@ } ], "traits": { - "smithy.api#documentation": "

Increases the Kinesis data stream's retention period, which is the length of time\n data records are accessible after they are added to the stream. The maximum value of a\n stream's retention period is 168 hours (7 days).

\n

If you choose a longer stream retention period, this operation increases the time\n period during which records that have not yet expired are accessible. However, it does\n not make previous, expired data (older than the stream's previous retention period)\n accessible after the operation has been called. For example, if a stream's retention\n period is set to 24 hours and is increased to 168 hours, any data that is older than 24\n hours remains inaccessible to consumer applications.

" + "smithy.api#documentation": "

Increases the Kinesis data stream's retention period, which is the length of time\n data records are accessible after they are added to the stream. The maximum value of a\n stream's retention period is 168 hours (7 days).

\n

If you choose a longer stream retention period, this operation increases the time\n period during which records that have not yet expired are accessible. However, it does\n not make previous, expired data (older than the stream's previous retention period)\n accessible after the operation has been called. For example, if a stream's retention\n period is set to 24 hours and is increased to 168 hours, any data that is older than 24\n hours remains inaccessible to consumer applications.

" } }, "com.amazonaws.kinesis#IncreaseStreamRetentionPeriodInput": { @@ -1035,7 +1067,7 @@ "RetentionPeriodHours": { "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { - "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be more than the current retention period.

", + "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be more than the current\n retention period.

", "smithy.api#required": {} } }, @@ -1059,6 +1091,7 @@ } }, "traits": { + "smithy.api#documentation": "

The processing of the request failed because of an unknown error, exception, or\n failure.

", "smithy.api#error": "server" } }, @@ -1073,7 +1106,7 @@ } }, "traits": { - "smithy.api#documentation": "

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

", + "smithy.api#documentation": "

A specified parameter exceeds its restrictions, is not supported, or can't be used.\n For more information, see the returned message.

", "smithy.api#error": "client" } }, @@ -1088,7 +1121,7 @@ } }, "traits": { - "smithy.api#documentation": "

The ciphertext references a key that doesn't exist or that you don't have access to.

", + "smithy.api#documentation": "

The ciphertext references a key that doesn't exist or that you don't have access\n to.

", "smithy.api#error": "client" } }, @@ -1118,7 +1151,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see \n How Key State Affects Use of a Customer Master Key in the \n AWS Key Management Service Developer Guide.

", + "smithy.api#documentation": "

The request was rejected because the state of the specified resource isn't valid\n for this request. For more information, see How Key State Affects Use of a\n Customer Master Key in the AWS Key Management Service Developer\n Guide.

", "smithy.api#error": "client" } }, @@ -1163,7 +1196,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was denied due to request throttling. For more information about throttling, see Limits in the \n AWS Key Management Service Developer Guide.

", + "smithy.api#documentation": "

The request was denied due to request throttling. For more information about\n throttling, see Limits in\n the AWS Key Management Service Developer Guide.

", "smithy.api#error": "client" } }, @@ -1270,7 +1303,7 @@ "sdkId": "Kinesis", "arnNamespace": "kinesis", "cloudFormationName": "Kinesis", - "cloudTrailEventSource": "v20131202.kinesis.amazonaws.com" + "cloudTrailEventSource": "kinesis.amazonaws.com" }, "aws.auth#sigv4": { "name": "kinesis" @@ -1294,7 +1327,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

", + "smithy.api#documentation": "

The requested resource exceeds the maximum number allowed, or the number of\n concurrent stream requests exceeds the maximum number allowed.

", "smithy.api#error": "client" } }, @@ -1333,13 +1366,7 @@ "MaxResults": { "target": "com.amazonaws.kinesis#ListShardsInputLimit", "traits": { - "smithy.api#documentation": "

The maximum number of shards to return in a single call to ListShards.\n The minimum value you can specify for this parameter is 1, and the maximum is 1,000,\n which is also the default.

\n

When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.

" - } - }, - "NextToken": { - "target": "com.amazonaws.kinesis#NextToken", - "traits": { - "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.

\n

Don't specify StreamName or StreamCreationTimestamp if\n you specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when\n you specify NextToken. If you specify a MaxResults value that\n is less than the number of shards that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListShards operation.

\n \n

Tokens expire after 300 seconds. When you obtain a value for NextToken in the\n response to a call to ListShards, you have 300 seconds to use that\n value. If you specify an expired token in a call to ListShards, you get\n ExpiredNextTokenException.

\n " + "smithy.api#documentation": "

The maximum number of shards to return in a single call to ListShards.\n The minimum value you can specify for this parameter is 1, and the maximum is 10,000,\n which is also the default.

\n

When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.

" } }, "StreamCreationTimestamp": { @@ -1348,12 +1375,21 @@ "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name.\n For example, if you create a data stream and then delete it, and you later create\n another data stream with the same name, you can use this input parameter to specify\n which of the two streams you want to list the shards for.

\n

You cannot specify this parameter if you specify the NextToken\n parameter.

" } }, + "NextToken": { + "target": "com.amazonaws.kinesis#NextToken", + "traits": { + "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.

\n

Don't specify StreamName or StreamCreationTimestamp if\n you specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when\n you specify NextToken. If you specify a MaxResults value that\n is less than the number of shards that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListShards operation.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get\n ExpiredNextTokenException.

\n " + } + }, "ExclusiveStartShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

Specify this parameter to indicate that you want to list the shards starting with\n the shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.

\n

You cannot specify this parameter if you specify NextToken.

" + "smithy.api#documentation": "

Specify this parameter to indicate that you want to list the shards starting with\n the shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior is for\n ListShards to list the shards starting with the first one in the\n stream.

\n

You cannot specify this parameter if you specify NextToken.

" } }, + "ShardFilter": { + "target": "com.amazonaws.kinesis#ShardFilter" + }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { @@ -1378,13 +1414,13 @@ "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { - "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards. For more information about the use of this pagination token\n when calling the ListShards operation, see ListShardsInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for NextToken in the\n response to a call to ListShards, you have 300 seconds to use that\n value. If you specify an expired token in a call to ListShards, you get\n ExpiredNextTokenException.

\n " + "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards. For more information about the use of this pagination token\n when calling the ListShards operation, see ListShardsInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get\n ExpiredNextTokenException.

\n " } }, "Shards": { "target": "com.amazonaws.kinesis#ShardList", "traits": { - "smithy.api#documentation": "

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, \n and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

" + "smithy.api#documentation": "

An array of JSON objects. Each object represents one shard and specifies the IDs of\n the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each\n object also contains the starting and ending hash keys and the starting and ending\n sequence numbers for the shard.

" } } } @@ -1415,7 +1451,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the consumers registered to receive data from a stream using enhanced fan-out,\n and provides information about each consumer.

\n

This operation has a limit of 10 transactions per second per account.

", + "smithy.api#documentation": "

Lists the consumers registered to receive data from a stream using enhanced fan-out,\n and provides information about each consumer.

\n

This operation has a limit of 5 transactions per second per stream.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1426,22 +1462,16 @@ "com.amazonaws.kinesis#ListStreamConsumersInput": { "type": "structure", "members": { - "StreamCreationTimestamp": { - "target": "com.amazonaws.kinesis#Timestamp", - "traits": { - "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the consumers for.

\n

You can't specify this parameter if you specify the NextToken parameter.

" - } - }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { - "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of consumers that are registered with the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListStreamConsumers to\n list the next set of registered consumers.

\n

Don't specify StreamName or StreamCreationTimestamp if\n you specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when\n you specify NextToken. If you specify a MaxResults value that\n is less than the number of consumers that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListStreamConsumers operation to list the next set of consumers.

\n \n

Tokens expire after 300 seconds. When you obtain a value for NextToken in the\n response to a call to ListStreamConsumers, you have 300 seconds to use that\n value. If you specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " + "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of consumers\n that are registered with the data stream, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a\n subsequent call to ListStreamConsumers to list the next set of registered\n consumers.

\n

Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of consumers that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListStreamConsumers operation to list the next set of consumers.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " } }, - "MaxResults": { - "target": "com.amazonaws.kinesis#ListStreamConsumersInputLimit", + "StreamCreationTimestamp": { + "target": "com.amazonaws.kinesis#Timestamp", "traits": { - "smithy.api#documentation": "

The maximum number of consumers that you want a single call of\n ListStreamConsumers to return.

" + "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the consumers for.

\n

You can't specify this parameter if you specify the NextToken parameter.

" } }, "StreamARN": { @@ -1450,6 +1480,12 @@ "smithy.api#documentation": "

The ARN of the Kinesis data stream for which you want to list the registered\n consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.kinesis#ListStreamConsumersInputLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of consumers that you want a single call of\n ListStreamConsumers to return.

" + } } } }, @@ -1466,17 +1502,17 @@ "com.amazonaws.kinesis#ListStreamConsumersOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.kinesis#NextToken", - "traits": { - "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of registered consumers,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListStreamConsumers to\n list the next set of registered consumers. For more information about the use of this pagination token\n when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for NextToken in the\n response to a call to ListStreamConsumers, you have 300 seconds to use that\n value. If you specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " - } - }, "Consumers": { "target": "com.amazonaws.kinesis#ConsumerList", "traits": { "smithy.api#documentation": "

An array of JSON objects. Each object represents one registered consumer.

" } + }, + "NextToken": { + "target": "com.amazonaws.kinesis#NextToken", + "traits": { + "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of registered\n consumers, the response includes a pagination token named NextToken. You\n can specify this NextToken value in a subsequent call to\n ListStreamConsumers to list the next set of registered consumers. For\n more information about the use of this pagination token when calling the\n ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " + } } } }, @@ -1500,17 +1536,17 @@ "com.amazonaws.kinesis#ListStreamsInput": { "type": "structure", "members": { - "ExclusiveStartStreamName": { - "target": "com.amazonaws.kinesis#StreamName", - "traits": { - "smithy.api#documentation": "

The name of the stream to start the list with.

" - } - }, "Limit": { "target": "com.amazonaws.kinesis#ListStreamsInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of streams to list.

" } + }, + "ExclusiveStartStreamName": { + "target": "com.amazonaws.kinesis#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream to start the list with.

" + } } }, "traits": { @@ -1530,17 +1566,17 @@ "com.amazonaws.kinesis#ListStreamsOutput": { "type": "structure", "members": { - "HasMoreStreams": { - "target": "com.amazonaws.kinesis#BooleanObject", + "StreamNames": { + "target": "com.amazonaws.kinesis#StreamNameList", "traits": { - "smithy.api#documentation": "

If set to true, there are more streams available to list.

", + "smithy.api#documentation": "

The names of the streams that are associated with the AWS account making the\n ListStreams request.

", "smithy.api#required": {} } }, - "StreamNames": { - "target": "com.amazonaws.kinesis#StreamNameList", + "HasMoreStreams": { + "target": "com.amazonaws.kinesis#BooleanObject", "traits": { - "smithy.api#documentation": "

The names of the streams that are associated with the AWS account making the\n ListStreams request.

", + "smithy.api#documentation": "

If set to true, there are more streams available to list.

", "smithy.api#required": {} } } @@ -1575,13 +1611,6 @@ "com.amazonaws.kinesis#ListTagsForStreamInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", - "traits": { - "smithy.api#documentation": "

The name of the stream.

", - "smithy.api#required": {} - } - }, "Limit": { "target": "com.amazonaws.kinesis#ListTagsForStreamInputLimit", "traits": { @@ -1591,7 +1620,14 @@ "ExclusiveStartTagKey": { "target": "com.amazonaws.kinesis#TagKey", "traits": { - "smithy.api#documentation": "

The key to use as the starting point for the list of tags. If this parameter is set,\n ListTagsForStream gets all tags that occur after\n ExclusiveStartTagKey.

" + "smithy.api#documentation": "

The key to use as the starting point for the list of tags. If this parameter is\n set, ListTagsForStream gets all tags that occur after\n ExclusiveStartTagKey.

" + } + }, + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream.

", + "smithy.api#required": {} } } }, @@ -1612,17 +1648,17 @@ "com.amazonaws.kinesis#ListTagsForStreamOutput": { "type": "structure", "members": { - "HasMoreTags": { - "target": "com.amazonaws.kinesis#BooleanObject", + "Tags": { + "target": "com.amazonaws.kinesis#TagList", "traits": { - "smithy.api#documentation": "

If set to true, more tags are available. To request additional tags, set\n ExclusiveStartTagKey to the key of the last tag returned.

", + "smithy.api#documentation": "

A list of tags associated with StreamName, starting with the first tag\n after ExclusiveStartTagKey and up to the specified Limit.\n

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.kinesis#TagList", + "HasMoreTags": { + "target": "com.amazonaws.kinesis#BooleanObject", "traits": { - "smithy.api#documentation": "

A list of tags associated with StreamName, starting with the first tag after\n ExclusiveStartTagKey and up to the specified Limit.

", + "smithy.api#documentation": "

If set to true, more tags are available. To request additional tags,\n set ExclusiveStartTagKey to the key of the last tag returned.

", "smithy.api#required": {} } } @@ -1651,7 +1687,7 @@ } ], "traits": { - "smithy.api#documentation": "

Merges two adjacent shards in a Kinesis data stream and combines them into a single\n shard to reduce the stream's capacity to ingest and transport data. Two shards are\n considered adjacent if the union of the hash key ranges for the two shards form a\n contiguous set with no gaps. For example, if you have two shards, one with a hash key\n range of 276...381 and the other with a hash key range of 382...454, then you could\n merge these two shards into a single shard that would have a hash key range of\n 276...454. After the merge, the single child shard receives data for all hash key values\n covered by the two parent shards.

\n

\n MergeShards is called when there is a need to reduce the overall capacity\n of a stream because of excess capacity that is not being used. You must specify the\n shard to be merged and the adjacent shard for a stream. For more information about\n merging shards, see Merge Two\n Shards in the Amazon Kinesis Data Streams Developer\n Guide.

\n

If the stream is in the ACTIVE state, you can call MergeShards.\n If a stream is in the CREATING, UPDATING, or\n DELETING state, MergeShards returns a\n ResourceInUseException. If the specified stream does not exist,\n MergeShards returns a ResourceNotFoundException.

\n

You can use DescribeStream to check the state of the stream, which is returned in\n StreamStatus.

\n

\n MergeShards is an asynchronous operation. Upon receiving a\n MergeShards request, Amazon Kinesis Data Streams immediately returns a\n response and sets the StreamStatus to UPDATING. After the\n operation is completed, Kinesis Data Streams sets the StreamStatus to\n ACTIVE. Read and write operations continue to work while the stream is\n in the UPDATING state.

\n

You use DescribeStream to determine the shard IDs that are specified in the\n MergeShards request.

\n

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards,\n or SplitShard, you receive a LimitExceededException.

\n

\n MergeShards has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Merges two adjacent shards in a Kinesis data stream and combines them into a single\n shard to reduce the stream's capacity to ingest and transport data. Two shards are\n considered adjacent if the union of the hash key ranges for the two shards form a\n contiguous set with no gaps. For example, if you have two shards, one with a hash key\n range of 276...381 and the other with a hash key range of 382...454, then you could\n merge these two shards into a single shard that would have a hash key range of\n 276...454. After the merge, the single child shard receives data for all hash key values\n covered by the two parent shards.

\n

\n MergeShards is called when there is a need to reduce the overall capacity\n of a stream because of excess capacity that is not being used. You must specify the\n shard to be merged and the adjacent shard for a stream. For more information about\n merging shards, see Merge Two\n Shards in the Amazon Kinesis Data Streams Developer\n Guide.

\n

If the stream is in the ACTIVE state, you can call\n MergeShards. If a stream is in the CREATING,\n UPDATING, or DELETING state, MergeShards\n returns a ResourceInUseException. If the specified stream does not exist,\n MergeShards returns a ResourceNotFoundException.

\n

You can use DescribeStream to check the state of the stream,\n which is returned in StreamStatus.

\n

\n MergeShards is an asynchronous operation. Upon receiving a\n MergeShards request, Amazon Kinesis Data Streams immediately returns a\n response and sets the StreamStatus to UPDATING. After the\n operation is completed, Kinesis Data Streams sets the StreamStatus to\n ACTIVE. Read and write operations continue to work while the stream is\n in the UPDATING state.

\n

You use DescribeStream to determine the shard IDs that are\n specified in the MergeShards request.

\n

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards,\n or SplitShard, you receive a LimitExceededException.

\n

\n MergeShards has a limit of five transactions per second per\n account.

" } }, "com.amazonaws.kinesis#MergeShardsInput": { @@ -1664,17 +1700,17 @@ "smithy.api#required": {} } }, - "ShardToMerge": { - "target": "com.amazonaws.kinesis#ShardId", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The shard ID of the shard to combine with the adjacent shard for the merge.

", + "smithy.api#documentation": "

The name of the stream for the merge.

", "smithy.api#required": {} } }, - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "ShardToMerge": { + "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

The name of the stream for the merge.

", + "smithy.api#documentation": "

The shard ID of the shard to combine with the adjacent shard for the\n merge.

", "smithy.api#required": {} } } @@ -1766,8 +1802,7 @@ "traits": { "smithy.api#box": {}, "smithy.api#range": { - "min": 1, - "max": 100000 + "min": 1 } } }, @@ -1824,18 +1859,12 @@ } ], "traits": { - "smithy.api#documentation": "

Writes a single data record into an Amazon Kinesis data stream. Call\n PutRecord to send data into the stream for real-time ingestion and\n subsequent processing, one record at a time. Each shard can support writes up to 1,000\n records per second, up to a maximum data write total of 1 MB per second.

\n

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

\n

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams to distribute data across shards.\n Kinesis Data Streams segregates the data records that belong to a stream into multiple\n shards, using the partition key associated with each data record to determine the shard\n to which a given data record belongs.

\n

Partition keys are Unicode strings, with a maximum length limit of 256 characters\n for each key. An MD5 hash function is used to map partition keys to 128-bit integer\n values and to map associated data records to shards using the hash key ranges of the\n shards. You can override hashing the partition key to determine the shard by explicitly\n specifying a hash value using the ExplicitHashKey parameter. For more\n information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

\n PutRecord returns the shard ID of where the data record was placed and the\n sequence number that was assigned to the data record.

\n

Sequence numbers increase over time and are specific to a shard within a stream,\n not across all shards within a stream. To guarantee strictly increasing ordering, write\n serially to a shard and use the SequenceNumberForOrdering parameter. For\n more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

If a PutRecord request cannot be processed because of insufficient\n provisioned throughput on the shard involved in the request, PutRecord\n throws ProvisionedThroughputExceededException.

\n

By default, data records are accessible for 24 hours from the time that they are added to a stream.\n You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod \n to modify this retention period.

" + "smithy.api#documentation": "

Writes a single data record into an Amazon Kinesis data stream. Call\n PutRecord to send data into the stream for real-time ingestion and\n subsequent processing, one record at a time. Each shard can support writes up to 1,000\n records per second, up to a maximum data write total of 1 MiB per second.

\n

You must specify the name of the stream that captures, stores, and transports the\n data; a partition key; and the data blob itself.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams to distribute data across shards.\n Kinesis Data Streams segregates the data records that belong to a stream into multiple\n shards, using the partition key associated with each data record to determine the shard\n to which a given data record belongs.

\n

Partition keys are Unicode strings, with a maximum length limit of 256 characters\n for each key. An MD5 hash function is used to map partition keys to 128-bit integer\n values and to map associated data records to shards using the hash key ranges of the\n shards. You can override hashing the partition key to determine the shard by explicitly\n specifying a hash value using the ExplicitHashKey parameter. For more\n information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

\n PutRecord returns the shard ID of where the data record was placed and the\n sequence number that was assigned to the data record.

\n

Sequence numbers increase over time and are specific to a shard within a stream,\n not across all shards within a stream. To guarantee strictly increasing ordering, write\n serially to a shard and use the SequenceNumberForOrdering parameter. For\n more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n \n

If a PutRecord request cannot be processed because of insufficient\n provisioned throughput on the shard involved in the request, PutRecord\n throws ProvisionedThroughputExceededException.

\n

By default, data records are accessible for 24 hours from the time that they are\n added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

" } }, "com.amazonaws.kinesis#PutRecordInput": { "type": "structure", "members": { - "SequenceNumberForOrdering": { - "target": "com.amazonaws.kinesis#SequenceNumber", - "traits": { - "smithy.api#documentation": "

Guarantees strictly increasing sequence numbers, for puts from the same client and\n to the same partition key. Usage: set the SequenceNumberForOrdering of\n record n to the sequence number of record n-1\n (as returned in the result when putting record n-1). If this\n parameter is not set, records are coarsely ordered based on arrival time.

" - } - }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { @@ -1846,7 +1875,13 @@ "ExplicitHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { - "smithy.api#documentation": "

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

" + "smithy.api#documentation": "

The hash value used to explicitly determine the shard the data record is assigned\n to by overriding the partition key hash.

" + } + }, + "SequenceNumberForOrdering": { + "target": "com.amazonaws.kinesis#SequenceNumber", + "traits": { + "smithy.api#documentation": "

Guarantees strictly increasing sequence numbers, for puts from the same client and\n to the same partition key. Usage: set the SequenceNumberForOrdering of\n record n to the sequence number of record n-1\n (as returned in the result when putting record n-1). If this\n parameter is not set, records are coarsely ordered based on arrival time.

" } }, "PartitionKey": { @@ -1859,7 +1894,7 @@ "Data": { "target": "com.amazonaws.kinesis#Data", "traits": { - "smithy.api#documentation": "

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

", + "smithy.api#documentation": "

The data blob to put into the record, which is base64-encoded when the blob is\n serialized. When the data blob (the payload before base64-encoding) is added to the\n partition key size, the total size must not exceed the maximum record size (1\n MiB).

", "smithy.api#required": {} } } @@ -1871,12 +1906,6 @@ "com.amazonaws.kinesis#PutRecordOutput": { "type": "structure", "members": { - "EncryptionType": { - "target": "com.amazonaws.kinesis#EncryptionType", - "traits": { - "smithy.api#documentation": "

The encryption type to use on the record. This parameter can be one of the following values:

\n " - } - }, "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { @@ -1887,9 +1916,15 @@ "SequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { - "smithy.api#documentation": "

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

", + "smithy.api#documentation": "

The sequence number identifier that was assigned to the put data record. The\n sequence number for the record is unique across all records in the stream. A sequence\n number is the identifier associated with every record put into the stream.

", "smithy.api#required": {} } + }, + "EncryptionType": { + "target": "com.amazonaws.kinesis#EncryptionType", + "traits": { + "smithy.api#documentation": "

The encryption type to use on the record. This parameter can be one of the\n following values:

\n " + } } }, "traits": { @@ -1934,23 +1969,23 @@ } ], "traits": { - "smithy.api#documentation": "

Writes multiple data records into a Kinesis data stream in a single call (also\n referred to as a PutRecords request). Use this operation to send data into\n the stream for data ingestion and processing.

\n

Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

\n

You must specify the name of the stream that captures, stores, and transports the data;\n and an array of request Records, with each record in the array requiring a\n partition key and data blob. The record size limit applies to the total size of the\n partition key and data blob.

\n

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams as input to a hash function that\n maps the partition key and associated data to a specific shard. An MD5 hash function is\n used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same\n partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

Each record in the Records array may include an optional parameter,\n ExplicitHashKey, which overrides the partition key to shard mapping.\n This parameter allows a data producer to determine explicitly the shard where the record\n is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n

The PutRecords response includes an array of response Records.\n Each record in the response array directly correlates with a record in the request array\n using natural ordering, from the top to the bottom of the request and response. The\n response Records array always includes the same number of records as the\n request array.

\n

The response Records array includes both successfully and\n unsuccessfully processed records. Kinesis Data Streams attempts to process all records\n in each PutRecords request. A single record failure does not stop the\n processing of subsequent records.

\n

A successfully processed record includes ShardId and\n SequenceNumber values. The ShardId parameter identifies\n the shard in the stream where the record is stored. The SequenceNumber\n parameter is an identifier assigned to the put record, unique to all records in the\n stream.

\n

An unsuccessfully processed record includes ErrorCode and\n ErrorMessage values. ErrorCode reflects the type of error\n and can be one of the following values:\n ProvisionedThroughputExceededException or InternalFailure.\n ErrorMessage provides more detailed information about the\n ProvisionedThroughputExceededException exception including the account\n ID, stream name, and shard ID of the record that was throttled. For more information\n about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n

By default, data records are accessible for 24 hours from the time that they are added to a stream.\n You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod \n to modify this retention period.

" + "smithy.api#documentation": "

Writes multiple data records into a Kinesis data stream in a single call (also\n referred to as a PutRecords request). Use this operation to send data into\n the stream for data ingestion and processing.

\n

Each PutRecords request can support up to 500 records. Each record in\n the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,\n including partition keys. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MiB per second.

\n

You must specify the name of the stream that captures, stores, and transports the\n data; and an array of request Records, with each record in the array\n requiring a partition key and data blob. The record size limit applies to the total size\n of the partition key and data blob.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams as input to a hash function that\n maps the partition key and associated data to a specific shard. An MD5 hash function is\n used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same\n partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

Each record in the Records array may include an optional parameter,\n ExplicitHashKey, which overrides the partition key to shard mapping.\n This parameter allows a data producer to determine explicitly the shard where the record\n is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n

The PutRecords response includes an array of response\n Records. Each record in the response array directly correlates with a\n record in the request array using natural ordering, from the top to the bottom of the\n request and response. The response Records array always includes the same\n number of records as the request array.

\n

The response Records array includes both successfully and\n unsuccessfully processed records. Kinesis Data Streams attempts to process all records\n in each PutRecords request. A single record failure does not stop the\n processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering\n of records. If you need to read records in the same order they are written to the\n stream, use PutRecord instead of PutRecords, and write to\n the same shard.

\n

A successfully processed record includes ShardId and\n SequenceNumber values. The ShardId parameter identifies\n the shard in the stream where the record is stored. The SequenceNumber\n parameter is an identifier assigned to the put record, unique to all records in the\n stream.

\n

An unsuccessfully processed record includes ErrorCode and\n ErrorMessage values. ErrorCode reflects the type of error\n and can be one of the following values:\n ProvisionedThroughputExceededException or InternalFailure.\n ErrorMessage provides more detailed information about the\n ProvisionedThroughputExceededException exception including the account\n ID, stream name, and shard ID of the record that was throttled. For more information\n about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n \n

By default, data records are accessible for 24 hours from the time that they are\n added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

" } }, "com.amazonaws.kinesis#PutRecordsInput": { "type": "structure", "members": { - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "Records": { + "target": "com.amazonaws.kinesis#PutRecordsRequestEntryList", "traits": { - "smithy.api#documentation": "

The stream name associated with the request.

", + "smithy.api#documentation": "

The records associated with the request.

", "smithy.api#required": {} } }, - "Records": { - "target": "com.amazonaws.kinesis#PutRecordsRequestEntryList", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The records associated with the request.

", + "smithy.api#documentation": "

The stream name associated with the request.

", "smithy.api#required": {} } } @@ -1962,23 +1997,23 @@ "com.amazonaws.kinesis#PutRecordsOutput": { "type": "structure", "members": { + "Records": { + "target": "com.amazonaws.kinesis#PutRecordsResultEntryList", + "traits": { + "smithy.api#documentation": "

An array of successfully and unsuccessfully processed record results, correlated\n with the request by natural ordering. A record that is successfully added to a stream\n includes SequenceNumber and ShardId in the result. A record\n that fails to be added to a stream includes ErrorCode and\n ErrorMessage in the result.

", + "smithy.api#required": {} + } + }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The encryption type used on the records. This parameter can be one of the following values:

\n " + "smithy.api#documentation": "

The encryption type used on the records. This parameter can be one of the following\n values:

\n " } }, "FailedRecordCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

The number of unsuccessfully processed records in a PutRecords request.

" - } - }, - "Records": { - "target": "com.amazonaws.kinesis#PutRecordsResultEntryList", - "traits": { - "smithy.api#documentation": "

An array of successfully and unsuccessfully processed record results, correlated with the\n request by natural ordering. A record that is successfully added to a stream includes\n SequenceNumber and ShardId in the result. A record that\n fails to be added to a stream includes ErrorCode and\n ErrorMessage in the result.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of unsuccessfully processed records in a PutRecords\n request.

" } } }, @@ -1989,24 +2024,24 @@ "com.amazonaws.kinesis#PutRecordsRequestEntry": { "type": "structure", "members": { - "PartitionKey": { - "target": "com.amazonaws.kinesis#PartitionKey", + "Data": { + "target": "com.amazonaws.kinesis#Data", "traits": { - "smithy.api#documentation": "

Determines which shard in the stream the data record is assigned to. Partition keys\n are Unicode strings with a maximum length limit of 256 characters for each key. Amazon\n Kinesis Data Streams uses the partition key as input to a hash function that maps the\n partition key and associated data to a specific shard. Specifically, an MD5 hash\n function is used to map partition keys to 128-bit integer values and to map associated\n data records to shards. As a result of this hashing mechanism, all data records with the\n same partition key map to the same shard within the stream.

", + "smithy.api#documentation": "

The data blob to put into the record, which is base64-encoded when the blob is\n serialized. When the data blob (the payload before base64-encoding) is added to the\n partition key size, the total size must not exceed the maximum record size (1\n MiB).

", "smithy.api#required": {} } }, - "Data": { - "target": "com.amazonaws.kinesis#Data", + "PartitionKey": { + "target": "com.amazonaws.kinesis#PartitionKey", "traits": { - "smithy.api#documentation": "

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

", + "smithy.api#documentation": "

Determines which shard in the stream the data record is assigned to. Partition keys\n are Unicode strings with a maximum length limit of 256 characters for each key. Amazon\n Kinesis Data Streams uses the partition key as input to a hash function that maps the\n partition key and associated data to a specific shard. Specifically, an MD5 hash\n function is used to map partition keys to 128-bit integer values and to map associated\n data records to shards. As a result of this hashing mechanism, all data records with the\n same partition key map to the same shard within the stream.

", "smithy.api#required": {} } }, "ExplicitHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { - "smithy.api#documentation": "

The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

" + "smithy.api#documentation": "

The hash value used to determine explicitly the shard that the data record is\n assigned to by overriding the partition key hash.

" } } }, @@ -2029,33 +2064,33 @@ "com.amazonaws.kinesis#PutRecordsResultEntry": { "type": "structure", "members": { - "ShardId": { - "target": "com.amazonaws.kinesis#ShardId", + "ErrorCode": { + "target": "com.amazonaws.kinesis#ErrorCode", "traits": { - "smithy.api#documentation": "

The shard ID for an individual record result.

" + "smithy.api#documentation": "

The error code for an individual record result. ErrorCodes can be\n either ProvisionedThroughputExceededException or\n InternalFailure.

" } }, - "SequenceNumber": { - "target": "com.amazonaws.kinesis#SequenceNumber", + "ShardId": { + "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

The sequence number for an individual record result.

" + "smithy.api#documentation": "

The shard ID for an individual record result.

" } }, - "ErrorCode": { - "target": "com.amazonaws.kinesis#ErrorCode", + "ErrorMessage": { + "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { - "smithy.api#documentation": "

The error code for an individual record result. ErrorCodes can be either\n ProvisionedThroughputExceededException or\n InternalFailure.

" + "smithy.api#documentation": "

The error message for an individual record result. An ErrorCode value\n of ProvisionedThroughputExceededException has an error message that\n includes the account ID, stream name, and shard ID. An ErrorCode value of\n InternalFailure has the error message \"Internal Service\n Failure\".

" } }, - "ErrorMessage": { - "target": "com.amazonaws.kinesis#ErrorMessage", + "SequenceNumber": { + "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { - "smithy.api#documentation": "

The error message for an individual record result. An ErrorCode value of\n ProvisionedThroughputExceededException has an error message that\n includes the account ID, stream name, and shard ID. An ErrorCode value of\n InternalFailure has the error message \"Internal Service\n Failure\".

" + "smithy.api#documentation": "

The sequence number for an individual record result.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the result of an individual record from a PutRecords request. A\n record that is successfully added to a stream includes SequenceNumber and\n ShardId in the result. A record that fails to be added to the stream\n includes ErrorCode and ErrorMessage in the result.

" + "smithy.api#documentation": "

Represents the result of an individual record from a PutRecords\n request. A record that is successfully added to a stream includes\n SequenceNumber and ShardId in the result. A record that\n fails to be added to the stream includes ErrorCode and\n ErrorMessage in the result.

" } }, "com.amazonaws.kinesis#PutRecordsResultEntryList": { @@ -2073,20 +2108,6 @@ "com.amazonaws.kinesis#Record": { "type": "structure", "members": { - "PartitionKey": { - "target": "com.amazonaws.kinesis#PartitionKey", - "traits": { - "smithy.api#documentation": "

Identifies which shard in the stream the data record is assigned to.

", - "smithy.api#required": {} - } - }, - "Data": { - "target": "com.amazonaws.kinesis#Data", - "traits": { - "smithy.api#documentation": "

The data blob. The data in the blob is both opaque and immutable to Kinesis Data\n Streams, which does not inspect, interpret, or change the data in the blob in any way.\n When the data blob (the payload before base64-encoding) is added to the partition key\n size, the total size must not exceed the maximum record size (1 MB).

", - "smithy.api#required": {} - } - }, "SequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { @@ -2097,7 +2118,14 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The encryption type used on the record. This parameter can be one of the following values:

\n " + "smithy.api#documentation": "

The encryption type used on the record. This parameter can be one of the following\n values:

\n " + } + }, + "Data": { + "target": "com.amazonaws.kinesis#Data", + "traits": { + "smithy.api#documentation": "

The data blob. The data in the blob is both opaque and immutable to Kinesis Data\n Streams, which does not inspect, interpret, or change the data in the blob in any way.\n When the data blob (the payload before base64-encoding) is added to the partition key\n size, the total size must not exceed the maximum record size (1 MiB).

", + "smithy.api#required": {} } }, "ApproximateArrivalTimestamp": { @@ -2105,6 +2133,13 @@ "traits": { "smithy.api#documentation": "

The approximate time that the record was inserted into the stream.

" } + }, + "PartitionKey": { + "target": "com.amazonaws.kinesis#PartitionKey", + "traits": { + "smithy.api#documentation": "

Identifies which shard in the stream the data record is assigned to.

", + "smithy.api#required": {} + } } }, "traits": { @@ -2140,23 +2175,23 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can read data from the stream at a rate of up to 2 MiB per second.\n This rate is unaffected by the total number of consumers that read from the same\n stream.

\n

You can register up to 5 consumers per stream. A given consumer can only be registered\n with one stream.

\n

This operation has a limit of five transactions per second per account.

" + "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

" } }, "com.amazonaws.kinesis#RegisterStreamConsumerInput": { "type": "structure", "members": { - "StreamARN": { - "target": "com.amazonaws.kinesis#StreamARN", + "ConsumerName": { + "target": "com.amazonaws.kinesis#ConsumerName", "traits": { - "smithy.api#documentation": "

The ARN of the Kinesis data stream that you want to register the consumer with. \n For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

", + "smithy.api#documentation": "

For a given Kinesis data stream, each consumer must have a unique name. However,\n consumer names don't have to be unique across data streams.

", "smithy.api#required": {} } }, - "ConsumerName": { - "target": "com.amazonaws.kinesis#ConsumerName", + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", "traits": { - "smithy.api#documentation": "

For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

", + "smithy.api#documentation": "

The ARN of the Kinesis data stream that you want to register the consumer with. For\n more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } } @@ -2245,18 +2280,14 @@ } }, "traits": { - "smithy.api#documentation": "

The requested resource could not be found. The stream might not be specified correctly.

", + "smithy.api#documentation": "

The requested resource could not be found. The stream might not be specified\n correctly.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#RetentionPeriodHours": { "type": "integer", "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 168 - } + "smithy.api#box": {} } }, "com.amazonaws.kinesis#ScalingType": { @@ -2279,17 +2310,17 @@ "com.amazonaws.kinesis#SequenceNumberRange": { "type": "structure", "members": { - "EndingSequenceNumber": { + "StartingSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { - "smithy.api#documentation": "

The ending sequence number for the range. Shards that are in the OPEN state have an\n ending sequence number of null.

" + "smithy.api#documentation": "

The starting sequence number for the range.

", + "smithy.api#required": {} } }, - "StartingSequenceNumber": { + "EndingSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { - "smithy.api#documentation": "

The starting sequence number for the range.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ending sequence number for the range. Shards that are in the OPEN state have an\n ending sequence number of null.

" } } }, @@ -2300,37 +2331,37 @@ "com.amazonaws.kinesis#Shard": { "type": "structure", "members": { - "ParentShardId": { - "target": "com.amazonaws.kinesis#ShardId", + "SequenceNumberRange": { + "target": "com.amazonaws.kinesis#SequenceNumberRange", "traits": { - "smithy.api#documentation": "

The shard ID of the shard's parent.

" + "smithy.api#documentation": "

The range of possible sequence numbers for the shard.

", + "smithy.api#required": {} } }, - "AdjacentParentShardId": { + "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

The shard ID of the shard adjacent to the shard's parent.

" - } - }, - "SequenceNumberRange": { - "target": "com.amazonaws.kinesis#SequenceNumberRange", - "traits": { - "smithy.api#documentation": "

The range of possible sequence numbers for the shard.

", + "smithy.api#documentation": "

The unique identifier of the shard within the stream.

", "smithy.api#required": {} } }, "HashKeyRange": { "target": "com.amazonaws.kinesis#HashKeyRange", "traits": { - "smithy.api#documentation": "

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

", + "smithy.api#documentation": "

The range of possible hash key values for the shard, which is a set of ordered\n contiguous positive integers.

", "smithy.api#required": {} } }, - "ShardId": { + "AdjacentParentShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

The unique identifier of the shard within the stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The shard ID of the shard adjacent to the shard's parent.

" + } + }, + "ParentShardId": { + "target": "com.amazonaws.kinesis#ShardId", + "traits": { + "smithy.api#documentation": "

The shard ID of the shard's parent.

" } } }, @@ -2348,6 +2379,54 @@ } } }, + "com.amazonaws.kinesis#ShardFilter": { + "type": "structure", + "members": { + "ShardId": { + "target": "com.amazonaws.kinesis#ShardId" + }, + "Timestamp": { + "target": "com.amazonaws.kinesis#Timestamp" + }, + "Type": { + "target": "com.amazonaws.kinesis#ShardFilterType", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kinesis#ShardFilterType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AFTER_SHARD_ID", + "name": "AFTER_SHARD_ID" + }, + { + "value": "AT_TRIM_HORIZON", + "name": "AT_TRIM_HORIZON" + }, + { + "value": "FROM_TRIM_HORIZON", + "name": "FROM_TRIM_HORIZON" + }, + { + "value": "AT_LATEST", + "name": "AT_LATEST" + }, + { + "value": "AT_TIMESTAMP", + "name": "AT_TIMESTAMP" + }, + { + "value": "FROM_TIMESTAMP", + "name": "FROM_TIMESTAMP" + } + ] + } + }, "com.amazonaws.kinesis#ShardId": { "type": "string", "traits": { @@ -2358,6 +2437,12 @@ "smithy.api#pattern": "[a-zA-Z0-9_.-]+" } }, + "com.amazonaws.kinesis#ShardIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.kinesis#ShardId" + } + }, "com.amazonaws.kinesis#ShardIterator": { "type": "string", "traits": { @@ -2420,23 +2505,23 @@ } ], "traits": { - "smithy.api#documentation": "

Splits a shard into two new shards in the Kinesis data stream, to increase the\n stream's capacity to ingest and transport data. SplitShard is called when\n there is a need to increase the overall capacity of a stream because of an expected\n increase in the volume of data records being ingested.

\n

You can also use SplitShard when a shard appears to be approaching its\n maximum utilization; for example, the producers sending data into the specific shard are\n suddenly sending more than previously anticipated. You can also call\n SplitShard to increase stream capacity, so that more Kinesis Data\n Streams applications can simultaneously read data from the stream for real-time\n processing.

\n

You must specify the shard to be split and the new hash key, which is the position\n in the shard where the shard gets split in two. In many cases, the new hash key might be\n the average of the beginning and ending hash key, but it can be any hash key value in\n the range being mapped into the shard. For more information, see Split a\n Shard in the Amazon Kinesis Data Streams Developer\n Guide.

\n

You can use DescribeStream to determine the shard ID and hash key values for the\n ShardToSplit and NewStartingHashKey parameters that are\n specified in the SplitShard request.

\n

\n SplitShard is an asynchronous operation. Upon receiving a\n SplitShard request, Kinesis Data Streams immediately returns a response\n and sets the stream status to UPDATING. After the operation is completed,\n Kinesis Data Streams sets the stream status to ACTIVE. Read and write\n operations continue to work while the stream is in the UPDATING state.

\n

You can use DescribeStream to check the status of the stream, which is\n returned in StreamStatus. If the stream is in the ACTIVE\n state, you can call SplitShard. If a stream is in CREATING or\n UPDATING or DELETING states, DescribeStream\n returns a ResourceInUseException.

\n

If the specified stream does not exist, DescribeStream returns a\n ResourceNotFoundException. If you try to create more shards than are\n authorized for your account, you receive a LimitExceededException.

\n

For the default shard limit for an AWS account, see Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact AWS\n Support.

\n

If you try to operate on too many streams simultaneously using CreateStream,\n DeleteStream, MergeShards, and/or SplitShard, you receive a\n LimitExceededException.

\n

\n SplitShard has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Splits a shard into two new shards in the Kinesis data stream, to increase the\n stream's capacity to ingest and transport data. SplitShard is called when\n there is a need to increase the overall capacity of a stream because of an expected\n increase in the volume of data records being ingested.

\n

You can also use SplitShard when a shard appears to be approaching its\n maximum utilization; for example, the producers sending data into the specific shard are\n suddenly sending more than previously anticipated. You can also call\n SplitShard to increase stream capacity, so that more Kinesis Data\n Streams applications can simultaneously read data from the stream for real-time\n processing.

\n

You must specify the shard to be split and the new hash key, which is the position\n in the shard where the shard gets split in two. In many cases, the new hash key might be\n the average of the beginning and ending hash key, but it can be any hash key value in\n the range being mapped into the shard. For more information, see Split a\n Shard in the Amazon Kinesis Data Streams Developer\n Guide.

\n

You can use DescribeStream to determine the shard ID and hash key\n values for the ShardToSplit and NewStartingHashKey parameters\n that are specified in the SplitShard request.

\n

\n SplitShard is an asynchronous operation. Upon receiving a\n SplitShard request, Kinesis Data Streams immediately returns a response\n and sets the stream status to UPDATING. After the operation is completed,\n Kinesis Data Streams sets the stream status to ACTIVE. Read and write\n operations continue to work while the stream is in the UPDATING state.

\n

You can use DescribeStream to check the status of the stream, which is\n returned in StreamStatus. If the stream is in the ACTIVE\n state, you can call SplitShard. If a stream is in CREATING or\n UPDATING or DELETING states, DescribeStream\n returns a ResourceInUseException.

\n

If the specified stream does not exist, DescribeStream returns a\n ResourceNotFoundException. If you try to create more shards than are\n authorized for your account, you receive a LimitExceededException.

\n

For the default shard limit for an AWS account, see Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact AWS\n Support.

\n

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a\n LimitExceededException.

\n

\n SplitShard has a limit of five transactions per second per\n account.

" } }, "com.amazonaws.kinesis#SplitShardInput": { "type": "structure", "members": { - "NewStartingHashKey": { - "target": "com.amazonaws.kinesis#HashKey", + "ShardToSplit": { + "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

A hash key value for the starting hash key of one of the child shards created by the\n split. The hash key range for a given shard constitutes a set of ordered contiguous\n positive integers. The value for NewStartingHashKey must be in the range of\n hash keys being mapped into the shard. The NewStartingHashKey hash key\n value and all higher hash key values in hash key range are distributed to one of the\n child shards. All the lower hash key values in the range are distributed to the other\n child shard.

", + "smithy.api#documentation": "

The shard ID of the shard to split.

", "smithy.api#required": {} } }, - "ShardToSplit": { - "target": "com.amazonaws.kinesis#ShardId", + "NewStartingHashKey": { + "target": "com.amazonaws.kinesis#HashKey", "traits": { - "smithy.api#documentation": "

The shard ID of the shard to split.

", + "smithy.api#documentation": "

A hash key value for the starting hash key of one of the child shards created by\n the split. The hash key range for a given shard constitutes a set of ordered contiguous\n positive integers. The value for NewStartingHashKey must be in the range of\n hash keys being mapped into the shard. The NewStartingHashKey hash key\n value and all higher hash key values in hash key range are distributed to one of the\n child shards. All the lower hash key values in the range are distributed to the other\n child shard.

", "smithy.api#required": {} } }, @@ -2490,16 +2575,16 @@ } ], "traits": { - "smithy.api#documentation": "

Enables or updates server-side encryption using an AWS KMS key for a specified stream.

\n

Starting encryption is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Updating or applying encryption\n normally takes a few seconds to complete, but it can take minutes. You can continue to\n read and write data to your stream while its status is UPDATING. Once the\n status of the stream is ACTIVE, encryption begins for records written to\n the stream.

\n

API Limits: You can successfully apply a new AWS KMS key for server-side encryption\n 25 times in a rolling 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE\n status before all records written to the stream are encrypted. After you enable\n encryption, you can verify that encryption is applied by inspecting the API response\n from PutRecord or PutRecords.

" + "smithy.api#documentation": "

Enables or updates server-side encryption using an AWS KMS key for a specified\n stream.

\n

Starting encryption is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Updating or applying encryption\n normally takes a few seconds to complete, but it can take minutes. You can continue to\n read and write data to your stream while its status is UPDATING. Once the\n status of the stream is ACTIVE, encryption begins for records written to\n the stream.

\n

API Limits: You can successfully apply a new AWS KMS key for server-side encryption\n 25 times in a rolling 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE\n status before all records written to the stream are encrypted. After you enable\n encryption, you can verify that encryption is applied by inspecting the API response\n from PutRecord or PutRecords.

" } }, "com.amazonaws.kinesis#StartStreamEncryptionInput": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kinesis#KeyId", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either\n an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key\n owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", + "smithy.api#documentation": "

The name of the stream for which to start encrypting records.

", "smithy.api#required": {} } }, @@ -2510,10 +2595,10 @@ "smithy.api#required": {} } }, - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "KeyId": { + "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "

The name of the stream for which to start encrypting records.

", + "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either\n an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key\n owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", "smithy.api#required": {} } } @@ -2522,18 +2607,28 @@ "com.amazonaws.kinesis#StartingPosition": { "type": "structure", "members": { + "Timestamp": { + "target": "com.amazonaws.kinesis#Timestamp", + "traits": { + "smithy.api#documentation": "

The time stamp of the data record from which to start reading. To specify a time\n stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp\n is the Unix epoch date with precision in milliseconds. For example,\n 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a\n record with this exact time stamp does not exist, records will be streamed from the next\n (later) record. If the time stamp is older than the current trim horizon, records will\n be streamed from the oldest untrimmed data record (TRIM_HORIZON).

" + } + }, "SequenceNumber": { - "target": "com.amazonaws.kinesis#SequenceNumber" + "target": "com.amazonaws.kinesis#SequenceNumber", + "traits": { + "smithy.api#documentation": "

The sequence number of the data record in the shard from which to start streaming. To\n specify a sequence number, set StartingPosition to\n AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

" + } }, "Type": { "target": "com.amazonaws.kinesis#ShardIteratorType", "traits": { + "smithy.api#documentation": "

You can set the starting position to one of the following values:

\n

\n AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the\n sequence number specified in the SequenceNumber field.

\n

\n AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted\n by the sequence number specified in the SequenceNumber field.

\n

\n AT_TIMESTAMP: Start streaming from the position denoted by the time stamp\n specified in the Timestamp field.

\n

\n TRIM_HORIZON: Start streaming at the last untrimmed record in the shard,\n which is the oldest data record in the shard.

\n

\n LATEST: Start streaming just after the most recent record in the shard,\n so that you always read the most recent data in the shard.

", "smithy.api#required": {} } - }, - "Timestamp": { - "target": "com.amazonaws.kinesis#Timestamp" } + }, + "traits": { + "smithy.api#documentation": "

" } }, "com.amazonaws.kinesis#StopStreamEncryption": { @@ -2562,13 +2657,6 @@ "com.amazonaws.kinesis#StopStreamEncryptionInput": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kinesis#KeyId", - "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either\n an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key\n owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", - "smithy.api#required": {} - } - }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { @@ -2582,6 +2670,13 @@ "smithy.api#documentation": "

The encryption type. The only valid value is KMS.

", "smithy.api#required": {} } + }, + "KeyId": { + "target": "com.amazonaws.kinesis#KeyId", + "traits": { + "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either\n an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key\n owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", + "smithy.api#required": {} + } } } }, @@ -2592,7 +2687,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:aws.*:kinesis:.*:\\d{12}:stream/.*" + "smithy.api#pattern": "arn:aws.*:kinesis:.*:\\d{12}:stream/.+" } }, "com.amazonaws.kinesis#StreamDescription": { @@ -2601,68 +2696,68 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The server-side encryption type used on the stream. This parameter can be one of the following values:

\n " + "smithy.api#documentation": "

The server-side encryption type used on the stream. This parameter can be one of\n the following values:

\n " } }, - "StreamName": { - "target": "com.amazonaws.kinesis#StreamName", + "EnhancedMonitoring": { + "target": "com.amazonaws.kinesis#EnhancedMonitoringList", "traits": { - "smithy.api#documentation": "

The name of the stream being described.

", + "smithy.api#documentation": "

Represents the current enhanced monitoring settings of the stream.

", "smithy.api#required": {} } }, - "StreamCreationTimestamp": { - "target": "com.amazonaws.kinesis#Timestamp", + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The approximate time that the stream was created.

", + "smithy.api#documentation": "

The name of the stream being described.

", "smithy.api#required": {} } }, - "HasMoreShards": { - "target": "com.amazonaws.kinesis#BooleanObject", + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", "traits": { - "smithy.api#documentation": "

If set to true, more shards in the stream are available to describe.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream being described.

", "smithy.api#required": {} } }, - "KeyId": { - "target": "com.amazonaws.kinesis#KeyId", + "Shards": { + "target": "com.amazonaws.kinesis#ShardList", "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified ARN to either an alias or a key, or\n an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data\n Streams by specifying the alias aws/kinesis.

\n " + "smithy.api#documentation": "

The shards that comprise the stream.

", + "smithy.api#required": {} } }, - "StreamStatus": { - "target": "com.amazonaws.kinesis#StreamStatus", + "RetentionPeriodHours": { + "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { - "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the following states:

\n ", + "smithy.api#documentation": "

The current retention period, in hours. Minimum value of 24. Maximum value of\n 168.

", "smithy.api#required": {} } }, - "Shards": { - "target": "com.amazonaws.kinesis#ShardList", + "HasMoreShards": { + "target": "com.amazonaws.kinesis#BooleanObject", "traits": { - "smithy.api#documentation": "

The shards that comprise the stream.

", + "smithy.api#documentation": "

If set to true, more shards in the stream are available to\n describe.

", "smithy.api#required": {} } }, - "StreamARN": { - "target": "com.amazonaws.kinesis#StreamARN", + "KeyId": { + "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream being described.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified ARN to either an alias or a key, or\n an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data\n Streams by specifying the alias aws/kinesis.

\n " } }, - "RetentionPeriodHours": { - "target": "com.amazonaws.kinesis#RetentionPeriodHours", + "StreamStatus": { + "target": "com.amazonaws.kinesis#StreamStatus", "traits": { - "smithy.api#documentation": "

The current retention period, in hours.

", + "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", "smithy.api#required": {} } }, - "EnhancedMonitoring": { - "target": "com.amazonaws.kinesis#EnhancedMonitoringList", + "StreamCreationTimestamp": { + "target": "com.amazonaws.kinesis#Timestamp", "traits": { - "smithy.api#documentation": "

Represents the current enhanced monitoring settings of the stream.

", + "smithy.api#documentation": "

The approximate time that the stream was created.

", "smithy.api#required": {} } } @@ -2677,13 +2772,13 @@ "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified ARN to either an alias or a key, or\n an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data\n Streams by specifying the alias aws/kinesis.

\n " + "smithy.api#documentation": "

The GUID for the customer-managed AWS KMS key to use for encryption. This value can\n be a globally unique identifier, a fully specified ARN to either an alias or a key, or\n an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data\n Streams by specifying the alias aws/kinesis.

\n " } }, "StreamStatus": { "target": "com.amazonaws.kinesis#StreamStatus", "traits": { - "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the following states:

\n ", + "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", "smithy.api#required": {} } }, @@ -2694,24 +2789,30 @@ "smithy.api#required": {} } }, - "RetentionPeriodHours": { - "target": "com.amazonaws.kinesis#PositiveIntegerObject", + "ConsumerCount": { + "target": "com.amazonaws.kinesis#ConsumerCountObject", "traits": { - "smithy.api#documentation": "

The current retention period, in hours.

", + "smithy.api#documentation": "

The number of enhanced fan-out consumers registered with the stream.

" + } + }, + "OpenShardCount": { + "target": "com.amazonaws.kinesis#ShardCountObject", + "traits": { + "smithy.api#documentation": "

The number of open shards in the stream.

", "smithy.api#required": {} } }, - "EnhancedMonitoring": { - "target": "com.amazonaws.kinesis#EnhancedMonitoringList", + "StreamCreationTimestamp": { + "target": "com.amazonaws.kinesis#Timestamp", "traits": { - "smithy.api#documentation": "

Represents the current enhanced monitoring settings of the stream.

", + "smithy.api#documentation": "

The approximate time that the stream was created.

", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The encryption type used. This value is one of the following:

\n " + "smithy.api#documentation": "

The encryption type used. This value is one of the following:

\n " } }, "StreamName": { @@ -2721,23 +2822,17 @@ "smithy.api#required": {} } }, - "StreamCreationTimestamp": { - "target": "com.amazonaws.kinesis#Timestamp", + "RetentionPeriodHours": { + "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { - "smithy.api#documentation": "

The approximate time that the stream was created.

", + "smithy.api#documentation": "

The current retention period, in hours.

", "smithy.api#required": {} } }, - "ConsumerCount": { - "target": "com.amazonaws.kinesis#ConsumerCountObject", - "traits": { - "smithy.api#documentation": "

The number of enhanced fan-out consumers registered with the stream.

" - } - }, - "OpenShardCount": { - "target": "com.amazonaws.kinesis#ShardCountObject", + "EnhancedMonitoring": { + "target": "com.amazonaws.kinesis#EnhancedMonitoringList", "traits": { - "smithy.api#documentation": "

The number of open shards in the stream.

", + "smithy.api#documentation": "

Represents the current enhanced monitoring settings of the stream.

", "smithy.api#required": {} } } @@ -2808,19 +2903,12 @@ } ], "traits": { - "smithy.api#documentation": "

Call this operation from your consumer after you call RegisterStreamConsumer to register the consumer with Kinesis Data\n Streams. If the call succeeds, your consumer starts receiving events of type SubscribeToShardEvent for up to 5 minutes, after which time you need to\n call SubscribeToShard again to renew the subscription if you want to\n continue to receive records.

\n

You can make one call to SubscribeToShard per second per\n ConsumerARN. If your call succeeds, and then you call the operation\n again less than 5 seconds later, the second call generates a ResourceInUseException. If you call the operation a second time more\n than 5 seconds after the first call succeeds, the second call succeeds and the first\n connection gets shut down.

" + "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the first connection will expire and the second\n call will take over the subscription.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

" } }, "com.amazonaws.kinesis#SubscribeToShardEvent": { "type": "structure", "members": { - "MillisBehindLatest": { - "target": "com.amazonaws.kinesis#MillisBehindLatest", - "traits": { - "smithy.api#documentation": "

The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. \n A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

", - "smithy.api#required": {} - } - }, "Records": { "target": "com.amazonaws.kinesis#RecordList", "traits": { @@ -2831,13 +2919,23 @@ "ContinuationSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { - "smithy.api#documentation": "

Use this as StartingSequenceNumber in the next call to SubscribeToShard.

", + "smithy.api#documentation": "

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to\n AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use\n ContinuationSequenceNumber for checkpointing because it captures your\n shard progress even when no data is written to the shard.

", + "smithy.api#required": {} + } + }, + "MillisBehindLatest": { + "target": "com.amazonaws.kinesis#MillisBehindLatest", + "traits": { + "smithy.api#documentation": "

The number of milliseconds the read records are from the tip of the stream, indicating\n how far behind current time the consumer is. A value of zero indicates that record\n processing is caught up, and there are no new records to process at this moment.

", "smithy.api#required": {} } + }, + "ChildShards": { + "target": "com.amazonaws.kinesis#ChildShardList" } }, "traits": { - "smithy.api#documentation": "

After you call SubscribeToShard, Kinesis Data Streams sends events of this type to your consumer.

" + "smithy.api#documentation": "

After you call SubscribeToShard, Kinesis Data Streams sends events\n of this type over an HTTP/2 connection to your consumer.

" } }, "com.amazonaws.kinesis#SubscribeToShardEventStream": { @@ -2846,6 +2944,18 @@ "KMSThrottlingException": { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, + "InternalFailureException": { + "target": "com.amazonaws.kinesis#InternalFailureException", + "traits": { + "smithy.api#documentation": "

The processing of the request failed because of an unknown error, exception, or\n failure.

" + } + }, + "ResourceInUseException": { + "target": "com.amazonaws.kinesis#ResourceInUseException" + }, + "KMSOptInRequired": { + "target": "com.amazonaws.kinesis#KMSOptInRequired" + }, "KMSDisabledException": { "target": "com.amazonaws.kinesis#KMSDisabledException" }, @@ -2862,32 +2972,20 @@ "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, "SubscribeToShardEvent": { - "target": "com.amazonaws.kinesis#SubscribeToShardEvent" - }, - "ResourceInUseException": { - "target": "com.amazonaws.kinesis#ResourceInUseException" - }, - "InternalFailureException": { - "target": "com.amazonaws.kinesis#InternalFailureException" - }, - "KMSOptInRequired": { - "target": "com.amazonaws.kinesis#KMSOptInRequired" + "target": "com.amazonaws.kinesis#SubscribeToShardEvent", + "traits": { + "smithy.api#documentation": "

After you call SubscribeToShard, Kinesis Data Streams sends events\n of this type to your consumer. For an example of how to handle these events, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

" + } } }, "traits": { + "smithy.api#documentation": "

This is a tagged union for all of the types of events an enhanced fan-out consumer can\n receive over HTTP/2 after a call to SubscribeToShard.

", "smithy.api#streaming": {} } }, "com.amazonaws.kinesis#SubscribeToShardInput": { "type": "structure", "members": { - "ConsumerARN": { - "target": "com.amazonaws.kinesis#ConsumerARN", - "traits": { - "smithy.api#documentation": "

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

", - "smithy.api#required": {} - } - }, "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { @@ -2898,6 +2996,14 @@ "StartingPosition": { "target": "com.amazonaws.kinesis#StartingPosition", "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ConsumerARN": { + "target": "com.amazonaws.kinesis#ConsumerARN", + "traits": { + "smithy.api#documentation": "

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

", "smithy.api#required": {} } } @@ -2918,17 +3024,17 @@ "com.amazonaws.kinesis#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.kinesis#TagKey", + "Value": { + "target": "com.amazonaws.kinesis#TagValue", "traits": { - "smithy.api#documentation": "

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional string, typically used to describe or define the tag. Maximum length:\n 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %\n @

" } }, - "Value": { - "target": "com.amazonaws.kinesis#TagValue", + "Key": { + "target": "com.amazonaws.kinesis#TagKey", "traits": { - "smithy.api#documentation": "

An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" + "smithy.api#documentation": "

A unique identifier for the tag. Maximum length: 128 characters. Valid characters:\n Unicode letters, digits, white space, _ . / = + - % @

", + "smithy.api#required": {} } } }, @@ -2964,7 +3070,8 @@ }, "traits": { "smithy.api#length": { - "min": 0 + "min": 0, + "max": 200 } } }, @@ -2979,7 +3086,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 50 + "max": 200 } } }, @@ -3018,12 +3125,19 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the shard count of the specified stream to the specified number of shards.

\n

Updating the shard count is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Depending on the size of the stream,\n the scaling action could take a few minutes to complete. You can continue to read and\n write data to your stream while its status is UPDATING.

\n

To update the shard count, Kinesis Data Streams performs splits or merges on\n individual shards. This can cause short-lived shards to be created, in addition to the\n final shards. We recommend that you double or halve the shard count, as this results in\n the fewest number of splits or merges.

\n

This operation has the following default limits. By default, you cannot do the\n following:

\n \n

For the default limits for an AWS account, see Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide. To request an\n increase in the call rate limit, the shard limit for this API, or your overall shard\n limit, use the limits form.

" + "smithy.api#documentation": "

Updates the shard count of the specified stream to the specified number of\n shards.

\n

Updating the shard count is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Depending on the size of the stream,\n the scaling action could take a few minutes to complete. You can continue to read and\n write data to your stream while its status is UPDATING.

\n

To update the shard count, Kinesis Data Streams performs splits or merges on\n individual shards. This can cause short-lived shards to be created, in addition to the\n final shards. These short-lived shards count towards your total shard limit for your\n account in the Region.

\n

When using this operation, we recommend that you specify a target shard count that\n is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your\n shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling\n action might take longer to complete.

\n

This operation has the following default limits. By default, you cannot do the\n following:

\n \n

For the default limits for an AWS account, see Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide. To request an\n increase in the call rate limit, the shard limit for this API, or your overall shard\n limit, use the limits form.

" } }, "com.amazonaws.kinesis#UpdateShardCountInput": { "type": "structure", "members": { + "ScalingType": { + "target": "com.amazonaws.kinesis#ScalingType", + "traits": { + "smithy.api#documentation": "

The scaling type. Uniform scaling creates shards of equal size.

", + "smithy.api#required": {} + } + }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { @@ -3034,14 +3148,7 @@ "TargetShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

The new number of shards.

", - "smithy.api#required": {} - } - }, - "ScalingType": { - "target": "com.amazonaws.kinesis#ScalingType", - "traits": { - "smithy.api#documentation": "

The scaling type. Uniform scaling creates shards of equal size.

", + "smithy.api#documentation": "

The new number of shards. This value has the following default limits. By default,\n you cannot do the following:

\n ", "smithy.api#required": {} } } @@ -3050,12 +3157,6 @@ "com.amazonaws.kinesis#UpdateShardCountOutput": { "type": "structure", "members": { - "CurrentShardCount": { - "target": "com.amazonaws.kinesis#PositiveIntegerObject", - "traits": { - "smithy.api#documentation": "

The current number of shards.

" - } - }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { @@ -3067,6 +3168,12 @@ "traits": { "smithy.api#documentation": "

The updated number of shards.

" } + }, + "CurrentShardCount": { + "target": "com.amazonaws.kinesis#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The current number of shards.

" + } } } } 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 aa1b1fb5433e..3b2a51ec9150 100644 --- a/codegen/sdk-codegen/aws-models/kms.2014-11-01.json +++ b/codegen/sdk-codegen/aws-models/kms.2014-11-01.json @@ -403,17 +403,17 @@ "com.amazonaws.kms#CreateAliasRequest": { "type": "structure", "members": { - "AliasName": { - "target": "com.amazonaws.kms#AliasNameType", + "TargetKeyId": { + "target": "com.amazonaws.kms#KeyIdType", "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": "

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#required": {} } }, - "TargetKeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "AliasName": { + "target": "com.amazonaws.kms#AliasNameType", "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": "

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#required": {} } } @@ -457,31 +457,31 @@ "com.amazonaws.kms#CreateCustomKeyStoreRequest": { "type": "structure", "members": { - "CloudHsmClusterId": { - "target": "com.amazonaws.kms#CloudHsmClusterIdType", + "CustomKeyStoreName": { + "target": "com.amazonaws.kms#CustomKeyStoreNameType", "traits": { - "smithy.api#documentation": "

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active\n AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID,\n use the DescribeClusters operation.

", + "smithy.api#documentation": "

Specifies a friendly name for the custom key store. The name must be unique in your AWS\n account.

", "smithy.api#required": {} } }, - "CustomKeyStoreName": { - "target": "com.amazonaws.kms#CustomKeyStoreNameType", + "KeyStorePassword": { + "target": "com.amazonaws.kms#KeyStorePasswordType", "traits": { - "smithy.api#documentation": "

Specifies a friendly name for the custom key store. The name must be unique in your AWS\n account.

", + "smithy.api#documentation": "

Enter the password of the \n kmsuser crypto user\n (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this\n user to manage key material on your behalf.

\n

The password must be a string of 7 to 32 characters. Its value is case sensitive.

\n

This parameter tells AWS KMS the kmsuser account password; it does not change\n the password in the AWS CloudHSM cluster.

", "smithy.api#required": {} } }, - "TrustAnchorCertificate": { - "target": "com.amazonaws.kms#TrustAnchorCertificateType", + "CloudHsmClusterId": { + "target": "com.amazonaws.kms#CloudHsmClusterIdType", "traits": { - "smithy.api#documentation": "

Enter the content of the trust anchor certificate for the cluster. This is the content of\n the customerCA.crt file that you created when you initialized the cluster.

", + "smithy.api#documentation": "

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active\n AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID,\n use the DescribeClusters operation.

", "smithy.api#required": {} } }, - "KeyStorePassword": { - "target": "com.amazonaws.kms#KeyStorePasswordType", + "TrustAnchorCertificate": { + "target": "com.amazonaws.kms#TrustAnchorCertificateType", "traits": { - "smithy.api#documentation": "

Enter the password of the \n kmsuser crypto user\n (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this\n user to manage key material on your behalf.

\n

The password must be a string of 7 to 32 characters. Its value is case sensitive.

\n

This parameter tells AWS KMS the kmsuser account password; it does not change\n the password in the AWS CloudHSM cluster.

", + "smithy.api#documentation": "

Enter the content of the trust anchor certificate for the cluster. This is the content of\n the customerCA.crt file that you created when you initialized the cluster.

", "smithy.api#required": {} } } @@ -539,10 +539,11 @@ "com.amazonaws.kms#CreateGrantRequest": { "type": "structure", "members": { - "GrantTokens": { - "target": "com.amazonaws.kms#GrantTokenList", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The unique identifier for the customer master key (CMK) that the grant applies to.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#required": {} } }, "Operations": { @@ -552,6 +553,12 @@ "smithy.api#required": {} } }, + "RetiringPrincipal": { + "target": "com.amazonaws.kms#PrincipalIdType", + "traits": { + "smithy.api#documentation": "

The principal that is given permission to retire the grant by using RetireGrant operation.

\n

To specify the 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 to use for specifying a principal, see\n AWS Identity and Access Management (IAM) in the Example ARNs section of the\n AWS General Reference.

" + } + }, "GranteePrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { @@ -559,10 +566,10 @@ "smithy.api#required": {} } }, - "RetiringPrincipal": { - "target": "com.amazonaws.kms#PrincipalIdType", + "Constraints": { + "target": "com.amazonaws.kms#GrantConstraints", "traits": { - "smithy.api#documentation": "

The principal that is given permission to retire the grant by using RetireGrant operation.

\n

To specify the 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 to use for specifying a principal, see\n AWS Identity and Access Management (IAM) in the Example ARNs section of the\n AWS General Reference.

" + "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 .

" } }, "Name": { @@ -571,17 +578,10 @@ "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.

" } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", - "traits": { - "smithy.api#documentation": "

The unique identifier for the customer master key (CMK) that the grant applies to.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", - "smithy.api#required": {} - } - }, - "Constraints": { - "target": "com.amazonaws.kms#GrantConstraints", + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", "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": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } } } @@ -650,22 +650,16 @@ "com.amazonaws.kms#CreateKeyRequest": { "type": "structure", "members": { - "Origin": { - "target": "com.amazonaws.kms#OriginType", - "traits": { - "smithy.api#documentation": "

The source of the key material for the CMK. You cannot change the origin after you create\n the CMK. The default is AWS_KMS, which means AWS KMS creates the key\n material.

\n

When the parameter value is EXTERNAL, AWS KMS creates a CMK without key\n material so that you can import key material from your existing key management infrastructure.\n For more information about importing key material into AWS KMS, see Importing Key Material in the\n AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.

\n

When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS\n custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also\n use the CustomKeyStoreId parameter to identify the custom key store. This value\n is valid only for symmetric CMKs.

" - } - }, - "Policy": { - "target": "com.amazonaws.kms#PolicyType", + "KeyUsage": { + "target": "com.amazonaws.kms#KeyUsageType", "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": "

Determines the cryptographic operations for which you can use the CMK. The default value\n is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You\n can't change the KeyUsage value after the CMK is created.

\n

Select only one valid value.

\n " } }, - "CustomerMasterKeySpec": { - "target": "com.amazonaws.kms#CustomerMasterKeySpec", + "Origin": { + "target": "com.amazonaws.kms#OriginType", "traits": { - "smithy.api#documentation": "

Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT,\n creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a\n key spec for your CMK, see How to Choose Your CMK\n Configuration in the AWS Key Management Service Developer\n Guide.

\n

The CustomerMasterKeySpec determines whether the CMK contains a symmetric key\n or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms\n that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK\n is created. To further restrict the algorithms that can be used with the CMK, use a condition\n key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer\n Guide.

\n \n

\n AWS services that\n are integrated with AWS KMS use symmetric CMKs to protect your data. These\n services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or\n asymmetric, see Identifying Symmetric and Asymmetric\n CMKs in the AWS Key Management Service Developer\n Guide.

\n \n

AWS KMS supports the following key specs for CMKs:

\n " + "smithy.api#documentation": "

The source of the key material for the CMK. You cannot change the origin after you create\n the CMK. The default is AWS_KMS, which means AWS KMS creates the key\n material.

\n

When the parameter value is EXTERNAL, AWS KMS creates a CMK without key\n material so that you can import key material from your existing key management infrastructure.\n For more information about importing key material into AWS KMS, see Importing Key Material in the\n AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.

\n

When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS\n custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also\n use the CustomKeyStoreId parameter to identify the custom key store. This value\n is valid only for symmetric CMKs.

" } }, "Description": { @@ -674,16 +668,16 @@ "smithy.api#documentation": "

A description of the CMK.

\n

Use a description that helps you decide whether the CMK is appropriate for a task.

" } }, - "BypassPolicyLockoutSafetyCheck": { - "target": "com.amazonaws.kms#BooleanType", + "Tags": { + "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the \n AWS Key Management Service Developer Guide\n .

\n \n

Use this parameter only when you include a policy in the request and you intend to prevent\n the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

\n

The default value is false.

" + "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.

" } }, - "KeyUsage": { - "target": "com.amazonaws.kms#KeyUsageType", + "BypassPolicyLockoutSafetyCheck": { + "target": "com.amazonaws.kms#BooleanType", "traits": { - "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the CMK. The default value\n is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You\n can't change the KeyUsage value after the CMK is created.

\n

Select only one valid value.

\n " + "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the \n AWS Key Management Service Developer Guide\n .

\n \n

Use this parameter only when you include a policy in the request and you intend to prevent\n the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

\n

The default value is false.

" } }, "CustomKeyStoreId": { @@ -692,10 +686,16 @@ "smithy.api#documentation": "

Creates the CMK in the specified custom key store and the key material in its associated\n AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a\n custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.

\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.

" } }, - "Tags": { - "target": "com.amazonaws.kms#TagList", + "CustomerMasterKeySpec": { + "target": "com.amazonaws.kms#CustomerMasterKeySpec", "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": "

Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT,\n creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a\n key spec for your CMK, see How to Choose Your CMK\n Configuration in the AWS Key Management Service Developer\n Guide.

\n

The CustomerMasterKeySpec determines whether the CMK contains a symmetric key\n or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms\n that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK\n is created. To further restrict the algorithms that can be used with the CMK, use a condition\n key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer\n Guide.

\n \n

\n AWS services that\n are integrated with AWS KMS use symmetric CMKs to protect your data. These\n services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or\n asymmetric, see Identifying Symmetric and Asymmetric\n CMKs in the AWS Key Management Service Developer\n Guide.

\n \n

AWS KMS supports the following key specs for CMKs:

\n " + } + }, + "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).

" } } } @@ -790,28 +790,16 @@ "com.amazonaws.kms#CustomKeyStoresListEntry": { "type": "structure", "members": { - "CreationDate": { - "target": "com.amazonaws.kms#DateType", - "traits": { - "smithy.api#documentation": "

The date and time when the custom key store was created.

" - } - }, - "CustomKeyStoreName": { - "target": "com.amazonaws.kms#CustomKeyStoreNameType", - "traits": { - "smithy.api#documentation": "

The user-specified friendly name for the custom key store.

" - } - }, "ConnectionErrorCode": { "target": "com.amazonaws.kms#ConnectionErrorCodeType", "traits": { "smithy.api#documentation": "

Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.

\n

Valid values are:

\n " } }, - "CustomKeyStoreId": { - "target": "com.amazonaws.kms#CustomKeyStoreIdType", + "ConnectionState": { + "target": "com.amazonaws.kms#ConnectionStateType", "traits": { - "smithy.api#documentation": "

A unique identifier for the custom key store.

" + "smithy.api#documentation": "

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

\n

You can create and use CMKs in your custom key stores only when its connection state is\n CONNECTED.

\n

The value is DISCONNECTED if the key store has never been connected or you\n use the DisconnectCustomKeyStore operation to disconnect it. If the value is\n CONNECTED but you are having trouble using the custom key store, make sure that\n its associated AWS CloudHSM cluster is active and contains at least one active HSM.

\n

A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For\n help resolving a connection failure, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

" } }, "TrustAnchorCertificate": { @@ -820,10 +808,16 @@ "smithy.api#documentation": "

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the\n cluster, you create this certificate and save it in the customerCA.crt\n file.

" } }, - "ConnectionState": { - "target": "com.amazonaws.kms#ConnectionStateType", + "CustomKeyStoreName": { + "target": "com.amazonaws.kms#CustomKeyStoreNameType", "traits": { - "smithy.api#documentation": "

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

\n

You can create and use CMKs in your custom key stores only when its connection state is\n CONNECTED.

\n

The value is DISCONNECTED if the key store has never been connected or you\n use the DisconnectCustomKeyStore operation to disconnect it. If the value is\n CONNECTED but you are having trouble using the custom key store, make sure that\n its associated AWS CloudHSM cluster is active and contains at least one active HSM.

\n

A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For\n help resolving a connection failure, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The user-specified friendly name for the custom key store.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the custom key store was created.

" } }, "CloudHsmClusterId": { @@ -831,6 +825,12 @@ "traits": { "smithy.api#documentation": "

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key\n store.

" } + }, + "CustomKeyStoreId": { + "target": "com.amazonaws.kms#CustomKeyStoreIdType", + "traits": { + "smithy.api#documentation": "

A unique identifier for the custom key store.

" + } } }, "traits": { @@ -976,18 +976,18 @@ "com.amazonaws.kms#DecryptRequest": { "type": "structure", "members": { - "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.

" - } - }, "EncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { "smithy.api#documentation": "

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify\n the same algorithm that was used to encrypt the data. If you specify a different algorithm,\n the Decrypt operation fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm\n that is valid for symmetric CMKs.

" } }, + "EncryptionContext": { + "target": "com.amazonaws.kms#EncryptionContextType", + "traits": { + "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + } + }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { @@ -1001,10 +1001,10 @@ "smithy.api#required": {} } }, - "EncryptionContext": { - "target": "com.amazonaws.kms#EncryptionContextType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "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.

" } } } @@ -1012,18 +1012,18 @@ "com.amazonaws.kms#DecryptResponse": { "type": "structure", "members": { - "EncryptionAlgorithm": { - "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", - "traits": { - "smithy.api#documentation": "

The encryption algorithm that was used to decrypt the ciphertext.

" - } - }, "Plaintext": { "target": "com.amazonaws.kms#PlaintextType", "traits": { "smithy.api#documentation": "

Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, + "EncryptionAlgorithm": { + "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The encryption algorithm that was used to decrypt the ciphertext.

" + } + }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { @@ -1186,10 +1186,10 @@ "com.amazonaws.kms#DescribeCustomKeyStoresRequest": { "type": "structure", "members": { - "CustomKeyStoreName": { - "target": "com.amazonaws.kms#CustomKeyStoreNameType", + "Limit": { + "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Gets only information about the specified custom key store. Enter the friendly name of the\n custom key store.

\n

By default, this operation gets information about all custom key stores in the account and\n region. To limit the output to a particular custom key store, you can use either the\n CustomKeyStoreId or CustomKeyStoreName parameter, but not\n both.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

" } }, "Marker": { @@ -1198,10 +1198,10 @@ "smithy.api#documentation": "

Use this parameter in a subsequent request after you receive a response with\n truncated results. Set it to the value of NextMarker from the truncated response\n you just received.

" } }, - "Limit": { - "target": "com.amazonaws.kms#LimitType", + "CustomKeyStoreName": { + "target": "com.amazonaws.kms#CustomKeyStoreNameType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

" + "smithy.api#documentation": "

Gets only information about the specified custom key store. Enter the friendly name of the\n custom key store.

\n

By default, this operation gets information about all custom key stores in the account and\n region. To limit the output to a particular custom key store, you can use either the\n CustomKeyStoreId or CustomKeyStoreName parameter, but not\n both.

" } }, "CustomKeyStoreId": { @@ -1264,18 +1264,18 @@ "com.amazonaws.kms#DescribeKeyRequest": { "type": "structure", "members": { - "GrantTokens": { - "target": "com.amazonaws.kms#GrantTokenList", - "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" - } - }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { "smithy.api#documentation": "

Describes the specified customer master key (CMK).

\n

If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the\n alias with an AWS\n managed CMK and returns its KeyId and Arn in the\n response.

\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": {} } + }, + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", + "traits": { + "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + } } } }, @@ -1559,35 +1559,35 @@ "com.amazonaws.kms#EncryptRequest": { "type": "structure", "members": { - "GrantTokens": { - "target": "com.amazonaws.kms#GrantTokenList", + "Plaintext": { + "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Data to be encrypted.

", + "smithy.api#required": {} } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "EncryptionContext": { + "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\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": {} + "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" } }, - "EncryptionAlgorithm": { - "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the CMK that you specify.

\n

This parameter is required only for asymmetric CMKs. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using\n an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } }, - "EncryptionContext": { - "target": "com.amazonaws.kms#EncryptionContextType", + "EncryptionAlgorithm": { + "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the CMK that you specify.

\n

This parameter is required only for asymmetric CMKs. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using\n an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.

" } }, - "Plaintext": { - "target": "com.amazonaws.kms#PlaintextType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Data to be encrypted.

", + "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\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": {} } } @@ -1596,10 +1596,10 @@ "com.amazonaws.kms#EncryptResponse": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "EncryptionAlgorithm": { + "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that was used to encrypt the plaintext.

" + "smithy.api#documentation": "

The encryption algorithm that was used to encrypt the plaintext.

" } }, "CiphertextBlob": { @@ -1608,10 +1608,10 @@ "smithy.api#documentation": "

The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, - "EncryptionAlgorithm": { - "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The encryption algorithm that was used to encrypt the plaintext.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that was used to encrypt the plaintext.

" } } } @@ -1769,23 +1769,16 @@ "com.amazonaws.kms#GenerateDataKeyPairRequest": { "type": "structure", "members": { - "EncryptionContext": { - "target": "com.amazonaws.kms#EncryptionContextType", - "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" - } - }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "EncryptionContext": { + "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot\n specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your\n 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": {} + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" } }, "KeyPairSpec": { @@ -1794,22 +1787,23 @@ "smithy.api#documentation": "

Determines the type of data key pair that is generated.

\n

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

", "smithy.api#required": {} } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot\n specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your\n 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": {} + } } } }, "com.amazonaws.kms#GenerateDataKeyPairResponse": { "type": "structure", "members": { - "PrivateKeyCiphertextBlob": { - "target": "com.amazonaws.kms#CiphertextType", - "traits": { - "smithy.api#documentation": "

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" - } - }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "PublicKey": { + "target": "com.amazonaws.kms#PublicKeyType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that encrypted the private key.

" + "smithy.api#documentation": "

The public key (in plaintext).

" } }, "KeyPairSpec": { @@ -1824,10 +1818,16 @@ "smithy.api#documentation": "

The plaintext copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, - "PublicKey": { - "target": "com.amazonaws.kms#PublicKeyType", + "PrivateKeyCiphertextBlob": { + "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The public key (in plaintext).

" + "smithy.api#documentation": "

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that encrypted the private key.

" } } } @@ -1876,13 +1876,6 @@ "com.amazonaws.kms#GenerateDataKeyPairWithoutPlaintextRequest": { "type": "structure", "members": { - "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#required": {} - } - }, "KeyPairSpec": { "target": "com.amazonaws.kms#DataKeyPairSpec", "traits": { @@ -1890,10 +1883,11 @@ "smithy.api#required": {} } }, - "EncryptionContext": { - "target": "com.amazonaws.kms#EncryptionContextType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "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#required": {} } }, "GrantTokens": { @@ -1901,6 +1895,12 @@ "traits": { "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } + }, + "EncryptionContext": { + "target": "com.amazonaws.kms#EncryptionContextType", + "traits": { + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + } } } }, @@ -1942,10 +1942,10 @@ "smithy.api#documentation": "

Specifies the length of the data key in bytes. For example, use the value 64 to generate a\n 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data\n keys, use the KeySpec parameter.

\n

You must specify either the KeySpec or the NumberOfBytes\n parameter (but not both) in every GenerateDataKey request.

" } }, - "EncryptionContext": { - "target": "com.amazonaws.kms#EncryptionContextType", + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } }, "KeyId": { @@ -1955,17 +1955,17 @@ "smithy.api#required": {} } }, - "GrantTokens": { - "target": "com.amazonaws.kms#GrantTokenList", - "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" - } - }, "KeySpec": { "target": "com.amazonaws.kms#DataKeySpec", "traits": { "smithy.api#documentation": "

Specifies the length of the data key. Use AES_128 to generate a 128-bit\n symmetric key, or AES_256 to generate a 256-bit symmetric key.

\n

You must specify either the KeySpec or the NumberOfBytes\n parameter (but not both) in every GenerateDataKey request.

" } + }, + "EncryptionContext": { + "target": "com.amazonaws.kms#EncryptionContextType", + "traits": { + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + } } } }, @@ -2033,12 +2033,6 @@ "com.amazonaws.kms#GenerateDataKeyWithoutPlaintextRequest": { "type": "structure", "members": { - "EncryptionContext": { - "target": "com.amazonaws.kms#EncryptionContextType", - "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" - } - }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { @@ -2046,6 +2040,12 @@ "smithy.api#required": {} } }, + "NumberOfBytes": { + "target": "com.amazonaws.kms#NumberOfBytesType", + "traits": { + "smithy.api#documentation": "

The length of the data key in bytes. For example, use the value 64 to generate a 512-bit\n data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys),\n we recommend that you use the KeySpec field instead of this one.

" + } + }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { @@ -2058,10 +2058,10 @@ "smithy.api#documentation": "

The length of the data key. Use AES_128 to generate a 128-bit symmetric key,\n or AES_256 to generate a 256-bit symmetric key.

" } }, - "NumberOfBytes": { - "target": "com.amazonaws.kms#NumberOfBytesType", + "EncryptionContext": { + "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

The length of the data key in bytes. For example, use the value 64 to generate a 512-bit\n data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys),\n we recommend that you use the KeySpec field instead of this one.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" } } } @@ -2169,17 +2169,17 @@ "com.amazonaws.kms#GetKeyPolicyRequest": { "type": "structure", "members": { - "PolicyName": { - "target": "com.amazonaws.kms#PolicyNameType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the name of the key policy. The only valid name is default. To get\n the names of key policies, use ListKeyPolicies.

", + "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\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": {} } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "PolicyName": { + "target": "com.amazonaws.kms#PolicyNameType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\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": "

Specifies the name of the key policy. The only valid name is default. To get\n the names of key policies, use ListKeyPolicies.

", "smithy.api#required": {} } } @@ -2312,12 +2312,6 @@ "com.amazonaws.kms#GetParametersForImportResponse": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK to use in a subsequent ImportKeyMaterial\n request. This is the same CMK specified in the GetParametersForImport\n request.

" - } - }, "ImportToken": { "target": "com.amazonaws.kms#CiphertextType", "traits": { @@ -2335,6 +2329,12 @@ "traits": { "smithy.api#documentation": "

The time at which the import token and public key are no longer valid. After this time,\n you cannot use them to make an ImportKeyMaterial request and you must send\n another GetParametersForImport request to get new ones.

" } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK to use in a subsequent ImportKeyMaterial\n request. This is the same CMK specified in the GetParametersForImport\n request.

" + } } } }, @@ -2403,16 +2403,10 @@ "com.amazonaws.kms#GetPublicKeyResponse": { "type": "structure", "members": { - "KeyUsage": { - "target": "com.amazonaws.kms#KeyUsageType", - "traits": { - "smithy.api#documentation": "

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or\n SIGN_VERIFY.

\n

This information is critical. If a public key with SIGN_VERIFY key usage\n encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

" - } - }, - "PublicKey": { - "target": "com.amazonaws.kms#PublicKeyType", + "EncryptionAlgorithms": { + "target": "com.amazonaws.kms#EncryptionAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The exported public key.

\n

The value is a DER-encoded X.509 public key, also known as\n SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

\n

" + "smithy.api#documentation": "

The encryption algorithms that AWS KMS supports for this key.

\n

This information is critical. If a public key encrypts data outside of AWS KMS by using an\n unsupported encryption algorithm, the ciphertext cannot be decrypted.

\n

This field appears in the response only when the KeyUsage of the public key\n is ENCRYPT_DECRYPT.

" } }, "CustomerMasterKeySpec": { @@ -2421,6 +2415,12 @@ "smithy.api#documentation": "

The type of the of the public key that was downloaded.

" } }, + "PublicKey": { + "target": "com.amazonaws.kms#PublicKeyType", + "traits": { + "smithy.api#documentation": "

The exported public key.

\n

The value is a DER-encoded X.509 public key, also known as\n SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

\n

" + } + }, "SigningAlgorithms": { "target": "com.amazonaws.kms#SigningAlgorithmSpecList", "traits": { @@ -2433,10 +2433,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

" } }, - "EncryptionAlgorithms": { - "target": "com.amazonaws.kms#EncryptionAlgorithmSpecList", + "KeyUsage": { + "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

The encryption algorithms that AWS KMS supports for this key.

\n

This information is critical. If a public key encrypts data outside of AWS KMS by using an\n unsupported encryption algorithm, the ciphertext cannot be decrypted.

\n

This field appears in the response only when the KeyUsage of the public key\n is ENCRYPT_DECRYPT.

" + "smithy.api#documentation": "

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or\n SIGN_VERIFY.

\n

This information is critical. If a public key with SIGN_VERIFY key usage\n encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

" } } } @@ -2479,16 +2479,16 @@ "com.amazonaws.kms#GrantListEntry": { "type": "structure", "members": { - "IssuingAccount": { - "target": "com.amazonaws.kms#PrincipalIdType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The AWS account under which the grant was issued.

" + "smithy.api#documentation": "

The unique identifier for the customer master key (CMK) to which the grant applies.

" } }, - "GranteePrincipal": { - "target": "com.amazonaws.kms#PrincipalIdType", + "GrantId": { + "target": "com.amazonaws.kms#GrantIdType", "traits": { - "smithy.api#documentation": "

The identity that gets the permissions in the grant.

\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.

" + "smithy.api#documentation": "

The unique identifier for the grant.

" } }, "Operations": { @@ -2497,28 +2497,34 @@ "smithy.api#documentation": "

The list of operations permitted by the grant.

" } }, + "IssuingAccount": { + "target": "com.amazonaws.kms#PrincipalIdType", + "traits": { + "smithy.api#documentation": "

The AWS account under which the grant was issued.

" + } + }, "Name": { "target": "com.amazonaws.kms#GrantNameType", "traits": { "smithy.api#documentation": "

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

" } }, - "RetiringPrincipal": { + "GranteePrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The principal that can retire the grant.

" + "smithy.api#documentation": "

The identity that gets the permissions in the grant.

\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.

" } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "CreationDate": { + "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The unique identifier for the customer master key (CMK) to which the grant applies.

" + "smithy.api#documentation": "

The date and time when the grant was created.

" } }, - "GrantId": { - "target": "com.amazonaws.kms#GrantIdType", + "RetiringPrincipal": { + "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The unique identifier for the grant.

" + "smithy.api#documentation": "

The principal that can retire the grant.

" } }, "Constraints": { @@ -2526,12 +2532,6 @@ "traits": { "smithy.api#documentation": "

A list of key-value pairs that must be present in the encryption context of certain\n subsequent operations that the grant allows.

" } - }, - "CreationDate": { - "target": "com.amazonaws.kms#DateType", - "traits": { - "smithy.api#documentation": "

The date and time when the grant was created.

" - } } }, "traits": { @@ -2685,6 +2685,12 @@ "com.amazonaws.kms#ImportKeyMaterialRequest": { "type": "structure", "members": { + "ValidTo": { + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, AWS KMS\n deletes the key material and the CMK becomes unusable. You must omit this parameter when the\n ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE.\n Otherwise it is required.

" + } + }, "ImportToken": { "target": "com.amazonaws.kms#CiphertextType", "traits": { @@ -2711,12 +2717,6 @@ "traits": { "smithy.api#documentation": "

Specifies whether the key material expires. The default is\n KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo\n parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must\n omit the ValidTo parameter.

" } - }, - "ValidTo": { - "target": "com.amazonaws.kms#DateType", - "traits": { - "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, AWS KMS\n deletes the key material and the CMK becomes unusable. You must omit this parameter when the\n ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE.\n Otherwise it is required.

" - } } } }, @@ -2959,17 +2959,16 @@ "com.amazonaws.kms#KeyMetadata": { "type": "structure", "members": { - "ExpirationModel": { - "target": "com.amazonaws.kms#ExpirationModelType", + "KeyState": { + "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

Specifies whether the CMK's key material expires. This value is present only when\n Origin is EXTERNAL, otherwise this value is omitted.

" + "smithy.api#documentation": "

The current status of the CMK.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

" } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "DeletionDate": { + "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The globally unique identifier for the CMK.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The date and time after which AWS KMS deletes the CMK. This value is present only when\n KeyState is PendingDeletion.

" } }, "CreationDate": { @@ -2978,94 +2977,95 @@ "smithy.api#documentation": "

The date and time when the CMK was created.

" } }, - "CloudHsmClusterId": { - "target": "com.amazonaws.kms#CloudHsmClusterIdType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you\n create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the\n associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key\n store.

" + "smithy.api#documentation": "

The globally unique identifier for the CMK.

", + "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.kms#ArnType", + "Origin": { + "target": "com.amazonaws.kms#OriginType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service\n (AWS KMS) in the Example ARNs section of the AWS General\n Reference.

" + "smithy.api#documentation": "

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS\n created the key material. When this value is EXTERNAL, the key material was\n imported from your existing key management infrastructure or the CMK lacks key material. When\n this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster\n associated with a custom key store.

" } }, - "KeyManager": { - "target": "com.amazonaws.kms#KeyManagerType", + "Description": { + "target": "com.amazonaws.kms#DescriptionType", "traits": { - "smithy.api#documentation": "

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS\n managed. For more information about the difference, see Customer Master Keys in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The description of the CMK.

" } }, - "KeyState": { - "target": "com.amazonaws.kms#KeyState", + "AWSAccountId": { + "target": "com.amazonaws.kms#AWSAccountIdType", "traits": { - "smithy.api#documentation": "

The current status of the CMK.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The twelve-digit account ID of the AWS account that owns the CMK.

" } }, - "KeyUsage": { - "target": "com.amazonaws.kms#KeyUsageType", + "SigningAlgorithms": { + "target": "com.amazonaws.kms#SigningAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The cryptographic operations for which you can use the CMK.

" + "smithy.api#documentation": "

The signing algorithms that the CMK supports. You cannot use the CMK with other\n signing algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n SIGN_VERIFY.

" } }, - "CustomKeyStoreId": { - "target": "com.amazonaws.kms#CustomKeyStoreIdType", + "CustomerMasterKeySpec": { + "target": "com.amazonaws.kms#CustomerMasterKeySpec", "traits": { - "smithy.api#documentation": "

A unique identifier for the custom key store that contains the CMK. This value is present\n only when the CMK is created in a custom key store.

" + "smithy.api#documentation": "

Describes the type of key material in the CMK.

" } }, - "AWSAccountId": { - "target": "com.amazonaws.kms#AWSAccountIdType", + "ValidTo": { + "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The twelve-digit account ID of the AWS account that owns the CMK.

" + "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, AWS KMS\n deletes the key material and the CMK becomes unusable. This value is present only for CMKs\n whose Origin is EXTERNAL and whose ExpirationModel is\n KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

" } }, - "Description": { - "target": "com.amazonaws.kms#DescriptionType", + "CloudHsmClusterId": { + "target": "com.amazonaws.kms#CloudHsmClusterIdType", "traits": { - "smithy.api#documentation": "

The description of the CMK.

" + "smithy.api#documentation": "

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you\n create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the\n associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key\n store.

" } }, - "EncryptionAlgorithms": { - "target": "com.amazonaws.kms#EncryptionAlgorithmSpecList", + "KeyUsage": { + "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

The encryption algorithms that the CMK supports. You cannot use the CMK with other\n encryption algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n ENCRYPT_DECRYPT.

" + "smithy.api#documentation": "

The cryptographic operations for which you can use the CMK.

" } }, - "ValidTo": { - "target": "com.amazonaws.kms#DateType", + "EncryptionAlgorithms": { + "target": "com.amazonaws.kms#EncryptionAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, AWS KMS\n deletes the key material and the CMK becomes unusable. This value is present only for CMKs\n whose Origin is EXTERNAL and whose ExpirationModel is\n KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

" + "smithy.api#documentation": "

The encryption algorithms that the CMK supports. You cannot use the CMK with other\n encryption algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n ENCRYPT_DECRYPT.

" } }, - "Enabled": { - "target": "com.amazonaws.kms#BooleanType", + "Arn": { + "target": "com.amazonaws.kms#ArnType", "traits": { - "smithy.api#documentation": "

Specifies whether the CMK is enabled. When KeyState is Enabled\n this value is true, otherwise it is false.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service\n (AWS KMS) in the Example ARNs section of the AWS General\n Reference.

" } }, - "SigningAlgorithms": { - "target": "com.amazonaws.kms#SigningAlgorithmSpecList", + "ExpirationModel": { + "target": "com.amazonaws.kms#ExpirationModelType", "traits": { - "smithy.api#documentation": "

The signing algorithms that the CMK supports. You cannot use the CMK with other\n signing algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n SIGN_VERIFY.

" + "smithy.api#documentation": "

Specifies whether the CMK's key material expires. This value is present only when\n Origin is EXTERNAL, otherwise this value is omitted.

" } }, - "CustomerMasterKeySpec": { - "target": "com.amazonaws.kms#CustomerMasterKeySpec", + "KeyManager": { + "target": "com.amazonaws.kms#KeyManagerType", "traits": { - "smithy.api#documentation": "

Describes the type of key material in the CMK.

" + "smithy.api#documentation": "

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS\n managed. For more information about the difference, see Customer Master Keys in the\n AWS Key Management Service Developer Guide.

" } }, - "Origin": { - "target": "com.amazonaws.kms#OriginType", + "Enabled": { + "target": "com.amazonaws.kms#BooleanType", "traits": { - "smithy.api#documentation": "

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS\n created the key material. When this value is EXTERNAL, the key material was\n imported from your existing key management infrastructure or the CMK lacks key material. When\n this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster\n associated with a custom key store.

" + "smithy.api#documentation": "

Specifies whether the CMK is enabled. When KeyState is Enabled\n this value is true, otherwise it is false.

" } }, - "DeletionDate": { - "target": "com.amazonaws.kms#DateType", + "CustomKeyStoreId": { + "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

The date and time after which AWS KMS deletes the CMK. This value is present only when\n KeyState is PendingDeletion.

" + "smithy.api#documentation": "

A unique identifier for the custom key store that contains the CMK. This value is present\n only when the CMK is created in a custom key store.

" } } }, @@ -3199,12 +3199,6 @@ "com.amazonaws.kms#ListAliasesRequest": { "type": "structure", "members": { - "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.

" - } - }, "Marker": { "target": "com.amazonaws.kms#MarkerType", "traits": { @@ -3216,18 +3210,18 @@ "traits": { "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" } + }, + "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.

" + } } } }, "com.amazonaws.kms#ListAliasesResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.kms#MarkerType", - "traits": { - "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

" - } - }, "Aliases": { "target": "com.amazonaws.kms#AliasList", "traits": { @@ -3239,6 +3233,12 @@ "traits": { "smithy.api#documentation": "

A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.

" } + }, + "NextMarker": { + "target": "com.amazonaws.kms#MarkerType", + "traits": { + "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

" + } } } }, @@ -3307,18 +3307,18 @@ "com.amazonaws.kms#ListGrantsResponse": { "type": "structure", "members": { - "Grants": { - "target": "com.amazonaws.kms#GrantList", - "traits": { - "smithy.api#documentation": "

A list of grants.

" - } - }, "NextMarker": { "target": "com.amazonaws.kms#MarkerType", "traits": { "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

" } }, + "Grants": { + "target": "com.amazonaws.kms#GrantList", + "traits": { + "smithy.api#documentation": "

A list of grants.

" + } + }, "Truncated": { "target": "com.amazonaws.kms#BooleanType", "traits": { @@ -3365,10 +3365,10 @@ "com.amazonaws.kms#ListKeyPoliciesRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.kms#LimitType", + "Marker": { + "target": "com.amazonaws.kms#MarkerType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between\n 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

\n

Only one policy can be attached to a key.

" + "smithy.api#documentation": "

Use this parameter in a subsequent request after you receive a response with\n truncated results. Set it to the value of NextMarker from the truncated response\n you just received.

" } }, "KeyId": { @@ -3378,10 +3378,10 @@ "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.kms#MarkerType", + "Limit": { + "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter in a subsequent request after you receive a response with\n truncated results. Set it to the value of NextMarker from the truncated response\n you just received.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between\n 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

\n

Only one policy can be attached to a key.

" } } } @@ -3389,6 +3389,12 @@ "com.amazonaws.kms#ListKeyPoliciesResponse": { "type": "structure", "members": { + "NextMarker": { + "target": "com.amazonaws.kms#MarkerType", + "traits": { + "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

" + } + }, "PolicyNames": { "target": "com.amazonaws.kms#PolicyNameList", "traits": { @@ -3400,12 +3406,6 @@ "traits": { "smithy.api#documentation": "

A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.

" } - }, - "NextMarker": { - "target": "com.amazonaws.kms#MarkerType", - "traits": { - "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

" - } } } }, @@ -3458,18 +3458,18 @@ "com.amazonaws.kms#ListKeysResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.kms#MarkerType", - "traits": { - "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

" - } - }, "Truncated": { "target": "com.amazonaws.kms#BooleanType", "traits": { "smithy.api#documentation": "

A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.

" } }, + "NextMarker": { + "target": "com.amazonaws.kms#MarkerType", + "traits": { + "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

" + } + }, "Keys": { "target": "com.amazonaws.kms#KeyList", "traits": { @@ -3507,6 +3507,12 @@ "com.amazonaws.kms#ListResourceTagsRequest": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.kms#MarkerType", + "traits": { + "smithy.api#documentation": "

Use this parameter in a subsequent request after you receive a response with\n truncated results. Set it to the value of NextMarker from the truncated response\n you just received.

\n

Do not attempt to construct this value. Use only the value of NextMarker from\n the truncated response you just received.

" + } + }, "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { @@ -3519,30 +3525,24 @@ "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\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": {} } - }, - "Marker": { - "target": "com.amazonaws.kms#MarkerType", - "traits": { - "smithy.api#documentation": "

Use this parameter in a subsequent request after you receive a response with\n truncated results. Set it to the value of NextMarker from the truncated response\n you just received.

\n

Do not attempt to construct this value. Use only the value of NextMarker from\n the truncated response you just received.

" - } } } }, "com.amazonaws.kms#ListResourceTagsResponse": { - "type": "structure", - "members": { - "NextMarker": { - "target": "com.amazonaws.kms#MarkerType", - "traits": { - "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

\n

Do not assume or infer any information from this value.

" - } - }, + "type": "structure", + "members": { "Truncated": { "target": "com.amazonaws.kms#BooleanType", "traits": { "smithy.api#documentation": "

A flag that indicates whether there are more items in the list. When this\n value is true, the list in this response is truncated. To get more items, pass the value of\n the NextMarker element in thisresponse to the Marker parameter in a\n subsequent request.

" } }, + "NextMarker": { + "target": "com.amazonaws.kms#MarkerType", + "traits": { + "smithy.api#documentation": "

When Truncated is true, this element is present and contains the\n value to use for the Marker parameter in a subsequent request.

\n

Do not assume or infer any information from this value.

" + } + }, "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { @@ -3583,18 +3583,18 @@ "com.amazonaws.kms#ListRetirableGrantsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.kms#LimitType", - "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" - } - }, "Marker": { "target": "com.amazonaws.kms#MarkerType", "traits": { "smithy.api#documentation": "

Use this parameter in a subsequent request after you receive a response with\n truncated results. Set it to the value of NextMarker from the truncated response\n you just received.

" } }, + "Limit": { + "target": "com.amazonaws.kms#LimitType", + "traits": { + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" + } + }, "RetiringPrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { @@ -3800,17 +3800,17 @@ "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

\n \n

Use this parameter only when you intend to prevent the principal that is making the\n request from making a subsequent PutKeyPolicy request on the CMK.

\n

The default value is false.

" } }, - "Policy": { - "target": "com.amazonaws.kms#PolicyType", + "PolicyName": { + "target": "com.amazonaws.kms#PolicyNameType", "traits": { - "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

The key policy must meet the following criteria:

\n \n

The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.

", + "smithy.api#documentation": "

The name of the key policy. The only valid value is default.

", "smithy.api#required": {} } }, - "PolicyName": { - "target": "com.amazonaws.kms#PolicyNameType", + "Policy": { + "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "

The name of the key policy. The only valid value is default.

", + "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

The key policy must meet the following criteria:

\n \n

The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.

", "smithy.api#required": {} } } @@ -3863,29 +3863,24 @@ "com.amazonaws.kms#ReEncryptRequest": { "type": "structure", "members": { - "CiphertextBlob": { - "target": "com.amazonaws.kms#CiphertextType", - "traits": { - "smithy.api#documentation": "

Ciphertext of the data to reencrypt.

", - "smithy.api#required": {} - } - }, - "DestinationEncryptionContext": { - "target": "com.amazonaws.kms#EncryptionContextType", + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination CMK is a symmetric\n CMK. The standard ciphertext format for asymmetric CMKs does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } }, - "SourceKeyId": { + "DestinationKeyId": { "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": "

A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or\n asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find the\n KeyUsage value of a CMK, use the DescribeKey\n 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": {} } }, - "GrantTokens": { - "target": "com.amazonaws.kms#GrantTokenList", + "CiphertextBlob": { + "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Ciphertext of the data to reencrypt.

", + "smithy.api#required": {} } }, "DestinationEncryptionAlgorithm": { @@ -3906,11 +3901,16 @@ "smithy.api#documentation": "

Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it\n is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm\n used for symmetric CMKs.

\n

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a\n different algorithm, the decrypt attempt fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric\n CMK.

" } }, - "DestinationKeyId": { + "DestinationEncryptionContext": { + "target": "com.amazonaws.kms#EncryptionContextType", + "traits": { + "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination CMK is a symmetric\n CMK. The standard ciphertext format for asymmetric CMKs does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + } + }, + "SourceKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or\n asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find the\n KeyUsage value of a CMK, use the DescribeKey\n 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": {} + "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.

" } } } @@ -3918,6 +3918,12 @@ "com.amazonaws.kms#ReEncryptResponse": { "type": "structure", "members": { + "DestinationEncryptionAlgorithm": { + "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The encryption algorithm that was used to reencrypt the data.

" + } + }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { @@ -3930,22 +3936,16 @@ "smithy.api#documentation": "

Unique identifier of the CMK used to originally encrypt the data.

" } }, - "CiphertextBlob": { - "target": "com.amazonaws.kms#CiphertextType", - "traits": { - "smithy.api#documentation": "

The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" - } - }, - "DestinationEncryptionAlgorithm": { + "SourceEncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

The encryption algorithm that was used to reencrypt the data.

" + "smithy.api#documentation": "

The encryption algorithm that was used to decrypt the ciphertext before it was\n reencrypted.

" } }, - "SourceEncryptionAlgorithm": { - "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", + "CiphertextBlob": { + "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The encryption algorithm that was used to decrypt the ciphertext before it was\n reencrypted.

" + "smithy.api#documentation": "

The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } } } @@ -3985,6 +3985,12 @@ "com.amazonaws.kms#RetireGrantRequest": { "type": "structure", "members": { + "GrantId": { + "target": "com.amazonaws.kms#GrantIdType", + "traits": { + "smithy.api#documentation": "

Unique identifier of the grant to retire. The grant ID is returned in the response to a\n CreateGrant operation.

\n " + } + }, "GrantToken": { "target": "com.amazonaws.kms#GrantTokenType", "traits": { @@ -3996,12 +4002,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK associated with the grant.

\n

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

" } - }, - "GrantId": { - "target": "com.amazonaws.kms#GrantIdType", - "traits": { - "smithy.api#documentation": "

Unique identifier of the grant to retire. The grant ID is returned in the response to a\n CreateGrant operation.

\n " - } } } }, @@ -4085,18 +4085,18 @@ "com.amazonaws.kms#ScheduleKeyDeletionRequest": { "type": "structure", "members": { + "PendingWindowInDays": { + "target": "com.amazonaws.kms#PendingWindowInDaysType", + "traits": { + "smithy.api#documentation": "

The waiting period, specified in number of days. After the waiting period ends, AWS KMS\n deletes the customer master key (CMK).

\n

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.

" + } + }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { "smithy.api#documentation": "

The unique identifier of the customer master key (CMK) to delete.

\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": {} } - }, - "PendingWindowInDays": { - "target": "com.amazonaws.kms#PendingWindowInDaysType", - "traits": { - "smithy.api#documentation": "

The waiting period, specified in number of days. After the waiting period ends, AWS KMS\n deletes the customer master key (CMK).

\n

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.

" - } } } }, @@ -4158,18 +4158,17 @@ "com.amazonaws.kms#SignRequest": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "Message": { + "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the\n message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find\n the KeyUsage of a CMK, use the DescribeKey operation.

\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.

", + "smithy.api#documentation": "

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a\n larger message, provide the message digest.

\n

If you provide a message, AWS KMS generates a hash digest of the message and then signs\n it.

", "smithy.api#required": {} } }, - "SigningAlgorithm": { - "target": "com.amazonaws.kms#SigningAlgorithmSpec", + "MessageType": { + "target": "com.amazonaws.kms#MessageType", "traits": { - "smithy.api#documentation": "

Specifies the signing algorithm to use when signing the message.

\n

Choose an algorithm that is compatible with the type and size of the specified asymmetric\n CMK.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Tells AWS KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

" } }, "GrantTokens": { @@ -4178,16 +4177,17 @@ "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } }, - "MessageType": { - "target": "com.amazonaws.kms#MessageType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Tells AWS KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

" + "smithy.api#documentation": "

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the\n message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find\n the KeyUsage of a CMK, use the DescribeKey operation.

\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.

", + "smithy.api#required": {} } }, - "Message": { - "target": "com.amazonaws.kms#PlaintextType", + "SigningAlgorithm": { + "target": "com.amazonaws.kms#SigningAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a\n larger message, provide the message digest.

\n

If you provide a message, AWS KMS generates a hash digest of the message and then signs\n it.

", + "smithy.api#documentation": "

Specifies the signing algorithm to use when signing the message.

\n

Choose an algorithm that is compatible with the type and size of the specified asymmetric\n CMK.

", "smithy.api#required": {} } } @@ -4196,10 +4196,10 @@ "com.amazonaws.kms#SignResponse": { "type": "structure", "members": { - "SigningAlgorithm": { - "target": "com.amazonaws.kms#SigningAlgorithmSpec", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The signing algorithm that was used to sign the message.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the\n message.

" } }, "Signature": { @@ -4208,10 +4208,10 @@ "smithy.api#documentation": "

The cryptographic signature that was generated for the message.

\n \n

When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "SigningAlgorithm": { + "target": "com.amazonaws.kms#SigningAlgorithmSpec", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the\n message.

" + "smithy.api#documentation": "

The signing algorithm that was used to sign the message.

" } } } @@ -4353,17 +4353,17 @@ "com.amazonaws.kms#TagResourceRequest": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "Tags": { + "target": "com.amazonaws.kms#TagList", "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": "

One or more tags. Each tag consists of a tag key and a tag value.

", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.kms#TagList", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

One or more tags. Each tag consists of a tag key and a tag value.

", + "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#required": {} } } @@ -4526,7 +4526,7 @@ "sdkId": "KMS", "arnNamespace": "kms", "cloudFormationName": "KMS", - "cloudTrailEventSource": "trent.amazon.com" + "cloudTrailEventSource": "kms.amazonaws.com" }, "aws.auth#sigv4": { "name": "kms" @@ -4590,17 +4590,17 @@ "com.amazonaws.kms#UntagResourceRequest": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "TagKeys": { + "target": "com.amazonaws.kms#TagKeyList", "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": "

One or more tag keys. Specify only the tag keys, not the tag values.

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.kms#TagKeyList", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

One or more tag keys. Specify only the tag keys, not the tag values.

", + "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#required": {} } } @@ -4635,17 +4635,17 @@ "com.amazonaws.kms#UpdateAliasRequest": { "type": "structure", "members": { - "TargetKeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "AliasName": { + "target": "com.amazonaws.kms#AliasNameType", "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 alias that is changing its CMK. This value must begin with\n alias/ followed by the alias name, such as alias/ExampleAlias. You\n cannot use UpdateAlias to change the alias name.

", "smithy.api#required": {} } }, - "AliasName": { - "target": "com.amazonaws.kms#AliasNameType", + "TargetKeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the alias that is changing its CMK. This value must begin with\n alias/ followed by the alias name, such as alias/ExampleAlias. You\n cannot use UpdateAlias to change the alias name.

", + "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#required": {} } } @@ -4692,10 +4692,10 @@ "com.amazonaws.kms#UpdateCustomKeyStoreRequest": { "type": "structure", "members": { - "CloudHsmClusterId": { - "target": "com.amazonaws.kms#CloudHsmClusterIdType", + "KeyStorePassword": { + "target": "com.amazonaws.kms#KeyStorePasswordType", "traits": { - "smithy.api#documentation": "

Associates the custom key store with a related AWS CloudHSM cluster.

\n

Enter the cluster ID of the cluster that you used to create the custom key store or a\n cluster that shares a backup history and has the same cluster certificate as the original\n cluster. You cannot use this parameter to associate a custom key store with an unrelated\n cluster. In addition, the replacement cluster must fulfill the requirements for\n a cluster associated with a custom key store. To view the cluster certificate of a cluster,\n use the DescribeClusters operation.

" + "smithy.api#documentation": "

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM\n cluster that is associated with the custom key store.

\n

This parameter tells AWS KMS the current password of the kmsuser crypto user\n (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

" } }, "CustomKeyStoreId": { @@ -4711,10 +4711,10 @@ "smithy.api#documentation": "

Changes the friendly name of the custom key store to the value that you specify. The\n custom key store name must be unique in the AWS account.

" } }, - "KeyStorePassword": { - "target": "com.amazonaws.kms#KeyStorePasswordType", + "CloudHsmClusterId": { + "target": "com.amazonaws.kms#CloudHsmClusterIdType", "traits": { - "smithy.api#documentation": "

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM\n cluster that is associated with the custom key store.

\n

This parameter tells AWS KMS the current password of the kmsuser crypto user\n (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

" + "smithy.api#documentation": "

Associates the custom key store with a related AWS CloudHSM cluster.

\n

Enter the cluster ID of the cluster that you used to create the custom key store or a\n cluster that shares a backup history and has the same cluster certificate as the original\n cluster. You cannot use this parameter to associate a custom key store with an unrelated\n cluster. In addition, the replacement cluster must fulfill the requirements for\n a cluster associated with a custom key store. To view the cluster certificate of a cluster,\n use the DescribeClusters operation.

" } } } @@ -4752,17 +4752,17 @@ "com.amazonaws.kms#UpdateKeyDescriptionRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.kms#DescriptionType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

New description for the CMK.

", + "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\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": {} } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "Description": { + "target": "com.amazonaws.kms#DescriptionType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\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": "

New description for the CMK.

", "smithy.api#required": {} } } @@ -4812,17 +4812,16 @@ "com.amazonaws.kms#VerifyRequest": { "type": "structure", "members": { - "MessageType": { - "target": "com.amazonaws.kms#MessageType", + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

Tells AWS KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

\n \n

Use the DIGEST value only when the value of the Message\n parameter is a message digest. If you use the DIGEST value with a raw message,\n the security of the verification operation can be compromised.

\n " + "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" } }, - "Message": { - "target": "com.amazonaws.kms#PlaintextType", + "MessageType": { + "target": "com.amazonaws.kms#MessageType", "traits": { - "smithy.api#documentation": "

Specifies the message that was signed. You can submit a raw message of up to 4096 bytes,\n or a hash digest of the message. If you submit a digest, use the MessageType\n parameter with a value of DIGEST.

\n

If the message specified here is different from the message that was signed, the signature\n verification fails. A message and its hash digest are considered to be the same\n message.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Tells AWS KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

\n \n

Use the DIGEST value only when the value of the Message\n parameter is a message digest. If you use the DIGEST value with a raw message,\n the security of the verification operation can be compromised.

\n " } }, "SigningAlgorithm": { @@ -4832,23 +4831,24 @@ "smithy.api#required": {} } }, - "GrantTokens": { - "target": "com.amazonaws.kms#GrantTokenList", + "Signature": { + "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The signature that the Sign operation generated.

", + "smithy.api#required": {} } }, - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", + "Message": { + "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

Identifies the asymmetric CMK that will be used to verify the signature. This must be the\n same CMK that was used to generate the signature. If you specify a different CMK, the\n signature verification fails.

\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.

", + "smithy.api#documentation": "

Specifies the message that was signed. You can submit a raw message of up to 4096 bytes,\n or a hash digest of the message. If you submit a digest, use the MessageType\n parameter with a value of DIGEST.

\n

If the message specified here is different from the message that was signed, the signature\n verification fails. A message and its hash digest are considered to be the same\n message.

", "smithy.api#required": {} } }, - "Signature": { - "target": "com.amazonaws.kms#CiphertextType", + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The signature that the Sign operation generated.

", + "smithy.api#documentation": "

Identifies the asymmetric CMK that will be used to verify the signature. This must be the\n same CMK that was used to generate the signature. If you specify a different CMK, the\n signature verification fails.

\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.

", "smithy.api#required": {} } } @@ -4857,12 +4857,6 @@ "com.amazonaws.kms#VerifyResponse": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.kms#KeyIdType", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

" - } - }, "SigningAlgorithm": { "target": "com.amazonaws.kms#SigningAlgorithmSpec", "traits": { @@ -4874,6 +4868,12 @@ "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether the signature was verified. A value of\n True indicates that the Signature was produced by signing the\n Message with the specified KeyID and\n SigningAlgorithm. If the signature is not verified, the Verify\n operation fails with a KMSInvalidSignatureException exception.

" } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/lakeformation.2017-03-31.json b/codegen/sdk-codegen/aws-models/lakeformation.2017-03-31.json index b383b2e7e12f..9547cd2a0db6 100644 --- a/codegen/sdk-codegen/aws-models/lakeformation.2017-03-31.json +++ b/codegen/sdk-codegen/aws-models/lakeformation.2017-03-31.json @@ -181,10 +181,11 @@ "com.amazonaws.lakeformation#BatchPermissionsRequestEntry": { "type": "structure", "members": { - "PermissionsWithGrantOption": { - "target": "com.amazonaws.lakeformation#PermissionList", + "Id": { + "target": "com.amazonaws.lakeformation#Identifier", "traits": { - "smithy.api#documentation": "

Indicates if the option to pass permissions is granted.

" + "smithy.api#documentation": "

A unique identifier for the batch permissions request entry.

", + "smithy.api#required": {} } }, "Principal": { @@ -193,11 +194,10 @@ "smithy.api#documentation": "

The principal to be granted a permission.

" } }, - "Id": { - "target": "com.amazonaws.lakeformation#Identifier", + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", "traits": { - "smithy.api#documentation": "

A unique identifier for the batch permissions request entry.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The permissions to be granted.

" } }, "Resource": { @@ -206,10 +206,10 @@ "smithy.api#documentation": "

The resource to which the principal is to be granted a permission.

" } }, - "Permissions": { + "PermissionsWithGrantOption": { "target": "com.amazonaws.lakeformation#PermissionList", "traits": { - "smithy.api#documentation": "

The permissions to be granted.

" + "smithy.api#documentation": "

Indicates if the option to pass permissions is granted.

" } } }, @@ -448,17 +448,17 @@ "smithy.api#documentation": "

A structure representing a list of up to three principal permissions entries for default create database permissions.

" } }, - "DataLakeAdmins": { - "target": "com.amazonaws.lakeformation#DataLakePrincipalList", - "traits": { - "smithy.api#documentation": "

A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.

" - } - }, "TrustedResourceOwners": { "target": "com.amazonaws.lakeformation#TrustedResourceOwners", "traits": { "smithy.api#documentation": "

A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's AWS CloudTrail log.

\n\t\n\t

You may want to specify this property when you are in a high-trust boundary, such as the same team or company.

" } + }, + "DataLakeAdmins": { + "target": "com.amazonaws.lakeformation#DataLakePrincipalList", + "traits": { + "smithy.api#documentation": "

A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.

" + } } }, "traits": { @@ -468,18 +468,18 @@ "com.amazonaws.lakeformation#DataLocationResource": { "type": "structure", "members": { - "CatalogId": { - "target": "com.amazonaws.lakeformation#CatalogIdString", - "traits": { - "smithy.api#documentation": "

The identifier for the Data Catalog where the location is registered with AWS Lake Formation. By default, it is the account ID of the caller.

" - } - }, "ResourceArn": { "target": "com.amazonaws.lakeformation#ResourceArnString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

", "smithy.api#required": {} } + }, + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The identifier for the Data Catalog where the location is registered with AWS Lake Formation. By default, it is the account ID of the caller.

" + } } }, "traits": { @@ -608,6 +608,20 @@ "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" } }, + "com.amazonaws.lakeformation#DetailsMap": { + "type": "structure", + "members": { + "ResourceShare": { + "target": "com.amazonaws.lakeformation#ResourceShareList", + "traits": { + "smithy.api#documentation": "

A share resource ARN for a catalog resource shared through AWS Resource Access Manager (AWS RAM).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure containing the additional details to be returned in the AdditionalDetails attribute of PrincipalResourcePermissions.

\n \n

If a catalog resource is shared through AWS Resource Access Manager (AWS RAM), then there will exist a corresponding RAM share resource ARN.

" + } + }, "com.amazonaws.lakeformation#EntityNotFoundException": { "type": "structure", "members": { @@ -665,18 +679,18 @@ "com.amazonaws.lakeformation#FilterCondition": { "type": "structure", "members": { - "Field": { - "target": "com.amazonaws.lakeformation#FieldNameString", - "traits": { - "smithy.api#documentation": "

The field to filter in the filter condition.

" - } - }, "ComparisonOperator": { "target": "com.amazonaws.lakeformation#ComparisonOperator", "traits": { "smithy.api#documentation": "

The comparison operator used in the filter condition.

" } }, + "Field": { + "target": "com.amazonaws.lakeformation#FieldNameString", + "traits": { + "smithy.api#documentation": "

The field to filter in the filter condition.

" + } + }, "StringValueList": { "target": "com.amazonaws.lakeformation#StringValueList", "traits": { @@ -809,17 +823,17 @@ "com.amazonaws.lakeformation#GetEffectivePermissionsForPathResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.lakeformation#PrincipalResourcePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of the permissions for the specified table or database resource located at the path in Amazon S3.

" - } - }, "NextToken": { "target": "com.amazonaws.lakeformation#Token", "traits": { "smithy.api#documentation": "

A continuation token, if this is not the first call to retrieve this list.

" } + }, + "Permissions": { + "target": "com.amazonaws.lakeformation#PrincipalResourcePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of the permissions for the specified table or database resource located at the path in Amazon S3.

" + } } } }, @@ -856,10 +870,10 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.lakeformation#CatalogIdString", + "PermissionsWithGrantOption": { + "target": "com.amazonaws.lakeformation#PermissionList", "traits": { - "smithy.api#documentation": "

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + "smithy.api#documentation": "

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

" } }, "Principal": { @@ -869,10 +883,10 @@ "smithy.api#required": {} } }, - "PermissionsWithGrantOption": { - "target": "com.amazonaws.lakeformation#PermissionList", + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

" + "smithy.api#documentation": "

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" } }, "Resource": { @@ -973,6 +987,12 @@ "smithy.api#documentation": "

A continuation token, if this is not the first call to retrieve this list.

" } }, + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "traits": { + "smithy.api#documentation": "

Specifies a principal to filter the permissions returned.

" + } + }, "ResourceType": { "target": "com.amazonaws.lakeformation#DataLakeResourceType", "traits": { @@ -985,12 +1005,6 @@ "smithy.api#documentation": "

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" } }, - "Principal": { - "target": "com.amazonaws.lakeformation#DataLakePrincipal", - "traits": { - "smithy.api#documentation": "

Specifies a principal to filter the permissions returned.

" - } - }, "MaxResults": { "target": "com.amazonaws.lakeformation#PageSize", "traits": { @@ -1059,34 +1073,34 @@ "smithy.api#documentation": "

The maximum number of resource results.

" } }, - "NextToken": { - "target": "com.amazonaws.lakeformation#Token", - "traits": { - "smithy.api#documentation": "

A continuation token, if this is not the first call to retrieve these resources.

" - } - }, "FilterConditionList": { "target": "com.amazonaws.lakeformation#FilterConditionList", "traits": { "smithy.api#documentation": "

Any applicable row-level and/or column-level filtering conditions for the resources.

" } + }, + "NextToken": { + "target": "com.amazonaws.lakeformation#Token", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is not the first call to retrieve these resources.

" + } } } }, "com.amazonaws.lakeformation#ListResourcesResponse": { "type": "structure", "members": { - "ResourceInfoList": { - "target": "com.amazonaws.lakeformation#ResourceInfoList", - "traits": { - "smithy.api#documentation": "

A summary of the data lake resources.

" - } - }, "NextToken": { "target": "com.amazonaws.lakeformation#Token", "traits": { "smithy.api#documentation": "

A continuation token, if this is not the first call to retrieve these resources.

" } + }, + "ResourceInfoList": { + "target": "com.amazonaws.lakeformation#ResourceInfoList", + "traits": { + "smithy.api#documentation": "

A summary of the data lake resources.

" + } } } }, @@ -1216,22 +1230,16 @@ "com.amazonaws.lakeformation#PrincipalResourcePermissions": { "type": "structure", "members": { - "Resource": { - "target": "com.amazonaws.lakeformation#Resource", - "traits": { - "smithy.api#documentation": "

The resource where permissions are to be granted or revoked.

" - } - }, - "Permissions": { + "PermissionsWithGrantOption": { "target": "com.amazonaws.lakeformation#PermissionList", "traits": { - "smithy.api#documentation": "

The permissions to be granted or revoked on the resource.

" + "smithy.api#documentation": "

Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).

" } }, - "PermissionsWithGrantOption": { - "target": "com.amazonaws.lakeformation#PermissionList", + "AdditionalDetails": { + "target": "com.amazonaws.lakeformation#DetailsMap", "traits": { - "smithy.api#documentation": "

Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).

" + "smithy.api#documentation": "

This attribute can be used to return any additional details of PrincipalResourcePermissions. Currently returns only as a RAM share resource ARN.

" } }, "Principal": { @@ -1239,6 +1247,18 @@ "traits": { "smithy.api#documentation": "

The Data Lake principal to be granted or revoked permissions.

" } + }, + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", + "traits": { + "smithy.api#documentation": "

The permissions to be granted or revoked on the resource.

" + } + }, + "Resource": { + "target": "com.amazonaws.lakeformation#Resource", + "traits": { + "smithy.api#documentation": "

The resource where permissions are to be granted or revoked.

" + } } }, "traits": { @@ -1293,6 +1313,9 @@ "type": "structure", "members": {} }, + "com.amazonaws.lakeformation#RAMResourceShareArn": { + "type": "string" + }, "com.amazonaws.lakeformation#RegisterResource": { "type": "operation", "input": { @@ -1350,22 +1373,16 @@ "com.amazonaws.lakeformation#Resource": { "type": "structure", "members": { - "TableWithColumns": { - "target": "com.amazonaws.lakeformation#TableWithColumnsResource", - "traits": { - "smithy.api#documentation": "

The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.

" - } - }, "DataLocation": { "target": "com.amazonaws.lakeformation#DataLocationResource", "traits": { "smithy.api#documentation": "

The location of an Amazon S3 path where permissions are granted or revoked.

" } }, - "Table": { - "target": "com.amazonaws.lakeformation#TableResource", + "TableWithColumns": { + "target": "com.amazonaws.lakeformation#TableWithColumnsResource", "traits": { - "smithy.api#documentation": "

The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

" + "smithy.api#documentation": "

The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.

" } }, "Database": { @@ -1374,6 +1391,12 @@ "smithy.api#documentation": "

The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal.

" } }, + "Table": { + "target": "com.amazonaws.lakeformation#TableResource", + "traits": { + "smithy.api#documentation": "

The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

" + } + }, "Catalog": { "target": "com.amazonaws.lakeformation#CatalogResource", "traits": { @@ -1391,18 +1414,18 @@ "com.amazonaws.lakeformation#ResourceInfo": { "type": "structure", "members": { - "RoleArn": { - "target": "com.amazonaws.lakeformation#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role that registered a resource.

" - } - }, "LastModified": { "target": "com.amazonaws.lakeformation#LastModifiedTimestamp", "traits": { "smithy.api#documentation": "

The date and time the resource was last modified.

" } }, + "RoleArn": { + "target": "com.amazonaws.lakeformation#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The IAM role that registered a resource.

" + } + }, "ResourceArn": { "target": "com.amazonaws.lakeformation#ResourceArnString", "traits": { @@ -1420,6 +1443,12 @@ "target": "com.amazonaws.lakeformation#ResourceInfo" } }, + "com.amazonaws.lakeformation#ResourceShareList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#RAMResourceShareArn" + } + }, "com.amazonaws.lakeformation#RevokePermissions": { "type": "operation", "input": { @@ -1452,30 +1481,30 @@ "smithy.api#documentation": "

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" } }, - "Principal": { - "target": "com.amazonaws.lakeformation#DataLakePrincipal", + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", "traits": { - "smithy.api#documentation": "

The principal to be revoked permissions on the resource.

", + "smithy.api#documentation": "

The permissions revoked to the principal on the resource. For information about permissions, see Security\n and Access Control to Metadata and Data.

", "smithy.api#required": {} } }, - "PermissionsWithGrantOption": { - "target": "com.amazonaws.lakeformation#PermissionList", + "Resource": { + "target": "com.amazonaws.lakeformation#Resource", "traits": { - "smithy.api#documentation": "

Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.

" + "smithy.api#documentation": "

The resource to which permissions are to be revoked.

", + "smithy.api#required": {} } }, - "Permissions": { + "PermissionsWithGrantOption": { "target": "com.amazonaws.lakeformation#PermissionList", "traits": { - "smithy.api#documentation": "

The permissions revoked to the principal on the resource. For information about permissions, see Security\n and Access Control to Metadata and Data.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.

" } }, - "Resource": { - "target": "com.amazonaws.lakeformation#Resource", + "Principal": { + "target": "com.amazonaws.lakeformation#DataLakePrincipal", "traits": { - "smithy.api#documentation": "

The resource to which permissions are to be revoked.

", + "smithy.api#documentation": "

The principal to be revoked permissions on the resource.

", "smithy.api#required": {} } } @@ -1497,29 +1526,29 @@ "com.amazonaws.lakeformation#TableResource": { "type": "structure", "members": { - "TableWildcard": { - "target": "com.amazonaws.lakeformation#TableWildcard", + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", "traits": { - "smithy.api#documentation": "

A wildcard object representing every table under a database.

\n\n

At least one of TableResource$Name or TableResource$TableWildcard is required.

" + "smithy.api#documentation": "

The identifier for the Data Catalog. By default, it is the account ID of the caller.

" } }, - "DatabaseName": { + "Name": { "target": "com.amazonaws.lakeformation#NameString", "traits": { - "smithy.api#documentation": "

The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the table.

" } }, - "Name": { + "DatabaseName": { "target": "com.amazonaws.lakeformation#NameString", "traits": { - "smithy.api#documentation": "

The name of the table.

" + "smithy.api#documentation": "

The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

", + "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.lakeformation#CatalogIdString", + "TableWildcard": { + "target": "com.amazonaws.lakeformation#TableWildcard", "traits": { - "smithy.api#documentation": "

The identifier for the Data Catalog. By default, it is the account ID of the caller.

" + "smithy.api#documentation": "

A wildcard object representing every table under a database.

\n\n

At least one of TableResource$Name or TableResource$TableWildcard is required.

" } } }, @@ -1537,6 +1566,12 @@ "com.amazonaws.lakeformation#TableWithColumnsResource": { "type": "structure", "members": { + "CatalogId": { + "target": "com.amazonaws.lakeformation#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The identifier for the Data Catalog. By default, it is the account ID of the caller.

" + } + }, "DatabaseName": { "target": "com.amazonaws.lakeformation#NameString", "traits": { @@ -1550,12 +1585,6 @@ "smithy.api#documentation": "

The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

" } }, - "ColumnWildcard": { - "target": "com.amazonaws.lakeformation#ColumnWildcard", - "traits": { - "smithy.api#documentation": "

A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

" - } - }, "Name": { "target": "com.amazonaws.lakeformation#NameString", "traits": { @@ -1563,10 +1592,10 @@ "smithy.api#required": {} } }, - "CatalogId": { - "target": "com.amazonaws.lakeformation#CatalogIdString", + "ColumnWildcard": { + "target": "com.amazonaws.lakeformation#ColumnWildcard", "traits": { - "smithy.api#documentation": "

The identifier for the Data Catalog. By default, it is the account ID of the caller.

" + "smithy.api#documentation": "

A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

" } } }, 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 8b6f8548fad8..cf15b64290c1 100644 --- a/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json +++ b/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json @@ -186,7 +186,7 @@ "sdkId": "Lambda", "arnNamespace": "lambda", "cloudFormationName": "Lambda", - "cloudTrailEventSource": "awsgirapi.amazonaws.com" + "cloudTrailEventSource": "lambda.amazonaws.com" }, "aws.auth#sigv4": { "name": "lambda" @@ -199,18 +199,6 @@ "com.amazonaws.lambda#AccountLimit": { "type": "structure", "members": { - "ConcurrentExecutions": { - "target": "com.amazonaws.lambda#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of simultaneous function executions.

" - } - }, - "TotalCodeSize": { - "target": "com.amazonaws.lambda#Long", - "traits": { - "smithy.api#documentation": "

The amount of storage space that you can use for all deployment packages and layer archives.

" - } - }, "CodeSizeZipped": { "target": "com.amazonaws.lambda#Long", "traits": { @@ -223,11 +211,23 @@ "smithy.api#documentation": "

The maximum number of simultaneous function executions, minus the capacity that's reserved for individual\n functions with PutFunctionConcurrency.

" } }, + "TotalCodeSize": { + "target": "com.amazonaws.lambda#Long", + "traits": { + "smithy.api#documentation": "

The amount of storage space that you can use for all deployment packages and layer archives.

" + } + }, "CodeSizeUnzipped": { "target": "com.amazonaws.lambda#Long", "traits": { "smithy.api#documentation": "

The maximum size of a function's deployment package and layers when they're extracted.

" } + }, + "ConcurrentExecutions": { + "target": "com.amazonaws.lambda#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of simultaneous function executions.

" + } } }, "traits": { @@ -237,16 +237,16 @@ "com.amazonaws.lambda#AccountUsage": { "type": "structure", "members": { - "FunctionCount": { + "TotalCodeSize": { "target": "com.amazonaws.lambda#Long", "traits": { - "smithy.api#documentation": "

The number of Lambda functions.

" + "smithy.api#documentation": "

The amount of storage space, in bytes, that's being used by deployment packages and layer archives.

" } }, - "TotalCodeSize": { + "FunctionCount": { "target": "com.amazonaws.lambda#Long", "traits": { - "smithy.api#documentation": "

The amount of storage space, in bytes, that's being used by deployment packages and layer archives.

" + "smithy.api#documentation": "

The number of Lambda functions.

" } } }, @@ -303,10 +303,17 @@ "com.amazonaws.lambda#AddLayerVersionPermissionRequest": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.lambda#LayerPermissionAllowedAction", + "RevisionId": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The API action that grants access to the layer. For example, lambda:GetLayerVersion.

", + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#httpQuery": "RevisionId" + } + }, + "Principal": { + "target": "com.amazonaws.lambda#LayerPermissionAllowedPrincipal", + "traits": { + "smithy.api#documentation": "

An account ID, or * to grant permission to all AWS accounts.

", "smithy.api#required": {} } }, @@ -317,18 +324,18 @@ "smithy.api#required": {} } }, - "Principal": { - "target": "com.amazonaws.lambda#LayerPermissionAllowedPrincipal", + "OrganizationId": { + "target": "com.amazonaws.lambda#OrganizationId", "traits": { - "smithy.api#documentation": "

An account ID, or * to grant permission to all AWS accounts.

", - "smithy.api#required": {} + "smithy.api#documentation": "

With the principal set to *, grant permission to all accounts in the specified\n organization.

" } }, - "RevisionId": { - "target": "com.amazonaws.lambda#String", + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", "traits": { - "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", - "smithy.api#httpQuery": "RevisionId" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "VersionNumber": { @@ -339,35 +346,28 @@ "smithy.api#required": {} } }, - "LayerName": { - "target": "com.amazonaws.lambda#LayerName", + "Action": { + "target": "com.amazonaws.lambda#LayerPermissionAllowedAction", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The API action that grants access to the layer. For example, lambda:GetLayerVersion.

", "smithy.api#required": {} } - }, - "OrganizationId": { - "target": "com.amazonaws.lambda#OrganizationId", - "traits": { - "smithy.api#documentation": "

With the principal set to *, grant permission to all accounts in the specified\n organization.

" - } } } }, "com.amazonaws.lambda#AddLayerVersionPermissionResponse": { "type": "structure", "members": { - "RevisionId": { + "Statement": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" + "smithy.api#documentation": "

The permission statement.

" } }, - "Statement": { + "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The permission statement.

" + "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" } } } @@ -415,6 +415,19 @@ "com.amazonaws.lambda#AddPermissionRequest": { "type": "structure", "members": { + "EventSourceToken": { + "target": "com.amazonaws.lambda#EventSourceToken", + "traits": { + "smithy.api#documentation": "

For Alexa Smart Home functions, a token that must be supplied by the invoker.

" + } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to add permissions to a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + }, "Action": { "target": "com.amazonaws.lambda#Action", "traits": { @@ -441,25 +454,10 @@ "smithy.api#required": {} } }, - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", - "traits": { - "smithy.api#documentation": "

The name of the Lambda function, version, or alias.

\n

\n Name formats\n

\n \n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "EventSourceToken": { - "target": "com.amazonaws.lambda#EventSourceToken", - "traits": { - "smithy.api#documentation": "

For Alexa Smart Home functions, a token that must be supplied by the invoker.

" - } - }, - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", + "RevisionId": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Specify a version or alias to add permissions to a published version of the function.

", - "smithy.api#httpQuery": "Qualifier" + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

" } }, "Principal": { @@ -469,10 +467,12 @@ "smithy.api#required": {} } }, - "RevisionId": { - "target": "com.amazonaws.lambda#String", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

" + "smithy.api#documentation": "

The name of the Lambda function, version, or alias.

\n

\n Name formats\n

\n \n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -520,22 +520,22 @@ "com.amazonaws.lambda#AliasConfiguration": { "type": "structure", "members": { - "RoutingConfig": { - "target": "com.amazonaws.lambda#AliasRoutingConfiguration", + "AliasArn": { + "target": "com.amazonaws.lambda#FunctionArn", "traits": { - "smithy.api#documentation": "

The routing\n configuration of the alias.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias.

" } }, - "Name": { - "target": "com.amazonaws.lambda#Alias", + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", "traits": { - "smithy.api#documentation": "

The name of the alias.

" + "smithy.api#documentation": "

The function version that the alias invokes.

" } }, - "AliasArn": { - "target": "com.amazonaws.lambda#FunctionArn", + "Description": { + "target": "com.amazonaws.lambda#Description", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias.

" + "smithy.api#documentation": "

A description of the alias.

" } }, "RevisionId": { @@ -544,16 +544,16 @@ "smithy.api#documentation": "

A unique identifier that changes when you update the alias.

" } }, - "FunctionVersion": { - "target": "com.amazonaws.lambda#Version", + "RoutingConfig": { + "target": "com.amazonaws.lambda#AliasRoutingConfiguration", "traits": { - "smithy.api#documentation": "

The function version that the alias invokes.

" + "smithy.api#documentation": "

The routing\n configuration of the alias.

" } }, - "Description": { - "target": "com.amazonaws.lambda#Description", + "Name": { + "target": "com.amazonaws.lambda#Alias", "traits": { - "smithy.api#documentation": "

A description of the alias.

" + "smithy.api#documentation": "

The name of the alias.

" } } }, @@ -621,14 +621,14 @@ "com.amazonaws.lambda#CodeStorageExceededException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.lambda#String" - }, "Type": { "target": "com.amazonaws.lambda#String", "traits": { "smithy.api#documentation": "

The exception type.

" } + }, + "message": { + "target": "com.amazonaws.lambda#String" } }, "traits": { @@ -697,12 +697,25 @@ "com.amazonaws.lambda#CreateAliasRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.lambda#Alias", + "traits": { + "smithy.api#documentation": "

The name of the alias.

", + "smithy.api#required": {} + } + }, "RoutingConfig": { "target": "com.amazonaws.lambda#AliasRoutingConfiguration", "traits": { "smithy.api#documentation": "

The routing\n configuration of the alias.

" } }, + "Description": { + "target": "com.amazonaws.lambda#Description", + "traits": { + "smithy.api#documentation": "

A description of the alias.

" + } + }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { @@ -711,25 +724,12 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.lambda#Description", - "traits": { - "smithy.api#documentation": "

A description of the alias.

" - } - }, "FunctionVersion": { "target": "com.amazonaws.lambda#Version", "traits": { "smithy.api#documentation": "

The function version that the alias invokes.

", "smithy.api#required": {} } - }, - "Name": { - "target": "com.amazonaws.lambda#Alias", - "traits": { - "smithy.api#documentation": "

The name of the alias.

", - "smithy.api#required": {} - } } } }, @@ -759,7 +759,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", @@ -773,43 +773,32 @@ "Enabled": { "target": "com.amazonaws.lambda#Enabled", "traits": { - "smithy.api#documentation": "

Disables the event source mapping to pause polling and invocation.

" - } - }, - "DestinationConfig": { - "target": "com.amazonaws.lambda#DestinationConfig", - "traits": { - "smithy.api#documentation": "

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

" + "smithy.api#documentation": "

If true, the event source mapping is active. Set to false to pause polling and invocation.

" } }, - "BisectBatchOnFunctionError": { - "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "

(Streams) If the function returns an error, split the batch in two and retry.

" + "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.

" } }, - "StartingPositionTimestamp": { - "target": "com.amazonaws.lambda#Date", + "Topics": { + "target": "com.amazonaws.lambda#Topics", "traits": { - "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading.

" + "smithy.api#documentation": "

\n (MSK) The name of the Kafka topic.\n

" } }, - "ParallelizationFactor": { - "target": "com.amazonaws.lambda#ParallelizationFactor", + "EventSourceArn": { + "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

(Streams) The number of batches to process from each shard concurrently.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n ", + "smithy.api#required": {} } }, "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of items to retrieve in a single batch.

\n " - } - }, - "MaximumRetryAttempts": { - "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", - "traits": { - "smithy.api#documentation": "

(Streams) The maximum number of times to retry when the function returns an error.

" + "smithy.api#documentation": "

The maximum number of items to retrieve in a single batch.

\n " } }, "FunctionName": { @@ -819,16 +808,28 @@ "smithy.api#required": {} } }, - "MaximumRecordAgeInSeconds": { - "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "ParallelizationFactor": { + "target": "com.amazonaws.lambda#ParallelizationFactor", "traits": { - "smithy.api#documentation": "

(Streams) The maximum age of a record that Lambda sends to a function for processing.

" + "smithy.api#documentation": "

(Streams) The number of batches to process from each shard concurrently.

" + } + }, + "BisectBatchOnFunctionError": { + "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "traits": { + "smithy.api#documentation": "

(Streams) If the function returns an error, split the batch in two and retry.

" } }, "StartingPosition": { "target": "com.amazonaws.lambda#EventSourcePosition", "traits": { - "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams\n sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

" + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams\n sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

" + } + }, + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", + "traits": { + "smithy.api#documentation": "

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

" } }, "MaximumBatchingWindowInSeconds": { @@ -837,11 +838,16 @@ "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

" } }, - "EventSourceArn": { - "target": "com.amazonaws.lambda#Arn", + "StartingPositionTimestamp": { + "target": "com.amazonaws.lambda#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading.

" + } + }, + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams) Discard records older than the specified age. The default value is infinite (-1).

" } } } @@ -886,111 +892,111 @@ "com.amazonaws.lambda#CreateFunctionRequest": { "type": "structure", "members": { - "VpcConfig": { - "target": "com.amazonaws.lambda#VpcConfig", + "Tags": { + "target": "com.amazonaws.lambda#Tags", "traits": { - "smithy.api#documentation": "

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more\n information, see VPC Settings.

" + "smithy.api#documentation": "

A list of tags to apply to the\n function.

" } }, - "Description": { - "target": "com.amazonaws.lambda#Description", + "Role": { + "target": "com.amazonaws.lambda#RoleArn", "traits": { - "smithy.api#documentation": "

A description of the function.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function's execution role.

", + "smithy.api#required": {} } }, - "MemorySize": { - "target": "com.amazonaws.lambda#MemorySize", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU\n allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

" + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#required": {} } }, - "KMSKeyArn": { - "target": "com.amazonaws.lambda#KMSKeyArn", + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment\n variables. If it's not provided, AWS Lambda uses a default service key.

" + "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" } }, - "Layers": { - "target": "com.amazonaws.lambda#LayerList", + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + "smithy.api#documentation": "

The identifier of the function's runtime.

", + "smithy.api#required": {} } }, - "Publish": { - "target": "com.amazonaws.lambda#Boolean", + "Environment": { + "target": "com.amazonaws.lambda#Environment", "traits": { - "smithy.api#documentation": "

Set to true to publish the first version of the function during creation.

" + "smithy.api#documentation": "

Environment variables that are accessible from function code during execution.

" } }, - "TracingConfig": { - "target": "com.amazonaws.lambda#TracingConfig", + "Publish": { + "target": "com.amazonaws.lambda#Boolean", "traits": { - "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with AWS\n X-Ray.

" + "smithy.api#documentation": "

Set to true to publish the first version of the function during creation.

" } }, - "Handler": { - "target": "com.amazonaws.lambda#Handler", + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The name of the method within your code that Lambda calls to execute your function. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment\n variables. If it's not provided, AWS Lambda uses a default service key.

" } }, - "Timeout": { - "target": "com.amazonaws.lambda#Timeout", + "Layers": { + "target": "com.amazonaws.lambda#LayerList", "traits": { - "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds.

" + "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" } }, - "Code": { - "target": "com.amazonaws.lambda#FunctionCode", + "Description": { + "target": "com.amazonaws.lambda#Description", "traits": { - "smithy.api#documentation": "

The code for the function.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the function.

" } }, - "Runtime": { - "target": "com.amazonaws.lambda#Runtime", + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfig", "traits": { - "smithy.api#documentation": "

The identifier of the function's runtime.

", - "smithy.api#required": {} + "smithy.api#documentation": "

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more\n information, see VPC Settings.

" } }, - "FileSystemConfigs": { - "target": "com.amazonaws.lambda#FileSystemConfigList", + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfig", "traits": { - "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" + "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with AWS\n X-Ray.

" } }, - "Role": { - "target": "com.amazonaws.lambda#RoleArn", + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function's execution role.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU\n allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

" } }, - "Environment": { - "target": "com.amazonaws.lambda#Environment", + "DeadLetterConfig": { + "target": "com.amazonaws.lambda#DeadLetterConfig", "traits": { - "smithy.api#documentation": "

Environment variables that are accessible from function code during execution.

" + "smithy.api#documentation": "

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\n when they fail processing. For more information, see Dead Letter Queues.

" } }, - "Tags": { - "target": "com.amazonaws.lambda#Tags", + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "

A list of tags to apply to the\n function.

" + "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds.

" } }, - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", + "Code": { + "target": "com.amazonaws.lambda#FunctionCode", "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The code for the function.

", "smithy.api#required": {} } }, - "DeadLetterConfig": { - "target": "com.amazonaws.lambda#DeadLetterConfig", + "Handler": { + "target": "com.amazonaws.lambda#Handler", "traits": { - "smithy.api#documentation": "

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\n when they fail processing. For more information, see Dead Letter Queues.

" + "smithy.api#documentation": "

The name of the method within your code that Lambda calls to execute your function. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.

", + "smithy.api#required": {} } } } @@ -1087,7 +1093,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\n deleted for several seconds.

", "smithy.api#http": { "method": "DELETE", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -1214,13 +1220,6 @@ "com.amazonaws.lambda#DeleteFunctionEventInvokeConfigRequest": { "type": "structure", "members": { - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

A version number or alias name.

", - "smithy.api#httpQuery": "Qualifier" - } - }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { @@ -1228,6 +1227,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" + } } } }, @@ -1276,18 +1282,18 @@ "com.amazonaws.lambda#DeleteLayerVersionRequest": { "type": "structure", "members": { - "LayerName": { - "target": "com.amazonaws.lambda#LayerName", + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#documentation": "

The version number.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "VersionNumber": { - "target": "com.amazonaws.lambda#LayerVersionNumber", + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", "traits": { - "smithy.api#documentation": "

The version number.

", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1368,17 +1374,17 @@ "com.amazonaws.lambda#DestinationConfig": { "type": "structure", "members": { - "OnSuccess": { - "target": "com.amazonaws.lambda#OnSuccess", - "traits": { - "smithy.api#documentation": "

The destination configuration for successful invocations.

" - } - }, "OnFailure": { "target": "com.amazonaws.lambda#OnFailure", "traits": { "smithy.api#documentation": "

The destination configuration for failed invocations.

" } + }, + "OnSuccess": { + "target": "com.amazonaws.lambda#OnSuccess", + "traits": { + "smithy.api#documentation": "

The destination configuration for successful invocations.

" + } } }, "traits": { @@ -1388,10 +1394,10 @@ "com.amazonaws.lambda#EC2AccessDeniedException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -1404,10 +1410,10 @@ "com.amazonaws.lambda#EC2ThrottledException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -1420,13 +1426,13 @@ "com.amazonaws.lambda#EC2UnexpectedException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "EC2ErrorCode": { + "Type": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "EC2ErrorCode": { "target": "com.amazonaws.lambda#String" } }, @@ -1439,10 +1445,10 @@ "com.amazonaws.lambda#EFSIOException": { "type": "structure", "members": { - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" }, - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" } }, @@ -1455,10 +1461,10 @@ "com.amazonaws.lambda#EFSMountConnectivityException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -1471,10 +1477,10 @@ "com.amazonaws.lambda#EFSMountFailureException": { "type": "structure", "members": { - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" }, - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" } }, @@ -1487,10 +1493,10 @@ "com.amazonaws.lambda#EFSMountTimeoutException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -1503,10 +1509,10 @@ "com.amazonaws.lambda#ENILimitReachedException": { "type": "structure", "members": { - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" }, - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" } }, @@ -1539,17 +1545,17 @@ "com.amazonaws.lambda#EnvironmentError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.lambda#SensitiveString", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, "ErrorCode": { "target": "com.amazonaws.lambda#String", "traits": { "smithy.api#documentation": "

The error code.

" } + }, + "Message": { + "target": "com.amazonaws.lambda#SensitiveString", + "traits": { + "smithy.api#documentation": "

The error message.

" + } } }, "traits": { @@ -1559,17 +1565,17 @@ "com.amazonaws.lambda#EnvironmentResponse": { "type": "structure", "members": { - "Variables": { - "target": "com.amazonaws.lambda#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "

Environment variable key-value pairs.

" - } - }, "Error": { "target": "com.amazonaws.lambda#EnvironmentError", "traits": { "smithy.api#documentation": "

Error messages for environment variables that couldn't be applied.

" } + }, + "Variables": { + "target": "com.amazonaws.lambda#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variable key-value pairs.

" + } } }, "traits": { @@ -1604,46 +1610,46 @@ "com.amazonaws.lambda#EventSourceMappingConfiguration": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.lambda#String", + "Topics": { + "target": "com.amazonaws.lambda#Topics", "traits": { - "smithy.api#documentation": "

The state of the event source mapping. It can be one of the following: Creating,\n Enabling, Enabled, Disabling, Disabled,\n Updating, or Deleting.

" + "smithy.api#documentation": "

\n (MSK) The name of the Kafka topic.\n

" } }, - "DestinationConfig": { - "target": "com.amazonaws.lambda#DestinationConfig", + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", "traits": { - "smithy.api#documentation": "

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

" + "smithy.api#documentation": "

The ARN of the Lambda function.

" } }, - "MaximumBatchingWindowInSeconds": { - "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", + "BatchSize": { + "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

" + "smithy.api#documentation": "

The maximum number of items to retrieve in a single batch.

" } }, - "MaximumRetryAttempts": { - "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "ParallelizationFactor": { + "target": "com.amazonaws.lambda#ParallelizationFactor", "traits": { - "smithy.api#documentation": "

(Streams) The maximum number of times to retry when the function returns an error.

" + "smithy.api#documentation": "

(Streams) The number of batches to process from each shard concurrently.

" } }, - "BatchSize": { - "target": "com.amazonaws.lambda#BatchSize", + "EventSourceArn": { + "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

The maximum number of items to retrieve in a single batch.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

" } }, - "LastProcessingResult": { - "target": "com.amazonaws.lambda#String", + "LastModified": { + "target": "com.amazonaws.lambda#Date", "traits": { - "smithy.api#documentation": "

The result of the last AWS Lambda invocation of your Lambda function.

" + "smithy.api#documentation": "

The date that the event source mapping was last updated, or its state changed.

" } }, - "ParallelizationFactor": { - "target": "com.amazonaws.lambda#ParallelizationFactor", + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "

(Streams) The number of batches to process from each shard concurrently.

" + "smithy.api#documentation": "

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

" } }, "BisectBatchOnFunctionError": { @@ -1652,10 +1658,10 @@ "smithy.api#documentation": "

(Streams) If the function returns an error, split the batch in two and retry.

" } }, - "StateTransitionReason": { + "State": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda\n service.

" + "smithy.api#documentation": "

The state of the event source mapping. It can be one of the following: Creating,\n Enabling, Enabled, Disabling, Disabled,\n Updating, or Deleting.

" } }, "MaximumRecordAgeInSeconds": { @@ -1664,28 +1670,34 @@ "smithy.api#documentation": "

(Streams) The maximum age of a record that Lambda sends to a function for processing.

" } }, - "LastModified": { - "target": "com.amazonaws.lambda#Date", + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

The date that the event source mapping was last updated, or its state changed.

" + "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

" } }, - "FunctionArn": { - "target": "com.amazonaws.lambda#FunctionArn", + "UUID": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The ARN of the Lambda function.

" + "smithy.api#documentation": "

The identifier of the event source mapping.

" } }, - "EventSourceArn": { - "target": "com.amazonaws.lambda#Arn", + "LastProcessingResult": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

" + "smithy.api#documentation": "

The result of the last AWS Lambda invocation of your Lambda function.

" } }, - "UUID": { - "target": "com.amazonaws.lambda#String", + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "

The identifier of the event source mapping.

" + "smithy.api#documentation": "

(Streams) The maximum number of times to retry when the function returns an error.

" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda\n service.

" } } }, @@ -1741,17 +1753,17 @@ "com.amazonaws.lambda#FileSystemConfig": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.lambda#FileSystemArn", + "LocalMountPath": { + "target": "com.amazonaws.lambda#LocalMountPath", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

", + "smithy.api#documentation": "

The path where the function can access the file system, starting with /mnt/.

", "smithy.api#required": {} } }, - "LocalMountPath": { - "target": "com.amazonaws.lambda#LocalMountPath", + "Arn": { + "target": "com.amazonaws.lambda#FileSystemArn", "traits": { - "smithy.api#documentation": "

The path where the function can access the file system, starting with /mnt/.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

", "smithy.api#required": {} } } @@ -1781,6 +1793,12 @@ "com.amazonaws.lambda#FunctionCode": { "type": "structure", "members": { + "ZipFile": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for\n you.

" + } + }, "S3ObjectVersion": { "target": "com.amazonaws.lambda#S3ObjectVersion", "traits": { @@ -1798,12 +1816,6 @@ "traits": { "smithy.api#documentation": "

The Amazon S3 key of the deployment package.

" } - }, - "ZipFile": { - "target": "com.amazonaws.lambda#Blob", - "traits": { - "smithy.api#documentation": "

The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for\n you.

" - } } }, "traits": { @@ -1813,16 +1825,16 @@ "com.amazonaws.lambda#FunctionCodeLocation": { "type": "structure", "members": { - "Location": { + "RepositoryType": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

A presigned URL that you can use to download the deployment package.

" + "smithy.api#documentation": "

The service that's hosting the file.

" } }, - "RepositoryType": { + "Location": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The service that's hosting the file.

" + "smithy.api#documentation": "

A presigned URL that you can use to download the deployment package.

" } } }, @@ -1833,28 +1845,28 @@ "com.amazonaws.lambda#FunctionConfiguration": { "type": "structure", "members": { - "FunctionName": { - "target": "com.amazonaws.lambda#NamespacedFunctionName", + "State": { + "target": "com.amazonaws.lambda#State", "traits": { - "smithy.api#documentation": "

The name of the function.

" + "smithy.api#documentation": "

The current state of the function. When the state is Inactive, you can reactivate the function by\n invoking it.

" } }, - "RevisionId": { - "target": "com.amazonaws.lambda#String", + "Environment": { + "target": "com.amazonaws.lambda#EnvironmentResponse", "traits": { - "smithy.api#documentation": "

The latest updated revision of the function or alias.

" + "smithy.api#documentation": "

The function's environment variables.

" } }, - "MasterArn": { - "target": "com.amazonaws.lambda#FunctionArn", + "LastUpdateStatusReason": { + "target": "com.amazonaws.lambda#LastUpdateStatusReason", "traits": { - "smithy.api#documentation": "

For Lambda@Edge functions, the ARN of the master function.

" + "smithy.api#documentation": "

The reason for the last update that was performed on the function.

" } }, - "LastUpdateStatus": { - "target": "com.amazonaws.lambda#LastUpdateStatus", + "MasterArn": { + "target": "com.amazonaws.lambda#FunctionArn", "traits": { - "smithy.api#documentation": "

The status of the last update that was performed on the function. This is first set to Successful\n after function creation completes.

" + "smithy.api#documentation": "

For Lambda@Edge functions, the ARN of the master function.

" } }, "Layers": { @@ -1863,22 +1875,22 @@ "smithy.api#documentation": "

The function's \n layers.

" } }, - "FileSystemConfigs": { - "target": "com.amazonaws.lambda#FileSystemConfigList", + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" + "smithy.api#documentation": "

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've\n configured a customer managed CMK.

" } }, - "VpcConfig": { - "target": "com.amazonaws.lambda#VpcConfigResponse", + "Role": { + "target": "com.amazonaws.lambda#RoleArn", "traits": { - "smithy.api#documentation": "

The function's networking configuration.

" + "smithy.api#documentation": "

The function's execution role.

" } }, - "Runtime": { - "target": "com.amazonaws.lambda#Runtime", + "FileSystemConfigs": { + "target": "com.amazonaws.lambda#FileSystemConfigList", "traits": { - "smithy.api#documentation": "

The runtime environment for the Lambda function.

" + "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" } }, "CodeSha256": { @@ -1887,28 +1899,16 @@ "smithy.api#documentation": "

The SHA256 hash of the function's deployment package.

" } }, - "LastModified": { - "target": "com.amazonaws.lambda#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" - } - }, - "MemorySize": { - "target": "com.amazonaws.lambda#MemorySize", - "traits": { - "smithy.api#documentation": "

The memory that's allocated to the function.

" - } - }, - "Version": { - "target": "com.amazonaws.lambda#Version", + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfigResponse", "traits": { - "smithy.api#documentation": "

The version of the Lambda function.

" + "smithy.api#documentation": "

The function's networking configuration.

" } }, - "Timeout": { - "target": "com.amazonaws.lambda#Timeout", + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The amount of time in seconds that Lambda allows a function to run before stopping it.

" + "smithy.api#documentation": "

The name of the function.

" } }, "CodeSize": { @@ -1917,28 +1917,22 @@ "smithy.api#documentation": "

The size of the function's deployment package, in bytes.

" } }, - "FunctionArn": { - "target": "com.amazonaws.lambda#NameSpacedFunctionArn", - "traits": { - "smithy.api#documentation": "

The function's Amazon Resource Name (ARN).

" - } - }, - "Environment": { - "target": "com.amazonaws.lambda#EnvironmentResponse", + "Version": { + "target": "com.amazonaws.lambda#Version", "traits": { - "smithy.api#documentation": "

The function's environment variables.

" + "smithy.api#documentation": "

The version of the Lambda function.

" } }, - "LastUpdateStatusReason": { - "target": "com.amazonaws.lambda#LastUpdateStatusReason", + "LastUpdateStatus": { + "target": "com.amazonaws.lambda#LastUpdateStatus", "traits": { - "smithy.api#documentation": "

The reason for the last update that was performed on the function.

" + "smithy.api#documentation": "

The status of the last update that was performed on the function. This is first set to Successful\n after function creation completes.

" } }, - "Handler": { - "target": "com.amazonaws.lambda#Handler", + "LastUpdateStatusReasonCode": { + "target": "com.amazonaws.lambda#LastUpdateStatusReasonCode", "traits": { - "smithy.api#documentation": "

The function that Lambda calls to begin executing your function.

" + "smithy.api#documentation": "

The reason code for the last update that was performed on the function.

" } }, "TracingConfig": { @@ -1947,16 +1941,22 @@ "smithy.api#documentation": "

The function's AWS X-Ray tracing configuration.

" } }, + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "

The runtime environment for the Lambda function.

" + } + }, "StateReasonCode": { "target": "com.amazonaws.lambda#StateReasonCode", "traits": { "smithy.api#documentation": "

The reason code for the function's current state. When the code is Creating, you can't invoke or\n modify the function.

" } }, - "LastUpdateStatusReasonCode": { - "target": "com.amazonaws.lambda#LastUpdateStatusReasonCode", + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "

The reason code for the last update that was performed on the function.

" + "smithy.api#documentation": "

The amount of time in seconds that Lambda allows a function to run before stopping it.

" } }, "Description": { @@ -1965,16 +1965,16 @@ "smithy.api#documentation": "

The function's description.

" } }, - "Role": { - "target": "com.amazonaws.lambda#RoleArn", + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", "traits": { - "smithy.api#documentation": "

The function's execution role.

" + "smithy.api#documentation": "

The memory that's allocated to the function.

" } }, - "KMSKeyArn": { - "target": "com.amazonaws.lambda#KMSKeyArn", + "StateReason": { + "target": "com.amazonaws.lambda#StateReason", "traits": { - "smithy.api#documentation": "

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've\n configured a customer managed CMK.

" + "smithy.api#documentation": "

The reason for the function's current state.

" } }, "DeadLetterConfig": { @@ -1983,16 +1983,28 @@ "smithy.api#documentation": "

The function's dead letter queue.

" } }, - "StateReason": { - "target": "com.amazonaws.lambda#StateReason", + "FunctionArn": { + "target": "com.amazonaws.lambda#NameSpacedFunctionArn", "traits": { - "smithy.api#documentation": "

The reason for the function's current state.

" + "smithy.api#documentation": "

The function's Amazon Resource Name (ARN).

" } }, - "State": { - "target": "com.amazonaws.lambda#State", + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", "traits": { - "smithy.api#documentation": "

The current state of the function. When the state is Inactive, you can reactivate the function by\n invoking it.

" + "smithy.api#documentation": "

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "

The function that Lambda calls to begin executing your function.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The latest updated revision of the function or alias.

" } } }, @@ -2003,34 +2015,34 @@ "com.amazonaws.lambda#FunctionEventInvokeConfig": { "type": "structure", "members": { - "MaximumEventAgeInSeconds": { - "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", - "traits": { - "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" - } - }, - "DestinationConfig": { - "target": "com.amazonaws.lambda#DestinationConfig", - "traits": { - "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n " - } - }, "LastModified": { "target": "com.amazonaws.lambda#Date", "traits": { "smithy.api#documentation": "

The date and time that the configuration was last updated.

" } }, + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function.

" + } + }, "MaximumRetryAttempts": { "target": "com.amazonaws.lambda#MaximumRetryAttempts", "traits": { "smithy.api#documentation": "

The maximum number of times to retry when the function returns an error.

" } }, - "FunctionArn": { - "target": "com.amazonaws.lambda#FunctionArn", + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function.

" + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n " + } + }, + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" } } } @@ -2100,17 +2112,17 @@ "com.amazonaws.lambda#GetAccountSettingsResponse": { "type": "structure", "members": { - "AccountLimit": { - "target": "com.amazonaws.lambda#AccountLimit", - "traits": { - "smithy.api#documentation": "

Limits that are related to concurrency and code storage.

" - } - }, "AccountUsage": { "target": "com.amazonaws.lambda#AccountUsage", "traits": { "smithy.api#documentation": "

The number of functions and amount of storage in use.

" } + }, + "AccountLimit": { + "target": "com.amazonaws.lambda#AccountLimit", + "traits": { + "smithy.api#documentation": "

Limits that are related to concurrency and code storage.

" + } } } }, @@ -2148,18 +2160,18 @@ "com.amazonaws.lambda#GetAliasRequest": { "type": "structure", "members": { - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", + "Name": { + "target": "com.amazonaws.lambda#Alias", "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name of the alias.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.lambda#Alias", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name of the alias.

", + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2189,7 +2201,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\n ListEventSourceMappings.

", "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -2330,6 +2342,13 @@ "com.amazonaws.lambda#GetFunctionConfigurationRequest": { "type": "structure", "members": { + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to get details about a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + }, "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { @@ -2337,13 +2356,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

Specify a version or alias to get details about a published version of the function.

", - "smithy.api#httpQuery": "Qualifier" - } } } }, @@ -2381,13 +2393,6 @@ "com.amazonaws.lambda#GetFunctionEventInvokeConfigRequest": { "type": "structure", "members": { - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

A version number or alias name.

", - "smithy.api#httpQuery": "Qualifier" - } - }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { @@ -2395,11 +2400,18 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - } - }, - "com.amazonaws.lambda#GetFunctionRequest": { - "type": "structure", + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" + } + } + } + }, + "com.amazonaws.lambda#GetFunctionRequest": { + "type": "structure", "members": { "Qualifier": { "target": "com.amazonaws.lambda#Qualifier", @@ -2421,29 +2433,29 @@ "com.amazonaws.lambda#GetFunctionResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.lambda#Tags", - "traits": { - "smithy.api#documentation": "

The function's tags.

" - } - }, - "Code": { - "target": "com.amazonaws.lambda#FunctionCodeLocation", - "traits": { - "smithy.api#documentation": "

The deployment package of the function or version.

" - } - }, "Concurrency": { "target": "com.amazonaws.lambda#Concurrency", "traits": { "smithy.api#documentation": "

The function's reserved\n concurrency.

" } }, + "Tags": { + "target": "com.amazonaws.lambda#Tags", + "traits": { + "smithy.api#documentation": "

The function's tags.

" + } + }, "Configuration": { "target": "com.amazonaws.lambda#FunctionConfiguration", "traits": { "smithy.api#documentation": "

The configuration of the function or version.

" } + }, + "Code": { + "target": "com.amazonaws.lambda#FunctionCodeLocation", + "traits": { + "smithy.api#documentation": "

The deployment package of the function or version.

" + } } } }, @@ -2577,16 +2589,16 @@ "com.amazonaws.lambda#GetLayerVersionPolicyResponse": { "type": "structure", "members": { - "Policy": { + "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The policy document.

" + "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" } }, - "RevisionId": { + "Policy": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" + "smithy.api#documentation": "

The policy document.

" } } } @@ -2594,18 +2606,18 @@ "com.amazonaws.lambda#GetLayerVersionRequest": { "type": "structure", "members": { - "LayerName": { - "target": "com.amazonaws.lambda#LayerName", + "VersionNumber": { + "target": "com.amazonaws.lambda#LayerVersionNumber", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#documentation": "

The version number.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "VersionNumber": { - "target": "com.amazonaws.lambda#LayerVersionNumber", + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", "traits": { - "smithy.api#documentation": "

The version number.

", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2615,28 +2627,28 @@ "com.amazonaws.lambda#GetLayerVersionResponse": { "type": "structure", "members": { - "LicenseInfo": { - "target": "com.amazonaws.lambda#LicenseInfo", + "LayerVersionArn": { + "target": "com.amazonaws.lambda#LayerVersionArn", "traits": { - "smithy.api#documentation": "

The layer's software license.

" + "smithy.api#documentation": "

The ARN of the layer version.

" } }, - "CompatibleRuntimes": { - "target": "com.amazonaws.lambda#CompatibleRuntimes", + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes.

" + "smithy.api#documentation": "

The ARN of the layer.

" } }, - "Description": { - "target": "com.amazonaws.lambda#Description", + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", "traits": { - "smithy.api#documentation": "

The description of the version.

" + "smithy.api#documentation": "

The layer's software license.

" } }, - "LayerVersionArn": { - "target": "com.amazonaws.lambda#LayerVersionArn", + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", "traits": { - "smithy.api#documentation": "

The ARN of the layer version.

" + "smithy.api#documentation": "

The layer's compatible runtimes.

" } }, "Version": { @@ -2651,16 +2663,16 @@ "smithy.api#documentation": "

Details about the layer version.

" } }, - "CreatedDate": { - "target": "com.amazonaws.lambda#Timestamp", + "Description": { + "target": "com.amazonaws.lambda#Description", "traits": { - "smithy.api#documentation": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + "smithy.api#documentation": "

The description of the version.

" } }, - "LayerArn": { - "target": "com.amazonaws.lambda#LayerArn", + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", "traits": { - "smithy.api#documentation": "

The ARN of the layer.

" + "smithy.api#documentation": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" } } } @@ -2699,6 +2711,13 @@ "com.amazonaws.lambda#GetPolicyRequest": { "type": "structure", "members": { + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to get the policy for that resource.

", + "smithy.api#httpQuery": "Qualifier" + } + }, "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { @@ -2706,29 +2725,22 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

Specify a version or alias to get the policy for that resource.

", - "smithy.api#httpQuery": "Qualifier" - } } } }, "com.amazonaws.lambda#GetPolicyResponse": { "type": "structure", "members": { - "Policy": { + "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The resource-based policy.

" + "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" } }, - "RevisionId": { + "Policy": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the current revision of the policy.

" + "smithy.api#documentation": "

The resource-based policy.

" } } } @@ -2770,14 +2782,6 @@ "com.amazonaws.lambda#GetProvisionedConcurrencyConfigRequest": { "type": "structure", "members": { - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

The version number or alias name.

", - "smithy.api#httpQuery": "Qualifier", - "smithy.api#required": {} - } - }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { @@ -2785,28 +2789,24 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

The version number or alias name.

", + "smithy.api#httpQuery": "Qualifier", + "smithy.api#required": {} + } } } }, "com.amazonaws.lambda#GetProvisionedConcurrencyConfigResponse": { "type": "structure", "members": { - "RequestedProvisionedConcurrentExecutions": { - "target": "com.amazonaws.lambda#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" - } - }, - "AvailableProvisionedConcurrentExecutions": { - "target": "com.amazonaws.lambda#NonNegativeInteger", - "traits": { - "smithy.api#documentation": "

The amount of provisioned concurrency available.

" - } - }, - "StatusReason": { - "target": "com.amazonaws.lambda#String", + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", "traits": { - "smithy.api#documentation": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

" + "smithy.api#documentation": "

The status of the allocation process.

" } }, "LastModified": { @@ -2815,10 +2815,10 @@ "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" } }, - "Status": { - "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The status of the allocation process.

" + "smithy.api#documentation": "

The amount of provisioned concurrency available.

" } }, "AllocatedProvisionedConcurrentExecutions": { @@ -2826,6 +2826,18 @@ "traits": { "smithy.api#documentation": "

The amount of provisioned concurrency allocated.

" } + }, + "StatusReason": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

" + } + }, + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" + } } } }, @@ -2839,6 +2851,9 @@ "smithy.api#pattern": "[^\\s]+" } }, + "com.amazonaws.lambda#HttpStatus": { + "type": "integer" + }, "com.amazonaws.lambda#Integer": { "type": "integer" }, @@ -2921,10 +2936,10 @@ "com.amazonaws.lambda#InvalidSubnetIDException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -2937,10 +2952,10 @@ "com.amazonaws.lambda#InvalidZipFileException": { "type": "structure", "members": { - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" }, - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" } }, @@ -2953,11 +2968,11 @@ "com.amazonaws.lambda#InvocationRequest": { "type": "structure", "members": { - "InvocationType": { - "target": "com.amazonaws.lambda#InvocationType", + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", "traits": { - "smithy.api#documentation": "

Choose from the following options.

\n ", - "smithy.api#httpHeader": "X-Amz-Invocation-Type" + "smithy.api#documentation": "

Specify a version or alias to invoke a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" } }, "LogType": { @@ -2967,6 +2982,14 @@ "smithy.api#httpHeader": "X-Amz-Log-Type" } }, + "FunctionName": { + "target": "com.amazonaws.lambda#NamespacedFunctionName", + "traits": { + "smithy.api#documentation": "

The name of the Lambda function, version, or alias.

\n

\n Name formats\n

\n \n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Payload": { "target": "com.amazonaws.lambda#Blob", "traits": { @@ -2974,13 +2997,6 @@ "smithy.api#httpPayload": {} } }, - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

Specify a version or alias to invoke a published version of the function.

", - "smithy.api#httpQuery": "Qualifier" - } - }, "ClientContext": { "target": "com.amazonaws.lambda#String", "traits": { @@ -2988,12 +3004,11 @@ "smithy.api#httpHeader": "X-Amz-Client-Context" } }, - "FunctionName": { - "target": "com.amazonaws.lambda#NamespacedFunctionName", + "InvocationType": { + "target": "com.amazonaws.lambda#InvocationType", "traits": { - "smithy.api#documentation": "

The name of the Lambda function, version, or alias.

\n

\n Name formats\n

\n \n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Choose from the following options.

\n ", + "smithy.api#httpHeader": "X-Amz-Invocation-Type" } } } @@ -3008,11 +3023,11 @@ "smithy.api#httpHeader": "X-Amz-Log-Result" } }, - "Payload": { - "target": "com.amazonaws.lambda#Blob", + "FunctionError": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The response from the function, or an error object.

", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

If present, indicates that an error occurred during function execution. Details about the error are included\n in the response payload.

", + "smithy.api#httpHeader": "X-Amz-Function-Error" } }, "ExecutedVersion": { @@ -3022,11 +3037,18 @@ "smithy.api#httpHeader": "X-Amz-Executed-Version" } }, - "FunctionError": { - "target": "com.amazonaws.lambda#String", + "StatusCode": { + "target": "com.amazonaws.lambda#Integer", "traits": { - "smithy.api#documentation": "

If present, indicates that an error occurred during function execution. Details about the error are included\n in the response payload.

", - "smithy.api#httpHeader": "X-Amz-Function-Error" + "smithy.api#documentation": "

The HTTP status code is in the 200 range for a successful request. For the RequestResponse\n invocation type, this status code is 200. For the Event invocation type, this status code is 202. For\n the DryRun invocation type, the status code is 204.

", + "smithy.api#httpResponseCode": {} + } + }, + "Payload": { + "target": "com.amazonaws.lambda#Blob", + "traits": { + "smithy.api#documentation": "

The response from the function, or an error object.

", + "smithy.api#httpPayload": {} } } } @@ -3185,14 +3207,6 @@ "com.amazonaws.lambda#InvokeAsyncRequest": { "type": "structure", "members": { - "InvokeArgs": { - "target": "com.amazonaws.lambda#BlobStream", - "traits": { - "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { @@ -3200,6 +3214,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "InvokeArgs": { + "target": "com.amazonaws.lambda#BlobStream", + "traits": { + "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -3208,7 +3230,15 @@ }, "com.amazonaws.lambda#InvokeAsyncResponse": { "type": "structure", - "members": {}, + "members": { + "Status": { + "target": "com.amazonaws.lambda#HttpStatus", + "traits": { + "smithy.api#documentation": "

The status code.

", + "smithy.api#httpResponseCode": {} + } + } + }, "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

A success response (202 Accepted) indicates that the request is queued for invocation.

" @@ -3249,10 +3279,10 @@ "com.amazonaws.lambda#KMSInvalidStateException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -3271,10 +3301,10 @@ "com.amazonaws.lambda#KMSNotFoundException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -3412,18 +3442,6 @@ "com.amazonaws.lambda#LayerVersionContentInput": { "type": "structure", "members": { - "S3Bucket": { - "target": "com.amazonaws.lambda#S3Bucket", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket of the layer archive.

" - } - }, - "S3ObjectVersion": { - "target": "com.amazonaws.lambda#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

For versioned objects, the version of the layer archive object to use.

" - } - }, "S3Key": { "target": "com.amazonaws.lambda#S3Key", "traits": { @@ -3435,6 +3453,18 @@ "traits": { "smithy.api#documentation": "

The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for\n you.

" } + }, + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket of the layer archive.

" + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

For versioned objects, the version of the layer archive object to use.

" + } } }, "traits": { @@ -3444,12 +3474,6 @@ "com.amazonaws.lambda#LayerVersionContentOutput": { "type": "structure", "members": { - "CodeSha256": { - "target": "com.amazonaws.lambda#String", - "traits": { - "smithy.api#documentation": "

The SHA-256 hash of the layer archive.

" - } - }, "CodeSize": { "target": "com.amazonaws.lambda#Long", "traits": { @@ -3461,6 +3485,12 @@ "traits": { "smithy.api#documentation": "

A link to the layer archive in Amazon S3 that is valid for 10 minutes.

" } + }, + "CodeSha256": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

The SHA-256 hash of the layer archive.

" + } } }, "traits": { @@ -3479,41 +3509,41 @@ "com.amazonaws.lambda#LayerVersionsListItem": { "type": "structure", "members": { - "CreatedDate": { - "target": "com.amazonaws.lambda#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.

" - } - }, "Version": { "target": "com.amazonaws.lambda#LayerVersionNumber", "traits": { "smithy.api#documentation": "

The version number.

" } }, - "LicenseInfo": { - "target": "com.amazonaws.lambda#LicenseInfo", - "traits": { - "smithy.api#documentation": "

The layer's open-source license.

" - } - }, - "CompatibleRuntimes": { - "target": "com.amazonaws.lambda#CompatibleRuntimes", - "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes.

" - } - }, "Description": { "target": "com.amazonaws.lambda#Description", "traits": { "smithy.api#documentation": "

The description of the version.

" } }, + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.

" + } + }, "LayerVersionArn": { "target": "com.amazonaws.lambda#LayerVersionArn", "traits": { "smithy.api#documentation": "

The ARN of the layer version.

" } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", + "traits": { + "smithy.api#documentation": "

The layer's compatible runtimes.

" + } + }, + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", + "traits": { + "smithy.api#documentation": "

The layer's open-source license.

" + } } }, "traits": { @@ -3535,17 +3565,17 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function layer.

" } }, - "LayerName": { - "target": "com.amazonaws.lambda#LayerName", - "traits": { - "smithy.api#documentation": "

The name of the layer.

" - } - }, "LatestMatchingVersion": { "target": "com.amazonaws.lambda#LayerVersionsListItem", "traits": { "smithy.api#documentation": "

The newest version of the layer.

" } + }, + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name of the layer.

" + } } }, "traits": { @@ -3614,6 +3644,13 @@ "smithy.api#httpQuery": "Marker" } }, + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

Specify a function version to only list aliases that invoke that version.

", + "smithy.api#httpQuery": "FunctionVersion" + } + }, "MaxItems": { "target": "com.amazonaws.lambda#MaxListItems", "traits": { @@ -3628,30 +3665,23 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "FunctionVersion": { - "target": "com.amazonaws.lambda#Version", - "traits": { - "smithy.api#documentation": "

Specify a function version to only list aliases that invoke that version.

", - "smithy.api#httpQuery": "FunctionVersion" - } } } }, "com.amazonaws.lambda#ListAliasesResponse": { "type": "structure", "members": { - "Aliases": { - "target": "com.amazonaws.lambda#AliasList", - "traits": { - "smithy.api#documentation": "

A list of aliases.

" - } - }, "NextMarker": { "target": "com.amazonaws.lambda#String", "traits": { "smithy.api#documentation": "

The pagination token that's included if more results are available.

" } + }, + "Aliases": { + "target": "com.amazonaws.lambda#AliasList", + "traits": { + "smithy.api#documentation": "

A list of aliases.

" + } } } }, @@ -3709,19 +3739,19 @@ "smithy.api#httpQuery": "MaxItems" } }, + "EventSourceArn": { + "target": "com.amazonaws.lambda#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n ", + "smithy.api#httpQuery": "EventSourceArn" + } + }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

", "smithy.api#httpQuery": "FunctionName" } - }, - "EventSourceArn": { - "target": "com.amazonaws.lambda#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n ", - "smithy.api#httpQuery": "EventSourceArn" - } } } }, @@ -3790,19 +3820,19 @@ "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.lambda#MaxFunctionEventInvokeConfigListItems", - "traits": { - "smithy.api#documentation": "

The maximum number of configurations to return.

", - "smithy.api#httpQuery": "MaxItems" - } - }, "Marker": { "target": "com.amazonaws.lambda#String", "traits": { "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", "smithy.api#httpQuery": "Marker" } + }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxFunctionEventInvokeConfigListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of configurations to return.

", + "smithy.api#httpQuery": "MaxItems" + } } } }, @@ -3860,6 +3890,13 @@ "com.amazonaws.lambda#ListFunctionsRequest": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } + }, "FunctionVersion": { "target": "com.amazonaws.lambda#FunctionVersion", "traits": { @@ -3867,13 +3904,6 @@ "smithy.api#httpQuery": "FunctionVersion" } }, - "MaxItems": { - "target": "com.amazonaws.lambda#MaxListItems", - "traits": { - "smithy.api#documentation": "

The maximum number of functions to return.

", - "smithy.api#httpQuery": "MaxItems" - } - }, "MasterRegion": { "target": "com.amazonaws.lambda#MasterRegion", "traits": { @@ -3881,11 +3911,11 @@ "smithy.api#httpQuery": "MasterRegion" } }, - "Marker": { - "target": "com.amazonaws.lambda#String", + "MaxItems": { + "target": "com.amazonaws.lambda#MaxListItems", "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "smithy.api#httpQuery": "Marker" + "smithy.api#documentation": "

The maximum number of functions to return.

", + "smithy.api#httpQuery": "MaxItems" } } } @@ -3964,6 +3994,13 @@ "smithy.api#httpQuery": "Marker" } }, + "MaxItems": { + "target": "com.amazonaws.lambda#MaxLayerListItems", + "traits": { + "smithy.api#documentation": "

The maximum number of versions to return.

", + "smithy.api#httpQuery": "MaxItems" + } + }, "LayerName": { "target": "com.amazonaws.lambda#LayerName", "traits": { @@ -3971,30 +4008,23 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "MaxItems": { - "target": "com.amazonaws.lambda#MaxLayerListItems", - "traits": { - "smithy.api#documentation": "

The maximum number of versions to return.

", - "smithy.api#httpQuery": "MaxItems" - } } } }, "com.amazonaws.lambda#ListLayerVersionsResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.lambda#String", - "traits": { - "smithy.api#documentation": "

A pagination token returned when the response doesn't contain all versions.

" - } - }, "LayerVersions": { "target": "com.amazonaws.lambda#LayerVersionsList", "traits": { "smithy.api#documentation": "

A list of versions.

" } + }, + "NextMarker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

A pagination token returned when the response doesn't contain all versions.

" + } } } }, @@ -4042,19 +4072,19 @@ "smithy.api#httpQuery": "MaxItems" } }, - "CompatibleRuntime": { - "target": "com.amazonaws.lambda#Runtime", - "traits": { - "smithy.api#documentation": "

A runtime identifier. For example, go1.x.

", - "smithy.api#httpQuery": "CompatibleRuntime" - } - }, "Marker": { "target": "com.amazonaws.lambda#String", "traits": { "smithy.api#documentation": "

A pagination token returned by a previous call.

", "smithy.api#httpQuery": "Marker" } + }, + "CompatibleRuntime": { + "target": "com.amazonaws.lambda#Runtime", + "traits": { + "smithy.api#documentation": "

A runtime identifier. For example, go1.x.

", + "smithy.api#httpQuery": "CompatibleRuntime" + } } } }, @@ -4115,11 +4145,12 @@ "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.lambda#String", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "smithy.api#httpQuery": "Marker" + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "MaxItems": { @@ -4129,12 +4160,11 @@ "smithy.api#httpQuery": "MaxItems" } }, - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", + "Marker": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" } } } @@ -4142,17 +4172,17 @@ "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsResponse": { "type": "structure", "members": { - "ProvisionedConcurrencyConfigs": { - "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfigList", - "traits": { - "smithy.api#documentation": "

A list of provisioned concurrency configurations.

" - } - }, "NextMarker": { "target": "com.amazonaws.lambda#String", "traits": { "smithy.api#documentation": "

The pagination token that's included if more results are available.

" } + }, + "ProvisionedConcurrencyConfigs": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfigList", + "traits": { + "smithy.api#documentation": "

A list of provisioned concurrency configurations.

" + } } } }, @@ -4251,13 +4281,6 @@ "com.amazonaws.lambda#ListVersionsByFunctionRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.lambda#String", - "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", - "smithy.api#httpQuery": "Marker" - } - }, "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { @@ -4272,23 +4295,30 @@ "smithy.api#documentation": "

The maximum number of versions to return.

", "smithy.api#httpQuery": "MaxItems" } + }, + "Marker": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "Marker" + } } } }, "com.amazonaws.lambda#ListVersionsByFunctionResponse": { "type": "structure", "members": { - "Versions": { - "target": "com.amazonaws.lambda#FunctionList", - "traits": { - "smithy.api#documentation": "

A list of Lambda function versions.

" - } - }, "NextMarker": { "target": "com.amazonaws.lambda#String", "traits": { "smithy.api#documentation": "

The pagination token that's included if more results are available.

" } + }, + "Versions": { + "target": "com.amazonaws.lambda#FunctionList", + "traits": { + "smithy.api#documentation": "

A list of Lambda function versions.

" + } } } }, @@ -4391,7 +4421,7 @@ "traits": { "smithy.api#box": {}, "smithy.api#range": { - "min": 60, + "min": -1, "max": 604800 } } @@ -4411,7 +4441,7 @@ "traits": { "smithy.api#box": {}, "smithy.api#range": { - "min": 0, + "min": -1, "max": 10000 } } @@ -4508,10 +4538,10 @@ "com.amazonaws.lambda#PolicyLengthExceededException": { "type": "structure", "members": { - "message": { + "Type": { "target": "com.amazonaws.lambda#String" }, - "Type": { + "message": { "target": "com.amazonaws.lambda#String" } }, @@ -4567,16 +4597,16 @@ "com.amazonaws.lambda#ProvisionedConcurrencyConfigListItem": { "type": "structure", "members": { - "LastModified": { - "target": "com.amazonaws.lambda#Timestamp", + "FunctionArn": { + "target": "com.amazonaws.lambda#FunctionArn", "traits": { - "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias or version.

" } }, - "AllocatedProvisionedConcurrentExecutions": { - "target": "com.amazonaws.lambda#NonNegativeInteger", + "StatusReason": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The amount of provisioned concurrency allocated.

" + "smithy.api#documentation": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

" } }, "Status": { @@ -4585,28 +4615,28 @@ "smithy.api#documentation": "

The status of the allocation process.

" } }, - "AvailableProvisionedConcurrentExecutions": { - "target": "com.amazonaws.lambda#NonNegativeInteger", + "RequestedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#PositiveInteger", "traits": { - "smithy.api#documentation": "

The amount of provisioned concurrency available.

" + "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" } }, - "StatusReason": { - "target": "com.amazonaws.lambda#String", + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", "traits": { - "smithy.api#documentation": "

For failed allocations, the reason that provisioned concurrency could not be allocated.

" + "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" } }, - "RequestedProvisionedConcurrentExecutions": { - "target": "com.amazonaws.lambda#PositiveInteger", + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" + "smithy.api#documentation": "

The amount of provisioned concurrency available.

" } }, - "FunctionArn": { - "target": "com.amazonaws.lambda#FunctionArn", + "AllocatedProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias or version.

" + "smithy.api#documentation": "

The amount of provisioned concurrency allocated.

" } } }, @@ -4617,10 +4647,10 @@ "com.amazonaws.lambda#ProvisionedConcurrencyConfigNotFoundException": { "type": "structure", "members": { - "message": { + "Type": { "target": "com.amazonaws.lambda#String" }, - "Type": { + "message": { "target": "com.amazonaws.lambda#String" } }, @@ -4686,25 +4716,16 @@ "com.amazonaws.lambda#PublishLayerVersionRequest": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.lambda#LayerVersionContentInput", - "traits": { - "smithy.api#documentation": "

The function layer archive.

", - "smithy.api#required": {} - } - }, "Description": { "target": "com.amazonaws.lambda#Description", "traits": { "smithy.api#documentation": "

The description of the version.

" } }, - "LayerName": { - "target": "com.amazonaws.lambda#LayerName", + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The layer's software license. It can be any of the following:

\n " } }, "CompatibleRuntimes": { @@ -4713,10 +4734,19 @@ "smithy.api#documentation": "

A list of compatible function\n runtimes. Used for filtering with ListLayers and ListLayerVersions.

" } }, - "LicenseInfo": { - "target": "com.amazonaws.lambda#LicenseInfo", + "Content": { + "target": "com.amazonaws.lambda#LayerVersionContentInput", "traits": { - "smithy.api#documentation": "

The layer's software license. It can be any of the following:

\n " + "smithy.api#documentation": "

The function layer archive.

", + "smithy.api#required": {} + } + }, + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -4724,34 +4754,34 @@ "com.amazonaws.lambda#PublishLayerVersionResponse": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.lambda#Description", - "traits": { - "smithy.api#documentation": "

The description of the version.

" - } - }, "LayerVersionArn": { "target": "com.amazonaws.lambda#LayerVersionArn", "traits": { "smithy.api#documentation": "

The ARN of the layer version.

" } }, - "Version": { - "target": "com.amazonaws.lambda#LayerVersionNumber", + "LicenseInfo": { + "target": "com.amazonaws.lambda#LicenseInfo", "traits": { - "smithy.api#documentation": "

The version number.

" + "smithy.api#documentation": "

The layer's software license.

" } }, - "CreatedDate": { - "target": "com.amazonaws.lambda#Timestamp", + "CompatibleRuntimes": { + "target": "com.amazonaws.lambda#CompatibleRuntimes", "traits": { - "smithy.api#documentation": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + "smithy.api#documentation": "

The layer's compatible runtimes.

" } }, - "LayerArn": { - "target": "com.amazonaws.lambda#LayerArn", + "Description": { + "target": "com.amazonaws.lambda#Description", "traits": { - "smithy.api#documentation": "

The ARN of the layer.

" + "smithy.api#documentation": "

The description of the version.

" + } + }, + "Version": { + "target": "com.amazonaws.lambda#LayerVersionNumber", + "traits": { + "smithy.api#documentation": "

The version number.

" } }, "Content": { @@ -4760,16 +4790,16 @@ "smithy.api#documentation": "

Details about the layer version.

" } }, - "CompatibleRuntimes": { - "target": "com.amazonaws.lambda#CompatibleRuntimes", + "LayerArn": { + "target": "com.amazonaws.lambda#LayerArn", "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes.

" + "smithy.api#documentation": "

The ARN of the layer.

" } }, - "LicenseInfo": { - "target": "com.amazonaws.lambda#LicenseInfo", + "CreatedDate": { + "target": "com.amazonaws.lambda#Timestamp", "traits": { - "smithy.api#documentation": "

The layer's software license.

" + "smithy.api#documentation": "

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" } } } @@ -4823,10 +4853,12 @@ "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid\n publishing a version if the function configuration has changed since you last updated it.

" } }, - "Description": { - "target": "com.amazonaws.lambda#Description", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

A description for the version to override the description in the function configuration.

" + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "CodeSha256": { @@ -4835,12 +4867,10 @@ "smithy.api#documentation": "

Only publish a version if the hash value matches the value that's specified. Use this option to avoid\n publishing a version if the function code has changed since you last updated it. You can get the hash for the\n version that you uploaded from the output of UpdateFunctionCode.

" } }, - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", + "Description": { + "target": "com.amazonaws.lambda#Description", "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the version to override the description in the function configuration.

" } } } @@ -4933,17 +4963,10 @@ "com.amazonaws.lambda#PutFunctionEventInvokeConfigRequest": { "type": "structure", "members": { - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

A version number or alias name.

", - "smithy.api#httpQuery": "Qualifier" - } - }, - "MaximumRetryAttempts": { - "target": "com.amazonaws.lambda#MaximumRetryAttempts", + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", "traits": { - "smithy.api#documentation": "

The maximum number of times to retry when the function returns an error.

" + "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" } }, "DestinationConfig": { @@ -4952,10 +4975,10 @@ "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n " } }, - "MaximumEventAgeInSeconds": { - "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttempts", "traits": { - "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" + "smithy.api#documentation": "

The maximum number of times to retry when the function returns an error.

" } }, "FunctionName": { @@ -4965,6 +4988,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" + } } } }, @@ -5005,14 +5035,6 @@ "com.amazonaws.lambda#PutProvisionedConcurrencyConfigRequest": { "type": "structure", "members": { - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", - "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "ProvisionedConcurrentExecutions": { "target": "com.amazonaws.lambda#PositiveInteger", "traits": { @@ -5027,22 +5049,36 @@ "smithy.api#httpQuery": "Qualifier", "smithy.api#required": {} } + }, + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", + "traits": { + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.lambda#PutProvisionedConcurrencyConfigResponse": { "type": "structure", "members": { - "AvailableProvisionedConcurrentExecutions": { + "AllocatedProvisionedConcurrentExecutions": { "target": "com.amazonaws.lambda#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

The amount of provisioned concurrency available.

" + "smithy.api#documentation": "

The amount of provisioned concurrency allocated.

" } }, - "Status": { - "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", + "LastModified": { + "target": "com.amazonaws.lambda#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the allocation process.

" + "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" + } + }, + "AvailableProvisionedConcurrentExecutions": { + "target": "com.amazonaws.lambda#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The amount of provisioned concurrency available.

" } }, "StatusReason": { @@ -5057,16 +5093,10 @@ "smithy.api#documentation": "

The amount of provisioned concurrency requested.

" } }, - "AllocatedProvisionedConcurrentExecutions": { - "target": "com.amazonaws.lambda#NonNegativeInteger", - "traits": { - "smithy.api#documentation": "

The amount of provisioned concurrency allocated.

" - } - }, - "LastModified": { - "target": "com.amazonaws.lambda#Timestamp", + "Status": { + "target": "com.amazonaws.lambda#ProvisionedConcurrencyStatusEnum", "traits": { - "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format.

" + "smithy.api#documentation": "

The status of the allocation process.

" } } } @@ -5123,12 +5153,11 @@ "smithy.api#required": {} } }, - "LayerName": { - "target": "com.amazonaws.lambda#LayerName", + "RevisionId": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#httpQuery": "RevisionId" } }, "StatementId": { @@ -5139,11 +5168,12 @@ "smithy.api#required": {} } }, - "RevisionId": { - "target": "com.amazonaws.lambda#String", + "LayerName": { + "target": "com.amazonaws.lambda#LayerName", "traits": { - "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", - "smithy.api#httpQuery": "RevisionId" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the layer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -5182,6 +5212,20 @@ "com.amazonaws.lambda#RemovePermissionRequest": { "type": "structure", "members": { + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", + "traits": { + "smithy.api#documentation": "

Specify a version or alias to remove permissions from a published version of the function.

", + "smithy.api#httpQuery": "Qualifier" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#httpQuery": "RevisionId" + } + }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { @@ -5197,30 +5241,16 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", - "traits": { - "smithy.api#documentation": "

Specify a version or alias to remove permissions from a published version of the function.

", - "smithy.api#httpQuery": "Qualifier" - } - }, - "RevisionId": { - "target": "com.amazonaws.lambda#String", - "traits": { - "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", - "smithy.api#httpQuery": "RevisionId" - } } } }, "com.amazonaws.lambda#RequestTooLargeException": { "type": "structure", "members": { - "Type": { + "message": { "target": "com.amazonaws.lambda#String" }, - "message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -5248,16 +5278,16 @@ "com.amazonaws.lambda#ResourceConflictException": { "type": "structure", "members": { - "Type": { + "message": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The exception type.

" + "smithy.api#documentation": "

The exception message.

" } }, - "message": { + "Type": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The exception message.

" + "smithy.api#documentation": "

The exception type.

" } } }, @@ -5270,10 +5300,10 @@ "com.amazonaws.lambda#ResourceInUseException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -5302,16 +5332,16 @@ "com.amazonaws.lambda#ResourceNotReadyException": { "type": "structure", "members": { - "message": { + "Type": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The exception message.

" + "smithy.api#documentation": "

The exception type.

" } }, - "Type": { + "message": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The exception type.

" + "smithy.api#documentation": "

The exception message.

" } } }, @@ -5359,6 +5389,10 @@ "value": "java8", "name": "java8" }, + { + "value": "java8.al2", + "name": "java8al2" + }, { "value": "java11", "name": "java11" @@ -5414,6 +5448,10 @@ { "value": "provided", "name": "provided" + }, + { + "value": "provided.al2", + "name": "providedal2" } ] } @@ -5578,10 +5616,10 @@ "com.amazonaws.lambda#SubnetIPAddressLimitReachedException": { "type": "structure", "members": { - "Type": { + "Message": { "target": "com.amazonaws.lambda#String" }, - "Message": { + "Type": { "target": "com.amazonaws.lambda#String" } }, @@ -5720,9 +5758,6 @@ "com.amazonaws.lambda#TooManyRequestsException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.lambda#String" - }, "retryAfterSeconds": { "target": "com.amazonaws.lambda#String", "traits": { @@ -5735,6 +5770,9 @@ }, "Reason": { "target": "com.amazonaws.lambda#ThrottleReason" + }, + "message": { + "target": "com.amazonaws.lambda#String" } }, "traits": { @@ -5743,6 +5781,28 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.lambda#Topic": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 249 + }, + "smithy.api#pattern": "^[^.]([a-zA-Z0-9\\-_.]+)" + } + }, + "com.amazonaws.lambda#Topics": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Topic" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.lambda#TracingConfig": { "type": "structure", "members": { @@ -5903,6 +5963,12 @@ "com.amazonaws.lambda#UpdateAliasRequest": { "type": "structure", "members": { + "FunctionVersion": { + "target": "com.amazonaws.lambda#Version", + "traits": { + "smithy.api#documentation": "

The function version that the alias invokes.

" + } + }, "Name": { "target": "com.amazonaws.lambda#Alias", "traits": { @@ -5911,10 +5977,12 @@ "smithy.api#required": {} } }, - "FunctionVersion": { - "target": "com.amazonaws.lambda#Version", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The function version that the alias invokes.

" + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "RoutingConfig": { @@ -5934,14 +6002,6 @@ "traits": { "smithy.api#documentation": "

A description of the alias.

" } - }, - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", - "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -5974,7 +6034,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\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#http": { "method": "PUT", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -5985,16 +6045,10 @@ "com.amazonaws.lambda#UpdateEventSourceMappingRequest": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.lambda#Enabled", - "traits": { - "smithy.api#documentation": "

Disables the event source mapping to pause polling and invocation.

" - } - }, - "MaximumBatchingWindowInSeconds": { - "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", + "BisectBatchOnFunctionError": { + "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", "traits": { - "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

" + "smithy.api#documentation": "

(Streams) If the function returns an error, split the batch in two and retry.

" } }, "DestinationConfig": { @@ -6003,18 +6057,16 @@ "smithy.api#documentation": "

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

" } }, - "UUID": { - "target": "com.amazonaws.lambda#String", + "MaximumRecordAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "

The identifier of the event source mapping.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

(Streams) Discard records older than the specified age. The default value is infinite (-1).

" } }, "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 " } }, "FunctionName": { @@ -6023,10 +6075,10 @@ "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

" } }, - "MaximumRecordAgeInSeconds": { - "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", + "Enabled": { + "target": "com.amazonaws.lambda#Enabled", "traits": { - "smithy.api#documentation": "

(Streams) The maximum age of a record that Lambda sends to a function for processing.

" + "smithy.api#documentation": "

If true, the event source mapping is active. Set to false to pause polling and invocation.

" } }, "ParallelizationFactor": { @@ -6035,16 +6087,24 @@ "smithy.api#documentation": "

(Streams) The number of batches to process from each shard concurrently.

" } }, - "MaximumRetryAttempts": { - "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "MaximumBatchingWindowInSeconds": { + "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

(Streams) The maximum number of times to retry when the function returns an error.

" + "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

" } }, - "BisectBatchOnFunctionError": { - "target": "com.amazonaws.lambda#BisectBatchOnFunctionError", + "UUID": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

(Streams) If the function returns an error, split the batch in two and retry.

" + "smithy.api#documentation": "

The identifier of the event source mapping.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", + "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 will be retried until the record expires.

" } } } @@ -6092,28 +6152,28 @@ "com.amazonaws.lambda#UpdateFunctionCodeRequest": { "type": "structure", "members": { - "S3Bucket": { - "target": "com.amazonaws.lambda#S3Bucket", + "S3ObjectVersion": { + "target": "com.amazonaws.lambda#S3ObjectVersion", "traits": { - "smithy.api#documentation": "

An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

" + "smithy.api#documentation": "

For versioned objects, the version of the deployment package object to use.

" } }, - "S3Key": { - "target": "com.amazonaws.lambda#S3Key", + "RevisionId": { + "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The Amazon S3 key of the deployment package.

" + "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" } }, - "S3ObjectVersion": { - "target": "com.amazonaws.lambda#S3ObjectVersion", + "Publish": { + "target": "com.amazonaws.lambda#Boolean", "traits": { - "smithy.api#documentation": "

For versioned objects, the version of the deployment package object to use.

" + "smithy.api#documentation": "

Set to true to publish a new version of the function after updating the code. This has the same effect as\n calling PublishVersion separately.

" } }, - "ZipFile": { - "target": "com.amazonaws.lambda#Blob", + "S3Bucket": { + "target": "com.amazonaws.lambda#S3Bucket", "traits": { - "smithy.api#documentation": "

The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for\n you.

" + "smithy.api#documentation": "

An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

" } }, "DryRun": { @@ -6122,24 +6182,24 @@ "smithy.api#documentation": "

Set to true to validate the request parameters and access permissions without modifying the function\n code.

" } }, - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", + "S3Key": { + "target": "com.amazonaws.lambda#S3Key", "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon S3 key of the deployment package.

" } }, - "RevisionId": { - "target": "com.amazonaws.lambda#String", + "ZipFile": { + "target": "com.amazonaws.lambda#Blob", "traits": { - "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" + "smithy.api#documentation": "

The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for\n you.

" } }, - "Publish": { - "target": "com.amazonaws.lambda#Boolean", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

Set to true to publish a new version of the function after updating the code. This has the same effect as\n calling PublishVersion separately.

" + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -6184,22 +6244,18 @@ "com.amazonaws.lambda#UpdateFunctionConfigurationRequest": { "type": "structure", "members": { - "RevisionId": { - "target": "com.amazonaws.lambda#String", - "traits": { - "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" - } - }, - "KMSKeyArn": { - "target": "com.amazonaws.lambda#KMSKeyArn", + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment\n variables. If it's not provided, AWS Lambda uses a default service key.

" + "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "MemorySize": { - "target": "com.amazonaws.lambda#MemorySize", + "VpcConfig": { + "target": "com.amazonaws.lambda#VpcConfig", "traits": { - "smithy.api#documentation": "

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU\n allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

" + "smithy.api#documentation": "

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more\n information, see VPC Settings.

" } }, "Description": { @@ -6208,28 +6264,16 @@ "smithy.api#documentation": "

A description of the function.

" } }, - "Layers": { - "target": "com.amazonaws.lambda#LayerList", - "traits": { - "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" - } - }, - "Handler": { - "target": "com.amazonaws.lambda#Handler", - "traits": { - "smithy.api#documentation": "

The name of the method within your code that Lambda calls to execute your function. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.

" - } - }, - "TracingConfig": { - "target": "com.amazonaws.lambda#TracingConfig", + "Runtime": { + "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with AWS\n X-Ray.

" + "smithy.api#documentation": "

The identifier of the function's runtime.

" } }, - "Timeout": { - "target": "com.amazonaws.lambda#Timeout", + "Role": { + "target": "com.amazonaws.lambda#RoleArn", "traits": { - "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function's execution role.

" } }, "FileSystemConfigs": { @@ -6238,30 +6282,34 @@ "smithy.api#documentation": "

Connection settings for an Amazon EFS file system.

" } }, - "Role": { - "target": "com.amazonaws.lambda#RoleArn", + "KMSKeyArn": { + "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function's execution role.

" + "smithy.api#documentation": "

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment\n variables. If it's not provided, AWS Lambda uses a default service key.

" } }, - "FunctionName": { - "target": "com.amazonaws.lambda#FunctionName", + "Environment": { + "target": "com.amazonaws.lambda#Environment", "traits": { - "smithy.api#documentation": "

The name of the Lambda function.

\n

\n Name formats\n

\n \n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Environment variables that are accessible from function code during execution.

" } }, - "Runtime": { - "target": "com.amazonaws.lambda#Runtime", + "TracingConfig": { + "target": "com.amazonaws.lambda#TracingConfig", "traits": { - "smithy.api#documentation": "

The identifier of the function's runtime.

" + "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with AWS\n X-Ray.

" } }, - "Environment": { - "target": "com.amazonaws.lambda#Environment", + "Layers": { + "target": "com.amazonaws.lambda#LayerList", "traits": { - "smithy.api#documentation": "

Environment variables that are accessible from function code during execution.

" + "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + } + }, + "MemorySize": { + "target": "com.amazonaws.lambda#MemorySize", + "traits": { + "smithy.api#documentation": "

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU\n allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

" } }, "DeadLetterConfig": { @@ -6270,10 +6318,22 @@ "smithy.api#documentation": "

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\n when they fail processing. For more information, see Dead Letter Queues.

" } }, - "VpcConfig": { - "target": "com.amazonaws.lambda#VpcConfig", + "Timeout": { + "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more\n information, see VPC Settings.

" + "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds.

" + } + }, + "Handler": { + "target": "com.amazonaws.lambda#Handler", + "traits": { + "smithy.api#documentation": "

The name of the method within your code that Lambda calls to execute your function. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Programming Model.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" } } } @@ -6320,17 +6380,16 @@ "smithy.api#required": {} } }, - "MaximumEventAgeInSeconds": { - "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", + "DestinationConfig": { + "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n " } }, - "Qualifier": { - "target": "com.amazonaws.lambda#Qualifier", + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.lambda#MaximumEventAgeInSeconds", "traits": { - "smithy.api#documentation": "

A version number or alias name.

", - "smithy.api#httpQuery": "Qualifier" + "smithy.api#documentation": "

The maximum age of a request that Lambda sends to a function for processing.

" } }, "MaximumRetryAttempts": { @@ -6339,10 +6398,11 @@ "smithy.api#documentation": "

The maximum number of times to retry when the function returns an error.

" } }, - "DestinationConfig": { - "target": "com.amazonaws.lambda#DestinationConfig", + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier", "traits": { - "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n " + "smithy.api#documentation": "

A version number or alias name.

", + "smithy.api#httpQuery": "Qualifier" } } } @@ -6360,17 +6420,17 @@ "com.amazonaws.lambda#VpcConfig": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.lambda#SubnetIds", - "traits": { - "smithy.api#documentation": "

A list of VPC subnet IDs.

" - } - }, "SecurityGroupIds": { "target": "com.amazonaws.lambda#SecurityGroupIds", "traits": { "smithy.api#documentation": "

A list of VPC security groups IDs.

" } + }, + "SubnetIds": { + "target": "com.amazonaws.lambda#SubnetIds", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs.

" + } } }, "traits": { @@ -6386,17 +6446,17 @@ "smithy.api#documentation": "

A list of VPC subnet IDs.

" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.lambda#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups IDs.

" - } - }, "VpcId": { "target": "com.amazonaws.lambda#VpcId", "traits": { "smithy.api#documentation": "

The ID of the VPC.

" } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.lambda#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups IDs.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/lex-model-building-service.2017-04-19.json b/codegen/sdk-codegen/aws-models/lex-model-building-service.2017-04-19.json index 9bb0771edb53..b62015ee7758 100644 --- a/codegen/sdk-codegen/aws-models/lex-model-building-service.2017-04-19.json +++ b/codegen/sdk-codegen/aws-models/lex-model-building-service.2017-04-19.json @@ -156,7 +156,7 @@ "sdkId": "Lex Model Building Service", "arnNamespace": "lex", "cloudFormationName": "LexModelBuildingService", - "cloudTrailEventSource": "modelbuilding.deepsense.amazonaws.com" + "cloudTrailEventSource": "lexmodelbuildingservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "lex" @@ -232,40 +232,40 @@ "smithy.api#documentation": "

A description of the bot alias.

" } }, - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#AliasName", "traits": { - "smithy.api#documentation": "

The name of the bot to which the alias points.

" + "smithy.api#documentation": "

The name of the bot alias.

" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The version of the Amazon Lex bot to which the alias points.

" + "smithy.api#documentation": "

Checksum of the bot alias.

" } }, - "lastUpdatedDate": { + "createdDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the bot alias was updated. When you create a resource, the creation date\n and last updated date are the same.

" + "smithy.api#documentation": "

The date that the bot alias was created.

" } }, - "createdDate": { + "lastUpdatedDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the bot alias was created.

" + "smithy.api#documentation": "

The date that the bot alias was updated. When you create a resource, the creation date\n and last updated date are the same.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#AliasName", + "botVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

The name of the bot alias.

" + "smithy.api#documentation": "

The version of the Amazon Lex bot to which the alias points.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

Checksum of the bot alias.

" + "smithy.api#documentation": "

The name of the bot to which the alias points.

" } } }, @@ -282,16 +282,10 @@ "com.amazonaws.lexmodelbuildingservice#BotChannelAssociation": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.lexmodelbuildingservice#ChannelStatus", - "traits": { - "smithy.api#documentation": "

The status of the bot channel.

\n " - } - }, - "failureReason": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "botConfiguration": { + "target": "com.amazonaws.lexmodelbuildingservice#ChannelConfigurationMap", "traits": { - "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to create the association.

" + "smithy.api#documentation": "

Provides information necessary to communicate with the messaging platform.

" } }, "type": { @@ -300,16 +294,22 @@ "smithy.api#documentation": "

Specifies the type of association by indicating the type of channel being established\n between the Amazon Lex bot and the external messaging platform.

" } }, - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "status": { + "target": "com.amazonaws.lexmodelbuildingservice#ChannelStatus", "traits": { - "smithy.api#documentation": "

The name of the Amazon Lex bot to which this association is being made.

\n \n

Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.

\n\n " + "smithy.api#documentation": "

The status of the bot channel.

\n " } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "failureReason": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

A text description of the association you are creating.

" + "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to create the association.

" + } + }, + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the association between the Amazon Lex bot and the channel was created.\n

" } }, "botAlias": { @@ -318,22 +318,22 @@ "smithy.api#documentation": "

An alias pointing to the specific version of the Amazon Lex bot to which this association is\n being made.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotChannelName", + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

The name of the association between the bot and the channel.

" + "smithy.api#documentation": "

The name of the Amazon Lex bot to which this association is being made.

\n \n

Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.

\n\n " } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotChannelName", "traits": { - "smithy.api#documentation": "

The date that the association between the Amazon Lex bot and the channel was created.\n

" + "smithy.api#documentation": "

The name of the association between the bot and the channel.

" } }, - "botConfiguration": { - "target": "com.amazonaws.lexmodelbuildingservice#ChannelConfigurationMap", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

Provides information necessary to communicate with the messaging platform.

" + "smithy.api#documentation": "

A text description of the association you are creating.

" } } }, @@ -360,10 +360,22 @@ "com.amazonaws.lexmodelbuildingservice#BotMetadata": { "type": "structure", "members": { - "lastUpdatedDate": { + "createdDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the bot was updated. When you create a bot, the creation date and last\n updated date are the same.

" + "smithy.api#documentation": "

The date that the bot was created.

" + } + }, + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the bot.

" + } + }, + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", + "traits": { + "smithy.api#documentation": "

The version of the bot. For a new bot, the version is always\n $LATEST.

" } }, "status": { @@ -378,22 +390,10 @@ "smithy.api#documentation": "

A description of the bot.

" } }, - "createdDate": { + "lastUpdatedDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the bot was created.

" - } - }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", - "traits": { - "smithy.api#documentation": "

The version of the bot. For a new bot, the version is always\n $LATEST.

" - } - }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the bot.

" + "smithy.api#documentation": "

The date that the bot was updated. When you create a bot, the creation date and last\n updated date are the same.

" } } }, @@ -587,6 +587,15 @@ "smithy.api#documentation": "

Specifies a Lambda function that verifies requests to a bot or fulfills the user's\n request to a bot..

" } }, + "com.amazonaws.lexmodelbuildingservice#ConfidenceThreshold": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.lexmodelbuildingservice#ConflictException": { "type": "structure", "members": { @@ -631,17 +640,17 @@ "com.amazonaws.lexmodelbuildingservice#ConversationLogsRequest": { "type": "structure", "members": { - "iamRoleArn": { - "target": "com.amazonaws.lexmodelbuildingservice#IamRoleArn", + "logSettings": { + "target": "com.amazonaws.lexmodelbuildingservice#LogSettingsRequestList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch\n Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this\n role also provides access permission for the AWS KMS key used for encrypting audio logs. For\n more information, see Creating an IAM Role and Policy\n for Conversation Logs.

", + "smithy.api#documentation": "

The settings for your conversation logs. You can log the conversation text, conversation\n audio, or both.

", "smithy.api#required": {} } }, - "logSettings": { - "target": "com.amazonaws.lexmodelbuildingservice#LogSettingsRequestList", + "iamRoleArn": { + "target": "com.amazonaws.lexmodelbuildingservice#IamRoleArn", "traits": { - "smithy.api#documentation": "

The settings for your conversation logs. You can log the conversation text, conversation\n audio, or both.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch\n Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this\n role also provides access permission for the AWS KMS key used for encrypting audio logs. For\n more information, see Creating an IAM Role and Policy\n for Conversation Logs.

", "smithy.api#required": {} } } @@ -653,17 +662,17 @@ "com.amazonaws.lexmodelbuildingservice#ConversationLogsResponse": { "type": "structure", "members": { - "iamRoleArn": { - "target": "com.amazonaws.lexmodelbuildingservice#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs\n or an S3 bucket.

" - } - }, "logSettings": { "target": "com.amazonaws.lexmodelbuildingservice#LogSettingsResponseList", "traits": { "smithy.api#documentation": "

The settings for your conversation logs. You can log text, audio, or both.

" } + }, + "iamRoleArn": { + "target": "com.amazonaws.lexmodelbuildingservice#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs\n or an S3 bucket.

" + } } }, "traits": { @@ -716,6 +725,12 @@ "com.amazonaws.lexmodelbuildingservice#CreateBotVersionRequest": { "type": "structure", "members": { + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", + "traits": { + "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version of the bot. If you\n specify a checksum and the $LATEST version of the bot has a different checksum, a\n PreconditionFailedException exception is returned and Amazon Lex doesn't publish a\n new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST\n version.

" + } + }, "name": { "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { @@ -723,58 +738,58 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", - "traits": { - "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version of the bot. If you\n specify a checksum and the $LATEST version of the bot has a different checksum, a\n PreconditionFailedException exception is returned and Amazon Lex doesn't publish a\n new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST\n version.

" - } } } }, "com.amazonaws.lexmodelbuildingservice#CreateBotVersionResponse": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "failureReason": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The version of the bot.

" + "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to build the bot.

" } }, - "intents": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentList", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

An array of Intent objects. For more information, see PutBot.

" + "smithy.api#documentation": "

The date when the $LATEST version of this bot was updated.

" } }, - "childDirected": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify\n whether your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to the\n Children's Online Privacy Protection Act (COPPA) by specifying true or\n false in the childDirected field. By specifying true\n in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By\n specifying false in the childDirected field, you confirm that your\n use of Amazon Lex is not related to a website, program, or other\n application that is directed or targeted, in whole or in part, to children under age 13 and\n subject to COPPA. You may not specify a default value for the childDirected field\n that does not accurately reflect whether your use of Amazon Lex is related to a website, program,\n or other application that is directed or targeted, in whole or in part, to children under age\n 13 and subject to COPPA.

\n

If your use of Amazon Lex relates to a website, program, or other application that is\n directed in whole or in part, to children under age 13, you must obtain any required\n verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in\n connection with websites, programs, or other applications that are directed or targeted, in\n whole or in part, to children under age 13, see the Amazon Lex FAQ.\n

" + "smithy.api#documentation": "

The date when the bot version was created.

" } }, - "checksum": { + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.lexmodelbuildingservice#SessionTTL", + "traits": { + "smithy.api#documentation": "

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For\n more information, see PutBot.

" + } + }, + "voiceId": { "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

Checksum identifying the version of the bot that was created.

" + "smithy.api#documentation": "

The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the\n user.

" } }, - "detectSentiment": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "intents": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentList", "traits": { - "smithy.api#documentation": "

Indicates whether utterances entered by the user should be sent to Amazon Comprehend for\n sentiment analysis.

" + "smithy.api#documentation": "

An array of Intent objects. For more information, see PutBot.

" } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "detectSentiment": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

A description of the bot.

" + "smithy.api#documentation": "

Indicates whether utterances entered by the user should be sent to Amazon Comprehend for\n sentiment analysis.

" } }, - "abortStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "status": { + "target": "com.amazonaws.lexmodelbuildingservice#Status", "traits": { - "smithy.api#documentation": "

The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.

" + "smithy.api#documentation": "

When you send a request to create or update a bot, Amazon Lex sets the status\n response element to BUILDING. After Amazon Lex builds the bot, it sets\n status to READY. If Amazon Lex can't build the bot, it sets\n status to FAILED. Amazon Lex returns the reason for the failure in the\n failureReason response element.

" } }, "locale": { @@ -783,46 +798,46 @@ "smithy.api#documentation": "

Specifies the target locale for the bot.

" } }, - "status": { - "target": "com.amazonaws.lexmodelbuildingservice#Status", + "childDirected": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

When you send a request to create or update a bot, Amazon Lex sets the status\n response element to BUILDING. After Amazon Lex builds the bot, it sets\n status to READY. If Amazon Lex can't build the bot, it sets\n status to FAILED. Amazon Lex returns the reason for the failure in the\n failureReason response element.

" + "smithy.api#documentation": "

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify\n whether your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to the\n Children's Online Privacy Protection Act (COPPA) by specifying true or\n false in the childDirected field. By specifying true\n in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By\n specifying false in the childDirected field, you confirm that your\n use of Amazon Lex is not related to a website, program, or other\n application that is directed or targeted, in whole or in part, to children under age 13 and\n subject to COPPA. You may not specify a default value for the childDirected field\n that does not accurately reflect whether your use of Amazon Lex is related to a website, program,\n or other application that is directed or targeted, in whole or in part, to children under age\n 13 and subject to COPPA.

\n

If your use of Amazon Lex relates to a website, program, or other application that is\n directed in whole or in part, to children under age 13, you must obtain any required\n verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in\n connection with websites, programs, or other applications that are directed or targeted, in\n whole or in part, to children under age 13, see the Amazon Lex FAQ.\n

" } }, - "clarificationPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

The message that Amazon Lex uses when it doesn't understand the user's request. For more\n information, see PutBot.

" + "smithy.api#documentation": "

The version of the bot.

" } }, - "voiceId": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the\n user.

" + "smithy.api#documentation": "

A description of the bot.

" } }, - "failureReason": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "enableModelImprovements": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to build the bot.

" + "smithy.api#documentation": "

Indicates whether the bot uses accuracy improvements. true \n indicates that the bot is using the improvements, otherwise, false.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "clarificationPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

The date when the $LATEST version of this bot was updated.

" + "smithy.api#documentation": "

The message that Amazon Lex uses when it doesn't understand the user's request. For more\n information, see PutBot.

" } }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.lexmodelbuildingservice#SessionTTL", + "abortStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For\n more information, see PutBot.

" + "smithy.api#documentation": "

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The date when the bot version was created.

" + "smithy.api#documentation": "

Checksum identifying the version of the bot that was created.

" } }, "name": { @@ -892,64 +907,58 @@ "com.amazonaws.lexmodelbuildingservice#CreateIntentVersionResponse": { "type": "structure", "members": { - "kendraConfiguration": { - "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", "traits": { - "smithy.api#documentation": "

Configuration information, if any, for connectin an Amazon Kendra index with the\n AMAZON.KendraSearchIntent intent.

" + "smithy.api#documentation": "

The name of the intent.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "dialogCodeHook": { + "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", "traits": { - "smithy.api#documentation": "

Checksum of the intent version created.

" + "smithy.api#documentation": "

If defined, Amazon Lex invokes this Lambda function for each user input.

" } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "parentIntentSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", "traits": { - "smithy.api#documentation": "

A description of the intent.

" + "smithy.api#documentation": "

A unique identifier for a built-in intent.

" } }, - "fulfillmentActivity": { - "target": "com.amazonaws.lexmodelbuildingservice#FulfillmentActivity", - "traits": { - "smithy.api#documentation": "

Describes how the intent is fulfilled.

" - } - }, - "confirmationPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", + "conclusionStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

If defined, the prompt that Amazon Lex uses to confirm the user's intent before\n fulfilling it.

" + "smithy.api#documentation": "

After the Lambda function specified in the fulfillmentActivity field\n fulfills the intent, Amazon Lex conveys this statement to the user.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "kendraConfiguration": { + "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", "traits": { - "smithy.api#documentation": "

The date that the intent was created.

" + "smithy.api#documentation": "

Configuration information, if any, for connecting an Amazon Kendra index with the\n AMAZON.KendraSearchIntent intent.

" } }, - "rejectionStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

If the user answers \"no\" to the question defined in confirmationPrompt,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" + "smithy.api#documentation": "

Checksum of the intent version created.

" } }, - "parentIntentSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", + "confirmationPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

A unique identifier for a built-in intent.

" + "smithy.api#documentation": "

If defined, the prompt that Amazon Lex uses to confirm the user's intent before\n fulfilling it.

" } }, - "sampleUtterances": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentUtteranceList", + "fulfillmentActivity": { + "target": "com.amazonaws.lexmodelbuildingservice#FulfillmentActivity", "traits": { - "smithy.api#documentation": "

An array of sample utterances configured for the intent.

" + "smithy.api#documentation": "

Describes how the intent is fulfilled.

" } }, - "dialogCodeHook": { - "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

If defined, Amazon Lex invokes this Lambda function for each user input.

" + "smithy.api#documentation": "

The version number assigned to the new version of the intent.

" } }, "slots": { @@ -958,34 +967,40 @@ "smithy.api#documentation": "

An array of slot types that defines the information required to fulfill the\n intent.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "followUpPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#FollowUpPrompt", "traits": { - "smithy.api#documentation": "

The name of the intent.

" + "smithy.api#documentation": "

If defined, Amazon Lex uses this prompt to solicit additional user activity after the\n intent is fulfilled.

" } }, - "conclusionStatement": { + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the intent was created.

" + } + }, + "rejectionStatement": { "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

After the Lambda function specified in the fulfillmentActivity field\n fulfills the intent, Amazon Lex conveys this statement to the user.

" + "smithy.api#documentation": "

If the user answers \"no\" to the question defined in confirmationPrompt,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "sampleUtterances": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentUtteranceList", "traits": { - "smithy.api#documentation": "

The date that the intent was updated.

" + "smithy.api#documentation": "

An array of sample utterances configured for the intent.

" } }, - "followUpPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#FollowUpPrompt", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

If defined, Amazon Lex uses this prompt to solicit additional user activity after the\n intent is fulfilled.

" + "smithy.api#documentation": "

A description of the intent.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The version number assigned to the new version of the intent.

" + "smithy.api#documentation": "

The date that the intent was updated.

" } } } @@ -1049,10 +1064,10 @@ "com.amazonaws.lexmodelbuildingservice#CreateSlotTypeVersionResponse": { "type": "structure", "members": { - "valueSelectionStrategy": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotValueSelectionStrategy", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The strategy that Amazon Lex uses to determine the value of the slot. For more information,\n see PutSlotType.

" + "smithy.api#documentation": "

The date that the slot type was created.

" } }, "slotTypeConfigurations": { @@ -1061,28 +1076,22 @@ "smithy.api#documentation": "

Configuration information that extends the parent built-in slot type.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the slot type was created.

" - } - }, - "parentSlotTypeSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

The built-in slot type used a the parent of the slot type.

" + "smithy.api#documentation": "

The version assigned to the new slot type version.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "valueSelectionStrategy": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotValueSelectionStrategy", "traits": { - "smithy.api#documentation": "

The date that the slot type was updated. When you create a resource, the creation date\n and last update date are the same.

" + "smithy.api#documentation": "

The strategy that Amazon Lex uses to determine the value of the slot. For more information,\n see PutSlotType.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeName", + "enumerationValues": { + "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", "traits": { - "smithy.api#documentation": "

The name of the slot type.

" + "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take.

" } }, "checksum": { @@ -1091,22 +1100,28 @@ "smithy.api#documentation": "

Checksum of the $LATEST version of the slot type.

" } }, + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeName", + "traits": { + "smithy.api#documentation": "

The name of the slot type.

" + } + }, "description": { "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { "smithy.api#documentation": "

A description of the slot type.

" } }, - "enumerationValues": { - "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", + "parentSlotTypeSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", "traits": { - "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take.

" + "smithy.api#documentation": "

The built-in slot type used a the parent of the slot type.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The version assigned to the new slot type version.

" + "smithy.api#documentation": "

The date that the slot type was updated. When you create a resource, the creation date\n and last update date are the same.

" } } } @@ -1192,18 +1207,18 @@ "com.amazonaws.lexmodelbuildingservice#DeleteBotAliasRequest": { "type": "structure", "members": { - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#AliasName", "traits": { - "smithy.api#documentation": "

The name of the bot that the alias points to.

", + "smithy.api#documentation": "

The name of the alias to delete. The name is case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#AliasName", + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

The name of the alias to delete. The name is case sensitive.

", + "smithy.api#documentation": "

The name of the bot that the alias points to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1244,14 +1259,6 @@ "com.amazonaws.lexmodelbuildingservice#DeleteBotChannelAssociationRequest": { "type": "structure", "members": { - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Lex bot.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "botAlias": { "target": "com.amazonaws.lexmodelbuildingservice#AliasName", "traits": { @@ -1267,6 +1274,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Lex bot.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -1320,18 +1335,18 @@ "com.amazonaws.lexmodelbuildingservice#DeleteBotVersionRequest": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#NumericalVersion", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

The version of the bot to delete. You cannot delete the $LATEST version of\n the bot. To delete the $LATEST version, use the DeleteBot\n operation.

", + "smithy.api#documentation": "

The name of the bot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#NumericalVersion", "traits": { - "smithy.api#documentation": "

The name of the bot.

", + "smithy.api#documentation": "

The version of the bot to delete. You cannot delete the $LATEST version of\n the bot. To delete the $LATEST version, use the DeleteBot\n operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1422,18 +1437,18 @@ "com.amazonaws.lexmodelbuildingservice#DeleteIntentVersionRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#NumericalVersion", "traits": { - "smithy.api#documentation": "

The name of the intent.

", + "smithy.api#documentation": "

The version of the intent to delete. You cannot delete the $LATEST version\n of the intent. To delete the $LATEST version, use the DeleteIntent operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#NumericalVersion", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", "traits": { - "smithy.api#documentation": "

The version of the intent to delete. You cannot delete the $LATEST version\n of the intent. To delete the $LATEST version, use the DeleteIntent operation.

", + "smithy.api#documentation": "

The name of the intent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1618,18 +1633,18 @@ "com.amazonaws.lexmodelbuildingservice#EnumerationValue": { "type": "structure", "members": { + "synonyms": { + "target": "com.amazonaws.lexmodelbuildingservice#SynonymList", + "traits": { + "smithy.api#documentation": "

Additional values related to the slot type value.

" + } + }, "value": { "target": "com.amazonaws.lexmodelbuildingservice#Value", "traits": { "smithy.api#documentation": "

The value of the slot type.

", "smithy.api#required": {} } - }, - "synonyms": { - "target": "com.amazonaws.lexmodelbuildingservice#SynonymList", - "traits": { - "smithy.api#documentation": "

Additional values related to the slot type value.

" - } } }, "traits": { @@ -1685,17 +1700,17 @@ "com.amazonaws.lexmodelbuildingservice#FollowUpPrompt": { "type": "structure", "members": { - "rejectionStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "prompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

If the user answers \"no\" to the question defined in the prompt field,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

", + "smithy.api#documentation": "

Prompts for information from the user.

", "smithy.api#required": {} } }, - "prompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", + "rejectionStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

Prompts for information from the user.

", + "smithy.api#documentation": "

If the user answers \"no\" to the question defined in the prompt field,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

", "smithy.api#required": {} } } @@ -1805,18 +1820,18 @@ "com.amazonaws.lexmodelbuildingservice#GetBotAliasRequest": { "type": "structure", "members": { - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#AliasName", "traits": { - "smithy.api#documentation": "

The name of the bot.

", + "smithy.api#documentation": "

The name of the bot alias. The name is case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#AliasName", + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

The name of the bot alias. The name is case sensitive.

", + "smithy.api#documentation": "

The name of the bot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1826,52 +1841,52 @@ "com.amazonaws.lexmodelbuildingservice#GetBotAliasResponse": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

A description of the bot alias.

" + "smithy.api#documentation": "

Checksum of the bot alias.

" } }, - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#AliasName", "traits": { - "smithy.api#documentation": "

The name of the bot that the alias points to.

" + "smithy.api#documentation": "

The name of the bot alias.

" } }, - "lastUpdatedDate": { + "createdDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the bot alias was updated. When you create a resource, the creation date\n and the last updated date are the same.

" + "smithy.api#documentation": "

The date that the bot alias was created.

" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "conversationLogs": { + "target": "com.amazonaws.lexmodelbuildingservice#ConversationLogsResponse", "traits": { - "smithy.api#documentation": "

The version of the bot that the alias points to.

" + "smithy.api#documentation": "

The settings that determine how Amazon Lex uses conversation logs for the alias.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "botVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

The date that the bot alias was created.

" + "smithy.api#documentation": "

The version of the bot that the alias points to.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

Checksum of the bot alias.

" + "smithy.api#documentation": "

A description of the bot alias.

" } }, - "conversationLogs": { - "target": "com.amazonaws.lexmodelbuildingservice#ConversationLogsResponse", + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

The settings that determine how Amazon Lex uses conversation logs for the alias.

" + "smithy.api#documentation": "

The name of the bot that the alias points to.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#AliasName", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the bot alias.

" + "smithy.api#documentation": "

The date that the bot alias was updated. When you create a resource, the creation date\n and the last updated date are the same.

" } } } @@ -1919,13 +1934,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "nameContains": { - "target": "com.amazonaws.lexmodelbuildingservice#AliasName", - "traits": { - "smithy.api#documentation": "

Substring to match in bot alias names. An alias will be returned if any part of its\n name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", - "smithy.api#httpQuery": "nameContains" - } - }, "maxResults": { "target": "com.amazonaws.lexmodelbuildingservice#MaxResults", "traits": { @@ -1940,23 +1948,30 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "nameContains": { + "target": "com.amazonaws.lexmodelbuildingservice#AliasName", + "traits": { + "smithy.api#documentation": "

Substring to match in bot alias names. An alias will be returned if any part of its\n name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "smithy.api#httpQuery": "nameContains" + } } } }, "com.amazonaws.lexmodelbuildingservice#GetBotAliasesResponse": { "type": "structure", "members": { - "BotAliases": { - "target": "com.amazonaws.lexmodelbuildingservice#BotAliasMetadataList", - "traits": { - "smithy.api#documentation": "

An array of BotAliasMetadata objects, each describing a bot\n alias.

" - } - }, "nextToken": { "target": "com.amazonaws.lexmodelbuildingservice#NextToken", "traits": { "smithy.api#documentation": "

A pagination token for fetching next page of aliases. If the response to this call is\n truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n aliases, specify the pagination token in the next request.

" } + }, + "BotAliases": { + "target": "com.amazonaws.lexmodelbuildingservice#BotAliasMetadataList", + "traits": { + "smithy.api#documentation": "

An array of BotAliasMetadata objects, each describing a bot\n alias.

" + } } } }, @@ -1994,10 +2009,10 @@ "com.amazonaws.lexmodelbuildingservice#GetBotChannelAssociationRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotChannelName", + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

The name of the association between the bot and the channel. The name is case\n sensitive.

", + "smithy.api#documentation": "

The name of the Amazon Lex bot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2010,10 +2025,10 @@ "smithy.api#required": {} } }, - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotChannelName", "traits": { - "smithy.api#documentation": "

The name of the Amazon Lex bot.

", + "smithy.api#documentation": "

The name of the association between the bot and the channel. The name is case\n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2029,22 +2044,10 @@ "smithy.api#documentation": "

An alias pointing to the specific version of the Amazon Lex bot to which this association is\n being made.

" } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", - "traits": { - "smithy.api#documentation": "

A description of the association between the bot and the channel.

" - } - }, - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Lex bot.

" - } - }, - "failureReason": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotChannelName", "traits": { - "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to create the association.

" + "smithy.api#documentation": "

The name of the association between the bot and the channel.

" } }, "createdDate": { @@ -2053,12 +2056,6 @@ "smithy.api#documentation": "

The date that the association between the bot and the channel was created.

" } }, - "type": { - "target": "com.amazonaws.lexmodelbuildingservice#ChannelType", - "traits": { - "smithy.api#documentation": "

The type of the messaging platform.

" - } - }, "botConfiguration": { "target": "com.amazonaws.lexmodelbuildingservice#ChannelConfigurationMap", "traits": { @@ -2071,10 +2068,28 @@ "smithy.api#documentation": "

The status of the bot channel.

\n " } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotChannelName", + "failureReason": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The name of the association between the bot and the channel.

" + "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to create the association.

" + } + }, + "type": { + "target": "com.amazonaws.lexmodelbuildingservice#ChannelType", + "traits": { + "smithy.api#documentation": "

The type of the messaging platform.

" + } + }, + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Lex bot.

" + } + }, + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", + "traits": { + "smithy.api#documentation": "

A description of the association between the bot and the channel.

" } } } @@ -2137,6 +2152,13 @@ "smithy.api#required": {} } }, + "nextToken": { + "target": "com.amazonaws.lexmodelbuildingservice#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token for fetching the next page of associations. If the response to this\n call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n associations, specify the pagination token in the next request.

", + "smithy.api#httpQuery": "nextToken" + } + }, "botAlias": { "target": "com.amazonaws.lexmodelbuildingservice#AliasNameOrListAll", "traits": { @@ -2144,13 +2166,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.lexmodelbuildingservice#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token for fetching the next page of associations. If the response to this\n call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n associations, specify the pagination token in the next request.

", - "smithy.api#httpQuery": "nextToken" - } } } }, @@ -2195,28 +2210,28 @@ "com.amazonaws.lexmodelbuildingservice#GetBotResponse": { "type": "structure", "members": { - "abortStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "clarificationPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

The message that Amazon Lex returns when the user elects to end the conversation without\n completing it. For more information, see PutBot.

" + "smithy.api#documentation": "

The message Amazon Lex uses when it doesn't understand the user's request. For more\n information, see PutBot.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The version of the bot. For a new bot, the version is always\n $LATEST.

" + "smithy.api#documentation": "

The date that the bot was updated. When you create a resource, the creation date and\n last updated date are the same.

" } }, - "intents": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentList", + "detectSentiment": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

An array of intent objects. For more information, see PutBot.

" + "smithy.api#documentation": "

Indicates whether user utterances should be sent to Amazon Comprehend for sentiment\n analysis.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

Checksum of the bot used to identify a specific revision of the bot's\n $LATEST version.

" + "smithy.api#documentation": "

A description of the bot.

" } }, "idleSessionTTLInSeconds": { @@ -2225,16 +2240,10 @@ "smithy.api#documentation": "

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For\n more information, see PutBot.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the bot.

" - } - }, - "status": { - "target": "com.amazonaws.lexmodelbuildingservice#Status", + "locale": { + "target": "com.amazonaws.lexmodelbuildingservice#Locale", "traits": { - "smithy.api#documentation": "

The status of the bot.

\n

When the status is BUILDING Amazon Lex is building the bot for testing and\n use.

\n

If the status of the bot is READY_BASIC_TESTING, you can test the bot\n using the exact utterances specified in the bot's intents. When the bot is ready for full\n testing or to run, the status is READY.

\n

If there was a problem with building the bot, the status is FAILED and the\n failureReason field explains why the bot did not build.

\n

If the bot was saved but not built, the status is NOT_BUILT.

" + "smithy.api#documentation": "

The target locale for the bot.

" } }, "failureReason": { @@ -2243,22 +2252,16 @@ "smithy.api#documentation": "

If status is FAILED, Amazon Lex explains why it failed to build\n the bot.

" } }, - "clarificationPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", - "traits": { - "smithy.api#documentation": "

The message Amazon Lex uses when it doesn't understand the user's request. For more\n information, see PutBot.

" - } - }, - "childDirected": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify\n whether your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to the\n Children's Online Privacy Protection Act (COPPA) by specifying true or\n false in the childDirected field. By specifying true\n in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By\n specifying false in the childDirected field, you confirm that your\n use of Amazon Lex is not related to a website, program, or other\n application that is directed or targeted, in whole or in part, to children under age 13 and\n subject to COPPA. You may not specify a default value for the childDirected field\n that does not accurately reflect whether your use of Amazon Lex is related to a website, program,\n or other application that is directed or targeted, in whole or in part, to children under age\n 13 and subject to COPPA.

\n

If your use of Amazon Lex relates to a website, program, or other application that is\n directed in whole or in part, to children under age 13, you must obtain any required\n verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in\n connection with websites, programs, or other applications that are directed or targeted, in\n whole or in part, to children under age 13, see the Amazon Lex FAQ.\n

" + "smithy.api#documentation": "

The version of the bot. For a new bot, the version is always\n $LATEST.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "intents": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentList", "traits": { - "smithy.api#documentation": "

The date that the bot was created.

" + "smithy.api#documentation": "

An array of intent objects. For more information, see PutBot.

" } }, "voiceId": { @@ -2267,28 +2270,52 @@ "smithy.api#documentation": "

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more\n information, see PutBot.

" } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "abortStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

A description of the bot.

" + "smithy.api#documentation": "

The message that Amazon Lex returns when the user elects to end the conversation without\n completing it. For more information, see PutBot.

" } }, - "locale": { - "target": "com.amazonaws.lexmodelbuildingservice#Locale", + "enableModelImprovements": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

The target locale for the bot.

" + "smithy.api#documentation": "

Indicates whether the bot uses accuracy improvements. true \n indicates that the bot is using the improvements, otherwise, false.

" } }, - "detectSentiment": { + "childDirected": { "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether user utterances should be sent to Amazon Comprehend for sentiment\n analysis.

" + "smithy.api#documentation": "

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify\n whether your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to the\n Children's Online Privacy Protection Act (COPPA) by specifying true or\n false in the childDirected field. By specifying true\n in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By\n specifying false in the childDirected field, you confirm that your\n use of Amazon Lex is not related to a website, program, or other\n application that is directed or targeted, in whole or in part, to children under age 13 and\n subject to COPPA. You may not specify a default value for the childDirected field\n that does not accurately reflect whether your use of Amazon Lex is related to a website, program,\n or other application that is directed or targeted, in whole or in part, to children under age\n 13 and subject to COPPA.

\n

If your use of Amazon Lex relates to a website, program, or other application that is\n directed in whole or in part, to children under age 13, you must obtain any required\n verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in\n connection with websites, programs, or other applications that are directed or targeted, in\n whole or in part, to children under age 13, see the Amazon Lex FAQ.\n

" } }, - "lastUpdatedDate": { + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the bot.

" + } + }, + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", + "traits": { + "smithy.api#documentation": "

Checksum of the bot used to identify a specific revision of the bot's\n $LATEST version.

" + } + }, + "status": { + "target": "com.amazonaws.lexmodelbuildingservice#Status", + "traits": { + "smithy.api#documentation": "

The status of the bot.

\n

When the status is BUILDING Amazon Lex is building the bot for testing and\n use.

\n

If the status of the bot is READY_BASIC_TESTING, you can test the bot\n using the exact utterances specified in the bot's intents. When the bot is ready for full\n testing or to run, the status is READY.

\n

If there was a problem with building the bot, the status is FAILED and the\n failureReason field explains why the bot did not build.

\n

If the bot was saved but not built, the status is NOT_BUILT.

" + } + }, + "createdDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the bot was updated. When you create a resource, the creation date and\n last updated date are the same.

" + "smithy.api#documentation": "

The date that the bot was created.

" + } + }, + "nluIntentConfidenceThreshold": { + "target": "com.amazonaws.lexmodelbuildingservice#ConfidenceThreshold", + "traits": { + "smithy.api#documentation": "

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent,\n AMAZON.KendraSearchIntent, or both when returning alternative intents in a\n PostContent or PostText response.\n AMAZON.FallbackIntent is inserted if the confidence score for all intents is\n below this value. AMAZON.KendraSearchIntent is only inserted if it is configured\n for the bot.

" } } } @@ -2339,13 +2366,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "maxResults": { - "target": "com.amazonaws.lexmodelbuildingservice#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of bot versions to return in the response. The default is\n 10.

", - "smithy.api#httpQuery": "maxResults" - } - }, "name": { "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { @@ -2353,23 +2373,30 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelbuildingservice#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of bot versions to return in the response. The default is\n 10.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.lexmodelbuildingservice#GetBotVersionsResponse": { "type": "structure", "members": { - "bots": { - "target": "com.amazonaws.lexmodelbuildingservice#BotMetadataList", - "traits": { - "smithy.api#documentation": "

An array of BotMetadata objects, one for each numbered version of the bot\n plus one for the $LATEST version.

" - } - }, "nextToken": { "target": "com.amazonaws.lexmodelbuildingservice#NextToken", "traits": { "smithy.api#documentation": "

A pagination token for fetching the next page of bot versions. If the response to this\n call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n versions, specify the pagination token in the next request.

" } + }, + "bots": { + "target": "com.amazonaws.lexmodelbuildingservice#BotMetadataList", + "traits": { + "smithy.api#documentation": "

An array of BotMetadata objects, one for each numbered version of the bot\n plus one for the $LATEST version.

" + } } } }, @@ -2419,19 +2446,19 @@ "smithy.api#httpQuery": "nextToken" } }, - "nameContains": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", - "traits": { - "smithy.api#documentation": "

Substring to match in bot names. A bot will be returned if any part of its name matches\n the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", - "smithy.api#httpQuery": "nameContains" - } - }, "maxResults": { "target": "com.amazonaws.lexmodelbuildingservice#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of bots to return in the response that the request will return. The\n default is 10.

", "smithy.api#httpQuery": "maxResults" } + }, + "nameContains": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "traits": { + "smithy.api#documentation": "

Substring to match in bot names. A bot will be returned if any part of its name matches\n the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "smithy.api#httpQuery": "nameContains" + } } } }, @@ -2499,10 +2526,10 @@ "com.amazonaws.lexmodelbuildingservice#GetBuiltinIntentResponse": { "type": "structure", "members": { - "slots": { - "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSlotList", + "supportedLocales": { + "target": "com.amazonaws.lexmodelbuildingservice#LocaleList", "traits": { - "smithy.api#documentation": "

An array of BuiltinIntentSlot objects, one entry for each slot type in the\n intent.

" + "smithy.api#documentation": "

A list of locales that the intent supports.

" } }, "signature": { @@ -2511,10 +2538,10 @@ "smithy.api#documentation": "

The unique identifier for a built-in intent.

" } }, - "supportedLocales": { - "target": "com.amazonaws.lexmodelbuildingservice#LocaleList", + "slots": { + "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSlotList", "traits": { - "smithy.api#documentation": "

A list of locales that the intent supports.

" + "smithy.api#documentation": "

An array of BuiltinIntentSlot objects, one entry for each slot type in the\n intent.

" } } } @@ -2555,18 +2582,11 @@ "com.amazonaws.lexmodelbuildingservice#GetBuiltinIntentsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.lexmodelbuildingservice#NextToken", + "signatureContains": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

A pagination token that fetches the next page of intents. If this API call is\n truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n intents, use the pagination token in the next request.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "locale": { - "target": "com.amazonaws.lexmodelbuildingservice#Locale", - "traits": { - "smithy.api#documentation": "

A list of locales that the intent supports.

", - "smithy.api#httpQuery": "locale" + "smithy.api#documentation": "

Substring to match in built-in intent signatures. An intent will be returned if any\n part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and\n \"abcxyz.\" To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

", + "smithy.api#httpQuery": "signatureContains" } }, "maxResults": { @@ -2576,11 +2596,18 @@ "smithy.api#httpQuery": "maxResults" } }, - "signatureContains": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "nextToken": { + "target": "com.amazonaws.lexmodelbuildingservice#NextToken", "traits": { - "smithy.api#documentation": "

Substring to match in built-in intent signatures. An intent will be returned if any\n part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and\n \"abcxyz.\" To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

", - "smithy.api#httpQuery": "signatureContains" + "smithy.api#documentation": "

A pagination token that fetches the next page of intents. If this API call is\n truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n intents, use the pagination token in the next request.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "locale": { + "target": "com.amazonaws.lexmodelbuildingservice#Locale", + "traits": { + "smithy.api#documentation": "

A list of locales that the intent supports.

", + "smithy.api#httpQuery": "locale" } } } @@ -2638,11 +2665,11 @@ "com.amazonaws.lexmodelbuildingservice#GetBuiltinSlotTypesRequest": { "type": "structure", "members": { - "locale": { - "target": "com.amazonaws.lexmodelbuildingservice#Locale", + "nextToken": { + "target": "com.amazonaws.lexmodelbuildingservice#NextToken", "traits": { - "smithy.api#documentation": "

A list of locales that the slot type supports.

", - "smithy.api#httpQuery": "locale" + "smithy.api#documentation": "

A pagination token that fetches the next page of slot types. If the response to this\n API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next\n page of slot types, specify the pagination token in the next request.

", + "smithy.api#httpQuery": "nextToken" } }, "signatureContains": { @@ -2659,11 +2686,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelbuildingservice#NextToken", + "locale": { + "target": "com.amazonaws.lexmodelbuildingservice#Locale", "traits": { - "smithy.api#documentation": "

A pagination token that fetches the next page of slot types. If the response to this\n API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next\n page of slot types, specify the pagination token in the next request.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

A list of locales that the slot type supports.

", + "smithy.api#httpQuery": "locale" } } } @@ -2735,14 +2762,6 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#Name", - "traits": { - "smithy.api#documentation": "

The name of the bot to export.

", - "smithy.api#httpQuery": "name", - "smithy.api#required": {} - } - }, "resourceType": { "target": "com.amazonaws.lexmodelbuildingservice#ResourceType", "traits": { @@ -2750,6 +2769,14 @@ "smithy.api#httpQuery": "resourceType", "smithy.api#required": {} } + }, + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#Name", + "traits": { + "smithy.api#documentation": "

The name of the bot to export.

", + "smithy.api#httpQuery": "name", + "smithy.api#required": {} + } } } }, @@ -2768,16 +2795,10 @@ "smithy.api#documentation": "

The format of the exported data.

" } }, - "url": { + "failureReason": { "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

An S3 pre-signed URL that provides the location of the exported resource. The exported\n resource is a ZIP archive that contains the exported resource in JSON format. The structure of\n the archive may change. Your code should not rely on the archive structure.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lexmodelbuildingservice#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of the exported resource.

" + "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to export the resource.

" } }, "exportStatus": { @@ -2786,16 +2807,22 @@ "smithy.api#documentation": "

The status of the export.

\n " } }, + "resourceType": { + "target": "com.amazonaws.lexmodelbuildingservice#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of the exported resource.

" + } + }, "version": { "target": "com.amazonaws.lexmodelbuildingservice#NumericalVersion", "traits": { "smithy.api#documentation": "

The version of the bot being exported.

" } }, - "failureReason": { + "url": { "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to export the resource.

" + "smithy.api#documentation": "

An S3 pre-signed URL that provides the location of the exported resource. The exported\n resource is a ZIP archive that contains the exported resource in JSON format. The structure of\n the archive may change. Your code should not rely on the archive structure.

" } } } @@ -2847,16 +2874,16 @@ "com.amazonaws.lexmodelbuildingservice#GetImportResponse": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#Name", + "mergeStrategy": { + "target": "com.amazonaws.lexmodelbuildingservice#MergeStrategy", "traits": { - "smithy.api#documentation": "

The name given to the import job.

" + "smithy.api#documentation": "

The action taken when there was a conflict between an existing resource and a resource\n in the import file.

" } }, - "importStatus": { - "target": "com.amazonaws.lexmodelbuildingservice#ImportStatus", + "importId": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The status of the import job. If the status is FAILED, you can get the\n reason for the failure from the failureReason field.

" + "smithy.api#documentation": "

The identifier for the specific import job.

" } }, "resourceType": { @@ -2865,28 +2892,28 @@ "smithy.api#documentation": "

The type of resource imported.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "failureReason": { + "target": "com.amazonaws.lexmodelbuildingservice#StringList", "traits": { - "smithy.api#documentation": "

A timestamp for the date and time that the import job was created.

" + "smithy.api#documentation": "

A string that describes why an import job failed to complete.

" } }, - "mergeStrategy": { - "target": "com.amazonaws.lexmodelbuildingservice#MergeStrategy", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#Name", "traits": { - "smithy.api#documentation": "

The action taken when there was a conflict between an existing resource and a resource\n in the import file.

" + "smithy.api#documentation": "

The name given to the import job.

" } }, - "failureReason": { - "target": "com.amazonaws.lexmodelbuildingservice#StringList", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

A string that describes why an import job failed to complete.

" + "smithy.api#documentation": "

A timestamp for the date and time that the import job was created.

" } }, - "importId": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "importStatus": { + "target": "com.amazonaws.lexmodelbuildingservice#ImportStatus", "traits": { - "smithy.api#documentation": "

The identifier for the specific import job.

" + "smithy.api#documentation": "

The status of the import job. If the status is FAILED, you can get the\n reason for the failure from the failureReason field.

" } } } @@ -2925,18 +2952,18 @@ "com.amazonaws.lexmodelbuildingservice#GetIntentRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

The name of the intent. The name is case sensitive.

", + "smithy.api#documentation": "

The version of the intent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", "traits": { - "smithy.api#documentation": "

The version of the intent.

", + "smithy.api#documentation": "

The name of the intent. The name is case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2946,34 +2973,22 @@ "com.amazonaws.lexmodelbuildingservice#GetIntentResponse": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", - "traits": { - "smithy.api#documentation": "

A description of the intent.

" - } - }, - "kendraConfiguration": { - "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration information, if any, to connect to an Amazon Kendra index with the\n AMAZON.KendraSearchIntent intent.

" - } - }, - "parentIntentSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", "traits": { - "smithy.api#documentation": "

A unique identifier for a built-in intent.

" + "smithy.api#documentation": "

The name of the intent.

" } }, - "conclusionStatement": { + "rejectionStatement": { "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

After the Lambda function specified in the fulfillmentActivity element\n fulfills the intent, Amazon Lex conveys this statement to the user.

" + "smithy.api#documentation": "

If the user answers \"no\" to the question defined in confirmationPrompt,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" } }, - "sampleUtterances": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentUtteranceList", + "dialogCodeHook": { + "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", "traits": { - "smithy.api#documentation": "

An array of sample utterances configured for the intent.

" + "smithy.api#documentation": "

If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input.\n For more information, see PutIntent.

" } }, "createdDate": { @@ -2982,52 +2997,58 @@ "smithy.api#documentation": "

The date that the intent was created.

" } }, - "rejectionStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "slots": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotList", "traits": { - "smithy.api#documentation": "

If the user answers \"no\" to the question defined in confirmationPrompt,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" + "smithy.api#documentation": "

An array of intent slots configured for the intent.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "confirmationPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

Checksum of the intent.

" + "smithy.api#documentation": "

If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the\n user's request. For more information, see PutIntent.

" } }, - "dialogCodeHook": { - "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", + "parentIntentSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", "traits": { - "smithy.api#documentation": "

If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input.\n For more information, see PutIntent.

" + "smithy.api#documentation": "

A unique identifier for a built-in intent.

" } }, - "slots": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotList", + "kendraConfiguration": { + "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", "traits": { - "smithy.api#documentation": "

An array of intent slots configured for the intent.

" + "smithy.api#documentation": "

Configuration information, if any, to connect to an Amazon Kendra index with the\n AMAZON.KendraSearchIntent intent.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "conclusionStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

The name of the intent.

" + "smithy.api#documentation": "

After the Lambda function specified in the fulfillmentActivity element\n fulfills the intent, Amazon Lex conveys this statement to the user.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

The date that the intent was updated. When you create a resource, the creation date and\n the last updated date are the same.

" + "smithy.api#documentation": "

A description of the intent.

" } }, - "confirmationPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the\n user's request. For more information, see PutIntent.

" + "smithy.api#documentation": "

Checksum of the intent.

" } }, - "fulfillmentActivity": { - "target": "com.amazonaws.lexmodelbuildingservice#FulfillmentActivity", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

Describes how the intent is fulfilled. For more information, see PutIntent.

" + "smithy.api#documentation": "

The version of the intent.

" + } + }, + "sampleUtterances": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentUtteranceList", + "traits": { + "smithy.api#documentation": "

An array of sample utterances configured for the intent.

" } }, "followUpPrompt": { @@ -3036,10 +3057,16 @@ "smithy.api#documentation": "

If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after\n the intent is fulfilled. For more information, see PutIntent.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The version of the intent.

" + "smithy.api#documentation": "

The date that the intent was updated. When you create a resource, the creation date and\n the last updated date are the same.

" + } + }, + "fulfillmentActivity": { + "target": "com.amazonaws.lexmodelbuildingservice#FulfillmentActivity", + "traits": { + "smithy.api#documentation": "

Describes how the intent is fulfilled. For more information, see PutIntent.

" } } } @@ -3083,14 +3110,6 @@ "com.amazonaws.lexmodelbuildingservice#GetIntentVersionsRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", - "traits": { - "smithy.api#documentation": "

The name of the intent for which versions should be returned.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "maxResults": { "target": "com.amazonaws.lexmodelbuildingservice#MaxResults", "traits": { @@ -3104,6 +3123,14 @@ "smithy.api#documentation": "

A pagination token for fetching the next page of intent versions. If the response to\n this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next\n page of versions, specify the pagination token in the next request.

", "smithy.api#httpQuery": "nextToken" } + }, + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "traits": { + "smithy.api#documentation": "

The name of the intent for which versions should be returned.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -3163,11 +3190,11 @@ "com.amazonaws.lexmodelbuildingservice#GetIntentsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.lexmodelbuildingservice#NextToken", + "nameContains": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", "traits": { - "smithy.api#documentation": "

A pagination token that fetches the next page of intents. If the response to this API\n call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n intents, specify the pagination token in the next request.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

Substring to match in intent names. An intent will be returned if any part of its name\n matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "smithy.api#httpQuery": "nameContains" } }, "maxResults": { @@ -3177,11 +3204,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "nameContains": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "nextToken": { + "target": "com.amazonaws.lexmodelbuildingservice#NextToken", "traits": { - "smithy.api#documentation": "

Substring to match in intent names. An intent will be returned if any part of its name\n matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", - "smithy.api#httpQuery": "nameContains" + "smithy.api#documentation": "

A pagination token that fetches the next page of intents. If the response to this API\n call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of\n intents, specify the pagination token in the next request.

", + "smithy.api#httpQuery": "nextToken" } } } @@ -3189,22 +3216,22 @@ "com.amazonaws.lexmodelbuildingservice#GetIntentsResponse": { "type": "structure", "members": { - "intents": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentMetadataList", - "traits": { - "smithy.api#documentation": "

An array of Intent objects. For more information, see PutBot.

" - } - }, "nextToken": { "target": "com.amazonaws.lexmodelbuildingservice#NextToken", "traits": { "smithy.api#documentation": "

If the response is truncated, the response includes a pagination token that you can\n specify in your next request to fetch the next page of intents.

" } - } - } - }, - "com.amazonaws.lexmodelbuildingservice#GetSlotType": { - "type": "operation", + }, + "intents": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentMetadataList", + "traits": { + "smithy.api#documentation": "

An array of Intent objects. For more information, see PutBot.

" + } + } + } + }, + "com.amazonaws.lexmodelbuildingservice#GetSlotType": { + "type": "operation", "input": { "target": "com.amazonaws.lexmodelbuildingservice#GetSlotTypeRequest" }, @@ -3237,18 +3264,18 @@ "com.amazonaws.lexmodelbuildingservice#GetSlotTypeRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeName", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

The name of the slot type. The name is case sensitive.

", + "smithy.api#documentation": "

The version of the slot type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeName", "traits": { - "smithy.api#documentation": "

The version of the slot type.

", + "smithy.api#documentation": "

The name of the slot type. The name is case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3258,16 +3285,22 @@ "com.amazonaws.lexmodelbuildingservice#GetSlotTypeResponse": { "type": "structure", "members": { + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", + "traits": { + "smithy.api#documentation": "

The version of the slot type.

" + } + }, "lastUpdatedDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { "smithy.api#documentation": "

The date that the slot type was updated. When you create a resource, the creation date\n and last update date are the same.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "parentSlotTypeSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", "traits": { - "smithy.api#documentation": "

The version of the slot type.

" + "smithy.api#documentation": "

The built-in slot type used as a parent for the slot type.

" } }, "createdDate": { @@ -3276,28 +3309,28 @@ "smithy.api#documentation": "

The date that the slot type was created.

" } }, - "slotTypeConfigurations": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeConfigurations", - "traits": { - "smithy.api#documentation": "

Configuration information that extends the parent built-in slot type.

" - } - }, "description": { "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { "smithy.api#documentation": "

A description of the slot type.

" } }, + "enumerationValues": { + "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", + "traits": { + "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take.

" + } + }, "valueSelectionStrategy": { "target": "com.amazonaws.lexmodelbuildingservice#SlotValueSelectionStrategy", "traits": { "smithy.api#documentation": "

The strategy that Amazon Lex uses to determine the value of the slot. For more information,\n see PutSlotType.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "slotTypeConfigurations": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeConfigurations", "traits": { - "smithy.api#documentation": "

Checksum of the $LATEST version of the slot type.

" + "smithy.api#documentation": "

Configuration information that extends the parent built-in slot type.

" } }, "name": { @@ -3306,16 +3339,10 @@ "smithy.api#documentation": "

The name of the slot type.

" } }, - "enumerationValues": { - "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", - "traits": { - "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take.

" - } - }, - "parentSlotTypeSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The built-in slot type used as a parent for the slot type.

" + "smithy.api#documentation": "

Checksum of the $LATEST version of the slot type.

" } } } @@ -3359,6 +3386,13 @@ "com.amazonaws.lexmodelbuildingservice#GetSlotTypeVersionsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.lexmodelbuildingservice#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token for fetching the next page of slot type versions. If the response to\n this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next\n page of versions, specify the pagination token in the next request.

", + "smithy.api#httpQuery": "nextToken" + } + }, "maxResults": { "target": "com.amazonaws.lexmodelbuildingservice#MaxResults", "traits": { @@ -3373,13 +3407,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.lexmodelbuildingservice#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token for fetching the next page of slot type versions. If the response to\n this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next\n page of versions, specify the pagination token in the next request.

", - "smithy.api#httpQuery": "nextToken" - } } } }, @@ -3510,6 +3537,14 @@ "com.amazonaws.lexmodelbuildingservice#GetUtterancesViewRequest": { "type": "structure", "members": { + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the bot for which utterance information should be returned.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "statusType": { "target": "com.amazonaws.lexmodelbuildingservice#StatusType", "traits": { @@ -3525,14 +3560,6 @@ "smithy.api#httpQuery": "bot_versions", "smithy.api#required": {} } - }, - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the bot for which utterance information should be returned.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -3623,10 +3650,10 @@ "com.amazonaws.lexmodelbuildingservice#IntentMetadata": { "type": "structure", "members": { - "createdDate": { + "lastUpdatedDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the intent was created.

" + "smithy.api#documentation": "

The date that the intent was updated. When you create an intent, the creation date and\n last updated date are the same.

" } }, "version": { @@ -3635,16 +3662,10 @@ "smithy.api#documentation": "

The version of the intent.

" } }, - "lastUpdatedDate": { + "createdDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the intent was updated. When you create an intent, the creation date and\n last updated date are the same.

" - } - }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", - "traits": { - "smithy.api#documentation": "

The name of the intent.

" + "smithy.api#documentation": "

The date that the intent was created.

" } }, "description": { @@ -3652,6 +3673,12 @@ "traits": { "smithy.api#documentation": "

A description of the intent.

" } + }, + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "traits": { + "smithy.api#documentation": "

The name of the intent.

" + } } }, "traits": { @@ -3708,17 +3735,17 @@ "smithy.api#documentation": "

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query.\n The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

\n

You can override this filter string with a new filter string at runtime.

" } }, - "role": { - "target": "com.amazonaws.lexmodelbuildingservice#roleArn", + "kendraIndex": { + "target": "com.amazonaws.lexmodelbuildingservice#KendraIndexArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon\n Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role\n does not exist, you get an exception when you call the PutIntent\n operation.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the\n AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region\n as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you\n call the PutIntent operation.

", "smithy.api#required": {} } }, - "kendraIndex": { - "target": "com.amazonaws.lexmodelbuildingservice#KendraIndexArn", + "role": { + "target": "com.amazonaws.lexmodelbuildingservice#roleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the\n AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region\n as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you\n call the PutIntent operation.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon\n Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role\n does not exist, you get an exception when you call the PutIntent\n operation.

", "smithy.api#required": {} } } @@ -3848,16 +3875,24 @@ "traits": { "smithy.api#enum": [ { - "value": "en-US", - "name": "EN_US" + "value": "de-DE", + "name": "DE_DE" + }, + { + "value": "en-AU", + "name": "EN_AU" }, { "value": "en-GB", "name": "EN_GB" }, { - "value": "de-DE", - "name": "DE_DE" + "value": "en-US", + "name": "EN_US" + }, + { + "value": "es-US", + "name": "ES_US" } ] } @@ -3871,13 +3906,6 @@ "com.amazonaws.lexmodelbuildingservice#LogSettingsRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.lexmodelbuildingservice#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the\n logs should be delivered.

", - "smithy.api#required": {} - } - }, "destination": { "target": "com.amazonaws.lexmodelbuildingservice#Destination", "traits": { @@ -3885,10 +3913,11 @@ "smithy.api#required": {} } }, - "kmsKeyArn": { - "target": "com.amazonaws.lexmodelbuildingservice#KmsKeyArn", + "resourceArn": { + "target": "com.amazonaws.lexmodelbuildingservice#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio\n logs delivered to an S3 bucket. The key does not apply to CloudWatch Logs and is optional for\n S3 buckets.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the\n logs should be delivered.

", + "smithy.api#required": {} } }, "logType": { @@ -3897,6 +3926,12 @@ "smithy.api#documentation": "

The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group.\n Audio logs are delivered to an S3 bucket.

", "smithy.api#required": {} } + }, + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelbuildingservice#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio\n logs delivered to an S3 bucket. The key does not apply to CloudWatch Logs and is optional for\n S3 buckets.

" + } } }, "traits": { @@ -3918,18 +3953,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3\n bucket.

" } }, - "logType": { - "target": "com.amazonaws.lexmodelbuildingservice#LogType", - "traits": { - "smithy.api#documentation": "

The type of logging that is enabled.

" - } - }, - "resourcePrefix": { - "target": "com.amazonaws.lexmodelbuildingservice#ResourcePrefix", - "traits": { - "smithy.api#documentation": "

The resource prefix is the first part of the S3 object key within the S3 bucket that you\n specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name\n within the log group that you specified.

" - } - }, "destination": { "target": "com.amazonaws.lexmodelbuildingservice#Destination", "traits": { @@ -3941,6 +3964,18 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the\n logs are delivered.

" } + }, + "logType": { + "target": "com.amazonaws.lexmodelbuildingservice#LogType", + "traits": { + "smithy.api#documentation": "

The type of logging that is enabled.

" + } + }, + "resourcePrefix": { + "target": "com.amazonaws.lexmodelbuildingservice#ResourcePrefix", + "traits": { + "smithy.api#documentation": "

The resource prefix is the first part of the S3 object key within the S3 bucket that you\n specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name\n within the log group that you specified.

" + } } }, "traits": { @@ -3996,11 +4031,10 @@ "com.amazonaws.lexmodelbuildingservice#Message": { "type": "structure", "members": { - "content": { - "target": "com.amazonaws.lexmodelbuildingservice#ContentString", + "groupNumber": { + "target": "com.amazonaws.lexmodelbuildingservice#GroupNumber", "traits": { - "smithy.api#documentation": "

The text of the message.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifies the message group that the message belongs to. When a group is assigned to a\n message, Amazon Lex returns one message from each group in the response.

" } }, "contentType": { @@ -4010,10 +4044,11 @@ "smithy.api#required": {} } }, - "groupNumber": { - "target": "com.amazonaws.lexmodelbuildingservice#GroupNumber", + "content": { + "target": "com.amazonaws.lexmodelbuildingservice#ContentString", "traits": { - "smithy.api#documentation": "

Identifies the message group that the message belongs to. When a group is assigned to a\n message, Amazon Lex returns one message from each group in the response.

" + "smithy.api#documentation": "

The text of the message.

", + "smithy.api#required": {} } } }, @@ -4134,10 +4169,11 @@ "com.amazonaws.lexmodelbuildingservice#Prompt": { "type": "structure", "members": { - "responseCard": { - "target": "com.amazonaws.lexmodelbuildingservice#ResponseCard", + "maxAttempts": { + "target": "com.amazonaws.lexmodelbuildingservice#PromptMaxAttempts", "traits": { - "smithy.api#documentation": "

A response card. Amazon Lex uses this prompt at runtime, in the PostText API\n response. It substitutes session attributes and slot values for placeholders in the response\n card. For more information, see ex-resp-card.

" + "smithy.api#documentation": "

The number of times to prompt the user for information.

", + "smithy.api#required": {} } }, "messages": { @@ -4147,11 +4183,10 @@ "smithy.api#required": {} } }, - "maxAttempts": { - "target": "com.amazonaws.lexmodelbuildingservice#PromptMaxAttempts", + "responseCard": { + "target": "com.amazonaws.lexmodelbuildingservice#ResponseCard", "traits": { - "smithy.api#documentation": "

The number of times to prompt the user for information.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A response card. Amazon Lex uses this prompt at runtime, in the PostText API\n response. It substitutes session attributes and slot values for placeholders in the response\n card. For more information, see ex-resp-card.

" } } }, @@ -4248,11 +4283,10 @@ "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "conversationLogs": { + "target": "com.amazonaws.lexmodelbuildingservice#ConversationLogsRequest", "traits": { - "smithy.api#documentation": "

The version of the bot.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Settings for conversation logs for the alias.

" } }, "description": { @@ -4281,10 +4315,11 @@ "smithy.api#documentation": "

A list of tags to add to the bot alias. You can only add tags when you create an alias,\n you can't use the PutBotAlias operation to update the tags on a bot alias. To\n update tags, use the TagResource operation.

" } }, - "conversationLogs": { - "target": "com.amazonaws.lexmodelbuildingservice#ConversationLogsRequest", + "botVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

Settings for conversation logs for the alias.

" + "smithy.api#documentation": "

The version of the bot.

", + "smithy.api#required": {} } } } @@ -4304,22 +4339,10 @@ "smithy.api#documentation": "

The settings that determine how Amazon Lex uses conversation logs for the alias.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the bot alias was updated. When you create a resource, the creation date\n and the last updated date are the same.

" - } - }, - "botName": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the bot that the alias points to.

" - } - }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "tags": { + "target": "com.amazonaws.lexmodelbuildingservice#TagList", "traits": { - "smithy.api#documentation": "

The date that the bot alias was created.

" + "smithy.api#documentation": "

A list of tags associated with a bot.

" } }, "botVersion": { @@ -4328,22 +4351,34 @@ "smithy.api#documentation": "

The version of the bot that the alias points to.

" } }, + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#AliasName", + "traits": { + "smithy.api#documentation": "

The name of the alias.

" + } + }, "checksum": { "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { "smithy.api#documentation": "

The checksum for the current version of the alias.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#AliasName", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the alias.

" + "smithy.api#documentation": "

The date that the bot alias was created.

" } }, - "tags": { - "target": "com.amazonaws.lexmodelbuildingservice#TagList", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

A list of tags associated with a bot.

" + "smithy.api#documentation": "

The date that the bot alias was updated. When you create a resource, the creation date\n and the last updated date are the same.

" + } + }, + "botName": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the bot that the alias points to.

" } } } @@ -4351,22 +4386,34 @@ "com.amazonaws.lexmodelbuildingservice#PutBotRequest": { "type": "structure", "members": { - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.lexmodelbuildingservice#SessionTTL", + "clarificationPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

The maximum time in seconds that Amazon Lex retains the data gathered in a\n conversation.

\n

A user interaction session remains active for the amount of time specified. If no\n conversation occurs during this time, the session expires and Amazon Lex deletes any data provided\n before the timeout.

\n

For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked\n halfway through placing an order. If the user doesn't complete the order within the specified\n time, Amazon Lex discards the slot information that it gathered, and the user must start\n over.

\n

If you don't include the idleSessionTTLInSeconds element in a\n PutBot operation request, Amazon Lex uses the default value. This is also true if\n the request replaces an existing bot.

\n

The default is 300 seconds (5 minutes).

" + "smithy.api#documentation": "

When Amazon Lex doesn't understand the user's intent, it uses this message to get\n clarification. To specify how many times Amazon Lex should repeat the clarification prompt, use the\n maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in\n the abortStatement field.

\n

When you create a clarification prompt, make sure that it suggests the correct response\n from the user. for example, for a bot that orders pizza and drinks, you might create this\n clarification prompt: \"What would you like to do? You can say 'Order a pizza' or 'Order a\n drink.'\"

\n

If you have defined a fallback intent, it will be invoked if the clarification prompt is\n repeated the number of times defined in the maxAttempts field. For more\n information, see AMAZON.FallbackIntent.

\n

If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request\n exception in three cases:

\n " } }, - "processBehavior": { - "target": "com.amazonaws.lexmodelbuildingservice#ProcessBehavior", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

If you set the processBehavior element to BUILD, Amazon Lex builds\n the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the\n bot, but doesn't build it.

\n

If you don't specify this value, the default value is BUILD.

" + "smithy.api#documentation": "

A description of the bot.

" } }, - "createVersion": { + "voiceId": { + "target": "com.amazonaws.lexmodelbuildingservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the\n user. The locale configured for the voice must match the locale of the bot. For more\n information, see Voices in Amazon Polly in the Amazon Polly Developer\n Guide.

" + } + }, + "detectSentiment": { "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

When set to true a new numbered version of the bot is created. This is the\n same as calling the CreateBotVersion operation. If you don't specify\n createVersion, the default is false.

" + "smithy.api#documentation": "

When set to true user utterances are sent to Amazon Comprehend for sentiment\n analysis. If you don't specify detectSentiment, the default is\n false.

" + } + }, + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", + "traits": { + "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version.

\n

When you create a new bot, leave the checksum field blank. If you specify\n a checksum you get a BadRequestException exception.

\n

When you want to update a bot, set the checksum field to the checksum of\n the most recent revision of the $LATEST version. If you don't specify the \n checksum field, or if the checksum does not match the $LATEST version,\n you get a PreconditionFailedException exception.

" } }, "childDirected": { @@ -4376,54 +4423,54 @@ "smithy.api#required": {} } }, - "abortStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "intents": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentList", "traits": { - "smithy.api#documentation": "

When Amazon Lex can't understand the user's input in context, it tries to elicit the\n information a few times. After that, Amazon Lex sends the message defined in\n abortStatement to the user, and then aborts the conversation. To set the number\n of retries, use the valueElicitationPrompt field for the slot type.

\n

For example, in a pizza ordering bot, Amazon Lex might ask a user \"What type of crust would\n you like?\" If the user's response is not one of the expected responses (for example, \"thin\n crust, \"deep dish,\" etc.), Amazon Lex tries to elicit a correct response a few more times.

\n

For example, in a pizza ordering application, OrderPizza might be one of\n the intents. This intent might require the CrustType slot. You specify the\n valueElicitationPrompt field when you create the CrustType\n slot.

\n

If you have defined a fallback intent the abort statement will not be sent to the user,\n the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.

" + "smithy.api#documentation": "

An array of Intent objects. Each intent represents a command that a user\n can express. For example, a pizza ordering bot might support an OrderPizza intent. For more\n information, see how-it-works.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.lexmodelbuildingservice#SessionTTL", "traits": { - "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version.

\n

When you create a new bot, leave the checksum field blank. If you specify\n a checksum you get a BadRequestException exception.

\n

When you want to update a bot, set the checksum field to the checksum of\n the most recent revision of the $LATEST version. If you don't specify the \n checksum field, or if the checksum does not match the $LATEST version,\n you get a PreconditionFailedException exception.

" + "smithy.api#documentation": "

The maximum time in seconds that Amazon Lex retains the data gathered in a\n conversation.

\n

A user interaction session remains active for the amount of time specified. If no\n conversation occurs during this time, the session expires and Amazon Lex deletes any data provided\n before the timeout.

\n

For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked\n halfway through placing an order. If the user doesn't complete the order within the specified\n time, Amazon Lex discards the slot information that it gathered, and the user must start\n over.

\n

If you don't include the idleSessionTTLInSeconds element in a\n PutBot operation request, Amazon Lex uses the default value. This is also true if\n the request replaces an existing bot.

\n

The default is 300 seconds (5 minutes).

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "enableModelImprovements": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

The name of the bot. The name is not case sensitive.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Set to true to enable access to natural language understanding improvements.\n

\n

When you set the enableModelImprovements parameter to true you\n can use the nluIntentConfidenceThreshold parameter to configure confidence\n scores. For more information, see Confidence Scores.

\n

You can only set the enableModelImprovements parameter in certain Regions. If\n you set the parameter to true, your bot has access to accuracy improvements.

\n

The Regions where you can set the enableModelImprovements parameter to\n true are:

\n \n

In other Regions, the enableModelImprovements parameter is set to\n true by default. In these Regions setting the parameter to false\n throws a ValidationException exception.

\n " } }, - "clarificationPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", + "processBehavior": { + "target": "com.amazonaws.lexmodelbuildingservice#ProcessBehavior", "traits": { - "smithy.api#documentation": "

When Amazon Lex doesn't understand the user's intent, it uses this message to get\n clarification. To specify how many times Amazon Lex should repeat the clarification prompt, use the\n maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in\n the abortStatement field.

\n

When you create a clarification prompt, make sure that it suggests the correct response\n from the user. for example, for a bot that orders pizza and drinks, you might create this\n clarification prompt: \"What would you like to do? You can say 'Order a pizza' or 'Order a\n drink.'\"

\n

If you have defined a fallback intent, it will be invoked if the clarification prompt is\n repeated the number of times defined in the maxAttempts field. For more\n information, see AMAZON.FallbackIntent.

\n

If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request\n exception in three cases:

\n " + "smithy.api#documentation": "

If you set the processBehavior element to BUILD, Amazon Lex builds\n the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the\n bot, but doesn't build it.

\n

If you don't specify this value, the default value is BUILD.

" } }, - "intents": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentList", + "nluIntentConfidenceThreshold": { + "target": "com.amazonaws.lexmodelbuildingservice#ConfidenceThreshold", "traits": { - "smithy.api#documentation": "

An array of Intent objects. Each intent represents a command that a user\n can express. For example, a pizza ordering bot might support an OrderPizza intent. For more\n information, see how-it-works.

" + "smithy.api#documentation": "

Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent,\n AMAZON.KendraSearchIntent, or both when returning alternative intents in a\n PostContent or PostText response.\n AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only\n inserted if they are configured for the bot.

\n

You must set the enableModelImprovements parameter to true to\n use confidence scores.

\n \n

In other Regions, the enableModelImprovements parameter is set to\n true by default.

\n

For example, suppose a bot is configured with the confidence threshold of 0.80 and the\n AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the\n following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from\n the PostText operation would be:

\n " } }, - "voiceId": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "abortStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the\n user. The locale configured for the voice must match the locale of the bot. For more\n information, see Voices in Amazon Polly in the Amazon Polly Developer\n Guide.

" + "smithy.api#documentation": "

When Amazon Lex can't understand the user's input in context, it tries to elicit the\n information a few times. After that, Amazon Lex sends the message defined in\n abortStatement to the user, and then cancels the conversation. To set the\n number of retries, use the valueElicitationPrompt field for the slot type.

\n

For example, in a pizza ordering bot, Amazon Lex might ask a user \"What type of crust would\n you like?\" If the user's response is not one of the expected responses (for example, \"thin\n crust, \"deep dish,\" etc.), Amazon Lex tries to elicit a correct response a few more times.

\n

For example, in a pizza ordering application, OrderPizza might be one of\n the intents. This intent might require the CrustType slot. You specify the\n valueElicitationPrompt field when you create the CrustType\n slot.

\n

If you have defined a fallback intent the cancel statement will not be sent to the user,\n the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.

" } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

A description of the bot.

" + "smithy.api#documentation": "

The name of the bot. The name is not case sensitive.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "detectSentiment": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "tags": { + "target": "com.amazonaws.lexmodelbuildingservice#TagList", "traits": { - "smithy.api#documentation": "

When set to true user utterances are sent to Amazon Comprehend for sentiment\n analysis. If you don't specify detectSentiment, the default is\n false.

" + "smithy.api#documentation": "

A list of tags to add to the bot. You can only add tags when you create a bot, you can't\n use the PutBot operation to update the tags on a bot. To update tags, use the\n TagResource operation.

" } }, "locale": { @@ -4433,10 +4480,10 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.lexmodelbuildingservice#TagList", + "createVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

A list of tags to add to the bot. You can only add tags when you create a bot, you can't\n use the PutBot operation to update the tags on a bot. To update tags, use the\n TagResource operation.

" + "smithy.api#documentation": "

When set to true a new numbered version of the bot is created. This is the\n same as calling the CreateBotVersion operation. If you don't specify\n createVersion, the default is false.

" } } } @@ -4444,46 +4491,52 @@ "com.amazonaws.lexmodelbuildingservice#PutBotResponse": { "type": "structure", "members": { - "voiceId": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "nluIntentConfidenceThreshold": { + "target": "com.amazonaws.lexmodelbuildingservice#ConfidenceThreshold", "traits": { - "smithy.api#documentation": "

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more\n information, see PutBot.

" + "smithy.api#documentation": "

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent,\n AMAZON.KendraSearchIntent, or both when returning alternative intents in a\n PostContent or PostText response.\n AMAZON.FallbackIntent is inserted if the confidence score for all intents is\n below this value. AMAZON.KendraSearchIntent is only inserted if it is configured\n for the bot.

" } }, - "clarificationPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", + "createVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more\n information, see PutBot.

" + "smithy.api#documentation": "

\n True if a new version of the bot was created. If the\n createVersion field was not specified in the request, the\n createVersion field is set to false in the response.

" } }, - "detectSentiment": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "locale": { + "target": "com.amazonaws.lexmodelbuildingservice#Locale", "traits": { - "smithy.api#documentation": "

\n true if the bot is configured to send user utterances to Amazon Comprehend\n for sentiment analysis. If the detectSentiment field was not specified in the\n request, the detectSentiment field is false in the response.

" + "smithy.api#documentation": "

The target locale for the bot.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.lexmodelbuildingservice#SessionTTL", "traits": { - "smithy.api#documentation": "

Checksum of the bot that you created.

" + "smithy.api#documentation": "

The maximum length of time that Amazon Lex retains the data gathered in a conversation. For\n more information, see PutBot.

" } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

A description of the bot.

" + "smithy.api#documentation": "

The version of the bot. For a new bot, the version is always\n $LATEST.

" } }, - "locale": { - "target": "com.amazonaws.lexmodelbuildingservice#Locale", + "intents": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentList", "traits": { - "smithy.api#documentation": "

The target locale for the bot.

" + "smithy.api#documentation": "

An array of Intent objects. For more information, see PutBot.

" } }, - "childDirected": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify\n whether your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to the\n Children's Online Privacy Protection Act (COPPA) by specifying true or\n false in the childDirected field. By specifying true\n in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By\n specifying false in the childDirected field, you confirm that your\n use of Amazon Lex is not related to a website, program, or other\n application that is directed or targeted, in whole or in part, to children under age 13 and\n subject to COPPA. You may not specify a default value for the childDirected field\n that does not accurately reflect whether your use of Amazon Lex is related to a website, program,\n or other application that is directed or targeted, in whole or in part, to children under age\n 13 and subject to COPPA.

\n

If your use of Amazon Lex relates to a website, program, or other application that is\n directed in whole or in part, to children under age 13, you must obtain any required\n verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in\n connection with websites, programs, or other applications that are directed or targeted, in\n whole or in part, to children under age 13, see the Amazon Lex FAQ.\n

" + "smithy.api#documentation": "

The date that the bot was updated. When you create a resource, the creation date and\n last updated date are the same.

" + } + }, + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", + "traits": { + "smithy.api#documentation": "

A description of the bot.

" } }, "tags": { @@ -4492,64 +4545,70 @@ "smithy.api#documentation": "

A list of tags associated with the bot.

" } }, - "failureReason": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "detectSentiment": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to build the bot.

" + "smithy.api#documentation": "

\n true if the bot is configured to send user utterances to Amazon Comprehend\n for sentiment analysis. If the detectSentiment field was not specified in the\n request, the detectSentiment field is false in the response.

" } }, - "intents": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentList", + "clarificationPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

An array of Intent objects. For more information, see PutBot.

" + "smithy.api#documentation": "

The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more\n information, see PutBot.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "voiceId": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The version of the bot. For a new bot, the version is always\n $LATEST.

" + "smithy.api#documentation": "

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more\n information, see PutBot.

" } }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.lexmodelbuildingservice#SessionTTL", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The maximum length of time that Amazon Lex retains the data gathered in a conversation. For\n more information, see PutBot.

" + "smithy.api#documentation": "

The date that the bot was created.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#BotName", + "status": { + "target": "com.amazonaws.lexmodelbuildingservice#Status", "traits": { - "smithy.api#documentation": "

The name of the bot.

" + "smithy.api#documentation": "

When you send a request to create a bot with processBehavior set to\n BUILD, Amazon Lex sets the status response element to\n BUILDING.

\n

In the READY_BASIC_TESTING state you can test the bot with user inputs\n that exactly match the utterances configured for the bot's intents and values in the slot\n types.

\n

If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED.\n Amazon Lex returns the reason for the failure in the failureReason response element.

\n

When you set processBehavior to SAVE, Amazon Lex sets the status\n code to NOT BUILT.

\n

When the bot is in the READY state you can test and publish the\n bot.

" } }, - "abortStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "childDirected": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.

" + "smithy.api#documentation": "

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify\n whether your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to the\n Children's Online Privacy Protection Act (COPPA) by specifying true or\n false in the childDirected field. By specifying true\n in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is\n directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By\n specifying false in the childDirected field, you confirm that your\n use of Amazon Lex is not related to a website, program, or other\n application that is directed or targeted, in whole or in part, to children under age 13 and\n subject to COPPA. You may not specify a default value for the childDirected field\n that does not accurately reflect whether your use of Amazon Lex is related to a website, program,\n or other application that is directed or targeted, in whole or in part, to children under age\n 13 and subject to COPPA.

\n

If your use of Amazon Lex relates to a website, program, or other application that is\n directed in whole or in part, to children under age 13, you must obtain any required\n verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in\n connection with websites, programs, or other applications that are directed or targeted, in\n whole or in part, to children under age 13, see the Amazon Lex FAQ.\n

" } }, - "status": { - "target": "com.amazonaws.lexmodelbuildingservice#Status", + "failureReason": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

When you send a request to create a bot with processBehavior set to\n BUILD, Amazon Lex sets the status response element to\n BUILDING.

\n

In the READY_BASIC_TESTING state you can test the bot with user inputs\n that exactly match the utterances configured for the bot's intents and values in the slot\n types.

\n

If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED.\n Amazon Lex returns the reason for the failure in the failureReason response element.

\n

When you set processBehavior to SAVE, Amazon Lex sets the status\n code to NOT BUILT.

\n

When the bot is in the READY state you can test and publish the\n bot.

" + "smithy.api#documentation": "

If status is FAILED, Amazon Lex provides the reason that it failed\n to build the bot.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "enableModelImprovements": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

The date that the bot was updated. When you create a resource, the creation date and\n last updated date are the same.

" + "smithy.api#documentation": "

Indicates whether the bot uses accuracy improvements. true \n indicates that the bot is using the improvements, otherwise, false.

" } }, - "createVersion": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#BotName", "traits": { - "smithy.api#documentation": "

\n True if a new version of the bot was created. If the\n createVersion field was not specified in the request, the\n createVersion field is set to false in the response.

" + "smithy.api#documentation": "

The name of the bot.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The date that the bot was created.

" + "smithy.api#documentation": "

Checksum of the bot that you created.

" + } + }, + "abortStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "traits": { + "smithy.api#documentation": "

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

" } } } @@ -4591,28 +4650,10 @@ "com.amazonaws.lexmodelbuildingservice#PutIntentRequest": { "type": "structure", "members": { - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", - "traits": { - "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version.

\n

When you create a new intent, leave the checksum field blank. If you\n specify a checksum you get a BadRequestException exception.

\n

When you want to update a intent, set the checksum field to the checksum\n of the most recent revision of the $LATEST version. If you don't specify the\n checksum field, or if the checksum does not match the $LATEST\n version, you get a PreconditionFailedException exception.

" - } - }, - "kendraConfiguration": { - "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration information required to use the AMAZON.KendraSearchIntent\n intent to connect to an Amazon Kendra index. For more information, see \n AMAZON.KendraSearchIntent.

" - } - }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", - "traits": { - "smithy.api#documentation": "

A description of the intent.

" - } - }, - "fulfillmentActivity": { - "target": "com.amazonaws.lexmodelbuildingservice#FulfillmentActivity", + "conclusionStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

Required. Describes how the intent is fulfilled. For example, after a user provides all\n of the information for a pizza order, fulfillmentActivity defines how the bot\n places an order with a local pizza store.

\n

You might configure Amazon Lex to return all of the intent information to the client\n application, or direct it to invoke a Lambda function that can process the intent (for\n example, place an order with a pizzeria).

" + "smithy.api#documentation": "

The statement that you want Amazon Lex to convey to the user after the intent is\n successfully fulfilled by the Lambda function.

\n

This element is relevant only if you provide a Lambda function in the\n fulfillmentActivity. If you return the intent to the client application, you\n can't specify this element.

\n \n

The followUpPrompt and conclusionStatement are mutually\n exclusive. You can specify only one.

\n " } }, "createVersion": { @@ -4627,16 +4668,34 @@ "smithy.api#documentation": "

An array of utterances (strings) that a user might say to signal the intent. For\n example, \"I want {PizzaSize} pizza\", \"Order {Quantity} {PizzaSize} pizzas\".

\n\n

In each utterance, a slot name is enclosed in curly braces.

" } }, + "rejectionStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "traits": { + "smithy.api#documentation": "

When the user answers \"no\" to the question defined in confirmationPrompt,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

\n \n

You must provide both the rejectionStatement and the\n confirmationPrompt, or neither.

\n " + } + }, + "parentIntentSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", + "traits": { + "smithy.api#documentation": "

A unique identifier for the built-in intent to base this intent on. To find the\n signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

" + } + }, "slots": { "target": "com.amazonaws.lexmodelbuildingservice#SlotList", "traits": { "smithy.api#documentation": "

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user\n using prompts defined in the slots. For more information, see how-it-works.\n

" } }, - "rejectionStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "dialogCodeHook": { + "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", "traits": { - "smithy.api#documentation": "

When the user answers \"no\" to the question defined in confirmationPrompt,\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

\n \n

You must provide both the rejectionStatement and the\n confirmationPrompt, or neither.

\n " + "smithy.api#documentation": "

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda\n function to personalize user interaction.

\n

For example, suppose your bot determines that the user is John. Your Lambda function\n might retrieve John's information from a backend database and prepopulate some of the values.\n For example, if you find that John is gluten intolerant, you might set the corresponding\n intent slot, GlutenIntolerant, to true. You might find John's phone number and\n set the corresponding session attribute.

" + } + }, + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", + "traits": { + "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version.

\n

When you create a new intent, leave the checksum field blank. If you\n specify a checksum you get a BadRequestException exception.

\n

When you want to update a intent, set the checksum field to the checksum\n of the most recent revision of the $LATEST version. If you don't specify the\n checksum field, or if the checksum does not match the $LATEST\n version, you get a PreconditionFailedException exception.

" } }, "name": { @@ -4647,28 +4706,22 @@ "smithy.api#required": {} } }, - "dialogCodeHook": { - "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", - "traits": { - "smithy.api#documentation": "

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda\n function to personalize user interaction.

\n

For example, suppose your bot determines that the user is John. Your Lambda function\n might retrieve John's information from a backend database and prepopulate some of the values.\n For example, if you find that John is gluten intolerant, you might set the corresponding\n intent slot, GlutenIntolerant, to true. You might find John's phone number and\n set the corresponding session attribute.

" - } - }, - "followUpPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#FollowUpPrompt", + "kendraConfiguration": { + "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", "traits": { - "smithy.api#documentation": "

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For\n example, after the OrderPizza intent is fulfilled, you might prompt the user to\n order a drink.

\n

The action that Amazon Lex takes depends on the user's response, as follows:

\n \n\n

The followUpPrompt field and the conclusionStatement field\n are mutually exclusive. You can specify only one.

" + "smithy.api#documentation": "

Configuration information required to use the AMAZON.KendraSearchIntent\n intent to connect to an Amazon Kendra index. For more information, see \n AMAZON.KendraSearchIntent.

" } }, - "parentIntentSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", + "fulfillmentActivity": { + "target": "com.amazonaws.lexmodelbuildingservice#FulfillmentActivity", "traits": { - "smithy.api#documentation": "

A unique identifier for the built-in intent to base this intent on. To find the\n signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

" + "smithy.api#documentation": "

Required. Describes how the intent is fulfilled. For example, after a user provides all\n of the information for a pizza order, fulfillmentActivity defines how the bot\n places an order with a local pizza store.

\n

You might configure Amazon Lex to return all of the intent information to the client\n application, or direct it to invoke a Lambda function that can process the intent (for\n example, place an order with a pizzeria).

" } }, - "conclusionStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

The statement that you want Amazon Lex to convey to the user after the intent is\n successfully fulfilled by the Lambda function.

\n

This element is relevant only if you provide a Lambda function in the\n fulfillmentActivity. If you return the intent to the client application, you\n can't specify this element.

\n \n

The followUpPrompt and conclusionStatement are mutually\n exclusive. You can specify only one.

\n " + "smithy.api#documentation": "

A description of the intent.

" } }, "confirmationPrompt": { @@ -4676,34 +4729,28 @@ "traits": { "smithy.api#documentation": "

Prompts the user to confirm the intent. This question should have a yes or no\n answer.

\n

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready\n for fulfillment. For example, with the OrderPizza intent, you might want to\n confirm that the order is correct before placing it. For other intents, such as intents that\n simply respond to user questions, you might not need to ask the user for confirmation before\n providing the information.

\n \n

You you must provide both the rejectionStatement and the\n confirmationPrompt, or neither.

\n " } + }, + "followUpPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#FollowUpPrompt", + "traits": { + "smithy.api#documentation": "

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For\n example, after the OrderPizza intent is fulfilled, you might prompt the user to\n order a drink.

\n

The action that Amazon Lex takes depends on the user's response, as follows:

\n \n\n

The followUpPrompt field and the conclusionStatement field\n are mutually exclusive. You can specify only one.

" + } } } }, "com.amazonaws.lexmodelbuildingservice#PutIntentResponse": { "type": "structure", "members": { - "conclusionStatement": { - "target": "com.amazonaws.lexmodelbuildingservice#Statement", - "traits": { - "smithy.api#documentation": "

After the Lambda function specified in thefulfillmentActivityintent\n fulfills the intent, Amazon Lex conveys this statement to the user.

" - } - }, - "createVersion": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", - "traits": { - "smithy.api#documentation": "

\n True if a new version of the intent was created. If the\n createVersion field was not specified in the request, the\n createVersion field is set to false in the response.

" - } - }, - "sampleUtterances": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentUtteranceList", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

An array of sample utterances that are configured for the intent.

" + "smithy.api#documentation": "

The date that the intent was created.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "slots": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotList", "traits": { - "smithy.api#documentation": "

The version of the intent. For a new intent, the version is always\n $LATEST.

" + "smithy.api#documentation": "

An array of intent slots that are configured for the intent.

" } }, "lastUpdatedDate": { @@ -4712,28 +4759,40 @@ "smithy.api#documentation": "

The date that the intent was updated. When you create a resource, the creation date and\n last update dates are the same.

" } }, - "followUpPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#FollowUpPrompt", - "traits": { - "smithy.api#documentation": "

If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity\n after the intent is fulfilled.

" - } - }, "fulfillmentActivity": { "target": "com.amazonaws.lexmodelbuildingservice#FulfillmentActivity", "traits": { "smithy.api#documentation": "

If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent\n after the user provides all of the information required by the intent.

" } }, + "followUpPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#FollowUpPrompt", + "traits": { + "smithy.api#documentation": "

If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity\n after the intent is fulfilled.

" + } + }, "description": { "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { "smithy.api#documentation": "

A description of the intent.

" } }, - "slots": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotList", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentName", "traits": { - "smithy.api#documentation": "

An array of intent slots that are configured for the intent.

" + "smithy.api#documentation": "

The name of the intent.

" + } + }, + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", + "traits": { + "smithy.api#documentation": "

Checksum of the $LATESTversion of the intent created or updated.

" + } + }, + "dialogCodeHook": { + "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", + "traits": { + "smithy.api#documentation": "

If defined in the intent, Amazon Lex invokes this Lambda function for each user\n input.

" } }, "rejectionStatement": { @@ -4742,46 +4801,46 @@ "smithy.api#documentation": "

If the user answers \"no\" to the question defined in confirmationPrompt\n Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "createVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

The date that the intent was created.

" + "smithy.api#documentation": "

\n True if a new version of the intent was created. If the\n createVersion field was not specified in the request, the\n createVersion field is set to false in the response.

" } }, - "confirmationPrompt": { - "target": "com.amazonaws.lexmodelbuildingservice#Prompt", + "sampleUtterances": { + "target": "com.amazonaws.lexmodelbuildingservice#IntentUtteranceList", "traits": { - "smithy.api#documentation": "

If defined in the intent, Amazon Lex prompts the user to confirm the intent before\n fulfilling it.

" + "smithy.api#documentation": "

An array of sample utterances that are configured for the intent.

" } }, - "dialogCodeHook": { - "target": "com.amazonaws.lexmodelbuildingservice#CodeHook", + "conclusionStatement": { + "target": "com.amazonaws.lexmodelbuildingservice#Statement", "traits": { - "smithy.api#documentation": "

If defined in the intent, Amazon Lex invokes this Lambda function for each user\n input.

" + "smithy.api#documentation": "

After the Lambda function specified in thefulfillmentActivityintent\n fulfills the intent, Amazon Lex conveys this statement to the user.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#IntentName", + "parentIntentSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", "traits": { - "smithy.api#documentation": "

The name of the intent.

" + "smithy.api#documentation": "

A unique identifier for the built-in intent that this intent is based on.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "kendraConfiguration": { + "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", "traits": { - "smithy.api#documentation": "

Checksum of the $LATESTversion of the intent created or updated.

" + "smithy.api#documentation": "

Configuration information, if any, required to connect to an Amazon Kendra index and use\n the AMAZON.KendraSearchIntent intent.

" } }, - "kendraConfiguration": { - "target": "com.amazonaws.lexmodelbuildingservice#KendraConfiguration", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

Configuration information, if any, required to connect to an Amazon Kendra\n index and use the AMAZON.KendraSearchIntent intent.

" + "smithy.api#documentation": "

The version of the intent. For a new intent, the version is always\n $LATEST.

" } }, - "parentIntentSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#BuiltinIntentSignature", + "confirmationPrompt": { + "target": "com.amazonaws.lexmodelbuildingservice#Prompt", "traits": { - "smithy.api#documentation": "

A unique identifier for the built-in intent that this intent is based on.

" + "smithy.api#documentation": "

If defined in the intent, Amazon Lex prompts the user to confirm the intent before\n fulfilling it.

" } } } @@ -4829,10 +4888,22 @@ "smithy.api#documentation": "

When set to true a new numbered version of the slot type is created. This\n is the same as calling the CreateSlotTypeVersion operation. If you do not specify\n createVersion, the default is false.

" } }, - "valueSelectionStrategy": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotValueSelectionStrategy", + "parentSlotTypeSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", "traits": { - "smithy.api#documentation": "

Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The\n field can be set to one of the following values:

\n \n

If you don't specify the valueSelectionStrategy, the default is\n ORIGINAL_VALUE.

" + "smithy.api#documentation": "

The built-in slot type used as the parent of the slot type. When you define a parent slot\n type, the new slot type has all of the same configuration as the parent.

\n

Only AMAZON.AlphaNumeric is supported.

" + } + }, + "enumerationValues": { + "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", + "traits": { + "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take. Each value can have a list of synonyms, which are additional\n values that help train the machine learning model about the values that it resolves for a\n slot.

\n

A regular expression slot type doesn't require enumeration values. All other slot types\n require a list of enumeration values.

\n

When Amazon Lex resolves a slot value, it generates a resolution list that contains up to\n five possible values for the slot. If you are using a Lambda function, this resolution list is\n passed to the function. If you are not using a Lambda function you can choose to return the\n value that the user entered or the first value in the resolution list as the slot value. The\n valueSelectionStrategy field indicates the option to use.

" + } + }, + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", + "traits": { + "smithy.api#documentation": "

A description of the slot type.

" } }, "slotTypeConfigurations": { @@ -4841,10 +4912,10 @@ "smithy.api#documentation": "

Configuration information that extends the parent built-in slot type. The configuration is\n added to the settings for the parent slot type.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "valueSelectionStrategy": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotValueSelectionStrategy", "traits": { - "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version.

\n

When you create a new slot type, leave the checksum field blank. If you\n specify a checksum you get a BadRequestException exception.

\n

When you want to update a slot type, set the checksum field to the\n checksum of the most recent revision of the $LATEST version. If you don't specify\n the checksum field, or if the checksum does not match the $LATEST\n version, you get a PreconditionFailedException exception.

" + "smithy.api#documentation": "

Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The\n field can be set to one of the following values:

\n \n

If you don't specify the valueSelectionStrategy, the default is\n ORIGINAL_VALUE.

" } }, "name": { @@ -4855,22 +4926,10 @@ "smithy.api#required": {} } }, - "enumerationValues": { - "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", - "traits": { - "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take. Each value can have a list of synonyms, which are additional\n values that help train the machine learning model about the values that it resolves for a\n slot.

\n

When Amazon Lex resolves a slot value, it generates a resolution list that contains up to\n five possible values for the slot. If you are using a Lambda function, this resolution list is\n passed to the function. If you are not using a Lambda function you can choose to return the\n value that the user entered or the first value in the resolution list as the slot value. The\n valueSelectionStrategy field indicates the option to use.

" - } - }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", - "traits": { - "smithy.api#documentation": "

A description of the slot type.

" - } - }, - "parentSlotTypeSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The built-in slot type used as the parent of the slot type. When you define a parent slot\n type, the new slot type has all of the same configuration as the parent.

\n

Only AMAZON.AlphaNumeric is supported.

" + "smithy.api#documentation": "

Identifies a specific revision of the $LATEST version.

\n

When you create a new slot type, leave the checksum field blank. If you\n specify a checksum you get a BadRequestException exception.

\n

When you want to update a slot type, set the checksum field to the\n checksum of the most recent revision of the $LATEST version. If you don't specify\n the checksum field, or if the checksum does not match the $LATEST\n version, you get a PreconditionFailedException exception.

" } } } @@ -4884,10 +4943,10 @@ "smithy.api#documentation": "

Configuration information that extends the parent built-in slot type.

" } }, - "valueSelectionStrategy": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotValueSelectionStrategy", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For\n more information, see PutSlotType.

" + "smithy.api#documentation": "

The date that the slot type was created.

" } }, "lastUpdatedDate": { @@ -4896,52 +4955,52 @@ "smithy.api#documentation": "

The date that the slot type was updated. When you create a slot type, the creation date\n and last update date are the same.

" } }, - "description": { - "target": "com.amazonaws.lexmodelbuildingservice#Description", + "valueSelectionStrategy": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotValueSelectionStrategy", "traits": { - "smithy.api#documentation": "

A description of the slot type.

" + "smithy.api#documentation": "

The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For\n more information, see PutSlotType.

" } }, - "checksum": { - "target": "com.amazonaws.lexmodelbuildingservice#String", + "enumerationValues": { + "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", "traits": { - "smithy.api#documentation": "

Checksum of the $LATEST version of the slot type.

" + "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeName", + "createVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Boolean", "traits": { - "smithy.api#documentation": "

The name of the slot type.

" + "smithy.api#documentation": "

\n True if a new version of the slot type was created. If the\n createVersion field was not specified in the request, the\n createVersion field is set to false in the response.

" } }, - "version": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "parentSlotTypeSignature": { + "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", "traits": { - "smithy.api#documentation": "

The version of the slot type. For a new slot type, the version is always\n $LATEST.

" + "smithy.api#documentation": "

The built-in slot type used as the parent of the slot type.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "description": { + "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { - "smithy.api#documentation": "

The date that the slot type was created.

" + "smithy.api#documentation": "

A description of the slot type.

" } }, - "createVersion": { - "target": "com.amazonaws.lexmodelbuildingservice#Boolean", + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotTypeName", "traits": { - "smithy.api#documentation": "

\n True if a new version of the slot type was created. If the\n createVersion field was not specified in the request, the\n createVersion field is set to false in the response.

" + "smithy.api#documentation": "

The name of the slot type.

" } }, - "parentSlotTypeSignature": { - "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", + "checksum": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

The built-in slot type used as the parent of the slot type.

" + "smithy.api#documentation": "

Checksum of the $LATEST version of the slot type.

" } }, - "enumerationValues": { - "target": "com.amazonaws.lexmodelbuildingservice#EnumerationValues", + "version": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

A list of EnumerationValue objects that defines the values that the slot\n type can take.

" + "smithy.api#documentation": "

The version of the slot type. For a new slot type, the version is always\n $LATEST.

" } } } @@ -4999,11 +5058,11 @@ "com.amazonaws.lexmodelbuildingservice#ResourceInUseException": { "type": "structure", "members": { - "referenceType": { - "target": "com.amazonaws.lexmodelbuildingservice#ReferenceType" - }, "exampleReference": { "target": "com.amazonaws.lexmodelbuildingservice#ResourceReference" + }, + "referenceType": { + "target": "com.amazonaws.lexmodelbuildingservice#ReferenceType" } }, "traits": { @@ -5088,29 +5147,23 @@ "smithy.api#documentation": "

A description of the slot.

" } }, - "name": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotName", + "slotConstraint": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotConstraint", "traits": { - "smithy.api#documentation": "

The name of the slot.

", + "smithy.api#documentation": "

Specifies whether the slot is required or optional.

", "smithy.api#required": {} } }, - "obfuscationSetting": { - "target": "com.amazonaws.lexmodelbuildingservice#ObfuscationSetting", - "traits": { - "smithy.api#documentation": "

Determines whether a slot is obfuscated in conversation logs and stored utterances. When\n you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For\n example, if the slot name is \"full_name\", obfuscated values are replaced with \"{full_name}\".\n For more information, see \n Slot Obfuscation .

" - } - }, - "priority": { - "target": "com.amazonaws.lexmodelbuildingservice#Priority", + "slotTypeVersion": { + "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { - "smithy.api#documentation": "

Directs Amazon Lex the order in which to elicit this slot value from the user. For example,\n if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the\n slot with priority 1.

\n

If multiple slots share the same priority, the order in which Amazon Lex elicits values is\n arbitrary.

" + "smithy.api#documentation": "

The version of the slot type.

" } }, - "sampleUtterances": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotUtteranceList", + "slotType": { + "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", "traits": { - "smithy.api#documentation": "

If you know a specific pattern with which users might respond to an Amazon Lex request for\n a slot value, you can provide those utterances to improve accuracy. This is optional. In most\n cases, Amazon Lex is capable of understanding user utterances.

" + "smithy.api#documentation": "

The type of the slot, either a custom slot type that you defined or one of the built-in\n slot types.

" } }, "responseCard": { @@ -5125,23 +5178,29 @@ "smithy.api#documentation": "

The prompt that Amazon Lex uses to elicit the slot value from the user.

" } }, - "slotTypeVersion": { - "target": "com.amazonaws.lexmodelbuildingservice#Version", + "sampleUtterances": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotUtteranceList", "traits": { - "smithy.api#documentation": "

The version of the slot type.

" + "smithy.api#documentation": "

If you know a specific pattern with which users might respond to an Amazon Lex request for\n a slot value, you can provide those utterances to improve accuracy. This is optional. In most\n cases, Amazon Lex is capable of understanding user utterances.

" } }, - "slotConstraint": { - "target": "com.amazonaws.lexmodelbuildingservice#SlotConstraint", + "priority": { + "target": "com.amazonaws.lexmodelbuildingservice#Priority", "traits": { - "smithy.api#documentation": "

Specifies whether the slot is required or optional.

", + "smithy.api#documentation": "

Directs Amazon Lex the order in which to elicit this slot value from the user. For example,\n if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the\n slot with priority 1.

\n

If multiple slots share the same priority, the order in which Amazon Lex elicits values is\n arbitrary.

" + } + }, + "name": { + "target": "com.amazonaws.lexmodelbuildingservice#SlotName", + "traits": { + "smithy.api#documentation": "

The name of the slot.

", "smithy.api#required": {} } }, - "slotType": { - "target": "com.amazonaws.lexmodelbuildingservice#CustomOrBuiltinSlotTypeName", + "obfuscationSetting": { + "target": "com.amazonaws.lexmodelbuildingservice#ObfuscationSetting", "traits": { - "smithy.api#documentation": "

The type of the slot, either a custom slot type that you defined or one of the built-in\n slot types.

" + "smithy.api#documentation": "

Determines whether a slot is obfuscated in conversation logs and stored utterances. When\n you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For\n example, if the slot name is \"full_name\", obfuscated values are replaced with \"{full_name}\".\n For more information, see \n Slot Obfuscation .

" } } }, @@ -5221,18 +5280,18 @@ "smithy.api#documentation": "

The date that the slot type was created.

" } }, - "lastUpdatedDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the slot type was updated. When you create a resource, the creation date\n and last updated date are the same.

" - } - }, "version": { "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { "smithy.api#documentation": "

The version of the slot type.

" } }, + "lastUpdatedDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the slot type was updated. When you create a resource, the creation date\n and last updated date are the same.

" + } + }, "description": { "target": "com.amazonaws.lexmodelbuildingservice#Description", "traits": { @@ -5352,17 +5411,17 @@ "smithy.api#required": {} } }, - "payload": { - "target": "com.amazonaws.lexmodelbuildingservice#Blob", + "mergeStrategy": { + "target": "com.amazonaws.lexmodelbuildingservice#MergeStrategy", "traits": { - "smithy.api#documentation": "

A zip archive in binary format. The archive should contain one file, a JSON file\n containing the resource to import. The resource should match the type specified in the\n resourceType field.

", + "smithy.api#documentation": "

Specifies the action that the StartImport operation should take when there\n is an existing resource with the same name.

\n ", "smithy.api#required": {} } }, - "mergeStrategy": { - "target": "com.amazonaws.lexmodelbuildingservice#MergeStrategy", + "payload": { + "target": "com.amazonaws.lexmodelbuildingservice#Blob", "traits": { - "smithy.api#documentation": "

Specifies the action that the StartImport operation should take when there\n is an existing resource with the same name.

\n ", + "smithy.api#documentation": "

A zip archive in binary format. The archive should contain one file, a JSON file\n containing the resource to import. The resource should match the type specified in the\n resourceType field.

", "smithy.api#required": {} } } @@ -5371,28 +5430,28 @@ "com.amazonaws.lexmodelbuildingservice#StartImportResponse": { "type": "structure", "members": { - "importId": { - "target": "com.amazonaws.lexmodelbuildingservice#String", - "traits": { - "smithy.api#documentation": "

The identifier for the specific import job.

" - } - }, "importStatus": { "target": "com.amazonaws.lexmodelbuildingservice#ImportStatus", "traits": { "smithy.api#documentation": "

The status of the import job. If the status is FAILED, you can get the\n reason for the failure using the GetImport operation.

" } }, - "tags": { - "target": "com.amazonaws.lexmodelbuildingservice#TagList", + "importId": { + "target": "com.amazonaws.lexmodelbuildingservice#String", "traits": { - "smithy.api#documentation": "

A list of tags added to the imported bot.

" + "smithy.api#documentation": "

The identifier for the specific import job.

" } }, - "resourceType": { - "target": "com.amazonaws.lexmodelbuildingservice#ResourceType", + "createdDate": { + "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The type of resource to import.

" + "smithy.api#documentation": "

A timestamp for the date and time that the import job was requested.

" + } + }, + "mergeStrategy": { + "target": "com.amazonaws.lexmodelbuildingservice#MergeStrategy", + "traits": { + "smithy.api#documentation": "

The action to take when there is a merge conflict.

" } }, "name": { @@ -5401,16 +5460,16 @@ "smithy.api#documentation": "

The name given to the import job.

" } }, - "createdDate": { - "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", + "tags": { + "target": "com.amazonaws.lexmodelbuildingservice#TagList", "traits": { - "smithy.api#documentation": "

A timestamp for the date and time that the import job was requested.

" + "smithy.api#documentation": "

A list of tags added to the imported bot.

" } }, - "mergeStrategy": { - "target": "com.amazonaws.lexmodelbuildingservice#MergeStrategy", + "resourceType": { + "target": "com.amazonaws.lexmodelbuildingservice#ResourceType", "traits": { - "smithy.api#documentation": "

The action to take when there is a merge conflict.

" + "smithy.api#documentation": "

The type of resource to import.

" } } } @@ -5655,14 +5714,6 @@ "com.amazonaws.lexmodelbuildingservice#UntagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.lexmodelbuildingservice#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove the tags from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "tagKeys": { "target": "com.amazonaws.lexmodelbuildingservice#TagKeyList", "traits": { @@ -5670,6 +5721,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "resourceArn": { + "target": "com.amazonaws.lexmodelbuildingservice#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove the tags from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -5704,28 +5763,28 @@ "smithy.api#documentation": "

The text that was entered by the user or the text representation of an audio\n clip.

" } }, - "firstUtteredDate": { + "lastUtteredDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the utterance was first recorded.

" + "smithy.api#documentation": "

The date that the utterance was last recorded.

" } }, - "distinctUsers": { + "count": { "target": "com.amazonaws.lexmodelbuildingservice#Count", "traits": { - "smithy.api#documentation": "

The total number of individuals that used the utterance.

" + "smithy.api#documentation": "

The number of times that the utterance was processed.

" } }, - "count": { + "distinctUsers": { "target": "com.amazonaws.lexmodelbuildingservice#Count", "traits": { - "smithy.api#documentation": "

The number of times that the utterance was processed.

" + "smithy.api#documentation": "

The total number of individuals that used the utterance.

" } }, - "lastUtteredDate": { + "firstUtteredDate": { "target": "com.amazonaws.lexmodelbuildingservice#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the utterance was last recorded.

" + "smithy.api#documentation": "

The date that the utterance was first recorded.

" } } }, @@ -5736,17 +5795,17 @@ "com.amazonaws.lexmodelbuildingservice#UtteranceList": { "type": "structure", "members": { - "utterances": { - "target": "com.amazonaws.lexmodelbuildingservice#ListOfUtterance", - "traits": { - "smithy.api#documentation": "

One or more UtteranceData objects that contain information about the\n utterances that have been made to a bot. The maximum number of object is 100.

" - } - }, "botVersion": { "target": "com.amazonaws.lexmodelbuildingservice#Version", "traits": { "smithy.api#documentation": "

The version of the bot that processed the list.

" } + }, + "utterances": { + "target": "com.amazonaws.lexmodelbuildingservice#ListOfUtterance", + "traits": { + "smithy.api#documentation": "

One or more UtteranceData objects that contain information about the\n utterances that have been made to a bot. The maximum number of object is 100.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/lex-runtime-service.2016-11-28.json b/codegen/sdk-codegen/aws-models/lex-runtime-service.2016-11-28.json index d98a8fa69c05..93bbe2e9c587 100644 --- a/codegen/sdk-codegen/aws-models/lex-runtime-service.2016-11-28.json +++ b/codegen/sdk-codegen/aws-models/lex-runtime-service.2016-11-28.json @@ -54,7 +54,7 @@ "sdkId": "Lex Runtime Service", "arnNamespace": "lex", "cloudFormationName": "LexRuntimeService", - "cloudTrailEventSource": "runtimeservice.deepsense.amazonaws.com" + "cloudTrailEventSource": "lexruntimeservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "lex" @@ -105,20 +105,30 @@ "com.amazonaws.lexruntimeservice#BotName": { "type": "string" }, + "com.amazonaws.lexruntimeservice#BotVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[0-9]+|\\$LATEST" + } + }, "com.amazonaws.lexruntimeservice#Button": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.lexruntimeservice#ButtonValueStringWithLength", + "text": { + "target": "com.amazonaws.lexruntimeservice#ButtonTextStringWithLength", "traits": { - "smithy.api#documentation": "

The value sent to Amazon Lex when a user chooses the button. For example, consider button\n text \"NYC.\" When the user chooses the button, the value sent can be \"New York City.\"

", + "smithy.api#documentation": "

Text that is visible to the user on the button.

", "smithy.api#required": {} } }, - "text": { - "target": "com.amazonaws.lexruntimeservice#ButtonTextStringWithLength", + "value": { + "target": "com.amazonaws.lexruntimeservice#ButtonValueStringWithLength", "traits": { - "smithy.api#documentation": "

Text that is visible to the user on the button.

", + "smithy.api#documentation": "

The value sent to Amazon Lex when a user chooses the button. For example, consider button\n text \"NYC.\" When the user chooses the button, the value sent can be \"New York City.\"

", "smithy.api#required": {} } } @@ -225,6 +235,14 @@ "com.amazonaws.lexruntimeservice#DeleteSessionRequest": { "type": "structure", "members": { + "botAlias": { + "target": "com.amazonaws.lexruntimeservice#BotAlias", + "traits": { + "smithy.api#documentation": "

The alias in use for the bot that contains the session data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "userId": { "target": "com.amazonaws.lexruntimeservice#UserId", "traits": { @@ -240,14 +258,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "botAlias": { - "target": "com.amazonaws.lexruntimeservice#BotAlias", - "traits": { - "smithy.api#documentation": "

The alias in use for the bot that contains the session data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -260,12 +270,6 @@ "smithy.api#documentation": "

The alias in use for the bot associated with the session data.

" } }, - "sessionId": { - "target": "com.amazonaws.lexruntimeservice#String", - "traits": { - "smithy.api#documentation": "

The unique identifier for the session.

" - } - }, "userId": { "target": "com.amazonaws.lexruntimeservice#UserId", "traits": { @@ -277,6 +281,12 @@ "traits": { "smithy.api#documentation": "

The name of the bot associated with the session data.

" } + }, + "sessionId": { + "target": "com.amazonaws.lexruntimeservice#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the session.

" + } } } }, @@ -296,47 +306,47 @@ "com.amazonaws.lexruntimeservice#DialogAction": { "type": "structure", "members": { - "slotToElicit": { - "target": "com.amazonaws.lexruntimeservice#String", + "slots": { + "target": "com.amazonaws.lexruntimeservice#StringMap", "traits": { - "smithy.api#documentation": "

The name of the slot that should be elicited from the user.

" + "smithy.api#documentation": "

Map of the slots that have been gathered and their values.

" } }, - "message": { - "target": "com.amazonaws.lexruntimeservice#Text", + "messageFormat": { + "target": "com.amazonaws.lexruntimeservice#MessageFormatType", "traits": { - "smithy.api#documentation": "

The message that should be shown to the user. If you don't specify a message, Amazon Lex will\n use the message configured for the intent.

" + "smithy.api#documentation": "" } }, - "type": { - "target": "com.amazonaws.lexruntimeservice#DialogActionType", + "intentName": { + "target": "com.amazonaws.lexruntimeservice#IntentName", "traits": { - "smithy.api#documentation": "

The next action that the bot should take in its interaction with the user. The possible\n values are:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the intent.

" } }, - "fulfillmentState": { - "target": "com.amazonaws.lexruntimeservice#FulfillmentState", + "slotToElicit": { + "target": "com.amazonaws.lexruntimeservice#String", "traits": { - "smithy.api#documentation": "

The fulfillment state of the intent. The possible values are:

\n " + "smithy.api#documentation": "

The name of the slot that should be elicited from the user.

" } }, - "slots": { - "target": "com.amazonaws.lexruntimeservice#StringMap", + "fulfillmentState": { + "target": "com.amazonaws.lexruntimeservice#FulfillmentState", "traits": { - "smithy.api#documentation": "

Map of the slots that have been gathered and their values.

" + "smithy.api#documentation": "

The fulfillment state of the intent. The possible values are:

\n " } }, - "intentName": { - "target": "com.amazonaws.lexruntimeservice#IntentName", + "type": { + "target": "com.amazonaws.lexruntimeservice#DialogActionType", "traits": { - "smithy.api#documentation": "

The name of the intent.

" + "smithy.api#documentation": "

The next action that the bot should take in its interaction with the user. The possible\n values are:

\n ", + "smithy.api#required": {} } }, - "messageFormat": { - "target": "com.amazonaws.lexruntimeservice#MessageFormatType", + "message": { + "target": "com.amazonaws.lexruntimeservice#Text", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "

The message that should be shown to the user. If you don't specify a message, Amazon Lex will\n use the message configured for the intent.

" } } }, @@ -402,6 +412,9 @@ ] } }, + "com.amazonaws.lexruntimeservice#Double": { + "type": "double" + }, "com.amazonaws.lexruntimeservice#ErrorMessage": { "type": "string" }, @@ -427,10 +440,10 @@ "com.amazonaws.lexruntimeservice#GenericAttachment": { "type": "structure", "members": { - "title": { + "subTitle": { "target": "com.amazonaws.lexruntimeservice#StringWithLength", "traits": { - "smithy.api#documentation": "

The title of the option.

" + "smithy.api#documentation": "

The subtitle shown below the title.

" } }, "attachmentLinkUrl": { @@ -439,22 +452,22 @@ "smithy.api#documentation": "

The URL of an attachment to the response card.

" } }, - "imageUrl": { - "target": "com.amazonaws.lexruntimeservice#StringUrlWithLength", - "traits": { - "smithy.api#documentation": "

The URL of an image that is displayed to the user.

" - } - }, "buttons": { "target": "com.amazonaws.lexruntimeservice#listOfButtons", "traits": { "smithy.api#documentation": "

The list of options to show to the user.

" } }, - "subTitle": { + "title": { "target": "com.amazonaws.lexruntimeservice#StringWithLength", "traits": { - "smithy.api#documentation": "

The subtitle shown below the title.

" + "smithy.api#documentation": "

The title of the option.

" + } + }, + "imageUrl": { + "target": "com.amazonaws.lexruntimeservice#StringUrlWithLength", + "traits": { + "smithy.api#documentation": "

The URL of an image that is displayed to the user.

" } } }, @@ -496,21 +509,6 @@ "com.amazonaws.lexruntimeservice#GetSessionRequest": { "type": "structure", "members": { - "botName": { - "target": "com.amazonaws.lexruntimeservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the bot that contains the session data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "checkpointLabelFilter": { - "target": "com.amazonaws.lexruntimeservice#IntentSummaryCheckpointLabel", - "traits": { - "smithy.api#documentation": "

A string used to filter the intents returned in the recentIntentSummaryView\n structure.

\n

When you specify a filter, only intents with their checkpointLabel field set\n to that string are returned.

", - "smithy.api#httpQuery": "checkpointLabelFilter" - } - }, "botAlias": { "target": "com.amazonaws.lexruntimeservice#BotAlias", "traits": { @@ -526,6 +524,21 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "botName": { + "target": "com.amazonaws.lexruntimeservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the bot that contains the session data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "checkpointLabelFilter": { + "target": "com.amazonaws.lexruntimeservice#IntentSummaryCheckpointLabel", + "traits": { + "smithy.api#documentation": "

A string used to filter the intents returned in the recentIntentSummaryView\n structure.

\n

When you specify a filter, only intents with their checkpointLabel field set\n to that string are returned.

", + "smithy.api#httpQuery": "checkpointLabelFilter" + } } } }, @@ -538,18 +551,18 @@ "smithy.api#documentation": "

Describes the current state of the bot.

" } }, - "sessionId": { - "target": "com.amazonaws.lexruntimeservice#String", - "traits": { - "smithy.api#documentation": "

A unique identifier for the session.

" - } - }, "recentIntentSummaryView": { "target": "com.amazonaws.lexruntimeservice#IntentSummaryList", "traits": { "smithy.api#documentation": "

An array of information about the intents used in the session. The array can contain a\n maximum of three summaries. If more than three intents are used in the session, the\n recentIntentSummaryView operation contains information about the last three\n intents used.

\n

If you set the checkpointLabelFilter parameter in the request, the array\n contains only the intents with the specified label.

" } }, + "sessionId": { + "target": "com.amazonaws.lexruntimeservice#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the session.

" + } + }, "sessionAttributes": { "target": "com.amazonaws.lexruntimeservice#StringMap", "traits": { @@ -561,35 +574,54 @@ "com.amazonaws.lexruntimeservice#HttpContentType": { "type": "string" }, + "com.amazonaws.lexruntimeservice#IntentConfidence": { + "type": "structure", + "members": { + "score": { + "target": "com.amazonaws.lexruntimeservice#Double", + "traits": { + "smithy.api#documentation": "

A score that indicates how confident Amazon Lex is that an intent satisfies the user's intent.\n Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a score that indicates the confidence that Amazon Lex has that an intent is the one\n that satisfies the user's intent.

" + } + }, + "com.amazonaws.lexruntimeservice#IntentList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexruntimeservice#PredictedIntent" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, "com.amazonaws.lexruntimeservice#IntentName": { "type": "string" }, "com.amazonaws.lexruntimeservice#IntentSummary": { "type": "structure", "members": { - "fulfillmentState": { - "target": "com.amazonaws.lexruntimeservice#FulfillmentState", - "traits": { - "smithy.api#documentation": "

The fulfillment state of the intent. The possible values are:

\n " - } - }, - "dialogActionType": { - "target": "com.amazonaws.lexruntimeservice#DialogActionType", - "traits": { - "smithy.api#documentation": "

The next action that the bot should take in its interaction with the user. The possible\n values are:

\n ", - "smithy.api#required": {} - } - }, "checkpointLabel": { "target": "com.amazonaws.lexruntimeservice#IntentSummaryCheckpointLabel", "traits": { "smithy.api#documentation": "

A user-defined label that identifies a particular intent. You can use this label to return\n to a previous intent.

\n

Use the checkpointLabelFilter parameter of the GetSessionRequest\n operation to filter the intents returned by the operation to those with only the specified\n label.

" } }, - "slotToElicit": { - "target": "com.amazonaws.lexruntimeservice#String", + "confirmationStatus": { + "target": "com.amazonaws.lexruntimeservice#ConfirmationStatus", "traits": { - "smithy.api#documentation": "

The next slot to elicit from the user. If there is not slot to elicit, the field is\n blank.

" + "smithy.api#documentation": "

The status of the intent after the user responds to the confirmation prompt. If the user\n confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the\n intent, Amazon Lex sets this value to Denied. The possible values are:

\n " + } + }, + "intentName": { + "target": "com.amazonaws.lexruntimeservice#IntentName", + "traits": { + "smithy.api#documentation": "

The name of the intent.

" } }, "slots": { @@ -598,16 +630,23 @@ "smithy.api#documentation": "

Map of the slots that have been gathered and their values.

" } }, - "confirmationStatus": { - "target": "com.amazonaws.lexruntimeservice#ConfirmationStatus", + "fulfillmentState": { + "target": "com.amazonaws.lexruntimeservice#FulfillmentState", "traits": { - "smithy.api#documentation": "

The status of the intent after the user responds to the confirmation prompt. If the user\n confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the\n intent, Amazon Lex sets this value to Denied. The possible values are:

\n " + "smithy.api#documentation": "

The fulfillment state of the intent. The possible values are:

\n " } }, - "intentName": { - "target": "com.amazonaws.lexruntimeservice#IntentName", + "slotToElicit": { + "target": "com.amazonaws.lexruntimeservice#String", "traits": { - "smithy.api#documentation": "

The name of the intent.

" + "smithy.api#documentation": "

The next slot to elicit from the user. If there is not slot to elicit, the field is\n blank.

" + } + }, + "dialogActionType": { + "target": "com.amazonaws.lexruntimeservice#DialogActionType", + "traits": { + "smithy.api#documentation": "

The next action that the bot should take in its interaction with the user. The possible\n values are:

\n ", + "smithy.api#required": {} } } }, @@ -788,6 +827,29 @@ "com.amazonaws.lexruntimeservice#PostContentRequest": { "type": "structure", "members": { + "requestAttributes": { + "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonAttributesString", + "traits": { + "smithy.api#documentation": "

You pass this value as the x-amz-lex-request-attributes HTTP header.

\n

Request-specific information passed between Amazon Lex and a client application. The value must\n be a JSON serialized and base64 encoded map with string keys and values. The total size of the\n requestAttributes and sessionAttributes headers is limited to 12\n KB.

\n

The namespace x-amz-lex: is reserved for special attributes. Don't create any\n request attributes with the prefix x-amz-lex:.

\n

For more information, see Setting Request\n Attributes.

", + "smithy.api#httpHeader": "x-amz-lex-request-attributes" + } + }, + "botAlias": { + "target": "com.amazonaws.lexruntimeservice#BotAlias", + "traits": { + "smithy.api#documentation": "

Alias of the Amazon Lex bot.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botName": { + "target": "com.amazonaws.lexruntimeservice#BotName", + "traits": { + "smithy.api#documentation": "

Name of the Amazon Lex bot.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "inputStream": { "target": "com.amazonaws.lexruntimeservice#BlobStream", "traits": { @@ -803,18 +865,12 @@ "smithy.api#httpHeader": "x-amz-lex-session-attributes" } }, - "requestAttributes": { - "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonAttributesString", - "traits": { - "smithy.api#documentation": "

You pass this value as the x-amz-lex-request-attributes HTTP header.

\n

Request-specific information passed between Amazon Lex and a client application. The value must\n be a JSON serialized and base64 encoded map with string keys and values. The total size of the\n requestAttributes and sessionAttributes headers is limited to 12\n KB.

\n

The namespace x-amz-lex: is reserved for special attributes. Don't create any\n request attributes with the prefix x-amz-lex:.

\n

For more information, see Setting Request\n Attributes.

", - "smithy.api#httpHeader": "x-amz-lex-request-attributes" - } - }, - "accept": { - "target": "com.amazonaws.lexruntimeservice#Accept", + "userId": { + "target": "com.amazonaws.lexruntimeservice#UserId", "traits": { - "smithy.api#documentation": "

You pass this value as the Accept HTTP header.

\n

The message Amazon Lex returns in the response can be either text or speech based on the\n Accept HTTP header value in the request.

\n ", - "smithy.api#httpHeader": "Accept" + "smithy.api#documentation": "

The ID of the client application user. Amazon Lex uses this to identify a user's conversation\n with your bot. At runtime, each request must contain the userID field.

\n

To decide the user ID to use for your application, consider the following factors.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "contentType": { @@ -825,28 +881,11 @@ "smithy.api#required": {} } }, - "userId": { - "target": "com.amazonaws.lexruntimeservice#UserId", - "traits": { - "smithy.api#documentation": "

The ID of the client application user. Amazon Lex uses this to identify a user's conversation\n with your bot. At runtime, each request must contain the userID field.

\n

To decide the user ID to use for your application, consider the following factors.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "botName": { - "target": "com.amazonaws.lexruntimeservice#BotName", - "traits": { - "smithy.api#documentation": "

Name of the Amazon Lex bot.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "botAlias": { - "target": "com.amazonaws.lexruntimeservice#BotAlias", + "accept": { + "target": "com.amazonaws.lexruntimeservice#Accept", "traits": { - "smithy.api#documentation": "

Alias of the Amazon Lex bot.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

You pass this value as the Accept HTTP header.

\n

The message Amazon Lex returns in the response can be either text or speech based on the\n Accept HTTP header value in the request.

\n ", + "smithy.api#httpHeader": "Accept" } } } @@ -854,18 +893,25 @@ "com.amazonaws.lexruntimeservice#PostContentResponse": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.lexruntimeservice#Text", + "alternativeIntents": { + "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", "traits": { - "smithy.api#documentation": "

The message to convey to the user. The message can come from the bot's configuration or\n from a Lambda function.

\n

If the intent is not configured with a Lambda function, or if the Lambda function returned\n Delegate as the dialogAction.type in its response, Amazon Lex decides\n on the next course of action and selects an appropriate message from the bot's configuration\n based on the current interaction context. For example, if Amazon Lex isn't able to understand user\n input, it uses a clarification prompt message.

\n

When you create an intent you can assign messages to groups. When messages are assigned to\n groups Amazon Lex returns one message from each group in the response. The message field is an\n escaped JSON string containing the messages. For more information about the structure of the\n JSON string returned, see msg-prompts-formats.

\n

If the Lambda function returns a message, Amazon Lex passes it to the client in its\n response.

", - "smithy.api#httpHeader": "x-amz-lex-message" + "smithy.api#documentation": "

One to four alternative intents that may be applicable to the user's intent.

\n

Each alternative includes a score that indicates how confident Amazon Lex is that the intent\n matches the user's intent. The intents are sorted by the confidence score.

", + "smithy.api#httpHeader": "x-amz-lex-alternative-intents" } }, - "slots": { - "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", + "messageFormat": { + "target": "com.amazonaws.lexruntimeservice#MessageFormatType", "traits": { - "smithy.api#documentation": "

Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input\n during the conversation. The field is base-64 encoded.

\n

Amazon Lex creates a resolution list containing likely values for a slot. The value that it\n returns is determined by the valueSelectionStrategy selected when the slot type\n was created or updated. If valueSelectionStrategy is set to\n ORIGINAL_VALUE, the value provided by the user is returned, if the user value\n is similar to the slot values. If valueSelectionStrategy is set to\n TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if\n there is no resolution list, null. If you don't specify a valueSelectionStrategy,\n the default is ORIGINAL_VALUE.

", - "smithy.api#httpHeader": "x-amz-lex-slots" + "smithy.api#documentation": "

The format of the response message. One of the following values:

\n ", + "smithy.api#httpHeader": "x-amz-lex-message-format" + } + }, + "contentType": { + "target": "com.amazonaws.lexruntimeservice#HttpContentType", + "traits": { + "smithy.api#documentation": "

Content type as specified in the Accept HTTP header in the request.

", + "smithy.api#httpHeader": "Content-Type" } }, "audioStream": { @@ -875,18 +921,32 @@ "smithy.api#httpPayload": {} } }, - "dialogState": { - "target": "com.amazonaws.lexruntimeservice#DialogState", + "message": { + "target": "com.amazonaws.lexruntimeservice#Text", "traits": { - "smithy.api#documentation": "

Identifies the current state of the user interaction. Amazon Lex returns one of the following\n values as dialogState. The client can optionally use this information to\n customize the user interface.

\n ", - "smithy.api#httpHeader": "x-amz-lex-dialog-state" + "smithy.api#documentation": "

The message to convey to the user. The message can come from the bot's configuration or\n from a Lambda function.

\n

If the intent is not configured with a Lambda function, or if the Lambda function returned\n Delegate as the dialogAction.type in its response, Amazon Lex decides\n on the next course of action and selects an appropriate message from the bot's configuration\n based on the current interaction context. For example, if Amazon Lex isn't able to understand user\n input, it uses a clarification prompt message.

\n

When you create an intent you can assign messages to groups. When messages are assigned to\n groups Amazon Lex returns one message from each group in the response. The message field is an\n escaped JSON string containing the messages. For more information about the structure of the\n JSON string returned, see msg-prompts-formats.

\n

If the Lambda function returns a message, Amazon Lex passes it to the client in its\n response.

", + "smithy.api#httpHeader": "x-amz-lex-message" } }, - "intentName": { - "target": "com.amazonaws.lexruntimeservice#IntentName", + "botVersion": { + "target": "com.amazonaws.lexruntimeservice#BotVersion", "traits": { - "smithy.api#documentation": "

Current user intent that Amazon Lex is aware of.

", - "smithy.api#httpHeader": "x-amz-lex-intent-name" + "smithy.api#documentation": "

The version of the bot that responded to the conversation. You can use this information to\n help determine if one version of a bot is performing better than another version.

\n

If you have enabled the new natural language understanding (NLU) model, you can use this\n to determine if the improvement is due to changes to the bot or changes to the NLU.

\n

For more information about enabling the new NLU, see the enableModelImprovements parameter of the PutBot operation.

", + "smithy.api#httpHeader": "x-amz-lex-bot-version" + } + }, + "sentimentResponse": { + "target": "com.amazonaws.lexruntimeservice#String", + "traits": { + "smithy.api#documentation": "

The sentiment expressed in an utterance.

\n

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis,\n this field contains the result of the analysis.

", + "smithy.api#httpHeader": "x-amz-lex-sentiment" + } + }, + "slots": { + "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", + "traits": { + "smithy.api#documentation": "

Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input\n during the conversation. The field is base-64 encoded.

\n

Amazon Lex creates a resolution list containing likely values for a slot. The value that it\n returns is determined by the valueSelectionStrategy selected when the slot type\n was created or updated. If valueSelectionStrategy is set to\n ORIGINAL_VALUE, the value provided by the user is returned, if the user value\n is similar to the slot values. If valueSelectionStrategy is set to\n TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if\n there is no resolution list, null. If you don't specify a valueSelectionStrategy,\n the default is ORIGINAL_VALUE.

", + "smithy.api#httpHeader": "x-amz-lex-slots" } }, "inputTranscript": { @@ -896,18 +956,18 @@ "smithy.api#httpHeader": "x-amz-lex-input-transcript" } }, - "messageFormat": { - "target": "com.amazonaws.lexruntimeservice#MessageFormatType", + "slotToElicit": { + "target": "com.amazonaws.lexruntimeservice#String", "traits": { - "smithy.api#documentation": "

The format of the response message. One of the following values:

\n ", - "smithy.api#httpHeader": "x-amz-lex-message-format" + "smithy.api#documentation": "

If the dialogState value is ElicitSlot, returns the name of the\n slot for which Amazon Lex is eliciting a value.

", + "smithy.api#httpHeader": "x-amz-lex-slot-to-elicit" } }, - "contentType": { - "target": "com.amazonaws.lexruntimeservice#HttpContentType", + "sessionAttributes": { + "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", "traits": { - "smithy.api#documentation": "

Content type as specified in the Accept HTTP header in the request.

", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

Map of key/value pairs representing the session-specific context information.

", + "smithy.api#httpHeader": "x-amz-lex-session-attributes" } }, "sessionId": { @@ -917,25 +977,25 @@ "smithy.api#httpHeader": "x-amz-lex-session-id" } }, - "sessionAttributes": { - "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", + "dialogState": { + "target": "com.amazonaws.lexruntimeservice#DialogState", "traits": { - "smithy.api#documentation": "

Map of key/value pairs representing the session-specific context information.

", - "smithy.api#httpHeader": "x-amz-lex-session-attributes" + "smithy.api#documentation": "

Identifies the current state of the user interaction. Amazon Lex returns one of the following\n values as dialogState. The client can optionally use this information to\n customize the user interface.

\n ", + "smithy.api#httpHeader": "x-amz-lex-dialog-state" } }, - "sentimentResponse": { - "target": "com.amazonaws.lexruntimeservice#String", + "intentName": { + "target": "com.amazonaws.lexruntimeservice#IntentName", "traits": { - "smithy.api#documentation": "

The sentiment expressed in and utterance.

\n

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis,\n this field contains the result of the analysis.

", - "smithy.api#httpHeader": "x-amz-lex-sentiment" + "smithy.api#documentation": "

Current user intent that Amazon Lex is aware of.

", + "smithy.api#httpHeader": "x-amz-lex-intent-name" } }, - "slotToElicit": { - "target": "com.amazonaws.lexruntimeservice#String", + "nluIntentConfidence": { + "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", "traits": { - "smithy.api#documentation": "

If the dialogState value is ElicitSlot, returns the name of the\n slot for which Amazon Lex is eliciting a value.

", - "smithy.api#httpHeader": "x-amz-lex-slot-to-elicit" + "smithy.api#documentation": "

Provides a score that indicates how confident Amazon Lex is that the returned intent is the one\n that matches the user's intent. The score is between 0.0 and 1.0.

\n

The score is a relative score, not an absolute score. The score may change based on\n improvements to the Amazon Lex NLU.

", + "smithy.api#httpHeader": "x-amz-lex-nlu-intent-confidence" } } } @@ -994,26 +1054,24 @@ "smithy.api#required": {} } }, - "inputText": { - "target": "com.amazonaws.lexruntimeservice#Text", + "requestAttributes": { + "target": "com.amazonaws.lexruntimeservice#StringMap", "traits": { - "smithy.api#documentation": "

The text that the user entered (Amazon Lex interprets this text).

", - "smithy.api#required": {} + "smithy.api#documentation": "

Request-specific information passed between Amazon Lex and a client application.

\n

The namespace x-amz-lex: is reserved for special attributes. Don't create any\n request attributes with the prefix x-amz-lex:.

\n

For more information, see Setting Request\n Attributes.

" } }, - "botName": { - "target": "com.amazonaws.lexruntimeservice#BotName", + "botAlias": { + "target": "com.amazonaws.lexruntimeservice#BotAlias", "traits": { - "smithy.api#documentation": "

The name of the Amazon Lex bot.

", + "smithy.api#documentation": "

The alias of the Amazon Lex bot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "botAlias": { - "target": "com.amazonaws.lexruntimeservice#BotAlias", + "inputText": { + "target": "com.amazonaws.lexruntimeservice#Text", "traits": { - "smithy.api#documentation": "

The alias of the Amazon Lex bot.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The text that the user entered (Amazon Lex interprets this text).

", "smithy.api#required": {} } }, @@ -1023,10 +1081,12 @@ "smithy.api#documentation": "

Application-specific information passed between Amazon Lex and a client application.

\n

For more information, see Setting Session\n Attributes.

" } }, - "requestAttributes": { - "target": "com.amazonaws.lexruntimeservice#StringMap", + "botName": { + "target": "com.amazonaws.lexruntimeservice#BotName", "traits": { - "smithy.api#documentation": "

Request-specific information passed between Amazon Lex and a client application.

\n

The namespace x-amz-lex: is reserved for special attributes. Don't create any\n request attributes with the prefix x-amz-lex:.

\n

For more information, see Setting Request\n Attributes.

" + "smithy.api#documentation": "

The name of the Amazon Lex bot.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -1034,22 +1094,46 @@ "com.amazonaws.lexruntimeservice#PostTextResponse": { "type": "structure", "members": { + "messageFormat": { + "target": "com.amazonaws.lexruntimeservice#MessageFormatType", + "traits": { + "smithy.api#documentation": "

The format of the response message. One of the following values:

\n " + } + }, + "intentName": { + "target": "com.amazonaws.lexruntimeservice#IntentName", + "traits": { + "smithy.api#documentation": "

The current user intent that Amazon Lex is aware of.

" + } + }, + "alternativeIntents": { + "target": "com.amazonaws.lexruntimeservice#IntentList", + "traits": { + "smithy.api#documentation": "

One to four alternative intents that may be applicable to the user's intent.

\n

Each alternative includes a score that indicates how confident Amazon Lex is that the intent\n matches the user's intent. The intents are sorted by the confidence score.

" + } + }, "message": { "target": "com.amazonaws.lexruntimeservice#Text", "traits": { "smithy.api#documentation": "

The message to convey to the user. The message can come from the bot's configuration or\n from a Lambda function.

\n

If the intent is not configured with a Lambda function, or if the Lambda function returned\n Delegate as the dialogAction.type its response, Amazon Lex decides on\n the next course of action and selects an appropriate message from the bot's configuration\n based on the current interaction context. For example, if Amazon Lex isn't able to understand user\n input, it uses a clarification prompt message.

\n

When you create an intent you can assign messages to groups. When messages are assigned to\n groups Amazon Lex returns one message from each group in the response. The message field is an\n escaped JSON string containing the messages. For more information about the structure of the\n JSON string returned, see msg-prompts-formats.

\n

If the Lambda function returns a message, Amazon Lex passes it to the client in its\n response.

" } }, - "slots": { - "target": "com.amazonaws.lexruntimeservice#StringMap", + "dialogState": { + "target": "com.amazonaws.lexruntimeservice#DialogState", "traits": { - "smithy.api#documentation": "

The intent slots that Amazon Lex detected from the user input in the conversation.

\n

Amazon Lex creates a resolution list containing likely values for a slot. The value that it\n returns is determined by the valueSelectionStrategy selected when the slot type\n was created or updated. If valueSelectionStrategy is set to\n ORIGINAL_VALUE, the value provided by the user is returned, if the user value\n is similar to the slot values. If valueSelectionStrategy is set to\n TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if\n there is no resolution list, null. If you don't specify a valueSelectionStrategy,\n the default is ORIGINAL_VALUE.

" + "smithy.api#documentation": "

Identifies the current state of the user interaction. Amazon Lex returns one of the following\n values as dialogState. The client can optionally use this information to\n customize the user interface.

\n " } }, - "responseCard": { - "target": "com.amazonaws.lexruntimeservice#ResponseCard", + "sessionId": { + "target": "com.amazonaws.lexruntimeservice#String", "traits": { - "smithy.api#documentation": "

Represents the options that the user has to respond to the current prompt. Response Card\n can come from the bot configuration (in the Amazon Lex console, choose the settings button next\n to a slot) or from a code hook (Lambda function).

" + "smithy.api#documentation": "

A unique identifier for the session.

" + } + }, + "botVersion": { + "target": "com.amazonaws.lexruntimeservice#BotVersion", + "traits": { + "smithy.api#documentation": "

The version of the bot that responded to the conversation. You can use this information to\n help determine if one version of a bot is performing better than another version.

\n

If you have enabled the new natural language understanding (NLU) model, you can use this\n to determine if the improvement is due to changes to the bot or changes to the NLU.

\n

For more information about enabling the new NLU, see the enableModelImprovements parameter of the PutBot operation.

" } }, "sentimentResponse": { @@ -1058,42 +1142,62 @@ "smithy.api#documentation": "

The sentiment expressed in and utterance.

\n

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis,\n this field contains the result of the analysis.

" } }, - "slotToElicit": { - "target": "com.amazonaws.lexruntimeservice#String", + "responseCard": { + "target": "com.amazonaws.lexruntimeservice#ResponseCard", "traits": { - "smithy.api#documentation": "

If the dialogState value is ElicitSlot, returns the name of the\n slot for which Amazon Lex is eliciting a value.

" + "smithy.api#documentation": "

Represents the options that the user has to respond to the current prompt. Response Card\n can come from the bot configuration (in the Amazon Lex console, choose the settings button next\n to a slot) or from a code hook (Lambda function).

" } }, - "messageFormat": { - "target": "com.amazonaws.lexruntimeservice#MessageFormatType", + "sessionAttributes": { + "target": "com.amazonaws.lexruntimeservice#StringMap", "traits": { - "smithy.api#documentation": "

The format of the response message. One of the following values:

\n " + "smithy.api#documentation": "

A map of key-value pairs representing the session-specific context information.

" } }, - "sessionId": { + "nluIntentConfidence": { + "target": "com.amazonaws.lexruntimeservice#IntentConfidence", + "traits": { + "smithy.api#documentation": "

Provides a score that indicates how confident Amazon Lex is that the returned intent is the one\n that matches the user's intent. The score is between 0.0 and 1.0. For more information, see\n Confidence\n Scores.

\n

The score is a relative score, not an absolute score. The score may change based on\n improvements to the Amazon Lex natural language understanding (NLU) model.

" + } + }, + "slotToElicit": { "target": "com.amazonaws.lexruntimeservice#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the session.

" + "smithy.api#documentation": "

If the dialogState value is ElicitSlot, returns the name of the\n slot for which Amazon Lex is eliciting a value.

" } }, - "sessionAttributes": { + "slots": { "target": "com.amazonaws.lexruntimeservice#StringMap", "traits": { - "smithy.api#documentation": "

A map of key-value pairs representing the session-specific context information.

" + "smithy.api#documentation": "

The intent slots that Amazon Lex detected from the user input in the conversation.

\n

Amazon Lex creates a resolution list containing likely values for a slot. The value that it\n returns is determined by the valueSelectionStrategy selected when the slot type\n was created or updated. If valueSelectionStrategy is set to\n ORIGINAL_VALUE, the value provided by the user is returned, if the user value\n is similar to the slot values. If valueSelectionStrategy is set to\n TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if\n there is no resolution list, null. If you don't specify a valueSelectionStrategy,\n the default is ORIGINAL_VALUE.

" + } + } + } + }, + "com.amazonaws.lexruntimeservice#PredictedIntent": { + "type": "structure", + "members": { + "slots": { + "target": "com.amazonaws.lexruntimeservice#StringMap", + "traits": { + "smithy.api#documentation": "

The slot and slot values associated with the predicted intent.

" } }, - "dialogState": { - "target": "com.amazonaws.lexruntimeservice#DialogState", + "nluIntentConfidence": { + "target": "com.amazonaws.lexruntimeservice#IntentConfidence", "traits": { - "smithy.api#documentation": "

Identifies the current state of the user interaction. Amazon Lex returns one of the following\n values as dialogState. The client can optionally use this information to\n customize the user interface.

\n " + "smithy.api#documentation": "

Indicates how confident Amazon Lex is that an intent satisfies the user's intent.

" } }, "intentName": { "target": "com.amazonaws.lexruntimeservice#IntentName", "traits": { - "smithy.api#documentation": "

The current user intent that Amazon Lex is aware of.

" + "smithy.api#documentation": "

The name of the intent that Amazon Lex suggests satisfies the user's intent.

" } } + }, + "traits": { + "smithy.api#documentation": "

An intent that Amazon Lex suggests satisfies the user's intent. Includes the name of the\n intent, the confidence that Amazon Lex has that the user's intent is satisfied, and the slots\n defined for the intent.

" } }, "com.amazonaws.lexruntimeservice#PutSession": { @@ -1142,28 +1246,11 @@ "com.amazonaws.lexruntimeservice#PutSessionRequest": { "type": "structure", "members": { - "userId": { - "target": "com.amazonaws.lexruntimeservice#UserId", - "traits": { - "smithy.api#documentation": "

The ID of the client application user. Amazon Lex uses this to identify a user's conversation\n with your bot.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "botName": { - "target": "com.amazonaws.lexruntimeservice#BotName", - "traits": { - "smithy.api#documentation": "

The name of the bot that contains the session data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "botAlias": { - "target": "com.amazonaws.lexruntimeservice#BotAlias", + "accept": { + "target": "com.amazonaws.lexruntimeservice#Accept", "traits": { - "smithy.api#documentation": "

The alias in use for the bot that contains the session data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The message that Amazon Lex returns in the response can be either text or speech based\n depending on the value of this field.

\n ", + "smithy.api#httpHeader": "Accept" } }, "dialogAction": { @@ -1178,36 +1265,46 @@ "smithy.api#documentation": "

A summary of the recent intents for the bot. You can use the intent summary view to set a\n checkpoint label on an intent and modify attributes of intents. You can also use it to remove\n or add intent summary objects to the list.

\n

An intent that you modify or add to the list must make sense for the bot. For example, the\n intent name must be valid for the bot. You must provide valid values for:

\n \n

If you send the recentIntentSummaryView parameter in a\n PutSession request, the contents of the new summary view replaces the old\n summary view. For example, if a GetSession request returns three intents in the\n summary view and you call PutSession with one intent in the summary view, the\n next call to GetSession will only return one intent.

" } }, - "accept": { - "target": "com.amazonaws.lexruntimeservice#Accept", - "traits": { - "smithy.api#documentation": "

The message that Amazon Lex returns in the response can be either text or speech based\n depending on the value of this field.

\n ", - "smithy.api#httpHeader": "Accept" - } - }, "sessionAttributes": { "target": "com.amazonaws.lexruntimeservice#StringMap", "traits": { "smithy.api#documentation": "

Map of key/value pairs representing the session-specific context information. It contains\n application information passed between Amazon Lex and a client application.

" } + }, + "userId": { + "target": "com.amazonaws.lexruntimeservice#UserId", + "traits": { + "smithy.api#documentation": "

The ID of the client application user. Amazon Lex uses this to identify a user's conversation\n with your bot.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botAlias": { + "target": "com.amazonaws.lexruntimeservice#BotAlias", + "traits": { + "smithy.api#documentation": "

The alias in use for the bot that contains the session data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botName": { + "target": "com.amazonaws.lexruntimeservice#BotName", + "traits": { + "smithy.api#documentation": "

The name of the bot that contains the session data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.lexruntimeservice#PutSessionResponse": { "type": "structure", "members": { - "slots": { - "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", - "traits": { - "smithy.api#documentation": "

Map of zero or more intent slots Amazon Lex detected from the user input during the\n conversation.

\n

Amazon Lex creates a resolution list containing likely values for a slot. The value that it\n returns is determined by the valueSelectionStrategy selected when the slot type\n was created or updated. If valueSelectionStrategy is set to\n ORIGINAL_VALUE, the value provided by the user is returned, if the user value\n is similar to the slot values. If valueSelectionStrategy is set to\n TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if\n there is no resolution list, null. If you don't specify a valueSelectionStrategy\n the default is ORIGINAL_VALUE.

", - "smithy.api#httpHeader": "x-amz-lex-slots" - } - }, - "messageFormat": { - "target": "com.amazonaws.lexruntimeservice#MessageFormatType", + "contentType": { + "target": "com.amazonaws.lexruntimeservice#HttpContentType", "traits": { - "smithy.api#documentation": "

The format of the response message. One of the following values:

\n ", - "smithy.api#httpHeader": "x-amz-lex-message-format" + "smithy.api#documentation": "

Content type as specified in the Accept HTTP header in the request.

", + "smithy.api#httpHeader": "Content-Type" } }, "intentName": { @@ -1217,11 +1314,11 @@ "smithy.api#httpHeader": "x-amz-lex-intent-name" } }, - "sessionId": { - "target": "com.amazonaws.lexruntimeservice#String", + "messageFormat": { + "target": "com.amazonaws.lexruntimeservice#MessageFormatType", "traits": { - "smithy.api#documentation": "

A unique identifier for the session.

", - "smithy.api#httpHeader": "x-amz-lex-session-id" + "smithy.api#documentation": "

The format of the response message. One of the following values:

\n ", + "smithy.api#httpHeader": "x-amz-lex-message-format" } }, "sessionAttributes": { @@ -1231,18 +1328,25 @@ "smithy.api#httpHeader": "x-amz-lex-session-attributes" } }, - "dialogState": { - "target": "com.amazonaws.lexruntimeservice#DialogState", + "sessionId": { + "target": "com.amazonaws.lexruntimeservice#String", "traits": { - "smithy.api#documentation": "

\n ", - "smithy.api#httpHeader": "x-amz-lex-dialog-state" + "smithy.api#documentation": "

A unique identifier for the session.

", + "smithy.api#httpHeader": "x-amz-lex-session-id" } }, - "audioStream": { - "target": "com.amazonaws.lexruntimeservice#BlobStream", + "slotToElicit": { + "target": "com.amazonaws.lexruntimeservice#String", "traits": { - "smithy.api#documentation": "

The audio version of the message to convey to the user.

", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

If the dialogState is ElicitSlot, returns the name of the slot\n for which Amazon Lex is eliciting a value.

", + "smithy.api#httpHeader": "x-amz-lex-slot-to-elicit" + } + }, + "slots": { + "target": "com.amazonaws.lexruntimeservice#SynthesizedJsonString", + "traits": { + "smithy.api#documentation": "

Map of zero or more intent slots Amazon Lex detected from the user input during the\n conversation.

\n

Amazon Lex creates a resolution list containing likely values for a slot. The value that it\n returns is determined by the valueSelectionStrategy selected when the slot type\n was created or updated. If valueSelectionStrategy is set to\n ORIGINAL_VALUE, the value provided by the user is returned, if the user value\n is similar to the slot values. If valueSelectionStrategy is set to\n TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if\n there is no resolution list, null. If you don't specify a valueSelectionStrategy\n the default is ORIGINAL_VALUE.

", + "smithy.api#httpHeader": "x-amz-lex-slots" } }, "message": { @@ -1252,18 +1356,18 @@ "smithy.api#httpHeader": "x-amz-lex-message" } }, - "contentType": { - "target": "com.amazonaws.lexruntimeservice#HttpContentType", + "dialogState": { + "target": "com.amazonaws.lexruntimeservice#DialogState", "traits": { - "smithy.api#documentation": "

Content type as specified in the Accept HTTP header in the request.

", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

\n ", + "smithy.api#httpHeader": "x-amz-lex-dialog-state" } }, - "slotToElicit": { - "target": "com.amazonaws.lexruntimeservice#String", + "audioStream": { + "target": "com.amazonaws.lexruntimeservice#BlobStream", "traits": { - "smithy.api#documentation": "

If the dialogState is ElicitSlot, returns the name of the slot\n for which Amazon Lex is eliciting a value.

", - "smithy.api#httpHeader": "x-amz-lex-slot-to-elicit" + "smithy.api#documentation": "

The audio version of the message to convey to the user.

", + "smithy.api#httpPayload": {} } } } @@ -1284,6 +1388,12 @@ "com.amazonaws.lexruntimeservice#ResponseCard": { "type": "structure", "members": { + "contentType": { + "target": "com.amazonaws.lexruntimeservice#ContentType", + "traits": { + "smithy.api#documentation": "

The content type of the response.

" + } + }, "version": { "target": "com.amazonaws.lexruntimeservice#String", "traits": { @@ -1295,12 +1405,6 @@ "traits": { "smithy.api#documentation": "

An array of attachment objects representing options.

" } - }, - "contentType": { - "target": "com.amazonaws.lexruntimeservice#ContentType", - "traits": { - "smithy.api#documentation": "

The content type of the response.

" - } } }, "traits": { @@ -1313,17 +1417,17 @@ "com.amazonaws.lexruntimeservice#SentimentResponse": { "type": "structure", "members": { - "sentimentScore": { - "target": "com.amazonaws.lexruntimeservice#SentimentScore", - "traits": { - "smithy.api#documentation": "

The likelihood that the sentiment was correctly inferred.

" - } - }, "sentimentLabel": { "target": "com.amazonaws.lexruntimeservice#SentimentLabel", "traits": { "smithy.api#documentation": "

The inferred sentiment that Amazon Comprehend has the highest confidence in.

" } + }, + "sentimentScore": { + "target": "com.amazonaws.lexruntimeservice#SentimentScore", + "traits": { + "smithy.api#documentation": "

The likelihood that the sentiment was correctly inferred.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json b/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json index a3c5769b893f..fa15d2ef0bb3 100644 --- a/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json +++ b/codegen/sdk-codegen/aws-models/license-manager.2018-08-01.json @@ -87,7 +87,7 @@ "sdkId": "License Manager", "arnNamespace": "license-manager", "cloudFormationName": "LicenseManager", - "cloudTrailEventSource": "V2018_08_01.manager.license.amazonaws.com" + "cloudTrailEventSource": "licensemanager.amazonaws.com" }, "aws.auth#sigv4": { "name": "license-manager" @@ -216,22 +216,22 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a license configuration.

\n

A license configuration is an abstraction of a customer license agreement that can be\n consumed and enforced by License Manager. Components include specifications for the license\n type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, \n Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM\n must be associated with a host), and the number of licenses purchased and used.

" + "smithy.api#documentation": "

Creates a license configuration.

\n

A license configuration is an abstraction of a customer license agreement that can be\n consumed and enforced by License Manager. Components include specifications for the license\n type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, \n Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a \n license must be associated with a host), and the number of licenses purchased and used.

" } }, "com.amazonaws.licensemanager#CreateLicenseConfigurationRequest": { "type": "structure", "members": { - "LicenseCountHardLimit": { - "target": "com.amazonaws.licensemanager#BoxBoolean", + "Description": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit\n blocks the launch of new instances.

" + "smithy.api#documentation": "

Description of the license configuration.

" } }, - "LicenseRules": { - "target": "com.amazonaws.licensemanager#StringList", + "LicenseCountHardLimit": { + "target": "com.amazonaws.licensemanager#BoxBoolean", "traits": { - "smithy.api#documentation": "

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). Available rules vary by dimension.

\n " + "smithy.api#documentation": "

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit\n blocks the launch of new instances.

" } }, "ProductInformationList": { @@ -240,10 +240,11 @@ "smithy.api#documentation": "

Product information.

" } }, - "Description": { - "target": "com.amazonaws.licensemanager#String", + "LicenseCountingType": { + "target": "com.amazonaws.licensemanager#LicenseCountingType", "traits": { - "smithy.api#documentation": "

Description of the license configuration.

" + "smithy.api#documentation": "

Dimension used to track the license inventory.

", + "smithy.api#required": {} } }, "LicenseCount": { @@ -259,18 +260,17 @@ "smithy.api#required": {} } }, - "LicenseCountingType": { - "target": "com.amazonaws.licensemanager#LicenseCountingType", - "traits": { - "smithy.api#documentation": "

Dimension used to track the license inventory.

", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.licensemanager#TagList", "traits": { "smithy.api#documentation": "

Tags to add to the license configuration.

" } + }, + "LicenseRules": { + "target": "com.amazonaws.licensemanager#StringList", + "traits": { + "smithy.api#documentation": "

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules \n vary by dimension, as follows.

\n \n

The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible \n values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and \n EC2-DedicatedInstance. The possible values for honorVcpuOptimization are \n True and False.

" + } } } }, @@ -447,28 +447,34 @@ "com.amazonaws.licensemanager#GetLicenseConfigurationResponse": { "type": "structure", "members": { - "ManagedResourceSummaryList": { - "target": "com.amazonaws.licensemanager#ManagedResourceSummaryList", - "traits": { - "smithy.api#documentation": "

Summaries of the managed resources.

" - } - }, "ProductInformationList": { "target": "com.amazonaws.licensemanager#ProductInformationList", "traits": { "smithy.api#documentation": "

Product information.

" } }, - "LicenseCount": { - "target": "com.amazonaws.licensemanager#BoxLong", + "OwnerAccountId": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Number of available licenses.

" + "smithy.api#documentation": "

Account ID of the owner of the license configuration.

" } }, - "Tags": { - "target": "com.amazonaws.licensemanager#TagList", + "LicenseConfigurationId": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Tags for the license configuration.

" + "smithy.api#documentation": "

Unique ID for the license configuration.

" + } + }, + "Name": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

Name of the license configuration.

" + } + }, + "ManagedResourceSummaryList": { + "target": "com.amazonaws.licensemanager#ManagedResourceSummaryList", + "traits": { + "smithy.api#documentation": "

Summaries of the managed resources.

" } }, "LicenseCountingType": { @@ -477,46 +483,46 @@ "smithy.api#documentation": "

Dimension on which the licenses are counted.

" } }, - "OwnerAccountId": { - "target": "com.amazonaws.licensemanager#String", + "Tags": { + "target": "com.amazonaws.licensemanager#TagList", "traits": { - "smithy.api#documentation": "

Account ID of the owner of the license configuration.

" + "smithy.api#documentation": "

Tags for the license configuration.

" } }, - "Name": { - "target": "com.amazonaws.licensemanager#String", + "AutomatedDiscoveryInformation": { + "target": "com.amazonaws.licensemanager#AutomatedDiscoveryInformation", "traits": { - "smithy.api#documentation": "

Name of the license configuration.

" + "smithy.api#documentation": "

Automated discovery information.

" } }, - "LicenseConfigurationArn": { - "target": "com.amazonaws.licensemanager#String", + "LicenseCount": { + "target": "com.amazonaws.licensemanager#BoxLong", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

" + "smithy.api#documentation": "

Number of available licenses.

" } }, - "LicenseConfigurationId": { - "target": "com.amazonaws.licensemanager#String", + "LicenseRules": { + "target": "com.amazonaws.licensemanager#StringList", "traits": { - "smithy.api#documentation": "

Unique ID for the license configuration.

" + "smithy.api#documentation": "

License rules.

" } }, - "ConsumedLicenseSummaryList": { - "target": "com.amazonaws.licensemanager#ConsumedLicenseSummaryList", + "LicenseCountHardLimit": { + "target": "com.amazonaws.licensemanager#BoxBoolean", "traits": { - "smithy.api#documentation": "

Summaries of the licenses consumed by resources.

" + "smithy.api#documentation": "

Sets the number of available licenses as a hard limit.

" } }, - "Status": { + "Description": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

License configuration status.

" + "smithy.api#documentation": "

Description of the license configuration.

" } }, - "Description": { + "Status": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Description of the license configuration.

" + "smithy.api#documentation": "

License configuration status.

" } }, "ConsumedLicenses": { @@ -525,22 +531,16 @@ "smithy.api#documentation": "

Number of licenses assigned to resources.

" } }, - "AutomatedDiscoveryInformation": { - "target": "com.amazonaws.licensemanager#AutomatedDiscoveryInformation", - "traits": { - "smithy.api#documentation": "

Automated discovery information.

" - } - }, - "LicenseRules": { - "target": "com.amazonaws.licensemanager#StringList", + "LicenseConfigurationArn": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

License rules.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

" } }, - "LicenseCountHardLimit": { - "target": "com.amazonaws.licensemanager#BoxBoolean", + "ConsumedLicenseSummaryList": { + "target": "com.amazonaws.licensemanager#ConsumedLicenseSummaryList", "traits": { - "smithy.api#documentation": "

Sets the number of available licenses as a hard limit.

" + "smithy.api#documentation": "

Summaries of the licenses consumed by resources.

" } } } @@ -596,17 +596,17 @@ "smithy.api#documentation": "

Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account will provide member\n accounts with access to this share.

" } }, - "SnsTopicArn": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

SNS topic configured to receive notifications from License Manager.

" - } - }, "EnableCrossAccountsDiscovery": { "target": "com.amazonaws.licensemanager#BoxBoolean", "traits": { "smithy.api#documentation": "

Indicates whether cross-account discovery has been enabled.

" } + }, + "SnsTopicArn": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

SNS topic configured to receive notifications from License Manager.

" + } } } }, @@ -645,17 +645,17 @@ "smithy.api#documentation": "

Value of the filter.

" } }, - "Name": { - "target": "com.amazonaws.licensemanager#String", + "Condition": { + "target": "com.amazonaws.licensemanager#InventoryFilterCondition", "traits": { - "smithy.api#documentation": "

Name of the filter.

", + "smithy.api#documentation": "

Condition of the filter.

", "smithy.api#required": {} } }, - "Condition": { - "target": "com.amazonaws.licensemanager#InventoryFilterCondition", + "Name": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Condition of the filter.

", + "smithy.api#documentation": "

Name of the filter.

", "smithy.api#required": {} } } @@ -696,46 +696,46 @@ "com.amazonaws.licensemanager#LicenseConfiguration": { "type": "structure", "members": { - "LicenseCountHardLimit": { - "target": "com.amazonaws.licensemanager#BoxBoolean", + "LicenseCount": { + "target": "com.amazonaws.licensemanager#BoxLong", "traits": { - "smithy.api#documentation": "

Number of available licenses as a hard limit.

" + "smithy.api#documentation": "

Number of licenses managed by the license configuration.

" } }, - "Description": { - "target": "com.amazonaws.licensemanager#String", + "AutomatedDiscoveryInformation": { + "target": "com.amazonaws.licensemanager#AutomatedDiscoveryInformation", "traits": { - "smithy.api#documentation": "

Description of the license configuration.

" + "smithy.api#documentation": "

Automated discovery information.

" } }, - "LicenseConfigurationArn": { + "Status": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

" + "smithy.api#documentation": "

Status of the license configuration.

" } }, - "ConsumedLicenses": { - "target": "com.amazonaws.licensemanager#BoxLong", + "LicenseCountHardLimit": { + "target": "com.amazonaws.licensemanager#BoxBoolean", "traits": { - "smithy.api#documentation": "

Number of licenses consumed.

" + "smithy.api#documentation": "

Number of available licenses as a hard limit.

" } }, - "LicenseConfigurationId": { - "target": "com.amazonaws.licensemanager#String", + "ProductInformationList": { + "target": "com.amazonaws.licensemanager#ProductInformationList", "traits": { - "smithy.api#documentation": "

Unique ID of the license configuration.

" + "smithy.api#documentation": "

Product information.

" } }, - "ConsumedLicenseSummaryList": { - "target": "com.amazonaws.licensemanager#ConsumedLicenseSummaryList", + "LicenseRules": { + "target": "com.amazonaws.licensemanager#StringList", "traits": { - "smithy.api#documentation": "

Summaries for licenses consumed by various resources.

" + "smithy.api#documentation": "

License rules.

" } }, - "LicenseCountingType": { - "target": "com.amazonaws.licensemanager#LicenseCountingType", + "LicenseConfigurationId": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Dimension to use to track the license inventory.

" + "smithy.api#documentation": "

Unique ID of the license configuration.

" } }, "OwnerAccountId": { @@ -744,10 +744,10 @@ "smithy.api#documentation": "

Account ID of the license configuration's owner.

" } }, - "ProductInformationList": { - "target": "com.amazonaws.licensemanager#ProductInformationList", + "ManagedResourceSummaryList": { + "target": "com.amazonaws.licensemanager#ManagedResourceSummaryList", "traits": { - "smithy.api#documentation": "

Product information.

" + "smithy.api#documentation": "

Summaries for managed resources.

" } }, "Name": { @@ -756,34 +756,34 @@ "smithy.api#documentation": "

Name of the license configuration.

" } }, - "ManagedResourceSummaryList": { - "target": "com.amazonaws.licensemanager#ManagedResourceSummaryList", + "LicenseCountingType": { + "target": "com.amazonaws.licensemanager#LicenseCountingType", "traits": { - "smithy.api#documentation": "

Summaries for managed resources.

" + "smithy.api#documentation": "

Dimension to use to track the license inventory.

" } }, - "LicenseRules": { - "target": "com.amazonaws.licensemanager#StringList", + "ConsumedLicenses": { + "target": "com.amazonaws.licensemanager#BoxLong", "traits": { - "smithy.api#documentation": "

License rules.

" + "smithy.api#documentation": "

Number of licenses consumed.

" } }, - "LicenseCount": { - "target": "com.amazonaws.licensemanager#BoxLong", + "LicenseConfigurationArn": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Number of licenses managed by the license configuration.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

" } }, - "AutomatedDiscoveryInformation": { - "target": "com.amazonaws.licensemanager#AutomatedDiscoveryInformation", + "ConsumedLicenseSummaryList": { + "target": "com.amazonaws.licensemanager#ConsumedLicenseSummaryList", "traits": { - "smithy.api#documentation": "

Automated discovery information.

" + "smithy.api#documentation": "

Summaries for licenses consumed by various resources.

" } }, - "Status": { + "Description": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Status of the license configuration.

" + "smithy.api#documentation": "

Description of the license configuration.

" } } }, @@ -794,22 +794,16 @@ "com.amazonaws.licensemanager#LicenseConfigurationAssociation": { "type": "structure", "members": { - "ResourceOwnerId": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

ID of the AWS account that owns the resource consuming licenses.

" - } - }, "ResourceArn": { "target": "com.amazonaws.licensemanager#String", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource.

" } }, - "ResourceType": { - "target": "com.amazonaws.licensemanager#ResourceType", + "ResourceOwnerId": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Type of server resource.

" + "smithy.api#documentation": "

ID of the AWS account that owns the resource consuming licenses.

" } }, "AssociationTime": { @@ -817,6 +811,12 @@ "traits": { "smithy.api#documentation": "

Time when the license configuration was associated with the resource.

" } + }, + "ResourceType": { + "target": "com.amazonaws.licensemanager#ResourceType", + "traits": { + "smithy.api#documentation": "

Type of server resource.

" + } } }, "traits": { @@ -926,28 +926,40 @@ "com.amazonaws.licensemanager#LicenseOperationFailure": { "type": "structure", "members": { + "ResourceType": { + "target": "com.amazonaws.licensemanager#ResourceType", + "traits": { + "smithy.api#documentation": "

Resource type.

" + } + }, "OperationName": { "target": "com.amazonaws.licensemanager#String", "traits": { "smithy.api#documentation": "

Name of the operation.

" } }, + "OperationRequestedBy": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

The requester is \"License Manager Automated Discovery\".

" + } + }, "ErrorMessage": { "target": "com.amazonaws.licensemanager#String", "traits": { "smithy.api#documentation": "

Error message.

" } }, - "FailureTime": { - "target": "com.amazonaws.licensemanager#DateTime", + "MetadataList": { + "target": "com.amazonaws.licensemanager#MetadataList", "traits": { - "smithy.api#documentation": "

Failure time.

" + "smithy.api#documentation": "

Reserved.

" } }, - "ResourceOwnerId": { - "target": "com.amazonaws.licensemanager#String", + "FailureTime": { + "target": "com.amazonaws.licensemanager#DateTime", "traits": { - "smithy.api#documentation": "

ID of the AWS account that owns the resource.

" + "smithy.api#documentation": "

Failure time.

" } }, "ResourceArn": { @@ -956,22 +968,10 @@ "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource.

" } }, - "OperationRequestedBy": { + "ResourceOwnerId": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

The requester is \"License Manager Automated Discovery\".

" - } - }, - "ResourceType": { - "target": "com.amazonaws.licensemanager#ResourceType", - "traits": { - "smithy.api#documentation": "

Resource type.

" - } - }, - "MetadataList": { - "target": "com.amazonaws.licensemanager#MetadataList", - "traits": { - "smithy.api#documentation": "

Reserved.

" + "smithy.api#documentation": "

ID of the AWS account that owns the resource.

" } } }, @@ -1061,34 +1061,34 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

Token for the next set of results.

" - } - }, "MaxResults": { "target": "com.amazonaws.licensemanager#BoxInteger", "traits": { "smithy.api#documentation": "

Maximum number of results to return in a single call.

" } + }, + "NextToken": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

Token for the next set of results.

" + } } } }, "com.amazonaws.licensemanager#ListAssociationsForLicenseConfigurationResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

Token for the next set of results.

" - } - }, "LicenseConfigurationAssociations": { "target": "com.amazonaws.licensemanager#LicenseConfigurationAssociations", "traits": { "smithy.api#documentation": "

Information about the associations for the license configuration.

" } + }, + "NextToken": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

Token for the next set of results.

" + } } } }, @@ -1124,6 +1124,13 @@ "com.amazonaws.licensemanager#ListFailuresForLicenseConfigurationOperationsRequest": { "type": "structure", "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name of the license configuration.

", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.licensemanager#String", "traits": { @@ -1135,13 +1142,6 @@ "traits": { "smithy.api#documentation": "

Maximum number of results to return in a single call.

" } - }, - "LicenseConfigurationArn": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name of the license configuration.

", - "smithy.api#required": {} - } } } }, @@ -1197,16 +1197,10 @@ "com.amazonaws.licensemanager#ListLicenseConfigurationsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.licensemanager#BoxInteger", - "traits": { - "smithy.api#documentation": "

Maximum number of results to return in a single call.

" - } - }, "Filters": { "target": "com.amazonaws.licensemanager#Filters", "traits": { - "smithy.api#documentation": "

Filters to scope the results. The following filters and logical operators\n are supported:

\n " + "smithy.api#documentation": "

Filters to scope the results. The following filters and logical operators\n are supported:

\n " } }, "LicenseConfigurationArns": { @@ -1215,6 +1209,12 @@ "smithy.api#documentation": "

Amazon Resource Names (ARN) of the license configurations.

" } }, + "MaxResults": { + "target": "com.amazonaws.licensemanager#BoxInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return in a single call.

" + } + }, "NextToken": { "target": "com.amazonaws.licensemanager#String", "traits": { @@ -1354,17 +1354,17 @@ "smithy.api#documentation": "

Maximum number of results to return in a single call.

" } }, - "NextToken": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

Token for the next set of results.

" - } - }, "Filters": { "target": "com.amazonaws.licensemanager#InventoryFilterList", "traits": { "smithy.api#documentation": "

Filters to scope the results. The following filters and logical operators\n are supported:

\n " } + }, + "NextToken": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

Token for the next set of results.

" + } } } }, @@ -1472,16 +1472,11 @@ "com.amazonaws.licensemanager#ListUsageForLicenseConfigurationRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.licensemanager#BoxInteger", - "traits": { - "smithy.api#documentation": "

Maximum number of results to return in a single call.

" - } - }, - "Filters": { - "target": "com.amazonaws.licensemanager#Filters", + "LicenseConfigurationArn": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Filters to scope the results. The following filters and logical operators\n are supported:

\n " + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

", + "smithy.api#required": {} } }, "NextToken": { @@ -1490,11 +1485,16 @@ "smithy.api#documentation": "

Token for the next set of results.

" } }, - "LicenseConfigurationArn": { - "target": "com.amazonaws.licensemanager#String", + "Filters": { + "target": "com.amazonaws.licensemanager#Filters", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Filters to scope the results. The following filters and logical operators\n are supported:

\n " + } + }, + "MaxResults": { + "target": "com.amazonaws.licensemanager#BoxInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return in a single call.

" } } } @@ -1519,17 +1519,17 @@ "com.amazonaws.licensemanager#ManagedResourceSummary": { "type": "structure", "members": { - "AssociationCount": { - "target": "com.amazonaws.licensemanager#BoxLong", - "traits": { - "smithy.api#documentation": "

Number of resources associated with licenses.

" - } - }, "ResourceType": { "target": "com.amazonaws.licensemanager#ResourceType", "traits": { "smithy.api#documentation": "

Type of resource associated with a license.

" } + }, + "AssociationCount": { + "target": "com.amazonaws.licensemanager#BoxLong", + "traits": { + "smithy.api#documentation": "

Number of resources associated with licenses.

" + } } }, "traits": { @@ -1589,17 +1589,17 @@ "com.amazonaws.licensemanager#ProductInformation": { "type": "structure", "members": { - "ProductInformationFilterList": { - "target": "com.amazonaws.licensemanager#ProductInformationFilterList", + "ResourceType": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Product information filters. The following filters and logical operators\n are supported:

\n ", + "smithy.api#documentation": "

Resource type. The possible values are SSM_MANAGED | RDS.

", "smithy.api#required": {} } }, - "ResourceType": { - "target": "com.amazonaws.licensemanager#String", + "ProductInformationFilterList": { + "target": "com.amazonaws.licensemanager#ProductInformationFilterList", "traits": { - "smithy.api#documentation": "

Resource type. The value is SSM_MANAGED.

", + "smithy.api#documentation": "

Product information filters.

\n

The following filters and logical operators are supported when the resource type \n is SSM_MANAGED:

\n \n

The following filters and logical operators are supported when the resource type\n is RDS:

\n ", "smithy.api#required": {} } } @@ -1611,17 +1611,17 @@ "com.amazonaws.licensemanager#ProductInformationFilter": { "type": "structure", "members": { - "ProductInformationFilterComparator": { - "target": "com.amazonaws.licensemanager#String", + "ProductInformationFilterValue": { + "target": "com.amazonaws.licensemanager#StringList", "traits": { - "smithy.api#documentation": "

Logical operator.

", + "smithy.api#documentation": "

Filter value.

", "smithy.api#required": {} } }, - "ProductInformationFilterValue": { - "target": "com.amazonaws.licensemanager#StringList", + "ProductInformationFilterComparator": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Filter value.

", + "smithy.api#documentation": "

Logical operator.

", "smithy.api#required": {} } }, @@ -1665,40 +1665,40 @@ "com.amazonaws.licensemanager#ResourceInventory": { "type": "structure", "members": { - "ResourceOwningAccountId": { - "target": "com.amazonaws.licensemanager#String", + "ResourceType": { + "target": "com.amazonaws.licensemanager#ResourceType", "traits": { - "smithy.api#documentation": "

ID of the account that owns the resource.

" + "smithy.api#documentation": "

Type of resource.

" } }, - "ResourceArn": { + "ResourceId": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource.

" + "smithy.api#documentation": "

ID of the resource.

" } }, - "ResourceId": { + "Platform": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

ID of the resource.

" + "smithy.api#documentation": "

Platform of the resource.

" } }, - "ResourceType": { - "target": "com.amazonaws.licensemanager#ResourceType", + "ResourceOwningAccountId": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Type of resource.

" + "smithy.api#documentation": "

ID of the account that owns the resource.

" } }, - "PlatformVersion": { + "ResourceArn": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Platform version of the resource in the inventory.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the resource.

" } }, - "Platform": { + "PlatformVersion": { "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Platform of the resource.

" + "smithy.api#documentation": "

Platform version of the resource in the inventory.

" } } }, @@ -1838,17 +1838,17 @@ "com.amazonaws.licensemanager#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.licensemanager#TagList", + "ResourceArn": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

One or more tags.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.licensemanager#String", + "Tags": { + "target": "com.amazonaws.licensemanager#TagList", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

", + "smithy.api#documentation": "

One or more tags.

", "smithy.api#required": {} } } @@ -1936,12 +1936,18 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the attributes of an existing license configuration.

\n

A license configuration is an abstraction of a customer license agreement that can be\n consumed and enforced by License Manager. Components include specifications for the license\n type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, \n Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM\n must be associated with a host), and the number of licenses purchased and used.

" + "smithy.api#documentation": "

Modifies the attributes of an existing license configuration.

" } }, "com.amazonaws.licensemanager#UpdateLicenseConfigurationRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

New description of the license configuration.

" + } + }, "LicenseCountHardLimit": { "target": "com.amazonaws.licensemanager#BoxBoolean", "traits": { @@ -1954,23 +1960,10 @@ "smithy.api#documentation": "

New product information.

" } }, - "Description": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

New description of the license configuration.

" - } - }, - "LicenseConfigurationArn": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

", - "smithy.api#required": {} - } - }, "LicenseRules": { "target": "com.amazonaws.licensemanager#StringList", "traits": { - "smithy.api#documentation": "

New license rules.

" + "smithy.api#documentation": "

New license rule. The only rule that you can add after you create a license\n configuration is licenseAffinityToHost.

" } }, "LicenseCount": { @@ -1979,6 +1972,13 @@ "smithy.api#documentation": "

New number of licenses managed by the license configuration.

" } }, + "LicenseConfigurationArn": { + "target": "com.amazonaws.licensemanager#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the license configuration.

", + "smithy.api#required": {} + } + }, "LicenseConfigurationStatus": { "target": "com.amazonaws.licensemanager#LicenseConfigurationStatus", "traits": { @@ -2092,22 +2092,16 @@ "com.amazonaws.licensemanager#UpdateServiceSettingsRequest": { "type": "structure", "members": { - "SnsTopicArn": { - "target": "com.amazonaws.licensemanager#String", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

" - } - }, "S3BucketArn": { "target": "com.amazonaws.licensemanager#String", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.

" } }, - "EnableCrossAccountsDiscovery": { - "target": "com.amazonaws.licensemanager#BoxBoolean", + "SnsTopicArn": { + "target": "com.amazonaws.licensemanager#String", "traits": { - "smithy.api#documentation": "

Activates cross-account discovery.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

" } }, "OrganizationConfiguration": { @@ -2115,6 +2109,12 @@ "traits": { "smithy.api#documentation": "

Enables integration with AWS Organizations for cross-account discovery.

" } + }, + "EnableCrossAccountsDiscovery": { + "target": "com.amazonaws.licensemanager#BoxBoolean", + "traits": { + "smithy.api#documentation": "

Activates cross-account discovery.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/lightsail.2016-11-28.json b/codegen/sdk-codegen/aws-models/lightsail.2016-11-28.json index 741fd7656b08..93490cf7cc84 100644 --- a/codegen/sdk-codegen/aws-models/lightsail.2016-11-28.json +++ b/codegen/sdk-codegen/aws-models/lightsail.2016-11-28.json @@ -32,16 +32,16 @@ "com.amazonaws.lightsail#AccessDeniedException": { "type": "structure", "members": { - "tip": { + "code": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, - "code": { + "docs": { "target": "com.amazonaws.lightsail#string" }, - "docs": { + "tip": { "target": "com.amazonaws.lightsail#string" } }, @@ -69,13 +69,13 @@ "com.amazonaws.lightsail#AccountSetupInProgressException": { "type": "structure", "members": { - "docs": { + "tip": { "target": "com.amazonaws.lightsail#string" }, "code": { "target": "com.amazonaws.lightsail#string" }, - "tip": { + "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { @@ -91,16 +91,16 @@ "com.amazonaws.lightsail#AddOn": { "type": "structure", "members": { - "nextSnapshotTimeOfDay": { - "target": "com.amazonaws.lightsail#TimeOfDay", + "status": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The next daily time an automatic snapshot will be created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" + "smithy.api#documentation": "

The status of the add-on.

" } }, - "name": { - "target": "com.amazonaws.lightsail#string", + "nextSnapshotTimeOfDay": { + "target": "com.amazonaws.lightsail#TimeOfDay", "traits": { - "smithy.api#documentation": "

The name of the add-on.

" + "smithy.api#documentation": "

The next daily time an automatic snapshot will be created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" } }, "snapshotTimeOfDay": { @@ -109,10 +109,10 @@ "smithy.api#documentation": "

The daily time when an automatic snapshot is created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" } }, - "status": { + "name": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The status of the add-on.

" + "smithy.api#documentation": "

The name of the add-on.

" } } }, @@ -167,28 +167,22 @@ "com.amazonaws.lightsail#Alarm": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.lightsail#AlarmState", - "traits": { - "smithy.api#documentation": "

The current state of the alarm.

\n

An alarm has the following possible states:

\n " - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "notificationTriggers": { + "target": "com.amazonaws.lightsail#NotificationTriggerList", "traits": { - "smithy.api#documentation": "

An object that lists information about the location of the alarm.

" + "smithy.api#documentation": "

The alarm states that trigger a notification.

" } }, - "threshold": { - "target": "com.amazonaws.lightsail#double", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

" + "smithy.api#documentation": "

The timestamp when the alarm was created.

" } }, - "notificationTriggers": { - "target": "com.amazonaws.lightsail#NotificationTriggerList", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The alarm states that trigger a notification.

" + "smithy.api#documentation": "

The Lightsail resource type (e.g., Alarm).

" } }, "unit": { @@ -197,52 +191,64 @@ "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" } }, - "metricName": { - "target": "com.amazonaws.lightsail#MetricName", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the metric associated with the alarm.

" + "smithy.api#documentation": "

The name of the alarm.

" } }, - "contactProtocols": { - "target": "com.amazonaws.lightsail#ContactProtocolsList", + "treatMissingData": { + "target": "com.amazonaws.lightsail#TreatMissingData", "traits": { - "smithy.api#documentation": "

The contact protocols for the alarm, such as Email, SMS (text\n messaging), or both.

" + "smithy.api#documentation": "

Specifies how the alarm handles missing data points.

\n

An alarm can treat missing data in the following ways:

\n " } }, - "comparisonOperator": { - "target": "com.amazonaws.lightsail#ComparisonOperator", + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { - "smithy.api#documentation": "

The arithmetic operation used when comparing the specified statistic and threshold.

" + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" } }, - "datapointsToAlarm": { + "statistic": { + "target": "com.amazonaws.lightsail#MetricStatistic", + "traits": { + "smithy.api#documentation": "

The statistic for the metric associated with the alarm.

\n

The following statistics are available:

\n " + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that lists information about the location of the alarm.

" + } + }, + "evaluationPeriods": { "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The number of data points that must not within the specified threshold to trigger the\n alarm.

" + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "comparisonOperator": { + "target": "com.amazonaws.lightsail#ComparisonOperator", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail alarm. This code enables our support team to look up your Lightsail\n information more easily.

" + "smithy.api#documentation": "

The arithmetic operation used when comparing the specified statistic and threshold.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "notificationEnabled": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Alarm).

" + "smithy.api#documentation": "

Indicates whether the alarm is enabled.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "monitoredResourceInfo": { + "target": "com.amazonaws.lightsail#MonitoredResourceInfo", "traits": { - "smithy.api#documentation": "

The name of the alarm.

" + "smithy.api#documentation": "

An object that lists information about the resource monitored by the alarm.

" } }, - "evaluationPeriods": { - "target": "com.amazonaws.lightsail#integer", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail alarm. This code enables our support team to look up your Lightsail\n information more easily.

" } }, "arn": { @@ -251,40 +257,34 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" } }, - "notificationEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the alarm is enabled.

" - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", + "state": { + "target": "com.amazonaws.lightsail#AlarmState", "traits": { - "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" + "smithy.api#documentation": "

The current state of the alarm.

\n

An alarm has the following possible states:

\n " } }, - "statistic": { - "target": "com.amazonaws.lightsail#MetricStatistic", + "threshold": { + "target": "com.amazonaws.lightsail#double", "traits": { - "smithy.api#documentation": "

The statistic for the metric associated with the alarm.

\n

The following statistics are available:

\n " + "smithy.api#documentation": "

The value against which the specified statistic is compared.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "datapointsToAlarm": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The timestamp when the alarm was created.

" + "smithy.api#documentation": "

The number of data points that must not within the specified threshold to trigger the\n alarm.

" } }, - "treatMissingData": { - "target": "com.amazonaws.lightsail#TreatMissingData", + "contactProtocols": { + "target": "com.amazonaws.lightsail#ContactProtocolsList", "traits": { - "smithy.api#documentation": "

Specifies how the alarm handles missing data points.

\n

An alarm can treat missing data in the following ways:

\n " + "smithy.api#documentation": "

The contact protocols for the alarm, such as Email, SMS (text\n messaging), or both.

" } }, - "monitoredResourceInfo": { - "target": "com.amazonaws.lightsail#MonitoredResourceInfo", + "metricName": { + "target": "com.amazonaws.lightsail#MetricName", "traits": { - "smithy.api#documentation": "

An object that lists information about the resource monitored by the alarm.

" + "smithy.api#documentation": "

The name of the metric associated with the alarm.

" } } }, @@ -490,13 +490,6 @@ "com.amazonaws.lightsail#AttachDiskRequest": { "type": "structure", "members": { - "diskPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The disk path to expose to the instance (e.g., /dev/xvdf).

", - "smithy.api#required": {} - } - }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -510,6 +503,13 @@ "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", "smithy.api#required": {} } + }, + "diskPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The disk path to expose to the instance (e.g., /dev/xvdf).

", + "smithy.api#required": {} + } } } }, @@ -567,17 +567,17 @@ "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest": { "type": "structure", "members": { - "instanceNames": { - "target": "com.amazonaws.lightsail#ResourceNameList", + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of strings representing the instance name(s) you want to attach to your load\n balancer.

\n

An instance must be running before you can attach it to your load\n balancer.

\n

There are no additional limits on the number of instances you can attach to your load\n balancer, aside from the limit of Lightsail instances you can create in your account\n (20).

", + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } }, - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", + "instanceNames": { + "target": "com.amazonaws.lightsail#ResourceNameList", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

An array of strings representing the instance name(s) you want to attach to your load\n balancer.

\n

An instance must be running before you can attach it to your load\n balancer.

\n

There are no additional limits on the number of instances you can attach to your load\n balancer, aside from the limit of Lightsail instances you can create in your account\n (20).

", "smithy.api#required": {} } } @@ -707,17 +707,17 @@ "com.amazonaws.lightsail#AttachStaticIpRequest": { "type": "structure", "members": { - "staticIpName": { + "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the static IP.

", + "smithy.api#documentation": "

The instance name to which you want to attach the static IP address.

", "smithy.api#required": {} } }, - "instanceName": { + "staticIpName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The instance name to which you want to attach the static IP address.

", + "smithy.api#documentation": "

The name of the static IP.

", "smithy.api#required": {} } } @@ -737,17 +737,17 @@ "com.amazonaws.lightsail#AttachedDisk": { "type": "structure", "members": { - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path of the disk (e.g., /dev/xvdf).

" - } - }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB.

" } + }, + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path of the disk (e.g., /dev/xvdf).

" + } } }, "traits": { @@ -792,22 +792,16 @@ "com.amazonaws.lightsail#AutoSnapshotDetails": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.lightsail#AutoSnapshotStatus", - "traits": { - "smithy.api#documentation": "

The status of the automatic snapshot.

" - } - }, "fromAttachedDisks": { "target": "com.amazonaws.lightsail#AttachedDiskList", "traits": { "smithy.api#documentation": "

An array of objects that describe the block storage disks attached to the instance when\n the automatic snapshot was created.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "status": { + "target": "com.amazonaws.lightsail#AutoSnapshotStatus", "traits": { - "smithy.api#documentation": "

The timestamp when the automatic snapshot was created.

" + "smithy.api#documentation": "

The status of the automatic snapshot.

" } }, "date": { @@ -815,6 +809,12 @@ "traits": { "smithy.api#documentation": "

The date of the automatic snapshot in YYYY-MM-DD format.

" } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the automatic snapshot was created.

" + } } }, "traits": { @@ -897,46 +897,40 @@ "com.amazonaws.lightsail#Blueprint": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "type": { + "target": "com.amazonaws.lightsail#BlueprintType", "traits": { - "smithy.api#documentation": "

The friendly name of the blueprint (e.g., Amazon Linux).

" + "smithy.api#documentation": "

The type of the blueprint (e.g., os or app).

" } }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", + "minPower": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed\n to support customers with existing instances but are not necessarily available for launch of\n new instances. Blueprints are marked inactive when they become outdated due to operating\n system updates or new application releases.

" + "smithy.api#documentation": "

The minimum bundle power required to run this blueprint. For example, you need a bundle\n with a power value of 500 or more to create an instance that uses a blueprint with a minimum\n power value of 500. 0 indicates that the blueprint runs on all instance sizes.\n

" } }, - "licenseUrl": { + "versionCode": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The end-user license agreement URL for the image or blueprint.

" + "smithy.api#documentation": "

The version code.

" } }, - "version": { - "target": "com.amazonaws.lightsail#string", + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The version number of the operating system, application, or stack (e.g.,\n 2016.03.0).

" + "smithy.api#documentation": "

The ID for the virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0).

" } }, - "productUrl": { + "description": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The product URL to learn more about the image or blueprint.

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#BlueprintType", - "traits": { - "smithy.api#documentation": "

The type of the blueprint (e.g., os or app).

" + "smithy.api#documentation": "

The description of the blueprint.

" } }, - "minPower": { - "target": "com.amazonaws.lightsail#integer", + "platform": { + "target": "com.amazonaws.lightsail#InstancePlatform", "traits": { - "smithy.api#documentation": "

The minimum bundle power required to run this blueprint. For example, you need a bundle\n with a power value of 500 or more to create an instance that uses a blueprint with a minimum\n power value of 500. 0 indicates that the blueprint runs on all instance sizes.\n

" + "smithy.api#documentation": "

The operating system platform (either Linux/Unix-based or Windows Server-based) of the\n blueprint.

" } }, "group": { @@ -945,28 +939,34 @@ "smithy.api#documentation": "

The group name of the blueprint (e.g., amazon-linux).

" } }, - "versionCode": { + "productUrl": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The version code.

" + "smithy.api#documentation": "

The product URL to learn more about the image or blueprint.

" } }, - "platform": { - "target": "com.amazonaws.lightsail#InstancePlatform", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The operating system platform (either Linux/Unix-based or Windows Server-based) of the\n blueprint.

" + "smithy.api#documentation": "

The friendly name of the blueprint (e.g., Amazon Linux).

" } }, - "description": { + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed\n to support customers with existing instances but are not necessarily available for launch of\n new instances. Blueprints are marked inactive when they become outdated due to operating\n system updates or new application releases.

" + } + }, + "version": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The description of the blueprint.

" + "smithy.api#documentation": "

The version number of the operating system, application, or stack (e.g.,\n 2016.03.0).

" } }, - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "licenseUrl": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The ID for the virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0).

" + "smithy.api#documentation": "

The end-user license agreement URL for the image or blueprint.

" } } }, @@ -998,16 +998,10 @@ "com.amazonaws.lightsail#Bundle": { "type": "structure", "members": { - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of vCPUs included in the bundle (e.g., 2).

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", + "name": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The price in US dollars (e.g., 5.0) of the bundle.

" + "smithy.api#documentation": "

A friendly name for the bundle (e.g., Micro).

" } }, "instanceType": { @@ -1016,52 +1010,58 @@ "smithy.api#documentation": "

The Amazon EC2 instance type (e.g., t2.micro).

" } }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the bundle is active.

" + "smithy.api#documentation": "

The bundle ID (e.g., micro_1_0).

" } }, - "transferPerMonthInGb": { + "power": { "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The data transfer rate per month in GB (e.g., 2000).

" + "smithy.api#documentation": "

A numeric value that represents the power of the bundle (e.g., 500). You can\n use the bundle's power value in conjunction with a blueprint's minimum power value to\n determine whether the blueprint will run on the bundle. For example, you need a bundle with a\n power value of 500 or more to create an instance that uses a blueprint with a minimum power\n value of 500.

" } }, - "power": { + "cpuCount": { "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

A numeric value that represents the power of the bundle (e.g., 500). You can\n use the bundle's power value in conjunction with a blueprint's minimum power value to\n determine whether the blueprint will run on the bundle. For example, you need a bundle with a\n power value of 500 or more to create an instance that uses a blueprint with a minimum power\n value of 500.

" + "smithy.api#documentation": "

The number of vCPUs included in the bundle (e.g., 2).

" } }, - "diskSizeInGb": { - "target": "com.amazonaws.lightsail#integer", + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", "traits": { - "smithy.api#documentation": "

The size of the SSD (e.g., 30).

" + "smithy.api#documentation": "

The amount of RAM in GB (e.g., 2.0).

" } }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "price": { + "target": "com.amazonaws.lightsail#float", "traits": { - "smithy.api#documentation": "

The bundle ID (e.g., micro_1_0).

" + "smithy.api#documentation": "

The price in US dollars (e.g., 5.0) of the bundle.

" } }, - "supportedPlatforms": { - "target": "com.amazonaws.lightsail#InstancePlatformList", + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle\n supports. You can only launch a WINDOWS bundle on a blueprint that supports the\n WINDOWS platform. LINUX_UNIX blueprints require a\n LINUX_UNIX bundle.

" + "smithy.api#documentation": "

The data transfer rate per month in GB (e.g., 2000).

" } }, - "name": { - "target": "com.amazonaws.lightsail#string", + "diskSizeInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

A friendly name for the bundle (e.g., Micro).

" + "smithy.api#documentation": "

The size of the SSD (e.g., 30).

" } }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", + "isActive": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The amount of RAM in GB (e.g., 2.0).

" + "smithy.api#documentation": "

A Boolean value indicating whether the bundle is active.

" + } + }, + "supportedPlatforms": { + "target": "com.amazonaws.lightsail#InstancePlatformList", + "traits": { + "smithy.api#documentation": "

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle\n supports. You can only launch a WINDOWS bundle on a blueprint that supports the\n WINDOWS platform. LINUX_UNIX blueprints require a\n LINUX_UNIX bundle.

" } } }, @@ -1118,22 +1118,40 @@ "com.amazonaws.lightsail#CacheSettings": { "type": "structure", "members": { + "forwardedQueryStrings": { + "target": "com.amazonaws.lightsail#QueryStringObject", + "traits": { + "smithy.api#documentation": "

An object that describes the query strings that are forwarded to the origin. Your content\n is cached based on the query strings that are forwarded.

" + } + }, + "cachedHTTPMethods": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The HTTP method responses that are cached by your distribution.

\n\n

You can specify the following options:

\n\n " + } + }, "forwardedHeaders": { "target": "com.amazonaws.lightsail#HeaderObject", "traits": { "smithy.api#documentation": "

An object that describes the headers that are forwarded to the origin. Your content is\n cached based on the headers that are forwarded.

" } }, + "forwardedCookies": { + "target": "com.amazonaws.lightsail#CookieObject", + "traits": { + "smithy.api#documentation": "

An object that describes the cookies that are forwarded to the origin. Your content is\n cached based on the cookies that are forwarded.

" + } + }, "defaultTTL": { "target": "com.amazonaws.lightsail#long", "traits": { "smithy.api#documentation": "

The default amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the content has been\n updated.

\n\n \n

The value specified applies only when the origin does not add HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

\n " } }, - "forwardedCookies": { - "target": "com.amazonaws.lightsail#CookieObject", + "maximumTTL": { + "target": "com.amazonaws.lightsail#long", "traits": { - "smithy.api#documentation": "

An object that describes the cookies that are forwarded to the origin. Your content is\n cached based on the cookies that are forwarded.

" + "smithy.api#documentation": "

The maximum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n\n

The value specified applies only when the origin adds HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

" } }, "minimumTTL": { @@ -1147,24 +1165,6 @@ "traits": { "smithy.api#documentation": "

The HTTP methods that are processed and forwarded to the distribution's origin.

\n\n

You can specify the following options:

\n\n \n\n

If you specify the third option, you might need to restrict access to your distribution's\n origin so users can't perform operations that you don't want them to. For example, you might\n not want users to have permission to delete objects from your origin.

" } - }, - "cachedHTTPMethods": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The HTTP method responses that are cached by your distribution.

\n\n

You can specify the following options:

\n\n " - } - }, - "maximumTTL": { - "target": "com.amazonaws.lightsail#long", - "traits": { - "smithy.api#documentation": "

The maximum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n\n

The value specified applies only when the origin adds HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

" - } - }, - "forwardedQueryStrings": { - "target": "com.amazonaws.lightsail#QueryStringObject", - "traits": { - "smithy.api#documentation": "

An object that describes the query strings that are forwarded to the origin. Your content\n is cached based on the query strings that are forwarded.

" - } } }, "traits": { @@ -1174,130 +1174,130 @@ "com.amazonaws.lightsail#Certificate": { "type": "structure", "members": { - "revokedAt": { + "notBefore": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" + "smithy.api#documentation": "

The timestamp when the certificate is first valid.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "name": { + "target": "com.amazonaws.lightsail#CertificateName", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The name of the certificate (e.g., my-certificate).

" } }, - "status": { - "target": "com.amazonaws.lightsail#CertificateStatus", + "eligibleToRenew": { + "target": "com.amazonaws.lightsail#EligibleToRenew", "traits": { - "smithy.api#documentation": "

The validation status of the certificate.

" + "smithy.api#documentation": "

The renewal eligibility of the certificate.

" } }, - "revocationReason": { - "target": "com.amazonaws.lightsail#RevocationReason", + "issuerCA": { + "target": "com.amazonaws.lightsail#IssuerCA", "traits": { - "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" + "smithy.api#documentation": "

The certificate authority that issued the certificate.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#DomainValidationRecordList", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was created.

" + "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" } }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", + "notAfter": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) of the certificate.

" + "smithy.api#documentation": "

The timestamp when the certificate expires.

" } }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The domain name of the certificate.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "inUseResourceCount": { - "target": "com.amazonaws.lightsail#InUseResourceCount", + "status": { + "target": "com.amazonaws.lightsail#CertificateStatus", "traits": { - "smithy.api#documentation": "

The number of Lightsail resources that the certificate is attached to.

" + "smithy.api#documentation": "

The validation status of the certificate.

" } }, - "issuedAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "revocationReason": { + "target": "com.amazonaws.lightsail#RevocationReason", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was issued.

" + "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" } }, - "eligibleToRenew": { - "target": "com.amazonaws.lightsail#EligibleToRenew", + "serialNumber": { + "target": "com.amazonaws.lightsail#SerialNumber", "traits": { - "smithy.api#documentation": "

The renewal eligibility of the certificate.

" + "smithy.api#documentation": "

The serial number of the certificate.

" } }, - "renewalSummary": { - "target": "com.amazonaws.lightsail#RenewalSummary", + "revokedAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" + "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" } }, - "requestFailureReason": { - "target": "com.amazonaws.lightsail#RequestFailureReason", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n\n

The following failure reasons are possible:

\n " + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail certificate. This code enables our support team to look up your Lightsail\n information more easily.

" } }, - "name": { - "target": "com.amazonaws.lightsail#CertificateName", + "renewalSummary": { + "target": "com.amazonaws.lightsail#RenewalSummary", "traits": { - "smithy.api#documentation": "

The name of the certificate (e.g., my-certificate).

" + "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" } }, - "keyAlgorithm": { - "target": "com.amazonaws.lightsail#KeyAlgorithm", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key) of the\n certificate.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail certificate. This code enables our support team to look up your Lightsail\n information more easily.

" + "smithy.api#documentation": "

The domain name of the certificate.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "inUseResourceCount": { + "target": "com.amazonaws.lightsail#InUseResourceCount", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + "smithy.api#documentation": "

The number of Lightsail resources that the certificate is attached to.

" } }, - "notBefore": { - "target": "com.amazonaws.lightsail#IsoDate", + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate is first valid.

" + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) of the certificate.

" } }, - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#DomainValidationRecordList", + "issuedAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" + "smithy.api#documentation": "

The timestamp when the certificate was issued.

" } }, - "issuerCA": { - "target": "com.amazonaws.lightsail#IssuerCA", + "requestFailureReason": { + "target": "com.amazonaws.lightsail#RequestFailureReason", "traits": { - "smithy.api#documentation": "

The certificate authority that issued the certificate.

" + "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n\n

The following failure reasons are possible:

\n " } }, - "serialNumber": { - "target": "com.amazonaws.lightsail#SerialNumber", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" + "smithy.api#documentation": "

The timestamp when the certificate was created.

" } }, - "notAfter": { - "target": "com.amazonaws.lightsail#IsoDate", + "keyAlgorithm": { + "target": "com.amazonaws.lightsail#KeyAlgorithm", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate expires.

" + "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key) of the\n certificate.

" } } }, @@ -1352,10 +1352,10 @@ "com.amazonaws.lightsail#CertificateSummary": { "type": "structure", "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", + "certificateDetail": { + "target": "com.amazonaws.lightsail#Certificate", "traits": { - "smithy.api#documentation": "

The domain name of the certificate.

" + "smithy.api#documentation": "

An object that describes a certificate in detail.

" } }, "tags": { @@ -1364,16 +1364,10 @@ "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "certificateArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" - } - }, - "certificateDetail": { - "target": "com.amazonaws.lightsail#Certificate", + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", "traits": { - "smithy.api#documentation": "

An object that describes a certificate in detail.

" + "smithy.api#documentation": "

The domain name of the certificate.

" } }, "certificateName": { @@ -1381,6 +1375,12 @@ "traits": { "smithy.api#documentation": "

The name of the certificate.

" } + }, + "certificateArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + } } }, "traits": { @@ -1466,16 +1466,10 @@ "com.amazonaws.lightsail#CloudFormationStackRecord": { "type": "structure", "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., CloudFormationStackRecord).

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "sourceInfo": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList", "traits": { - "smithy.api#documentation": "

A list of objects describing the Availability Zone and AWS Region of the CloudFormation\n stack record.

" + "smithy.api#documentation": "

A list of objects describing the source of the CloudFormation stack record.

" } }, "createdAt": { @@ -1490,22 +1484,22 @@ "smithy.api#documentation": "

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon\n Resource Name (ARN) of the AWS CloudFormation stack.

" } }, - "state": { - "target": "com.amazonaws.lightsail#RecordState", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The current state of the CloudFormation stack record.

" + "smithy.api#documentation": "

A list of objects describing the Availability Zone and AWS Region of the CloudFormation\n stack record.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "state": { + "target": "com.amazonaws.lightsail#RecordState", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudFormation stack record.

" + "smithy.api#documentation": "

The current state of the CloudFormation stack record.

" } }, - "sourceInfo": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

A list of objects describing the source of the CloudFormation stack record.

" + "smithy.api#documentation": "

The Lightsail resource type (e.g., CloudFormationStackRecord).

" } }, "name": { @@ -1513,6 +1507,12 @@ "traits": { "smithy.api#documentation": "

The name of the CloudFormation stack record. It starts with\n CloudFormationStackRecord followed by a GUID.

" } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudFormation stack record.

" + } } }, "traits": { @@ -1528,6 +1528,12 @@ "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo": { "type": "structure", "members": { + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" + } + }, "resourceType": { "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceType", "traits": { @@ -1539,12 +1545,6 @@ "traits": { "smithy.api#documentation": "

The name of the record.

" } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" - } } }, "traits": { @@ -1594,22 +1594,19 @@ "com.amazonaws.lightsail#ContactMethod": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact method.

" - } + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation" }, - "protocol": { - "target": "com.amazonaws.lightsail#ContactProtocol", + "status": { + "target": "com.amazonaws.lightsail#ContactMethodStatus", "traits": { - "smithy.api#documentation": "

The protocol of the contact method, such as email or SMS (text messaging).

" + "smithy.api#documentation": "

The current status of the contact method.

\n

A contact method has the following possible status:

\n " } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "contactEndpoint": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail contact method. This code enables our support team to look up your\n Lightsail information more easily.

" + "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

" } }, "createdAt": { @@ -1618,21 +1615,12 @@ "smithy.api#documentation": "

The timestamp when the contact method was created.

" } }, - "contactEndpoint": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#ContactMethodStatus", + "protocol": { + "target": "com.amazonaws.lightsail#ContactProtocol", "traits": { - "smithy.api#documentation": "

The current status of the contact method.

\n

A contact method has the following possible status:

\n " + "smithy.api#documentation": "

The protocol of the contact method, such as email or SMS (text messaging).

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation" - }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { @@ -1644,6 +1632,18 @@ "traits": { "smithy.api#documentation": "

The name of the contact method.

" } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact method.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail contact method. This code enables our support team to look up your\n Lightsail information more easily.

" + } } }, "traits": { @@ -1770,11 +1770,16 @@ "com.amazonaws.lightsail#CopySnapshotRequest": { "type": "structure", "members": { - "sourceRegion": { - "target": "com.amazonaws.lightsail#RegionName", + "sourceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The AWS Region where the source manual or automatic snapshot is located.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the source manual snapshot to copy.

\n

Constraint:

\n " + } + }, + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot of the\n specified source instance or disk.

\n

Constraints:

\n " } }, "restoreDate": { @@ -1783,10 +1788,11 @@ "smithy.api#documentation": "

The date of the source automatic snapshot to copy. Use the get auto snapshots\n operation to identify the dates of the available automatic snapshots.

\n

Constraints:

\n " } }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", + "sourceRegion": { + "target": "com.amazonaws.lightsail#RegionName", "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot of the\n specified source instance or disk.

\n

Constraints:

\n " + "smithy.api#documentation": "

The AWS Region where the source manual or automatic snapshot is located.

", + "smithy.api#required": {} } }, "targetSnapshotName": { @@ -1796,12 +1802,6 @@ "smithy.api#required": {} } }, - "sourceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source manual snapshot to copy.

\n

Constraint:

\n " - } - }, "sourceResourceName": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -1858,16 +1858,10 @@ "com.amazonaws.lightsail#CreateCertificateRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the certificate during create.

\n\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", "traits": { - "smithy.api#documentation": "

The name for the certificate.

", + "smithy.api#documentation": "

The domain name (e.g., example.com) for the certificate.

", "smithy.api#required": {} } }, @@ -1877,29 +1871,35 @@ "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

\n\n

You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).

\n\n

Wildcard domain entries (e.g., *.example.com) are not supported.

" } }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", "traits": { - "smithy.api#documentation": "

The domain name (e.g., example.com) for the certificate.

", + "smithy.api#documentation": "

The name for the certificate.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the certificate during create.

\n\n

Use the TagResource action to tag a resource after it's created.

" + } } } }, "com.amazonaws.lightsail#CreateCertificateResult": { "type": "structure", "members": { - "certificate": { - "target": "com.amazonaws.lightsail#CertificateSummary", - "traits": { - "smithy.api#documentation": "

An object that describes the certificate created.

" - } - }, "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } + }, + "certificate": { + "target": "com.amazonaws.lightsail#CertificateSummary", + "traits": { + "smithy.api#documentation": "

An object that describes the certificate created.

" + } } } }, @@ -2116,17 +2116,10 @@ "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest": { "type": "structure", "members": { - "sourceDiskName": { + "restoreDate": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The name of the source disk from which the source automatic snapshot was created.

\n

Constraints:

\n " - } - }, - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The date of the automatic snapshot to use for the new disk. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " } }, "sizeInGb": { @@ -2136,16 +2129,17 @@ "smithy.api#required": {} } }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", + "sourceDiskName": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" + "smithy.api#documentation": "

The name of the source disk from which the source automatic snapshot was created.

\n

Constraints:

\n " } }, - "diskSnapshotName": { + "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-snapshot) from which to create the\n new storage disk.

\n

Constraint:

\n " + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", + "smithy.api#required": {} } }, "useLatestRestorableAutoSnapshot": { @@ -2154,12 +2148,6 @@ "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, "availabilityZone": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { @@ -2167,10 +2155,22 @@ "smithy.api#required": {} } }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to use for the new disk. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " + "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-snapshot) from which to create the\n new storage disk.

\n

Constraint:

\n " } } } @@ -2189,10 +2189,10 @@ "com.amazonaws.lightsail#CreateDiskRequest": { "type": "structure", "members": { - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", "smithy.api#required": {} } }, @@ -2202,11 +2202,10 @@ "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" } }, - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "availabilityZone": { @@ -2216,10 +2215,11 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", + "smithy.api#required": {} } } } @@ -2278,10 +2278,11 @@ "com.amazonaws.lightsail#CreateDiskSnapshotRequest": { "type": "structure", "members": { - "diskName": { + "diskSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The unique name of the source disk (e.g., Disk-Virginia-1).

\n \n

This parameter cannot be defined together with the instance name parameter.\n The disk name and instance name parameters are mutually\n exclusive.

\n " + "smithy.api#documentation": "

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on\n the source disk.

", + "smithy.api#required": {} } }, "instanceName": { @@ -2296,11 +2297,10 @@ "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, - "diskSnapshotName": { + "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on\n the source disk.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unique name of the source disk (e.g., Disk-Virginia-1).

\n \n

This parameter cannot be defined together with the instance name parameter.\n The disk name and instance name parameters are mutually\n exclusive.

\n " } } } @@ -2356,10 +2356,24 @@ "com.amazonaws.lightsail#CreateDistributionRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the distribution during create.

\n\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

The bundle ID to use for the distribution.

\n\n

A distribution bundle describes the specifications of your distribution, such as the\n monthly cost and monthly network transfer quota.

\n\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

", + "smithy.api#required": {} + } + }, + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", + "traits": { + "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

", + "smithy.api#required": {} } }, "distributionName": { @@ -2375,19 +2389,6 @@ "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" } }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", - "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

" - } - }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

", - "smithy.api#required": {} - } - }, "origin": { "target": "com.amazonaws.lightsail#InputOrigin", "traits": { @@ -2395,11 +2396,10 @@ "smithy.api#required": {} } }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The bundle ID to use for the distribution.

\n\n

A distribution bundle describes the specifications of your distribution, such as the\n monthly cost and monthly network transfer quota.

\n\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tag keys and optional values to add to the distribution during create.

\n\n

Use the TagResource action to tag a resource after it's created.

" } } } @@ -2407,17 +2407,17 @@ "com.amazonaws.lightsail#CreateDistributionResult": { "type": "structure", "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - }, "distribution": { "target": "com.amazonaws.lightsail#LightsailDistribution", "traits": { "smithy.api#documentation": "

An object that describes the distribution created.

" } + }, + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } } } }, @@ -2504,17 +2504,17 @@ "com.amazonaws.lightsail#CreateDomainEntryRequest": { "type": "structure", "members": { - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry request.

", + "smithy.api#documentation": "

The domain name (e.g., example.com) for which you want to create the domain\n entry.

", "smithy.api#required": {} } }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", "traits": { - "smithy.api#documentation": "

The domain name (e.g., example.com) for which you want to create the domain\n entry.

", + "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry request.

", "smithy.api#required": {} } } @@ -2534,18 +2534,18 @@ "com.amazonaws.lightsail#CreateDomainRequest": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name to manage (e.g., example.com).

\n \n

You cannot register a new domain name using Lightsail. You must register a domain name\n using Amazon Route 53 or another domain name registrar. If you have already registered your\n domain, you can enter its name in this parameter to manage the DNS records for that\n domain.

\n ", "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } } } }, @@ -2603,6 +2603,13 @@ "com.amazonaws.lightsail#CreateInstanceSnapshotRequest": { "type": "structure", "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The Lightsail instance on which to base your snapshot.

", + "smithy.api#required": {} + } + }, "instanceSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -2615,13 +2622,6 @@ "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The Lightsail instance on which to base your snapshot.

", - "smithy.api#required": {} - } } } }, @@ -2719,23 +2719,23 @@ "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest": { "type": "structure", "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The name for your key pair.

" + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " } }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", + "instanceNames": { + "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to use for the new instance. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " + "smithy.api#documentation": "

The names for your new instances.

", + "smithy.api#required": {} } }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (e.g.,\n micro_1_0).

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "sourceInstanceName": { @@ -2744,11 +2744,10 @@ "smithy.api#documentation": "

The name of the source instance from which the source automatic snapshot was\n created.

\n

Constraints:

\n " } }, - "availabilityZone": { + "userData": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The Availability Zone where you want to create your instances. Use the following\n formatting: us-east-2a (case sensitive). You can get a list of Availability Zones\n by using the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", - "smithy.api#required": {} + "smithy.api#documentation": "

You can create a launch script that configures a server with additional user data. For\n example, apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Dev Guide.

\n " } }, "attachedDiskMapping": { @@ -2757,34 +2756,29 @@ "smithy.api#documentation": "

An object containing information about one or more disk mappings.

" } }, - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance snapshot on which you are basing your new instances. Use the get\n instance snapshots operation to return information about your existing snapshots.

\n

Constraint:

\n " - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "restoreDate": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

The date of the automatic snapshot to use for the new instance. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " } }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " + "smithy.api#documentation": "

The Availability Zone where you want to create your instances. Use the following\n formatting: us-east-2a (case sensitive). You can get a list of Availability Zones\n by using the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", + "smithy.api#required": {} } }, - "userData": { - "target": "com.amazonaws.lightsail#string", + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

You can create a launch script that configures a server with additional user data. For\n example, apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Dev Guide.

\n " + "smithy.api#documentation": "

The name for your key pair.

" } }, - "instanceNames": { - "target": "com.amazonaws.lightsail#StringList", + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The names for your new instances.

", + "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (e.g.,\n micro_1_0).

", "smithy.api#required": {} } }, @@ -2793,6 +2787,12 @@ "traits": { "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" } + }, + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance snapshot on which you are basing your new instances. Use the get\n instance snapshots operation to return information about your existing snapshots.

\n

Constraint:

\n " + } } } }, @@ -2810,19 +2810,13 @@ "com.amazonaws.lightsail#CreateInstancesRequest": { "type": "structure", "members": { - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "instanceNames": { + "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

The ID for a virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0). Use the get blueprints operation to return a list\n of available images (or blueprints).

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", + "smithy.api#documentation": "

The names to use for your new Lightsail instances. Separate multiple values using\n quotation marks and commas, for example:\n [\"MyFirstInstance\",\"MySecondInstance\"]\n

", "smithy.api#required": {} } }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your key pair.

" - } - }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { @@ -2830,6 +2824,18 @@ "smithy.api#required": {} } }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your key pair.

" + } + }, "availabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -2837,17 +2843,18 @@ "smithy.api#required": {} } }, - "instanceNames": { - "target": "com.amazonaws.lightsail#StringList", + "customImageName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The names to use for your new Lightsail instances. Separate multiple values using\n quotation marks and commas, for example:\n [\"MyFirstInstance\",\"MySecondInstance\"]\n

", - "smithy.api#required": {} + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The name for your custom image.

\n \n

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now\n deprecated.

\n " } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

The ID for a virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0). Use the get blueprints operation to return a list\n of available images (or blueprints).

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", + "smithy.api#required": {} } }, "userData": { @@ -2861,13 +2868,6 @@ "traits": { "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" } - }, - "customImageName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The name for your custom image.

\n \n

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now\n deprecated.

\n " - } } } }, @@ -2925,46 +2925,46 @@ "com.amazonaws.lightsail#CreateKeyPairRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name for your new key pair.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } } } }, "com.amazonaws.lightsail#CreateKeyPairResult": { "type": "structure", "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", + "keyPair": { + "target": "com.amazonaws.lightsail#KeyPair", "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + "smithy.api#documentation": "

An array of key-value pairs containing information about the new key pair you just\n created.

" } }, - "privateKeyBase64": { + "publicKeyBase64": { "target": "com.amazonaws.lightsail#Base64", "traits": { - "smithy.api#documentation": "

A base64-encoded RSA private key.

" + "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" } }, - "keyPair": { - "target": "com.amazonaws.lightsail#KeyPair", + "operation": { + "target": "com.amazonaws.lightsail#Operation", "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the new key pair you just\n created.

" + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } }, - "publicKeyBase64": { + "privateKeyBase64": { "target": "com.amazonaws.lightsail#Base64", "traits": { - "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" + "smithy.api#documentation": "

A base64-encoded RSA private key.

" } } } @@ -3012,25 +3012,12 @@ "com.amazonaws.lightsail#CreateLoadBalancerRequest": { "type": "structure", "members": { - "instancePort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#documentation": "

The instance port where you're creating your load balancer.

", - "smithy.api#required": {} - } - }, "healthCheckPath": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The path you provided to perform the load balancer health check. If you didn't specify a\n health check path, Lightsail uses the root path of your website (e.g.,\n \"/\").

\n

You may want to specify a custom health check path other than the root of your application\n if your home page loads slowly or has a lot of media or scripting on it.

" } }, - "certificateDomainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name with which your certificate is associated (e.g.,\n example.com).

\n

If you specify certificateDomainName, then certificateName is\n required (and vice-versa).

" - } - }, "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -3038,10 +3025,16 @@ "smithy.api#required": {} } }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", + "certificateDomainName": { + "target": "com.amazonaws.lightsail#DomainName", "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate.

\n

If you specify certificateName, then certificateDomainName is\n required (and vice-versa).

" + "smithy.api#documentation": "

The domain name with which your certificate is associated (e.g.,\n example.com).

\n

If you specify certificateDomainName, then certificateName is\n required (and vice-versa).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "certificateAlternativeNames": { @@ -3050,10 +3043,17 @@ "smithy.api#documentation": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (e.g., www.example.com, example.com, m.example.com,\n blog.example.com).

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "instancePort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#documentation": "

The instance port where you're creating your load balancer.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

The name of the SSL/TLS certificate.

\n

If you specify certificateName, then certificateDomainName is\n required (and vice-versa).

" } } } @@ -3112,10 +3112,11 @@ "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest": { "type": "structure", "members": { - "certificateAlternativeNames": { - "target": "com.amazonaws.lightsail#DomainNameList", + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,\n *.example.com).

" + "smithy.api#documentation": "

The load balancer name where you want to create the SSL/TLS certificate.

", + "smithy.api#required": {} } }, "certificateDomainName": { @@ -3125,24 +3126,23 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "certificateAlternativeNames": { + "target": "com.amazonaws.lightsail#DomainNameList", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,\n *.example.com).

" } }, - "loadBalancerName": { + "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The load balancer name where you want to create the SSL/TLS certificate.

", + "smithy.api#documentation": "

The SSL/TLS certificate name.

\n

You can have up to 10 certificates in your account at one time. Each Lightsail load\n balancer can have up to 2 certificates associated with it at one time. There is also an\n overall limit to the number of certificates that can be issue in a 365-day period. For more\n information, see Limits.

", "smithy.api#required": {} } }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The SSL/TLS certificate name.

\n

You can have up to 10 certificates in your account at one time. Each Lightsail load\n balancer can have up to 2 certificates associated with it at one time. There is also an\n overall limit to the number of certificates that can be issue in a 365-day period. For more\n information, see Limits.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } } @@ -3241,47 +3241,47 @@ "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest": { "type": "structure", "members": { - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", + "restoreTime": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + "smithy.api#documentation": "

The date and time to restore your database from.

\n

Constraints:

\n " } }, - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The name to use for your new database.

\n

Constraints:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

\n

When creating a new database from a snapshot, you cannot choose a bundle that is smaller\n than the bundle of the source database.

" } }, - "relationalDatabaseSnapshotName": { + "sourceRelationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the database snapshot from which to create your new database.

" + "smithy.api#documentation": "

The name of the source database.

" } }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

\n

When creating a new database from a snapshot, you cannot choose a bundle that is smaller\n than the bundle of the source database.

" + "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" } }, - "restoreTime": { - "target": "com.amazonaws.lightsail#IsoDate", + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The date and time to restore your database from.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name to use for your new database.

\n

Constraints:

\n ", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "useLatestRestorableTime": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

Specifies whether your database is restored from the latest backup time. A value of\n true restores from the latest backup time.

\n

Default: false\n

\n

Constraints: Cannot be specified if the restore time parameter is\n provided.

" } }, - "sourceRelationalDatabaseName": { + "relationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the source database.

" + "smithy.api#documentation": "

The name of the database snapshot from which to create your new database.

" } }, "availabilityZone": { @@ -3290,10 +3290,10 @@ "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" } }, - "useLatestRestorableTime": { - "target": "com.amazonaws.lightsail#boolean", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

Specifies whether your database is restored from the latest backup time. A value of\n true restores from the latest backup time.

\n

Default: false\n

\n

Constraints: Cannot be specified if the restore time parameter is\n provided.

" + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } } @@ -3312,23 +3312,23 @@ "com.amazonaws.lightsail#CreateRelationalDatabaseRequest": { "type": "structure", "members": { - "preferredBackupWindow": { + "masterUsername": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for your new database if\n automated backups are enabled.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. For more information about the preferred backup window time blocks for each\n region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

\n

Constraints:

\n " + "smithy.api#documentation": "

The master user name for your new database.

\n

Constraints:

\n ", + "smithy.api#required": {} } }, - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The name to use for your new database.

\n

Constraints:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your new\n database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " } }, - "masterUserPassword": { - "target": "com.amazonaws.lightsail#SensitiveString", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The password for the master user of your new database. The password can include any\n printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain 8 to 41 characters.

" + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "masterDatabaseName": { @@ -3338,37 +3338,36 @@ "smithy.api#required": {} } }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", + "masterUserPassword": { + "target": "com.amazonaws.lightsail#SensitiveString", "traits": { - "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The password for the master user of your new database. The password can include any\n printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain 8 to 41 characters.

" } }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", + "relationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + "smithy.api#documentation": "

The blueprint ID for your new database. A blueprint describes the major engine version of\n a database.

\n

You can get a list of database blueprints IDs by using the get relational database\n blueprints operation.

", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

", + "smithy.api#required": {} } }, - "masterUsername": { + "preferredBackupWindow": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The master user name for your new database.

\n

Constraints:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The daily time range during which automated backups are created for your new database if\n automated backups are enabled.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. For more information about the preferred backup window time blocks for each\n region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

\n

Constraints:

\n " } }, - "relationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#string", + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The blueprint ID for your new database. A blueprint describes the major engine version of\n a database.

\n

You can get a list of database blueprints IDs by using the get relational database\n blueprints operation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" } }, "availabilityZone": { @@ -3377,10 +3376,11 @@ "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" } }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#string", + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your new\n database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name to use for your new database.

\n

Constraints:

\n ", + "smithy.api#required": {} } } } @@ -3572,17 +3572,17 @@ "com.amazonaws.lightsail#DeleteAutoSnapshotRequest": { "type": "structure", "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "date": { + "target": "com.amazonaws.lightsail#AutoSnapshotDate", "traits": { - "smithy.api#documentation": "

The name of the source instance or disk from which to delete the automatic\n snapshot.

", + "smithy.api#documentation": "

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the\n get auto snapshots operation to get the available automatic snapshots for a\n resource.

", "smithy.api#required": {} } }, - "date": { - "target": "com.amazonaws.lightsail#AutoSnapshotDate", + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the\n get auto snapshots operation to get the available automatic snapshots for a\n resource.

", + "smithy.api#documentation": "

The name of the source instance or disk from which to delete the automatic\n snapshot.

", "smithy.api#required": {} } } @@ -4083,18 +4083,18 @@ "com.amazonaws.lightsail#DeleteInstanceRequest": { "type": "structure", "members": { + "forceDeleteAddOns": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

" + } + }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance to delete.

", "smithy.api#required": {} } - }, - "forceDeleteAddOns": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

" - } } } }, @@ -4480,13 +4480,6 @@ "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest": { "type": "structure", "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database that you are deleting.

", - "smithy.api#required": {} - } - }, "finalRelationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -4498,6 +4491,13 @@ "traits": { "smithy.api#documentation": "

Determines whether a final database snapshot is created before your database is deleted.\n If true is specified, no database snapshot is created. If false is\n specified, a database snapshot is created before your database is deleted.

\n

You must specify the final relational database snapshot name parameter if the\n skip final snapshot parameter is false.

\n

Default: false\n

" } + }, + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database that you are deleting.

", + "smithy.api#required": {} + } } } }, @@ -4578,16 +4578,16 @@ "com.amazonaws.lightsail#DestinationInfo": { "type": "structure", "members": { - "service": { + "id": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The destination service of the record.

" + "smithy.api#documentation": "

The ID of the resource created at the destination.

" } }, - "id": { + "service": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the resource created at the destination.

" + "smithy.api#documentation": "

The destination service of the record.

" } } }, @@ -4921,108 +4921,108 @@ "com.amazonaws.lightsail#Disk": { "type": "structure", "members": { - "attachmentState": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The attachment state of the disk.

\n \n

In releases prior to November 14, 2017, this parameter returned attached\n for system disks in the API response. It is now deprecated, but still included in the\n response. Use isAttached instead.

\n " - } - }, - "gbInUse": { - "target": "com.amazonaws.lightsail#integer", + "addOns": { + "target": "com.amazonaws.lightsail#AddOnList", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The number of GB in use by the disk.

\n \n

In releases prior to November 14, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " + "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the disk.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The date when the disk was created.

" + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, - "iops": { - "target": "com.amazonaws.lightsail#integer", + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The input/output operations per second (IOPS) of the disk.

" + "smithy.api#documentation": "

A Boolean value indicating whether the disk is attached.

" } }, - "path": { - "target": "com.amazonaws.lightsail#string", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The disk path.

" + "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk is located.

" } }, - "attachedTo": { - "target": "com.amazonaws.lightsail#ResourceName", + "state": { + "target": "com.amazonaws.lightsail#DiskState", "traits": { - "smithy.api#documentation": "

The resources to which the disk is attached.

" + "smithy.api#documentation": "

Describes the status of the disk.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "iops": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The input/output operations per second (IOPS) of the disk.

" } }, - "state": { - "target": "com.amazonaws.lightsail#DiskState", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

Describes the status of the disk.

" + "smithy.api#documentation": "

The Lightsail resource type (e.g., Disk).

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "gbInUse": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk is located.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The number of GB in use by the disk.

\n \n

In releases prior to November 14, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " } }, - "isSystemDisk": { - "target": "com.amazonaws.lightsail#boolean", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" + "smithy.api#documentation": "

The unique name of the disk.

" } }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk.

" } }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnList", + "attachedTo": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the disk.

" + "smithy.api#documentation": "

The resources to which the disk is attached.

" } }, - "supportCode": { + "path": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + "smithy.api#documentation": "

The disk path.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk.

" + "smithy.api#documentation": "

The size of the disk in GB.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Disk).

" + "smithy.api#documentation": "

The date when the disk was created.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "attachmentState": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The unique name of the disk.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The attachment state of the disk.

\n \n

In releases prior to November 14, 2017, this parameter returned attached\n for system disks in the API response. It is now deprecated, but still included in the\n response. Use isAttached instead.

\n " } }, - "isAttached": { + "isSystemDisk": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the disk is attached.

" + "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } } }, @@ -5033,10 +5033,10 @@ "com.amazonaws.lightsail#DiskInfo": { "type": "structure", "members": { - "isSystemDisk": { - "target": "com.amazonaws.lightsail#boolean", + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" } }, "path": { @@ -5045,16 +5045,16 @@ "smithy.api#documentation": "

The disk path.

" } }, - "name": { - "target": "com.amazonaws.lightsail#string", + "isSystemDisk": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The disk name.

" + "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" } }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", + "name": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" + "smithy.api#documentation": "

The disk name.

" } } }, @@ -5103,10 +5103,16 @@ "com.amazonaws.lightsail#DiskSnapshot": { "type": "structure", "members": { - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "state": { + "target": "com.amazonaws.lightsail#DiskSnapshotState", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + "smithy.api#documentation": "

The status of the disk snapshot operation.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB.

" } }, "location": { @@ -5115,22 +5121,22 @@ "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk snapshot was created.

" } }, - "state": { - "target": "com.amazonaws.lightsail#DiskSnapshotState", + "fromDiskArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The status of the disk snapshot operation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was\n created.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., DiskSnapshot).

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "fromInstanceName": { + "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The unique name of the source instance from which the disk (system volume) snapshot was\n created.

" + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

" } }, "progress": { @@ -5139,22 +5145,22 @@ "smithy.api#documentation": "

The progress of the disk snapshot operation.

" } }, - "fromInstanceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "fromDiskName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)\n snapshot was created.

" + "smithy.api#documentation": "

The unique name of the source disk from which the disk snapshot was created.

" } }, - "name": { + "fromInstanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

" + "smithy.api#documentation": "

The unique name of the source instance from which the disk (system volume) snapshot was\n created.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk snapshot.

" + "smithy.api#documentation": "

The date when the disk snapshot was created.

" } }, "isFromAutoSnapshot": { @@ -5163,34 +5169,28 @@ "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "fromInstanceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date when the disk snapshot was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)\n snapshot was created.

" } }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

" + "smithy.api#documentation": "

The Lightsail resource type (e.g., DiskSnapshot).

" } }, - "fromDiskArn": { + "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was\n created.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk snapshot.

" } }, - "fromDiskName": { - "target": "com.amazonaws.lightsail#ResourceName", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The unique name of the source disk from which the disk snapshot was created.

" + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } } }, @@ -5271,16 +5271,10 @@ "com.amazonaws.lightsail#DistributionBundle": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the distribution bundle.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", + "isActive": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The ID of the bundle.

" + "smithy.api#documentation": "

Indicates whether the bundle is active, and can be specified for a new\n distribution.

" } }, "transferPerMonthInGb": { @@ -5289,10 +5283,10 @@ "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" } }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", + "name": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Indicates whether the bundle is active, and can be specified for a new\n distribution.

" + "smithy.api#documentation": "

The name of the distribution bundle.

" } }, "price": { @@ -5300,6 +5294,12 @@ "traits": { "smithy.api#documentation": "

The monthly price, in US dollars, of the bundle.

" } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the bundle.

" + } } }, "traits": { @@ -5352,16 +5352,10 @@ "com.amazonaws.lightsail#Domain": { "type": "structure", "members": { - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zones where the domain recordset was created.

" - } - }, - "domainEntries": { - "target": "com.amazonaws.lightsail#DomainEntryList", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entries.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, "createdAt": { @@ -5376,22 +5370,22 @@ "smithy.api#documentation": "

The resource type.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + "smithy.api#documentation": "

The AWS Region and Availability Zones where the domain recordset was created.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "domainEntries": { + "target": "com.amazonaws.lightsail#DomainEntryList", "traits": { - "smithy.api#documentation": "

The name of the domain.

" + "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entries.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "arn": { @@ -5399,6 +5393,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain recordset (e.g.,\n arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

" } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

" + } } }, "traits": { @@ -5408,18 +5408,6 @@ "com.amazonaws.lightsail#DomainEntry": { "type": "structure", "members": { - "target": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The target AWS name server (e.g., ns-111.awsdns-22.com.).

\n

For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure\n to also set isAlias to true when setting up an A record for a load\n balancer.

" - } - }, - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the domain recordset entry.

" - } - }, "name": { "target": "com.amazonaws.lightsail#DomainName", "traits": { @@ -5433,12 +5421,24 @@ "smithy.api#documentation": "

(Deprecated) The options for the domain entry.

\n \n

In releases prior to November 29, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " } }, + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the domain recordset entry.

" + } + }, "isAlias": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, specifies whether the domain entry is an alias used by the\n Lightsail load balancer. You can include an alias (A type) record in your request, which\n points to a load balancer DNS name and routes traffic to your load balancer

" } }, + "target": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The target AWS name server (e.g., ns-111.awsdns-22.com.).

\n

For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure\n to also set isAlias to true when setting up an A record for a load\n balancer.

" + } + }, "type": { "target": "com.amazonaws.lightsail#DomainEntryType", "traits": { @@ -5616,17 +5616,17 @@ "com.amazonaws.lightsail#EnableAddOnRequest": { "type": "structure", "members": { - "addOnRequest": { - "target": "com.amazonaws.lightsail#AddOnRequest", + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of strings representing the add-on to enable or modify.

", + "smithy.api#documentation": "

The name of the source resource for which to enable or modify the add-on.

", "smithy.api#required": {} } }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "addOnRequest": { + "target": "com.amazonaws.lightsail#AddOnRequest", "traits": { - "smithy.api#documentation": "

The name of the source resource for which to enable or modify the add-on.

", + "smithy.api#documentation": "

An array of strings representing the add-on to enable or modify.

", "smithy.api#required": {} } } @@ -5686,16 +5686,10 @@ "com.amazonaws.lightsail#ExportSnapshotRecord": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" - } - }, - "sourceInfo": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

A list of objects describing the source of the export snapshot record.

" + "smithy.api#documentation": "

The AWS Region and Availability Zone where the export snapshot record is located.

" } }, "state": { @@ -5704,28 +5698,34 @@ "smithy.api#documentation": "

The state of the export snapshot record.

" } }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the export snapshot record was created.

" + } + }, "destinationInfo": { "target": "com.amazonaws.lightsail#DestinationInfo", "traits": { "smithy.api#documentation": "

A list of objects describing the destination of the export snapshot record.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "sourceInfo": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo", "traits": { - "smithy.api#documentation": "

The date when the export snapshot record was created.

" + "smithy.api#documentation": "

A list of objects describing the source of the export snapshot record.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the export snapshot record is located.

" + "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" } }, "name": { @@ -5748,16 +5748,16 @@ "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo": { "type": "structure", "members": { - "instanceSnapshotInfo": { - "target": "com.amazonaws.lightsail#InstanceSnapshotInfo", + "fromResourceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

A list of objects describing an instance snapshot.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" + "smithy.api#documentation": "

The date when the source instance or disk snapshot was created.

" } }, "fromResourceName": { @@ -5766,22 +5766,16 @@ "smithy.api#documentation": "

The name of the snapshot's source instance or disk.

" } }, - "fromResourceArn": { + "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the source instance or disk snapshot was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" } }, - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "instanceSnapshotInfo": { + "target": "com.amazonaws.lightsail#InstanceSnapshotInfo", "traits": { - "smithy.api#documentation": "

The name of the source instance or disk snapshot.

" + "smithy.api#documentation": "

A list of objects describing an instance snapshot.

" } }, "diskSnapshotInfo": { @@ -5790,6 +5784,12 @@ "smithy.api#documentation": "

A list of objects describing a disk snapshot.

" } }, + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk snapshot.

" + } + }, "resourceType": { "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceType", "traits": { @@ -5912,17 +5912,17 @@ "com.amazonaws.lightsail#GetActiveNamesResult": { "type": "structure", "members": { - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.

" - } - }, "activeNames": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The list of active names returned by the get active names request.

" } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.

" + } } } }, @@ -5966,12 +5966,6 @@ "com.amazonaws.lightsail#GetAlarmsRequest": { "type": "structure", "members": { - "monitoredResourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

" - } - }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -5983,6 +5977,12 @@ "traits": { "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

" } + }, + "monitoredResourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

" + } } } }, @@ -6055,10 +6055,10 @@ "com.amazonaws.lightsail#GetAutoSnapshotsResult": { "type": "structure", "members": { - "autoSnapshots": { - "target": "com.amazonaws.lightsail#AutoSnapshotDetailsList", + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.

" + "smithy.api#documentation": "

The name of the source instance or disk for the automatic snapshots.

" } }, "resourceType": { @@ -6067,10 +6067,10 @@ "smithy.api#documentation": "

The resource type (e.g., Instance or Disk).

" } }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "autoSnapshots": { + "target": "com.amazonaws.lightsail#AutoSnapshotDetailsList", "traits": { - "smithy.api#documentation": "

The name of the source instance or disk for the automatic snapshots.

" + "smithy.api#documentation": "

An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.

" } } } @@ -6118,17 +6118,17 @@ "com.amazonaws.lightsail#GetBlueprintsRequest": { "type": "structure", "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBlueprints request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - }, "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether to include inactive results in your request.

" } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBlueprints request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } } } }, @@ -6192,34 +6192,34 @@ "com.amazonaws.lightsail#GetBundlesRequest": { "type": "structure", "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBundles request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive bundle results in your\n request.

" } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBundles request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } } } }, "com.amazonaws.lightsail#GetBundlesResult": { "type": "structure", "members": { - "bundles": { - "target": "com.amazonaws.lightsail#BundleList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs that contains information about the available bundles.

" - } - }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBundles request and\n specify the next page token using the pageToken parameter.

" } + }, + "bundles": { + "target": "com.amazonaws.lightsail#BundleList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that contains information about the available bundles.

" + } } } }, @@ -6260,10 +6260,10 @@ "com.amazonaws.lightsail#GetCertificatesRequest": { "type": "structure", "members": { - "includeCertificateDetails": { - "target": "com.amazonaws.lightsail#IncludeCertificateDetails", + "certificateStatuses": { + "target": "com.amazonaws.lightsail#CertificateStatusList", "traits": { - "smithy.api#documentation": "

Indicates whether to include detailed information about the certificates in the\n response.

\n\n

When omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.

" + "smithy.api#documentation": "

The status of the certificates for which to return information.

\n\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n\n

When omitted, the response includes all of your certificates in the AWS region where the\n request is made, regardless of their current status.

" } }, "certificateName": { @@ -6272,10 +6272,10 @@ "smithy.api#documentation": "

The name for the certificate for which to return information.

\n\n

When omitted, the response includes all of your certificates in the AWS region where the\n request is made.

" } }, - "certificateStatuses": { - "target": "com.amazonaws.lightsail#CertificateStatusList", + "includeCertificateDetails": { + "target": "com.amazonaws.lightsail#IncludeCertificateDetails", "traits": { - "smithy.api#documentation": "

The status of the certificates for which to return information.

\n\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n\n

When omitted, the response includes all of your certificates in the AWS region where the\n request is made, regardless of their current status.

" + "smithy.api#documentation": "

Indicates whether to include detailed information about the certificates in the\n response.

\n\n

When omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.

" } } } @@ -6837,10 +6837,10 @@ "com.amazonaws.lightsail#GetDistributionMetricDataRequest": { "type": "structure", "members": { - "metricName": { - "target": "com.amazonaws.lightsail#DistributionMetricName", + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n\n

Valid distribution metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n\n ", + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } }, @@ -6851,24 +6851,24 @@ "smithy.api#required": {} } }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#documentation": "

The unit for the metric data request.

\n\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", "smithy.api#required": {} } }, - "startTime": { - "target": "com.amazonaws.lightsail#timestamp", + "metricName": { + "target": "com.amazonaws.lightsail#DistributionMetricName", "traits": { - "smithy.api#documentation": "

The start of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#documentation": "

The metric for which you want to return information.

\n\n

Valid distribution metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n\n ", "smithy.api#required": {} } }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The unit for the metric data request.

\n\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", + "smithy.api#documentation": "

The name of the distribution for which to get metric data.

\n\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", "smithy.api#required": {} } }, @@ -6879,10 +6879,10 @@ "smithy.api#required": {} } }, - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", "traits": { - "smithy.api#documentation": "

The name of the distribution for which to get metric data.

\n\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#documentation": "

The start of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "smithy.api#required": {} } } @@ -6891,17 +6891,17 @@ "com.amazonaws.lightsail#GetDistributionMetricDataResult": { "type": "structure", "members": { - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - }, "metricName": { "target": "com.amazonaws.lightsail#DistributionMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } } } }, @@ -6945,17 +6945,17 @@ "com.amazonaws.lightsail#GetDistributionsRequest": { "type": "structure", "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

To get a page token, perform an initial GetDistributions request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - }, "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution for which to return information.

\n\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

\n\n

When omitted, the response includes all of your distributions in the AWS Region where\n the request is made.

" } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

To get a page token, perform an initial GetDistributions request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } } } }, @@ -7161,17 +7161,17 @@ "com.amazonaws.lightsail#GetExportSnapshotRecordsResult": { "type": "structure", "members": { - "exportSnapshotRecords": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the export snapshot records.

" - } - }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetExportSnapshotRecords\n request and specify the next page token using the pageToken parameter.

" } + }, + "exportSnapshotRecords": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the export snapshot records.

" + } } } }, @@ -7327,52 +7327,52 @@ "com.amazonaws.lightsail#GetInstanceMetricDataRequest": { "type": "structure", "members": { - "startTime": { + "endTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { - "smithy.api#documentation": "

The start time of the time period.

", + "smithy.api#documentation": "

The end time of the time period.

", "smithy.api#required": {} } }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", + "metricName": { + "target": "com.amazonaws.lightsail#InstanceMetricName", "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", "smithy.api#required": {} } }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", "traits": { - "smithy.api#documentation": "

The end time of the time period.

", + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units to specify with each available metric, see the\n metricName parameter.

", "smithy.api#required": {} } }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units to specify with each available metric, see the\n metricName parameter.

", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

The StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.

", "smithy.api#required": {} } }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", "traits": { - "smithy.api#documentation": "

The name of the instance for which you want to get metrics data.

", + "smithy.api#documentation": "

The start time of the time period.

", "smithy.api#required": {} } }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

The StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.

", + "smithy.api#documentation": "

The name of the instance for which you want to get metrics data.

", "smithy.api#required": {} } }, - "metricName": { - "target": "com.amazonaws.lightsail#InstanceMetricName", + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } } @@ -7381,17 +7381,17 @@ "com.amazonaws.lightsail#GetInstanceMetricDataResult": { "type": "structure", "members": { - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - }, "metricName": { "target": "com.amazonaws.lightsail#InstanceMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } } } }, @@ -7729,17 +7729,17 @@ "com.amazonaws.lightsail#GetInstancesResult": { "type": "structure", "members": { - "instances": { - "target": "com.amazonaws.lightsail#InstanceList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about your instances.

" - } - }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstances request and\n specify the next page token using the pageToken parameter.

" } + }, + "instances": { + "target": "com.amazonaws.lightsail#InstanceList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about your instances.

" + } } } }, @@ -7957,24 +7957,17 @@ "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest": { "type": "structure", "members": { - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#LoadBalancerMetricName", + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid load balancer metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#documentation": "

The start time of the period.

", "smithy.api#required": {} } }, - "startTime": { + "endTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { - "smithy.api#documentation": "

The start time of the period.

", + "smithy.api#documentation": "

The end time of the period.

", "smithy.api#required": {} } }, @@ -7985,24 +7978,31 @@ "smithy.api#required": {} } }, - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", "smithy.api#required": {} } }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { - "smithy.api#documentation": "

The end time of the period.

", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

", "smithy.api#required": {} } }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", + "metricName": { + "target": "com.amazonaws.lightsail#LoadBalancerMetricName", "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid load balancer metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#required": {} + } + }, + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } } @@ -8325,30 +8325,24 @@ "com.amazonaws.lightsail#GetOperationsForResourceRequest": { "type": "structure", "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperationsForResource request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" - } - }, "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the resource for which you are requesting information.

", "smithy.api#required": {} } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperationsForResource request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" + } } } }, "com.amazonaws.lightsail#GetOperationsForResourceResult": { "type": "structure", "members": { - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.

" - } - }, "nextPageCount": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -8361,6 +8355,12 @@ "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.

" + } } } }, @@ -8378,17 +8378,17 @@ "com.amazonaws.lightsail#GetOperationsResult": { "type": "structure", "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperations request and\n specify the next page token using the pageToken parameter.

" } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } } } }, @@ -8554,17 +8554,17 @@ "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult": { "type": "structure", "members": { - "blueprints": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprintList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database blueprints request.

" - } - }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseBlueprints request and specify the next page token using\n the pageToken parameter.

" } + }, + "blueprints": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprintList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database blueprints request.

" + } } } }, @@ -8622,17 +8622,17 @@ "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult": { "type": "structure", "members": { - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.

" - } - }, "bundles": { "target": "com.amazonaws.lightsail#RelationalDatabaseBundleList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database bundles request.

" } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.

" + } } } }, @@ -8679,18 +8679,18 @@ "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest": { "type": "structure", "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseEvents request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - }, "durationInMinutes": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of minutes in the past from which to retrieve events. For example, to get all\n events from the past 2 hours, enter 120.

\n

Default: 60\n

\n

The minimum is 1 and the maximum is 14 days (20160 minutes).

" } }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseEvents request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + }, "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -8703,17 +8703,17 @@ "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult": { "type": "structure", "members": { - "relationalDatabaseEvents": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEventList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database events request.

" - } - }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseEvents\n request and specify the next page token using the pageToken parameter.

" } + }, + "relationalDatabaseEvents": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEventList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database events request.

" + } } } }, @@ -8760,42 +8760,42 @@ "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest": { "type": "structure", "members": { - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", + "startFromHead": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The end of the time interval from which to get log events.

\n

Constraints:

\n " + "smithy.api#documentation": "

Parameter to specify if the log should start from head or tail. If true is\n specified, the log event starts from the head of the log. If false is specified,\n the log event starts from the tail of the log.

\n \n

For PostgreSQL, the default value of false is the only option\n available.

\n " } }, - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", + "pageToken": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The name of your database for which to get log events.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token to advance to the next or previous page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseLogEvents\n request. If your results are paginated, the response will return a next forward token and/or\n next backward token that you can specify as the page token in a subsequent request.

" } }, - "startTime": { + "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The start of the time interval from which to get log events.

\n

Constraints:

\n " + "smithy.api#documentation": "

The end of the time interval from which to get log events.

\n

Constraints:

\n " } }, - "pageToken": { + "logStreamName": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The token to advance to the next or previous page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseLogEvents\n request. If your results are paginated, the response will return a next forward token and/or\n next backward token that you can specify as the page token in a subsequent request.

" + "smithy.api#documentation": "

The name of the log stream.

\n

Use the get relational database log streams operation to get a list of\n available log streams.

", + "smithy.api#required": {} } }, - "startFromHead": { - "target": "com.amazonaws.lightsail#boolean", + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

Parameter to specify if the log should start from head or tail. If true is\n specified, the log event starts from the head of the log. If false is specified,\n the log event starts from the tail of the log.

\n \n

For PostgreSQL, the default value of false is the only option\n available.

\n " + "smithy.api#documentation": "

The name of your database for which to get log events.

", + "smithy.api#required": {} } }, - "logStreamName": { - "target": "com.amazonaws.lightsail#string", + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The name of the log stream.

\n

Use the get relational database log streams operation to get a list of\n available log streams.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The start of the time interval from which to get log events.

\n

Constraints:

\n " } } } @@ -8803,6 +8803,12 @@ "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult": { "type": "structure", "members": { + "nextForwardToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A token used for advancing to the next page of results from your get relational database\n log events request.

" + } + }, "resourceLogEvents": { "target": "com.amazonaws.lightsail#LogEventList", "traits": { @@ -8814,12 +8820,6 @@ "traits": { "smithy.api#documentation": "

A token used for advancing to the previous page of results from your get relational\n database log events request.

" } - }, - "nextForwardToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A token used for advancing to the next page of results from your get relational database\n log events request.

" - } } } }, @@ -8929,35 +8929,35 @@ "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest": { "type": "structure", "members": { - "passwordVersion": { - "target": "com.amazonaws.lightsail#RelationalDatabasePasswordVersion", - "traits": { - "smithy.api#documentation": "

The password version to return.

\n

Specifying CURRENT or PREVIOUS returns the current or previous\n passwords respectively. Specifying PENDING returns the newest version of the\n password that will rotate to CURRENT. After the PENDING password\n rotates to CURRENT, the PENDING password is no longer\n available.

\n

Default: CURRENT\n

" - } - }, "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database for which to get the master user password.

", "smithy.api#required": {} } + }, + "passwordVersion": { + "target": "com.amazonaws.lightsail#RelationalDatabasePasswordVersion", + "traits": { + "smithy.api#documentation": "

The password version to return.

\n

Specifying CURRENT or PREVIOUS returns the current or previous\n passwords respectively. Specifying PENDING returns the newest version of the\n password that will rotate to CURRENT. After the PENDING password\n rotates to CURRENT, the PENDING password is no longer\n available.

\n

Default: CURRENT\n

" + } } } }, "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the specified version of the master user password was created.

" - } - }, "masterUserPassword": { "target": "com.amazonaws.lightsail#SensitiveString", "traits": { "smithy.api#documentation": "

The master user password for the password version specified.

" } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the specified version of the master user password was created.

" + } } } }, @@ -9004,17 +9004,17 @@ "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest": { "type": "structure", "members": { - "metricName": { - "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid relational database metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value. All relational database metric data is available in 1-minute (60 seconds)\n granularity.

\n ", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All relational database metric data is available in 1-minute (60 seconds)\n granularity.

", "smithy.api#required": {} } }, - "endTime": { + "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The end of the time interval from which to get metric data.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The start of the time interval from which to get metric data.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -9025,31 +9025,31 @@ "smithy.api#required": {} } }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The start of the time interval from which to get metric data.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The name of your database from which to get metric data.

", "smithy.api#required": {} } }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#documentation": "

The end of the time interval from which to get metric data.

\n

Constraints:

\n ", "smithy.api#required": {} } }, - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", + "metricName": { + "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", "traits": { - "smithy.api#documentation": "

The name of your database from which to get metric data.

", + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid relational database metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value. All relational database metric data is available in 1-minute (60 seconds)\n granularity.

\n ", "smithy.api#required": {} } }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All relational database metric data is available in 1-minute (60 seconds)\n granularity.

", + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } } @@ -9058,17 +9058,17 @@ "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult": { "type": "structure", "members": { - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - }, "metricName": { "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } } } }, @@ -9115,18 +9115,18 @@ "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest": { "type": "structure", "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseParameters\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" - } - }, "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database for which to get parameters.

", "smithy.api#required": {} } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseParameters\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" + } } } }, @@ -9482,21 +9482,21 @@ } } } - }, - "com.amazonaws.lightsail#GetStaticIpsResult": { - "type": "structure", - "members": { - "staticIps": { - "target": "com.amazonaws.lightsail#StaticIpList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about your get static IPs\n request.

" - } - }, + }, + "com.amazonaws.lightsail#GetStaticIpsResult": { + "type": "structure", + "members": { "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of resutls from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetStaticIps request and\n specify the next page token using the pageToken parameter.

" } + }, + "staticIps": { + "target": "com.amazonaws.lightsail#StaticIpList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about your get static IPs\n request.

" + } } } }, @@ -9576,17 +9576,17 @@ "com.amazonaws.lightsail#HeaderObject": { "type": "structure", "members": { - "headersAllowList": { - "target": "com.amazonaws.lightsail#HeaderForwardList", - "traits": { - "smithy.api#documentation": "

The specific headers to forward to your distribution's origin.

" - } - }, "option": { "target": "com.amazonaws.lightsail#ForwardValues", "traits": { "smithy.api#documentation": "

The headers that you want your distribution to forward to your origin and base caching\n on.

\n\n

You can configure your distribution to do one of the following:

\n " } + }, + "headersAllowList": { + "target": "com.amazonaws.lightsail#HeaderForwardList", + "traits": { + "smithy.api#documentation": "

The specific headers to forward to your distribution's origin.

" + } } }, "traits": { @@ -9596,16 +9596,10 @@ "com.amazonaws.lightsail#HostKeyAttributes": { "type": "structure", "members": { - "algorithm": { + "fingerprintSHA256": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The SSH host key algorithm or the RDP certificate format.

\n

For SSH host keys, the algorithm may be ssh-rsa,\n ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the\n algorithm is always x509-cert.

" - } - }, - "notValidAfter": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The returned RDP certificate is not valid after this point in time.

\n

This value is listed only for RDP certificates.

" + "smithy.api#documentation": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

\n " } }, "publicKey": { @@ -9614,10 +9608,10 @@ "smithy.api#documentation": "

The public SSH host key or the RDP certificate.

" } }, - "fingerprintSHA256": { - "target": "com.amazonaws.lightsail#string", + "notValidBefore": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

\n " + "smithy.api#documentation": "

The returned RDP certificate is valid after this point in time.

\n

This value is listed only for RDP certificates.

" } }, "fingerprintSHA1": { @@ -9626,10 +9620,10 @@ "smithy.api#documentation": "

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

\n " } }, - "notValidBefore": { + "notValidAfter": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The returned RDP certificate is valid after this point in time.

\n

This value is listed only for RDP certificates.

" + "smithy.api#documentation": "

The returned RDP certificate is not valid after this point in time.

\n

This value is listed only for RDP certificates.

" } }, "witnessedAt": { @@ -9637,6 +9631,12 @@ "traits": { "smithy.api#documentation": "

The time that the SSH host key or RDP certificate was recorded by Lightsail.

" } + }, + "algorithm": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The SSH host key algorithm or the RDP certificate format.

\n

For SSH host keys, the algorithm may be ssh-rsa,\n ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the\n algorithm is always x509-cert.

" + } } }, "traits": { @@ -9692,17 +9692,17 @@ "com.amazonaws.lightsail#ImportKeyPairRequest": { "type": "structure", "members": { - "publicKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

", + "smithy.api#documentation": "

The name of the key pair for which you want to import the public key.

", "smithy.api#required": {} } }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", + "publicKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", "traits": { - "smithy.api#documentation": "

The name of the key pair for which you want to import the public key.

", + "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

", "smithy.api#required": {} } } @@ -9728,12 +9728,6 @@ "com.amazonaws.lightsail#InputOrigin": { "type": "structure", "members": { - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The AWS Region name of the origin resource.

" - } - }, "protocolPolicy": { "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", "traits": { @@ -9745,6 +9739,12 @@ "traits": { "smithy.api#documentation": "

The name of the origin resource.

" } + }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The AWS Region name of the origin resource.

" + } } }, "traits": { @@ -9754,82 +9754,82 @@ "com.amazonaws.lightsail#Instance": { "type": "structure", "members": { - "isStaticIp": { - "target": "com.amazonaws.lightsail#boolean", + "addOns": { + "target": "com.amazonaws.lightsail#AddOnList", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether this instance has a static IP assigned to it.

" + "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the instance.

" } }, - "networking": { - "target": "com.amazonaws.lightsail#InstanceNetworking", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Information about the public ports and monthly data transfer rates for the\n instance.

" + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "ipv6Address": { + "target": "com.amazonaws.lightsail#IpV6Address", "traits": { - "smithy.api#documentation": "

The timestamp when the instance was created (e.g., 1479734909.17) in Unix\n time format.

" + "smithy.api#documentation": "

The IPv6 address of the instance.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "publicIpAddress": { + "target": "com.amazonaws.lightsail#IpAddress", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

" + "smithy.api#documentation": "

The public IP address of the instance.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "networking": { + "target": "com.amazonaws.lightsail#InstanceNetworking", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + "smithy.api#documentation": "

Information about the public ports and monthly data transfer rates for the\n instance.

" } }, - "username": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "privateIpAddress": { + "target": "com.amazonaws.lightsail#IpAddress", "traits": { - "smithy.api#documentation": "

The user name for connecting to the instance (e.g., ec2-user).

" + "smithy.api#documentation": "

The private IP address of the instance.

" } }, - "hardware": { - "target": "com.amazonaws.lightsail#InstanceHardware", + "isStaticIp": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The size of the vCPU and the amount of RAM for the instance.

" + "smithy.api#documentation": "

A Boolean value indicating whether this instance has a static IP assigned to it.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

" + "smithy.api#documentation": "

The bundle for the instance (e.g., micro_1_0).

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The type of resource (usually Instance).

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "ipv6Address": { - "target": "com.amazonaws.lightsail#IpV6Address", + "username": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The IPv6 address of the instance.

" + "smithy.api#documentation": "

The user name for connecting to the instance (e.g., ec2-user).

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The blueprint ID (e.g., os_amlinux_2016_03).

" } }, - "privateIpAddress": { - "target": "com.amazonaws.lightsail#IpAddress", + "sshKeyName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The private IP address of the instance.

" + "smithy.api#documentation": "

The name of the SSH key being used to connect to the instance (e.g.,\n LightsailDefaultKeyPair).

" } }, - "state": { - "target": "com.amazonaws.lightsail#InstanceState", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The status code and the state (e.g., running) for the instance.

" + "smithy.api#documentation": "

The timestamp when the instance was created (e.g., 1479734909.17) in Unix\n time format.

" } }, "location": { @@ -9838,10 +9838,10 @@ "smithy.api#documentation": "

The region name and Availability Zone where the instance is located.

" } }, - "publicIpAddress": { - "target": "com.amazonaws.lightsail#IpAddress", + "state": { + "target": "com.amazonaws.lightsail#InstanceState", "traits": { - "smithy.api#documentation": "

The public IP address of the instance.

" + "smithy.api#documentation": "

The status code and the state (e.g., running) for the instance.

" } }, "blueprintName": { @@ -9850,28 +9850,28 @@ "smithy.api#documentation": "

The friendly name of the blueprint (e.g., Amazon Linux).

" } }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnList", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the instance.

" + "smithy.api#documentation": "

The type of resource (usually Instance).

" } }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "hardware": { + "target": "com.amazonaws.lightsail#InstanceHardware", "traits": { - "smithy.api#documentation": "

The bundle for the instance (e.g., micro_1_0).

" + "smithy.api#documentation": "

The size of the vCPU and the amount of RAM for the instance.

" } }, - "sshKeyName": { - "target": "com.amazonaws.lightsail#ResourceName", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the SSH key being used to connect to the instance (e.g.,\n LightsailDefaultKeyPair).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

" } }, - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The blueprint ID (e.g., os_amlinux_2016_03).

" + "smithy.api#documentation": "

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

" } } }, @@ -9882,22 +9882,22 @@ "com.amazonaws.lightsail#InstanceAccessDetails": { "type": "structure", "members": { - "password": { - "target": "com.amazonaws.lightsail#string", + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty\n string if the password for your new instance is not ready yet. When you create an instance, it\n can take up to 15 minutes for the instance to be ready.

\n \n

If you create an instance using any key pair other than the default\n (LightsailDefaultKeyPair), password will always be an empty\n string.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original password value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " + "smithy.api#documentation": "

The name of this Amazon Lightsail instance.

" } }, - "expiresAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "certKey": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

For SSH access, the date on which the temporary keys expire.

" + "smithy.api#documentation": "

For SSH access, the public key to use when accessing your instance For OpenSSH clients\n (e.g., command line SSH), you should save this value to tempkey-cert.pub.

" } }, - "ipAddress": { - "target": "com.amazonaws.lightsail#IpAddress", + "hostKeys": { + "target": "com.amazonaws.lightsail#HostKeysList", "traits": { - "smithy.api#documentation": "

The public IP address of the Amazon Lightsail instance.

" + "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" } }, "protocol": { @@ -9906,16 +9906,16 @@ "smithy.api#documentation": "

The protocol for these Amazon Lightsail instance access details.

" } }, - "hostKeys": { - "target": "com.amazonaws.lightsail#HostKeysList", + "ipAddress": { + "target": "com.amazonaws.lightsail#IpAddress", "traits": { - "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" + "smithy.api#documentation": "

The public IP address of the Amazon Lightsail instance.

" } }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "expiresAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The name of this Amazon Lightsail instance.

" + "smithy.api#documentation": "

For SSH access, the date on which the temporary keys expire.

" } }, "username": { @@ -9924,10 +9924,10 @@ "smithy.api#documentation": "

The user name to use when logging in to the Amazon Lightsail instance.

" } }, - "privateKey": { + "password": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH),\n you should save this value to tempkey).

" + "smithy.api#documentation": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty\n string if the password for your new instance is not ready yet. When you create an instance, it\n can take up to 15 minutes for the instance to be ready.

\n \n

If you create an instance using any key pair other than the default\n (LightsailDefaultKeyPair), password will always be an empty\n string.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original password value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " } }, "passwordData": { @@ -9936,10 +9936,10 @@ "smithy.api#documentation": "

For a Windows Server-based instance, an object with the data you can use to retrieve your\n password. This is only needed if password is empty and the instance is not new\n (and therefore the password is not ready yet). When you create an instance, it can take up to\n 15 minutes for the instance to be ready.

" } }, - "certKey": { + "privateKey": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

For SSH access, the public key to use when accessing your instance For OpenSSH clients\n (e.g., command line SSH), you should save this value to tempkey-cert.pub.

" + "smithy.api#documentation": "

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH),\n you should save this value to tempkey).

" } } }, @@ -9965,6 +9965,13 @@ "com.amazonaws.lightsail#InstanceEntry": { "type": "structure", "members": { + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the new Amazon EC2 instance.

", + "smithy.api#required": {} + } + }, "sourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -9991,13 +9998,6 @@ "traits": { "smithy.api#documentation": "

A launch script you can create that configures a server with additional user data. For\n example, you might want to run apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg.

\n " } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone for the new Amazon EC2 instance.

", - "smithy.api#required": {} - } } }, "traits": { @@ -10013,10 +10013,10 @@ "com.amazonaws.lightsail#InstanceHardware": { "type": "structure", "members": { - "disks": { - "target": "com.amazonaws.lightsail#DiskList", + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", "traits": { - "smithy.api#documentation": "

The disks attached to the instance.

" + "smithy.api#documentation": "

The amount of RAM in GB on the instance (e.g., 1.0).

" } }, "cpuCount": { @@ -10025,10 +10025,10 @@ "smithy.api#documentation": "

The number of vCPUs the instance has.

" } }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", + "disks": { + "target": "com.amazonaws.lightsail#DiskList", "traits": { - "smithy.api#documentation": "

The amount of RAM in GB on the instance (e.g., 1.0).

" + "smithy.api#documentation": "

The disks attached to the instance.

" } } }, @@ -10127,17 +10127,17 @@ "smithy.api#documentation": "

The name of the Lightsail instance for which you are requesting health check\n data.

" } }, - "instanceHealthReason": { - "target": "com.amazonaws.lightsail#InstanceHealthReason", - "traits": { - "smithy.api#documentation": "

More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.

\n

If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:

\n " - } - }, "instanceHealth": { "target": "com.amazonaws.lightsail#InstanceHealthState", "traits": { "smithy.api#documentation": "

Describes the overall instance health. Valid values are below.

" } + }, + "instanceHealthReason": { + "target": "com.amazonaws.lightsail#InstanceHealthReason", + "traits": { + "smithy.api#documentation": "

More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.

\n

If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:

\n " + } } }, "traits": { @@ -10198,17 +10198,17 @@ "com.amazonaws.lightsail#InstanceNetworking": { "type": "structure", "members": { - "monthlyTransfer": { - "target": "com.amazonaws.lightsail#MonthlyTransfer", - "traits": { - "smithy.api#documentation": "

The amount of data in GB allocated for monthly data transfers.

" - } - }, "ports": { "target": "com.amazonaws.lightsail#InstancePortInfoList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the ports on the instance.

" } + }, + "monthlyTransfer": { + "target": "com.amazonaws.lightsail#MonthlyTransfer", + "traits": { + "smithy.api#documentation": "

The amount of data in GB allocated for monthly data transfers.

" + } } }, "traits": { @@ -10239,16 +10239,16 @@ "com.amazonaws.lightsail#InstancePortInfo": { "type": "structure", "members": { - "cidrListAliases": { + "cidrs": { "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + "smithy.api#documentation": "

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to\n an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, - "accessDirection": { - "target": "com.amazonaws.lightsail#AccessDirection", + "commonName": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The access direction (inbound or outbound).

\n \n

Lightsail currently supports only inbound access direction.

\n " + "smithy.api#documentation": "

The common name of the port information.

" } }, "accessType": { @@ -10257,22 +10257,10 @@ "smithy.api#documentation": "

The type of access (Public or Private).

" } }, - "commonName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The common name of the port information.

" - } - }, - "cidrs": { + "cidrListAliases": { "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to\n an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" } }, "fromPort": { @@ -10287,6 +10275,18 @@ "smithy.api#documentation": "

The location from which access is allowed. For example, Anywhere (0.0.0.0/0),\n or Custom if a specific IP address or range of IP addresses is allowed.

" } }, + "toPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "accessDirection": { + "target": "com.amazonaws.lightsail#AccessDirection", + "traits": { + "smithy.api#documentation": "

The access direction (inbound or outbound).

\n \n

Lightsail currently supports only inbound access direction.

\n " + } + }, "protocol": { "target": "com.amazonaws.lightsail#NetworkProtocol", "traits": { @@ -10307,34 +10307,34 @@ "com.amazonaws.lightsail#InstancePortState": { "type": "structure", "members": { - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", + "toPort": { + "target": "com.amazonaws.lightsail#Port", "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", + "state": { + "target": "com.amazonaws.lightsail#PortState", "traits": { - "smithy.api#documentation": "

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to\n an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + "smithy.api#documentation": "

Specifies whether the instance port is open or closed.

\n \n

The port state for Lightsail instances is always open.

\n " } }, - "protocol": { - "target": "com.amazonaws.lightsail#NetworkProtocol", + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " + "smithy.api#documentation": "

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to\n an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, - "state": { - "target": "com.amazonaws.lightsail#PortState", + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

Specifies whether the instance port is open or closed.

\n \n

The port state for Lightsail instances is always open.

\n " + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" } }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", + "protocol": { + "target": "com.amazonaws.lightsail#NetworkProtocol", "traits": { - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " } }, "fromPort": { @@ -10357,16 +10357,16 @@ "com.amazonaws.lightsail#InstanceSnapshot": { "type": "structure", "members": { - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", + "fromBlueprintId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The size in GB of the SSD.

" + "smithy.api#documentation": "

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A\n blueprint is a virtual private server (or instance) image used to create\n instances quickly.

" } }, - "state": { - "target": "com.amazonaws.lightsail#InstanceSnapshotState", + "fromInstanceName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The state the snapshot is in.

" + "smithy.api#documentation": "

The instance from which the snapshot was created.

" } }, "createdAt": { @@ -10375,40 +10375,40 @@ "smithy.api#documentation": "

The timestamp when the snapshot was created (e.g., 1479907467.024).

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "fromBundleId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The region name and Availability Zone where you created the snapshot.

" + "smithy.api#documentation": "

The bundle ID from which you created the snapshot (e.g., micro_1_0).

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "fromAttachedDisks": { + "target": "com.amazonaws.lightsail#DiskList", "traits": { - "smithy.api#documentation": "

The type of resource (usually InstanceSnapshot).

" + "smithy.api#documentation": "

An array of disk objects containing information about all block storage disks.

" } }, - "isFromAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "progress": { - "target": "com.amazonaws.lightsail#string", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The progress of the snapshot.

" + "smithy.api#documentation": "

The region name and Availability Zone where you created the snapshot.

" } }, - "fromInstanceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "state": { + "target": "com.amazonaws.lightsail#InstanceSnapshotState", "traits": { - "smithy.api#documentation": "

The instance from which the snapshot was created.

" + "smithy.api#documentation": "

The state the snapshot is in.

" } }, - "fromInstanceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

" + "smithy.api#documentation": "

The size in GB of the SSD.

" } }, "supportCode": { @@ -10417,40 +10417,40 @@ "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "fromInstanceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the snapshot.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "isFromAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

" + "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "progress": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The progress of the snapshot.

" } }, - "fromBlueprintId": { - "target": "com.amazonaws.lightsail#string", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A\n blueprint is a virtual private server (or instance) image used to create\n instances quickly.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

" } }, - "fromAttachedDisks": { - "target": "com.amazonaws.lightsail#DiskList", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of disk objects containing information about all block storage disks.

" + "smithy.api#documentation": "

The name of the snapshot.

" } }, - "fromBundleId": { - "target": "com.amazonaws.lightsail#string", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The bundle ID from which you created the snapshot (e.g., micro_1_0).

" + "smithy.api#documentation": "

The type of resource (usually InstanceSnapshot).

" } } }, @@ -10461,10 +10461,10 @@ "com.amazonaws.lightsail#InstanceSnapshotInfo": { "type": "structure", "members": { - "fromBlueprintId": { + "fromBundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The blueprint ID from which the source instance (e.g., os_debian_8_3).

" + "smithy.api#documentation": "

The bundle ID from which the source instance was created (e.g.,\n micro_1_0).

" } }, "fromDiskInfo": { @@ -10473,10 +10473,10 @@ "smithy.api#documentation": "

A list of objects describing the disks that were attached to the source instance.

" } }, - "fromBundleId": { + "fromBlueprintId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The bundle ID from which the source instance was created (e.g.,\n micro_1_0).

" + "smithy.api#documentation": "

The blueprint ID from which the source instance (e.g., os_debian_8_3).

" } } }, @@ -10532,16 +10532,16 @@ "com.amazonaws.lightsail#InvalidInputException": { "type": "structure", "members": { - "tip": { + "docs": { "target": "com.amazonaws.lightsail#string" }, - "code": { + "message": { "target": "com.amazonaws.lightsail#string" }, - "docs": { + "code": { "target": "com.amazonaws.lightsail#string" }, - "message": { + "tip": { "target": "com.amazonaws.lightsail#string" } }, @@ -10630,22 +10630,22 @@ "com.amazonaws.lightsail#KeyPair": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The friendly name of the SSH key pair.

" + "smithy.api#documentation": "

The timestamp when the key pair was created (e.g., 1479816991.349).

" } }, - "fingerprint": { - "target": "com.amazonaws.lightsail#Base64", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The RSA fingerprint of the key pair.

" + "smithy.api#documentation": "

The resource type (usually KeyPair).

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key pair (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, "supportCode": { @@ -10654,16 +10654,16 @@ "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The friendly name of the SSH key pair.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The resource type (usually KeyPair).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key pair (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

" } }, "location": { @@ -10672,10 +10672,10 @@ "smithy.api#documentation": "

The region name and Availability Zone where the key pair was created.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "fingerprint": { + "target": "com.amazonaws.lightsail#Base64", "traits": { - "smithy.api#documentation": "

The timestamp when the key pair was created (e.g., 1479816991.349).

" + "smithy.api#documentation": "

The RSA fingerprint of the key pair.

" } } }, @@ -10692,88 +10692,82 @@ "com.amazonaws.lightsail#LightsailDistribution": { "type": "structure", "members": { - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior of the distribution.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "originPublicDNS": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

An object that describes the location of the distribution, such as the AWS Region and\n Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any AWS\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n " + "smithy.api#documentation": "

The public DNS of the origin.

" } }, - "status": { - "target": "com.amazonaws.lightsail#string", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The status of the distribution.

" + "smithy.api#documentation": "

The timestamp when the distribution was created.

" } }, - "origin": { - "target": "com.amazonaws.lightsail#Origin", + "alternativeDomainNames": { + "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance or load balancer.

\n\n

The distribution pulls, caches, and serves content from the origin.

" + "smithy.api#documentation": "

The alternate domain names of the distribution.

" } }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", + "isEnabled": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings of the distribution.

" + "smithy.api#documentation": "

Indicates whether the distribution is enabled.

" } }, - "originPublicDNS": { + "domainName": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The public DNS of the origin.

" + "smithy.api#documentation": "

The domain name of the distribution.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "ableToUpdateBundle": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Distribution).

" + "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to your distribution, specified\n using the distributionName parameter, can be changed to another bundle.

\n\n

Use the UpdateDistributionBundle action to change your distribution's\n bundle.

" } }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", + "bundleId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior of the distribution.

" + "smithy.api#documentation": "

The ID of the bundle currently applied to the distribution.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The timestamp when the distribution was created.

" + "smithy.api#documentation": "

The name of the SSL/TLS certificate attached to the distribution, if any.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "isEnabled": { - "target": "com.amazonaws.lightsail#boolean", + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", "traits": { - "smithy.api#documentation": "

Indicates whether the distribution is enabled.

" + "smithy.api#documentation": "

An object that describes the default cache behavior of the distribution.

" } }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", + "origin": { + "target": "com.amazonaws.lightsail#Origin", "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate attached to the distribution, if any.

" + "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance or load balancer.

\n\n

The distribution pulls, caches, and serves content from the origin.

" } }, - "domainName": { - "target": "com.amazonaws.lightsail#string", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The domain name of the distribution.

" + "smithy.api#documentation": "

An object that describes the location of the distribution, such as the AWS Region and\n Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any AWS\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n " } }, - "ableToUpdateBundle": { - "target": "com.amazonaws.lightsail#boolean", + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", "traits": { - "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to your distribution, specified\n using the distributionName parameter, can be changed to another bundle.

\n\n

Use the UpdateDistributionBundle action to change your distribution's\n bundle.

" + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior of the distribution.

" } }, "name": { @@ -10782,28 +10776,34 @@ "smithy.api#documentation": "

The name of the distribution.

" } }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings of the distribution.

" + } + }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail distribution. This code enables our support team to look up your Lightsail\n information more easily.

" } }, - "alternativeDomainNames": { - "target": "com.amazonaws.lightsail#StringList", + "status": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The alternate domain names of the distribution.

" + "smithy.api#documentation": "

The status of the distribution.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution.

" } }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The ID of the bundle currently applied to the distribution.

" + "smithy.api#documentation": "

The Lightsail resource type (e.g., Distribution).

" } } }, @@ -11215,16 +11215,16 @@ "com.amazonaws.lightsail#LoadBalancer": { "type": "structure", "members": { - "healthCheckPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "instanceHealthSummary": { + "target": "com.amazonaws.lightsail#InstanceHealthSummaryList", "traits": { - "smithy.api#documentation": "

The path you specified to perform your health checks. If no path is specified, the load\n balancer tries to make a request to the default (root) page.

" + "smithy.api#documentation": "

An array of InstanceHealthSummary objects describing the health of the load\n balancer.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "dnsName": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date when your load balancer was created.

" + "smithy.api#documentation": "

The DNS name of your Lightsail load balancer.

" } }, "tlsCertificateSummaries": { @@ -11233,16 +11233,16 @@ "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateSummary objects that provide additional information\n about the SSL/TLS certificates. For example, if true, the certificate is attached\n to the load balancer.

" } }, - "protocol": { - "target": "com.amazonaws.lightsail#LoadBalancerProtocol", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The protocol you have enabled for your load balancer. Valid values are below.

\n

You can't just have HTTP_HTTPS, but you can have just\n HTTP.

" + "smithy.api#documentation": "

The name of the load balancer (e.g., my-load-balancer).

" } }, - "instanceHealthSummary": { - "target": "com.amazonaws.lightsail#InstanceHealthSummaryList", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of InstanceHealthSummary objects describing the health of the load\n balancer.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } }, "resourceType": { @@ -11251,64 +11251,64 @@ "smithy.api#documentation": "

The resource type (e.g., LoadBalancer.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "protocol": { + "target": "com.amazonaws.lightsail#LoadBalancerProtocol", "traits": { - "smithy.api#documentation": "

The name of the load balancer (e.g., my-load-balancer).

" + "smithy.api#documentation": "

The protocol you have enabled for your load balancer. Valid values are below.

\n

You can't just have HTTP_HTTPS, but you can have just\n HTTP.

" } }, - "instancePort": { - "target": "com.amazonaws.lightsail#integer", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The port where the load balancer will direct traffic to your Lightsail instances. For\n HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" + "smithy.api#documentation": "

The date when your load balancer was created.

" } }, - "state": { - "target": "com.amazonaws.lightsail#LoadBalancerState", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The status of your load balancer. Valid values are below.

" + "smithy.api#documentation": "

The AWS Region where your load balancer was created (e.g., us-east-2a).\n Lightsail automatically creates your load balancer across Availability Zones.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "configurationOptions": { + "target": "com.amazonaws.lightsail#LoadBalancerConfigurationOptions", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer. This code enables our support team to look up your Lightsail\n information more easily.

" + "smithy.api#documentation": "

A string to string map of the configuration options for your load balancer. Valid values\n are listed below.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "state": { + "target": "com.amazonaws.lightsail#LoadBalancerState", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" + "smithy.api#documentation": "

The status of your load balancer. Valid values are below.

" } }, - "dnsName": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The DNS name of your Lightsail load balancer.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "publicPorts": { - "target": "com.amazonaws.lightsail#PortList", + "healthCheckPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,\n use port 443.

" + "smithy.api#documentation": "

The path you specified to perform your health checks. If no path is specified, the load\n balancer tries to make a request to the default (root) page.

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The AWS Region where your load balancer was created (e.g., us-east-2a).\n Lightsail automatically creates your load balancer across Availability Zones.

" + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer. This code enables our support team to look up your Lightsail\n information more easily.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "instancePort": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The port where the load balancer will direct traffic to your Lightsail instances. For\n HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" } }, - "configurationOptions": { - "target": "com.amazonaws.lightsail#LoadBalancerConfigurationOptions", + "publicPorts": { + "target": "com.amazonaws.lightsail#PortList", "traits": { - "smithy.api#documentation": "

A string to string map of the configuration options for your load balancer. Valid values\n are listed below.

" + "smithy.api#documentation": "

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,\n use port 443.

" } } }, @@ -11450,46 +11450,40 @@ "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { "type": "structure", "members": { - "issuer": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The issuer of the certificate.

" - } - }, - "subject": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" + "smithy.api#documentation": "

The AWS Region and Availability Zone where you created your certificate.

" } }, - "revocationReason": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason", + "status": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus", "traits": { - "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" + "smithy.api#documentation": "

The validation status of the SSL/TLS certificate. Valid values are below.

" } }, - "notAfter": { - "target": "com.amazonaws.lightsail#IsoDate", + "serial": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate expires.

" + "smithy.api#documentation": "

The serial number of the certificate.

" } }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#StringList", + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

" + "smithy.api#documentation": "

The load balancer name where your SSL/TLS certificate is attached.

" } }, - "keyAlgorithm": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key).

" + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to\n look up your Lightsail information more easily.

" } }, - "notBefore": { - "target": "com.amazonaws.lightsail#IsoDate", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate is first valid.

" + "smithy.api#documentation": "

The name of the SSL/TLS certificate (e.g., my-certificate).

" } }, "domainValidationRecords": { @@ -11498,58 +11492,58 @@ "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the\n records.

" } }, - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", + "signatureAlgorithm": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The load balancer name where your SSL/TLS certificate is attached.

" + "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" } }, - "createdAt": { + "notAfter": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The time when you created your SSL/TLS certificate.

" + "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate expires.

" } }, - "renewalSummary": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary", + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" + "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" } }, - "issuedAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The time when the SSL/TLS certificate was issued.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "failureReason": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" + "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n\n

The following failure reasons are possible:

\n " } }, - "revokedAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" + "smithy.api#documentation": "

The domain name for your SSL/TLS certificate.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "revocationReason": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason", "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where you created your certificate.

" + "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" } }, - "signatureAlgorithm": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "revokedAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" + "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" } }, "resourceType": { @@ -11558,46 +11552,52 @@ "smithy.api#documentation": "

The resource type (e.g., LoadBalancerTlsCertificate).

\n " } }, - "failureReason": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason", + "subject": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n\n

The following failure reasons are possible:

\n " + "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" + } + }, + "keyAlgorithm": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key).

" } }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The domain name for your SSL/TLS certificate.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" } }, - "serial": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "issuedAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" + "smithy.api#documentation": "

The time when the SSL/TLS certificate was issued.

" } }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", + "renewalSummary": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary", "traits": { - "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" + "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" } }, - "status": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus", + "issuer": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The validation status of the SSL/TLS certificate. Valid values are below.

" + "smithy.api#documentation": "

The issuer of the certificate.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to\n look up your Lightsail information more easily.

" + "smithy.api#documentation": "

The time when you created your SSL/TLS certificate.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "notBefore": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate (e.g., my-certificate).

" + "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate is first valid.

" } } }, @@ -11653,12 +11653,6 @@ "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value for that type.

" - } - }, "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { @@ -11671,10 +11665,10 @@ "smithy.api#documentation": "

The domain name against which your SSL/TLS certificate was validated.

" } }, - "type": { + "value": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of validation record. For example, CNAME for domain\n validation.

" + "smithy.api#documentation": "

The value for that type.

" } }, "validationStatus": { @@ -11682,6 +11676,12 @@ "traits": { "smithy.api#documentation": "

The validation status. Valid values are listed below.

" } + }, + "type": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of validation record. For example, CNAME for domain\n validation.

" + } } }, "traits": { @@ -11859,17 +11859,17 @@ "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate.

" - } - }, "isAttached": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate.

" + } } }, "traits": { @@ -11885,17 +11885,17 @@ "com.amazonaws.lightsail#LogEvent": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database log event was created.

" - } - }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message of the database log event.

" } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database log event was created.

" + } } }, "traits": { @@ -11911,12 +11911,6 @@ "com.amazonaws.lightsail#MetricDatapoint": { "type": "structure", "members": { - "maximum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The maximum.

" - } - }, "sampleCount": { "target": "com.amazonaws.lightsail#double", "traits": { @@ -11929,6 +11923,18 @@ "smithy.api#documentation": "

The timestamp (e.g., 1479816991.349).

" } }, + "minimum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The minimum.

" + } + }, + "sum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The sum.

" + } + }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { @@ -11941,16 +11947,10 @@ "smithy.api#documentation": "

The average.

" } }, - "minimum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The minimum.

" - } - }, - "sum": { + "maximum": { "target": "com.amazonaws.lightsail#double", "traits": { - "smithy.api#documentation": "

The sum.

" + "smithy.api#documentation": "

The maximum.

" } } }, @@ -12231,6 +12231,12 @@ "com.amazonaws.lightsail#MonitoredResourceInfo": { "type": "structure", "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type of the resource being monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

" + } + }, "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -12242,12 +12248,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being monitored.

" } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type of the resource being monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

" - } } }, "traits": { @@ -12300,16 +12300,16 @@ "com.amazonaws.lightsail#NotFoundException": { "type": "structure", "members": { - "tip": { + "code": { "target": "com.amazonaws.lightsail#string" }, - "message": { + "docs": { "target": "com.amazonaws.lightsail#string" }, - "docs": { + "tip": { "target": "com.amazonaws.lightsail#string" }, - "code": { + "message": { "target": "com.amazonaws.lightsail#string" } }, @@ -12398,22 +12398,28 @@ "com.amazonaws.lightsail#Operation": { "type": "structure", "members": { - "statusChangedAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "isTerminal": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The timestamp when the status was changed (e.g., 1479816991.349).

" + "smithy.api#documentation": "

A Boolean value indicating whether the operation is terminal.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "errorCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The resource type.

" + "smithy.api#documentation": "

The error code.

" } }, - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "operationType": { + "target": "com.amazonaws.lightsail#OperationType", "traits": { - "smithy.api#documentation": "

The ID of the operation.

" + "smithy.api#documentation": "

The type of operation.

" + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

" } }, "location": { @@ -12422,28 +12428,34 @@ "smithy.api#documentation": "

The AWS Region and Availability Zone.

" } }, - "isTerminal": { - "target": "com.amazonaws.lightsail#boolean", + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the operation is terminal.

" + "smithy.api#documentation": "

The ID of the operation.

" } }, - "operationDetails": { - "target": "com.amazonaws.lightsail#string", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

Details about the operation (e.g., Debian-1GB-Ohio-1).

" + "smithy.api#documentation": "

The timestamp when the operation was initialized (e.g.,\n 1479816991.349).

" } }, - "operationType": { - "target": "com.amazonaws.lightsail#OperationType", + "statusChangedAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The type of operation.

" + "smithy.api#documentation": "

The timestamp when the status was changed (e.g., 1479816991.349).

" } }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The resource name.

" + "smithy.api#documentation": "

The resource type.

" + } + }, + "operationDetails": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Details about the operation (e.g., Debian-1GB-Ohio-1).

" } }, "status": { @@ -12457,18 +12469,6 @@ "traits": { "smithy.api#documentation": "

The error details.

" } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the operation was initialized (e.g.,\n 1479816991.349).

" - } - }, - "errorCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The error code.

" - } } }, "traits": { @@ -12478,16 +12478,16 @@ "com.amazonaws.lightsail#OperationFailureException": { "type": "structure", "members": { - "code": { + "docs": { "target": "com.amazonaws.lightsail#string" }, - "message": { + "tip": { "target": "com.amazonaws.lightsail#string" }, - "tip": { + "code": { "target": "com.amazonaws.lightsail#string" }, - "docs": { + "message": { "target": "com.amazonaws.lightsail#string" } }, @@ -12796,18 +12796,18 @@ "com.amazonaws.lightsail#Origin": { "type": "structure", "members": { - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The AWS Region name of the origin resource.

" - } - }, "protocolPolicy": { "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", "traits": { "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" } }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The AWS Region name of the origin resource.

" + } + }, "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -12843,17 +12843,17 @@ "com.amazonaws.lightsail#PasswordData": { "type": "structure", "members": { - "ciphertext": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The encrypted password. Ciphertext will be an empty string if access to your new instance\n is not ready yet. When you create an instance, it can take up to 15 minutes for the instance\n to be ready.

\n \n

If you use the default key pair (LightsailDefaultKeyPair), the decrypted\n password will be available in the password field.

\n

If you are using a custom key pair, you need to use your own means of decryption.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original ciphertext value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " - } - }, "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the key pair that you used when creating your instance. If no key pair name\n was specified when creating the instance, Lightsail uses the default key pair\n (LightsailDefaultKeyPair).

\n

If you are using a custom key pair, you need to use your own means of decrypting your\n password using the ciphertext. Lightsail creates the ciphertext by encrypting\n your password with the public key part of this key pair.

" } + }, + "ciphertext": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The encrypted password. Ciphertext will be an empty string if access to your new instance\n is not ready yet. When you create an instance, it can take up to 15 minutes for the instance\n to be ready.

\n \n

If you use the default key pair (LightsailDefaultKeyPair), the decrypted\n password will be available in the password field.

\n

If you are using a custom key pair, you need to use your own means of decryption.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original ciphertext value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " + } } }, "traits": { @@ -12918,12 +12918,6 @@ "com.amazonaws.lightsail#PendingMaintenanceAction": { "type": "structure", "members": { - "currentApplyDate": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The effective date of the pending database maintenance action.

" - } - }, "action": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { @@ -12935,6 +12929,12 @@ "traits": { "smithy.api#documentation": "

Additional detail about the pending database maintenance action.

" } + }, + "currentApplyDate": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The effective date of the pending database maintenance action.

" + } } }, "traits": { @@ -12950,18 +12950,18 @@ "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues": { "type": "structure", "members": { - "engineVersion": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The database engine version.

" - } - }, "backupRetentionEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled.

" } }, + "engineVersion": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, "masterUserPassword": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -12998,18 +12998,12 @@ } }, "com.amazonaws.lightsail#PortInfo": { - "type": "structure", - "members": { - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" - } - }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", + "type": "structure", + "members": { + "fromPort": { + "target": "com.amazonaws.lightsail#Port", "traits": { - "smithy.api#documentation": "

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to\n an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

\n

Examples:

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, "protocol": { @@ -13018,10 +13012,10 @@ "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " } }, - "fromPort": { - "target": "com.amazonaws.lightsail#Port", + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " + "smithy.api#documentation": "

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to\n an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

\n

Examples:

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, "toPort": { @@ -13029,6 +13023,12 @@ "traits": { "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " } + }, + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + } } }, "traits": { @@ -13125,17 +13125,16 @@ "com.amazonaws.lightsail#PutAlarmRequest": { "type": "structure", "members": { - "monitoredResourceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "datapointsToAlarm": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource that will be monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of data points that must be not within the specified threshold to trigger the\n alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm)\n is the M.

" } }, - "notificationTriggers": { - "target": "com.amazonaws.lightsail#NotificationTriggerList", + "treatMissingData": { + "target": "com.amazonaws.lightsail#TreatMissingData", "traits": { - "smithy.api#documentation": "

The alarm states that trigger a notification.

\n

An alarm has the following possible states:

\n \n

When you specify a notification trigger, the ALARM state must be specified.\n The INSUFFICIENT_DATA and OK states can be specified in addition to\n the ALARM state.

\n \n

The notification trigger defaults to ALARM if you don't specify this\n parameter.

" + "smithy.api#documentation": "

Sets how this alarm will handle missing data points.

\n

An alarm can treat missing data in the following ways:

\n \n

If treatMissingData is not specified, the default behavior of\n missing is used.

" } }, "threshold": { @@ -13145,10 +13144,17 @@ "smithy.api#required": {} } }, - "notificationEnabled": { - "target": "com.amazonaws.lightsail#boolean", + "notificationTriggers": { + "target": "com.amazonaws.lightsail#NotificationTriggerList", "traits": { - "smithy.api#documentation": "

Indicates whether the alarm is enabled.

\n

Notifications are enabled by default if you don't specify this parameter.

" + "smithy.api#documentation": "

The alarm states that trigger a notification.

\n

An alarm has the following possible states:

\n \n

When you specify a notification trigger, the ALARM state must be specified.\n The INSUFFICIENT_DATA and OK states can be specified in addition to\n the ALARM state.

\n \n

The notification trigger defaults to ALARM if you don't specify this\n parameter.

" + } + }, + "monitoredResourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource that will be monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

", + "smithy.api#required": {} } }, "evaluationPeriods": { @@ -13158,6 +13164,19 @@ "smithy.api#required": {} } }, + "comparisonOperator": { + "target": "com.amazonaws.lightsail#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic to the threshold.\n The specified statistic value is used as the first operand.

", + "smithy.api#required": {} + } + }, + "notificationEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the alarm is enabled.

\n

Notifications are enabled by default if you don't specify this parameter.

" + } + }, "alarmName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -13177,25 +13196,6 @@ "smithy.api#documentation": "

The name of the metric to associate with the alarm.

\n

You can configure up to two alarms per metric.

\n

The following metrics are available for each resource type:

\n \n

For more information about these metrics, see Metrics available in Lightsail.

", "smithy.api#required": {} } - }, - "comparisonOperator": { - "target": "com.amazonaws.lightsail#ComparisonOperator", - "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic to the threshold.\n The specified statistic value is used as the first operand.

", - "smithy.api#required": {} - } - }, - "datapointsToAlarm": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of data points that must be not within the specified threshold to trigger the\n alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm)\n is the M.

" - } - }, - "treatMissingData": { - "target": "com.amazonaws.lightsail#TreatMissingData", - "traits": { - "smithy.api#documentation": "

Sets how this alarm will handle missing data points.

\n

An alarm can treat missing data in the following ways:

\n \n

If treatMissingData is not specified, the default behavior of\n missing is used.

" - } } } }, @@ -13283,17 +13283,17 @@ "com.amazonaws.lightsail#QueryStringObject": { "type": "structure", "members": { - "queryStringsAllowList": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The specific query strings that the distribution forwards to the origin.

\n\n

Your distribution will cache content based on the specified query strings.

\n\n

If the option parameter is true, then your distribution forwards all query\n strings, regardless of what you specify using the queryStringsAllowList\n parameter.

" - } - }, "option": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the distribution forwards and caches based on query strings.

" } + }, + "queryStringsAllowList": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The specific query strings that the distribution forwards to the origin.

\n\n

Your distribution will cache content based on the specified query strings.

\n\n

If the option parameter is true, then your distribution forwards all query\n strings, regardless of what you specify using the queryStringsAllowList\n parameter.

" + } } }, "traits": { @@ -13448,12 +13448,6 @@ "com.amazonaws.lightsail#Region": { "type": "structure", "members": { - "continentCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The continent code (e.g., NA, meaning North America).

" - } - }, "displayName": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -13466,16 +13460,16 @@ "smithy.api#documentation": "

The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).

" } }, - "name": { - "target": "com.amazonaws.lightsail#RegionName", + "continentCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The region name (e.g., us-east-2).

" + "smithy.api#documentation": "

The continent code (e.g., NA, meaning North America).

" } }, - "description": { - "target": "com.amazonaws.lightsail#string", + "name": { + "target": "com.amazonaws.lightsail#RegionName", "traits": { - "smithy.api#documentation": "

The description of the AWS Region (e.g., This region is recommended to serve users\n in the eastern United States and eastern Canada).

" + "smithy.api#documentation": "

The region name (e.g., us-east-2).

" } }, "availabilityZones": { @@ -13483,6 +13477,12 @@ "traits": { "smithy.api#documentation": "

The Availability Zones. Follows the format us-east-2a\n (case-sensitive).

" } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the AWS Region (e.g., This region is recommended to serve users\n in the eastern United States and eastern Canada).

" + } } }, "traits": { @@ -13561,160 +13561,160 @@ "com.amazonaws.lightsail#RelationalDatabase": { "type": "structure", "members": { - "engine": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "secondaryAvailabilityZone": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The database software (for example, MySQL).

" + "smithy.api#documentation": "

Describes the secondary Availability Zone of a high availability database.

\n

The secondary database is used for failover support of a high availability\n database.

" } }, - "backupRetentionEnabled": { - "target": "com.amazonaws.lightsail#boolean", + "pendingModifiedValues": { + "target": "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled for the\n database.

" + "smithy.api#documentation": "

Describes pending database value modifications.

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The timestamp when the database was created. Formatted in Unix time.

" } }, - "engineVersion": { + "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The database engine version (for example, 5.7.23).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" } }, - "preferredBackupWindow": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "latestRestorableTime": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for the database (for\n example, 16:00-16:30).

" + "smithy.api#documentation": "

The latest point in time to which the database can be restored. Formatted in Unix\n time.

" } }, - "masterUsername": { + "preferredMaintenanceWindow": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The master user name of the database.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on the database.

\n

In the format ddd:hh24:mi-ddd:hh24:mi. For example,\n Tue:17:00-Tue:17:30.

" } }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" + "smithy.api#documentation": "

The unique name of the database resource in Lightsail.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "state": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The timestamp when the database was created. Formatted in Unix time.

" + "smithy.api#documentation": "

Describes the current state of the database.

" } }, - "pendingMaintenanceActions": { - "target": "com.amazonaws.lightsail#PendingMaintenanceActionList", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

Describes the pending maintenance actions for the database.

" + "smithy.api#documentation": "

The Lightsail resource type for the database (for example,\n RelationalDatabase).

" } }, - "masterDatabaseName": { - "target": "com.amazonaws.lightsail#string", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The name of the master database created when the Lightsail database resource is\n created.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "secondaryAvailabilityZone": { - "target": "com.amazonaws.lightsail#string", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

Describes the secondary Availability Zone of a high availability database.

\n

The secondary database is used for failover support of a high availability\n database.

" + "smithy.api#documentation": "

The Region name and Availability Zone where the database is located.

" } }, - "caCertificateIdentifier": { - "target": "com.amazonaws.lightsail#string", + "relationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The certificate associated with the database.

" + "smithy.api#documentation": "

The blueprint ID for the database. A blueprint describes the major engine version of a\n database.

" } }, - "hardware": { - "target": "com.amazonaws.lightsail#RelationalDatabaseHardware", + "masterUsername": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

Describes the hardware of the database.

" + "smithy.api#documentation": "

The master user name of the database.

" } }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", + "engineVersion": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database is publicly accessible.

" + "smithy.api#documentation": "

The database engine version (for example, 5.7.23).

" } }, - "latestRestorableTime": { - "target": "com.amazonaws.lightsail#IsoDate", + "masterDatabaseName": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The latest point in time to which the database can be restored. Formatted in Unix\n time.

" + "smithy.api#documentation": "

The name of the master database created when the Lightsail database resource is\n created.

" } }, - "parameterApplyStatus": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "supportCode": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The status of parameter updates for the database.

" + "smithy.api#documentation": "

The support code for the database. Include this code in your email to support when you\n have questions about a database in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, - "state": { + "engine": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

Describes the current state of the database.

" + "smithy.api#documentation": "

The database software (for example, MySQL).

" } }, - "relationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The blueprint ID for the database. A blueprint describes the major engine version of a\n database.

" + "smithy.api#documentation": "

A Boolean value indicating whether the database is publicly accessible.

" } }, - "pendingModifiedValues": { - "target": "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues", + "backupRetentionEnabled": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

Describes pending database value modifications.

" + "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled for the\n database.

" } }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "hardware": { + "target": "com.amazonaws.lightsail#RelationalDatabaseHardware", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on the database.

\n

In the format ddd:hh24:mi-ddd:hh24:mi. For example,\n Tue:17:00-Tue:17:30.

" + "smithy.api#documentation": "

Describes the hardware of the database.

" } }, - "masterEndpoint": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEndpoint", + "pendingMaintenanceActions": { + "target": "com.amazonaws.lightsail#PendingMaintenanceActionList", "traits": { - "smithy.api#documentation": "

The master endpoint for the database.

" + "smithy.api#documentation": "

Describes the pending maintenance actions for the database.

" } }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "caCertificateIdentifier": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The bundle ID for the database. A bundle describes the performance specifications for your\n database.

" + "smithy.api#documentation": "

The certificate associated with the database.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "parameterApplyStatus": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The support code for the database. Include this code in your email to support when you\n have questions about a database in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + "smithy.api#documentation": "

The status of parameter updates for the database.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "masterEndpoint": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEndpoint", "traits": { - "smithy.api#documentation": "

The Lightsail resource type for the database (for example,\n RelationalDatabase).

" + "smithy.api#documentation": "

The master endpoint for the database.

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "preferredBackupWindow": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Region name and Availability Zone where the database is located.

" + "smithy.api#documentation": "

The daily time range during which automated backups are created for the database (for\n example, 16:00-16:30).

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The unique name of the database resource in Lightsail.

" + "smithy.api#documentation": "

The bundle ID for the database. A bundle describes the performance specifications for your\n database.

" } } }, @@ -13725,6 +13725,18 @@ "com.amazonaws.lightsail#RelationalDatabaseBlueprint": { "type": "structure", "members": { + "engineDescription": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the database engine for the database blueprint.

" + } + }, + "blueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID for the database blueprint.

" + } + }, "engineVersion": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -13748,18 +13760,6 @@ "traits": { "smithy.api#documentation": "

The database software of the database blueprint (for example, MySQL).

" } - }, - "blueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID for the database blueprint.

" - } - }, - "engineDescription": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the database engine for the database blueprint.

" - } } }, "traits": { @@ -13775,22 +13775,22 @@ "com.amazonaws.lightsail#RelationalDatabaseBundle": { "type": "structure", "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#string", + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", "traits": { - "smithy.api#documentation": "

The ID for the database bundle.

" + "smithy.api#documentation": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

" } }, - "name": { - "target": "com.amazonaws.lightsail#string", + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The name for the database bundle.

" + "smithy.api#documentation": "

The number of virtual CPUs (vCPUs) for the database bundle.

" } }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is active.

" + "smithy.api#documentation": "

The data transfer rate per month in GB for the database bundle.

" } }, "diskSizeInGb": { @@ -13799,34 +13799,34 @@ "smithy.api#documentation": "

The size of the disk for the database bundle.

" } }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The data transfer rate per month in GB for the database bundle.

" - } - }, "isEncrypted": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is encrypted.

" } }, - "price": { - "target": "com.amazonaws.lightsail#float", + "name": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The cost of the database bundle in US currency.

" + "smithy.api#documentation": "

The name for the database bundle.

" } }, - "ramSizeInGb": { + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID for the database bundle.

" + } + }, + "price": { "target": "com.amazonaws.lightsail#float", "traits": { - "smithy.api#documentation": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

" + "smithy.api#documentation": "

The cost of the database bundle in US currency.

" } }, - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", + "isActive": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The number of virtual CPUs (vCPUs) for the database bundle.

" + "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is active.

" } } }, @@ -13843,17 +13843,17 @@ "com.amazonaws.lightsail#RelationalDatabaseEndpoint": { "type": "structure", "members": { - "port": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

Specifies the port that the database is listening on.

" - } - }, "address": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

Specifies the DNS address of the database.

" } + }, + "port": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

Specifies the port that the database is listening on.

" + } } }, "traits": { @@ -13874,18 +13874,6 @@ "com.amazonaws.lightsail#RelationalDatabaseEvent": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database event was created.

" - } - }, - "resource": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The database that the database event relates to.

" - } - }, "eventCategories": { "target": "com.amazonaws.lightsail#StringList", "traits": { @@ -13897,6 +13885,18 @@ "traits": { "smithy.api#documentation": "

The message of the database event.

" } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database event was created.

" + } + }, + "resource": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The database that the database event relates to.

" + } } }, "traits": { @@ -13912,18 +13912,18 @@ "com.amazonaws.lightsail#RelationalDatabaseHardware": { "type": "structure", "members": { - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM in GB for the database.

" - } - }, "cpuCount": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of vCPUs for the database.

" } }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM in GB for the database.

" + } + }, "diskSizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { @@ -13975,22 +13975,22 @@ "com.amazonaws.lightsail#RelationalDatabaseParameter": { "type": "structure", "members": { - "parameterName": { + "allowedValues": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Specifies the name of the parameter.

" + "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" } }, - "description": { - "target": "com.amazonaws.lightsail#string", + "isModifiable": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

Provides a description of the parameter.

" + "smithy.api#documentation": "

A Boolean value indicating whether the parameter can be modified.

" } }, - "dataType": { + "parameterValue": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" + "smithy.api#documentation": "

Specifies the value of the parameter.

" } }, "applyMethod": { @@ -13999,28 +13999,28 @@ "smithy.api#documentation": "

Indicates when parameter updates are applied.

\n

Can be immediate or pending-reboot.

" } }, - "allowedValues": { + "applyType": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" + "smithy.api#documentation": "

Specifies the engine-specific parameter type.

" } }, - "isModifiable": { - "target": "com.amazonaws.lightsail#boolean", + "description": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the parameter can be modified.

" + "smithy.api#documentation": "

Provides a description of the parameter.

" } }, - "applyType": { + "parameterName": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Specifies the engine-specific parameter type.

" + "smithy.api#documentation": "

Specifies the name of the parameter.

" } }, - "parameterValue": { + "dataType": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" + "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" } } }, @@ -14056,94 +14056,94 @@ "com.amazonaws.lightsail#RelationalDatabaseSnapshot": { "type": "structure", "members": { - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The size of the disk in GB (for example, 32) for the database\n snapshot.

" + "smithy.api#documentation": "

The timestamp when the database snapshot was created.

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The Region name and Availability Zone where the database snapshot is located.

" + "smithy.api#documentation": "

The Lightsail resource type.

" } }, - "fromRelationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", + "name": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The bundle ID of the database from which the database snapshot was created.

" + "smithy.api#documentation": "

The name of the database snapshot.

" } }, - "engineVersion": { + "engine": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The database engine version for the database snapshot (for example,\n 5.7.23).

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database snapshot was created.

" + "smithy.api#documentation": "

The software of the database snapshot (for example, MySQL)

" } }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", + "fromRelationalDatabaseArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database from which the database snapshot was\n created.

" } }, - "fromRelationalDatabaseBlueprintId": { + "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The blueprint ID of the database from which the database snapshot was created. A blueprint\n describes the major engine version of a database.

" + "smithy.api#documentation": "

The support code for the database snapshot. Include this code in your email to support\n when you have questions about a database snapshot in Lightsail. This code enables our\n support team to look up your Lightsail information more easily.

" } }, - "fromRelationalDatabaseName": { + "state": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the source database from which the database snapshot was created.

" + "smithy.api#documentation": "

The state of the database snapshot.

" } }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", "traits": { - "smithy.api#documentation": "

The name of the database snapshot.

" + "smithy.api#documentation": "

The size of the disk in GB (for example, 32) for the database\n snapshot.

" } }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", + "fromRelationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The Lightsail resource type.

" + "smithy.api#documentation": "

The bundle ID of the database from which the database snapshot was created.

" } }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", + "fromRelationalDatabaseName": { + "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The support code for the database snapshot. Include this code in your email to support\n when you have questions about a database snapshot in Lightsail. This code enables our\n support team to look up your Lightsail information more easily.

" + "smithy.api#documentation": "

The name of the source database from which the database snapshot was created.

" } }, - "arn": { + "engineVersion": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database snapshot.

" + "smithy.api#documentation": "

The database engine version for the database snapshot (for example,\n 5.7.23).

" } }, - "state": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "tags": { + "target": "com.amazonaws.lightsail#TagList", "traits": { - "smithy.api#documentation": "

The state of the database snapshot.

" + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Lightsail\n Dev Guide.

" } }, - "engine": { + "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "

The software of the database snapshot (for example, MySQL)

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database snapshot.

" } }, - "fromRelationalDatabaseArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database from which the database snapshot was\n created.

" + "smithy.api#documentation": "

The Region name and Availability Zone where the database snapshot is located.

" + } + }, + "fromRelationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The blueprint ID of the database from which the database snapshot was created. A blueprint\n describes the major engine version of a database.

" } } }, @@ -14249,28 +14249,28 @@ "com.amazonaws.lightsail#RenewalSummary": { "type": "structure", "members": { - "updatedAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "renewalStatusReason": { + "target": "com.amazonaws.lightsail#RenewalStatusReason", "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was last updated.

" + "smithy.api#documentation": "

The reason for the renewal status of the certificate.

" } }, - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#DomainValidationRecordList", + "renewalStatus": { + "target": "com.amazonaws.lightsail#RenewalStatus", "traits": { - "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" + "smithy.api#documentation": "

The renewal status of the certificate.

\n\n

The following renewal status are possible:

\n\n " } }, - "renewalStatus": { - "target": "com.amazonaws.lightsail#RenewalStatus", + "updatedAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The renewal status of the certificate.

\n\n

The following renewal status are possible:

\n\n " + "smithy.api#documentation": "

The timestamp when the certificate was last updated.

" } }, - "renewalStatusReason": { - "target": "com.amazonaws.lightsail#RenewalStatusReason", + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#DomainValidationRecordList", "traits": { - "smithy.api#documentation": "

The reason for the renewal status of the certificate.

" + "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" } } }, @@ -14332,10 +14332,10 @@ "com.amazonaws.lightsail#ResetDistributionCacheResult": { "type": "structure", "members": { - "createTime": { - "target": "com.amazonaws.lightsail#IsoDate", + "status": { + "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time\n format.

" + "smithy.api#documentation": "

The status of the reset cache request.

" } }, "operation": { @@ -14344,10 +14344,10 @@ "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } }, - "status": { - "target": "com.amazonaws.lightsail#string", + "createTime": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The status of the reset cache request.

" + "smithy.api#documentation": "

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time\n format.

" } } } @@ -14361,17 +14361,17 @@ "com.amazonaws.lightsail#ResourceLocation": { "type": "structure", "members": { - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" - } - }, "regionName": { "target": "com.amazonaws.lightsail#RegionName", "traits": { "smithy.api#documentation": "

The AWS Region name.

" } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" + } } }, "traits": { @@ -14399,16 +14399,16 @@ "smithy.api#documentation": "

The name of the record.

" } }, - "value": { + "type": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The value for the DNS record.

" + "smithy.api#documentation": "

The DNS record type.

" } }, - "type": { + "value": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The DNS record type.

" + "smithy.api#documentation": "

The value for the DNS record.

" } } }, @@ -14570,16 +14570,16 @@ "com.amazonaws.lightsail#ServiceException": { "type": "structure", "members": { - "message": { + "tip": { "target": "com.amazonaws.lightsail#string" }, - "docs": { + "message": { "target": "com.amazonaws.lightsail#string" }, - "tip": { + "code": { "target": "com.amazonaws.lightsail#string" }, - "code": { + "docs": { "target": "com.amazonaws.lightsail#string" } }, @@ -14718,22 +14718,22 @@ "com.amazonaws.lightsail#StaticIp": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

" + "smithy.api#documentation": "

The resource type (usually StaticIp).

" } }, - "ipAddress": { - "target": "com.amazonaws.lightsail#IpAddress", + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "

The static IP address.

" + "smithy.api#documentation": "

The timestamp when the static IP was created (e.g., 1479735304.222).

" } }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the static IP is attached.

" + "smithy.api#documentation": "

The region and Availability Zone where the static IP was created.

" } }, "attachedTo": { @@ -14742,16 +14742,22 @@ "smithy.api#documentation": "

The instance where the static IP is attached (e.g.,\n Amazon_Linux-1GB-Ohio-1).

" } }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", + "ipAddress": { + "target": "com.amazonaws.lightsail#IpAddress", "traits": { - "smithy.api#documentation": "

The region and Availability Zone where the static IP was created.

" + "smithy.api#documentation": "

The static IP address.

" } }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

The timestamp when the static IP was created (e.g., 1479735304.222).

" + "smithy.api#documentation": "

A Boolean value indicating whether the static IP is attached.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

" } }, "arn": { @@ -14765,12 +14771,6 @@ "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (usually StaticIp).

" - } } }, "traits": { @@ -14945,17 +14945,17 @@ "com.amazonaws.lightsail#Tag": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.lightsail#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" - } - }, "key": { "target": "com.amazonaws.lightsail#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" } + }, + "value": { + "target": "com.amazonaws.lightsail#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" + } } }, "traits": { @@ -15020,12 +15020,6 @@ "com.amazonaws.lightsail#TagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.lightsail#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" - } - }, "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { @@ -15039,6 +15033,12 @@ "smithy.api#documentation": "

The tag key and optional value.

", "smithy.api#required": {} } + }, + "resourceArn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" + } } } }, @@ -15096,17 +15096,17 @@ "com.amazonaws.lightsail#TestAlarmRequest": { "type": "structure", "members": { - "state": { - "target": "com.amazonaws.lightsail#AlarmState", + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n ", + "smithy.api#documentation": "

The name of the alarm to test.

", "smithy.api#required": {} } }, - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", + "state": { + "target": "com.amazonaws.lightsail#AlarmState", "traits": { - "smithy.api#documentation": "

The name of the alarm to test.

", + "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n ", "smithy.api#required": {} } } @@ -15155,16 +15155,16 @@ "com.amazonaws.lightsail#UnauthenticatedException": { "type": "structure", "members": { - "tip": { + "docs": { "target": "com.amazonaws.lightsail#string" }, - "code": { + "message": { "target": "com.amazonaws.lightsail#string" }, - "docs": { + "tip": { "target": "com.amazonaws.lightsail#string" }, - "message": { + "code": { "target": "com.amazonaws.lightsail#string" } }, @@ -15272,17 +15272,17 @@ "com.amazonaws.lightsail#UntagResourceRequest": { "type": "structure", "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", + "tagKeys": { + "target": "com.amazonaws.lightsail#TagKeyList", "traits": { - "smithy.api#documentation": "

The name of the resource from which you are removing a tag.

", + "smithy.api#documentation": "

The tag keys to delete from the specified resource.

", "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.lightsail#TagKeyList", + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The tag keys to delete from the specified resource.

", + "smithy.api#documentation": "

The name of the resource from which you are removing a tag.

", "smithy.api#required": {} } }, @@ -15382,17 +15382,17 @@ "com.amazonaws.lightsail#UpdateDistributionBundleRequest": { "type": "structure", "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID of the new bundle to apply to your distribution.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

" - } - }, "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution for which to update the bundle.

\n\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID of the new bundle to apply to your distribution.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

" + } } } }, @@ -15407,22 +15407,17 @@ "com.amazonaws.lightsail#UpdateDistributionRequest": { "type": "structure", "members": { - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

" - } - }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", + "origin": { + "target": "com.amazonaws.lightsail#InputOrigin", "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

\n \n

The cacheBehaviorSettings specified in your\n UpdateDistributionRequest will replace your distribution's existing\n settings.

\n " + "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance or load balancer.

\n\n

The distribution pulls, caches, and serves content from the origin.

" } }, - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" + "smithy.api#documentation": "

The name of the distribution to update.

\n\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} } }, "isEnabled": { @@ -15431,17 +15426,22 @@ "smithy.api#documentation": "

Indicates whether to enable the distribution.

" } }, - "origin": { - "target": "com.amazonaws.lightsail#InputOrigin", + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", "traits": { - "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance or load balancer.

\n\n

The distribution pulls, caches, and serves content from the origin.

" + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" } }, - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", "traits": { - "smithy.api#documentation": "

The name of the distribution to update.

\n\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

" + } + }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

\n \n

The cacheBehaviorSettings specified in your\n UpdateDistributionRequest will replace your distribution's existing\n settings.

\n " } } } @@ -15500,17 +15500,17 @@ "com.amazonaws.lightsail#UpdateDomainEntryRequest": { "type": "structure", "members": { - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry.

", + "smithy.api#documentation": "

The name of the domain recordset to update.

", "smithy.api#required": {} } }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", "traits": { - "smithy.api#documentation": "

The name of the domain recordset to update.

", + "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry.

", "smithy.api#required": {} } } @@ -15717,6 +15717,18 @@ "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest": { "type": "structure", "members": { + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " + } + }, + "applyImmediately": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, applies changes immediately. When false, applies\n changes during the preferred maintenance window. Some changes may cause an outage.

\n

Default: false\n

" + } + }, "preferredBackupWindow": { "target": "com.amazonaws.lightsail#string", "traits": { @@ -15730,34 +15742,34 @@ "smithy.api#required": {} } }, - "caCertificateIdentifier": { - "target": "com.amazonaws.lightsail#string", + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" + "smithy.api#documentation": "

Specifies the accessibility options for your database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" } }, - "rotateMasterUserPassword": { + "enableBackupRetention": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

When true, the master user password is changed to a new strong password\n generated by Lightsail.

\n

Use the get relational database master user password operation to get the new\n password.

" + "smithy.api#documentation": "

When true, enables automated backup retention for your database.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" } }, - "enableBackupRetention": { + "rotateMasterUserPassword": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

When true, enables automated backup retention for your database.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" + "smithy.api#documentation": "

When true, the master user password is changed to a new strong password\n generated by Lightsail.

\n

Use the get relational database master user password operation to get the new\n password.

" } }, - "applyImmediately": { + "disableBackupRetention": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

When true, applies changes immediately. When false, applies\n changes during the preferred maintenance window. Some changes may cause an outage.

\n

Default: false\n

" + "smithy.api#documentation": "

When true, disables automated backup retention for your database.

\n

Disabling backup retention deletes all automated database backups. Before disabling this,\n you may want to create a snapshot of your database using the create relational database\n snapshot operation.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" } }, - "preferredMaintenanceWindow": { + "caCertificateIdentifier": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " + "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" } }, "masterUserPassword": { @@ -15765,18 +15777,6 @@ "traits": { "smithy.api#documentation": "

The password for the master user of your database. The password can include any printable\n ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain 8 to 41 characters.

" } - }, - "disableBackupRetention": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, disables automated backup retention for your database.

\n

Disabling backup retention deletes all automated database backups. Before disabling this,\n you may want to create a snapshot of your database using the create relational database\n snapshot operation.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" - } } } }, diff --git a/codegen/sdk-codegen/aws-models/machine-learning.2014-12-12.json b/codegen/sdk-codegen/aws-models/machine-learning.2014-12-12.json index 4d344827bf93..75ed7db42d27 100644 --- a/codegen/sdk-codegen/aws-models/machine-learning.2014-12-12.json +++ b/codegen/sdk-codegen/aws-models/machine-learning.2014-12-12.json @@ -68,17 +68,17 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.machinelearning#TagList", + "ResourceId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.

", + "smithy.api#documentation": "

The ID of the ML object to tag. For example, exampleModelId.

", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.machinelearning#EntityId", + "Tags": { + "target": "com.amazonaws.machinelearning#TagList", "traits": { - "smithy.api#documentation": "

The ID of the ML object to tag. For example, exampleModelId.

", + "smithy.api#documentation": "

The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.

", "smithy.api#required": {} } } @@ -210,7 +210,7 @@ "sdkId": "Machine Learning", "arnNamespace": "machinelearning", "cloudFormationName": "MachineLearning", - "cloudTrailEventSource": "v20141212.eml.amazon.com" + "cloudTrailEventSource": "machinelearning.amazonaws.com" }, "aws.auth#sigv4": { "name": "machinelearning" @@ -233,52 +233,64 @@ "com.amazonaws.machinelearning#BatchPrediction": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.machinelearning#EntityStatus", + "InputDataLocationS3": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The status of the BatchPrediction. This element can have one of the following values:

\n " + "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" } }, - "TotalRecordCount": { - "target": "com.amazonaws.machinelearning#LongType" - }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "OutputUri": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

" } }, + "FinishedAt": { + "target": "com.amazonaws.machinelearning#EpochTime" + }, + "ComputeTime": { + "target": "com.amazonaws.machinelearning#LongType" + }, "Message": { "target": "com.amazonaws.machinelearning#Message", "traits": { "smithy.api#documentation": "

A description of the most recent details about processing the batch prediction request.

" } }, + "BatchPredictionId": { + "target": "com.amazonaws.machinelearning#EntityId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID \n in the request.\n

" + } + }, + "StartedAt": { + "target": "com.amazonaws.machinelearning#EpochTime" + }, "CreatedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { "smithy.api#documentation": "

The time that the BatchPrediction was created. The time is expressed in epoch time.

" } }, - "InvalidRecordCount": { - "target": "com.amazonaws.machinelearning#LongType" - }, - "OutputUri": { - "target": "com.amazonaws.machinelearning#S3Url", + "Status": { + "target": "com.amazonaws.machinelearning#EntityStatus", "traits": { - "smithy.api#documentation": "

The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

" + "smithy.api#documentation": "

The status of the BatchPrediction. This element can have one of the following values:

\n " } }, - "MLModelId": { + "TotalRecordCount": { + "target": "com.amazonaws.machinelearning#LongType" + }, + "BatchPredictionDataSourceId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the MLModel that generated predictions for the BatchPrediction request.

" + "smithy.api#documentation": "

The ID of the DataSource that points to the group of observations to predict.

" } }, - "BatchPredictionDataSourceId": { + "MLModelId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the DataSource that points to the group of observations to predict.

" + "smithy.api#documentation": "

The ID of the MLModel that generated predictions for the BatchPrediction request.

" } }, "Name": { @@ -287,31 +299,19 @@ "smithy.api#documentation": "

A user-supplied name or description of the BatchPrediction.

" } }, - "InputDataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", + "CreatedByIamUser": { + "target": "com.amazonaws.machinelearning#AwsUserArn", "traits": { - "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + "smithy.api#documentation": "

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" } }, - "ComputeTime": { + "InvalidRecordCount": { "target": "com.amazonaws.machinelearning#LongType" }, - "FinishedAt": { - "target": "com.amazonaws.machinelearning#EpochTime" - }, - "BatchPredictionId": { - "target": "com.amazonaws.machinelearning#EntityId", - "traits": { - "smithy.api#documentation": "

The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID \n in the request.\n

" - } - }, - "StartedAt": { - "target": "com.amazonaws.machinelearning#EpochTime" - }, - "CreatedByIamUser": { - "target": "com.amazonaws.machinelearning#AwsUserArn", + "LastUpdatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + "smithy.api#documentation": "

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

" } } }, @@ -412,19 +412,6 @@ "smithy.api#required": {} } }, - "OutputUri": { - "target": "com.amazonaws.machinelearning#S3Url", - "traits": { - "smithy.api#documentation": "

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

\n

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

", - "smithy.api#required": {} - } - }, - "BatchPredictionName": { - "target": "com.amazonaws.machinelearning#EntityName", - "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

" - } - }, "BatchPredictionDataSourceId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { @@ -438,6 +425,19 @@ "smithy.api#documentation": "

The ID of the MLModel that will generate predictions for the group of observations.

", "smithy.api#required": {} } + }, + "BatchPredictionName": { + "target": "com.amazonaws.machinelearning#EntityName", + "traits": { + "smithy.api#documentation": "

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

" + } + }, + "OutputUri": { + "target": "com.amazonaws.machinelearning#S3Url", + "traits": { + "smithy.api#documentation": "

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

\n

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

", + "smithy.api#required": {} + } } } }, @@ -488,19 +488,6 @@ "smithy.api#required": {} } }, - "ComputeStatistics": { - "target": "com.amazonaws.machinelearning#ComputeStatistics", - "traits": { - "smithy.api#documentation": "

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by \n a DataSource. Amazon ML uses the statistics internally during MLModel training.\n This parameter must be set to true if the DataSource needs to be used for MLModel training.\n

" - } - }, - "RoleARN": { - "target": "com.amazonaws.machinelearning#RoleARN", - "traits": { - "smithy.api#documentation": "

The role that Amazon ML assumes on behalf of the user to create and activate a data\n pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

\n

", - "smithy.api#required": {} - } - }, "RDSData": { "target": "com.amazonaws.machinelearning#RDSDataSpec", "traits": { @@ -513,6 +500,19 @@ "traits": { "smithy.api#documentation": "

A user-supplied name or description of the DataSource.

" } + }, + "RoleARN": { + "target": "com.amazonaws.machinelearning#RoleARN", + "traits": { + "smithy.api#documentation": "

The role that Amazon ML assumes on behalf of the user to create and activate a data\n pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

\n

", + "smithy.api#required": {} + } + }, + "ComputeStatistics": { + "target": "com.amazonaws.machinelearning#ComputeStatistics", + "traits": { + "smithy.api#documentation": "

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by \n a DataSource. Amazon ML uses the statistics internally during MLModel training.\n This parameter must be set to true if the DataSource needs to be used for MLModel training.\n

" + } } } }, @@ -563,18 +563,6 @@ "smithy.api#required": {} } }, - "ComputeStatistics": { - "target": "com.amazonaws.machinelearning#ComputeStatistics", - "traits": { - "smithy.api#documentation": "

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by \n a DataSource. Amazon ML uses the statistics internally during MLModel training.\n This parameter must be set to true if the DataSource needs to\n be used for MLModel training.

" - } - }, - "DataSourceName": { - "target": "com.amazonaws.machinelearning#EntityName", - "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the DataSource.

" - } - }, "DataSpec": { "target": "com.amazonaws.machinelearning#RedshiftDataSpec", "traits": { @@ -588,6 +576,18 @@ "smithy.api#documentation": "

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

\n \n ", "smithy.api#required": {} } + }, + "DataSourceName": { + "target": "com.amazonaws.machinelearning#EntityName", + "traits": { + "smithy.api#documentation": "

A user-supplied name or description of the DataSource.

" + } + }, + "ComputeStatistics": { + "target": "com.amazonaws.machinelearning#ComputeStatistics", + "traits": { + "smithy.api#documentation": "

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by \n a DataSource. Amazon ML uses the statistics internally during MLModel training.\n This parameter must be set to true if the DataSource needs to\n be used for MLModel training.

" + } } } }, @@ -644,18 +644,18 @@ "smithy.api#documentation": "

A user-supplied name or description of the DataSource.

" } }, - "ComputeStatistics": { - "target": "com.amazonaws.machinelearning#ComputeStatistics", - "traits": { - "smithy.api#documentation": "

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by \n a DataSource. Amazon ML uses the statistics internally during MLModel training.\n This parameter must be set to true if the DataSource needs to be used for MLModel training.

" - } - }, "DataSpec": { "target": "com.amazonaws.machinelearning#S3DataSpec", "traits": { "smithy.api#documentation": "

The data specification of a DataSource:

\n ", "smithy.api#required": {} } + }, + "ComputeStatistics": { + "target": "com.amazonaws.machinelearning#ComputeStatistics", + "traits": { + "smithy.api#documentation": "

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by \n a DataSource. Amazon ML uses the statistics internally during MLModel training.\n This parameter must be set to true if the DataSource needs to be used for MLModel training.

" + } } } }, @@ -699,13 +699,6 @@ "com.amazonaws.machinelearning#CreateEvaluationInput": { "type": "structure", "members": { - "EvaluationId": { - "target": "com.amazonaws.machinelearning#EntityId", - "traits": { - "smithy.api#documentation": "

A user-supplied ID that uniquely identifies the Evaluation.

", - "smithy.api#required": {} - } - }, "EvaluationDataSourceId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { @@ -713,10 +706,10 @@ "smithy.api#required": {} } }, - "MLModelId": { + "EvaluationId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the MLModel to evaluate.

\n

The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.

", + "smithy.api#documentation": "

A user-supplied ID that uniquely identifies the Evaluation.

", "smithy.api#required": {} } }, @@ -725,6 +718,13 @@ "traits": { "smithy.api#documentation": "

A user-supplied name or description of the Evaluation.

" } + }, + "MLModelId": { + "target": "com.amazonaws.machinelearning#EntityId", + "traits": { + "smithy.api#documentation": "

The ID of the MLModel to evaluate.

\n

The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.

", + "smithy.api#required": {} + } } } }, @@ -774,25 +774,13 @@ "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

" } }, - "TrainingDataSourceId": { + "MLModelId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The DataSource that points to the training data.

", + "smithy.api#documentation": "

A user-supplied ID that uniquely identifies the MLModel.

", "smithy.api#required": {} } }, - "Parameters": { - "target": "com.amazonaws.machinelearning#TrainingParameters", - "traits": { - "smithy.api#documentation": "

A list of the training parameters in the MLModel. The list is implemented as\n a map of key-value pairs.

\n

The following is the current set of training parameters:

\n " - } - }, - "MLModelName": { - "target": "com.amazonaws.machinelearning#EntityName", - "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the MLModel.

" - } - }, "MLModelType": { "target": "com.amazonaws.machinelearning#MLModelType", "traits": { @@ -800,16 +788,28 @@ "smithy.api#required": {} } }, + "Parameters": { + "target": "com.amazonaws.machinelearning#TrainingParameters", + "traits": { + "smithy.api#documentation": "

A list of the training parameters in the MLModel. The list is implemented as\n a map of key-value pairs.

\n

The following is the current set of training parameters:

\n " + } + }, "Recipe": { "target": "com.amazonaws.machinelearning#Recipe", "traits": { "smithy.api#documentation": "

The data recipe for creating the MLModel. You must specify either the recipe\n or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

" } }, - "MLModelId": { + "MLModelName": { + "target": "com.amazonaws.machinelearning#EntityName", + "traits": { + "smithy.api#documentation": "

A user-supplied name or description of the MLModel.

" + } + }, + "TrainingDataSourceId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

A user-supplied ID that uniquely identifies the MLModel.

", + "smithy.api#documentation": "

The DataSource that points to the training data.

", "smithy.api#required": {} } } @@ -900,95 +900,95 @@ "com.amazonaws.machinelearning#DataSource": { "type": "structure", "members": { - "DataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", + "CreatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

" + "smithy.api#documentation": "

The time that the DataSource was created. The time is expressed in epoch time.

" } }, - "NumberOfFiles": { - "target": "com.amazonaws.machinelearning#LongType", + "Status": { + "target": "com.amazonaws.machinelearning#EntityStatus", "traits": { - "smithy.api#documentation": "

The number of data files referenced by the DataSource.

" + "smithy.api#documentation": "

The current status of the DataSource. This element can have one of the following values:

\n " } }, - "RedshiftMetadata": { - "target": "com.amazonaws.machinelearning#RedshiftMetadata" + "RoleARN": { + "target": "com.amazonaws.machinelearning#RoleARN" }, - "DataRearrangement": { - "target": "com.amazonaws.machinelearning#DataRearrangement", + "LastUpdatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

A JSON string that represents the splitting and rearrangement requirement used when this DataSource\n was created.

" + "smithy.api#documentation": "

The time of the most recent edit to the \n BatchPrediction. The time is expressed in epoch time.

" } }, - "ComputeTime": { - "target": "com.amazonaws.machinelearning#LongType" + "CreatedByIamUser": { + "target": "com.amazonaws.machinelearning#AwsUserArn", + "traits": { + "smithy.api#documentation": "

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + } }, "FinishedAt": { "target": "com.amazonaws.machinelearning#EpochTime" }, - "ComputeStatistics": { - "target": "com.amazonaws.machinelearning#ComputeStatistics", - "traits": { - "smithy.api#documentation": "

\n The parameter is true if statistics need to be generated from the observation data.\n

" - } - }, - "DataSizeInBytes": { - "target": "com.amazonaws.machinelearning#LongType", - "traits": { - "smithy.api#documentation": "

The total number of observations contained in the data files that the DataSource references.

" - } - }, - "RDSMetadata": { - "target": "com.amazonaws.machinelearning#RDSMetadata" - }, "StartedAt": { "target": "com.amazonaws.machinelearning#EpochTime" }, - "Message": { - "target": "com.amazonaws.machinelearning#Message", - "traits": { - "smithy.api#documentation": "

A description of the most recent details about creating the DataSource.

" - } + "ComputeTime": { + "target": "com.amazonaws.machinelearning#LongType" }, - "Status": { - "target": "com.amazonaws.machinelearning#EntityStatus", + "NumberOfFiles": { + "target": "com.amazonaws.machinelearning#LongType", "traits": { - "smithy.api#documentation": "

The current status of the DataSource. This element can have one of the following values:

\n " + "smithy.api#documentation": "

The number of data files referenced by the DataSource.

" } }, - "RoleARN": { - "target": "com.amazonaws.machinelearning#RoleARN" - }, "DataSourceId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { "smithy.api#documentation": "

The ID that is assigned to the DataSource during creation.

" } }, + "DataSizeInBytes": { + "target": "com.amazonaws.machinelearning#LongType", + "traits": { + "smithy.api#documentation": "

The total number of observations contained in the data files that the DataSource references.

" + } + }, "Name": { "target": "com.amazonaws.machinelearning#EntityName", "traits": { "smithy.api#documentation": "

A user-supplied name or description of the DataSource.

" } }, - "CreatedByIamUser": { - "target": "com.amazonaws.machinelearning#AwsUserArn", + "ComputeStatistics": { + "target": "com.amazonaws.machinelearning#ComputeStatistics", "traits": { - "smithy.api#documentation": "

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + "smithy.api#documentation": "

\n The parameter is true if statistics need to be generated from the observation data.\n

" } }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "RDSMetadata": { + "target": "com.amazonaws.machinelearning#RDSMetadata" + }, + "Message": { + "target": "com.amazonaws.machinelearning#Message", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the \n BatchPrediction. The time is expressed in epoch time.

" + "smithy.api#documentation": "

A description of the most recent details about creating the DataSource.

" } }, - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "DataRearrangement": { + "target": "com.amazonaws.machinelearning#DataRearrangement", "traits": { - "smithy.api#documentation": "

The time that the DataSource was created. The time is expressed in epoch time.

" + "smithy.api#documentation": "

A JSON string that represents the splitting and rearrangement requirement used when this DataSource\n was created.

" + } + }, + "DataLocationS3": { + "target": "com.amazonaws.machinelearning#S3Url", + "traits": { + "smithy.api#documentation": "

The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

" } + }, + "RedshiftMetadata": { + "target": "com.amazonaws.machinelearning#RedshiftMetadata" } }, "traits": { @@ -1391,46 +1391,34 @@ "smithy.api#documentation": "

A two-value parameter that determines the sequence of the resulting list of MLModels.

\n \n

Results are sorted by FilterVariable.

" } }, - "NE": { - "target": "com.amazonaws.machinelearning#ComparatorValue", - "traits": { - "smithy.api#documentation": "

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

" - } - }, "Prefix": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { "smithy.api#documentation": "

A string that is found at the beginning of a variable, such as Name or Id.

\n

For example, a Batch Prediction operation could have the Name \n 2014-09-09-HolidayGiftMailer. To search for \n this BatchPrediction, select Name for the FilterVariable and any of the following strings for the \n Prefix:\n

\n \n " } }, - "Limit": { - "target": "com.amazonaws.machinelearning#PageLimit", - "traits": { - "smithy.api#documentation": "

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" - } - }, - "LE": { + "GT": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

" + "smithy.api#documentation": "

The greater than operator. The BatchPrediction results will \n have FilterVariable values that are greater than the value specified with GT.

" } }, - "LT": { + "GE": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The less than operator. The BatchPrediction results will \n have FilterVariable values that are less than the value specified with LT.

" + "smithy.api#documentation": "

The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.\n

" } }, - "NextToken": { - "target": "com.amazonaws.machinelearning#StringType", + "Limit": { + "target": "com.amazonaws.machinelearning#PageLimit", "traits": { - "smithy.api#documentation": "

An ID of the page in the paginated results.

" + "smithy.api#documentation": "

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" } }, - "GE": { + "EQ": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.\n

" + "smithy.api#documentation": "

The equal to operator. The BatchPrediction results will have \n FilterVariable values that exactly match the value specified with EQ.

" } }, "FilterVariable": { @@ -1439,16 +1427,28 @@ "smithy.api#documentation": "

Use one of the following variables to filter a list of BatchPrediction:

\n " } }, - "EQ": { + "LE": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The equal to operator. The BatchPrediction results will have \n FilterVariable values that exactly match the value specified with EQ.

" + "smithy.api#documentation": "

The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

" } }, - "GT": { + "NE": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The greater than operator. The BatchPrediction results will \n have FilterVariable values that are greater than the value specified with GT.

" + "smithy.api#documentation": "

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

" + } + }, + "LT": { + "target": "com.amazonaws.machinelearning#ComparatorValue", + "traits": { + "smithy.api#documentation": "

The less than operator. The BatchPrediction results will \n have FilterVariable values that are less than the value specified with LT.

" + } + }, + "NextToken": { + "target": "com.amazonaws.machinelearning#StringType", + "traits": { + "smithy.api#documentation": "

An ID of the page in the paginated results.

" } } } @@ -1456,17 +1456,17 @@ "com.amazonaws.machinelearning#DescribeBatchPredictionsOutput": { "type": "structure", "members": { - "Results": { - "target": "com.amazonaws.machinelearning#BatchPredictions", - "traits": { - "smithy.api#documentation": "

A list of BatchPrediction objects that meet the search criteria.\n

" - } - }, "NextToken": { "target": "com.amazonaws.machinelearning#StringType", "traits": { "smithy.api#documentation": "

The ID of the next page in the paginated results that indicates at least one more page follows.

" } + }, + "Results": { + "target": "com.amazonaws.machinelearning#BatchPredictions", + "traits": { + "smithy.api#documentation": "

A list of BatchPrediction objects that meet the search criteria.\n

" + } } }, "traits": { @@ -1502,16 +1502,16 @@ "com.amazonaws.machinelearning#DescribeDataSourcesInput": { "type": "structure", "members": { - "NE": { + "GT": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

" + "smithy.api#documentation": "

The greater than operator. The DataSource results will \n have FilterVariable values that are greater than the value specified with GT.

" } }, - "SortOrder": { - "target": "com.amazonaws.machinelearning#SortOrder", + "GE": { + "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

A two-value parameter that determines the sequence of the resulting list of DataSource.

\n \n

Results are sorted by FilterVariable.

" + "smithy.api#documentation": "

The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.\n

" } }, "LE": { @@ -1520,52 +1520,52 @@ "smithy.api#documentation": "

The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

" } }, - "LT": { - "target": "com.amazonaws.machinelearning#ComparatorValue", - "traits": { - "smithy.api#documentation": "

The less than operator. The DataSource results will \n have FilterVariable values that are less than the value specified with LT.

" - } - }, - "NextToken": { - "target": "com.amazonaws.machinelearning#StringType", - "traits": { - "smithy.api#documentation": "

The ID of the page in the paginated results.

" - } - }, "Limit": { "target": "com.amazonaws.machinelearning#PageLimit", "traits": { "smithy.api#documentation": "

The maximum number of DataSource to include in the result.

" } }, + "FilterVariable": { + "target": "com.amazonaws.machinelearning#DataSourceFilterVariable", + "traits": { + "smithy.api#documentation": "

Use one of the following variables to filter a list of DataSource:

\n " + } + }, "Prefix": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { "smithy.api#documentation": "

A string that is found at the beginning of a variable, such as Name or Id.

\n

For example, a DataSource could have the Name \n 2014-09-09-HolidayGiftMailer. To search for \n this DataSource, select Name for the FilterVariable and any of the following strings for the \n Prefix: \n

\n \n " } }, - "GT": { + "EQ": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The greater than operator. The DataSource results will \n have FilterVariable values that are greater than the value specified with GT.

" + "smithy.api#documentation": "

The equal to operator. The DataSource results will have \n FilterVariable values that exactly match the value specified with EQ.

" } }, - "FilterVariable": { - "target": "com.amazonaws.machinelearning#DataSourceFilterVariable", + "SortOrder": { + "target": "com.amazonaws.machinelearning#SortOrder", "traits": { - "smithy.api#documentation": "

Use one of the following variables to filter a list of DataSource:

\n " + "smithy.api#documentation": "

A two-value parameter that determines the sequence of the resulting list of DataSource.

\n \n

Results are sorted by FilterVariable.

" } }, - "EQ": { + "NE": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The equal to operator. The DataSource results will have \n FilterVariable values that exactly match the value specified with EQ.

" + "smithy.api#documentation": "

The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

" } }, - "GE": { + "LT": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.\n

" + "smithy.api#documentation": "

The less than operator. The DataSource results will \n have FilterVariable values that are less than the value specified with LT.

" + } + }, + "NextToken": { + "target": "com.amazonaws.machinelearning#StringType", + "traits": { + "smithy.api#documentation": "

The ID of the page in the paginated results.

" } } } @@ -1619,70 +1619,70 @@ "com.amazonaws.machinelearning#DescribeEvaluationsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.machinelearning#StringType", - "traits": { - "smithy.api#documentation": "

The ID of the page in the paginated results.

" - } - }, "GE": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { "smithy.api#documentation": "

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.\n

" } }, - "SortOrder": { - "target": "com.amazonaws.machinelearning#SortOrder", + "Prefix": { + "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

A two-value parameter that determines the sequence of the resulting list of Evaluation.

\n \n

Results are sorted by FilterVariable.

" + "smithy.api#documentation": "

A string that is found at the beginning of a variable, such as Name or Id.

\n

For example, an Evaluation could have the Name \n 2014-09-09-HolidayGiftMailer. To search for \n this Evaluation, select Name for the FilterVariable and any of the following strings for the \n Prefix: \n

\n \n " } }, - "GT": { + "LE": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The greater than operator. The Evaluation results will \n have FilterVariable values that are greater than the value specified with GT.

" + "smithy.api#documentation": "

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

" } }, - "FilterVariable": { - "target": "com.amazonaws.machinelearning#EvaluationFilterVariable", + "LT": { + "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

Use one of the following variable to filter a list of Evaluation objects:

\n " + "smithy.api#documentation": "

The less than operator. The Evaluation results will \n have FilterVariable values that are less than the value specified with LT.

" } }, - "Prefix": { + "NE": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

A string that is found at the beginning of a variable, such as Name or Id.

\n

For example, an Evaluation could have the Name \n 2014-09-09-HolidayGiftMailer. To search for \n this Evaluation, select Name for the FilterVariable and any of the following strings for the \n Prefix: \n

\n \n " + "smithy.api#documentation": "

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

" } }, - "EQ": { + "GT": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The equal to operator. The Evaluation results will have \n FilterVariable values that exactly match the value specified with EQ.

" + "smithy.api#documentation": "

The greater than operator. The Evaluation results will \n have FilterVariable values that are greater than the value specified with GT.

" } }, - "Limit": { - "target": "com.amazonaws.machinelearning#PageLimit", + "FilterVariable": { + "target": "com.amazonaws.machinelearning#EvaluationFilterVariable", "traits": { - "smithy.api#documentation": "

The maximum number of Evaluation to include in the result.

" + "smithy.api#documentation": "

Use one of the following variable to filter a list of Evaluation objects:

\n " } }, - "LE": { + "EQ": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

" + "smithy.api#documentation": "

The equal to operator. The Evaluation results will have \n FilterVariable values that exactly match the value specified with EQ.

" } }, - "LT": { - "target": "com.amazonaws.machinelearning#ComparatorValue", + "NextToken": { + "target": "com.amazonaws.machinelearning#StringType", "traits": { - "smithy.api#documentation": "

The less than operator. The Evaluation results will \n have FilterVariable values that are less than the value specified with LT.

" + "smithy.api#documentation": "

The ID of the page in the paginated results.

" } }, - "NE": { - "target": "com.amazonaws.machinelearning#ComparatorValue", + "SortOrder": { + "target": "com.amazonaws.machinelearning#SortOrder", "traits": { - "smithy.api#documentation": "

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

" + "smithy.api#documentation": "

A two-value parameter that determines the sequence of the resulting list of Evaluation.

\n \n

Results are sorted by FilterVariable.

" + } + }, + "Limit": { + "target": "com.amazonaws.machinelearning#PageLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of Evaluation to include in the result.

" } } } @@ -1742,16 +1742,22 @@ "smithy.api#documentation": "

The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.

" } }, + "NextToken": { + "target": "com.amazonaws.machinelearning#StringType", + "traits": { + "smithy.api#documentation": "

The ID of the page in the paginated results.

" + } + }, "LT": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { "smithy.api#documentation": "

The less than operator. The MLModel results will \n have FilterVariable values that are less than the value specified with LT.

" } }, - "Prefix": { - "target": "com.amazonaws.machinelearning#ComparatorValue", + "SortOrder": { + "target": "com.amazonaws.machinelearning#SortOrder", "traits": { - "smithy.api#documentation": "

A string that is found at the beginning of a variable, such as Name or Id.

\n

For example, an MLModel could have the Name \n 2014-09-09-HolidayGiftMailer. To search for \n this MLModel, select Name for the FilterVariable and any of the following strings for the \n Prefix: \n

\n \n " + "smithy.api#documentation": "

A two-value parameter that determines the sequence of the resulting list of MLModel.

\n \n

Results are sorted by FilterVariable.

" } }, "LE": { @@ -1760,22 +1766,16 @@ "smithy.api#documentation": "

The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.

" } }, - "SortOrder": { - "target": "com.amazonaws.machinelearning#SortOrder", + "Limit": { + "target": "com.amazonaws.machinelearning#PageLimit", "traits": { - "smithy.api#documentation": "

A two-value parameter that determines the sequence of the resulting list of MLModel.

\n \n

Results are sorted by FilterVariable.

" + "smithy.api#documentation": "

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" } }, - "NextToken": { - "target": "com.amazonaws.machinelearning#StringType", - "traits": { - "smithy.api#documentation": "

The ID of the page in the paginated results.

" - } - }, - "Limit": { - "target": "com.amazonaws.machinelearning#PageLimit", + "Prefix": { + "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { - "smithy.api#documentation": "

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" + "smithy.api#documentation": "

A string that is found at the beginning of a variable, such as Name or Id.

\n

For example, an MLModel could have the Name \n 2014-09-09-HolidayGiftMailer. To search for \n this MLModel, select Name for the FilterVariable and any of the following strings for the \n Prefix: \n

\n \n " } }, "EQ": { @@ -1784,12 +1784,6 @@ "smithy.api#documentation": "

The equal to operator. The MLModel results will have \n FilterVariable values that exactly match the value specified with EQ.

" } }, - "FilterVariable": { - "target": "com.amazonaws.machinelearning#MLModelFilterVariable", - "traits": { - "smithy.api#documentation": "

Use one of the following variables to filter a list of MLModel:

\n " - } - }, "GT": { "target": "com.amazonaws.machinelearning#ComparatorValue", "traits": { @@ -1801,6 +1795,12 @@ "traits": { "smithy.api#documentation": "

The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.\n

" } + }, + "FilterVariable": { + "target": "com.amazonaws.machinelearning#MLModelFilterVariable", + "traits": { + "smithy.api#documentation": "

Use one of the following variables to filter a list of MLModel:

\n " + } } } }, @@ -1875,17 +1875,17 @@ "smithy.api#documentation": "

A list of tags associated with the ML object.

" } }, - "ResourceType": { - "target": "com.amazonaws.machinelearning#TaggableResourceType", - "traits": { - "smithy.api#documentation": "

The type of the tagged ML object.

" - } - }, "ResourceId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { "smithy.api#documentation": "

The ID of the tagged ML object.

" } + }, + "ResourceType": { + "target": "com.amazonaws.machinelearning#TaggableResourceType", + "traits": { + "smithy.api#documentation": "

The type of the tagged ML object.

" + } } }, "traits": { @@ -2049,51 +2049,57 @@ "com.amazonaws.machinelearning#Evaluation": { "type": "structure", "members": { - "PerformanceMetrics": { - "target": "com.amazonaws.machinelearning#PerformanceMetrics", + "Name": { + "target": "com.amazonaws.machinelearning#EntityName", "traits": { - "smithy.api#documentation": "

Measurements of how well the MLModel performed, using observations referenced\n by the DataSource. One of the following metrics is returned, based on the type of the MLModel: \n

\n \n

\n For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.\n

" + "smithy.api#documentation": "

A user-supplied name or description of the Evaluation.

" } }, - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "EvaluationDataSourceId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The time that the Evaluation was created. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The ID of the DataSource that is used to evaluate the MLModel.

" } }, - "MLModelId": { - "target": "com.amazonaws.machinelearning#EntityId", + "StartedAt": { + "target": "com.amazonaws.machinelearning#EpochTime" + }, + "CreatedByIamUser": { + "target": "com.amazonaws.machinelearning#AwsUserArn", "traits": { - "smithy.api#documentation": "

The ID of the MLModel that is the focus of the evaluation.

" + "smithy.api#documentation": "

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" } }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "ComputeTime": { + "target": "com.amazonaws.machinelearning#LongType" + }, + "FinishedAt": { + "target": "com.amazonaws.machinelearning#EpochTime" + }, + "InputDataLocationS3": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

" } }, - "EvaluationDataSourceId": { + "MLModelId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the DataSource that is used to evaluate the MLModel.

" + "smithy.api#documentation": "

The ID of the MLModel that is the focus of the evaluation.

" } }, - "CreatedByIamUser": { - "target": "com.amazonaws.machinelearning#AwsUserArn", + "Status": { + "target": "com.amazonaws.machinelearning#EntityStatus", "traits": { - "smithy.api#documentation": "

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + "smithy.api#documentation": "

The status of the evaluation. This element can have one of the following values:

\n " } }, - "Name": { - "target": "com.amazonaws.machinelearning#EntityName", + "PerformanceMetrics": { + "target": "com.amazonaws.machinelearning#PerformanceMetrics", "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the Evaluation.

" + "smithy.api#documentation": "

Measurements of how well the MLModel performed, using observations referenced\n by the DataSource. One of the following metrics is returned, based on the type of the MLModel: \n

\n \n

\n For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.\n

" } }, - "ComputeTime": { - "target": "com.amazonaws.machinelearning#LongType" - }, "Message": { "target": "com.amazonaws.machinelearning#Message", "traits": { @@ -2106,23 +2112,17 @@ "smithy.api#documentation": "

The ID that is assigned to the Evaluation at creation.

" } }, - "Status": { - "target": "com.amazonaws.machinelearning#EntityStatus", + "CreatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The status of the evaluation. This element can have one of the following values:

\n " + "smithy.api#documentation": "

The time that the Evaluation was created. The time is expressed in epoch time.

" } }, - "InputDataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", + "LastUpdatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

" + "smithy.api#documentation": "

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" } - }, - "StartedAt": { - "target": "com.amazonaws.machinelearning#EpochTime" - }, - "FinishedAt": { - "target": "com.amazonaws.machinelearning#EpochTime" } }, "traits": { @@ -2213,28 +2213,40 @@ "com.amazonaws.machinelearning#GetBatchPredictionOutput": { "type": "structure", "members": { - "MLModelId": { - "target": "com.amazonaws.machinelearning#EntityId", + "LogUri": { + "target": "com.amazonaws.machinelearning#PresignedS3Url", "traits": { - "smithy.api#documentation": "

The ID of the MLModel that generated predictions for the BatchPrediction request.

" + "smithy.api#documentation": "

A link to the file that contains logs of the CreateBatchPrediction operation.

" } }, - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "ComputeTime": { + "target": "com.amazonaws.machinelearning#LongType", "traits": { - "smithy.api#documentation": "

The time when the BatchPrediction was created. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

" } }, - "Status": { - "target": "com.amazonaws.machinelearning#EntityStatus", + "OutputUri": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The status of the BatchPrediction, which can be one of the following values:

\n " + "smithy.api#documentation": "

The location of an Amazon S3 bucket or directory to receive the operation results.

" } }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "CreatedByIamUser": { + "target": "com.amazonaws.machinelearning#AwsUserArn", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + } + }, + "BatchPredictionDataSourceId": { + "target": "com.amazonaws.machinelearning#EntityId", + "traits": { + "smithy.api#documentation": "

The ID of the DataSource that was used to create the BatchPrediction.\n

" + } + }, + "Name": { + "target": "com.amazonaws.machinelearning#EntityName", + "traits": { + "smithy.api#documentation": "

A user-supplied name or description of the BatchPrediction.

" } }, "TotalRecordCount": { @@ -2249,70 +2261,58 @@ "smithy.api#documentation": "

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

" } }, - "StartedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", - "traits": { - "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

" - } - }, - "BatchPredictionId": { + "MLModelId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID \n in the request.

" - } - }, - "ComputeTime": { - "target": "com.amazonaws.machinelearning#LongType", - "traits": { - "smithy.api#documentation": "

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

" + "smithy.api#documentation": "

The ID of the MLModel that generated predictions for the BatchPrediction request.

" } }, - "CreatedByIamUser": { - "target": "com.amazonaws.machinelearning#AwsUserArn", + "LastUpdatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + "smithy.api#documentation": "

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

" } }, - "FinishedAt": { + "CreatedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

" + "smithy.api#documentation": "

The time when the BatchPrediction was created. The time is expressed in epoch time.

" } }, - "InputDataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", + "Message": { + "target": "com.amazonaws.machinelearning#Message", "traits": { - "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + "smithy.api#documentation": "

A description of the most recent details about processing the batch prediction request.

" } }, - "LogUri": { - "target": "com.amazonaws.machinelearning#PresignedS3Url", + "Status": { + "target": "com.amazonaws.machinelearning#EntityStatus", "traits": { - "smithy.api#documentation": "

A link to the file that contains logs of the CreateBatchPrediction operation.

" + "smithy.api#documentation": "

The status of the BatchPrediction, which can be one of the following values:

\n " } }, - "Message": { - "target": "com.amazonaws.machinelearning#Message", + "FinishedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

A description of the most recent details about processing the batch prediction request.

" + "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

" } }, - "BatchPredictionDataSourceId": { + "BatchPredictionId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the DataSource that was used to create the BatchPrediction.\n

" + "smithy.api#documentation": "

An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID \n in the request.

" } }, - "Name": { - "target": "com.amazonaws.machinelearning#EntityName", + "StartedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the BatchPrediction.

" + "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

" } }, - "OutputUri": { + "InputDataLocationS3": { "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The location of an Amazon S3 bucket or directory to receive the operation results.

" + "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" } } }, @@ -2346,52 +2346,43 @@ "com.amazonaws.machinelearning#GetDataSourceInput": { "type": "structure", "members": { + "Verbose": { + "target": "com.amazonaws.machinelearning#Verbose", + "traits": { + "smithy.api#documentation": "

Specifies whether the GetDataSource operation should return DataSourceSchema.

\n

If true, DataSourceSchema is returned.

\n

If false, DataSourceSchema is not returned.

" + } + }, "DataSourceId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { "smithy.api#documentation": "

The ID assigned to the DataSource at creation.

", "smithy.api#required": {} } - }, - "Verbose": { - "target": "com.amazonaws.machinelearning#Verbose", - "traits": { - "smithy.api#documentation": "

Specifies whether the GetDataSource operation should return DataSourceSchema.

\n

If true, DataSourceSchema is returned.

\n

If false, DataSourceSchema is not returned.

" - } } } }, "com.amazonaws.machinelearning#GetDataSourceOutput": { "type": "structure", "members": { - "StartedAt": { + "RedshiftMetadata": { + "target": "com.amazonaws.machinelearning#RedshiftMetadata" + }, + "LastUpdatedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

" + "smithy.api#documentation": "

The time of the most recent edit to the DataSource. The time is expressed in epoch time.

" } }, - "DataSourceSchema": { - "target": "com.amazonaws.machinelearning#DataSchema", + "CreatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The schema used by all of the data files of this DataSource.

\n

\n Note: This parameter is provided as part of the verbose format.

" + "smithy.api#documentation": "

The time that the DataSource was created. The time is expressed in epoch time.

" } }, - "ComputeTime": { + "NumberOfFiles": { "target": "com.amazonaws.machinelearning#LongType", "traits": { - "smithy.api#documentation": "

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

" - } - }, - "Name": { - "target": "com.amazonaws.machinelearning#EntityName", - "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the DataSource.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.machinelearning#EntityId", - "traits": { - "smithy.api#documentation": "

The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

" + "smithy.api#documentation": "

The number of data files referenced by the DataSource.

" } }, "CreatedByIamUser": { @@ -2406,28 +2397,28 @@ "smithy.api#documentation": "

The user-supplied description of the most recent details about creating the DataSource.

" } }, - "DataSizeInBytes": { - "target": "com.amazonaws.machinelearning#LongType", + "DataSourceSchema": { + "target": "com.amazonaws.machinelearning#DataSchema", "traits": { - "smithy.api#documentation": "

The total size of observations in the data files.

" + "smithy.api#documentation": "

The schema used by all of the data files of this DataSource.

\n

\n Note: This parameter is provided as part of the verbose format.

" } }, - "ComputeStatistics": { - "target": "com.amazonaws.machinelearning#ComputeStatistics", + "DataSourceId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

\n The parameter is true if statistics need to be generated from the observation data.\n

" + "smithy.api#documentation": "

The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

" } }, - "FinishedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", - "traits": { - "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

" + "Name": { + "target": "com.amazonaws.machinelearning#EntityName", + "traits": { + "smithy.api#documentation": "

A user-supplied name or description of the DataSource.

" } }, - "LogUri": { - "target": "com.amazonaws.machinelearning#PresignedS3Url", + "ComputeTime": { + "target": "com.amazonaws.machinelearning#LongType", "traits": { - "smithy.api#documentation": "

A link to the file containing logs of CreateDataSourceFrom* operations.

" + "smithy.api#documentation": "

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

" } }, "Status": { @@ -2436,44 +2427,53 @@ "smithy.api#documentation": "

The current status of the DataSource. This element can have one of the following values:

\n " } }, - "RDSMetadata": { - "target": "com.amazonaws.machinelearning#RDSMetadata" - }, - "DataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", + "FinishedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

" } }, - "RedshiftMetadata": { - "target": "com.amazonaws.machinelearning#RedshiftMetadata" + "StartedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", + "traits": { + "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

" + } }, - "NumberOfFiles": { - "target": "com.amazonaws.machinelearning#LongType", + "LogUri": { + "target": "com.amazonaws.machinelearning#PresignedS3Url", "traits": { - "smithy.api#documentation": "

The number of data files referenced by the DataSource.

" + "smithy.api#documentation": "

A link to the file containing logs of CreateDataSourceFrom* operations.

" } }, "RoleARN": { "target": "com.amazonaws.machinelearning#RoleARN" }, - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", - "traits": { - "smithy.api#documentation": "

The time that the DataSource was created. The time is expressed in epoch time.

" - } - }, "DataRearrangement": { "target": "com.amazonaws.machinelearning#DataRearrangement", "traits": { "smithy.api#documentation": "

A JSON string that represents the splitting and rearrangement requirement used when this DataSource\n was created.

" } }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "ComputeStatistics": { + "target": "com.amazonaws.machinelearning#ComputeStatistics", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the DataSource. The time is expressed in epoch time.

" + "smithy.api#documentation": "

\n The parameter is true if statistics need to be generated from the observation data.\n

" } + }, + "DataLocationS3": { + "target": "com.amazonaws.machinelearning#S3Url", + "traits": { + "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + } + }, + "DataSizeInBytes": { + "target": "com.amazonaws.machinelearning#LongType", + "traits": { + "smithy.api#documentation": "

The total size of observations in the data files.

" + } + }, + "RDSMetadata": { + "target": "com.amazonaws.machinelearning#RDSMetadata" } }, "traits": { @@ -2518,94 +2518,94 @@ "com.amazonaws.machinelearning#GetEvaluationOutput": { "type": "structure", "members": { - "EvaluationId": { - "target": "com.amazonaws.machinelearning#EntityId", + "InputDataLocationS3": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The evaluation ID which is same as the EvaluationId in the request.

" + "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" } }, - "StartedAt": { + "LastUpdatedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. StartedAt isn't available if the Evaluation is in the PENDING state.

" + "smithy.api#documentation": "

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" } }, - "Name": { - "target": "com.amazonaws.machinelearning#EntityName", + "MLModelId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the Evaluation.

" + "smithy.api#documentation": "

The ID of the MLModel that was the focus of the evaluation.

" } }, - "CreatedByIamUser": { - "target": "com.amazonaws.machinelearning#AwsUserArn", + "PerformanceMetrics": { + "target": "com.amazonaws.machinelearning#PerformanceMetrics", "traits": { - "smithy.api#documentation": "

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + "smithy.api#documentation": "

Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel: \n

\n \n

\n For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.\n

" } }, - "Message": { - "target": "com.amazonaws.machinelearning#Message", + "Name": { + "target": "com.amazonaws.machinelearning#EntityName", "traits": { - "smithy.api#documentation": "

A description of the most recent details about evaluating the MLModel.

" + "smithy.api#documentation": "

A user-supplied name or description of the Evaluation.

" } }, - "EvaluationDataSourceId": { - "target": "com.amazonaws.machinelearning#EntityId", + "Message": { + "target": "com.amazonaws.machinelearning#Message", "traits": { - "smithy.api#documentation": "

The DataSource used for this evaluation.

" + "smithy.api#documentation": "

A description of the most recent details about evaluating the MLModel.

" } }, - "FinishedAt": { + "StartedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED or FAILED. FinishedAt is only available when the Evaluation is in the COMPLETED or FAILED state.

" + "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. StartedAt isn't available if the Evaluation is in the PENDING state.

" } }, - "ComputeTime": { - "target": "com.amazonaws.machinelearning#LongType", + "EvaluationId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the Evaluation, normalized and scaled on computation resources. ComputeTime is only available if the Evaluation is in the COMPLETED state.

" + "smithy.api#documentation": "

The evaluation ID which is same as the EvaluationId in the request.

" } }, - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "EvaluationDataSourceId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The time that the Evaluation was created. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The DataSource used for this evaluation.

" } }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "Status": { + "target": "com.amazonaws.machinelearning#EntityStatus", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The status of the evaluation. This element can have one of the following values:

\n " } }, - "MLModelId": { - "target": "com.amazonaws.machinelearning#EntityId", + "CreatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The ID of the MLModel that was the focus of the evaluation.

" + "smithy.api#documentation": "

The time that the Evaluation was created. The time is expressed in epoch time.

" } }, - "InputDataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", + "LogUri": { + "target": "com.amazonaws.machinelearning#PresignedS3Url", "traits": { - "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + "smithy.api#documentation": "

A link to the file that contains logs of the CreateEvaluation operation.

" } }, - "PerformanceMetrics": { - "target": "com.amazonaws.machinelearning#PerformanceMetrics", + "FinishedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel: \n

\n \n

\n For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.\n

" + "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED or FAILED. FinishedAt is only available when the Evaluation is in the COMPLETED or FAILED state.

" } }, - "Status": { - "target": "com.amazonaws.machinelearning#EntityStatus", + "ComputeTime": { + "target": "com.amazonaws.machinelearning#LongType", "traits": { - "smithy.api#documentation": "

The status of the evaluation. This element can have one of the following values:

\n " + "smithy.api#documentation": "

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the Evaluation, normalized and scaled on computation resources. ComputeTime is only available if the Evaluation is in the COMPLETED state.

" } }, - "LogUri": { - "target": "com.amazonaws.machinelearning#PresignedS3Url", + "CreatedByIamUser": { + "target": "com.amazonaws.machinelearning#AwsUserArn", "traits": { - "smithy.api#documentation": "

A link to the file that contains logs of the CreateEvaluation operation.

" + "smithy.api#documentation": "

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" } } }, @@ -2639,59 +2639,50 @@ "com.amazonaws.machinelearning#GetMLModelInput": { "type": "structure", "members": { - "Verbose": { - "target": "com.amazonaws.machinelearning#Verbose", - "traits": { - "smithy.api#documentation": "

Specifies whether the GetMLModel operation should return Recipe.

\n

If true, Recipe is returned.

\n

If false, Recipe is not returned.

" - } - }, "MLModelId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { "smithy.api#documentation": "

The ID assigned to the MLModel at creation.

", "smithy.api#required": {} } + }, + "Verbose": { + "target": "com.amazonaws.machinelearning#Verbose", + "traits": { + "smithy.api#documentation": "

Specifies whether the GetMLModel operation should return Recipe.

\n

If true, Recipe is returned.

\n

If false, Recipe is not returned.

" + } } } }, "com.amazonaws.machinelearning#GetMLModelOutput": { "type": "structure", "members": { - "Recipe": { - "target": "com.amazonaws.machinelearning#Recipe", - "traits": { - "smithy.api#documentation": "

The recipe to use when training the MLModel. The Recipe\n provides detailed information about the observation data to use during training, and\n manipulations to perform on the observation data during training.

\n

\n Note: This parameter is provided as part of the verbose format.

" - } - }, - "Name": { - "target": "com.amazonaws.machinelearning#MLModelName", + "MLModelType": { + "target": "com.amazonaws.machinelearning#MLModelType", "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the MLModel.

" + "smithy.api#documentation": "

Identifies the MLModel category. The following are the available types:

\n " } }, - "Message": { - "target": "com.amazonaws.machinelearning#Message", + "TrainingParameters": { + "target": "com.amazonaws.machinelearning#TrainingParameters", "traits": { - "smithy.api#documentation": "

A description of the most recent details about accessing the MLModel.

" + "smithy.api#documentation": "

A list of the training parameters in the MLModel. The list is implemented as\n a map of key-value pairs.

\n

The following is the current set of training parameters:

\n " } }, - "CreatedByIamUser": { - "target": "com.amazonaws.machinelearning#AwsUserArn", + "EndpointInfo": { + "target": "com.amazonaws.machinelearning#RealtimeEndpointInfo", "traits": { - "smithy.api#documentation": "

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + "smithy.api#documentation": "

The current endpoint of the MLModel\n

" } }, - "MLModelId": { - "target": "com.amazonaws.machinelearning#EntityId", + "InputDataLocationS3": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The MLModel ID, \n which is same as the MLModelId in the request.

" + "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" } }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", - "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" - } + "SizeInBytes": { + "target": "com.amazonaws.machinelearning#LongType" }, "ScoreThresholdLastUpdatedAt": { "target": "com.amazonaws.machinelearning#EpochTime", @@ -2699,55 +2690,46 @@ "smithy.api#documentation": "

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

" } }, - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "Schema": { + "target": "com.amazonaws.machinelearning#DataSchema", "traits": { - "smithy.api#documentation": "

The time that the MLModel was created. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The schema used by all of the data files referenced by the DataSource.

\n

\n Note: This parameter is provided as part of the verbose format.

" } }, - "EndpointInfo": { - "target": "com.amazonaws.machinelearning#RealtimeEndpointInfo", + "LogUri": { + "target": "com.amazonaws.machinelearning#PresignedS3Url", "traits": { - "smithy.api#documentation": "

The current endpoint of the MLModel\n

" + "smithy.api#documentation": "

A link to the file that contains logs of the CreateMLModel operation.

" } }, - "TrainingDataSourceId": { + "MLModelId": { "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the training DataSource.

" - } - }, - "SizeInBytes": { - "target": "com.amazonaws.machinelearning#LongType" - }, - "MLModelType": { - "target": "com.amazonaws.machinelearning#MLModelType", - "traits": { - "smithy.api#documentation": "

Identifies the MLModel category. The following are the available types:

\n " + "smithy.api#documentation": "

The MLModel ID, \n which is same as the MLModelId in the request.

" } }, - "TrainingParameters": { - "target": "com.amazonaws.machinelearning#TrainingParameters", + "Message": { + "target": "com.amazonaws.machinelearning#Message", "traits": { - "smithy.api#documentation": "

A list of the training parameters in the MLModel. The list is implemented as\n a map of key-value pairs.

\n

The following is the current set of training parameters:

\n " + "smithy.api#documentation": "

A description of the most recent details about accessing the MLModel.

" } }, - "ScoreThreshold": { - "target": "com.amazonaws.machinelearning#ScoreThreshold", + "Recipe": { + "target": "com.amazonaws.machinelearning#Recipe", "traits": { - "smithy.api#documentation": "

The scoring threshold is used in binary classification MLModel\n models. It marks the boundary between a positive prediction and a\n negative prediction.

\n

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as \n true. Output values less than the threshold receive a negative response from the MLModel, \n such as false.

" + "smithy.api#documentation": "

The recipe to use when training the MLModel. The Recipe\n provides detailed information about the observation data to use during training, and\n manipulations to perform on the observation data during training.

\n

\n Note: This parameter is provided as part of the verbose format.

" } }, - "LogUri": { - "target": "com.amazonaws.machinelearning#PresignedS3Url", + "TrainingDataSourceId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

A link to the file that contains logs of the CreateMLModel operation.

" + "smithy.api#documentation": "

The ID of the training DataSource.

" } }, - "Schema": { - "target": "com.amazonaws.machinelearning#DataSchema", + "Name": { + "target": "com.amazonaws.machinelearning#MLModelName", "traits": { - "smithy.api#documentation": "

The schema used by all of the data files referenced by the DataSource.

\n

\n Note: This parameter is provided as part of the verbose format.

" + "smithy.api#documentation": "

A user-supplied name or description of the MLModel.

" } }, "ComputeTime": { @@ -2756,28 +2738,46 @@ "smithy.api#documentation": "

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state.

" } }, + "Status": { + "target": "com.amazonaws.machinelearning#EntityStatus", + "traits": { + "smithy.api#documentation": "

The current status of the MLModel. This element can have one of the following values:

\n " + } + }, "FinishedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state.

" } }, - "Status": { - "target": "com.amazonaws.machinelearning#EntityStatus", + "StartedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The current status of the MLModel. This element can have one of the following values:

\n " + "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

" } }, - "InputDataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", + "LastUpdatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + "smithy.api#documentation": "

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" } }, - "StartedAt": { + "ScoreThreshold": { + "target": "com.amazonaws.machinelearning#ScoreThreshold", + "traits": { + "smithy.api#documentation": "

The scoring threshold is used in binary classification MLModel\n models. It marks the boundary between a positive prediction and a\n negative prediction.

\n

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as \n true. Output values less than the threshold receive a negative response from the MLModel, \n such as false.

" + } + }, + "CreatedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

" + "smithy.api#documentation": "

The time that the MLModel was created. The time is expressed in epoch time.

" + } + }, + "CreatedByIamUser": { + "target": "com.amazonaws.machinelearning#AwsUserArn", + "traits": { + "smithy.api#documentation": "

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" } } }, @@ -2788,11 +2788,11 @@ "com.amazonaws.machinelearning#IdempotentParameterMismatchException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.machinelearning#ErrorMessage" - }, "code": { "target": "com.amazonaws.machinelearning#ErrorCode" + }, + "message": { + "target": "com.amazonaws.machinelearning#ErrorMessage" } }, "traits": { @@ -2862,11 +2862,11 @@ "com.amazonaws.machinelearning#LimitExceededException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.machinelearning#ErrorMessage" - }, "code": { "target": "com.amazonaws.machinelearning#ErrorCode" + }, + "message": { + "target": "com.amazonaws.machinelearning#ErrorMessage" } }, "traits": { @@ -2885,37 +2885,55 @@ "com.amazonaws.machinelearning#MLModel": { "type": "structure", "members": { - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "EndpointInfo": { + "target": "com.amazonaws.machinelearning#RealtimeEndpointInfo", "traits": { - "smithy.api#documentation": "

The time that the MLModel was created. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The current endpoint of the MLModel.

" } }, - "StartedAt": { - "target": "com.amazonaws.machinelearning#EpochTime" + "ScoreThresholdLastUpdatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", + "traits": { + "smithy.api#documentation": "

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

" + } }, - "TrainingDataSourceId": { - "target": "com.amazonaws.machinelearning#EntityId", + "TrainingParameters": { + "target": "com.amazonaws.machinelearning#TrainingParameters", "traits": { - "smithy.api#documentation": "

The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.

" + "smithy.api#documentation": "

A list of the training parameters in the MLModel. The list is implemented as\n a map of key-value pairs.

\n

The following is the current set of training parameters:

\n " } }, - "LastUpdatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "ComputeTime": { + "target": "com.amazonaws.machinelearning#LongType" + }, + "FinishedAt": { + "target": "com.amazonaws.machinelearning#EpochTime" + }, + "InputDataLocationS3": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" } }, + "StartedAt": { + "target": "com.amazonaws.machinelearning#EpochTime" + }, "Status": { "target": "com.amazonaws.machinelearning#EntityStatus", "traits": { "smithy.api#documentation": "

The current status of an MLModel. This element can have one of the following values:

\n " } }, - "Name": { - "target": "com.amazonaws.machinelearning#MLModelName", + "TrainingDataSourceId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

A user-supplied name or description of the MLModel.

" + "smithy.api#documentation": "

The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", + "traits": { + "smithy.api#documentation": "

The time that the MLModel was created. The time is expressed in epoch time.

" } }, "MLModelId": { @@ -2930,31 +2948,28 @@ "smithy.api#documentation": "

A description of the most recent details about accessing the MLModel.

" } }, - "MLModelType": { - "target": "com.amazonaws.machinelearning#MLModelType", + "CreatedByIamUser": { + "target": "com.amazonaws.machinelearning#AwsUserArn", "traits": { - "smithy.api#documentation": "

Identifies the MLModel category. The following are the available types:

\n " + "smithy.api#documentation": "

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" } }, - "EndpointInfo": { - "target": "com.amazonaws.machinelearning#RealtimeEndpointInfo", + "Name": { + "target": "com.amazonaws.machinelearning#MLModelName", "traits": { - "smithy.api#documentation": "

The current endpoint of the MLModel.

" + "smithy.api#documentation": "

A user-supplied name or description of the MLModel.

" } }, - "TrainingParameters": { - "target": "com.amazonaws.machinelearning#TrainingParameters", + "ScoreThreshold": { + "target": "com.amazonaws.machinelearning#ScoreThreshold", "traits": { - "smithy.api#documentation": "

A list of the training parameters in the MLModel. The list is implemented as\n a map of key-value pairs.

\n

The following is the current set of training parameters:

\n " + "smithy.api#documentation": "

The score threshold for the MLModel.

" } }, - "SizeInBytes": { - "target": "com.amazonaws.machinelearning#LongType" - }, - "ScoreThresholdLastUpdatedAt": { + "LastUpdatedAt": { "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" } }, "Algorithm": { @@ -2963,29 +2978,14 @@ "smithy.api#documentation": "

The algorithm used to train the MLModel. The following algorithm is supported:

\n " } }, - "InputDataLocationS3": { - "target": "com.amazonaws.machinelearning#S3Url", - "traits": { - "smithy.api#documentation": "

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" - } - }, - "ScoreThreshold": { - "target": "com.amazonaws.machinelearning#ScoreThreshold", + "MLModelType": { + "target": "com.amazonaws.machinelearning#MLModelType", "traits": { - "smithy.api#documentation": "

The score threshold for the MLModel.

" + "smithy.api#documentation": "

Identifies the MLModel category. The following are the available types:

\n " } }, - "FinishedAt": { - "target": "com.amazonaws.machinelearning#EpochTime" - }, - "ComputeTime": { + "SizeInBytes": { "target": "com.amazonaws.machinelearning#LongType" - }, - "CreatedByIamUser": { - "target": "com.amazonaws.machinelearning#AwsUserArn", - "traits": { - "smithy.api#documentation": "

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" - } } }, "traits": { @@ -3160,17 +3160,17 @@ "smithy.api#required": {} } }, - "MLModelId": { - "target": "com.amazonaws.machinelearning#EntityId", + "PredictEndpoint": { + "target": "com.amazonaws.machinelearning#VipURLUnvalidated", "traits": { - "smithy.api#documentation": "

A unique identifier of the MLModel.

", + "smithy.api#documentation": "

The predicted endpoint for the input.

", "smithy.api#required": {} } }, - "PredictEndpoint": { - "target": "com.amazonaws.machinelearning#VipURLUnvalidated", + "MLModelId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The predicted endpoint for the input.

", + "smithy.api#documentation": "

A unique identifier of the MLModel.

", "smithy.api#required": {} } } @@ -3187,14 +3187,8 @@ "com.amazonaws.machinelearning#Prediction": { "type": "structure", "members": { - "details": { - "target": "com.amazonaws.machinelearning#DetailsMap" - }, - "predictedLabel": { - "target": "com.amazonaws.machinelearning#Label", - "traits": { - "smithy.api#documentation": "

The prediction label for either a BINARY or MULTICLASS \n MLModel.

" - } + "predictedScores": { + "target": "com.amazonaws.machinelearning#ScoreValuePerLabelMap" }, "predictedValue": { "target": "com.amazonaws.machinelearning#floatLabel", @@ -3202,8 +3196,14 @@ "smithy.api#documentation": "

The prediction value for REGRESSION \n MLModel.

" } }, - "predictedScores": { - "target": "com.amazonaws.machinelearning#ScoreValuePerLabelMap" + "predictedLabel": { + "target": "com.amazonaws.machinelearning#Label", + "traits": { + "smithy.api#documentation": "

The prediction label for either a BINARY or MULTICLASS \n MLModel.

" + } + }, + "details": { + "target": "com.amazonaws.machinelearning#DetailsMap" } }, "traits": { @@ -3229,10 +3229,10 @@ "com.amazonaws.machinelearning#RDSDataSpec": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.machinelearning#EDPSubnetId", + "ResourceRole": { + "target": "com.amazonaws.machinelearning#EDPResourceRole", "traits": { - "smithy.api#documentation": "

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

", + "smithy.api#documentation": "

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

", "smithy.api#required": {} } }, @@ -3243,11 +3243,10 @@ "smithy.api#required": {} } }, - "ResourceRole": { - "target": "com.amazonaws.machinelearning#EDPResourceRole", + "DataSchema": { + "target": "com.amazonaws.machinelearning#DataSchema", "traits": { - "smithy.api#documentation": "

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A JSON string that represents the schema for an Amazon RDS\n DataSource. The DataSchema\n defines the structure of the observation data in the data file(s)\n referenced in the DataSource.

\n

A DataSchema is not required if you specify a \n DataSchemaUri\n

\n

Define your DataSchema as a series of key-value pairs. attributes\n and excludedAttributeNames have an array of key-value pairs\n for their value. Use the following format to define your DataSchema.

\n

{ \"version\": \"1.0\",

\n

\"recordAnnotationFieldName\": \"F1\",

\n

\"recordWeightFieldName\": \"F2\",

\n

\"targetAttributeName\": \"F3\",

\n

\"dataFormat\": \"CSV\",

\n

\"dataFileContainsHeader\": true,

\n

\"attributes\": [

\n

{ \"attributeName\": \"F1\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F2\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F3\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F4\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F5\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F6\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F7\", \"attributeType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"attributeName\": \"F8\", \"attributeType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\n

\"excludedAttributeNames\": [ \"F6\" ] }

" } }, "SecurityGroupIds": { @@ -3257,16 +3256,25 @@ "smithy.api#required": {} } }, - "DataSchema": { - "target": "com.amazonaws.machinelearning#DataSchema", + "S3StagingLocation": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

A JSON string that represents the schema for an Amazon RDS\n DataSource. The DataSchema\n defines the structure of the observation data in the data file(s)\n referenced in the DataSource.

\n

A DataSchema is not required if you specify a \n DataSchemaUri\n

\n

Define your DataSchema as a series of key-value pairs. attributes\n and excludedAttributeNames have an array of key-value pairs\n for their value. Use the following format to define your DataSchema.

\n

{ \"version\": \"1.0\",

\n

\"recordAnnotationFieldName\": \"F1\",

\n

\"recordWeightFieldName\": \"F2\",

\n

\"targetAttributeName\": \"F3\",

\n

\"dataFormat\": \"CSV\",

\n

\"dataFileContainsHeader\": true,

\n

\"attributes\": [

\n

{ \"attributeName\": \"F1\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F2\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F3\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F4\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F5\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F6\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F7\", \"attributeType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"attributeName\": \"F8\", \"attributeType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\n

\"excludedAttributeNames\": [ \"F6\" ] }

" + "smithy.api#documentation": "

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

", + "smithy.api#required": {} } }, - "DataSchemaUri": { - "target": "com.amazonaws.machinelearning#S3Url", + "SelectSqlQuery": { + "target": "com.amazonaws.machinelearning#RDSSelectSqlQuery", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the DataSchema.

" + "smithy.api#documentation": "

The query that is used to retrieve the observation data for the DataSource.

", + "smithy.api#required": {} + } + }, + "DatabaseInformation": { + "target": "com.amazonaws.machinelearning#RDSDatabase", + "traits": { + "smithy.api#documentation": "

Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database.

", + "smithy.api#required": {} } }, "DataRearrangement": { @@ -3275,11 +3283,10 @@ "smithy.api#documentation": "

A JSON string that represents the splitting and rearrangement \n processing to be applied to a DataSource. If the DataRearrangement \n parameter is not provided, all of the input data is used to create the Datasource.

\n\n

There are multiple parameters that control what data is used to create a datasource:

\n " } }, - "SelectSqlQuery": { - "target": "com.amazonaws.machinelearning#RDSSelectSqlQuery", + "DataSchemaUri": { + "target": "com.amazonaws.machinelearning#S3Url", "traits": { - "smithy.api#documentation": "

The query that is used to retrieve the observation data for the DataSource.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon S3 location of the DataSchema.

" } }, "DatabaseCredentials": { @@ -3289,17 +3296,10 @@ "smithy.api#required": {} } }, - "S3StagingLocation": { - "target": "com.amazonaws.machinelearning#S3Url", - "traits": { - "smithy.api#documentation": "

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

", - "smithy.api#required": {} - } - }, - "DatabaseInformation": { - "target": "com.amazonaws.machinelearning#RDSDatabase", + "SubnetId": { + "target": "com.amazonaws.machinelearning#EDPSubnetId", "traits": { - "smithy.api#documentation": "

Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database.

", + "smithy.api#documentation": "

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

", "smithy.api#required": {} } } @@ -3311,16 +3311,16 @@ "com.amazonaws.machinelearning#RDSDatabase": { "type": "structure", "members": { - "DatabaseName": { - "target": "com.amazonaws.machinelearning#RDSDatabaseName", + "InstanceIdentifier": { + "target": "com.amazonaws.machinelearning#RDSInstanceIdentifier", "traits": { + "smithy.api#documentation": "

The ID of an RDS DB instance.

", "smithy.api#required": {} } }, - "InstanceIdentifier": { - "target": "com.amazonaws.machinelearning#RDSInstanceIdentifier", + "DatabaseName": { + "target": "com.amazonaws.machinelearning#RDSDatabaseName", "traits": { - "smithy.api#documentation": "

The ID of an RDS DB instance.

", "smithy.api#required": {} } } @@ -3392,21 +3392,24 @@ "com.amazonaws.machinelearning#RDSMetadata": { "type": "structure", "members": { + "ServiceRole": { + "target": "com.amazonaws.machinelearning#EDPServiceRole", + "traits": { + "smithy.api#documentation": "

The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" + } + }, "ResourceRole": { "target": "com.amazonaws.machinelearning#EDPResourceRole", "traits": { "smithy.api#documentation": "

The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" } }, - "ServiceRole": { - "target": "com.amazonaws.machinelearning#EDPServiceRole", + "Database": { + "target": "com.amazonaws.machinelearning#RDSDatabase", "traits": { - "smithy.api#documentation": "

The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" + "smithy.api#documentation": "

The database details required to connect to an Amazon RDS.

" } }, - "DatabaseUserName": { - "target": "com.amazonaws.machinelearning#RDSDatabaseUsername" - }, "DataPipelineId": { "target": "com.amazonaws.machinelearning#EDPPipelineId", "traits": { @@ -3419,11 +3422,8 @@ "smithy.api#documentation": "

The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput.

" } }, - "Database": { - "target": "com.amazonaws.machinelearning#RDSDatabase", - "traits": { - "smithy.api#documentation": "

The database details required to connect to an Amazon RDS.

" - } + "DatabaseUserName": { + "target": "com.amazonaws.machinelearning#RDSDatabaseUsername" } }, "traits": { @@ -3443,16 +3443,10 @@ "com.amazonaws.machinelearning#RealtimeEndpointInfo": { "type": "structure", "members": { - "EndpointStatus": { - "target": "com.amazonaws.machinelearning#RealtimeEndpointStatus", - "traits": { - "smithy.api#documentation": "

The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

\n " - } - }, - "EndpointUrl": { - "target": "com.amazonaws.machinelearning#VipURL", + "CreatedAt": { + "target": "com.amazonaws.machinelearning#EpochTime", "traits": { - "smithy.api#documentation": "

The URI that specifies where to send real-time prediction requests for the MLModel.

\n

\n Note: The application must wait until the real-time endpoint is ready before using this URI.

" + "smithy.api#documentation": "

The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

" } }, "PeakRequestsPerSecond": { @@ -3461,10 +3455,16 @@ "smithy.api#documentation": "

The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

" } }, - "CreatedAt": { - "target": "com.amazonaws.machinelearning#EpochTime", + "EndpointStatus": { + "target": "com.amazonaws.machinelearning#RealtimeEndpointStatus", "traits": { - "smithy.api#documentation": "

The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

" + "smithy.api#documentation": "

The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

\n " + } + }, + "EndpointUrl": { + "target": "com.amazonaws.machinelearning#VipURL", + "traits": { + "smithy.api#documentation": "

The URI that specifies where to send real-time prediction requests for the MLModel.

\n

\n Note: The application must wait until the real-time endpoint is ready before using this URI.

" } } }, @@ -3535,19 +3535,18 @@ "smithy.api#documentation": "

A JSON string that represents the splitting and rearrangement \n processing to be applied to a DataSource. If the DataRearrangement \n parameter is not provided, all of the input data is used to create the Datasource.

\n\n

There are multiple parameters that control what data is used to create a datasource:

\n " } }, - "SelectSqlQuery": { - "target": "com.amazonaws.machinelearning#RedshiftSelectSqlQuery", - "traits": { - "smithy.api#documentation": "

Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

", - "smithy.api#required": {} - } - }, "DataSchemaUri": { "target": "com.amazonaws.machinelearning#S3Url", "traits": { "smithy.api#documentation": "

Describes the schema location for an Amazon Redshift DataSource.

" } }, + "DataSchema": { + "target": "com.amazonaws.machinelearning#DataSchema", + "traits": { + "smithy.api#documentation": "

A JSON string that represents the schema for an Amazon Redshift \n DataSource. The DataSchema\n defines the structure of the observation data in the data file(s)\n referenced in the DataSource.

\n

A DataSchema is not required if you specify a \n DataSchemaUri.

\n

Define your DataSchema as a series of key-value pairs. attributes\n and excludedAttributeNames have an array of key-value pairs\n for their value. Use the following format to define your DataSchema.

\n

{ \"version\": \"1.0\",

\n

\"recordAnnotationFieldName\": \"F1\",

\n

\"recordWeightFieldName\": \"F2\",

\n

\"targetAttributeName\": \"F3\",

\n

\"dataFormat\": \"CSV\",

\n

\"dataFileContainsHeader\": true,

\n

\"attributes\": [

\n

{ \"attributeName\": \"F1\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F2\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F3\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F4\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F5\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F6\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F7\", \"attributeType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"attributeName\": \"F8\", \"attributeType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\n

\"excludedAttributeNames\": [ \"F6\" ] }

" + } + }, "DatabaseCredentials": { "target": "com.amazonaws.machinelearning#RedshiftDatabaseCredentials", "traits": { @@ -3555,10 +3554,10 @@ "smithy.api#required": {} } }, - "DatabaseInformation": { - "target": "com.amazonaws.machinelearning#RedshiftDatabase", + "SelectSqlQuery": { + "target": "com.amazonaws.machinelearning#RedshiftSelectSqlQuery", "traits": { - "smithy.api#documentation": "

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

", + "smithy.api#documentation": "

Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

", "smithy.api#required": {} } }, @@ -3569,10 +3568,11 @@ "smithy.api#required": {} } }, - "DataSchema": { - "target": "com.amazonaws.machinelearning#DataSchema", + "DatabaseInformation": { + "target": "com.amazonaws.machinelearning#RedshiftDatabase", "traits": { - "smithy.api#documentation": "

A JSON string that represents the schema for an Amazon Redshift \n DataSource. The DataSchema\n defines the structure of the observation data in the data file(s)\n referenced in the DataSource.

\n

A DataSchema is not required if you specify a \n DataSchemaUri.

\n

Define your DataSchema as a series of key-value pairs. attributes\n and excludedAttributeNames have an array of key-value pairs\n for their value. Use the following format to define your DataSchema.

\n

{ \"version\": \"1.0\",

\n

\"recordAnnotationFieldName\": \"F1\",

\n

\"recordWeightFieldName\": \"F2\",

\n

\"targetAttributeName\": \"F3\",

\n

\"dataFormat\": \"CSV\",

\n

\"dataFileContainsHeader\": true,

\n

\"attributes\": [

\n

{ \"attributeName\": \"F1\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F2\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F3\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F4\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F5\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F6\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F7\", \"attributeType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"attributeName\": \"F8\", \"attributeType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\n

\"excludedAttributeNames\": [ \"F6\" ] }

" + "smithy.api#documentation": "

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

", + "smithy.api#required": {} } } }, @@ -3603,14 +3603,14 @@ "com.amazonaws.machinelearning#RedshiftDatabaseCredentials": { "type": "structure", "members": { - "Username": { - "target": "com.amazonaws.machinelearning#RedshiftDatabaseUsername", + "Password": { + "target": "com.amazonaws.machinelearning#RedshiftDatabasePassword", "traits": { "smithy.api#required": {} } }, - "Password": { - "target": "com.amazonaws.machinelearning#RedshiftDatabasePassword", + "Username": { + "target": "com.amazonaws.machinelearning#RedshiftDatabaseUsername", "traits": { "smithy.api#required": {} } @@ -3653,17 +3653,17 @@ "com.amazonaws.machinelearning#RedshiftMetadata": { "type": "structure", "members": { + "DatabaseUserName": { + "target": "com.amazonaws.machinelearning#RedshiftDatabaseUsername" + }, + "RedshiftDatabase": { + "target": "com.amazonaws.machinelearning#RedshiftDatabase" + }, "SelectSqlQuery": { "target": "com.amazonaws.machinelearning#RedshiftSelectSqlQuery", "traits": { "smithy.api#documentation": "

The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput.

" } - }, - "RedshiftDatabase": { - "target": "com.amazonaws.machinelearning#RedshiftDatabase" - }, - "DatabaseUserName": { - "target": "com.amazonaws.machinelearning#RedshiftDatabaseUsername" } }, "traits": { @@ -3683,11 +3683,11 @@ "com.amazonaws.machinelearning#ResourceNotFoundException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.machinelearning#ErrorMessage" - }, "code": { "target": "com.amazonaws.machinelearning#ErrorCode" + }, + "message": { + "target": "com.amazonaws.machinelearning#ErrorMessage" } }, "traits": { @@ -3721,18 +3721,18 @@ "smithy.api#documentation": "

Describes the schema location in Amazon S3. You must provide either the \n DataSchema or the DataSchemaLocationS3.

" } }, - "DataSchema": { - "target": "com.amazonaws.machinelearning#DataSchema", - "traits": { - "smithy.api#documentation": "

A JSON string that represents the schema for an Amazon S3 \n DataSource. The DataSchema\n defines the structure of the observation data in the data file(s) \n referenced in the DataSource.

\n

You must provide either the DataSchema or the DataSchemaLocationS3.

\n

Define your DataSchema as a series of key-value pairs. attributes \n and excludedAttributeNames have an array of key-value pairs\n for their value. Use the following format to define your DataSchema.

\n

{ \"version\": \"1.0\",

\n

\"recordAnnotationFieldName\": \"F1\",

\n

\"recordWeightFieldName\": \"F2\",

\n

\"targetAttributeName\": \"F3\",

\n

\"dataFormat\": \"CSV\",

\n

\"dataFileContainsHeader\": true,

\n

\"attributes\": [

\n

{ \"attributeName\": \"F1\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F2\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F3\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F4\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F5\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F6\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F7\", \"attributeType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"attributeName\": \"F8\", \"attributeType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\n

\"excludedAttributeNames\": [ \"F6\" ] }

" - } - }, "DataLocationS3": { "target": "com.amazonaws.machinelearning#S3Url", "traits": { "smithy.api#documentation": "

The location of the data file(s) used by a DataSource. The URI specifies a data file or \n an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.

", "smithy.api#required": {} } + }, + "DataSchema": { + "target": "com.amazonaws.machinelearning#DataSchema", + "traits": { + "smithy.api#documentation": "

A JSON string that represents the schema for an Amazon S3 \n DataSource. The DataSchema\n defines the structure of the observation data in the data file(s) \n referenced in the DataSource.

\n

You must provide either the DataSchema or the DataSchemaLocationS3.

\n

Define your DataSchema as a series of key-value pairs. attributes \n and excludedAttributeNames have an array of key-value pairs\n for their value. Use the following format to define your DataSchema.

\n

{ \"version\": \"1.0\",

\n

\"recordAnnotationFieldName\": \"F1\",

\n

\"recordWeightFieldName\": \"F2\",

\n

\"targetAttributeName\": \"F3\",

\n

\"dataFormat\": \"CSV\",

\n

\"dataFileContainsHeader\": true,

\n

\"attributes\": [

\n

{ \"attributeName\": \"F1\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F2\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F3\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F4\", \"attributeType\": \"NUMERIC\" }, { \"attributeName\": \"F5\", \"attributeType\": \"CATEGORICAL\" }, { \"attributeName\": \"F6\", \"attributeType\": \"TEXT\" }, { \"attributeName\": \"F7\", \"attributeType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"attributeName\": \"F8\", \"attributeType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\n

\"excludedAttributeNames\": [ \"F6\" ] }

" + } } }, "traits": { @@ -3796,17 +3796,17 @@ "com.amazonaws.machinelearning#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.machinelearning#TagKey", - "traits": { - "smithy.api#documentation": "

A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

" - } - }, "Value": { "target": "com.amazonaws.machinelearning#TagValue", "traits": { "smithy.api#documentation": "

An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

" } + }, + "Key": { + "target": "com.amazonaws.machinelearning#TagKey", + "traits": { + "smithy.api#documentation": "

A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

" + } } }, "traits": { @@ -3927,17 +3927,17 @@ "com.amazonaws.machinelearning#UpdateBatchPredictionInput": { "type": "structure", "members": { - "BatchPredictionName": { - "target": "com.amazonaws.machinelearning#EntityName", + "BatchPredictionId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

A new user-supplied name or description of the BatchPrediction.

", + "smithy.api#documentation": "

The ID assigned to the BatchPrediction during creation.

", "smithy.api#required": {} } }, - "BatchPredictionId": { - "target": "com.amazonaws.machinelearning#EntityId", + "BatchPredictionName": { + "target": "com.amazonaws.machinelearning#EntityName", "traits": { - "smithy.api#documentation": "

The ID assigned to the BatchPrediction during creation.

", + "smithy.api#documentation": "

A new user-supplied name or description of the BatchPrediction.

", "smithy.api#required": {} } } @@ -3983,17 +3983,17 @@ "com.amazonaws.machinelearning#UpdateDataSourceInput": { "type": "structure", "members": { - "DataSourceId": { - "target": "com.amazonaws.machinelearning#EntityId", + "DataSourceName": { + "target": "com.amazonaws.machinelearning#EntityName", "traits": { - "smithy.api#documentation": "

The ID assigned to the DataSource during creation.

", + "smithy.api#documentation": "

A new user-supplied name or description of the DataSource that will replace the current description.

", "smithy.api#required": {} } }, - "DataSourceName": { - "target": "com.amazonaws.machinelearning#EntityName", + "DataSourceId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

A new user-supplied name or description of the DataSource that will replace the current description.

", + "smithy.api#documentation": "

The ID assigned to the DataSource during creation.

", "smithy.api#required": {} } } @@ -4039,17 +4039,17 @@ "com.amazonaws.machinelearning#UpdateEvaluationInput": { "type": "structure", "members": { - "EvaluationName": { - "target": "com.amazonaws.machinelearning#EntityName", + "EvaluationId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

A new user-supplied name or description of the Evaluation that will replace the current content.

", + "smithy.api#documentation": "

The ID assigned to the Evaluation during creation.

", "smithy.api#required": {} } }, - "EvaluationId": { - "target": "com.amazonaws.machinelearning#EntityId", + "EvaluationName": { + "target": "com.amazonaws.machinelearning#EntityName", "traits": { - "smithy.api#documentation": "

The ID assigned to the Evaluation during creation.

", + "smithy.api#documentation": "

A new user-supplied name or description of the Evaluation that will replace the current content.

", "smithy.api#required": {} } } @@ -4095,10 +4095,11 @@ "com.amazonaws.machinelearning#UpdateMLModelInput": { "type": "structure", "members": { - "ScoreThreshold": { - "target": "com.amazonaws.machinelearning#ScoreThreshold", + "MLModelId": { + "target": "com.amazonaws.machinelearning#EntityId", "traits": { - "smithy.api#documentation": "

The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction.

\n

Output values greater than or equal to the ScoreThreshold receive a positive result from the MLModel, such as true. Output values less than the ScoreThreshold receive a negative response from the MLModel, such as false.

" + "smithy.api#documentation": "

The ID assigned to the MLModel during creation.

", + "smithy.api#required": {} } }, "MLModelName": { @@ -4107,11 +4108,10 @@ "smithy.api#documentation": "

A user-supplied name or description of the MLModel.

" } }, - "MLModelId": { - "target": "com.amazonaws.machinelearning#EntityId", + "ScoreThreshold": { + "target": "com.amazonaws.machinelearning#ScoreThreshold", "traits": { - "smithy.api#documentation": "

The ID assigned to the MLModel during creation.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction.

\n

Output values greater than or equal to the ScoreThreshold receive a positive result from the MLModel, such as true. Output values less than the ScoreThreshold receive a negative response from the MLModel, such as false.

" } } } diff --git a/codegen/sdk-codegen/aws-models/macie.2017-12-19.json b/codegen/sdk-codegen/aws-models/macie.2017-12-19.json index 66299271f81c..a78774b42a42 100644 --- a/codegen/sdk-codegen/aws-models/macie.2017-12-19.json +++ b/codegen/sdk-codegen/aws-models/macie.2017-12-19.json @@ -38,11 +38,11 @@ "com.amazonaws.macie#AccessDeniedException": { "type": "structure", "members": { - "resourceType": { - "target": "com.amazonaws.macie#ResourceType" - }, "message": { "target": "com.amazonaws.macie#ExceptionMessage" + }, + "resourceType": { + "target": "com.amazonaws.macie#ResourceType" } }, "traits": { @@ -297,17 +297,17 @@ "smithy.api#documentation": "

The status code of a failed item.

" } }, - "failedItem": { - "target": "com.amazonaws.macie#S3Resource", - "traits": { - "smithy.api#documentation": "

The failed S3 resources.

" - } - }, "errorMessage": { "target": "com.amazonaws.macie#ExceptionMessage", "traits": { "smithy.api#documentation": "

The error message of a failed item.

" } + }, + "failedItem": { + "target": "com.amazonaws.macie#S3Resource", + "traits": { + "smithy.api#documentation": "

The failed S3 resources.

" + } } }, "traits": { @@ -351,11 +351,11 @@ "fieldName": { "target": "com.amazonaws.macie#FieldName" }, - "message": { - "target": "com.amazonaws.macie#ExceptionMessage" - }, "errorCode": { "target": "com.amazonaws.macie#ErrorCode" + }, + "message": { + "target": "com.amazonaws.macie#ExceptionMessage" } }, "traits": { @@ -366,14 +366,14 @@ "com.amazonaws.macie#LimitExceededException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.macie#ExceptionMessage" - }, "errorCode": { "target": "com.amazonaws.macie#ErrorCode" }, "resourceType": { "target": "com.amazonaws.macie#ResourceType" + }, + "message": { + "target": "com.amazonaws.macie#ExceptionMessage" } }, "traits": { @@ -409,17 +409,17 @@ "com.amazonaws.macie#ListMemberAccountsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.macie#MaxResults", - "traits": { - "smithy.api#documentation": "

Use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 250.

" - } - }, "nextToken": { "target": "com.amazonaws.macie#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results. Set the value of this parameter to null on\n your first call to the ListMemberAccounts action. Subsequent calls to the action fill\n nextToken in the request with the value of nextToken from the previous response to continue\n listing data.

" } + }, + "maxResults": { + "target": "com.amazonaws.macie#MaxResults", + "traits": { + "smithy.api#documentation": "

Use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 250.

" + } } } }, @@ -477,17 +477,17 @@ "smithy.api#documentation": "

The Amazon Macie Classic member account ID whose associated S3 resources you want to\n list.

" } }, - "nextToken": { - "target": "com.amazonaws.macie#NextToken", - "traits": { - "smithy.api#documentation": "

Use this parameter when paginating results. Set its value to null on your first call to\n the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with\n the value of nextToken from the previous response to continue listing data.

" - } - }, "maxResults": { "target": "com.amazonaws.macie#MaxResults", "traits": { "smithy.api#documentation": "

Use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 250.

" } + }, + "nextToken": { + "target": "com.amazonaws.macie#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results. Set its value to null on your first call to\n the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with\n the value of nextToken from the previous response to continue listing data.

" + } } } }, @@ -539,7 +539,7 @@ "sdkId": "Macie", "arnNamespace": "macie", "cloudFormationName": "Macie", - "cloudTrailEventSource": "service.macie.amazonaws.com" + "cloudTrailEventSource": "macie.amazonaws.com" }, "aws.auth#sigv4": { "name": "macie" @@ -635,18 +635,18 @@ "com.amazonaws.macie#S3Resource": { "type": "structure", "members": { - "prefix": { - "target": "com.amazonaws.macie#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix of the S3 bucket.

" - } - }, "bucketName": { "target": "com.amazonaws.macie#BucketName", "traits": { "smithy.api#documentation": "

The name of the S3 bucket.

", "smithy.api#required": {} } + }, + "prefix": { + "target": "com.amazonaws.macie#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix of the S3 bucket.

" + } } }, "traits": { @@ -662,17 +662,17 @@ "smithy.api#documentation": "

The prefix of the S3 bucket that you want to associate with Amazon Macie\n Classic.

" } }, - "classificationType": { - "target": "com.amazonaws.macie#ClassificationType", + "bucketName": { + "target": "com.amazonaws.macie#BucketName", "traits": { - "smithy.api#documentation": "

The classification type that you want to specify for the resource associated with\n Amazon Macie Classic.

", + "smithy.api#documentation": "

The name of the S3 bucket that you want to associate with Amazon Macie\n Classic.

", "smithy.api#required": {} } }, - "bucketName": { - "target": "com.amazonaws.macie#BucketName", + "classificationType": { + "target": "com.amazonaws.macie#ClassificationType", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket that you want to associate with Amazon Macie\n Classic.

", + "smithy.api#documentation": "

The classification type that you want to specify for the resource associated with\n Amazon Macie Classic.

", "smithy.api#required": {} } } @@ -684,11 +684,10 @@ "com.amazonaws.macie#S3ResourceClassificationUpdate": { "type": "structure", "members": { - "classificationTypeUpdate": { - "target": "com.amazonaws.macie#ClassificationTypeUpdate", + "prefix": { + "target": "com.amazonaws.macie#Prefix", "traits": { - "smithy.api#documentation": "

The classification type that you want to update for the resource associated with Amazon\n Macie Classic.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The prefix of the S3 bucket whose classification types you want to update.

" } }, "bucketName": { @@ -698,10 +697,11 @@ "smithy.api#required": {} } }, - "prefix": { - "target": "com.amazonaws.macie#Prefix", + "classificationTypeUpdate": { + "target": "com.amazonaws.macie#ClassificationTypeUpdate", "traits": { - "smithy.api#documentation": "

The prefix of the S3 bucket whose classification types you want to update.

" + "smithy.api#documentation": "

The classification type that you want to update for the resource associated with Amazon\n Macie Classic.

", + "smithy.api#required": {} } } }, @@ -753,18 +753,18 @@ "com.amazonaws.macie#UpdateS3ResourcesRequest": { "type": "structure", "members": { + "memberAccountId": { + "target": "com.amazonaws.macie#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The AWS ID of the Amazon Macie Classic member account whose S3 resources'\n classification types you want to update.

" + } + }, "s3ResourcesUpdate": { "target": "com.amazonaws.macie#S3ResourcesClassificationUpdate", "traits": { "smithy.api#documentation": "

The S3 resources whose classification types you want to update.

", "smithy.api#required": {} } - }, - "memberAccountId": { - "target": "com.amazonaws.macie#AWSAccountId", - "traits": { - "smithy.api#documentation": "

The AWS ID of the Amazon Macie Classic member account whose S3 resources'\n classification types you want to update.

" - } } } }, diff --git a/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json b/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json index 43077b7dd787..15839a370bf2 100644 --- a/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json +++ b/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json @@ -72,19 +72,19 @@ "com.amazonaws.macie2#AcceptInvitationRequest": { "type": "structure", "members": { - "invitationId": { + "masterAccount": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the invitation to accept.

", - "smithy.api#jsonName": "invitationId", + "smithy.api#documentation": "

The AWS account ID for the account that sent the invitation.

", + "smithy.api#jsonName": "masterAccount", "smithy.api#required": {} } }, - "masterAccount": { + "invitationId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The AWS account ID for the account that sent the invitation.

", - "smithy.api#jsonName": "masterAccount", + "smithy.api#documentation": "

The unique identifier for the invitation to accept.

", + "smithy.api#jsonName": "invitationId", "smithy.api#required": {} } } @@ -213,6 +213,13 @@ "com.amazonaws.macie2#ApiCallDetails": { "type": "structure", "members": { + "apiServiceName": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The URL of the AWS service that provides the operation, for example: s3.amazonaws.com.

", + "smithy.api#jsonName": "apiServiceName" + } + }, "lastSeen": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { @@ -227,13 +234,6 @@ "smithy.api#jsonName": "firstSeen" } }, - "apiServiceName": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The URL of the AWS service that provides the operation, for example: s3.amazonaws.com.

", - "smithy.api#jsonName": "apiServiceName" - } - }, "api": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -249,20 +249,6 @@ "com.amazonaws.macie2#AssumedRole": { "type": "structure", "members": { - "principalId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for the entity that was used to get the credentials.

", - "smithy.api#jsonName": "principalId" - } - }, - "accessKeyId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The AWS access key ID that identifies the credentials.

", - "smithy.api#jsonName": "accessKeyId" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -283,6 +269,20 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

", "smithy.api#jsonName": "arn" } + }, + "principalId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the entity that was used to get the credentials.

", + "smithy.api#jsonName": "principalId" + } + }, + "accessKeyId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The AWS access key ID that identifies the credentials.

", + "smithy.api#jsonName": "accessKeyId" + } } }, "traits": { @@ -292,18 +292,18 @@ "com.amazonaws.macie2#AwsAccount": { "type": "structure", "members": { - "principalId": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the entity that performed the action.

", - "smithy.api#jsonName": "principalId" + "smithy.api#documentation": "

The unique identifier for the AWS account.

", + "smithy.api#jsonName": "accountId" } }, - "accountId": { + "principalId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the AWS account.

", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "

The unique identifier for the entity that performed the action.

", + "smithy.api#jsonName": "principalId" } } }, @@ -329,18 +329,25 @@ "com.amazonaws.macie2#BatchGetCustomDataIdentifierSummary": { "type": "structure", "members": { - "arn": { + "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom data identifier.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The custom name of the custom data identifier.

", + "smithy.api#jsonName": "name" } }, - "id": { + "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the custom data identifier.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The custom description of the custom data identifier.

", + "smithy.api#jsonName": "description" + } + }, + "arn": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom data identifier.

", + "smithy.api#jsonName": "arn" } }, "deleted": { @@ -350,25 +357,18 @@ "smithy.api#jsonName": "deleted" } }, - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

", - "smithy.api#jsonName": "createdAt" - } - }, - "description": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The custom description of the custom data identifier.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The unique identifier for the custom data identifier.

", + "smithy.api#jsonName": "id" } }, - "name": { - "target": "com.amazonaws.macie2#__string", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The custom name of the custom data identifier.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

", + "smithy.api#jsonName": "createdAt" } } }, @@ -431,30 +431,30 @@ "com.amazonaws.macie2#BatchGetCustomDataIdentifiersResponse": { "type": "structure", "members": { - "customDataIdentifiers": { - "target": "com.amazonaws.macie2#__listOfBatchGetCustomDataIdentifierSummary", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each custom data identifier that meets the criteria specified in the request.

", - "smithy.api#jsonName": "customDataIdentifiers" - } - }, "notFoundIdentifierIds": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { "smithy.api#documentation": "

An array of identifiers, one for each identifier that was specified in the request, but doesn't correlate to an existing custom data identifier.

", "smithy.api#jsonName": "notFoundIdentifierIds" } + }, + "customDataIdentifiers": { + "target": "com.amazonaws.macie2#__listOfBatchGetCustomDataIdentifierSummary", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each custom data identifier that meets the criteria specified in the request.

", + "smithy.api#jsonName": "customDataIdentifiers" + } } } }, "com.amazonaws.macie2#BlockPublicAccess": { "type": "structure", "members": { - "restrictPublicBuckets": { + "ignorePublicAcls": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

", - "smithy.api#jsonName": "restrictPublicBuckets" + "smithy.api#documentation": "

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

", + "smithy.api#jsonName": "ignorePublicAcls" } }, "blockPublicAcls": { @@ -464,11 +464,11 @@ "smithy.api#jsonName": "blockPublicAcls" } }, - "ignorePublicAcls": { + "restrictPublicBuckets": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

", - "smithy.api#jsonName": "ignorePublicAcls" + "smithy.api#documentation": "

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

", + "smithy.api#jsonName": "restrictPublicBuckets" } }, "blockPublicPolicy": { @@ -486,11 +486,11 @@ "com.amazonaws.macie2#BucketCountByEffectivePermission": { "type": "structure", "members": { - "publiclyAccessible": { + "publiclyWritable": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of buckets that allow the general public to have read or write access to the bucket.

", - "smithy.api#jsonName": "publiclyAccessible" + "smithy.api#documentation": "

The total number of buckets that allow the general public to have write access to the bucket.

", + "smithy.api#jsonName": "publiclyWritable" } }, "publiclyReadable": { @@ -500,11 +500,18 @@ "smithy.api#jsonName": "publiclyReadable" } }, - "publiclyWritable": { + "unknown": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of buckets that allow the general public to have write access to the bucket.

", - "smithy.api#jsonName": "publiclyWritable" + "smithy.api#documentation": "

The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.

", + "smithy.api#jsonName": "unknown" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of buckets that allow the general public to have read or write access to the bucket.

", + "smithy.api#jsonName": "publiclyAccessible" } } }, @@ -515,18 +522,18 @@ "com.amazonaws.macie2#BucketCountByEncryptionType": { "type": "structure", "members": { - "kmsManaged": { + "unencrypted": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt objects. These buckets use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.

", - "smithy.api#jsonName": "kmsManaged" + "smithy.api#documentation": "

The total number of buckets that don't encrypt objects by default. Default encryption is disabled for these buckets.

", + "smithy.api#jsonName": "unencrypted" } }, - "unencrypted": { + "kmsManaged": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of buckets that don't encrypt objects by default. Default encryption is disabled for these buckets.

", - "smithy.api#jsonName": "unencrypted" + "smithy.api#documentation": "

The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt objects. These buckets use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.

", + "smithy.api#jsonName": "kmsManaged" } }, "s3Managed": { @@ -544,6 +551,13 @@ "com.amazonaws.macie2#BucketCountBySharedAccessType": { "type": "structure", "members": { + "notShared": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of buckets that aren't shared with other AWS accounts.

", + "smithy.api#jsonName": "notShared" + } + }, "external": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -551,11 +565,11 @@ "smithy.api#jsonName": "external" } }, - "notShared": { + "unknown": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of buckets that aren't shared with any other AWS accounts.

", - "smithy.api#jsonName": "notShared" + "smithy.api#documentation": "

The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other AWS accounts.

", + "smithy.api#jsonName": "unknown" } }, "internal": { @@ -585,13 +599,6 @@ "com.amazonaws.macie2#BucketCriteriaAdditionalProperties": { "type": "structure", "members": { - "eq": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

An equal to condition to apply to a specified attribute value for buckets.

", - "smithy.api#jsonName": "eq" - } - }, "prefix": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -599,6 +606,20 @@ "smithy.api#jsonName": "prefix" } }, + "neq": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "

A not equal to condition to apply to a specified attribute value for buckets.

", + "smithy.api#jsonName": "neq" + } + }, + "eq": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "

An equal to condition to apply to a specified attribute value for buckets.

", + "smithy.api#jsonName": "eq" + } + }, "lte": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -620,13 +641,6 @@ "smithy.api#jsonName": "lt" } }, - "neq": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

A not equal to condition to apply to a specified attribute value for buckets.

", - "smithy.api#jsonName": "neq" - } - }, "gte": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -642,6 +656,13 @@ "com.amazonaws.macie2#BucketLevelPermissions": { "type": "structure", "members": { + "bucketPolicy": { + "target": "com.amazonaws.macie2#BucketPolicy", + "traits": { + "smithy.api#documentation": "

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

", + "smithy.api#jsonName": "bucketPolicy" + } + }, "accessControlList": { "target": "com.amazonaws.macie2#AccessControlList", "traits": { @@ -655,111 +676,97 @@ "smithy.api#documentation": "

The block public access settings for the bucket.

", "smithy.api#jsonName": "blockPublicAccess" } - }, - "bucketPolicy": { - "target": "com.amazonaws.macie2#BucketPolicy", - "traits": { - "smithy.api#documentation": "

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

", - "smithy.api#jsonName": "bucketPolicy" - } } }, "traits": { - "smithy.api#documentation": "

Provides information about bucket-level permissions settings for an S3 bucket.

" + "smithy.api#documentation": "

Provides information about the bucket-level permissions settings for an S3 bucket.

" } }, "com.amazonaws.macie2#BucketMetadata": { "type": "structure", "members": { - "objectCount": { - "target": "com.amazonaws.macie2#__long", + "sharedAccess": { + "target": "com.amazonaws.macie2#SharedAccess", "traits": { - "smithy.api#documentation": "

The total number of objects in the bucket.

", - "smithy.api#jsonName": "objectCount" + "smithy.api#documentation": "

Specifies whether the bucket is shared with another AWS account. Possible values are:

", + "smithy.api#jsonName": "sharedAccess" } }, - "classifiableObjectCount": { - "target": "com.amazonaws.macie2#__long", + "lastUpdated": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a file format, file extension, or content type that Amazon Macie supports.

", - "smithy.api#jsonName": "classifiableObjectCount" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the bucket from Amazon S3.

", + "smithy.api#jsonName": "lastUpdated" } }, - "sizeInBytes": { + "classifiableObjectCount": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total storage size, in bytes, of the bucket.

", - "smithy.api#jsonName": "sizeInBytes" + "smithy.api#documentation": "

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "classifiableObjectCount" } }, - "sharedAccess": { - "target": "com.amazonaws.macie2#SharedAccess", + "objectCount": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

Specifies whether the bucket is shared with another AWS account. Valid values are:

", - "smithy.api#jsonName": "sharedAccess" + "smithy.api#documentation": "

The total number of objects in the bucket.

", + "smithy.api#jsonName": "objectCount" } }, - "bucketName": { + "region": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The name of the bucket.

", - "smithy.api#jsonName": "bucketName" + "smithy.api#documentation": "

The AWS Region that hosts the bucket.

", + "smithy.api#jsonName": "region" } }, - "objectCountByEncryptionType": { - "target": "com.amazonaws.macie2#ObjectCountByEncryptionType", + "sizeInBytesCompressed": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

", - "smithy.api#jsonName": "objectCountByEncryptionType" + "smithy.api#documentation": "

The total compressed storage size, in bytes, of the bucket.

", + "smithy.api#jsonName": "sizeInBytesCompressed" } }, - "replicationDetails": { - "target": "com.amazonaws.macie2#ReplicationDetails", + "unclassifiableObjectSizeInBytes": { + "target": "com.amazonaws.macie2#ObjectLevelStatistics", "traits": { - "smithy.api#documentation": "

Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.

", - "smithy.api#jsonName": "replicationDetails" + "smithy.api#documentation": "

The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "unclassifiableObjectSizeInBytes" } }, - "region": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The AWS Region that hosts the bucket.

", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "

The unique identifier for the AWS account that owns the bucket.

", + "smithy.api#jsonName": "accountId" } }, - "bucketCreatedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "tags": { + "target": "com.amazonaws.macie2#__listOfKeyValuePair", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

", - "smithy.api#jsonName": "bucketCreatedAt" + "smithy.api#documentation": "

An array that specifies the tags (keys and values) that are associated with the bucket.

", + "smithy.api#jsonName": "tags" } }, - "sizeInBytesCompressed": { - "target": "com.amazonaws.macie2#__long", + "unclassifiableObjectCount": { + "target": "com.amazonaws.macie2#ObjectLevelStatistics", "traits": { - "smithy.api#documentation": "

The total compressed storage size, in bytes, of the bucket.

", - "smithy.api#jsonName": "sizeInBytesCompressed" + "smithy.api#documentation": "

The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "unclassifiableObjectCount" } }, - "accountId": { - "target": "com.amazonaws.macie2#__string", + "replicationDetails": { + "target": "com.amazonaws.macie2#ReplicationDetails", "traits": { - "smithy.api#documentation": "

The unique identifier for the AWS account that's associated with the bucket.

", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "

Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.

", + "smithy.api#jsonName": "replicationDetails" } }, - "bucketArn": { + "bucketName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

", - "smithy.api#jsonName": "bucketArn" - } - }, - "tags": { - "target": "com.amazonaws.macie2#__listOfKeyValuePair", - "traits": { - "smithy.api#documentation": "

An array that specifies the tags (keys and values) that are associated with the bucket.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The name of the bucket.

", + "smithy.api#jsonName": "bucketName" } }, "publicAccess": { @@ -769,11 +776,25 @@ "smithy.api#jsonName": "publicAccess" } }, - "lastUpdated": { + "objectCountByEncryptionType": { + "target": "com.amazonaws.macie2#ObjectCountByEncryptionType", + "traits": { + "smithy.api#documentation": "

The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

", + "smithy.api#jsonName": "objectCountByEncryptionType" + } + }, + "sizeInBytes": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total storage size, in bytes, of the bucket.

", + "smithy.api#jsonName": "sizeInBytes" + } + }, + "bucketCreatedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed the bucket.

", - "smithy.api#jsonName": "lastUpdated" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

", + "smithy.api#jsonName": "bucketCreatedAt" } }, "versioning": { @@ -782,6 +803,20 @@ "smithy.api#documentation": "

Specifies whether versioning is enabled for the bucket.

", "smithy.api#jsonName": "versioning" } + }, + "bucketArn": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

", + "smithy.api#jsonName": "bucketArn" + } + }, + "classifiableSizeInBytes": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "classifiableSizeInBytes" + } } }, "traits": { @@ -791,23 +826,23 @@ "com.amazonaws.macie2#BucketPermissionConfiguration": { "type": "structure", "members": { - "bucketLevelPermissions": { - "target": "com.amazonaws.macie2#BucketLevelPermissions", - "traits": { - "smithy.api#documentation": "

The bucket-level permissions settings for the bucket.

", - "smithy.api#jsonName": "bucketLevelPermissions" - } - }, "accountLevelPermissions": { "target": "com.amazonaws.macie2#AccountLevelPermissions", "traits": { "smithy.api#documentation": "

The account-level permissions settings that apply to the bucket.

", "smithy.api#jsonName": "accountLevelPermissions" } + }, + "bucketLevelPermissions": { + "target": "com.amazonaws.macie2#BucketLevelPermissions", + "traits": { + "smithy.api#documentation": "

The bucket-level permissions settings for the bucket.

", + "smithy.api#jsonName": "bucketLevelPermissions" + } } }, "traits": { - "smithy.api#documentation": "

The account-level and bucket-level permissions settings for an S3 bucket.

" + "smithy.api#documentation": "

Provides information about the account-level and bucket-level permissions settings for an S3 bucket.

" } }, "com.amazonaws.macie2#BucketPolicy": { @@ -835,69 +870,114 @@ "com.amazonaws.macie2#BucketPublicAccess": { "type": "structure", "members": { - "effectivePermission": { - "target": "com.amazonaws.macie2#EffectivePermission", - "traits": { - "smithy.api#documentation": "

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are: PUBLIC, the bucket is publicly accessible; and, NOT_PUBLIC, the bucket isn't publicly accessible.

", - "smithy.api#jsonName": "effectivePermission" - } - }, "permissionConfiguration": { "target": "com.amazonaws.macie2#BucketPermissionConfiguration", "traits": { "smithy.api#documentation": "

The account-level and bucket-level permissions for the bucket.

", "smithy.api#jsonName": "permissionConfiguration" } + }, + "effectivePermission": { + "target": "com.amazonaws.macie2#EffectivePermission", + "traits": { + "smithy.api#documentation": "

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:

", + "smithy.api#jsonName": "effectivePermission" + } } }, "traits": { - "smithy.api#documentation": "

Provides information about permissions settings that determine whether an S3 bucket is publicly accessible.

" + "smithy.api#documentation": "

Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.

" } }, "com.amazonaws.macie2#BucketSortCriteria": { "type": "structure", "members": { + "orderBy": { + "target": "com.amazonaws.macie2#OrderBy", + "traits": { + "smithy.api#documentation": "

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

", + "smithy.api#jsonName": "orderBy" + } + }, "attributeName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The name of the attribute to sort the results by. This value can be the name of any property that Amazon Macie defines as bucket metadata, such as bucketName, accountId, or lastUpdated.

", + "smithy.api#documentation": "

The name of the attribute to sort the results by. This value can be the name of any property that Amazon Macie defines as bucket metadata, such as bucketName or accountId.

", "smithy.api#jsonName": "attributeName" } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies criteria for sorting the results of a query for information about S3 buckets.

" + } + }, + "com.amazonaws.macie2#Cell": { + "type": "structure", + "members": { + "row": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The row number of the row that contains the data.

", + "smithy.api#jsonName": "row" + } }, - "orderBy": { - "target": "com.amazonaws.macie2#OrderBy", + "column": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

", - "smithy.api#jsonName": "orderBy" + "smithy.api#documentation": "

The column number of the column that contains the data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier. For example, 1 for column A, 2 for column B, and so on.

", + "smithy.api#jsonName": "column" + } + }, + "cellReference": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.

", + "smithy.api#jsonName": "cellReference" + } + }, + "columnName": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The name of the column that contains the data, if available.

", + "smithy.api#jsonName": "columnName" } } }, "traits": { - "smithy.api#documentation": "

Specifies criteria for sorting the results of a query for information about S3 buckets.

" + "smithy.api#documentation": "

Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.

" + } + }, + "com.amazonaws.macie2#Cells": { + "type": "list", + "member": { + "target": "com.amazonaws.macie2#Cell" + }, + "traits": { + "smithy.api#documentation": "

Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.

" } }, "com.amazonaws.macie2#ClassificationDetails": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.macie2#__string", + "result": { + "target": "com.amazonaws.macie2#ClassificationResult", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the classification job that produced the finding.

", - "smithy.api#jsonName": "jobArn" + "smithy.api#documentation": "

The status and other details for the finding.

", + "smithy.api#jsonName": "result" } }, "detailedResultsLocation": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the file that contains the detailed record, including offsets, for the finding.

", + "smithy.api#documentation": "

The path to the folder or file (in Amazon S3) that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.

", "smithy.api#jsonName": "detailedResultsLocation" } }, - "result": { - "target": "com.amazonaws.macie2#ClassificationResult", + "jobArn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The status and detailed results of the finding.

", - "smithy.api#jsonName": "result" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the classification job that produced the finding.

", + "smithy.api#jsonName": "jobArn" } }, "jobId": { @@ -933,22 +1013,29 @@ "sensitiveData": { "target": "com.amazonaws.macie2#SensitiveData", "traits": { - "smithy.api#documentation": "

The category and number of occurrences of the sensitive data that produced the finding.

", + "smithy.api#documentation": "

The category, types, and number of occurrences of the sensitive data that produced the finding.

", "smithy.api#jsonName": "sensitiveData" } }, - "mimeType": { - "target": "com.amazonaws.macie2#__string", + "customDataIdentifiers": { + "target": "com.amazonaws.macie2#CustomDataIdentifiers", "traits": { - "smithy.api#documentation": "

The type of content, expressed as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe PDF file.

", - "smithy.api#jsonName": "mimeType" + "smithy.api#documentation": "

The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

", + "smithy.api#jsonName": "customDataIdentifiers" } }, - "sizeClassified": { - "target": "com.amazonaws.macie2#__long", + "additionalOccurrences": { + "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "

The total size, in bytes, of the data that the finding applies to.

", - "smithy.api#jsonName": "sizeClassified" + "smithy.api#documentation": "

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you to determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).

", + "smithy.api#jsonName": "additionalOccurrences" + } + }, + "mimeType": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

", + "smithy.api#jsonName": "mimeType" } }, "status": { @@ -958,33 +1045,33 @@ "smithy.api#jsonName": "status" } }, - "customDataIdentifiers": { - "target": "com.amazonaws.macie2#CustomDataIdentifiers", + "sizeClassified": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The number of occurrences of the data that produced the finding, and the custom data identifiers that detected the data.

", - "smithy.api#jsonName": "customDataIdentifiers" + "smithy.api#documentation": "

The total size, in bytes, of the data that the finding applies to.

", + "smithy.api#jsonName": "sizeClassified" } } }, "traits": { - "smithy.api#documentation": "

Provides detailed information about a sensitive data finding, including the types and number of occurrences of the sensitive data that was found.

" + "smithy.api#documentation": "

Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.

" } }, "com.amazonaws.macie2#ClassificationResultStatus": { "type": "structure", "members": { - "code": { + "reason": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The status of the finding, such as COMPLETE.

", - "smithy.api#jsonName": "code" + "smithy.api#documentation": "

A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.

", + "smithy.api#jsonName": "reason" } }, - "reason": { + "code": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.

", - "smithy.api#jsonName": "reason" + "smithy.api#documentation": "

The status of the finding. Possible values are:

", + "smithy.api#jsonName": "code" } } }, @@ -1052,26 +1139,33 @@ "com.amazonaws.macie2#CreateClassificationJobRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "jobType": { + "target": "com.amazonaws.macie2#JobType", "traits": { - "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The schedule for running the job. Valid values are:

", + "smithy.api#jsonName": "jobType", + "smithy.api#required": {} } }, - "s3JobDefinition": { - "target": "com.amazonaws.macie2#S3JobDefinition", + "initialRun": { + "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

", - "smithy.api#jsonName": "s3JobDefinition", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

", + "smithy.api#jsonName": "initialRun" } }, - "description": { - "target": "com.amazonaws.macie2#__string", + "samplingPercentage": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

A custom description of the job. The description can contain as many as 200 characters.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

", + "smithy.api#jsonName": "samplingPercentage" + } + }, + "scheduleFrequency": { + "target": "com.amazonaws.macie2#JobScheduleFrequency", + "traits": { + "smithy.api#documentation": "

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

", + "smithy.api#jsonName": "scheduleFrequency" } }, "name": { @@ -1082,18 +1176,11 @@ "smithy.api#required": {} } }, - "initialRun": { - "target": "com.amazonaws.macie2#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to run the job immediately, after it's created.

", - "smithy.api#jsonName": "initialRun" - } - }, - "jobType": { - "target": "com.amazonaws.macie2#JobType", + "s3JobDefinition": { + "target": "com.amazonaws.macie2#S3JobDefinition", "traits": { - "smithy.api#documentation": "

The schedule for running the job. Valid values are:

", - "smithy.api#jsonName": "jobType", + "smithy.api#documentation": "

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

", + "smithy.api#jsonName": "s3JobDefinition", "smithy.api#required": {} } }, @@ -1106,11 +1193,18 @@ "smithy.api#required": {} } }, - "scheduleFrequency": { - "target": "com.amazonaws.macie2#JobScheduleFrequency", + "tags": { + "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

", - "smithy.api#jsonName": "scheduleFrequency" + "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", + "smithy.api#jsonName": "tags" + } + }, + "description": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

A custom description of the job. The description can contain as many as 200 characters.

", + "smithy.api#jsonName": "description" } }, "customDataIdentifierIds": { @@ -1119,31 +1213,24 @@ "smithy.api#documentation": "

The custom data identifiers to use for data analysis and classification.

", "smithy.api#jsonName": "customDataIdentifierIds" } - }, - "samplingPercentage": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If the value is less than 100, Amazon Macie randomly selects the objects to analyze, up to the specified percentage.

", - "smithy.api#jsonName": "samplingPercentage" - } } } }, "com.amazonaws.macie2#CreateClassificationJobResponse": { "type": "structure", "members": { - "jobArn": { + "jobId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

", - "smithy.api#jsonName": "jobArn" + "smithy.api#documentation": "

The unique identifier for the job.

", + "smithy.api#jsonName": "jobId" } }, - "jobId": { + "jobArn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the job.

", - "smithy.api#jsonName": "jobId" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

", + "smithy.api#jsonName": "jobArn" } } } @@ -1191,13 +1278,21 @@ "com.amazonaws.macie2#CreateCustomDataIdentifierRequest": { "type": "structure", "members": { - "name": { + "clientToken": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.

", - "smithy.api#jsonName": "name" - } - }, + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "ignoreWords": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.

", + "smithy.api#jsonName": "ignoreWords" + } + }, "description": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -1205,19 +1300,25 @@ "smithy.api#jsonName": "description" } }, + "maximumMatchDistance": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.

", + "smithy.api#jsonName": "maximumMatchDistance" + } + }, "tags": { "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", + "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", "smithy.api#jsonName": "tags" } }, - "clientToken": { + "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" + "smithy.api#documentation": "

A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.

", + "smithy.api#jsonName": "name" } }, "regex": { @@ -1227,26 +1328,12 @@ "smithy.api#jsonName": "regex" } }, - "maximumMatchDistance": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.

", - "smithy.api#jsonName": "maximumMatchDistance" - } - }, "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters.

", + "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters. Keywords aren't case sensitive.

", "smithy.api#jsonName": "keywords" } - }, - "ignoreWords": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters.

", - "smithy.api#jsonName": "ignoreWords" - } } } }, @@ -1308,7 +1395,7 @@ "tags": { "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", + "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", "smithy.api#jsonName": "tags" } }, @@ -1319,14 +1406,6 @@ "smithy.api#jsonName": "description" } }, - "findingCriteria": { - "target": "com.amazonaws.macie2#FindingCriteria", - "traits": { - "smithy.api#documentation": "

The criteria to use to filter findings.

", - "smithy.api#jsonName": "findingCriteria", - "smithy.api#required": {} - } - }, "clientToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -1335,12 +1414,11 @@ "smithy.api#jsonName": "clientToken" } }, - "action": { - "target": "com.amazonaws.macie2#FindingsFilterAction", + "position": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

", - "smithy.api#jsonName": "action", - "smithy.api#required": {} + "smithy.api#documentation": "

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

", + "smithy.api#jsonName": "position" } }, "name": { @@ -1351,11 +1429,20 @@ "smithy.api#required": {} } }, - "position": { - "target": "com.amazonaws.macie2#__integer", + "action": { + "target": "com.amazonaws.macie2#FindingsFilterAction", "traits": { - "smithy.api#documentation": "

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

", - "smithy.api#jsonName": "position" + "smithy.api#documentation": "

The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

", + "smithy.api#jsonName": "action", + "smithy.api#required": {} + } + }, + "findingCriteria": { + "target": "com.amazonaws.macie2#FindingCriteria", + "traits": { + "smithy.api#documentation": "

The criteria to use to filter findings.

", + "smithy.api#jsonName": "findingCriteria", + "smithy.api#required": {} } } } @@ -1363,18 +1450,18 @@ "com.amazonaws.macie2#CreateFindingsFilterResponse": { "type": "structure", "members": { - "id": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the filter that was created.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the filter that was created.

", + "smithy.api#jsonName": "arn" } }, - "arn": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the filter that was created.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The unique identifier for the filter that was created.

", + "smithy.api#jsonName": "id" } } } @@ -1422,13 +1509,6 @@ "com.amazonaws.macie2#CreateInvitationsRequest": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.

", - "smithy.api#jsonName": "message" - } - }, "disableEmailNotification": { "target": "com.amazonaws.macie2#__boolean", "traits": { @@ -1436,6 +1516,13 @@ "smithy.api#jsonName": "disableEmailNotification" } }, + "message": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.

", + "smithy.api#jsonName": "message" + } + }, "accountIds": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { @@ -1501,13 +1588,6 @@ "com.amazonaws.macie2#CreateMemberRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.macie2#TagMap", - "traits": { - "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

An account can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", - "smithy.api#jsonName": "tags" - } - }, "account": { "target": "com.amazonaws.macie2#AccountDetail", "traits": { @@ -1515,6 +1595,13 @@ "smithy.api#jsonName": "account", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", + "smithy.api#jsonName": "tags" + } } } }, @@ -1601,32 +1688,25 @@ "com.amazonaws.macie2#CriterionAdditionalProperties": { "type": "structure", "members": { - "eq": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

An equal to condition to apply to a specified property value for findings.

", - "smithy.api#jsonName": "eq" - } - }, - "lte": { + "gte": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

A less than or equal to condition to apply to a specified property value for findings.

", - "smithy.api#jsonName": "lte" + "smithy.api#documentation": "

A greater than or equal to condition to apply to a specified property value for findings.

", + "smithy.api#jsonName": "gte" } }, - "gt": { + "lt": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

A greater than condition to apply to a specified property value for findings.

", - "smithy.api#jsonName": "gt" + "smithy.api#documentation": "

A less than condition to apply to a specified property value for findings.

", + "smithy.api#jsonName": "lt" } }, - "lt": { + "lte": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

A less than condition to apply to a specified property value for findings.

", - "smithy.api#jsonName": "lt" + "smithy.api#documentation": "

A less than or equal to condition to apply to a specified property value for findings.

", + "smithy.api#jsonName": "lte" } }, "neq": { @@ -1636,11 +1716,18 @@ "smithy.api#jsonName": "neq" } }, - "gte": { + "eq": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "

An equal to condition to apply to a specified property value for findings.

", + "smithy.api#jsonName": "eq" + } + }, + "gt": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

A greater than or equal to condition to apply to a specified property value for findings.

", - "smithy.api#jsonName": "gte" + "smithy.api#documentation": "

A greater than condition to apply to a specified property value for findings.

", + "smithy.api#jsonName": "gt" } } }, @@ -1663,25 +1750,25 @@ "com.amazonaws.macie2#CustomDataIdentifierSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.macie2#__string", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The custom name of the custom data identifier.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

", + "smithy.api#jsonName": "createdAt" } }, - "description": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The custom description of the custom data identifier.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The unique identifier for the custom data identifier.

", + "smithy.api#jsonName": "id" } }, - "id": { + "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the custom data identifier.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The custom name of the custom data identifier.

", + "smithy.api#jsonName": "name" } }, "arn": { @@ -1691,11 +1778,11 @@ "smithy.api#jsonName": "arn" } }, - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "description": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "

The custom description of the custom data identifier.

", + "smithy.api#jsonName": "description" } } }, @@ -1706,19 +1793,19 @@ "com.amazonaws.macie2#CustomDataIdentifiers": { "type": "structure", "members": { - "detections": { - "target": "com.amazonaws.macie2#CustomDetections", - "traits": { - "smithy.api#documentation": "

The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

", - "smithy.api#jsonName": "detections" - } - }, "totalCount": { "target": "com.amazonaws.macie2#__long", "traits": { "smithy.api#documentation": "

The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.

", "smithy.api#jsonName": "totalCount" } + }, + "detections": { + "target": "com.amazonaws.macie2#CustomDetections", + "traits": { + "smithy.api#documentation": "

The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

", + "smithy.api#jsonName": "detections" + } } }, "traits": { @@ -1728,11 +1815,11 @@ "com.amazonaws.macie2#CustomDetection": { "type": "structure", "members": { - "count": { - "target": "com.amazonaws.macie2#__long", + "arn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The total number of occurrences of the data that the custom data identifier detected for the finding.

", - "smithy.api#jsonName": "count" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom data identifier.

", + "smithy.api#jsonName": "arn" } }, "name": { @@ -1742,16 +1829,23 @@ "smithy.api#jsonName": "name" } }, - "arn": { - "target": "com.amazonaws.macie2#__string", + "occurrences": { + "target": "com.amazonaws.macie2#Occurrences", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom data identifier.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

", + "smithy.api#jsonName": "occurrences" + } + }, + "count": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of occurrences of the sensitive data that the custom data identifier detected.

", + "smithy.api#jsonName": "count" } } }, "traits": { - "smithy.api#documentation": "

Provides information about a custom data identifier that produced a sensitive data finding, and the number of occurrences of the data that it detected for the finding.

" + "smithy.api#documentation": "

Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.

" } }, "com.amazonaws.macie2#CustomDetections": { @@ -1873,23 +1967,30 @@ "com.amazonaws.macie2#DefaultDetection": { "type": "structure", "members": { - "count": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "

The total number of occurrences of the type of data that was detected.

", - "smithy.api#jsonName": "count" - } - }, "type": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The type of data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

", + "smithy.api#documentation": "

The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

", "smithy.api#jsonName": "type" } + }, + "occurrences": { + "target": "com.amazonaws.macie2#Occurrences", + "traits": { + "smithy.api#documentation": "

The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

", + "smithy.api#jsonName": "occurrences" + } + }, + "count": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of occurrences of the type of sensitive data that was detected.

", + "smithy.api#jsonName": "count" + } } }, "traits": { - "smithy.api#documentation": "

Provides information about sensitive data that was detected by managed data identifiers and produced a sensitive data finding.

" + "smithy.api#documentation": "

Provides information about a type of sensitive data that was detected by managed data identifiers and produced a sensitive data finding.

" } }, "com.amazonaws.macie2#DefaultDetections": { @@ -2174,26 +2275,18 @@ "method": "POST", "uri": "/datasources/s3", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "buckets", + "pageSize": "maxResults" } } }, "com.amazonaws.macie2#DescribeBucketsRequest": { "type": "structure", "members": { - "sortCriteria": { - "target": "com.amazonaws.macie2#BucketSortCriteria", - "traits": { - "smithy.api#documentation": "

The criteria to use to sort the query results.

", - "smithy.api#jsonName": "sortCriteria" - } - }, - "maxResults": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The maximum number of items to include in each page of the response. The default value is 50.

", - "smithy.api#jsonName": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -2207,6 +2300,20 @@ "smithy.api#documentation": "

The criteria to use to filter the query results.

", "smithy.api#jsonName": "criteria" } + }, + "sortCriteria": { + "target": "com.amazonaws.macie2#BucketSortCriteria", + "traits": { + "smithy.api#documentation": "

The criteria to use to sort the query results.

", + "smithy.api#jsonName": "sortCriteria" + } + }, + "maxResults": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to include in each page of the response. The default value is 50.

", + "smithy.api#jsonName": "maxResults" + } } } }, @@ -2261,7 +2368,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the status and settings for a classification job.

", + "smithy.api#documentation": "

Retrieves the status and settings for a classification job.

", "smithy.api#http": { "method": "GET", "uri": "/jobs/{jobId}", @@ -2285,11 +2392,18 @@ "com.amazonaws.macie2#DescribeClassificationJobResponse": { "type": "structure", "members": { - "jobType": { - "target": "com.amazonaws.macie2#JobType", + "tags": { + "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "

The schedule for running the job. Possible values are:

", - "smithy.api#jsonName": "jobType" + "smithy.api#documentation": "

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

", + "smithy.api#jsonName": "tags" + } + }, + "s3JobDefinition": { + "target": "com.amazonaws.macie2#S3JobDefinition", + "traits": { + "smithy.api#documentation": "

The S3 buckets that the job is configured to analyze, and the scope of that analysis.

", + "smithy.api#jsonName": "s3JobDefinition" } }, "clientToken": { @@ -2300,25 +2414,18 @@ "smithy.api#jsonName": "clientToken" } }, - "customDataIdentifierIds": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

The custom data identifiers that the job uses to analyze data.

", - "smithy.api#jsonName": "customDataIdentifierIds" - } - }, - "lastRunTime": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "statistics": { + "target": "com.amazonaws.macie2#Statistics", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the job last ran.

", - "smithy.api#jsonName": "lastRunTime" + "smithy.api#documentation": "

The number of times that the job has run and processing statistics for the job's current run.

", + "smithy.api#jsonName": "statistics" } }, - "jobArn": { - "target": "com.amazonaws.macie2#__string", + "userPausedDetails": { + "target": "com.amazonaws.macie2#UserPausedDetails", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

", - "smithy.api#jsonName": "jobArn" + "smithy.api#documentation": "

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

", + "smithy.api#jsonName": "userPausedDetails" } }, "description": { @@ -2328,39 +2435,32 @@ "smithy.api#jsonName": "description" } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "initialRun": { + "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.

", + "smithy.api#jsonName": "initialRun" } }, "samplingPercentage": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

The sampling depth, as a percentage, that the job applies when it processes objects.

", + "smithy.api#documentation": "

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

", "smithy.api#jsonName": "samplingPercentage" } }, - "initialRun": { - "target": "com.amazonaws.macie2#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the job has run for the first time.

", - "smithy.api#jsonName": "initialRun" - } - }, - "jobStatus": { - "target": "com.amazonaws.macie2#JobStatus", + "jobArn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The current status of the job. Possible values are:

", - "smithy.api#jsonName": "jobStatus" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

", + "smithy.api#jsonName": "jobArn" } }, - "s3JobDefinition": { - "target": "com.amazonaws.macie2#S3JobDefinition", + "customDataIdentifierIds": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

The S3 buckets that the job is configured to analyze, and the scope of that analysis.

", - "smithy.api#jsonName": "s3JobDefinition" + "smithy.api#documentation": "

The custom data identifiers that the job uses to analyze data.

", + "smithy.api#jsonName": "customDataIdentifierIds" } }, "createdAt": { @@ -2370,13 +2470,6 @@ "smithy.api#jsonName": "createdAt" } }, - "scheduleFrequency": { - "target": "com.amazonaws.macie2#JobScheduleFrequency", - "traits": { - "smithy.api#documentation": "

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

", - "smithy.api#jsonName": "scheduleFrequency" - } - }, "jobId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -2384,6 +2477,20 @@ "smithy.api#jsonName": "jobId" } }, + "lastRunTime": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the job last ran.

", + "smithy.api#jsonName": "lastRunTime" + } + }, + "jobType": { + "target": "com.amazonaws.macie2#JobType", + "traits": { + "smithy.api#documentation": "

The schedule for running the job. Possible values are:

", + "smithy.api#jsonName": "jobType" + } + }, "name": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -2391,11 +2498,18 @@ "smithy.api#jsonName": "name" } }, - "statistics": { - "target": "com.amazonaws.macie2#Statistics", + "scheduleFrequency": { + "target": "com.amazonaws.macie2#JobScheduleFrequency", "traits": { - "smithy.api#documentation": "

The number of times that the job has run and processing statistics for the job's most recent run.

", - "smithy.api#jsonName": "statistics" + "smithy.api#documentation": "

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

", + "smithy.api#jsonName": "scheduleFrequency" + } + }, + "jobStatus": { + "target": "com.amazonaws.macie2#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the job. Possible values are:

", + "smithy.api#jsonName": "jobStatus" } } } @@ -2432,7 +2546,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the Amazon Macie configuration settings for an AWS organization.

", + "smithy.api#documentation": "

Retrieves the Amazon Macie configuration settings for an AWS organization.

", "smithy.api#http": { "method": "GET", "uri": "/admin/configuration", @@ -2699,6 +2813,10 @@ { "value": "NOT_PUBLIC", "name": "NOT_PUBLIC" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" } ] } @@ -2746,6 +2864,13 @@ "com.amazonaws.macie2#EnableMacieRequest": { "type": "structure", "members": { + "status": { + "target": "com.amazonaws.macie2#MacieStatus", + "traits": { + "smithy.api#documentation": "

Specifies the status for the account. To enable Amazon Macie and start all Amazon Macie activities for the account, set this value to ENABLED.

", + "smithy.api#jsonName": "status" + } + }, "clientToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -2760,13 +2885,6 @@ "smithy.api#documentation": "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).", "smithy.api#jsonName": "findingPublishingFrequency" } - }, - "status": { - "target": "com.amazonaws.macie2#MacieStatus", - "traits": { - "smithy.api#documentation": "

Specifies the status for the account. To enable Amazon Macie and start all Amazon Macie activities for the account, set this value to ENABLED.

", - "smithy.api#jsonName": "status" - } } } }, @@ -2817,14 +2935,6 @@ "com.amazonaws.macie2#EnableOrganizationAdminAccountRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" - } - }, "adminAccountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -2832,6 +2942,14 @@ "smithy.api#jsonName": "adminAccountId", "smithy.api#required": {} } + }, + "clientToken": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } } } }, @@ -2842,7 +2960,7 @@ "com.amazonaws.macie2#EncryptionType": { "type": "string", "traits": { - "smithy.api#documentation": "

The type of server-side encryption that's used to encrypt objects in the S3 bucket. Valid values are:

", + "smithy.api#documentation": "

The type of server-side encryption that's used to encrypt an S3 object or objects in an S3 bucket. Valid values are:

", "smithy.api#enum": [ { "value": "NONE", @@ -2882,11 +3000,11 @@ "com.amazonaws.macie2#FederatedUser": { "type": "structure", "members": { - "sessionContext": { - "target": "com.amazonaws.macie2#SessionContext", + "accessKeyId": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The details of the session that was created for the credentials, including the entity that issued the session.

", - "smithy.api#jsonName": "sessionContext" + "smithy.api#documentation": "

The AWS access key ID that identifies the credentials.

", + "smithy.api#jsonName": "accessKeyId" } }, "accountId": { @@ -2896,6 +3014,13 @@ "smithy.api#jsonName": "accountId" } }, + "sessionContext": { + "target": "com.amazonaws.macie2#SessionContext", + "traits": { + "smithy.api#documentation": "

The details of the session that was created for the credentials, including the entity that issued the session.

", + "smithy.api#jsonName": "sessionContext" + } + }, "arn": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -2909,13 +3034,6 @@ "smithy.api#documentation": "

The unique identifier for the entity that was used to get the credentials.

", "smithy.api#jsonName": "principalId" } - }, - "accessKeyId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The AWS access key ID that identifies the credentials.

", - "smithy.api#jsonName": "accessKeyId" - } } }, "traits": { @@ -2925,27 +3043,27 @@ "com.amazonaws.macie2#Finding": { "type": "structure", "members": { - "id": { + "resourcesAffected": { + "target": "com.amazonaws.macie2#ResourcesAffected", + "traits": { + "smithy.api#documentation": "

The resources that the finding applies to.

", + "smithy.api#jsonName": "resourcesAffected" + } + }, + "region": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The AWS Region that Amazon Macie created the finding in.

", + "smithy.api#jsonName": "region" } }, "updatedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. Sensitive data findings aren't updated.

", + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.

", "smithy.api#jsonName": "updatedAt" } }, - "classificationDetails": { - "target": "com.amazonaws.macie2#ClassificationDetails", - "traits": { - "smithy.api#documentation": "

The details of a sensitive data finding. This value is null for a policy finding.

", - "smithy.api#jsonName": "classificationDetails" - } - }, "category": { "target": "com.amazonaws.macie2#FindingCategory", "traits": { @@ -2953,11 +3071,18 @@ "smithy.api#jsonName": "category" } }, - "resourcesAffected": { - "target": "com.amazonaws.macie2#ResourcesAffected", + "accountId": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The resources that the finding applies to.

", - "smithy.api#jsonName": "resourcesAffected" + "smithy.api#documentation": "

The unique identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.

", + "smithy.api#jsonName": "accountId" + } + }, + "classificationDetails": { + "target": "com.amazonaws.macie2#ClassificationDetails", + "traits": { + "smithy.api#documentation": "

The details of a sensitive data finding. This value is null for a policy finding.

", + "smithy.api#jsonName": "classificationDetails" } }, "createdAt": { @@ -2981,34 +3106,6 @@ "smithy.api#jsonName": "schemaVersion" } }, - "title": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The brief description of the finding.

", - "smithy.api#jsonName": "title" - } - }, - "count": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "

The total number of occurrences of this finding.

", - "smithy.api#jsonName": "count" - } - }, - "region": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The AWS Region that Amazon Macie created the finding in.

", - "smithy.api#jsonName": "region" - } - }, - "accountId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.

", - "smithy.api#jsonName": "accountId" - } - }, "sample": { "target": "com.amazonaws.macie2#__boolean", "traits": { @@ -3016,13 +3113,6 @@ "smithy.api#jsonName": "sample" } }, - "description": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The description of the finding.

", - "smithy.api#jsonName": "description" - } - }, "type": { "target": "com.amazonaws.macie2#FindingType", "traits": { @@ -3033,10 +3123,31 @@ "severity": { "target": "com.amazonaws.macie2#Severity", "traits": { - "smithy.api#documentation": "

The severity of the finding.

", + "smithy.api#documentation": "

The severity level and score for the finding.

", "smithy.api#jsonName": "severity" } }, + "policyDetails": { + "target": "com.amazonaws.macie2#PolicyDetails", + "traits": { + "smithy.api#documentation": "

The details of a policy finding. This value is null for a sensitive data finding.

", + "smithy.api#jsonName": "policyDetails" + } + }, + "title": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The brief description of the finding.

", + "smithy.api#jsonName": "title" + } + }, + "id": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

", + "smithy.api#jsonName": "id" + } + }, "archived": { "target": "com.amazonaws.macie2#__boolean", "traits": { @@ -3044,37 +3155,44 @@ "smithy.api#jsonName": "archived" } }, - "policyDetails": { - "target": "com.amazonaws.macie2#PolicyDetails", + "description": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The details of a policy finding. This value is null for a sensitive data finding.

", - "smithy.api#jsonName": "policyDetails" + "smithy.api#documentation": "

The description of the finding.

", + "smithy.api#jsonName": "description" + } + }, + "count": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of occurrences of the finding.

", + "smithy.api#jsonName": "count" } } }, "traits": { - "smithy.api#documentation": "

Provides information about a finding.

" + "smithy.api#documentation": "

Provides the details of a finding.

" } }, "com.amazonaws.macie2#FindingAction": { "type": "structure", "members": { - "actionType": { - "target": "com.amazonaws.macie2#FindingActionType", - "traits": { - "smithy.api#documentation": "

The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

", - "smithy.api#jsonName": "actionType" - } - }, "apiCallDetails": { "target": "com.amazonaws.macie2#ApiCallDetails", "traits": { "smithy.api#documentation": "

The invocation details of the API operation that an entity invoked for the affected resource, if the value for the actionType property is AWS_API_CALL.

", "smithy.api#jsonName": "apiCallDetails" } - } - }, - "traits": { + }, + "actionType": { + "target": "com.amazonaws.macie2#FindingActionType", + "traits": { + "smithy.api#documentation": "

The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

", + "smithy.api#jsonName": "actionType" + } + } + }, + "traits": { "smithy.api#documentation": "

Provides information about an action that occurred for a resource and produced a policy finding.

" } }, @@ -3093,6 +3211,13 @@ "com.amazonaws.macie2#FindingActor": { "type": "structure", "members": { + "userIdentity": { + "target": "com.amazonaws.macie2#UserIdentity", + "traits": { + "smithy.api#documentation": "

The type and other characteristics of the entity that performed the action on the affected resource.

", + "smithy.api#jsonName": "userIdentity" + } + }, "domainDetails": { "target": "com.amazonaws.macie2#DomainDetails", "traits": { @@ -3106,13 +3231,6 @@ "smithy.api#documentation": "

The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.

", "smithy.api#jsonName": "ipAddressDetails" } - }, - "userIdentity": { - "target": "com.amazonaws.macie2#UserIdentity", - "traits": { - "smithy.api#documentation": "

The type and other characteristics of the entity that performed the action on the affected resource.

", - "smithy.api#jsonName": "userIdentity" - } } }, "traits": { @@ -3189,19 +3307,19 @@ "com.amazonaws.macie2#FindingStatisticsSortCriteria": { "type": "structure", "members": { - "attributeName": { - "target": "com.amazonaws.macie2#FindingStatisticsSortAttributeName", - "traits": { - "smithy.api#documentation": "

The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.

", - "smithy.api#jsonName": "attributeName" - } - }, "orderBy": { "target": "com.amazonaws.macie2#OrderBy", "traits": { "smithy.api#documentation": "

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

", "smithy.api#jsonName": "orderBy" } + }, + "attributeName": { + "target": "com.amazonaws.macie2#FindingStatisticsSortAttributeName", + "traits": { + "smithy.api#documentation": "

The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.

", + "smithy.api#jsonName": "attributeName" + } } }, "traits": { @@ -3211,7 +3329,7 @@ "com.amazonaws.macie2#FindingType": { "type": "string", "traits": { - "smithy.api#documentation": "

The type of finding. Valid values are:

", + "smithy.api#documentation": "

The type of finding. For details about each type, see Types of Amazon Macie findings in the Amazon Macie User Guide. Valid values are:

", "smithy.api#enum": [ { "value": "SensitiveData:S3Object/Multiple", @@ -3275,13 +3393,6 @@ "com.amazonaws.macie2#FindingsFilterListItem": { "type": "structure", "members": { - "action": { - "target": "com.amazonaws.macie2#FindingsFilterAction", - "traits": { - "smithy.api#documentation": "

The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

", - "smithy.api#jsonName": "action" - } - }, "name": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -3296,11 +3407,11 @@ "smithy.api#jsonName": "arn" } }, - "id": { - "target": "com.amazonaws.macie2#__string", + "action": { + "target": "com.amazonaws.macie2#FindingsFilterAction", "traits": { - "smithy.api#documentation": "

The unique identifier for the filter.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

", + "smithy.api#jsonName": "action" } }, "tags": { @@ -3309,6 +3420,13 @@ "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

", "smithy.api#jsonName": "tags" } + }, + "id": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the filter.

", + "smithy.api#jsonName": "id" + } } }, "traits": { @@ -3370,32 +3488,25 @@ "com.amazonaws.macie2#GetBucketStatisticsResponse": { "type": "structure", "members": { - "bucketCountByEncryptionType": { - "target": "com.amazonaws.macie2#BucketCountByEncryptionType", - "traits": { - "smithy.api#documentation": "

The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that aren't encrypted.

", - "smithy.api#jsonName": "bucketCountByEncryptionType" - } - }, - "sizeInBytes": { - "target": "com.amazonaws.macie2#__long", + "unclassifiableObjectCount": { + "target": "com.amazonaws.macie2#ObjectLevelStatistics", "traits": { - "smithy.api#documentation": "

The total storage size, in bytes, of all the buckets.

", - "smithy.api#jsonName": "sizeInBytes" + "smithy.api#documentation": "

The total number of objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "unclassifiableObjectCount" } }, "lastUpdated": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed the buckets.

", + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the buckets from Amazon S3.

", "smithy.api#jsonName": "lastUpdated" } }, - "classifiableObjectCount": { + "bucketCount": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that Amazon Macie can analyze in all the buckets. These objects use a file format, file extension, or content type that Amazon Macie supports.

", - "smithy.api#jsonName": "classifiableObjectCount" + "smithy.api#documentation": "

The total number of buckets.

", + "smithy.api#jsonName": "bucketCount" } }, "bucketCountByEffectivePermission": { @@ -3405,18 +3516,46 @@ "smithy.api#jsonName": "bucketCountByEffectivePermission" } }, + "classifiableObjectCount": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "classifiableObjectCount" + } + }, + "unclassifiableObjectSizeInBytes": { + "target": "com.amazonaws.macie2#ObjectLevelStatistics", + "traits": { + "smithy.api#documentation": "

The total storage size, in bytes, of all the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "unclassifiableObjectSizeInBytes" + } + }, "objectCount": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects in all the buckets.

", + "smithy.api#documentation": "

The total number of objects in the buckets.

", "smithy.api#jsonName": "objectCount" } }, - "sizeInBytesCompressed": { + "bucketCountByEncryptionType": { + "target": "com.amazonaws.macie2#BucketCountByEncryptionType", + "traits": { + "smithy.api#documentation": "

The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that don't encrypt objects by default.

", + "smithy.api#jsonName": "bucketCountByEncryptionType" + } + }, + "classifiableSizeInBytes": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total compressed storage size, in bytes, of all the buckets.

", - "smithy.api#jsonName": "sizeInBytesCompressed" + "smithy.api#documentation": "

The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "classifiableSizeInBytes" + } + }, + "sizeInBytes": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total storage size, in bytes, of the buckets.

", + "smithy.api#jsonName": "sizeInBytes" } }, "bucketCountBySharedAccessType": { @@ -3426,11 +3565,11 @@ "smithy.api#jsonName": "bucketCountBySharedAccessType" } }, - "bucketCount": { + "sizeInBytesCompressed": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of buckets.

", - "smithy.api#jsonName": "bucketCount" + "smithy.api#documentation": "

The total compressed storage size, in bytes, of the buckets.

", + "smithy.api#jsonName": "sizeInBytesCompressed" } } } @@ -3523,7 +3662,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the criteria and other settings for a custom data identifier.

", + "smithy.api#documentation": "

Retrieves the criteria and other settings for a custom data identifier.

", "smithy.api#http": { "method": "GET", "uri": "/custom-data-identifiers/{id}", @@ -3547,32 +3686,32 @@ "com.amazonaws.macie2#GetCustomDataIdentifierResponse": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "keywords": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.

", + "smithy.api#jsonName": "keywords" } }, - "regex": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The regular expression (regex) that defines the pattern to match.

", - "smithy.api#jsonName": "regex" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom data identifier.

", + "smithy.api#jsonName": "arn" } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "maximumMatchDistance": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.

", + "smithy.api#jsonName": "maximumMatchDistance" } }, - "description": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The custom description of the custom data identifier.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The unique identifier for the custom data identifier.

", + "smithy.api#jsonName": "id" } }, "deleted": { @@ -3582,13 +3721,6 @@ "smithy.api#jsonName": "deleted" } }, - "maximumMatchDistance": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.

", - "smithy.api#jsonName": "maximumMatchDistance" - } - }, "name": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -3596,32 +3728,39 @@ "smithy.api#jsonName": "name" } }, - "keywords": { - "target": "com.amazonaws.macie2#__listOf__string", + "regex": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match.

", - "smithy.api#jsonName": "keywords" + "smithy.api#documentation": "

The regular expression (regex) that defines the pattern to match.

", + "smithy.api#jsonName": "regex" } }, - "arn": { + "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom data identifier.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The custom description of the custom data identifier.

", + "smithy.api#jsonName": "description" + } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

", + "smithy.api#jsonName": "tags" } }, "ignoreWords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it.

", + "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

", "smithy.api#jsonName": "ignoreWords" } }, - "id": { - "target": "com.amazonaws.macie2#__string", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The unique identifier for the custom data identifier.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

", + "smithy.api#jsonName": "createdAt" } } } @@ -3669,24 +3808,10 @@ "com.amazonaws.macie2#GetFindingStatisticsRequest": { "type": "structure", "members": { - "size": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The maximum number of items to include in each page of the response.

", - "smithy.api#jsonName": "size" - } - }, - "sortCriteria": { - "target": "com.amazonaws.macie2#FindingStatisticsSortCriteria", - "traits": { - "smithy.api#documentation": "

The criteria to use to sort the query results.

", - "smithy.api#jsonName": "sortCriteria" - } - }, "groupBy": { "target": "com.amazonaws.macie2#GroupBy", "traits": { - "smithy.api#documentation": "

The finding property to use to group the query results. Valid values are:

", + "smithy.api#documentation": "

The finding property to use to group the query results. Valid values are:

", "smithy.api#jsonName": "groupBy", "smithy.api#required": {} } @@ -3697,6 +3822,20 @@ "smithy.api#documentation": "

The criteria to use to filter the query results.

", "smithy.api#jsonName": "findingCriteria" } + }, + "size": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to include in each page of the response.

", + "smithy.api#jsonName": "size" + } + }, + "sortCriteria": { + "target": "com.amazonaws.macie2#FindingStatisticsSortCriteria", + "traits": { + "smithy.api#documentation": "

The criteria to use to sort the query results.

", + "smithy.api#jsonName": "sortCriteria" + } } } }, @@ -3744,7 +3883,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about one or more findings.

", + "smithy.api#documentation": "

Retrieves the details of one or more findings.

", "smithy.api#http": { "method": "POST", "uri": "/findings/describe", @@ -3784,7 +3923,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the criteria and other settings for a findings filter.

", + "smithy.api#documentation": "

Retrieves the criteria and other settings for a findings filter.

", "smithy.api#http": { "method": "GET", "uri": "/findingsfilters/{id}", @@ -3808,11 +3947,18 @@ "com.amazonaws.macie2#GetFindingsFilterResponse": { "type": "structure", "members": { - "arn": { + "position": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

", + "smithy.api#jsonName": "position" + } + }, + "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the filter.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The custom description of the filter.

", + "smithy.api#jsonName": "description" } }, "id": { @@ -3829,20 +3975,6 @@ "smithy.api#jsonName": "action" } }, - "description": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The custom description of the filter.

", - "smithy.api#jsonName": "description" - } - }, - "position": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

", - "smithy.api#jsonName": "position" - } - }, "findingCriteria": { "target": "com.amazonaws.macie2#FindingCriteria", "traits": { @@ -3850,11 +3982,11 @@ "smithy.api#jsonName": "findingCriteria" } }, - "name": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The custom name of the filter.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the filter.

", + "smithy.api#jsonName": "arn" } }, "tags": { @@ -3863,26 +3995,33 @@ "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

", "smithy.api#jsonName": "tags" } + }, + "name": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The custom name of the filter.

", + "smithy.api#jsonName": "name" + } } } }, "com.amazonaws.macie2#GetFindingsRequest": { "type": "structure", "members": { - "sortCriteria": { - "target": "com.amazonaws.macie2#SortCriteria", - "traits": { - "smithy.api#documentation": "

The criteria for sorting the results of the request.

", - "smithy.api#jsonName": "sortCriteria" - } - }, "findingIds": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array of strings that lists the unique identifiers for the findings to retrieve information about.

", + "smithy.api#documentation": "

An array of strings that lists the unique identifiers for the findings to retrieve.

", "smithy.api#jsonName": "findingIds", "smithy.api#required": {} } + }, + "sortCriteria": { + "target": "com.amazonaws.macie2#SortCriteria", + "traits": { + "smithy.api#documentation": "

The criteria for sorting the results of the request.

", + "smithy.api#jsonName": "sortCriteria" + } } } }, @@ -3986,7 +4125,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the current status and configuration settings for an Amazon Macie account.

", + "smithy.api#documentation": "

Retrieves the current status and configuration settings for an Amazon Macie account.

", "smithy.api#http": { "method": "GET", "uri": "/macie", @@ -4001,6 +4140,13 @@ "com.amazonaws.macie2#GetMacieSessionResponse": { "type": "structure", "members": { + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.

", + "smithy.api#jsonName": "createdAt" + } + }, "status": { "target": "com.amazonaws.macie2#MacieStatus", "traits": { @@ -4008,9 +4154,16 @@ "smithy.api#jsonName": "status" } }, - "findingPublishingFrequency": { - "target": "com.amazonaws.macie2#FindingPublishingFrequency", - "traits": { + "serviceRole": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in AWS resources for the account.

", + "smithy.api#jsonName": "serviceRole" + } + }, + "findingPublishingFrequency": { + "target": "com.amazonaws.macie2#FindingPublishingFrequency", + "traits": { "smithy.api#documentation": "

The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

", "smithy.api#jsonName": "findingPublishingFrequency" } @@ -4021,20 +4174,6 @@ "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.

", "smithy.api#jsonName": "updatedAt" } - }, - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.

", - "smithy.api#jsonName": "createdAt" - } - }, - "serviceRole": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in AWS resources for the account.

", - "smithy.api#jsonName": "serviceRole" - } } } }, @@ -4150,6 +4289,13 @@ "com.amazonaws.macie2#GetMemberResponse": { "type": "structure", "members": { + "relationshipStatus": { + "target": "com.amazonaws.macie2#RelationshipStatus", + "traits": { + "smithy.api#documentation": "

The current status of the relationship between the account and the master account.

", + "smithy.api#jsonName": "relationshipStatus" + } + }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4164,18 +4310,25 @@ "smithy.api#jsonName": "arn" } }, - "invitedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "tags": { + "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

", - "smithy.api#jsonName": "invitedAt" + "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.

", + "smithy.api#jsonName": "tags" } }, - "updatedAt": { + "masterAccountId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the master account.

", + "smithy.api#jsonName": "masterAccountId" + } + }, + "invitedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.

", - "smithy.api#jsonName": "updatedAt" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

", + "smithy.api#jsonName": "invitedAt" } }, "email": { @@ -4185,25 +4338,11 @@ "smithy.api#jsonName": "email" } }, - "relationshipStatus": { - "target": "com.amazonaws.macie2#RelationshipStatus", - "traits": { - "smithy.api#documentation": "

The current status of the relationship between the account and the master account.

", - "smithy.api#jsonName": "relationshipStatus" - } - }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", - "traits": { - "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.

", - "smithy.api#jsonName": "tags" - } - }, - "masterAccountId": { - "target": "com.amazonaws.macie2#__string", + "updatedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The AWS account ID for the master account.

", - "smithy.api#jsonName": "masterAccountId" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.

", + "smithy.api#jsonName": "updatedAt" } } } @@ -4245,19 +4384,18 @@ "method": "POST", "uri": "/usage/statistics", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "records", + "pageSize": "maxResults" } } }, "com.amazonaws.macie2#GetUsageStatisticsRequest": { "type": "structure", "members": { - "filterBy": { - "target": "com.amazonaws.macie2#__listOfUsageStatisticsFilter", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each condition to use to filter the query results. If the array contains more than one object, Amazon Macie uses an AND operator to join the conditions specified by the objects.

", - "smithy.api#jsonName": "filterBy" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4278,6 +4416,13 @@ "smithy.api#documentation": "

The criteria to use to sort the query results.

", "smithy.api#jsonName": "sortBy" } + }, + "filterBy": { + "target": "com.amazonaws.macie2#__listOfUsageStatisticsFilter", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each condition to use to filter the query results. If the array contains more than one object, Amazon Macie uses an AND operator to join the conditions specified by the objects.

", + "smithy.api#jsonName": "filterBy" + } } } }, @@ -4382,19 +4527,19 @@ "com.amazonaws.macie2#GroupCount": { "type": "structure", "members": { - "groupKey": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.

", - "smithy.api#jsonName": "groupKey" - } - }, "count": { "target": "com.amazonaws.macie2#__long", "traits": { "smithy.api#documentation": "

The total number of findings in the group of query results.

", "smithy.api#jsonName": "count" } + }, + "groupKey": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.

", + "smithy.api#jsonName": "groupKey" + } } }, "traits": { @@ -4404,32 +4549,32 @@ "com.amazonaws.macie2#IamUser": { "type": "structure", "members": { - "userName": { + "principalId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The user name of the IAM user who performed the action.

", - "smithy.api#jsonName": "userName" + "smithy.api#documentation": "

The unique identifier for the IAM user who performed the action.

", + "smithy.api#jsonName": "principalId" } }, - "arn": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The unique identifier for the AWS account that's associated with the IAM user who performed the action.

", + "smithy.api#jsonName": "accountId" } }, - "accountId": { + "userName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the AWS account that's associated with the IAM user who performed the action.

", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "

The user name of the IAM user who performed the action.

", + "smithy.api#jsonName": "userName" } }, - "principalId": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the IAM user who performed the action.

", - "smithy.api#jsonName": "principalId" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.

", + "smithy.api#jsonName": "arn" } } }, @@ -4457,20 +4602,6 @@ "com.amazonaws.macie2#Invitation": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The AWS account ID for the account that sent the invitation.

", - "smithy.api#jsonName": "accountId" - } - }, - "invitedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

", - "smithy.api#jsonName": "invitedAt" - } - }, "relationshipStatus": { "target": "com.amazonaws.macie2#RelationshipStatus", "traits": { @@ -4484,6 +4615,20 @@ "smithy.api#documentation": "

The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.

", "smithy.api#jsonName": "invitationId" } + }, + "accountId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the account that sent the invitation.

", + "smithy.api#jsonName": "accountId" + } + }, + "invitedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

", + "smithy.api#jsonName": "invitedAt" + } } }, "traits": { @@ -4493,11 +4638,11 @@ "com.amazonaws.macie2#IpAddressDetails": { "type": "structure", "members": { - "ipCity": { - "target": "com.amazonaws.macie2#IpCity", + "ipCountry": { + "target": "com.amazonaws.macie2#IpCountry", "traits": { - "smithy.api#documentation": "

The city that the IP address originated from.

", - "smithy.api#jsonName": "ipCity" + "smithy.api#documentation": "

The country that the IP address originated from.

", + "smithy.api#jsonName": "ipCountry" } }, "ipGeoLocation": { @@ -4507,11 +4652,18 @@ "smithy.api#jsonName": "ipGeoLocation" } }, - "ipCountry": { - "target": "com.amazonaws.macie2#IpCountry", + "ipAddressV4": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The country that the IP address originated from.

", - "smithy.api#jsonName": "ipCountry" + "smithy.api#documentation": "

The Internet Protocol version 4 (IPv4) address of the device.

", + "smithy.api#jsonName": "ipAddressV4" + } + }, + "ipCity": { + "target": "com.amazonaws.macie2#IpCity", + "traits": { + "smithy.api#documentation": "

The city that the IP address originated from.

", + "smithy.api#jsonName": "ipCity" } }, "ipOwner": { @@ -4520,13 +4672,6 @@ "smithy.api#documentation": "

The registered owner of the IP address.

", "smithy.api#jsonName": "ipOwner" } - }, - "ipAddressV4": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The Internet Protocol version 4 (IPv4) address of the device.

", - "smithy.api#jsonName": "ipAddressV4" - } } }, "traits": { @@ -4551,18 +4696,18 @@ "com.amazonaws.macie2#IpCountry": { "type": "structure", "members": { - "code": { + "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.

", - "smithy.api#jsonName": "code" + "smithy.api#documentation": "

The name of the country that the IP address originated from.

", + "smithy.api#jsonName": "name" } }, - "name": { + "code": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The name of the country that the IP address originated from.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.

", + "smithy.api#jsonName": "code" } } }, @@ -4595,6 +4740,13 @@ "com.amazonaws.macie2#IpOwner": { "type": "structure", "members": { + "org": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The name of the organization that owned the IP address.

", + "smithy.api#jsonName": "org" + } + }, "isp": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4609,13 +4761,6 @@ "smithy.api#jsonName": "asn" } }, - "org": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The name of the organization that owned the IP address.

", - "smithy.api#jsonName": "org" - } - }, "asnOrg": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4667,6 +4812,13 @@ "com.amazonaws.macie2#JobScheduleFrequency": { "type": "structure", "members": { + "dailySchedule": { + "target": "com.amazonaws.macie2#DailySchedule", + "traits": { + "smithy.api#documentation": "

Specifies a daily recurrence pattern for running the job.

", + "smithy.api#jsonName": "dailySchedule" + } + }, "weeklySchedule": { "target": "com.amazonaws.macie2#WeeklySchedule", "traits": { @@ -4680,13 +4832,6 @@ "smithy.api#documentation": "

Specifies a monthly recurrence pattern for running the job.

", "smithy.api#jsonName": "monthlySchedule" } - }, - "dailySchedule": { - "target": "com.amazonaws.macie2#DailySchedule", - "traits": { - "smithy.api#documentation": "

Specifies a daily recurrence pattern for running the job.

", - "smithy.api#jsonName": "dailySchedule" - } } }, "traits": { @@ -4696,19 +4841,19 @@ "com.amazonaws.macie2#JobScopeTerm": { "type": "structure", "members": { - "tagScopeTerm": { - "target": "com.amazonaws.macie2#TagScopeTerm", - "traits": { - "smithy.api#documentation": "

A tag-based condition that defines the operator and a tag key or tag keys and values for including or excluding an object from the job.

", - "smithy.api#jsonName": "tagScopeTerm" - } - }, "simpleScopeTerm": { "target": "com.amazonaws.macie2#SimpleScopeTerm", "traits": { "smithy.api#documentation": "

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job.

", "smithy.api#jsonName": "simpleScopeTerm" } + }, + "tagScopeTerm": { + "target": "com.amazonaws.macie2#TagScopeTerm", + "traits": { + "smithy.api#documentation": "

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job.

", + "smithy.api#jsonName": "tagScopeTerm" + } } }, "traits": { @@ -4727,7 +4872,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job.

" + "smithy.api#documentation": "

Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

" } }, "com.amazonaws.macie2#JobStatus": { @@ -4754,6 +4899,10 @@ { "value": "IDLE", "name": "IDLE" + }, + { + "value": "USER_PAUSED", + "name": "USER_PAUSED" } ] } @@ -4761,20 +4910,6 @@ "com.amazonaws.macie2#JobSummary": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the job was created.

", - "smithy.api#jsonName": "createdAt" - } - }, - "jobType": { - "target": "com.amazonaws.macie2#JobType", - "traits": { - "smithy.api#documentation": "

The schedule for running the job. Possible values are:

", - "smithy.api#jsonName": "jobType" - } - }, "jobId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4782,18 +4917,18 @@ "smithy.api#jsonName": "jobId" } }, - "jobStatus": { - "target": "com.amazonaws.macie2#JobStatus", + "userPausedDetails": { + "target": "com.amazonaws.macie2#UserPausedDetails", "traits": { - "smithy.api#documentation": "

The current status of the job. Possible values are:

", - "smithy.api#jsonName": "jobStatus" + "smithy.api#documentation": "

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

", + "smithy.api#jsonName": "userPausedDetails" } }, - "name": { - "target": "com.amazonaws.macie2#__string", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "

The custom name of the job.

", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the job was created.

", + "smithy.api#jsonName": "createdAt" } }, "bucketDefinitions": { @@ -4802,6 +4937,27 @@ "smithy.api#documentation": "

The S3 buckets that the job is configured to analyze.

", "smithy.api#jsonName": "bucketDefinitions" } + }, + "jobStatus": { + "target": "com.amazonaws.macie2#JobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the job. Possible values are:

", + "smithy.api#jsonName": "jobStatus" + } + }, + "jobType": { + "target": "com.amazonaws.macie2#JobType", + "traits": { + "smithy.api#documentation": "

The schedule for running the job. Possible values are:

", + "smithy.api#jsonName": "jobType" + } + }, + "name": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The custom name of the job.

", + "smithy.api#jsonName": "name" + } } }, "traits": { @@ -4892,12 +5048,25 @@ "method": "POST", "uri": "/jobs/list", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" } } }, "com.amazonaws.macie2#ListClassificationJobsRequest": { "type": "structure", "members": { + "sortCriteria": { + "target": "com.amazonaws.macie2#ListJobsSortCriteria", + "traits": { + "smithy.api#documentation": "

The criteria to use to sort the results.

", + "smithy.api#jsonName": "sortCriteria" + } + }, "filterCriteria": { "target": "com.amazonaws.macie2#ListJobsFilterCriteria", "traits": { @@ -4912,13 +5081,6 @@ "smithy.api#jsonName": "maxResults" } }, - "sortCriteria": { - "target": "com.amazonaws.macie2#ListJobsSortCriteria", - "traits": { - "smithy.api#documentation": "

The criteria to use to sort the results.

", - "smithy.api#jsonName": "sortCriteria" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4984,25 +5146,31 @@ "method": "POST", "uri": "/custom-data-identifiers/list", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "items", + "pageSize": "maxResults" } } }, "com.amazonaws.macie2#ListCustomDataIdentifiersRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The maximum number of items to include in each page of the response.

", - "smithy.api#jsonName": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The nextToken string that specifies which page of results to return in a paginated response.

", "smithy.api#jsonName": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to include in each page of the response.

", + "smithy.api#jsonName": "maxResults" + } } } }, @@ -5062,6 +5230,12 @@ "method": "POST", "uri": "/findings", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "findingIds", + "pageSize": "maxResults" } } }, @@ -5102,25 +5276,31 @@ "method": "GET", "uri": "/findingsfilters", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "findingsFilterListItems", + "pageSize": "maxResults" } } }, "com.amazonaws.macie2#ListFindingsFiltersRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.macie2#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to include in each page of a paginated response.

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The nextToken string that specifies which page of results to return in a paginated response.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.macie2#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to include in each page of a paginated response.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -5146,20 +5326,6 @@ "com.amazonaws.macie2#ListFindingsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "

The maximum number of items to include in each page of the response.

", - "smithy.api#jsonName": "maxResults" - } - }, - "sortCriteria": { - "target": "com.amazonaws.macie2#SortCriteria", - "traits": { - "smithy.api#documentation": "

The criteria to use to sort the results.

", - "smithy.api#jsonName": "sortCriteria" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -5173,25 +5339,39 @@ "smithy.api#documentation": "

The criteria to use to filter the results.

", "smithy.api#jsonName": "findingCriteria" } + }, + "sortCriteria": { + "target": "com.amazonaws.macie2#SortCriteria", + "traits": { + "smithy.api#documentation": "

The criteria to use to sort the results.

", + "smithy.api#jsonName": "sortCriteria" + } + }, + "maxResults": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to include in each page of the response.

", + "smithy.api#jsonName": "maxResults" + } } } }, "com.amazonaws.macie2#ListFindingsResponse": { "type": "structure", "members": { - "findingIds": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.

", - "smithy.api#jsonName": "findingIds" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

", "smithy.api#jsonName": "nextToken" } + }, + "findingIds": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "

An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.

", + "smithy.api#jsonName": "findingIds" + } } } }, @@ -5232,44 +5412,50 @@ "method": "GET", "uri": "/invitations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "invitations", + "pageSize": "maxResults" } } }, "com.amazonaws.macie2#ListInvitationsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The nextToken string that specifies which page of results to return in a paginated response.

", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.macie2#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to include in each page of a paginated response.

", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The nextToken string that specifies which page of results to return in a paginated response.

", + "smithy.api#httpQuery": "nextToken" + } } } }, "com.amazonaws.macie2#ListInvitationsResponse": { "type": "structure", "members": { - "invitations": { - "target": "com.amazonaws.macie2#__listOfInvitation", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each invitation that was received by the account.

", - "smithy.api#jsonName": "invitations" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

", "smithy.api#jsonName": "nextToken" } + }, + "invitations": { + "target": "com.amazonaws.macie2#__listOfInvitation", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each invitation that was received by the account.

", + "smithy.api#jsonName": "invitations" + } } } }, @@ -5322,13 +5508,6 @@ "com.amazonaws.macie2#ListJobsFilterTerm": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.macie2#ListJobsFilterKey", - "traits": { - "smithy.api#documentation": "

The property to use to filter the results.

", - "smithy.api#jsonName": "key" - } - }, "comparator": { "target": "com.amazonaws.macie2#JobComparator", "traits": { @@ -5342,6 +5521,13 @@ "smithy.api#documentation": "

An array that lists one or more values to use to filter the results.

", "smithy.api#jsonName": "values" } + }, + "key": { + "target": "com.amazonaws.macie2#ListJobsFilterKey", + "traits": { + "smithy.api#documentation": "

The property to use to filter the results.

", + "smithy.api#jsonName": "key" + } } }, "traits": { @@ -5431,6 +5617,12 @@ "method": "GET", "uri": "/members", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "members", + "pageSize": "maxResults" } } }, @@ -5444,18 +5636,18 @@ "smithy.api#httpQuery": "maxResults" } }, - "onlyAssociated": { + "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.

", - "smithy.api#httpQuery": "onlyAssociated" + "smithy.api#documentation": "

The nextToken string that specifies which page of results to return in a paginated response.

", + "smithy.api#httpQuery": "nextToken" } }, - "nextToken": { + "onlyAssociated": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The nextToken string that specifies which page of results to return in a paginated response.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.

", + "smithy.api#httpQuery": "onlyAssociated" } } } @@ -5463,19 +5655,19 @@ "com.amazonaws.macie2#ListMembersResponse": { "type": "structure", "members": { - "members": { - "target": "com.amazonaws.macie2#__listOfMember", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each account that's associated with the master account and meets the criteria specified by the onlyAssociated request parameter.

", - "smithy.api#jsonName": "members" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

", "smithy.api#jsonName": "nextToken" } + }, + "members": { + "target": "com.amazonaws.macie2#__listOfMember", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each account that's associated with the master account and meets the criteria specified by the onlyAssociated request parameter.

", + "smithy.api#jsonName": "members" + } } } }, @@ -5516,44 +5708,50 @@ "method": "GET", "uri": "/admin", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "adminAccounts", + "pageSize": "maxResults" } } }, "com.amazonaws.macie2#ListOrganizationAdminAccountsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.macie2#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to include in each page of a paginated response.

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The nextToken string that specifies which page of results to return in a paginated response.

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.macie2#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to include in each page of a paginated response.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.macie2#ListOrganizationAdminAccountsResponse": { "type": "structure", "members": { - "adminAccounts": { - "target": "com.amazonaws.macie2#__listOfAdminAccount", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each account that's designated as a delegated administrator of Amazon Macie for the AWS organization. Of those accounts, only one can have a status of ENABLED.

", - "smithy.api#jsonName": "adminAccounts" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

", "smithy.api#jsonName": "nextToken" } + }, + "adminAccounts": { + "target": "com.amazonaws.macie2#__listOfAdminAccount", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each account that's designated as a delegated administrator of Amazon Macie for the AWS organization. Of those accounts, only one can have a status of ENABLED.

", + "smithy.api#jsonName": "adminAccounts" + } } } }, @@ -5800,25 +5998,11 @@ "com.amazonaws.macie2#Member": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.macie2#TagMap", - "traits": { - "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.

", - "smithy.api#jsonName": "tags" - } - }, - "relationshipStatus": { - "target": "com.amazonaws.macie2#RelationshipStatus", - "traits": { - "smithy.api#documentation": "

The current status of the relationship between the account and the master account.

", - "smithy.api#jsonName": "relationshipStatus" - } - }, - "email": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The email address for the account.

", - "smithy.api#jsonName": "email" + "smithy.api#documentation": "

The AWS account ID for the account.

", + "smithy.api#jsonName": "accountId" } }, "masterAccountId": { @@ -5828,11 +6012,18 @@ "smithy.api#jsonName": "masterAccountId" } }, - "accountId": { - "target": "com.amazonaws.macie2#__string", + "tags": { + "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "

The AWS account ID for the account.

", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "

A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.

", + "smithy.api#jsonName": "tags" + } + }, + "updatedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.

", + "smithy.api#jsonName": "updatedAt" } }, "invitedAt": { @@ -5842,11 +6033,11 @@ "smithy.api#jsonName": "invitedAt" } }, - "updatedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "email": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.

", - "smithy.api#jsonName": "updatedAt" + "smithy.api#documentation": "

The email address for the account.

", + "smithy.api#jsonName": "email" } }, "arn": { @@ -5855,6 +6046,13 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account.

", "smithy.api#jsonName": "arn" } + }, + "relationshipStatus": { + "target": "com.amazonaws.macie2#RelationshipStatus", + "traits": { + "smithy.api#documentation": "

The current status of the relationship between the account and the master account.

", + "smithy.api#jsonName": "relationshipStatus" + } } }, "traits": { @@ -5867,7 +6065,7 @@ "dayOfMonth": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 30.

", + "smithy.api#documentation": "

The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.

If this value exceeds the number of days in a certain month, Macie runs the job on the last day of that month. For example, if this value is 31 and a month has only 30 days, Macie runs the job on day 30 of that month.

", "smithy.api#jsonName": "dayOfMonth" } } @@ -5879,11 +6077,18 @@ "com.amazonaws.macie2#ObjectCountByEncryptionType": { "type": "structure", "members": { - "unencrypted": { + "kmsManaged": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that aren't encrypted or use client-side encryption.

", - "smithy.api#jsonName": "unencrypted" + "smithy.api#documentation": "

The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.

", + "smithy.api#jsonName": "kmsManaged" + } + }, + "s3Managed": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of objects that are encrypted using an Amazon S3-managed key. The objects use Amazon S3-managed (SSE-S3) encryption.

", + "smithy.api#jsonName": "s3Managed" } }, "customerManaged": { @@ -5893,23 +6098,88 @@ "smithy.api#jsonName": "customerManaged" } }, - "s3Managed": { + "unencrypted": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that are encrypted using an Amazon S3-managed key. The objects use Amazon S3-managed (SSE-S3) encryption.

", - "smithy.api#jsonName": "s3Managed" + "smithy.api#documentation": "

The total number of objects that aren't encrypted or use client-side encryption.

", + "smithy.api#jsonName": "unencrypted" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.

" + } + }, + "com.amazonaws.macie2#ObjectLevelStatistics": { + "type": "structure", + "members": { + "total": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "total" } }, - "kmsManaged": { + "storageClass": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.

", - "smithy.api#jsonName": "kmsManaged" + "smithy.api#documentation": "

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

", + "smithy.api#jsonName": "storageClass" + } + }, + "fileType": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

", + "smithy.api#jsonName": "fileType" } } }, "traits": { - "smithy.api#documentation": "

Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.

" + "smithy.api#documentation": "

Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.

" + } + }, + "com.amazonaws.macie2#Occurrences": { + "type": "structure", + "members": { + "records": { + "target": "com.amazonaws.macie2#Records", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.

", + "smithy.api#jsonName": "records" + } + }, + "pages": { + "target": "com.amazonaws.macie2#Pages", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.

", + "smithy.api#jsonName": "pages" + } + }, + "lineRanges": { + "target": "com.amazonaws.macie2#Ranges", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.

", + "smithy.api#jsonName": "lineRanges" + } + }, + "cells": { + "target": "com.amazonaws.macie2#Cells", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.

", + "smithy.api#jsonName": "cells" + } + }, + "offsetRanges": { + "target": "com.amazonaws.macie2#Ranges", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the start of the file.

This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.

", + "smithy.api#jsonName": "offsetRanges" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.

" } }, "com.amazonaws.macie2#OrderBy": { @@ -5927,22 +6197,60 @@ ] } }, - "com.amazonaws.macie2#PolicyDetails": { + "com.amazonaws.macie2#Page": { "type": "structure", "members": { - "actor": { - "target": "com.amazonaws.macie2#FindingActor", + "pageNumber": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The entity that performed the action that produced the finding.

", - "smithy.api#jsonName": "actor" + "smithy.api#documentation": "

The page number of the page that contains the data.

", + "smithy.api#jsonName": "pageNumber" } }, + "lineRange": { + "target": "com.amazonaws.macie2#Range", + "traits": { + "smithy.api#documentation": "

The line that contains the data, and the position of the data on that line.

", + "smithy.api#jsonName": "lineRange" + } + }, + "offsetRange": { + "target": "com.amazonaws.macie2#Range", + "traits": { + "smithy.api#documentation": "

The position of the data on the page, relative to the start and end of the page.

", + "smithy.api#jsonName": "offsetRange" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.

" + } + }, + "com.amazonaws.macie2#Pages": { + "type": "list", + "member": { + "target": "com.amazonaws.macie2#Page" + }, + "traits": { + "smithy.api#documentation": "

Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.

" + } + }, + "com.amazonaws.macie2#PolicyDetails": { + "type": "structure", + "members": { "action": { "target": "com.amazonaws.macie2#FindingAction", "traits": { "smithy.api#documentation": "

The action that produced the finding.

", "smithy.api#jsonName": "action" } + }, + "actor": { + "target": "com.amazonaws.macie2#FindingActor", + "traits": { + "smithy.api#documentation": "

The entity that performed the action that produced the finding.

", + "smithy.api#jsonName": "actor" + } } }, "traits": { @@ -6014,6 +6322,68 @@ } } }, + "com.amazonaws.macie2#Range": { + "type": "structure", + "members": { + "startColumn": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The column number for the column that contains the data, if the file contains structured data.

", + "smithy.api#jsonName": "startColumn" + } + }, + "start": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

Possible values are:

", + "smithy.api#jsonName": "start" + } + }, + "end": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

Possible values are:

", + "smithy.api#jsonName": "end" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Apache Avro object container, Microsoft Word document, or non-binary text file.

" + } + }, + "com.amazonaws.macie2#Ranges": { + "type": "list", + "member": { + "target": "com.amazonaws.macie2#Range" + }, + "traits": { + "smithy.api#documentation": "

Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Apache Avro object container, Microsoft Word document, or non-binary text file.

" + } + }, + "com.amazonaws.macie2#Record": { + "type": "structure", + "members": { + "recordIndex": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The row index, starting from 0, for the row that contains the data.

", + "smithy.api#jsonName": "recordIndex" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the location of an occurrence of sensitive data in an Apache Parquet file.

" + } + }, + "com.amazonaws.macie2#Records": { + "type": "list", + "member": { + "target": "com.amazonaws.macie2#Record" + }, + "traits": { + "smithy.api#documentation": "

Specifies the location of occurrences of sensitive data in an Apache Parquet file.

" + } + }, "com.amazonaws.macie2#RelationshipStatus": { "type": "string", "traits": { @@ -6065,17 +6435,10 @@ "com.amazonaws.macie2#ReplicationDetails": { "type": "structure", "members": { - "replicated": { - "target": "com.amazonaws.macie2#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the bucket is configured to replicate one or more objects to any destination.

", - "smithy.api#jsonName": "replicated" - } - }, "replicatedExternally": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the bucket is configured to replicate one or more objects to an AWS account that isn't part of the Amazon Macie organization.

", + "smithy.api#documentation": "

Specifies whether the bucket is configured to replicate one or more objects to an AWS account that isn't part of the same Amazon Macie organization.

", "smithy.api#jsonName": "replicatedExternally" } }, @@ -6085,6 +6448,13 @@ "smithy.api#documentation": "

An array of AWS account IDs, one for each AWS account that the bucket is configured to replicate one or more objects to.

", "smithy.api#jsonName": "replicationAccounts" } + }, + "replicated": { + "target": "com.amazonaws.macie2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the bucket is configured to replicate one or more objects to any destination.

", + "smithy.api#jsonName": "replicated" + } } }, "traits": { @@ -6111,19 +6481,19 @@ "com.amazonaws.macie2#ResourcesAffected": { "type": "structure", "members": { - "s3Bucket": { - "target": "com.amazonaws.macie2#S3Bucket", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.

", - "smithy.api#jsonName": "s3Bucket" - } - }, "s3Object": { "target": "com.amazonaws.macie2#S3Object", "traits": { "smithy.api#documentation": "

An array of objects, one for each S3 object that the finding applies to. Each object provides a set of metadata about an affected S3 object.

", "smithy.api#jsonName": "s3Object" } + }, + "s3Bucket": { + "target": "com.amazonaws.macie2#S3Bucket", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.

", + "smithy.api#jsonName": "s3Bucket" + } } }, "traits": { @@ -6133,18 +6503,11 @@ "com.amazonaws.macie2#S3Bucket": { "type": "structure", "members": { - "owner": { - "target": "com.amazonaws.macie2#S3BucketOwner", - "traits": { - "smithy.api#documentation": "

The display name and account identifier for the user who owns the bucket.

", - "smithy.api#jsonName": "owner" - } - }, - "arn": { + "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The name of the bucket.

", + "smithy.api#jsonName": "name" } }, "createdAt": { @@ -6154,6 +6517,20 @@ "smithy.api#jsonName": "createdAt" } }, + "defaultServerSideEncryption": { + "target": "com.amazonaws.macie2#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The type of server-side encryption that's used by default to encrypt objects in the bucket.

", + "smithy.api#jsonName": "defaultServerSideEncryption" + } + }, + "owner": { + "target": "com.amazonaws.macie2#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The display name and account identifier for the user who owns the bucket.

", + "smithy.api#jsonName": "owner" + } + }, "publicAccess": { "target": "com.amazonaws.macie2#BucketPublicAccess", "traits": { @@ -6161,18 +6538,11 @@ "smithy.api#jsonName": "publicAccess" } }, - "name": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The name of the bucket.

", - "smithy.api#jsonName": "name" - } - }, - "defaultServerSideEncryption": { - "target": "com.amazonaws.macie2#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption settings for the bucket.

", - "smithy.api#jsonName": "defaultServerSideEncryption" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

", + "smithy.api#jsonName": "arn" } }, "tags": { @@ -6190,19 +6560,19 @@ "com.amazonaws.macie2#S3BucketDefinitionForJob": { "type": "structure", "members": { - "buckets": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

An array that lists the names of the buckets.

", - "smithy.api#jsonName": "buckets" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "

The unique identifier for the AWS account that owns one or more of the buckets. If specified, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.

", "smithy.api#jsonName": "accountId" } + }, + "buckets": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "

An array that lists the names of the buckets.

", + "smithy.api#jsonName": "buckets" + } } }, "traits": { @@ -6212,18 +6582,18 @@ "com.amazonaws.macie2#S3BucketOwner": { "type": "structure", "members": { - "id": { + "displayName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The AWS account ID for the user who owns the bucket.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The display name of the user who owns the bucket.

", + "smithy.api#jsonName": "displayName" } }, - "displayName": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The display name of the user who owns the bucket.

", - "smithy.api#jsonName": "displayName" + "smithy.api#documentation": "

The AWS account ID for the user who owns the bucket.

", + "smithy.api#jsonName": "id" } } }, @@ -6234,6 +6604,14 @@ "com.amazonaws.macie2#S3Destination": { "type": "structure", "members": { + "kmsKeyArn": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same AWS Region as the bucket.

", + "smithy.api#jsonName": "kmsKeyArn", + "smithy.api#required": {} + } + }, "bucketName": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -6248,14 +6626,6 @@ "smithy.api#documentation": "

The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.

", "smithy.api#jsonName": "keyPrefix" } - }, - "kmsKeyArn": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same AWS Region as the bucket.

", - "smithy.api#jsonName": "kmsKeyArn", - "smithy.api#required": {} - } } }, "traits": { @@ -6265,54 +6635,33 @@ "com.amazonaws.macie2#S3JobDefinition": { "type": "structure", "members": { - "bucketDefinitions": { - "target": "com.amazonaws.macie2#__listOfS3BucketDefinitionForJob", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each bucket that contains objects to analyze.

", - "smithy.api#jsonName": "bucketDefinitions" - } - }, "scoping": { "target": "com.amazonaws.macie2#Scoping", "traits": { "smithy.api#documentation": "

The property- and tag-based conditions that determine which objects to include or exclude from the analysis.

", "smithy.api#jsonName": "scoping" } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.

" - } - }, - "com.amazonaws.macie2#S3Object": { - "type": "structure", - "members": { - "bucketArn": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket that contains the object.

", - "smithy.api#jsonName": "bucketArn" - } }, - "extension": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The file extension of the object. If the object doesn't have a file extension, this value is \"\".

", - "smithy.api#jsonName": "extension" - } - }, - "versionId": { - "target": "com.amazonaws.macie2#__string", + "bucketDefinitions": { + "target": "com.amazonaws.macie2#__listOfS3BucketDefinitionForJob", "traits": { - "smithy.api#documentation": "

The identifier for the affected version of the object.

", - "smithy.api#jsonName": "versionId" + "smithy.api#documentation": "

An array of objects, one for each bucket that contains objects to analyze.

", + "smithy.api#jsonName": "bucketDefinitions" } - }, - "eTag": { - "target": "com.amazonaws.macie2#__string", + } + }, + "traits": { + "smithy.api#documentation": "

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.

" + } + }, + "com.amazonaws.macie2#S3Object": { + "type": "structure", + "members": { + "serverSideEncryption": { + "target": "com.amazonaws.macie2#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

", - "smithy.api#jsonName": "eTag" + "smithy.api#documentation": "

The type of server-side encryption that's used for the object.

", + "smithy.api#jsonName": "serverSideEncryption" } }, "path": { @@ -6322,13 +6671,6 @@ "smithy.api#jsonName": "path" } }, - "size": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "

The total storage size, in bytes, of the object.

", - "smithy.api#jsonName": "size" - } - }, "publicAccess": { "target": "com.amazonaws.macie2#__boolean", "traits": { @@ -6336,11 +6678,18 @@ "smithy.api#jsonName": "publicAccess" } }, - "storageClass": { - "target": "com.amazonaws.macie2#StorageClass", + "key": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The storage class of the object.

", - "smithy.api#jsonName": "storageClass" + "smithy.api#documentation": "

The full key (name) that's assigned to the object.

", + "smithy.api#jsonName": "key" + } + }, + "bucketArn": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket that contains the object.

", + "smithy.api#jsonName": "bucketArn" } }, "lastModified": { @@ -6350,11 +6699,25 @@ "smithy.api#jsonName": "lastModified" } }, - "serverSideEncryption": { - "target": "com.amazonaws.macie2#ServerSideEncryption", + "size": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The server-side encryption settings for the object.

", - "smithy.api#jsonName": "serverSideEncryption" + "smithy.api#documentation": "

The total storage size, in bytes, of the object.

", + "smithy.api#jsonName": "size" + } + }, + "eTag": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

", + "smithy.api#jsonName": "eTag" + } + }, + "versionId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the affected version of the object.

", + "smithy.api#jsonName": "versionId" } }, "tags": { @@ -6364,11 +6727,18 @@ "smithy.api#jsonName": "tags" } }, - "key": { + "storageClass": { + "target": "com.amazonaws.macie2#StorageClass", + "traits": { + "smithy.api#documentation": "

The storage class of the object.

", + "smithy.api#jsonName": "storageClass" + } + }, + "extension": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The full key (name) that's assigned to the object.

", - "smithy.api#jsonName": "key" + "smithy.api#documentation": "

The file name extension of the object. If the object doesn't have a file name extension, this value is \"\".

", + "smithy.api#jsonName": "extension" } } }, @@ -6407,23 +6777,23 @@ "com.amazonaws.macie2#Scoping": { "type": "structure", "members": { - "excludes": { + "includes": { "target": "com.amazonaws.macie2#JobScopingBlock", "traits": { - "smithy.api#documentation": "

The property- or tag-based conditions that determine which objects to exclude from the analysis.

", - "smithy.api#jsonName": "excludes" + "smithy.api#documentation": "

The property- or tag-based conditions that determine which objects to include in the analysis.

", + "smithy.api#jsonName": "includes" } }, - "includes": { + "excludes": { "target": "com.amazonaws.macie2#JobScopingBlock", "traits": { - "smithy.api#documentation": "

The property- or tag-based conditions that determine which objects to include in the analysis.

", - "smithy.api#jsonName": "includes" + "smithy.api#documentation": "

The property- or tag-based conditions that determine which objects to exclude from the analysis.

", + "smithy.api#jsonName": "excludes" } } }, "traits": { - "smithy.api#documentation": "

Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes.

" + "smithy.api#documentation": "

Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.

" } }, "com.amazonaws.macie2#SensitiveData": { @@ -6438,30 +6808,30 @@ "com.amazonaws.macie2#SensitiveDataItem": { "type": "structure", "members": { - "totalCount": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "

The total number of occurrences of the sensitive data that was detected.

", - "smithy.api#jsonName": "totalCount" - } - }, "category": { "target": "com.amazonaws.macie2#SensitiveDataItemCategory", "traits": { - "smithy.api#documentation": "

The category of sensitive data that was detected. For example: FINANCIAL_INFORMATION, for financial information such as credit card numbers; PERSONAL_INFORMATION, for personally identifiable information such as full names and mailing addresses; or, CUSTOM_IDENTIFIER, for data that was detected by a custom data identifier.

", + "smithy.api#documentation": "

The category of sensitive data that was detected. For example: FINANCIAL_INFORMATION, for financial information such as credit card numbers; PERSONAL_INFORMATION, for personally identifiable information, such as full names and mailing addresses, or personal health information; or, CUSTOM_IDENTIFIER, for data that was detected by a custom data identifier.

", "smithy.api#jsonName": "category" } }, "detections": { "target": "com.amazonaws.macie2#DefaultDetections", "traits": { - "smithy.api#documentation": "

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected.

", + "smithy.api#documentation": "

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

", "smithy.api#jsonName": "detections" } + }, + "totalCount": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The total number of occurrences of the sensitive data that was detected.

", + "smithy.api#jsonName": "totalCount" + } } }, "traits": { - "smithy.api#documentation": "

Provides information about the category, type, and number of occurrences of sensitive data that produced a finding.

" + "smithy.api#documentation": "

Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.

" } }, "com.amazonaws.macie2#SensitiveDataItemCategory": { @@ -6491,28 +6861,35 @@ "com.amazonaws.macie2#ServerSideEncryption": { "type": "structure", "members": { + "kmsMasterKeyId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if AWS KMS isn't used to encrypt the bucket or object.

", + "smithy.api#jsonName": "kmsMasterKeyId" + } + }, "encryptionType": { "target": "com.amazonaws.macie2#EncryptionType", "traits": { "smithy.api#documentation": "

The server-side encryption algorithm that's used when storing data in the bucket or object. If encryption is disabled for the bucket or object, this value is NONE.

", "smithy.api#jsonName": "encryptionType" } - }, - "kmsMasterKeyId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if KMS isn't used to encrypt the bucket or object.

", - "smithy.api#jsonName": "kmsMasterKeyId" - } } }, "traits": { - "smithy.api#documentation": "

Provides information about the server-side encryption settings for an S3 bucket or object.

" + "smithy.api#documentation": "

Provides information about the server-side encryption settings for an S3 bucket or S3 object.

" } }, "com.amazonaws.macie2#ServiceLimit": { "type": "structure", "members": { + "value": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The value for the metric specified by the UsageByAccount.type field in the response.

", + "smithy.api#jsonName": "value" + } + }, "isServiceLimited": { "target": "com.amazonaws.macie2#__boolean", "traits": { @@ -6526,13 +6903,6 @@ "smithy.api#documentation": "

The unit of measurement for the value specified by the value field.

", "smithy.api#jsonName": "unit" } - }, - "value": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "

The value for the metric specified by the UsageByAccount.type field in the response.

", - "smithy.api#jsonName": "value" - } } }, "traits": { @@ -6559,19 +6929,19 @@ "com.amazonaws.macie2#SessionContext": { "type": "structure", "members": { - "attributes": { - "target": "com.amazonaws.macie2#SessionContextAttributes", - "traits": { - "smithy.api#documentation": "

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

", - "smithy.api#jsonName": "attributes" - } - }, "sessionIssuer": { "target": "com.amazonaws.macie2#SessionIssuer", "traits": { "smithy.api#documentation": "

The source and type of credentials that were issued to the entity.

", "smithy.api#jsonName": "sessionIssuer" } + }, + "attributes": { + "target": "com.amazonaws.macie2#SessionContextAttributes", + "traits": { + "smithy.api#documentation": "

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

", + "smithy.api#jsonName": "attributes" + } } }, "traits": { @@ -6581,19 +6951,19 @@ "com.amazonaws.macie2#SessionContextAttributes": { "type": "structure", "members": { - "mfaAuthenticated": { - "target": "com.amazonaws.macie2#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

", - "smithy.api#jsonName": "mfaAuthenticated" - } - }, "creationDate": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { "smithy.api#documentation": "

The date and time, in UTC and ISO 8601 format, when the credentials were issued.

", "smithy.api#jsonName": "creationDate" } + }, + "mfaAuthenticated": { + "target": "com.amazonaws.macie2#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

", + "smithy.api#jsonName": "mfaAuthenticated" + } } }, "traits": { @@ -6603,11 +6973,18 @@ "com.amazonaws.macie2#SessionIssuer": { "type": "structure", "members": { - "accountId": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the AWS account that owns the entity that was used to get the credentials.

", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.

", + "smithy.api#jsonName": "arn" + } + }, + "principalId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the entity that was used to get the credentials.

", + "smithy.api#jsonName": "principalId" } }, "type": { @@ -6624,18 +7001,11 @@ "smithy.api#jsonName": "userName" } }, - "arn": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.

", - "smithy.api#jsonName": "arn" - } - }, - "principalId": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the entity that was used to get the credentials.

", - "smithy.api#jsonName": "principalId" + "smithy.api#documentation": "

The unique identifier for the AWS account that owns the entity that was used to get the credentials.

", + "smithy.api#jsonName": "accountId" } } }, @@ -6646,29 +7016,29 @@ "com.amazonaws.macie2#Severity": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.macie2#SeverityDescription", - "traits": { - "smithy.api#documentation": "

The textual representation of the severity value, such as Low or High.

", - "smithy.api#jsonName": "description" - } - }, "score": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "

The numeric score for the severity value, ranging from 0 (least severe) to 4 (most severe).

", + "smithy.api#documentation": "

The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).

", "smithy.api#jsonName": "score" } + }, + "description": { + "target": "com.amazonaws.macie2#SeverityDescription", + "traits": { + "smithy.api#documentation": "

The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).

", + "smithy.api#jsonName": "description" + } } }, "traits": { - "smithy.api#documentation": "

Provides the numeric score and textual representation of a severity value.

" + "smithy.api#documentation": "

Provides the numerical and qualitative representations of a finding's severity.

" } }, "com.amazonaws.macie2#SeverityDescription": { "type": "string", "traits": { - "smithy.api#documentation": "

The textual representation of the finding's severity. Possible values are:

", + "smithy.api#documentation": "

The qualitative representation of the finding's severity. Possible values are:

", "smithy.api#enum": [ { "value": "Low", @@ -6700,6 +7070,10 @@ { "value": "NOT_SHARED", "name": "NOT_SHARED" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" } ] } @@ -6707,26 +7081,26 @@ "com.amazonaws.macie2#SimpleScopeTerm": { "type": "structure", "members": { + "key": { + "target": "com.amazonaws.macie2#ScopeFilterKey", + "traits": { + "smithy.api#documentation": "

The object property to use in the condition.

", + "smithy.api#jsonName": "key" + } + }, "comparator": { "target": "com.amazonaws.macie2#JobComparator", "traits": { - "smithy.api#documentation": "

The operator to use in the condition.

", + "smithy.api#documentation": "

The operator to use in the condition. Valid operators for each supported property (key) are:

", "smithy.api#jsonName": "comparator" } }, "values": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists one or more values to use in the condition.

", + "smithy.api#documentation": "

An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION, this array can specify multiple values and Amazon Macie uses an OR operator to join the values. Otherwise, this array can specify only one value. Valid values for each supported property (key) are:

", "smithy.api#jsonName": "values" } - }, - "key": { - "target": "com.amazonaws.macie2#ScopeFilterKey", - "traits": { - "smithy.api#documentation": "

The property to use in the condition.

", - "smithy.api#jsonName": "key" - } } }, "traits": { @@ -6736,40 +7110,40 @@ "com.amazonaws.macie2#SortCriteria": { "type": "structure", "members": { - "attributeName": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

", - "smithy.api#jsonName": "attributeName" - } - }, "orderBy": { "target": "com.amazonaws.macie2#OrderBy", "traits": { "smithy.api#documentation": "

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

", "smithy.api#jsonName": "orderBy" } + }, + "attributeName": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

", + "smithy.api#jsonName": "attributeName" + } } }, "traits": { - "smithy.api#documentation": "

Specifies criteria for sorting the results of a request for information about findings.

" + "smithy.api#documentation": "

Specifies criteria for sorting the results of a request for findings.

" } }, "com.amazonaws.macie2#Statistics": { "type": "structure", "members": { - "approximateNumberOfObjectsToProcess": { + "numberOfRuns": { "target": "com.amazonaws.macie2#__double", "traits": { - "smithy.api#documentation": "

The approximate number of objects that the job has yet to process during its current run.

", - "smithy.api#jsonName": "approximateNumberOfObjectsToProcess" + "smithy.api#documentation": "

The number of times that the job has run.

", + "smithy.api#jsonName": "numberOfRuns" } }, - "numberOfRuns": { + "approximateNumberOfObjectsToProcess": { "target": "com.amazonaws.macie2#__double", "traits": { - "smithy.api#documentation": "

The number of times that the job has run.

", - "smithy.api#jsonName": "numberOfRuns" + "smithy.api#documentation": "

The approximate number of objects that the job has yet to process during its current run.

", + "smithy.api#jsonName": "approximateNumberOfObjectsToProcess" } } }, @@ -6780,7 +7154,7 @@ "com.amazonaws.macie2#StorageClass": { "type": "string", "traits": { - "smithy.api#documentation": "

The storage class of the S3 bucket or object. Possible values are:

", + "smithy.api#documentation": "

The storage class of the S3 object. Possible values are:

", "smithy.api#enum": [ { "value": "STANDARD", @@ -6845,14 +7219,6 @@ "com.amazonaws.macie2#TagResourceRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.macie2#TagMap", - "traits": { - "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the resource.

A resource can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -6860,6 +7226,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specifies the tags to associate with the resource.

A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } } } }, @@ -6870,11 +7244,11 @@ "com.amazonaws.macie2#TagScopeTerm": { "type": "structure", "members": { - "tagValues": { - "target": "com.amazonaws.macie2#__listOfTagValuePair", + "target": { + "target": "com.amazonaws.macie2#TagTarget", "traits": { - "smithy.api#documentation": "

The tag key and value pairs to use in the condition.

", - "smithy.api#jsonName": "tagValues" + "smithy.api#documentation": "

The type of object to apply the condition to.

", + "smithy.api#jsonName": "target" } }, "key": { @@ -6884,19 +7258,19 @@ "smithy.api#jsonName": "key" } }, - "target": { - "target": "com.amazonaws.macie2#TagTarget", - "traits": { - "smithy.api#documentation": "

The type of object to apply the condition to.

", - "smithy.api#jsonName": "target" - } - }, "comparator": { "target": "com.amazonaws.macie2#JobComparator", "traits": { - "smithy.api#documentation": "

The operator to use in the condition.

", + "smithy.api#documentation": "

The operator to use in the condition. Valid operators are EQ (equals) or NE (not equals).

", "smithy.api#jsonName": "comparator" } + }, + "tagValues": { + "target": "com.amazonaws.macie2#__listOfTagValuePair", + "traits": { + "smithy.api#documentation": "

The tag keys or tag key and value pairs to use in the condition.

", + "smithy.api#jsonName": "tagValues" + } } }, "traits": { @@ -6921,7 +7295,7 @@ "value": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The tag value, associated with the specified tag key, to use in the condition.

", + "smithy.api#documentation": "

The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

", "smithy.api#jsonName": "value" } }, @@ -6934,7 +7308,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a tag key and value, as a pair, to use in a tag-based condition for a classification job.

" + "smithy.api#documentation": "

Specifies a tag key or tag key and value pair to use in a tag-based condition for a classification job.

" } }, "com.amazonaws.macie2#TestCustomDataIdentifier": { @@ -6980,33 +7354,25 @@ "com.amazonaws.macie2#TestCustomDataIdentifierRequest": { "type": "structure", "members": { - "regex": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

", - "smithy.api#jsonName": "regex", - "smithy.api#required": {} - } - }, - "ignoreWords": { - "target": "com.amazonaws.macie2#__listOf__string", + "maximumMatchDistance": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters.

", - "smithy.api#jsonName": "ignoreWords" + "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.

", + "smithy.api#jsonName": "maximumMatchDistance" } }, "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters.

", + "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters. Keywords aren't case sensitive.

", "smithy.api#jsonName": "keywords" } }, - "maximumMatchDistance": { - "target": "com.amazonaws.macie2#__integer", + "ignoreWords": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.

", - "smithy.api#jsonName": "maximumMatchDistance" + "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.

", + "smithy.api#jsonName": "ignoreWords" } }, "sampleText": { @@ -7016,6 +7382,14 @@ "smithy.api#jsonName": "sampleText", "smithy.api#required": {} } + }, + "regex": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

", + "smithy.api#jsonName": "regex", + "smithy.api#required": {} + } } } }, @@ -7062,13 +7436,6 @@ "com.amazonaws.macie2#UnprocessedAccount": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The AWS account ID for the account that the request applies to.

", - "smithy.api#jsonName": "accountId" - } - }, "errorMessage": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -7082,6 +7449,13 @@ "smithy.api#documentation": "

The source of the issue or delay in processing the request.

", "smithy.api#jsonName": "errorCode" } + }, + "accountId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the account that the request applies to.

", + "smithy.api#jsonName": "accountId" + } } }, "traits": { @@ -7108,14 +7482,6 @@ "com.amazonaws.macie2#UntagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "tagKeys": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { @@ -7123,6 +7489,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "resourceArn": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -7162,7 +7536,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a classification job.

", + "smithy.api#documentation": "

Changes the status of a classification job.

", "smithy.api#http": { "method": "PATCH", "uri": "/jobs/{jobId}", @@ -7184,7 +7558,7 @@ "jobStatus": { "target": "com.amazonaws.macie2#JobStatus", "traits": { - "smithy.api#documentation": "

The status to change the job's status to. The only supported value is CANCELLED, which cancels the job completely.

", + "smithy.api#documentation": "

The new status for the job. Valid values are:

", "smithy.api#jsonName": "jobStatus", "smithy.api#required": {} } @@ -7238,11 +7612,12 @@ "com.amazonaws.macie2#UpdateFindingsFilterRequest": { "type": "structure", "members": { - "description": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.

", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

The unique identifier for the Amazon Macie resource or account that the request applies to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "position": { @@ -7252,21 +7627,6 @@ "smithy.api#jsonName": "position" } }, - "name": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.

", - "smithy.api#jsonName": "name" - } - }, - "id": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Amazon Macie resource or account that the request applies to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "action": { "target": "com.amazonaws.macie2#FindingsFilterAction", "traits": { @@ -7274,30 +7634,44 @@ "smithy.api#jsonName": "action" } }, + "description": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.

", + "smithy.api#jsonName": "description" + } + }, "findingCriteria": { "target": "com.amazonaws.macie2#FindingCriteria", "traits": { "smithy.api#documentation": "

The criteria to use to filter findings.

", "smithy.api#jsonName": "findingCriteria" } + }, + "name": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.

", + "smithy.api#jsonName": "name" + } } } }, "com.amazonaws.macie2#UpdateFindingsFilterResponse": { "type": "structure", "members": { - "id": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the filter that was updated.

", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the filter that was updated.

", + "smithy.api#jsonName": "arn" } }, - "arn": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the filter that was updated.

", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "

The unique identifier for the filter that was updated.

", + "smithy.api#jsonName": "id" } } } @@ -7408,14 +7782,6 @@ "com.amazonaws.macie2#UpdateMemberSessionRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.macie2#MacieStatus", - "traits": { - "smithy.api#documentation": "

Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - }, "id": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -7423,6 +7789,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "status": { + "target": "com.amazonaws.macie2#MacieStatus", + "traits": { + "smithy.api#documentation": "

Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } } } }, @@ -7490,20 +7864,6 @@ "com.amazonaws.macie2#UsageByAccount": { "type": "structure", "members": { - "estimatedCost": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "

The estimated value for the metric.

", - "smithy.api#jsonName": "estimatedCost" - } - }, - "currency": { - "target": "com.amazonaws.macie2#Currency", - "traits": { - "smithy.api#documentation": "

The type of currency that the value for the metric (estimatedCost) is reported in.

", - "smithy.api#jsonName": "currency" - } - }, "serviceLimit": { "target": "com.amazonaws.macie2#ServiceLimit", "traits": { @@ -7517,6 +7877,20 @@ "smithy.api#documentation": "

The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.

", "smithy.api#jsonName": "type" } + }, + "estimatedCost": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The estimated value for the metric.

", + "smithy.api#jsonName": "estimatedCost" + } + }, + "currency": { + "target": "com.amazonaws.macie2#Currency", + "traits": { + "smithy.api#documentation": "

The type of currency that the value for the metric (estimatedCost) is reported in.

", + "smithy.api#jsonName": "currency" + } } }, "traits": { @@ -7526,13 +7900,6 @@ "com.amazonaws.macie2#UsageRecord": { "type": "structure", "members": { - "freeTrialStartDate": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the free trial started for the account.

", - "smithy.api#jsonName": "freeTrialStartDate" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -7546,6 +7913,13 @@ "smithy.api#documentation": "

An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.

", "smithy.api#jsonName": "usage" } + }, + "freeTrialStartDate": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the free trial started for the account.

", + "smithy.api#jsonName": "freeTrialStartDate" + } } }, "traits": { @@ -7555,13 +7929,6 @@ "com.amazonaws.macie2#UsageStatisticsFilter": { "type": "structure", "members": { - "values": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "

An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

Valid values for each supported field are:

", - "smithy.api#jsonName": "values" - } - }, "key": { "target": "com.amazonaws.macie2#UsageStatisticsFilterKey", "traits": { @@ -7575,6 +7942,13 @@ "smithy.api#documentation": "

The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.

", "smithy.api#jsonName": "comparator" } + }, + "values": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "

An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

Valid values for each supported field are:

", + "smithy.api#jsonName": "values" + } } }, "traits": { @@ -7690,6 +8064,13 @@ "com.amazonaws.macie2#UsageTotal": { "type": "structure", "members": { + "type": { + "target": "com.amazonaws.macie2#UsageType", + "traits": { + "smithy.api#documentation": "

The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.

", + "smithy.api#jsonName": "type" + } + }, "currency": { "target": "com.amazonaws.macie2#Currency", "traits": { @@ -7703,13 +8084,6 @@ "smithy.api#documentation": "

The estimated value for the metric.

", "smithy.api#jsonName": "estimatedCost" } - }, - "type": { - "target": "com.amazonaws.macie2#UsageType", - "traits": { - "smithy.api#documentation": "

The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.

", - "smithy.api#jsonName": "type" - } } }, "traits": { @@ -7735,18 +8109,18 @@ "com.amazonaws.macie2#UserIdentity": { "type": "structure", "members": { - "assumedRole": { - "target": "com.amazonaws.macie2#AssumedRole", + "awsService": { + "target": "com.amazonaws.macie2#AwsService", "traits": { - "smithy.api#documentation": "

If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.

", - "smithy.api#jsonName": "assumedRole" + "smithy.api#documentation": "

If the action was performed by an AWS account that belongs to an AWS service, the name of the service.

", + "smithy.api#jsonName": "awsService" } }, - "awsAccount": { - "target": "com.amazonaws.macie2#AwsAccount", + "federatedUser": { + "target": "com.amazonaws.macie2#FederatedUser", "traits": { - "smithy.api#documentation": "

If the action was performed using the credentials for another AWS account, the details of that account.

", - "smithy.api#jsonName": "awsAccount" + "smithy.api#documentation": "

If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.

", + "smithy.api#jsonName": "federatedUser" } }, "type": { @@ -7756,13 +8130,6 @@ "smithy.api#jsonName": "type" } }, - "awsService": { - "target": "com.amazonaws.macie2#AwsService", - "traits": { - "smithy.api#documentation": "

If the action was performed by an AWS account that belongs to an AWS service, the name of the service.

", - "smithy.api#jsonName": "awsService" - } - }, "iamUser": { "target": "com.amazonaws.macie2#IamUser", "traits": { @@ -7770,11 +8137,18 @@ "smithy.api#jsonName": "iamUser" } }, - "federatedUser": { - "target": "com.amazonaws.macie2#FederatedUser", + "awsAccount": { + "target": "com.amazonaws.macie2#AwsAccount", "traits": { - "smithy.api#documentation": "

If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.

", - "smithy.api#jsonName": "federatedUser" + "smithy.api#documentation": "

If the action was performed using the credentials for another AWS account, the details of that account.

", + "smithy.api#jsonName": "awsAccount" + } + }, + "assumedRole": { + "target": "com.amazonaws.macie2#AssumedRole", + "traits": { + "smithy.api#documentation": "

If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.

", + "smithy.api#jsonName": "assumedRole" } }, "root": { @@ -7850,6 +8224,35 @@ ] } }, + "com.amazonaws.macie2#UserPausedDetails": { + "type": "structure", + "members": { + "jobExpiresAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when the job will expire and be cancelled if you don't resume it first. If you don't resume a job within 30 days of pausing it, the job expires and Amazon Macie cancels it.

", + "smithy.api#jsonName": "jobExpiresAt" + } + }, + "jobPausedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The date and time, in UTC and extended ISO 8601 format, when you paused the job.

", + "smithy.api#jsonName": "jobPausedAt" + } + }, + "jobImminentExpirationHealthEventArn": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Health event that Amazon Macie sent to notify you of the job's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

", + "smithy.api#jsonName": "jobImminentExpirationHealthEventArn" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about when a classification job was paused and when it will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED.

" + } + }, "com.amazonaws.macie2#ValidationException": { "type": "structure", "members": { 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 cb336cae8809..7a4e8e423d60 100644 --- a/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json +++ b/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json @@ -41,10 +41,10 @@ "com.amazonaws.managedblockchain#ApprovalThresholdPolicy": { "type": "structure", "members": { - "ProposalDurationInHours": { - "target": "com.amazonaws.managedblockchain#ProposalDurationInt", + "ThresholdComparator": { + "target": "com.amazonaws.managedblockchain#ThresholdComparator", "traits": { - "smithy.api#documentation": "

The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions are not carried out.

" + "smithy.api#documentation": "

Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.

" } }, "ThresholdPercentage": { @@ -53,10 +53,10 @@ "smithy.api#documentation": "

The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved.

" } }, - "ThresholdComparator": { - "target": "com.amazonaws.managedblockchain#ThresholdComparator", + "ProposalDurationInHours": { + "target": "com.amazonaws.managedblockchain#ProposalDurationInt", "traits": { - "smithy.api#documentation": "

Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.

" + "smithy.api#documentation": "

The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions are not carried out.

" } } }, @@ -130,13 +130,6 @@ "smithy.api#required": {} } }, - "MemberConfiguration": { - "target": "com.amazonaws.managedblockchain#MemberConfiguration", - "traits": { - "smithy.api#documentation": "

Member configuration parameters.

", - "smithy.api#required": {} - } - }, "InvitationId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -151,6 +144,13 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "MemberConfiguration": { + "target": "com.amazonaws.managedblockchain#MemberConfiguration", + "traits": { + "smithy.api#documentation": "

Member configuration parameters.

", + "smithy.api#required": {} + } } } }, @@ -205,12 +205,10 @@ "com.amazonaws.managedblockchain#CreateNetworkInput": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.managedblockchain#ClientRequestTokenString", + "FrameworkConfiguration": { + "target": "com.amazonaws.managedblockchain#NetworkFrameworkConfiguration", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

\n Configuration properties of the blockchain framework relevant to the network configuration.\n

" } }, "Description": { @@ -219,17 +217,18 @@ "smithy.api#documentation": "

An optional description for the network.

" } }, - "Name": { - "target": "com.amazonaws.managedblockchain#NameString", + "MemberConfiguration": { + "target": "com.amazonaws.managedblockchain#MemberConfiguration", "traits": { - "smithy.api#documentation": "

The name of the network.

", + "smithy.api#documentation": "

Configuration properties for the first member within the network.

", "smithy.api#required": {} } }, - "MemberConfiguration": { - "target": "com.amazonaws.managedblockchain#MemberConfiguration", + "ClientRequestToken": { + "target": "com.amazonaws.managedblockchain#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

Configuration properties for the first member within the network.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, @@ -247,10 +246,11 @@ "smithy.api#required": {} } }, - "FrameworkConfiguration": { - "target": "com.amazonaws.managedblockchain#NetworkFrameworkConfiguration", + "Name": { + "target": "com.amazonaws.managedblockchain#NameString", "traits": { - "smithy.api#documentation": "

\n Configuration properties of the blockchain framework relevant to the network configuration.\n

" + "smithy.api#documentation": "

The name of the network.

", + "smithy.api#required": {} } }, "FrameworkVersion": { @@ -325,14 +325,6 @@ "com.amazonaws.managedblockchain#CreateNodeInput": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.managedblockchain#ClientRequestTokenString", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -341,6 +333,14 @@ "smithy.api#required": {} } }, + "ClientRequestToken": { + "target": "com.amazonaws.managedblockchain#ClientRequestTokenString", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, "NodeConfiguration": { "target": "com.amazonaws.managedblockchain#NodeConfiguration", "traits": { @@ -409,12 +409,6 @@ "com.amazonaws.managedblockchain#CreateProposalInput": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.managedblockchain#DescriptionString", - "traits": { - "smithy.api#documentation": "

A description for the proposal that is visible to voting members, for example, \"Proposal to add Example Corp. as member.\"

" - } - }, "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -423,6 +417,12 @@ "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.managedblockchain#DescriptionString", + "traits": { + "smithy.api#documentation": "

A description for the proposal that is visible to voting members, for example, \"Proposal to add Example Corp. as member.\"

" + } + }, "ClientRequestToken": { "target": "com.amazonaws.managedblockchain#ClientRequestTokenString", "traits": { @@ -560,26 +560,26 @@ "com.amazonaws.managedblockchain#DeleteNodeInput": { "type": "structure", "members": { - "NetworkId": { + "MemberId": { "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 member that owns this node.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NodeId": { + "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the node.

", + "smithy.api#documentation": "

The unique identifier of the network that the node belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MemberId": { + "NodeId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member that owns this node.

", + "smithy.api#documentation": "

The unique identifier of the node.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -677,18 +677,18 @@ "com.amazonaws.managedblockchain#GetMemberInput": { "type": "structure", "members": { - "MemberId": { + "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member.

", + "smithy.api#documentation": "

The unique identifier of the network to which the member belongs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NetworkId": { + "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network to which the member belongs.

", + "smithy.api#documentation": "

The unique identifier of the member.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -801,26 +801,26 @@ "com.amazonaws.managedblockchain#GetNodeInput": { "type": "structure", "members": { - "NodeId": { + "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the node.

", + "smithy.api#documentation": "

The unique identifier of the network to which the node belongs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MemberId": { + "NodeId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member that owns the node.

", + "smithy.api#documentation": "

The unique identifier of the node.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NetworkId": { + "MemberId": { "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 member that owns the node.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -875,18 +875,18 @@ "com.amazonaws.managedblockchain#GetProposalInput": { "type": "structure", "members": { - "ProposalId": { + "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the proposal.

", + "smithy.api#documentation": "

The unique identifier of the network for which the proposal is made.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NetworkId": { + "ProposalId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network for which the proposal is made.

", + "smithy.api#documentation": "

The unique identifier of the proposal.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -951,19 +951,19 @@ "smithy.api#documentation": "

The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

" } }, - "CreationDate": { - "target": "com.amazonaws.managedblockchain#Timestamp", + "Status": { + "target": "com.amazonaws.managedblockchain#InvitationStatus", "traits": { - "smithy.api#documentation": "

The date and time that the invitation was created.

" + "smithy.api#documentation": "

The status of the invitation:

\n " } }, "NetworkSummary": { "target": "com.amazonaws.managedblockchain#NetworkSummary" }, - "Status": { - "target": "com.amazonaws.managedblockchain#InvitationStatus", + "CreationDate": { + "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { - "smithy.api#documentation": "

The status of the invitation:

\n " + "smithy.api#documentation": "

The date and time that the invitation was created.

" } }, "InvitationId": { @@ -1066,7 +1066,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a listing of all invitations made on the specified network.

", + "smithy.api#documentation": "

Returns a listing of all invitations for the current AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/invitations", @@ -1101,17 +1101,17 @@ "com.amazonaws.managedblockchain#ListInvitationsOutput": { "type": "structure", "members": { - "Invitations": { - "target": "com.amazonaws.managedblockchain#InvitationList", - "traits": { - "smithy.api#documentation": "

The invitations for the network.

" - } - }, "NextToken": { "target": "com.amazonaws.managedblockchain#PaginationToken", "traits": { "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" } + }, + "Invitations": { + "target": "com.amazonaws.managedblockchain#InvitationList", + "traits": { + "smithy.api#documentation": "

The invitations for the network.

" + } } } }, @@ -1161,14 +1161,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "NetworkId": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The unique identifier of the network for which to list members.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "IsOwned": { "target": "com.amazonaws.managedblockchain#IsOwned", "traits": { @@ -1183,6 +1175,14 @@ "smithy.api#httpQuery": "name" } }, + "NetworkId": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the network for which to list members.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.managedblockchain#MemberListMaxResults", "traits": { @@ -1202,17 +1202,17 @@ "com.amazonaws.managedblockchain#ListMembersOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.managedblockchain#PaginationToken", - "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" - } - }, "Members": { "target": "com.amazonaws.managedblockchain#MemberSummaryList", "traits": { "smithy.api#documentation": "

An array of MemberSummary objects. Each object contains details about a network member.

" } + }, + "NextToken": { + "target": "com.amazonaws.managedblockchain#PaginationToken", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + } } } }, @@ -1276,36 +1276,36 @@ "smithy.api#httpQuery": "name" } }, - "MaxResults": { - "target": "com.amazonaws.managedblockchain#NetworkListMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of networks to list.

", - "smithy.api#httpQuery": "maxResults" - } - }, "NextToken": { "target": "com.amazonaws.managedblockchain#PaginationToken", "traits": { "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

", "smithy.api#httpQuery": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.managedblockchain#NetworkListMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of networks to list.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.managedblockchain#ListNetworksOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.managedblockchain#PaginationToken", - "traits": { - "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" - } - }, "Networks": { "target": "com.amazonaws.managedblockchain#NetworkSummaryList", "traits": { "smithy.api#documentation": "

An array of NetworkSummary objects that contain configuration properties for each network.

" } + }, + "NextToken": { + "target": "com.amazonaws.managedblockchain#PaginationToken", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results to retrieve.

" + } } } }, @@ -1348,6 +1348,13 @@ "com.amazonaws.managedblockchain#ListNodesInput": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.managedblockchain#NodeStatus", + "traits": { + "smithy.api#documentation": "

An optional status specifier. If provided, only nodes currently in this status are listed.

", + "smithy.api#httpQuery": "status" + } + }, "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -1356,13 +1363,6 @@ "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.managedblockchain#NodeStatus", - "traits": { - "smithy.api#documentation": "

An optional status specifier. If provided, only nodes currently in this status are listed.

", - "smithy.api#httpQuery": "status" - } - }, "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -1443,6 +1443,13 @@ "com.amazonaws.managedblockchain#ListProposalVotesInput": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.managedblockchain#ProposalListMaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of votes to return.\n

", + "smithy.api#httpQuery": "maxResults" + } + }, "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -1458,13 +1465,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "MaxResults": { - "target": "com.amazonaws.managedblockchain#ProposalListMaxResults", - "traits": { - "smithy.api#documentation": "

\n The maximum number of votes to return.\n

", - "smithy.api#httpQuery": "maxResults" - } - }, "ProposalId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -1478,17 +1478,17 @@ "com.amazonaws.managedblockchain#ListProposalVotesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.managedblockchain#PaginationToken", - "traits": { - "smithy.api#documentation": "

\n The pagination token that indicates the next set of results to retrieve.\n

" - } - }, "ProposalVotes": { "target": "com.amazonaws.managedblockchain#ProposalVoteList", "traits": { "smithy.api#documentation": "

\n The listing of votes.\n

" } + }, + "NextToken": { + "target": "com.amazonaws.managedblockchain#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n The pagination token that indicates the next set of results to retrieve.\n

" + } } } }, @@ -1612,16 +1612,10 @@ "smithy.api#documentation": "

The unique identifier of the member.

" } }, - "Description": { - "target": "com.amazonaws.managedblockchain#DescriptionString", - "traits": { - "smithy.api#documentation": "

An optional description for the member.

" - } - }, - "Name": { - "target": "com.amazonaws.managedblockchain#NetworkMemberNameString", + "NetworkId": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The name of the member.

" + "smithy.api#documentation": "

The unique identifier of the network to which the member belongs.

" } }, "LogPublishingConfiguration": { @@ -1630,16 +1624,16 @@ "smithy.api#documentation": "

Configuration properties for logging events associated with a member.

" } }, - "NetworkId": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", + "Name": { + "target": "com.amazonaws.managedblockchain#NetworkMemberNameString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network to which the member belongs.

" + "smithy.api#documentation": "

The name of the member.

" } }, - "FrameworkAttributes": { - "target": "com.amazonaws.managedblockchain#MemberFrameworkAttributes", + "CreationDate": { + "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { - "smithy.api#documentation": "

Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

" + "smithy.api#documentation": "

The date and time that the member was created.

" } }, "Status": { @@ -1648,10 +1642,16 @@ "smithy.api#documentation": "

The status of a member.

\n " } }, - "CreationDate": { - "target": "com.amazonaws.managedblockchain#Timestamp", + "Description": { + "target": "com.amazonaws.managedblockchain#DescriptionString", "traits": { - "smithy.api#documentation": "

The date and time that the member was created.

" + "smithy.api#documentation": "

An optional description for the member.

" + } + }, + "FrameworkAttributes": { + "target": "com.amazonaws.managedblockchain#MemberFrameworkAttributes", + "traits": { + "smithy.api#documentation": "

Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

" } } }, @@ -1662,11 +1662,10 @@ "com.amazonaws.managedblockchain#MemberConfiguration": { "type": "structure", "members": { - "FrameworkConfiguration": { - "target": "com.amazonaws.managedblockchain#MemberFrameworkConfiguration", + "LogPublishingConfiguration": { + "target": "com.amazonaws.managedblockchain#MemberLogPublishingConfiguration", "traits": { - "smithy.api#documentation": "

Configuration properties of the blockchain framework relevant to the member.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Configuration properties for logging events associated with a member of a Managed Blockchain network.

" } }, "Description": { @@ -1675,17 +1674,18 @@ "smithy.api#documentation": "

An optional description of the member.

" } }, - "Name": { - "target": "com.amazonaws.managedblockchain#NetworkMemberNameString", + "FrameworkConfiguration": { + "target": "com.amazonaws.managedblockchain#MemberFrameworkConfiguration", "traits": { - "smithy.api#documentation": "

The name of the member.

", + "smithy.api#documentation": "

Configuration properties of the blockchain framework relevant to the member.

", "smithy.api#required": {} } }, - "LogPublishingConfiguration": { - "target": "com.amazonaws.managedblockchain#MemberLogPublishingConfiguration", + "Name": { + "target": "com.amazonaws.managedblockchain#NetworkMemberNameString", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The name of the member.

", + "smithy.api#required": {} } } }, @@ -1716,17 +1716,17 @@ "com.amazonaws.managedblockchain#MemberFabricConfiguration": { "type": "structure", "members": { - "AdminPassword": { - "target": "com.amazonaws.managedblockchain#PasswordString", + "AdminUsername": { + "target": "com.amazonaws.managedblockchain#UsernameString", "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 user name for the member's initial administrative user.

", "smithy.api#required": {} } }, - "AdminUsername": { - "target": "com.amazonaws.managedblockchain#UsernameString", + "AdminPassword": { + "target": "com.amazonaws.managedblockchain#PasswordString", "traits": { - "smithy.api#documentation": "

The user name for the member's initial administrative user.

", + "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#required": {} } } @@ -1835,16 +1835,22 @@ "com.amazonaws.managedblockchain#MemberSummary": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.managedblockchain#NetworkMemberNameString", + "traits": { + "smithy.api#documentation": "

The name of the member.

" + } + }, "IsOwned": { "target": "com.amazonaws.managedblockchain#IsOwned", "traits": { "smithy.api#documentation": "

An indicator of whether the member is owned by your AWS account or a different AWS account.

" } }, - "Name": { - "target": "com.amazonaws.managedblockchain#NetworkMemberNameString", + "Id": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The name of the member.

" + "smithy.api#documentation": "

The unique identifier of the member.

" } }, "Description": { @@ -1859,12 +1865,6 @@ "smithy.api#documentation": "

The status of the member.

\n " } }, - "Id": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The unique identifier of the member.

" - } - }, "CreationDate": { "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { @@ -1895,10 +1895,10 @@ "com.amazonaws.managedblockchain#Network": { "type": "structure", "members": { - "VotingPolicy": { - "target": "com.amazonaws.managedblockchain#VotingPolicy", + "Status": { + "target": "com.amazonaws.managedblockchain#NetworkStatus", "traits": { - "smithy.api#documentation": "

The voting rules for the network to decide if a proposal is accepted.

" + "smithy.api#documentation": "

The current status of the network.

" } }, "VpcEndpointServiceName": { @@ -1907,16 +1907,16 @@ "smithy.api#documentation": "

The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources.

" } }, - "FrameworkAttributes": { - "target": "com.amazonaws.managedblockchain#NetworkFrameworkAttributes", + "Framework": { + "target": "com.amazonaws.managedblockchain#Framework", "traits": { - "smithy.api#documentation": "

Attributes of the blockchain framework that the network uses.

" + "smithy.api#documentation": "

The blockchain framework that the network uses.

" } }, - "Status": { - "target": "com.amazonaws.managedblockchain#NetworkStatus", + "VotingPolicy": { + "target": "com.amazonaws.managedblockchain#VotingPolicy", "traits": { - "smithy.api#documentation": "

The current status of the network.

" + "smithy.api#documentation": "

The voting rules for the network to decide if a proposal is accepted.

" } }, "Name": { @@ -1925,16 +1925,10 @@ "smithy.api#documentation": "

The name of the network.

" } }, - "Framework": { - "target": "com.amazonaws.managedblockchain#Framework", - "traits": { - "smithy.api#documentation": "

The blockchain framework that the network uses.

" - } - }, - "Id": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", + "FrameworkAttributes": { + "target": "com.amazonaws.managedblockchain#NetworkFrameworkAttributes", "traits": { - "smithy.api#documentation": "

The unique identifier of the network.

" + "smithy.api#documentation": "

Attributes of the blockchain framework that the network uses.

" } }, "Description": { @@ -1949,6 +1943,12 @@ "smithy.api#documentation": "

The version of the blockchain framework that the network uses.

" } }, + "Id": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the network.

" + } + }, "CreationDate": { "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { @@ -2073,10 +2073,10 @@ "com.amazonaws.managedblockchain#NetworkSummary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", + "Name": { + "target": "com.amazonaws.managedblockchain#NameString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network.

" + "smithy.api#documentation": "

The name of the network.

" } }, "FrameworkVersion": { @@ -2085,10 +2085,10 @@ "smithy.api#documentation": "

The version of the blockchain framework that the network uses.

" } }, - "CreationDate": { - "target": "com.amazonaws.managedblockchain#Timestamp", + "Framework": { + "target": "com.amazonaws.managedblockchain#Framework", "traits": { - "smithy.api#documentation": "

The date and time that the network was created.

" + "smithy.api#documentation": "

The blockchain framework that the network uses.

" } }, "Status": { @@ -2097,22 +2097,22 @@ "smithy.api#documentation": "

The current status of the network.

" } }, - "Description": { - "target": "com.amazonaws.managedblockchain#DescriptionString", + "CreationDate": { + "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { - "smithy.api#documentation": "

An optional description of the network.

" + "smithy.api#documentation": "

The date and time that the network was created.

" } }, - "Name": { - "target": "com.amazonaws.managedblockchain#NameString", + "Description": { + "target": "com.amazonaws.managedblockchain#DescriptionString", "traits": { - "smithy.api#documentation": "

The name of the network.

" + "smithy.api#documentation": "

An optional description of the network.

" } }, - "Framework": { - "target": "com.amazonaws.managedblockchain#Framework", + "Id": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The blockchain framework that the network uses.

" + "smithy.api#documentation": "

The unique identifier of the network.

" } } }, @@ -2141,10 +2141,10 @@ "smithy.api#documentation": "

The unique identifier of the node.

" } }, - "LogPublishingConfiguration": { - "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", + "StateDB": { + "target": "com.amazonaws.managedblockchain#StateDBType", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The state database that the node uses. Values are LevelDB or CouchDB.

" } }, "NetworkId": { @@ -2153,10 +2153,10 @@ "smithy.api#documentation": "

The unique identifier of the network that the node is in.

" } }, - "FrameworkAttributes": { - "target": "com.amazonaws.managedblockchain#NodeFrameworkAttributes", + "LogPublishingConfiguration": { + "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", "traits": { - "smithy.api#documentation": "

Attributes of the blockchain framework being used.

" + "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

" } }, "MemberId": { @@ -2165,12 +2165,6 @@ "smithy.api#documentation": "

The unique identifier of the member to which the node belongs.

" } }, - "AvailabilityZone": { - "target": "com.amazonaws.managedblockchain#AvailabilityZoneString", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which the node exists.

" - } - }, "CreationDate": { "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { @@ -2182,6 +2176,18 @@ "traits": { "smithy.api#documentation": "

The status of the node.

" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.managedblockchain#AvailabilityZoneString", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the node exists.

" + } + }, + "FrameworkAttributes": { + "target": "com.amazonaws.managedblockchain#NodeFrameworkAttributes", + "traits": { + "smithy.api#documentation": "

Attributes of the blockchain framework being used.

" + } } }, "traits": { @@ -2191,11 +2197,10 @@ "com.amazonaws.managedblockchain#NodeConfiguration": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.managedblockchain#AvailabilityZoneString", + "LogPublishingConfiguration": { + "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", "traits": { - "smithy.api#documentation": "

The Availability Zone in which the node exists.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network. \n

" } }, "InstanceType": { @@ -2205,10 +2210,17 @@ "smithy.api#required": {} } }, - "LogPublishingConfiguration": { - "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", + "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.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.managedblockchain#AvailabilityZoneString", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Availability Zone in which the node exists.

", + "smithy.api#required": {} } } }, @@ -2239,16 +2251,16 @@ "com.amazonaws.managedblockchain#NodeFabricLogPublishingConfiguration": { "type": "structure", "members": { - "PeerLogs": { + "ChaincodeLogs": { "target": "com.amazonaws.managedblockchain#LogConfigurations", "traits": { - "smithy.api#documentation": "

Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.

" + "smithy.api#documentation": "

Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.

" } }, - "ChaincodeLogs": { + "PeerLogs": { "target": "com.amazonaws.managedblockchain#LogConfigurations", "traits": { - "smithy.api#documentation": "

Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.

" + "smithy.api#documentation": "

Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.

" } } }, @@ -2332,10 +2344,10 @@ "com.amazonaws.managedblockchain#NodeSummary": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.managedblockchain#AvailabilityZoneString", + "Status": { + "target": "com.amazonaws.managedblockchain#NodeStatus", "traits": { - "smithy.api#documentation": "

The Availability Zone in which the node exists.

" + "smithy.api#documentation": "

The status of the node.

" } }, "Id": { @@ -2350,10 +2362,10 @@ "smithy.api#documentation": "

The EC2 instance type for the node.

" } }, - "Status": { - "target": "com.amazonaws.managedblockchain#NodeStatus", + "AvailabilityZone": { + "target": "com.amazonaws.managedblockchain#AvailabilityZoneString", "traits": { - "smithy.api#documentation": "

The status of the node.

" + "smithy.api#documentation": "

The Availability Zone in which the node exists.

" } }, "CreationDate": { @@ -2399,22 +2411,22 @@ "com.amazonaws.managedblockchain#Proposal": { "type": "structure", "members": { - "NoVoteCount": { + "OutstandingVoteCount": { "target": "com.amazonaws.managedblockchain#VoteCount", "traits": { - "smithy.api#documentation": "

\n The current total of NO votes cast on the proposal by members.\n

" + "smithy.api#documentation": "

\n The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES votes and NO votes.\n

" } }, - "CreationDate": { - "target": "com.amazonaws.managedblockchain#Timestamp", + "Description": { + "target": "com.amazonaws.managedblockchain#DescriptionString", "traits": { - "smithy.api#documentation": "

\n The date and time that the proposal was created.\n

" + "smithy.api#documentation": "

The description of the proposal.

" } }, - "OutstandingVoteCount": { + "NoVoteCount": { "target": "com.amazonaws.managedblockchain#VoteCount", "traits": { - "smithy.api#documentation": "

\n The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES votes and NO votes.\n

" + "smithy.api#documentation": "

\n The current total of NO votes cast on the proposal by members.\n

" } }, "ProposedByMemberId": { @@ -2429,40 +2441,40 @@ "smithy.api#documentation": "

The name of the member that created the proposal.

" } }, - "YesVoteCount": { - "target": "com.amazonaws.managedblockchain#VoteCount", + "CreationDate": { + "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { - "smithy.api#documentation": "

\n The current total of YES votes cast on the proposal by members.\n

" + "smithy.api#documentation": "

\n The date and time that the proposal was created.\n

" } }, - "NetworkId": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", + "Actions": { + "target": "com.amazonaws.managedblockchain#ProposalActions", "traits": { - "smithy.api#documentation": "

The unique identifier of the network for which the proposal is made.

" + "smithy.api#documentation": "

The actions to perform on the network if the proposal is APPROVED.

" } }, - "Description": { - "target": "com.amazonaws.managedblockchain#DescriptionString", + "ExpirationDate": { + "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { - "smithy.api#documentation": "

The description of the proposal.

" + "smithy.api#documentation": "

\n The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.\n

" } }, - "ProposalId": { + "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the proposal.

" + "smithy.api#documentation": "

The unique identifier of the network for which the proposal is made.

" } }, - "ExpirationDate": { - "target": "com.amazonaws.managedblockchain#Timestamp", + "YesVoteCount": { + "target": "com.amazonaws.managedblockchain#VoteCount", "traits": { - "smithy.api#documentation": "

\n The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.\n

" + "smithy.api#documentation": "

\n The current total of YES votes cast on the proposal by members.\n

" } }, - "Actions": { - "target": "com.amazonaws.managedblockchain#ProposalActions", + "ProposalId": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The actions to perform on the network if the proposal is APPROVED.

" + "smithy.api#documentation": "

The unique identifier of the proposal.

" } }, "Status": { @@ -2546,6 +2558,12 @@ "com.amazonaws.managedblockchain#ProposalSummary": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.managedblockchain#DescriptionString", + "traits": { + "smithy.api#documentation": "

\n The description of the proposal.\n

" + } + }, "Status": { "target": "com.amazonaws.managedblockchain#ProposalStatus", "traits": { @@ -2558,16 +2576,10 @@ "smithy.api#documentation": "

\n The date and time that the proposal was created.\n

" } }, - "Description": { - "target": "com.amazonaws.managedblockchain#DescriptionString", - "traits": { - "smithy.api#documentation": "

\n The description of the proposal.\n

" - } - }, - "ExpirationDate": { - "target": "com.amazonaws.managedblockchain#Timestamp", + "ProposedByMemberId": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

\n The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.\n

" + "smithy.api#documentation": "

\n The unique identifier of the member that created the proposal.\n

" } }, "ProposedByMemberName": { @@ -2576,10 +2588,10 @@ "smithy.api#documentation": "

\n The name of the member that created the proposal.\n

" } }, - "ProposedByMemberId": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", + "ExpirationDate": { + "target": "com.amazonaws.managedblockchain#Timestamp", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the member that created the proposal.\n

" + "smithy.api#documentation": "

\n The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.\n

" } }, "ProposalId": { @@ -2741,6 +2753,21 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.managedblockchain#StateDBType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LevelDB", + "name": "LevelDB" + }, + { + "value": "CouchDB", + "name": "CouchDB" + } + ] + } + }, "com.amazonaws.managedblockchain#String": { "type": "string" }, @@ -2814,7 +2841,7 @@ "sdkId": "ManagedBlockchain", "arnNamespace": "managedblockchain", "cloudFormationName": "ManagedBlockchain", - "cloudTrailEventSource": "api.webservice.taiga.amazonaws.com" + "cloudTrailEventSource": "managedblockchain.amazonaws.com" }, "aws.auth#sigv4": { "name": "managedblockchain" @@ -2901,14 +2928,6 @@ "com.amazonaws.managedblockchain#UpdateMemberInput": { "type": "structure", "members": { - "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#httpLabel": {}, - "smithy.api#required": {} - } - }, "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -2922,6 +2941,14 @@ "traits": { "smithy.api#documentation": "

Configuration properties for publishing to Amazon CloudWatch Logs.

" } + }, + "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#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -2982,12 +3009,6 @@ "smithy.api#required": {} } }, - "LogPublishingConfiguration": { - "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration properties for publishing to Amazon CloudWatch Logs.

" - } - }, "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { @@ -2995,6 +3016,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "LogPublishingConfiguration": { + "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration properties for publishing to Amazon CloudWatch Logs.

" + } } } }, @@ -3058,18 +3085,18 @@ "com.amazonaws.managedblockchain#VoteOnProposalInput": { "type": "structure", "members": { - "NetworkId": { - "target": "com.amazonaws.managedblockchain#ResourceIdString", + "Vote": { + "target": "com.amazonaws.managedblockchain#VoteValue", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the network.\n

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

\n The value of the vote.\n

", "smithy.api#required": {} } }, - "Vote": { - "target": "com.amazonaws.managedblockchain#VoteValue", + "NetworkId": { + "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

\n The value of the vote.\n

", + "smithy.api#documentation": "

\n The unique identifier of the network.\n

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json b/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json index d95321e80d7f..eaf63a5ca567 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json +++ b/codegen/sdk-codegen/aws-models/marketplace-catalog.2018-09-17.json @@ -67,13 +67,13 @@ "sdkId": "Marketplace Catalog", "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceCatalog", - "cloudTrailEventSource": "model.seymour.marketplace.amazonaws.com" + "cloudTrailEventSource": "marketplacecatalog.amazonaws.com" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Catalog API actions allow you to manage your entities through list, describe, and update\n capabilities. An entity can be a product or an offer on AWS Marketplace.

\n\n

You can automate your entity update process by integrating the AWS Marketplace Catalog\n API with your AWS Marketplace product build or deployment pipelines. You can also create\n your own applications on top of the Catalog API to manage your products on AWS\n Marketplace.

", + "smithy.api#documentation": "

Catalog API actions allow you to manage your entities through list, describe, and update\n capabilities. An entity can be a product or an offer on AWS Marketplace.

\n\n

You can automate your entity update process by integrating the AWS Marketplace Catalog\n API with your AWS Marketplace product build or deployment pipelines. You can also create\n your own applications on top of the Catalog API to manage your products on AWS\n Marketplace.

", "smithy.api#title": "AWS Marketplace Catalog Service" } }, @@ -229,22 +229,16 @@ "com.amazonaws.marketplacecatalog#ChangeSetSummaryListItem": { "type": "structure", "members": { - "ChangeSetId": { - "target": "com.amazonaws.marketplacecatalog#ResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier for a change set.

" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.marketplacecatalog#ChangeSetName", + "ChangeSetArn": { + "target": "com.amazonaws.marketplacecatalog#ARN", "traits": { - "smithy.api#documentation": "

The non-unique name for the change set.

" + "smithy.api#documentation": "

The ARN associated with the unique identifier for the change set referenced in this\n request.

" } }, - "EntityIdList": { - "target": "com.amazonaws.marketplacecatalog#ResourceIdList", + "Status": { + "target": "com.amazonaws.marketplacecatalog#ChangeStatus", "traits": { - "smithy.api#documentation": "

This object is a list of entity IDs (string) that are a part of a change set. The\n entity ID list is a maximum of 20 entities. It must contain at least one entity.

" + "smithy.api#documentation": "

The current status of the change set.

" } }, "StartTime": { @@ -253,10 +247,16 @@ "smithy.api#documentation": "

The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was\n started.

" } }, - "ChangeSetArn": { - "target": "com.amazonaws.marketplacecatalog#ARN", + "ChangeSetId": { + "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { - "smithy.api#documentation": "

The ARN associated with the unique identifier for the change set referenced in this\n request.

" + "smithy.api#documentation": "

The unique identifier for a change set.

" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.marketplacecatalog#ChangeSetName", + "traits": { + "smithy.api#documentation": "

The non-unique name for the change set.

" } }, "EndTime": { @@ -265,10 +265,16 @@ "smithy.api#documentation": "

The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was\n finished.

" } }, - "Status": { - "target": "com.amazonaws.marketplacecatalog#ChangeStatus", + "EntityIdList": { + "target": "com.amazonaws.marketplacecatalog#ResourceIdList", "traits": { - "smithy.api#documentation": "

The current status of the change set.

" + "smithy.api#documentation": "

This object is a list of entity IDs (string) that are a part of a change set. The\n entity ID list is a maximum of 20 entities. It must contain at least one entity.

" + } + }, + "FailureCode": { + "target": "com.amazonaws.marketplacecatalog#FailureCode", + "traits": { + "smithy.api#documentation": "

Returned if the change set is in FAILED status. Can be either \n CLIENT_ERROR, which means that there are issues with the request (see the \n ErrorDetailList of DescribeChangeSet), or SERVER_FAULT,\n which means that there is a problem in the system, and you should retry your request.

" } } }, @@ -306,16 +312,10 @@ "com.amazonaws.marketplacecatalog#ChangeSummary": { "type": "structure", "members": { - "Details": { - "target": "com.amazonaws.marketplacecatalog#Json", - "traits": { - "smithy.api#documentation": "

This object contains details specific to the change type of the requested\n change.

" - } - }, - "Entity": { - "target": "com.amazonaws.marketplacecatalog#Entity", + "ChangeType": { + "target": "com.amazonaws.marketplacecatalog#ChangeType", "traits": { - "smithy.api#documentation": "

The entity to be changed.

" + "smithy.api#documentation": "

The type of the change.

" } }, "ErrorDetailList": { @@ -324,10 +324,16 @@ "smithy.api#documentation": "

An array of ErrorDetail objects associated with the change.

" } }, - "ChangeType": { - "target": "com.amazonaws.marketplacecatalog#ChangeType", + "Entity": { + "target": "com.amazonaws.marketplacecatalog#Entity", "traits": { - "smithy.api#documentation": "

The type of the change.

" + "smithy.api#documentation": "

The entity to be changed.

" + } + }, + "Details": { + "target": "com.amazonaws.marketplacecatalog#Json", + "traits": { + "smithy.api#documentation": "

This object contains details specific to the change type of the requested\n change.

" } } }, @@ -402,14 +408,6 @@ "com.amazonaws.marketplacecatalog#DescribeChangeSetRequest": { "type": "structure", "members": { - "Catalog": { - "target": "com.amazonaws.marketplacecatalog#Catalog", - "traits": { - "smithy.api#documentation": "

Required. The catalog related to the request. Fixed value:\n AWSMarketplace\n

", - "smithy.api#httpQuery": "catalog", - "smithy.api#required": {} - } - }, "ChangeSetId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { @@ -417,28 +415,36 @@ "smithy.api#httpQuery": "changeSetId", "smithy.api#required": {} } + }, + "Catalog": { + "target": "com.amazonaws.marketplacecatalog#Catalog", + "traits": { + "smithy.api#documentation": "

Required. The catalog related to the request. Fixed value:\n AWSMarketplace\n

", + "smithy.api#httpQuery": "catalog", + "smithy.api#required": {} + } } } }, "com.amazonaws.marketplacecatalog#DescribeChangeSetResponse": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", + "Status": { + "target": "com.amazonaws.marketplacecatalog#ChangeStatus", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned\n to a terminal state. The change cannot transition to a different state. Null if the\n request is not in a terminal state.

" + "smithy.api#documentation": "

The status of the change request.

" } }, - "ChangeSetName": { - "target": "com.amazonaws.marketplacecatalog#ChangeSetName", + "FailureDescription": { + "target": "com.amazonaws.marketplacecatalog#StringValue", "traits": { - "smithy.api#documentation": "

The optional name provided in the StartChangeSet request. If you do not\n provide a name, one is set by default.

" + "smithy.api#documentation": "

Returned if there is a failure on the change set, but that failure is not related to\n any of the changes in the request.

" } }, - "Status": { - "target": "com.amazonaws.marketplacecatalog#ChangeStatus", + "ChangeSet": { + "target": "com.amazonaws.marketplacecatalog#ChangeSetDescription", "traits": { - "smithy.api#documentation": "

The status of the change request.

" + "smithy.api#documentation": "

An array of ChangeSummary objects.

" } }, "ChangeSetId": { @@ -447,10 +453,10 @@ "smithy.api#documentation": "

Required. The unique identifier for the change set referenced in this request.

" } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { - "smithy.api#documentation": "

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.\n

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned\n to a terminal state. The change cannot transition to a different state. Null if the\n request is not in a terminal state.

" } }, "ChangeSetArn": { @@ -459,16 +465,22 @@ "smithy.api#documentation": "

The ARN associated with the unique identifier for the change set referenced in this\n request.

" } }, - "FailureDescription": { - "target": "com.amazonaws.marketplacecatalog#StringValue", + "FailureCode": { + "target": "com.amazonaws.marketplacecatalog#FailureCode", "traits": { - "smithy.api#documentation": "

Returned if there is a failure on the change set, but that failure is not related to\n any of the changes in the request.

" + "smithy.api#documentation": "

Returned if the change set is in FAILED status. Can be either \n CLIENT_ERROR, which means that there are issues with the request (see the \n ErrorDetailList), or SERVER_FAULT, which means that there is a \n problem in the system, and you should retry your request.

" } }, - "ChangeSet": { - "target": "com.amazonaws.marketplacecatalog#ChangeSetDescription", + "StartTime": { + "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { - "smithy.api#documentation": "

An array of ChangeSummary objects.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.\n

" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.marketplacecatalog#ChangeSetName", + "traits": { + "smithy.api#documentation": "

The optional name provided in the StartChangeSet request. If you do not\n provide a name, one is set by default.

" } } } @@ -534,18 +546,6 @@ "com.amazonaws.marketplacecatalog#DescribeEntityResponse": { "type": "structure", "members": { - "LastModifiedDate": { - "target": "com.amazonaws.marketplacecatalog#StringValue", - "traits": { - "smithy.api#documentation": "

The last modified date of the entity, in ISO 8601 format\n (2018-02-27T13:45:22Z).

" - } - }, - "EntityType": { - "target": "com.amazonaws.marketplacecatalog#EntityType", - "traits": { - "smithy.api#documentation": "

The named type of the entity, in the format of EntityType@Version.

" - } - }, "EntityIdentifier": { "target": "com.amazonaws.marketplacecatalog#Identifier", "traits": { @@ -563,24 +563,36 @@ "traits": { "smithy.api#documentation": "

The ARN associated to the unique identifier for the change set referenced in this\n request.

" } + }, + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#StringValue", + "traits": { + "smithy.api#documentation": "

The last modified date of the entity, in ISO 8601 format\n (2018-02-27T13:45:22Z).

" + } + }, + "EntityType": { + "target": "com.amazonaws.marketplacecatalog#EntityType", + "traits": { + "smithy.api#documentation": "

The named type of the entity, in the format of EntityType@Version.

" + } } } }, "com.amazonaws.marketplacecatalog#Entity": { "type": "structure", "members": { - "Identifier": { - "target": "com.amazonaws.marketplacecatalog#Identifier", - "traits": { - "smithy.api#documentation": "

The identifier for the entity.

" - } - }, "Type": { "target": "com.amazonaws.marketplacecatalog#EntityType", "traits": { "smithy.api#documentation": "

The type of entity.

", "smithy.api#required": {} } + }, + "Identifier": { + "target": "com.amazonaws.marketplacecatalog#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier for the entity.

" + } } }, "traits": { @@ -590,24 +602,12 @@ "com.amazonaws.marketplacecatalog#EntitySummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.marketplacecatalog#StringValue", - "traits": { - "smithy.api#documentation": "

The name for the entity. This value is not unique. It is defined by the\n seller.

" - } - }, "Visibility": { "target": "com.amazonaws.marketplacecatalog#StringValue", "traits": { "smithy.api#documentation": "

The visibility status of the entity to\n buyers.\n This value can be Public (everyone can view the entity),\n Limited (the entity is visible to limited accounts only), or\n Restricted (the entity was published and then unpublished and only\n existing\n buyers\n can view it).

" } }, - "LastModifiedDate": { - "target": "com.amazonaws.marketplacecatalog#StringValue", - "traits": { - "smithy.api#documentation": "

The last time the entity was published, using ISO 8601 format\n (2018-02-27T13:45:22Z).

" - } - }, "EntityArn": { "target": "com.amazonaws.marketplacecatalog#ARN", "traits": { @@ -620,6 +620,18 @@ "smithy.api#documentation": "

The type of the entity.

" } }, + "LastModifiedDate": { + "target": "com.amazonaws.marketplacecatalog#StringValue", + "traits": { + "smithy.api#documentation": "

The last time the entity was published, using ISO 8601 format\n (2018-02-27T13:45:22Z).

" + } + }, + "Name": { + "target": "com.amazonaws.marketplacecatalog#StringValue", + "traits": { + "smithy.api#documentation": "

The name for the entity. This value is not unique. It is defined by the\n seller.

" + } + }, "EntityId": { "target": "com.amazonaws.marketplacecatalog#ResourceId", "traits": { @@ -673,20 +685,35 @@ "target": "com.amazonaws.marketplacecatalog#ErrorDetail" } }, + "com.amazonaws.marketplacecatalog#FailureCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CLIENT_ERROR", + "name": "ClientError" + }, + { + "value": "SERVER_FAULT", + "name": "ServerFault" + } + ] + } + }, "com.amazonaws.marketplacecatalog#Filter": { "type": "structure", "members": { - "ValueList": { - "target": "com.amazonaws.marketplacecatalog#ValueList", - "traits": { - "smithy.api#documentation": "

\n ListEntities - This is a list of unique EntityIds.

\n\n

\n ListChangeSets - The supported filter names and associated\n ValueLists is as follows:

\n " - } - }, "Name": { "target": "com.amazonaws.marketplacecatalog#FilterName", "traits": { "smithy.api#documentation": "

For ListEntities, the supported value for this is an\n EntityId.

\n

For ListChangeSets, the supported values are as follows:

" } + }, + "ValueList": { + "target": "com.amazonaws.marketplacecatalog#ValueList", + "traits": { + "smithy.api#documentation": "

\n ListEntities - This is a list of unique EntityIds.

\n\n

\n ListChangeSets - The supported filter names and associated\n ValueLists is as follows:

\n " + } } }, "traits": { @@ -787,18 +814,6 @@ "com.amazonaws.marketplacecatalog#ListChangeSetsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.marketplacecatalog#NextToken", - "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" - } - }, - "Sort": { - "target": "com.amazonaws.marketplacecatalog#Sort", - "traits": { - "smithy.api#documentation": "

An object that contains two attributes, SortBy and\n SortOrder.

" - } - }, "FilterList": { "target": "com.amazonaws.marketplacecatalog#FilterList", "traits": { @@ -812,28 +827,40 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.marketplacecatalog#NextToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" + } + }, "MaxResults": { "target": "com.amazonaws.marketplacecatalog#MaxResultInteger", "traits": { "smithy.api#documentation": "

The maximum number of results returned by a single call. This value must be provided\n in the next call to retrieve the next set of results. By default, this value is\n 20.

" } + }, + "Sort": { + "target": "com.amazonaws.marketplacecatalog#Sort", + "traits": { + "smithy.api#documentation": "

An object that contains two attributes, SortBy and\n SortOrder.

" + } } } }, "com.amazonaws.marketplacecatalog#ListChangeSetsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.marketplacecatalog#NextToken", - "traits": { - "smithy.api#documentation": "

The value of the next token, if it exists. Null if there are no more results.

" - } - }, "ChangeSetSummaryList": { "target": "com.amazonaws.marketplacecatalog#ChangeSetSummaryList", "traits": { "smithy.api#documentation": "

Array of ChangeSetSummaryListItem objects.

" } + }, + "NextToken": { + "target": "com.amazonaws.marketplacecatalog#NextToken", + "traits": { + "smithy.api#documentation": "

The value of the next token, if it exists. Null if there are no more results.

" + } } } }, @@ -879,11 +906,22 @@ "com.amazonaws.marketplacecatalog#ListEntitiesRequest": { "type": "structure", "members": { - "EntityType": { - "target": "com.amazonaws.marketplacecatalog#EntityType", + "NextToken": { + "target": "com.amazonaws.marketplacecatalog#NextToken", "traits": { - "smithy.api#documentation": "

The type of entities to retrieve.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The value of the next token, if it exists. Null if there are no more results.

" + } + }, + "Sort": { + "target": "com.amazonaws.marketplacecatalog#Sort", + "traits": { + "smithy.api#documentation": "

An object that contains two attributes, SortBy and\n SortOrder.

" + } + }, + "FilterList": { + "target": "com.amazonaws.marketplacecatalog#FilterList", + "traits": { + "smithy.api#documentation": "

An array of filter objects. Each filter object contains two attributes,\n filterName and filterValues.

" } }, "Catalog": { @@ -893,28 +931,17 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.marketplacecatalog#NextToken", - "traits": { - "smithy.api#documentation": "

The value of the next token, if it exists. Null if there are no more results.

" - } - }, "MaxResults": { "target": "com.amazonaws.marketplacecatalog#MaxResultInteger", "traits": { "smithy.api#documentation": "

Specifies the upper limit of the elements on a single page. If a value isn't provided,\n the default value is 20.

" } }, - "Sort": { - "target": "com.amazonaws.marketplacecatalog#Sort", - "traits": { - "smithy.api#documentation": "

An object that contains two attributes, SortBy and\n SortOrder.

" - } - }, - "FilterList": { - "target": "com.amazonaws.marketplacecatalog#FilterList", + "EntityType": { + "target": "com.amazonaws.marketplacecatalog#EntityType", "traits": { - "smithy.api#documentation": "

An array of filter objects. Each filter object contains two attributes,\n filterName and filterValues.

" + "smithy.api#documentation": "

The type of entities to retrieve.

", + "smithy.api#required": {} } } } @@ -922,17 +949,17 @@ "com.amazonaws.marketplacecatalog#ListEntitiesResponse": { "type": "structure", "members": { - "EntitySummaryList": { - "target": "com.amazonaws.marketplacecatalog#EntitySummaryList", - "traits": { - "smithy.api#documentation": "

Array of EntitySummary object.

" - } - }, "NextToken": { "target": "com.amazonaws.marketplacecatalog#NextToken", "traits": { "smithy.api#documentation": "

The value of the next token if it exists. Null if there is no more result.

" } + }, + "EntitySummaryList": { + "target": "com.amazonaws.marketplacecatalog#EntitySummaryList", + "traits": { + "smithy.api#documentation": "

Array of EntitySummary object.

" + } } } }, @@ -1124,13 +1151,6 @@ "com.amazonaws.marketplacecatalog#StartChangeSetRequest": { "type": "structure", "members": { - "ChangeSet": { - "target": "com.amazonaws.marketplacecatalog#RequestedChangeList", - "traits": { - "smithy.api#documentation": "

Array of change object.

", - "smithy.api#required": {} - } - }, "ChangeSetName": { "target": "com.amazonaws.marketplacecatalog#ChangeSetName", "traits": { @@ -1143,6 +1163,13 @@ "smithy.api#documentation": "

A unique token to identify the request to ensure idempotency.

" } }, + "ChangeSet": { + "target": "com.amazonaws.marketplacecatalog#RequestedChangeList", + "traits": { + "smithy.api#documentation": "

Array of change object.

", + "smithy.api#required": {} + } + }, "Catalog": { "target": "com.amazonaws.marketplacecatalog#Catalog", "traits": { diff --git a/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.2015-07-01.json b/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.2015-07-01.json index e5876b817e08..e165b3c7b02e 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.2015-07-01.json +++ b/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.2015-07-01.json @@ -224,17 +224,17 @@ "smithy.api#documentation": "(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.\n For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file\n \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\".\n If the prefix directory structure does not exist, it will be created.\n If no prefix is provided, the data set will be published to the S3 bucket root." } }, - "destinationS3BucketName": { - "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3BucketName", + "dataSetType": { + "target": "com.amazonaws.marketplacecommerceanalytics#DataSetType", "traits": { - "smithy.api#documentation": "The name (friendly name, not ARN) of the destination S3 bucket.", + "smithy.api#documentation": "

The desired data set type.

\n

\n

\n

", "smithy.api#required": {} } }, - "dataSetType": { - "target": "com.amazonaws.marketplacecommerceanalytics#DataSetType", + "destinationS3BucketName": { + "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3BucketName", "traits": { - "smithy.api#documentation": "

The desired data set type.

\n

\n

\n

", + "smithy.api#documentation": "The name (friendly name, not ARN) of the destination S3 bucket.", "smithy.api#required": {} } }, @@ -280,7 +280,7 @@ "sdkId": "Marketplace Commerce Analytics", "arnNamespace": "marketplacecommerceanalytics", "cloudFormationName": "MarketplaceCommerceAnalytics", - "cloudTrailEventSource": "v20150701.businessintelligenceservice.marketplace.aws.amazon.com" + "cloudTrailEventSource": "marketplacecommerceanalytics.amazonaws.com" }, "aws.auth#sigv4": { "name": "marketplacecommerceanalytics" @@ -359,6 +359,13 @@ "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExportRequest": { "type": "structure", "members": { + "snsTopicArn": { + "target": "com.amazonaws.marketplacecommerceanalytics#SnsTopicArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an\n error has occurred.", + "smithy.api#required": {} + } + }, "fromDate": { "target": "com.amazonaws.marketplacecommerceanalytics#FromDate", "traits": { @@ -366,11 +373,10 @@ "smithy.api#required": {} } }, - "snsTopicArn": { - "target": "com.amazonaws.marketplacecommerceanalytics#SnsTopicArn", + "destinationS3Prefix": { + "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3Prefix", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an\n error has occurred.", - "smithy.api#required": {} + "smithy.api#documentation": "(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.\n For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file\n \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\".\n If the prefix directory structure does not exist, it will be created.\n If no prefix is provided, the data set will be published to the S3 bucket root." } }, "dataSetType": { @@ -386,10 +392,11 @@ "smithy.api#documentation": "(Optional) Key-value pairs which will be returned, unmodified, in the\n Amazon SNS notification message and the data set metadata file." } }, - "destinationS3Prefix": { - "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3Prefix", + "roleNameArn": { + "target": "com.amazonaws.marketplacecommerceanalytics#RoleNameArn", "traits": { - "smithy.api#documentation": "(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.\n For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file\n \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\".\n If the prefix directory structure does not exist, it will be created.\n If no prefix is provided, the data set will be published to the S3 bucket root." + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided\n AWS services.", + "smithy.api#required": {} } }, "destinationS3BucketName": { @@ -398,13 +405,6 @@ "smithy.api#documentation": "The name (friendly name, not ARN) of the destination S3 bucket.", "smithy.api#required": {} } - }, - "roleNameArn": { - "target": "com.amazonaws.marketplacecommerceanalytics#RoleNameArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided\n AWS services.", - "smithy.api#required": {} - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json b/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json index fa915f119131..c9ed2aff3768 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json +++ b/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json @@ -42,7 +42,7 @@ "sdkId": "Marketplace Entitlement Service", "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceEntitlementService", - "cloudTrailEventSource": "entitlement.marketplace.amazonaws.com" + "cloudTrailEventSource": "marketplaceentitlementservice.amazonaws.com" }, "aws.auth#sigv4": { "name": "aws-marketplace" @@ -73,12 +73,6 @@ "smithy.api#documentation": "

The dimension for which the given entitlement applies. Dimensions represent categories of\n capacity in a product and are specified when the product is listed in AWS\n Marketplace.

" } }, - "CustomerIdentifier": { - "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The customer identifier is a handle to each unique customer in an application. Customer\n identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering\n Service.

" - } - }, "ProductCode": { "target": "com.amazonaws.marketplaceentitlementservice#ProductCode", "traits": { @@ -91,6 +85,12 @@ "smithy.api#documentation": "

The expiration date represents the minimum date through which this entitlement is\n expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date\n is the date at which the customer will renew or cancel their contract. Customers who are opting\n to renew their contract will still have entitlements with an expiration date.

" } }, + "CustomerIdentifier": { + "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The customer identifier is a handle to each unique customer in an application. Customer\n identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering\n Service.

" + } + }, "Value": { "target": "com.amazonaws.marketplaceentitlementservice#EntitlementValue", "traits": { @@ -212,22 +212,16 @@ "com.amazonaws.marketplaceentitlementservice#GetEntitlementsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.marketplaceentitlementservice#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of items to retrieve from the GetEntitlements operation. For\n pagination, use the NextToken field in subsequent calls to GetEntitlements.

" - } - }, "NextToken": { "target": "com.amazonaws.marketplaceentitlementservice#NonEmptyString", "traits": { "smithy.api#documentation": "

For paginated calls to GetEntitlements, pass the NextToken from the previous\n GetEntitlementsResult.

" } }, - "Filter": { - "target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilters", + "MaxResults": { + "target": "com.amazonaws.marketplaceentitlementservice#Integer", "traits": { - "smithy.api#documentation": "

Filter is used to return entitlements for a specific customer or for a specific\n dimension. Filters are described as keys mapped to a lists of values. Filtered requests are\n unioned for each value in the value list, and then\n intersected for each filter key.

" + "smithy.api#documentation": "

The maximum number of items to retrieve from the GetEntitlements operation. For\n pagination, use the NextToken field in subsequent calls to GetEntitlements.

" } }, "ProductCode": { @@ -236,6 +230,12 @@ "smithy.api#documentation": "

Product code is used to uniquely identify a product in AWS Marketplace. The product code\n will be provided by AWS Marketplace when the product listing is created.

", "smithy.api#required": {} } + }, + "Filter": { + "target": "com.amazonaws.marketplaceentitlementservice#GetEntitlementFilters", + "traits": { + "smithy.api#documentation": "

Filter is used to return entitlements for a specific customer or for a specific\n dimension. Filters are described as keys mapped to a lists of values. Filtered requests are\n unioned for each value in the value list, and then\n intersected for each filter key.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/marketplace-metering.2016-01-14.json b/codegen/sdk-codegen/aws-models/marketplace-metering.2016-01-14.json index 771db80d325f..bab933bc5abf 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-metering.2016-01-14.json +++ b/codegen/sdk-codegen/aws-models/marketplace-metering.2016-01-14.json @@ -51,7 +51,7 @@ "sdkId": "Marketplace Metering", "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceMetering", - "cloudTrailEventSource": "metering.marketplace.amazonaws.com" + "cloudTrailEventSource": "marketplacemetering.amazonaws.com" }, "aws.auth#sigv4": { "name": "aws-marketplace" @@ -461,6 +461,12 @@ "com.amazonaws.marketplacemetering#RegisterUsageRequest": { "type": "structure", "members": { + "Nonce": { + "target": "com.amazonaws.marketplacemetering#Nonce", + "traits": { + "smithy.api#documentation": "

(Optional) To scope down the registration to a specific running software instance\n and guard against replay attacks.

" + } + }, "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { @@ -468,12 +474,6 @@ "smithy.api#required": {} } }, - "Nonce": { - "target": "com.amazonaws.marketplacemetering#Nonce", - "traits": { - "smithy.api#documentation": "

(Optional) To scope down the registration to a specific running software instance\n and guard against replay attacks.

" - } - }, "PublicKeyVersion": { "target": "com.amazonaws.marketplacemetering#VersionInteger", "traits": { @@ -547,17 +547,17 @@ "com.amazonaws.marketplacemetering#ResolveCustomerResult": { "type": "structure", "members": { - "ProductCode": { - "target": "com.amazonaws.marketplacemetering#ProductCode", - "traits": { - "smithy.api#documentation": "

The product code is returned to confirm that the buyer is registering for your\n product. Subsequent BatchMeterUsage calls should be made using this product\n code.

" - } - }, "CustomerIdentifier": { "target": "com.amazonaws.marketplacemetering#CustomerIdentifier", "traits": { "smithy.api#documentation": "

The CustomerIdentifier is used to identify an individual customer in your\n application. Calls to BatchMeterUsage require CustomerIdentifiers for each\n UsageRecord.

" } + }, + "ProductCode": { + "target": "com.amazonaws.marketplacemetering#ProductCode", + "traits": { + "smithy.api#documentation": "

The product code is returned to confirm that the buyer is registering for your\n product. Subsequent BatchMeterUsage calls should be made using this product\n code.

" + } } }, "traits": { @@ -616,13 +616,6 @@ "com.amazonaws.marketplacemetering#UsageRecord": { "type": "structure", "members": { - "Timestamp": { - "target": "com.amazonaws.marketplacemetering#Timestamp", - "traits": { - "smithy.api#documentation": "

Timestamp, in UTC, for which the usage is being reported.

\n

Your application can meter usage for up to one hour in the past. Make sure the\n timestamp value is not before the start of the software usage.

", - "smithy.api#required": {} - } - }, "Quantity": { "target": "com.amazonaws.marketplacemetering#UsageQuantity", "traits": { @@ -636,6 +629,13 @@ "smithy.api#required": {} } }, + "Timestamp": { + "target": "com.amazonaws.marketplacemetering#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp, in UTC, for which the usage is being reported.

\n

Your application can meter usage for up to one hour in the past. Make sure the\n timestamp value is not before the start of the software usage.

", + "smithy.api#required": {} + } + }, "CustomerIdentifier": { "target": "com.amazonaws.marketplacemetering#CustomerIdentifier", "traits": { @@ -663,10 +663,10 @@ "com.amazonaws.marketplacemetering#UsageRecordResult": { "type": "structure", "members": { - "MeteringRecordId": { - "target": "com.amazonaws.marketplacemetering#String", + "UsageRecord": { + "target": "com.amazonaws.marketplacemetering#UsageRecord", "traits": { - "smithy.api#documentation": "

The MeteringRecordId is a unique identifier for this metering event.

" + "smithy.api#documentation": "

The UsageRecord that was part of the BatchMeterUsage request.

" } }, "Status": { @@ -675,10 +675,10 @@ "smithy.api#documentation": "

The UsageRecordResult Status indicates the status of an individual UsageRecord\n processed by BatchMeterUsage.

\n " } }, - "UsageRecord": { - "target": "com.amazonaws.marketplacemetering#UsageRecord", + "MeteringRecordId": { + "target": "com.amazonaws.marketplacemetering#String", "traits": { - "smithy.api#documentation": "

The UsageRecord that was part of the BatchMeterUsage request.

" + "smithy.api#documentation": "

The MeteringRecordId is a unique identifier for this metering event.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/mediaconnect.2018-11-14.json b/codegen/sdk-codegen/aws-models/mediaconnect.2018-11-14.json index 96eb96071990..aa53299d2cfd 100644 --- a/codegen/sdk-codegen/aws-models/mediaconnect.2018-11-14.json +++ b/codegen/sdk-codegen/aws-models/mediaconnect.2018-11-14.json @@ -115,19 +115,19 @@ "com.amazonaws.mediaconnect#AddFlowOutputsResponse": { "type": "structure", "members": { - "FlowArn": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The ARN of the flow that these outputs were added to.", - "smithy.api#jsonName": "flowArn" - } - }, "Outputs": { "target": "com.amazonaws.mediaconnect#__listOfOutput", "traits": { "smithy.api#documentation": "The details of the newly added outputs.", "smithy.api#jsonName": "outputs" } + }, + "FlowArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The ARN of the flow that these outputs were added to.", + "smithy.api#jsonName": "flowArn" + } } } }, @@ -196,19 +196,19 @@ "com.amazonaws.mediaconnect#AddFlowSourcesResponse": { "type": "structure", "members": { - "FlowArn": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The ARN of the flow that these sources were added to.", - "smithy.api#jsonName": "flowArn" - } - }, "Sources": { "target": "com.amazonaws.mediaconnect#__listOfSource", "traits": { "smithy.api#documentation": "The details of the newly added sources.", "smithy.api#jsonName": "sources" } + }, + "FlowArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The ARN of the flow that these sources were added to.", + "smithy.api#jsonName": "flowArn" + } } } }, @@ -296,41 +296,6 @@ "com.amazonaws.mediaconnect#AddOutputRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.", - "smithy.api#jsonName": "description" - } - }, - "Encryption": { - "target": "com.amazonaws.mediaconnect#Encryption", - "traits": { - "smithy.api#documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "smithy.api#jsonName": "encryption" - } - }, - "VpcInterfaceAttachment": { - "target": "com.amazonaws.mediaconnect#VpcInterfaceAttachment", - "traits": { - "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.", - "smithy.api#jsonName": "vpcInterfaceAttachment" - } - }, - "RemoteId": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The remote ID for the Zixi-pull output stream.", - "smithy.api#jsonName": "remoteId" - } - }, - "SmoothingLatency": { - "target": "com.amazonaws.mediaconnect#__integer", - "traits": { - "smithy.api#documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", - "smithy.api#jsonName": "smoothingLatency" - } - }, "StreamId": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -338,11 +303,11 @@ "smithy.api#jsonName": "streamId" } }, - "Port": { + "SmoothingLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The port to use when content is distributed to this output.", - "smithy.api#jsonName": "port" + "smithy.api#documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", + "smithy.api#jsonName": "smoothingLatency" } }, "Protocol": { @@ -360,6 +325,13 @@ "smithy.api#jsonName": "destination" } }, + "CidrAllowList": { + "target": "com.amazonaws.mediaconnect#__listOf__string", + "traits": { + "smithy.api#documentation": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "smithy.api#jsonName": "cidrAllowList" + } + }, "Name": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -367,6 +339,27 @@ "smithy.api#jsonName": "name" } }, + "RemoteId": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The remote ID for the Zixi-pull output stream.", + "smithy.api#jsonName": "remoteId" + } + }, + "Encryption": { + "target": "com.amazonaws.mediaconnect#Encryption", + "traits": { + "smithy.api#documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "smithy.api#jsonName": "encryption" + } + }, + "Port": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port to use when content is distributed to this output.", + "smithy.api#jsonName": "port" + } + }, "MaxLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { @@ -374,11 +367,18 @@ "smithy.api#jsonName": "maxLatency" } }, - "CidrAllowList": { - "target": "com.amazonaws.mediaconnect#__listOf__string", + "Description": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "smithy.api#jsonName": "cidrAllowList" + "smithy.api#documentation": "A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.", + "smithy.api#jsonName": "description" + } + }, + "VpcInterfaceAttachment": { + "target": "com.amazonaws.mediaconnect#VpcInterfaceAttachment", + "traits": { + "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.", + "smithy.api#jsonName": "vpcInterfaceAttachment" } } }, @@ -481,11 +481,16 @@ "com.amazonaws.mediaconnect#CreateFlowRequest": { "type": "structure", "members": { - "VpcInterfaces": { - "target": "com.amazonaws.mediaconnect#__listOfVpcInterfaceRequest", + "Sources": { + "target": "com.amazonaws.mediaconnect#__listOfSetSourceRequest", "traits": { - "smithy.api#documentation": "The VPC interfaces you want on the flow.", - "smithy.api#jsonName": "vpcInterfaces" + "smithy.api#jsonName": "sources" + } + }, + "Source": { + "target": "com.amazonaws.mediaconnect#SetSourceRequest", + "traits": { + "smithy.api#jsonName": "source" } }, "AvailabilityZone": { @@ -495,25 +500,6 @@ "smithy.api#jsonName": "availabilityZone" } }, - "SourceFailoverConfig": { - "target": "com.amazonaws.mediaconnect#FailoverConfig", - "traits": { - "smithy.api#jsonName": "sourceFailoverConfig" - } - }, - "Entitlements": { - "target": "com.amazonaws.mediaconnect#__listOfGrantEntitlementRequest", - "traits": { - "smithy.api#documentation": "The entitlements that you want to grant on a flow.", - "smithy.api#jsonName": "entitlements" - } - }, - "Sources": { - "target": "com.amazonaws.mediaconnect#__listOfSetSourceRequest", - "traits": { - "smithy.api#jsonName": "sources" - } - }, "Outputs": { "target": "com.amazonaws.mediaconnect#__listOfAddOutputRequest", "traits": { @@ -529,10 +515,24 @@ "smithy.api#required": {} } }, - "Source": { - "target": "com.amazonaws.mediaconnect#SetSourceRequest", + "Entitlements": { + "target": "com.amazonaws.mediaconnect#__listOfGrantEntitlementRequest", "traits": { - "smithy.api#jsonName": "source" + "smithy.api#documentation": "The entitlements that you want to grant on a flow.", + "smithy.api#jsonName": "entitlements" + } + }, + "VpcInterfaces": { + "target": "com.amazonaws.mediaconnect#__listOfVpcInterfaceRequest", + "traits": { + "smithy.api#documentation": "The VPC interfaces you want on the flow.", + "smithy.api#jsonName": "vpcInterfaces" + } + }, + "SourceFailoverConfig": { + "target": "com.amazonaws.mediaconnect#FailoverConfig", + "traits": { + "smithy.api#jsonName": "sourceFailoverConfig" } } }, @@ -673,60 +673,159 @@ "com.amazonaws.mediaconnect#DescribeFlowResponse": { "type": "structure", "members": { + "Flow": { + "target": "com.amazonaws.mediaconnect#Flow", + "traits": { + "smithy.api#jsonName": "flow" + } + }, "Messages": { "target": "com.amazonaws.mediaconnect#Messages", "traits": { "smithy.api#jsonName": "messages" } + } + } + }, + "com.amazonaws.mediaconnect#DescribeOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediaconnect#DescribeOfferingRequest" + }, + "output": { + "target": "com.amazonaws.mediaconnect#DescribeOfferingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediaconnect#BadRequestException" }, - "Flow": { - "target": "com.amazonaws.mediaconnect#Flow", - "traits": { - "smithy.api#jsonName": "flow" - } + { + "target": "com.amazonaws.mediaconnect#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mediaconnect#NotFoundException" + }, + { + "target": "com.amazonaws.mediaconnect#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.mediaconnect#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/offerings/{OfferingArn}", + "code": 200 } } }, - "com.amazonaws.mediaconnect#Encryption": { + "com.amazonaws.mediaconnect#DescribeOfferingRequest": { "type": "structure", "members": { - "SecretArn": { + "OfferingArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", - "smithy.api#jsonName": "secretArn" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the offering.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "KeyType": { - "target": "com.amazonaws.mediaconnect#KeyType", + } + } + }, + "com.amazonaws.mediaconnect#DescribeOfferingResponse": { + "type": "structure", + "members": { + "Offering": { + "target": "com.amazonaws.mediaconnect#Offering", "traits": { - "smithy.api#documentation": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "smithy.api#jsonName": "keyType" + "smithy.api#jsonName": "offering" } + } + } + }, + "com.amazonaws.mediaconnect#DescribeReservation": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediaconnect#DescribeReservationRequest" + }, + "output": { + "target": "com.amazonaws.mediaconnect#DescribeReservationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediaconnect#BadRequestException" }, - "ResourceId": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "smithy.api#jsonName": "resourceId" - } + { + "target": "com.amazonaws.mediaconnect#InternalServerErrorException" }, - "DeviceId": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "smithy.api#jsonName": "deviceId" - } + { + "target": "com.amazonaws.mediaconnect#NotFoundException" }, - "Region": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "smithy.api#jsonName": "region" - } + { + "target": "com.amazonaws.mediaconnect#ServiceUnavailableException" }, - "ConstantInitializationVector": { - "target": "com.amazonaws.mediaconnect#__string", + { + "target": "com.amazonaws.mediaconnect#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/reservations/{ReservationArn}", + "code": 200 + } + } + }, + "com.amazonaws.mediaconnect#DescribeReservationRequest": { + "type": "structure", + "members": { + "ReservationArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the reservation.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediaconnect#DescribeReservationResponse": { + "type": "structure", + "members": { + "Reservation": { + "target": "com.amazonaws.mediaconnect#Reservation", + "traits": { + "smithy.api#jsonName": "reservation" + } + } + } + }, + "com.amazonaws.mediaconnect#DurationUnits": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MONTHS", + "name": "MONTHS" + } + ] + } + }, + "com.amazonaws.mediaconnect#Encryption": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "smithy.api#jsonName": "region" + } + }, + "ConstantInitializationVector": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { "smithy.api#documentation": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.", "smithy.api#jsonName": "constantInitializationVector" @@ -740,6 +839,13 @@ "smithy.api#required": {} } }, + "ResourceId": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "smithy.api#jsonName": "resourceId" + } + }, "RoleArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -754,6 +860,27 @@ "smithy.api#documentation": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", "smithy.api#jsonName": "url" } + }, + "DeviceId": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "smithy.api#jsonName": "deviceId" + } + }, + "KeyType": { + "target": "com.amazonaws.mediaconnect#KeyType", + "traits": { + "smithy.api#documentation": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "smithy.api#jsonName": "keyType" + } + }, + "SecretArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", + "smithy.api#jsonName": "secretArn" + } } }, "traits": { @@ -763,18 +890,11 @@ "com.amazonaws.mediaconnect#Entitlement": { "type": "structure", "members": { - "EntitlementStatus": { - "target": "com.amazonaws.mediaconnect#EntitlementStatus", - "traits": { - "smithy.api#documentation": "An indication of whether the entitlement is enabled.", - "smithy.api#jsonName": "entitlementStatus" - } - }, - "EntitlementArn": { + "Name": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the entitlement.", - "smithy.api#jsonName": "entitlementArn", + "smithy.api#documentation": "The name of the entitlement.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, @@ -786,14 +906,6 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The name of the entitlement.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, "Encryption": { "target": "com.amazonaws.mediaconnect#Encryption", "traits": { @@ -814,6 +926,21 @@ "smithy.api#documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber.", "smithy.api#jsonName": "dataTransferSubscriberFeePercent" } + }, + "EntitlementStatus": { + "target": "com.amazonaws.mediaconnect#EntitlementStatus", + "traits": { + "smithy.api#documentation": "An indication of whether the entitlement is enabled.", + "smithy.api#jsonName": "entitlementStatus" + } + }, + "EntitlementArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The ARN of the entitlement.", + "smithy.api#jsonName": "entitlementArn", + "smithy.api#required": {} + } } }, "traits": { @@ -859,33 +986,26 @@ "com.amazonaws.mediaconnect#Flow": { "type": "structure", "members": { - "Source": { - "target": "com.amazonaws.mediaconnect#Source", - "traits": { - "smithy.api#jsonName": "source", - "smithy.api#required": {} - } - }, - "Name": { + "EgressIp": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The name of the flow.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "The IP address from which video will be sent to output destinations.", + "smithy.api#jsonName": "egressIp" } }, - "Entitlements": { - "target": "com.amazonaws.mediaconnect#__listOfEntitlement", + "FlowArn": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The entitlements in this flow.", - "smithy.api#jsonName": "entitlements", + "smithy.api#documentation": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", + "smithy.api#jsonName": "flowArn", "smithy.api#required": {} } }, - "Sources": { - "target": "com.amazonaws.mediaconnect#__listOfSource", + "Description": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#jsonName": "sources" + "smithy.api#documentation": "A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", + "smithy.api#jsonName": "description" } }, "VpcInterfaces": { @@ -895,55 +1015,62 @@ "smithy.api#jsonName": "vpcInterfaces" } }, - "EgressIp": { - "target": "com.amazonaws.mediaconnect#__string", + "Status": { + "target": "com.amazonaws.mediaconnect#Status", "traits": { - "smithy.api#documentation": "The IP address from which video will be sent to output destinations.", - "smithy.api#jsonName": "egressIp" + "smithy.api#documentation": "The current status of the flow.", + "smithy.api#jsonName": "status", + "smithy.api#required": {} } }, - "SourceFailoverConfig": { - "target": "com.amazonaws.mediaconnect#FailoverConfig", + "AvailabilityZone": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#jsonName": "sourceFailoverConfig" + "smithy.api#documentation": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.", + "smithy.api#jsonName": "availabilityZone", + "smithy.api#required": {} } }, - "Outputs": { - "target": "com.amazonaws.mediaconnect#__listOfOutput", + "Entitlements": { + "target": "com.amazonaws.mediaconnect#__listOfEntitlement", "traits": { - "smithy.api#documentation": "The outputs in this flow.", - "smithy.api#jsonName": "outputs", + "smithy.api#documentation": "The entitlements in this flow.", + "smithy.api#jsonName": "entitlements", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.mediaconnect#__string", + "Sources": { + "target": "com.amazonaws.mediaconnect#__listOfSource", "traits": { - "smithy.api#documentation": "A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", - "smithy.api#jsonName": "description" + "smithy.api#jsonName": "sources" } }, - "FlowArn": { - "target": "com.amazonaws.mediaconnect#__string", + "SourceFailoverConfig": { + "target": "com.amazonaws.mediaconnect#FailoverConfig", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", - "smithy.api#jsonName": "flowArn", + "smithy.api#jsonName": "sourceFailoverConfig" + } + }, + "Source": { + "target": "com.amazonaws.mediaconnect#Source", + "traits": { + "smithy.api#jsonName": "source", "smithy.api#required": {} } }, - "AvailabilityZone": { + "Name": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.", - "smithy.api#jsonName": "availabilityZone", + "smithy.api#documentation": "The name of the flow.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.mediaconnect#Status", + "Outputs": { + "target": "com.amazonaws.mediaconnect#__listOfOutput", "traits": { - "smithy.api#documentation": "The current status of the flow.", - "smithy.api#jsonName": "status", + "smithy.api#documentation": "The outputs in this flow.", + "smithy.api#jsonName": "outputs", "smithy.api#required": {} } } @@ -973,13 +1100,6 @@ "com.amazonaws.mediaconnect#GrantEntitlementRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The name of the entitlement. This value must be unique within the current flow.", - "smithy.api#jsonName": "name" - } - }, "Encryption": { "target": "com.amazonaws.mediaconnect#Encryption", "traits": { @@ -1001,13 +1121,6 @@ "smithy.api#jsonName": "description" } }, - "EntitlementStatus": { - "target": "com.amazonaws.mediaconnect#EntitlementStatus", - "traits": { - "smithy.api#documentation": "An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.", - "smithy.api#jsonName": "entitlementStatus" - } - }, "Subscribers": { "target": "com.amazonaws.mediaconnect#__listOf__string", "traits": { @@ -1015,6 +1128,20 @@ "smithy.api#jsonName": "subscribers", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The name of the entitlement. This value must be unique within the current flow.", + "smithy.api#jsonName": "name" + } + }, + "EntitlementStatus": { + "target": "com.amazonaws.mediaconnect#EntitlementStatus", + "traits": { + "smithy.api#documentation": "An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.", + "smithy.api#jsonName": "entitlementStatus" + } } }, "traits": { @@ -1082,14 +1209,6 @@ "com.amazonaws.mediaconnect#GrantFlowEntitlementsRequest": { "type": "structure", "members": { - "Entitlements": { - "target": "com.amazonaws.mediaconnect#__listOfGrantEntitlementRequest", - "traits": { - "smithy.api#documentation": "The list of entitlements that you want to grant.", - "smithy.api#jsonName": "entitlements", - "smithy.api#required": {} - } - }, "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -1098,6 +1217,14 @@ "smithy.api#pattern": "^arn:.*", "smithy.api#required": {} } + }, + "Entitlements": { + "target": "com.amazonaws.mediaconnect#__listOfGrantEntitlementRequest", + "traits": { + "smithy.api#documentation": "The list of entitlements that you want to grant.", + "smithy.api#jsonName": "entitlements", + "smithy.api#required": {} + } } }, "traits": { @@ -1107,24 +1234,24 @@ "com.amazonaws.mediaconnect#GrantFlowEntitlementsResponse": { "type": "structure", "members": { - "Entitlements": { - "target": "com.amazonaws.mediaconnect#__listOfEntitlement", - "traits": { - "smithy.api#documentation": "The entitlements that were just granted.", - "smithy.api#jsonName": "entitlements" - } - }, "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { "smithy.api#documentation": "The ARN of the flow that these entitlements were granted to.", "smithy.api#jsonName": "flowArn" } - } - } - }, - "com.amazonaws.mediaconnect#InternalServerErrorException": { - "type": "structure", + }, + "Entitlements": { + "target": "com.amazonaws.mediaconnect#__listOfEntitlement", + "traits": { + "smithy.api#documentation": "The entitlements that were just granted.", + "smithy.api#jsonName": "entitlements" + } + } + } + }, + "com.amazonaws.mediaconnect#InternalServerErrorException": { + "type": "structure", "members": { "Message": { "target": "com.amazonaws.mediaconnect#__string", @@ -1184,6 +1311,12 @@ "method": "GET", "uri": "/v1/entitlements", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entitlements", + "pageSize": "MaxResults" } } }, @@ -1253,25 +1386,31 @@ "method": "GET", "uri": "/v1/flows", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Flows", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediaconnect#ListFlowsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.", - "smithy.api#httpQuery": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.mediaconnect#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.", "smithy.api#httpQuery": "maxResults" } + }, + "NextToken": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -1294,6 +1433,156 @@ } } }, + "com.amazonaws.mediaconnect#ListOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediaconnect#ListOfferingsRequest" + }, + "output": { + "target": "com.amazonaws.mediaconnect#ListOfferingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediaconnect#BadRequestException" + }, + { + "target": "com.amazonaws.mediaconnect#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mediaconnect#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.mediaconnect#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/offerings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Offerings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.mediaconnect#ListOfferingsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.mediaconnect#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per API request. For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.mediaconnect#ListOfferingsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.", + "smithy.api#jsonName": "nextToken" + } + }, + "Offerings": { + "target": "com.amazonaws.mediaconnect#__listOfOffering", + "traits": { + "smithy.api#documentation": "A list of offerings that are available to this account in the current AWS Region.", + "smithy.api#jsonName": "offerings" + } + } + } + }, + "com.amazonaws.mediaconnect#ListReservations": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediaconnect#ListReservationsRequest" + }, + "output": { + "target": "com.amazonaws.mediaconnect#ListReservationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediaconnect#BadRequestException" + }, + { + "target": "com.amazonaws.mediaconnect#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mediaconnect#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.mediaconnect#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/reservations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Reservations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.mediaconnect#ListReservationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediaconnect#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per API request. For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.mediaconnect#ListReservationsResponse": { + "type": "structure", + "members": { + "Reservations": { + "target": "com.amazonaws.mediaconnect#__listOfReservation", + "traits": { + "smithy.api#documentation": "A list of all reservations that have been purchased by this account in the current AWS Region.", + "smithy.api#jsonName": "reservations" + } + }, + "NextToken": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.", + "smithy.api#jsonName": "nextToken" + } + } + } + }, "com.amazonaws.mediaconnect#ListTagsForResource": { "type": "operation", "input": { @@ -1350,6 +1639,13 @@ "com.amazonaws.mediaconnect#ListedEntitlement": { "type": "structure", "members": { + "DataTransferSubscriberFeePercent": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber.", + "smithy.api#jsonName": "dataTransferSubscriberFeePercent" + } + }, "EntitlementName": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -1365,13 +1661,6 @@ "smithy.api#jsonName": "entitlementArn", "smithy.api#required": {} } - }, - "DataTransferSubscriberFeePercent": { - "target": "com.amazonaws.mediaconnect#__integer", - "traits": { - "smithy.api#documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber.", - "smithy.api#jsonName": "dataTransferSubscriberFeePercent" - } } }, "traits": { @@ -1381,27 +1670,27 @@ "com.amazonaws.mediaconnect#ListedFlow": { "type": "structure", "members": { - "AvailabilityZone": { + "Description": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The Availability Zone that the flow was created in.", - "smithy.api#jsonName": "availabilityZone", + "smithy.api#documentation": "A description of the flow.", + "smithy.api#jsonName": "description", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.mediaconnect#__string", + "Status": { + "target": "com.amazonaws.mediaconnect#Status", "traits": { - "smithy.api#documentation": "A description of the flow.", - "smithy.api#jsonName": "description", + "smithy.api#documentation": "The current status of the flow.", + "smithy.api#jsonName": "status", "smithy.api#required": {} } }, - "FlowArn": { - "target": "com.amazonaws.mediaconnect#__string", + "SourceType": { + "target": "com.amazonaws.mediaconnect#SourceType", "traits": { - "smithy.api#documentation": "The ARN of the flow.", - "smithy.api#jsonName": "flowArn", + "smithy.api#documentation": "The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account).", + "smithy.api#jsonName": "sourceType", "smithy.api#required": {} } }, @@ -1413,19 +1702,19 @@ "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.mediaconnect#Status", + "AvailabilityZone": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The current status of the flow.", - "smithy.api#jsonName": "status", + "smithy.api#documentation": "The Availability Zone that the flow was created in.", + "smithy.api#jsonName": "availabilityZone", "smithy.api#required": {} } }, - "SourceType": { - "target": "com.amazonaws.mediaconnect#SourceType", + "FlowArn": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account).", - "smithy.api#jsonName": "sourceType", + "smithy.api#documentation": "The ARN of the flow.", + "smithy.api#jsonName": "flowArn", "smithy.api#required": {} } } @@ -1465,6 +1754,12 @@ { "target": "com.amazonaws.mediaconnect#DescribeFlow" }, + { + "target": "com.amazonaws.mediaconnect#DescribeOffering" + }, + { + "target": "com.amazonaws.mediaconnect#DescribeReservation" + }, { "target": "com.amazonaws.mediaconnect#GrantFlowEntitlements" }, @@ -1474,9 +1769,18 @@ { "target": "com.amazonaws.mediaconnect#ListFlows" }, + { + "target": "com.amazonaws.mediaconnect#ListOfferings" + }, + { + "target": "com.amazonaws.mediaconnect#ListReservations" + }, { "target": "com.amazonaws.mediaconnect#ListTagsForResource" }, + { + "target": "com.amazonaws.mediaconnect#PurchaseOffering" + }, { "target": "com.amazonaws.mediaconnect#RemoveFlowOutput" }, @@ -1563,50 +1867,101 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.mediaconnect#Output": { + "com.amazonaws.mediaconnect#Offering": { "type": "structure", "members": { - "Destination": { + "PriceUnits": { + "target": "com.amazonaws.mediaconnect#PriceUnits", + "traits": { + "smithy.api#documentation": "The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.", + "smithy.api#jsonName": "priceUnits", + "smithy.api#required": {} + } + }, + "ResourceSpecification": { + "target": "com.amazonaws.mediaconnect#ResourceSpecification", + "traits": { + "smithy.api#documentation": "A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.", + "smithy.api#jsonName": "resourceSpecification", + "smithy.api#required": {} + } + }, + "OfferingDescription": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The address where you want to send the output.", - "smithy.api#jsonName": "destination" + "smithy.api#documentation": "A description of the offering.", + "smithy.api#jsonName": "offeringDescription", + "smithy.api#required": {} } }, - "MediaLiveInputArn": { + "Duration": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The length of time that your reservation would be active.", + "smithy.api#jsonName": "duration", + "smithy.api#required": {} + } + }, + "PricePerUnit": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.", - "smithy.api#jsonName": "mediaLiveInputArn" + "smithy.api#documentation": "The cost of a single unit. This value, in combination with priceUnits, makes up the rate.", + "smithy.api#jsonName": "pricePerUnit", + "smithy.api#required": {} } }, - "Transport": { - "target": "com.amazonaws.mediaconnect#Transport", + "OfferingArn": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "Attributes related to the transport stream that are used in the output.", - "smithy.api#jsonName": "transport" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.", + "smithy.api#jsonName": "offeringArn", + "smithy.api#required": {} } }, - "OutputArn": { + "DurationUnits": { + "target": "com.amazonaws.mediaconnect#DurationUnits", + "traits": { + "smithy.api#documentation": "The unit of measurement for the duration of the offering.", + "smithy.api#jsonName": "durationUnits", + "smithy.api#required": {} + } + }, + "CurrencyCode": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the output.", - "smithy.api#jsonName": "outputArn", + "smithy.api#documentation": "The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.", + "smithy.api#jsonName": "currencyCode", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time." + } + }, + "com.amazonaws.mediaconnect#Output": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The name of the output. This value must be unique within the current flow.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, - "Encryption": { - "target": "com.amazonaws.mediaconnect#Encryption", + "Port": { + "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "The port to use when content is distributed to this output.", + "smithy.api#jsonName": "port" } }, - "VpcInterfaceAttachment": { - "target": "com.amazonaws.mediaconnect#VpcInterfaceAttachment", + "MediaLiveInputArn": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.", - "smithy.api#jsonName": "vpcInterfaceAttachment" + "smithy.api#documentation": "The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.", + "smithy.api#jsonName": "mediaLiveInputArn" } }, "Description": { @@ -1623,19 +1978,19 @@ "smithy.api#jsonName": "dataTransferSubscriberFeePercent" } }, - "Name": { + "OutputArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The name of the output. This value must be unique within the current flow.", - "smithy.api#jsonName": "name", + "smithy.api#documentation": "The ARN of the output.", + "smithy.api#jsonName": "outputArn", "smithy.api#required": {} } }, - "Port": { - "target": "com.amazonaws.mediaconnect#__integer", + "VpcInterfaceAttachment": { + "target": "com.amazonaws.mediaconnect#VpcInterfaceAttachment", "traits": { - "smithy.api#documentation": "The port to use when content is distributed to this output.", - "smithy.api#jsonName": "port" + "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.", + "smithy.api#jsonName": "vpcInterfaceAttachment" } }, "EntitlementArn": { @@ -1644,12 +1999,44 @@ "smithy.api#documentation": "The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.", "smithy.api#jsonName": "entitlementArn" } + }, + "Encryption": { + "target": "com.amazonaws.mediaconnect#Encryption", + "traits": { + "smithy.api#documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "smithy.api#jsonName": "encryption" + } + }, + "Transport": { + "target": "com.amazonaws.mediaconnect#Transport", + "traits": { + "smithy.api#documentation": "Attributes related to the transport stream that are used in the output.", + "smithy.api#jsonName": "transport" + } + }, + "Destination": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The address where you want to send the output.", + "smithy.api#jsonName": "destination" + } } }, "traits": { "smithy.api#documentation": "The settings for an output." } }, + "com.amazonaws.mediaconnect#PriceUnits": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HOURLY", + "name": "HOURLY" + } + ] + } + }, "com.amazonaws.mediaconnect#Protocol": { "type": "string", "traits": { @@ -1677,6 +2064,86 @@ ] } }, + "com.amazonaws.mediaconnect#PurchaseOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediaconnect#PurchaseOfferingRequest" + }, + "output": { + "target": "com.amazonaws.mediaconnect#PurchaseOfferingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediaconnect#BadRequestException" + }, + { + "target": "com.amazonaws.mediaconnect#ForbiddenException" + }, + { + "target": "com.amazonaws.mediaconnect#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mediaconnect#NotFoundException" + }, + { + "target": "com.amazonaws.mediaconnect#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.mediaconnect#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/offerings/{OfferingArn}", + "code": 201 + } + } + }, + "com.amazonaws.mediaconnect#PurchaseOfferingRequest": { + "type": "structure", + "members": { + "OfferingArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the offering.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Start": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.", + "smithy.api#jsonName": "start", + "smithy.api#required": {} + } + }, + "ReservationName": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The name that you want to use for the reservation.", + "smithy.api#jsonName": "reservationName", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to purchase a offering." + } + }, + "com.amazonaws.mediaconnect#PurchaseOfferingResponse": { + "type": "structure", + "members": { + "Reservation": { + "target": "com.amazonaws.mediaconnect#Reservation", + "traits": { + "smithy.api#jsonName": "reservation" + } + } + } + }, "com.amazonaws.mediaconnect#RemoveFlowOutput": { "type": "operation", "input": { @@ -1738,18 +2205,18 @@ "com.amazonaws.mediaconnect#RemoveFlowOutputResponse": { "type": "structure", "members": { - "FlowArn": { + "OutputArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the flow that is associated with the output you removed.", - "smithy.api#jsonName": "flowArn" + "smithy.api#documentation": "The ARN of the output that was removed.", + "smithy.api#jsonName": "outputArn" } }, - "OutputArn": { + "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the output that was removed.", - "smithy.api#jsonName": "outputArn" + "smithy.api#documentation": "The ARN of the flow that is associated with the output you removed.", + "smithy.api#jsonName": "flowArn" } } } @@ -1892,27 +2359,196 @@ "com.amazonaws.mediaconnect#RemoveFlowVpcInterfaceResponse": { "type": "structure", "members": { + "NonDeletedNetworkInterfaceIds": { + "target": "com.amazonaws.mediaconnect#__listOf__string", + "traits": { + "smithy.api#documentation": "IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove.", + "smithy.api#jsonName": "nonDeletedNetworkInterfaceIds" + } + }, + "VpcInterfaceName": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The name of the VPC interface that was removed.", + "smithy.api#jsonName": "vpcInterfaceName" + } + }, "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { "smithy.api#documentation": "The ARN of the flow that is associated with the VPC interface you removed.", "smithy.api#jsonName": "flowArn" } + } + } + }, + "com.amazonaws.mediaconnect#Reservation": { + "type": "structure", + "members": { + "OfferingDescription": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "A description of the offering. MediaConnect defines this value in the offering.", + "smithy.api#jsonName": "offeringDescription", + "smithy.api#required": {} + } }, - "VpcInterfaceName": { + "ReservationArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The name of the VPC interface that was removed.", - "smithy.api#jsonName": "vpcInterfaceName" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.", + "smithy.api#jsonName": "reservationArn", + "smithy.api#required": {} } }, - "NonDeletedNetworkInterfaceIds": { - "target": "com.amazonaws.mediaconnect#__listOf__string", + "Duration": { + "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove.", - "smithy.api#jsonName": "nonDeletedNetworkInterfaceIds" + "smithy.api#documentation": "The length of time that this reservation is active. MediaConnect defines this value in the offering.", + "smithy.api#jsonName": "duration", + "smithy.api#required": {} + } + }, + "ResourceSpecification": { + "target": "com.amazonaws.mediaconnect#ResourceSpecification", + "traits": { + "smithy.api#documentation": "A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.", + "smithy.api#jsonName": "resourceSpecification", + "smithy.api#required": {} + } + }, + "PricePerUnit": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.", + "smithy.api#jsonName": "pricePerUnit", + "smithy.api#required": {} + } + }, + "OfferingArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.", + "smithy.api#jsonName": "offeringArn", + "smithy.api#required": {} + } + }, + "End": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.", + "smithy.api#jsonName": "end", + "smithy.api#required": {} + } + }, + "ReservationState": { + "target": "com.amazonaws.mediaconnect#ReservationState", + "traits": { + "smithy.api#documentation": "The status of your reservation.", + "smithy.api#jsonName": "reservationState", + "smithy.api#required": {} + } + }, + "DurationUnits": { + "target": "com.amazonaws.mediaconnect#DurationUnits", + "traits": { + "smithy.api#documentation": "The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.", + "smithy.api#jsonName": "durationUnits", + "smithy.api#required": {} + } + }, + "ReservationName": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The name that you assigned to the reservation when you purchased the offering.", + "smithy.api#jsonName": "reservationName", + "smithy.api#required": {} + } + }, + "PriceUnits": { + "target": "com.amazonaws.mediaconnect#PriceUnits", + "traits": { + "smithy.api#documentation": "The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.", + "smithy.api#jsonName": "priceUnits", + "smithy.api#required": {} + } + }, + "Start": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The day and time that the reservation becomes active. You set this value when you purchase the offering.", + "smithy.api#jsonName": "start", + "smithy.api#required": {} + } + }, + "CurrencyCode": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.", + "smithy.api#jsonName": "currencyCode", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate." + } + }, + "com.amazonaws.mediaconnect#ReservationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "EXPIRED", + "name": "EXPIRED" + }, + { + "value": "PROCESSING", + "name": "PROCESSING" + }, + { + "value": "CANCELED", + "name": "CANCELED" + } + ] + } + }, + "com.amazonaws.mediaconnect#ResourceSpecification": { + "type": "structure", + "members": { + "ReservedBitrate": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The amount of outbound bandwidth that is discounted in the offering.", + "smithy.api#jsonName": "reservedBitrate" + } + }, + "ResourceType": { + "target": "com.amazonaws.mediaconnect#ResourceType", + "traits": { + "smithy.api#documentation": "The type of resource and the unit that is being billed for.", + "smithy.api#jsonName": "resourceType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A definition of what is being billed for, including the type and amount." + } + }, + "com.amazonaws.mediaconnect#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Mbps_Outbound_Bandwidth", + "name": "Mbps_Outbound_Bandwidth" } - } + ] } }, "com.amazonaws.mediaconnect#RevokeFlowEntitlement": { @@ -1955,18 +2591,18 @@ "com.amazonaws.mediaconnect#RevokeFlowEntitlementRequest": { "type": "structure", "members": { - "EntitlementArn": { + "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the entitlement that you want to revoke.", + "smithy.api#documentation": "The flow that you want to revoke an entitlement from.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "FlowArn": { + "EntitlementArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The flow that you want to revoke an entitlement from.", + "smithy.api#documentation": "The ARN of the entitlement that you want to revoke.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2013,6 +2649,13 @@ "com.amazonaws.mediaconnect#SetSourceRequest": { "type": "structure", "members": { + "EntitlementArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.", + "smithy.api#jsonName": "entitlementArn" + } + }, "VpcInterfaceName": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -2020,11 +2663,11 @@ "smithy.api#jsonName": "vpcInterfaceName" } }, - "IngestPort": { - "target": "com.amazonaws.mediaconnect#__integer", + "Protocol": { + "target": "com.amazonaws.mediaconnect#Protocol", "traits": { - "smithy.api#documentation": "The port that the flow will be listening on for incoming content.", - "smithy.api#jsonName": "ingestPort" + "smithy.api#documentation": "The protocol that is used by the source.", + "smithy.api#jsonName": "protocol" } }, "MaxBitrate": { @@ -2034,11 +2677,18 @@ "smithy.api#jsonName": "maxBitrate" } }, - "EntitlementArn": { + "Description": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.", - "smithy.api#jsonName": "entitlementArn" + "smithy.api#documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", + "smithy.api#jsonName": "description" + } + }, + "Name": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The name of the source.", + "smithy.api#jsonName": "name" } }, "MaxLatency": { @@ -2055,13 +2705,6 @@ "smithy.api#jsonName": "whitelistCidr" } }, - "Name": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The name of the source.", - "smithy.api#jsonName": "name" - } - }, "StreamId": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -2069,26 +2712,19 @@ "smithy.api#jsonName": "streamId" } }, + "IngestPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow will be listening on for incoming content.", + "smithy.api#jsonName": "ingestPort" + } + }, "Decryption": { "target": "com.amazonaws.mediaconnect#Encryption", "traits": { "smithy.api#documentation": "The type of encryption that is used on the content ingested from this source.", "smithy.api#jsonName": "decryption" } - }, - "Protocol": { - "target": "com.amazonaws.mediaconnect#Protocol", - "traits": { - "smithy.api#documentation": "The protocol that is used by the source.", - "smithy.api#jsonName": "protocol" - } - }, - "Description": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", - "smithy.api#jsonName": "description" - } } }, "traits": { @@ -2098,20 +2734,25 @@ "com.amazonaws.mediaconnect#Source": { "type": "structure", "members": { - "SourceArn": { + "IngestIp": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the source.", - "smithy.api#jsonName": "sourceArn", - "smithy.api#required": {} + "smithy.api#documentation": "The IP address that the flow will be listening on for incoming content.", + "smithy.api#jsonName": "ingestIp" } }, - "Name": { + "EntitlementArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The name of the source.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.", + "smithy.api#jsonName": "entitlementArn" + } + }, + "Description": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", + "smithy.api#jsonName": "description" } }, "DataTransferSubscriberFeePercent": { @@ -2121,6 +2762,14 @@ "smithy.api#jsonName": "dataTransferSubscriberFeePercent" } }, + "SourceArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The ARN of the source.", + "smithy.api#jsonName": "sourceArn", + "smithy.api#required": {} + } + }, "WhitelistCidr": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -2128,11 +2777,11 @@ "smithy.api#jsonName": "whitelistCidr" } }, - "Description": { - "target": "com.amazonaws.mediaconnect#__string", + "IngestPort": { + "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The port that the flow will be listening on for incoming content.", + "smithy.api#jsonName": "ingestPort" } }, "VpcInterfaceName": { @@ -2156,25 +2805,12 @@ "smithy.api#jsonName": "decryption" } }, - "EntitlementArn": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.", - "smithy.api#jsonName": "entitlementArn" - } - }, - "IngestPort": { - "target": "com.amazonaws.mediaconnect#__integer", - "traits": { - "smithy.api#documentation": "The port that the flow will be listening on for incoming content.", - "smithy.api#jsonName": "ingestPort" - } - }, - "IngestIp": { + "Name": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The IP address that the flow will be listening on for incoming content.", - "smithy.api#jsonName": "ingestIp" + "smithy.api#documentation": "The name of the source.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } } }, @@ -2415,14 +3051,6 @@ "com.amazonaws.mediaconnect#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediaconnect#__mapOf__string", - "traits": { - "smithy.api#documentation": "A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -2430,6 +3058,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.mediaconnect#__mapOf__string", + "traits": { + "smithy.api#documentation": "A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } } }, "traits": { @@ -2457,11 +3093,19 @@ "com.amazonaws.mediaconnect#Transport": { "type": "structure", "members": { - "RemoteId": { - "target": "com.amazonaws.mediaconnect#__string", + "Protocol": { + "target": "com.amazonaws.mediaconnect#Protocol", "traits": { - "smithy.api#documentation": "The remote ID for the Zixi-pull stream.", - "smithy.api#jsonName": "remoteId" + "smithy.api#documentation": "The protocol that is used by the source or output.", + "smithy.api#jsonName": "protocol", + "smithy.api#required": {} + } + }, + "MaxLatency": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", + "smithy.api#jsonName": "maxLatency" } }, "CidrAllowList": { @@ -2471,18 +3115,18 @@ "smithy.api#jsonName": "cidrAllowList" } }, - "MaxLatency": { + "MaxBitrate": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", - "smithy.api#jsonName": "maxLatency" + "smithy.api#documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", + "smithy.api#jsonName": "maxBitrate" } }, - "SmoothingLatency": { - "target": "com.amazonaws.mediaconnect#__integer", + "RemoteId": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", - "smithy.api#jsonName": "smoothingLatency" + "smithy.api#documentation": "The remote ID for the Zixi-pull stream.", + "smithy.api#jsonName": "remoteId" } }, "StreamId": { @@ -2492,19 +3136,11 @@ "smithy.api#jsonName": "streamId" } }, - "Protocol": { - "target": "com.amazonaws.mediaconnect#Protocol", - "traits": { - "smithy.api#documentation": "The protocol that is used by the source or output.", - "smithy.api#jsonName": "protocol", - "smithy.api#required": {} - } - }, - "MaxBitrate": { + "SmoothingLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", + "smithy.api#jsonName": "smoothingLatency" } } }, @@ -2540,14 +3176,6 @@ "com.amazonaws.mediaconnect#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "TagKeys": { "target": "com.amazonaws.mediaconnect#__listOf__string", "traits": { @@ -2555,6 +3183,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "ResourceArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -2568,18 +3204,18 @@ "smithy.api#jsonName": "region" } }, - "RoleArn": { + "Url": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", + "smithy.api#jsonName": "url" } }, - "Url": { + "RoleArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).", + "smithy.api#jsonName": "roleArn" } }, "Algorithm": { @@ -2589,6 +3225,13 @@ "smithy.api#jsonName": "algorithm" } }, + "SecretArn": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", + "smithy.api#jsonName": "secretArn" + } + }, "KeyType": { "target": "com.amazonaws.mediaconnect#KeyType", "traits": { @@ -2616,13 +3259,6 @@ "smithy.api#documentation": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.", "smithy.api#jsonName": "resourceId" } - }, - "SecretArn": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.", - "smithy.api#jsonName": "secretArn" - } } }, "traits": { @@ -2727,18 +3363,11 @@ "com.amazonaws.mediaconnect#UpdateFlowEntitlementRequest": { "type": "structure", "members": { - "EntitlementStatus": { - "target": "com.amazonaws.mediaconnect#EntitlementStatus", - "traits": { - "smithy.api#documentation": "An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.", - "smithy.api#jsonName": "entitlementStatus" - } - }, - "Encryption": { - "target": "com.amazonaws.mediaconnect#UpdateEncryption", + "Subscribers": { + "target": "com.amazonaws.mediaconnect#__listOf__string", "traits": { - "smithy.api#documentation": "The type of encryption that will be used on the output associated with this entitlement.", - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.", + "smithy.api#jsonName": "subscribers" } }, "Description": { @@ -2748,27 +3377,34 @@ "smithy.api#jsonName": "description" } }, - "FlowArn": { + "EntitlementStatus": { + "target": "com.amazonaws.mediaconnect#EntitlementStatus", + "traits": { + "smithy.api#documentation": "An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.", + "smithy.api#jsonName": "entitlementStatus" + } + }, + "EntitlementArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The flow that is associated with the entitlement that you want to update.", + "smithy.api#documentation": "The ARN of the entitlement that you want to update.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "EntitlementArn": { + "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the entitlement that you want to update.", + "smithy.api#documentation": "The flow that is associated with the entitlement that you want to update.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Subscribers": { - "target": "com.amazonaws.mediaconnect#__listOf__string", + "Encryption": { + "target": "com.amazonaws.mediaconnect#UpdateEncryption", "traits": { - "smithy.api#documentation": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.", - "smithy.api#jsonName": "subscribers" + "smithy.api#documentation": "The type of encryption that will be used on the output associated with this entitlement.", + "smithy.api#jsonName": "encryption" } } }, @@ -2779,18 +3415,19 @@ "com.amazonaws.mediaconnect#UpdateFlowEntitlementResponse": { "type": "structure", "members": { - "Entitlement": { - "target": "com.amazonaws.mediaconnect#Entitlement", - "traits": { - "smithy.api#jsonName": "entitlement" - } - }, "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { "smithy.api#documentation": "The ARN of the flow that this entitlement was granted on.", "smithy.api#jsonName": "flowArn" } + }, + "Entitlement": { + "target": "com.amazonaws.mediaconnect#Entitlement", + "traits": { + "smithy.api#documentation": "The new configuration of the entitlement that you updated.", + "smithy.api#jsonName": "entitlement" + } } } }, @@ -2834,11 +3471,39 @@ "com.amazonaws.mediaconnect#UpdateFlowOutputRequest": { "type": "structure", "members": { - "CidrAllowList": { - "target": "com.amazonaws.mediaconnect#__listOf__string", + "MaxLatency": { + "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "smithy.api#jsonName": "cidrAllowList" + "smithy.api#documentation": "The maximum latency in milliseconds for Zixi-based streams.", + "smithy.api#jsonName": "maxLatency" + } + }, + "Protocol": { + "target": "com.amazonaws.mediaconnect#Protocol", + "traits": { + "smithy.api#documentation": "The protocol to use for the output.", + "smithy.api#jsonName": "protocol" + } + }, + "Encryption": { + "target": "com.amazonaws.mediaconnect#UpdateEncryption", + "traits": { + "smithy.api#documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", + "smithy.api#jsonName": "encryption" + } + }, + "Port": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port to use when content is distributed to this output.", + "smithy.api#jsonName": "port" + } + }, + "RemoteId": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The remote ID for the Zixi-pull stream.", + "smithy.api#jsonName": "remoteId" } }, "Destination": { @@ -2863,20 +3528,6 @@ "smithy.api#required": {} } }, - "Encryption": { - "target": "com.amazonaws.mediaconnect#UpdateEncryption", - "traits": { - "smithy.api#documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).", - "smithy.api#jsonName": "encryption" - } - }, - "Port": { - "target": "com.amazonaws.mediaconnect#__integer", - "traits": { - "smithy.api#documentation": "The port to use when content is distributed to this output.", - "smithy.api#jsonName": "port" - } - }, "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -2885,25 +3536,11 @@ "smithy.api#required": {} } }, - "RemoteId": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "The remote ID for the Zixi-pull stream.", - "smithy.api#jsonName": "remoteId" - } - }, - "MaxLatency": { - "target": "com.amazonaws.mediaconnect#__integer", - "traits": { - "smithy.api#documentation": "The maximum latency in milliseconds for Zixi-based streams.", - "smithy.api#jsonName": "maxLatency" - } - }, - "Protocol": { - "target": "com.amazonaws.mediaconnect#Protocol", + "CidrAllowList": { + "target": "com.amazonaws.mediaconnect#__listOf__string", "traits": { - "smithy.api#documentation": "The protocol to use for the output.", - "smithy.api#jsonName": "protocol" + "smithy.api#documentation": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "smithy.api#jsonName": "cidrAllowList" } }, "VpcInterfaceAttachment": { @@ -2913,19 +3550,19 @@ "smithy.api#jsonName": "vpcInterfaceAttachment" } }, - "SmoothingLatency": { - "target": "com.amazonaws.mediaconnect#__integer", - "traits": { - "smithy.api#documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", - "smithy.api#jsonName": "smoothingLatency" - } - }, "StreamId": { "target": "com.amazonaws.mediaconnect#__string", "traits": { "smithy.api#documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.", "smithy.api#jsonName": "streamId" } + }, + "SmoothingLatency": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.", + "smithy.api#jsonName": "smoothingLatency" + } } }, "traits": { @@ -2935,30 +3572,25 @@ "com.amazonaws.mediaconnect#UpdateFlowOutputResponse": { "type": "structure", "members": { - "Output": { - "target": "com.amazonaws.mediaconnect#Output", - "traits": { - "smithy.api#jsonName": "output" - } - }, "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { "smithy.api#documentation": "The ARN of the flow that is associated with the updated output.", "smithy.api#jsonName": "flowArn" } + }, + "Output": { + "target": "com.amazonaws.mediaconnect#Output", + "traits": { + "smithy.api#documentation": "The new settings of the output that you updated.", + "smithy.api#jsonName": "output" + } } } }, "com.amazonaws.mediaconnect#UpdateFlowRequest": { "type": "structure", "members": { - "SourceFailoverConfig": { - "target": "com.amazonaws.mediaconnect#UpdateFailoverConfig", - "traits": { - "smithy.api#jsonName": "sourceFailoverConfig" - } - }, "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -2966,6 +3598,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "SourceFailoverConfig": { + "target": "com.amazonaws.mediaconnect#UpdateFailoverConfig", + "traits": { + "smithy.api#jsonName": "sourceFailoverConfig" + } } }, "traits": { @@ -3023,31 +3661,25 @@ "com.amazonaws.mediaconnect#UpdateFlowSourceRequest": { "type": "structure", "members": { - "VpcInterfaceName": { + "EntitlementArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The name of the VPC Interface to configure this Source with.", - "smithy.api#jsonName": "vpcInterfaceName" + "smithy.api#documentation": "The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.", + "smithy.api#jsonName": "entitlementArn" } }, - "Description": { + "SourceArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", - "smithy.api#jsonName": "description" - } - }, - "MaxBitrate": { - "target": "com.amazonaws.mediaconnect#__integer", - "traits": { - "smithy.api#documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "The ARN of the source that you want to update.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SourceArn": { + "FlowArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The ARN of the source that you want to update.", + "smithy.api#documentation": "The flow that is associated with the source that you want to update.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3066,18 +3698,25 @@ "smithy.api#jsonName": "streamId" } }, - "Protocol": { - "target": "com.amazonaws.mediaconnect#Protocol", + "WhitelistCidr": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The protocol that is used by the source.", - "smithy.api#jsonName": "protocol" + "smithy.api#documentation": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", + "smithy.api#jsonName": "whitelistCidr" } }, - "EntitlementArn": { - "target": "com.amazonaws.mediaconnect#__string", + "MaxBitrate": { + "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.", - "smithy.api#jsonName": "entitlementArn" + "smithy.api#documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.", + "smithy.api#jsonName": "maxBitrate" + } + }, + "IngestPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow will be listening on for incoming content.", + "smithy.api#jsonName": "ingestPort" } }, "MaxLatency": { @@ -3087,26 +3726,25 @@ "smithy.api#jsonName": "maxLatency" } }, - "WhitelistCidr": { - "target": "com.amazonaws.mediaconnect#__string", + "Protocol": { + "target": "com.amazonaws.mediaconnect#Protocol", "traits": { - "smithy.api#documentation": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.", - "smithy.api#jsonName": "whitelistCidr" + "smithy.api#documentation": "The protocol that is used by the source.", + "smithy.api#jsonName": "protocol" } }, - "IngestPort": { - "target": "com.amazonaws.mediaconnect#__integer", + "VpcInterfaceName": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The port that the flow will be listening on for incoming content.", - "smithy.api#jsonName": "ingestPort" + "smithy.api#documentation": "The name of the VPC Interface to configure this Source with.", + "smithy.api#jsonName": "vpcInterfaceName" } }, - "FlowArn": { + "Description": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The flow that is associated with the source that you want to update.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.", + "smithy.api#jsonName": "description" } } }, @@ -3136,6 +3774,14 @@ "com.amazonaws.mediaconnect#VpcInterface": { "type": "structure", "members": { + "NetworkInterfaceIds": { + "target": "com.amazonaws.mediaconnect#__listOf__string", + "traits": { + "smithy.api#documentation": "IDs of the network interfaces created in customer's account by MediaConnect.", + "smithy.api#jsonName": "networkInterfaceIds", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -3144,11 +3790,11 @@ "smithy.api#required": {} } }, - "NetworkInterfaceIds": { - "target": "com.amazonaws.mediaconnect#__listOf__string", + "RoleArn": { + "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "IDs of the network interfaces created in customer's account by MediaConnect.", - "smithy.api#jsonName": "networkInterfaceIds", + "smithy.api#documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account", + "smithy.api#jsonName": "roleArn", "smithy.api#required": {} } }, @@ -3167,14 +3813,6 @@ "smithy.api#jsonName": "subnetId", "smithy.api#required": {} } - }, - "RoleArn": { - "target": "com.amazonaws.mediaconnect#__string", - "traits": { - "smithy.api#documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account", - "smithy.api#jsonName": "roleArn", - "smithy.api#required": {} - } } }, "traits": { @@ -3199,11 +3837,11 @@ "com.amazonaws.mediaconnect#VpcInterfaceRequest": { "type": "structure", "members": { - "SubnetId": { + "RoleArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "Subnet must be in the AZ of the Flow", - "smithy.api#jsonName": "subnetId", + "smithy.api#documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account", + "smithy.api#jsonName": "roleArn", "smithy.api#required": {} } }, @@ -3215,19 +3853,19 @@ "smithy.api#required": {} } }, - "RoleArn": { + "Name": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account", - "smithy.api#jsonName": "roleArn", + "smithy.api#documentation": "The name of the VPC Interface. This value must be unique within the current flow.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, - "Name": { + "SubnetId": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "The name of the VPC Interface. This value must be unique within the current flow.", - "smithy.api#jsonName": "name", + "smithy.api#documentation": "Subnet must be in the AZ of the Flow", + "smithy.api#jsonName": "subnetId", "smithy.api#required": {} } } @@ -3269,12 +3907,24 @@ "target": "com.amazonaws.mediaconnect#ListedFlow" } }, + "com.amazonaws.mediaconnect#__listOfOffering": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconnect#Offering" + } + }, "com.amazonaws.mediaconnect#__listOfOutput": { "type": "list", "member": { "target": "com.amazonaws.mediaconnect#Output" } }, + "com.amazonaws.mediaconnect#__listOfReservation": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconnect#Reservation" + } + }, "com.amazonaws.mediaconnect#__listOfSetSourceRequest": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json index b7cf8fa73d9d..80b3b0120a44 100644 --- a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json +++ b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json @@ -128,6 +128,13 @@ "com.amazonaws.mediaconvert#AacSettings": { "type": "structure", "members": { + "VbrQuality": { + "target": "com.amazonaws.mediaconvert#AacVbrQuality", + "traits": { + "smithy.api#documentation": "VBR Quality Level - Only used if rate_control_mode is VBR.", + "smithy.api#jsonName": "vbrQuality" + } + }, "RawFormat": { "target": "com.amazonaws.mediaconvert#AacRawFormat", "traits": { @@ -135,18 +142,18 @@ "smithy.api#jsonName": "rawFormat" } }, - "Specification": { - "target": "com.amazonaws.mediaconvert#AacSpecification", + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#AacCodecProfile", "traits": { - "smithy.api#documentation": "Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.", - "smithy.api#jsonName": "specification" + "smithy.api#documentation": "AAC Profile.", + "smithy.api#jsonName": "codecProfile" } }, - "VbrQuality": { - "target": "com.amazonaws.mediaconvert#AacVbrQuality", + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin8000Max96000", "traits": { - "smithy.api#documentation": "VBR Quality Level - Only used if rate_control_mode is VBR.", - "smithy.api#jsonName": "vbrQuality" + "smithy.api#documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile.", + "smithy.api#jsonName": "sampleRate" } }, "RateControlMode": { @@ -163,13 +170,6 @@ "smithy.api#jsonName": "codingMode" } }, - "CodecProfile": { - "target": "com.amazonaws.mediaconvert#AacCodecProfile", - "traits": { - "smithy.api#documentation": "AAC Profile.", - "smithy.api#jsonName": "codecProfile" - } - }, "AudioDescriptionBroadcasterMix": { "target": "com.amazonaws.mediaconvert#AacAudioDescriptionBroadcasterMix", "traits": { @@ -177,19 +177,19 @@ "smithy.api#jsonName": "audioDescriptionBroadcasterMix" } }, - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin8000Max96000", - "traits": { - "smithy.api#documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile.", - "smithy.api#jsonName": "sampleRate" - } - }, "Bitrate": { "target": "com.amazonaws.mediaconvert#__integerMin6000Max1024000", "traits": { "smithy.api#documentation": "Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile.", "smithy.api#jsonName": "bitrate" } + }, + "Specification": { + "target": "com.amazonaws.mediaconvert#AacSpecification", + "traits": { + "smithy.api#documentation": "Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.", + "smithy.api#jsonName": "specification" + } } }, "traits": { @@ -351,11 +351,25 @@ "com.amazonaws.mediaconvert#Ac3Settings": { "type": "structure", "members": { - "LfeFilter": { - "target": "com.amazonaws.mediaconvert#Ac3LfeFilter", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin64000Max640000", "traits": { - "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", - "smithy.api#jsonName": "lfeFilter" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.", + "smithy.api#jsonName": "bitrate" + } + }, + "CodingMode": { + "target": "com.amazonaws.mediaconvert#Ac3CodingMode", + "traits": { + "smithy.api#documentation": "Dolby Digital coding mode. Determines number of channels.", + "smithy.api#jsonName": "codingMode" + } + }, + "Dialnorm": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max31", + "traits": { + "smithy.api#documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through.", + "smithy.api#jsonName": "dialnorm" } }, "BitstreamMode": { @@ -365,13 +379,6 @@ "smithy.api#jsonName": "bitstreamMode" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin64000Max640000", - "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.", - "smithy.api#jsonName": "bitrate" - } - }, "DynamicRangeCompressionProfile": { "target": "com.amazonaws.mediaconvert#Ac3DynamicRangeCompressionProfile", "traits": { @@ -379,13 +386,6 @@ "smithy.api#jsonName": "dynamicRangeCompressionProfile" } }, - "CodingMode": { - "target": "com.amazonaws.mediaconvert#Ac3CodingMode", - "traits": { - "smithy.api#documentation": "Dolby Digital coding mode. Determines number of channels.", - "smithy.api#jsonName": "codingMode" - } - }, "MetadataControl": { "target": "com.amazonaws.mediaconvert#Ac3MetadataControl", "traits": { @@ -400,11 +400,11 @@ "smithy.api#jsonName": "sampleRate" } }, - "Dialnorm": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max31", + "LfeFilter": { + "target": "com.amazonaws.mediaconvert#Ac3LfeFilter", "traits": { - "smithy.api#documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through.", - "smithy.api#jsonName": "dialnorm" + "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", + "smithy.api#jsonName": "lfeFilter" } } }, @@ -502,19 +502,19 @@ "smithy.api#jsonName": "sampleRate" } }, - "BitDepth": { - "target": "com.amazonaws.mediaconvert#__integerMin16Max24", - "traits": { - "smithy.api#documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.", - "smithy.api#jsonName": "bitDepth" - } - }, "Channels": { "target": "com.amazonaws.mediaconvert#__integerMin1Max64", "traits": { "smithy.api#documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64.", "smithy.api#jsonName": "channels" } + }, + "BitDepth": { + "target": "com.amazonaws.mediaconvert#__integerMin16Max24", + "traits": { + "smithy.api#documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.", + "smithy.api#jsonName": "bitDepth" + } } }, "traits": { @@ -556,6 +556,13 @@ "com.amazonaws.mediaconvert#AncillarySourceSettings": { "type": "structure", "members": { + "TerminateCaptions": { + "target": "com.amazonaws.mediaconvert#AncillaryTerminateCaptions", + "traits": { + "smithy.api#documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.", + "smithy.api#jsonName": "terminateCaptions" + } + }, "SourceAncillaryChannelNumber": { "target": "com.amazonaws.mediaconvert#__integerMin1Max4", "traits": { @@ -569,13 +576,6 @@ "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", "smithy.api#jsonName": "convert608To708" } - }, - "TerminateCaptions": { - "target": "com.amazonaws.mediaconvert#AncillaryTerminateCaptions", - "traits": { - "smithy.api#documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.", - "smithy.api#jsonName": "terminateCaptions" - } } }, "traits": { @@ -668,6 +668,89 @@ "type": "structure", "members": {} }, + "com.amazonaws.mediaconvert#AudioChannelTag": { + "type": "string", + "traits": { + "smithy.api#documentation": "You can add a tag for this mono-channel audio track to mimic its placement in a multi-channel layout. For example, if this track is the left surround channel, choose Left surround (LS).", + "smithy.api#enum": [ + { + "value": "L", + "name": "L" + }, + { + "value": "R", + "name": "R" + }, + { + "value": "C", + "name": "C" + }, + { + "value": "LFE", + "name": "LFE" + }, + { + "value": "LS", + "name": "LS" + }, + { + "value": "RS", + "name": "RS" + }, + { + "value": "LC", + "name": "LC" + }, + { + "value": "RC", + "name": "RC" + }, + { + "value": "CS", + "name": "CS" + }, + { + "value": "LSD", + "name": "LSD" + }, + { + "value": "RSD", + "name": "RSD" + }, + { + "value": "TCS", + "name": "TCS" + }, + { + "value": "VHL", + "name": "VHL" + }, + { + "value": "VHC", + "name": "VHC" + }, + { + "value": "VHR", + "name": "VHR" + } + ] + } + }, + "com.amazonaws.mediaconvert#AudioChannelTaggingSettings": { + "type": "structure", + "members": { + "ChannelTag": { + "target": "com.amazonaws.mediaconvert#AudioChannelTag", + "traits": { + "smithy.api#documentation": "You can add a tag for this mono-channel audio track to mimic its placement in a multi-channel layout. For example, if this track is the left surround channel, choose Left surround (LS).", + "smithy.api#jsonName": "channelTag" + } + } + }, + "traits": { + "smithy.api#documentation": "When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use audio layout tagging, your output must be in a QuickTime (.mov) container; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel." + } + }, "com.amazonaws.mediaconvert#AudioCodec": { "type": "string", "traits": { @@ -723,20 +806,6 @@ "com.amazonaws.mediaconvert#AudioCodecSettings": { "type": "structure", "members": { - "Mp3Settings": { - "target": "com.amazonaws.mediaconvert#Mp3Settings", - "traits": { - "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.", - "smithy.api#jsonName": "mp3Settings" - } - }, - "Mp2Settings": { - "target": "com.amazonaws.mediaconvert#Mp2Settings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.", - "smithy.api#jsonName": "mp2Settings" - } - }, "AacSettings": { "target": "com.amazonaws.mediaconvert#AacSettings", "traits": { @@ -744,13 +813,6 @@ "smithy.api#jsonName": "aacSettings" } }, - "OpusSettings": { - "target": "com.amazonaws.mediaconvert#OpusSettings", - "traits": { - "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS.", - "smithy.api#jsonName": "opusSettings" - } - }, "Ac3Settings": { "target": "com.amazonaws.mediaconvert#Ac3Settings", "traits": { @@ -758,18 +820,11 @@ "smithy.api#jsonName": "ac3Settings" } }, - "Eac3Settings": { - "target": "com.amazonaws.mediaconvert#Eac3Settings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.", - "smithy.api#jsonName": "eac3Settings" - } - }, - "VorbisSettings": { - "target": "com.amazonaws.mediaconvert#VorbisSettings", + "WavSettings": { + "target": "com.amazonaws.mediaconvert#WavSettings", "traits": { - "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.", - "smithy.api#jsonName": "vorbisSettings" + "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.", + "smithy.api#jsonName": "wavSettings" } }, "Codec": { @@ -779,6 +834,13 @@ "smithy.api#jsonName": "codec" } }, + "VorbisSettings": { + "target": "com.amazonaws.mediaconvert#VorbisSettings", + "traits": { + "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.", + "smithy.api#jsonName": "vorbisSettings" + } + }, "AiffSettings": { "target": "com.amazonaws.mediaconvert#AiffSettings", "traits": { @@ -786,6 +848,20 @@ "smithy.api#jsonName": "aiffSettings" } }, + "Mp2Settings": { + "target": "com.amazonaws.mediaconvert#Mp2Settings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.", + "smithy.api#jsonName": "mp2Settings" + } + }, + "OpusSettings": { + "target": "com.amazonaws.mediaconvert#OpusSettings", + "traits": { + "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS.", + "smithy.api#jsonName": "opusSettings" + } + }, "Eac3AtmosSettings": { "target": "com.amazonaws.mediaconvert#Eac3AtmosSettings", "traits": { @@ -793,11 +869,18 @@ "smithy.api#jsonName": "eac3AtmosSettings" } }, - "WavSettings": { - "target": "com.amazonaws.mediaconvert#WavSettings", + "Mp3Settings": { + "target": "com.amazonaws.mediaconvert#Mp3Settings", "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.", - "smithy.api#jsonName": "wavSettings" + "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.", + "smithy.api#jsonName": "mp3Settings" + } + }, + "Eac3Settings": { + "target": "com.amazonaws.mediaconvert#Eac3Settings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.", + "smithy.api#jsonName": "eac3Settings" } } }, @@ -824,20 +907,6 @@ "com.amazonaws.mediaconvert#AudioDescription": { "type": "structure", "members": { - "CodecSettings": { - "target": "com.amazonaws.mediaconvert#AudioCodecSettings", - "traits": { - "smithy.api#documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings * VORBIS, VorbisSettings * OPUS, OpusSettings", - "smithy.api#jsonName": "codecSettings" - } - }, - "LanguageCode": { - "target": "com.amazonaws.mediaconvert#LanguageCode", - "traits": { - "smithy.api#documentation": "Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.", - "smithy.api#jsonName": "languageCode" - } - }, "AudioType": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { @@ -845,18 +914,18 @@ "smithy.api#jsonName": "audioType" } }, - "RemixSettings": { - "target": "com.amazonaws.mediaconvert#RemixSettings", + "AudioSourceName": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Advanced audio remixing settings.", - "smithy.api#jsonName": "remixSettings" + "smithy.api#documentation": "Specifies which audio data to use from each input. In the simplest case, specify an \"Audio Selector\":#inputs-audio_selector by name based on its order within each input. For example if you specify \"Audio Selector 3\", then the third audio selector will be used from each input. If an input does not have an \"Audio Selector 3\", then the audio selector marked as \"default\" in that input will be used. If there is no audio selector marked as \"default\", silence will be inserted for the duration of that input. Alternatively, an \"Audio Selector Group\":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then \"Audio Selector 1\" will be chosen automatically.", + "smithy.api#jsonName": "audioSourceName" } }, - "AudioTypeControl": { - "target": "com.amazonaws.mediaconvert#AudioTypeControl", + "AudioChannelTaggingSettings": { + "target": "com.amazonaws.mediaconvert#AudioChannelTaggingSettings", "traits": { - "smithy.api#documentation": "When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.", - "smithy.api#jsonName": "audioTypeControl" + "smithy.api#documentation": "When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use audio layout tagging, your output must be in a QuickTime (.mov) container; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel.", + "smithy.api#jsonName": "audioChannelTaggingSettings" } }, "LanguageCodeControl": { @@ -873,18 +942,18 @@ "smithy.api#jsonName": "audioNormalizationSettings" } }, - "CustomLanguageCode": { - "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", + "LanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { - "smithy.api#documentation": "Specify the language for this audio output track. The service puts this language code into your output audio track when you set Language code control (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). The service also uses your specified custom language code when you set Language code control (AudioLanguageCodeControl) to Follow input (FOLLOW_INPUT), but your input file doesn't specify a language code. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", - "smithy.api#jsonName": "customLanguageCode" + "smithy.api#documentation": "Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.", + "smithy.api#jsonName": "languageCode" } }, - "AudioSourceName": { - "target": "com.amazonaws.mediaconvert#__string", + "RemixSettings": { + "target": "com.amazonaws.mediaconvert#RemixSettings", "traits": { - "smithy.api#documentation": "Specifies which audio data to use from each input. In the simplest case, specify an \"Audio Selector\":#inputs-audio_selector by name based on its order within each input. For example if you specify \"Audio Selector 3\", then the third audio selector will be used from each input. If an input does not have an \"Audio Selector 3\", then the audio selector marked as \"default\" in that input will be used. If there is no audio selector marked as \"default\", silence will be inserted for the duration of that input. Alternatively, an \"Audio Selector Group\":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then \"Audio Selector 1\" will be chosen automatically.", - "smithy.api#jsonName": "audioSourceName" + "smithy.api#documentation": "Advanced audio remixing settings.", + "smithy.api#jsonName": "remixSettings" } }, "StreamName": { @@ -893,6 +962,27 @@ "smithy.api#documentation": "Specify a label for this output audio stream. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.", "smithy.api#jsonName": "streamName" } + }, + "CodecSettings": { + "target": "com.amazonaws.mediaconvert#AudioCodecSettings", + "traits": { + "smithy.api#documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings * VORBIS, VorbisSettings * OPUS, OpusSettings", + "smithy.api#jsonName": "codecSettings" + } + }, + "CustomLanguageCode": { + "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", + "traits": { + "smithy.api#documentation": "Specify the language for this audio output track. The service puts this language code into your output audio track when you set Language code control (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). The service also uses your specified custom language code when you set Language code control (AudioLanguageCodeControl) to Follow input (FOLLOW_INPUT), but your input file doesn't specify a language code. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", + "smithy.api#jsonName": "customLanguageCode" + } + }, + "AudioTypeControl": { + "target": "com.amazonaws.mediaconvert#AudioTypeControl", + "traits": { + "smithy.api#documentation": "When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.", + "smithy.api#jsonName": "audioTypeControl" + } } }, "traits": { @@ -990,11 +1080,11 @@ "com.amazonaws.mediaconvert#AudioNormalizationSettings": { "type": "structure", "members": { - "CorrectionGateLevel": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative70Max0", + "Algorithm": { + "target": "com.amazonaws.mediaconvert#AudioNormalizationAlgorithm", "traits": { - "smithy.api#documentation": "Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.", - "smithy.api#jsonName": "correctionGateLevel" + "smithy.api#documentation": "Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.", + "smithy.api#jsonName": "algorithm" } }, "AlgorithmControl": { @@ -1004,11 +1094,18 @@ "smithy.api#jsonName": "algorithmControl" } }, - "Algorithm": { - "target": "com.amazonaws.mediaconvert#AudioNormalizationAlgorithm", + "TargetLkfs": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative59Max0", "traits": { - "smithy.api#documentation": "Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.", - "smithy.api#jsonName": "algorithm" + "smithy.api#documentation": "When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.", + "smithy.api#jsonName": "targetLkfs" + } + }, + "CorrectionGateLevel": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative70Max0", + "traits": { + "smithy.api#documentation": "Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.", + "smithy.api#jsonName": "correctionGateLevel" } }, "LoudnessLogging": { @@ -1018,13 +1115,6 @@ "smithy.api#jsonName": "loudnessLogging" } }, - "TargetLkfs": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative59Max0", - "traits": { - "smithy.api#documentation": "When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.", - "smithy.api#jsonName": "targetLkfs" - } - }, "PeakCalculation": { "target": "com.amazonaws.mediaconvert#AudioNormalizationPeakCalculation", "traits": { @@ -1047,6 +1137,20 @@ "smithy.api#jsonName": "languageCode" } }, + "Offset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "traits": { + "smithy.api#documentation": "Specifies a time delta in milliseconds to offset the audio from the input video.", + "smithy.api#jsonName": "offset" + } + }, + "DefaultSelection": { + "target": "com.amazonaws.mediaconvert#AudioDefaultSelection", + "traits": { + "smithy.api#documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.", + "smithy.api#jsonName": "defaultSelection" + } + }, "Pids": { "target": "com.amazonaws.mediaconvert#__listOf__integerMin1Max2147483647", "traits": { @@ -1061,53 +1165,39 @@ "smithy.api#jsonName": "tracks" } }, - "CustomLanguageCode": { - "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", - "traits": { - "smithy.api#documentation": "Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code", - "smithy.api#jsonName": "customLanguageCode" - } - }, - "ProgramSelection": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max8", + "RemixSettings": { + "target": "com.amazonaws.mediaconvert#RemixSettings", "traits": { - "smithy.api#documentation": "Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.", - "smithy.api#jsonName": "programSelection" + "smithy.api#documentation": "Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other.", + "smithy.api#jsonName": "remixSettings" } }, - "Offset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "SelectorType": { + "target": "com.amazonaws.mediaconvert#AudioSelectorType", "traits": { - "smithy.api#documentation": "Specifies a time delta in milliseconds to offset the audio from the input video.", - "smithy.api#jsonName": "offset" + "smithy.api#documentation": "Specifies the type of the audio selector.", + "smithy.api#jsonName": "selectorType" } }, - "DefaultSelection": { - "target": "com.amazonaws.mediaconvert#AudioDefaultSelection", + "CustomLanguageCode": { + "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", "traits": { - "smithy.api#documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.", - "smithy.api#jsonName": "defaultSelection" + "smithy.api#documentation": "Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code", + "smithy.api#jsonName": "customLanguageCode" } }, "ExternalAudioFileInput": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3WWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", + "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", "traits": { "smithy.api#documentation": "Specifies audio data from an external file source.", "smithy.api#jsonName": "externalAudioFileInput" } }, - "RemixSettings": { - "target": "com.amazonaws.mediaconvert#RemixSettings", - "traits": { - "smithy.api#documentation": "Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other.", - "smithy.api#jsonName": "remixSettings" - } - }, - "SelectorType": { - "target": "com.amazonaws.mediaconvert#AudioSelectorType", + "ProgramSelection": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max8", "traits": { - "smithy.api#documentation": "Specifies the type of the audio selector.", - "smithy.api#jsonName": "selectorType" + "smithy.api#documentation": "Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.", + "smithy.api#jsonName": "programSelection" } } }, @@ -1169,7 +1259,7 @@ "com.amazonaws.mediaconvert#Av1AdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization (spatialAdaptiveQuantization).", "smithy.api#enum": [ { "value": "OFF", @@ -1217,7 +1307,7 @@ "com.amazonaws.mediaconvert#Av1FramerateConversionAlgorithm": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#enum": [ { "value": "DUPLICATE_DROP", @@ -1226,6 +1316,10 @@ { "value": "INTERPOLATE", "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" } ] } @@ -1267,6 +1361,13 @@ "com.amazonaws.mediaconvert#Av1Settings": { "type": "structure", "members": { + "QvbrSettings": { + "target": "com.amazonaws.mediaconvert#Av1QvbrSettings", + "traits": { + "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the AV1 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", + "smithy.api#jsonName": "qvbrSettings" + } + }, "GopSize": { "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { @@ -1274,25 +1375,11 @@ "smithy.api#jsonName": "gopSize" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Av1FramerateConversionAlgorithm", - "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", - "smithy.api#jsonName": "framerateConversionAlgorithm" - } - }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#Av1RateControlMode", - "traits": { - "smithy.api#documentation": "'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'", - "smithy.api#jsonName": "rateControlMode" - } - }, - "QvbrSettings": { - "target": "com.amazonaws.mediaconvert#Av1QvbrSettings", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin7Max15", "traits": { - "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the AV1 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", - "smithy.api#jsonName": "qvbrSettings" + "smithy.api#documentation": "Specify the number of B-frames. With AV1, MediaConvert supports only 7 or 15.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, "MaxBitrate": { @@ -1302,39 +1389,25 @@ "smithy.api#jsonName": "maxBitrate" } }, - "SpatialAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Av1SpatialAdaptiveQuantization", - "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", - "smithy.api#jsonName": "spatialAdaptiveQuantization" - } - }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" - } - }, - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin7Max15", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Av1FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Specify the number of B-frames. With AV1, MediaConvert supports only 7 or 15.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, "AdaptiveQuantization": { "target": "com.amazonaws.mediaconvert#Av1AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization (spatialAdaptiveQuantization).", "smithy.api#jsonName": "adaptiveQuantization" } }, - "FramerateNumerator": { + "FramerateDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, "Slices": { @@ -1350,6 +1423,27 @@ "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", "smithy.api#jsonName": "framerateControl" } + }, + "SpatialAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Av1SpatialAdaptiveQuantization", + "traits": { + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#jsonName": "spatialAdaptiveQuantization" + } + }, + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" + } + }, + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#Av1RateControlMode", + "traits": { + "smithy.api#documentation": "'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'", + "smithy.api#jsonName": "rateControlMode" + } } }, "traits": { @@ -1359,7 +1453,7 @@ "com.amazonaws.mediaconvert#Av1SpatialAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", "smithy.api#enum": [ { "value": "DISABLED", @@ -1387,77 +1481,229 @@ "smithy.api#documentation": "Settings for Avail Blanking" } }, - "com.amazonaws.mediaconvert#BadRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#jsonName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax.", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.mediaconvert#BillingTagsSource": { + "com.amazonaws.mediaconvert#AvcIntraClass": { "type": "string", "traits": { - "smithy.api#documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.", + "smithy.api#documentation": "Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate depending on the frame rate of the output. Outputs with higher class values have higher bitrates and improved image quality.", "smithy.api#enum": [ { - "value": "QUEUE", - "name": "QUEUE" + "value": "CLASS_50", + "name": "CLASS_50" }, { - "value": "PRESET", - "name": "PRESET" + "value": "CLASS_100", + "name": "CLASS_100" }, { - "value": "JOB_TEMPLATE", - "name": "JOB_TEMPLATE" + "value": "CLASS_200", + "name": "CLASS_200" + } + ] + } + }, + "com.amazonaws.mediaconvert#AvcIntraFramerateControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#enum": [ + { + "value": "INITIALIZE_FROM_SOURCE", + "name": "INITIALIZE_FROM_SOURCE" }, { - "value": "JOB", - "name": "JOB" + "value": "SPECIFIED", + "name": "SPECIFIED" } ] } }, - "com.amazonaws.mediaconvert#BurninDestinationSettings": { - "type": "structure", - "members": { - "FontSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max96", - "traits": { - "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontSize" + "com.amazonaws.mediaconvert#AvcIntraFramerateConversionAlgorithm": { + "type": "string", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#enum": [ + { + "value": "DUPLICATE_DROP", + "name": "DUPLICATE_DROP" + }, + { + "value": "INTERPOLATE", + "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" + } + ] + } + }, + "com.amazonaws.mediaconvert#AvcIntraInterlaceMode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#enum": [ + { + "value": "PROGRESSIVE", + "name": "PROGRESSIVE" + }, + { + "value": "TOP_FIELD", + "name": "TOP_FIELD" + }, + { + "value": "BOTTOM_FIELD", + "name": "BOTTOM_FIELD" + }, + { + "value": "FOLLOW_TOP_FIELD", + "name": "FOLLOW_TOP_FIELD" + }, + { + "value": "FOLLOW_BOTTOM_FIELD", + "name": "FOLLOW_BOTTOM_FIELD" + } + ] + } + }, + "com.amazonaws.mediaconvert#AvcIntraSettings": { + "type": "structure", + "members": { + "AvcIntraClass": { + "target": "com.amazonaws.mediaconvert#AvcIntraClass", + "traits": { + "smithy.api#documentation": "Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate depending on the frame rate of the output. Outputs with higher class values have higher bitrates and improved image quality.", + "smithy.api#jsonName": "avcIntraClass" } }, - "BackgroundColor": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleBackgroundColor", + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#AvcIntraInterlaceMode", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundColor" + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" } }, - "YPosition": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#AvcIntraFramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "yPosition" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "TeletextSpacing": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleTeletextSpacing", + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max1001", "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", - "smithy.api#jsonName": "teletextSpacing" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" + } + }, + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#AvcIntraFramerateControl", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" + } + }, + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" + } + }, + "Telecine": { + "target": "com.amazonaws.mediaconvert#AvcIntraTelecine", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" } }, + "SlowPal": { + "target": "com.amazonaws.mediaconvert#AvcIntraSlowPal", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set your output video codec to AVC-Intra. For more information about the AVC-I settings, see the relevant specification. For detailed information about SD and HD in AVC-I, see https://ieeexplore.ieee.org/document/7290936." + } + }, + "com.amazonaws.mediaconvert#AvcIntraSlowPal": { + "type": "string", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.mediaconvert#AvcIntraTelecine": { + "type": "string", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "HARD", + "name": "HARD" + } + ] + } + }, + "com.amazonaws.mediaconvert#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.mediaconvert#BillingTagsSource": { + "type": "string", + "traits": { + "smithy.api#documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.", + "smithy.api#enum": [ + { + "value": "QUEUE", + "name": "QUEUE" + }, + { + "value": "PRESET", + "name": "PRESET" + }, + { + "value": "JOB_TEMPLATE", + "name": "JOB_TEMPLATE" + }, + { + "value": "JOB", + "name": "JOB" + } + ] + } + }, + "com.amazonaws.mediaconvert#BurninDestinationSettings": { + "type": "structure", + "members": { "ShadowYOffset": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { @@ -1472,6 +1718,27 @@ "smithy.api#jsonName": "xPosition" } }, + "TeletextSpacing": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleTeletextSpacing", + "traits": { + "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#jsonName": "teletextSpacing" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleBackgroundColor", + "traits": { + "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundColor" + } + }, + "FontSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max96", + "traits": { + "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontSize" + } + }, "Alignment": { "target": "com.amazonaws.mediaconvert#BurninSubtitleAlignment", "traits": { @@ -1479,13 +1746,6 @@ "smithy.api#jsonName": "alignment" } }, - "BackgroundOpacity": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max255", - "traits": { - "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundOpacity" - } - }, "ShadowXOffset": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { @@ -1493,6 +1753,34 @@ "smithy.api#jsonName": "shadowXOffset" } }, + "FontColor": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleFontColor", + "traits": { + "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontColor" + } + }, + "ShadowColor": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleShadowColor", + "traits": { + "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowColor" + } + }, + "OutlineColor": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleOutlineColor", + "traits": { + "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "outlineColor" + } + }, + "ShadowOpacity": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max255", + "traits": { + "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowOpacity" + } + }, "OutlineSize": { "target": "com.amazonaws.mediaconvert#__integerMin0Max10", "traits": { @@ -1500,18 +1788,25 @@ "smithy.api#jsonName": "outlineSize" } }, - "FontOpacity": { + "BackgroundOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontOpacity" + "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundOpacity" } }, - "ShadowColor": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleShadowColor", + "YPosition": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowColor" + "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "yPosition" + } + }, + "FontOpacity": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max255", + "traits": { + "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontOpacity" } }, "FontResolution": { @@ -1527,27 +1822,6 @@ "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.", "smithy.api#jsonName": "fontScript" } - }, - "OutlineColor": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleOutlineColor", - "traits": { - "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "outlineColor" - } - }, - "ShadowOpacity": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max255", - "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowOpacity" - } - }, - "FontColor": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleFontColor", - "traits": { - "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontColor" - } } }, "traits": { @@ -1747,11 +2021,11 @@ "com.amazonaws.mediaconvert#CaptionDescription": { "type": "structure", "members": { - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#CaptionDestinationSettings", + "CaptionSelectorName": { + "target": "com.amazonaws.mediaconvert#__stringMin1", "traits": { - "smithy.api#documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.", - "smithy.api#jsonName": "destinationSettings" + "smithy.api#documentation": "Specifies which \"Caption Selector\":#inputs-caption_selector to use from each input when generating captions. The name should be of the format \"Caption Selector \", which denotes that the Nth Caption Selector will be used from each input.", + "smithy.api#jsonName": "captionSelectorName" } }, "LanguageCode": { @@ -1768,19 +2042,19 @@ "smithy.api#jsonName": "languageDescription" } }, + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#CaptionDestinationSettings", + "traits": { + "smithy.api#documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.", + "smithy.api#jsonName": "destinationSettings" + } + }, "CustomLanguageCode": { "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", "traits": { "smithy.api#documentation": "Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", "smithy.api#jsonName": "customLanguageCode" } - }, - "CaptionSelectorName": { - "target": "com.amazonaws.mediaconvert#__stringMin1", - "traits": { - "smithy.api#documentation": "Specifies which \"Caption Selector\":#inputs-caption_selector to use from each input when generating captions. The name should be of the format \"Caption Selector \", which denotes that the Nth Caption Selector will be used from each input.", - "smithy.api#jsonName": "captionSelectorName" - } } }, "traits": { @@ -1790,11 +2064,11 @@ "com.amazonaws.mediaconvert#CaptionDescriptionPreset": { "type": "structure", "members": { - "CustomLanguageCode": { - "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", + "LanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { - "smithy.api#documentation": "Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", - "smithy.api#jsonName": "customLanguageCode" + "smithy.api#documentation": "Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.", + "smithy.api#jsonName": "languageCode" } }, "DestinationSettings": { @@ -1804,11 +2078,11 @@ "smithy.api#jsonName": "destinationSettings" } }, - "LanguageCode": { - "target": "com.amazonaws.mediaconvert#LanguageCode", + "CustomLanguageCode": { + "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", "traits": { - "smithy.api#documentation": "Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.", - "smithy.api#jsonName": "languageCode" + "smithy.api#documentation": "Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", + "smithy.api#jsonName": "customLanguageCode" } }, "LanguageDescription": { @@ -1826,13 +2100,6 @@ "com.amazonaws.mediaconvert#CaptionDestinationSettings": { "type": "structure", "members": { - "DestinationType": { - "target": "com.amazonaws.mediaconvert#CaptionDestinationType", - "traits": { - "smithy.api#documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).", - "smithy.api#jsonName": "destinationType" - } - }, "ImscDestinationSettings": { "target": "com.amazonaws.mediaconvert#ImscDestinationSettings", "traits": { @@ -1840,25 +2107,11 @@ "smithy.api#jsonName": "imscDestinationSettings" } }, - "TeletextDestinationSettings": { - "target": "com.amazonaws.mediaconvert#TeletextDestinationSettings", - "traits": { - "smithy.api#documentation": "Settings for Teletext caption output", - "smithy.api#jsonName": "teletextDestinationSettings" - } - }, - "EmbeddedDestinationSettings": { - "target": "com.amazonaws.mediaconvert#EmbeddedDestinationSettings", - "traits": { - "smithy.api#documentation": "Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.", - "smithy.api#jsonName": "embeddedDestinationSettings" - } - }, - "DvbSubDestinationSettings": { - "target": "com.amazonaws.mediaconvert#DvbSubDestinationSettings", + "TtmlDestinationSettings": { + "target": "com.amazonaws.mediaconvert#TtmlDestinationSettings", "traits": { - "smithy.api#documentation": "DVB-Sub Destination Settings", - "smithy.api#jsonName": "dvbSubDestinationSettings" + "smithy.api#documentation": "Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).", + "smithy.api#jsonName": "ttmlDestinationSettings" } }, "BurninDestinationSettings": { @@ -1868,11 +2121,11 @@ "smithy.api#jsonName": "burninDestinationSettings" } }, - "TtmlDestinationSettings": { - "target": "com.amazonaws.mediaconvert#TtmlDestinationSettings", + "DestinationType": { + "target": "com.amazonaws.mediaconvert#CaptionDestinationType", "traits": { - "smithy.api#documentation": "Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).", - "smithy.api#jsonName": "ttmlDestinationSettings" + "smithy.api#documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).", + "smithy.api#jsonName": "destinationType" } }, "SccDestinationSettings": { @@ -1881,6 +2134,27 @@ "smithy.api#documentation": "Settings for SCC caption output.", "smithy.api#jsonName": "sccDestinationSettings" } + }, + "EmbeddedDestinationSettings": { + "target": "com.amazonaws.mediaconvert#EmbeddedDestinationSettings", + "traits": { + "smithy.api#documentation": "Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.", + "smithy.api#jsonName": "embeddedDestinationSettings" + } + }, + "DvbSubDestinationSettings": { + "target": "com.amazonaws.mediaconvert#DvbSubDestinationSettings", + "traits": { + "smithy.api#documentation": "DVB-Sub Destination Settings", + "smithy.api#jsonName": "dvbSubDestinationSettings" + } + }, + "TeletextDestinationSettings": { + "target": "com.amazonaws.mediaconvert#TeletextDestinationSettings", + "traits": { + "smithy.api#documentation": "Settings for Teletext caption output", + "smithy.api#jsonName": "teletextDestinationSettings" + } } }, "traits": { @@ -1946,13 +2220,6 @@ "com.amazonaws.mediaconvert#CaptionSelector": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.mediaconvert#LanguageCode", - "traits": { - "smithy.api#documentation": "The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.", - "smithy.api#jsonName": "languageCode" - } - }, "CustomLanguageCode": { "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", "traits": { @@ -1966,6 +2233,13 @@ "smithy.api#documentation": "If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.", "smithy.api#jsonName": "sourceSettings" } + }, + "LanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", + "traits": { + "smithy.api#documentation": "The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.", + "smithy.api#jsonName": "languageCode" + } } }, "traits": { @@ -1997,25 +2271,18 @@ "com.amazonaws.mediaconvert#CaptionSourceSettings": { "type": "structure", "members": { - "TeletextSourceSettings": { - "target": "com.amazonaws.mediaconvert#TeletextSourceSettings", - "traits": { - "smithy.api#documentation": "Settings specific to Teletext caption sources, including Page number.", - "smithy.api#jsonName": "teletextSourceSettings" - } - }, - "FileSourceSettings": { - "target": "com.amazonaws.mediaconvert#FileSourceSettings", + "DvbSubSourceSettings": { + "target": "com.amazonaws.mediaconvert#DvbSubSourceSettings", "traits": { - "smithy.api#documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.", - "smithy.api#jsonName": "fileSourceSettings" + "smithy.api#documentation": "DVB Sub Source Settings", + "smithy.api#jsonName": "dvbSubSourceSettings" } }, - "TrackSourceSettings": { - "target": "com.amazonaws.mediaconvert#TrackSourceSettings", + "EmbeddedSourceSettings": { + "target": "com.amazonaws.mediaconvert#EmbeddedSourceSettings", "traits": { - "smithy.api#documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.", - "smithy.api#jsonName": "trackSourceSettings" + "smithy.api#documentation": "Settings for embedded captions Source", + "smithy.api#jsonName": "embeddedSourceSettings" } }, "SourceType": { @@ -2032,18 +2299,25 @@ "smithy.api#jsonName": "ancillarySourceSettings" } }, - "DvbSubSourceSettings": { - "target": "com.amazonaws.mediaconvert#DvbSubSourceSettings", + "TrackSourceSettings": { + "target": "com.amazonaws.mediaconvert#TrackSourceSettings", "traits": { - "smithy.api#documentation": "DVB Sub Source Settings", - "smithy.api#jsonName": "dvbSubSourceSettings" + "smithy.api#documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.", + "smithy.api#jsonName": "trackSourceSettings" } }, - "EmbeddedSourceSettings": { - "target": "com.amazonaws.mediaconvert#EmbeddedSourceSettings", + "FileSourceSettings": { + "target": "com.amazonaws.mediaconvert#FileSourceSettings", "traits": { - "smithy.api#documentation": "Settings for embedded captions Source", - "smithy.api#jsonName": "embeddedSourceSettings" + "smithy.api#documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.", + "smithy.api#jsonName": "fileSourceSettings" + } + }, + "TeletextSourceSettings": { + "target": "com.amazonaws.mediaconvert#TeletextSourceSettings", + "traits": { + "smithy.api#documentation": "Settings specific to Teletext caption sources, including Page number.", + "smithy.api#jsonName": "teletextSourceSettings" } } }, @@ -2125,19 +2399,19 @@ "com.amazonaws.mediaconvert#CmafAdditionalManifest": { "type": "structure", "members": { - "ManifestNameModifier": { - "target": "com.amazonaws.mediaconvert#__stringMin1", - "traits": { - "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your HLS group is film-name.m3u8. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is different from the nameModifier of the output. The service uses the output name modifier to create unique names for the individual variant manifests.", - "smithy.api#jsonName": "manifestNameModifier" - } - }, "SelectedOutputs": { "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", "traits": { "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", "smithy.api#jsonName": "selectedOutputs" } + }, + "ManifestNameModifier": { + "target": "com.amazonaws.mediaconvert#__stringMin1", + "traits": { + "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your HLS group is film-name.m3u8. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is different from the nameModifier of the output. The service uses the output name modifier to create unique names for the individual variant manifests.", + "smithy.api#jsonName": "manifestNameModifier" + } } }, "traits": { @@ -2179,27 +2453,6 @@ "com.amazonaws.mediaconvert#CmafEncryptionSettings": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.mediaconvert#CmafKeyProviderType", - "traits": { - "smithy.api#documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", - "smithy.api#jsonName": "type" - } - }, - "StaticKeyProvider": { - "target": "com.amazonaws.mediaconvert#StaticKeyProvider", - "traits": { - "smithy.api#documentation": "Use these settings to set up encryption with a static key provider.", - "smithy.api#jsonName": "staticKeyProvider" - } - }, - "EncryptionMethod": { - "target": "com.amazonaws.mediaconvert#CmafEncryptionType", - "traits": { - "smithy.api#documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR).", - "smithy.api#jsonName": "encryptionMethod" - } - }, "ConstantInitializationVector": { "target": "com.amazonaws.mediaconvert#__stringMin32Max32Pattern09aFAF32", "traits": { @@ -2220,6 +2473,27 @@ "smithy.api#documentation": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.", "smithy.api#jsonName": "initializationVectorInManifest" } + }, + "StaticKeyProvider": { + "target": "com.amazonaws.mediaconvert#StaticKeyProvider", + "traits": { + "smithy.api#documentation": "Use these settings to set up encryption with a static key provider.", + "smithy.api#jsonName": "staticKeyProvider" + } + }, + "Type": { + "target": "com.amazonaws.mediaconvert#CmafKeyProviderType", + "traits": { + "smithy.api#documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", + "smithy.api#jsonName": "type" + } + }, + "EncryptionMethod": { + "target": "com.amazonaws.mediaconvert#CmafEncryptionType", + "traits": { + "smithy.api#documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR).", + "smithy.api#jsonName": "encryptionMethod" + } } }, "traits": { @@ -2245,13 +2519,6 @@ "com.amazonaws.mediaconvert#CmafGroupSettings": { "type": "structure", "members": { - "WriteSegmentTimelineInRepresentation": { - "target": "com.amazonaws.mediaconvert#CmafWriteSegmentTimelineInRepresentation", - "traits": { - "smithy.api#documentation": "When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.", - "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" - } - }, "AdditionalManifests": { "target": "com.amazonaws.mediaconvert#__listOfCmafAdditionalManifest", "traits": { @@ -2259,46 +2526,32 @@ "smithy.api#jsonName": "additionalManifests" } }, - "FragmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", - "smithy.api#jsonName": "fragmentLength" - } - }, - "ManifestDurationFormat": { - "target": "com.amazonaws.mediaconvert#CmafManifestDurationFormat", - "traits": { - "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", - "smithy.api#jsonName": "manifestDurationFormat" - } - }, - "StreamInfResolution": { - "target": "com.amazonaws.mediaconvert#CmafStreamInfResolution", + "ManifestCompression": { + "target": "com.amazonaws.mediaconvert#CmafManifestCompression", "traits": { - "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", - "smithy.api#jsonName": "streamInfResolution" + "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", + "smithy.api#jsonName": "manifestCompression" } }, - "Encryption": { - "target": "com.amazonaws.mediaconvert#CmafEncryptionSettings", + "FragmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "DRM settings.", - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", + "smithy.api#jsonName": "fragmentLength" } }, - "MpdProfile": { - "target": "com.amazonaws.mediaconvert#CmafMpdProfile", + "BaseUrl": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", - "smithy.api#jsonName": "mpdProfile" + "smithy.api#documentation": "A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", + "smithy.api#jsonName": "baseUrl" } }, - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", + "WriteSegmentTimelineInRepresentation": { + "target": "com.amazonaws.mediaconvert#CmafWriteSegmentTimelineInRepresentation", "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" + "smithy.api#documentation": "When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.", + "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" } }, "SegmentControl": { @@ -2308,13 +2561,6 @@ "smithy.api#jsonName": "segmentControl" } }, - "WriteDashManifest": { - "target": "com.amazonaws.mediaconvert#CmafWriteDASHManifest", - "traits": { - "smithy.api#documentation": "When set to ENABLED, a DASH MPD manifest will be generated for this output.", - "smithy.api#jsonName": "writeDashManifest" - } - }, "ClientCache": { "target": "com.amazonaws.mediaconvert#CmafClientCache", "traits": { @@ -2322,18 +2568,46 @@ "smithy.api#jsonName": "clientCache" } }, - "WriteHlsManifest": { - "target": "com.amazonaws.mediaconvert#CmafWriteHLSManifest", + "Destination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output.", - "smithy.api#jsonName": "writeHlsManifest" + "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", + "smithy.api#jsonName": "destination" } }, - "BaseUrl": { - "target": "com.amazonaws.mediaconvert#__string", + "CodecSpecification": { + "target": "com.amazonaws.mediaconvert#CmafCodecSpecification", "traits": { - "smithy.api#documentation": "A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", - "smithy.api#jsonName": "baseUrl" + "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", + "smithy.api#jsonName": "codecSpecification" + } + }, + "SegmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.", + "smithy.api#jsonName": "segmentLength" + } + }, + "MinBufferTime": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout.", + "smithy.api#jsonName": "minBufferTime" + } + }, + "MpdProfile": { + "target": "com.amazonaws.mediaconvert#CmafMpdProfile", + "traits": { + "smithy.api#documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", + "smithy.api#jsonName": "mpdProfile" + } + }, + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", + "traits": { + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } }, "MinFinalSegmentLength": { @@ -2343,39 +2617,39 @@ "smithy.api#jsonName": "minFinalSegmentLength" } }, - "SegmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "StreamInfResolution": { + "target": "com.amazonaws.mediaconvert#CmafStreamInfResolution", "traits": { - "smithy.api#documentation": "Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.", - "smithy.api#jsonName": "segmentLength" + "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", + "smithy.api#jsonName": "streamInfResolution" } }, - "Destination": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "WriteHlsManifest": { + "target": "com.amazonaws.mediaconvert#CmafWriteHLSManifest", "traits": { - "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", - "smithy.api#jsonName": "destination" + "smithy.api#documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output.", + "smithy.api#jsonName": "writeHlsManifest" } }, - "ManifestCompression": { - "target": "com.amazonaws.mediaconvert#CmafManifestCompression", + "Encryption": { + "target": "com.amazonaws.mediaconvert#CmafEncryptionSettings", "traits": { - "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", - "smithy.api#jsonName": "manifestCompression" + "smithy.api#documentation": "DRM settings.", + "smithy.api#jsonName": "encryption" } }, - "MinBufferTime": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "WriteDashManifest": { + "target": "com.amazonaws.mediaconvert#CmafWriteDASHManifest", "traits": { - "smithy.api#documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout.", - "smithy.api#jsonName": "minBufferTime" + "smithy.api#documentation": "When set to ENABLED, a DASH MPD manifest will be generated for this output.", + "smithy.api#jsonName": "writeDashManifest" } }, - "CodecSpecification": { - "target": "com.amazonaws.mediaconvert#CmafCodecSpecification", + "ManifestDurationFormat": { + "target": "com.amazonaws.mediaconvert#CmafManifestDurationFormat", "traits": { - "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", - "smithy.api#jsonName": "codecSpecification" + "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", + "smithy.api#jsonName": "manifestDurationFormat" } } }, @@ -2578,19 +2852,19 @@ "com.amazonaws.mediaconvert#CmfcSettings": { "type": "structure", "members": { - "Scte35Source": { - "target": "com.amazonaws.mediaconvert#CmfcScte35Source", - "traits": { - "smithy.api#documentation": "Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.", - "smithy.api#jsonName": "scte35Source" - } - }, "Scte35Esam": { "target": "com.amazonaws.mediaconvert#CmfcScte35Esam", "traits": { "smithy.api#documentation": "Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).", "smithy.api#jsonName": "scte35Esam" } + }, + "Scte35Source": { + "target": "com.amazonaws.mediaconvert#CmfcScte35Source", + "traits": { + "smithy.api#documentation": "Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.", + "smithy.api#jsonName": "scte35Source" + } } }, "traits": { @@ -2600,6 +2874,13 @@ "com.amazonaws.mediaconvert#ColorCorrector": { "type": "structure", "members": { + "Hue": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative180Max180", + "traits": { + "smithy.api#documentation": "Hue in degrees.", + "smithy.api#jsonName": "hue" + } + }, "Contrast": { "target": "com.amazonaws.mediaconvert#__integerMin1Max100", "traits": { @@ -2607,18 +2888,11 @@ "smithy.api#jsonName": "contrast" } }, - "Hdr10Metadata": { - "target": "com.amazonaws.mediaconvert#Hdr10Metadata", - "traits": { - "smithy.api#documentation": "Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", - "smithy.api#jsonName": "hdr10Metadata" - } - }, - "Brightness": { + "Saturation": { "target": "com.amazonaws.mediaconvert#__integerMin1Max100", "traits": { - "smithy.api#documentation": "Brightness level.", - "smithy.api#jsonName": "brightness" + "smithy.api#documentation": "Saturation level.", + "smithy.api#jsonName": "saturation" } }, "ColorSpaceConversion": { @@ -2628,18 +2902,18 @@ "smithy.api#jsonName": "colorSpaceConversion" } }, - "Saturation": { + "Brightness": { "target": "com.amazonaws.mediaconvert#__integerMin1Max100", "traits": { - "smithy.api#documentation": "Saturation level.", - "smithy.api#jsonName": "saturation" + "smithy.api#documentation": "Brightness level.", + "smithy.api#jsonName": "brightness" } }, - "Hue": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative180Max180", + "Hdr10Metadata": { + "target": "com.amazonaws.mediaconvert#Hdr10Metadata", "traits": { - "smithy.api#documentation": "Hue in degrees.", - "smithy.api#jsonName": "hue" + "smithy.api#documentation": "Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", + "smithy.api#jsonName": "hdr10Metadata" } } }, @@ -2766,25 +3040,18 @@ "com.amazonaws.mediaconvert#ContainerSettings": { "type": "structure", "members": { - "M3u8Settings": { - "target": "com.amazonaws.mediaconvert#M3u8Settings", - "traits": { - "smithy.api#documentation": "Settings for TS segments in HLS", - "smithy.api#jsonName": "m3u8Settings" - } - }, - "MxfSettings": { - "target": "com.amazonaws.mediaconvert#MxfSettings", + "M2tsSettings": { + "target": "com.amazonaws.mediaconvert#M2tsSettings", "traits": { - "smithy.api#documentation": "MXF settings", - "smithy.api#jsonName": "mxfSettings" + "smithy.api#documentation": "MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.", + "smithy.api#jsonName": "m2tsSettings" } }, - "CmfcSettings": { - "target": "com.amazonaws.mediaconvert#CmfcSettings", + "Container": { + "target": "com.amazonaws.mediaconvert#ContainerType", "traits": { - "smithy.api#documentation": "Settings for MP4 segments in CMAF", - "smithy.api#jsonName": "cmfcSettings" + "smithy.api#documentation": "Container for this output. Some containers require a container settings object. If not specified, the default object will be created.", + "smithy.api#jsonName": "container" } }, "F4vSettings": { @@ -2794,6 +3061,13 @@ "smithy.api#jsonName": "f4vSettings" } }, + "MxfSettings": { + "target": "com.amazonaws.mediaconvert#MxfSettings", + "traits": { + "smithy.api#documentation": "MXF settings", + "smithy.api#jsonName": "mxfSettings" + } + }, "MpdSettings": { "target": "com.amazonaws.mediaconvert#MpdSettings", "traits": { @@ -2801,32 +3075,32 @@ "smithy.api#jsonName": "mpdSettings" } }, - "MovSettings": { - "target": "com.amazonaws.mediaconvert#MovSettings", + "Mp4Settings": { + "target": "com.amazonaws.mediaconvert#Mp4Settings", "traits": { - "smithy.api#documentation": "Settings for MOV Container.", - "smithy.api#jsonName": "movSettings" + "smithy.api#documentation": "Settings for MP4 container. You can create audio-only AAC outputs with this container.", + "smithy.api#jsonName": "mp4Settings" } }, - "Container": { - "target": "com.amazonaws.mediaconvert#ContainerType", + "M3u8Settings": { + "target": "com.amazonaws.mediaconvert#M3u8Settings", "traits": { - "smithy.api#documentation": "Container for this output. Some containers require a container settings object. If not specified, the default object will be created.", - "smithy.api#jsonName": "container" + "smithy.api#documentation": "Settings for TS segments in HLS", + "smithy.api#jsonName": "m3u8Settings" } }, - "M2tsSettings": { - "target": "com.amazonaws.mediaconvert#M2tsSettings", + "MovSettings": { + "target": "com.amazonaws.mediaconvert#MovSettings", "traits": { - "smithy.api#documentation": "MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.", - "smithy.api#jsonName": "m2tsSettings" + "smithy.api#documentation": "Settings for MOV Container.", + "smithy.api#jsonName": "movSettings" } }, - "Mp4Settings": { - "target": "com.amazonaws.mediaconvert#Mp4Settings", + "CmfcSettings": { + "target": "com.amazonaws.mediaconvert#CmfcSettings", "traits": { - "smithy.api#documentation": "Settings for MP4 container. You can create audio-only AAC outputs with this container.", - "smithy.api#jsonName": "mp4Settings" + "smithy.api#documentation": "Settings for MP4 segments in CMAF", + "smithy.api#jsonName": "cmfcSettings" } } }, @@ -2926,11 +3200,12 @@ "com.amazonaws.mediaconvert#CreateJobRequest": { "type": "structure", "members": { - "AccelerationSettings": { - "target": "com.amazonaws.mediaconvert#AccelerationSettings", + "Role": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", - "smithy.api#jsonName": "accelerationSettings" + "smithy.api#documentation": "Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.", + "smithy.api#jsonName": "role", + "smithy.api#required": {} } }, "HopDestinations": { @@ -2954,35 +3229,32 @@ "smithy.api#jsonName": "tags" } }, - "Settings": { - "target": "com.amazonaws.mediaconvert#JobSettings", + "UserMetadata": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { - "smithy.api#documentation": "JobSettings contains all the transcode settings for a job.", - "smithy.api#jsonName": "settings", - "smithy.api#required": {} + "smithy.api#documentation": "Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", + "smithy.api#jsonName": "userMetadata" } }, - "Role": { - "target": "com.amazonaws.mediaconvert#__string", + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", "traits": { - "smithy.api#documentation": "Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.", - "smithy.api#jsonName": "role", - "smithy.api#required": {} + "smithy.api#documentation": "Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" } }, - "ClientRequestToken": { - "target": "com.amazonaws.mediaconvert#__string", + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", "traits": { - "smithy.api#documentation": "Optional. Idempotency token for CreateJob operation.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientRequestToken" + "smithy.api#documentation": "Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", + "smithy.api#jsonName": "priority" } - }, - "Queue": { - "target": "com.amazonaws.mediaconvert#__string", + }, + "BillingTagsSource": { + "target": "com.amazonaws.mediaconvert#BillingTagsSource", "traits": { - "smithy.api#documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.", - "smithy.api#jsonName": "queue" + "smithy.api#documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", + "smithy.api#jsonName": "billingTagsSource" } }, "JobTemplate": { @@ -2992,32 +3264,34 @@ "smithy.api#jsonName": "jobTemplate" } }, - "BillingTagsSource": { - "target": "com.amazonaws.mediaconvert#BillingTagsSource", + "Settings": { + "target": "com.amazonaws.mediaconvert#JobSettings", "traits": { - "smithy.api#documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", - "smithy.api#jsonName": "billingTagsSource" + "smithy.api#documentation": "JobSettings contains all the transcode settings for a job.", + "smithy.api#jsonName": "settings", + "smithy.api#required": {} } }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "Queue": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", - "smithy.api#jsonName": "priority" + "smithy.api#documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.", + "smithy.api#jsonName": "queue" } }, - "UserMetadata": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", + "AccelerationSettings": { + "target": "com.amazonaws.mediaconvert#AccelerationSettings", "traits": { - "smithy.api#documentation": "Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", - "smithy.api#jsonName": "userMetadata" + "smithy.api#documentation": "Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", + "smithy.api#jsonName": "accelerationSettings" } }, - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", + "ClientRequestToken": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" + "smithy.api#documentation": "Optional. Idempotency token for CreateJob operation.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientRequestToken" } } } @@ -3028,7 +3302,7 @@ "Job": { "target": "com.amazonaws.mediaconvert#Job", "traits": { - "smithy.api#documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", + "smithy.api#documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", "smithy.api#jsonName": "job" } } @@ -3074,12 +3348,25 @@ "com.amazonaws.mediaconvert#CreateJobTemplateRequest": { "type": "structure", "members": { - "Name": { + "AccelerationSettings": { + "target": "com.amazonaws.mediaconvert#AccelerationSettings", + "traits": { + "smithy.api#documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", + "smithy.api#jsonName": "accelerationSettings" + } + }, + "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The name of the job template you are creating.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "Optional. A description of the job template you are creating.", + "smithy.api#jsonName": "description" + } + }, + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "traits": { + "smithy.api#documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", + "smithy.api#jsonName": "priority" } }, "StatusUpdateInterval": { @@ -3096,20 +3383,6 @@ "smithy.api#jsonName": "queue" } }, - "Description": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Optional. A description of the job template you are creating.", - "smithy.api#jsonName": "description" - } - }, - "AccelerationSettings": { - "target": "com.amazonaws.mediaconvert#AccelerationSettings", - "traits": { - "smithy.api#documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", - "smithy.api#jsonName": "accelerationSettings" - } - }, "Category": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -3124,11 +3397,20 @@ "smithy.api#jsonName": "tags" } }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "Settings": { + "target": "com.amazonaws.mediaconvert#JobTemplateSettings", "traits": { - "smithy.api#documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", - "smithy.api#jsonName": "priority" + "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", + "smithy.api#jsonName": "settings", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "The name of the job template you are creating.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, "HopDestinations": { @@ -3137,14 +3419,6 @@ "smithy.api#documentation": "Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.", "smithy.api#jsonName": "hopDestinations" } - }, - "Settings": { - "target": "com.amazonaws.mediaconvert#JobTemplateSettings", - "traits": { - "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", - "smithy.api#jsonName": "settings", - "smithy.api#required": {} - } } } }, @@ -3207,13 +3481,6 @@ "smithy.api#jsonName": "description" } }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Optional. A category for the preset you are creating.", - "smithy.api#jsonName": "category" - } - }, "Tags": { "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { @@ -3236,6 +3503,13 @@ "smithy.api#jsonName": "settings", "smithy.api#required": {} } + }, + "Category": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optional. A category for the preset you are creating.", + "smithy.api#jsonName": "category" + } } } }, @@ -3313,6 +3587,13 @@ "smithy.api#jsonName": "reservationPlanSettings" } }, + "PricingPlan": { + "target": "com.amazonaws.mediaconvert#PricingPlan", + "traits": { + "smithy.api#documentation": "Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.", + "smithy.api#jsonName": "pricingPlan" + } + }, "Tags": { "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { @@ -3326,13 +3607,6 @@ "smithy.api#documentation": "Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.", "smithy.api#jsonName": "status" } - }, - "PricingPlan": { - "target": "com.amazonaws.mediaconvert#PricingPlan", - "traits": { - "smithy.api#documentation": "Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.", - "smithy.api#jsonName": "pricingPlan" - } } } }, @@ -3351,19 +3625,19 @@ "com.amazonaws.mediaconvert#DashAdditionalManifest": { "type": "structure", "members": { - "ManifestNameModifier": { - "target": "com.amazonaws.mediaconvert#__stringMin1", - "traits": { - "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your DASH group is film-name.mpd. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.mpd.", - "smithy.api#jsonName": "manifestNameModifier" - } - }, "SelectedOutputs": { "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", "traits": { "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", "smithy.api#jsonName": "selectedOutputs" } + }, + "ManifestNameModifier": { + "target": "com.amazonaws.mediaconvert#__stringMin1", + "traits": { + "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your DASH group is film-name.mpd. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.mpd.", + "smithy.api#jsonName": "manifestNameModifier" + } } }, "traits": { @@ -3395,18 +3669,25 @@ "com.amazonaws.mediaconvert#DashIsoGroupSettings": { "type": "structure", "members": { - "SegmentControl": { - "target": "com.amazonaws.mediaconvert#DashIsoSegmentControl", + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", "traits": { - "smithy.api#documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", - "smithy.api#jsonName": "segmentControl" + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } }, - "Destination": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "WriteSegmentTimelineInRepresentation": { + "target": "com.amazonaws.mediaconvert#DashIsoWriteSegmentTimelineInRepresentation", "traits": { - "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", - "smithy.api#jsonName": "destination" + "smithy.api#documentation": "If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.", + "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" + } + }, + "MinBufferTime": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout.", + "smithy.api#jsonName": "minBufferTime" } }, "Encryption": { @@ -3416,32 +3697,32 @@ "smithy.api#jsonName": "encryption" } }, - "BaseUrl": { - "target": "com.amazonaws.mediaconvert#__string", + "Destination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", - "smithy.api#jsonName": "baseUrl" + "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", + "smithy.api#jsonName": "destination" } }, - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", + "MpdProfile": { + "target": "com.amazonaws.mediaconvert#DashIsoMpdProfile", "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" + "smithy.api#documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", + "smithy.api#jsonName": "mpdProfile" } }, - "WriteSegmentTimelineInRepresentation": { - "target": "com.amazonaws.mediaconvert#DashIsoWriteSegmentTimelineInRepresentation", + "BaseUrl": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.", - "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" + "smithy.api#documentation": "A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", + "smithy.api#jsonName": "baseUrl" } }, - "AdditionalManifests": { - "target": "com.amazonaws.mediaconvert#__listOfDashAdditionalManifest", + "FragmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here.", - "smithy.api#jsonName": "additionalManifests" + "smithy.api#documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", + "smithy.api#jsonName": "fragmentLength" } }, "SegmentLength": { @@ -3451,32 +3732,25 @@ "smithy.api#jsonName": "segmentLength" } }, - "HbbtvCompliance": { - "target": "com.amazonaws.mediaconvert#DashIsoHbbtvCompliance", - "traits": { - "smithy.api#documentation": "Supports HbbTV specification as indicated", - "smithy.api#jsonName": "hbbtvCompliance" - } - }, - "MinBufferTime": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "SegmentControl": { + "target": "com.amazonaws.mediaconvert#DashIsoSegmentControl", "traits": { - "smithy.api#documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout.", - "smithy.api#jsonName": "minBufferTime" + "smithy.api#documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", + "smithy.api#jsonName": "segmentControl" } }, - "FragmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "AdditionalManifests": { + "target": "com.amazonaws.mediaconvert#__listOfDashAdditionalManifest", "traits": { - "smithy.api#documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", - "smithy.api#jsonName": "fragmentLength" + "smithy.api#documentation": "By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here.", + "smithy.api#jsonName": "additionalManifests" } }, - "MpdProfile": { - "target": "com.amazonaws.mediaconvert#DashIsoMpdProfile", + "HbbtvCompliance": { + "target": "com.amazonaws.mediaconvert#DashIsoHbbtvCompliance", "traits": { - "smithy.api#documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", - "smithy.api#jsonName": "mpdProfile" + "smithy.api#documentation": "Supports HbbTV specification as indicated", + "smithy.api#jsonName": "hbbtvCompliance" } } }, @@ -3611,11 +3885,11 @@ "com.amazonaws.mediaconvert#Deinterlacer": { "type": "structure", "members": { - "Control": { - "target": "com.amazonaws.mediaconvert#DeinterlacerControl", + "Mode": { + "target": "com.amazonaws.mediaconvert#DeinterlacerMode", "traits": { - "smithy.api#documentation": "- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video.", - "smithy.api#jsonName": "control" + "smithy.api#documentation": "Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.", + "smithy.api#jsonName": "mode" } }, "Algorithm": { @@ -3625,11 +3899,11 @@ "smithy.api#jsonName": "algorithm" } }, - "Mode": { - "target": "com.amazonaws.mediaconvert#DeinterlacerMode", + "Control": { + "target": "com.amazonaws.mediaconvert#DeinterlacerControl", "traits": { - "smithy.api#documentation": "Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.", - "smithy.api#jsonName": "mode" + "smithy.api#documentation": "- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video.", + "smithy.api#jsonName": "control" } } }, @@ -3869,6 +4143,12 @@ "method": "POST", "uri": "/2017-08-29/endpoints", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Endpoints", + "pageSize": "MaxResults" } } }, @@ -3891,18 +4171,18 @@ "com.amazonaws.mediaconvert#DescribeEndpointsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", + "MaxResults": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of endpoints.", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "Optional. Max number of endpoints, up to twenty, that will be returned at one time.", + "smithy.api#jsonName": "maxResults" } }, - "MaxResults": { - "target": "com.amazonaws.mediaconvert#__integer", + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. Max number of endpoints, up to twenty, that will be returned at one time.", - "smithy.api#jsonName": "maxResults" + "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of endpoints.", + "smithy.api#jsonName": "nextToken" } }, "Mode": { @@ -4008,13 +4288,6 @@ "com.amazonaws.mediaconvert#DolbyVision": { "type": "structure", "members": { - "L6Mode": { - "target": "com.amazonaws.mediaconvert#DolbyVisionLevel6Mode", - "traits": { - "smithy.api#documentation": "Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies.", - "smithy.api#jsonName": "l6Mode" - } - }, "Profile": { "target": "com.amazonaws.mediaconvert#DolbyVisionProfile", "traits": { @@ -4028,6 +4301,13 @@ "smithy.api#documentation": "Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values.", "smithy.api#jsonName": "l6Metadata" } + }, + "L6Mode": { + "target": "com.amazonaws.mediaconvert#DolbyVisionLevel6Mode", + "traits": { + "smithy.api#documentation": "Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies.", + "smithy.api#jsonName": "l6Mode" + } } }, "traits": { @@ -4107,6 +4387,13 @@ "com.amazonaws.mediaconvert#DvbNitSettings": { "type": "structure", "members": { + "NitInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin25Max10000", + "traits": { + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "nitInterval" + } + }, "NetworkId": { "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { @@ -4120,13 +4407,6 @@ "smithy.api#documentation": "The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is 256 characters.", "smithy.api#jsonName": "networkName" } - }, - "NitInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin25Max10000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "nitInterval" - } } }, "traits": { @@ -4136,13 +4416,6 @@ "com.amazonaws.mediaconvert#DvbSdtSettings": { "type": "structure", "members": { - "SdtInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin25Max2000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "sdtInterval" - } - }, "ServiceName": { "target": "com.amazonaws.mediaconvert#__stringMin1Max256", "traits": { @@ -4150,6 +4423,13 @@ "smithy.api#jsonName": "serviceName" } }, + "ServiceProviderName": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "serviceProviderName" + } + }, "OutputSdt": { "target": "com.amazonaws.mediaconvert#OutputSdt", "traits": { @@ -4157,11 +4437,11 @@ "smithy.api#jsonName": "outputSdt" } }, - "ServiceProviderName": { - "target": "com.amazonaws.mediaconvert#__stringMin1Max256", + "SdtInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin25Max2000", "traits": { - "smithy.api#documentation": "The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "serviceProviderName" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "sdtInterval" } } }, @@ -4179,6 +4459,27 @@ "smithy.api#jsonName": "backgroundOpacity" } }, + "OutlineSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max10", + "traits": { + "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "outlineSize" + } + }, + "ShadowOpacity": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max255", + "traits": { + "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowOpacity" + } + }, + "FontSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max96", + "traits": { + "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontSize" + } + }, "OutlineColor": { "target": "com.amazonaws.mediaconvert#DvbSubtitleOutlineColor", "traits": { @@ -4186,11 +4487,11 @@ "smithy.api#jsonName": "outlineColor" } }, - "FontResolution": { - "target": "com.amazonaws.mediaconvert#__integerMin96Max600", + "SubtitlingType": { + "target": "com.amazonaws.mediaconvert#DvbSubtitlingType", "traits": { - "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontResolution" + "smithy.api#documentation": "Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.", + "smithy.api#jsonName": "subtitlingType" } }, "ShadowColor": { @@ -4200,25 +4501,25 @@ "smithy.api#jsonName": "shadowColor" } }, - "FontScript": { - "target": "com.amazonaws.mediaconvert#FontScript", + "ShadowYOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions.", - "smithy.api#jsonName": "fontScript" + "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowYOffset" } }, - "FontOpacity": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max255", + "TeletextSpacing": { + "target": "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing", "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontOpacity" + "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#jsonName": "teletextSpacing" } }, - "OutlineSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max10", + "FontColor": { + "target": "com.amazonaws.mediaconvert#DvbSubtitleFontColor", "traits": { - "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "outlineSize" + "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontColor" } }, "ShadowXOffset": { @@ -4228,13 +4529,6 @@ "smithy.api#jsonName": "shadowXOffset" } }, - "BackgroundColor": { - "target": "com.amazonaws.mediaconvert#DvbSubtitleBackgroundColor", - "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundColor" - } - }, "XPosition": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -4249,53 +4543,39 @@ "smithy.api#jsonName": "alignment" } }, - "YPosition": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "BackgroundColor": { + "target": "com.amazonaws.mediaconvert#DvbSubtitleBackgroundColor", "traits": { - "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "yPosition" + "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundColor" } }, - "TeletextSpacing": { - "target": "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing", + "FontScript": { + "target": "com.amazonaws.mediaconvert#FontScript", "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", - "smithy.api#jsonName": "teletextSpacing" + "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions.", + "smithy.api#jsonName": "fontScript" } }, - "ShadowYOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "FontResolution": { + "target": "com.amazonaws.mediaconvert#__integerMin96Max600", "traits": { - "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowYOffset" + "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontResolution" } }, - "FontSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max96", + "YPosition": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontSize" + "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "yPosition" } }, - "ShadowOpacity": { + "FontOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowOpacity" - } - }, - "SubtitlingType": { - "target": "com.amazonaws.mediaconvert#DvbSubtitlingType", - "traits": { - "smithy.api#documentation": "Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.", - "smithy.api#jsonName": "subtitlingType" - } - }, - "FontColor": { - "target": "com.amazonaws.mediaconvert#DvbSubtitleFontColor", - "traits": { - "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontColor" + "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontOpacity" } } }, @@ -4620,18 +4900,11 @@ "com.amazonaws.mediaconvert#Eac3AtmosSettings": { "type": "structure", "members": { - "LtRtCenterMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", - "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", - "smithy.api#jsonName": "ltRtCenterMixLevel" - } - }, - "StereoDownmix": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosStereoDownmix", + "LtRtSurroundMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", "traits": { - "smithy.api#documentation": "Choose how the service does stereo downmixing.", - "smithy.api#jsonName": "stereoDownmix" + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", + "smithy.api#jsonName": "ltRtSurroundMixLevel" } }, "LoRoSurroundMixLevel": { @@ -4641,11 +4914,25 @@ "smithy.api#jsonName": "loRoSurroundMixLevel" } }, - "SurroundExMode": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosSurroundExMode", + "DynamicRangeCompressionLine": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionLine", "traits": { - "smithy.api#documentation": "Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.", - "smithy.api#jsonName": "surroundExMode" + "smithy.api#documentation": "Specify the absolute peak level for a signal with dynamic range compression.", + "smithy.api#jsonName": "dynamicRangeCompressionLine" + } + }, + "LtRtCenterMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", + "traits": { + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", + "smithy.api#jsonName": "ltRtCenterMixLevel" + } + }, + "MeteringMode": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosMeteringMode", + "traits": { + "smithy.api#documentation": "Choose how the service meters the loudness of your audio.", + "smithy.api#jsonName": "meteringMode" } }, "BitstreamMode": { @@ -4655,39 +4942,39 @@ "smithy.api#jsonName": "bitstreamMode" } }, - "CodingMode": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosCodingMode", + "DynamicRangeCompressionRf": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionRf", "traits": { - "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).", - "smithy.api#jsonName": "codingMode" + "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", + "smithy.api#jsonName": "dynamicRangeCompressionRf" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin384000Max768000", + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin48000Max48000", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second.\nValid values: 384k, 448k, 640k, 768k", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "This value is always 48000. It represents the sample rate in Hz.", + "smithy.api#jsonName": "sampleRate" } }, - "LtRtSurroundMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "CodingMode": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosCodingMode", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", - "smithy.api#jsonName": "ltRtSurroundMixLevel" + "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).", + "smithy.api#jsonName": "codingMode" } }, - "LoRoCenterMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", + "StereoDownmix": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosStereoDownmix", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only center mix\n(Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this\nvalue depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix).\nValid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", - "smithy.api#jsonName": "loRoCenterMixLevel" + "smithy.api#documentation": "Choose how the service does stereo downmixing.", + "smithy.api#jsonName": "stereoDownmix" } }, - "DialogueIntelligence": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosDialogueIntelligence", + "SurroundExMode": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosSurroundExMode", "traits": { - "smithy.api#documentation": "Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.", - "smithy.api#jsonName": "dialogueIntelligence" + "smithy.api#documentation": "Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.", + "smithy.api#jsonName": "surroundExMode" } }, "SpeechThreshold": { @@ -4697,32 +4984,25 @@ "smithy.api#jsonName": "speechThreshold" } }, - "DynamicRangeCompressionLine": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionLine", - "traits": { - "smithy.api#documentation": "Specify the absolute peak level for a signal with dynamic range compression.", - "smithy.api#jsonName": "dynamicRangeCompressionLine" - } - }, - "MeteringMode": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosMeteringMode", + "LoRoCenterMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", "traits": { - "smithy.api#documentation": "Choose how the service meters the loudness of your audio.", - "smithy.api#jsonName": "meteringMode" + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only center mix\n(Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this\nvalue depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix).\nValid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", + "smithy.api#jsonName": "loRoCenterMixLevel" } }, - "DynamicRangeCompressionRf": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionRf", + "DialogueIntelligence": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosDialogueIntelligence", "traits": { - "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", - "smithy.api#jsonName": "dynamicRangeCompressionRf" + "smithy.api#documentation": "Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.", + "smithy.api#jsonName": "dialogueIntelligence" } }, - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin48000Max48000", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin384000Max768000", "traits": { - "smithy.api#documentation": "This value is always 48000. It represents the sample rate in Hz.", - "smithy.api#jsonName": "sampleRate" + "smithy.api#documentation": "Specify the average bitrate in bits per second.\nValid values: 384k, 448k, 640k, 768k", + "smithy.api#jsonName": "bitrate" } } }, @@ -5001,25 +5281,18 @@ "com.amazonaws.mediaconvert#Eac3Settings": { "type": "structure", "members": { - "StereoDownmix": { - "target": "com.amazonaws.mediaconvert#Eac3StereoDownmix", - "traits": { - "smithy.api#documentation": "Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix).", - "smithy.api#jsonName": "stereoDownmix" - } - }, - "BitstreamMode": { - "target": "com.amazonaws.mediaconvert#Eac3BitstreamMode", + "SurroundExMode": { + "target": "com.amazonaws.mediaconvert#Eac3SurroundExMode", "traits": { - "smithy.api#documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", - "smithy.api#jsonName": "bitstreamMode" + "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", + "smithy.api#jsonName": "surroundExMode" } }, - "LoRoSurroundMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "LtRtCenterMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60Max3", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only surround (loRoSurroundMixLevel).", - "smithy.api#jsonName": "loRoSurroundMixLevel" + "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total center (ltRtCenterMixLevel).", + "smithy.api#jsonName": "ltRtCenterMixLevel" } }, "Dialnorm": { @@ -5029,53 +5302,39 @@ "smithy.api#jsonName": "dialnorm" } }, - "CodingMode": { - "target": "com.amazonaws.mediaconvert#Eac3CodingMode", - "traits": { - "smithy.api#documentation": "Dolby Digital Plus coding mode. Determines number of channels.", - "smithy.api#jsonName": "codingMode" - } - }, - "LtRtCenterMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60Max3", - "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total center (ltRtCenterMixLevel).", - "smithy.api#jsonName": "ltRtCenterMixLevel" - } - }, - "PhaseControl": { - "target": "com.amazonaws.mediaconvert#Eac3PhaseControl", + "LoRoSurroundMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", "traits": { - "smithy.api#documentation": "Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "phaseControl" + "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only surround (loRoSurroundMixLevel).", + "smithy.api#jsonName": "loRoSurroundMixLevel" } }, - "AttenuationControl": { - "target": "com.amazonaws.mediaconvert#Eac3AttenuationControl", + "LtRtSurroundMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", "traits": { - "smithy.api#documentation": "If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "attenuationControl" + "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total surround (ltRtSurroundMixLevel).", + "smithy.api#jsonName": "ltRtSurroundMixLevel" } }, - "SurroundMode": { - "target": "com.amazonaws.mediaconvert#Eac3SurroundMode", + "DynamicRangeCompressionLine": { + "target": "com.amazonaws.mediaconvert#Eac3DynamicRangeCompressionLine", "traits": { - "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", - "smithy.api#jsonName": "surroundMode" + "smithy.api#documentation": "Specify the absolute peak level for a signal with dynamic range compression.", + "smithy.api#jsonName": "dynamicRangeCompressionLine" } }, - "DcFilter": { - "target": "com.amazonaws.mediaconvert#Eac3DcFilter", + "MetadataControl": { + "target": "com.amazonaws.mediaconvert#Eac3MetadataControl", "traits": { - "smithy.api#documentation": "Activates a DC highpass filter for all input channels.", - "smithy.api#jsonName": "dcFilter" + "smithy.api#documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", + "smithy.api#jsonName": "metadataControl" } }, - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin48000Max48000", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin64000Max640000", "traits": { - "smithy.api#documentation": "This value is always 48000. It represents the sample rate in Hz.", - "smithy.api#jsonName": "sampleRate" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.", + "smithy.api#jsonName": "bitrate" } }, "LoRoCenterMixLevel": { @@ -5085,11 +5344,18 @@ "smithy.api#jsonName": "loRoCenterMixLevel" } }, - "SurroundExMode": { - "target": "com.amazonaws.mediaconvert#Eac3SurroundExMode", + "LfeFilter": { + "target": "com.amazonaws.mediaconvert#Eac3LfeFilter", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", - "smithy.api#jsonName": "surroundExMode" + "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", + "smithy.api#jsonName": "lfeFilter" + } + }, + "LfeControl": { + "target": "com.amazonaws.mediaconvert#Eac3LfeControl", + "traits": { + "smithy.api#documentation": "When encoding 3/2 audio, controls whether the LFE channel is enabled", + "smithy.api#jsonName": "lfeControl" } }, "DynamicRangeCompressionRf": { @@ -5099,53 +5365,67 @@ "smithy.api#jsonName": "dynamicRangeCompressionRf" } }, - "DynamicRangeCompressionLine": { - "target": "com.amazonaws.mediaconvert#Eac3DynamicRangeCompressionLine", + "PassthroughControl": { + "target": "com.amazonaws.mediaconvert#Eac3PassthroughControl", "traits": { - "smithy.api#documentation": "Specify the absolute peak level for a signal with dynamic range compression.", - "smithy.api#jsonName": "dynamicRangeCompressionLine" + "smithy.api#documentation": "When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.", + "smithy.api#jsonName": "passthroughControl" } }, - "LfeControl": { - "target": "com.amazonaws.mediaconvert#Eac3LfeControl", + "PhaseControl": { + "target": "com.amazonaws.mediaconvert#Eac3PhaseControl", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, controls whether the LFE channel is enabled", - "smithy.api#jsonName": "lfeControl" + "smithy.api#documentation": "Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "phaseControl" } }, - "MetadataControl": { - "target": "com.amazonaws.mediaconvert#Eac3MetadataControl", + "CodingMode": { + "target": "com.amazonaws.mediaconvert#Eac3CodingMode", "traits": { - "smithy.api#documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", - "smithy.api#jsonName": "metadataControl" + "smithy.api#documentation": "Dolby Digital Plus coding mode. Determines number of channels.", + "smithy.api#jsonName": "codingMode" } }, - "PassthroughControl": { - "target": "com.amazonaws.mediaconvert#Eac3PassthroughControl", + "SurroundMode": { + "target": "com.amazonaws.mediaconvert#Eac3SurroundMode", "traits": { - "smithy.api#documentation": "When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.", - "smithy.api#jsonName": "passthroughControl" + "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", + "smithy.api#jsonName": "surroundMode" } }, - "LtRtSurroundMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin48000Max48000", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total surround (ltRtSurroundMixLevel).", - "smithy.api#jsonName": "ltRtSurroundMixLevel" + "smithy.api#documentation": "This value is always 48000. It represents the sample rate in Hz.", + "smithy.api#jsonName": "sampleRate" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin64000Max640000", + "StereoDownmix": { + "target": "com.amazonaws.mediaconvert#Eac3StereoDownmix", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix).", + "smithy.api#jsonName": "stereoDownmix" } }, - "LfeFilter": { - "target": "com.amazonaws.mediaconvert#Eac3LfeFilter", + "BitstreamMode": { + "target": "com.amazonaws.mediaconvert#Eac3BitstreamMode", "traits": { - "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", - "smithy.api#jsonName": "lfeFilter" + "smithy.api#documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", + "smithy.api#jsonName": "bitstreamMode" + } + }, + "AttenuationControl": { + "target": "com.amazonaws.mediaconvert#Eac3AttenuationControl", + "traits": { + "smithy.api#documentation": "If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "attenuationControl" + } + }, + "DcFilter": { + "target": "com.amazonaws.mediaconvert#Eac3DcFilter", + "traits": { + "smithy.api#documentation": "Activates a DC highpass filter for all input channels.", + "smithy.api#jsonName": "dcFilter" } } }, @@ -5453,11 +5733,11 @@ "com.amazonaws.mediaconvert#FileSourceSettings": { "type": "structure", "members": { - "SourceFile": { - "target": "com.amazonaws.mediaconvert#__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI", + "Framerate": { + "target": "com.amazonaws.mediaconvert#CaptionSourceFramerate", "traits": { - "smithy.api#documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'.", - "smithy.api#jsonName": "sourceFile" + "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", + "smithy.api#jsonName": "framerate" } }, "TimeDelta": { @@ -5467,19 +5747,19 @@ "smithy.api#jsonName": "timeDelta" } }, - "Framerate": { - "target": "com.amazonaws.mediaconvert#CaptionSourceFramerate", - "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", - "smithy.api#jsonName": "framerate" - } - }, "Convert608To708": { "target": "com.amazonaws.mediaconvert#FileSourceConvert608To708", "traits": { "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", "smithy.api#jsonName": "convert608To708" } + }, + "SourceFile": { + "target": "com.amazonaws.mediaconvert#__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI", + "traits": { + "smithy.api#documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'.", + "smithy.api#jsonName": "sourceFile" + } } }, "traits": { @@ -5525,11 +5805,18 @@ "com.amazonaws.mediaconvert#FrameCaptureSettings": { "type": "structure", "members": { - "FramerateNumerator": { + "FramerateDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.", + "smithy.api#jsonName": "framerateDenominator" + } + }, + "MaxCaptures": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max10000000", + "traits": { + "smithy.api#documentation": "Maximum number of captures (encoded jpg output files).", + "smithy.api#jsonName": "maxCaptures" } }, "Quality": { @@ -5539,18 +5826,11 @@ "smithy.api#jsonName": "quality" } }, - "FramerateDenominator": { + "FramerateNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.", - "smithy.api#jsonName": "framerateDenominator" - } - }, - "MaxCaptures": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max10000000", - "traits": { - "smithy.api#documentation": "Maximum number of captures (encoded jpg output files).", - "smithy.api#jsonName": "maxCaptures" + "smithy.api#documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.", + "smithy.api#jsonName": "framerateNumerator" } } }, @@ -5614,7 +5894,7 @@ "Job": { "target": "com.amazonaws.mediaconvert#Job", "traits": { - "smithy.api#documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", + "smithy.api#documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", "smithy.api#jsonName": "job" } } @@ -5809,7 +6089,7 @@ "com.amazonaws.mediaconvert#H264AdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", "smithy.api#enum": [ { "value": "OFF", @@ -5981,7 +6261,7 @@ "com.amazonaws.mediaconvert#H264FieldEncoding": { "type": "string", "traits": { - "smithy.api#documentation": "Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.", + "smithy.api#documentation": "Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field (FORCE_FIELD) to disable PAFF encoding and create separate interlaced fields.", "smithy.api#enum": [ { "value": "PAFF", @@ -5997,7 +6277,7 @@ "com.amazonaws.mediaconvert#H264FlickerAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "smithy.api#documentation": "Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off (OFF).", "smithy.api#enum": [ { "value": "DISABLED", @@ -6029,7 +6309,7 @@ "com.amazonaws.mediaconvert#H264FramerateConversionAlgorithm": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#enum": [ { "value": "DUPLICATE_DROP", @@ -6038,6 +6318,10 @@ { "value": "INTERPOLATE", "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" } ] } @@ -6077,7 +6361,7 @@ "com.amazonaws.mediaconvert#H264InterlaceMode": { "type": "string", "traits": { - "smithy.api#documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", "smithy.api#enum": [ { "value": "PROGRESSIVE", @@ -6141,6 +6425,13 @@ "com.amazonaws.mediaconvert#H264QvbrSettings": { "type": "structure", "members": { + "MaxAverageBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", + "traits": { + "smithy.api#documentation": "Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value that you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output.", + "smithy.api#jsonName": "maxAverageBitrate" + } + }, "QvbrQualityLevelFineTune": { "target": "com.amazonaws.mediaconvert#__doubleMin0Max1", "traits": { @@ -6154,13 +6445,6 @@ "smithy.api#documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify the general target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33.", "smithy.api#jsonName": "qvbrQualityLevel" } - }, - "MaxAverageBitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", - "traits": { - "smithy.api#documentation": "Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value that you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output.", - "smithy.api#jsonName": "maxAverageBitrate" - } } }, "traits": { @@ -6226,193 +6510,200 @@ "com.amazonaws.mediaconvert#H264Settings": { "type": "structure", "members": { - "GopSize": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", - "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", - "smithy.api#jsonName": "gopSize" - } - }, - "SlowPal": { - "target": "com.amazonaws.mediaconvert#H264SlowPal", + "NumberReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max6", "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", - "smithy.api#jsonName": "slowPal" + "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", + "smithy.api#jsonName": "numberReferenceFrames" } }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1152000000", + "UnregisteredSeiTimecode": { + "target": "com.amazonaws.mediaconvert#H264UnregisteredSeiTimecode", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", + "smithy.api#jsonName": "unregisteredSeiTimecode" } }, - "InterlaceMode": { - "target": "com.amazonaws.mediaconvert#H264InterlaceMode", + "TemporalAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H264TemporalAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", - "smithy.api#jsonName": "interlaceMode" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#jsonName": "temporalAdaptiveQuantization" } }, - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max7", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#H264FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "GopBReference": { - "target": "com.amazonaws.mediaconvert#H264GopBReference", + "EntropyEncoding": { + "target": "com.amazonaws.mediaconvert#H264EntropyEncoding", "traits": { - "smithy.api#documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", - "smithy.api#jsonName": "gopBReference" + "smithy.api#documentation": "Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.", + "smithy.api#jsonName": "entropyEncoding" } }, - "Syntax": { - "target": "com.amazonaws.mediaconvert#H264Syntax", + "SceneChangeDetect": { + "target": "com.amazonaws.mediaconvert#H264SceneChangeDetect", "traits": { - "smithy.api#documentation": "Produces a bitstream compliant with SMPTE RP-2027.", - "smithy.api#jsonName": "syntax" + "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", + "smithy.api#jsonName": "sceneChangeDetect" } }, - "DynamicSubGop": { - "target": "com.amazonaws.mediaconvert#H264DynamicSubGop", + "RepeatPps": { + "target": "com.amazonaws.mediaconvert#H264RepeatPps", "traits": { - "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", - "smithy.api#jsonName": "dynamicSubGop" + "smithy.api#documentation": "Places a PPS header on each encoded picture, even if repeated.", + "smithy.api#jsonName": "repeatPps" } }, - "ParNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "MaxBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", + "smithy.api#jsonName": "maxBitrate" } }, "FieldEncoding": { "target": "com.amazonaws.mediaconvert#H264FieldEncoding", "traits": { - "smithy.api#documentation": "Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.", + "smithy.api#documentation": "Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field (FORCE_FIELD) to disable PAFF encoding and create separate interlaced fields.", "smithy.api#jsonName": "fieldEncoding" } }, - "CodecProfile": { - "target": "com.amazonaws.mediaconvert#H264CodecProfile", + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.", - "smithy.api#jsonName": "codecProfile" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, - "Slices": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max32", + "MinIInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", - "smithy.api#jsonName": "slices" + "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "MaxBitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", + "HrdBufferInitialFillPercentage": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "hrdBufferInitialFillPercentage" } }, - "GopSizeUnits": { - "target": "com.amazonaws.mediaconvert#H264GopSizeUnits", + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#H264CodecProfile", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.", + "smithy.api#jsonName": "codecProfile" } }, - "SceneChangeDetect": { - "target": "com.amazonaws.mediaconvert#H264SceneChangeDetect", + "ParNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", - "smithy.api#jsonName": "sceneChangeDetect" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" } }, - "RepeatPps": { - "target": "com.amazonaws.mediaconvert#H264RepeatPps", + "AdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H264AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Places a PPS header on each encoded picture, even if repeated.", - "smithy.api#jsonName": "repeatPps" + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "UnregisteredSeiTimecode": { - "target": "com.amazonaws.mediaconvert#H264UnregisteredSeiTimecode", + "GopBReference": { + "target": "com.amazonaws.mediaconvert#H264GopBReference", "traits": { - "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", - "smithy.api#jsonName": "unregisteredSeiTimecode" + "smithy.api#documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", + "smithy.api#jsonName": "gopBReference" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#H264QualityTuningLevel", + "GopClosedCadence": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "EntropyEncoding": { - "target": "com.amazonaws.mediaconvert#H264EntropyEncoding", + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.", - "smithy.api#jsonName": "entropyEncoding" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, - "HrdBufferInitialFillPercentage": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", + "Telecine": { + "target": "com.amazonaws.mediaconvert#H264Telecine", "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "hrdBufferInitialFillPercentage" + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#H264FramerateConversionAlgorithm", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" } }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#H264RateControlMode", + "CodecLevel": { + "target": "com.amazonaws.mediaconvert#H264CodecLevel", "traits": { - "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).", + "smithy.api#jsonName": "codecLevel" } }, - "NumberReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max6", + "QvbrSettings": { + "target": "com.amazonaws.mediaconvert#H264QvbrSettings", "traits": { - "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", - "smithy.api#jsonName": "numberReferenceFrames" + "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", + "smithy.api#jsonName": "qvbrSettings" } }, - "TemporalAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H264TemporalAdaptiveQuantization", + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#H264InterlaceMode", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", - "smithy.api#jsonName": "temporalAdaptiveQuantization" + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" + } + }, + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1152000000", + "traits": { + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } }, "SpatialAdaptiveQuantization": { "target": "com.amazonaws.mediaconvert#H264SpatialAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", "smithy.api#jsonName": "spatialAdaptiveQuantization" } }, - "FlickerAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H264FlickerAdaptiveQuantization", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", - "smithy.api#jsonName": "flickerAdaptiveQuantization" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#H264Telecine", + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#H264RateControlMode", "traits": { - "smithy.api#documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", - "smithy.api#jsonName": "telecine" + "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", + "smithy.api#jsonName": "rateControlMode" + } + }, + "GopSizeUnits": { + "target": "com.amazonaws.mediaconvert#H264GopSizeUnits", + "traits": { + "smithy.api#documentation": "Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, "ParControl": { @@ -6422,81 +6713,74 @@ "smithy.api#jsonName": "parControl" } }, - "QvbrSettings": { - "target": "com.amazonaws.mediaconvert#H264QvbrSettings", - "traits": { - "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", - "smithy.api#jsonName": "qvbrSettings" - } - }, - "Softness": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max128", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#H264FramerateControl", "traits": { - "smithy.api#documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.", - "smithy.api#jsonName": "softness" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "Slices": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max32", "traits": { - "smithy.api#documentation": "Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", + "smithy.api#jsonName": "slices" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", + "SlowPal": { + "target": "com.amazonaws.mediaconvert#H264SlowPal", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" } }, - "GopClosedCadence": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "GopSize": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", + "smithy.api#jsonName": "gopSize" } }, - "CodecLevel": { - "target": "com.amazonaws.mediaconvert#H264CodecLevel", + "Syntax": { + "target": "com.amazonaws.mediaconvert#H264Syntax", "traits": { - "smithy.api#documentation": "Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).", - "smithy.api#jsonName": "codecLevel" + "smithy.api#documentation": "Produces a bitstream compliant with SMPTE RP-2027.", + "smithy.api#jsonName": "syntax" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H264AdaptiveQuantization", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "FlickerAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H264FlickerAdaptiveQuantization", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off (OFF).", + "smithy.api#jsonName": "flickerAdaptiveQuantization" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#H264FramerateControl", + "Softness": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max128", "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" + "smithy.api#documentation": "Ignore this setting unless you need to comply with a specification that requires a specific value. If you don't have a specification requirement, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, for flat quantization. Choose the value 1 or 16 to use the default JVT softening quantization matricies from the H.264 specification. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video.", + "smithy.api#jsonName": "softness" } }, - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#H264QualityTuningLevel", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" } }, - "MinIInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max30", + "DynamicSubGop": { + "target": "com.amazonaws.mediaconvert#H264DynamicSubGop", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "smithy.api#jsonName": "dynamicSubGop" } } }, @@ -6507,7 +6791,7 @@ "com.amazonaws.mediaconvert#H264SlowPal": { "type": "string", "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", "smithy.api#enum": [ { "value": "DISABLED", @@ -6523,7 +6807,7 @@ "com.amazonaws.mediaconvert#H264SpatialAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", "smithy.api#enum": [ { "value": "DISABLED", @@ -6555,7 +6839,7 @@ "com.amazonaws.mediaconvert#H264Telecine": { "type": "string", "traits": { - "smithy.api#documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", "smithy.api#enum": [ { "value": "NONE", @@ -6575,7 +6859,7 @@ "com.amazonaws.mediaconvert#H264TemporalAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", "smithy.api#enum": [ { "value": "DISABLED", @@ -6607,7 +6891,7 @@ "com.amazonaws.mediaconvert#H265AdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", "smithy.api#enum": [ { "value": "OFF", @@ -6775,7 +7059,7 @@ "com.amazonaws.mediaconvert#H265FlickerAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "smithy.api#documentation": "Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off (OFF).", "smithy.api#enum": [ { "value": "DISABLED", @@ -6807,7 +7091,7 @@ "com.amazonaws.mediaconvert#H265FramerateConversionAlgorithm": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#enum": [ { "value": "DUPLICATE_DROP", @@ -6816,6 +7100,10 @@ { "value": "INTERPOLATE", "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" } ] } @@ -6855,7 +7143,7 @@ "com.amazonaws.mediaconvert#H265InterlaceMode": { "type": "string", "traits": { - "smithy.api#documentation": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).", + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", "smithy.api#enum": [ { "value": "PROGRESSIVE", @@ -7008,90 +7296,97 @@ "com.amazonaws.mediaconvert#H265Settings": { "type": "structure", "members": { - "InterlaceMode": { - "target": "com.amazonaws.mediaconvert#H265InterlaceMode", + "SceneChangeDetect": { + "target": "com.amazonaws.mediaconvert#H265SceneChangeDetect", "traits": { - "smithy.api#documentation": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).", - "smithy.api#jsonName": "interlaceMode" + "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", + "smithy.api#jsonName": "sceneChangeDetect" } }, - "CodecLevel": { - "target": "com.amazonaws.mediaconvert#H265CodecLevel", + "MinIInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "H.265 Level.", - "smithy.api#jsonName": "codecLevel" + "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "WriteMp4PackagingType": { - "target": "com.amazonaws.mediaconvert#H265WriteMp4PackagingType", + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#H265QualityTuningLevel", "traits": { - "smithy.api#documentation": "If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.", - "smithy.api#jsonName": "writeMp4PackagingType" + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" } }, - "GopSize": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "MaxBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1466400000", "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", + "smithy.api#jsonName": "maxBitrate" } }, - "GopBReference": { - "target": "com.amazonaws.mediaconvert#H265GopBReference", + "HrdBufferInitialFillPercentage": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", - "smithy.api#jsonName": "gopBReference" + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "hrdBufferInitialFillPercentage" } }, - "SlowPal": { - "target": "com.amazonaws.mediaconvert#H265SlowPal", + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#H265RateControlMode", "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", - "smithy.api#jsonName": "slowPal" + "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", + "smithy.api#jsonName": "rateControlMode" } }, - "ParDenominator": { + "ParNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" } }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1466400000", + "AdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H265AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "ParControl": { - "target": "com.amazonaws.mediaconvert#H265ParControl", + "AlternateTransferFunctionSei": { + "target": "com.amazonaws.mediaconvert#H265AlternateTransferFunctionSei", "traits": { - "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", - "smithy.api#jsonName": "parControl" + "smithy.api#documentation": "Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).", + "smithy.api#jsonName": "alternateTransferFunctionSei" } }, - "SpatialAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H265SpatialAdaptiveQuantization", + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", - "smithy.api#jsonName": "spatialAdaptiveQuantization" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, "FramerateDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Frame rate denominator.", + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", "smithy.api#jsonName": "framerateDenominator" } }, + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#H265CodecProfile", + "traits": { + "smithy.api#documentation": "Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so \"Main/High\" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License.", + "smithy.api#jsonName": "codecProfile" + } + }, "TemporalIds": { "target": "com.amazonaws.mediaconvert#H265TemporalIds", "traits": { @@ -7099,186 +7394,179 @@ "smithy.api#jsonName": "temporalIds" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#H265FramerateControl", - "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" - } - }, - "GopClosedCadence": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "FlickerAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H265FlickerAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off (OFF).", + "smithy.api#jsonName": "flickerAdaptiveQuantization" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1466400000", + "SampleAdaptiveOffsetFilterMode": { + "target": "com.amazonaws.mediaconvert#H265SampleAdaptiveOffsetFilterMode", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content", + "smithy.api#jsonName": "sampleAdaptiveOffsetFilterMode" } }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#H265Telecine", + "DynamicSubGop": { + "target": "com.amazonaws.mediaconvert#H265DynamicSubGop", "traits": { - "smithy.api#documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", - "smithy.api#jsonName": "telecine" + "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "smithy.api#jsonName": "dynamicSubGop" } }, - "AlternateTransferFunctionSei": { - "target": "com.amazonaws.mediaconvert#H265AlternateTransferFunctionSei", + "UnregisteredSeiTimecode": { + "target": "com.amazonaws.mediaconvert#H265UnregisteredSeiTimecode", "traits": { - "smithy.api#documentation": "Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).", - "smithy.api#jsonName": "alternateTransferFunctionSei" + "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", + "smithy.api#jsonName": "unregisteredSeiTimecode" } }, - "QvbrSettings": { - "target": "com.amazonaws.mediaconvert#H265QvbrSettings", + "TemporalAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H265TemporalAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", - "smithy.api#jsonName": "qvbrSettings" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#jsonName": "temporalAdaptiveQuantization" } }, - "SceneChangeDetect": { - "target": "com.amazonaws.mediaconvert#H265SceneChangeDetect", + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#H265InterlaceMode", "traits": { - "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", - "smithy.api#jsonName": "sceneChangeDetect" + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" } }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#H265RateControlMode", + "CodecLevel": { + "target": "com.amazonaws.mediaconvert#H265CodecLevel", "traits": { - "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "H.265 Level.", + "smithy.api#jsonName": "codecLevel" } }, - "ParNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "GopSize": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", + "smithy.api#jsonName": "gopSize" } }, - "MinIInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max30", + "SlowPal": { + "target": "com.amazonaws.mediaconvert#H265SlowPal", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" } }, - "HrdBufferInitialFillPercentage": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1466400000", "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "hrdBufferInitialFillPercentage" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" } }, - "Tiles": { - "target": "com.amazonaws.mediaconvert#H265Tiles", + "WriteMp4PackagingType": { + "target": "com.amazonaws.mediaconvert#H265WriteMp4PackagingType", "traits": { - "smithy.api#documentation": "Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.", - "smithy.api#jsonName": "tiles" + "smithy.api#documentation": "If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.", + "smithy.api#jsonName": "writeMp4PackagingType" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H265AdaptiveQuantization", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#H265FramerateControl", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, - "GopSizeUnits": { - "target": "com.amazonaws.mediaconvert#H265GopSizeUnits", + "Slices": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max32", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", + "smithy.api#jsonName": "slices" } }, - "NumberReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max6", + "ParControl": { + "target": "com.amazonaws.mediaconvert#H265ParControl", "traits": { - "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", - "smithy.api#jsonName": "numberReferenceFrames" + "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", + "smithy.api#jsonName": "parControl" } }, - "TemporalAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H265TemporalAdaptiveQuantization", + "QvbrSettings": { + "target": "com.amazonaws.mediaconvert#H265QvbrSettings", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", - "smithy.api#jsonName": "temporalAdaptiveQuantization" + "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", + "smithy.api#jsonName": "qvbrSettings" } }, - "FlickerAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H265FlickerAdaptiveQuantization", + "Telecine": { + "target": "com.amazonaws.mediaconvert#H265Telecine", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", - "smithy.api#jsonName": "flickerAdaptiveQuantization" + "smithy.api#documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", + "smithy.api#jsonName": "telecine" } }, - "SampleAdaptiveOffsetFilterMode": { - "target": "com.amazonaws.mediaconvert#H265SampleAdaptiveOffsetFilterMode", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content", - "smithy.api#jsonName": "sampleAdaptiveOffsetFilterMode" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, - "MaxBitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1466400000", + "SpatialAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H265SpatialAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#jsonName": "spatialAdaptiveQuantization" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#H265FramerateConversionAlgorithm", + "GopClosedCadence": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "DynamicSubGop": { - "target": "com.amazonaws.mediaconvert#H265DynamicSubGop", + "NumberReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max6", "traits": { - "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", - "smithy.api#jsonName": "dynamicSubGop" + "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", + "smithy.api#jsonName": "numberReferenceFrames" } }, - "CodecProfile": { - "target": "com.amazonaws.mediaconvert#H265CodecProfile", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#H265FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so \"Main/High\" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License.", - "smithy.api#jsonName": "codecProfile" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "UnregisteredSeiTimecode": { - "target": "com.amazonaws.mediaconvert#H265UnregisteredSeiTimecode", + "GopBReference": { + "target": "com.amazonaws.mediaconvert#H265GopBReference", "traits": { - "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", - "smithy.api#jsonName": "unregisteredSeiTimecode" + "smithy.api#documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", + "smithy.api#jsonName": "gopBReference" } }, - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max7", + "GopSizeUnits": { + "target": "com.amazonaws.mediaconvert#H265GopSizeUnits", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" + "smithy.api#documentation": "Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "Slices": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max32", + "Tiles": { + "target": "com.amazonaws.mediaconvert#H265Tiles", "traits": { - "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", - "smithy.api#jsonName": "slices" + "smithy.api#documentation": "Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.", + "smithy.api#jsonName": "tiles" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#H265QualityTuningLevel", + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1466400000", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } } }, @@ -7289,7 +7577,7 @@ "com.amazonaws.mediaconvert#H265SlowPal": { "type": "string", "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", "smithy.api#enum": [ { "value": "DISABLED", @@ -7305,7 +7593,7 @@ "com.amazonaws.mediaconvert#H265SpatialAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", "smithy.api#enum": [ { "value": "DISABLED", @@ -7341,7 +7629,7 @@ "com.amazonaws.mediaconvert#H265TemporalAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", "smithy.api#enum": [ { "value": "DISABLED", @@ -7421,32 +7709,32 @@ "com.amazonaws.mediaconvert#Hdr10Metadata": { "type": "structure", "members": { - "WhitePointY": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", + "MaxLuminance": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "whitePointY" + "smithy.api#documentation": "Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.", + "smithy.api#jsonName": "maxLuminance" } }, - "RedPrimaryY": { + "BluePrimaryX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "redPrimaryY" + "smithy.api#jsonName": "bluePrimaryX" } }, - "MaxContentLightLevel": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "BluePrimaryY": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { - "smithy.api#documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", - "smithy.api#jsonName": "maxContentLightLevel" + "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", + "smithy.api#jsonName": "bluePrimaryY" } }, - "MinLuminance": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "WhitePointY": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { - "smithy.api#documentation": "Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter", - "smithy.api#jsonName": "minLuminance" + "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", + "smithy.api#jsonName": "whitePointY" } }, "RedPrimaryX": { @@ -7456,13 +7744,6 @@ "smithy.api#jsonName": "redPrimaryX" } }, - "MaxLuminance": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", - "traits": { - "smithy.api#documentation": "Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.", - "smithy.api#jsonName": "maxLuminance" - } - }, "WhitePointX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { @@ -7470,18 +7751,25 @@ "smithy.api#jsonName": "whitePointX" } }, - "GreenPrimaryX": { + "MinLuminance": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter", + "smithy.api#jsonName": "minLuminance" + } + }, + "RedPrimaryY": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "greenPrimaryX" + "smithy.api#jsonName": "redPrimaryY" } }, - "BluePrimaryX": { + "GreenPrimaryY": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "bluePrimaryX" + "smithy.api#jsonName": "greenPrimaryY" } }, "MaxFrameAverageLightLevel": { @@ -7491,18 +7779,18 @@ "smithy.api#jsonName": "maxFrameAverageLightLevel" } }, - "GreenPrimaryY": { + "GreenPrimaryX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "greenPrimaryY" + "smithy.api#jsonName": "greenPrimaryX" } }, - "BluePrimaryY": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", + "MaxContentLightLevel": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "bluePrimaryY" + "smithy.api#documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", + "smithy.api#jsonName": "maxContentLightLevel" } } }, @@ -7528,19 +7816,19 @@ "com.amazonaws.mediaconvert#HlsAdditionalManifest": { "type": "structure", "members": { - "SelectedOutputs": { - "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", - "traits": { - "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", - "smithy.api#jsonName": "selectedOutputs" - } - }, "ManifestNameModifier": { "target": "com.amazonaws.mediaconvert#__stringMin1", "traits": { "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your HLS group is film-name.m3u8. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is different from the nameModifier of the output. The service uses the output name modifier to create unique names for the individual variant manifests.", "smithy.api#jsonName": "manifestNameModifier" } + }, + "SelectedOutputs": { + "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", + "traits": { + "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", + "smithy.api#jsonName": "selectedOutputs" + } } }, "traits": { @@ -7563,6 +7851,22 @@ ] } }, + "com.amazonaws.mediaconvert#HlsAudioOnlyHeader": { + "type": "string", + "traits": { + "smithy.api#documentation": "Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.", + "smithy.api#enum": [ + { + "value": "INCLUDE", + "name": "INCLUDE" + }, + { + "value": "EXCLUDE", + "name": "EXCLUDE" + } + ] + } + }, "com.amazonaws.mediaconvert#HlsAudioTrackType": { "type": "string", "traits": { @@ -7604,19 +7908,19 @@ "smithy.api#jsonName": "captionChannel" } }, - "LanguageCode": { - "target": "com.amazonaws.mediaconvert#LanguageCode", - "traits": { - "smithy.api#documentation": "Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.", - "smithy.api#jsonName": "languageCode" - } - }, "LanguageDescription": { "target": "com.amazonaws.mediaconvert#__string", "traits": { "smithy.api#documentation": "Caption language description.", "smithy.api#jsonName": "languageDescription" } + }, + "LanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", + "traits": { + "smithy.api#documentation": "Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.", + "smithy.api#jsonName": "languageCode" + } } }, "traits": { @@ -7694,13 +7998,6 @@ "com.amazonaws.mediaconvert#HlsEncryptionSettings": { "type": "structure", "members": { - "OfflineEncrypted": { - "target": "com.amazonaws.mediaconvert#HlsOfflineEncrypted", - "traits": { - "smithy.api#documentation": "Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.", - "smithy.api#jsonName": "offlineEncrypted" - } - }, "EncryptionMethod": { "target": "com.amazonaws.mediaconvert#HlsEncryptionType", "traits": { @@ -7708,13 +8005,6 @@ "smithy.api#jsonName": "encryptionMethod" } }, - "SpekeKeyProvider": { - "target": "com.amazonaws.mediaconvert#SpekeKeyProvider", - "traits": { - "smithy.api#documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.", - "smithy.api#jsonName": "spekeKeyProvider" - } - }, "StaticKeyProvider": { "target": "com.amazonaws.mediaconvert#StaticKeyProvider", "traits": { @@ -7736,6 +8026,20 @@ "smithy.api#jsonName": "constantInitializationVector" } }, + "SpekeKeyProvider": { + "target": "com.amazonaws.mediaconvert#SpekeKeyProvider", + "traits": { + "smithy.api#documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.", + "smithy.api#jsonName": "spekeKeyProvider" + } + }, + "OfflineEncrypted": { + "target": "com.amazonaws.mediaconvert#HlsOfflineEncrypted", + "traits": { + "smithy.api#documentation": "Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.", + "smithy.api#jsonName": "offlineEncrypted" + } + }, "InitializationVectorInManifest": { "target": "com.amazonaws.mediaconvert#HlsInitializationVectorInManifest", "traits": { @@ -7767,74 +8071,39 @@ "com.amazonaws.mediaconvert#HlsGroupSettings": { "type": "structure", "members": { - "TimedMetadataId3Frame": { - "target": "com.amazonaws.mediaconvert#HlsTimedMetadataId3Frame", - "traits": { - "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", - "smithy.api#jsonName": "timedMetadataId3Frame" - } - }, - "ProgramDateTime": { - "target": "com.amazonaws.mediaconvert#HlsProgramDateTime", - "traits": { - "smithy.api#documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.", - "smithy.api#jsonName": "programDateTime" - } - }, - "MinFinalSegmentLength": { - "target": "com.amazonaws.mediaconvert#__doubleMin0Max2147483647", - "traits": { - "smithy.api#documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.", - "smithy.api#jsonName": "minFinalSegmentLength" - } - }, - "ProgramDateTimePeriod": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max3600", - "traits": { - "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", - "smithy.api#jsonName": "programDateTimePeriod" - } - }, - "SegmentControl": { - "target": "com.amazonaws.mediaconvert#HlsSegmentControl", - "traits": { - "smithy.api#documentation": "When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.", - "smithy.api#jsonName": "segmentControl" - } - }, - "CaptionLanguageSetting": { - "target": "com.amazonaws.mediaconvert#HlsCaptionLanguageSetting", + "TimestampDeltaMilliseconds": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.", - "smithy.api#jsonName": "captionLanguageSetting" + "smithy.api#documentation": "Provides an extra millisecond delta offset to fine tune the timestamps.", + "smithy.api#jsonName": "timestampDeltaMilliseconds" } }, - "CodecSpecification": { - "target": "com.amazonaws.mediaconvert#HlsCodecSpecification", + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", "traits": { - "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", - "smithy.api#jsonName": "codecSpecification" + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } }, - "Destination": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "DirectoryStructure": { + "target": "com.amazonaws.mediaconvert#HlsDirectoryStructure", "traits": { - "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", - "smithy.api#jsonName": "destination" + "smithy.api#documentation": "Indicates whether segments should be placed in subdirectories.", + "smithy.api#jsonName": "directoryStructure" } }, - "ManifestCompression": { - "target": "com.amazonaws.mediaconvert#HlsManifestCompression", + "AdMarkers": { + "target": "com.amazonaws.mediaconvert#__listOfHlsAdMarkers", "traits": { - "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", - "smithy.api#jsonName": "manifestCompression" + "smithy.api#documentation": "Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.", + "smithy.api#jsonName": "adMarkers" } }, - "SegmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "ManifestDurationFormat": { + "target": "com.amazonaws.mediaconvert#HlsManifestDurationFormat", "traits": { - "smithy.api#documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.", - "smithy.api#jsonName": "segmentLength" + "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", + "smithy.api#jsonName": "manifestDurationFormat" } }, "BaseUrl": { @@ -7844,32 +8113,32 @@ "smithy.api#jsonName": "baseUrl" } }, - "AdMarkers": { - "target": "com.amazonaws.mediaconvert#__listOfHlsAdMarkers", + "CaptionLanguageSetting": { + "target": "com.amazonaws.mediaconvert#HlsCaptionLanguageSetting", "traits": { - "smithy.api#documentation": "Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.", - "smithy.api#jsonName": "adMarkers" + "smithy.api#documentation": "Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.", + "smithy.api#jsonName": "captionLanguageSetting" } }, - "TimestampDeltaMilliseconds": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "CodecSpecification": { + "target": "com.amazonaws.mediaconvert#HlsCodecSpecification", "traits": { - "smithy.api#documentation": "Provides an extra millisecond delta offset to fine tune the timestamps.", - "smithy.api#jsonName": "timestampDeltaMilliseconds" + "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", + "smithy.api#jsonName": "codecSpecification" } }, - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", + "SegmentControl": { + "target": "com.amazonaws.mediaconvert#HlsSegmentControl", "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" + "smithy.api#documentation": "When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.", + "smithy.api#jsonName": "segmentControl" } }, - "MinSegmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "Destination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", - "smithy.api#jsonName": "minSegmentLength" + "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", + "smithy.api#jsonName": "destination" } }, "ClientCache": { @@ -7879,39 +8148,46 @@ "smithy.api#jsonName": "clientCache" } }, - "DirectoryStructure": { - "target": "com.amazonaws.mediaconvert#HlsDirectoryStructure", + "CaptionLanguageMappings": { + "target": "com.amazonaws.mediaconvert#__listOfHlsCaptionLanguageMapping", "traits": { - "smithy.api#documentation": "Indicates whether segments should be placed in subdirectories.", - "smithy.api#jsonName": "directoryStructure" + "smithy.api#documentation": "Language to be used on Caption outputs", + "smithy.api#jsonName": "captionLanguageMappings" } }, - "TimedMetadataId3Period": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "TimedMetadataId3Frame": { + "target": "com.amazonaws.mediaconvert#HlsTimedMetadataId3Frame", "traits": { - "smithy.api#documentation": "Timed Metadata interval in seconds.", - "smithy.api#jsonName": "timedMetadataId3Period" + "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", + "smithy.api#jsonName": "timedMetadataId3Frame" } }, - "SegmentsPerSubdirectory": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "MinFinalSegmentLength": { + "target": "com.amazonaws.mediaconvert#__doubleMin0Max2147483647", "traits": { - "smithy.api#documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.", - "smithy.api#jsonName": "segmentsPerSubdirectory" + "smithy.api#documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.", + "smithy.api#jsonName": "minFinalSegmentLength" } }, - "CaptionLanguageMappings": { - "target": "com.amazonaws.mediaconvert#__listOfHlsCaptionLanguageMapping", + "OutputSelection": { + "target": "com.amazonaws.mediaconvert#HlsOutputSelection", "traits": { - "smithy.api#documentation": "Language to be used on Caption outputs", - "smithy.api#jsonName": "captionLanguageMappings" + "smithy.api#documentation": "Indicates whether the .m3u8 manifest file should be generated for this HLS output group.", + "smithy.api#jsonName": "outputSelection" } }, - "AdditionalManifests": { - "target": "com.amazonaws.mediaconvert#__listOfHlsAdditionalManifest", + "StreamInfResolution": { + "target": "com.amazonaws.mediaconvert#HlsStreamInfResolution", "traits": { - "smithy.api#documentation": "By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.", - "smithy.api#jsonName": "additionalManifests" + "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", + "smithy.api#jsonName": "streamInfResolution" + } + }, + "ProgramDateTime": { + "target": "com.amazonaws.mediaconvert#HlsProgramDateTime", + "traits": { + "smithy.api#documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.", + "smithy.api#jsonName": "programDateTime" } }, "Encryption": { @@ -7921,25 +8197,60 @@ "smithy.api#jsonName": "encryption" } }, - "OutputSelection": { - "target": "com.amazonaws.mediaconvert#HlsOutputSelection", + "ManifestCompression": { + "target": "com.amazonaws.mediaconvert#HlsManifestCompression", "traits": { - "smithy.api#documentation": "Indicates whether the .m3u8 manifest file should be generated for this HLS output group.", - "smithy.api#jsonName": "outputSelection" + "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", + "smithy.api#jsonName": "manifestCompression" } }, - "ManifestDurationFormat": { - "target": "com.amazonaws.mediaconvert#HlsManifestDurationFormat", + "AdditionalManifests": { + "target": "com.amazonaws.mediaconvert#__listOfHlsAdditionalManifest", "traits": { - "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", - "smithy.api#jsonName": "manifestDurationFormat" + "smithy.api#documentation": "By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.", + "smithy.api#jsonName": "additionalManifests" } }, - "StreamInfResolution": { - "target": "com.amazonaws.mediaconvert#HlsStreamInfResolution", + "SegmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", - "smithy.api#jsonName": "streamInfResolution" + "smithy.api#documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.", + "smithy.api#jsonName": "segmentLength" + } + }, + "SegmentsPerSubdirectory": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.", + "smithy.api#jsonName": "segmentsPerSubdirectory" + } + }, + "TimedMetadataId3Period": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "traits": { + "smithy.api#documentation": "Timed Metadata interval in seconds.", + "smithy.api#jsonName": "timedMetadataId3Period" + } + }, + "MinSegmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", + "smithy.api#jsonName": "minSegmentLength" + } + }, + "AudioOnlyHeader": { + "target": "com.amazonaws.mediaconvert#HlsAudioOnlyHeader", + "traits": { + "smithy.api#documentation": "Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.", + "smithy.api#jsonName": "audioOnlyHeader" + } + }, + "ProgramDateTimePeriod": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max3600", + "traits": { + "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", + "smithy.api#jsonName": "programDateTimePeriod" } } }, @@ -8094,13 +8405,6 @@ "com.amazonaws.mediaconvert#HlsSettings": { "type": "structure", "members": { - "SegmentModifier": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html", - "smithy.api#jsonName": "segmentModifier" - } - }, "AudioGroupId": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -8115,6 +8419,13 @@ "smithy.api#jsonName": "iFrameOnlyManifest" } }, + "SegmentModifier": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html", + "smithy.api#jsonName": "segmentModifier" + } + }, "AudioTrackType": { "target": "com.amazonaws.mediaconvert#HlsAudioTrackType", "traits": { @@ -8180,13 +8491,6 @@ "com.amazonaws.mediaconvert#HopDestination": { "type": "structure", "members": { - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", - "traits": { - "smithy.api#documentation": "Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue.", - "smithy.api#jsonName": "priority" - } - }, "WaitMinutes": { "target": "com.amazonaws.mediaconvert#__integer", "traits": { @@ -8200,6 +8504,13 @@ "smithy.api#documentation": "Optional unless the job is submitted on the default queue. When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn't the default queue and you don't specify the destination queue, the job will move to the default queue.", "smithy.api#jsonName": "queue" } + }, + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "traits": { + "smithy.api#documentation": "Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue.", + "smithy.api#jsonName": "priority" + } } }, "traits": { @@ -8277,25 +8588,11 @@ "com.amazonaws.mediaconvert#Input": { "type": "structure", "members": { - "DenoiseFilter": { - "target": "com.amazonaws.mediaconvert#InputDenoiseFilter", - "traits": { - "smithy.api#documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.", - "smithy.api#jsonName": "denoiseFilter" - } - }, - "FilterStrength": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative5Max5", - "traits": { - "smithy.api#documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.", - "smithy.api#jsonName": "filterStrength" - } - }, - "Crop": { - "target": "com.amazonaws.mediaconvert#Rectangle", + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", - "smithy.api#jsonName": "crop" + "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", + "smithy.api#jsonName": "programNumber" } }, "AudioSelectors": { @@ -8305,13 +8602,6 @@ "smithy.api#jsonName": "audioSelectors" } }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", - "smithy.api#jsonName": "programNumber" - } - }, "CaptionSelectors": { "target": "com.amazonaws.mediaconvert#__mapOfCaptionSelector", "traits": { @@ -8326,32 +8616,53 @@ "smithy.api#jsonName": "psiControl" } }, - "Position": { - "target": "com.amazonaws.mediaconvert#Rectangle", + "DenoiseFilter": { + "target": "com.amazonaws.mediaconvert#InputDenoiseFilter", "traits": { - "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).", - "smithy.api#jsonName": "position" + "smithy.api#documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.", + "smithy.api#jsonName": "denoiseFilter" } }, - "SupplementalImps": { - "target": "com.amazonaws.mediaconvert#__listOf__stringPatternS3ASSETMAPXml", + "TimecodeSource": { + "target": "com.amazonaws.mediaconvert#InputTimecodeSource", "traits": { - "smithy.api#documentation": "Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example [\"s3://bucket/ov/\", \"s3://bucket/vf2/ASSETMAP.xml\"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it.", - "smithy.api#jsonName": "supplementalImps" + "smithy.api#documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "smithy.api#jsonName": "timecodeSource" } }, - "VideoSelector": { - "target": "com.amazonaws.mediaconvert#VideoSelector", + "FilterStrength": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative5Max5", "traits": { - "smithy.api#documentation": "Selector for video.", - "smithy.api#jsonName": "videoSelector" + "smithy.api#documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.", + "smithy.api#jsonName": "filterStrength" } }, - "DeblockFilter": { - "target": "com.amazonaws.mediaconvert#InputDeblockFilter", + "AudioSelectorGroups": { + "target": "com.amazonaws.mediaconvert#__mapOfAudioSelectorGroup", "traits": { - "smithy.api#documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.", - "smithy.api#jsonName": "deblockFilter" + "smithy.api#documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information.", + "smithy.api#jsonName": "audioSelectorGroups" + } + }, + "InputClippings": { + "target": "com.amazonaws.mediaconvert#__listOfInputClipping", + "traits": { + "smithy.api#documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them.", + "smithy.api#jsonName": "inputClippings" + } + }, + "TimecodeStart": { + "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "traits": { + "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "smithy.api#jsonName": "timecodeStart" + } + }, + "InputScanType": { + "target": "com.amazonaws.mediaconvert#InputScanType", + "traits": { + "smithy.api#documentation": "When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto (AUTO). Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.", + "smithy.api#jsonName": "inputScanType" } }, "ImageInserter": { @@ -8361,53 +8672,60 @@ "smithy.api#jsonName": "imageInserter" } }, - "InputClippings": { - "target": "com.amazonaws.mediaconvert#__listOfInputClipping", + "FileInput": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL", "traits": { - "smithy.api#documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them.", - "smithy.api#jsonName": "inputClippings" + "smithy.api#documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.", + "smithy.api#jsonName": "fileInput" + } + }, + "DecryptionSettings": { + "target": "com.amazonaws.mediaconvert#InputDecryptionSettings", + "traits": { + "smithy.api#documentation": "Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.", + "smithy.api#jsonName": "decryptionSettings" } }, "FilterEnable": { "target": "com.amazonaws.mediaconvert#InputFilterEnable", "traits": { - "smithy.api#documentation": "Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.", + "smithy.api#documentation": "Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.", "smithy.api#jsonName": "filterEnable" } }, - "FileInput": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL", + "Crop": { + "target": "com.amazonaws.mediaconvert#Rectangle", "traits": { - "smithy.api#documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.", - "smithy.api#jsonName": "fileInput" + "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", + "smithy.api#jsonName": "crop" } }, - "DecryptionSettings": { - "target": "com.amazonaws.mediaconvert#InputDecryptionSettings", + "DeblockFilter": { + "target": "com.amazonaws.mediaconvert#InputDeblockFilter", "traits": { - "smithy.api#documentation": "Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.", - "smithy.api#jsonName": "decryptionSettings" + "smithy.api#documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.", + "smithy.api#jsonName": "deblockFilter" } }, - "AudioSelectorGroups": { - "target": "com.amazonaws.mediaconvert#__mapOfAudioSelectorGroup", + "Position": { + "target": "com.amazonaws.mediaconvert#Rectangle", "traits": { - "smithy.api#documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information.", - "smithy.api#jsonName": "audioSelectorGroups" + "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).", + "smithy.api#jsonName": "position" } }, - "TimecodeStart": { - "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "SupplementalImps": { + "target": "com.amazonaws.mediaconvert#__listOf__stringPatternS3ASSETMAPXml", "traits": { - "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", - "smithy.api#jsonName": "timecodeStart" + "smithy.api#documentation": "Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example [\"s3://bucket/ov/\", \"s3://bucket/vf2/ASSETMAP.xml\"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it.", + "smithy.api#jsonName": "supplementalImps" } }, - "TimecodeSource": { - "target": "com.amazonaws.mediaconvert#InputTimecodeSource", + "VideoSelector": { + "target": "com.amazonaws.mediaconvert#VideoSelector", "traits": { - "smithy.api#documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", - "smithy.api#jsonName": "timecodeSource" + "smithy.api#documentation": "Selector for video.", + "smithy.api#jsonName": "videoSelector" } } }, @@ -8456,20 +8774,6 @@ "com.amazonaws.mediaconvert#InputDecryptionSettings": { "type": "structure", "members": { - "DecryptionMode": { - "target": "com.amazonaws.mediaconvert#DecryptionMode", - "traits": { - "smithy.api#documentation": "Specify the encryption mode that you used to encrypt your input files.", - "smithy.api#jsonName": "decryptionMode" - } - }, - "EncryptedDecryptionKey": { - "target": "com.amazonaws.mediaconvert#__stringMin24Max512PatternAZaZ0902", - "traits": { - "smithy.api#documentation": "Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits.", - "smithy.api#jsonName": "encryptedDecryptionKey" - } - }, "InitializationVector": { "target": "com.amazonaws.mediaconvert#__stringMin16Max24PatternAZaZ0922AZaZ0916", "traits": { @@ -8483,6 +8787,20 @@ "smithy.api#documentation": "Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that Region is different from the one you are using for AWS Elemental MediaConvert.", "smithy.api#jsonName": "kmsKeyRegion" } + }, + "EncryptedDecryptionKey": { + "target": "com.amazonaws.mediaconvert#__stringMin24Max512PatternAZaZ0902", + "traits": { + "smithy.api#documentation": "Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits.", + "smithy.api#jsonName": "encryptedDecryptionKey" + } + }, + "DecryptionMode": { + "target": "com.amazonaws.mediaconvert#DecryptionMode", + "traits": { + "smithy.api#documentation": "Specify the encryption mode that you used to encrypt your input files.", + "smithy.api#jsonName": "decryptionMode" + } } }, "traits": { @@ -8508,7 +8826,7 @@ "com.amazonaws.mediaconvert#InputFilterEnable": { "type": "string", "traits": { - "smithy.api#documentation": "Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.", + "smithy.api#documentation": "Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.", "smithy.api#enum": [ { "value": "AUTO", @@ -8569,14 +8887,37 @@ ] } }, + "com.amazonaws.mediaconvert#InputScanType": { + "type": "string", + "traits": { + "smithy.api#documentation": "When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto (AUTO). Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.", + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "PSF", + "name": "PSF" + } + ] + } + }, "com.amazonaws.mediaconvert#InputTemplate": { "type": "structure", "members": { - "TimecodeStart": { - "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "AudioSelectorGroups": { + "target": "com.amazonaws.mediaconvert#__mapOfAudioSelectorGroup", "traits": { - "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", - "smithy.api#jsonName": "timecodeStart" + "smithy.api#documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information.", + "smithy.api#jsonName": "audioSelectorGroups" + } + }, + "DeblockFilter": { + "target": "com.amazonaws.mediaconvert#InputDeblockFilter", + "traits": { + "smithy.api#documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.", + "smithy.api#jsonName": "deblockFilter" } }, "InputClippings": { @@ -8586,11 +8927,18 @@ "smithy.api#jsonName": "inputClippings" } }, - "DeblockFilter": { - "target": "com.amazonaws.mediaconvert#InputDeblockFilter", + "TimecodeStart": { + "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", "traits": { - "smithy.api#documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.", - "smithy.api#jsonName": "deblockFilter" + "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "smithy.api#jsonName": "timecodeStart" + } + }, + "InputScanType": { + "target": "com.amazonaws.mediaconvert#InputScanType", + "traits": { + "smithy.api#documentation": "When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto (AUTO). Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.", + "smithy.api#jsonName": "inputScanType" } }, "ImageInserter": { @@ -8600,25 +8948,25 @@ "smithy.api#jsonName": "imageInserter" } }, - "Crop": { - "target": "com.amazonaws.mediaconvert#Rectangle", + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", - "smithy.api#jsonName": "crop" + "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", + "smithy.api#jsonName": "programNumber" } }, - "VideoSelector": { - "target": "com.amazonaws.mediaconvert#VideoSelector", + "FilterStrength": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative5Max5", "traits": { - "smithy.api#documentation": "Selector for video.", - "smithy.api#jsonName": "videoSelector" + "smithy.api#documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.", + "smithy.api#jsonName": "filterStrength" } }, - "FilterEnable": { - "target": "com.amazonaws.mediaconvert#InputFilterEnable", + "Position": { + "target": "com.amazonaws.mediaconvert#Rectangle", "traits": { - "smithy.api#documentation": "Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.", - "smithy.api#jsonName": "filterEnable" + "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).", + "smithy.api#jsonName": "position" } }, "PsiControl": { @@ -8628,11 +8976,11 @@ "smithy.api#jsonName": "psiControl" } }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "TimecodeSource": { + "target": "com.amazonaws.mediaconvert#InputTimecodeSource", "traits": { - "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", - "smithy.api#jsonName": "programNumber" + "smithy.api#documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "smithy.api#jsonName": "timecodeSource" } }, "AudioSelectors": { @@ -8649,11 +8997,11 @@ "smithy.api#jsonName": "captionSelectors" } }, - "Position": { - "target": "com.amazonaws.mediaconvert#Rectangle", + "VideoSelector": { + "target": "com.amazonaws.mediaconvert#VideoSelector", "traits": { - "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).", - "smithy.api#jsonName": "position" + "smithy.api#documentation": "Selector for video.", + "smithy.api#jsonName": "videoSelector" } }, "DenoiseFilter": { @@ -8663,25 +9011,18 @@ "smithy.api#jsonName": "denoiseFilter" } }, - "FilterStrength": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative5Max5", - "traits": { - "smithy.api#documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.", - "smithy.api#jsonName": "filterStrength" - } - }, - "TimecodeSource": { - "target": "com.amazonaws.mediaconvert#InputTimecodeSource", + "FilterEnable": { + "target": "com.amazonaws.mediaconvert#InputFilterEnable", "traits": { - "smithy.api#documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", - "smithy.api#jsonName": "timecodeSource" + "smithy.api#documentation": "Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.", + "smithy.api#jsonName": "filterEnable" } }, - "AudioSelectorGroups": { - "target": "com.amazonaws.mediaconvert#__mapOfAudioSelectorGroup", + "Crop": { + "target": "com.amazonaws.mediaconvert#Rectangle", "traits": { - "smithy.api#documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information.", - "smithy.api#jsonName": "audioSelectorGroups" + "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", + "smithy.api#jsonName": "crop" } } }, @@ -8712,13 +9053,6 @@ "com.amazonaws.mediaconvert#InsertableImage": { "type": "structure", "members": { - "ImageY": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", - "traits": { - "smithy.api#documentation": "Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.", - "smithy.api#jsonName": "imageY" - } - }, "Layer": { "target": "com.amazonaws.mediaconvert#__integerMin0Max99", "traits": { @@ -8726,18 +9060,11 @@ "smithy.api#jsonName": "layer" } }, - "ImageX": { + "Duration": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.", - "smithy.api#jsonName": "imageX" - } - }, - "Opacity": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", - "traits": { - "smithy.api#documentation": "Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.", - "smithy.api#jsonName": "opacity" + "smithy.api#documentation": "Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.", + "smithy.api#jsonName": "duration" } }, "StartTime": { @@ -8747,13 +9074,6 @@ "smithy.api#jsonName": "startTime" } }, - "FadeOut": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", - "traits": { - "smithy.api#documentation": "Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.", - "smithy.api#jsonName": "fadeOut" - } - }, "FadeIn": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -8775,11 +9095,18 @@ "smithy.api#jsonName": "height" } }, - "Duration": { + "ImageX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.", - "smithy.api#jsonName": "duration" + "smithy.api#documentation": "Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.", + "smithy.api#jsonName": "imageX" + } + }, + "Opacity": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", + "traits": { + "smithy.api#documentation": "Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.", + "smithy.api#jsonName": "opacity" } }, "ImageInserterInput": { @@ -8788,6 +9115,20 @@ "smithy.api#documentation": "Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.", "smithy.api#jsonName": "imageInserterInput" } + }, + "FadeOut": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.", + "smithy.api#jsonName": "fadeOut" + } + }, + "ImageY": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.", + "smithy.api#jsonName": "imageY" + } } }, "traits": { @@ -8813,41 +9154,46 @@ "com.amazonaws.mediaconvert#Job": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.mediaconvert#__integer", + "QueueTransitions": { + "target": "com.amazonaws.mediaconvert#__listOfQueueTransition", "traits": { - "smithy.api#documentation": "Error code for the job", - "smithy.api#jsonName": "errorCode" + "smithy.api#documentation": "The job's queue hopping history.", + "smithy.api#jsonName": "queueTransitions" } }, - "Settings": { - "target": "com.amazonaws.mediaconvert#JobSettings", + "UserMetadata": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { - "smithy.api#documentation": "JobSettings contains all the transcode settings for a job.", - "smithy.api#jsonName": "settings", - "smithy.api#required": {} + "smithy.api#documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", + "smithy.api#jsonName": "userMetadata" } }, - "Role": { - "target": "com.amazonaws.mediaconvert#__string", + "AccelerationSettings": { + "target": "com.amazonaws.mediaconvert#AccelerationSettings", "traits": { - "smithy.api#documentation": "The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html", - "smithy.api#jsonName": "role", - "smithy.api#required": {} + "smithy.api#documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content.", + "smithy.api#jsonName": "accelerationSettings" } }, - "AccelerationStatus": { - "target": "com.amazonaws.mediaconvert#AccelerationStatus", + "JobPercentComplete": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.", - "smithy.api#jsonName": "accelerationStatus" + "smithy.api#documentation": "An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.", + "smithy.api#jsonName": "jobPercentComplete" + } + }, + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", + "traits": { + "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" } }, - "SimulateReservedQueue": { - "target": "com.amazonaws.mediaconvert#SimulateReservedQueue", + "BillingTagsSource": { + "target": "com.amazonaws.mediaconvert#BillingTagsSource", "traits": { - "smithy.api#documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.", - "smithy.api#jsonName": "simulateReservedQueue" + "smithy.api#documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.", + "smithy.api#jsonName": "billingTagsSource" } }, "Priority": { @@ -8864,46 +9210,40 @@ "smithy.api#jsonName": "currentPhase" } }, - "Status": { - "target": "com.amazonaws.mediaconvert#JobStatus", - "traits": { - "smithy.api#documentation": "A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.", - "smithy.api#jsonName": "status" - } - }, - "BillingTagsSource": { - "target": "com.amazonaws.mediaconvert#BillingTagsSource", + "RetryCount": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.", - "smithy.api#jsonName": "billingTagsSource" + "smithy.api#documentation": "The number of times that the service automatically attempted to process your job after encountering an error.", + "smithy.api#jsonName": "retryCount" } }, - "Timing": { - "target": "com.amazonaws.mediaconvert#Timing", + "Queue": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.", - "smithy.api#jsonName": "timing" + "smithy.api#documentation": "When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", + "smithy.api#jsonName": "queue" } }, - "Id": { - "target": "com.amazonaws.mediaconvert#__string", + "SimulateReservedQueue": { + "target": "com.amazonaws.mediaconvert#SimulateReservedQueue", "traits": { - "smithy.api#documentation": "A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.", + "smithy.api#jsonName": "simulateReservedQueue" } }, - "Messages": { - "target": "com.amazonaws.mediaconvert#JobMessages", + "Settings": { + "target": "com.amazonaws.mediaconvert#JobSettings", "traits": { - "smithy.api#documentation": "Provides messages from the service about jobs that you have already successfully submitted.", - "smithy.api#jsonName": "messages" + "smithy.api#documentation": "JobSettings contains all the transcode settings for a job.", + "smithy.api#jsonName": "settings", + "smithy.api#required": {} } }, - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", + "ErrorCode": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" + "smithy.api#documentation": "Error code for the job", + "smithy.api#jsonName": "errorCode" } }, "HopDestinations": { @@ -8913,11 +9253,18 @@ "smithy.api#jsonName": "hopDestinations" } }, - "CreatedAt": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "OutputGroupDetails": { + "target": "com.amazonaws.mediaconvert#__listOfOutputGroupDetail", "traits": { - "smithy.api#documentation": "The time, in Unix epoch format in seconds, when the job got created.", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "List of output group details", + "smithy.api#jsonName": "outputGroupDetails" + } + }, + "Id": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources", + "smithy.api#jsonName": "id" } }, "JobTemplate": { @@ -8927,32 +9274,47 @@ "smithy.api#jsonName": "jobTemplate" } }, - "JobPercentComplete": { - "target": "com.amazonaws.mediaconvert#__integer", + "Timing": { + "target": "com.amazonaws.mediaconvert#Timing", "traits": { - "smithy.api#documentation": "An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.", - "smithy.api#jsonName": "jobPercentComplete" + "smithy.api#documentation": "Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.", + "smithy.api#jsonName": "timing" } }, - "UserMetadata": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", + "Messages": { + "target": "com.amazonaws.mediaconvert#JobMessages", "traits": { - "smithy.api#documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", - "smithy.api#jsonName": "userMetadata" + "smithy.api#documentation": "Provides messages from the service about jobs that you have already successfully submitted.", + "smithy.api#jsonName": "messages" } }, - "Queue": { + "AccelerationStatus": { + "target": "com.amazonaws.mediaconvert#AccelerationStatus", + "traits": { + "smithy.api#documentation": "Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.", + "smithy.api#jsonName": "accelerationStatus" + } + }, + "CreatedAt": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time, in Unix epoch format in seconds, when the job got created.", + "smithy.api#jsonName": "createdAt" + } + }, + "Role": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", - "smithy.api#jsonName": "queue" + "smithy.api#documentation": "The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html", + "smithy.api#jsonName": "role", + "smithy.api#required": {} } }, - "AccelerationSettings": { - "target": "com.amazonaws.mediaconvert#AccelerationSettings", + "Status": { + "target": "com.amazonaws.mediaconvert#JobStatus", "traits": { - "smithy.api#documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content.", - "smithy.api#jsonName": "accelerationSettings" + "smithy.api#documentation": "A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.", + "smithy.api#jsonName": "status" } }, "Arn": { @@ -8968,31 +9330,10 @@ "smithy.api#documentation": "Error message of Job", "smithy.api#jsonName": "errorMessage" } - }, - "OutputGroupDetails": { - "target": "com.amazonaws.mediaconvert#__listOfOutputGroupDetail", - "traits": { - "smithy.api#documentation": "List of output group details", - "smithy.api#jsonName": "outputGroupDetails" - } - }, - "RetryCount": { - "target": "com.amazonaws.mediaconvert#__integer", - "traits": { - "smithy.api#documentation": "The number of times that the service automatically attempted to process your job after encountering an error.", - "smithy.api#jsonName": "retryCount" - } - }, - "QueueTransitions": { - "target": "com.amazonaws.mediaconvert#__listOfQueueTransition", - "traits": { - "smithy.api#documentation": "The job's queue hopping history.", - "smithy.api#jsonName": "queueTransitions" - } } }, "traits": { - "smithy.api#documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + "smithy.api#documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" } }, "com.amazonaws.mediaconvert#JobMessages": { @@ -9040,6 +9381,27 @@ "com.amazonaws.mediaconvert#JobSettings": { "type": "structure", "members": { + "AvailBlanking": { + "target": "com.amazonaws.mediaconvert#AvailBlanking", + "traits": { + "smithy.api#documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.", + "smithy.api#jsonName": "availBlanking" + } + }, + "NielsenConfiguration": { + "target": "com.amazonaws.mediaconvert#NielsenConfiguration", + "traits": { + "smithy.api#documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.", + "smithy.api#jsonName": "nielsenConfiguration" + } + }, + "Esam": { + "target": "com.amazonaws.mediaconvert#EsamSettings", + "traits": { + "smithy.api#documentation": "Settings for Event Signaling And Messaging (ESAM).", + "smithy.api#jsonName": "esam" + } + }, "TimecodeConfig": { "target": "com.amazonaws.mediaconvert#TimecodeConfig", "traits": { @@ -9047,18 +9409,18 @@ "smithy.api#jsonName": "timecodeConfig" } }, - "TimedMetadataInsertion": { - "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", + "NielsenNonLinearWatermark": { + "target": "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings", "traits": { - "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", - "smithy.api#jsonName": "timedMetadataInsertion" + "smithy.api#documentation": "Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]", + "smithy.api#jsonName": "nielsenNonLinearWatermark" } }, - "AvailBlanking": { - "target": "com.amazonaws.mediaconvert#AvailBlanking", + "AdAvailOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", "traits": { - "smithy.api#documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.", - "smithy.api#jsonName": "availBlanking" + "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", + "smithy.api#jsonName": "adAvailOffset" } }, "MotionImageInserter": { @@ -9068,13 +9430,6 @@ "smithy.api#jsonName": "motionImageInserter" } }, - "OutputGroups": { - "target": "com.amazonaws.mediaconvert#__listOfOutputGroup", - "traits": { - "smithy.api#documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings", - "smithy.api#jsonName": "outputGroups" - } - }, "Inputs": { "target": "com.amazonaws.mediaconvert#__listOfInput", "traits": { @@ -9082,25 +9437,18 @@ "smithy.api#jsonName": "inputs" } }, - "NielsenConfiguration": { - "target": "com.amazonaws.mediaconvert#NielsenConfiguration", - "traits": { - "smithy.api#documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.", - "smithy.api#jsonName": "nielsenConfiguration" - } - }, - "AdAvailOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", + "OutputGroups": { + "target": "com.amazonaws.mediaconvert#__listOfOutputGroup", "traits": { - "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", - "smithy.api#jsonName": "adAvailOffset" + "smithy.api#documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings", + "smithy.api#jsonName": "outputGroups" } }, - "Esam": { - "target": "com.amazonaws.mediaconvert#EsamSettings", + "TimedMetadataInsertion": { + "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", "traits": { - "smithy.api#documentation": "Settings for Event Signaling And Messaging (ESAM).", - "smithy.api#jsonName": "esam" + "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", + "smithy.api#jsonName": "timedMetadataInsertion" } } }, @@ -9146,90 +9494,90 @@ "smithy.api#jsonName": "hopDestinations" } }, - "Name": { - "target": "com.amazonaws.mediaconvert#__string", + "AccelerationSettings": { + "target": "com.amazonaws.mediaconvert#AccelerationSettings", "traits": { - "smithy.api#documentation": "A name you create for each job template. Each name must be unique within your account.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content.", + "smithy.api#jsonName": "accelerationSettings" } }, - "LastUpdated": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "Type": { + "target": "com.amazonaws.mediaconvert#Type", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds when the Job template was last updated.", - "smithy.api#jsonName": "lastUpdated" + "smithy.api#documentation": "A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.", + "smithy.api#jsonName": "type" } }, - "Settings": { - "target": "com.amazonaws.mediaconvert#JobTemplateSettings", + "Name": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", - "smithy.api#jsonName": "settings", + "smithy.api#documentation": "A name you create for each job template. Each name must be unique within your account.", + "smithy.api#jsonName": "name", "smithy.api#required": {} } }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "Queue": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Relative priority on the job.", - "smithy.api#jsonName": "priority" + "smithy.api#documentation": "Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.", + "smithy.api#jsonName": "queue" } }, - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", + "CreatedAt": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" + "smithy.api#documentation": "The timestamp in epoch seconds for Job template creation.", + "smithy.api#jsonName": "createdAt" } }, - "Arn": { + "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "An optional description you create for each job template.", + "smithy.api#jsonName": "description" } }, - "Type": { - "target": "com.amazonaws.mediaconvert#Type", + "Category": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "An optional category you create to organize your job templates.", + "smithy.api#jsonName": "category" } }, - "CreatedAt": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "Arn": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for Job template creation.", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", + "smithy.api#jsonName": "arn" } }, - "Queue": { - "target": "com.amazonaws.mediaconvert#__string", + "Settings": { + "target": "com.amazonaws.mediaconvert#JobTemplateSettings", "traits": { - "smithy.api#documentation": "Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.", - "smithy.api#jsonName": "queue" + "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", + "smithy.api#jsonName": "settings", + "smithy.api#required": {} } }, - "AccelerationSettings": { - "target": "com.amazonaws.mediaconvert#AccelerationSettings", + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", "traits": { - "smithy.api#documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content.", - "smithy.api#jsonName": "accelerationSettings" + "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" } }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", + "LastUpdated": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "An optional category you create to organize your job templates.", - "smithy.api#jsonName": "category" + "smithy.api#documentation": "The timestamp in epoch seconds when the Job template was last updated.", + "smithy.api#jsonName": "lastUpdated" } }, - "Description": { - "target": "com.amazonaws.mediaconvert#__string", + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", "traits": { - "smithy.api#documentation": "An optional description you create for each job template.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "Relative priority on the job.", + "smithy.api#jsonName": "priority" } } }, @@ -9260,25 +9608,25 @@ "com.amazonaws.mediaconvert#JobTemplateSettings": { "type": "structure", "members": { - "AdAvailOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", + "Inputs": { + "target": "com.amazonaws.mediaconvert#__listOfInputTemplate", "traits": { - "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", - "smithy.api#jsonName": "adAvailOffset" + "smithy.api#documentation": "Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.", + "smithy.api#jsonName": "inputs" } }, - "TimedMetadataInsertion": { - "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", + "MotionImageInserter": { + "target": "com.amazonaws.mediaconvert#MotionImageInserter", "traits": { - "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", - "smithy.api#jsonName": "timedMetadataInsertion" + "smithy.api#documentation": "Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups.", + "smithy.api#jsonName": "motionImageInserter" } }, - "Esam": { - "target": "com.amazonaws.mediaconvert#EsamSettings", + "NielsenNonLinearWatermark": { + "target": "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings", "traits": { - "smithy.api#documentation": "Settings for Event Signaling And Messaging (ESAM).", - "smithy.api#jsonName": "esam" + "smithy.api#documentation": "Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]", + "smithy.api#jsonName": "nielsenNonLinearWatermark" } }, "TimecodeConfig": { @@ -9295,20 +9643,6 @@ "smithy.api#jsonName": "outputGroups" } }, - "MotionImageInserter": { - "target": "com.amazonaws.mediaconvert#MotionImageInserter", - "traits": { - "smithy.api#documentation": "Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups.", - "smithy.api#jsonName": "motionImageInserter" - } - }, - "Inputs": { - "target": "com.amazonaws.mediaconvert#__listOfInputTemplate", - "traits": { - "smithy.api#documentation": "Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.", - "smithy.api#jsonName": "inputs" - } - }, "NielsenConfiguration": { "target": "com.amazonaws.mediaconvert#NielsenConfiguration", "traits": { @@ -9322,6 +9656,27 @@ "smithy.api#documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.", "smithy.api#jsonName": "availBlanking" } + }, + "TimedMetadataInsertion": { + "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", + "traits": { + "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", + "smithy.api#jsonName": "timedMetadataInsertion" + } + }, + "Esam": { + "target": "com.amazonaws.mediaconvert#EsamSettings", + "traits": { + "smithy.api#documentation": "Settings for Event Signaling And Messaging (ESAM).", + "smithy.api#jsonName": "esam" + } + }, + "AdAvailOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", + "traits": { + "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", + "smithy.api#jsonName": "adAvailOffset" + } } }, "traits": { @@ -10134,12 +10489,25 @@ "method": "GET", "uri": "/2017-08-29/jobTemplates", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobTemplates", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediaconvert#ListJobTemplatesRequest": { "type": "structure", "members": { + "ListBy": { + "target": "com.amazonaws.mediaconvert#JobTemplateListBy", + "traits": { + "smithy.api#documentation": "Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", + "smithy.api#httpQuery": "listBy" + } + }, "NextToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -10147,11 +10515,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", + "MaxResults": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max20", "traits": { - "smithy.api#documentation": "Optionally, specify a job template category to limit responses to only job templates from that category.", - "smithy.api#httpQuery": "category" + "smithy.api#documentation": "Optional. Number of job templates, up to twenty, that will be returned at one time.", + "smithy.api#httpQuery": "maxResults" } }, "Order": { @@ -10161,18 +10529,11 @@ "smithy.api#httpQuery": "order" } }, - "MaxResults": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max20", - "traits": { - "smithy.api#documentation": "Optional. Number of job templates, up to twenty, that will be returned at one time.", - "smithy.api#httpQuery": "maxResults" - } - }, - "ListBy": { - "target": "com.amazonaws.mediaconvert#JobTemplateListBy", + "Category": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", - "smithy.api#httpQuery": "listBy" + "smithy.api#documentation": "Optionally, specify a job template category to limit responses to only job templates from that category.", + "smithy.api#httpQuery": "category" } } } @@ -10180,19 +10541,19 @@ "com.amazonaws.mediaconvert#ListJobTemplatesResponse": { "type": "structure", "members": { - "JobTemplates": { - "target": "com.amazonaws.mediaconvert#__listOfJobTemplate", - "traits": { - "smithy.api#documentation": "List of Job templates.", - "smithy.api#jsonName": "jobTemplates" - } - }, "NextToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { "smithy.api#documentation": "Use this string to request the next batch of job templates.", "smithy.api#jsonName": "nextToken" } + }, + "JobTemplates": { + "target": "com.amazonaws.mediaconvert#__listOfJobTemplate", + "traits": { + "smithy.api#documentation": "List of Job templates.", + "smithy.api#jsonName": "jobTemplates" + } } } }, @@ -10230,17 +10591,30 @@ "method": "GET", "uri": "/2017-08-29/jobs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Jobs", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediaconvert#ListJobsRequest": { "type": "structure", "members": { - "Order": { - "target": "com.amazonaws.mediaconvert#Order", + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", - "smithy.api#httpQuery": "order" + "smithy.api#documentation": "Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.", + "smithy.api#httpQuery": "nextToken" + } + }, + "Queue": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optional. Provide a queue name to get back only jobs from that queue.", + "smithy.api#httpQuery": "queue" } }, "Status": { @@ -10250,13 +10624,6 @@ "smithy.api#httpQuery": "status" } }, - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.", - "smithy.api#httpQuery": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.mediaconvert#__integerMin1Max20", "traits": { @@ -10264,11 +10631,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "Queue": { - "target": "com.amazonaws.mediaconvert#__string", + "Order": { + "target": "com.amazonaws.mediaconvert#Order", "traits": { - "smithy.api#documentation": "Optional. Provide a queue name to get back only jobs from that queue.", - "smithy.api#httpQuery": "queue" + "smithy.api#documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "smithy.api#httpQuery": "order" } } } @@ -10326,19 +10693,18 @@ "method": "GET", "uri": "/2017-08-29/presets", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Presets", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediaconvert#ListPresetsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max20", - "traits": { - "smithy.api#documentation": "Optional. Number of presets, up to twenty, that will be returned at one time", - "smithy.api#httpQuery": "maxResults" - } - }, "Order": { "target": "com.amazonaws.mediaconvert#Order", "traits": { @@ -10346,11 +10712,11 @@ "smithy.api#httpQuery": "order" } }, - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", + "MaxResults": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max20", "traits": { - "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of presets.", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "Optional. Number of presets, up to twenty, that will be returned at one time", + "smithy.api#httpQuery": "maxResults" } }, "Category": { @@ -10360,6 +10726,13 @@ "smithy.api#httpQuery": "category" } }, + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of presets.", + "smithy.api#httpQuery": "nextToken" + } + }, "ListBy": { "target": "com.amazonaws.mediaconvert#PresetListBy", "traits": { @@ -10372,19 +10745,19 @@ "com.amazonaws.mediaconvert#ListPresetsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use this string to request the next batch of presets.", - "smithy.api#jsonName": "nextToken" - } - }, "Presets": { "target": "com.amazonaws.mediaconvert#__listOfPreset", "traits": { "smithy.api#documentation": "List of presets", "smithy.api#jsonName": "presets" } + }, + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this string to request the next batch of presets.", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -10422,12 +10795,25 @@ "method": "GET", "uri": "/2017-08-29/queues", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Queues", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediaconvert#ListQueuesRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max20", + "traits": { + "smithy.api#documentation": "Optional. Number of queues, up to twenty, that will be returned at one time.", + "smithy.api#httpQuery": "maxResults" + } + }, "ListBy": { "target": "com.amazonaws.mediaconvert#QueueListBy", "traits": { @@ -10442,13 +10828,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "MaxResults": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max20", - "traits": { - "smithy.api#documentation": "Optional. Number of queues, up to twenty, that will be returned at one time.", - "smithy.api#httpQuery": "maxResults" - } - }, "Order": { "target": "com.amazonaws.mediaconvert#Order", "traits": { @@ -10461,19 +10840,19 @@ "com.amazonaws.mediaconvert#ListQueuesResponse": { "type": "structure", "members": { - "Queues": { - "target": "com.amazonaws.mediaconvert#__listOfQueue", - "traits": { - "smithy.api#documentation": "List of queues.", - "smithy.api#jsonName": "queues" - } - }, "NextToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { "smithy.api#documentation": "Use this string to request the next batch of queues.", "smithy.api#jsonName": "nextToken" } + }, + "Queues": { + "target": "com.amazonaws.mediaconvert#__listOfQueue", + "traits": { + "smithy.api#documentation": "List of queues.", + "smithy.api#jsonName": "queues" + } } } }, @@ -10757,96 +11136,82 @@ }, { "value": "RESET_CADENCE", - "name": "RESET_CADENCE" - } - ] - } - }, - "com.amazonaws.mediaconvert#M2tsSettings": { - "type": "structure", - "members": { - "NullPacketBitrate": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", - "traits": { - "smithy.api#documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.", - "smithy.api#jsonName": "nullPacketBitrate" - } - }, - "PmtInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", - "traits": { - "smithy.api#documentation": "Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.", - "smithy.api#jsonName": "pmtInterval" - } - }, - "DvbSubPids": { - "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", + "name": "RESET_CADENCE" + } + ] + } + }, + "com.amazonaws.mediaconvert#M2tsSettings": { + "type": "structure", + "members": { + "SegmentationTime": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.", - "smithy.api#jsonName": "dvbSubPids" + "smithy.api#documentation": "Specify the length, in seconds, of each segment. Required unless markers is set to _none_.", + "smithy.api#jsonName": "segmentationTime" } }, - "RateMode": { - "target": "com.amazonaws.mediaconvert#M2tsRateMode", + "AudioFramesPerPes": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.", - "smithy.api#jsonName": "rateMode" + "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", + "smithy.api#jsonName": "audioFramesPerPes" } }, - "EsRateInPes": { - "target": "com.amazonaws.mediaconvert#M2tsEsRateInPes", + "PcrPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Controls whether to include the ES Rate field in the PES header.", - "smithy.api#jsonName": "esRateInPes" + "smithy.api#documentation": "Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid).", + "smithy.api#jsonName": "pcrPid" } }, - "SegmentationStyle": { - "target": "com.amazonaws.mediaconvert#M2tsSegmentationStyle", + "PrivateMetadataPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of \"reset_cadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of \"maintain_cadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.", - "smithy.api#jsonName": "segmentationStyle" + "smithy.api#documentation": "Specify the packet identifier (PID) of the private metadata stream. Default is 503.", + "smithy.api#jsonName": "privateMetadataPid" } }, - "Scte35Esam": { - "target": "com.amazonaws.mediaconvert#M2tsScte35Esam", + "Scte35Pid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).", - "smithy.api#jsonName": "scte35Esam" + "smithy.api#documentation": "Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.", + "smithy.api#jsonName": "scte35Pid" } }, - "PatInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", + "FragmentTime": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "patInterval" + "smithy.api#documentation": "The length, in seconds, of each fragment. Only used with EBP markers.", + "smithy.api#jsonName": "fragmentTime" } }, - "MaxPcrInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max500", + "DvbSdtSettings": { + "target": "com.amazonaws.mediaconvert#DvbSdtSettings", "traits": { - "smithy.api#documentation": "Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.", - "smithy.api#jsonName": "maxPcrInterval" + "smithy.api#documentation": "Inserts DVB Service Description Table (NIT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbSdtSettings" } }, - "AudioPids": { - "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", + "MinEbpInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max10000", "traits": { - "smithy.api#documentation": "Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.", - "smithy.api#jsonName": "audioPids" + "smithy.api#documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.", + "smithy.api#jsonName": "minEbpInterval" } }, - "DvbNitSettings": { - "target": "com.amazonaws.mediaconvert#DvbNitSettings", + "AudioBufferModel": { + "target": "com.amazonaws.mediaconvert#M2tsAudioBufferModel", "traits": { - "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbNitSettings" + "smithy.api#documentation": "Selects between the DVB and ATSC buffer models for Dolby Digital audio.", + "smithy.api#jsonName": "audioBufferModel" } }, - "DvbSdtSettings": { - "target": "com.amazonaws.mediaconvert#DvbSdtSettings", + "ForceTsVideoEbpOrder": { + "target": "com.amazonaws.mediaconvert#M2tsForceTsVideoEbpOrder", "traits": { - "smithy.api#documentation": "Inserts DVB Service Description Table (NIT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbSdtSettings" + "smithy.api#documentation": "Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).", + "smithy.api#jsonName": "forceTsVideoEbpOrder" } }, "BufferModel": { @@ -10856,116 +11221,123 @@ "smithy.api#jsonName": "bufferModel" } }, - "Scte35Source": { - "target": "com.amazonaws.mediaconvert#M2tsScte35Source", + "VideoPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).", - "smithy.api#jsonName": "scte35Source" + "smithy.api#documentation": "Specify the packet identifier (PID) of the elementary video stream in the transport stream.", + "smithy.api#jsonName": "videoPid" } }, - "PrivateMetadataPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "NielsenId3": { + "target": "com.amazonaws.mediaconvert#M2tsNielsenId3", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) of the private metadata stream. Default is 503.", - "smithy.api#jsonName": "privateMetadataPid" + "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "smithy.api#jsonName": "nielsenId3" } }, - "AudioBufferModel": { - "target": "com.amazonaws.mediaconvert#M2tsAudioBufferModel", + "EbpAudioInterval": { + "target": "com.amazonaws.mediaconvert#M2tsEbpAudioInterval", "traits": { - "smithy.api#documentation": "Selects between the DVB and ATSC buffer models for Dolby Digital audio.", - "smithy.api#jsonName": "audioBufferModel" + "smithy.api#documentation": "When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", + "smithy.api#jsonName": "ebpAudioInterval" } }, - "ForceTsVideoEbpOrder": { - "target": "com.amazonaws.mediaconvert#M2tsForceTsVideoEbpOrder", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).", - "smithy.api#jsonName": "forceTsVideoEbpOrder" + "smithy.api#documentation": "Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.", + "smithy.api#jsonName": "bitrate" } }, - "PcrControl": { - "target": "com.amazonaws.mediaconvert#M2tsPcrControl", + "MaxPcrInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max500", "traits": { - "smithy.api#documentation": "When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.", - "smithy.api#jsonName": "pcrControl" + "smithy.api#documentation": "Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.", + "smithy.api#jsonName": "maxPcrInterval" } }, - "TimedMetadataPid": { + "DvbTeletextPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for timed metadata in this output. Default is 502.", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499.", + "smithy.api#jsonName": "dvbTeletextPid" } }, - "PcrPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "EbpPlacement": { + "target": "com.amazonaws.mediaconvert#M2tsEbpPlacement", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid).", - "smithy.api#jsonName": "pcrPid" + "smithy.api#documentation": "Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", + "smithy.api#jsonName": "ebpPlacement" } }, - "SegmentationTime": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "DvbSubPids": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the length, in seconds, of each segment. Required unless markers is set to _none_.", - "smithy.api#jsonName": "segmentationTime" + "smithy.api#documentation": "Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.", + "smithy.api#jsonName": "dvbSubPids" } }, - "DvbTeletextPid": { + "Scte35Esam": { + "target": "com.amazonaws.mediaconvert#M2tsScte35Esam", + "traits": { + "smithy.api#documentation": "Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).", + "smithy.api#jsonName": "scte35Esam" + } + }, + "TimedMetadataPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499.", - "smithy.api#jsonName": "dvbTeletextPid" + "smithy.api#documentation": "Specify the packet identifier (PID) for timed metadata in this output. Default is 502.", + "smithy.api#jsonName": "timedMetadataPid" } }, - "FragmentTime": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "PmtInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "The length, in seconds, of each fragment. Only used with EBP markers.", - "smithy.api#jsonName": "fragmentTime" + "smithy.api#documentation": "Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.", + "smithy.api#jsonName": "pmtInterval" } }, - "PmtPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "NullPacketBitrate": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.", - "smithy.api#jsonName": "pmtPid" + "smithy.api#documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.", + "smithy.api#jsonName": "nullPacketBitrate" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "RateMode": { + "target": "com.amazonaws.mediaconvert#M2tsRateMode", "traits": { - "smithy.api#documentation": "Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.", + "smithy.api#jsonName": "rateMode" } }, - "SegmentationMarkers": { - "target": "com.amazonaws.mediaconvert#M2tsSegmentationMarkers", + "PcrControl": { + "target": "com.amazonaws.mediaconvert#M2tsPcrControl", "traits": { - "smithy.api#documentation": "Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.", - "smithy.api#jsonName": "segmentationMarkers" + "smithy.api#documentation": "When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.", + "smithy.api#jsonName": "pcrControl" } }, - "AudioFramesPerPes": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "DvbTdtSettings": { + "target": "com.amazonaws.mediaconvert#DvbTdtSettings", "traits": { - "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", - "smithy.api#jsonName": "audioFramesPerPes" + "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbTdtSettings" } }, - "EbpAudioInterval": { - "target": "com.amazonaws.mediaconvert#M2tsEbpAudioInterval", + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", - "smithy.api#jsonName": "ebpAudioInterval" + "smithy.api#documentation": "Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", + "smithy.api#jsonName": "programNumber" } }, - "EbpPlacement": { - "target": "com.amazonaws.mediaconvert#M2tsEbpPlacement", + "AudioPids": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", - "smithy.api#jsonName": "ebpPlacement" + "smithy.api#documentation": "Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.", + "smithy.api#jsonName": "audioPids" } }, "TransportStreamId": { @@ -10975,46 +11347,53 @@ "smithy.api#jsonName": "transportStreamId" } }, - "NielsenId3": { - "target": "com.amazonaws.mediaconvert#M2tsNielsenId3", + "DvbNitSettings": { + "target": "com.amazonaws.mediaconvert#DvbNitSettings", "traits": { - "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", - "smithy.api#jsonName": "nielsenId3" + "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbNitSettings" } }, - "VideoPid": { + "Scte35Source": { + "target": "com.amazonaws.mediaconvert#M2tsScte35Source", + "traits": { + "smithy.api#documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).", + "smithy.api#jsonName": "scte35Source" + } + }, + "PmtPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) of the elementary video stream in the transport stream.", - "smithy.api#jsonName": "videoPid" + "smithy.api#documentation": "Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.", + "smithy.api#jsonName": "pmtPid" } }, - "MinEbpInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max10000", + "PatInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.", - "smithy.api#jsonName": "minEbpInterval" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "patInterval" } }, - "Scte35Pid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "EsRateInPes": { + "target": "com.amazonaws.mediaconvert#M2tsEsRateInPes", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.", - "smithy.api#jsonName": "scte35Pid" + "smithy.api#documentation": "Controls whether to include the ES Rate field in the PES header.", + "smithy.api#jsonName": "esRateInPes" } }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "SegmentationMarkers": { + "target": "com.amazonaws.mediaconvert#M2tsSegmentationMarkers", "traits": { - "smithy.api#documentation": "Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", - "smithy.api#jsonName": "programNumber" + "smithy.api#documentation": "Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.", + "smithy.api#jsonName": "segmentationMarkers" } }, - "DvbTdtSettings": { - "target": "com.amazonaws.mediaconvert#DvbTdtSettings", + "SegmentationStyle": { + "target": "com.amazonaws.mediaconvert#M2tsSegmentationStyle", "traits": { - "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbTdtSettings" + "smithy.api#documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of \"reset_cadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of \"maintain_cadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.", + "smithy.api#jsonName": "segmentationStyle" } } }, @@ -11073,27 +11452,6 @@ "com.amazonaws.mediaconvert#M3u8Settings": { "type": "structure", "members": { - "PcrControl": { - "target": "com.amazonaws.mediaconvert#M3u8PcrControl", - "traits": { - "smithy.api#documentation": "When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", - "smithy.api#jsonName": "pcrControl" - } - }, - "PcrPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", - "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID.", - "smithy.api#jsonName": "pcrPid" - } - }, - "PatInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "patInterval" - } - }, "PmtInterval": { "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", "traits": { @@ -11108,18 +11466,32 @@ "smithy.api#jsonName": "audioFramesPerPes" } }, - "AudioPids": { - "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", + "TimedMetadataPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation.", - "smithy.api#jsonName": "audioPids" + "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream.", + "smithy.api#jsonName": "timedMetadataPid" } }, - "NielsenId3": { - "target": "com.amazonaws.mediaconvert#M3u8NielsenId3", + "PcrControl": { + "target": "com.amazonaws.mediaconvert#M3u8PcrControl", "traits": { - "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", - "smithy.api#jsonName": "nielsenId3" + "smithy.api#documentation": "When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", + "smithy.api#jsonName": "pcrControl" + } + }, + "PatInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", + "traits": { + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "patInterval" + } + }, + "PcrPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "traits": { + "smithy.api#documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID.", + "smithy.api#jsonName": "pcrPid" } }, "Scte35Source": { @@ -11129,11 +11501,11 @@ "smithy.api#jsonName": "scte35Source" } }, - "PmtPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "TransportStreamId": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.", - "smithy.api#jsonName": "pmtPid" + "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", + "smithy.api#jsonName": "transportStreamId" } }, "VideoPid": { @@ -11143,6 +11515,20 @@ "smithy.api#jsonName": "videoPid" } }, + "TimedMetadata": { + "target": "com.amazonaws.mediaconvert#TimedMetadata", + "traits": { + "smithy.api#documentation": "Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#jsonName": "timedMetadata" + } + }, + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "traits": { + "smithy.api#documentation": "The value of the program number field in the Program Map Table.", + "smithy.api#jsonName": "programNumber" + } + }, "Scte35Pid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { @@ -11150,11 +11536,11 @@ "smithy.api#jsonName": "scte35Pid" } }, - "TimedMetadata": { - "target": "com.amazonaws.mediaconvert#TimedMetadata", + "PmtPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", - "smithy.api#jsonName": "timedMetadata" + "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.", + "smithy.api#jsonName": "pmtPid" } }, "PrivateMetadataPid": { @@ -11164,25 +11550,18 @@ "smithy.api#jsonName": "privateMetadataPid" } }, - "TransportStreamId": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", - "traits": { - "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", - "smithy.api#jsonName": "transportStreamId" - } - }, - "TimedMetadataPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "AudioPids": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream.", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation.", + "smithy.api#jsonName": "audioPids" } }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "NielsenId3": { + "target": "com.amazonaws.mediaconvert#M3u8NielsenId3", "traits": { - "smithy.api#documentation": "The value of the program number field in the Program Map Table.", - "smithy.api#jsonName": "programNumber" + "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "smithy.api#jsonName": "nielsenId3" } } }, @@ -11288,20 +11667,6 @@ "com.amazonaws.mediaconvert#MotionImageInserter": { "type": "structure", "members": { - "Playback": { - "target": "com.amazonaws.mediaconvert#MotionImagePlayback", - "traits": { - "smithy.api#documentation": "Specify whether your motion graphic overlay repeats on a loop or plays only once.", - "smithy.api#jsonName": "playback" - } - }, - "Offset": { - "target": "com.amazonaws.mediaconvert#MotionImageInsertionOffset", - "traits": { - "smithy.api#documentation": "Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.", - "smithy.api#jsonName": "offset" - } - }, "Input": { "target": "com.amazonaws.mediaconvert#__stringMin14Max1285PatternS3Mov09PngHttpsMov09Png", "traits": { @@ -11309,11 +11674,11 @@ "smithy.api#jsonName": "input" } }, - "StartTime": { - "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "Offset": { + "target": "com.amazonaws.mediaconvert#MotionImageInsertionOffset", "traits": { - "smithy.api#documentation": "Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.", - "smithy.api#jsonName": "startTime" + "smithy.api#documentation": "Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.", + "smithy.api#jsonName": "offset" } }, "InsertionMode": { @@ -11329,6 +11694,20 @@ "smithy.api#documentation": "If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video.", "smithy.api#jsonName": "framerate" } + }, + "StartTime": { + "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "traits": { + "smithy.api#documentation": "Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.", + "smithy.api#jsonName": "startTime" + } + }, + "Playback": { + "target": "com.amazonaws.mediaconvert#MotionImagePlayback", + "traits": { + "smithy.api#documentation": "Specify whether your motion graphic overlay repeats on a loop or plays only once.", + "smithy.api#jsonName": "playback" + } } }, "traits": { @@ -11338,19 +11717,19 @@ "com.amazonaws.mediaconvert#MotionImageInsertionFramerate": { "type": "structure", "members": { - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483640", - "traits": { - "smithy.api#documentation": "The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 24.", - "smithy.api#jsonName": "framerateNumerator" - } - }, "FramerateDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max17895697", "traits": { "smithy.api#documentation": "The bottom of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 1.", "smithy.api#jsonName": "framerateDenominator" } + }, + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483640", + "traits": { + "smithy.api#documentation": "The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 24.", + "smithy.api#jsonName": "framerateNumerator" + } } }, "traits": { @@ -11376,18 +11755,18 @@ "com.amazonaws.mediaconvert#MotionImageInsertionOffset": { "type": "structure", "members": { - "ImageY": { + "ImageX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Set the distance, in pixels, between the overlay and the top edge of the video frame.", - "smithy.api#jsonName": "imageY" + "smithy.api#documentation": "Set the distance, in pixels, between the overlay and the left edge of the video frame.", + "smithy.api#jsonName": "imageX" } }, - "ImageX": { + "ImageY": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Set the distance, in pixels, between the overlay and the left edge of the video frame.", - "smithy.api#jsonName": "imageX" + "smithy.api#documentation": "Set the distance, in pixels, between the overlay and the top edge of the video frame.", + "smithy.api#jsonName": "imageY" } } }, @@ -11462,7 +11841,7 @@ "com.amazonaws.mediaconvert#MovPaddingControl": { "type": "string", "traits": { - "smithy.api#documentation": "If set to OMNEON, inserts Omneon-compatible padding", + "smithy.api#documentation": "To make this output compatible with Omenon, keep the default value, OMNEON. Unless you need Omneon compatibility, set this value to NONE. When you keep the default value, OMNEON, MediaConvert increases the length of the edit list atom. This might cause file rejections when a recipient of the output file doesn't expct this extra padding.", "smithy.api#enum": [ { "value": "OMNEON", @@ -11494,11 +11873,11 @@ "com.amazonaws.mediaconvert#MovSettings": { "type": "structure", "members": { - "Mpeg2FourCCControl": { - "target": "com.amazonaws.mediaconvert#MovMpeg2FourCCControl", + "ClapAtom": { + "target": "com.amazonaws.mediaconvert#MovClapAtom", "traits": { - "smithy.api#documentation": "When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2.", - "smithy.api#jsonName": "mpeg2FourCCControl" + "smithy.api#documentation": "When enabled, include 'clap' atom if appropriate for the video output settings.", + "smithy.api#jsonName": "clapAtom" } }, "Reference": { @@ -11508,20 +11887,20 @@ "smithy.api#jsonName": "reference" } }, - "ClapAtom": { - "target": "com.amazonaws.mediaconvert#MovClapAtom", - "traits": { - "smithy.api#documentation": "When enabled, include 'clap' atom if appropriate for the video output settings.", - "smithy.api#jsonName": "clapAtom" - } - }, "PaddingControl": { "target": "com.amazonaws.mediaconvert#MovPaddingControl", "traits": { - "smithy.api#documentation": "If set to OMNEON, inserts Omneon-compatible padding", + "smithy.api#documentation": "To make this output compatible with Omenon, keep the default value, OMNEON. Unless you need Omneon compatibility, set this value to NONE. When you keep the default value, OMNEON, MediaConvert increases the length of the edit list atom. This might cause file rejections when a recipient of the output file doesn't expct this extra padding.", "smithy.api#jsonName": "paddingControl" } }, + "Mpeg2FourCCControl": { + "target": "com.amazonaws.mediaconvert#MovMpeg2FourCCControl", + "traits": { + "smithy.api#documentation": "When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2.", + "smithy.api#jsonName": "mpeg2FourCCControl" + } + }, "CslgAtom": { "target": "com.amazonaws.mediaconvert#MovCslgAtom", "traits": { @@ -11537,6 +11916,13 @@ "com.amazonaws.mediaconvert#Mp2Settings": { "type": "structure", "members": { + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin32000Max384000", + "traits": { + "smithy.api#documentation": "Specify the average bitrate in bits per second.", + "smithy.api#jsonName": "bitrate" + } + }, "Channels": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2", "traits": { @@ -11550,13 +11936,6 @@ "smithy.api#documentation": "Sample rate in hz.", "smithy.api#jsonName": "sampleRate" } - }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin32000Max384000", - "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second.", - "smithy.api#jsonName": "bitrate" - } } }, "traits": { @@ -11582,6 +11961,13 @@ "com.amazonaws.mediaconvert#Mp3Settings": { "type": "structure", "members": { + "Channels": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2", + "traits": { + "smithy.api#documentation": "Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output channel; choosing Stereo gives you 2. In the API, valid values are 1 and 2.", + "smithy.api#jsonName": "channels" + } + }, "RateControlMode": { "target": "com.amazonaws.mediaconvert#Mp3RateControlMode", "traits": { @@ -11609,13 +11995,6 @@ "smithy.api#documentation": "Specify the average bitrate in bits per second.", "smithy.api#jsonName": "bitrate" } - }, - "Channels": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2", - "traits": { - "smithy.api#documentation": "Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output channel; choosing Stereo gives you 2. In the API, valid values are 1 and 2.", - "smithy.api#jsonName": "channels" - } } }, "traits": { @@ -11673,6 +12052,13 @@ "com.amazonaws.mediaconvert#Mp4Settings": { "type": "structure", "members": { + "CttsVersion": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1", + "traits": { + "smithy.api#documentation": "Ignore this setting unless compliance to the CTTS box version specification matters in your workflow. Specify a value of 1 to set your CTTS box version to 1 and make your output compliant with the specification. When you specify a value of 1, you must also set CSLG atom (cslgAtom) to the value INCLUDE. Keep the default value 0 to set your CTTS box version to 0. This can provide backward compatibility for some players and packagers.", + "smithy.api#jsonName": "cttsVersion" + } + }, "FreeSpaceBox": { "target": "com.amazonaws.mediaconvert#Mp4FreeSpaceBox", "traits": { @@ -11680,32 +12066,25 @@ "smithy.api#jsonName": "freeSpaceBox" } }, - "MoovPlacement": { - "target": "com.amazonaws.mediaconvert#Mp4MoovPlacement", - "traits": { - "smithy.api#documentation": "If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end.", - "smithy.api#jsonName": "moovPlacement" - } - }, - "CslgAtom": { - "target": "com.amazonaws.mediaconvert#Mp4CslgAtom", + "Mp4MajorBrand": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", - "smithy.api#jsonName": "cslgAtom" + "smithy.api#documentation": "Overrides the \"Major Brand\" field in the output file. Usually not necessary to specify.", + "smithy.api#jsonName": "mp4MajorBrand" } }, - "Mp4MajorBrand": { - "target": "com.amazonaws.mediaconvert#__string", + "MoovPlacement": { + "target": "com.amazonaws.mediaconvert#Mp4MoovPlacement", "traits": { - "smithy.api#documentation": "Overrides the \"Major Brand\" field in the output file. Usually not necessary to specify.", - "smithy.api#jsonName": "mp4MajorBrand" + "smithy.api#documentation": "If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end.", + "smithy.api#jsonName": "moovPlacement" } }, - "CttsVersion": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1", + "CslgAtom": { + "target": "com.amazonaws.mediaconvert#Mp4CslgAtom", "traits": { - "smithy.api#documentation": "Ignore this setting unless compliance to the CTTS box version specification matters in your workflow. Specify a value of 1 to set your CTTS box version to 1 and make your output compliant with the specification. When you specify a value of 1, you must also set CSLG atom (cslgAtom) to the value INCLUDE. Keep the default value 0 to set your CTTS box version to 0. This can provide backward compatibility for some players and packagers.", - "smithy.api#jsonName": "cttsVersion" + "smithy.api#documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", + "smithy.api#jsonName": "cslgAtom" } } }, @@ -11771,19 +12150,19 @@ "smithy.api#jsonName": "captionContainerType" } }, - "Scte35Source": { - "target": "com.amazonaws.mediaconvert#MpdScte35Source", - "traits": { - "smithy.api#documentation": "Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.", - "smithy.api#jsonName": "scte35Source" - } - }, "Scte35Esam": { "target": "com.amazonaws.mediaconvert#MpdScte35Esam", "traits": { "smithy.api#documentation": "Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).", "smithy.api#jsonName": "scte35Esam" } + }, + "Scte35Source": { + "target": "com.amazonaws.mediaconvert#MpdScte35Source", + "traits": { + "smithy.api#documentation": "Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.", + "smithy.api#jsonName": "scte35Source" + } } }, "traits": { @@ -11793,7 +12172,7 @@ "com.amazonaws.mediaconvert#Mpeg2AdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", "smithy.api#enum": [ { "value": "OFF", @@ -11893,7 +12272,7 @@ "com.amazonaws.mediaconvert#Mpeg2FramerateConversionAlgorithm": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#enum": [ { "value": "DUPLICATE_DROP", @@ -11902,6 +12281,10 @@ { "value": "INTERPOLATE", "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" } ] } @@ -11925,7 +12308,7 @@ "com.amazonaws.mediaconvert#Mpeg2InterlaceMode": { "type": "string", "traits": { - "smithy.api#documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", "smithy.api#enum": [ { "value": "PROGRESSIVE", @@ -12045,67 +12428,74 @@ "com.amazonaws.mediaconvert#Mpeg2Settings": { "type": "structure", "members": { - "Telecine": { - "target": "com.amazonaws.mediaconvert#Mpeg2Telecine", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.", - "smithy.api#jsonName": "telecine" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, - "Softness": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max128", + "SpatialAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Mpeg2SpatialAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.", - "smithy.api#jsonName": "softness" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#jsonName": "spatialAdaptiveQuantization" } }, - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "GopClosedCadence": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "CodecProfile": { - "target": "com.amazonaws.mediaconvert#Mpeg2CodecProfile", + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max1001", "traits": { - "smithy.api#documentation": "Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.", - "smithy.api#jsonName": "codecProfile" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Mpeg2FramerateConversionAlgorithm", + "AdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Mpeg2AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "InterlaceMode": { - "target": "com.amazonaws.mediaconvert#Mpeg2InterlaceMode", + "Syntax": { + "target": "com.amazonaws.mediaconvert#Mpeg2Syntax", "traits": { - "smithy.api#documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", - "smithy.api#jsonName": "interlaceMode" + "smithy.api#documentation": "Specify whether this output's video uses the D10 syntax. Keep the default value to not use the syntax. Related settings: When you choose D10 (D_10) for your MXF profile (profile), you must also set this value to to D10 (D_10).", + "smithy.api#jsonName": "syntax" } }, - "GopSize": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "ParControl": { + "target": "com.amazonaws.mediaconvert#Mpeg2ParControl", "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", + "smithy.api#jsonName": "parControl" } }, - "MinIInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max30", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, - "MaxBitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max300000000", + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#Mpeg2RateControlMode", "traits": { - "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).", + "smithy.api#jsonName": "rateControlMode" + } + }, + "DynamicSubGop": { + "target": "com.amazonaws.mediaconvert#Mpeg2DynamicSubGop", + "traits": { + "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "smithy.api#jsonName": "dynamicSubGop" } }, "SceneChangeDetect": { @@ -12115,11 +12505,11 @@ "smithy.api#jsonName": "sceneChangeDetect" } }, - "GopSizeUnits": { - "target": "com.amazonaws.mediaconvert#Mpeg2GopSizeUnits", + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#Mpeg2QualityTuningLevel", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" } }, "FramerateControl": { @@ -12129,95 +12519,88 @@ "smithy.api#jsonName": "framerateControl" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max288000000", - "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" - } - }, - "CodecLevel": { - "target": "com.amazonaws.mediaconvert#Mpeg2CodecLevel", + "TemporalAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Mpeg2TemporalAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.", - "smithy.api#jsonName": "codecLevel" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#jsonName": "temporalAdaptiveQuantization" } }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#Mpeg2RateControlMode", + "MinIInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "SpatialAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Mpeg2SpatialAdaptiveQuantization", + "GopSize": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", - "smithy.api#jsonName": "spatialAdaptiveQuantization" + "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", + "smithy.api#jsonName": "gopSize" } }, - "GopClosedCadence": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "Softness": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max128", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "Ignore this setting unless you need to comply with a specification that requires a specific value. If you don't have a specification requirement, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, to use the AWS Elemental default matrices. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video.", + "smithy.api#jsonName": "softness" } }, - "ParControl": { - "target": "com.amazonaws.mediaconvert#Mpeg2ParControl", + "CodecLevel": { + "target": "com.amazonaws.mediaconvert#Mpeg2CodecLevel", "traits": { - "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", - "smithy.api#jsonName": "parControl" + "smithy.api#documentation": "Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.", + "smithy.api#jsonName": "codecLevel" } }, - "IntraDcPrecision": { - "target": "com.amazonaws.mediaconvert#Mpeg2IntraDcPrecision", + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.", - "smithy.api#jsonName": "intraDcPrecision" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, - "Syntax": { - "target": "com.amazonaws.mediaconvert#Mpeg2Syntax", + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#Mpeg2CodecProfile", "traits": { - "smithy.api#documentation": "Produces a Type D-10 compatible bitstream (SMPTE 356M-2001).", - "smithy.api#jsonName": "syntax" + "smithy.api#documentation": "Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.", + "smithy.api#jsonName": "codecProfile" } }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", + "Telecine": { + "target": "com.amazonaws.mediaconvert#Mpeg2Telecine", "traits": { - "smithy.api#documentation": "Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" } }, - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max7", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max288000000", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" } }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", + "GopSizeUnits": { + "target": "com.amazonaws.mediaconvert#Mpeg2GopSizeUnits", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max1001", + "SlowPal": { + "target": "com.amazonaws.mediaconvert#Mpeg2SlowPal", "traits": { - "smithy.api#documentation": "Frame rate denominator.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Mpeg2AdaptiveQuantization", + "HrdBufferInitialFillPercentage": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "hrdBufferInitialFillPercentage" } }, "ParNumerator": { @@ -12227,39 +12610,39 @@ "smithy.api#jsonName": "parNumerator" } }, - "HrdBufferInitialFillPercentage": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "hrdBufferInitialFillPercentage" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } }, - "SlowPal": { - "target": "com.amazonaws.mediaconvert#Mpeg2SlowPal", + "MaxBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max300000000", "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", - "smithy.api#jsonName": "slowPal" + "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000.", + "smithy.api#jsonName": "maxBitrate" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#Mpeg2QualityTuningLevel", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Mpeg2FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "TemporalAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Mpeg2TemporalAdaptiveQuantization", + "IntraDcPrecision": { + "target": "com.amazonaws.mediaconvert#Mpeg2IntraDcPrecision", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", - "smithy.api#jsonName": "temporalAdaptiveQuantization" + "smithy.api#documentation": "Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.", + "smithy.api#jsonName": "intraDcPrecision" } }, - "DynamicSubGop": { - "target": "com.amazonaws.mediaconvert#Mpeg2DynamicSubGop", + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#Mpeg2InterlaceMode", "traits": { - "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", - "smithy.api#jsonName": "dynamicSubGop" + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" } } }, @@ -12270,7 +12653,7 @@ "com.amazonaws.mediaconvert#Mpeg2SlowPal": { "type": "string", "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", "smithy.api#enum": [ { "value": "DISABLED", @@ -12286,7 +12669,7 @@ "com.amazonaws.mediaconvert#Mpeg2SpatialAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", "smithy.api#enum": [ { "value": "DISABLED", @@ -12302,7 +12685,7 @@ "com.amazonaws.mediaconvert#Mpeg2Syntax": { "type": "string", "traits": { - "smithy.api#documentation": "Produces a Type D-10 compatible bitstream (SMPTE 356M-2001).", + "smithy.api#documentation": "Specify whether this output's video uses the D10 syntax. Keep the default value to not use the syntax. Related settings: When you choose D10 (D_10) for your MXF profile (profile), you must also set this value to to D10 (D_10).", "smithy.api#enum": [ { "value": "DEFAULT", @@ -12318,7 +12701,7 @@ "com.amazonaws.mediaconvert#Mpeg2Telecine": { "type": "string", "traits": { - "smithy.api#documentation": "Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.", + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", "smithy.api#enum": [ { "value": "NONE", @@ -12338,7 +12721,7 @@ "com.amazonaws.mediaconvert#Mpeg2TemporalAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", "smithy.api#enum": [ { "value": "DISABLED", @@ -12407,25 +12790,18 @@ "com.amazonaws.mediaconvert#MsSmoothGroupSettings": { "type": "structure", "members": { - "FragmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate.", - "smithy.api#jsonName": "fragmentLength" - } - }, - "Encryption": { - "target": "com.amazonaws.mediaconvert#MsSmoothEncryptionSettings", + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", "traits": { - "smithy.api#documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.", - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } - }, - "ManifestEncoding": { - "target": "com.amazonaws.mediaconvert#MsSmoothManifestEncoding", + }, + "FragmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.", - "smithy.api#jsonName": "manifestEncoding" + "smithy.api#documentation": "Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate.", + "smithy.api#jsonName": "fragmentLength" } }, "AdditionalManifests": { @@ -12435,11 +12811,11 @@ "smithy.api#jsonName": "additionalManifests" } }, - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", + "Destination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" + "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", + "smithy.api#jsonName": "destination" } }, "AudioDeduplication": { @@ -12449,11 +12825,18 @@ "smithy.api#jsonName": "audioDeduplication" } }, - "Destination": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "ManifestEncoding": { + "target": "com.amazonaws.mediaconvert#MsSmoothManifestEncoding", "traits": { - "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", - "smithy.api#jsonName": "destination" + "smithy.api#documentation": "Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.", + "smithy.api#jsonName": "manifestEncoding" + } + }, + "Encryption": { + "target": "com.amazonaws.mediaconvert#MsSmoothEncryptionSettings", + "traits": { + "smithy.api#documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.", + "smithy.api#jsonName": "encryption" } } }, @@ -12493,6 +12876,26 @@ ] } }, + "com.amazonaws.mediaconvert#MxfProfile": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the MXF profile, also called shim, for this output. When you choose Auto, MediaConvert chooses a profile based on the video codec and resolution. For a list of codecs supported with each MXF profile, see https://docs.aws.amazon.com/mediaconvert/latest/ug/codecs-supported-with-each-mxf-profile.html. For more information about the automatic selection behavior, see https://docs.aws.amazon.com/mediaconvert/latest/ug/default-automatic-selection-of-mxf-profiles.html.", + "smithy.api#enum": [ + { + "value": "D_10", + "name": "D_10" + }, + { + "value": "XDCAM", + "name": "XDCAM" + }, + { + "value": "OP1A", + "name": "OP1A" + } + ] + } + }, "com.amazonaws.mediaconvert#MxfSettings": { "type": "structure", "members": { @@ -12502,6 +12905,13 @@ "smithy.api#documentation": "Optional. When you have AFD signaling set up in your output video stream, use this setting to choose whether to also include it in the MXF wrapper. Choose Don't copy (NO_COPY) to exclude AFD signaling from the MXF wrapper. Choose Copy from video stream (COPY_FROM_VIDEO) to copy the AFD values from the video stream for this output to the MXF wrapper. Regardless of which option you choose, the AFD values remain in the video stream. Related settings: To set up your output to include or exclude AFD values, see AfdSignaling, under VideoDescription. On the console, find AFD signaling under the output's video encoding settings.", "smithy.api#jsonName": "afdSignaling" } + }, + "Profile": { + "target": "com.amazonaws.mediaconvert#MxfProfile", + "traits": { + "smithy.api#documentation": "Specify the MXF profile, also called shim, for this output. When you choose Auto, MediaConvert chooses a profile based on the video codec and resolution. For a list of codecs supported with each MXF profile, see https://docs.aws.amazon.com/mediaconvert/latest/ug/codecs-supported-with-each-mxf-profile.html. For more information about the automatic selection behavior, see https://docs.aws.amazon.com/mediaconvert/latest/ug/default-automatic-selection-of-mxf-profiles.html.", + "smithy.api#jsonName": "profile" + } } }, "traits": { @@ -12511,13 +12921,6 @@ "com.amazonaws.mediaconvert#NexGuardFileMarkerSettings": { "type": "structure", "members": { - "Strength": { - "target": "com.amazonaws.mediaconvert#WatermarkingStrength", - "traits": { - "smithy.api#documentation": "Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.", - "smithy.api#jsonName": "strength" - } - }, "Preset": { "target": "com.amazonaws.mediaconvert#__stringMin1Max256", "traits": { @@ -12525,51 +12928,195 @@ "smithy.api#jsonName": "preset" } }, - "Payload": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max4194303", - "traits": { - "smithy.api#documentation": "Specify the payload ID that you want associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. Required when you include Nagra NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job. For PreRelease Content (NGPR/G2), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of which ID you have assigned to each asset. Neither Nagra nor MediaConvert keep track of the relationship between output files and your IDs. For OTT Streaming, create two adaptive bitrate (ABR) stacks for each asset. Do this by setting up two output groups. For one output group, set the value of Payload ID (payload) to 0 in every output. For the other output group, set Payload ID (payload) to 1 in every output.", - "smithy.api#jsonName": "payload" - } - }, "License": { "target": "com.amazonaws.mediaconvert#__stringMin1Max100000", "traits": { "smithy.api#documentation": "Use the base64 license string that Nagra provides you. Enter it directly in your JSON job specification or in the console. Required when you include Nagra NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job.", "smithy.api#jsonName": "license" } + }, + "Strength": { + "target": "com.amazonaws.mediaconvert#WatermarkingStrength", + "traits": { + "smithy.api#documentation": "Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.", + "smithy.api#jsonName": "strength" + } + }, + "Payload": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max4194303", + "traits": { + "smithy.api#documentation": "Specify the payload ID that you want associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. Required when you include Nagra NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job. For PreRelease Content (NGPR/G2), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of which ID you have assigned to each asset. Neither Nagra nor MediaConvert keep track of the relationship between output files and your IDs. For OTT Streaming, create two adaptive bitrate (ABR) stacks for each asset. Do this by setting up two output groups. For one output group, set the value of Payload ID (payload) to 0 in every output. For the other output group, set Payload ID (payload) to 1 in every output.", + "smithy.api#jsonName": "payload" + } } }, "traits": { "smithy.api#documentation": "For forensic video watermarking, MediaConvert supports Nagra NexGuard File Marker watermarking. MediaConvert supports both PreRelease Content (NGPR/G2) and OTT Streaming workflows." } }, + "com.amazonaws.mediaconvert#NielsenActiveWatermarkProcessType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.", + "smithy.api#enum": [ + { + "value": "NAES2_AND_NW", + "name": "NAES2_AND_NW" + }, + { + "value": "CBET", + "name": "CBET" + }, + { + "value": "NAES2_AND_NW_AND_CBET", + "name": "NAES2_AND_NW_AND_CBET" + } + ] + } + }, "com.amazonaws.mediaconvert#NielsenConfiguration": { "type": "structure", "members": { + "DistributorId": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen.", + "smithy.api#jsonName": "distributorId" + } + }, "BreakoutCode": { "target": "com.amazonaws.mediaconvert#__integerMin0Max0", "traits": { "smithy.api#documentation": "Nielsen has discontinued the use of breakout code functionality. If you must include this property, set the value to zero.", "smithy.api#jsonName": "breakoutCode" } + } + }, + "traits": { + "smithy.api#documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting." + } + }, + "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings": { + "type": "structure", + "members": { + "TicServerUrl": { + "target": "com.amazonaws.mediaconvert#__stringPatternHttps", + "traits": { + "smithy.api#documentation": "Specify the endpoint for the TIC server that you have deployed and configured in the AWS Cloud. Required for all Nielsen non-linear watermarking. MediaConvert can't connect directly to a TIC server. Instead, you must use API Gateway to provide a RESTful interface between MediaConvert and a TIC server that you deploy in your AWS account. For more information on deploying a TIC server in your AWS account and the required API Gateway, contact Nielsen support.", + "smithy.api#jsonName": "ticServerUrl" + } }, - "DistributorId": { - "target": "com.amazonaws.mediaconvert#__string", + "SourceId": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65534", "traits": { - "smithy.api#documentation": "Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen.", - "smithy.api#jsonName": "distributorId" + "smithy.api#documentation": "Use the SID that Nielsen provides to you. This source ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking. This ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking.", + "smithy.api#jsonName": "sourceId" + } + }, + "UniqueTicPerAudioTrack": { + "target": "com.amazonaws.mediaconvert#NielsenUniqueTicPerAudioTrackType", + "traits": { + "smithy.api#documentation": "To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).", + "smithy.api#jsonName": "uniqueTicPerAudioTrack" + } + }, + "CbetSourceId": { + "target": "com.amazonaws.mediaconvert#__stringPattern0xAFaF0908190908", + "traits": { + "smithy.api#documentation": "Use the CSID that Nielsen provides to you. This CBET source ID should be unique to your Nielsen account but common to all of your output assets that have CBET watermarking. Required when you choose a value for the setting Watermark types (ActiveWatermarkProcess) that includes CBET.", + "smithy.api#jsonName": "cbetSourceId" + } + }, + "EpisodeId": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max20", + "traits": { + "smithy.api#documentation": "Optional. If this asset uses an episode ID with Nielsen, provide it here.", + "smithy.api#jsonName": "episodeId" + } + }, + "ActiveWatermarkProcess": { + "target": "com.amazonaws.mediaconvert#NielsenActiveWatermarkProcessType", + "traits": { + "smithy.api#documentation": "Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.", + "smithy.api#jsonName": "activeWatermarkProcess" + } + }, + "AdiFilename": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "traits": { + "smithy.api#documentation": "Optional. Use this setting when you want the service to include an ADI file in the Nielsen metadata .zip file. To provide an ADI file, store it in Amazon S3 and provide a URL to it here. The URL should be in the following format: S3://bucket/path/ADI-file. For more information about the metadata .zip file, see the setting Metadata destination (metadataDestination).", + "smithy.api#jsonName": "adiFilename" + } + }, + "SourceWatermarkStatus": { + "target": "com.amazonaws.mediaconvert#NielsenSourceWatermarkStatusType", + "traits": { + "smithy.api#documentation": "Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to Watermarked (WATERMARKED), the service fails the job. Nielsen requires that you add non-linear watermarking to only clean content that doesn't already have non-linear Nielsen watermarks.", + "smithy.api#jsonName": "sourceWatermarkStatus" + } + }, + "MetadataDestination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "traits": { + "smithy.api#documentation": "Specify the Amazon S3 location where you want MediaConvert to save your Nielsen non-linear metadata .zip file. This Amazon S3 bucket must be in the same Region as the one where you do your MediaConvert transcoding. If you want to include an ADI file in this .zip file, use the setting ADI file (adiFilename) to specify it. MediaConvert delivers the Nielsen metadata .zip files only to your metadata destination Amazon S3 bucket. It doesn't deliver the .zip files to Nielsen. You are responsible for delivering the metadata .zip files to Nielsen.", + "smithy.api#jsonName": "metadataDestination" + } + }, + "AssetName": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max50", + "traits": { + "smithy.api#documentation": "Use the asset name that you provide to Nielsen for this asset. Required for all Nielsen non-linear watermarking.", + "smithy.api#jsonName": "assetName" + } + }, + "AssetId": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max20", + "traits": { + "smithy.api#documentation": "Use the asset ID that you provide to Nielsen to uniquely identify this asset. Required for all Nielsen non-linear watermarking.", + "smithy.api#jsonName": "assetId" } } }, "traits": { - "smithy.api#documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting." + "smithy.api#documentation": "Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]" + } + }, + "com.amazonaws.mediaconvert#NielsenSourceWatermarkStatusType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to Watermarked (WATERMARKED), the service fails the job. Nielsen requires that you add non-linear watermarking to only clean content that doesn't already have non-linear Nielsen watermarks.", + "smithy.api#enum": [ + { + "value": "CLEAN", + "name": "CLEAN" + }, + { + "value": "WATERMARKED", + "name": "WATERMARKED" + } + ] + } + }, + "com.amazonaws.mediaconvert#NielsenUniqueTicPerAudioTrackType": { + "type": "string", + "traits": { + "smithy.api#documentation": "To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).", + "smithy.api#enum": [ + { + "value": "RESERVE_UNIQUE_TICS_PER_TRACK", + "name": "RESERVE_UNIQUE_TICS_PER_TRACK" + }, + { + "value": "SAME_TICS_PER_TRACK", + "name": "SAME_TICS_PER_TRACK" + } + ] } }, "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can optionally use this setting to apply additional sharpening. The default behavior, Auto (AUTO) allows the transcoder to determine whether to apply filtering, depending on input type and quality.", + "smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can use this setting to apply sharpening. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply filtering, depending on input type and quality. When you set Noise reducer to Temporal, your output bandwidth is reduced. When Post temporal sharpening is also enabled, that bandwidth reduction is smaller.", "smithy.api#enum": [ { "value": "DISABLED", @@ -12589,11 +13136,11 @@ "com.amazonaws.mediaconvert#NoiseReducer": { "type": "structure", "members": { - "TemporalFilterSettings": { - "target": "com.amazonaws.mediaconvert#NoiseReducerTemporalFilterSettings", + "SpatialFilterSettings": { + "target": "com.amazonaws.mediaconvert#NoiseReducerSpatialFilterSettings", "traits": { - "smithy.api#documentation": "Noise reducer filter settings for temporal filter.", - "smithy.api#jsonName": "temporalFilterSettings" + "smithy.api#documentation": "Noise reducer filter settings for spatial filter.", + "smithy.api#jsonName": "spatialFilterSettings" } }, "Filter": { @@ -12603,19 +13150,19 @@ "smithy.api#jsonName": "filter" } }, - "SpatialFilterSettings": { - "target": "com.amazonaws.mediaconvert#NoiseReducerSpatialFilterSettings", - "traits": { - "smithy.api#documentation": "Noise reducer filter settings for spatial filter.", - "smithy.api#jsonName": "spatialFilterSettings" - } - }, "FilterSettings": { "target": "com.amazonaws.mediaconvert#NoiseReducerFilterSettings", "traits": { "smithy.api#documentation": "Settings for a noise reducer filter", "smithy.api#jsonName": "filterSettings" } + }, + "TemporalFilterSettings": { + "target": "com.amazonaws.mediaconvert#NoiseReducerTemporalFilterSettings", + "traits": { + "smithy.api#documentation": "Noise reducer filter settings for temporal filter.", + "smithy.api#jsonName": "temporalFilterSettings" + } } }, "traits": { @@ -12687,19 +13234,19 @@ "smithy.api#jsonName": "postFilterSharpenStrength" } }, - "Speed": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2Max3", - "traits": { - "smithy.api#documentation": "The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value.", - "smithy.api#jsonName": "speed" - } - }, "Strength": { "target": "com.amazonaws.mediaconvert#__integerMin0Max16", "traits": { "smithy.api#documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering.", "smithy.api#jsonName": "strength" } + }, + "Speed": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2Max3", + "traits": { + "smithy.api#documentation": "The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value.", + "smithy.api#jsonName": "speed" + } } }, "traits": { @@ -12709,6 +13256,13 @@ "com.amazonaws.mediaconvert#NoiseReducerTemporalFilterSettings": { "type": "structure", "members": { + "Speed": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max3", + "traits": { + "smithy.api#documentation": "The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate.", + "smithy.api#jsonName": "speed" + } + }, "AggressiveMode": { "target": "com.amazonaws.mediaconvert#__integerMin0Max4", "traits": { @@ -12723,17 +13277,10 @@ "smithy.api#jsonName": "strength" } }, - "Speed": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max3", - "traits": { - "smithy.api#documentation": "The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate.", - "smithy.api#jsonName": "speed" - } - }, "PostTemporalSharpening": { "target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening", "traits": { - "smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can optionally use this setting to apply additional sharpening. The default behavior, Auto (AUTO) allows the transcoder to determine whether to apply filtering, depending on input type and quality.", + "smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can use this setting to apply sharpening. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply filtering, depending on input type and quality. When you set Noise reducer to Temporal, your output bandwidth is reduced. When Post temporal sharpening is also enabled, that bandwidth reduction is smaller.", "smithy.api#jsonName": "postTemporalSharpening" } } @@ -12806,11 +13353,11 @@ "com.amazonaws.mediaconvert#Output": { "type": "structure", "members": { - "Preset": { - "target": "com.amazonaws.mediaconvert#__stringMin0", + "VideoDescription": { + "target": "com.amazonaws.mediaconvert#VideoDescription", "traits": { - "smithy.api#documentation": "Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both.", - "smithy.api#jsonName": "preset" + "smithy.api#documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output.", + "smithy.api#jsonName": "videoDescription" } }, "CaptionDescriptions": { @@ -12820,6 +13367,13 @@ "smithy.api#jsonName": "captionDescriptions" } }, + "Extension": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)", + "smithy.api#jsonName": "extension" + } + }, "ContainerSettings": { "target": "com.amazonaws.mediaconvert#ContainerSettings", "traits": { @@ -12827,6 +13381,13 @@ "smithy.api#jsonName": "containerSettings" } }, + "AudioDescriptions": { + "target": "com.amazonaws.mediaconvert#__listOfAudioDescription", + "traits": { + "smithy.api#documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.", + "smithy.api#jsonName": "audioDescriptions" + } + }, "OutputSettings": { "target": "com.amazonaws.mediaconvert#OutputSettings", "traits": { @@ -12841,25 +13402,11 @@ "smithy.api#jsonName": "nameModifier" } }, - "Extension": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)", - "smithy.api#jsonName": "extension" - } - }, - "VideoDescription": { - "target": "com.amazonaws.mediaconvert#VideoDescription", - "traits": { - "smithy.api#documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output.", - "smithy.api#jsonName": "videoDescription" - } - }, - "AudioDescriptions": { - "target": "com.amazonaws.mediaconvert#__listOfAudioDescription", + "Preset": { + "target": "com.amazonaws.mediaconvert#__stringMin0", "traits": { - "smithy.api#documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.", - "smithy.api#jsonName": "audioDescriptions" + "smithy.api#documentation": "Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both.", + "smithy.api#jsonName": "preset" } } }, @@ -12885,19 +13432,19 @@ "com.amazonaws.mediaconvert#OutputDetail": { "type": "structure", "members": { - "VideoDetails": { - "target": "com.amazonaws.mediaconvert#VideoDetail", - "traits": { - "smithy.api#documentation": "Contains details about the output's video stream", - "smithy.api#jsonName": "videoDetails" - } - }, "DurationInMs": { "target": "com.amazonaws.mediaconvert#__integer", "traits": { "smithy.api#documentation": "Duration in milliseconds", "smithy.api#jsonName": "durationInMs" } + }, + "VideoDetails": { + "target": "com.amazonaws.mediaconvert#VideoDetail", + "traits": { + "smithy.api#documentation": "Contains details about the output's video stream", + "smithy.api#jsonName": "videoDetails" + } } }, "traits": { @@ -12907,11 +13454,11 @@ "com.amazonaws.mediaconvert#OutputGroup": { "type": "structure", "members": { - "OutputGroupSettings": { - "target": "com.amazonaws.mediaconvert#OutputGroupSettings", + "Outputs": { + "target": "com.amazonaws.mediaconvert#__listOfOutput", "traits": { - "smithy.api#documentation": "Output Group settings, including type", - "smithy.api#jsonName": "outputGroupSettings" + "smithy.api#documentation": "This object holds groups of encoding settings, one group of settings per output.", + "smithy.api#jsonName": "outputs" } }, "CustomName": { @@ -12921,19 +13468,19 @@ "smithy.api#jsonName": "customName" } }, + "OutputGroupSettings": { + "target": "com.amazonaws.mediaconvert#OutputGroupSettings", + "traits": { + "smithy.api#documentation": "Output Group settings, including type", + "smithy.api#jsonName": "outputGroupSettings" + } + }, "Name": { "target": "com.amazonaws.mediaconvert#__string", "traits": { "smithy.api#documentation": "Name of the output group", "smithy.api#jsonName": "name" } - }, - "Outputs": { - "target": "com.amazonaws.mediaconvert#__listOfOutput", - "traits": { - "smithy.api#documentation": "This object holds groups of encoding settings, one group of settings per output.", - "smithy.api#jsonName": "outputs" - } } }, "traits": { @@ -12965,11 +13512,11 @@ "smithy.api#jsonName": "type" } }, - "HlsGroupSettings": { - "target": "com.amazonaws.mediaconvert#HlsGroupSettings", + "CmafGroupSettings": { + "target": "com.amazonaws.mediaconvert#CmafGroupSettings", "traits": { - "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.", - "smithy.api#jsonName": "hlsGroupSettings" + "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.", + "smithy.api#jsonName": "cmafGroupSettings" } }, "FileGroupSettings": { @@ -12979,6 +13526,13 @@ "smithy.api#jsonName": "fileGroupSettings" } }, + "HlsGroupSettings": { + "target": "com.amazonaws.mediaconvert#HlsGroupSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.", + "smithy.api#jsonName": "hlsGroupSettings" + } + }, "DashIsoGroupSettings": { "target": "com.amazonaws.mediaconvert#DashIsoGroupSettings", "traits": { @@ -12992,13 +13546,6 @@ "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS.", "smithy.api#jsonName": "msSmoothGroupSettings" } - }, - "CmafGroupSettings": { - "target": "com.amazonaws.mediaconvert#CmafGroupSettings", - "traits": { - "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.", - "smithy.api#jsonName": "cmafGroupSettings" - } } }, "traits": { @@ -13090,6 +13637,13 @@ "com.amazonaws.mediaconvert#Preset": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", + "smithy.api#jsonName": "arn" + } + }, "LastUpdated": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -13113,6 +13667,13 @@ "smithy.api#required": {} } }, + "Type": { + "target": "com.amazonaws.mediaconvert#Type", + "traits": { + "smithy.api#documentation": "A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user.", + "smithy.api#jsonName": "type" + } + }, "CreatedAt": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -13133,20 +13694,6 @@ "smithy.api#documentation": "An optional category you create to organize your presets.", "smithy.api#jsonName": "category" } - }, - "Type": { - "target": "com.amazonaws.mediaconvert#Type", - "traits": { - "smithy.api#documentation": "A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user.", - "smithy.api#jsonName": "type" - } - }, - "Arn": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", - "smithy.api#jsonName": "arn" - } } }, "traits": { @@ -13176,11 +13723,11 @@ "com.amazonaws.mediaconvert#PresetSettings": { "type": "structure", "members": { - "CaptionDescriptions": { - "target": "com.amazonaws.mediaconvert#__listOfCaptionDescriptionPreset", + "AudioDescriptions": { + "target": "com.amazonaws.mediaconvert#__listOfAudioDescription", "traits": { - "smithy.api#documentation": "Caption settings for this preset. There can be multiple caption settings in a single output.", - "smithy.api#jsonName": "captionDescriptions" + "smithy.api#documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.", + "smithy.api#jsonName": "audioDescriptions" } }, "VideoDescription": { @@ -13190,19 +13737,19 @@ "smithy.api#jsonName": "videoDescription" } }, - "AudioDescriptions": { - "target": "com.amazonaws.mediaconvert#__listOfAudioDescription", - "traits": { - "smithy.api#documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.", - "smithy.api#jsonName": "audioDescriptions" - } - }, "ContainerSettings": { "target": "com.amazonaws.mediaconvert#ContainerSettings", "traits": { "smithy.api#documentation": "Container specific settings.", "smithy.api#jsonName": "containerSettings" } + }, + "CaptionDescriptions": { + "target": "com.amazonaws.mediaconvert#__listOfCaptionDescriptionPreset", + "traits": { + "smithy.api#documentation": "Caption settings for this preset. There can be multiple caption settings in a single output.", + "smithy.api#jsonName": "captionDescriptions" + } } }, "traits": { @@ -13268,7 +13815,7 @@ "com.amazonaws.mediaconvert#ProresFramerateConversionAlgorithm": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#enum": [ { "value": "DUPLICATE_DROP", @@ -13277,6 +13824,10 @@ { "value": "INTERPOLATE", "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" } ] } @@ -13284,7 +13835,7 @@ "com.amazonaws.mediaconvert#ProresInterlaceMode": { "type": "string", "traits": { - "smithy.api#documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", "smithy.api#enum": [ { "value": "PROGRESSIVE", @@ -13328,60 +13879,53 @@ "com.amazonaws.mediaconvert#ProresSettings": { "type": "structure", "members": { - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "ParControl": { + "target": "com.amazonaws.mediaconvert#ProresParControl", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", + "smithy.api#jsonName": "parControl" + } + }, + "Telecine": { + "target": "com.amazonaws.mediaconvert#ProresTelecine", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" + } + }, + "SlowPal": { + "target": "com.amazonaws.mediaconvert#ProresSlowPal", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" } }, "InterlaceMode": { "target": "com.amazonaws.mediaconvert#ProresInterlaceMode", "traits": { - "smithy.api#documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", "smithy.api#jsonName": "interlaceMode" } }, - "ParNumerator": { + "ParDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, "FramerateConversionAlgorithm": { "target": "com.amazonaws.mediaconvert#ProresFramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use duplicate drop conversion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "SlowPal": { - "target": "com.amazonaws.mediaconvert#ProresSlowPal", - "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", - "smithy.api#jsonName": "slowPal" - } - }, - "FramerateNumerator": { + "FramerateDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator.", - "smithy.api#jsonName": "framerateNumerator" - } - }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#ProresTelecine", - "traits": { - "smithy.api#documentation": "Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.", - "smithy.api#jsonName": "telecine" - } - }, - "ParControl": { - "target": "com.amazonaws.mediaconvert#ProresParControl", - "traits": { - "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", - "smithy.api#jsonName": "parControl" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, "CodecProfile": { @@ -13391,19 +13935,26 @@ "smithy.api#jsonName": "codecProfile" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Frame rate denominator.", - "smithy.api#jsonName": "framerateDenominator" - } - }, "FramerateControl": { "target": "com.amazonaws.mediaconvert#ProresFramerateControl", "traits": { "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", "smithy.api#jsonName": "framerateControl" } + }, + "ParNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" + } + }, + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" + } } }, "traits": { @@ -13413,7 +13964,7 @@ "com.amazonaws.mediaconvert#ProresSlowPal": { "type": "string", "traits": { - "smithy.api#documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", "smithy.api#enum": [ { "value": "DISABLED", @@ -13429,7 +13980,7 @@ "com.amazonaws.mediaconvert#ProresTelecine": { "type": "string", "traits": { - "smithy.api#documentation": "Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.", + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", "smithy.api#enum": [ { "value": "NONE", @@ -13445,25 +13996,25 @@ "com.amazonaws.mediaconvert#Queue": { "type": "structure", "members": { - "SubmittedJobsCount": { - "target": "com.amazonaws.mediaconvert#__integer", + "Type": { + "target": "com.amazonaws.mediaconvert#Type", "traits": { - "smithy.api#documentation": "The estimated number of jobs with a SUBMITTED status.", - "smithy.api#jsonName": "submittedJobsCount" + "smithy.api#documentation": "Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.", + "smithy.api#jsonName": "type" } }, - "Description": { - "target": "com.amazonaws.mediaconvert#__string", + "Status": { + "target": "com.amazonaws.mediaconvert#QueueStatus", "traits": { - "smithy.api#documentation": "An optional description that you create for each queue.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.", + "smithy.api#jsonName": "status" } }, - "Arn": { + "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "An optional description that you create for each queue.", + "smithy.api#jsonName": "description" } }, "CreatedAt": { @@ -13473,54 +14024,54 @@ "smithy.api#jsonName": "createdAt" } }, - "Name": { - "target": "com.amazonaws.mediaconvert#__string", + "PricingPlan": { + "target": "com.amazonaws.mediaconvert#PricingPlan", "traits": { - "smithy.api#documentation": "A name that you create for each queue. Each name must be unique within your account.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.", + "smithy.api#jsonName": "pricingPlan" } }, - "ProgressingJobsCount": { - "target": "com.amazonaws.mediaconvert#__integer", + "LastUpdated": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "The estimated number of jobs with a PROGRESSING status.", - "smithy.api#jsonName": "progressingJobsCount" + "smithy.api#documentation": "The timestamp in epoch seconds for when you most recently updated the queue.", + "smithy.api#jsonName": "lastUpdated" } }, - "Type": { - "target": "com.amazonaws.mediaconvert#Type", + "ReservationPlan": { + "target": "com.amazonaws.mediaconvert#ReservationPlan", "traits": { - "smithy.api#documentation": "Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.", + "smithy.api#jsonName": "reservationPlan" } }, - "PricingPlan": { - "target": "com.amazonaws.mediaconvert#PricingPlan", + "SubmittedJobsCount": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.", - "smithy.api#jsonName": "pricingPlan" + "smithy.api#documentation": "The estimated number of jobs with a SUBMITTED status.", + "smithy.api#jsonName": "submittedJobsCount" } }, - "Status": { - "target": "com.amazonaws.mediaconvert#QueueStatus", + "Arn": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.", - "smithy.api#jsonName": "status" + "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", + "smithy.api#jsonName": "arn" } }, - "LastUpdated": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "Name": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for when you most recently updated the queue.", - "smithy.api#jsonName": "lastUpdated" + "smithy.api#documentation": "A name that you create for each queue. Each name must be unique within your account.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, - "ReservationPlan": { - "target": "com.amazonaws.mediaconvert#ReservationPlan", + "ProgressingJobsCount": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.", - "smithy.api#jsonName": "reservationPlan" + "smithy.api#documentation": "The estimated number of jobs with a PROGRESSING status.", + "smithy.api#jsonName": "progressingJobsCount" } } }, @@ -13563,13 +14114,6 @@ "com.amazonaws.mediaconvert#QueueTransition": { "type": "structure", "members": { - "DestinationQueue": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "The queue that the job was on after the transition.", - "smithy.api#jsonName": "destinationQueue" - } - }, "Timestamp": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -13583,6 +14127,13 @@ "smithy.api#documentation": "The queue that the job was on before the transition.", "smithy.api#jsonName": "sourceQueue" } + }, + "DestinationQueue": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "The queue that the job was on after the transition.", + "smithy.api#jsonName": "destinationQueue" + } } }, "traits": { @@ -13592,13 +14143,6 @@ "com.amazonaws.mediaconvert#Rectangle": { "type": "structure", "members": { - "Y": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", - "traits": { - "smithy.api#documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers.", - "smithy.api#jsonName": "y" - } - }, "X": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -13606,18 +14150,25 @@ "smithy.api#jsonName": "x" } }, - "Height": { + "Width": { "target": "com.amazonaws.mediaconvert#__integerMin2Max2147483647", "traits": { - "smithy.api#documentation": "Height of rectangle in pixels. Specify only even numbers.", - "smithy.api#jsonName": "height" + "smithy.api#documentation": "Width of rectangle in pixels. Specify only even numbers.", + "smithy.api#jsonName": "width" } }, - "Width": { + "Y": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers.", + "smithy.api#jsonName": "y" + } + }, + "Height": { "target": "com.amazonaws.mediaconvert#__integerMin2Max2147483647", "traits": { - "smithy.api#documentation": "Width of rectangle in pixels. Specify only even numbers.", - "smithy.api#jsonName": "width" + "smithy.api#documentation": "Height of rectangle in pixels. Specify only even numbers.", + "smithy.api#jsonName": "height" } } }, @@ -13628,18 +14179,18 @@ "com.amazonaws.mediaconvert#RemixSettings": { "type": "structure", "members": { - "ChannelsOut": { + "ChannelsIn": { "target": "com.amazonaws.mediaconvert#__integerMin1Max64", "traits": { - "smithy.api#documentation": "Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.)", - "smithy.api#jsonName": "channelsOut" + "smithy.api#documentation": "Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different.", + "smithy.api#jsonName": "channelsIn" } }, - "ChannelsIn": { + "ChannelsOut": { "target": "com.amazonaws.mediaconvert#__integerMin1Max64", "traits": { - "smithy.api#documentation": "Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different.", - "smithy.api#jsonName": "channelsIn" + "smithy.api#documentation": "Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.)", + "smithy.api#jsonName": "channelsOut" } }, "ChannelMapping": { @@ -13673,6 +14224,13 @@ "com.amazonaws.mediaconvert#ReservationPlan": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.mediaconvert#ReservationPlanStatus", + "traits": { + "smithy.api#documentation": "Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.", + "smithy.api#jsonName": "status" + } + }, "PurchasedAt": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -13680,25 +14238,25 @@ "smithy.api#jsonName": "purchasedAt" } }, - "Commitment": { - "target": "com.amazonaws.mediaconvert#Commitment", + "ExpiresAt": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "The length of the term of your reserved queue pricing plan commitment.", - "smithy.api#jsonName": "commitment" + "smithy.api#documentation": "The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.", + "smithy.api#jsonName": "expiresAt" } }, - "Status": { - "target": "com.amazonaws.mediaconvert#ReservationPlanStatus", + "RenewalType": { + "target": "com.amazonaws.mediaconvert#RenewalType", "traits": { - "smithy.api#documentation": "Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.", - "smithy.api#jsonName": "status" + "smithy.api#documentation": "Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.", + "smithy.api#jsonName": "renewalType" } }, - "ExpiresAt": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "Commitment": { + "target": "com.amazonaws.mediaconvert#Commitment", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.", - "smithy.api#jsonName": "expiresAt" + "smithy.api#documentation": "The length of the term of your reserved queue pricing plan commitment.", + "smithy.api#jsonName": "commitment" } }, "ReservedSlots": { @@ -13707,13 +14265,6 @@ "smithy.api#documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.", "smithy.api#jsonName": "reservedSlots" } - }, - "RenewalType": { - "target": "com.amazonaws.mediaconvert#RenewalType", - "traits": { - "smithy.api#documentation": "Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.", - "smithy.api#jsonName": "renewalType" - } } }, "traits": { @@ -13723,11 +14274,11 @@ "com.amazonaws.mediaconvert#ReservationPlanSettings": { "type": "structure", "members": { - "RenewalType": { - "target": "com.amazonaws.mediaconvert#RenewalType", + "ReservedSlots": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment.", - "smithy.api#jsonName": "renewalType", + "smithy.api#documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.", + "smithy.api#jsonName": "reservedSlots", "smithy.api#required": {} } }, @@ -13739,11 +14290,11 @@ "smithy.api#required": {} } }, - "ReservedSlots": { - "target": "com.amazonaws.mediaconvert#__integer", + "RenewalType": { + "target": "com.amazonaws.mediaconvert#RenewalType", "traits": { - "smithy.api#documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.", - "smithy.api#jsonName": "reservedSlots", + "smithy.api#documentation": "Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment.", + "smithy.api#jsonName": "renewalType", "smithy.api#required": {} } } @@ -13771,19 +14322,19 @@ "com.amazonaws.mediaconvert#ResourceTags": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.", - "smithy.api#jsonName": "arn" - } - }, "Tags": { "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { "smithy.api#documentation": "The tags for the resource.", "smithy.api#jsonName": "tags" } + }, + "Arn": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.", + "smithy.api#jsonName": "arn" + } } }, "traits": { @@ -13987,13 +14538,6 @@ "com.amazonaws.mediaconvert#SpekeKeyProvider": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.", - "smithy.api#jsonName": "resourceId" - } - }, "SystemIds": { "target": "com.amazonaws.mediaconvert#__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12", "traits": { @@ -14001,11 +14545,11 @@ "smithy.api#jsonName": "systemIds" } }, - "Url": { - "target": "com.amazonaws.mediaconvert#__stringPatternHttps", + "ResourceId": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.", + "smithy.api#jsonName": "resourceId" } }, "CertificateArn": { @@ -14014,6 +14558,13 @@ "smithy.api#documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.", "smithy.api#jsonName": "certificateArn" } + }, + "Url": { + "target": "com.amazonaws.mediaconvert#__stringPatternHttps", + "traits": { + "smithy.api#documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.", + "smithy.api#jsonName": "url" + } } }, "traits": { @@ -14023,11 +14574,11 @@ "com.amazonaws.mediaconvert#SpekeKeyProviderCmaf": { "type": "structure", "members": { - "HlsSignaledSystemIds": { - "target": "com.amazonaws.mediaconvert#__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", + "Url": { + "target": "com.amazonaws.mediaconvert#__stringPatternHttps", "traits": { - "smithy.api#documentation": "Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/.", - "smithy.api#jsonName": "hlsSignaledSystemIds" + "smithy.api#documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.", + "smithy.api#jsonName": "url" } }, "ResourceId": { @@ -14037,6 +14588,13 @@ "smithy.api#jsonName": "resourceId" } }, + "CertificateArn": { + "target": "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovAcm", + "traits": { + "smithy.api#documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.", + "smithy.api#jsonName": "certificateArn" + } + }, "DashSignaledSystemIds": { "target": "com.amazonaws.mediaconvert#__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", "traits": { @@ -14044,18 +14602,11 @@ "smithy.api#jsonName": "dashSignaledSystemIds" } }, - "Url": { - "target": "com.amazonaws.mediaconvert#__stringPatternHttps", - "traits": { - "smithy.api#documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.", - "smithy.api#jsonName": "url" - } - }, - "CertificateArn": { - "target": "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovAcm", + "HlsSignaledSystemIds": { + "target": "com.amazonaws.mediaconvert#__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", "traits": { - "smithy.api#documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.", - "smithy.api#jsonName": "certificateArn" + "smithy.api#documentation": "Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/.", + "smithy.api#jsonName": "hlsSignaledSystemIds" } } }, @@ -14066,18 +14617,11 @@ "com.amazonaws.mediaconvert#StaticKeyProvider": { "type": "structure", "members": { - "StaticKeyValue": { - "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ0932", - "traits": { - "smithy.api#documentation": "Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue).", - "smithy.api#jsonName": "staticKeyValue" - } - }, - "Url": { - "target": "com.amazonaws.mediaconvert#__string", + "KeyFormatVersions": { + "target": "com.amazonaws.mediaconvert#__stringPatternDD", "traits": { - "smithy.api#documentation": "Relates to DRM implementation. The location of the license server used for protecting content.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3).", + "smithy.api#jsonName": "keyFormatVersions" } }, "KeyFormat": { @@ -14087,11 +14631,18 @@ "smithy.api#jsonName": "keyFormat" } }, - "KeyFormatVersions": { - "target": "com.amazonaws.mediaconvert#__stringPatternDD", + "Url": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3).", - "smithy.api#jsonName": "keyFormatVersions" + "smithy.api#documentation": "Relates to DRM implementation. The location of the license server used for protecting content.", + "smithy.api#jsonName": "url" + } + }, + "StaticKeyValue": { + "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ0932", + "traits": { + "smithy.api#documentation": "Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue).", + "smithy.api#jsonName": "staticKeyValue" } } }, @@ -14304,19 +14855,19 @@ "smithy.api#jsonName": "prefix" } }, - "FontSize": { - "target": "com.amazonaws.mediaconvert#__integerMin10Max48", - "traits": { - "smithy.api#documentation": "Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48.", - "smithy.api#jsonName": "fontSize" - } - }, "Position": { "target": "com.amazonaws.mediaconvert#TimecodeBurninPosition", "traits": { "smithy.api#documentation": "Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode on output video.", "smithy.api#jsonName": "position" } + }, + "FontSize": { + "target": "com.amazonaws.mediaconvert#__integerMin10Max48", + "traits": { + "smithy.api#documentation": "Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48.", + "smithy.api#jsonName": "fontSize" + } } }, "traits": { @@ -14370,13 +14921,6 @@ "com.amazonaws.mediaconvert#TimecodeConfig": { "type": "structure", "members": { - "Source": { - "target": "com.amazonaws.mediaconvert#TimecodeSource", - "traits": { - "smithy.api#documentation": "Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value.", - "smithy.api#jsonName": "source" - } - }, "Start": { "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", "traits": { @@ -14384,6 +14928,13 @@ "smithy.api#jsonName": "start" } }, + "TimestampOffset": { + "target": "com.amazonaws.mediaconvert#__stringPattern0940191020191209301", + "traits": { + "smithy.api#documentation": "Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format \"yyyy-mm-dd\". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25.", + "smithy.api#jsonName": "timestampOffset" + } + }, "Anchor": { "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", "traits": { @@ -14391,11 +14942,11 @@ "smithy.api#jsonName": "anchor" } }, - "TimestampOffset": { - "target": "com.amazonaws.mediaconvert#__stringPattern0940191020191209301", + "Source": { + "target": "com.amazonaws.mediaconvert#TimecodeSource", "traits": { - "smithy.api#documentation": "Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format \"yyyy-mm-dd\". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25.", - "smithy.api#jsonName": "timestampOffset" + "smithy.api#documentation": "Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value.", + "smithy.api#jsonName": "source" } } }, @@ -14451,19 +15002,12 @@ } }, "traits": { - "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects." + "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects." } }, "com.amazonaws.mediaconvert#Timing": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time, in Unix epoch format, that transcoding for the job began.", - "smithy.api#jsonName": "startTime" - } - }, "SubmitTime": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -14474,8 +15018,15 @@ "FinishTime": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "The time, in Unix epoch format, that the transcoding job finished", - "smithy.api#jsonName": "finishTime" + "smithy.api#documentation": "The time, in Unix epoch format, that the transcoding job finished", + "smithy.api#jsonName": "finishTime" + } + }, + "StartTime": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time, in Unix epoch format, that transcoding for the job began.", + "smithy.api#jsonName": "startTime" } } }, @@ -14600,6 +15151,13 @@ "com.amazonaws.mediaconvert#UntagResourceRequest": { "type": "structure", "members": { + "TagKeys": { + "target": "com.amazonaws.mediaconvert#__listOf__string", + "traits": { + "smithy.api#documentation": "The keys of the tags that you want to remove from the resource.", + "smithy.api#jsonName": "tagKeys" + } + }, "Arn": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -14607,13 +15165,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "TagKeys": { - "target": "com.amazonaws.mediaconvert#__listOf__string", - "traits": { - "smithy.api#documentation": "The keys of the tags that you want to remove from the resource.", - "smithy.api#jsonName": "tagKeys" - } } } }, @@ -14661,32 +15212,33 @@ "com.amazonaws.mediaconvert#UpdateJobTemplateRequest": { "type": "structure", "members": { - "Category": { - "target": "com.amazonaws.mediaconvert#__string", + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", "traits": { - "smithy.api#documentation": "The new category for the job template, if you are changing it.", - "smithy.api#jsonName": "category" + "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" } }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "Settings": { + "target": "com.amazonaws.mediaconvert#JobTemplateSettings", "traits": { - "smithy.api#documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", - "smithy.api#jsonName": "priority" + "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", + "smithy.api#jsonName": "settings" } }, - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", + "Name": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" + "smithy.api#documentation": "The name of the job template you are modifying", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.mediaconvert#__string", + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", "traits": { - "smithy.api#documentation": "The new description for the job template, if you are changing it.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", + "smithy.api#jsonName": "priority" } }, "AccelerationSettings": { @@ -14696,11 +15248,11 @@ "smithy.api#jsonName": "accelerationSettings" } }, - "Queue": { + "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The new queue for the job template, if you are changing it.", - "smithy.api#jsonName": "queue" + "smithy.api#documentation": "The new description for the job template, if you are changing it.", + "smithy.api#jsonName": "description" } }, "HopDestinations": { @@ -14710,19 +15262,18 @@ "smithy.api#jsonName": "hopDestinations" } }, - "Name": { + "Category": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The name of the job template you are modifying", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The new category for the job template, if you are changing it.", + "smithy.api#jsonName": "category" } }, - "Settings": { - "target": "com.amazonaws.mediaconvert#JobTemplateSettings", + "Queue": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", - "smithy.api#jsonName": "settings" + "smithy.api#documentation": "The new queue for the job template, if you are changing it.", + "smithy.api#jsonName": "queue" } } } @@ -14779,11 +15330,11 @@ "com.amazonaws.mediaconvert#UpdatePresetRequest": { "type": "structure", "members": { - "Settings": { - "target": "com.amazonaws.mediaconvert#PresetSettings", + "Description": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Settings for preset", - "smithy.api#jsonName": "settings" + "smithy.api#documentation": "The new description for the preset, if you are changing it.", + "smithy.api#jsonName": "description" } }, "Name": { @@ -14794,18 +15345,18 @@ "smithy.api#required": {} } }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", + "Settings": { + "target": "com.amazonaws.mediaconvert#PresetSettings", "traits": { - "smithy.api#documentation": "The new category for the preset, if you are changing it.", - "smithy.api#jsonName": "category" + "smithy.api#documentation": "Settings for preset", + "smithy.api#jsonName": "settings" } }, - "Description": { + "Category": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The new description for the preset, if you are changing it.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The new category for the preset, if you are changing it.", + "smithy.api#jsonName": "category" } } } @@ -14862,20 +15413,6 @@ "com.amazonaws.mediaconvert#UpdateQueueRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "The new description for the queue, if you are changing it.", - "smithy.api#jsonName": "description" - } - }, - "Status": { - "target": "com.amazonaws.mediaconvert#QueueStatus", - "traits": { - "smithy.api#documentation": "Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.", - "smithy.api#jsonName": "status" - } - }, "ReservationPlanSettings": { "target": "com.amazonaws.mediaconvert#ReservationPlanSettings", "traits": { @@ -14883,6 +15420,13 @@ "smithy.api#jsonName": "reservationPlanSettings" } }, + "Description": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "The new description for the queue, if you are changing it.", + "smithy.api#jsonName": "description" + } + }, "Name": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -14890,6 +15434,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Status": { + "target": "com.amazonaws.mediaconvert#QueueStatus", + "traits": { + "smithy.api#documentation": "Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.", + "smithy.api#jsonName": "status" + } } } }, @@ -14905,19 +15456,191 @@ } } }, - "com.amazonaws.mediaconvert#VideoCodec": { + "com.amazonaws.mediaconvert#Vc3Class": { "type": "string", "traits": { - "smithy.api#documentation": "Type of video codec", + "smithy.api#documentation": "Specify the VC3 class to choose the quality characteristics for this output. VC3 class, together with the settings Framerate (framerateNumerator and framerateDenominator) and Resolution (height and width), determine your output bitrate. For example, say that your video resolution is 1920x1080 and your framerate is 29.97. Then Class 145 (CLASS_145) gives you an output with a bitrate of approximately 145 Mbps and Class 220 (CLASS_220) gives you and output with a bitrate of approximately 220 Mbps. VC3 class also specifies the color bit depth of your output.", "smithy.api#enum": [ { - "value": "FRAME_CAPTURE", - "name": "FRAME_CAPTURE" + "value": "CLASS_145_8BIT", + "name": "CLASS_145_8BIT" + }, + { + "value": "CLASS_220_8BIT", + "name": "CLASS_220_8BIT" + }, + { + "value": "CLASS_220_10BIT", + "name": "CLASS_220_10BIT" + } + ] + } + }, + "com.amazonaws.mediaconvert#Vc3FramerateControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#enum": [ + { + "value": "INITIALIZE_FROM_SOURCE", + "name": "INITIALIZE_FROM_SOURCE" + }, + { + "value": "SPECIFIED", + "name": "SPECIFIED" + } + ] + } + }, + "com.amazonaws.mediaconvert#Vc3FramerateConversionAlgorithm": { + "type": "string", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#enum": [ + { + "value": "DUPLICATE_DROP", + "name": "DUPLICATE_DROP" + }, + { + "value": "INTERPOLATE", + "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" + } + ] + } + }, + "com.amazonaws.mediaconvert#Vc3InterlaceMode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Optional. Choose the scan line type for this output. If you don't specify a value, MediaConvert will create a progressive output.", + "smithy.api#enum": [ + { + "value": "INTERLACED", + "name": "INTERLACED" + }, + { + "value": "PROGRESSIVE", + "name": "PROGRESSIVE" + } + ] + } + }, + "com.amazonaws.mediaconvert#Vc3Settings": { + "type": "structure", + "members": { + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" + } + }, + "SlowPal": { + "target": "com.amazonaws.mediaconvert#Vc3SlowPal", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly reduce the duration of your video. Related settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" + } + }, + "Telecine": { + "target": "com.amazonaws.mediaconvert#Vc3Telecine", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" + } + }, + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#Vc3FramerateControl", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" + } + }, + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Vc3FramerateConversionAlgorithm", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" + } + }, + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max1001", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" + } + }, + "Vc3Class": { + "target": "com.amazonaws.mediaconvert#Vc3Class", + "traits": { + "smithy.api#documentation": "Specify the VC3 class to choose the quality characteristics for this output. VC3 class, together with the settings Framerate (framerateNumerator and framerateDenominator) and Resolution (height and width), determine your output bitrate. For example, say that your video resolution is 1920x1080 and your framerate is 29.97. Then Class 145 (CLASS_145) gives you an output with a bitrate of approximately 145 Mbps and Class 220 (CLASS_220) gives you and output with a bitrate of approximately 220 Mbps. VC3 class also specifies the color bit depth of your output.", + "smithy.api#jsonName": "vc3Class" + } + }, + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#Vc3InterlaceMode", + "traits": { + "smithy.api#documentation": "Optional. Choose the scan line type for this output. If you don't specify a value, MediaConvert will create a progressive output.", + "smithy.api#jsonName": "interlaceMode" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VC3" + } + }, + "com.amazonaws.mediaconvert#Vc3SlowPal": { + "type": "string", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly reduce the duration of your video. Related settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.mediaconvert#Vc3Telecine": { + "type": "string", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" }, + { + "value": "HARD", + "name": "HARD" + } + ] + } + }, + "com.amazonaws.mediaconvert#VideoCodec": { + "type": "string", + "traits": { + "smithy.api#documentation": "Type of video codec", + "smithy.api#enum": [ { "value": "AV1", "name": "AV1" }, + { + "value": "AVC_INTRA", + "name": "AVC_INTRA" + }, + { + "value": "FRAME_CAPTURE", + "name": "FRAME_CAPTURE" + }, { "value": "H_264", "name": "H_264" @@ -14934,6 +15657,10 @@ "value": "PRORES", "name": "PRORES" }, + { + "value": "VC3", + "name": "VC3" + }, { "value": "VP8", "name": "VP8" @@ -14948,25 +15675,11 @@ "com.amazonaws.mediaconvert#VideoCodecSettings": { "type": "structure", "members": { - "ProresSettings": { - "target": "com.amazonaws.mediaconvert#ProresSettings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.", - "smithy.api#jsonName": "proresSettings" - } - }, - "FrameCaptureSettings": { - "target": "com.amazonaws.mediaconvert#FrameCaptureSettings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.", - "smithy.api#jsonName": "frameCaptureSettings" - } - }, - "H265Settings": { - "target": "com.amazonaws.mediaconvert#H265Settings", + "Av1Settings": { + "target": "com.amazonaws.mediaconvert#Av1Settings", "traits": { - "smithy.api#documentation": "Settings for H265 codec", - "smithy.api#jsonName": "h265Settings" + "smithy.api#documentation": "Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.", + "smithy.api#jsonName": "av1Settings" } }, "Mpeg2Settings": { @@ -14976,11 +15689,18 @@ "smithy.api#jsonName": "mpeg2Settings" } }, - "Codec": { - "target": "com.amazonaws.mediaconvert#VideoCodec", + "AvcIntraSettings": { + "target": "com.amazonaws.mediaconvert#AvcIntraSettings", "traits": { - "smithy.api#documentation": "Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec.", - "smithy.api#jsonName": "codec" + "smithy.api#documentation": "Required when you set your output video codec to AVC-Intra. For more information about the AVC-I settings, see the relevant specification. For detailed information about SD and HD in AVC-I, see https://ieeexplore.ieee.org/document/7290936.", + "smithy.api#jsonName": "avcIntraSettings" + } + }, + "ProresSettings": { + "target": "com.amazonaws.mediaconvert#ProresSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.", + "smithy.api#jsonName": "proresSettings" } }, "Vp9Settings": { @@ -14990,11 +15710,25 @@ "smithy.api#jsonName": "vp9Settings" } }, - "Av1Settings": { - "target": "com.amazonaws.mediaconvert#Av1Settings", + "Vc3Settings": { + "target": "com.amazonaws.mediaconvert#Vc3Settings", "traits": { - "smithy.api#documentation": "Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.", - "smithy.api#jsonName": "av1Settings" + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VC3", + "smithy.api#jsonName": "vc3Settings" + } + }, + "FrameCaptureSettings": { + "target": "com.amazonaws.mediaconvert#FrameCaptureSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.", + "smithy.api#jsonName": "frameCaptureSettings" + } + }, + "H265Settings": { + "target": "com.amazonaws.mediaconvert#H265Settings", + "traits": { + "smithy.api#documentation": "Settings for H265 codec", + "smithy.api#jsonName": "h265Settings" } }, "Vp8Settings": { @@ -15010,10 +15744,17 @@ "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.", "smithy.api#jsonName": "h264Settings" } + }, + "Codec": { + "target": "com.amazonaws.mediaconvert#VideoCodec", + "traits": { + "smithy.api#documentation": "Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec.", + "smithy.api#jsonName": "codec" + } } }, "traits": { - "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * FRAME_CAPTURE, FrameCaptureSettings * AV1, Av1Settings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VP8, Vp8Settings * VP9, Vp9Settings" + "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings" } }, "com.amazonaws.mediaconvert#VideoDescription": { @@ -15026,46 +15767,39 @@ "smithy.api#jsonName": "position" } }, - "VideoPreprocessors": { - "target": "com.amazonaws.mediaconvert#VideoPreprocessor", - "traits": { - "smithy.api#documentation": "Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.", - "smithy.api#jsonName": "videoPreprocessors" - } - }, - "RespondToAfd": { - "target": "com.amazonaws.mediaconvert#RespondToAfd", + "FixedAfd": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max15", "traits": { - "smithy.api#documentation": "Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.", - "smithy.api#jsonName": "respondToAfd" + "smithy.api#documentation": "Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.", + "smithy.api#jsonName": "fixedAfd" } }, - "Height": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "AntiAlias": { + "target": "com.amazonaws.mediaconvert#AntiAlias", "traits": { - "smithy.api#documentation": "Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.", - "smithy.api#jsonName": "height" + "smithy.api#documentation": "The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.", + "smithy.api#jsonName": "antiAlias" } }, - "ScalingBehavior": { - "target": "com.amazonaws.mediaconvert#ScalingBehavior", + "CodecSettings": { + "target": "com.amazonaws.mediaconvert#VideoCodecSettings", "traits": { - "smithy.api#documentation": "Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.", - "smithy.api#jsonName": "scalingBehavior" + "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings", + "smithy.api#jsonName": "codecSettings" } }, - "DropFrameTimecode": { - "target": "com.amazonaws.mediaconvert#DropFrameTimecode", + "Sharpness": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.", - "smithy.api#jsonName": "dropFrameTimecode" + "smithy.api#documentation": "Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.", + "smithy.api#jsonName": "sharpness" } }, - "Width": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "AfdSignaling": { + "target": "com.amazonaws.mediaconvert#AfdSignaling", "traits": { - "smithy.api#documentation": "Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.", - "smithy.api#jsonName": "width" + "smithy.api#documentation": "This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.", + "smithy.api#jsonName": "afdSignaling" } }, "Crop": { @@ -15075,6 +15809,13 @@ "smithy.api#jsonName": "crop" } }, + "TimecodeInsertion": { + "target": "com.amazonaws.mediaconvert#VideoTimecodeInsertion", + "traits": { + "smithy.api#documentation": "Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.", + "smithy.api#jsonName": "timecodeInsertion" + } + }, "ColorMetadata": { "target": "com.amazonaws.mediaconvert#ColorMetadata", "traits": { @@ -15082,46 +15823,46 @@ "smithy.api#jsonName": "colorMetadata" } }, - "TimecodeInsertion": { - "target": "com.amazonaws.mediaconvert#VideoTimecodeInsertion", + "ScalingBehavior": { + "target": "com.amazonaws.mediaconvert#ScalingBehavior", "traits": { - "smithy.api#documentation": "Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.", - "smithy.api#jsonName": "timecodeInsertion" + "smithy.api#documentation": "Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.", + "smithy.api#jsonName": "scalingBehavior" } }, - "AfdSignaling": { - "target": "com.amazonaws.mediaconvert#AfdSignaling", + "RespondToAfd": { + "target": "com.amazonaws.mediaconvert#RespondToAfd", "traits": { - "smithy.api#documentation": "This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.", - "smithy.api#jsonName": "afdSignaling" + "smithy.api#documentation": "Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.", + "smithy.api#jsonName": "respondToAfd" } }, - "Sharpness": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", "traits": { - "smithy.api#documentation": "Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.", - "smithy.api#jsonName": "sharpness" + "smithy.api#documentation": "Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.", + "smithy.api#jsonName": "height" } }, - "CodecSettings": { - "target": "com.amazonaws.mediaconvert#VideoCodecSettings", + "DropFrameTimecode": { + "target": "com.amazonaws.mediaconvert#DropFrameTimecode", "traits": { - "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * FRAME_CAPTURE, FrameCaptureSettings * AV1, Av1Settings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VP8, Vp8Settings * VP9, Vp9Settings", - "smithy.api#jsonName": "codecSettings" + "smithy.api#documentation": "Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.", + "smithy.api#jsonName": "dropFrameTimecode" } }, - "FixedAfd": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max15", + "VideoPreprocessors": { + "target": "com.amazonaws.mediaconvert#VideoPreprocessor", "traits": { - "smithy.api#documentation": "Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.", - "smithy.api#jsonName": "fixedAfd" + "smithy.api#documentation": "Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.", + "smithy.api#jsonName": "videoPreprocessors" } }, - "AntiAlias": { - "target": "com.amazonaws.mediaconvert#AntiAlias", + "Width": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", "traits": { - "smithy.api#documentation": "The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.", - "smithy.api#jsonName": "antiAlias" + "smithy.api#documentation": "Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.", + "smithy.api#jsonName": "width" } } }, @@ -15154,53 +15895,53 @@ "com.amazonaws.mediaconvert#VideoPreprocessor": { "type": "structure", "members": { - "Deinterlacer": { - "target": "com.amazonaws.mediaconvert#Deinterlacer", + "NoiseReducer": { + "target": "com.amazonaws.mediaconvert#NoiseReducer", "traits": { - "smithy.api#documentation": "Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture.", - "smithy.api#jsonName": "deinterlacer" + "smithy.api#documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", + "smithy.api#jsonName": "noiseReducer" } }, - "DolbyVision": { - "target": "com.amazonaws.mediaconvert#DolbyVision", + "TimecodeBurnin": { + "target": "com.amazonaws.mediaconvert#TimecodeBurnin", "traits": { - "smithy.api#documentation": "Enable Dolby Vision feature to produce Dolby Vision compatible video output.", - "smithy.api#jsonName": "dolbyVision" + "smithy.api#documentation": "Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.", + "smithy.api#jsonName": "timecodeBurnin" } }, - "ColorCorrector": { - "target": "com.amazonaws.mediaconvert#ColorCorrector", + "PartnerWatermarking": { + "target": "com.amazonaws.mediaconvert#PartnerWatermarking", "traits": { - "smithy.api#documentation": "Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", - "smithy.api#jsonName": "colorCorrector" + "smithy.api#documentation": "If you work with a third party video watermarking partner, use the group of settings that correspond with your watermarking partner to include watermarks in your output.", + "smithy.api#jsonName": "partnerWatermarking" } }, - "ImageInserter": { - "target": "com.amazonaws.mediaconvert#ImageInserter", + "Deinterlacer": { + "target": "com.amazonaws.mediaconvert#Deinterlacer", "traits": { - "smithy.api#documentation": "Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default.", - "smithy.api#jsonName": "imageInserter" + "smithy.api#documentation": "Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture.", + "smithy.api#jsonName": "deinterlacer" } }, - "PartnerWatermarking": { - "target": "com.amazonaws.mediaconvert#PartnerWatermarking", + "ColorCorrector": { + "target": "com.amazonaws.mediaconvert#ColorCorrector", "traits": { - "smithy.api#documentation": "If you work with a third party video watermarking partner, use the group of settings that correspond with your watermarking partner to include watermarks in your output.", - "smithy.api#jsonName": "partnerWatermarking" + "smithy.api#documentation": "Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", + "smithy.api#jsonName": "colorCorrector" } }, - "TimecodeBurnin": { - "target": "com.amazonaws.mediaconvert#TimecodeBurnin", + "DolbyVision": { + "target": "com.amazonaws.mediaconvert#DolbyVision", "traits": { - "smithy.api#documentation": "Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.", - "smithy.api#jsonName": "timecodeBurnin" + "smithy.api#documentation": "Enable Dolby Vision feature to produce Dolby Vision compatible video output.", + "smithy.api#jsonName": "dolbyVision" } }, - "NoiseReducer": { - "target": "com.amazonaws.mediaconvert#NoiseReducer", + "ImageInserter": { + "target": "com.amazonaws.mediaconvert#ImageInserter", "traits": { - "smithy.api#documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", - "smithy.api#jsonName": "noiseReducer" + "smithy.api#documentation": "Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default.", + "smithy.api#jsonName": "imageInserter" } } }, @@ -15211,25 +15952,25 @@ "com.amazonaws.mediaconvert#VideoSelector": { "type": "structure", "members": { - "AlphaBehavior": { - "target": "com.amazonaws.mediaconvert#AlphaBehavior", + "Hdr10Metadata": { + "target": "com.amazonaws.mediaconvert#Hdr10Metadata", "traits": { - "smithy.api#documentation": "Ignore this setting unless this input is a QuickTime animation with an alpha channel. Use this setting to create separate Key and Fill outputs. In each output, specify which part of the input MediaConvert uses. Leave this setting at the default value DISCARD to delete the alpha channel and preserve the video. Set it to REMAP_TO_LUMA to delete the video and map the alpha channel to the luma channel of your outputs.", - "smithy.api#jsonName": "alphaBehavior" + "smithy.api#documentation": "Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate values vary depending on the input video and must be provided by a color grader. The color grader generates these values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", + "smithy.api#jsonName": "hdr10Metadata" } }, - "ColorSpace": { - "target": "com.amazonaws.mediaconvert#ColorSpace", + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", - "smithy.api#jsonName": "colorSpace" + "smithy.api#documentation": "Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported.", + "smithy.api#jsonName": "programNumber" } }, - "Hdr10Metadata": { - "target": "com.amazonaws.mediaconvert#Hdr10Metadata", + "AlphaBehavior": { + "target": "com.amazonaws.mediaconvert#AlphaBehavior", "traits": { - "smithy.api#documentation": "Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate values vary depending on the input video and must be provided by a color grader. The color grader generates these values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", - "smithy.api#jsonName": "hdr10Metadata" + "smithy.api#documentation": "Ignore this setting unless this input is a QuickTime animation with an alpha channel. Use this setting to create separate Key and Fill outputs. In each output, specify which part of the input MediaConvert uses. Leave this setting at the default value DISCARD to delete the alpha channel and preserve the video. Set it to REMAP_TO_LUMA to delete the video and map the alpha channel to the luma channel of your outputs.", + "smithy.api#jsonName": "alphaBehavior" } }, "ColorSpaceUsage": { @@ -15239,6 +15980,13 @@ "smithy.api#jsonName": "colorSpaceUsage" } }, + "ColorSpace": { + "target": "com.amazonaws.mediaconvert#ColorSpace", + "traits": { + "smithy.api#documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", + "smithy.api#jsonName": "colorSpace" + } + }, "Pid": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { @@ -15246,13 +15994,6 @@ "smithy.api#jsonName": "pid" } }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", - "traits": { - "smithy.api#documentation": "Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported.", - "smithy.api#jsonName": "programNumber" - } - }, "Rotate": { "target": "com.amazonaws.mediaconvert#InputRotate", "traits": { @@ -15284,11 +16025,11 @@ "com.amazonaws.mediaconvert#VorbisSettings": { "type": "structure", "members": { - "VbrQuality": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max10", + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin22050Max48000", "traits": { - "smithy.api#documentation": "Optional. Specify the variable audio quality of this Vorbis output from -1 (lowest quality, ~45 kbit/s) to 10 (highest quality, ~500 kbit/s). The default value is 4 (~128 kbit/s). Values 5 and 6 are approximately 160 and 192 kbit/s, respectively.", - "smithy.api#jsonName": "vbrQuality" + "smithy.api#documentation": "Optional. Specify the audio sample rate in Hz. Valid values are 22050, 32000, 44100, and 48000. The default value is 48000.", + "smithy.api#jsonName": "sampleRate" } }, "Channels": { @@ -15298,11 +16039,11 @@ "smithy.api#jsonName": "channels" } }, - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin22050Max48000", + "VbrQuality": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max10", "traits": { - "smithy.api#documentation": "Optional. Specify the audio sample rate in Hz. Valid values are 22050, 32000, 44100, and 48000. The default value is 48000.", - "smithy.api#jsonName": "sampleRate" + "smithy.api#documentation": "Optional. Specify the variable audio quality of this Vorbis output from -1 (lowest quality, ~45 kbit/s) to 10 (highest quality, ~500 kbit/s). The default value is 4 (~128 kbit/s). Values 5 and 6 are approximately 160 and 192 kbit/s, respectively.", + "smithy.api#jsonName": "vbrQuality" } } }, @@ -15329,7 +16070,7 @@ "com.amazonaws.mediaconvert#Vp8FramerateConversionAlgorithm": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose Interpolate (INTERPOLATE) instead, the conversion produces smoother motion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#enum": [ { "value": "DUPLICATE_DROP", @@ -15338,6 +16079,10 @@ { "value": "INTERPOLATE", "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" } ] } @@ -15389,25 +16134,18 @@ "com.amazonaws.mediaconvert#Vp8Settings": { "type": "structure", "members": { - "ParControl": { - "target": "com.amazonaws.mediaconvert#Vp8ParControl", - "traits": { - "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", - "smithy.api#jsonName": "parControl" - } - }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Target bitrate in bits/second. For example, enter five megabits per second as 5000000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, - "FramerateNumerator": { + "ParNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" } }, "RateControlMode": { @@ -15417,25 +16155,32 @@ "smithy.api#jsonName": "rateControlMode" } }, - "ParNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#documentation": "Target bitrate in bits/second. For example, enter five megabits per second as 5000000.", + "smithy.api#jsonName": "bitrate" } }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#Vp8QualityTuningLevel", "traits": { - "smithy.api#documentation": "Optional. Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Vp8FramerateConversionAlgorithm", + "GopSize": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose Interpolate (INTERPOLATE) instead, the conversion produces smoother motion.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "GOP Length (keyframe interval) in frames. Must be greater than zero.", + "smithy.api#jsonName": "gopSize" + } + }, + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, "FramerateControl": { @@ -15445,6 +16190,13 @@ "smithy.api#jsonName": "framerateControl" } }, + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Vp8FramerateConversionAlgorithm", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" + } + }, "MaxBitrate": { "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { @@ -15452,32 +16204,25 @@ "smithy.api#jsonName": "maxBitrate" } }, - "GopSize": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", - "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames. Must be greater than zero.", - "smithy.api#jsonName": "gopSize" - } - }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#Vp8QualityTuningLevel", + "ParControl": { + "target": "com.amazonaws.mediaconvert#Vp8ParControl", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", + "smithy.api#jsonName": "parControl" } }, - "FramerateDenominator": { + "FramerateNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "Optional. Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } } }, @@ -15504,7 +16249,7 @@ "com.amazonaws.mediaconvert#Vp9FramerateConversionAlgorithm": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose Interpolate (INTERPOLATE) instead, the conversion produces smoother motion.", + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", "smithy.api#enum": [ { "value": "DUPLICATE_DROP", @@ -15513,6 +16258,10 @@ { "value": "INTERPOLATE", "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" } ] } @@ -15564,20 +16313,6 @@ "com.amazonaws.mediaconvert#Vp9Settings": { "type": "structure", "members": { - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" - } - }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", - "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" - } - }, "FramerateNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { @@ -15592,6 +16327,34 @@ "smithy.api#jsonName": "parControl" } }, + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max480000000", + "traits": { + "smithy.api#documentation": "Target bitrate in bits/second. For example, enter five megabits per second as 5000000.", + "smithy.api#jsonName": "bitrate" + } + }, + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#Vp9FramerateControl", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" + } + }, + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" + } + }, + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" + } + }, "MaxBitrate": { "target": "com.amazonaws.mediaconvert#__integerMin1000Max480000000", "traits": { @@ -15599,11 +16362,11 @@ "smithy.api#jsonName": "maxBitrate" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Vp9FramerateConversionAlgorithm", + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#Vp9QualityTuningLevel", "traits": { - "smithy.api#documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose Interpolate (INTERPOLATE) instead, the conversion produces smoother motion.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" } }, "GopSize": { @@ -15613,13 +16376,6 @@ "smithy.api#jsonName": "gopSize" } }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#Vp9RateControlMode", - "traits": { - "smithy.api#documentation": "With the VP9 codec, you can use only the variable bitrate (VBR) rate control mode.", - "smithy.api#jsonName": "rateControlMode" - } - }, "ParNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { @@ -15627,32 +16383,25 @@ "smithy.api#jsonName": "parNumerator" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" - } - }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#Vp9FramerateControl", + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#Vp9RateControlMode", "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" + "smithy.api#documentation": "With the VP9 codec, you can use only the variable bitrate (VBR) rate control mode.", + "smithy.api#jsonName": "rateControlMode" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max480000000", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Vp9FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Target bitrate in bits/second. For example, enter five megabits per second as 5000000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#Vp9QualityTuningLevel", + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } } }, @@ -15707,18 +16456,11 @@ "com.amazonaws.mediaconvert#WavSettings": { "type": "structure", "members": { - "Channels": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max64", - "traits": { - "smithy.api#documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64.", - "smithy.api#jsonName": "channels" - } - }, - "Format": { - "target": "com.amazonaws.mediaconvert#WavFormat", + "BitDepth": { + "target": "com.amazonaws.mediaconvert#__integerMin16Max24", "traits": { - "smithy.api#documentation": "The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64.", - "smithy.api#jsonName": "format" + "smithy.api#documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.", + "smithy.api#jsonName": "bitDepth" } }, "SampleRate": { @@ -15728,11 +16470,18 @@ "smithy.api#jsonName": "sampleRate" } }, - "BitDepth": { - "target": "com.amazonaws.mediaconvert#__integerMin16Max24", + "Format": { + "target": "com.amazonaws.mediaconvert#WavFormat", "traits": { - "smithy.api#documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.", - "smithy.api#jsonName": "bitDepth" + "smithy.api#documentation": "The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64.", + "smithy.api#jsonName": "format" + } + }, + "Channels": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max64", + "traits": { + "smithy.api#documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64.", + "smithy.api#jsonName": "channels" } } }, @@ -15962,6 +16711,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin0Max65534": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65534 + } + } + }, "com.amazonaws.mediaconvert#__integerMin0Max65535": { "type": "integer", "traits": { @@ -16833,6 +17591,15 @@ } } }, + "com.amazonaws.mediaconvert#__stringMin1Max20": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.mediaconvert#__stringMin1Max256": { "type": "string", "traits": { @@ -16842,6 +17609,15 @@ } } }, + "com.amazonaws.mediaconvert#__stringMin1Max50": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.mediaconvert#__stringMin24Max512PatternAZaZ0902": { "type": "string", "traits": { @@ -16932,6 +17708,12 @@ "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, + "com.amazonaws.mediaconvert#__stringPattern0xAFaF0908190908": { + "type": "string", + "traits": { + "smithy.api#pattern": "(^0x[A-Fa-f0-9]{0,8}$|^[1-9][0-9]{0,8}$)" + } + }, "com.amazonaws.mediaconvert#__stringPatternAZaZ0902": { "type": "string", "traits": { @@ -16992,16 +17774,16 @@ "smithy.api#pattern": "^s3:\\/\\/.*\\/(ASSETMAP.xml)?$" } }, - "com.amazonaws.mediaconvert#__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": { + "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": { "type": "string", "traits": { - "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" + "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, - "com.amazonaws.mediaconvert#__stringPatternS3WWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { + "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { "type": "string", "traits": { - "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" + "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, "com.amazonaws.mediaconvert#__stringPatternSNManifestConfirmConditionNotificationNS": { diff --git a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json index 74ff1e2428b0..84f924d758d1 100644 --- a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json +++ b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json @@ -128,18 +128,25 @@ "com.amazonaws.medialive#AacSettings": { "type": "structure", "members": { - "Spec": { - "target": "com.amazonaws.medialive#AacSpec", + "SampleRate": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.", - "smithy.api#jsonName": "spec" + "smithy.api#documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile.", + "smithy.api#jsonName": "sampleRate" } }, - "InputType": { - "target": "com.amazonaws.medialive#AacInputType", + "CodingMode": { + "target": "com.amazonaws.medialive#AacCodingMode", "traits": { - "smithy.api#documentation": "Set to \"broadcasterMixedAd\" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.\n\nLeave set to \"normal\" when input does not contain pre-mixed audio + AD.", - "smithy.api#jsonName": "inputType" + "smithy.api#documentation": "Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.", + "smithy.api#jsonName": "codingMode" + } + }, + "Profile": { + "target": "com.amazonaws.medialive#AacProfile", + "traits": { + "smithy.api#documentation": "AAC Profile.", + "smithy.api#jsonName": "profile" } }, "RateControlMode": { @@ -149,18 +156,11 @@ "smithy.api#jsonName": "rateControlMode" } }, - "SampleRate": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile.", - "smithy.api#jsonName": "sampleRate" - } - }, - "Profile": { - "target": "com.amazonaws.medialive#AacProfile", + "Spec": { + "target": "com.amazonaws.medialive#AacSpec", "traits": { - "smithy.api#documentation": "AAC Profile.", - "smithy.api#jsonName": "profile" + "smithy.api#documentation": "Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.", + "smithy.api#jsonName": "spec" } }, "VbrQuality": { @@ -170,18 +170,11 @@ "smithy.api#jsonName": "vbrQuality" } }, - "Bitrate": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Average bitrate in bits/second. Valid values depend on rate control mode and profile.", - "smithy.api#jsonName": "bitrate" - } - }, - "CodingMode": { - "target": "com.amazonaws.medialive#AacCodingMode", + "InputType": { + "target": "com.amazonaws.medialive#AacInputType", "traits": { - "smithy.api#documentation": "Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.", - "smithy.api#jsonName": "codingMode" + "smithy.api#documentation": "Set to \"broadcasterMixedAd\" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.\n\nLeave set to \"normal\" when input does not contain pre-mixed audio + AD.", + "smithy.api#jsonName": "inputType" } }, "RawFormat": { @@ -190,6 +183,13 @@ "smithy.api#documentation": "Sets LATM / LOAS AAC output for raw containers.", "smithy.api#jsonName": "rawFormat" } + }, + "Bitrate": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Average bitrate in bits/second. Valid values depend on rate control mode and profile.", + "smithy.api#jsonName": "bitrate" + } } }, "traits": { @@ -351,11 +351,11 @@ "com.amazonaws.medialive#Ac3Settings": { "type": "structure", "members": { - "LfeFilter": { - "target": "com.amazonaws.medialive#Ac3LfeFilter", + "MetadataControl": { + "target": "com.amazonaws.medialive#Ac3MetadataControl", "traits": { - "smithy.api#documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.", - "smithy.api#jsonName": "lfeFilter" + "smithy.api#documentation": "When set to \"followInput\", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", + "smithy.api#jsonName": "metadataControl" } }, "Dialnorm": { @@ -365,6 +365,20 @@ "smithy.api#jsonName": "dialnorm" } }, + "BitstreamMode": { + "target": "com.amazonaws.medialive#Ac3BitstreamMode", + "traits": { + "smithy.api#documentation": "Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.", + "smithy.api#jsonName": "bitstreamMode" + } + }, + "CodingMode": { + "target": "com.amazonaws.medialive#Ac3CodingMode", + "traits": { + "smithy.api#documentation": "Dolby Digital coding mode. Determines number of channels.", + "smithy.api#jsonName": "codingMode" + } + }, "DrcProfile": { "target": "com.amazonaws.medialive#Ac3DrcProfile", "traits": { @@ -379,25 +393,11 @@ "smithy.api#jsonName": "bitrate" } }, - "MetadataControl": { - "target": "com.amazonaws.medialive#Ac3MetadataControl", - "traits": { - "smithy.api#documentation": "When set to \"followInput\", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", - "smithy.api#jsonName": "metadataControl" - } - }, - "CodingMode": { - "target": "com.amazonaws.medialive#Ac3CodingMode", - "traits": { - "smithy.api#documentation": "Dolby Digital coding mode. Determines number of channels.", - "smithy.api#jsonName": "codingMode" - } - }, - "BitstreamMode": { - "target": "com.amazonaws.medialive#Ac3BitstreamMode", + "LfeFilter": { + "target": "com.amazonaws.medialive#Ac3LfeFilter", "traits": { - "smithy.api#documentation": "Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.", - "smithy.api#jsonName": "bitstreamMode" + "smithy.api#documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.", + "smithy.api#jsonName": "lfeFilter" } } }, @@ -408,7 +408,7 @@ "com.amazonaws.medialive#AcceptHeader": { "type": "string", "traits": { - "smithy.api#documentation": "The HTTP Accept header. Indicates the requested type for the thumbnail.", + "smithy.api#documentation": "The HTTP Accept header. Indicates the requested type fothe thumbnail.", "smithy.api#enum": [ { "value": "image/jpeg", @@ -417,6 +417,75 @@ ] } }, + "com.amazonaws.medialive#AcceptInputDeviceTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#AcceptInputDeviceTransferRequest" + }, + "output": { + "target": "com.amazonaws.medialive#AcceptInputDeviceTransferResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/accept", + "code": 200 + } + } + }, + "com.amazonaws.medialive#AcceptInputDeviceTransferRequest": { + "type": "structure", + "members": { + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device to accept. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for AcceptInputDeviceTransferRequest" + } + }, + "com.amazonaws.medialive#AcceptInputDeviceTransferResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for AcceptInputDeviceTransferResponse" + } + }, "com.amazonaws.medialive#AfdSignaling": { "type": "string", "traits": { @@ -437,6 +506,21 @@ ] } }, + "com.amazonaws.medialive#AncillarySourceSettings": { + "type": "structure", + "members": { + "SourceAncillaryChannelNumber": { + "target": "com.amazonaws.medialive#__integerMin1Max4", + "traits": { + "smithy.api#documentation": "Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field.", + "smithy.api#jsonName": "sourceAncillaryChannelNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "Ancillary Source Settings" + } + }, "com.amazonaws.medialive#ArchiveContainerSettings": { "type": "structure", "members": { @@ -445,6 +529,12 @@ "traits": { "smithy.api#jsonName": "m2tsSettings" } + }, + "RawSettings": { + "target": "com.amazonaws.medialive#RawSettings", + "traits": { + "smithy.api#jsonName": "rawSettings" + } } }, "traits": { @@ -477,6 +567,13 @@ "com.amazonaws.medialive#ArchiveOutputSettings": { "type": "structure", "members": { + "NameModifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type.", + "smithy.api#jsonName": "nameModifier" + } + }, "ContainerSettings": { "target": "com.amazonaws.medialive#ArchiveContainerSettings", "traits": { @@ -491,13 +588,6 @@ "smithy.api#documentation": "Output file extension. If excluded, this will be auto-selected from the container type.", "smithy.api#jsonName": "extension" } - }, - "NameModifier": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type.", - "smithy.api#jsonName": "nameModifier" - } } }, "traits": { @@ -551,22 +641,22 @@ "smithy.api#jsonName": "passThroughSettings" } }, - "Ac3Settings": { - "target": "com.amazonaws.medialive#Ac3Settings", - "traits": { - "smithy.api#jsonName": "ac3Settings" - } - }, "Mp2Settings": { "target": "com.amazonaws.medialive#Mp2Settings", "traits": { "smithy.api#jsonName": "mp2Settings" } }, - "AacSettings": { - "target": "com.amazonaws.medialive#AacSettings", + "WavSettings": { + "target": "com.amazonaws.medialive#WavSettings", "traits": { - "smithy.api#jsonName": "aacSettings" + "smithy.api#jsonName": "wavSettings" + } + }, + "Ac3Settings": { + "target": "com.amazonaws.medialive#Ac3Settings", + "traits": { + "smithy.api#jsonName": "ac3Settings" } }, "Eac3Settings": { @@ -574,6 +664,12 @@ "traits": { "smithy.api#jsonName": "eac3Settings" } + }, + "AacSettings": { + "target": "com.amazonaws.medialive#AacSettings", + "traits": { + "smithy.api#jsonName": "aacSettings" + } } }, "traits": { @@ -583,6 +679,35 @@ "com.amazonaws.medialive#AudioDescription": { "type": "structure", "members": { + "RemixSettings": { + "target": "com.amazonaws.medialive#RemixSettings", + "traits": { + "smithy.api#documentation": "Settings that control how input audio channels are remixed into the output audio channels.", + "smithy.api#jsonName": "remixSettings" + } + }, + "AudioTypeControl": { + "target": "com.amazonaws.medialive#AudioDescriptionAudioTypeControl", + "traits": { + "smithy.api#documentation": "Determines how audio type is determined.\n followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output.\n useConfigured: The value in Audio Type is included in the output.\nNote that this field and audioType are both ignored if inputType is broadcasterMixedAd.", + "smithy.api#jsonName": "audioTypeControl" + } + }, + "LanguageCodeControl": { + "target": "com.amazonaws.medialive#AudioDescriptionLanguageCodeControl", + "traits": { + "smithy.api#documentation": "Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.", + "smithy.api#jsonName": "languageCodeControl" + } + }, + "AudioSelectorName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the AudioSelector used as the source for this AudioDescription.", + "smithy.api#jsonName": "audioSelectorName", + "smithy.api#required": {} + } + }, "AudioNormalizationSettings": { "target": "com.amazonaws.medialive#AudioNormalizationSettings", "traits": { @@ -597,12 +722,18 @@ "smithy.api#jsonName": "languageCode" } }, - "AudioSelectorName": { - "target": "com.amazonaws.medialive#__string", + "CodecSettings": { + "target": "com.amazonaws.medialive#AudioCodecSettings", "traits": { - "smithy.api#documentation": "The name of the AudioSelector used as the source for this AudioDescription.", - "smithy.api#jsonName": "audioSelectorName", - "smithy.api#required": {} + "smithy.api#documentation": "Audio codec settings.", + "smithy.api#jsonName": "codecSettings" + } + }, + "AudioType": { + "target": "com.amazonaws.medialive#AudioType", + "traits": { + "smithy.api#documentation": "Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.", + "smithy.api#jsonName": "audioType" } }, "StreamName": { @@ -612,20 +743,6 @@ "smithy.api#jsonName": "streamName" } }, - "LanguageCodeControl": { - "target": "com.amazonaws.medialive#AudioDescriptionLanguageCodeControl", - "traits": { - "smithy.api#documentation": "Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.", - "smithy.api#jsonName": "languageCodeControl" - } - }, - "AudioType": { - "target": "com.amazonaws.medialive#AudioType", - "traits": { - "smithy.api#documentation": "Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.", - "smithy.api#jsonName": "audioType" - } - }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -633,27 +750,6 @@ "smithy.api#jsonName": "name", "smithy.api#required": {} } - }, - "CodecSettings": { - "target": "com.amazonaws.medialive#AudioCodecSettings", - "traits": { - "smithy.api#documentation": "Audio codec settings.", - "smithy.api#jsonName": "codecSettings" - } - }, - "RemixSettings": { - "target": "com.amazonaws.medialive#RemixSettings", - "traits": { - "smithy.api#documentation": "Settings that control how input audio channels are remixed into the output audio channels.", - "smithy.api#jsonName": "remixSettings" - } - }, - "AudioTypeControl": { - "target": "com.amazonaws.medialive#AudioDescriptionAudioTypeControl", - "traits": { - "smithy.api#documentation": "Determines how audio type is determined.\n followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output.\n useConfigured: The value in Audio Type is included in the output.\nNote that this field and audioType are both ignored if inputType is broadcasterMixedAd.", - "smithy.api#jsonName": "audioTypeControl" - } } }, "traits": { @@ -762,6 +858,13 @@ "com.amazonaws.medialive#AudioNormalizationSettings": { "type": "structure", "members": { + "Algorithm": { + "target": "com.amazonaws.medialive#AudioNormalizationAlgorithm", + "traits": { + "smithy.api#documentation": "Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.", + "smithy.api#jsonName": "algorithm" + } + }, "TargetLkfs": { "target": "com.amazonaws.medialive#__doubleMinNegative59Max0", "traits": { @@ -775,13 +878,6 @@ "smithy.api#documentation": "When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.", "smithy.api#jsonName": "algorithmControl" } - }, - "Algorithm": { - "target": "com.amazonaws.medialive#AudioNormalizationAlgorithm", - "traits": { - "smithy.api#documentation": "Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.", - "smithy.api#jsonName": "algorithm" - } } }, "traits": { @@ -906,12 +1002,6 @@ "com.amazonaws.medialive#AudioSelectorSettings": { "type": "structure", "members": { - "AudioLanguageSelection": { - "target": "com.amazonaws.medialive#AudioLanguageSelection", - "traits": { - "smithy.api#jsonName": "audioLanguageSelection" - } - }, "AudioPidSelection": { "target": "com.amazonaws.medialive#AudioPidSelection", "traits": { @@ -923,6 +1013,12 @@ "traits": { "smithy.api#jsonName": "audioTrackSelection" } + }, + "AudioLanguageSelection": { + "target": "com.amazonaws.medialive#AudioLanguageSelection", + "traits": { + "smithy.api#jsonName": "audioLanguageSelection" + } } }, "traits": { @@ -951,7 +1047,7 @@ "Tracks": { "target": "com.amazonaws.medialive#__listOfAudioTrack", "traits": { - "smithy.api#documentation": "Selects one or more unique audio tracks from within an mp4 source.", + "smithy.api#documentation": "Selects one or more unique audio tracks from within a source.", "smithy.api#jsonName": "tracks", "smithy.api#required": {} } @@ -1080,17 +1176,17 @@ "com.amazonaws.medialive#AvailSettings": { "type": "structure", "members": { - "Scte35TimeSignalApos": { - "target": "com.amazonaws.medialive#Scte35TimeSignalApos", - "traits": { - "smithy.api#jsonName": "scte35TimeSignalApos" - } - }, "Scte35SpliceInsert": { "target": "com.amazonaws.medialive#Scte35SpliceInsert", "traits": { "smithy.api#jsonName": "scte35SpliceInsert" } + }, + "Scte35TimeSignalApos": { + "target": "com.amazonaws.medialive#Scte35TimeSignalApos", + "traits": { + "smithy.api#jsonName": "scte35TimeSignalApos" + } } }, "traits": { @@ -1129,6 +1225,143 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.medialive#BatchDelete": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#BatchDeleteRequest" + }, + "output": { + "target": "com.amazonaws.medialive#BatchDeleteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Starts delete of resources.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/batch/delete", + "code": 200 + } + } + }, + "com.amazonaws.medialive#BatchDeleteRequest": { + "type": "structure", + "members": { + "MultiplexIds": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "List of multiplex IDs", + "smithy.api#jsonName": "multiplexIds" + } + }, + "InputIds": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "List of input IDs", + "smithy.api#jsonName": "inputIds" + } + }, + "ChannelIds": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "List of channel IDs", + "smithy.api#jsonName": "channelIds" + } + }, + "InputSecurityGroupIds": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "List of input security group IDs", + "smithy.api#jsonName": "inputSecurityGroupIds" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete resources" + } + }, + "com.amazonaws.medialive#BatchDeleteResponse": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.medialive#__listOfBatchSuccessfulResultModel", + "traits": { + "smithy.api#documentation": "List of successful operations", + "smithy.api#jsonName": "successful" + } + }, + "Failed": { + "target": "com.amazonaws.medialive#__listOfBatchFailedResultModel", + "traits": { + "smithy.api#documentation": "List of failed operations", + "smithy.api#jsonName": "failed" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for BatchDeleteResponse" + } + }, + "com.amazonaws.medialive#BatchFailedResultModel": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Error message for the failed operation", + "smithy.api#jsonName": "message" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "ID of the resource", + "smithy.api#jsonName": "id" + } + }, + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "ARN of the resource", + "smithy.api#jsonName": "arn" + } + }, + "Code": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Error code for the failed operation", + "smithy.api#jsonName": "code" + } + } + }, + "traits": { + "smithy.api#documentation": "Details from a failed operation" + } + }, "com.amazonaws.medialive#BatchScheduleActionCreateRequest": { "type": "structure", "members": { @@ -1193,13 +1426,13 @@ "smithy.api#documentation": "List of actions that have been deleted from the schedule." } }, - "com.amazonaws.medialive#BatchUpdateSchedule": { + "com.amazonaws.medialive#BatchStart": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#BatchUpdateScheduleRequest" + "target": "com.amazonaws.medialive#BatchStartRequest" }, "output": { - "target": "com.amazonaws.medialive#BatchUpdateScheduleResponse" + "target": "com.amazonaws.medialive#BatchStartResponse" }, "errors": [ { @@ -1208,6 +1441,9 @@ { "target": "com.amazonaws.medialive#BadRequestException" }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, { "target": "com.amazonaws.medialive#ForbiddenException" }, @@ -1222,102 +1458,302 @@ }, { "target": "com.amazonaws.medialive#TooManyRequestsException" - }, - { - "target": "com.amazonaws.medialive#UnprocessableEntityException" } ], "traits": { - "smithy.api#documentation": "Update a channel schedule", + "smithy.api#documentation": "Starts existing resources", "smithy.api#http": { - "method": "PUT", - "uri": "/prod/channels/{ChannelId}/schedule", + "method": "POST", + "uri": "/prod/batch/start", "code": 200 } } }, - "com.amazonaws.medialive#BatchUpdateScheduleRequest": { + "com.amazonaws.medialive#BatchStartRequest": { "type": "structure", "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Id of the channel whose schedule is being updated.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Deletes": { - "target": "com.amazonaws.medialive#BatchScheduleActionDeleteRequest", + "ChannelIds": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "Schedule actions to delete from the schedule.", - "smithy.api#jsonName": "deletes" + "smithy.api#documentation": "List of channel IDs", + "smithy.api#jsonName": "channelIds" } }, - "Creates": { - "target": "com.amazonaws.medialive#BatchScheduleActionCreateRequest", + "MultiplexIds": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "Schedule actions to create in the schedule.", - "smithy.api#jsonName": "creates" + "smithy.api#documentation": "List of multiplex IDs", + "smithy.api#jsonName": "multiplexIds" } } }, "traits": { - "smithy.api#documentation": "List of actions to create and list of actions to delete." + "smithy.api#documentation": "A request to start resources" } }, - "com.amazonaws.medialive#BatchUpdateScheduleResponse": { + "com.amazonaws.medialive#BatchStartResponse": { "type": "structure", "members": { - "Deletes": { - "target": "com.amazonaws.medialive#BatchScheduleActionDeleteResult", + "Successful": { + "target": "com.amazonaws.medialive#__listOfBatchSuccessfulResultModel", "traits": { - "smithy.api#documentation": "Schedule actions deleted from the schedule.", - "smithy.api#jsonName": "deletes" + "smithy.api#documentation": "List of successful operations", + "smithy.api#jsonName": "successful" } }, - "Creates": { - "target": "com.amazonaws.medialive#BatchScheduleActionCreateResult", + "Failed": { + "target": "com.amazonaws.medialive#__listOfBatchFailedResultModel", "traits": { - "smithy.api#documentation": "Schedule actions created in the schedule.", - "smithy.api#jsonName": "creates" + "smithy.api#documentation": "List of failed operations", + "smithy.api#jsonName": "failed" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for BatchUpdateScheduleResponse" + "smithy.api#documentation": "Placeholder documentation for BatchStartResponse" } }, - "com.amazonaws.medialive#BlackoutSlate": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.medialive#BlackoutSlateState", - "traits": { - "smithy.api#documentation": "When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.", - "smithy.api#jsonName": "state" - } - }, - "NetworkEndBlackoutImage": { - "target": "com.amazonaws.medialive#InputLocation", - "traits": { - "smithy.api#documentation": "Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.", - "smithy.api#jsonName": "networkEndBlackoutImage" - } + "com.amazonaws.medialive#BatchStop": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#BatchStopRequest" + }, + "output": { + "target": "com.amazonaws.medialive#BatchStopResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" }, - "NetworkEndBlackout": { - "target": "com.amazonaws.medialive#BlackoutSlateNetworkEndBlackout", - "traits": { - "smithy.api#documentation": "Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the \"Network Blackout Image\" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in \"Network ID\".", - "smithy.api#jsonName": "networkEndBlackout" - } + { + "target": "com.amazonaws.medialive#BadRequestException" }, - "NetworkId": { - "target": "com.amazonaws.medialive#__stringMin34Max34", - "traits": { - "smithy.api#documentation": "Provides Network ID that matches EIDR ID format (e.g., \"10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C\").", - "smithy.api#jsonName": "networkId" - } + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Stops running resources", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/batch/stop", + "code": 200 + } + } + }, + "com.amazonaws.medialive#BatchStopRequest": { + "type": "structure", + "members": { + "MultiplexIds": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "List of multiplex IDs", + "smithy.api#jsonName": "multiplexIds" + } + }, + "ChannelIds": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "List of channel IDs", + "smithy.api#jsonName": "channelIds" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to stop resources" + } + }, + "com.amazonaws.medialive#BatchStopResponse": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.medialive#__listOfBatchSuccessfulResultModel", + "traits": { + "smithy.api#documentation": "List of successful operations", + "smithy.api#jsonName": "successful" + } + }, + "Failed": { + "target": "com.amazonaws.medialive#__listOfBatchFailedResultModel", + "traits": { + "smithy.api#documentation": "List of failed operations", + "smithy.api#jsonName": "failed" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for BatchStopResponse" + } + }, + "com.amazonaws.medialive#BatchSuccessfulResultModel": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Current state of the resource", + "smithy.api#jsonName": "state" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "ID of the resource", + "smithy.api#jsonName": "id" + } + }, + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "ARN of the resource", + "smithy.api#jsonName": "arn" + } + } + }, + "traits": { + "smithy.api#documentation": "Details from a successful operation" + } + }, + "com.amazonaws.medialive#BatchUpdateSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#BatchUpdateScheduleRequest" + }, + "output": { + "target": "com.amazonaws.medialive#BatchUpdateScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Update a channel schedule", + "smithy.api#http": { + "method": "PUT", + "uri": "/prod/channels/{ChannelId}/schedule", + "code": 200 + } + } + }, + "com.amazonaws.medialive#BatchUpdateScheduleRequest": { + "type": "structure", + "members": { + "Deletes": { + "target": "com.amazonaws.medialive#BatchScheduleActionDeleteRequest", + "traits": { + "smithy.api#documentation": "Schedule actions to delete from the schedule.", + "smithy.api#jsonName": "deletes" + } + }, + "ChannelId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Id of the channel whose schedule is being updated.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Creates": { + "target": "com.amazonaws.medialive#BatchScheduleActionCreateRequest", + "traits": { + "smithy.api#documentation": "Schedule actions to create in the schedule.", + "smithy.api#jsonName": "creates" + } + } + }, + "traits": { + "smithy.api#documentation": "List of actions to create and list of actions to delete." + } + }, + "com.amazonaws.medialive#BatchUpdateScheduleResponse": { + "type": "structure", + "members": { + "Deletes": { + "target": "com.amazonaws.medialive#BatchScheduleActionDeleteResult", + "traits": { + "smithy.api#documentation": "Schedule actions deleted from the schedule.", + "smithy.api#jsonName": "deletes" + } + }, + "Creates": { + "target": "com.amazonaws.medialive#BatchScheduleActionCreateResult", + "traits": { + "smithy.api#documentation": "Schedule actions created in the schedule.", + "smithy.api#jsonName": "creates" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for BatchUpdateScheduleResponse" + } + }, + "com.amazonaws.medialive#BlackoutSlate": { + "type": "structure", + "members": { + "NetworkEndBlackout": { + "target": "com.amazonaws.medialive#BlackoutSlateNetworkEndBlackout", + "traits": { + "smithy.api#documentation": "Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the \"Network Blackout Image\" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in \"Network ID\".", + "smithy.api#jsonName": "networkEndBlackout" + } + }, + "State": { + "target": "com.amazonaws.medialive#BlackoutSlateState", + "traits": { + "smithy.api#documentation": "When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.", + "smithy.api#jsonName": "state" + } + }, + "NetworkEndBlackoutImage": { + "target": "com.amazonaws.medialive#InputLocation", + "traits": { + "smithy.api#documentation": "Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.", + "smithy.api#jsonName": "networkEndBlackoutImage" + } + }, + "NetworkId": { + "target": "com.amazonaws.medialive#__stringMin34Max34", + "traits": { + "smithy.api#documentation": "Provides Network ID that matches EIDR ID format (e.g., \"10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C\").", + "smithy.api#jsonName": "networkId" + } }, "BlackoutSlateImage": { "target": "com.amazonaws.medialive#InputLocation", @@ -1406,18 +1842,18 @@ "com.amazonaws.medialive#BurnInDestinationSettings": { "type": "structure", "members": { - "Font": { - "target": "com.amazonaws.medialive#InputLocation", + "BackgroundColor": { + "target": "com.amazonaws.medialive#BurnInBackgroundColor", "traits": { - "smithy.api#documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "font" + "smithy.api#documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundColor" } }, - "XPosition": { + "YPosition": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "xPosition" + "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "yPosition" } }, "FontSize": { @@ -1427,6 +1863,13 @@ "smithy.api#jsonName": "fontSize" } }, + "Font": { + "target": "com.amazonaws.medialive#InputLocation", + "traits": { + "smithy.api#documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "font" + } + }, "ShadowYOffset": { "target": "com.amazonaws.medialive#__integer", "traits": { @@ -1434,13 +1877,6 @@ "smithy.api#jsonName": "shadowYOffset" } }, - "YPosition": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "yPosition" - } - }, "TeletextGridControl": { "target": "com.amazonaws.medialive#BurnInTeletextGridControl", "traits": { @@ -1448,39 +1884,39 @@ "smithy.api#jsonName": "teletextGridControl" } }, - "BackgroundColor": { - "target": "com.amazonaws.medialive#BurnInBackgroundColor", + "ShadowOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundColor" + "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowOpacity" } }, - "OutlineSize": { - "target": "com.amazonaws.medialive#__integerMin0Max10", + "BackgroundOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "outlineSize" + "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundOpacity" } }, - "ShadowXOffset": { - "target": "com.amazonaws.medialive#__integer", + "Alignment": { + "target": "com.amazonaws.medialive#BurnInAlignment", "traits": { - "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowXOffset" + "smithy.api#documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "alignment" } }, - "FontOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "XPosition": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontOpacity" + "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "xPosition" } }, - "OutlineColor": { - "target": "com.amazonaws.medialive#BurnInOutlineColor", + "FontOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "outlineColor" + "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontOpacity" } }, "ShadowColor": { @@ -1497,32 +1933,32 @@ "smithy.api#jsonName": "fontResolution" } }, - "BackgroundOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "FontColor": { + "target": "com.amazonaws.medialive#BurnInFontColor", "traits": { - "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundOpacity" + "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontColor" } }, - "Alignment": { - "target": "com.amazonaws.medialive#BurnInAlignment", + "OutlineSize": { + "target": "com.amazonaws.medialive#__integerMin0Max10", "traits": { - "smithy.api#documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "alignment" + "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "outlineSize" } }, - "FontColor": { - "target": "com.amazonaws.medialive#BurnInFontColor", + "ShadowXOffset": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontColor" + "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowXOffset" } }, - "ShadowOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "OutlineColor": { + "target": "com.amazonaws.medialive#BurnInOutlineColor", "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowOpacity" + "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "outlineColor" } } }, @@ -1630,14 +2066,84 @@ ] } }, + "com.amazonaws.medialive#CancelInputDeviceTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#CancelInputDeviceTransferRequest" + }, + "output": { + "target": "com.amazonaws.medialive#CancelInputDeviceTransferResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Cancel an input device transfer that you have requested.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/cancel", + "code": 200 + } + } + }, + "com.amazonaws.medialive#CancelInputDeviceTransferRequest": { + "type": "structure", + "members": { + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device to cancel. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CancelInputDeviceTransferRequest" + } + }, + "com.amazonaws.medialive#CancelInputDeviceTransferResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CancelInputDeviceTransferResponse" + } + }, "com.amazonaws.medialive#CaptionDescription": { "type": "structure", "members": { - "DestinationSettings": { - "target": "com.amazonaws.medialive#CaptionDestinationSettings", + "CaptionSelectorName": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Additional settings for captions destination that depend on the destination type.", - "smithy.api#jsonName": "destinationSettings" + "smithy.api#documentation": "Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.", + "smithy.api#jsonName": "captionSelectorName", + "smithy.api#required": {} } }, "LanguageCode": { @@ -1662,12 +2168,11 @@ "smithy.api#required": {} } }, - "CaptionSelectorName": { - "target": "com.amazonaws.medialive#__string", + "DestinationSettings": { + "target": "com.amazonaws.medialive#CaptionDestinationSettings", "traits": { - "smithy.api#documentation": "Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.", - "smithy.api#jsonName": "captionSelectorName", - "smithy.api#required": {} + "smithy.api#documentation": "Additional settings for captions destination that depend on the destination type.", + "smithy.api#jsonName": "destinationSettings" } } }, @@ -1678,10 +2183,10 @@ "com.amazonaws.medialive#CaptionDestinationSettings": { "type": "structure", "members": { - "SmpteTtDestinationSettings": { - "target": "com.amazonaws.medialive#SmpteTtDestinationSettings", + "TtmlDestinationSettings": { + "target": "com.amazonaws.medialive#TtmlDestinationSettings", "traits": { - "smithy.api#jsonName": "smpteTtDestinationSettings" + "smithy.api#jsonName": "ttmlDestinationSettings" } }, "EmbeddedPlusScte20DestinationSettings": { @@ -1702,28 +2207,22 @@ "smithy.api#jsonName": "ebuTtDDestinationSettings" } }, - "TtmlDestinationSettings": { - "target": "com.amazonaws.medialive#TtmlDestinationSettings", - "traits": { - "smithy.api#jsonName": "ttmlDestinationSettings" - } - }, - "Scte20PlusEmbeddedDestinationSettings": { - "target": "com.amazonaws.medialive#Scte20PlusEmbeddedDestinationSettings", + "Scte27DestinationSettings": { + "target": "com.amazonaws.medialive#Scte27DestinationSettings", "traits": { - "smithy.api#jsonName": "scte20PlusEmbeddedDestinationSettings" + "smithy.api#jsonName": "scte27DestinationSettings" } }, - "DvbSubDestinationSettings": { - "target": "com.amazonaws.medialive#DvbSubDestinationSettings", + "RtmpCaptionInfoDestinationSettings": { + "target": "com.amazonaws.medialive#RtmpCaptionInfoDestinationSettings", "traits": { - "smithy.api#jsonName": "dvbSubDestinationSettings" + "smithy.api#jsonName": "rtmpCaptionInfoDestinationSettings" } }, - "WebvttDestinationSettings": { - "target": "com.amazonaws.medialive#WebvttDestinationSettings", + "EmbeddedDestinationSettings": { + "target": "com.amazonaws.medialive#EmbeddedDestinationSettings", "traits": { - "smithy.api#jsonName": "webvttDestinationSettings" + "smithy.api#jsonName": "embeddedDestinationSettings" } }, "TeletextDestinationSettings": { @@ -1732,28 +2231,34 @@ "smithy.api#jsonName": "teletextDestinationSettings" } }, + "DvbSubDestinationSettings": { + "target": "com.amazonaws.medialive#DvbSubDestinationSettings", + "traits": { + "smithy.api#jsonName": "dvbSubDestinationSettings" + } + }, "BurnInDestinationSettings": { "target": "com.amazonaws.medialive#BurnInDestinationSettings", "traits": { "smithy.api#jsonName": "burnInDestinationSettings" } }, - "Scte27DestinationSettings": { - "target": "com.amazonaws.medialive#Scte27DestinationSettings", + "WebvttDestinationSettings": { + "target": "com.amazonaws.medialive#WebvttDestinationSettings", "traits": { - "smithy.api#jsonName": "scte27DestinationSettings" + "smithy.api#jsonName": "webvttDestinationSettings" } }, - "EmbeddedDestinationSettings": { - "target": "com.amazonaws.medialive#EmbeddedDestinationSettings", + "SmpteTtDestinationSettings": { + "target": "com.amazonaws.medialive#SmpteTtDestinationSettings", "traits": { - "smithy.api#jsonName": "embeddedDestinationSettings" + "smithy.api#jsonName": "smpteTtDestinationSettings" } }, - "RtmpCaptionInfoDestinationSettings": { - "target": "com.amazonaws.medialive#RtmpCaptionInfoDestinationSettings", + "Scte20PlusEmbeddedDestinationSettings": { + "target": "com.amazonaws.medialive#Scte20PlusEmbeddedDestinationSettings", "traits": { - "smithy.api#jsonName": "rtmpCaptionInfoDestinationSettings" + "smithy.api#jsonName": "scte20PlusEmbeddedDestinationSettings" } } }, @@ -1764,6 +2269,14 @@ "com.amazonaws.medialive#CaptionLanguageMapping": { "type": "structure", "members": { + "CaptionChannel": { + "target": "com.amazonaws.medialive#__integerMin1Max4", + "traits": { + "smithy.api#documentation": "The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)", + "smithy.api#jsonName": "captionChannel", + "smithy.api#required": {} + } + }, "LanguageCode": { "target": "com.amazonaws.medialive#__stringMin3Max3", "traits": { @@ -1779,14 +2292,6 @@ "smithy.api#jsonName": "languageDescription", "smithy.api#required": {} } - }, - "CaptionChannel": { - "target": "com.amazonaws.medialive#__integerMin1Max4", - "traits": { - "smithy.api#documentation": "The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)", - "smithy.api#jsonName": "captionChannel", - "smithy.api#required": {} - } } }, "traits": { @@ -1796,13 +2301,6 @@ "com.amazonaws.medialive#CaptionSelector": { "type": "structure", "members": { - "SelectorSettings": { - "target": "com.amazonaws.medialive#CaptionSelectorSettings", - "traits": { - "smithy.api#documentation": "Caption selector settings.", - "smithy.api#jsonName": "selectorSettings" - } - }, "LanguageCode": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -1810,6 +2308,13 @@ "smithy.api#jsonName": "languageCode" } }, + "SelectorSettings": { + "target": "com.amazonaws.medialive#CaptionSelectorSettings", + "traits": { + "smithy.api#documentation": "Caption selector settings.", + "smithy.api#jsonName": "selectorSettings" + } + }, "Name": { "target": "com.amazonaws.medialive#__stringMin1", "traits": { @@ -1826,16 +2331,10 @@ "com.amazonaws.medialive#CaptionSelectorSettings": { "type": "structure", "members": { - "Scte27SourceSettings": { - "target": "com.amazonaws.medialive#Scte27SourceSettings", - "traits": { - "smithy.api#jsonName": "scte27SourceSettings" - } - }, - "DvbSubSourceSettings": { - "target": "com.amazonaws.medialive#DvbSubSourceSettings", + "EmbeddedSourceSettings": { + "target": "com.amazonaws.medialive#EmbeddedSourceSettings", "traits": { - "smithy.api#jsonName": "dvbSubSourceSettings" + "smithy.api#jsonName": "embeddedSourceSettings" } }, "AribSourceSettings": { @@ -1844,16 +2343,16 @@ "smithy.api#jsonName": "aribSourceSettings" } }, - "Scte20SourceSettings": { - "target": "com.amazonaws.medialive#Scte20SourceSettings", + "DvbSubSourceSettings": { + "target": "com.amazonaws.medialive#DvbSubSourceSettings", "traits": { - "smithy.api#jsonName": "scte20SourceSettings" + "smithy.api#jsonName": "dvbSubSourceSettings" } }, - "EmbeddedSourceSettings": { - "target": "com.amazonaws.medialive#EmbeddedSourceSettings", + "Scte27SourceSettings": { + "target": "com.amazonaws.medialive#Scte27SourceSettings", "traits": { - "smithy.api#jsonName": "embeddedSourceSettings" + "smithy.api#jsonName": "scte27SourceSettings" } }, "TeletextSourceSettings": { @@ -1861,40 +2360,71 @@ "traits": { "smithy.api#jsonName": "teletextSourceSettings" } - } - }, - "traits": { - "smithy.api#documentation": "Caption Selector Settings" - } - }, - "com.amazonaws.medialive#Channel": { - "type": "structure", - "members": { - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", - "traits": { - "smithy.api#jsonName": "inputSpecification" - } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "Scte20SourceSettings": { + "target": "com.amazonaws.medialive#Scte20SourceSettings", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" + "smithy.api#jsonName": "scte20SourceSettings" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "AncillarySourceSettings": { + "target": "com.amazonaws.medialive#AncillarySourceSettings", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#jsonName": "ancillarySourceSettings" } - }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + } + }, + "traits": { + "smithy.api#documentation": "Caption Selector Settings" + } + }, + "com.amazonaws.medialive#CdiInputResolution": { + "type": "string", + "traits": { + "smithy.api#documentation": "Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps", + "smithy.api#enum": [ + { + "value": "SD", + "name": "SD" + }, + { + "value": "HD", + "name": "HD" + }, + { + "value": "FHD", + "name": "FHD" + }, + { + "value": "UHD", + "name": "UHD" + } + ] + } + }, + "com.amazonaws.medialive#CdiInputSpecification": { + "type": "structure", + "members": { + "Resolution": { + "target": "com.amazonaws.medialive#CdiInputResolution", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "Maximum CDI input resolution", + "smithy.api#jsonName": "resolution" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for CdiInputSpecification" + } + }, + "com.amazonaws.medialive#Channel": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" } }, "Arn": { @@ -1904,11 +2434,25 @@ "smithy.api#jsonName": "arn" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", + "smithy.api#jsonName": "destinations" + } + }, + "RoleArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" + } + }, + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", + "traits": { + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, "PipelineDetails": { @@ -1918,10 +2462,24 @@ "smithy.api#jsonName": "pipelineDetails" } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "encoderSettings" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" + } + }, + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", + "traits": { + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" + } + }, + "State": { + "target": "com.amazonaws.medialive#ChannelState", + "traits": { + "smithy.api#jsonName": "state" } }, "ChannelClass": { @@ -1931,6 +2489,13 @@ "smithy.api#jsonName": "channelClass" } }, + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", + "traits": { + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" + } + }, "EgressEndpoints": { "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", "traits": { @@ -1945,13 +2510,6 @@ "smithy.api#jsonName": "tags" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", - "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" - } - }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -1959,17 +2517,17 @@ "smithy.api#jsonName": "name" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", - "smithy.api#jsonName": "destinations" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#jsonName": "encoderSettings" } } }, @@ -2070,86 +2628,94 @@ "smithy.api#jsonName": "destinations" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "The unique arn of the channel.", + "smithy.api#jsonName": "arn" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" } }, - "RoleArn": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" } }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "State": { + "target": "com.amazonaws.medialive#ChannelState", "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" + "smithy.api#jsonName": "state" } }, - "Id": { + "RoleArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" } }, - "Arn": { - "target": "com.amazonaws.medialive#__string", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#documentation": "The unique arn of the channel.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" + } + }, + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", + "traits": { + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } } }, @@ -2238,31 +2804,32 @@ "com.amazonaws.medialive#CreateChannelRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.medialive#__string", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "Name of channel.", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#jsonName": "encoderSettings" + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The log level to write to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "Name of channel.", + "smithy.api#jsonName": "name" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, "RoleArn": { @@ -2279,12 +2846,11 @@ "smithy.api#jsonName": "channelClass" } }, - "RequestId": { - "target": "com.amazonaws.medialive#__string", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "requestId" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, "Reserved": { @@ -2295,18 +2861,19 @@ "smithy.api#jsonName": "reserved" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The log level to write to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "RequestId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)", - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "requestId" } }, "Destinations": { @@ -2314,7 +2881,13 @@ "traits": { "smithy.api#jsonName": "destinations" } - } + }, + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", + "traits": { + "smithy.api#jsonName": "encoderSettings" + } + } }, "traits": { "smithy.api#documentation": "A request to create a channel" @@ -2374,6 +2947,13 @@ "com.amazonaws.medialive#CreateInputRequest": { "type": "structure", "members": { + "RoleArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", + "smithy.api#jsonName": "roleArn" + } + }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { @@ -2381,10 +2961,25 @@ "smithy.api#jsonName": "tags" } }, - "Type": { - "target": "com.amazonaws.medialive#InputType", + "InputSecurityGroups": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#jsonName": "type" + "smithy.api#documentation": "A list of security groups referenced by IDs to attach to the input.", + "smithy.api#jsonName": "inputSecurityGroups" + } + }, + "Destinations": { + "target": "com.amazonaws.medialive#__listOfInputDestinationRequest", + "traits": { + "smithy.api#documentation": "Destination settings for PUSH type inputs.", + "smithy.api#jsonName": "destinations" + } + }, + "MediaConnectFlows": { + "target": "com.amazonaws.medialive#__listOfMediaConnectFlowRequest", + "traits": { + "smithy.api#documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.", + "smithy.api#jsonName": "mediaConnectFlows" } }, "InputDevices": { @@ -2394,18 +2989,10 @@ "smithy.api#jsonName": "inputDevices" } }, - "InputSecurityGroups": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of security groups referenced by IDs to attach to the input.", - "smithy.api#jsonName": "inputSecurityGroups" - } - }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "Type": { + "target": "com.amazonaws.medialive#InputType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", - "smithy.api#jsonName": "roleArn" + "smithy.api#jsonName": "type" } }, "Name": { @@ -2422,11 +3009,12 @@ "smithy.api#jsonName": "sources" } }, - "MediaConnectFlows": { - "target": "com.amazonaws.medialive#__listOfMediaConnectFlowRequest", + "RequestId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.", - "smithy.api#jsonName": "mediaConnectFlows" + "smithy.api#documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "requestId" } }, "Vpc": { @@ -2434,21 +3022,6 @@ "traits": { "smithy.api#jsonName": "vpc" } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfInputDestinationRequest", - "traits": { - "smithy.api#documentation": "Destination settings for PUSH type inputs.", - "smithy.api#jsonName": "destinations" - } - }, - "RequestId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "requestId" - } } }, "traits": { @@ -2631,14 +3204,6 @@ "com.amazonaws.medialive#CreateMultiplexProgramRequest": { "type": "structure", "members": { - "MultiplexId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "ID of the multiplex where the program is to be created.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "MultiplexProgramSettings": { "target": "com.amazonaws.medialive#MultiplexProgramSettings", "traits": { @@ -2663,6 +3228,14 @@ "smithy.api#jsonName": "requestId", "smithy.api#required": {} } + }, + "MultiplexId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "ID of the multiplex where the program is to be created.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -2687,6 +3260,13 @@ "com.amazonaws.medialive#CreateMultiplexRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, "AvailabilityZones": { "target": "com.amazonaws.medialive#__listOf__string", "traits": { @@ -2712,13 +3292,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -2858,59 +3431,45 @@ "com.amazonaws.medialive#DeleteChannelResponse": { "type": "structure", "members": { - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", - "traits": { - "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", - "smithy.api#jsonName": "destinations" - } - }, - "Id": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" - } - }, "EncoderSettings": { "target": "com.amazonaws.medialive#EncoderSettings", "traits": { "smithy.api#jsonName": "encoderSettings" } }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" } }, - "Arn": { + "RoleArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique arn of the channel.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" + "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", + "smithy.api#jsonName": "destinations" } }, "PipelinesRunningCount": { @@ -2920,6 +3479,20 @@ "smithy.api#jsonName": "pipelinesRunningCount" } }, + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "traits": { + "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", + "smithy.api#jsonName": "pipelineDetails" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" + } + }, "State": { "target": "com.amazonaws.medialive#ChannelState", "traits": { @@ -2933,31 +3506,39 @@ "smithy.api#jsonName": "inputAttachments" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "The unique arn of the channel.", + "smithy.api#jsonName": "arn" } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "traits": { + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" } } }, @@ -3183,18 +3764,18 @@ "com.amazonaws.medialive#DeleteMultiplexProgramRequest": { "type": "structure", "members": { - "ProgramName": { + "MultiplexId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The multiplex program name.", + "smithy.api#documentation": "The ID of the multiplex that the program belongs to.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MultiplexId": { + "ProgramName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID of the multiplex that the program belongs to.", + "smithy.api#documentation": "The multiplex program name.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3207,18 +3788,18 @@ "com.amazonaws.medialive#DeleteMultiplexProgramResponse": { "type": "structure", "members": { - "MultiplexProgramSettings": { - "target": "com.amazonaws.medialive#MultiplexProgramSettings", + "PacketIdentifiersMap": { + "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", "traits": { - "smithy.api#documentation": "The settings for this multiplex program.", - "smithy.api#jsonName": "multiplexProgramSettings" + "smithy.api#documentation": "The packet identifier map for this multiplex program.", + "smithy.api#jsonName": "packetIdentifiersMap" } }, - "ChannelId": { - "target": "com.amazonaws.medialive#__string", + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", "traits": { - "smithy.api#documentation": "The MediaLive channel associated with the program.", - "smithy.api#jsonName": "channelId" + "smithy.api#documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.", + "smithy.api#jsonName": "pipelineDetails" } }, "ProgramName": { @@ -3228,11 +3809,18 @@ "smithy.api#jsonName": "programName" } }, - "PacketIdentifiersMap": { - "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", + "MultiplexProgramSettings": { + "target": "com.amazonaws.medialive#MultiplexProgramSettings", "traits": { - "smithy.api#documentation": "The packet identifier map for this multiplex program.", - "smithy.api#jsonName": "packetIdentifiersMap" + "smithy.api#documentation": "The settings for this multiplex program.", + "smithy.api#jsonName": "multiplexProgramSettings" + } + }, + "ChannelId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The MediaLive channel associated with the program.", + "smithy.api#jsonName": "channelId" } } }, @@ -3266,6 +3854,13 @@ "smithy.api#jsonName": "tags" } }, + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", + "traits": { + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" + } + }, "AvailabilityZones": { "target": "com.amazonaws.medialive#__listOf__string", "traits": { @@ -3273,13 +3868,6 @@ "smithy.api#jsonName": "availabilityZones" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" - } - }, "Destinations": { "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { @@ -3287,25 +3875,25 @@ "smithy.api#jsonName": "destinations" } }, - "State": { - "target": "com.amazonaws.medialive#MultiplexState", - "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" } }, - "Arn": { - "target": "com.amazonaws.medialive#__string", + "State": { + "target": "com.amazonaws.medialive#MultiplexState", "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" } }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" } }, "PipelinesRunningCount": { @@ -3315,18 +3903,18 @@ "smithy.api#jsonName": "pipelinesRunningCount" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" } } }, @@ -3396,18 +3984,18 @@ "com.amazonaws.medialive#DeleteReservationResponse": { "type": "structure", "members": { - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } }, - "Start": { + "OfferingId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", - "smithy.api#jsonName": "start" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, "End": { @@ -3424,32 +4012,18 @@ "smithy.api#jsonName": "arn" } }, - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" - } - }, - "Region": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" - } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#documentation": "A collection of key-value pairs", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" } }, - "OfferingDescription": { + "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" + "smithy.api#documentation": "User specified reservation name", + "smithy.api#jsonName": "name" } }, "ReservationId": { @@ -3459,18 +4033,18 @@ "smithy.api#jsonName": "reservationId" } }, - "CurrencyCode": { - "target": "com.amazonaws.medialive#__string", + "Duration": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, - "DurationUnits": { - "target": "com.amazonaws.medialive#OfferingDurationUnits", + "Count": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", - "smithy.api#jsonName": "durationUnits" + "smithy.api#documentation": "Number of reserved resources", + "smithy.api#jsonName": "count" } }, "State": { @@ -3480,46 +4054,60 @@ "smithy.api#jsonName": "state" } }, - "Name": { + "OfferingDescription": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "User specified reservation name", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" } }, - "UsagePrice": { + "CurrencyCode": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" + } + }, + "FixedPrice": { "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" + "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#jsonName": "tags" } }, - "Count": { - "target": "com.amazonaws.medialive#__integer", + "DurationUnits": { + "target": "com.amazonaws.medialive#OfferingDurationUnits", "traits": { - "smithy.api#documentation": "Number of reserved resources", - "smithy.api#jsonName": "count" + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", + "smithy.api#jsonName": "durationUnits" } }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "Region": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" + } + }, + "Start": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'", + "smithy.api#jsonName": "start" } } }, @@ -3700,18 +4288,11 @@ "com.amazonaws.medialive#DescribeChannelResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique arn of the channel.", - "smithy.api#jsonName": "arn" - } - }, - "RoleArn": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" } }, "Destinations": { @@ -3721,87 +4302,102 @@ "smithy.api#jsonName": "destinations" } }, + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", + "traits": { + "smithy.api#jsonName": "encoderSettings" + } + }, "InputSpecification": { "target": "com.amazonaws.medialive#InputSpecification", "traits": { + "smithy.api#documentation": "Specification of network and file inputs for this channel", "smithy.api#jsonName": "inputSpecification" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "RoleArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" } }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "State": { + "target": "com.amazonaws.medialive#ChannelState", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#jsonName": "state" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfPipelineDetail", "traits": { - "smithy.api#jsonName": "encoderSettings" + "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", + "smithy.api#jsonName": "pipelineDetails" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" } - } + }, + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique arn of the channel.", + "smithy.api#jsonName": "arn" + } + } }, "traits": { "smithy.api#documentation": "Placeholder documentation for DescribeChannelResponse" @@ -3913,6 +4509,20 @@ "smithy.api#jsonName": "macAddress" } }, + "HdDeviceSettings": { + "target": "com.amazonaws.medialive#InputDeviceHdSettings", + "traits": { + "smithy.api#documentation": "Settings that describe an input device that is type HD.", + "smithy.api#jsonName": "hdDeviceSettings" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "A name that you specify for the input device.", + "smithy.api#jsonName": "name" + } + }, "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -3920,6 +4530,13 @@ "smithy.api#jsonName": "arn" } }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#jsonName": "id" + } + }, "ConnectionState": { "target": "com.amazonaws.medialive#InputDeviceConnectionState", "traits": { @@ -3927,11 +4544,18 @@ "smithy.api#jsonName": "connectionState" } }, - "Id": { + "Type": { + "target": "com.amazonaws.medialive#InputDeviceType", + "traits": { + "smithy.api#documentation": "The type of the input device.", + "smithy.api#jsonName": "type" + } + }, + "SerialNumber": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The unique serial number of the input device.", + "smithy.api#jsonName": "serialNumber" } }, "NetworkSettings": { @@ -3941,40 +4565,12 @@ "smithy.api#jsonName": "networkSettings" } }, - "SerialNumber": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique serial number of the input device.", - "smithy.api#jsonName": "serialNumber" - } - }, "DeviceSettingsSyncState": { "target": "com.amazonaws.medialive#DeviceSettingsSyncState", "traits": { "smithy.api#documentation": "The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.", "smithy.api#jsonName": "deviceSettingsSyncState" } - }, - "Type": { - "target": "com.amazonaws.medialive#InputDeviceType", - "traits": { - "smithy.api#documentation": "The type of the input device.", - "smithy.api#jsonName": "type" - } - }, - "HdDeviceSettings": { - "target": "com.amazonaws.medialive#InputDeviceHdSettings", - "traits": { - "smithy.api#documentation": "Settings that describe an input device that is type HD.", - "smithy.api#jsonName": "hdDeviceSettings" - } - }, - "Name": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "A name that you specify for the input device.", - "smithy.api#jsonName": "name" - } } }, "traits": { @@ -4024,14 +4620,6 @@ "com.amazonaws.medialive#DescribeInputDeviceThumbnailRequest": { "type": "structure", "members": { - "InputDeviceId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "Accept": { "target": "com.amazonaws.medialive#AcceptHeader", "traits": { @@ -4039,6 +4627,14 @@ "smithy.api#httpHeader": "accept", "smithy.api#required": {} } + }, + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -4048,20 +4644,6 @@ "com.amazonaws.medialive#DescribeInputDeviceThumbnailResponse": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.medialive#ContentType", - "traits": { - "smithy.api#documentation": "Specifies the media type of the thumbnail.", - "smithy.api#httpHeader": "Content-Type" - } - }, - "ContentLength": { - "target": "com.amazonaws.medialive#__long", - "traits": { - "smithy.api#documentation": "The length of the content.", - "smithy.api#httpHeader": "Content-Length" - } - }, "ETag": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -4069,6 +4651,13 @@ "smithy.api#httpHeader": "ETag" } }, + "ContentType": { + "target": "com.amazonaws.medialive#ContentType", + "traits": { + "smithy.api#documentation": "Specifies the media type of the thumbnail.", + "smithy.api#httpHeader": "Content-Type" + } + }, "LastModified": { "target": "com.amazonaws.medialive#__timestamp", "traits": { @@ -4083,6 +4672,13 @@ "smithy.api#httpPayload": {}, "smithy.api#jsonName": "body" } + }, + "ContentLength": { + "target": "com.amazonaws.medialive#__long", + "traits": { + "smithy.api#documentation": "The length of the content.", + "smithy.api#httpHeader": "Content-Length" + } } }, "traits": { @@ -4108,12 +4704,6 @@ "com.amazonaws.medialive#DescribeInputResponse": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.medialive#InputType", - "traits": { - "smithy.api#jsonName": "type" - } - }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { @@ -4121,18 +4711,24 @@ "smithy.api#jsonName": "tags" } }, - "MediaConnectFlows": { - "target": "com.amazonaws.medialive#__listOfMediaConnectFlow", + "Type": { + "target": "com.amazonaws.medialive#InputType", "traits": { - "smithy.api#documentation": "A list of MediaConnect Flows for this input.", - "smithy.api#jsonName": "mediaConnectFlows" + "smithy.api#jsonName": "type" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "SecurityGroups": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "The generated ID of the input (unique for user account, immutable).", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", + "smithy.api#jsonName": "securityGroups" + } + }, + "Sources": { + "target": "com.amazonaws.medialive#__listOfInputSource", + "traits": { + "smithy.api#documentation": "A list of the sources of the input (PULL-type).", + "smithy.api#jsonName": "sources" } }, "RoleArn": { @@ -4142,24 +4738,11 @@ "smithy.api#jsonName": "roleArn" } }, - "State": { - "target": "com.amazonaws.medialive#InputState", - "traits": { - "smithy.api#jsonName": "state" - } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfInputDestination", - "traits": { - "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", - "smithy.api#jsonName": "destinations" - } - }, - "InputSourceType": { - "target": "com.amazonaws.medialive#InputSourceType", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE inputs.", - "smithy.api#jsonName": "inputSourceType" + "smithy.api#documentation": "The Unique ARN of the input (generated, immutable).", + "smithy.api#jsonName": "arn" } }, "InputDevices": { @@ -4176,11 +4759,10 @@ "smithy.api#jsonName": "name" } }, - "InputClass": { - "target": "com.amazonaws.medialive#InputClass", + "State": { + "target": "com.amazonaws.medialive#InputState", "traits": { - "smithy.api#documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.", - "smithy.api#jsonName": "inputClass" + "smithy.api#jsonName": "state" } }, "AttachedChannels": { @@ -4190,25 +4772,39 @@ "smithy.api#jsonName": "attachedChannels" } }, - "Sources": { - "target": "com.amazonaws.medialive#__listOfInputSource", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfInputDestination", "traits": { - "smithy.api#documentation": "A list of the sources of the input (PULL-type).", - "smithy.api#jsonName": "sources" + "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", + "smithy.api#jsonName": "destinations" } }, - "Arn": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The Unique ARN of the input (generated, immutable).", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The generated ID of the input (unique for user account, immutable).", + "smithy.api#jsonName": "id" } }, - "SecurityGroups": { - "target": "com.amazonaws.medialive#__listOf__string", + "MediaConnectFlows": { + "target": "com.amazonaws.medialive#__listOfMediaConnectFlow", "traits": { - "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", - "smithy.api#jsonName": "securityGroups" + "smithy.api#documentation": "A list of MediaConnect Flows for this input.", + "smithy.api#jsonName": "mediaConnectFlows" + } + }, + "InputSourceType": { + "target": "com.amazonaws.medialive#InputSourceType", + "traits": { + "smithy.api#documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE inputs.", + "smithy.api#jsonName": "inputSourceType" + } + }, + "InputClass": { + "target": "com.amazonaws.medialive#InputClass", + "traits": { + "smithy.api#documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.", + "smithy.api#jsonName": "inputClass" } } }, @@ -4275,11 +4871,18 @@ "com.amazonaws.medialive#DescribeInputSecurityGroupResponse": { "type": "structure", "members": { - "Arn": { + "State": { + "target": "com.amazonaws.medialive#InputSecurityGroupState", + "traits": { + "smithy.api#documentation": "The current state of the Input Security Group.", + "smithy.api#jsonName": "state" + } + }, + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique ARN of Input Security Group", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The Id of the Input Security Group", + "smithy.api#jsonName": "id" } }, "WhitelistRules": { @@ -4303,18 +4906,11 @@ "smithy.api#jsonName": "inputs" } }, - "State": { - "target": "com.amazonaws.medialive#InputSecurityGroupState", - "traits": { - "smithy.api#documentation": "The current state of the Input Security Group.", - "smithy.api#jsonName": "state" - } - }, - "Id": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The Id of the Input Security Group", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Unique ARN of Input Security Group", + "smithy.api#jsonName": "arn" } } }, @@ -4450,6 +5046,13 @@ "smithy.api#jsonName": "multiplexProgramSettings" } }, + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", + "traits": { + "smithy.api#documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.", + "smithy.api#jsonName": "pipelineDetails" + } + }, "PacketIdentifiersMap": { "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", "traits": { @@ -4481,25 +5084,18 @@ "com.amazonaws.medialive#DescribeMultiplexResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" } }, - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A list of availability zones for the multiplex.", - "smithy.api#jsonName": "availabilityZones" - } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", - "traits": { - "smithy.api#documentation": "A list of the multiplex output destinations.", - "smithy.api#jsonName": "destinations" + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" } }, "State": { @@ -4509,18 +5105,11 @@ "smithy.api#jsonName": "state" } }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" - } - }, - "Arn": { - "target": "com.amazonaws.medialive#__string", + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "A list of availability zones for the multiplex.", + "smithy.api#jsonName": "availabilityZones" } }, "Name": { @@ -4537,18 +5126,32 @@ "smithy.api#jsonName": "pipelinesRunningCount" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#documentation": "A list of the multiplex output destinations.", + "smithy.api#jsonName": "destinations" } }, - "Id": { + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" + } + }, + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" } } }, @@ -4615,25 +5218,11 @@ "com.amazonaws.medialive#DescribeOfferingResponse": { "type": "structure", "members": { - "Duration": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" - } - }, - "Region": { + "OfferingId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" - } - }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", - "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, "OfferingDescription": { @@ -4643,13 +5232,6 @@ "smithy.api#jsonName": "offeringDescription" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" - } - }, "CurrencyCode": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -4657,18 +5239,11 @@ "smithy.api#jsonName": "currencyCode" } }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", - "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" - } - }, - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, "DurationUnits": { @@ -4685,11 +5260,39 @@ "smithy.api#jsonName": "arn" } }, - "FixedPrice": { + "Region": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" + } + }, + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "traits": { + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" + } + }, + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", + "traits": { + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" + } + }, + "Duration": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" + } + }, + "UsagePrice": { "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } } }, @@ -4756,18 +5359,18 @@ "com.amazonaws.medialive#DescribeReservationResponse": { "type": "structure", "members": { - "Count": { - "target": "com.amazonaws.medialive#__integer", + "Region": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Number of reserved resources", - "smithy.api#jsonName": "count" + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" } }, - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" + "smithy.api#documentation": "User specified reservation name", + "smithy.api#jsonName": "name" } }, "State": { @@ -4777,25 +5380,18 @@ "smithy.api#jsonName": "state" } }, - "DurationUnits": { - "target": "com.amazonaws.medialive#OfferingDurationUnits", - "traits": { - "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", - "smithy.api#jsonName": "durationUnits" - } - }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "Count": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "User specified reservation name", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Number of reserved resources", + "smithy.api#jsonName": "count" } }, - "Region": { + "CurrencyCode": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" } }, "OfferingType": { @@ -4805,25 +5401,32 @@ "smithy.api#jsonName": "offeringType" } }, - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "DurationUnits": { + "target": "com.amazonaws.medialive#OfferingDurationUnits", "traits": { - "smithy.api#documentation": "A collection of key-value pairs", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Units for duration, e.g. 'MONTHS'", + "smithy.api#jsonName": "durationUnits" } }, - "OfferingDescription": { - "target": "com.amazonaws.medialive#__string", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" + } + }, + "Duration": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, "ReservationId": { @@ -4840,46 +5443,46 @@ "smithy.api#jsonName": "start" } }, - "End": { + "OfferingDescription": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", - "smithy.api#jsonName": "end" + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } }, - "Arn": { - "target": "com.amazonaws.medialive#__string", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#jsonName": "tags" } }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", + "End": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" + "smithy.api#documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'", + "smithy.api#jsonName": "end" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", + "OfferingId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, - "CurrencyCode": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" + "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", + "smithy.api#jsonName": "arn" } } }, @@ -4924,12 +5527,24 @@ "method": "GET", "uri": "/prod/channels/{ChannelId}/schedule", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduleActions", + "pageSize": "MaxResults" } } }, "com.amazonaws.medialive#DescribeScheduleRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + }, "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -4943,12 +5558,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", - "traits": { - "smithy.api#httpQuery": "maxResults" - } } }, "traits": { @@ -4996,14 +5605,6 @@ "com.amazonaws.medialive#DvbNitSettings": { "type": "structure", "members": { - "NetworkName": { - "target": "com.amazonaws.medialive#__stringMin1Max256", - "traits": { - "smithy.api#documentation": "The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "networkName", - "smithy.api#required": {} - } - }, "RepInterval": { "target": "com.amazonaws.medialive#__integerMin25Max10000", "traits": { @@ -5018,6 +5619,14 @@ "smithy.api#jsonName": "networkId", "smithy.api#required": {} } + }, + "NetworkName": { + "target": "com.amazonaws.medialive#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "networkName", + "smithy.api#required": {} + } } }, "traits": { @@ -5051,13 +5660,6 @@ "com.amazonaws.medialive#DvbSdtSettings": { "type": "structure", "members": { - "OutputSdt": { - "target": "com.amazonaws.medialive#DvbSdtOutputSdt", - "traits": { - "smithy.api#documentation": "Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.", - "smithy.api#jsonName": "outputSdt" - } - }, "ServiceProviderName": { "target": "com.amazonaws.medialive#__stringMin1Max256", "traits": { @@ -5065,11 +5667,11 @@ "smithy.api#jsonName": "serviceProviderName" } }, - "ServiceName": { - "target": "com.amazonaws.medialive#__stringMin1Max256", + "OutputSdt": { + "target": "com.amazonaws.medialive#DvbSdtOutputSdt", "traits": { - "smithy.api#documentation": "The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "serviceName" + "smithy.api#documentation": "Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.", + "smithy.api#jsonName": "outputSdt" } }, "RepInterval": { @@ -5078,6 +5680,13 @@ "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", "smithy.api#jsonName": "repInterval" } + }, + "ServiceName": { + "target": "com.amazonaws.medialive#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "serviceName" + } } }, "traits": { @@ -5191,6 +5800,20 @@ "com.amazonaws.medialive#DvbSubDestinationSettings": { "type": "structure", "members": { + "BackgroundColor": { + "target": "com.amazonaws.medialive#DvbSubDestinationBackgroundColor", + "traits": { + "smithy.api#documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundColor" + } + }, + "YPosition": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "yPosition" + } + }, "XPosition": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { @@ -5205,18 +5828,11 @@ "smithy.api#jsonName": "fontSize" } }, - "Font": { - "target": "com.amazonaws.medialive#InputLocation", - "traits": { - "smithy.api#documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "font" - } - }, - "BackgroundColor": { - "target": "com.amazonaws.medialive#DvbSubDestinationBackgroundColor", + "BackgroundOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundColor" + "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundOpacity" } }, "Alignment": { @@ -5226,39 +5842,39 @@ "smithy.api#jsonName": "alignment" } }, - "ShadowXOffset": { + "ShadowYOffset": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowXOffset" + "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowYOffset" } }, - "OutlineSize": { - "target": "com.amazonaws.medialive#__integerMin0Max10", + "ShadowOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "outlineSize" + "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowOpacity" } }, - "BackgroundOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "Font": { + "target": "com.amazonaws.medialive#InputLocation", "traits": { - "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundOpacity" + "smithy.api#documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "font" } }, - "TeletextGridControl": { - "target": "com.amazonaws.medialive#DvbSubDestinationTeletextGridControl", + "ShadowColor": { + "target": "com.amazonaws.medialive#DvbSubDestinationShadowColor", "traits": { - "smithy.api#documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.", - "smithy.api#jsonName": "teletextGridControl" + "smithy.api#documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowColor" } }, - "YPosition": { - "target": "com.amazonaws.medialive#__integerMin0", + "FontColor": { + "target": "com.amazonaws.medialive#DvbSubDestinationFontColor", "traits": { - "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "yPosition" + "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontColor" } }, "FontResolution": { @@ -5275,39 +5891,32 @@ "smithy.api#jsonName": "outlineColor" } }, - "FontOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", - "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontOpacity" - } - }, - "FontColor": { - "target": "com.amazonaws.medialive#DvbSubDestinationFontColor", + "ShadowXOffset": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontColor" + "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowXOffset" } }, - "ShadowOpacity": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "OutlineSize": { + "target": "com.amazonaws.medialive#__integerMin0Max10", "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowOpacity" + "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "outlineSize" } }, - "ShadowYOffset": { - "target": "com.amazonaws.medialive#__integer", + "TeletextGridControl": { + "target": "com.amazonaws.medialive#DvbSubDestinationTeletextGridControl", "traits": { - "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowYOffset" + "smithy.api#documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.", + "smithy.api#jsonName": "teletextGridControl" } }, - "ShadowColor": { - "target": "com.amazonaws.medialive#DvbSubDestinationShadowColor", + "FontOpacity": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowColor" + "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontOpacity" } } }, @@ -5608,18 +6217,11 @@ "com.amazonaws.medialive#Eac3Settings": { "type": "structure", "members": { - "DcFilter": { - "target": "com.amazonaws.medialive#Eac3DcFilter", - "traits": { - "smithy.api#documentation": "When set to enabled, activates a DC highpass filter for all input channels.", - "smithy.api#jsonName": "dcFilter" - } - }, - "LoRoCenterMixLevel": { + "Bitrate": { "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "loRoCenterMixLevel" + "smithy.api#documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.", + "smithy.api#jsonName": "bitrate" } }, "LtRtSurroundMixLevel": { @@ -5629,39 +6231,60 @@ "smithy.api#jsonName": "ltRtSurroundMixLevel" } }, - "SurroundExMode": { - "target": "com.amazonaws.medialive#Eac3SurroundExMode", + "LoRoSurroundMixLevel": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", - "smithy.api#jsonName": "surroundExMode" + "smithy.api#documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "loRoSurroundMixLevel" } }, - "PassthroughControl": { - "target": "com.amazonaws.medialive#Eac3PassthroughControl", + "LtRtCenterMixLevel": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.", - "smithy.api#jsonName": "passthroughControl" + "smithy.api#documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "ltRtCenterMixLevel" } }, - "BitstreamMode": { - "target": "com.amazonaws.medialive#Eac3BitstreamMode", + "MetadataControl": { + "target": "com.amazonaws.medialive#Eac3MetadataControl", "traits": { - "smithy.api#documentation": "Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.", - "smithy.api#jsonName": "bitstreamMode" + "smithy.api#documentation": "When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", + "smithy.api#jsonName": "metadataControl" } }, - "DrcRf": { - "target": "com.amazonaws.medialive#Eac3DrcRf", + "DrcLine": { + "target": "com.amazonaws.medialive#Eac3DrcLine", "traits": { - "smithy.api#documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.", - "smithy.api#jsonName": "drcRf" + "smithy.api#documentation": "Sets the Dolby dynamic range compression profile.", + "smithy.api#jsonName": "drcLine" } }, - "AttenuationControl": { - "target": "com.amazonaws.medialive#Eac3AttenuationControl", + "LfeControl": { + "target": "com.amazonaws.medialive#Eac3LfeControl", "traits": { - "smithy.api#documentation": "When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "attenuationControl" + "smithy.api#documentation": "When encoding 3/2 audio, setting to lfe enables the LFE channel", + "smithy.api#jsonName": "lfeControl" + } + }, + "LfeFilter": { + "target": "com.amazonaws.medialive#Eac3LfeFilter", + "traits": { + "smithy.api#documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.", + "smithy.api#jsonName": "lfeFilter" + } + }, + "PhaseControl": { + "target": "com.amazonaws.medialive#Eac3PhaseControl", + "traits": { + "smithy.api#documentation": "When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "phaseControl" + } + }, + "SurroundMode": { + "target": "com.amazonaws.medialive#Eac3SurroundMode", + "traits": { + "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", + "smithy.api#jsonName": "surroundMode" } }, "CodingMode": { @@ -5671,11 +6294,11 @@ "smithy.api#jsonName": "codingMode" } }, - "DrcLine": { - "target": "com.amazonaws.medialive#Eac3DrcLine", + "PassthroughControl": { + "target": "com.amazonaws.medialive#Eac3PassthroughControl", "traits": { - "smithy.api#documentation": "Sets the Dolby dynamic range compression profile.", - "smithy.api#jsonName": "drcLine" + "smithy.api#documentation": "When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.", + "smithy.api#jsonName": "passthroughControl" } }, "Dialnorm": { @@ -5685,11 +6308,18 @@ "smithy.api#jsonName": "dialnorm" } }, - "PhaseControl": { - "target": "com.amazonaws.medialive#Eac3PhaseControl", + "DrcRf": { + "target": "com.amazonaws.medialive#Eac3DrcRf", "traits": { - "smithy.api#documentation": "When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "phaseControl" + "smithy.api#documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.", + "smithy.api#jsonName": "drcRf" + } + }, + "BitstreamMode": { + "target": "com.amazonaws.medialive#Eac3BitstreamMode", + "traits": { + "smithy.api#documentation": "Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.", + "smithy.api#jsonName": "bitstreamMode" } }, "StereoDownmix": { @@ -5699,53 +6329,32 @@ "smithy.api#jsonName": "stereoDownmix" } }, - "SurroundMode": { - "target": "com.amazonaws.medialive#Eac3SurroundMode", - "traits": { - "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", - "smithy.api#jsonName": "surroundMode" - } - }, - "LtRtCenterMixLevel": { + "LoRoCenterMixLevel": { "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "ltRtCenterMixLevel" + "smithy.api#documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "loRoCenterMixLevel" } }, - "LfeFilter": { - "target": "com.amazonaws.medialive#Eac3LfeFilter", + "SurroundExMode": { + "target": "com.amazonaws.medialive#Eac3SurroundExMode", "traits": { - "smithy.api#documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.", - "smithy.api#jsonName": "lfeFilter" + "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", + "smithy.api#jsonName": "surroundExMode" } }, - "LoRoSurroundMixLevel": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "loRoSurroundMixLevel" - } - }, - "Bitrate": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode.", - "smithy.api#jsonName": "bitrate" - } - }, - "MetadataControl": { - "target": "com.amazonaws.medialive#Eac3MetadataControl", + "AttenuationControl": { + "target": "com.amazonaws.medialive#Eac3AttenuationControl", "traits": { - "smithy.api#documentation": "When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", - "smithy.api#jsonName": "metadataControl" + "smithy.api#documentation": "When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "attenuationControl" } }, - "LfeControl": { - "target": "com.amazonaws.medialive#Eac3LfeControl", + "DcFilter": { + "target": "com.amazonaws.medialive#Eac3DcFilter", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, setting to lfe enables the LFE channel", - "smithy.api#jsonName": "lfeControl" + "smithy.api#documentation": "When set to enabled, activates a DC highpass filter for all input channels.", + "smithy.api#jsonName": "dcFilter" } } }, @@ -5934,6 +6543,13 @@ "smithy.api#jsonName": "source608ChannelNumber" } }, + "Source608TrackNumber": { + "target": "com.amazonaws.medialive#__integerMin1Max5", + "traits": { + "smithy.api#documentation": "This field is unused and deprecated.", + "smithy.api#jsonName": "source608TrackNumber" + } + }, "Scte20Detection": { "target": "com.amazonaws.medialive#EmbeddedScte20Detection", "traits": { @@ -5947,13 +6563,6 @@ "smithy.api#documentation": "If upconvert, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.", "smithy.api#jsonName": "convert608To708" } - }, - "Source608TrackNumber": { - "target": "com.amazonaws.medialive#__integerMin1Max5", - "traits": { - "smithy.api#documentation": "This field is unused and deprecated.", - "smithy.api#jsonName": "source608TrackNumber" - } } }, "traits": { @@ -5963,11 +6572,11 @@ "com.amazonaws.medialive#EncoderSettings": { "type": "structure", "members": { - "AudioDescriptions": { - "target": "com.amazonaws.medialive#__listOfAudioDescription", + "AvailBlanking": { + "target": "com.amazonaws.medialive#AvailBlanking", "traits": { - "smithy.api#jsonName": "audioDescriptions", - "smithy.api#required": {} + "smithy.api#documentation": "Settings for ad avail blanking.", + "smithy.api#jsonName": "availBlanking" } }, "NielsenConfiguration": { @@ -5977,20 +6586,6 @@ "smithy.api#jsonName": "nielsenConfiguration" } }, - "GlobalConfiguration": { - "target": "com.amazonaws.medialive#GlobalConfiguration", - "traits": { - "smithy.api#documentation": "Configuration settings that apply to the event as a whole.", - "smithy.api#jsonName": "globalConfiguration" - } - }, - "VideoDescriptions": { - "target": "com.amazonaws.medialive#__listOfVideoDescription", - "traits": { - "smithy.api#jsonName": "videoDescriptions", - "smithy.api#required": {} - } - }, "AvailConfiguration": { "target": "com.amazonaws.medialive#AvailConfiguration", "traits": { @@ -5998,20 +6593,13 @@ "smithy.api#jsonName": "availConfiguration" } }, - "OutputGroups": { - "target": "com.amazonaws.medialive#__listOfOutputGroup", + "AudioDescriptions": { + "target": "com.amazonaws.medialive#__listOfAudioDescription", "traits": { - "smithy.api#jsonName": "outputGroups", + "smithy.api#jsonName": "audioDescriptions", "smithy.api#required": {} } }, - "CaptionDescriptions": { - "target": "com.amazonaws.medialive#__listOfCaptionDescription", - "traits": { - "smithy.api#documentation": "Settings for caption decriptions", - "smithy.api#jsonName": "captionDescriptions" - } - }, "FeatureActivations": { "target": "com.amazonaws.medialive#FeatureActivations", "traits": { @@ -6019,19 +6607,18 @@ "smithy.api#jsonName": "featureActivations" } }, - "TimecodeConfig": { - "target": "com.amazonaws.medialive#TimecodeConfig", + "VideoDescriptions": { + "target": "com.amazonaws.medialive#__listOfVideoDescription", "traits": { - "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", - "smithy.api#jsonName": "timecodeConfig", + "smithy.api#jsonName": "videoDescriptions", "smithy.api#required": {} } }, - "AvailBlanking": { - "target": "com.amazonaws.medialive#AvailBlanking", + "GlobalConfiguration": { + "target": "com.amazonaws.medialive#GlobalConfiguration", "traits": { - "smithy.api#documentation": "Settings for ad avail blanking.", - "smithy.api#jsonName": "availBlanking" + "smithy.api#documentation": "Configuration settings that apply to the event as a whole.", + "smithy.api#jsonName": "globalConfiguration" } }, "BlackoutSlate": { @@ -6040,6 +6627,28 @@ "smithy.api#documentation": "Settings for blackout slate.", "smithy.api#jsonName": "blackoutSlate" } + }, + "OutputGroups": { + "target": "com.amazonaws.medialive#__listOfOutputGroup", + "traits": { + "smithy.api#jsonName": "outputGroups", + "smithy.api#required": {} + } + }, + "TimecodeConfig": { + "target": "com.amazonaws.medialive#TimecodeConfig", + "traits": { + "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", + "smithy.api#jsonName": "timecodeConfig", + "smithy.api#required": {} + } + }, + "CaptionDescriptions": { + "target": "com.amazonaws.medialive#__listOfCaptionDescription", + "traits": { + "smithy.api#documentation": "Settings for caption decriptions", + "smithy.api#jsonName": "captionDescriptions" + } } }, "traits": { @@ -6096,11 +6705,11 @@ "com.amazonaws.medialive#FecOutputSettings": { "type": "structure", "members": { - "ColumnDepth": { - "target": "com.amazonaws.medialive#__integerMin4Max20", + "IncludeFec": { + "target": "com.amazonaws.medialive#FecOutputIncludeFec", "traits": { - "smithy.api#documentation": "Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.", - "smithy.api#jsonName": "columnDepth" + "smithy.api#documentation": "Enables column only or column and row based FEC", + "smithy.api#jsonName": "includeFec" } }, "RowLength": { @@ -6110,11 +6719,11 @@ "smithy.api#jsonName": "rowLength" } }, - "IncludeFec": { - "target": "com.amazonaws.medialive#FecOutputIncludeFec", + "ColumnDepth": { + "target": "com.amazonaws.medialive#__integerMin4Max20", "traits": { - "smithy.api#documentation": "Enables column only or column and row based FEC", - "smithy.api#jsonName": "includeFec" + "smithy.api#documentation": "Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.", + "smithy.api#jsonName": "columnDepth" } } }, @@ -6193,13 +6802,6 @@ "com.amazonaws.medialive#Fmp4HlsSettings": { "type": "structure", "members": { - "NielsenId3Behavior": { - "target": "com.amazonaws.medialive#Fmp4NielsenId3Behavior", - "traits": { - "smithy.api#documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", - "smithy.api#jsonName": "nielsenId3Behavior" - } - }, "AudioRenditionSets": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -6213,6 +6815,13 @@ "smithy.api#documentation": "When set to passthrough, timed metadata is passed through from input to output.", "smithy.api#jsonName": "timedMetadataBehavior" } + }, + "NielsenId3Behavior": { + "target": "com.amazonaws.medialive#Fmp4NielsenId3Behavior", + "traits": { + "smithy.api#documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "smithy.api#jsonName": "nielsenId3Behavior" + } } }, "traits": { @@ -6254,14 +6863,6 @@ "com.amazonaws.medialive#FollowModeScheduleActionStartSettings": { "type": "structure", "members": { - "ReferenceActionName": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The action name of another action that this one refers to.", - "smithy.api#jsonName": "referenceActionName", - "smithy.api#required": {} - } - }, "FollowPoint": { "target": "com.amazonaws.medialive#FollowPoint", "traits": { @@ -6269,6 +6870,14 @@ "smithy.api#jsonName": "followPoint", "smithy.api#required": {} } + }, + "ReferenceActionName": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The action name of another action that this one refers to.", + "smithy.api#jsonName": "referenceActionName", + "smithy.api#required": {} + } } }, "traits": { @@ -6313,7 +6922,7 @@ "Destination": { "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { - "smithy.api#documentation": "The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, \"curling_\") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg", + "smithy.api#documentation": "The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, \"curling-\") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg", "smithy.api#jsonName": "destination", "smithy.api#required": {} } @@ -6357,13 +6966,6 @@ "com.amazonaws.medialive#FrameCaptureSettings": { "type": "structure", "members": { - "CaptureIntervalUnits": { - "target": "com.amazonaws.medialive#FrameCaptureIntervalUnit", - "traits": { - "smithy.api#documentation": "Unit for the frame capture interval.", - "smithy.api#jsonName": "captureIntervalUnits" - } - }, "CaptureInterval": { "target": "com.amazonaws.medialive#__integerMin1Max3600000", "traits": { @@ -6371,6 +6973,13 @@ "smithy.api#jsonName": "captureInterval", "smithy.api#required": {} } + }, + "CaptureIntervalUnits": { + "target": "com.amazonaws.medialive#FrameCaptureIntervalUnit", + "traits": { + "smithy.api#documentation": "Unit for the frame capture interval.", + "smithy.api#jsonName": "captureIntervalUnits" + } } }, "traits": { @@ -6396,11 +7005,11 @@ "com.amazonaws.medialive#GlobalConfiguration": { "type": "structure", "members": { - "OutputTimingSource": { - "target": "com.amazonaws.medialive#GlobalConfigurationOutputTimingSource", + "InputEndAction": { + "target": "com.amazonaws.medialive#GlobalConfigurationInputEndAction", "traits": { - "smithy.api#documentation": "Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.", - "smithy.api#jsonName": "outputTimingSource" + "smithy.api#documentation": "Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When \"none\" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the \"Input Loss Behavior\" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).", + "smithy.api#jsonName": "inputEndAction" } }, "SupportLowFramerateInputs": { @@ -6417,6 +7026,13 @@ "smithy.api#jsonName": "initialAudioGain" } }, + "OutputTimingSource": { + "target": "com.amazonaws.medialive#GlobalConfigurationOutputTimingSource", + "traits": { + "smithy.api#documentation": "Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.", + "smithy.api#jsonName": "outputTimingSource" + } + }, "OutputLockingMode": { "target": "com.amazonaws.medialive#GlobalConfigurationOutputLockingMode", "traits": { @@ -6430,13 +7046,6 @@ "smithy.api#documentation": "Settings for system actions when input is lost.", "smithy.api#jsonName": "inputLossBehavior" } - }, - "InputEndAction": { - "target": "com.amazonaws.medialive#GlobalConfigurationInputEndAction", - "traits": { - "smithy.api#documentation": "Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When \"none\" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the \"Input Loss Behavior\" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).", - "smithy.api#jsonName": "inputEndAction" - } } }, "traits": { @@ -6910,102 +7519,88 @@ "com.amazonaws.medialive#H264Settings": { "type": "structure", "members": { - "ColorSpaceSettings": { - "target": "com.amazonaws.medialive#H264ColorSpaceSettings", + "Profile": { + "target": "com.amazonaws.medialive#H264Profile", "traits": { - "smithy.api#documentation": "Color Space settings", - "smithy.api#jsonName": "colorSpaceSettings" + "smithy.api#documentation": "H.264 Profile.", + "smithy.api#jsonName": "profile" } }, - "Softness": { - "target": "com.amazonaws.medialive#__integerMin0Max128", + "FlickerAq": { + "target": "com.amazonaws.medialive#H264FlickerAq", "traits": { - "smithy.api#documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.", - "smithy.api#jsonName": "softness" + "smithy.api#documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "smithy.api#jsonName": "flickerAq" } }, - "GopBReference": { - "target": "com.amazonaws.medialive#H264GopBReference", + "QvbrQualityLevel": { + "target": "com.amazonaws.medialive#__integerMin1Max10", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "gopBReference" + "smithy.api#documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M", + "smithy.api#jsonName": "qvbrQualityLevel" } }, - "ParDenominator": { - "target": "com.amazonaws.medialive#__integerMin1", + "LookAheadRateControl": { + "target": "com.amazonaws.medialive#H264LookAheadRateControl", "traits": { - "smithy.api#documentation": "Pixel Aspect Ratio denominator.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", + "smithy.api#jsonName": "lookAheadRateControl" } }, - "Bitrate": { - "target": "com.amazonaws.medialive#__integerMin1000", + "FramerateControl": { + "target": "com.amazonaws.medialive#H264FramerateControl", "traits": { - "smithy.api#documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "This field indicates how the output video frame rate is specified. If \"specified\" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if \"initializeFromSource\" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.", + "smithy.api#jsonName": "framerateControl" } }, - "SpatialAq": { - "target": "com.amazonaws.medialive#H264SpatialAq", + "FramerateDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.", - "smithy.api#jsonName": "spatialAq" + "smithy.api#documentation": "Framerate denominator.", + "smithy.api#jsonName": "framerateDenominator" } }, - "EntropyEncoding": { - "target": "com.amazonaws.medialive#H264EntropyEncoding", + "Syntax": { + "target": "com.amazonaws.medialive#H264Syntax", "traits": { - "smithy.api#documentation": "Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.", - "smithy.api#jsonName": "entropyEncoding" + "smithy.api#documentation": "Produces a bitstream compliant with SMPTE RP-2027.", + "smithy.api#jsonName": "syntax" } }, - "GopSizeUnits": { - "target": "com.amazonaws.medialive#H264GopSizeUnits", + "Slices": { + "target": "com.amazonaws.medialive#__integerMin1Max32", "traits": { - "smithy.api#documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" - } - }, - "FixedAfd": { - "target": "com.amazonaws.medialive#FixedAfd", - "traits": { - "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", - "smithy.api#jsonName": "fixedAfd" - } - }, - "AfdSignaling": { - "target": "com.amazonaws.medialive#AfdSignaling", - "traits": { - "smithy.api#documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter.", - "smithy.api#jsonName": "afdSignaling" + "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.", + "smithy.api#jsonName": "slices" } }, - "GopSize": { - "target": "com.amazonaws.medialive#__double", + "AdaptiveQuantization": { + "target": "com.amazonaws.medialive#H264AdaptiveQuantization", "traits": { - "smithy.api#documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "SceneChangeDetect": { - "target": "com.amazonaws.medialive#H264SceneChangeDetect", + "Level": { + "target": "com.amazonaws.medialive#H264Level", "traits": { - "smithy.api#documentation": "Scene change detection.\n\n- On: inserts I-frames when scene change is detected.\n- Off: does not force an I-frame when scene change is detected.", - "smithy.api#jsonName": "sceneChangeDetect" + "smithy.api#documentation": "H.264 Level.", + "smithy.api#jsonName": "level" } }, - "ForceFieldPictures": { - "target": "com.amazonaws.medialive#H264ForceFieldPictures", + "NumRefFrames": { + "target": "com.amazonaws.medialive#__integerMin1Max6", "traits": { - "smithy.api#documentation": "This setting applies only when scan type is \"interlaced.\" It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.)\nenabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately.\ndisabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.", - "smithy.api#jsonName": "forceFieldPictures" + "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", + "smithy.api#jsonName": "numRefFrames" } }, - "MinIInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max30", + "TemporalAq": { + "target": "com.amazonaws.medialive#H264TemporalAq", "traits": { - "smithy.api#documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.", + "smithy.api#jsonName": "temporalAq" } }, "QualityLevel": { @@ -7015,95 +7610,95 @@ "smithy.api#jsonName": "qualityLevel" } }, - "FramerateDenominator": { - "target": "com.amazonaws.medialive#__integerMin1", + "ForceFieldPictures": { + "target": "com.amazonaws.medialive#H264ForceFieldPictures", "traits": { - "smithy.api#documentation": "Framerate denominator.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "This setting applies only when scan type is \"interlaced.\" It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.)\nenabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately.\ndisabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.", + "smithy.api#jsonName": "forceFieldPictures" } }, - "FramerateControl": { - "target": "com.amazonaws.medialive#H264FramerateControl", + "GopSize": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "This field indicates how the output video frame rate is specified. If \"specified\" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if \"initializeFromSource\" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.", - "smithy.api#jsonName": "framerateControl" + "smithy.api#documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.", + "smithy.api#jsonName": "gopSize" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.medialive#H264AdaptiveQuantization", + "AfdSignaling": { + "target": "com.amazonaws.medialive#AfdSignaling", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter.", + "smithy.api#jsonName": "afdSignaling" } }, - "FilterSettings": { - "target": "com.amazonaws.medialive#H264FilterSettings", + "ParDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Optional filters that you can apply to an encode.", - "smithy.api#jsonName": "filterSettings" + "smithy.api#documentation": "Pixel Aspect Ratio denominator.", + "smithy.api#jsonName": "parDenominator" } }, - "NumRefFrames": { - "target": "com.amazonaws.medialive#__integerMin1Max6", + "EntropyEncoding": { + "target": "com.amazonaws.medialive#H264EntropyEncoding", "traits": { - "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", - "smithy.api#jsonName": "numRefFrames" + "smithy.api#documentation": "Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.", + "smithy.api#jsonName": "entropyEncoding" } }, - "Syntax": { - "target": "com.amazonaws.medialive#H264Syntax", + "SpatialAq": { + "target": "com.amazonaws.medialive#H264SpatialAq", "traits": { - "smithy.api#documentation": "Produces a bitstream compliant with SMPTE RP-2027.", - "smithy.api#jsonName": "syntax" + "smithy.api#documentation": "If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.", + "smithy.api#jsonName": "spatialAq" } }, - "Level": { - "target": "com.amazonaws.medialive#H264Level", + "Softness": { + "target": "com.amazonaws.medialive#__integerMin0Max128", "traits": { - "smithy.api#documentation": "H.264 Level.", - "smithy.api#jsonName": "level" + "smithy.api#documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.", + "smithy.api#jsonName": "softness" } }, - "ParControl": { - "target": "com.amazonaws.medialive#H264ParControl", + "ColorSpaceSettings": { + "target": "com.amazonaws.medialive#H264ColorSpaceSettings", "traits": { - "smithy.api#documentation": "This field indicates how the output pixel aspect ratio is specified. If \"specified\" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if \"initializeFromSource\" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.", - "smithy.api#jsonName": "parControl" + "smithy.api#documentation": "Color Space settings", + "smithy.api#jsonName": "colorSpaceSettings" } }, - "TemporalAq": { - "target": "com.amazonaws.medialive#H264TemporalAq", + "BufFillPct": { + "target": "com.amazonaws.medialive#__integerMin0Max100", "traits": { - "smithy.api#documentation": "If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.", - "smithy.api#jsonName": "temporalAq" + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "bufFillPct" } }, - "GopClosedCadence": { - "target": "com.amazonaws.medialive#__integerMin0", + "GopNumBFrames": { + "target": "com.amazonaws.medialive#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "gopNumBFrames" } }, - "FramerateNumerator": { - "target": "com.amazonaws.medialive#__integerMin1", + "MinIInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "FlickerAq": { - "target": "com.amazonaws.medialive#H264FlickerAq", + "FilterSettings": { + "target": "com.amazonaws.medialive#H264FilterSettings", "traits": { - "smithy.api#documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", - "smithy.api#jsonName": "flickerAq" + "smithy.api#documentation": "Optional filters that you can apply to an encode.", + "smithy.api#jsonName": "filterSettings" } }, - "Profile": { - "target": "com.amazonaws.medialive#H264Profile", + "SubgopLength": { + "target": "com.amazonaws.medialive#H264SubGopLength", "traits": { - "smithy.api#documentation": "H.264 Profile.", - "smithy.api#jsonName": "profile" + "smithy.api#documentation": "If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.", + "smithy.api#jsonName": "subgopLength" } }, "RateControlMode": { @@ -7113,11 +7708,25 @@ "smithy.api#jsonName": "rateControlMode" } }, - "MaxBitrate": { - "target": "com.amazonaws.medialive#__integerMin1000", + "ParNumerator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "For QVBR: See the tooltip for Quality level\n\nFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "Pixel Aspect Ratio numerator.", + "smithy.api#jsonName": "parNumerator" + } + }, + "ScanType": { + "target": "com.amazonaws.medialive#H264ScanType", + "traits": { + "smithy.api#documentation": "Sets the scan type of the output to progressive or top-field-first interlaced.", + "smithy.api#jsonName": "scanType" + } + }, + "SceneChangeDetect": { + "target": "com.amazonaws.medialive#H264SceneChangeDetect", + "traits": { + "smithy.api#documentation": "Scene change detection.\n\n- On: inserts I-frames when scene change is detected.\n- Off: does not force an I-frame when scene change is detected.", + "smithy.api#jsonName": "sceneChangeDetect" } }, "ColorMetadata": { @@ -7127,32 +7736,25 @@ "smithy.api#jsonName": "colorMetadata" } }, - "QvbrQualityLevel": { - "target": "com.amazonaws.medialive#__integerMin1Max10", - "traits": { - "smithy.api#documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M", - "smithy.api#jsonName": "qvbrQualityLevel" - } - }, - "SubgopLength": { - "target": "com.amazonaws.medialive#H264SubGopLength", + "GopClosedCadence": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.", - "smithy.api#jsonName": "subgopLength" + "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "Slices": { - "target": "com.amazonaws.medialive#__integerMin1Max32", + "Bitrate": { + "target": "com.amazonaws.medialive#__integerMin1000", "traits": { - "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.", - "smithy.api#jsonName": "slices" + "smithy.api#documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" } }, - "LookAheadRateControl": { - "target": "com.amazonaws.medialive#H264LookAheadRateControl", + "TimecodeInsertion": { + "target": "com.amazonaws.medialive#H264TimecodeInsertionBehavior", "traits": { - "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", - "smithy.api#jsonName": "lookAheadRateControl" + "smithy.api#documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config", + "smithy.api#jsonName": "timecodeInsertion" } }, "BufSize": { @@ -7162,39 +7764,46 @@ "smithy.api#jsonName": "bufSize" } }, - "TimecodeInsertion": { - "target": "com.amazonaws.medialive#H264TimecodeInsertionBehavior", + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integerMin1000", "traits": { - "smithy.api#documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config", - "smithy.api#jsonName": "timecodeInsertion" + "smithy.api#documentation": "For QVBR: See the tooltip for Quality level\n\nFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.", + "smithy.api#jsonName": "maxBitrate" } }, - "ScanType": { - "target": "com.amazonaws.medialive#H264ScanType", + "GopSizeUnits": { + "target": "com.amazonaws.medialive#H264GopSizeUnits", "traits": { - "smithy.api#documentation": "Sets the scan type of the output to progressive or top-field-first interlaced.", - "smithy.api#jsonName": "scanType" + "smithy.api#documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "BufFillPct": { - "target": "com.amazonaws.medialive#__integerMin0Max100", + "GopBReference": { + "target": "com.amazonaws.medialive#H264GopBReference", "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "bufFillPct" + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "gopBReference" } }, - "ParNumerator": { + "FixedAfd": { + "target": "com.amazonaws.medialive#FixedAfd", + "traits": { + "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", + "smithy.api#jsonName": "fixedAfd" + } + }, + "FramerateNumerator": { "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Pixel Aspect Ratio numerator.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", + "smithy.api#jsonName": "framerateNumerator" } }, - "GopNumBFrames": { - "target": "com.amazonaws.medialive#__integerMin0Max7", + "ParControl": { + "target": "com.amazonaws.medialive#H264ParControl", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "gopNumBFrames" + "smithy.api#documentation": "This field indicates how the output pixel aspect ratio is specified. If \"specified\" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if \"initializeFromSource\" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.", + "smithy.api#jsonName": "parControl" } } }, @@ -7349,10 +7958,10 @@ "com.amazonaws.medialive#H265ColorSpaceSettings": { "type": "structure", "members": { - "Hdr10Settings": { - "target": "com.amazonaws.medialive#Hdr10Settings", + "Rec709Settings": { + "target": "com.amazonaws.medialive#Rec709Settings", "traits": { - "smithy.api#jsonName": "hdr10Settings" + "smithy.api#jsonName": "rec709Settings" } }, "Rec601Settings": { @@ -7361,10 +7970,10 @@ "smithy.api#jsonName": "rec601Settings" } }, - "Rec709Settings": { - "target": "com.amazonaws.medialive#Rec709Settings", + "Hdr10Settings": { + "target": "com.amazonaws.medialive#Hdr10Settings", "traits": { - "smithy.api#jsonName": "rec709Settings" + "smithy.api#jsonName": "hdr10Settings" } }, "ColorSpacePassthroughSettings": { @@ -7579,74 +8188,89 @@ "com.amazonaws.medialive#H265Settings": { "type": "structure", "members": { - "AlternativeTransferFunction": { - "target": "com.amazonaws.medialive#H265AlternativeTransferFunction", + "QvbrQualityLevel": { + "target": "com.amazonaws.medialive#__integerMin1Max10", "traits": { - "smithy.api#documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.", - "smithy.api#jsonName": "alternativeTransferFunction" + "smithy.api#documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M", + "smithy.api#jsonName": "qvbrQualityLevel" } }, - "ParDenominator": { - "target": "com.amazonaws.medialive#__integerMin1", + "LookAheadRateControl": { + "target": "com.amazonaws.medialive#H265LookAheadRateControl", "traits": { - "smithy.api#documentation": "Pixel Aspect Ratio denominator.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", + "smithy.api#jsonName": "lookAheadRateControl" } }, - "ColorSpaceSettings": { - "target": "com.amazonaws.medialive#H265ColorSpaceSettings", + "FlickerAq": { + "target": "com.amazonaws.medialive#H265FlickerAq", "traits": { - "smithy.api#documentation": "Color Space settings", - "smithy.api#jsonName": "colorSpaceSettings" + "smithy.api#documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "smithy.api#jsonName": "flickerAq" } }, - "Tier": { - "target": "com.amazonaws.medialive#H265Tier", + "GopSize": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "H.265 Tier.", - "smithy.api#jsonName": "tier" + "smithy.api#documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.", + "smithy.api#jsonName": "gopSize" } }, - "MaxBitrate": { - "target": "com.amazonaws.medialive#__integerMin100000Max40000000", + "Level": { + "target": "com.amazonaws.medialive#H265Level", "traits": { - "smithy.api#documentation": "For QVBR: See the tooltip for Quality level", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "H.265 Level.", + "smithy.api#jsonName": "level" } }, - "AfdSignaling": { - "target": "com.amazonaws.medialive#AfdSignaling", + "Slices": { + "target": "com.amazonaws.medialive#__integerMin1Max16", "traits": { - "smithy.api#documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter.", - "smithy.api#jsonName": "afdSignaling" + "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.", + "smithy.api#jsonName": "slices" } }, - "FixedAfd": { - "target": "com.amazonaws.medialive#FixedAfd", + "BufSize": { + "target": "com.amazonaws.medialive#__integerMin100000Max80000000", "traits": { - "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", - "smithy.api#jsonName": "fixedAfd" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits.", + "smithy.api#jsonName": "bufSize" } }, - "GopSizeUnits": { - "target": "com.amazonaws.medialive#H265GopSizeUnits", + "TimecodeInsertion": { + "target": "com.amazonaws.medialive#H265TimecodeInsertionBehavior", "traits": { - "smithy.api#documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config", + "smithy.api#jsonName": "timecodeInsertion" } }, - "BufSize": { - "target": "com.amazonaws.medialive#__integerMin100000Max80000000", + "FramerateNumerator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits.", - "smithy.api#jsonName": "bufSize" + "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", + "smithy.api#jsonName": "framerateNumerator", + "smithy.api#required": {} } }, - "ColorMetadata": { - "target": "com.amazonaws.medialive#H265ColorMetadata", + "Bitrate": { + "target": "com.amazonaws.medialive#__integerMin100000Max40000000", "traits": { - "smithy.api#documentation": "Includes colorspace metadata in the output.", - "smithy.api#jsonName": "colorMetadata" + "smithy.api#documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" + } + }, + "RateControlMode": { + "target": "com.amazonaws.medialive#H265RateControlMode", + "traits": { + "smithy.api#documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\n\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program.", + "smithy.api#jsonName": "rateControlMode" + } + }, + "GopClosedCadence": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#jsonName": "gopClosedCadence" } }, "ParNumerator": { @@ -7663,89 +8287,81 @@ "smithy.api#jsonName": "scanType" } }, - "TimecodeInsertion": { - "target": "com.amazonaws.medialive#H265TimecodeInsertionBehavior", - "traits": { - "smithy.api#documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config", - "smithy.api#jsonName": "timecodeInsertion" - } - }, - "Level": { - "target": "com.amazonaws.medialive#H265Level", + "FixedAfd": { + "target": "com.amazonaws.medialive#FixedAfd", "traits": { - "smithy.api#documentation": "H.265 Level.", - "smithy.api#jsonName": "level" + "smithy.api#documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.", + "smithy.api#jsonName": "fixedAfd" } }, - "Slices": { - "target": "com.amazonaws.medialive#__integerMin1Max16", + "ColorMetadata": { + "target": "com.amazonaws.medialive#H265ColorMetadata", "traits": { - "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.", - "smithy.api#jsonName": "slices" + "smithy.api#documentation": "Includes colorspace metadata in the output.", + "smithy.api#jsonName": "colorMetadata" } }, - "QvbrQualityLevel": { - "target": "com.amazonaws.medialive#__integerMin1Max10", + "Tier": { + "target": "com.amazonaws.medialive#H265Tier", "traits": { - "smithy.api#documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M", - "smithy.api#jsonName": "qvbrQualityLevel" + "smithy.api#documentation": "H.265 Tier.", + "smithy.api#jsonName": "tier" } }, - "LookAheadRateControl": { - "target": "com.amazonaws.medialive#H265LookAheadRateControl", + "GopSizeUnits": { + "target": "com.amazonaws.medialive#H265GopSizeUnits", "traits": { - "smithy.api#documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.", - "smithy.api#jsonName": "lookAheadRateControl" + "smithy.api#documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "FlickerAq": { - "target": "com.amazonaws.medialive#H265FlickerAq", + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integerMin100000Max40000000", "traits": { - "smithy.api#documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", - "smithy.api#jsonName": "flickerAq" + "smithy.api#documentation": "For QVBR: See the tooltip for Quality level", + "smithy.api#jsonName": "maxBitrate" } }, - "FramerateNumerator": { - "target": "com.amazonaws.medialive#__integerMin1", + "AlternativeTransferFunction": { + "target": "com.amazonaws.medialive#H265AlternativeTransferFunction", "traits": { - "smithy.api#documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.", - "smithy.api#jsonName": "framerateNumerator", - "smithy.api#required": {} + "smithy.api#documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.", + "smithy.api#jsonName": "alternativeTransferFunction" } }, - "Profile": { - "target": "com.amazonaws.medialive#H265Profile", + "FilterSettings": { + "target": "com.amazonaws.medialive#H265FilterSettings", "traits": { - "smithy.api#documentation": "H.265 Profile.", - "smithy.api#jsonName": "profile" + "smithy.api#documentation": "Optional filters that you can apply to an encode.", + "smithy.api#jsonName": "filterSettings" } }, - "Bitrate": { - "target": "com.amazonaws.medialive#__integerMin100000Max40000000", + "ParDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Pixel Aspect Ratio denominator.", + "smithy.api#jsonName": "parDenominator" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.medialive#H265AdaptiveQuantization", + "MinIInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "GopClosedCadence": { - "target": "com.amazonaws.medialive#__integerMin0", + "SceneChangeDetect": { + "target": "com.amazonaws.medialive#H265SceneChangeDetect", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "Scene change detection.", + "smithy.api#jsonName": "sceneChangeDetect" } }, - "RateControlMode": { - "target": "com.amazonaws.medialive#H265RateControlMode", + "ColorSpaceSettings": { + "target": "com.amazonaws.medialive#H265ColorSpaceSettings", "traits": { - "smithy.api#documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\n\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program.", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "Color Space settings", + "smithy.api#jsonName": "colorSpaceSettings" } }, "FramerateDenominator": { @@ -7756,32 +8372,25 @@ "smithy.api#required": {} } }, - "FilterSettings": { - "target": "com.amazonaws.medialive#H265FilterSettings", - "traits": { - "smithy.api#documentation": "Optional filters that you can apply to an encode.", - "smithy.api#jsonName": "filterSettings" - } - }, - "SceneChangeDetect": { - "target": "com.amazonaws.medialive#H265SceneChangeDetect", + "AdaptiveQuantization": { + "target": "com.amazonaws.medialive#H265AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Scene change detection.", - "smithy.api#jsonName": "sceneChangeDetect" + "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "GopSize": { - "target": "com.amazonaws.medialive#__double", + "AfdSignaling": { + "target": "com.amazonaws.medialive#AfdSignaling", "traits": { - "smithy.api#documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.\nIf gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter.", + "smithy.api#jsonName": "afdSignaling" } }, - "MinIInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max30", + "Profile": { + "target": "com.amazonaws.medialive#H265Profile", "traits": { - "smithy.api#documentation": "Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "H.265 Profile.", + "smithy.api#jsonName": "profile" } } }, @@ -7824,18 +8433,18 @@ "com.amazonaws.medialive#Hdr10Settings": { "type": "structure", "members": { - "MaxCll": { + "MaxFall": { "target": "com.amazonaws.medialive#__integerMin0Max32768", "traits": { - "smithy.api#documentation": "Maximum Content Light Level\nAn integer metadata value defining the maximum light level, in nits,\nof any single pixel within an encoded HDR video stream or file.", - "smithy.api#jsonName": "maxCll" + "smithy.api#documentation": "Maximum Frame Average Light Level\nAn integer metadata value defining the maximum average light level, in nits,\nfor any single frame within an encoded HDR video stream or file.", + "smithy.api#jsonName": "maxFall" } }, - "MaxFall": { + "MaxCll": { "target": "com.amazonaws.medialive#__integerMin0Max32768", "traits": { - "smithy.api#documentation": "Maximum Frame Average Light Level\nAn integer metadata value defining the maximum average light level, in nits,\nfor any single frame within an encoded HDR video stream or file.", - "smithy.api#jsonName": "maxFall" + "smithy.api#documentation": "Maximum Content Light Level\nAn integer metadata value defining the maximum light level, in nits,\nof any single pixel within an encoded HDR video stream or file.", + "smithy.api#jsonName": "maxCll" } } }, @@ -7882,25 +8491,18 @@ "com.amazonaws.medialive#HlsAkamaiSettings": { "type": "structure", "members": { - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0Max600", + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" } }, - "Token": { + "Salt": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Token parameter for authenticated akamai. If not specified, _gda_ is used.", - "smithy.api#jsonName": "token" - } - }, - "Salt": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Salt for authenticated Akamai.", - "smithy.api#jsonName": "salt" + "smithy.api#documentation": "Salt for authenticated Akamai.", + "smithy.api#jsonName": "salt" } }, "HttpTransferMode": { @@ -7910,11 +8512,25 @@ "smithy.api#jsonName": "httpTransferMode" } }, - "ConnectionRetryInterval": { + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0Max600", + "traits": { + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" + } + }, + "NumRetries": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" + "smithy.api#documentation": "Number of retry attempts that will be made before the Live Event is put into an error state.", + "smithy.api#jsonName": "numRetries" + } + }, + "Token": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Token parameter for authenticated akamai. If not specified, _gda_ is used.", + "smithy.api#jsonName": "token" } }, "RestartDelay": { @@ -7923,13 +8539,6 @@ "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", "smithy.api#jsonName": "restartDelay" } - }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Number of retry attempts that will be made before the Live Event is put into an error state.", - "smithy.api#jsonName": "numRetries" - } } }, "traits": { @@ -7939,6 +8548,13 @@ "com.amazonaws.medialive#HlsBasicPutSettings": { "type": "structure", "members": { + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Number of retry attempts that will be made before the Live Event is put into an error state.", + "smithy.api#jsonName": "numRetries" + } + }, "RestartDelay": { "target": "com.amazonaws.medialive#__integerMin0Max15", "traits": { @@ -7946,13 +8562,6 @@ "smithy.api#jsonName": "restartDelay" } }, - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" - } - }, "FilecacheDuration": { "target": "com.amazonaws.medialive#__integerMin0Max600", "traits": { @@ -7960,11 +8569,11 @@ "smithy.api#jsonName": "filecacheDuration" } }, - "NumRetries": { + "ConnectionRetryInterval": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Number of retry attempts that will be made before the Live Event is put into an error state.", - "smithy.api#jsonName": "numRetries" + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" } } }, @@ -7995,10 +8604,10 @@ "com.amazonaws.medialive#HlsCdnSettings": { "type": "structure", "members": { - "HlsAkamaiSettings": { - "target": "com.amazonaws.medialive#HlsAkamaiSettings", + "HlsBasicPutSettings": { + "target": "com.amazonaws.medialive#HlsBasicPutSettings", "traits": { - "smithy.api#jsonName": "hlsAkamaiSettings" + "smithy.api#jsonName": "hlsBasicPutSettings" } }, "HlsWebdavSettings": { @@ -8007,17 +8616,17 @@ "smithy.api#jsonName": "hlsWebdavSettings" } }, - "HlsBasicPutSettings": { - "target": "com.amazonaws.medialive#HlsBasicPutSettings", - "traits": { - "smithy.api#jsonName": "hlsBasicPutSettings" - } - }, "HlsMediaStoreSettings": { "target": "com.amazonaws.medialive#HlsMediaStoreSettings", "traits": { "smithy.api#jsonName": "hlsMediaStoreSettings" } + }, + "HlsAkamaiSettings": { + "target": "com.amazonaws.medialive#HlsAkamaiSettings", + "traits": { + "smithy.api#jsonName": "hlsAkamaiSettings" + } } }, "traits": { @@ -8091,130 +8700,137 @@ "com.amazonaws.medialive#HlsGroupSettings": { "type": "structure", "members": { - "ManifestDurationFormat": { - "target": "com.amazonaws.medialive#HlsManifestDurationFormat", + "StreamInfResolution": { + "target": "com.amazonaws.medialive#HlsStreamInfResolution", "traits": { - "smithy.api#documentation": "Indicates whether the output manifest should use floating point or integer values for segment duration.", - "smithy.api#jsonName": "manifestDurationFormat" + "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", + "smithy.api#jsonName": "streamInfResolution" } }, - "DirectoryStructure": { - "target": "com.amazonaws.medialive#HlsDirectoryStructure", + "OutputSelection": { + "target": "com.amazonaws.medialive#HlsOutputSelection", "traits": { - "smithy.api#documentation": "Place segments in subdirectories.", - "smithy.api#jsonName": "directoryStructure" + "smithy.api#documentation": "MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.\n\nVARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest.\n\nSEGMENTS_ONLY: Does not generate any manifests for this output group.", + "smithy.api#jsonName": "outputSelection" } }, - "TimedMetadataId3Period": { - "target": "com.amazonaws.medialive#__integerMin0", + "IFrameOnlyPlaylists": { + "target": "com.amazonaws.medialive#IFrameOnlyPlaylistType", "traits": { - "smithy.api#documentation": "Timed Metadata interval in seconds.", - "smithy.api#jsonName": "timedMetadataId3Period" + "smithy.api#documentation": "DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).\n\nSTANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888\"", + "smithy.api#jsonName": "iFrameOnlyPlaylists" } }, - "KeepSegments": { - "target": "com.amazonaws.medialive#__integerMin1", + "RedundantManifest": { + "target": "com.amazonaws.medialive#HlsRedundantManifest", "traits": { - "smithy.api#documentation": "Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.", - "smithy.api#jsonName": "keepSegments" + "smithy.api#documentation": "ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.\n\nDISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.\n\nFor an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.", + "smithy.api#jsonName": "redundantManifest" } }, - "ManifestCompression": { - "target": "com.amazonaws.medialive#HlsManifestCompression", + "IvInManifest": { + "target": "com.amazonaws.medialive#HlsIvInManifest", "traits": { - "smithy.api#documentation": "When set to gzip, compresses HLS playlist.", - "smithy.api#jsonName": "manifestCompression" + "smithy.api#documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to \"include\", IV is listed in the manifest, otherwise the IV is not in the manifest.", + "smithy.api#jsonName": "ivInManifest" } }, - "SegmentLength": { + "SegmentsPerSubdirectory": { "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.", - "smithy.api#jsonName": "segmentLength" + "smithy.api#documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.", + "smithy.api#jsonName": "segmentsPerSubdirectory" } }, - "KeyProviderSettings": { - "target": "com.amazonaws.medialive#KeyProviderSettings", + "SegmentationMode": { + "target": "com.amazonaws.medialive#HlsSegmentationMode", "traits": { - "smithy.api#documentation": "The key provider settings.", - "smithy.api#jsonName": "keyProviderSettings" + "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", + "smithy.api#jsonName": "segmentationMode" } }, - "IndexNSegments": { - "target": "com.amazonaws.medialive#__integerMin3", + "MinSegmentLength": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.", - "smithy.api#jsonName": "indexNSegments" + "smithy.api#documentation": "When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", + "smithy.api#jsonName": "minSegmentLength" } }, - "CaptionLanguageMappings": { - "target": "com.amazonaws.medialive#__listOfCaptionLanguageMapping", + "ProgramDateTime": { + "target": "com.amazonaws.medialive#HlsProgramDateTime", "traits": { - "smithy.api#documentation": "Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to \"insert\".", - "smithy.api#jsonName": "captionLanguageMappings" + "smithy.api#documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.", + "smithy.api#jsonName": "programDateTime" } }, - "TsFileMode": { - "target": "com.amazonaws.medialive#HlsTsFileMode", + "BaseUrlContent": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.\n\nSINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.", - "smithy.api#jsonName": "tsFileMode" + "smithy.api#documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.", + "smithy.api#jsonName": "baseUrlContent" } }, - "IvSource": { - "target": "com.amazonaws.medialive#HlsIvSource", + "BaseUrlManifest": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is \"followsSegmentNumber\", it will cause the IV to change every segment (to match the segment number). If this is set to \"explicit\", you must enter a constantIv value.", - "smithy.api#jsonName": "ivSource" + "smithy.api#documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.", + "smithy.api#jsonName": "baseUrlManifest" } }, - "BaseUrlContent1": { - "target": "com.amazonaws.medialive#__string", + "KeyProviderSettings": { + "target": "com.amazonaws.medialive#KeyProviderSettings", "traits": { - "smithy.api#documentation": "Optional. One value per output group.\n\nThis field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.", - "smithy.api#jsonName": "baseUrlContent1" + "smithy.api#documentation": "The key provider settings.", + "smithy.api#jsonName": "keyProviderSettings" } }, - "SegmentationMode": { - "target": "com.amazonaws.medialive#HlsSegmentationMode", + "ManifestCompression": { + "target": "com.amazonaws.medialive#HlsManifestCompression", "traits": { - "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", - "smithy.api#jsonName": "segmentationMode" + "smithy.api#documentation": "When set to gzip, compresses HLS playlist.", + "smithy.api#jsonName": "manifestCompression" } }, - "KeyFormat": { + "BaseUrlManifest1": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of \"identity\" is used. A reverse DNS string can also be given.", - "smithy.api#jsonName": "keyFormat" + "smithy.api#documentation": "Optional. One value per output group.\n\nComplete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.", + "smithy.api#jsonName": "baseUrlManifest1" } }, - "ProgramDateTime": { - "target": "com.amazonaws.medialive#HlsProgramDateTime", + "TimedMetadataId3Frame": { + "target": "com.amazonaws.medialive#HlsTimedMetadataId3Frame", "traits": { - "smithy.api#documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.", - "smithy.api#jsonName": "programDateTime" + "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", + "smithy.api#jsonName": "timedMetadataId3Frame" } }, - "BaseUrlManifest": { - "target": "com.amazonaws.medialive#__string", + "SegmentLength": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.", - "smithy.api#jsonName": "baseUrlManifest" + "smithy.api#documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.", + "smithy.api#jsonName": "segmentLength" } }, - "AdMarkers": { - "target": "com.amazonaws.medialive#__listOfHlsAdMarkers", + "ProgramDateTimePeriod": { + "target": "com.amazonaws.medialive#__integerMin0Max3600", "traits": { - "smithy.api#documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.", - "smithy.api#jsonName": "adMarkers" + "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", + "smithy.api#jsonName": "programDateTimePeriod" } }, - "BaseUrlContent": { - "target": "com.amazonaws.medialive#__string", + "KeepSegments": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.", - "smithy.api#jsonName": "baseUrlContent" + "smithy.api#documentation": "Applies only if Mode field is LIVE.\n\nSpecifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1).\n\nIf this \"keep segments\" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player.", + "smithy.api#jsonName": "keepSegments" + } + }, + "TimedMetadataId3Period": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Timed Metadata interval in seconds.", + "smithy.api#jsonName": "timedMetadataId3Period" } }, "TimestampDeltaMilliseconds": { @@ -8224,67 +8840,46 @@ "smithy.api#jsonName": "timestampDeltaMilliseconds" } }, - "SegmentsPerSubdirectory": { - "target": "com.amazonaws.medialive#__integerMin1", + "DirectoryStructure": { + "target": "com.amazonaws.medialive#HlsDirectoryStructure", "traits": { - "smithy.api#documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.", - "smithy.api#jsonName": "segmentsPerSubdirectory" + "smithy.api#documentation": "Place segments in subdirectories.", + "smithy.api#jsonName": "directoryStructure" } }, - "CaptionLanguageSetting": { - "target": "com.amazonaws.medialive#HlsCaptionLanguageSetting", + "AdMarkers": { + "target": "com.amazonaws.medialive#__listOfHlsAdMarkers", "traits": { - "smithy.api#documentation": "Applies only to 608 Embedded output captions.\ninsert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.\nnone: Include CLOSED-CAPTIONS=NONE line in the manifest.\nomit: Omit any CLOSED-CAPTIONS line from the manifest.", - "smithy.api#jsonName": "captionLanguageSetting" + "smithy.api#documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.", + "smithy.api#jsonName": "adMarkers" } }, - "IFrameOnlyPlaylists": { - "target": "com.amazonaws.medialive#IFrameOnlyPlaylistType", + "HlsId3SegmentTagging": { + "target": "com.amazonaws.medialive#HlsId3SegmentTaggingState", "traits": { - "smithy.api#documentation": "DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).\n\nSTANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888\"", - "smithy.api#jsonName": "iFrameOnlyPlaylists" + "smithy.api#documentation": "State of HLS ID3 Segment Tagging", + "smithy.api#jsonName": "hlsId3SegmentTagging" } }, - "IvInManifest": { - "target": "com.amazonaws.medialive#HlsIvInManifest", + "InputLossAction": { + "target": "com.amazonaws.medialive#InputLossActionForHlsOut", "traits": { - "smithy.api#documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to \"include\", IV is listed in the manifest, otherwise the IV is not in the manifest.", - "smithy.api#jsonName": "ivInManifest" + "smithy.api#documentation": "Parameter that control output group behavior on input loss.", + "smithy.api#jsonName": "inputLossAction" } }, - "OutputSelection": { - "target": "com.amazonaws.medialive#HlsOutputSelection", + "ManifestDurationFormat": { + "target": "com.amazonaws.medialive#HlsManifestDurationFormat", "traits": { - "smithy.api#documentation": "MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.\n\nVARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest.\n\nSEGMENTS_ONLY: Does not generate any manifests for this output group.", - "smithy.api#jsonName": "outputSelection" + "smithy.api#documentation": "Indicates whether the output manifest should use floating point or integer values for segment duration.", + "smithy.api#jsonName": "manifestDurationFormat" } }, - "StreamInfResolution": { - "target": "com.amazonaws.medialive#HlsStreamInfResolution", - "traits": { - "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", - "smithy.api#jsonName": "streamInfResolution" - } - }, - "RedundantManifest": { - "target": "com.amazonaws.medialive#HlsRedundantManifest", - "traits": { - "smithy.api#documentation": "ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.\n\nDISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.\n\nFor an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.", - "smithy.api#jsonName": "redundantManifest" - } - }, - "ProgramDateTimePeriod": { - "target": "com.amazonaws.medialive#__integerMin0Max3600", - "traits": { - "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", - "smithy.api#jsonName": "programDateTimePeriod" - } - }, - "TimedMetadataId3Frame": { - "target": "com.amazonaws.medialive#HlsTimedMetadataId3Frame", + "Mode": { + "target": "com.amazonaws.medialive#HlsMode", "traits": { - "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", - "smithy.api#jsonName": "timedMetadataId3Frame" + "smithy.api#documentation": "If \"vod\", all segments are indexed and kept permanently in the destination and manifest. If \"live\", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.\n\nVOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a \"VOD\" type manifest on completion of the stream.", + "smithy.api#jsonName": "mode" } }, "ClientCache": { @@ -8294,25 +8889,18 @@ "smithy.api#jsonName": "clientCache" } }, - "MinSegmentLength": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", - "smithy.api#jsonName": "minSegmentLength" - } - }, - "BaseUrlManifest1": { + "KeyFormatVersions": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Optional. One value per output group.\n\nComplete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.", - "smithy.api#jsonName": "baseUrlManifest1" + "smithy.api#documentation": "Either a single positive integer version value or a slash delimited list of version values (1/2/3).", + "smithy.api#jsonName": "keyFormatVersions" } }, - "Mode": { - "target": "com.amazonaws.medialive#HlsMode", + "HlsCdnSettings": { + "target": "com.amazonaws.medialive#HlsCdnSettings", "traits": { - "smithy.api#documentation": "If \"vod\", all segments are indexed and kept permanently in the destination and manifest. If \"live\", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.\n\nVOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a \"VOD\" type manifest on completion of the stream.", - "smithy.api#jsonName": "mode" + "smithy.api#documentation": "Parameters that control interactions with the CDN.", + "smithy.api#jsonName": "hlsCdnSettings" } }, "CodecSpecification": { @@ -8330,18 +8918,18 @@ "smithy.api#required": {} } }, - "InputLossAction": { - "target": "com.amazonaws.medialive#InputLossActionForHlsOut", + "IvSource": { + "target": "com.amazonaws.medialive#HlsIvSource", "traits": { - "smithy.api#documentation": "Parameter that control output group behavior on input loss.", - "smithy.api#jsonName": "inputLossAction" + "smithy.api#documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is \"followsSegmentNumber\", it will cause the IV to change every segment (to match the segment number). If this is set to \"explicit\", you must enter a constantIv value.", + "smithy.api#jsonName": "ivSource" } }, - "EncryptionType": { - "target": "com.amazonaws.medialive#HlsEncryptionType", + "BaseUrlContent1": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.", - "smithy.api#jsonName": "encryptionType" + "smithy.api#documentation": "Optional. One value per output group.\n\nThis field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.", + "smithy.api#jsonName": "baseUrlContent1" } }, "ConstantIv": { @@ -8351,25 +8939,46 @@ "smithy.api#jsonName": "constantIv" } }, - "KeyFormatVersions": { + "KeyFormat": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Either a single positive integer version value or a slash delimited list of version values (1/2/3).", - "smithy.api#jsonName": "keyFormatVersions" + "smithy.api#documentation": "The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of \"identity\" is used. A reverse DNS string can also be given.", + "smithy.api#jsonName": "keyFormat" } }, - "HlsId3SegmentTagging": { - "target": "com.amazonaws.medialive#HlsId3SegmentTaggingState", + "TsFileMode": { + "target": "com.amazonaws.medialive#HlsTsFileMode", "traits": { - "smithy.api#documentation": "State of HLS ID3 Segment Tagging", - "smithy.api#jsonName": "hlsId3SegmentTagging" + "smithy.api#documentation": "SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.\n\nSINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.", + "smithy.api#jsonName": "tsFileMode" } }, - "HlsCdnSettings": { - "target": "com.amazonaws.medialive#HlsCdnSettings", + "CaptionLanguageMappings": { + "target": "com.amazonaws.medialive#__listOfCaptionLanguageMapping", "traits": { - "smithy.api#documentation": "Parameters that control interactions with the CDN.", - "smithy.api#jsonName": "hlsCdnSettings" + "smithy.api#documentation": "Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to \"insert\".", + "smithy.api#jsonName": "captionLanguageMappings" + } + }, + "CaptionLanguageSetting": { + "target": "com.amazonaws.medialive#HlsCaptionLanguageSetting", + "traits": { + "smithy.api#documentation": "Applies only to 608 Embedded output captions.\ninsert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.\nnone: Include CLOSED-CAPTIONS=NONE line in the manifest.\nomit: Omit any CLOSED-CAPTIONS line from the manifest.", + "smithy.api#jsonName": "captionLanguageSetting" + } + }, + "IndexNSegments": { + "target": "com.amazonaws.medialive#__integerMin3", + "traits": { + "smithy.api#documentation": "Applies only if Mode field is LIVE.\n\nSpecifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field.", + "smithy.api#jsonName": "indexNSegments" + } + }, + "EncryptionType": { + "target": "com.amazonaws.medialive#HlsEncryptionType", + "traits": { + "smithy.api#documentation": "Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.", + "smithy.api#jsonName": "encryptionType" } } }, @@ -8428,6 +9037,13 @@ "com.amazonaws.medialive#HlsInputSettings": { "type": "structure", "members": { + "Retries": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.", + "smithy.api#jsonName": "retries" + } + }, "RetryInterval": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { @@ -8448,13 +9064,6 @@ "smithy.api#documentation": "When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.", "smithy.api#jsonName": "bandwidth" } - }, - "Retries": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.", - "smithy.api#jsonName": "retries" - } } }, "traits": { @@ -8528,11 +9137,11 @@ "com.amazonaws.medialive#HlsMediaStoreSettings": { "type": "structure", "members": { - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0Max600", "traits": { - "smithy.api#documentation": "Number of retry attempts that will be made before the Live Event is put into an error state.", - "smithy.api#jsonName": "numRetries" + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" } }, "RestartDelay": { @@ -8542,6 +9151,13 @@ "smithy.api#jsonName": "restartDelay" } }, + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" + } + }, "MediaStoreStorageClass": { "target": "com.amazonaws.medialive#HlsMediaStoreStorageClass", "traits": { @@ -8549,18 +9165,11 @@ "smithy.api#jsonName": "mediaStoreStorageClass" } }, - "ConnectionRetryInterval": { + "NumRetries": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" - } - }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0Max600", - "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" + "smithy.api#documentation": "Number of retry attempts that will be made before the Live Event is put into an error state.", + "smithy.api#jsonName": "numRetries" } } }, @@ -8619,6 +9228,13 @@ "com.amazonaws.medialive#HlsOutputSettings": { "type": "structure", "members": { + "H265PackagingType": { + "target": "com.amazonaws.medialive#HlsH265PackagingType", + "traits": { + "smithy.api#documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.", + "smithy.api#jsonName": "h265PackagingType" + } + }, "NameModifier": { "target": "com.amazonaws.medialive#__stringMin1", "traits": { @@ -8634,13 +9250,6 @@ "smithy.api#required": {} } }, - "H265PackagingType": { - "target": "com.amazonaws.medialive#HlsH265PackagingType", - "traits": { - "smithy.api#documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.", - "smithy.api#jsonName": "h265PackagingType" - } - }, "SegmentModifier": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -8814,13 +9423,6 @@ "com.amazonaws.medialive#HlsWebdavSettings": { "type": "structure", "members": { - "HttpTransferMode": { - "target": "com.amazonaws.medialive#HlsWebdavHttpTransferMode", - "traits": { - "smithy.api#documentation": "Specify whether or not to use chunked transfer encoding to WebDAV.", - "smithy.api#jsonName": "httpTransferMode" - } - }, "NumRetries": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { @@ -8828,13 +9430,6 @@ "smithy.api#jsonName": "numRetries" } }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0Max600", - "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" - } - }, "RestartDelay": { "target": "com.amazonaws.medialive#__integerMin0Max15", "traits": { @@ -8842,12 +9437,26 @@ "smithy.api#jsonName": "restartDelay" } }, + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0Max600", + "traits": { + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" + } + }, "ConnectionRetryInterval": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { "smithy.api#documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost.", "smithy.api#jsonName": "connectionRetryInterval" } + }, + "HttpTransferMode": { + "target": "com.amazonaws.medialive#HlsWebdavHttpTransferMode", + "traits": { + "smithy.api#documentation": "Specify whether or not to use chunked transfer encoding to WebDAV.", + "smithy.api#jsonName": "httpTransferMode" + } } }, "traits": { @@ -8880,13 +9489,6 @@ "com.amazonaws.medialive#Input": { "type": "structure", "members": { - "SecurityGroups": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", - "smithy.api#jsonName": "securityGroups" - } - }, "RoleArn": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -8894,13 +9496,6 @@ "smithy.api#jsonName": "roleArn" } }, - "InputClass": { - "target": "com.amazonaws.medialive#InputClass", - "traits": { - "smithy.api#documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.", - "smithy.api#jsonName": "inputClass" - } - }, "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -8908,6 +9503,13 @@ "smithy.api#jsonName": "arn" } }, + "SecurityGroups": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of IDs for all the Input Security Groups attached to the input.", + "smithy.api#jsonName": "securityGroups" + } + }, "Id": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -8922,24 +9524,11 @@ "smithy.api#jsonName": "sources" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfInputDestination", - "traits": { - "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", - "smithy.api#jsonName": "destinations" - } - }, - "Name": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The user-assigned name (This is a mutable value).", - "smithy.api#jsonName": "name" - } - }, - "State": { - "target": "com.amazonaws.medialive#InputState", + "InputDevices": { + "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#documentation": "Settings for the input devices.", + "smithy.api#jsonName": "inputDevices" } }, "MediaConnectFlows": { @@ -8956,12 +9545,6 @@ "smithy.api#jsonName": "inputSourceType" } }, - "Type": { - "target": "com.amazonaws.medialive#InputType", - "traits": { - "smithy.api#jsonName": "type" - } - }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { @@ -8969,6 +9552,12 @@ "smithy.api#jsonName": "tags" } }, + "Type": { + "target": "com.amazonaws.medialive#InputType", + "traits": { + "smithy.api#jsonName": "type" + } + }, "AttachedChannels": { "target": "com.amazonaws.medialive#__listOf__string", "traits": { @@ -8976,14 +9565,34 @@ "smithy.api#jsonName": "attachedChannels" } }, - "InputDevices": { - "target": "com.amazonaws.medialive#__listOfInputDeviceSettings", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Settings for the input devices.", - "smithy.api#jsonName": "inputDevices" + "smithy.api#documentation": "The user-assigned name (This is a mutable value).", + "smithy.api#jsonName": "name" } - } - }, + }, + "Destinations": { + "target": "com.amazonaws.medialive#__listOfInputDestination", + "traits": { + "smithy.api#documentation": "A list of the destinations of the input (PUSH-type).", + "smithy.api#jsonName": "destinations" + } + }, + "State": { + "target": "com.amazonaws.medialive#InputState", + "traits": { + "smithy.api#jsonName": "state" + } + }, + "InputClass": { + "target": "com.amazonaws.medialive#InputClass", + "traits": { + "smithy.api#documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.", + "smithy.api#jsonName": "inputClass" + } + } + }, "traits": { "smithy.api#documentation": "Placeholder documentation for Input" } @@ -9027,14 +9636,6 @@ "com.amazonaws.medialive#InputChannelLevel": { "type": "structure", "members": { - "InputChannel": { - "target": "com.amazonaws.medialive#__integerMin0Max15", - "traits": { - "smithy.api#documentation": "The index of the input channel used as a source.", - "smithy.api#jsonName": "inputChannel", - "smithy.api#required": {} - } - }, "Gain": { "target": "com.amazonaws.medialive#__integerMinNegative60Max6", "traits": { @@ -9042,6 +9643,14 @@ "smithy.api#jsonName": "gain", "smithy.api#required": {} } + }, + "InputChannel": { + "target": "com.amazonaws.medialive#__integerMin0Max15", + "traits": { + "smithy.api#documentation": "The index of the input channel used as a source.", + "smithy.api#jsonName": "inputChannel", + "smithy.api#required": {} + } } }, "traits": { @@ -9067,6 +9676,13 @@ "com.amazonaws.medialive#InputClippingSettings": { "type": "structure", "members": { + "StopTimecode": { + "target": "com.amazonaws.medialive#StopTimecode", + "traits": { + "smithy.api#documentation": "Settings to identify the end of the clip.", + "smithy.api#jsonName": "stopTimecode" + } + }, "InputTimecodeSource": { "target": "com.amazonaws.medialive#InputTimecodeSource", "traits": { @@ -9075,13 +9691,6 @@ "smithy.api#required": {} } }, - "StopTimecode": { - "target": "com.amazonaws.medialive#StopTimecode", - "traits": { - "smithy.api#documentation": "Settings to identify the end of the clip.", - "smithy.api#jsonName": "stopTimecode" - } - }, "StartTimecode": { "target": "com.amazonaws.medialive#StartTimecode", "traits": { @@ -9156,6 +9765,13 @@ "smithy.api#jsonName": "port" } }, + "Url": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "This represents the endpoint that the customer stream will be\npushed to.", + "smithy.api#jsonName": "url" + } + }, "Vpc": { "target": "com.amazonaws.medialive#InputDestinationVpc", "traits": { @@ -9168,13 +9784,6 @@ "smithy.api#documentation": "The system-generated static IP address of endpoint.\nIt remains fixed for the lifetime of the input.", "smithy.api#jsonName": "ip" } - }, - "Url": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "This represents the endpoint that the customer stream will be\npushed to.", - "smithy.api#jsonName": "url" - } } }, "traits": { @@ -9199,18 +9808,18 @@ "com.amazonaws.medialive#InputDestinationVpc": { "type": "structure", "members": { - "NetworkInterfaceId": { + "AvailabilityZone": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The network interface ID of the Input destination in the VPC.", - "smithy.api#jsonName": "networkInterfaceId" + "smithy.api#documentation": "The availability zone of the Input destination.", + "smithy.api#jsonName": "availabilityZone" } }, - "AvailabilityZone": { + "NetworkInterfaceId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The availability zone of the Input destination.", - "smithy.api#jsonName": "availabilityZone" + "smithy.api#documentation": "The network interface ID of the Input destination in the VPC.", + "smithy.api#jsonName": "networkInterfaceId" } } }, @@ -9295,13 +9904,6 @@ "com.amazonaws.medialive#InputDeviceHdSettings": { "type": "structure", "members": { - "Width": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "The width of the video source, in pixels.", - "smithy.api#jsonName": "width" - } - }, "Height": { "target": "com.amazonaws.medialive#__integer", "traits": { @@ -9309,6 +9911,13 @@ "smithy.api#jsonName": "height" } }, + "ConfiguredInput": { + "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", + "traits": { + "smithy.api#documentation": "The source at the input device that is currently active. You can specify this source.", + "smithy.api#jsonName": "configuredInput" + } + }, "ActiveInput": { "target": "com.amazonaws.medialive#InputDeviceActiveInput", "traits": { @@ -9316,6 +9925,13 @@ "smithy.api#jsonName": "activeInput" } }, + "MaxBitrate": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.", + "smithy.api#jsonName": "maxBitrate" + } + }, "Framerate": { "target": "com.amazonaws.medialive#__double", "traits": { @@ -9323,6 +9939,13 @@ "smithy.api#jsonName": "framerate" } }, + "ScanType": { + "target": "com.amazonaws.medialive#InputDeviceScanType", + "traits": { + "smithy.api#documentation": "The scan type of the video source.", + "smithy.api#jsonName": "scanType" + } + }, "DeviceState": { "target": "com.amazonaws.medialive#InputDeviceState", "traits": { @@ -9330,25 +9953,11 @@ "smithy.api#jsonName": "deviceState" } }, - "MaxBitrate": { + "Width": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.", - "smithy.api#jsonName": "maxBitrate" - } - }, - "ConfiguredInput": { - "target": "com.amazonaws.medialive#InputDeviceConfiguredInput", - "traits": { - "smithy.api#documentation": "The source at the input device that is currently active. You can specify this source.", - "smithy.api#jsonName": "configuredInput" - } - }, - "ScanType": { - "target": "com.amazonaws.medialive#InputDeviceScanType", - "traits": { - "smithy.api#documentation": "The scan type of the video source.", - "smithy.api#jsonName": "scanType" + "smithy.api#documentation": "The width of the video source, in pixels.", + "smithy.api#jsonName": "width" } } }, @@ -9382,18 +9991,11 @@ "smithy.api#jsonName": "subnetMask" } }, - "Gateway": { + "IpAddress": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The network gateway IP address.", - "smithy.api#jsonName": "gateway" - } - }, - "DnsAddresses": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "The DNS addresses of the input device.", - "smithy.api#jsonName": "dnsAddresses" + "smithy.api#documentation": "The IP address of the input device.", + "smithy.api#jsonName": "ipAddress" } }, "IpScheme": { @@ -9403,11 +10005,18 @@ "smithy.api#jsonName": "ipScheme" } }, - "IpAddress": { + "DnsAddresses": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The DNS addresses of the input device.", + "smithy.api#jsonName": "dnsAddresses" + } + }, + "Gateway": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The IP address of the input device.", - "smithy.api#jsonName": "ipAddress" + "smithy.api#documentation": "The network gateway IP address.", + "smithy.api#jsonName": "gateway" } } }, @@ -9480,6 +10089,13 @@ "com.amazonaws.medialive#InputDeviceSummary": { "type": "structure", "members": { + "SerialNumber": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique serial number of the input device.", + "smithy.api#jsonName": "serialNumber" + } + }, "DeviceSettingsSyncState": { "target": "com.amazonaws.medialive#DeviceSettingsSyncState", "traits": { @@ -9494,18 +10110,25 @@ "smithy.api#jsonName": "name" } }, - "Id": { + "Type": { + "target": "com.amazonaws.medialive#InputDeviceType", + "traits": { + "smithy.api#documentation": "The type of the input device.", + "smithy.api#jsonName": "type" + } + }, + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The unique ARN of the input device.", + "smithy.api#jsonName": "arn" } }, - "MacAddress": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The network MAC address of the input device.", - "smithy.api#jsonName": "macAddress" + "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#jsonName": "id" } }, "HdDeviceSettings": { @@ -9515,6 +10138,13 @@ "smithy.api#jsonName": "hdDeviceSettings" } }, + "MacAddress": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The network MAC address of the input device.", + "smithy.api#jsonName": "macAddress" + } + }, "ConnectionState": { "target": "com.amazonaws.medialive#InputDeviceConnectionState", "traits": { @@ -9522,33 +10152,12 @@ "smithy.api#jsonName": "connectionState" } }, - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique ARN of the input device.", - "smithy.api#jsonName": "arn" - } - }, "NetworkSettings": { "target": "com.amazonaws.medialive#InputDeviceNetworkSettings", "traits": { "smithy.api#documentation": "Network settings for the input device.", "smithy.api#jsonName": "networkSettings" } - }, - "Type": { - "target": "com.amazonaws.medialive#InputDeviceType", - "traits": { - "smithy.api#documentation": "The type of the input device.", - "smithy.api#jsonName": "type" - } - }, - "SerialNumber": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique serial number of the input device.", - "smithy.api#jsonName": "serialNumber" - } } }, "traits": { @@ -9558,9 +10167,26 @@ "com.amazonaws.medialive#InputDeviceThumbnail": { "type": "blob", "traits": { + "smithy.api#documentation": "The binary data for the thumbnail that the Link device has most recently sent to MediaLive.", "smithy.api#streaming": {} } }, + "com.amazonaws.medialive#InputDeviceTransferType": { + "type": "string", + "traits": { + "smithy.api#documentation": "The type of device transfer. INCOMING for an input device that is being transferred to you, OUTGOING for an input device that you are transferring to another AWS account.", + "smithy.api#enum": [ + { + "value": "OUTGOING", + "name": "OUTGOING" + }, + { + "value": "INCOMING", + "name": "INCOMING" + } + ] + } + }, "com.amazonaws.medialive#InputDeviceType": { "type": "string", "traits": { @@ -9604,18 +10230,18 @@ "smithy.api#required": {} } }, - "PasswordParam": { + "Username": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", - "smithy.api#jsonName": "passwordParam" + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "username" } }, - "Username": { + "PasswordParam": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "username" + "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", + "smithy.api#jsonName": "passwordParam" } } }, @@ -9694,18 +10320,11 @@ "com.amazonaws.medialive#InputLossBehavior": { "type": "structure", "members": { - "RepeatFrameMsec": { - "target": "com.amazonaws.medialive#__integerMin0Max1000000", - "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "repeatFrameMsec" - } - }, - "BlackFrameMsec": { - "target": "com.amazonaws.medialive#__integerMin0Max1000000", + "InputLossImageSlate": { + "target": "com.amazonaws.medialive#InputLocation", "traits": { - "smithy.api#documentation": "Documentation update needed", - "smithy.api#jsonName": "blackFrameMsec" + "smithy.api#documentation": "When input loss image type is \"slate\" these fields specify the parameters for accessing the slate.", + "smithy.api#jsonName": "inputLossImageSlate" } }, "InputLossImageType": { @@ -9715,6 +10334,13 @@ "smithy.api#jsonName": "inputLossImageType" } }, + "BlackFrameMsec": { + "target": "com.amazonaws.medialive#__integerMin0Max1000000", + "traits": { + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "blackFrameMsec" + } + }, "InputLossImageColor": { "target": "com.amazonaws.medialive#__stringMin6Max6", "traits": { @@ -9722,11 +10348,11 @@ "smithy.api#jsonName": "inputLossImageColor" } }, - "InputLossImageSlate": { - "target": "com.amazonaws.medialive#InputLocation", + "RepeatFrameMsec": { + "target": "com.amazonaws.medialive#__integerMin0Max1000000", "traits": { - "smithy.api#documentation": "When input loss image type is \"slate\" these fields specify the parameters for accessing the slate.", - "smithy.api#jsonName": "inputLossImageSlate" + "smithy.api#documentation": "Documentation update needed", + "smithy.api#jsonName": "repeatFrameMsec" } } }, @@ -9789,6 +10415,13 @@ "com.amazonaws.medialive#InputPrepareScheduleActionSettings": { "type": "structure", "members": { + "InputAttachmentNameReference": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated.", + "smithy.api#jsonName": "inputAttachmentNameReference" + } + }, "InputClippingSettings": { "target": "com.amazonaws.medialive#InputClippingSettings", "traits": { @@ -9802,13 +10435,6 @@ "smithy.api#documentation": "The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.", "smithy.api#jsonName": "urlPath" } - }, - "InputAttachmentNameReference": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated.", - "smithy.api#jsonName": "inputAttachmentNameReference" - } } }, "traits": { @@ -9838,6 +10464,13 @@ "com.amazonaws.medialive#InputSecurityGroup": { "type": "structure", "members": { + "State": { + "target": "com.amazonaws.medialive#InputSecurityGroupState", + "traits": { + "smithy.api#documentation": "The current state of the Input Security Group.", + "smithy.api#jsonName": "state" + } + }, "Id": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -9845,13 +10478,6 @@ "smithy.api#jsonName": "id" } }, - "WhitelistRules": { - "target": "com.amazonaws.medialive#__listOfInputWhitelistRule", - "traits": { - "smithy.api#documentation": "Whitelist rules and their sync status", - "smithy.api#jsonName": "whitelistRules" - } - }, "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -9859,13 +10485,6 @@ "smithy.api#jsonName": "arn" } }, - "State": { - "target": "com.amazonaws.medialive#InputSecurityGroupState", - "traits": { - "smithy.api#documentation": "The current state of the Input Security Group.", - "smithy.api#jsonName": "state" - } - }, "Inputs": { "target": "com.amazonaws.medialive#__listOf__string", "traits": { @@ -9879,6 +10498,13 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "WhitelistRules": { + "target": "com.amazonaws.medialive#__listOfInputWhitelistRule", + "traits": { + "smithy.api#documentation": "Whitelist rules and their sync status", + "smithy.api#jsonName": "whitelistRules" + } } }, "traits": { @@ -9912,11 +10538,11 @@ "com.amazonaws.medialive#InputSettings": { "type": "structure", "members": { - "InputFilter": { - "target": "com.amazonaws.medialive#InputFilter", + "DeblockFilter": { + "target": "com.amazonaws.medialive#InputDeblockFilter", "traits": { - "smithy.api#documentation": "Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.\n1) auto - filtering will be applied depending on input type/quality\n2) disabled - no filtering will be applied to the input\n3) forced - filtering will be applied regardless of input type", - "smithy.api#jsonName": "inputFilter" + "smithy.api#documentation": "Enable or disable the deblock filter when filtering.", + "smithy.api#jsonName": "deblockFilter" } }, "FilterStrength": { @@ -9926,25 +10552,18 @@ "smithy.api#jsonName": "filterStrength" } }, - "Smpte2038DataPreference": { - "target": "com.amazonaws.medialive#Smpte2038DataPreference", - "traits": { - "smithy.api#documentation": "Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages.\n- PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).\n- IGNORE: Never extract any ancillary data from SMPTE-2038.", - "smithy.api#jsonName": "smpte2038DataPreference" - } - }, - "CaptionSelectors": { - "target": "com.amazonaws.medialive#__listOfCaptionSelector", + "InputFilter": { + "target": "com.amazonaws.medialive#InputFilter", "traits": { - "smithy.api#documentation": "Used to select the caption input to use for inputs that have multiple available.", - "smithy.api#jsonName": "captionSelectors" + "smithy.api#documentation": "Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.\n1) auto - filtering will be applied depending on input type/quality\n2) disabled - no filtering will be applied to the input\n3) forced - filtering will be applied regardless of input type", + "smithy.api#jsonName": "inputFilter" } }, - "AudioSelectors": { - "target": "com.amazonaws.medialive#__listOfAudioSelector", + "SourceEndBehavior": { + "target": "com.amazonaws.medialive#InputSourceEndBehavior", "traits": { - "smithy.api#documentation": "Used to select the audio stream to decode for inputs that have multiple available.", - "smithy.api#jsonName": "audioSelectors" + "smithy.api#documentation": "Loop input if it is a file. This allows a file input to be streamed indefinitely.", + "smithy.api#jsonName": "sourceEndBehavior" } }, "VideoSelector": { @@ -9954,25 +10573,25 @@ "smithy.api#jsonName": "videoSelector" } }, - "SourceEndBehavior": { - "target": "com.amazonaws.medialive#InputSourceEndBehavior", + "Smpte2038DataPreference": { + "target": "com.amazonaws.medialive#Smpte2038DataPreference", "traits": { - "smithy.api#documentation": "Loop input if it is a file. This allows a file input to be streamed indefinitely.", - "smithy.api#jsonName": "sourceEndBehavior" + "smithy.api#documentation": "Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages.\n- PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).\n- IGNORE: Never extract any ancillary data from SMPTE-2038.", + "smithy.api#jsonName": "smpte2038DataPreference" } }, - "DeblockFilter": { - "target": "com.amazonaws.medialive#InputDeblockFilter", + "AudioSelectors": { + "target": "com.amazonaws.medialive#__listOfAudioSelector", "traits": { - "smithy.api#documentation": "Enable or disable the deblock filter when filtering.", - "smithy.api#jsonName": "deblockFilter" + "smithy.api#documentation": "Used to select the audio stream to decode for inputs that have multiple available.", + "smithy.api#jsonName": "audioSelectors" } }, - "NetworkInputSettings": { - "target": "com.amazonaws.medialive#NetworkInputSettings", + "CaptionSelectors": { + "target": "com.amazonaws.medialive#__listOfCaptionSelector", "traits": { - "smithy.api#documentation": "Input settings.", - "smithy.api#jsonName": "networkInputSettings" + "smithy.api#documentation": "Used to select the caption input to use for inputs that have multiple available.", + "smithy.api#jsonName": "captionSelectors" } }, "DenoiseFilter": { @@ -9981,6 +10600,13 @@ "smithy.api#documentation": "Enable or disable the denoise filter when filtering.", "smithy.api#jsonName": "denoiseFilter" } + }, + "NetworkInputSettings": { + "target": "com.amazonaws.medialive#NetworkInputSettings", + "traits": { + "smithy.api#documentation": "Input settings.", + "smithy.api#jsonName": "networkInputSettings" + } } }, "traits": { @@ -9997,18 +10623,18 @@ "smithy.api#jsonName": "url" } }, - "Username": { + "PasswordParam": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The username for the input source.", - "smithy.api#jsonName": "username" + "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", + "smithy.api#jsonName": "passwordParam" } }, - "PasswordParam": { + "Username": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", - "smithy.api#jsonName": "passwordParam" + "smithy.api#documentation": "The username for the input source.", + "smithy.api#jsonName": "username" } } }, @@ -10035,6 +10661,13 @@ "com.amazonaws.medialive#InputSourceRequest": { "type": "structure", "members": { + "PasswordParam": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", + "smithy.api#jsonName": "passwordParam" + } + }, "Url": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -10048,13 +10681,6 @@ "smithy.api#documentation": "The username for the input source.", "smithy.api#jsonName": "username" } - }, - "PasswordParam": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The key used to extract the password from EC2 Parameter store.", - "smithy.api#jsonName": "passwordParam" - } } }, "traits": { @@ -10080,13 +10706,6 @@ "com.amazonaws.medialive#InputSpecification": { "type": "structure", "members": { - "Codec": { - "target": "com.amazonaws.medialive#InputCodec", - "traits": { - "smithy.api#documentation": "Input codec", - "smithy.api#jsonName": "codec" - } - }, "Resolution": { "target": "com.amazonaws.medialive#InputResolution", "traits": { @@ -10100,6 +10719,13 @@ "smithy.api#documentation": "Maximum input bitrate, categorized coarsely", "smithy.api#jsonName": "maximumBitrate" } + }, + "Codec": { + "target": "com.amazonaws.medialive#InputCodec", + "traits": { + "smithy.api#documentation": "Input codec", + "smithy.api#jsonName": "codec" + } } }, "traits": { @@ -10137,6 +10763,13 @@ "com.amazonaws.medialive#InputSwitchScheduleActionSettings": { "type": "structure", "members": { + "InputClippingSettings": { + "target": "com.amazonaws.medialive#InputClippingSettings", + "traits": { + "smithy.api#documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.", + "smithy.api#jsonName": "inputClippingSettings" + } + }, "InputAttachmentNameReference": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -10151,13 +10784,6 @@ "smithy.api#documentation": "The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.", "smithy.api#jsonName": "urlPath" } - }, - "InputClippingSettings": { - "target": "com.amazonaws.medialive#InputClippingSettings", - "traits": { - "smithy.api#documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.", - "smithy.api#jsonName": "inputClippingSettings" - } } }, "traits": { @@ -10216,6 +10842,10 @@ { "value": "INPUT_DEVICE", "name": "INPUT_DEVICE" + }, + { + "value": "AWS_CDI", + "name": "AWS_CDI" } ] } @@ -10353,6 +10983,12 @@ "method": "GET", "uri": "/prod/channels", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Channels", + "pageSize": "MaxResults" } } }, @@ -10396,13 +11032,13 @@ "smithy.api#documentation": "Placeholder documentation for ListChannelsResponse" } }, - "com.amazonaws.medialive#ListInputDevices": { + "com.amazonaws.medialive#ListInputDeviceTransfers": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#ListInputDevicesRequest" + "target": "com.amazonaws.medialive#ListInputDeviceTransfersRequest" }, "output": { - "target": "com.amazonaws.medialive#ListInputDevicesResponse" + "target": "com.amazonaws.medialive#ListInputDeviceTransfersResponse" }, "errors": [ { @@ -10422,45 +11058,61 @@ }, { "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" } ], "traits": { - "smithy.api#documentation": "List input devices", + "smithy.api#documentation": "List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.", "smithy.api#http": { "method": "GET", - "uri": "/prod/inputDevices", + "uri": "/prod/inputDeviceTransfers", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InputDeviceTransfers", + "pageSize": "MaxResults" } } }, - "com.amazonaws.medialive#ListInputDevicesRequest": { + "com.amazonaws.medialive#ListInputDeviceTransfersRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", + "NextToken": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "maxResults" + "smithy.api#httpQuery": "nextToken" } }, - "NextToken": { + "TransferType": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#httpQuery": "transferType", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputDevicesRequest" + "smithy.api#documentation": "Placeholder documentation for ListInputDeviceTransfersRequest" } }, - "com.amazonaws.medialive#ListInputDevicesResponse": { + "com.amazonaws.medialive#ListInputDeviceTransfersResponse": { "type": "structure", "members": { - "InputDevices": { - "target": "com.amazonaws.medialive#__listOfInputDeviceSummary", + "InputDeviceTransfers": { + "target": "com.amazonaws.medialive#__listOfTransferringInputDeviceSummary", "traits": { - "smithy.api#documentation": "The list of input devices.", - "smithy.api#jsonName": "inputDevices" + "smithy.api#documentation": "The list of devices that you are transferring or are being transferred to you.", + "smithy.api#jsonName": "inputDeviceTransfers" } }, "NextToken": { @@ -10472,16 +11124,16 @@ } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputDevicesResponse" + "smithy.api#documentation": "Placeholder documentation for ListInputDeviceTransfersResponse" } }, - "com.amazonaws.medialive#ListInputSecurityGroups": { + "com.amazonaws.medialive#ListInputDevices": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#ListInputSecurityGroupsRequest" + "target": "com.amazonaws.medialive#ListInputDevicesRequest" }, "output": { - "target": "com.amazonaws.medialive#ListInputSecurityGroupsResponse" + "target": "com.amazonaws.medialive#ListInputDevicesResponse" }, "errors": [ { @@ -10504,15 +11156,21 @@ } ], "traits": { - "smithy.api#documentation": "Produces a list of Input Security Groups for an account", + "smithy.api#documentation": "List input devices", "smithy.api#http": { "method": "GET", - "uri": "/prod/inputSecurityGroups", + "uri": "/prod/inputDevices", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InputDevices", + "pageSize": "MaxResults" } } }, - "com.amazonaws.medialive#ListInputSecurityGroupsRequest": { + "com.amazonaws.medialive#ListInputDevicesRequest": { "type": "structure", "members": { "MaxResults": { @@ -10529,37 +11187,38 @@ } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsRequest" + "smithy.api#documentation": "Placeholder documentation for ListInputDevicesRequest" } }, - "com.amazonaws.medialive#ListInputSecurityGroupsResponse": { + "com.amazonaws.medialive#ListInputDevicesResponse": { "type": "structure", "members": { - "InputSecurityGroups": { - "target": "com.amazonaws.medialive#__listOfInputSecurityGroup", + "InputDevices": { + "target": "com.amazonaws.medialive#__listOfInputDeviceSummary", "traits": { - "smithy.api#documentation": "List of input security groups", - "smithy.api#jsonName": "inputSecurityGroups" + "smithy.api#documentation": "The list of input devices.", + "smithy.api#jsonName": "inputDevices" } }, "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { + "smithy.api#documentation": "A token to get additional list results.", "smithy.api#jsonName": "nextToken" } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsResponse" + "smithy.api#documentation": "Placeholder documentation for ListInputDevicesResponse" } }, - "com.amazonaws.medialive#ListInputs": { + "com.amazonaws.medialive#ListInputSecurityGroups": { "type": "operation", "input": { - "target": "com.amazonaws.medialive#ListInputsRequest" + "target": "com.amazonaws.medialive#ListInputSecurityGroupsRequest" }, "output": { - "target": "com.amazonaws.medialive#ListInputsResponse" + "target": "com.amazonaws.medialive#ListInputSecurityGroupsResponse" }, "errors": [ { @@ -10582,15 +11241,21 @@ } ], "traits": { - "smithy.api#documentation": "Produces list of inputs that have been created", + "smithy.api#documentation": "Produces a list of Input Security Groups for an account", "smithy.api#http": { "method": "GET", - "uri": "/prod/inputs", + "uri": "/prod/inputSecurityGroups", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InputSecurityGroups", + "pageSize": "MaxResults" } } }, - "com.amazonaws.medialive#ListInputsRequest": { + "com.amazonaws.medialive#ListInputSecurityGroupsRequest": { "type": "structure", "members": { "NextToken": { @@ -10607,30 +11272,114 @@ } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputsRequest" + "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsRequest" } }, - "com.amazonaws.medialive#ListInputsResponse": { + "com.amazonaws.medialive#ListInputSecurityGroupsResponse": { "type": "structure", "members": { - "Inputs": { - "target": "com.amazonaws.medialive#__listOfInput", - "traits": { - "smithy.api#jsonName": "inputs" - } - }, "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { "smithy.api#jsonName": "nextToken" } + }, + "InputSecurityGroups": { + "target": "com.amazonaws.medialive#__listOfInputSecurityGroup", + "traits": { + "smithy.api#documentation": "List of input security groups", + "smithy.api#jsonName": "inputSecurityGroups" + } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for ListInputsResponse" + "smithy.api#documentation": "Placeholder documentation for ListInputSecurityGroupsResponse" } }, - "com.amazonaws.medialive#ListMultiplexPrograms": { + "com.amazonaws.medialive#ListInputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#ListInputsRequest" + }, + "output": { + "target": "com.amazonaws.medialive#ListInputsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Produces list of inputs that have been created", + "smithy.api#http": { + "method": "GET", + "uri": "/prod/inputs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Inputs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.medialive#ListInputsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListInputsRequest" + } + }, + "com.amazonaws.medialive#ListInputsResponse": { + "type": "structure", + "members": { + "Inputs": { + "target": "com.amazonaws.medialive#__listOfInput", + "traits": { + "smithy.api#jsonName": "inputs" + } + }, + "NextToken": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for ListInputsResponse" + } + }, + "com.amazonaws.medialive#ListMultiplexPrograms": { "type": "operation", "input": { "target": "com.amazonaws.medialive#ListMultiplexProgramsRequest" @@ -10667,25 +11416,31 @@ "method": "GET", "uri": "/prod/multiplexes/{MultiplexId}/programs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MultiplexPrograms", + "pageSize": "MaxResults" } } }, "com.amazonaws.medialive#ListMultiplexProgramsRequest": { "type": "structure", "members": { - "MultiplexId": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID of the multiplex that the programs belong to.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The token to retrieve the next page of results.", + "smithy.api#httpQuery": "nextToken" } }, - "NextToken": { + "MultiplexId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The token to retrieve the next page of results.", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The ID of the multiplex that the programs belong to.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "MaxResults": { @@ -10756,6 +11511,12 @@ "method": "GET", "uri": "/prod/multiplexes", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Multiplexes", + "pageSize": "MaxResults" } } }, @@ -10784,19 +11545,19 @@ "com.amazonaws.medialive#ListMultiplexesResponse": { "type": "structure", "members": { - "Multiplexes": { - "target": "com.amazonaws.medialive#__listOfMultiplexSummary", - "traits": { - "smithy.api#documentation": "List of multiplexes.", - "smithy.api#jsonName": "multiplexes" - } - }, "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { "smithy.api#documentation": "Token for the next ListMultiplexes request.", "smithy.api#jsonName": "nextToken" } + }, + "Multiplexes": { + "target": "com.amazonaws.medialive#__listOfMultiplexSummary", + "traits": { + "smithy.api#documentation": "List of multiplexes.", + "smithy.api#jsonName": "multiplexes" + } } }, "traits": { @@ -10837,24 +11598,30 @@ "method": "GET", "uri": "/prod/offerings", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Offerings", + "pageSize": "MaxResults" } } }, "com.amazonaws.medialive#ListOfferingsRequest": { "type": "structure", "members": { - "Codec": { + "ChannelClass": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'", - "smithy.api#httpQuery": "codec" + "smithy.api#documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'", + "smithy.api#httpQuery": "channelClass" } }, - "ChannelClass": { + "MaximumFramerate": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'", - "smithy.api#httpQuery": "channelClass" + "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", + "smithy.api#httpQuery": "maximumFramerate" } }, "Duration": { @@ -10871,32 +11638,25 @@ "smithy.api#httpQuery": "resolution" } }, - "MaximumFramerate": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", - "smithy.api#httpQuery": "maximumFramerate" - } - }, - "ChannelConfiguration": { + "SpecialFeature": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)", - "smithy.api#httpQuery": "channelConfiguration" + "smithy.api#documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", + "smithy.api#httpQuery": "specialFeature" } }, - "ResourceType": { + "MaximumBitrate": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", - "smithy.api#httpQuery": "resourceType" + "smithy.api#documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'", + "smithy.api#httpQuery": "maximumBitrate" } }, - "VideoQuality": { + "ChannelConfiguration": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'", - "smithy.api#httpQuery": "videoQuality" + "smithy.api#documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)", + "smithy.api#httpQuery": "channelConfiguration" } }, "NextToken": { @@ -10911,18 +11671,25 @@ "smithy.api#httpQuery": "maxResults" } }, - "MaximumBitrate": { + "Codec": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'", - "smithy.api#httpQuery": "maximumBitrate" + "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'", + "smithy.api#httpQuery": "codec" } }, - "SpecialFeature": { + "VideoQuality": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", - "smithy.api#httpQuery": "specialFeature" + "smithy.api#documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'", + "smithy.api#httpQuery": "videoQuality" + } + }, + "ResourceType": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", + "smithy.api#httpQuery": "resourceType" } } }, @@ -10986,19 +11753,18 @@ "method": "GET", "uri": "/prod/reservations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Reservations", + "pageSize": "MaxResults" } } }, "com.amazonaws.medialive#ListReservationsRequest": { "type": "structure", "members": { - "Resolution": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'", - "smithy.api#httpQuery": "resolution" - } - }, "ResourceType": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -11006,23 +11772,11 @@ "smithy.api#httpQuery": "resourceType" } }, - "MaximumFramerate": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", - "smithy.api#httpQuery": "maximumFramerate" - } - }, - "MaxResults": { - "target": "com.amazonaws.medialive#MaxResults", - "traits": { - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { + "Codec": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'", + "smithy.api#httpQuery": "codec" } }, "MaximumBitrate": { @@ -11039,11 +11793,16 @@ "smithy.api#httpQuery": "specialFeature" } }, - "Codec": { + "NextToken": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'", - "smithy.api#httpQuery": "codec" + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.medialive#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" } }, "VideoQuality": { @@ -11059,6 +11818,20 @@ "smithy.api#documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'", "smithy.api#httpQuery": "channelClass" } + }, + "Resolution": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'", + "smithy.api#httpQuery": "resolution" + } + }, + "MaximumFramerate": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'", + "smithy.api#httpQuery": "maximumFramerate" + } } }, "traits": { @@ -11482,95 +12255,102 @@ "com.amazonaws.medialive#M2tsSettings": { "type": "structure", "members": { - "Scte35Pid": { - "target": "com.amazonaws.medialive#__string", + "DvbTdtSettings": { + "target": "com.amazonaws.medialive#DvbTdtSettings", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "scte35Pid" + "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbTdtSettings" } }, - "Scte27Pids": { - "target": "com.amazonaws.medialive#__string", + "Arib": { + "target": "com.amazonaws.medialive#M2tsArib", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "scte27Pids" + "smithy.api#documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.", + "smithy.api#jsonName": "arib" } }, - "EbpPlacement": { - "target": "com.amazonaws.medialive#M2tsEbpPlacement", + "AudioStreamType": { + "target": "com.amazonaws.medialive#M2tsAudioStreamType", "traits": { - "smithy.api#documentation": "Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.", - "smithy.api#jsonName": "ebpPlacement" + "smithy.api#documentation": "When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.", + "smithy.api#jsonName": "audioStreamType" } }, - "CcDescriptor": { - "target": "com.amazonaws.medialive#M2tsCcDescriptor", + "DvbNitSettings": { + "target": "com.amazonaws.medialive#DvbNitSettings", "traits": { - "smithy.api#documentation": "When set to enabled, generates captionServiceDescriptor in PMT.", - "smithy.api#jsonName": "ccDescriptor" + "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbNitSettings" } }, - "EtvSignalPid": { - "target": "com.amazonaws.medialive#__string", + "NullPacketBitrate": { + "target": "com.amazonaws.medialive#__doubleMin0", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "etvSignalPid" + "smithy.api#documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.", + "smithy.api#jsonName": "nullPacketBitrate" } }, - "TransportStreamId": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", - "traits": { - "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", - "smithy.api#jsonName": "transportStreamId" + "BufferModel": { + "target": "com.amazonaws.medialive#M2tsBufferModel", + "traits": { + "smithy.api#documentation": "Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.", + "smithy.api#jsonName": "bufferModel" } }, - "AudioFramesPerPes": { - "target": "com.amazonaws.medialive#__integerMin0", + "EtvPlatformPid": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", - "smithy.api#jsonName": "audioFramesPerPes" + "smithy.api#documentation": "Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "etvPlatformPid" } }, - "AudioPids": { + "TimedMetadataPid": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "audioPids" + "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "timedMetadataPid" } }, - "AribCaptionsPid": { - "target": "com.amazonaws.medialive#__string", + "AribCaptionsPidControl": { + "target": "com.amazonaws.medialive#M2tsAribCaptionsPidControl", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "aribCaptionsPid" + "smithy.api#documentation": "If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.", + "smithy.api#jsonName": "aribCaptionsPidControl" } }, - "Bitrate": { - "target": "com.amazonaws.medialive#__integerMin0", + "TimedMetadataBehavior": { + "target": "com.amazonaws.medialive#M2tsTimedMetadataBehavior", "traits": { - "smithy.api#documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "When set to passthrough, timed metadata will be passed through from input to output.", + "smithy.api#jsonName": "timedMetadataBehavior" } }, - "VideoPid": { + "PcrControl": { + "target": "com.amazonaws.medialive#M2tsPcrControl", + "traits": { + "smithy.api#documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", + "smithy.api#jsonName": "pcrControl" + } + }, + "PmtPid": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "videoPid" + "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "pmtPid" } }, - "SegmentationMarkers": { - "target": "com.amazonaws.medialive#M2tsSegmentationMarkers", + "AbsentInputAudioBehavior": { + "target": "com.amazonaws.medialive#M2tsAbsentInputAudioBehavior", "traits": { - "smithy.api#documentation": "Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.", - "smithy.api#jsonName": "segmentationMarkers" + "smithy.api#documentation": "When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.", + "smithy.api#jsonName": "absentInputAudioBehavior" } }, - "EtvPlatformPid": { - "target": "com.amazonaws.medialive#__string", + "RateMode": { + "target": "com.amazonaws.medialive#M2tsRateMode", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "etvPlatformPid" + "smithy.api#documentation": "When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.", + "smithy.api#jsonName": "rateMode" } }, "FragmentTime": { @@ -11580,88 +12360,81 @@ "smithy.api#jsonName": "fragmentTime" } }, - "AbsentInputAudioBehavior": { - "target": "com.amazonaws.medialive#M2tsAbsentInputAudioBehavior", - "traits": { - "smithy.api#documentation": "When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.", - "smithy.api#jsonName": "absentInputAudioBehavior" - } - }, - "PatInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", + "ProgramNum": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", - "smithy.api#jsonName": "patInterval" + "smithy.api#documentation": "The value of the program number field in the Program Map Table.", + "smithy.api#jsonName": "programNum" } }, - "PcrPeriod": { - "target": "com.amazonaws.medialive#__integerMin0Max500", + "AudioPids": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.", - "smithy.api#jsonName": "pcrPeriod" + "smithy.api#documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "audioPids" } }, - "Scte35Control": { - "target": "com.amazonaws.medialive#M2tsScte35Control", + "NielsenId3Behavior": { + "target": "com.amazonaws.medialive#M2tsNielsenId3Behavior", "traits": { - "smithy.api#documentation": "Optionally pass SCTE-35 signals from the input source to this output.", - "smithy.api#jsonName": "scte35Control" + "smithy.api#documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "smithy.api#jsonName": "nielsenId3Behavior" } }, - "TimedMetadataBehavior": { - "target": "com.amazonaws.medialive#M2tsTimedMetadataBehavior", + "Klv": { + "target": "com.amazonaws.medialive#M2tsKlv", "traits": { - "smithy.api#documentation": "When set to passthrough, timed metadata will be passed through from input to output.", - "smithy.api#jsonName": "timedMetadataBehavior" + "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", + "smithy.api#jsonName": "klv" } }, - "DvbNitSettings": { - "target": "com.amazonaws.medialive#DvbNitSettings", + "TransportStreamId": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbNitSettings" + "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", + "smithy.api#jsonName": "transportStreamId" } }, - "SegmentationStyle": { - "target": "com.amazonaws.medialive#M2tsSegmentationStyle", + "KlvDataPids": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.\n\nWhen a segmentation style of \"resetCadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.\n\nWhen a segmentation style of \"maintainCadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.", - "smithy.api#jsonName": "segmentationStyle" + "smithy.api#documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "klvDataPids" } }, - "DvbTdtSettings": { - "target": "com.amazonaws.medialive#DvbTdtSettings", + "EbpLookaheadMs": { + "target": "com.amazonaws.medialive#__integerMin0Max10000", "traits": { - "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbTdtSettings" + "smithy.api#documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.", + "smithy.api#jsonName": "ebpLookaheadMs" } }, - "AribCaptionsPidControl": { - "target": "com.amazonaws.medialive#M2tsAribCaptionsPidControl", + "AudioFramesPerPes": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.", - "smithy.api#jsonName": "aribCaptionsPidControl" + "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", + "smithy.api#jsonName": "audioFramesPerPes" } }, - "Klv": { - "target": "com.amazonaws.medialive#M2tsKlv", + "Scte35Control": { + "target": "com.amazonaws.medialive#M2tsScte35Control", "traits": { - "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", - "smithy.api#jsonName": "klv" + "smithy.api#documentation": "Optionally pass SCTE-35 signals from the input source to this output.", + "smithy.api#jsonName": "scte35Control" } }, - "AudioStreamType": { - "target": "com.amazonaws.medialive#M2tsAudioStreamType", + "PatInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.", - "smithy.api#jsonName": "audioStreamType" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", + "smithy.api#jsonName": "patInterval" } }, - "EbpLookaheadMs": { - "target": "com.amazonaws.medialive#__integerMin0Max10000", + "SegmentationStyle": { + "target": "com.amazonaws.medialive#M2tsSegmentationStyle", "traits": { - "smithy.api#documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.", - "smithy.api#jsonName": "ebpLookaheadMs" + "smithy.api#documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.\n\nWhen a segmentation style of \"resetCadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.\n\nWhen a segmentation style of \"maintainCadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule.", + "smithy.api#jsonName": "segmentationStyle" } }, "EsRateInPes": { @@ -11671,74 +12444,88 @@ "smithy.api#jsonName": "esRateInPes" } }, - "NielsenId3Behavior": { - "target": "com.amazonaws.medialive#M2tsNielsenId3Behavior", + "SegmentationMarkers": { + "target": "com.amazonaws.medialive#M2tsSegmentationMarkers", "traits": { - "smithy.api#documentation": "If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", - "smithy.api#jsonName": "nielsenId3Behavior" + "smithy.api#documentation": "Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.", + "smithy.api#jsonName": "segmentationMarkers" } }, - "Arib": { - "target": "com.amazonaws.medialive#M2tsArib", + "Bitrate": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.", - "smithy.api#jsonName": "arib" + "smithy.api#documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.", + "smithy.api#jsonName": "bitrate" } }, - "KlvDataPids": { + "Scte27Pids": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "klvDataPids" + "smithy.api#documentation": "Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "scte27Pids" } }, - "PmtPid": { - "target": "com.amazonaws.medialive#__string", + "CcDescriptor": { + "target": "com.amazonaws.medialive#M2tsCcDescriptor", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "pmtPid" + "smithy.api#documentation": "When set to enabled, generates captionServiceDescriptor in PMT.", + "smithy.api#jsonName": "ccDescriptor" } }, - "DvbTeletextPid": { + "SegmentationTime": { + "target": "com.amazonaws.medialive#__doubleMin1", + "traits": { + "smithy.api#documentation": "The length in seconds of each segment. Required unless markers is set to _none_.", + "smithy.api#jsonName": "segmentationTime" + } + }, + "EtvSignalPid": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "dvbTeletextPid" + "smithy.api#documentation": "Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "etvSignalPid" } }, - "ProgramNum": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", + "DvbSdtSettings": { + "target": "com.amazonaws.medialive#DvbSdtSettings", "traits": { - "smithy.api#documentation": "The value of the program number field in the Program Map Table.", - "smithy.api#jsonName": "programNum" + "smithy.api#documentation": "Inserts DVB Service Description Table (SDT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbSdtSettings" } }, - "PcrControl": { - "target": "com.amazonaws.medialive#M2tsPcrControl", + "Scte35Pid": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", - "smithy.api#jsonName": "pcrControl" + "smithy.api#documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "scte35Pid" } }, - "RateMode": { - "target": "com.amazonaws.medialive#M2tsRateMode", + "EcmPid": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.", - "smithy.api#jsonName": "rateMode" + "smithy.api#documentation": "This field is unused and deprecated.", + "smithy.api#jsonName": "ecmPid" } }, - "DvbSubPids": { + "AudioBufferModel": { + "target": "com.amazonaws.medialive#M2tsAudioBufferModel", + "traits": { + "smithy.api#documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.", + "smithy.api#jsonName": "audioBufferModel" + } + }, + "DvbTeletextPid": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "dvbSubPids" + "smithy.api#documentation": "Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "dvbTeletextPid" } }, - "EbpAudioInterval": { - "target": "com.amazonaws.medialive#M2tsAudioInterval", + "Ebif": { + "target": "com.amazonaws.medialive#M2tsEbifControl", "traits": { - "smithy.api#documentation": "When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.", - "smithy.api#jsonName": "ebpAudioInterval" + "smithy.api#documentation": "If set to passthrough, passes any EBIF data from the input source to this output.", + "smithy.api#jsonName": "ebif" } }, "PcrPid": { @@ -11748,67 +12535,53 @@ "smithy.api#jsonName": "pcrPid" } }, - "PmtInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", + "PcrPeriod": { + "target": "com.amazonaws.medialive#__integerMin0Max500", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", - "smithy.api#jsonName": "pmtInterval" + "smithy.api#documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.", + "smithy.api#jsonName": "pcrPeriod" } }, - "SegmentationTime": { - "target": "com.amazonaws.medialive#__doubleMin1", - "traits": { - "smithy.api#documentation": "The length in seconds of each segment. Required unless markers is set to _none_.", - "smithy.api#jsonName": "segmentationTime" - } - }, - "BufferModel": { - "target": "com.amazonaws.medialive#M2tsBufferModel", + "EbpPlacement": { + "target": "com.amazonaws.medialive#M2tsEbpPlacement", "traits": { - "smithy.api#documentation": "If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.", - "smithy.api#jsonName": "bufferModel" + "smithy.api#documentation": "Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.", + "smithy.api#jsonName": "ebpPlacement" } }, - "TimedMetadataPid": { - "target": "com.amazonaws.medialive#__string", + "PmtInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.", + "smithy.api#jsonName": "pmtInterval" } }, - "EcmPid": { + "VideoPid": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "This field is unused and deprecated.", - "smithy.api#jsonName": "ecmPid" - } - }, - "NullPacketBitrate": { - "target": "com.amazonaws.medialive#__doubleMin0", - "traits": { - "smithy.api#documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.", - "smithy.api#jsonName": "nullPacketBitrate" + "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "videoPid" } }, - "DvbSdtSettings": { - "target": "com.amazonaws.medialive#DvbSdtSettings", + "EbpAudioInterval": { + "target": "com.amazonaws.medialive#M2tsAudioInterval", "traits": { - "smithy.api#documentation": "Inserts DVB Service Description Table (SDT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbSdtSettings" + "smithy.api#documentation": "When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.", + "smithy.api#jsonName": "ebpAudioInterval" } }, - "Ebif": { - "target": "com.amazonaws.medialive#M2tsEbifControl", + "AribCaptionsPid": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "If set to passthrough, passes any EBIF data from the input source to this output.", - "smithy.api#jsonName": "ebif" + "smithy.api#documentation": "Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "aribCaptionsPid" } }, - "AudioBufferModel": { - "target": "com.amazonaws.medialive#M2tsAudioBufferModel", + "DvbSubPids": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.", - "smithy.api#jsonName": "audioBufferModel" + "smithy.api#documentation": "Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "dvbSubPids" } } }, @@ -11883,6 +12656,20 @@ "com.amazonaws.medialive#M3u8Settings": { "type": "structure", "members": { + "TimedMetadataPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "timedMetadataPid" + } + }, + "AudioFramesPerPes": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", + "smithy.api#jsonName": "audioFramesPerPes" + } + }, "Scte35Pid": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -11890,6 +12677,13 @@ "smithy.api#jsonName": "scte35Pid" } }, + "PcrPid": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.", + "smithy.api#jsonName": "pcrPid" + } + }, "TimedMetadataBehavior": { "target": "com.amazonaws.medialive#M3u8TimedMetadataBehavior", "traits": { @@ -11897,18 +12691,18 @@ "smithy.api#jsonName": "timedMetadataBehavior" } }, - "VideoPid": { - "target": "com.amazonaws.medialive#__string", + "PmtInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.", - "smithy.api#jsonName": "videoPid" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file.", + "smithy.api#jsonName": "pmtInterval" } }, - "TimedMetadataPid": { - "target": "com.amazonaws.medialive#__string", + "Scte35Behavior": { + "target": "com.amazonaws.medialive#M3u8Scte35Behavior", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "If set to passthrough, passes any SCTE-35 signals from the input source to this output.", + "smithy.api#jsonName": "scte35Behavior" } }, "NielsenId3Behavior": { @@ -11925,13 +12719,6 @@ "smithy.api#jsonName": "pcrPeriod" } }, - "ProgramNum": { - "target": "com.amazonaws.medialive#__integerMin0Max65535", - "traits": { - "smithy.api#documentation": "The value of the program number field in the Program Map Table.", - "smithy.api#jsonName": "programNum" - } - }, "AudioPids": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -11939,18 +12726,18 @@ "smithy.api#jsonName": "audioPids" } }, - "PatInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", + "PmtPid": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file.", - "smithy.api#jsonName": "patInterval" + "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.", + "smithy.api#jsonName": "pmtPid" } }, - "EcmPid": { - "target": "com.amazonaws.medialive#__string", + "TransportStreamId": { + "target": "com.amazonaws.medialive#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "This parameter is unused and deprecated.", - "smithy.api#jsonName": "ecmPid" + "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", + "smithy.api#jsonName": "transportStreamId" } }, "PcrControl": { @@ -11960,46 +12747,32 @@ "smithy.api#jsonName": "pcrControl" } }, - "PmtPid": { - "target": "com.amazonaws.medialive#__string", + "PatInterval": { + "target": "com.amazonaws.medialive#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.", - "smithy.api#jsonName": "pmtPid" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file.", + "smithy.api#jsonName": "patInterval" } }, - "Scte35Behavior": { - "target": "com.amazonaws.medialive#M3u8Scte35Behavior", + "EcmPid": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "If set to passthrough, passes any SCTE-35 signals from the input source to this output.", - "smithy.api#jsonName": "scte35Behavior" + "smithy.api#documentation": "This parameter is unused and deprecated.", + "smithy.api#jsonName": "ecmPid" } }, - "TransportStreamId": { + "ProgramNum": { "target": "com.amazonaws.medialive#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", - "smithy.api#jsonName": "transportStreamId" - } - }, - "AudioFramesPerPes": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "The number of audio frames to insert for each PES packet.", - "smithy.api#jsonName": "audioFramesPerPes" + "smithy.api#documentation": "The value of the program number field in the Program Map Table.", + "smithy.api#jsonName": "programNum" } }, - "PcrPid": { + "VideoPid": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.", - "smithy.api#jsonName": "pcrPid" - } - }, - "PmtInterval": { - "target": "com.amazonaws.medialive#__integerMin0Max1000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file.", - "smithy.api#jsonName": "pmtInterval" + "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.", + "smithy.api#jsonName": "videoPid" } } }, @@ -12067,9 +12840,24 @@ "type": "service", "version": "2017-10-14", "operations": [ + { + "target": "com.amazonaws.medialive#AcceptInputDeviceTransfer" + }, + { + "target": "com.amazonaws.medialive#BatchDelete" + }, + { + "target": "com.amazonaws.medialive#BatchStart" + }, + { + "target": "com.amazonaws.medialive#BatchStop" + }, { "target": "com.amazonaws.medialive#BatchUpdateSchedule" }, + { + "target": "com.amazonaws.medialive#CancelInputDeviceTransfer" + }, { "target": "com.amazonaws.medialive#CreateChannel" }, @@ -12148,6 +12936,9 @@ { "target": "com.amazonaws.medialive#ListInputDevices" }, + { + "target": "com.amazonaws.medialive#ListInputDeviceTransfers" + }, { "target": "com.amazonaws.medialive#ListInputs" }, @@ -12172,6 +12963,9 @@ { "target": "com.amazonaws.medialive#PurchaseOffering" }, + { + "target": "com.amazonaws.medialive#RejectInputDeviceTransfer" + }, { "target": "com.amazonaws.medialive#StartChannel" }, @@ -12184,6 +12978,9 @@ { "target": "com.amazonaws.medialive#StopMultiplex" }, + { + "target": "com.amazonaws.medialive#TransferInputDevice" + }, { "target": "com.amazonaws.medialive#UpdateChannel" }, @@ -12281,11 +13078,11 @@ "com.amazonaws.medialive#Mp2Settings": { "type": "structure", "members": { - "SampleRate": { + "Bitrate": { "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Sample rate in Hz.", - "smithy.api#jsonName": "sampleRate" + "smithy.api#documentation": "Average bitrate in bits/second.", + "smithy.api#jsonName": "bitrate" } }, "CodingMode": { @@ -12295,11 +13092,11 @@ "smithy.api#jsonName": "codingMode" } }, - "Bitrate": { + "SampleRate": { "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Average bitrate in bits/second.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Sample rate in Hz.", + "smithy.api#jsonName": "sampleRate" } } }, @@ -12307,91 +13104,346 @@ "smithy.api#documentation": "Mp2 Settings" } }, - "com.amazonaws.medialive#MsSmoothGroupSettings": { - "type": "structure", - "members": { - "SendDelayMs": { - "target": "com.amazonaws.medialive#__integerMin0Max10000", - "traits": { - "smithy.api#documentation": "Number of milliseconds to delay the output from the second pipeline.", - "smithy.api#jsonName": "sendDelayMs" - } - }, - "EventId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "MS Smooth event ID to be sent to the IIS server.\n\nShould only be specified if eventIdMode is set to useConfigured.", - "smithy.api#jsonName": "eventId" - } - }, - "FilecacheDuration": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", - "smithy.api#jsonName": "filecacheDuration" + "com.amazonaws.medialive#Mpeg2AdaptiveQuantization": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Adaptive Quantization", + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "OFF", + "name": "OFF" } - }, - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.", - "smithy.api#jsonName": "connectionRetryInterval" + ] + } + }, + "com.amazonaws.medialive#Mpeg2ColorMetadata": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Color Metadata", + "smithy.api#enum": [ + { + "value": "IGNORE", + "name": "IGNORE" + }, + { + "value": "INSERT", + "name": "INSERT" } - }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.", - "smithy.api#jsonName": "restartDelay" + ] + } + }, + "com.amazonaws.medialive#Mpeg2ColorSpace": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Color Space", + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "PASSTHROUGH", + "name": "PASSTHROUGH" + } + ] + } + }, + "com.amazonaws.medialive#Mpeg2DisplayRatio": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Display Ratio", + "smithy.api#enum": [ + { + "value": "DISPLAYRATIO16X9", + "name": "DISPLAYRATIO16X9" + }, + { + "value": "DISPLAYRATIO4X3", + "name": "DISPLAYRATIO4X3" + } + ] + } + }, + "com.amazonaws.medialive#Mpeg2FilterSettings": { + "type": "structure", + "members": { + "TemporalFilterSettings": { + "target": "com.amazonaws.medialive#TemporalFilterSettings", + "traits": { + "smithy.api#jsonName": "temporalFilterSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Filter Settings" + } + }, + "com.amazonaws.medialive#Mpeg2GopSizeUnits": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Gop Size Units", + "smithy.api#enum": [ + { + "value": "FRAMES", + "name": "FRAMES" + }, + { + "value": "SECONDS", + "name": "SECONDS" + } + ] + } + }, + "com.amazonaws.medialive#Mpeg2ScanType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Scan Type", + "smithy.api#enum": [ + { + "value": "INTERLACED", + "name": "INTERLACED" + }, + { + "value": "PROGRESSIVE", + "name": "PROGRESSIVE" + } + ] + } + }, + "com.amazonaws.medialive#Mpeg2Settings": { + "type": "structure", + "members": { + "TimecodeInsertion": { + "target": "com.amazonaws.medialive#Mpeg2TimecodeInsertionBehavior", + "traits": { + "smithy.api#documentation": "Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \\\"MediaLive Features - Timecode configuration\\\" in the MediaLive User Guide.\nDISABLED: do not include timecodes.\nGOP_TIMECODE: Include timecode metadata in the GOP header.", + "smithy.api#jsonName": "timecodeInsertion" } }, - "SegmentationMode": { - "target": "com.amazonaws.medialive#SmoothGroupSegmentationMode", + "ColorMetadata": { + "target": "com.amazonaws.medialive#Mpeg2ColorMetadata", "traits": { - "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", - "smithy.api#jsonName": "segmentationMode" + "smithy.api#documentation": "Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.", + "smithy.api#jsonName": "colorMetadata" } }, - "InputLossAction": { - "target": "com.amazonaws.medialive#InputLossActionForMsSmoothOut", + "GopClosedCadence": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Parameter that control output group behavior on input loss.", - "smithy.api#jsonName": "inputLossAction" + "smithy.api#documentation": "MPEG2: default is open GOP.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "TimestampOffset": { - "target": "com.amazonaws.medialive#__string", + "ScanType": { + "target": "com.amazonaws.medialive#Mpeg2ScanType", "traits": { - "smithy.api#documentation": "Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.", - "smithy.api#jsonName": "timestampOffset" + "smithy.api#documentation": "Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).", + "smithy.api#jsonName": "scanType" } }, - "StreamManifestBehavior": { - "target": "com.amazonaws.medialive#SmoothGroupStreamManifestBehavior", + "FramerateDenominator": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "When set to send, send stream manifest so publishing point doesn't start until all streams start.", - "smithy.api#jsonName": "streamManifestBehavior" + "smithy.api#documentation": "description\": \"The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.", + "smithy.api#jsonName": "framerateDenominator", + "smithy.api#required": {} } }, - "TimestampOffsetMode": { - "target": "com.amazonaws.medialive#SmoothGroupTimestampOffsetMode", + "AdaptiveQuantization": { + "target": "com.amazonaws.medialive#Mpeg2AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Type of timestamp date offset to use.\n- useEventStartDate: Use the date the event was started as the offset\n- useConfiguredOffset: Use an explicitly configured date as the offset", - "smithy.api#jsonName": "timestampOffsetMode" + "smithy.api#documentation": "Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "FragmentLength": { + "DisplayAspectRatio": { + "target": "com.amazonaws.medialive#Mpeg2DisplayRatio", + "traits": { + "smithy.api#documentation": "Sets the pixel aspect ratio for the encode.", + "smithy.api#jsonName": "displayAspectRatio" + } + }, + "FramerateNumerator": { "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.", - "smithy.api#jsonName": "fragmentLength" + "smithy.api#documentation": "The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.", + "smithy.api#jsonName": "framerateNumerator", + "smithy.api#required": {} } }, - "EventIdMode": { - "target": "com.amazonaws.medialive#SmoothGroupEventIdMode", + "AfdSignaling": { + "target": "com.amazonaws.medialive#AfdSignaling", "traits": { - "smithy.api#documentation": "Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.\n\nOptions:\n- \"useConfigured\" - use the value provided in eventId\n- \"useTimestamp\" - generate and send an event ID based on the current timestamp\n- \"noEventId\" - do not send an event ID to the IIS server.", - "smithy.api#jsonName": "eventIdMode" + "smithy.api#documentation": "Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO.\nAUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).\nFIXED: MediaLive will use the value you specify in fixedAFD.", + "smithy.api#jsonName": "afdSignaling" + } + }, + "FixedAfd": { + "target": "com.amazonaws.medialive#FixedAfd", + "traits": { + "smithy.api#documentation": "Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.", + "smithy.api#jsonName": "fixedAfd" + } + }, + "ColorSpace": { + "target": "com.amazonaws.medialive#Mpeg2ColorSpace", + "traits": { + "smithy.api#documentation": "Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \\\"MediaLive Features - Video - color space\\\" in the MediaLive User Guide.\nPASSTHROUGH: Keep the color space of the input content - do not convert it.\nAUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.", + "smithy.api#jsonName": "colorSpace" + } + }, + "SubgopLength": { + "target": "com.amazonaws.medialive#Mpeg2SubGopLength", + "traits": { + "smithy.api#documentation": "Relates to the GOP structure. If you do not know what GOP is, use the default.\nFIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames.\nDYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.", + "smithy.api#jsonName": "subgopLength" + } + }, + "GopSizeUnits": { + "target": "com.amazonaws.medialive#Mpeg2GopSizeUnits", + "traits": { + "smithy.api#documentation": "Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.", + "smithy.api#jsonName": "gopSizeUnits" + } + }, + "FilterSettings": { + "target": "com.amazonaws.medialive#Mpeg2FilterSettings", + "traits": { + "smithy.api#documentation": "Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied.\nTEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean.\nWhen the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise.\nWhen the content is reasonably clean, the filter tends to decrease the bitrate.", + "smithy.api#jsonName": "filterSettings" + } + }, + "GopNumBFrames": { + "target": "com.amazonaws.medialive#__integerMin0Max7", + "traits": { + "smithy.api#documentation": "Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.", + "smithy.api#jsonName": "gopNumBFrames" + } + }, + "GopSize": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default.\nIf gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1.\nIf gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.", + "smithy.api#jsonName": "gopSize" + } + } + }, + "traits": { + "smithy.api#documentation": "Mpeg2 Settings" + } + }, + "com.amazonaws.medialive#Mpeg2SubGopLength": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Sub Gop Length", + "smithy.api#enum": [ + { + "value": "DYNAMIC", + "name": "DYNAMIC" + }, + { + "value": "FIXED", + "name": "FIXED" + } + ] + } + }, + "com.amazonaws.medialive#Mpeg2TimecodeInsertionBehavior": { + "type": "string", + "traits": { + "smithy.api#documentation": "Mpeg2 Timecode Insertion Behavior", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "GOP_TIMECODE", + "name": "GOP_TIMECODE" + } + ] + } + }, + "com.amazonaws.medialive#MsSmoothGroupSettings": { + "type": "structure", + "members": { + "EventStopBehavior": { + "target": "com.amazonaws.medialive#SmoothGroupEventStopBehavior", + "traits": { + "smithy.api#documentation": "When set to sendEos, send EOS signal to IIS server when stopping the event", + "smithy.api#jsonName": "eventStopBehavior" + } + }, + "FilecacheDuration": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Size in seconds of file cache for streaming outputs.", + "smithy.api#jsonName": "filecacheDuration" + } + }, + "AcquisitionPointId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.", + "smithy.api#jsonName": "acquisitionPointId" + } + }, + "SegmentationMode": { + "target": "com.amazonaws.medialive#SmoothGroupSegmentationMode", + "traits": { + "smithy.api#documentation": "useInputSegmentation has been deprecated. The configured segment size is always used.", + "smithy.api#jsonName": "segmentationMode" + } + }, + "SendDelayMs": { + "target": "com.amazonaws.medialive#__integerMin0Max10000", + "traits": { + "smithy.api#documentation": "Number of milliseconds to delay the output from the second pipeline.", + "smithy.api#jsonName": "sendDelayMs" + } + }, + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.", + "smithy.api#jsonName": "connectionRetryInterval" + } + }, + "InputLossAction": { + "target": "com.amazonaws.medialive#InputLossActionForMsSmoothOut", + "traits": { + "smithy.api#documentation": "Parameter that control output group behavior on input loss.", + "smithy.api#jsonName": "inputLossAction" + } + }, + "EventId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "MS Smooth event ID to be sent to the IIS server.\n\nShould only be specified if eventIdMode is set to useConfigured.", + "smithy.api#jsonName": "eventId" + } + }, + "AudioOnlyTimecodeControl": { + "target": "com.amazonaws.medialive#SmoothGroupAudioOnlyTimecodeControl", + "traits": { + "smithy.api#documentation": "If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.", + "smithy.api#jsonName": "audioOnlyTimecodeControl" } }, "CertificateMode": { @@ -12401,6 +13453,13 @@ "smithy.api#jsonName": "certificateMode" } }, + "NumRetries": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Number of retry attempts.", + "smithy.api#jsonName": "numRetries" + } + }, "Destination": { "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { @@ -12409,39 +13468,53 @@ "smithy.api#required": {} } }, - "NumRetries": { - "target": "com.amazonaws.medialive#__integerMin0", + "SparseTrackType": { + "target": "com.amazonaws.medialive#SmoothGroupSparseTrackType", "traits": { - "smithy.api#documentation": "Number of retry attempts.", - "smithy.api#jsonName": "numRetries" + "smithy.api#documentation": "Identifies the type of data to place in the sparse track:\n- SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment.\n- SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment.\n- NONE: Don't generate a sparse track for any outputs in this output group.", + "smithy.api#jsonName": "sparseTrackType" } }, - "SparseTrackType": { - "target": "com.amazonaws.medialive#SmoothGroupSparseTrackType", + "EventIdMode": { + "target": "com.amazonaws.medialive#SmoothGroupEventIdMode", + "traits": { + "smithy.api#documentation": "Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.\n\nOptions:\n- \"useConfigured\" - use the value provided in eventId\n- \"useTimestamp\" - generate and send an event ID based on the current timestamp\n- \"noEventId\" - do not send an event ID to the IIS server.", + "smithy.api#jsonName": "eventIdMode" + } + }, + "TimestampOffsetMode": { + "target": "com.amazonaws.medialive#SmoothGroupTimestampOffsetMode", + "traits": { + "smithy.api#documentation": "Type of timestamp date offset to use.\n- useEventStartDate: Use the date the event was started as the offset\n- useConfiguredOffset: Use an explicitly configured date as the offset", + "smithy.api#jsonName": "timestampOffsetMode" + } + }, + "FragmentLength": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Identifies the type of data to place in the sparse track:\n- SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment.\n- SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment.\n- NONE: Don't generate a sparse track for any outputs in this output group.", - "smithy.api#jsonName": "sparseTrackType" + "smithy.api#documentation": "Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.", + "smithy.api#jsonName": "fragmentLength" } }, - "EventStopBehavior": { - "target": "com.amazonaws.medialive#SmoothGroupEventStopBehavior", + "StreamManifestBehavior": { + "target": "com.amazonaws.medialive#SmoothGroupStreamManifestBehavior", "traits": { - "smithy.api#documentation": "When set to sendEos, send EOS signal to IIS server when stopping the event", - "smithy.api#jsonName": "eventStopBehavior" + "smithy.api#documentation": "When set to send, send stream manifest so publishing point doesn't start until all streams start.", + "smithy.api#jsonName": "streamManifestBehavior" } }, - "AudioOnlyTimecodeControl": { - "target": "com.amazonaws.medialive#SmoothGroupAudioOnlyTimecodeControl", + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.", - "smithy.api#jsonName": "audioOnlyTimecodeControl" + "smithy.api#documentation": "Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.", + "smithy.api#jsonName": "restartDelay" } }, - "AcquisitionPointId": { + "TimestampOffset": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.", - "smithy.api#jsonName": "acquisitionPointId" + "smithy.api#documentation": "Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.", + "smithy.api#jsonName": "timestampOffset" } } }, @@ -12468,19 +13541,19 @@ "com.amazonaws.medialive#MsSmoothOutputSettings": { "type": "structure", "members": { - "NameModifier": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type.", - "smithy.api#jsonName": "nameModifier" - } - }, "H265PackagingType": { "target": "com.amazonaws.medialive#MsSmoothH265PackagingType", "traits": { "smithy.api#documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1.", "smithy.api#jsonName": "h265PackagingType" } + }, + "NameModifier": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type.", + "smithy.api#jsonName": "nameModifier" + } } }, "traits": { @@ -12490,6 +13563,20 @@ "com.amazonaws.medialive#Multiplex": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" + } + }, "PipelinesRunningCount": { "target": "com.amazonaws.medialive#__integer", "traits": { @@ -12497,6 +13584,13 @@ "smithy.api#jsonName": "pipelinesRunningCount" } }, + "Arn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" + } + }, "ProgramCount": { "target": "com.amazonaws.medialive#__integer", "traits": { @@ -12504,11 +13598,11 @@ "smithy.api#jsonName": "programCount" } }, - "Name": { + "Id": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" } }, "State": { @@ -12518,13 +13612,6 @@ "smithy.api#jsonName": "state" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" - } - }, "MultiplexSettings": { "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { @@ -12532,11 +13619,11 @@ "smithy.api#jsonName": "multiplexSettings" } }, - "Arn": { - "target": "com.amazonaws.medialive#__string", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "A list of the multiplex output destinations.", + "smithy.api#jsonName": "destinations" } }, "AvailabilityZones": { @@ -12545,20 +13632,6 @@ "smithy.api#documentation": "A list of availability zones for the multiplex.", "smithy.api#jsonName": "availabilityZones" } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", - "traits": { - "smithy.api#documentation": "A list of the multiplex output destinations.", - "smithy.api#jsonName": "destinations" - } } }, "traits": { @@ -12621,18 +13694,18 @@ "com.amazonaws.medialive#MultiplexProgram": { "type": "structure", "members": { - "ProgramName": { - "target": "com.amazonaws.medialive#__string", + "PacketIdentifiersMap": { + "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", "traits": { - "smithy.api#documentation": "The name of the multiplex program.", - "smithy.api#jsonName": "programName" + "smithy.api#documentation": "The packet identifier map for this multiplex program.", + "smithy.api#jsonName": "packetIdentifiersMap" } }, - "ChannelId": { + "ProgramName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The MediaLive channel associated with the program.", - "smithy.api#jsonName": "channelId" + "smithy.api#documentation": "The name of the multiplex program.", + "smithy.api#jsonName": "programName" } }, "MultiplexProgramSettings": { @@ -12642,11 +13715,18 @@ "smithy.api#jsonName": "multiplexProgramSettings" } }, - "PacketIdentifiersMap": { - "target": "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap", + "ChannelId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The packet identifier map for this multiplex program.", - "smithy.api#jsonName": "packetIdentifiersMap" + "smithy.api#documentation": "The MediaLive channel associated with the program.", + "smithy.api#jsonName": "channelId" + } + }, + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail", + "traits": { + "smithy.api#documentation": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.", + "smithy.api#jsonName": "pipelineDetails" } } }, @@ -12679,16 +13759,16 @@ "com.amazonaws.medialive#MultiplexProgramPacketIdentifiersMap": { "type": "structure", "members": { - "EtvPlatformPid": { + "PcrPid": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "etvPlatformPid" + "smithy.api#jsonName": "pcrPid" } }, - "TimedMetadataPid": { + "EtvPlatformPid": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#jsonName": "etvPlatformPid" } }, "DvbSubPids": { @@ -12703,22 +13783,28 @@ "smithy.api#jsonName": "scte27Pids" } }, - "PcrPid": { + "KlvDataPids": { + "target": "com.amazonaws.medialive#__listOf__integer", + "traits": { + "smithy.api#jsonName": "klvDataPids" + } + }, + "VideoPid": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "pcrPid" + "smithy.api#jsonName": "videoPid" } }, - "EtvSignalPid": { + "DvbTeletextPid": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "etvSignalPid" + "smithy.api#jsonName": "dvbTeletextPid" } }, - "AudioPids": { - "target": "com.amazonaws.medialive#__listOf__integer", + "PmtPid": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "audioPids" + "smithy.api#jsonName": "pmtPid" } }, "Scte35Pid": { @@ -12727,39 +13813,55 @@ "smithy.api#jsonName": "scte35Pid" } }, - "PrivateMetadataPid": { + "EtvSignalPid": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "privateMetadataPid" + "smithy.api#jsonName": "etvSignalPid" } }, - "PmtPid": { + "PrivateMetadataPid": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "pmtPid" + "smithy.api#jsonName": "privateMetadataPid" } }, - "DvbTeletextPid": { - "target": "com.amazonaws.medialive#__integer", + "AudioPids": { + "target": "com.amazonaws.medialive#__listOf__integer", "traits": { - "smithy.api#jsonName": "dvbTeletextPid" + "smithy.api#jsonName": "audioPids" } }, - "VideoPid": { + "TimedMetadataPid": { "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "videoPid" + "smithy.api#jsonName": "timedMetadataPid" + } + } + }, + "traits": { + "smithy.api#documentation": "Packet identifiers map for a given Multiplex program." + } + }, + "com.amazonaws.medialive#MultiplexProgramPipelineDetail": { + "type": "structure", + "members": { + "PipelineId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Identifies a specific pipeline in the multiplex.", + "smithy.api#jsonName": "pipelineId" } }, - "KlvDataPids": { - "target": "com.amazonaws.medialive#__listOf__integer", + "ActiveChannelPipeline": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "klvDataPids" + "smithy.api#documentation": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.", + "smithy.api#jsonName": "activeChannelPipeline" } } }, "traits": { - "smithy.api#documentation": "Packet identifiers map for a given Multiplex program." + "smithy.api#documentation": "The current source for one of the pipelines in the multiplex." } }, "com.amazonaws.medialive#MultiplexProgramServiceDescriptor": { @@ -12789,11 +13891,11 @@ "com.amazonaws.medialive#MultiplexProgramSettings": { "type": "structure", "members": { - "PreferredChannelPipeline": { - "target": "com.amazonaws.medialive#PreferredChannelPipeline", + "VideoSettings": { + "target": "com.amazonaws.medialive#MultiplexVideoSettings", "traits": { - "smithy.api#documentation": "Indicates which pipeline is preferred by the multiplex for program ingest.", - "smithy.api#jsonName": "preferredChannelPipeline" + "smithy.api#documentation": "Program video settings configuration.", + "smithy.api#jsonName": "videoSettings" } }, "ServiceDescriptor": { @@ -12803,11 +13905,11 @@ "smithy.api#jsonName": "serviceDescriptor" } }, - "VideoSettings": { - "target": "com.amazonaws.medialive#MultiplexVideoSettings", + "PreferredChannelPipeline": { + "target": "com.amazonaws.medialive#PreferredChannelPipeline", "traits": { - "smithy.api#documentation": "Program video settings configuration.", - "smithy.api#jsonName": "videoSettings" + "smithy.api#documentation": "Indicates which pipeline is preferred by the multiplex for program ingest.", + "smithy.api#jsonName": "preferredChannelPipeline" } }, "ProgramNumber": { @@ -12848,13 +13950,6 @@ "com.amazonaws.medialive#MultiplexSettings": { "type": "structure", "members": { - "TransportStreamReservedBitrate": { - "target": "com.amazonaws.medialive#__integerMin0Max100000000", - "traits": { - "smithy.api#documentation": "Transport stream reserved bit rate.", - "smithy.api#jsonName": "transportStreamReservedBitrate" - } - }, "TransportStreamId": { "target": "com.amazonaws.medialive#__integerMin0Max65535", "traits": { @@ -12863,6 +13958,13 @@ "smithy.api#required": {} } }, + "TransportStreamReservedBitrate": { + "target": "com.amazonaws.medialive#__integerMin0Max100000000", + "traits": { + "smithy.api#documentation": "Transport stream reserved bit rate.", + "smithy.api#jsonName": "transportStreamReservedBitrate" + } + }, "TransportStreamBitrate": { "target": "com.amazonaws.medialive#__integerMin1000000Max100000000", "traits": { @@ -12872,7 +13974,7 @@ } }, "MaximumVideoBufferDelayMilliseconds": { - "target": "com.amazonaws.medialive#__integerMin1000Max3000", + "target": "com.amazonaws.medialive#__integerMin800Max3000", "traits": { "smithy.api#documentation": "Maximum video buffer delay in milliseconds.", "smithy.api#jsonName": "maximumVideoBufferDelayMilliseconds" @@ -12945,6 +14047,13 @@ "com.amazonaws.medialive#MultiplexStatmuxVideoSettings": { "type": "structure", "members": { + "Priority": { + "target": "com.amazonaws.medialive#__integerMinNegative5Max5", + "traits": { + "smithy.api#documentation": "The purpose of the priority is to use a combination of the\\nmultiplex rate control algorithm and the QVBR capability of the\\nencoder to prioritize the video quality of some channels in a\\nmultiplex over others. Channels that have a higher priority will\\nget higher video quality at the expense of the video quality of\\nother channels in the multiplex with lower priority.", + "smithy.api#jsonName": "priority" + } + }, "MaximumBitrate": { "target": "com.amazonaws.medialive#__integerMin100000Max100000000", "traits": { @@ -12958,20 +14067,48 @@ "smithy.api#documentation": "Minimum statmux bitrate.", "smithy.api#jsonName": "minimumBitrate" } - } - }, - "traits": { - "smithy.api#documentation": "Statmux rate control settings" - } - }, - "com.amazonaws.medialive#MultiplexSummary": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.medialive#MultiplexState", + } + }, + "traits": { + "smithy.api#documentation": "Statmux rate control settings" + } + }, + "com.amazonaws.medialive#MultiplexSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" + } + }, + "State": { + "target": "com.amazonaws.medialive#MultiplexState", + "traits": { + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" + } + }, + "Tags": { + "target": "com.amazonaws.medialive#Tags", + "traits": { + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" + } + }, + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, "ProgramCount": { @@ -12995,40 +14132,12 @@ "smithy.api#jsonName": "multiplexSettings" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" - } - }, - "Id": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" - } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } - }, "AvailabilityZones": { "target": "com.amazonaws.medialive#__listOf__string", "traits": { "smithy.api#documentation": "A list of availability zones for the multiplex.", "smithy.api#jsonName": "availabilityZones" } - }, - "Name": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" - } } }, "traits": { @@ -13152,25 +14261,18 @@ "com.amazonaws.medialive#Offering": { "type": "structure", "members": { - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" - } - }, - "Region": { - "target": "com.amazonaws.medialive#__string", + "Duration": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, - "Arn": { - "target": "com.amazonaws.medialive#__string", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" } }, "DurationUnits": { @@ -13180,18 +14282,11 @@ "smithy.api#jsonName": "durationUnits" } }, - "CurrencyCode": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", - "smithy.api#jsonName": "currencyCode" - } - }, - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" } }, "OfferingType": { @@ -13201,11 +14296,18 @@ "smithy.api#jsonName": "offeringType" } }, - "OfferingDescription": { + "Region": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" + "smithy.api#documentation": "AWS region, e.g. 'us-west-2'", + "smithy.api#jsonName": "region" + } + }, + "OfferingId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, "UsagePrice": { @@ -13215,18 +14317,25 @@ "smithy.api#jsonName": "usagePrice" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" + "smithy.api#documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'", + "smithy.api#jsonName": "arn" } }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", + "CurrencyCode": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'", + "smithy.api#jsonName": "currencyCode" + } + }, + "OfferingDescription": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } } }, @@ -13261,20 +14370,6 @@ "com.amazonaws.medialive#Output": { "type": "structure", "members": { - "AudioDescriptionNames": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "The names of the AudioDescriptions used as audio sources for this output.", - "smithy.api#jsonName": "audioDescriptionNames" - } - }, - "CaptionDescriptionNames": { - "target": "com.amazonaws.medialive#__listOf__string", - "traits": { - "smithy.api#documentation": "The names of the CaptionDescriptions used as caption sources for this output.", - "smithy.api#jsonName": "captionDescriptionNames" - } - }, "OutputName": { "target": "com.amazonaws.medialive#__stringMin1Max255", "traits": { @@ -13289,6 +14384,20 @@ "smithy.api#jsonName": "videoDescriptionName" } }, + "CaptionDescriptionNames": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The names of the CaptionDescriptions used as caption sources for this output.", + "smithy.api#jsonName": "captionDescriptionNames" + } + }, + "AudioDescriptionNames": { + "target": "com.amazonaws.medialive#__listOf__string", + "traits": { + "smithy.api#documentation": "The names of the AudioDescriptions used as audio sources for this output.", + "smithy.api#jsonName": "audioDescriptionNames" + } + }, "OutputSettings": { "target": "com.amazonaws.medialive#OutputSettings", "traits": { @@ -13312,13 +14421,6 @@ "smithy.api#jsonName": "id" } }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexProgramChannelDestinationSettings", - "traits": { - "smithy.api#documentation": "Destination settings for a Multiplex output; one destination for both encoders.", - "smithy.api#jsonName": "multiplexSettings" - } - }, "MediaPackageSettings": { "target": "com.amazonaws.medialive#__listOfMediaPackageOutputDestinationSettings", "traits": { @@ -13332,6 +14434,13 @@ "smithy.api#documentation": "Destination settings for a standard output; one destination for each redundant encoder.", "smithy.api#jsonName": "settings" } + }, + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexProgramChannelDestinationSettings", + "traits": { + "smithy.api#documentation": "Destination settings for a Multiplex output; one destination for both encoders.", + "smithy.api#jsonName": "multiplexSettings" + } } }, "traits": { @@ -13348,18 +14457,18 @@ "smithy.api#jsonName": "url" } }, - "StreamName": { + "PasswordParam": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Stream name for RTMP destinations (URLs of type rtmp://)", - "smithy.api#jsonName": "streamName" + "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", + "smithy.api#jsonName": "passwordParam" } }, - "PasswordParam": { + "StreamName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "key used to extract the password from EC2 Parameter store", - "smithy.api#jsonName": "passwordParam" + "smithy.api#documentation": "Stream name for RTMP destinations (URLs of type rtmp://)", + "smithy.api#jsonName": "streamName" } }, "Username": { @@ -13407,16 +14516,16 @@ "com.amazonaws.medialive#OutputGroupSettings": { "type": "structure", "members": { - "RtmpGroupSettings": { - "target": "com.amazonaws.medialive#RtmpGroupSettings", + "UdpGroupSettings": { + "target": "com.amazonaws.medialive#UdpGroupSettings", "traits": { - "smithy.api#jsonName": "rtmpGroupSettings" + "smithy.api#jsonName": "udpGroupSettings" } }, - "FrameCaptureGroupSettings": { - "target": "com.amazonaws.medialive#FrameCaptureGroupSettings", + "MediaPackageGroupSettings": { + "target": "com.amazonaws.medialive#MediaPackageGroupSettings", "traits": { - "smithy.api#jsonName": "frameCaptureGroupSettings" + "smithy.api#jsonName": "mediaPackageGroupSettings" } }, "MultiplexGroupSettings": { @@ -13425,10 +14534,10 @@ "smithy.api#jsonName": "multiplexGroupSettings" } }, - "ArchiveGroupSettings": { - "target": "com.amazonaws.medialive#ArchiveGroupSettings", + "FrameCaptureGroupSettings": { + "target": "com.amazonaws.medialive#FrameCaptureGroupSettings", "traits": { - "smithy.api#jsonName": "archiveGroupSettings" + "smithy.api#jsonName": "frameCaptureGroupSettings" } }, "HlsGroupSettings": { @@ -13437,22 +14546,22 @@ "smithy.api#jsonName": "hlsGroupSettings" } }, - "MsSmoothGroupSettings": { - "target": "com.amazonaws.medialive#MsSmoothGroupSettings", + "ArchiveGroupSettings": { + "target": "com.amazonaws.medialive#ArchiveGroupSettings", "traits": { - "smithy.api#jsonName": "msSmoothGroupSettings" + "smithy.api#jsonName": "archiveGroupSettings" } }, - "MediaPackageGroupSettings": { - "target": "com.amazonaws.medialive#MediaPackageGroupSettings", + "MsSmoothGroupSettings": { + "target": "com.amazonaws.medialive#MsSmoothGroupSettings", "traits": { - "smithy.api#jsonName": "mediaPackageGroupSettings" + "smithy.api#jsonName": "msSmoothGroupSettings" } }, - "UdpGroupSettings": { - "target": "com.amazonaws.medialive#UdpGroupSettings", + "RtmpGroupSettings": { + "target": "com.amazonaws.medialive#RtmpGroupSettings", "traits": { - "smithy.api#jsonName": "udpGroupSettings" + "smithy.api#jsonName": "rtmpGroupSettings" } } }, @@ -13477,16 +14586,16 @@ "com.amazonaws.medialive#OutputSettings": { "type": "structure", "members": { - "MediaPackageOutputSettings": { - "target": "com.amazonaws.medialive#MediaPackageOutputSettings", + "ArchiveOutputSettings": { + "target": "com.amazonaws.medialive#ArchiveOutputSettings", "traits": { - "smithy.api#jsonName": "mediaPackageOutputSettings" + "smithy.api#jsonName": "archiveOutputSettings" } }, - "MultiplexOutputSettings": { - "target": "com.amazonaws.medialive#MultiplexOutputSettings", + "RtmpOutputSettings": { + "target": "com.amazonaws.medialive#RtmpOutputSettings", "traits": { - "smithy.api#jsonName": "multiplexOutputSettings" + "smithy.api#jsonName": "rtmpOutputSettings" } }, "MsSmoothOutputSettings": { @@ -13495,10 +14604,10 @@ "smithy.api#jsonName": "msSmoothOutputSettings" } }, - "ArchiveOutputSettings": { - "target": "com.amazonaws.medialive#ArchiveOutputSettings", + "MediaPackageOutputSettings": { + "target": "com.amazonaws.medialive#MediaPackageOutputSettings", "traits": { - "smithy.api#jsonName": "archiveOutputSettings" + "smithy.api#jsonName": "mediaPackageOutputSettings" } }, "FrameCaptureOutputSettings": { @@ -13507,22 +14616,22 @@ "smithy.api#jsonName": "frameCaptureOutputSettings" } }, - "HlsOutputSettings": { - "target": "com.amazonaws.medialive#HlsOutputSettings", + "UdpOutputSettings": { + "target": "com.amazonaws.medialive#UdpOutputSettings", "traits": { - "smithy.api#jsonName": "hlsOutputSettings" + "smithy.api#jsonName": "udpOutputSettings" } }, - "RtmpOutputSettings": { - "target": "com.amazonaws.medialive#RtmpOutputSettings", + "MultiplexOutputSettings": { + "target": "com.amazonaws.medialive#MultiplexOutputSettings", "traits": { - "smithy.api#jsonName": "rtmpOutputSettings" + "smithy.api#jsonName": "multiplexOutputSettings" } }, - "UdpOutputSettings": { - "target": "com.amazonaws.medialive#UdpOutputSettings", + "HlsOutputSettings": { + "target": "com.amazonaws.medialive#HlsOutputSettings", "traits": { - "smithy.api#jsonName": "udpOutputSettings" + "smithy.api#jsonName": "hlsOutputSettings" } } }, @@ -13554,18 +14663,18 @@ "com.amazonaws.medialive#PipelineDetail": { "type": "structure", "members": { - "ActiveInputAttachmentName": { + "ActiveInputSwitchActionName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the active input attachment currently being ingested by this pipeline.", - "smithy.api#jsonName": "activeInputAttachmentName" + "smithy.api#documentation": "The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.", + "smithy.api#jsonName": "activeInputSwitchActionName" } }, - "ActiveInputSwitchActionName": { + "ActiveInputAttachmentName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.", - "smithy.api#jsonName": "activeInputSwitchActionName" + "smithy.api#documentation": "The name of the active input attachment currently being ingested by this pipeline.", + "smithy.api#jsonName": "activeInputAttachmentName" } }, "PipelineId": { @@ -13678,11 +14787,11 @@ "com.amazonaws.medialive#PurchaseOfferingRequest": { "type": "structure", "members": { - "OfferingId": { - "target": "com.amazonaws.medialive#__string", + "Count": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "Offering to purchase, e.g. '87654321'", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "Number of resources", + "smithy.api#jsonName": "count", "smithy.api#required": {} } }, @@ -13693,18 +14802,19 @@ "smithy.api#jsonName": "tags" } }, - "Name": { + "OfferingId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Name for the new reservation", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Offering to purchase, e.g. '87654321'", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Start": { + "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.", - "smithy.api#jsonName": "start" + "smithy.api#documentation": "Name for the new reservation", + "smithy.api#jsonName": "name" } }, "RequestId": { @@ -13715,12 +14825,11 @@ "smithy.api#jsonName": "requestId" } }, - "Count": { - "target": "com.amazonaws.medialive#__integerMin1", + "Start": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Number of resources", - "smithy.api#jsonName": "count", - "smithy.api#required": {} + "smithy.api#documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.", + "smithy.api#jsonName": "start" } } }, @@ -13742,6 +14851,13 @@ "smithy.api#documentation": "Placeholder documentation for PurchaseOfferingResponse" } }, + "com.amazonaws.medialive#RawSettings": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Raw Settings" + } + }, "com.amazonaws.medialive#Rec601Settings": { "type": "structure", "members": {}, @@ -13756,9 +14872,85 @@ "smithy.api#documentation": "Rec709 Settings" } }, + "com.amazonaws.medialive#RejectInputDeviceTransfer": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#RejectInputDeviceTransferRequest" + }, + "output": { + "target": "com.amazonaws.medialive#RejectInputDeviceTransferResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Reject the transfer of the specified input device to your AWS account.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/reject", + "code": 200 + } + } + }, + "com.amazonaws.medialive#RejectInputDeviceTransferRequest": { + "type": "structure", + "members": { + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device to reject. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for RejectInputDeviceTransferRequest" + } + }, + "com.amazonaws.medialive#RejectInputDeviceTransferResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Placeholder documentation for RejectInputDeviceTransferResponse" + } + }, "com.amazonaws.medialive#RemixSettings": { "type": "structure", "members": { + "ChannelsIn": { + "target": "com.amazonaws.medialive#__integerMin1Max16", + "traits": { + "smithy.api#documentation": "Number of input channels to be used.", + "smithy.api#jsonName": "channelsIn" + } + }, "ChannelsOut": { "target": "com.amazonaws.medialive#__integerMin1Max8", "traits": { @@ -13773,13 +14965,6 @@ "smithy.api#jsonName": "channelMappings", "smithy.api#required": {} } - }, - "ChannelsIn": { - "target": "com.amazonaws.medialive#__integerMin1Max16", - "traits": { - "smithy.api#documentation": "Number of input channels to be used.", - "smithy.api#jsonName": "channelsIn" - } } }, "traits": { @@ -13789,20 +14974,6 @@ "com.amazonaws.medialive#Reservation": { "type": "structure", "members": { - "FixedPrice": { - "target": "com.amazonaws.medialive#__double", - "traits": { - "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", - "smithy.api#jsonName": "fixedPrice" - } - }, - "OfferingType": { - "target": "com.amazonaws.medialive#OfferingType", - "traits": { - "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", - "smithy.api#jsonName": "offeringType" - } - }, "State": { "target": "com.amazonaws.medialive#ReservationState", "traits": { @@ -13817,6 +14988,20 @@ "smithy.api#jsonName": "durationUnits" } }, + "Count": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "Number of reserved resources", + "smithy.api#jsonName": "count" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "User specified reservation name", + "smithy.api#jsonName": "name" + } + }, "CurrencyCode": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -13831,32 +15016,46 @@ "smithy.api#jsonName": "region" } }, - "OfferingId": { + "OfferingType": { + "target": "com.amazonaws.medialive#OfferingType", + "traits": { + "smithy.api#documentation": "Offering type, e.g. 'NO_UPFRONT'", + "smithy.api#jsonName": "offeringType" + } + }, + "FixedPrice": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering", + "smithy.api#jsonName": "fixedPrice" + } + }, + "ReservationId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", - "smithy.api#jsonName": "offeringId" + "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", + "smithy.api#jsonName": "reservationId" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "Duration": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "A collection of key-value pairs", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Lease duration, e.g. '12'", + "smithy.api#jsonName": "duration" } }, - "UsagePrice": { - "target": "com.amazonaws.medialive#__double", + "ResourceSpecification": { + "target": "com.amazonaws.medialive#ReservationResourceSpecification", "traits": { - "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", - "smithy.api#jsonName": "usagePrice" + "smithy.api#documentation": "Resource configuration details", + "smithy.api#jsonName": "resourceSpecification" } }, - "Arn": { + "OfferingDescription": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", + "smithy.api#jsonName": "offeringDescription" } }, "Start": { @@ -13873,46 +15072,32 @@ "smithy.api#jsonName": "end" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integer", - "traits": { - "smithy.api#documentation": "Lease duration, e.g. '12'", - "smithy.api#jsonName": "duration" - } - }, - "ReservationId": { - "target": "com.amazonaws.medialive#__string", + "UsagePrice": { + "target": "com.amazonaws.medialive#__double", "traits": { - "smithy.api#documentation": "Unique reservation ID, e.g. '1234567'", - "smithy.api#jsonName": "reservationId" + "smithy.api#documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'", + "smithy.api#jsonName": "usagePrice" } }, - "OfferingDescription": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'", - "smithy.api#jsonName": "offeringDescription" + "smithy.api#documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'", + "smithy.api#jsonName": "arn" } }, - "Name": { + "OfferingId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "User specified reservation name", - "smithy.api#jsonName": "name" - } - }, - "ResourceSpecification": { - "target": "com.amazonaws.medialive#ReservationResourceSpecification", - "traits": { - "smithy.api#documentation": "Resource configuration details", - "smithy.api#jsonName": "resourceSpecification" + "smithy.api#documentation": "Unique offering ID, e.g. '87654321'", + "smithy.api#jsonName": "offeringId" } }, - "Count": { - "target": "com.amazonaws.medialive#__integer", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "Number of reserved resources", - "smithy.api#jsonName": "count" + "smithy.api#documentation": "A collection of key-value pairs", + "smithy.api#jsonName": "tags" } } }, @@ -13940,6 +15125,10 @@ { "value": "AUDIO", "name": "AUDIO" + }, + { + "value": "LINK", + "name": "LINK" } ] } @@ -14007,25 +15196,18 @@ "com.amazonaws.medialive#ReservationResourceSpecification": { "type": "structure", "members": { - "MaximumFramerate": { - "target": "com.amazonaws.medialive#ReservationMaximumFramerate", - "traits": { - "smithy.api#documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)", - "smithy.api#jsonName": "maximumFramerate" - } - }, - "Resolution": { - "target": "com.amazonaws.medialive#ReservationResolution", + "ResourceType": { + "target": "com.amazonaws.medialive#ReservationResourceType", "traits": { - "smithy.api#documentation": "Resolution, e.g. 'HD'", - "smithy.api#jsonName": "resolution" + "smithy.api#documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", + "smithy.api#jsonName": "resourceType" } }, - "Codec": { - "target": "com.amazonaws.medialive#ReservationCodec", + "MaximumBitrate": { + "target": "com.amazonaws.medialive#ReservationMaximumBitrate", "traits": { - "smithy.api#documentation": "Codec, e.g. 'AVC'", - "smithy.api#jsonName": "codec" + "smithy.api#documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'", + "smithy.api#jsonName": "maximumBitrate" } }, "SpecialFeature": { @@ -14035,11 +15217,18 @@ "smithy.api#jsonName": "specialFeature" } }, - "MaximumBitrate": { - "target": "com.amazonaws.medialive#ReservationMaximumBitrate", + "Codec": { + "target": "com.amazonaws.medialive#ReservationCodec", + "traits": { + "smithy.api#documentation": "Codec, e.g. 'AVC'", + "smithy.api#jsonName": "codec" + } + }, + "VideoQuality": { + "target": "com.amazonaws.medialive#ReservationVideoQuality", "traits": { - "smithy.api#documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'", - "smithy.api#jsonName": "maximumBitrate" + "smithy.api#documentation": "Video quality, e.g. 'STANDARD' (Outputs only)", + "smithy.api#jsonName": "videoQuality" } }, "ChannelClass": { @@ -14049,18 +15238,18 @@ "smithy.api#jsonName": "channelClass" } }, - "ResourceType": { - "target": "com.amazonaws.medialive#ReservationResourceType", + "Resolution": { + "target": "com.amazonaws.medialive#ReservationResolution", "traits": { - "smithy.api#documentation": "Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'", - "smithy.api#jsonName": "resourceType" + "smithy.api#documentation": "Resolution, e.g. 'HD'", + "smithy.api#jsonName": "resolution" } }, - "VideoQuality": { - "target": "com.amazonaws.medialive#ReservationVideoQuality", + "MaximumFramerate": { + "target": "com.amazonaws.medialive#ReservationMaximumFramerate", "traits": { - "smithy.api#documentation": "Video quality, e.g. 'STANDARD' (Outputs only)", - "smithy.api#jsonName": "videoQuality" + "smithy.api#documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)", + "smithy.api#jsonName": "maximumFramerate" } } }, @@ -14198,13 +15387,6 @@ "com.amazonaws.medialive#RtmpGroupSettings": { "type": "structure", "members": { - "CacheFullBehavior": { - "target": "com.amazonaws.medialive#RtmpCacheFullBehavior", - "traits": { - "smithy.api#documentation": "Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.", - "smithy.api#jsonName": "cacheFullBehavior" - } - }, "CaptionData": { "target": "com.amazonaws.medialive#RtmpCaptionData", "traits": { @@ -14212,13 +15394,6 @@ "smithy.api#jsonName": "captionData" } }, - "RestartDelay": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", - "smithy.api#jsonName": "restartDelay" - } - }, "CacheLength": { "target": "com.amazonaws.medialive#__integerMin30", "traits": { @@ -14233,6 +15408,20 @@ "smithy.api#jsonName": "inputLossAction" } }, + "RestartDelay": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", + "smithy.api#jsonName": "restartDelay" + } + }, + "CacheFullBehavior": { + "target": "com.amazonaws.medialive#RtmpCacheFullBehavior", + "traits": { + "smithy.api#documentation": "Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.", + "smithy.api#jsonName": "cacheFullBehavior" + } + }, "AuthenticationScheme": { "target": "com.amazonaws.medialive#AuthenticationScheme", "traits": { @@ -14278,13 +15467,6 @@ "smithy.api#jsonName": "certificateMode" } }, - "ConnectionRetryInterval": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#documentation": "Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.", - "smithy.api#jsonName": "connectionRetryInterval" - } - }, "Destination": { "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { @@ -14292,6 +15474,13 @@ "smithy.api#jsonName": "destination", "smithy.api#required": {} } + }, + "ConnectionRetryInterval": { + "target": "com.amazonaws.medialive#__integerMin1", + "traits": { + "smithy.api#documentation": "Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.", + "smithy.api#jsonName": "connectionRetryInterval" + } } }, "traits": { @@ -14301,14 +15490,6 @@ "com.amazonaws.medialive#ScheduleAction": { "type": "structure", "members": { - "ScheduleActionStartSettings": { - "target": "com.amazonaws.medialive#ScheduleActionStartSettings", - "traits": { - "smithy.api#documentation": "The time for the action to start in the channel.", - "smithy.api#jsonName": "scheduleActionStartSettings", - "smithy.api#required": {} - } - }, "ScheduleActionSettings": { "target": "com.amazonaws.medialive#ScheduleActionSettings", "traits": { @@ -14324,6 +15505,14 @@ "smithy.api#jsonName": "actionName", "smithy.api#required": {} } + }, + "ScheduleActionStartSettings": { + "target": "com.amazonaws.medialive#ScheduleActionStartSettings", + "traits": { + "smithy.api#documentation": "The time for the action to start in the channel.", + "smithy.api#jsonName": "scheduleActionStartSettings", + "smithy.api#required": {} + } } }, "traits": { @@ -14333,11 +15522,11 @@ "com.amazonaws.medialive#ScheduleActionSettings": { "type": "structure", "members": { - "PauseStateSettings": { - "target": "com.amazonaws.medialive#PauseStateScheduleActionSettings", + "InputSwitchSettings": { + "target": "com.amazonaws.medialive#InputSwitchScheduleActionSettings", "traits": { - "smithy.api#documentation": "Action to pause or unpause one or both channel pipelines", - "smithy.api#jsonName": "pauseStateSettings" + "smithy.api#documentation": "Action to switch the input", + "smithy.api#jsonName": "inputSwitchSettings" } }, "Scte35SpliceInsertSettings": { @@ -14347,11 +15536,18 @@ "smithy.api#jsonName": "scte35SpliceInsertSettings" } }, - "InputSwitchSettings": { - "target": "com.amazonaws.medialive#InputSwitchScheduleActionSettings", + "StaticImageActivateSettings": { + "target": "com.amazonaws.medialive#StaticImageActivateScheduleActionSettings", "traits": { - "smithy.api#documentation": "Action to switch the input", - "smithy.api#jsonName": "inputSwitchSettings" + "smithy.api#documentation": "Action to activate a static image overlay", + "smithy.api#jsonName": "staticImageActivateSettings" + } + }, + "HlsId3SegmentTaggingSettings": { + "target": "com.amazonaws.medialive#HlsId3SegmentTaggingScheduleActionSettings", + "traits": { + "smithy.api#documentation": "Action to insert HLS ID3 segment tagging", + "smithy.api#jsonName": "hlsId3SegmentTaggingSettings" } }, "StaticImageDeactivateSettings": { @@ -14361,6 +15557,13 @@ "smithy.api#jsonName": "staticImageDeactivateSettings" } }, + "InputPrepareSettings": { + "target": "com.amazonaws.medialive#InputPrepareScheduleActionSettings", + "traits": { + "smithy.api#documentation": "Action to prepare an input for a future immediate input switch", + "smithy.api#jsonName": "inputPrepareSettings" + } + }, "Scte35TimeSignalSettings": { "target": "com.amazonaws.medialive#Scte35TimeSignalScheduleActionSettings", "traits": { @@ -14368,20 +15571,6 @@ "smithy.api#jsonName": "scte35TimeSignalSettings" } }, - "HlsTimedMetadataSettings": { - "target": "com.amazonaws.medialive#HlsTimedMetadataScheduleActionSettings", - "traits": { - "smithy.api#documentation": "Action to insert HLS metadata", - "smithy.api#jsonName": "hlsTimedMetadataSettings" - } - }, - "HlsId3SegmentTaggingSettings": { - "target": "com.amazonaws.medialive#HlsId3SegmentTaggingScheduleActionSettings", - "traits": { - "smithy.api#documentation": "Action to insert HLS ID3 segment tagging", - "smithy.api#jsonName": "hlsId3SegmentTaggingSettings" - } - }, "Scte35ReturnToNetworkSettings": { "target": "com.amazonaws.medialive#Scte35ReturnToNetworkScheduleActionSettings", "traits": { @@ -14389,18 +15578,18 @@ "smithy.api#jsonName": "scte35ReturnToNetworkSettings" } }, - "StaticImageActivateSettings": { - "target": "com.amazonaws.medialive#StaticImageActivateScheduleActionSettings", + "PauseStateSettings": { + "target": "com.amazonaws.medialive#PauseStateScheduleActionSettings", "traits": { - "smithy.api#documentation": "Action to activate a static image overlay", - "smithy.api#jsonName": "staticImageActivateSettings" + "smithy.api#documentation": "Action to pause or unpause one or both channel pipelines", + "smithy.api#jsonName": "pauseStateSettings" } }, - "InputPrepareSettings": { - "target": "com.amazonaws.medialive#InputPrepareScheduleActionSettings", + "HlsTimedMetadataSettings": { + "target": "com.amazonaws.medialive#HlsTimedMetadataScheduleActionSettings", "traits": { - "smithy.api#documentation": "Action to prepare an input for a future immediate input switch", - "smithy.api#jsonName": "inputPrepareSettings" + "smithy.api#documentation": "Action to insert HLS metadata", + "smithy.api#jsonName": "hlsTimedMetadataSettings" } } }, @@ -14411,6 +15600,13 @@ "com.amazonaws.medialive#ScheduleActionStartSettings": { "type": "structure", "members": { + "FixedModeScheduleActionStartSettings": { + "target": "com.amazonaws.medialive#FixedModeScheduleActionStartSettings", + "traits": { + "smithy.api#documentation": "Option for specifying the start time for an action.", + "smithy.api#jsonName": "fixedModeScheduleActionStartSettings" + } + }, "ImmediateModeScheduleActionStartSettings": { "target": "com.amazonaws.medialive#ImmediateModeScheduleActionStartSettings", "traits": { @@ -14424,13 +15620,6 @@ "smithy.api#documentation": "Option for specifying an action as relative to another action.", "smithy.api#jsonName": "followModeScheduleActionStartSettings" } - }, - "FixedModeScheduleActionStartSettings": { - "target": "com.amazonaws.medialive#FixedModeScheduleActionStartSettings", - "traits": { - "smithy.api#documentation": "Option for specifying the start time for an action.", - "smithy.api#jsonName": "fixedModeScheduleActionStartSettings" - } } }, "traits": { @@ -14555,6 +15744,14 @@ "com.amazonaws.medialive#Scte35DeliveryRestrictions": { "type": "structure", "members": { + "ArchiveAllowedFlag": { + "target": "com.amazonaws.medialive#Scte35ArchiveAllowedFlag", + "traits": { + "smithy.api#documentation": "Corresponds to SCTE-35 archive_allowed_flag.", + "smithy.api#jsonName": "archiveAllowedFlag", + "smithy.api#required": {} + } + }, "NoRegionalBlackoutFlag": { "target": "com.amazonaws.medialive#Scte35NoRegionalBlackoutFlag", "traits": { @@ -14571,14 +15768,6 @@ "smithy.api#required": {} } }, - "ArchiveAllowedFlag": { - "target": "com.amazonaws.medialive#Scte35ArchiveAllowedFlag", - "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 archive_allowed_flag.", - "smithy.api#jsonName": "archiveAllowedFlag", - "smithy.api#required": {} - } - }, "DeviceRestrictions": { "target": "com.amazonaws.medialive#Scte35DeviceRestrictions", "traits": { @@ -14699,11 +15888,11 @@ "com.amazonaws.medialive#Scte35SegmentationDescriptor": { "type": "structure", "members": { - "SegmentNum": { + "SegmentationUpidType": { "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.", - "smithy.api#jsonName": "segmentNum" + "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, \"0x0C\" hex from the specification is \"12\" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, \"0x0C\" ) or in decimal (for example, \"12\").", + "smithy.api#jsonName": "segmentationUpidType" } }, "DeliveryRestrictions": { @@ -14713,6 +15902,21 @@ "smithy.api#jsonName": "deliveryRestrictions" } }, + "SegmentationCancelIndicator": { + "target": "com.amazonaws.medialive#Scte35SegmentationCancelIndicator", + "traits": { + "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator.", + "smithy.api#jsonName": "segmentationCancelIndicator", + "smithy.api#required": {} + } + }, + "SubSegmentNum": { + "target": "com.amazonaws.medialive#__integerMin0Max255", + "traits": { + "smithy.api#documentation": "Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.", + "smithy.api#jsonName": "subSegmentNum" + } + }, "SegmentationTypeId": { "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { @@ -14727,11 +15931,11 @@ "smithy.api#jsonName": "subSegmentsExpected" } }, - "SegmentationUpidType": { - "target": "com.amazonaws.medialive#__integerMin0Max255", + "SegmentationDuration": { + "target": "com.amazonaws.medialive#__longMin0Max1099511627775", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, \"0x0C\" hex from the specification is \"12\" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, \"0x0C\" ) or in decimal (for example, \"12\").", - "smithy.api#jsonName": "segmentationUpidType" + "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.", + "smithy.api#jsonName": "segmentationDuration" } }, "SegmentsExpected": { @@ -14741,18 +15945,11 @@ "smithy.api#jsonName": "segmentsExpected" } }, - "SubSegmentNum": { - "target": "com.amazonaws.medialive#__integerMin0Max255", - "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.", - "smithy.api#jsonName": "subSegmentNum" - } - }, - "SegmentationCancelIndicator": { - "target": "com.amazonaws.medialive#Scte35SegmentationCancelIndicator", + "SegmentationEventId": { + "target": "com.amazonaws.medialive#__longMin0Max4294967295", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator.", - "smithy.api#jsonName": "segmentationCancelIndicator", + "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_id.", + "smithy.api#jsonName": "segmentationEventId", "smithy.api#required": {} } }, @@ -14763,19 +15960,11 @@ "smithy.api#jsonName": "segmentationUpid" } }, - "SegmentationEventId": { - "target": "com.amazonaws.medialive#__longMin0Max4294967295", - "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_event_id.", - "smithy.api#jsonName": "segmentationEventId", - "smithy.api#required": {} - } - }, - "SegmentationDuration": { - "target": "com.amazonaws.medialive#__longMin0Max1099511627775", + "SegmentNum": { + "target": "com.amazonaws.medialive#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.", - "smithy.api#jsonName": "segmentationDuration" + "smithy.api#documentation": "Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.", + "smithy.api#jsonName": "segmentNum" } } }, @@ -14786,13 +15975,6 @@ "com.amazonaws.medialive#Scte35SpliceInsert": { "type": "structure", "members": { - "NoRegionalBlackoutFlag": { - "target": "com.amazonaws.medialive#Scte35SpliceInsertNoRegionalBlackoutBehavior", - "traits": { - "smithy.api#documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates", - "smithy.api#jsonName": "noRegionalBlackoutFlag" - } - }, "AdAvailOffset": { "target": "com.amazonaws.medialive#__integerMinNegative1000Max1000", "traits": { @@ -14800,6 +15982,13 @@ "smithy.api#jsonName": "adAvailOffset" } }, + "NoRegionalBlackoutFlag": { + "target": "com.amazonaws.medialive#Scte35SpliceInsertNoRegionalBlackoutBehavior", + "traits": { + "smithy.api#documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates", + "smithy.api#jsonName": "noRegionalBlackoutFlag" + } + }, "WebDeliveryAllowedFlag": { "target": "com.amazonaws.medialive#Scte35SpliceInsertWebDeliveryAllowedBehavior", "traits": { @@ -14828,16 +16017,9 @@ ] } }, - "com.amazonaws.medialive#Scte35SpliceInsertScheduleActionSettings": { - "type": "structure", - "members": { - "Duration": { - "target": "com.amazonaws.medialive#__longMin0Max8589934591", - "traits": { - "smithy.api#documentation": "Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.", - "smithy.api#jsonName": "duration" - } - }, + "com.amazonaws.medialive#Scte35SpliceInsertScheduleActionSettings": { + "type": "structure", + "members": { "SpliceEventId": { "target": "com.amazonaws.medialive#__longMin0Max4294967295", "traits": { @@ -14845,6 +16027,13 @@ "smithy.api#jsonName": "spliceEventId", "smithy.api#required": {} } + }, + "Duration": { + "target": "com.amazonaws.medialive#__longMin0Max8589934591", + "traits": { + "smithy.api#documentation": "Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.", + "smithy.api#jsonName": "duration" + } } }, "traits": { @@ -15171,106 +16360,114 @@ "com.amazonaws.medialive#StartChannelResponse": { "type": "structure", "members": { - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", - "traits": { - "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", - "smithy.api#jsonName": "destinations" - } - }, "EncoderSettings": { "target": "com.amazonaws.medialive#EncoderSettings", "traits": { "smithy.api#jsonName": "encoderSettings" } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The log level being written to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "The unique arn of the channel.", + "smithy.api#jsonName": "arn" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" } }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfPipelineDetail", "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" + "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", + "smithy.api#jsonName": "pipelineDetails" } }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "Arn": { - "target": "com.amazonaws.medialive#__string", + "State": { + "target": "com.amazonaws.medialive#ChannelState", "traits": { - "smithy.api#documentation": "The unique arn of the channel.", - "smithy.api#jsonName": "arn" + "smithy.api#jsonName": "state" } }, - "Id": { + "RoleArn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel.", + "smithy.api#jsonName": "roleArn" } }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#documentation": "The log level being written to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" + } + }, + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", + "traits": { + "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", + "smithy.api#jsonName": "destinations" + } + }, + "Name": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" } } }, @@ -15340,11 +16537,11 @@ "com.amazonaws.medialive#StartMultiplexResponse": { "type": "structure", "members": { - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", + "State": { + "target": "com.amazonaws.medialive#MultiplexState", "traits": { - "smithy.api#documentation": "Configuration for a multiplex event.", - "smithy.api#jsonName": "multiplexSettings" + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" } }, "Id": { @@ -15354,18 +16551,18 @@ "smithy.api#jsonName": "id" } }, - "State": { - "target": "com.amazonaws.medialive#MultiplexState", + "ProgramCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "smithy.api#documentation": "The number of programs in the multiplex.", + "smithy.api#jsonName": "programCount" } }, - "AvailabilityZones": { - "target": "com.amazonaws.medialive#__listOf__string", + "Arn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "A list of availability zones for the multiplex.", - "smithy.api#jsonName": "availabilityZones" + "smithy.api#documentation": "The unique arn of the multiplex.", + "smithy.api#jsonName": "arn" } }, "PipelinesRunningCount": { @@ -15375,18 +16572,18 @@ "smithy.api#jsonName": "pipelinesRunningCount" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { - "smithy.api#documentation": "The name of the multiplex.", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Configuration for a multiplex event.", + "smithy.api#jsonName": "multiplexSettings" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", + "AvailabilityZones": { + "target": "com.amazonaws.medialive#__listOf__string", "traits": { - "smithy.api#documentation": "A list of the multiplex output destinations.", - "smithy.api#jsonName": "destinations" + "smithy.api#documentation": "A list of availability zones for the multiplex.", + "smithy.api#jsonName": "availabilityZones" } }, "Tags": { @@ -15396,18 +16593,18 @@ "smithy.api#jsonName": "tags" } }, - "Arn": { + "Name": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique arn of the multiplex.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The name of the multiplex.", + "smithy.api#jsonName": "name" } }, - "ProgramCount": { - "target": "com.amazonaws.medialive#__integer", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { - "smithy.api#documentation": "The number of programs in the multiplex.", - "smithy.api#jsonName": "programCount" + "smithy.api#documentation": "A list of the multiplex output destinations.", + "smithy.api#jsonName": "destinations" } } }, @@ -15433,18 +16630,25 @@ "com.amazonaws.medialive#StaticImageActivateScheduleActionSettings": { "type": "structure", "members": { - "FadeIn": { + "Duration": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).", - "smithy.api#jsonName": "fadeIn" + "smithy.api#documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.", + "smithy.api#jsonName": "duration" } }, - "Opacity": { - "target": "com.amazonaws.medialive#__integerMin0Max100", + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.", - "smithy.api#jsonName": "opacity" + "smithy.api#documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.", + "smithy.api#jsonName": "layer" + } + }, + "FadeIn": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).", + "smithy.api#jsonName": "fadeIn" } }, "FadeOut": { @@ -15454,39 +16658,39 @@ "smithy.api#jsonName": "fadeOut" } }, - "Height": { - "target": "com.amazonaws.medialive#__integerMin1", + "Opacity": { + "target": "com.amazonaws.medialive#__integerMin0Max100", "traits": { - "smithy.api#documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.", - "smithy.api#jsonName": "height" + "smithy.api#documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.", + "smithy.api#jsonName": "opacity" } }, - "ImageY": { + "ImageX": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.", - "smithy.api#jsonName": "imageY" + "smithy.api#documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.", + "smithy.api#jsonName": "imageX" } }, - "ImageX": { + "ImageY": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { - "smithy.api#documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.", - "smithy.api#jsonName": "imageX" + "smithy.api#documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.", + "smithy.api#jsonName": "imageY" } }, - "Layer": { - "target": "com.amazonaws.medialive#__integerMin0Max7", + "Width": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.", - "smithy.api#jsonName": "layer" + "smithy.api#documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.", + "smithy.api#jsonName": "width" } }, - "Duration": { - "target": "com.amazonaws.medialive#__integerMin0", + "Height": { + "target": "com.amazonaws.medialive#__integerMin1", "traits": { - "smithy.api#documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.", - "smithy.api#jsonName": "duration" + "smithy.api#documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.", + "smithy.api#jsonName": "height" } }, "Image": { @@ -15496,13 +16700,6 @@ "smithy.api#jsonName": "image", "smithy.api#required": {} } - }, - "Width": { - "target": "com.amazonaws.medialive#__integerMin1", - "traits": { - "smithy.api#documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.", - "smithy.api#jsonName": "width" - } } }, "traits": { @@ -15512,19 +16709,19 @@ "com.amazonaws.medialive#StaticImageDeactivateScheduleActionSettings": { "type": "structure", "members": { - "Layer": { - "target": "com.amazonaws.medialive#__integerMin0Max7", - "traits": { - "smithy.api#documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0.", - "smithy.api#jsonName": "layer" - } - }, "FadeOut": { "target": "com.amazonaws.medialive#__integerMin0", "traits": { "smithy.api#documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out).", "smithy.api#jsonName": "fadeOut" } + }, + "Layer": { + "target": "com.amazonaws.medialive#__integerMin0Max7", + "traits": { + "smithy.api#documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0.", + "smithy.api#jsonName": "layer" + } } }, "traits": { @@ -15534,6 +16731,13 @@ "com.amazonaws.medialive#StaticKeySettings": { "type": "structure", "members": { + "KeyProviderServer": { + "target": "com.amazonaws.medialive#InputLocation", + "traits": { + "smithy.api#documentation": "The URL of the license server used for protecting content.", + "smithy.api#jsonName": "keyProviderServer" + } + }, "StaticKeyValue": { "target": "com.amazonaws.medialive#__stringMin32Max32", "traits": { @@ -15541,13 +16745,6 @@ "smithy.api#jsonName": "staticKeyValue", "smithy.api#required": {} } - }, - "KeyProviderServer": { - "target": "com.amazonaws.medialive#InputLocation", - "traits": { - "smithy.api#documentation": "The URL of the license server used for protecting content.", - "smithy.api#jsonName": "keyProviderServer" - } } }, "traits": { @@ -15616,6 +16813,20 @@ "com.amazonaws.medialive#StopChannelResponse": { "type": "structure", "members": { + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", + "traits": { + "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", + "smithy.api#jsonName": "channelClass" + } + }, + "EgressEndpoints": { + "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", + "traits": { + "smithy.api#documentation": "The endpoints where outgoing connections initiate from", + "smithy.api#jsonName": "egressEndpoints" + } + }, "Tags": { "target": "com.amazonaws.medialive#Tags", "traits": { @@ -15630,31 +16841,17 @@ "smithy.api#jsonName": "logLevel" } }, - "EgressEndpoints": { - "target": "com.amazonaws.medialive#__listOfChannelEgressEndpoint", - "traits": { - "smithy.api#documentation": "The endpoints where outgoing connections initiate from", - "smithy.api#jsonName": "egressEndpoints" - } - }, - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", - "traits": { - "smithy.api#documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.", - "smithy.api#jsonName": "channelClass" - } - }, - "State": { - "target": "com.amazonaws.medialive#ChannelState", + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", "traits": { - "smithy.api#jsonName": "state" + "smithy.api#jsonName": "encoderSettings" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "The name of the channel. (user-mutable)", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "List of input attachments for channel.", + "smithy.api#jsonName": "inputAttachments" } }, "RoleArn": { @@ -15664,24 +16861,25 @@ "smithy.api#jsonName": "roleArn" } }, - "Destinations": { - "target": "com.amazonaws.medialive#__listOfOutputDestination", - "traits": { - "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", - "smithy.api#jsonName": "destinations" - } - }, "InputSpecification": { "target": "com.amazonaws.medialive#InputSpecification", "traits": { + "smithy.api#documentation": "Specification of network and file inputs for this channel", "smithy.api#jsonName": "inputSpecification" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#documentation": "The unique id of the channel.", + "smithy.api#jsonName": "id" + } + }, + "PipelineDetails": { + "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "traits": { + "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", + "smithy.api#jsonName": "pipelineDetails" } }, "Arn": { @@ -15691,31 +16889,38 @@ "smithy.api#jsonName": "arn" } }, - "PipelineDetails": { - "target": "com.amazonaws.medialive#__listOfPipelineDetail", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Runtime details for the pipelines of a running channel.", - "smithy.api#jsonName": "pipelineDetails" + "smithy.api#documentation": "The name of the channel. (user-mutable)", + "smithy.api#jsonName": "name" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", "traits": { - "smithy.api#documentation": "List of input attachments for channel.", - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "The unique id of the channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "Destinations": { + "target": "com.amazonaws.medialive#__listOfOutputDestination", "traits": { - "smithy.api#jsonName": "encoderSettings" + "smithy.api#documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.", + "smithy.api#jsonName": "destinations" + } + }, + "State": { + "target": "com.amazonaws.medialive#ChannelState", + "traits": { + "smithy.api#jsonName": "state" } } }, @@ -15785,6 +16990,13 @@ "com.amazonaws.medialive#StopMultiplexResponse": { "type": "structure", "members": { + "PipelinesRunningCount": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#documentation": "The number of currently healthy pipelines.", + "smithy.api#jsonName": "pipelinesRunningCount" + } + }, "Destinations": { "target": "com.amazonaws.medialive#__listOfMultiplexOutputDestination", "traits": { @@ -15799,11 +17011,11 @@ "smithy.api#jsonName": "programCount" } }, - "State": { - "target": "com.amazonaws.medialive#MultiplexState", + "Tags": { + "target": "com.amazonaws.medialive#Tags", "traits": { - "smithy.api#documentation": "The current state of the multiplex.", - "smithy.api#jsonName": "state" + "smithy.api#documentation": "A collection of key-value pairs.", + "smithy.api#jsonName": "tags" } }, "Name": { @@ -15813,13 +17025,6 @@ "smithy.api#jsonName": "name" } }, - "Id": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique id of the multiplex.", - "smithy.api#jsonName": "id" - } - }, "MultiplexSettings": { "target": "com.amazonaws.medialive#MultiplexSettings", "traits": { @@ -15834,11 +17039,18 @@ "smithy.api#jsonName": "arn" } }, - "PipelinesRunningCount": { - "target": "com.amazonaws.medialive#__integer", + "Id": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The number of currently healthy pipelines.", - "smithy.api#jsonName": "pipelinesRunningCount" + "smithy.api#documentation": "The unique id of the multiplex.", + "smithy.api#jsonName": "id" + } + }, + "State": { + "target": "com.amazonaws.medialive#MultiplexState", + "traits": { + "smithy.api#documentation": "The current state of the multiplex.", + "smithy.api#jsonName": "state" } }, "AvailabilityZones": { @@ -15847,13 +17059,6 @@ "smithy.api#documentation": "A list of availability zones for the multiplex.", "smithy.api#jsonName": "availabilityZones" } - }, - "Tags": { - "target": "com.amazonaws.medialive#Tags", - "traits": { - "smithy.api#documentation": "A collection of key-value pairs.", - "smithy.api#jsonName": "tags" - } } }, "traits": { @@ -15863,19 +17068,19 @@ "com.amazonaws.medialive#StopTimecode": { "type": "structure", "members": { - "LastFrameClippingBehavior": { - "target": "com.amazonaws.medialive#LastFrameClippingBehavior", - "traits": { - "smithy.api#documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.", - "smithy.api#jsonName": "lastFrameClippingBehavior" - } - }, "Timecode": { "target": "com.amazonaws.medialive#__string", "traits": { "smithy.api#documentation": "The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.", "smithy.api#jsonName": "timecode" } + }, + "LastFrameClippingBehavior": { + "target": "com.amazonaws.medialive#LastFrameClippingBehavior", + "traits": { + "smithy.api#documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.", + "smithy.api#jsonName": "lastFrameClippingBehavior" + } } }, "traits": { @@ -15939,19 +17144,19 @@ "com.amazonaws.medialive#TemporalFilterSettings": { "type": "structure", "members": { - "PostFilterSharpening": { - "target": "com.amazonaws.medialive#TemporalFilterPostFilterSharpening", - "traits": { - "smithy.api#documentation": "If you enable this filter, the results are the following:\n- If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.\n- If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.", - "smithy.api#jsonName": "postFilterSharpening" - } - }, "Strength": { "target": "com.amazonaws.medialive#TemporalFilterStrength", "traits": { "smithy.api#documentation": "Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.", "smithy.api#jsonName": "strength" } + }, + "PostFilterSharpening": { + "target": "com.amazonaws.medialive#TemporalFilterPostFilterSharpening", + "traits": { + "smithy.api#documentation": "If you enable this filter, the results are the following:\n- If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.\n- If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.", + "smithy.api#jsonName": "postFilterSharpening" + } } }, "traits": { @@ -16034,63 +17239,182 @@ ] } }, - "com.amazonaws.medialive#TimecodeConfig": { + "com.amazonaws.medialive#TimecodeConfig": { + "type": "structure", + "members": { + "SyncThreshold": { + "target": "com.amazonaws.medialive#__integerMin1Max1000000", + "traits": { + "smithy.api#documentation": "Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.", + "smithy.api#jsonName": "syncThreshold" + } + }, + "Source": { + "target": "com.amazonaws.medialive#TimecodeConfigSource", + "traits": { + "smithy.api#documentation": "Identifies the source for the timecode that will be associated with the events outputs.\n-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using \"Start at 0\" (zerobased).\n-System Clock (systemclock): Use the UTC time.\n-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.", + "smithy.api#jsonName": "source", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Timecode Config" + } + }, + "com.amazonaws.medialive#TimecodeConfigSource": { + "type": "string", + "traits": { + "smithy.api#documentation": "Timecode Config Source", + "smithy.api#enum": [ + { + "value": "EMBEDDED", + "name": "EMBEDDED" + }, + { + "value": "SYSTEMCLOCK", + "name": "SYSTEMCLOCK" + }, + { + "value": "ZEROBASED", + "name": "ZEROBASED" + } + ] + } + }, + "com.amazonaws.medialive#TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for TooManyRequestsException", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.medialive#TransferInputDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.medialive#TransferInputDeviceRequest" + }, + "output": { + "target": "com.amazonaws.medialive#TransferInputDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.medialive#BadGatewayException" + }, + { + "target": "com.amazonaws.medialive#BadRequestException" + }, + { + "target": "com.amazonaws.medialive#ConflictException" + }, + { + "target": "com.amazonaws.medialive#ForbiddenException" + }, + { + "target": "com.amazonaws.medialive#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.medialive#InternalServerErrorException" + }, + { + "target": "com.amazonaws.medialive#NotFoundException" + }, + { + "target": "com.amazonaws.medialive#TooManyRequestsException" + }, + { + "target": "com.amazonaws.medialive#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.", + "smithy.api#http": { + "method": "POST", + "uri": "/prod/inputDevices/{InputDeviceId}/transfer", + "code": 200 + } + } + }, + "com.amazonaws.medialive#TransferInputDeviceRequest": { "type": "structure", "members": { - "SyncThreshold": { - "target": "com.amazonaws.medialive#__integerMin1Max1000000", + "TransferMessage": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.", - "smithy.api#jsonName": "syncThreshold" + "smithy.api#documentation": "An optional message for the recipient. Maximum 280 characters.", + "smithy.api#jsonName": "transferMessage" } }, - "Source": { - "target": "com.amazonaws.medialive#TimecodeConfigSource", + "InputDeviceId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Identifies the source for the timecode that will be associated with the events outputs.\n-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using \"Start at 0\" (zerobased).\n-System Clock (systemclock): Use the UTC time.\n-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.", - "smithy.api#jsonName": "source", + "smithy.api#documentation": "The unique ID of this input device. For example, hd-123456789abcdef.", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TargetCustomerId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The AWS account ID (12 digits) for the recipient of the device transfer.", + "smithy.api#jsonName": "targetCustomerId" + } } }, "traits": { - "smithy.api#documentation": "Timecode Config" + "smithy.api#documentation": "A request to transfer an input device." } }, - "com.amazonaws.medialive#TimecodeConfigSource": { - "type": "string", + "com.amazonaws.medialive#TransferInputDeviceResponse": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#documentation": "Timecode Config Source", - "smithy.api#enum": [ - { - "value": "EMBEDDED", - "name": "EMBEDDED" - }, - { - "value": "SYSTEMCLOCK", - "name": "SYSTEMCLOCK" - }, - { - "value": "ZEROBASED", - "name": "ZEROBASED" - } - ] + "smithy.api#documentation": "Placeholder documentation for TransferInputDeviceResponse" } }, - "com.amazonaws.medialive#TooManyRequestsException": { + "com.amazonaws.medialive#TransferringInputDeviceSummary": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.medialive#__string", "traits": { + "smithy.api#documentation": "The optional message that the sender has attached to the transfer.", "smithy.api#jsonName": "message" } + }, + "TransferType": { + "target": "com.amazonaws.medialive#InputDeviceTransferType", + "traits": { + "smithy.api#documentation": "The type (direction) of the input device transfer.", + "smithy.api#jsonName": "transferType" + } + }, + "TargetCustomerId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The AWS account ID for the recipient of the input device transfer.", + "smithy.api#jsonName": "targetCustomerId" + } + }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#jsonName": "id" + } } }, "traits": { - "smithy.api#documentation": "Placeholder documentation for TooManyRequestsException", - "smithy.api#error": "client", - "smithy.api#httpError": 429 + "smithy.api#documentation": "Details about the input device that is being transferred." } }, "com.amazonaws.medialive#TtmlDestinationSettings": { @@ -16141,6 +17465,13 @@ "com.amazonaws.medialive#UdpGroupSettings": { "type": "structure", "members": { + "TimedMetadataId3Period": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Timed Metadata interval in seconds.", + "smithy.api#jsonName": "timedMetadataId3Period" + } + }, "InputLossAction": { "target": "com.amazonaws.medialive#InputLossActionForUdpOut", "traits": { @@ -16154,13 +17485,6 @@ "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", "smithy.api#jsonName": "timedMetadataId3Frame" } - }, - "TimedMetadataId3Period": { - "target": "com.amazonaws.medialive#__integerMin0", - "traits": { - "smithy.api#documentation": "Timed Metadata interval in seconds.", - "smithy.api#jsonName": "timedMetadataId3Period" - } } }, "traits": { @@ -16170,6 +17494,13 @@ "com.amazonaws.medialive#UdpOutputSettings": { "type": "structure", "members": { + "BufferMsec": { + "target": "com.amazonaws.medialive#__integerMin0Max10000", + "traits": { + "smithy.api#documentation": "UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.", + "smithy.api#jsonName": "bufferMsec" + } + }, "Destination": { "target": "com.amazonaws.medialive#OutputLocationRef", "traits": { @@ -16185,13 +17516,6 @@ "smithy.api#required": {} } }, - "BufferMsec": { - "target": "com.amazonaws.medialive#__integerMin0Max10000", - "traits": { - "smithy.api#documentation": "UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.", - "smithy.api#jsonName": "bufferMsec" - } - }, "FecOutputSettings": { "target": "com.amazonaws.medialive#FecOutputSettings", "traits": { @@ -16227,19 +17551,19 @@ "com.amazonaws.medialive#UnprocessableEntityException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The error message.", - "smithy.api#jsonName": "message" - } - }, "ValidationErrors": { "target": "com.amazonaws.medialive#__listOfValidationError", "traits": { "smithy.api#documentation": "A collection of validation error responses.", "smithy.api#jsonName": "validationErrors" } + }, + "Message": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The error message.", + "smithy.api#jsonName": "message" + } } }, "traits": { @@ -16337,14 +17661,6 @@ "com.amazonaws.medialive#UpdateChannelClassRequest": { "type": "structure", "members": { - "ChannelClass": { - "target": "com.amazonaws.medialive#ChannelClass", - "traits": { - "smithy.api#documentation": "The channel class that you wish to update this channel to use.", - "smithy.api#jsonName": "channelClass", - "smithy.api#required": {} - } - }, "ChannelId": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -16359,6 +17675,14 @@ "smithy.api#documentation": "A list of output destinations for this channel.", "smithy.api#jsonName": "destinations" } + }, + "ChannelClass": { + "target": "com.amazonaws.medialive#ChannelClass", + "traits": { + "smithy.api#documentation": "The channel class that you wish to update this channel to use.", + "smithy.api#jsonName": "channelClass", + "smithy.api#required": {} + } } }, "traits": { @@ -16382,12 +17706,18 @@ "com.amazonaws.medialive#UpdateChannelRequest": { "type": "structure", "members": { - "ChannelId": { - "target": "com.amazonaws.medialive#__string", + "EncoderSettings": { + "target": "com.amazonaws.medialive#EncoderSettings", "traits": { - "smithy.api#documentation": "channel ID", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The encoder settings for this channel.", + "smithy.api#jsonName": "encoderSettings" + } + }, + "CdiInputSpecification": { + "target": "com.amazonaws.medialive#CdiInputSpecification", + "traits": { + "smithy.api#documentation": "Specification of CDI inputs for this channel", + "smithy.api#jsonName": "cdiInputSpecification" } }, "Destinations": { @@ -16397,45 +17727,46 @@ "smithy.api#jsonName": "destinations" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", + "LogLevel": { + "target": "com.amazonaws.medialive#LogLevel", "traits": { - "smithy.api#documentation": "The name of the channel.", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The log level to write to CloudWatch Logs.", + "smithy.api#jsonName": "logLevel" } }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", + "InputSpecification": { + "target": "com.amazonaws.medialive#InputSpecification", "traits": { - "smithy.api#documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.", - "smithy.api#jsonName": "roleArn" + "smithy.api#documentation": "Specification of network and file inputs for this channel", + "smithy.api#jsonName": "inputSpecification" } }, - "InputAttachments": { - "target": "com.amazonaws.medialive#__listOfInputAttachment", + "ChannelId": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#jsonName": "inputAttachments" + "smithy.api#documentation": "channel ID", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "LogLevel": { - "target": "com.amazonaws.medialive#LogLevel", + "RoleArn": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The log level to write to CloudWatch Logs.", - "smithy.api#jsonName": "logLevel" + "smithy.api#documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.", + "smithy.api#jsonName": "roleArn" } }, - "InputSpecification": { - "target": "com.amazonaws.medialive#InputSpecification", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)", - "smithy.api#jsonName": "inputSpecification" + "smithy.api#documentation": "The name of the channel.", + "smithy.api#jsonName": "name" } }, - "EncoderSettings": { - "target": "com.amazonaws.medialive#EncoderSettings", + "InputAttachments": { + "target": "com.amazonaws.medialive#__listOfInputAttachment", "traits": { - "smithy.api#documentation": "The encoder settings for this channel.", - "smithy.api#jsonName": "encoderSettings" + "smithy.api#jsonName": "inputAttachments" } } }, @@ -16543,13 +17874,6 @@ "com.amazonaws.medialive#UpdateInputDeviceRequest": { "type": "structure", "members": { - "HdDeviceSettings": { - "target": "com.amazonaws.medialive#InputDeviceConfigurableSettings", - "traits": { - "smithy.api#documentation": "The settings that you want to apply to the input device.", - "smithy.api#jsonName": "hdDeviceSettings" - } - }, "InputDeviceId": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -16558,6 +17882,13 @@ "smithy.api#required": {} } }, + "HdDeviceSettings": { + "target": "com.amazonaws.medialive#InputDeviceConfigurableSettings", + "traits": { + "smithy.api#documentation": "The settings that you want to apply to the input device.", + "smithy.api#jsonName": "hdDeviceSettings" + } + }, "Name": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -16573,32 +17904,11 @@ "com.amazonaws.medialive#UpdateInputDeviceResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The unique ARN of the input device.", - "smithy.api#jsonName": "arn" - } - }, - "MacAddress": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The network MAC address of the input device.", - "smithy.api#jsonName": "macAddress" - } - }, - "HdDeviceSettings": { - "target": "com.amazonaws.medialive#InputDeviceHdSettings", - "traits": { - "smithy.api#documentation": "Settings that describe an input device that is type HD.", - "smithy.api#jsonName": "hdDeviceSettings" - } - }, - "Type": { - "target": "com.amazonaws.medialive#InputDeviceType", + "ConnectionState": { + "target": "com.amazonaws.medialive#InputDeviceConnectionState", "traits": { - "smithy.api#documentation": "The type of the input device.", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "The state of the connection between the input device and AWS.", + "smithy.api#jsonName": "connectionState" } }, "DeviceSettingsSyncState": { @@ -16608,6 +17918,13 @@ "smithy.api#jsonName": "deviceSettingsSyncState" } }, + "Id": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The unique ID of the input device.", + "smithy.api#jsonName": "id" + } + }, "NetworkSettings": { "target": "com.amazonaws.medialive#InputDeviceNetworkSettings", "traits": { @@ -16618,8 +17935,15 @@ "SerialNumber": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique serial number of the input device.", - "smithy.api#jsonName": "serialNumber" + "smithy.api#documentation": "The unique serial number of the input device.", + "smithy.api#jsonName": "serialNumber" + } + }, + "Type": { + "target": "com.amazonaws.medialive#InputDeviceType", + "traits": { + "smithy.api#documentation": "The type of the input device.", + "smithy.api#jsonName": "type" } }, "Name": { @@ -16629,18 +17953,25 @@ "smithy.api#jsonName": "name" } }, - "Id": { + "Arn": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The unique ID of the input device.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The unique ARN of the input device.", + "smithy.api#jsonName": "arn" } }, - "ConnectionState": { - "target": "com.amazonaws.medialive#InputDeviceConnectionState", + "MacAddress": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The state of the connection between the input device and AWS.", - "smithy.api#jsonName": "connectionState" + "smithy.api#documentation": "The network MAC address of the input device.", + "smithy.api#jsonName": "macAddress" + } + }, + "HdDeviceSettings": { + "target": "com.amazonaws.medialive#InputDeviceHdSettings", + "traits": { + "smithy.api#documentation": "Settings that describe an input device that is type HD.", + "smithy.api#jsonName": "hdDeviceSettings" } } }, @@ -16651,13 +17982,6 @@ "com.amazonaws.medialive#UpdateInputRequest": { "type": "structure", "members": { - "InputDevices": { - "target": "com.amazonaws.medialive#__listOfInputDeviceRequest", - "traits": { - "smithy.api#documentation": "Settings for the devices.", - "smithy.api#jsonName": "inputDevices" - } - }, "Sources": { "target": "com.amazonaws.medialive#__listOfInputSourceRequest", "traits": { @@ -16665,6 +17989,20 @@ "smithy.api#jsonName": "sources" } }, + "RoleArn": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", + "smithy.api#jsonName": "roleArn" + } + }, + "InputDevices": { + "target": "com.amazonaws.medialive#__listOfInputDeviceRequest", + "traits": { + "smithy.api#documentation": "Settings for the devices.", + "smithy.api#jsonName": "inputDevices" + } + }, "Destinations": { "target": "com.amazonaws.medialive#__listOfInputDestinationRequest", "traits": { @@ -16680,6 +18018,13 @@ "smithy.api#required": {} } }, + "MediaConnectFlows": { + "target": "com.amazonaws.medialive#__listOfMediaConnectFlowRequest", + "traits": { + "smithy.api#documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.", + "smithy.api#jsonName": "mediaConnectFlows" + } + }, "InputSecurityGroups": { "target": "com.amazonaws.medialive#__listOf__string", "traits": { @@ -16693,20 +18038,6 @@ "smithy.api#documentation": "Name of the input.", "smithy.api#jsonName": "name" } - }, - "RoleArn": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation.", - "smithy.api#jsonName": "roleArn" - } - }, - "MediaConnectFlows": { - "target": "com.amazonaws.medialive#__listOfMediaConnectFlowRequest", - "traits": { - "smithy.api#documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.", - "smithy.api#jsonName": "mediaConnectFlows" - } } }, "traits": { @@ -16770,6 +18101,14 @@ "com.amazonaws.medialive#UpdateInputSecurityGroupRequest": { "type": "structure", "members": { + "InputSecurityGroupId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The id of the Input Security Group to update.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "WhitelistRules": { "target": "com.amazonaws.medialive#__listOfInputWhitelistRuleCidr", "traits": { @@ -16783,14 +18122,6 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } - }, - "InputSecurityGroupId": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The id of the Input Security Group to update.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -16900,10 +18231,10 @@ "com.amazonaws.medialive#UpdateMultiplexProgramRequest": { "type": "structure", "members": { - "ProgramName": { + "MultiplexId": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The name of the program to update.", + "smithy.api#documentation": "The ID of the multiplex of the program to update.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16915,10 +18246,10 @@ "smithy.api#jsonName": "multiplexProgramSettings" } }, - "MultiplexId": { + "ProgramName": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "The ID of the multiplex of the program to update.", + "smithy.api#documentation": "The name of the program to update.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16946,6 +18277,13 @@ "com.amazonaws.medialive#UpdateMultiplexRequest": { "type": "structure", "members": { + "MultiplexSettings": { + "target": "com.amazonaws.medialive#MultiplexSettings", + "traits": { + "smithy.api#documentation": "The new settings for a multiplex.", + "smithy.api#jsonName": "multiplexSettings" + } + }, "MultiplexId": { "target": "com.amazonaws.medialive#__string", "traits": { @@ -16960,13 +18298,6 @@ "smithy.api#documentation": "Name of the multiplex.", "smithy.api#jsonName": "name" } - }, - "MultiplexSettings": { - "target": "com.amazonaws.medialive#MultiplexSettings", - "traits": { - "smithy.api#documentation": "The new settings for a multiplex.", - "smithy.api#jsonName": "multiplexSettings" - } } }, "traits": { @@ -17105,6 +18436,12 @@ "smithy.api#jsonName": "h265Settings" } }, + "Mpeg2Settings": { + "target": "com.amazonaws.medialive#Mpeg2Settings", + "traits": { + "smithy.api#jsonName": "mpeg2Settings" + } + }, "H264Settings": { "target": "com.amazonaws.medialive#H264Settings", "traits": { @@ -17119,27 +18456,35 @@ "com.amazonaws.medialive#VideoDescription": { "type": "structure", "members": { - "Height": { - "target": "com.amazonaws.medialive#__integer", + "Name": { + "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.", - "smithy.api#jsonName": "height" + "smithy.api#documentation": "The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, - "Width": { - "target": "com.amazonaws.medialive#__integer", + "Sharpness": { + "target": "com.amazonaws.medialive#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.", - "smithy.api#jsonName": "width" + "smithy.api#documentation": "Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.", + "smithy.api#jsonName": "sharpness" } }, "RespondToAfd": { "target": "com.amazonaws.medialive#VideoDescriptionRespondToAfd", "traits": { - "smithy.api#documentation": "Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.", + "smithy.api#documentation": "Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH.\nRESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE.\nPASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output.\nNONE: MediaLive does not clip the input video and does not include the AFD values in the output", "smithy.api#jsonName": "respondToAfd" } }, + "CodecSettings": { + "target": "com.amazonaws.medialive#VideoCodecSettings", + "traits": { + "smithy.api#documentation": "Video codec settings.", + "smithy.api#jsonName": "codecSettings" + } + }, "ScalingBehavior": { "target": "com.amazonaws.medialive#VideoDescriptionScalingBehavior", "traits": { @@ -17147,26 +18492,18 @@ "smithy.api#jsonName": "scalingBehavior" } }, - "Name": { - "target": "com.amazonaws.medialive#__string", - "traits": { - "smithy.api#documentation": "The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "Sharpness": { - "target": "com.amazonaws.medialive#__integerMin0Max100", + "Height": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.", - "smithy.api#jsonName": "sharpness" + "smithy.api#documentation": "Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.", + "smithy.api#jsonName": "height" } }, - "CodecSettings": { - "target": "com.amazonaws.medialive#VideoCodecSettings", + "Width": { + "target": "com.amazonaws.medialive#__integer", "traits": { - "smithy.api#documentation": "Video codec settings.", - "smithy.api#jsonName": "codecSettings" + "smithy.api#documentation": "Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.", + "smithy.api#jsonName": "width" } } }, @@ -17213,13 +18550,6 @@ "com.amazonaws.medialive#VideoSelector": { "type": "structure", "members": { - "ColorSpace": { - "target": "com.amazonaws.medialive#VideoSelectorColorSpace", - "traits": { - "smithy.api#documentation": "Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.", - "smithy.api#jsonName": "colorSpace" - } - }, "SelectorSettings": { "target": "com.amazonaws.medialive#VideoSelectorSettings", "traits": { @@ -17233,6 +18563,13 @@ "smithy.api#documentation": "Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.", "smithy.api#jsonName": "colorSpaceUsage" } + }, + "ColorSpace": { + "target": "com.amazonaws.medialive#VideoSelectorColorSpace", + "traits": { + "smithy.api#documentation": "Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.", + "smithy.api#jsonName": "colorSpace" + } } }, "traits": { @@ -17325,6 +18662,59 @@ "smithy.api#documentation": "Video Selector Settings" } }, + "com.amazonaws.medialive#WavCodingMode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Wav Coding Mode", + "smithy.api#enum": [ + { + "value": "CODING_MODE_1_0", + "name": "CODING_MODE_1_0" + }, + { + "value": "CODING_MODE_2_0", + "name": "CODING_MODE_2_0" + }, + { + "value": "CODING_MODE_4_0", + "name": "CODING_MODE_4_0" + }, + { + "value": "CODING_MODE_8_0", + "name": "CODING_MODE_8_0" + } + ] + } + }, + "com.amazonaws.medialive#WavSettings": { + "type": "structure", + "members": { + "CodingMode": { + "target": "com.amazonaws.medialive#WavCodingMode", + "traits": { + "smithy.api#documentation": "The audio coding mode for the WAV audio. The mode determines the number of channels in the audio.", + "smithy.api#jsonName": "codingMode" + } + }, + "BitDepth": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Bits per sample.", + "smithy.api#jsonName": "bitDepth" + } + }, + "SampleRate": { + "target": "com.amazonaws.medialive#__double", + "traits": { + "smithy.api#documentation": "Sample rate in Hz.", + "smithy.api#jsonName": "sampleRate" + } + } + }, + "traits": { + "smithy.api#documentation": "Wav Settings" + } + }, "com.amazonaws.medialive#WebvttDestinationSettings": { "type": "structure", "members": {}, @@ -17609,16 +18999,6 @@ } } }, - "com.amazonaws.medialive#__integerMin1000Max3000": { - "type": "integer", - "traits": { - "smithy.api#documentation": "Placeholder documentation for __integerMin1000Max3000", - "smithy.api#range": { - "min": 1000, - "max": 3000 - } - } - }, "com.amazonaws.medialive#__integerMin1000Max30000": { "type": "integer", "traits": { @@ -17797,6 +19177,16 @@ } } }, + "com.amazonaws.medialive#__integerMin800Max3000": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMin800Max3000", + "smithy.api#range": { + "min": 800, + "max": 3000 + } + } + }, "com.amazonaws.medialive#__integerMin96Max600": { "type": "integer", "traits": { @@ -17817,6 +19207,16 @@ } } }, + "com.amazonaws.medialive#__integerMinNegative5Max5": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMinNegative5Max5", + "smithy.api#range": { + "min": -5, + "max": 5 + } + } + }, "com.amazonaws.medialive#__integerMinNegative60Max6": { "type": "integer", "traits": { @@ -17873,6 +19273,24 @@ "smithy.api#documentation": "Placeholder documentation for __listOfAudioTrack" } }, + "com.amazonaws.medialive#__listOfBatchFailedResultModel": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#BatchFailedResultModel" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfBatchFailedResultModel" + } + }, + "com.amazonaws.medialive#__listOfBatchSuccessfulResultModel": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#BatchSuccessfulResultModel" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfBatchSuccessfulResultModel" + } + }, "com.amazonaws.medialive#__listOfCaptionDescription": { "type": "list", "member": { @@ -18080,6 +19498,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfMultiplexOutputDestination" } }, + "com.amazonaws.medialive#__listOfMultiplexProgramPipelineDetail": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#MultiplexProgramPipelineDetail" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfMultiplexProgramPipelineDetail" + } + }, "com.amazonaws.medialive#__listOfMultiplexProgramSummary": { "type": "list", "member": { @@ -18188,6 +19615,15 @@ "smithy.api#documentation": "Placeholder documentation for __listOfScte35Descriptor" } }, + "com.amazonaws.medialive#__listOfTransferringInputDeviceSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#TransferringInputDeviceSummary" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfTransferringInputDeviceSummary" + } + }, "com.amazonaws.medialive#__listOfValidationError": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json b/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json index 0ca6a4f8d595..3ecc883da4b0 100644 --- a/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json +++ b/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json @@ -51,17 +51,18 @@ "com.amazonaws.mediapackagevod#AssetShallow": { "type": "structure", "members": { - "CreatedAt": { + "Arn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The time the Asset was initially submitted for Ingest.", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "The ARN of the Asset.", + "smithy.api#jsonName": "arn" } }, - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", + "SourceArn": { + "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "ARN of the source object in S3.", + "smithy.api#jsonName": "sourceArn" } }, "PackagingGroupId": { @@ -71,13 +72,6 @@ "smithy.api#jsonName": "packagingGroupId" } }, - "SourceArn": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "ARN of the source object in S3.", - "smithy.api#jsonName": "sourceArn" - } - }, "ResourceId": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -85,25 +79,31 @@ "smithy.api#jsonName": "resourceId" } }, - "SourceRoleArn": { + "Id": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The IAM role ARN used to access the source S3 bucket.", - "smithy.api#jsonName": "sourceRoleArn" + "smithy.api#documentation": "The unique identifier for the Asset.", + "smithy.api#jsonName": "id" } }, - "Id": { + "CreatedAt": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the Asset.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The time the Asset was initially submitted for Ingest.", + "smithy.api#jsonName": "createdAt" } }, - "Arn": { + "SourceRoleArn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The ARN of the Asset.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The IAM role ARN used to access the source S3 bucket.", + "smithy.api#jsonName": "sourceRoleArn" + } + }, + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", + "traits": { + "smithy.api#jsonName": "tags" } } }, @@ -114,19 +114,19 @@ "com.amazonaws.mediapackagevod#Authorization": { "type": "structure", "members": { - "SecretsRoleArn": { + "CdnIdentifierSecret": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.", - "smithy.api#jsonName": "secretsRoleArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.", + "smithy.api#jsonName": "cdnIdentifierSecret", "smithy.api#required": {} } }, - "CdnIdentifierSecret": { + "SecretsRoleArn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.", - "smithy.api#jsonName": "cdnIdentifierSecret", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.", + "smithy.api#jsonName": "secretsRoleArn", "smithy.api#required": {} } } @@ -153,14 +153,6 @@ "com.amazonaws.mediapackagevod#CmafPackage": { "type": "structure", "members": { - "HlsManifests": { - "target": "com.amazonaws.mediapackagevod#__listOfHlsManifest", - "traits": { - "smithy.api#documentation": "A list of HLS manifest configurations.", - "smithy.api#jsonName": "hlsManifests", - "smithy.api#required": {} - } - }, "SegmentDurationSeconds": { "target": "com.amazonaws.mediapackagevod#__integer", "traits": { @@ -173,6 +165,14 @@ "traits": { "smithy.api#jsonName": "encryption" } + }, + "HlsManifests": { + "target": "com.amazonaws.mediapackagevod#__listOfHlsManifest", + "traits": { + "smithy.api#documentation": "A list of HLS manifest configurations.", + "smithy.api#jsonName": "hlsManifests", + "smithy.api#required": {} + } } }, "traits": { @@ -240,14 +240,6 @@ "smithy.api#required": {} } }, - "PackagingGroupId": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The ID of the PackagingGroup for the Asset.", - "smithy.api#jsonName": "packagingGroupId", - "smithy.api#required": {} - } - }, "SourceRoleArn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -263,6 +255,14 @@ "smithy.api#jsonName": "id", "smithy.api#required": {} } + }, + "PackagingGroupId": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The ID of the PackagingGroup for the Asset.", + "smithy.api#jsonName": "packagingGroupId", + "smithy.api#required": {} + } } }, "traits": { @@ -272,45 +272,53 @@ "com.amazonaws.mediapackagevod#CreateAssetResponse": { "type": "structure", "members": { - "CreatedAt": { + "Id": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The time the Asset was initially submitted for Ingest.", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "The unique identifier for the Asset.", + "smithy.api#jsonName": "id" } }, - "SourceArn": { + "SourceRoleArn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "ARN of the source object in S3.", - "smithy.api#jsonName": "sourceArn" + "smithy.api#documentation": "The IAM role_arn used to access the source S3 bucket.", + "smithy.api#jsonName": "sourceRoleArn" } }, - "Id": { + "ResourceId": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the Asset.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The resource ID to include in SPEKE key requests.", + "smithy.api#jsonName": "resourceId" } }, - "PackagingGroupId": { + "Arn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The ID of the PackagingGroup for the Asset.", - "smithy.api#jsonName": "packagingGroupId" + "smithy.api#documentation": "The ARN of the Asset.", + "smithy.api#jsonName": "arn" } }, - "ResourceId": { + "CreatedAt": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The resource ID to include in SPEKE key requests.", - "smithy.api#jsonName": "resourceId" + "smithy.api#documentation": "The time the Asset was initially submitted for Ingest.", + "smithy.api#jsonName": "createdAt" } }, - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", + "SourceArn": { + "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "ARN of the source object in S3.", + "smithy.api#jsonName": "sourceArn" + } + }, + "PackagingGroupId": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The ID of the PackagingGroup for the Asset.", + "smithy.api#jsonName": "packagingGroupId" } }, "EgressEndpoints": { @@ -320,18 +328,10 @@ "smithy.api#jsonName": "egressEndpoints" } }, - "SourceRoleArn": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The IAM role_arn used to access the source S3 bucket.", - "smithy.api#jsonName": "sourceRoleArn" - } - }, - "Arn": { - "target": "com.amazonaws.mediapackagevod#__string", + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", "traits": { - "smithy.api#documentation": "The ARN of the Asset.", - "smithy.api#jsonName": "arn" + "smithy.api#jsonName": "tags" } } } @@ -376,24 +376,24 @@ "com.amazonaws.mediapackagevod#CreatePackagingConfigurationRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", + "PackagingGroupId": { + "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The ID of a PackagingGroup.", + "smithy.api#jsonName": "packagingGroupId", + "smithy.api#required": {} } }, - "CmafPackage": { - "target": "com.amazonaws.mediapackagevod#CmafPackage", + "HlsPackage": { + "target": "com.amazonaws.mediapackagevod#HlsPackage", "traits": { - "smithy.api#jsonName": "cmafPackage" + "smithy.api#jsonName": "hlsPackage" } }, - "Id": { - "target": "com.amazonaws.mediapackagevod#__string", + "MssPackage": { + "target": "com.amazonaws.mediapackagevod#MssPackage", "traits": { - "smithy.api#documentation": "The ID of the PackagingConfiguration.", - "smithy.api#jsonName": "id", - "smithy.api#required": {} + "smithy.api#jsonName": "mssPackage" } }, "DashPackage": { @@ -402,24 +402,24 @@ "smithy.api#jsonName": "dashPackage" } }, - "PackagingGroupId": { + "Id": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The ID of a PackagingGroup.", - "smithy.api#jsonName": "packagingGroupId", + "smithy.api#documentation": "The ID of the PackagingConfiguration.", + "smithy.api#jsonName": "id", "smithy.api#required": {} } }, - "HlsPackage": { - "target": "com.amazonaws.mediapackagevod#HlsPackage", + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", "traits": { - "smithy.api#jsonName": "hlsPackage" + "smithy.api#jsonName": "tags" } }, - "MssPackage": { - "target": "com.amazonaws.mediapackagevod#MssPackage", + "CmafPackage": { + "target": "com.amazonaws.mediapackagevod#CmafPackage", "traits": { - "smithy.api#jsonName": "mssPackage" + "smithy.api#jsonName": "cmafPackage" } } }, @@ -430,29 +430,10 @@ "com.amazonaws.mediapackagevod#CreatePackagingConfigurationResponse": { "type": "structure", "members": { - "CmafPackage": { - "target": "com.amazonaws.mediapackagevod#CmafPackage", - "traits": { - "smithy.api#jsonName": "cmafPackage" - } - }, - "HlsPackage": { - "target": "com.amazonaws.mediapackagevod#HlsPackage", - "traits": { - "smithy.api#jsonName": "hlsPackage" - } - }, - "MssPackage": { - "target": "com.amazonaws.mediapackagevod#MssPackage", - "traits": { - "smithy.api#jsonName": "mssPackage" - } - }, - "PackagingGroupId": { - "target": "com.amazonaws.mediapackagevod#__string", + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", "traits": { - "smithy.api#documentation": "The ID of a PackagingGroup.", - "smithy.api#jsonName": "packagingGroupId" + "smithy.api#jsonName": "tags" } }, "Id": { @@ -462,10 +443,10 @@ "smithy.api#jsonName": "id" } }, - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", + "CmafPackage": { + "target": "com.amazonaws.mediapackagevod#CmafPackage", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "cmafPackage" } }, "DashPackage": { @@ -480,6 +461,25 @@ "smithy.api#documentation": "The ARN of the PackagingConfiguration.", "smithy.api#jsonName": "arn" } + }, + "PackagingGroupId": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The ID of a PackagingGroup.", + "smithy.api#jsonName": "packagingGroupId" + } + }, + "HlsPackage": { + "target": "com.amazonaws.mediapackagevod#HlsPackage", + "traits": { + "smithy.api#jsonName": "hlsPackage" + } + }, + "MssPackage": { + "target": "com.amazonaws.mediapackagevod#MssPackage", + "traits": { + "smithy.api#jsonName": "mssPackage" + } } } }, @@ -531,17 +531,17 @@ "smithy.api#required": {} } }, - "Authorization": { - "target": "com.amazonaws.mediapackagevod#Authorization", - "traits": { - "smithy.api#jsonName": "authorization" - } - }, "Tags": { "target": "com.amazonaws.mediapackagevod#Tags", "traits": { "smithy.api#jsonName": "tags" } + }, + "Authorization": { + "target": "com.amazonaws.mediapackagevod#Authorization", + "traits": { + "smithy.api#jsonName": "authorization" + } } }, "traits": { @@ -551,6 +551,20 @@ "com.amazonaws.mediapackagevod#CreatePackagingGroupResponse": { "type": "structure", "members": { + "DomainName": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The fully qualified domain name for Assets in the PackagingGroup.", + "smithy.api#jsonName": "domainName" + } + }, + "Id": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The ID of the PackagingGroup.", + "smithy.api#jsonName": "id" + } + }, "Authorization": { "target": "com.amazonaws.mediapackagevod#Authorization", "traits": { @@ -563,26 +577,12 @@ "smithy.api#jsonName": "tags" } }, - "DomainName": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The fully qualified domain name for Assets in the PackagingGroup.", - "smithy.api#jsonName": "domainName" - } - }, "Arn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { "smithy.api#documentation": "The ARN of the PackagingGroup.", "smithy.api#jsonName": "arn" } - }, - "Id": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The ID of the PackagingGroup.", - "smithy.api#jsonName": "id" - } } } }, @@ -604,6 +604,13 @@ "com.amazonaws.mediapackagevod#DashManifest": { "type": "structure", "members": { + "Profile": { + "target": "com.amazonaws.mediapackagevod#Profile", + "traits": { + "smithy.api#documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", + "smithy.api#jsonName": "profile" + } + }, "ManifestName": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -630,13 +637,6 @@ "smithy.api#documentation": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", "smithy.api#jsonName": "manifestLayout" } - }, - "Profile": { - "target": "com.amazonaws.mediapackagevod#Profile", - "traits": { - "smithy.api#documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", - "smithy.api#jsonName": "profile" - } } }, "traits": { @@ -646,13 +646,6 @@ "com.amazonaws.mediapackagevod#DashPackage": { "type": "structure", "members": { - "SegmentDurationSeconds": { - "target": "com.amazonaws.mediapackagevod#__integer", - "traits": { - "smithy.api#documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.", - "smithy.api#jsonName": "segmentDurationSeconds" - } - }, "DashManifests": { "target": "com.amazonaws.mediapackagevod#__listOfDashManifest", "traits": { @@ -661,25 +654,32 @@ "smithy.api#required": {} } }, + "SegmentTemplateFormat": { + "target": "com.amazonaws.mediapackagevod#SegmentTemplateFormat", + "traits": { + "smithy.api#documentation": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", + "smithy.api#jsonName": "segmentTemplateFormat" + } + }, "Encryption": { "target": "com.amazonaws.mediapackagevod#DashEncryption", "traits": { "smithy.api#jsonName": "encryption" } }, + "SegmentDurationSeconds": { + "target": "com.amazonaws.mediapackagevod#__integer", + "traits": { + "smithy.api#documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.", + "smithy.api#jsonName": "segmentDurationSeconds" + } + }, "PeriodTriggers": { "target": "com.amazonaws.mediapackagevod#__listOf__PeriodTriggersElement", "traits": { "smithy.api#documentation": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)\nMedia Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not\nbe partitioned into more than one period. If the list contains \"ADS\", new periods will be created where\nthe Asset contains SCTE-35 ad markers.", "smithy.api#jsonName": "periodTriggers" } - }, - "SegmentTemplateFormat": { - "target": "com.amazonaws.mediapackagevod#SegmentTemplateFormat", - "traits": { - "smithy.api#documentation": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", - "smithy.api#jsonName": "segmentTemplateFormat" - } } }, "traits": { @@ -922,20 +922,6 @@ "smithy.api#jsonName": "resourceId" } }, - "CreatedAt": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The time the Asset was initially submitted for Ingest.", - "smithy.api#jsonName": "createdAt" - } - }, - "SourceArn": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "ARN of the source object in S3.", - "smithy.api#jsonName": "sourceArn" - } - }, "PackagingGroupId": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -950,10 +936,18 @@ "smithy.api#jsonName": "arn" } }, - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", + "CreatedAt": { + "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The time the Asset was initially submitted for Ingest.", + "smithy.api#jsonName": "createdAt" + } + }, + "SourceArn": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "ARN of the source object in S3.", + "smithy.api#jsonName": "sourceArn" } }, "EgressEndpoints": { @@ -962,6 +956,12 @@ "smithy.api#documentation": "The list of egress endpoints available for the Asset.", "smithy.api#jsonName": "egressEndpoints" } + }, + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } } } }, @@ -1018,12 +1018,6 @@ "com.amazonaws.mediapackagevod#DescribePackagingConfigurationResponse": { "type": "structure", "members": { - "HlsPackage": { - "target": "com.amazonaws.mediapackagevod#HlsPackage", - "traits": { - "smithy.api#jsonName": "hlsPackage" - } - }, "Id": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -1031,22 +1025,17 @@ "smithy.api#jsonName": "id" } }, - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", - "traits": { - "smithy.api#jsonName": "tags" - } - }, "CmafPackage": { "target": "com.amazonaws.mediapackagevod#CmafPackage", "traits": { "smithy.api#jsonName": "cmafPackage" } }, - "MssPackage": { - "target": "com.amazonaws.mediapackagevod#MssPackage", + "Arn": { + "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#jsonName": "mssPackage" + "smithy.api#documentation": "The ARN of the PackagingConfiguration.", + "smithy.api#jsonName": "arn" } }, "PackagingGroupId": { @@ -1056,18 +1045,29 @@ "smithy.api#jsonName": "packagingGroupId" } }, - "Arn": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The ARN of the PackagingConfiguration.", - "smithy.api#jsonName": "arn" - } - }, "DashPackage": { "target": "com.amazonaws.mediapackagevod#DashPackage", "traits": { "smithy.api#jsonName": "dashPackage" } + }, + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "HlsPackage": { + "target": "com.amazonaws.mediapackagevod#HlsPackage", + "traits": { + "smithy.api#jsonName": "hlsPackage" + } + }, + "MssPackage": { + "target": "com.amazonaws.mediapackagevod#MssPackage", + "traits": { + "smithy.api#jsonName": "mssPackage" + } } } }, @@ -1124,18 +1124,6 @@ "com.amazonaws.mediapackagevod#DescribePackagingGroupResponse": { "type": "structure", "members": { - "Authorization": { - "target": "com.amazonaws.mediapackagevod#Authorization", - "traits": { - "smithy.api#jsonName": "authorization" - } - }, - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", - "traits": { - "smithy.api#jsonName": "tags" - } - }, "DomainName": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -1153,8 +1141,20 @@ "Id": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The ID of the PackagingGroup.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The ID of the PackagingGroup.", + "smithy.api#jsonName": "id" + } + }, + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "Authorization": { + "target": "com.amazonaws.mediapackagevod#Authorization", + "traits": { + "smithy.api#jsonName": "authorization" } } } @@ -1222,19 +1222,19 @@ "smithy.api#jsonName": "constantInitializationVector" } }, - "SpekeKeyProvider": { - "target": "com.amazonaws.mediapackagevod#SpekeKeyProvider", - "traits": { - "smithy.api#jsonName": "spekeKeyProvider", - "smithy.api#required": {} - } - }, "EncryptionMethod": { "target": "com.amazonaws.mediapackagevod#EncryptionMethod", "traits": { "smithy.api#documentation": "The encryption method to use.", "smithy.api#jsonName": "encryptionMethod" } + }, + "SpekeKeyProvider": { + "target": "com.amazonaws.mediapackagevod#SpekeKeyProvider", + "traits": { + "smithy.api#jsonName": "spekeKeyProvider", + "smithy.api#required": {} + } } }, "traits": { @@ -1244,11 +1244,10 @@ "com.amazonaws.mediapackagevod#HlsManifest": { "type": "structure", "members": { - "IncludeIframeOnlyStream": { - "target": "com.amazonaws.mediapackagevod#__boolean", + "StreamSelection": { + "target": "com.amazonaws.mediapackagevod#StreamSelection", "traits": { - "smithy.api#documentation": "When enabled, an I-Frame only stream will be included in the output.", - "smithy.api#jsonName": "includeIframeOnlyStream" + "smithy.api#jsonName": "streamSelection" } }, "RepeatExtXKey": { @@ -1258,11 +1257,11 @@ "smithy.api#jsonName": "repeatExtXKey" } }, - "ProgramDateTimeIntervalSeconds": { - "target": "com.amazonaws.mediapackagevod#__integer", + "ManifestName": { + "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.", - "smithy.api#jsonName": "programDateTimeIntervalSeconds" + "smithy.api#documentation": "An optional string to include in the name of the manifest.", + "smithy.api#jsonName": "manifestName" } }, "AdMarkers": { @@ -1272,17 +1271,18 @@ "smithy.api#jsonName": "adMarkers" } }, - "StreamSelection": { - "target": "com.amazonaws.mediapackagevod#StreamSelection", + "ProgramDateTimeIntervalSeconds": { + "target": "com.amazonaws.mediapackagevod#__integer", "traits": { - "smithy.api#jsonName": "streamSelection" + "smithy.api#documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.", + "smithy.api#jsonName": "programDateTimeIntervalSeconds" } }, - "ManifestName": { - "target": "com.amazonaws.mediapackagevod#__string", + "IncludeIframeOnlyStream": { + "target": "com.amazonaws.mediapackagevod#__boolean", "traits": { - "smithy.api#documentation": "An optional string to include in the name of the manifest.", - "smithy.api#jsonName": "manifestName" + "smithy.api#documentation": "When enabled, an I-Frame only stream will be included in the output.", + "smithy.api#jsonName": "includeIframeOnlyStream" } } }, @@ -1293,12 +1293,10 @@ "com.amazonaws.mediapackagevod#HlsPackage": { "type": "structure", "members": { - "HlsManifests": { - "target": "com.amazonaws.mediapackagevod#__listOfHlsManifest", + "Encryption": { + "target": "com.amazonaws.mediapackagevod#HlsEncryption", "traits": { - "smithy.api#documentation": "A list of HLS manifest configurations.", - "smithy.api#jsonName": "hlsManifests", - "smithy.api#required": {} + "smithy.api#jsonName": "encryption" } }, "UseAudioRenditionGroup": { @@ -1308,10 +1306,12 @@ "smithy.api#jsonName": "useAudioRenditionGroup" } }, - "Encryption": { - "target": "com.amazonaws.mediapackagevod#HlsEncryption", + "HlsManifests": { + "target": "com.amazonaws.mediapackagevod#__listOfHlsManifest", "traits": { - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "A list of HLS manifest configurations.", + "smithy.api#jsonName": "hlsManifests", + "smithy.api#required": {} } }, "SegmentDurationSeconds": { @@ -1376,6 +1376,12 @@ "method": "GET", "uri": "/assets", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Assets", + "pageSize": "MaxResults" } } }, @@ -1389,19 +1395,19 @@ "smithy.api#httpQuery": "nextToken" } }, - "MaxResults": { - "target": "com.amazonaws.mediapackagevod#MaxResults", - "traits": { - "smithy.api#documentation": "Upper bound on number of records to return.", - "smithy.api#httpQuery": "maxResults" - } - }, "PackagingGroupId": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { "smithy.api#documentation": "Returns Assets associated with the specified PackagingGroup.", "smithy.api#httpQuery": "packagingGroupId" } + }, + "MaxResults": { + "target": "com.amazonaws.mediapackagevod#MaxResults", + "traits": { + "smithy.api#documentation": "Upper bound on number of records to return.", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -1458,19 +1464,18 @@ "method": "GET", "uri": "/packaging_configurations", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PackagingConfigurations", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediapackagevod#ListPackagingConfigurationsRequest": { "type": "structure", "members": { - "PackagingGroupId": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.", - "smithy.api#httpQuery": "packagingGroupId" - } - }, "MaxResults": { "target": "com.amazonaws.mediapackagevod#MaxResults", "traits": { @@ -1478,6 +1483,13 @@ "smithy.api#httpQuery": "maxResults" } }, + "PackagingGroupId": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.", + "smithy.api#httpQuery": "packagingGroupId" + } + }, "NextToken": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -1540,25 +1552,31 @@ "method": "GET", "uri": "/packaging_groups", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PackagingGroups", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediapackagevod#ListPackagingGroupsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "A token used to resume pagination from the end of a previous request.", - "smithy.api#httpQuery": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.mediapackagevod#MaxResults", "traits": { "smithy.api#documentation": "Upper bound on number of records to return.", "smithy.api#httpQuery": "maxResults" } + }, + "NextToken": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "A token used to resume pagination from the end of a previous request.", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -1705,7 +1723,7 @@ "sdkId": "MediaPackage Vod", "arnNamespace": "mediapackage-vod", "cloudFormationName": "MediaPackageVod", - "cloudTrailEventSource": "mediapackage_vod.amazonaws.com" + "cloudTrailEventSource": "mediapackagevod.amazonaws.com" }, "aws.auth#sigv4": { "name": "mediapackage-vod" @@ -1733,18 +1751,18 @@ "com.amazonaws.mediapackagevod#MssManifest": { "type": "structure", "members": { - "StreamSelection": { - "target": "com.amazonaws.mediapackagevod#StreamSelection", - "traits": { - "smithy.api#jsonName": "streamSelection" - } - }, "ManifestName": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { "smithy.api#documentation": "An optional string to include in the name of the manifest.", "smithy.api#jsonName": "manifestName" } + }, + "StreamSelection": { + "target": "com.amazonaws.mediapackagevod#StreamSelection", + "traits": { + "smithy.api#jsonName": "streamSelection" + } } }, "traits": { @@ -1799,11 +1817,16 @@ "com.amazonaws.mediapackagevod#PackagingConfiguration": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.mediapackagevod#__string", + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", "traits": { - "smithy.api#documentation": "The ID of the PackagingConfiguration.", - "smithy.api#jsonName": "id" + "smithy.api#jsonName": "tags" + } + }, + "MssPackage": { + "target": "com.amazonaws.mediapackagevod#MssPackage", + "traits": { + "smithy.api#jsonName": "mssPackage" } }, "HlsPackage": { @@ -1832,22 +1855,17 @@ "smithy.api#jsonName": "arn" } }, - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", - "traits": { - "smithy.api#jsonName": "tags" - } - }, "CmafPackage": { "target": "com.amazonaws.mediapackagevod#CmafPackage", "traits": { "smithy.api#jsonName": "cmafPackage" } }, - "MssPackage": { - "target": "com.amazonaws.mediapackagevod#MssPackage", + "Id": { + "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#jsonName": "mssPackage" + "smithy.api#documentation": "The ID of the PackagingConfiguration.", + "smithy.api#jsonName": "id" } } }, @@ -1858,25 +1876,12 @@ "com.amazonaws.mediapackagevod#PackagingGroup": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", - "traits": { - "smithy.api#jsonName": "tags" - } - }, "Authorization": { "target": "com.amazonaws.mediapackagevod#Authorization", "traits": { "smithy.api#jsonName": "authorization" } }, - "Arn": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The ARN of the PackagingGroup.", - "smithy.api#jsonName": "arn" - } - }, "DomainName": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -1890,6 +1895,19 @@ "smithy.api#documentation": "The ID of the PackagingGroup.", "smithy.api#jsonName": "id" } + }, + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "Arn": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The ARN of the PackagingGroup.", + "smithy.api#jsonName": "arn" + } } }, "traits": { @@ -1949,19 +1967,19 @@ "com.amazonaws.mediapackagevod#SpekeKeyProvider": { "type": "structure", "members": { - "RoleArn": { + "Url": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental\nMediaPackage will assume when accessing the key provider service.", - "smithy.api#jsonName": "roleArn", + "smithy.api#documentation": "The URL of the external key provider service.", + "smithy.api#jsonName": "url", "smithy.api#required": {} } }, - "Url": { + "RoleArn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { - "smithy.api#documentation": "The URL of the external key provider service.", - "smithy.api#jsonName": "url", + "smithy.api#documentation": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental\nMediaPackage will assume when accessing the key provider service.", + "smithy.api#jsonName": "roleArn", "smithy.api#required": {} } }, @@ -2043,14 +2061,6 @@ "com.amazonaws.mediapackagevod#TagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.mediapackagevod#__mapOf__string", "traits": { @@ -2058,6 +2068,14 @@ "smithy.api#jsonName": "tags", "smithy.api#required": {} } + }, + "ResourceArn": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -2122,14 +2140,6 @@ "com.amazonaws.mediapackagevod#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.mediapackagevod#__listOf__string", - "traits": { - "smithy.api#documentation": "A comma-separated list of the tag keys to remove from the resource.", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -2137,6 +2147,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TagKeys": { + "target": "com.amazonaws.mediapackagevod#__listOf__string", + "traits": { + "smithy.api#documentation": "A comma-separated list of the tag keys to remove from the resource.", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -2180,6 +2198,12 @@ "com.amazonaws.mediapackagevod#UpdatePackagingGroupRequest": { "type": "structure", "members": { + "Authorization": { + "target": "com.amazonaws.mediapackagevod#Authorization", + "traits": { + "smithy.api#jsonName": "authorization" + } + }, "Id": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -2187,12 +2211,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Authorization": { - "target": "com.amazonaws.mediapackagevod#Authorization", - "traits": { - "smithy.api#jsonName": "authorization" - } } }, "traits": { @@ -2202,25 +2220,12 @@ "com.amazonaws.mediapackagevod#UpdatePackagingGroupResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediapackagevod#Tags", - "traits": { - "smithy.api#jsonName": "tags" - } - }, "Authorization": { "target": "com.amazonaws.mediapackagevod#Authorization", "traits": { "smithy.api#jsonName": "authorization" } }, - "DomainName": { - "target": "com.amazonaws.mediapackagevod#__string", - "traits": { - "smithy.api#documentation": "The fully qualified domain name for Assets in the PackagingGroup.", - "smithy.api#jsonName": "domainName" - } - }, "Arn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -2228,12 +2233,25 @@ "smithy.api#jsonName": "arn" } }, + "Tags": { + "target": "com.amazonaws.mediapackagevod#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + }, "Id": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { "smithy.api#documentation": "The ID of the PackagingGroup.", "smithy.api#jsonName": "id" } + }, + "DomainName": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "The fully qualified domain name for Assets in the PackagingGroup.", + "smithy.api#jsonName": "domainName" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/mediapackage.2017-10-12.json b/codegen/sdk-codegen/aws-models/mediapackage.2017-10-12.json index ba0a8bb2729c..4af7577564d7 100644 --- a/codegen/sdk-codegen/aws-models/mediapackage.2017-10-12.json +++ b/codegen/sdk-codegen/aws-models/mediapackage.2017-10-12.json @@ -112,24 +112,23 @@ "com.amazonaws.mediapackage#Channel": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "ingressAccessLogs" } }, - "Arn": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The ID of the Channel.", + "smithy.api#jsonName": "id" } }, - "Description": { - "target": "com.amazonaws.mediapackage#__string", + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", "traits": { - "smithy.api#documentation": "A short text description of the Channel.", - "smithy.api#jsonName": "description" + "smithy.api#jsonName": "egressAccessLogs" } }, "HlsIngest": { @@ -138,11 +137,24 @@ "smithy.api#jsonName": "hlsIngest" } }, - "Id": { + "Arn": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "smithy.api#jsonName": "arn" + } + }, + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "Description": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "A short text description of the Channel.", + "smithy.api#jsonName": "description" } } }, @@ -175,11 +187,17 @@ "com.amazonaws.mediapackage#CmafPackage": { "type": "structure", "members": { - "HlsManifests": { - "target": "com.amazonaws.mediapackage#__listOfHlsManifest", + "Encryption": { + "target": "com.amazonaws.mediapackage#CmafEncryption", "traits": { - "smithy.api#documentation": "A list of HLS manifest configurations", - "smithy.api#jsonName": "hlsManifests" + "smithy.api#jsonName": "encryption" + } + }, + "SegmentPrefix": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", + "smithy.api#jsonName": "segmentPrefix" } }, "SegmentDurationSeconds": { @@ -195,17 +213,11 @@ "smithy.api#jsonName": "streamSelection" } }, - "SegmentPrefix": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", - "smithy.api#jsonName": "segmentPrefix" - } - }, - "Encryption": { - "target": "com.amazonaws.mediapackage#CmafEncryption", + "HlsManifests": { + "target": "com.amazonaws.mediapackage#__listOfHlsManifest", "traits": { - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "A list of HLS manifest configurations", + "smithy.api#jsonName": "hlsManifests" } } }, @@ -216,6 +228,19 @@ "com.amazonaws.mediapackage#CmafPackageCreateOrUpdateParameters": { "type": "structure", "members": { + "Encryption": { + "target": "com.amazonaws.mediapackage#CmafEncryption", + "traits": { + "smithy.api#jsonName": "encryption" + } + }, + "SegmentPrefix": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", + "smithy.api#jsonName": "segmentPrefix" + } + }, "StreamSelection": { "target": "com.amazonaws.mediapackage#StreamSelection", "traits": { @@ -235,32 +260,19 @@ "smithy.api#documentation": "A list of HLS manifest configurations", "smithy.api#jsonName": "hlsManifests" } - }, - "SegmentPrefix": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", - "smithy.api#jsonName": "segmentPrefix" - } - }, - "Encryption": { - "target": "com.amazonaws.mediapackage#CmafEncryption", - "traits": { - "smithy.api#jsonName": "encryption" - } } }, "traits": { "smithy.api#documentation": "A Common Media Application Format (CMAF) packaging configuration." } }, - "com.amazonaws.mediapackage#CreateChannel": { + "com.amazonaws.mediapackage#ConfigureLogs": { "type": "operation", "input": { - "target": "com.amazonaws.mediapackage#CreateChannelRequest" + "target": "com.amazonaws.mediapackage#ConfigureLogsRequest" }, "output": { - "target": "com.amazonaws.mediapackage#CreateChannelResponse" + "target": "com.amazonaws.mediapackage#ConfigureLogsResponse" }, "errors": [ { @@ -283,50 +295,49 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Channel.", + "smithy.api#documentation": "Changes the Channel's properities to configure log subscription", "smithy.api#http": { - "method": "POST", - "uri": "/channels", + "method": "PUT", + "uri": "/channels/{Id}/configure_logs", "code": 200 } } }, - "com.amazonaws.mediapackage#CreateChannelRequest": { + "com.amazonaws.mediapackage#ConfigureLogsRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel. The ID must be unique within the region and it\ncannot be changed after a Channel is created.", - "smithy.api#jsonName": "id", + "smithy.api#documentation": "The ID of the channel to log subscription.", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.mediapackage#__string", + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", "traits": { - "smithy.api#documentation": "A short text description of the Channel.", - "smithy.api#jsonName": "description" + "smithy.api#jsonName": "ingressAccessLogs" } }, - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "egressAccessLogs" } } }, "traits": { - "smithy.api#documentation": "A new Channel configuration." + "smithy.api#documentation": "the option to configure log subscription." } }, - "com.amazonaws.mediapackage#CreateChannelResponse": { + "com.amazonaws.mediapackage#ConfigureLogsResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "egressAccessLogs" } }, "HlsIngest": { @@ -335,11 +346,17 @@ "smithy.api#jsonName": "hlsIngest" } }, - "Description": { + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", + "traits": { + "smithy.api#jsonName": "ingressAccessLogs" + } + }, + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A short text description of the Channel.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The ID of the Channel.", + "smithy.api#jsonName": "id" } }, "Arn": { @@ -349,22 +366,28 @@ "smithy.api#jsonName": "arn" } }, - "Id": { + "Description": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "A short text description of the Channel.", + "smithy.api#jsonName": "description" + } + }, + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", + "traits": { + "smithy.api#jsonName": "tags" } } } }, - "com.amazonaws.mediapackage#CreateHarvestJob": { + "com.amazonaws.mediapackage#CreateChannel": { "type": "operation", "input": { - "target": "com.amazonaws.mediapackage#CreateHarvestJobRequest" + "target": "com.amazonaws.mediapackage#CreateChannelRequest" }, "output": { - "target": "com.amazonaws.mediapackage#CreateHarvestJobResponse" + "target": "com.amazonaws.mediapackage#CreateChannelResponse" }, "errors": [ { @@ -387,135 +410,100 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new HarvestJob record.", + "smithy.api#documentation": "Creates a new Channel.", "smithy.api#http": { "method": "POST", - "uri": "/harvest_jobs", + "uri": "/channels", "code": 200 } } }, - "com.amazonaws.mediapackage#CreateHarvestJobRequest": { + "com.amazonaws.mediapackage#CreateChannelRequest": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "The end of the time-window which will be harvested", - "smithy.api#jsonName": "endTime", - "smithy.api#required": {} - } - }, - "OriginEndpointId": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", - "smithy.api#jsonName": "originEndpointId", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.mediapackage#__string", + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", "traits": { - "smithy.api#documentation": "The start of the time-window which will be harvested", - "smithy.api#jsonName": "startTime", - "smithy.api#required": {} + "smithy.api#jsonName": "tags" } }, "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted", + "smithy.api#documentation": "The ID of the Channel. The ID must be unique within the region and it\ncannot be changed after a Channel is created.", "smithy.api#jsonName": "id", "smithy.api#required": {} } }, - "S3Destination": { - "target": "com.amazonaws.mediapackage#S3Destination", + "Description": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "s3Destination", - "smithy.api#required": {} + "smithy.api#documentation": "A short text description of the Channel.", + "smithy.api#jsonName": "description" } } }, "traits": { - "smithy.api#documentation": "Configuration parameters used to create a new HarvestJob." + "smithy.api#documentation": "A new Channel configuration." } }, - "com.amazonaws.mediapackage#CreateHarvestJobResponse": { + "com.amazonaws.mediapackage#CreateChannelResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted.", - "smithy.api#jsonName": "id" - } - }, - "StartTime": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "The start of the time-window which will be harvested.", - "smithy.api#jsonName": "startTime" - } - }, - "EndTime": { + "Arn": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The end of the time-window which will be harvested.", - "smithy.api#jsonName": "endTime" + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "smithy.api#jsonName": "arn" } }, - "Arn": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The ID of the Channel.", + "smithy.api#jsonName": "id" } }, - "CreatedAt": { + "Description": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The time the HarvestJob was submitted", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "A short text description of the Channel.", + "smithy.api#jsonName": "description" } }, - "OriginEndpointId": { - "target": "com.amazonaws.mediapackage#__string", + "HlsIngest": { + "target": "com.amazonaws.mediapackage#HlsIngest", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", - "smithy.api#jsonName": "originEndpointId" + "smithy.api#jsonName": "hlsIngest" } }, - "S3Destination": { - "target": "com.amazonaws.mediapackage#S3Destination", + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", "traits": { - "smithy.api#jsonName": "s3Destination" + "smithy.api#jsonName": "tags" } }, - "Status": { - "target": "com.amazonaws.mediapackage#Status", + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", "traits": { - "smithy.api#documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.", - "smithy.api#jsonName": "status" + "smithy.api#jsonName": "egressAccessLogs" } }, - "ChannelId": { - "target": "com.amazonaws.mediapackage#__string", + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", "traits": { - "smithy.api#documentation": "The ID of the Channel that the HarvestJob will harvest from.", - "smithy.api#jsonName": "channelId" + "smithy.api#jsonName": "ingressAccessLogs" } } } }, - "com.amazonaws.mediapackage#CreateOriginEndpoint": { + "com.amazonaws.mediapackage#CreateHarvestJob": { "type": "operation", "input": { - "target": "com.amazonaws.mediapackage#CreateOriginEndpointRequest" + "target": "com.amazonaws.mediapackage#CreateHarvestJobRequest" }, "output": { - "target": "com.amazonaws.mediapackage#CreateOriginEndpointResponse" + "target": "com.amazonaws.mediapackage#CreateHarvestJobResponse" }, "errors": [ { @@ -538,68 +526,193 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new OriginEndpoint record.", + "smithy.api#documentation": "Creates a new HarvestJob record.", "smithy.api#http": { "method": "POST", - "uri": "/origin_endpoints", + "uri": "/harvest_jobs", "code": 200 } } }, - "com.amazonaws.mediapackage#CreateOriginEndpointRequest": { + "com.amazonaws.mediapackage#CreateHarvestJobRequest": { "type": "structure", "members": { - "TimeDelaySeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "StartTime": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", - "smithy.api#jsonName": "timeDelaySeconds" + "smithy.api#documentation": "The start of the time-window which will be harvested", + "smithy.api#jsonName": "startTime", + "smithy.api#required": {} } }, - "DashPackage": { - "target": "com.amazonaws.mediapackage#DashPackage", + "EndTime": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "dashPackage" + "smithy.api#documentation": "The end of the time-window which will be harvested", + "smithy.api#jsonName": "endTime", + "smithy.api#required": {} } }, - "ChannelId": { + "OriginEndpointId": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel that the OriginEndpoint will be associated with.\nThis cannot be changed after the OriginEndpoint is created.", - "smithy.api#jsonName": "channelId", + "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", + "smithy.api#jsonName": "originEndpointId", "smithy.api#required": {} } }, - "HlsPackage": { - "target": "com.amazonaws.mediapackage#HlsPackage", + "Id": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "hlsPackage" + "smithy.api#documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted", + "smithy.api#jsonName": "id", + "smithy.api#required": {} } }, - "Whitelist": { - "target": "com.amazonaws.mediapackage#__listOf__string", + "S3Destination": { + "target": "com.amazonaws.mediapackage#S3Destination", "traits": { - "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", - "smithy.api#jsonName": "whitelist" + "smithy.api#jsonName": "s3Destination", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration parameters used to create a new HarvestJob." + } + }, + "com.amazonaws.mediapackage#CreateHarvestJobResponse": { + "type": "structure", + "members": { + "S3Destination": { + "target": "com.amazonaws.mediapackage#S3Destination", + "traits": { + "smithy.api#jsonName": "s3Destination" } }, - "CmafPackage": { - "target": "com.amazonaws.mediapackage#CmafPackageCreateOrUpdateParameters", + "Status": { + "target": "com.amazonaws.mediapackage#Status", "traits": { - "smithy.api#jsonName": "cmafPackage" + "smithy.api#documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.", + "smithy.api#jsonName": "status" } }, - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", + "OriginEndpointId": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", + "smithy.api#jsonName": "originEndpointId" } }, - "ManifestName": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A short string that will be used as the filename of the OriginEndpoint URL (defaults to \"index\").", - "smithy.api#jsonName": "manifestName" + "smithy.api#documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted.", + "smithy.api#jsonName": "id" + } + }, + "CreatedAt": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The time the HarvestJob was submitted", + "smithy.api#jsonName": "createdAt" + } + }, + "StartTime": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The start of the time-window which will be harvested.", + "smithy.api#jsonName": "startTime" + } + }, + "Arn": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.", + "smithy.api#jsonName": "arn" + } + }, + "EndTime": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The end of the time-window which will be harvested.", + "smithy.api#jsonName": "endTime" + } + }, + "ChannelId": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The ID of the Channel that the HarvestJob will harvest from.", + "smithy.api#jsonName": "channelId" + } + } + } + }, + "com.amazonaws.mediapackage#CreateOriginEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediapackage#CreateOriginEndpointRequest" + }, + "output": { + "target": "com.amazonaws.mediapackage#CreateOriginEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediapackage#ForbiddenException" + }, + { + "target": "com.amazonaws.mediapackage#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mediapackage#NotFoundException" + }, + { + "target": "com.amazonaws.mediapackage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.mediapackage#TooManyRequestsException" + }, + { + "target": "com.amazonaws.mediapackage#UnprocessableEntityException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new OriginEndpoint record.", + "smithy.api#http": { + "method": "POST", + "uri": "/origin_endpoints", + "code": 200 + } + } + }, + "com.amazonaws.mediapackage#CreateOriginEndpointRequest": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The ID of the Channel that the OriginEndpoint will be associated with.\nThis cannot be changed after the OriginEndpoint is created.", + "smithy.api#jsonName": "channelId", + "smithy.api#required": {} + } + }, + "Origination": { + "target": "com.amazonaws.mediapackage#Origination", + "traits": { + "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", + "smithy.api#jsonName": "origination" + } + }, + "DashPackage": { + "target": "com.amazonaws.mediapackage#DashPackage", + "traits": { + "smithy.api#jsonName": "dashPackage" + } + }, + "HlsPackage": { + "target": "com.amazonaws.mediapackage#HlsPackage", + "traits": { + "smithy.api#jsonName": "hlsPackage" } }, "Authorization": { @@ -608,6 +721,12 @@ "smithy.api#jsonName": "authorization" } }, + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + }, "StartoverWindowSeconds": { "target": "com.amazonaws.mediapackage#__integer", "traits": { @@ -615,11 +734,23 @@ "smithy.api#jsonName": "startoverWindowSeconds" } }, - "Origination": { - "target": "com.amazonaws.mediapackage#Origination", + "CmafPackage": { + "target": "com.amazonaws.mediapackage#CmafPackageCreateOrUpdateParameters", "traits": { - "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", - "smithy.api#jsonName": "origination" + "smithy.api#jsonName": "cmafPackage" + } + }, + "MssPackage": { + "target": "com.amazonaws.mediapackage#MssPackage", + "traits": { + "smithy.api#jsonName": "mssPackage" + } + }, + "Description": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "A short text description of the OriginEndpoint.", + "smithy.api#jsonName": "description" } }, "Id": { @@ -630,17 +761,25 @@ "smithy.api#required": {} } }, - "MssPackage": { - "target": "com.amazonaws.mediapackage#MssPackage", + "TimeDelaySeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#jsonName": "mssPackage" + "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", + "smithy.api#jsonName": "timeDelaySeconds" } }, - "Description": { + "ManifestName": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A short text description of the OriginEndpoint.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "A short string that will be used as the filename of the OriginEndpoint URL (defaults to \"index\").", + "smithy.api#jsonName": "manifestName" + } + }, + "Whitelist": { + "target": "com.amazonaws.mediapackage#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "smithy.api#jsonName": "whitelist" } } }, @@ -651,17 +790,44 @@ "com.amazonaws.mediapackage#CreateOriginEndpointResponse": { "type": "structure", "members": { - "StartoverWindowSeconds": { + "Arn": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", + "smithy.api#jsonName": "arn" + } + }, + "MssPackage": { + "target": "com.amazonaws.mediapackage#MssPackage", + "traits": { + "smithy.api#jsonName": "mssPackage" + } + }, + "ManifestName": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "A short string appended to the end of the OriginEndpoint URL.", + "smithy.api#jsonName": "manifestName" + } + }, + "TimeDelaySeconds": { "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", - "smithy.api#jsonName": "startoverWindowSeconds" + "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", + "smithy.api#jsonName": "timeDelaySeconds" } }, - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", + "DashPackage": { + "target": "com.amazonaws.mediapackage#DashPackage", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "dashPackage" + } + }, + "Whitelist": { + "target": "com.amazonaws.mediapackage#__listOf__string", + "traits": { + "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "smithy.api#jsonName": "whitelist" } }, "Url": { @@ -671,11 +837,11 @@ "smithy.api#jsonName": "url" } }, - "Origination": { - "target": "com.amazonaws.mediapackage#Origination", + "ChannelId": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", - "smithy.api#jsonName": "origination" + "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "smithy.api#jsonName": "channelId" } }, "HlsPackage": { @@ -684,37 +850,30 @@ "smithy.api#jsonName": "hlsPackage" } }, - "ManifestName": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "A short string appended to the end of the OriginEndpoint URL.", - "smithy.api#jsonName": "manifestName" - } - }, "Authorization": { "target": "com.amazonaws.mediapackage#Authorization", "traits": { "smithy.api#jsonName": "authorization" } }, - "Id": { - "target": "com.amazonaws.mediapackage#__string", + "Origination": { + "target": "com.amazonaws.mediapackage#Origination", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", + "smithy.api#jsonName": "origination" } }, - "DashPackage": { - "target": "com.amazonaws.mediapackage#DashPackage", + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", "traits": { - "smithy.api#jsonName": "dashPackage" + "smithy.api#jsonName": "tags" } }, - "Arn": { - "target": "com.amazonaws.mediapackage#__string", + "StartoverWindowSeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", + "smithy.api#jsonName": "startoverWindowSeconds" } }, "Description": { @@ -730,31 +889,11 @@ "smithy.api#jsonName": "cmafPackage" } }, - "TimeDelaySeconds": { - "target": "com.amazonaws.mediapackage#__integer", - "traits": { - "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", - "smithy.api#jsonName": "timeDelaySeconds" - } - }, - "MssPackage": { - "target": "com.amazonaws.mediapackage#MssPackage", - "traits": { - "smithy.api#jsonName": "mssPackage" - } - }, - "ChannelId": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", - "smithy.api#jsonName": "channelId" - } - }, - "Whitelist": { - "target": "com.amazonaws.mediapackage#__listOf__string", - "traits": { - "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", - "smithy.api#jsonName": "whitelist" + "smithy.api#documentation": "The ID of the OriginEndpoint.", + "smithy.api#jsonName": "id" } } } @@ -784,18 +923,11 @@ "com.amazonaws.mediapackage#DashPackage": { "type": "structure", "members": { - "SegmentDurationSeconds": { - "target": "com.amazonaws.mediapackage#__integer", - "traits": { - "smithy.api#documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.", - "smithy.api#jsonName": "segmentDurationSeconds" - } - }, - "SegmentTemplateFormat": { - "target": "com.amazonaws.mediapackage#SegmentTemplateFormat", + "ManifestLayout": { + "target": "com.amazonaws.mediapackage#ManifestLayout", "traits": { - "smithy.api#documentation": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", - "smithy.api#jsonName": "segmentTemplateFormat" + "smithy.api#documentation": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", + "smithy.api#jsonName": "manifestLayout" } }, "ManifestWindowSeconds": { @@ -805,11 +937,17 @@ "smithy.api#jsonName": "manifestWindowSeconds" } }, - "MinUpdatePeriodSeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "UtcTimingUri": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).", - "smithy.api#jsonName": "minUpdatePeriodSeconds" + "smithy.api#documentation": "Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO or HTTP-HEAD", + "smithy.api#jsonName": "utcTimingUri" + } + }, + "AdsOnDeliveryRestrictions": { + "target": "com.amazonaws.mediapackage#AdsOnDeliveryRestrictions", + "traits": { + "smithy.api#jsonName": "adsOnDeliveryRestrictions" } }, "StreamSelection": { @@ -818,31 +956,31 @@ "smithy.api#jsonName": "streamSelection" } }, - "SuggestedPresentationDelaySeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "SegmentTemplateFormat": { + "target": "com.amazonaws.mediapackage#SegmentTemplateFormat", "traits": { - "smithy.api#documentation": "Duration (in seconds) to delay live content before presentation.", - "smithy.api#jsonName": "suggestedPresentationDelaySeconds" + "smithy.api#documentation": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", + "smithy.api#jsonName": "segmentTemplateFormat" } }, - "MinBufferTimeSeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "Profile": { + "target": "com.amazonaws.mediapackage#Profile", "traits": { - "smithy.api#documentation": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", - "smithy.api#jsonName": "minBufferTimeSeconds" + "smithy.api#documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", + "smithy.api#jsonName": "profile" } }, - "ManifestLayout": { - "target": "com.amazonaws.mediapackage#ManifestLayout", + "UtcTiming": { + "target": "com.amazonaws.mediapackage#UtcTiming", "traits": { - "smithy.api#documentation": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", - "smithy.api#jsonName": "manifestLayout" + "smithy.api#documentation": "Determines the type of UTCTiming included in the Media Presentation Description (MPD)", + "smithy.api#jsonName": "utcTiming" } }, - "AdsOnDeliveryRestrictions": { - "target": "com.amazonaws.mediapackage#AdsOnDeliveryRestrictions", + "Encryption": { + "target": "com.amazonaws.mediapackage#DashEncryption", "traits": { - "smithy.api#jsonName": "adsOnDeliveryRestrictions" + "smithy.api#jsonName": "encryption" } }, "PeriodTriggers": { @@ -858,17 +996,32 @@ "smithy.api#jsonName": "adTriggers" } }, - "Encryption": { - "target": "com.amazonaws.mediapackage#DashEncryption", + "MinBufferTimeSeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", + "smithy.api#jsonName": "minBufferTimeSeconds" } }, - "Profile": { - "target": "com.amazonaws.mediapackage#Profile", + "SuggestedPresentationDelaySeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", - "smithy.api#jsonName": "profile" + "smithy.api#documentation": "Duration (in seconds) to delay live content before presentation.", + "smithy.api#jsonName": "suggestedPresentationDelaySeconds" + } + }, + "SegmentDurationSeconds": { + "target": "com.amazonaws.mediapackage#__integer", + "traits": { + "smithy.api#documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.", + "smithy.api#jsonName": "segmentDurationSeconds" + } + }, + "MinUpdatePeriodSeconds": { + "target": "com.amazonaws.mediapackage#__integer", + "traits": { + "smithy.api#documentation": "Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).", + "smithy.api#jsonName": "minUpdatePeriodSeconds" } } }, @@ -1037,11 +1190,10 @@ "com.amazonaws.mediapackage#DescribeChannelResponse": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.mediapackage#__string", + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", "traits": { - "smithy.api#documentation": "A short text description of the Channel.", - "smithy.api#jsonName": "description" + "smithy.api#jsonName": "ingressAccessLogs" } }, "Tags": { @@ -1050,11 +1202,18 @@ "smithy.api#jsonName": "tags" } }, - "Id": { + "Description": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "A short text description of the Channel.", + "smithy.api#jsonName": "description" + } + }, + "Arn": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "smithy.api#jsonName": "arn" } }, "HlsIngest": { @@ -1063,11 +1222,17 @@ "smithy.api#jsonName": "hlsIngest" } }, - "Arn": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The ID of the Channel.", + "smithy.api#jsonName": "id" + } + }, + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", + "traits": { + "smithy.api#jsonName": "egressAccessLogs" } } } @@ -1125,66 +1290,66 @@ "com.amazonaws.mediapackage#DescribeHarvestJobResponse": { "type": "structure", "members": { - "Arn": { + "StartTime": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The start of the time-window which will be harvested.", + "smithy.api#jsonName": "startTime" } }, - "S3Destination": { - "target": "com.amazonaws.mediapackage#S3Destination", + "Status": { + "target": "com.amazonaws.mediapackage#Status", "traits": { - "smithy.api#jsonName": "s3Destination" + "smithy.api#documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.", + "smithy.api#jsonName": "status" } }, - "Id": { + "CreatedAt": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The time the HarvestJob was submitted", + "smithy.api#jsonName": "createdAt" } }, - "Status": { - "target": "com.amazonaws.mediapackage#Status", + "OriginEndpointId": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.", - "smithy.api#jsonName": "status" + "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", + "smithy.api#jsonName": "originEndpointId" } }, - "EndTime": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The end of the time-window which will be harvested.", - "smithy.api#jsonName": "endTime" + "smithy.api#documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted.", + "smithy.api#jsonName": "id" } }, - "StartTime": { + "ChannelId": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The start of the time-window which will be harvested.", - "smithy.api#jsonName": "startTime" + "smithy.api#documentation": "The ID of the Channel that the HarvestJob will harvest from.", + "smithy.api#jsonName": "channelId" } }, - "CreatedAt": { + "Arn": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The time the HarvestJob was submitted", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.", + "smithy.api#jsonName": "arn" } }, - "OriginEndpointId": { + "EndTime": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", - "smithy.api#jsonName": "originEndpointId" + "smithy.api#documentation": "The end of the time-window which will be harvested.", + "smithy.api#jsonName": "endTime" } }, - "ChannelId": { - "target": "com.amazonaws.mediapackage#__string", + "S3Destination": { + "target": "com.amazonaws.mediapackage#S3Destination", "traits": { - "smithy.api#documentation": "The ID of the Channel that the HarvestJob will harvest from.", - "smithy.api#jsonName": "channelId" + "smithy.api#jsonName": "s3Destination" } } } @@ -1242,36 +1407,31 @@ "com.amazonaws.mediapackage#DescribeOriginEndpointResponse": { "type": "structure", "members": { - "StartoverWindowSeconds": { - "target": "com.amazonaws.mediapackage#__integer", - "traits": { - "smithy.api#documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", - "smithy.api#jsonName": "startoverWindowSeconds" - } - }, - "CmafPackage": { - "target": "com.amazonaws.mediapackage#CmafPackage", + "Arn": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "cmafPackage" + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", + "smithy.api#jsonName": "arn" } }, - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", + "MssPackage": { + "target": "com.amazonaws.mediapackage#MssPackage", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "mssPackage" } }, - "Authorization": { - "target": "com.amazonaws.mediapackage#Authorization", + "TimeDelaySeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#jsonName": "authorization" + "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", + "smithy.api#jsonName": "timeDelaySeconds" } }, - "ManifestName": { - "target": "com.amazonaws.mediapackage#__string", + "Whitelist": { + "target": "com.amazonaws.mediapackage#__listOf__string", "traits": { - "smithy.api#documentation": "A short string appended to the end of the OriginEndpoint URL.", - "smithy.api#jsonName": "manifestName" + "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "smithy.api#jsonName": "whitelist" } }, "DashPackage": { @@ -1280,74 +1440,94 @@ "smithy.api#jsonName": "dashPackage" } }, - "HlsPackage": { - "target": "com.amazonaws.mediapackage#HlsPackage", + "ChannelId": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "hlsPackage" + "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "smithy.api#jsonName": "channelId" } }, - "Id": { + "Url": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The URL of the packaged OriginEndpoint for consumption.", + "smithy.api#jsonName": "url" } }, - "Arn": { - "target": "com.amazonaws.mediapackage#__string", + "Origination": { + "target": "com.amazonaws.mediapackage#Origination", + "traits": { + "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", + "smithy.api#jsonName": "origination" + } + }, + "Authorization": { + "target": "com.amazonaws.mediapackage#Authorization", + "traits": { + "smithy.api#jsonName": "authorization" + } + }, + "HlsPackage": { + "target": "com.amazonaws.mediapackage#HlsPackage", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", - "smithy.api#jsonName": "arn" + "smithy.api#jsonName": "hlsPackage" } }, - "Description": { + "ManifestName": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A short text description of the OriginEndpoint.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "A short string appended to the end of the OriginEndpoint URL.", + "smithy.api#jsonName": "manifestName" } }, - "MssPackage": { - "target": "com.amazonaws.mediapackage#MssPackage", + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", "traits": { - "smithy.api#jsonName": "mssPackage" + "smithy.api#jsonName": "tags" } }, - "Whitelist": { - "target": "com.amazonaws.mediapackage#__listOf__string", + "StartoverWindowSeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", - "smithy.api#jsonName": "whitelist" + "smithy.api#documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", + "smithy.api#jsonName": "startoverWindowSeconds" } }, - "Origination": { - "target": "com.amazonaws.mediapackage#Origination", + "CmafPackage": { + "target": "com.amazonaws.mediapackage#CmafPackage", "traits": { - "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", - "smithy.api#jsonName": "origination" + "smithy.api#jsonName": "cmafPackage" } }, - "Url": { + "Description": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The URL of the packaged OriginEndpoint for consumption.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "A short text description of the OriginEndpoint.", + "smithy.api#jsonName": "description" } }, - "ChannelId": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", - "smithy.api#jsonName": "channelId" + "smithy.api#documentation": "The ID of the OriginEndpoint.", + "smithy.api#jsonName": "id" } - }, - "TimeDelaySeconds": { - "target": "com.amazonaws.mediapackage#__integer", + } + } + }, + "com.amazonaws.mediapackage#EgressAccessLogs": { + "type": "structure", + "members": { + "LogGroupName": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", - "smithy.api#jsonName": "timeDelaySeconds" + "smithy.api#documentation": "Customize the log group name.", + "smithy.api#jsonName": "logGroupName" } } + }, + "traits": { + "smithy.api#documentation": "Configure egress access logging." } }, "com.amazonaws.mediapackage#EncryptionMethod": { @@ -1384,32 +1564,24 @@ "com.amazonaws.mediapackage#HarvestJob": { "type": "structure", "members": { - "ChannelId": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "The ID of the Channel that the HarvestJob will harvest from.", - "smithy.api#jsonName": "channelId" - } - }, - "Arn": { - "target": "com.amazonaws.mediapackage#__string", + "Status": { + "target": "com.amazonaws.mediapackage#Status", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.", + "smithy.api#jsonName": "status" } }, - "StartTime": { + "CreatedAt": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The start of the time-window which will be harvested.", - "smithy.api#jsonName": "startTime" + "smithy.api#documentation": "The time the HarvestJob was submitted", + "smithy.api#jsonName": "createdAt" } }, - "Status": { - "target": "com.amazonaws.mediapackage#Status", + "S3Destination": { + "target": "com.amazonaws.mediapackage#S3Destination", "traits": { - "smithy.api#documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.", - "smithy.api#jsonName": "status" + "smithy.api#jsonName": "s3Destination" } }, "EndTime": { @@ -1419,24 +1591,32 @@ "smithy.api#jsonName": "endTime" } }, - "OriginEndpointId": { + "ChannelId": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", - "smithy.api#jsonName": "originEndpointId" + "smithy.api#documentation": "The ID of the Channel that the HarvestJob will harvest from.", + "smithy.api#jsonName": "channelId" } }, - "CreatedAt": { + "StartTime": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The time the HarvestJob was submitted", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "The start of the time-window which will be harvested.", + "smithy.api#jsonName": "startTime" } }, - "S3Destination": { - "target": "com.amazonaws.mediapackage#S3Destination", + "Arn": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "s3Destination" + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.", + "smithy.api#jsonName": "arn" + } + }, + "OriginEndpointId": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.", + "smithy.api#jsonName": "originEndpointId" } }, "Id": { @@ -1454,20 +1634,6 @@ "com.amazonaws.mediapackage#HlsEncryption": { "type": "structure", "members": { - "ConstantInitializationVector": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "A constant initialization vector for encryption (optional).\nWhen not specified the initialization vector will be periodically rotated.", - "smithy.api#jsonName": "constantInitializationVector" - } - }, - "SpekeKeyProvider": { - "target": "com.amazonaws.mediapackage#SpekeKeyProvider", - "traits": { - "smithy.api#jsonName": "spekeKeyProvider", - "smithy.api#required": {} - } - }, "RepeatExtXKey": { "target": "com.amazonaws.mediapackage#__boolean", "traits": { @@ -1488,6 +1654,20 @@ "smithy.api#documentation": "The encryption method to use.", "smithy.api#jsonName": "encryptionMethod" } + }, + "ConstantInitializationVector": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "A constant initialization vector for encryption (optional).\nWhen not specified the initialization vector will be periodically rotated.", + "smithy.api#jsonName": "constantInitializationVector" + } + }, + "SpekeKeyProvider": { + "target": "com.amazonaws.mediapackage#SpekeKeyProvider", + "traits": { + "smithy.api#jsonName": "spekeKeyProvider", + "smithy.api#required": {} + } } }, "traits": { @@ -1512,18 +1692,11 @@ "com.amazonaws.mediapackage#HlsManifest": { "type": "structure", "members": { - "IncludeIframeOnlyStream": { - "target": "com.amazonaws.mediapackage#__boolean", - "traits": { - "smithy.api#documentation": "When enabled, an I-Frame only stream will be included in the output.", - "smithy.api#jsonName": "includeIframeOnlyStream" - } - }, - "ManifestName": { - "target": "com.amazonaws.mediapackage#__string", + "ProgramDateTimeIntervalSeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", - "smithy.api#jsonName": "manifestName" + "smithy.api#documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.", + "smithy.api#jsonName": "programDateTimeIntervalSeconds" } }, "Url": { @@ -1533,13 +1706,6 @@ "smithy.api#jsonName": "url" } }, - "PlaylistWindowSeconds": { - "target": "com.amazonaws.mediapackage#__integer", - "traits": { - "smithy.api#documentation": "Time window (in seconds) contained in each parent manifest.", - "smithy.api#jsonName": "playlistWindowSeconds" - } - }, "PlaylistType": { "target": "com.amazonaws.mediapackage#PlaylistType", "traits": { @@ -1547,18 +1713,25 @@ "smithy.api#jsonName": "playlistType" } }, - "ProgramDateTimeIntervalSeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "ManifestName": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.", - "smithy.api#jsonName": "programDateTimeIntervalSeconds" + "smithy.api#documentation": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", + "smithy.api#jsonName": "manifestName" } }, - "AdMarkers": { - "target": "com.amazonaws.mediapackage#AdMarkers", + "IncludeIframeOnlyStream": { + "target": "com.amazonaws.mediapackage#__boolean", "traits": { - "smithy.api#documentation": "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.", - "smithy.api#jsonName": "adMarkers" + "smithy.api#documentation": "When enabled, an I-Frame only stream will be included in the output.", + "smithy.api#jsonName": "includeIframeOnlyStream" + } + }, + "PlaylistWindowSeconds": { + "target": "com.amazonaws.mediapackage#__integer", + "traits": { + "smithy.api#documentation": "Time window (in seconds) contained in each parent manifest.", + "smithy.api#jsonName": "playlistWindowSeconds" } }, "Id": { @@ -1568,6 +1741,13 @@ "smithy.api#jsonName": "id", "smithy.api#required": {} } + }, + "AdMarkers": { + "target": "com.amazonaws.mediapackage#AdMarkers", + "traits": { + "smithy.api#documentation": "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.", + "smithy.api#jsonName": "adMarkers" + } } }, "traits": { @@ -1577,17 +1757,10 @@ "com.amazonaws.mediapackage#HlsManifestCreateOrUpdateParameters": { "type": "structure", "members": { - "AdTriggers": { - "target": "com.amazonaws.mediapackage#AdTriggers", - "traits": { - "smithy.api#jsonName": "adTriggers" - } - }, - "IncludeIframeOnlyStream": { - "target": "com.amazonaws.mediapackage#__boolean", + "AdsOnDeliveryRestrictions": { + "target": "com.amazonaws.mediapackage#AdsOnDeliveryRestrictions", "traits": { - "smithy.api#documentation": "When enabled, an I-Frame only stream will be included in the output.", - "smithy.api#jsonName": "includeIframeOnlyStream" + "smithy.api#jsonName": "adsOnDeliveryRestrictions" } }, "ProgramDateTimeIntervalSeconds": { @@ -1597,12 +1770,11 @@ "smithy.api#jsonName": "programDateTimeIntervalSeconds" } }, - "Id": { - "target": "com.amazonaws.mediapackage#__string", + "PlaylistWindowSeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.", - "smithy.api#jsonName": "id", - "smithy.api#required": {} + "smithy.api#documentation": "Time window (in seconds) contained in each parent manifest.", + "smithy.api#jsonName": "playlistWindowSeconds" } }, "PlaylistType": { @@ -1612,6 +1784,14 @@ "smithy.api#jsonName": "playlistType" } }, + "Id": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, "AdMarkers": { "target": "com.amazonaws.mediapackage#AdMarkers", "traits": { @@ -1619,52 +1799,45 @@ "smithy.api#jsonName": "adMarkers" } }, - "ManifestName": { - "target": "com.amazonaws.mediapackage#__string", + "IncludeIframeOnlyStream": { + "target": "com.amazonaws.mediapackage#__boolean", "traits": { - "smithy.api#documentation": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", - "smithy.api#jsonName": "manifestName" + "smithy.api#documentation": "When enabled, an I-Frame only stream will be included in the output.", + "smithy.api#jsonName": "includeIframeOnlyStream" } }, - "PlaylistWindowSeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "AdTriggers": { + "target": "com.amazonaws.mediapackage#AdTriggers", "traits": { - "smithy.api#documentation": "Time window (in seconds) contained in each parent manifest.", - "smithy.api#jsonName": "playlistWindowSeconds" + "smithy.api#jsonName": "adTriggers" } }, - "AdsOnDeliveryRestrictions": { - "target": "com.amazonaws.mediapackage#AdsOnDeliveryRestrictions", + "ManifestName": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "adsOnDeliveryRestrictions" + "smithy.api#documentation": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", + "smithy.api#jsonName": "manifestName" } } }, "traits": { - "smithy.api#documentation": "A HTTP Live Streaming (HLS) manifest configuration." - } - }, - "com.amazonaws.mediapackage#HlsPackage": { - "type": "structure", - "members": { - "PlaylistType": { - "target": "com.amazonaws.mediapackage#PlaylistType", - "traits": { - "smithy.api#documentation": "The HTTP Live Streaming (HLS) playlist type.\nWhen either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE\nentry will be included in the media playlist.", - "smithy.api#jsonName": "playlistType" - } - }, - "AdTriggers": { - "target": "com.amazonaws.mediapackage#AdTriggers", + "smithy.api#documentation": "A HTTP Live Streaming (HLS) manifest configuration." + } + }, + "com.amazonaws.mediapackage#HlsPackage": { + "type": "structure", + "members": { + "StreamSelection": { + "target": "com.amazonaws.mediapackage#StreamSelection", "traits": { - "smithy.api#jsonName": "adTriggers" + "smithy.api#jsonName": "streamSelection" } }, - "ProgramDateTimeIntervalSeconds": { + "PlaylistWindowSeconds": { "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.", - "smithy.api#jsonName": "programDateTimeIntervalSeconds" + "smithy.api#documentation": "Time window (in seconds) contained in each parent manifest.", + "smithy.api#jsonName": "playlistWindowSeconds" } }, "UseAudioRenditionGroup": { @@ -1681,10 +1854,11 @@ "smithy.api#jsonName": "includeIframeOnlyStream" } }, - "Encryption": { - "target": "com.amazonaws.mediapackage#HlsEncryption", + "ProgramDateTimeIntervalSeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.", + "smithy.api#jsonName": "programDateTimeIntervalSeconds" } }, "SegmentDurationSeconds": { @@ -1701,17 +1875,23 @@ "smithy.api#jsonName": "adMarkers" } }, - "PlaylistWindowSeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "AdTriggers": { + "target": "com.amazonaws.mediapackage#AdTriggers", "traits": { - "smithy.api#documentation": "Time window (in seconds) contained in each parent manifest.", - "smithy.api#jsonName": "playlistWindowSeconds" + "smithy.api#jsonName": "adTriggers" } }, - "StreamSelection": { - "target": "com.amazonaws.mediapackage#StreamSelection", + "PlaylistType": { + "target": "com.amazonaws.mediapackage#PlaylistType", "traits": { - "smithy.api#jsonName": "streamSelection" + "smithy.api#documentation": "The HTTP Live Streaming (HLS) playlist type.\nWhen either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE\nentry will be included in the media playlist.", + "smithy.api#jsonName": "playlistType" + } + }, + "Encryption": { + "target": "com.amazonaws.mediapackage#HlsEncryption", + "traits": { + "smithy.api#jsonName": "encryption" } }, "AdsOnDeliveryRestrictions": { @@ -1728,32 +1908,32 @@ "com.amazonaws.mediapackage#IngestEndpoint": { "type": "structure", "members": { - "Password": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The system generated password for ingest authentication.", - "smithy.api#jsonName": "password" + "smithy.api#documentation": "The system generated unique identifier for the IngestEndpoint", + "smithy.api#jsonName": "id" } }, - "Username": { + "Url": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The system generated username for ingest authentication.", - "smithy.api#jsonName": "username" + "smithy.api#documentation": "The ingest URL to which the source stream should be sent.", + "smithy.api#jsonName": "url" } }, - "Id": { + "Password": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The system generated unique identifier for the IngestEndpoint", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The system generated password for ingest authentication.", + "smithy.api#jsonName": "password" } }, - "Url": { + "Username": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ingest URL to which the source stream should be sent.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "The system generated username for ingest authentication.", + "smithy.api#jsonName": "username" } } }, @@ -1761,6 +1941,21 @@ "smithy.api#documentation": "An endpoint for ingesting source content for a Channel." } }, + "com.amazonaws.mediapackage#IngressAccessLogs": { + "type": "structure", + "members": { + "LogGroupName": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "Customize the log group name.", + "smithy.api#jsonName": "logGroupName" + } + } + }, + "traits": { + "smithy.api#documentation": "Configure ingress access logging." + } + }, "com.amazonaws.mediapackage#InternalServerErrorException": { "type": "structure", "members": { @@ -1811,6 +2006,12 @@ "method": "GET", "uri": "/channels", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Channels", + "pageSize": "MaxResults" } } }, @@ -1886,17 +2087,23 @@ "method": "GET", "uri": "/harvest_jobs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HarvestJobs", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediapackage#ListHarvestJobsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.mediapackage#MaxResults", + "NextToken": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The upper bound on the number of records to return.", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "A token used to resume pagination from the end of a previous request.", + "smithy.api#httpQuery": "nextToken" } }, "IncludeStatus": { @@ -1906,11 +2113,11 @@ "smithy.api#httpQuery": "includeStatus" } }, - "NextToken": { - "target": "com.amazonaws.mediapackage#__string", + "MaxResults": { + "target": "com.amazonaws.mediapackage#MaxResults", "traits": { - "smithy.api#documentation": "A token used to resume pagination from the end of a previous request.", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The upper bound on the number of records to return.", + "smithy.api#httpQuery": "maxResults" } }, "IncludeChannelId": { @@ -1975,17 +2182,23 @@ "method": "GET", "uri": "/origin_endpoints", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OriginEndpoints", + "pageSize": "MaxResults" } } }, "com.amazonaws.mediapackage#ListOriginEndpointsRequest": { "type": "structure", "members": { - "ChannelId": { + "NextToken": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "When specified, the request will return only OriginEndpoints associated with the given Channel ID.", - "smithy.api#httpQuery": "channelId" + "smithy.api#documentation": "A token used to resume pagination from the end of a previous request.", + "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { @@ -1995,11 +2208,11 @@ "smithy.api#httpQuery": "maxResults" } }, - "NextToken": { + "ChannelId": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A token used to resume pagination from the end of a previous request.", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "When specified, the request will return only OriginEndpoints associated with the given Channel ID.", + "smithy.api#httpQuery": "channelId" } } } @@ -2090,6 +2303,9 @@ "type": "service", "version": "2017-10-12", "operations": [ + { + "target": "com.amazonaws.mediapackage#ConfigureLogs" + }, { "target": "com.amazonaws.mediapackage#CreateChannel" }, @@ -2178,11 +2394,17 @@ "com.amazonaws.mediapackage#MssPackage": { "type": "structure", "members": { - "ManifestWindowSeconds": { + "StreamSelection": { + "target": "com.amazonaws.mediapackage#StreamSelection", + "traits": { + "smithy.api#jsonName": "streamSelection" + } + }, + "SegmentDurationSeconds": { "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The time window (in seconds) contained in each manifest.", - "smithy.api#jsonName": "manifestWindowSeconds" + "smithy.api#documentation": "The duration (in seconds) of each segment.", + "smithy.api#jsonName": "segmentDurationSeconds" } }, "Encryption": { @@ -2191,17 +2413,11 @@ "smithy.api#jsonName": "encryption" } }, - "StreamSelection": { - "target": "com.amazonaws.mediapackage#StreamSelection", - "traits": { - "smithy.api#jsonName": "streamSelection" - } - }, - "SegmentDurationSeconds": { + "ManifestWindowSeconds": { "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The duration (in seconds) of each segment.", - "smithy.api#jsonName": "segmentDurationSeconds" + "smithy.api#documentation": "The time window (in seconds) contained in each manifest.", + "smithy.api#jsonName": "manifestWindowSeconds" } } }, @@ -2228,17 +2444,10 @@ "com.amazonaws.mediapackage#OriginEndpoint": { "type": "structure", "members": { - "Url": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "The URL of the packaged OriginEndpoint for consumption.", - "smithy.api#jsonName": "url" - } - }, - "DashPackage": { - "target": "com.amazonaws.mediapackage#DashPackage", + "CmafPackage": { + "target": "com.amazonaws.mediapackage#CmafPackage", "traits": { - "smithy.api#jsonName": "dashPackage" + "smithy.api#jsonName": "cmafPackage" } }, "ManifestName": { @@ -2248,10 +2457,10 @@ "smithy.api#jsonName": "manifestName" } }, - "HlsPackage": { - "target": "com.amazonaws.mediapackage#HlsPackage", + "Authorization": { + "target": "com.amazonaws.mediapackage#Authorization", "traits": { - "smithy.api#jsonName": "hlsPackage" + "smithy.api#jsonName": "authorization" } }, "StartoverWindowSeconds": { @@ -2261,24 +2470,11 @@ "smithy.api#jsonName": "startoverWindowSeconds" } }, - "Authorization": { - "target": "com.amazonaws.mediapackage#Authorization", - "traits": { - "smithy.api#jsonName": "authorization" - } - }, - "Origination": { - "target": "com.amazonaws.mediapackage#Origination", - "traits": { - "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", - "smithy.api#jsonName": "origination" - } - }, - "ChannelId": { + "Url": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", - "smithy.api#jsonName": "channelId" + "smithy.api#documentation": "The URL of the packaged OriginEndpoint for consumption.", + "smithy.api#jsonName": "url" } }, "Tags": { @@ -2287,17 +2483,24 @@ "smithy.api#jsonName": "tags" } }, - "Id": { - "target": "com.amazonaws.mediapackage#__string", + "HlsPackage": { + "target": "com.amazonaws.mediapackage#HlsPackage", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint.", - "smithy.api#jsonName": "id" + "smithy.api#jsonName": "hlsPackage" } }, - "CmafPackage": { - "target": "com.amazonaws.mediapackage#CmafPackage", + "Whitelist": { + "target": "com.amazonaws.mediapackage#__listOf__string", "traits": { - "smithy.api#jsonName": "cmafPackage" + "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "smithy.api#jsonName": "whitelist" + } + }, + "TimeDelaySeconds": { + "target": "com.amazonaws.mediapackage#__integer", + "traits": { + "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", + "smithy.api#jsonName": "timeDelaySeconds" } }, "MssPackage": { @@ -2306,6 +2509,13 @@ "smithy.api#jsonName": "mssPackage" } }, + "ChannelId": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "smithy.api#jsonName": "channelId" + } + }, "Description": { "target": "com.amazonaws.mediapackage#__string", "traits": { @@ -2313,6 +2523,13 @@ "smithy.api#jsonName": "description" } }, + "Origination": { + "target": "com.amazonaws.mediapackage#Origination", + "traits": { + "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", + "smithy.api#jsonName": "origination" + } + }, "Arn": { "target": "com.amazonaws.mediapackage#__string", "traits": { @@ -2320,18 +2537,17 @@ "smithy.api#jsonName": "arn" } }, - "Whitelist": { - "target": "com.amazonaws.mediapackage#__listOf__string", + "Id": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", - "smithy.api#jsonName": "whitelist" + "smithy.api#documentation": "The ID of the OriginEndpoint.", + "smithy.api#jsonName": "id" } }, - "TimeDelaySeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "DashPackage": { + "target": "com.amazonaws.mediapackage#DashPackage", "traits": { - "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", - "smithy.api#jsonName": "timeDelaySeconds" + "smithy.api#jsonName": "dashPackage" } } }, @@ -2447,6 +2663,13 @@ "com.amazonaws.mediapackage#RotateChannelCredentialsResponse": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The ID of the Channel.", + "smithy.api#jsonName": "id" + } + }, "Description": { "target": "com.amazonaws.mediapackage#__string", "traits": { @@ -2454,11 +2677,16 @@ "smithy.api#jsonName": "description" } }, - "Id": { - "target": "com.amazonaws.mediapackage#__string", + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", "traits": { - "smithy.api#documentation": "The ID of the Channel.", - "smithy.api#jsonName": "id" + "smithy.api#jsonName": "ingressAccessLogs" + } + }, + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", + "traits": { + "smithy.api#jsonName": "egressAccessLogs" } }, "Tags": { @@ -2525,18 +2753,18 @@ "com.amazonaws.mediapackage#RotateIngestEndpointCredentialsRequest": { "type": "structure", "members": { - "Id": { + "IngestEndpointId": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The ID of the channel the IngestEndpoint is on.", + "smithy.api#documentation": "The id of the IngestEndpoint whose credentials should be rotated", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "IngestEndpointId": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The id of the IngestEndpoint whose credentials should be rotated", + "smithy.api#documentation": "The ID of the channel the IngestEndpoint is on.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2546,18 +2774,26 @@ "com.amazonaws.mediapackage#RotateIngestEndpointCredentialsResponse": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "A short text description of the Channel.", + "smithy.api#jsonName": "description" + } + }, + "Id": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The ID of the Channel.", + "smithy.api#jsonName": "id" + } + }, "HlsIngest": { "target": "com.amazonaws.mediapackage#HlsIngest", "traits": { "smithy.api#jsonName": "hlsIngest" } }, - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", - "traits": { - "smithy.api#jsonName": "tags" - } - }, "Arn": { "target": "com.amazonaws.mediapackage#__string", "traits": { @@ -2565,18 +2801,22 @@ "smithy.api#jsonName": "arn" } }, - "Description": { - "target": "com.amazonaws.mediapackage#__string", + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", "traits": { - "smithy.api#documentation": "A short text description of the Channel.", - "smithy.api#jsonName": "description" + "smithy.api#jsonName": "tags" } }, - "Id": { - "target": "com.amazonaws.mediapackage#__string", + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", "traits": { - "smithy.api#documentation": "The ID of the Channel.", - "smithy.api#jsonName": "id" + "smithy.api#jsonName": "egressAccessLogs" + } + }, + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", + "traits": { + "smithy.api#jsonName": "ingressAccessLogs" } } } @@ -2667,12 +2907,11 @@ "smithy.api#required": {} } }, - "Url": { + "CertificateArn": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "The URL of the external key provider service.", - "smithy.api#jsonName": "url", - "smithy.api#required": {} + "smithy.api#documentation": "An Amazon Resource Name (ARN) of a Certificate Manager certificate\nthat MediaPackage will use for enforcing secure end-to-end data\ntransfer with the key provider service.", + "smithy.api#jsonName": "certificateArn" } }, "RoleArn": { @@ -2683,11 +2922,12 @@ "smithy.api#required": {} } }, - "CertificateArn": { + "Url": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "An Amazon Resource Name (ARN) of a Certificate Manager certificate\nthat MediaPackage will use for enforcing secure end-to-end data\ntransfer with the key provider service.", - "smithy.api#jsonName": "certificateArn" + "smithy.api#documentation": "The URL of the external key provider service.", + "smithy.api#jsonName": "url", + "smithy.api#required": {} } } }, @@ -2736,11 +2976,11 @@ "com.amazonaws.mediapackage#StreamSelection": { "type": "structure", "members": { - "MinVideoBitsPerSecond": { + "MaxVideoBitsPerSecond": { "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The minimum video bitrate (bps) to include in output.", - "smithy.api#jsonName": "minVideoBitsPerSecond" + "smithy.api#documentation": "The maximum video bitrate (bps) to include in output.", + "smithy.api#jsonName": "maxVideoBitsPerSecond" } }, "StreamOrder": { @@ -2750,11 +2990,11 @@ "smithy.api#jsonName": "streamOrder" } }, - "MaxVideoBitsPerSecond": { + "MinVideoBitsPerSecond": { "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The maximum video bitrate (bps) to include in output.", - "smithy.api#jsonName": "maxVideoBitsPerSecond" + "smithy.api#documentation": "The minimum video bitrate (bps) to include in output.", + "smithy.api#jsonName": "minVideoBitsPerSecond" } } }, @@ -2934,6 +3174,18 @@ "com.amazonaws.mediapackage#UpdateChannelResponse": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.mediapackage#Tags", + "traits": { + "smithy.api#jsonName": "tags" + } + }, + "IngressAccessLogs": { + "target": "com.amazonaws.mediapackage#IngressAccessLogs", + "traits": { + "smithy.api#jsonName": "ingressAccessLogs" + } + }, "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { @@ -2941,10 +3193,10 @@ "smithy.api#jsonName": "id" } }, - "Tags": { - "target": "com.amazonaws.mediapackage#Tags", + "EgressAccessLogs": { + "target": "com.amazonaws.mediapackage#EgressAccessLogs", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "egressAccessLogs" } }, "Description": { @@ -3009,32 +3261,30 @@ "com.amazonaws.mediapackage#UpdateOriginEndpointRequest": { "type": "structure", "members": { - "Whitelist": { - "target": "com.amazonaws.mediapackage#__listOf__string", + "Description": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", - "smithy.api#jsonName": "whitelist" + "smithy.api#documentation": "A short text description of the OriginEndpoint.", + "smithy.api#jsonName": "description" } }, - "TimeDelaySeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "Origination": { + "target": "com.amazonaws.mediapackage#Origination", "traits": { - "smithy.api#documentation": "Amount of delay (in seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", - "smithy.api#jsonName": "timeDelaySeconds" + "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", + "smithy.api#jsonName": "origination" } }, - "CmafPackage": { - "target": "com.amazonaws.mediapackage#CmafPackageCreateOrUpdateParameters", + "HlsPackage": { + "target": "com.amazonaws.mediapackage#HlsPackage", "traits": { - "smithy.api#jsonName": "cmafPackage" + "smithy.api#jsonName": "hlsPackage" } }, - "Id": { - "target": "com.amazonaws.mediapackage#__string", + "DashPackage": { + "target": "com.amazonaws.mediapackage#DashPackage", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint to update.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#jsonName": "dashPackage" } }, "MssPackage": { @@ -3043,24 +3293,32 @@ "smithy.api#jsonName": "mssPackage" } }, - "Description": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A short text description of the OriginEndpoint.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The ID of the OriginEndpoint to update.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "DashPackage": { - "target": "com.amazonaws.mediapackage#DashPackage", + "Whitelist": { + "target": "com.amazonaws.mediapackage#__listOf__string", "traits": { - "smithy.api#jsonName": "dashPackage" + "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "smithy.api#jsonName": "whitelist" } }, - "StartoverWindowSeconds": { + "TimeDelaySeconds": { "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "Maximum duration (in seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", - "smithy.api#jsonName": "startoverWindowSeconds" + "smithy.api#documentation": "Amount of delay (in seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", + "smithy.api#jsonName": "timeDelaySeconds" + } + }, + "CmafPackage": { + "target": "com.amazonaws.mediapackage#CmafPackageCreateOrUpdateParameters", + "traits": { + "smithy.api#jsonName": "cmafPackage" } }, "ManifestName": { @@ -3070,24 +3328,18 @@ "smithy.api#jsonName": "manifestName" } }, - "HlsPackage": { - "target": "com.amazonaws.mediapackage#HlsPackage", - "traits": { - "smithy.api#jsonName": "hlsPackage" - } - }, - "Origination": { - "target": "com.amazonaws.mediapackage#Origination", - "traits": { - "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", - "smithy.api#jsonName": "origination" - } - }, "Authorization": { "target": "com.amazonaws.mediapackage#Authorization", "traits": { "smithy.api#jsonName": "authorization" } + }, + "StartoverWindowSeconds": { + "target": "com.amazonaws.mediapackage#__integer", + "traits": { + "smithy.api#documentation": "Maximum duration (in seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", + "smithy.api#jsonName": "startoverWindowSeconds" + } } }, "traits": { @@ -3097,24 +3349,17 @@ "com.amazonaws.mediapackage#UpdateOriginEndpointResponse": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.mediapackage#__string", - "traits": { - "smithy.api#documentation": "A short text description of the OriginEndpoint.", - "smithy.api#jsonName": "description" - } - }, - "MssPackage": { - "target": "com.amazonaws.mediapackage#MssPackage", + "DashPackage": { + "target": "com.amazonaws.mediapackage#DashPackage", "traits": { - "smithy.api#jsonName": "mssPackage" + "smithy.api#jsonName": "dashPackage" } }, - "Id": { - "target": "com.amazonaws.mediapackage#__string", + "TimeDelaySeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "The ID of the OriginEndpoint.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", + "smithy.api#jsonName": "timeDelaySeconds" } }, "Arn": { @@ -3124,24 +3369,17 @@ "smithy.api#jsonName": "arn" } }, - "TimeDelaySeconds": { - "target": "com.amazonaws.mediapackage#__integer", - "traits": { - "smithy.api#documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.", - "smithy.api#jsonName": "timeDelaySeconds" - } - }, - "CmafPackage": { - "target": "com.amazonaws.mediapackage#CmafPackage", + "HlsPackage": { + "target": "com.amazonaws.mediapackage#HlsPackage", "traits": { - "smithy.api#jsonName": "cmafPackage" + "smithy.api#jsonName": "hlsPackage" } }, - "Url": { - "target": "com.amazonaws.mediapackage#__string", + "Whitelist": { + "target": "com.amazonaws.mediapackage#__listOf__string", "traits": { - "smithy.api#documentation": "The URL of the packaged OriginEndpoint for consumption.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "smithy.api#jsonName": "whitelist" } }, "Authorization": { @@ -3150,24 +3388,24 @@ "smithy.api#jsonName": "authorization" } }, - "HlsPackage": { - "target": "com.amazonaws.mediapackage#HlsPackage", + "ManifestName": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#jsonName": "hlsPackage" + "smithy.api#documentation": "A short string appended to the end of the OriginEndpoint URL.", + "smithy.api#jsonName": "manifestName" } }, - "ChannelId": { - "target": "com.amazonaws.mediapackage#__string", + "CmafPackage": { + "target": "com.amazonaws.mediapackage#CmafPackage", "traits": { - "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", - "smithy.api#jsonName": "channelId" + "smithy.api#jsonName": "cmafPackage" } }, - "Origination": { - "target": "com.amazonaws.mediapackage#Origination", + "StartoverWindowSeconds": { + "target": "com.amazonaws.mediapackage#__integer", "traits": { - "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", - "smithy.api#jsonName": "origination" + "smithy.api#documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", + "smithy.api#jsonName": "startoverWindowSeconds" } }, "Tags": { @@ -3176,35 +3414,68 @@ "smithy.api#jsonName": "tags" } }, - "StartoverWindowSeconds": { - "target": "com.amazonaws.mediapackage#__integer", + "Description": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.", - "smithy.api#jsonName": "startoverWindowSeconds" + "smithy.api#documentation": "A short text description of the OriginEndpoint.", + "smithy.api#jsonName": "description" } }, - "DashPackage": { - "target": "com.amazonaws.mediapackage#DashPackage", + "Origination": { + "target": "com.amazonaws.mediapackage#Origination", "traits": { - "smithy.api#jsonName": "dashPackage" + "smithy.api#documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination", + "smithy.api#jsonName": "origination" } }, - "ManifestName": { + "Id": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A short string appended to the end of the OriginEndpoint URL.", - "smithy.api#jsonName": "manifestName" + "smithy.api#documentation": "The ID of the OriginEndpoint.", + "smithy.api#jsonName": "id" } }, - "Whitelist": { - "target": "com.amazonaws.mediapackage#__listOf__string", + "ChannelId": { + "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", - "smithy.api#jsonName": "whitelist" + "smithy.api#documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "smithy.api#jsonName": "channelId" + } + }, + "Url": { + "target": "com.amazonaws.mediapackage#__string", + "traits": { + "smithy.api#documentation": "The URL of the packaged OriginEndpoint for consumption.", + "smithy.api#jsonName": "url" + } + }, + "MssPackage": { + "target": "com.amazonaws.mediapackage#MssPackage", + "traits": { + "smithy.api#jsonName": "mssPackage" } } } }, + "com.amazonaws.mediapackage#UtcTiming": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "HTTP-HEAD", + "name": "HTTP_HEAD" + }, + { + "value": "HTTP-ISO", + "name": "HTTP_ISO" + } + ] + } + }, "com.amazonaws.mediapackage#__AdTriggersElement": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/mediastore-data.2017-09-01.json b/codegen/sdk-codegen/aws-models/mediastore-data.2017-09-01.json index e38587a607e2..4d3c80d43da8 100644 --- a/codegen/sdk-codegen/aws-models/mediastore-data.2017-09-01.json +++ b/codegen/sdk-codegen/aws-models/mediastore-data.2017-09-01.json @@ -254,11 +254,11 @@ "com.amazonaws.mediastoredata#GetObjectResponse": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.mediastoredata#ContentType", + "CacheControl": { + "target": "com.amazonaws.mediastoredata#StringPrimitive", "traits": { - "smithy.api#documentation": "

The content type of the object.

", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

An optional CacheControl header that allows the caller to control the\n object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

\n

Headers with a custom user-defined value are also accepted.

", + "smithy.api#httpHeader": "Cache-Control" } }, "ContentLength": { @@ -268,11 +268,11 @@ "smithy.api#httpHeader": "Content-Length" } }, - "CacheControl": { - "target": "com.amazonaws.mediastoredata#StringPrimitive", + "ContentType": { + "target": "com.amazonaws.mediastoredata#ContentType", "traits": { - "smithy.api#documentation": "

An optional CacheControl header that allows the caller to control the\n object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

\n

Headers with a custom user-defined value are also accepted.

", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "

The content type of the object.

", + "smithy.api#httpHeader": "Content-Type" } }, "ContentRange": { @@ -282,6 +282,13 @@ "smithy.api#httpHeader": "Content-Range" } }, + "LastModified": { + "target": "com.amazonaws.mediastoredata#TimeStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the object was last modified.

", + "smithy.api#httpHeader": "Last-Modified" + } + }, "ETag": { "target": "com.amazonaws.mediastoredata#ETag", "traits": { @@ -289,11 +296,12 @@ "smithy.api#httpHeader": "ETag" } }, - "LastModified": { - "target": "com.amazonaws.mediastoredata#TimeStamp", + "StatusCode": { + "target": "com.amazonaws.mediastoredata#statusCode", "traits": { - "smithy.api#documentation": "

The date and time that the object was last modified.

", - "smithy.api#httpHeader": "Last-Modified" + "smithy.api#documentation": "

The HTML status code of the request. Status codes ranging from 200 to 299 indicate\n success. All other status codes indicate the type of error that occurred.

", + "smithy.api#httpResponseCode": {}, + "smithy.api#required": {} } }, "Body": { @@ -320,6 +328,12 @@ "com.amazonaws.mediastoredata#Item": { "type": "structure", "members": { + "ETag": { + "target": "com.amazonaws.mediastoredata#ETag", + "traits": { + "smithy.api#documentation": "

The ETag that represents a unique instance of the item.

" + } + }, "Name": { "target": "com.amazonaws.mediastoredata#ItemName", "traits": { @@ -338,12 +352,6 @@ "smithy.api#documentation": "

The length of the item in bytes.

" } }, - "ETag": { - "target": "com.amazonaws.mediastoredata#ETag", - "traits": { - "smithy.api#documentation": "

The ETag that represents a unique instance of the item.

" - } - }, "ContentType": { "target": "com.amazonaws.mediastoredata#ContentType", "traits": { @@ -501,7 +509,7 @@ "sdkId": "MediaStore Data", "arnNamespace": "mediastore", "cloudFormationName": "MediaStoreData", - "cloudTrailEventSource": "object.mediastore.amazonaws.com" + "cloudTrailEventSource": "mediastoredata.amazonaws.com" }, "aws.auth#sigv4": { "name": "mediastore" @@ -585,6 +593,14 @@ "com.amazonaws.mediastoredata#PutObjectRequest": { "type": "structure", "members": { + "Path": { + "target": "com.amazonaws.mediastoredata#PathNaming", + "traits": { + "smithy.api#documentation": "

The path (including the file name) where the object is stored in the container.\n Format: //

\n

For example, to upload the file mlaw.avi to the folder path\n premium\\canada in the container movies, enter the path\n premium/canada/mlaw.avi.

\n

Do not include the container name in this path.

\n

If the path includes any folders that don't exist yet, the service creates them. For\n example, suppose you have an existing premium/usa subfolder. If you specify\n premium/canada, the service creates a canada subfolder in the\n premium folder. You then have two subfolders, usa and\n canada, in the premium folder.

\n

There is no correlation between the path to the source and the path (folders) in the\n container in AWS Elemental MediaStore.

\n

For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User\n Guide.

\n

The file name is the name that is assigned to the file that you upload. The file can\n have the same name inside and outside of AWS Elemental MediaStore, or it can have the same\n name. The file name can include or omit an extension.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "StorageClass": { "target": "com.amazonaws.mediastoredata#StorageClass", "traits": { @@ -592,13 +608,6 @@ "smithy.api#httpHeader": "x-amz-storage-class" } }, - "CacheControl": { - "target": "com.amazonaws.mediastoredata#StringPrimitive", - "traits": { - "smithy.api#documentation": "

An optional CacheControl header that allows the caller to control the\n object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

\n

Headers with a custom user-defined value are also accepted.

", - "smithy.api#httpHeader": "Cache-Control" - } - }, "ContentType": { "target": "com.amazonaws.mediastoredata#ContentType", "traits": { @@ -606,12 +615,11 @@ "smithy.api#httpHeader": "Content-Type" } }, - "Path": { - "target": "com.amazonaws.mediastoredata#PathNaming", + "CacheControl": { + "target": "com.amazonaws.mediastoredata#StringPrimitive", "traits": { - "smithy.api#documentation": "

The path (including the file name) where the object is stored in the container.\n Format: //

\n

For example, to upload the file mlaw.avi to the folder path\n premium\\canada in the container movies, enter the path\n premium/canada/mlaw.avi.

\n

Do not include the container name in this path.

\n

If the path includes any folders that don't exist yet, the service creates them. For\n example, suppose you have an existing premium/usa subfolder. If you specify\n premium/canada, the service creates a canada subfolder in the\n premium folder. You then have two subfolders, usa and\n canada, in the premium folder.

\n

There is no correlation between the path to the source and the path (folders) in the\n container in AWS Elemental MediaStore.

\n

For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User\n Guide.

\n

The file name is the name that is assigned to the file that you upload. The file can\n have the same name inside and outside of AWS Elemental MediaStore, or it can have the same\n name. The file name can include or omit an extension.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

An optional CacheControl header that allows the caller to control the\n object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

\n

Headers with a custom user-defined value are also accepted.

", + "smithy.api#httpHeader": "Cache-Control" } }, "Body": { @@ -627,10 +635,10 @@ "com.amazonaws.mediastoredata#PutObjectResponse": { "type": "structure", "members": { - "ETag": { - "target": "com.amazonaws.mediastoredata#ETag", + "StorageClass": { + "target": "com.amazonaws.mediastoredata#StorageClass", "traits": { - "smithy.api#documentation": "

Unique identifier of the object in the container.

" + "smithy.api#documentation": "

The storage class where the object was persisted. The class should be\n “Temporal”.

" } }, "ContentSHA256": { @@ -639,10 +647,10 @@ "smithy.api#documentation": "

The SHA256 digest of the object that is persisted.

" } }, - "StorageClass": { - "target": "com.amazonaws.mediastoredata#StorageClass", + "ETag": { + "target": "com.amazonaws.mediastoredata#ETag", "traits": { - "smithy.api#documentation": "

The storage class where the object was persisted. The class should be\n “Temporal”.

" + "smithy.api#documentation": "

Unique identifier of the object in the container.

" } } } @@ -696,6 +704,9 @@ }, "com.amazonaws.mediastoredata#TimeStamp": { "type": "timestamp" + }, + "com.amazonaws.mediastoredata#statusCode": { + "type": "integer" } } } diff --git a/codegen/sdk-codegen/aws-models/mediastore.2017-09-01.json b/codegen/sdk-codegen/aws-models/mediastore.2017-09-01.json index f7a71721e3e0..77c113891255 100644 --- a/codegen/sdk-codegen/aws-models/mediastore.2017-09-01.json +++ b/codegen/sdk-codegen/aws-models/mediastore.2017-09-01.json @@ -68,18 +68,18 @@ "com.amazonaws.mediastore#Container": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.mediastore#Endpoint", - "traits": { - "smithy.api#documentation": "

The DNS endpoint of the container. Use the endpoint to identify the specific\n container when sending requests to the data plane. The service assigns this value when the\n container is created. Once the value has been assigned, it does not change.

" - } - }, "ARN": { "target": "com.amazonaws.mediastore#ContainerARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container. The ARN has the following\n format:

\n

arn:aws:::container/

\n

For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

" } }, + "CreationTime": { + "target": "com.amazonaws.mediastore#TimeStamp", + "traits": { + "smithy.api#documentation": "

Unix timestamp.

" + } + }, "Status": { "target": "com.amazonaws.mediastore#ContainerStatus", "traits": { @@ -92,10 +92,10 @@ "smithy.api#documentation": "

The state of access logging on the container. This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true, indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

" } }, - "CreationTime": { - "target": "com.amazonaws.mediastore#TimeStamp", + "Endpoint": { + "target": "com.amazonaws.mediastore#Endpoint", "traits": { - "smithy.api#documentation": "

Unix timestamp.

" + "smithy.api#documentation": "

The DNS endpoint of the container. Use the endpoint to identify the specific\n container when sending requests to the data plane. The service assigns this value when the\n container is created. Once the value has been assigned, it does not change.

" } }, "Name": { @@ -251,10 +251,18 @@ "com.amazonaws.mediastore#CorsRule": { "type": "structure", "members": { - "ExposeHeaders": { - "target": "com.amazonaws.mediastore#ExposeHeaders", + "AllowedHeaders": { + "target": "com.amazonaws.mediastore#AllowedHeaders", "traits": { - "smithy.api#documentation": "

One or more headers in the response that you want users to be able to access from\n their applications (for example, from a JavaScript XMLHttpRequest\n object).

\n

This element is optional for each rule.

" + "smithy.api#documentation": "

Specifies which headers are allowed in a preflight OPTIONS request\n through the Access-Control-Request-Headers header. Each header name that is\n specified in Access-Control-Request-Headers must have a corresponding entry in\n the rule. Only the headers that were requested are sent back.

\n

This element can contain only one wildcard character (*).

", + "smithy.api#required": {} + } + }, + "AllowedOrigins": { + "target": "com.amazonaws.mediastore#AllowedOrigins", + "traits": { + "smithy.api#documentation": "

One or more response headers that you want users to be able to access from their\n applications (for example, from a JavaScript XMLHttpRequest object).

\n

Each CORS rule must have at least one AllowedOrigins element. The string\n value can include only one wildcard character (*), for example, http://*.example.com.\n Additionally, you can specify only one wildcard character to allow cross-origin access for\n all origins.

", + "smithy.api#required": {} } }, "AllowedMethods": { @@ -263,11 +271,10 @@ "smithy.api#documentation": "

Identifies an HTTP method that the origin that is specified in the rule is allowed to\n execute.

\n

Each CORS rule must contain at least one AllowedMethods and one\n AllowedOrigins element.

" } }, - "AllowedHeaders": { - "target": "com.amazonaws.mediastore#AllowedHeaders", + "ExposeHeaders": { + "target": "com.amazonaws.mediastore#ExposeHeaders", "traits": { - "smithy.api#documentation": "

Specifies which headers are allowed in a preflight OPTIONS request\n through the Access-Control-Request-Headers header. Each header name that is\n specified in Access-Control-Request-Headers must have a corresponding entry in\n the rule. Only the headers that were requested are sent back.

\n

This element can contain only one wildcard character (*).

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more headers in the response that you want users to be able to access from\n their applications (for example, from a JavaScript XMLHttpRequest\n object).

\n

This element is optional for each rule.

" } }, "MaxAgeSeconds": { @@ -275,13 +282,6 @@ "traits": { "smithy.api#documentation": "

The time in seconds that your browser caches the preflight response for the specified\n resource.

\n

A CORS rule can have only one MaxAgeSeconds element.

" } - }, - "AllowedOrigins": { - "target": "com.amazonaws.mediastore#AllowedOrigins", - "traits": { - "smithy.api#documentation": "

One or more response headers that you want users to be able to access from their\n applications (for example, from a JavaScript XMLHttpRequest object).

\n

Each CORS rule must have at least one AllowedOrigins element. The string\n value can include only one wildcard character (*), for example, http://*.example.com.\n Additionally, you can specify only one wildcard character to allow cross-origin access for\n all origins.

", - "smithy.api#required": {} - } } }, "traits": { @@ -891,17 +891,17 @@ "com.amazonaws.mediastore#ListContainersInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediastore#PaginationToken", - "traits": { - "smithy.api#documentation": "

Only if you used MaxResults in the first command, enter the token (which\n was included in the previous response) to obtain the next set of containers. This token is\n included in a response only if there actually are more containers to list.

" - } - }, "MaxResults": { "target": "com.amazonaws.mediastore#ContainerListLimit", "traits": { "smithy.api#documentation": "

Enter the maximum number of containers in the response. Use from 1 to 255 characters.\n

" } + }, + "NextToken": { + "target": "com.amazonaws.mediastore#PaginationToken", + "traits": { + "smithy.api#documentation": "

Only if you used MaxResults in the first command, enter the token (which\n was included in the previous response) to obtain the next set of containers. This token is\n included in a response only if there actually are more containers to list.

" + } } } }, @@ -1090,18 +1090,18 @@ "com.amazonaws.mediastore#MetricPolicy": { "type": "structure", "members": { - "MetricPolicyRules": { - "target": "com.amazonaws.mediastore#MetricPolicyRules", - "traits": { - "smithy.api#documentation": "

A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.

" - } - }, "ContainerLevelMetrics": { "target": "com.amazonaws.mediastore#ContainerLevelMetrics", "traits": { "smithy.api#documentation": "

A setting to enable or disable metrics at the container level.

", "smithy.api#required": {} } + }, + "MetricPolicyRules": { + "target": "com.amazonaws.mediastore#MetricPolicyRules", + "traits": { + "smithy.api#documentation": "

A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.

" + } } }, "traits": { @@ -1111,17 +1111,17 @@ "com.amazonaws.mediastore#MetricPolicyRule": { "type": "structure", "members": { - "ObjectGroup": { - "target": "com.amazonaws.mediastore#ObjectGroup", + "ObjectGroupName": { + "target": "com.amazonaws.mediastore#ObjectGroupName", "traits": { - "smithy.api#documentation": "

A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable.

", + "smithy.api#documentation": "

A name that allows you to refer to the object group.

", "smithy.api#required": {} } }, - "ObjectGroupName": { - "target": "com.amazonaws.mediastore#ObjectGroupName", + "ObjectGroup": { + "target": "com.amazonaws.mediastore#ObjectGroup", "traits": { - "smithy.api#documentation": "

A name that allows you to refer to the object group.

", + "smithy.api#documentation": "

A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable.

", "smithy.api#required": {} } } @@ -1220,17 +1220,17 @@ "com.amazonaws.mediastore#PutContainerPolicyInput": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.mediastore#ContainerPolicy", + "ContainerName": { + "target": "com.amazonaws.mediastore#ContainerName", "traits": { - "smithy.api#documentation": "

The contents of the policy, which includes the following:

\n
    \n
  • \n

    One Version tag

    \n
    • \n
  • \n

    One Statement tag that contains the standard tags for the\n policy.

    \n
    • \n
", + "smithy.api#documentation": "

The name of the container.

", "smithy.api#required": {} } }, - "ContainerName": { - "target": "com.amazonaws.mediastore#ContainerName", + "Policy": { + "target": "com.amazonaws.mediastore#ContainerPolicy", "traits": { - "smithy.api#documentation": "

The name of the container.

", + "smithy.api#documentation": "

The contents of the policy, which includes the following:

\n
    \n
  • \n

    One Version tag

    \n
    • \n
  • \n

    One Statement tag that contains the standard tags for the\n policy.

    \n
    • \n
", "smithy.api#required": {} } } @@ -1266,17 +1266,17 @@ "com.amazonaws.mediastore#PutCorsPolicyInput": { "type": "structure", "members": { - "CorsPolicy": { - "target": "com.amazonaws.mediastore#CorsPolicy", + "ContainerName": { + "target": "com.amazonaws.mediastore#ContainerName", "traits": { - "smithy.api#documentation": "

The CORS policy to apply to the container.

", + "smithy.api#documentation": "

The name of the container that you want to assign the CORS policy to.

", "smithy.api#required": {} } }, - "ContainerName": { - "target": "com.amazonaws.mediastore#ContainerName", + "CorsPolicy": { + "target": "com.amazonaws.mediastore#CorsPolicy", "traits": { - "smithy.api#documentation": "

The name of the container that you want to assign the CORS policy to.

", + "smithy.api#documentation": "

The CORS policy to apply to the container.

", "smithy.api#required": {} } } @@ -1358,17 +1358,17 @@ "com.amazonaws.mediastore#PutMetricPolicyInput": { "type": "structure", "members": { - "ContainerName": { - "target": "com.amazonaws.mediastore#ContainerName", + "MetricPolicy": { + "target": "com.amazonaws.mediastore#MetricPolicy", "traits": { - "smithy.api#documentation": "

The name of the container that you want to add the metric policy to.

", + "smithy.api#documentation": "

The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:

\n
    \n
  • \n

    An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can't have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.

    \n
    • \n
  • \n

    An object group name that allows you to refer to the object group. The name can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).

    \n
    • \n
", "smithy.api#required": {} } }, - "MetricPolicy": { - "target": "com.amazonaws.mediastore#MetricPolicy", + "ContainerName": { + "target": "com.amazonaws.mediastore#ContainerName", "traits": { - "smithy.api#documentation": "

The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:

\n
    \n
  • \n

    An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can't have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.

    \n
    • \n
  • \n

    An object group name that allows you to refer to the object group. The name can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).

    \n
    • \n
", + "smithy.api#documentation": "

The name of the container that you want to add the metric policy to.

", "smithy.api#required": {} } } @@ -1459,18 +1459,18 @@ "com.amazonaws.mediastore#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.mediastore#TagValue", - "traits": { - "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or\n \"companyB.\" Tag values are case-sensitive.

" - } - }, "Key": { "target": "com.amazonaws.mediastore#TagKey", "traits": { "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are\n case-sensitive.

", "smithy.api#required": {} } + }, + "Value": { + "target": "com.amazonaws.mediastore#TagValue", + "traits": { + "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or\n \"companyB.\" Tag values are case-sensitive.

" + } } }, "traits": { @@ -1590,17 +1590,17 @@ "com.amazonaws.mediastore#UntagResourceInput": { "type": "structure", "members": { - "Resource": { - "target": "com.amazonaws.mediastore#ContainerARN", + "TagKeys": { + "target": "com.amazonaws.mediastore#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the container.

", + "smithy.api#documentation": "

A comma-separated list of keys for tags that you want to remove from the container. For example, if your container has two tags (customer:CompanyA\n and priority:High) and you want to remove one of the tags (priority:High), you specify the key for the tag that you want to remove\n (priority).

", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.mediastore#TagKeyList", + "Resource": { + "target": "com.amazonaws.mediastore#ContainerARN", "traits": { - "smithy.api#documentation": "

A comma-separated list of keys for tags that you want to remove from the container. For example, if your container has two tags (customer:CompanyA\n and priority:High) and you want to remove one of the tags (priority:High), you specify the key for the tag that you want to remove\n (priority).

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the container.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json index ab40f56b01ff..218a5c03674e 100644 --- a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json +++ b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json @@ -32,17 +32,17 @@ "com.amazonaws.mediatailor#AvailSuppression": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The avail suppression value is a live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window." - } - }, "Mode": { "target": "com.amazonaws.mediatailor#Mode", "traits": { "smithy.api#documentation": "Sets the mode for avail suppression, also known as ad suppression. By default, ad suppression is off and all ad breaks are filled by MediaTailor with ads or slate." } + }, + "Value": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The avail suppression value is a live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window." + } } }, "traits": { @@ -65,16 +65,16 @@ "com.amazonaws.mediatailor#Bumper": { "type": "structure", "members": { - "EndUrl": { + "StartUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL for the end bumper asset.

" + "smithy.api#documentation": "

The URL for the start bumper asset.

" } }, - "StartUrl": { + "EndUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL for the start bumper asset.

" + "smithy.api#documentation": "

The URL for the end bumper asset.

" } } }, @@ -85,16 +85,16 @@ "com.amazonaws.mediatailor#CdnConfiguration": { "type": "structure", "members": { - "ContentSegmentUrlPrefix": { + "AdSegmentUrlPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

" + "smithy.api#documentation": "

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the following origin: ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

" } }, - "AdSegmentUrlPrefix": { + "ContentSegmentUrlPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the following origin: ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

" + "smithy.api#documentation": "

A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

" } } }, @@ -105,10 +105,10 @@ "com.amazonaws.mediatailor#DashConfiguration": { "type": "structure", "members": { - "ManifestEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", + "OriginManifestType": { + "target": "com.amazonaws.mediatailor#OriginManifestType", "traits": { - "smithy.api#documentation": "

The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

" + "smithy.api#documentation": "

The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

" } }, "MpdLocation": { @@ -117,10 +117,10 @@ "smithy.api#documentation": "

The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

" } }, - "OriginManifestType": { - "target": "com.amazonaws.mediatailor#OriginManifestType", + "ManifestEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

" + "smithy.api#documentation": "

The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

" } } }, @@ -215,22 +215,40 @@ "com.amazonaws.mediatailor#GetPlaybackConfigurationResponse": { "type": "structure", "members": { + "DashConfiguration": { + "target": "com.amazonaws.mediatailor#DashConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for DASH content.

" + } + }, "HlsConfiguration": { "target": "com.amazonaws.mediatailor#HlsConfiguration", "traits": { "smithy.api#documentation": "

The configuration for HLS content.

" } }, + "SlateAdUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

" + } + }, "VideoContentSourceUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

" } }, - "PlaybackConfigurationArn": { + "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

" + "smithy.api#documentation": "

The identifier for the playback configuration.

" + } + }, + "PlaybackEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

" } }, "LivePreRollConfiguration": { @@ -239,22 +257,22 @@ "smithy.api#documentation": "

The configuration for pre-roll ad insertion.

" } }, - "SessionInitializationEndpointPrefix": { + "PlaybackConfigurationArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

" } }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", + "CdnConfiguration": { + "target": "com.amazonaws.mediatailor#CdnConfiguration", "traits": { - "smithy.api#documentation": "

The identifier for the playback configuration.

" + "smithy.api#documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

" } }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", + "Bumper": { + "target": "com.amazonaws.mediatailor#Bumper", "traits": { - "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" + "smithy.api#documentation": "

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.

" } }, "PersonalizationThresholdSeconds": { @@ -263,22 +281,10 @@ "smithy.api#documentation": "

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

" } }, - "CdnConfiguration": { - "target": "com.amazonaws.mediatailor#CdnConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

" - } - }, - "PlaybackEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

" - } - }, - "SlateAdUrl": { + "AdDecisionServerUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

" + "smithy.api#documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" } }, "TranscodeProfileName": { @@ -287,12 +293,6 @@ "smithy.api#documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

" } }, - "DashConfiguration": { - "target": "com.amazonaws.mediatailor#DashConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for DASH content.

" - } - }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { @@ -300,16 +300,16 @@ "smithy.api#jsonName": "tags" } }, - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", "traits": { - "smithy.api#documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" + "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" } }, - "Bumper": { - "target": "com.amazonaws.mediatailor#Bumper", + "SessionInitializationEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.

" + "smithy.api#documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

" } } } @@ -367,17 +367,17 @@ "com.amazonaws.mediatailor#ListPlaybackConfigurationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

" - } - }, "Items": { "target": "com.amazonaws.mediatailor#__listOfPlaybackConfigurations", "traits": { "smithy.api#documentation": "

Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.

" } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

" + } } } }, @@ -431,17 +431,17 @@ "com.amazonaws.mediatailor#LivePreRollConfiguration": { "type": "structure", "members": { - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "

The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" - } - }, "MaxDurationSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns." } + }, + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" + } } }, "traits": { @@ -522,22 +522,10 @@ "com.amazonaws.mediatailor#PlaybackConfiguration": { "type": "structure", "members": { - "VideoContentSourceUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

" - } - }, - "HlsConfiguration": { - "target": "com.amazonaws.mediatailor#HlsConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for HLS content.

" - } - }, - "AdDecisionServerUrl": { + "SessionInitializationEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" + "smithy.api#documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

" } }, "DashConfiguration": { @@ -552,22 +540,29 @@ "smithy.api#documentation": "

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.

" } }, - "PlaybackConfigurationArn": { + "PlaybackEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

" + "smithy.api#documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

" } }, - "PersonalizationThresholdSeconds": { - "target": "com.amazonaws.mediatailor#__integerMin1", + "SlateAdUrl": { + "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

" + "smithy.api#documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

" } }, - "CdnConfiguration": { - "target": "com.amazonaws.mediatailor#CdnConfiguration", + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", "traits": { - "smithy.api#documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

" + "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags assigned to the playback configuration.

", + "smithy.api#jsonName": "tags" } }, "TranscodeProfileName": { @@ -576,41 +571,46 @@ "smithy.api#documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

" } }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" + "smithy.api#documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" } }, - "Name": { + "PlaybackConfigurationArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The identifier for the playback configuration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

" } }, - "SlateAdUrl": { - "target": "com.amazonaws.mediatailor#__string", + "PersonalizationThresholdSeconds": { + "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { - "smithy.api#documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

" + "smithy.api#documentation": "

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

" } }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", + "CdnConfiguration": { + "target": "com.amazonaws.mediatailor#CdnConfiguration", "traits": { - "smithy.api#documentation": "

The tags assigned to the playback configuration.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

" } }, - "PlaybackEndpointPrefix": { + "HlsConfiguration": { + "target": "com.amazonaws.mediatailor#HlsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for HLS content.

" + } + }, + "VideoContentSourceUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

" + "smithy.api#documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

" } }, - "SessionInitializationEndpointPrefix": { + "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

" + "smithy.api#documentation": "

The identifier for the playback configuration.

" } } }, @@ -638,22 +638,17 @@ "com.amazonaws.mediatailor#PutPlaybackConfigurationRequest": { "type": "structure", "members": { - "VideoContentSourceUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

" - } - }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { - "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" + "smithy.api#documentation": "

The tags to assign to the playback configuration.

", + "smithy.api#jsonName": "tags" } }, - "Name": { + "TranscodeProfileName": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The identifier for the playback configuration.

" + "smithy.api#documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

" } }, "SlateAdUrl": { @@ -668,31 +663,12 @@ "smithy.api#documentation": "

The configuration for DASH content.

" } }, - "TranscodeProfileName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

" - } - }, "AdDecisionServerUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

" } }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "

The tags to assign to the playback configuration.

", - "smithy.api#jsonName": "tags" - } - }, - "CdnConfiguration": { - "target": "com.amazonaws.mediatailor#CdnConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

" - } - }, "Bumper": { "target": "com.amazonaws.mediatailor#Bumper", "traits": { @@ -705,27 +681,16 @@ "smithy.api#documentation": "

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

" } }, - "LivePreRollConfiguration": { - "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for pre-roll ad insertion.

" - } - } - } - }, - "com.amazonaws.mediatailor#PutPlaybackConfigurationResponse": { - "type": "structure", - "members": { - "TranscodeProfileName": { + "VideoContentSourceUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

" + "smithy.api#documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

" } }, - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", + "LivePreRollConfiguration": { + "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", "traits": { - "smithy.api#documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" + "smithy.api#documentation": "

The configuration for pre-roll ad insertion.

" } }, "CdnConfiguration": { @@ -740,28 +705,40 @@ "smithy.api#documentation": "

The identifier for the playback configuration.

" } }, - "PlaybackConfigurationArn": { - "target": "com.amazonaws.mediatailor#__string", + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

" + "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" } - }, - "SessionInitializationEndpointPrefix": { + } + } + }, + "com.amazonaws.mediatailor#PutPlaybackConfigurationResponse": { + "type": "structure", + "members": { + "TranscodeProfileName": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

" + "smithy.api#documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

" } }, - "HlsConfiguration": { - "target": "com.amazonaws.mediatailor#HlsConfiguration", + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { - "smithy.api#documentation": "

The configuration for HLS content.

" + "smithy.api#documentation": "

The tags assigned to the playback configuration.

", + "smithy.api#jsonName": "tags" } }, - "VideoContentSourceUrl": { + "PlaybackConfigurationArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

" + } + }, + "LivePreRollConfiguration": { + "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for pre-roll ad insertion.

" } }, "Bumper": { @@ -770,16 +747,34 @@ "smithy.api#documentation": "

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.

" } }, + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

" + } + }, "DashConfiguration": { "target": "com.amazonaws.mediatailor#DashConfiguration", "traits": { "smithy.api#documentation": "

The configuration for DASH content.

" } }, - "LivePreRollConfiguration": { - "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", + "SessionInitializationEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The configuration for pre-roll ad insertion.

" + "smithy.api#documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the playback configuration.

" + } + }, + "PlaybackEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

" } }, "PersonalizationThresholdSeconds": { @@ -788,29 +783,34 @@ "smithy.api#documentation": "

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

" } }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", + "CdnConfiguration": { + "target": "com.amazonaws.mediatailor#CdnConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" + "smithy.api#documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

" } }, - "PlaybackEndpointPrefix": { + "SlateAdUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

" + "smithy.api#documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

" } }, - "SlateAdUrl": { + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", + "traits": { + "smithy.api#documentation": "

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

" + } + }, + "VideoContentSourceUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

" + "smithy.api#documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

" } }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", + "HlsConfiguration": { + "target": "com.amazonaws.mediatailor#HlsConfiguration", "traits": { - "smithy.api#documentation": "

The tags assigned to the playback configuration.

", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

The configuration for HLS content.

" } } } @@ -877,14 +877,6 @@ "com.amazonaws.mediatailor#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.mediatailor#__listOf__string", - "traits": { - "smithy.api#documentation": "

A comma-separated list of the tag keys to remove from the playback configuration.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -892,6 +884,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TagKeys": { + "target": "com.amazonaws.mediatailor#__listOf__string", + "traits": { + "smithy.api#documentation": "

A comma-separated list of the tag keys to remove from the playback configuration.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, diff --git a/codegen/sdk-codegen/aws-models/migration-hub.2017-05-31.json b/codegen/sdk-codegen/aws-models/migration-hub.2017-05-31.json index e4af3a964520..9ef547619473 100644 --- a/codegen/sdk-codegen/aws-models/migration-hub.2017-05-31.json +++ b/codegen/sdk-codegen/aws-models/migration-hub.2017-05-31.json @@ -90,7 +90,7 @@ "sdkId": "Migration Hub", "arnNamespace": "mgh", "cloudFormationName": "MigrationHub", - "cloudTrailEventSource": "migration.aws.amazon.com" + "cloudTrailEventSource": "migrationhub.amazonaws.com" }, "aws.auth#sigv4": { "name": "mgh" @@ -242,6 +242,13 @@ "smithy.api#required": {} } }, + "CreatedArtifact": { + "target": "com.amazonaws.migrationhub#CreatedArtifact", + "traits": { + "smithy.api#documentation": "

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS\n instance, etc.)

", + "smithy.api#required": {} + } + }, "ProgressUpdateStream": { "target": "com.amazonaws.migrationhub#ProgressUpdateStream", "traits": { @@ -254,13 +261,6 @@ "traits": { "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" } - }, - "CreatedArtifact": { - "target": "com.amazonaws.migrationhub#CreatedArtifact", - "traits": { - "smithy.api#documentation": "

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS\n instance, etc.)

", - "smithy.api#required": {} - } } } }, @@ -315,13 +315,19 @@ "com.amazonaws.migrationhub#AssociateDiscoveredResourceRequest": { "type": "structure", "members": { - "DiscoveredResource": { - "target": "com.amazonaws.migrationhub#DiscoveredResource", + "ProgressUpdateStream": { + "target": "com.amazonaws.migrationhub#ProgressUpdateStream", "traits": { - "smithy.api#documentation": "

Object representing a Resource.

", + "smithy.api#documentation": "

The name of the ProgressUpdateStream.

", "smithy.api#required": {} } }, + "DryRun": { + "target": "com.amazonaws.migrationhub#DryRun", + "traits": { + "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" + } + }, "MigrationTaskName": { "target": "com.amazonaws.migrationhub#MigrationTaskName", "traits": { @@ -329,16 +335,10 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.migrationhub#DryRun", - "traits": { - "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" - } - }, - "ProgressUpdateStream": { - "target": "com.amazonaws.migrationhub#ProgressUpdateStream", + "DiscoveredResource": { + "target": "com.amazonaws.migrationhub#DiscoveredResource", "traits": { - "smithy.api#documentation": "

The name of the ProgressUpdateStream.

", + "smithy.api#documentation": "

Object representing a Resource.

", "smithy.api#required": {} } } @@ -399,18 +399,18 @@ "com.amazonaws.migrationhub#CreateProgressUpdateStreamRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.migrationhub#DryRun", - "traits": { - "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" - } - }, "ProgressUpdateStreamName": { "target": "com.amazonaws.migrationhub#ProgressUpdateStream", "traits": { "smithy.api#documentation": "

The name of the ProgressUpdateStream. Do not store personal data in this\n field.\n

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.migrationhub#DryRun", + "traits": { + "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" + } } } }, @@ -509,18 +509,18 @@ "com.amazonaws.migrationhub#DeleteProgressUpdateStreamRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.migrationhub#DryRun", - "traits": { - "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" - } - }, "ProgressUpdateStreamName": { "target": "com.amazonaws.migrationhub#ProgressUpdateStream", "traits": { "smithy.api#documentation": "

The name of the ProgressUpdateStream. Do not store personal data in this\n field.\n

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.migrationhub#DryRun", + "traits": { + "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" + } } } }, @@ -581,17 +581,17 @@ "com.amazonaws.migrationhub#DescribeApplicationStateResult": { "type": "structure", "members": { - "ApplicationStatus": { - "target": "com.amazonaws.migrationhub#ApplicationStatus", - "traits": { - "smithy.api#documentation": "

Status of the application - Not Started, In-Progress, Complete.

" - } - }, "LastUpdatedTime": { "target": "com.amazonaws.migrationhub#UpdateDateTime", "traits": { "smithy.api#documentation": "

The timestamp when the application status was last updated.

" } + }, + "ApplicationStatus": { + "target": "com.amazonaws.migrationhub#ApplicationStatus", + "traits": { + "smithy.api#documentation": "

Status of the application - Not Started, In-Progress, Complete.

" + } } } }, @@ -711,6 +711,13 @@ "smithy.api#required": {} } }, + "CreatedArtifactName": { + "target": "com.amazonaws.migrationhub#CreatedArtifactName", + "traits": { + "smithy.api#documentation": "

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS\n instance, etc.)

", + "smithy.api#required": {} + } + }, "DryRun": { "target": "com.amazonaws.migrationhub#DryRun", "traits": { @@ -723,13 +730,6 @@ "smithy.api#documentation": "

The name of the ProgressUpdateStream.

", "smithy.api#required": {} } - }, - "CreatedArtifactName": { - "target": "com.amazonaws.migrationhub#CreatedArtifactName", - "traits": { - "smithy.api#documentation": "

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS\n instance, etc.)

", - "smithy.api#required": {} - } } } }, @@ -781,13 +781,6 @@ "com.amazonaws.migrationhub#DisassociateDiscoveredResourceRequest": { "type": "structure", "members": { - "ProgressUpdateStream": { - "target": "com.amazonaws.migrationhub#ProgressUpdateStream", - "traits": { - "smithy.api#documentation": "

The name of the ProgressUpdateStream.

", - "smithy.api#required": {} - } - }, "DryRun": { "target": "com.amazonaws.migrationhub#DryRun", "traits": { @@ -807,6 +800,13 @@ "smithy.api#documentation": "

The identifier given to the MigrationTask. Do not store personal data in this\n field.\n

", "smithy.api#required": {} } + }, + "ProgressUpdateStream": { + "target": "com.amazonaws.migrationhub#ProgressUpdateStream", + "traits": { + "smithy.api#documentation": "

The name of the ProgressUpdateStream.

", + "smithy.api#required": {} + } } } }, @@ -1028,10 +1028,10 @@ "com.amazonaws.migrationhub#ListApplicationStatesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.migrationhub#Token", + "ApplicationIds": { + "target": "com.amazonaws.migrationhub#ApplicationIds", "traits": { - "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" + "smithy.api#documentation": "

The configurationIds from the Application Discovery Service that uniquely identifies\n your applications.

" } }, "MaxResults": { @@ -1040,10 +1040,10 @@ "smithy.api#documentation": "

Maximum number of results to be returned per page.

" } }, - "ApplicationIds": { - "target": "com.amazonaws.migrationhub#ApplicationIds", + "NextToken": { + "target": "com.amazonaws.migrationhub#Token", "traits": { - "smithy.api#documentation": "

The configurationIds from the Application Discovery Service that uniquely identifies\n your applications.

" + "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" } } } @@ -1051,17 +1051,17 @@ "com.amazonaws.migrationhub#ListApplicationStatesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.migrationhub#Token", - "traits": { - "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" - } - }, "ApplicationStateList": { "target": "com.amazonaws.migrationhub#ApplicationStateList", "traits": { "smithy.api#documentation": "

A list of Applications that exist in Application Discovery Service.

" } + }, + "NextToken": { + "target": "com.amazonaws.migrationhub#Token", + "traits": { + "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" + } } } }, @@ -1116,18 +1116,18 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.migrationhub#Token", - "traits": { - "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" - } - }, "MaxResults": { "target": "com.amazonaws.migrationhub#MaxResultsCreatedArtifacts", "traits": { "smithy.api#documentation": "

Maximum number of results to be returned per page.

" } }, + "NextToken": { + "target": "com.amazonaws.migrationhub#Token", + "traits": { + "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" + } + }, "ProgressUpdateStream": { "target": "com.amazonaws.migrationhub#ProgressUpdateStream", "traits": { @@ -1140,17 +1140,17 @@ "com.amazonaws.migrationhub#ListCreatedArtifactsResult": { "type": "structure", "members": { - "CreatedArtifactList": { - "target": "com.amazonaws.migrationhub#CreatedArtifactList", - "traits": { - "smithy.api#documentation": "

List of created artifacts up to the maximum number of results specified in the\n request.

" - } - }, "NextToken": { "target": "com.amazonaws.migrationhub#Token", "traits": { "smithy.api#documentation": "

If there are more created artifacts than the max result, return the next token to be\n passed to the next call as a bookmark of where to start from.

" } + }, + "CreatedArtifactList": { + "target": "com.amazonaws.migrationhub#CreatedArtifactList", + "traits": { + "smithy.api#documentation": "

List of created artifacts up to the maximum number of results specified in the\n request.

" + } } } }, @@ -1205,18 +1205,18 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.migrationhub#Token", - "traits": { - "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" - } - }, "MaxResults": { "target": "com.amazonaws.migrationhub#MaxResultsResources", "traits": { "smithy.api#documentation": "

The maximum number of results returned per page.

" } }, + "NextToken": { + "target": "com.amazonaws.migrationhub#Token", + "traits": { + "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" + } + }, "ProgressUpdateStream": { "target": "com.amazonaws.migrationhub#ProgressUpdateStream", "traits": { @@ -1229,17 +1229,17 @@ "com.amazonaws.migrationhub#ListDiscoveredResourcesResult": { "type": "structure", "members": { - "DiscoveredResourceList": { - "target": "com.amazonaws.migrationhub#DiscoveredResourceList", - "traits": { - "smithy.api#documentation": "

Returned list of discovered resources associated with the given MigrationTask.

" - } - }, "NextToken": { "target": "com.amazonaws.migrationhub#Token", "traits": { "smithy.api#documentation": "

If there are more discovered resources than the max result, return the next token to be\n passed to the next call as a bookmark of where to start from.

" } + }, + "DiscoveredResourceList": { + "target": "com.amazonaws.migrationhub#DiscoveredResourceList", + "traits": { + "smithy.api#documentation": "

Returned list of discovered resources associated with the given MigrationTask.

" + } } } }, @@ -1290,18 +1290,18 @@ "com.amazonaws.migrationhub#ListMigrationTasksRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.migrationhub#MaxResults", - "traits": { - "smithy.api#documentation": "

Value to specify how many results are returned per page.

" - } - }, "NextToken": { "target": "com.amazonaws.migrationhub#Token", "traits": { "smithy.api#documentation": "

If a NextToken was returned by a previous call, there are more results\n available. To retrieve the next page of results, make the call again using the returned\n token in NextToken.

" } }, + "MaxResults": { + "target": "com.amazonaws.migrationhub#MaxResults", + "traits": { + "smithy.api#documentation": "

Value to specify how many results are returned per page.

" + } + }, "ResourceName": { "target": "com.amazonaws.migrationhub#ResourceName", "traits": { @@ -1438,18 +1438,18 @@ "smithy.api#documentation": "

Unique identifier that references the migration task. Do not store personal\n data in this field.\n

" } }, - "Task": { - "target": "com.amazonaws.migrationhub#Task", - "traits": { - "smithy.api#documentation": "

Task object encapsulating task information.

" - } - }, "UpdateDateTime": { "target": "com.amazonaws.migrationhub#UpdateDateTime", "traits": { "smithy.api#documentation": "

The timestamp when the task was gathered.

" } }, + "Task": { + "target": "com.amazonaws.migrationhub#Task", + "traits": { + "smithy.api#documentation": "

Task object encapsulating task information.

" + } + }, "ProgressUpdateStream": { "target": "com.amazonaws.migrationhub#ProgressUpdateStream", "traits": { @@ -1492,12 +1492,6 @@ "smithy.api#documentation": "

Status of the task.

" } }, - "MigrationTaskName": { - "target": "com.amazonaws.migrationhub#MigrationTaskName", - "traits": { - "smithy.api#documentation": "

Unique identifier that references the migration task. Do not store personal\n data in this field.\n

" - } - }, "UpdateDateTime": { "target": "com.amazonaws.migrationhub#UpdateDateTime", "traits": { @@ -1515,6 +1509,12 @@ "traits": { "smithy.api#documentation": "

Indication of the percentage completion of the task.

" } + }, + "MigrationTaskName": { + "target": "com.amazonaws.migrationhub#MigrationTaskName", + "traits": { + "smithy.api#documentation": "

Unique identifier that references the migration task. Do not store personal\n data in this field.\n

" + } } }, "traits": { @@ -1589,10 +1589,10 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.migrationhub#DryRun", + "UpdateDateTime": { + "target": "com.amazonaws.migrationhub#UpdateDateTime", "traits": { - "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" + "smithy.api#documentation": "

The timestamp when the application state changed.

" } }, "ApplicationId": { @@ -1602,10 +1602,10 @@ "smithy.api#required": {} } }, - "UpdateDateTime": { - "target": "com.amazonaws.migrationhub#UpdateDateTime", + "DryRun": { + "target": "com.amazonaws.migrationhub#DryRun", "traits": { - "smithy.api#documentation": "

The timestamp when the application state changed.

" + "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" } } } @@ -1672,16 +1672,10 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.migrationhub#DryRun", - "traits": { - "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" - } - }, - "MigrationTaskName": { - "target": "com.amazonaws.migrationhub#MigrationTaskName", + "Task": { + "target": "com.amazonaws.migrationhub#Task", "traits": { - "smithy.api#documentation": "

Unique identifier that references the migration task. Do not store personal\n data in this field.\n

", + "smithy.api#documentation": "

Information about the task's progress and status.

", "smithy.api#required": {} } }, @@ -1692,12 +1686,18 @@ "smithy.api#required": {} } }, - "Task": { - "target": "com.amazonaws.migrationhub#Task", + "MigrationTaskName": { + "target": "com.amazonaws.migrationhub#MigrationTaskName", "traits": { - "smithy.api#documentation": "

Information about the task's progress and status.

", + "smithy.api#documentation": "

Unique identifier that references the migration task. Do not store personal\n data in this field.\n

", "smithy.api#required": {} } + }, + "DryRun": { + "target": "com.amazonaws.migrationhub#DryRun", + "traits": { + "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" + } } } }, @@ -1808,11 +1808,10 @@ "smithy.api#required": {} } }, - "MigrationTaskName": { - "target": "com.amazonaws.migrationhub#MigrationTaskName", + "DryRun": { + "target": "com.amazonaws.migrationhub#DryRun", "traits": { - "smithy.api#documentation": "

Unique identifier that references the migration task. Do not store personal\n data in this field.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" } }, "ResourceAttributeList": { @@ -1822,10 +1821,11 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.migrationhub#DryRun", + "MigrationTaskName": { + "target": "com.amazonaws.migrationhub#MigrationTaskName", "traits": { - "smithy.api#documentation": "

Optional boolean flag to indicate whether any effect should take place. Used to test if\n the caller has permission to make the call.

" + "smithy.api#documentation": "

Unique identifier that references the migration task. Do not store personal\n data in this field.\n

", + "smithy.api#required": {} } } } @@ -1837,17 +1837,17 @@ "com.amazonaws.migrationhub#ResourceAttribute": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.migrationhub#ResourceAttributeType", + "Value": { + "target": "com.amazonaws.migrationhub#ResourceAttributeValue", "traits": { - "smithy.api#documentation": "

Type of resource.

", + "smithy.api#documentation": "

Value of the resource type.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.migrationhub#ResourceAttributeValue", + "Type": { + "target": "com.amazonaws.migrationhub#ResourceAttributeType", "traits": { - "smithy.api#documentation": "

Value of the resource type.

", + "smithy.api#documentation": "

Type of resource.

", "smithy.api#required": {} } } @@ -1998,10 +1998,11 @@ "com.amazonaws.migrationhub#Task": { "type": "structure", "members": { - "ProgressPercent": { - "target": "com.amazonaws.migrationhub#ProgressPercent", + "Status": { + "target": "com.amazonaws.migrationhub#Status", "traits": { - "smithy.api#documentation": "

Indication of the percentage completion of the task.

" + "smithy.api#documentation": "

Status of the task - Not Started, In-Progress, Complete.

", + "smithy.api#required": {} } }, "StatusDetail": { @@ -2010,11 +2011,10 @@ "smithy.api#documentation": "

Details of task status as notified by a migration tool. A tool might use this field to\n provide clarifying information about the status that is unique to that tool or that\n explains an error state.

" } }, - "Status": { - "target": "com.amazonaws.migrationhub#Status", + "ProgressPercent": { + "target": "com.amazonaws.migrationhub#ProgressPercent", "traits": { - "smithy.api#documentation": "

Status of the task - Not Started, In-Progress, Complete.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Indication of the percentage completion of the task.

" } } }, @@ -2025,19 +2025,19 @@ "com.amazonaws.migrationhub#ThrottlingException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.migrationhub#ErrorMessage", - "traits": { - "smithy.api#documentation": "

A message that provides information about the exception.

", - "smithy.api#required": {} - } - }, "RetryAfterSeconds": { "target": "com.amazonaws.migrationhub#RetryAfterSeconds", "traits": { "smithy.api#documentation": "

The number of seconds the caller should wait before retrying.

", "smithy.api#httpHeader": "Retry-After" } + }, + "Message": { + "target": "com.amazonaws.migrationhub#ErrorMessage", + "traits": { + "smithy.api#documentation": "

A message that provides information about the exception.

", + "smithy.api#required": {} + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/migrationhub-config.2019-06-30.json b/codegen/sdk-codegen/aws-models/migrationhub-config.2019-06-30.json index 29fdf85e1cdb..0ffd14cdce4c 100644 --- a/codegen/sdk-codegen/aws-models/migrationhub-config.2019-06-30.json +++ b/codegen/sdk-codegen/aws-models/migrationhub-config.2019-06-30.json @@ -48,7 +48,7 @@ "sdkId": "MigrationHub Config", "arnNamespace": "mgh", "cloudFormationName": "MigrationHubConfig", - "cloudTrailEventSource": "awsmigrationhubmultiaccount.amazonaws.com" + "cloudTrailEventSource": "migrationhubconfig.amazonaws.com" }, "aws.auth#sigv4": { "name": "mgh" @@ -115,12 +115,6 @@ "com.amazonaws.migrationhubconfig#CreateHomeRegionControlRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.migrationhubconfig#DryRun", - "traits": { - "smithy.api#documentation": "

Optional Boolean flag to indicate whether any effect should take place. It tests whether\n the caller has permission to make the call.

" - } - }, "HomeRegion": { "target": "com.amazonaws.migrationhubconfig#HomeRegion", "traits": { @@ -128,6 +122,12 @@ "smithy.api#required": {} } }, + "DryRun": { + "target": "com.amazonaws.migrationhubconfig#DryRun", + "traits": { + "smithy.api#documentation": "

Optional Boolean flag to indicate whether any effect should take place. It tests whether\n the caller has permission to make the call.

" + } + }, "Target": { "target": "com.amazonaws.migrationhubconfig#Target", "traits": { @@ -195,24 +195,12 @@ "com.amazonaws.migrationhubconfig#DescribeHomeRegionControlsRequest": { "type": "structure", "members": { - "Target": { - "target": "com.amazonaws.migrationhubconfig#Target", - "traits": { - "smithy.api#documentation": "

The target parameter specifies the identifier to which the home region is applied, which\n is always of type ACCOUNT. It applies the home region to the current\n ACCOUNT.

" - } - }, "MaxResults": { "target": "com.amazonaws.migrationhubconfig#DescribeHomeRegionControlsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of filtering results to display per page.

" } }, - "NextToken": { - "target": "com.amazonaws.migrationhubconfig#Token", - "traits": { - "smithy.api#documentation": "

If a NextToken was returned by a previous call, more results are available.\n To retrieve the next page of results, make the call again using the returned token in\n NextToken.

" - } - }, "HomeRegion": { "target": "com.amazonaws.migrationhubconfig#HomeRegion", "traits": { @@ -224,6 +212,18 @@ "traits": { "smithy.api#documentation": "

The ControlID is a unique identifier string of your\n HomeRegionControl object.

" } + }, + "NextToken": { + "target": "com.amazonaws.migrationhubconfig#Token", + "traits": { + "smithy.api#documentation": "

If a NextToken was returned by a previous call, more results are available.\n To retrieve the next page of results, make the call again using the returned token in\n NextToken.

" + } + }, + "Target": { + "target": "com.amazonaws.migrationhubconfig#Target", + "traits": { + "smithy.api#documentation": "

The target parameter specifies the identifier to which the home region is applied, which\n is always of type ACCOUNT. It applies the home region to the current\n ACCOUNT.

" + } } } }, @@ -319,16 +319,10 @@ "com.amazonaws.migrationhubconfig#HomeRegionControl": { "type": "structure", "members": { - "Target": { - "target": "com.amazonaws.migrationhubconfig#Target", - "traits": { - "smithy.api#documentation": "

The target parameter specifies the identifier to which the home region is applied, which\n is always an ACCOUNT. It applies the home region to the current\n ACCOUNT.

" - } - }, - "ControlId": { - "target": "com.amazonaws.migrationhubconfig#ControlId", + "HomeRegion": { + "target": "com.amazonaws.migrationhubconfig#HomeRegion", "traits": { - "smithy.api#documentation": "

A unique identifier that's generated for each home region control. It's always a string\n that begins with \"hrc-\" followed by 12 lowercase letters and numbers.

" + "smithy.api#documentation": "

The AWS Region that's been set as home region. For example, \"us-west-2\" or \"eu-central-1\"\n are valid home regions.

" } }, "RequestedTime": { @@ -337,10 +331,16 @@ "smithy.api#documentation": "

A timestamp representing the time when the customer called\n CreateHomeregionControl and set the home region for the account.

" } }, - "HomeRegion": { - "target": "com.amazonaws.migrationhubconfig#HomeRegion", + "Target": { + "target": "com.amazonaws.migrationhubconfig#Target", "traits": { - "smithy.api#documentation": "

The AWS Region that's been set as home region. For example, \"us-west-2\" or \"eu-central-1\"\n are valid home regions.

" + "smithy.api#documentation": "

The target parameter specifies the identifier to which the home region is applied, which\n is always an ACCOUNT. It applies the home region to the current\n ACCOUNT.

" + } + }, + "ControlId": { + "target": "com.amazonaws.migrationhubconfig#ControlId", + "traits": { + "smithy.api#documentation": "

A unique identifier that's generated for each home region control. It's always a string\n that begins with \"hrc-\" followed by 12 lowercase letters and numbers.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/mobile.2017-07-01.json b/codegen/sdk-codegen/aws-models/mobile.2017-07-01.json index 960f121312c7..fc4937b273c7 100644 --- a/codegen/sdk-codegen/aws-models/mobile.2017-07-01.json +++ b/codegen/sdk-codegen/aws-models/mobile.2017-07-01.json @@ -66,7 +66,7 @@ "sdkId": "Mobile", "arnNamespace": "awsmobilehubservice", "cloudFormationName": "Mobile", - "cloudTrailEventSource": "model.mobile.services.amazonaws.com" + "cloudTrailEventSource": "mobile.amazonaws.com" }, "aws.auth#sigv4": { "name": "awsmobilehubservice" @@ -141,23 +141,23 @@ "com.amazonaws.mobile#BundleDetails": { "type": "structure", "members": { - "availablePlatforms": { - "target": "com.amazonaws.mobile#Platforms" + "iconUrl": { + "target": "com.amazonaws.mobile#IconUrl" + }, + "bundleId": { + "target": "com.amazonaws.mobile#BundleId" }, "description": { "target": "com.amazonaws.mobile#BundleDescription" }, - "bundleId": { - "target": "com.amazonaws.mobile#BundleId" + "version": { + "target": "com.amazonaws.mobile#BundleVersion" }, "title": { "target": "com.amazonaws.mobile#BundleTitle" }, - "iconUrl": { - "target": "com.amazonaws.mobile#IconUrl" - }, - "version": { - "target": "com.amazonaws.mobile#BundleVersion" + "availablePlatforms": { + "target": "com.amazonaws.mobile#Platforms" } }, "traits": { @@ -243,13 +243,6 @@ "com.amazonaws.mobile#CreateProjectRequest": { "type": "structure", "members": { - "region": { - "target": "com.amazonaws.mobile#ProjectRegion", - "traits": { - "smithy.api#documentation": "

\n Default region where project resources should be created.\n

", - "smithy.api#httpQuery": "region" - } - }, "contents": { "target": "com.amazonaws.mobile#Contents", "traits": { @@ -257,6 +250,13 @@ "smithy.api#httpPayload": {} } }, + "name": { + "target": "com.amazonaws.mobile#ProjectName", + "traits": { + "smithy.api#documentation": "

\n Name of the project.\n

", + "smithy.api#httpQuery": "name" + } + }, "snapshotId": { "target": "com.amazonaws.mobile#SnapshotId", "traits": { @@ -264,11 +264,11 @@ "smithy.api#httpQuery": "snapshotId" } }, - "name": { - "target": "com.amazonaws.mobile#ProjectName", + "region": { + "target": "com.amazonaws.mobile#ProjectRegion", "traits": { - "smithy.api#documentation": "

\n Name of the project.\n

", - "smithy.api#httpQuery": "name" + "smithy.api#documentation": "

\n Default region where project resources should be created.\n

", + "smithy.api#httpQuery": "region" } } }, @@ -553,13 +553,6 @@ "com.amazonaws.mobile#ExportBundleRequest": { "type": "structure", "members": { - "projectId": { - "target": "com.amazonaws.mobile#ProjectId", - "traits": { - "smithy.api#documentation": "

\n Unique project identifier.\n

", - "smithy.api#httpQuery": "projectId" - } - }, "bundleId": { "target": "com.amazonaws.mobile#BundleId", "traits": { @@ -574,6 +567,13 @@ "smithy.api#documentation": "

\n Developer desktop or target application platform.\n

", "smithy.api#httpQuery": "platform" } + }, + "projectId": { + "target": "com.amazonaws.mobile#ProjectId", + "traits": { + "smithy.api#documentation": "

\n Unique project identifier.\n

", + "smithy.api#httpQuery": "projectId" + } } }, "traits": { @@ -656,17 +656,17 @@ "smithy.api#documentation": "

\n Unique identifier for the exported snapshot of the project configuration. This\n snapshot identifier is included in the share URL.\n

" } }, - "downloadUrl": { - "target": "com.amazonaws.mobile#DownloadUrl", - "traits": { - "smithy.api#documentation": "

\n URL which can be used to download the exported project configuation file(s).\n

" - } - }, "shareUrl": { "target": "com.amazonaws.mobile#ShareUrl", "traits": { "smithy.api#documentation": "

\n URL which can be shared to allow other AWS users to create their own project\n in AWS Mobile Hub with the same configuration as the specified project. This\n URL pertains to a snapshot in time of the project configuration that is created\n when this API is called. If you want to share additional changes to your project\n configuration, then you will need to create and share a new snapshot by calling\n this method again.\n

" } + }, + "downloadUrl": { + "target": "com.amazonaws.mobile#DownloadUrl", + "traits": { + "smithy.api#documentation": "

\n URL which can be used to download the exported project configuation file(s).\n

" + } } }, "traits": { @@ -781,17 +781,17 @@ "com.amazonaws.mobile#ListBundlesResult": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.mobile#NextToken", - "traits": { - "smithy.api#documentation": "

\n Pagination token. If non-null pagination token is returned in a result,\n then pass its value in another request to fetch more entries.\n

" - } - }, "bundleList": { "target": "com.amazonaws.mobile#BundleList", "traits": { "smithy.api#documentation": "

\n A list of bundles.\n

" } + }, + "nextToken": { + "target": "com.amazonaws.mobile#NextToken", + "traits": { + "smithy.api#documentation": "

\n Pagination token. If non-null pagination token is returned in a result,\n then pass its value in another request to fetch more entries.\n

" + } } }, "traits": { @@ -840,19 +840,19 @@ "com.amazonaws.mobile#ListProjectsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.mobile#MaxResults", - "traits": { - "smithy.api#documentation": "

\n Maximum number of records to list in a single response.\n

", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.mobile#NextToken", "traits": { "smithy.api#documentation": "

\n Pagination token. Set to null to start listing projects from start.\n If non-null pagination token is returned in a result, then pass its\n value in here in another request to list more projects.\n

", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.mobile#MaxResults", + "traits": { + "smithy.api#documentation": "

\n Maximum number of records to list in a single response.\n

", + "smithy.api#httpQuery": "maxResults" + } } }, "traits": { @@ -946,38 +946,38 @@ "com.amazonaws.mobile#ProjectDetails": { "type": "structure", "members": { - "resources": { - "target": "com.amazonaws.mobile#Resources" + "projectId": { + "target": "com.amazonaws.mobile#ProjectId" + }, + "consoleUrl": { + "target": "com.amazonaws.mobile#ConsoleUrl", + "traits": { + "smithy.api#documentation": "

\n Website URL for this project in the AWS Mobile Hub console.\n

" + } }, "name": { "target": "com.amazonaws.mobile#ProjectName" }, - "projectId": { - "target": "com.amazonaws.mobile#ProjectId" + "region": { + "target": "com.amazonaws.mobile#ProjectRegion" }, "state": { "target": "com.amazonaws.mobile#ProjectState" }, - "region": { - "target": "com.amazonaws.mobile#ProjectRegion" - }, - "createdDate": { + "lastUpdatedDate": { "target": "com.amazonaws.mobile#Date", "traits": { - "smithy.api#documentation": "

\n Date the project was created.\n

" - } - }, - "consoleUrl": { - "target": "com.amazonaws.mobile#ConsoleUrl", - "traits": { - "smithy.api#documentation": "

\n Website URL for this project in the AWS Mobile Hub console.\n

" + "smithy.api#documentation": "

\n Date of the last modification of the project.\n

" } }, - "lastUpdatedDate": { + "createdDate": { "target": "com.amazonaws.mobile#Date", "traits": { - "smithy.api#documentation": "

\n Date of the last modification of the project.\n

" + "smithy.api#documentation": "

\n Date the project was created.\n

" } + }, + "resources": { + "target": "com.amazonaws.mobile#Resources" } }, "traits": { @@ -1104,14 +1104,14 @@ "com.amazonaws.mobile#ServiceUnavailableException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.mobile#ErrorMessage" - }, "retryAfterSeconds": { "target": "com.amazonaws.mobile#ErrorMessage", "traits": { "smithy.api#httpHeader": "Retry-After" } + }, + "message": { + "target": "com.amazonaws.mobile#ErrorMessage" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/mq.2017-11-27.json b/codegen/sdk-codegen/aws-models/mq.2017-11-27.json index 22d3df958d5c..5a6a3a6799ae 100644 --- a/codegen/sdk-codegen/aws-models/mq.2017-11-27.json +++ b/codegen/sdk-codegen/aws-models/mq.2017-11-27.json @@ -63,18 +63,18 @@ "com.amazonaws.mq#BadRequestException": { "type": "structure", "members": { - "ErrorAttribute": { + "Message": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The attribute which caused the error.", - "smithy.api#jsonName": "errorAttribute" + "smithy.api#documentation": "The explanation of the error.", + "smithy.api#jsonName": "message" } }, - "Message": { + "ErrorAttribute": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The explanation of the error.", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "The attribute which caused the error.", + "smithy.api#jsonName": "errorAttribute" } } }, @@ -87,19 +87,19 @@ "com.amazonaws.mq#BrokerEngineType": { "type": "structure", "members": { - "EngineType": { - "target": "com.amazonaws.mq#EngineType", - "traits": { - "smithy.api#documentation": "The type of broker engine.", - "smithy.api#jsonName": "engineType" - } - }, "EngineVersions": { "target": "com.amazonaws.mq#__listOfEngineVersion", "traits": { "smithy.api#documentation": "The list of engine versions.", "smithy.api#jsonName": "engineVersions" } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#documentation": "The type of broker engine.", + "smithy.api#jsonName": "engineType" + } } }, "traits": { @@ -109,11 +109,11 @@ "com.amazonaws.mq#BrokerInstance": { "type": "structure", "members": { - "ConsoleURL": { + "IpAddress": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The URL of the broker's ActiveMQ Web Console.", - "smithy.api#jsonName": "consoleURL" + "smithy.api#documentation": "The IP address of the Elastic Network Interface (ENI) attached to the broker.", + "smithy.api#jsonName": "ipAddress" } }, "Endpoints": { @@ -123,11 +123,11 @@ "smithy.api#jsonName": "endpoints" } }, - "IpAddress": { + "ConsoleURL": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The IP address of the Elastic Network Interface (ENI) attached to the broker.", - "smithy.api#jsonName": "ipAddress" + "smithy.api#documentation": "The URL of the broker's ActiveMQ Web Console.", + "smithy.api#jsonName": "consoleURL" } } }, @@ -138,20 +138,6 @@ "com.amazonaws.mq#BrokerInstanceOption": { "type": "structure", "members": { - "AvailabilityZones": { - "target": "com.amazonaws.mq#__listOfAvailabilityZone", - "traits": { - "smithy.api#documentation": "The list of available az.", - "smithy.api#jsonName": "availabilityZones" - } - }, - "StorageType": { - "target": "com.amazonaws.mq#BrokerStorageType", - "traits": { - "smithy.api#documentation": "The broker's storage type.", - "smithy.api#jsonName": "storageType" - } - }, "SupportedEngineVersions": { "target": "com.amazonaws.mq#__listOf__string", "traits": { @@ -179,6 +165,20 @@ "smithy.api#documentation": "The type of broker engine.", "smithy.api#jsonName": "engineType" } + }, + "AvailabilityZones": { + "target": "com.amazonaws.mq#__listOfAvailabilityZone", + "traits": { + "smithy.api#documentation": "The list of available az.", + "smithy.api#jsonName": "availabilityZones" + } + }, + "StorageType": { + "target": "com.amazonaws.mq#BrokerStorageType", + "traits": { + "smithy.api#documentation": "The broker's storage type.", + "smithy.api#jsonName": "storageType" + } } }, "traits": { @@ -232,13 +232,6 @@ "com.amazonaws.mq#BrokerSummary": { "type": "structure", "members": { - "BrokerId": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", - "smithy.api#jsonName": "brokerId" - } - }, "Created": { "target": "com.amazonaws.mq#__timestampIso8601", "traits": { @@ -246,11 +239,18 @@ "smithy.api#jsonName": "created" } }, - "HostInstanceType": { + "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The broker's instance type.", - "smithy.api#jsonName": "hostInstanceType" + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#jsonName": "brokerId" + } + }, + "DeploymentMode": { + "target": "com.amazonaws.mq#DeploymentMode", + "traits": { + "smithy.api#documentation": "Required. The deployment mode of the broker.", + "smithy.api#jsonName": "deploymentMode" } }, "BrokerName": { @@ -260,11 +260,11 @@ "smithy.api#jsonName": "brokerName" } }, - "BrokerState": { - "target": "com.amazonaws.mq#BrokerState", + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The status of the broker.", - "smithy.api#jsonName": "brokerState" + "smithy.api#documentation": "The broker's instance type.", + "smithy.api#jsonName": "hostInstanceType" } }, "BrokerArn": { @@ -274,11 +274,11 @@ "smithy.api#jsonName": "brokerArn" } }, - "DeploymentMode": { - "target": "com.amazonaws.mq#DeploymentMode", + "BrokerState": { + "target": "com.amazonaws.mq#BrokerState", "traits": { - "smithy.api#documentation": "Required. The deployment mode of the broker.", - "smithy.api#jsonName": "deploymentMode" + "smithy.api#documentation": "The status of the broker.", + "smithy.api#jsonName": "brokerState" } } }, @@ -309,32 +309,25 @@ "com.amazonaws.mq#Configuration": { "type": "structure", "members": { - "Created": { - "target": "com.amazonaws.mq#__timestampIso8601", + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", "traits": { - "smithy.api#documentation": "Required. The date and time of the configuration revision.", - "smithy.api#jsonName": "created" + "smithy.api#documentation": "The authentication strategy associated with the configuration.", + "smithy.api#jsonName": "authenticationStrategy" } }, - "Name": { + "Description": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", - "smithy.api#jsonName": "name" - } - }, - "Tags": { - "target": "com.amazonaws.mq#__mapOf__string", - "traits": { - "smithy.api#documentation": "The list of all tags associated with this configuration.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Required. The description of the configuration.", + "smithy.api#jsonName": "description" } }, - "EngineType": { - "target": "com.amazonaws.mq#EngineType", + "Arn": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", - "smithy.api#jsonName": "engineType" + "smithy.api#documentation": "Required. The ARN of the configuration.", + "smithy.api#jsonName": "arn" } }, "Id": { @@ -344,6 +337,13 @@ "smithy.api#jsonName": "id" } }, + "EngineVersion": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", + "smithy.api#jsonName": "engineVersion" + } + }, "LatestRevision": { "target": "com.amazonaws.mq#ConfigurationRevision", "traits": { @@ -351,32 +351,32 @@ "smithy.api#jsonName": "latestRevision" } }, - "Arn": { + "Name": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The ARN of the configuration.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", + "smithy.api#jsonName": "name" } }, - "AuthenticationStrategy": { - "target": "com.amazonaws.mq#AuthenticationStrategy", + "EngineType": { + "target": "com.amazonaws.mq#EngineType", "traits": { - "smithy.api#documentation": "The authentication strategy associated with the configuration.", - "smithy.api#jsonName": "authenticationStrategy" + "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", + "smithy.api#jsonName": "engineType" } }, - "EngineVersion": { - "target": "com.amazonaws.mq#__string", + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", "traits": { - "smithy.api#documentation": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", - "smithy.api#jsonName": "engineVersion" + "smithy.api#documentation": "The list of all tags associated with this configuration.", + "smithy.api#jsonName": "tags" } }, - "Description": { - "target": "com.amazonaws.mq#__string", + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", "traits": { - "smithy.api#documentation": "Required. The description of the configuration.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "Required. The date and time of the configuration revision.", + "smithy.api#jsonName": "created" } } }, @@ -387,19 +387,19 @@ "com.amazonaws.mq#ConfigurationId": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", - "smithy.api#jsonName": "id" - } - }, "Revision": { "target": "com.amazonaws.mq#__integer", "traits": { "smithy.api#documentation": "The revision number of the configuration.", "smithy.api#jsonName": "revision" } + }, + "Id": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", + "smithy.api#jsonName": "id" + } } }, "traits": { @@ -409,11 +409,11 @@ "com.amazonaws.mq#ConfigurationRevision": { "type": "structure", "members": { - "Revision": { - "target": "com.amazonaws.mq#__integer", + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", "traits": { - "smithy.api#documentation": "Required. The revision number of the configuration.", - "smithy.api#jsonName": "revision" + "smithy.api#documentation": "Required. The date and time of the configuration revision.", + "smithy.api#jsonName": "created" } }, "Description": { @@ -423,11 +423,11 @@ "smithy.api#jsonName": "description" } }, - "Created": { - "target": "com.amazonaws.mq#__timestampIso8601", + "Revision": { + "target": "com.amazonaws.mq#__integer", "traits": { - "smithy.api#documentation": "Required. The date and time of the configuration revision.", - "smithy.api#jsonName": "created" + "smithy.api#documentation": "Required. The revision number of the configuration.", + "smithy.api#jsonName": "revision" } } }, @@ -438,13 +438,6 @@ "com.amazonaws.mq#Configurations": { "type": "structure", "members": { - "Current": { - "target": "com.amazonaws.mq#ConfigurationId", - "traits": { - "smithy.api#documentation": "The current configuration of the broker.", - "smithy.api#jsonName": "current" - } - }, "History": { "target": "com.amazonaws.mq#__listOfConfigurationId", "traits": { @@ -458,6 +451,13 @@ "smithy.api#documentation": "The pending configuration of the broker.", "smithy.api#jsonName": "pending" } + }, + "Current": { + "target": "com.amazonaws.mq#ConfigurationId", + "traits": { + "smithy.api#documentation": "The current configuration of the broker.", + "smithy.api#jsonName": "current" + } } }, "traits": { @@ -467,18 +467,18 @@ "com.amazonaws.mq#ConflictException": { "type": "structure", "members": { - "Message": { + "ErrorAttribute": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The explanation of the error.", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "The attribute which caused the error.", + "smithy.api#jsonName": "errorAttribute" } }, - "ErrorAttribute": { + "Message": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The attribute which caused the error.", - "smithy.api#jsonName": "errorAttribute" + "smithy.api#documentation": "The explanation of the error.", + "smithy.api#jsonName": "message" } } }, @@ -525,53 +525,40 @@ "com.amazonaws.mq#CreateBrokerRequest": { "type": "structure", "members": { - "Configuration": { - "target": "com.amazonaws.mq#ConfigurationId", + "Logs": { + "target": "com.amazonaws.mq#Logs", "traits": { - "smithy.api#documentation": "A list of information about the configuration.", - "smithy.api#jsonName": "configuration" + "smithy.api#documentation": "Enables Amazon CloudWatch logging for brokers.", + "smithy.api#jsonName": "logs" } }, - "Users": { - "target": "com.amazonaws.mq#__listOfUser", + "EncryptionOptions": { + "target": "com.amazonaws.mq#EncryptionOptions", "traits": { - "smithy.api#documentation": "Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", - "smithy.api#jsonName": "users" + "smithy.api#documentation": "Encryption options for the broker.", + "smithy.api#jsonName": "encryptionOptions" } }, - "EngineVersion": { + "CreatorRequestId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", - "smithy.api#jsonName": "engineVersion" - } - }, - "AuthenticationStrategy": { - "target": "com.amazonaws.mq#AuthenticationStrategy", - "traits": { - "smithy.api#documentation": "The authentication strategy used to secure the broker.", - "smithy.api#jsonName": "authenticationStrategy" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.mq#__boolean", - "traits": { - "smithy.api#documentation": "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.", - "smithy.api#jsonName": "autoMinorVersionUpgrade" + "smithy.api#documentation": "The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "creatorRequestId" } }, - "StorageType": { - "target": "com.amazonaws.mq#BrokerStorageType", + "LdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataInput", "traits": { - "smithy.api#documentation": "The broker's storage type.", - "smithy.api#jsonName": "storageType" + "smithy.api#documentation": "The metadata of the LDAP server used to authenticate and authorize connections to the broker.", + "smithy.api#jsonName": "ldapServerMetadata" } }, - "SecurityGroups": { - "target": "com.amazonaws.mq#__listOf__string", + "MaintenanceWindowStartTime": { + "target": "com.amazonaws.mq#WeeklyStartTime", "traits": { - "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", - "smithy.api#jsonName": "securityGroups" + "smithy.api#documentation": "The parameters that determine the WeeklyStartTime.", + "smithy.api#jsonName": "maintenanceWindowStartTime" } }, "Tags": { @@ -581,53 +568,46 @@ "smithy.api#jsonName": "tags" } }, - "LdapServerMetadata": { - "target": "com.amazonaws.mq#LdapServerMetadataInput", - "traits": { - "smithy.api#documentation": "The metadata of the LDAP server used to authenticate and authorize connections to the broker.", - "smithy.api#jsonName": "ldapServerMetadata" - } - }, - "EncryptionOptions": { - "target": "com.amazonaws.mq#EncryptionOptions", + "DeploymentMode": { + "target": "com.amazonaws.mq#DeploymentMode", "traits": { - "smithy.api#documentation": "Encryption options for the broker.", - "smithy.api#jsonName": "encryptionOptions" + "smithy.api#documentation": "Required. The deployment mode of the broker.", + "smithy.api#jsonName": "deploymentMode" } }, - "PubliclyAccessible": { - "target": "com.amazonaws.mq#__boolean", + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.", - "smithy.api#jsonName": "publiclyAccessible" + "smithy.api#documentation": "Required. The broker's instance type.", + "smithy.api#jsonName": "hostInstanceType" } }, - "EngineType": { - "target": "com.amazonaws.mq#EngineType", + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", - "smithy.api#jsonName": "engineType" + "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", + "smithy.api#jsonName": "securityGroups" } }, - "DeploymentMode": { - "target": "com.amazonaws.mq#DeploymentMode", + "StorageType": { + "target": "com.amazonaws.mq#BrokerStorageType", "traits": { - "smithy.api#documentation": "Required. The deployment mode of the broker.", - "smithy.api#jsonName": "deploymentMode" + "smithy.api#documentation": "The broker's storage type.", + "smithy.api#jsonName": "storageType" } }, - "Logs": { - "target": "com.amazonaws.mq#Logs", + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", "traits": { - "smithy.api#documentation": "Enables Amazon CloudWatch logging for brokers.", - "smithy.api#jsonName": "logs" + "smithy.api#documentation": "The authentication strategy used to secure the broker.", + "smithy.api#jsonName": "authenticationStrategy" } }, - "HostInstanceType": { + "EngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The broker's instance type.", - "smithy.api#jsonName": "hostInstanceType" + "smithy.api#documentation": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", + "smithy.api#jsonName": "engineVersion" } }, "BrokerName": { @@ -637,26 +617,46 @@ "smithy.api#jsonName": "brokerName" } }, - "MaintenanceWindowStartTime": { - "target": "com.amazonaws.mq#WeeklyStartTime", + "SubnetIds": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "The parameters that determine the WeeklyStartTime.", - "smithy.api#jsonName": "maintenanceWindowStartTime" + "smithy.api#documentation": "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.", + "smithy.api#jsonName": "subnetIds" } }, - "CreatorRequestId": { - "target": "com.amazonaws.mq#__string", + "Users": { + "target": "com.amazonaws.mq#__listOfUser", "traits": { - "smithy.api#documentation": "The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "creatorRequestId" + "smithy.api#documentation": "Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#jsonName": "users" } }, - "SubnetIds": { - "target": "com.amazonaws.mq#__listOf__string", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.", - "smithy.api#jsonName": "subnetIds" + "smithy.api#documentation": "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.", + "smithy.api#jsonName": "autoMinorVersionUpgrade" + } + }, + "EngineType": { + "target": "com.amazonaws.mq#EngineType", + "traits": { + "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", + "smithy.api#jsonName": "engineType" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.", + "smithy.api#jsonName": "publiclyAccessible" + } + }, + "Configuration": { + "target": "com.amazonaws.mq#ConfigurationId", + "traits": { + "smithy.api#documentation": "A list of information about the configuration.", + "smithy.api#jsonName": "configuration" } } }, @@ -667,18 +667,18 @@ "com.amazonaws.mq#CreateBrokerResponse": { "type": "structure", "members": { - "BrokerId": { + "BrokerArn": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", - "smithy.api#jsonName": "brokerId" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the broker.", + "smithy.api#jsonName": "brokerArn" } }, - "BrokerArn": { + "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the broker.", - "smithy.api#jsonName": "brokerArn" + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#jsonName": "brokerId" } } } @@ -724,13 +724,6 @@ "smithy.api#jsonName": "engineVersion" } }, - "Tags": { - "target": "com.amazonaws.mq#__mapOf__string", - "traits": { - "smithy.api#documentation": "Create tags when creating the configuration.", - "smithy.api#jsonName": "tags" - } - }, "EngineType": { "target": "com.amazonaws.mq#EngineType", "traits": { @@ -738,19 +731,26 @@ "smithy.api#jsonName": "engineType" } }, - "AuthenticationStrategy": { - "target": "com.amazonaws.mq#AuthenticationStrategy", - "traits": { - "smithy.api#documentation": "The authentication strategy associated with the configuration.", - "smithy.api#jsonName": "authenticationStrategy" - } - }, "Name": { "target": "com.amazonaws.mq#__string", "traits": { "smithy.api#documentation": "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", "smithy.api#jsonName": "name" } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "Create tags when creating the configuration.", + "smithy.api#jsonName": "tags" + } + }, + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "The authentication strategy associated with the configuration.", + "smithy.api#jsonName": "authenticationStrategy" + } } }, "traits": { @@ -767,25 +767,25 @@ "smithy.api#jsonName": "authenticationStrategy" } }, - "LatestRevision": { - "target": "com.amazonaws.mq#ConfigurationRevision", + "Id": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The latest revision of the configuration.", - "smithy.api#jsonName": "latestRevision" + "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", + "smithy.api#jsonName": "id" } }, - "Arn": { - "target": "com.amazonaws.mq#__string", + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", "traits": { - "smithy.api#documentation": "Required. The Amazon Resource Name (ARN) of the configuration.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Required. The date and time of the configuration.", + "smithy.api#jsonName": "created" } }, - "Id": { + "Arn": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Required. The Amazon Resource Name (ARN) of the configuration.", + "smithy.api#jsonName": "arn" } }, "Name": { @@ -795,11 +795,11 @@ "smithy.api#jsonName": "name" } }, - "Created": { - "target": "com.amazonaws.mq#__timestampIso8601", + "LatestRevision": { + "target": "com.amazonaws.mq#ConfigurationRevision", "traits": { - "smithy.api#documentation": "Required. The date and time of the configuration.", - "smithy.api#jsonName": "created" + "smithy.api#documentation": "The latest revision of the configuration.", + "smithy.api#jsonName": "latestRevision" } } } @@ -833,15 +833,8 @@ } }, "com.amazonaws.mq#CreateTagsRequest": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.mq#__mapOf__string", - "traits": { - "smithy.api#documentation": "The key-value pair for the resource tag.", - "smithy.api#jsonName": "tags" - } - }, + "type": "structure", + "members": { "ResourceArn": { "target": "com.amazonaws.mq#__string", "traits": { @@ -849,6 +842,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", + "traits": { + "smithy.api#documentation": "The key-value pair for the resource tag.", + "smithy.api#jsonName": "tags" + } } }, "traits": { @@ -892,17 +892,17 @@ "com.amazonaws.mq#CreateUserRequest": { "type": "structure", "members": { - "Password": { - "target": "com.amazonaws.mq#__string", + "Groups": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.", - "smithy.api#jsonName": "password" + "smithy.api#documentation": "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#jsonName": "groups" } }, - "Username": { + "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -914,17 +914,17 @@ "smithy.api#jsonName": "consoleAccess" } }, - "Groups": { - "target": "com.amazonaws.mq#__listOf__string", + "Password": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", - "smithy.api#jsonName": "groups" + "smithy.api#documentation": "Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.", + "smithy.api#jsonName": "password" } }, - "BrokerId": { + "Username": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#documentation": "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1112,18 +1112,18 @@ "com.amazonaws.mq#DeleteUserRequest": { "type": "structure", "members": { - "BrokerId": { + "Username": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#documentation": "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Username": { + "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1212,6 +1212,13 @@ "com.amazonaws.mq#DescribeBrokerEngineTypesRequest": { "type": "structure", "members": { + "EngineType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "Filter response by engine type.", + "smithy.api#httpQuery": "engineType" + } + }, "MaxResults": { "target": "com.amazonaws.mq#MaxResults", "traits": { @@ -1225,24 +1232,17 @@ "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", "smithy.api#httpQuery": "nextToken" } - }, - "EngineType": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "Filter response by engine type.", - "smithy.api#httpQuery": "engineType" - } } } }, "com.amazonaws.mq#DescribeBrokerEngineTypesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mq#__string", + "MaxResults": { + "target": "com.amazonaws.mq#__integerMin5Max100", "traits": { - "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100.", + "smithy.api#jsonName": "maxResults" } }, "BrokerEngineTypes": { @@ -1252,11 +1252,11 @@ "smithy.api#jsonName": "brokerEngineTypes" } }, - "MaxResults": { - "target": "com.amazonaws.mq#__integerMin5Max100", + "NextToken": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100.", - "smithy.api#jsonName": "maxResults" + "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", + "smithy.api#jsonName": "nextToken" } } } @@ -1292,13 +1292,6 @@ "com.amazonaws.mq#DescribeBrokerInstanceOptionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", - "smithy.api#httpQuery": "nextToken" - } - }, "StorageType": { "target": "com.amazonaws.mq#__string", "traits": { @@ -1306,11 +1299,11 @@ "smithy.api#httpQuery": "storageType" } }, - "MaxResults": { - "target": "com.amazonaws.mq#MaxResults", + "EngineType": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The maximum number of instance options that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "Filter response by engine type.", + "smithy.api#httpQuery": "engineType" } }, "HostInstanceType": { @@ -1320,11 +1313,18 @@ "smithy.api#httpQuery": "hostInstanceType" } }, - "EngineType": { + "MaxResults": { + "target": "com.amazonaws.mq#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of instance options that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Filter response by engine type.", - "smithy.api#httpQuery": "engineType" + "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", + "smithy.api#httpQuery": "nextToken" } } } @@ -1371,39 +1371,32 @@ "com.amazonaws.mq#DescribeBrokerResponse": { "type": "structure", "members": { - "BrokerState": { - "target": "com.amazonaws.mq#BrokerState", - "traits": { - "smithy.api#documentation": "The status of the broker.", - "smithy.api#jsonName": "brokerState" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.mq#__listOf__string", + "BrokerArn": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", - "smithy.api#jsonName": "securityGroups" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the broker.", + "smithy.api#jsonName": "brokerArn" } }, - "PendingSecurityGroups": { - "target": "com.amazonaws.mq#__listOf__string", + "PendingLdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataOutput", "traits": { - "smithy.api#documentation": "The list of pending security groups to authorize connections to brokers.", - "smithy.api#jsonName": "pendingSecurityGroups" + "smithy.api#documentation": "The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.", + "smithy.api#jsonName": "pendingLdapServerMetadata" } }, - "BrokerInstances": { - "target": "com.amazonaws.mq#__listOfBrokerInstance", + "Tags": { + "target": "com.amazonaws.mq#__mapOf__string", "traits": { - "smithy.api#documentation": "A list of information about allocated brokers.", - "smithy.api#jsonName": "brokerInstances" + "smithy.api#documentation": "The list of all tags associated with this broker.", + "smithy.api#jsonName": "tags" } }, - "AuthenticationStrategy": { - "target": "com.amazonaws.mq#AuthenticationStrategy", + "PubliclyAccessible": { + "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "The authentication strategy used to secure the broker.", - "smithy.api#jsonName": "authenticationStrategy" + "smithy.api#documentation": "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.", + "smithy.api#jsonName": "publiclyAccessible" } }, "Users": { @@ -1413,95 +1406,95 @@ "smithy.api#jsonName": "users" } }, - "SubnetIds": { - "target": "com.amazonaws.mq#__listOf__string", + "EngineType": { + "target": "com.amazonaws.mq#EngineType", "traits": { - "smithy.api#documentation": "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.", - "smithy.api#jsonName": "subnetIds" + "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", + "smithy.api#jsonName": "engineType" } }, - "Created": { - "target": "com.amazonaws.mq#__timestampIso8601", + "EncryptionOptions": { + "target": "com.amazonaws.mq#EncryptionOptions", "traits": { - "smithy.api#documentation": "The time when the broker was created.", - "smithy.api#jsonName": "created" + "smithy.api#documentation": "Encryption options for the broker.", + "smithy.api#jsonName": "encryptionOptions" } }, - "PendingHostInstanceType": { - "target": "com.amazonaws.mq#__string", + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types", - "smithy.api#jsonName": "pendingHostInstanceType" + "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", + "smithy.api#jsonName": "securityGroups" } }, - "DeploymentMode": { - "target": "com.amazonaws.mq#DeploymentMode", + "BrokerInstances": { + "target": "com.amazonaws.mq#__listOfBrokerInstance", "traits": { - "smithy.api#documentation": "Required. The deployment mode of the broker.", - "smithy.api#jsonName": "deploymentMode" + "smithy.api#documentation": "A list of information about allocated brokers.", + "smithy.api#jsonName": "brokerInstances" } }, - "EngineType": { - "target": "com.amazonaws.mq#EngineType", + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", - "smithy.api#jsonName": "engineType" + "smithy.api#documentation": "The broker's instance type.", + "smithy.api#jsonName": "hostInstanceType" } }, - "Configurations": { - "target": "com.amazonaws.mq#Configurations", + "PendingEngineVersion": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The list of all revisions for the specified configuration.", - "smithy.api#jsonName": "configurations" + "smithy.api#documentation": "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", + "smithy.api#jsonName": "pendingEngineVersion" } }, - "EncryptionOptions": { - "target": "com.amazonaws.mq#EncryptionOptions", + "PendingSecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "Encryption options for the broker.", - "smithy.api#jsonName": "encryptionOptions" + "smithy.api#documentation": "The list of pending security groups to authorize connections to brokers.", + "smithy.api#jsonName": "pendingSecurityGroups" } }, - "PendingEngineVersion": { - "target": "com.amazonaws.mq#__string", + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", "traits": { - "smithy.api#documentation": "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", - "smithy.api#jsonName": "pendingEngineVersion" + "smithy.api#documentation": "The time when the broker was created.", + "smithy.api#jsonName": "created" } }, - "Tags": { - "target": "com.amazonaws.mq#__mapOf__string", + "Configurations": { + "target": "com.amazonaws.mq#Configurations", "traits": { - "smithy.api#documentation": "The list of all tags associated with this broker.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The list of all revisions for the specified configuration.", + "smithy.api#jsonName": "configurations" } }, - "EngineVersion": { - "target": "com.amazonaws.mq#__string", + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", "traits": { - "smithy.api#documentation": "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", - "smithy.api#jsonName": "engineVersion" + "smithy.api#documentation": "The authentication strategy used to secure the broker.", + "smithy.api#jsonName": "authenticationStrategy" } }, - "StorageType": { - "target": "com.amazonaws.mq#BrokerStorageType", + "DeploymentMode": { + "target": "com.amazonaws.mq#DeploymentMode", "traits": { - "smithy.api#documentation": "The broker's storage type.", - "smithy.api#jsonName": "storageType" + "smithy.api#documentation": "Required. The deployment mode of the broker.", + "smithy.api#jsonName": "deploymentMode" } }, - "BrokerId": { - "target": "com.amazonaws.mq#__string", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", - "smithy.api#jsonName": "brokerId" + "smithy.api#documentation": "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.", + "smithy.api#jsonName": "autoMinorVersionUpgrade" } }, - "PendingAuthenticationStrategy": { - "target": "com.amazonaws.mq#AuthenticationStrategy", + "Logs": { + "target": "com.amazonaws.mq#LogsSummary", "traits": { - "smithy.api#documentation": "The authentication strategy that will be applied when the broker is rebooted.", - "smithy.api#jsonName": "pendingAuthenticationStrategy" + "smithy.api#documentation": "The list of information about logs currently enabled and pending to be deployed for the specified broker.", + "smithy.api#jsonName": "logs" } }, "MaintenanceWindowStartTime": { @@ -1511,60 +1504,67 @@ "smithy.api#jsonName": "maintenanceWindowStartTime" } }, - "HostInstanceType": { + "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The broker's instance type.", - "smithy.api#jsonName": "hostInstanceType" + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#jsonName": "brokerId" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.mq#__boolean", + "PendingHostInstanceType": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.", - "smithy.api#jsonName": "autoMinorVersionUpgrade" + "smithy.api#documentation": "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types", + "smithy.api#jsonName": "pendingHostInstanceType" } }, - "Logs": { - "target": "com.amazonaws.mq#LogsSummary", + "LdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataOutput", "traits": { - "smithy.api#documentation": "The list of information about logs currently enabled and pending to be deployed for the specified broker.", - "smithy.api#jsonName": "logs" + "smithy.api#documentation": "The metadata of the LDAP server used to authenticate and authorize connections to the broker.", + "smithy.api#jsonName": "ldapServerMetadata" } }, - "BrokerName": { + "EngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.", - "smithy.api#jsonName": "brokerName" + "smithy.api#documentation": "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", + "smithy.api#jsonName": "engineVersion" } }, - "PendingLdapServerMetadata": { - "target": "com.amazonaws.mq#LdapServerMetadataOutput", + "StorageType": { + "target": "com.amazonaws.mq#BrokerStorageType", "traits": { - "smithy.api#documentation": "The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.", - "smithy.api#jsonName": "pendingLdapServerMetadata" + "smithy.api#documentation": "The broker's storage type.", + "smithy.api#jsonName": "storageType" } }, - "LdapServerMetadata": { - "target": "com.amazonaws.mq#LdapServerMetadataOutput", + "PendingAuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", "traits": { - "smithy.api#documentation": "The metadata of the LDAP server used to authenticate and authorize connections to the broker.", - "smithy.api#jsonName": "ldapServerMetadata" + "smithy.api#documentation": "The authentication strategy that will be applied when the broker is rebooted.", + "smithy.api#jsonName": "pendingAuthenticationStrategy" } }, - "PubliclyAccessible": { - "target": "com.amazonaws.mq#__boolean", + "BrokerState": { + "target": "com.amazonaws.mq#BrokerState", "traits": { - "smithy.api#documentation": "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.", - "smithy.api#jsonName": "publiclyAccessible" + "smithy.api#documentation": "The status of the broker.", + "smithy.api#jsonName": "brokerState" } }, - "BrokerArn": { + "BrokerName": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the broker.", - "smithy.api#jsonName": "brokerArn" + "smithy.api#documentation": "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.", + "smithy.api#jsonName": "brokerName" + } + }, + "SubnetIds": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.", + "smithy.api#jsonName": "subnetIds" } } } @@ -1616,11 +1616,11 @@ "com.amazonaws.mq#DescribeConfigurationResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.mq#__string", + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", "traits": { - "smithy.api#documentation": "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "Required. The date and time of the configuration revision.", + "smithy.api#jsonName": "created" } }, "Tags": { @@ -1630,18 +1630,18 @@ "smithy.api#jsonName": "tags" } }, - "EngineType": { - "target": "com.amazonaws.mq#EngineType", + "EngineVersion": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", - "smithy.api#jsonName": "engineType" + "smithy.api#documentation": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", + "smithy.api#jsonName": "engineVersion" } }, - "AuthenticationStrategy": { - "target": "com.amazonaws.mq#AuthenticationStrategy", + "Description": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The authentication strategy associated with the configuration.", - "smithy.api#jsonName": "authenticationStrategy" + "smithy.api#documentation": "Required. The description of the configuration.", + "smithy.api#jsonName": "description" } }, "LatestRevision": { @@ -1651,39 +1651,39 @@ "smithy.api#jsonName": "latestRevision" } }, - "Arn": { - "target": "com.amazonaws.mq#__string", + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", "traits": { - "smithy.api#documentation": "Required. The ARN of the configuration.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The authentication strategy associated with the configuration.", + "smithy.api#jsonName": "authenticationStrategy" } }, - "Created": { - "target": "com.amazonaws.mq#__timestampIso8601", + "Id": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The date and time of the configuration revision.", - "smithy.api#jsonName": "created" + "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", + "smithy.api#jsonName": "id" } }, - "EngineVersion": { + "Arn": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html", - "smithy.api#jsonName": "engineVersion" + "smithy.api#documentation": "Required. The ARN of the configuration.", + "smithy.api#jsonName": "arn" } }, - "Description": { - "target": "com.amazonaws.mq#__string", + "EngineType": { + "target": "com.amazonaws.mq#EngineType", "traits": { - "smithy.api#documentation": "Required. The description of the configuration.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.", + "smithy.api#jsonName": "engineType" } }, - "Id": { + "Name": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", + "smithy.api#jsonName": "name" } } } @@ -1722,18 +1722,18 @@ "com.amazonaws.mq#DescribeConfigurationRevisionRequest": { "type": "structure", "members": { - "ConfigurationRevision": { + "ConfigurationId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The revision of the configuration.", + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the configuration.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ConfigurationId": { + "ConfigurationRevision": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the configuration.", + "smithy.api#documentation": "The revision of the configuration.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1750,11 +1750,11 @@ "smithy.api#jsonName": "configurationId" } }, - "Data": { - "target": "com.amazonaws.mq#__string", + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", "traits": { - "smithy.api#documentation": "Required. The base64-encoded XML configuration.", - "smithy.api#jsonName": "data" + "smithy.api#documentation": "Required. The date and time of the configuration.", + "smithy.api#jsonName": "created" } }, "Description": { @@ -1764,11 +1764,11 @@ "smithy.api#jsonName": "description" } }, - "Created": { - "target": "com.amazonaws.mq#__timestampIso8601", + "Data": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The date and time of the configuration.", - "smithy.api#jsonName": "created" + "smithy.api#documentation": "Required. The base64-encoded XML configuration.", + "smithy.api#jsonName": "data" } } } @@ -1807,18 +1807,18 @@ "com.amazonaws.mq#DescribeUserRequest": { "type": "structure", "members": { - "Username": { + "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "BrokerId": { + "Username": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#documentation": "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1828,6 +1828,20 @@ "com.amazonaws.mq#DescribeUserResponse": { "type": "structure", "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the broker.", + "smithy.api#jsonName": "brokerId" + } + }, + "Pending": { + "target": "com.amazonaws.mq#UserPendingChanges", + "traits": { + "smithy.api#documentation": "The status of the changes pending for the ActiveMQ user.", + "smithy.api#jsonName": "pending" + } + }, "ConsoleAccess": { "target": "com.amazonaws.mq#__boolean", "traits": { @@ -1848,26 +1862,19 @@ "smithy.api#documentation": "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", "smithy.api#jsonName": "username" } - }, - "BrokerId": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the broker.", - "smithy.api#jsonName": "brokerId" - } - }, - "Pending": { - "target": "com.amazonaws.mq#UserPendingChanges", - "traits": { - "smithy.api#documentation": "The status of the changes pending for the ActiveMQ user.", - "smithy.api#jsonName": "pending" - } } } }, "com.amazonaws.mq#EncryptionOptions": { "type": "structure", "members": { + "KmsKeyId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.", + "smithy.api#jsonName": "kmsKeyId" + } + }, "UseAwsOwnedKey": { "target": "com.amazonaws.mq#__boolean", "traits": { @@ -1875,13 +1882,6 @@ "smithy.api#jsonName": "useAwsOwnedKey", "smithy.api#required": {} } - }, - "KmsKeyId": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.", - "smithy.api#jsonName": "kmsKeyId" - } } }, "traits": { @@ -1942,18 +1942,18 @@ "com.amazonaws.mq#InternalServerErrorException": { "type": "structure", "members": { - "ErrorAttribute": { + "Message": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The attribute which caused the error.", - "smithy.api#jsonName": "errorAttribute" + "smithy.api#documentation": "The explanation of the error.", + "smithy.api#jsonName": "message" } }, - "Message": { + "ErrorAttribute": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The explanation of the error.", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "The attribute which caused the error.", + "smithy.api#jsonName": "errorAttribute" } } }, @@ -1966,81 +1966,81 @@ "com.amazonaws.mq#LdapServerMetadataInput": { "type": "structure", "members": { - "ServiceAccountUsername": { + "RoleName": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Service account username.", - "smithy.api#jsonName": "serviceAccountUsername" + "smithy.api#documentation": "Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.", + "smithy.api#jsonName": "roleName" } }, - "ServiceAccountPassword": { - "target": "com.amazonaws.mq#__string", + "RoleSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "Service account password.", - "smithy.api#jsonName": "serviceAccountPassword" + "smithy.api#documentation": "The directory search scope for the role. If set to true, scope is to search the entire sub-tree.", + "smithy.api#jsonName": "roleSearchSubtree" } }, - "UserRoleName": { - "target": "com.amazonaws.mq#__string", + "Hosts": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "Specifies the name of the LDAP attribute for the user group membership.", - "smithy.api#jsonName": "userRoleName" + "smithy.api#documentation": "Fully qualified domain name of the LDAP server. Optional failover server.", + "smithy.api#jsonName": "hosts" } }, - "UserBase": { - "target": "com.amazonaws.mq#__string", + "UserSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "Fully qualified name of the directory where you want to search for users.", - "smithy.api#jsonName": "userBase" + "smithy.api#documentation": "The directory search scope for the user. If set to true, scope is to search the entire sub-tree.", + "smithy.api#jsonName": "userSearchSubtree" } }, - "RoleName": { + "UserSearchMatching": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.", - "smithy.api#jsonName": "roleName" + "smithy.api#documentation": "The search criteria for users.", + "smithy.api#jsonName": "userSearchMatching" } }, - "RoleSearchMatching": { + "ServiceAccountPassword": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The search criteria for groups.", - "smithy.api#jsonName": "roleSearchMatching" + "smithy.api#documentation": "Service account password.", + "smithy.api#jsonName": "serviceAccountPassword" } }, - "RoleSearchSubtree": { - "target": "com.amazonaws.mq#__boolean", + "RoleBase": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The directory search scope for the role. If set to true, scope is to search the entire sub-tree.", - "smithy.api#jsonName": "roleSearchSubtree" + "smithy.api#documentation": "Fully qualified name of the directory to search for a user’s groups.", + "smithy.api#jsonName": "roleBase" } }, - "Hosts": { - "target": "com.amazonaws.mq#__listOf__string", + "UserBase": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Fully qualified domain name of the LDAP server. Optional failover server.", - "smithy.api#jsonName": "hosts" + "smithy.api#documentation": "Fully qualified name of the directory where you want to search for users.", + "smithy.api#jsonName": "userBase" } }, - "RoleBase": { + "ServiceAccountUsername": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Fully qualified name of the directory to search for a user’s groups.", - "smithy.api#jsonName": "roleBase" + "smithy.api#documentation": "Service account username.", + "smithy.api#jsonName": "serviceAccountUsername" } }, - "UserSearchSubtree": { - "target": "com.amazonaws.mq#__boolean", + "UserRoleName": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The directory search scope for the user. If set to true, scope is to search the entire sub-tree.", - "smithy.api#jsonName": "userSearchSubtree" + "smithy.api#documentation": "Specifies the name of the LDAP attribute for the user group membership.", + "smithy.api#jsonName": "userRoleName" } }, - "UserSearchMatching": { + "RoleSearchMatching": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The search criteria for users.", - "smithy.api#jsonName": "userSearchMatching" + "smithy.api#documentation": "The search criteria for groups.", + "smithy.api#jsonName": "roleSearchMatching" } } }, @@ -2051,46 +2051,46 @@ "com.amazonaws.mq#LdapServerMetadataOutput": { "type": "structure", "members": { - "Hosts": { - "target": "com.amazonaws.mq#__listOf__string", + "RoleSearchMatching": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Fully qualified domain name of the LDAP server. Optional failover server.", - "smithy.api#jsonName": "hosts" + "smithy.api#documentation": "The search criteria for groups.", + "smithy.api#jsonName": "roleSearchMatching" } }, - "RoleSearchSubtree": { - "target": "com.amazonaws.mq#__boolean", + "RoleBase": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The directory search scope for the role. If set to true, scope is to search the entire sub-tree.", - "smithy.api#jsonName": "roleSearchSubtree" + "smithy.api#documentation": "Fully qualified name of the directory to search for a user’s groups.", + "smithy.api#jsonName": "roleBase" } }, - "UserBase": { - "target": "com.amazonaws.mq#__string", + "Hosts": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "Fully qualified name of the directory where you want to search for users.", - "smithy.api#jsonName": "userBase" + "smithy.api#documentation": "Fully qualified domain name of the LDAP server. Optional failover server.", + "smithy.api#jsonName": "hosts" } }, - "RoleSearchMatching": { + "RoleName": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The search criteria for groups.", - "smithy.api#jsonName": "roleSearchMatching" + "smithy.api#documentation": "Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.", + "smithy.api#jsonName": "roleName" } }, - "UserRoleName": { + "UserSearchMatching": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Specifies the name of the LDAP attribute for the user group membership.", - "smithy.api#jsonName": "userRoleName" + "smithy.api#documentation": "The search criteria for users.", + "smithy.api#jsonName": "userSearchMatching" } }, - "RoleBase": { - "target": "com.amazonaws.mq#__string", + "UserSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "Fully qualified name of the directory to search for a user’s groups.", - "smithy.api#jsonName": "roleBase" + "smithy.api#documentation": "The directory search scope for the user. If set to true, scope is to search the entire sub-tree.", + "smithy.api#jsonName": "userSearchSubtree" } }, "ServiceAccountUsername": { @@ -2100,25 +2100,25 @@ "smithy.api#jsonName": "serviceAccountUsername" } }, - "UserSearchMatching": { - "target": "com.amazonaws.mq#__string", + "RoleSearchSubtree": { + "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "The search criteria for users.", - "smithy.api#jsonName": "userSearchMatching" + "smithy.api#documentation": "The directory search scope for the role. If set to true, scope is to search the entire sub-tree.", + "smithy.api#jsonName": "roleSearchSubtree" } }, - "UserSearchSubtree": { - "target": "com.amazonaws.mq#__boolean", + "UserRoleName": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The directory search scope for the user. If set to true, scope is to search the entire sub-tree.", - "smithy.api#jsonName": "userSearchSubtree" + "smithy.api#documentation": "Specifies the name of the LDAP attribute for the user group membership.", + "smithy.api#jsonName": "userRoleName" } }, - "RoleName": { + "UserBase": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.", - "smithy.api#jsonName": "roleName" + "smithy.api#documentation": "Fully qualified name of the directory where you want to search for users.", + "smithy.api#jsonName": "userBase" } } }, @@ -2151,6 +2151,12 @@ "method": "GET", "uri": "/v1/brokers", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "BrokerSummaries", + "pageSize": "MaxResults" } } }, @@ -2176,19 +2182,19 @@ "com.amazonaws.mq#ListBrokersResponse": { "type": "structure", "members": { - "BrokerSummaries": { - "target": "com.amazonaws.mq#__listOfBrokerSummary", - "traits": { - "smithy.api#documentation": "A list of information about all brokers.", - "smithy.api#jsonName": "brokerSummaries" - } - }, "NextToken": { "target": "com.amazonaws.mq#__string", "traits": { "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", "smithy.api#jsonName": "nextToken" } + }, + "BrokerSummaries": { + "target": "com.amazonaws.mq#__listOfBrokerSummary", + "traits": { + "smithy.api#documentation": "A list of information about all brokers.", + "smithy.api#jsonName": "brokerSummaries" + } } } }, @@ -2226,14 +2232,6 @@ "com.amazonaws.mq#ListConfigurationRevisionsRequest": { "type": "structure", "members": { - "ConfigurationId": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the configuration.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.mq#MaxResults", "traits": { @@ -2247,24 +2245,25 @@ "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", "smithy.api#httpQuery": "nextToken" } + }, + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the configuration.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.mq#ListConfigurationRevisionsResponse": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.mq#__integer", - "traits": { - "smithy.api#documentation": "The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.", - "smithy.api#jsonName": "maxResults" - } - }, - "Revisions": { - "target": "com.amazonaws.mq#__listOfConfigurationRevision", + "ConfigurationId": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The list of all revisions for the specified configuration.", - "smithy.api#jsonName": "revisions" + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the configuration.", + "smithy.api#jsonName": "configurationId" } }, "NextToken": { @@ -2274,11 +2273,18 @@ "smithy.api#jsonName": "nextToken" } }, - "ConfigurationId": { - "target": "com.amazonaws.mq#__string", + "Revisions": { + "target": "com.amazonaws.mq#__listOfConfigurationRevision", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the configuration.", - "smithy.api#jsonName": "configurationId" + "smithy.api#documentation": "The list of all revisions for the specified configuration.", + "smithy.api#jsonName": "revisions" + } + }, + "MaxResults": { + "target": "com.amazonaws.mq#__integer", + "traits": { + "smithy.api#documentation": "The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.", + "smithy.api#jsonName": "maxResults" } } } @@ -2333,6 +2339,13 @@ "com.amazonaws.mq#ListConfigurationsResponse": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.mq#__integer", + "traits": { + "smithy.api#documentation": "The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.", + "smithy.api#jsonName": "maxResults" + } + }, "NextToken": { "target": "com.amazonaws.mq#__string", "traits": { @@ -2346,13 +2359,6 @@ "smithy.api#documentation": "The list of all revisions for the specified configuration.", "smithy.api#jsonName": "configurations" } - }, - "MaxResults": { - "target": "com.amazonaws.mq#__integer", - "traits": { - "smithy.api#documentation": "The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.", - "smithy.api#jsonName": "maxResults" - } } } }, @@ -2446,6 +2452,14 @@ "com.amazonaws.mq#ListUsersRequest": { "type": "structure", "members": { + "BrokerId": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.mq#MaxResults", "traits": { @@ -2459,27 +2473,12 @@ "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", "smithy.api#httpQuery": "nextToken" } - }, - "BrokerId": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.mq#ListUsersResponse": { "type": "structure", "members": { - "BrokerId": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the broker.", - "smithy.api#jsonName": "brokerId" - } - }, "Users": { "target": "com.amazonaws.mq#__listOfUserSummary", "traits": { @@ -2487,11 +2486,11 @@ "smithy.api#jsonName": "users" } }, - "MaxResults": { - "target": "com.amazonaws.mq#__integerMin5Max100", + "BrokerId": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.", - "smithy.api#jsonName": "maxResults" + "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the broker.", + "smithy.api#jsonName": "brokerId" } }, "NextToken": { @@ -2500,24 +2499,31 @@ "smithy.api#documentation": "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.", "smithy.api#jsonName": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.mq#__integerMin5Max100", + "traits": { + "smithy.api#documentation": "Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.", + "smithy.api#jsonName": "maxResults" + } } } }, "com.amazonaws.mq#Logs": { "type": "structure", "members": { - "General": { + "Audit": { "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "Enables general logging.", - "smithy.api#jsonName": "general" + "smithy.api#documentation": "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.", + "smithy.api#jsonName": "audit" } }, - "Audit": { + "General": { "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.", - "smithy.api#jsonName": "audit" + "smithy.api#documentation": "Enables general logging.", + "smithy.api#jsonName": "general" } } }, @@ -2528,13 +2534,6 @@ "com.amazonaws.mq#LogsSummary": { "type": "structure", "members": { - "General": { - "target": "com.amazonaws.mq#__boolean", - "traits": { - "smithy.api#documentation": "Enables general logging.", - "smithy.api#jsonName": "general" - } - }, "Pending": { "target": "com.amazonaws.mq#PendingLogs", "traits": { @@ -2549,19 +2548,26 @@ "smithy.api#jsonName": "generalLogGroup" } }, - "AuditLogGroup": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The location of the CloudWatch Logs log group where audit logs are sent.", - "smithy.api#jsonName": "auditLogGroup" - } - }, "Audit": { "target": "com.amazonaws.mq#__boolean", "traits": { "smithy.api#documentation": "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.", "smithy.api#jsonName": "audit" } + }, + "General": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "Enables general logging.", + "smithy.api#jsonName": "general" + } + }, + "AuditLogGroup": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "The location of the CloudWatch Logs log group where audit logs are sent.", + "smithy.api#jsonName": "auditLogGroup" + } } }, "traits": { @@ -2580,18 +2586,18 @@ "com.amazonaws.mq#NotFoundException": { "type": "structure", "members": { - "ErrorAttribute": { + "Message": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The attribute which caused the error.", - "smithy.api#jsonName": "errorAttribute" + "smithy.api#documentation": "The explanation of the error.", + "smithy.api#jsonName": "message" } }, - "Message": { + "ErrorAttribute": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The explanation of the error.", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "The attribute which caused the error.", + "smithy.api#jsonName": "errorAttribute" } } }, @@ -2723,18 +2729,18 @@ "com.amazonaws.mq#UnauthorizedException": { "type": "structure", "members": { - "ErrorAttribute": { + "Message": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The attribute which caused the error.", - "smithy.api#jsonName": "errorAttribute" + "smithy.api#documentation": "The explanation of the error.", + "smithy.api#jsonName": "message" } }, - "Message": { + "ErrorAttribute": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The explanation of the error.", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "The attribute which caused the error.", + "smithy.api#jsonName": "errorAttribute" } } }, @@ -2781,6 +2787,20 @@ "com.amazonaws.mq#UpdateBrokerRequest": { "type": "structure", "members": { + "AuthenticationStrategy": { + "target": "com.amazonaws.mq#AuthenticationStrategy", + "traits": { + "smithy.api#documentation": "The authentication strategy used to secure the broker.", + "smithy.api#jsonName": "authenticationStrategy" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", + "smithy.api#jsonName": "securityGroups" + } + }, "EngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { @@ -2788,6 +2808,13 @@ "smithy.api#jsonName": "engineVersion" } }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.", + "smithy.api#jsonName": "autoMinorVersionUpgrade" + } + }, "Configuration": { "target": "com.amazonaws.mq#ConfigurationId", "traits": { @@ -2795,13 +2822,6 @@ "smithy.api#jsonName": "configuration" } }, - "SecurityGroups": { - "target": "com.amazonaws.mq#__listOf__string", - "traits": { - "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", - "smithy.api#jsonName": "securityGroups" - } - }, "LdapServerMetadata": { "target": "com.amazonaws.mq#LdapServerMetadataInput", "traits": { @@ -2809,13 +2829,6 @@ "smithy.api#jsonName": "ldapServerMetadata" } }, - "AuthenticationStrategy": { - "target": "com.amazonaws.mq#AuthenticationStrategy", - "traits": { - "smithy.api#documentation": "The authentication strategy used to secure the broker.", - "smithy.api#jsonName": "authenticationStrategy" - } - }, "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { @@ -2824,13 +2837,6 @@ "smithy.api#required": {} } }, - "HostInstanceType": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types", - "smithy.api#jsonName": "hostInstanceType" - } - }, "Logs": { "target": "com.amazonaws.mq#Logs", "traits": { @@ -2838,11 +2844,11 @@ "smithy.api#jsonName": "logs" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.mq#__boolean", + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.", - "smithy.api#jsonName": "autoMinorVersionUpgrade" + "smithy.api#documentation": "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types", + "smithy.api#jsonName": "hostInstanceType" } } }, @@ -2853,13 +2859,6 @@ "com.amazonaws.mq#UpdateBrokerResponse": { "type": "structure", "members": { - "Configuration": { - "target": "com.amazonaws.mq#ConfigurationId", - "traits": { - "smithy.api#documentation": "The ID of the updated configuration.", - "smithy.api#jsonName": "configuration" - } - }, "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { @@ -2867,25 +2866,18 @@ "smithy.api#jsonName": "brokerId" } }, - "Logs": { - "target": "com.amazonaws.mq#Logs", - "traits": { - "smithy.api#documentation": "The list of information about logs to be enabled for the specified broker.", - "smithy.api#jsonName": "logs" - } - }, - "HostInstanceType": { - "target": "com.amazonaws.mq#__string", + "LdapServerMetadata": { + "target": "com.amazonaws.mq#LdapServerMetadataOutput", "traits": { - "smithy.api#documentation": "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types", - "smithy.api#jsonName": "hostInstanceType" + "smithy.api#documentation": "The metadata of the LDAP server used to authenticate and authorize connections to the broker.", + "smithy.api#jsonName": "ldapServerMetadata" } }, - "SecurityGroups": { - "target": "com.amazonaws.mq#__listOf__string", + "Configuration": { + "target": "com.amazonaws.mq#ConfigurationId", "traits": { - "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", - "smithy.api#jsonName": "securityGroups" + "smithy.api#documentation": "The ID of the updated configuration.", + "smithy.api#jsonName": "configuration" } }, "AuthenticationStrategy": { @@ -2895,11 +2887,11 @@ "smithy.api#jsonName": "authenticationStrategy" } }, - "LdapServerMetadata": { - "target": "com.amazonaws.mq#LdapServerMetadataOutput", + "SecurityGroups": { + "target": "com.amazonaws.mq#__listOf__string", "traits": { - "smithy.api#documentation": "The metadata of the LDAP server used to authenticate and authorize connections to the broker.", - "smithy.api#jsonName": "ldapServerMetadata" + "smithy.api#documentation": "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.", + "smithy.api#jsonName": "securityGroups" } }, "EngineVersion": { @@ -2915,6 +2907,20 @@ "smithy.api#documentation": "The new value of automatic upgrades to new minor version for brokers.", "smithy.api#jsonName": "autoMinorVersionUpgrade" } + }, + "HostInstanceType": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types", + "smithy.api#jsonName": "hostInstanceType" + } + }, + "Logs": { + "target": "com.amazonaws.mq#Logs", + "traits": { + "smithy.api#documentation": "The list of information about logs to be enabled for the specified broker.", + "smithy.api#jsonName": "logs" + } } } }, @@ -2955,6 +2961,13 @@ "com.amazonaws.mq#UpdateConfigurationRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "The description of the configuration.", + "smithy.api#jsonName": "description" + } + }, "ConfigurationId": { "target": "com.amazonaws.mq#__string", "traits": { @@ -2969,13 +2982,6 @@ "smithy.api#documentation": "Required. The base64-encoded XML configuration.", "smithy.api#jsonName": "data" } - }, - "Description": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "The description of the configuration.", - "smithy.api#jsonName": "description" - } } }, "traits": { @@ -2985,25 +2991,18 @@ "com.amazonaws.mq#UpdateConfigurationResponse": { "type": "structure", "members": { - "Created": { - "target": "com.amazonaws.mq#__timestampIso8601", + "LatestRevision": { + "target": "com.amazonaws.mq#ConfigurationRevision", "traits": { - "smithy.api#documentation": "Required. The date and time of the configuration.", - "smithy.api#jsonName": "created" + "smithy.api#documentation": "The latest revision of the configuration.", + "smithy.api#jsonName": "latestRevision" } }, - "Name": { + "Id": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", - "smithy.api#jsonName": "name" - } - }, - "Warnings": { - "target": "com.amazonaws.mq#__listOfSanitizationWarning", - "traits": { - "smithy.api#documentation": "The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.", - "smithy.api#jsonName": "warnings" + "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", + "smithy.api#jsonName": "id" } }, "Arn": { @@ -3013,18 +3012,25 @@ "smithy.api#jsonName": "arn" } }, - "Id": { + "Warnings": { + "target": "com.amazonaws.mq#__listOfSanitizationWarning", + "traits": { + "smithy.api#documentation": "The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.", + "smithy.api#jsonName": "warnings" + } + }, + "Name": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The unique ID that Amazon MQ generates for the configuration.", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.", + "smithy.api#jsonName": "name" } }, - "LatestRevision": { - "target": "com.amazonaws.mq#ConfigurationRevision", + "Created": { + "target": "com.amazonaws.mq#__timestampIso8601", "traits": { - "smithy.api#documentation": "The latest revision of the configuration.", - "smithy.api#jsonName": "latestRevision" + "smithy.api#documentation": "Required. The date and time of the configuration.", + "smithy.api#jsonName": "created" } } } @@ -3066,13 +3072,6 @@ "com.amazonaws.mq#UpdateUserRequest": { "type": "structure", "members": { - "ConsoleAccess": { - "target": "com.amazonaws.mq#__boolean", - "traits": { - "smithy.api#documentation": "Enables access to the the ActiveMQ Web Console for the ActiveMQ user.", - "smithy.api#jsonName": "consoleAccess" - } - }, "Password": { "target": "com.amazonaws.mq#__string", "traits": { @@ -3080,10 +3079,10 @@ "smithy.api#jsonName": "password" } }, - "Username": { + "BrokerId": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3095,13 +3094,20 @@ "smithy.api#jsonName": "groups" } }, - "BrokerId": { + "Username": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The unique ID that Amazon MQ generates for the broker.", + "smithy.api#documentation": "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "ConsoleAccess": { + "target": "com.amazonaws.mq#__boolean", + "traits": { + "smithy.api#documentation": "Enables access to the the ActiveMQ Web Console for the ActiveMQ user.", + "smithy.api#jsonName": "consoleAccess" + } } }, "traits": { @@ -3115,20 +3121,6 @@ "com.amazonaws.mq#User": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.mq#__listOf__string", - "traits": { - "smithy.api#documentation": "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", - "smithy.api#jsonName": "groups" - } - }, - "Username": { - "target": "com.amazonaws.mq#__string", - "traits": { - "smithy.api#documentation": "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", - "smithy.api#jsonName": "username" - } - }, "ConsoleAccess": { "target": "com.amazonaws.mq#__boolean", "traits": { @@ -3142,6 +3134,20 @@ "smithy.api#documentation": "Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.", "smithy.api#jsonName": "password" } + }, + "Username": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#jsonName": "username" + } + }, + "Groups": { + "target": "com.amazonaws.mq#__listOf__string", + "traits": { + "smithy.api#documentation": "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", + "smithy.api#jsonName": "groups" + } } }, "traits": { @@ -3151,13 +3157,6 @@ "com.amazonaws.mq#UserPendingChanges": { "type": "structure", "members": { - "PendingChange": { - "target": "com.amazonaws.mq#ChangeType", - "traits": { - "smithy.api#documentation": "Required. The type of change pending for the ActiveMQ user.", - "smithy.api#jsonName": "pendingChange" - } - }, "ConsoleAccess": { "target": "com.amazonaws.mq#__boolean", "traits": { @@ -3165,6 +3164,13 @@ "smithy.api#jsonName": "consoleAccess" } }, + "PendingChange": { + "target": "com.amazonaws.mq#ChangeType", + "traits": { + "smithy.api#documentation": "Required. The type of change pending for the ActiveMQ user.", + "smithy.api#jsonName": "pendingChange" + } + }, "Groups": { "target": "com.amazonaws.mq#__listOf__string", "traits": { @@ -3180,19 +3186,19 @@ "com.amazonaws.mq#UserSummary": { "type": "structure", "members": { - "PendingChange": { - "target": "com.amazonaws.mq#ChangeType", - "traits": { - "smithy.api#documentation": "The type of change pending for the ActiveMQ user.", - "smithy.api#jsonName": "pendingChange" - } - }, "Username": { "target": "com.amazonaws.mq#__string", "traits": { "smithy.api#documentation": "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.", "smithy.api#jsonName": "username" } + }, + "PendingChange": { + "target": "com.amazonaws.mq#ChangeType", + "traits": { + "smithy.api#documentation": "The type of change pending for the ActiveMQ user.", + "smithy.api#jsonName": "pendingChange" + } } }, "traits": { @@ -3202,13 +3208,6 @@ "com.amazonaws.mq#WeeklyStartTime": { "type": "structure", "members": { - "DayOfWeek": { - "target": "com.amazonaws.mq#DayOfWeek", - "traits": { - "smithy.api#documentation": "Required. The day of the week.", - "smithy.api#jsonName": "dayOfWeek" - } - }, "TimeOfDay": { "target": "com.amazonaws.mq#__string", "traits": { @@ -3222,6 +3221,13 @@ "smithy.api#documentation": "The time zone, UTC by default, in either the Country/City format, or the UTC offset format.", "smithy.api#jsonName": "timeZone" } + }, + "DayOfWeek": { + "target": "com.amazonaws.mq#DayOfWeek", + "traits": { + "smithy.api#documentation": "Required. The day of the week.", + "smithy.api#jsonName": "dayOfWeek" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/mturk.2017-01-17.json b/codegen/sdk-codegen/aws-models/mturk.2017-01-17.json index c97126f66ef0..3cb7243466eb 100644 --- a/codegen/sdk-codegen/aws-models/mturk.2017-01-17.json +++ b/codegen/sdk-codegen/aws-models/mturk.2017-01-17.json @@ -95,10 +95,10 @@ "com.amazonaws.mturk#ApproveAssignmentRequest": { "type": "structure", "members": { - "OverrideRejection": { - "target": "com.amazonaws.mturk#Boolean", + "RequesterFeedback": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to False.\n

" + "smithy.api#documentation": "

\n A message for the Worker, which the Worker can see in the Status section of the web site.\n

" } }, "AssignmentId": { @@ -108,10 +108,10 @@ "smithy.api#required": {} } }, - "RequesterFeedback": { - "target": "com.amazonaws.mturk#String", + "OverrideRejection": { + "target": "com.amazonaws.mturk#Boolean", "traits": { - "smithy.api#documentation": "

\n A message for the Worker, which the Worker can see in the Status section of the web site.\n

" + "smithy.api#documentation": "

\n A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to False.\n

" } } } @@ -123,46 +123,40 @@ "com.amazonaws.mturk#Assignment": { "type": "structure", "members": { - "Deadline": { - "target": "com.amazonaws.mturk#Timestamp", + "AssignmentId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The date and time of the deadline for the assignment. This\n value is derived from the deadline specification for the HIT and the\n date and time the Worker accepted the HIT.

" + "smithy.api#documentation": "

A unique identifier for the assignment.

" } }, - "AutoApprovalTime": { + "Deadline": { "target": "com.amazonaws.mturk#Timestamp", "traits": { - "smithy.api#documentation": "

If results have been submitted, AutoApprovalTime is the date\n and time the results of the assignment results are considered\n Approved automatically if they have not already been explicitly\n approved or rejected by the Requester. This value is derived from the\n auto-approval delay specified by the Requester in the HIT. This value\n is omitted from the assignment if the Worker has not yet submitted\n results.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.mturk#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment.

" + "smithy.api#documentation": "

The date and time of the deadline for the assignment. This\n value is derived from the deadline specification for the HIT and the\n date and time the Worker accepted the HIT.

" } }, - "AssignmentId": { - "target": "com.amazonaws.mturk#EntityId", + "WorkerId": { + "target": "com.amazonaws.mturk#CustomerId", "traits": { - "smithy.api#documentation": "

A unique identifier for the assignment.

" + "smithy.api#documentation": "

The ID of the Worker who accepted the HIT.

" } }, - "HITId": { - "target": "com.amazonaws.mturk#EntityId", + "RejectionTime": { + "target": "com.amazonaws.mturk#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the HIT.

" + "smithy.api#documentation": "

If the Worker has submitted results and the Requester has\n rejected the results, RejectionTime is the date and time the\n Requester rejected the results.

" } }, - "AcceptTime": { + "SubmitTime": { "target": "com.amazonaws.mturk#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time the Worker accepted the assignment.

" + "smithy.api#documentation": "

If the Worker has submitted results, SubmitTime is the date\n and time the assignment was submitted. This value is omitted from the\n assignment if the Worker has not yet submitted results.

" } }, - "ApprovalTime": { - "target": "com.amazonaws.mturk#Timestamp", + "Answer": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

If the Worker has submitted results and the Requester has\n approved the results, ApprovalTime is the date and time the Requester\n approved the results. This value is omitted from the assignment if\n the Requester has not yet approved the results.

" + "smithy.api#documentation": "

The Worker's answers submitted for the HIT contained in a\n QuestionFormAnswers document, if the Worker provides an answer. If\n the Worker does not provide any answers, Answer may contain a\n QuestionFormAnswers document, or Answer may be empty.

" } }, "RequesterFeedback": { @@ -171,28 +165,34 @@ "smithy.api#documentation": "

The feedback string included with the call to the\n ApproveAssignment operation or the RejectAssignment operation, if the\n Requester approved or rejected the assignment and specified feedback.

" } }, - "SubmitTime": { - "target": "com.amazonaws.mturk#Timestamp", + "AssignmentStatus": { + "target": "com.amazonaws.mturk#AssignmentStatus", "traits": { - "smithy.api#documentation": "

If the Worker has submitted results, SubmitTime is the date\n and time the assignment was submitted. This value is omitted from the\n assignment if the Worker has not yet submitted results.

" + "smithy.api#documentation": "

The status of the assignment.

" } }, - "WorkerId": { - "target": "com.amazonaws.mturk#CustomerId", + "HITId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the Worker who accepted the HIT.

" + "smithy.api#documentation": "

The ID of the HIT.

" } }, - "Answer": { - "target": "com.amazonaws.mturk#String", + "AutoApprovalTime": { + "target": "com.amazonaws.mturk#Timestamp", "traits": { - "smithy.api#documentation": "

The Worker's answers submitted for the HIT contained in a\n QuestionFormAnswers document, if the Worker provides an answer. If\n the Worker does not provide any answers, Answer may contain a\n QuestionFormAnswers document, or Answer may be empty.

" + "smithy.api#documentation": "

If results have been submitted, AutoApprovalTime is the date\n and time the results of the assignment results are considered\n Approved automatically if they have not already been explicitly\n approved or rejected by the Requester. This value is derived from the\n auto-approval delay specified by the Requester in the HIT. This value\n is omitted from the assignment if the Worker has not yet submitted\n results.

" } }, - "RejectionTime": { + "AcceptTime": { "target": "com.amazonaws.mturk#Timestamp", "traits": { - "smithy.api#documentation": "

If the Worker has submitted results and the Requester has\n rejected the results, RejectionTime is the date and time the\n Requester rejected the results.

" + "smithy.api#documentation": "

The date and time the Worker accepted the assignment.

" + } + }, + "ApprovalTime": { + "target": "com.amazonaws.mturk#Timestamp", + "traits": { + "smithy.api#documentation": "

If the Worker has submitted results and the Requester has\n approved the results, ApprovalTime is the date and time the Requester\n approved the results. This value is omitted from the assignment if\n the Requester has not yet approved the results.

" } } }, @@ -254,30 +254,30 @@ "com.amazonaws.mturk#AssociateQualificationWithWorkerRequest": { "type": "structure", "members": { - "IntegerValue": { - "target": "com.amazonaws.mturk#Integer", + "SendNotification": { + "target": "com.amazonaws.mturk#Boolean", "traits": { - "smithy.api#documentation": "

The value of the Qualification to assign.

" + "smithy.api#documentation": "

\n Specifies whether to send a notification email message to the Worker\n saying that the qualification was assigned to the Worker.\n Note: this is true by default.\n

" } }, - "QualificationTypeId": { - "target": "com.amazonaws.mturk#EntityId", + "WorkerId": { + "target": "com.amazonaws.mturk#CustomerId", "traits": { - "smithy.api#documentation": "

The ID of the Qualification type to use for the assigned Qualification.

", + "smithy.api#documentation": "

\n The ID of the Worker to whom the Qualification is being assigned.\n Worker IDs are included with submitted HIT assignments and Qualification requests.\n

", "smithy.api#required": {} } }, - "WorkerId": { - "target": "com.amazonaws.mturk#CustomerId", + "QualificationTypeId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

\n The ID of the Worker to whom the Qualification is being assigned.\n Worker IDs are included with submitted HIT assignments and Qualification requests.\n

", + "smithy.api#documentation": "

The ID of the Qualification type to use for the assigned Qualification.

", "smithy.api#required": {} } }, - "SendNotification": { - "target": "com.amazonaws.mturk#Boolean", + "IntegerValue": { + "target": "com.amazonaws.mturk#Integer", "traits": { - "smithy.api#documentation": "

\n Specifies whether to send a notification email message to the Worker\n saying that the qualification was assigned to the Worker.\n Note: this is true by default.\n

" + "smithy.api#documentation": "

The value of the Qualification to assign.

" } } } @@ -301,8 +301,11 @@ "smithy.api#documentation": "

The date and time of when the bonus was granted.

" } }, - "BonusAmount": { - "target": "com.amazonaws.mturk#CurrencyAmount" + "AssignmentId": { + "target": "com.amazonaws.mturk#EntityId", + "traits": { + "smithy.api#documentation": "

The ID of the assignment associated with this bonus payment.

" + } }, "WorkerId": { "target": "com.amazonaws.mturk#CustomerId", @@ -310,11 +313,8 @@ "smithy.api#documentation": "

The ID of the Worker to whom the bonus was paid.

" } }, - "AssignmentId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

The ID of the assignment associated with this bonus payment.

" - } + "BonusAmount": { + "target": "com.amazonaws.mturk#CurrencyAmount" } }, "traits": { @@ -461,30 +461,23 @@ "com.amazonaws.mturk#CreateHITRequest": { "type": "structure", "members": { - "HITLayoutId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

\n The HITLayoutId allows you to use a pre-existing HIT design with placeholder values\n and create an additional HIT by providing those values as HITLayoutParameters.\n

\n

\n Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.\n

" - } - }, - "Description": { + "Question": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n A general description of the HIT. A description includes detailed information about the kind of task\n the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded\n view of search results, and in the HIT and assignment screens. A good description gives the user enough\n information to evaluate the HIT before accepting it.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The data the person completing the HIT uses to produce the results.\n

\n

\n Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure,\n or an HTMLQuestion data structure. The XML question data must not be larger than\n 64 kilobytes (65,535 bytes) in size, including whitespace.\n

\n

Either a Question parameter or a HITLayoutId parameter must be provided.

" } }, - "Reward": { - "target": "com.amazonaws.mturk#CurrencyAmount", + "AutoApprovalDelayInSeconds": { + "target": "com.amazonaws.mturk#Long", "traits": { - "smithy.api#documentation": "

\n The amount of money the Requester will pay a Worker for successfully completing the HIT.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The number of seconds after an assignment for the HIT has been submitted,\n after which the assignment is considered Approved automatically\n unless the Requester explicitly rejects it.\n

" } }, - "QualificationRequirements": { - "target": "com.amazonaws.mturk#QualificationRequirementList", + "Title": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n Conditions that a Worker's Qualifications must meet in order\n to accept the HIT. A HIT can have between zero and ten\n Qualification requirements. All requirements must be met in\n order for a Worker to accept the HIT. Additionally, other\n actions can be restricted using the ActionsGuarded\n field on each QualificationRequirement structure.\n

" + "smithy.api#documentation": "

\n The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains.\n On the Amazon Mechanical Turk web site, the HIT title appears in search results,\n and everywhere the HIT is mentioned.\n

", + "smithy.api#required": {} } }, "LifetimeInSeconds": { @@ -494,18 +487,10 @@ "smithy.api#required": {} } }, - "AssignmentDurationInSeconds": { - "target": "com.amazonaws.mturk#Long", - "traits": { - "smithy.api#documentation": "

\n The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.\n If a Worker does not complete the assignment within the specified duration,\n the assignment is considered abandoned. If the HIT is still active\n (that is, its lifetime has not elapsed), the assignment becomes available\n for other users to find and accept.\n

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.mturk#String", + "AssignmentReviewPolicy": { + "target": "com.amazonaws.mturk#ReviewPolicy", "traits": { - "smithy.api#documentation": "

\n The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains.\n On the Amazon Mechanical Turk web site, the HIT title appears in search results,\n and everywhere the HIT is mentioned.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The Assignment-level Review Policy applies to the assignments under the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" } }, "UniqueRequestToken": { @@ -514,40 +499,43 @@ "smithy.api#documentation": "

\n A unique identifier for this request which allows you to retry the call\n on error without creating duplicate HITs.\n This is useful in cases such as network timeouts where it is unclear whether or not\n the call succeeded on the server.\n If the HIT already exists in the system from a previous call using the same UniqueRequestToken,\n subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error\n with a message containing the HITId.\n

\n \n

\n Note: It is your responsibility to ensure uniqueness of the token.\n The unique token expires after 24 hours. Subsequent calls using the same\n UniqueRequestToken made after the 24 hour limit could create duplicate HITs.\n

\n " } }, - "AutoApprovalDelayInSeconds": { - "target": "com.amazonaws.mturk#Long", + "HITLayoutParameters": { + "target": "com.amazonaws.mturk#HITLayoutParameterList", "traits": { - "smithy.api#documentation": "

\n The number of seconds after an assignment for the HIT has been submitted,\n after which the assignment is considered Approved automatically\n unless the Requester explicitly rejects it.\n

" + "smithy.api#documentation": "

\n If the HITLayoutId is provided, any placeholder values must be filled in with values\n using the HITLayoutParameter structure. For more information, see HITLayout.\n

" } }, - "Question": { - "target": "com.amazonaws.mturk#String", + "AssignmentDurationInSeconds": { + "target": "com.amazonaws.mturk#Long", "traits": { - "smithy.api#documentation": "

\n The data the person completing the HIT uses to produce the results.\n

\n

\n Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure,\n or an HTMLQuestion data structure. The XML question data must not be larger than\n 64 kilobytes (65,535 bytes) in size, including whitespace.\n

\n

Either a Question parameter or a HITLayoutId parameter must be provided.

" + "smithy.api#documentation": "

\n The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.\n If a Worker does not complete the assignment within the specified duration,\n the assignment is considered abandoned. If the HIT is still active\n (that is, its lifetime has not elapsed), the assignment becomes available\n for other users to find and accept.\n

", + "smithy.api#required": {} } }, - "HITReviewPolicy": { - "target": "com.amazonaws.mturk#ReviewPolicy", + "Description": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n The HIT-level Review Policy applies to the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" + "smithy.api#documentation": "

\n A general description of the HIT. A description includes detailed information about the kind of task\n the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded\n view of search results, and in the HIT and assignment screens. A good description gives the user enough\n information to evaluate the HIT before accepting it.\n

", + "smithy.api#required": {} } }, - "AssignmentReviewPolicy": { - "target": "com.amazonaws.mturk#ReviewPolicy", + "Reward": { + "target": "com.amazonaws.mturk#CurrencyAmount", "traits": { - "smithy.api#documentation": "

\n The Assignment-level Review Policy applies to the assignments under the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" + "smithy.api#documentation": "

\n The amount of money the Requester will pay a Worker for successfully completing the HIT.\n

", + "smithy.api#required": {} } }, - "RequesterAnnotation": { - "target": "com.amazonaws.mturk#String", + "QualificationRequirements": { + "target": "com.amazonaws.mturk#QualificationRequirementList", "traits": { - "smithy.api#documentation": "

\n An arbitrary data field.\n The RequesterAnnotation parameter lets your application attach arbitrary data\n to the HIT for tracking purposes.\n For example, this parameter could be an identifier internal to the Requester's application\n that corresponds with the HIT.\n

\n

\n The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT.\n It is not shown to the Worker, or any other Requester.\n

\n

\n The RequesterAnnotation parameter may be different for each HIT you submit.\n It does not affect how your HITs are grouped.\n

" + "smithy.api#documentation": "

\n Conditions that a Worker's Qualifications must meet in order\n to accept the HIT. A HIT can have between zero and ten\n Qualification requirements. All requirements must be met in\n order for a Worker to accept the HIT. Additionally, other\n actions can be restricted using the ActionsGuarded\n field on each QualificationRequirement structure.\n

" } }, - "HITLayoutParameters": { - "target": "com.amazonaws.mturk#HITLayoutParameterList", + "HITLayoutId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

\n If the HITLayoutId is provided, any placeholder values must be filled in with values\n using the HITLayoutParameter structure. For more information, see HITLayout.\n

" + "smithy.api#documentation": "

\n The HITLayoutId allows you to use a pre-existing HIT design with placeholder values\n and create an additional HIT by providing those values as HITLayoutParameters.\n

\n

\n Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.\n

" } }, "MaxAssignments": { @@ -561,6 +549,18 @@ "traits": { "smithy.api#documentation": "

\n One or more words or phrases that describe the HIT, separated by commas.\n These words are used in searches to find HITs.\n

" } + }, + "RequesterAnnotation": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

\n An arbitrary data field.\n The RequesterAnnotation parameter lets your application attach arbitrary data\n to the HIT for tracking purposes.\n For example, this parameter could be an identifier internal to the Requester's application\n that corresponds with the HIT.\n

\n

\n The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT.\n It is not shown to the Worker, or any other Requester.\n

\n

\n The RequesterAnnotation parameter may be different for each HIT you submit.\n It does not affect how your HITs are grouped.\n

" + } + }, + "HITReviewPolicy": { + "target": "com.amazonaws.mturk#ReviewPolicy", + "traits": { + "smithy.api#documentation": "

\n The HIT-level Review Policy applies to the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" + } } } }, @@ -606,17 +606,17 @@ "smithy.api#required": {} } }, - "QualificationRequirements": { - "target": "com.amazonaws.mturk#QualificationRequirementList", + "Reward": { + "target": "com.amazonaws.mturk#CurrencyAmount", "traits": { - "smithy.api#documentation": "

\n Conditions that a Worker's Qualifications must meet in order\n to accept the HIT. A HIT can have between zero and ten\n Qualification requirements. All requirements must be met in\n order for a Worker to accept the HIT. Additionally, other\n actions can be restricted using the ActionsGuarded\n field on each QualificationRequirement structure.\n

" + "smithy.api#documentation": "

\n The amount of money the Requester will pay a Worker for successfully completing the HIT.\n

", + "smithy.api#required": {} } }, - "AssignmentDurationInSeconds": { - "target": "com.amazonaws.mturk#Long", + "QualificationRequirements": { + "target": "com.amazonaws.mturk#QualificationRequirementList", "traits": { - "smithy.api#documentation": "

\n The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.\n If a Worker does not complete the assignment within the specified duration,\n the assignment is considered abandoned. If the HIT is still active\n (that is, its lifetime has not elapsed), the assignment becomes available\n for other users to find and accept.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n Conditions that a Worker's Qualifications must meet in order\n to accept the HIT. A HIT can have between zero and ten\n Qualification requirements. All requirements must be met in\n order for a Worker to accept the HIT. Additionally, other\n actions can be restricted using the ActionsGuarded\n field on each QualificationRequirement structure.\n

" } }, "Keywords": { @@ -625,24 +625,24 @@ "smithy.api#documentation": "

\n One or more words or phrases that describe the HIT, separated by commas.\n These words are used in searches to find HITs.\n

" } }, - "Title": { - "target": "com.amazonaws.mturk#String", + "AutoApprovalDelayInSeconds": { + "target": "com.amazonaws.mturk#Long", "traits": { - "smithy.api#documentation": "

\n The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains.\n On the Amazon Mechanical Turk web site, the HIT title appears in search results,\n and everywhere the HIT is mentioned.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The number of seconds after an assignment for the HIT has been submitted,\n after which the assignment is considered Approved automatically\n unless the Requester explicitly rejects it.\n

" } }, - "Reward": { - "target": "com.amazonaws.mturk#CurrencyAmount", + "Title": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n The amount of money the Requester will pay a Worker for successfully completing the HIT.\n

", + "smithy.api#documentation": "

\n The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains.\n On the Amazon Mechanical Turk web site, the HIT title appears in search results,\n and everywhere the HIT is mentioned.\n

", "smithy.api#required": {} } }, - "AutoApprovalDelayInSeconds": { + "AssignmentDurationInSeconds": { "target": "com.amazonaws.mturk#Long", "traits": { - "smithy.api#documentation": "

\n The number of seconds after an assignment for the HIT has been submitted,\n after which the assignment is considered Approved automatically\n unless the Requester explicitly rejects it.\n

" + "smithy.api#documentation": "

\n The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.\n If a Worker does not complete the assignment within the specified duration,\n the assignment is considered abandoned. If the HIT is still active\n (that is, its lifetime has not elapsed), the assignment becomes available\n for other users to find and accept.\n

", + "smithy.api#required": {} } } } @@ -681,22 +681,30 @@ "com.amazonaws.mturk#CreateHITWithHITTypeRequest": { "type": "structure", "members": { - "AssignmentReviewPolicy": { - "target": "com.amazonaws.mturk#ReviewPolicy", + "MaxAssignments": { + "target": "com.amazonaws.mturk#Integer", "traits": { - "smithy.api#documentation": "

\n The Assignment-level Review Policy applies to the assignments under the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" + "smithy.api#documentation": "

\n The number of times the HIT can be accepted and completed before the HIT becomes unavailable.\n

" } }, - "HITLayoutParameters": { - "target": "com.amazonaws.mturk#HITLayoutParameterList", + "LifetimeInSeconds": { + "target": "com.amazonaws.mturk#Long", "traits": { - "smithy.api#documentation": "

\n If the HITLayoutId is provided, any placeholder values must be filled in with values\n using the HITLayoutParameter structure. For more information, see HITLayout.\n

" + "smithy.api#documentation": "

\n An amount of time, in seconds, after which the HIT is no longer available for users to accept.\n After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches,\n even if not all of the assignments for the HIT have been accepted.\n

", + "smithy.api#required": {} } }, - "MaxAssignments": { - "target": "com.amazonaws.mturk#Integer", + "HITTypeId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

\n The number of times the HIT can be accepted and completed before the HIT becomes unavailable.\n

" + "smithy.api#documentation": "

The HIT type ID you want to create this HIT with.

", + "smithy.api#required": {} + } + }, + "HITLayoutParameters": { + "target": "com.amazonaws.mturk#HITLayoutParameterList", + "traits": { + "smithy.api#documentation": "

\n If the HITLayoutId is provided, any placeholder values must be filled in with values\n using the HITLayoutParameter structure. For more information, see HITLayout.\n

" } }, "UniqueRequestToken": { @@ -705,11 +713,10 @@ "smithy.api#documentation": "

\n A unique identifier for this request which allows you to retry the call\n on error without creating duplicate HITs.\n This is useful in cases such as network timeouts where it is unclear whether or not\n the call succeeded on the server.\n If the HIT already exists in the system from a previous call using the same UniqueRequestToken,\n subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error\n with a message containing the HITId.\n

\n \n

\n Note: It is your responsibility to ensure uniqueness of the token.\n The unique token expires after 24 hours. Subsequent calls using the same\n UniqueRequestToken made after the 24 hour limit could create duplicate HITs.\n

\n " } }, - "HITTypeId": { - "target": "com.amazonaws.mturk#EntityId", + "AssignmentReviewPolicy": { + "target": "com.amazonaws.mturk#ReviewPolicy", "traits": { - "smithy.api#documentation": "

The HIT type ID you want to create this HIT with.

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The Assignment-level Review Policy applies to the assignments under the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" } }, "RequesterAnnotation": { @@ -718,10 +725,10 @@ "smithy.api#documentation": "

\n An arbitrary data field.\n The RequesterAnnotation parameter lets your application attach arbitrary data\n to the HIT for tracking purposes.\n For example, this parameter could be an identifier internal to the Requester's application\n that corresponds with the HIT.\n

\n

\n The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT.\n It is not shown to the Worker, or any other Requester.\n

\n

\n The RequesterAnnotation parameter may be different for each HIT you submit.\n It does not affect how your HITs are grouped.\n

" } }, - "Question": { - "target": "com.amazonaws.mturk#String", + "HITReviewPolicy": { + "target": "com.amazonaws.mturk#ReviewPolicy", "traits": { - "smithy.api#documentation": "

\n The data the person completing the HIT uses to produce the results.\n

\n

\n Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure,\n or an HTMLQuestion data structure. The XML question data must not be larger than\n 64 kilobytes (65,535 bytes) in size, including whitespace.\n

\n

Either a Question parameter or a HITLayoutId parameter must be provided.

" + "smithy.api#documentation": "

\n The HIT-level Review Policy applies to the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" } }, "HITLayoutId": { @@ -730,17 +737,10 @@ "smithy.api#documentation": "

\n The HITLayoutId allows you to use a pre-existing HIT design with placeholder values\n and create an additional HIT by providing those values as HITLayoutParameters.\n

\n

\n Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.\n

" } }, - "HITReviewPolicy": { - "target": "com.amazonaws.mturk#ReviewPolicy", - "traits": { - "smithy.api#documentation": "

\n The HIT-level Review Policy applies to the HIT.\n You can specify for Mechanical Turk to take various actions based on the policy.\n

" - } - }, - "LifetimeInSeconds": { - "target": "com.amazonaws.mturk#Long", + "Question": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n An amount of time, in seconds, after which the HIT is no longer available for users to accept.\n After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches,\n even if not all of the assignments for the HIT have been accepted.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The data the person completing the HIT uses to produce the results.\n

\n

\n Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure,\n or an HTMLQuestion data structure. The XML question data must not be larger than\n 64 kilobytes (65,535 bytes) in size, including whitespace.\n

\n

Either a Question parameter or a HITLayoutId parameter must be provided.

" } } } @@ -779,6 +779,12 @@ "com.amazonaws.mturk#CreateQualificationTypeRequest": { "type": "structure", "members": { + "Test": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

\n The questions for the Qualification test a Worker must answer\n correctly to obtain a Qualification of this type. If this parameter\n is specified,\n TestDurationInSeconds\n must also be specified.\n

\n

Constraints: Must not be longer than 65535 bytes. Must be a\n QuestionForm data structure. This parameter cannot be specified if\n AutoGranted is true.

\n

Constraints: None. If not specified, the Worker may request\n the Qualification without answering any questions.

" + } + }, "Description": { "target": "com.amazonaws.mturk#String", "traits": { @@ -792,17 +798,23 @@ "smithy.api#documentation": "

The answers to the Qualification test specified in the Test\n parameter, in the form of an AnswerKey data structure.

\n

Constraints: Must not be longer than 65535 bytes.

\n

Constraints: None. If not specified, you must process\n Qualification requests manually.

" } }, - "QualificationTypeStatus": { - "target": "com.amazonaws.mturk#QualificationTypeStatus", + "Name": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The initial status of the Qualification type.

\n

Constraints: Valid values are: Active | Inactive

", + "smithy.api#documentation": "

The name you give to the Qualification type. The type name\n is used to represent the Qualification to Workers, and to find the\n type using a Qualification type search. It must be unique across all\n of your Qualification types.

", "smithy.api#required": {} } }, - "Test": { + "AutoGranted": { + "target": "com.amazonaws.mturk#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether requests for the Qualification type are\n granted immediately, without prompting the Worker with a\n Qualification test.

\n

Constraints: If the Test parameter is specified, this\n parameter cannot be true.

" + } + }, + "Keywords": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n The questions for the Qualification test a Worker must answer\n correctly to obtain a Qualification of this type. If this parameter\n is specified,\n TestDurationInSeconds\n must also be specified.\n

\n

Constraints: Must not be longer than 65535 bytes. Must be a\n QuestionForm data structure. This parameter cannot be specified if\n AutoGranted is true.

\n

Constraints: None. If not specified, the Worker may request\n the Qualification without answering any questions.

" + "smithy.api#documentation": "

One or more words or phrases that describe the Qualification\n type, separated by commas. The keywords of a type make the type\n easier to find during a search.

" } }, "TestDurationInSeconds": { @@ -811,6 +823,13 @@ "smithy.api#documentation": "

The number of seconds the Worker has to complete the\n Qualification test, starting from the time the Worker requests the\n Qualification.

" } }, + "QualificationTypeStatus": { + "target": "com.amazonaws.mturk#QualificationTypeStatus", + "traits": { + "smithy.api#documentation": "

The initial status of the Qualification type.

\n

Constraints: Valid values are: Active | Inactive

", + "smithy.api#required": {} + } + }, "AutoGrantedValue": { "target": "com.amazonaws.mturk#Integer", "traits": { @@ -822,25 +841,6 @@ "traits": { "smithy.api#documentation": "

The number of seconds that a Worker must wait after\n requesting a Qualification of the Qualification type before the\n worker can retry the Qualification request.

\n

Constraints: None. If not specified, retries are disabled and\n Workers can request a Qualification of this type only once, even if\n the Worker has not been granted the Qualification. It is not possible\n to disable retries for a Qualification type after it has been created\n with retries enabled. If you want to disable retries, you must delete\n existing retry-enabled Qualification type and then create a new\n Qualification type with retries disabled.

" } - }, - "Keywords": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

One or more words or phrases that describe the Qualification\n type, separated by commas. The keywords of a type make the type\n easier to find during a search.

" - } - }, - "Name": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

The name you give to the Qualification type. The type name\n is used to represent the Qualification to Workers, and to find the\n type using a Qualification type search. It must be unique across all\n of your Qualification types.

", - "smithy.api#required": {} - } - }, - "AutoGranted": { - "target": "com.amazonaws.mturk#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether requests for the Qualification type are\n granted immediately, without prompting the Worker with a\n Qualification test.

\n

Constraints: If the Test parameter is specified, this\n parameter cannot be true.

" - } } } }, @@ -878,17 +878,17 @@ "com.amazonaws.mturk#CreateWorkerBlockRequest": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.mturk#String", + "WorkerId": { + "target": "com.amazonaws.mturk#CustomerId", "traits": { - "smithy.api#documentation": "

A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message.

", + "smithy.api#documentation": "

The ID of the Worker to block.

", "smithy.api#required": {} } }, - "WorkerId": { - "target": "com.amazonaws.mturk#CustomerId", + "Reason": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The ID of the Worker to block.

", + "smithy.api#documentation": "

A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message.

", "smithy.api#required": {} } } @@ -1017,20 +1017,20 @@ } }, "com.amazonaws.mturk#DeleteWorkerBlockRequest": { - "type": "structure", - "members": { - "Reason": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

A message that explains the reason for unblocking the Worker. The Worker does not see this message.

" - } - }, + "type": "structure", + "members": { "WorkerId": { "target": "com.amazonaws.mturk#CustomerId", "traits": { "smithy.api#documentation": "

The ID of the Worker to unblock.

", "smithy.api#required": {} } + }, + "Reason": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

A message that explains the reason for unblocking the Worker. The Worker does not see this message.

" + } } } }, @@ -1061,13 +1061,6 @@ "com.amazonaws.mturk#DisassociateQualificationFromWorkerRequest": { "type": "structure", "members": { - "QualificationTypeId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

The ID of the Qualification type of the Qualification to be revoked.

", - "smithy.api#required": {} - } - }, "WorkerId": { "target": "com.amazonaws.mturk#CustomerId", "traits": { @@ -1080,6 +1073,13 @@ "traits": { "smithy.api#documentation": "

A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message.

" } + }, + "QualificationTypeId": { + "target": "com.amazonaws.mturk#EntityId", + "traits": { + "smithy.api#documentation": "

The ID of the Qualification type of the Qualification to be revoked.

", + "smithy.api#required": {} + } } } }, @@ -1233,17 +1233,17 @@ "com.amazonaws.mturk#GetAssignmentResponse": { "type": "structure", "members": { - "HIT": { - "target": "com.amazonaws.mturk#HIT", - "traits": { - "smithy.api#documentation": "

The HIT associated with this assignment. The response\n includes one HIT element.

" - } - }, "Assignment": { "target": "com.amazonaws.mturk#Assignment", "traits": { "smithy.api#documentation": "

The assignment. The response includes one Assignment\n element.\n

" } + }, + "HIT": { + "target": "com.amazonaws.mturk#HIT", + "traits": { + "smithy.api#documentation": "

The HIT associated with this assignment. The response\n includes one HIT element.

" + } } } }, @@ -1366,17 +1366,17 @@ "com.amazonaws.mturk#GetQualificationScoreRequest": { "type": "structure", "members": { - "WorkerId": { - "target": "com.amazonaws.mturk#CustomerId", + "QualificationTypeId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the Worker whose Qualification is being updated.

", + "smithy.api#documentation": "

The ID of the QualificationType.

", "smithy.api#required": {} } }, - "QualificationTypeId": { - "target": "com.amazonaws.mturk#EntityId", + "WorkerId": { + "target": "com.amazonaws.mturk#CustomerId", "traits": { - "smithy.api#documentation": "

The ID of the QualificationType.

", + "smithy.api#documentation": "

The ID of the Worker whose Qualification is being updated.

", "smithy.api#required": {} } } @@ -1440,40 +1440,28 @@ "com.amazonaws.mturk#HIT": { "type": "structure", "members": { - "MaxAssignments": { - "target": "com.amazonaws.mturk#Integer", + "Keywords": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The number of times the HIT can be accepted and completed\n before the HIT becomes unavailable.\n

" + "smithy.api#documentation": "

One or more words or phrases that describe the HIT,\n separated by commas. Search terms similar to the keywords of a HIT\n are more likely to have the HIT in the search results.

" } }, - "HITStatus": { - "target": "com.amazonaws.mturk#HITStatus", + "NumberOfAssignmentsAvailable": { + "target": "com.amazonaws.mturk#Integer", "traits": { - "smithy.api#documentation": "

The status of the HIT and its assignments. Valid Values are\n Assignable | Unassignable | Reviewable | Reviewing | Disposed.\n

" + "smithy.api#documentation": "

The number of assignments for this HIT that are available\n for Workers to accept.

" } }, - "HITTypeId": { + "HITGroupId": { "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the HIT type of this HIT

" - } - }, - "CreationTime": { - "target": "com.amazonaws.mturk#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time the HIT was created.

" - } - }, - "AssignmentDurationInSeconds": { - "target": "com.amazonaws.mturk#Long", - "traits": { - "smithy.api#documentation": "

The length of time, in seconds, that a Worker has to\n complete the HIT after accepting it.

" + "smithy.api#documentation": "

The ID of the HIT Group of this HIT.

" } }, - "Expiration": { - "target": "com.amazonaws.mturk#Timestamp", + "RequesterAnnotation": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The date and time the HIT expires.

" + "smithy.api#documentation": "

An arbitrary data field the Requester who created the HIT\n can use. This field is visible only to the creator of the HIT.

" } }, "Description": { @@ -1482,52 +1470,58 @@ "smithy.api#documentation": "

A general description of the HIT.

" } }, - "HITGroupId": { - "target": "com.amazonaws.mturk#EntityId", + "Title": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The ID of the HIT Group of this HIT.

" + "smithy.api#documentation": "

The title of the HIT.

" } }, - "Keywords": { - "target": "com.amazonaws.mturk#String", + "NumberOfAssignmentsCompleted": { + "target": "com.amazonaws.mturk#Integer", "traits": { - "smithy.api#documentation": "

One or more words or phrases that describe the HIT,\n separated by commas. Search terms similar to the keywords of a HIT\n are more likely to have the HIT in the search results.

" + "smithy.api#documentation": "

The number of assignments for this HIT that have been\n approved or rejected.

" } }, - "RequesterAnnotation": { - "target": "com.amazonaws.mturk#String", + "Expiration": { + "target": "com.amazonaws.mturk#Timestamp", "traits": { - "smithy.api#documentation": "

An arbitrary data field the Requester who created the HIT\n can use. This field is visible only to the creator of the HIT.

" + "smithy.api#documentation": "

The date and time the HIT expires.

" } }, - "NumberOfAssignmentsCompleted": { - "target": "com.amazonaws.mturk#Integer", + "HITLayoutId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The number of assignments for this HIT that have been\n approved or rejected.

" + "smithy.api#documentation": "

The ID of the HIT Layout of this HIT.

" } }, - "NumberOfAssignmentsAvailable": { + "MaxAssignments": { "target": "com.amazonaws.mturk#Integer", "traits": { - "smithy.api#documentation": "

The number of assignments for this HIT that are available\n for Workers to accept.

" + "smithy.api#documentation": "

The number of times the HIT can be accepted and completed\n before the HIT becomes unavailable.\n

" } }, - "NumberOfAssignmentsPending": { - "target": "com.amazonaws.mturk#Integer", + "AssignmentDurationInSeconds": { + "target": "com.amazonaws.mturk#Long", "traits": { - "smithy.api#documentation": "

The number of assignments for this HIT that are being\n previewed or have been accepted by Workers, but have not yet been\n submitted, returned, or abandoned.

" + "smithy.api#documentation": "

The length of time, in seconds, that a Worker has to\n complete the HIT after accepting it.

" } }, - "HITLayoutId": { + "HITTypeId": { "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the HIT Layout of this HIT.

" + "smithy.api#documentation": "

The ID of the HIT type of this HIT

" } }, - "QualificationRequirements": { - "target": "com.amazonaws.mturk#QualificationRequirementList", + "HITReviewStatus": { + "target": "com.amazonaws.mturk#HITReviewStatus", "traits": { - "smithy.api#documentation": "

\n Conditions that a Worker's Qualifications must meet in order\n to accept the HIT. A HIT can have between zero and ten\n Qualification requirements. All requirements must be met in\n order for a Worker to accept the HIT. Additionally, other\n actions can be restricted using the ActionsGuarded\n field on each QualificationRequirement structure.\n

" + "smithy.api#documentation": "

Indicates the review status of the HIT. Valid Values are\n NotReviewed | MarkedForReview | ReviewedAppropriate |\n ReviewedInappropriate.

" + } + }, + "HITId": { + "target": "com.amazonaws.mturk#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the HIT.

" } }, "AutoApprovalDelayInSeconds": { @@ -1536,8 +1530,11 @@ "smithy.api#documentation": "

The amount of time, in seconds, after the Worker submits an\n assignment for the HIT that the results are automatically approved by\n Amazon Mechanical Turk. This is the amount of time the Requester has\n to reject an assignment submitted by a Worker before the assignment\n is auto-approved and the Worker is paid.\n

" } }, - "Reward": { - "target": "com.amazonaws.mturk#CurrencyAmount" + "HITStatus": { + "target": "com.amazonaws.mturk#HITStatus", + "traits": { + "smithy.api#documentation": "

The status of the HIT and its assignments. Valid Values are\n Assignable | Unassignable | Reviewable | Reviewing | Disposed.\n

" + } }, "Question": { "target": "com.amazonaws.mturk#String", @@ -1545,22 +1542,25 @@ "smithy.api#documentation": "

The data the Worker completing the HIT uses produce the\n results. This is either either a QuestionForm, HTMLQuestion or an\n ExternalQuestion data structure.

" } }, - "HITReviewStatus": { - "target": "com.amazonaws.mturk#HITReviewStatus", + "Reward": { + "target": "com.amazonaws.mturk#CurrencyAmount" + }, + "NumberOfAssignmentsPending": { + "target": "com.amazonaws.mturk#Integer", "traits": { - "smithy.api#documentation": "

Indicates the review status of the HIT. Valid Values are\n NotReviewed | MarkedForReview | ReviewedAppropriate |\n ReviewedInappropriate.

" + "smithy.api#documentation": "

The number of assignments for this HIT that are being\n previewed or have been accepted by Workers, but have not yet been\n submitted, returned, or abandoned.

" } }, - "HITId": { - "target": "com.amazonaws.mturk#EntityId", + "QualificationRequirements": { + "target": "com.amazonaws.mturk#QualificationRequirementList", "traits": { - "smithy.api#documentation": "

A unique identifier for the HIT.

" + "smithy.api#documentation": "

\n Conditions that a Worker's Qualifications must meet in order\n to accept the HIT. A HIT can have between zero and ten\n Qualification requirements. All requirements must be met in\n order for a Worker to accept the HIT. Additionally, other\n actions can be restricted using the ActionsGuarded\n field on each QualificationRequirement structure.\n

" } }, - "Title": { - "target": "com.amazonaws.mturk#String", + "CreationTime": { + "target": "com.amazonaws.mturk#Timestamp", "traits": { - "smithy.api#documentation": "

The title of the HIT.

" + "smithy.api#documentation": "

The date and time the HIT was created.

" } } }, @@ -1590,17 +1590,17 @@ "com.amazonaws.mturk#HITLayoutParameter": { "type": "structure", "members": { - "Name": { + "Value": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The name of the parameter in the HITLayout.\n

", + "smithy.api#documentation": "

The value substituted for the parameter referenced in the\n HITLayout.\n

", "smithy.api#required": {} } }, - "Value": { + "Name": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The value substituted for the parameter referenced in the\n HITLayout.\n

", + "smithy.api#documentation": "

The name of the parameter in the HITLayout.\n

", "smithy.api#required": {} } } @@ -1730,18 +1730,18 @@ "smithy.api#documentation": "

The status of the assignments to return: Submitted | Approved\n | Rejected

" } }, + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination token

" + } + }, "HITId": { "target": "com.amazonaws.mturk#EntityId", "traits": { "smithy.api#documentation": "

The ID of the HIT.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken", - "traits": { - "smithy.api#documentation": "

Pagination token

" - } } } }, @@ -1800,12 +1800,6 @@ "smithy.api#documentation": "

Pagination token

" } }, - "HITId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

The ID of the HIT associated with the bonus payments to\n retrieve. If not specified, all bonus payments for all assignments\n for the given HIT are returned. Either the HITId parameter or the\n AssignmentId parameter must be specified

" - } - }, "MaxResults": { "target": "com.amazonaws.mturk#ResultSize" }, @@ -1814,17 +1808,20 @@ "traits": { "smithy.api#documentation": "

The ID of the assignment associated with the bonus payments\n to retrieve. If specified, only bonus payments for the given\n assignment are returned. Either the HITId parameter or the\n AssignmentId parameter must be specified

" } + }, + "HITId": { + "target": "com.amazonaws.mturk#EntityId", + "traits": { + "smithy.api#documentation": "

The ID of the HIT associated with the bonus payments to\n retrieve. If not specified, all bonus payments for all assignments\n for the given HIT are returned. Either the HITId parameter or the\n AssignmentId parameter must be specified

" + } } } }, "com.amazonaws.mturk#ListBonusPaymentsResponse": { "type": "structure", "members": { - "BonusPayments": { - "target": "com.amazonaws.mturk#BonusPaymentList", - "traits": { - "smithy.api#documentation": "

A successful request to the ListBonusPayments operation\n returns a list of BonusPayment objects.\n

" - } + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken" }, "NumResults": { "target": "com.amazonaws.mturk#Integer", @@ -1832,8 +1829,11 @@ "smithy.api#documentation": "

The number of bonus payments on this page in the filtered\n results list, equivalent to the number of bonus payments being\n returned by this call.\n

" } }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken" + "BonusPayments": { + "target": "com.amazonaws.mturk#BonusPaymentList", + "traits": { + "smithy.api#documentation": "

A successful request to the ListBonusPayments operation\n returns a list of BonusPayment objects.\n

" + } } } }, @@ -1916,15 +1916,15 @@ "com.amazonaws.mturk#ListHITsForQualificationTypeResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken" + }, "NumResults": { "target": "com.amazonaws.mturk#Integer", "traits": { "smithy.api#documentation": "

The number of HITs on this page in the filtered results\n list, equivalent to the number of HITs being returned by this call.\t

" } }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken" - }, "HITs": { "target": "com.amazonaws.mturk#HITList", "traits": { @@ -1950,15 +1950,15 @@ "com.amazonaws.mturk#ListHITsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken" + }, "NumResults": { "target": "com.amazonaws.mturk#Integer", "traits": { "smithy.api#documentation": "

The number of HITs on this page in the filtered results list,\n equivalent to the number of HITs being returned by this call.

" } }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken" - }, "HITs": { "target": "com.amazonaws.mturk#HITList", "traits": { @@ -1996,15 +1996,15 @@ "com.amazonaws.mturk#ListQualificationRequestsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken" + }, "QualificationTypeId": { "target": "com.amazonaws.mturk#EntityId", "traits": { "smithy.api#documentation": "

The ID of the QualificationType.

" } }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken" - }, "MaxResults": { "target": "com.amazonaws.mturk#ResultSize", "traits": { @@ -2022,14 +2022,14 @@ "smithy.api#documentation": "

The number of Qualification requests on this page in the filtered results list,\n equivalent to the number of Qualification requests being returned by this call.

" } }, + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken" + }, "QualificationRequests": { "target": "com.amazonaws.mturk#QualificationRequestList", "traits": { "smithy.api#documentation": "

The Qualification request. The response includes one\n QualificationRequest element\n for each Qualification request returned\n by the query.

" } - }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken" } } }, @@ -2062,11 +2062,16 @@ "com.amazonaws.mturk#ListQualificationTypesRequest": { "type": "structure", "members": { - "MustBeRequestable": { + "Query": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

A text query against all of the searchable attributes of\n Qualification types.\n

" + } + }, + "MustBeOwnedByCaller": { "target": "com.amazonaws.mturk#Boolean", "traits": { - "smithy.api#documentation": "

Specifies that only Qualification types that a user can\n request through the Amazon Mechanical Turk web site, such as by\n taking a Qualification test, are returned as results of the search.\n Some Qualification types, such as those assigned automatically by the\n system, cannot be requested directly by users. If false, all\n Qualification types, including those managed by the system, are\n considered. Valid values are True | False.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies that only Qualification types that the Requester\n created are returned. If false, the operation returns all\n Qualification types.\n

" } }, "MaxResults": { @@ -2078,16 +2083,11 @@ "NextToken": { "target": "com.amazonaws.mturk#PaginationToken" }, - "MustBeOwnedByCaller": { + "MustBeRequestable": { "target": "com.amazonaws.mturk#Boolean", "traits": { - "smithy.api#documentation": "

Specifies that only Qualification types that the Requester\n created are returned. If false, the operation returns all\n Qualification types.\n

" - } - }, - "Query": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

A text query against all of the searchable attributes of\n Qualification types.\n

" + "smithy.api#documentation": "

Specifies that only Qualification types that a user can\n request through the Amazon Mechanical Turk web site, such as by\n taking a Qualification test, are returned as results of the search.\n Some Qualification types, such as those assigned automatically by the\n system, cannot be requested directly by users. If false, all\n Qualification types, including those managed by the system, are\n considered. Valid values are True | False.\n

", + "smithy.api#required": {} } } } @@ -2098,17 +2098,17 @@ "NextToken": { "target": "com.amazonaws.mturk#PaginationToken" }, - "QualificationTypes": { - "target": "com.amazonaws.mturk#QualificationTypeList", - "traits": { - "smithy.api#documentation": "

The list of QualificationType elements returned by the\n query.\n

" - } - }, "NumResults": { "target": "com.amazonaws.mturk#Integer", "traits": { "smithy.api#documentation": "

The number of Qualification types on this page in the\n filtered results list, equivalent to the number of types this\n operation returns.\n

" } + }, + "QualificationTypes": { + "target": "com.amazonaws.mturk#QualificationTypeList", + "traits": { + "smithy.api#documentation": "

The list of QualificationType elements returned by the\n query.\n

" + } } } }, @@ -2141,16 +2141,23 @@ "com.amazonaws.mturk#ListReviewPolicyResultsForHITRequest": { "type": "structure", "members": { + "RetrieveActions": { + "target": "com.amazonaws.mturk#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specify if the operation should retrieve a list of the actions taken executing\n the Review Policies and their outcomes.\n

" + } + }, "MaxResults": { "target": "com.amazonaws.mturk#ResultSize", "traits": { "smithy.api#documentation": "

Limit the number of results returned.

" } }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken", + "HITId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

Pagination token

" + "smithy.api#documentation": "

The unique identifier of the HIT to retrieve review results for.

", + "smithy.api#required": {} } }, "RetrieveResults": { @@ -2165,17 +2172,10 @@ "smithy.api#documentation": "

\n The Policy Level(s) to retrieve review results for - HIT or Assignment.\n If omitted, the default behavior is to retrieve all data for both policy levels.\n For a list of all the described policies, see Review Policies.\n

" } }, - "HITId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the HIT to retrieve review results for.

", - "smithy.api#required": {} - } - }, - "RetrieveActions": { - "target": "com.amazonaws.mturk#Boolean", + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken", "traits": { - "smithy.api#documentation": "

\n Specify if the operation should retrieve a list of the actions taken executing\n the Review Policies and their outcomes.\n

" + "smithy.api#documentation": "

Pagination token

" } } } @@ -2183,16 +2183,22 @@ "com.amazonaws.mturk#ListReviewPolicyResultsForHITResponse": { "type": "structure", "members": { + "HITReviewPolicy": { + "target": "com.amazonaws.mturk#ReviewPolicy", + "traits": { + "smithy.api#documentation": "

The name of the HIT-level Review Policy. This contains only\n the PolicyName element.

" + } + }, "HITReviewReport": { "target": "com.amazonaws.mturk#ReviewReport", "traits": { "smithy.api#documentation": "

Contains both ReviewResult and ReviewAction elements for a particular HIT.\n

" } }, - "HITReviewPolicy": { - "target": "com.amazonaws.mturk#ReviewPolicy", + "AssignmentReviewReport": { + "target": "com.amazonaws.mturk#ReviewReport", "traits": { - "smithy.api#documentation": "

The name of the HIT-level Review Policy. This contains only\n the PolicyName element.

" + "smithy.api#documentation": "

Contains both ReviewResult and ReviewAction elements for an\n Assignment.\n

" } }, "AssignmentReviewPolicy": { @@ -2209,12 +2215,6 @@ "traits": { "smithy.api#documentation": "

The HITId of the HIT for which results have been returned.

" } - }, - "AssignmentReviewReport": { - "target": "com.amazonaws.mturk#ReviewReport", - "traits": { - "smithy.api#documentation": "

Contains both ReviewResult and ReviewAction elements for an\n Assignment.\n

" - } } } }, @@ -2247,22 +2247,16 @@ "com.amazonaws.mturk#ListReviewableHITsRequest": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.mturk#ReviewableHITStatus", - "traits": { - "smithy.api#documentation": "

\n Can be either Reviewable or Reviewing.\n Reviewable is the default value.\n

" - } - }, "HITTypeId": { "target": "com.amazonaws.mturk#EntityId", "traits": { "smithy.api#documentation": "

\n The ID of the HIT type of the HITs to consider for the query.\n If not specified, all HITs for the Reviewer are considered\n

" } }, - "MaxResults": { - "target": "com.amazonaws.mturk#ResultSize", + "Status": { + "target": "com.amazonaws.mturk#ReviewableHITStatus", "traits": { - "smithy.api#documentation": "

\n Limit the number of results returned.\n

" + "smithy.api#documentation": "

\n Can be either Reviewable or Reviewing.\n Reviewable is the default value.\n

" } }, "NextToken": { @@ -2270,6 +2264,12 @@ "traits": { "smithy.api#documentation": "

Pagination Token

" } + }, + "MaxResults": { + "target": "com.amazonaws.mturk#ResultSize", + "traits": { + "smithy.api#documentation": "

\n Limit the number of results returned.\n

" + } } } }, @@ -2282,14 +2282,14 @@ "smithy.api#documentation": "

The list of HIT elements returned by the query.

" } }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken" - }, "NumResults": { "target": "com.amazonaws.mturk#Integer", "traits": { "smithy.api#documentation": "

The number of HITs on this page in the filtered results\n list, equivalent to the number of HITs being returned by this call.\n

" } + }, + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken" } } }, @@ -2382,6 +2382,12 @@ "com.amazonaws.mturk#ListWorkersWithQualificationTypeRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.mturk#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination Token

" + } + }, "QualificationTypeId": { "target": "com.amazonaws.mturk#EntityId", "traits": { @@ -2389,10 +2395,10 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.mturk#PaginationToken", + "Status": { + "target": "com.amazonaws.mturk#QualificationStatus", "traits": { - "smithy.api#documentation": "

Pagination Token

" + "smithy.api#documentation": "

\n The status of the Qualifications to return.\n Can be Granted | Revoked.\n

" } }, "MaxResults": { @@ -2400,12 +2406,6 @@ "traits": { "smithy.api#documentation": "

\n Limit the number of results returned.\n

" } - }, - "Status": { - "target": "com.amazonaws.mturk#QualificationStatus", - "traits": { - "smithy.api#documentation": "

\n The status of the Qualifications to return.\n Can be Granted | Revoked.\n

" - } } } }, @@ -2415,17 +2415,17 @@ "NextToken": { "target": "com.amazonaws.mturk#PaginationToken" }, - "NumResults": { - "target": "com.amazonaws.mturk#Integer", - "traits": { - "smithy.api#documentation": "

The number of Qualifications on this page in the filtered\n results list, equivalent to the number of Qualifications being\n returned by this call.

" - } - }, "Qualifications": { "target": "com.amazonaws.mturk#QualificationList", "traits": { "smithy.api#documentation": "

The list of Qualification elements returned by this call.\n

" } + }, + "NumResults": { + "target": "com.amazonaws.mturk#Integer", + "traits": { + "smithy.api#documentation": "

The number of Qualifications on this page in the filtered\n results list, equivalent to the number of Qualifications being\n returned by this call.

" + } } } }, @@ -2589,7 +2589,7 @@ "sdkId": "MTurk", "arnNamespace": "mturk-requester", "cloudFormationName": "MTurk", - "cloudTrailEventSource": "V20170117.requester.mturk.services.amazonaws.com" + "cloudTrailEventSource": "mturk.amazonaws.com" }, "aws.auth#sigv4": { "name": "mturk-requester" @@ -2612,6 +2612,13 @@ "smithy.api#required": {} } }, + "Version": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

The version of the Notification API to use. Valid value is\n 2006-05-05.

", + "smithy.api#required": {} + } + }, "Transport": { "target": "com.amazonaws.mturk#NotificationTransport", "traits": { @@ -2625,13 +2632,6 @@ "smithy.api#documentation": "

\n The target for notification messages. The Destination’s format is determined by the specified Transport:\n

\n
    \n
  • \n

    When Transport is Email, the Destination is your email address.

    \n
    • \n
  • \n

    When Transport is SQS, the Destination is your queue URL.

    \n
    • \n
  • \n

    When Transport is SNS, the Destination is the ARN of your topic.

    \n
    • \n
", "smithy.api#required": {} } - }, - "Version": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

The version of the Notification API to use. Valid value is\n 2006-05-05.

", - "smithy.api#required": {} - } } }, "traits": { @@ -2701,17 +2701,17 @@ "smithy.api#documentation": "

A message detailing the reason the Worker could not be\n notified.\n

" } }, - "WorkerId": { - "target": "com.amazonaws.mturk#CustomerId", - "traits": { - "smithy.api#documentation": "

The ID of the Worker.

" - } - }, "NotifyWorkersFailureCode": { "target": "com.amazonaws.mturk#NotifyWorkersFailureCode", "traits": { "smithy.api#documentation": "

Encoded value for the failure type.\n

" } + }, + "WorkerId": { + "target": "com.amazonaws.mturk#CustomerId", + "traits": { + "smithy.api#documentation": "

The ID of the Worker.

" + } } }, "traits": { @@ -2727,6 +2727,13 @@ "com.amazonaws.mturk#NotifyWorkersRequest": { "type": "structure", "members": { + "Subject": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

The subject line of the email message to send. Can include up\n to 200 characters.

", + "smithy.api#required": {} + } + }, "WorkerIds": { "target": "com.amazonaws.mturk#CustomerIdList", "traits": { @@ -2740,13 +2747,6 @@ "smithy.api#documentation": "

The text of the email message to send. Can include up to\n 4,096 characters

", "smithy.api#required": {} } - }, - "Subject": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

The subject line of the email message to send. Can include up\n to 200 characters.

", - "smithy.api#required": {} - } } } }, @@ -2806,17 +2806,17 @@ "smithy.api#documentation": "

Name of the parameter from the list of Review Polices.\n

" } }, - "Values": { - "target": "com.amazonaws.mturk#StringList", - "traits": { - "smithy.api#documentation": "

The list of values of the Parameter

" - } - }, "MapEntries": { "target": "com.amazonaws.mturk#ParameterMapEntryList", "traits": { "smithy.api#documentation": "

List of ParameterMapEntry objects.\n

" } + }, + "Values": { + "target": "com.amazonaws.mturk#StringList", + "traits": { + "smithy.api#documentation": "

The list of values of the Parameter

" + } } }, "traits": { @@ -2832,19 +2832,25 @@ "com.amazonaws.mturk#Qualification": { "type": "structure", "members": { + "LocaleValue": { + "target": "com.amazonaws.mturk#Locale" + }, + "GrantTime": { + "target": "com.amazonaws.mturk#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the Qualification was granted to the\n Worker. If the Worker's Qualification was revoked, and then\n re-granted based on a new Qualification request, GrantTime is the\n date and time of the last call to the AcceptQualificationRequest\n operation.

" + } + }, "IntegerValue": { "target": "com.amazonaws.mturk#Integer", "traits": { "smithy.api#documentation": "

The value (score) of the Qualification, if the Qualification\n has an integer value.

" } }, - "LocaleValue": { - "target": "com.amazonaws.mturk#Locale" - }, - "WorkerId": { - "target": "com.amazonaws.mturk#CustomerId", + "Status": { + "target": "com.amazonaws.mturk#QualificationStatus", "traits": { - "smithy.api#documentation": "

The ID of the Worker who possesses the Qualification.\n

" + "smithy.api#documentation": "

The status of the Qualification. Valid values are Granted |\n Revoked.

" } }, "QualificationTypeId": { @@ -2853,16 +2859,10 @@ "smithy.api#documentation": "

The ID of the Qualification type for the Qualification.

" } }, - "GrantTime": { - "target": "com.amazonaws.mturk#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time the Qualification was granted to the\n Worker. If the Worker's Qualification was revoked, and then\n re-granted based on a new Qualification request, GrantTime is the\n date and time of the last call to the AcceptQualificationRequest\n operation.

" - } - }, - "Status": { - "target": "com.amazonaws.mturk#QualificationStatus", + "WorkerId": { + "target": "com.amazonaws.mturk#CustomerId", "traits": { - "smithy.api#documentation": "

The status of the Qualification. Valid values are Granted |\n Revoked.

" + "smithy.api#documentation": "

The ID of the Worker who possesses the Qualification.\n

" } } }, @@ -2879,22 +2879,22 @@ "com.amazonaws.mturk#QualificationRequest": { "type": "structure", "members": { - "QualificationTypeId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

The ID of the Qualification type the Worker is requesting,\n as returned by the CreateQualificationType operation.\n

" - } - }, "WorkerId": { "target": "com.amazonaws.mturk#CustomerId", "traits": { "smithy.api#documentation": "

The ID of the Worker requesting the Qualification.

" } }, - "QualificationRequestId": { + "Answer": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The ID of the Qualification request, a unique identifier\n generated when the request was submitted.\n\n

" + "smithy.api#documentation": "

The Worker's answers for the Qualification type's test\n contained in a QuestionFormAnswers document, if the type has a test\n and the Worker has submitted answers. If the Worker does not provide\n any answers, Answer may be empty.\n

" + } + }, + "Test": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

The contents of the Qualification test that was presented to\n the Worker, if the type has a test and the Worker has submitted\n answers. This value is identical to the QuestionForm associated with\n the Qualification type at the time the Worker requests the\n Qualification.

" } }, "SubmitTime": { @@ -2903,16 +2903,16 @@ "smithy.api#documentation": "

The date and time the Qualification request had a status of\n Submitted. This is either the time the Worker submitted answers for a\n Qualification test, or the time the Worker requested the\n Qualification if the Qualification type does not have a test.\n

" } }, - "Answer": { + "QualificationRequestId": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The Worker's answers for the Qualification type's test\n contained in a QuestionFormAnswers document, if the type has a test\n and the Worker has submitted answers. If the Worker does not provide\n any answers, Answer may be empty.\n

" + "smithy.api#documentation": "

The ID of the Qualification request, a unique identifier\n generated when the request was submitted.\n\n

" } }, - "Test": { - "target": "com.amazonaws.mturk#String", + "QualificationTypeId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The contents of the Qualification test that was presented to\n the Worker, if the type has a test and the Worker has submitted\n answers. This value is identical to the QuestionForm associated with\n the Qualification type at the time the Worker requests the\n Qualification.

" + "smithy.api#documentation": "

The ID of the Qualification type the Worker is requesting,\n as returned by the CreateQualificationType operation.\n

" } } }, @@ -2935,11 +2935,17 @@ "smithy.api#documentation": "

Setting this attribute prevents Workers whose Qualifications do not meet\n this QualificationRequirement from taking the specified action. Valid arguments include\n \"Accept\" (Worker cannot accept the HIT, but can preview the HIT and see it in their search results),\n \"PreviewAndAccept\" (Worker cannot accept or preview the HIT, but can see the HIT in their search results),\n and \"DiscoverPreviewAndAccept\" (Worker cannot accept, preview, or see the HIT in their search results). It's possible for you to create a HIT with multiple\n QualificationRequirements (which can have different values for the ActionGuarded attribute). In this case,\n the Worker is only permitted to perform an action when they have met all QualificationRequirements guarding\n the action. The actions in the order of least restrictive to most restrictive are Discover, Preview and Accept.\n For example, if a Worker meets all QualificationRequirements that are set to DiscoverPreviewAndAccept, but do\n not meet all requirements that are set with PreviewAndAccept, then the Worker will be able to Discover, i.e. see the\n HIT in their search result, but will not be able to Preview or Accept the HIT. ActionsGuarded should not be used in combination with the\n RequiredToPreview field.\n

" } }, - "RequiredToPreview": { - "target": "com.amazonaws.mturk#Boolean", + "Comparator": { + "target": "com.amazonaws.mturk#Comparator", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

DEPRECATED: Use the ActionsGuarded field instead.\n If RequiredToPreview is true, the question data for the HIT will not be shown\n when a Worker whose Qualifications do not meet this requirement tries\n to preview the HIT. That is, a Worker's Qualifications must meet all\n of the requirements for which RequiredToPreview is true in order to\n preview the HIT. If a Worker meets all of the requirements where\n RequiredToPreview is true (or if there are no such requirements), but\n does not meet all of the requirements for the HIT, the Worker will be\n allowed to preview the HIT's question data, but will not be allowed\n to accept and complete the HIT. The default is false. This should not\n be used in combination with the ActionsGuarded field.\n

" + "smithy.api#documentation": "

The kind of comparison to make against a Qualification's\n value. You can compare a Qualification's value to an IntegerValue to\n see if it is LessThan, LessThanOrEqualTo, GreaterThan,\n GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You\n can compare it to a LocaleValue to see if it is EqualTo, or\n NotEqualTo the LocaleValue. You can check to see if the value is In\n or NotIn a set of IntegerValue\n or LocaleValue values. Lastly, a\n Qualification requirement can also\n test if a Qualification Exists or\n DoesNotExist in the user's profile,\n regardless of its value.\n

", + "smithy.api#required": {} + } + }, + "IntegerValues": { + "target": "com.amazonaws.mturk#IntegerList", + "traits": { + "smithy.api#documentation": "

The integer value to compare against the Qualification's\n value. IntegerValue must not be present if Comparator is Exists or\n DoesNotExist. IntegerValue can only be used if the Qualification type\n has an integer value; it cannot be used with the Worker_Locale\n QualificationType ID. When performing a set comparison by using the\n In or the NotIn comparator, you can use up to 15 IntegerValue\n elements in a QualificationRequirement data structure.\n

" } }, "LocaleValues": { @@ -2948,10 +2954,11 @@ "smithy.api#documentation": "

The locale value to compare against the Qualification's\n value. The local value must be a valid ISO 3166 country code or\n supports ISO 3166-2 subdivisions. LocaleValue can only be used with a\n Worker_Locale QualificationType ID. LocaleValue can only be used with\n the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use\n a single LocaleValue element when using the EqualTo or NotEqualTo\n comparators. When performing a set comparison by using the In or the\n NotIn comparator, you can use up to 30 LocaleValue elements in a\n QualificationRequirement data structure.\n

" } }, - "IntegerValues": { - "target": "com.amazonaws.mturk#IntegerList", + "RequiredToPreview": { + "target": "com.amazonaws.mturk#Boolean", "traits": { - "smithy.api#documentation": "

The integer value to compare against the Qualification's\n value. IntegerValue must not be present if Comparator is Exists or\n DoesNotExist. IntegerValue can only be used if the Qualification type\n has an integer value; it cannot be used with the Worker_Locale\n QualificationType ID. When performing a set comparison by using the\n In or the NotIn comparator, you can use up to 15 IntegerValue\n elements in a QualificationRequirement data structure.\n

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

DEPRECATED: Use the ActionsGuarded field instead.\n If RequiredToPreview is true, the question data for the HIT will not be shown\n when a Worker whose Qualifications do not meet this requirement tries\n to preview the HIT. That is, a Worker's Qualifications must meet all\n of the requirements for which RequiredToPreview is true in order to\n preview the HIT. If a Worker meets all of the requirements where\n RequiredToPreview is true (or if there are no such requirements), but\n does not meet all of the requirements for the HIT, the Worker will be\n allowed to preview the HIT's question data, but will not be allowed\n to accept and complete the HIT. The default is false. This should not\n be used in combination with the ActionsGuarded field.\n

" } }, "QualificationTypeId": { @@ -2960,13 +2967,6 @@ "smithy.api#documentation": "

The ID of the Qualification type for the requirement.

", "smithy.api#required": {} } - }, - "Comparator": { - "target": "com.amazonaws.mturk#Comparator", - "traits": { - "smithy.api#documentation": "

The kind of comparison to make against a Qualification's\n value. You can compare a Qualification's value to an IntegerValue to\n see if it is LessThan, LessThanOrEqualTo, GreaterThan,\n GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You\n can compare it to a LocaleValue to see if it is EqualTo, or\n NotEqualTo the LocaleValue. You can check to see if the value is In\n or NotIn a set of IntegerValue\n or LocaleValue values. Lastly, a\n Qualification requirement can also\n test if a Qualification Exists or\n DoesNotExist in the user's profile,\n regardless of its value.\n

", - "smithy.api#required": {} - } } }, "traits": { @@ -2991,28 +2991,40 @@ "value": "Revoked", "name": "Revoked" } - ] - } - }, - "com.amazonaws.mturk#QualificationType": { - "type": "structure", - "members": { - "Test": { - "target": "com.amazonaws.mturk#String", + ] + } + }, + "com.amazonaws.mturk#QualificationType": { + "type": "structure", + "members": { + "IsRequestable": { + "target": "com.amazonaws.mturk#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the Qualification type is one that a user\n can request through the Amazon Mechanical Turk web site, such as by\n taking a Qualification test. This value is False for Qualifications\n assigned automatically by the system. Valid values are True | False.\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.mturk#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the Qualification type was created.\n

" + } + }, + "AutoGranted": { + "target": "com.amazonaws.mturk#Boolean", "traits": { - "smithy.api#documentation": "

The questions for a Qualification test associated with this\n Qualification type that a user can take to obtain a Qualification of\n this type. This parameter must be specified if AnswerKey is present.\n A Qualification type cannot have both a specified Test parameter and\n an AutoGranted value of true.\n

" + "smithy.api#documentation": "

Specifies that requests for the Qualification type are\n granted immediately, without prompting the Worker with a\n Qualification test. Valid values are True | False.

" } }, - "RetryDelayInSeconds": { - "target": "com.amazonaws.mturk#Long", + "QualificationTypeId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, Workers must wait after\n taking the Qualification test before they can take it again. Workers\n can take a Qualification test multiple times if they were not granted\n the Qualification from a previous attempt, or if the test offers a\n gradient score and they want a better score. If not specified,\n retries are disabled and Workers can request a Qualification only\n once.\n

" + "smithy.api#documentation": "

A unique identifier for the Qualification type. A\n Qualification type is given a Qualification type ID when you call the\n CreateQualificationType operation.\n

" } }, - "Name": { + "AnswerKey": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The name of the Qualification type. The type name is used to\n identify the type, and to find the type using a Qualification type\n search.\n

" + "smithy.api#documentation": "

The answers to the Qualification test specified in the Test\n parameter.

" } }, "Keywords": { @@ -3021,22 +3033,16 @@ "smithy.api#documentation": "

One or more words or phrases that describe theQualification\n type, separated by commas. The Keywords make the type easier to find\n using a search.\n

" } }, - "QualificationTypeId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the Qualification type. A\n Qualification type is given a Qualification type ID when you call the\n CreateQualificationType operation.\n

" - } - }, - "AutoGranted": { - "target": "com.amazonaws.mturk#Boolean", + "AutoGrantedValue": { + "target": "com.amazonaws.mturk#Integer", "traits": { - "smithy.api#documentation": "

Specifies that requests for the Qualification type are\n granted immediately, without prompting the Worker with a\n Qualification test. Valid values are True | False.

" + "smithy.api#documentation": "

The Qualification integer value to use for automatically\n granted Qualifications, if AutoGranted is true. This is 1 by default.\n

" } }, - "CreationTime": { - "target": "com.amazonaws.mturk#Timestamp", + "QualificationTypeStatus": { + "target": "com.amazonaws.mturk#QualificationTypeStatus", "traits": { - "smithy.api#documentation": "

The date and time the Qualification type was created.\n

" + "smithy.api#documentation": "

The status of the Qualification type. A Qualification type's\n status determines if users can apply to receive a Qualification of\n this type, and if HITs can be created with requirements based on this\n type. Valid values are Active | Inactive.\n

" } }, "TestDurationInSeconds": { @@ -3045,34 +3051,28 @@ "smithy.api#documentation": "

The amount of time, in seconds, given to a Worker to\n complete the Qualification test, beginning from the time the Worker\n requests the Qualification.\n

" } }, - "Description": { + "Test": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

A long description for the Qualification type.\n

" - } - }, - "AutoGrantedValue": { - "target": "com.amazonaws.mturk#Integer", - "traits": { - "smithy.api#documentation": "

The Qualification integer value to use for automatically\n granted Qualifications, if AutoGranted is true. This is 1 by default.\n

" + "smithy.api#documentation": "

The questions for a Qualification test associated with this\n Qualification type that a user can take to obtain a Qualification of\n this type. This parameter must be specified if AnswerKey is present.\n A Qualification type cannot have both a specified Test parameter and\n an AutoGranted value of true.\n

" } }, - "QualificationTypeStatus": { - "target": "com.amazonaws.mturk#QualificationTypeStatus", + "Name": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The status of the Qualification type. A Qualification type's\n status determines if users can apply to receive a Qualification of\n this type, and if HITs can be created with requirements based on this\n type. Valid values are Active | Inactive.\n

" + "smithy.api#documentation": "

The name of the Qualification type. The type name is used to\n identify the type, and to find the type using a Qualification type\n search.\n

" } }, - "IsRequestable": { - "target": "com.amazonaws.mturk#Boolean", + "RetryDelayInSeconds": { + "target": "com.amazonaws.mturk#Long", "traits": { - "smithy.api#documentation": "

Specifies whether the Qualification type is one that a user\n can request through the Amazon Mechanical Turk web site, such as by\n taking a Qualification test. This value is False for Qualifications\n assigned automatically by the system. Valid values are True | False.\n

" + "smithy.api#documentation": "

The amount of time, in seconds, Workers must wait after\n taking the Qualification test before they can take it again. Workers\n can take a Qualification test multiple times if they were not granted\n the Qualification from a previous attempt, or if the test offers a\n gradient score and they want a better score. If not specified,\n retries are disabled and Workers can request a Qualification only\n once.\n

" } }, - "AnswerKey": { + "Description": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The answers to the Qualification test specified in the Test\n parameter.

" + "smithy.api#documentation": "

A long description for the Qualification type.\n

" } } }, @@ -3125,17 +3125,17 @@ "com.amazonaws.mturk#RejectAssignmentRequest": { "type": "structure", "members": { - "AssignmentId": { - "target": "com.amazonaws.mturk#EntityId", + "RequesterFeedback": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n The ID of the assignment. The assignment must correspond to a HIT created by the Requester.\n

", + "smithy.api#documentation": "

\n A message for the Worker, which the Worker can see in the Status section of the web site.\n

", "smithy.api#required": {} } }, - "RequesterFeedback": { - "target": "com.amazonaws.mturk#String", + "AssignmentId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

\n A message for the Worker, which the Worker can see in the Status section of the web site.\n

", + "smithy.api#documentation": "

\n The ID of the assignment. The assignment must correspond to a HIT created by the Requester.\n

", "smithy.api#required": {} } } @@ -3168,17 +3168,17 @@ "com.amazonaws.mturk#RejectQualificationRequestRequest": { "type": "structure", "members": { - "QualificationRequestId": { + "Reason": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

\n The ID of the Qualification request, as returned by the\n ListQualificationRequests\n operation.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

A text message explaining why the request was rejected, to be\n shown to the Worker who made the request.

" } }, - "Reason": { + "QualificationRequestId": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

A text message explaining why the request was rejected, to be\n shown to the Worker who made the request.

" + "smithy.api#documentation": "

\n The ID of the Qualification request, as returned by the\n ListQualificationRequests\n operation.\n

", + "smithy.api#required": {} } } } @@ -3190,11 +3190,11 @@ "com.amazonaws.mturk#RequestError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.mturk#ExceptionMessage" - }, "TurkErrorCode": { "target": "com.amazonaws.mturk#TurkErrorCode" + }, + "Message": { + "target": "com.amazonaws.mturk#ExceptionMessage" } }, "traits": { @@ -3216,28 +3216,40 @@ "com.amazonaws.mturk#ReviewActionDetail": { "type": "structure", "members": { - "ActionId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the action.

" - } - }, "CompleteTime": { "target": "com.amazonaws.mturk#Timestamp", "traits": { "smithy.api#documentation": "

The date when the action was completed.

" } }, + "Result": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

A description of the outcome of the review.

" + } + }, "ActionName": { "target": "com.amazonaws.mturk#String", "traits": { "smithy.api#documentation": "

The nature of the action itself. The Review Policy is\n responsible for examining the HIT and Assignments, emitting results,\n and deciding which other actions will be necessary.

" } }, - "Result": { + "Status": { + "target": "com.amazonaws.mturk#ReviewActionStatus", + "traits": { + "smithy.api#documentation": "

The current disposition of the action: INTENDED, SUCCEEDED,\n FAILED, or CANCELLED.\n

" + } + }, + "ErrorCode": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

A description of the outcome of the review.

" + "smithy.api#documentation": "

Present only when the Results have a FAILED Status.

" + } + }, + "ActionId": { + "target": "com.amazonaws.mturk#EntityId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the action.

" } }, "TargetId": { @@ -3251,18 +3263,6 @@ "traits": { "smithy.api#documentation": "

The type of object in TargetId.

" } - }, - "ErrorCode": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

Present only when the Results have a FAILED Status.

" - } - }, - "Status": { - "target": "com.amazonaws.mturk#ReviewActionStatus", - "traits": { - "smithy.api#documentation": "

The current disposition of the action: INTENDED, SUCCEEDED,\n FAILED, or CANCELLED.\n

" - } } }, "traits": { @@ -3301,18 +3301,18 @@ "com.amazonaws.mturk#ReviewPolicy": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.mturk#PolicyParameterList", - "traits": { - "smithy.api#documentation": "

Name of the parameter from the Review policy.

" - } - }, "PolicyName": { "target": "com.amazonaws.mturk#String", "traits": { "smithy.api#documentation": "

Name of a Review Policy: SimplePlurality/2011-09-01 or\n ScoreMyKnownAnswers/2011-09-01\n

", "smithy.api#required": {} } + }, + "Parameters": { + "target": "com.amazonaws.mturk#PolicyParameterList", + "traits": { + "smithy.api#documentation": "

Name of the parameter from the Review policy.

" + } } }, "traits": { @@ -3369,34 +3369,34 @@ "smithy.api#documentation": "

Specifies the QuestionId the result is describing. Depending\n on whether the TargetType is a HIT or Assignment this results could\n specify multiple values. If TargetType is HIT and QuestionId is\n absent, then the result describes results of the HIT, including the\n HIT agreement score. If ObjectType is Assignment and QuestionId is\n absent, then the result describes the Worker's performance on the\n HIT.\n

" } }, - "ActionId": { - "target": "com.amazonaws.mturk#EntityId", + "Value": { + "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

A unique identifier of the Review action result.\n

" + "smithy.api#documentation": "

The values of Key provided by the review policies you have\n selected.\n

" } }, - "Key": { + "SubjectType": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

Key identifies the particular piece of reviewed information.\n

" + "smithy.api#documentation": "

The type of the object from the SubjectId field.

" } }, - "SubjectId": { + "ActionId": { "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The HITID or AssignmentId about which this result was taken.\n Note that HIT-level Review Policies will often emit results about\n both the HIT itself and its Assignments, while Assignment-level\n review policies generally only emit results about the Assignment\n itself.\n

" + "smithy.api#documentation": "

A unique identifier of the Review action result.\n

" } }, - "SubjectType": { + "Key": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The type of the object from the SubjectId field.

" + "smithy.api#documentation": "

Key identifies the particular piece of reviewed information.\n

" } }, - "Value": { - "target": "com.amazonaws.mturk#String", + "SubjectId": { + "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The values of Key provided by the review policies you have\n selected.\n

" + "smithy.api#documentation": "

The HITID or AssignmentId about which this result was taken.\n Note that HIT-level Review Policies will often emit results about\n both the HIT itself and its Assignments, while Assignment-level\n review policies generally only emit results about the Assignment\n itself.\n

" } } }, @@ -3448,13 +3448,6 @@ "com.amazonaws.mturk#SendBonusRequest": { "type": "structure", "members": { - "AssignmentId": { - "target": "com.amazonaws.mturk#EntityId", - "traits": { - "smithy.api#documentation": "

The ID of the assignment for which this bonus is paid.

", - "smithy.api#required": {} - } - }, "Reason": { "target": "com.amazonaws.mturk#String", "traits": { @@ -3481,6 +3474,13 @@ "traits": { "smithy.api#documentation": "

A unique identifier for this request, which allows you to\n retry the call on error without granting multiple bonuses. This is\n useful in cases such as network timeouts where it is unclear whether\n or not the call succeeded on the server. If the bonus already exists\n in the system from a previous call using the same UniqueRequestToken,\n subsequent calls will return an error with a message containing the\n request ID.

" } + }, + "AssignmentId": { + "target": "com.amazonaws.mturk#EntityId", + "traits": { + "smithy.api#documentation": "

The ID of the assignment for which this bonus is paid.

", + "smithy.api#required": {} + } } } }, @@ -3511,17 +3511,17 @@ "com.amazonaws.mturk#SendTestEventNotificationRequest": { "type": "structure", "members": { - "Notification": { - "target": "com.amazonaws.mturk#NotificationSpecification", + "TestEventType": { + "target": "com.amazonaws.mturk#EventType", "traits": { - "smithy.api#documentation": "

\n The notification specification to test. This value is identical to the value\n you would provide to the UpdateNotificationSettings operation when you establish\n the notification specification for a HIT type.\n

", + "smithy.api#documentation": "

\n The event to simulate to test the notification specification.\n This event is included in the test message even if the notification specification\n does not include the event type.\n The notification specification does not filter out the test event.\n

", "smithy.api#required": {} } }, - "TestEventType": { - "target": "com.amazonaws.mturk#EventType", + "Notification": { + "target": "com.amazonaws.mturk#NotificationSpecification", "traits": { - "smithy.api#documentation": "

\n The event to simulate to test the notification specification.\n This event is included in the test message even if the notification specification\n does not include the event type.\n The notification specification does not filter out the test event.\n

", + "smithy.api#documentation": "

\n The notification specification to test. This value is identical to the value\n you would provide to the UpdateNotificationSettings operation when you establish\n the notification specification for a HIT type.\n

", "smithy.api#required": {} } } @@ -3534,11 +3534,11 @@ "com.amazonaws.mturk#ServiceFault": { "type": "structure", "members": { - "TurkErrorCode": { - "target": "com.amazonaws.mturk#TurkErrorCode" - }, "Message": { "target": "com.amazonaws.mturk#ExceptionMessage" + }, + "TurkErrorCode": { + "target": "com.amazonaws.mturk#TurkErrorCode" } }, "traits": { @@ -3673,17 +3673,17 @@ "com.amazonaws.mturk#UpdateHITTypeOfHITRequest": { "type": "structure", "members": { - "HITTypeId": { + "HITId": { "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The ID of the new HIT type.

", + "smithy.api#documentation": "

The HIT to update.

", "smithy.api#required": {} } }, - "HITId": { + "HITTypeId": { "target": "com.amazonaws.mturk#EntityId", "traits": { - "smithy.api#documentation": "

The HIT to update.

", + "smithy.api#documentation": "

The ID of the new HIT type.

", "smithy.api#required": {} } } @@ -3723,18 +3723,18 @@ "smithy.api#documentation": "

\n Specifies whether notifications are sent for HITs of this HIT type,\n according to the notification specification.\n You must specify either the Notification parameter or the Active parameter\n for the call to UpdateNotificationSettings to succeed.\n

" } }, + "Notification": { + "target": "com.amazonaws.mturk#NotificationSpecification", + "traits": { + "smithy.api#documentation": "

\n The notification specification for the HIT type.\n

" + } + }, "HITTypeId": { "target": "com.amazonaws.mturk#EntityId", "traits": { "smithy.api#documentation": "

\n The ID of the HIT type whose notification specification is being updated.\n

", "smithy.api#required": {} } - }, - "Notification": { - "target": "com.amazonaws.mturk#NotificationSpecification", - "traits": { - "smithy.api#documentation": "

\n The notification specification for the HIT type.\n

" - } } } }, @@ -3784,10 +3784,22 @@ "smithy.api#documentation": "

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

\n

Constraints: If the Test parameter is specified, this parameter cannot be true.

" } }, - "AnswerKey": { + "AutoGrantedValue": { + "target": "com.amazonaws.mturk#Integer", + "traits": { + "smithy.api#documentation": "

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

" + } + }, + "Test": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

" + "smithy.api#documentation": "

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

\n

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

\n

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

" + } + }, + "Description": { + "target": "com.amazonaws.mturk#String", + "traits": { + "smithy.api#documentation": "

The new description of the Qualification type.

" } }, "TestDurationInSeconds": { @@ -3802,22 +3814,10 @@ "smithy.api#documentation": "

The new status of the Qualification type - Active | Inactive

" } }, - "AutoGrantedValue": { - "target": "com.amazonaws.mturk#Integer", - "traits": { - "smithy.api#documentation": "

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

" - } - }, - "Test": { - "target": "com.amazonaws.mturk#String", - "traits": { - "smithy.api#documentation": "

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

\n

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

\n

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

" - } - }, - "Description": { + "AnswerKey": { "target": "com.amazonaws.mturk#String", "traits": { - "smithy.api#documentation": "

The new description of the Qualification type.

" + "smithy.api#documentation": "

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

" } } } 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 bf4904aef188..72c6db0e007e 100644 --- a/codegen/sdk-codegen/aws-models/neptune.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/neptune.2014-10-31.json @@ -55,17 +55,17 @@ "com.amazonaws.neptune#AddRoleToDBClusterMessage": { "type": "structure", "members": { - "DBClusterIdentifier": { + "RoleArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster to associate the IAM role with.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster,\n for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

", "smithy.api#required": {} } }, - "RoleArn": { + "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster,\n for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

", + "smithy.api#documentation": "

The name of the DB cluster to associate the IAM role with.

", "smithy.api#required": {} } } @@ -344,7 +344,7 @@ "sdkId": "Neptune", "arnNamespace": "rds", "cloudFormationName": "Neptune", - "cloudTrailEventSource": "v20141031.admin.rds" + "cloudTrailEventSource": "neptune.amazonaws.com" }, "aws.auth#sigv4": { "name": "rds" @@ -397,17 +397,17 @@ "smithy.api#required": {} } }, - "OptInType": { + "ResourceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in\n request of type immediate can't be undone.

\n

Valid values:

\n
    \n
  • \n

    \n immediate - Apply the maintenance action immediately.

    \n
    • \n
  • \n

    \n next-maintenance - Apply the maintenance action during the next\n maintenance window for the resource.

    \n
    • \n
  • \n

    \n undo-opt-in - Cancel any existing next-maintenance opt-in\n requests.

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies\n to. For information about creating an ARN, see Constructing an\n Amazon Resource Name (ARN).

", "smithy.api#required": {} } }, - "ResourceIdentifier": { + "OptInType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies\n to. For information about creating an ARN, see Constructing an\n Amazon Resource Name (ARN).

", + "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in\n request of type immediate can't be undone.

\n

Valid values:

\n
    \n
  • \n

    \n immediate - Apply the maintenance action immediately.

    \n
    • \n
  • \n

    \n next-maintenance - Apply the maintenance action during the next\n maintenance window for the resource.

    \n
    • \n
  • \n

    \n undo-opt-in - Cancel any existing next-maintenance opt-in\n requests.

    \n
    • \n
", "smithy.api#required": {} } } @@ -506,16 +506,16 @@ "com.amazonaws.neptune#CharacterSet": { "type": "structure", "members": { - "CharacterSetName": { + "CharacterSetDescription": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the character set.

" + "smithy.api#documentation": "

The description of the character set.

" } }, - "CharacterSetDescription": { + "CharacterSetName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The description of the character set.

" + "smithy.api#documentation": "

The name of the character set.

" } } }, @@ -526,16 +526,16 @@ "com.amazonaws.neptune#CloudwatchLogsExportConfiguration": { "type": "structure", "members": { - "EnableLogTypes": { + "DisableLogTypes": { "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of log types to enable.

" + "smithy.api#documentation": "

The list of log types to disable.

" } }, - "DisableLogTypes": { + "EnableLogTypes": { "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of log types to disable.

" + "smithy.api#documentation": "

The list of log types to enable.

" } } }, @@ -569,12 +569,6 @@ "com.amazonaws.neptune#CopyDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.neptune#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the copied DB cluster parameter group.

" - } - }, "SourceDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { @@ -595,6 +589,12 @@ "smithy.api#documentation": "

A description for the copied DB cluster parameter group.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.neptune#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the copied DB cluster parameter group.

" + } } } }, @@ -641,10 +641,11 @@ "com.amazonaws.neptune#CopyDBClusterSnapshotMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.neptune#TagList", + "SourceDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The tags to assign to the new DB cluster snapshot copy.

" + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter is not\n case-sensitive.

\n

You can't copy from one AWS Region to another.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
  • \n

    Specify a valid DB snapshot identifier.

    \n
    • \n
\n

Example: my-cluster-snapshot1\n

", + "smithy.api#required": {} } }, "CopyTags": { @@ -653,23 +654,22 @@ "smithy.api#documentation": "

True to copy all tags from the source DB cluster snapshot to the target DB cluster\n snapshot, and otherwise false. The default is false.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.neptune#String", + "Tags": { + "target": "com.amazonaws.neptune#TagList", "traits": { - "smithy.api#documentation": "

The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon\n Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

\n\n

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a\n value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you\n don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is\n encrypted with the same KMS key as the source DB cluster snapshot.

\n\n

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then\n you must specify a value for KmsKeyId.

\n

KMS encryption keys are specific to the AWS Region that they are created in, and you\n can't use encryption keys from one AWS Region in another AWS Region.

\n\n

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to\n copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an\n error is returned.

" + "smithy.api#documentation": "

The tags to assign to the new DB cluster snapshot copy.

" } }, - "SourceDBClusterSnapshotIdentifier": { + "PreSignedUrl": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter is not\n case-sensitive.

\n

You can't copy from one AWS Region to another.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
  • \n

    Specify a valid DB snapshot identifier.

    \n
    • \n
\n

Example: my-cluster-snapshot1\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

Not currently supported.

" } }, - "PreSignedUrl": { + "KmsKeyId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Not currently supported.

" + "smithy.api#documentation": "

The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon\n Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

\n\n

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a\n value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you\n don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is\n encrypted with the same KMS key as the source DB cluster snapshot.

\n\n

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then\n you must specify a value for KmsKeyId.

\n

KMS encryption keys are specific to the AWS Region that they are created in, and you\n can't use encryption keys from one AWS Region in another AWS Region.

\n\n

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to\n copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an\n error is returned.

" } }, "TargetDBClusterSnapshotIdentifier": { @@ -715,6 +715,13 @@ "com.amazonaws.neptune#CopyDBParameterGroupMessage": { "type": "structure", "members": { + "TargetDBParameterGroupIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Cannot be null, empty, or blank.

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n\n

Example: my-db-parameter-group\n

", + "smithy.api#required": {} + } + }, "TargetDBParameterGroupDescription": { "target": "com.amazonaws.neptune#String", "traits": { @@ -722,10 +729,10 @@ "smithy.api#required": {} } }, - "TargetDBParameterGroupIdentifier": { + "SourceDBParameterGroupIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Cannot be null, empty, or blank.

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n\n

Example: my-db-parameter-group\n

", + "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group. For information about creating\n an ARN, see Constructing an\n Amazon Resource Name (ARN).

\n\n

Constraints:

\n\n
    \n
  • \n

    Must specify a valid DB parameter group.

    \n
    • \n
  • \n

    Must specify a valid DB parameter group identifier, for example\n my-db-param-group, or a valid ARN.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -734,13 +741,6 @@ "traits": { "smithy.api#documentation": "

The tags to be assigned to the copied DB parameter group.

" } - }, - "SourceDBParameterGroupIdentifier": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group. For information about creating\n an ARN, see Constructing an\n Amazon Resource Name (ARN).

\n\n

Constraints:

\n\n
    \n
  • \n

    Must specify a valid DB parameter group.

    \n
    • \n
  • \n

    Must specify a valid DB parameter group identifier, for example\n my-db-param-group, or a valid ARN.

    \n
    • \n
", - "smithy.api#required": {} - } } } }, @@ -814,16 +814,28 @@ "com.amazonaws.neptune#CreateDBClusterMessage": { "type": "structure", "members": { - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.neptune#BooleanOptional", + "CharacterSetName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

Default: false\n

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "ReplicationSourceIdentifier": { + "Port": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

Default: 8182\n

" + } + }, + "PreSignedUrl": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster\n is created as a Read Replica.

" + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. You must specify a minimum\n value of 1.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" } }, "Tags": { @@ -832,71 +844,58 @@ "smithy.api#documentation": "

The tags to assign to the new DB cluster.

" } }, - "MasterUserPassword": { - "target": "com.amazonaws.neptune#String", + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII\n character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

" + "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

Default: false\n

" } }, - "DBClusterIdentifier": { + "MasterUserPassword": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. You must specify a minimum\n value of 1.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" + "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII\n character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

" } }, - "OptionGroupName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated\n Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week. To see the time blocks available, see\n Adjusting the Preferred\n Maintenance Window in the Amazon Neptune User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, - "DBClusterParameterGroupName": { + "MasterUsername": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot be a reserved word for the chosen database engine.

    \n
    • \n
" } }, - "Port": { - "target": "com.amazonaws.neptune#IntegerOptional", + "KmsKeyId": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

Default: 8182\n

" + "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If\n you are creating a DB cluster with the same AWS account that owns the KMS encryption key used\n to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the\n KMS encryption key.

\n

If an encryption key is not specified in KmsKeyId:

\n
    \n
  • \n

    If ReplicationSourceIdentifier identifies an encrypted source, then\n Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon\n Neptune will use your default encryption key.

    \n
    • \n
  • \n

    If the StorageEncrypted parameter is true and\n ReplicationSourceIdentifier is not specified, then Amazon Neptune will use\n your default encryption key.

    \n
    • \n
\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

\n

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must\n set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This\n key is used to encrypt the Read Replica in that AWS Region.

" } }, - "EngineVersion": { + "DBSubnetGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use. Currently, setting this\n parameter has no effect.

\n

Example: 1.0.1\n

" + "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mySubnetgroup\n

" } }, - "StorageEncrypted": { + "DeletionProtection": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

" + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled. By default,\n deletion protection is enabled.

" } }, - "CharacterSetName": { + "DatabaseName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

The name for your database of up to 64 alpha-numeric characters. If you do not provide a\n name, Amazon Neptune will not create a database in the DB cluster you are creating.

" } }, - "DBSubnetGroupName": { + "PreferredBackupWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mySubnetgroup\n

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

" + "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are\n enabled using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. To see the time blocks available, see Adjusting the Preferred\n Maintenance Window in the Amazon Neptune User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" } }, "AvailabilityZones": { @@ -912,52 +911,53 @@ "smithy.api#required": {} } }, + "EngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use. Currently, setting this\n parameter has no effect.

\n

Example: 1.0.1\n

" + } + }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.neptune#LogTypeList", "traits": { "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs.

" } }, - "DatabaseName": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alpha-numeric characters. If you do not provide a\n name, Amazon Neptune will not create a database in the DB cluster you are creating.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.neptune#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled. By default,\n deletion protection is enabled.

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" } }, - "MasterUsername": { + "ReplicationSourceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot be a reserved word for the chosen database engine.

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster\n is created as a Read Replica.

" } }, - "PreSignedUrl": { - "target": "com.amazonaws.neptune#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

" } }, - "KmsKeyId": { + "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If\n you are creating a DB cluster with the same AWS account that owns the KMS encryption key used\n to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the\n KMS encryption key.

\n

If an encryption key is not specified in KmsKeyId:

\n
    \n
  • \n

    If ReplicationSourceIdentifier identifies an encrypted source, then\n Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon\n Neptune will use your default encryption key.

    \n
    • \n
  • \n

    If the StorageEncrypted parameter is true and\n ReplicationSourceIdentifier is not specified, then Amazon Neptune will use\n your default encryption key.

    \n
    • \n
\n

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

\n

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must\n set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This\n key is used to encrypt the Read Replica in that AWS Region.

" + "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.neptune#String", + "StorageEncrypted": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are\n enabled using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. To see the time blocks available, see Adjusting the Preferred\n Maintenance Window in the Amazon Neptune User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

" } }, - "PreferredMaintenanceWindow": { + "OptionGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated\n Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week. To see the time blocks available, see\n Adjusting the Preferred\n Maintenance Window in the Amazon Neptune User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } } } @@ -985,10 +985,10 @@ "com.amazonaws.neptune#CreateDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Description": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The description for the DB cluster parameter group.

", + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", "smithy.api#required": {} } }, @@ -998,10 +998,10 @@ "smithy.api#documentation": "

The tags to be assigned to the new DB cluster parameter group.

" } }, - "DBClusterParameterGroupName": { + "Description": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#documentation": "

The description for the DB cluster parameter group.

", "smithy.api#required": {} } }, @@ -1068,17 +1068,17 @@ "smithy.api#documentation": "

The tags to be assigned to the DB cluster snapshot.

" } }, - "DBClusterIdentifier": { + "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter is not\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1-snapshot1\n

", "smithy.api#required": {} } }, - "DBClusterSnapshotIdentifier": { + "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1-snapshot1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter is not\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Example: my-cluster1\n

", "smithy.api#required": {} } } @@ -1163,46 +1163,52 @@ "com.amazonaws.neptune#CreateDBInstanceMessage": { "type": "structure", "members": { - "DomainIAMRoleName": { + "MonitoringRoleArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory\n Service.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to\n Amazon CloudWatch Logs. For example,\n arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a\n MonitoringRoleArn value.

" } }, - "PromotionTier": { - "target": "com.amazonaws.neptune#IntegerOptional", + "TdeCredentialArn": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Read Replica is promoted to the primary\n instance after a failure of the existing primary instance.\n

\n

Default: 1

\n

Valid Values: 0 - 15

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" } }, - "MasterUserPassword": { + "CharacterSetName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\".

\n

Not used.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "Domain": { + "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory Domain to create the instance in.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "MonitoringRoleArn": { + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

True to enable AWS Identity and Access Management (IAM) authentication for Neptune.

\n

Default: false\n

" + } + }, + "DomainIAMRoleName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to\n Amazon CloudWatch Logs. For example,\n arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a\n MonitoringRoleArn value.

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory\n Service.

" } }, - "Tags": { - "target": "com.amazonaws.neptune#TagList", + "Port": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The tags to assign to the new instance.

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.

\n

Default: 8182\n

\n

Type: Integer

" } }, - "EnableIAMDatabaseAuthentication": { + "CopyTagsToSnapshot": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

True to enable AWS Identity and Access Management (IAM) authentication for Neptune.

\n

Default: false\n

" + "smithy.api#documentation": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise\n false. The default is false.

" } }, "MultiAZ": { @@ -1211,218 +1217,212 @@ "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone\n parameter if the MultiAZ parameter is set to true.

" } }, - "TdeCredentialArn": { - "target": "com.amazonaws.neptune#String", + "PromotionTier": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" + "smithy.api#documentation": "

A value that specifies the order in which an Read Replica is promoted to the primary\n instance after a failure of the existing primary instance.\n

\n

Default: 1

\n

Valid Values: 0 - 15

" } }, - "PerformanceInsightsKMSKeyId": { + "MasterUserPassword": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\".

\n

Not used.

" } }, - "PubliclyAccessible": { - "target": "com.amazonaws.neptune#BooleanOptional", + "BackupRetentionPeriod": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This flag should no longer be used.

" + "smithy.api#documentation": "

The number of days for which automated backups are\n retained.

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.\n For more information, see CreateDBCluster.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35

    \n
    • \n
  • \n

    Cannot be set to 0 if the DB instance is a source to Read Replicas

    \n
    • \n
" } }, - "DBClusterIdentifier": { + "DBParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster that the instance will belong to.

\n

For information on creating a DB cluster, see CreateDBCluster.

\n

Type: String

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are\n retained.

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.\n For more information, see CreateDBCluster.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35

    \n
    • \n
  • \n

    Cannot be set to 0 if the DB instance is a source to Read Replicas

    \n
    • \n
" + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If this argument is\n omitted, the default DBParameterGroup for the specified engine is used.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" } }, - "Port": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DBSecurityGroups": { + "target": "com.amazonaws.neptune#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.

\n

Default: 8182\n

\n

Type: Integer

" + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" } }, - "CharacterSetName": { + "Domain": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

Specify the Active Directory Domain to create the instance in.

" } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", + "MonitoringInterval": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Not applicable. The associated list of EC2 VPC security groups is managed by the DB\n cluster. For more information, see CreateDBCluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected\n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default\n is 0.

\n

If MonitoringRoleArn is specified, then you must also set\n MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" } }, - "EngineVersion": { + "MasterUsername": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use. Currently, setting this\n parameter has no effect.

" + "smithy.api#documentation": "

The name for the master user. Not used.

" } }, - "StorageEncrypted": { + "AutoMinorVersionUpgrade": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance is encrypted.

\n

Not applicable. The encryption for DB instances is managed by the DB cluster. For more\n information, see CreateDBCluster.

\n

Default: false

" + "smithy.api#documentation": "

Indicates that minor engine upgrades are applied automatically to the DB instance during\n the maintenance window.

\n

Default: true\n

" } }, - "StorageType": { + "DBName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Not applicable. Storage is managed by the DB Cluster.

" + "smithy.api#documentation": "

Not supported.

" } }, - "DBInstanceIdentifier": { + "AvailabilityZone": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The EC2 Availability Zone that the DB instance is created in

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is\n set to true. The specified Availability Zone must be in the same AWS Region as\n the current endpoint.

" } }, - "OptionGroupName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.neptune#IntegerOptional", + "KmsKeyId": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate for the DB instance.

\n

Type: Integer

\n

Not applicable. Neptune cluster volumes automatically grow as the amount of data in your\n database increases, though you are only charged for the space that you use in a Neptune\n cluster volume.

" + "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB instance.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If\n you are creating a DB instance with the same AWS account that owns the KMS encryption key used\n to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the\n KM encryption key.

\n

Not applicable. The KMS key identifier is managed by the DB cluster. For more information,\n see CreateDBCluster.

\n

If the StorageEncrypted parameter is true, and you do not specify a value for\n the KmsKeyId parameter, then Amazon Neptune will use your default encryption key.\n AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" } }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.neptune#BooleanOptional", + "PreferredBackupWindow": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

The daily time range during which automated backups are created.

\n

Not applicable. The daily time range for creating automated backups is managed by the DB\n cluster. For more information, see CreateDBCluster.

" } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.neptune#LogTypeList", + "DBSubnetGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs.

" + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

If there is no DB subnet group, then it is a non-VPC DB instance.

" } }, - "Iops": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DeletionProtection": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially\n allocated for the DB instance.

" + "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. See Deleting\n a DB Instance.

\n\n

DB instances in a DB cluster can be deleted even when deletion\n protection is enabled in their parent DB cluster.

" } }, - "DBInstanceClass": { + "Timezone": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions.

", - "smithy.api#required": {} - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.neptune#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates that minor engine upgrades are applied automatically to the DB instance during\n the maintenance window.

\n

Default: true\n

" + "smithy.api#documentation": "

The time zone of the DB instance.

" } }, - "DBSecurityGroups": { - "target": "com.amazonaws.neptune#DBSecurityGroupNameList", + "LicenseModel": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" + "smithy.api#documentation": "

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license |\n general-public-license\n

" } }, - "Engine": { + "TdeCredentialPassword": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: neptune\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

" } }, - "CopyTagsToSnapshot": { + "EnablePerformanceInsights": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise\n false. The default is false.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.neptune#String", + "Iops": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created.

\n

Not applicable. The daily time range for creating automated backups is managed by the DB\n cluster. For more information, see CreateDBCluster.

" + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially\n allocated for the DB instance.

" } }, - "PreferredMaintenanceWindow": { + "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Not applicable. Storage is managed by the DB Cluster.

" } }, - "DBName": { + "EngineVersion": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Not supported.

" + "smithy.api#documentation": "

The version number of the database engine to use. Currently, setting this\n parameter has no effect.

" } }, - "MasterUsername": { - "target": "com.amazonaws.neptune#String", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

The name for the master user. Not used.

" + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs.

" } }, - "KmsKeyId": { + "Engine": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB instance.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If\n you are creating a DB instance with the same AWS account that owns the KMS encryption key used\n to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the\n KM encryption key.

\n

Not applicable. The KMS key identifier is managed by the DB cluster. For more information,\n see CreateDBCluster.

\n

If the StorageEncrypted parameter is true, and you do not specify a value for\n the KmsKeyId parameter, then Amazon Neptune will use your default encryption key.\n AWS KMS creates the default encryption key for your AWS account. Your AWS account has a\n different default encryption key for each AWS Region.

" + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: neptune\n

", + "smithy.api#required": {} } }, - "AvailabilityZone": { - "target": "com.amazonaws.neptune#String", + "PubliclyAccessible": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The EC2 Availability Zone that the DB instance is created in

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is\n set to true. The specified Availability Zone must be in the same AWS Region as\n the current endpoint.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This flag should no longer be used.

" } }, - "LicenseModel": { + "DBInstanceClass": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license |\n general-public-license\n

" + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions.

", + "smithy.api#required": {} } }, - "Timezone": { - "target": "com.amazonaws.neptune#String", + "Tags": { + "target": "com.amazonaws.neptune#TagList", "traits": { - "smithy.api#documentation": "

The time zone of the DB instance.

" + "smithy.api#documentation": "

The tags to assign to the new instance.

" } }, - "MonitoringInterval": { - "target": "com.amazonaws.neptune#IntegerOptional", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected\n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default\n is 0.

\n

If MonitoringRoleArn is specified, then you must also set\n MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Not applicable. The associated list of EC2 VPC security groups is managed by the DB\n cluster. For more information, see CreateDBCluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" } }, - "DeletionProtection": { - "target": "com.amazonaws.neptune#BooleanOptional", + "OptionGroupName": { + "target": "com.amazonaws.neptune#String", "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. See Deleting\n a DB Instance.

\n\n

DB instances in a DB cluster can be deleted even when deletion\n protection is enabled in their parent DB cluster.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "DBSubnetGroupName": { + "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

If there is no DB subnet group, then it is a non-VPC DB instance.

" + "smithy.api#documentation": "

The identifier of the DB cluster that the instance will belong to.

\n

For information on creating a DB cluster, see CreateDBCluster.

\n

Type: String

" } }, - "TdeCredentialPassword": { + "DBInstanceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

" + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", + "smithy.api#required": {} } }, - "DBParameterGroupName": { - "target": "com.amazonaws.neptune#String", + "AllocatedStorage": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If this argument is\n omitted, the default DBParameterGroup for the specified engine is used.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate for the DB instance.

\n

Type: Integer

\n

Not applicable. Neptune cluster volumes automatically grow as the amount of data in your\n database increases, though you are only charged for the space that you use in a Neptune\n cluster volume.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is encrypted.

\n

Not applicable. The encryption for DB instances is managed by the DB cluster. For more\n information, see CreateDBCluster.

\n

Default: false

" } } } @@ -1458,6 +1458,12 @@ "com.amazonaws.neptune#CreateDBParameterGroupMessage": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.neptune#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the new DB parameter group.

" + } + }, "DBParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { @@ -1465,12 +1471,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.neptune#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the new DB parameter group.

" - } - }, "Description": { "target": "com.amazonaws.neptune#String", "traits": { @@ -1527,23 +1527,16 @@ "com.amazonaws.neptune#CreateDBSubnetGroupMessage": { "type": "structure", "members": { - "DBSubnetGroupDescription": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The description for the DB subnet group.

", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.neptune#TagList", "traits": { "smithy.api#documentation": "

The tags to be assigned to the new DB subnet group.

" } }, - "DBSubnetGroupName": { + "DBSubnetGroupDescription": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces,\n or hyphens. Must not be default.

\n

Example: mySubnetgroup\n

", + "smithy.api#documentation": "

The description for the DB subnet group.

", "smithy.api#required": {} } }, @@ -1553,6 +1546,13 @@ "smithy.api#documentation": "

The EC2 Subnet IDs for the DB subnet group.

", "smithy.api#required": {} } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces,\n or hyphens. Must not be default.

\n

Example: mySubnetgroup\n

", + "smithy.api#required": {} + } } } }, @@ -1602,17 +1602,16 @@ "com.amazonaws.neptune#CreateEventSubscriptionMessage": { "type": "structure", "members": { - "SubscriptionName": { - "target": "com.amazonaws.neptune#String", + "Tags": { + "target": "com.amazonaws.neptune#TagList", "traits": { - "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to be applied to the new event subscription.

" } }, - "EventCategories": { - "target": "com.amazonaws.neptune#EventCategoriesList", + "SourceType": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A list of event categories for a SourceType that you want to subscribe to. You can see a\n list of the categories for a given SourceType by using the\n DescribeEventCategories action.

" + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified\n of events generated by a DB instance, you would set this parameter to db-instance. if this\n value is not specified, all events are returned.

\n

Valid values: db-instance | db-cluster |\n db-parameter-group | db-security-group | db-snapshot |\n db-cluster-snapshot\n

" } }, "SnsTopicArn": { @@ -1622,28 +1621,29 @@ "smithy.api#required": {} } }, + "EventCategories": { + "target": "com.amazonaws.neptune#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for a SourceType that you want to subscribe to. You can see a\n list of the categories for a given SourceType by using the\n DescribeEventCategories action.

" + } + }, "SourceIds": { "target": "com.amazonaws.neptune#SourceIdsList", "traits": { "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not\n specified, then all sources are included in the response. An identifier must begin with a\n letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or\n contain two consecutive hyphens.

\n

Constraints:

\n
    \n
  • \n

    If SourceIds are supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, then a DBInstanceIdentifier must be\n supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName must be\n supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName must\n be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier must be\n supplied.

    \n
    • \n
" } }, - "Tags": { - "target": "com.amazonaws.neptune#TagList", + "Enabled": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The tags to be applied to the new event subscription.

" + "smithy.api#documentation": "

A Boolean value; set to true to activate the\n subscription, set to false to create the subscription but not\n active it.

" } }, - "SourceType": { + "SubscriptionName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified\n of events generated by a DB instance, you would set this parameter to db-instance. if this\n value is not specified, all events are returned.

\n

Valid values: db-instance | db-cluster |\n db-parameter-group | db-security-group | db-snapshot |\n db-cluster-snapshot\n

" - } - }, - "Enabled": { - "target": "com.amazonaws.neptune#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A Boolean value; set to true to activate the\n subscription, set to false to create the subscription but not\n active it.

" + "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", + "smithy.api#required": {} } } } @@ -1659,10 +1659,16 @@ "com.amazonaws.neptune#DBCluster": { "type": "structure", "members": { - "LatestRestorableTime": { - "target": "com.amazonaws.neptune#TStamp", + "EngineVersion": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" + "smithy.api#documentation": "

Indicates the database engine version.

" + } + }, + "Status": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

Specifies the current state of this DB cluster.

" } }, "ReaderEndpoint": { @@ -1671,12 +1677,30 @@ "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances\n connections across the Read Replicas that are available in a DB cluster. As clients request\n new connections to the reader endpoint, Neptune distributes the connection requests among the\n Read Replicas in the DB cluster. This functionality can help balance your read workload across\n multiple Read Replicas in your DB cluster.

\n

If a failover occurs, and the Read Replica that you are connected to is promoted to be the\n primary instance, your connection is dropped. To continue sending your read workload to other\n Read Replicas in the cluster, you can then reconnect to the reader endpoint.

" } }, + "AvailabilityZones": { + "target": "com.amazonaws.neptune#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

Provides the list of EC2 Availability Zones that instances in the DB cluster can be\n created in.

" + } + }, "Engine": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

Provides the name of the database engine to be used for this DB cluster.

" } }, + "LatestRestorableTime": { + "target": "com.amazonaws.neptune#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" + } + }, + "EarliestRestorableTime": { + "target": "com.amazonaws.neptune#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the earliest time to which a database can be restored with point-in-time\n restore.

" + } + }, "DeletionProtection": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { @@ -1689,16 +1713,10 @@ "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "HostedZoneId": { + "DatabaseName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.neptune#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

Provides the list of EC2 Availability Zones that instances in the DB cluster can be\n created in.

" + "smithy.api#documentation": "

Contains the name of the initial database of this DB cluster that was provided at create\n time, if one was specified when the DB cluster was created. This same name is returned for the\n life of the DB cluster.

" } }, "KmsKeyId": { @@ -1707,64 +1725,70 @@ "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for the\n encrypted DB cluster.

" } }, - "PreferredMaintenanceWindow": { + "HostedZoneId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

" + "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" } }, - "DatabaseName": { + "Endpoint": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Contains the name of the initial database of this DB cluster that was provided at create\n time, if one was specified when the DB cluster was created. This same name is returned for the\n life of the DB cluster.

" + "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the DB cluster.

" } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.neptune#String", + "BackupRetentionPeriod": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if automated\n backups are enabled, as determined by the BackupRetentionPeriod.

" + "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" } }, - "DBClusterArn": { + "ReadReplicaIdentifiers": { + "target": "com.amazonaws.neptune#ReadReplicaIdentifierList", + "traits": { + "smithy.api#documentation": "

Contains one or more identifiers of the Read Replicas associated with this DB\n cluster.

" + } + }, + "CloneGroupId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster.

" + "smithy.api#documentation": "

Identifies the clone group to which the DB cluster is associated.

" } }, - "DBClusterParameterGroup": { + "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the DB cluster parameter group for the DB cluster.

" + "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" } }, - "DBSubnetGroup": { + "DbClusterResourceId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB cluster, including the\n name, description, and subnets in the subnet group.

" + "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found\n in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

" } }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.neptune#LogTypeList", + "AllocatedStorage": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

" + "smithy.api#documentation": "

\n AllocatedStorage always returns 1, because Neptune DB cluster storage size is\n not fixed, but instead automatically adjusts as needed.

" } }, - "AssociatedRoles": { - "target": "com.amazonaws.neptune#DBClusterRoles", + "Port": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated\n with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the\n DB cluster to access other AWS services on your behalf.

" + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" } }, - "MultiAZ": { - "target": "com.amazonaws.neptune#Boolean", + "PercentProgress": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster has instances in multiple Availability Zones.

" + "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" } }, - "VpcSecurityGroups": { - "target": "com.amazonaws.neptune#VpcSecurityGroupMembershipList", + "CharacterSetName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides a list of VPC security groups that the DB cluster belongs to.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, "IAMDatabaseAuthenticationEnabled": { @@ -1773,22 +1797,28 @@ "smithy.api#documentation": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts\n is enabled, and otherwise false.

" } }, + "ClusterCreateTime": { + "target": "com.amazonaws.neptune#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time\n (UTC).

" + } + }, "StorageEncrypted": { "target": "com.amazonaws.neptune#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

" } }, - "ReplicationSourceIdentifier": { - "target": "com.amazonaws.neptune#String", + "MultiAZ": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Not supported by Neptune.

" + "smithy.api#documentation": "

Specifies whether the DB cluster has instances in multiple Availability Zones.

" } }, - "Endpoint": { - "target": "com.amazonaws.neptune#String", + "DBClusterMembers": { + "target": "com.amazonaws.neptune#DBClusterMemberList", "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the DB cluster.

" + "smithy.api#documentation": "

Provides the list of instances that make up the DB cluster.

" } }, "MasterUsername": { @@ -1797,88 +1827,58 @@ "smithy.api#documentation": "

Contains the master username for the DB cluster.

" } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" - } - }, - "PercentProgress": { + "ReplicationSourceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" + "smithy.api#documentation": "

Not supported by Neptune.

" } }, - "DBClusterIdentifier": { + "PreferredBackupWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if automated\n backups are enabled, as determined by the BackupRetentionPeriod.

" } }, - "CloneGroupId": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Identifies the clone group to which the DB cluster is associated.

" + "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

" } }, - "DbClusterResourceId": { + "DBSubnetGroup": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found\n in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

" - } - }, - "DBClusterMembers": { - "target": "com.amazonaws.neptune#DBClusterMemberList", - "traits": { - "smithy.api#documentation": "

Provides the list of instances that make up the DB cluster.

" + "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB cluster, including the\n name, description, and subnets in the subnet group.

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.neptune#IntegerOptional", + "VpcSecurityGroups": { + "target": "com.amazonaws.neptune#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

\n AllocatedStorage always returns 1, because Neptune DB cluster storage size is\n not fixed, but instead automatically adjusts as needed.

" + "smithy.api#documentation": "

Provides a list of VPC security groups that the DB cluster belongs to.

" } }, - "ReadReplicaIdentifiers": { - "target": "com.amazonaws.neptune#ReadReplicaIdentifierList", + "AssociatedRoles": { + "target": "com.amazonaws.neptune#DBClusterRoles", "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of the Read Replicas associated with this DB\n cluster.

" + "smithy.api#documentation": "

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated\n with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the\n DB cluster to access other AWS services on your behalf.

" } }, - "Status": { + "DBClusterArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the current state of this DB cluster.

" - } - }, - "EarliestRestorableTime": { - "target": "com.amazonaws.neptune#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the earliest time to which a database can be restored with point-in-time\n restore.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster.

" } }, - "EngineVersion": { - "target": "com.amazonaws.neptune#String", + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" + "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

" } }, - "CharacterSetName": { + "DBClusterParameterGroup": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.neptune#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time\n (UTC).

" - } - }, - "Port": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + "smithy.api#documentation": "

Specifies the name of the DB cluster parameter group for the DB cluster.

" } } }, @@ -1914,12 +1914,6 @@ "com.amazonaws.neptune#DBClusterMember": { "type": "structure", "members": { - "IsClusterWriter": { - "target": "com.amazonaws.neptune#Boolean", - "traits": { - "smithy.api#documentation": "

Value that is true if the cluster member is the primary instance for the DB\n cluster and false otherwise.

" - } - }, "DBInstanceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { @@ -1932,6 +1926,12 @@ "smithy.api#documentation": "

A value that specifies the order in which a Read Replica is promoted to the primary\n instance after a failure of the existing primary instance.

" } }, + "IsClusterWriter": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

Value that is true if the cluster member is the primary instance for the DB\n cluster and false otherwise.

" + } + }, "DBClusterParameterGroupStatus": { "target": "com.amazonaws.neptune#String", "traits": { @@ -1955,17 +1955,17 @@ "com.amazonaws.neptune#DBClusterMessage": { "type": "structure", "members": { - "DBClusters": { - "target": "com.amazonaws.neptune#DBClusterList", - "traits": { - "smithy.api#documentation": "

Contains a list of DB clusters for the user.

" - } - }, "Marker": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

A pagination token that can be used in a subsequent DescribeDBClusters request.

" } + }, + "DBClusters": { + "target": "com.amazonaws.neptune#DBClusterList", + "traits": { + "smithy.api#documentation": "

Contains a list of DB clusters for the user.

" + } } } }, @@ -1997,16 +1997,16 @@ "com.amazonaws.neptune#DBClusterOptionGroupStatus": { "type": "structure", "members": { - "DBClusterOptionGroupName": { + "Status": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the DB cluster option group.

" + "smithy.api#documentation": "

Specifies the status of the DB cluster option group.

" } }, - "Status": { + "DBClusterOptionGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the status of the DB cluster option group.

" + "smithy.api#documentation": "

Specifies the name of the DB cluster option group.

" } } }, @@ -2017,10 +2017,10 @@ "com.amazonaws.neptune#DBClusterParameterGroup": { "type": "structure", "members": { - "DBClusterParameterGroupName": { + "DBClusterParameterGroupArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the name of the DB cluster parameter group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" } }, "DBParameterGroupFamily": { @@ -2029,16 +2029,16 @@ "smithy.api#documentation": "

Provides the name of the DB parameter group family that this DB cluster parameter group is\n compatible with.

" } }, - "DBClusterParameterGroupArn": { + "Description": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" + "smithy.api#documentation": "

Provides the customer-specified description for this DB cluster parameter group.

" } }, - "Description": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the customer-specified description for this DB cluster parameter group.

" + "smithy.api#documentation": "

Provides the name of the DB cluster parameter group.

" } } }, @@ -2102,17 +2102,17 @@ "com.amazonaws.neptune#DBClusterParameterGroupsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "DBClusterParameterGroups": { "target": "com.amazonaws.neptune#DBClusterParameterGroupList", "traits": { "smithy.api#documentation": "

A list of DB cluster parameter groups.

" } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } } }, @@ -2135,16 +2135,16 @@ "com.amazonaws.neptune#DBClusterRole": { "type": "structure", "members": { - "RoleArn": { + "Status": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n cluster.

" + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status\n property returns one of the following values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be\n used to access other AWS services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB\n cluster.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB\n cluster is unable to assume the IAM role in order to access other AWS services on your\n behalf.

    \n
    • \n
" } }, - "Status": { + "RoleArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status\n property returns one of the following values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be\n used to access other AWS services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB\n cluster.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB\n cluster is unable to assume the IAM role in order to access other AWS services on your\n behalf.

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n cluster.

" } } }, @@ -2212,22 +2212,22 @@ "com.amazonaws.neptune#DBClusterSnapshot": { "type": "structure", "members": { - "ClusterCreateTime": { - "target": "com.amazonaws.neptune#TStamp", + "LicenseModel": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time\n (UTC).

" + "smithy.api#documentation": "

Provides the license model information for this DB cluster snapshot.

" } }, - "Engine": { - "target": "com.amazonaws.neptune#String", + "PercentProgress": { + "target": "com.amazonaws.neptune#Integer", "traits": { - "smithy.api#documentation": "

Specifies the name of the database engine.

" + "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" } }, - "AvailabilityZones": { - "target": "com.amazonaws.neptune#AvailabilityZones", + "StorageEncrypted": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can\n be restored in.

" + "smithy.api#documentation": "

Specifies whether the DB cluster snapshot is encrypted.

" } }, "EngineVersion": { @@ -2236,58 +2236,52 @@ "smithy.api#documentation": "

Provides the version of the database engine for this DB cluster snapshot.

" } }, - "MasterUsername": { - "target": "com.amazonaws.neptune#String", + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Provides the master username for the DB cluster snapshot.

" + "smithy.api#documentation": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts\n is enabled, and otherwise false.

" } }, - "KmsKeyId": { - "target": "com.amazonaws.neptune#String", + "AllocatedStorage": { + "target": "com.amazonaws.neptune#Integer", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB\n cluster snapshot.

" + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" } }, - "DBClusterSnapshotIdentifier": { + "VpcId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the identifier for a DB cluster snapshot. Must match the identifier\n of an existing snapshot.

\n\n

After you restore a DB cluster using a DBClusterSnapshotIdentifier,\n you must specify the same DBClusterSnapshotIdentifier for any future\n updates to the DB cluster. When you specify this property for an update, the DB\n cluster is not restored from the snapshot again, and the data in the database is not\n changed.

\n\n

However, if you don't specify the DBClusterSnapshotIdentifier, an empty\n DB cluster is created, and the original DB cluster is deleted. If you specify a\n property that is different from the previous snapshot restore property, the DB\n cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier,\n and the original DB cluster is deleted.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.neptune#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + "smithy.api#documentation": "

Provides the VPC ID associated with the DB cluster snapshot.

" } }, - "LicenseModel": { + "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the license model information for this DB cluster snapshot.

" + "smithy.api#documentation": "

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was\n created from.

" } }, - "VpcId": { + "MasterUsername": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB cluster snapshot.

" + "smithy.api#documentation": "

Provides the master username for the DB cluster snapshot.

" } }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.neptune#Boolean", + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts\n is enabled, and otherwise false.

" + "smithy.api#documentation": "

Specifies the identifier for a DB cluster snapshot. Must match the identifier\n of an existing snapshot.

\n\n

After you restore a DB cluster using a DBClusterSnapshotIdentifier,\n you must specify the same DBClusterSnapshotIdentifier for any future\n updates to the DB cluster. When you specify this property for an update, the DB\n cluster is not restored from the snapshot again, and the data in the database is not\n changed.

\n\n

However, if you don't specify the DBClusterSnapshotIdentifier, an empty\n DB cluster is created, and the original DB cluster is deleted. If you specify a\n property that is different from the previous snapshot restore property, the DB\n cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier,\n and the original DB cluster is deleted.

" } }, - "StorageEncrypted": { - "target": "com.amazonaws.neptune#Boolean", + "AvailabilityZones": { + "target": "com.amazonaws.neptune#AvailabilityZones", "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster snapshot is encrypted.

" + "smithy.api#documentation": "

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can\n be restored in.

" } }, - "DBClusterIdentifier": { + "KmsKeyId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was\n created from.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB\n cluster snapshot.

" } }, "SnapshotCreateTime": { @@ -2296,16 +2290,16 @@ "smithy.api#documentation": "

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" } }, - "PercentProgress": { - "target": "com.amazonaws.neptune#Integer", + "SourceDBClusterSnapshotArn": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" + "smithy.api#documentation": "

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" } }, - "Port": { - "target": "com.amazonaws.neptune#Integer", + "Engine": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the port that the DB cluster was listening on at the time of the\n snapshot.

" + "smithy.api#documentation": "

Specifies the name of the database engine.

" } }, "DBClusterSnapshotArn": { @@ -2314,10 +2308,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" } }, - "SourceDBClusterSnapshotArn": { + "ClusterCreateTime": { + "target": "com.amazonaws.neptune#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time\n (UTC).

" + } + }, + "SnapshotType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" + "smithy.api#documentation": "

Provides the type of the DB cluster snapshot.

" } }, "Status": { @@ -2326,10 +2326,10 @@ "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot.

" } }, - "SnapshotType": { - "target": "com.amazonaws.neptune#String", + "Port": { + "target": "com.amazonaws.neptune#Integer", "traits": { - "smithy.api#documentation": "

Provides the type of the DB cluster snapshot.

" + "smithy.api#documentation": "

Specifies the port that the DB cluster was listening on at the time of the\n snapshot.

" } } }, @@ -2356,17 +2356,17 @@ "com.amazonaws.neptune#DBClusterSnapshotAttribute": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that have\n permission to copy or restore the manual DB cluster snapshot. For more information, see the\n ModifyDBClusterSnapshotAttribute API action.

" - } - }, "AttributeValues": { "target": "com.amazonaws.neptune#AttributeValueList", "traits": { "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB\n cluster snapshot. If a value of all is in the list, then the manual DB cluster\n snapshot is public and available for any AWS account to copy or restore.

" } + }, + "AttributeName": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that have\n permission to copy or restore the manual DB cluster snapshot. For more information, see the\n ModifyDBClusterSnapshotAttribute API action.

" + } } }, "traits": { @@ -2385,17 +2385,17 @@ "com.amazonaws.neptune#DBClusterSnapshotAttributesResult": { "type": "structure", "members": { - "DBClusterSnapshotAttributes": { - "target": "com.amazonaws.neptune#DBClusterSnapshotAttributeList", - "traits": { - "smithy.api#documentation": "

The list of attributes and values for the manual DB cluster snapshot.

" - } - }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

The identifier of the manual DB cluster snapshot that the attributes apply to.

" } + }, + "DBClusterSnapshotAttributes": { + "target": "com.amazonaws.neptune#DBClusterSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the manual DB cluster snapshot.

" + } } }, "traits": { @@ -2414,17 +2414,17 @@ "com.amazonaws.neptune#DBClusterSnapshotMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.\n

" - } - }, "DBClusterSnapshots": { "target": "com.amazonaws.neptune#DBClusterSnapshotList", "traits": { "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user.

" } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.\n

" + } } } }, @@ -2447,34 +2447,16 @@ "com.amazonaws.neptune#DBEngineVersion": { "type": "structure", "members": { - "SupportedCharacterSets": { - "target": "com.amazonaws.neptune#SupportedCharacterSetsList", - "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" - } - }, - "ValidUpgradeTarget": { - "target": "com.amazonaws.neptune#ValidUpgradeTargetList", - "traits": { - "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" - } - }, - "DefaultCharacterSet": { - "target": "com.amazonaws.neptune#CharacterSet", - "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" - } - }, "SupportsReadReplica": { "target": "com.amazonaws.neptune#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the database engine version supports read replicas.

" } }, - "ExportableLogTypes": { - "target": "com.amazonaws.neptune#LogTypeList", + "SupportedCharacterSets": { + "target": "com.amazonaws.neptune#SupportedCharacterSetsList", "traits": { - "smithy.api#documentation": "

The types of logs that the database engine has available for export to CloudWatch\n Logs.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, "SupportedTimezones": { @@ -2489,10 +2471,22 @@ "smithy.api#documentation": "

The description of the database engine.

" } }, - "SupportsLogExportsToCloudwatchLogs": { - "target": "com.amazonaws.neptune#Boolean", + "DefaultCharacterSet": { + "target": "com.amazonaws.neptune#CharacterSet", "traits": { - "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types\n specified by ExportableLogTypes to CloudWatch Logs.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine.

" + } + }, + "ExportableLogTypes": { + "target": "com.amazonaws.neptune#LogTypeList", + "traits": { + "smithy.api#documentation": "

The types of logs that the database engine has available for export to CloudWatch\n Logs.

" } }, "Engine": { @@ -2501,10 +2495,10 @@ "smithy.api#documentation": "

The name of the database engine.

" } }, - "EngineVersion": { + "DBEngineVersionDescription": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine.

" + "smithy.api#documentation": "

The description of the database engine version.

" } }, "DBParameterGroupFamily": { @@ -2513,10 +2507,16 @@ "smithy.api#documentation": "

The name of the DB parameter group family for the database engine.

" } }, - "DBEngineVersionDescription": { - "target": "com.amazonaws.neptune#String", + "ValidUpgradeTarget": { + "target": "com.amazonaws.neptune#ValidUpgradeTargetList", "traits": { - "smithy.api#documentation": "

The description of the database engine version.

" + "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" + } + }, + "SupportsLogExportsToCloudwatchLogs": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types\n specified by ExportableLogTypes to CloudWatch Logs.

" } } }, @@ -2536,33 +2536,27 @@ "com.amazonaws.neptune#DBEngineVersionMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "DBEngineVersions": { "target": "com.amazonaws.neptune#DBEngineVersionList", "traits": { "smithy.api#documentation": "

A list of DBEngineVersion elements.

" } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } } }, "com.amazonaws.neptune#DBInstance": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance is located in.

" - } - }, - "DBName": { + "CACertificateIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The database name.

" + "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" } }, "ReadReplicaDBInstanceIdentifiers": { @@ -2571,64 +2565,76 @@ "smithy.api#documentation": "

Contains one or more identifiers of the Read Replicas associated with this DB\n instance.

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.neptune#Integer", + "DBName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the allocated storage size specified in gibibytes.

" + "smithy.api#documentation": "

The database name.

" } }, - "CACertificateIdentifier": { + "AvailabilityZone": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" + "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance is located in.

" } }, - "DBInstanceClass": { + "ReadReplicaSourceDBInstanceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the DB instance.

" + "smithy.api#documentation": "

Contains the identifier of the source DB instance if this DB instance is a Read\n Replica.

" } }, - "LatestRestorableTime": { - "target": "com.amazonaws.neptune#TStamp", + "MonitoringRoleArn": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to\n Amazon CloudWatch Logs.

" } }, - "Engine": { + "EnhancedMonitoringResourceArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the name of the database engine to be used for this DB instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the\n Enhanced Monitoring metrics data for the DB instance.

" } }, - "MonitoringInterval": { + "PromotionTier": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected\n for the DB instance.

" + "smithy.api#documentation": "

A value that specifies the order in which a Read Replica is promoted to the primary\n instance after a failure of the existing primary instance.\n

" } }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.neptune#LogTypeList", + "AllocatedStorage": { + "target": "com.amazonaws.neptune#Integer", "traits": { - "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch\n Logs.

" + "smithy.api#documentation": "

Specifies the allocated storage size specified in gibibytes.

" } }, - "DBInstanceArn": { + "CharacterSetName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB instance.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "DBInstanceStatus": { + "EngineVersion": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the current state of this database.

" + "smithy.api#documentation": "

Indicates the database engine version.

" } }, - "DBClusterIdentifier": { + "ReadReplicaDBClusterIdentifiers": { + "target": "com.amazonaws.neptune#ReadReplicaDBClusterIdentifierList", + "traits": { + "smithy.api#documentation": "

Contains one or more identifiers of DB clusters that are Read Replicas of this DB\n instance.

" + } + }, + "MasterUsername": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that\n the DB instance is a member of.

" + "smithy.api#documentation": "

Contains the master username for the DB instance.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.neptune#DBSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" } }, "DomainMemberships": { @@ -2637,155 +2643,179 @@ "smithy.api#documentation": "

Not supported

" } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.neptune#Boolean", + "SecondaryAvailabilityZone": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies whether tags are copied from the DB instance to snapshots of the DB\n instance.

" + "smithy.api#documentation": "

If present, specifies the name of the secondary Availability Zone for a DB instance with\n multi-AZ support.

" } }, - "ReadReplicaDBClusterIdentifiers": { - "target": "com.amazonaws.neptune#ReadReplicaDBClusterIdentifierList", + "OptionGroupMemberships": { + "target": "com.amazonaws.neptune#OptionGroupMembershipList", "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of DB clusters that are Read Replicas of this DB\n instance.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "StorageEncrypted": { - "target": "com.amazonaws.neptune#Boolean", + "InstanceCreateTime": { + "target": "com.amazonaws.neptune#TStamp", "traits": { - "smithy.api#documentation": "

Not supported: The encryption for DB instances is managed by the DB cluster.

" + "smithy.api#documentation": "

Provides the date and time the DB instance was created.

" } }, - "Timezone": { - "target": "com.amazonaws.neptune#String", + "StatusInfos": { + "target": "com.amazonaws.neptune#DBInstanceStatusInfoList", "traits": { - "smithy.api#documentation": "

Not supported.

" + "smithy.api#documentation": "

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

" } }, - "MonitoringRoleArn": { - "target": "com.amazonaws.neptune#String", + "MultiAZ": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to\n Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment.

" } }, - "SecondaryAvailabilityZone": { + "DBInstanceStatus": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

If present, specifies the name of the secondary Availability Zone for a DB instance with\n multi-AZ support.

" + "smithy.api#documentation": "

Specifies the current state of this database.

" } }, - "InstanceCreateTime": { + "LatestRestorableTime": { "target": "com.amazonaws.neptune#TStamp", "traits": { - "smithy.api#documentation": "

Provides the date and time the DB instance was created.

" + "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time\n restore.

" } }, - "MasterUsername": { + "DBInstanceClass": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Contains the master username for the DB instance.

" + "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the DB instance.

" } }, - "DBSecurityGroups": { - "target": "com.amazonaws.neptune#DBSecurityGroupMembershipList", + "Timezone": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + "smithy.api#documentation": "

Not supported.

" } }, - "PromotionTier": { + "DeletionProtection": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether or not the DB instance has deletion protection enabled.\n The instance can't be deleted when deletion protection is enabled. See Deleting\n a DB Instance.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.neptune#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security group elements that the DB instance belongs to.

" + } + }, + "MonitoringInterval": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which a Read Replica is promoted to the primary\n instance after a failure of the existing primary instance.\n

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected\n for the DB instance.

" } }, - "EnhancedMonitoringResourceArn": { - "target": "com.amazonaws.neptune#String", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the\n Enhanced Monitoring metrics data for the DB instance.

" + "smithy.api#documentation": "

Indicates that minor version patches are applied automatically.

" } }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.neptune#String", + "Endpoint": { + "target": "com.amazonaws.neptune#Endpoint", "traits": { - "smithy.api#documentation": "

Contains a user-supplied database identifier. This identifier is the unique key that\n identifies a DB instance.

" + "smithy.api#documentation": "

Specifies the connection endpoint.

" } }, - "ReadReplicaSourceDBInstanceIdentifier": { - "target": "com.amazonaws.neptune#String", + "DbInstancePort": { + "target": "com.amazonaws.neptune#Integer", "traits": { - "smithy.api#documentation": "

Contains the identifier of the source DB instance if this DB instance is a Read\n Replica.

" + "smithy.api#documentation": "

Specifies the port that the DB instance listens on. If the DB instance is part of a DB\n cluster, this can be a different port than the DB cluster port.

" } }, - "StorageType": { - "target": "com.amazonaws.neptune#String", + "PubliclyAccessible": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Specifies the storage type associated with DB instance.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This flag should no longer be used.

" } }, - "EngineVersion": { + "KmsKeyId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" + "smithy.api#documentation": "

Not supported: The encryption for DB instances is managed by the DB cluster.

" } }, - "CharacterSetName": { + "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "PreferredMaintenanceWindow": { + "PendingModifiedValues": { + "target": "com.amazonaws.neptune#PendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Specifies that changes to the DB instance are pending. This element is only included when\n changes are pending. Specific changes are identified by subelements.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

Not supported: The encryption for DB instances is managed by the DB cluster.

" + } + }, + "DBInstanceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

" + "smithy.api#documentation": "

Contains a user-supplied database identifier. This identifier is the unique key that\n identifies a DB instance.

" } }, - "DeletionProtection": { - "target": "com.amazonaws.neptune#BooleanOptional", + "StorageType": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Indicates whether or not the DB instance has deletion protection enabled.\n The instance can't be deleted when deletion protection is enabled. See Deleting\n a DB Instance.

" + "smithy.api#documentation": "

Specifies the storage type associated with DB instance.

" } }, - "PubliclyAccessible": { + "CopyTagsToSnapshot": { "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This flag should no longer be used.

" + "smithy.api#documentation": "

Specifies whether tags are copied from the DB instance to snapshots of the DB\n instance.

" } }, - "DBSubnetGroup": { - "target": "com.amazonaws.neptune#DBSubnetGroup", + "PreferredBackupWindow": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB instance, including the\n name, description, and subnets in the subnet group.

" + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if automated\n backups are enabled, as determined by the BackupRetentionPeriod.

" } }, - "LicenseModel": { + "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

License model information for this DB instance.

" + "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that\n the DB instance is a member of.

" } }, - "Endpoint": { - "target": "com.amazonaws.neptune#Endpoint", + "BackupRetentionPeriod": { + "target": "com.amazonaws.neptune#Integer", "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint.

" + "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" } }, - "KmsKeyId": { + "DBInstanceArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Not supported: The encryption for DB instances is managed by the DB cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB instance.

" } }, - "DbInstancePort": { - "target": "com.amazonaws.neptune#Integer", + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies the port that the DB instance listens on. If the DB instance is part of a DB\n cluster, this can be a different port than the DB cluster port.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "PendingModifiedValues": { - "target": "com.amazonaws.neptune#PendingModifiedValues", + "Engine": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies that changes to the DB instance are pending. This element is only included when\n changes are pending. Specific changes are identified by subelements.

" + "smithy.api#documentation": "

Provides the name of the database engine to be used for this DB instance.

" } }, "DBParameterGroups": { @@ -2794,16 +2824,10 @@ "smithy.api#documentation": "

Provides the list of DB parameter groups applied to this DB instance.

" } }, - "Iops": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value.

" - } - }, - "AutoMinorVersionUpgrade": { + "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Indicates that minor version patches are applied automatically.

" + "smithy.api#documentation": "

True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise\n false.

" } }, "TdeCredentialArn": { @@ -2812,40 +2836,16 @@ "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE\n encryption.

" } }, - "MultiAZ": { - "target": "com.amazonaws.neptune#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.neptune#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

Provides a list of VPC security group elements that the DB instance belongs to.

" - } - }, - "PerformanceInsightsKMSKeyId": { + "LicenseModel": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" - } - }, - "StatusInfos": { - "target": "com.amazonaws.neptune#DBInstanceStatusInfoList", - "traits": { - "smithy.api#documentation": "

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

" - } - }, - "OptionGroupMemberships": { - "target": "com.amazonaws.neptune#OptionGroupMembershipList", - "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

License model information for this DB instance.

" } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.neptune#Integer", + "DBSubnetGroup": { + "target": "com.amazonaws.neptune#DBSubnetGroup", "traits": { - "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" + "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB instance, including the\n name, description, and subnets in the subnet group.

" } }, "DbiResourceId": { @@ -2854,22 +2854,22 @@ "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found\n in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

" } }, - "PreferredBackupWindow": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the daily time range during which automated backups are created if automated\n backups are enabled, as determined by the BackupRetentionPeriod.

" + "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

" } }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.neptune#Boolean", + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise\n false.

" + "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch\n Logs.

" } }, - "PerformanceInsightsEnabled": { - "target": "com.amazonaws.neptune#BooleanOptional", + "Iops": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value.

" } } }, @@ -2905,17 +2905,17 @@ "com.amazonaws.neptune#DBInstanceMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords .

" - } - }, "DBInstances": { "target": "com.amazonaws.neptune#DBInstanceList", "traits": { "smithy.api#documentation": "

A list of DBInstance instances.

" } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords .

" + } } } }, @@ -2938,28 +2938,28 @@ "com.amazonaws.neptune#DBInstanceStatusInfo": { "type": "structure", "members": { - "Status": { + "Message": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, error, stopped, or terminated.

" + "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance is not in an\n error state, this value is blank.

" } }, - "StatusType": { - "target": "com.amazonaws.neptune#String", + "Normal": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

This value is currently \"read replication.\"

" + "smithy.api#documentation": "

Boolean value that is true if the instance is operating normally, or false if the instance\n is in an error state.

" } }, - "Message": { + "StatusType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance is not in an\n error state, this value is blank.

" + "smithy.api#documentation": "

This value is currently \"read replication.\"

" } }, - "Normal": { - "target": "com.amazonaws.neptune#Boolean", + "Status": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Boolean value that is true if the instance is operating normally, or false if the instance\n is in an error state.

" + "smithy.api#documentation": "

Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, error, stopped, or terminated.

" } } }, @@ -2979,10 +2979,10 @@ "com.amazonaws.neptune#DBParameterGroup": { "type": "structure", "members": { - "Description": { + "DBParameterGroupArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the customer-specified description for this DB parameter group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB parameter group.

" } }, "DBParameterGroupFamily": { @@ -2991,16 +2991,16 @@ "smithy.api#documentation": "

Provides the name of the DB parameter group family that this DB parameter group is\n compatible with.

" } }, - "DBParameterGroupArn": { + "DBParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB parameter group.

" + "smithy.api#documentation": "

Provides the name of the DB parameter group.

" } }, - "DBParameterGroupName": { + "Description": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the name of the DB parameter group.

" + "smithy.api#documentation": "

Provides the customer-specified description for this DB parameter group.

" } } }, @@ -3027,17 +3027,17 @@ "com.amazonaws.neptune#DBParameterGroupDetails": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.neptune#ParametersList", - "traits": { - "smithy.api#documentation": "

A list of Parameter values.

" - } - }, "Marker": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } + }, + "Parameters": { + "target": "com.amazonaws.neptune#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of Parameter values.

" + } } } }, @@ -3096,16 +3096,16 @@ "com.amazonaws.neptune#DBParameterGroupStatus": { "type": "structure", "members": { - "ParameterApplyStatus": { + "DBParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The status of parameter updates.

" + "smithy.api#documentation": "

The name of the DP parameter group.

" } }, - "DBParameterGroupName": { + "ParameterApplyStatus": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DP parameter group.

" + "smithy.api#documentation": "

The status of parameter updates.

" } } }, @@ -3228,34 +3228,34 @@ "com.amazonaws.neptune#DBSubnetGroup": { "type": "structure", "members": { - "VpcId": { + "DBSubnetGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the VpcId of the DB subnet group.

" + "smithy.api#documentation": "

The name of the DB subnet group.

" } }, - "DBSubnetGroupArn": { + "VpcId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" + "smithy.api#documentation": "

Provides the VpcId of the DB subnet group.

" } }, - "DBSubnetGroupDescription": { + "SubnetGroupStatus": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the description of the DB subnet group.

" + "smithy.api#documentation": "

Provides the status of the DB subnet group.

" } }, - "SubnetGroupStatus": { + "DBSubnetGroupDescription": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the status of the DB subnet group.

" + "smithy.api#documentation": "

Provides the description of the DB subnet group.

" } }, - "DBSubnetGroupName": { + "DBSubnetGroupArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB subnet group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" } }, "Subnets": { @@ -3304,17 +3304,17 @@ "com.amazonaws.neptune#DBSubnetGroupMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "DBSubnetGroups": { "target": "com.amazonaws.neptune#DBSubnetGroups", "traits": { "smithy.api#documentation": "

A list of DBSubnetGroup instances.

" } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } } } }, @@ -3423,6 +3423,13 @@ "com.amazonaws.neptune#DeleteDBClusterMessage": { "type": "structure", "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing DBClusterIdentifier.

    \n
    • \n
", + "smithy.api#required": {} + } + }, "SkipFinalSnapshot": { "target": "com.amazonaws.neptune#Boolean", "traits": { @@ -3434,13 +3441,6 @@ "traits": { "smithy.api#documentation": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when\n SkipFinalSnapshot is set to false.

\n \n

Specifying this parameter and also setting the SkipFinalShapshot parameter\n to true results in an error.

\n \n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing DBClusterIdentifier.

    \n
    • \n
", - "smithy.api#required": {} - } } } }, @@ -3709,18 +3709,18 @@ "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" } }, - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, "Filters": { "target": "com.amazonaws.neptune#FilterList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

" } }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, "MaxRecords": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { @@ -3749,10 +3749,10 @@ "com.amazonaws.neptune#DescribeDBClusterParametersMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", + "Filters": { + "target": "com.amazonaws.neptune#FilterList", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.\n

" + "smithy.api#documentation": "

This parameter is not currently supported.

" } }, "Source": { @@ -3761,23 +3761,23 @@ "smithy.api#documentation": "

A value that indicates to return only parameters for a specific source. Parameter sources\n can be engine, service, or customer.

" } }, - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DBClusterParameterGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.neptune#FilterList", + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "DBClusterParameterGroupName": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.\n

" } } } @@ -3839,16 +3839,16 @@ "com.amazonaws.neptune#DescribeDBClusterSnapshotsMessage": { "type": "structure", "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.neptune#String", + "Filters": { + "target": "com.amazonaws.neptune#FilterList", "traits": { - "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter\n can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This\n parameter is not case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBCluster.

    \n
    • \n
" + "smithy.api#documentation": "

This parameter is not currently supported.

" } }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.neptune#String", + "IncludePublic": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. This parameter can't be used in\n conjunction with the DBClusterIdentifier parameter. This value is stored as a\n lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBClusterSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType\n parameter must also be specified.

    \n
    • \n
" + "smithy.api#documentation": "

True to include manual DB cluster snapshots that are public and can be copied or restored\n by any AWS account, and otherwise false. The default is false. The default is\n false.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" } }, "IncludeShared": { @@ -3857,22 +3857,28 @@ "smithy.api#documentation": "

True to include shared manual DB cluster snapshots from other AWS accounts that this AWS\n account has been given permission to copy or restore, and otherwise false. The default is\n false.

\n

You can give an AWS account permission to restore a manual DB cluster snapshot from\n another AWS account by the ModifyDBClusterSnapshotAttribute API\n action.

" } }, - "SnapshotType": { + "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following\n values:

\n
    \n
  • \n

    \n automated - Return all DB cluster snapshots that have been automatically\n taken by Amazon Neptune for my AWS account.

    \n
    • \n
  • \n

    \n manual - Return all DB cluster snapshots that have been taken by my AWS\n account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB cluster snapshots that have been shared to\n my AWS account.

    \n
    • \n
  • \n

    \n public - Return all DB cluster snapshots that have been marked as\n public.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual DB\n cluster snapshots are returned. You can include shared DB cluster snapshots with these results\n by setting the IncludeShared parameter to true. You can include\n public DB cluster snapshots with these results by setting the IncludePublic\n parameter to true.

\n

The IncludeShared and IncludePublic parameters don't apply for\n SnapshotType values of manual or automated. The\n IncludePublic parameter doesn't apply when SnapshotType is set to\n shared. The IncludeShared parameter doesn't apply when\n SnapshotType is set to public.

" + "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. This parameter can't be used in\n conjunction with the DBClusterIdentifier parameter. This value is stored as a\n lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBClusterSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType\n parameter must also be specified.

    \n
    • \n
" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter\n can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This\n parameter is not case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBCluster.

    \n
    • \n
" } }, - "IncludePublic": { - "target": "com.amazonaws.neptune#Boolean", + "Marker": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

True to include manual DB cluster snapshots that are public and can be copied or restored\n by any AWS account, and otherwise false. The default is false. The default is\n false.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.\n

" } }, - "Filters": { - "target": "com.amazonaws.neptune#FilterList", + "SnapshotType": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following\n values:

\n
    \n
  • \n

    \n automated - Return all DB cluster snapshots that have been automatically\n taken by Amazon Neptune for my AWS account.

    \n
    • \n
  • \n

    \n manual - Return all DB cluster snapshots that have been taken by my AWS\n account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB cluster snapshots that have been shared to\n my AWS account.

    \n
    • \n
  • \n

    \n public - Return all DB cluster snapshots that have been marked as\n public.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual DB\n cluster snapshots are returned. You can include shared DB cluster snapshots with these results\n by setting the IncludeShared parameter to true. You can include\n public DB cluster snapshots with these results by setting the IncludePublic\n parameter to true.

\n

The IncludeShared and IncludePublic parameters don't apply for\n SnapshotType values of manual or automated. The\n IncludePublic parameter doesn't apply when SnapshotType is set to\n shared. The IncludeShared parameter doesn't apply when\n SnapshotType is set to public.

" } }, "MaxRecords": { @@ -3880,12 +3886,6 @@ "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } - }, - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.\n

" - } } } }, @@ -3909,18 +3909,6 @@ "com.amazonaws.neptune#DescribeDBClustersMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Filters": { - "target": "com.amazonaws.neptune#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon\n Resource Names (ARNs). The results list will only include information about the DB\n clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n engine - Accepts an engine name (such as neptune),\n and restricts the results list to DB clusters created by that engine.

    \n
    • \n
\n\n

For example, to invoke this API from the AWS CLI and filter so that only\n Neptune DB clusters are returned, you could use the following command:

" - } - }, "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { @@ -3932,6 +3920,18 @@ "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBClusters\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } + }, + "Filters": { + "target": "com.amazonaws.neptune#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon\n Resource Names (ARNs). The results list will only include information about the DB\n clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n engine - Accepts an engine name (such as neptune),\n and restricts the results list to DB clusters created by that engine.

    \n
    • \n
\n\n

For example, to invoke this API from the AWS CLI and filter so that only\n Neptune DB clusters are returned, you could use the following command:

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } } } }, @@ -3956,16 +3956,10 @@ "com.amazonaws.neptune#DescribeDBEngineVersionsMessage": { "type": "structure", "members": { - "ListSupportedTimezones": { - "target": "com.amazonaws.neptune#BooleanOptional", - "traits": { - "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the TimeZone\n parameter for CreateDBInstance, the response includes a list of supported time\n zones for each engine version.

" - } - }, - "Marker": { + "DBParameterGroupFamily": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBParameterGroupFamily.

    \n
    • \n
" } }, "Engine": { @@ -3974,28 +3968,22 @@ "smithy.api#documentation": "

The database engine to return.

" } }, - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more than the\n MaxRecords value is available, a pagination token called a marker is included in\n the response so that the following results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBParameterGroupFamily.

    \n
    • \n
" - } - }, "Filters": { "target": "com.amazonaws.neptune#FilterList", "traits": { "smithy.api#documentation": "

Not currently supported.

" } }, - "EngineVersion": { - "target": "com.amazonaws.neptune#String", + "ListSupportedCharacterSets": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" + "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the\n CharacterSetName parameter for CreateDBInstance, the response\n includes a list of supported character sets for each engine version.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more than the\n MaxRecords value is available, a pagination token called a marker is included in\n the response so that the following results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "DefaultOnly": { @@ -4004,10 +3992,22 @@ "smithy.api#documentation": "

Indicates that only the default version of the specified engine or engine and major\n version combination is returned.

" } }, - "ListSupportedCharacterSets": { + "ListSupportedTimezones": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the\n CharacterSetName parameter for CreateDBInstance, the response\n includes a list of supported character sets for each engine version.

" + "smithy.api#documentation": "

If this parameter is specified and the requested engine supports the TimeZone\n parameter for CreateDBInstance, the response includes a list of supported time\n zones for each engine version.

" + } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" } } } @@ -4044,6 +4044,12 @@ "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon\n Resource Names (ARNs). The results list will only include information about the DB\n instances associated with the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n engine - Accepts an engine name (such as neptune),\n and restricts the results list to DB instances created by that engine.

    \n
    • \n
\n\n

For example, to invoke this API from the AWS CLI and filter so that only\n Neptune DB instances are returned, you could use the following command:

" } }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBInstances\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, "MaxRecords": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { @@ -4055,12 +4061,6 @@ "traits": { "smithy.api#documentation": "

The user-supplied instance identifier. If this parameter is specified, information from\n only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \n
" } - }, - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBInstances\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } } } }, @@ -4090,28 +4090,28 @@ "com.amazonaws.neptune#DescribeDBParameterGroupsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.neptune#FilterList", + "DBParameterGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" } }, - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", + "Filters": { + "target": "com.amazonaws.neptune#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

This parameter is not currently supported.

" } }, - "DBParameterGroupName": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, - "Marker": { - "target": "com.amazonaws.neptune#String", + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by MaxRecords.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } } } @@ -4142,11 +4142,10 @@ "com.amazonaws.neptune#DescribeDBParametersMessage": { "type": "structure", "members": { - "DBParameterGroupName": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBParameters\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" } }, "Filters": { @@ -4155,10 +4154,11 @@ "smithy.api#documentation": "

This parameter is not currently supported.

" } }, - "Marker": { + "DBParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBParameters\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} } }, "Source": { @@ -4201,10 +4201,10 @@ "com.amazonaws.neptune#DescribeDBSubnetGroupsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.neptune#FilterList", + "DBSubnetGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

The name of the DB subnet group to return details for.

" } }, "MaxRecords": { @@ -4213,16 +4213,16 @@ "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "DBSubnetGroupName": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB subnet group to return details for.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If\n this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" } }, - "Marker": { - "target": "com.amazonaws.neptune#String", + "Filters": { + "target": "com.amazonaws.neptune#FilterList", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If\n this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

" + "smithy.api#documentation": "

This parameter is not currently supported.

" } } } @@ -4255,17 +4255,17 @@ "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request. If this parameter is specified,\n the response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, - "Filters": { - "target": "com.amazonaws.neptune#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, "MaxRecords": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } + }, + "Filters": { + "target": "com.amazonaws.neptune#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } } } }, @@ -4286,35 +4286,41 @@ "target": "com.amazonaws.neptune#DescribeEngineDefaultParametersResult" }, "traits": { - "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified database\n engine.

" + "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified database\n engine.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "EngineDefaults.Marker", + "items": "EngineDefaults.Parameters", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.neptune#DescribeEngineDefaultParametersMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.neptune#FilterList", + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Not currently supported.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "DBParameterGroupFamily": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" } }, - "Marker": { - "target": "com.amazonaws.neptune#String", + "Filters": { + "target": "com.amazonaws.neptune#FilterList", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + "smithy.api#documentation": "

Not currently supported.

" } }, - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DBParameterGroupFamily": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The name of the DB parameter group family.

", + "smithy.api#required": {} } } } @@ -4342,17 +4348,17 @@ "com.amazonaws.neptune#DescribeEventCategoriesMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.neptune#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, "SourceType": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

The type of source that is generating the events.

\n

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" } + }, + "Filters": { + "target": "com.amazonaws.neptune#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } } } }, @@ -4382,28 +4388,28 @@ "com.amazonaws.neptune#DescribeEventSubscriptionsMessage": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.neptune#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, "MaxRecords": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, - "SubscriptionName": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the event notification subscription you want to describe.

" - } - }, - "Filters": { - "target": "com.amazonaws.neptune#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords .

" } }, - "Marker": { + "SubscriptionName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords .

" + "smithy.api#documentation": "

The name of the event notification subscription you want to describe.

" } } } @@ -4429,16 +4435,10 @@ "com.amazonaws.neptune#DescribeEventsMessage": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.neptune#TStamp", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601 format.\n For more information about ISO 8601, go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", + "EventCategories": { + "target": "com.amazonaws.neptune#EventCategoriesList", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

A list of event categories that trigger notifications for a event notification\n subscription.

" } }, "Marker": { @@ -4447,16 +4447,16 @@ "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeEvents request. If this\n parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" } }, - "SourceType": { - "target": "com.amazonaws.neptune#SourceType", + "Duration": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are\n returned.

" + "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" } }, - "StartTime": { - "target": "com.amazonaws.neptune#TStamp", + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n For more information about ISO 8601, go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "SourceIdentifier": { @@ -4465,10 +4465,16 @@ "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then\n all sources are included in the response.

\n

Constraints:

\n
    \n
  • \n

    If SourceIdentifier is supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is DBInstance, then a\n DBInstanceIdentifier must be supplied.

    \n
    • \n
  • \n

    If the source type is DBSecurityGroup, a DBSecurityGroupName\n must be supplied.

    \n
    • \n
  • \n

    If the source type is DBParameterGroup, a\n DBParameterGroupName must be supplied.

    \n
    • \n
  • \n

    If the source type is DBSnapshot, a DBSnapshotIdentifier\n must be supplied.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" } }, - "EventCategories": { - "target": "com.amazonaws.neptune#EventCategoriesList", + "EndTime": { + "target": "com.amazonaws.neptune#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601 format.\n For more information about ISO 8601, go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + } + }, + "SourceType": { + "target": "com.amazonaws.neptune#SourceType", "traits": { - "smithy.api#documentation": "

A list of event categories that trigger notifications for a event notification\n subscription.

" + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are\n returned.

" } }, "Filters": { @@ -4477,10 +4483,10 @@ "smithy.api#documentation": "

This parameter is not currently supported.

" } }, - "Duration": { - "target": "com.amazonaws.neptune#IntegerOptional", + "StartTime": { + "target": "com.amazonaws.neptune#TStamp", "traits": { - "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n For more information about ISO 8601, go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" } } } @@ -4506,41 +4512,34 @@ "com.amazonaws.neptune#DescribeOrderableDBInstanceOptionsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - }, - "Vpc": { - "target": "com.amazonaws.neptune#BooleanOptional", + "Filters": { + "target": "com.amazonaws.neptune#FilterList", "traits": { - "smithy.api#documentation": "

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC\n offerings.

" + "smithy.api#documentation": "

This parameter is not currently supported.

" } }, - "Engine": { + "EngineVersion": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available\n offerings matching the specified engine version.

" } }, - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DBInstanceClass": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available\n offerings matching the specified DB instance class.

" } }, - "DBInstanceClass": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available\n offerings matching the specified DB instance class.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions\n request. If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords .

" } }, - "Filters": { - "target": "com.amazonaws.neptune#FilterList", + "Vpc": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" + "smithy.api#documentation": "

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC\n offerings.

" } }, "LicenseModel": { @@ -4549,10 +4548,17 @@ "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available\n offerings matching the specified license model.

" } }, - "EngineVersion": { + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Engine": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available\n offerings matching the specified engine version.

" + "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

", + "smithy.api#required": {} } } } @@ -4577,18 +4583,18 @@ "com.amazonaws.neptune#DescribePendingMaintenanceActionsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.neptune#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, "Marker": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request. If this parameter is specified, the\n response includes only records beyond the marker, up to a number of records specified by\n MaxRecords.

" } }, + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in the\n response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, "ResourceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { @@ -4646,16 +4652,16 @@ "com.amazonaws.neptune#DomainMembership": { "type": "structure", "members": { - "Domain": { + "FQDN": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The identifier of the Active Directory Domain.

" + "smithy.api#documentation": "

The fully qualified domain name of the Active Directory Domain.

" } }, - "IAMRoleName": { + "Domain": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

" + "smithy.api#documentation": "

The identifier of the Active Directory Domain.

" } }, "Status": { @@ -4664,10 +4670,10 @@ "smithy.api#documentation": "

The status of the DB instance's Active Directory Domain membership, such as joined,\n pending-join, failed etc).

" } }, - "FQDN": { + "IAMRoleName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The fully qualified domain name of the Active Directory Domain.

" + "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

" } } }, @@ -4767,16 +4773,16 @@ "com.amazonaws.neptune#EngineDefaults": { "type": "structure", "members": { - "Marker": { + "DBParameterGroupFamily": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous EngineDefaults request. If this\n parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords .

" + "smithy.api#documentation": "

Specifies the name of the DB parameter group family that the engine default parameters\n apply to.

" } }, - "DBParameterGroupFamily": { + "Marker": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the DB parameter group family that the engine default parameters\n apply to.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous EngineDefaults request. If this\n parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords .

" } }, "Parameters": { @@ -4793,40 +4799,40 @@ "com.amazonaws.neptune#Event": { "type": "structure", "members": { - "Date": { - "target": "com.amazonaws.neptune#TStamp", + "SourceType": { + "target": "com.amazonaws.neptune#SourceType", "traits": { - "smithy.api#documentation": "

Specifies the date and time of the event.

" + "smithy.api#documentation": "

Specifies the source type for this event.

" } }, - "SourceIdentifier": { - "target": "com.amazonaws.neptune#String", + "EventCategories": { + "target": "com.amazonaws.neptune#EventCategoriesList", "traits": { - "smithy.api#documentation": "

Provides the identifier for the source of the event.

" + "smithy.api#documentation": "

Specifies the category for the event.

" } }, - "SourceType": { - "target": "com.amazonaws.neptune#SourceType", + "SourceIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the source type for this event.

" + "smithy.api#documentation": "

Provides the identifier for the source of the event.

" } }, - "Message": { + "SourceArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the text of this event.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" } }, - "EventCategories": { - "target": "com.amazonaws.neptune#EventCategoriesList", + "Date": { + "target": "com.amazonaws.neptune#TStamp", "traits": { - "smithy.api#documentation": "

Specifies the category for the event.

" + "smithy.api#documentation": "

Specifies the date and time of the event.

" } }, - "SourceArn": { + "Message": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" + "smithy.api#documentation": "

Provides the text of this event.

" } } }, @@ -4895,28 +4901,28 @@ "com.amazonaws.neptune#EventSubscription": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.neptune#Boolean", + "SourceType": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription\n is enabled.

" + "smithy.api#documentation": "

The source type for the event notification subscription.

" } }, - "SnsTopicArn": { - "target": "com.amazonaws.neptune#String", + "EventCategoriesList": { + "target": "com.amazonaws.neptune#EventCategoriesList", "traits": { - "smithy.api#documentation": "

The topic ARN of the event notification subscription.

" + "smithy.api#documentation": "

A list of event categories for the event notification subscription.

" } }, - "EventSubscriptionArn": { + "CustomerAwsId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

" + "smithy.api#documentation": "

The AWS customer account associated with the event notification subscription.

" } }, - "CustSubscriptionId": { + "SubscriptionCreationTime": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The event notification subscription Id.

" + "smithy.api#documentation": "

The time the event notification subscription was created.

" } }, "SourceIdsList": { @@ -4925,34 +4931,34 @@ "smithy.api#documentation": "

A list of source IDs for the event notification subscription.

" } }, - "Status": { - "target": "com.amazonaws.neptune#String", + "Enabled": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

The status of the event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission |\n topic-not-exist

\n

The status \"no-permission\" indicates that Neptune no longer has permission to post to the\n SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the\n subscription was created.

" + "smithy.api#documentation": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription\n is enabled.

" } }, - "EventCategoriesList": { - "target": "com.amazonaws.neptune#EventCategoriesList", + "CustSubscriptionId": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A list of event categories for the event notification subscription.

" + "smithy.api#documentation": "

The event notification subscription Id.

" } }, - "SourceType": { + "Status": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The source type for the event notification subscription.

" + "smithy.api#documentation": "

The status of the event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission |\n topic-not-exist

\n

The status \"no-permission\" indicates that Neptune no longer has permission to post to the\n SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the\n subscription was created.

" } }, - "CustomerAwsId": { + "SnsTopicArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The AWS customer account associated with the event notification subscription.

" + "smithy.api#documentation": "

The topic ARN of the event notification subscription.

" } }, - "SubscriptionCreationTime": { + "EventSubscriptionArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The time the event notification subscription was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

" } } }, @@ -5073,15 +5079,15 @@ "com.amazonaws.neptune#Filter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.neptune#String", + "Values": { + "target": "com.amazonaws.neptune#FilterValueList", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.neptune#FilterValueList", + "Name": { + "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

This parameter is not currently supported.

", "smithy.api#required": {} @@ -5494,18 +5500,18 @@ "com.amazonaws.neptune#ModifyDBClusterMessage": { "type": "structure", "members": { - "NewDBClusterIdentifier": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    The first character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-cluster2\n

" - } - }, "DeletionProtection": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled. By default,\n deletion protection is disabled.

" } }, + "OptionGroupName": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + } + }, "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { @@ -5513,16 +5519,16 @@ "smithy.api#required": {} } }, - "OptionGroupName": { - "target": "com.amazonaws.neptune#String", + "BackupRetentionPeriod": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

The number of days for which automated backups are retained. You must specify a minimum\n value of 1.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" } }, - "PreferredMaintenanceWindow": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated\n Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the\n week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

" } }, "Port": { @@ -5537,40 +5543,34 @@ "smithy.api#documentation": "

The version number of the database engine. Currently, setting this\n parameter has no effect. To upgrade your database engine to the most recent release,\n use the ApplyPendingMaintenanceAction API.

\n\n

For a list of valid engine versions, see CreateDBInstance,\n or call DescribeDBEngineVersions.

" } }, - "MasterUserPassword": { + "PreferredBackupWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The new password for the master database user. This password can contain any printable\n ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the DB cluster will belong to.

" + "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are\n enabled, using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" } }, - "PreferredBackupWindow": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are\n enabled, using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated\n Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the\n week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.neptune#String", + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

" + "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

Default: false\n

" } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.neptune#IntegerOptional", + "NewDBClusterIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. You must specify a minimum\n value of 1.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" + "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    The first character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-cluster2\n

" } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.neptune#BooleanOptional", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

Default: false\n

" + "smithy.api#documentation": "

A list of VPC security groups that the DB cluster will belong to.

" } }, "ApplyImmediately": { @@ -5579,6 +5579,12 @@ "smithy.api#documentation": "

A value that specifies whether the modifications in this request and any pending\n modifications are asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set\n to false, changes to the DB cluster are applied during the next maintenance\n window.

\n

The ApplyImmediately parameter only affects the\n NewDBClusterIdentifier and MasterUserPassword values. If you set the\n ApplyImmediately parameter value to false, then changes to the\n NewDBClusterIdentifier and MasterUserPassword values are applied\n during the next maintenance window. All other changes are applied immediately, regardless of\n the value of the ApplyImmediately parameter.

\n

Default: false\n

" } }, + "MasterUserPassword": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The new password for the master database user. This password can contain any printable\n ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Must contain from 8 to 41 characters.

" + } + }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.neptune#CloudwatchLogsExportConfiguration", "traits": { @@ -5610,17 +5616,17 @@ "com.amazonaws.neptune#ModifyDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.neptune#ParametersList", + "DBClusterParameterGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

", + "smithy.api#documentation": "

The name of the DB cluster parameter group to modify.

", "smithy.api#required": {} } }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.neptune#String", + "Parameters": { + "target": "com.amazonaws.neptune#ParametersList", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to modify.

", + "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

", "smithy.api#required": {} } } @@ -5660,31 +5666,31 @@ "com.amazonaws.neptune#ModifyDBClusterSnapshotAttributeMessage": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual DB cluster\n snapshot, set this value to restore.

", - "smithy.api#required": {} - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB cluster snapshot to modify the attributes for.

", - "smithy.api#required": {} - } - }, "ValuesToRemove": { "target": "com.amazonaws.neptune#AttributeValueList", "traits": { "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by\n AttributeName.

\n

To remove authorization for other AWS accounts to copy or restore a manual DB cluster\n snapshot, set this list to include one or more AWS account identifiers, or all to\n remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you\n specify all, an AWS account whose account ID is explicitly added to the\n restore attribute can still copy or restore a manual DB cluster snapshot.

" } }, + "AttributeName": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual DB cluster\n snapshot, set this value to restore.

", + "smithy.api#required": {} + } + }, "ValuesToAdd": { "target": "com.amazonaws.neptune#AttributeValueList", "traits": { "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by\n AttributeName.

\n

To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this\n list to include one or more AWS account IDs, or all to make the manual DB cluster\n snapshot restorable by any AWS account. Do not add the all value for any manual\n DB cluster snapshots that contain private information that you don't want available to all AWS\n accounts.

" } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB cluster snapshot to modify the attributes for.

", + "smithy.api#required": {} + } } } }, @@ -5761,59 +5767,65 @@ "com.amazonaws.neptune#ModifyDBInstanceMessage": { "type": "structure", "members": { - "DeletionProtection": { + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.neptune#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs\n for a specific DB instance or DB cluster.

" + } + }, + "PubliclyAccessible": { "target": "com.amazonaws.neptune#BooleanOptional", "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. See Deleting\n a DB Instance.

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This flag should no longer be used.

" } }, - "OptionGroupName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter doesn't result in an outage, except in the\n following situation, and the change is asynchronously applied as soon as possible. If there\n are pending actions that cause a reboot, and the maintenance window is changed to include the\n current time, then changing this parameter will cause a reboot of the DB instance. If moving\n this window to the current time, there must be at least 30 minutes between the current time\n and end of the window to ensure pending changes are applied.

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" } }, - "StorageType": { - "target": "com.amazonaws.neptune#String", + "AllocatedStorage": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Not supported.

" + "smithy.api#documentation": "

The new amount of storage (in gibibytes) to allocate for the DB instance.

\n

Not applicable. Storage is managed by the DB Cluster.

" } }, - "LicenseModel": { + "OptionGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Not supported.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "PreferredMaintenanceWindow": { + "CACertificateIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which might\n result in an outage. Changing this parameter doesn't result in an outage, except in the\n following situation, and the change is asynchronously applied as soon as possible. If there\n are pending actions that cause a reboot, and the maintenance window is changed to include the\n current time, then changing this parameter will cause a reboot of the DB instance. If moving\n this window to the current time, there must be at least 30 minutes between the current time\n and end of the window to ensure pending changes are applied.

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" + "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the instance.

" } }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.neptune#CloudwatchLogsExportConfiguration", + "DeletionProtection": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs\n for a specific DB instance or DB cluster.

" + "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. See Deleting\n a DB Instance.

" } }, - "TdeCredentialPassword": { + "MasterUserPassword": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

" + "smithy.api#documentation": "

Not applicable.

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DBParameterGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The new amount of storage (in gibibytes) to allocate for the DB instance.

\n

Not applicable. Storage is managed by the DB Cluster.

" + "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance. Changing this setting\n doesn't result in an outage. The parameter group name itself is changed immediately, but the\n actual parameter changes are not applied until you reboot the instance without failover. The\n db instance will NOT be rebooted automatically and the parameter changes will NOT be applied\n during the next maintenance window.

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB parameter group family as this\n DB instance.

" } }, - "PubliclyAccessible": { - "target": "com.amazonaws.neptune#BooleanOptional", + "TdeCredentialPassword": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This flag should no longer be used.

" + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

" } }, "EngineVersion": { @@ -5822,10 +5834,10 @@ "smithy.api#documentation": "

The version number of the database engine to upgrade to. Currently, setting this\n parameter has no effect. To upgrade your database engine to the most recent release,\n use the ApplyPendingMaintenanceAction API.

" } }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.neptune#BooleanOptional", + "StorageType": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

Not supported.

" } }, "DBInstanceClass": { @@ -5834,100 +5846,95 @@ "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example,\n db.m4.large. Not all DB instance classes are available in all AWS\n Regions.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless ApplyImmediately is specified\n as true for this request.

\n

Default: Uses existing setting

" } }, - "DBSubnetGroupName": { + "TdeCredentialArn": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The new DB subnet group for the DB instance. You can use this parameter to move your DB\n instance to a different VPC.

\n

Changing the subnet group causes an outage during the change. The change is applied during\n the next maintenance window, unless you specify true for the\n ApplyImmediately parameter.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetGroup\n

" + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.neptune#BooleanOptional", + "DomainIAMRoleName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

You can enable IAM database authentication for the following database engines

\n

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: false\n

" + "smithy.api#documentation": "

Not supported

" } }, - "Domain": { + "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Not supported.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "AutoMinorVersionUpgrade": { + "MultiAZ": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

Indicates that minor version upgrades are applied automatically to the DB instance during\n the maintenance window. Changing this parameter doesn't result in an outage except in the\n following case and the change is asynchronously applied as soon as possible. An outage will\n result if this parameter is set to true during the maintenance window, and a\n newer minor version is available, and Neptune has enabled auto patching for that engine\n version.

" + "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't\n result in an outage and the change is applied during the next maintenance window unless the\n ApplyImmediately parameter is set to true for this request.

" } }, - "Iops": { - "target": "com.amazonaws.neptune#IntegerOptional", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the instance.

\n

Changing this setting doesn't result in an outage and the change is applied during the\n next maintenance window unless the ApplyImmediately parameter is set to\n true for this request.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

A list of EC2 VPC security groups to authorize on this DB instance. This change is\n asynchronously applied as soon as possible.

\n

Not applicable. The associated list of EC2 VPC security groups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing VpcSecurityGroupIds.

    \n
    • \n
" } }, - "MasterUserPassword": { + "PreferredBackupWindow": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Not applicable.

" + "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are\n enabled.

\n

Not applicable. The daily time range for creating automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi

    \n
    • \n
  • \n

    Must be in Universal Time Coordinated (UTC)

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window

    \n
    • \n
  • \n

    Must be at least 30 minutes

    \n
    • \n
" } }, - "DBParameterGroupName": { - "target": "com.amazonaws.neptune#String", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance. Changing this setting\n doesn't result in an outage. The parameter group name itself is changed immediately, but the\n actual parameter changes are not applied until you reboot the instance without failover. The\n db instance will NOT be rebooted automatically and the parameter changes will NOT be applied\n during the next maintenance window.

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB parameter group family as this\n DB instance.

" + "smithy.api#documentation": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise\n false. The default is false.

" } }, - "ApplyImmediately": { - "target": "com.amazonaws.neptune#Boolean", + "BackupRetentionPeriod": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are\n asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance.

\n

If this parameter is set to false, changes to the DB instance are applied\n during the next maintenance window. Some parameter changes can cause an outage and are applied\n on the next call to RebootDBInstance, or the next\n failure reboot.

\n

Default: false\n

" + "smithy.api#documentation": "

Not applicable. The retention period for automated backups is managed by the DB cluster.\n For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

" } }, - "MonitoringRoleArn": { - "target": "com.amazonaws.neptune#String", + "DBPortNumber": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to\n Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a\n MonitoringRoleArn value.

" + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values\n specified for options in the option group for the DB instance.

\n

Your database will restart when you change the DBPortNumber value regardless\n of the value of the ApplyImmediately parameter.

\n

Default: 8182\n

" } }, - "PreferredBackupWindow": { + "DBInstanceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are\n enabled.

\n

Not applicable. The daily time range for creating automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi

    \n
    • \n
  • \n

    Must be in Universal Time Coordinated (UTC)

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window

    \n
    • \n
  • \n

    Must be at least 30 minutes

    \n
    • \n
" + "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} } }, - "CACertificateIdentifier": { + "NewDBInstanceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the instance.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.neptune#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting\n doesn't result in an outage and the change is asynchronously applied as soon as\n possible.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DBSecurityGroups.

    \n
    • \n
" + "smithy.api#documentation": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you\n change the DB instance identifier, an instance reboot will occur immediately if you set\n Apply Immediately to true, or will occur during the next maintenance window if\n Apply Immediately to false. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

" } }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.neptune#Boolean", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

Indicates that major version upgrades are allowed. Changing this parameter doesn't result\n in an outage and the change is asynchronously applied as soon as possible.

" + "smithy.api#documentation": "

Indicates that minor version upgrades are applied automatically to the DB instance during\n the maintenance window. Changing this parameter doesn't result in an outage except in the\n following case and the change is asynchronously applied as soon as possible. An outage will\n result if this parameter is set to true during the maintenance window, and a\n newer minor version is available, and Neptune has enabled auto patching for that engine\n version.

" } }, - "BackupRetentionPeriod": { + "MonitoringInterval": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Not applicable. The retention period for automated backups is managed by the DB cluster.\n For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected\n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default\n is 0.

\n

If MonitoringRoleArn is specified, then you must also set\n MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" } }, - "MultiAZ": { + "EnablePerformanceInsights": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't\n result in an outage and the change is applied during the next maintenance window unless the\n ApplyImmediately parameter is set to true for this request.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "MonitoringInterval": { + "Iops": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected\n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default\n is 0.

\n

If MonitoringRoleArn is specified, then you must also set\n MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the instance.

\n

Changing this setting doesn't result in an outage and the change is applied during the\n next maintenance window unless the ApplyImmediately parameter is set to\n true for this request.

\n

Default: Uses existing setting

" } }, "PromotionTier": { @@ -5936,53 +5943,52 @@ "smithy.api#documentation": "

A value that specifies the order in which a Read Replica is promoted to the primary\n instance after a failure of the existing primary instance.

\n

Default: 1

\n

Valid Values: 0 - 15

" } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.neptune#BooleanOptional", + "ApplyImmediately": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise\n false. The default is false.

" + "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are\n asynchronously applied as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance.

\n

If this parameter is set to false, changes to the DB instance are applied\n during the next maintenance window. Some parameter changes can cause an outage and are applied\n on the next call to RebootDBInstance, or the next\n failure reboot.

\n

Default: false\n

" } }, - "NewDBInstanceIdentifier": { - "target": "com.amazonaws.neptune#String", + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you\n change the DB instance identifier, an instance reboot will occur immediately if you set\n Apply Immediately to true, or will occur during the next maintenance window if\n Apply Immediately to false. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

" + "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

You can enable IAM database authentication for the following database engines

\n

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: false\n

" } }, - "DBInstanceIdentifier": { + "DBSubnetGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", - "smithy.api#required": {} + "smithy.api#documentation": "

The new DB subnet group for the DB instance. You can use this parameter to move your DB\n instance to a different VPC.

\n

Changing the subnet group causes an outage during the change. The change is applied during\n the next maintenance window, unless you specify true for the\n ApplyImmediately parameter.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetGroup\n

" } }, - "DBPortNumber": { - "target": "com.amazonaws.neptune#IntegerOptional", + "LicenseModel": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values\n specified for options in the option group for the DB instance.

\n

Your database will restart when you change the DBPortNumber value regardless\n of the value of the ApplyImmediately parameter.

\n

Default: 8182\n

" + "smithy.api#documentation": "

Not supported.

" } }, - "PerformanceInsightsKMSKeyId": { + "Domain": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

Not supported.

" } }, - "DomainIAMRoleName": { - "target": "com.amazonaws.neptune#String", + "DBSecurityGroups": { + "target": "com.amazonaws.neptune#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

Not supported

" + "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting\n doesn't result in an outage and the change is asynchronously applied as soon as\n possible.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DBSecurityGroups.

    \n
    • \n
" } }, - "TdeCredentialArn": { - "target": "com.amazonaws.neptune#String", + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" + "smithy.api#documentation": "

Indicates that major version upgrades are allowed. Changing this parameter doesn't result\n in an outage and the change is asynchronously applied as soon as possible.

" } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", + "MonitoringRoleArn": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to authorize on this DB instance. This change is\n asynchronously applied as soon as possible.

\n

Not applicable. The associated list of EC2 VPC security groups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing VpcSecurityGroupIds.

    \n
    • \n
" + "smithy.api#documentation": "

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to\n Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a\n MonitoringRoleArn value.

" } } } @@ -6018,17 +6024,17 @@ "com.amazonaws.neptune#ModifyDBParameterGroupMessage": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.neptune#ParametersList", + "DBParameterGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

An array of parameter names, values, and the apply method for the parameter update. At\n least one parameter name, value, and apply method must be supplied; subsequent arguments are\n optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the\n pending-reboot value for both dynamic and static parameters, and changes are applied when\n you reboot the DB instance without failover.

\n ", + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", "smithy.api#required": {} } }, - "DBParameterGroupName": { - "target": "com.amazonaws.neptune#String", + "Parameters": { + "target": "com.amazonaws.neptune#ParametersList", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#documentation": "

An array of parameter names, values, and the apply method for the parameter update. At\n least one parameter name, value, and apply method must be supplied; subsequent arguments are\n optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the\n pending-reboot value for both dynamic and static parameters, and changes are applied when\n you reboot the DB instance without failover.

\n ", "smithy.api#required": {} } } @@ -6066,10 +6072,10 @@ "com.amazonaws.neptune#ModifyDBSubnetGroupMessage": { "type": "structure", "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.neptune#String", + "SubnetIds": { + "target": "com.amazonaws.neptune#SubnetIdentifierList", "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string. You can't\n modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mySubnetgroup\n

", + "smithy.api#documentation": "

The EC2 subnet IDs for the DB subnet group.

", "smithy.api#required": {} } }, @@ -6079,10 +6085,10 @@ "smithy.api#documentation": "

The description for the DB subnet group.

" } }, - "SubnetIds": { - "target": "com.amazonaws.neptune#SubnetIdentifierList", + "DBSubnetGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The EC2 subnet IDs for the DB subnet group.

", + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string. You can't\n modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mySubnetgroup\n

", "smithy.api#required": {} } } @@ -6131,6 +6137,12 @@ "com.amazonaws.neptune#ModifyEventSubscriptionMessage": { "type": "structure", "members": { + "Enabled": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A Boolean value; set to true to activate the\n subscription.

" + } + }, "SubscriptionName": { "target": "com.amazonaws.neptune#String", "traits": { @@ -6144,10 +6156,10 @@ "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified\n of events generated by a DB instance, you would set this parameter to db-instance. if this\n value is not specified, all events are returned.

\n

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" } }, - "Enabled": { - "target": "com.amazonaws.neptune#BooleanOptional", + "EventCategories": { + "target": "com.amazonaws.neptune#EventCategoriesList", "traits": { - "smithy.api#documentation": "

A Boolean value; set to true to activate the\n subscription.

" + "smithy.api#documentation": "

A list of event categories for a SourceType that you want to subscribe to. You can see a\n list of the categories for a given SourceType\n \n by using the DescribeEventCategories action.

" } }, "SnsTopicArn": { @@ -6155,12 +6167,6 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is\n created by Amazon SNS when you create a topic and subscribe to it.

" } - }, - "EventCategories": { - "target": "com.amazonaws.neptune#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for a SourceType that you want to subscribe to. You can see a\n list of the categories for a given SourceType\n \n by using the DescribeEventCategories action.

" - } } } }, @@ -6175,16 +6181,16 @@ "com.amazonaws.neptune#OptionGroupMembership": { "type": "structure", "members": { - "Status": { + "OptionGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are:\n in-sync, pending-apply, pending-removal,\n pending-maintenance-apply, pending-maintenance-removal,\n applying, removing, and failed.

" + "smithy.api#documentation": "

The name of the option group that the instance belongs to.

" } }, - "OptionGroupName": { + "Status": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the option group that the instance belongs to.

" + "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are:\n in-sync, pending-apply, pending-removal,\n pending-maintenance-apply, pending-maintenance-removal,\n applying, removing, and failed.

" } } }, @@ -6220,28 +6226,22 @@ "com.amazonaws.neptune#OrderableDBInstanceOption": { "type": "structure", "members": { - "DBInstanceClass": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The DB instance class for a DB instance.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.neptune#AvailabilityZoneList", + "MinIopsPerGib": { + "target": "com.amazonaws.neptune#DoubleOptional", "traits": { - "smithy.api#documentation": "

A list of Availability Zones for a DB instance.

" + "smithy.api#documentation": "

Minimum provisioned IOPS per GiB for a DB instance.

" } }, - "Engine": { + "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The engine type of a DB instance.

" + "smithy.api#documentation": "

Indicates the storage type for a DB instance.

" } }, - "MultiAZCapable": { - "target": "com.amazonaws.neptune#Boolean", + "LicenseModel": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Indicates whether a DB instance is Multi-AZ capable.

" + "smithy.api#documentation": "

The license model for a DB instance.

" } }, "MaxStorageSize": { @@ -6250,10 +6250,10 @@ "smithy.api#documentation": "

Maximum storage size for a DB instance.

" } }, - "Vpc": { + "ReadReplicaCapable": { "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a DB instance is in a VPC.

" + "smithy.api#documentation": "

Indicates whether a DB instance can have a Read Replica.

" } }, "EngineVersion": { @@ -6262,28 +6262,28 @@ "smithy.api#documentation": "

The engine version of a DB instance.

" } }, - "StorageType": { - "target": "com.amazonaws.neptune#String", + "SupportsIAMDatabaseAuthentication": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Indicates the storage type for a DB instance.

" + "smithy.api#documentation": "

Indicates whether a DB instance supports IAM database authentication.

" } }, - "MinIopsPerDbInstance": { - "target": "com.amazonaws.neptune#IntegerOptional", + "SupportsPerformanceInsights": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Minimum total provisioned IOPS for a DB instance.

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, - "SupportsIAMDatabaseAuthentication": { - "target": "com.amazonaws.neptune#Boolean", + "AvailabilityZones": { + "target": "com.amazonaws.neptune#AvailabilityZoneList", "traits": { - "smithy.api#documentation": "

Indicates whether a DB instance supports IAM database authentication.

" + "smithy.api#documentation": "

A list of Availability Zones for a DB instance.

" } }, - "SupportsIops": { - "target": "com.amazonaws.neptune#Boolean", + "MaxIopsPerDbInstance": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" + "smithy.api#documentation": "

Maximum total provisioned IOPS for a DB instance.

" } }, "SupportsEnhancedMonitoring": { @@ -6292,46 +6292,46 @@ "smithy.api#documentation": "

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60\n seconds.

" } }, - "LicenseModel": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The license model for a DB instance.

" - } - }, "MaxIopsPerGib": { "target": "com.amazonaws.neptune#DoubleOptional", "traits": { "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" } }, - "MaxIopsPerDbInstance": { + "MinStorageSize": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Maximum total provisioned IOPS for a DB instance.

" + "smithy.api#documentation": "

Minimum storage size for a DB instance.

" } }, - "SupportsPerformanceInsights": { + "SupportsIops": { "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" } }, - "ReadReplicaCapable": { + "MultiAZCapable": { "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a DB instance can have a Read Replica.

" + "smithy.api#documentation": "

Indicates whether a DB instance is Multi-AZ capable.

" } }, - "MinStorageSize": { - "target": "com.amazonaws.neptune#IntegerOptional", + "Engine": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Minimum storage size for a DB instance.

" + "smithy.api#documentation": "

The engine type of a DB instance.

" } }, - "MinIopsPerGib": { - "target": "com.amazonaws.neptune#DoubleOptional", + "Vpc": { + "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#documentation": "

Minimum provisioned IOPS per GiB for a DB instance.

" + "smithy.api#documentation": "

Indicates whether a DB instance is in a VPC.

" + } + }, + "MinIopsPerDbInstance": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum total provisioned IOPS for a DB instance.

" } }, "SupportsStorageEncryption": { @@ -6339,6 +6339,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether a DB instance supports encrypted storage.

" } + }, + "DBInstanceClass": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for a DB instance.

" + } } }, "traits": { @@ -6357,27 +6363,27 @@ "com.amazonaws.neptune#OrderableDBInstanceOptionsMessage": { "type": "structure", "members": { - "OrderableDBInstanceOptions": { - "target": "com.amazonaws.neptune#OrderableDBInstanceOptionsList", - "traits": { - "smithy.api#documentation": "

An OrderableDBInstanceOption structure\n containing information about orderable options for the DB instance.

" - } - }, "Marker": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes only records beyond the marker, up to\n the value specified by MaxRecords .

" } + }, + "OrderableDBInstanceOptions": { + "target": "com.amazonaws.neptune#OrderableDBInstanceOptionsList", + "traits": { + "smithy.api#documentation": "

An OrderableDBInstanceOption structure\n containing information about orderable options for the DB instance.

" + } } } }, "com.amazonaws.neptune#Parameter": { "type": "structure", "members": { - "Description": { + "ParameterValue": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides a description of the parameter.

" + "smithy.api#documentation": "

Specifies the value of the parameter.

" } }, "ApplyType": { @@ -6386,16 +6392,10 @@ "smithy.api#documentation": "

Specifies the engine specific parameters type.

" } }, - "IsModifiable": { - "target": "com.amazonaws.neptune#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them from\n being changed.

" - } - }, - "ApplyMethod": { - "target": "com.amazonaws.neptune#ApplyMethod", + "Source": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Indicates when to apply parameter updates.

" + "smithy.api#documentation": "

Indicates the source of the parameter value.

" } }, "ParameterName": { @@ -6404,22 +6404,16 @@ "smithy.api#documentation": "

Specifies the name of the parameter.

" } }, - "Source": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

Indicates the source of the parameter value.

" - } - }, "DataType": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" } }, - "MinimumEngineVersion": { - "target": "com.amazonaws.neptune#String", + "ApplyMethod": { + "target": "com.amazonaws.neptune#ApplyMethod", "traits": { - "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" + "smithy.api#documentation": "

Indicates when to apply parameter updates.

" } }, "AllowedValues": { @@ -6428,10 +6422,22 @@ "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" } }, - "ParameterValue": { + "IsModifiable": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them from\n being changed.

" + } + }, + "Description": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" + "smithy.api#documentation": "

Provides a description of the parameter.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" } } }, @@ -6451,16 +6457,16 @@ "com.amazonaws.neptune#PendingCloudwatchLogsExports": { "type": "structure", "members": { - "LogTypesToDisable": { + "LogTypesToEnable": { "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are\n enabled, these log types are exported to CloudWatch Logs.

" + "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are\n deactivated, these log types aren't exported to CloudWatch Logs.

" } }, - "LogTypesToEnable": { + "LogTypesToDisable": { "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are\n deactivated, these log types aren't exported to CloudWatch Logs.

" + "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are\n enabled, these log types are exported to CloudWatch Logs.

" } } }, @@ -6471,40 +6477,40 @@ "com.amazonaws.neptune#PendingMaintenanceAction": { "type": "structure", "members": { - "OptInStatus": { - "target": "com.amazonaws.neptune#String", + "AutoAppliedAfterDate": { + "target": "com.amazonaws.neptune#TStamp", "traits": { - "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" + "smithy.api#documentation": "

The date of the maintenance window when the action is applied. The maintenance action is\n applied to the resource during its first maintenance window after this date. If this date is\n specified, any next-maintenance opt-in requests are ignored.

" } }, - "CurrentApplyDate": { + "ForcedApplyDate": { "target": "com.amazonaws.neptune#TStamp", "traits": { - "smithy.api#documentation": "

The effective date when the pending maintenance action is applied to the resource. This\n date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the\n ForcedApplyDate. This value is blank if an opt-in request has not been received\n and nothing has been specified as AutoAppliedAfterDate or\n ForcedApplyDate.

" + "smithy.api#documentation": "

The date when the maintenance action is automatically applied. The maintenance action is\n applied to the resource on this date regardless of the maintenance window for the resource. If\n this date is specified, any immediate opt-in requests are ignored.

" } }, - "Description": { + "Action": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" + "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource.

" } }, - "Action": { + "Description": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource.

" + "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" } }, - "AutoAppliedAfterDate": { + "CurrentApplyDate": { "target": "com.amazonaws.neptune#TStamp", "traits": { - "smithy.api#documentation": "

The date of the maintenance window when the action is applied. The maintenance action is\n applied to the resource during its first maintenance window after this date. If this date is\n specified, any next-maintenance opt-in requests are ignored.

" + "smithy.api#documentation": "

The effective date when the pending maintenance action is applied to the resource. This\n date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the\n ForcedApplyDate. This value is blank if an opt-in request has not been received\n and nothing has been specified as AutoAppliedAfterDate or\n ForcedApplyDate.

" } }, - "ForcedApplyDate": { - "target": "com.amazonaws.neptune#TStamp", + "OptInStatus": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The date when the maintenance action is automatically applied. The maintenance action is\n applied to the resource on this date regardless of the maintenance window for the resource. If\n this date is specified, any immediate opt-in requests are ignored.

" + "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" } } }, @@ -6533,27 +6539,33 @@ "com.amazonaws.neptune#PendingMaintenanceActionsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request. If this parameter is specified, the\n response includes only records beyond the marker, up to a number of records specified by\n MaxRecords.

" - } - }, "PendingMaintenanceActions": { "target": "com.amazonaws.neptune#PendingMaintenanceActions", "traits": { "smithy.api#documentation": "

A list of the pending maintenance actions for the resource.

" } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request. If this parameter is specified, the\n response includes only records beyond the marker, up to a number of records specified by\n MaxRecords.

" + } } } }, "com.amazonaws.neptune#PendingModifiedValues": { "type": "structure", "members": { - "StorageType": { - "target": "com.amazonaws.neptune#String", + "AllocatedStorage": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

" + "smithy.api#documentation": "

Contains the new AllocatedStorage size for the DB instance that will be\n applied or is currently being applied.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the pending number of days for which automated backups are retained.

" } }, "LicenseModel": { @@ -6562,16 +6574,16 @@ "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license |\n general-public-license\n

" } }, - "Port": { - "target": "com.amazonaws.neptune#IntegerOptional", + "CACertificateIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the pending port for the DB instance.

" + "smithy.api#documentation": "

Specifies the identifier of the CA certificate for the DB instance.

" } }, - "EngineVersion": { + "DBSubnetGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" + "smithy.api#documentation": "

The new DB subnet group for the DB instance.

" } }, "Iops": { @@ -6580,40 +6592,40 @@ "smithy.api#documentation": "

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is\n currently being applied.

" } }, - "AllocatedStorage": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DBInstanceIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Contains the new AllocatedStorage size for the DB instance that will be\n applied or is currently being applied.

" + "smithy.api#documentation": "

Contains the new DBInstanceIdentifier for the DB instance that will be\n applied or is currently being applied.

" } }, - "DBSubnetGroupName": { + "EngineVersion": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The new DB subnet group for the DB instance.

" + "smithy.api#documentation": "

Indicates the database engine version.

" } }, - "MasterUserPassword": { - "target": "com.amazonaws.neptune#String", + "MultiAZ": { + "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#documentation": "

Contains the pending or currently-in-progress change of the master credentials for the DB\n instance.

" + "smithy.api#documentation": "

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" } }, - "CACertificateIdentifier": { - "target": "com.amazonaws.neptune#String", + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.neptune#PendingCloudwatchLogsExports", "traits": { - "smithy.api#documentation": "

Specifies the identifier of the CA certificate for the DB instance.

" + "smithy.api#documentation": "

This PendingCloudwatchLogsExports structure specifies\n pending changes to which CloudWatch logs are enabled and which are disabled.

" } }, - "DBInstanceIdentifier": { + "StorageType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Contains the new DBInstanceIdentifier for the DB instance that will be\n applied or is currently being applied.

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

" } }, - "PendingCloudwatchLogsExports": { - "target": "com.amazonaws.neptune#PendingCloudwatchLogsExports", + "MasterUserPassword": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

This PendingCloudwatchLogsExports structure specifies\n pending changes to which CloudWatch logs are enabled and which are disabled.

" + "smithy.api#documentation": "

Contains the pending or currently-in-progress change of the master credentials for the DB\n instance.

" } }, "DBInstanceClass": { @@ -6622,16 +6634,10 @@ "smithy.api#documentation": "

Contains the new DBInstanceClass for the DB instance that will be applied or\n is currently being applied.

" } }, - "MultiAZ": { - "target": "com.amazonaws.neptune#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" - } - }, - "BackupRetentionPeriod": { + "Port": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the pending number of days for which automated backups are retained.

" + "smithy.api#documentation": "

Specifies the pending port for the DB instance.

" } } }, @@ -6698,6 +6704,12 @@ "com.amazonaws.neptune#Range": { "type": "structure", "members": { + "To": { + "target": "com.amazonaws.neptune#Integer", + "traits": { + "smithy.api#documentation": "

The maximum value in the range.

" + } + }, "Step": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { @@ -6709,12 +6721,6 @@ "traits": { "smithy.api#documentation": "

The minimum value in the range.

" } - }, - "To": { - "target": "com.amazonaws.neptune#Integer", - "traits": { - "smithy.api#documentation": "

The maximum value in the range.

" - } } }, "traits": { @@ -6865,17 +6871,17 @@ "com.amazonaws.neptune#RemoveSourceIdentifierFromSubscriptionMessage": { "type": "structure", "members": { - "SubscriptionName": { + "SourceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the event notification subscription you want to remove a source identifier\n from.

", + "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security\n group.

", "smithy.api#required": {} } }, - "SourceIdentifier": { + "SubscriptionName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security\n group.

", + "smithy.api#documentation": "

The name of the event notification subscription you want to remove a source identifier\n from.

", "smithy.api#required": {} } } @@ -6951,12 +6957,6 @@ "com.amazonaws.neptune#ResetDBClusterParameterGroupMessage": { "type": "structure", "members": { - "ResetAllParameters": { - "target": "com.amazonaws.neptune#Boolean", - "traits": { - "smithy.api#documentation": "

A value that is set to true to reset all parameters in the DB cluster\n parameter group to their default values, and false otherwise. You can't use this\n parameter if there is a list of parameter names specified for the Parameters\n parameter.

" - } - }, "DBClusterParameterGroupName": { "target": "com.amazonaws.neptune#String", "traits": { @@ -6964,6 +6964,12 @@ "smithy.api#required": {} } }, + "ResetAllParameters": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

A value that is set to true to reset all parameters in the DB cluster\n parameter group to their default values, and false otherwise. You can't use this\n parameter if there is a list of parameter names specified for the Parameters\n parameter.

" + } + }, "Parameters": { "target": "com.amazonaws.neptune#ParametersList", "traits": { @@ -6995,13 +7001,6 @@ "com.amazonaws.neptune#ResetDBParameterGroupMessage": { "type": "structure", "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBParameterGroup.

    \n
    • \n
", - "smithy.api#required": {} - } - }, "Parameters": { "target": "com.amazonaws.neptune#ParametersList", "traits": { @@ -7013,6 +7012,13 @@ "traits": { "smithy.api#documentation": "

Specifies whether (true) or not (false) to reset all parameters\n in the DB parameter group to default values.

\n

Default: true\n

" } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } } } }, @@ -7035,17 +7041,17 @@ "com.amazonaws.neptune#ResourcePendingMaintenanceActions": { "type": "structure", "members": { - "PendingMaintenanceActionDetails": { - "target": "com.amazonaws.neptune#PendingMaintenanceActionDetails", - "traits": { - "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the\n resource.

" - } - }, "ResourceIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

The ARN of the resource that has pending maintenance actions.

" } + }, + "PendingMaintenanceActionDetails": { + "target": "com.amazonaws.neptune#PendingMaintenanceActionDetails", + "traits": { + "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the\n resource.

" + } } }, "traits": { @@ -7117,16 +7123,10 @@ "com.amazonaws.neptune#RestoreDBClusterFromSnapshotMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.neptune#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

" - } - }, - "DBClusterParameterGroupName": { + "DBSubnetGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with the new DB cluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetgroup\n

" } }, "VpcSecurityGroupIds": { @@ -7135,10 +7135,10 @@ "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

" } }, - "OptionGroupName": { - "target": "com.amazonaws.neptune#String", + "AvailabilityZones": { + "target": "com.amazonaws.neptune#AvailabilityZones", "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" + "smithy.api#documentation": "

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can\n be created in.

" } }, "DatabaseName": { @@ -7147,16 +7147,10 @@ "smithy.api#documentation": "

Not supported.

" } }, - "DBSubnetGroupName": { + "OptionGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetgroup\n

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.neptune#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled. By default,\n deletion protection is disabled.\n

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, "DBClusterIdentifier": { @@ -7166,41 +7160,35 @@ "smithy.api#required": {} } }, - "EngineVersion": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

" - } - }, - "SnapshotIdentifier": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster\n snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Snapshot.

    \n
    • \n
", - "smithy.api#required": {} - } - }, "Port": { "target": "com.amazonaws.neptune#IntegerOptional", "traits": { "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

" } }, + "DeletionProtection": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled. By default,\n deletion protection is disabled.\n

" + } + }, "KmsKeyId": { "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If\n you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used\n to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the\n KMS encryption key.

\n

If you do not specify a value for the KmsKeyId parameter, then the following\n will occur:

\n
    \n
  • \n

    If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is\n encrypted, then the restored DB cluster is encrypted using the KMS key that was used to\n encrypt the DB snapshot or DB cluster snapshot.

    \n
    • \n
  • \n

    If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not\n encrypted, then the restored DB cluster is not encrypted.

    \n
    • \n
" } }, - "AvailabilityZones": { - "target": "com.amazonaws.neptune#AvailabilityZones", + "SnapshotIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can\n be created in.

" + "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster\n snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Snapshot.

    \n
    • \n
", + "smithy.api#required": {} } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.neptune#BooleanOptional", + "EngineVersion": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

Default: false\n

" + "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

" } }, "Engine": { @@ -7210,11 +7198,29 @@ "smithy.api#required": {} } }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with the new DB cluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + } + }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.neptune#LogTypeList", "traits": { "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

" } + }, + "Tags": { + "target": "com.amazonaws.neptune#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

Default: false\n

" + } } } }, @@ -7294,16 +7300,23 @@ "com.amazonaws.neptune#RestoreDBClusterToPointInTimeMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.neptune#TagList", + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The tags to be applied to the restored DB cluster.

" + "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", + "smithy.api#required": {} } }, - "RestoreType": { - "target": "com.amazonaws.neptune#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n
    \n
  • \n

    \n full-copy - The new DB cluster is restored as a full copy of the source\n DB cluster.

    \n
    • \n
  • \n

    \n copy-on-write - The new DB cluster is restored as a clone of the source\n DB cluster.

    \n
    • \n
\n

If you don't specify a RestoreType value, then the new DB cluster is restored\n as a full copy of the source DB cluster.

" + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

" + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

A value that is set to true to restore the DB cluster to the latest\n restorable backup time, and false otherwise.

\n

Default: false\n

\n

Constraints: Cannot be specified if RestoreToTime parameter is\n provided.

" } }, "EnableIAMDatabaseAuthentication": { @@ -7312,23 +7325,22 @@ "smithy.api#documentation": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts, and otherwise false.

\n

Default: false\n

" } }, - "SourceDBClusterIdentifier": { - "target": "com.amazonaws.neptune#String", + "Tags": { + "target": "com.amazonaws.neptune#TagList", "traits": { - "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags to be applied to the restored DB cluster.

" } }, - "DBClusterParameterGroupName": { + "DBSubnetGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with the new DB cluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetgroup\n

" } }, - "Port": { - "target": "com.amazonaws.neptune#IntegerOptional", + "DBClusterParameterGroupName": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

" + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with the new DB cluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" } }, "RestoreToTime": { @@ -7337,22 +7349,22 @@ "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n
    \n
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Must be specified if UseLatestRestorableTime parameter is not\n provided

    \n
    • \n
  • \n

    Cannot be specified if UseLatestRestorableTime parameter is true

    \n
    • \n
  • \n

    Cannot be specified if RestoreType parameter is\n copy-on-write\n

    \n
    • \n
\n

Example: 2015-03-07T23:45:00Z\n

" } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.neptune#LogTypeList", + "Port": { + "target": "com.amazonaws.neptune#IntegerOptional", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs.

" + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

" } }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.neptune#Boolean", + "KmsKeyId": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

A value that is set to true to restore the DB cluster to the latest\n restorable backup time, and false otherwise.

\n

Default: false\n

\n

Constraints: Cannot be specified if RestoreToTime parameter is\n provided.

" + "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted\n DB cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If\n you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used\n to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the\n KMS encryption key.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is\n different than the KMS key used to encrypt the source DB cluster. The new DB cluster is\n encrypted with the KMS key identified by the KmsKeyId parameter.

\n

If you do not specify a value for the KmsKeyId parameter, then the following\n will occur:

\n
    \n
  • \n

    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the\n KMS key that was used to encrypt the source DB cluster.

    \n
    • \n
  • \n

    If the DB cluster is not encrypted, then the restored DB cluster is not\n encrypted.

    \n
    • \n
\n

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the\n restore request is rejected.

" } }, - "DBSubnetGroupName": { + "OptionGroupName": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetgroup\n

" + "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" } }, "DeletionProtection": { @@ -7361,12 +7373,6 @@ "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled. By default,\n deletion protection is disabled.\n

" } }, - "OptionGroupName": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

\n (Not supported by Neptune)\n

" - } - }, "DBClusterIdentifier": { "target": "com.amazonaws.neptune#String", "traits": { @@ -7374,16 +7380,16 @@ "smithy.api#required": {} } }, - "KmsKeyId": { + "RestoreType": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted\n DB cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If\n you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used\n to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the\n KMS encryption key.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is\n different than the KMS key used to encrypt the source DB cluster. The new DB cluster is\n encrypted with the KMS key identified by the KmsKeyId parameter.

\n

If you do not specify a value for the KmsKeyId parameter, then the following\n will occur:

\n
    \n
  • \n

    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the\n KMS key that was used to encrypt the source DB cluster.

    \n
    • \n
  • \n

    If the DB cluster is not encrypted, then the restored DB cluster is not\n encrypted.

    \n
    • \n
\n

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the\n restore request is rejected.

" + "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n
    \n
  • \n

    \n full-copy - The new DB cluster is restored as a full copy of the source\n DB cluster.

    \n
    • \n
  • \n

    \n copy-on-write - The new DB cluster is restored as a clone of the source\n DB cluster.

    \n
    • \n
\n

If you don't specify a RestoreType value, then the new DB cluster is restored\n as a full copy of the source DB cluster.

" } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.neptune#VpcSecurityGroupIdList", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.neptune#LogTypeList", "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

" + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs.

" } } } @@ -7650,10 +7656,10 @@ "com.amazonaws.neptune#Subnet": { "type": "structure", "members": { - "SubnetStatus": { - "target": "com.amazonaws.neptune#String", + "SubnetAvailabilityZone": { + "target": "com.amazonaws.neptune#AvailabilityZone", "traits": { - "smithy.api#documentation": "

Specifies the status of the subnet.

" + "smithy.api#documentation": "

Specifies the EC2 Availability Zone that the subnet is in.

" } }, "SubnetIdentifier": { @@ -7662,10 +7668,10 @@ "smithy.api#documentation": "

Specifies the identifier of the subnet.

" } }, - "SubnetAvailabilityZone": { - "target": "com.amazonaws.neptune#AvailabilityZone", + "SubnetStatus": { + "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

Specifies the EC2 Availability Zone that the subnet is in.

" + "smithy.api#documentation": "

Specifies the status of the subnet.

" } } }, @@ -7833,24 +7839,12 @@ "com.amazonaws.neptune#UpgradeTarget": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" - } - }, "AutoUpgrade": { "target": "com.amazonaws.neptune#Boolean", "traits": { "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB instances\n that have AutoMinorVersionUpgrade set to true.

" } }, - "EngineVersion": { - "target": "com.amazonaws.neptune#String", - "traits": { - "smithy.api#documentation": "

The version number of the upgrade target database engine.

" - } - }, "IsMajorVersionUpgrade": { "target": "com.amazonaws.neptune#Boolean", "traits": { @@ -7862,6 +7856,18 @@ "traits": { "smithy.api#documentation": "

The name of the upgrade target database engine.

" } + }, + "Description": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The version number of the upgrade target database engine.

" + } } }, "traits": { @@ -7885,10 +7891,10 @@ "com.amazonaws.neptune#ValidStorageOptions": { "type": "structure", "members": { - "IopsToStorageRatio": { - "target": "com.amazonaws.neptune#DoubleRangeList", + "ProvisionedIops": { + "target": "com.amazonaws.neptune#RangeList", "traits": { - "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" + "smithy.api#documentation": "

The valid range of provisioned IOPS. For example, 1000-20000.

" } }, "StorageType": { @@ -7897,16 +7903,16 @@ "smithy.api#documentation": "

The valid storage types for your DB instance. For example, gp2, io1.

" } }, - "ProvisionedIops": { + "StorageSize": { "target": "com.amazonaws.neptune#RangeList", "traits": { - "smithy.api#documentation": "

The valid range of provisioned IOPS. For example, 1000-20000.

" + "smithy.api#documentation": "

The valid range of storage in gibibytes. For example, 100 to 16384.

" } }, - "StorageSize": { - "target": "com.amazonaws.neptune#RangeList", + "IopsToStorageRatio": { + "target": "com.amazonaws.neptune#DoubleRangeList", "traits": { - "smithy.api#documentation": "

The valid range of storage in gibibytes. For example, 100 to 16384.

" + "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" } } }, @@ -7944,16 +7950,16 @@ "com.amazonaws.neptune#VpcSecurityGroupMembership": { "type": "structure", "members": { - "Status": { + "VpcSecurityGroupId": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The status of the VPC security group.

" + "smithy.api#documentation": "

The name of the VPC security group.

" } }, - "VpcSecurityGroupId": { + "Status": { "target": "com.amazonaws.neptune#String", "traits": { - "smithy.api#documentation": "

The name of the VPC security group.

" + "smithy.api#documentation": "

The status of the VPC security group.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json b/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json index efb85efc640b..007520d35b75 100644 --- a/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json +++ b/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json @@ -88,13 +88,6 @@ "com.amazonaws.networkmanager#AssociateCustomerGatewayRequest": { "type": "structure", "members": { - "CustomerGatewayArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway. For more information, see\n Resources Defined by Amazon EC2.

", - "smithy.api#required": {} - } - }, "GlobalNetworkId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -110,6 +103,13 @@ "smithy.api#required": {} } }, + "CustomerGatewayArn": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway. For more information, see\n Resources Defined by Amazon EC2.

", + "smithy.api#required": {} + } + }, "LinkId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -230,10 +230,10 @@ "com.amazonaws.networkmanager#ConflictException": { "type": "structure", "members": { - "ResourceId": { + "ResourceType": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#documentation": "

The resource type.

", "smithy.api#required": {} } }, @@ -243,10 +243,10 @@ "smithy.api#required": {} } }, - "ResourceType": { + "ResourceId": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The resource type.

", + "smithy.api#documentation": "

The ID of the resource.

", "smithy.api#required": {} } } @@ -300,22 +300,16 @@ "com.amazonaws.networkmanager#CreateDeviceRequest": { "type": "structure", "members": { - "SerialNumber": { + "Model": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The serial number of the device.

\n

Length Constraints: Maximum length of 128 characters.

" - } - }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + "smithy.api#documentation": "

The model of the device.

\n

Length Constraints: Maximum length of 128 characters.

" } }, - "SiteId": { + "SerialNumber": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the site.

" + "smithy.api#documentation": "

The serial number of the device.

\n

Length Constraints: Maximum length of 128 characters.

" } }, "Type": { @@ -324,10 +318,16 @@ "smithy.api#documentation": "

The type of the device.

" } }, - "Description": { + "SiteId": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

A description of the device.

\n

Length Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The ID of the site.

" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource during creation.

" } }, "Location": { @@ -336,10 +336,10 @@ "smithy.api#documentation": "

The location of the device.

" } }, - "Model": { + "Description": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The model of the device.

\n

Length Constraints: Maximum length of 128 characters.

" + "smithy.api#documentation": "

A description of the device.

\n

Length Constraints: Maximum length of 256 characters.

" } }, "Vendor": { @@ -477,10 +477,10 @@ "com.amazonaws.networkmanager#CreateLinkRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "Type": { + "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + "smithy.api#documentation": "

The type of the link.

\n

Constraints: Cannot include the following characters: | \\ ^

\n

Length Constraints: Maximum length of 128 characters.

" } }, "SiteId": { @@ -490,12 +490,6 @@ "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The type of the link.

\n

Constraints: Cannot include the following characters: | \\ ^

\n

Length Constraints: Maximum length of 128 characters.

" - } - }, "GlobalNetworkId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -504,6 +498,12 @@ "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + } + }, "Provider": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -579,6 +579,12 @@ "com.amazonaws.networkmanager#CreateSiteRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

A description of your site.

\n

Length Constraints: Maximum length of 256 characters.

" + } + }, "Location": { "target": "com.amazonaws.networkmanager#Location", "traits": { @@ -598,12 +604,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Description": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

A description of your site.

\n

Length Constraints: Maximum length of 256 characters.

" - } } } }, @@ -621,6 +621,12 @@ "com.amazonaws.networkmanager#CustomerGatewayAssociation": { "type": "structure", "members": { + "CustomerGatewayArn": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway.

" + } + }, "State": { "target": "com.amazonaws.networkmanager#CustomerGatewayAssociationState", "traits": { @@ -633,12 +639,6 @@ "smithy.api#documentation": "

The ID of the device.

" } }, - "CustomerGatewayArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway.

" - } - }, "GlobalNetworkId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -996,18 +996,18 @@ "com.amazonaws.networkmanager#DeregisterTransitGatewayRequest": { "type": "structure", "members": { - "GlobalNetworkId": { + "TransitGatewayArn": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "TransitGatewayArn": { + "GlobalNetworkId": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", + "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1067,13 +1067,6 @@ "com.amazonaws.networkmanager#DescribeGlobalNetworksRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, "GlobalNetworkIds": { "target": "com.amazonaws.networkmanager#StringList", "traits": { @@ -1087,23 +1080,30 @@ "smithy.api#documentation": "

The token for the next page of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.networkmanager#DescribeGlobalNetworksResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, "GlobalNetworks": { "target": "com.amazonaws.networkmanager#GlobalNetworkList", "traits": { "smithy.api#documentation": "

Information about the global networks.

" } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } } }, @@ -1122,16 +1122,22 @@ "smithy.api#documentation": "

The ID of the device.

" } }, - "GlobalNetworkId": { + "Model": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the global network.

" + "smithy.api#documentation": "

The device model.

" } }, - "Model": { + "Vendor": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The device model.

" + "smithy.api#documentation": "

The device vendor.

" + } + }, + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

" } }, "Description": { @@ -1146,10 +1152,10 @@ "smithy.api#documentation": "

The device serial number.

" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "SiteId": { + "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The tags for the device.

" + "smithy.api#documentation": "

The site ID.

" } }, "Type": { @@ -1158,10 +1164,10 @@ "smithy.api#documentation": "

The device type.

" } }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The site ID.

" + "smithy.api#documentation": "

The tags for the device.

" } }, "Location": { @@ -1176,12 +1182,6 @@ "smithy.api#documentation": "

The device state.

" } }, - "Vendor": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The device vendor.

" - } - }, "DeviceArn": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -1331,14 +1331,6 @@ "com.amazonaws.networkmanager#DisassociateLinkRequest": { "type": "structure", "members": { - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the device.

", - "smithy.api#httpQuery": "deviceId", - "smithy.api#required": {} - } - }, "LinkId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -1354,6 +1346,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "DeviceId": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The ID of the device.

", + "smithy.api#httpQuery": "deviceId", + "smithy.api#required": {} + } } } }, @@ -1447,17 +1447,17 @@ "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsResponse": { "type": "structure", "members": { - "CustomerGatewayAssociations": { - "target": "com.amazonaws.networkmanager#CustomerGatewayAssociationList", - "traits": { - "smithy.api#documentation": "

The customer gateway associations.

" - } - }, "NextToken": { "target": "com.amazonaws.networkmanager#String", "traits": { "smithy.api#documentation": "

The token for the next page of results.

" } + }, + "CustomerGatewayAssociations": { + "target": "com.amazonaws.networkmanager#CustomerGatewayAssociationList", + "traits": { + "smithy.api#documentation": "

The customer gateway associations.

" + } } } }, @@ -1503,12 +1503,11 @@ "com.amazonaws.networkmanager#GetDevicesRequest": { "type": "structure", "members": { - "GlobalNetworkId": { + "NextToken": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" } }, "DeviceIds": { @@ -1532,11 +1531,12 @@ "smithy.api#httpQuery": "maxResults" } }, - "NextToken": { + "GlobalNetworkId": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -1607,13 +1607,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, "DeviceId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -1621,6 +1614,13 @@ "smithy.api#httpQuery": "deviceId" } }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, "LinkId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -1697,25 +1697,11 @@ "com.amazonaws.networkmanager#GetLinksRequest": { "type": "structure", "members": { - "Provider": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The link provider.

", - "smithy.api#httpQuery": "provider" - } - }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the site.

", - "smithy.api#httpQuery": "siteId" - } - }, - "Type": { - "target": "com.amazonaws.networkmanager#String", + "LinkIds": { + "target": "com.amazonaws.networkmanager#StringList", "traits": { - "smithy.api#documentation": "

The link type.

", - "smithy.api#httpQuery": "type" + "smithy.api#documentation": "

One or more link IDs. The maximum is 10.

", + "smithy.api#httpQuery": "linkIds" } }, "GlobalNetworkId": { @@ -1740,29 +1726,43 @@ "smithy.api#httpQuery": "maxResults" } }, - "LinkIds": { - "target": "com.amazonaws.networkmanager#StringList", + "SiteId": { + "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

One or more link IDs. The maximum is 10.

", - "smithy.api#httpQuery": "linkIds" + "smithy.api#documentation": "

The ID of the site.

", + "smithy.api#httpQuery": "siteId" } - } - } - }, - "com.amazonaws.networkmanager#GetLinksResponse": { - "type": "structure", - "members": { - "NextToken": { + }, + "Type": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

The link type.

", + "smithy.api#httpQuery": "type" } }, + "Provider": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The link provider.

", + "smithy.api#httpQuery": "provider" + } + } + } + }, + "com.amazonaws.networkmanager#GetLinksResponse": { + "type": "structure", + "members": { "Links": { "target": "com.amazonaws.networkmanager#LinkList", "traits": { "smithy.api#documentation": "

The links.

" } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } } }, @@ -1808,6 +1808,13 @@ "com.amazonaws.networkmanager#GetSitesRequest": { "type": "structure", "members": { + "SiteIds": { + "target": "com.amazonaws.networkmanager#StringList", + "traits": { + "smithy.api#documentation": "

One or more site IDs. The maximum is 10.

", + "smithy.api#httpQuery": "siteIds" + } + }, "MaxResults": { "target": "com.amazonaws.networkmanager#MaxResults", "traits": { @@ -1829,13 +1836,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "SiteIds": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

One or more site IDs. The maximum is 10.

", - "smithy.api#httpQuery": "siteIds" - } } } }, @@ -1898,11 +1898,12 @@ "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "TransitGatewayArns": { @@ -1912,20 +1913,19 @@ "smithy.api#httpQuery": "transitGatewayArns" } }, - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.networkmanager#String", "traits": { "smithy.api#documentation": "

The token for the next page of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -1955,10 +1955,10 @@ "smithy.api#documentation": "

The tags for the global network.

" } }, - "CreatedAt": { - "target": "com.amazonaws.networkmanager#DateTime", + "State": { + "target": "com.amazonaws.networkmanager#GlobalNetworkState", "traits": { - "smithy.api#documentation": "

The date and time that the global network was created.

" + "smithy.api#documentation": "

The state of the global network.

" } }, "GlobalNetworkId": { @@ -1973,10 +1973,10 @@ "smithy.api#documentation": "

The description of the global network.

" } }, - "State": { - "target": "com.amazonaws.networkmanager#GlobalNetworkState", + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", "traits": { - "smithy.api#documentation": "

The state of the global network.

" + "smithy.api#documentation": "

The date and time that the global network was created.

" } }, "GlobalNetworkArn": { @@ -2051,28 +2051,28 @@ "com.amazonaws.networkmanager#Link": { "type": "structure", "members": { - "CreatedAt": { - "target": "com.amazonaws.networkmanager#DateTime", + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The date and time that the link was created.

" + "smithy.api#documentation": "

The ID of the global network.

" } }, - "Description": { - "target": "com.amazonaws.networkmanager#String", + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", "traits": { - "smithy.api#documentation": "

The description of the link.

" + "smithy.api#documentation": "

The date and time that the link was created.

" } }, - "GlobalNetworkId": { + "Provider": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the global network.

" + "smithy.api#documentation": "

The provider of the link.

" } }, - "Type": { - "target": "com.amazonaws.networkmanager#String", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The type of the link.

" + "smithy.api#documentation": "

The tags for the link.

" } }, "LinkId": { @@ -2087,16 +2087,16 @@ "smithy.api#documentation": "

The ID of the site.

" } }, - "Provider": { + "Type": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The provider of the link.

" + "smithy.api#documentation": "

The type of the link.

" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "Description": { + "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The tags for the link.

" + "smithy.api#documentation": "

The description of the link.

" } }, "Bandwidth": { @@ -2125,12 +2125,6 @@ "com.amazonaws.networkmanager#LinkAssociation": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

" - } - }, "LinkAssociationState": { "target": "com.amazonaws.networkmanager#LinkAssociationState", "traits": { @@ -2148,6 +2142,12 @@ "traits": { "smithy.api#documentation": "

The device ID for the link association.

" } + }, + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

" + } } }, "traits": { @@ -2273,16 +2273,16 @@ "com.amazonaws.networkmanager#Location": { "type": "structure", "members": { - "Address": { + "Longitude": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The physical address.

" + "smithy.api#documentation": "

The longitude.

" } }, - "Longitude": { + "Address": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The longitude.

" + "smithy.api#documentation": "

The physical address.

" } }, "Latitude": { @@ -2400,7 +2400,7 @@ "sdkId": "NetworkManager", "arnNamespace": "networkmanager", "cloudFormationName": "NetworkManager", - "cloudTrailEventSource": "V2019_07_05.networkmanager.amazonaws.com" + "cloudTrailEventSource": "networkmanager.amazonaws.com" }, "aws.auth#sigv4": { "name": "networkmanager" @@ -2491,16 +2491,16 @@ "smithy.api#required": {} } }, - "ResourceType": { + "Message": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The resource type.

", "smithy.api#required": {} } }, - "Message": { + "ResourceType": { "target": "com.amazonaws.networkmanager#String", "traits": { + "smithy.api#documentation": "

The resource type.

", "smithy.api#required": {} } } @@ -2527,12 +2527,6 @@ "smithy.api#required": {} } }, - "ResourceType": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The resource type.

" - } - }, "Message": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -2540,10 +2534,10 @@ "smithy.api#required": {} } }, - "ResourceId": { + "ResourceType": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the resource.

" + "smithy.api#documentation": "

The resource type.

" } }, "ServiceCode": { @@ -2552,6 +2546,12 @@ "smithy.api#documentation": "

The service code.

", "smithy.api#required": {} } + }, + "ResourceId": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } } }, "traits": { @@ -2569,16 +2569,22 @@ "smithy.api#documentation": "

The state of the site.

" } }, + "Description": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The description of the site.

" + } + }, "Location": { "target": "com.amazonaws.networkmanager#Location", "traits": { "smithy.api#documentation": "

The location of the site.

" } }, - "CreatedAt": { - "target": "com.amazonaws.networkmanager#DateTime", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The date and time that the site was created.

" + "smithy.api#documentation": "

The tags for the site.

" } }, "GlobalNetworkId": { @@ -2587,18 +2593,6 @@ "smithy.api#documentation": "

The ID of the global network.

" } }, - "Description": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The description of the site.

" - } - }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", - "traits": { - "smithy.api#documentation": "

The tags for the site.

" - } - }, "SiteArn": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -2610,6 +2604,12 @@ "traits": { "smithy.api#documentation": "

The ID of the site.

" } + }, + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that the site was created.

" + } } }, "traits": { @@ -2759,18 +2759,18 @@ "com.amazonaws.networkmanager#ThrottlingException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#required": {} + } + }, "RetryAfterSeconds": { "target": "com.amazonaws.networkmanager#RetryAfterSeconds", "traits": { "smithy.api#documentation": "

Indicates when to retry the request.

", "smithy.api#httpHeader": "Retry-After" } - }, - "Message": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#required": {} - } } }, "traits": { @@ -2960,10 +2960,16 @@ "com.amazonaws.networkmanager#UpdateDeviceRequest": { "type": "structure", "members": { - "SerialNumber": { + "Vendor": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The serial number of the device.

\n

Length Constraints: Maximum length of 128 characters.

" + "smithy.api#documentation": "

The vendor of the device.

\n

Length Constraints: Maximum length of 128 characters.

" + } + }, + "Type": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The type of the device.

" } }, "SiteId": { @@ -2972,10 +2978,13 @@ "smithy.api#documentation": "

The ID of the site.

" } }, - "Type": { + "Location": { + "target": "com.amazonaws.networkmanager#Location" + }, + "Description": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The type of the device.

" + "smithy.api#documentation": "

A description of the device.

\n

Length Constraints: Maximum length of 256 characters.

" } }, "GlobalNetworkId": { @@ -2986,25 +2995,16 @@ "smithy.api#required": {} } }, - "Vendor": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The vendor of the device.

\n

Length Constraints: Maximum length of 128 characters.

" - } - }, - "Location": { - "target": "com.amazonaws.networkmanager#Location" - }, - "Description": { + "Model": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

A description of the device.

\n

Length Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The model of the device.

\n

Length Constraints: Maximum length of 128 characters.

" } }, - "Model": { + "SerialNumber": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The model of the device.

\n

Length Constraints: Maximum length of 128 characters.

" + "smithy.api#documentation": "

The serial number of the device.

\n

Length Constraints: Maximum length of 128 characters.

" } }, "DeviceId": { @@ -3068,18 +3068,18 @@ "com.amazonaws.networkmanager#UpdateGlobalNetworkRequest": { "type": "structure", "members": { - "GlobalNetworkId": { + "Description": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of your global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the global network.

\n

Length Constraints: Maximum length of 256 characters.

" } }, - "Description": { + "GlobalNetworkId": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

A description of the global network.

\n

Length Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The ID of your global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -3158,18 +3158,18 @@ "smithy.api#documentation": "

The type of the link.

\n

Length Constraints: Maximum length of 128 characters.

" } }, - "GlobalNetworkId": { + "Provider": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The provider of the link.

\n

Length Constraints: Maximum length of 128 characters.

" } }, - "Provider": { + "GlobalNetworkId": { "target": "com.amazonaws.networkmanager#String", "traits": { - "smithy.api#documentation": "

The provider of the link.

\n

Length Constraints: Maximum length of 128 characters.

" + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Description": { @@ -3231,14 +3231,6 @@ "com.amazonaws.networkmanager#UpdateSiteRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "SiteId": { "target": "com.amazonaws.networkmanager#String", "traits": { @@ -3258,6 +3250,14 @@ "traits": { "smithy.api#documentation": "

A description of your site.

\n

Length Constraints: Maximum length of 256 characters.

" } + }, + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#String", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -3275,18 +3275,18 @@ "com.amazonaws.networkmanager#ValidationException": { "type": "structure", "members": { - "Fields": { - "target": "com.amazonaws.networkmanager#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "

The fields that caused the error, if applicable.

" - } - }, "Message": { "target": "com.amazonaws.networkmanager#String", "traits": { "smithy.api#required": {} } }, + "Fields": { + "target": "com.amazonaws.networkmanager#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The fields that caused the error, if applicable.

" + } + }, "Reason": { "target": "com.amazonaws.networkmanager#ValidationExceptionReason", "traits": { 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 e640e5fcb138..d823f1c4a58e 100644 --- a/codegen/sdk-codegen/aws-models/opsworks.2013-02-18.json +++ b/codegen/sdk-codegen/aws-models/opsworks.2013-02-18.json @@ -58,22 +58,10 @@ "com.amazonaws.opsworks#App": { "type": "structure", "members": { - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable SSL for the app.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

When the app was created.

" - } - }, - "Description": { - "target": "com.amazonaws.opsworks#String", + "DataSources": { + "target": "com.amazonaws.opsworks#DataSources", "traits": { - "smithy.api#documentation": "

A description of the app.

" + "smithy.api#documentation": "

The app's data sources.

" } }, "AppId": { @@ -82,10 +70,10 @@ "smithy.api#documentation": "

The app ID.

" } }, - "StackId": { - "target": "com.amazonaws.opsworks#String", + "Domains": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

The app stack ID.

" + "smithy.api#documentation": "

The app vhost settings with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" } }, "Type": { @@ -100,34 +88,28 @@ "smithy.api#documentation": "

The app's short name.

" } }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", - "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" - } - }, "AppSource": { "target": "com.amazonaws.opsworks#Source", "traits": { "smithy.api#documentation": "

A Source object that describes the app repository.

" } }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", + "SslConfiguration": { + "target": "com.amazonaws.opsworks#SslConfiguration", "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances. For more information, see Environment Variables.

\n \n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an \"Environment: is too large (maximum is 20 KB)\" message.

\n " + "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" } }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", + "EnableSsl": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The app vhost settings with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" + "smithy.api#documentation": "

Whether to enable SSL for the app.

" } }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", + "StackId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The app's data sources.

" + "smithy.api#documentation": "

The app stack ID.

" } }, "Name": { @@ -141,6 +123,24 @@ "traits": { "smithy.api#documentation": "

The stack attributes.

" } + }, + "Environment": { + "target": "com.amazonaws.opsworks#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances. For more information, see Environment Variables.

\n \n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an \"Environment: is too large (maximum is 20 KB)\" message.

\n " + } + }, + "Description": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

A description of the app.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

When the app was created.

" + } } }, "traits": { @@ -278,17 +278,17 @@ "com.amazonaws.opsworks#AssignVolumeRequest": { "type": "structure", "members": { - "VolumeId": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The instance ID.

" } }, - "InstanceId": { + "VolumeId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance ID.

" + "smithy.api#documentation": "

The volume ID.

", + "smithy.api#required": {} } } } @@ -367,16 +367,22 @@ "com.amazonaws.opsworks#AutoScalingThresholds": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.opsworks#Integer", + "IgnoreMetricsTime": { + "target": "com.amazonaws.opsworks#Minute", "traits": { - "smithy.api#documentation": "

The number of instances to add or remove when the load exceeds a threshold.

" + "smithy.api#documentation": "

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics\n and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following\n an upscaling event but the instances won't start reducing the load until they have been booted\n and configured. There is no point in raising additional scaling events during that operation,\n which typically takes several minutes. IgnoreMetricsTime allows you to direct\n AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

" } }, - "CpuThreshold": { + "Alarms": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names,\n which are case sensitive and must be in the same region as the stack.

\n \n

To use custom alarms, you must update your service role to allow\n cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for\n you when you first use this feature or you can edit the role manually. For more information,\n see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

\n " + } + }, + "MemoryThreshold": { "target": "com.amazonaws.opsworks#Double", "traits": { - "smithy.api#documentation": "

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

" + "smithy.api#documentation": "

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

" } }, "ThresholdsWaitTime": { @@ -385,28 +391,22 @@ "smithy.api#documentation": "

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

" } }, - "IgnoreMetricsTime": { - "target": "com.amazonaws.opsworks#Minute", + "InstanceCount": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics\n and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following\n an upscaling event but the instances won't start reducing the load until they have been booted\n and configured. There is no point in raising additional scaling events during that operation,\n which typically takes several minutes. IgnoreMetricsTime allows you to direct\n AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

" + "smithy.api#documentation": "

The number of instances to add or remove when the load exceeds a threshold.

" } }, - "MemoryThreshold": { + "LoadThreshold": { "target": "com.amazonaws.opsworks#Double", "traits": { - "smithy.api#documentation": "

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

" - } - }, - "Alarms": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names,\n which are case sensitive and must be in the same region as the stack.

\n \n

To use custom alarms, you must update your service role to allow\n cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for\n you when you first use this feature or you can edit the role manually. For more information,\n see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

\n " + "smithy.api#documentation": "

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

" } }, - "LoadThreshold": { + "CpuThreshold": { "target": "com.amazonaws.opsworks#Double", "traits": { - "smithy.api#documentation": "

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

" + "smithy.api#documentation": "

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

" } } }, @@ -430,16 +430,10 @@ "com.amazonaws.opsworks#BlockDeviceMapping": { "type": "structure", "members": { - "VirtualName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The virtual device name. For more information, see BlockDeviceMapping.

" - } - }, - "NoDevice": { + "DeviceName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Suppresses the specified device included in the AMI's block device mapping.

" + "smithy.api#documentation": "

The device name that is exposed to the instance, such as /dev/sdh. For the root\n device, you can use the explicit device name or you can set this parameter to\n ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.

" } }, "Ebs": { @@ -448,10 +442,16 @@ "smithy.api#documentation": "

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the\n instance is launched.

" } }, - "DeviceName": { + "VirtualName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The device name that is exposed to the instance, such as /dev/sdh. For the root\n device, you can use the explicit device name or you can set this parameter to\n ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.

" + "smithy.api#documentation": "

The virtual device name. For more information, see BlockDeviceMapping.

" + } + }, + "NoDevice": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

Suppresses the specified device included in the AMI's block device mapping.

" } } }, @@ -474,17 +474,17 @@ "com.amazonaws.opsworks#ChefConfiguration": { "type": "structure", "members": { - "BerkshelfVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Berkshelf version.

" - } - }, "ManageBerkshelf": { "target": "com.amazonaws.opsworks#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable Berkshelf.

" } + }, + "BerkshelfVersion": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The Berkshelf version.

" + } } }, "traits": { @@ -514,53 +514,59 @@ "com.amazonaws.opsworks#CloneStackRequest": { "type": "structure", "members": { - "AgentVersion": { + "CloneAppIds": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

A list of source stack app IDs to be included in the cloned stack.

" + } + }, + "CustomJson": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
    • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update \n the agent version, you must edit the stack configuration and specify a new version. \n AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

    \n
    • \n
\n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

\n " + "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes\n

" } }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", + "CustomCookbooksSource": { + "target": "com.amazonaws.opsworks#Source", "traits": { - "smithy.api#documentation": "

Whether to use custom cookbooks.

" + "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or Cookbooks and Recipes.

" } }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", + "ChefConfiguration": { + "target": "com.amazonaws.opsworks#ChefConfiguration", "traits": { - "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux\n 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    \n Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

    \n
    • \n
\n

The default option is the parent stack's operating system.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

\n \n

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

\n " + "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" } }, - "ServiceRoleArn": { + "DefaultSubnetId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for\n you. You can obtain an existing stack's IAM ARN programmatically by calling\n DescribePermissions. For more information about IAM ARNs, see Using\n Identifiers.

\n \n

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" } }, - "DefaultInstanceProfileArn": { + "DefaultSshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" + "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS\n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" } }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", + "ServiceRoleArn": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" + "smithy.api#documentation": "

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for\n you. You can obtain an existing stack's IAM ARN programmatically by calling\n DescribePermissions. For more information about IAM ARNs, see Using\n Identifiers.

\n \n

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

\n ", + "smithy.api#required": {} } }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", + "ConfigurationManager": { + "target": "com.amazonaws.opsworks#StackConfigurationManager", "traits": { - "smithy.api#documentation": "

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n
    \n
  • \n

    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.

    \n
    • \n
  • \n

    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

    \n
    • \n
\n

For more information, see Create a New\n Stack.

" + "smithy.api#documentation": "

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" } }, - "CustomJson": { + "HostnameTheme": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes\n

" + "smithy.api#documentation": "

The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
    • \n
  • \n

    \n Clouds\n

    \n
    • \n
  • \n

    \n Europe_Cities\n

    \n
    • \n
  • \n

    \n Fruits\n

    \n
    • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
    • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
    • \n
  • \n

    \n Planets_and_Moons\n

    \n
    • \n
  • \n

    \n Roman_Deities\n

    \n
    • \n
  • \n

    \n Scottish_Islands\n

    \n
    • \n
  • \n

    \n US_Cities\n

    \n
    • \n
  • \n

    \n Wild_Cats\n

    \n
    • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" } }, "Region": { @@ -569,58 +575,53 @@ "smithy.api#documentation": "

The cloned stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see\n Regions and Endpoints.

" } }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", + "UseOpsworksSecurityGroups": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS\n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" + "smithy.api#documentation": "

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n
    \n
  • \n

    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.

    \n
    • \n
  • \n

    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

    \n
    • \n
\n

For more information, see Create a New\n Stack.

" } }, - "DefaultSubnetId": { + "SourceStackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or Cookbooks and Recipes.

" + "smithy.api#documentation": "

The source stack ID.

", + "smithy.api#required": {} } }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", + "DefaultAvailabilityZone": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" + "smithy.api#documentation": "

The cloned stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" } }, - "CloneAppIds": { - "target": "com.amazonaws.opsworks#Strings", + "ClonePermissions": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

A list of source stack app IDs to be included in the cloned stack.

" + "smithy.api#documentation": "

Whether to clone the source stack's permissions.

" } }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", + "AgentVersion": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the cloned\n stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
    • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update \n the agent version, you must edit the stack configuration and specify a new version. \n AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

    \n
    • \n
\n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

\n " } }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", + "Attributes": { + "target": "com.amazonaws.opsworks#StackAttributes", "traits": { - "smithy.api#documentation": "

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All\n instances are launched into this VPC, and you cannot change the ID later.

\n
    \n
  • \n

    If your account supports EC2 Classic, the default value is no VPC.

    \n
    • \n
  • \n

    If your account does not support EC2 Classic, the default value is the default VPC for the specified region.

    \n
    • \n
\n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n
    \n
  • \n

    It must belong to a VPC in your account that is in the specified region.

    \n
    • \n
  • \n

    You must specify a value for DefaultSubnetId.

    \n
    • \n
\n

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2 Classic, see Supported\n Platforms.

" + "smithy.api#documentation": "

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" } }, - "HostnameTheme": { + "DefaultOs": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
    • \n
  • \n

    \n Clouds\n

    \n
    • \n
  • \n

    \n Europe_Cities\n

    \n
    • \n
  • \n

    \n Fruits\n

    \n
    • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
    • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
    • \n
  • \n

    \n Planets_and_Moons\n

    \n
    • \n
  • \n

    \n Roman_Deities\n

    \n
    • \n
  • \n

    \n Scottish_Islands\n

    \n
    • \n
  • \n

    \n US_Cities\n

    \n
    • \n
  • \n

    \n Wild_Cats\n

    \n
    • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" + "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux\n 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    \n Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

    \n
    • \n
\n

The default option is the parent stack's operating system.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

\n \n

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

\n " } }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", + "UseCustomCookbooks": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + "smithy.api#documentation": "

Whether to use custom cookbooks.

" } }, "Name": { @@ -629,23 +630,22 @@ "smithy.api#documentation": "

The cloned stack name.

" } }, - "ClonePermissions": { - "target": "com.amazonaws.opsworks#Boolean", + "VpcId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether to clone the source stack's permissions.

" + "smithy.api#documentation": "

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All\n instances are launched into this VPC, and you cannot change the ID later.

\n
    \n
  • \n

    If your account supports EC2 Classic, the default value is no VPC.

    \n
    • \n
  • \n

    If your account does not support EC2 Classic, the default value is the default VPC for the specified region.

    \n
    • \n
\n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n
    \n
  • \n

    It must belong to a VPC in your account that is in the specified region.

    \n
    • \n
  • \n

    You must specify a value for DefaultSubnetId.

    \n
    • \n
\n

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2 Classic, see Supported\n Platforms.

" } }, - "SourceStackId": { - "target": "com.amazonaws.opsworks#String", + "DefaultRootDeviceType": { + "target": "com.amazonaws.opsworks#RootDeviceType", "traits": { - "smithy.api#documentation": "

The source stack ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the cloned\n stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" } }, - "DefaultAvailabilityZone": { + "DefaultInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The cloned stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" } } } @@ -667,17 +667,17 @@ "com.amazonaws.opsworks#CloudWatchLogsConfiguration": { "type": "structure", "members": { - "LogStreams": { - "target": "com.amazonaws.opsworks#CloudWatchLogsLogStreams", - "traits": { - "smithy.api#documentation": "

A list of configuration options for CloudWatch Logs.

" - } - }, "Enabled": { "target": "com.amazonaws.opsworks#Boolean", "traits": { "smithy.api#documentation": "

Whether CloudWatch Logs is enabled for a layer.

" } + }, + "LogStreams": { + "target": "com.amazonaws.opsworks#CloudWatchLogsLogStreams", + "traits": { + "smithy.api#documentation": "

A list of configuration options for CloudWatch Logs.

" + } } }, "traits": { @@ -985,16 +985,10 @@ "com.amazonaws.opsworks#CloudWatchLogsLogStream": { "type": "structure", "members": { - "DatetimeFormat": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies how the time stamp is extracted from logs. For more information, see the \n CloudWatch Logs Agent Reference.

" - } - }, - "BatchCount": { + "BufferDuration": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

" + "smithy.api#documentation": "

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

" } }, "File": { @@ -1003,16 +997,10 @@ "smithy.api#documentation": "

Specifies log files that you want to push to CloudWatch Logs.

\n

\n File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*).\n Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series\n of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on\n by using a pattern like access_log.*. Don't use a wildcard to match multiple file types,\n such as access_log_80 and access_log_443. To specify multiple, different file types, add another\n log stream entry to the configuration file, so that each log file type is stored in a different log group.

\n

Zipped files are not supported.

" } }, - "BufferDuration": { + "BatchCount": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

" - } - }, - "Encoding": { - "target": "com.amazonaws.opsworks#CloudWatchLogsEncoding", - "traits": { - "smithy.api#documentation": "

Specifies the encoding of the log file so that the file can be read correctly. \n The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

" + "smithy.api#documentation": "

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

" } }, "MultiLineStartPattern": { @@ -1021,12 +1009,6 @@ "smithy.api#documentation": "

Specifies the pattern for identifying the start of a log message.

" } }, - "FileFingerprintLines": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, \n such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are \n not sent to CloudWatch Logs unless all specified lines are available.

" - } - }, "LogGroupName": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -1039,16 +1021,34 @@ "smithy.api#documentation": "

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. \n The default value is 32768 bytes. This size is calculated as the sum of all event messages \n in UTF-8, plus 26 bytes for each log event.

" } }, + "InitialPosition": { + "target": "com.amazonaws.opsworks#CloudWatchLogsInitialPosition", + "traits": { + "smithy.api#documentation": "

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. \n This setting is only used if there is no state persisted for that log stream.

" + } + }, "TimeZone": { "target": "com.amazonaws.opsworks#CloudWatchLogsTimeZone", "traits": { "smithy.api#documentation": "

Specifies the time zone of log event time stamps.

" } }, - "InitialPosition": { - "target": "com.amazonaws.opsworks#CloudWatchLogsInitialPosition", + "FileFingerprintLines": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. \n This setting is only used if there is no state persisted for that log stream.

" + "smithy.api#documentation": "

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, \n such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are \n not sent to CloudWatch Logs unless all specified lines are available.

" + } + }, + "DatetimeFormat": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

Specifies how the time stamp is extracted from logs. For more information, see the \n CloudWatch Logs Agent Reference.

" + } + }, + "Encoding": { + "target": "com.amazonaws.opsworks#CloudWatchLogsEncoding", + "traits": { + "smithy.api#documentation": "

Specifies the encoding of the log file so that the file can be read correctly. \n The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

" } } }, @@ -1082,6 +1082,18 @@ "com.amazonaws.opsworks#Command": { "type": "structure", "members": { + "LogUrl": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The URL of the command log.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The ID of the instance where the command was executed.

" + } + }, "CreatedAt": { "target": "com.amazonaws.opsworks#DateTime", "traits": { @@ -1100,22 +1112,22 @@ "smithy.api#documentation": "

Date and time when the command was acknowledged.

" } }, - "Status": { + "CommandId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The command status:

\n
    \n
  • \n

    failed

    \n
    • \n
  • \n

    successful

    \n
    • \n
  • \n

    skipped

    \n
    • \n
  • \n

    pending

    \n
    • \n
" + "smithy.api#documentation": "

The command ID.

" } }, - "LogUrl": { - "target": "com.amazonaws.opsworks#String", + "CompletedAt": { + "target": "com.amazonaws.opsworks#DateTime", "traits": { - "smithy.api#documentation": "

The URL of the command log.

" + "smithy.api#documentation": "

Date when the command completed.

" } }, - "DeploymentId": { + "Status": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The command deployment ID.

" + "smithy.api#documentation": "

The command status:

\n
    \n
  • \n

    failed

    \n
    • \n
  • \n

    successful

    \n
    • \n
  • \n

    skipped

    \n
    • \n
  • \n

    pending

    \n
    • \n
" } }, "Type": { @@ -1124,22 +1136,10 @@ "smithy.api#documentation": "

The command type:

\n
    \n
  • \n

    \n configure\n

    \n
    • \n
  • \n

    \n deploy\n

    \n
    • \n
  • \n

    \n execute_recipes\n

    \n
    • \n
  • \n

    \n install_dependencies\n

    \n
    • \n
  • \n

    \n restart\n

    \n
    • \n
  • \n

    \n rollback\n

    \n
    • \n
  • \n

    \n setup\n

    \n
    • \n
  • \n

    \n start\n

    \n
    • \n
  • \n

    \n stop\n

    \n
    • \n
  • \n

    \n undeploy\n

    \n
    • \n
  • \n

    \n update_custom_cookbooks\n

    \n
    • \n
  • \n

    \n update_dependencies\n

    \n
    • \n
" } }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the instance where the command was executed.

" - } - }, - "CommandId": { + "DeploymentId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The command ID.

" - } - }, - "CompletedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the command completed.

" + "smithy.api#documentation": "

The command deployment ID.

" } } }, @@ -1176,10 +1176,16 @@ "com.amazonaws.opsworks#CreateAppRequest": { "type": "structure", "members": { - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", + "Domains": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" + "smithy.api#documentation": "

The app virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" + } + }, + "EnableSsl": { + "target": "com.amazonaws.opsworks#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to enable SSL for the app.

" } }, "Shortname": { @@ -1188,10 +1194,18 @@ "smithy.api#documentation": "

The app's short name.

" } }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", + "Name": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instance. For more information, see Environment Variables.

\n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n " + "smithy.api#documentation": "

The app name.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.opsworks#AppType", + "traits": { + "smithy.api#documentation": "

The app type. Each supported type is associated with a particular layer. For example, PHP\n applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances\n that are members of the corresponding layer. If your app isn't one of the standard types, or\n you prefer to implement your own Deploy recipes, specify other.

", + "smithy.api#required": {} } }, "Attributes": { @@ -1200,12 +1214,25 @@ "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" } }, + "StackId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The stack ID.

", + "smithy.api#required": {} + } + }, "AppSource": { "target": "com.amazonaws.opsworks#Source", "traits": { "smithy.api#documentation": "

A Source object that specifies the app repository.

" } }, + "Environment": { + "target": "com.amazonaws.opsworks#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instance. For more information, see Environment Variables.

\n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n " + } + }, "Description": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -1218,37 +1245,10 @@ "smithy.api#documentation": "

The app's data source.

" } }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", - "traits": { - "smithy.api#documentation": "

The app type. Each supported type is associated with a particular layer. For example, PHP\n applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances\n that are members of the corresponding layer. If your app isn't one of the standard types, or\n you prefer to implement your own Deploy recipes, specify other.

", - "smithy.api#required": {} - } - }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The app virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app name.

", - "smithy.api#required": {} - } - }, - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", + "SslConfiguration": { + "target": "com.amazonaws.opsworks#SslConfiguration", "traits": { - "smithy.api#documentation": "

Whether to enable SSL for the app.

" + "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" } } } @@ -1290,48 +1290,48 @@ "com.amazonaws.opsworks#CreateDeploymentRequest": { "type": "structure", "members": { - "StackId": { + "Comment": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A user-defined comment.

" } }, - "InstanceIds": { + "LayerIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

The instance IDs for the deployment targets.

" + "smithy.api#documentation": "

The layer IDs for the deployment targets.

" } }, - "AppId": { - "target": "com.amazonaws.opsworks#String", + "Command": { + "target": "com.amazonaws.opsworks#DeploymentCommand", "traits": { - "smithy.api#documentation": "

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" + "smithy.api#documentation": "

A DeploymentCommand object that specifies the deployment command and any\n associated arguments.

", + "smithy.api#required": {} } }, - "Comment": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A user-defined comment.

" + "smithy.api#documentation": "

The stack ID.

", + "smithy.api#required": {} } }, - "CustomJson": { + "AppId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes and \n Overriding Attributes With Custom JSON.

" + "smithy.api#documentation": "

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" } }, - "Command": { - "target": "com.amazonaws.opsworks#DeploymentCommand", + "CustomJson": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A DeploymentCommand object that specifies the deployment command and any\n associated arguments.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes and \n Overriding Attributes With Custom JSON.

" } }, - "LayerIds": { + "InstanceIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

The layer IDs for the deployment targets.

" + "smithy.api#documentation": "

The instance IDs for the deployment targets.

" } } } @@ -1373,103 +1373,97 @@ "com.amazonaws.opsworks#CreateInstanceRequest": { "type": "structure", "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", + "Architecture": { + "target": "com.amazonaws.opsworks#Architecture", "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The instance architecture. The default option is x86_64. Instance types do not\n necessarily support both architectures. For a list of the architectures that are supported by\n the different instance types, see Instance Families and\n Types.

" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.opsworks#BlockDeviceMappings", + "InstanceType": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

An array of BlockDeviceMapping objects that specify the instance's block\n devices. For more information, see Block\n Device Mapping. Note that block device mappings are not supported for custom AMIs.

" + "smithy.api#documentation": "

The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.

", + "smithy.api#required": {} } }, - "SubnetId": { + "VirtualizationType": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

" + "smithy.api#documentation": "

The instance's virtualization type, paravirtual or hvm.

" } }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", + "AgentVersion": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" + "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    \n INHERIT - Use the stack's default agent version setting.

    \n
    • \n
  • \n

    \n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, edit the instance configuration and specify a\n new version.\n AWS OpsWorks Stacks then automatically installs that version on the instance.

    \n
    • \n
\n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

" } }, - "Os": { + "Tenancy": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n\t\t\t Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom.

    \n
    • \n
\n

For more information about the supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the CreateInstance action's AmiId parameter to\n specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating\n systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using\n Custom AMIs.

" + "smithy.api#documentation": "

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

" } }, - "RootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", + "Hostname": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance root device type. For more information, see Storage for the Root Device.

" + "smithy.api#documentation": "

The instance host name.

" } }, - "SshKeyName": { + "Os": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" + "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n\t\t\t Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom.

    \n
    • \n
\n

For more information about the supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the CreateInstance action's AmiId parameter to\n specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating\n systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using\n Custom AMIs.

" } }, - "Tenancy": { + "SubnetId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

" + "smithy.api#documentation": "

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

" } }, - "InstanceType": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.

", - "smithy.api#required": {} - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array that contains the instance's layer IDs.

", + "smithy.api#documentation": "

The stack ID.

", "smithy.api#required": {} } }, - "AmiId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. The AMI should be based on one of the\n supported operating systems.\n For more information, see\n Using Custom AMIs.

\n \n

If you specify a custom AMI, you must set Os to Custom.

\n " - } - }, "InstallUpdatesOnBoot": { "target": "com.amazonaws.opsworks#Boolean", "traits": { "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true to ensure that your\n instances have the latest security updates.

\n " } }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", + "BlockDeviceMappings": { + "target": "com.amazonaws.opsworks#BlockDeviceMappings", "traits": { - "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" + "smithy.api#documentation": "

An array of BlockDeviceMapping objects that specify the instance's block\n devices. For more information, see Block\n Device Mapping. Note that block device mappings are not supported for custom AMIs.

" } }, - "VirtualizationType": { + "SshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's virtualization type, paravirtual or hvm.

" + "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" } }, - "AgentVersion": { + "AmiId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    \n INHERIT - Use the stack's default agent version setting.

    \n
    • \n
  • \n

    \n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, edit the instance configuration and specify a\n new version.\n AWS OpsWorks Stacks then automatically installs that version on the instance.

    \n
    • \n
\n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

" + "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. The AMI should be based on one of the\n supported operating systems.\n For more information, see\n Using Custom AMIs.

\n \n

If you specify a custom AMI, you must set Os to Custom.

\n " } }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", + "AutoScalingType": { + "target": "com.amazonaws.opsworks#AutoScalingType", "traits": { - "smithy.api#documentation": "

The instance architecture. The default option is x86_64. Instance types do not\n necessarily support both architectures. For a list of the architectures that are supported by\n the different instance types, see Instance Families and\n Types.

" + "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" + } + }, + "LayerIds": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

An array that contains the instance's layer IDs.

", + "smithy.api#required": {} } }, "EbsOptimized": { @@ -1478,10 +1472,16 @@ "smithy.api#documentation": "

Whether to create an Amazon EBS-optimized instance.

" } }, - "Hostname": { + "AvailabilityZone": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance host name.

" + "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" + } + }, + "RootDeviceType": { + "target": "com.amazonaws.opsworks#RootDeviceType", + "traits": { + "smithy.api#documentation": "

The instance root device type. For more information, see Storage for the Root Device.

" } } } @@ -1523,35 +1523,34 @@ "com.amazonaws.opsworks#CreateLayerRequest": { "type": "structure", "members": { - "UseEbsOptimizedInstances": { + "AutoAssignElasticIps": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" + "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" } }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", + "InstallUpdatesOnBoot": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information\n about IAM ARNs, see Using Identifiers.

" + "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

To ensure that your\n instances have the latest security updates, we strongly recommend using the default value of true.

\n " } }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", + "Attributes": { + "target": "com.amazonaws.opsworks#LayerAttributes", "traits": { - "smithy.api#documentation": "

Whether to disable auto healing for the layer.

" + "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

\n

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

" } }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", + "CloudWatchLogsConfiguration": { + "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", "traits": { - "smithy.api#documentation": "

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to\n specify an execution timeout and enable or disable Elastic Load Balancer connection\n draining.

" + "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

" } }, - "StackId": { - "target": "com.amazonaws.opsworks#String", + "Packages": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

The layer stack ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array of Package objects that describes the layer packages.

" } }, "Name": { @@ -1561,35 +1560,47 @@ "smithy.api#required": {} } }, - "Shortname": { + "CustomInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

\n

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information\n about IAM ARNs, see Using Identifiers.

" } }, - "InstallUpdatesOnBoot": { + "VolumeConfigurations": { + "target": "com.amazonaws.opsworks#VolumeConfigurations", + "traits": { + "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + } + }, + "EnableAutoHealing": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

To ensure that your\n instances have the latest security updates, we strongly recommend using the default value of true.

\n " + "smithy.api#documentation": "

Whether to disable auto healing for the layer.

" } }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", + "LifecycleEventConfiguration": { + "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", "traits": { - "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

" + "smithy.api#documentation": "

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to\n specify an execution timeout and enable or disable Elastic Load Balancer connection\n draining.

" } }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", + "CustomRecipes": { + "target": "com.amazonaws.opsworks#Recipes", "traits": { - "smithy.api#documentation": "

An array of Package objects that describes the layer packages.

" + "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer custom recipes.

" } }, - "AutoAssignElasticIps": { + "Shortname": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

\n

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.

", + "smithy.api#required": {} + } + }, + "UseEbsOptimizedInstances": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" + "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" } }, "CustomSecurityGroupIds": { @@ -1605,22 +1616,11 @@ "smithy.api#required": {} } }, - "CustomJson": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI. \n

" - } - }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer custom recipes.

" - } - }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", - "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + "smithy.api#documentation": "

The layer stack ID.

", + "smithy.api#required": {} } }, "AutoAssignPublicIps": { @@ -1629,10 +1629,10 @@ "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" } }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", + "CustomJson": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

\n

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

" + "smithy.api#documentation": "

A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI. \n

" } } } @@ -1671,10 +1671,28 @@ "com.amazonaws.opsworks#CreateStackRequest": { "type": "structure", "members": { - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", + "CustomJson": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" + "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" + } + }, + "ChefConfiguration": { + "target": "com.amazonaws.opsworks#ChefConfiguration", + "traits": { + "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + } + }, + "CustomCookbooksSource": { + "target": "com.amazonaws.opsworks#Source", + "traits": { + "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" + } + }, + "DefaultSubnetId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" } }, "ServiceRoleArn": { @@ -1690,23 +1708,16 @@ "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
    • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

    \n
    • \n
\n

The default setting is the most recent release of the agent. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

\n " } }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", + "ConfigurationManager": { + "target": "com.amazonaws.opsworks#StackConfigurationManager", "traits": { - "smithy.api#documentation": "

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n
    \n
  • \n

    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

    \n
    • \n
  • \n

    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

    \n
    • \n
\n

For more information, see Create a New\n Stack.

" + "smithy.api#documentation": "

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" } }, - "DefaultInstanceProfileArn": { + "HostnameTheme": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" + "smithy.api#documentation": "

The stack's host name theme, with spaces replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
    • \n
  • \n

    \n Clouds\n

    \n
    • \n
  • \n

    \n Europe_Cities\n

    \n
    • \n
  • \n

    \n Fruits\n

    \n
    • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
    • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
    • \n
  • \n

    \n Planets_and_Moons\n

    \n
    • \n
  • \n

    \n Roman_Deities\n

    \n
    • \n
  • \n

    \n Scottish_Islands\n

    \n
    • \n
  • \n

    \n US_Cities\n

    \n
    • \n
  • \n

    \n Wild_Cats\n

    \n
    • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" } }, "Region": { @@ -1716,77 +1727,66 @@ "smithy.api#required": {} } }, - "CustomJson": { + "DefaultAvailabilityZone": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" + "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" } }, - "DefaultSshKeyName": { + "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS\n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" + "smithy.api#documentation": "

The stack name.

", + "smithy.api#required": {} } }, - "DefaultSubnetId": { + "DefaultSshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" + "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS\n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" } }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", + "DefaultOs": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" + "smithy.api#documentation": "

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, \n Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or \n Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more\n information, see \n Using Custom AMIs.

    \n
    • \n
\n

The default option is the current Amazon Linux version.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

" } }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", + "UseCustomCookbooks": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The default root device type. This value is the default for all instances in the stack,\n but you can override it when you create an instance. The default option is\n instance-store. For more information, see Storage for the Root Device.

" + "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" } }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", + "Attributes": { + "target": "com.amazonaws.opsworks#StackAttributes", "traits": { - "smithy.api#documentation": "

The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

\n
    \n
  • \n

    If your account supports EC2-Classic, the default value is no VPC.

    \n
    • \n
  • \n

    If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

    \n
    • \n
\n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n AWS OpsWorks Stacks infers the value of the \n other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n
    \n
  • \n

    It must belong to a VPC in your account that is in the specified region.

    \n
    • \n
  • \n

    You must specify a value for DefaultSubnetId.

    \n
    • \n
\n

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2-Classic, see Supported\n Platforms.

" + "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" } }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", + "UseOpsworksSecurityGroups": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The stack's host name theme, with spaces replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
    • \n
  • \n

    \n Clouds\n

    \n
    • \n
  • \n

    \n Europe_Cities\n

    \n
    • \n
  • \n

    \n Fruits\n

    \n
    • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
    • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
    • \n
  • \n

    \n Planets_and_Moons\n

    \n
    • \n
  • \n

    \n Roman_Deities\n

    \n
    • \n
  • \n

    \n Scottish_Islands\n

    \n
    • \n
  • \n

    \n US_Cities\n

    \n
    • \n
  • \n

    \n Wild_Cats\n

    \n
    • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" + "smithy.api#documentation": "

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n
    \n
  • \n

    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

    \n
    • \n
  • \n

    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

    \n
    • \n
\n

For more information, see Create a New\n Stack.

" } }, - "Name": { + "DefaultInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack name.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

", "smithy.api#required": {} } }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", + "DefaultRootDeviceType": { + "target": "com.amazonaws.opsworks#RootDeviceType", "traits": { - "smithy.api#documentation": "

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, \n Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or \n Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more\n information, see \n Using Custom AMIs.

    \n
    • \n
\n

The default option is the current Amazon Linux version.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

" + "smithy.api#documentation": "

The default root device type. This value is the default for all instances in the stack,\n but you can override it when you create an instance. The default option is\n instance-store. For more information, see Storage for the Root Device.

" } }, - "DefaultAvailabilityZone": { + "VpcId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" + "smithy.api#documentation": "

The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

\n
    \n
  • \n

    If your account supports EC2-Classic, the default value is no VPC.

    \n
    • \n
  • \n

    If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

    \n
    • \n
\n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n AWS OpsWorks Stacks infers the value of the \n other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n
    \n
  • \n

    It must belong to a VPC in your account that is in the specified region.

    \n
    • \n
  • \n

    You must specify a value for DefaultSubnetId.

    \n
    • \n
\n

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2-Classic, see Supported\n Platforms.

" } } } @@ -1825,10 +1825,10 @@ "com.amazonaws.opsworks#CreateUserProfileRequest": { "type": "structure", "members": { - "SshUsername": { + "SshPublicKey": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS OpsWorks Stacks generates one from the IAM user name.

" + "smithy.api#documentation": "

The user's public SSH key.

" } }, "IamUserArn": { @@ -1838,16 +1838,16 @@ "smithy.api#required": {} } }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", + "SshUsername": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Setting an IAM\n User's Public SSH Key.

" + "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS OpsWorks Stacks generates one from the IAM user name.

" } }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", + "AllowSelfManagement": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The user's public SSH key.

" + "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Setting an IAM\n User's Public SSH Key.

" } } } @@ -1959,13 +1959,6 @@ "com.amazonaws.opsworks#DeleteInstanceRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, "DeleteElasticIp": { "target": "com.amazonaws.opsworks#Boolean", "traits": { @@ -1977,6 +1970,13 @@ "traits": { "smithy.api#documentation": "

Whether to delete the instance's Amazon EBS volumes.

" } + }, + "InstanceId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The instance ID.

", + "smithy.api#required": {} + } } } }, @@ -2070,22 +2070,22 @@ "com.amazonaws.opsworks#Deployment": { "type": "structure", "members": { - "Command": { - "target": "com.amazonaws.opsworks#DeploymentCommand", + "CustomJson": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Used to specify a stack or deployment command.

" + "smithy.api#documentation": "

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" } }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", + "InstanceIds": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

Date when the deployment was created.

" + "smithy.api#documentation": "

The IDs of the target instances.

" } }, - "IamUserArn": { + "Comment": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" + "smithy.api#documentation": "

A user-defined comment.

" } }, "Status": { @@ -2094,34 +2094,34 @@ "smithy.api#documentation": "

The deployment status:

\n
    \n
  • \n

    running

    \n
    • \n
  • \n

    successful

    \n
    • \n
  • \n

    failed

    \n
    • \n
" } }, - "CustomJson": { + "AppId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" + "smithy.api#documentation": "

The app ID.

" } }, - "CompletedAt": { + "CreatedAt": { "target": "com.amazonaws.opsworks#DateTime", "traits": { - "smithy.api#documentation": "

Date when the deployment completed.

" + "smithy.api#documentation": "

Date when the deployment was created.

" } }, - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", + "Command": { + "target": "com.amazonaws.opsworks#DeploymentCommand", "traits": { - "smithy.api#documentation": "

The deployment ID.

" + "smithy.api#documentation": "

Used to specify a stack or deployment command.

" } }, - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", + "IamUserArn": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The IDs of the target instances.

" + "smithy.api#documentation": "

The user's IAM ARN.

" } }, - "Duration": { - "target": "com.amazonaws.opsworks#Integer", + "CompletedAt": { + "target": "com.amazonaws.opsworks#DateTime", "traits": { - "smithy.api#documentation": "

The deployment duration.

" + "smithy.api#documentation": "

Date when the deployment completed.

" } }, "StackId": { @@ -2130,16 +2130,16 @@ "smithy.api#documentation": "

The stack ID.

" } }, - "AppId": { + "DeploymentId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The app ID.

" + "smithy.api#documentation": "

The deployment ID.

" } }, - "Comment": { - "target": "com.amazonaws.opsworks#String", + "Duration": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

A user-defined comment.

" + "smithy.api#documentation": "

The deployment duration.

" } } }, @@ -2150,18 +2150,18 @@ "com.amazonaws.opsworks#DeploymentCommand": { "type": "structure", "members": { - "Args": { - "target": "com.amazonaws.opsworks#DeploymentCommandArgs", - "traits": { - "smithy.api#documentation": "

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

\n

\n {\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...],\n ...}\n

\n

The update_dependencies command takes two arguments:

\n
    \n
  • \n

    \n upgrade_os_to - Specifies the desired Amazon Linux version for instances\n whose OS you want to upgrade, such as Amazon Linux 2016.09. You must also set\n the allow_reboot argument to true.

    \n
    • \n
  • \n

    \n allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if\n necessary, after installing the updates. This argument can be set to either\n true or false. The default value is false.

    \n
    • \n
\n

For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the\n following.

\n

\n { \"upgrade_os_to\":[\"Amazon Linux 2016.09\"], \"allow_reboot\":[\"true\"] } \n

" - } - }, "Name": { "target": "com.amazonaws.opsworks#DeploymentCommandName", "traits": { "smithy.api#documentation": "

Specifies the operation. You can specify only one command.

\n

For stacks, the following commands are available:

\n
    \n
  • \n

    \n execute_recipes: Execute one or more recipes. To specify the recipes, set an\n Args parameter named recipes to the list of recipes to be\n executed. For example, to execute phpapp::appsetup, set Args to\n {\"recipes\":[\"phpapp::appsetup\"]}.

    \n
    • \n
  • \n

    \n install_dependencies: Install the stack's dependencies.

    \n
    • \n
  • \n

    \n update_custom_cookbooks: Update the stack's custom cookbooks.

    \n
    • \n
  • \n

    \n update_dependencies: Update the stack's dependencies.

    \n
    • \n
\n \n

The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.

\n \n

For apps, the following commands are available:

\n
    \n
  • \n

    \n deploy: Deploy an app. Ruby on Rails apps have an optional Args\n parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to\n migrate the database. The default setting is {\"migrate\":[\"false\"]}.

    \n
    • \n
  • \n

    \n rollback Roll the app back to the previous version. When you update an app,\n AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this\n command to roll an app back as many as four versions.

    \n
    • \n
  • \n

    \n start: Start the app's web or application server.

    \n
    • \n
  • \n

    \n stop: Stop the app's web or application server.

    \n
    • \n
  • \n

    \n restart: Restart the app's web or application server.

    \n
    • \n
  • \n

    \n undeploy: Undeploy the app.

    \n
    • \n
", "smithy.api#required": {} } + }, + "Args": { + "target": "com.amazonaws.opsworks#DeploymentCommandArgs", + "traits": { + "smithy.api#documentation": "

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

\n

\n {\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...],\n ...}\n

\n

The update_dependencies command takes two arguments:

\n
    \n
  • \n

    \n upgrade_os_to - Specifies the desired Amazon Linux version for instances\n whose OS you want to upgrade, such as Amazon Linux 2016.09. You must also set\n the allow_reboot argument to true.

    \n
    • \n
  • \n

    \n allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if\n necessary, after installing the updates. This argument can be set to either\n true or false. The default value is false.

    \n
    • \n
\n

For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the\n following.

\n

\n { \"upgrade_os_to\":[\"Amazon Linux 2016.09\"], \"allow_reboot\":[\"true\"] } \n

" + } } }, "traits": { @@ -2394,17 +2394,17 @@ "com.amazonaws.opsworks#DescribeAgentVersionsRequest": { "type": "structure", "members": { - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager.

" - } - }, "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

The stack ID.

" } + }, + "ConfigurationManager": { + "target": "com.amazonaws.opsworks#StackConfigurationManager", + "traits": { + "smithy.api#documentation": "

The configuration manager.

" + } } } }, @@ -2445,17 +2445,17 @@ "com.amazonaws.opsworks#DescribeAppsRequest": { "type": "structure", "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app stack ID. If you use this parameter, DescribeApps returns a description\n of the apps in the specified stack.

" - } - }, "AppIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { "smithy.api#documentation": "

An array of app IDs for the apps to be described. If you use this parameter,\n DescribeApps returns a description of the specified apps. Otherwise, it returns\n a description of every app.

" } + }, + "StackId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The app stack ID. If you use this parameter, DescribeApps returns a description\n of the apps in the specified stack.

" + } } } }, @@ -2496,6 +2496,12 @@ "com.amazonaws.opsworks#DescribeCommandsRequest": { "type": "structure", "members": { + "CommandIds": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

An array of command IDs. If you include this parameter, DescribeCommands returns\n a description of the specified commands. Otherwise, it returns a description of every\n command.

" + } + }, "DeploymentId": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -2507,12 +2513,6 @@ "traits": { "smithy.api#documentation": "

The instance ID. If you include this parameter, DescribeCommands returns a\n description of the commands associated with the specified instance.

" } - }, - "CommandIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of command IDs. If you include this parameter, DescribeCommands returns\n a description of the specified commands. Otherwise, it returns a description of every\n command.

" - } } } }, @@ -2553,12 +2553,6 @@ "com.amazonaws.opsworks#DescribeDeploymentsRequest": { "type": "structure", "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID. If you include this parameter, the command returns a\n description of the commands associated with the specified app.

" - } - }, "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -2570,6 +2564,12 @@ "traits": { "smithy.api#documentation": "

An array of deployment IDs to be described. If you include this parameter,\n the command returns a description of the specified deployments.\n Otherwise, it returns a description of every deployment.

" } + }, + "AppId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The app ID. If you include this parameter, the command returns a\n description of the commands associated with the specified app.

" + } } } }, @@ -2616,28 +2616,28 @@ "com.amazonaws.opsworks#DescribeEcsClustersRequest": { "type": "structure", "members": { - "EcsClusterArns": { - "target": "com.amazonaws.opsworks#Strings", + "MaxResults": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

A list of ARNs, one for each cluster to be described.

" + "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds this maximum, the\n response includes a NextToken value that you can assign\n to the NextToken request parameter to get the next set of results.

" } }, - "NextToken": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results,\n the response object'sNextToken parameter value is set to a token.\n To retrieve the next set of results, call DescribeEcsClusters\n again and assign that token to the request object's NextToken parameter.\n If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

A stack ID.\n DescribeEcsClusters returns a description of the cluster that is registered with the stack.

" } }, - "StackId": { - "target": "com.amazonaws.opsworks#String", + "EcsClusterArns": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

A stack ID.\n DescribeEcsClusters returns a description of the cluster that is registered with the stack.

" + "smithy.api#documentation": "

A list of ARNs, one for each cluster to be described.

" } }, - "MaxResults": { - "target": "com.amazonaws.opsworks#Integer", + "NextToken": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds this maximum, the\n response includes a NextToken value that you can assign\n to the NextToken request parameter to get the next set of results.

" + "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results,\n the response object'sNextToken parameter value is set to a token.\n To retrieve the next set of results, call DescribeEcsClusters\n again and assign that token to the request object's NextToken parameter.\n If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

" } } } @@ -2645,17 +2645,17 @@ "com.amazonaws.opsworks#DescribeEcsClustersResult": { "type": "structure", "members": { - "EcsClusters": { - "target": "com.amazonaws.opsworks#EcsClusters", - "traits": { - "smithy.api#documentation": "

A list of EcsCluster objects containing the cluster descriptions.

" - } - }, "NextToken": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

If a paginated request does not return all of the remaining results, this parameter is set to a token that\n you can assign to the request object's NextToken parameter to retrieve the next set of results.\n If the previous paginated request returned all of the remaining results,\n this parameter is set to null.

" } + }, + "EcsClusters": { + "target": "com.amazonaws.opsworks#EcsClusters", + "traits": { + "smithy.api#documentation": "

A list of EcsCluster objects containing the cluster descriptions.

" + } } }, "traits": { @@ -2691,17 +2691,17 @@ "smithy.api#documentation": "

A stack ID. If you include this parameter, DescribeElasticIps returns a\n description of the Elastic IP addresses that are registered with the specified stack.

" } }, - "Ips": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Elastic IP addresses to be described. If you include this parameter,\n DescribeElasticIps returns a description of the specified Elastic IP addresses.\n Otherwise, it returns a description of every Elastic IP address.

" - } - }, "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

The instance ID. If you include this parameter, DescribeElasticIps returns a\n description of the Elastic IP addresses associated with the specified instance.

" } + }, + "Ips": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

An array of Elastic IP addresses to be described. If you include this parameter,\n DescribeElasticIps returns a description of the specified Elastic IP addresses.\n Otherwise, it returns a description of every Elastic IP address.

" + } } } }, @@ -2793,6 +2793,12 @@ "com.amazonaws.opsworks#DescribeInstancesRequest": { "type": "structure", "members": { + "StackId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

A stack ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified stack.

" + } + }, "LayerId": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -2804,12 +2810,6 @@ "traits": { "smithy.api#documentation": "

An array of instance IDs to be described. If you use this parameter,\n DescribeInstances returns a description of the specified instances. Otherwise,\n it returns a description of every instance.

" } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified stack.

" - } } } }, @@ -3044,18 +3044,18 @@ "com.amazonaws.opsworks#DescribeRaidArraysRequest": { "type": "structure", "members": { - "RaidArrayIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays\n returns descriptions of the specified arrays. Otherwise, it returns a description of every\n array.

" - } - }, "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeRaidArrays returns\n descriptions of the RAID arrays associated with the specified instance.

" } }, + "RaidArrayIds": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays\n returns descriptions of the specified arrays. Otherwise, it returns a description of every\n array.

" + } + }, "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -3101,18 +3101,18 @@ "com.amazonaws.opsworks#DescribeRdsDbInstancesRequest": { "type": "structure", "members": { + "RdsDbInstanceArns": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

An array containing the ARNs of the instances to be described.

" + } + }, "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

", "smithy.api#required": {} } - }, - "RdsDbInstanceArns": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the ARNs of the instances to be described.

" - } } } }, @@ -3153,6 +3153,12 @@ "com.amazonaws.opsworks#DescribeServiceErrorsRequest": { "type": "structure", "members": { + "InstanceId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified instance.

" + } + }, "ServiceErrorIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { @@ -3164,12 +3170,6 @@ "traits": { "smithy.api#documentation": "

The stack ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified stack.

" } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified instance.

" - } } } }, @@ -3444,10 +3444,10 @@ "com.amazonaws.opsworks#DescribeVolumesRequest": { "type": "structure", "members": { - "StackId": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" + "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeVolumes returns descriptions\n of the volumes associated with the specified instance.

" } }, "VolumeIds": { @@ -3462,10 +3462,10 @@ "smithy.api#documentation": "

The RAID array ID. If you use this parameter, DescribeVolumes returns\n descriptions of the volumes associated with the specified RAID array.

" } }, - "InstanceId": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeVolumes returns descriptions\n of the volumes associated with the specified instance.

" + "smithy.api#documentation": "

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" } } } @@ -3555,6 +3555,18 @@ "com.amazonaws.opsworks#EbsBlockDevice": { "type": "structure", "members": { + "SnapshotId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The snapshot ID.

" + } + }, + "Iops": { + "target": "com.amazonaws.opsworks#Integer", + "traits": { + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For more\n information, see EbsBlockDevice.

" + } + }, "VolumeType": { "target": "com.amazonaws.opsworks#VolumeType", "traits": { @@ -3572,18 +3584,6 @@ "traits": { "smithy.api#documentation": "

Whether the volume is deleted on instance termination.

" } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For more\n information, see EbsBlockDevice.

" - } - }, - "SnapshotId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The snapshot ID.

" - } } }, "traits": { @@ -3593,10 +3593,10 @@ "com.amazonaws.opsworks#EcsCluster": { "type": "structure", "members": { - "EcsClusterArn": { + "EcsClusterName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The cluster's ARN.

" + "smithy.api#documentation": "

The cluster name.

" } }, "RegisteredAt": { @@ -3605,10 +3605,10 @@ "smithy.api#documentation": "

The time and date that the cluster was registered with the stack.

" } }, - "EcsClusterName": { + "EcsClusterArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The cluster name.

" + "smithy.api#documentation": "

The cluster's ARN.

" } }, "StackId": { @@ -3631,34 +3631,34 @@ "com.amazonaws.opsworks#ElasticIp": { "type": "structure", "members": { - "Name": { + "Domain": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The name.

" + "smithy.api#documentation": "

The domain.

" } }, - "Region": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The AWS region. For more information, see Regions and Endpoints.

" + "smithy.api#documentation": "

The ID of the instance that the address is attached to.

" } }, - "Ip": { + "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The IP address.

" + "smithy.api#documentation": "

The name.

" } }, - "Domain": { + "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The domain.

" + "smithy.api#documentation": "

The AWS region. For more information, see Regions and Endpoints.

" } }, - "InstanceId": { + "Ip": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ID of the instance that the address is attached to.

" + "smithy.api#documentation": "

The IP address.

" } } }, @@ -3675,28 +3675,22 @@ "com.amazonaws.opsworks#ElasticLoadBalancer": { "type": "structure", "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the layer that the instance is attached to.

" - } - }, - "VpcId": { + "ElasticLoadBalancerName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The VPC ID.

" + "smithy.api#documentation": "

The Elastic Load Balancing instance's name.

" } }, - "SubnetIds": { + "Ec2InstanceIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

A list of subnet IDs, if the stack is running in a VPC.

" + "smithy.api#documentation": "

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

" } }, - "StackId": { + "DnsName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ID of the stack that the instance is associated with.

" + "smithy.api#documentation": "

The instance's public DNS name.

" } }, "AvailabilityZones": { @@ -3705,28 +3699,34 @@ "smithy.api#documentation": "

A list of Availability Zones.

" } }, - "Region": { + "VpcId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's AWS region.

" + "smithy.api#documentation": "

The VPC ID.

" } }, - "Ec2InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", + "LayerId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

" + "smithy.api#documentation": "

The ID of the layer that the instance is attached to.

" } }, - "ElasticLoadBalancerName": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The Elastic Load Balancing instance's name.

" + "smithy.api#documentation": "

The ID of the stack that the instance is associated with.

" } }, - "DnsName": { + "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's public DNS name.

" + "smithy.api#documentation": "

The instance's AWS region.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs, if the stack is running in a VPC.

" } } }, @@ -3743,11 +3743,10 @@ "com.amazonaws.opsworks#EnvironmentVariable": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.opsworks#String", + "Secure": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

", - "smithy.api#required": {} + "smithy.api#documentation": "

(Optional) Whether the variable's value will be returned by the DescribeApps action.\n To conceal an environment variable's value, set Secure to true.\n DescribeApps then returns *****FILTERED***** instead of the actual\n value. The default value for Secure is false.

" } }, "Value": { @@ -3757,10 +3756,11 @@ "smithy.api#required": {} } }, - "Secure": { - "target": "com.amazonaws.opsworks#Boolean", + "Key": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

(Optional) Whether the variable's value will be returned by the DescribeApps action.\n To conceal an environment variable's value, set Secure to true.\n DescribeApps then returns *****FILTERED***** instead of the actual\n value. The default value for Secure is false.

" + "smithy.api#documentation": "

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

", + "smithy.api#required": {} } } }, @@ -3884,112 +3884,100 @@ "com.amazonaws.opsworks#Instance": { "type": "structure", "members": { - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must then update\n your instances manually by using CreateDeployment to run the\n update_dependencies stack command or\n by manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " - } - }, - "EcsClusterArn": { + "PrivateIp": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For container instances, the Amazon ECS cluster's ARN.

" + "smithy.api#documentation": "

The instance's private IP address.

" } }, - "Platform": { - "target": "com.amazonaws.opsworks#String", + "AutoScalingType": { + "target": "com.amazonaws.opsworks#AutoScalingType", "traits": { - "smithy.api#documentation": "

The instance's platform.

" + "smithy.api#documentation": "

For load-based or time-based instances, the type.

" } }, - "AgentVersion": { + "PublicDns": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The agent version. This parameter is set to INHERIT if\n the instance inherits the default stack setting or to a\n a version number for a fixed agent version.

" + "smithy.api#documentation": "

The instance public DNS name.

" } }, - "InfrastructureClass": { - "target": "com.amazonaws.opsworks#String", + "EbsOptimized": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

For registered instances, the infrastructure class: ec2 or\n on-premises.

" + "smithy.api#documentation": "

Whether this is an Amazon EBS-optimized instance.

" } }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", + "SecurityGroupIds": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

The time that the instance was created.

" + "smithy.api#documentation": "

An array containing the instance security group IDs.

" } }, - "EcsContainerInstanceArn": { + "LastServiceErrorId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For container instances, the instance's ARN.

" + "smithy.api#documentation": "

The ID of the last service error. For more information, call\n DescribeServiceErrors.

" } }, - "Tenancy": { - "target": "com.amazonaws.opsworks#String", + "InstallUpdatesOnBoot": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The instance's tenancy option, such as dedicated or host.

" + "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must then update\n your instances manually by using CreateDeployment to run the\n update_dependencies stack command or\n by manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " } }, - "ElasticIp": { + "EcsContainerInstanceArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance Elastic IP address .

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the instance layer IDs.

" + "smithy.api#documentation": "

For container instances, the instance's ARN.

" } }, - "InstanceType": { + "Ec2InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro.

" + "smithy.api#documentation": "

The ID of the associated Amazon EC2 instance.

" } }, - "Arn": { + "SshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's Amazon Resource Number (ARN).

" + "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" } }, - "StackId": { + "Status": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack ID.

" + "smithy.api#documentation": "

The instance status:

\n
    \n
  • \n

    \n booting\n

    \n
    • \n
  • \n

    \n connection_lost\n

    \n
    • \n
  • \n

    \n online\n

    \n
    • \n
  • \n

    \n pending\n

    \n
    • \n
  • \n

    \n rebooting\n

    \n
    • \n
  • \n

    \n requested\n

    \n
    • \n
  • \n

    \n running_setup\n

    \n
    • \n
  • \n

    \n setup_failed\n

    \n
    • \n
  • \n

    \n shutting_down\n

    \n
    • \n
  • \n

    \n start_failed\n

    \n
    • \n
  • \n

    \n stop_failed\n

    \n
    • \n
  • \n

    \n stopped\n

    \n
    • \n
  • \n

    \n stopping\n

    \n
    • \n
  • \n

    \n terminated\n

    \n
    • \n
  • \n

    \n terminating\n

    \n
    • \n
" } }, - "LastServiceErrorId": { + "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ID of the last service error. For more information, call\n DescribeServiceErrors.

" + "smithy.api#documentation": "

The agent version. This parameter is set to INHERIT if\n the instance inherits the default stack setting or to a\n a version number for a fixed agent version.

" } }, - "SubnetId": { + "Platform": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's subnet ID; applicable only if the stack is running in a VPC.

" + "smithy.api#documentation": "

The instance's platform.

" } }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", + "Tenancy": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type.

" + "smithy.api#documentation": "

The instance's tenancy option, such as dedicated or host.

" } }, - "SshHostRsaKeyFingerprint": { + "ElasticIp": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The SSH key's RSA fingerprint.

" + "smithy.api#documentation": "

The instance Elastic IP address .

" } }, - "PrivateIp": { + "InstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's private IP address.

" + "smithy.api#documentation": "

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using\n Identifiers.

" } }, "ReportedOs": { @@ -3998,40 +3986,34 @@ "smithy.api#documentation": "

For registered instances, the reported operating system.

" } }, - "Ec2InstanceId": { + "Arn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ID of the associated Amazon EC2 instance.

" - } - }, - "RootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The instance's root device type. For more information, see Storage for the Root Device.

" + "smithy.api#documentation": "

The instance's Amazon Resource Number (ARN).

" } }, - "InstanceProfileArn": { + "EcsClusterArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using\n Identifiers.

" + "smithy.api#documentation": "

For container instances, the Amazon ECS cluster's ARN.

" } }, - "EbsOptimized": { - "target": "com.amazonaws.opsworks#Boolean", + "CreatedAt": { + "target": "com.amazonaws.opsworks#DateTime", "traits": { - "smithy.api#documentation": "

Whether this is an Amazon EBS-optimized instance.

" + "smithy.api#documentation": "

The time that the instance was created.

" } }, - "Hostname": { + "InfrastructureClass": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance host name.

" + "smithy.api#documentation": "

For registered instances, the infrastructure class: ec2 or\n on-premises.

" } }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", + "RootDeviceType": { + "target": "com.amazonaws.opsworks#RootDeviceType", "traits": { - "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" + "smithy.api#documentation": "

The instance's root device type. For more information, see Storage for the Root Device.

" } }, "ReportedAgentVersion": { @@ -4040,52 +4022,52 @@ "smithy.api#documentation": "

The instance's reported AWS OpsWorks Stacks agent version.

" } }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", + "AvailabilityZone": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance architecture: \"i386\" or \"x86_64\".

" + "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" } }, - "PublicIp": { + "RegisteredBy": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance public IP address.

" + "smithy.api#documentation": "

For registered instances, who performed the registration.

" } }, - "InstanceId": { + "AmiId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance ID.

" + "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. For more\n information, see Instances\n

" } }, - "VirtualizationType": { - "target": "com.amazonaws.opsworks#VirtualizationType", + "SubnetId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's virtualization type: paravirtual or hvm.

" + "smithy.api#documentation": "

The instance's subnet ID; applicable only if the stack is running in a VPC.

" } }, - "Status": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance status:

\n
    \n
  • \n

    \n booting\n

    \n
    • \n
  • \n

    \n connection_lost\n

    \n
    • \n
  • \n

    \n online\n

    \n
    • \n
  • \n

    \n pending\n

    \n
    • \n
  • \n

    \n rebooting\n

    \n
    • \n
  • \n

    \n requested\n

    \n
    • \n
  • \n

    \n running_setup\n

    \n
    • \n
  • \n

    \n setup_failed\n

    \n
    • \n
  • \n

    \n shutting_down\n

    \n
    • \n
  • \n

    \n start_failed\n

    \n
    • \n
  • \n

    \n stop_failed\n

    \n
    • \n
  • \n

    \n stopped\n

    \n
    • \n
  • \n

    \n stopping\n

    \n
    • \n
  • \n

    \n terminated\n

    \n
    • \n
  • \n

    \n terminating\n

    \n
    • \n
" + "smithy.api#documentation": "

The stack ID.

" } }, - "SshKeyName": { + "Os": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" + "smithy.api#documentation": "

The instance's operating system.

" } }, - "RegisteredBy": { + "SshHostRsaKeyFingerprint": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For registered instances, who performed the registration.

" + "smithy.api#documentation": "

The SSH key's RSA fingerprint.

" } }, - "AmiId": { + "SshHostDsaKeyFingerprint": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. For more\n information, see Instances\n

" + "smithy.api#documentation": "

The SSH key's Deep Security Agent (DSA) fingerprint.

" } }, "BlockDeviceMappings": { @@ -4100,34 +4082,52 @@ "smithy.api#documentation": "

The instance's private DNS name.

" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", + "PublicIp": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

An array containing the instance security group IDs.

" + "smithy.api#documentation": "

The instance public IP address.

" } }, - "Os": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's operating system.

" + "smithy.api#documentation": "

The instance ID.

" } }, - "RootDeviceVolumeId": { + "VirtualizationType": { + "target": "com.amazonaws.opsworks#VirtualizationType", + "traits": { + "smithy.api#documentation": "

The instance's virtualization type: paravirtual or hvm.

" + } + }, + "Architecture": { + "target": "com.amazonaws.opsworks#Architecture", + "traits": { + "smithy.api#documentation": "

The instance architecture: \"i386\" or \"x86_64\".

" + } + }, + "InstanceType": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The root device volume ID.

" + "smithy.api#documentation": "

The instance type, such as t2.micro.

" } }, - "SshHostDsaKeyFingerprint": { + "Hostname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The SSH key's Deep Security Agent (DSA) fingerprint.

" + "smithy.api#documentation": "

The instance host name.

" } }, - "PublicDns": { + "LayerIds": { + "target": "com.amazonaws.opsworks#Strings", + "traits": { + "smithy.api#documentation": "

An array containing the instance layer IDs.

" + } + }, + "RootDeviceVolumeId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance public DNS name.

" + "smithy.api#documentation": "

The root device volume ID.

" } } }, @@ -4138,16 +4138,16 @@ "com.amazonaws.opsworks#InstanceIdentity": { "type": "structure", "members": { - "Signature": { + "Document": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A signature that can be used to verify the document's accuracy and authenticity.

" + "smithy.api#documentation": "

A JSON document that contains the metadata.

" } }, - "Document": { + "Signature": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A JSON document that contains the metadata.

" + "smithy.api#documentation": "

A signature that can be used to verify the document's accuracy and authenticity.

" } } }, @@ -4164,40 +4164,34 @@ "com.amazonaws.opsworks#InstancesCount": { "type": "structure", "members": { - "Stopped": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with stopped status.

" - } - }, - "Registered": { + "Booting": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances in the Registered state.

" + "smithy.api#documentation": "

The number of instances with booting status.

" } }, - "Online": { + "SetupFailed": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with online status.

" + "smithy.api#documentation": "

The number of instances with setup_failed status.

" } }, - "Registering": { + "Rebooting": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances in the Registering state.

" + "smithy.api#documentation": "

The number of instances with rebooting status.

" } }, - "Pending": { + "StopFailed": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with pending status.

" + "smithy.api#documentation": "

The number of instances with stop_failed status.

" } }, - "Rebooting": { + "Deregistering": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with rebooting status.

" + "smithy.api#documentation": "

The number of instances in the Deregistering state.

" } }, "Requested": { @@ -4206,58 +4200,64 @@ "smithy.api#documentation": "

The number of instances with requested status.

" } }, - "SetupFailed": { + "Unassigning": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with setup_failed status.

" + "smithy.api#documentation": "

The number of instances in the Unassigning state.

" } }, - "ConnectionLost": { + "Pending": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with connection_lost status.

" + "smithy.api#documentation": "

The number of instances with pending status.

" } }, - "Deregistering": { + "Registered": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances in the Deregistering state.

" + "smithy.api#documentation": "

The number of instances in the Registered state.

" } }, - "Terminated": { + "Online": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with terminated status.

" + "smithy.api#documentation": "

The number of instances with online status.

" } }, - "StopFailed": { + "Registering": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with stop_failed status.

" + "smithy.api#documentation": "

The number of instances in the Registering state.

" } }, - "ShuttingDown": { + "ConnectionLost": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with shutting_down status.

" + "smithy.api#documentation": "

The number of instances with connection_lost status.

" } }, - "Stopping": { + "Assigning": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with stopping status.

" + "smithy.api#documentation": "

The number of instances in the Assigning state.

" } }, - "Assigning": { + "Terminating": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances in the Assigning state.

" + "smithy.api#documentation": "

The number of instances with terminating status.

" } }, - "Unassigning": { + "StartFailed": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances in the Unassigning state.

" + "smithy.api#documentation": "

The number of instances with start_failed status.

" + } + }, + "Stopped": { + "target": "com.amazonaws.opsworks#Integer", + "traits": { + "smithy.api#documentation": "

The number of instances with stopped status.

" } }, "RunningSetup": { @@ -4266,22 +4266,22 @@ "smithy.api#documentation": "

The number of instances with running_setup status.

" } }, - "StartFailed": { + "Terminated": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with start_failed status.

" + "smithy.api#documentation": "

The number of instances with terminated status.

" } }, - "Booting": { + "ShuttingDown": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with booting status.

" + "smithy.api#documentation": "

The number of instances with shutting_down status.

" } }, - "Terminating": { + "Stopping": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of instances with terminating status.

" + "smithy.api#documentation": "

The number of instances with stopping status.

" } } }, @@ -4298,142 +4298,142 @@ "com.amazonaws.opsworks#Layer": { "type": "structure", "members": { - "Name": { + "Arn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The layer name.

" + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a layer.

" } }, - "StackId": { - "target": "com.amazonaws.opsworks#String", + "VolumeConfigurations": { + "target": "com.amazonaws.opsworks#VolumeConfigurations", "traits": { - "smithy.api#documentation": "

The layer stack ID.

" + "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" } }, - "DefaultRecipes": { - "target": "com.amazonaws.opsworks#Recipes", + "Attributes": { + "target": "com.amazonaws.opsworks#LayerAttributes", "traits": { - "smithy.api#documentation": "

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, \n deploy, undeploy, and shutdown.\n For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide \n custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard \n recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of \n the five events.

\n

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe \n name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the \n dbsetup.rb recipe in the repository's phpapp2 folder.

" + "smithy.api#documentation": "

The layer attributes.

\n

For the HaproxyStatsPassword, MysqlRootPassword, and\n GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED*****\n instead of the actual value

\n

For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

" } }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", + "InstallUpdatesOnBoot": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

A LifeCycleEventConfiguration object that specifies the Shutdown event\n configuration.

" + "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must then update\n your instances manually by using CreateDeployment to run the\n update_dependencies stack command or manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " } }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", + "CreatedAt": { + "target": "com.amazonaws.opsworks#DateTime", "traits": { - "smithy.api#documentation": "

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" + "smithy.api#documentation": "

Date when the layer was created.

" } }, - "Shortname": { + "LayerId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The layer short name.

" - } - }, - "AutoAssignPublicIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" + "smithy.api#documentation": "

The layer ID.

" } }, - "DefaultSecurityGroupNames": { + "CustomSecurityGroupIds": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

An array containing the layer's security group names.

" + "smithy.api#documentation": "

An array containing the layer's custom security group IDs.

" } }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", + "Type": { + "target": "com.amazonaws.opsworks#LayerType", "traits": { - "smithy.api#documentation": "

Whether auto healing is disabled for the layer.

" + "smithy.api#documentation": "

The layer type.

" } }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", + "DefaultRecipes": { + "target": "com.amazonaws.opsworks#Recipes", "traits": { - "smithy.api#documentation": "

Date when the layer was created.

" + "smithy.api#documentation": "

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, \n deploy, undeploy, and shutdown.\n For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide \n custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard \n recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of \n the five events.

\n

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe \n name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the \n dbsetup.rb recipe in the repository's phpapp2 folder.

" } }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", + "CustomJson": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" + "smithy.api#documentation": "

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

" } }, - "Arn": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a layer.

" + "smithy.api#documentation": "

The layer stack ID.

" } }, - "InstallUpdatesOnBoot": { + "AutoAssignPublicIps": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must then update\n your instances manually by using CreateDeployment to run the\n update_dependencies stack command or manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " + "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" } }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", + "CustomRecipes": { + "target": "com.amazonaws.opsworks#Recipes", "traits": { - "smithy.api#documentation": "

The layer attributes.

\n

For the HaproxyStatsPassword, MysqlRootPassword, and\n GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED*****\n instead of the actual value

\n

For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

" + "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" } }, - "LayerId": { + "Shortname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The layer ID.

" + "smithy.api#documentation": "

The layer short name.

" } }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", + "LifecycleEventConfiguration": { + "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" + "smithy.api#documentation": "

A LifeCycleEventConfiguration object that specifies the Shutdown event\n configuration.

" } }, - "CustomSecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", + "CloudWatchLogsConfiguration": { + "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", "traits": { - "smithy.api#documentation": "

An array containing the layer's custom security group IDs.

" + "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration settings for the layer.

" } }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", + "Packages": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

" + "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" } }, - "Type": { - "target": "com.amazonaws.opsworks#LayerType", + "UseEbsOptimizedInstances": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The layer type.

" + "smithy.api#documentation": "

Whether the layer uses Amazon EBS-optimized instances.

" } }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", + "AutoAssignElasticIps": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" } }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", + "DefaultSecurityGroupNames": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration settings for the layer.

" + "smithy.api#documentation": "

An array containing the layer's security group names.

" } }, - "UseEbsOptimizedInstances": { + "EnableAutoHealing": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

Whether the layer uses Amazon EBS-optimized instances.

" + "smithy.api#documentation": "

Whether auto healing is disabled for the layer.

" } }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", + "CustomInstanceProfileArn": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" + "smithy.api#documentation": "

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" + } + }, + "Name": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The layer name.

" } } }, @@ -4625,34 +4625,34 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.opsworks#NextToken", - "traits": { - "smithy.api#documentation": "

Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call.\n

" - } - }, "MaxResults": { "target": "com.amazonaws.opsworks#MaxResults", "traits": { "smithy.api#documentation": "

Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call.\n

" } + }, + "NextToken": { + "target": "com.amazonaws.opsworks#NextToken", + "traits": { + "smithy.api#documentation": "

Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call.\n

" + } } } }, "com.amazonaws.opsworks#ListTagsResult": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.opsworks#Tags", - "traits": { - "smithy.api#documentation": "

A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.

" - } - }, "NextToken": { "target": "com.amazonaws.opsworks#NextToken", "traits": { "smithy.api#documentation": "

If a paginated request does not return all of the remaining results, this parameter is set to a token that\n you can assign to the request object's NextToken parameter to get the next set of results.\n If the previous paginated request returned all of the remaining results,\n this parameter is set to null.\n

" } + }, + "Tags": { + "target": "com.amazonaws.opsworks#Tags", + "traits": { + "smithy.api#documentation": "

A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.

" + } } }, "traits": { @@ -4662,22 +4662,16 @@ "com.amazonaws.opsworks#LoadBasedAutoScalingConfiguration": { "type": "structure", "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - }, "Enable": { "target": "com.amazonaws.opsworks#Boolean", "traits": { "smithy.api#documentation": "

Whether load-based auto scaling is enabled for the layer.

" } }, - "DownScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", + "LayerId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object that describes the downscaling configuration,\n which defines how and when AWS OpsWorks Stacks reduces the number of instances.

" + "smithy.api#documentation": "

The layer ID.

" } }, "UpScaling": { @@ -4685,6 +4679,12 @@ "traits": { "smithy.api#documentation": "

An AutoScalingThresholds object that describes the upscaling configuration,\n which defines how and when AWS OpsWorks Stacks increases the number of instances.

" } + }, + "DownScaling": { + "target": "com.amazonaws.opsworks#AutoScalingThresholds", + "traits": { + "smithy.api#documentation": "

An AutoScalingThresholds object that describes the downscaling configuration,\n which defines how and when AWS OpsWorks Stacks reduces the number of instances.

" + } } }, "traits": { @@ -4712,32 +4712,26 @@ }, "com.amazonaws.opsworks#NextToken": { "type": "string" - }, - "com.amazonaws.opsworks#OperatingSystem": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of a supported operating system, such as Amazon Linux 2018.03.

" - } - }, - "ReportedVersion": { - "target": "com.amazonaws.opsworks#String", + }, + "com.amazonaws.opsworks#OperatingSystem": { + "type": "structure", + "members": { + "ConfigurationManagers": { + "target": "com.amazonaws.opsworks#OperatingSystemConfigurationManagers", "traits": { - "smithy.api#documentation": "

The version of the operating system, including the release and edition, if applicable.

" + "smithy.api#documentation": "

Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.

" } }, - "Name": { + "ReportedName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The name of the operating system, such as Amazon Linux 2018.03.

" + "smithy.api#documentation": "

A short name for the operating system manufacturer.

" } }, - "ReportedName": { + "Type": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A short name for the operating system manufacturer.

" + "smithy.api#documentation": "

The type of a supported operating system, either Linux or Windows.

" } }, "Supported": { @@ -4746,16 +4740,22 @@ "smithy.api#documentation": "

Indicates that an operating system is not supported for new instances.

" } }, - "Type": { + "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The type of a supported operating system, either Linux or Windows.

" + "smithy.api#documentation": "

The name of the operating system, such as Amazon Linux 2018.03.

" } }, - "ConfigurationManagers": { - "target": "com.amazonaws.opsworks#OperatingSystemConfigurationManagers", + "Id": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.

" + "smithy.api#documentation": "

The ID of a supported operating system, such as Amazon Linux 2018.03.

" + } + }, + "ReportedVersion": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The version of the operating system, including the release and edition, if applicable.

" } } }, @@ -4766,16 +4766,16 @@ "com.amazonaws.opsworks#OperatingSystemConfigurationManager": { "type": "structure", "members": { - "Version": { + "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The versions of the configuration manager that are supported by an operating system.

" + "smithy.api#documentation": "

The name of the configuration manager, which is Chef.

" } }, - "Name": { + "Version": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The name of the configuration manager, which is Chef.

" + "smithy.api#documentation": "

The versions of the configuration manager that are supported by an operating system.

" } } }, @@ -5052,16 +5052,16 @@ "com.amazonaws.opsworks#Permission": { "type": "structure", "members": { - "AllowSsh": { - "target": "com.amazonaws.opsworks#Boolean", + "StackId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether the user can use SSH.

" + "smithy.api#documentation": "

A stack ID.

" } }, - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", + "AllowSudo": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more\n information about IAM ARNs, see Using\n Identifiers.

" + "smithy.api#documentation": "

Whether the user can use sudo.

" } }, "Level": { @@ -5070,16 +5070,16 @@ "smithy.api#documentation": "

The user's permission level, which must be the following:

\n
    \n
  • \n

    \n deny\n

    \n
    • \n
  • \n

    \n show\n

    \n
    • \n
  • \n

    \n deploy\n

    \n
    • \n
  • \n

    \n manage\n

    \n
    • \n
  • \n

    \n iam_only\n

    \n
    • \n
\n

For more information on the permissions associated with these levels, see Managing User Permissions\n

" } }, - "StackId": { + "IamUserArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A stack ID.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more\n information about IAM ARNs, see Using\n Identifiers.

" } }, - "AllowSudo": { + "AllowSsh": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

Whether the user can use sudo.

" + "smithy.api#documentation": "

Whether the user can use SSH.

" } } }, @@ -5096,22 +5096,16 @@ "com.amazonaws.opsworks#RaidArray": { "type": "structure", "members": { - "AvailabilityZone": { + "VolumeType": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The array's Availability Zone. For more information, see Regions and Endpoints.

" + "smithy.api#documentation": "

The volume type, standard or PIOPS.

" } }, - "Size": { + "NumberOfDisks": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The array's size.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" + "smithy.api#documentation": "

The number of disks in the array.

" } }, "RaidLevel": { @@ -5120,58 +5114,64 @@ "smithy.api#documentation": "

The RAID level.

" } }, + "MountPoint": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The array's mount point.

" + } + }, "Iops": { "target": "com.amazonaws.opsworks#Integer", "traits": { "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" } }, - "Device": { + "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The array's Linux device. For example /dev/mdadm0.

" + "smithy.api#documentation": "

The array name.

" } }, - "Name": { + "AvailabilityZone": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The array name.

" + "smithy.api#documentation": "

The array's Availability Zone. For more information, see Regions and Endpoints.

" } }, - "StackId": { + "RaidArrayId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack ID.

" + "smithy.api#documentation": "

The array ID.

" } }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", + "Size": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

When the RAID array was created.

" + "smithy.api#documentation": "

The array's size.

" } }, - "MountPoint": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The array's mount point.

" + "smithy.api#documentation": "

The instance ID.

" } }, - "NumberOfDisks": { - "target": "com.amazonaws.opsworks#Integer", + "CreatedAt": { + "target": "com.amazonaws.opsworks#DateTime", "traits": { - "smithy.api#documentation": "

The number of disks in the array.

" + "smithy.api#documentation": "

When the RAID array was created.

" } }, - "RaidArrayId": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The array ID.

" + "smithy.api#documentation": "

The stack ID.

" } }, - "VolumeType": { + "Device": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume type, standard or PIOPS.

" + "smithy.api#documentation": "

The array's Linux device. For example /dev/mdadm0.

" } } }, @@ -5188,58 +5188,58 @@ "com.amazonaws.opsworks#RdsDbInstance": { "type": "structure", "members": { - "DbUser": { + "Address": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The master user name.

" + "smithy.api#documentation": "

The instance's address.

" } }, - "Address": { + "Engine": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's address.

" + "smithy.api#documentation": "

The instance's database engine.

" } }, - "DbPassword": { + "DbInstanceIdentifier": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" + "smithy.api#documentation": "

The DB instance identifier.

" } }, - "StackId": { - "target": "com.amazonaws.opsworks#String", + "MissingOnRds": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The ID of the stack with which the instance is registered.

" + "smithy.api#documentation": "

Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts\n to discover the instance only once. If this value is set to true, you must\n deregister the instance, and then register it again.

" } }, - "Region": { + "RdsDbInstanceArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's AWS region.

" + "smithy.api#documentation": "

The instance's ARN.

" } }, - "Engine": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's database engine.

" + "smithy.api#documentation": "

The ID of the stack with which the instance is registered.

" } }, - "RdsDbInstanceArn": { + "DbUser": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's ARN.

" + "smithy.api#documentation": "

The master user name.

" } }, - "MissingOnRds": { - "target": "com.amazonaws.opsworks#Boolean", + "Region": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts\n to discover the instance only once. If this value is set to true, you must\n deregister the instance, and then register it again.

" + "smithy.api#documentation": "

The instance's AWS region.

" } }, - "DbInstanceIdentifier": { + "DbPassword": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier.

" + "smithy.api#documentation": "

AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" } } }, @@ -5285,16 +5285,16 @@ "com.amazonaws.opsworks#Recipes": { "type": "structure", "members": { - "Shutdown": { + "Deploy": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a shutdown event.

" + "smithy.api#documentation": "

An array of custom recipe names to be run following a deploy event.

" } }, - "Undeploy": { + "Configure": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a undeploy event.

" + "smithy.api#documentation": "

An array of custom recipe names to be run following a configure event.

" } }, "Setup": { @@ -5303,16 +5303,16 @@ "smithy.api#documentation": "

An array of custom recipe names to be run following a setup event.

" } }, - "Configure": { + "Shutdown": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a configure event.

" + "smithy.api#documentation": "

An array of custom recipe names to be run following a shutdown event.

" } }, - "Deploy": { + "Undeploy": { "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a deploy event.

" + "smithy.api#documentation": "

An array of custom recipe names to be run following a undeploy event.

" } } }, @@ -5449,16 +5449,17 @@ "com.amazonaws.opsworks#RegisterInstanceRequest": { "type": "structure", "members": { - "RsaPublicKey": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

" + "smithy.api#documentation": "

The ID of the stack that the instance is to be registered with.

", + "smithy.api#required": {} } }, - "PrivateIp": { + "Hostname": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's private IP address.

" + "smithy.api#documentation": "

The instance's hostname.

" } }, "RsaPublicKeyFingerprint": { @@ -5467,29 +5468,28 @@ "smithy.api#documentation": "

The instances public RSA key fingerprint.

" } }, - "StackId": { - "target": "com.amazonaws.opsworks#String", + "InstanceIdentity": { + "target": "com.amazonaws.opsworks#InstanceIdentity", "traits": { - "smithy.api#documentation": "

The ID of the stack that the instance is to be registered with.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An InstanceIdentity object that contains the instance's identity.

" } }, - "Hostname": { + "PublicIp": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's hostname.

" + "smithy.api#documentation": "

The instance's public IP address.

" } }, - "InstanceIdentity": { - "target": "com.amazonaws.opsworks#InstanceIdentity", + "RsaPublicKey": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

An InstanceIdentity object that contains the instance's identity.

" + "smithy.api#documentation": "

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

" } }, - "PublicIp": { + "PrivateIp": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's public IP address.

" + "smithy.api#documentation": "

The instance's private IP address.

" } } } @@ -5535,10 +5535,10 @@ "smithy.api#required": {} } }, - "DbPassword": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The database password.

", + "smithy.api#documentation": "

The stack ID.

", "smithy.api#required": {} } }, @@ -5549,10 +5549,10 @@ "smithy.api#required": {} } }, - "StackId": { + "DbPassword": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack ID.

", + "smithy.api#documentation": "

The database password.

", "smithy.api#required": {} } } @@ -5581,17 +5581,17 @@ "com.amazonaws.opsworks#RegisterVolumeRequest": { "type": "structure", "members": { - "StackId": { + "Ec2VolumeId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon EBS volume ID.

" } }, - "Ec2VolumeId": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The Amazon EBS volume ID.

" + "smithy.api#documentation": "

The stack ID.

", + "smithy.api#required": {} } } } @@ -5670,22 +5670,16 @@ "com.amazonaws.opsworks#SelfUserProfile": { "type": "structure", "members": { - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" - } - }, "Name": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

The user's name.

" } }, - "SshUsername": { + "SshPublicKey": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's SSH user name.

" + "smithy.api#documentation": "

The user's SSH public key.

" } }, "IamUserArn": { @@ -5693,6 +5687,12 @@ "traits": { "smithy.api#documentation": "

The user's IAM ARN.

" } + }, + "SshUsername": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The user's SSH user name.

" + } } }, "traits": { @@ -5702,40 +5702,40 @@ "com.amazonaws.opsworks#ServiceError": { "type": "structure", "members": { - "ServiceErrorId": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The error ID.

" + "smithy.api#documentation": "

The stack ID.

" } }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", + "InstanceId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

When the error occurred.

" + "smithy.api#documentation": "

The instance ID.

" } }, - "StackId": { + "Message": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack ID.

" + "smithy.api#documentation": "

A message that describes the error.

" } }, - "Type": { - "target": "com.amazonaws.opsworks#String", + "CreatedAt": { + "target": "com.amazonaws.opsworks#DateTime", "traits": { - "smithy.api#documentation": "

The error type.

" + "smithy.api#documentation": "

When the error occurred.

" } }, - "InstanceId": { + "ServiceErrorId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance ID.

" + "smithy.api#documentation": "

The error ID.

" } }, - "Message": { + "Type": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A message that describes the error.

" + "smithy.api#documentation": "

The error type.

" } } }, @@ -5769,6 +5769,18 @@ "com.amazonaws.opsworks#SetLoadBasedAutoScalingRequest": { "type": "structure", "members": { + "Enable": { + "target": "com.amazonaws.opsworks#Boolean", + "traits": { + "smithy.api#documentation": "

Enables load-based auto scaling for the layer.

" + } + }, + "DownScaling": { + "target": "com.amazonaws.opsworks#AutoScalingThresholds", + "traits": { + "smithy.api#documentation": "

An AutoScalingThresholds object with the downscaling threshold configuration. If\n the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified\n number of instances.

" + } + }, "UpScaling": { "target": "com.amazonaws.opsworks#AutoScalingThresholds", "traits": { @@ -5781,18 +5793,6 @@ "smithy.api#documentation": "

The layer ID.

", "smithy.api#required": {} } - }, - "Enable": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Enables load-based auto scaling for the layer.

" - } - }, - "DownScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object with the downscaling threshold configuration. If\n the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified\n number of instances.

" - } } } }, @@ -5816,11 +5816,10 @@ "com.amazonaws.opsworks#SetPermissionRequest": { "type": "structure", "members": { - "IamUserArn": { + "Level": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

\n
    \n
  • \n

    \n deny\n

    \n
    • \n
  • \n

    \n show\n

    \n
    • \n
  • \n

    \n deploy\n

    \n
    • \n
  • \n

    \n manage\n

    \n
    • \n
  • \n

    \n iam_only\n

    \n
    • \n
\n

For more information about the permissions associated with these levels, see Managing User Permissions.

" } }, "AllowSsh": { @@ -5842,10 +5841,11 @@ "smithy.api#documentation": "

The user is allowed to use sudo to elevate privileges.

" } }, - "Level": { + "IamUserArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

\n
    \n
  • \n

    \n deny\n

    \n
    • \n
  • \n

    \n show\n

    \n
    • \n
  • \n

    \n deploy\n

    \n
    • \n
  • \n

    \n manage\n

    \n
    • \n
  • \n

    \n iam_only\n

    \n
    • \n
\n

For more information about the permissions associated with these levels, see Managing User Permissions.

" + "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN.

", + "smithy.api#required": {} } } } @@ -5870,35 +5870,35 @@ "com.amazonaws.opsworks#SetTimeBasedAutoScalingRequest": { "type": "structure", "members": { + "AutoScalingSchedule": { + "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", + "traits": { + "smithy.api#documentation": "

An AutoScalingSchedule with the instance schedule.

" + } + }, "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

The instance ID.

", "smithy.api#required": {} } - }, - "AutoScalingSchedule": { - "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

An AutoScalingSchedule with the instance schedule.

" - } } } }, "com.amazonaws.opsworks#ShutdownEventConfiguration": { "type": "structure", "members": { - "ExecutionTimeout": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.

" - } - }, "DelayUntilElbConnectionsDrained": { "target": "com.amazonaws.opsworks#Boolean", "traits": { "smithy.api#documentation": "

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining\n

" } + }, + "ExecutionTimeout": { + "target": "com.amazonaws.opsworks#Integer", + "traits": { + "smithy.api#documentation": "

The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.

" + } } }, "traits": { @@ -5908,12 +5908,6 @@ "com.amazonaws.opsworks#Source": { "type": "structure", "members": { - "Revision": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

" - } - }, "Username": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -5926,12 +5920,6 @@ "smithy.api#documentation": "

The repository type.

" } }, - "SshKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

In requests, the repository's SSH key.

\n

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" - } - }, "Url": { "target": "com.amazonaws.opsworks#String", "traits": { @@ -5943,6 +5931,18 @@ "traits": { "smithy.api#documentation": "

When included in a request, the parameter depends on the repository type.

\n
    \n
  • \n

    For Amazon S3 bundles, set Password to the appropriate IAM secret access\n key.

    \n
    • \n
  • \n

    For HTTP bundles and Subversion repositories, set Password to the\n password.

    \n
    • \n
\n

For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

\n

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" } + }, + "SshKey": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

In requests, the repository's SSH key.

\n

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" + } + }, + "Revision": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

" + } } }, "traits": { @@ -5971,17 +5971,17 @@ "com.amazonaws.opsworks#SslConfiguration": { "type": "structure", "members": { - "Certificate": { + "PrivateKey": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The contents of the certificate's domain.crt file.

", + "smithy.api#documentation": "

The private key; the contents of the certificate's domain.kex file.

", "smithy.api#required": {} } }, - "PrivateKey": { + "Certificate": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The private key; the contents of the certificate's domain.kex file.

", + "smithy.api#documentation": "

The contents of the certificate's domain.crt file.

", "smithy.api#required": {} } }, @@ -5999,58 +5999,70 @@ "com.amazonaws.opsworks#Stack": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", + "CustomCookbooksSource": { + "target": "com.amazonaws.opsworks#Source", "traits": { - "smithy.api#documentation": "

The stack's attributes.

" + "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" } }, - "DefaultSubnetId": { + "ConfigurationManager": { + "target": "com.amazonaws.opsworks#StackConfigurationManager", + "traits": { + "smithy.api#documentation": "

The configuration manager.

" + } + }, + "DefaultRootDeviceType": { + "target": "com.amazonaws.opsworks#RootDeviceType", + "traits": { + "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + } + }, + "VpcId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The default subnet ID; applicable only if the stack is running in a VPC.

" + "smithy.api#documentation": "

The VPC ID; applicable only if the stack is running in a VPC.

" } }, - "DefaultOs": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack's default operating system.

" + "smithy.api#documentation": "

The stack ID.

" } }, - "Arn": { + "Region": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack's ARN.

" + "smithy.api#documentation": "

The stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see Regions and Endpoints.

" } }, - "CustomJson": { + "HostnameTheme": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" + "smithy.api#documentation": "

The stack host name theme, with spaces replaced by underscores.

" } }, - "DefaultInstanceProfileArn": { + "DefaultSubnetId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" + "smithy.api#documentation": "

The default subnet ID; applicable only if the stack is running in a VPC.

" } }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", + "CustomJson": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.

" + "smithy.api#documentation": "

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" } }, - "VpcId": { + "DefaultSshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The VPC ID; applicable only if the stack is running in a VPC.

" + "smithy.api#documentation": "

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

" } }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", + "Arn": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + "smithy.api#documentation": "

The stack's ARN.

" } }, "CreatedAt": { @@ -6059,40 +6071,40 @@ "smithy.api#documentation": "

The date when the stack was created.

" } }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", + "DefaultInstanceProfileArn": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" + "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" } }, - "HostnameTheme": { + "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack host name theme, with spaces replaced by underscores.

" + "smithy.api#documentation": "

The agent version. This parameter is set to LATEST for auto-update.\n or a version number for a fixed agent version.

" } }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", + "UseOpsworksSecurityGroups": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

" + "smithy.api#documentation": "

Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.

" } }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", + "ServiceRoleArn": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The configuration manager.

" + "smithy.api#documentation": "

The stack AWS Identity and Access Management (IAM) role.

" } }, - "Region": { - "target": "com.amazonaws.opsworks#String", + "UseCustomCookbooks": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see Regions and Endpoints.

" + "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" } }, - "StackId": { - "target": "com.amazonaws.opsworks#String", + "Attributes": { + "target": "com.amazonaws.opsworks#StackAttributes", "traits": { - "smithy.api#documentation": "

The stack ID.

" + "smithy.api#documentation": "

The stack's attributes.

" } }, "Name": { @@ -6101,34 +6113,22 @@ "smithy.api#documentation": "

The stack name.

" } }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", + "ChefConfiguration": { + "target": "com.amazonaws.opsworks#ChefConfiguration", "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" + "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version. For more information, see Create a New Stack.

" } }, - "AgentVersion": { + "DefaultAvailabilityZone": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The agent version. This parameter is set to LATEST for auto-update.\n or a version number for a fixed agent version.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" + "smithy.api#documentation": "

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" } }, - "ServiceRoleArn": { + "DefaultOs": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack AWS Identity and Access Management (IAM) role.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version. For more information, see Create a New Stack.

" + "smithy.api#documentation": "

The stack's default operating system.

" } } }, @@ -6190,22 +6190,16 @@ "smithy.api#documentation": "

The stack name.

" } }, - "AppsCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of apps.

" - } - }, "LayersCount": { "target": "com.amazonaws.opsworks#Integer", "traits": { "smithy.api#documentation": "

The number of layers.

" } }, - "InstancesCount": { - "target": "com.amazonaws.opsworks#InstancesCount", + "AppsCount": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

An InstancesCount object with the number of instances in each status.

" + "smithy.api#documentation": "

The number of apps.

" } }, "Arn": { @@ -6213,6 +6207,12 @@ "traits": { "smithy.api#documentation": "

The stack's ARN.

" } + }, + "InstancesCount": { + "target": "com.amazonaws.opsworks#InstancesCount", + "traits": { + "smithy.api#documentation": "

An InstancesCount object with the number of instances in each status.

" + } } }, "traits": { @@ -6388,17 +6388,17 @@ "com.amazonaws.opsworks#TagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworks#ResourceArn", + "Tags": { + "target": "com.amazonaws.opsworks#Tags", "traits": { - "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", + "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to a stack or layer.

\n
    \n
  • \n

    The key cannot be empty.

    \n
    • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

    \n
    • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

    \n
    • \n
  • \n

    Leading and trailing white spaces are trimmed from both the key and value.

    \n
    • \n
  • \n

    A maximum of 40 tags is allowed for any resource.

    \n
    • \n
", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.opsworks#Tags", + "ResourceArn": { + "target": "com.amazonaws.opsworks#ResourceArn", "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to a stack or layer.

\n
    \n
  • \n

    The key cannot be empty.

    \n
    • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

    \n
    • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

    \n
    • \n
  • \n

    Leading and trailing white spaces are trimmed from both the key and value.

    \n
    • \n
  • \n

    A maximum of 40 tags is allowed for any resource.

    \n
    • \n
", + "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", "smithy.api#required": {} } } @@ -6419,16 +6419,22 @@ "com.amazonaws.opsworks#TemporaryCredential": { "type": "structure", "members": { - "Password": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The password.

" + "smithy.api#documentation": "

The instance's AWS OpsWorks Stacks ID.

" } }, - "InstanceId": { + "Username": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance's AWS OpsWorks Stacks ID.

" + "smithy.api#documentation": "

The user name.

" + } + }, + "Password": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The password.

" } }, "ValidForInMinutes": { @@ -6436,12 +6442,6 @@ "traits": { "smithy.api#documentation": "

The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.

" } - }, - "Username": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user name.

" - } } }, "traits": { @@ -6451,17 +6451,17 @@ "com.amazonaws.opsworks#TimeBasedAutoScalingConfiguration": { "type": "structure", "members": { - "AutoScalingSchedule": { - "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

A WeeklyAutoScalingSchedule object with the instance schedule.

" - } - }, "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

The instance ID.

" } + }, + "AutoScalingSchedule": { + "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", + "traits": { + "smithy.api#documentation": "

A WeeklyAutoScalingSchedule object with the instance schedule.

" + } } }, "traits": { @@ -6588,22 +6588,16 @@ "com.amazonaws.opsworks#UpdateAppRequest": { "type": "structure", "members": { - "AppSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

A Source object that specifies the app repository.

" - } - }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", + "Domains": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances.For more information, see Environment Variables.

\n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20 KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n " + "smithy.api#documentation": "

The app's virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" } }, - "Attributes": { - "target": "com.amazonaws.opsworks#AppAttributes", + "DataSources": { + "target": "com.amazonaws.opsworks#DataSources", "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" + "smithy.api#documentation": "

The app's data sources.

" } }, "EnableSsl": { @@ -6612,47 +6606,53 @@ "smithy.api#documentation": "

Whether SSL is enabled for the app.

" } }, - "Name": { + "Description": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The app name.

" + "smithy.api#documentation": "

A description of the app.

" } }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", + "AppId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The app type.

" + "smithy.api#documentation": "

The app ID.

", + "smithy.api#required": {} } }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", + "SslConfiguration": { + "target": "com.amazonaws.opsworks#SslConfiguration", "traits": { - "smithy.api#documentation": "

The app's data sources.

" + "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" } }, - "AppId": { - "target": "com.amazonaws.opsworks#String", + "Attributes": { + "target": "com.amazonaws.opsworks#AppAttributes", "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" } }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", + "Environment": { + "target": "com.amazonaws.opsworks#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The app's virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" + "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances.For more information, see Environment Variables.

\n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20 KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n " } }, - "Description": { - "target": "com.amazonaws.opsworks#String", + "Type": { + "target": "com.amazonaws.opsworks#AppType", "traits": { - "smithy.api#documentation": "

A description of the app.

" + "smithy.api#documentation": "

The app type.

" } }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", + "AppSource": { + "target": "com.amazonaws.opsworks#Source", "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" + "smithy.api#documentation": "

A Source object that specifies the app repository.

" + } + }, + "Name": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The app name.

" } } } @@ -6712,23 +6712,22 @@ "com.amazonaws.opsworks#UpdateInstanceRequest": { "type": "structure", "members": { - "InstanceId": { + "SshKeyName": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The instance's Amazon EC2 key name.

" } }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", + "EbsOptimized": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" + "smithy.api#documentation": "

This property cannot be updated.

" } }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", + "AmiId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance architecture. Instance types do not necessarily support both architectures. For\n a list of the architectures that are supported by the different instance types, see Instance\n Families and Types.

" + "smithy.api#documentation": "

The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. \n You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.\n

" } }, "InstanceType": { @@ -6737,16 +6736,17 @@ "smithy.api#documentation": "

The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.

" } }, - "AgentVersion": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    \n INHERIT - Use the stack's default agent version setting.

    \n
    • \n
  • \n

    \n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, you must edit the instance configuration and specify a\n new version.\n AWS OpsWorks Stacks then automatically installs that version on the instance.

    \n
    • \n
\n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions.

\n

AgentVersion cannot be set to Chef 12.2.

" + "smithy.api#documentation": "

The instance ID.

", + "smithy.api#required": {} } }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", + "Os": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " + "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux\n 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
\n

For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the AmiId parameter to\n specify the custom AMI that you want to use. For more information about supported operating\n systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

\n \n

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

\n " } }, "Hostname": { @@ -6755,34 +6755,34 @@ "smithy.api#documentation": "

The instance host name.

" } }, - "EbsOptimized": { + "InstallUpdatesOnBoot": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

This property cannot be updated.

" + "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " } }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", + "Architecture": { + "target": "com.amazonaws.opsworks#Architecture", "traits": { - "smithy.api#documentation": "

The instance's layer IDs.

" + "smithy.api#documentation": "

The instance architecture. Instance types do not necessarily support both architectures. For\n a list of the architectures that are supported by the different instance types, see Instance\n Families and Types.

" } }, - "AmiId": { + "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. \n You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.\n

" + "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    \n INHERIT - Use the stack's default agent version setting.

    \n
    • \n
  • \n

    \n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, you must edit the instance configuration and specify a\n new version.\n AWS OpsWorks Stacks then automatically installs that version on the instance.

    \n
    • \n
\n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions.

\n

AgentVersion cannot be set to Chef 12.2.

" } }, - "Os": { - "target": "com.amazonaws.opsworks#String", + "LayerIds": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux\n 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
\n

For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the AmiId parameter to\n specify the custom AMI that you want to use. For more information about supported operating\n systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

\n \n

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

\n " + "smithy.api#documentation": "

The instance's layer IDs.

" } }, - "SshKeyName": { - "target": "com.amazonaws.opsworks#String", + "AutoScalingType": { + "target": "com.amazonaws.opsworks#AutoScalingType", "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key name.

" + "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" } } } @@ -6807,16 +6807,16 @@ "com.amazonaws.opsworks#UpdateLayerRequest": { "type": "structure", "members": { - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", + "UseEbsOptimizedInstances": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" } }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", + "InstallUpdatesOnBoot": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" + "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " } }, "Name": { @@ -6825,16 +6825,22 @@ "smithy.api#documentation": "

The layer name, which is used by the console.

" } }, - "AutoAssignPublicIps": { + "Attributes": { + "target": "com.amazonaws.opsworks#LayerAttributes", + "traits": { + "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" + } + }, + "AutoAssignElasticIps": { "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" + "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" } }, - "Shortname": { + "CustomInstanceProfileArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

\n

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference\n

" + "smithy.api#documentation": "

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" } }, "EnableAutoHealing": { @@ -6843,46 +6849,34 @@ "smithy.api#documentation": "

Whether to disable auto healing for the layer.

" } }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" - } - }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

" - } - }, - "UseEbsOptimizedInstances": { - "target": "com.amazonaws.opsworks#Boolean", + "VolumeConfigurations": { + "target": "com.amazonaws.opsworks#VolumeConfigurations", "traits": { - "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" + "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" } }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", + "CustomRecipes": { + "target": "com.amazonaws.opsworks#Recipes", "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " + "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" } }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", + "CloudWatchLogsConfiguration": { + "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" + "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

" } }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", + "Packages": { + "target": "com.amazonaws.opsworks#Strings", "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" } }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", + "LifecycleEventConfiguration": { + "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" + "smithy.api#documentation": "

" } }, "LayerId": { @@ -6898,16 +6892,22 @@ "smithy.api#documentation": "

An array containing the layer's custom security group IDs.

" } }, + "AutoAssignPublicIps": { + "target": "com.amazonaws.opsworks#Boolean", + "traits": { + "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" + } + }, "CustomJson": { "target": "com.amazonaws.opsworks#String", "traits": { "smithy.api#documentation": "

A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON.\n

" } }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", + "Shortname": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" + "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

\n

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference\n

" } } } @@ -6964,16 +6964,16 @@ "smithy.api#required": {} } }, - "DbUser": { + "DbPassword": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The master user name.

" + "smithy.api#documentation": "

The database password.

" } }, - "DbPassword": { + "DbUser": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The database password.

" + "smithy.api#documentation": "

The master user name.

" } } } @@ -6998,53 +6998,28 @@ "com.amazonaws.opsworks#UpdateStackRequest": { "type": "structure", "members": { - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. UseOpsworksSecurityGroups allows you to\n provide your own custom security groups\n instead of using the built-in groups. UseOpsworksSecurityGroups has\n the following settings:

\n
    \n
  • \n

    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

    \n
    • \n
  • \n

    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

    \n
    • \n
\n

For more information, see Create a New\n Stack.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the\n stack's region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see CreateStack.

" - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's new host name theme, with spaces replaced by underscores.\n The theme is used to generate host names for the stack's instances.\n By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the\n layer's short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
    • \n
  • \n

    \n Clouds\n

    \n
    • \n
  • \n

    \n Europe_Cities\n

    \n
    • \n
  • \n

    \n Fruits\n

    \n
    • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
    • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
    • \n
  • \n

    \n Planets_and_Moons\n

    \n
    • \n
  • \n

    \n Roman_Deities\n

    \n
    • \n
  • \n

    \n Scottish_Islands\n

    \n
    • \n
  • \n

    \n US_Cities\n

    \n
    • \n
  • \n

    \n Wild_Cats\n

    \n
    • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", + "Attributes": { + "target": "com.amazonaws.opsworks#StackAttributes", "traits": { - "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
    • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

    \n
    • \n
\n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

\n " + "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" } }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", + "ChefConfiguration": { + "target": "com.amazonaws.opsworks#ChefConfiguration", "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" + "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" } }, - "DefaultSshKeyName": { + "DefaultOs": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key-pair name. The default value is\n none. If you specify a key-pair name,\n AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" + "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following:

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

    \n
    • \n
\n

The default option is the stack's current operating system.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

" } }, - "StackId": { + "CustomJson": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" } }, "DefaultSubnetId": { @@ -7059,16 +7034,10 @@ "smithy.api#documentation": "

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" } }, - "CustomJson": { + "AgentVersion": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + "smithy.api#documentation": "

The default AWS OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
    • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

    \n
    • \n
\n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

\n " } }, "CustomCookbooksSource": { @@ -7077,22 +7046,23 @@ "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or Cookbooks and Recipes.

" } }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", + "ServiceRoleArn": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + "smithy.api#documentation": "

Do not use this parameter. You cannot update a stack's service role.

" } }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", + "HostnameTheme": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" + "smithy.api#documentation": "

The stack's new host name theme, with spaces replaced by underscores.\n The theme is used to generate host names for the stack's instances.\n By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the\n layer's short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
    • \n
  • \n

    \n Clouds\n

    \n
    • \n
  • \n

    \n Europe_Cities\n

    \n
    • \n
  • \n

    \n Fruits\n

    \n
    • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
    • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
    • \n
  • \n

    \n Planets_and_Moons\n

    \n
    • \n
  • \n

    \n Roman_Deities\n

    \n
    • \n
  • \n

    \n Scottish_Islands\n

    \n
    • \n
  • \n

    \n US_Cities\n

    \n
    • \n
  • \n

    \n Wild_Cats\n

    \n
    • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" } }, - "ServiceRoleArn": { + "StackId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Do not use this parameter. You cannot update a stack's service role.

" + "smithy.api#documentation": "

The stack ID.

", + "smithy.api#required": {} } }, "Name": { @@ -7101,10 +7071,40 @@ "smithy.api#documentation": "

The stack's new name.

" } }, - "DefaultOs": { + "DefaultAvailabilityZone": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following:

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
    • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
    • \n
  • \n

    \n CentOS Linux 7\n

    \n
    • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
    • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
    • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

    \n
    • \n
\n

The default option is the stack's current operating system.\n For more information about supported operating systems,\n see AWS OpsWorks Stacks Operating Systems.

" + "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the\n stack's region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see CreateStack.

" + } + }, + "DefaultSshKeyName": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

A default Amazon EC2 key-pair name. The default value is\n none. If you specify a key-pair name,\n AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" + } + }, + "DefaultInstanceProfileArn": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" + } + }, + "UseCustomCookbooks": { + "target": "com.amazonaws.opsworks#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" + } + }, + "UseOpsworksSecurityGroups": { + "target": "com.amazonaws.opsworks#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. UseOpsworksSecurityGroups allows you to\n provide your own custom security groups\n instead of using the built-in groups. UseOpsworksSecurityGroups has\n the following settings:

\n
    \n
  • \n

    True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

    \n
    • \n
  • \n

    False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

    \n
    • \n
\n

For more information, see Create a New\n Stack.

" + } + }, + "DefaultRootDeviceType": { + "target": "com.amazonaws.opsworks#RootDeviceType", + "traits": { + "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.

" } } } @@ -7129,23 +7129,17 @@ "com.amazonaws.opsworks#UpdateUserProfileRequest": { "type": "structure", "members": { - "SshUsername": { + "IamUserArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS OpsWorks Stacks generates one from the IAM user name.

" - } - }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" + "smithy.api#documentation": "

The user IAM ARN. This can also be a federated user's ARN.

", + "smithy.api#required": {} } }, - "IamUserArn": { + "SshUsername": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS OpsWorks Stacks generates one from the IAM user name.

" } }, "SshPublicKey": { @@ -7153,6 +7147,12 @@ "traits": { "smithy.api#documentation": "

The user's new SSH public key.

" } + }, + "AllowSelfManagement": { + "target": "com.amazonaws.opsworks#Boolean", + "traits": { + "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" + } } } }, @@ -7176,10 +7176,10 @@ "com.amazonaws.opsworks#UpdateVolumeRequest": { "type": "structure", "members": { - "MountPoint": { + "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The new mount point.

" + "smithy.api#documentation": "

The new name.

" } }, "VolumeId": { @@ -7189,10 +7189,10 @@ "smithy.api#required": {} } }, - "Name": { + "MountPoint": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The new name.

" + "smithy.api#documentation": "

The new mount point.

" } } } @@ -7200,16 +7200,16 @@ "com.amazonaws.opsworks#UserProfile": { "type": "structure", "members": { - "SshUsername": { - "target": "com.amazonaws.opsworks#String", + "AllowSelfManagement": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The user's SSH user name.

" + "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" } }, - "IamUserArn": { + "SshPublicKey": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" + "smithy.api#documentation": "

The user's SSH public key.

" } }, "Name": { @@ -7218,16 +7218,16 @@ "smithy.api#documentation": "

The user's name.

" } }, - "SshPublicKey": { + "IamUserArn": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" + "smithy.api#documentation": "

The user's IAM ARN.

" } }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", + "SshUsername": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" + "smithy.api#documentation": "

The user's SSH user name.

" } } }, @@ -7282,10 +7282,10 @@ "com.amazonaws.opsworks#Volume": { "type": "structure", "members": { - "MountPoint": { + "Name": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume mount point. For example, \"/mnt/disk1\".

" + "smithy.api#documentation": "

The volume name.

" } }, "Region": { @@ -7294,76 +7294,76 @@ "smithy.api#documentation": "

The AWS region. For more information about AWS regions, see Regions and Endpoints.

" } }, - "Ec2VolumeId": { - "target": "com.amazonaws.opsworks#String", + "Iops": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The Amazon EC2 volume ID.

" + "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" } }, - "VolumeType": { - "target": "com.amazonaws.opsworks#String", + "Size": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n
    \n
  • \n

    \n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

    \n
    • \n
  • \n

    \n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
" + "smithy.api#documentation": "

The volume size.

" } }, - "VolumeId": { - "target": "com.amazonaws.opsworks#String", + "Encrypted": { + "target": "com.amazonaws.opsworks#Boolean", "traits": { - "smithy.api#documentation": "

The volume ID.

" + "smithy.api#documentation": "

Specifies whether an Amazon EBS volume is encrypted. For more information, \n see Amazon EBS Encryption.

" } }, - "Status": { + "InstanceId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The value returned by DescribeVolumes.

" + "smithy.api#documentation": "

The instance ID.

" } }, - "Size": { - "target": "com.amazonaws.opsworks#Integer", + "Device": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume size.

" + "smithy.api#documentation": "

The device name.

" } }, - "RaidArrayId": { + "Status": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The RAID array ID.

" + "smithy.api#documentation": "

The value returned by DescribeVolumes.

" } }, - "AvailabilityZone": { + "Ec2VolumeId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume Availability Zone. For more information, see Regions and Endpoints.

" + "smithy.api#documentation": "

The Amazon EC2 volume ID.

" } }, - "InstanceId": { + "MountPoint": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The instance ID.

" + "smithy.api#documentation": "

The volume mount point. For example, \"/mnt/disk1\".

" } }, - "Device": { + "VolumeId": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The device name.

" + "smithy.api#documentation": "

The volume ID.

" } }, - "Encrypted": { - "target": "com.amazonaws.opsworks#Boolean", + "RaidArrayId": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

Specifies whether an Amazon EBS volume is encrypted. For more information, \n see Amazon EBS Encryption.

" + "smithy.api#documentation": "

The RAID array ID.

" } }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", + "VolumeType": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" + "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n
    \n
  • \n

    \n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

    \n
    • \n
  • \n

    \n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
" } }, - "Name": { + "AvailabilityZone": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume name.

" + "smithy.api#documentation": "

The volume Availability Zone. For more information, see Regions and Endpoints.

" } } }, @@ -7374,36 +7374,30 @@ "com.amazonaws.opsworks#VolumeConfiguration": { "type": "structure", "members": { - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" - } - }, - "RaidLevel": { - "target": "com.amazonaws.opsworks#Integer", + "VolumeType": { + "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume RAID level.

" + "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n
    \n
  • \n

    \n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

    \n
    • \n
  • \n

    \n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
" } }, - "VolumeType": { + "MountPoint": { "target": "com.amazonaws.opsworks#String", "traits": { - "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n
    \n
  • \n

    \n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

    \n
    • \n
  • \n

    \n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
  • \n

    \n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

    \n
    • \n
" + "smithy.api#documentation": "

The volume mount point. For example \"/dev/sdh\".

", + "smithy.api#required": {} } }, - "Size": { + "NumberOfDisks": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The volume size.

", + "smithy.api#documentation": "

The number of disks in the volume.

", "smithy.api#required": {} } }, - "MountPoint": { - "target": "com.amazonaws.opsworks#String", + "Iops": { + "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The volume mount point. For example \"/dev/sdh\".

", - "smithy.api#required": {} + "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" } }, "Encrypted": { @@ -7412,10 +7406,16 @@ "smithy.api#documentation": "

Specifies whether an Amazon EBS volume is encrypted. For more information, \n see Amazon EBS Encryption.

" } }, - "NumberOfDisks": { + "RaidLevel": { "target": "com.amazonaws.opsworks#Integer", "traits": { - "smithy.api#documentation": "

The number of disks in the volume.

", + "smithy.api#documentation": "

The volume RAID level.

" + } + }, + "Size": { + "target": "com.amazonaws.opsworks#Integer", + "traits": { + "smithy.api#documentation": "

The volume size.

", "smithy.api#required": {} } } @@ -7455,46 +7455,46 @@ "com.amazonaws.opsworks#WeeklyAutoScalingSchedule": { "type": "structure", "members": { - "Saturday": { + "Wednesday": { "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", "traits": { - "smithy.api#documentation": "

The schedule for Saturday.

" + "smithy.api#documentation": "

The schedule for Wednesday.

" } }, - "Tuesday": { + "Friday": { "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", "traits": { - "smithy.api#documentation": "

The schedule for Tuesday.

" + "smithy.api#documentation": "

The schedule for Friday.

" } }, - "Friday": { + "Saturday": { "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", "traits": { - "smithy.api#documentation": "

The schedule for Friday.

" + "smithy.api#documentation": "

The schedule for Saturday.

" } }, - "Monday": { + "Sunday": { "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", "traits": { - "smithy.api#documentation": "

The schedule for Monday.

" + "smithy.api#documentation": "

The schedule for Sunday.

" } }, - "Thursday": { + "Monday": { "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", "traits": { - "smithy.api#documentation": "

The schedule for Thursday.

" + "smithy.api#documentation": "

The schedule for Monday.

" } }, - "Wednesday": { + "Tuesday": { "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", "traits": { - "smithy.api#documentation": "

The schedule for Wednesday.

" + "smithy.api#documentation": "

The schedule for Tuesday.

" } }, - "Sunday": { + "Thursday": { "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", "traits": { - "smithy.api#documentation": "

The schedule for Sunday.

" + "smithy.api#documentation": "

The schedule for Thursday.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/opsworkscm.2016-11-01.json b/codegen/sdk-codegen/aws-models/opsworkscm.2016-11-01.json index a4e43706b4ef..9c56cca2f483 100644 --- a/codegen/sdk-codegen/aws-models/opsworkscm.2016-11-01.json +++ b/codegen/sdk-codegen/aws-models/opsworkscm.2016-11-01.json @@ -38,18 +38,18 @@ "com.amazonaws.opsworkscm#AccountAttribute": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The attribute name. The following are supported attribute names.\n

\n
    \n
  • \n

    \n ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.\n

    \n
    • \n
  • \n

    \n ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum \n of 50 manual backups saved.\n

    \n
    • \n
" - } - }, "Maximum": { "target": "com.amazonaws.opsworkscm#Integer", "traits": { "smithy.api#documentation": "

\n The maximum allowed value.\n

" } }, + "Name": { + "target": "com.amazonaws.opsworkscm#String", + "traits": { + "smithy.api#documentation": "

\n The attribute name. The following are supported attribute names.\n

\n
    \n
  • \n

    \n ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.\n

    \n
    • \n
  • \n

    \n ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum \n of 50 manual backups saved.\n

    \n
    • \n
" + } + }, "Used": { "target": "com.amazonaws.opsworkscm#Integer", "traits": { @@ -103,17 +103,17 @@ "smithy.api#required": {} } }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", + "NodeName": { + "target": "com.amazonaws.opsworkscm#NodeName", "traits": { - "smithy.api#documentation": "

The name of the server with which to associate the node.\n

", + "smithy.api#documentation": "

The name of the node.\n

", "smithy.api#required": {} } }, - "NodeName": { - "target": "com.amazonaws.opsworkscm#NodeName", + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", "traits": { - "smithy.api#documentation": "

The name of the node.\n

", + "smithy.api#documentation": "

The name of the server with which to associate the node.\n

", "smithy.api#required": {} } } @@ -153,22 +153,23 @@ "com.amazonaws.opsworkscm#Backup": { "type": "structure", "members": { - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", + "ToolsVersion": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS\n

" + "smithy.api#documentation": "

\n The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.\n

" } }, - "StatusDescription": { - "target": "com.amazonaws.opsworkscm#String", + "S3DataSize": { + "target": "com.amazonaws.opsworkscm#Integer", "traits": { - "smithy.api#documentation": "

\n An informational message about backup status.\n

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" } }, - "S3LogUrl": { + "KeyPair": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The Amazon S3 URL of the backup's log file.\n

" + "smithy.api#documentation": "

\n The key pair that is obtained from the server when the backup is created.\n

" } }, "Status": { @@ -177,89 +178,83 @@ "smithy.api#documentation": "

The status of a backup while in progress.\n

" } }, - "ToolsVersion": { + "UserArn": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.\n

" + "smithy.api#documentation": "

\n The IAM user ARN of the requester for manual backups. This field is empty for automated backups.\n

" } }, - "Engine": { + "BackupArn": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The engine type that is obtained from the server when the backup is created.\n

" + "smithy.api#documentation": "

The ARN of the backup.\n

" } }, - "BackupType": { - "target": "com.amazonaws.opsworkscm#BackupType", + "CreatedAt": { + "target": "com.amazonaws.opsworkscm#Timestamp", "traits": { - "smithy.api#documentation": "

\n The backup type. Valid values are automated or manual.\n

" + "smithy.api#documentation": "

\n The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z\n

" } }, - "EngineModel": { + "S3DataUrl": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The engine model that is obtained from the server when the backup is created.\n

" + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" } }, - "InstanceType": { + "ServiceRoleArn": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The instance type that is obtained from the server when the backup is created.\n

" + "smithy.api#documentation": "

\n The service role ARN that is obtained from the server when the backup is created.\n

" } }, - "Description": { + "EngineVersion": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n A user-provided description for a manual backup. This field is empty for automated backups.\n

" + "smithy.api#documentation": "

\n The engine version that is obtained from the server when the backup is created.\n

" } }, - "KeyPair": { + "Description": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The key pair that is obtained from the server when the backup is created.\n

" + "smithy.api#documentation": "

\n A user-provided description for a manual backup. This field is empty for automated backups.\n

" } }, - "UserArn": { - "target": "com.amazonaws.opsworkscm#String", + "BackupType": { + "target": "com.amazonaws.opsworkscm#BackupType", "traits": { - "smithy.api#documentation": "

\n The IAM user ARN of the requester for manual backups. This field is empty for automated backups.\n

" + "smithy.api#documentation": "

\n The backup type. Valid values are automated or manual.\n

" } }, - "S3DataSize": { - "target": "com.amazonaws.opsworkscm#Integer", + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" + "smithy.api#documentation": "

\n The name of the server from which the backup was made.\n

" } }, - "ServiceRoleArn": { + "Engine": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The service role ARN that is obtained from the server when the backup is created.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

\n The name of the server from which the backup was made.\n

" + "smithy.api#documentation": "

\n The engine type that is obtained from the server when the backup is created.\n

" } }, - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", + "InstanceType": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z\n

" + "smithy.api#documentation": "

\n The instance type that is obtained from the server when the backup is created.\n

" } }, - "BackupArn": { + "StatusDescription": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The ARN of the backup.\n

" + "smithy.api#documentation": "

\n An informational message about backup status.\n

" } }, - "EngineVersion": { + "S3LogUrl": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The engine version that is obtained from the server when the backup is created.\n

" + "smithy.api#documentation": "

\n The Amazon S3 URL of the backup's log file.\n

" } }, "SecurityGroupIds": { @@ -274,23 +269,22 @@ "smithy.api#documentation": "

\n The subnet IDs that are obtained from the server when the backup is created.\n

" } }, - "PreferredMaintenanceWindow": { + "PreferredBackupWindow": { "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", "traits": { - "smithy.api#documentation": "

\n The preferred maintenance period that is obtained from the server when the backup is created.\n

" + "smithy.api#documentation": "

\n The preferred backup period that is obtained from the server when the backup is created.\n

" } }, - "PreferredBackupWindow": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", "traits": { - "smithy.api#documentation": "

\n The preferred backup period that is obtained from the server when the backup is created.\n

" + "smithy.api#documentation": "

\n The preferred maintenance period that is obtained from the server when the backup is created.\n

" } }, - "S3DataUrl": { + "EngineModel": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" + "smithy.api#documentation": "

\n The engine model that is obtained from the server when the backup is created.\n

" } }, "InstanceProfileArn": { @@ -298,6 +292,12 @@ "traits": { "smithy.api#documentation": "

\n The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored,\n you are not required to provide the InstanceProfileArn again if you restore a backup.\n

" } + }, + "BackupId": { + "target": "com.amazonaws.opsworkscm#BackupId", + "traits": { + "smithy.api#documentation": "

\n The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS\n

" + } } }, "traits": { @@ -402,13 +402,6 @@ "com.amazonaws.opsworkscm#CreateBackupRequest": { "type": "structure", "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server that you want to back up.\n

", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.opsworkscm#TagList", "traits": { @@ -420,6 +413,13 @@ "traits": { "smithy.api#documentation": "

\n A user-defined description of the backup.\n

" } + }, + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", + "traits": { + "smithy.api#documentation": "

The name of the server that you want to back up.\n

", + "smithy.api#required": {} + } } } }, @@ -463,55 +463,54 @@ "com.amazonaws.opsworkscm#CreateServerRequest": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", + "CustomCertificate": { + "target": "com.amazonaws.opsworkscm#CustomCertificate", "traits": { - "smithy.api#documentation": "

\n A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups\n must be within the VPC that is specified by SubnetIds.\n

\n

\n If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to\n 0.0.0.0/0 (everyone).\n

" + "smithy.api#documentation": "

A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a \n custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

\n
    \n
  • \n

    You can provide either a self-signed, custom certificate, or the full certificate chain.

    \n
    • \n
  • \n

    The certificate must be a valid X509 certificate, or a certificate chain in PEM format.

    \n
    • \n
  • \n

    The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires \n (the certificate's NotAfter date).

    \n
    • \n
  • \n

    The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.

    \n
    • \n
  • \n

    The certificate must match the value of CustomPrivateKey.

    \n
    • \n
" } }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", + "ServiceRoleArn": { + "target": "com.amazonaws.opsworkscm#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

\n The IDs of subnets in which to launch the server EC2 instance.\n

\n

\n Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled.\n

\n

\n EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled.\n

\n

For more information about supported Amazon EC2 platforms, see\n Supported Platforms.

" + "smithy.api#documentation": "

\n The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates\n the service role for you, if you are using the AWS CLI or API commands,\n run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.\n This template creates a CloudFormation stack that includes the service role and instance profile that you need.\n

", + "smithy.api#required": {} } }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#BackupRetentionCountDefinition", + "EngineModel": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded.\n The default value is 1.\n

" + "smithy.api#documentation": "

\n The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" } }, - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", + "DisableAutomatedBackup": { + "target": "com.amazonaws.opsworkscm#Boolean", "traits": { - "smithy.api#documentation": "

\n If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.\n

" + "smithy.api#documentation": "

\n Enable or disable scheduled backups. Valid values are true or false. The default value is true.\n

" } }, - "Engine": { - "target": "com.amazonaws.opsworkscm#String", + "AssociatePublicIpAddress": { + "target": "com.amazonaws.opsworkscm#Boolean", "traits": { - "smithy.api#documentation": "

\n The configuration management engine to use. Valid values include ChefAutomate and Puppet.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.\n

" } }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworkscm#InstanceProfileArn", + "PreferredBackupWindow": { + "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", "traits": { - "smithy.api#documentation": "

\n The ARN of the instance profile that your Amazon EC2\n instances use. Although the AWS OpsWorks console typically creates\n the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml\n AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.\n This template creates a CloudFormation stack that includes the instance profile you need.\n \n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server\n if automated backups are enabled. Valid values must be specified in one of the following formats:\n

\n
    \n
  • \n

    \n HH:MM for daily backups

    \n
    • \n
  • \n

    \n DDD:HH:MM for weekly backups

    \n
    • \n
\n

\n MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

\n

\n Example: \n 08:00, which represents a daily start time of 08:00 UTC.

\n

\n Example: \n Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" } }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", + "KeyPair": { + "target": "com.amazonaws.opsworkscm#KeyPair", "traits": { - "smithy.api#documentation": "

\n The Amazon EC2 instance type to use. For example, m5.large.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

\n The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.\n

" } }, - "EngineVersion": { + "InstanceType": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.\n

" + "smithy.api#documentation": "

\n The Amazon EC2 instance type to use. For example, m5.large.\n

", + "smithy.api#required": {} } }, "CustomPrivateKey": { @@ -520,24 +519,24 @@ "smithy.api#documentation": "

A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. \n If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.

" } }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#ServiceRoleArn", + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", "traits": { - "smithy.api#documentation": "

\n The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates\n the service role for you, if you are using the AWS CLI or API commands,\n run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.\n This template creates a CloudFormation stack that includes the service role and instance profile that you need.\n

", + "smithy.api#documentation": "

\n The name of the server. The server name must be unique within your AWS account, within each region.\n Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.\n

", "smithy.api#required": {} } }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", + "InstanceProfileArn": { + "target": "com.amazonaws.opsworkscm#InstanceProfileArn", "traits": { - "smithy.api#documentation": "

\n The name of the server. The server name must be unique within your AWS account, within each region.\n Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.\n

", + "smithy.api#documentation": "

\n The ARN of the instance profile that your Amazon EC2\n instances use. Although the AWS OpsWorks console typically creates\n the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml\n AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.\n This template creates a CloudFormation stack that includes the instance profile you need.\n \n

", "smithy.api#required": {} } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", + "SecurityGroupIds": { + "target": "com.amazonaws.opsworkscm#Strings", "traits": { - "smithy.api#documentation": "

\n The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server\n if automated backups are enabled. Valid values must be specified in one of the following formats:\n

\n
    \n
  • \n

    \n HH:MM for daily backups

    \n
    • \n
  • \n

    \n DDD:HH:MM for weekly backups

    \n
    • \n
\n

\n MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

\n

\n Example: \n 08:00, which represents a daily start time of 08:00 UTC.

\n

\n Example: \n Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" + "smithy.api#documentation": "

\n A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups\n must be within the VPC that is specified by SubnetIds.\n

\n

\n If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to\n 0.0.0.0/0 (everyone).\n

" } }, "PreferredMaintenanceWindow": { @@ -546,52 +545,53 @@ "smithy.api#documentation": "

\n The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.\n Valid values must be specified in the following format: DDD:HH:MM. MM must be specified as 00. The specified time is in coordinated universal time (UTC).\n The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.\n

\n

\n Example:\n Mon:08:00,\n which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)\n

" } }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", + "EngineVersion": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

Optional engine attributes on a specified server.\n

\n

\n Attributes accepted in a Chef createServer request:\n

\n
    \n
  • \n

    \n CHEF_AUTOMATE_PIVOTAL_KEY: A\n base64-encoded RSA public key. The corresponding private key is required to\n access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is\n generated and returned in the response.\n

    \n
    • \n
  • \n

    \n CHEF_AUTOMATE_ADMIN_PASSWORD:\n The password for the administrative user in the Chef Automate web-based dashboard. The\n password length is a minimum of eight characters, and a maximum of 32. The\n password can contain letters, numbers, and special characters\n (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper\n case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is\n generated and returned in the response.

    \n
    • \n
\n

\n Attributes accepted in a Puppet createServer request:\n

\n
    \n
  • \n

    \n PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.

    \n
    • \n
  • \n

    \n PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository \n (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.

    \n
    • \n
  • \n

    \n PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add \n PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

    \n
    • \n
" + "smithy.api#documentation": "

\n The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.\n

" } }, - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", + "BackupRetentionCount": { + "target": "com.amazonaws.opsworkscm#BackupRetentionCountDefinition", "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.

\n
    \n
  • \n

    The key cannot be empty.

    \n
    • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @\n

    \n
    • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @\n

    \n
    • \n
  • \n

    Leading and trailing white spaces are trimmed from both the key and value.

    \n
    • \n
  • \n

    A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.

    \n
    • \n
" + "smithy.api#documentation": "

\n The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded.\n The default value is 1.\n

" } }, - "CustomCertificate": { - "target": "com.amazonaws.opsworkscm#CustomCertificate", + "SubnetIds": { + "target": "com.amazonaws.opsworkscm#Strings", "traits": { - "smithy.api#documentation": "

A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a \n custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

\n
    \n
  • \n

    You can provide either a self-signed, custom certificate, or the full certificate chain.

    \n
    • \n
  • \n

    The certificate must be a valid X509 certificate, or a certificate chain in PEM format.

    \n
    • \n
  • \n

    The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires \n (the certificate's NotAfter date).

    \n
    • \n
  • \n

    The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.

    \n
    • \n
  • \n

    The certificate must match the value of CustomPrivateKey.

    \n
    • \n
" + "smithy.api#documentation": "

\n The IDs of subnets in which to launch the server EC2 instance.\n

\n

\n Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled.\n

\n

\n EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled.\n

\n

For more information about supported Amazon EC2 platforms, see\n Supported Platforms.

" } }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.opsworkscm#Boolean", + "BackupId": { + "target": "com.amazonaws.opsworkscm#BackupId", "traits": { - "smithy.api#documentation": "

\n Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.\n

" + "smithy.api#documentation": "

\n If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.\n

" } }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#KeyPair", + "Tags": { + "target": "com.amazonaws.opsworkscm#TagList", "traits": { - "smithy.api#documentation": "

\n The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.\n

" + "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.

\n
    \n
  • \n

    The key cannot be empty.

    \n
    • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @\n

    \n
    • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @\n

    \n
    • \n
  • \n

    Leading and trailing white spaces are trimmed from both the key and value.

    \n
    • \n
  • \n

    A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.

    \n
    • \n
" } }, - "CustomDomain": { - "target": "com.amazonaws.opsworkscm#CustomDomain", + "Engine": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom \n domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the \n generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate \n and CustomPrivateKey.

" + "smithy.api#documentation": "

\n The configuration management engine to use. Valid values include ChefAutomate and Puppet.\n

", + "smithy.api#required": {} } }, - "EngineModel": { - "target": "com.amazonaws.opsworkscm#String", + "CustomDomain": { + "target": "com.amazonaws.opsworkscm#CustomDomain", "traits": { - "smithy.api#documentation": "

\n The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" + "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom \n domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the \n generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate \n and CustomPrivateKey.

" } }, - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", + "EngineAttributes": { + "target": "com.amazonaws.opsworkscm#EngineAttributes", "traits": { - "smithy.api#documentation": "

\n Enable or disable scheduled backups. Valid values are true or false. The default value is true.\n

" + "smithy.api#documentation": "

Optional engine attributes on a specified server.\n

\n

\n Attributes accepted in a Chef createServer request:\n

\n
    \n
  • \n

    \n CHEF_AUTOMATE_PIVOTAL_KEY: A\n base64-encoded RSA public key. The corresponding private key is required to\n access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is\n generated and returned in the response.\n

    \n
    • \n
  • \n

    \n CHEF_AUTOMATE_ADMIN_PASSWORD:\n The password for the administrative user in the Chef Automate web-based dashboard. The\n password length is a minimum of eight characters, and a maximum of 32. The\n password can contain letters, numbers, and special characters\n (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper\n case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is\n generated and returned in the response.

    \n
    • \n
\n

\n Attributes accepted in a Puppet createServer request:\n

\n
    \n
  • \n

    \n PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.

    \n
    • \n
  • \n

    \n PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository \n (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.

    \n
    • \n
  • \n

    \n PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add \n PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

    \n
    • \n
" } } } @@ -775,6 +775,12 @@ "com.amazonaws.opsworkscm#DescribeBackupsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.opsworkscm#MaxResults", + "traits": { + "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" + } + }, "BackupId": { "target": "com.amazonaws.opsworkscm#BackupId", "traits": { @@ -792,29 +798,23 @@ "traits": { "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" - } } } }, "com.amazonaws.opsworkscm#DescribeBackupsResponse": { "type": "structure", "members": { - "Backups": { - "target": "com.amazonaws.opsworkscm#Backups", - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeBackups request.\n

" - } - }, "NextToken": { "target": "com.amazonaws.opsworkscm#String", "traits": { "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" } + }, + "Backups": { + "target": "com.amazonaws.opsworkscm#Backups", + "traits": { + "smithy.api#documentation": "

Contains the response to a DescribeBackups request.\n

" + } } } }, @@ -911,17 +911,17 @@ "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusRequest": { "type": "structure", "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", + "NodeAssociationStatusToken": { + "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", "traits": { - "smithy.api#documentation": "

The name of the server from which to disassociate the node.\n

", + "smithy.api#documentation": "

The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.\n

", "smithy.api#required": {} } }, - "NodeAssociationStatusToken": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", "traits": { - "smithy.api#documentation": "

The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.\n

", + "smithy.api#documentation": "

The name of the server from which to disassociate the node.\n

", "smithy.api#required": {} } } @@ -930,17 +930,17 @@ "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusResponse": { "type": "structure", "members": { - "NodeAssociationStatus": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatus", - "traits": { - "smithy.api#documentation": "

The status of the association or disassociation request.\n

\n

\n Possible values:\n

\n
    \n
  • \n

    \n SUCCESS: The association or disassociation succeeded.\n

    \n
    • \n
  • \n

    \n FAILED: The association or disassociation failed.\n

    \n
    • \n
  • \n

    \n IN_PROGRESS: The association or disassociation is still in progress.\n

    \n
    • \n
" - } - }, "EngineAttributes": { "target": "com.amazonaws.opsworkscm#EngineAttributes", "traits": { "smithy.api#documentation": "

Attributes specific to the node association. \n In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).\n

" } + }, + "NodeAssociationStatus": { + "target": "com.amazonaws.opsworkscm#NodeAssociationStatus", + "traits": { + "smithy.api#documentation": "

The status of the association or disassociation request.\n

\n

\n Possible values:\n

\n
    \n
  • \n

    \n SUCCESS: The association or disassociation succeeded.\n

    \n
    • \n
  • \n

    \n FAILED: The association or disassociation failed.\n

    \n
    • \n
  • \n

    \n IN_PROGRESS: The association or disassociation is still in progress.\n

    \n
    • \n
" + } } } }, @@ -976,12 +976,6 @@ "com.amazonaws.opsworkscm#DescribeServersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" - } - }, "ServerName": { "target": "com.amazonaws.opsworkscm#ServerName", "traits": { @@ -993,6 +987,12 @@ "traits": { "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" } + }, + "NextToken": { + "target": "com.amazonaws.opsworkscm#NextToken", + "traits": { + "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" + } } } }, @@ -1145,17 +1145,17 @@ "com.amazonaws.opsworkscm#ExportServerEngineAttributeRequest": { "type": "structure", "members": { - "ExportAttributeName": { - "target": "com.amazonaws.opsworkscm#String", + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", "traits": { - "smithy.api#documentation": "

The name of the export attribute. Currently, the supported export attribute is Userdata. \n This exports a user data script that includes parameters and values provided in the InputAttributes list.

", + "smithy.api#documentation": "

The name of the server from which you are exporting the attribute.

", "smithy.api#required": {} } }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", + "ExportAttributeName": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The name of the server from which you are exporting the attribute.

", + "smithy.api#documentation": "

The name of the export attribute. Currently, the supported export attribute is Userdata. \n This exports a user data script that includes parameters and values provided in the InputAttributes list.

", "smithy.api#required": {} } }, @@ -1170,17 +1170,17 @@ "com.amazonaws.opsworkscm#ExportServerEngineAttributeResponse": { "type": "structure", "members": { - "EngineAttribute": { - "target": "com.amazonaws.opsworkscm#EngineAttribute", - "traits": { - "smithy.api#documentation": "

The requested engine attribute pair with attribute name and value.

" - } - }, "ServerName": { "target": "com.amazonaws.opsworkscm#ServerName", "traits": { "smithy.api#documentation": "

The server name used in the request.

" } + }, + "EngineAttribute": { + "target": "com.amazonaws.opsworkscm#EngineAttribute", + "traits": { + "smithy.api#documentation": "

The requested engine attribute pair with attribute name and value.

" + } } } }, @@ -1284,18 +1284,18 @@ "com.amazonaws.opsworkscm#ListTagsForResourceRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call ListTagsForResource again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.

" - } - }, "MaxResults": { "target": "com.amazonaws.opsworkscm#MaxResults", "traits": { "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds\n this maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" } }, + "NextToken": { + "target": "com.amazonaws.opsworkscm#NextToken", + "traits": { + "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call ListTagsForResource again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.

" + } + }, "ResourceArn": { "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", "traits": { @@ -1533,13 +1533,6 @@ "com.amazonaws.opsworkscm#RestoreServerRequest": { "type": "structure", "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server that you want to restore.\n

", - "smithy.api#required": {} - } - }, "BackupId": { "target": "com.amazonaws.opsworkscm#BackupId", "traits": { @@ -1558,6 +1551,13 @@ "traits": { "smithy.api#documentation": "

The name of the key pair to set on the new EC2 instance. This can be helpful\n if the administrator no longer has the SSH key.\n

" } + }, + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", + "traits": { + "smithy.api#documentation": "

The name of the server that you want to restore.\n

", + "smithy.api#required": {} + } } } }, @@ -1568,46 +1568,58 @@ "com.amazonaws.opsworkscm#Server": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.opsworkscm#String", + "MaintenanceStatus": { + "target": "com.amazonaws.opsworkscm#MaintenanceStatus", "traits": { - "smithy.api#documentation": "

\n A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.\n

" + "smithy.api#documentation": "

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.\n

" } }, - "EngineModel": { + "CustomDomain": { + "target": "com.amazonaws.opsworkscm#CustomDomain", + "traits": { + "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

" + } + }, + "Engine": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" + "smithy.api#documentation": "

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.\n

" } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", + "BackupRetentionCount": { + "target": "com.amazonaws.opsworkscm#Integer", "traits": { - "smithy.api#documentation": "

The preferred maintenance period specified for the server.\n

" + "smithy.api#documentation": "

The number of automated backups to keep.\n

" } }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", + "SecurityGroupIds": { + "target": "com.amazonaws.opsworkscm#Strings", "traits": { - "smithy.api#documentation": "

The response of a createServer() request returns the master\n credential to access the server in EngineAttributes. These\n credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().\n

\n

\n Attributes returned in a createServer response for Chef\n

\n
    \n
  • \n

    \n CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is\n generated by AWS OpsWorks for Chef Automate. This private key is required to access\n the Chef API.

    \n
    • \n
  • \n

    \n CHEF_STARTER_KIT: A base64-encoded ZIP file.\n The ZIP file contains a Chef starter kit, which includes a README, a\n configuration file, and the required RSA private key. Save this file, unzip it,\n and then change to the directory where you've unzipped the file contents.\n From this directory, you can run Knife commands.

    \n
    • \n
\n

\n Attributes returned in a createServer response for Puppet\n

\n
    \n
  • \n

    \n PUPPET_STARTER_KIT: A base64-encoded ZIP file.\n The ZIP file contains a Puppet starter kit, including a README and a\n required private key. Save this file, unzip it,\n and then change to the directory where you've unzipped the file contents.

    \n
    • \n
  • \n

    \n PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

    \n
    • \n
" + "smithy.api#documentation": "

\n The security group IDs for the server, as specified in the CloudFormation stack.\n These might not be the same security groups that are shown in the EC2 console.\n

" } }, - "ServerName": { + "Endpoint": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The name of the server.\n

" + "smithy.api#documentation": "

\n A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.\n

" } }, - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", + "InstanceProfileArn": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.\n

" + "smithy.api#documentation": "

The instance profile ARN of the server.\n

" } }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#String", + "SubnetIds": { + "target": "com.amazonaws.opsworkscm#Strings", "traits": { - "smithy.api#documentation": "

The service role ARN used to create the server.\n

" + "smithy.api#documentation": "

\n The subnet IDs specified in a CreateServer request.\n

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", + "traits": { + "smithy.api#documentation": "

The preferred backup period specified for the server.\n

" } }, "CreatedAt": { @@ -1616,58 +1628,52 @@ "smithy.api#documentation": "

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z\n

" } }, - "KeyPair": { + "EngineModel": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The key pair associated with the server.\n

" + "smithy.api#documentation": "

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" } }, - "InstanceProfileArn": { + "KeyPair": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The instance profile ARN of the server.\n

" - } - }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

Associate a public IP address with a server that you are launching.\n

" + "smithy.api#documentation": "

The key pair associated with the server.\n

" } }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", + "InstanceType": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

\n The subnet IDs specified in a CreateServer request.\n

" + "smithy.api#documentation": "

\n The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.\n

" } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", + "DisableAutomatedBackup": { + "target": "com.amazonaws.opsworkscm#Boolean", "traits": { - "smithy.api#documentation": "

The preferred backup period specified for the server.\n

" + "smithy.api#documentation": "

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.\n

" } }, - "StatusReason": { - "target": "com.amazonaws.opsworkscm#String", + "AssociatePublicIpAddress": { + "target": "com.amazonaws.opsworkscm#Boolean", "traits": { - "smithy.api#documentation": "

\n Depending on the server status, this field has either a human-readable\n message (such as a create or backup error), or an escaped block of JSON (used for health check results).\n

" + "smithy.api#documentation": "

Associate a public IP address with a server that you are launching.\n

" } }, - "Engine": { + "ServiceRoleArn": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.\n

" + "smithy.api#documentation": "

The service role ARN used to create the server.\n

" } }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#Integer", + "EngineAttributes": { + "target": "com.amazonaws.opsworkscm#EngineAttributes", "traits": { - "smithy.api#documentation": "

The number of automated backups to keep.\n

" + "smithy.api#documentation": "

The response of a createServer() request returns the master\n credential to access the server in EngineAttributes. These\n credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().\n

\n

\n Attributes returned in a createServer response for Chef\n

\n
    \n
  • \n

    \n CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is\n generated by AWS OpsWorks for Chef Automate. This private key is required to access\n the Chef API.

    \n
    • \n
  • \n

    \n CHEF_STARTER_KIT: A base64-encoded ZIP file.\n The ZIP file contains a Chef starter kit, which includes a README, a\n configuration file, and the required RSA private key. Save this file, unzip it,\n and then change to the directory where you've unzipped the file contents.\n From this directory, you can run Knife commands.

    \n
    • \n
\n

\n Attributes returned in a createServer response for Puppet\n

\n
    \n
  • \n

    \n PUPPET_STARTER_KIT: A base64-encoded ZIP file.\n The ZIP file contains a Puppet starter kit, including a README and a\n required private key. Save this file, unzip it,\n and then change to the directory where you've unzipped the file contents.

    \n
    • \n
  • \n

    \n PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

    \n
    • \n
" } }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", "traits": { - "smithy.api#documentation": "

\n The security group IDs for the server, as specified in the CloudFormation stack.\n These might not be the same security groups that are shown in the EC2 console.\n

" + "smithy.api#documentation": "

The preferred maintenance period specified for the server.\n

" } }, "EngineVersion": { @@ -1676,10 +1682,10 @@ "smithy.api#documentation": "

The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.\n

" } }, - "CustomDomain": { - "target": "com.amazonaws.opsworkscm#CustomDomain", + "ServerName": { + "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

" + "smithy.api#documentation": "

The name of the server.\n

" } }, "ServerArn": { @@ -1688,6 +1694,12 @@ "smithy.api#documentation": "

The ARN of the server.\n

" } }, + "StatusReason": { + "target": "com.amazonaws.opsworkscm#String", + "traits": { + "smithy.api#documentation": "

\n Depending on the server status, this field has either a human-readable\n message (such as a create or backup error), or an escaped block of JSON (used for health check results).\n

" + } + }, "CloudFormationStackArn": { "target": "com.amazonaws.opsworkscm#String", "traits": { @@ -1699,18 +1711,6 @@ "traits": { "smithy.api#documentation": "

\n The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server,\n as well as the server's health state.\n

" } - }, - "MaintenanceStatus": { - "target": "com.amazonaws.opsworkscm#MaintenanceStatus", - "traits": { - "smithy.api#documentation": "

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.\n

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.\n

" - } } }, "traits": { @@ -1720,28 +1720,28 @@ "com.amazonaws.opsworkscm#ServerEvent": { "type": "structure", "members": { - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the event occurred.\n

" - } - }, "Message": { "target": "com.amazonaws.opsworkscm#String", "traits": { "smithy.api#documentation": "

A human-readable informational or status message.

" } }, - "LogUrl": { + "ServerName": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The Amazon S3 URL of the event's log file.

" + "smithy.api#documentation": "

The name of the server on or for which the event occurred.\n

" } }, - "ServerName": { + "CreatedAt": { + "target": "com.amazonaws.opsworkscm#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the event occurred.\n

" + } + }, + "LogUrl": { "target": "com.amazonaws.opsworkscm#String", "traits": { - "smithy.api#documentation": "

The name of the server on or for which the event occurred.\n

" + "smithy.api#documentation": "

The Amazon S3 URL of the event's log file.

" } } }, @@ -1866,18 +1866,18 @@ "com.amazonaws.opsworkscm#StartMaintenanceRequest": { "type": "structure", "members": { - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Engine attributes that are specific to the server on which you want to run maintenance.

\n

\n Attributes accepted in a StartMaintenance request for Chef\n

\n " - } - }, "ServerName": { "target": "com.amazonaws.opsworkscm#ServerName", "traits": { "smithy.api#documentation": "

The name of the server on which to run maintenance.\n

", "smithy.api#required": {} } + }, + "EngineAttributes": { + "target": "com.amazonaws.opsworkscm#EngineAttributes", + "traits": { + "smithy.api#documentation": "

Engine attributes that are specific to the server on which you want to run maintenance.

\n

\n Attributes accepted in a StartMaintenance request for Chef\n

\n " + } } } }, @@ -1911,17 +1911,17 @@ "com.amazonaws.opsworkscm#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.opsworkscm#TagKey", + "Value": { + "target": "com.amazonaws.opsworkscm#TagValue", "traits": { - "smithy.api#documentation": "

A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, \n and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", + "smithy.api#documentation": "

An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, \n and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.opsworkscm#TagValue", + "Key": { + "target": "com.amazonaws.opsworkscm#TagKey", "traits": { - "smithy.api#documentation": "

An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, \n and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", + "smithy.api#documentation": "

A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, \n and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", "smithy.api#required": {} } } @@ -2060,17 +2060,17 @@ "com.amazonaws.opsworkscm#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.opsworkscm#TagKeyList", + "ResourceArn": { + "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", "traits": { - "smithy.api#documentation": "

The keys of tags that you want to remove.

", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", + "TagKeys": { + "target": "com.amazonaws.opsworkscm#TagKeyList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", + "smithy.api#documentation": "

The keys of tags that you want to remove.

", "smithy.api#required": {} } } @@ -2129,11 +2129,10 @@ "com.amazonaws.opsworkscm#UpdateServerEngineAttributesRequest": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.opsworkscm#AttributeName", + "AttributeValue": { + "target": "com.amazonaws.opsworkscm#AttributeValue", "traits": { - "smithy.api#documentation": "

The name of the engine attribute to update.\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The value to set for the attribute.\n

" } }, "ServerName": { @@ -2143,10 +2142,11 @@ "smithy.api#required": {} } }, - "AttributeValue": { - "target": "com.amazonaws.opsworkscm#AttributeValue", + "AttributeName": { + "target": "com.amazonaws.opsworkscm#AttributeName", "traits": { - "smithy.api#documentation": "

The value to set for the attribute.\n

" + "smithy.api#documentation": "

The name of the engine attribute to update.\n

", + "smithy.api#required": {} } } } @@ -2165,16 +2165,6 @@ "com.amazonaws.opsworkscm#UpdateServerRequest": { "type": "structure", "members": { - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition" - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server to update.\n

", - "smithy.api#required": {} - } - }, "BackupRetentionCount": { "target": "com.amazonaws.opsworkscm#Integer", "traits": { @@ -2184,11 +2174,21 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.opsworkscm#TimeWindowDefinition" }, + "PreferredBackupWindow": { + "target": "com.amazonaws.opsworkscm#TimeWindowDefinition" + }, "DisableAutomatedBackup": { "target": "com.amazonaws.opsworkscm#Boolean", "traits": { "smithy.api#documentation": "

Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.\n

" } + }, + "ServerName": { + "target": "com.amazonaws.opsworkscm#ServerName", + "traits": { + "smithy.api#documentation": "

The name of the server to update.\n

", + "smithy.api#required": {} + } } } }, diff --git a/codegen/sdk-codegen/aws-models/organizations.2016-11-28.json b/codegen/sdk-codegen/aws-models/organizations.2016-11-28.json index ef144fe1eee8..0d164cfd6ac3 100644 --- a/codegen/sdk-codegen/aws-models/organizations.2016-11-28.json +++ b/codegen/sdk-codegen/aws-models/organizations.2016-11-28.json @@ -205,7 +205,7 @@ "sdkId": "Organizations", "arnNamespace": "organizations", "cloudFormationName": "Organizations", - "cloudTrailEventSource": "v20161128.awsorganizations.amazon.com" + "cloudTrailEventSource": "organizations.amazonaws.com" }, "aws.auth#sigv4": { "name": "organizations" @@ -262,7 +262,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a response to the originator of a handshake agreeing to the action proposed by\n the handshake request.

\n

This operation can be called only by the following principals when they also have the\n relevant IAM permissions:

\n
    \n
  • \n

    \n Invitation to join or Approve all features request handshakes: only a principal from\n the member account.

    \n

    The user who calls the API for an invitation to join must have the\n organizations:AcceptHandshake permission. If you enabled all\n features in the organization, the user must also have the\n iam:CreateServiceLinkedRole permission so that AWS Organizations can\n create the required service-linked role named AWSServiceRoleForOrganizations. For\n more information, see AWS Organizations and Service-Linked Roles in the\n AWS Organizations User Guide.

    \n
    • \n
  • \n

    \n Enable all features final confirmation\n handshake: only a principal from the master account.

    \n

    For more information about invitations, see Inviting an AWS Account to Join Your Organization in the\n AWS Organizations User Guide. For more information about requests to\n enable all features in the organization, see Enabling All Features in Your Organization in\n the AWS Organizations User Guide.\n

    \n
    • \n
\n

After you accept a handshake, it continues to appear in the results of relevant APIs\n for only 30 days. After that, it's deleted.

" + "smithy.api#documentation": "

Sends a response to the originator of a handshake agreeing to the action proposed by\n the handshake request.

\n

This operation can be called only by the following principals when they also have the\n relevant IAM permissions:

\n
    \n
  • \n

    \n Invitation to join or Approve all features request handshakes: only a principal from\n the member account.

    \n

    The user who calls the API for an invitation to join must have the\n organizations:AcceptHandshake permission. If you enabled all\n features in the organization, the user must also have the\n iam:CreateServiceLinkedRole permission so that AWS Organizations can\n create the required service-linked role named AWSServiceRoleForOrganizations. For\n more information, see AWS Organizations and Service-Linked Roles in the\n AWS Organizations User Guide.

    \n
    • \n
  • \n

    \n Enable all features final confirmation\n handshake: only a principal from the master account.

    \n

    For more information about invitations, see Inviting an AWS Account to Join Your Organization in the\n AWS Organizations User Guide. For more information about requests to\n enable all features in the organization, see Enabling All Features in Your Organization in\n the AWS Organizations User Guide.\n

    \n
    • \n
\n

After you accept a handshake, it continues to appear in the results of relevant APIs\n for only 30 days. After that, it's deleted.

" } }, "com.amazonaws.organizations#AcceptHandshakeRequest": { @@ -304,11 +304,11 @@ "com.amazonaws.organizations#AccessDeniedForDependencyException": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.organizations#AccessDeniedForDependencyExceptionReason" - }, "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" + }, + "Reason": { + "target": "com.amazonaws.organizations#AccessDeniedForDependencyExceptionReason" } }, "traits": { @@ -331,16 +331,16 @@ "com.amazonaws.organizations#Account": { "type": "structure", "members": { - "JoinedMethod": { - "target": "com.amazonaws.organizations#AccountJoinedMethod", + "Id": { + "target": "com.amazonaws.organizations#AccountId", "traits": { - "smithy.api#documentation": "

The method by which the account joined the organization.

" + "smithy.api#documentation": "

The unique identifier (ID) of the account.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

" } }, - "Status": { - "target": "com.amazonaws.organizations#AccountStatus", + "Arn": { + "target": "com.amazonaws.organizations#AccountArn", "traits": { - "smithy.api#documentation": "

The status of the account in the organization.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" } }, "JoinedTimestamp": { @@ -349,10 +349,10 @@ "smithy.api#documentation": "

The date the account became a part of the organization.

" } }, - "Arn": { - "target": "com.amazonaws.organizations#AccountArn", + "Email": { + "target": "com.amazonaws.organizations#Email", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" + "smithy.api#documentation": "

The email address associated with the AWS account.

\n

The regex pattern for this parameter is a string of characters that represents a\n standard internet email address.

" } }, "Name": { @@ -361,16 +361,16 @@ "smithy.api#documentation": "

The friendly name of the account.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, - "Id": { - "target": "com.amazonaws.organizations#AccountId", + "Status": { + "target": "com.amazonaws.organizations#AccountStatus", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the account.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

" + "smithy.api#documentation": "

The status of the account in the organization.

" } }, - "Email": { - "target": "com.amazonaws.organizations#Email", + "JoinedMethod": { + "target": "com.amazonaws.organizations#AccountJoinedMethod", "traits": { - "smithy.api#documentation": "

The email address associated with the AWS account.

\n

The regex pattern for this parameter is a string of characters that represents a\n standard internet email address.

" + "smithy.api#documentation": "

The method by which the account joined the organization.

" } } }, @@ -576,7 +576,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n AWS Organizations User Guide for information about each policy type:

\n \n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n AWS Organizations User Guide for information about each policy type:

\n \n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#AttachPolicyRequest": { @@ -636,7 +636,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a handshake. Canceling a handshake sets the handshake state to\n CANCELED.

\n

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient\n can no longer respond to that handshake.

\n

After you cancel a handshake, it continues to appear in the results of relevant APIs\n for only 30 days. After that, it's deleted.

" + "smithy.api#documentation": "

Cancels a handshake. Canceling a handshake sets the handshake state to\n CANCELED.

\n

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient\n can no longer respond to that handshake.

\n

After you cancel a handshake, it continues to appear in the results of relevant APIs\n for only 30 days. After that, it's deleted.

" } }, "com.amazonaws.organizations#CancelHandshakeRequest": { @@ -665,16 +665,16 @@ "com.amazonaws.organizations#Child": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.organizations#ChildType", + "Id": { + "target": "com.amazonaws.organizations#ChildId", "traits": { - "smithy.api#documentation": "

The type of this child entity.

" + "smithy.api#documentation": "

The unique identifier (ID) of this child entity.

\n

The regex pattern for a child ID string requires one of the \n following:

\n
    \n
  • \n

    \n Account - A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 \n lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
" } }, - "Id": { - "target": "com.amazonaws.organizations#ChildId", + "Type": { + "target": "com.amazonaws.organizations#ChildType", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of this child entity.

\n

The regex pattern for a child ID string requires one of the \n following:

\n
    \n
  • \n

    Account: A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    Organizational unit (OU): A string that begins with \"ou-\" followed by from 4 to 32 \n lower-case letters or digits (the ID of the root that contains the OU). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lower-case letters or digits.

    \n
    • \n
" + "smithy.api#documentation": "

The type of this child entity.

" } } }, @@ -742,15 +742,15 @@ "com.amazonaws.organizations#ConstraintViolationException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.organizations#ExceptionMessage" - }, "Reason": { "target": "com.amazonaws.organizations#ConstraintViolationExceptionReason" + }, + "Message": { + "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { - "smithy.api#documentation": "

Performing this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

\n \n
    \n
  • \n

    ACCOUNT_CANNOT_LEAVE_ORGANIZAION: You attempted to remove the master account\n from the organization. You can't remove the master account. Instead, after you\n remove all member accounts, delete the organization itself.

    \n
    • \n
  • \n

    ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the\n organization that doesn't yet have enough information to exist as a standalone\n account. This account requires you to first agree to the AWS Customer\n Agreement. Follow the steps at Removing a member account from your organizationin the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an\n account from the organization that doesn't yet have enough information to exist\n as a standalone account. This account requires you to first complete phone\n verification. Follow the steps at Removing a member account from your organization in the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can create in one day.

    \n
    • \n
  • \n

    ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. If you need more accounts, contact AWS Support to request an increase\n in your limit.

    \n

    Or the number of invitations that you tried to send would cause you to exceed\n the limit of accounts in your organization. Send fewer invitations or contact\n AWS Support to request an increase in the number of accounts.

    \n \n

    Deleted and closed accounts still count toward your limit.

    \n     \n \n

    If you get this exception when running a command immediately after\n creating the organization, wait one hour and try again. After an hour, if\n the command continues to fail with this error, contact AWS Support.

    \n     \n
    • \n
  • \n

    CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register\n the master account of the organization as a delegated administrator for an AWS\n service integrated with Organizations. You can designate only a member account\n as a delegated administrator.

    \n
    • \n
  • \n

    CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an\n account that is registered as a delegated administrator for a service integrated\n with your organization. To complete this operation, you must first deregister\n this account as a delegated administrator.

    \n
    • \n
  • \n

    CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an\n organization in the specified region, you must enable all features mode.

    \n
    • \n
  • \n

    DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an\n AWS account as a delegated administrator for an AWS service that already has a\n delegated administrator. To complete this operation, you must first deregister\n any existing delegated administrators for this service.

    \n
    • \n
  • \n

    EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for\n a limited period of time. You must resubmit the request and generate a new\n verfication code.

    \n
    • \n
  • \n

    HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in\n this organization, you first must migrate the organization's master account to\n the marketplace that corresponds to the master account's address. For example,\n accounts with India addresses must be associated with the AISPL marketplace. All\n accounts in an organization must be associated with the same marketplace.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the AWS Regions in\n China. To create an organization, the master must have an valid business license. \n For more information, contact customer support.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must\n first provide a valid contact address and phone number for the master account.\n Then try the operation again.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master\n account must have an associated account in the AWS GovCloud (US-West) Region.\n For more information, see AWS Organizations in\n the \n AWS GovCloud User Guide.\n

    \n
    • \n
  • \n

    MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with\n this master account, you first must associate a valid payment instrument, such\n as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet\n been provided in the AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to\n register more delegated administrators than allowed for the service principal.\n

    \n
    • \n
  • \n

    MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number\n of policies of a certain type that can be attached to an entity at one\n time.

    \n
    • \n
  • \n

    MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this\n resource.

    \n
    • \n
  • \n

    MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with\n this member account, you first must associate a valid payment instrument, such\n as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet\n been provided in the AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy\n from an entity that would cause the entity to have fewer than the minimum number\n of policies of a certain type required.

    \n
    • \n
  • \n

    ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation\n that requires the organization to be configured to support all features. An\n organization that supports only consolidated billing features can't perform this\n operation.

    \n
    • \n
  • \n

    OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many\n levels deep.

    \n
    • \n
  • \n

    OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you\n can have in an organization.

    \n
    • \n
  • \n

    POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger\n than the maximum size.

    \n
    • \n
  • \n

    POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies\n that you can have in an organization.

    \n
    • \n
  • \n

    TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags\n that are not compliant with the tag policy requirements for this account.

    \n
    • \n
", + "smithy.api#documentation": "

Performing this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

\n \n
    \n
  • \n

    ACCOUNT_CANNOT_LEAVE_ORGANIZAION: You attempted to remove the\n master account from the organization. You can't remove the master account.\n Instead, after you remove all member accounts, delete the organization\n itself.

    \n
    • \n
  • \n

    ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the\n organization that doesn't yet have enough information to exist as a standalone\n account. This account requires you to first agree to the AWS Customer\n Agreement. Follow the steps at Removing a member account from your organizationin the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an\n account from the organization that doesn't yet have enough information to exist\n as a standalone account. This account requires you to first complete phone\n verification. Follow the steps at Removing a member account from your organization in the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can create in one day.

    \n
    • \n
  • \n

    ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. If you need more accounts, contact AWS Support to request an increase\n in your limit.

    \n

    Or the number of invitations that you tried to send would cause you to exceed\n the limit of accounts in your organization. Send fewer invitations or contact\n AWS Support to request an increase in the number of accounts.

    \n \n

    Deleted and closed accounts still count toward your limit.

    \n     \n \n

    If you get this exception when running a command immediately after\n creating the organization, wait one hour and try again. After an hour, if\n the command continues to fail with this error, contact AWS Support.

    \n     \n
    • \n
  • \n

    CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register\n the master account of the organization as a delegated administrator for an\n AWS service integrated with Organizations. You can designate only a member\n account as a delegated administrator.

    \n
    • \n
  • \n

    CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an\n account that is registered as a delegated administrator for a service integrated\n with your organization. To complete this operation, you must first deregister\n this account as a delegated administrator.

    \n
    • \n
  • \n

    CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an\n organization in the specified region, you must enable all features mode.

    \n
    • \n
  • \n

    DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an\n AWS account as a delegated administrator for an AWS service that already has a\n delegated administrator. To complete this operation, you must first deregister\n any existing delegated administrators for this service.

    \n
    • \n
  • \n

    EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for\n a limited period of time. You must resubmit the request and generate a new\n verfication code.

    \n
    • \n
  • \n

    HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in\n this organization, you first must migrate the organization's master account\n to the marketplace that corresponds to the master account's address. For\n example, accounts with India addresses must be associated with the AISPL\n marketplace. All accounts in an organization must be associated with the same\n marketplace.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the AWS Regions in\n China. To create an organization, the master must have an valid business\n license. For more information, contact customer support.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must\n first provide a valid contact address and phone number for the\n master account. Then try the operation again.

    \n
    • \n
  • \n

    MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the\n master account must have an associated account in the AWS GovCloud\n (US-West) Region. For more information, see AWS Organizations in\n the \n AWS GovCloud User Guide.\n

    \n
    • \n
  • \n

    MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with\n this master account, you first must associate a valid payment instrument,\n such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet\n been provided in the AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to\n register more delegated administrators than allowed for the service principal.\n

    \n
    • \n
  • \n

    MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number\n of policies of a certain type that can be attached to an entity at one\n time.

    \n
    • \n
  • \n

    MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this\n resource.

    \n
    • \n
  • \n

    MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with\n this member account, you first must associate a valid payment instrument, such\n as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet\n been provided in the AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy\n from an entity that would cause the entity to have fewer than the minimum number\n of policies of a certain type required.

    \n
    • \n
  • \n

    ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation\n that requires the organization to be configured to support all features. An\n organization that supports only consolidated billing features can't perform this\n operation.

    \n
    • \n
  • \n

    OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many\n levels deep.

    \n
    • \n
  • \n

    OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you\n can have in an organization.

    \n
    • \n
  • \n

    POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger\n than the maximum size.

    \n
    • \n
  • \n

    POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies\n that you can have in an organization.

    \n
    • \n
  • \n

    TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags\n that are not compliant with the tag policy requirements for this account.

    \n
    • \n
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -912,7 +912,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AWS account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that AWS performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:

\n
    \n
  • \n

    Use the OperationId response element from this operation to\n provide as a parameter to the DescribeCreateAccountStatus\n operation.

    \n
    • \n
  • \n

    Check the AWS CloudTrail log for the CreateAccountResult event. For\n information on using AWS CloudTrail with AWS Organizations, see Monitoring the Activity in Your\n Organization in the AWS Organizations User Guide.\n

    \n
    • \n
\n

\n

The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, AWS Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the\n AWS Organizations User Guide.

\n

AWS Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n master account administrator permissions in the new member account. Principals in the\n master account can assume the role. AWS Organizations clones the company name and address\n information for the new account from the organization's master account.

\n

This operation can be called only from the organization's master account.

\n

For more information about creating accounts, see Creating\n an AWS Account in Your Organization in the\n AWS Organizations User Guide.\n

\n \n
    \n
  • \n

    When you create an account in an organization using the AWS Organizations console,\n API, or CLI commands, the information required for the account to operate as\n a standalone account, such as a payment method and signing the end user\n license agreement (EULA) is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. Follow the steps\n at To leave an organization as a member account in the\n AWS Organizations User Guide.

    \n
    • \n
  • \n

    If you get an exception that indicates that you exceeded your account\n limits for the organization, contact AWS Support.

    \n
    • \n
  • \n

    If you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact AWS\n Support.

    \n
    • \n
  • \n

    Using CreateAccount to create multiple temporary accounts\n isn't recommended. You can only close an account from the Billing and Cost\n Management Console, and you must be signed in as the root user. For\n information on the requirements and process for closing an account, see\n Closing an\n AWS Account in the\n AWS Organizations User Guide.

    \n
    • \n
\n \n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n Access to Your Billing Information and Tools.

\n " + "smithy.api#documentation": "

Creates an AWS account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that AWS performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:

\n
    \n
  • \n

    Use the Id member of the CreateAccountStatus\n response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

    \n
    • \n
  • \n

    Check the AWS CloudTrail log for the CreateAccountResult event. For\n information on using AWS CloudTrail with AWS Organizations, see Monitoring the Activity in Your\n Organization in the AWS Organizations User Guide.\n

    \n
    • \n
\n

The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, AWS Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the\n AWS Organizations User Guide.

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

AWS Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n master account administrator permissions in the new member account. Principals in the\n master account can assume the role. AWS Organizations clones the company name and address\n information for the new account from the organization's master account.

\n

This operation can be called only from the organization's master account.

\n

For more information about creating accounts, see Creating\n an AWS Account in Your Organization in the\n AWS Organizations User Guide.\n

\n \n
    \n
  • \n

    When you create an account in an organization using the AWS Organizations console,\n API, or CLI commands, the information required for the account to operate as\n a standalone account, such as a payment method and signing the end user\n license agreement (EULA) is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. Follow the steps\n at To leave an organization as a member account in the\n AWS Organizations User Guide.

    \n
    • \n
  • \n

    If you get an exception that indicates that you exceeded your account\n limits for the organization, contact AWS Support.

    \n
    • \n
  • \n

    If you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact AWS\n Support.

    \n
    • \n
  • \n

    Using CreateAccount to create multiple temporary accounts\n isn't recommended. You can only close an account from the Billing and Cost\n Management Console, and you must be signed in as the root user. For\n information on the requirements and process for closing an account, see\n Closing an\n AWS Account in the\n AWS Organizations User Guide.

    \n
    • \n
\n \n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n Access to Your Billing Information and Tools.

\n " } }, "com.amazonaws.organizations#CreateAccountFailureReason": { @@ -946,6 +946,14 @@ { "value": "GOVCLOUD_ACCOUNT_ALREADY_EXISTS", "name": "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" + }, + { + "value": "MISSING_BUSINESS_VALIDATION", + "name": "MISSING_BUSINESS_VALIDATION" + }, + { + "value": "MISSING_PAYMENT_INSTRUMENT", + "name": "MISSING_PAYMENT_INSTRUMENT" } ] } @@ -953,12 +961,6 @@ "com.amazonaws.organizations#CreateAccountRequest": { "type": "structure", "members": { - "RoleName": { - "target": "com.amazonaws.organizations#RoleName", - "traits": { - "smithy.api#documentation": "

(Optional)

\n

The name of an IAM role that AWS Organizations automatically preconfigures in the new member\n account. This role trusts the master account, allowing users in the master account to\n assume the role, as permitted by the master account administrator. The role has\n administrator permissions in the new member account.

\n

If you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.

\n

For more information about how to use this role to access the member account, see the\n following links:

\n \n

The regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" - } - }, "IamUserAccessToBilling": { "target": "com.amazonaws.organizations#IAMUserAccessToBilling", "traits": { @@ -972,12 +974,24 @@ "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.organizations#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the newly created account. For each tag in\n the list, you must specify both a tag key and a value. You can set the value to an empty\n string, but you can't set it to null. For more information about tagging,\n see Tagging AWS\n Organizations resources in the AWS Organizations User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed number of tags for\n an account, then the entire request fails and the account is not created.

\n " + } + }, "AccountName": { "target": "com.amazonaws.organizations#AccountName", "traits": { "smithy.api#documentation": "

The friendly name of the member account.

", "smithy.api#required": {} } + }, + "RoleName": { + "target": "com.amazonaws.organizations#RoleName", + "traits": { + "smithy.api#documentation": "

(Optional)

\n

The name of an IAM role that AWS Organizations automatically preconfigures in the new member\n account. This role trusts the master account, allowing users in the master account\n to assume the role, as permitted by the master account administrator. The role has\n administrator permissions in the new member account.

\n

If you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.

\n

For more information about how to use this role to access the member account, see the\n following links:

\n \n

The regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" + } } } }, @@ -1030,16 +1044,10 @@ "com.amazonaws.organizations#CreateAccountStatus": { "type": "structure", "members": { - "AccountName": { - "target": "com.amazonaws.organizations#AccountName", - "traits": { - "smithy.api#documentation": "

The account name given to the account when it was created.

" - } - }, - "CompletedTimestamp": { - "target": "com.amazonaws.organizations#Timestamp", + "Id": { + "target": "com.amazonaws.organizations#CreateAccountRequestId", "traits": { - "smithy.api#documentation": "

The date and time that the account was created and the request completed.

" + "smithy.api#documentation": "

The unique identifier (ID) that references this request. You get this value from the\n response of the initial CreateAccount request to create the\n account.

\n

The regex pattern for a create account request ID string \n requires \"car-\" followed by from 8 to 32 lowercase letters or digits.

" } }, "AccountId": { @@ -1054,10 +1062,16 @@ "smithy.api#documentation": "

The date and time that the request was made for the account creation.

" } }, - "FailureReason": { - "target": "com.amazonaws.organizations#CreateAccountFailureReason", + "CompletedTimestamp": { + "target": "com.amazonaws.organizations#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the account was created and the request completed.

" + } + }, + "AccountName": { + "target": "com.amazonaws.organizations#AccountName", "traits": { - "smithy.api#documentation": "

If the request failed, a description of the reason for the failure.

\n
    \n
  • \n

    ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have\n reached the limit on the number of accounts in your organization.

    \n
    • \n
  • \n

    EMAIL_ALREADY_EXISTS: The account could not be created because another AWS\n account with that email address already exists.

    \n
    • \n
  • \n

    GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region\n could not be created because this Region already includes an account with that\n email address.

    \n
    • \n
  • \n

    INVALID_ADDRESS: The account could not be created because the address you\n provided is not valid.

    \n
    • \n
  • \n

    INVALID_EMAIL: The account could not be created because the email address you\n provided is not valid.

    \n
    • \n
  • \n

    INTERNAL_FAILURE: The account could not be created because of an internal\n failure. Try again later. If the problem persists, contact Customer\n Support.

    \n
    • \n
" + "smithy.api#documentation": "

The account name given to the account when it was created.

" } }, "GovCloudAccountId": { @@ -1066,16 +1080,16 @@ "smithy.api#documentation": "

If the account was created successfully, the unique identifier (ID) of the new account\n in the AWS GovCloud (US) Region.

" } }, - "State": { - "target": "com.amazonaws.organizations#CreateAccountState", + "FailureReason": { + "target": "com.amazonaws.organizations#CreateAccountFailureReason", "traits": { - "smithy.api#documentation": "

The status of the request.

" + "smithy.api#documentation": "

If the request failed, a description of the reason for the failure.

\n
    \n
  • \n

    ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have\n reached the limit on the number of accounts in your organization.

    \n
    • \n
  • \n

    CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same\n information.

    \n
    • \n
  • \n

    EMAIL_ALREADY_EXISTS: The account could not be created because another AWS\n account with that email address already exists.

    \n
    • \n
  • \n

    GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region\n could not be created because this Region already includes an account with that\n email address.

    \n
    • \n
  • \n

    INVALID_ADDRESS: The account could not be created because the address you\n provided is not valid.

    \n
    • \n
  • \n

    INVALID_EMAIL: The account could not be created because the email address you\n provided is not valid.

    \n
    • \n
  • \n

    INTERNAL_FAILURE: The account could not be created because of an internal\n failure. Try again later. If the problem persists, contact Customer\n Support.

    \n
    • \n
  • \n

    MISSING_BUSINESS_VALIDATION: The AWS account that owns your organization has\n not received Business Validation.

    \n
    • \n
  • \n

    MISSING_PAYMENT_INSTRUMENT: You must configure the master account with a\n valid payment method, such as a credit card.

    \n
    • \n
" } }, - "Id": { - "target": "com.amazonaws.organizations#CreateAccountRequestId", + "State": { + "target": "com.amazonaws.organizations#CreateAccountState", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) that references this request. You get this value from the\n response of the initial CreateAccount request to create the\n account.

\n

The regex pattern for a create account request ID string \n requires \"car-\" followed by from 8 to 32 lower-case letters or digits.

" + "smithy.api#documentation": "

The status of the request.

" } } }, @@ -1140,35 +1154,41 @@ } ], "traits": { - "smithy.api#documentation": "

This action is available if all of the following are true:

\n
    \n
  • \n

    You're authorized to create accounts in the AWS GovCloud (US) Region. For\n more information on the AWS GovCloud (US) Region, see the \n AWS GovCloud User Guide.\n

    \n
    • \n
  • \n

    You already have an account in the AWS GovCloud (US) Region that is\n associated with your master account in the commercial Region.

    \n
    • \n
  • \n

    You call this action from the master account of your organization in the\n commercial Region.

    \n
    • \n
  • \n

    You have the organizations:CreateGovCloudAccount permission.\n AWS Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the\n AWS Organizations User Guide.\n

    \n
    • \n
\n

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also\n do the following:

\n
    \n
  • \n

    Verify that AWS CloudTrail is enabled to store logs.

    \n
    • \n
  • \n

    Create an S3 bucket for AWS CloudTrail log storage.

    \n

    For more information, see Verifying AWS CloudTrail Is\n Enabled in the AWS GovCloud User Guide.\n

    \n
    • \n
\n

You call this action from the master account of your organization in the commercial\n Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the\n account is created, the master account of an organization in the AWS GovCloud (US)\n Region can invite it to that organization. For more information on inviting standalone\n accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the\n AWS GovCloud User Guide.\n

\n

Calling CreateGovCloudAccount is an asynchronous request that AWS\n performs in the background. Because CreateGovCloudAccount operates\n asynchronously, it can return a successful completion message even though account\n initialization might still be in progress. You might need to wait a few minutes before\n you can successfully access the account. To check the status of the request, do one of\n the following:

\n
    \n
  • \n

    Use the OperationId response element from this operation to\n provide as a parameter to the DescribeCreateAccountStatus\n operation.

    \n
    • \n
  • \n

    Check the AWS CloudTrail log for the CreateAccountResult event. For\n information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your\n Organization in the AWS Organizations User Guide.\n

    \n
    • \n
\n

\n

When you call the CreateGovCloudAccount action, you create two accounts:\n a standalone account in the AWS GovCloud (US) Region and an associated account in the\n commercial Region for billing and support purposes. The account in the commercial Region\n is automatically a member of the organization whose credentials made the request. Both\n accounts are associated with the same email address.

\n

A role is created in the new account in the commercial Region that allows the master\n account in the organization in the commercial Region to assume it. An AWS GovCloud\n (US) account is then created and associated with the commercial account that you just\n created. A role is created in the new AWS GovCloud (US) account that can be assumed by\n the AWS GovCloud (US) account that is associated with the master account of the\n commercial organization. For more information and to view a diagram that explains how\n account access works, see AWS Organizations in the AWS GovCloud User Guide.\n

\n \n \n

For more information about creating accounts, see Creating\n an AWS Account in Your Organization in the\n AWS Organizations User Guide.\n

\n \n
    \n
  • \n

    When you create an account in an organization using the AWS Organizations console,\n API, or CLI commands, the information required for the account to operate as\n a standalone account is not automatically collected.\n This includes a payment method and signing the end user license agreement\n (EULA). If you must remove an account from your organization later, you can\n do so only after you provide the missing information. Follow the steps at\n To leave an organization as a member account in the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    If you get an exception that indicates that you exceeded your account\n limits for the organization, contact AWS Support.

    \n
    • \n
  • \n

    If you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact AWS\n Support.

    \n
    • \n
  • \n

    Using CreateGovCloudAccount to create multiple temporary\n accounts isn't recommended. You can only close an account from the AWS\n Billing and Cost Management console, and you must be signed in as the root\n user. For information on the requirements and process for closing an\n account, see Closing an AWS Account in the\n AWS Organizations User Guide.

    \n
    • \n
\n \n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n Access to Your Billing Information and Tools.

\n " + "smithy.api#documentation": "

This action is available if all of the following are true:

\n
    \n
  • \n

    You're authorized to create accounts in the AWS GovCloud (US) Region. For\n more information on the AWS GovCloud (US) Region, see the \n AWS GovCloud User Guide.\n

    \n
    • \n
  • \n

    You already have an account in the AWS GovCloud (US) Region that is paired\n with a master account of an organization in the commercial Region.

    \n
    • \n
  • \n

    You call this action from the master account of your organization in the\n commercial Region.

    \n
    • \n
  • \n

    You have the organizations:CreateGovCloudAccount permission.\n

    \n
    • \n
\n

AWS Organizations automatically creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the\n AWS Organizations User Guide.\n

\n

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also\n do the following:

\n
    \n
  • \n

    Verify that AWS CloudTrail is enabled to store logs.

    \n
    • \n
  • \n

    Create an S3 bucket for AWS CloudTrail log storage.

    \n

    For more information, see Verifying AWS CloudTrail Is\n Enabled in the AWS GovCloud User Guide.\n

    \n
    • \n
\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission. The tags are attached to the\n commercial account associated with the GovCloud account, rather than the GovCloud\n account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud\n account exists.

\n

You call this action from the master account of your organization in the commercial\n Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the\n account is created, the master account of an organization in the AWS GovCloud (US)\n Region can invite it to that organization. For more information on inviting standalone\n accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the\n AWS GovCloud User Guide.\n

\n

Calling CreateGovCloudAccount is an asynchronous request that AWS\n performs in the background. Because CreateGovCloudAccount operates\n asynchronously, it can return a successful completion message even though account\n initialization might still be in progress. You might need to wait a few minutes before\n you can successfully access the account. To check the status of the request, do one of\n the following:

\n
    \n
  • \n

    Use the OperationId response element from this operation to\n provide as a parameter to the DescribeCreateAccountStatus\n operation.

    \n
    • \n
  • \n

    Check the AWS CloudTrail log for the CreateAccountResult event. For\n information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your\n Organization in the AWS Organizations User Guide.\n

    \n
    • \n
\n

\n

When you call the CreateGovCloudAccount action, you create two accounts:\n a standalone account in the AWS GovCloud (US) Region and an associated account in the\n commercial Region for billing and support purposes. The account in the commercial Region\n is automatically a member of the organization whose credentials made the request. Both\n accounts are associated with the same email address.

\n

A role is created in the new account in the commercial Region that allows the\n master account in the organization in the commercial Region to assume it. An AWS\n GovCloud (US) account is then created and associated with the commercial account that\n you just created. A role is also created in the new AWS GovCloud (US) account that can\n be assumed by the AWS GovCloud (US) account that is associated with the\n master account of the commercial organization. For more information and to view a\n diagram that explains how account access works, see AWS Organizations in the\n AWS GovCloud User Guide.\n

\n \n \n

For more information about creating accounts, see Creating\n an AWS Account in Your Organization in the\n AWS Organizations User Guide.\n

\n \n
    \n
  • \n

    When you create an account in an organization using the AWS Organizations console,\n API, or CLI commands, the information required for the account to operate as\n a standalone account is not automatically collected.\n This includes a payment method and signing the end user license agreement\n (EULA). If you must remove an account from your organization later, you can\n do so only after you provide the missing information. Follow the steps at\n To leave an organization as a member account in the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    If you get an exception that indicates that you exceeded your account\n limits for the organization, contact AWS Support.

    \n
    • \n
  • \n

    If you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact AWS\n Support.

    \n
    • \n
  • \n

    Using CreateGovCloudAccount to create multiple temporary\n accounts isn't recommended. You can only close an account from the AWS\n Billing and Cost Management console, and you must be signed in as the root\n user. For information on the requirements and process for closing an\n account, see Closing an AWS Account in the\n AWS Organizations User Guide.

    \n
    • \n
\n \n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n Access to Your Billing Information and Tools.

\n " } }, "com.amazonaws.organizations#CreateGovCloudAccountRequest": { "type": "structure", "members": { - "Email": { - "target": "com.amazonaws.organizations#Email", + "AccountName": { + "target": "com.amazonaws.organizations#AccountName", "traits": { - "smithy.api#documentation": "

The email address of the owner to assign to the new member account in the commercial\n Region. This email address must not already be associated with another AWS account.\n You must use a valid email address to complete account creation. You can't access the\n root user of the account or remove an account that was created with an invalid email\n address. Like all request parameters for CreateGovCloudAccount, the request\n for the email address for the AWS GovCloud (US) account originates from the commercial\n Region, not from the AWS GovCloud (US) Region.

", + "smithy.api#documentation": "

The friendly name of the member account.

", "smithy.api#required": {} } }, - "IamUserAccessToBilling": { - "target": "com.amazonaws.organizations#IAMUserAccessToBilling", + "Tags": { + "target": "com.amazonaws.organizations#Tags", "traits": { - "smithy.api#documentation": "

If set to ALLOW, the new linked account in the commercial Region enables\n IAM users to access account billing information if they have the\n required permissions. If set to DENY, only the root user of the new account\n can access account billing information. For more information, see Activating\n Access to the Billing and Cost Management Console in the\n AWS Billing and Cost Management User Guide.\n

\n

If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.

" + "smithy.api#documentation": "

A list of tags that you want to attach to the newly created account. These tags are\n attached to the commercial account associated with the GovCloud account, and not to the\n GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud\n account exists.

\n

For each tag in the list, you must specify both a tag key and a value. You can set the\n value to an empty string, but you can't set it to null. For more\n information about tagging, see Tagging AWS Organizations resources\n in the AWS Organizations User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed number of tags for\n an account, then the entire request fails and the account is not created.

\n " } }, "RoleName": { "target": "com.amazonaws.organizations#RoleName", "traits": { - "smithy.api#documentation": "

(Optional)

\n

The name of an IAM role that AWS Organizations automatically preconfigures in the new member\n accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role\n trusts the master account, allowing users in the master account to assume the role, as\n permitted by the master account administrator. The role has administrator permissions in\n the new member account.

\n

If you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.

\n

For more information about how to use this role to access the member account, see\n Accessing and Administering the Member Accounts in Your Organization in the\n AWS Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the\n IAM User Guide.\n

\n

The regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" + "smithy.api#documentation": "

(Optional)

\n

The name of an IAM role that AWS Organizations automatically preconfigures in the new member\n accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role\n trusts the master account, allowing users in the master account to assume the\n role, as permitted by the master account administrator. The role has administrator\n permissions in the new member account.

\n

If you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.

\n

For more information about how to use this role to access the member account, see\n Accessing and Administering the Member Accounts in Your Organization in the\n AWS Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the\n IAM User Guide.\n

\n

The regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" } }, - "AccountName": { - "target": "com.amazonaws.organizations#AccountName", + "IamUserAccessToBilling": { + "target": "com.amazonaws.organizations#IAMUserAccessToBilling", "traits": { - "smithy.api#documentation": "

The friendly name of the member account.

", + "smithy.api#documentation": "

If set to ALLOW, the new linked account in the commercial Region enables\n IAM users to access account billing information if they have the\n required permissions. If set to DENY, only the root user of the new account\n can access account billing information. For more information, see Activating\n Access to the Billing and Cost Management Console in the\n AWS Billing and Cost Management User Guide.\n

\n

If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.

" + } + }, + "Email": { + "target": "com.amazonaws.organizations#Email", + "traits": { + "smithy.api#documentation": "

The email address of the owner to assign to the new member account in the commercial\n Region. This email address must not already be associated with another AWS account.\n You must use a valid email address to complete account creation. You can't access the\n root user of the account or remove an account that was created with an invalid email\n address. Like all request parameters for CreateGovCloudAccount, the request\n for the email address for the AWS GovCloud (US) account originates from the commercial\n Region, not from the AWS GovCloud (US) Region.

", "smithy.api#required": {} } } @@ -1217,7 +1237,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AWS organization. The account whose user is calling the\n CreateOrganization operation automatically becomes the master account of the new organization.

\n

This operation must be called using credentials from the account that is to become the\n new organization's master account. The principal must also have the relevant IAM\n permissions.

\n

By default (or if you set the FeatureSet parameter to ALL),\n the new organization is created with all features enabled and service control policies\n automatically enabled in the root. If you instead choose to create the organization\n supporting only the consolidated billing features by setting the FeatureSet\n parameter to CONSOLIDATED_BILLING\", no policy types are enabled by default,\n and you can't use organization policies

" + "smithy.api#documentation": "

Creates an AWS organization. The account whose user is calling the\n CreateOrganization operation automatically becomes the master account of the new organization.

\n

This operation must be called using credentials from the account that is to become the\n new organization's master account. The principal must also have the relevant IAM\n permissions.

\n

By default (or if you set the FeatureSet parameter to ALL),\n the new organization is created with all features enabled and service control policies\n automatically enabled in the root. If you instead choose to create the organization\n supporting only the consolidated billing features by setting the FeatureSet\n parameter to CONSOLIDATED_BILLING\", no policy types are enabled by default,\n and you can't use organization policies

" } }, "com.amazonaws.organizations#CreateOrganizationRequest": { @@ -1226,7 +1246,7 @@ "FeatureSet": { "target": "com.amazonaws.organizations#OrganizationFeatureSet", "traits": { - "smithy.api#documentation": "

Specifies the feature set supported by the new organization. Each feature set supports\n different levels of functionality.

\n
    \n
  • \n

    \n CONSOLIDATED_BILLING: All member accounts have their bills\n consolidated to and paid by the master account. For more information, see Consolidated billing in the\n AWS Organizations User Guide.\n

    \n

    The consolidated billing feature subset isn't available for organizations in\n the AWS GovCloud (US) Region.

    \n
    • \n
  • \n

    \n ALL: In addition to all the features supported by the\n consolidated billing feature set, the master account can also apply any policy\n type to any member account in the organization. For more information, see All\n features in the AWS Organizations User Guide.\n

    \n
    • \n
" + "smithy.api#documentation": "

Specifies the feature set supported by the new organization. Each feature set supports\n different levels of functionality.

\n
    \n
  • \n

    \n CONSOLIDATED_BILLING: All member accounts have their bills\n consolidated to and paid by the master account. For more information, see\n Consolidated billing in the\n AWS Organizations User Guide.\n

    \n

    The consolidated billing feature subset isn't available for organizations in\n the AWS GovCloud (US) Region.

    \n
    • \n
  • \n

    \n ALL: In addition to all the features supported by the\n consolidated billing feature set, the master account can also apply any\n policy type to any member account in the organization. For more information, see\n All\n features in the AWS Organizations User Guide.\n

    \n
    • \n
" } } } @@ -1280,7 +1300,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an organizational unit (OU) within a root or parent OU. An OU is a container\n for accounts that enables you to organize your accounts to apply policies according to\n your business requirements. The number of levels deep that you can nest OUs is dependent\n upon the policy types enabled for that root. For service control policies, the limit is\n five.

\n

For more information about OUs, see Managing Organizational Units in the\n AWS Organizations User Guide.\n

\n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Creates an organizational unit (OU) within a root or parent OU. An OU is a container\n for accounts that enables you to organize your accounts to apply policies according to\n your business requirements. The number of levels deep that you can nest OUs is dependent\n upon the policy types enabled for that root. For service control policies, the limit is\n five.

\n

For more information about OUs, see Managing Organizational Units in the\n AWS Organizations User Guide.\n

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#CreateOrganizationalUnitRequest": { @@ -1299,6 +1319,12 @@ "smithy.api#documentation": "

The unique identifier (ID) of the parent root or OU that you want to create the new OU\n in.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32\n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.organizations#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the newly created OU. For each tag in the\n list, you must specify both a tag key and a value. You can set the value to an empty\n string, but you can't set it to null. For more information about tagging,\n see Tagging AWS\n Organizations resources in the AWS Organizations User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed number of tags for\n an OU, then the entire request fails and the OU is not created.

\n " + } } } }, @@ -1357,31 +1383,30 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a policy of a specified type that you can attach to a root, an organizational\n unit (OU), or an individual AWS account.

\n

For more information about policies and their use, see Managing\n Organization Policies.

\n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Creates a policy of a specified type that you can attach to a root, an organizational\n unit (OU), or an individual AWS account.

\n

For more information about policies and their use, see Managing\n Organization Policies.

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#CreatePolicyRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.organizations#PolicyType", + "Content": { + "target": "com.amazonaws.organizations#PolicyContent", "traits": { - "smithy.api#documentation": "

The type of policy to create. You can specify one of the following values:

\n ", + "smithy.api#documentation": "

The policy text content to add to the new policy. The text that you supply must adhere\n to the rules of the policy type you specify in the Type parameter.

", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.organizations#PolicyDescription", + "Type": { + "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

An optional description to assign to the policy.

", + "smithy.api#documentation": "

The type of policy to create. You can specify one of the following values:

\n ", "smithy.api#required": {} } }, - "Content": { - "target": "com.amazonaws.organizations#PolicyContent", + "Tags": { + "target": "com.amazonaws.organizations#Tags", "traits": { - "smithy.api#documentation": "

The policy text content to add to the new policy. The text that you supply must adhere\n to the rules of the policy type you specify in the Type parameter.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of tags that you want to attach to the newly created policy. For each tag in\n the list, you must specify both a tag key and a value. You can set the value to an empty\n string, but you can't set it to null. For more information about tagging,\n see Tagging AWS\n Organizations resources in the AWS Organizations User Guide.

\n \n

If any one of the tags is invalid or if you exceed the allowed number of tags for\n a policy, then the entire request fails and the policy is not created.

\n " } }, "Name": { @@ -1390,6 +1415,13 @@ "smithy.api#documentation": "

The friendly name to assign to the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

", "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.organizations#PolicyDescription", + "traits": { + "smithy.api#documentation": "

An optional description to assign to the policy.

", + "smithy.api#required": {} + } } } }, @@ -1468,22 +1500,16 @@ "com.amazonaws.organizations#DelegatedAdministrator": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.organizations#AccountName", - "traits": { - "smithy.api#documentation": "

The friendly name of the delegated administrator's account.

" - } - }, - "DelegationEnabledDate": { - "target": "com.amazonaws.organizations#Timestamp", + "JoinedMethod": { + "target": "com.amazonaws.organizations#AccountJoinedMethod", "traits": { - "smithy.api#documentation": "

The date when the account was made a delegated administrator.

" + "smithy.api#documentation": "

The method by which the delegated administrator's account joined the\n organization.

" } }, - "Id": { - "target": "com.amazonaws.organizations#AccountId", + "Status": { + "target": "com.amazonaws.organizations#AccountStatus", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the delegated administrator's account.

" + "smithy.api#documentation": "

The status of the delegated administrator's account in the organization.

" } }, "Email": { @@ -1492,28 +1518,34 @@ "smithy.api#documentation": "

The email address that is associated with the delegated administrator's AWS\n account.

" } }, - "Arn": { - "target": "com.amazonaws.organizations#AccountArn", + "DelegationEnabledDate": { + "target": "com.amazonaws.organizations#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the delegated administrator's account.

" + "smithy.api#documentation": "

The date when the account was made a delegated administrator.

" } }, - "JoinedTimestamp": { - "target": "com.amazonaws.organizations#Timestamp", + "Name": { + "target": "com.amazonaws.organizations#AccountName", "traits": { - "smithy.api#documentation": "

The date when the delegated administrator's account became a part of the\n organization.

" + "smithy.api#documentation": "

The friendly name of the delegated administrator's account.

" } }, - "Status": { - "target": "com.amazonaws.organizations#AccountStatus", + "Id": { + "target": "com.amazonaws.organizations#AccountId", "traits": { - "smithy.api#documentation": "

The status of the delegated administrator's account in the organization.

" + "smithy.api#documentation": "

The unique identifier (ID) of the delegated administrator's account.

" } }, - "JoinedMethod": { - "target": "com.amazonaws.organizations#AccountJoinedMethod", + "JoinedTimestamp": { + "target": "com.amazonaws.organizations#Timestamp", "traits": { - "smithy.api#documentation": "

The method by which the delegated administrator's account joined the\n organization.

" + "smithy.api#documentation": "

The date when the delegated administrator's account became a part of the\n organization.

" + } + }, + "Arn": { + "target": "com.amazonaws.organizations#AccountArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the delegated administrator's account.

" } } }, @@ -1530,17 +1562,17 @@ "com.amazonaws.organizations#DelegatedService": { "type": "structure", "members": { - "DelegationEnabledDate": { - "target": "com.amazonaws.organizations#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the account became a delegated administrator for this service.

" - } - }, "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The name of a service that can request an operation for the specified service. This is\n typically in the form of a URL, such as:\n \n servicename.amazonaws.com.

" } + }, + "DelegationEnabledDate": { + "target": "com.amazonaws.organizations#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the account became a delegated administrator for this service.

" + } } }, "traits": { @@ -1768,7 +1800,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves AWS Organizations-related information about the specified account.

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

" + "smithy.api#documentation": "

Retrieves AWS Organizations-related information about the specified account.

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

" } }, "com.amazonaws.organizations#DescribeAccountRequest": { @@ -1826,7 +1858,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the current status of an asynchronous request to create an account.

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

" + "smithy.api#documentation": "

Retrieves the current status of an asynchronous request to create an account.

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

" } }, "com.amazonaws.organizations#DescribeCreateAccountStatusRequest": { @@ -1835,7 +1867,7 @@ "CreateAccountRequestId": { "target": "com.amazonaws.organizations#CreateAccountRequestId", "traits": { - "smithy.api#documentation": "

Specifies the operationId that uniquely identifies the request. You can\n get the ID from the response to an earlier CreateAccount request, or\n from the ListCreateAccountStatus operation.

\n

The regex pattern for a create account request ID string \n requires \"car-\" followed by from 8 to 32 lowercase letters or digits.

", + "smithy.api#documentation": "

Specifies the Id value that uniquely identifies the\n CreateAccount request. You can get the value from the\n CreateAccountStatus.Id response in an earlier CreateAccount request, or from the ListCreateAccountStatus operation.

\n

The regex pattern for a create account request ID string \n requires \"car-\" followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } } @@ -1890,23 +1922,23 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the account.

\n

This operation applies only to policy types other than service\n control policies (SCPs).

\n

For more information about policy inheritance, see How Policy Inheritance\n Works in the AWS Organizations User Guide.

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

" + "smithy.api#documentation": "

Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.

\n

This operation applies only to policy types other than service\n control policies (SCPs).

\n

For more information about policy inheritance, see How Policy Inheritance\n Works in the AWS Organizations User Guide.

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

" } }, "com.amazonaws.organizations#DescribeEffectivePolicyRequest": { "type": "structure", "members": { - "PolicyType": { - "target": "com.amazonaws.organizations#EffectivePolicyType", + "TargetId": { + "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { - "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

When you're signed in as the master account, specify the ID of the account that you\n want details about. Specifying an organization root or organizational unit (OU) as the\n target is not supported.

" } }, - "TargetId": { - "target": "com.amazonaws.organizations#PolicyTargetId", + "PolicyType": { + "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { - "smithy.api#documentation": "

When you're signed in as the master account, specify the ID of the account that you\n want details about. Specifying an organization root or organizational unit (OU) as the\n target is not supported.

" + "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", + "smithy.api#required": {} } } } @@ -2043,7 +2075,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about an organizational unit (OU).

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

" + "smithy.api#documentation": "

Retrieves information about an organizational unit (OU).

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

" } }, "com.amazonaws.organizations#DescribeOrganizationalUnitRequest": { @@ -2101,7 +2133,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a policy.

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

" + "smithy.api#documentation": "

Retrieves information about a policy.

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

" } }, "com.amazonaws.organizations#DescribePolicyRequest": { @@ -2184,23 +2216,23 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches a policy from a target root, organizational unit (OU), or account.

\n \n

If the policy being detached is a service control policy (SCP), the changes to\n permissions for AWS Identity and Access Management (IAM) users and roles in affected accounts are\n immediate.

\n \n

Every root, OU, and account must have at least one SCP attached. If you want to\n replace the default FullAWSAccess policy with an SCP that limits the\n permissions that can be delegated, you must attach the replacement SCP before you can\n remove the default SCP. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and leave the\n FullAWSAccess SCP still attached, and specify \"Effect\":\n \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in\n the FullAWSAccess policy (or any other attached SCP), you're using the\n authorization strategy of a \"deny list\".

\n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Detaches a policy from a target root, organizational unit (OU), or account.

\n \n

If the policy being detached is a service control policy (SCP), the changes to\n permissions for AWS Identity and Access Management (IAM) users and roles in affected accounts are\n immediate.

\n \n

Every root, OU, and account must have at least one SCP attached. If you want to\n replace the default FullAWSAccess policy with an SCP that limits the\n permissions that can be delegated, you must attach the replacement SCP before you can\n remove the default SCP. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and\n leave the FullAWSAccess SCP still attached, and specify \"Effect\":\n \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in\n the FullAWSAccess policy (or any other attached SCP), you're using the\n authorization strategy of a \"deny list\".

\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#DetachPolicyRequest": { "type": "structure", "members": { - "PolicyId": { - "target": "com.amazonaws.organizations#PolicyId", + "TargetId": { + "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the policy you want to detach. You can get the ID from\n the ListPolicies or ListPoliciesForTarget\n operations.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", + "smithy.api#documentation": "

The unique identifier (ID) of the root, OU, or account that you want to detach the\n policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts\n operations.

\n

The regex pattern for a target ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Account - A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 \n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
", "smithy.api#required": {} } }, - "TargetId": { - "target": "com.amazonaws.organizations#PolicyTargetId", + "PolicyId": { + "target": "com.amazonaws.organizations#PolicyId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the root, OU, or account that you want to detach the\n policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts\n operations.

\n

The regex pattern for a target ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Account - A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 \n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
", + "smithy.api#documentation": "

The unique identifier (ID) of the policy you want to detach. You can get the ID from\n the ListPolicies or ListPoliciesForTarget\n operations.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } } @@ -2297,23 +2329,23 @@ } ], "traits": { - "smithy.api#documentation": "

Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.

\n

This is an asynchronous request that AWS performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.

\n

This operation can be called only from the organization's master account.

\n

To view the status of available policy types in the organization, use DescribeOrganization.

" + "smithy.api#documentation": "

Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.

\n

This is an asynchronous request that AWS performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.

\n

This operation can be called only from the organization's master account.

\n

To view the status of available policy types in the organization, use DescribeOrganization.

" } }, "com.amazonaws.organizations#DisablePolicyTypeRequest": { "type": "structure", "members": { - "RootId": { - "target": "com.amazonaws.organizations#RootId", + "PolicyType": { + "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the root in which you want to disable a policy type. You\n can get the ID from the ListRoots operation.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

", + "smithy.api#documentation": "

The policy type that you want to disable in this root. You can specify one of the\n following values:

\n ", "smithy.api#required": {} } }, - "PolicyType": { - "target": "com.amazonaws.organizations#PolicyType", + "RootId": { + "target": "com.amazonaws.organizations#RootId", "traits": { - "smithy.api#documentation": "

The policy type that you want to disable in this root. You can specify one of the\n following values:

\n ", + "smithy.api#documentation": "

The unique identifier (ID) of the root in which you want to disable a policy type. You\n can get the ID from the ListRoots operation.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

", "smithy.api#required": {} } } @@ -2410,21 +2442,21 @@ "smithy.api#documentation": "

The text content of the policy.

" } }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.organizations#Timestamp", - "traits": { - "smithy.api#documentation": "

The time of the last update to this policy.

" - } - }, "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { "smithy.api#documentation": "

The account ID of the policy target.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Contains rules to be applied to the affected accounts. The effective policy is the\n aggregation of any policies the account inherits, plus any policy directly attached to\n the account.

" + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.organizations#Timestamp", + "traits": { + "smithy.api#documentation": "

The time of the last update to this policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains rules to be applied to the affected accounts. The effective policy is the\n aggregation of any policies the account inherits, plus any policy directly attached to\n the account.

" } }, "com.amazonaws.organizations#EffectivePolicyNotFoundException": { @@ -2435,7 +2467,7 @@ } }, "traits": { - "smithy.api#documentation": "

If you ran this action on the master account, this policy type is not enabled. If you\n ran the action on a member account, the account doesn't have an effective policy of this\n type. Contact the administrator of your organization about attaching a policy of this\n type to the account.

", + "smithy.api#documentation": "

If you ran this action on the master account, this policy type is not enabled. If\n you ran the action on a member account, the account doesn't have an effective policy of\n this type. Contact the administrator of your organization about attaching a policy of\n this type to the account.

", "smithy.api#error": "client" } }, @@ -2501,7 +2533,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the integration of an AWS service (the service that is specified by\n ServicePrincipal) with AWS Organizations. When you enable integration, you allow\n the specified service to create a service-linked role in\n all the accounts in your organization. This allows the service to perform operations on\n your behalf in your organization and its accounts.

\n \n

We recommend that you enable integration between AWS Organizations and the specified AWS\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other AWS service.

\n \n

For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other\n AWS Services in the AWS Organizations User Guide.\n

\n

This operation can be called only from the organization's master account and only if\n the organization has enabled all features.

" + "smithy.api#documentation": "

Enables the integration of an AWS service (the service that is specified by\n ServicePrincipal) with AWS Organizations. When you enable integration, you allow\n the specified service to create a service-linked role in\n all the accounts in your organization. This allows the service to perform operations on\n your behalf in your organization and its accounts.

\n \n

We recommend that you enable integration between AWS Organizations and the specified AWS\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other AWS service.

\n \n

For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other\n AWS Services in the AWS Organizations User Guide.\n

\n

This operation can be called only from the organization's master account and only\n if the organization has enabled all\n features.

" } }, "com.amazonaws.organizations#EnableAWSServiceAccessRequest": { @@ -2548,7 +2580,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables all features in an organization. This enables the use of organization policies\n that can restrict the services and actions that can be called in each account. Until you\n enable all features, you have access only to consolidated billing, and you can't use any\n of the advanced account administration features that AWS Organizations supports. For more\n information, see Enabling All Features in Your Organization in the\n AWS Organizations User Guide.\n

\n \n

This operation is required only for organizations that were created explicitly\n with only the consolidated billing features enabled. Calling this operation sends a\n handshake to every invited account in the organization. The feature set change can\n be finalized and the additional features enabled only after all administrators in\n the invited accounts approve the change by accepting the handshake.

\n \n

After you enable all features, you can separately enable or disable individual policy\n types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use\n ListRoots.

\n

After all invited member accounts accept the handshake, you finalize the feature set\n change by accepting the handshake that contains \"Action\":\n \"ENABLE_ALL_FEATURES\". This completes the change.

\n

After you enable all features in your organization, the master account in the\n organization can apply policies on all member accounts. These policies can restrict what\n users and even administrators in those accounts can do. The master account can apply\n policies that prevent accounts from leaving the organization. Ensure that your account\n administrators are aware of this.

\n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Enables all features in an organization. This enables the use of organization policies\n that can restrict the services and actions that can be called in each account. Until you\n enable all features, you have access only to consolidated billing, and you can't use any\n of the advanced account administration features that AWS Organizations supports. For more\n information, see Enabling All Features in Your Organization in the\n AWS Organizations User Guide.\n

\n \n

This operation is required only for organizations that were created explicitly\n with only the consolidated billing features enabled. Calling this operation sends a\n handshake to every invited account in the organization. The feature set change can\n be finalized and the additional features enabled only after all administrators in\n the invited accounts approve the change by accepting the handshake.

\n \n

After you enable all features, you can separately enable or disable individual policy\n types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use\n ListRoots.

\n

After all invited member accounts accept the handshake, you finalize the feature set\n change by accepting the handshake that contains \"Action\":\n \"ENABLE_ALL_FEATURES\". This completes the change.

\n

After you enable all features in your organization, the master account in the\n organization can apply policies on all member accounts. These policies can restrict what\n users and even administrators in those accounts can do. The master account can apply\n policies that prevent accounts from leaving the organization. Ensure that your account\n administrators are aware of this.

\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#EnableAllFeaturesRequest": { @@ -2613,23 +2645,23 @@ } ], "traits": { - "smithy.api#documentation": "

Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.

\n

This is an asynchronous request that AWS performs in the background. AWS\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.

\n

This operation can be called only from the organization's master account.

\n

You can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n DescribeOrganization.

" + "smithy.api#documentation": "

Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.

\n

This is an asynchronous request that AWS performs in the background. AWS\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.

\n

This operation can be called only from the organization's master account.

\n

You can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n DescribeOrganization.

" } }, "com.amazonaws.organizations#EnablePolicyTypeRequest": { "type": "structure", "members": { - "PolicyType": { - "target": "com.amazonaws.organizations#PolicyType", + "RootId": { + "target": "com.amazonaws.organizations#RootId", "traits": { - "smithy.api#documentation": "

The policy type that you want to enable. You can specify one of the following\n values:

\n ", + "smithy.api#documentation": "

The unique identifier (ID) of the root in which you want to enable a policy type. You\n can get the ID from the ListRoots operation.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

", "smithy.api#required": {} } }, - "RootId": { - "target": "com.amazonaws.organizations#RootId", + "PolicyType": { + "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the root in which you want to enable a policy type. You\n can get the ID from the ListRoots operation.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

", + "smithy.api#documentation": "

The policy type that you want to enable. You can specify one of the following\n values:

\n ", "smithy.api#required": {} } } @@ -2649,17 +2681,17 @@ "com.amazonaws.organizations#EnabledServicePrincipal": { "type": "structure", "members": { - "DateEnabled": { - "target": "com.amazonaws.organizations#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the service principal was enabled for integration with AWS Organizations.

" - } - }, "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The name of the service principal. This is typically in the form of a URL, such as:\n \n servicename.amazonaws.com.

" } + }, + "DateEnabled": { + "target": "com.amazonaws.organizations#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the service principal was enabled for integration with AWS Organizations.

" + } } }, "traits": { @@ -2700,10 +2732,28 @@ "com.amazonaws.organizations#Handshake": { "type": "structure", "members": { + "ExpirationTimestamp": { + "target": "com.amazonaws.organizations#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the handshake expires. If the recipient of the handshake\n request fails to respond before the specified date and time, the handshake becomes\n inactive and is no longer valid.

" + } + }, + "Resources": { + "target": "com.amazonaws.organizations#HandshakeResources", + "traits": { + "smithy.api#documentation": "

Additional information that is needed to process the handshake.

" + } + }, + "Action": { + "target": "com.amazonaws.organizations#ActionType", + "traits": { + "smithy.api#documentation": "

The type of handshake, indicating what action occurs when the recipient accepts the\n handshake. The following handshake types are supported:

\n
    \n
  • \n

    \n INVITE: This type of handshake represents a\n request to join an organization. It is always sent from the master account to\n only non-member accounts.

    \n
    • \n
  • \n

    \n ENABLE_ALL_FEATURES: This type of handshake\n represents a request to enable all features in an organization. It is always\n sent from the master account to only invited member\n accounts. Created accounts do not receive this because those accounts were\n created by the organization's master account and approval is inferred.

    \n
    • \n
  • \n

    \n APPROVE_ALL_FEATURES: This type of handshake\n is sent from the Organizations service when all member accounts have approved the\n ENABLE_ALL_FEATURES invitation. It is sent only to the\n master account and signals the master that it can finalize the process to\n enable all features.

    \n
    • \n
" + } + }, "Id": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of a handshake. The originating account creates the ID when\n it initiates the handshake.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lower-case letters or digits.

" + "smithy.api#documentation": "

The unique identifier (ID) of a handshake. The originating account creates the ID when\n it initiates the handshake.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

" } }, "Arn": { @@ -2712,12 +2762,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a handshake.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" } }, - "Resources": { - "target": "com.amazonaws.organizations#HandshakeResources", - "traits": { - "smithy.api#documentation": "

Additional information that is needed to process the handshake.

" - } - }, "RequestedTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { @@ -2730,27 +2774,15 @@ "smithy.api#documentation": "

Information about the two accounts that are participating in the handshake.

" } }, - "ExpirationTimestamp": { - "target": "com.amazonaws.organizations#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the handshake expires. If the recipient of the handshake\n request fails to respond before the specified date and time, the handshake becomes\n inactive and is no longer valid.

" - } - }, "State": { "target": "com.amazonaws.organizations#HandshakeState", "traits": { "smithy.api#documentation": "

The current state of the handshake. Use the state to trace the flow of the handshake\n through the process from its creation to its acceptance. The meaning of each of the\n valid values is as follows:

\n
    \n
  • \n

    \n REQUESTED: This handshake was sent to\n multiple recipients (applicable to only some handshake types) and not all\n recipients have responded yet. The request stays in this state until all\n recipients respond.

    \n
    • \n
  • \n

    \n OPEN: This handshake was sent to multiple\n recipients (applicable to only some policy types) and all recipients have\n responded, allowing the originator to complete the handshake action.

    \n
    • \n
  • \n

    \n CANCELED: This handshake is no longer active\n because it was canceled by the originating account.

    \n
    • \n
  • \n

    \n ACCEPTED: This handshake is complete because\n it has been accepted by the recipient.

    \n
    • \n
  • \n

    \n DECLINED: This handshake is no longer active\n because it was declined by the recipient account.

    \n
    • \n
  • \n

    \n EXPIRED: This handshake is no longer active\n because the originator did not receive a response of any kind from the recipient\n before the expiration time (15 days).

    \n
    • \n
" } - }, - "Action": { - "target": "com.amazonaws.organizations#ActionType", - "traits": { - "smithy.api#documentation": "

The type of handshake, indicating what action occurs when the recipient accepts the\n handshake. The following handshake types are supported:

\n
    \n
  • \n

    \n INVITE: This type of handshake represents a\n request to join an organization. It is always sent from the master account to\n only non-member accounts.

    \n
    • \n
  • \n

    \n ENABLE_ALL_FEATURES: This type of handshake\n represents a request to enable all features in an organization. It is always\n sent from the master account to only invited member\n accounts. Created accounts do not receive this because those accounts were\n created by the organization's master account and approval is inferred.

    \n
    • \n
  • \n

    \n APPROVE_ALL_FEATURES: This type of handshake\n is sent from the Organizations service when all member accounts have approved the\n ENABLE_ALL_FEATURES invitation. It is sent only to the master\n account and signals the master that it can finalize the process to enable all\n features.

    \n
    • \n
" - } } }, "traits": { - "smithy.api#documentation": "

Contains information that must be exchanged to securely establish a relationship\n between two accounts (an originator and a\n recipient). For example, when a master account (the originator)\n invites another account (the recipient) to join its organization, the two accounts\n exchange information as a series of handshake requests and responses.

\n

\n Note: Handshakes that are CANCELED, ACCEPTED, or\n DECLINED show up in lists for only 30 days after entering that state After that they are\n deleted.

" + "smithy.api#documentation": "

Contains information that must be exchanged to securely establish a relationship\n between two accounts (an originator and a\n recipient). For example, when a master account (the\n originator) invites another account (the recipient) to join its organization, the two\n accounts exchange information as a series of handshake requests and responses.

\n

\n Note: Handshakes that are CANCELED, ACCEPTED, or\n DECLINED show up in lists for only 30 days after entering that state After that they are\n deleted.

" } }, "com.amazonaws.organizations#HandshakeAlreadyInStateException": { @@ -2839,7 +2871,7 @@ "ParentHandshakeId": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { - "smithy.api#documentation": "

Specifies the parent handshake. Only used for handshake types that are a child of\n another type.

\n

If you specify ParentHandshakeId, you cannot also specify\n ActionType.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lower-case letters or digits.

" + "smithy.api#documentation": "

Specifies the parent handshake. Only used for handshake types that are a child of\n another type.

\n

If you specify ParentHandshakeId, you cannot also specify\n ActionType.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

" } } }, @@ -2893,7 +2925,7 @@ "Id": { "target": "com.amazonaws.organizations#HandshakePartyId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) for the party.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lower-case letters or digits.

", + "smithy.api#documentation": "

The unique identifier (ID) for the party.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } }, @@ -2942,10 +2974,10 @@ "com.amazonaws.organizations#HandshakeResource": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.organizations#HandshakeResourceValue", + "Type": { + "target": "com.amazonaws.organizations#HandshakeResourceType", "traits": { - "smithy.api#documentation": "

The information that is passed to the other party in the handshake. The format of the\n value string must match the requirements of the specified type.

" + "smithy.api#documentation": "

The type of information being passed, specifying how the value is to be interpreted by\n the other party:

\n
    \n
  • \n

    \n ACCOUNT - Specifies an AWS account ID number.

    \n
    • \n
  • \n

    \n ORGANIZATION - Specifies an organization ID number.

    \n
    • \n
  • \n

    \n EMAIL - Specifies the email address that is associated with the\n account that receives the handshake.

    \n
    • \n
  • \n

    \n OWNER_EMAIL - Specifies the email address associated with the\n master account. Included as information about an organization.

    \n
    • \n
  • \n

    \n OWNER_NAME - Specifies the name associated with the\n master account. Included as information about an organization.

    \n
    • \n
  • \n

    \n NOTES - Additional text provided by the handshake initiator and\n intended for the recipient to read.

    \n
    • \n
" } }, "Resources": { @@ -2954,10 +2986,10 @@ "smithy.api#documentation": "

When needed, contains an additional array of HandshakeResource\n objects.

" } }, - "Type": { - "target": "com.amazonaws.organizations#HandshakeResourceType", + "Value": { + "target": "com.amazonaws.organizations#HandshakeResourceValue", "traits": { - "smithy.api#documentation": "

The type of information being passed, specifying how the value is to be interpreted by\n the other party:

\n
    \n
  • \n

    \n ACCOUNT - Specifies an AWS account ID number.

    \n
    • \n
  • \n

    \n ORGANIZATION - Specifies an organization ID number.

    \n
    • \n
  • \n

    \n EMAIL - Specifies the email address that is associated with the\n account that receives the handshake.

    \n
    • \n
  • \n

    \n OWNER_EMAIL - Specifies the email address associated with the\n master account. Included as information about an organization.

    \n
    • \n
  • \n

    \n OWNER_NAME - Specifies the name associated with the master\n account. Included as information about an organization.

    \n
    • \n
  • \n

    \n NOTES - Additional text provided by the handshake initiator and\n intended for the recipient to read.

    \n
    • \n
" + "smithy.api#documentation": "

The information that is passed to the other party in the handshake. The format of the\n value string must match the requirements of the specified type.

" } } }, @@ -3084,15 +3116,15 @@ "com.amazonaws.organizations#InvalidInputException": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.organizations#InvalidInputExceptionReason" - }, "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" + }, + "Reason": { + "target": "com.amazonaws.organizations#InvalidInputExceptionReason" } }, "traits": { - "smithy.api#documentation": "

The requested operation failed because you provided invalid values for one or more of\n the request parameters. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

\n \n
    \n
  • \n

    IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be\n modified.

    \n
    • \n
  • \n

    INPUT_REQUIRED: You must include a value for all required parameters.

    \n
    • \n
  • \n

    INVALID_ENUM: You specified an invalid value.

    \n
    • \n
  • \n

    INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid\n characters.

    \n
    • \n
  • \n

    INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least\n one invalid value.

    \n
    • \n
  • \n

    INVALID_PAGINATION_TOKEN: Get the value for the NextToken\n parameter from the response to a previous call of the operation.

    \n
    • \n
  • \n

    INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account,\n organization, or email) as a party.

    \n
    • \n
  • \n

    INVALID_PATTERN: You provided a value that doesn't match the required\n pattern.

    \n
    • \n
  • \n

    INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match\n the required pattern.

    \n
    • \n
  • \n

    INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name\n can't begin with the reserved prefix AWSServiceRoleFor.

    \n
    • \n
  • \n

    INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name\n (ARN) for the organization.

    \n
    • \n
  • \n

    INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

    \n
    • \n
  • \n

    INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag.\n You can’t add, edit, or delete system tag keys because they're reserved for\n AWS use. System tags don’t count against your tags per resource limit.

    \n
    • \n
  • \n

    MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the\n operation.

    \n
    • \n
  • \n

    MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than\n allowed.

    \n
    • \n
  • \n

    MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value\n than allowed.

    \n
    • \n
  • \n

    MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than\n allowed.

    \n
    • \n
  • \n

    MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value\n than allowed.

    \n
    • \n
  • \n

    MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between\n entities in the same root.

    \n
    • \n
", + "smithy.api#documentation": "

The requested operation failed because you provided invalid values for one or more of\n the request parameters. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

\n \n
    \n
  • \n

    DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same\n entity.

    \n
    • \n
  • \n

    IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be\n modified.

    \n
    • \n
  • \n

    INPUT_REQUIRED: You must include a value for all required parameters.

    \n
    • \n
  • \n

    INVALID_ENUM: You specified an invalid value.

    \n
    • \n
  • \n

    INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.

    \n
    • \n
  • \n

    INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid\n characters.

    \n
    • \n
  • \n

    INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least\n one invalid value.

    \n
    • \n
  • \n

    INVALID_PAGINATION_TOKEN: Get the value for the NextToken\n parameter from the response to a previous call of the operation.

    \n
    • \n
  • \n

    INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account,\n organization, or email) as a party.

    \n
    • \n
  • \n

    INVALID_PATTERN: You provided a value that doesn't match the required\n pattern.

    \n
    • \n
  • \n

    INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match\n the required pattern.

    \n
    • \n
  • \n

    INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name\n can't begin with the reserved prefix AWSServiceRoleFor.

    \n
    • \n
  • \n

    INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name\n (ARN) for the organization.

    \n
    • \n
  • \n

    INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

    \n
    • \n
  • \n

    INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag.\n You can’t add, edit, or delete system tag keys because they're reserved for\n AWS use. System tags don’t count against your tags per resource limit.

    \n
    • \n
  • \n

    MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the\n operation.

    \n
    • \n
  • \n

    MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than\n allowed.

    \n
    • \n
  • \n

    MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value\n than allowed.

    \n
    • \n
  • \n

    MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than\n allowed.

    \n
    • \n
  • \n

    MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value\n than allowed.

    \n
    • \n
  • \n

    MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between\n entities in the same root.

    \n
    • \n
  • \n

    TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target\n entity.

    \n
    • \n
  • \n

    UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't\n recognized.

    \n
    • \n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3185,6 +3217,10 @@ "value": "INVALID_SYSTEM_TAGS_PARAMETER", "name": "INVALID_SYSTEM_TAGS_PARAMETER" }, + { + "value": "DUPLICATE_TAG_KEY", + "name": "DUPLICATE_TAG_KEY" + }, { "value": "TARGET_NOT_SUPPORTED", "name": "TARGET_NOT_SUPPORTED" @@ -3213,6 +3249,9 @@ { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, + { + "target": "com.amazonaws.organizations#ConstraintViolationException" + }, { "target": "com.amazonaws.organizations#DuplicateHandshakeException" }, @@ -3233,24 +3272,30 @@ } ], "traits": { - "smithy.api#documentation": "

Sends an invitation to another account to join your organization as a member account.\n AWS Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.

\n \n
    \n
  • \n

    You can invite AWS accounts only from the same seller as the master\n account. For example, if your organization's master account was created by\n Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, you can\n invite only other AISPL accounts to your organization. You can't combine\n accounts from AISPL and AWS or from any other AWS seller. For more\n information, see Consolidated\n Billing in India.

    \n
    • \n
  • \n

    If you receive an exception that indicates that you exceeded your account\n limits for the organization or that the operation failed because your\n organization is still initializing, wait one hour and then try again. If the\n error persists after an hour, contact AWS Support.

    \n
    • \n
\n \n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Sends an invitation to another account to join your organization as a member account.\n AWS Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.

\n \n
    \n
  • \n

    You can invite AWS accounts only from the same seller as the\n master account. For example, if your organization's master account was\n created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in\n India, you can invite only other AISPL accounts to your organization. You\n can't combine accounts from AISPL and AWS or from any other AWS seller.\n For more information, see Consolidated\n Billing in India.

    \n
    • \n
  • \n

    If you receive an exception that indicates that you exceeded your account\n limits for the organization or that the operation failed because your\n organization is still initializing, wait one hour and then try again. If the\n error persists after an hour, contact AWS Support.

    \n
    • \n
\n \n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#InviteAccountToOrganizationRequest": { "type": "structure", "members": { - "Target": { - "target": "com.amazonaws.organizations#HandshakeParty", - "traits": { - "smithy.api#documentation": "

The identifier (ID) of the AWS account that you want to invite to join your\n organization. This is a JSON object that contains the following elements:

\n

\n { \"Type\": \"ACCOUNT\", \"Id\": \"<\n account id\n number\n >\" }\n

\n

If you use the AWS CLI, you can submit this as a single string, similar to the\n following example:

\n

\n --target Id=123456789012,Type=ACCOUNT\n

\n

If you specify \"Type\": \"ACCOUNT\", you must provide the AWS account ID\n number as the Id. If you specify \"Type\": \"EMAIL\", you must\n specify the email address that is associated with the account.

\n

\n --target Id=diego@example.com,Type=EMAIL\n

", - "smithy.api#required": {} - } - }, "Notes": { "target": "com.amazonaws.organizations#HandshakeNotes", "traits": { "smithy.api#documentation": "

Additional information that you want to include in the generated email to the\n recipient account owner.

" } + }, + "Tags": { + "target": "com.amazonaws.organizations#Tags", + "traits": { + "smithy.api#documentation": "

A list of tags that you want to attach to the account when it becomes a member of the\n organization. For each tag in the list, you must specify both a tag key and a value. You\n can set the value to an empty string, but you can't set it to null. For\n more information about tagging, see Tagging AWS Organizations resources\n in the AWS Organizations User Guide.

\n \n

Any tags in the request are checked for compliance with any applicable tag\n policies when the request is made. The request is rejected if the tags in the\n request don't match the requirements of the policy at that time. Tag policy\n compliance is \n not\n checked\n again when the invitation is accepted and the tags are actually attached to the\n account. That means that if the tag policy changes between the invitation and the\n acceptance, then that tags could potentially be non-compliant.

\n \n \n

If any one of the tags is invalid or if you exceed the allowed number of tags for\n an account, then the entire request fails and invitations are not sent.

\n " + } + }, + "Target": { + "target": "com.amazonaws.organizations#HandshakeParty", + "traits": { + "smithy.api#documentation": "

The identifier (ID) of the AWS account that you want to invite to join your\n organization. This is a JSON object that contains the following elements:

\n

\n { \"Type\": \"ACCOUNT\", \"Id\": \"<\n account id\n number\n >\" }\n

\n

If you use the AWS CLI, you can submit this as a single string, similar to the\n following example:

\n

\n --target Id=123456789012,Type=ACCOUNT\n

\n

If you specify \"Type\": \"ACCOUNT\", you must provide the AWS account ID\n number as the Id. If you specify \"Type\": \"EMAIL\", you must\n specify the email address that is associated with the account.

\n

\n --target Id=diego@example.com,Type=EMAIL\n

", + "smithy.api#required": {} + } } } }, @@ -3297,7 +3342,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the master account, use RemoveAccountFromOrganization instead.

\n

This operation can be called only from a member account in the organization.

\n \n
    \n
  • \n

    The master account in an organization with all features enabled can set\n service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.

    \n
    • \n
  • \n

    You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the AWS Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must do the following steps:

    \n
      \n
    • \n

      Accept the end user license agreement (EULA)

      \n
      • \n
    • \n

      Choose a support plan

      \n
      • \n
    • \n

      Provide and verify the required contact information

      \n
      • \n
    • \n

      Provide a current payment method

      \n
      • \n
    \n

    AWS uses the payment method to charge for any billable (not free tier)\n AWS activity that occurs while the account isn't attached to an\n organization. Follow the steps at To leave an organization when all required account information has not\n yet been provided in the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    You can leave an organization only after you enable IAM user access to\n billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in\n the AWS Billing and Cost Management User Guide.\n

    \n
    • \n
\n " + "smithy.api#documentation": "

Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the master account, use RemoveAccountFromOrganization\n instead.

\n

This operation can be called only from a member account in the organization.

\n \n
    \n
  • \n

    The master account in an organization with all features enabled can set\n service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.

    \n
    • \n
  • \n

    You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the AWS Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must perform the following steps. If any of\n the steps are already completed for this account, that step doesn't\n appear.

    \n
      \n
    • \n

      Choose a support plan

      \n
      • \n
    • \n

      Provide and verify the required contact information

      \n
      • \n
    • \n

      Provide a current payment method

      \n
      • \n
    \n

    AWS uses the payment method to charge for any billable (not free tier)\n AWS activity that occurs while the account isn't attached to an\n organization. Follow the steps at To leave an organization when all required account information has not\n yet been provided in the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    You can leave an organization only after you enable IAM user access to\n billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in\n the AWS Billing and Cost Management User Guide.\n

    \n
    • \n
  • \n

    After the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. AWS accounts outside\n of an organization do not support tags.

    \n
    • \n
\n " } }, "com.amazonaws.organizations#ListAWSServiceAccessForOrganization": { @@ -3332,7 +3377,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the AWS services that you enabled to integrate with your\n organization. After a service on this list creates the resources that it requires for\n the integration, it can perform operations on your organization and its accounts.

\n

For more information about integrating other services with AWS Organizations, including the\n list of services that currently work with Organizations, see Integrating AWS Organizations with Other\n AWS Services in the AWS Organizations User Guide.\n

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Returns a list of the AWS services that you enabled to integrate with your\n organization. After a service on this list creates the resources that it requires for\n the integration, it can perform operations on your organization and its accounts.

\n

For more information about integrating other services with AWS Organizations, including the\n list of services that currently work with Organizations, see Integrating AWS Organizations with Other\n AWS Services in the AWS Organizations User Guide.\n

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3343,17 +3388,17 @@ "com.amazonaws.organizations#ListAWSServiceAccessForOrganizationRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } - }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } } } }, @@ -3400,7 +3445,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the accounts in the organization. To request only the accounts in a\n specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists all the accounts in the organization. To request only the accounts in a\n specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3437,7 +3482,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the accounts in an organization that are contained by the specified target root\n or organizational unit (OU). If you specify the root, you get a list of all the accounts\n that aren't in any OU. If you specify an OU, you get a list of all the accounts in only\n that OU and not in any child OUs. To get a list of all accounts in the organization, use\n the ListAccounts operation.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists the accounts in an organization that are contained by the specified target root\n or organizational unit (OU). If you specify the root, you get a list of all the accounts\n that aren't in any OU. If you specify an OU, you get a list of all the accounts in only\n that OU and not in any child OUs. To get a list of all accounts in the organization, use\n the ListAccounts operation.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3448,13 +3493,6 @@ "com.amazonaws.organizations#ListAccountsForParentRequest": { "type": "structure", "members": { - "ParentId": { - "target": "com.amazonaws.organizations#ParentId", - "traits": { - "smithy.api#documentation": "

The unique identifier (ID) for the parent root or organization unit (OU) whose\n accounts you want to list.

", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { @@ -3466,40 +3504,47 @@ "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" } + }, + "ParentId": { + "target": "com.amazonaws.organizations#ParentId", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) for the parent root or organization unit (OU) whose\n accounts you want to list.

", + "smithy.api#required": {} + } } } }, "com.amazonaws.organizations#ListAccountsForParentResponse": { "type": "structure", "members": { - "Accounts": { - "target": "com.amazonaws.organizations#Accounts", - "traits": { - "smithy.api#documentation": "

A list of the accounts in the specified root or OU.

" - } - }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" } + }, + "Accounts": { + "target": "com.amazonaws.organizations#Accounts", + "traits": { + "smithy.api#documentation": "

A list of the accounts in the specified root or OU.

" + } } } }, "com.amazonaws.organizations#ListAccountsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } - }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } } } }, @@ -3549,7 +3594,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all of the organizational units (OUs) or accounts that are contained in the\n specified parent OU or root. This operation, along with ListParents\n enables you to traverse the tree structure that makes up this root.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists all of the organizational units (OUs) or accounts that are contained in the\n specified parent OU or root. This operation, along with ListParents\n enables you to traverse the tree structure that makes up this root.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3560,11 +3605,10 @@ "com.amazonaws.organizations#ListChildrenRequest": { "type": "structure", "members": { - "ChildType": { - "target": "com.amazonaws.organizations#ChildType", + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", "traits": { - "smithy.api#documentation": "

Filters the output to include only the specified child type.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" } }, "ParentId": { @@ -3574,16 +3618,17 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.organizations#MaxResults", + "ChildType": { + "target": "com.amazonaws.organizations#ChildType", "traits": { - "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" + "smithy.api#documentation": "

Filters the output to include only the specified child type.

", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", + "MaxResults": { + "target": "com.amazonaws.organizations#MaxResults", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } } } @@ -3591,17 +3636,17 @@ "com.amazonaws.organizations#ListChildrenResponse": { "type": "structure", "members": { - "Children": { - "target": "com.amazonaws.organizations#Children", - "traits": { - "smithy.api#documentation": "

The list of children of the specified parent container.

" - } - }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" } + }, + "Children": { + "target": "com.amazonaws.organizations#Children", + "traits": { + "smithy.api#documentation": "

The list of children of the specified parent container.

" + } } } }, @@ -3634,7 +3679,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the account creation requests that match the specified status that is currently\n being tracked for the organization.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists the account creation requests that match the specified status that is currently\n being tracked for the organization.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3645,10 +3690,10 @@ "com.amazonaws.organizations#ListCreateAccountStatusRequest": { "type": "structure", "members": { - "States": { - "target": "com.amazonaws.organizations#CreateAccountStates", + "MaxResults": { + "target": "com.amazonaws.organizations#MaxResults", "traits": { - "smithy.api#documentation": "

A list of one or more states that you want included in the response. If this parameter\n isn't present, all requests are included in the response.

" + "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } }, "NextToken": { @@ -3657,10 +3702,10 @@ "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" } }, - "MaxResults": { - "target": "com.amazonaws.organizations#MaxResults", + "States": { + "target": "com.amazonaws.organizations#CreateAccountStates", "traits": { - "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" + "smithy.api#documentation": "

A list of one or more states that you want included in the response. If this parameter\n isn't present, all requests are included in the response.

" } } } @@ -3714,7 +3759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the AWS accounts that are designated as delegated administrators in this\n organization.

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists the AWS accounts that are designated as delegated administrators in this\n organization.

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3726,6 +3771,12 @@ "com.amazonaws.organizations#ListDelegatedAdministratorsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } + }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { @@ -3737,12 +3788,6 @@ "traits": { "smithy.api#documentation": "

Specifies a service principal name. If specified, then the operation lists the\n delegated administrators only for the specified service.

\n

If you don't specify a service principal, the operation lists all delegated\n administrators for all services in your organization.

" } - }, - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } } } }, @@ -3801,7 +3846,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the AWS services for which the specified account is a delegated administrator.

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

List the AWS services for which the specified account is a delegated\n administrator.

\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3813,6 +3858,12 @@ "com.amazonaws.organizations#ListDelegatedServicesForAccountRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } + }, "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { @@ -3825,29 +3876,23 @@ "traits": { "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } - }, - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } } } }, "com.amazonaws.organizations#ListDelegatedServicesForAccountResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" - } - }, "DelegatedServices": { "target": "com.amazonaws.organizations#DelegatedServices", "traits": { "smithy.api#documentation": "

The services for which the account is a delegated administrator.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" + } } } }, @@ -3877,7 +3922,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the current handshakes that are associated with the account of the requesting\n user.

\n

Handshakes that are ACCEPTED, DECLINED, or\n CANCELED appear in the results of this API for only 30 days after\n changing to that state. After that, they're deleted and no longer accessible.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists the current handshakes that are associated with the account of the requesting\n user.

\n

Handshakes that are ACCEPTED, DECLINED, or\n CANCELED appear in the results of this API for only 30 days after\n changing to that state. After that, they're deleted and no longer accessible.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called from any account in the organization.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3888,6 +3933,12 @@ "com.amazonaws.organizations#ListHandshakesForAccountRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } + }, "Filter": { "target": "com.amazonaws.organizations#HandshakeFilter", "traits": { @@ -3899,12 +3950,6 @@ "traits": { "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } - }, - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } } } }, @@ -3954,7 +3999,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the handshakes that are associated with the organization that the requesting\n user is part of. The ListHandshakesForOrganization operation returns a list\n of handshake structures. Each structure contains details and status about a\n handshake.

\n

Handshakes that are ACCEPTED, DECLINED, or\n CANCELED appear in the results of this API for only 30 days after\n changing to that state. After that, they're deleted and no longer accessible.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists the handshakes that are associated with the organization that the requesting\n user is part of. The ListHandshakesForOrganization operation returns a list\n of handshake structures. Each structure contains details and status about a\n handshake.

\n

Handshakes that are ACCEPTED, DECLINED, or\n CANCELED appear in the results of this API for only 30 days after\n changing to that state. After that, they're deleted and no longer accessible.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3965,10 +4010,10 @@ "com.amazonaws.organizations#ListHandshakesForOrganizationRequest": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.organizations#HandshakeFilter", + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", "traits": { - "smithy.api#documentation": "

A filter of the handshakes that you want included in the response. The default is all\n types. Use the ActionType element to limit the output to only a specified\n type, such as INVITE, ENABLE-ALL-FEATURES, or\n APPROVE-ALL-FEATURES. Alternatively, for the\n ENABLE-ALL-FEATURES handshake that generates a separate child handshake\n for each member account, you can specify the ParentHandshakeId to see only\n the handshakes that were generated by that parent request.

" + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" } }, "MaxResults": { @@ -3977,10 +4022,10 @@ "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } }, - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", + "Filter": { + "target": "com.amazonaws.organizations#HandshakeFilter", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + "smithy.api#documentation": "

A filter of the handshakes that you want included in the response. The default is all\n types. Use the ActionType element to limit the output to only a specified\n type, such as INVITE, ENABLE-ALL-FEATURES, or\n APPROVE-ALL-FEATURES. Alternatively, for the\n ENABLE-ALL-FEATURES handshake that generates a separate child handshake\n for each member account, you can specify the ParentHandshakeId to see only\n the handshakes that were generated by that parent request.

" } } } @@ -4031,7 +4076,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the organizational units (OUs) in a parent organizational unit or root.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists the organizational units (OUs) in a parent organizational unit or root.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4049,34 +4094,34 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } - }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } } } }, "com.amazonaws.organizations#ListOrganizationalUnitsForParentResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" - } - }, "OrganizationalUnits": { "target": "com.amazonaws.organizations#OrganizationalUnits", "traits": { "smithy.api#documentation": "

A list of the OUs in the specified root or parent OU.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" + } } } }, @@ -4109,7 +4154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the root or organizational units (OUs) that serve as the immediate parent of the\n specified child OU or account. This operation, along with ListChildren\n enables you to traverse the tree structure that makes up this root.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

\n \n

In the current release, a child can have only a single parent.

\n ", + "smithy.api#documentation": "

Lists the root or organizational units (OUs) that serve as the immediate parent of the\n specified child OU or account. This operation, along with ListChildren\n enables you to traverse the tree structure that makes up this root.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

\n \n

In the current release, a child can have only a single parent.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4120,12 +4165,6 @@ "com.amazonaws.organizations#ListParentsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } - }, "ChildId": { "target": "com.amazonaws.organizations#ChildId", "traits": { @@ -4138,23 +4177,29 @@ "traits": { "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } } } }, "com.amazonaws.organizations#ListParentsResponse": { "type": "structure", "members": { - "Parents": { - "target": "com.amazonaws.organizations#Parents", - "traits": { - "smithy.api#documentation": "

A list of parents for the specified child account or OU.

" - } - }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" } + }, + "Parents": { + "target": "com.amazonaws.organizations#Parents", + "traits": { + "smithy.api#documentation": "

A list of parents for the specified child account or OU.

" + } } } }, @@ -4187,7 +4232,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the list of all policies in an organization of a specified type.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Retrieves the list of all policies in an organization of a specified type.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4227,7 +4272,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the policies that are directly attached to the specified target root,\n organizational unit (OU), or account. You must specify the policy type that you want\n included in the returned list.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists the policies that are directly attached to the specified target root,\n organizational unit (OU), or account. You must specify the policy type that you want\n included in the returned list.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4238,71 +4283,71 @@ "com.amazonaws.organizations#ListPoliciesForTargetRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", + "MaxResults": { + "target": "com.amazonaws.organizations#MaxResults", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } }, - "TargetId": { - "target": "com.amazonaws.organizations#PolicyTargetId", + "Filter": { + "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the root, organizational unit, or account whose policies\n you want to list.

\n

The regex pattern for a target ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Account - A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 \n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
", + "smithy.api#documentation": "

The type of policy that you want to include in the returned list. You must specify one\n of the following values:

\n ", "smithy.api#required": {} } }, - "Filter": { - "target": "com.amazonaws.organizations#PolicyType", + "TargetId": { + "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { - "smithy.api#documentation": "

The type of policy that you want to include in the returned list. You must specify one\n of the following values:

\n ", + "smithy.api#documentation": "

The unique identifier (ID) of the root, organizational unit, or account whose policies\n you want to list.

\n

The regex pattern for a target ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Account - A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 \n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
", "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.organizations#MaxResults", + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", "traits": { - "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" } } } }, "com.amazonaws.organizations#ListPoliciesForTargetResponse": { "type": "structure", - "members": { - "Policies": { - "target": "com.amazonaws.organizations#Policies", - "traits": { - "smithy.api#documentation": "

The list of policies that match the criteria in the request.

" - } - }, + "members": { "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" } + }, + "Policies": { + "target": "com.amazonaws.organizations#Policies", + "traits": { + "smithy.api#documentation": "

The list of policies that match the criteria in the request.

" + } } } }, "com.amazonaws.organizations#ListPoliciesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", + "MaxResults": { + "target": "com.amazonaws.organizations#MaxResults", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" } }, "Filter": { "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

Specifies the type of policy that you want to include in the response. You must\n specify one of the following values:

\n ", + "smithy.api#documentation": "

Specifies the type of policy that you want to include in the response. You must\n specify one of the following values:

\n ", "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.organizations#MaxResults", + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", "traits": { - "smithy.api#documentation": "

The total number of results that you want included \n on each page of the response. If you do not include this parameter, it defaults to a value that is specific \n to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results. Note that Organizations might return fewer results than the maximum even \n when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" } } } @@ -4310,17 +4355,17 @@ "com.amazonaws.organizations#ListPoliciesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" - } - }, "Policies": { "target": "com.amazonaws.organizations#Policies", "traits": { "smithy.api#documentation": "

A list of policies that match the filter criteria in the request. The output list\n doesn't include the policy contents. To see the content for a policy, see DescribePolicy.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" + } } } }, @@ -4350,7 +4395,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the roots that are defined in the current organization.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

\n \n

Policy types can be enabled and disabled in roots. This is distinct from whether\n they're available in the organization. When you enable all features, you make policy\n types available for use in that organization. Individual policy types can then be\n enabled and disabled in a root. To see the availability of a policy type in an\n organization, use DescribeOrganization.

\n ", + "smithy.api#documentation": "

Lists the roots that are defined in the current organization.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

\n \n

Policy types can be enabled and disabled in roots. This is distinct from whether\n they're available in the organization. When you enable all features, you make policy\n types available for use in that organization. Individual policy types can then be\n enabled and disabled in a root. To see the availability of a policy type in an\n organization, use DescribeOrganization.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4421,7 +4466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists tags for the specified resource.

\n \n

Currently, you can list tags on an account in AWS Organizations.

\n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists tags that are attached to the specified resource.

\n

You can attach tags to the following resources in AWS Organizations.

\n
    \n
  • \n

    AWS account

    \n
    • \n
  • \n

    Organization root

    \n
    • \n
  • \n

    Organizational unit (OU)

    \n
    • \n
  • \n

    Policy (any type)

    \n
    • \n
\n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4432,18 +4477,18 @@ "com.amazonaws.organizations#ListTagsForResourceRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } - }, "ResourceId": { "target": "com.amazonaws.organizations#TaggableResourceId", "traits": { - "smithy.api#documentation": "

The ID of the resource that you want to retrieve tags for.

", + "smithy.api#documentation": "

The ID of the resource with the tags to list.

\n

You can specify any of the following taggable resources.

\n
    \n
  • \n

    AWS account – specify the account ID number.

    \n
    • \n
  • \n

    Organizational unit – specify the OU ID that begins with ou- and\n looks similar to: ou-1a2b-34uvwxyz\n \n

    \n
    • \n
  • \n

    Root – specify the root ID that begins with r- and looks similar\n to: r-1a2b\n \n

    \n
    • \n
  • \n

    Policy – specify the policy ID that begins with p- andlooks\n similar to: p-12abcdefg3\n \n

    \n
    • \n
", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } } } }, @@ -4496,7 +4541,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the roots, organizational units (OUs), and accounts that the specified\n policy is attached to.

\n \n

Always check the NextToken response parameter \n for a null value when calling a List* operation. These operations can \n occasionally return an empty set of results even when there are more results available. The \n NextToken response parameter value is null \n only \n when there are no more results to display.

\n \n

This operation can be called only from the organization's\n master account or by a member account that is a delegated administrator for an AWS service.

", + "smithy.api#documentation": "

Lists all the roots, organizational units (OUs), and accounts that the specified\n policy is attached to.

\n \n

Always check the NextToken response parameter \nfor a null value when calling a List* operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken response parameter value is null \n only \nwhen there are no more results to display.

\n \n

This operation can be called only from the organization's\nmaster account or by a member account that is a delegated administrator for an AWS service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4507,12 +4552,6 @@ "com.amazonaws.organizations#ListTargetsForPolicyRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" - } - }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { @@ -4525,23 +4564,29 @@ "smithy.api#documentation": "

The unique identifier (ID) of the policy whose attachments you want to know.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a NextToken \n response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the \n value of the previous call's NextToken response to indicate where the output should \n continue from.

" + } } } }, "com.amazonaws.organizations#ListTargetsForPolicyResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.organizations#NextToken", - "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" - } - }, "Targets": { "target": "com.amazonaws.organizations#PolicyTargets", "traits": { "smithy.api#documentation": "

A list of structures, each of which contains details about one of the entities to\n which the specified policy is attached.

" } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken\n request parameter in a subsequent call to the operation to get the next part of the output. You \n should repeat this until the NextToken response element comes back as \n null.

" + } } } }, @@ -4566,7 +4611,7 @@ } }, "traits": { - "smithy.api#documentation": "

You can't remove a master account from an organization. If you want the master account\n to become a member account in another organization, you must first delete the current\n organization of the master account.

", + "smithy.api#documentation": "

You can't remove a master account from an organization. If you want the\n master account to become a member account in another organization, you must first\n delete the current organization of the master account.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -4625,17 +4670,17 @@ "com.amazonaws.organizations#MoveAccountRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.organizations#AccountId", + "DestinationParentId": { + "target": "com.amazonaws.organizations#ParentId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the account that you want to move.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

", + "smithy.api#documentation": "

The unique identifier (ID) of the root or organizational unit that you want to move\n the account to.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32\n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
", "smithy.api#required": {} } }, - "DestinationParentId": { - "target": "com.amazonaws.organizations#ParentId", + "AccountId": { + "target": "com.amazonaws.organizations#AccountId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the root or organizational unit that you want to move\n the account to.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32\n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
", + "smithy.api#documentation": "

The unique identifier (ID) of the account that you want to move.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

", "smithy.api#required": {} } }, @@ -4661,22 +4706,22 @@ "com.amazonaws.organizations#Organization": { "type": "structure", "members": { - "MasterAccountArn": { - "target": "com.amazonaws.organizations#AccountArn", + "Arn": { + "target": "com.amazonaws.organizations#OrganizationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account that is designated as the master account\n for the organization.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" } }, - "AvailablePolicyTypes": { - "target": "com.amazonaws.organizations#PolicyTypes", + "Id": { + "target": "com.amazonaws.organizations#OrganizationId", "traits": { - "smithy.api#documentation": "\n

Do not use. This field is deprecated and doesn't provide complete information\n about the policies in your organization.

\n \n

To determine the policies that are enabled and available for use in your organization,\n use the ListRoots operation instead.

" + "smithy.api#documentation": "

The unique identifier (ID) of an organization.

\n

The regex pattern for an organization ID string requires \"o-\" \n followed by from 10 to 32 lowercase letters or digits.

" } }, - "FeatureSet": { - "target": "com.amazonaws.organizations#OrganizationFeatureSet", + "MasterAccountId": { + "target": "com.amazonaws.organizations#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the functionality that currently is available to the organization. If set to\n \"ALL\", then all features are enabled and policies can be applied to accounts in the\n organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing\n functionality is available. For more information, see Enabling All Features\n in Your Organization in the AWS Organizations User Guide.

" + "smithy.api#documentation": "

The unique identifier (ID) of the master account of an organization.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

" } }, "MasterAccountEmail": { @@ -4685,22 +4730,22 @@ "smithy.api#documentation": "

The email address that is associated with the AWS account that is designated as the\n master account for the organization.

" } }, - "MasterAccountId": { - "target": "com.amazonaws.organizations#AccountId", + "AvailablePolicyTypes": { + "target": "com.amazonaws.organizations#PolicyTypes", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the master account of an organization.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

" + "smithy.api#documentation": "\n

Do not use. This field is deprecated and doesn't provide complete information\n about the policies in your organization.

\n \n

To determine the policies that are enabled and available for use in your organization,\n use the ListRoots operation instead.

" } }, - "Arn": { - "target": "com.amazonaws.organizations#OrganizationArn", + "MasterAccountArn": { + "target": "com.amazonaws.organizations#AccountArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account that is designated as the\n master account for the organization.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" } }, - "Id": { - "target": "com.amazonaws.organizations#OrganizationId", + "FeatureSet": { + "target": "com.amazonaws.organizations#OrganizationFeatureSet", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of an organization.

\n

The regex pattern for an organization ID string requires \"o-\" \n followed by from 10 to 32 lower-case letters or digits.

" + "smithy.api#documentation": "

Specifies the functionality that currently is available to the organization. If set to\n \"ALL\", then all features are enabled and policies can be applied to accounts in the\n organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing\n functionality is available. For more information, see Enabling All Features\n in Your Organization in the AWS Organizations User Guide.

" } } }, @@ -4751,10 +4796,10 @@ "com.amazonaws.organizations#OrganizationalUnit": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.organizations#OrganizationalUnitId", + "Name": { + "target": "com.amazonaws.organizations#OrganizationalUnitName", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) associated with this OU.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or \n digits.

" + "smithy.api#documentation": "

The friendly name of this OU.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, "Arn": { @@ -4763,10 +4808,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this OU.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" } }, - "Name": { - "target": "com.amazonaws.organizations#OrganizationalUnitName", + "Id": { + "target": "com.amazonaws.organizations#OrganizationalUnitId", "traits": { - "smithy.api#documentation": "

The friendly name of this OU.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" + "smithy.api#documentation": "

The unique identifier (ID) associated with this OU.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or \n digits.

" } } }, @@ -4844,7 +4889,7 @@ "Id": { "target": "com.amazonaws.organizations#ParentId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the parent entity.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n
    \n
  • \n

    Root: A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or \n digits.

    \n
    • \n
  • \n

    Organizational unit (OU): A string that begins with \"ou-\" followed by from 4 to 32\n lower-case letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lower-case letters or digits.

    \n
    • \n
" + "smithy.api#documentation": "

The unique identifier (ID) of the parent entity.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32\n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
" } } }, @@ -5022,40 +5067,40 @@ "com.amazonaws.organizations#PolicySummary": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.organizations#PolicyType", + "Description": { + "target": "com.amazonaws.organizations#PolicyDescription", "traits": { - "smithy.api#documentation": "

The type of policy.

" + "smithy.api#documentation": "

The description of the policy.

" } }, - "Name": { - "target": "com.amazonaws.organizations#PolicyName", + "Arn": { + "target": "com.amazonaws.organizations#PolicyArn", "traits": { - "smithy.api#documentation": "

The friendly name of the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" } }, - "AwsManaged": { - "target": "com.amazonaws.organizations#AwsManagedPolicy", + "Id": { + "target": "com.amazonaws.organizations#PolicyId", "traits": { - "smithy.api#documentation": "

A boolean value that indicates whether the specified policy is an AWS managed\n policy. If true, then you can attach the policy to roots, OUs, or accounts, but you\n cannot edit it.

" + "smithy.api#documentation": "

The unique identifier (ID) of the policy.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

" } }, - "Id": { - "target": "com.amazonaws.organizations#PolicyId", + "AwsManaged": { + "target": "com.amazonaws.organizations#AwsManagedPolicy", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the policy.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lower-case letters or digits.

" + "smithy.api#documentation": "

A boolean value that indicates whether the specified policy is an AWS managed\n policy. If true, then you can attach the policy to roots, OUs, or accounts, but you\n cannot edit it.

" } }, - "Description": { - "target": "com.amazonaws.organizations#PolicyDescription", + "Name": { + "target": "com.amazonaws.organizations#PolicyName", "traits": { - "smithy.api#documentation": "

The description of the policy.

" + "smithy.api#documentation": "

The friendly name of the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, - "Arn": { - "target": "com.amazonaws.organizations#PolicyArn", + "Type": { + "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" + "smithy.api#documentation": "

The type of policy.

" } } }, @@ -5076,16 +5121,16 @@ "com.amazonaws.organizations#PolicyTargetSummary": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.organizations#TargetType", + "Arn": { + "target": "com.amazonaws.organizations#GenericArn", "traits": { - "smithy.api#documentation": "

The type of the policy target.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy target.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" } }, "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) of the policy target.

\n

The regex pattern for a target ID string requires one of the \n following:

\n
    \n
  • \n

    Root: A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or \n digits.

    \n
    • \n
  • \n

    Account: A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    Organizational unit (OU): A string that begins with \"ou-\" followed by from 4 to 32 \n lower-case letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lower-case letters or digits.

    \n
    • \n
" + "smithy.api#documentation": "

The unique identifier (ID) of the policy target.

\n

The regex pattern for a target ID string requires one of the \n following:

\n
    \n
  • \n

    \n Root - A string that begins with \"r-\" followed by from 4 to 32 lowercase letters or \n digits.

    \n
    • \n
  • \n

    \n Account - A string that consists of exactly 12 digits.

    \n
    • \n
  • \n

    \n Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 \n lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second \n \"-\" dash and from 8 to 32 additional lowercase letters or digits.

    \n
    • \n
" } }, "Name": { @@ -5094,10 +5139,10 @@ "smithy.api#documentation": "

The friendly name of the policy target.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, - "Arn": { - "target": "com.amazonaws.organizations#GenericArn", + "Type": { + "target": "com.amazonaws.organizations#TargetType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy target.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" + "smithy.api#documentation": "

The type of the policy target.

" } } }, @@ -5262,17 +5307,17 @@ "com.amazonaws.organizations#RegisterDelegatedAdministratorRequest": { "type": "structure", "members": { - "ServicePrincipal": { - "target": "com.amazonaws.organizations#ServicePrincipal", + "AccountId": { + "target": "com.amazonaws.organizations#AccountId", "traits": { - "smithy.api#documentation": "

The service principal of the AWS service for which you want to make the member\n account a delegated administrator.

", + "smithy.api#documentation": "

The account ID number of the member account in the organization to register as a\n delegated administrator.

", "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.organizations#AccountId", + "ServicePrincipal": { + "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { - "smithy.api#documentation": "

The account ID number of the member account in the organization to register as a\n delegated administrator.

", + "smithy.api#documentation": "

The service principal of the AWS service for which you want to make the member\n account a delegated administrator.

", "smithy.api#required": {} } } @@ -5313,7 +5358,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified account from the organization.

\n

The removed account becomes a standalone account that isn't a member of any\n organization. It's no longer subject to any policies and is responsible for its own bill\n payments. The organization's master account is no longer charged for any expenses\n accrued by the member account after it's removed from the organization.

\n

This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.

\n \n

You can remove an account from your organization only if the account is configured\n with the information required to operate as a standalone account. When you create an\n account in an organization using the AWS Organizations console, API, or CLI commands, the\n information required of standalone accounts is not\n automatically collected. For an account that you want to make standalone, you must\n accept the end user license agreement (EULA), choose a support plan, provide and\n verify the required contact information, and provide a current payment method. AWS\n uses the payment method to charge for any billable (not free tier) AWS activity\n that occurs while the account isn't attached to an organization. To remove an\n account that doesn't yet have this information, you must sign in as the member\n account and follow the steps at To\n leave an organization when all required account information has not yet been\n provided in the AWS Organizations User Guide.\n

\n " + "smithy.api#documentation": "

Removes the specified account from the organization.

\n

The removed account becomes a standalone account that isn't a member of any\n organization. It's no longer subject to any policies and is responsible for its own bill\n payments. The organization's master account is no longer charged for any expenses\n accrued by the member account after it's removed from the organization.

\n

This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.

\n \n
    \n
  • \n

    You can remove an account from your organization only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the AWS Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For an account that\n you want to make standalone, you must choose a support plan, provide and\n verify the required contact information, and provide a current payment\n method. AWS uses the payment method to charge for any billable (not free\n tier) AWS activity that occurs while the account isn't attached to an\n organization. To remove an account that doesn't yet have this information,\n you must sign in as the member account and follow the steps at To leave an organization when all required account information has not\n yet been provided in the\n AWS Organizations User Guide.\n

    \n
    • \n
  • \n

    After the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. AWS accounts outside\n of an organization do not support tags.

    \n
    • \n
\n " } }, "com.amazonaws.organizations#RemoveAccountFromOrganizationRequest": { @@ -5341,16 +5386,10 @@ "com.amazonaws.organizations#Root": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.organizations#RootName", - "traits": { - "smithy.api#documentation": "

The friendly name of the root.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" - } - }, - "Arn": { - "target": "com.amazonaws.organizations#RootArn", + "Id": { + "target": "com.amazonaws.organizations#RootId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the root.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" + "smithy.api#documentation": "

The unique identifier (ID) for the root.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

" } }, "PolicyTypes": { @@ -5359,15 +5398,21 @@ "smithy.api#documentation": "

The types of policies that are currently enabled for the root and therefore can be\n attached to the root or to its OUs or accounts.

\n \n

Even if a policy type is shown as available in the organization, you can\n separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in\n that organization.

\n " } }, - "Id": { - "target": "com.amazonaws.organizations#RootId", + "Arn": { + "target": "com.amazonaws.organizations#RootArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the root.

\n

For more information about ARNs in Organizations, see ARN Formats Supported by\n Organizations in the AWS Organizations User Guide.

" + } + }, + "Name": { + "target": "com.amazonaws.organizations#RootName", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) for the root.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lower-case letters or digits.

" + "smithy.api#documentation": "

The friendly name of the root.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } } }, "traits": { - "smithy.api#documentation": "

Contains details about a root. A root is a top-level parent node in the hierarchy of\n an organization that can contain organizational units (OUs) and accounts. Every root\n contains every AWS account in the organization. Each root enables the accounts to be\n organized in a different way and to have different policy types enabled for use in that\n root.

" + "smithy.api#documentation": "

Contains details about a root. A root is a top-level parent node in the hierarchy of\n an organization that can contain organizational units (OUs) and accounts.\n The root contains every AWS account in the\n organization.

" } }, "com.amazonaws.organizations#RootArn": { @@ -5453,23 +5498,23 @@ "com.amazonaws.organizations#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.organizations#TagKey", + "Value": { + "target": "com.amazonaws.organizations#TagValue", "traits": { - "smithy.api#documentation": "

The key identifier, or name, of the tag.

", + "smithy.api#documentation": "

The string value that's associated with the key of the tag. You can set the value of a\n tag to an empty string, but you can't set the value of a tag to null.

", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.organizations#TagValue", + "Key": { + "target": "com.amazonaws.organizations#TagKey", "traits": { - "smithy.api#documentation": "

The string value that's associated with the key of the tag. You can set the value of a\n tag to an empty string, but you can't set the value of a tag to null.

", + "smithy.api#documentation": "

The key identifier, or name, of the tag.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A custom key-value pair associated with a resource such as an account within your\n organization.

" + "smithy.api#documentation": "

A custom key-value pair associated with a resource within your organization.

\n

You can attach tags to any of the following organization resources.

\n
    \n
  • \n

    AWS account

    \n
    • \n
  • \n

    Organizational unit (OU)

    \n
    • \n
  • \n

    Organization root

    \n
    • \n
  • \n

    Policy

    \n
    • \n
" } }, "com.amazonaws.organizations#TagKey": { @@ -5520,23 +5565,23 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to the specified resource.

\n \n

Currently, you can tag and untag accounts in AWS Organizations.

\n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Adds one or more tags to the specified resource.

\n

Currently, you can attach tags to the following resources in AWS Organizations.

\n
    \n
  • \n

    AWS account

    \n
    • \n
  • \n

    Organization root

    \n
    • \n
  • \n

    Organizational unit (OU)

    \n
    • \n
  • \n

    Policy (any type)

    \n
    • \n
\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.organizations#Tags", + "ResourceId": { + "target": "com.amazonaws.organizations#TaggableResourceId", "traits": { - "smithy.api#documentation": "

The tag to add to the specified resource. You must specify both a tag key and value.\n You can set the value of a tag to an empty string, but you can't set it to null.

", + "smithy.api#documentation": "

The ID of the resource to add a tag to.

", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.organizations#TaggableResourceId", + "Tags": { + "target": "com.amazonaws.organizations#Tags", "traits": { - "smithy.api#documentation": "

The ID of the resource to add a tag to.

", + "smithy.api#documentation": "

A list of tags to add to the specified resource.

\n

You can specify any of the following taggable resources.

\n
    \n
  • \n

    AWS account – specify the account ID number.

    \n
    • \n
  • \n

    Organizational unit – specify the OU ID that begins with ou- and\n looks similar to: ou-1a2b-34uvwxyz\n \n

    \n
    • \n
  • \n

    Root – specify the root ID that begins with r- and looks similar\n to: r-1a2b\n \n

    \n
    • \n
  • \n

    Policy – specify the policy ID that begins with p- andlooks\n similar to: p-12abcdefg3\n \n

    \n
    • \n
\n

For\n each tag in the list, you must specify both a tag key and a value. You can set the value\n to an empty string, but you can't set it to null.

\n \n

If any one of the tags is invalid or if you exceed the allowed number of tags for\n an account user, then the entire request fails and the account is not\n created.

\n ", "smithy.api#required": {} } } @@ -5557,9 +5602,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 12 + "max": 130 }, - "smithy.api#pattern": "^\\d{12}$" + "smithy.api#pattern": "^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})|(^p-[0-9a-zA-Z_]{8,128})$" } }, "com.amazonaws.organizations#Tags": { @@ -5585,7 +5630,7 @@ } }, "traits": { - "smithy.api#documentation": "

We can't find a root, OU, or account with the TargetId that you\n specified.

", + "smithy.api#documentation": "

We can't find a root, OU, account, or policy with the TargetId that you\n specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -5615,11 +5660,11 @@ "com.amazonaws.organizations#TooManyRequestsException": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.organizations#ExceptionType" - }, "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" + }, + "Type": { + "target": "com.amazonaws.organizations#ExceptionType" } }, "traits": { @@ -5673,7 +5718,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a tag from the specified resource.

\n \n

Currently, you can tag and untag accounts in AWS Organizations.

\n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Removes any tags with the specified keys from the specified resource.

\n

You can attach tags to the following resources in AWS Organizations.

\n
    \n
  • \n

    AWS account

    \n
    • \n
  • \n

    Organization root

    \n
    • \n
  • \n

    Organizational unit (OU)

    \n
    • \n
  • \n

    Policy (any type)

    \n
    • \n
\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#UntagResourceRequest": { @@ -5682,14 +5727,14 @@ "ResourceId": { "target": "com.amazonaws.organizations#TaggableResourceId", "traits": { - "smithy.api#documentation": "

The ID of the resource to remove the tag from.

", + "smithy.api#documentation": "

The ID of the resource to remove a tag from.

\n

You can specify any of the following taggable resources.

\n
    \n
  • \n

    AWS account – specify the account ID number.

    \n
    • \n
  • \n

    Organizational unit – specify the OU ID that begins with ou- and\n looks similar to: ou-1a2b-34uvwxyz\n \n

    \n
    • \n
  • \n

    Root – specify the root ID that begins with r- and looks similar\n to: r-1a2b\n \n

    \n
    • \n
  • \n

    Policy – specify the policy ID that begins with p- andlooks\n similar to: p-12abcdefg3\n \n

    \n
    • \n
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.organizations#TagKeys", "traits": { - "smithy.api#documentation": "

The tag to remove from the specified resource.

", + "smithy.api#documentation": "

The list of keys for tags to remove from the specified resource.

", "smithy.api#required": {} } } @@ -5730,24 +5775,24 @@ } ], "traits": { - "smithy.api#documentation": "

Renames the specified organizational unit (OU). The ID and ARN don't change. The child\n OUs and accounts remain in place, and any attached policies of the OU remain attached.

\n

This operation can be called only from the organization's master account.

" + "smithy.api#documentation": "

Renames the specified organizational unit (OU). The ID and ARN don't change. The child\n OUs and accounts remain in place, and any attached policies of the OU remain\n attached.

\n

This operation can be called only from the organization's master account.

" } }, "com.amazonaws.organizations#UpdateOrganizationalUnitRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.organizations#OrganizationalUnitName", + "traits": { + "smithy.api#documentation": "

The new name that you want to assign to the OU.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" + } + }, "OrganizationalUnitId": { "target": "com.amazonaws.organizations#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the OU that you want to rename. You can get the ID from\n the ListOrganizationalUnitsForParent operation.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or \n digits.

", "smithy.api#required": {} } - }, - "Name": { - "target": "com.amazonaws.organizations#OrganizationalUnitName", - "traits": { - "smithy.api#documentation": "

The new name that you want to assign to the OU.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" - } } } }, @@ -5828,17 +5873,17 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.organizations#PolicyName", - "traits": { - "smithy.api#documentation": "

If provided, the new name for the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" - } - }, "Description": { "target": "com.amazonaws.organizations#PolicyDescription", "traits": { "smithy.api#documentation": "

If provided, the new description for the policy.

" } + }, + "Name": { + "target": "com.amazonaws.organizations#PolicyName", + "traits": { + "smithy.api#documentation": "

If provided, the new name for the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" + } } } }, 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 e747301bbaad..3ca55ca7d19f 100644 --- a/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json +++ b/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json @@ -111,23 +111,23 @@ "com.amazonaws.outposts#CreateOutpostInput": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.outposts#OutpostName" + "AvailabilityZoneId": { + "target": "com.amazonaws.outposts#AvailabilityZoneId" }, "AvailabilityZone": { "target": "com.amazonaws.outposts#AvailabilityZone" }, - "AvailabilityZoneId": { - "target": "com.amazonaws.outposts#AvailabilityZoneId" + "Name": { + "target": "com.amazonaws.outposts#OutpostName" + }, + "Description": { + "target": "com.amazonaws.outposts#OutpostDescription" }, "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { "smithy.api#required": {} } - }, - "Description": { - "target": "com.amazonaws.outposts#OutpostDescription" } } }, @@ -320,12 +320,6 @@ "com.amazonaws.outposts#GetOutpostInstanceTypesInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.outposts#Token", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { @@ -333,6 +327,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, "MaxResults": { "target": "com.amazonaws.outposts#MaxResults1000", "traits": { @@ -344,17 +344,17 @@ "com.amazonaws.outposts#GetOutpostInstanceTypesOutput": { "type": "structure", "members": { - "OutpostArn": { - "target": "com.amazonaws.outposts#OutpostArn" - }, - "OutpostId": { - "target": "com.amazonaws.outposts#OutpostId" + "NextToken": { + "target": "com.amazonaws.outposts#Token" }, "InstanceTypes": { "target": "com.amazonaws.outposts#InstanceTypeListDefinition" }, - "NextToken": { - "target": "com.amazonaws.outposts#Token" + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostId" + }, + "OutpostArn": { + "target": "com.amazonaws.outposts#OutpostArn" } } }, @@ -447,17 +447,17 @@ "com.amazonaws.outposts#ListOutpostsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.outposts#Token", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, "MaxResults": { "target": "com.amazonaws.outposts#MaxResults1000", "traits": { "smithy.api#httpQuery": "MaxResults" } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } } } }, @@ -525,11 +525,11 @@ "com.amazonaws.outposts#ListSitesOutput": { "type": "structure", "members": { - "Sites": { - "target": "com.amazonaws.outposts#siteListDefinition" - }, "NextToken": { "target": "com.amazonaws.outposts#Token" + }, + "Sites": { + "target": "com.amazonaws.outposts#siteListDefinition" } } }, @@ -560,32 +560,32 @@ "com.amazonaws.outposts#Outpost": { "type": "structure", "members": { - "AvailabilityZoneId": { - "target": "com.amazonaws.outposts#AvailabilityZoneId" + "OutpostArn": { + "target": "com.amazonaws.outposts#OutpostArn" }, "AvailabilityZone": { "target": "com.amazonaws.outposts#AvailabilityZone" }, + "AvailabilityZoneId": { + "target": "com.amazonaws.outposts#AvailabilityZoneId" + }, "LifeCycleStatus": { "target": "com.amazonaws.outposts#LifeCycleStatus" }, - "OutpostArn": { - "target": "com.amazonaws.outposts#OutpostArn" - }, "Name": { "target": "com.amazonaws.outposts#OutpostName" }, "SiteId": { "target": "com.amazonaws.outposts#SiteId" }, - "OutpostId": { - "target": "com.amazonaws.outposts#OutpostId" + "Description": { + "target": "com.amazonaws.outposts#OutpostDescription" }, "OwnerId": { "target": "com.amazonaws.outposts#OwnerId" }, - "Description": { - "target": "com.amazonaws.outposts#OutpostDescription" + "OutpostId": { + "target": "com.amazonaws.outposts#OutpostId" } }, "traits": { @@ -667,7 +667,7 @@ "sdkId": "Outposts", "arnNamespace": "outposts", "cloudFormationName": "Outposts", - "cloudTrailEventSource": "model.service.olaf.outposts.amazonaws.com" + "cloudTrailEventSource": "outposts.amazonaws.com" }, "aws.auth#sigv4": { "name": "outposts" @@ -704,17 +704,17 @@ "com.amazonaws.outposts#Site": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.outposts#AccountId" - }, "Name": { "target": "com.amazonaws.outposts#SiteName" }, + "Description": { + "target": "com.amazonaws.outposts#SiteDescription" + }, "SiteId": { "target": "com.amazonaws.outposts#SiteId" }, - "Description": { - "target": "com.amazonaws.outposts#SiteDescription" + "AccountId": { + "target": "com.amazonaws.outposts#AccountId" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/personalize-events.2018-03-22.json b/codegen/sdk-codegen/aws-models/personalize-events.2018-03-22.json index 09cec64f522a..facdc490cda6 100644 --- a/codegen/sdk-codegen/aws-models/personalize-events.2018-03-22.json +++ b/codegen/sdk-codegen/aws-models/personalize-events.2018-03-22.json @@ -35,6 +35,12 @@ "operations": [ { "target": "com.amazonaws.personalizeevents#PutEvents" + }, + { + "target": "com.amazonaws.personalizeevents#PutItems" + }, + { + "target": "com.amazonaws.personalizeevents#PutUsers" } ], "traits": { @@ -42,16 +48,26 @@ "sdkId": "Personalize Events", "arnNamespace": "personalize", "cloudFormationName": "PersonalizeEvents", - "cloudTrailEventSource": "events.personalize.services.amazonaws.com" + "cloudTrailEventSource": "personalizeevents.amazonaws.com" }, "aws.auth#sigv4": { "name": "personalize" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Amazon Personalize can consume real-time user event data, such as stream or click data, and use\n it for model training either alone or combined with historical data. For more information see recording-events.

", "smithy.api#title": "Amazon Personalize Events" } }, + "com.amazonaws.personalizeevents#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "arn:([a-z\\d-]+):personalize:.*:.*:.+" + } + }, "com.amazonaws.personalizeevents#Date": { "type": "timestamp" }, @@ -61,27 +77,50 @@ "com.amazonaws.personalizeevents#Event": { "type": "structure", "members": { + "eventValue": { + "target": "com.amazonaws.personalizeevents#FloatType", + "traits": { + "smithy.api#documentation": "

The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

" + } + }, "eventType": { "target": "com.amazonaws.personalizeevents#StringType", "traits": { - "smithy.api#documentation": "

The type of event. This property corresponds to the EVENT_TYPE\n field of the Interactions schema.

", + "smithy.api#documentation": "

The type of event, such as click or download. This property corresponds to the EVENT_TYPE\n field of your Interactions schema and depends on the types of events you are tracking.

", "smithy.api#required": {} } }, + "recommendationId": { + "target": "com.amazonaws.personalizeevents#RecommendationId", + "traits": { + "smithy.api#documentation": "

The ID of the recommendation.

" + } + }, + "itemId": { + "target": "com.amazonaws.personalizeevents#ItemId", + "traits": { + "smithy.api#documentation": "

The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

" + } + }, "properties": { "target": "com.amazonaws.personalizeevents#SynthesizedJsonEventPropertiesJSON", "traits": { - "smithy.api#documentation": "

A string map of event-specific data that you might choose to record. For example, if a\n user rates a movie on your site, you might send the movie ID and rating, and the number of\n movie ratings made by the user.

\n

Each item in the map consists of a key-value pair. For example,

\n

\n {\"itemId\": \"movie1\"}\n

\n

\n {\"itemId\": \"movie2\", \"eventValue\": \"4.5\"}\n

\n

\n {\"itemId\": \"movie3\", \"eventValue\": \"3\", \"numberOfRatings\": \"12\"}\n

\n

The keys use camel case names that match the fields in the Interactions\n schema. The itemId and eventValue keys correspond to the\n ITEM_ID and EVENT_VALUE fields.\n In the above example, the eventType might be 'MovieRating' with\n eventValue being the rating. The numberOfRatings would match the\n 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A string map of event-specific data that you might choose to record. For example, if a\n user rates a movie on your site, other than movie ID (itemId) and rating (eventValue)\n , you might also send the number of movie ratings made by the user.

\n

Each item in the map consists of a key-value pair. For example,

\n \n

\n {\"numberOfRatings\": \"12\"}\n

\n

The keys use camel case names that match the fields in the Interactions\n schema. In the above example, the numberOfRatings would match the\n 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

" } }, "sentAt": { "target": "com.amazonaws.personalizeevents#Date", "traits": { - "smithy.api#documentation": "

The timestamp on the client side when the event occurred.

", + "smithy.api#documentation": "

The timestamp (in Unix time) on the client side when the event occurred.

", "smithy.api#required": {} } }, + "impression": { + "target": "com.amazonaws.personalizeevents#Impression", + "traits": { + "smithy.api#documentation": "

A list of item IDs that represents the sequence of items you have shown the user. For example, [\"itemId1\", \"itemId2\", \"itemId3\"].

" + } + }, "eventId": { "target": "com.amazonaws.personalizeevents#StringType", "traits": { @@ -105,6 +144,24 @@ } } }, + "com.amazonaws.personalizeevents#FloatType": { + "type": "float", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.personalizeevents#Impression": { + "type": "list", + "member": { + "target": "com.amazonaws.personalizeevents#ItemId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.personalizeevents#InvalidInputException": { "type": "structure", "members": { @@ -118,6 +175,48 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.personalizeevents#Item": { + "type": "structure", + "members": { + "itemId": { + "target": "com.amazonaws.personalizeevents#StringType", + "traits": { + "smithy.api#documentation": "

The ID associated with the item.

", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.personalizeevents#SynthesizedJsonItemProperties", + "traits": { + "smithy.api#documentation": "

A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example,\n

\n

\n {\"numberOfRatings\": \"12\"}\n

\n

The keys use camel case names that match the fields in the Items\n schema. In the above example, the numberOfRatings would match the\n 'NUMBER_OF_RATINGS' field defined in the Items schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents item metadata added to an Items dataset using the \n PutItems API.

" + } + }, + "com.amazonaws.personalizeevents#ItemId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.personalizeevents#ItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.personalizeevents#Item" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.personalizeevents#PutEvents": { "type": "operation", "input": { @@ -129,7 +228,7 @@ } ], "traits": { - "smithy.api#documentation": "

Records user interaction event data.

", + "smithy.api#documentation": "

Records user interaction event data. For more information see event-record-api.

", "smithy.api#http": { "method": "POST", "uri": "/events", @@ -140,6 +239,12 @@ "com.amazonaws.personalizeevents#PutEventsRequest": { "type": "structure", "members": { + "userId": { + "target": "com.amazonaws.personalizeevents#UserId", + "traits": { + "smithy.api#documentation": "

The user associated with the event.

" + } + }, "eventList": { "target": "com.amazonaws.personalizeevents#EventList", "traits": { @@ -147,10 +252,11 @@ "smithy.api#required": {} } }, - "userId": { - "target": "com.amazonaws.personalizeevents#UserId", + "sessionId": { + "target": "com.amazonaws.personalizeevents#StringType", "traits": { - "smithy.api#documentation": "

The user associated with the event.

" + "smithy.api#documentation": "

The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. \n Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information see event-record-api.

", + "smithy.api#required": {} } }, "trackingId": { @@ -159,16 +265,113 @@ "smithy.api#documentation": "

The tracking ID for the event.\n The ID is generated by a call to the\n CreateEventTracker API.

", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.personalizeevents#PutItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalizeevents#PutItemsRequest" + }, + "errors": [ + { + "target": "com.amazonaws.personalizeevents#InvalidInputException" }, - "sessionId": { - "target": "com.amazonaws.personalizeevents#StringType", + { + "target": "com.amazonaws.personalizeevents#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more items to an Items dataset. For more information see \n importing-items.

", + "smithy.api#http": { + "method": "POST", + "uri": "/items", + "code": 200 + } + } + }, + "com.amazonaws.personalizeevents#PutItemsRequest": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.personalizeevents#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Items dataset you are adding the item or items to.

", + "smithy.api#required": {} + } + }, + "items": { + "target": "com.amazonaws.personalizeevents#ItemList", + "traits": { + "smithy.api#documentation": "

A list of item data.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalizeevents#PutUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalizeevents#PutUsersRequest" + }, + "errors": [ + { + "target": "com.amazonaws.personalizeevents#InvalidInputException" + }, + { + "target": "com.amazonaws.personalizeevents#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more users to a Users dataset. For more information see \n importing-users.

", + "smithy.api#http": { + "method": "POST", + "uri": "/users", + "code": 200 + } + } + }, + "com.amazonaws.personalizeevents#PutUsersRequest": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.personalizeevents#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Users dataset you are adding the user or users to.

", + "smithy.api#required": {} + } + }, + "users": { + "target": "com.amazonaws.personalizeevents#UserList", "traits": { - "smithy.api#documentation": "

The session ID associated with the user's visit.

", + "smithy.api#documentation": "

A list of user data.

", "smithy.api#required": {} } } } }, + "com.amazonaws.personalizeevents#RecommendationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.personalizeevents#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.personalizeevents#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Could not find the specified resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.personalizeevents#StringType": { "type": "string", "traits": { @@ -188,6 +391,47 @@ "smithy.api#mediaType": "application/json" } }, + "com.amazonaws.personalizeevents#SynthesizedJsonItemProperties": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.personalizeevents#SynthesizedJsonUserProperties": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.personalizeevents#User": { + "type": "structure", + "members": { + "properties": { + "target": "com.amazonaws.personalizeevents#SynthesizedJsonUserProperties", + "traits": { + "smithy.api#documentation": "

A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example,\n

\n

\n {\"numberOfVideosWatched\": \"45\"}\n

\n

The keys use camel case names that match the fields in the Users\n schema. In the above example, the numberOfVideosWatched would match the\n 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema.

" + } + }, + "userId": { + "target": "com.amazonaws.personalizeevents#StringType", + "traits": { + "smithy.api#documentation": "

The ID associated with the user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents user metadata added to a Users dataset using the \n PutUsers API.

" + } + }, "com.amazonaws.personalizeevents#UserId": { "type": "string", "traits": { @@ -196,6 +440,18 @@ "max": 256 } } + }, + "com.amazonaws.personalizeevents#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.personalizeevents#User" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } } } } diff --git a/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json b/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json index 6577e91165ce..7516206b16d1 100644 --- a/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json +++ b/codegen/sdk-codegen/aws-models/personalize-runtime.2018-05-22.json @@ -45,7 +45,7 @@ "sdkId": "Personalize Runtime", "arnNamespace": "personalize", "cloudFormationName": "PersonalizeRuntime", - "cloudTrailEventSource": "runtime.personalize.services.amazonaws.com" + "cloudTrailEventSource": "personalizeruntime.amazonaws.com" }, "aws.auth#sigv4": { "name": "personalize" @@ -132,31 +132,37 @@ "com.amazonaws.personalizeruntime#GetPersonalizedRankingRequest": { "type": "structure", "members": { - "campaignArn": { + "filterArn": { "target": "com.amazonaws.personalizeruntime#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized\n ranking.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a filter you created to include or exclude items from recommendations for a given user.

" } }, - "userId": { - "target": "com.amazonaws.personalizeruntime#UserID", + "context": { + "target": "com.amazonaws.personalizeruntime#Context", "traits": { - "smithy.api#documentation": "

The user for which you want the campaign to provide a personalized ranking.

", + "smithy.api#documentation": "

The contextual metadata to use when getting recommendations. Contextual metadata includes\n any interaction information that might be relevant when getting a user's recommendations, such\n as the user's current location or device type.

" + } + }, + "campaignArn": { + "target": "com.amazonaws.personalizeruntime#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized\n ranking.

", "smithy.api#required": {} } }, "inputList": { "target": "com.amazonaws.personalizeruntime#InputList", "traits": { - "smithy.api#documentation": "

A list of items (itemId's) to rank. If an item was not included in the training dataset,\n the item is appended to the end of the reranked list. The maximum is 500.

", + "smithy.api#documentation": "

A list of items (by itemId) to rank. If an item was not included in the training dataset,\n the item is appended to the end of the reranked list. The maximum is 500.

", "smithy.api#required": {} } }, - "context": { - "target": "com.amazonaws.personalizeruntime#Context", + "userId": { + "target": "com.amazonaws.personalizeruntime#UserID", "traits": { - "smithy.api#documentation": "

The contextual metadata to use when getting recommendations. Contextual metadata includes\n any interaction information that might be relevant when getting a user's recommendations, such\n as the user's current location or device type.

" + "smithy.api#documentation": "

The user for which you want the campaign to provide a personalized ranking.

", + "smithy.api#required": {} } } } @@ -169,6 +175,12 @@ "traits": { "smithy.api#documentation": "

A list of items in order of most likely interest to the user. The maximum is 500.

" } + }, + "recommendationId": { + "target": "com.amazonaws.personalizeruntime#RecommendationID", + "traits": { + "smithy.api#documentation": "

The ID of the recommendation.

" + } } } }, @@ -201,12 +213,6 @@ "com.amazonaws.personalizeruntime#GetRecommendationsRequest": { "type": "structure", "members": { - "context": { - "target": "com.amazonaws.personalizeruntime#Context", - "traits": { - "smithy.api#documentation": "

The contextual metadata to use when getting recommendations. Contextual metadata includes\n any interaction information that might be relevant when getting a user's recommendations, such\n as the user's current location or device type.

" - } - }, "userId": { "target": "com.amazonaws.personalizeruntime#UserID", "traits": { @@ -220,10 +226,22 @@ "smithy.api#required": {} } }, + "context": { + "target": "com.amazonaws.personalizeruntime#Context", + "traits": { + "smithy.api#documentation": "

The contextual metadata to use when getting recommendations. Contextual metadata includes\n any interaction information that might be relevant when getting a user's recommendations, such\n as the user's current location or device type.

" + } + }, + "numResults": { + "target": "com.amazonaws.personalizeruntime#NumResults", + "traits": { + "smithy.api#documentation": "

The number of results to return. The default is 25. The maximum is 500.

" + } + }, "filterArn": { "target": "com.amazonaws.personalizeruntime#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the filter to apply to the returned recommendations. For more information, see\n Using Filters with Amazon Personalize.

" + "smithy.api#documentation": "

The ARN of the filter to apply to the returned recommendations. For more information, see\n Using Filters with Amazon Personalize.

\n

When using this parameter, be sure the filter resource is ACTIVE.

" } }, "itemId": { @@ -231,18 +249,18 @@ "traits": { "smithy.api#documentation": "

The item ID to provide recommendations for.

\n

Required for RELATED_ITEMS recipe type.

" } - }, - "numResults": { - "target": "com.amazonaws.personalizeruntime#NumResults", - "traits": { - "smithy.api#documentation": "

The number of results to return. The default is 25. The maximum is 500.

" - } } } }, "com.amazonaws.personalizeruntime#GetRecommendationsResponse": { "type": "structure", "members": { + "recommendationId": { + "target": "com.amazonaws.personalizeruntime#RecommendationID", + "traits": { + "smithy.api#documentation": "

The ID of the recommendation.

" + } + }, "itemList": { "target": "com.amazonaws.personalizeruntime#ItemList", "traits": { @@ -313,6 +331,9 @@ "smithy.api#documentation": "

An object that identifies an item.

\n

The and APIs return a list of\n PredictedItems.

" } }, + "com.amazonaws.personalizeruntime#RecommendationID": { + "type": "string" + }, "com.amazonaws.personalizeruntime#ResourceNotFoundException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/personalize.2018-05-22.json b/codegen/sdk-codegen/aws-models/personalize.2018-05-22.json index d35b8dc8a729..3807107eb2c6 100644 --- a/codegen/sdk-codegen/aws-models/personalize.2018-05-22.json +++ b/codegen/sdk-codegen/aws-models/personalize.2018-05-22.json @@ -41,58 +41,52 @@ "com.amazonaws.personalize#Algorithm": { "type": "structure", "members": { - "defaultResourceConfig": { - "target": "com.amazonaws.personalize#ResourceConfig", + "trainingInputMode": { + "target": "com.amazonaws.personalize#TrainingInputMode", "traits": { - "smithy.api#documentation": "

Specifies the default maximum number of training jobs and parallel training jobs.

" + "smithy.api#documentation": "

The training input mode.

" } }, - "algorithmArn": { - "target": "com.amazonaws.personalize#Arn", + "defaultHyperParameters": { + "target": "com.amazonaws.personalize#HyperParameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm.

" + "smithy.api#documentation": "

Specifies the default hyperparameters.

" } }, - "name": { - "target": "com.amazonaws.personalize#Name", + "defaultHyperParameterRanges": { + "target": "com.amazonaws.personalize#DefaultHyperParameterRanges", "traits": { - "smithy.api#documentation": "

The name of the algorithm.

" + "smithy.api#documentation": "

Specifies the default hyperparameters, their ranges, and whether they\n are tunable. A tunable hyperparameter can\n have its value determined during hyperparameter optimization (HPO).

" } }, - "algorithmImage": { - "target": "com.amazonaws.personalize#AlgorithmImage", + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The URI of the Docker container for the algorithm image.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the algorithm was last updated.

" } }, - "roleArn": { + "algorithmArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role.

" - } - }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", - "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the algorithm was last updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm.

" } }, - "defaultHyperParameters": { - "target": "com.amazonaws.personalize#HyperParameters", + "roleArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

Specifies the default hyperparameters.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role.

" } }, - "trainingInputMode": { - "target": "com.amazonaws.personalize#TrainingInputMode", + "defaultResourceConfig": { + "target": "com.amazonaws.personalize#ResourceConfig", "traits": { - "smithy.api#documentation": "

The training input mode.

" + "smithy.api#documentation": "

Specifies the default maximum number of training jobs and parallel training jobs.

" } }, - "defaultHyperParameterRanges": { - "target": "com.amazonaws.personalize#DefaultHyperParameterRanges", + "algorithmImage": { + "target": "com.amazonaws.personalize#AlgorithmImage", "traits": { - "smithy.api#documentation": "

Specifies the default hyperparameters, their ranges, and whether they\n are tunable. A tunable hyperparameter can\n have its value determined during hyperparameter optimization (HPO).

" + "smithy.api#documentation": "

The URI of the Docker container for the algorithm image.

" } }, "creationDateTime": { @@ -100,6 +94,12 @@ "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the algorithm was created.

" } + }, + "name": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "

The name of the algorithm.

" + } } }, "traits": { @@ -266,7 +266,7 @@ "sdkId": "Personalize", "arnNamespace": "personalize", "cloudFormationName": "Personalize", - "cloudTrailEventSource": "personalize.services.amazonaws.com" + "cloudTrailEventSource": "personalize.amazonaws.com" }, "aws.auth#sigv4": { "name": "personalize" @@ -344,28 +344,40 @@ "com.amazonaws.personalize#BatchInferenceJob": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.personalize#Name", + "jobInput": { + "target": "com.amazonaws.personalize#BatchInferenceJobInput", "traits": { - "smithy.api#documentation": "

The name of the batch inference job.

" + "smithy.api#documentation": "

The Amazon S3 path that leads to the input data used to generate the batch inference\n job.

" } }, - "failureReason": { - "target": "com.amazonaws.personalize#FailureReason", + "batchInferenceJobConfig": { + "target": "com.amazonaws.personalize#BatchInferenceJobConfig", "traits": { - "smithy.api#documentation": "

If the batch inference job failed, the reason for the failure.

" + "smithy.api#documentation": "

A string to string map of the configuration details of a batch inference job.

" } }, - "solutionVersionArn": { + "jobOutput": { + "target": "com.amazonaws.personalize#BatchInferenceJobOutput", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket that contains the output data generated by the batch inference job.

" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "

The status of the batch inference job. The status is one of the following values:

\n
    \n
  • \n

    PENDING

    \n
    • \n
  • \n

    IN PROGRESS

    \n
    • \n
  • \n

    ACTIVE

    \n
    • \n
  • \n

    CREATE FAILED

    \n
    • \n
" + } + }, + "batchInferenceJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version from which the batch inference job\n was created.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

" } }, - "roleArn": { - "target": "com.amazonaws.personalize#RoleArn", + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

" + "smithy.api#documentation": "

If the batch inference job failed, the reason for the failure.

" } }, "numResults": { @@ -374,34 +386,34 @@ "smithy.api#documentation": "

The number of recommendations generated by the batch inference job. This number includes\n the error messages generated for failed input records.

" } }, - "jobInput": { - "target": "com.amazonaws.personalize#BatchInferenceJobInput", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon S3 path that leads to the input data used to generate the batch inference\n job.

" + "smithy.api#documentation": "

The time at which the batch inference job was created.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "jobName": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was last updated.

" + "smithy.api#documentation": "

The name of the batch inference job.

" } }, - "status": { - "target": "com.amazonaws.personalize#Status", + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The status of the batch inference job. The status is one of the following values:

\n
    \n
  • \n

    PENDING

    \n
    • \n
  • \n

    IN PROGRESS

    \n
    • \n
  • \n

    ACTIVE

    \n
    • \n
  • \n

    CREATE FAILED

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version from which the batch inference job\n was created.

" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was created.

" + "smithy.api#documentation": "

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

" } }, - "jobOutput": { - "target": "com.amazonaws.personalize#BatchInferenceJobOutput", + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that contains the output data generated by the batch inference job.

" + "smithy.api#documentation": "

The time at which the batch inference job was last updated.

" } }, "filterArn": { @@ -409,16 +421,24 @@ "traits": { "smithy.api#documentation": "

The ARN of the filter used on the batch inference job.

" } - }, - "batchInferenceJobArn": { - "target": "com.amazonaws.personalize#Arn", + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on a batch inference job.

" + } + }, + "com.amazonaws.personalize#BatchInferenceJobConfig": { + "type": "structure", + "members": { + "itemExplorationConfig": { + "target": "com.amazonaws.personalize#HyperParameters", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

" + "smithy.api#documentation": "

A string to string map specifying the inference hyperparameters you wish to use for hyperparameter optimization. See customizing-solution-config-hpo.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information on a batch inference job.

" + "smithy.api#documentation": "

The configuration details of a batch inference job.

" } }, "com.amazonaws.personalize#BatchInferenceJobInput": { @@ -454,16 +474,22 @@ "com.amazonaws.personalize#BatchInferenceJobSummary": { "type": "structure", "members": { - "solutionVersionArn": { + "batchInferenceJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the solution version used by the batch inference job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "jobName": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was last updated.

" + "smithy.api#documentation": "

The name of the batch inference job.

" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "

The status of the batch inference job. The status is one of the following values:

\n
    \n
  • \n

    PENDING

    \n
    • \n
  • \n

    IN PROGRESS

    \n
    • \n
  • \n

    ACTIVE

    \n
    • \n
  • \n

    CREATE FAILED

    \n
    • \n
" } }, "failureReason": { @@ -472,28 +498,22 @@ "smithy.api#documentation": "

If the batch inference job failed, the reason for the failure.

" } }, - "batchInferenceJobArn": { + "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

" + "smithy.api#documentation": "

The ARN of the solution version used by the batch inference job.

" } }, - "creationDateTime": { + "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was created.

" - } - }, - "status": { - "target": "com.amazonaws.personalize#Status", - "traits": { - "smithy.api#documentation": "

The status of the batch inference job. The status is one of the following values:

\n
    \n
  • \n

    PENDING

    \n
    • \n
  • \n

    IN PROGRESS

    \n
    • \n
  • \n

    ACTIVE

    \n
    • \n
  • \n

    CREATE FAILED

    \n
    • \n
" + "smithy.api#documentation": "

The time at which the batch inference job was last updated.

" } }, - "jobName": { - "target": "com.amazonaws.personalize#Name", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The name of the batch inference job.

" + "smithy.api#documentation": "

The time at which the batch inference job was created.

" } } }, @@ -522,19 +542,16 @@ "com.amazonaws.personalize#Campaign": { "type": "structure", "members": { - "latestCampaignUpdate": { - "target": "com.amazonaws.personalize#CampaignUpdateSummary" - }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The date and time (in Unix format) that the campaign was last updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a specific version of the solution.

" } }, - "minProvisionedTPS": { - "target": "com.amazonaws.personalize#TransactionsPerSecond", + "campaignArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" } }, "name": { @@ -543,28 +560,37 @@ "smithy.api#documentation": "

The name of the campaign.

" } }, - "status": { - "target": "com.amazonaws.personalize#Status", + "campaignConfig": { + "target": "com.amazonaws.personalize#CampaignConfig", "traits": { - "smithy.api#documentation": "

The status of the campaign.

\n

A campaign can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" + "smithy.api#documentation": "

The configuration details of a campaign.

" } }, - "creationDateTime": { + "minProvisionedTPS": { + "target": "com.amazonaws.personalize#TransactionsPerSecond", + "traits": { + "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second.

" + } + }, + "latestCampaignUpdate": { + "target": "com.amazonaws.personalize#CampaignUpdateSummary" + }, + "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The date and time (in Unix format) that the campaign was created.

" + "smithy.api#documentation": "

The date and time (in Unix format) that the campaign was last updated.

" } }, - "solutionVersionArn": { - "target": "com.amazonaws.personalize#Arn", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a specific version of the solution.

" + "smithy.api#documentation": "

The date and time (in Unix format) that the campaign was created.

" } }, - "campaignArn": { - "target": "com.amazonaws.personalize#Arn", + "status": { + "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" + "smithy.api#documentation": "

The status of the campaign.

\n

A campaign can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" } }, "failureReason": { @@ -578,6 +604,20 @@ "smithy.api#documentation": "

Describes a deployed solution version, otherwise known as a campaign.\n For more information on campaigns, see CreateCampaign.

" } }, + "com.amazonaws.personalize#CampaignConfig": { + "type": "structure", + "members": { + "itemExplorationConfig": { + "target": "com.amazonaws.personalize#HyperParameters", + "traits": { + "smithy.api#documentation": "

A string to string map specifying the inference hyperparameters you wish to use for hyperparameter optimization. See customizing-solution-config-hpo.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of a campaign.

" + } + }, "com.amazonaws.personalize#CampaignSummary": { "type": "structure", "members": { @@ -587,24 +627,12 @@ "smithy.api#documentation": "

The date and time (in Unix time) that the campaign was last updated.

" } }, - "campaignArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" - } - }, "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the campaign.

" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", - "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the campaign was created.

" - } - }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { @@ -616,6 +644,18 @@ "traits": { "smithy.api#documentation": "

If a campaign fails, the reason behind the failure.

" } + }, + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

The date and time (in Unix time) that the campaign was created.

" + } + }, + "campaignArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" + } } }, "traits": { @@ -625,16 +665,22 @@ "com.amazonaws.personalize#CampaignUpdateSummary": { "type": "structure", "members": { - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "minProvisionedTPS": { + "target": "com.amazonaws.personalize#TransactionsPerSecond", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the campaign update was last updated.

" + "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second that\n Amazon Personalize will support.

" } }, - "failureReason": { - "target": "com.amazonaws.personalize#FailureReason", + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

If a campaign update fails, the reason behind the failure.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployed solution version.

" + } + }, + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

The date and time (in Unix time) that the campaign update was created.

" } }, "status": { @@ -643,22 +689,19 @@ "smithy.api#documentation": "

The status of the campaign update.

\n

A campaign update can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", - "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the campaign update was created.

" - } + "campaignConfig": { + "target": "com.amazonaws.personalize#CampaignConfig" }, - "solutionVersionArn": { - "target": "com.amazonaws.personalize#Arn", + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployed solution version.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the campaign update was last updated.

" } }, - "minProvisionedTPS": { - "target": "com.amazonaws.personalize#TransactionsPerSecond", + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", "traits": { - "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second that\n Amazon Personalize will support.

" + "smithy.api#documentation": "

If a campaign update fails, the reason behind the failure.

" } } }, @@ -681,17 +724,17 @@ "com.amazonaws.personalize#CategoricalHyperParameterRange": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.personalize#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the hyperparameter.

" - } - }, "values": { "target": "com.amazonaws.personalize#CategoricalValues", "traits": { "smithy.api#documentation": "

A list of the categories for the hyperparameter.

" } + }, + "name": { + "target": "com.amazonaws.personalize#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the hyperparameter.

" + } } }, "traits": { @@ -740,17 +783,17 @@ "smithy.api#documentation": "

The maximum allowable value for the hyperparameter.

" } }, - "name": { - "target": "com.amazonaws.personalize#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the hyperparameter.

" - } - }, "minValue": { "target": "com.amazonaws.personalize#ContinuousMinValue", "traits": { "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" } + }, + "name": { + "target": "com.amazonaws.personalize#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the hyperparameter.

" + } } }, "traits": { @@ -817,25 +860,12 @@ "com.amazonaws.personalize#CreateBatchInferenceJobRequest": { "type": "structure", "members": { - "jobOutput": { - "target": "com.amazonaws.personalize#BatchInferenceJobOutput", - "traits": { - "smithy.api#documentation": "

The path to the Amazon S3 bucket where the job's output will be stored.

", - "smithy.api#required": {} - } - }, "numResults": { "target": "com.amazonaws.personalize#NumBatchResults", "traits": { "smithy.api#documentation": "

The number of recommendations to retreive.

" } }, - "filterArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the filter to apply to the batch inference job. For more information on using\n filters, see Using Filters with Amazon Personalize.

" - } - }, "roleArn": { "target": "com.amazonaws.personalize#RoleArn", "traits": { @@ -843,13 +873,25 @@ "smithy.api#required": {} } }, - "jobName": { - "target": "com.amazonaws.personalize#Name", + "batchInferenceJobConfig": { + "target": "com.amazonaws.personalize#BatchInferenceJobConfig", "traits": { - "smithy.api#documentation": "

The name of the batch inference job to create.

", + "smithy.api#documentation": "

The configuration details of a batch inference job.

" + } + }, + "jobOutput": { + "target": "com.amazonaws.personalize#BatchInferenceJobOutput", + "traits": { + "smithy.api#documentation": "

The path to the Amazon S3 bucket where the job's output will be stored.

", "smithy.api#required": {} } }, + "filterArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the filter to apply to the batch inference job. For more information on using\n filters, see Using Filters with Amazon Personalize.

" + } + }, "jobInput": { "target": "com.amazonaws.personalize#BatchInferenceJobInput", "traits": { @@ -863,6 +905,13 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version that will be used to generate the\n batch inference recommendations.

", "smithy.api#required": {} } + }, + "jobName": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "

The name of the batch inference job to create.

", + "smithy.api#required": {} + } } } }, @@ -924,6 +973,12 @@ "smithy.api#required": {} } }, + "campaignConfig": { + "target": "com.amazonaws.personalize#CampaignConfig", + "traits": { + "smithy.api#documentation": "

The configuration details of a campaign.

" + } + }, "name": { "target": "com.amazonaws.personalize#Name", "traits": { @@ -970,7 +1025,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an empty dataset and adds it to the specified dataset group. Use\n CreateDatasetImportJob to import your training data to a dataset.

\n

There are three types of datasets:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
\n

Each dataset type has an associated schema with required field types. Only the\n Interactions dataset is required in order to train a model (also referred to as\n creating a solution).

\n

A dataset can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
\n

To get the status of the dataset, call DescribeDataset.

\n

\n Related APIs\n

\n ", + "smithy.api#documentation": "

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

\n

There are three types of datasets:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
\n

Each dataset type has an associated schema with required field types. Only the\n Interactions dataset is required in order to train a model (also referred to as\n creating a solution).

\n

A dataset can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
\n

To get the status of the dataset, call DescribeDataset.

\n

\n Related APIs\n

\n ", "smithy.api#idempotent": {} } }, @@ -994,22 +1049,22 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an empty dataset group. A dataset group contains related datasets that supply\n data for training a model. A dataset group can contain at most three datasets,\n one for each type of dataset:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
\n

To train a model (create a solution), a dataset group that contains an\n Interactions dataset is required. Call CreateDataset\n to add a dataset to the group.

\n

A dataset group can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING

    \n
    • \n
\n

To get the status of the dataset group, call DescribeDatasetGroup.\n If the status shows as CREATE FAILED, the response includes a\n failureReason key, which describes why the creation failed.

\n \n

You must wait until the status of the dataset\n group is ACTIVE before adding a dataset to the group.

\n \n

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.\n If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role\n that has permission to access the key.

\n

\n APIs that require a dataset group ARN in the request\n

\n \n

\n Related APIs\n

\n " + "smithy.api#documentation": "

Creates an empty dataset group. A dataset group contains related datasets that supply data\n for training a model. A dataset group can contain at most three datasets, one for each type of\n dataset:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
\n

To train a model (create a solution), a dataset group that contains an\n Interactions dataset is required. Call CreateDataset to add a\n dataset to the group.

\n

A dataset group can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING

    \n
    • \n
\n

To get the status of the dataset group, call DescribeDatasetGroup. If\n the status shows as CREATE FAILED, the response includes a failureReason key,\n which describes why the creation failed.

\n \n

You must wait until the status of the dataset group is ACTIVE\n before adding a dataset to the group.

\n \n

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you\n specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to\n access the key.

\n

\n APIs that require a dataset group ARN in the request\n

\n \n

\n Related APIs\n

\n " } }, "com.amazonaws.personalize#CreateDatasetGroupRequest": { "type": "structure", "members": { - "kmsKeyArn": { - "target": "com.amazonaws.personalize#KmsKeyArn", + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.

" + "smithy.api#documentation": "

The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM\n role is only valid when also specifying a KMS key.

" } }, - "roleArn": { - "target": "com.amazonaws.personalize#RoleArn", + "kmsKeyArn": { + "target": "com.amazonaws.personalize#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that has permissions to access the KMS key. Supplying an\n IAM role is only valid when also specifying a KMS key.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.

" } }, "name": { @@ -1058,16 +1113,16 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a job that imports training data from your data source (an Amazon S3 bucket)\n to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data,\n you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source.

\n \n

The dataset import job replaces any previous data in the dataset.

\n \n

\n Status\n

\n

A dataset import job can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
\n

To get the status of the import job, call DescribeDatasetImportJob,\n providing the Amazon Resource Name (ARN) of the dataset import job.\n The dataset import is complete when the status shows as ACTIVE.\n If the status shows as CREATE FAILED, the response includes a\n failureReason key, which describes why the job failed.

\n \n

Importing takes time. You must wait until the status\n shows as ACTIVE before training a model using the dataset.

\n \n \n

\n Related APIs\n

\n " + "smithy.api#documentation": "

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an\n Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an\n AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a\n copy of your data and processes it in an internal AWS system.

\n \n

The dataset import job replaces any previous data in the dataset.

\n \n

\n Status\n

\n

A dataset import job can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
\n

To get the status of the import job, call DescribeDatasetImportJob,\n providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is\n complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response\n includes a failureReason key, which describes why the job failed.

\n \n

Importing takes time. You must wait until the status shows as ACTIVE before training a\n model using the dataset.

\n \n \n

\n Related APIs\n

\n " } }, "com.amazonaws.personalize#CreateDatasetImportJobRequest": { "type": "structure", "members": { - "dataSource": { - "target": "com.amazonaws.personalize#DataSource", + "datasetArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that contains the training data to import.

", + "smithy.api#documentation": "

The ARN of the dataset that receives the imported data.

", "smithy.api#required": {} } }, @@ -1078,17 +1133,17 @@ "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.personalize#RoleArn", + "dataSource": { + "target": "com.amazonaws.personalize#DataSource", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

", + "smithy.api#documentation": "

The Amazon S3 bucket that contains the training data to import.

", "smithy.api#required": {} } }, - "datasetArn": { - "target": "com.amazonaws.personalize#Arn", + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the dataset that receives the imported data.

", + "smithy.api#documentation": "

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

", "smithy.api#required": {} } } @@ -1108,24 +1163,17 @@ "com.amazonaws.personalize#CreateDatasetRequest": { "type": "structure", "members": { - "datasetGroupArn": { + "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.personalize#Name", - "traits": { - "smithy.api#documentation": "

The name for the dataset.

", + "smithy.api#documentation": "

The ARN of the schema to associate with the dataset. The schema defines the dataset\n fields.

", "smithy.api#required": {} } }, - "schemaArn": { + "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the schema to associate with the dataset. The schema defines the dataset\n fields.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

", "smithy.api#required": {} } }, @@ -1135,6 +1183,13 @@ "smithy.api#documentation": "

The type of dataset.

\n

One of the following (case insensitive) values:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
", "smithy.api#required": {} } + }, + "name": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "

The name for the dataset.

", + "smithy.api#required": {} + } } } }, @@ -1238,16 +1293,16 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a recommendation filter. For more information, see Using Filters with Amazon\n Personalize.

" + "smithy.api#documentation": "

Creates a recommendation filter. For more information, see Using\n Filters with Amazon Personalize.

" } }, "com.amazonaws.personalize#CreateFilterRequest": { "type": "structure", "members": { - "filterExpression": { - "target": "com.amazonaws.personalize#FilterExpression", + "name": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The filter expression that designates the interaction types that the filter will\n filter out. A filter expression must follow the following format:

\n

\n EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")\n

\n

Where \"EVENT_TYPE\" is the type of event to filter out. To filter out all items with\n any interactions history, set \"*\" as the EVENT_TYPE. For more information, see\n Using Filters with Amazon Personalize.

", + "smithy.api#documentation": "

The name of the filter to create.

", "smithy.api#required": {} } }, @@ -1258,10 +1313,10 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.personalize#Name", + "filterExpression": { + "target": "com.amazonaws.personalize#FilterExpression", "traits": { - "smithy.api#documentation": "

The name of the filter to create.

", + "smithy.api#documentation": "

The filter expression that designates the interaction types that the filter will\n filter out. A filter expression must follow the following format:

\n

\n EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")\n

\n

Where \"EVENT_TYPE\" is the type of event to filter out. To filter out all items with\n any interactions history, set \"*\" as the EVENT_TYPE. For more information,\n see Using\n Filters with Amazon Personalize.

", "smithy.api#required": {} } } @@ -1364,16 +1419,23 @@ "com.amazonaws.personalize#CreateSolutionRequest": { "type": "structure", "members": { - "recipeArn": { + "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the recipe to use for model training. Only specified when\n performAutoML is false.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

", + "smithy.api#required": {} } }, - "performAutoML": { - "target": "com.amazonaws.personalize#PerformAutoML", + "eventType": { + "target": "com.amazonaws.personalize#EventType", "traits": { - "smithy.api#documentation": "

Whether to perform automated machine learning (AutoML). The default is false.\n For this case, you must specify recipeArn.

\n

When set to true, Amazon Personalize analyzes your training data and selects\n the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit\n recipeArn. Amazon Personalize determines the optimal recipe by running tests with\n different values for the hyperparameters.\n AutoML lengthens the training process as compared to selecting a specific recipe.

" + "smithy.api#documentation": "

When your have multiple event types (using an EVENT_TYPE schema field),\n this parameter specifies which event type (for example, 'click' or 'like') is used for\n training the model.

" + } + }, + "recipeArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the recipe to use for model training. Only specified when\n performAutoML is false.

" } }, "performHPO": { @@ -1382,6 +1444,12 @@ "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe.\n The default is false.

\n

When performing AutoML, this parameter is always true and you\n should not set it to false.

" } }, + "performAutoML": { + "target": "com.amazonaws.personalize#PerformAutoML", + "traits": { + "smithy.api#documentation": "

Whether to perform automated machine learning (AutoML). The default is false.\n For this case, you must specify recipeArn.

\n

When set to true, Amazon Personalize analyzes your training data and selects\n the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit\n recipeArn. Amazon Personalize determines the optimal recipe by running tests with\n different values for the hyperparameters.\n AutoML lengthens the training process as compared to selecting a specific recipe.

" + } + }, "name": { "target": "com.amazonaws.personalize#Name", "traits": { @@ -1394,19 +1462,6 @@ "traits": { "smithy.api#documentation": "

The configuration to use with the solution. When performAutoML is set to\n true, Amazon Personalize only evaluates the autoMLConfig section\n of the solution configuration.

" } - }, - "eventType": { - "target": "com.amazonaws.personalize#EventType", - "traits": { - "smithy.api#documentation": "

When your have multiple event types (using an EVENT_TYPE schema field),\n this parameter specifies which event type (for example, 'click' or 'like') is used for\n training the model.

" - } - }, - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

", - "smithy.api#required": {} - } } } }, @@ -1433,6 +1488,9 @@ { "target": "com.amazonaws.personalize#InvalidInputException" }, + { + "target": "com.amazonaws.personalize#LimitExceededException" + }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, @@ -1447,18 +1505,18 @@ "com.amazonaws.personalize#CreateSolutionVersionRequest": { "type": "structure", "members": { + "trainingMode": { + "target": "com.amazonaws.personalize#TrainingMode", + "traits": { + "smithy.api#documentation": "

The scope of training to be performed when creating the solution version. The\n FULL option trains the solution version based on the entirety of the input\n solution's training data, while the UPDATE option processes only the data that\n has changed in comparison to the input solution. Choose UPDATE when you want to\n incrementally update your solution version instead of creating an entirely new one.

\n \n

The UPDATE option can only be used when you already have an active solution\n version created from the input solution using the FULL option and the input\n solution was trained with the native-recipe-hrnn-coldstart recipe.

\n " + } + }, "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution containing the training configuration\n information.

", "smithy.api#required": {} } - }, - "trainingMode": { - "target": "com.amazonaws.personalize#TrainingMode", - "traits": { - "smithy.api#documentation": "

The scope of training to be performed when creating the solution version. The\n FULL option trains the solution version based on the entirety of the input\n solution's training data, while the UPDATE option processes only the data that\n has changed in comparison to the input solution. Choose UPDATE when you want to\n incrementally update your solution version instead of creating an entirely new one.

\n \n

The UPDATE option can only be used when you already have an active solution\n version created from the input solution using the FULL option and the input\n solution was trained with the native-recipe-hrnn-coldstart recipe.

\n " - } } } }, @@ -1490,16 +1548,16 @@ "com.amazonaws.personalize#Dataset": { "type": "structure", "members": { - "datasetType": { - "target": "com.amazonaws.personalize#DatasetType", + "schemaArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

One of the following values:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
" + "smithy.api#documentation": "

The ARN of the associated schema.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "datasetArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

A time stamp that shows when the dataset was updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

" } }, "status": { @@ -1508,16 +1566,22 @@ "smithy.api#documentation": "

The status of the dataset.

\n

A dataset can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" } }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

A time stamp that shows when the dataset was updated.

" + } + }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset.

" } }, - "datasetArn": { - "target": "com.amazonaws.personalize#Arn", + "datasetType": { + "target": "com.amazonaws.personalize#DatasetType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

" + "smithy.api#documentation": "

One of the following values:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
" } }, "name": { @@ -1526,12 +1590,6 @@ "smithy.api#documentation": "

The name of the dataset.

" } }, - "schemaArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the associated schema.

" - } - }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { @@ -1546,10 +1604,22 @@ "com.amazonaws.personalize#DatasetGroup": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.personalize#RoleArn", + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that has permissions to create the dataset group.

" + "smithy.api#documentation": "

If creating a dataset group fails, provides the reason why.

" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

The last update date and time (in Unix time) of the dataset group.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.personalize#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.

" } }, "name": { @@ -1558,16 +1628,16 @@ "smithy.api#documentation": "

The name of the dataset group.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "roleArn": { + "target": "com.amazonaws.personalize#RoleArn", "traits": { - "smithy.api#documentation": "

The last update date and time (in Unix time) of the dataset group.

" + "smithy.api#documentation": "

The ARN of the IAM role that has permissions to create the dataset group.

" } }, - "failureReason": { - "target": "com.amazonaws.personalize#FailureReason", + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

If creating a dataset group fails, provides the reason why.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" } }, "status": { @@ -1581,37 +1651,19 @@ "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset group.

" } - }, - "kmsKeyArn": { - "target": "com.amazonaws.personalize#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.

" - } - }, - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" - } } }, "traits": { - "smithy.api#documentation": "

A dataset group is a collection of related datasets (Interactions, User, and Item). \n You create a dataset group by calling\n CreateDatasetGroup. You then create a dataset and add it to a dataset\n group by calling CreateDataset. The dataset group \n is used to create and train a solution by calling CreateSolution.\n A dataset group can contain only one of each type of dataset.

\n

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.

" + "smithy.api#documentation": "

A dataset group is a collection of related datasets (Interactions, User, and Item). You\n create a dataset group by calling CreateDatasetGroup. You then create a\n dataset and add it to a dataset group by calling CreateDataset. The dataset\n group is used to create and train a solution by calling CreateSolution. A\n dataset group can contain only one of each type of dataset.

\n

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.

" } }, "com.amazonaws.personalize#DatasetGroupSummary": { "type": "structure", "members": { - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" - } - }, - "name": { - "target": "com.amazonaws.personalize#Name", + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The name of the dataset group.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the dataset group was last updated.

" } }, "failureReason": { @@ -1620,16 +1672,16 @@ "smithy.api#documentation": "

If creating a dataset group fails, the reason behind the failure.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the dataset group was last updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", + "name": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the dataset group was created.

" + "smithy.api#documentation": "

The name of the dataset group.

" } }, "status": { @@ -1637,6 +1689,12 @@ "traits": { "smithy.api#documentation": "

The status of the dataset group.

\n

A dataset group can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING

    \n
    • \n
" } + }, + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

The date and time (in Unix time) that the dataset group was created.

" + } } }, "traits": { @@ -1658,22 +1716,22 @@ "com.amazonaws.personalize#DatasetImportJob": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.personalize#Status", + "dataSource": { + "target": "com.amazonaws.personalize#DataSource", "traits": { - "smithy.api#documentation": "

The status of the dataset import job.

\n

A dataset import job can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon S3 bucket that contains the training data to import.

" } }, - "failureReason": { - "target": "com.amazonaws.personalize#FailureReason", + "datasetImportJobArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

If a dataset import job fails, provides the reason why.

" + "smithy.api#documentation": "

The ARN of the dataset import job.

" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", + "datasetArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset import job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

" } }, "lastUpdatedDateTime": { @@ -1682,54 +1740,54 @@ "smithy.api#documentation": "

The date and time (in Unix time) the dataset was last updated.

" } }, - "datasetArn": { - "target": "com.amazonaws.personalize#Arn", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

" + "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset import job.

" } }, - "jobName": { - "target": "com.amazonaws.personalize#Name", + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", "traits": { - "smithy.api#documentation": "

The name of the import job.

" + "smithy.api#documentation": "

If a dataset import job fails, provides the reason why.

" } }, - "dataSource": { - "target": "com.amazonaws.personalize#DataSource", + "status": { + "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that contains the training data to import.

" + "smithy.api#documentation": "

The status of the dataset import job.

\n

A dataset import job can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
" } }, - "datasetImportJobArn": { + "roleArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the dataset import job.

" + "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data\n source.

" } }, - "roleArn": { - "target": "com.amazonaws.personalize#Arn", + "jobName": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data source.

" + "smithy.api#documentation": "

The name of the import job.

" } } }, "traits": { - "smithy.api#documentation": "

Describes a job that imports training data from a data source (Amazon S3 bucket)\n to an Amazon Personalize dataset. For more information, see\n CreateDatasetImportJob.

\n

A dataset import job can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
" + "smithy.api#documentation": "

Describes a job that imports training data from a data source (Amazon S3 bucket) to an\n Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

\n

A dataset import job can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
" } }, "com.amazonaws.personalize#DatasetImportJobSummary": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.personalize#Name", + "datasetImportJobArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The name of the dataset import job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset import job.

" } }, - "failureReason": { - "target": "com.amazonaws.personalize#FailureReason", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

If a dataset import job fails, the reason behind the failure.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the dataset import job was created.

" } }, "status": { @@ -1738,16 +1796,10 @@ "smithy.api#documentation": "

The status of the dataset import job.

\n

A dataset import job can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", - "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the dataset import job was created.

" - } - }, - "datasetImportJobArn": { - "target": "com.amazonaws.personalize#Arn", + "jobName": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset import job.

" + "smithy.api#documentation": "

The name of the dataset import job.

" } }, "lastUpdatedDateTime": { @@ -1755,6 +1807,12 @@ "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset was last updated.

" } + }, + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", + "traits": { + "smithy.api#documentation": "

If a dataset import job fails, the reason behind the failure.

" + } } }, "traits": { @@ -1776,10 +1834,10 @@ "com.amazonaws.personalize#DatasetSchema": { "type": "structure", "members": { - "schemaArn": { - "target": "com.amazonaws.personalize#Arn", + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the schema was last updated.

" } }, "schema": { @@ -1788,22 +1846,22 @@ "smithy.api#documentation": "

The schema.

" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", - "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the schema was created.

" - } - }, "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the schema.

" } }, - "lastUpdatedDateTime": { + "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the schema was last updated.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the schema was created.

" + } + }, + "schemaArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema.

" } } }, @@ -1820,16 +1878,16 @@ "smithy.api#documentation": "

The name of the schema.

" } }, - "lastUpdatedDateTime": { + "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the schema was last updated.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the schema was created.

" } }, - "creationDateTime": { + "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the schema was created.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the schema was last updated.

" } }, "schemaArn": { @@ -1837,19 +1895,31 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a summary of the properties of a dataset schema. For a complete listing, call the\n DescribeSchema API.

" - } - }, - "com.amazonaws.personalize#DatasetSummary": { - "type": "structure", - "members": { - "datasetType": { - "target": "com.amazonaws.personalize#DatasetType", + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of the properties of a dataset schema. For a complete listing, call the\n DescribeSchema API.

" + } + }, + "com.amazonaws.personalize#DatasetSummary": { + "type": "structure", + "members": { + "datasetArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "name": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "status": { + "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

The dataset type. One of the following values:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
  • \n

    Event-Interactions

    \n
    • \n
" + "smithy.api#documentation": "

The status of the dataset.

\n

A dataset can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" } }, "lastUpdatedDateTime": { @@ -1864,22 +1934,10 @@ "smithy.api#documentation": "

The date and time (in Unix time) that the dataset was created.

" } }, - "status": { - "target": "com.amazonaws.personalize#Status", - "traits": { - "smithy.api#documentation": "

The status of the dataset.

\n

A dataset can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" - } - }, - "name": { - "target": "com.amazonaws.personalize#Name", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "datasetArn": { - "target": "com.amazonaws.personalize#Arn", + "datasetType": { + "target": "com.amazonaws.personalize#DatasetType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + "smithy.api#documentation": "

The dataset type. One of the following values:

\n
    \n
  • \n

    Interactions

    \n
    • \n
  • \n

    Items

    \n
    • \n
  • \n

    Users

    \n
    • \n
  • \n

    Event-Interactions

    \n
    • \n
" } } }, @@ -1914,12 +1972,6 @@ "com.amazonaws.personalize#DefaultCategoricalHyperParameterRange": { "type": "structure", "members": { - "values": { - "target": "com.amazonaws.personalize#CategoricalValues", - "traits": { - "smithy.api#documentation": "

A list of the categories for the hyperparameter.

" - } - }, "isTunable": { "target": "com.amazonaws.personalize#Tunable", "traits": { @@ -1931,6 +1983,12 @@ "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } + }, + "values": { + "target": "com.amazonaws.personalize#CategoricalValues", + "traits": { + "smithy.api#documentation": "

A list of the categories for the hyperparameter.

" + } } }, "traits": { @@ -1952,29 +2010,29 @@ "com.amazonaws.personalize#DefaultContinuousHyperParameterRange": { "type": "structure", "members": { - "minValue": { - "target": "com.amazonaws.personalize#ContinuousMinValue", - "traits": { - "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" - } - }, "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } }, - "isTunable": { - "target": "com.amazonaws.personalize#Tunable", - "traits": { - "smithy.api#documentation": "

Whether the hyperparameter is tunable.

" - } - }, "maxValue": { "target": "com.amazonaws.personalize#ContinuousMaxValue", "traits": { "smithy.api#documentation": "

The maximum allowable value for the hyperparameter.

" } + }, + "minValue": { + "target": "com.amazonaws.personalize#ContinuousMinValue", + "traits": { + "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" + } + }, + "isTunable": { + "target": "com.amazonaws.personalize#Tunable", + "traits": { + "smithy.api#documentation": "

Whether the hyperparameter is tunable.

" + } } }, "traits": { @@ -1996,18 +2054,18 @@ "com.amazonaws.personalize#DefaultHyperParameterRanges": { "type": "structure", "members": { - "integerHyperParameterRanges": { - "target": "com.amazonaws.personalize#DefaultIntegerHyperParameterRanges", - "traits": { - "smithy.api#documentation": "

The integer-valued hyperparameters and their default ranges.

" - } - }, "continuousHyperParameterRanges": { "target": "com.amazonaws.personalize#DefaultContinuousHyperParameterRanges", "traits": { "smithy.api#documentation": "

The continuous hyperparameters and their default ranges.

" } }, + "integerHyperParameterRanges": { + "target": "com.amazonaws.personalize#DefaultIntegerHyperParameterRanges", + "traits": { + "smithy.api#documentation": "

The integer-valued hyperparameters and their default ranges.

" + } + }, "categoricalHyperParameterRanges": { "target": "com.amazonaws.personalize#DefaultCategoricalHyperParameterRanges", "traits": { @@ -2022,18 +2080,6 @@ "com.amazonaws.personalize#DefaultIntegerHyperParameterRange": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.personalize#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the hyperparameter.

" - } - }, - "isTunable": { - "target": "com.amazonaws.personalize#Tunable", - "traits": { - "smithy.api#documentation": "

Indicates whether the hyperparameter is tunable.

" - } - }, "maxValue": { "target": "com.amazonaws.personalize#IntegerMaxValue", "traits": { @@ -2045,6 +2091,18 @@ "traits": { "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" } + }, + "name": { + "target": "com.amazonaws.personalize#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the hyperparameter.

" + } + }, + "isTunable": { + "target": "com.amazonaws.personalize#Tunable", + "traits": { + "smithy.api#documentation": "

Indicates whether the hyperparameter is tunable.

" + } } }, "traits": { @@ -2113,7 +2171,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a dataset. You can't delete a dataset if an associated\n DatasetImportJob or SolutionVersion is in the\n CREATE PENDING or IN PROGRESS state. For more information on datasets, see\n CreateDataset.

", + "smithy.api#documentation": "

Deletes a dataset. You can't delete a dataset if an associated\n DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN\n PROGRESS state. For more information on datasets, see CreateDataset.

", "smithy.api#idempotent": {} } }, @@ -2134,7 +2192,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a dataset group. Before you delete a dataset group, you must delete\n the following:

\n
    \n
  • \n

    All associated event trackers.

    \n
    • \n
  • \n

    All associated solutions.

    \n
    • \n
  • \n

    All datasets in the dataset group.

    \n
    • \n
", + "smithy.api#documentation": "

Deletes a dataset group. Before you delete a dataset group, you must delete the\n following:

\n
    \n
  • \n

    All associated event trackers.

    \n
    • \n
  • \n

    All associated solutions.

    \n
    • \n
  • \n

    All datasets in the dataset group.

    \n
    • \n
", "smithy.api#idempotent": {} } }, @@ -2204,6 +2262,9 @@ { "target": "com.amazonaws.personalize#InvalidInputException" }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } @@ -2439,7 +2500,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the given dataset. For more information on datasets, see\n CreateDataset.

", + "smithy.api#documentation": "

Describes the given dataset. For more information on datasets, see CreateDataset.

", "smithy.api#idempotent": {} } }, @@ -2460,7 +2521,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the given dataset group. For more information on dataset groups, see\n CreateDatasetGroup.

", + "smithy.api#documentation": "

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

", "smithy.api#idempotent": {} } }, @@ -2880,10 +2941,10 @@ "com.amazonaws.personalize#EventTracker": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.personalize#Name", + "eventTrackerArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The name of the event tracker.

" + "smithy.api#documentation": "

The ARN of the event tracker.

" } }, "lastUpdatedDateTime": { @@ -2892,16 +2953,22 @@ "smithy.api#documentation": "

The date and time (in Unix time) that the event tracker was last updated.

" } }, - "eventTrackerArn": { + "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the event tracker.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", + "name": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The date and time (in Unix format) that the event tracker was created.

" + "smithy.api#documentation": "

The name of the event tracker.

" + } + }, + "accountId": { + "target": "com.amazonaws.personalize#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon AWS account that owns the event tracker.

" } }, "status": { @@ -2916,16 +2983,10 @@ "smithy.api#documentation": "

The ID of the event tracker. Include this ID in requests to the\n PutEvents API.

" } }, - "accountId": { - "target": "com.amazonaws.personalize#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon AWS account that owns the event tracker.

" - } - }, - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

" + "smithy.api#documentation": "

The date and time (in Unix format) that the event tracker was created.

" } } }, @@ -2948,10 +3009,10 @@ "smithy.api#documentation": "

The date and time (in Unix time) that the event tracker was created.

" } }, - "eventTrackerArn": { - "target": "com.amazonaws.personalize#Arn", + "name": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event tracker.

" + "smithy.api#documentation": "

The name of the event tracker.

" } }, "status": { @@ -2960,10 +3021,10 @@ "smithy.api#documentation": "

The status of the event tracker.

\n

An event tracker can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" } }, - "name": { - "target": "com.amazonaws.personalize#Name", + "eventTrackerArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The name of the event tracker.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event tracker.

" } } }, @@ -3007,6 +3068,18 @@ "com.amazonaws.personalize#FeatureTransformation": { "type": "structure", "members": { + "defaultParameters": { + "target": "com.amazonaws.personalize#FeaturizationParameters", + "traits": { + "smithy.api#documentation": "

Provides the default parameters for feature transformation.

" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

The last update date and time (in Unix time) of the feature transformation.

" + } + }, "name": { "target": "com.amazonaws.personalize#Name", "traits": { @@ -3025,18 +3098,6 @@ "smithy.api#documentation": "

The creation date and time (in Unix time) of the feature transformation.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", - "traits": { - "smithy.api#documentation": "

The last update date and time (in Unix time) of the feature transformation.

" - } - }, - "defaultParameters": { - "target": "com.amazonaws.personalize#FeaturizationParameters", - "traits": { - "smithy.api#documentation": "

Provides the default parameters for feature transformation.

" - } - }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { @@ -3081,16 +3142,16 @@ "com.amazonaws.personalize#Filter": { "type": "structure", "members": { - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The ARN of the dataset group to which the filter belongs.

" + "smithy.api#documentation": "

The time at which the filter was created.

" } }, - "filterExpression": { - "target": "com.amazonaws.personalize#FilterExpression", + "status": { + "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

Specifies the type of item interactions to filter out of recommendation results. The\n filter expression must follow the following format:

\n

\n EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")\n

\n

Where \"EVENT_TYPE\" is the type of event to filter out. For more information, see Using\n Filters with Amazon Personalize.

" + "smithy.api#documentation": "

The status of the filter.

" } }, "failureReason": { @@ -3099,10 +3160,16 @@ "smithy.api#documentation": "

If the filter failed, the reason for its failure.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The time at which the filter was last updated.

" + "smithy.api#documentation": "

The ARN of the dataset group to which the filter belongs.

" + } + }, + "filterExpression": { + "target": "com.amazonaws.personalize#FilterExpression", + "traits": { + "smithy.api#documentation": "

Specifies the type of item interactions to filter out of recommendation results. The\n filter expression must follow the following format:

\n

\n EXCLUDE itemId WHERE INTERACTIONS.event_type in (\"EVENT_TYPE\")\n

\n

Where \"EVENT_TYPE\" is the type of event to filter out. For more information, see\n Using\n Filters with Amazon Personalize.

" } }, "filterArn": { @@ -3117,16 +3184,10 @@ "smithy.api#documentation": "

The name of the filter.

" } }, - "status": { - "target": "com.amazonaws.personalize#Status", - "traits": { - "smithy.api#documentation": "

The status of the filter.

" - } - }, - "creationDateTime": { + "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The time at which the filter was created.

" + "smithy.api#documentation": "

The time at which the filter was last updated.

" } } }, @@ -3147,10 +3208,22 @@ "com.amazonaws.personalize#FilterSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.personalize#Name", + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", "traits": { - "smithy.api#documentation": "

The name of the filter.

" + "smithy.api#documentation": "

If the filter failed, the reason for the failure.

" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

The time at which the filter was last updated.

" + } + }, + "filterArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the filter.

" } }, "datasetGroupArn": { @@ -3159,10 +3232,10 @@ "smithy.api#documentation": "

The ARN of the dataset group to which the filter belongs.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "name": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The time at which the filter was last updated.

" + "smithy.api#documentation": "

The name of the filter.

" } }, "status": { @@ -3176,18 +3249,6 @@ "traits": { "smithy.api#documentation": "

The time at which the filter was created.

" } - }, - "filterArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the filter.

" - } - }, - "failureReason": { - "target": "com.amazonaws.personalize#FailureReason", - "traits": { - "smithy.api#documentation": "

If the filter failed, the reason for the failure.

" - } } }, "traits": { @@ -3241,20 +3302,20 @@ } } }, - "com.amazonaws.personalize#GetSolutionMetricsResponse": { - "type": "structure", - "members": { - "metrics": { - "target": "com.amazonaws.personalize#Metrics", - "traits": { - "smithy.api#documentation": "

The metrics for the solution version.

" - } - }, + "com.amazonaws.personalize#GetSolutionMetricsResponse": { + "type": "structure", + "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The same solution version ARN as specified in the request.

" } + }, + "metrics": { + "target": "com.amazonaws.personalize#Metrics", + "traits": { + "smithy.api#documentation": "

The metrics for the solution version.

" + } } } }, @@ -3267,17 +3328,17 @@ "smithy.api#documentation": "

Describes the resource configuration for HPO.

" } }, - "algorithmHyperParameterRanges": { - "target": "com.amazonaws.personalize#HyperParameterRanges", - "traits": { - "smithy.api#documentation": "

The hyperparameters and their allowable ranges.

" - } - }, "hpoObjective": { "target": "com.amazonaws.personalize#HPOObjective", "traits": { "smithy.api#documentation": "

The metric to optimize during HPO.

" } + }, + "algorithmHyperParameterRanges": { + "target": "com.amazonaws.personalize#HyperParameterRanges", + "traits": { + "smithy.api#documentation": "

The hyperparameters and their allowable ranges.

" + } } }, "traits": { @@ -3293,17 +3354,17 @@ "smithy.api#documentation": "

The name of the metric.

" } }, - "type": { - "target": "com.amazonaws.personalize#HPOObjectiveType", - "traits": { - "smithy.api#documentation": "

The type of the metric. Valid values are Maximize and Minimize.

" - } - }, "metricRegex": { "target": "com.amazonaws.personalize#MetricRegex", "traits": { "smithy.api#documentation": "

A regular expression for finding the metric in the training job logs.

" } + }, + "type": { + "target": "com.amazonaws.personalize#HPOObjectiveType", + "traits": { + "smithy.api#documentation": "

The type of the metric. Valid values are Maximize and Minimize.

" + } } }, "traits": { @@ -3331,16 +3392,16 @@ "com.amazonaws.personalize#HPOResourceConfig": { "type": "structure", "members": { - "maxParallelTrainingJobs": { + "maxNumberOfTrainingJobs": { "target": "com.amazonaws.personalize#HPOResource", "traits": { - "smithy.api#documentation": "

The maximum number of parallel training\n jobs when you create a\n solution\n version.\n The maximum value for maxParallelTrainingJobs is\n 10.

" + "smithy.api#documentation": "

The maximum number of training\n jobs when you create a\n solution\n version.\n The maximum value for maxNumberOfTrainingJobs is\n 40.

" } }, - "maxNumberOfTrainingJobs": { + "maxParallelTrainingJobs": { "target": "com.amazonaws.personalize#HPOResource", "traits": { - "smithy.api#documentation": "

The maximum number of training\n jobs when you create a\n solution\n version.\n The maximum value for maxNumberOfTrainingJobs is\n 40.

" + "smithy.api#documentation": "

The maximum number of parallel training\n jobs when you create a\n solution\n version.\n The maximum value for maxParallelTrainingJobs is\n 10.

" } } }, @@ -3351,6 +3412,12 @@ "com.amazonaws.personalize#HyperParameterRanges": { "type": "structure", "members": { + "integerHyperParameterRanges": { + "target": "com.amazonaws.personalize#IntegerHyperParameterRanges", + "traits": { + "smithy.api#documentation": "

The integer-valued hyperparameters and their ranges.

" + } + }, "continuousHyperParameterRanges": { "target": "com.amazonaws.personalize#ContinuousHyperParameterRanges", "traits": { @@ -3362,12 +3429,6 @@ "traits": { "smithy.api#documentation": "

The categorical hyperparameters and their ranges.

" } - }, - "integerHyperParameterRanges": { - "target": "com.amazonaws.personalize#IntegerHyperParameterRanges", - "traits": { - "smithy.api#documentation": "

The integer-valued hyperparameters and their ranges.

" - } } }, "traits": { @@ -3398,17 +3459,17 @@ "smithy.api#documentation": "

The maximum allowable value for the hyperparameter.

" } }, - "minValue": { - "target": "com.amazonaws.personalize#IntegerMinValue", - "traits": { - "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" - } - }, "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } + }, + "minValue": { + "target": "com.amazonaws.personalize#IntegerMinValue", + "traits": { + "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" + } } }, "traits": { @@ -3515,10 +3576,10 @@ "com.amazonaws.personalize#ListBatchInferenceJobsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.personalize#MaxResults", + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The maximum number of batch inference job results to return in each page. The default\n value is 100.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs\n were created.

" } }, "nextToken": { @@ -3527,10 +3588,10 @@ "smithy.api#documentation": "

The token to request the next page of results.

" } }, - "solutionVersionArn": { - "target": "com.amazonaws.personalize#Arn", + "maxResults": { + "target": "com.amazonaws.personalize#MaxResults", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs\n were created.

" + "smithy.api#documentation": "

The maximum number of batch inference job results to return in each page. The default\n value is 100.

" } } } @@ -3538,17 +3599,17 @@ "com.amazonaws.personalize#ListBatchInferenceJobsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", - "traits": { - "smithy.api#documentation": "

The token to use to retreive the next page of results. The value is null when\n there are no more results to return.

" - } - }, "batchInferenceJobs": { "target": "com.amazonaws.personalize#BatchInferenceJobs", "traits": { "smithy.api#documentation": "

A list containing information on each job that is returned.

" } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retreive the next page of results. The value is null when\n there are no more results to return.

" + } } } }, @@ -3582,12 +3643,6 @@ "com.amazonaws.personalize#ListCampaignsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.personalize#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of campaigns to return.

" - } - }, "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { @@ -3599,23 +3654,29 @@ "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListCampaigns for getting\n the next set of campaigns (if they exist).

" } + }, + "maxResults": { + "target": "com.amazonaws.personalize#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of campaigns to return.

" + } } } }, "com.amazonaws.personalize#ListCampaignsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", - "traits": { - "smithy.api#documentation": "

A token for getting the next set of campaigns (if they exist).

" - } - }, "campaigns": { "target": "com.amazonaws.personalize#Campaigns", "traits": { "smithy.api#documentation": "

A list of the campaigns.

" } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of campaigns (if they exist).

" + } } } }, @@ -3633,7 +3694,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of dataset groups. The response provides the properties for each dataset\n group, including the Amazon Resource Name (ARN). For more information on dataset groups, see\n CreateDatasetGroup.

", + "smithy.api#documentation": "

Returns a list of dataset groups. The response provides the properties for each dataset\n group, including the Amazon Resource Name (ARN). For more information on dataset groups, see\n CreateDatasetGroup.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -3649,7 +3710,7 @@ "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { - "smithy.api#documentation": "

A token returned from the previous call to ListDatasetGroups for getting\n the next set of dataset groups (if they exist).

" + "smithy.api#documentation": "

A token returned from the previous call to ListDatasetGroups for getting the\n next set of dataset groups (if they exist).

" } }, "maxResults": { @@ -3663,17 +3724,17 @@ "com.amazonaws.personalize#ListDatasetGroupsResponse": { "type": "structure", "members": { - "datasetGroups": { - "target": "com.amazonaws.personalize#DatasetGroups", - "traits": { - "smithy.api#documentation": "

The list of your dataset groups.

" - } - }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of dataset groups (if they exist).

" } + }, + "datasetGroups": { + "target": "com.amazonaws.personalize#DatasetGroups", + "traits": { + "smithy.api#documentation": "

The list of your dataset groups.

" + } } } }, @@ -3694,7 +3755,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of dataset import jobs that use the given dataset.\n When a dataset is not specified, all the dataset import jobs associated with the account are listed.\n The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN).\n For more information on dataset import jobs, see CreateDatasetImportJob.\n For more information on datasets, see CreateDataset.

", + "smithy.api#documentation": "

Returns a list of dataset import jobs that use the given dataset. When a dataset is not\n specified, all the dataset import jobs associated with the account are listed. The response\n provides the properties for each dataset import job, including the Amazon Resource Name (ARN).\n For more information on dataset import jobs, see CreateDatasetImportJob. For\n more information on datasets, see CreateDataset.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -3707,12 +3768,6 @@ "com.amazonaws.personalize#ListDatasetImportJobsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", - "traits": { - "smithy.api#documentation": "

A token returned from the previous call to ListDatasetImportJobs for getting\n the next set of dataset import jobs (if they exist).

" - } - }, "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { @@ -3724,6 +3779,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of dataset import jobs to return.

" } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "

A token returned from the previous call to ListDatasetImportJobs for getting\n the next set of dataset import jobs (if they exist).

" + } } } }, @@ -3761,7 +3822,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the list of datasets contained in the given dataset group. The response\n provides the properties for each dataset, including\n the Amazon Resource Name (ARN). For more information on datasets,\n see CreateDataset.

", + "smithy.api#documentation": "

Returns the list of datasets contained in the given dataset group. The response provides\n the properties for each dataset, including the Amazon Resource Name (ARN). For more\n information on datasets, see CreateDataset.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -3774,10 +3835,10 @@ "com.amazonaws.personalize#ListDatasetsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.personalize#MaxResults", + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The maximum number of datasets to return.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to\n list.

" } }, "nextToken": { @@ -3786,10 +3847,10 @@ "smithy.api#documentation": "

A token returned from the previous call to ListDatasetImportJobs for getting\n the next set of dataset import jobs (if they exist).

" } }, - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", + "maxResults": { + "target": "com.amazonaws.personalize#MaxResults", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that contains the\n datasets to list.

" + "smithy.api#documentation": "

The maximum number of datasets to return.

" } } } @@ -3797,16 +3858,16 @@ "com.amazonaws.personalize#ListDatasetsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", + "datasets": { + "target": "com.amazonaws.personalize#Datasets", "traits": { - "smithy.api#documentation": "

A token for getting the next set of datasets (if they exist).

" + "smithy.api#documentation": "

An array of Dataset objects. Each object provides metadata\n information.

" } }, - "datasets": { - "target": "com.amazonaws.personalize#Datasets", + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", "traits": { - "smithy.api#documentation": "

An array of Dataset objects. Each object provides metadata information.

" + "smithy.api#documentation": "

A token for getting the next set of datasets (if they exist).

" } } } @@ -3841,10 +3902,10 @@ "com.amazonaws.personalize#ListEventTrackersRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.personalize#MaxResults", + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", "traits": { - "smithy.api#documentation": "

The maximum number of event trackers to return.

" + "smithy.api#documentation": "

A token returned from the previous call to ListEventTrackers for getting\n the next set of event trackers (if they exist).

" } }, "datasetGroupArn": { @@ -3853,10 +3914,10 @@ "smithy.api#documentation": "

The ARN of a dataset group used to filter the response.

" } }, - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", + "maxResults": { + "target": "com.amazonaws.personalize#MaxResults", "traits": { - "smithy.api#documentation": "

A token returned from the previous call to ListEventTrackers for getting\n the next set of event trackers (if they exist).

" + "smithy.api#documentation": "

The maximum number of event trackers to return.

" } } } @@ -3902,10 +3963,10 @@ "com.amazonaws.personalize#ListFiltersRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.personalize#MaxResults", + "datasetGroupArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The maximum number of filters to return.

" + "smithy.api#documentation": "

The ARN of the dataset group that contains the filters.

" } }, "nextToken": { @@ -3914,10 +3975,10 @@ "smithy.api#documentation": "

A token returned from the previous call to ListFilters for getting the\n next set of filters (if they exist).

" } }, - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", + "maxResults": { + "target": "com.amazonaws.personalize#MaxResults", "traits": { - "smithy.api#documentation": "

The ARN of the dataset group that contains the filters.

" + "smithy.api#documentation": "

The maximum number of filters to return.

" } } } @@ -3972,17 +4033,17 @@ "smithy.api#documentation": "

The default is SERVICE.

" } }, - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", - "traits": { - "smithy.api#documentation": "

A token returned from the previous call to ListRecipes for getting\n the next set of recipes (if they exist).

" - } - }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of recipes to return.

" } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "

A token returned from the previous call to ListRecipes for getting\n the next set of recipes (if they exist).

" + } } } }, @@ -4030,34 +4091,34 @@ "com.amazonaws.personalize#ListSchemasRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.personalize#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of schemas to return.

" - } - }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListSchemas for getting\n the next set of schemas (if they exist).

" } + }, + "maxResults": { + "target": "com.amazonaws.personalize#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of schemas to return.

" + } } } }, "com.amazonaws.personalize#ListSchemasResponse": { "type": "structure", "members": { - "schemas": { - "target": "com.amazonaws.personalize#Schemas", - "traits": { - "smithy.api#documentation": "

A list of schemas.

" - } - }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token used to get the next set of schemas (if they exist).

" } + }, + "schemas": { + "target": "com.amazonaws.personalize#Schemas", + "traits": { + "smithy.api#documentation": "

A list of schemas.

" + } } } }, @@ -4094,12 +4155,6 @@ "com.amazonaws.personalize#ListSolutionVersionsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", - "traits": { - "smithy.api#documentation": "

A token returned from the previous call to ListSolutionVersions for getting\n the next set of solution versions (if they exist).

" - } - }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { @@ -4111,23 +4166,29 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution.

" } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "

A token returned from the previous call to ListSolutionVersions for getting\n the next set of solution versions (if they exist).

" + } } } }, "com.amazonaws.personalize#ListSolutionVersionsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.personalize#NextToken", - "traits": { - "smithy.api#documentation": "

A token for getting the next set of solution versions (if they exist).

" - } - }, "solutionVersions": { "target": "com.amazonaws.personalize#SolutionVersions", "traits": { "smithy.api#documentation": "

A list of solution versions describing the version properties.

" } + }, + "nextToken": { + "target": "com.amazonaws.personalize#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of solution versions (if they exist).

" + } } } }, @@ -4296,22 +4357,34 @@ "com.amazonaws.personalize#Recipe": { "type": "structure", "members": { + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", + "traits": { + "smithy.api#documentation": "

The date and time (in Unix format) that the recipe was last updated.

" + } + }, + "featureTransformationArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the FeatureTransformation object.

" + } + }, "recipeType": { "target": "com.amazonaws.personalize#RecipeType", "traits": { "smithy.api#documentation": "

One of the following values:

\n
    \n
  • \n

    PERSONALIZED_RANKING

    \n
    • \n
  • \n

    RELATED_ITEMS

    \n
    • \n
  • \n

    USER_PERSONALIZATION

    \n
    • \n
" } }, - "name": { - "target": "com.amazonaws.personalize#Name", + "algorithmArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The name of the recipe.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train\n the model.

" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.personalize#Date", + "description": { + "target": "com.amazonaws.personalize#Description", "traits": { - "smithy.api#documentation": "

The date and time (in Unix format) that the recipe was last updated.

" + "smithy.api#documentation": "

The description of the recipe.

" } }, "recipeArn": { @@ -4320,10 +4393,10 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recipe.

" } }, - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", + "name": { + "target": "com.amazonaws.personalize#Name", "traits": { - "smithy.api#documentation": "

The date and time (in Unix format) that the recipe was created.

" + "smithy.api#documentation": "

The name of the recipe.

" } }, "status": { @@ -4332,22 +4405,10 @@ "smithy.api#documentation": "

The status of the recipe.

" } }, - "featureTransformationArn": { - "target": "com.amazonaws.personalize#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the FeatureTransformation object.

" - } - }, - "description": { - "target": "com.amazonaws.personalize#Description", - "traits": { - "smithy.api#documentation": "

The description of the recipe.

" - } - }, - "algorithmArn": { - "target": "com.amazonaws.personalize#Arn", + "creationDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train\n the model.

" + "smithy.api#documentation": "

The date and time (in Unix format) that the recipe was created.

" } } }, @@ -4369,28 +4430,22 @@ "com.amazonaws.personalize#RecipeSummary": { "type": "structure", "members": { - "creationDateTime": { - "target": "com.amazonaws.personalize#Date", - "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the recipe was created.

" - } - }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the recipe.

" } }, - "lastUpdatedDateTime": { + "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the recipe was last updated.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the recipe was created.

" } }, - "recipeArn": { - "target": "com.amazonaws.personalize#Arn", + "lastUpdatedDateTime": { + "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recipe.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the recipe was last updated.

" } }, "name": { @@ -4398,6 +4453,12 @@ "traits": { "smithy.api#documentation": "

The name of the recipe.

" } + }, + "recipeArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recipe.

" + } } }, "traits": { @@ -4492,18 +4553,18 @@ "com.amazonaws.personalize#S3DataConfig": { "type": "structure", "members": { - "kmsKeyArn": { - "target": "com.amazonaws.personalize#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key that Amazon Personalize uses to\n encrypt or decrypt the input and output files of a batch inference job.

" - } - }, "path": { "target": "com.amazonaws.personalize#S3Location", "traits": { "smithy.api#documentation": "

The file path of the Amazon S3 bucket.

", "smithy.api#required": {} } + }, + "kmsKeyArn": { + "target": "com.amazonaws.personalize#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key that Amazon Personalize uses to\n encrypt or decrypt the input and output files of a batch inference job.

" + } } }, "traits": { @@ -4534,22 +4595,16 @@ "com.amazonaws.personalize#Solution": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.personalize#Status", - "traits": { - "smithy.api#documentation": "

The status of the solution.

\n

A solution can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" - } - }, - "solutionConfig": { - "target": "com.amazonaws.personalize#SolutionConfig", + "autoMLResult": { + "target": "com.amazonaws.personalize#AutoMLResult", "traits": { - "smithy.api#documentation": "

Describes the configuration properties for the solution.

" + "smithy.api#documentation": "

When performAutoML is true, specifies the best recipe found.

" } }, - "performAutoML": { - "target": "com.amazonaws.personalize#PerformAutoML", + "performHPO": { + "target": "com.amazonaws.personalize#PerformHPO", "traits": { - "smithy.api#documentation": "

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from\n the list specified in the solution configuration (recipeArn must not be specified).\n When false (the default), Amazon Personalize uses recipeArn for training.

" + "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The\n default is false.

" } }, "lastUpdatedDateTime": { @@ -4558,16 +4613,10 @@ "smithy.api#documentation": "

The date and time (in Unix time) that the solution was last updated.

" } }, - "performHPO": { - "target": "com.amazonaws.personalize#PerformHPO", - "traits": { - "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The\n default is false.

" - } - }, - "datasetGroupArn": { - "target": "com.amazonaws.personalize#Arn", + "latestSolutionVersion": { + "target": "com.amazonaws.personalize#SolutionVersionSummary", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

" + "smithy.api#documentation": "

Describes the latest version of the solution, including the status and the ARN.

" } }, "creationDateTime": { @@ -4576,28 +4625,40 @@ "smithy.api#documentation": "

The creation date and time (in Unix time) of the solution.

" } }, + "status": { + "target": "com.amazonaws.personalize#Status", + "traits": { + "smithy.api#documentation": "

The status of the solution.

\n

A solution can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" + } + }, + "performAutoML": { + "target": "com.amazonaws.personalize#PerformAutoML", + "traits": { + "smithy.api#documentation": "

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from\n the list specified in the solution configuration (recipeArn must not be specified).\n When false (the default), Amazon Personalize uses recipeArn for training.

" + } + }, "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the solution.

" } }, - "recipeArn": { + "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the recipe used to create the solution.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

" } }, - "latestSolutionVersion": { - "target": "com.amazonaws.personalize#SolutionVersionSummary", + "eventType": { + "target": "com.amazonaws.personalize#EventType", "traits": { - "smithy.api#documentation": "

Describes the latest version of the solution, including the status and the ARN.

" + "smithy.api#documentation": "

The event type (for example, 'click' or 'like') that is used for training the model.

" } }, - "autoMLResult": { - "target": "com.amazonaws.personalize#AutoMLResult", + "recipeArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

When performAutoML is true, specifies the best recipe found.

" + "smithy.api#documentation": "

The ARN of the recipe used to create the solution.

" } }, "solutionArn": { @@ -4606,10 +4667,10 @@ "smithy.api#documentation": "

The ARN of the solution.

" } }, - "eventType": { - "target": "com.amazonaws.personalize#EventType", + "solutionConfig": { + "target": "com.amazonaws.personalize#SolutionConfig", "traits": { - "smithy.api#documentation": "

The event type (for example, 'click' or 'like') that is used for training the model.

" + "smithy.api#documentation": "

Describes the configuration properties for the solution.

" } } }, @@ -4620,16 +4681,10 @@ "com.amazonaws.personalize#SolutionConfig": { "type": "structure", "members": { - "eventValueThreshold": { - "target": "com.amazonaws.personalize#EventValueThreshold", - "traits": { - "smithy.api#documentation": "

Only events with a value greater than or equal to this threshold are\n used for training a model.

" - } - }, - "autoMLConfig": { - "target": "com.amazonaws.personalize#AutoMLConfig", + "hpoConfig": { + "target": "com.amazonaws.personalize#HPOConfig", "traits": { - "smithy.api#documentation": "

The AutoMLConfig object containing a list of recipes to search\n when AutoML is performed.

" + "smithy.api#documentation": "

Describes the properties for hyperparameter optimization (HPO).

" } }, "featureTransformationParameters": { @@ -4638,10 +4693,16 @@ "smithy.api#documentation": "

Lists the feature transformation parameters.

" } }, - "hpoConfig": { - "target": "com.amazonaws.personalize#HPOConfig", + "eventValueThreshold": { + "target": "com.amazonaws.personalize#EventValueThreshold", "traits": { - "smithy.api#documentation": "

Describes the properties for hyperparameter optimization (HPO).

" + "smithy.api#documentation": "

Only events with a value greater than or equal to this threshold are\n used for training a model.

" + } + }, + "autoMLConfig": { + "target": "com.amazonaws.personalize#AutoMLConfig", + "traits": { + "smithy.api#documentation": "

The AutoMLConfig object containing a list of recipes to search\n when AutoML is performed.

" } }, "algorithmHyperParameters": { @@ -4664,10 +4725,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution.

" } }, - "lastUpdatedDateTime": { + "name": { + "target": "com.amazonaws.personalize#Name", + "traits": { + "smithy.api#documentation": "

The name of the solution.

" + } + }, + "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the solution was last updated.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the solution was created.

" } }, "status": { @@ -4676,16 +4743,10 @@ "smithy.api#documentation": "

The status of the solution.

\n

A solution can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    \n
    • \n
  • \n

    DELETE PENDING > DELETE IN_PROGRESS

    \n
    • \n
" } }, - "creationDateTime": { + "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { - "smithy.api#documentation": "

The date and time (in Unix time) that the solution was created.

" - } - }, - "name": { - "target": "com.amazonaws.personalize#Name", - "traits": { - "smithy.api#documentation": "

The name of the solution.

" + "smithy.api#documentation": "

The date and time (in Unix time) that the solution was last updated.

" } } }, @@ -4696,10 +4757,10 @@ "com.amazonaws.personalize#SolutionVersion": { "type": "structure", "members": { - "solutionConfig": { - "target": "com.amazonaws.personalize#SolutionConfig", + "performAutoML": { + "target": "com.amazonaws.personalize#PerformAutoML", "traits": { - "smithy.api#documentation": "

Describes the configuration properties for the solution.

" + "smithy.api#documentation": "

When true, Amazon Personalize searches for the most optimal recipe according to the solution\n configuration. When false (the default), Amazon Personalize uses recipeArn.

" } }, "lastUpdatedDateTime": { @@ -4708,28 +4769,34 @@ "smithy.api#documentation": "

The date and time (in\n Unix\n time) that the solution was last updated.

" } }, - "status": { - "target": "com.amazonaws.personalize#Status", + "performHPO": { + "target": "com.amazonaws.personalize#PerformHPO", "traits": { - "smithy.api#documentation": "

The status of the solution version.

\n

A solution version can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING

    \n
    • \n
  • \n

    CREATE IN_PROGRESS

    \n
    • \n
  • \n

    ACTIVE

    \n
    • \n
  • \n

    CREATE FAILED

    \n
    • \n
" + "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is\n false.

" } }, - "tunedHPOParams": { - "target": "com.amazonaws.personalize#TunedHPOParams", + "solutionConfig": { + "target": "com.amazonaws.personalize#SolutionConfig", "traits": { - "smithy.api#documentation": "

If hyperparameter optimization was performed, contains the hyperparameter values of the\n best performing model.

" + "smithy.api#documentation": "

Describes the configuration properties for the solution.

" } }, - "performHPO": { - "target": "com.amazonaws.personalize#PerformHPO", + "solutionArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is\n false.

" + "smithy.api#documentation": "

The ARN of the solution.

" } }, - "performAutoML": { - "target": "com.amazonaws.personalize#PerformAutoML", + "trainingHours": { + "target": "com.amazonaws.personalize#TrainingHours", "traits": { - "smithy.api#documentation": "

When true, Amazon Personalize searches for the most optimal recipe according to the solution\n configuration. When false (the default), Amazon Personalize uses recipeArn.

" + "smithy.api#documentation": "

The time used to train the model. You are billed for the time it takes to train a model.\n This field is visible only after Amazon Personalize successfully trains a model.

" + } + }, + "eventType": { + "target": "com.amazonaws.personalize#EventType", + "traits": { + "smithy.api#documentation": "

The event type (for example, 'click' or 'like') that is used for training the\n model.

" } }, "trainingMode": { @@ -4738,16 +4805,16 @@ "smithy.api#documentation": "

The scope of training used to create the solution version. The FULL option\n trains the solution version based on the entirety of the input solution's training data, while\n the UPDATE option processes only the training data that has changed since the\n creation of the last solution version. Choose UPDATE when you want to start\n recommending items added to the dataset without retraining the model.

\n \n

The UPDATE option can only be used after you've created a solution version\n with the FULL option and the training solution uses the native-recipe-hrnn-coldstart.

\n " } }, - "trainingHours": { - "target": "com.amazonaws.personalize#TrainingHours", + "recipeArn": { + "target": "com.amazonaws.personalize#Arn", "traits": { - "smithy.api#documentation": "

The time used to train the model. You are billed for the time it takes to train a model.\n This field is visible only after Amazon Personalize successfully trains a model.

" + "smithy.api#documentation": "

The ARN of the recipe used in the solution.

" } }, - "failureReason": { - "target": "com.amazonaws.personalize#FailureReason", + "tunedHPOParams": { + "target": "com.amazonaws.personalize#TunedHPOParams", "traits": { - "smithy.api#documentation": "

If training a solution version fails, the reason for the failure.

" + "smithy.api#documentation": "

If hyperparameter optimization was performed, contains the hyperparameter values of the\n best performing model.

" } }, "creationDateTime": { @@ -4756,22 +4823,16 @@ "smithy.api#documentation": "

The date and\n time\n (in Unix time) that this version of the solution was created.

" } }, - "eventType": { - "target": "com.amazonaws.personalize#EventType", - "traits": { - "smithy.api#documentation": "

The event type (for example, 'click' or 'like') that is used for training the\n model.

" - } - }, - "solutionArn": { - "target": "com.amazonaws.personalize#Arn", + "status": { + "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "

The ARN of the solution.

" + "smithy.api#documentation": "

The status of the solution version.

\n

A solution version can be in one of the following states:

\n
    \n
  • \n

    CREATE PENDING

    \n
    • \n
  • \n

    CREATE IN_PROGRESS

    \n
    • \n
  • \n

    ACTIVE

    \n
    • \n
  • \n

    CREATE FAILED

    \n
    • \n
" } }, - "recipeArn": { - "target": "com.amazonaws.personalize#Arn", + "failureReason": { + "target": "com.amazonaws.personalize#FailureReason", "traits": { - "smithy.api#documentation": "

The ARN of the recipe used in the solution.

" + "smithy.api#documentation": "

If training a solution version fails, the reason for the failure.

" } }, "solutionVersionArn": { @@ -4957,10 +5018,10 @@ "com.amazonaws.personalize#UpdateCampaignRequest": { "type": "structure", "members": { - "solutionVersionArn": { - "target": "com.amazonaws.personalize#Arn", + "minProvisionedTPS": { + "target": "com.amazonaws.personalize#TransactionsPerSecond", "traits": { - "smithy.api#documentation": "

The ARN of a new solution version to deploy.

" + "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second that\n Amazon Personalize will support.

" } }, "campaignArn": { @@ -4970,10 +5031,16 @@ "smithy.api#required": {} } }, - "minProvisionedTPS": { - "target": "com.amazonaws.personalize#TransactionsPerSecond", + "campaignConfig": { + "target": "com.amazonaws.personalize#CampaignConfig", "traits": { - "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second that\n Amazon Personalize will support.

" + "smithy.api#documentation": "

The configuration details of a campaign.

" + } + }, + "solutionVersionArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of a new solution version to deploy.

" } } } diff --git a/codegen/sdk-codegen/aws-models/pi.2018-02-27.json b/codegen/sdk-codegen/aws-models/pi.2018-02-27.json index 767d4c481357..0b8874a8b0c3 100644 --- a/codegen/sdk-codegen/aws-models/pi.2018-02-27.json +++ b/codegen/sdk-codegen/aws-models/pi.2018-02-27.json @@ -83,18 +83,17 @@ "com.amazonaws.pi#DescribeDimensionKeysRequest": { "type": "structure", "members": { - "Identifier": { - "target": "com.amazonaws.pi#String", + "StartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", "traits": { - "smithy.api#documentation": "

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.

\n

To use an Amazon RDS instance as a data source, you specify its\n DbiResourceId value - for example:\n db-FAIHNTYBKTGAUSUZQYPDS2GW4A\n

", + "smithy.api#documentation": "

The date and time specifying the beginning of the requested time series data. \n You can't specify a StartTime that's earlier than 7 days ago. The value\n specified is inclusive - data points equal to or greater than\n StartTime will be returned.

\n

The value for StartTime must be earlier than the value for\n EndTime.

", "smithy.api#required": {} } }, - "GroupBy": { + "PartitionBy": { "target": "com.amazonaws.pi#DimensionGroup", "traits": { - "smithy.api#documentation": "

A specification for how to aggregate the data points from a query result. You must\n specify a valid dimension group. Performance Insights will return all of the dimensions within that group,\n unless you provide the names of specific dimensions within that group. You can also request\n that Performance Insights return a limited number of values for a dimension.

", - "smithy.api#required": {} + "smithy.api#documentation": "

For each dimension specified in \n GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

" } }, "Metric": { @@ -104,36 +103,30 @@ "smithy.api#required": {} } }, - "PeriodInSeconds": { - "target": "com.amazonaws.pi#Integer", + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as\n one second, or as long as one day (86400 seconds). Valid values are:

\n \n
    \n
  • \n

    \n 1 (one second)

    \n
    • \n
  • \n

    \n 60 (one minute)

    \n
    • \n
  • \n

    \n 300 (five minutes)

    \n
    • \n
  • \n

    \n 3600 (one hour)

    \n
    • \n
  • \n

    \n 86400 (twenty-four hours)

    \n
    • \n
\n \n

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for\n you, with a goal of returning roughly 100-200 data points in the response.

" + "smithy.api#documentation": "

The AWS service for which Performance Insights will return metrics. The only valid value for\n ServiceType is: RDS\n

", + "smithy.api#required": {} } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.pi#ISOTimestamp", "traits": { - "smithy.api#documentation": "

The date and time specifying the beginning of the requested time series data. \n You can't specify a StartTime that's earlier than 7 days ago. The value\n specified is inclusive - data points equal to or greater than\n StartTime will be returned.

\n

The value for StartTime must be earlier than the value for\n EndTime.

", + "smithy.api#documentation": "

The date and time specifying the end of the requested time series data. The value\n specified is exclusive - data points less than (but not equal to)\n EndTime will be returned.

\n

The value for EndTime must be later than the value for\n StartTime.

", "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pi#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If\n this parameter is specified, the response includes only records beyond the token, up to the\n value specified by MaxRecords.

" - } - }, "MaxResults": { "target": "com.amazonaws.pi#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. \n If more items exist than the specified MaxRecords value, a pagination \n token is included in the response so that the remaining \n results can be retrieved.\n

" } }, - "ServiceType": { - "target": "com.amazonaws.pi#ServiceType", + "NextToken": { + "target": "com.amazonaws.pi#String", "traits": { - "smithy.api#documentation": "

The AWS service for which Performance Insights will return metrics. The only valid value for\n ServiceType is: RDS\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If\n this parameter is specified, the response includes only records beyond the token, up to the\n value specified by MaxRecords.

" } }, "Filter": { @@ -142,16 +135,23 @@ "smithy.api#documentation": "

One or more filters to apply in the request. Restrictions:

\n
    \n
  • \n

    Any number of filters by the same dimension, as specified in the GroupBy or\n Partition parameters.

    \n
    • \n
  • \n

    A single filter for any other dimension in this dimension group.

    \n
    • \n
" } }, - "PartitionBy": { + "PeriodInSeconds": { + "target": "com.amazonaws.pi#Integer", + "traits": { + "smithy.api#documentation": "

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as\n one second, or as long as one day (86400 seconds). Valid values are:

\n \n
    \n
  • \n

    \n 1 (one second)

    \n
    • \n
  • \n

    \n 60 (one minute)

    \n
    • \n
  • \n

    \n 300 (five minutes)

    \n
    • \n
  • \n

    \n 3600 (one hour)

    \n
    • \n
  • \n

    \n 86400 (twenty-four hours)

    \n
    • \n
\n \n

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for\n you, with a goal of returning roughly 100-200 data points in the response.

" + } + }, + "GroupBy": { "target": "com.amazonaws.pi#DimensionGroup", "traits": { - "smithy.api#documentation": "

For each dimension specified in \n GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

" + "smithy.api#documentation": "

A specification for how to aggregate the data points from a query result. You must\n specify a valid dimension group. Performance Insights will return all of the dimensions within that group,\n unless you provide the names of specific dimensions within that group. You can also request\n that Performance Insights return a limited number of values for a dimension.

", + "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.pi#ISOTimestamp", + "Identifier": { + "target": "com.amazonaws.pi#String", "traits": { - "smithy.api#documentation": "

The date and time specifying the end of the requested time series data. The value\n specified is exclusive - data points less than (but not equal to)\n EndTime will be returned.

\n

The value for EndTime must be later than the value for\n StartTime.

", + "smithy.api#documentation": "

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.

\n

To use an Amazon RDS instance as a data source, you specify its\n DbiResourceId value - for example:\n db-FAIHNTYBKTGAUSUZQYPDS2GW4A\n

", "smithy.api#required": {} } } @@ -160,18 +160,6 @@ "com.amazonaws.pi#DescribeDimensionKeysResponse": { "type": "structure", "members": { - "AlignedEndTime": { - "target": "com.amazonaws.pi#ISOTimestamp", - "traits": { - "smithy.api#documentation": "

The end time for the returned dimension keys, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedEndTime will be greater than\n or equal to the value of the user-specified Endtime.

" - } - }, - "AlignedStartTime": { - "target": "com.amazonaws.pi#ISOTimestamp", - "traits": { - "smithy.api#documentation": "

The start time for the returned dimension keys, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedStartTime will be less than or\n equal to the value of the user-specified StartTime.

" - } - }, "NextToken": { "target": "com.amazonaws.pi#String", "traits": { @@ -184,6 +172,18 @@ "smithy.api#documentation": "

The dimension keys that were requested.

" } }, + "AlignedEndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "

The end time for the returned dimension keys, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedEndTime will be greater than\n or equal to the value of the user-specified Endtime.

" + } + }, + "AlignedStartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "

The start time for the returned dimension keys, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedStartTime will be less than or\n equal to the value of the user-specified StartTime.

" + } + }, "PartitionKeys": { "target": "com.amazonaws.pi#ResponsePartitionKeyList", "traits": { @@ -195,10 +195,10 @@ "com.amazonaws.pi#DimensionGroup": { "type": "structure", "members": { - "Dimensions": { - "target": "com.amazonaws.pi#StringList", + "Limit": { + "target": "com.amazonaws.pi#Limit", "traits": { - "smithy.api#documentation": "

A list of specific dimensions from a dimension group. If this parameter is not present,\n then it signifies that all of the dimensions in the group were requested, or are present in\n the response.

\n

Valid values for elements in the Dimensions array are:

\n
    \n
  • \n

    db.user.id

    \n
    • \n
  • \n

    db.user.name

    \n
    • \n
  • \n

    db.host.id

    \n
    • \n
  • \n

    db.host.name

    \n
    • \n
  • \n

    db.sql.id

    \n
    • \n
  • \n

    db.sql.db_id

    \n
    • \n
  • \n

    db.sql.statement

    \n
    • \n
  • \n

    db.sql.tokenized_id

    \n
    • \n
  • \n

    db.sql_tokenized.id

    \n
    • \n
  • \n

    db.sql_tokenized.db_id

    \n
    • \n
  • \n

    db.sql_tokenized.statement

    \n
    • \n
  • \n

    db.wait_event.name

    \n
    • \n
  • \n

    db.wait_event.type

    \n
    • \n
  • \n

    db.wait_event_type.name

    \n
    • \n
" + "smithy.api#documentation": "

The maximum number of items to fetch for this dimension group.

" } }, "Group": { @@ -208,10 +208,10 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.pi#Limit", + "Dimensions": { + "target": "com.amazonaws.pi#StringList", "traits": { - "smithy.api#documentation": "

The maximum number of items to fetch for this dimension group.

" + "smithy.api#documentation": "

A list of specific dimensions from a dimension group. If this parameter is not present,\n then it signifies that all of the dimensions in the group were requested, or are present in\n the response.

\n

Valid values for elements in the Dimensions array are:

\n
    \n
  • \n

    db.user.id

    \n
    • \n
  • \n

    db.user.name

    \n
    • \n
  • \n

    db.host.id

    \n
    • \n
  • \n

    db.host.name

    \n
    • \n
  • \n

    db.sql.id

    \n
    • \n
  • \n

    db.sql.db_id

    \n
    • \n
  • \n

    db.sql.statement

    \n
    • \n
  • \n

    db.sql.tokenized_id

    \n
    • \n
  • \n

    db.sql_tokenized.id

    \n
    • \n
  • \n

    db.sql_tokenized.db_id

    \n
    • \n
  • \n

    db.sql_tokenized.statement

    \n
    • \n
  • \n

    db.wait_event.name

    \n
    • \n
  • \n

    db.wait_event.type

    \n
    • \n
  • \n

    db.wait_event_type.name

    \n
    • \n
" } } }, @@ -222,18 +222,18 @@ "com.amazonaws.pi#DimensionKeyDescription": { "type": "structure", "members": { - "Partitions": { - "target": "com.amazonaws.pi#MetricValuesList", - "traits": { - "smithy.api#documentation": "

If PartitionBy was specified, PartitionKeys contains the dimensions that were.

" - } - }, "Total": { "target": "com.amazonaws.pi#Double", "traits": { "smithy.api#documentation": "

The aggregated metric value for the dimension(s), over the requested time range.

" } }, + "Partitions": { + "target": "com.amazonaws.pi#MetricValuesList", + "traits": { + "smithy.api#documentation": "

If PartitionBy was specified, PartitionKeys contains the dimensions that were.

" + } + }, "Dimensions": { "target": "com.amazonaws.pi#DimensionMap", "traits": { @@ -292,22 +292,16 @@ "com.amazonaws.pi#GetResourceMetricsRequest": { "type": "structure", "members": { - "PeriodInSeconds": { - "target": "com.amazonaws.pi#Integer", - "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as\n one second, or as long as one day (86400 seconds). Valid values are:

\n \n
    \n
  • \n

    \n 1 (one second)

    \n
    • \n
  • \n

    \n 60 (one minute)

    \n
    • \n
  • \n

    \n 300 (five minutes)

    \n
    • \n
  • \n

    \n 3600 (one hour)

    \n
    • \n
  • \n

    \n 86400 (twenty-four hours)

    \n
    • \n
\n \n

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for\n you, with a goal of returning roughly 100-200 data points in the response.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.pi#MaxResults", + "NextToken": { + "target": "com.amazonaws.pi#String", "traits": { - "smithy.api#documentation": "

The maximum number of items to return in the response. \n If more items exist than the specified MaxRecords value, a pagination \n token is included in the response so that the remaining \n results can be retrieved.\n

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If\n this parameter is specified, the response includes only records beyond the token, up to the\n value specified by MaxRecords.

" } }, - "ServiceType": { - "target": "com.amazonaws.pi#ServiceType", + "MetricQueries": { + "target": "com.amazonaws.pi#MetricQueryList", "traits": { - "smithy.api#documentation": "

The AWS service for which Performance Insights will return metrics. The only valid value for\n ServiceType is: RDS\n

", + "smithy.api#documentation": "

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and\n can optionally specify aggregation and filtering criteria.

", "smithy.api#required": {} } }, @@ -318,16 +312,10 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pi#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If\n this parameter is specified, the response includes only records beyond the token, up to the\n value specified by MaxRecords.

" - } - }, - "MetricQueries": { - "target": "com.amazonaws.pi#MetricQueryList", + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", "traits": { - "smithy.api#documentation": "

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and\n can optionally specify aggregation and filtering criteria.

", + "smithy.api#documentation": "

The AWS service for which Performance Insights will return metrics. The only valid value for\n ServiceType is: RDS\n

", "smithy.api#required": {} } }, @@ -338,6 +326,18 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.pi#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return in the response. \n If more items exist than the specified MaxRecords value, a pagination \n token is included in the response so that the remaining \n results can be retrieved.\n

" + } + }, + "PeriodInSeconds": { + "target": "com.amazonaws.pi#Integer", + "traits": { + "smithy.api#documentation": "

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as\n one second, or as long as one day (86400 seconds). Valid values are:

\n \n
    \n
  • \n

    \n 1 (one second)

    \n
    • \n
  • \n

    \n 60 (one minute)

    \n
    • \n
  • \n

    \n 300 (five minutes)

    \n
    • \n
  • \n

    \n 3600 (one hour)

    \n
    • \n
  • \n

    \n 86400 (twenty-four hours)

    \n
    • \n
\n \n

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for\n you, with a goal of returning roughly 100-200 data points in the response.

" + } + }, "Identifier": { "target": "com.amazonaws.pi#String", "traits": { @@ -350,16 +350,16 @@ "com.amazonaws.pi#GetResourceMetricsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pi#String", + "AlignedEndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If\n this parameter is specified, the response includes only records beyond the token, up to the\n value specified by MaxRecords.

" + "smithy.api#documentation": "

The end time for the returned metrics, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedEndTime will be greater than\n or equal to the value of the user-specified Endtime.

" } }, - "MetricList": { - "target": "com.amazonaws.pi#MetricKeyDataPointsList", + "AlignedStartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", "traits": { - "smithy.api#documentation": "

An array of metric results,, where each array element contains all of the data points for a particular dimension.

" + "smithy.api#documentation": "

The start time for the returned metrics, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedStartTime will be less than or\n equal to the value of the user-specified StartTime.

" } }, "Identifier": { @@ -368,16 +368,16 @@ "smithy.api#documentation": "

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.

\n

To use an Amazon RDS instance as a data source, you specify its \n DbiResourceId value - for example: \n db-FAIHNTYBKTGAUSUZQYPDS2GW4A\n

" } }, - "AlignedStartTime": { - "target": "com.amazonaws.pi#ISOTimestamp", + "MetricList": { + "target": "com.amazonaws.pi#MetricKeyDataPointsList", "traits": { - "smithy.api#documentation": "

The start time for the returned metrics, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedStartTime will be less than or\n equal to the value of the user-specified StartTime.

" + "smithy.api#documentation": "

An array of metric results,, where each array element contains all of the data points for a particular dimension.

" } }, - "AlignedEndTime": { - "target": "com.amazonaws.pi#ISOTimestamp", + "NextToken": { + "target": "com.amazonaws.pi#String", "traits": { - "smithy.api#documentation": "

The end time for the returned metrics, after alignment to a granular boundary (as\n specified by PeriodInSeconds). AlignedEndTime will be greater than\n or equal to the value of the user-specified Endtime.

" + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If\n this parameter is specified, the response includes only records beyond the token, up to the\n value specified by MaxRecords.

" } } } @@ -438,17 +438,17 @@ "com.amazonaws.pi#MetricKeyDataPoints": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.pi#ResponseResourceMetricKey", - "traits": { - "smithy.api#documentation": "

The dimension(s) to which the data points apply.

" - } - }, "DataPoints": { "target": "com.amazonaws.pi#DataPointsList", "traits": { "smithy.api#documentation": "

An array of timestamp-value pairs, representing measurements over a period of time.

" } + }, + "Key": { + "target": "com.amazonaws.pi#ResponseResourceMetricKey", + "traits": { + "smithy.api#documentation": "

The dimension(s) to which the data points apply.

" + } } }, "traits": { @@ -464,12 +464,6 @@ "com.amazonaws.pi#MetricQuery": { "type": "structure", "members": { - "GroupBy": { - "target": "com.amazonaws.pi#DimensionGroup", - "traits": { - "smithy.api#documentation": "

A specification for how to aggregate the data points from a query result. You must\n specify a valid dimension group. Performance Insights will return all of the dimensions within that group,\n unless you provide the names of specific dimensions within that group. You can also request\n that Performance Insights return a limited number of values for a dimension.

" - } - }, "Metric": { "target": "com.amazonaws.pi#String", "traits": { @@ -477,6 +471,12 @@ "smithy.api#required": {} } }, + "GroupBy": { + "target": "com.amazonaws.pi#DimensionGroup", + "traits": { + "smithy.api#documentation": "

A specification for how to aggregate the data points from a query result. You must\n specify a valid dimension group. Performance Insights will return all of the dimensions within that group,\n unless you provide the names of specific dimensions within that group. You can also request\n that Performance Insights return a limited number of values for a dimension.

" + } + }, "Filter": { "target": "com.amazonaws.pi#MetricQueryFilterMap", "traits": { @@ -543,7 +543,7 @@ "sdkId": "PI", "arnNamespace": "pi", "cloudFormationName": "PI", - "cloudTrailEventSource": "v20180227.pi.amazonaws" + "cloudTrailEventSource": "pi.amazonaws.com" }, "aws.auth#sigv4": { "name": "pi" @@ -580,18 +580,18 @@ "com.amazonaws.pi#ResponseResourceMetricKey": { "type": "structure", "members": { + "Dimensions": { + "target": "com.amazonaws.pi#DimensionMap", + "traits": { + "smithy.api#documentation": "

The valid dimensions for the metric.

" + } + }, "Metric": { "target": "com.amazonaws.pi#String", "traits": { "smithy.api#documentation": "

The name of a Performance Insights metric to be measured.

\n

Valid values for Metric are:

\n \n
    \n
  • \n

    \n db.load.avg - a scaled representation of the number of active sessions\n for the database engine.

    \n
    • \n
  • \n

    \n db.sampledload.avg - the raw number of active sessions for the\n database engine.

    \n
    • \n
", "smithy.api#required": {} } - }, - "Dimensions": { - "target": "com.amazonaws.pi#DimensionMap", - "traits": { - "smithy.api#documentation": "

The valid dimensions for the metric.

" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/pinpoint-email.2018-07-26.json b/codegen/sdk-codegen/aws-models/pinpoint-email.2018-07-26.json index b490d3c12a0b..588d224cdc75 100644 --- a/codegen/sdk-codegen/aws-models/pinpoint-email.2018-07-26.json +++ b/codegen/sdk-codegen/aws-models/pinpoint-email.2018-07-26.json @@ -191,7 +191,7 @@ "sdkId": "Pinpoint Email", "arnNamespace": "ses", "cloudFormationName": "PinpointEmail", - "cloudTrailEventSource": "svc.frontend.pinpoint.bacon.amazon.com" + "cloudTrailEventSource": "pinpointemail.amazonaws.com" }, "aws.auth#sigv4": { "name": "ses" @@ -248,17 +248,17 @@ "smithy.api#documentation": "

Additional information about the blacklisting event, as provided by the blacklist\n maintainer.

" } }, - "ListingTime": { - "target": "com.amazonaws.pinpointemail#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the blacklisting event occurred, shown in Unix time format.

" - } - }, "RblName": { "target": "com.amazonaws.pinpointemail#RblName", "traits": { "smithy.api#documentation": "

The name of the blacklist that the IP address appears on.

" } + }, + "ListingTime": { + "target": "com.amazonaws.pinpointemail#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the blacklisting event occurred, shown in Unix time format.

" + } } }, "traits": { @@ -295,16 +295,16 @@ "com.amazonaws.pinpointemail#Body": { "type": "structure", "members": { - "Html": { + "Text": { "target": "com.amazonaws.pinpointemail#Content", "traits": { - "smithy.api#documentation": "

An object that represents the version of the message that is displayed in email\n clients that support HTML. HTML messages can include formatted text, hyperlinks, images,\n and more.

" + "smithy.api#documentation": "

An object that represents the version of the message that is displayed in email\n clients that don't support HTML, or clients where the recipient has disabled HTML\n rendering.

" } }, - "Text": { + "Html": { "target": "com.amazonaws.pinpointemail#Content", "traits": { - "smithy.api#documentation": "

An object that represents the version of the message that is displayed in email\n clients that don't support HTML, or clients where the recipient has disabled HTML\n rendering.

" + "smithy.api#documentation": "

An object that represents the version of the message that is displayed in email\n clients that support HTML. HTML messages can include formatted text, hyperlinks, images,\n and more.

" } } }, @@ -343,17 +343,17 @@ "smithy.api#required": {} } }, - "DimensionName": { - "target": "com.amazonaws.pinpointemail#DimensionName", + "DimensionValueSource": { + "target": "com.amazonaws.pinpointemail#DimensionValueSource", "traits": { - "smithy.api#documentation": "

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to\n meet the following criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),\n or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", + "smithy.api#documentation": "

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you\n want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header\n or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you\n want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want\n Amazon Pinpoint to use link tags, choose linkTags.

", "smithy.api#required": {} } }, - "DimensionValueSource": { - "target": "com.amazonaws.pinpointemail#DimensionValueSource", + "DimensionName": { + "target": "com.amazonaws.pinpointemail#DimensionName", "traits": { - "smithy.api#documentation": "

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you\n want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header\n or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you\n want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want\n Amazon Pinpoint to use link tags, choose linkTags.

", + "smithy.api#documentation": "

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to\n meet the following criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),\n or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", "smithy.api#required": {} } } @@ -543,10 +543,10 @@ "smithy.api#documentation": "

An array of objects that define the tags (keys and values) that you want to associate\n with the configuration set.

" } }, - "ReputationOptions": { - "target": "com.amazonaws.pinpointemail#ReputationOptions", + "TrackingOptions": { + "target": "com.amazonaws.pinpointemail#TrackingOptions", "traits": { - "smithy.api#documentation": "

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails\n that you send that use the configuration set.

" + "smithy.api#documentation": "

An object that defines the open and click tracking options for emails that you send\n using the configuration set.

" } }, "ConfigurationSetName": { @@ -556,10 +556,10 @@ "smithy.api#required": {} } }, - "TrackingOptions": { - "target": "com.amazonaws.pinpointemail#TrackingOptions", + "ReputationOptions": { + "target": "com.amazonaws.pinpointemail#ReputationOptions", "traits": { - "smithy.api#documentation": "

An object that defines the open and click tracking options for emails that you send\n using the configuration set.

" + "smithy.api#documentation": "

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails\n that you send that use the configuration set.

" } } }, @@ -685,13 +685,6 @@ "com.amazonaws.pinpointemail#CreateDeliverabilityTestReportRequest": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.pinpointemail#EmailContent", - "traits": { - "smithy.api#documentation": "

The HTML body of the message that you sent when you performed the predictive inbox placement test.

", - "smithy.api#required": {} - } - }, "ReportName": { "target": "com.amazonaws.pinpointemail#ReportName", "traits": { @@ -710,6 +703,13 @@ "smithy.api#documentation": "

The email address that the predictive inbox placement test email was sent from.

", "smithy.api#required": {} } + }, + "Content": { + "target": "com.amazonaws.pinpointemail#EmailContent", + "traits": { + "smithy.api#documentation": "

The HTML body of the message that you sent when you performed the predictive inbox placement test.

", + "smithy.api#required": {} + } } }, "traits": { @@ -772,18 +772,18 @@ "com.amazonaws.pinpointemail#CreateEmailIdentityRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.pinpointemail#TagList", + "traits": { + "smithy.api#documentation": "

An array of objects that define the tags (keys and values) that you want to associate\n with the email identity.

" + } + }, "EmailIdentity": { "target": "com.amazonaws.pinpointemail#Identity", "traits": { "smithy.api#documentation": "

The email address or domain that you want to verify.

", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.pinpointemail#TagList", - "traits": { - "smithy.api#documentation": "

An array of objects that define the tags (keys and values) that you want to associate\n with the email identity.

" - } } }, "traits": { @@ -793,12 +793,6 @@ "com.amazonaws.pinpointemail#CreateEmailIdentityResponse": { "type": "structure", "members": { - "VerifiedForSendingStatus": { - "target": "com.amazonaws.pinpointemail#Enabled", - "traits": { - "smithy.api#documentation": "

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email\n from verified email addresses or domains. For more information about verifying\n identities, see the Amazon Pinpoint User Guide.

" - } - }, "DkimAttributes": { "target": "com.amazonaws.pinpointemail#DkimAttributes", "traits": { @@ -810,6 +804,12 @@ "traits": { "smithy.api#documentation": "

The email identity type.

" } + }, + "VerifiedForSendingStatus": { + "target": "com.amazonaws.pinpointemail#Enabled", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email\n from verified email addresses or domains. For more information about verifying\n identities, see the Amazon Pinpoint User Guide.

" + } } }, "traits": { @@ -825,18 +825,18 @@ "com.amazonaws.pinpointemail#DailyVolume": { "type": "structure", "members": { - "DomainIspPlacements": { - "target": "com.amazonaws.pinpointemail#DomainIspPlacements", - "traits": { - "smithy.api#documentation": "

An object that contains inbox placement metrics for a specified day in the analysis\n period, broken out by the recipient's email provider.

" - } - }, "StartDate": { "target": "com.amazonaws.pinpointemail#Timestamp", "traits": { "smithy.api#documentation": "

The date that the DailyVolume metrics apply to, in Unix time.

" } }, + "DomainIspPlacements": { + "target": "com.amazonaws.pinpointemail#DomainIspPlacements", + "traits": { + "smithy.api#documentation": "

An object that contains inbox placement metrics for a specified day in the analysis\n period, broken out by the recipient's email provider.

" + } + }, "VolumeStatistics": { "target": "com.amazonaws.pinpointemail#VolumeStatistics", "traits": { @@ -857,6 +857,12 @@ "com.amazonaws.pinpointemail#DedicatedIp": { "type": "structure", "members": { + "PoolName": { + "target": "com.amazonaws.pinpointemail#PoolName", + "traits": { + "smithy.api#documentation": "

The name of the dedicated IP pool that the IP address is associated with.

" + } + }, "WarmupStatus": { "target": "com.amazonaws.pinpointemail#WarmupStatus", "traits": { @@ -864,23 +870,17 @@ "smithy.api#required": {} } }, - "Ip": { - "target": "com.amazonaws.pinpointemail#Ip", + "WarmupPercentage": { + "target": "com.amazonaws.pinpointemail#Percentage100Wrapper", "traits": { - "smithy.api#documentation": "

An IP address that is reserved for use by your Amazon Pinpoint account.

", + "smithy.api#documentation": "

Indicates how complete the dedicated IP warm-up process is. When this value equals 1,\n the address has completed the warm-up process and is ready for use.

", "smithy.api#required": {} } }, - "PoolName": { - "target": "com.amazonaws.pinpointemail#PoolName", - "traits": { - "smithy.api#documentation": "

The name of the dedicated IP pool that the IP address is associated with.

" - } - }, - "WarmupPercentage": { - "target": "com.amazonaws.pinpointemail#Percentage100Wrapper", + "Ip": { + "target": "com.amazonaws.pinpointemail#Ip", "traits": { - "smithy.api#documentation": "

Indicates how complete the dedicated IP warm-up process is. When this value equals 1,\n the address has completed the warm-up process and is ready for use.

", + "smithy.api#documentation": "

An IP address that is reserved for use by your Amazon Pinpoint account.

", "smithy.api#required": {} } } @@ -1148,12 +1148,6 @@ "com.amazonaws.pinpointemail#DeliverabilityTestReport": { "type": "structure", "members": { - "DeliverabilityTestStatus": { - "target": "com.amazonaws.pinpointemail#DeliverabilityTestStatus", - "traits": { - "smithy.api#documentation": "

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is COMPLETE, then the test is finished, and you can use\n the GetDeliverabilityTestReport to view the results of the test.

" - } - }, "FromEmailAddress": { "target": "com.amazonaws.pinpointemail#EmailAddress", "traits": { @@ -1166,10 +1160,16 @@ "smithy.api#documentation": "

A name that helps you identify a predictive inbox placement test report.

" } }, - "Subject": { - "target": "com.amazonaws.pinpointemail#DeliverabilityTestSubject", + "CreateDate": { + "target": "com.amazonaws.pinpointemail#Timestamp", "traits": { - "smithy.api#documentation": "

The subject line for an email that you submitted in a predictive inbox placement test.

" + "smithy.api#documentation": "

The date and time when the predictive inbox placement test was created, in Unix time format.

" + } + }, + "DeliverabilityTestStatus": { + "target": "com.amazonaws.pinpointemail#DeliverabilityTestStatus", + "traits": { + "smithy.api#documentation": "

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is COMPLETE, then the test is finished, and you can use\n the GetDeliverabilityTestReport to view the results of the test.

" } }, "ReportId": { @@ -1178,10 +1178,10 @@ "smithy.api#documentation": "

A unique string that identifies the predictive inbox placement test.

" } }, - "CreateDate": { - "target": "com.amazonaws.pinpointemail#Timestamp", + "Subject": { + "target": "com.amazonaws.pinpointemail#DeliverabilityTestSubject", "traits": { - "smithy.api#documentation": "

The date and time when the predictive inbox placement test was created, in Unix time format.

" + "smithy.api#documentation": "

The subject line for an email that you submitted in a predictive inbox placement test.

" } } }, @@ -1240,12 +1240,6 @@ "com.amazonaws.pinpointemail#Destination": { "type": "structure", "members": { - "ToAddresses": { - "target": "com.amazonaws.pinpointemail#EmailAddressList", - "traits": { - "smithy.api#documentation": "

An array that contains the email addresses of the \"To\" recipients for the\n email.

" - } - }, "BccAddresses": { "target": "com.amazonaws.pinpointemail#EmailAddressList", "traits": { @@ -1257,6 +1251,12 @@ "traits": { "smithy.api#documentation": "

An array that contains the email addresses of the \"CC\" (carbon copy) recipients for\n the email.

" } + }, + "ToAddresses": { + "target": "com.amazonaws.pinpointemail#EmailAddressList", + "traits": { + "smithy.api#documentation": "

An array that contains the email addresses of the \"To\" recipients for the\n email.

" + } } }, "traits": { @@ -1292,10 +1292,10 @@ "com.amazonaws.pinpointemail#DkimAttributes": { "type": "structure", "members": { - "Tokens": { - "target": "com.amazonaws.pinpointemail#DnsTokenList", + "SigningEnabled": { + "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

A set of unique strings that you use to create a set of CNAME records that you add to\n the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS\n configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint\n usually detects these records within about 72 hours of adding them to the DNS\n configuration for your domain.

" + "smithy.api#documentation": "

If the value is true, then the messages that Amazon Pinpoint sends from the\n identity are DKIM-signed. If the value is false, then the messages that\n Amazon Pinpoint sends from the identity aren't DKIM-signed.

" } }, "Status": { @@ -1304,10 +1304,10 @@ "smithy.api#documentation": "

Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS\n records for the domain. The status can be one of the following:

\n
    \n
  • \n

    \n PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the\n DNS configuration for the domain, but will continue to attempt to locate\n them.

    \n
    • \n
  • \n

    \n SUCCESS – Amazon Pinpoint located the DKIM records in the DNS\n configuration for the domain and determined that they're correct. Amazon Pinpoint can now\n send DKIM-signed email from the identity.

    \n
    • \n
  • \n

    \n FAILED – Amazon Pinpoint was unable to locate the DKIM records in the\n DNS settings for the domain, and won't continue to search for them.

    \n
    • \n
  • \n

    \n TEMPORARY_FAILURE – A temporary issue occurred, which\n prevented Amazon Pinpoint from determining the DKIM status for the domain.

    \n
    • \n
  • \n

    \n NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the\n DKIM records in the DKIM records for the domain.

    \n
    • \n
" } }, - "SigningEnabled": { - "target": "com.amazonaws.pinpointemail#Enabled", + "Tokens": { + "target": "com.amazonaws.pinpointemail#DnsTokenList", "traits": { - "smithy.api#documentation": "

If the value is true, then the messages that Amazon Pinpoint sends from the\n identity are DKIM-signed. If the value is false, then the messages that\n Amazon Pinpoint sends from the identity aren't DKIM-signed.

" + "smithy.api#documentation": "

A set of unique strings that you use to create a set of CNAME records that you add to\n the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS\n configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint\n usually detects these records within about 72 hours of adding them to the DNS\n configuration for your domain.

" } } }, @@ -1370,46 +1370,40 @@ "smithy.api#documentation": "

The URL of an image that contains a snapshot of the email message that was\n sent.

" } }, - "ReadDeleteRate": { - "target": "com.amazonaws.pinpointemail#Percentage", + "Subject": { + "target": "com.amazonaws.pinpointemail#Subject", "traits": { - "smithy.api#documentation": "

The percentage of email messages that were opened and then deleted by recipients. Due\n to technical limitations, this value only includes recipients who opened the message by\n using an email client that supports images.

" + "smithy.api#documentation": "

The subject line, or title, of the email message.

" } }, - "ProjectedVolume": { - "target": "com.amazonaws.pinpointemail#Volume", + "FirstSeenDateTime": { + "target": "com.amazonaws.pinpointemail#Timestamp", "traits": { - "smithy.api#documentation": "

The projected number of recipients that the email message was sent to.

" + "smithy.api#documentation": "

The first time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

" } }, - "SendingIps": { - "target": "com.amazonaws.pinpointemail#IpList", + "Esps": { + "target": "com.amazonaws.pinpointemail#Esps", "traits": { - "smithy.api#documentation": "

The IP addresses that were used to send the email message.

" + "smithy.api#documentation": "

The major email providers who handled the email message.

" } }, - "SpamCount": { - "target": "com.amazonaws.pinpointemail#Volume", + "CampaignId": { + "target": "com.amazonaws.pinpointemail#CampaignId", "traits": { - "smithy.api#documentation": "

The number of email messages that were delivered to recipients' spam or junk mail\n folders.

" + "smithy.api#documentation": "

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this\n identifier to a campaign. This value is not the same as the campaign identifier that\n Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the\n Amazon Pinpoint console.

" } }, - "ReadRate": { + "DeleteRate": { "target": "com.amazonaws.pinpointemail#Percentage", "traits": { - "smithy.api#documentation": "

The percentage of email messages that were opened by recipients. Due to technical\n limitations, this value only includes recipients who opened the message by using an\n email client that supports images.

" - } - }, - "CampaignId": { - "target": "com.amazonaws.pinpointemail#CampaignId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this\n identifier to a campaign. This value is not the same as the campaign identifier that\n Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the\n Amazon Pinpoint console.

" + "smithy.api#documentation": "

The percentage of email messages that were deleted by recipients, without being opened\n first. Due to technical limitations, this value only includes recipients who opened the\n message by using an email client that supports images.

" } }, - "Esps": { - "target": "com.amazonaws.pinpointemail#Esps", + "LastSeenDateTime": { + "target": "com.amazonaws.pinpointemail#Timestamp", "traits": { - "smithy.api#documentation": "

The major email providers who handled the email message.

" + "smithy.api#documentation": "

The last time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

" } }, "FromAddress": { @@ -1418,28 +1412,34 @@ "smithy.api#documentation": "

The verified email address that the email message was sent from.

" } }, - "Subject": { - "target": "com.amazonaws.pinpointemail#Subject", + "ProjectedVolume": { + "target": "com.amazonaws.pinpointemail#Volume", "traits": { - "smithy.api#documentation": "

The subject line, or title, of the email message.

" + "smithy.api#documentation": "

The projected number of recipients that the email message was sent to.

" } }, - "LastSeenDateTime": { - "target": "com.amazonaws.pinpointemail#Timestamp", + "ReadRate": { + "target": "com.amazonaws.pinpointemail#Percentage", "traits": { - "smithy.api#documentation": "

The last time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

" + "smithy.api#documentation": "

The percentage of email messages that were opened by recipients. Due to technical\n limitations, this value only includes recipients who opened the message by using an\n email client that supports images.

" } }, - "FirstSeenDateTime": { - "target": "com.amazonaws.pinpointemail#Timestamp", + "SpamCount": { + "target": "com.amazonaws.pinpointemail#Volume", "traits": { - "smithy.api#documentation": "

The first time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

" + "smithy.api#documentation": "

The number of email messages that were delivered to recipients' spam or junk mail\n folders.

" } }, - "DeleteRate": { + "ReadDeleteRate": { "target": "com.amazonaws.pinpointemail#Percentage", "traits": { - "smithy.api#documentation": "

The percentage of email messages that were deleted by recipients, without being opened\n first. Due to technical limitations, this value only includes recipients who opened the\n message by using an email client that supports images.

" + "smithy.api#documentation": "

The percentage of email messages that were opened and then deleted by recipients. Due\n to technical limitations, this value only includes recipients who opened the message by\n using an email client that supports images.

" + } + }, + "SendingIps": { + "target": "com.amazonaws.pinpointemail#IpList", + "traits": { + "smithy.api#documentation": "

The IP addresses that were used to send the email message.

" } } }, @@ -1459,6 +1459,12 @@ "com.amazonaws.pinpointemail#DomainDeliverabilityTrackingOption": { "type": "structure", "members": { + "SubscriptionStartDate": { + "target": "com.amazonaws.pinpointemail#Timestamp", + "traits": { + "smithy.api#documentation": "

The date, in Unix time format, when you enabled the Deliverability dashboard for the\n domain.

" + } + }, "InboxPlacementTrackingOption": { "target": "com.amazonaws.pinpointemail#InboxPlacementTrackingOption", "traits": { @@ -1470,12 +1476,6 @@ "traits": { "smithy.api#documentation": "

A verified domain that’s associated with your AWS account and currently has an\n active Deliverability dashboard subscription.

" } - }, - "SubscriptionStartDate": { - "target": "com.amazonaws.pinpointemail#Timestamp", - "traits": { - "smithy.api#documentation": "

The date, in Unix time format, when you enabled the Deliverability dashboard for the\n domain.

" - } } }, "traits": { @@ -1494,28 +1494,22 @@ "com.amazonaws.pinpointemail#DomainIspPlacement": { "type": "structure", "members": { - "IspName": { - "target": "com.amazonaws.pinpointemail#IspName", - "traits": { - "smithy.api#documentation": "

The name of the email provider that the inbox placement data applies to.

" - } - }, "InboxPercentage": { "target": "com.amazonaws.pinpointemail#Percentage", "traits": { "smithy.api#documentation": "

The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

" } }, - "SpamRawCount": { - "target": "com.amazonaws.pinpointemail#Volume", + "IspName": { + "target": "com.amazonaws.pinpointemail#IspName", "traits": { - "smithy.api#documentation": "

The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.

" + "smithy.api#documentation": "

The name of the email provider that the inbox placement data applies to.

" } }, - "InboxRawCount": { + "SpamRawCount": { "target": "com.amazonaws.pinpointemail#Volume", "traits": { - "smithy.api#documentation": "

The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

" + "smithy.api#documentation": "

The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.

" } }, "SpamPercentage": { @@ -1523,6 +1517,12 @@ "traits": { "smithy.api#documentation": "

The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.

" } + }, + "InboxRawCount": { + "target": "com.amazonaws.pinpointemail#Volume", + "traits": { + "smithy.api#documentation": "

The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

" + } } }, "traits": { @@ -1547,10 +1547,10 @@ "com.amazonaws.pinpointemail#EmailContent": { "type": "structure", "members": { - "Raw": { - "target": "com.amazonaws.pinpointemail#RawMessage", + "Template": { + "target": "com.amazonaws.pinpointemail#Template", "traits": { - "smithy.api#documentation": "

The raw email message. The message has to meet the following criteria:

\n
    \n
  • \n

    The message has to contain a header and a body, separated by one blank\n line.

    \n
    • \n
  • \n

    All of the required header fields must be present in the message.

    \n
    • \n
  • \n

    Each part of a multipart MIME message must be formatted properly.

    \n
    • \n
  • \n

    If you include attachments, they must be in a file format that Amazon Pinpoint supports.\n

    \n
    • \n
  • \n

    The entire message must be Base64 encoded.

    \n
    • \n
  • \n

    If any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.

    \n
    • \n
  • \n

    The length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.

    \n
    • \n
" + "smithy.api#documentation": "

The template to use for the email message.

" } }, "Simple": { @@ -1559,10 +1559,10 @@ "smithy.api#documentation": "

The simple email message. The message consists of a subject and a message body.

" } }, - "Template": { - "target": "com.amazonaws.pinpointemail#Template", + "Raw": { + "target": "com.amazonaws.pinpointemail#RawMessage", "traits": { - "smithy.api#documentation": "

The template to use for the email message.

" + "smithy.api#documentation": "

The raw email message. The message has to meet the following criteria:

\n
    \n
  • \n

    The message has to contain a header and a body, separated by one blank\n line.

    \n
    • \n
  • \n

    All of the required header fields must be present in the message.

    \n
    • \n
  • \n

    Each part of a multipart MIME message must be formatted properly.

    \n
    • \n
  • \n

    If you include attachments, they must be in a file format that Amazon Pinpoint supports.\n

    \n
    • \n
  • \n

    The entire message must be Base64 encoded.

    \n
    • \n
  • \n

    If any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.

    \n
    • \n
  • \n

    The length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.

    \n
    • \n
" } } }, @@ -1588,22 +1588,22 @@ "com.amazonaws.pinpointemail#EventDestination": { "type": "structure", "members": { - "SnsDestination": { - "target": "com.amazonaws.pinpointemail#SnsDestination", - "traits": { - "smithy.api#documentation": "

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.

" - } - }, "CloudWatchDestination": { "target": "com.amazonaws.pinpointemail#CloudWatchDestination", "traits": { "smithy.api#documentation": "

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.

" } }, - "Enabled": { - "target": "com.amazonaws.pinpointemail#Enabled", + "SnsDestination": { + "target": "com.amazonaws.pinpointemail#SnsDestination", "traits": { - "smithy.api#documentation": "

If true, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n EventDestinationDefinition.

\n

If false, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.

" + "smithy.api#documentation": "

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.

" + } + }, + "KinesisFirehoseDestination": { + "target": "com.amazonaws.pinpointemail#KinesisFirehoseDestination", + "traits": { + "smithy.api#documentation": "

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

" } }, "PinpointDestination": { @@ -1612,11 +1612,10 @@ "smithy.api#documentation": "

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events\n to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments\n for your campaigns.

" } }, - "MatchingEventTypes": { - "target": "com.amazonaws.pinpointemail#EventTypes", + "Enabled": { + "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

The types of events that Amazon Pinpoint sends to the specified event destinations.

", - "smithy.api#required": {} + "smithy.api#documentation": "

If true, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n EventDestinationDefinition.

\n

If false, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.

" } }, "Name": { @@ -1626,10 +1625,11 @@ "smithy.api#required": {} } }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.pinpointemail#KinesisFirehoseDestination", + "MatchingEventTypes": { + "target": "com.amazonaws.pinpointemail#EventTypes", "traits": { - "smithy.api#documentation": "

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

" + "smithy.api#documentation": "

The types of events that Amazon Pinpoint sends to the specified event destinations.

", + "smithy.api#required": {} } } }, @@ -1640,10 +1640,10 @@ "com.amazonaws.pinpointemail#EventDestinationDefinition": { "type": "structure", "members": { - "PinpointDestination": { - "target": "com.amazonaws.pinpointemail#PinpointDestination", + "KinesisFirehoseDestination": { + "target": "com.amazonaws.pinpointemail#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events\n to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments\n for your campaigns.

" + "smithy.api#documentation": "

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

" } }, "Enabled": { @@ -1652,16 +1652,10 @@ "smithy.api#documentation": "

If true, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n EventDestinationDefinition.

\n

If false, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.

" } }, - "CloudWatchDestination": { - "target": "com.amazonaws.pinpointemail#CloudWatchDestination", - "traits": { - "smithy.api#documentation": "

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.

" - } - }, - "SnsDestination": { - "target": "com.amazonaws.pinpointemail#SnsDestination", + "PinpointDestination": { + "target": "com.amazonaws.pinpointemail#PinpointDestination", "traits": { - "smithy.api#documentation": "

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.

" + "smithy.api#documentation": "

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events\n to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments\n for your campaigns.

" } }, "MatchingEventTypes": { @@ -1670,10 +1664,16 @@ "smithy.api#documentation": "

An array that specifies which events Amazon Pinpoint should send to the destinations in this\n EventDestinationDefinition.

" } }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.pinpointemail#KinesisFirehoseDestination", + "SnsDestination": { + "target": "com.amazonaws.pinpointemail#SnsDestination", "traits": { - "smithy.api#documentation": "

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

" + "smithy.api#documentation": "

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.

" + } + }, + "CloudWatchDestination": { + "target": "com.amazonaws.pinpointemail#CloudWatchDestination", + "traits": { + "smithy.api#documentation": "

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to\n monitor and gain insights on your email sending metrics.

" } } }, @@ -1777,22 +1777,16 @@ "com.amazonaws.pinpointemail#GetAccountResponse": { "type": "structure", "members": { - "SendQuota": { - "target": "com.amazonaws.pinpointemail#SendQuota", - "traits": { - "smithy.api#documentation": "

An object that contains information about the per-day and per-second sending limits\n for your Amazon Pinpoint account in the current AWS Region.

" - } - }, - "SendingEnabled": { + "ProductionAccessEnabled": { "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the\n current AWS Region.

" + "smithy.api#documentation": "

Indicates whether or not your account has production access in the current AWS\n Region.

\n

If the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.

\n

If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.

" } }, - "ProductionAccessEnabled": { + "DedicatedIpAutoWarmupEnabled": { "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

Indicates whether or not your account has production access in the current AWS\n Region.

\n

If the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.

\n

If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.

" + "smithy.api#documentation": "

Indicates whether or not the automatic warm-up feature is enabled for dedicated IP\n addresses that are associated with your account.

" } }, "EnforcementStatus": { @@ -1801,10 +1795,16 @@ "smithy.api#documentation": "

The reputation status of your Amazon Pinpoint account. The status can be one of the\n following:

\n
    \n
  • \n

    \n HEALTHY – There are no reputation-related issues that\n currently impact your account.

    \n
    • \n
  • \n

    \n PROBATION – We've identified some issues with your Amazon Pinpoint\n account. We're placing your account under review while you work on correcting\n these issues.

    \n
    • \n
  • \n

    \n SHUTDOWN – Your account's ability to send email is\n currently paused because of an issue with the email sent from your account. When\n you correct the issue, you can contact us and request that your account's\n ability to send email is resumed.

    \n
    • \n
" } }, - "DedicatedIpAutoWarmupEnabled": { + "SendingEnabled": { "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

Indicates whether or not the automatic warm-up feature is enabled for dedicated IP\n addresses that are associated with your account.

" + "smithy.api#documentation": "

Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the\n current AWS Region.

" + } + }, + "SendQuota": { + "target": "com.amazonaws.pinpointemail#SendQuota", + "traits": { + "smithy.api#documentation": "

An object that contains information about the per-day and per-second sending limits\n for your Amazon Pinpoint account in the current AWS Region.

" } } }, @@ -1976,22 +1976,16 @@ "com.amazonaws.pinpointemail#GetConfigurationSetResponse": { "type": "structure", "members": { - "SendingOptions": { - "target": "com.amazonaws.pinpointemail#SendingOptions", - "traits": { - "smithy.api#documentation": "

An object that defines whether or not Amazon Pinpoint can send email that you send using the\n configuration set.

" - } - }, "DeliveryOptions": { "target": "com.amazonaws.pinpointemail#DeliveryOptions", "traits": { "smithy.api#documentation": "

An object that defines the dedicated IP pool that is used to send emails that you send\n using the configuration set.

" } }, - "TrackingOptions": { - "target": "com.amazonaws.pinpointemail#TrackingOptions", + "ReputationOptions": { + "target": "com.amazonaws.pinpointemail#ReputationOptions", "traits": { - "smithy.api#documentation": "

An object that defines the open and click tracking options for emails that you send\n using the configuration set.

" + "smithy.api#documentation": "

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails\n that you send that use the configuration set.

" } }, "Tags": { @@ -2006,10 +2000,16 @@ "smithy.api#documentation": "

The name of the configuration set.

" } }, - "ReputationOptions": { - "target": "com.amazonaws.pinpointemail#ReputationOptions", + "SendingOptions": { + "target": "com.amazonaws.pinpointemail#SendingOptions", "traits": { - "smithy.api#documentation": "

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails\n that you send that use the configuration set.

" + "smithy.api#documentation": "

An object that defines whether or not Amazon Pinpoint can send email that you send using the\n configuration set.

" + } + }, + "TrackingOptions": { + "target": "com.amazonaws.pinpointemail#TrackingOptions", + "traits": { + "smithy.api#documentation": "

An object that defines the open and click tracking options for emails that you send\n using the configuration set.

" } } }, @@ -2111,6 +2111,13 @@ "com.amazonaws.pinpointemail#GetDedicatedIpsRequest": { "type": "structure", "members": { + "PoolName": { + "target": "com.amazonaws.pinpointemail#PoolName", + "traits": { + "smithy.api#documentation": "

The name of the IP pool that the dedicated IP address is associated with.

", + "smithy.api#httpQuery": "PoolName" + } + }, "PageSize": { "target": "com.amazonaws.pinpointemail#MaxItems", "traits": { @@ -2124,13 +2131,6 @@ "smithy.api#documentation": "

A token returned from a previous call to GetDedicatedIps to indicate the\n position of the dedicated IP pool in the list of IP pools.

", "smithy.api#httpQuery": "NextToken" } - }, - "PoolName": { - "target": "com.amazonaws.pinpointemail#PoolName", - "traits": { - "smithy.api#documentation": "

The name of the IP pool that the dedicated IP address is associated with.

", - "smithy.api#httpQuery": "PoolName" - } } }, "traits": { @@ -2195,12 +2195,24 @@ "com.amazonaws.pinpointemail#GetDeliverabilityDashboardOptionsResponse": { "type": "structure", "members": { + "AccountStatus": { + "target": "com.amazonaws.pinpointemail#DeliverabilityDashboardAccountStatus", + "traits": { + "smithy.api#documentation": "

The current status of your Deliverability dashboard subscription. If this value is\n PENDING_EXPIRATION, your subscription is scheduled to expire at the end\n of the current calendar month.

" + } + }, "SubscriptionExpiryDate": { "target": "com.amazonaws.pinpointemail#Timestamp", "traits": { "smithy.api#documentation": "

The date, in Unix time format, when your current subscription to the Deliverability dashboard\n is scheduled to expire, if your subscription is scheduled to expire at the end of the\n current calendar month. This value is null if you have an active subscription that isn’t\n due to expire at the end of the month.

" } }, + "ActiveSubscribedDomains": { + "target": "com.amazonaws.pinpointemail#DomainDeliverabilityTrackingOptions", + "traits": { + "smithy.api#documentation": "

An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at\n the end of the current calendar month.

" + } + }, "PendingExpirationSubscribedDomains": { "target": "com.amazonaws.pinpointemail#DomainDeliverabilityTrackingOptions", "traits": { @@ -2213,18 +2225,6 @@ "smithy.api#documentation": "

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value\n is true, the dashboard is enabled.

", "smithy.api#required": {} } - }, - "ActiveSubscribedDomains": { - "target": "com.amazonaws.pinpointemail#DomainDeliverabilityTrackingOptions", - "traits": { - "smithy.api#documentation": "

An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at\n the end of the current calendar month.

" - } - }, - "AccountStatus": { - "target": "com.amazonaws.pinpointemail#DeliverabilityDashboardAccountStatus", - "traits": { - "smithy.api#documentation": "

The current status of your Deliverability dashboard subscription. If this value is\n PENDING_EXPIRATION, your subscription is scheduled to expire at the end\n of the current calendar month.

" - } } }, "traits": { @@ -2285,29 +2285,29 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.pinpointemail#TagList", + "Message": { + "target": "com.amazonaws.pinpointemail#MessageContent", "traits": { - "smithy.api#documentation": "

An array of objects that define the tags (keys and values) that are associated with\n the predictive inbox placement test.

" + "smithy.api#documentation": "

An object that contains the message that you sent when you performed this\n predictive inbox placement test.

" } }, - "OverallPlacement": { - "target": "com.amazonaws.pinpointemail#PlacementStatistics", + "DeliverabilityTestReport": { + "target": "com.amazonaws.pinpointemail#DeliverabilityTestReport", "traits": { - "smithy.api#documentation": "

An object that specifies how many test messages that were sent during the predictive inbox placement test were\n delivered to recipients' inboxes, how many were sent to recipients' spam folders, and\n how many weren't delivered.

", + "smithy.api#documentation": "

An object that contains the results of the predictive inbox placement test.

", "smithy.api#required": {} } }, - "Message": { - "target": "com.amazonaws.pinpointemail#MessageContent", + "Tags": { + "target": "com.amazonaws.pinpointemail#TagList", "traits": { - "smithy.api#documentation": "

An object that contains the message that you sent when you performed this\n predictive inbox placement test.

" + "smithy.api#documentation": "

An array of objects that define the tags (keys and values) that are associated with\n the predictive inbox placement test.

" } }, - "DeliverabilityTestReport": { - "target": "com.amazonaws.pinpointemail#DeliverabilityTestReport", + "OverallPlacement": { + "target": "com.amazonaws.pinpointemail#PlacementStatistics", "traits": { - "smithy.api#documentation": "

An object that contains the results of the predictive inbox placement test.

", + "smithy.api#documentation": "

An object that specifies how many test messages that were sent during the predictive inbox placement test were\n delivered to recipients' inboxes, how many were sent to recipients' spam folders, and\n how many weren't delivered.

", "smithy.api#required": {} } } @@ -2406,6 +2406,14 @@ "com.amazonaws.pinpointemail#GetDomainStatisticsReportRequest": { "type": "structure", "members": { + "StartDate": { + "target": "com.amazonaws.pinpointemail#Timestamp", + "traits": { + "smithy.api#documentation": "

The first day (in Unix time) that you want to obtain domain deliverability metrics\n for.

", + "smithy.api#httpQuery": "StartDate", + "smithy.api#required": {} + } + }, "Domain": { "target": "com.amazonaws.pinpointemail#Identity", "traits": { @@ -2421,14 +2429,6 @@ "smithy.api#httpQuery": "EndDate", "smithy.api#required": {} } - }, - "StartDate": { - "target": "com.amazonaws.pinpointemail#Timestamp", - "traits": { - "smithy.api#documentation": "

The first day (in Unix time) that you want to obtain domain deliverability metrics\n for.

", - "smithy.api#httpQuery": "StartDate", - "smithy.api#required": {} - } } }, "traits": { @@ -2504,22 +2504,22 @@ "com.amazonaws.pinpointemail#GetEmailIdentityResponse": { "type": "structure", "members": { - "IdentityType": { - "target": "com.amazonaws.pinpointemail#IdentityType", + "FeedbackForwardingStatus": { + "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

The email identity type.

" + "smithy.api#documentation": "

The feedback forwarding configuration for the identity.

\n

If the value is true, Amazon Pinpoint sends you email notifications when bounce or\n complaint events occur. Amazon Pinpoint sends this notification to the address that you specified\n in the Return-Path header of the original email.

\n

When you set this value to false, Amazon Pinpoint sends notifications through other\n mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're\n required to have a method of tracking bounces and complaints. If you haven't set up\n another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email\n notification when these events occur (even if this setting is disabled).

" } }, - "MailFromAttributes": { - "target": "com.amazonaws.pinpointemail#MailFromAttributes", + "IdentityType": { + "target": "com.amazonaws.pinpointemail#IdentityType", "traits": { - "smithy.api#documentation": "

An object that contains information about the Mail-From attributes for the email\n identity.

" + "smithy.api#documentation": "

The email identity type.

" } }, - "FeedbackForwardingStatus": { + "VerifiedForSendingStatus": { "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

The feedback forwarding configuration for the identity.

\n

If the value is true, Amazon Pinpoint sends you email notifications when bounce or\n complaint events occur. Amazon Pinpoint sends this notification to the address that you specified\n in the Return-Path header of the original email.

\n

When you set this value to false, Amazon Pinpoint sends notifications through other\n mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're\n required to have a method of tracking bounces and complaints. If you haven't set up\n another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email\n notification when these events occur (even if this setting is disabled).

" + "smithy.api#documentation": "

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email\n from verified email addresses or domains. For more information about verifying\n identities, see the Amazon Pinpoint User Guide.

" } }, "Tags": { @@ -2528,16 +2528,16 @@ "smithy.api#documentation": "

An array of objects that define the tags (keys and values) that are associated with\n the email identity.

" } }, - "DkimAttributes": { - "target": "com.amazonaws.pinpointemail#DkimAttributes", + "MailFromAttributes": { + "target": "com.amazonaws.pinpointemail#MailFromAttributes", "traits": { - "smithy.api#documentation": "

An object that contains information about the DKIM attributes for the identity. This\n object includes the tokens that you use to create the CNAME records that are required to\n complete the DKIM verification process.

" + "smithy.api#documentation": "

An object that contains information about the Mail-From attributes for the email\n identity.

" } }, - "VerifiedForSendingStatus": { - "target": "com.amazonaws.pinpointemail#Enabled", + "DkimAttributes": { + "target": "com.amazonaws.pinpointemail#DkimAttributes", "traits": { - "smithy.api#documentation": "

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email\n from verified email addresses or domains. For more information about verifying\n identities, see the Amazon Pinpoint User Guide.

" + "smithy.api#documentation": "

An object that contains information about the DKIM attributes for the identity. This\n object includes the tokens that you use to create the CNAME records that are required to\n complete the DKIM verification process.

" } } }, @@ -2551,10 +2551,10 @@ "com.amazonaws.pinpointemail#IdentityInfo": { "type": "structure", "members": { - "SendingEnabled": { - "target": "com.amazonaws.pinpointemail#Enabled", + "IdentityType": { + "target": "com.amazonaws.pinpointemail#IdentityType", "traits": { - "smithy.api#documentation": "

Indicates whether or not you can send email from the identity.

\n

In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before\n you can send email from an identity, you have to demostrate that you own the identity,\n and that you authorize Amazon Pinpoint to send email from that identity.

" + "smithy.api#documentation": "

The email identity type. The identity type can be one of the following:

\n
    \n
  • \n

    \n EMAIL_ADDRESS – The identity is an email address.

    \n
    • \n
  • \n

    \n DOMAIN – The identity is a domain.

    \n
    • \n
  • \n

    \n MANAGED_DOMAIN – The identity is a domain that is managed\n by AWS.

    \n
    • \n
" } }, "IdentityName": { @@ -2563,10 +2563,10 @@ "smithy.api#documentation": "

The address or domain of the identity.

" } }, - "IdentityType": { - "target": "com.amazonaws.pinpointemail#IdentityType", + "SendingEnabled": { + "target": "com.amazonaws.pinpointemail#Enabled", "traits": { - "smithy.api#documentation": "

The email identity type. The identity type can be one of the following:

\n
    \n
  • \n

    \n EMAIL_ADDRESS – The identity is an email address.

    \n
    • \n
  • \n

    \n DOMAIN – The identity is a domain.

    \n
    • \n
  • \n

    \n MANAGED_DOMAIN – The identity is a domain that is managed\n by AWS.

    \n
    • \n
" + "smithy.api#documentation": "

Indicates whether or not you can send email from the identity.

\n

In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before\n you can send email from an identity, you have to demostrate that you own the identity,\n and that you authorize Amazon Pinpoint to send email from that identity.

" } } }, @@ -2606,17 +2606,17 @@ "com.amazonaws.pinpointemail#InboxPlacementTrackingOption": { "type": "structure", "members": { - "Global": { - "target": "com.amazonaws.pinpointemail#Enabled", - "traits": { - "smithy.api#documentation": "

Specifies whether inbox placement data is being tracked for the domain.

" - } - }, "TrackedIsps": { "target": "com.amazonaws.pinpointemail#IspNameList", "traits": { "smithy.api#documentation": "

An array of strings, one for each major email provider that the inbox placement data\n applies to.

" } + }, + "Global": { + "target": "com.amazonaws.pinpointemail#Enabled", + "traits": { + "smithy.api#documentation": "

Specifies whether inbox placement data is being tracked for the domain.

" + } } }, "traits": { @@ -2676,17 +2676,17 @@ "com.amazonaws.pinpointemail#KinesisFirehoseDestination": { "type": "structure", "members": { - "IamRoleArn": { + "DeliveryStreamArn": { "target": "com.amazonaws.pinpointemail#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email\n events to the Amazon Kinesis Data Firehose stream.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events\n to.

", "smithy.api#required": {} } }, - "DeliveryStreamArn": { + "IamRoleArn": { "target": "com.amazonaws.pinpointemail#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events\n to.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email\n events to the Amazon Kinesis Data Firehose stream.

", "smithy.api#required": {} } } @@ -2747,19 +2747,19 @@ "com.amazonaws.pinpointemail#ListConfigurationSetsRequest": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.pinpointemail#MaxItems", - "traits": { - "smithy.api#documentation": "

The number of results to show in a single call to ListConfigurationSets.\n If the number of results is larger than the number you specified in this parameter, then\n the response includes a NextToken element, which you can use to obtain\n additional results.

", - "smithy.api#httpQuery": "PageSize" - } - }, "NextToken": { "target": "com.amazonaws.pinpointemail#NextToken", "traits": { "smithy.api#documentation": "

A token returned from a previous call to ListConfigurationSets to\n indicate the position in the list of configuration sets.

", "smithy.api#httpQuery": "NextToken" } + }, + "PageSize": { + "target": "com.amazonaws.pinpointemail#MaxItems", + "traits": { + "smithy.api#documentation": "

The number of results to show in a single call to ListConfigurationSets.\n If the number of results is larger than the number you specified in this parameter, then\n the response includes a NextToken element, which you can use to obtain\n additional results.

", + "smithy.api#httpQuery": "PageSize" + } } }, "traits": { @@ -2916,18 +2916,18 @@ "com.amazonaws.pinpointemail#ListDeliverabilityTestReportsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.pinpointemail#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates that there are additional predictive inbox placement tests to list. To view additional\n predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass\n this token in the NextToken parameter.

" + } + }, "DeliverabilityTestReports": { "target": "com.amazonaws.pinpointemail#DeliverabilityTestReports", "traits": { "smithy.api#documentation": "

An object that contains a lists of predictive inbox placement tests that you've performed.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.pinpointemail#NextToken", - "traits": { - "smithy.api#documentation": "

A token that indicates that there are additional predictive inbox placement tests to list. To view additional\n predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass\n this token in the NextToken parameter.

" - } } }, "traits": { @@ -2973,15 +2973,22 @@ "PageSize": { "target": "com.amazonaws.pinpointemail#MaxItems", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in response to a single call to the\n ListDomainDeliverabilityCampaigns operation. If the number of results\n is larger than the number that you specify in this parameter, the response includes a\n NextToken element, which you can use to obtain additional\n results.

", - "smithy.api#httpQuery": "PageSize" + "smithy.api#documentation": "

The maximum number of results to include in response to a single call to the\n ListDomainDeliverabilityCampaigns operation. If the number of results\n is larger than the number that you specify in this parameter, the response includes a\n NextToken element, which you can use to obtain additional\n results.

", + "smithy.api#httpQuery": "PageSize" + } + }, + "NextToken": { + "target": "com.amazonaws.pinpointemail#NextToken", + "traits": { + "smithy.api#documentation": "

A token that’s returned from a previous call to the\n ListDomainDeliverabilityCampaigns operation. This token indicates the\n position of a campaign in the list of campaigns.

", + "smithy.api#httpQuery": "NextToken" } }, - "EndDate": { + "StartDate": { "target": "com.amazonaws.pinpointemail#Timestamp", "traits": { - "smithy.api#documentation": "

The last day, in Unix time format, that you want to obtain deliverability data for.\n This value has to be less than or equal to 30 days after the value of the\n StartDate parameter.

", - "smithy.api#httpQuery": "EndDate", + "smithy.api#documentation": "

The first day, in Unix time format, that you want to obtain deliverability data\n for.

", + "smithy.api#httpQuery": "StartDate", "smithy.api#required": {} } }, @@ -2993,20 +3000,13 @@ "smithy.api#required": {} } }, - "StartDate": { + "EndDate": { "target": "com.amazonaws.pinpointemail#Timestamp", "traits": { - "smithy.api#documentation": "

The first day, in Unix time format, that you want to obtain deliverability data\n for.

", - "smithy.api#httpQuery": "StartDate", + "smithy.api#documentation": "

The last day, in Unix time format, that you want to obtain deliverability data for.\n This value has to be less than or equal to 30 days after the value of the\n StartDate parameter.

", + "smithy.api#httpQuery": "EndDate", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.pinpointemail#NextToken", - "traits": { - "smithy.api#documentation": "

A token that’s returned from a previous call to the\n ListDomainDeliverabilityCampaigns operation. This token indicates the\n position of a campaign in the list of campaigns.

", - "smithy.api#httpQuery": "NextToken" - } } }, "traits": { @@ -3016,18 +3016,18 @@ "com.amazonaws.pinpointemail#ListDomainDeliverabilityCampaignsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.pinpointemail#NextToken", + "traits": { + "smithy.api#documentation": "

A token that’s returned from a previous call to the\n ListDomainDeliverabilityCampaigns operation. This token indicates the\n position of the campaign in the list of campaigns.

" + } + }, "DomainDeliverabilityCampaigns": { "target": "com.amazonaws.pinpointemail#DomainDeliverabilityCampaignList", "traits": { "smithy.api#documentation": "

An array of responses, one for each campaign that used the domain to send email during\n the specified time range.

", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.pinpointemail#NextToken", - "traits": { - "smithy.api#documentation": "

A token that’s returned from a previous call to the\n ListDomainDeliverabilityCampaigns operation. This token indicates the\n position of the campaign in the list of campaigns.

" - } } }, "traits": { @@ -3067,19 +3067,19 @@ "com.amazonaws.pinpointemail#ListEmailIdentitiesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pinpointemail#NextToken", - "traits": { - "smithy.api#documentation": "

A token returned from a previous call to ListEmailIdentities to indicate\n the position in the list of identities.

", - "smithy.api#httpQuery": "NextToken" - } - }, "PageSize": { "target": "com.amazonaws.pinpointemail#MaxItems", "traits": { "smithy.api#documentation": "

The number of results to show in a single call to ListEmailIdentities. If\n the number of results is larger than the number you specified in this parameter, then\n the response includes a NextToken element, which you can use to obtain\n additional results.

\n

The value you specify has to be at least 0, and can be no more than 1000.

", "smithy.api#httpQuery": "PageSize" } + }, + "NextToken": { + "target": "com.amazonaws.pinpointemail#NextToken", + "traits": { + "smithy.api#documentation": "

A token returned from a previous call to ListEmailIdentities to indicate\n the position in the list of identities.

", + "smithy.api#httpQuery": "NextToken" + } } }, "traits": { @@ -3171,6 +3171,13 @@ "com.amazonaws.pinpointemail#MailFromAttributes": { "type": "structure", "members": { + "BehaviorOnMxFailure": { + "target": "com.amazonaws.pinpointemail#BehaviorOnMxFailure", + "traits": { + "smithy.api#documentation": "

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom\n MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses\n amazonses.com as the MAIL FROM domain. When you set this value\n to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified\n error, and doesn't attempt to deliver the email.

\n

These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending, Failed, and TemporaryFailure\n states.

", + "smithy.api#required": {} + } + }, "MailFromDomainStatus": { "target": "com.amazonaws.pinpointemail#MailFromDomainStatus", "traits": { @@ -3184,13 +3191,6 @@ "smithy.api#documentation": "

The name of a domain that an email identity uses as a custom MAIL FROM domain.

", "smithy.api#required": {} } - }, - "BehaviorOnMxFailure": { - "target": "com.amazonaws.pinpointemail#BehaviorOnMxFailure", - "traits": { - "smithy.api#documentation": "

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom\n MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses\n amazonses.com as the MAIL FROM domain. When you set this value\n to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified\n error, and doesn't attempt to deliver the email.

\n

These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending, Failed, and TemporaryFailure\n states.

", - "smithy.api#required": {} - } } }, "traits": { @@ -3255,17 +3255,17 @@ "com.amazonaws.pinpointemail#Message": { "type": "structure", "members": { - "Body": { - "target": "com.amazonaws.pinpointemail#Body", + "Subject": { + "target": "com.amazonaws.pinpointemail#Content", "traits": { - "smithy.api#documentation": "

The body of the message. You can specify an HTML version of the message, a text-only\n version of the message, or both.

", + "smithy.api#documentation": "

The subject line of the email. The subject line can only contain 7-bit ASCII\n characters. However, you can specify non-ASCII characters in the subject line by using\n encoded-word syntax, as described in RFC 2047.

", "smithy.api#required": {} } }, - "Subject": { - "target": "com.amazonaws.pinpointemail#Content", + "Body": { + "target": "com.amazonaws.pinpointemail#Body", "traits": { - "smithy.api#documentation": "

The subject line of the email. The subject line can only contain 7-bit ASCII\n characters. However, you can specify non-ASCII characters in the subject line by using\n encoded-word syntax, as described in RFC 2047.

", + "smithy.api#documentation": "

The body of the message. You can specify an HTML version of the message, a text-only\n version of the message, or both.

", "smithy.api#required": {} } } @@ -3299,17 +3299,17 @@ "com.amazonaws.pinpointemail#MessageTag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.pinpointemail#MessageTagValue", + "Name": { + "target": "com.amazonaws.pinpointemail#MessageTagName", "traits": { - "smithy.api#documentation": "

The value of the message tag. The message tag value has to meet the following\n criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", + "smithy.api#documentation": "

The name of the message tag. The message tag name has to meet the following\n criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.pinpointemail#MessageTagName", + "Value": { + "target": "com.amazonaws.pinpointemail#MessageTagValue", "traits": { - "smithy.api#documentation": "

The name of the message tag. The message tag name has to meet the following\n criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", + "smithy.api#documentation": "

The value of the message tag. The message tag value has to meet the following\n criteria:

\n
    \n
  • \n

    It can only contain ASCII letters (a–z, A–Z), numbers (0–9),\n underscores (_), or dashes (-).

    \n
    • \n
  • \n

    It can contain no more than 256 characters.

    \n
    • \n
", "smithy.api#required": {} } } @@ -3361,6 +3361,12 @@ "com.amazonaws.pinpointemail#OverallVolume": { "type": "structure", "members": { + "ReadRatePercent": { + "target": "com.amazonaws.pinpointemail#Percentage", + "traits": { + "smithy.api#documentation": "

The percentage of emails that were sent from the domain that were read by their\n recipients.

" + } + }, "DomainIspPlacements": { "target": "com.amazonaws.pinpointemail#DomainIspPlacements", "traits": { @@ -3372,12 +3378,6 @@ "traits": { "smithy.api#documentation": "

An object that contains information about the numbers of messages that arrived in\n recipients' inboxes and junk mail folders.

" } - }, - "ReadRatePercent": { - "target": "com.amazonaws.pinpointemail#Percentage", - "traits": { - "smithy.api#documentation": "

The percentage of emails that were sent from the domain that were read by their\n recipients.

" - } } }, "traits": { @@ -3414,22 +3414,22 @@ "com.amazonaws.pinpointemail#PlacementStatistics": { "type": "structure", "members": { - "InboxPercentage": { + "SpfPercentage": { "target": "com.amazonaws.pinpointemail#Percentage", "traits": { - "smithy.api#documentation": "

The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

" + "smithy.api#documentation": "

The percentage of emails that were authenticated by using Sender Policy Framework\n (SPF) during the predictive inbox placement test.

" } }, - "SpfPercentage": { + "InboxPercentage": { "target": "com.amazonaws.pinpointemail#Percentage", "traits": { - "smithy.api#documentation": "

The percentage of emails that were authenticated by using Sender Policy Framework\n (SPF) during the predictive inbox placement test.

" + "smithy.api#documentation": "

The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

" } }, - "DkimPercentage": { + "MissingPercentage": { "target": "com.amazonaws.pinpointemail#Percentage", "traits": { - "smithy.api#documentation": "

The percentage of emails that were authenticated by using DomainKeys Identified Mail\n (DKIM) during the predictive inbox placement test.

" + "smithy.api#documentation": "

The percentage of emails that didn't arrive in recipients' inboxes at all during the\n predictive inbox placement test.

" } }, "SpamPercentage": { @@ -3438,10 +3438,10 @@ "smithy.api#documentation": "

The percentage of emails that arrived in recipients' spam or junk mail folders during\n the predictive inbox placement test.

" } }, - "MissingPercentage": { + "DkimPercentage": { "target": "com.amazonaws.pinpointemail#Percentage", "traits": { - "smithy.api#documentation": "

The percentage of emails that didn't arrive in recipients' inboxes at all during the\n predictive inbox placement test.

" + "smithy.api#documentation": "

The percentage of emails that were authenticated by using DomainKeys Identified Mail\n (DKIM) during the predictive inbox placement test.

" } } }, @@ -3641,6 +3641,12 @@ "com.amazonaws.pinpointemail#PutConfigurationSetReputationOptionsRequest": { "type": "structure", "members": { + "ReputationMetricsEnabled": { + "target": "com.amazonaws.pinpointemail#Enabled", + "traits": { + "smithy.api#documentation": "

If true, tracking of reputation metrics is enabled for the configuration\n set. If false, tracking of reputation metrics is disabled for the\n configuration set.

" + } + }, "ConfigurationSetName": { "target": "com.amazonaws.pinpointemail#ConfigurationSetName", "traits": { @@ -3648,12 +3654,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "ReputationMetricsEnabled": { - "target": "com.amazonaws.pinpointemail#Enabled", - "traits": { - "smithy.api#documentation": "

If true, tracking of reputation metrics is enabled for the configuration\n set. If false, tracking of reputation metrics is disabled for the\n configuration set.

" - } } }, "traits": { @@ -3698,6 +3698,12 @@ "com.amazonaws.pinpointemail#PutConfigurationSetSendingOptionsRequest": { "type": "structure", "members": { + "SendingEnabled": { + "target": "com.amazonaws.pinpointemail#Enabled", + "traits": { + "smithy.api#documentation": "

If true, email sending is enabled for the configuration set. If\n false, email sending is disabled for the configuration set.

" + } + }, "ConfigurationSetName": { "target": "com.amazonaws.pinpointemail#ConfigurationSetName", "traits": { @@ -3705,12 +3711,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "SendingEnabled": { - "target": "com.amazonaws.pinpointemail#Enabled", - "traits": { - "smithy.api#documentation": "

If true, email sending is enabled for the configuration set. If\n false, email sending is disabled for the configuration set.

" - } } }, "traits": { @@ -3870,18 +3870,18 @@ "com.amazonaws.pinpointemail#PutDedicatedIpWarmupAttributesRequest": { "type": "structure", "members": { - "Ip": { - "target": "com.amazonaws.pinpointemail#Ip", + "WarmupPercentage": { + "target": "com.amazonaws.pinpointemail#Percentage100Wrapper", "traits": { - "smithy.api#documentation": "

The dedicated IP address that you want to update the warm-up attributes for.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The warm-up percentage that you want to associate with the dedicated IP\n address.

", "smithy.api#required": {} } }, - "WarmupPercentage": { - "target": "com.amazonaws.pinpointemail#Percentage100Wrapper", + "Ip": { + "target": "com.amazonaws.pinpointemail#Ip", "traits": { - "smithy.api#documentation": "

The warm-up percentage that you want to associate with the dedicated IP\n address.

", + "smithy.api#documentation": "

The dedicated IP address that you want to update the warm-up attributes for.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -4047,12 +4047,6 @@ "com.amazonaws.pinpointemail#PutEmailIdentityFeedbackAttributesRequest": { "type": "structure", "members": { - "EmailForwardingEnabled": { - "target": "com.amazonaws.pinpointemail#Enabled", - "traits": { - "smithy.api#documentation": "

Sets the feedback forwarding configuration for the identity.

\n

If the value is true, Amazon Pinpoint sends you email notifications when bounce or\n complaint events occur. Amazon Pinpoint sends this notification to the address that you specified\n in the Return-Path header of the original email.

\n

When you set this value to false, Amazon Pinpoint sends notifications through other\n mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're\n required to have a method of tracking bounces and complaints. If you haven't set up\n another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email\n notification when these events occur (even if this setting is disabled).

" - } - }, "EmailIdentity": { "target": "com.amazonaws.pinpointemail#Identity", "traits": { @@ -4060,6 +4054,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "EmailForwardingEnabled": { + "target": "com.amazonaws.pinpointemail#Enabled", + "traits": { + "smithy.api#documentation": "

Sets the feedback forwarding configuration for the identity.

\n

If the value is true, Amazon Pinpoint sends you email notifications when bounce or\n complaint events occur. Amazon Pinpoint sends this notification to the address that you specified\n in the Return-Path header of the original email.

\n

When you set this value to false, Amazon Pinpoint sends notifications through other\n mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're\n required to have a method of tracking bounces and complaints. If you haven't set up\n another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email\n notification when these events occur (even if this setting is disabled).

" + } } }, "traits": { @@ -4104,12 +4104,10 @@ "com.amazonaws.pinpointemail#PutEmailIdentityMailFromAttributesRequest": { "type": "structure", "members": { - "EmailIdentity": { - "target": "com.amazonaws.pinpointemail#Identity", + "MailFromDomain": { + "target": "com.amazonaws.pinpointemail#MailFromDomainName", "traits": { - "smithy.api#documentation": "

The verified email identity that you want to set up the custom MAIL FROM domain\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM\n domain must meet the following criteria:

\n
    \n
  • \n

    It has to be a subdomain of the verified identity.

    \n
    • \n
  • \n

    It can't be used to receive email.

    \n
    • \n
  • \n

    It can't be used in a \"From\" address if the MAIL FROM domain is a destination\n for feedback forwarding emails.

    \n
    • \n
" } }, "BehaviorOnMxFailure": { @@ -4118,10 +4116,12 @@ "smithy.api#documentation": "

The action that you want Amazon Pinpoint to take if it can't read the required MX record when\n you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses\n amazonses.com as the MAIL FROM domain. When you set this value\n to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified\n error, and doesn't attempt to deliver the email.

\n

These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending, Failed, and TemporaryFailure\n states.

" } }, - "MailFromDomain": { - "target": "com.amazonaws.pinpointemail#MailFromDomainName", + "EmailIdentity": { + "target": "com.amazonaws.pinpointemail#Identity", "traits": { - "smithy.api#documentation": "

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM\n domain must meet the following criteria:

\n
    \n
  • \n

    It has to be a subdomain of the verified identity.

    \n
    • \n
  • \n

    It can't be used to receive email.

    \n
    • \n
  • \n

    It can't be used in a \"From\" address if the MAIL FROM domain is a destination\n for feedback forwarding emails.

    \n
    • \n
" + "smithy.api#documentation": "

The verified email identity that you want to set up the custom MAIL FROM domain\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -4241,6 +4241,13 @@ "com.amazonaws.pinpointemail#SendEmailRequest": { "type": "structure", "members": { + "Content": { + "target": "com.amazonaws.pinpointemail#EmailContent", + "traits": { + "smithy.api#documentation": "

An object that contains the body of the message. You can send either a Simple message\n or a Raw message.

", + "smithy.api#required": {} + } + }, "ReplyToAddresses": { "target": "com.amazonaws.pinpointemail#EmailAddressList", "traits": { @@ -4265,25 +4272,18 @@ "smithy.api#documentation": "

The email address that you want to use as the \"From\" address for the email. The\n address that you specify has to be verified.\n

" } }, - "Destination": { - "target": "com.amazonaws.pinpointemail#Destination", + "EmailTags": { + "target": "com.amazonaws.pinpointemail#MessageTagList", "traits": { - "smithy.api#documentation": "

An object that contains the recipients of the email message.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of tags, in the form of name/value pairs, to apply to an email that you send\n using the SendEmail operation. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events.

" } }, - "Content": { - "target": "com.amazonaws.pinpointemail#EmailContent", + "Destination": { + "target": "com.amazonaws.pinpointemail#Destination", "traits": { - "smithy.api#documentation": "

An object that contains the body of the message. You can send either a Simple message\n or a Raw message.

", + "smithy.api#documentation": "

An object that contains the recipients of the email message.

", "smithy.api#required": {} } - }, - "EmailTags": { - "target": "com.amazonaws.pinpointemail#MessageTagList", - "traits": { - "smithy.api#documentation": "

A list of tags, in the form of name/value pairs, to apply to an email that you send\n using the SendEmail operation. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events.

" - } } }, "traits": { @@ -4313,17 +4313,17 @@ "smithy.api#documentation": "

The maximum number of emails that you can send in the current AWS Region over a\n 24-hour period. This value is also called your sending\n quota.

" } }, - "MaxSendRate": { - "target": "com.amazonaws.pinpointemail#MaxSendRate", - "traits": { - "smithy.api#documentation": "

The maximum number of emails that you can send per second in the current AWS Region.\n This value is also called your maximum sending rate or your\n maximum TPS (transactions per second) rate.

" - } - }, "SentLast24Hours": { "target": "com.amazonaws.pinpointemail#SentLast24Hours", "traits": { "smithy.api#documentation": "

The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the\n past 24 hours.

" } + }, + "MaxSendRate": { + "target": "com.amazonaws.pinpointemail#MaxSendRate", + "traits": { + "smithy.api#documentation": "

The maximum number of emails that you can send per second in the current AWS Region.\n This value is also called your maximum sending rate or your\n maximum TPS (transactions per second) rate.

" + } } }, "traits": { @@ -4481,17 +4481,17 @@ "com.amazonaws.pinpointemail#Template": { "type": "structure", "members": { - "TemplateArn": { - "target": "com.amazonaws.pinpointemail#TemplateArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, "TemplateData": { "target": "com.amazonaws.pinpointemail#TemplateData", "traits": { "smithy.api#documentation": "

An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

" } + }, + "TemplateArn": { + "target": "com.amazonaws.pinpointemail#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" + } } } }, @@ -4641,6 +4641,14 @@ "com.amazonaws.pinpointemail#UpdateConfigurationSetEventDestinationRequest": { "type": "structure", "members": { + "EventDestinationName": { + "target": "com.amazonaws.pinpointemail#EventDestinationName", + "traits": { + "smithy.api#documentation": "

The name of the event destination that you want to modify.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ConfigurationSetName": { "target": "com.amazonaws.pinpointemail#ConfigurationSetName", "traits": { @@ -4655,14 +4663,6 @@ "smithy.api#documentation": "

An object that defines the event destination.

", "smithy.api#required": {} } - }, - "EventDestinationName": { - "target": "com.amazonaws.pinpointemail#EventDestinationName", - "traits": { - "smithy.api#documentation": "

The name of the event destination that you want to modify.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -4692,10 +4692,10 @@ "smithy.api#documentation": "

The total number of emails that arrived in recipients' inboxes.

" } }, - "ProjectedSpam": { + "SpamRawCount": { "target": "com.amazonaws.pinpointemail#Volume", "traits": { - "smithy.api#documentation": "

An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' spam or junk mail folders.

" + "smithy.api#documentation": "

The total number of emails that arrived in recipients' spam or junk mail\n folders.

" } }, "ProjectedInbox": { @@ -4704,10 +4704,10 @@ "smithy.api#documentation": "

An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' inboxes.

" } }, - "SpamRawCount": { + "ProjectedSpam": { "target": "com.amazonaws.pinpointemail#Volume", "traits": { - "smithy.api#documentation": "

The total number of emails that arrived in recipients' spam or junk mail\n folders.

" + "smithy.api#documentation": "

An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' spam or junk mail folders.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/pinpoint-sms-voice.2018-09-05.json b/codegen/sdk-codegen/aws-models/pinpoint-sms-voice.2018-09-05.json index 63f5e835f42b..58dc4317b44b 100644 --- a/codegen/sdk-codegen/aws-models/pinpoint-sms-voice.2018-09-05.json +++ b/codegen/sdk-codegen/aws-models/pinpoint-sms-voice.2018-09-05.json @@ -75,16 +75,16 @@ "com.amazonaws.pinpointsmsvoice#CloudWatchLogsDestination": { "type": "structure", "members": { - "IamRoleArn": { + "LogGroupArn": { "target": "com.amazonaws.pinpointsmsvoice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination." + "smithy.api#documentation": "The name of the Amazon CloudWatch Log Group that you want to record events in." } }, - "LogGroupArn": { + "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoice#String", "traits": { - "smithy.api#documentation": "The name of the Amazon CloudWatch Log Group that you want to record events in." + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination." } } }, @@ -175,14 +175,6 @@ "com.amazonaws.pinpointsmsvoice#CreateConfigurationSetEventDestinationRequest": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.pinpointsmsvoice#__string", - "traits": { - "smithy.api#documentation": "ConfigurationSetName", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "EventDestination": { "target": "com.amazonaws.pinpointsmsvoice#EventDestinationDefinition" }, @@ -191,6 +183,14 @@ "traits": { "smithy.api#documentation": "A name that identifies the event destination." } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.pinpointsmsvoice#__string", + "traits": { + "smithy.api#documentation": "ConfigurationSetName", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -290,18 +290,18 @@ "com.amazonaws.pinpointsmsvoice#DeleteConfigurationSetEventDestinationRequest": { "type": "structure", "members": { - "ConfigurationSetName": { + "EventDestinationName": { "target": "com.amazonaws.pinpointsmsvoice#__string", "traits": { - "smithy.api#documentation": "ConfigurationSetName", + "smithy.api#documentation": "EventDestinationName", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "EventDestinationName": { + "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoice#__string", "traits": { - "smithy.api#documentation": "EventDestinationName", + "smithy.api#documentation": "ConfigurationSetName", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -338,14 +338,11 @@ "com.amazonaws.pinpointsmsvoice#EventDestination": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpointsmsvoice#String", - "traits": { - "smithy.api#documentation": "A name that identifies the event destination configuration." - } + "KinesisFirehoseDestination": { + "target": "com.amazonaws.pinpointsmsvoice#KinesisFirehoseDestination" }, - "SnsDestination": { - "target": "com.amazonaws.pinpointsmsvoice#SnsDestination" + "MatchingEventTypes": { + "target": "com.amazonaws.pinpointsmsvoice#EventTypes" }, "Enabled": { "target": "com.amazonaws.pinpointsmsvoice#Boolean", @@ -353,14 +350,17 @@ "smithy.api#documentation": "Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination." } }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.pinpointsmsvoice#KinesisFirehoseDestination" - }, - "MatchingEventTypes": { - "target": "com.amazonaws.pinpointsmsvoice#EventTypes" - }, "CloudWatchLogsDestination": { "target": "com.amazonaws.pinpointsmsvoice#CloudWatchLogsDestination" + }, + "Name": { + "target": "com.amazonaws.pinpointsmsvoice#String", + "traits": { + "smithy.api#documentation": "A name that identifies the event destination configuration." + } + }, + "SnsDestination": { + "target": "com.amazonaws.pinpointsmsvoice#SnsDestination" } }, "traits": { @@ -370,14 +370,8 @@ "com.amazonaws.pinpointsmsvoice#EventDestinationDefinition": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.pinpointsmsvoice#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination." - } - }, - "SnsDestination": { - "target": "com.amazonaws.pinpointsmsvoice#SnsDestination" + "CloudWatchLogsDestination": { + "target": "com.amazonaws.pinpointsmsvoice#CloudWatchLogsDestination" }, "KinesisFirehoseDestination": { "target": "com.amazonaws.pinpointsmsvoice#KinesisFirehoseDestination" @@ -385,8 +379,14 @@ "MatchingEventTypes": { "target": "com.amazonaws.pinpointsmsvoice#EventTypes" }, - "CloudWatchLogsDestination": { - "target": "com.amazonaws.pinpointsmsvoice#CloudWatchLogsDestination" + "SnsDestination": { + "target": "com.amazonaws.pinpointsmsvoice#SnsDestination" + }, + "Enabled": { + "target": "com.amazonaws.pinpointsmsvoice#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination." + } } }, "traits": { @@ -598,17 +598,17 @@ "com.amazonaws.pinpointsmsvoice#ListConfigurationSetsResponse": { "type": "structure", "members": { - "ConfigurationSets": { - "target": "com.amazonaws.pinpointsmsvoice#ConfigurationSets", - "traits": { - "smithy.api#documentation": "An object that contains a list of configuration sets for your account in the current region." - } - }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoice#NextTokenString", "traits": { "smithy.api#documentation": "A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets." } + }, + "ConfigurationSets": { + "target": "com.amazonaws.pinpointsmsvoice#ConfigurationSets", + "traits": { + "smithy.api#documentation": "An object that contains a list of configuration sets for your account in the current region." + } } }, "traits": { @@ -668,7 +668,7 @@ "sdkId": "Pinpoint SMS Voice", "arnNamespace": "sms-voice", "cloudFormationName": "PinpointSMSVoice", - "cloudTrailEventSource": "pinpoint_sms_voice.amazonaws.com" + "cloudTrailEventSource": "pinpointsmsvoice.amazonaws.com" }, "aws.auth#sigv4": { "name": "sms-voice" @@ -681,10 +681,10 @@ "com.amazonaws.pinpointsmsvoice#PlainTextMessageType": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.pinpointsmsvoice#String", + "Text": { + "target": "com.amazonaws.pinpointsmsvoice#NonEmptyString", "traits": { - "smithy.api#documentation": "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + "smithy.api#documentation": "The plain (not SSML-formatted) text to deliver to the recipient." } }, "VoiceId": { @@ -693,10 +693,10 @@ "smithy.api#documentation": "The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide." } }, - "Text": { - "target": "com.amazonaws.pinpointsmsvoice#NonEmptyString", + "LanguageCode": { + "target": "com.amazonaws.pinpointsmsvoice#String", "traits": { - "smithy.api#documentation": "The plain (not SSML-formatted) text to deliver to the recipient." + "smithy.api#documentation": "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." } } }, @@ -707,10 +707,10 @@ "com.amazonaws.pinpointsmsvoice#SSMLMessageType": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.pinpointsmsvoice#String", + "Text": { + "target": "com.amazonaws.pinpointsmsvoice#NonEmptyString", "traits": { - "smithy.api#documentation": "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + "smithy.api#documentation": "The SSML-formatted text to deliver to the recipient." } }, "VoiceId": { @@ -719,10 +719,10 @@ "smithy.api#documentation": "The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide." } }, - "Text": { - "target": "com.amazonaws.pinpointsmsvoice#NonEmptyString", + "LanguageCode": { + "target": "com.amazonaws.pinpointsmsvoice#String", "traits": { - "smithy.api#documentation": "The SSML-formatted text to deliver to the recipient." + "smithy.api#documentation": "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." } } }, @@ -761,32 +761,32 @@ "com.amazonaws.pinpointsmsvoice#SendVoiceMessageRequest": { "type": "structure", "members": { - "CallerId": { - "target": "com.amazonaws.pinpointsmsvoice#String", - "traits": { - "smithy.api#documentation": "The phone number that appears on recipients' devices when they receive the message." - } - }, - "Content": { - "target": "com.amazonaws.pinpointsmsvoice#VoiceMessageContent" - }, "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoice#WordCharactersWithDelimiters", "traits": { "smithy.api#documentation": "The name of the configuration set that you want to use to send the message." } }, - "OriginationPhoneNumber": { + "DestinationPhoneNumber": { "target": "com.amazonaws.pinpointsmsvoice#NonEmptyString", "traits": { - "smithy.api#documentation": "The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request." + "smithy.api#documentation": "The phone number that you want to send the voice message to." } }, - "DestinationPhoneNumber": { + "CallerId": { + "target": "com.amazonaws.pinpointsmsvoice#String", + "traits": { + "smithy.api#documentation": "The phone number that appears on recipients' devices when they receive the message." + } + }, + "OriginationPhoneNumber": { "target": "com.amazonaws.pinpointsmsvoice#NonEmptyString", "traits": { - "smithy.api#documentation": "The phone number that you want to send the voice message to." + "smithy.api#documentation": "The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request." } + }, + "Content": { + "target": "com.amazonaws.pinpointsmsvoice#VoiceMessageContent" } }, "traits": { @@ -871,21 +871,21 @@ "com.amazonaws.pinpointsmsvoice#UpdateConfigurationSetEventDestinationRequest": { "type": "structure", "members": { - "EventDestination": { - "target": "com.amazonaws.pinpointsmsvoice#EventDestinationDefinition" - }, - "EventDestinationName": { + "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoice#__string", "traits": { - "smithy.api#documentation": "EventDestinationName", + "smithy.api#documentation": "ConfigurationSetName", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ConfigurationSetName": { + "EventDestination": { + "target": "com.amazonaws.pinpointsmsvoice#EventDestinationDefinition" + }, + "EventDestinationName": { "target": "com.amazonaws.pinpointsmsvoice#__string", "traits": { - "smithy.api#documentation": "ConfigurationSetName", + "smithy.api#documentation": "EventDestinationName", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -905,14 +905,14 @@ "com.amazonaws.pinpointsmsvoice#VoiceMessageContent": { "type": "structure", "members": { - "PlainTextMessage": { - "target": "com.amazonaws.pinpointsmsvoice#PlainTextMessageType" + "SSMLMessage": { + "target": "com.amazonaws.pinpointsmsvoice#SSMLMessageType" }, "CallInstructionsMessage": { "target": "com.amazonaws.pinpointsmsvoice#CallInstructionsMessageType" }, - "SSMLMessage": { - "target": "com.amazonaws.pinpointsmsvoice#SSMLMessageType" + "PlainTextMessage": { + "target": "com.amazonaws.pinpointsmsvoice#PlainTextMessageType" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json b/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json index 63369d8c524e..f351682b52fc 100644 --- a/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json +++ b/codegen/sdk-codegen/aws-models/pinpoint.2016-12-01.json @@ -32,6 +32,12 @@ "com.amazonaws.pinpoint#ADMChannelRequest": { "type": "structure", "members": { + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable the ADM channel for the application.

" + } + }, "ClientId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -45,12 +51,6 @@ "smithy.api#documentation": "

The Client Secret that you received from Amazon to send messages by using ADM.

", "smithy.api#required": {} } - }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable the ADM channel for the application.

" - } } }, "traits": { @@ -60,34 +60,34 @@ "com.amazonaws.pinpoint#ADMChannelResponse": { "type": "structure", "members": { - "LastModifiedBy": { - "target": "com.amazonaws.pinpoint#__string", + "IsArchived": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

The user who last modified the ADM channel.

" + "smithy.api#documentation": "

Specifies whether the ADM channel is archived.

" } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "LastModifiedBy": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The current version of the ADM channel.

" + "smithy.api#documentation": "

The user who last modified the ADM channel.

" } }, - "ApplicationId": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The unique identifier for the application that the ADM channel applies to.

" + "smithy.api#documentation": "

The date and time when the ADM channel was enabled.

" } }, - "HasCredential": { - "target": "com.amazonaws.pinpoint#__boolean", + "LastModifiedDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

(Not used) This property is retained only for backward compatibility.

" + "smithy.api#documentation": "

The date and time when the ADM channel was last modified.

" } }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

Specifies whether the ADM channel is enabled for the application.

" + "smithy.api#documentation": "

(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

" } }, "Platform": { @@ -97,28 +97,28 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.pinpoint#__string", + "HasCredential": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

" + "smithy.api#documentation": "

(Not used) This property is retained only for backward compatibility.

" } }, - "IsArchived": { + "Enabled": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the ADM channel is archived.

" + "smithy.api#documentation": "

Specifies whether the ADM channel is enabled for the application.

" } }, - "LastModifiedDate": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The date and time when the ADM channel was last modified.

" + "smithy.api#documentation": "

The unique identifier for the application that the ADM channel applies to.

" } }, - "CreationDate": { - "target": "com.amazonaws.pinpoint#__string", + "Version": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

The date and time when the ADM channel was enabled.

" + "smithy.api#documentation": "

The current version of the ADM channel.

" } } }, @@ -129,82 +129,88 @@ "com.amazonaws.pinpoint#ADMMessage": { "type": "structure", "members": { + "Data": { + "target": "com.amazonaws.pinpoint#MapOf__string", + "traits": { + "smithy.api#documentation": "

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

" + } + }, "Title": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

The title to display above the notification message on the recipient's device.

" } }, - "Sound": { + "ExpiresAfter": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

" + "smithy.api#documentation": "

The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

" } }, - "RawContent": { + "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

" + "smithy.api#documentation": "

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

" } }, - "Body": { - "target": "com.amazonaws.pinpoint#__string", + "Substitutions": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

The body of the notification message.

" + "smithy.api#documentation": "

The default message variables to use in the notification message. You can override the default variables with individual address variables.

" } }, - "Url": { + "Sound": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

" + "smithy.api#documentation": "

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

" } }, - "ConsolidationKey": { + "ImageUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

" + "smithy.api#documentation": "

The URL of an image to display in the push notification.

" } }, - "IconReference": { + "MD5": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The icon image name of the asset saved in your app.

" + "smithy.api#documentation": "

The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

" } }, - "Action": { - "target": "com.amazonaws.pinpoint#Action", + "ImageIconUrl": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

" + "smithy.api#documentation": "

The URL of the large icon image to display in the content view of the push notification.

" } }, - "Data": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "SmallImageIconUrl": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

" + "smithy.api#documentation": "

The URL of the small icon image to display in the status bar and the content view of the push notification.

" } }, - "ExpiresAfter": { - "target": "com.amazonaws.pinpoint#__string", + "Action": { + "target": "com.amazonaws.pinpoint#Action", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

" + "smithy.api#documentation": "

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

" } }, - "ImageUrl": { + "ConsolidationKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The URL of an image to display in the push notification.

" + "smithy.api#documentation": "

An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

" } }, - "SmallImageIconUrl": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The URL of the small icon image to display in the status bar and the content view of the push notification.

" + "smithy.api#documentation": "

The body of the notification message.

" } }, - "Substitutions": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "RawContent": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The default message variables to use in the notification message. You can override the default variables with individual address variables.

" + "smithy.api#documentation": "

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

" } }, "SilentPush": { @@ -213,16 +219,10 @@ "smithy.api#documentation": "

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

" } }, - "MD5": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

" - } - }, - "ImageIconUrl": { + "IconReference": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The URL of the large icon image to display in the content view of the push notification.

" + "smithy.api#documentation": "

The icon image name of the asset saved in your app.

" } } }, @@ -245,40 +245,40 @@ "smithy.api#documentation": "

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

" } }, - "TokenKey": { + "Certificate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The authentication key to use for APNs tokens.

" + "smithy.api#documentation": "

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

" } }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "TeamId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

Specifies whether to enable the APNs channel for the application.

" + "smithy.api#documentation": "

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

" } }, - "TokenKeyId": { + "DefaultAuthenticationMethod": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

" + "smithy.api#documentation": "

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

" } }, - "TeamId": { + "TokenKeyId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

" + "smithy.api#documentation": "

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

" } }, - "Certificate": { + "TokenKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

" + "smithy.api#documentation": "

The authentication key to use for APNs tokens.

" } }, - "DefaultAuthenticationMethod": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

" + "smithy.api#documentation": "

Specifies whether to enable the APNs channel for the application.

" } } }, @@ -289,12 +289,6 @@ "com.amazonaws.pinpoint#APNSChannelResponse": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for the application that the APNs channel applies to.

" - } - }, "HasCredential": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { @@ -307,10 +301,10 @@ "smithy.api#documentation": "

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

" } }, - "LastModifiedBy": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

The user who last modified the APNs channel.

" + "smithy.api#documentation": "

Specifies whether the APNs channel is enabled for the application.

" } }, "Platform": { @@ -326,18 +320,6 @@ "smithy.api#documentation": "

(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

" } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", - "traits": { - "smithy.api#documentation": "

The current version of the APNs channel.

" - } - }, - "HasTokenKey": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

" - } - }, "IsArchived": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { @@ -356,10 +338,28 @@ "smithy.api#documentation": "

The date and time when the APNs channel was last modified.

" } }, - "Enabled": { + "HasTokenKey": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the APNs channel is enabled for the application.

" + "smithy.api#documentation": "

Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

The user who last modified the APNs channel.

" + } + }, + "Version": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

The current version of the APNs channel.

" + } + }, + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for the application that the APNs channel applies to.

" } } }, @@ -370,70 +370,70 @@ "com.amazonaws.pinpoint#APNSMessage": { "type": "structure", "members": { + "Sound": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

" + } + }, "Data": { "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { "smithy.api#documentation": "

The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

" } }, - "Title": { + "APNSPushType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The title to display above the notification message on the recipient's device.

" + "smithy.api#documentation": "

The type of push notification to send. Valid values are:

  • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.

  • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.

  • complication - For a notification that contains update information for an app’s complication timeline.

  • fileprovider - For a notification that signals changes to a File Provider extension.

  • mdm - For a notification that tells managed devices to contact the MDM server.

  • voip - For a notification that provides information about an incoming VoIP call.

Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

" } }, - "PreferredAuthenticationMethod": { + "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

" + "smithy.api#documentation": "

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

" } }, - "MediaUrl": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The URL of an image or video to display in the push notification.

" + "smithy.api#documentation": "

The body of the notification message.

" } }, - "Sound": { + "RawContent": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

" + "smithy.api#documentation": "

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

" } }, - "Category": { - "target": "com.amazonaws.pinpoint#__string", + "Action": { + "target": "com.amazonaws.pinpoint#Action", "traits": { - "smithy.api#documentation": "

The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

" + "smithy.api#documentation": "

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

" } }, - "Body": { + "Title": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The body of the notification message.

" + "smithy.api#documentation": "

The title to display above the notification message on the recipient's device.

" } }, - "APNSPushType": { + "PreferredAuthenticationMethod": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The type of push notification to send. Valid values are:

  • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.

  • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.

  • complication - For a notification that contains update information for an app’s complication timeline.

  • fileprovider - For a notification that signals changes to a File Provider extension.

  • mdm - For a notification that tells managed devices to contact the MDM server.

  • voip - For a notification that provides information about an incoming VoIP call.

Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

" + "smithy.api#documentation": "

The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

" } }, - "RawContent": { + "Priority": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

" - } - }, - "Substitutions": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", - "traits": { - "smithy.api#documentation": "

The default message variables to use in the notification message. You can override these default variables with individual address variables.

" + "smithy.api#documentation": "

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

  • 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

    • /para>

    Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

    The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

    " } }, - "SilentPush": { - "target": "com.amazonaws.pinpoint#__boolean", + "TimeToLive": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

    Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

    Apple has indicated that they will throttle \"excessive\" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

    " + "smithy.api#documentation": "

    The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

    " } }, "CollapseId": { @@ -442,40 +442,40 @@ "smithy.api#documentation": "

    An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

    Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

    " } }, - "Badge": { - "target": "com.amazonaws.pinpoint#__integer", + "SilentPush": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

    " + "smithy.api#documentation": "

    Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

    Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

    Apple has indicated that they will throttle \"excessive\" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

    " } }, - "ThreadId": { + "MediaUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

    " + "smithy.api#documentation": "

    The URL of an image or video to display in the push notification.

    " } }, - "Priority": { + "Category": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

    /listitem>

  • 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

    • /para>

    Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

    The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

    " + "smithy.api#documentation": "

    The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

    " } }, - "Action": { - "target": "com.amazonaws.pinpoint#Action", + "Badge": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + "smithy.api#documentation": "

    The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

    " } }, - "Url": { - "target": "com.amazonaws.pinpoint#__string", + "Substitutions": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + "smithy.api#documentation": "

    The default message variables to use in the notification message. You can override these default variables with individual address variables.

    " } }, - "TimeToLive": { - "target": "com.amazonaws.pinpoint#__integer", + "ThreadId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

    " + "smithy.api#documentation": "

    The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

    " } } }, @@ -486,24 +486,12 @@ "com.amazonaws.pinpoint#APNSPushNotificationTemplate": { "type": "structure", "members": { - "Title": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

    " - } - }, "Sound": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

    " } }, - "MediaUrl": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The URL of an image or video to display in push notifications that are based on the message template.

    " - } - }, "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -516,16 +504,28 @@ "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

    " } }, + "Body": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The message body to use in push notifications that are based on the message template.

    " + } + }, "Action": { "target": "com.amazonaws.pinpoint#Action", "traits": { "smithy.api#documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " } }, - "Body": { + "MediaUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message body to use in push notifications that are based on the message template.

    " + "smithy.api#documentation": "

    The URL of an image or video to display in push notifications that are based on the message template.

    " + } + }, + "Title": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

    " } } }, @@ -536,10 +536,10 @@ "com.amazonaws.pinpoint#APNSSandboxChannelRequest": { "type": "structure", "members": { - "TokenKey": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The authentication key to use for APNs tokens.

    " + "smithy.api#documentation": "

    Specifies whether to enable the APNs sandbox channel for the application.

    " } }, "DefaultAuthenticationMethod": { @@ -548,40 +548,40 @@ "smithy.api#documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.

    " } }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "TokenKey": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether to enable the APNs sandbox channel for the application.

    " + "smithy.api#documentation": "

    The authentication key to use for APNs tokens.

    " } }, - "TokenKeyId": { + "PrivateKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

    " + "smithy.api#documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

    " } }, - "TeamId": { + "BundleId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " + "smithy.api#documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " } }, - "Certificate": { + "TeamId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

    " + "smithy.api#documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " } }, - "BundleId": { + "TokenKeyId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " + "smithy.api#documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

    " } }, - "PrivateKey": { + "Certificate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

    " + "smithy.api#documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

    " } } }, @@ -592,10 +592,11 @@ "com.amazonaws.pinpoint#APNSSandboxChannelResponse": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "Platform": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs sandbox channel is enabled for the application.

    " + "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

    ", + "smithy.api#required": {} } }, "Id": { @@ -604,65 +605,64 @@ "smithy.api#documentation": "

    (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

    " } }, - "DefaultAuthenticationMethod": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

    " - } - }, "Version": { "target": "com.amazonaws.pinpoint#__integer", "traits": { "smithy.api#documentation": "

    The current version of the APNs sandbox channel.

    " } }, - "HasCredential": { + "LastModifiedBy": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The user who last modified the APNs sandbox channel.

    " + } + }, + "HasTokenKey": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " } }, - "Platform": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for the application that the APNs sandbox channel applies to.

    " } }, - "IsArchived": { + "HasCredential": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs sandbox channel is archived.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, - "LastModifiedDate": { - "target": "com.amazonaws.pinpoint#__string", + "IsArchived": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The date and time when the APNs sandbox channel was last modified.

    " + "smithy.api#documentation": "

    Specifies whether the APNs sandbox channel is archived.

    " } }, - "CreationDate": { + "DefaultAuthenticationMethod": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time when the APNs sandbox channel was enabled.

    " + "smithy.api#documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

    " } }, - "HasTokenKey": { + "Enabled": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " + "smithy.api#documentation": "

    Specifies whether the APNs sandbox channel is enabled for the application.

    " } }, - "LastModifiedBy": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The user who last modified the APNs sandbox channel.

    " + "smithy.api#documentation": "

    The date and time when the APNs sandbox channel was last modified.

    " } }, - "ApplicationId": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the APNs sandbox channel applies to.

    " + "smithy.api#documentation": "

    The date and time when the APNs sandbox channel was enabled.

    " } } }, @@ -673,52 +673,52 @@ "com.amazonaws.pinpoint#APNSVoipChannelRequest": { "type": "structure", "members": { - "Certificate": { + "TokenKeyId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

    " + "smithy.api#documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

    " } }, - "DefaultAuthenticationMethod": { + "BundleId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

    " + "smithy.api#documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " } }, - "TokenKey": { + "PrivateKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The authentication key to use for APNs tokens.

    " + "smithy.api#documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

    " } }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "Certificate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether to enable the APNs VoIP channel for the application.

    " + "smithy.api#documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

    " } }, - "TokenKeyId": { + "TeamId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

    " + "smithy.api#documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " } }, - "BundleId": { + "DefaultAuthenticationMethod": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " + "smithy.api#documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

    " } }, - "PrivateKey": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

    " + "smithy.api#documentation": "

    Specifies whether to enable the APNs VoIP channel for the application.

    " } }, - "TeamId": { + "TokenKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " + "smithy.api#documentation": "

    The authentication key to use for APNs tokens.

    " } } }, @@ -729,16 +729,10 @@ "com.amazonaws.pinpoint#APNSVoipChannelResponse": { "type": "structure", "members": { - "HasCredential": { + "Enabled": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " - } - }, - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the APNs VoIP channel applies to.

    " + "smithy.api#documentation": "

    Specifies whether the APNs VoIP channel is enabled for the application.

    " } }, "DefaultAuthenticationMethod": { @@ -747,23 +741,29 @@ "smithy.api#documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

    " } }, - "LastModifiedBy": { - "target": "com.amazonaws.pinpoint#__string", + "HasCredential": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The user who last modified the APNs VoIP channel.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, - "HasTokenKey": { - "target": "com.amazonaws.pinpoint#__boolean", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " + "smithy.api#documentation": "

    (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

    " } }, "Platform": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

    ", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The current version of the APNs VoIP channel.

    " } }, "IsArchived": { @@ -772,12 +772,6 @@ "smithy.api#documentation": "

    Specifies whether the APNs VoIP channel is archived.

    " } }, - "Id": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

    " - } - }, "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -790,16 +784,22 @@ "smithy.api#documentation": "

    The date and time when the APNs VoIP channel was last modified.

    " } }, - "Enabled": { + "HasTokenKey": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs VoIP channel is enabled for the application.

    " + "smithy.api#documentation": "

    Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The current version of the APNs VoIP channel.

    " + "smithy.api#documentation": "

    The unique identifier for the application that the APNs VoIP channel applies to.

    " + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The user who last modified the APNs VoIP channel.

    " } } }, @@ -816,22 +816,22 @@ "smithy.api#documentation": "

    Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    " } }, - "TeamId": { + "PrivateKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " + "smithy.api#documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

    " } }, - "TokenKeyId": { + "TokenKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

    " + "smithy.api#documentation": "

    The authentication key to use for APNs tokens.

    " } }, - "PrivateKey": { + "TeamId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

    " + "smithy.api#documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " } }, "BundleId": { @@ -840,22 +840,22 @@ "smithy.api#documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " } }, - "DefaultAuthenticationMethod": { + "Certificate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

    " + "smithy.api#documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

    " } }, - "Certificate": { + "DefaultAuthenticationMethod": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

    " + "smithy.api#documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

    " } }, - "TokenKey": { + "TokenKeyId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The authentication key to use for APNs tokens.

    " + "smithy.api#documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

    " } } }, @@ -866,16 +866,16 @@ "com.amazonaws.pinpoint#APNSVoipSandboxChannelResponse": { "type": "structure", "members": { - "Enabled": { + "HasTokenKey": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    " + "smithy.api#documentation": "

    Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The current version of the APNs VoIP sandbox channel.

    " + "smithy.api#documentation": "

    (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

    " } }, "Platform": { @@ -885,28 +885,34 @@ "smithy.api#required": {} } }, - "HasTokenKey": { - "target": "com.amazonaws.pinpoint#__boolean", + "LastModifiedBy": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " + "smithy.api#documentation": "

    The user who last modified the APNs VoIP sandbox channel.

    " } }, - "Id": { + "Version": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The current version of the APNs VoIP sandbox channel.

    " + } + }, + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    The unique identifier for the application that the APNs VoIP sandbox channel applies to.

    " } }, - "IsArchived": { + "HasCredential": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the APNs VoIP sandbox channel is archived.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, - "CreationDate": { + "DefaultAuthenticationMethod": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time when the APNs VoIP sandbox channel was enabled.

    " + "smithy.api#documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

    " } }, "LastModifiedDate": { @@ -915,28 +921,22 @@ "smithy.api#documentation": "

    The date and time when the APNs VoIP sandbox channel was last modified.

    " } }, - "ApplicationId": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the APNs VoIP sandbox channel applies to.

    " + "smithy.api#documentation": "

    The date and time when the APNs VoIP sandbox channel was enabled.

    " } }, - "HasCredential": { + "IsArchived": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The user who last modified the APNs VoIP sandbox channel.

    " + "smithy.api#documentation": "

    Specifies whether the APNs VoIP sandbox channel is archived.

    " } }, - "DefaultAuthenticationMethod": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

    " + "smithy.api#documentation": "

    Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    " } } }, @@ -987,16 +987,16 @@ "com.amazonaws.pinpoint#Activity": { "type": "structure", "members": { - "SMS": { - "target": "com.amazonaws.pinpoint#SMSMessageActivity", + "Wait": { + "target": "com.amazonaws.pinpoint#WaitActivity", "traits": { - "smithy.api#documentation": "

    The settings for an SMS activity. This type of activity sends a text message to participants.

    " + "smithy.api#documentation": "

    The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

    " } }, - "MultiCondition": { - "target": "com.amazonaws.pinpoint#MultiConditionalSplitActivity", + "EMAIL": { + "target": "com.amazonaws.pinpoint#EmailMessageActivity", "traits": { - "smithy.api#documentation": "

    The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

    " + "smithy.api#documentation": "

    The settings for an email activity. This type of activity sends an email message to participants.

    " } }, "Description": { @@ -1005,28 +1005,16 @@ "smithy.api#documentation": "

    The custom description of the activity.

    " } }, - "Wait": { - "target": "com.amazonaws.pinpoint#WaitActivity", - "traits": { - "smithy.api#documentation": "

    The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

    " - } - }, - "Holdout": { - "target": "com.amazonaws.pinpoint#HoldoutActivity", - "traits": { - "smithy.api#documentation": "

    The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

    " - } - }, - "CUSTOM": { - "target": "com.amazonaws.pinpoint#CustomMessageActivity", + "MultiCondition": { + "target": "com.amazonaws.pinpoint#MultiConditionalSplitActivity", "traits": { - "smithy.api#documentation": "

    The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

    " + "smithy.api#documentation": "

    The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

    " } }, - "EMAIL": { - "target": "com.amazonaws.pinpoint#EmailMessageActivity", + "RandomSplit": { + "target": "com.amazonaws.pinpoint#RandomSplitActivity", "traits": { - "smithy.api#documentation": "

    The settings for an email activity. This type of activity sends an email message to participants.

    " + "smithy.api#documentation": "

    The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

    " } }, "ConditionalSplit": { @@ -1035,16 +1023,28 @@ "smithy.api#documentation": "

    The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

    " } }, + "Holdout": { + "target": "com.amazonaws.pinpoint#HoldoutActivity", + "traits": { + "smithy.api#documentation": "

    The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

    " + } + }, "PUSH": { "target": "com.amazonaws.pinpoint#PushMessageActivity", "traits": { "smithy.api#documentation": "

    The settings for a push notification activity. This type of activity sends a push notification to participants.

    " } }, - "RandomSplit": { - "target": "com.amazonaws.pinpoint#RandomSplitActivity", + "CUSTOM": { + "target": "com.amazonaws.pinpoint#CustomMessageActivity", "traits": { - "smithy.api#documentation": "

    The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

    " + "smithy.api#documentation": "

    The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

    " + } + }, + "SMS": { + "target": "com.amazonaws.pinpoint#SMSMessageActivity", + "traits": { + "smithy.api#documentation": "

    The settings for an SMS activity. This type of activity sends a text message to participants.

    " } } }, @@ -1068,35 +1068,29 @@ "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

    " - } - }, "End": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

    " } }, - "TimezonesCompletedCount": { - "target": "com.amazonaws.pinpoint#__integer", + "CampaignId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The total number of time zones that were completed.

    " + "smithy.api#documentation": "

    The unique identifier for the campaign that the activity applies to.

    ", + "smithy.api#required": {} } }, - "Id": { + "Start": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the activity.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The actual start time, in ISO 8601 format, of the activity.

    " } }, - "TreatmentId": { + "ScheduledStart": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    " + "smithy.api#documentation": "

    The scheduled start time, in ISO 8601 format, for the activity.

    " } }, "SuccessfulEndpointCount": { @@ -1105,35 +1099,41 @@ "smithy.api#documentation": "

    The total number of endpoints that the campaign successfully delivered messages to.

    " } }, - "ScheduledStart": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The scheduled start time, in ISO 8601 format, for the activity.

    " - } - }, "TotalEndpointCount": { "target": "com.amazonaws.pinpoint#__integer", "traits": { "smithy.api#documentation": "

    The total number of endpoints that the campaign attempted to deliver messages to.

    " } }, - "Result": { + "Id": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

    " + "smithy.api#documentation": "

    The unique identifier for the activity.

    ", + "smithy.api#required": {} } }, - "Start": { + "TreatmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The actual start time, in ISO 8601 format, of the activity.

    " + "smithy.api#documentation": "

    The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    " } }, - "CampaignId": { + "State": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the campaign that the activity applies to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

    " + } + }, + "Result": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

    " + } + }, + "TimezonesCompletedCount": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The total number of time zones that were completed.

    " } } }, @@ -1144,16 +1144,10 @@ "com.amazonaws.pinpoint#AddressConfiguration": { "type": "structure", "members": { - "Substitutions": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", - "traits": { - "smithy.api#documentation": "

    A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

    " - } - }, - "Context": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "ChannelType": { + "target": "com.amazonaws.pinpoint#ChannelType", "traits": { - "smithy.api#documentation": "

    An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

    For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    " + "smithy.api#documentation": "

    The channel to use when sending the message.

    " } }, "TitleOverride": { @@ -1162,12 +1156,6 @@ "smithy.api#documentation": "

    The message title to use instead of the default message title. This value overrides the default message title.

    " } }, - "ChannelType": { - "target": "com.amazonaws.pinpoint#ChannelType", - "traits": { - "smithy.api#documentation": "

    The channel to use when sending the message.

    " - } - }, "BodyOverride": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -1179,6 +1167,18 @@ "traits": { "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

    " } + }, + "Context": { + "target": "com.amazonaws.pinpoint#MapOf__string", + "traits": { + "smithy.api#documentation": "

    An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

    For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    " + } + }, + "Substitutions": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "traits": { + "smithy.api#documentation": "

    A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

    " + } } }, "traits": { @@ -1188,34 +1188,40 @@ "com.amazonaws.pinpoint#AndroidPushNotificationTemplate": { "type": "structure", "members": { - "SmallImageIconUrl": { + "Title": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

    " + "smithy.api#documentation": "

    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

    " } }, - "Sound": { + "ImageUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " + "smithy.api#documentation": "

    The URL of an image to display in a push notification that's based on the message template.

    " + } + }, + "SmallImageIconUrl": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

    " } }, - "RawContent": { - "target": "com.amazonaws.pinpoint#__string", + "Action": { + "target": "com.amazonaws.pinpoint#Action", "traits": { - "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

    " + "smithy.api#documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " } }, - "ImageUrl": { + "ImageIconUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of an image to display in a push notification that's based on the message template.

    " + "smithy.api#documentation": "

    The URL of the large icon image to display in the content view of a push notification that's based on the message template.

    " } }, - "Body": { + "RawContent": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message body to use in a push notification that's based on the message template.

    " + "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

    " } }, "Url": { @@ -1224,22 +1230,16 @@ "smithy.api#documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    " } }, - "ImageIconUrl": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the large icon image to display in the content view of a push notification that's based on the message template.

    " + "smithy.api#documentation": "

    The message body to use in a push notification that's based on the message template.

    " } }, - "Title": { + "Sound": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

    " - } - }, - "Action": { - "target": "com.amazonaws.pinpoint#Action", - "traits": { - "smithy.api#documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + "smithy.api#documentation": "

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " } } }, @@ -1250,13 +1250,6 @@ "com.amazonaws.pinpoint#ApplicationDateRangeKpiResponse": { "type": "structure", "members": { - "KpiResult": { - "target": "com.amazonaws.pinpoint#BaseKpiResult", - "traits": { - "smithy.api#documentation": "

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

    ", - "smithy.api#required": {} - } - }, "KpiName": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -1271,10 +1264,18 @@ "smithy.api#required": {} } }, - "NextToken": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

    " + "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", + "smithy.api#required": {} + } + }, + "KpiResult": { + "target": "com.amazonaws.pinpoint#BaseKpiResult", + "traits": { + "smithy.api#documentation": "

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

    ", + "smithy.api#required": {} } }, "StartTime": { @@ -1284,11 +1285,10 @@ "smithy.api#required": {} } }, - "ApplicationId": { + "NextToken": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

    " } } }, @@ -1299,11 +1299,11 @@ "com.amazonaws.pinpoint#ApplicationResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpoint#__string", + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" } }, "Arn": { @@ -1313,17 +1313,17 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#required": {} } }, - "Id": { + "Name": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

    ", "smithy.api#required": {} } } @@ -1335,10 +1335,10 @@ "com.amazonaws.pinpoint#ApplicationSettingsResource": { "type": "structure", "members": { - "QuietTime": { - "target": "com.amazonaws.pinpoint#QuietTime", + "LastModifiedDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    " + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the application's settings were last modified.

    " } }, "CampaignHook": { @@ -1347,12 +1347,6 @@ "smithy.api#documentation": "

    The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

    " } }, - "Limits": { - "target": "com.amazonaws.pinpoint#CampaignLimits", - "traits": { - "smithy.api#documentation": "

    The default sending limits for campaigns and journeys in the application.

    " - } - }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -1360,10 +1354,16 @@ "smithy.api#required": {} } }, - "LastModifiedDate": { - "target": "com.amazonaws.pinpoint#__string", + "QuietTime": { + "target": "com.amazonaws.pinpoint#QuietTime", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the application's settings were last modified.

    " + "smithy.api#documentation": "

    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    " + } + }, + "Limits": { + "target": "com.amazonaws.pinpoint#CampaignLimits", + "traits": { + "smithy.api#documentation": "

    The default sending limits for campaigns in the application.

    " } } }, @@ -1374,17 +1374,17 @@ "com.amazonaws.pinpoint#ApplicationsResponse": { "type": "structure", "members": { - "Item": { - "target": "com.amazonaws.pinpoint#ListOfApplicationResponse", - "traits": { - "smithy.api#documentation": "

    An array of responses, one for each application that was returned.

    " - } - }, "NextToken": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " } + }, + "Item": { + "target": "com.amazonaws.pinpoint#ListOfApplicationResponse", + "traits": { + "smithy.api#documentation": "

    An array of responses, one for each application that was returned.

    " + } } }, "traits": { @@ -1394,18 +1394,18 @@ "com.amazonaws.pinpoint#AttributeDimension": { "type": "structure", "members": { - "AttributeType": { - "target": "com.amazonaws.pinpoint#AttributeType", - "traits": { - "smithy.api#documentation": "

    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

    " - } - }, "Values": { "target": "com.amazonaws.pinpoint#ListOf__string", "traits": { "smithy.api#documentation": "

    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

    ", "smithy.api#required": {} } + }, + "AttributeType": { + "target": "com.amazonaws.pinpoint#AttributeType", + "traits": { + "smithy.api#documentation": "

    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

    " + } } }, "traits": { @@ -1430,10 +1430,10 @@ "com.amazonaws.pinpoint#AttributesResource": { "type": "structure", "members": { - "ApplicationId": { + "AttributeType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application.

    ", + "smithy.api#documentation": "

    The type of attribute or attributes that were removed from the endpoints. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints.

    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.

    • endpoint-user-attributes - Custom attributes that describe users.

    ", "smithy.api#required": {} } }, @@ -1443,10 +1443,10 @@ "smithy.api#documentation": "

    An array that specifies the names of the attributes that were removed from the endpoints.

    " } }, - "AttributeType": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of attribute or attributes that were removed from the endpoints. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints.

    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.

    • endpoint-user-attributes - Custom attributes that describe users.

    ", + "smithy.api#documentation": "

    The unique identifier for the application.

    ", "smithy.api#required": {} } } @@ -1458,16 +1458,16 @@ "com.amazonaws.pinpoint#BadRequestException": { "type": "structure", "members": { - "Message": { + "RequestID": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message that's returned from the API.

    " + "smithy.api#documentation": "

    The unique identifier for the request or response.

    " } }, - "RequestID": { + "Message": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the request or response.

    " + "smithy.api#documentation": "

    The message that's returned from the API.

    " } } }, @@ -1480,11 +1480,10 @@ "com.amazonaws.pinpoint#BaiduChannelRequest": { "type": "structure", "members": { - "SecretKey": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The secret key that you received from the Baidu Cloud Push service to communicate with the service.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies whether to enable the Baidu channel for the application.

    " } }, "ApiKey": { @@ -1494,10 +1493,11 @@ "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "SecretKey": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether to enable the Baidu channel for the application.

    " + "smithy.api#documentation": "

    The secret key that you received from the Baidu Cloud Push service to communicate with the service.

    ", + "smithy.api#required": {} } } }, @@ -1508,35 +1508,41 @@ "com.amazonaws.pinpoint#BaiduChannelResponse": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "Platform": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the Baidu channel is enabled for the application.

    " + "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

    ", + "smithy.api#required": {} } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The current version of the Baidu channel.

    " + "smithy.api#documentation": "

    (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

    " } }, - "Id": { + "LastModifiedBy": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    The user who last modified the Baidu channel.

    " } }, - "Platform": { + "Version": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The current version of the Baidu channel.

    " + } + }, + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for the application that the Baidu channel applies to.

    " } }, - "IsArchived": { + "HasCredential": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the Baidu channel is archived.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, "Credential": { @@ -1546,34 +1552,28 @@ "smithy.api#required": {} } }, - "CreationDate": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The date and time when the Baidu channel was enabled.

    " - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.pinpoint#__string", + "IsArchived": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The date and time when the Baidu channel was last modified.

    " + "smithy.api#documentation": "

    Specifies whether the Baidu channel is archived.

    " } }, - "HasCredential": { + "Enabled": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    Specifies whether the Baidu channel is enabled for the application.

    " } }, - "ApplicationId": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the Baidu channel applies to.

    " + "smithy.api#documentation": "

    The date and time when the Baidu channel was last modified.

    " } }, - "LastModifiedBy": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The user who last modified the Baidu channel.

    " + "smithy.api#documentation": "

    The date and time when the Baidu channel was enabled.

    " } } }, @@ -1584,22 +1584,10 @@ "com.amazonaws.pinpoint#BaiduMessage": { "type": "structure", "members": { - "RawContent": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

    " - } - }, - "IconReference": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The icon image name of the asset saved in your app.

    " - } - }, - "TimeToLive": { - "target": "com.amazonaws.pinpoint#__integer", - "traits": { - "smithy.api#documentation": "

    The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

    " + "smithy.api#documentation": "

    The body of the notification message.

    " } }, "Action": { @@ -1608,28 +1596,28 @@ "smithy.api#documentation": "

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " } }, - "Sound": { + "RawContent": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " + "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

    " } }, - "SmallImageIconUrl": { + "Sound": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the small icon image to display in the status bar and the content view of the push notification.

    " + "smithy.api#documentation": "

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " } }, - "Url": { - "target": "com.amazonaws.pinpoint#__string", + "SilentPush": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + "smithy.api#documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

    " } }, - "ImageUrl": { + "ImageIconUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of an image to display in the push notification.

    " + "smithy.api#documentation": "

    The URL of the large icon image to display in the content view of the push notification.

    " } }, "Substitutions": { @@ -1638,34 +1626,46 @@ "smithy.api#documentation": "

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

    " } }, + "ImageUrl": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The URL of an image to display in the push notification.

    " + } + }, "Data": { "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { "smithy.api#documentation": "

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    " } }, - "Title": { + "IconReference": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The title to display above the notification message on the recipient's device.

    " + "smithy.api#documentation": "

    The icon image name of the asset saved in your app.

    " } }, - "ImageIconUrl": { + "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the large icon image to display in the content view of the push notification.

    " + "smithy.api#documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + } + }, + "SmallImageIconUrl": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The URL of the small icon image to display in the status bar and the content view of the push notification.

    " } }, - "Body": { + "Title": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The body of the notification message.

    " + "smithy.api#documentation": "

    The title to display above the notification message on the recipient's device.

    " } }, - "SilentPush": { - "target": "com.amazonaws.pinpoint#__boolean", + "TimeToLive": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

    " + "smithy.api#documentation": "

    The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

    " } } }, @@ -1705,10 +1705,10 @@ "com.amazonaws.pinpoint#CampaignDateRangeKpiResponse": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "StartTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", + "smithy.api#documentation": "

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", "smithy.api#required": {} } }, @@ -1718,10 +1718,10 @@ "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

    " } }, - "StartTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", + "KpiName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", + "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

    ", "smithy.api#required": {} } }, @@ -1739,17 +1739,17 @@ "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", "smithy.api#required": {} } }, - "KpiName": { - "target": "com.amazonaws.pinpoint#__string", + "EndTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

    ", + "smithy.api#documentation": "

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", "smithy.api#required": {} } } @@ -1761,28 +1761,28 @@ "com.amazonaws.pinpoint#CampaignEmailMessage": { "type": "structure", "members": { - "FromAddress": { + "Title": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

    " + "smithy.api#documentation": "

    The subject line, or title, of the email.

    " } }, - "Body": { + "HtmlBody": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The body of the email for recipients whose email clients don't render HTML content.

    " + "smithy.api#documentation": "

    The body of the email, in HTML format, for recipients whose email clients render HTML content.

    " } }, - "HtmlBody": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The body of the email, in HTML format, for recipients whose email clients render HTML content.

    " + "smithy.api#documentation": "

    The body of the email for recipients whose email clients don't render HTML content.

    " } }, - "Title": { + "FromAddress": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The subject line, or title, of the email.

    " + "smithy.api#documentation": "

    The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

    " } } }, @@ -1815,10 +1815,10 @@ "com.amazonaws.pinpoint#CampaignHook": { "type": "structure", "members": { - "LambdaFunctionName": { + "WebUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

    " + "smithy.api#documentation": "

    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

    " } }, "Mode": { @@ -1827,10 +1827,10 @@ "smithy.api#documentation": "

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

    • FILTER - Invoke the function to customize the segment that's used by a campaign.

    • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

    " } }, - "WebUrl": { + "LambdaFunctionName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

    " + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

    " } } }, @@ -1847,10 +1847,10 @@ "smithy.api#documentation": "

    The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

    " } }, - "Total": { + "MessagesPerSecond": { "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

    " + "smithy.api#documentation": "

    The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

    " } }, "MaximumDuration": { @@ -1859,26 +1859,20 @@ "smithy.api#documentation": "

    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

    " } }, - "MessagesPerSecond": { + "Total": { "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send each second. The minimum value is 50. The maximum value is 20,000.

    " + "smithy.api#documentation": "

    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

    " } } }, "traits": { - "smithy.api#documentation": "

    For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns and journeys in the application can send.

    " + "smithy.api#documentation": "

    For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.

    " } }, "com.amazonaws.pinpoint#CampaignResponse": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.pinpoint#CampaignState", - "traits": { - "smithy.api#documentation": "

    The current status of the campaign.

    " - } - }, "Limits": { "target": "com.amazonaws.pinpoint#CampaignLimits", "traits": { @@ -1891,50 +1885,65 @@ "smithy.api#documentation": "

    The custom description of the default treatment for the campaign.

    " } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "MessageConfiguration": { + "target": "com.amazonaws.pinpoint#MessageConfiguration", "traits": { - "smithy.api#documentation": "

    The version number of the campaign.

    " + "smithy.api#documentation": "

    The message configuration settings for the campaign.

    " } }, - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "AdditionalTreatments": { + "target": "com.amazonaws.pinpoint#ListOfTreatmentResource", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the campaign applies to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

    " } }, - "SegmentId": { + "DefaultState": { + "target": "com.amazonaws.pinpoint#CampaignState", + "traits": { + "smithy.api#documentation": "

    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

    " + } + }, + "TreatmentName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the segment that's associated with the campaign.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

    " } }, - "LastModifiedDate": { + "Name": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the campaign was last modified.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the campaign.

    " } }, - "CreationDate": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the campaign was created.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that the campaign applies to.

    ", "smithy.api#required": {} } }, - "CustomDeliveryConfiguration": { - "target": "com.amazonaws.pinpoint#CustomDeliveryConfiguration", + "IsPaused": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The delivery configuration settings for sending the campaign through a custom channel.

    " + "smithy.api#documentation": "

    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

    " } }, - "TreatmentName": { + "Version": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The version number of the campaign.

    " + } + }, + "Hook": { + "target": "com.amazonaws.pinpoint#CampaignHook", + "traits": { + "smithy.api#documentation": "

    The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

    " + } + }, + "Description": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

    " + "smithy.api#documentation": "

    The custom description of the campaign.

    " } }, "Arn": { @@ -1951,6 +1960,13 @@ "smithy.api#required": {} } }, + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", + "traits": { + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" + } + }, "SegmentVersion": { "target": "com.amazonaws.pinpoint#__integer", "traits": { @@ -1958,22 +1974,10 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The custom description of the campaign.

    " - } - }, - "Schedule": { - "target": "com.amazonaws.pinpoint#Schedule", - "traits": { - "smithy.api#documentation": "

    The schedule settings for the campaign.

    " - } - }, - "Hook": { - "target": "com.amazonaws.pinpoint#CampaignHook", + "TemplateConfiguration": { + "target": "com.amazonaws.pinpoint#TemplateConfiguration", "traits": { - "smithy.api#documentation": "

    The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

    " + "smithy.api#documentation": "

    The message template that’s used for the campaign.

    " } }, "HoldoutPercent": { @@ -1982,47 +1986,43 @@ "smithy.api#documentation": "

    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

    " } }, - "AdditionalTreatments": { - "target": "com.amazonaws.pinpoint#ListOfTreatmentResource", - "traits": { - "smithy.api#documentation": "

    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

    " - } - }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "CustomDeliveryConfiguration": { + "target": "com.amazonaws.pinpoint#CustomDeliveryConfiguration", "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The delivery configuration settings for sending the campaign through a custom channel.

    " } }, - "MessageConfiguration": { - "target": "com.amazonaws.pinpoint#MessageConfiguration", + "State": { + "target": "com.amazonaws.pinpoint#CampaignState", "traits": { - "smithy.api#documentation": "

    The message configuration settings for the campaign.

    " + "smithy.api#documentation": "

    The current status of the campaign.

    " } }, - "IsPaused": { - "target": "com.amazonaws.pinpoint#__boolean", + "LastModifiedDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

    " + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the campaign was last modified.

    ", + "smithy.api#required": {} } }, - "TemplateConfiguration": { - "target": "com.amazonaws.pinpoint#TemplateConfiguration", + "CreationDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message template that’s used for the campaign.

    " + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the campaign was created.

    ", + "smithy.api#required": {} } }, - "DefaultState": { - "target": "com.amazonaws.pinpoint#CampaignState", + "SegmentId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

    " + "smithy.api#documentation": "

    The unique identifier for the segment that's associated with the campaign.

    ", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.pinpoint#__string", + "Schedule": { + "target": "com.amazonaws.pinpoint#Schedule", "traits": { - "smithy.api#documentation": "

    The name of the campaign.

    " + "smithy.api#documentation": "

    The schedule settings for the campaign.

    " } } }, @@ -2033,12 +2033,6 @@ "com.amazonaws.pinpoint#CampaignSmsMessage": { "type": "structure", "members": { - "SenderId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The sender ID to display on recipients' devices when they receive the SMS message.

    " - } - }, "MessageType": { "target": "com.amazonaws.pinpoint#MessageType", "traits": { @@ -2050,6 +2044,12 @@ "traits": { "smithy.api#documentation": "

    The body of the SMS message.

    " } + }, + "SenderId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The sender ID to display on recipients' devices when they receive the SMS message.

    " + } } }, "traits": { @@ -2097,6 +2097,10 @@ { "value": "DELETED", "name": "DELETED" + }, + { + "value": "INVALID", + "name": "INVALID" } ] } @@ -2104,18 +2108,18 @@ "com.amazonaws.pinpoint#CampaignsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, "Item": { "target": "com.amazonaws.pinpoint#ListOfCampaignResponse", "traits": { "smithy.api#documentation": "

    An array of responses, one for each campaign that's associated with the application.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " - } } }, "traits": { @@ -2125,58 +2129,58 @@ "com.amazonaws.pinpoint#ChannelResponse": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether the channel is enabled for the application.

    " - } - }, "Version": { "target": "com.amazonaws.pinpoint#__integer", "traits": { "smithy.api#documentation": "

    The current version of the channel.

    " } }, - "ApplicationId": { + "Id": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application.

    " + "smithy.api#documentation": "

    (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.

    " } }, - "LastModifiedDate": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the channel was last modified.

    " + "smithy.api#documentation": "

    Specifies whether the channel is enabled for the application.

    " } }, - "CreationDate": { + "LastModifiedBy": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the channel was enabled.

    " + "smithy.api#documentation": "

    The user who last modified the channel.

    " } }, - "IsArchived": { + "HasCredential": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the channel is archived.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, - "LastModifiedBy": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The user who last modified the channel.

    " + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the channel was last modified.

    " } }, - "HasCredential": { - "target": "com.amazonaws.pinpoint#__boolean", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    The unique identifier for the application.

    " } }, - "Id": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the channel was enabled.

    " + } + }, + "IsArchived": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the channel is archived.

    " } } }, @@ -2257,17 +2261,17 @@ "com.amazonaws.pinpoint#Condition": { "type": "structure", "members": { - "Operator": { - "target": "com.amazonaws.pinpoint#Operator", - "traits": { - "smithy.api#documentation": "

    Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

    " - } - }, "Conditions": { "target": "com.amazonaws.pinpoint#ListOfSimpleCondition", "traits": { "smithy.api#documentation": "

    The conditions to evaluate for the activity.

    " } + }, + "Operator": { + "target": "com.amazonaws.pinpoint#Operator", + "traits": { + "smithy.api#documentation": "

    Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

    " + } } }, "traits": { @@ -2277,10 +2281,10 @@ "com.amazonaws.pinpoint#ConditionalSplitActivity": { "type": "structure", "members": { - "Condition": { - "target": "com.amazonaws.pinpoint#Condition", + "EvaluationWaitTime": { + "target": "com.amazonaws.pinpoint#WaitTime", "traits": { - "smithy.api#documentation": "

    The conditions that define the paths for the activity, and the relationship between the conditions.

    " + "smithy.api#documentation": "

    The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

    " } }, "FalseActivity": { @@ -2289,10 +2293,10 @@ "smithy.api#documentation": "

    The unique identifier for the activity to perform if the conditions aren't met.

    " } }, - "EvaluationWaitTime": { - "target": "com.amazonaws.pinpoint#WaitTime", + "Condition": { + "target": "com.amazonaws.pinpoint#Condition", "traits": { - "smithy.api#documentation": "

    The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

    " + "smithy.api#documentation": "

    The conditions that define the paths for the activity, and the relationship between the conditions.

    " } }, "TrueActivity": { @@ -2303,7 +2307,29 @@ } }, "traits": { - "smithy.api#documentation": "

    Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

    " + "smithy.api#documentation": "

    Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

    To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

    " + } + }, + "com.amazonaws.pinpoint#ConflictException": { + "type": "structure", + "members": { + "RequestID": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the request or response.

    " + } + }, + "Message": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The message that's returned from the API.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about an API request or response.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 409 } }, "com.amazonaws.pinpoint#CreateApp": { @@ -2373,19 +2399,19 @@ "com.amazonaws.pinpoint#CreateApplicationRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

    ", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

    ", "smithy.api#jsonName": "tags" } + }, + "Name": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -2435,18 +2461,18 @@ "com.amazonaws.pinpoint#CreateCampaignRequest": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "WriteCampaignRequest": { + "target": "com.amazonaws.pinpoint#WriteCampaignRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "WriteCampaignRequest": { - "target": "com.amazonaws.pinpoint#WriteCampaignRequest", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -2501,18 +2527,18 @@ "com.amazonaws.pinpoint#CreateEmailTemplateRequest": { "type": "structure", "members": { - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", + "EmailTemplateRequest": { + "target": "com.amazonaws.pinpoint#EmailTemplateRequest", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "EmailTemplateRequest": { - "target": "com.amazonaws.pinpoint#EmailTemplateRequest", + "TemplateName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -2783,13 +2809,6 @@ "com.amazonaws.pinpoint#CreatePushTemplateRequest": { "type": "structure", "members": { - "PushNotificationTemplateRequest": { - "target": "com.amazonaws.pinpoint#PushNotificationTemplateRequest", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -2797,6 +2816,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "PushNotificationTemplateRequest": { + "target": "com.amazonaws.pinpoint#PushNotificationTemplateRequest", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -2879,11 +2905,10 @@ "com.amazonaws.pinpoint#CreateRecommenderConfigurationShape": { "type": "structure", "members": { - "RecommendationProviderUri": { + "RecommendationsDisplayName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

    " } }, "RecommendationProviderRoleArn": { @@ -2893,22 +2918,22 @@ "smithy.api#required": {} } }, - "RecommendationProviderIdType": { + "Description": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

    • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

    • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

    " + "smithy.api#documentation": "

    A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

    " } }, - "RecommendationsPerMessage": { - "target": "com.amazonaws.pinpoint#__integer", + "RecommendationProviderIdType": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

    To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " + "smithy.api#documentation": "

    The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

    • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

    • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

    " } }, - "RecommendationsDisplayName": { + "Name": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

    " + "smithy.api#documentation": "

    A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    " } }, "RecommendationTransformerUri": { @@ -2923,16 +2948,17 @@ "smithy.api#documentation": "

    A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

    • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.

    • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

    " } }, - "Name": { - "target": "com.amazonaws.pinpoint#__string", + "RecommendationsPerMessage": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    " + "smithy.api#documentation": "

    The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

    To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " } }, - "Description": { + "RecommendationProviderUri": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

    ", + "smithy.api#required": {} } } }, @@ -2983,18 +3009,18 @@ "com.amazonaws.pinpoint#CreateSegmentRequest": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "WriteSegmentRequest": { + "target": "com.amazonaws.pinpoint#WriteSegmentRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "WriteSegmentRequest": { - "target": "com.amazonaws.pinpoint#WriteSegmentRequest", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -3049,18 +3075,18 @@ "com.amazonaws.pinpoint#CreateSmsTemplateRequest": { "type": "structure", "members": { - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", + "SMSTemplateRequest": { + "target": "com.amazonaws.pinpoint#SMSTemplateRequest", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "SMSTemplateRequest": { - "target": "com.amazonaws.pinpoint#SMSTemplateRequest", + "TemplateName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -3081,10 +3107,10 @@ "com.amazonaws.pinpoint#CreateTemplateMessageBody": { "type": "structure", "members": { - "RequestID": { + "Arn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the request to create the message template.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template that was created.

    " } }, "Message": { @@ -3093,10 +3119,10 @@ "smithy.api#documentation": "

    The message that's returned from the API for the request to create the message template.

    " } }, - "Arn": { + "RequestID": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template that was created.

    " + "smithy.api#documentation": "

    The unique identifier for the request to create the message template.

    " } } }, @@ -3173,18 +3199,18 @@ "com.amazonaws.pinpoint#CustomDeliveryConfiguration": { "type": "structure", "members": { + "EndpointTypes": { + "target": "com.amazonaws.pinpoint#ListOf__EndpointTypesElement", + "traits": { + "smithy.api#documentation": "

    The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

    " + } + }, "DeliveryUri": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The destination to send the campaign or treatment to. This value can be one of the following:

    • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

    • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

    ", "smithy.api#required": {} } - }, - "EndpointTypes": { - "target": "com.amazonaws.pinpoint#ListOf__EndpointTypesElement", - "traits": { - "smithy.api#documentation": "

    The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

    " - } } }, "traits": { @@ -3194,16 +3220,10 @@ "com.amazonaws.pinpoint#CustomMessageActivity": { "type": "structure", "members": { - "EndpointTypes": { - "target": "com.amazonaws.pinpoint#ListOf__EndpointTypesElement", - "traits": { - "smithy.api#documentation": "

    The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

    " - } - }, - "TemplateVersion": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " + "smithy.api#documentation": "

    The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

    " } }, "NextActivity": { @@ -3212,16 +3232,22 @@ "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

    " } }, - "DeliveryUri": { + "TemplateVersion": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The destination to send the custom message to. This value can be one of the following:

    • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the custom message.

    • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

    " + "smithy.api#documentation": "

    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " } }, - "TemplateName": { + "EndpointTypes": { + "target": "com.amazonaws.pinpoint#ListOf__EndpointTypesElement", + "traits": { + "smithy.api#documentation": "

    The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

    " + } + }, + "DeliveryUri": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

    " + "smithy.api#documentation": "

    The destination to send the campaign or treatment to. This value can be one of the following:

    • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

    • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

    " } }, "MessageConfig": { @@ -3238,17 +3264,17 @@ "com.amazonaws.pinpoint#DefaultMessage": { "type": "structure", "members": { - "Substitutions": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", - "traits": { - "smithy.api#documentation": "

    The default message variables to use in the message. You can override these default variables with individual address variables.

    " - } - }, "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The default body of the message.

    " } + }, + "Substitutions": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "traits": { + "smithy.api#documentation": "

    The default message variables to use in the message. You can override these default variables with individual address variables.

    " + } } }, "traits": { @@ -3258,16 +3284,10 @@ "com.amazonaws.pinpoint#DefaultPushNotificationMessage": { "type": "structure", "members": { - "SilentPush": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

    " - } - }, - "Url": { - "target": "com.amazonaws.pinpoint#__string", + "Action": { + "target": "com.amazonaws.pinpoint#Action", "traits": { - "smithy.api#documentation": "

    The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + "smithy.api#documentation": "

    The default action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " } }, "Body": { @@ -3282,10 +3302,10 @@ "smithy.api#documentation": "

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

    " } }, - "Action": { - "target": "com.amazonaws.pinpoint#Action", + "Title": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The default action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + "smithy.api#documentation": "

    The default title to display above the notification message on a recipient's device.

    " } }, "Data": { @@ -3294,10 +3314,16 @@ "smithy.api#documentation": "

    The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    " } }, - "Title": { + "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The default title to display above the notification message on a recipient's device.

    " + "smithy.api#documentation": "

    The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + } + }, + "SilentPush": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

    " } } }, @@ -3308,16 +3334,22 @@ "com.amazonaws.pinpoint#DefaultPushNotificationTemplate": { "type": "structure", "members": { - "Url": { + "Action": { + "target": "com.amazonaws.pinpoint#Action", + "traits": { + "smithy.api#documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + } + }, + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    " + "smithy.api#documentation": "

    The message body to use in push notifications that are based on the message template.

    " } }, - "Sound": { + "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

    " + "smithy.api#documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    " } }, "Title": { @@ -3326,16 +3358,10 @@ "smithy.api#documentation": "

    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

    " } }, - "Body": { + "Sound": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message body to use in push notifications that are based on the message template.

    " - } - }, - "Action": { - "target": "com.amazonaws.pinpoint#Action", - "traits": { - "smithy.api#documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + "smithy.api#documentation": "

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

    " } } }, @@ -3979,19 +4005,19 @@ "com.amazonaws.pinpoint#DeleteEmailTemplateRequest": { "type": "structure", "members": { - "TemplateName": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" } }, - "Version": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -4051,18 +4077,18 @@ "com.amazonaws.pinpoint#DeleteEndpointRequest": { "type": "structure", "members": { - "ApplicationId": { + "EndpointId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the endpoint.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "EndpointId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the endpoint.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4327,19 +4353,19 @@ "com.amazonaws.pinpoint#DeletePushTemplateRequest": { "type": "structure", "members": { - "TemplateName": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" } }, - "Version": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -4464,18 +4490,18 @@ "com.amazonaws.pinpoint#DeleteSegmentRequest": { "type": "structure", "members": { - "ApplicationId": { + "SegmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the segment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "SegmentId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the segment.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4894,28 +4920,16 @@ "com.amazonaws.pinpoint#DirectMessageConfiguration": { "type": "structure", "members": { - "VoiceMessage": { - "target": "com.amazonaws.pinpoint#VoiceMessage", - "traits": { - "smithy.api#documentation": "

    The default message for the voice channel. This message overrides the default message (DefaultMessage).

    " - } - }, "BaiduMessage": { "target": "com.amazonaws.pinpoint#BaiduMessage", "traits": { "smithy.api#documentation": "

    The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

    " } }, - "EmailMessage": { - "target": "com.amazonaws.pinpoint#EmailMessage", - "traits": { - "smithy.api#documentation": "

    The default message for the email channel. This message overrides the default message (DefaultMessage).

    " - } - }, - "DefaultPushNotificationMessage": { - "target": "com.amazonaws.pinpoint#DefaultPushNotificationMessage", + "DefaultMessage": { + "target": "com.amazonaws.pinpoint#DefaultMessage", "traits": { - "smithy.api#documentation": "

    The default push notification message for all push notification channels.

    " + "smithy.api#documentation": "

    The default message for all channels.

    " } }, "APNSMessage": { @@ -4924,16 +4938,16 @@ "smithy.api#documentation": "

    The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

    " } }, - "SMSMessage": { - "target": "com.amazonaws.pinpoint#SMSMessage", + "EmailMessage": { + "target": "com.amazonaws.pinpoint#EmailMessage", "traits": { - "smithy.api#documentation": "

    The default message for the SMS channel. This message overrides the default message (DefaultMessage).

    " + "smithy.api#documentation": "

    The default message for the email channel. This message overrides the default message (DefaultMessage).

    " } }, - "DefaultMessage": { - "target": "com.amazonaws.pinpoint#DefaultMessage", + "VoiceMessage": { + "target": "com.amazonaws.pinpoint#VoiceMessage", "traits": { - "smithy.api#documentation": "

    The default message for all channels.

    " + "smithy.api#documentation": "

    The default message for the voice channel. This message overrides the default message (DefaultMessage).

    " } }, "GCMMessage": { @@ -4947,6 +4961,18 @@ "traits": { "smithy.api#documentation": "

    The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

    " } + }, + "SMSMessage": { + "target": "com.amazonaws.pinpoint#SMSMessage", + "traits": { + "smithy.api#documentation": "

    The default message for the SMS channel. This message overrides the default message (DefaultMessage).

    " + } + }, + "DefaultPushNotificationMessage": { + "target": "com.amazonaws.pinpoint#DefaultPushNotificationMessage", + "traits": { + "smithy.api#documentation": "

    The default push notification message for all push notification channels.

    " + } } }, "traits": { @@ -4979,36 +5005,36 @@ "com.amazonaws.pinpoint#EmailChannelRequest": { "type": "structure", "members": { - "RoleArn": { - "target": "com.amazonaws.pinpoint#__string", + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

    " + "smithy.api#documentation": "

    Specifies whether to enable the email channel for the application.

    " } }, - "Identity": { + "ConfigurationSet": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon SES configuration set that you want to apply to messages that you send through the channel.

    " } }, - "ConfigurationSet": { + "FromAddress": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon SES configuration set that you want to apply to messages that you send through the channel.

    " + "smithy.api#documentation": "

    The verified email address that you want to send email from when you send email through the channel.

    ", + "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", + "Identity": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether to enable the email channel for the application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

    ", + "smithy.api#required": {} } }, - "FromAddress": { + "RoleArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The verified email address that you want to send email from when you send email through the channel.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

    " } } }, @@ -5019,10 +5045,10 @@ "com.amazonaws.pinpoint#EmailChannelResponse": { "type": "structure", "members": { - "LastModifiedBy": { - "target": "com.amazonaws.pinpoint#__string", + "Version": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The user who last modified the email channel.

    " + "smithy.api#documentation": "

    The current version of the email channel.

    " } }, "CreationDate": { @@ -5031,22 +5057,22 @@ "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the email channel was enabled.

    " } }, - "LastModifiedDate": { + "FromAddress": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the email channel was last modified.

    " + "smithy.api#documentation": "

    The verified email address that email is sent from when you send email through the channel.

    " } }, - "RoleArn": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

    " + "smithy.api#documentation": "

    The unique identifier for the application that the email channel applies to.

    " } }, - "MessagesPerSecond": { - "target": "com.amazonaws.pinpoint#__integer", + "LastModifiedDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of emails that can be sent through the channel each second.

    " + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the email channel was last modified.

    " } }, "Enabled": { @@ -5055,12 +5081,6 @@ "smithy.api#documentation": "

    Specifies whether the email channel is enabled for the application.

    " } }, - "Id": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

    " - } - }, "Platform": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -5068,22 +5088,28 @@ "smithy.api#required": {} } }, - "HasCredential": { - "target": "com.amazonaws.pinpoint#__boolean", + "Identity": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

    " } }, - "ConfigurationSet": { + "Id": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon SES configuration set that's applied to messages that are sent through the channel.

    " + "smithy.api#documentation": "

    (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

    " } }, - "Identity": { + "MessagesPerSecond": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The maximum number of emails that can be sent through the channel each second.

    " + } + }, + "ConfigurationSet": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

    " + "smithy.api#documentation": "

    The Amazon SES configuration set that's applied to messages that are sent through the channel.

    " } }, "IsArchived": { @@ -5092,22 +5118,22 @@ "smithy.api#documentation": "

    Specifies whether the email channel is archived.

    " } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "RoleArn": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The current version of the email channel.

    " + "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

    " } }, - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "HasCredential": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the email channel applies to.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, - "FromAddress": { + "LastModifiedBy": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The verified email address that email is sent from when you send email through the channel.

    " + "smithy.api#documentation": "

    The user who last modified the email channel.

    " } } }, @@ -5118,22 +5144,22 @@ "com.amazonaws.pinpoint#EmailMessage": { "type": "structure", "members": { - "Substitutions": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "RawEmail": { + "target": "com.amazonaws.pinpoint#RawEmail", "traits": { - "smithy.api#documentation": "

    The default message variables to use in the email message. You can override the default variables with individual address variables.

    " + "smithy.api#documentation": "

    The email message, represented as a raw MIME message.

    " } }, - "FeedbackForwardingAddress": { - "target": "com.amazonaws.pinpoint#__string", + "Substitutions": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

    The email address to forward bounces and complaints to, if feedback forwarding is enabled.

    " + "smithy.api#documentation": "

    The default message variables to use in the email message. You can override the default variables with individual address variables.

    " } }, - "FromAddress": { - "target": "com.amazonaws.pinpoint#__string", + "SimpleEmail": { + "target": "com.amazonaws.pinpoint#SimpleEmail", "traits": { - "smithy.api#documentation": "

    The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

    " + "smithy.api#documentation": "

    The email message, composed of a subject, a text part, and an HTML part.

    " } }, "ReplyToAddresses": { @@ -5148,16 +5174,16 @@ "smithy.api#documentation": "

    The body of the email message.

    " } }, - "SimpleEmail": { - "target": "com.amazonaws.pinpoint#SimpleEmail", + "FromAddress": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The email message, composed of a subject, a text part, and an HTML part.

    " + "smithy.api#documentation": "

    The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

    " } }, - "RawEmail": { - "target": "com.amazonaws.pinpoint#RawEmail", + "FeedbackForwardingAddress": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The email message, represented as a raw MIME message.

    " + "smithy.api#documentation": "

    The email address to forward bounces and complaints to, if feedback forwarding is enabled.

    " } } }, @@ -5168,22 +5194,16 @@ "com.amazonaws.pinpoint#EmailMessageActivity": { "type": "structure", "members": { - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

    " - } - }, "MessageConfig": { "target": "com.amazonaws.pinpoint#JourneyEmailMessage", "traits": { "smithy.api#documentation": "

    Specifies the sender address for an email message that's sent to participants in the journey.

    " } }, - "TemplateVersion": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " + "smithy.api#documentation": "

    The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

    " } }, "NextActivity": { @@ -5191,6 +5211,12 @@ "traits": { "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after the message is sent.

    " } + }, + "TemplateVersion": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " + } } }, "traits": { @@ -5206,10 +5232,23 @@ "smithy.api#documentation": "

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

    " } }, - "TextPart": { + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", + "traits": { + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" + } + }, + "Subject": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

    " + "smithy.api#documentation": "

    The subject line, or title, to use in email messages that are based on the message template.

    " + } + }, + "HtmlPart": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

    " } }, "DefaultSubstitutions": { @@ -5218,29 +5257,16 @@ "smithy.api#documentation": "

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    " } }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", - "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" - } - }, "TemplateDescription": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    A custom description of the message template.

    " } }, - "Subject": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The subject line, or title, to use in email messages that are based on the message template.

    " - } - }, - "HtmlPart": { + "TextPart": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

    " + "smithy.api#documentation": "

    The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

    " } } }, @@ -5251,16 +5277,29 @@ "com.amazonaws.pinpoint#EmailTemplateResponse": { "type": "structure", "members": { + "HtmlPart": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The message body, in HTML format, that's used in email messages that are based on the message template.

    " + } + }, "Arn": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " } }, - "HtmlPart": { + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", + "traits": { + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" + } + }, + "DefaultSubstitutions": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message body, in HTML format, that's used in email messages that are based on the message template.

    " + "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " } }, "TemplateDescription": { @@ -5269,18 +5308,16 @@ "smithy.api#documentation": "

    The custom description of the message template.

    " } }, - "CreationDate": { + "Subject": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The subject line, or title, that's used in email messages that are based on the message template.

    " } }, - "LastModifiedDate": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was last modified.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " } }, "TextPart": { @@ -5289,10 +5326,11 @@ "smithy.api#documentation": "

    The message body, in plain text format, that's used in email messages that are based on the message template.

    " } }, - "DefaultSubstitutions": { - "target": "com.amazonaws.pinpoint#__string", + "TemplateType": { + "target": "com.amazonaws.pinpoint#TemplateType", "traits": { - "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " + "smithy.api#documentation": "

    The type of channel that the message template is designed for. For an email template, this value is EMAIL.

    ", + "smithy.api#required": {} } }, "TemplateName": { @@ -5302,36 +5340,24 @@ "smithy.api#required": {} } }, - "RecommenderId": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the recommender model that's used by the message template.

    " + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was created.

    ", + "smithy.api#required": {} } }, - "Version": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " - } - }, - "TemplateType": { - "target": "com.amazonaws.pinpoint#TemplateType", - "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. For an email template, this value is EMAIL.

    ", + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was last modified.

    ", "smithy.api#required": {} } }, - "Subject": { + "RecommenderId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The subject line, or title, that's used in email messages that are based on the message template.

    " - } - }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", - "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The unique identifier for the recommender model that's used by the message template.

    " } } }, @@ -5342,10 +5368,10 @@ "com.amazonaws.pinpoint#EndpointBatchItem": { "type": "structure", "members": { - "OptOut": { + "EndpointStatus": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + "smithy.api#documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " } }, "ChannelType": { @@ -5354,28 +5380,34 @@ "smithy.api#documentation": "

    The channel to use when sending messages or push notifications to the endpoint.

    " } }, - "RequestId": { - "target": "com.amazonaws.pinpoint#__string", + "Metrics": { + "target": "com.amazonaws.pinpoint#MapOf__double", "traits": { - "smithy.api#documentation": "

    The unique identifier for the request to create or update the endpoint.

    " + "smithy.api#documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " } }, - "Id": { + "User": { + "target": "com.amazonaws.pinpoint#EndpointUser", + "traits": { + "smithy.api#documentation": "

    One or more custom attributes that describe the user who's associated with the endpoint.

    " + } + }, + "EffectiveDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the endpoint in the context of the batch.

    " + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint was created or updated.

    " } }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "Location": { + "target": "com.amazonaws.pinpoint#EndpointLocation", "traits": { - "smithy.api#documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

    " + "smithy.api#documentation": "

    The geographic information for the endpoint.

    " } }, - "Demographic": { - "target": "com.amazonaws.pinpoint#EndpointDemographic", + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " + "smithy.api#documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

    " } }, "Address": { @@ -5384,34 +5416,28 @@ "smithy.api#documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

    " } }, - "Metrics": { - "target": "com.amazonaws.pinpoint#MapOf__double", - "traits": { - "smithy.api#documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " - } - }, - "User": { - "target": "com.amazonaws.pinpoint#EndpointUser", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    One or more custom attributes that describe the user who's associated with the endpoint.

    " + "smithy.api#documentation": "

    The unique identifier for the endpoint in the context of the batch.

    " } }, - "EndpointStatus": { + "OptOut": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " + "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " } }, - "EffectiveDate": { - "target": "com.amazonaws.pinpoint#__string", + "Demographic": { + "target": "com.amazonaws.pinpoint#EndpointDemographic", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint was created or updated.

    " + "smithy.api#documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " } }, - "Location": { - "target": "com.amazonaws.pinpoint#EndpointLocation", + "RequestId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The geographic information for the endpoint.

    " + "smithy.api#documentation": "

    The unique identifier for the request to create or update the endpoint.

    " } } }, @@ -5437,52 +5463,52 @@ "com.amazonaws.pinpoint#EndpointDemographic": { "type": "structure", "members": { - "AppVersion": { + "Platform": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The version of the app that's associated with the endpoint.

    " + "smithy.api#documentation": "

    The platform of the endpoint device, such as ios.

    " } }, - "Make": { + "Model": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The manufacturer of the endpoint device, such as apple or samsung.

    " + "smithy.api#documentation": "

    The model name or number of the endpoint device, such as iPhone or SM-G900F.

    " } }, - "ModelVersion": { + "PlatformVersion": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The model version of the endpoint device.

    " + "smithy.api#documentation": "

    The platform version of the endpoint device.

    " } }, - "Timezone": { + "AppVersion": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

    " + "smithy.api#documentation": "

    The version of the app that's associated with the endpoint.

    " } }, - "Platform": { + "Timezone": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The platform of the endpoint device, such as ios.

    " + "smithy.api#documentation": "

    The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

    " } }, - "Model": { + "Locale": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The model name or number of the endpoint device, such as iPhone or SM-G900F.

    " + "smithy.api#documentation": "

    The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

    " } }, - "PlatformVersion": { + "ModelVersion": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The platform version of the endpoint device.

    " + "smithy.api#documentation": "

    The model version of the endpoint device.

    " } }, - "Locale": { + "Make": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

    " + "smithy.api#documentation": "

    The manufacturer of the endpoint device, such as apple or samsung.

    " } } }, @@ -5493,17 +5519,17 @@ "com.amazonaws.pinpoint#EndpointItemResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The custom message that's returned in the response as a result of processing the endpoint data.

    " - } - }, "StatusCode": { "target": "com.amazonaws.pinpoint#__integer", "traits": { "smithy.api#documentation": "

    The status code that's returned in the response as a result of processing the endpoint data.

    " } + }, + "Message": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The custom message that's returned in the response as a result of processing the endpoint data.

    " + } } }, "traits": { @@ -5513,12 +5539,6 @@ "com.amazonaws.pinpoint#EndpointLocation": { "type": "structure", "members": { - "Longitude": { - "target": "com.amazonaws.pinpoint#__double", - "traits": { - "smithy.api#documentation": "

    The longitude coordinate of the endpoint location, rounded to one decimal place.

    " - } - }, "Country": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -5531,10 +5551,10 @@ "smithy.api#documentation": "

    The postal or ZIP code for the area where the endpoint is located.

    " } }, - "Region": { + "City": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

    " + "smithy.api#documentation": "

    The name of the city where the endpoint is located.

    " } }, "Latitude": { @@ -5543,10 +5563,16 @@ "smithy.api#documentation": "

    The latitude coordinate of the endpoint location, rounded to one decimal place.

    " } }, - "City": { + "Region": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the city where the endpoint is located.

    " + "smithy.api#documentation": "

    The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

    " + } + }, + "Longitude": { + "target": "com.amazonaws.pinpoint#__double", + "traits": { + "smithy.api#documentation": "

    The longitude coordinate of the endpoint location, rounded to one decimal place.

    " } } }, @@ -5557,24 +5583,22 @@ "com.amazonaws.pinpoint#EndpointMessageResult": { "type": "structure", "members": { - "StatusCode": { - "target": "com.amazonaws.pinpoint#__integer", + "Address": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The downstream service status code for delivering the message.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The endpoint address that the message was delivered to.

    " } }, - "DeliveryStatus": { - "target": "com.amazonaws.pinpoint#DeliveryStatus", + "UpdatedToken": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.

    • SUCCESSFUL - The message was successfully delivered to the endpoint.

    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.

    • TIMEOUT - The message couldn't be sent within the timeout period.

    • UNKNOWN_FAILURE - An unknown error occurred.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

    " } }, - "Address": { + "MessageId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The endpoint address that the message was delivered to.

    " + "smithy.api#documentation": "

    The unique identifier for the message that was sent.

    " } }, "StatusMessage": { @@ -5583,16 +5607,18 @@ "smithy.api#documentation": "

    The status message for delivering the message.

    " } }, - "MessageId": { - "target": "com.amazonaws.pinpoint#__string", + "StatusCode": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The unique identifier for the message that was sent.

    " + "smithy.api#documentation": "

    The downstream service status code for delivering the message.

    ", + "smithy.api#required": {} } }, - "UpdatedToken": { - "target": "com.amazonaws.pinpoint#__string", + "DeliveryStatus": { + "target": "com.amazonaws.pinpoint#DeliveryStatus", "traits": { - "smithy.api#documentation": "

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

    " + "smithy.api#documentation": "

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.

    • SUCCESSFUL - The message was successfully delivered to the endpoint.

    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.

    • TIMEOUT - The message couldn't be sent within the timeout period.

    • UNKNOWN_FAILURE - An unknown error occurred.

    ", + "smithy.api#required": {} } } }, @@ -5603,34 +5629,40 @@ "com.amazonaws.pinpoint#EndpointRequest": { "type": "structure", "members": { - "Address": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

    " - } - }, "Attributes": { "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { "smithy.api#documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

    " } }, - "Demographic": { - "target": "com.amazonaws.pinpoint#EndpointDemographic", + "User": { + "target": "com.amazonaws.pinpoint#EndpointUser", + "traits": { + "smithy.api#documentation": "

    One or more custom attributes that describe the user who's associated with the endpoint.

    " + } + }, + "Address": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

    " + } + }, + "Metrics": { + "target": "com.amazonaws.pinpoint#MapOf__double", "traits": { - "smithy.api#documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " + "smithy.api#documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " } }, - "OptOut": { + "EndpointStatus": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + "smithy.api#documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " } }, - "ChannelType": { - "target": "com.amazonaws.pinpoint#ChannelType", + "Demographic": { + "target": "com.amazonaws.pinpoint#EndpointDemographic", "traits": { - "smithy.api#documentation": "

    The channel to use when sending messages or push notifications to the endpoint.

    " + "smithy.api#documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " } }, "RequestId": { @@ -5645,28 +5677,22 @@ "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint is updated.

    " } }, - "EndpointStatus": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " - } - }, "Location": { "target": "com.amazonaws.pinpoint#EndpointLocation", "traits": { "smithy.api#documentation": "

    The geographic information for the endpoint.

    " } }, - "Metrics": { - "target": "com.amazonaws.pinpoint#MapOf__double", + "OptOut": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " + "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " } }, - "User": { - "target": "com.amazonaws.pinpoint#EndpointUser", + "ChannelType": { + "target": "com.amazonaws.pinpoint#ChannelType", "traits": { - "smithy.api#documentation": "

    One or more custom attributes that describe the user who's associated with the endpoint.

    " + "smithy.api#documentation": "

    The channel to use when sending messages or push notifications to the endpoint.

    " } } }, @@ -5677,22 +5703,22 @@ "com.amazonaws.pinpoint#EndpointResponse": { "type": "structure", "members": { - "User": { - "target": "com.amazonaws.pinpoint#EndpointUser", + "Address": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

    " + "smithy.api#documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

    " } }, - "CreationDate": { + "CohortId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint was created.

    " + "smithy.api#documentation": "

    A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

    " } }, - "Address": { - "target": "com.amazonaws.pinpoint#__string", + "User": { + "target": "com.amazonaws.pinpoint#EndpointUser", "traits": { - "smithy.api#documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

    " + "smithy.api#documentation": "

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

    " } }, "EffectiveDate": { @@ -5701,34 +5727,28 @@ "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint was last updated.

    " } }, - "Id": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

    " - } - }, "Location": { "target": "com.amazonaws.pinpoint#EndpointLocation", "traits": { "smithy.api#documentation": "

    The geographic information for the endpoint.

    " } }, - "RequestId": { + "OptOut": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the most recent request to update the endpoint.

    " + "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " } }, - "EndpointStatus": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " + "smithy.api#documentation": "

    The unique identifier for the application that's associated with the endpoint.

    " } }, - "CohortId": { + "EndpointStatus": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

    " + "smithy.api#documentation": "

    Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " } }, "ChannelType": { @@ -5737,10 +5757,16 @@ "smithy.api#documentation": "

    The channel that's used when sending messages or push notifications to the endpoint.

    " } }, - "ApplicationId": { + "RequestId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that's associated with the endpoint.

    " + "smithy.api#documentation": "

    The unique identifier for the most recent request to update the endpoint.

    " + } + }, + "Id": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

    " } }, "Demographic": { @@ -5749,10 +5775,10 @@ "smithy.api#documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " } }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "CreationDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments.

    " + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint was created.

    " } }, "Metrics": { @@ -5761,10 +5787,10 @@ "smithy.api#documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " } }, - "OptOut": { - "target": "com.amazonaws.pinpoint#__string", + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + "smithy.api#documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments.

    " } } }, @@ -5781,10 +5807,10 @@ "smithy.api#documentation": "

    A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

    " } }, - "TitleOverride": { + "RawContent": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The title or subject line of the message. If specified, this value overrides the default message title or subject line.

    " + "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

    " } }, "Context": { @@ -5799,10 +5825,10 @@ "smithy.api#documentation": "

    The body of the message. If specified, this value overrides the default message body.

    " } }, - "RawContent": { + "TitleOverride": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

    " + "smithy.api#documentation": "

    The title or subject line of the message. If specified, this value overrides the default message title or subject line.

    " } } }, @@ -5813,17 +5839,17 @@ "com.amazonaws.pinpoint#EndpointUser": { "type": "structure", "members": { - "UserAttributes": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", - "traits": { - "smithy.api#documentation": "

    One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

    " - } - }, "UserId": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The unique identifier for the user.

    " } + }, + "UserAttributes": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "traits": { + "smithy.api#documentation": "

    One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

    " + } } }, "traits": { @@ -5848,16 +5874,16 @@ "com.amazonaws.pinpoint#Event": { "type": "structure", "members": { - "Session": { - "target": "com.amazonaws.pinpoint#Session", + "AppTitle": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Information about the session in which the event occurred.

    " + "smithy.api#documentation": "

    The title of the app that's recording the event.

    " } }, - "AppTitle": { + "AppPackageName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The title of the app that's recording the event.

    " + "smithy.api#documentation": "

    The package name of the app that's recording the event.

    " } }, "Metrics": { @@ -5866,47 +5892,47 @@ "smithy.api#documentation": "

    One or more custom metrics that are associated with the event.

    " } }, - "AppPackageName": { + "EventType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The package name of the app that's recording the event.

    " + "smithy.api#documentation": "

    The name of the event.

    ", + "smithy.api#required": {} } }, - "Timestamp": { + "SdkName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the event occurred.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the SDK that's being used to record the event.

    " } }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "Session": { + "target": "com.amazonaws.pinpoint#Session", "traits": { - "smithy.api#documentation": "

    One or more custom attributes that are associated with the event.

    " + "smithy.api#documentation": "

    Information about the session in which the event occurred.

    " } }, - "AppVersionCode": { + "ClientSdkVersion": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The version number of the app that's recording the event.

    " + "smithy.api#documentation": "

    The version of the SDK that's running on the client device.

    " } }, - "ClientSdkVersion": { - "target": "com.amazonaws.pinpoint#__string", + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The version of the SDK that's running on the client device.

    " + "smithy.api#documentation": "

    One or more custom attributes that are associated with the event.

    " } }, - "SdkName": { + "AppVersionCode": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the SDK that's being used to record the event.

    " + "smithy.api#documentation": "

    The version number of the app that's recording the event.

    " } }, - "EventType": { + "Timestamp": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the event.

    ", + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the event occurred.

    ", "smithy.api#required": {} } } @@ -5938,6 +5964,12 @@ "com.amazonaws.pinpoint#EventDimensions": { "type": "structure", "members": { + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOfAttributeDimension", + "traits": { + "smithy.api#documentation": "

    One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

    " + } + }, "EventType": { "target": "com.amazonaws.pinpoint#SetDimension", "traits": { @@ -5949,16 +5981,32 @@ "traits": { "smithy.api#documentation": "

    One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

    " } + } + }, + "traits": { + "smithy.api#documentation": "

    Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

    " + } + }, + "com.amazonaws.pinpoint#EventFilter": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.pinpoint#EventDimensions", + "traits": { + "smithy.api#documentation": "

    The dimensions for the event filter to use for the campaign or the journey activity.

    ", + "smithy.api#required": {} + } }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOfAttributeDimension", + "FilterType": { + "target": "com.amazonaws.pinpoint#FilterType", "traits": { - "smithy.api#documentation": "

    One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

    " + "smithy.api#documentation": "

    The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

    ", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

    " + "smithy.api#documentation": "

    Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

    " } }, "com.amazonaws.pinpoint#EventItemResponse": { @@ -5981,46 +6029,60 @@ "smithy.api#documentation": "

    Provides the status code and message that result from processing an event.

    " } }, + "com.amazonaws.pinpoint#EventStartCondition": { + "type": "structure", + "members": { + "EventFilter": { + "target": "com.amazonaws.pinpoint#EventFilter" + }, + "SegmentId": { + "target": "com.amazonaws.pinpoint#__string" + } + }, + "traits": { + "smithy.api#documentation": "

    Specifies the settings for an event that causes a journey activity to start.

    " + } + }, "com.amazonaws.pinpoint#EventStream": { "type": "structure", "members": { - "LastModifiedDate": { + "RoleArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the event stream was last modified.

    " + "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

    ", + "smithy.api#required": {} } }, - "ExternalId": { + "DestinationStreamArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

    For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name\n

    For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name\n

    ", + "smithy.api#required": {} } }, - "LastUpdatedBy": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The IAM user who last modified the event stream.

    " + "smithy.api#documentation": "

    The unique identifier for the application to publish event data for.

    ", + "smithy.api#required": {} } }, - "ApplicationId": { + "ExternalId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application to publish event data for.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " } }, - "RoleArn": { + "LastUpdatedBy": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The IAM user who last modified the event stream.

    " } }, - "DestinationStreamArn": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

    For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name\n

    For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the event stream was last modified.

    " } } }, @@ -6031,17 +6093,17 @@ "com.amazonaws.pinpoint#EventsBatch": { "type": "structure", "members": { - "Events": { - "target": "com.amazonaws.pinpoint#MapOfEvent", + "Endpoint": { + "target": "com.amazonaws.pinpoint#PublicEndpoint", "traits": { - "smithy.api#documentation": "

    A set of properties that are associated with the event.

    ", + "smithy.api#documentation": "

    A set of properties and attributes that are associated with the endpoint.

    ", "smithy.api#required": {} } }, - "Endpoint": { - "target": "com.amazonaws.pinpoint#PublicEndpoint", + "Events": { + "target": "com.amazonaws.pinpoint#MapOfEvent", "traits": { - "smithy.api#documentation": "

    A set of properties and attributes that are associated with the endpoint.

    ", + "smithy.api#documentation": "

    A set of properties that are associated with the event.

    ", "smithy.api#required": {} } } @@ -6082,30 +6144,30 @@ "com.amazonaws.pinpoint#ExportJobRequest": { "type": "structure", "members": { - "S3UrlPrefix": { - "target": "com.amazonaws.pinpoint#__string", + "SegmentVersion": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The version of the segment to export endpoint definitions from, if specified.

    " } }, - "RoleArn": { + "SegmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

    " } }, - "SegmentVersion": { - "target": "com.amazonaws.pinpoint#__integer", + "S3UrlPrefix": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The version of the segment to export endpoint definitions from, if specified.

    " + "smithy.api#documentation": "

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

    ", + "smithy.api#required": {} } }, - "SegmentId": { + "RoleArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

    ", + "smithy.api#required": {} } } }, @@ -6116,30 +6178,30 @@ "com.amazonaws.pinpoint#ExportJobResource": { "type": "structure", "members": { - "SegmentVersion": { - "target": "com.amazonaws.pinpoint#__integer", + "RoleArn": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The version of the segment that the endpoint definitions were exported from.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

    ", + "smithy.api#required": {} } }, - "SegmentId": { - "target": "com.amazonaws.pinpoint#__string", + "SegmentVersion": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

    " + "smithy.api#documentation": "

    The version of the segment that the endpoint definitions were exported from.

    " } }, - "RoleArn": { + "S3UrlPrefix": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

    ", + "smithy.api#documentation": "

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

    ", "smithy.api#required": {} } }, - "S3UrlPrefix": { + "SegmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

    " } } }, @@ -6150,23 +6212,24 @@ "com.amazonaws.pinpoint#ExportJobResponse": { "type": "structure", "members": { - "Definition": { - "target": "com.amazonaws.pinpoint#ExportJobResource", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The resource settings that apply to the export job.

    ", + "smithy.api#documentation": "

    The unique identifier for the export job.

    ", "smithy.api#required": {} } }, - "TotalPieces": { - "target": "com.amazonaws.pinpoint#__integer", + "Definition": { + "target": "com.amazonaws.pinpoint#ExportJobResource", "traits": { - "smithy.api#documentation": "

    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

    " + "smithy.api#documentation": "

    The resource settings that apply to the export job.

    ", + "smithy.api#required": {} } }, - "Id": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the export job.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that's associated with the export job.

    ", "smithy.api#required": {} } }, @@ -6176,13 +6239,6 @@ "smithy.api#documentation": "

    The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

    " } }, - "CreationDate": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the export job was created.

    ", - "smithy.api#required": {} - } - }, "Type": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -6196,11 +6252,16 @@ "smithy.api#documentation": "

    The date, in ISO 8601 format, when the export job was completed.

    " } }, - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "Failures": { + "target": "com.amazonaws.pinpoint#ListOf__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that's associated with the export job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

    " + } + }, + "TotalFailures": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

    " } }, "FailedPieces": { @@ -6209,10 +6270,11 @@ "smithy.api#documentation": "

    The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

    " } }, - "TotalFailures": { - "target": "com.amazonaws.pinpoint#__integer", + "JobStatus": { + "target": "com.amazonaws.pinpoint#JobStatus", "traits": { - "smithy.api#documentation": "

    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

    " + "smithy.api#documentation": "

    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

    ", + "smithy.api#required": {} } }, "TotalProcessed": { @@ -6221,16 +6283,16 @@ "smithy.api#documentation": "

    The total number of endpoint definitions that were processed by the export job.

    " } }, - "Failures": { - "target": "com.amazonaws.pinpoint#ListOf__string", + "TotalPieces": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

    " + "smithy.api#documentation": "

    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

    " } }, - "JobStatus": { - "target": "com.amazonaws.pinpoint#JobStatus", + "CreationDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

    ", + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the export job was created.

    ", "smithy.api#required": {} } } @@ -6242,18 +6304,18 @@ "com.amazonaws.pinpoint#ExportJobsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " - } - }, "Item": { "target": "com.amazonaws.pinpoint#ListOfExportJobResponse", "traits": { "smithy.api#documentation": "

    An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } } }, "traits": { @@ -6346,18 +6408,18 @@ "com.amazonaws.pinpoint#GCMChannelRequest": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether to enable the GCM channel for the application.

    " - } - }, "ApiKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

    ", "smithy.api#required": {} } + }, + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether to enable the GCM channel for the application.

    " + } } }, "traits": { @@ -6367,17 +6429,10 @@ "com.amazonaws.pinpoint#GCMChannelResponse": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

    " - } - }, - "Platform": { - "target": "com.amazonaws.pinpoint#__string", + "IsArchived": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies whether the GCM channel is archived.

    " } }, "LastModifiedBy": { @@ -6386,29 +6441,29 @@ "smithy.api#documentation": "

    The user who last modified the GCM channel.

    " } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The current version of the GCM channel.

    " + "smithy.api#documentation": "

    (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

    " } }, - "ApplicationId": { + "Credential": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the GCM channel applies to.

    " + "smithy.api#documentation": "

    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

    ", + "smithy.api#required": {} } }, - "HasCredential": { - "target": "com.amazonaws.pinpoint#__boolean", + "LastModifiedDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    The date and time when the GCM channel was last modified.

    " } }, - "Credential": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The date and time when the GCM channel was enabled.

    " } }, "Enabled": { @@ -6417,22 +6472,29 @@ "smithy.api#documentation": "

    Specifies whether the GCM channel is enabled for the application.

    " } }, - "LastModifiedDate": { + "Platform": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time when the GCM channel was last modified.

    " + "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

    ", + "smithy.api#required": {} } }, - "CreationDate": { - "target": "com.amazonaws.pinpoint#__string", + "HasCredential": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The date and time when the GCM channel was enabled.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, - "IsArchived": { - "target": "com.amazonaws.pinpoint#__boolean", + "Version": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    Specifies whether the GCM channel is archived.

    " + "smithy.api#documentation": "

    The current version of the GCM channel.

    " + } + }, + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the application that the GCM channel applies to.

    " } } }, @@ -6443,10 +6505,10 @@ "com.amazonaws.pinpoint#GCMMessage": { "type": "structure", "members": { - "Substitutions": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "SmallImageIconUrl": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

    " + "smithy.api#documentation": "

    The URL of the small icon image to display in the status bar and the content view of the push notification.

    " } }, "ImageUrl": { @@ -6455,10 +6517,10 @@ "smithy.api#documentation": "

    The URL of an image to display in the push notification.

    " } }, - "SilentPush": { - "target": "com.amazonaws.pinpoint#__boolean", + "Substitutions": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

    " + "smithy.api#documentation": "

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

    " } }, "TimeToLive": { @@ -6467,16 +6529,10 @@ "smithy.api#documentation": "

    The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

    Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

    " } }, - "Url": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " - } - }, - "IconReference": { + "ImageIconUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The icon image name of the asset saved in your app.

    " + "smithy.api#documentation": "

    The URL of the large icon image to display in the content view of the push notification.

    " } }, "RestrictedPackageName": { @@ -6485,22 +6541,22 @@ "smithy.api#documentation": "

    The package name of the application where registration tokens must match in order for the recipient to receive the message.

    " } }, - "Title": { + "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The title to display above the notification message on the recipient's device.

    " + "smithy.api#documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " } }, - "SmallImageIconUrl": { + "Sound": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the small icon image to display in the status bar and the content view of the push notification.

    " + "smithy.api#documentation": "

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " } }, - "Data": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "Title": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    " + "smithy.api#documentation": "

    The title to display above the notification message on the recipient's device.

    " } }, "Action": { @@ -6509,16 +6565,16 @@ "smithy.api#documentation": "

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " } }, - "Priority": { - "target": "com.amazonaws.pinpoint#__string", + "Data": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

    /listitem>

  • high - The notification is sent immediately and might wake a sleeping device.

    • /para>

    Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

    The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

    " + "smithy.api#documentation": "

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    " } }, - "Sound": { + "IconReference": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " + "smithy.api#documentation": "

    The icon image name of the asset saved in your app.

    " } }, "RawContent": { @@ -6539,10 +6595,16 @@ "smithy.api#documentation": "

    An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

    Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

    " } }, - "ImageIconUrl": { + "SilentPush": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

    " + } + }, + "Priority": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the large icon image to display in the content view of the push notification.

    " + "smithy.api#documentation": "

    para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

    /listitem>

  • high - The notification is sent immediately and might wake a sleeping device.

    • /para>

    Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

    The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

    " } } }, @@ -6575,18 +6637,18 @@ "com.amazonaws.pinpoint#GPSPointDimension": { "type": "structure", "members": { + "RangeInKilometers": { + "target": "com.amazonaws.pinpoint#__double", + "traits": { + "smithy.api#documentation": "

    The range, in kilometers, from the GPS coordinates.

    " + } + }, "Coordinates": { "target": "com.amazonaws.pinpoint#GPSCoordinates", "traits": { "smithy.api#documentation": "

    The GPS coordinates to measure distance from.

    ", "smithy.api#required": {} } - }, - "RangeInKilometers": { - "target": "com.amazonaws.pinpoint#__double", - "traits": { - "smithy.api#documentation": "

    The range, in kilometers, from the GPS coordinates.

    " - } } }, "traits": { @@ -7026,11 +7088,11 @@ "com.amazonaws.pinpoint#GetApplicationDateRangeKpiRequest": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", + "PageSize": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

    ", - "smithy.api#httpQuery": "start-time" + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" } }, "EndTime": { @@ -7040,11 +7102,11 @@ "smithy.api#httpQuery": "end-time" } }, - "PageSize": { - "target": "com.amazonaws.pinpoint#__string", + "StartTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

    ", + "smithy.api#httpQuery": "start-time" } }, "NextToken": { @@ -7054,18 +7116,18 @@ "smithy.api#httpQuery": "next-token" } }, - "KpiName": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "KpiName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7376,11 +7438,11 @@ "smithy.api#required": {} } }, - "PageSize": { + "Token": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", + "smithy.api#httpQuery": "token" } }, "CampaignId": { @@ -7391,11 +7453,11 @@ "smithy.api#required": {} } }, - "Token": { + "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", - "smithy.api#httpQuery": "token" + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" } } } @@ -7455,18 +7517,10 @@ "com.amazonaws.pinpoint#GetCampaignDateRangeKpiRequest": { "type": "structure", "members": { - "KpiName": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CampaignId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7499,10 +7553,18 @@ "smithy.api#httpQuery": "page-size" } }, - "ApplicationId": { + "CampaignId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "KpiName": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7605,18 +7667,18 @@ "smithy.api#required": {} } }, - "Version": { + "CampaignId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique version number (Version property) for the campaign version.

    ", + "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "CampaignId": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", + "smithy.api#documentation": "

    The unique version number (Version property) for the campaign version.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7685,10 +7747,10 @@ "smithy.api#httpQuery": "page-size" } }, - "CampaignId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7700,10 +7762,10 @@ "smithy.api#httpQuery": "token" } }, - "ApplicationId": { + "CampaignId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8046,18 +8108,18 @@ "com.amazonaws.pinpoint#GetEndpointRequest": { "type": "structure", "members": { - "ApplicationId": { + "EndpointId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the endpoint.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "EndpointId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the endpoint.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8265,18 +8327,18 @@ "smithy.api#required": {} } }, - "PageSize": { + "Token": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", + "smithy.api#httpQuery": "token" } }, - "Token": { + "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", - "smithy.api#httpQuery": "token" + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" } } } @@ -8401,18 +8463,18 @@ "com.amazonaws.pinpoint#GetImportJobRequest": { "type": "structure", "members": { - "JobId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the job.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "JobId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the job.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8593,6 +8655,13 @@ "com.amazonaws.pinpoint#GetJourneyDateRangeKpiRequest": { "type": "structure", "members": { + "EndTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

    ", + "smithy.api#httpQuery": "end-time" + } + }, "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -8600,11 +8669,12 @@ "smithy.api#httpQuery": "page-size" } }, - "EndTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", + "KpiName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

    ", - "smithy.api#httpQuery": "end-time" + "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "JourneyId": { @@ -8615,13 +8685,6 @@ "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

    ", - "smithy.api#httpQuery": "start-time" - } - }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -8630,19 +8693,18 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpoint#__string", + "StartTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

    ", + "smithy.api#httpQuery": "start-time" } }, - "KpiName": { + "NextToken": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "next-token" } } } @@ -8710,19 +8772,19 @@ "smithy.api#required": {} } }, - "JourneyActivityId": { + "NextToken": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the journey activity.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "next-token" } }, - "PageSize": { + "JourneyActivityId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The unique identifier for the journey activity.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ApplicationId": { @@ -8733,11 +8795,11 @@ "smithy.api#required": {} } }, - "NextToken": { + "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" } } } @@ -8797,34 +8859,34 @@ "com.amazonaws.pinpoint#GetJourneyExecutionMetricsRequest": { "type": "structure", "members": { - "PageSize": { + "NextToken": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "next-token" } }, - "JourneyId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the journey.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "JourneyId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the journey.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NextToken": { + "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" } } } @@ -8917,13 +8979,6 @@ "com.amazonaws.pinpoint#GetPushTemplateRequest": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" - } - }, "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -8931,6 +8986,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Version": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" + } } } }, @@ -9054,18 +9116,18 @@ "com.amazonaws.pinpoint#GetRecommenderConfigurationsRequest": { "type": "structure", "members": { - "PageSize": { + "Token": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", + "smithy.api#httpQuery": "token" } }, - "Token": { + "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", - "smithy.api#httpQuery": "token" + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" } } } @@ -9165,25 +9227,18 @@ "com.amazonaws.pinpoint#GetSegmentExportJobsRequest": { "type": "structure", "members": { - "ApplicationId": { + "SegmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the segment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "PageSize": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" - } - }, - "SegmentId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the segment.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9194,6 +9249,13 @@ "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", "smithy.api#httpQuery": "token" } + }, + "PageSize": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" + } } } }, @@ -9252,25 +9314,18 @@ "com.amazonaws.pinpoint#GetSegmentImportJobsRequest": { "type": "structure", "members": { - "SegmentId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the segment.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "PageSize": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" - } - }, - "ApplicationId": { + "SegmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the segment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9281,6 +9336,13 @@ "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", "smithy.api#httpQuery": "token" } + }, + "PageSize": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" + } } } }, @@ -9299,18 +9361,18 @@ "com.amazonaws.pinpoint#GetSegmentRequest": { "type": "structure", "members": { - "SegmentId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the segment.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "SegmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the segment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9372,10 +9434,10 @@ "com.amazonaws.pinpoint#GetSegmentVersionRequest": { "type": "structure", "members": { - "ApplicationId": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique version number (Version property) for the campaign version.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9388,10 +9450,10 @@ "smithy.api#required": {} } }, - "Version": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique version number (Version property) for the campaign version.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9453,10 +9515,17 @@ "com.amazonaws.pinpoint#GetSegmentVersionsRequest": { "type": "structure", "members": { - "ApplicationId": { + "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" + } + }, + "SegmentId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the segment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9468,19 +9537,12 @@ "smithy.api#httpQuery": "token" } }, - "SegmentId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the segment.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PageSize": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -9540,6 +9602,13 @@ "com.amazonaws.pinpoint#GetSegmentsRequest": { "type": "structure", "members": { + "Token": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", + "smithy.api#httpQuery": "token" + } + }, "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -9554,13 +9623,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Token": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", - "smithy.api#httpQuery": "token" - } } } }, @@ -9684,19 +9746,19 @@ "com.amazonaws.pinpoint#GetSmsTemplateRequest": { "type": "structure", "members": { - "TemplateName": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" } }, - "Version": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -9756,18 +9818,18 @@ "com.amazonaws.pinpoint#GetUserEndpointsRequest": { "type": "structure", "members": { - "ApplicationId": { + "UserId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the user.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "UserId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the user.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9894,13 +9956,6 @@ "com.amazonaws.pinpoint#GetVoiceTemplateRequest": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" - } - }, "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -9908,6 +9963,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Version": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" + } } } }, @@ -9926,18 +9988,18 @@ "com.amazonaws.pinpoint#HoldoutActivity": { "type": "structure", "members": { - "NextActivity": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after performing the holdout activity.

    " - } - }, "Percentage": { "target": "com.amazonaws.pinpoint#__integer", "traits": { "smithy.api#documentation": "

    The percentage of participants who shouldn't continue the journey.

    To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

    ", "smithy.api#required": {} } + }, + "NextActivity": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after performing the holdout activity.

    " + } } }, "traits": { @@ -9947,10 +10009,11 @@ "com.amazonaws.pinpoint#ImportJobRequest": { "type": "structure", "members": { - "DefineSegment": { - "target": "com.amazonaws.pinpoint#__boolean", + "RoleArn": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    ", + "smithy.api#required": {} } }, "RegisterEndpoints": { @@ -9959,10 +10022,10 @@ "smithy.api#documentation": "

    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

    " } }, - "SegmentId": { - "target": "com.amazonaws.pinpoint#__string", + "DefineSegment": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

    " + "smithy.api#documentation": "

    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

    " } }, "S3Url": { @@ -9972,16 +10035,22 @@ "smithy.api#required": {} } }, + "ExternalId": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + } + }, "SegmentName": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

    " } }, - "ExternalId": { + "SegmentId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + "smithy.api#documentation": "

    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

    " } }, "Format": { @@ -9990,13 +10059,6 @@ "smithy.api#documentation": "

    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

    ", "smithy.api#required": {} } - }, - "RoleArn": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -10006,12 +10068,6 @@ "com.amazonaws.pinpoint#ImportJobResource": { "type": "structure", "members": { - "RegisterEndpoints": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

    " - } - }, "RoleArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -10019,17 +10075,22 @@ "smithy.api#required": {} } }, + "RegisterEndpoints": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

    " + } + }, "DefineSegment": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { "smithy.api#documentation": "

    Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

    " } }, - "Format": { - "target": "com.amazonaws.pinpoint#Format", + "ExternalId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

    If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " } }, "SegmentName": { @@ -10051,10 +10112,11 @@ "smithy.api#documentation": "

    The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

    " } }, - "ExternalId": { - "target": "com.amazonaws.pinpoint#__string", + "Format": { + "target": "com.amazonaws.pinpoint#Format", "traits": { - "smithy.api#documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + "smithy.api#documentation": "

    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

    If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

    ", + "smithy.api#required": {} } } }, @@ -10065,16 +10127,17 @@ "com.amazonaws.pinpoint#ImportJobResponse": { "type": "structure", "members": { - "FailedPieces": { - "target": "com.amazonaws.pinpoint#__integer", + "Type": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

    " + "smithy.api#documentation": "

    The job type. This value is IMPORT for import jobs.

    ", + "smithy.api#required": {} } }, - "TotalFailures": { - "target": "com.amazonaws.pinpoint#__integer", + "CompletionDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

    " + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the import job was completed.

    " } }, "JobStatus": { @@ -10084,16 +10147,22 @@ "smithy.api#required": {} } }, - "Failures": { - "target": "com.amazonaws.pinpoint#ListOf__string", + "TotalPieces": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

    " + "smithy.api#documentation": "

    The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

    " } }, - "Definition": { - "target": "com.amazonaws.pinpoint#ImportJobResource", + "FailedPieces": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The resource settings that apply to the import job.

    ", + "smithy.api#documentation": "

    The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

    " + } + }, + "CreationDate": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the import job was created.

    ", "smithy.api#required": {} } }, @@ -10110,43 +10179,36 @@ "smithy.api#documentation": "

    The total number of endpoint definitions that were processed by the import job.

    " } }, - "CompletionDate": { - "target": "com.amazonaws.pinpoint#__string", + "Definition": { + "target": "com.amazonaws.pinpoint#ImportJobResource", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the import job was completed.

    " + "smithy.api#documentation": "

    The resource settings that apply to the import job.

    ", + "smithy.api#required": {} } }, - "CreationDate": { - "target": "com.amazonaws.pinpoint#__string", + "CompletedPieces": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the import job was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

    " } }, - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "Failures": { + "target": "com.amazonaws.pinpoint#ListOf__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that's associated with the import job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

    " } }, - "Type": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The job type. This value is IMPORT for import jobs.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that's associated with the import job.

    ", "smithy.api#required": {} } }, - "TotalPieces": { - "target": "com.amazonaws.pinpoint#__integer", - "traits": { - "smithy.api#documentation": "

    The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

    " - } - }, - "CompletedPieces": { + "TotalFailures": { "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

    " + "smithy.api#documentation": "

    The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

    " } } }, @@ -10157,18 +10219,18 @@ "com.amazonaws.pinpoint#ImportJobsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, "Item": { "target": "com.amazonaws.pinpoint#ListOfImportJobResponse", "traits": { "smithy.api#documentation": "

    An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " - } } }, "traits": { @@ -10197,16 +10259,16 @@ "com.amazonaws.pinpoint#InternalServerErrorException": { "type": "structure", "members": { - "RequestID": { + "Message": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the request or response.

    " + "smithy.api#documentation": "

    The message that's returned from the API.

    " } }, - "Message": { + "RequestID": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message that's returned from the API.

    " + "smithy.api#documentation": "

    The unique identifier for the request or response.

    " } } }, @@ -10219,17 +10281,17 @@ "com.amazonaws.pinpoint#ItemResponse": { "type": "structure", "members": { - "EventsItemResponse": { - "target": "com.amazonaws.pinpoint#MapOfEventItemResponse", - "traits": { - "smithy.api#documentation": "

    A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

    " - } - }, "EndpointItemResponse": { "target": "com.amazonaws.pinpoint#EndpointItemResponse", "traits": { "smithy.api#documentation": "

    The response that was received after the endpoint data was accepted.

    " } + }, + "EventsItemResponse": { + "target": "com.amazonaws.pinpoint#MapOfEventItemResponse", + "traits": { + "smithy.api#documentation": "

    A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

    " + } } }, "traits": { @@ -10296,51 +10358,51 @@ "com.amazonaws.pinpoint#JourneyDateRangeKpiResponse": { "type": "structure", "members": { - "KpiName": { - "target": "com.amazonaws.pinpoint#__string", + "EndTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

    ", + "smithy.api#documentation": "

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", "smithy.api#required": {} } }, - "JourneyId": { - "target": "com.amazonaws.pinpoint#__string", + "StartTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The unique identifier for the journey that the metric applies to.

    ", + "smithy.api#documentation": "

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", "smithy.api#required": {} } }, - "ApplicationId": { + "NextToken": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

    " } }, - "KpiResult": { - "target": "com.amazonaws.pinpoint#BaseKpiResult", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", + "JourneyId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", + "smithy.api#documentation": "

    The unique identifier for the journey that the metric applies to.

    ", "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpoint#__string", + "KpiResult": { + "target": "com.amazonaws.pinpoint#BaseKpiResult", "traits": { - "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

    " + "smithy.api#documentation": "

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

    ", + "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", + "KpiName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    ", + "smithy.api#documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

    ", "smithy.api#required": {} } } @@ -10366,31 +10428,31 @@ "com.amazonaws.pinpoint#JourneyExecutionActivityMetricsResponse": { "type": "structure", "members": { - "JourneyId": { - "target": "com.amazonaws.pinpoint#__string", + "Metrics": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the journey that the metric applies to.

    ", + "smithy.api#documentation": "

    A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

    ", "smithy.api#required": {} } }, - "Metrics": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "JourneyId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

    ", + "smithy.api#documentation": "

    The unique identifier for the journey that the metric applies to.

    ", "smithy.api#required": {} } }, - "JourneyActivityId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the activity that the metric applies to.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", "smithy.api#required": {} } }, - "LastEvaluatedTime": { + "JourneyActivityId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

    ", + "smithy.api#documentation": "

    The unique identifier for the activity that the metric applies to.

    ", "smithy.api#required": {} } }, @@ -10401,10 +10463,10 @@ "smithy.api#required": {} } }, - "ApplicationId": { + "LastEvaluatedTime": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

    ", "smithy.api#required": {} } } @@ -10416,31 +10478,31 @@ "com.amazonaws.pinpoint#JourneyExecutionMetricsResponse": { "type": "structure", "members": { - "ApplicationId": { + "LastEvaluatedTime": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

    ", "smithy.api#required": {} } }, "Metrics": { "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

    ", + "smithy.api#documentation": "

    A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

    ", "smithy.api#required": {} } }, - "JourneyId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the journey that the metric applies to.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that the metric applies to.

    ", "smithy.api#required": {} } }, - "LastEvaluatedTime": { + "JourneyId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

    ", + "smithy.api#documentation": "

    The unique identifier for the journey that the metric applies to.

    ", "smithy.api#required": {} } } @@ -10458,16 +10520,16 @@ "smithy.api#documentation": "

    The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

    " } }, - "MessagesPerSecond": { + "EndpointReentryCap": { "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The maximum number of messages that the journey can send each second.

    " + "smithy.api#documentation": "

    The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

    " } }, - "EndpointReentryCap": { + "MessagesPerSecond": { "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

    " + "smithy.api#documentation": "

    The maximum number of messages that the journey can send each second.

    " } } }, @@ -10492,40 +10554,29 @@ "com.amazonaws.pinpoint#JourneyResponse": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.pinpoint#State", - "traits": { - "smithy.api#documentation": "

    The current status of the journey. Possible values are:

    • DRAFT - The journey is being developed and hasn't been published yet.

    • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

    • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.

    • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.

    • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.

    " - } - }, "Limits": { "target": "com.amazonaws.pinpoint#JourneyLimits", "traits": { "smithy.api#documentation": "

    The messaging and entry limits for the journey.

    " } }, - "StartCondition": { - "target": "com.amazonaws.pinpoint#StartCondition", - "traits": { - "smithy.api#documentation": "

    The segment that defines which users are participants in the journey.

    " - } - }, - "CreationDate": { + "Name": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the journey was created.

    " + "smithy.api#documentation": "

    The name of the journey.

    ", + "smithy.api#required": {} } }, - "LastModifiedDate": { + "StartActivity": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the journey was last modified.

    " + "smithy.api#documentation": "

    The unique identifier for the first activity in the journey.

    " } }, - "Activities": { - "target": "com.amazonaws.pinpoint#MapOfActivity", + "RefreshFrequency": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

    " + "smithy.api#documentation": "

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    " } }, "ApplicationId": { @@ -10535,6 +10586,12 @@ "smithy.api#required": {} } }, + "StartCondition": { + "target": "com.amazonaws.pinpoint#StartCondition", + "traits": { + "smithy.api#documentation": "

    The segment that defines which users are participants in the journey.

    " + } + }, "Id": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -10548,12 +10605,6 @@ "smithy.api#documentation": "

    Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

    " } }, - "Schedule": { - "target": "com.amazonaws.pinpoint#JourneySchedule", - "traits": { - "smithy.api#documentation": "

    The schedule settings for the journey.

    " - } - }, "QuietTime": { "target": "com.amazonaws.pinpoint#QuietTime", "traits": { @@ -10567,23 +10618,34 @@ "smithy.api#jsonName": "tags" } }, - "StartActivity": { - "target": "com.amazonaws.pinpoint#__string", + "State": { + "target": "com.amazonaws.pinpoint#State", "traits": { - "smithy.api#documentation": "

    The unique identifier for the first activity in the journey.

    " + "smithy.api#documentation": "

    The current status of the journey. Possible values are:

    • DRAFT - The journey is being developed and hasn't been published yet.

    • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

    • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.

    • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.

    • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.

    " } }, - "RefreshFrequency": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    " + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the journey was created.

    " } }, - "Name": { + "Activities": { + "target": "com.amazonaws.pinpoint#MapOfActivity", + "traits": { + "smithy.api#documentation": "

    A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

    " + } + }, + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the journey.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the journey was last modified.

    " + } + }, + "Schedule": { + "target": "com.amazonaws.pinpoint#JourneySchedule", + "traits": { + "smithy.api#documentation": "

    The schedule settings for the journey.

    " } } }, @@ -10597,7 +10659,7 @@ "SenderId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

    " + "smithy.api#documentation": "

    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

    " } }, "MessageType": { @@ -10620,17 +10682,17 @@ "smithy.api#documentation": "

    The scheduled time, in ISO 8601 format, when the journey ended or will end.

    " } }, - "StartTime": { - "target": "com.amazonaws.pinpoint#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

    The scheduled time, in ISO 8601 format, when the journey began or will begin.

    " - } - }, "Timezone": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC,\n UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30,\n UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02,\n UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09,\n UTC-09:30, UTC-10, and UTC-11.

    " } + }, + "StartTime": { + "target": "com.amazonaws.pinpoint#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

    The scheduled time, in ISO 8601 format, when the journey began or will begin.

    " + } } }, "traits": { @@ -10723,18 +10785,18 @@ "smithy.api#required": {} } }, - "PageSize": { + "Token": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "page-size" + "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", + "smithy.api#httpQuery": "token" } }, - "Token": { + "PageSize": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    ", - "smithy.api#httpQuery": "token" + "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "page-size" } } } @@ -10898,18 +10960,18 @@ "com.amazonaws.pinpoint#ListRecommenderConfigurationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " - } - }, "Item": { "target": "com.amazonaws.pinpoint#ListOfRecommenderConfigurationResponse", "traits": { "smithy.api#documentation": "

    An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } } }, "traits": { @@ -11001,27 +11063,20 @@ "com.amazonaws.pinpoint#ListTemplateVersionsRequest": { "type": "structure", "members": { - "TemplateType": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

    ", + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", "smithy.api#httpLabel": {}, - "smithy.api#pattern": "^[^a-z]*$", "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", - "smithy.api#httpQuery": "next-token" - } - }, - "TemplateName": { + "TemplateType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#documentation": "

    The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

    ", "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^[^a-z]*$", "smithy.api#required": {} } }, @@ -11031,6 +11086,13 @@ "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", "smithy.api#httpQuery": "page-size" } + }, + "NextToken": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", + "smithy.api#httpQuery": "next-token" + } } } }, @@ -11083,13 +11145,6 @@ "com.amazonaws.pinpoint#ListTemplatesRequest": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

    ", - "smithy.api#httpQuery": "prefix" - } - }, "NextToken": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -11110,6 +11165,13 @@ "smithy.api#documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    ", "smithy.api#httpQuery": "page-size" } + }, + "Prefix": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

    ", + "smithy.api#httpQuery": "prefix" + } } } }, @@ -11281,40 +11343,46 @@ "com.amazonaws.pinpoint#Message": { "type": "structure", "members": { - "Body": { + "ImageUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The body of the notification message. The maximum number of characters is 200.

    " + "smithy.api#documentation": "

    The URL of an image to display in the push notification.

    " } }, - "MediaUrl": { + "Title": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the image or video to display in the push notification.

    " + "smithy.api#documentation": "

    The title to display above the notification message on a recipient's device.

    " } }, - "RawContent": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

    " + "smithy.api#documentation": "

    The body of the notification message. The maximum number of characters is 200.

    " } }, - "ImageUrl": { - "target": "com.amazonaws.pinpoint#__string", + "Action": { + "target": "com.amazonaws.pinpoint#Action", "traits": { - "smithy.api#documentation": "

    The URL of an image to display in the push notification.

    " + "smithy.api#documentation": "

    The action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " } }, - "JsonBody": { + "ImageIconUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The JSON payload to use for a silent push notification.

    " + "smithy.api#documentation": "

    The URL of the image to display as the push-notification icon, such as the icon for the app.

    " } }, - "Url": { + "TimeToLive": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

    " + } + }, + "ImageSmallIconUrl": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + "smithy.api#documentation": "

    The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

    " } }, "SilentPush": { @@ -11323,34 +11391,28 @@ "smithy.api#documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

    " } }, - "ImageIconUrl": { + "Url": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the image to display as the push-notification icon, such as the icon for the app.

    " + "smithy.api#documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " } }, - "ImageSmallIconUrl": { + "RawContent": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

    " + "smithy.api#documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

    " } }, - "Title": { + "JsonBody": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The title to display above the notification message on a recipient's device.

    " - } - }, - "TimeToLive": { - "target": "com.amazonaws.pinpoint#__integer", - "traits": { - "smithy.api#documentation": "

    The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

    " + "smithy.api#documentation": "

    The JSON payload to use for a silent push notification.

    " } }, - "Action": { - "target": "com.amazonaws.pinpoint#Action", + "MediaUrl": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + "smithy.api#documentation": "

    The URL of the image or video to display in the push notification.

    " } } }, @@ -11361,16 +11423,16 @@ "com.amazonaws.pinpoint#MessageBody": { "type": "structure", "members": { - "RequestID": { + "Message": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the request or response.

    " + "smithy.api#documentation": "

    The message that's returned from the API.

    " } }, - "Message": { + "RequestID": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message that's returned from the API.

    " + "smithy.api#documentation": "

    The unique identifier for the request or response.

    " } } }, @@ -11381,52 +11443,52 @@ "com.amazonaws.pinpoint#MessageConfiguration": { "type": "structure", "members": { - "GCMMessage": { - "target": "com.amazonaws.pinpoint#Message", + "SMSMessage": { + "target": "com.amazonaws.pinpoint#CampaignSmsMessage", "traits": { - "smithy.api#documentation": "

    The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

    " + "smithy.api#documentation": "

    The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

    " } }, - "APNSMessage": { - "target": "com.amazonaws.pinpoint#Message", + "EmailMessage": { + "target": "com.amazonaws.pinpoint#CampaignEmailMessage", "traits": { - "smithy.api#documentation": "

    The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

    " + "smithy.api#documentation": "

    The message that the campaign sends through the email channel. If specified, this message overrides the default message.

    " } }, - "BaiduMessage": { + "GCMMessage": { "target": "com.amazonaws.pinpoint#Message", "traits": { - "smithy.api#documentation": "

    The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

    " + "smithy.api#documentation": "

    The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

    " } }, - "SMSMessage": { - "target": "com.amazonaws.pinpoint#CampaignSmsMessage", + "DefaultMessage": { + "target": "com.amazonaws.pinpoint#Message", "traits": { - "smithy.api#documentation": "

    The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

    " + "smithy.api#documentation": "

    The default message that the campaign sends through all the channels that are configured for the campaign.

    " } }, - "EmailMessage": { - "target": "com.amazonaws.pinpoint#CampaignEmailMessage", + "ADMMessage": { + "target": "com.amazonaws.pinpoint#Message", "traits": { - "smithy.api#documentation": "

    The message that the campaign sends through the email channel. If specified, this message overrides the default message.

    " + "smithy.api#documentation": "

    The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

    " } }, - "CustomMessage": { - "target": "com.amazonaws.pinpoint#CampaignCustomMessage", + "APNSMessage": { + "target": "com.amazonaws.pinpoint#Message", "traits": { - "smithy.api#documentation": "

    The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

    " + "smithy.api#documentation": "

    The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

    " } }, - "ADMMessage": { + "BaiduMessage": { "target": "com.amazonaws.pinpoint#Message", "traits": { - "smithy.api#documentation": "

    The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

    " + "smithy.api#documentation": "

    The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

    " } }, - "DefaultMessage": { - "target": "com.amazonaws.pinpoint#Message", + "CustomMessage": { + "target": "com.amazonaws.pinpoint#CampaignCustomMessage", "traits": { - "smithy.api#documentation": "

    The default message that the campaign sends through all the channels that are configured for the campaign.

    " + "smithy.api#documentation": "

    The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

    " } } }, @@ -11437,41 +11499,41 @@ "com.amazonaws.pinpoint#MessageRequest": { "type": "structure", "members": { - "TraceId": { - "target": "com.amazonaws.pinpoint#__string", + "Addresses": { + "target": "com.amazonaws.pinpoint#MapOfAddressConfiguration", "traits": { - "smithy.api#documentation": "

    The unique identifier for tracing the message. This identifier is visible to message recipients.

    " + "smithy.api#documentation": "

    A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

    " } }, - "MessageConfiguration": { - "target": "com.amazonaws.pinpoint#DirectMessageConfiguration", + "TemplateConfiguration": { + "target": "com.amazonaws.pinpoint#TemplateConfiguration", "traits": { - "smithy.api#documentation": "

    The settings and content for the default message and any default messages that you defined for specific channels.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The message template to use for the message.

    " } }, - "Endpoints": { - "target": "com.amazonaws.pinpoint#MapOfEndpointSendConfiguration", + "Context": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

    " + "smithy.api#documentation": "

    A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    " } }, - "Addresses": { - "target": "com.amazonaws.pinpoint#MapOfAddressConfiguration", + "Endpoints": { + "target": "com.amazonaws.pinpoint#MapOfEndpointSendConfiguration", "traits": { - "smithy.api#documentation": "

    A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

    " + "smithy.api#documentation": "

    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

    " } }, - "Context": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "TraceId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    " + "smithy.api#documentation": "

    The unique identifier for tracing the message. This identifier is visible to message recipients.

    " } }, - "TemplateConfiguration": { - "target": "com.amazonaws.pinpoint#TemplateConfiguration", + "MessageConfiguration": { + "target": "com.amazonaws.pinpoint#DirectMessageConfiguration", "traits": { - "smithy.api#documentation": "

    The message template to use for the message.

    " + "smithy.api#documentation": "

    The settings and content for the default message and any default messages that you defined for specific channels.

    ", + "smithy.api#required": {} } } }, @@ -11482,29 +11544,29 @@ "com.amazonaws.pinpoint#MessageResponse": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that was used to send the message.

    ", - "smithy.api#required": {} - } - }, "EndpointResult": { "target": "com.amazonaws.pinpoint#MapOfEndpointMessageResult", "traits": { "smithy.api#documentation": "

    A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

    " } }, - "Result": { - "target": "com.amazonaws.pinpoint#MapOfMessageResult", + "RequestId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

    " + "smithy.api#documentation": "

    The identifier for the original request that the message was delivered for.

    " } }, - "RequestId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The identifier for the original request that the message was delivered for.

    " + "smithy.api#documentation": "

    The unique identifier for the application that was used to send the message.

    ", + "smithy.api#required": {} + } + }, + "Result": { + "target": "com.amazonaws.pinpoint#MapOfMessageResult", + "traits": { + "smithy.api#documentation": "

    A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

    " } } }, @@ -11515,17 +11577,23 @@ "com.amazonaws.pinpoint#MessageResult": { "type": "structure", "members": { + "StatusCode": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The downstream service status code for delivering the message.

    ", + "smithy.api#required": {} + } + }, "StatusMessage": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The status message for delivering the message.

    " } }, - "DeliveryStatus": { - "target": "com.amazonaws.pinpoint#DeliveryStatus", + "UpdatedToken": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • SUCCESSFUL - The message was successfully delivered to the endpoint address.

    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

    • TIMEOUT - The message couldn't be sent within the timeout period.

    • UNKNOWN_FAILURE - An unknown error occurred.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

    " } }, "MessageId": { @@ -11534,18 +11602,12 @@ "smithy.api#documentation": "

    The unique identifier for the message that was sent.

    " } }, - "StatusCode": { - "target": "com.amazonaws.pinpoint#__integer", + "DeliveryStatus": { + "target": "com.amazonaws.pinpoint#DeliveryStatus", "traits": { - "smithy.api#documentation": "

    The downstream service status code for delivering the message.

    ", + "smithy.api#documentation": "

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • SUCCESSFUL - The message was successfully delivered to the endpoint address.

    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.

    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

    • TIMEOUT - The message couldn't be sent within the timeout period.

    • UNKNOWN_FAILURE - An unknown error occurred.

    ", "smithy.api#required": {} } - }, - "UpdatedToken": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

    " - } } }, "traits": { @@ -11570,16 +11632,16 @@ "com.amazonaws.pinpoint#MethodNotAllowedException": { "type": "structure", "members": { - "RequestID": { + "Message": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the request or response.

    " + "smithy.api#documentation": "

    The message that's returned from the API.

    " } }, - "Message": { + "RequestID": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message that's returned from the API.

    " + "smithy.api#documentation": "

    The unique identifier for the request or response.

    " } } }, @@ -11592,17 +11654,17 @@ "com.amazonaws.pinpoint#MetricDimension": { "type": "structure", "members": { - "ComparisonOperator": { - "target": "com.amazonaws.pinpoint#__string", + "Value": { + "target": "com.amazonaws.pinpoint#__double", "traits": { - "smithy.api#documentation": "

    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

    ", + "smithy.api#documentation": "

    The value to compare.

    ", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.pinpoint#__double", + "ComparisonOperator": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The value to compare.

    ", + "smithy.api#documentation": "

    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

    ", "smithy.api#required": {} } } @@ -11669,7 +11731,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

    " + "smithy.api#documentation": "

    Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

    To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

    " } }, "com.amazonaws.pinpoint#NotFoundException": { @@ -11697,16 +11759,16 @@ "com.amazonaws.pinpoint#NumberValidateRequest": { "type": "structure", "members": { - "PhoneNumber": { + "IsoCountryCode": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

    " + "smithy.api#documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

    " } }, - "IsoCountryCode": { + "PhoneNumber": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

    " } } }, @@ -11717,12 +11779,6 @@ "com.amazonaws.pinpoint#NumberValidateResponse": { "type": "structure", "members": { - "CountryCodeNumeric": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The numeric code for the country or region where the phone number was originally registered.

    " - } - }, "CleansedPhoneNumberE164": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -11735,58 +11791,58 @@ "smithy.api#documentation": "

    The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

    " } }, - "OriginalPhoneNumber": { + "PhoneType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The phone number that was sent in the request body.

    " + "smithy.api#documentation": "

    The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,\n INVALID, PREPAID, and OTHER.

    " } }, - "ZipCode": { + "OriginalPhoneNumber": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The postal or ZIP code for the location where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The phone number that was sent in the request body.

    " } }, - "County": { + "CountryCodeIso2": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the county where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

    " } }, - "Timezone": { + "CleansedPhoneNumberNational": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The time zone for the location where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The cleansed phone number, in the format for the location where the phone number was originally registered.

    " } }, - "CountryCodeIso2": { + "CountryCodeNumeric": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The numeric code for the country or region where the phone number was originally registered.

    " } }, - "CleansedPhoneNumberNational": { + "OriginalCountryCodeIso2": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The cleansed phone number, in the format for the location where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

    " } }, - "PhoneType": { + "ZipCode": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,\n INVALID, PREPAID, and OTHER.

    " + "smithy.api#documentation": "

    The postal or ZIP code for the location where the phone number was originally registered.

    " } }, - "City": { + "Country": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the city where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The name of the country or region where the phone number was originally registered.

    " } }, - "OriginalCountryCodeIso2": { + "City": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

    " + "smithy.api#documentation": "

    The name of the city where the phone number was originally registered.

    " } }, "PhoneTypeCode": { @@ -11795,10 +11851,16 @@ "smithy.api#documentation": "

    The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

    " } }, - "Country": { + "Timezone": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the country or region where the phone number was originally registered.

    " + "smithy.api#documentation": "

    The time zone for the location where the phone number was originally registered.

    " + } + }, + "County": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The name of the county where the phone number was originally registered.

    " } } }, @@ -12266,16 +12328,16 @@ "com.amazonaws.pinpoint#PublicEndpoint": { "type": "structure", "members": { - "OptOut": { + "EndpointStatus": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + "smithy.api#documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " } }, - "ChannelType": { - "target": "com.amazonaws.pinpoint#ChannelType", + "Demographic": { + "target": "com.amazonaws.pinpoint#EndpointDemographic", "traits": { - "smithy.api#documentation": "

    The channel that's used when sending messages or push notifications to the endpoint.

    " + "smithy.api#documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " } }, "RequestId": { @@ -12284,52 +12346,52 @@ "smithy.api#documentation": "

    A unique identifier that's generated each time the endpoint is updated.

    " } }, - "EffectiveDate": { - "target": "com.amazonaws.pinpoint#__string", + "User": { + "target": "com.amazonaws.pinpoint#EndpointUser", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint was last updated.

    " + "smithy.api#documentation": "

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

    " } }, - "EndpointStatus": { + "Address": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " + "smithy.api#documentation": "

    The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

    " } }, - "Location": { - "target": "com.amazonaws.pinpoint#EndpointLocation", + "Metrics": { + "target": "com.amazonaws.pinpoint#MapOf__double", "traits": { - "smithy.api#documentation": "

    The geographic information for the endpoint.

    " + "smithy.api#documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " } }, - "Demographic": { - "target": "com.amazonaws.pinpoint#EndpointDemographic", + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " + "smithy.api#documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

    " } }, - "Address": { - "target": "com.amazonaws.pinpoint#__string", + "Location": { + "target": "com.amazonaws.pinpoint#EndpointLocation", "traits": { - "smithy.api#documentation": "

    The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

    " + "smithy.api#documentation": "

    The geographic information for the endpoint.

    " } }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "EffectiveDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

    " + "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the endpoint was last updated.

    " } }, - "Metrics": { - "target": "com.amazonaws.pinpoint#MapOf__double", + "ChannelType": { + "target": "com.amazonaws.pinpoint#ChannelType", "traits": { - "smithy.api#documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " + "smithy.api#documentation": "

    The channel that's used when sending messages or push notifications to the endpoint.

    " } }, - "User": { - "target": "com.amazonaws.pinpoint#EndpointUser", + "OptOut": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

    " + "smithy.api#documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " } } }, @@ -12346,12 +12408,6 @@ "smithy.api#documentation": "

    Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

    " } }, - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

    " - } - }, "NextActivity": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -12363,6 +12419,12 @@ "traits": { "smithy.api#documentation": "

    The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " } + }, + "TemplateName": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

    " + } } }, "traits": { @@ -12372,10 +12434,11 @@ "com.amazonaws.pinpoint#PushNotificationTemplateRequest": { "type": "structure", "members": { - "RecommenderId": { - "target": "com.amazonaws.pinpoint#__string", + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

    " + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" } }, "GCM": { @@ -12384,29 +12447,10 @@ "smithy.api#documentation": "

    The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " } }, - "APNS": { - "target": "com.amazonaws.pinpoint#APNSPushNotificationTemplate", - "traits": { - "smithy.api#documentation": "

    The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " - } - }, - "DefaultSubstitutions": { + "RecommenderId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    " - } - }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", - "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" - } - }, - "Baidu": { - "target": "com.amazonaws.pinpoint#AndroidPushNotificationTemplate", - "traits": { - "smithy.api#documentation": "

    The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + "smithy.api#documentation": "

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

    " } }, "Default": { @@ -12426,6 +12470,24 @@ "traits": { "smithy.api#documentation": "

    A custom description of the message template.

    " } + }, + "Baidu": { + "target": "com.amazonaws.pinpoint#AndroidPushNotificationTemplate", + "traits": { + "smithy.api#documentation": "

    The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + } + }, + "APNS": { + "target": "com.amazonaws.pinpoint#APNSPushNotificationTemplate", + "traits": { + "smithy.api#documentation": "

    The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + } + }, + "DefaultSubstitutions": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    " + } } }, "traits": { @@ -12435,28 +12497,23 @@ "com.amazonaws.pinpoint#PushNotificationTemplateResponse": { "type": "structure", "members": { - "Arn": { + "TemplateDescription": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " - } - }, - "Default": { - "target": "com.amazonaws.pinpoint#DefaultPushNotificationTemplate", - "traits": { - "smithy.api#documentation": "

    The default message template that's used for push notification channels.

    " + "smithy.api#documentation": "

    The custom description of the message template.

    " } }, - "TemplateDescription": { - "target": "com.amazonaws.pinpoint#__string", + "APNS": { + "target": "com.amazonaws.pinpoint#APNSPushNotificationTemplate", "traits": { - "smithy.api#documentation": "

    The custom description of the message template.

    " + "smithy.api#documentation": "

    The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " } }, - "GCM": { - "target": "com.amazonaws.pinpoint#AndroidPushNotificationTemplate", + "TemplateType": { + "target": "com.amazonaws.pinpoint#TemplateType", "traits": { - "smithy.api#documentation": "

    The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + "smithy.api#documentation": "

    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

    ", + "smithy.api#required": {} } }, "LastModifiedDate": { @@ -12473,31 +12530,22 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", - "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" - } - }, - "APNS": { - "target": "com.amazonaws.pinpoint#APNSPushNotificationTemplate", + "RecommenderId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + "smithy.api#documentation": "

    The unique identifier for the recommender model that's used by the message template.

    " } }, - "TemplateType": { - "target": "com.amazonaws.pinpoint#TemplateType", + "Arn": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " } }, - "TemplateName": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " } }, "Baidu": { @@ -12506,22 +12554,17 @@ "smithy.api#documentation": "

    The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " } }, - "RecommenderId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the recommender model that's used by the message template.

    " - } - }, "ADM": { "target": "com.amazonaws.pinpoint#AndroidPushNotificationTemplate", "traits": { "smithy.api#documentation": "

    The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " } }, - "Version": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " + "smithy.api#documentation": "

    The name of the message template.

    ", + "smithy.api#required": {} } }, "DefaultSubstitutions": { @@ -12529,6 +12572,25 @@ "traits": { "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " } + }, + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", + "traits": { + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" + } + }, + "GCM": { + "target": "com.amazonaws.pinpoint#AndroidPushNotificationTemplate", + "traits": { + "smithy.api#documentation": "

    The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + } + }, + "Default": { + "target": "com.amazonaws.pinpoint#DefaultPushNotificationTemplate", + "traits": { + "smithy.api#documentation": "

    The default message template that's used for push notification channels.

    " + } } }, "traits": { @@ -12578,13 +12640,6 @@ "com.amazonaws.pinpoint#PutEventStreamRequest": { "type": "structure", "members": { - "WriteEventStream": { - "target": "com.amazonaws.pinpoint#WriteEventStream", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -12592,6 +12647,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "WriteEventStream": { + "target": "com.amazonaws.pinpoint#WriteEventStream", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -12650,18 +12712,18 @@ "com.amazonaws.pinpoint#PutEventsRequest": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "EventsRequest": { + "target": "com.amazonaws.pinpoint#EventsRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "EventsRequest": { - "target": "com.amazonaws.pinpoint#EventsRequest", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -12750,17 +12812,17 @@ "com.amazonaws.pinpoint#RecencyDimension": { "type": "structure", "members": { - "Duration": { - "target": "com.amazonaws.pinpoint#Duration", + "RecencyType": { + "target": "com.amazonaws.pinpoint#RecencyType", "traits": { - "smithy.api#documentation": "

    The duration to use when determining whether an endpoint is active or inactive.

    ", + "smithy.api#documentation": "

    The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

    ", "smithy.api#required": {} } }, - "RecencyType": { - "target": "com.amazonaws.pinpoint#RecencyType", + "Duration": { + "target": "com.amazonaws.pinpoint#Duration", "traits": { - "smithy.api#documentation": "

    The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

    ", + "smithy.api#documentation": "

    The duration to use when determining whether an endpoint is active or inactive.

    ", "smithy.api#required": {} } } @@ -12800,31 +12862,31 @@ "smithy.api#documentation": "

    The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

    • PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

    • PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

    " } }, - "CreationDate": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

    ", + "smithy.api#documentation": "

    The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

    ", "smithy.api#required": {} } }, - "LastModifiedDate": { + "CreationDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

    ", + "smithy.api#documentation": "

    The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

    ", "smithy.api#required": {} } }, - "Description": { + "RecommendationProviderRoleArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom description of the configuration for the recommender model.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

    ", + "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.pinpoint#__string", + "RecommendationsPerMessage": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The unique identifier for the recommender model configuration.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

    " } }, "RecommendationTransformerUri": { @@ -12833,35 +12895,35 @@ "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

    " } }, - "Name": { + "RecommendationsDisplayName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom name of the configuration for the recommender model.

    " + "smithy.api#documentation": "

    The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

    This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " } }, - "RecommendationProviderRoleArn": { - "target": "com.amazonaws.pinpoint#__string", + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " } }, - "RecommendationsPerMessage": { - "target": "com.amazonaws.pinpoint#__integer", + "Name": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

    " + "smithy.api#documentation": "

    The custom name of the configuration for the recommender model.

    " } }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "Id": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " + "smithy.api#documentation": "

    The unique identifier for the recommender model configuration.

    ", + "smithy.api#required": {} } }, - "RecommendationsDisplayName": { + "Description": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

    This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " + "smithy.api#documentation": "

    The custom description of the configuration for the recommender model.

    " } } }, @@ -12912,18 +12974,18 @@ "com.amazonaws.pinpoint#RemoveAttributesRequest": { "type": "structure", "members": { - "AttributeType": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of attribute or attributes to remove. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.

    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.

    • endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "AttributeType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The type of attribute or attributes to remove. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.

    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.

    • endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12952,17 +13014,17 @@ "com.amazonaws.pinpoint#ResultRow": { "type": "structure", "members": { - "Values": { + "GroupedBys": { "target": "com.amazonaws.pinpoint#ListOfResultRowValue", "traits": { - "smithy.api#documentation": "

    An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

    ", + "smithy.api#documentation": "

    An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

    ", "smithy.api#required": {} } }, - "GroupedBys": { + "Values": { "target": "com.amazonaws.pinpoint#ListOfResultRowValue", "traits": { - "smithy.api#documentation": "

    An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

    ", + "smithy.api#documentation": "

    An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

    ", "smithy.api#required": {} } } @@ -12974,24 +13036,24 @@ "com.amazonaws.pinpoint#ResultRowValue": { "type": "structure", "members": { - "Key": { + "Value": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The friendly name of the metric whose value is specified by the Value property.

    ", + "smithy.api#documentation": "

    In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

    ", "smithy.api#required": {} } }, - "Value": { + "Type": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

    ", + "smithy.api#documentation": "

    The data type of the value specified by the Value property.

    ", "smithy.api#required": {} } }, - "Type": { + "Key": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The data type of the value specified by the Value property.

    ", + "smithy.api#documentation": "

    The friendly name of the metric whose value is specified by the Value property.

    ", "smithy.api#required": {} } } @@ -13003,6 +13065,12 @@ "com.amazonaws.pinpoint#SMSChannelRequest": { "type": "structure", "members": { + "ShortCode": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The registered short code that you want to use when you send messages through the SMS channel.

    " + } + }, "Enabled": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { @@ -13014,12 +13082,6 @@ "traits": { "smithy.api#documentation": "

    The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

    " } - }, - "ShortCode": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The registered short code that you want to use when you send messages through the SMS channel.

    " - } } }, "traits": { @@ -13047,11 +13109,10 @@ "smithy.api#documentation": "

    The registered short code to use when you send messages through the SMS channel.

    " } }, - "Platform": { - "target": "com.amazonaws.pinpoint#__string", + "Version": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The current version of the SMS channel.

    " } }, "Id": { @@ -13060,34 +13121,34 @@ "smithy.api#documentation": "

    (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

    " } }, - "LastModifiedBy": { - "target": "com.amazonaws.pinpoint#__string", + "TransactionalMessagesPerSecond": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The user who last modified the SMS channel.

    " + "smithy.api#documentation": "

    The maximum number of transactional messages that you can send through the SMS channel each second.

    " } }, - "PromotionalMessagesPerSecond": { - "target": "com.amazonaws.pinpoint#__integer", + "SenderId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of promotional messages that you can send through the SMS channel each second.

    " + "smithy.api#documentation": "

    The identity that displays on recipients' devices when they receive messages from the SMS channel.

    " } }, - "IsArchived": { - "target": "com.amazonaws.pinpoint#__boolean", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the SMS channel is archived.

    " + "smithy.api#documentation": "

    The unique identifier for the application that the SMS channel applies to.

    " } }, - "HasCredential": { + "IsArchived": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    Specifies whether the SMS channel is archived.

    " } }, - "SenderId": { - "target": "com.amazonaws.pinpoint#__string", + "PromotionalMessagesPerSecond": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The identity that displays on recipients' devices when they receive messages from the SMS channel.

    " + "smithy.api#documentation": "

    The maximum number of promotional messages that you can send through the SMS channel each second.

    " } }, "Enabled": { @@ -13096,22 +13157,23 @@ "smithy.api#documentation": "

    Specifies whether the SMS channel is enabled for the application.

    " } }, - "TransactionalMessagesPerSecond": { - "target": "com.amazonaws.pinpoint#__integer", + "Platform": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The maximum number of transactional messages that you can send through the SMS channel each second.

    " + "smithy.api#documentation": "

    The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

    ", + "smithy.api#required": {} } }, - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "HasCredential": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the SMS channel applies to.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "LastModifiedBy": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The current version of the SMS channel.

    " + "smithy.api#documentation": "

    The user who last modified the SMS channel.

    " } } }, @@ -13122,10 +13184,10 @@ "com.amazonaws.pinpoint#SMSMessage": { "type": "structure", "members": { - "OriginationNumber": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

    " + "smithy.api#documentation": "

    The body of the SMS message.

    " } }, "Keyword": { @@ -13134,16 +13196,16 @@ "smithy.api#documentation": "

    The SMS program name that you provided to AWS Support when you requested your dedicated number.

    " } }, - "SenderId": { + "OriginationNumber": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

    " + "smithy.api#documentation": "

    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

    " } }, - "MessageType": { - "target": "com.amazonaws.pinpoint#MessageType", + "MediaUrl": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

    " + "smithy.api#documentation": "

    This field is reserved for future use.

    " } }, "Substitutions": { @@ -13152,16 +13214,16 @@ "smithy.api#documentation": "

    The message variables to use in the SMS message. You can override the default variables with individual address variables.

    " } }, - "MediaUrl": { - "target": "com.amazonaws.pinpoint#__string", + "MessageType": { + "target": "com.amazonaws.pinpoint#MessageType", "traits": { - "smithy.api#documentation": "

    The URL of an image or video to display in the SMS message.

    " + "smithy.api#documentation": "

    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

    " } }, - "Body": { + "SenderId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The body of the SMS message.

    " + "smithy.api#documentation": "

    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

    " } } }, @@ -13172,22 +13234,16 @@ "com.amazonaws.pinpoint#SMSMessageActivity": { "type": "structure", "members": { - "NextActivity": { + "TemplateVersion": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after the message is sent.

    " - } - }, - "MessageConfig": { - "target": "com.amazonaws.pinpoint#JourneySMSMessage", - "traits": { - "smithy.api#documentation": "

    Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

    " + "smithy.api#documentation": "

    The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " } }, - "TemplateVersion": { + "NextActivity": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " + "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after the message is sent.

    " } }, "TemplateName": { @@ -13195,6 +13251,12 @@ "traits": { "smithy.api#documentation": "

    The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

    " } + }, + "MessageConfig": { + "target": "com.amazonaws.pinpoint#JourneySMSMessage", + "traits": { + "smithy.api#documentation": "

    Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

    " + } } }, "traits": { @@ -13204,16 +13266,17 @@ "com.amazonaws.pinpoint#SMSTemplateRequest": { "type": "structure", "members": { - "Body": { + "TemplateDescription": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The message body to use in text messages that are based on the message template.

    " + "smithy.api#documentation": "

    A custom description of the message template.

    " } }, - "DefaultSubstitutions": { - "target": "com.amazonaws.pinpoint#__string", + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    " + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" } }, "RecommenderId": { @@ -13222,17 +13285,16 @@ "smithy.api#documentation": "

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

    " } }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "Body": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The message body to use in text messages that are based on the message template.

    " } }, - "TemplateDescription": { + "DefaultSubstitutions": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom description of the message template.

    " + "smithy.api#documentation": "

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    " } } }, @@ -13243,12 +13305,6 @@ "com.amazonaws.pinpoint#SMSTemplateResponse": { "type": "structure", "members": { - "RecommenderId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the recommender model that's used by the message template.

    " - } - }, "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -13263,23 +13319,23 @@ "smithy.api#required": {} } }, - "TemplateDescription": { + "RecommenderId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom description of the message template.

    " + "smithy.api#documentation": "

    The unique identifier for the recommender model that's used by the message template.

    " } }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "Version": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " } }, - "Arn": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " + "smithy.api#documentation": "

    The name of the message template.

    ", + "smithy.api#required": {} } }, "DefaultSubstitutions": { @@ -13288,6 +13344,12 @@ "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " } }, + "TemplateDescription": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The custom description of the message template.

    " + } + }, "TemplateType": { "target": "com.amazonaws.pinpoint#TemplateType", "traits": { @@ -13295,11 +13357,10 @@ "smithy.api#required": {} } }, - "TemplateName": { + "Arn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " } }, "Body": { @@ -13308,10 +13369,11 @@ "smithy.api#documentation": "

    The message body that's used in text messages that are based on the message template.

    " } }, - "Version": { - "target": "com.amazonaws.pinpoint#__string", + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" } } }, @@ -13322,22 +13384,17 @@ "com.amazonaws.pinpoint#Schedule": { "type": "structure", "members": { - "Frequency": { - "target": "com.amazonaws.pinpoint#Frequency", - "traits": { - "smithy.api#documentation": "

    Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

    " - } - }, - "EventFilter": { - "target": "com.amazonaws.pinpoint#CampaignEventFilter", + "StartTime": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

    " + "smithy.api#documentation": "

    The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

    ", + "smithy.api#required": {} } }, - "IsLocalTime": { - "target": "com.amazonaws.pinpoint#__boolean", + "Timezone": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

    " + "smithy.api#documentation": "

    The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,\n UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,\n UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

    " } }, "QuietTime": { @@ -13346,23 +13403,28 @@ "smithy.api#documentation": "

    The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

    If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

    " } }, - "Timezone": { + "EndTime": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,\n UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,\n UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

    " + "smithy.api#documentation": "

    The scheduled time, in ISO 8601 format, when the campaign ended or will end.

    " } }, - "EndTime": { - "target": "com.amazonaws.pinpoint#__string", + "IsLocalTime": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The scheduled time, in ISO 8601 format, when the campaign ended or will end.

    " + "smithy.api#documentation": "

    Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

    " } }, - "StartTime": { - "target": "com.amazonaws.pinpoint#__string", + "EventFilter": { + "target": "com.amazonaws.pinpoint#CampaignEventFilter", "traits": { - "smithy.api#documentation": "

    The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

    " + } + }, + "Frequency": { + "target": "com.amazonaws.pinpoint#Frequency", + "traits": { + "smithy.api#documentation": "

    Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

    " } } }, @@ -13402,10 +13464,10 @@ "com.amazonaws.pinpoint#SegmentDemographics": { "type": "structure", "members": { - "DeviceType": { + "Channel": { "target": "com.amazonaws.pinpoint#SetDimension", "traits": { - "smithy.api#documentation": "

    The device type criteria for the segment.

    " + "smithy.api#documentation": "

    The channel criteria for the segment.

    " } }, "AppVersion": { @@ -13414,16 +13476,16 @@ "smithy.api#documentation": "

    The app version criteria for the segment.

    " } }, - "Channel": { + "DeviceType": { "target": "com.amazonaws.pinpoint#SetDimension", "traits": { - "smithy.api#documentation": "

    The channel criteria for the segment.

    " + "smithy.api#documentation": "

    The device type criteria for the segment.

    " } }, - "Make": { + "Platform": { "target": "com.amazonaws.pinpoint#SetDimension", "traits": { - "smithy.api#documentation": "

    The device make criteria for the segment.

    " + "smithy.api#documentation": "

    The device platform criteria for the segment.

    " } }, "Model": { @@ -13432,38 +13494,20 @@ "smithy.api#documentation": "

    The device model criteria for the segment.

    " } }, - "Platform": { + "Make": { "target": "com.amazonaws.pinpoint#SetDimension", "traits": { - "smithy.api#documentation": "

    The device platform criteria for the segment.

    " + "smithy.api#documentation": "

    The device make criteria for the segment.

    " } } }, "traits": { "smithy.api#documentation": "

    Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.

    " } - }, - "com.amazonaws.pinpoint#SegmentDimensions": { - "type": "structure", - "members": { - "Behavior": { - "target": "com.amazonaws.pinpoint#SegmentBehaviors", - "traits": { - "smithy.api#documentation": "

    The behavior-based criteria, such as how recently users have used your app, for the segment.

    " - } - }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOfAttributeDimension", - "traits": { - "smithy.api#documentation": "

    One or more custom attributes to use as criteria for the segment.

    " - } - }, - "Demographic": { - "target": "com.amazonaws.pinpoint#SegmentDemographics", - "traits": { - "smithy.api#documentation": "

    The demographic-based criteria, such as device platform, for the segment.

    " - } - }, + }, + "com.amazonaws.pinpoint#SegmentDimensions": { + "type": "structure", + "members": { "Metrics": { "target": "com.amazonaws.pinpoint#MapOfMetricDimension", "traits": { @@ -13481,6 +13525,24 @@ "traits": { "smithy.api#documentation": "

    One or more custom user attributes to use as criteria for the segment.

    " } + }, + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOfAttributeDimension", + "traits": { + "smithy.api#documentation": "

    One or more custom attributes to use as criteria for the segment.

    " + } + }, + "Behavior": { + "target": "com.amazonaws.pinpoint#SegmentBehaviors", + "traits": { + "smithy.api#documentation": "

    The behavior-based criteria, such as how recently users have used your app, for the segment.

    " + } + }, + "Demographic": { + "target": "com.amazonaws.pinpoint#SegmentDemographics", + "traits": { + "smithy.api#documentation": "

    The demographic-based criteria, such as device platform, for the segment.

    " + } } }, "traits": { @@ -13496,10 +13558,10 @@ "smithy.api#documentation": "

    The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

    You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

    " } }, - "Dimensions": { - "target": "com.amazonaws.pinpoint#ListOfSegmentDimensions", + "SourceType": { + "target": "com.amazonaws.pinpoint#SourceType", "traits": { - "smithy.api#documentation": "

    An array that defines the dimensions for the segment.

    " + "smithy.api#documentation": "

    Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

    " } }, "Type": { @@ -13508,10 +13570,10 @@ "smithy.api#documentation": "

    Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

    " } }, - "SourceType": { - "target": "com.amazonaws.pinpoint#SourceType", + "Dimensions": { + "target": "com.amazonaws.pinpoint#ListOfSegmentDimensions", "traits": { - "smithy.api#documentation": "

    Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

    " + "smithy.api#documentation": "

    An array that defines the dimensions for the segment.

    " } } }, @@ -13522,17 +13584,17 @@ "com.amazonaws.pinpoint#SegmentGroupList": { "type": "structure", "members": { - "Include": { - "target": "com.amazonaws.pinpoint#Include", - "traits": { - "smithy.api#documentation": "

    Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

    " - } - }, "Groups": { "target": "com.amazonaws.pinpoint#ListOfSegmentGroup", "traits": { "smithy.api#documentation": "

    An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

    " } + }, + "Include": { + "target": "com.amazonaws.pinpoint#Include", + "traits": { + "smithy.api#documentation": "

    Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

    " + } } }, "traits": { @@ -13549,10 +13611,11 @@ "smithy.api#required": {} } }, - "ChannelCounts": { - "target": "com.amazonaws.pinpoint#MapOf__integer", + "Size": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The number of channel types in the endpoint definitions that were imported to create the segment.

    " + "smithy.api#documentation": "

    The number of endpoint definitions that were imported successfully to create the segment.

    ", + "smithy.api#required": {} } }, "S3Url": { @@ -13562,24 +13625,23 @@ "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.pinpoint#__string", + "Format": { + "target": "com.amazonaws.pinpoint#Format", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    ", + "smithy.api#documentation": "

    The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

    ", "smithy.api#required": {} } }, - "Size": { - "target": "com.amazonaws.pinpoint#__integer", + "ChannelCounts": { + "target": "com.amazonaws.pinpoint#MapOf__integer", "traits": { - "smithy.api#documentation": "

    The number of endpoint definitions that were imported successfully to create the segment.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of channel types in the endpoint definitions that were imported to create the segment.

    " } }, - "Format": { - "target": "com.amazonaws.pinpoint#Format", + "RoleArn": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    ", "smithy.api#required": {} } } @@ -13591,17 +13653,17 @@ "com.amazonaws.pinpoint#SegmentLocation": { "type": "structure", "members": { - "Country": { - "target": "com.amazonaws.pinpoint#SetDimension", - "traits": { - "smithy.api#documentation": "

    The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

    " - } - }, "GPSPoint": { "target": "com.amazonaws.pinpoint#GPSPointDimension", "traits": { "smithy.api#documentation": "

    The GPS location and range for the segment.

    " } + }, + "Country": { + "target": "com.amazonaws.pinpoint#SetDimension", + "traits": { + "smithy.api#documentation": "

    The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

    " + } } }, "traits": { @@ -13632,18 +13694,16 @@ "com.amazonaws.pinpoint#SegmentResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "SegmentGroups": { + "target": "com.amazonaws.pinpoint#SegmentGroupList", "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

    " } }, - "ApplicationId": { + "Name": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application that the segment is associated with.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the segment.

    " } }, "ImportDefinition": { @@ -13652,30 +13712,37 @@ "smithy.api#documentation": "

    The settings for the import job that's associated with the segment.

    " } }, - "SegmentType": { - "target": "com.amazonaws.pinpoint#SegmentType", + "Dimensions": { + "target": "com.amazonaws.pinpoint#SegmentDimensions", "traits": { - "smithy.api#documentation": "

    The segment type. Valid values are:

    • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

    • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The dimension settings for the segment.

    " } }, - "CreationDate": { + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", + "traits": { + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" + } + }, + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time when the segment was created.

    ", + "smithy.api#documentation": "

    The unique identifier for the application that the segment is associated with.

    ", "smithy.api#required": {} } }, - "LastModifiedDate": { + "Arn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date and time when the segment was last modified.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the segment.

    ", + "smithy.api#required": {} } }, - "SegmentGroups": { - "target": "com.amazonaws.pinpoint#SegmentGroupList", + "Version": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

    " + "smithy.api#documentation": "

    The version number of the segment.

    " } }, "Id": { @@ -13685,29 +13752,24 @@ "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.pinpoint#__string", + "SegmentType": { + "target": "com.amazonaws.pinpoint#SegmentType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the segment.

    ", + "smithy.api#documentation": "

    The segment type. Valid values are:

    • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

    • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

    ", "smithy.api#required": {} } }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", - "traits": { - "smithy.api#documentation": "

    The version number of the segment.

    " - } - }, - "Dimensions": { - "target": "com.amazonaws.pinpoint#SegmentDimensions", + "CreationDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The dimension settings for the segment.

    " + "smithy.api#documentation": "

    The date and time when the segment was created.

    ", + "smithy.api#required": {} } }, - "Name": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the segment.

    " + "smithy.api#documentation": "

    The date and time when the segment was last modified.

    " } } }, @@ -13794,18 +13856,18 @@ "com.amazonaws.pinpoint#SendMessagesRequest": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "MessageRequest": { + "target": "com.amazonaws.pinpoint#MessageRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "MessageRequest": { - "target": "com.amazonaws.pinpoint#MessageRequest", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -13826,6 +13888,13 @@ "com.amazonaws.pinpoint#SendUsersMessageRequest": { "type": "structure", "members": { + "Users": { + "target": "com.amazonaws.pinpoint#MapOfEndpointSendConfiguration", + "traits": { + "smithy.api#documentation": "

    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

    ", + "smithy.api#required": {} + } + }, "MessageConfiguration": { "target": "com.amazonaws.pinpoint#DirectMessageConfiguration", "traits": { @@ -13833,11 +13902,10 @@ "smithy.api#required": {} } }, - "Users": { - "target": "com.amazonaws.pinpoint#MapOfEndpointSendConfiguration", + "TraceId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for tracing the message. This identifier is visible to message recipients.

    " } }, "Context": { @@ -13851,12 +13919,6 @@ "traits": { "smithy.api#documentation": "

    The message template to use for the message.

    " } - }, - "TraceId": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for tracing the message. This identifier is visible to message recipients.

    " - } } }, "traits": { @@ -13866,18 +13928,18 @@ "com.amazonaws.pinpoint#SendUsersMessageResponse": { "type": "structure", "members": { - "Result": { - "target": "com.amazonaws.pinpoint#MapOfMapOfEndpointMessageResult", - "traits": { - "smithy.api#documentation": "

    An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

    " - } - }, "RequestId": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The unique identifier that was assigned to the message request.

    " } }, + "Result": { + "target": "com.amazonaws.pinpoint#MapOfMapOfEndpointMessageResult", + "traits": { + "smithy.api#documentation": "

    An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

    " + } + }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -13933,13 +13995,6 @@ "com.amazonaws.pinpoint#SendUsersMessagesRequest": { "type": "structure", "members": { - "SendUsersMessageRequest": { - "target": "com.amazonaws.pinpoint#SendUsersMessageRequest", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -13947,6 +14002,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "SendUsersMessageRequest": { + "target": "com.amazonaws.pinpoint#SendUsersMessageRequest", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -13965,12 +14027,6 @@ "com.amazonaws.pinpoint#Session": { "type": "structure", "members": { - "Duration": { - "target": "com.amazonaws.pinpoint#__integer", - "traits": { - "smithy.api#documentation": "

    The duration of the session, in milliseconds.

    " - } - }, "StopTimestamp": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -13984,6 +14040,12 @@ "smithy.api#required": {} } }, + "Duration": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The duration of the session, in milliseconds.

    " + } + }, "Id": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -14020,13 +14082,6 @@ "com.amazonaws.pinpoint#SimpleCondition": { "type": "structure", "members": { - "SegmentDimensions": { - "target": "com.amazonaws.pinpoint#SegmentDimensions", - "traits": { - "smithy.api#documentation": "

    The dimension settings for the segment that's associated with the activity.

    ", - "smithy.api#jsonName": "segmentDimensions" - } - }, "EventCondition": { "target": "com.amazonaws.pinpoint#EventCondition", "traits": { @@ -14038,6 +14093,13 @@ "traits": { "smithy.api#documentation": "

    The segment that's associated with the activity.

    " } + }, + "SegmentDimensions": { + "target": "com.amazonaws.pinpoint#SegmentDimensions", + "traits": { + "smithy.api#documentation": "

    The dimension settings for the segment that's associated with the activity.

    ", + "smithy.api#jsonName": "segmentDimensions" + } } }, "traits": { @@ -14047,22 +14109,22 @@ "com.amazonaws.pinpoint#SimpleEmail": { "type": "structure", "members": { - "Subject": { + "HtmlPart": { "target": "com.amazonaws.pinpoint#SimpleEmailPart", "traits": { - "smithy.api#documentation": "

    The subject line, or title, of the email.

    " + "smithy.api#documentation": "

    The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

    " } }, - "TextPart": { + "Subject": { "target": "com.amazonaws.pinpoint#SimpleEmailPart", "traits": { - "smithy.api#documentation": "

    The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

    " + "smithy.api#documentation": "

    The subject line, or title, of the email.

    " } }, - "HtmlPart": { + "TextPart": { "target": "com.amazonaws.pinpoint#SimpleEmailPart", "traits": { - "smithy.api#documentation": "

    The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

    " + "smithy.api#documentation": "

    The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

    " } } }, @@ -14118,6 +14180,9 @@ "smithy.api#documentation": "

    The custom description of the condition.

    " } }, + "EventStartCondition": { + "target": "com.amazonaws.pinpoint#EventStartCondition" + }, "SegmentStartCondition": { "target": "com.amazonaws.pinpoint#SegmentCondition", "traits": { @@ -14169,17 +14234,10 @@ "code": 204 } } - }, - "com.amazonaws.pinpoint#TagResourceRequest": { - "type": "structure", - "members": { - "TagsModel": { - "target": "com.amazonaws.pinpoint#TagsModel", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, + }, + "com.amazonaws.pinpoint#TagResourceRequest": { + "type": "structure", + "members": { "ResourceArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -14187,6 +14245,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TagsModel": { + "target": "com.amazonaws.pinpoint#TagsModel", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -14209,16 +14274,16 @@ "com.amazonaws.pinpoint#Template": { "type": "structure", "members": { - "Version": { + "Name": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " + "smithy.api#documentation": "

    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

    " } }, - "Name": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

    " + "smithy.api#documentation": "

    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

    " } } }, @@ -14243,22 +14308,16 @@ "com.amazonaws.pinpoint#TemplateConfiguration": { "type": "structure", "members": { - "SMSTemplate": { - "target": "com.amazonaws.pinpoint#Template", - "traits": { - "smithy.api#documentation": "

    The SMS template to use for the message.

    " - } - }, "EmailTemplate": { "target": "com.amazonaws.pinpoint#Template", "traits": { "smithy.api#documentation": "

    The email template to use for the message.

    " } }, - "PushTemplate": { + "SMSTemplate": { "target": "com.amazonaws.pinpoint#Template", "traits": { - "smithy.api#documentation": "

    The push notification template to use for the message.

    " + "smithy.api#documentation": "

    The SMS template to use for the message.

    " } }, "VoiceTemplate": { @@ -14266,6 +14325,12 @@ "traits": { "smithy.api#documentation": "

    The voice template to use for the message. This object isn't supported for campaigns.

    " } + }, + "PushTemplate": { + "target": "com.amazonaws.pinpoint#Template", + "traits": { + "smithy.api#documentation": "

    The push notification template to use for the message.

    " + } } }, "traits": { @@ -14275,35 +14340,23 @@ "com.amazonaws.pinpoint#TemplateResponse": { "type": "structure", "members": { - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The name of the message template.

    ", - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template.

    " - } - }, "Arn": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

    " } }, - "DefaultSubstitutions": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

    " + "smithy.api#documentation": "

    The name of the message template.

    ", + "smithy.api#required": {} } }, - "TemplateType": { - "target": "com.amazonaws.pinpoint#TemplateType", + "LastModifiedDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

    ", + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was last modified.

    ", "smithy.api#required": {} } }, @@ -14314,6 +14367,12 @@ "smithy.api#required": {} } }, + "TemplateDescription": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

    " + } + }, "tags": { "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { @@ -14321,17 +14380,23 @@ "smithy.api#jsonName": "tags" } }, - "LastModifiedDate": { - "target": "com.amazonaws.pinpoint#__string", + "TemplateType": { + "target": "com.amazonaws.pinpoint#TemplateType", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was last modified.

    ", + "smithy.api#documentation": "

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

    ", "smithy.api#required": {} } }, - "TemplateDescription": { + "DefaultSubstitutions": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

    " + "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

    " + } + }, + "Version": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template.

    " } } }, @@ -14372,17 +14437,17 @@ "smithy.api#required": {} } }, - "LastModifiedDate": { + "TemplateType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the version of the message template was last modified.

    ", + "smithy.api#documentation": "

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

    ", "smithy.api#required": {} } }, - "TemplateType": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

    ", + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the version of the message template was last modified.

    ", "smithy.api#required": {} } }, @@ -14392,10 +14457,11 @@ "smithy.api#documentation": "

    The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.

    " } }, - "DefaultSubstitutions": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " + "smithy.api#documentation": "

    The name of the message template.

    ", + "smithy.api#required": {} } }, "TemplateDescription": { @@ -14404,11 +14470,10 @@ "smithy.api#documentation": "

    The custom description of the version of the message template.

    " } }, - "TemplateName": { + "DefaultSubstitutions": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " } } }, @@ -14431,18 +14496,18 @@ "smithy.api#documentation": "

    The message that's returned from the API for the request to retrieve information about all the versions of the message template.

    " } }, + "RequestID": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the request to retrieve information about all the versions of the message template.

    " + } + }, "Item": { "target": "com.amazonaws.pinpoint#ListOfTemplateVersionResponse", "traits": { "smithy.api#documentation": "

    An array of responses, one for each version of the message template.

    ", "smithy.api#required": {} } - }, - "RequestID": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the request to retrieve information about all the versions of the message template.

    " - } } }, "traits": { @@ -14495,10 +14560,16 @@ "com.amazonaws.pinpoint#TreatmentResource": { "type": "structure", "members": { - "TemplateConfiguration": { - "target": "com.amazonaws.pinpoint#TemplateConfiguration", + "State": { + "target": "com.amazonaws.pinpoint#CampaignState", "traits": { - "smithy.api#documentation": "

    The message template to use for the treatment.

    " + "smithy.api#documentation": "

    The current status of the treatment.

    " + } + }, + "TreatmentName": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The custom name of the treatment.

    " } }, "Schedule": { @@ -14507,10 +14578,11 @@ "smithy.api#documentation": "

    The schedule settings for the treatment.

    " } }, - "TreatmentName": { + "Id": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom name of the treatment.

    " + "smithy.api#documentation": "

    The unique identifier for the treatment.

    ", + "smithy.api#required": {} } }, "SizePercent": { @@ -14520,35 +14592,28 @@ "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.pinpoint#CampaignState", - "traits": { - "smithy.api#documentation": "

    The current status of the treatment.

    " - } - }, "MessageConfiguration": { "target": "com.amazonaws.pinpoint#MessageConfiguration", "traits": { "smithy.api#documentation": "

    The message configuration settings for the treatment.

    " } }, - "TreatmentDescription": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The custom description of the treatment.

    " - } - }, "CustomDeliveryConfiguration": { "target": "com.amazonaws.pinpoint#CustomDeliveryConfiguration", "traits": { "smithy.api#documentation": "

    The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

    " } }, - "Id": { + "TreatmentDescription": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the treatment.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The custom description of the treatment.

    " + } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.pinpoint#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "

    The message template to use for the treatment.

    " } } }, @@ -14869,13 +14934,6 @@ "com.amazonaws.pinpoint#UpdateApnsVoipChannelRequest": { "type": "structure", "members": { - "APNSVoipChannelRequest": { - "target": "com.amazonaws.pinpoint#APNSVoipChannelRequest", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -14883,6 +14941,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "APNSVoipChannelRequest": { + "target": "com.amazonaws.pinpoint#APNSVoipChannelRequest", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -15099,18 +15164,18 @@ "com.amazonaws.pinpoint#UpdateBaiduChannelRequest": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "BaiduChannelRequest": { + "target": "com.amazonaws.pinpoint#BaiduChannelRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "BaiduChannelRequest": { - "target": "com.amazonaws.pinpoint#BaiduChannelRequest", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -15171,18 +15236,18 @@ "com.amazonaws.pinpoint#UpdateCampaignRequest": { "type": "structure", "members": { - "CampaignId": { + "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "CampaignId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#documentation": "

    The unique identifier for the campaign.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15323,11 +15388,11 @@ "com.amazonaws.pinpoint#UpdateEmailTemplateRequest": { "type": "structure", "members": { - "EmailTemplateRequest": { - "target": "com.amazonaws.pinpoint#EmailTemplateRequest", + "Version": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" } }, "CreateNewVersion": { @@ -15337,19 +15402,19 @@ "smithy.api#httpQuery": "create-new-version" } }, - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", + "EmailTemplateRequest": { + "target": "com.amazonaws.pinpoint#EmailTemplateRequest", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "Version": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -15417,13 +15482,6 @@ "smithy.api#required": {} } }, - "EndpointRequest": { - "target": "com.amazonaws.pinpoint#EndpointRequest", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "EndpointId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -15431,6 +15489,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "EndpointRequest": { + "target": "com.amazonaws.pinpoint#EndpointRequest", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -15489,18 +15554,18 @@ "com.amazonaws.pinpoint#UpdateEndpointsBatchRequest": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "EndpointBatchRequest": { + "target": "com.amazonaws.pinpoint#EndpointBatchRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "EndpointBatchRequest": { - "target": "com.amazonaws.pinpoint#EndpointBatchRequest", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -15561,13 +15626,6 @@ "com.amazonaws.pinpoint#UpdateGcmChannelRequest": { "type": "structure", "members": { - "GCMChannelRequest": { - "target": "com.amazonaws.pinpoint#GCMChannelRequest", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -15575,6 +15633,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "GCMChannelRequest": { + "target": "com.amazonaws.pinpoint#GCMChannelRequest", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -15602,6 +15667,9 @@ { "target": "com.amazonaws.pinpoint#BadRequestException" }, + { + "target": "com.amazonaws.pinpoint#ConflictException" + }, { "target": "com.amazonaws.pinpoint#ForbiddenException" }, @@ -15633,10 +15701,11 @@ "com.amazonaws.pinpoint#UpdateJourneyRequest": { "type": "structure", "members": { - "WriteJourneyRequest": { - "target": "com.amazonaws.pinpoint#WriteJourneyRequest", + "JourneyId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the journey.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -15648,11 +15717,10 @@ "smithy.api#required": {} } }, - "JourneyId": { - "target": "com.amazonaws.pinpoint#__string", + "WriteJourneyRequest": { + "target": "com.amazonaws.pinpoint#WriteJourneyRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the journey.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } } @@ -15713,11 +15781,10 @@ "com.amazonaws.pinpoint#UpdateJourneyStateRequest": { "type": "structure", "members": { - "JourneyId": { - "target": "com.amazonaws.pinpoint#__string", + "JourneyStateRequest": { + "target": "com.amazonaws.pinpoint#JourneyStateRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the journey.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, @@ -15729,10 +15796,11 @@ "smithy.api#required": {} } }, - "JourneyStateRequest": { - "target": "com.amazonaws.pinpoint#JourneyStateRequest", + "JourneyId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the journey.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -15793,11 +15861,11 @@ "com.amazonaws.pinpoint#UpdatePushTemplateRequest": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.pinpoint#__string", + "PushNotificationTemplateRequest": { + "target": "com.amazonaws.pinpoint#PushNotificationTemplateRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } }, "TemplateName": { @@ -15815,11 +15883,11 @@ "smithy.api#httpQuery": "create-new-version" } }, - "PushNotificationTemplateRequest": { - "target": "com.amazonaws.pinpoint#PushNotificationTemplateRequest", + "Version": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" } } } @@ -15879,13 +15947,6 @@ "com.amazonaws.pinpoint#UpdateRecommenderConfigurationRequest": { "type": "structure", "members": { - "UpdateRecommenderConfiguration": { - "target": "com.amazonaws.pinpoint#UpdateRecommenderConfigurationShape", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "RecommenderId": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -15893,6 +15954,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "UpdateRecommenderConfiguration": { + "target": "com.amazonaws.pinpoint#UpdateRecommenderConfigurationShape", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -15911,35 +15979,34 @@ "com.amazonaws.pinpoint#UpdateRecommenderConfigurationShape": { "type": "structure", "members": { - "RecommendationTransformerUri": { - "target": "com.amazonaws.pinpoint#__string", + "Attributes": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

    " + "smithy.api#documentation": "

    A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

    • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.

    • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

    " } }, - "RecommendationsPerMessage": { - "target": "com.amazonaws.pinpoint#__integer", + "RecommendationTransformerUri": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

    To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

    " } }, - "RecommendationsDisplayName": { + "RecommendationProviderIdType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

    " + "smithy.api#documentation": "

    The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

    • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

    • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

    " } }, - "Attributes": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "Name": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

    • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.

    • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

    " + "smithy.api#documentation": "

    A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    " } }, - "RecommendationProviderRoleArn": { - "target": "com.amazonaws.pinpoint#__string", + "RecommendationsPerMessage": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

    To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    " } }, "RecommendationProviderUri": { @@ -15949,22 +16016,23 @@ "smithy.api#required": {} } }, - "Description": { + "RecommendationsDisplayName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

    " + "smithy.api#documentation": "

    A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

    " } }, - "RecommendationProviderIdType": { + "Description": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

    • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

    • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

    " + "smithy.api#documentation": "

    A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

    " } }, - "Name": { + "RecommendationProviderRoleArn": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

    ", + "smithy.api#required": {} } } }, @@ -16023,18 +16091,18 @@ "smithy.api#required": {} } }, - "ApplicationId": { - "target": "com.amazonaws.pinpoint#__string", + "WriteSegmentRequest": { + "target": "com.amazonaws.pinpoint#WriteSegmentRequest", "traits": { - "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "WriteSegmentRequest": { - "target": "com.amazonaws.pinpoint#WriteSegmentRequest", + "ApplicationId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -16182,19 +16250,19 @@ "smithy.api#required": {} } }, - "Version": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", - "smithy.api#httpQuery": "version" - } - }, "SMSTemplateRequest": { "target": "com.amazonaws.pinpoint#SMSTemplateRequest", "traits": { "smithy.api#httpPayload": {}, "smithy.api#required": {} } + }, + "Version": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

    If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

    If you don't specify a value for this parameter, Amazon Pinpoint does the following:

    • For a get operation, retrieves information about the active version of the template.

    • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

    • For a delete operation, deletes the template, including all versions of the template.

    ", + "smithy.api#httpQuery": "version" + } } } }, @@ -16262,18 +16330,18 @@ "smithy.api#required": {} } }, - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", + "TemplateActiveVersionRequest": { + "target": "com.amazonaws.pinpoint#TemplateActiveVersionRequest", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "TemplateActiveVersionRequest": { - "target": "com.amazonaws.pinpoint#TemplateActiveVersionRequest", + "TemplateName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -16406,18 +16474,10 @@ "com.amazonaws.pinpoint#UpdateVoiceTemplateRequest": { "type": "structure", "members": { - "CreateNewVersion": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

    ", - "smithy.api#httpQuery": "create-new-version" - } - }, - "TemplateName": { - "target": "com.amazonaws.pinpoint#__string", + "VoiceTemplateRequest": { + "target": "com.amazonaws.pinpoint#VoiceTemplateRequest", "traits": { - "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, @@ -16428,12 +16488,20 @@ "smithy.api#httpQuery": "version" } }, - "VoiceTemplateRequest": { - "target": "com.amazonaws.pinpoint#VoiceTemplateRequest", + "TemplateName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "CreateNewVersion": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

    If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

    ", + "smithy.api#httpQuery": "create-new-version" + } } } }, @@ -16466,16 +16534,28 @@ "com.amazonaws.pinpoint#VoiceChannelResponse": { "type": "structure", "members": { + "Enabled": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the voice channel is enabled for the application.

    " + } + }, + "Version": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The current version of the voice channel.

    " + } + }, "ApplicationId": { "target": "com.amazonaws.pinpoint#__string", "traits": { "smithy.api#documentation": "

    The unique identifier for the application that the voice channel applies to.

    " } }, - "HasCredential": { - "target": "com.amazonaws.pinpoint#__boolean", + "LastModifiedBy": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + "smithy.api#documentation": "

    The user who last modified the voice channel.

    " } }, "CreationDate": { @@ -16490,12 +16570,6 @@ "smithy.api#documentation": "

    The date and time, in ISO 8601 format, when the voice channel was last modified.

    " } }, - "Enabled": { - "target": "com.amazonaws.pinpoint#__boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether the voice channel is enabled for the application.

    " - } - }, "IsArchived": { "target": "com.amazonaws.pinpoint#__boolean", "traits": { @@ -16515,16 +16589,10 @@ "smithy.api#documentation": "

    (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

    " } }, - "LastModifiedBy": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The user who last modified the voice channel.

    " - } - }, - "Version": { - "target": "com.amazonaws.pinpoint#__integer", + "HasCredential": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The current version of the voice channel.

    " + "smithy.api#documentation": "

    (Not used) This property is retained only for backward compatibility.

    " } } }, @@ -16541,16 +16609,16 @@ "smithy.api#documentation": "

    The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

    " } }, - "Body": { + "LanguageCode": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The text of the script to use for the voice message.

    " + "smithy.api#documentation": "

    The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    " } }, - "LanguageCode": { - "target": "com.amazonaws.pinpoint#__string", + "Substitutions": { + "target": "com.amazonaws.pinpoint#MapOfListOf__string", "traits": { - "smithy.api#documentation": "

    The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    " + "smithy.api#documentation": "

    The default message variables to use in the voice message. You can override the default variables with individual address variables.

    " } }, "VoiceId": { @@ -16559,10 +16627,10 @@ "smithy.api#documentation": "

    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

    " } }, - "Substitutions": { - "target": "com.amazonaws.pinpoint#MapOfListOf__string", + "Body": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The default message variables to use in the voice message. You can override the default variables with individual address variables.

    " + "smithy.api#documentation": "

    The text of the script to use for the voice message.

    " } } }, @@ -16573,22 +16641,22 @@ "com.amazonaws.pinpoint#VoiceTemplateRequest": { "type": "structure", "members": { - "DefaultSubstitutions": { + "TemplateDescription": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    " + "smithy.api#documentation": "

    A custom description of the message template.

    " } }, - "VoiceId": { + "LanguageCode": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

    " + "smithy.api#documentation": "

    The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    " } }, - "Body": { + "VoiceId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The text of the script to use in messages that are based on the message template, in plain text format.

    " + "smithy.api#documentation": "

    The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

    " } }, "tags": { @@ -16598,16 +16666,16 @@ "smithy.api#jsonName": "tags" } }, - "LanguageCode": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    " + "smithy.api#documentation": "

    The text of the script to use in messages that are based on the message template, in plain text format.

    " } }, - "TemplateDescription": { + "DefaultSubstitutions": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom description of the message template.

    " + "smithy.api#documentation": "

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

    " } } }, @@ -16618,48 +16686,49 @@ "com.amazonaws.pinpoint#VoiceTemplateResponse": { "type": "structure", "members": { - "LastModifiedDate": { + "Body": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was last modified.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The text of the script that's used in messages that are based on the message template, in plain text format.

    " } }, - "CreationDate": { - "target": "com.amazonaws.pinpoint#__string", + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" } }, - "LanguageCode": { + "DefaultSubstitutions": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    " + "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " } }, - "TemplateDescription": { + "VoiceId": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The custom description of the message template.

    " + "smithy.api#documentation": "

    The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

    " } }, - "Version": { + "TemplateName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " + "smithy.api#documentation": "

    The name of the message template.

    ", + "smithy.api#required": {} } }, - "DefaultSubstitutions": { - "target": "com.amazonaws.pinpoint#__string", + "TemplateType": { + "target": "com.amazonaws.pinpoint#TemplateType", "traits": { - "smithy.api#documentation": "

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

    " + "smithy.api#documentation": "

    The type of channel that the message template is designed for. For a voice template, this value is VOICE.

    ", + "smithy.api#required": {} } }, - "VoiceId": { + "Version": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

    " + "smithy.api#documentation": "

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

    " } }, "Arn": { @@ -16668,30 +16737,29 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " } }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "CreationDate": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was created.

    ", + "smithy.api#required": {} } }, - "TemplateType": { - "target": "com.amazonaws.pinpoint#TemplateType", + "LanguageCode": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. For a voice template, this value is VOICE.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    " } }, - "Body": { + "TemplateDescription": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The text of the script that's used in messages that are based on the message template, in plain text format.

    " + "smithy.api#documentation": "

    The custom description of the message template.

    " } }, - "TemplateName": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The name of the message template.

    ", + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the message template was last modified.

    ", "smithy.api#required": {} } } @@ -16703,17 +16771,17 @@ "com.amazonaws.pinpoint#WaitActivity": { "type": "structure", "members": { - "NextActivity": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after performing the wait activity.

    " - } - }, "WaitTime": { "target": "com.amazonaws.pinpoint#WaitTime", "traits": { "smithy.api#documentation": "

    The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

    " } + }, + "NextActivity": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the next activity to perform, after performing the wait activity.

    " + } } }, "traits": { @@ -16749,16 +16817,19 @@ "smithy.api#documentation": "

    The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

    " } }, + "EventTaggingEnabled": { + "target": "com.amazonaws.pinpoint#__boolean" + }, "Limits": { "target": "com.amazonaws.pinpoint#CampaignLimits", "traits": { - "smithy.api#documentation": "

    The default sending limits for campaigns and journeys in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

    " + "smithy.api#documentation": "

    The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

    " } }, "QuietTime": { "target": "com.amazonaws.pinpoint#QuietTime", "traits": { - "smithy.api#documentation": "

    The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

    " + "smithy.api#documentation": "

    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

    " } }, "CloudWatchMetricsEnabled": { @@ -16781,34 +16852,35 @@ "smithy.api#documentation": "

    The messaging limits for the campaign.

    " } }, - "TreatmentDescription": { - "target": "com.amazonaws.pinpoint#__string", + "AdditionalTreatments": { + "target": "com.amazonaws.pinpoint#ListOfWriteTreatmentResource", "traits": { - "smithy.api#documentation": "

    A custom description of the default treatment for the campaign.

    " + "smithy.api#documentation": "

    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

    " } }, - "CustomDeliveryConfiguration": { - "target": "com.amazonaws.pinpoint#CustomDeliveryConfiguration", + "IsPaused": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

    " + "smithy.api#documentation": "

    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

    " } }, - "SegmentId": { + "Name": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The unique identifier for the segment to associate with the campaign.

    " + "smithy.api#documentation": "

    A custom name for the campaign.

    " } }, - "Hook": { - "target": "com.amazonaws.pinpoint#CampaignHook", + "tags": { + "target": "com.amazonaws.pinpoint#MapOf__string", "traits": { - "smithy.api#documentation": "

    The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

    " + "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

    ", + "smithy.api#jsonName": "tags" } }, - "TreatmentName": { - "target": "com.amazonaws.pinpoint#__string", + "MessageConfiguration": { + "target": "com.amazonaws.pinpoint#MessageConfiguration", "traits": { - "smithy.api#documentation": "

    A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

    " + "smithy.api#documentation": "

    The message configuration settings for the campaign.

    " } }, "Description": { @@ -16817,59 +16889,58 @@ "smithy.api#documentation": "

    A custom description of the campaign.

    " } }, - "HoldoutPercent": { - "target": "com.amazonaws.pinpoint#__integer", + "Hook": { + "target": "com.amazonaws.pinpoint#CampaignHook", "traits": { - "smithy.api#documentation": "

    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

    " + "smithy.api#documentation": "

    The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

    " } }, - "Schedule": { - "target": "com.amazonaws.pinpoint#Schedule", + "SegmentVersion": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    The schedule settings for the campaign.

    " + "smithy.api#documentation": "

    The version of the segment to associate with the campaign.

    " } }, - "AdditionalTreatments": { - "target": "com.amazonaws.pinpoint#ListOfWriteTreatmentResource", + "TemplateConfiguration": { + "target": "com.amazonaws.pinpoint#TemplateConfiguration", "traits": { - "smithy.api#documentation": "

    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

    " + "smithy.api#documentation": "

    The message template to use for the campaign.

    " } }, - "tags": { - "target": "com.amazonaws.pinpoint#MapOf__string", + "TreatmentName": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

    " } }, - "MessageConfiguration": { - "target": "com.amazonaws.pinpoint#MessageConfiguration", + "Schedule": { + "target": "com.amazonaws.pinpoint#Schedule", "traits": { - "smithy.api#documentation": "

    The message configuration settings for the campaign.

    " + "smithy.api#documentation": "

    The schedule settings for the campaign.

    " } }, - "IsPaused": { - "target": "com.amazonaws.pinpoint#__boolean", + "HoldoutPercent": { + "target": "com.amazonaws.pinpoint#__integer", "traits": { - "smithy.api#documentation": "

    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

    " + "smithy.api#documentation": "

    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

    " } }, - "TemplateConfiguration": { - "target": "com.amazonaws.pinpoint#TemplateConfiguration", + "CustomDeliveryConfiguration": { + "target": "com.amazonaws.pinpoint#CustomDeliveryConfiguration", "traits": { - "smithy.api#documentation": "

    The message template to use for the campaign.

    " + "smithy.api#documentation": "

    The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

    " } }, - "Name": { + "TreatmentDescription": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom name for the campaign.

    " + "smithy.api#documentation": "

    A custom description of the default treatment for the campaign.

    " } }, - "SegmentVersion": { - "target": "com.amazonaws.pinpoint#__integer", + "SegmentId": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The version of the segment to associate with the campaign.

    " + "smithy.api#documentation": "

    The unique identifier for the segment to associate with the campaign.

    " } } }, @@ -16902,35 +16973,34 @@ "com.amazonaws.pinpoint#WriteJourneyRequest": { "type": "structure", "members": { - "StartCondition": { - "target": "com.amazonaws.pinpoint#StartCondition", + "LocalTime": { + "target": "com.amazonaws.pinpoint#__boolean", "traits": { - "smithy.api#documentation": "

    The segment that defines which users are participants in the journey.

    " + "smithy.api#documentation": "

    Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

    " } }, - "State": { - "target": "com.amazonaws.pinpoint#State", + "Schedule": { + "target": "com.amazonaws.pinpoint#JourneySchedule", "traits": { - "smithy.api#documentation": "

    The status of the journey. Valid values are:

    • DRAFT - Saves the journey and doesn't publish it.

    • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

    The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

    " + "smithy.api#documentation": "

    The schedule settings for the journey.

    " } }, - "Name": { - "target": "com.amazonaws.pinpoint#__string", + "StartCondition": { + "target": "com.amazonaws.pinpoint#StartCondition", "traits": { - "smithy.api#documentation": "

    The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The segment that defines which users are participants in the journey.

    " } }, - "StartActivity": { - "target": "com.amazonaws.pinpoint#__string", + "Activities": { + "target": "com.amazonaws.pinpoint#MapOfActivity", "traits": { - "smithy.api#documentation": "

    The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

    " + "smithy.api#documentation": "

    A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

    " } }, - "RefreshFrequency": { + "LastModifiedDate": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    " + "smithy.api#documentation": "

    The date, in ISO 8601 format, when the journey was last modified.

    " } }, "CreationDate": { @@ -16939,16 +17009,16 @@ "smithy.api#documentation": "

    The date, in ISO 8601 format, when the journey was created.

    " } }, - "Activities": { - "target": "com.amazonaws.pinpoint#MapOfActivity", + "State": { + "target": "com.amazonaws.pinpoint#State", "traits": { - "smithy.api#documentation": "

    A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

    " + "smithy.api#documentation": "

    The status of the journey. Valid values are:

    • DRAFT - Saves the journey and doesn't publish it.

    • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

    The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

    " } }, - "LastModifiedDate": { + "StartActivity": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The date, in ISO 8601 format, when the journey was last modified.

    " + "smithy.api#documentation": "

    The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

    " } }, "QuietTime": { @@ -16957,22 +17027,23 @@ "smithy.api#documentation": "

    The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

    • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

    • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

    If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

    " } }, - "Limits": { - "target": "com.amazonaws.pinpoint#JourneyLimits", + "Name": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The messaging and entry limits for the journey.

    " + "smithy.api#documentation": "

    The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

    ", + "smithy.api#required": {} } }, - "LocalTime": { - "target": "com.amazonaws.pinpoint#__boolean", + "Limits": { + "target": "com.amazonaws.pinpoint#JourneyLimits", "traits": { - "smithy.api#documentation": "

    Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

    " + "smithy.api#documentation": "

    The messaging and entry limits for the journey.

    " } }, - "Schedule": { - "target": "com.amazonaws.pinpoint#JourneySchedule", + "RefreshFrequency": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The schedule settings for the journey.

    " + "smithy.api#documentation": "

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    " } } }, @@ -16983,10 +17054,16 @@ "com.amazonaws.pinpoint#WriteSegmentRequest": { "type": "structure", "members": { - "Dimensions": { - "target": "com.amazonaws.pinpoint#SegmentDimensions", + "SegmentGroups": { + "target": "com.amazonaws.pinpoint#SegmentGroupList", "traits": { - "smithy.api#documentation": "

    The criteria that define the dimensions for the segment.

    " + "smithy.api#documentation": "

    The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

    " + } + }, + "Name": { + "target": "com.amazonaws.pinpoint#__string", + "traits": { + "smithy.api#documentation": "

    The name of the segment.

    " } }, "tags": { @@ -16996,16 +17073,10 @@ "smithy.api#jsonName": "tags" } }, - "Name": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    The name of the segment.

    " - } - }, - "SegmentGroups": { - "target": "com.amazonaws.pinpoint#SegmentGroupList", + "Dimensions": { + "target": "com.amazonaws.pinpoint#SegmentDimensions", "traits": { - "smithy.api#documentation": "

    The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

    " + "smithy.api#documentation": "

    The criteria that define the dimensions for the segment.

    " } } }, @@ -17016,11 +17087,16 @@ "com.amazonaws.pinpoint#WriteTreatmentResource": { "type": "structure", "members": { - "SizePercent": { - "target": "com.amazonaws.pinpoint#__integer", + "TreatmentDescription": { + "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The allocated percentage of users (segment members) to send the treatment to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A custom description of the treatment.

    " + } + }, + "TemplateConfiguration": { + "target": "com.amazonaws.pinpoint#TemplateConfiguration", + "traits": { + "smithy.api#documentation": "

    The message template to use for the treatment.

    " } }, "Schedule": { @@ -17029,10 +17105,17 @@ "smithy.api#documentation": "

    The schedule settings for the treatment.

    " } }, - "TreatmentDescription": { + "TreatmentName": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    A custom description of the treatment.

    " + "smithy.api#documentation": "

    A custom name for the treatment.

    " + } + }, + "SizePercent": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The allocated percentage of users (segment members) to send the treatment to.

    ", + "smithy.api#required": {} } }, "CustomDeliveryConfiguration": { @@ -17046,18 +17129,6 @@ "traits": { "smithy.api#documentation": "

    The message configuration settings for the treatment.

    " } - }, - "TreatmentName": { - "target": "com.amazonaws.pinpoint#__string", - "traits": { - "smithy.api#documentation": "

    A custom name for the treatment.

    " - } - }, - "TemplateConfiguration": { - "target": "com.amazonaws.pinpoint#TemplateConfiguration", - "traits": { - "smithy.api#documentation": "

    The message template to use for the treatment.

    " - } } }, "traits": { 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 66a1b19e5d95..856b24b98322 100644 --- a/codegen/sdk-codegen/aws-models/polly.2016-06-10.json +++ b/codegen/sdk-codegen/aws-models/polly.2016-06-10.json @@ -114,20 +114,6 @@ "com.amazonaws.polly#DescribeVoicesInput": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.polly#LanguageCode", - "traits": { - "smithy.api#documentation": "

    \n \n The language identification tag (ISO 639 code for the language name-ISO 3166 country code) \n for filtering the list of voices returned. \n If you don't specify this optional parameter, all available voices are returned.\n

    ", - "smithy.api#httpQuery": "LanguageCode" - } - }, - "NextToken": { - "target": "com.amazonaws.polly#NextToken", - "traits": { - "smithy.api#documentation": "

    An opaque pagination token returned from the previous \n DescribeVoices operation. If present, this indicates where to \n continue the listing.

    ", - "smithy.api#httpQuery": "NextToken" - } - }, "IncludeAdditionalLanguageCodes": { "target": "com.amazonaws.polly#IncludeAdditionalLanguageCodes", "traits": { @@ -141,6 +127,20 @@ "smithy.api#documentation": "

    Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.

    ", "smithy.api#httpQuery": "Engine" } + }, + "NextToken": { + "target": "com.amazonaws.polly#NextToken", + "traits": { + "smithy.api#documentation": "

    An opaque pagination token returned from the previous \n DescribeVoices operation. If present, this indicates where to \n continue the listing.

    ", + "smithy.api#httpQuery": "NextToken" + } + }, + "LanguageCode": { + "target": "com.amazonaws.polly#LanguageCode", + "traits": { + "smithy.api#documentation": "

    \n \n The language identification tag (ISO 639 code for the language name-ISO 3166 country code) \n for filtering the list of voices returned. \n If you don't specify this optional parameter, all available voices are returned.\n

    ", + "smithy.api#httpQuery": "LanguageCode" + } } } }, @@ -573,30 +573,30 @@ "com.amazonaws.polly#LexiconAttributes": { "type": "structure", "members": { - "LastModified": { - "target": "com.amazonaws.polly#LastModified", - "traits": { - "smithy.api#documentation": "

    Date lexicon was last modified (a timestamp value).

    " - } - }, "Alphabet": { "target": "com.amazonaws.polly#Alphabet", "traits": { "smithy.api#documentation": "

    Phonetic alphabet used in the lexicon.\n Valid values are ipa and x-sampa.

    " } }, - "LexiconArn": { - "target": "com.amazonaws.polly#LexiconArn", - "traits": { - "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the lexicon.

    " - } - }, "LanguageCode": { "target": "com.amazonaws.polly#LanguageCode", "traits": { "smithy.api#documentation": "

    Language code that the lexicon applies to.\n A lexicon with a language code such as \"en\" would be\n applied to all English languages (en-GB, en-US, en-AUS,\n en-WLS, and so on.

    " } }, + "LastModified": { + "target": "com.amazonaws.polly#LastModified", + "traits": { + "smithy.api#documentation": "

    Date lexicon was last modified (a timestamp value).

    " + } + }, + "LexiconArn": { + "target": "com.amazonaws.polly#LexiconArn", + "traits": { + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the lexicon.

    " + } + }, "Size": { "target": "com.amazonaws.polly#Size", "traits": { @@ -620,17 +620,17 @@ "com.amazonaws.polly#LexiconDescription": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.polly#LexiconName", - "traits": { - "smithy.api#documentation": "

    Name of the lexicon.

    " - } - }, "Attributes": { "target": "com.amazonaws.polly#LexiconAttributes", "traits": { "smithy.api#documentation": "

    Provides lexicon metadata.

    " } + }, + "Name": { + "target": "com.amazonaws.polly#LexiconName", + "traits": { + "smithy.api#documentation": "

    Name of the lexicon.

    " + } } }, "traits": { @@ -728,17 +728,17 @@ "com.amazonaws.polly#ListLexiconsOutput": { "type": "structure", "members": { - "Lexicons": { - "target": "com.amazonaws.polly#LexiconDescriptionList", - "traits": { - "smithy.api#documentation": "

    A list of lexicon names and attributes.

    " - } - }, "NextToken": { "target": "com.amazonaws.polly#NextToken", "traits": { "smithy.api#documentation": "

    The pagination token to use in the next request to continue \n the listing of lexicons. NextToken is returned only if \n the response is truncated.

    " } + }, + "Lexicons": { + "target": "com.amazonaws.polly#LexiconDescriptionList", + "traits": { + "smithy.api#documentation": "

    A list of lexicon names and attributes.

    " + } } } }, @@ -782,19 +782,19 @@ "smithy.api#httpQuery": "MaxResults" } }, - "NextToken": { - "target": "com.amazonaws.polly#NextToken", - "traits": { - "smithy.api#documentation": "

    The pagination token to use in the next request to continue the listing of speech synthesis \n tasks.

    ", - "smithy.api#httpQuery": "NextToken" - } - }, "Status": { "target": "com.amazonaws.polly#TaskStatus", "traits": { "smithy.api#documentation": "

    Status of the speech synthesis tasks returned in a List operation

    ", "smithy.api#httpQuery": "Status" } + }, + "NextToken": { + "target": "com.amazonaws.polly#NextToken", + "traits": { + "smithy.api#documentation": "

    The pagination token to use in the next request to continue the listing of speech synthesis \n tasks.

    ", + "smithy.api#httpQuery": "NextToken" + } } } }, @@ -948,7 +948,7 @@ "sdkId": "Polly", "arnNamespace": "polly", "cloudFormationName": "Polly", - "cloudTrailEventSource": "v1.parrot.amazonaws.com" + "cloudTrailEventSource": "polly.amazonaws.com" }, "aws.auth#sigv4": { "name": "polly" @@ -1004,13 +1004,6 @@ "com.amazonaws.polly#PutLexiconInput": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.polly#LexiconContent", - "traits": { - "smithy.api#documentation": "

    Content of the PLS lexicon as string data.

    ", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.polly#LexiconName", "traits": { @@ -1018,6 +1011,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Content": { + "target": "com.amazonaws.polly#LexiconContent", + "traits": { + "smithy.api#documentation": "

    Content of the PLS lexicon as string data.

    ", + "smithy.api#required": {} + } } } }, @@ -1159,28 +1159,16 @@ "com.amazonaws.polly#StartSpeechSynthesisTaskInput": { "type": "structure", "members": { - "SampleRate": { - "target": "com.amazonaws.polly#SampleRate", - "traits": { - "smithy.api#documentation": "

    The audio frequency specified in Hz.

    \n

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The \n default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    \n

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " - } - }, - "SpeechMarkTypes": { - "target": "com.amazonaws.polly#SpeechMarkTypeList", - "traits": { - "smithy.api#documentation": "

    The type of speech marks returned for the input text.

    " - } - }, - "LanguageCode": { - "target": "com.amazonaws.polly#LanguageCode", + "TextType": { + "target": "com.amazonaws.polly#TextType", "traits": { - "smithy.api#documentation": "

    Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, \n such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    \n

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. \n The default language for any voice is the one returned by the DescribeVoices \n operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    " + "smithy.api#documentation": "

    Specifies whether the input text is plain text or SSML. The default value is plain text.

    " } }, - "LexiconNames": { - "target": "com.amazonaws.polly#LexiconNameList", + "OutputS3KeyPrefix": { + "target": "com.amazonaws.polly#OutputS3KeyPrefix", "traits": { - "smithy.api#documentation": "

    List of one or more pronunciation lexicon names you want the service \n to apply during synthesis. Lexicons are applied only if the language \n of the lexicon is the same as the language of the voice.

    " + "smithy.api#documentation": "

    The Amazon S3 key prefix for the output speech file.

    " } }, "OutputS3BucketName": { @@ -1190,22 +1178,22 @@ "smithy.api#required": {} } }, - "Engine": { - "target": "com.amazonaws.polly#Engine", + "LanguageCode": { + "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.

    " + "smithy.api#documentation": "

    Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, \n such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    \n

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. \n The default language for any voice is the one returned by the DescribeVoices \n operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    " } }, - "OutputS3KeyPrefix": { - "target": "com.amazonaws.polly#OutputS3KeyPrefix", + "SpeechMarkTypes": { + "target": "com.amazonaws.polly#SpeechMarkTypeList", "traits": { - "smithy.api#documentation": "

    The Amazon S3 key prefix for the output speech file.

    " + "smithy.api#documentation": "

    The type of speech marks returned for the input text.

    " } }, - "TextType": { - "target": "com.amazonaws.polly#TextType", + "SampleRate": { + "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

    Specifies whether the input text is plain text or SSML. The default value is plain text.

    " + "smithy.api#documentation": "

    The audio frequency specified in Hz.

    \n

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The \n default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    \n

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " } }, "SnsTopicArn": { @@ -1214,6 +1202,13 @@ "smithy.api#documentation": "

    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

    " } }, + "VoiceId": { + "target": "com.amazonaws.polly#VoiceId", + "traits": { + "smithy.api#documentation": "

    Voice ID to use for the synthesis.

    ", + "smithy.api#required": {} + } + }, "Text": { "target": "com.amazonaws.polly#Text", "traits": { @@ -1221,11 +1216,10 @@ "smithy.api#required": {} } }, - "VoiceId": { - "target": "com.amazonaws.polly#VoiceId", + "Engine": { + "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "

    Voice ID to use for the synthesis.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.

    " } }, "OutputFormat": { @@ -1234,6 +1228,12 @@ "smithy.api#documentation": "

    The format in which the returned output will be encoded. For \n audio stream, this will be mp3, ogg_vorbis, or pcm. For speech\n marks, this will be json.

    ", "smithy.api#required": {} } + }, + "LexiconNames": { + "target": "com.amazonaws.polly#LexiconNameList", + "traits": { + "smithy.api#documentation": "

    List of one or more pronunciation lexicon names you want the service \n to apply during synthesis. Lexicons are applied only if the language \n of the lexicon is the same as the language of the voice.

    " + } } } }, @@ -1251,34 +1251,34 @@ "com.amazonaws.polly#SynthesisTask": { "type": "structure", "members": { - "LexiconNames": { - "target": "com.amazonaws.polly#LexiconNameList", + "LanguageCode": { + "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

    List of one or more pronunciation lexicon names you want the service \n to apply during synthesis. Lexicons are applied only if the language \n of the lexicon is the same as the language of the voice.

    " + "smithy.api#documentation": "

    Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as \n Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    \n

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language\n of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices \n operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather \n than Hindi.

    " } }, - "TaskStatusReason": { - "target": "com.amazonaws.polly#TaskStatusReason", + "SampleRate": { + "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

    Reason for the current status of a specific speech synthesis task, including \n errors if the task has failed.

    " + "smithy.api#documentation": "

    The audio frequency specified in Hz.

    \n

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The \n default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    \n

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " } }, - "RequestCharacters": { - "target": "com.amazonaws.polly#RequestCharacters", + "OutputUri": { + "target": "com.amazonaws.polly#OutputUri", "traits": { - "smithy.api#documentation": "

    Number of billable characters synthesized.

    " + "smithy.api#documentation": "

    Pathway for the output speech file.

    " } }, - "OutputFormat": { - "target": "com.amazonaws.polly#OutputFormat", + "TaskStatusReason": { + "target": "com.amazonaws.polly#TaskStatusReason", "traits": { - "smithy.api#documentation": "

    The format in which the returned output will be encoded. For \n audio stream, this will be mp3, ogg_vorbis, or pcm. For speech\n marks, this will be json.

    " + "smithy.api#documentation": "

    Reason for the current status of a specific speech synthesis task, including \n errors if the task has failed.

    " } }, - "SnsTopicArn": { - "target": "com.amazonaws.polly#SnsTopicArn", + "RequestCharacters": { + "target": "com.amazonaws.polly#RequestCharacters", "traits": { - "smithy.api#documentation": "

    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

    " + "smithy.api#documentation": "

    Number of billable characters synthesized.

    " } }, "TaskStatus": { @@ -1287,34 +1287,40 @@ "smithy.api#documentation": "

    Current status of the individual speech synthesis task.

    " } }, - "OutputUri": { - "target": "com.amazonaws.polly#OutputUri", - "traits": { - "smithy.api#documentation": "

    Pathway for the output speech file.

    " - } - }, "TextType": { "target": "com.amazonaws.polly#TextType", "traits": { "smithy.api#documentation": "

    Specifies whether the input text is plain text or SSML. The default value is plain text.

    " } }, - "SpeechMarkTypes": { - "target": "com.amazonaws.polly#SpeechMarkTypeList", + "LexiconNames": { + "target": "com.amazonaws.polly#LexiconNameList", "traits": { - "smithy.api#documentation": "

    The type of speech marks returned for the input text.

    " + "smithy.api#documentation": "

    List of one or more pronunciation lexicon names you want the service \n to apply during synthesis. Lexicons are applied only if the language \n of the lexicon is the same as the language of the voice.

    " } }, - "LanguageCode": { - "target": "com.amazonaws.polly#LanguageCode", + "SnsTopicArn": { + "target": "com.amazonaws.polly#SnsTopicArn", "traits": { - "smithy.api#documentation": "

    Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as \n Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    \n

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language\n of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices \n operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather \n than Hindi.

    " + "smithy.api#documentation": "

    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

    " } }, - "SampleRate": { - "target": "com.amazonaws.polly#SampleRate", + "OutputFormat": { + "target": "com.amazonaws.polly#OutputFormat", "traits": { - "smithy.api#documentation": "

    The audio frequency specified in Hz.

    \n

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The \n default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    \n

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " + "smithy.api#documentation": "

    The format in which the returned output will be encoded. For \n audio stream, this will be mp3, ogg_vorbis, or pcm. For speech\n marks, this will be json.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.polly#DateTime", + "traits": { + "smithy.api#documentation": "

    Timestamp for the time the synthesis task was started.

    " + } + }, + "Engine": { + "target": "com.amazonaws.polly#Engine", + "traits": { + "smithy.api#documentation": "

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.

    " } }, "VoiceId": { @@ -1329,16 +1335,10 @@ "smithy.api#documentation": "

    The Amazon Polly generated identifier for a speech synthesis task.

    " } }, - "CreationTime": { - "target": "com.amazonaws.polly#DateTime", - "traits": { - "smithy.api#documentation": "

    Timestamp for the time the synthesis task was started.

    " - } - }, - "Engine": { - "target": "com.amazonaws.polly#Engine", + "SpeechMarkTypes": { + "target": "com.amazonaws.polly#SpeechMarkTypeList", "traits": { - "smithy.api#documentation": "

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.

    " + "smithy.api#documentation": "

    The type of speech marks returned for the input text.

    " } } }, @@ -1414,10 +1414,16 @@ "com.amazonaws.polly#SynthesizeSpeechInput": { "type": "structure", "members": { - "OutputFormat": { - "target": "com.amazonaws.polly#OutputFormat", + "Engine": { + "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "

    \n The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. \n For speech marks, this will be json.

    \n

    When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

    ", + "smithy.api#documentation": "

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.

    " + } + }, + "VoiceId": { + "target": "com.amazonaws.polly#VoiceId", + "traits": { + "smithy.api#documentation": "

    \n Voice ID to use for the synthesis. You can get a list of \n available voice IDs by calling the DescribeVoices operation.\n

    ", "smithy.api#required": {} } }, @@ -1428,23 +1434,23 @@ "smithy.api#required": {} } }, - "VoiceId": { - "target": "com.amazonaws.polly#VoiceId", + "OutputFormat": { + "target": "com.amazonaws.polly#OutputFormat", "traits": { - "smithy.api#documentation": "

    \n Voice ID to use for the synthesis. You can get a list of \n available voice IDs by calling the DescribeVoices operation.\n

    ", + "smithy.api#documentation": "

    \n The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. \n For speech marks, this will be json.

    \n

    When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

    ", "smithy.api#required": {} } }, - "LanguageCode": { - "target": "com.amazonaws.polly#LanguageCode", + "SpeechMarkTypes": { + "target": "com.amazonaws.polly#SpeechMarkTypeList", "traits": { - "smithy.api#documentation": "

    Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, \n such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    \n

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language\n of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices \n operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than \n Hindi.

    " + "smithy.api#documentation": "

    The type of speech marks returned for the input text.

    " } }, - "SampleRate": { - "target": "com.amazonaws.polly#SampleRate", + "LanguageCode": { + "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

    The audio frequency specified in Hz.

    \n

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The \n default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    \n

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " + "smithy.api#documentation": "

    Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, \n such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    \n

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language\n of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices \n operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than \n Hindi.

    " } }, "LexiconNames": { @@ -1453,22 +1459,16 @@ "smithy.api#documentation": "

    List of one or more pronunciation lexicon names you want the service to apply\n during synthesis. Lexicons are applied only if the language of the lexicon is the same\n as the language of the voice. For information about storing lexicons, \n see PutLexicon.

    " } }, - "SpeechMarkTypes": { - "target": "com.amazonaws.polly#SpeechMarkTypeList", - "traits": { - "smithy.api#documentation": "

    The type of speech marks returned for the input text.

    " - } - }, "TextType": { "target": "com.amazonaws.polly#TextType", "traits": { "smithy.api#documentation": "

    \n Specifies whether the input text is plain text or SSML. The default value is plain text.\n For more information, see Using SSML.

    " } }, - "Engine": { - "target": "com.amazonaws.polly#Engine", + "SampleRate": { + "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine\n selected will result in an error.

    " + "smithy.api#documentation": "

    The audio frequency specified in Hz.

    \n

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The \n default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    \n

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " } } } @@ -1483,19 +1483,19 @@ "smithy.api#httpPayload": {} } }, - "ContentType": { - "target": "com.amazonaws.polly#ContentType", - "traits": { - "smithy.api#documentation": "

    \n Specifies the type audio stream. This should reflect the \n OutputFormat parameter in your request.\n

    \n
      \n
    • \n

      \n If you request mp3 as the OutputFormat, \n the ContentType returned is audio/mpeg.\n

      \n
      • \n
    • \n

      \n If you request ogg_vorbis as the OutputFormat, \n the ContentType returned is audio/ogg.\n

      \n
      • \n
    • \n

      If you request pcm as the OutputFormat, the\n ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono),\n little-endian format.

      \n
      • \n
    • \n

      If you request json as the OutputFormat, the ContentType\n returned is audio/json.

      \n
      • \n
    \n

    \n \n

    ", - "smithy.api#httpHeader": "Content-Type" - } - }, "RequestCharacters": { "target": "com.amazonaws.polly#RequestCharacters", "traits": { "smithy.api#documentation": "

    Number of characters synthesized.

    ", "smithy.api#httpHeader": "x-amzn-RequestCharacters" } + }, + "ContentType": { + "target": "com.amazonaws.polly#ContentType", + "traits": { + "smithy.api#documentation": "

    \n Specifies the type audio stream. This should reflect the \n OutputFormat parameter in your request.\n

    \n
      \n
    • \n

      \n If you request mp3 as the OutputFormat, \n the ContentType returned is audio/mpeg.\n

      \n
      • \n
    • \n

      \n If you request ogg_vorbis as the OutputFormat, \n the ContentType returned is audio/ogg.\n

      \n
      • \n
    • \n

      If you request pcm as the OutputFormat, the\n ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono),\n little-endian format.

      \n
      • \n
    • \n

      If you request json as the OutputFormat, the ContentType\n returned is audio/json.

      \n
      • \n
    \n

    \n \n

    ", + "smithy.api#httpHeader": "Content-Type" + } } } }, @@ -1591,18 +1591,6 @@ "com.amazonaws.polly#Voice": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.polly#VoiceName", - "traits": { - "smithy.api#documentation": "

    Name of the voice (for example, Salli, Kendra, etc.).\n This provides a human readable voice name that you might display \n in your application.

    " - } - }, - "AdditionalLanguageCodes": { - "target": "com.amazonaws.polly#LanguageCodeList", - "traits": { - "smithy.api#documentation": "

    Additional codes for languages available for the specified voice in addition to its default language.

    \n

    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since \n Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

    " - } - }, "LanguageCode": { "target": "com.amazonaws.polly#LanguageCode", "traits": { @@ -1615,6 +1603,12 @@ "smithy.api#documentation": "

    Human readable name of the language in English.

    " } }, + "Id": { + "target": "com.amazonaws.polly#VoiceId", + "traits": { + "smithy.api#documentation": "

    Amazon Polly assigned voice ID. This is the ID that you specify \n when calling the SynthesizeSpeech operation.

    " + } + }, "Gender": { "target": "com.amazonaws.polly#Gender", "traits": { @@ -1627,10 +1621,16 @@ "smithy.api#documentation": "

    Specifies which engines (standard or neural) that are supported by a given voice.

    " } }, - "Id": { - "target": "com.amazonaws.polly#VoiceId", + "Name": { + "target": "com.amazonaws.polly#VoiceName", "traits": { - "smithy.api#documentation": "

    Amazon Polly assigned voice ID. This is the ID that you specify \n when calling the SynthesizeSpeech operation.

    " + "smithy.api#documentation": "

    Name of the voice (for example, Salli, Kendra, etc.).\n This provides a human readable voice name that you might display \n in your application.

    " + } + }, + "AdditionalLanguageCodes": { + "target": "com.amazonaws.polly#LanguageCodeList", + "traits": { + "smithy.api#documentation": "

    Additional codes for languages available for the specified voice in addition to its default language.

    \n

    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since \n Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json b/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json index daa02f46109d..e6f76e59f62d 100644 --- a/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json +++ b/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json @@ -48,7 +48,7 @@ "sdkId": "Pricing", "arnNamespace": "pricing", "cloudFormationName": "Pricing", - "cloudTrailEventSource": "awspricelistservice.amazonaws.com" + "cloudTrailEventSource": "pricing.amazonaws.com" }, "aws.auth#sigv4": { "name": "pricing" @@ -130,11 +130,10 @@ "com.amazonaws.pricing#DescribeServicesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.pricing#BoxedInteger", + "FormatVersion": { + "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of results that you want returned in the response.

    " + "smithy.api#documentation": "

    The format version that you want the response to be in.

    \n

    Valid values are: aws_v1\n

    " } }, "ServiceCode": { @@ -143,16 +142,17 @@ "smithy.api#documentation": "

    The code for the service whose information you want to retrieve, such as AmazonEC2.\n You can use \n the ServiceCode to filter the results in a GetProducts call.\n To retrieve a list of all services, leave this blank.

    " } }, - "NextToken": { - "target": "com.amazonaws.pricing#String", + "MaxResults": { + "target": "com.amazonaws.pricing#BoxedInteger", "traits": { - "smithy.api#documentation": "

    The pagination token that indicates the next set of results that you want to retrieve.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results that you want returned in the response.

    " } }, - "FormatVersion": { + "NextToken": { "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#documentation": "

    The format version that you want the response to be in.

    \n

    Valid values are: aws_v1\n

    " + "smithy.api#documentation": "

    The pagination token that indicates the next set of results that you want to retrieve.

    " } } } @@ -160,10 +160,10 @@ "com.amazonaws.pricing#DescribeServicesResponse": { "type": "structure", "members": { - "Services": { - "target": "com.amazonaws.pricing#ServiceList", + "NextToken": { + "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#documentation": "

    The service metadata for the service or services in the response.

    " + "smithy.api#documentation": "

    The pagination token for the next set of retreivable results.

    " } }, "FormatVersion": { @@ -172,10 +172,10 @@ "smithy.api#documentation": "

    The format version of the response. For example, aws_v1.

    " } }, - "NextToken": { - "target": "com.amazonaws.pricing#String", + "Services": { + "target": "com.amazonaws.pricing#ServiceList", "traits": { - "smithy.api#documentation": "

    The pagination token for the next set of retreivable results.

    " + "smithy.api#documentation": "

    The service metadata for the service or services in the response.

    " } } } @@ -203,17 +203,17 @@ "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.pricing#FilterType", + "Field": { + "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#documentation": "

    The type of filter that you want to use.

    \n

    Valid values are: TERM_MATCH. TERM_MATCH returns only \n products that match both the given filter field and the given value.

    ", + "smithy.api#documentation": "

    The product metadata field that you want to filter on. You can filter by just the \n service code to see all products for a specific service, filter \n by just the attribute name to see a specific attribute for multiple services, or use both a service code\n and an attribute name to retrieve only products that match both fields.

    \n

    Valid values include: ServiceCode, and all attribute names

    \n \n

    For example, you can filter by the AmazonEC2 service code and the \n volumeType attribute name to get the prices for only Amazon EC2 volumes.

    ", "smithy.api#required": {} } }, - "Field": { - "target": "com.amazonaws.pricing#String", + "Type": { + "target": "com.amazonaws.pricing#FilterType", "traits": { - "smithy.api#documentation": "

    The product metadata field that you want to filter on. You can filter by just the \n service code to see all products for a specific service, filter \n by just the attribute name to see a specific attribute for multiple services, or use both a service code\n and an attribute name to retrieve only products that match both fields.

    \n

    Valid values include: ServiceCode, and all attribute names

    \n \n

    For example, you can filter by the AmazonEC2 service code and the \n volumeType attribute name to get the prices for only Amazon EC2 volumes.

    ", + "smithy.api#documentation": "

    The type of filter that you want to use.

    \n

    Valid values are: TERM_MATCH. TERM_MATCH returns only \n products that match both the given filter field and the given value.

    ", "smithy.api#required": {} } } @@ -283,10 +283,11 @@ "smithy.api#required": {} } }, - "NextToken": { + "ServiceCode": { "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#documentation": "

    The pagination token that indicates the next set of results that you want to retrieve.

    " + "smithy.api#documentation": "

    The service code for the service whose attributes you want to retrieve. For example, if you want \n the retrieve an EC2 attribute, use AmazonEC2.

    ", + "smithy.api#required": {} } }, "MaxResults": { @@ -296,11 +297,10 @@ "smithy.api#documentation": "

    The maximum number of results to return in response.

    " } }, - "ServiceCode": { + "NextToken": { "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#documentation": "

    The service code for the service whose attributes you want to retrieve. For example, if you want \n the retrieve an EC2 attribute, use AmazonEC2.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The pagination token that indicates the next set of results that you want to retrieve.

    " } } } @@ -359,23 +359,22 @@ "com.amazonaws.pricing#GetProductsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.pricing#BoxedInteger", + "NextToken": { + "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of results to return in the response.

    " + "smithy.api#documentation": "

    The pagination token that indicates the next set of results that you want to retrieve.

    " } }, - "Filters": { - "target": "com.amazonaws.pricing#Filters", + "FormatVersion": { + "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#documentation": "

    The list of filters that limit the returned products. only products that match all filters\n are returned.

    " + "smithy.api#documentation": "

    The format version that you want the response to be in.

    \n

    Valid values are: aws_v1\n

    " } }, - "NextToken": { - "target": "com.amazonaws.pricing#String", + "Filters": { + "target": "com.amazonaws.pricing#Filters", "traits": { - "smithy.api#documentation": "

    The pagination token that indicates the next set of results that you want to retrieve.

    " + "smithy.api#documentation": "

    The list of filters that limit the returned products. only products that match all filters\n are returned.

    " } }, "ServiceCode": { @@ -384,10 +383,11 @@ "smithy.api#documentation": "

    The code for the service whose products you want to retrieve.

    " } }, - "FormatVersion": { - "target": "com.amazonaws.pricing#String", + "MaxResults": { + "target": "com.amazonaws.pricing#BoxedInteger", "traits": { - "smithy.api#documentation": "

    The format version that you want the response to be in.

    \n

    Valid values are: aws_v1\n

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to return in the response.

    " } } } @@ -395,12 +395,6 @@ "com.amazonaws.pricing#GetProductsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.pricing#String", - "traits": { - "smithy.api#documentation": "

    The pagination token that indicates the next set of results to retrieve.

    " - } - }, "PriceList": { "target": "com.amazonaws.pricing#PriceList", "traits": { @@ -412,6 +406,12 @@ "traits": { "smithy.api#documentation": "

    The format version of the response. For example, aws_v1.

    " } + }, + "NextToken": { + "target": "com.amazonaws.pricing#String", + "traits": { + "smithy.api#documentation": "

    The pagination token that indicates the next set of results to retrieve.

    " + } } } }, diff --git a/codegen/sdk-codegen/aws-models/qldb-session.2019-07-11.json b/codegen/sdk-codegen/aws-models/qldb-session.2019-07-11.json index c4dbfda1b537..02e6898e4332 100644 --- a/codegen/sdk-codegen/aws-models/qldb-session.2019-07-11.json +++ b/codegen/sdk-codegen/aws-models/qldb-session.2019-07-11.json @@ -64,17 +64,17 @@ "com.amazonaws.qldbsession#CommitTransactionRequest": { "type": "structure", "members": { - "TransactionId": { - "target": "com.amazonaws.qldbsession#TransactionId", + "CommitDigest": { + "target": "com.amazonaws.qldbsession#CommitDigest", "traits": { - "smithy.api#documentation": "

    Specifies the transaction ID of the transaction to commit.

    ", + "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#required": {} } }, - "CommitDigest": { - "target": "com.amazonaws.qldbsession#CommitDigest", + "TransactionId": { + "target": "com.amazonaws.qldbsession#TransactionId", "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 transaction ID of the transaction to commit.

    ", "smithy.api#required": {} } } @@ -126,12 +126,6 @@ "com.amazonaws.qldbsession#ExecuteStatementRequest": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.qldbsession#StatementParameters", - "traits": { - "smithy.api#documentation": "

    Specifies the parameters for the parameterized statement in the request.

    " - } - }, "TransactionId": { "target": "com.amazonaws.qldbsession#TransactionId", "traits": { @@ -139,6 +133,12 @@ "smithy.api#required": {} } }, + "Parameters": { + "target": "com.amazonaws.qldbsession#StatementParameters", + "traits": { + "smithy.api#documentation": "

    Specifies the parameters for the parameterized statement in the request.

    " + } + }, "Statement": { "target": "com.amazonaws.qldbsession#Statement", "traits": { @@ -204,11 +204,11 @@ "com.amazonaws.qldbsession#InvalidSessionException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.qldbsession#ErrorCode" - }, "Message": { "target": "com.amazonaws.qldbsession#ErrorMessage" + }, + "Code": { + "target": "com.amazonaws.qldbsession#ErrorCode" } }, "traits": { @@ -311,7 +311,7 @@ "sdkId": "QLDB Session", "arnNamespace": "qldb", "cloudFormationName": "QLDBSession", - "cloudTrailEventSource": "session.qldb.amazonaws.com" + "cloudTrailEventSource": "qldbsession.amazonaws.com" }, "aws.auth#sigv4": { "name": "qldb" @@ -365,24 +365,6 @@ "com.amazonaws.qldbsession#SendCommandRequest": { "type": "structure", "members": { - "StartSession": { - "target": "com.amazonaws.qldbsession#StartSessionRequest", - "traits": { - "smithy.api#documentation": "

    Command to start a new session. A session token is obtained as part of the\n response.

    " - } - }, - "CommitTransaction": { - "target": "com.amazonaws.qldbsession#CommitTransactionRequest", - "traits": { - "smithy.api#documentation": "

    Command to commit the specified transaction.

    " - } - }, - "EndSession": { - "target": "com.amazonaws.qldbsession#EndSessionRequest", - "traits": { - "smithy.api#documentation": "

    Command to end the current session.

    " - } - }, "StartTransaction": { "target": "com.amazonaws.qldbsession#StartTransactionRequest", "traits": { @@ -395,6 +377,12 @@ "smithy.api#documentation": "

    Command to abort the current transaction.

    " } }, + "EndSession": { + "target": "com.amazonaws.qldbsession#EndSessionRequest", + "traits": { + "smithy.api#documentation": "

    Command to end the current session.

    " + } + }, "FetchPage": { "target": "com.amazonaws.qldbsession#FetchPageRequest", "traits": { @@ -407,6 +395,18 @@ "smithy.api#documentation": "

    Specifies the session token for the current command. A session token is constant\n throughout the life of the session.

    \n

    To obtain a session token, run the StartSession command. This\n SessionToken is required for every subsequent command that is issued during\n the current session.

    " } }, + "StartSession": { + "target": "com.amazonaws.qldbsession#StartSessionRequest", + "traits": { + "smithy.api#documentation": "

    Command to start a new session. A session token is obtained as part of the\n response.

    " + } + }, + "CommitTransaction": { + "target": "com.amazonaws.qldbsession#CommitTransactionRequest", + "traits": { + "smithy.api#documentation": "

    Command to commit the specified transaction.

    " + } + }, "ExecuteStatement": { "target": "com.amazonaws.qldbsession#ExecuteStatementRequest", "traits": { @@ -418,22 +418,16 @@ "com.amazonaws.qldbsession#SendCommandResult": { "type": "structure", "members": { - "EndSession": { - "target": "com.amazonaws.qldbsession#EndSessionResult", - "traits": { - "smithy.api#documentation": "

    Contains the details of the ended session.

    " - } - }, - "FetchPage": { - "target": "com.amazonaws.qldbsession#FetchPageResult", + "CommitTransaction": { + "target": "com.amazonaws.qldbsession#CommitTransactionResult", "traits": { - "smithy.api#documentation": "

    Contains the details of the fetched page.

    " + "smithy.api#documentation": "

    Contains the details of the committed transaction.

    " } }, - "AbortTransaction": { - "target": "com.amazonaws.qldbsession#AbortTransactionResult", + "EndSession": { + "target": "com.amazonaws.qldbsession#EndSessionResult", "traits": { - "smithy.api#documentation": "

    Contains the details of the aborted transaction.

    " + "smithy.api#documentation": "

    Contains the details of the ended session.

    " } }, "StartSession": { @@ -448,10 +442,16 @@ "smithy.api#documentation": "

    Contains the details of the started transaction.

    " } }, - "CommitTransaction": { - "target": "com.amazonaws.qldbsession#CommitTransactionResult", + "AbortTransaction": { + "target": "com.amazonaws.qldbsession#AbortTransactionResult", "traits": { - "smithy.api#documentation": "

    Contains the details of the committed transaction.

    " + "smithy.api#documentation": "

    Contains the details of the aborted transaction.

    " + } + }, + "FetchPage": { + "target": "com.amazonaws.qldbsession#FetchPageResult", + "traits": { + "smithy.api#documentation": "

    Contains the details of the fetched page.

    " } }, "ExecuteStatement": { @@ -550,17 +550,17 @@ "com.amazonaws.qldbsession#ValueHolder": { "type": "structure", "members": { - "IonBinary": { - "target": "com.amazonaws.qldbsession#IonBinary", - "traits": { - "smithy.api#documentation": "

    An Amazon Ion binary value contained in a ValueHolder structure.

    " - } - }, "IonText": { "target": "com.amazonaws.qldbsession#IonText", "traits": { "smithy.api#documentation": "

    An Amazon Ion plaintext value contained in a ValueHolder structure.

    " } + }, + "IonBinary": { + "target": "com.amazonaws.qldbsession#IonBinary", + "traits": { + "smithy.api#documentation": "

    An Amazon Ion binary value contained in a ValueHolder structure.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/qldb.2019-01-02.json b/codegen/sdk-codegen/aws-models/qldb.2019-01-02.json index 6a75753ab2be..699ec65e630f 100644 --- a/codegen/sdk-codegen/aws-models/qldb.2019-01-02.json +++ b/codegen/sdk-codegen/aws-models/qldb.2019-01-02.json @@ -96,7 +96,7 @@ "sdkId": "QLDB", "arnNamespace": "qldb", "cloudFormationName": "QLDB", - "cloudTrailEventSource": "v20190102.ledger.amazonaws.com" + "cloudTrailEventSource": "qldb.amazonaws.com" }, "aws.auth#sigv4": { "name": "qldb" @@ -155,18 +155,18 @@ "com.amazonaws.qldb#CancelJournalKinesisStreamRequest": { "type": "structure", "members": { - "StreamId": { - "target": "com.amazonaws.qldb#UniqueId", + "LedgerName": { + "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "

    The unique ID that QLDB assigns to each QLDB journal stream.

    ", + "smithy.api#documentation": "

    The name of the ledger.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", + "StreamId": { + "target": "com.amazonaws.qldb#UniqueId", "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    ", + "smithy.api#documentation": "

    The unique ID that QLDB assigns to each QLDB journal stream.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -218,11 +218,10 @@ "com.amazonaws.qldb#CreateLedgerRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", + "DeletionProtection": { + "target": "com.amazonaws.qldb#DeletionProtection", "traits": { - "smithy.api#documentation": "

    The name of the ledger that you want to create. The name must be unique among all of\n your ledgers in the current AWS Region.

    \n

    Naming constraints for ledger names are defined in Quotas in Amazon QLDB\n in the Amazon QLDB Developer Guide.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " } }, "PermissionsMode": { @@ -232,39 +231,34 @@ "smithy.api#required": {} } }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " - } - }, "Tags": { "target": "com.amazonaws.qldb#Tags", "traits": { "smithy.api#documentation": "

    The key-value pairs to add as tags to the ledger that you want to create. Tag keys are\n case sensitive. Tag values are case sensitive and can be null.

    " } + }, + "Name": { + "target": "com.amazonaws.qldb#LedgerName", + "traits": { + "smithy.api#documentation": "

    The name of the ledger that you want to create. The name must be unique among all of\n your ledgers in the current AWS Region.

    \n

    Naming constraints for ledger names are defined in Quotas in Amazon QLDB\n in the Amazon QLDB Developer Guide.

    ", + "smithy.api#required": {} + } } } }, "com.amazonaws.qldb#CreateLedgerResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    " - } - }, "DeletionProtection": { "target": "com.amazonaws.qldb#DeletionProtection", "traits": { "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " } }, - "CreationDateTime": { - "target": "com.amazonaws.qldb#Timestamp", + "State": { + "target": "com.amazonaws.qldb#LedgerState", "traits": { - "smithy.api#documentation": "

    The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " + "smithy.api#documentation": "

    The current status of the ledger.

    " } }, "Arn": { @@ -273,10 +267,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the ledger.

    " } }, - "State": { - "target": "com.amazonaws.qldb#LedgerState", + "Name": { + "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "

    The current status of the ledger.

    " + "smithy.api#documentation": "

    The name of the ledger.

    " + } + }, + "CreationDateTime": { + "target": "com.amazonaws.qldb#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " } } } @@ -359,18 +359,18 @@ "com.amazonaws.qldb#DescribeJournalKinesisStreamRequest": { "type": "structure", "members": { - "StreamId": { - "target": "com.amazonaws.qldb#UniqueId", + "LedgerName": { + "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "

    The unique ID that QLDB assigns to each QLDB journal stream.

    ", + "smithy.api#documentation": "

    The name of the ledger.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", + "StreamId": { + "target": "com.amazonaws.qldb#UniqueId", "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    ", + "smithy.api#documentation": "

    The unique ID that QLDB assigns to each QLDB journal stream.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -484,16 +484,10 @@ "com.amazonaws.qldb#DescribeLedgerResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    " - } - }, - "CreationDateTime": { - "target": "com.amazonaws.qldb#Timestamp", + "DeletionProtection": { + "target": "com.amazonaws.qldb#DeletionProtection", "traits": { - "smithy.api#documentation": "

    The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " + "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " } }, "State": { @@ -502,10 +496,10 @@ "smithy.api#documentation": "

    The current status of the ledger.

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", + "CreationDateTime": { + "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " + "smithy.api#documentation": "

    The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " } }, "Arn": { @@ -513,6 +507,12 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the ledger.

    " } + }, + "Name": { + "target": "com.amazonaws.qldb#LedgerName", + "traits": { + "smithy.api#documentation": "

    The name of the ledger.

    " + } } } }, @@ -571,10 +571,11 @@ "com.amazonaws.qldb#ExportJournalToS3Request": { "type": "structure", "members": { - "InclusiveStartTime": { - "target": "com.amazonaws.qldb#Timestamp", + "Name": { + "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "

    The inclusive start date and time for the range of journal contents that you want to\n export.

    \n

    The InclusiveStartTime must be in ISO 8601 date and time\n format and in Universal Coordinated Time (UTC). For example:\n 2019-06-13T21:36:34Z\n

    \n

    The InclusiveStartTime must be before ExclusiveEndTime.

    \n

    If you provide an InclusiveStartTime that is before the ledger's\n CreationDateTime, Amazon QLDB defaults it to the ledger's\n CreationDateTime.

    ", + "smithy.api#documentation": "

    The name of the ledger.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -592,11 +593,10 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.qldb#LedgerName", + "InclusiveStartTime": { + "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The inclusive start date and time for the range of journal contents that you want to\n export.

    \n

    The InclusiveStartTime must be in ISO 8601 date and time\n format and in Universal Coordinated Time (UTC). For example:\n 2019-06-13T21:36:34Z\n

    \n

    The InclusiveStartTime must be before ExclusiveEndTime.

    \n

    If you provide an InclusiveStartTime that is before the ledger's\n CreationDateTime, Amazon QLDB defaults it to the ledger's\n CreationDateTime.

    ", "smithy.api#required": {} } }, @@ -678,12 +678,6 @@ "smithy.api#required": {} } }, - "DigestTipAddress": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

    The latest block location covered by the digest for which to request a proof. An address\n is an Amazon Ion structure that has two fields: strandId and\n sequenceNo.

    \n

    For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}\n

    " - } - }, "Name": { "target": "com.amazonaws.qldb#LedgerName", "traits": { @@ -691,23 +685,29 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "DigestTipAddress": { + "target": "com.amazonaws.qldb#ValueHolder", + "traits": { + "smithy.api#documentation": "

    The latest block location covered by the digest for which to request a proof. An address\n is an Amazon Ion structure that has two fields: strandId and\n sequenceNo.

    \n

    For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}\n

    " + } } } }, "com.amazonaws.qldb#GetBlockResponse": { "type": "structure", "members": { - "Block": { + "Proof": { "target": "com.amazonaws.qldb#ValueHolder", "traits": { - "smithy.api#documentation": "

    The block data object in Amazon Ion format.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The proof object in Amazon Ion format returned by a GetBlock request. A\n proof contains the list of hash values required to recalculate the specified digest using a\n Merkle tree, starting with the specified block.

    " } }, - "Proof": { + "Block": { "target": "com.amazonaws.qldb#ValueHolder", "traits": { - "smithy.api#documentation": "

    The proof object in Amazon Ion format returned by a GetBlock request. A\n proof contains the list of hash values required to recalculate the specified digest using a\n Merkle tree, starting with the specified block.

    " + "smithy.api#documentation": "

    The block data object in Amazon Ion format.

    ", + "smithy.api#required": {} } } } @@ -756,17 +756,17 @@ "com.amazonaws.qldb#GetDigestResponse": { "type": "structure", "members": { - "Digest": { - "target": "com.amazonaws.qldb#Digest", + "DigestTipAddress": { + "target": "com.amazonaws.qldb#ValueHolder", "traits": { - "smithy.api#documentation": "

    The 256-bit hash value representing the digest returned by a GetDigest\n request.

    ", + "smithy.api#documentation": "

    The latest block location covered by the digest that you requested. An address is an\n Amazon Ion structure that has two fields: strandId and\n sequenceNo.

    ", "smithy.api#required": {} } }, - "DigestTipAddress": { - "target": "com.amazonaws.qldb#ValueHolder", + "Digest": { + "target": "com.amazonaws.qldb#Digest", "traits": { - "smithy.api#documentation": "

    The latest block location covered by the digest that you requested. An address is an\n Amazon Ion structure that has two fields: strandId and\n sequenceNo.

    ", + "smithy.api#documentation": "

    The 256-bit hash value representing the digest returned by a GetDigest\n request.

    ", "smithy.api#required": {} } } @@ -803,13 +803,6 @@ "com.amazonaws.qldb#GetRevisionRequest": { "type": "structure", "members": { - "DocumentId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

    The unique ID of the document to be verified.

    ", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.qldb#LedgerName", "traits": { @@ -824,6 +817,13 @@ "smithy.api#documentation": "

    The latest block location covered by the digest for which to request a proof. An address\n is an Amazon Ion structure that has two fields: strandId and\n sequenceNo.

    \n

    For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}\n

    " } }, + "DocumentId": { + "target": "com.amazonaws.qldb#UniqueId", + "traits": { + "smithy.api#documentation": "

    The unique ID of the document to be verified.

    ", + "smithy.api#required": {} + } + }, "BlockAddress": { "target": "com.amazonaws.qldb#ValueHolder", "traits": { @@ -883,23 +883,23 @@ "com.amazonaws.qldb#JournalKinesisStreamDescription": { "type": "structure", "members": { - "KinesisConfiguration": { - "target": "com.amazonaws.qldb#KinesisConfiguration", + "ExclusiveEndTime": { + "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The configuration settings of the Amazon Kinesis Data Streams destination for your QLDB journal\n stream.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The exclusive date and time that specifies when the stream ends. If this parameter is\n blank, the stream runs indefinitely until you cancel it.

    " } }, - "ExclusiveEndTime": { + "CreationTime": { "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The exclusive date and time that specifies when the stream ends. If this parameter is\n blank, the stream runs indefinitely until you cancel it.

    " + "smithy.api#documentation": "

    The date and time, in epoch time format, when the QLDB journal stream was created.\n (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970\n UTC.)

    " } }, - "Arn": { - "target": "com.amazonaws.qldb#Arn", + "LedgerName": { + "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the QLDB journal stream.

    " + "smithy.api#documentation": "

    The name of the ledger.

    ", + "smithy.api#required": {} } }, "ErrorCause": { @@ -908,16 +908,16 @@ "smithy.api#documentation": "

    The error message that describes the reason that a stream has a status of\n IMPAIRED or FAILED. This is not applicable to streams that\n have other status values.

    " } }, - "InclusiveStartTime": { - "target": "com.amazonaws.qldb#Timestamp", + "Arn": { + "target": "com.amazonaws.qldb#Arn", "traits": { - "smithy.api#documentation": "

    The inclusive start date and time from which to start streaming journal data.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the QLDB journal stream.

    " } }, - "Status": { - "target": "com.amazonaws.qldb#StreamStatus", + "KinesisConfiguration": { + "target": "com.amazonaws.qldb#KinesisConfiguration", "traits": { - "smithy.api#documentation": "

    The current state of the QLDB journal stream.

    ", + "smithy.api#documentation": "

    The configuration settings of the Amazon Kinesis Data Streams destination for your QLDB journal\n stream.

    ", "smithy.api#required": {} } }, @@ -928,11 +928,10 @@ "smithy.api#required": {} } }, - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", + "InclusiveStartTime": { + "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The inclusive start date and time from which to start streaming journal data.

    " } }, "StreamName": { @@ -942,10 +941,11 @@ "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.qldb#Timestamp", + "Status": { + "target": "com.amazonaws.qldb#StreamStatus", "traits": { - "smithy.api#documentation": "

    The date and time, in epoch time format, when the QLDB journal stream was created.\n (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970\n UTC.)

    " + "smithy.api#documentation": "

    The current state of the QLDB journal stream.

    ", + "smithy.api#required": {} } }, "RoleArn": { @@ -969,17 +969,16 @@ "com.amazonaws.qldb#JournalS3ExportDescription": { "type": "structure", "members": { - "ExportId": { - "target": "com.amazonaws.qldb#UniqueId", + "ExportCreationTime": { + "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The unique ID of the journal export job.

    ", + "smithy.api#documentation": "

    The date and time, in epoch time format, when the export job was created. (Epoch time\n format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    ", "smithy.api#required": {} } }, - "ExportCreationTime": { - "target": "com.amazonaws.qldb#Timestamp", + "S3ExportConfiguration": { + "target": "com.amazonaws.qldb#S3ExportConfiguration", "traits": { - "smithy.api#documentation": "

    The date and time, in epoch time format, when the export job was created. (Epoch time\n format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    ", "smithy.api#required": {} } }, @@ -990,37 +989,38 @@ "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.qldb#ExportStatus", + "RoleArn": { + "target": "com.amazonaws.qldb#Arn", "traits": { - "smithy.api#documentation": "

    The current state of the journal export job.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

    \n
      \n
    • \n

      Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

      \n
      • \n
    • \n

      (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS\n KMS) for server-side encryption of your exported data.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.qldb#Arn", + "LedgerName": { + "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

    \n
      \n
    • \n

      Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

      \n
      • \n
    • \n

      (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS\n KMS) for server-side encryption of your exported data.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the ledger.

    ", "smithy.api#required": {} } }, - "ExclusiveEndTime": { - "target": "com.amazonaws.qldb#Timestamp", + "Status": { + "target": "com.amazonaws.qldb#ExportStatus", "traits": { - "smithy.api#documentation": "

    The exclusive end date and time for the range of journal contents that are specified in\n the original export request.

    ", + "smithy.api#documentation": "

    The current state of the journal export job.

    ", "smithy.api#required": {} } }, - "S3ExportConfiguration": { - "target": "com.amazonaws.qldb#S3ExportConfiguration", + "ExportId": { + "target": "com.amazonaws.qldb#UniqueId", "traits": { + "smithy.api#documentation": "

    The unique ID of the journal export job.

    ", "smithy.api#required": {} } }, - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", + "ExclusiveEndTime": { + "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    ", + "smithy.api#documentation": "

    The exclusive end date and time for the range of journal contents that are specified in\n the original export request.

    ", "smithy.api#required": {} } } @@ -1104,17 +1104,17 @@ "smithy.api#documentation": "

    The current status of the ledger.

    " } }, - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

    The name of the ledger.

    " - } - }, "CreationDateTime": { "target": "com.amazonaws.qldb#Timestamp", "traits": { "smithy.api#documentation": "

    The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " } + }, + "Name": { + "target": "com.amazonaws.qldb#LedgerName", + "traits": { + "smithy.api#documentation": "

    The name of the ledger.

    " + } } }, "traits": { @@ -1176,13 +1176,6 @@ "com.amazonaws.qldb#ListJournalKinesisStreamsForLedgerRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.qldb#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in a single\n ListJournalKinesisStreamsForLedger request. (The actual number of results\n returned might be fewer.)

    ", - "smithy.api#httpQuery": "max_results" - } - }, "NextToken": { "target": "com.amazonaws.qldb#NextToken", "traits": { @@ -1190,6 +1183,13 @@ "smithy.api#httpQuery": "next_token" } }, + "MaxResults": { + "target": "com.amazonaws.qldb#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return in a single\n ListJournalKinesisStreamsForLedger request. (The actual number of results\n returned might be fewer.)

    ", + "smithy.api#httpQuery": "max_results" + } + }, "LedgerName": { "target": "com.amazonaws.qldb#LedgerName", "traits": { @@ -1264,6 +1264,13 @@ "com.amazonaws.qldb#ListJournalS3ExportsForLedgerRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.qldb#NextToken", + "traits": { + "smithy.api#documentation": "

    A pagination token, indicating that you want to retrieve the next page of results. If\n you received a value for NextToken in the response from a previous\n ListJournalS3ExportsForLedger call, then you should use that value as input\n here.

    ", + "smithy.api#httpQuery": "next_token" + } + }, "Name": { "target": "com.amazonaws.qldb#LedgerName", "traits": { @@ -1278,13 +1285,6 @@ "smithy.api#documentation": "

    The maximum number of results to return in a single\n ListJournalS3ExportsForLedger request. (The actual number of results\n returned might be fewer.)

    ", "smithy.api#httpQuery": "max_results" } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "

    A pagination token, indicating that you want to retrieve the next page of results. If\n you received a value for NextToken in the response from a previous\n ListJournalS3ExportsForLedger call, then you should use that value as input\n here.

    ", - "smithy.api#httpQuery": "next_token" - } } } }, @@ -1327,17 +1327,17 @@ "com.amazonaws.qldb#ListJournalS3ExportsResponse": { "type": "structure", "members": { - "JournalS3Exports": { - "target": "com.amazonaws.qldb#JournalS3ExportList", - "traits": { - "smithy.api#documentation": "

    The array of journal export job descriptions for all ledgers that are associated with\n the current AWS account and Region.

    " - } - }, "NextToken": { "target": "com.amazonaws.qldb#NextToken", "traits": { "smithy.api#documentation": "
      \n
    • \n

      If NextToken is empty, then the last page of results has been\n processed and there are no more results to be retrieved.

      \n
      • \n
    • \n

      If NextToken is not empty, then there are more\n results available. To retrieve the next page of results, use the value of\n NextToken in a subsequent ListJournalS3Exports\n call.

      \n
      • \n
    " } + }, + "JournalS3Exports": { + "target": "com.amazonaws.qldb#JournalS3ExportList", + "traits": { + "smithy.api#documentation": "

    The array of journal export job descriptions for all ledgers that are associated with\n the current AWS account and Region.

    " + } } } }, @@ -1485,6 +1485,9 @@ "com.amazonaws.qldb#ResourceAlreadyExistsException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.qldb#ErrorMessage" + }, "ResourceName": { "target": "com.amazonaws.qldb#ResourceName", "traits": { @@ -1496,9 +1499,6 @@ "traits": { "smithy.api#documentation": "

    The type of resource.

    " } - }, - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" } }, "traits": { @@ -1510,15 +1510,15 @@ "com.amazonaws.qldb#ResourceInUseException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.qldb#ErrorMessage" + }, "ResourceType": { "target": "com.amazonaws.qldb#ResourceType", "traits": { "smithy.api#documentation": "

    The type of resource.

    " } }, - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, "ResourceName": { "target": "com.amazonaws.qldb#ResourceName", "traits": { @@ -1544,14 +1544,14 @@ "smithy.api#documentation": "

    The type of resource.

    " } }, - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, "ResourceName": { "target": "com.amazonaws.qldb#ResourceName", "traits": { "smithy.api#documentation": "

    The name of the resource.

    " } + }, + "Message": { + "target": "com.amazonaws.qldb#ErrorMessage" } }, "traits": { @@ -1563,12 +1563,6 @@ "com.amazonaws.qldb#ResourcePreconditionNotMetException": { "type": "structure", "members": { - "ResourceName": { - "target": "com.amazonaws.qldb#ResourceName", - "traits": { - "smithy.api#documentation": "

    The name of the resource.

    " - } - }, "ResourceType": { "target": "com.amazonaws.qldb#ResourceType", "traits": { @@ -1577,6 +1571,12 @@ }, "Message": { "target": "com.amazonaws.qldb#ErrorMessage" + }, + "ResourceName": { + "target": "com.amazonaws.qldb#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the resource.

    " + } } }, "traits": { @@ -1622,17 +1622,17 @@ "com.amazonaws.qldb#S3ExportConfiguration": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.qldb#S3Prefix", + "Bucket": { + "target": "com.amazonaws.qldb#S3Bucket", "traits": { - "smithy.api#documentation": "

    The prefix for the Amazon S3 bucket in which a journal export job writes the journal\n contents.

    \n

    The prefix must comply with Amazon S3 key naming rules and restrictions. For more\n information, see Object Key and Metadata in the Amazon S3 Developer\n Guide.

    \n

    The following are examples of valid Prefix values:

    \n
      \n
    • \n

      \n JournalExports-ForMyLedger/Testing/\n

      \n
      • \n
    • \n

      \n JournalExports\n

      \n
      • \n
    • \n

      \n My:Tests/\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The Amazon S3 bucket name in which a journal export job writes the journal contents.

    \n

    The bucket name must comply with the Amazon S3 bucket naming conventions. For more\n information, see Bucket Restrictions and\n Limitations in the Amazon S3 Developer Guide.

    ", "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.qldb#S3Bucket", + "Prefix": { + "target": "com.amazonaws.qldb#S3Prefix", "traits": { - "smithy.api#documentation": "

    The Amazon S3 bucket name in which a journal export job writes the journal contents.

    \n

    The bucket name must comply with the Amazon S3 bucket naming conventions. For more\n information, see Bucket Restrictions and\n Limitations in the Amazon S3 Developer Guide.

    ", + "smithy.api#documentation": "

    The prefix for the Amazon S3 bucket in which a journal export job writes the journal\n contents.

    \n

    The prefix must comply with Amazon S3 key naming rules and restrictions. For more\n information, see Object Key and Metadata in the Amazon S3 Developer\n Guide.

    \n

    The following are examples of valid Prefix values:

    \n
      \n
    • \n

      \n JournalExports-ForMyLedger/Testing/\n

      \n
      • \n
    • \n

      \n JournalExports\n

      \n
      • \n
    • \n

      \n My:Tests/\n

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -1707,10 +1707,16 @@ "com.amazonaws.qldb#StreamJournalToKinesisRequest": { "type": "structure", "members": { - "KinesisConfiguration": { - "target": "com.amazonaws.qldb#KinesisConfiguration", + "ExclusiveEndTime": { + "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

    The configuration settings of the Kinesis Data Streams destination for your stream request.

    ", + "smithy.api#documentation": "

    The exclusive date and time that specifies when the stream ends. If you don't define\n this parameter, the stream runs indefinitely until you cancel it.

    \n

    The ExclusiveEndTime must be in ISO 8601 date and time format\n and in Universal Coordinated Time (UTC). For example:\n 2019-06-13T21:36:34Z\n

    " + } + }, + "RoleArn": { + "target": "com.amazonaws.qldb#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.

    ", "smithy.api#required": {} } }, @@ -1722,29 +1728,23 @@ "smithy.api#required": {} } }, - "ExclusiveEndTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

    The exclusive date and time that specifies when the stream ends. If you don't define\n this parameter, the stream runs indefinitely until you cancel it.

    \n

    The ExclusiveEndTime must be in ISO 8601 date and time format\n and in Universal Coordinated Time (UTC). For example:\n 2019-06-13T21:36:34Z\n

    " - } - }, "Tags": { "target": "com.amazonaws.qldb#Tags", "traits": { "smithy.api#documentation": "

    The key-value pairs to add as tags to the stream that you want to create. Tag keys are\n case sensitive. Tag values are case sensitive and can be null.

    " } }, - "RoleArn": { - "target": "com.amazonaws.qldb#Arn", + "StreamName": { + "target": "com.amazonaws.qldb#StreamName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.

    ", + "smithy.api#documentation": "

    The name that you want to assign to the QLDB journal stream. User-defined names can\n help identify and indicate the purpose of a stream.

    \n

    Your stream name must be unique among other active streams for a\n given ledger. Stream names have the same naming constraints as ledger names, as defined in\n Quotas in Amazon QLDB in the Amazon QLDB Developer\n Guide.

    ", "smithy.api#required": {} } }, - "StreamName": { - "target": "com.amazonaws.qldb#StreamName", + "KinesisConfiguration": { + "target": "com.amazonaws.qldb#KinesisConfiguration", "traits": { - "smithy.api#documentation": "

    The name that you want to assign to the QLDB journal stream. User-defined names can\n help identify and indicate the purpose of a stream.

    \n

    Your stream name must be unique among other active streams for a\n given ledger. Stream names have the same naming constraints as ledger names, as defined in\n Quotas in Amazon QLDB in the Amazon QLDB Developer\n Guide.

    ", + "smithy.api#documentation": "

    The configuration settings of the Kinesis Data Streams destination for your stream request.

    ", "smithy.api#required": {} } }, @@ -1940,14 +1940,6 @@ "com.amazonaws.qldb#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) from which you want to remove the tags. For\n example:

    \n

    \n arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger\n

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "TagKeys": { "target": "com.amazonaws.qldb#TagKeyList", "traits": { @@ -1955,6 +1947,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "ResourceArn": { + "target": "com.amazonaws.qldb#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) from which you want to remove the tags. For\n example:

    \n

    \n arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger\n

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -1990,6 +1990,12 @@ "com.amazonaws.qldb#UpdateLedgerRequest": { "type": "structure", "members": { + "DeletionProtection": { + "target": "com.amazonaws.qldb#DeletionProtection", + "traits": { + "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " + } + }, "Name": { "target": "com.amazonaws.qldb#LedgerName", "traits": { @@ -1997,28 +2003,16 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " - } } } }, "com.amazonaws.qldb#UpdateLedgerResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the ledger.

    " - } - }, - "State": { - "target": "com.amazonaws.qldb#LedgerState", + "DeletionProtection": { + "target": "com.amazonaws.qldb#DeletionProtection", "traits": { - "smithy.api#documentation": "

    The current status of the ledger.

    " + "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " } }, "CreationDateTime": { @@ -2027,17 +2021,23 @@ "smithy.api#documentation": "

    The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

    The flag that prevents a ledger from being deleted by any user. If not provided on\n ledger creation, this feature is enabled (true) by default.

    \n

    If deletion protection is enabled, you must first disable it before you can delete the\n ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the\n UpdateLedger operation to set the flag to false. The QLDB\n console disables deletion protection for you when you use it to delete a ledger.

    " - } - }, "Name": { "target": "com.amazonaws.qldb#LedgerName", "traits": { "smithy.api#documentation": "

    The name of the ledger.

    " } + }, + "State": { + "target": "com.amazonaws.qldb#LedgerState", + "traits": { + "smithy.api#documentation": "

    The current status of the ledger.

    " + } + }, + "Arn": { + "target": "com.amazonaws.qldb#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the ledger.

    " + } } } }, 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 15c1f724add5..1c78f01521d4 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -32,14 +32,14 @@ "com.amazonaws.quicksight#AccessDeniedException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this request.

    " } - }, - "Message": { - "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -59,7 +59,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The customizations associated with your AWS account for QuickSight.

    " + "smithy.api#documentation": "

    The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.

    " } }, "com.amazonaws.quicksight#AccountSettings": { @@ -68,7 +68,7 @@ "AccountName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The name associated with the QuickSight subscription in your AWS account.

    " + "smithy.api#documentation": "

    The \"account name\" you provided for the QuickSight subscription in your AWS account. \n You create this name when you sign up for QuickSight. It is unique in all of AWS and \n it appears only in the console when users sign in.

    " } }, "NotificationEmail": { @@ -80,13 +80,13 @@ "DefaultNamespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The default QuickSight namespace for your AWS account.

    " + "smithy.api#documentation": "

    The default QuickSight namespace for your AWS account.

    " } }, "Edition": { "target": "com.amazonaws.quicksight#Edition", "traits": { - "smithy.api#documentation": "

    The edition of QuickSight that you're currently subscribed to.

    " + "smithy.api#documentation": "

    The edition of QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.

    " } } }, @@ -171,6 +171,303 @@ "smithy.api#documentation": "

    Amazon Elasticsearch Service parameters.

    " } }, + "com.amazonaws.quicksight#Analysis": { + "type": "structure", + "members": { + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

    A list of the associated sheets with the unique identifier and name of each sheet.

    " + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis.

    " + } + }, + "DataSetArns": { + "target": "com.amazonaws.quicksight#DataSetArnsList", + "traits": { + "smithy.api#documentation": "

    The ARNs of the datasets of the analysis.

    " + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

    Status associated with the analysis.

    " + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AnalysisErrorList", + "traits": { + "smithy.api#documentation": "

    Errors associated with the analysis.

    " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN of the theme of the analysis.

    " + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

    The descriptive name of the analysis.

    " + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time that the analysis was created.

    " + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the analysis.

    " + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time that the analysis was last updated.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Metadata structure for an analysis in Amazon QuickSight

    " + } + }, + "com.amazonaws.quicksight#AnalysisError": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The message associated with the analysis error.

    " + } + }, + "Type": { + "target": "com.amazonaws.quicksight#AnalysisErrorType", + "traits": { + "smithy.api#documentation": "

    The type of the analysis error.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A metadata error structure for an analysis.

    " + } + }, + "com.amazonaws.quicksight#AnalysisErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#AnalysisErrorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "SOURCE_NOT_FOUND", + "name": "SOURCE_NOT_FOUND" + }, + { + "value": "DATA_SET_NOT_FOUND", + "name": "DATA_SET_NOT_FOUND" + }, + { + "value": "INTERNAL_FAILURE", + "name": "INTERNAL_FAILURE" + }, + { + "value": "PARAMETER_VALUE_INCOMPATIBLE", + "name": "PARAMETER_VALUE_INCOMPATIBLE" + }, + { + "value": "PARAMETER_TYPE_INVALID", + "name": "PARAMETER_TYPE_INVALID" + }, + { + "value": "PARAMETER_NOT_FOUND", + "name": "PARAMETER_NOT_FOUND" + }, + { + "value": "COLUMN_TYPE_MISMATCH", + "name": "COLUMN_TYPE_MISMATCH" + }, + { + "value": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", + "name": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" + }, + { + "value": "COLUMN_REPLACEMENT_MISSING", + "name": "COLUMN_REPLACEMENT_MISSING" + } + ] + } + }, + "com.amazonaws.quicksight#AnalysisFilterAttribute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUICKSIGHT_USER", + "name": "QUICKSIGHT_USER" + } + ] + } + }, + "com.amazonaws.quicksight#AnalysisName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "[\\u0020-\\u00FF]+" + } + }, + "com.amazonaws.quicksight#AnalysisSearchFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#AnalysisFilterAttribute", + "traits": { + "smithy.api#documentation": "

    The name of the value that you want to use as a filter, for example \"Name\":\n \"QUICKSIGHT_USER\".

    " + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example \"Value\". An example is\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

    " + } + }, + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

    The comparison operator that you want to use as a filter, for example\n \"Operator\": \"StringEquals\".

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A filter that you apply when searching for one or more analyses.

    " + } + }, + "com.amazonaws.quicksight#AnalysisSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#AnalysisSourceEntity": { + "type": "structure", + "members": { + "SourceTemplate": { + "target": "com.amazonaws.quicksight#AnalysisSourceTemplate", + "traits": { + "smithy.api#documentation": "

    The source template for the source entity of the analysis.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The source entity of an analysis.

    " + } + }, + "com.amazonaws.quicksight#AnalysisSourceTemplate": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source template of an analysis.

    ", + "smithy.api#required": {} + } + }, + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", + "traits": { + "smithy.api#documentation": "

    The dataset references of the source template of an analysis.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The source template of an analysis.

    " + } + }, + "com.amazonaws.quicksight#AnalysisSummary": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

    The last known status for the analysis.

    " + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

    The name of the analysis. This name is displayed in the QuickSight console.\n

    " + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time that the analysis was last updated.

    " + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the analysis.

    " + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis. This ID displays in the URL.

    " + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time that the analysis was created.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The summary metadata that describes an analysis.

    " + } + }, + "com.amazonaws.quicksight#AnalysisSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.quicksight#Arn": { "type": "string" }, @@ -317,17 +614,17 @@ "com.amazonaws.quicksight#CalculatedColumn": { "type": "structure", "members": { - "ColumnId": { - "target": "com.amazonaws.quicksight#ColumnId", + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", "traits": { - "smithy.api#documentation": "

    A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

    ", + "smithy.api#documentation": "

    Column name.

    ", "smithy.api#required": {} } }, - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", + "ColumnId": { + "target": "com.amazonaws.quicksight#ColumnId", "traits": { - "smithy.api#documentation": "

    Column name.

    ", + "smithy.api#documentation": "

    A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

    ", "smithy.api#required": {} } }, @@ -651,22 +948,22 @@ "com.amazonaws.quicksight#ColumnSchema": { "type": "structure", "members": { - "DataType": { + "Name": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The data type of the column schema.

    " + "smithy.api#documentation": "

    The name of the column schema.

    " } }, - "GeographicRole": { + "DataType": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The geographic role of the column schema.

    " + "smithy.api#documentation": "

    The data type of the column schema.

    " } }, - "Name": { + "GeographicRole": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The name of the column schema.

    " + "smithy.api#documentation": "

    The geographic role of the column schema.

    " } } }, @@ -723,7 +1020,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A resource is already in a state that indicates an action is happening that must complete\n\t\t\tbefore a new update can be applied.

    ", + "smithy.api#documentation": "

    A resource is already in a state that indicates an operation is happening that must complete\n\t\t\tbefore a new update can be applied.

    ", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -731,14 +1028,14 @@ "com.amazonaws.quicksight#ConflictException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this request.

    " } - }, - "Message": { - "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -785,7 +1082,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a customization for the Amazon QuickSight subscription associated with your AWS account.

    ", + "smithy.api#documentation": "

    Creates Amazon QuickSight customizations the current AWS Region. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User\n Guide.\n

    \n

    You can create customizations for your AWS account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an AWS account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

    \n

    Before you use the CreateAccountCustomization API operation to add a theme \n as the namespace default, make sure that you first share the theme with the namespace. \n If you don't share it with the namespace, the theme isn't visible to your users \n even if you make it the default theme. \n To check if the theme is shared, view the current permissions by using the \n \n DescribeThemePermissions\n API operation.\n To share the theme, grant permissions by using the \n \n UpdateThemePermissions\n API operation.

    ", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/customizations", @@ -799,17 +1096,23 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The namespace associated with the customization that you're creating.

    ", + "smithy.api#documentation": "

    The QuickSight namespace that you want to add customizations to.

    ", "smithy.api#httpQuery": "namespace" } }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

    The customizations you're adding to the QuickSight subscription for the AWS account.\n\t For example, you could add a default theme by setting AccountCustomization to \n\t the midnight theme (DefaultTheme=\"arn:aws:quicksight::aws:theme/MIDNIGHT\") or to a custom theme (DefaultTheme=\"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\").

    ", + "smithy.api#documentation": "

    The QuickSight customizations you're adding in the current AWS Region. You can add\n these to an AWS account and a QuickSight namespace.

    \n

    For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

    ", "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

    A list of the tags that you want to attach to this resource.

    " + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -826,25 +1129,159 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the customization that you created for this AWS account.

    " + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

    The QuickSight customizations you're adding in the current AWS Region.

    " + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

    The namespace associated with the customization you're creating.

    " + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID for the AWS account that you want to customize QuickSight for.

    " + } + } + } + }, + "com.amazonaws.quicksight#CreateAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates an analysis in Amazon QuickSight.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateAnalysisRequest": { + "type": "structure", + "members": { + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the QuickSight console, make sure that you have access to it.

    " + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the\n analysis.

    " + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

    The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

    " + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "traits": { + "smithy.api#documentation": "

    A source entity to use for the analysis that you're creating. This metadata structure\n contains details that describe a source template and one or more datasets.

    ", + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the analysis that you're creating. This ID displays in the URL of the\n analysis.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A structure that describes the principals and the resource-level permissions on an\n analysis. You can use the Permissions structure to grant permissions by\n providing a list of AWS Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).

    \n \n

    To specify no permissions, omit Permissions.

    " + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account where you are creating an analysis.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

    A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the QuickSight console.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#CreateAnalysisResponse": { + "type": "structure", + "members": { + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

    The status of the creation of the analysis.

    " } }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The customizations you're adding to the QuickSight subscription for the AWS account.

    " + "smithy.api#documentation": "

    The ARN for the analysis.

    " } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The namespace associated with the customization you're creating.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that you want to customize QuickSight for.

    " + "smithy.api#documentation": "

    The ID of the analysis.

    " } } } @@ -896,7 +1333,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a dashboard from a template. To first create a template, see the \n\t\t\tCreateTemplate API operation.

    \n\t\t

    A dashboard is an entity in QuickSight that identifies QuickSight reports, created from\n\t\t\tanalyses. You can share QuickSight dashboards. With the right permissions, you can\n\t\t\tcreate scheduled email reports from them. The CreateDashboard,\n\t\t\t\tDescribeDashboard, and ListDashboardsByUser API operations\n\t\t\tact on the dashboard entity. If you have the correct permissions, you can create a\n\t\t\tdashboard from a template that exists in a different AWS account.

    ", + "smithy.api#documentation": "

    Creates a dashboard from a template. To first create a template, see the \n CreateTemplate\n API operation.

    \n

    A dashboard is an entity in QuickSight that identifies QuickSight reports, created\n from analyses. You can share QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can \n create a dashboard from a template that exists in a different AWS account.

    ", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", @@ -907,10 +1344,10 @@ "com.amazonaws.quicksight#CreateDashboardRequest": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "

    A structure that contains the permissions of the dashboard. You can use this structure for\n\t\t\tgranting permissions with principal and action information.

    " + "smithy.api#documentation": "

    A description for the first version of the dashboard being created.

    " } }, "DashboardId": { @@ -928,10 +1365,10 @@ "smithy.api#required": {} } }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "

    A description for the first version of the dashboard being created.

    " + "smithy.api#documentation": "

    A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.

    \n \n

    To specify no permissions, omit the permissions list.

    " } }, "AwsAccountId": { @@ -945,32 +1382,32 @@ "Tags": { "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

    " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value\n\t\t\tfor this field, it overrides the value that is used in the source entity. The theme ARN must exist\n\t\t\tin the same AWS account where you create the dashboard.

    " + "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the\n dashboard.

    " } }, "Parameters": { "target": "com.amazonaws.quicksight#Parameters", "traits": { - "smithy.api#documentation": "

    The parameters for the creation of the dashboard, which you want to use to override the default settings. \n\t\t\tA dashboard can have any type of parameters, and some parameters might\n\t\t\taccept multiple values. \n\t\t

    " + "smithy.api#documentation": "

    The parameters for the creation of the dashboard, which you want to use to override\n the default settings. A dashboard can have any type of parameters, and some parameters\n might accept multiple values.

    " } }, "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "

    The entity that you are using as a source when you create the dashboard. In\n\t\t\tSourceEntity, you specify the type of object you're using as source. You\n\t\t\tcan only create a dashboard from a template, so you use a SourceTemplate\n\t\t\tentity. If you need to create a dashboard from an analysis, first convert the analysis\n\t\t\tto a template by using the CreateTemplate API operation. For\n\t\t\tSourceTemplate, specify the Amazon Resource Name (ARN) of the source\n\t\t\ttemplate. The SourceTemplateARN can contain any AWS Account and any QuickSight-supported\n\t\t\tAWS Region.

    \n\t\t

    Use the DataSetReferences entity within SourceTemplate\n\t\t\tto list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

    ", + "smithy.api#documentation": "

    The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any AWS Account and any\n QuickSight-supported AWS Region.

    \n

    Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

    ", "smithy.api#required": {} } }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that is used in the source\n entity. The theme ARN must exist in the same AWS account where you create the\n dashboard.

    " + } + }, "DashboardPublishOptions": { "target": "com.amazonaws.quicksight#DashboardPublishOptions", "traits": { - "smithy.api#documentation": "

    Options for publishing the dashboard when you create it:

    \n\t\t
      \n
    • \n\t\t\t\t\t

      \n AvailabilityStatus for AdHocFilteringOption - This status can\n\t\t\t\t\tbe either ENABLED or DISABLED. When this is set to\n\t\t\t\t\t\tDISABLED, QuickSight disables the left filter pane on the\n\t\t\t\t\tpublished dashboard, which can be used for ad hoc (one-time) filtering. This\n\t\t\t\t\toption is ENABLED by default.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n AvailabilityStatus for ExportToCSVOption - This status can be\n\t\t\t\t\teither ENABLED or DISABLED. The visual option to\n\t\t\t\t\texport data to .csv format isn't enabled when this is set to\n\t\t\t\t\t\tDISABLED. This option is ENABLED by default.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n VisibilityState for SheetControlsOption - This visibility state\n\t\t\t\t\tcan be either COLLAPSED or EXPANDED. This option is\n\t\t\t\t\t\tCOLLAPSED by default.

      \n\t\t\t
      • \n
    " + "smithy.api#documentation": "

    Options for publishing the dashboard when you create it:

    \n
      \n
    • \n

      \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

      \n
      • \n
    • \n

      \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

      \n
      • \n
    • \n

      \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

      \n
      • \n
    " } } } @@ -999,7 +1436,7 @@ "VersionArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The ARN of the dashboard, including the version number\n\t\t\tof the first version that is created.

    " + "smithy.api#documentation": "

    The ARN of the dashboard, including the version number of the first version that is\n created.

    " } }, "Arn": { @@ -1072,10 +1509,11 @@ "smithy.api#required": {} } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", "traits": { - "smithy.api#documentation": "

    A list of resource permissions on the dataset.

    " + "smithy.api#documentation": "

    Indicates whether you want to import the data into SPICE.

    ", + "smithy.api#required": {} } }, "LogicalTableMap": { @@ -1084,13 +1522,6 @@ "smithy.api#documentation": "

    Configures the combination and transformation of the data from the physical tables.

    " } }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

    Indicates whether you want to import the data into SPICE.

    ", - "smithy.api#required": {} - } - }, "ColumnGroups": { "target": "com.amazonaws.quicksight#ColumnGroupList", "traits": { @@ -1110,6 +1541,12 @@ "smithy.api#required": {} } }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A list of resource permissions on the dataset.

    " + } + }, "Name": { "target": "com.amazonaws.quicksight#ResourceName", "traits": { @@ -1142,10 +1579,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dataset.

    " } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    " } }, "IngestionArn": { @@ -1154,10 +1591,10 @@ "smithy.api#documentation": "

    The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

    " } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } } } @@ -1214,10 +1651,11 @@ "smithy.api#documentation": "

    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.

    " } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    A display name for the data source.

    ", + "smithy.api#documentation": "

    The AWS account ID.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -1233,11 +1671,16 @@ "smithy.api#documentation": "

    The parameters that QuickSight uses to connect to your underlying source.

    " } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

    " + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

    An ID for the data source. This ID is unique per AWS Region for each AWS account.

    ", "smithy.api#required": {} } }, @@ -1247,19 +1690,13 @@ "smithy.api#documentation": "

    The credentials QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.

    " } }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "

    An ID for the data source. This ID is unique per AWS Region for each AWS account.

    ", + "smithy.api#documentation": "

    A display name for the data source.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

    " - } - }, "Type": { "target": "com.amazonaws.quicksight#DataSourceType", "traits": { @@ -1284,12 +1721,6 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    " - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -1301,6 +1732,12 @@ "traits": { "smithy.api#documentation": "

    The status of creating the data source.

    " } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    " + } } } }, @@ -1409,18 +1846,18 @@ "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The namespace. Currently, you should set this to default.

    ", + "smithy.api#documentation": "

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", + "smithy.api#documentation": "

    The namespace. Currently, you should set this to default.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1447,10 +1884,12 @@ "com.amazonaws.quicksight#CreateGroupRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    A description for the group that you want to create.

    " + "smithy.api#documentation": "

    The namespace. Currently, you should set this to default.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "AwsAccountId": { @@ -1461,18 +1900,16 @@ "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", "traits": { - "smithy.api#documentation": "

    A name for the group that you want to create.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A description for the group that you want to create.

    " } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#documentation": "

    The namespace. Currently, you should set this to default.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    A name for the group that you want to create.

    ", "smithy.api#required": {} } } @@ -1552,10 +1989,10 @@ "smithy.api#required": {} } }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "

    The status of the assignment. Possible values are as follows:

    \n\t\t
      \n
    • \n

      \n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\t\tsource.

      \n
      • \n
    • \n

      \n DISABLED - This assignment isn't used when creating the data source.

      \n
      • \n
    • \n

      \n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\t\tdata source.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the assignment. It must be unique within an AWS account.

    ", "smithy.api#required": {} } }, @@ -1565,6 +2002,13 @@ "smithy.api#documentation": "

    The QuickSight users, groups, or both that you want to assign the policy to.

    " } }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

    The status of the assignment. Possible values are as follows:

    \n\t\t
      \n
    • \n

      \n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\t\tsource.

      \n
      • \n
    • \n

      \n DISABLED - This assignment isn't used when creating the data source.

      \n
      • \n
    • \n

      \n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\t\tdata source.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -1578,13 +2022,6 @@ "traits": { "smithy.api#documentation": "

    The ARN for the IAM policy to apply to the QuickSight users and groups\n\t\t\tspecified in this assignment.

    " } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

    The name of the assignment. It must be unique within an AWS account.

    ", - "smithy.api#required": {} - } } } }, @@ -1615,17 +2052,17 @@ "smithy.api#documentation": "

    The ID for the assignment.

    " } }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

    The QuickSight users, groups, or both that the IAM policy is assigned to.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

    The QuickSight users, groups, or both that the IAM policy is assigned to.

    " + } } } }, @@ -1680,18 +2117,18 @@ "smithy.api#required": {} } }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    An ID for the ingestion.

    ", + "smithy.api#documentation": "

    The AWS account ID.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    ", + "smithy.api#documentation": "

    An ID for the ingestion.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1707,18 +2144,18 @@ "smithy.api#documentation": "

    An ID for the ingestion.

    " } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " - } - }, "IngestionStatus": { "target": "com.amazonaws.quicksight#IngestionStatus", "traits": { "smithy.api#documentation": "

    The ingestion status.

    " } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -1787,10 +2224,11 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", "traits": { - "smithy.api#documentation": "

    The tags that you want to associate with the namespace that you're creating.

    " + "smithy.api#documentation": "

    Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

    ", + "smithy.api#required": {} } }, "Namespace": { @@ -1800,11 +2238,10 @@ "smithy.api#required": {} } }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "

    Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The tags that you want to associate with the namespace that you're creating.

    " } } } @@ -1812,10 +2249,10 @@ "com.amazonaws.quicksight#CreateNamespaceResponse": { "type": "structure", "members": { - "CreationStatus": { - "target": "com.amazonaws.quicksight#NamespaceStatus", + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", "traits": { - "smithy.api#documentation": "

    The status of the creation of the namespace. This is an asynchronous process. A status\n of CREATED means that your namespace is ready to use. If an error occurs,\n it indicates if the process is retryable or non-retryable. In\n the case of a non-retryable error, refer to the error message for follow-up\n actions.

    " + "smithy.api#documentation": "

    Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

    " } }, "Name": { @@ -1824,10 +2261,16 @@ "smithy.api#documentation": "

    The name of the new namespace that you created.

    " } }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", + "CreationStatus": { + "target": "com.amazonaws.quicksight#NamespaceStatus", "traits": { - "smithy.api#documentation": "

    Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

    " + "smithy.api#documentation": "

    The status of the creation of the namespace. This is an asynchronous process. A status\n of CREATED means that your namespace is ready to use. If an error occurs,\n it indicates if the process is retryable or non-retryable. In\n the case of a non-retryable error, refer to the error message for follow-up\n tasks.

    " + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN of the QuickSight namespace you created.

    " } }, "RequestId": { @@ -1841,12 +2284,6 @@ "traits": { "smithy.api#documentation": "

    The AWS Region that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in.

    " } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The ARN of the QuickSight namespace you created.

    " - } } } }, @@ -1998,12 +2435,6 @@ "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

    " } }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

    A display name for the template.

    " - } - }, "SourceEntity": { "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { @@ -2014,9 +2445,21 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A list of resource permissions to be set on the template.

    " + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

    A display name for the template.

    " } }, "TemplateId": { @@ -2027,12 +2470,6 @@ "smithy.api#required": {} } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

    A list of resource permissions to be set on the template.

    " - } - }, "VersionDescription": { "target": "com.amazonaws.quicksight#VersionDescription", "traits": { @@ -2056,6 +2493,12 @@ "smithy.api#documentation": "

    The ID of the template.

    " } }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN for the template.

    " + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -2067,12 +2510,6 @@ "traits": { "smithy.api#documentation": "

    The ARN for the template, including the version information of\n\t\t\tthe first version.

    " } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The ARN for the template.

    " - } } } }, @@ -2165,33 +2602,33 @@ "com.amazonaws.quicksight#CreateThemeAliasRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the theme for the new theme alias.

    ", + "smithy.api#documentation": "

    The name that you want to give to the theme alias that you are creating. The\n\t\t\talias name can't begin with a $. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "

    An ID for the theme alias.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The version number of the theme.

    ", "smithy.api#required": {} } }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The version number of the theme.

    ", + "smithy.api#documentation": "

    An ID for the theme alias.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The name that you want to give to the theme alias that you are creating. The\n\t\t\talias name can't begin with a $. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the theme for the new theme alias.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2239,6 +2676,13 @@ "smithy.api#documentation": "

    A map of the key-value pairs for the resource tag or tags that you want to add to the\n\t\t\tresource.

    " } }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

    A display name for the theme.

    ", + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -2260,13 +2704,6 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

    A display name for the theme.

    ", - "smithy.api#required": {} - } - }, "VersionDescription": { "target": "com.amazonaws.quicksight#VersionDescription", "traits": { @@ -2278,10 +2715,10 @@ "com.amazonaws.quicksight#CreateThemeResponse": { "type": "structure", "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "

    The ID of the theme.

    " + "smithy.api#documentation": "

    The theme creation status.

    " } }, "RequestId": { @@ -2290,22 +2727,22 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the theme.

    " + "smithy.api#documentation": "

    The ID of the theme.

    " } }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The theme creation status.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the new theme.

    " } }, - "VersionArn": { + "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the new theme.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the theme.

    " } } } @@ -2316,20 +2753,20 @@ "AlternateDataSourceParameters": { "target": "com.amazonaws.quicksight#DataSourceParametersList", "traits": { - "smithy.api#documentation": "

    A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API compares the\n DataSourceParameters structure that's in the request with the structures in\n the AlternateDataSourceParameters allowlist. If the structures are an exact\n match, the request is allowed to use the new data source with the existing credentials.\n If the AlternateDataSourceParameters list is null, the\n DataSourceParameters originally used with these Credentials is\n automatically allowed.

    " + "smithy.api#documentation": "

    A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares the\n DataSourceParameters structure that's in the request with the structures in\n the AlternateDataSourceParameters allowlist. If the structures are an exact\n match, the request is allowed to use the new data source with the existing credentials.\n If the AlternateDataSourceParameters list is null, the\n DataSourceParameters originally used with these Credentials is\n automatically allowed.

    " } }, - "Password": { - "target": "com.amazonaws.quicksight#Password", + "Username": { + "target": "com.amazonaws.quicksight#UserName2", "traits": { - "smithy.api#documentation": "

    Password.

    ", + "smithy.api#documentation": "

    User name.

    ", "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.quicksight#UserName2", + "Password": { + "target": "com.amazonaws.quicksight#Password", "traits": { - "smithy.api#documentation": "

    User name.

    ", + "smithy.api#documentation": "

    Password.

    ", "smithy.api#required": {} } } @@ -2385,10 +2822,10 @@ "com.amazonaws.quicksight#Dashboard": { "type": "structure", "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    Dashboard ID.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " } }, "Version": { @@ -2397,10 +2834,16 @@ "smithy.api#documentation": "

    Version.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + "smithy.api#documentation": "

    Dashboard ID.

    " + } + }, + "LastPublishedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The last time that this dataset was published.

    " } }, "Name": { @@ -2409,10 +2852,10 @@ "smithy.api#documentation": "

    A display name for the dashboard.

    " } }, - "LastPublishedTime": { + "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The last time that this dataset was published.

    " + "smithy.api#documentation": "

    The last time that this dataset was updated.

    " } }, "CreatedTime": { @@ -2420,12 +2863,6 @@ "traits": { "smithy.api#documentation": "

    The time that this dataset was created.

    " } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

    The last time that this dataset was updated.

    " - } } }, "traits": { @@ -2549,18 +2986,18 @@ "com.amazonaws.quicksight#DashboardPublishOptions": { "type": "structure", "members": { - "ExportToCSVOption": { - "target": "com.amazonaws.quicksight#ExportToCSVOption", - "traits": { - "smithy.api#documentation": "

    Export to .csv option.

    " - } - }, "AdHocFilteringOption": { "target": "com.amazonaws.quicksight#AdHocFilteringOption", "traits": { "smithy.api#documentation": "

    Ad hoc (one-time) filtering option.

    " } }, + "ExportToCSVOption": { + "target": "com.amazonaws.quicksight#ExportToCSVOption", + "traits": { + "smithy.api#documentation": "

    Export to .csv option.

    " + } + }, "SheetControlsOption": { "target": "com.amazonaws.quicksight#SheetControlsOption", "traits": { @@ -2628,17 +3065,17 @@ "com.amazonaws.quicksight#DashboardSourceTemplate": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", + "smithy.api#documentation": "

    Dataset references.

    ", "smithy.api#required": {} } }, - "DataSetReferences": { - "target": "com.amazonaws.quicksight#DataSetReferenceList", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    Dataset references.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", "smithy.api#required": {} } } @@ -2650,16 +3087,16 @@ "com.amazonaws.quicksight#DashboardSummary": { "type": "structure", "members": { - "CreatedTime": { + "LastPublishedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The time that this dashboard was created.

    " + "smithy.api#documentation": "

    The last time that this dashboard was published.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "PublishedVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + "smithy.api#documentation": "

    Published version number.

    " } }, "DashboardId": { @@ -2668,12 +3105,6 @@ "smithy.api#documentation": "

    Dashboard ID.

    " } }, - "PublishedVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    Published version number.

    " - } - }, "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { @@ -2686,10 +3117,16 @@ "smithy.api#documentation": "

    A display name for the dashboard.

    " } }, - "LastPublishedTime": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + } + }, + "CreatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The last time that this dashboard was published.

    " + "smithy.api#documentation": "

    The time that this dashboard was created.

    " } } }, @@ -2727,28 +3164,22 @@ "com.amazonaws.quicksight#DashboardVersion": { "type": "structure", "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    Version number.

    " - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#DashboardErrorList", + "DataSetArns": { + "target": "com.amazonaws.quicksight#DataSetArnsList", "traits": { - "smithy.api#documentation": "

    Errors.

    " + "smithy.api#documentation": "

    The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

    " } }, - "DataSetArns": { - "target": "com.amazonaws.quicksight#DataSetArnsList", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Numbers (ARNs) for the datasets that are associated with a version\n of the dashboard.

    " + "smithy.api#documentation": "

    Version number for this version of the dashboard.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The time that this dashboard version was created.

    " + "smithy.api#documentation": "

    The ARN of the theme associated with a version of the dashboard.

    " } }, "Description": { @@ -2757,10 +3188,10 @@ "smithy.api#documentation": "

    Description.

    " } }, - "SourceEntityArn": { - "target": "com.amazonaws.quicksight#Arn", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    Source entity ARN.

    " + "smithy.api#documentation": "

    The time that this dashboard version was created.

    " } }, "Arn": { @@ -2769,11 +3200,29 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " } }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

    A list of the associated sheets with the unique identifier and name of each sheet.

    " + } + }, "Status": { "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { "smithy.api#documentation": "

    The HTTP status of the request.

    " } + }, + "Errors": { + "target": "com.amazonaws.quicksight#DashboardErrorList", + "traits": { + "smithy.api#documentation": "

    Errors associated with this dashboard version.

    " + } + }, + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    Source entity ARN.

    " + } } }, "traits": { @@ -2783,6 +3232,12 @@ "com.amazonaws.quicksight#DashboardVersionSummary": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + } + }, "Description": { "target": "com.amazonaws.quicksight#VersionDescription", "traits": { @@ -2795,29 +3250,23 @@ "smithy.api#documentation": "

    The time that this dashboard version was created.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " - } - }, "VersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { "smithy.api#documentation": "

    Version number.

    " } }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

    The HTTP status of the request.

    " - } - }, "SourceEntityArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "

    Source entity ARN.

    " } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

    The HTTP status of the request.

    " + } } }, "traits": { @@ -2865,10 +3314,28 @@ "com.amazonaws.quicksight#DataSet": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

    A display name for the dataset.

    " + } + }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "

    Configures the combination and transformation of the data from the physical\n tables.

    " + } + }, "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The last time that this dataset was updated.

    " + "smithy.api#documentation": "

    The last time that this dataset was updated.

    " + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

    The row-level security configuration for the dataset.

    " } }, "ConsumedSpiceCapacityInBytes": { @@ -2877,12 +3344,6 @@ "smithy.api#documentation": "

    The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

    " } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

    A display name for the dataset.

    " - } - }, "OutputColumns": { "target": "com.amazonaws.quicksight#OutputColumnList", "traits": { @@ -2895,16 +3356,16 @@ "smithy.api#documentation": "

    Indicates whether you want to import the data into SPICE.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + "smithy.api#documentation": "

    Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.

    " } }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The row-level security configuration for the dataset.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " } }, "DataSetId": { @@ -2913,28 +3374,16 @@ "smithy.api#documentation": "

    The ID of the dataset.

    " } }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "

    Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.

    " - } - }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", - "traits": { - "smithy.api#documentation": "

    Declares the physical tables that are available in the underlying data sources.

    " - } - }, "CreatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { "smithy.api#documentation": "

    The time that this dataset was created.

    " } }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", "traits": { - "smithy.api#documentation": "

    Configures the combination and transformation of the data from the physical\n tables.

    " + "smithy.api#documentation": "

    Declares the physical tables that are available in the underlying data sources.

    " } } }, @@ -3066,18 +3515,6 @@ "com.amazonaws.quicksight#DataSetSummary": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dataset.

    " - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

    The row-level security configuration for the dataset.

    " - } - }, "ImportMode": { "target": "com.amazonaws.quicksight#DataSetImportMode", "traits": { @@ -3090,10 +3527,10 @@ "smithy.api#documentation": "

    The time that this dataset was created.

    " } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", "traits": { - "smithy.api#documentation": "

    A display name for the dataset.

    " + "smithy.api#documentation": "

    The row-level security configuration for the dataset.

    " } }, "DataSetId": { @@ -3107,6 +3544,18 @@ "traits": { "smithy.api#documentation": "

    The last time that this dataset was updated.

    " } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

    A display name for the dataset.

    " + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dataset.

    " + } } }, "traits": { @@ -3128,10 +3577,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the data source.

    " } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", "traits": { - "smithy.api#documentation": "

    The last time that this data source was updated.

    " + "smithy.api#documentation": "

    A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allowlist. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

    " } }, "Name": { @@ -3140,22 +3589,10 @@ "smithy.api#documentation": "

    A display name for the data source.

    " } }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", - "traits": { - "smithy.api#documentation": "

    A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n compares the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allowlist. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

    " - } - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "

    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your\n underlying source.

    " - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS\n account.

    " + "smithy.api#documentation": "

    The HTTP status of the request.

    " } }, "VpcConnectionProperties": { @@ -3164,34 +3601,46 @@ "smithy.api#documentation": "

    The VPC connection information. You need to use this parameter only when you want\n QuickSight to use a VPC connection when connecting to your underlying source.

    " } }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your\n underlying source.

    " + } + }, "Type": { "target": "com.amazonaws.quicksight#DataSourceType", "traits": { "smithy.api#documentation": "

    The type of the data source. This type indicates which database engine the data source\n connects to.

    " } }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#DataSourceErrorInfo", + "traits": { + "smithy.api#documentation": "

    Error information from the last update or the creation of the data source.

    " + } + }, "DataSourceParameters": { "target": "com.amazonaws.quicksight#DataSourceParameters", "traits": { "smithy.api#documentation": "

    The parameters that Amazon QuickSight uses to connect to your underlying source. This\n is a variant type structure. For this structure to be valid, only one of the attributes\n can be non-null.

    " } }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

    The HTTP status of the request.

    " + "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS\n account.

    " } }, - "CreatedTime": { + "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The time that this data source was created.

    " + "smithy.api#documentation": "

    The last time that this data source was updated.

    " } }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#DataSourceErrorInfo", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    Error information from the last update or the creation of the data source.

    " + "smithy.api#documentation": "

    The time that this data source was created.

    " } } }, @@ -3288,22 +3737,16 @@ "com.amazonaws.quicksight#DataSourceParameters": { "type": "structure", "members": { - "PrestoParameters": { - "target": "com.amazonaws.quicksight#PrestoParameters", - "traits": { - "smithy.api#documentation": "

    Presto parameters.

    " - } - }, "ServiceNowParameters": { "target": "com.amazonaws.quicksight#ServiceNowParameters", "traits": { "smithy.api#documentation": "

    ServiceNow parameters.

    " } }, - "S3Parameters": { - "target": "com.amazonaws.quicksight#S3Parameters", + "PrestoParameters": { + "target": "com.amazonaws.quicksight#PrestoParameters", "traits": { - "smithy.api#documentation": "

    S3 parameters.

    " + "smithy.api#documentation": "

    Presto parameters.

    " } }, "AuroraParameters": { @@ -3312,22 +3755,34 @@ "smithy.api#documentation": "

    Amazon Aurora MySQL parameters.

    " } }, + "S3Parameters": { + "target": "com.amazonaws.quicksight#S3Parameters", + "traits": { + "smithy.api#documentation": "

    S3 parameters.

    " + } + }, "TwitterParameters": { "target": "com.amazonaws.quicksight#TwitterParameters", "traits": { "smithy.api#documentation": "

    Twitter parameters.

    " } }, + "RedshiftParameters": { + "target": "com.amazonaws.quicksight#RedshiftParameters", + "traits": { + "smithy.api#documentation": "

    Amazon Redshift parameters.

    " + } + }, "AuroraPostgreSqlParameters": { "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", "traits": { "smithy.api#documentation": "

    Aurora PostgreSQL parameters.

    " } }, - "RedshiftParameters": { - "target": "com.amazonaws.quicksight#RedshiftParameters", + "MariaDbParameters": { + "target": "com.amazonaws.quicksight#MariaDbParameters", "traits": { - "smithy.api#documentation": "

    Amazon Redshift parameters.

    " + "smithy.api#documentation": "

    MariaDB parameters.

    " } }, "AthenaParameters": { @@ -3342,24 +3797,12 @@ "smithy.api#documentation": "

    Spark parameters.

    " } }, - "MariaDbParameters": { - "target": "com.amazonaws.quicksight#MariaDbParameters", - "traits": { - "smithy.api#documentation": "

    MariaDB parameters.

    " - } - }, "AwsIotAnalyticsParameters": { "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", "traits": { "smithy.api#documentation": "

    AWS IoT Analytics parameters.

    " } }, - "RdsParameters": { - "target": "com.amazonaws.quicksight#RdsParameters", - "traits": { - "smithy.api#documentation": "

    Amazon RDS parameters.

    " - } - }, "MySqlParameters": { "target": "com.amazonaws.quicksight#MySqlParameters", "traits": { @@ -3372,18 +3815,24 @@ "smithy.api#documentation": "

    Amazon Elasticsearch Service parameters.

    " } }, - "SnowflakeParameters": { - "target": "com.amazonaws.quicksight#SnowflakeParameters", - "traits": { - "smithy.api#documentation": "

    Snowflake parameters.

    " - } - }, "JiraParameters": { "target": "com.amazonaws.quicksight#JiraParameters", "traits": { "smithy.api#documentation": "

    Jira parameters.

    " } }, + "RdsParameters": { + "target": "com.amazonaws.quicksight#RdsParameters", + "traits": { + "smithy.api#documentation": "

    Amazon RDS parameters.

    " + } + }, + "PostgreSqlParameters": { + "target": "com.amazonaws.quicksight#PostgreSqlParameters", + "traits": { + "smithy.api#documentation": "

    PostgreSQL parameters.

    " + } + }, "TeradataParameters": { "target": "com.amazonaws.quicksight#TeradataParameters", "traits": { @@ -3396,10 +3845,10 @@ "smithy.api#documentation": "

    SQL Server parameters.

    " } }, - "PostgreSqlParameters": { - "target": "com.amazonaws.quicksight#PostgreSqlParameters", + "SnowflakeParameters": { + "target": "com.amazonaws.quicksight#SnowflakeParameters", "traits": { - "smithy.api#documentation": "

    PostgreSQL parameters.

    " + "smithy.api#documentation": "

    Snowflake parameters.

    " } } }, @@ -3506,6 +3955,10 @@ { "value": "TWITTER", "name": "TWITTER" + }, + { + "value": "TIMESTREAM", + "name": "TIMESTREAM" } ] } @@ -3525,20 +3978,20 @@ "Values": { "target": "com.amazonaws.quicksight#TimestampList", "traits": { - "smithy.api#documentation": "

    Values.

    ", + "smithy.api#documentation": "

    The values for the date-time parameter.

    ", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A display name for the dataset.

    ", + "smithy.api#documentation": "

    A display name for the date-time parameter.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Date time parameter.

    " + "smithy.api#documentation": "

    A date-time parameter.

    " } }, "com.amazonaws.quicksight#DateTimeParameterList": { @@ -3556,23 +4009,23 @@ "com.amazonaws.quicksight#DecimalParameter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", + "Values": { + "target": "com.amazonaws.quicksight#DoubleList", "traits": { - "smithy.api#documentation": "

    A display name for the dataset.

    ", + "smithy.api#documentation": "

    The values for the decimal parameter.

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.quicksight#DoubleList", + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Values.

    ", + "smithy.api#documentation": "

    A display name for the decimal parameter.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Decimal parameter.

    " + "smithy.api#documentation": "

    A decimal parameter.

    " } }, "com.amazonaws.quicksight#DecimalParameterList": { @@ -3616,37 +4069,138 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes customizations for the QuickSight subscription on your AWS account.

    ", + "smithy.api#documentation": "

    Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS\n account and QuickSight namespace.

    ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomizationRequest": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

    The QuickSight namespace that you're deleting the customizations from.

    ", + "smithy.api#httpQuery": "namespace" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID for the AWS account that you want to delete QuickSight customizations from in\n this AWS Region.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + } + } + }, + "com.amazonaws.quicksight#DeleteAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during\n which you can restore the analysis. If you don't specify a recovery window value, the\n operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to\n the response that specifies the end of the recovery window. At the end of the recovery\n window, QuickSight deletes the analysis permanently.

    \n

    At any time before recovery window ends, you can use the RestoreAnalysis\n API operation to remove the DeletionTime stamp and cancel the deletion of\n the analysis. The analysis remains visible in the API until it's deleted, so you can\n describe it but you can't make a template from it.

    \n

    An analysis that's scheduled for deletion isn't accessible in the QuickSight console.\n To access it in the console, restore it. Deleting an analysis doesn't delete the\n dashboards that you publish from it.

    ", "smithy.api#http": { "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/customizations", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", "code": 200 } } }, - "com.amazonaws.quicksight#DeleteAccountCustomizationRequest": { + "com.amazonaws.quicksight#DeleteAnalysisRequest": { "type": "structure", "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis that you're deleting.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that you want to delete QuickSight customizations from.

    ", + "smithy.api#documentation": "

    The ID of the AWS account where you want to delete an analysis.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "RecoveryWindowInDays": { + "target": "com.amazonaws.quicksight#RecoveryWindowInDays", "traits": { - "smithy.api#documentation": "

    The namespace associated with the customization that you're deleting.

    ", - "smithy.api#httpQuery": "namespace" + "smithy.api#documentation": "

    A value that specifies the number of days that QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery\n option in the same API call. The default value is 30.

    ", + "smithy.api#httpQuery": "recovery-window-in-days" + } + }, + "ForceDeleteWithoutRecovery": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "

    This option defaults to the value NoForceDeleteWithoutRecovery. To\n immediately delete the analysis, add the ForceDeleteWithoutRecovery option.\n You can't restore an analysis after it's deleted.

    ", + "smithy.api#httpQuery": "force-delete-without-recovery" } } } }, - "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { + "com.amazonaws.quicksight#DeleteAnalysisResponse": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deleted analysis.

    " + } + }, + "DeletionTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that the analysis is scheduled to be deleted.

    " + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the deleted analysis.

    " + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -3703,32 +4257,26 @@ "smithy.api#required": {} } }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

    The version number of the dashboard. If the version number property is provided, only\n the specified version of the dashboard is deleted.

    ", + "smithy.api#httpQuery": "version-number" + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're deleting.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're\n deleting.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    The version number of the dashboard. If the version number property is provided, only the\n\t\t\tspecified version of the dashboard is deleted.

    ", - "smithy.api#httpQuery": "version-number" - } } } }, "com.amazonaws.quicksight#DeleteDashboardResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Secure Socket Layer (SSL) properties that apply for the resource.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -3740,6 +4288,12 @@ "traits": { "smithy.api#documentation": "

    The ID of the dashboard.

    " } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Secure Socket Layer (SSL) properties that apply for the resource.

    " + } } } }, @@ -3801,18 +4355,18 @@ "com.amazonaws.quicksight#DeleteDataSetResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dataset.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dataset.

    " + } + }, "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -3847,7 +4401,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes the data source permanently. This action breaks \n\t\t\tall the datasets that reference the deleted data source.

    ", + "smithy.api#documentation": "

    Deletes the data source permanently. This operation breaks \n\t\t\tall the datasets that reference the deleted data source.

    ", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", @@ -4185,7 +4739,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the APIs for the relevant asset.

    ", + "smithy.api#documentation": "

    Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the API operations for the relevant asset.

    ", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", @@ -4302,6 +4856,14 @@ "com.amazonaws.quicksight#DeleteTemplateAliasRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the item to delete.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AliasName": { "target": "com.amazonaws.quicksight#AliasName", "traits": { @@ -4317,24 +4879,16 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the item to delete.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#DeleteTemplateAliasResponse": { "type": "structure", "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The name for the template alias.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the template you want to delete.

    " } }, "RequestId": { @@ -4343,10 +4897,10 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the template you want to delete.

    " + "smithy.api#documentation": "

    The name for the template alias.

    " } }, "TemplateId": { @@ -4360,6 +4914,14 @@ "com.amazonaws.quicksight#DeleteTemplateRequest": { "type": "structure", "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    An ID for the template you want to delete.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "VersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { @@ -4374,32 +4936,24 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    An ID for the template you want to delete.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#DeleteTemplateResponse": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " - } - }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "

    An ID for the template.

    " } }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -4517,12 +5071,6 @@ "com.amazonaws.quicksight#DeleteThemeAliasResponse": { "type": "structure", "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    An ID for the theme associated with the deletion.

    " - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -4535,6 +5083,12 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    An ID for the theme associated with the deletion.

    " + } + }, "AliasName": { "target": "com.amazonaws.quicksight#AliasName", "traits": { @@ -4574,10 +5128,10 @@ "com.amazonaws.quicksight#DeleteThemeResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    An ID for the theme.

    " } }, "Arn": { @@ -4586,10 +5140,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    An ID for the theme.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } } } @@ -4720,6 +5274,14 @@ "com.amazonaws.quicksight#DeleteUserRequest": { "type": "structure", "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

    The name of the user that you want to delete.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -4728,51 +5290,142 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The name of the user that you want to delete.

    ", + "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + } + } + }, + "com.amazonaws.quicksight#DeleteUserResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + } + } + }, + "com.amazonaws.quicksight#Delimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the customizations associated with the provided AWS account and Amazon\n QuickSight namespace in an AWS Region. The QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.

    \n

    To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

    \n
      \n
    • \n

      \n AWS Account - The AWS account exists at the top of the hierarchy.\n It has the potential to use all of the AWS Regions and AWS Services. When you\n subscribe to QuickSight, you choose one AWS Region to use as your home Region.\n That's where your free SPICE capacity is located. You can use QuickSight in any\n supported AWS Region.

      \n
      • \n
    • \n

      \n AWS Region - In each AWS Region where you sign in to QuickSight\n at least once, QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to QuickSight in any AWS\n Region, unless they are constrained to a namespace.

      \n

      To run the command in a different AWS Region, you change your Region settings.\n If you're using the AWS CLI, you can use one of the following options:

      \n \n
      • \n
    • \n

      \n Namespace - A QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same AWS account\n and AWS Region.

      \n
      • \n
    • \n

      \n Applied customizations - Within an AWS Region, a set of\n QuickSight customizations can apply to an AWS account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n AWS account. All settings are isolated to a single AWS Region. To apply them in\n other AWS Regions, run the CreateAccountCustomization command in\n each AWS Region where you want to apply the same customizations.

      \n
      • \n
    ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomizationRequest": { + "type": "structure", + "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", + "smithy.api#documentation": "

    The ID for the AWS account that you want to describe QuickSight customizations\n for.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Resolved": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "

    The Resolved flag works with the other parameters to determine which view\n of QuickSight customizations is returned. You can add this flag to your command to use\n the same view that QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved, to reveal customizations\n that are configured at different levels.

    ", + "smithy.api#httpQuery": "resolved" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

    The QuickSight namespace that you want to describe QuickSight customizations\n for.

    ", + "smithy.api#httpQuery": "namespace" + } } } }, - "com.amazonaws.quicksight#DeleteUserResponse": { + "com.amazonaws.quicksight#DescribeAccountCustomizationResponse": { "type": "structure", "members": { "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID for the AWS account that you're describing.

    " + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

    The QuickSight namespace that you're describing.

    " + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

    The QuickSight customizations that exist in the current AWS Region.

    " + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.

    " } } } }, - "com.amazonaws.quicksight#Delimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountCustomization": { + "com.amazonaws.quicksight#DescribeAccountSettings": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeAccountCustomizationRequest" + "target": "com.amazonaws.quicksight#DescribeAccountSettingsRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeAccountCustomizationResponse" + "target": "com.amazonaws.quicksight#DescribeAccountSettingsResponse" }, "errors": [ { @@ -4795,77 +5448,51 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes the customizations associated with your AWS account.

    ", + "smithy.api#documentation": "

    Describes the settings that were used when your QuickSight subscription was first\n created in this AWS account.

    ", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/customizations", + "uri": "/accounts/{AwsAccountId}/settings", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeAccountCustomizationRequest": { + "com.amazonaws.quicksight#DescribeAccountSettingsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that you want to describe QuickSight customizations for.

    ", + "smithy.api#documentation": "

    The ID for the AWS account that contains the settings that you want to list.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Resolved": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#documentation": "

    The status of the creation of the customization. This is an asynchronous process. A status\n of CREATED means that your customization is ready to use.

    ", - "smithy.api#httpQuery": "resolved" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

    The namespace associated with the customization that you're describing.

    ", - "smithy.api#httpQuery": "namespace" - } } } }, - "com.amazonaws.quicksight#DescribeAccountCustomizationResponse": { + "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

    The namespace associated with the customization that you're describing.

    " - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AccountSettings": { + "target": "com.amazonaws.quicksight#AccountSettings", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that you want to describe QuickSight customizations for.

    " + "smithy.api#documentation": "

    The QuickSight settings for this AWS account. This information includes the edition of Amazon\n QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes\n referred to as a QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the QuickSight service for your AWS account. The\n edition that you subscribe to applies to QuickSight in every AWS Region where you use it.

    " } }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The customizations associated with QuickSight.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } } } }, - "com.amazonaws.quicksight#DescribeAccountSettings": { + "com.amazonaws.quicksight#DescribeAnalysis": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeAccountSettingsRequest" + "target": "com.amazonaws.quicksight#DescribeAnalysisRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeAccountSettingsResponse" + "target": "com.amazonaws.quicksight#DescribeAnalysisResponse" }, "errors": [ { @@ -4881,41 +5508,133 @@ "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Provides a summary of the metadata for an analysis.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "

    Describes the settings that were used when your QuickSight subscription was first created \n in this AWS Account.

    ", + "smithy.api#documentation": "

    Provides the read and write permissions for an analysis.

    ", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/settings", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeAccountSettingsRequest": { + "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that contains the QuickSight namespaces that you want to list.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the analysis whose permissions you're\n describing. You must be using the AWS account that the analysis is in.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis whose permissions you're describing. The ID is part of the\n analysis URL.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { + "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse": { "type": "structure", "members": { - "AccountSettings": { - "target": "com.amazonaws.quicksight#AccountSettings", + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis whose permissions you're describing.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, + "AnalysisArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the analysis whose permissions you're\n describing.

    " + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A structure that describes the principals and the resource-level permissions on an\n analysis.

    " + } + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the analysis. You must be using the AWS\n account that the analysis is in.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisResponse": { + "type": "structure", + "members": { + "Analysis": { + "target": "com.amazonaws.quicksight#Analysis", "traits": { - "smithy.api#documentation": "

    The settings associated with the QuickSight subscription associated with this AWS account. This information includes the\n edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the\n notification email for the QuickSight subscription. The QuickSight console, the\n QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though\n it is technically not an account, but a subscription in your AWS account.

    " + "smithy.api#documentation": "

    A metadata structure that contains summary information for the analysis that you're\n describing.

    " } }, "RequestId": { @@ -5000,18 +5719,18 @@ "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest": { "type": "structure", "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the dashboard, also added to the IAM policy.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're describing\n permissions for.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're describing\n\t\t\tpermissions for.

    ", + "smithy.api#documentation": "

    The ID for the dashboard, also added to the IAM policy.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5033,31 +5752,23 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the dashboard.

    " - } - }, "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { "smithy.api#documentation": "

    A structure that contains the permissions for the dashboard.

    " } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the dashboard.

    " + } } } }, "com.amazonaws.quicksight#DescribeDashboardRequest": { "type": "structure", "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the dashboard.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AliasName": { "target": "com.amazonaws.quicksight#AliasName", "traits": { @@ -5065,10 +5776,10 @@ "smithy.api#httpQuery": "alias-name" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're describing.

    ", + "smithy.api#documentation": "

    The ID for the dashboard.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5076,9 +5787,17 @@ "VersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "

    The version number for the dashboard. If a version number isn't passed, the latest\n\t\t\tpublished dashboard version is described.

    ", + "smithy.api#documentation": "

    The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

    ", "smithy.api#httpQuery": "version-number" } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're\n describing.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -5170,18 +5889,18 @@ "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    ", + "smithy.api#documentation": "

    The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    ", + "smithy.api#documentation": "

    The AWS account ID.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5191,10 +5910,10 @@ "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    A list of resource permissions on the dataset.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, "DataSetArn": { @@ -5203,35 +5922,35 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dataset.

    " } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " - } - }, "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { "smithy.api#documentation": "

    The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    " } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A list of resource permissions on the dataset.

    " + } } } }, "com.amazonaws.quicksight#DescribeDataSetRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    ", + "smithy.api#documentation": "

    The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

    ", + "smithy.api#documentation": "

    The AWS account ID.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5326,18 +6045,18 @@ "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { "type": "structure", "members": { - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    ", + "smithy.api#documentation": "

    The AWS account ID.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    ", + "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5537,18 +6256,18 @@ "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the assignment that you want to describe.

    ", + "smithy.api#documentation": "

    The namespace that contains the assignment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The namespace that contains the assignment.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the assignment that you want to describe.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5564,19 +6283,19 @@ } }, "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " - } - }, + "type": "structure", + "members": { "IAMPolicyAssignment": { "target": "com.amazonaws.quicksight#IAMPolicyAssignment", "traits": { "smithy.api#documentation": "

    Information describing the IAM policy assignment.

    " } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } } } }, @@ -5620,6 +6339,14 @@ "com.amazonaws.quicksight#DescribeIngestionRequest": { "type": "structure", "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The ID of the dataset used in the ingestion.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -5635,31 +6362,23 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The ID of the dataset used in the ingestion.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#DescribeIngestionResponse": { "type": "structure", "members": { - "Ingestion": { - "target": "com.amazonaws.quicksight#Ingestion", - "traits": { - "smithy.api#documentation": "

    Information about the ingestion.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } + }, + "Ingestion": { + "target": "com.amazonaws.quicksight#Ingestion", + "traits": { + "smithy.api#documentation": "

    Information about the ingestion.

    " + } } } }, @@ -5727,7 +6446,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#NamespaceInfoV2", "traits": { - "smithy.api#documentation": "

    The information about the namespace that you're describing. The response includes \n the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API lists the namespace error types and messages associated with the creation process.

    " + "smithy.api#documentation": "

    The information about the namespace that you're describing. The response includes \n the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.

    " } }, "RequestId": { @@ -5815,18 +6534,18 @@ "com.amazonaws.quicksight#DescribeTemplateAliasRequest": { "type": "structure", "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The name of the template alias that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the template alias that you're\n\t\t\tdescribing.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the template alias that you're\n\t\t\tdescribing.

    ", + "smithy.api#documentation": "

    The name of the template alias that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5844,17 +6563,17 @@ "com.amazonaws.quicksight#DescribeTemplateAliasResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " - } - }, "TemplateAlias": { "target": "com.amazonaws.quicksight#TemplateAlias", "traits": { "smithy.api#documentation": "

    Information about the template alias.

    " } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } } } }, @@ -5948,6 +6667,14 @@ "com.amazonaws.quicksight#DescribeTemplateRequest": { "type": "structure", "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the template.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -5969,14 +6696,6 @@ "smithy.api#documentation": "

    (Optional) The number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the template is described.

    ", "smithy.api#httpQuery": "version-number" } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the template.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -6085,18 +6804,18 @@ "smithy.api#required": {} } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "

    The ID for the theme.

    ", + "smithy.api#documentation": "

    The name of the theme alias that you want to describe.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The name of the theme alias that you want to describe.

    ", + "smithy.api#documentation": "

    The ID for the theme.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6106,17 +6825,17 @@ "com.amazonaws.quicksight#DescribeThemeAliasResponse": { "type": "structure", "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "

    Information about the theme alias.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } + }, + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "

    Information about the theme alias.

    " + } } } }, @@ -6193,23 +6912,30 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

    A list of resource permissions set on the theme.

    " - } - }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "

    The ID for the theme.

    " } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A list of resource permissions set on the theme.

    " + } } } }, "com.amazonaws.quicksight#DescribeThemeRequest": { "type": "structure", "members": { + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

    The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to themes.

    ", + "smithy.api#httpQuery": "alias-name" + } + }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -6218,13 +6944,6 @@ "smithy.api#required": {} } }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

    The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to themes.

    ", - "smithy.api#httpQuery": "alias-name" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAndAccountId", "traits": { @@ -6310,18 +7029,18 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The name of the user that you want to describe.

    ", + "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "UserName": { + "target": "com.amazonaws.quicksight#UserName", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", + "smithy.api#documentation": "

    The name of the user that you want to describe.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6357,14 +7076,14 @@ "com.amazonaws.quicksight#DomainNotWhitelistedException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this request.

    " } + }, + "Message": { + "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -6558,17 +7277,17 @@ "com.amazonaws.quicksight#GeoSpatialColumnGroup": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.quicksight#ColumnGroupName", + "Columns": { + "target": "com.amazonaws.quicksight#ColumnList", "traits": { - "smithy.api#documentation": "

    A display name for the hierarchy.

    ", + "smithy.api#documentation": "

    Columns in this hierarchy.

    ", "smithy.api#required": {} } }, - "Columns": { - "target": "com.amazonaws.quicksight#ColumnList", + "Name": { + "target": "com.amazonaws.quicksight#ColumnGroupName", "traits": { - "smithy.api#documentation": "

    Columns in this hierarchy.

    ", + "smithy.api#documentation": "

    A display name for the hierarchy.

    ", "smithy.api#required": {} } }, @@ -6674,7 +7393,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Generates a URL and authorization code that you can embed in your web server code. Before\n\t\t\tyou use this command, make sure that you have configured the dashboards and permissions.

    \n\t\t

    Currently, you can use GetDashboardEmbedURL only from the server, not from the\n\t\t\tuser's browser. The following rules apply to the combination of URL and\n\t\t\tauthorization code:

    \n\t\t
      \n
    • \n\t\t\t\t

      They must be used together.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      They can be used one time only.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      They are valid for 5 minutes after you run this command.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      The resulting user session is valid for 10 hours.

      \n\t\t\t
      • \n
    \n\t\t

    For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User\n\t\t\tGuide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API\n\t\t\tReference.

    ", + "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
    • \n

      They must be used together.

      \n
      • \n
    • \n

      They can be used one time only.

      \n
      • \n
    • \n

      They are valid for 5 minutes after you run this command.

      \n
      • \n
    • \n

      The resulting user session is valid for 10 hours.

      \n
      • \n
    \n

    For more information, see Embedding Amazon QuickSight in the Amazon QuickSight User\n Guide\n .

    ", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", @@ -6685,13 +7404,6 @@ "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest": { "type": "structure", "members": { - "ResetDisabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#documentation": "

    Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.

    ", - "smithy.api#httpQuery": "reset-disabled" - } - }, "SessionLifetimeInMinutes": { "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", "traits": { @@ -6699,6 +7411,13 @@ "smithy.api#httpQuery": "session-lifetime" } }, + "ResetDisabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "

    Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.

    ", + "smithy.api#httpQuery": "reset-disabled" + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -6715,17 +7434,10 @@ "smithy.api#required": {} } }, - "UndoRedoDisabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#documentation": "

    Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.

    ", - "smithy.api#httpQuery": "undo-redo-disabled" - } - }, "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 Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      Active Directory (AD) users or group members

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      Invited nonfederated users

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using\n\t\t\t\t\tSAML, OpenID Connect, or IAM federation.

      \n\t\t\t
      • \n
    ", + "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 Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      Active Directory (AD) users or group members

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      Invited nonfederated users

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using\n\t\t\t\t\tSAML, OpenID Connect, or IAM federation.

      \n\t\t\t
      • \n
    \n

    Omit this parameter for users in the third group – IAM users and IAM\n role-based sessions.

    ", "smithy.api#httpQuery": "user-arn" } }, @@ -6736,6 +7448,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "UndoRedoDisabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "

    Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.

    ", + "smithy.api#httpQuery": "undo-redo-disabled" + } } } }, @@ -6745,7 +7464,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "

    A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

    " + "smithy.api#documentation": "

    A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

    " } }, "RequestId": { @@ -6794,7 +7513,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Generates a session URL and authorization code that you can embed in your web server code.

    ", + "smithy.api#documentation": "

    Generates a session URL and authorization code that you can use to embed the Amazon\n QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/session-embed-url", @@ -6812,10 +7531,17 @@ "smithy.api#httpQuery": "session-lifetime" } }, + "EntryPoint": { + "target": "com.amazonaws.quicksight#EntryPoint", + "traits": { + "smithy.api#documentation": "

    The URL you use to access the embedded session. The entry point URL is constrained to \n the following paths:

    \n
      \n
    • \n

      \n /start\n

      \n
      • \n
    • \n

      \n /start/analyses\n

      \n
      • \n
    • \n

      \n /start/dashboards\n

      \n
      • \n
    • \n

      \n /start/favorites\n

      \n
      • \n
    • \n

      \n /dashboards/DashboardId\n - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard

      \n
      • \n
    • \n

      \n /analyses/AnalysisId\n - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis

      \n
      • \n
    ", + "smithy.api#httpQuery": "entry-point" + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that contains the QuickSight session that you're embedding.

    ", + "smithy.api#documentation": "

    The ID for the AWS account associated with your QuickSight subscription.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6823,16 +7549,9 @@ "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 Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      Active Directory (AD) users or group members

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      Invited nonfederated users

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using\n\t\t\t\t\tSAML, OpenID Connect, or IAM federation.

      \n\t\t\t
      • \n
    ", + "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#httpQuery": "user-arn" } - }, - "EntryPoint": { - "target": "com.amazonaws.quicksight#EntryPoint", - "traits": { - "smithy.api#documentation": "

    The entry point for the embedded session.

    ", - "smithy.api#httpQuery": "entry-point" - } } } }, @@ -6842,7 +7561,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "

    A single-use URL that you can put into your server-side web page to embed your\n\t\t\tQuickSight session. This URL is valid for 5 minutes. The API provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

    " + "smithy.api#documentation": "

    A single-use URL that you can put into your server-side web page to embed your\n\t\t\tQuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

    " } }, "RequestId": { @@ -6882,7 +7601,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A group in Amazon QuickSight consists of a set of users. You can\n use groups to make it easier to manage access and security. Currently, an Amazon\n QuickSight subscription can't contain more than 500 Amazon QuickSight groups.

    " + "smithy.api#documentation": "

    A group in Amazon QuickSight consists of a set of users. You can\n use groups to make it easier to manage access and security.

    " } }, "com.amazonaws.quicksight#GroupDescription": { @@ -6978,16 +7697,10 @@ "com.amazonaws.quicksight#IAMPolicyAssignment": { "type": "structure", "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

    Assignment name.

    " - } - }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    Assignment ID.

    " + "smithy.api#documentation": "

    The AWS account ID.

    " } }, "PolicyArn": { @@ -6996,22 +7709,28 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the IAM policy.

    " } }, + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    Assignment ID.

    " + } + }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { "smithy.api#documentation": "

    Identities.

    " } }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "

    Assignment status.

    " + "smithy.api#documentation": "

    Assignment name.

    " } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    " + "smithy.api#documentation": "

    Assignment status.

    " } } }, @@ -7031,17 +7750,17 @@ "com.amazonaws.quicksight#IAMPolicyAssignmentSummary": { "type": "structure", "members": { - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

    Assignment status.

    " - } - }, "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { "smithy.api#documentation": "

    Assignment name.

    " } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

    Assignment status.

    " + } } }, "traits": { @@ -7133,9 +7852,6 @@ "smithy.api#required": {} } }, - "RowInfo": { - "target": "com.amazonaws.quicksight#RowInfo" - }, "IngestionSizeInBytes": { "target": "com.amazonaws.quicksight#Long", "traits": { @@ -7143,17 +7859,21 @@ "smithy.api#documentation": "

    The size of the data ingested, in bytes.

    " } }, - "IngestionStatus": { - "target": "com.amazonaws.quicksight#IngestionStatus", + "RowInfo": { + "target": "com.amazonaws.quicksight#RowInfo" + }, + "IngestionTimeInSeconds": { + "target": "com.amazonaws.quicksight#Long", "traits": { - "smithy.api#documentation": "

    Ingestion status.

    ", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

    The time that this ingestion took, measured in seconds.

    " } }, - "RequestType": { - "target": "com.amazonaws.quicksight#IngestionRequestType", + "IngestionStatus": { + "target": "com.amazonaws.quicksight#IngestionStatus", "traits": { - "smithy.api#documentation": "

    Type of this ingestion.

    " + "smithy.api#documentation": "

    Ingestion status.

    ", + "smithy.api#required": {} } }, "ErrorInfo": { @@ -7162,8 +7882,11 @@ "smithy.api#documentation": "

    Error information for this ingestion.

    " } }, - "QueueInfo": { - "target": "com.amazonaws.quicksight#QueueInfo" + "RequestType": { + "target": "com.amazonaws.quicksight#IngestionRequestType", + "traits": { + "smithy.api#documentation": "

    Type of this ingestion.

    " + } }, "IngestionId": { "target": "com.amazonaws.quicksight#IngestionId", @@ -7171,13 +7894,6 @@ "smithy.api#documentation": "

    Ingestion ID.

    " } }, - "IngestionTimeInSeconds": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The time that this ingestion took, measured in seconds.

    " - } - }, "CreatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { @@ -7185,6 +7901,9 @@ "smithy.api#required": {} } }, + "QueueInfo": { + "target": "com.amazonaws.quicksight#QueueInfo" + }, "RequestSource": { "target": "com.amazonaws.quicksight#IngestionRequestSource", "traits": { @@ -7538,23 +8257,23 @@ "com.amazonaws.quicksight#IntegerParameter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", + "Values": { + "target": "com.amazonaws.quicksight#LongList", "traits": { - "smithy.api#documentation": "

    A display name for the dataset.

    ", + "smithy.api#documentation": "

    The values for the integer parameter.

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.quicksight#LongList", + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Values.

    ", + "smithy.api#documentation": "

    The name of the integer parameter.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Integer parameter.

    " + "smithy.api#documentation": "

    An integer parameter.

    " } }, "com.amazonaws.quicksight#IntegerParameterList": { @@ -7651,17 +8370,17 @@ "smithy.api#required": {} } }, - "LeftOperand": { - "target": "com.amazonaws.quicksight#LogicalTableId", + "OnClause": { + "target": "com.amazonaws.quicksight#OnClause", "traits": { - "smithy.api#documentation": "

    Left operand.

    ", + "smithy.api#documentation": "

    On Clause.

    ", "smithy.api#required": {} } }, - "OnClause": { - "target": "com.amazonaws.quicksight#OnClause", + "LeftOperand": { + "target": "com.amazonaws.quicksight#LogicalTableId", "traits": { - "smithy.api#documentation": "

    On Clause.

    ", + "smithy.api#documentation": "

    Left operand.

    ", "smithy.api#required": {} } }, @@ -7725,6 +8444,93 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.quicksight#ListAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAnalysesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists Amazon QuickSight analyses that exist in the specified AWS account.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAnalysesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to return.

    ", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    ", + "smithy.api#httpQuery": "next-token" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the analyses.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#ListAnalysesResponse": { + "type": "structure", + "members": { + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "traits": { + "smithy.api#documentation": "

    Metadata describing each of the analyses that are listed.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " + } + } + } + }, "com.amazonaws.quicksight#ListDashboardVersions": { "type": "operation", "input": { @@ -7788,7 +8594,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're listing versions\n\t\t\tfor.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're listing versions\n for.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7865,14 +8671,6 @@ "com.amazonaws.quicksight#ListDashboardsRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboards that you're listing.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -7880,6 +8678,14 @@ "smithy.api#httpQuery": "next-token" } }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboards that you're\n listing.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -7896,7 +8702,7 @@ "DashboardSummaryList": { "target": "com.amazonaws.quicksight#DashboardSummaryList", "traits": { - "smithy.api#documentation": "

    A structure that contains all of the dashboards in your AWS account. This structure\n\t\t\tprovides basic information about the dashboards.

    " + "smithy.api#documentation": "

    A structure that contains all of the dashboards in your AWS account. This structure\n provides basic information about the dashboards.

    " } }, "NextToken": { @@ -7989,16 +8795,16 @@ "smithy.api#documentation": "

    The list of dataset summaries.

    " } }, - "RequestId": { + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } } } @@ -8073,6 +8879,12 @@ "com.amazonaws.quicksight#ListDataSourcesResponse": { "type": "structure", "members": { + "DataSources": { + "target": "com.amazonaws.quicksight#DataSourceList", + "traits": { + "smithy.api#documentation": "

    A list of data sources.

    " + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -8084,12 +8896,6 @@ "traits": { "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } - }, - "DataSources": { - "target": "com.amazonaws.quicksight#DataSourceList", - "traits": { - "smithy.api#documentation": "

    A list of data sources.

    " - } } } }, @@ -8139,12 +8945,12 @@ "com.amazonaws.quicksight#ListGroupMembershipsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of results to return from this request.

    ", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "

    The name of the group that you want to see a membership list of.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "NextToken": { @@ -8154,12 +8960,12 @@ "smithy.api#httpQuery": "next-token" } }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", "traits": { - "smithy.api#documentation": "

    The name of the group that you want to see a membership list of.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to return from this request.

    ", + "smithy.api#httpQuery": "max-results" } }, "Namespace": { @@ -8183,16 +8989,16 @@ "com.amazonaws.quicksight#ListGroupMembershipsResponse": { "type": "structure", "members": { - "RequestId": { + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, "GroupMemberList": { @@ -8256,14 +9062,6 @@ "smithy.api#httpQuery": "next-token" } }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of results to return.

    ", - "smithy.api#httpQuery": "max-results" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -8272,6 +9070,14 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to return.

    ", + "smithy.api#httpQuery": "max-results" + } + }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -8385,18 +9191,18 @@ "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the assignments.

    ", + "smithy.api#documentation": "

    The namespace of the assignment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The namespace of the assignment.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the assignments.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8409,13 +9215,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", - "smithy.api#httpQuery": "next-token" - } - }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -8423,6 +9222,13 @@ "smithy.api#documentation": "

    The maximum number of results to be returned per request.

    ", "smithy.api#httpQuery": "max-results" } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", + "smithy.api#httpQuery": "next-token" + } } } }, @@ -8467,10 +9273,12 @@ "smithy.api#httpQuery": "next-token" } }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The status of the assignments.

    " + "smithy.api#documentation": "

    The namespace for the assignments.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "AwsAccountId": { @@ -8481,12 +9289,10 @@ "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "

    The namespace for the assignments.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The status of the assignments.

    " } } } @@ -8494,6 +9300,12 @@ "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse": { "type": "structure", "members": { + "IAMPolicyAssignments": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", + "traits": { + "smithy.api#documentation": "

    Information describing the IAM policy assignments.

    " + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -8505,12 +9317,6 @@ "traits": { "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " } - }, - "IAMPolicyAssignments": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", - "traits": { - "smithy.api#documentation": "

    Information describing the IAM policy assignments.

    " - } } } }, @@ -8561,14 +9367,7 @@ }, "com.amazonaws.quicksight#ListIngestionsRequest": { "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", - "smithy.api#httpQuery": "next-token" - } - }, + "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -8577,6 +9376,13 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", + "smithy.api#httpQuery": "next-token" + } + }, "DataSetId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -8669,14 +9475,6 @@ "com.amazonaws.quicksight#ListNamespacesRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that contains the QuickSight namespaces that you want to list.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -8685,6 +9483,14 @@ "smithy.api#httpQuery": "max-results" } }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID for the AWS account that contains the QuickSight namespaces that you want to list.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -8697,10 +9503,10 @@ "com.amazonaws.quicksight#ListNamespacesResponse": { "type": "structure", "members": { - "Namespaces": { - "target": "com.amazonaws.quicksight#Namespaces", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The information about the namespaces in this AWS account. The response includes \n the namespace ARN, name, AWS Region, notification email address, creation status, and \n identity store.

    " + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " } }, "RequestId": { @@ -8709,10 +9515,10 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "Namespaces": { + "target": "com.amazonaws.quicksight#Namespaces", "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " + "smithy.api#documentation": "

    The information about the namespaces in this AWS account. The response includes \n the namespace ARN, name, AWS Region, notification email address, creation status, and \n identity store.

    " } } } @@ -8767,17 +9573,17 @@ "com.amazonaws.quicksight#ListTagsForResourceResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " - } - }, "Tags": { "target": "com.amazonaws.quicksight#TagList", "traits": { "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the\n\t\t\tresource.

    " } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } } } }, @@ -8823,6 +9629,13 @@ "com.amazonaws.quicksight#ListTemplateAliasesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -8831,13 +9644,6 @@ "smithy.api#httpQuery": "max-result" } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", - "smithy.api#httpQuery": "next-token" - } - }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -8865,16 +9671,16 @@ "smithy.api#documentation": "

    A structure containing the list of the template's aliases.

    " } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "RequestId": { + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " } } } @@ -8924,14 +9730,6 @@ "com.amazonaws.quicksight#ListTemplateVersionsRequest": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the template.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -8940,10 +9738,10 @@ "smithy.api#httpQuery": "max-results" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the templates that you're listing.

    ", + "smithy.api#documentation": "

    The ID for the template.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8954,6 +9752,14 @@ "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", "smithy.api#httpQuery": "next-token" } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the templates that you're listing.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -9032,14 +9838,6 @@ "smithy.api#httpQuery": "next-token" } }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of results to be returned per request.

    ", - "smithy.api#httpQuery": "max-result" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -9047,22 +9845,30 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to be returned per request.

    ", + "smithy.api#httpQuery": "max-result" + } } } }, "com.amazonaws.quicksight#ListTemplatesResponse": { "type": "structure", "members": { - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "RequestId": { + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " } }, "TemplateSummaryList": { @@ -9124,6 +9930,13 @@ "smithy.api#httpQuery": "max-result" } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", + "smithy.api#httpQuery": "next-token" + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -9132,13 +9945,6 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", - "smithy.api#httpQuery": "next-token" - } - }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -9223,6 +10029,13 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -9238,13 +10051,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", - "smithy.api#httpQuery": "next-token" - } } } }, @@ -9330,31 +10136,25 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", - "smithy.api#httpQuery": "next-token" - } - }, "Type": { "target": "com.amazonaws.quicksight#ThemeType", "traits": { "smithy.api#documentation": "

    The type of themes that you want to list. Valid options include the following:

    \n \t
      \n
    • \n

      \n ALL (default)- Display all existing themes.

      \n
      • \n
    • \n

      \n CUSTOM - Display only the themes created by people using Amazon QuickSight.

      \n
      • \n
    • \n

      \n QUICKSIGHT - Display only the starting themes defined by QuickSight.

      \n
      • \n
    ", "smithy.api#httpQuery": "type" } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    ", + "smithy.api#httpQuery": "next-token" + } } } }, "com.amazonaws.quicksight#ListThemesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9366,6 +10166,12 @@ "traits": { "smithy.api#documentation": "

    Information about the themes in the list.

    " } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + } } } }, @@ -9420,6 +10226,14 @@ "smithy.api#httpQuery": "max-results" } }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID that the user is in. Currently, you use the ID for the AWS account\n\t\t\tthat contains your Amazon QuickSight account.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -9435,14 +10249,6 @@ "smithy.api#httpQuery": "next-token" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

    The AWS account ID that the user is in. Currently, you use the ID for the AWS account\n\t\t\tthat contains your Amazon QuickSight account.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "UserName": { "target": "com.amazonaws.quicksight#UserName", "traits": { @@ -9462,17 +10268,17 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", - "traits": { - "smithy.api#documentation": "

    The list of groups the user is a member of.

    " - } - }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " } + }, + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

    The list of groups the user is a member of.

    " + } } } }, @@ -9522,6 +10328,13 @@ "com.amazonaws.quicksight#ListUsersRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    ", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -9530,11 +10343,12 @@ "smithy.api#httpQuery": "max-results" } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    ", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Namespace": { @@ -9544,14 +10358,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -9564,16 +10370,16 @@ "smithy.api#documentation": "

    The list of users.

    " } }, - "RequestId": { + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } } } @@ -9588,18 +10394,18 @@ "smithy.api#required": {} } }, - "DataTransforms": { - "target": "com.amazonaws.quicksight#TransformOperationList", - "traits": { - "smithy.api#documentation": "

    Transform operations that act on this logical table.

    " - } - }, "Alias": { "target": "com.amazonaws.quicksight#LogicalTableAlias", "traits": { "smithy.api#documentation": "

    A display name for the logical table.

    ", "smithy.api#required": {} } + }, + "DataTransforms": { + "target": "com.amazonaws.quicksight#TransformOperationList", + "traits": { + "smithy.api#documentation": "

    Transform operations that act on this logical table.

    " + } } }, "traits": { @@ -9709,13 +10515,6 @@ "com.amazonaws.quicksight#MariaDbParameters": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

    Port.

    ", - "smithy.api#required": {} - } - }, "Database": { "target": "com.amazonaws.quicksight#Database", "traits": { @@ -9726,7 +10525,14 @@ "Host": { "target": "com.amazonaws.quicksight#Host", "traits": { - "smithy.api#documentation": "

    Host.

    ", + "smithy.api#documentation": "

    Host.

    ", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

    Port.

    ", "smithy.api#required": {} } } @@ -9747,13 +10553,6 @@ "com.amazonaws.quicksight#MySqlParameters": { "type": "structure", "members": { - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

    Database.

    ", - "smithy.api#required": {} - } - }, "Port": { "target": "com.amazonaws.quicksight#Port", "traits": { @@ -9767,6 +10566,13 @@ "smithy.api#documentation": "

    Host.

    ", "smithy.api#required": {} } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

    Database.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -9821,6 +10627,12 @@ "com.amazonaws.quicksight#NamespaceInfoV2": { "type": "structure", "members": { + "CapacityRegion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The namespace AWS Region.

    " + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -9839,22 +10651,16 @@ "smithy.api#documentation": "

    The identity store used for the namespace.

    " } }, - "CapacityRegion": { - "target": "com.amazonaws.quicksight#String", + "CreationStatus": { + "target": "com.amazonaws.quicksight#NamespaceStatus", "traits": { - "smithy.api#documentation": "

    The namespace AWS Region.

    " + "smithy.api#documentation": "

    The creation status of a namespace that is not yet completely created.

    " } }, "NamespaceError": { "target": "com.amazonaws.quicksight#NamespaceError", "traits": { - "smithy.api#documentation": "

    An error that occured when the namespace was created.

    " - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#NamespaceStatus", - "traits": { - "smithy.api#documentation": "

    The creation status of a namespace that is not yet completely created.

    " + "smithy.api#documentation": "

    An error that occurred when the namespace was created.

    " } } }, @@ -9948,22 +10754,22 @@ "com.amazonaws.quicksight#Parameters": { "type": "structure", "members": { - "StringParameters": { - "target": "com.amazonaws.quicksight#StringParameterList", - "traits": { - "smithy.api#documentation": "

    String parameters.

    " - } - }, "DecimalParameters": { "target": "com.amazonaws.quicksight#DecimalParameterList", "traits": { "smithy.api#documentation": "

    Decimal parameters.

    " } }, + "StringParameters": { + "target": "com.amazonaws.quicksight#StringParameterList", + "traits": { + "smithy.api#documentation": "

    String parameters.

    " + } + }, "DateTimeParameters": { "target": "com.amazonaws.quicksight#DateTimeParameterList", "traits": { - "smithy.api#documentation": "

    DateTime parameters.

    " + "smithy.api#documentation": "

    Date-time parameters.

    " } }, "IntegerParameters": { @@ -9974,7 +10780,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Parameters.

    " + "smithy.api#documentation": "

    A list of QuickSight parameters and the list's override values.

    " } }, "com.amazonaws.quicksight#Password": { @@ -9995,17 +10801,17 @@ "smithy.api#documentation": "

    A physical table type for relational data sources.

    " } }, - "CustomSql": { - "target": "com.amazonaws.quicksight#CustomSql", - "traits": { - "smithy.api#documentation": "

    A physical table type built from the results of the custom SQL query.

    " - } - }, "S3Source": { "target": "com.amazonaws.quicksight#S3Source", "traits": { "smithy.api#documentation": "

    A physical table type for as S3 data source.

    " } + }, + "CustomSql": { + "target": "com.amazonaws.quicksight#CustomSql", + "traits": { + "smithy.api#documentation": "

    A physical table type built from the results of the custom SQL query.

    " + } } }, "traits": { @@ -10201,14 +11007,14 @@ "com.amazonaws.quicksight#QuickSightUserNotFoundException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this request.

    " } - }, - "Message": { - "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -10227,6 +11033,9 @@ { "target": "com.amazonaws.quicksight#CreateAccountCustomization" }, + { + "target": "com.amazonaws.quicksight#CreateAnalysis" + }, { "target": "com.amazonaws.quicksight#CreateDashboard" }, @@ -10266,6 +11075,9 @@ { "target": "com.amazonaws.quicksight#DeleteAccountCustomization" }, + { + "target": "com.amazonaws.quicksight#DeleteAnalysis" + }, { "target": "com.amazonaws.quicksight#DeleteDashboard" }, @@ -10311,6 +11123,12 @@ { "target": "com.amazonaws.quicksight#DescribeAccountSettings" }, + { + "target": "com.amazonaws.quicksight#DescribeAnalysis" + }, + { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissions" + }, { "target": "com.amazonaws.quicksight#DescribeDashboard" }, @@ -10368,6 +11186,9 @@ { "target": "com.amazonaws.quicksight#GetSessionEmbedUrl" }, + { + "target": "com.amazonaws.quicksight#ListAnalyses" + }, { "target": "com.amazonaws.quicksight#ListDashboards" }, @@ -10428,6 +11249,12 @@ { "target": "com.amazonaws.quicksight#RegisterUser" }, + { + "target": "com.amazonaws.quicksight#RestoreAnalysis" + }, + { + "target": "com.amazonaws.quicksight#SearchAnalyses" + }, { "target": "com.amazonaws.quicksight#SearchDashboards" }, @@ -10443,6 +11270,12 @@ { "target": "com.amazonaws.quicksight#UpdateAccountSettings" }, + { + "target": "com.amazonaws.quicksight#UpdateAnalysis" + }, + { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissions" + }, { "target": "com.amazonaws.quicksight#UpdateDashboard" }, @@ -10503,7 +11336,7 @@ "name": "quicksight" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon QuickSight API Reference\n\t\t

    Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS\n\t\t\tCloud that makes it easy to extend data and insights to every user in your organization.\n\t\t\tThis API reference contains documentation for a programming interface that you can use\n\t\t\tto manage Amazon QuickSight.

    ", + "smithy.api#documentation": "Amazon QuickSight API Reference\n

    Amazon QuickSight is a fully managed, serverless business intelligence service for the\n AWS Cloud that makes it easy to extend data and insights to every user in your\n organization. This API reference contains documentation for a programming interface that\n you can use to manage Amazon QuickSight.

    ", "smithy.api#title": "Amazon QuickSight" } }, @@ -10529,9 +11362,25 @@ "smithy.api#documentation": "

    Amazon RDS parameters.

    " } }, + "com.amazonaws.quicksight#RecoveryWindowInDays": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 7, + "max": 30 + } + } + }, "com.amazonaws.quicksight#RedshiftParameters": { "type": "structure", "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

    Host. This field can be blank if ClusterId is provided.

    " + } + }, "Database": { "target": "com.amazonaws.quicksight#Database", "traits": { @@ -10539,12 +11388,6 @@ "smithy.api#required": {} } }, - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

    Host. This field can be blank if ClusterId is provided.

    " - } - }, "Port": { "target": "com.amazonaws.quicksight#OptionalPort", "traits": { @@ -10611,6 +11454,18 @@ "com.amazonaws.quicksight#RegisterUserRequest": { "type": "structure", "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

    The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.

    " + } + }, + "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

    " + } + }, "IdentityType": { "target": "com.amazonaws.quicksight#IdentityType", "traits": { @@ -10618,10 +11473,10 @@ "smithy.api#required": {} } }, - "SessionName": { - "target": "com.amazonaws.quicksight#RoleSessionName", + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", "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": "

    (Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

    \n
      \n
    • \n

      Create and update data sources

      \n
      • \n
    • \n

      Create and update datasets

      \n
      • \n
    • \n

      Create and update email reports

      \n
      • \n
    • \n

      Subscribe to email reports

      \n
      • \n
    \n

    To add custom permissions to an existing user, use \n UpdateUser\n instead.

    \n

    A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.

    \n

    QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).

    \n

    This feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).

    " } }, "IamArn": { @@ -10630,10 +11485,11 @@ "smithy.api#documentation": "

    The ARN of the IAM user or role that you are registering with Amazon QuickSight.

    " } }, - "UserRole": { - "target": "com.amazonaws.quicksight#UserRole", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n READER: A user who has read-only access to dashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n RESTRICTED_READER: This role isn't currently available for\n\t\t\t\t\tuse.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n RESTRICTED_AUTHOR: This role isn't currently available for\n\t\t\t\t\tuse.

      \n\t\t\t
      • \n
    ", + "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -10645,32 +11501,19 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "UserRole": { + "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n READER: A user who has read-only access to dashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n RESTRICTED_READER: This role isn't currently available for\n\t\t\t\t\tuse.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n RESTRICTED_AUTHOR: This role isn't currently available for\n\t\t\t\t\tuse.

      \n\t\t\t
      • \n
    ", "smithy.api#required": {} } }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

    (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.\n Currently, custom permissions profile names are assigned to permissions profiles in the \n QuickSight console. You use this API to assign the named set of permissions to a \n QuickSight user.

    \n \n

    Customizing permissions in the QuickSight UI allows you to control a user's access\n to the following operations:

    \n
      \n
    • \n

      \n
      • \n
    • \n

      \n
      • \n
    • \n

      \n
      • \n
    • \n

      \n
      • \n
    \n

    QuickSight custom permissions are applied through IAM policies. Therefore, they \n override the permissions typically granted by assigning QuickSight users to \n one of the default security cohorts (admin, author, reader) in QuickSight.

    \n

    This feature is available only to QuickSight Enterprise edition subscriptions that\n use SAML 2.0-Based Federation for Single Sign-On (SSO).

    " - } - }, "Email": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The email address of the user that you want to register.

    ", "smithy.api#required": {} } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

    The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.

    " - } } } }, @@ -10692,7 +11535,7 @@ "User": { "target": "com.amazonaws.quicksight#User", "traits": { - "smithy.api#documentation": "

    The user name.

    " + "smithy.api#documentation": "

    The user's user name.

    " } } } @@ -10706,17 +11549,17 @@ "smithy.api#documentation": "

    The schema name. This name applies to certain relational database engines.

    " } }, - "Name": { - "target": "com.amazonaws.quicksight#RelationalTableName", + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The name of the relational table.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the data source.

    ", "smithy.api#required": {} } }, - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", + "Name": { + "target": "com.amazonaws.quicksight#RelationalTableName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the data source.

    ", + "smithy.api#documentation": "

    The name of the relational table.

    ", "smithy.api#required": {} } }, @@ -10837,17 +11680,17 @@ "com.amazonaws.quicksight#ResourcePermission": { "type": "structure", "members": { - "Actions": { - "target": "com.amazonaws.quicksight#ActionList", + "Principal": { + "target": "com.amazonaws.quicksight#Principal", "traits": { - "smithy.api#documentation": "

    The action to grant or revoke permissions on, for example\n \"quicksight:DescribeDashboard\".

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

    \n
      \n
    • \n

      The ARN of an Amazon QuickSight user, group, or namespace. (This is most\n common.)

      \n
      • \n
    • \n

      The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across AWS accounts.\n (This is less common.)

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Principal": { - "target": "com.amazonaws.quicksight#Principal", + "Actions": { + "target": "com.amazonaws.quicksight#ActionList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

    \n
      \n
    • \n

      The ARN of an Amazon QuickSight user, group, or namespace. (This is most\n common.)

      \n
      • \n
    • \n

      The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across AWS accounts.\n (This is less common.)

      \n
      • \n
    ", + "smithy.api#documentation": "

    The IAM action to grant or revoke permissions on, for example\n \"quicksight:DescribeDashboard\".

    ", "smithy.api#required": {} } } @@ -10868,60 +11711,145 @@ } } }, - "com.amazonaws.quicksight#ResourceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATION_IN_PROGRESS", - "name": "CREATION_IN_PROGRESS" - }, - { - "value": "CREATION_SUCCESSFUL", - "name": "CREATION_SUCCESSFUL" - }, - { - "value": "CREATION_FAILED", - "name": "CREATION_FAILED" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "UPDATE_SUCCESSFUL", - "name": "UPDATE_SUCCESSFUL" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" + "com.amazonaws.quicksight#ResourceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATION_IN_PROGRESS", + "name": "CREATION_IN_PROGRESS" + }, + { + "value": "CREATION_SUCCESSFUL", + "name": "CREATION_SUCCESSFUL" + }, + { + "value": "CREATION_FAILED", + "name": "CREATION_FAILED" + }, + { + "value": "UPDATE_IN_PROGRESS", + "name": "UPDATE_IN_PROGRESS" + }, + { + "value": "UPDATE_SUCCESSFUL", + "name": "UPDATE_SUCCESSFUL" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.quicksight#ResourceUnavailableException": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

    The resource type for this request.

    " + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this request.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    This resource is currently unavailable.

    ", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.quicksight#RestoreAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#RestoreAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#RestoreAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Restores an analysis.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#RestoreAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the analysis.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - ] + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis that you're restoring.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } } }, - "com.amazonaws.quicksight#ResourceUnavailableException": { + "com.amazonaws.quicksight#RestoreAnalysisResponse": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The resource type for this request.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "Message": { - "target": "com.amazonaws.quicksight#String" + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis that you're restoring.\n

    " + } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this request.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the analysis that you're restoring.

    " } } - }, - "traits": { - "smithy.api#documentation": "

    This resource is currently unavailable.

    ", - "smithy.api#error": "server", - "smithy.api#httpError": 503 } }, "com.amazonaws.quicksight#RestrictiveResourceId": { @@ -11055,10 +11983,11 @@ "com.amazonaws.quicksight#S3Source": { "type": "structure", "members": { - "UploadSettings": { - "target": "com.amazonaws.quicksight#UploadSettings", + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    Information about the format for the S3 source file or files.

    " + "smithy.api#documentation": "

    The amazon Resource Name (ARN) for the data source.

    ", + "smithy.api#required": {} } }, "InputColumns": { @@ -11068,11 +11997,10 @@ "smithy.api#required": {} } }, - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", + "UploadSettings": { + "target": "com.amazonaws.quicksight#UploadSettings", "traits": { - "smithy.api#documentation": "

    The amazon Resource Name (ARN) for the data source.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Information about the format for the S3 source file or files.

    " } } }, @@ -11080,13 +12008,13 @@ "smithy.api#documentation": "

    A physical table type for as S3 data source.

    " } }, - "com.amazonaws.quicksight#SearchDashboards": { + "com.amazonaws.quicksight#SearchAnalyses": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#SearchDashboardsRequest" + "target": "com.amazonaws.quicksight#SearchAnalysesRequest" }, "output": { - "target": "com.amazonaws.quicksight#SearchDashboardsResponse" + "target": "com.amazonaws.quicksight#SearchAnalysesResponse" }, "errors": [ { @@ -11109,10 +12037,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Searchs for dashboards that belong to a user.

    ", + "smithy.api#documentation": "

    Searches for analyses that belong to the user specified in the filter.

    ", "smithy.api#http": { "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/dashboards", + "uri": "/accounts/{AwsAccountId}/search/analyses", "code": 200 }, "smithy.api#paginated": { @@ -11122,51 +12050,150 @@ } } }, - "com.amazonaws.quicksight#SearchDashboardsRequest": { + "com.amazonaws.quicksight#SearchAnalysesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to be returned per request.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to return.

    " } }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the user whose dashboards you're searching for. \n\t\t

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the analyses that you're searching\n for.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.

    " + } + }, "Filters": { - "target": "com.amazonaws.quicksight#DashboardSearchFilterList", + "target": "com.amazonaws.quicksight#AnalysisSearchFilterList", "traits": { - "smithy.api#documentation": "

    The filters to apply to the search. Currently, you can search only by user name, \n\t\t\tfor example, \"Filters\": [\n\t\t\t\t{\n\t\t\t\t\"Name\": \"QUICKSIGHT_USER\",\n\t\t\t\t\"Operator\": \"StringEquals\",\n\t\t\t\t\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"\n\t\t\t\t}\n\t\t\t\t]\n

    ", + "smithy.api#documentation": "

    The structure for the search filters that you want to apply to your search.

    ", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.quicksight#SearchAnalysesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    A pagination token that can be used in a subsequent request.\n

    " + } + }, + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "traits": { + "smithy.api#documentation": "

    Metadata describing the analyses that you searched for.

    " } } } }, - "com.amazonaws.quicksight#SearchDashboardsResponse": { + "com.amazonaws.quicksight#SearchDashboards": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchDashboardsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchDashboardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Searches for dashboards that belong to a user.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/dashboards", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchDashboardsRequest": { "type": "structure", "members": { - "RequestId": { + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to be returned per request.

    " + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the user whose dashboards you're searching\n for.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " } }, + "Filters": { + "target": "com.amazonaws.quicksight#DashboardSearchFilterList", + "traits": { + "smithy.api#documentation": "

    The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]\n

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#SearchDashboardsResponse": { + "type": "structure", + "members": { "DashboardSummaryList": { "target": "com.amazonaws.quicksight#DashboardSummaryList", "traits": { - "smithy.api#documentation": "

    The list of dashboards owned by the user specified in Filters in your request.

    " + "smithy.api#documentation": "

    The list of dashboards owned by the user specified in Filters in your\n request.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, "NextToken": { @@ -11221,6 +12248,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.quicksight#Sheet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of a sheet. This is displayed on the sheet's tab in the QuickSight console.

    " + } + }, + "SheetId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The unique identifier associated with a sheet.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A sheet is an object that contains a set of visuals that are viewed together on one page in the\n Amazon QuickSight console. Every analysis and dashboard contains at least one sheet. Each sheet contains at\n least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can\n be associated with other components, such as controls, filters, and so on.

    " + } + }, "com.amazonaws.quicksight#SheetControlsOption": { "type": "structure", "members": { @@ -11235,6 +12282,18 @@ "smithy.api#documentation": "

    Sheet controls option.

    " } }, + "com.amazonaws.quicksight#SheetList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Sheet" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.quicksight#SheetStyle": { "type": "structure", "members": { @@ -11274,17 +12333,17 @@ "smithy.api#required": {} } }, - "Warehouse": { - "target": "com.amazonaws.quicksight#Warehouse", + "Database": { + "target": "com.amazonaws.quicksight#Database", "traits": { - "smithy.api#documentation": "

    Warehouse.

    ", + "smithy.api#documentation": "

    Database.

    ", "smithy.api#required": {} } }, - "Database": { - "target": "com.amazonaws.quicksight#Database", + "Warehouse": { + "target": "com.amazonaws.quicksight#Warehouse", "traits": { - "smithy.api#documentation": "

    Database.

    ", + "smithy.api#documentation": "

    Warehouse.

    ", "smithy.api#required": {} } } @@ -11385,20 +12444,20 @@ "Values": { "target": "com.amazonaws.quicksight#StringList", "traits": { - "smithy.api#documentation": "

    Values.

    ", + "smithy.api#documentation": "

    The values of a string parameter.

    ", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A display name for the dataset.

    ", + "smithy.api#documentation": "

    A display name for a string parameter.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    String parameter.

    " + "smithy.api#documentation": "

    A string parameter.

    " } }, "com.amazonaws.quicksight#StringParameterList": { @@ -11530,18 +12589,18 @@ "com.amazonaws.quicksight#TagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.quicksight#Arn", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource that you want to tag.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource that you want to tag.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -11570,22 +12629,22 @@ "com.amazonaws.quicksight#Template": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    Time when this was created.

    " + "smithy.api#documentation": "

    The ID for the template. This is unique per AWS Region for each AWS account.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the template.

    " + "smithy.api#documentation": "

    Time when this was last updated.

    " } }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Version": { + "target": "com.amazonaws.quicksight#TemplateVersion", "traits": { - "smithy.api#documentation": "

    The ID for the template. This is unique per AWS Region for each AWS account.

    " + "smithy.api#documentation": "

    A structure describing the versions of the template.

    " } }, "Name": { @@ -11594,38 +12653,38 @@ "smithy.api#documentation": "

    The display name of the template.

    " } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    Time when this was last updated.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the template.

    " } }, - "Version": { - "target": "com.amazonaws.quicksight#TemplateVersion", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    A structure describing the versions of the template.

    " + "smithy.api#documentation": "

    Time when this was created.

    " } } }, "traits": { - "smithy.api#documentation": "

    A template object. A template is an entity in QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with the analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

    \n

    You can share templates across AWS accounts by allowing users in other AWS accounts to\n create a template or a dashboard from an existing template.

    " + "smithy.api#documentation": "

    A template object. A template is an entity in QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with an analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

    \n

    You can share templates across AWS accounts by allowing users in other AWS accounts to\n create a template or a dashboard from an existing template.

    " } }, "com.amazonaws.quicksight#TemplateAlias": { "type": "structure", "members": { - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    The version number of the template alias.

    " - } - }, "AliasName": { "target": "com.amazonaws.quicksight#AliasName", "traits": { "smithy.api#documentation": "

    The display name of the template alias.

    " } }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

    The version number of the template alias.

    " + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -11695,6 +12754,10 @@ { "value": "INTERNAL_FAILURE", "name": "INTERNAL_FAILURE" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" } ] } @@ -11775,22 +12838,16 @@ "smithy.api#documentation": "

    The last time that this template was created.

    " } }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the template. This ID is unique per AWS Region for each AWS account.

    " - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "

    A summary of a template.

    " } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The last time that this template was updated.

    " + "smithy.api#documentation": "

    The ID of the template. This ID is unique per AWS Region for each AWS account.

    " } }, "Name": { @@ -11799,6 +12856,12 @@ "smithy.api#documentation": "

    A display name for the template.

    " } }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The last time that this template was updated.

    " + } + }, "LatestVersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { @@ -11825,12 +12888,6 @@ "com.amazonaws.quicksight#TemplateVersion": { "type": "structure", "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    The version number of the template.

    " - } - }, "Status": { "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { @@ -11840,19 +12897,19 @@ "Errors": { "target": "com.amazonaws.quicksight#TemplateErrorList", "traits": { - "smithy.api#documentation": "

    Errors associated with the template.

    " + "smithy.api#documentation": "

    Errors associated with this template version.

    " } }, - "SourceEntityArn": { + "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the analysis or template which was used to create\n this template.

    " + "smithy.api#documentation": "

    The ARN of the theme associated with this version of the template.

    " } }, - "DataSetConfigurations": { - "target": "com.amazonaws.quicksight#DataSetConfigurationList", + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    Schema of the dataset identified by the placeholder. The idea is that any dashboard\n created from the template should be bound to new datasets matching the same schema\n described through this API. .

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

    " } }, "Description": { @@ -11866,6 +12923,24 @@ "traits": { "smithy.api#documentation": "

    The time that this template version was created.

    " } + }, + "DataSetConfigurations": { + "target": "com.amazonaws.quicksight#DataSetConfigurationList", + "traits": { + "smithy.api#documentation": "

    Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

    " + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

    The version number of the template version.

    " + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

    A list of the associated sheets with the unique identifier and name of each sheet.

    " + } } }, "traits": { @@ -11875,22 +12950,16 @@ "com.amazonaws.quicksight#TemplateVersionSummary": { "type": "structure", "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    The version number of the template version.

    " - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the template version.

    " } }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "

    The status of the template version.

    " + "smithy.api#documentation": "

    The version number of the template version.

    " } }, "CreatedTime": { @@ -11899,6 +12968,12 @@ "smithy.api#documentation": "

    The time that this template version was created.

    " } }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

    The status of the template version.

    " + } + }, "Description": { "target": "com.amazonaws.quicksight#VersionDescription", "traits": { @@ -11925,6 +13000,13 @@ "com.amazonaws.quicksight#TeradataParameters": { "type": "structure", "members": { + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

    Database.

    ", + "smithy.api#required": {} + } + }, "Host": { "target": "com.amazonaws.quicksight#Host", "traits": { @@ -11938,13 +13020,6 @@ "smithy.api#documentation": "

    Port.

    ", "smithy.api#required": {} } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

    Database.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -11969,65 +13044,65 @@ "com.amazonaws.quicksight#Theme": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

    The name that the user gives to the theme.

    " - } - }, "Type": { "target": "com.amazonaws.quicksight#ThemeType", "traits": { "smithy.api#documentation": "

    The type of theme, based on how it was created. Valid values include:\n QUICKSIGHT and CUSTOM.

    " } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", "traits": { - "smithy.api#documentation": "

    The date and time that the theme was last updated.

    " + "smithy.api#documentation": "

    The name that the user gives to the theme.

    " } }, + "Version": { + "target": "com.amazonaws.quicksight#ThemeVersion" + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the theme.

    " } }, - "Version": { - "target": "com.amazonaws.quicksight#ThemeVersion" + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The identifier that the user gives to the theme.

    " + } }, - "CreatedTime": { + "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time that the theme was created.

    " + "smithy.api#documentation": "

    The date and time that the theme was last updated.

    " } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "

    The identifier that the user gives to the theme.

    " + "smithy.api#documentation": "

    The date and time that the theme was created.

    " } } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    Summary information about a theme.

    " } }, "com.amazonaws.quicksight#ThemeAlias": { "type": "structure", "members": { - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    The version number of the theme alias.

    " - } - }, "AliasName": { "target": "com.amazonaws.quicksight#AliasName", "traits": { "smithy.api#documentation": "

    The display name of the theme alias.

    " } }, + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

    The version number of the theme alias.

    " + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -12054,18 +13129,18 @@ "com.amazonaws.quicksight#ThemeConfiguration": { "type": "structure", "members": { - "Sheet": { - "target": "com.amazonaws.quicksight#SheetStyle", - "traits": { - "smithy.api#documentation": "

    Display options related to sheets.

    " - } - }, "DataColorPalette": { "target": "com.amazonaws.quicksight#DataColorPalette", "traits": { "smithy.api#documentation": "

    Color properties that apply to chart data colors.

    " } }, + "Sheet": { + "target": "com.amazonaws.quicksight#SheetStyle", + "traits": { + "smithy.api#documentation": "

    Display options related to sheets.

    " + } + }, "UIColorPalette": { "target": "com.amazonaws.quicksight#UIColorPalette", "traits": { @@ -12080,17 +13155,17 @@ "com.amazonaws.quicksight#ThemeError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The error message.

    " - } - }, "Type": { "target": "com.amazonaws.quicksight#ThemeErrorType", "traits": { "smithy.api#documentation": "

    The type of error.

    " } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The error message.

    " + } } }, "traits": { @@ -12131,12 +13206,24 @@ "com.amazonaws.quicksight#ThemeSummary": { "type": "structure", "members": { + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The last date and time that this theme was updated.

    " + } + }, "Name": { "target": "com.amazonaws.quicksight#ThemeName", "traits": { "smithy.api#documentation": "

    the display name for the theme.

    " } }, + "LatestVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

    The latest version number for the theme.

    " + } + }, "CreatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { @@ -12149,18 +13236,6 @@ "smithy.api#documentation": "

    The ID of the theme. This ID is unique per AWS Region for each AWS account.

    " } }, - "LatestVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

    The latest version number for the theme.

    " - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

    The last date and time that this theme was updated.

    " - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -12224,10 +13299,10 @@ "smithy.api#documentation": "

    The version number of the theme.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Errors": { + "target": "com.amazonaws.quicksight#ThemeErrorList", "traits": { - "smithy.api#documentation": "

    The date and time that this theme version was created.

    " + "smithy.api#documentation": "

    Errors associated with the theme.

    " } }, "Configuration": { @@ -12236,6 +13311,12 @@ "smithy.api#documentation": "

    The theme configuration, which contains all the theme display properties.

    " } }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that this theme version was created.

    " + } + }, "Status": { "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { @@ -12247,12 +13328,6 @@ "traits": { "smithy.api#documentation": "

    The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default QuickSight theme.

    " } - }, - "Errors": { - "target": "com.amazonaws.quicksight#ThemeErrorList", - "traits": { - "smithy.api#documentation": "

    Errors associated with the theme.

    " - } } }, "traits": { @@ -12274,18 +13349,18 @@ "smithy.api#documentation": "

    The status of the theme version.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date and time that this theme version was created.

    " - } - }, "Description": { "target": "com.amazonaws.quicksight#VersionDescription", "traits": { "smithy.api#documentation": "

    The description of the theme version.

    " } }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that this theme version was created.

    " + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -12312,14 +13387,14 @@ "com.amazonaws.quicksight#ThrottlingException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

    The AWS request ID for this request.

    " } - }, - "Message": { - "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -12392,18 +13467,18 @@ "smithy.api#documentation": "

    An operation that tags a column with additional information.

    " } }, - "ProjectOperation": { - "target": "com.amazonaws.quicksight#ProjectOperation", - "traits": { - "smithy.api#documentation": "

    An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.

    " - } - }, "CreateColumnsOperation": { "target": "com.amazonaws.quicksight#CreateColumnsOperation", "traits": { "smithy.api#documentation": "

    An operation that creates calculated columns. Columns created in one such operation\n form a lexical closure.

    " } }, + "ProjectOperation": { + "target": "com.amazonaws.quicksight#ProjectOperation", + "traits": { + "smithy.api#documentation": "

    An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.

    " + } + }, "FilterOperation": { "target": "com.amazonaws.quicksight#FilterOperation", "traits": { @@ -12467,10 +13542,10 @@ "smithy.api#documentation": "

    This color that applies to warning and informational messages.

    " } }, - "SecondaryForeground": { + "DimensionForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

    " + "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n dimension color.

    " } }, "MeasureForeground": { @@ -12479,34 +13554,34 @@ "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n measure color.

    " } }, - "DimensionForeground": { + "SecondaryForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n dimension color.

    " + "smithy.api#documentation": "

    The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

    " } }, - "DangerForeground": { + "Dimension": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n error color.

    " + "smithy.api#documentation": "

    The color that applies to the names of fields that are identified as\n dimensions.

    " } }, - "Dimension": { + "PrimaryForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The color that applies to the names of fields that are identified as\n dimensions.

    " + "smithy.api#documentation": "

    The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

    " } }, - "Success": { + "DangerForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The color that applies to success messages, for example the check mark for a\n successful download.

    " + "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n error color.

    " } }, - "PrimaryForeground": { + "SuccessForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

    " + "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n success color.

    " } }, "AccentForeground": { @@ -12515,10 +13590,10 @@ "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n accent color.

    " } }, - "SuccessForeground": { + "Danger": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n success color.

    " + "smithy.api#documentation": "

    The color that applies to error messages.

    " } }, "Accent": { @@ -12527,10 +13602,10 @@ "smithy.api#documentation": "

    This color is that applies to selected states and buttons.

    " } }, - "Danger": { + "PrimaryBackground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The color that applies to error messages.

    " + "smithy.api#documentation": "

    The background color that applies to visuals and other high emphasis UI.

    " } }, "WarningForeground": { @@ -12539,10 +13614,10 @@ "smithy.api#documentation": "

    The foreground color that applies to any text or other elements that appear over the\n warning color.

    " } }, - "PrimaryBackground": { + "Success": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "

    The background color that applies to visuals and other high emphasis UI.

    " + "smithy.api#documentation": "

    The color that applies to success messages, for example the check mark for a\n successful download.

    " } }, "Measure": { @@ -12676,7 +13751,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates customizations associated with the QuickSight subscription on your AWS account.

    ", + "smithy.api#documentation": "

    Updates Amazon QuickSight customizations the current AWS Region. Currently, the only\n customization you can use is a theme.

    \n

    You can use customizations for your AWS account or, if you specify a namespace, for a\n QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an AWS account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

    ", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/customizations", @@ -12687,25 +13762,25 @@ "com.amazonaws.quicksight#UpdateAccountCustomizationRequest": { "type": "structure", "members": { + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

    The namespace that you want to update QuickSight customizations for.

    ", + "smithy.api#httpQuery": "namespace" + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that you want to update QuickSight customizations for.

    ", + "smithy.api#documentation": "

    The ID for the AWS account that you want to update QuickSight customizations\n for.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

    The namespace associated with the customization that you're updating.

    ", - "smithy.api#httpQuery": "namespace" - } - }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

    The customizations you want to update in QuickSight.

    ", + "smithy.api#documentation": "

    The QuickSight customizations you're updating in the current AWS Region.

    ", "smithy.api#required": {} } } @@ -12720,16 +13795,16 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The customizations associated with your QuickSight subscription.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the updated customization for this AWS account.

    " } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that you want to update QuickSight customizations for.

    " + "smithy.api#documentation": "

    The QuickSight customizations you're updating in the current AWS Region.

    " } }, "Namespace": { @@ -12737,6 +13812,12 @@ "traits": { "smithy.api#documentation": "

    The namespace associated with the customization that you're updating.

    " } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID for the AWS account that you want to update QuickSight customizations\n for.

    " + } } } }, @@ -12769,7 +13850,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates the settings for the Amazon QuickSight subscription in your AWS Account.

    ", + "smithy.api#documentation": "

    Updates the Amazon QuickSight settings in your AWS account.

    ", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/settings", @@ -12783,7 +13864,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the AWS account that contains the QuickSight namespaces that you want to list.

    ", + "smithy.api#documentation": "

    The ID for the AWS account that contains the QuickSight settings that you want to\n list.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12791,13 +13872,13 @@ "NotificationEmail": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    Email address used to send notifications regarding administration of QuickSight.

    " + "smithy.api#documentation": "

    The email address that you want QuickSight to send notifications to regarding your AWS\n account or QuickSight subscription.

    " } }, "DefaultNamespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The default namespace for this AWS Account. Currently, the default is default. IAM users who register for the first time with QuickSight provide an email that becomes associated with the default namespace.

    ", + "smithy.api#documentation": "

    The default namespace for this AWS account. Currently, the default is\n default. AWS Identity and Access Management (IAM) users that register\n for the first time with QuickSight provide an email that becomes associated with the\n default namespace.

    ", "smithy.api#required": {} } } @@ -12814,6 +13895,221 @@ } } }, + "com.amazonaws.quicksight#UpdateAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates an analysis in Amazon QuickSight

    ", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates the read and write permissions for an analysis.

    ", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the analysis whose permissions you're\n updating. You must be using the AWS account that the analysis is in.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A structure that describes the permissions to add and the principal to add them\n to.

    " + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A structure that describes the permissions to remove and the principal to remove them\n from.

    " + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis whose permissions you're updating. The ID is part of the\n analysis URL.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A structure that describes the principals and the resource-level permissions on an\n analysis.

    " + } + }, + "AnalysisArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the analysis that you updated.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis that you updated permissions for.

    " + } + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

    A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the QuickSight console.

    ", + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that contains the analysis that you're updating.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're\n creating. To see the theme in the QuickSight console, make sure that you have access to\n it.

    " + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

    The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

    " + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the analysis that you're updating. This ID displays in the URL of the\n analysis.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "traits": { + "smithy.api#documentation": "

    A source entity to use for the analysis that you're updating. This metadata structure\n contains details that describe a source template and one or more datasets.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN of the analysis that you're updating.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the analysis.

    " + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

    The update status of the last update that was made to the analysis.

    " + } + } + } + }, "com.amazonaws.quicksight#UpdateDashboard": { "type": "operation", "input": { @@ -12894,18 +14190,18 @@ "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard whose permissions you're\n\t\t\tupdating.

    ", + "smithy.api#documentation": "

    The ID for the dashboard.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the dashboard.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard whose permissions you're\n updating.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13001,18 +14297,18 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're updating.

    ", + "smithy.api#documentation": "

    The ID for the dashboard.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The ID for the dashboard.

    ", + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're\n updating.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13022,12 +14318,6 @@ "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse": { "type": "structure", "members": { - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dashboard.

    " - } - }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -13037,7 +14327,13 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } + }, + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dashboard.

    " } } } @@ -13045,37 +14341,44 @@ "com.amazonaws.quicksight#UpdateDashboardRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

    The display name of the dashboard.

    ", + "smithy.api#required": {} + } + }, "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "

    The entity that you are using as a source when you update the dashboard. In\n\t\t\tSourceEntity, you specify the type of object you're using as source. You\n\t\t\tcan only update a dashboard from a template, so you use a SourceTemplate\n\t\t\tentity. If you need to update a dashboard from an analysis, first convert the analysis\n\t\t\tto a template by using the CreateTemplate API operation. For\n\t\t\tSourceTemplate, specify the Amazon Resource Name (ARN) of the source\n\t\t\ttemplate. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported\n\t\t\tAWS Region.

    \n\t\t

    Use the DataSetReferences entity within SourceTemplate\n\t\t\tto list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

    ", + "smithy.api#documentation": "

    The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any AWS Account and any\n QuickSight-supported AWS Region.

    \n

    Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

    ", "smithy.api#required": {} } }, - "DashboardPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardPublishOptions", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    Options for publishing the dashboard when you create it:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n AvailabilityStatus for AdHocFilteringOption - This status can be\n\t\t\t\t\teither ENABLED or DISABLED. When this is set to\n\t\t\t\t\t\tDISABLED, QuickSight disables the left filter pane on the\n\t\t\t\t\tpublished dashboard, which can be used for ad hoc (one-time) filtering. This\n\t\t\t\t\toption is ENABLED by default.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n AvailabilityStatus for ExportToCSVOption - This status can be\n\t\t\t\t\teither ENABLED or DISABLED. The visual option to\n\t\t\t\t\texport data to .csv format isn't enabled when this is set to\n\t\t\t\t\t\tDISABLED. This option is ENABLED by default.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n VisibilityState for SheetControlsOption - This visibility state\n\t\t\t\t\tcan be either COLLAPSED or EXPANDED. This option is\n\t\t\t\t\tCOLLAPSED by default.

      \n\t\t\t
      • \n
    " + "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're\n updating.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value\n\t\t\tfor this field, it overrides the value that was originally associated with the entity. The theme ARN must \n\t\t\texist in the same AWS account where you create the dashboard.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that was originally associated\n with the entity. The theme ARN must exist in the same AWS account where you create the\n dashboard.

    " } }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", + "DashboardPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardPublishOptions", "traits": { - "smithy.api#documentation": "

    A structure that contains the parameters of the dashboard. These are parameter overrides for\n\t\t\ta dashboard. A dashboard can have any type of parameters, and some parameters might\n\t\t\taccept multiple values.

    " + "smithy.api#documentation": "

    Options for publishing the dashboard when you create it:

    \n
      \n
    • \n

      \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

      \n
      • \n
    • \n

      \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

      \n
      • \n
    • \n

      \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

      \n
      • \n
    " } }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", "traits": { - "smithy.api#documentation": "

    The ID for the dashboard.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    A structure that contains the parameters of the dashboard. These are parameter\n overrides for a dashboard. A dashboard can have any type of parameters, and some\n parameters might accept multiple values.

    " } }, "VersionDescription": { @@ -13084,30 +14387,29 @@ "smithy.api#documentation": "

    A description for the first version of the dashboard being created.

    " } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the dashboard that you're updating.

    ", + "smithy.api#documentation": "

    The ID for the dashboard.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

    The display name of the dashboard.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#UpdateDashboardResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The ARN of the dashboard, including the version number.

    " + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the dashboard.

    " } }, "Arn": { @@ -13116,10 +14418,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " } }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The ARN of the dashboard, including the version number.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, "Status": { @@ -13128,12 +14430,6 @@ "smithy.api#documentation": "

    The HTTP status of the request.

    " } }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the dashboard.

    " - } - }, "CreationStatus": { "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { @@ -13233,6 +14529,12 @@ "smithy.api#required": {} } }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    The resource permissions that you want to grant to the dataset.

    " + } + }, "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -13241,12 +14543,6 @@ "smithy.api#required": {} } }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

    The resource permissions that you want to grant to the dataset.

    " - } - }, "RevokePermissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { @@ -13258,18 +14554,18 @@ "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse": { "type": "structure", "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the dataset whose permissions you want to update. This ID is unique per AWS\n\t\t\tRegion for each AWS account.

    " - } - }, "DataSetArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dataset.

    " } }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the dataset whose permissions you want to update. This ID is unique per AWS\n\t\t\tRegion for each AWS account.

    " + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -13294,12 +14590,6 @@ "smithy.api#required": {} } }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

    The row-level security configuration for the data you want to create.

    " - } - }, "PhysicalTableMap": { "target": "com.amazonaws.quicksight#PhysicalTableMap", "traits": { @@ -13307,19 +14597,20 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

    The display name for the dataset.

    ", - "smithy.api#required": {} - } - }, "LogicalTableMap": { "target": "com.amazonaws.quicksight#LogicalTableMap", "traits": { "smithy.api#documentation": "

    Configures the combination and transformation of the data from the physical tables.

    " } }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -13328,11 +14619,16 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The row-level security configuration for the data you want to create.

    " + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

    The display name for the dataset.

    ", "smithy.api#required": {} } } @@ -13450,6 +14746,12 @@ "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest": { "type": "structure", "members": { + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

    A list of resource permissions that you want to revoke on the data source.

    " + } + }, "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -13471,22 +14773,16 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

    A list of resource permissions that you want to revoke on the data source.

    " - } } } }, "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the data source.

    " } }, "DataSourceId": { @@ -13495,10 +14791,10 @@ "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    " } }, - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the data source.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } } } @@ -13513,18 +14809,10 @@ "smithy.api#required": {} } }, - "Credentials": { - "target": "com.amazonaws.quicksight#DataSourceCredentials", - "traits": { - "smithy.api#documentation": "

    The credentials that QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

    " - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", "traits": { - "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The parameters that QuickSight uses to connect to your underlying source.

    " } }, "AwsAccountId": { @@ -13535,16 +14823,18 @@ "smithy.api#required": {} } }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

    The parameters that QuickSight uses to connect to your underlying source.

    " + "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", + "Credentials": { + "target": "com.amazonaws.quicksight#DataSourceCredentials", "traits": { - "smithy.api#documentation": "

    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying\n\t\t\tsource.

    " + "smithy.api#documentation": "

    The credentials that QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

    " } }, "VpcConnectionProperties": { @@ -13552,6 +14842,12 @@ "traits": { "smithy.api#documentation": "

    Use this parameter only when you want QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

    " } + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying\n\t\t\tsource.

    " + } } } }, @@ -13564,12 +14860,6 @@ "smithy.api#documentation": "

    The update status of the data source's last update.

    " } }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -13581,6 +14871,12 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the data source.

    " } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the data source. This ID is unique per AWS Region for each AWS account.

    " + } } } }, @@ -13643,12 +14939,6 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "

    The description for the group that you want to update.

    " - } - }, "GroupName": { "target": "com.amazonaws.quicksight#GroupName", "traits": { @@ -13656,6 +14946,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "

    The description for the group that you want to update.

    " + } } } }, @@ -13719,24 +15015,26 @@ "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest": { "type": "structure", "members": { - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

    The ARN for the IAM policy to apply to the QuickSight users and groups\n\t\t\tspecified in this assignment.

    " + "smithy.api#documentation": "

    The namespace of the assignment.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

    The status of the assignment. Possible values are as follows:

    \n\t\t
      \n
    • \n

      \n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.

      \n
      • \n
    • \n

      \n DISABLED - This assignment isn't used when creating the data source.

      \n
      • \n
    • \n

      \n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.

      \n
      • \n
    " + "smithy.api#documentation": "

    The ID of the AWS account that contains the IAM policy assignment.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The name of the assignment. This name must be unique within an AWS account.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The ARN for the IAM policy to apply to the QuickSight users and groups\n\t\t\tspecified in this assignment.

    " } }, "Identities": { @@ -13745,39 +15043,25 @@ "smithy.api#documentation": "

    The QuickSight users, groups, or both that you want to assign the policy to.

    " } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that contains the IAM policy assignment.

    ", + "smithy.api#documentation": "

    The name of the assignment. This name must be unique within an AWS account.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "

    The namespace of the assignment.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The status of the assignment. Possible values are as follows:

    \n\t\t
      \n
    • \n

      \n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.

      \n
      • \n
    • \n

      \n DISABLED - This assignment isn't used when creating the data source.

      \n
      • \n
    • \n

      \n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.

      \n
      • \n
    " } } } }, "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The ARN for the IAM policy applied to the QuickSight users and groups specified in this\n\t\t\tassignment.

    " - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

    The status of the assignment. Possible values are as follows:

    \n\t\t
      \n
    • \n

      \n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.

      \n
      • \n
    • \n

      \n DISABLED - This assignment isn't used when creating the data source.

      \n
      • \n
    • \n

      \n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.

      \n
      • \n
    " - } - }, + "type": "structure", + "members": { "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { @@ -13790,10 +15074,10 @@ "smithy.api#documentation": "

    The QuickSight users, groups, or both that the IAM policy is assigned to.

    " } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The status of the assignment. Possible values are as follows:

    \n\t\t
      \n
    • \n

      \n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.

      \n
      • \n
    • \n

      \n DISABLED - This assignment isn't used when creating the data source.

      \n
      • \n
    • \n

      \n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.

      \n
      • \n
    " } }, "AssignmentId": { @@ -13801,6 +15085,18 @@ "traits": { "smithy.api#documentation": "

    The ID of the assignment.

    " } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN for the IAM policy applied to the QuickSight users and groups specified in this\n\t\t\tassignment.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + } } } }, @@ -13896,6 +15192,14 @@ "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { "type": "structure", "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the template.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -13918,14 +15222,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the template.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -13992,14 +15288,6 @@ "smithy.api#documentation": "

    A list of resource permissions to be revoked from the template.

    " } }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the template.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "GrantPermissions": { "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { @@ -14013,6 +15301,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the template.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -14025,12 +15321,6 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the template.

    " } }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the template.

    " - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -14042,6 +15332,12 @@ "traits": { "smithy.api#documentation": "

    A list of resource permissions to be set on the template.

    " } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the template.

    " + } } } }, @@ -14055,18 +15351,10 @@ "smithy.api#required": {} } }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

    A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.

    " - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", "traits": { - "smithy.api#documentation": "

    The ID for the template.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The name for the template.

    " } }, "AwsAccountId": { @@ -14077,10 +15365,18 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "

    The name for the template.

    " + "smithy.api#documentation": "

    A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.

    " + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the template.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -14100,6 +15396,12 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the template.

    " } }, + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the template.

    " + } + }, "VersionArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -14111,12 +15413,6 @@ "traits": { "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the template.

    " - } } } }, @@ -14206,6 +15502,14 @@ "com.amazonaws.quicksight#UpdateThemeAliasRequest": { "type": "structure", "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the theme.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ThemeVersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { @@ -14228,14 +15532,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the theme.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -14302,14 +15598,6 @@ "smithy.api#documentation": "

    A list of resource permissions to be revoked from the theme.

    " } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

    The ID for the theme.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -14323,22 +15611,30 @@ "traits": { "smithy.api#documentation": "

    A list of resource permissions to be granted for the theme.

    " } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

    The ID for the theme.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The resulting list of resource permissions for the theme.

    " + "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "

    The ID for the theme.

    " + "smithy.api#documentation": "

    The resulting list of resource permissions for the theme.

    " } }, "ThemeArn": { @@ -14347,10 +15643,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the theme.

    " } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

    The AWS request ID for this operation.

    " + "smithy.api#documentation": "

    The ID for the theme.

    " } } } @@ -14416,18 +15712,18 @@ "smithy.api#documentation": "

    The AWS request ID for this operation.

    " } }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the new version of the theme.

    " - } - }, "CreationStatus": { "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { "smithy.api#documentation": "

    The creation status of the theme.

    " } }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the new version of the theme.

    " + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -14479,6 +15775,12 @@ "com.amazonaws.quicksight#UpdateUserRequest": { "type": "structure", "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

    (Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

    \n
      \n
    • \n

      Create and update data sources

      \n
      • \n
    • \n

      Create and update datasets

      \n
      • \n
    • \n

      Create and update email reports

      \n
      • \n
    • \n

      Subscribe to email reports

      \n
      • \n
    \n

    A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.

    \n

    QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).

    \n

    This feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).

    " + } + }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -14487,16 +15789,11 @@ "smithy.api#required": {} } }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

    The name of the custom permissions profile that you want to assign to this user.\n Currently, custom permissions profile names are assigned to permissions profiles in the \n QuickSight console. You use this API to assign the named set of permissions to a \n QuickSight user.

    " - } - }, - "Email": { - "target": "com.amazonaws.quicksight#String", + "UserName": { + "target": "com.amazonaws.quicksight#UserName", "traits": { - "smithy.api#documentation": "

    The email address of the user that you want to update.

    ", + "smithy.api#documentation": "

    The Amazon QuickSight user name that you want to update.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -14508,11 +15805,10 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", + "Role": { + "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "

    The Amazon QuickSight user name that you want to update.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n READER: A user who has read-only access to dashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

      \n\t\t\t
      • \n
    \n\t

    The name of the QuickSight role is invisible to the user except for the console \n\t screens dealing with permissions.

    ", "smithy.api#required": {} } }, @@ -14522,10 +15818,10 @@ "smithy.api#documentation": "

    A flag that you use to indicate that you want to remove all custom permissions\n from this user. Using this parameter resets the user to the state\n it was in before a custom permissions profile was applied. This parameter defaults to\n NULL and it doesn't accept any other value.

    " } }, - "Role": { - "target": "com.amazonaws.quicksight#UserRole", + "Email": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The Amazon QuickSight role of the user. The user role can be one of the\n\t\t\tfollowing:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n READER: A user who has read-only access to dashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

      \n\t\t\t
      • \n
    ", + "smithy.api#documentation": "

    The email address of the user that you want to update.

    ", "smithy.api#required": {} } } @@ -14551,10 +15847,10 @@ "com.amazonaws.quicksight#UploadSettings": { "type": "structure", "members": { - "Format": { - "target": "com.amazonaws.quicksight#FileFormat", + "Delimiter": { + "target": "com.amazonaws.quicksight#Delimiter", "traits": { - "smithy.api#documentation": "

    File format.

    " + "smithy.api#documentation": "

    The delimiter between values in the file.

    " } }, "StartFromRow": { @@ -14564,23 +15860,23 @@ "smithy.api#documentation": "

    A row number to start reading data from.

    " } }, - "TextQualifier": { - "target": "com.amazonaws.quicksight#TextQualifier", + "ContainsHeader": { + "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "

    Text qualifier.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    Whether the file has a header row, or the files each have a header row.

    " } }, - "Delimiter": { - "target": "com.amazonaws.quicksight#Delimiter", + "TextQualifier": { + "target": "com.amazonaws.quicksight#TextQualifier", "traits": { - "smithy.api#documentation": "

    The delimiter between values in the file.

    " + "smithy.api#documentation": "

    Text qualifier.

    " } }, - "ContainsHeader": { - "target": "com.amazonaws.quicksight#Boolean", + "Format": { + "target": "com.amazonaws.quicksight#FileFormat", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Whether the file has a header row, or the files each have a header row.

    " + "smithy.api#documentation": "

    File format.

    " } } }, @@ -14597,10 +15893,10 @@ "smithy.api#documentation": "

    The custom permissions profile associated with this user.

    " } }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", + "Active": { + "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "

    The user's user name.

    " + "smithy.api#documentation": "

    The active status of user. When you create an Amazon QuickSight user that’s not an IAM\n user or an Active Directory user, that user is inactive until they sign in and provide a\n password.

    " } }, "Role": { @@ -14609,39 +15905,39 @@ "smithy.api#documentation": "

    The Amazon QuickSight role for the user. The user role can be one of the\n following:.

    \n
      \n
    • \n

      \n READER: A user who has read-only access to dashboards.

      \n
      • \n
    • \n

      \n AUTHOR: A user who can create data sources, datasets, analyses,\n and dashboards.

      \n
      • \n
    • \n

      \n ADMIN: A user who is an author, who can also manage Amazon\n QuickSight settings.

      \n
      • \n
    • \n

      \n RESTRICTED_READER: This role isn't currently available for\n use.

      \n
      • \n
    • \n

      \n RESTRICTED_AUTHOR: This role isn't currently available for\n use.

      \n
      • \n
    " } }, - "Active": { - "target": "com.amazonaws.quicksight#Boolean", + "Email": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The active status of user. When you create an Amazon QuickSight user that’s not an IAM\n user or an Active Directory user, that user is inactive until they sign in and provide a\n password.

    " + "smithy.api#documentation": "

    The user's email address.

    " } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "UserName": { + "target": "com.amazonaws.quicksight#UserName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the user.

    " + "smithy.api#documentation": "

    The user's user name.

    " } }, - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", + "IdentityType": { + "target": "com.amazonaws.quicksight#IdentityType", "traits": { - "smithy.api#documentation": "

    The principal ID of the user.

    " + "smithy.api#documentation": "

    The type of identity authentication used by the user.

    " } }, - "Email": { - "target": "com.amazonaws.quicksight#String", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

    The user's email address.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the user.

    " } }, - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

    The type of identity authentication used by the user.

    " + "smithy.api#documentation": "

    The principal ID of the user.

    " } } }, "traits": { - "smithy.api#documentation": "

    A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription\n can't contain more than 20 million users.

    " + "smithy.api#documentation": "

    A registered user of Amazon QuickSight.

    " } }, "com.amazonaws.quicksight#UserList": { 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 36d04d9b2167..039a586f99dc 100644 --- a/codegen/sdk-codegen/aws-models/ram.2018-01-04.json +++ b/codegen/sdk-codegen/aws-models/ram.2018-01-04.json @@ -195,7 +195,7 @@ "sdkId": "RAM", "arnNamespace": "ram", "cloudFormationName": "RAM", - "cloudTrailEventSource": "V2018_01_04.resourcesharing.amazonaws.com" + "cloudTrailEventSource": "ram.amazonaws.com" }, "aws.auth#sigv4": { "name": "ram" @@ -297,10 +297,10 @@ "com.amazonaws.ram#AssociateResourceSharePermissionRequest": { "type": "structure", "members": { - "permissionArn": { + "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS RAM permission to associate with the resource share.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", "smithy.api#required": {} } }, @@ -310,17 +310,17 @@ "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, - "replace": { - "target": "com.amazonaws.ram#Boolean", + "permissionArn": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    Indicates whether the permission should replace the permissions that are currently \n \tassociated with the resource share. Use true to replace the current permissions. \n \tUse false to add the permission to the current permission.

    " + "smithy.api#documentation": "

    The ARN of the AWS RAM permission to associate with the resource share.

    ", + "smithy.api#required": {} } }, - "resourceShareArn": { - "target": "com.amazonaws.ram#String", + "replace": { + "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates whether the permission should replace the permissions that are currently \n \tassociated with the resource share. Use true to replace the current permissions. \n \tUse false to add the permission to the current permission.

    " } } } @@ -345,10 +345,17 @@ "com.amazonaws.ram#AssociateResourceShareRequest": { "type": "structure", "members": { - "clientToken": { + "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", + "smithy.api#required": {} + } + }, + "resourceArns": { + "target": "com.amazonaws.ram#ResourceArnList", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resources.

    " } }, "principals": { @@ -357,17 +364,10 @@ "smithy.api#documentation": "

    The principals.

    " } }, - "resourceShareArn": { + "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", - "smithy.api#required": {} - } - }, - "resourceArns": { - "target": "com.amazonaws.ram#ResourceArnList", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resources.

    " + "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } } } @@ -375,17 +375,17 @@ "com.amazonaws.ram#AssociateResourceShareResponse": { "type": "structure", "members": { - "resourceShareAssociations": { - "target": "com.amazonaws.ram#ResourceShareAssociationList", - "traits": { - "smithy.api#documentation": "

    Information about the associations.

    " - } - }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } + }, + "resourceShareAssociations": { + "target": "com.amazonaws.ram#ResourceShareAssociationList", + "traits": { + "smithy.api#documentation": "

    Information about the associations.

    " + } } } }, @@ -450,16 +450,10 @@ "com.amazonaws.ram#CreateResourceShareRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.ram#TagList", - "traits": { - "smithy.api#documentation": "

    One or more tags.

    " - } - }, - "resourceArns": { - "target": "com.amazonaws.ram#ResourceArnList", + "clientToken": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resources to associate with the resource share.

    " + "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, "name": { @@ -469,12 +463,6 @@ "smithy.api#required": {} } }, - "allowExternalPrincipals": { - "target": "com.amazonaws.ram#Boolean", - "traits": { - "smithy.api#documentation": "

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " - } - }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { @@ -487,10 +475,22 @@ "smithy.api#documentation": "

    The ARNs of the permissions to associate with the resource share. If you do not specify an ARN\n\t\t\tfor the permission, AWS RAM automatically attaches the default version of the permission\n\t\t\tfor each resource type.

    " } }, - "clientToken": { - "target": "com.amazonaws.ram#String", + "resourceArns": { + "target": "com.amazonaws.ram#ResourceArnList", "traits": { - "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resources to associate with the resource share.

    " + } + }, + "tags": { + "target": "com.amazonaws.ram#TagList", + "traits": { + "smithy.api#documentation": "

    One or more tags.

    " + } + }, + "allowExternalPrincipals": { + "target": "com.amazonaws.ram#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " } } } @@ -564,13 +564,6 @@ "com.amazonaws.ram#DeleteResourceShareRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", - "smithy.api#httpQuery": "clientToken" - } - }, "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { @@ -578,6 +571,13 @@ "smithy.api#httpQuery": "resourceShareArn", "smithy.api#required": {} } + }, + "clientToken": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "smithy.api#httpQuery": "clientToken" + } } } }, @@ -691,13 +691,6 @@ "com.amazonaws.ram#DisassociateResourceSharePermissionRequest": { "type": "structure", "members": { - "permissionArn": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The ARN of the permission to disassociate from the resource share.

    ", - "smithy.api#required": {} - } - }, "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { @@ -710,29 +703,43 @@ "traits": { "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } + }, + "permissionArn": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission to disassociate from the resource share.

    ", + "smithy.api#required": {} + } } } }, "com.amazonaws.ram#DisassociateResourceSharePermissionResponse": { "type": "structure", "members": { - "returnValue": { - "target": "com.amazonaws.ram#Boolean", - "traits": { - "smithy.api#documentation": "

    Indicates whether the request succeeded.

    " - } - }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } + }, + "returnValue": { + "target": "com.amazonaws.ram#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the request succeeded.

    " + } } } }, "com.amazonaws.ram#DisassociateResourceShareRequest": { "type": "structure", "members": { + "resourceShareArn": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", + "smithy.api#required": {} + } + }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { @@ -750,30 +757,23 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the resources.

    " } - }, - "resourceShareArn": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.ram#DisassociateResourceShareResponse": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " - } - }, "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { "smithy.api#documentation": "

    Information about the associations.

    " } + }, + "clientToken": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } } } }, @@ -861,18 +861,18 @@ "com.amazonaws.ram#GetPermissionRequest": { "type": "structure", "members": { + "permissionVersion": { + "target": "com.amazonaws.ram#Integer", + "traits": { + "smithy.api#documentation": "

    The identifier for the version of the permission.

    " + } + }, "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "

    The ARN of the permission.

    ", "smithy.api#required": {} } - }, - "permissionVersion": { - "target": "com.amazonaws.ram#Integer", - "traits": { - "smithy.api#documentation": "

    The identifier for the version of the permission.

    " - } } } }, @@ -932,10 +932,10 @@ "com.amazonaws.ram#GetResourcePoliciesRequest": { "type": "structure", "members": { - "nextToken": { + "principal": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " + "smithy.api#documentation": "

    The principal.

    " } }, "resourceArns": { @@ -951,10 +951,10 @@ "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " } }, - "principal": { + "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The principal.

    " + "smithy.api#documentation": "

    The token for the next page of results.

    " } } } @@ -962,17 +962,17 @@ "com.amazonaws.ram#GetResourcePoliciesResponse": { "type": "structure", "members": { - "policies": { - "target": "com.amazonaws.ram#PolicyList", - "traits": { - "smithy.api#documentation": "

    A key policy document, in JSON format.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "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.

    " } + }, + "policies": { + "target": "com.amazonaws.ram#PolicyList", + "traits": { + "smithy.api#documentation": "

    A key policy document, in JSON format.

    " + } } } }, @@ -1030,10 +1030,10 @@ "smithy.api#documentation": "

    The association status.

    " } }, - "nextToken": { + "principal": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " + "smithy.api#documentation": "

    The principal. You cannot specify this parameter if the association type is \n \tRESOURCE.

    " } }, "resourceShareArns": { @@ -1042,6 +1042,12 @@ "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resource shares.

    " } }, + "resourceArn": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the \n \tassociation type is PRINCIPAL.

    " + } + }, "associationType": { "target": "com.amazonaws.ram#ResourceShareAssociationType", "traits": { @@ -1049,22 +1055,16 @@ "smithy.api#required": {} } }, - "principal": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The principal. You cannot specify this parameter if the association type is \n \tRESOURCE.

    " - } - }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " } }, - "resourceArn": { + "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the \n \tassociation type is PRINCIPAL.

    " + "smithy.api#documentation": "

    The token for the next page of results.

    " } } } @@ -1072,17 +1072,17 @@ "com.amazonaws.ram#GetResourceShareAssociationsResponse": { "type": "structure", "members": { - "resourceShareAssociations": { - "target": "com.amazonaws.ram#ResourceShareAssociationList", - "traits": { - "smithy.api#documentation": "

    Information about the associations.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "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.

    " } + }, + "resourceShareAssociations": { + "target": "com.amazonaws.ram#ResourceShareAssociationList", + "traits": { + "smithy.api#documentation": "

    Information about the associations.

    " + } } } }, @@ -1137,18 +1137,6 @@ "com.amazonaws.ram#GetResourceShareInvitationsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.ram#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " - } - }, - "resourceShareInvitationArns": { - "target": "com.amazonaws.ram#ResourceShareInvitationArnList", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the invitations.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { @@ -1160,23 +1148,35 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resource shares.

    " } + }, + "resourceShareInvitationArns": { + "target": "com.amazonaws.ram#ResourceShareInvitationArnList", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the invitations.

    " + } + }, + "maxResults": { + "target": "com.amazonaws.ram#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " + } } } }, "com.amazonaws.ram#GetResourceShareInvitationsResponse": { "type": "structure", "members": { - "resourceShareInvitations": { - "target": "com.amazonaws.ram#ResourceShareInvitationList", - "traits": { - "smithy.api#documentation": "

    Information about the invitations.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "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.

    " } + }, + "resourceShareInvitations": { + "target": "com.amazonaws.ram#ResourceShareInvitationList", + "traits": { + "smithy.api#documentation": "

    Information about the invitations.

    " + } } } }, @@ -1225,24 +1225,18 @@ "com.amazonaws.ram#GetResourceSharesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.ram#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " - } - }, - "resourceShareStatus": { - "target": "com.amazonaws.ram#ResourceShareStatus", - "traits": { - "smithy.api#documentation": "

    The status of the resource share.

    " - } - }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resource shares.

    " } }, + "nextToken": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The token for the next page of results.

    " + } + }, "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { @@ -1250,22 +1244,28 @@ "smithy.api#required": {} } }, - "tagFilters": { - "target": "com.amazonaws.ram#TagFilters", + "name": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    One or more tag filters.

    " + "smithy.api#documentation": "

    The name of the resource share.

    " } }, - "nextToken": { - "target": "com.amazonaws.ram#String", + "maxResults": { + "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " + "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " } }, - "name": { - "target": "com.amazonaws.ram#String", + "tagFilters": { + "target": "com.amazonaws.ram#TagFilters", "traits": { - "smithy.api#documentation": "

    The name of the resource share.

    " + "smithy.api#documentation": "

    One or more tag filters.

    " + } + }, + "resourceShareStatus": { + "target": "com.amazonaws.ram#ResourceShareStatus", + "traits": { + "smithy.api#documentation": "

    The status of the resource share.

    " } } } @@ -1459,10 +1459,10 @@ "com.amazonaws.ram#ListPendingInvitationResourcesRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.ram#MaxResults", + "nextToken": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " + "smithy.api#documentation": "

    The token for the next page of results.

    " } }, "resourceShareInvitationArn": { @@ -1472,10 +1472,10 @@ "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.ram#String", + "maxResults": { + "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " + "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " } } } @@ -1483,17 +1483,17 @@ "com.amazonaws.ram#ListPendingInvitationResourcesResponse": { "type": "structure", "members": { - "resources": { - "target": "com.amazonaws.ram#ResourceList", - "traits": { - "smithy.api#documentation": "

    Information about the resources included the resource share.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "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.

    " } + }, + "resources": { + "target": "com.amazonaws.ram#ResourceList", + "traits": { + "smithy.api#documentation": "

    Information about the resources included the resource share.

    " + } } } }, @@ -1534,6 +1534,12 @@ "com.amazonaws.ram#ListPermissionsRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The token for the next page of results.

    " + } + }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { @@ -1545,29 +1551,23 @@ "traits": { "smithy.api#documentation": "

    Specifies the resource type for which to list permissions. For example, to list only \n\t\tpermissions that apply to EC2 subnets, specify ec2:Subnet.

    " } - }, - "nextToken": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " - } } } }, "com.amazonaws.ram#ListPermissionsResponse": { "type": "structure", "members": { - "permissions": { - "target": "com.amazonaws.ram#ResourceSharePermissionList", - "traits": { - "smithy.api#documentation": "

    Information about the permissions.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "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.

    " } + }, + "permissions": { + "target": "com.amazonaws.ram#ResourceSharePermissionList", + "traits": { + "smithy.api#documentation": "

    Information about the permissions.

    " + } } } }, @@ -1616,22 +1616,16 @@ "com.amazonaws.ram#ListPrincipalsRequest": { "type": "structure", "members": { - "principals": { - "target": "com.amazonaws.ram#PrincipalArnOrIdList", + "resourceShareArns": { + "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { - "smithy.api#documentation": "

    The principals.

    " + "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resource shares.

    " } }, - "nextToken": { + "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " - } - }, - "resourceShareArns": { - "target": "com.amazonaws.ram#ResourceShareArnList", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resource shares.

    " + "smithy.api#documentation": "

    The resource type.

    \n \t

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | \n \t\trds:Cluster | route53resolver:ResolverRule\n

    " } }, "resourceOwner": { @@ -1641,6 +1635,12 @@ "smithy.api#required": {} } }, + "nextToken": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The token for the next page of results.

    " + } + }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { @@ -1653,10 +1653,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " } }, - "resourceType": { - "target": "com.amazonaws.ram#String", + "principals": { + "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { - "smithy.api#documentation": "

    The resource type.

    \n \t

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | \n \t\trds:Cluster | route53resolver:ResolverRule\n

    " + "smithy.api#documentation": "

    The principals.

    " } } } @@ -1721,10 +1721,10 @@ "com.amazonaws.ram#ListResourceSharePermissionsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ram#String", + "maxResults": { + "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " + "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " } }, "resourceShareArn": { @@ -1734,10 +1734,10 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.ram#MaxResults", + "nextToken": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " + "smithy.api#documentation": "

    The token for the next page of results.

    " } } } @@ -1793,34 +1793,34 @@ "com.amazonaws.ram#ListResourceTypesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " - } - }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " } + }, + "nextToken": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The token for the next page of results.

    " + } } } }, "com.amazonaws.ram#ListResourceTypesResponse": { "type": "structure", "members": { - "resourceTypes": { - "target": "com.amazonaws.ram#ServiceNameAndResourceTypeList", - "traits": { - "smithy.api#documentation": "

    The shareable resource types supported by AWS RAM.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "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.

    " } + }, + "resourceTypes": { + "target": "com.amazonaws.ram#ServiceNameAndResourceTypeList", + "traits": { + "smithy.api#documentation": "

    The shareable resource types supported by AWS RAM.

    " + } } } }, @@ -1872,10 +1872,10 @@ "com.amazonaws.ram#ListResourcesRequest": { "type": "structure", "members": { - "resourceShareArns": { - "target": "com.amazonaws.ram#ResourceShareArnList", + "maxResults": { + "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resource shares.

    " + "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " } }, "principal": { @@ -1890,19 +1890,6 @@ "smithy.api#documentation": "

    The resource type.

    \n \t

    Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | \n \t\trds:Cluster | route53resolver:ResolverRule\n

    " } }, - "resourceOwner": { - "target": "com.amazonaws.ram#ResourceOwner", - "traits": { - "smithy.api#documentation": "

    The type of owner.

    ", - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.ram#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

    " - } - }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { @@ -1914,6 +1901,19 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resources.

    " } + }, + "resourceShareArns": { + "target": "com.amazonaws.ram#ResourceShareArnList", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the resource shares.

    " + } + }, + "resourceOwner": { + "target": "com.amazonaws.ram#ResourceOwner", + "traits": { + "smithy.api#documentation": "

    The type of owner.

    ", + "smithy.api#required": {} + } } } }, @@ -2016,22 +2016,16 @@ "com.amazonaws.ram#Principal": { "type": "structure", "members": { - "lastUpdatedTime": { - "target": "com.amazonaws.ram#DateTime", - "traits": { - "smithy.api#documentation": "

    The time when the association was last updated.

    " - } - }, - "id": { + "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The ID of the principal.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " } }, - "resourceShareArn": { - "target": "com.amazonaws.ram#String", + "external": { + "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " + "smithy.api#documentation": "

    Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    " } }, "creationTime": { @@ -2040,10 +2034,16 @@ "smithy.api#documentation": "

    The time when the principal was associated with the resource share.

    " } }, - "external": { - "target": "com.amazonaws.ram#Boolean", + "id": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    " + "smithy.api#documentation": "

    The ID of the principal.

    " + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.ram#DateTime", + "traits": { + "smithy.api#documentation": "

    The time when the association was last updated.

    " } } }, @@ -2186,17 +2186,17 @@ "com.amazonaws.ram#RejectResourceShareInvitationRequest": { "type": "structure", "members": { - "resourceShareInvitationArn": { + "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the invitation.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, - "clientToken": { + "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the invitation.

    ", + "smithy.api#required": {} } } } @@ -2204,27 +2204,39 @@ "com.amazonaws.ram#RejectResourceShareInvitationResponse": { "type": "structure", "members": { - "resourceShareInvitation": { - "target": "com.amazonaws.ram#ResourceShareInvitation", - "traits": { - "smithy.api#documentation": "

    Information about the invitation.

    " - } - }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } + }, + "resourceShareInvitation": { + "target": "com.amazonaws.ram#ResourceShareInvitation", + "traits": { + "smithy.api#documentation": "

    Information about the invitation.

    " + } } } }, "com.amazonaws.ram#Resource": { "type": "structure", "members": { - "lastUpdatedTime": { + "resourceGroupArn": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The ARN of the resource group. This value is returned only if the resource is a resource\n\t\t\tgroup.

    " + } + }, + "resourceShareArn": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " + } + }, + "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

    The time when the association was last updated.

    " + "smithy.api#documentation": "

    The time when the resource was associated with the resource share.

    " } }, "status": { @@ -2233,10 +2245,10 @@ "smithy.api#documentation": "

    The status of the resource.

    " } }, - "arn": { + "type": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + "smithy.api#documentation": "

    The resource type.

    " } }, "statusMessage": { @@ -2245,28 +2257,16 @@ "smithy.api#documentation": "

    A message about the status of the resource.

    " } }, - "type": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The resource type.

    " - } - }, - "resourceShareArn": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " - } - }, - "creationTime": { + "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

    The time when the resource was associated with the resource share.

    " + "smithy.api#documentation": "

    The time when the association was last updated.

    " } }, - "resourceGroupArn": { + "arn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The ARN of the resource group. This value is returned only if the resource is a resource\n\t\t\tgroup.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " } } }, @@ -2326,28 +2326,28 @@ "com.amazonaws.ram#ResourceShare": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.ram#TagList", + "lastUpdatedTime": { + "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

    The tags for the resource share.

    " + "smithy.api#documentation": "

    The time when the resource share was last updated.

    " } }, - "creationTime": { - "target": "com.amazonaws.ram#DateTime", + "name": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The time when the resource share was created.

    " + "smithy.api#documentation": "

    The name of the resource share.

    " } }, - "allowExternalPrincipals": { - "target": "com.amazonaws.ram#Boolean", + "owningAccountId": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " + "smithy.api#documentation": "

    The ID of the AWS account that owns the resource share.

    " } }, - "name": { + "statusMessage": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The name of the resource share.

    " + "smithy.api#documentation": "

    A message about the status of the resource share.

    " } }, "featureSet": { @@ -2356,34 +2356,34 @@ "smithy.api#documentation": "

    Indicates how the resource share was created. Possible values include:

    \n\t
      \n
    • \n\t\t\t

      \n CREATED_FROM_POLICY - Indicates that the resource share was created from an AWS Identity\n\t\t\t\t\tand Access Management (AWS IAM) policy attached to a resource. These resource shares are\n\t\t\t\t\tvisible only to the AWS account that created it. They cannot be modified in\n\t\t\t\t\tAWS RAM.

      \n\t\t
      • \n
    • \n\t\t\t

      \n PROMOTING_TO_STANDARD - The resource share is in the process \n\t\t\t\tof being promoted. For more information, see \n\t\t\t\tPromoteResourceShareCreatedFromPolicy.

      \n\t\t
      • \n
    • \n\t\t\t

      \n STANDARD - Indicates that the resource share was created in AWS RAM using the console or\n\t\t\t\t\tAPIs. These resource shares are visible to all principals. They can be modified\n\t\t\t\t\tin AWS RAM.

      \n\t\t
      • \n
    " } }, - "status": { - "target": "com.amazonaws.ram#ResourceShareStatus", + "creationTime": { + "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

    The status of the resource share.

    " + "smithy.api#documentation": "

    The time when the resource share was created.

    " } }, - "statusMessage": { + "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    A message about the status of the resource share.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " } }, - "owningAccountId": { - "target": "com.amazonaws.ram#String", + "tags": { + "target": "com.amazonaws.ram#TagList", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that owns the resource share.

    " + "smithy.api#documentation": "

    The tags for the resource share.

    " } }, - "lastUpdatedTime": { - "target": "com.amazonaws.ram#DateTime", + "status": { + "target": "com.amazonaws.ram#ResourceShareStatus", "traits": { - "smithy.api#documentation": "

    The time when the resource share was last updated.

    " + "smithy.api#documentation": "

    The status of the resource share.

    " } }, - "resourceShareArn": { - "target": "com.amazonaws.ram#String", + "allowExternalPrincipals": { + "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " + "smithy.api#documentation": "

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " } } }, @@ -2403,30 +2403,12 @@ "com.amazonaws.ram#ResourceShareAssociation": { "type": "structure", "members": { - "resourceShareName": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The name of the resource share.

    " - } - }, "statusMessage": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "

    A message about the status of the association.

    " } }, - "status": { - "target": "com.amazonaws.ram#ResourceShareAssociationStatus", - "traits": { - "smithy.api#documentation": "

    The status of the association.

    " - } - }, - "associatedEntity": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The associated entity. For resource associations, this is the ARN of the resource.\n For principal associations, this is the ID of an AWS account or the ARN of an OU or\n organization from AWS Organizations.

    " - } - }, "associationType": { "target": "com.amazonaws.ram#ResourceShareAssociationType", "traits": { @@ -2439,10 +2421,10 @@ "smithy.api#documentation": "

    Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    " } }, - "lastUpdatedTime": { - "target": "com.amazonaws.ram#DateTime", + "resourceShareName": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The time when the association was last updated.

    " + "smithy.api#documentation": "

    The name of the resource share.

    " } }, "creationTime": { @@ -2456,6 +2438,24 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " } + }, + "status": { + "target": "com.amazonaws.ram#ResourceShareAssociationStatus", + "traits": { + "smithy.api#documentation": "

    The status of the association.

    " + } + }, + "associatedEntity": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The associated entity. For resource associations, this is the ARN of the resource.\n For principal associations, this is the ID of an AWS account or the ARN of an OU or\n organization from AWS Organizations.

    " + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.ram#DateTime", + "traits": { + "smithy.api#documentation": "

    The time when the association was last updated.

    " + } } }, "traits": { @@ -2525,6 +2525,18 @@ "com.amazonaws.ram#ResourceShareInvitation": { "type": "structure", "members": { + "resourceShareArn": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " + } + }, + "receiverAccountId": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS account that received the invitation.

    " + } + }, "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { @@ -2540,28 +2552,16 @@ "smithy.api#documentation": "

    The date and time when the invitation was sent.

    " } }, - "resourceShareArn": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    " - } - }, - "resourceShareName": { - "target": "com.amazonaws.ram#String", - "traits": { - "smithy.api#documentation": "

    The name of the resource share.

    " - } - }, "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the invitation.

    " } }, - "receiverAccountId": { - "target": "com.amazonaws.ram#String", + "status": { + "target": "com.amazonaws.ram#ResourceShareInvitationStatus", "traits": { - "smithy.api#documentation": "

    The ID of the AWS account that received the invitation.

    " + "smithy.api#documentation": "

    The status of the invitation.

    " } }, "senderAccountId": { @@ -2570,10 +2570,10 @@ "smithy.api#documentation": "

    The ID of the AWS account that sent the invitation.

    " } }, - "status": { - "target": "com.amazonaws.ram#ResourceShareInvitationStatus", + "resourceShareName": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The status of the invitation.

    " + "smithy.api#documentation": "

    The name of the resource share.

    " } } }, @@ -2710,40 +2710,40 @@ "com.amazonaws.ram#ResourceSharePermissionDetail": { "type": "structure", "members": { - "defaultVersion": { - "target": "com.amazonaws.ram#Boolean", + "version": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The identifier for the version of the permission that is set as the \n \t\tdefault version.

    " + "smithy.api#documentation": "

    The identifier for the version of the permission.

    " } }, - "lastUpdatedTime": { + "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

    The date and time when the permission was last updated.

    " + "smithy.api#documentation": "

    The date and time when the permission was created.

    " } }, - "permission": { + "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The permission's effect and actions in JSON format. The effect indicates whether\n\t\t\tthe actions are allowed or denied. The actions list the API actions to\n\t\t\twhich the principal is granted or denied access.

    " + "smithy.api#documentation": "

    The resource type to which the permission applies.

    " } }, - "creationTime": { + "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

    The date and time when the permission was created.

    " + "smithy.api#documentation": "

    The date and time when the permission was last updated.

    " } }, - "resourceType": { + "permission": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The resource type to which the permission applies.

    " + "smithy.api#documentation": "

    The permission's effect and actions in JSON format. The effect indicates whether\n\t\t\tthe actions are allowed or denied. The actions list the API actions to\n\t\t\twhich the principal is granted or denied access.

    " } }, - "version": { + "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The identifier for the version of the permission.

    " + "smithy.api#documentation": "

    The name of the permission.

    " } }, "arn": { @@ -2752,10 +2752,10 @@ "smithy.api#documentation": "

    The ARN of the permission.

    " } }, - "name": { - "target": "com.amazonaws.ram#String", + "defaultVersion": { + "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

    The name of the permission.

    " + "smithy.api#documentation": "

    The identifier for the version of the permission that is set as the \n \t\tdefault version.

    " } } }, @@ -2775,16 +2775,22 @@ "com.amazonaws.ram#ResourceSharePermissionSummary": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.ram#String", + "defaultVersion": { + "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

    The current status of the permission.

    " + "smithy.api#documentation": "

    The identifier for the version of the permission that is set as the default version.

    " } }, - "name": { + "lastUpdatedTime": { + "target": "com.amazonaws.ram#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time when the permission was last updated.

    " + } + }, + "status": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The name of the permission.

    " + "smithy.api#documentation": "

    The current status of the permission.

    " } }, "creationTime": { @@ -2793,34 +2799,28 @@ "smithy.api#documentation": "

    The date and time when the permission was created.

    " } }, - "defaultVersion": { - "target": "com.amazonaws.ram#Boolean", - "traits": { - "smithy.api#documentation": "

    The identifier for the version of the permission that is set as the default version.

    " - } - }, - "arn": { + "version": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The ARN of the permission.

    " + "smithy.api#documentation": "

    The identifier for the version of the permission.

    " } }, - "resourceType": { + "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The type of resource to which the permission applies.

    " + "smithy.api#documentation": "

    The name of the permission.

    " } }, - "version": { + "arn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The identifier for the version of the permission.

    " + "smithy.api#documentation": "

    The ARN of the permission.

    " } }, - "lastUpdatedTime": { - "target": "com.amazonaws.ram#DateTime", + "resourceType": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The date and time when the permission was last updated.

    " + "smithy.api#documentation": "

    The type of resource to which the permission applies.

    " } } }, @@ -2891,16 +2891,16 @@ "com.amazonaws.ram#ServiceNameAndResourceType": { "type": "structure", "members": { - "serviceName": { + "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The name of the AWS services to which the resources belong.

    " + "smithy.api#documentation": "

    The shareable resource types.

    " } }, - "resourceType": { + "serviceName": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The shareable resource types.

    " + "smithy.api#documentation": "

    The name of the AWS services to which the resources belong.

    " } } }, @@ -2959,17 +2959,17 @@ "com.amazonaws.ram#TagFilter": { "type": "structure", "members": { - "tagKey": { - "target": "com.amazonaws.ram#TagKey", - "traits": { - "smithy.api#documentation": "

    The tag key.

    " - } - }, "tagValues": { "target": "com.amazonaws.ram#TagValueList", "traits": { "smithy.api#documentation": "

    The tag values.

    " } + }, + "tagKey": { + "target": "com.amazonaws.ram#TagKey", + "traits": { + "smithy.api#documentation": "

    The tag key.

    " + } } }, "traits": { @@ -3072,17 +3072,17 @@ "com.amazonaws.ram#TagResourceRequest": { "type": "structure", "members": { - "resourceShareArn": { - "target": "com.amazonaws.ram#String", + "tags": { + "target": "com.amazonaws.ram#TagList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", + "smithy.api#documentation": "

    One or more tags.

    ", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.ram#TagList", + "resourceShareArn": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    One or more tags.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", "smithy.api#required": {} } } @@ -3148,17 +3148,17 @@ "com.amazonaws.ram#UntagResourceRequest": { "type": "structure", "members": { - "resourceShareArn": { - "target": "com.amazonaws.ram#String", + "tagKeys": { + "target": "com.amazonaws.ram#TagKeyList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", + "smithy.api#documentation": "

    The tag keys of the tags to remove.

    ", "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.ram#TagKeyList", + "resourceShareArn": { + "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The tag keys of the tags to remove.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", "smithy.api#required": {} } } @@ -3217,16 +3217,17 @@ "com.amazonaws.ram#UpdateResourceShareRequest": { "type": "structure", "members": { - "clientToken": { + "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", + "smithy.api#required": {} } }, - "name": { + "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The name of the resource share.

    " + "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, "allowExternalPrincipals": { @@ -3235,11 +3236,10 @@ "smithy.api#documentation": "

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " } }, - "resourceShareArn": { + "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource share.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the resource share.

    " } } } @@ -3247,17 +3247,17 @@ "com.amazonaws.ram#UpdateResourceShareResponse": { "type": "structure", "members": { - "resourceShare": { - "target": "com.amazonaws.ram#ResourceShare", - "traits": { - "smithy.api#documentation": "

    Information about the resource share.

    " - } - }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } + }, + "resourceShare": { + "target": "com.amazonaws.ram#ResourceShare", + "traits": { + "smithy.api#documentation": "

    Information about the resource share.

    " + } } } } 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 085017fc2008..8808d37098a7 100644 --- a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json @@ -46,12 +46,6 @@ "com.amazonaws.rds#AccountQuota": { "type": "structure", "members": { - "AccountQuotaName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the Amazon RDS quota for this AWS account.

    " - } - }, "Max": { "target": "com.amazonaws.rds#Long", "traits": { @@ -63,6 +57,12 @@ "traits": { "smithy.api#documentation": "

    The amount currently used toward the quota maximum.

    " } + }, + "AccountQuotaName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the Amazon RDS quota for this AWS account.

    " + } } }, "traits": { @@ -184,10 +184,10 @@ "com.amazonaws.rds#AddRoleToDBInstanceMessage": { "type": "structure", "members": { - "FeatureName": { + "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the feature for the DB instance that the IAM role is to be associated with. \n For the list of supported feature names, see DBEngineVersion.\n

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

    ", "smithy.api#required": {} } }, @@ -198,10 +198,10 @@ "smithy.api#required": {} } }, - "RoleArn": { + "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

    ", + "smithy.api#documentation": "

    The name of the feature for the DB instance that the IAM role is to be associated with. \n For the list of supported feature names, see DBEngineVersion.\n

    ", "smithy.api#required": {} } } @@ -230,17 +230,17 @@ "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { "type": "structure", "members": { - "SourceIdentifier": { + "SubscriptionName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the event source to be added.

    \n

    Constraints:

    \n
      \n
    • \n

      If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB security group, a DBSecurityGroupName must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the RDS event notification subscription you want to add a source identifier to.

    ", "smithy.api#required": {} } }, - "SubscriptionName": { + "SourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the RDS event notification subscription you want to add a source identifier to.

    ", + "smithy.api#documentation": "

    The identifier of the event source to be added.

    \n

    Constraints:

    \n
      \n
    • \n

      If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -705,7 +705,7 @@ "sdkId": "RDS", "arnNamespace": "rds", "cloudFormationName": "RDS", - "cloudTrailEventSource": "v20141031.admin.rds" + "cloudTrailEventSource": "rds.amazonaws.com" }, "aws.auth#sigv4": { "name": "rds" @@ -757,10 +757,10 @@ "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { "type": "structure", "members": { - "ResourceIdentifier": { + "ApplyAction": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

    ", + "smithy.api#documentation": "

    The pending maintenance action to apply to this resource.

    \n

    Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

    ", "smithy.api#required": {} } }, @@ -771,10 +771,10 @@ "smithy.api#required": {} } }, - "ApplyAction": { + "ResourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The pending maintenance action to apply to this resource.

    \n

    Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

    ", + "smithy.api#documentation": "

    The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

    ", "smithy.api#required": {} } } @@ -879,16 +879,16 @@ "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { "type": "structure", "members": { - "EC2SecurityGroupOwnerId": { + "EC2SecurityGroupId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n AWS account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

    " + "smithy.api#documentation": "

    \n Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

    " } }, - "CIDRIP": { + "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The IP range to authorize.

    " + "smithy.api#documentation": "

    \n AWS account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

    " } }, "EC2SecurityGroupName": { @@ -904,10 +904,10 @@ "smithy.api#required": {} } }, - "EC2SecurityGroupId": { + "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

    " + "smithy.api#documentation": "

    The IP range to authorize.

    " } } }, @@ -958,10 +958,10 @@ "com.amazonaws.rds#AvailableProcessorFeature": { "type": "structure", "members": { - "Name": { + "AllowedValues": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the processor feature. Valid names are coreCount \n and threadsPerCore.

    " + "smithy.api#documentation": "

    The allowed values for the processor feature of the DB instance class.

    " } }, "DefaultValue": { @@ -970,10 +970,10 @@ "smithy.api#documentation": "

    The default value for the processor feature of the DB instance class.

    " } }, - "AllowedValues": { + "Name": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The allowed values for the processor feature of the DB instance class.

    " + "smithy.api#documentation": "

    The name of the processor feature. Valid names are coreCount \n and threadsPerCore.

    " } } }, @@ -1013,6 +1013,18 @@ "com.amazonaws.rds#BacktrackDBClusterMessage": { "type": "structure", "members": { + "UseEarliestTimeOnPointInTimeUnavailable": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

    " + } + }, + "Force": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

    " + } + }, "BacktrackTo": { "target": "com.amazonaws.rds#TStamp", "traits": { @@ -1026,18 +1038,6 @@ "smithy.api#documentation": "

    The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n

    Example: my-cluster1\n

    ", "smithy.api#required": {} } - }, - "UseEarliestTimeOnPointInTimeUnavailable": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

    " - } - }, - "Force": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

    " - } } }, "traits": { @@ -1103,28 +1103,28 @@ "com.amazonaws.rds#Certificate": { "type": "structure", "members": { - "CertificateArn": { - "target": "com.amazonaws.rds#String", + "CustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the certificate.

    " + "smithy.api#documentation": "

    Whether there is an override for the default certificate identifier.

    " } }, - "CertificateIdentifier": { + "Thumbprint": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The unique key that identifies a certificate.

    " + "smithy.api#documentation": "

    The thumbprint of the certificate.

    " } }, - "CertificateType": { + "CertificateArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The type of the certificate.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the certificate.

    " } }, - "CustomerOverrideValidTill": { - "target": "com.amazonaws.rds#TStamp", + "CertificateType": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If there is an override for the default certificate identifier, when the override\n expires.

    " + "smithy.api#documentation": "

    The type of the certificate.

    " } }, "ValidTill": { @@ -1133,22 +1133,22 @@ "smithy.api#documentation": "

    The final date that the certificate continues to be valid.

    " } }, - "ValidFrom": { - "target": "com.amazonaws.rds#TStamp", + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The starting date from which the certificate is valid.

    " + "smithy.api#documentation": "

    The unique key that identifies a certificate.

    " } }, - "Thumbprint": { - "target": "com.amazonaws.rds#String", + "CustomerOverrideValidTill": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The thumbprint of the certificate.

    " + "smithy.api#documentation": "

    If there is an override for the default certificate identifier, when the override\n expires.

    " } }, - "CustomerOverride": { - "target": "com.amazonaws.rds#BooleanOptional", + "ValidFrom": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    Whether there is an override for the default certificate identifier.

    " + "smithy.api#documentation": "

    The starting date from which the certificate is valid.

    " } } }, @@ -1168,17 +1168,17 @@ "com.amazonaws.rds#CertificateMessage": { "type": "structure", "members": { - "Certificates": { - "target": "com.amazonaws.rds#CertificateList", - "traits": { - "smithy.api#documentation": "

    The list of Certificate objects for the AWS account.

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " } + }, + "Certificates": { + "target": "com.amazonaws.rds#CertificateList", + "traits": { + "smithy.api#documentation": "

    The list of Certificate objects for the AWS account.

    " + } } }, "traits": { @@ -1221,36 +1221,30 @@ "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { "type": "structure", "members": { - "EnableLogTypes": { + "DisableLogTypes": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The list of log types to enable.

    " + "smithy.api#documentation": "

    The list of log types to disable.

    " } }, - "DisableLogTypes": { + "EnableLogTypes": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The list of log types to disable.

    " + "smithy.api#documentation": "

    The list of log types to enable.

    " } } }, "traits": { - "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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon\n RDS User Guide.

    " + "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#ConnectionPoolConfiguration": { "type": "structure", "members": { - "MaxIdleConnectionsPercent": { + "MaxConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    \n Controls how actively the proxy closes idle database connections in the connection pool.\n A high value enables the proxy to leave a high percentage of idle connections open.\n A low value causes the proxy to close idle client connections and return the underlying\n database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n

    \n

    Default: 50

    \n

    Constraints: between 0 and MaxConnectionsPercent\n

    " - } - }, - "SessionPinningFilters": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

    Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

    \n

    Default: no session pinning filters

    " + "smithy.api#documentation": "

    The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

    \n

    Default: 100

    \n

    Constraints: between 1 and 100

    " } }, "InitQuery": { @@ -1259,16 +1253,22 @@ "smithy.api#documentation": "

    \n One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.\n

    \n

    Default: no initialization query

    " } }, - "MaxConnectionsPercent": { + "ConnectionBorrowTimeout": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

    \n

    Default: 100

    \n

    Constraints: between 1 and 100

    " + "smithy.api#documentation": "

    The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

    \n

    Default: 120

    \n

    Constraints: between 1 and 3600, or 0 representing unlimited

    " } }, - "ConnectionBorrowTimeout": { + "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

    \n

    Default: 120

    \n

    Constraints: between 1 and 3600, or 0 representing unlimited

    " + "smithy.api#documentation": "

    \n Controls how actively the proxy closes idle database connections in the connection pool.\n A high value enables the proxy to leave a high percentage of idle connections open.\n A low value causes the proxy to close idle client connections and return the underlying\n database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n

    \n

    Default: 50

    \n

    Constraints: between 0 and MaxConnectionsPercent\n

    " + } + }, + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

    Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

    \n

    Default: no session pinning filters

    " } } }, @@ -1279,16 +1279,10 @@ "com.amazonaws.rds#ConnectionPoolConfigurationInfo": { "type": "structure", "members": { - "SessionPinningFilters": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

    Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. Currently, the only\n allowed value is EXCLUDE_VARIABLE_SETS.

    " - } - }, - "InitQuery": { - "target": "com.amazonaws.rds#String", + "MaxConnectionsPercent": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    \n One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.\n

    " + "smithy.api#documentation": "

    The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

    " } }, "ConnectionBorrowTimeout": { @@ -1303,10 +1297,16 @@ "smithy.api#documentation": "

    \n Controls how actively the proxy closes idle database connections in the connection pool.\n A high value enables the proxy to leave a high percentage of idle connections open.\n A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool.\n For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n

    " } }, - "MaxConnectionsPercent": { - "target": "com.amazonaws.rds#Integer", + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

    " + "smithy.api#documentation": "

    Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. Currently, the only\n allowed value is EXCLUDE_VARIABLE_SETS.

    " + } + }, + "InitQuery": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.\n

    " } } }, @@ -1340,6 +1340,9 @@ "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, "TargetDBClusterParameterGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { @@ -1360,9 +1363,6 @@ "smithy.api#documentation": "

    The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must specify a valid DB cluster parameter group.

      \n
      • \n
    • \n

      If the source DB cluster parameter group is in the same AWS Region as the copy, \n specify a valid DB parameter group identifier, for example\n my-db-cluster-param-group, or a valid ARN.

      \n
      • \n
    • \n

      If the source DB parameter group is in a different AWS Region than the copy,\n specify a valid DB cluster parameter group ARN, for example\n arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

      \n
      • \n
    ", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" } } }, @@ -1416,6 +1416,12 @@ "smithy.api#required": {} } }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The AWS KMS key ID for an encrypted DB cluster snapshot. \n The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    \n \n

    If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. \n

    \n \n

    If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

    \n \n

    To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot \n in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region \n in another AWS Region.

    \n \n

    If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

    " + } + }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { @@ -1429,19 +1435,13 @@ "smithy.api#required": {} } }, - "CopyTags": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

    " - } - }, "Tags": { "target": "com.amazonaws.rds#TagList" }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The AWS KMS key ID for an encrypted DB cluster snapshot. \n The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    \n \n

    If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. \n

    \n \n

    If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

    \n \n

    To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot \n in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region \n in another AWS Region.

    \n \n

    If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

    " + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

    " } } }, @@ -1483,6 +1483,9 @@ "com.amazonaws.rds#CopyDBParameterGroupMessage": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, "SourceDBParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -1490,20 +1493,17 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "TargetDBParameterGroupIdentifier": { + "TargetDBParameterGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the copied DB parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      Can't be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-db-parameter-group\n

    ", + "smithy.api#documentation": "

    A description for the copied DB parameter group.

    ", "smithy.api#required": {} } }, - "TargetDBParameterGroupDescription": { + "TargetDBParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A description for the copied DB parameter group.

    ", + "smithy.api#documentation": "

    The identifier for the copied DB parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      Can't be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-db-parameter-group\n

    ", "smithy.api#required": {} } } @@ -1546,22 +1546,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.

    \n \n

    You can copy a snapshot from one AWS Region to another. In that case, the AWS Region\n where you call the CopyDBSnapshot action is the destination AWS Region for the\n DB snapshot copy.

    \n \n

    For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    Copies the specified DB snapshot. The source DB snapshot must be in the available state.

    \n \n

    You can copy a snapshot from one AWS Region to another. In that case, the AWS Region\n where you call the CopyDBSnapshot action is the destination AWS Region for the\n DB snapshot copy.

    \n \n

    For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n

    " } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { "type": "structure", "members": { - "KmsKeyId": { + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "TargetDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key ID for an encrypted DB snapshot. \n The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. \n

    \n \n

    If you copy an encrypted DB snapshot from your AWS account, \n you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. \n

    \n\n

    If you copy an encrypted DB snapshot that is shared from another AWS account, \n then you must specify a value for this parameter.\n

    \n \n

    If you specify this parameter \n when you copy an unencrypted snapshot, \n the copy is encrypted.\n

    \n \n

    If you copy an encrypted snapshot to a different AWS Region, then you must specify\n a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region\n that they are created in, and you can't use encryption keys from one AWS Region in another\n AWS Region.\n

    " + "smithy.api#documentation": "

    The identifier for the copy of the snapshot.\n

    \n \n

    Constraints:

    \n \n
      \n
    • \n

      Can't be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n\n

    Example: my-db-snapshot\n

    ", + "smithy.api#required": {} } }, - "CopyTags": { - "target": "com.amazonaws.rds#BooleanOptional", + "KmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

    " + "smithy.api#documentation": "

    The AWS KMS key ID for an encrypted DB snapshot. \n The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. \n

    \n \n

    If you copy an encrypted DB snapshot from your AWS account, \n you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. \n

    \n\n

    If you copy an encrypted DB snapshot that is shared from another AWS account, \n then you must specify a value for this parameter.\n

    \n \n

    If you specify this parameter \n when you copy an unencrypted snapshot, \n the copy is encrypted.\n

    \n \n

    If you copy an encrypted snapshot to a different AWS Region, then you must specify\n a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region\n that they are created in, and you can't use encryption keys from one AWS Region in another\n AWS Region.\n

    " } }, "SourceDBSnapshotIdentifier": { @@ -1571,11 +1575,10 @@ "smithy.api#required": {} } }, - "TargetDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The identifier for the copy of the snapshot.\n

    \n \n

    Constraints:

    \n \n
      \n
    • \n

      Can't be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n\n

    Example: my-db-snapshot\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

    " } }, "PreSignedUrl": { @@ -1584,9 +1587,6 @@ "smithy.api#documentation": "

    The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source AWS Region that contains the\n source DB snapshot to copy.

    \n \n

    You must specify this parameter when you copy an encrypted DB snapshot from another\n AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same AWS Region.

    \n \n

    The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:\n

    \n \n
      \n
    • \n

      \n DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. \n This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.\n

      \n\n

      For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region\n to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in\n the us-east-1 AWS Region and provide a presigned URL that contains a call to the\n CopyDBSnapshot action in the us-west-2 AWS Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 AWS Region.

      \n
      • \n
    • \n

      \n KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. \n This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, \n and the action contained in the presigned URL.\n

      \n
      • \n
    • \n

      \n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.\n

      \n
      • \n
    \n\n\t

    To learn how to generate a Signature Version 4 signed request, see \n\t\tAuthenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n\t\tSignature Version 4 Signing Process.\n\t

    \n \n \n

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.

    \n     " } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -1632,13 +1632,6 @@ "com.amazonaws.rds#CopyOptionGroupMessage": { "type": "structure", "members": { - "TargetOptionGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The identifier for the copied option group.

    \n

    Constraints:

    \n
      \n
    • \n

      Can't be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-option-group\n

    ", - "smithy.api#required": {} - } - }, "TargetOptionGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { @@ -1646,15 +1639,22 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, "SourceOptionGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier or ARN for the source option group. For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must specify a valid option group.

      \n
      • \n
    • \n

      If the source option group is in the same AWS Region as the copy, \n specify a valid option group identifier, for example my-option-group,\n or a valid ARN.

      \n
      • \n
    • \n

      If the source option group is in a different AWS Region than the copy,\n specify a valid option group ARN, for example \n arn:aws:rds:us-west-2:123456789012:og:special-options.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The identifier for the source option group.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must specify a valid option group.

      \n
      • \n
    ", "smithy.api#required": {} } + }, + "TargetOptionGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The identifier for the copied option group.

    \n

    Constraints:

    \n
      \n
    • \n

      Can't be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-option-group\n

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" } }, "traits": { @@ -1695,29 +1695,29 @@ "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage": { "type": "structure", "members": { - "ExistingVpnId": { + "CustomAvailabilityZoneName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ID of an existing virtual private network (VPN) between the Amazon RDS website and\n the VMware vSphere cluster.

    " + "smithy.api#documentation": "

    The name of the custom Availability Zone (AZ).

    ", + "smithy.api#required": {} } }, - "VpnTunnelOriginatorIP": { + "NewVpnTunnelName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

    \n

    Specify this parameter only if ExistingVpnId isn't specified.

    " + "smithy.api#documentation": "

    The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

    \n

    Specify this parameter only if ExistingVpnId isn't specified.

    " } }, - "CustomAvailabilityZoneName": { + "VpnTunnelOriginatorIP": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the custom Availability Zone (AZ).

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

    \n

    Specify this parameter only if ExistingVpnId isn't specified.

    " } }, - "NewVpnTunnelName": { + "ExistingVpnId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

    \n

    Specify this parameter only if ExistingVpnId isn't specified.

    " + "smithy.api#documentation": "

    The ID of an existing virtual private network (VPN) between the Amazon RDS website and\n the VMware vSphere cluster.

    " } } }, @@ -1836,42 +1836,42 @@ "com.amazonaws.rds#CreateDBClusterEndpointMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

    The tags to be assigned to the Amazon RDS resource.

    " - } - }, - "DBClusterEndpointIdentifier": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

    ", + "smithy.api#documentation": "

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

    ", "smithy.api#required": {} } }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

    List of DB instance identifiers that are part of the custom endpoint group.

    " - } - }, "ExcludedMembers": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "

    List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

    " } }, - "DBClusterIdentifier": { + "EndpointType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

    ", + "smithy.api#documentation": "

    The type of the endpoint. One of: READER, WRITER, ANY.

    ", "smithy.api#required": {} } }, - "EndpointType": { + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

    The tags to be assigned to the Amazon RDS resource.

    " + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

    List of DB instance identifiers that are part of the custom endpoint group.

    " + } + }, + "DBClusterEndpointIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The type of the endpoint. One of: READER, WRITER, ANY.

    ", + "smithy.api#documentation": "

    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

    ", "smithy.api#required": {} } } @@ -1880,34 +1880,17 @@ "com.amazonaws.rds#CreateDBClusterMessage": { "type": "structure", "members": { - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

    A list of EC2 VPC security groups to associate with this DB cluster.

    " - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with this DB cluster.

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mySubnetgroup\n

    " - } - }, - "CopyTagsToSnapshot": { + "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

    " - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.

    \n

    When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

    \n

    For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

    " } }, - "DBClusterParameterGroupName": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DB cluster parameter group.

      \n
      • \n
    " + "smithy.api#documentation": "

    The DB cluster identifier. This parameter is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n

    Example: my-cluster1\n

    ", + "smithy.api#required": {} } }, "BackupRetentionPeriod": { @@ -1916,11 +1899,10 @@ "smithy.api#documentation": "

    The number of days for which automated backups are retained.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 1 to 35

      \n
      • \n
    " } }, - "Engine": { + "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the database engine to be used for this DB cluster.

    \n

    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " } }, "MasterUsername": { @@ -1929,64 +1911,64 @@ "smithy.api#documentation": "

    The name of the master user for the DB cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    " } }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", + "CharacterSetName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " + "smithy.api#documentation": "

    A value that indicates that the DB cluster should be associated with the specified CharacterSet.

    " } }, - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "EnableGlobalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    \n The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.\n

    " + "smithy.api#documentation": "

    A value that indicates whether to enable write operations to be forwarded\n from this cluster to the primary cluster in an Aurora global database. The\n resulting changes are replicated back to this cluster. This parameter only\n applies to DB clusters that are secondary clusters in an Aurora global database.\n By default, Aurora disallows write operations for secondary clusters.

    " } }, - "DeletionProtection": { + "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB cluster is encrypted.

    " } }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

    A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on\n AWS Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    A list of EC2 VPC security groups to associate with this DB cluster.

    " } }, - "KmsKeyId": { + "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for an encrypted DB cluster.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption\n key. If you are creating a DB cluster with the same AWS account that owns the KMS\n encryption key used to encrypt the new DB cluster, then you can use the KMS key alias\n instead of the ARN for the KMS encryption key.

    \n

    If an encryption key isn't specified in KmsKeyId:

    \n
      \n
    • \n

      If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the encryption key used to encrypt the\n source. Otherwise, Amazon RDS will use your default encryption key.

      \n
      • \n
    • \n

      If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default encryption key.

      \n
      • \n
    \n

    AWS KMS creates the default encryption key for your AWS account. Your AWS account\n has a different default encryption key for each AWS Region.

    \n

    If you create a read replica of an encrypted DB cluster in another AWS Region, you\n must set KmsKeyId to a KMS key ID that is valid in the destination AWS\n Region. This key is used to encrypt the read replica in that AWS Region.

    " + "smithy.api#documentation": "

    A DB subnet group to associate with this DB cluster.

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mySubnetgroup\n

    " } }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

    " + "smithy.api#documentation": "

    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    \n

    \n Aurora MySQL\n

    \n

    Possible values are audit, error, general, and slowquery. \n

    \n

    \n Aurora PostgreSQL\n

    \n

    Possible values are postgresql and upgrade.\n

    " } }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

    \n \n

    The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

    \n

    The pre-signed URL request must contain the following parameter values:

    \n
      \n
    • \n

      \n KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of \n the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

      \n
      • \n
    • \n

      \n DestinationRegion - The name of the AWS Region that Aurora read replica will\n be created in.

      \n
      • \n
    • \n

      \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

      \n
      • \n
    \n \n

    To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n \n Signature Version 4 Signing Process.

    \n \n

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.

    \n     " + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

    The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " + "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " } }, - "PreferredMaintenanceWindow": { + "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n

    Constraints: Minimum 30-minute window.

    " + "smithy.api#documentation": "

    The Active Directory directory ID to create the DB cluster in.

    \n

    \n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

    " } }, - "EnableGlobalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", + "EngineVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable write operations to be forwarded\n from this cluster to the primary cluster in an Aurora global database. The\n resulting changes are replicated back to this cluster. This parameter only\n applies to DB clusters that are secondary clusters in an Aurora global database.\n By default, Aurora disallows write operations for secondary clusters.

    " + "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    \n Aurora MySQL\n

    \n

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n

    \n

    \n Aurora PostgreSQL\n

    \n

    Example: 9.6.3, 10.7\n

    " } }, "MasterUserPassword": { @@ -1995,89 +1977,107 @@ "smithy.api#documentation": "

    The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n

    Constraints: Must contain from 8 to 41 characters.

    " } }, - "Tags": { - "target": "com.amazonaws.rds#TagList", + "EngineMode": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Tags to assign to the DB cluster.

    " + "smithy.api#documentation": "

    The DB engine mode of the DB cluster, either provisioned \n serverless, \n parallelquery, global, or multimaster.

    \n

    The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.

    \n

    The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.

    \n

    The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

    \n

    For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.

    \n

    Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

    \n " } }, - "ReplicationSourceIdentifier": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

    " + "smithy.api#documentation": "

    The port number on which the instances in the DB cluster accept connections.

    \n

    \n Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.\n

    " } }, - "DomainIAMRoleName": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    \n The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DB cluster parameter group.

      \n
      • \n
    " } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    " } }, - "Domain": { + "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Active Directory directory ID to create the DB cluster in.

    \n

    \n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

    " } }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", + "OptionGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB cluster is encrypted.

    " + "smithy.api#documentation": "

    A value that indicates that the DB cluster should be associated with the specified option group.

    \n

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    " } }, - "CharacterSetName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates that the DB cluster should be associated with the specified CharacterSet.

    " + "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n

    Constraints: Minimum 30-minute window.

    " } }, - "EngineMode": { - "target": "com.amazonaws.rds#String", + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

    The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

    \n \n

    \n global engine mode only applies for global database clusters created with Aurora MySQL version\n 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned\n engine mode.\n

    \n     \n

    Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

    \n " + "smithy.api#documentation": "

    A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on\n AWS Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.\n

    " } }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "KmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The port number on which the instances in the DB cluster accept connections.

    \n

    \n Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.\n

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for an encrypted DB cluster.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption\n key. If you are creating a DB cluster with the same AWS account that owns the KMS\n encryption key used to encrypt the new DB cluster, then you can use the KMS key alias\n instead of the ARN for the KMS encryption key.

    \n

    If an encryption key isn't specified in KmsKeyId:

    \n
      \n
    • \n

      If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the encryption key used to encrypt the\n source. Otherwise, Amazon RDS will use your default encryption key.

      \n
      • \n
    • \n

      If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default encryption key.

      \n
      • \n
    \n

    AWS KMS creates the default encryption key for your AWS account. Your AWS account\n has a different default encryption key for each AWS Region.

    \n

    If you create a read replica of an encrypted DB cluster in another AWS Region, you\n must set KmsKeyId to a KMS key ID that is valid in the destination AWS\n Region. This key is used to encrypt the read replica in that AWS Region.

    " } }, - "EnableHttpEndpoint": { + "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.

    \n

    When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

    \n

    For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.

    " } }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", + "ReplicationSourceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

    " } }, - "DBClusterIdentifier": { + "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB cluster identifier. This parameter is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n

    Example: my-cluster1\n

    ", + "smithy.api#documentation": "

    \n The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.\n

    " + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the database engine to be used for this DB cluster.

    \n

    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n

    ", "smithy.api#required": {} } }, - "OptionGroupName": { + "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates that the DB cluster should be associated with the specified option group.

    \n

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    " + "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " } }, - "EngineVersion": { + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

    Tags to assign to the DB cluster.

    " + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

    " + } + }, + "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    \n Aurora MySQL\n

    \n

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n

    \n

    \n Aurora PostgreSQL\n

    \n

    Example: 9.6.3, 10.7\n

    " + "smithy.api#documentation": "

    A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

    \n \n

    The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

    \n

    The pre-signed URL request must contain the following parameter values:

    \n
      \n
    • \n

      \n KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of \n the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

      \n
      • \n
    • \n

      \n DestinationRegion - The name of the AWS Region that Aurora read replica will\n be created in.

      \n
      • \n
    • \n

      \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

      \n
      • \n
    \n \n

    To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n \n Signature Version 4 Signing Process.

    \n \n

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.

    \n     " } } }, @@ -2108,16 +2108,17 @@ "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.rds#TagList", + "Description": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Tags to assign to the DB cluster parameter group.

    " + "smithy.api#documentation": "

    The description for the DB cluster parameter group.

    ", + "smithy.api#required": {} } }, - "Description": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The description for the DB cluster parameter group.

    ", + "smithy.api#documentation": "

    The name of the DB cluster parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the name of an existing DB cluster parameter group.

      \n
      • \n
    \n \n

    This value is stored as a lowercase string.

    \n     ", "smithy.api#required": {} } }, @@ -2128,11 +2129,10 @@ "smithy.api#required": {} } }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", + "Tags": { + "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

    The name of the DB cluster parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the name of an existing DB cluster parameter group.

      \n
      • \n
    \n \n

    This value is stored as a lowercase string.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Tags to assign to the DB cluster parameter group.

    " } } }, @@ -2295,29 +2295,28 @@ "com.amazonaws.rds#CreateDBInstanceMessage": { "type": "structure", "members": { - "DBSubnetGroupName": { + "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    \n

    If there is no DB subnet group, then it is a non-VPC DB instance.

    " + "smithy.api#documentation": "

    \n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n For more information, see The Backup Window in the Amazon RDS User Guide.\n

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

    \n \n

    \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.\n

    \n \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " } }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A list of DB security groups to associate with this DB instance.

    \n

    Default: The default DB security group for the database engine.

    " + "smithy.api#documentation": "

    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

    " } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

    " + "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    \n

    If there is no DB subnet group, then it is a non-VPC DB instance.

    " } }, - "DBInstanceClass": { + "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name for the master user.

    \n\n

    \n Amazon Aurora\n

    \n

    Not applicable. The name for the master user is managed by the DB cluster.\n

    \n\n

    \n MariaDB\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for MariaDB.

      \n
      • \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n \n

    \n Microsoft SQL Server\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for SQL Server.

      \n
      • \n
    • \n

      Must be 1 to 128 letters or numbers.

      \n
      • \n
    • \n

      The first character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n \n

    \n MySQL\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for MySQL.

      \n
      • \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n\n

    \n Oracle\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for Oracle.

      \n
      • \n
    • \n

      Must be 1 to 30 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n \n

    \n PostgreSQL\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for PostgreSQL.

      \n
      • \n
    • \n

      Must be 1 to 63 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    " } }, "VpcSecurityGroupIds": { @@ -2326,77 +2325,71 @@ "smithy.api#documentation": "

    A list of Amazon EC2 VPC security groups to associate with this DB instance.

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

    \n \n

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    " } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.

    " + "smithy.api#documentation": "

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

    \n

    Default: 1

    \n

    Valid Values: 0 - 15

    " } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The name of the database engine to be used for this instance.\n

    \n \n

    Not every database engine is available for every AWS Region.\n

    \n\n

    Valid Values:\n

    \n
      \n
    • \n

      \n aurora (for MySQL 5.6-compatible Aurora)

      \n
      • \n
    • \n

      \n aurora-mysql (for MySQL 5.7-compatible Aurora)

      \n
      • \n
    • \n

      \n aurora-postgresql\n

      \n
      • \n
    • \n

      \n mariadb\n

      \n
      • \n
    • \n

      \n mysql\n

      \n
      • \n
    • \n

      \n oracle-ee\n

      \n
      • \n
    • \n

      \n oracle-se2\n

      \n
      • \n
    • \n

      \n oracle-se1\n

      \n
      • \n
    • \n

      \n oracle-se\n

      \n
      • \n
    • \n

      \n postgres\n

      \n
      • \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. CloudWatch Logs exports are managed by the DB cluster.\n

    \n

    \n MariaDB\n

    \n

    Possible values are audit, error, general, and slowquery. \n

    \n

    \n Microsoft SQL Server\n

    \n

    Possible values are agent and error.\n

    \n

    \n MySQL\n

    \n

    Possible values are audit, error, general, and slowquery. \n

    \n

    \n Oracle\n

    \n

    Possible values are alert, audit, listener, and trace. \n

    \n

    \n PostgreSQL\n

    \n

    Possible values are postgresql and upgrade.\n

    " } }, - "DeletionProtection": { + "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "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

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.\n

    " + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n

    You can enable IAM database authentication for the following database engines:

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster.

    \n \n

    \n MySQL\n

    \n
      \n
    • \n

      For MySQL 5.6, minor version 5.6.34 or higher

      \n
      • \n
    • \n

      For MySQL 5.7, minor version 5.7.16 or higher

      \n
      • \n
    • \n

      For MySQL 8.0, minor version 8.0.16 or higher

      \n
      • \n
    \n \n

    \n PostgreSQL\n

    \n
      \n
    • \n

      For PostgreSQL 9.5, minor version 9.5.15 or higher

      \n
      • \n
    • \n

      For PostgreSQL 9.6, minor version 9.6.11 or higher

      \n
      • \n
    • \n

      PostgreSQL 10.6, 10.7, and 10.9

      \n
      • \n
    \n \n

    For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " } }, - "DBName": { + "MonitoringRoleArn": { "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

      Must contain 1 to 64 letters or numbers.

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \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

      Must contain 1 to 64 letters or numbers.

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \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

      Must contain 1 to 63 letters, numbers, or underscores.

      \n
      • \n
    • \n

      Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \n
    \n

    \n 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

      Can't be longer than 8 characters

      \n
      • \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
      \n
    • \n

      Must contain 1 to 64 letters or numbers.

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \n
    " - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " + "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

    \n

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

    " + "smithy.api#documentation": "

    The DB instance identifier. This parameter is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n

    Example: mydbinstance\n

    ", + "smithy.api#required": {} } }, - "MasterUsername": { + "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name for the master user.

    \n\n

    \n Amazon Aurora\n

    \n

    Not applicable. The name for the master user is managed by the DB cluster.\n

    \n\n

    \n MariaDB\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for MariaDB.

      \n
      • \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n \n

    \n Microsoft SQL Server\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for SQL Server.

      \n
      • \n
    • \n

      Must be 1 to 128 letters or numbers.

      \n
      • \n
    • \n

      The first character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n \n

    \n MySQL\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for MySQL.

      \n
      • \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n\n

    \n Oracle\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for Oracle.

      \n
      • \n
    • \n

      Must be 1 to 30 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    \n \n

    \n PostgreSQL\n

    \n

    Constraints:

    \n
      \n
    • \n

      Required for PostgreSQL.

      \n
      • \n
    • \n

      Must be 1 to 63 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    " + "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    \n If you specify io1, you must also include a value for the\n Iops parameter.\n

    \n

    \n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " } }, - "AvailabilityZone": { + "CharacterSetName": { "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": "

    For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for an encrypted DB instance.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

    \n \n

    If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default encryption key. AWS KMS creates the \n default encryption key for your AWS account. Your AWS account has a different\n default encryption key for each AWS Region.

    " + "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " } }, - "PreferredBackupWindow": { + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n For more information, see The Backup Window in the Amazon RDS User Guide.\n

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

    \n \n

    \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.\n

    \n \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " + "smithy.api#documentation": "

    Indicates that the DB instance should be associated with the specified option group.

    \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

    " } }, - "Timezone": { - "target": "com.amazonaws.rds#String", + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.\n

    " + "smithy.api#documentation": "

    The amount of storage (in gibibytes) to allocate for the DB instance.

    \n

    Type: Integer

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

    \n\n

    \n MySQL\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 5 to 3072.

      \n
      • \n
    \n \n

    \n MariaDB\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 5 to 3072.

      \n
      • \n
    \n \n

    \n PostgreSQL\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 5 to 3072.

      \n
      • \n
    \n \n

    \n Oracle\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 10 to 3072.

      \n
      • \n
    \n \n

    \n SQL Server\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2):

      \n
        \n
      • \n

        Enterprise and Standard editions: Must be an integer from 200 to 16384.

        \n
        • \n
      • \n

        Web and Express editions: Must be an integer from 20 to 16384.

        \n
        • \n
      \n
      • \n
    • \n

      Provisioned IOPS storage (io1):

      \n
        \n
      • \n

        Enterprise and Standard editions: Must be an integer from 200 to 16384.

        \n
        • \n
      • \n

        Web and Express editions: Must be an integer from 100 to 16384.

        \n
        • \n
      \n
      • \n
    • \n

      Magnetic storage (standard):

      \n
        \n
      • \n

        Enterprise and Standard editions: Must be an integer from 200 to 1024.

        \n
        • \n
      • \n

        Web and Express editions: Must be an integer from 20 to 1024.

        \n
        • \n
      \n
      • \n
    " } }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", + "Tags": { + "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable Performance Insights for the DB instance.\n

    \n

    For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

    " + "smithy.api#documentation": "

    Tags to assign to the DB instance.

    " } }, "PreferredMaintenanceWindow": { @@ -2411,100 +2404,101 @@ "smithy.api#documentation": "

    License model information for this DB instance.

    \n

    \n Valid values: license-included | bring-your-own-license | general-public-license\n

    " } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n

    \n

    Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. \n For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.\n

    " + "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " } }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    \n

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

    \n

    Valid Values: 0, 1, 5, 10, 15, 30, 60\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

      Must contain 1 to 64 letters or numbers.

      \n
      • \n
    • \n

      Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \n
    \n

    \n MariaDB\n

    \n

    The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain 1 to 64 letters or numbers.

      \n
      • \n
    • \n

      Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \n
    \n

    \n 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

      Must contain 1 to 63 letters, numbers, or underscores.

      \n
      • \n
    • \n

      Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \n
    \n

    \n 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

      Can't be longer than 8 characters

      \n
      • \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
      \n
    • \n

      Must contain 1 to 64 letters or numbers.

      \n
      • \n
    • \n

      Can't be a word reserved by the specified database engine

      \n
      • \n
    " } }, - "TdeCredentialPassword": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The password for the given ARN from the key store in order to access the device.

    " + "smithy.api#documentation": "

    The name of the database engine to be used for this instance.\n

    \n \n

    Not every database engine is available for every AWS Region.\n

    \n\n

    Valid Values:\n

    \n
      \n
    • \n

      \n aurora (for MySQL 5.6-compatible Aurora)

      \n
      • \n
    • \n

      \n aurora-mysql (for MySQL 5.7-compatible Aurora)

      \n
      • \n
    • \n

      \n aurora-postgresql\n

      \n
      • \n
    • \n

      \n mariadb\n

      \n
      • \n
    • \n

      \n mysql\n

      \n
      • \n
    • \n

      \n oracle-ee\n

      \n
      • \n
    • \n

      \n oracle-se2\n

      \n
      • \n
    • \n

      \n oracle-se1\n

      \n
      • \n
    • \n

      \n oracle-se\n

      \n
      • \n
    • \n

      \n postgres\n

      \n
      • \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    " + "smithy.api#documentation": "

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.\n

    \n

    Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. \n For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.\n

    " } }, - "Domain": { + "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle \n DB instances can be created in an Active Directory Domain.

    \n

    For Microsoft SQL Server DB instances, Amazon RDS can use \n Windows Authentication to authenticate users that connect to the DB instance. For more\n information, see \n Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the \n Amazon RDS User Guide.

    \n

    For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate\n users that connect to the DB instance. For more information, see Using\n Kerberos Authentication with Amazon RDS for Oracle in the Amazon\n RDS User Guide.

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS\n encryption key.

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n

    You can enable IAM database authentication for the following database engines:

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster.

    \n \n

    \n MySQL\n

    \n
      \n
    • \n

      For MySQL 5.6, minor version 5.6.34 or higher

      \n
      • \n
    • \n

      For MySQL 5.7, minor version 5.7.16 or higher

      \n
      • \n
    • \n

      For MySQL 8.0, minor version 8.0.16 or higher

      \n
      • \n
    \n \n

    \n PostgreSQL\n

    \n
      \n
    • \n

      For PostgreSQL 9.5, minor version 9.5.15 or higher

      \n
      • \n
    • \n

      For PostgreSQL 9.6, minor version 9.6.11 or higher

      \n
      • \n
    • \n

      PostgreSQL 10.6, 10.7, and 10.9

      \n
      • \n
    \n \n

    For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " } }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

    \n

    Default: 1

    \n

    Valid Values: 0 - 15

    " + "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " } }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + "smithy.api#documentation": "

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The retention period for automated backups is managed by the DB\n cluster.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 0 to 35

      \n
      • \n
    • \n

      Can't be set to 0 if the DB instance is a source to read replicas

      \n
      • \n
    " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " + "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " } }, - "MonitoringRoleArn": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

    \n

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " + "smithy.api#documentation": "

    The identifier of the DB cluster that the instance will belong to.

    " } }, - "Tags": { - "target": "com.amazonaws.rds#TagList", + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

    Tags to assign to the DB instance.

    " + "smithy.api#documentation": "

    A list of DB security groups to associate with this DB instance.

    \n

    Default: The default DB security group for the database engine.

    " } }, - "PubliclyAccessible": { + "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

    \n

    If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

    \n
      \n
    • \n

      If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

      \n
      • \n
    • \n

      If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

      \n
      • \n
    \n

    If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

    \n
      \n
    • \n

      If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

      \n
      • \n
    • \n

      If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

      \n
      • \n
    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The encryption for DB instances is managed by\n the DB cluster.

    " } }, - "MasterUserPassword": { + "Timezone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n\n

    \n Amazon Aurora\n

    \n

    Not applicable. The password for the master user is managed by the DB\n cluster.

    \n\n

    \n MariaDB\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n\n

    \n Microsoft SQL Server\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    \n \n

    \n MySQL\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n\n

    \n Oracle\n

    \n

    Constraints: Must contain from 8 to 30 characters.

    \n\n

    \n PostgreSQL\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    " + "smithy.api#documentation": "

    The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.\n

    " } }, - "PerformanceInsightsKMSKeyId": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS\n encryption key.

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " + "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    For a list of valid engine versions, use the DescribeDBEngineVersions action.

    \n

    The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every AWS Region.

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

    \n \n

    \n MariaDB\n

    \n\n

    See MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

    \n \n

    \n Microsoft SQL Server\n

    \n \n

    See Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n

    \n \n

    \n MySQL\n

    \n\n

    See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

    \n \n

    \n Oracle\n

    \n \n

    See Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n

    \n\n

    \n PostgreSQL\n

    \n\n

    See Supported PostgreSQL Database Versions in the \n Amazon RDS User Guide.\n

    " } }, - "DomainIAMRoleName": { + "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n\n

    \n Amazon Aurora\n

    \n

    Not applicable. The password for the master user is managed by the DB\n cluster.

    \n\n

    \n MariaDB\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n\n

    \n Microsoft SQL Server\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    \n \n

    \n MySQL\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n\n

    \n Oracle\n

    \n

    Constraints: Must contain from 8 to 30 characters.

    \n\n

    \n PostgreSQL\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    " } }, - "TdeCredentialArn": { + "NcharCharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + "smithy.api#documentation": "

    The name of the NCHAR character set for the Oracle DB instance.

    " } }, "Port": { @@ -2513,65 +2507,77 @@ "smithy.api#documentation": "

    The port number on which the database accepts connections.

    \n

    \n MySQL\n

    \n

    \n Default: 3306\n

    \n

    Valid values: 1150-65535\n

    \n

    Type: Integer

    \n

    \n MariaDB\n

    \n

    \n Default: 3306\n

    \n

    Valid values: 1150-65535\n

    \n

    Type: Integer

    \n

    \n PostgreSQL\n

    \n

    \n Default: 5432\n

    \n

    Valid values: 1150-65535\n

    \n

    Type: Integer

    \n

    \n Oracle\n

    \n

    \n Default: 1521\n

    \n

    Valid values: 1150-65535\n

    \n

    \n SQL Server\n

    \n

    \n Default: 1433\n

    \n

    Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

    \n

    \n Amazon Aurora\n

    \n

    \n Default: 3306\n

    \n

    Valid values: 1150-65535\n

    \n

    Type: Integer

    " } }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Indicates that the DB instance should be associated with the specified option group.

    \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

    \n

    If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

    \n
      \n
    • \n

      If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

      \n
      • \n
    • \n

      If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

      \n
      • \n
    \n

    If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

    \n
      \n
    • \n

      If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

      \n
      • \n
    • \n

      If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

      \n
      • \n
    " } }, - "DBClusterIdentifier": { + "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the DB cluster that the instance will belong to.

    " + "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    " } }, - "CharacterSetName": { + "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

    " + "smithy.api#documentation": "

    The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

    \n

    For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

    " } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The retention period for automated backups is managed by the DB\n cluster.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 0 to 35

      \n
      • \n
    • \n

      Can't be set to 0 if the DB instance is a source to read replicas

      \n
      • \n
    " + "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

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.\n

    " } }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The encryption for DB instances is managed by\n the DB cluster.

    " + "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     " } }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", + "KmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for an encrypted DB instance.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

    \n \n

    If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default encryption key. AWS KMS creates the \n default encryption key for your AWS account. Your AWS account has a different\n default encryption key for each AWS Region.

    " } }, - "EngineVersion": { + "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    For a list of valid engine versions, use the DescribeDBEngineVersions action.

    \n

    The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every AWS Region.

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

    \n \n

    \n MariaDB\n

    \n\n

    See MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

    \n \n

    \n Microsoft SQL Server\n

    \n \n

    See Version and Feature Support on Amazon RDS in the \n Amazon RDS User Guide.\n

    \n \n

    \n MySQL\n

    \n\n

    See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

    \n \n

    \n Oracle\n

    \n \n

    See Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n

    \n\n

    \n PostgreSQL\n

    \n\n

    See Supported PostgreSQL Database Versions in the \n Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    The compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    ", + "smithy.api#required": {} } }, - "StorageType": { - "target": "com.amazonaws.rds#String", + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    \n If you specify io1, you must also include a value for the\n Iops parameter.\n

    \n

    \n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " } }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The amount of storage (in gibibytes) to allocate for the DB instance.

    \n

    Type: Integer

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

    \n\n

    \n MySQL\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 5 to 3072.

      \n
      • \n
    \n \n

    \n MariaDB\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 5 to 3072.

      \n
      • \n
    \n \n

    \n PostgreSQL\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 5 to 3072.

      \n
      • \n
    \n \n

    \n Oracle\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

      \n
      • \n
    • \n

      Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      \n
      • \n
    • \n

      Magnetic storage (standard): Must be an integer from 10 to 3072.

      \n
      • \n
    \n \n

    \n SQL Server\n

    \n

    Constraints to the amount of storage for each storage type are the following:\n

    \n
      \n
    • \n

      General Purpose (SSD) storage (gp2):

      \n
        \n
      • \n

        Enterprise and Standard editions: Must be an integer from 200 to 16384.

        \n
        • \n
      • \n

        Web and Express editions: Must be an integer from 20 to 16384.

        \n
        • \n
      \n
      • \n
    • \n

      Provisioned IOPS storage (io1):

      \n
        \n
      • \n

        Enterprise and Standard editions: Must be an integer from 200 to 16384.

        \n
        • \n
      • \n

        Web and Express editions: Must be an integer from 100 to 16384.

        \n
        • \n
      \n
      • \n
    • \n

      Magnetic storage (standard):

      \n
        \n
      • \n

        Enterprise and Standard editions: Must be an integer from 200 to 1024.

        \n
        • \n
      • \n

        Web and Express editions: Must be an integer from 20 to 1024.

        \n
        • \n
      \n
      • \n
    " + "smithy.api#documentation": "

    A value that indicates whether to enable Performance Insights for the DB instance.\n

    \n

    For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

    " } }, - "DBInstanceIdentifier": { + "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB instance identifier. This parameter is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n

    Example: mydbinstance\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The password for the given ARN from the key store in order to access the device.

    " + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

    " + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    \n

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

    \n

    Valid Values: 0, 1, 5, 10, 15, 30, 60\n

    " } } }, @@ -2653,22 +2659,16 @@ "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { "type": "structure", "members": { - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.

    " - } - }, - "PreSignedUrl": { + "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source AWS Region that contains the source DB instance.\n

    \n \n

    You must specify this parameter when you create an encrypted read replica from\n another AWS Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same AWS Region.

    \n \n

    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source AWS Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n

    \n \n
      \n
    • \n

      \n DestinationRegion - The AWS Region that the encrypted read\n replica is created in. This AWS Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.

      \n \n

      For example, if you create an encrypted DB instance in the us-west-1 AWS Region,\n from a source DB instance in the us-east-2 AWS Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 AWS Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 AWS Region.\n

      \n
      • \n
    • \n

      \n KmsKeyId - The AWS KMS key identifier for the key to use to\n encrypt the read replica in the destination AWS Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination AWS Region, and the action contained in the presigned\n URL.

      \n
      • \n
    • \n

      \n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source AWS Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 AWS\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

      \n
      • \n
    \n \n

    To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n Signature Version 4 Signing Process.\n

    \n \n \n

    If you are using an AWS SDK tool or the AWS CLI, you can specify\n SourceRegion (or --source-region for the AWS CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source AWS Region.

    \n

    \n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.

    \n     " + "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

    \n

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

    A list of EC2 VPC security groups to associate with the read replica.

    \n

    \n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

    " + "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " } }, "UseDefaultProcessorFeatures": { @@ -2677,79 +2677,72 @@ "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

    " } }, - "MonitoringRoleArn": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

    \n

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " + "smithy.api#documentation": "

    The DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.

    ", + "smithy.api#required": {} } }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", + "Domain": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable Performance Insights for the read replica.

    \n

    For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

    \n

    For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

    " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the read replica is in a Multi-AZ deployment.

    \n \n

    You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.

    " + "smithy.api#documentation": "

    The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " } }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

    \n

    Constraints:

    \n
      \n
    • \n

      Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

      \n
      • \n
    • \n

      If supplied, must match the name of an existing DBSubnetGroup.

      \n
      • \n
    • \n

      The specified DB subnet group must be in the same AWS Region in which the operation is running.

      \n
      • \n
    • \n

      All read replicas in one AWS Region that are created from the same source DB\n instance must either:>

      \n
        \n
      • \n

        Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

        \n
        • \n
      • \n

        Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

        \n
        • \n
      \n
      • \n
    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " } }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The compute and memory capacity of the read replica, for example,\n db.m4.large. Not all DB instance classes are available in all AWS\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n

    \n

    Default: Inherits from the source DB instance.

    " + "smithy.api#documentation": "

    The port number that the DB instance uses for connections.

    \n

    Default: Inherits from the source DB instance

    \n

    Valid Values: 1150-65535\n

    " } }, - "AutoMinorVersionUpgrade": { + "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

    \n

    Default: Inherits from the source DB instance

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " } }, - "DBParameterGroupName": { + "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross region read replica.

    \n \n

    Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

    \n     \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    " - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

    \n

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

    \n

    Valid Values: 0, 1, 5, 10, 15, 30, 60\n

    " + "smithy.api#documentation": "

    Specifies the storage type to be associated with the read replica.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    \n If you specify io1, you must also include a value for the\n Iops parameter.\n

    \n

    \n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " } }, - "Iops": { + "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    " + "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " } }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", + "SourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " + "smithy.api#documentation": "

    The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.

      \n
      • \n
    • \n

      Can specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.

      \n
      • \n
    • \n

      For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.

      \n
      • \n
    • \n

      For the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

      \n
      • \n
    • \n

      Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-region replication).

      \n
      • \n
    • \n

      The specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.

      \n
      • \n
    • \n

      If the source DB instance is in the same AWS Region as the read replica, specify a valid DB\n instance identifier.

      \n
      • \n
    • \n

      If the source DB instance is in a different AWS Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

    \n \n

    For SQL Server, you must use the option group associated with the source\n instance.

    \n     " } }, - "AvailabilityZone": { + "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Availability Zone (AZ) where the read replica will be created.

    \n

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

    \n

    \n Example: us-east-1d\n

    " + "smithy.api#documentation": "

    Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

    \n

    Constraints:

    \n
      \n
    • \n

      Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

      \n
      • \n
    • \n

      If supplied, must match the name of an existing DBSubnetGroup.

      \n
      • \n
    • \n

      The specified DB subnet group must be in the same AWS Region in which the operation is running.

      \n
      • \n
    • \n

      All read replicas in one AWS Region that are created from the same source DB\n instance must either:>

      \n
        \n
      • \n

        Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

        \n
        • \n
      • \n

        Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

        \n
        • \n
      \n
      • \n
    \n

    Example: mySubnetgroup\n

    " } }, "DeletionProtection": { @@ -2764,16 +2757,37 @@ "smithy.api#documentation": "

    The AWS KMS key ID for an encrypted read replica. The KMS key ID is the Amazon\n Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    \n \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 KMS key as the source DB instance.

    \n \n

    If you create an encrypted read replica in a different AWS Region, then you must\n specify a KMS key for the destination AWS Region. KMS encryption keys are specific to\n the AWS Region that they are created in, and you can't use encryption keys from one\n AWS Region in another AWS Region.

    \n \n

    You can't create an encrypted read replica from an unencrypted DB instance.

    " } }, - "EnableIAMDatabaseAuthentication": { + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The Availability Zone (AZ) where the read replica will be created.

    \n

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

    \n

    \n Example: us-east-1d\n

    " + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

    \n

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

    \n

    Valid Values: 0, 1, 5, 10, 15, 30, 60\n

    " + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

    A list of EC2 VPC security groups to associate with the read replica.

    \n

    \n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

    " + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

    \n

    Default: Inherits from the source DB instance

    " } }, - "PerformanceInsightsKMSKeyId": { + "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " + "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross region read replica.

    \n \n

    Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

    \n     \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    " } }, "DomainIAMRoleName": { @@ -2782,54 +2796,52 @@ "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " } }, - "Domain": { - "target": "com.amazonaws.rds#String", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The Active Directory directory ID to create the DB instance in.

    \n

    For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. \n For more information, see \n Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    \n

    For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to\n authenticate users that connect to the DB instance. For more information, see \n Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL\n Server in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    " } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    A value that indicates whether to enable Performance Insights for the read replica.

    \n

    For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.\n

    " } }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + "smithy.api#documentation": "

    The open mode of the replica database: mounted or read-only.

    \n \n

    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 Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

    \n

    You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

    " } }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " } }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The port number that the DB instance uses for connections.

    \n

    Default: Inherits from the source DB instance

    \n

    Valid Values: 1150-65535\n

    " + "smithy.api#documentation": "

    A value that indicates whether the read replica is in a Multi-AZ deployment.

    \n \n

    You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.

    " } }, - "StorageType": { + "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the storage type to be associated with the read replica.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    \n If you specify io1, you must also include a value for the\n Iops parameter.\n

    \n

    \n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " + "smithy.api#documentation": "

    The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source AWS Region that contains the source DB instance.\n

    \n \n

    You must specify this parameter when you create an encrypted read replica from\n another AWS Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same AWS Region.

    \n \n

    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source AWS Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n

    \n \n
      \n
    • \n

      \n DestinationRegion - The AWS Region that the encrypted read\n replica is created in. This AWS Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.

      \n \n

      For example, if you create an encrypted DB instance in the us-west-1 AWS Region,\n from a source DB instance in the us-east-2 AWS Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 AWS Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 AWS Region.\n

      \n
      • \n
    • \n

      \n KmsKeyId - The AWS KMS key identifier for the key to use to\n encrypt the read replica in the destination AWS Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination AWS Region, and the action contained in the presigned\n URL.

      \n
      • \n
    • \n

      \n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source AWS Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 AWS\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

      \n
      • \n
    \n \n

    To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n Signature Version 4 Signing Process.\n

    \n \n \n

    If you are using an AWS SDK tool or the AWS CLI, you can specify\n SourceRegion (or --source-region for the AWS CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source AWS Region.

    \n

    \n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.

    \n     " } }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.

    " } }, - "SourceDBInstanceIdentifier": { + "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.

      \n
      • \n
    • \n

      Can specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.

      \n
      • \n
    • \n

      For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.

      \n
      • \n
    • \n

      For the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

      \n
      • \n
    • \n

      Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-region replication).

      \n
      • \n
    • \n

      The specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.

      \n
      • \n
    • \n

      If the source DB instance is in the same AWS Region as the read replica, specify a valid DB\n instance identifier.

      \n
      • \n
    • \n

      If the source DB instance is in a different AWS Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The compute and memory capacity of the read replica, for example,\n db.m4.large. Not all DB instance classes are available in all AWS\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n

    \n

    Default: Inherits from the source DB instance.

    " } } } @@ -2873,23 +2885,16 @@ "com.amazonaws.rds#CreateDBParameterGroupMessage": { "type": "structure", "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

    \n

    To list all of the available parameter group families, use the following command:

    \n

    \n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"\n

    \n \n

    The output contains duplicates.

    \n     ", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "

    Tags to assign to the DB parameter group.

    " } }, - "DBParameterGroupName": { + "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n \n

    This value is stored as a lowercase string.

    \n     ", + "smithy.api#documentation": "

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

    \n

    To list all of the available parameter group families, use the following command:

    \n

    \n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"\n

    \n \n

    The output contains duplicates.

    \n     ", "smithy.api#required": {} } }, @@ -2899,6 +2904,13 @@ "smithy.api#documentation": "

    The description for the DB parameter group.

    ", "smithy.api#required": {} } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the DB parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n \n

    This value is stored as a lowercase string.

    \n     ", + "smithy.api#required": {} + } } }, "traits": { @@ -2939,17 +2951,16 @@ "com.amazonaws.rds#CreateDBProxyRequest": { "type": "structure", "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

    " } }, - "RoleArn": { - "target": "com.amazonaws.rds#String", + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

    ", + "smithy.api#documentation": "

    One or more VPC subnet IDs to associate with the new proxy.

    ", "smithy.api#required": {} } }, @@ -2959,23 +2970,17 @@ "smithy.api#documentation": "

    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

    " } }, - "VpcSubnetIds": { + "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    One or more VPC subnet IDs to associate with the new proxy.

    ", - "smithy.api#required": {} - } - }, - "RequireTLS": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

    " + "smithy.api#documentation": "

    One or more VPC security group IDs to associate with the new proxy.

    " } }, - "Tags": { - "target": "com.amazonaws.rds#TagList", + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", "traits": { - "smithy.api#documentation": "

    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

    " + "smithy.api#documentation": "

    The authorization mechanism that the proxy uses.

    ", + "smithy.api#required": {} } }, "EngineFamily": { @@ -2985,23 +2990,30 @@ "smithy.api#required": {} } }, - "DebugLogging": { + "RequireTLS": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

    " + "smithy.api#documentation": "

    A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

    " } }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigList", + "RoleArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The authorization mechanism that the proxy uses.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

    ", "smithy.api#required": {} } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", + "DBProxyName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    One or more VPC security group IDs to associate with the new proxy.

    " + "smithy.api#documentation": "

    The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

    " } } } @@ -3043,10 +3055,11 @@ "com.amazonaws.rds#CreateDBSecurityGroupMessage": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.rds#TagList", + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Tags to assign to the DB security group.

    " + "smithy.api#documentation": "

    The name for the DB security group. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    • \n

      Must not be \"Default\"

      \n
      • \n
    \n

    Example: mysecuritygroup\n

    ", + "smithy.api#required": {} } }, "DBSecurityGroupDescription": { @@ -3056,11 +3069,10 @@ "smithy.api#required": {} } }, - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", + "Tags": { + "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

    The name for the DB security group. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    • \n

      Must not be \"Default\"

      \n
      • \n
    \n

    Example: mysecuritygroup\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Tags to assign to the DB security group.

    " } } }, @@ -3099,7 +3111,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

    " + "smithy.api#documentation": "

    Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimizationstate.

    " } }, "com.amazonaws.rds#CreateDBSnapshotMessage": { @@ -3167,10 +3179,10 @@ "com.amazonaws.rds#CreateDBSubnetGroupMessage": { "type": "structure", "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", + "SubnetIds": { + "target": "com.amazonaws.rds#SubnetIdentifierList", "traits": { - "smithy.api#documentation": "

    The name for the DB subnet group. This value is stored as a lowercase string.

    \n

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    \n

    Example: mySubnetgroup\n

    ", + "smithy.api#documentation": "

    The EC2 Subnet IDs for the DB subnet group.

    ", "smithy.api#required": {} } }, @@ -3181,18 +3193,18 @@ "smithy.api#required": {} } }, - "SubnetIds": { - "target": "com.amazonaws.rds#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

    The EC2 Subnet IDs for the DB subnet group.

    ", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.rds#TagList", "traits": { "smithy.api#documentation": "

    Tags to assign to the DB subnet group.

    " } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name for the DB subnet group. This value is stored as a lowercase string.

    \n

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    \n

    Example: mySubnetgroup\n

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -3239,18 +3251,37 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an RDS event notification subscription. This action requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

    \n

    You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources \n (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to \n be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and \n EventCategories = Availability, Backup.

    \n\n

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify a SourceIdentifier,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIdentifier, you are notified of events\n generated from all RDS sources belonging to your customer account.

    \n \n

    RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.

    \n     " + "smithy.api#documentation": "

    Creates an RDS event notification subscription. This action requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

    \n

    You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

    \n\n

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify a SourceIdentifier,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIdentifier, you are notified of events\n generated from all RDS sources belonging to your customer account.

    \n \n

    RDS event notification is only available for unencrypted SNS topics. If you specify an \n encrypted SNS topic, event notifications aren't sent for the topic.

    \n     " } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { "type": "structure", "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the subscription.

    \n

    Constraints: The name must be less than 255 characters.

    ", + "smithy.api#required": {} + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

    A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source\n type in Events in the\n Amazon RDS User Guide or by using the DescribeEventCategories operation.

    " + } + }, "Enabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "

    \n A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.\n

    " } }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. If this value isn't specified, all events are\n returned.

    \n

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot \n

    " + } + }, "SnsTopicArn": { "target": "com.amazonaws.rds#String", "traits": { @@ -3261,30 +3292,11 @@ "SourceIds": { "target": "com.amazonaws.rds#SourceIdsList", "traits": { - "smithy.api#documentation": "

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

    \n

    Constraints:

    \n
      \n
    • \n

      If SourceIds are supplied, SourceType must also be provided.

      \n
      • \n
    • \n

      If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB security group, a DBSecurityGroupName must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

      \n
      • \n
    " + "smithy.api#documentation": "

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

    \n

    Constraints:

    \n
      \n
    • \n

      If a SourceIds value is supplied, SourceType must also be provided.

      \n
      • \n
    • \n

      If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

      \n
      • \n
    " } }, "Tags": { "target": "com.amazonaws.rds#TagList" - }, - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the subscription.

    \n

    Constraints: The name must be less than 255 characters.

    ", - "smithy.api#required": {} - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

    \n A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories \n for a given SourceType \n in the Events topic \n in the Amazon RDS User Guide \n or by using the DescribeEventCategories action.\n

    " - } - }, - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The type of source that is generating the events. For example, if you want to be notified of \n events generated by a DB instance, you would set this parameter to db-instance. if this value isn't specified, all events are returned.

    \n

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot \n

    " - } } }, "traits": { @@ -3322,52 +3334,52 @@ } ], "traits": { - "smithy.api#documentation": "

    \n Creates an Aurora global database\n spread across multiple regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.\n

    \n

    \n You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.\n

    \n \n

    This action only applies to Aurora DB clusters.

    \n     " + "smithy.api#documentation": "

    \n Creates an Aurora global database\n spread across multiple AWS Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.\n

    \n

    \n You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.\n

    \n \n

    This action only applies to Aurora DB clusters.

    \n     " } }, "com.amazonaws.rds#CreateGlobalClusterMessage": { "type": "structure", "members": { - "DatabaseName": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon\n Aurora will not create a database in the global database cluster you are creating.\n

    " + "smithy.api#documentation": "

    The engine version of the Aurora global database.

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    \n The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is enabled.\n

    " + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The cluster identifier of the new global database cluster.

    " } }, - "Engine": { + "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the name of the database engine to be used for this DB cluster.

    " + "smithy.api#documentation": "

    \n The Amazon Resource Name (ARN) to use as the primary cluster of the global database.\n This parameter is optional.\n

    " } }, - "StorageEncrypted": { + "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    \n The storage encryption setting for the new global database cluster.\n

    " + "smithy.api#documentation": "

    \n The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is enabled.\n

    " } }, - "EngineVersion": { + "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The engine version of the Aurora global database.

    " + "smithy.api#documentation": "

    \n The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon\n Aurora will not create a database in the global database cluster you are creating.\n

    " } }, - "SourceDBClusterIdentifier": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The Amazon Resource Name (ARN) to use as the primary cluster of the global database.\n This parameter is optional.\n

    " + "smithy.api#documentation": "

    The name of the database engine to be used for this DB cluster.

    " } }, - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The cluster identifier of the new global database cluster.

    " + "smithy.api#documentation": "

    \n The storage encryption setting for the new global database cluster.\n

    " } } } @@ -3403,10 +3415,16 @@ "com.amazonaws.rds#CreateOptionGroupMessage": { "type": "structure", "members": { - "OptionGroupName": { + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

    Tags to assign to the option group.

    " + } + }, + "MajorEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the option group to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: myoptiongroup\n

    ", + "smithy.api#documentation": "

    Specifies the major version of the engine that this option group should be associated with.

    ", "smithy.api#required": {} } }, @@ -3417,23 +3435,17 @@ "smithy.api#required": {} } }, - "OptionGroupDescription": { + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The description of the option group.

    ", + "smithy.api#documentation": "

    Specifies the name of the option group to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: myoptiongroup\n

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

    Tags to assign to the option group.

    " - } - }, - "MajorEngineVersion": { + "OptionGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the major version of the engine that this option group should be associated with.

    ", + "smithy.api#documentation": "

    The description of the option group.

    ", "smithy.api#required": {} } } @@ -3453,28 +3465,28 @@ "com.amazonaws.rds#CustomAvailabilityZone": { "type": "structure", "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", + "VpnDetails": { + "target": "com.amazonaws.rds#VpnDetails", "traits": { - "smithy.api#documentation": "

    The identifier of the custom AZ.

    \n

    Amazon RDS generates a unique identifier when a custom AZ is created.

    " + "smithy.api#documentation": "

    Information about the virtual private network (VPN) between the VMware vSphere cluster\n and the AWS website.

    " } }, - "CustomAvailabilityZoneName": { + "CustomAvailabilityZoneStatus": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the custom AZ.

    " + "smithy.api#documentation": "

    The status of the custom AZ.

    " } }, - "VpnDetails": { - "target": "com.amazonaws.rds#VpnDetails", + "CustomAvailabilityZoneName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Information about the virtual private network (VPN) between the VMware vSphere cluster\n and the AWS website.

    " + "smithy.api#documentation": "

    The name of the custom AZ.

    " } }, - "CustomAvailabilityZoneStatus": { + "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of the custom AZ.

    " + "smithy.api#documentation": "

    The identifier of the custom AZ.

    \n

    Amazon RDS generates a unique identifier when a custom AZ is created.

    " } } }, @@ -3550,100 +3562,73 @@ "com.amazonaws.rds#DBCluster": { "type": "structure", "members": { - "VpcSecurityGroups": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

    Provides a list of VPC security groups that the DB cluster belongs to.

    " - } - }, - "ReplicationSourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    Contains the identifier of the source DB cluster if this DB cluster is a read\n replica.

    " - } - }, - "ActivityStreamKmsKeyId": { + "DBClusterArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier used for encrypting messages in the database activity stream.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB cluster.

    " } }, - "Capacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

    \n

    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.

    " - } + "TagList": { + "target": "com.amazonaws.rds#TagList" }, - "Endpoint": { + "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the connection endpoint for the primary instance of the DB cluster.

    " - } - }, - "EarliestBacktrackTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

    The earliest time to which a DB cluster can be backtracked.

    " + "smithy.api#documentation": "

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    " } }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", + "PercentProgress": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

    " + "smithy.api#documentation": "

    Specifies the progress of the operation as a percentage.

    " } }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Specifies whether the DB cluster is encrypted.

    " + "smithy.api#documentation": "

    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

    " } }, - "KmsKeyId": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

    " - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    Specifies the port that the database engine is listening on.

    " + "smithy.api#documentation": "

    Indicates the database engine version.

    " } }, - "HttpEndpointEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

    \n

    When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

    \n

    For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n

    " } }, - "DBClusterMembers": { - "target": "com.amazonaws.rds#DBClusterMemberList", + "CustomEndpoints": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    Provides the list of instances that make up the DB cluster.

    " + "smithy.api#documentation": "

    Identifies all custom endpoints associated with the cluster.

    " } }, - "DbClusterResourceId": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

    " + "smithy.api#documentation": "

    The name of the database engine to be used for this DB cluster.

    " } }, - "DomainMemberships": { - "target": "com.amazonaws.rds#DomainMembershipList", + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The Active Directory Domain membership records associated with the DB cluster.

    " + "smithy.api#documentation": "

    Specifies the latest time to which a database can be restored with point-in-time restore.

    " } }, - "ReaderEndpoint": { - "target": "com.amazonaws.rds#String", + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBClusterRoles", "traits": { - "smithy.api#documentation": "

    The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

    \n

    If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

    " + "smithy.api#documentation": "

    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services\n on your behalf.

    " } }, - "EngineMode": { - "target": "com.amazonaws.rds#String", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

    \n \n

    \n global engine mode only applies for global database clusters created with Aurora MySQL version\n 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned\n engine mode. To check if a DB cluster is part of a global database, use DescribeGlobalClusters\n instead of checking the EngineMode return value from DescribeDBClusters.\n

    \n     " + "smithy.api#documentation": "

    Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

    " } }, "BackupRetentionPeriod": { @@ -3652,73 +3637,70 @@ "smithy.api#documentation": "

    Specifies the number of days for which automatic DB snapshots are retained.

    " } }, - "EarliestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The earliest time to which a database can be restored with point-in-time\n restore.

    " + "smithy.api#documentation": "

    Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

    " } }, - "ActivityStreamStatus": { - "target": "com.amazonaws.rds#ActivityStreamStatus", + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The status of the database activity stream.

    " + "smithy.api#documentation": "

    A list of log types that this DB cluster is configured to export to CloudWatch Logs.

    \n

    Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

    " } }, - "CrossAccountClone": { + "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

    " + "smithy.api#documentation": "

    A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

    " } }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", + "GlobalWriteForwardingRequested": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

    " + "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.

    " } }, - "MasterUsername": { + "HostedZoneId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains the master username for the DB cluster.

    " + "smithy.api#documentation": "

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " } }, - "ScalingConfigurationInfo": { - "target": "com.amazonaws.rds#ScalingConfigurationInfo" - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", + "EarliestBacktrackTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n

    " + "smithy.api#documentation": "

    The earliest time to which a DB cluster can be backtracked.

    " } }, - "DBClusterParameterGroup": { - "target": "com.amazonaws.rds#String", + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

    Specifies the name of the DB cluster parameter group for the DB cluster.

    " + "smithy.api#documentation": "

    Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

    " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { - "smithy.api#documentation": "

    Specifies whether the DB cluster has instances in multiple Availability Zones.

    " + "smithy.api#documentation": "

    Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

    " } }, - "AssociatedRoles": { - "target": "com.amazonaws.rds#DBClusterRoles", + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services\n on your behalf.

    " + "smithy.api#documentation": "

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    " } }, - "LatestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", + "DBClusterOptionGroupMemberships": { + "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", "traits": { - "smithy.api#documentation": "

    Specifies the latest time to which a database can be restored with point-in-time restore.

    " + "smithy.api#documentation": "

    Provides the list of option group memberships for this DB cluster.

    " } }, - "CustomEndpoints": { - "target": "com.amazonaws.rds#StringList", + "EarliestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    Identifies all custom endpoints associated with the cluster.

    " + "smithy.api#documentation": "

    The earliest time to which a database can be restored with point-in-time\n restore.

    " } }, "ReadReplicaIdentifiers": { @@ -3733,76 +3715,85 @@ "smithy.api#documentation": "

    The number of change records stored for Backtrack.

    " } }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    " + "smithy.api#documentation": "

    Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n

    " } }, - "CharacterSetName": { + "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If present, specifies the name of the character set that this cluster is associated with.

    " + "smithy.api#documentation": "

    If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

    " } }, - "PercentProgress": { + "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the progress of the operation as a percentage.

    " + "smithy.api#documentation": "

    Specifies the connection endpoint for the primary instance of the DB cluster.

    " } }, - "ActivityStreamMode": { - "target": "com.amazonaws.rds#ActivityStreamMode", + "CrossAccountClone": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n

    " + "smithy.api#documentation": "

    Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

    " } }, - "AllocatedStorage": { + "Capacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

    " + "smithy.api#documentation": "

    The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

    \n

    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the \n Amazon Aurora User Guide.

    " } }, - "EngineVersion": { + "DBSubnetGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates the database engine version.

    " + "smithy.api#documentation": "

    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

    " } }, - "Status": { - "target": "com.amazonaws.rds#String", + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

    Specifies the current state of this DB cluster.

    " + "smithy.api#documentation": "

    Provides a list of VPC security groups that the DB cluster belongs to.

    " } }, - "CloneGroupId": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Identifies the clone group to which the DB cluster is associated.

    " + "smithy.api#documentation": "

    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    " } }, - "ClusterCreateTime": { - "target": "com.amazonaws.rds#TStamp", + "ReaderEndpoint": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    " + "smithy.api#documentation": "

    The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

    \n

    If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

    " } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "ScalingConfigurationInfo": { + "target": "com.amazonaws.rds#ScalingConfigurationInfo" + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Provides the name of the database engine to be used for this DB cluster.

    " + "smithy.api#documentation": "

    Specifies whether the DB cluster has instances in multiple Availability Zones.

    " } }, - "GlobalWriteForwardingStatus": { - "target": "com.amazonaws.rds#WriteForwardingStatus", + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

    " + "smithy.api#documentation": "

    The AWS KMS key identifier used for encrypting messages in the database activity stream.

    " } }, - "HostedZoneId": { + "ReplicationSourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " + "smithy.api#documentation": "

    Contains the identifier of the source DB cluster if this DB cluster is a read\n replica.

    " + } + }, + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", + "traits": { + "smithy.api#documentation": "

    The Active Directory Domain membership records associated with the DB cluster.

    " } }, "ActivityStreamKinesisStreamName": { @@ -3811,10 +3802,16 @@ "smithy.api#documentation": "

    The name of the Amazon Kinesis data stream used for the database activity stream.

    " } }, - "PreferredBackupWindow": { + "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

    " + "smithy.api#documentation": "

    Contains the master username for the DB cluster.

    " + } + }, + "CloneGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Identifies the clone group to which the DB cluster is associated.

    " } }, "DBClusterIdentifier": { @@ -3823,52 +3820,70 @@ "smithy.api#documentation": "

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    " } }, - "DBClusterOptionGroupMemberships": { - "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Provides the list of option group memberships for this DB cluster.

    " + "smithy.api#documentation": "

    Specifies the port that the database engine is listening on.

    " } }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", + "CharacterSetName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

    " + "smithy.api#documentation": "

    If present, specifies the name of the character set that this cluster is associated with.

    " } }, - "DBClusterArn": { + "HttpEndpointEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

    \n

    When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

    \n

    For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

    " + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the DB cluster is encrypted.

    " + } + }, + "DBClusterParameterGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB cluster.

    " + "smithy.api#documentation": "

    Specifies the name of the DB cluster parameter group for the DB cluster.

    " } }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of log types that this DB cluster is configured to export to CloudWatch Logs.

    \n

    Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

    " } }, - "PreferredMaintenanceWindow": { + "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    " + "smithy.api#documentation": "

    The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

    \n

    For more information, see \n CreateDBCluster.

    " } }, - "DBSubnetGroup": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

    " + "smithy.api#documentation": "

    Specifies the current state of this DB cluster.

    " } }, - "GlobalWriteForwardingRequested": { - "target": "com.amazonaws.rds#BooleanOptional", + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", "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.

    " + "smithy.api#documentation": "

    The status of the database activity stream.

    " } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "DBClusterMembers": { + "target": "com.amazonaws.rds#DBClusterMemberList", "traits": { - "smithy.api#documentation": "

    Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

    " + "smithy.api#documentation": "

    Provides the list of instances that make up the DB cluster.

    " + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

    The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

    " } } }, @@ -3892,22 +3907,22 @@ "com.amazonaws.rds#DBClusterBacktrack": { "type": "structure", "members": { - "BacktrackTo": { - "target": "com.amazonaws.rds#TStamp", + "Status": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The timestamp of the time to which the DB cluster was backtracked.

    " + "smithy.api#documentation": "

    The status of the backtrack. This property returns one of the following\n values:

    \n
      \n
    • \n

      \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

      \n
      • \n
    " } }, - "BacktrackRequestCreationTime": { + "BacktrackTo": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The timestamp of the time at which the backtrack was requested.

    " + "smithy.api#documentation": "

    The timestamp of the time to which the DB cluster was backtracked.

    " } }, - "DBClusterIdentifier": { + "BacktrackIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    " + "smithy.api#documentation": "

    Contains the backtrack identifier.

    " } }, "BacktrackedFrom": { @@ -3916,16 +3931,16 @@ "smithy.api#documentation": "

    The timestamp of the time from which the DB cluster was backtracked.

    " } }, - "BacktrackIdentifier": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains the backtrack identifier.

    " + "smithy.api#documentation": "

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    " } }, - "Status": { - "target": "com.amazonaws.rds#String", + "BacktrackRequestCreationTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The status of the backtrack. This property returns one of the following\n values:

    \n
      \n
    • \n

      \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

      \n
      • \n
    " + "smithy.api#documentation": "

    The timestamp of the time at which the backtrack was requested.

    " } } }, @@ -3945,17 +3960,17 @@ "com.amazonaws.rds#DBClusterBacktrackMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a later DescribeDBClusterBacktracks request.

    " - } - }, "DBClusterBacktracks": { "target": "com.amazonaws.rds#DBClusterBacktrackList", "traits": { "smithy.api#documentation": "

    Contains a list of backtracks for the user.

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    A pagination token that can be used in a later DescribeDBClusterBacktracks request.

    " + } } }, "traits": { @@ -3978,6 +3993,18 @@ "com.amazonaws.rds#DBClusterCapacityInfo": { "type": "structure", "members": { + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

    " + } + }, + "CurrentCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The current capacity of the DB cluster.

    " + } + }, "TimeoutAction": { "target": "com.amazonaws.rds#String", "traits": { @@ -3990,69 +4017,57 @@ "smithy.api#documentation": "

    A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

    " } }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

    " - } - }, "PendingCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

    A value that specifies the capacity that the DB cluster scales to next.

    " } - }, - "CurrentCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The current capacity of the DB cluster.

    " - } } } }, "com.amazonaws.rds#DBClusterEndpoint": { "type": "structure", "members": { - "DBClusterEndpointIdentifier": { + "CustomEndpointType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

    " + "smithy.api#documentation": "

    The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.

    " } }, - "DBClusterIdentifier": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

    " + "smithy.api#documentation": "

    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster,\n such as a writer endpoint for a read-only secondary cluster in a global database.

    " } }, - "EndpointType": { - "target": "com.amazonaws.rds#String", + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

    " + "smithy.api#documentation": "

    List of DB instance identifiers that are part of the custom endpoint group.

    " } }, - "Endpoint": { + "DBClusterEndpointResourceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DNS address of the endpoint.

    " + "smithy.api#documentation": "

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

    " } }, - "DBClusterEndpointResourceIdentifier": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

    " + "smithy.api#documentation": "

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

    " } }, - "ExcludedMembers": { - "target": "com.amazonaws.rds#StringList", + "EndpointType": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

    " + "smithy.api#documentation": "

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

    " } }, - "Status": { + "DBClusterEndpointIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The current status of the endpoint. One of: creating, available, deleting, modifying.

    " + "smithy.api#documentation": "

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

    " } }, "DBClusterEndpointArn": { @@ -4061,16 +4076,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the endpoint.

    " } }, - "CustomEndpointType": { - "target": "com.amazonaws.rds#String", + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.

    " + "smithy.api#documentation": "

    List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

    " } }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", + "Endpoint": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    List of DB instance identifiers that are part of the custom endpoint group.

    " + "smithy.api#documentation": "

    The DNS address of the endpoint.

    " } } }, @@ -4155,10 +4170,10 @@ "com.amazonaws.rds#DBClusterMember": { "type": "structure", "members": { - "IsClusterWriter": { - "target": "com.amazonaws.rds#Boolean", + "DBClusterParameterGroupStatus": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

    " + "smithy.api#documentation": "

    Specifies the status of the DB cluster parameter group for this member of the DB cluster.

    " } }, "PromotionTier": { @@ -4167,16 +4182,16 @@ "smithy.api#documentation": "

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

    " } }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", + "IsClusterWriter": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the instance identifier for this member of the DB cluster.

    " + "smithy.api#documentation": "

    Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

    " } }, - "DBClusterParameterGroupStatus": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the status of the DB cluster parameter group for this member of the DB cluster.

    " + "smithy.api#documentation": "

    Specifies the instance identifier for this member of the DB cluster.

    " } } }, @@ -4238,16 +4253,16 @@ "com.amazonaws.rds#DBClusterOptionGroupStatus": { "type": "structure", "members": { - "Status": { + "DBClusterOptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the status of the DB cluster option group.

    " + "smithy.api#documentation": "

    Specifies the name of the DB cluster option group.

    " } }, - "DBClusterOptionGroupName": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the DB cluster option group.

    " + "smithy.api#documentation": "

    Specifies the status of the DB cluster option group.

    " } } }, @@ -4258,28 +4273,28 @@ "com.amazonaws.rds#DBClusterParameterGroup": { "type": "structure", "members": { - "DBClusterParameterGroupName": { + "Description": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the name of the DB cluster parameter group.

    " + "smithy.api#documentation": "

    Provides the customer-specified description for this DB cluster parameter group.

    " } }, - "DBParameterGroupFamily": { + "DBClusterParameterGroupArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB cluster parameter group.

    " } }, - "Description": { + "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the customer-specified description for this DB cluster parameter group.

    " + "smithy.api#documentation": "

    The name of the DB parameter group family that this DB cluster parameter group is compatible with.

    " } }, - "DBClusterParameterGroupArn": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB cluster parameter group.

    " + "smithy.api#documentation": "

    The name of the DB cluster parameter group.

    " } } }, @@ -4290,17 +4305,17 @@ "com.amazonaws.rds#DBClusterParameterGroupDetails": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " - } - }, "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { "smithy.api#documentation": "

    Provides a list of parameters for the DB cluster parameter group.

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " + } } }, "traits": { @@ -4379,16 +4394,16 @@ "com.amazonaws.rds#DBClusterRole": { "type": "structure", "members": { - "Status": { + "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

    \n
      \n
    • \n

      \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other AWS services on your behalf.

      \n
      • \n
    • \n

      \n PENDING - the IAM role ARN is being associated with the DB cluster.

      \n
      • \n
    • \n

      \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other AWS services on your behalf.

      \n
      • \n
    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

    " } }, - "RoleArn": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

    " + "smithy.api#documentation": "

    Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

    \n
      \n
    • \n

      \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other AWS services on your behalf.

      \n
      • \n
    • \n

      \n PENDING - the IAM role ARN is being associated with the DB cluster.

      \n
      • \n
    • \n

      \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other AWS services on your behalf.

      \n
      • \n
    " } }, "FeatureName": { @@ -4453,125 +4468,128 @@ "com.amazonaws.rds#DBClusterSnapshot": { "type": "structure", "members": { - "Engine": { + "DBClusterSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the database engine.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB cluster snapshot.

    " } }, - "EngineVersion": { + "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the version of the database engine for this DB cluster snapshot.

    " + "smithy.api#documentation": "

    Provides the VPC ID associated with the DB cluster snapshot.

    " } }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", + "SourceDBClusterSnapshotArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies whether the DB cluster snapshot is encrypted.

    " + "smithy.api#documentation": "

    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

    " } }, - "LicenseModel": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the license model information for this DB cluster snapshot.

    " + "smithy.api#documentation": "

    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    " } }, - "SnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    " + "smithy.api#documentation": "

    Specifies the allocated storage size in gibibytes (GiB).

    " } }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", + "SnapshotType": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

    " + "smithy.api#documentation": "

    Provides the type of the DB cluster snapshot.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

    " + "smithy.api#documentation": "

    Specifies the port that the DB cluster was listening on at the time of the snapshot.

    " } }, - "VpcId": { - "target": "com.amazonaws.rds#String", + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    Provides the VPC ID associated with the DB cluster snapshot.

    " + "smithy.api#documentation": "

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    " } }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    " + "smithy.api#documentation": "

    Specifies the percentage of the estimated data that has been transferred.

    " } }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    " + "smithy.api#documentation": "

    Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

    " } }, - "DBClusterSnapshotArn": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB cluster snapshot.

    " + "smithy.api#documentation": "

    Provides the version of the database engine for this DB cluster snapshot.

    " } }, - "SnapshotType": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the type of the DB cluster snapshot.

    " + "smithy.api#documentation": "

    Specifies the status of this DB cluster snapshot.

    " } }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    Provides the master username for the DB cluster snapshot.

    " + "smithy.api#documentation": "

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    " } }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", + "Engine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the allocated storage size in gibibytes (GiB).

    " + "smithy.api#documentation": "

    Specifies the name of the database engine.

    " } }, - "Port": { - "target": "com.amazonaws.rds#Integer", + "LicenseModel": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the port that the DB cluster was listening on at the time of the snapshot.

    " + "smithy.api#documentation": "

    Provides the license model information for this DB cluster snapshot.

    " } }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the identifier for the DB cluster snapshot.

    " + "smithy.api#documentation": "

    Specifies whether the DB cluster snapshot is encrypted.

    " } }, - "PercentProgress": { - "target": "com.amazonaws.rds#Integer", + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the percentage of the estimated data that has been transferred.

    " + "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    " } }, - "Status": { + "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the status of this DB cluster snapshot.

    " + "smithy.api#documentation": "

    Provides the master username for the DB cluster snapshot.

    " } }, - "ClusterCreateTime": { - "target": "com.amazonaws.rds#TStamp", + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    " + "smithy.api#documentation": "

    Specifies the identifier for the DB cluster snapshot.

    " } }, - "SourceDBClusterSnapshotArn": { + "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

    " + "smithy.api#documentation": "

    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

    " } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" } }, "traits": { @@ -4594,17 +4612,17 @@ "com.amazonaws.rds#DBClusterSnapshotAttribute": { "type": "structure", "members": { - "AttributeValues": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

    The value(s) for the manual DB cluster snapshot attribute.

    \n

    If the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any AWS account to copy or restore.

    " - } - }, "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The name of the manual DB cluster snapshot attribute.

    \n

    The attribute named restore refers to the list of AWS accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

    " } + }, + "AttributeValues": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

    The value(s) for the manual DB cluster snapshot attribute.

    \n

    If the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any AWS account to copy or restore.

    " + } } }, "traits": { @@ -4685,46 +4703,46 @@ "com.amazonaws.rds#DBEngineVersion": { "type": "structure", "members": { - "ExportableLogTypes": { - "target": "com.amazonaws.rds#LogTypeList", + "EngineVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The types of logs that the database engine has available for export to CloudWatch Logs.

    " + "smithy.api#documentation": "

    The version number of the database engine.

    " } }, - "DefaultCharacterSet": { - "target": "com.amazonaws.rds#CharacterSet", + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    \n The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.\n

    " + "smithy.api#documentation": "

    A value that indicates whether you can use Aurora global databases with a specific DB engine version.

    " } }, - "ValidUpgradeTarget": { - "target": "com.amazonaws.rds#ValidUpgradeTargetList", + "Status": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of engine versions that this database engine version can be upgraded to.

    " + "smithy.api#documentation": "

    The status of the DB engine version, either available or deprecated.

    " } }, - "SupportedFeatureNames": { - "target": "com.amazonaws.rds#FeatureNameList", + "SupportsLogExportsToCloudwatchLogs": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    \n A list of features supported by the DB engine. Supported feature names include the following.\n

    \n
      \n
    • \n

      s3Import

      \n
      • \n
    " + "smithy.api#documentation": "

    A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

    " } }, - "SupportsParallelQuery": { - "target": "com.amazonaws.rds#Boolean", + "DBEngineVersionDescription": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

    " + "smithy.api#documentation": "

    The description of the database engine version.

    " } }, - "EngineVersion": { + "DBEngineDescription": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version number of the database engine.

    " + "smithy.api#documentation": "

    The description of the database engine.

    " } }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", + "Engine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of the supported DB engine modes.

    \n \n

    \n global engine mode only applies for global database clusters created with Aurora MySQL version\n 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned\n engine mode.\n

    \n     " + "smithy.api#documentation": "

    The name of the database engine.

    " } }, "SupportedTimezones": { @@ -4733,58 +4751,64 @@ "smithy.api#documentation": "

    A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action. \n

    " } }, - "DBEngineDescription": { + "ExportableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

    The types of logs that the database engine has available for export to CloudWatch Logs.

    " + } + }, + "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The description of the database engine.

    " + "smithy.api#documentation": "

    The name of the DB parameter group family for the database engine.

    " } }, - "SupportsReadReplica": { - "target": "com.amazonaws.rds#Boolean", + "SupportedCharacterSets": { + "target": "com.amazonaws.rds#SupportedCharacterSetsList", "traits": { - "smithy.api#documentation": "

    Indicates whether the database engine version supports read replicas.

    " + "smithy.api#documentation": "

    A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation. \n

    " } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The name of the database engine.

    " + "smithy.api#documentation": "

    A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

    " } }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", + "ValidUpgradeTarget": { + "target": "com.amazonaws.rds#ValidUpgradeTargetList", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group family for the database engine.

    " + "smithy.api#documentation": "

    A list of engine versions that this database engine version can be upgraded to.

    " } }, - "Status": { - "target": "com.amazonaws.rds#String", + "SupportedFeatureNames": { + "target": "com.amazonaws.rds#FeatureNameList", "traits": { - "smithy.api#documentation": "

    The status of the DB engine version, either available or deprecated.

    " + "smithy.api#documentation": "

    \n A list of features supported by the DB engine. Supported feature names include the following.\n

    \n
      \n
    • \n

      s3Import

      \n
      • \n
    " } }, - "SupportedCharacterSets": { + "SupportedNcharCharacterSets": { "target": "com.amazonaws.rds#SupportedCharacterSetsList", "traits": { - "smithy.api#documentation": "

    \n A list of the character sets supported by this engine for the\n CharacterSetName parameter of the CreateDBInstance action. \n

    " + "smithy.api#documentation": "

    A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation. \n

    " } }, - "SupportsLogExportsToCloudwatchLogs": { + "SupportsReadReplica": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

    " + "smithy.api#documentation": "

    Indicates whether the database engine version supports read replicas.

    " } }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#Boolean", + "DefaultCharacterSet": { + "target": "com.amazonaws.rds#CharacterSet", "traits": { - "smithy.api#documentation": "

    A value that indicates whether you can use Aurora global databases with a specific DB engine version.

    " + "smithy.api#documentation": "

    \n The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.\n

    " } }, - "DBEngineVersionDescription": { - "target": "com.amazonaws.rds#String", + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", "traits": { - "smithy.api#documentation": "

    The description of the database engine version.

    " + "smithy.api#documentation": "

    A list of the supported DB engine modes.

    " } } }, @@ -4804,17 +4828,17 @@ "com.amazonaws.rds#DBEngineVersionMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " - } - }, "DBEngineVersions": { "target": "com.amazonaws.rds#DBEngineVersionList", "traits": { "smithy.api#documentation": "

    \n A list of DBEngineVersion elements.\n

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + } } }, "traits": { @@ -4824,70 +4848,52 @@ "com.amazonaws.rds#DBInstance": { "type": "structure", "members": { - "CharacterSetName": { - "target": "com.amazonaws.rds#String", + "OptionGroupMemberships": { + "target": "com.amazonaws.rds#OptionGroupMembershipList", "traits": { - "smithy.api#documentation": "

    If present, specifies the name of the character set that this instance is associated with.

    " + "smithy.api#documentation": "

    Provides the list of option group memberships for this DB instance.

    " } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", + "StatusInfos": { + "target": "com.amazonaws.rds#DBInstanceStatusInfoList", "traits": { - "smithy.api#documentation": "

    \n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

    " + "smithy.api#documentation": "

    The status of a read replica. If the instance isn't a read replica, this is\n blank.

    " } }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", + "PendingModifiedValues": { + "target": "com.amazonaws.rds#PendingModifiedValues", "traits": { - "smithy.api#documentation": "

    Provides the date and time the DB instance was created.

    " + "smithy.api#documentation": "

    Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

    " } }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    " + "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    \n\n

    IAM database authentication can be enabled for the following database engines

    \n
      \n
    • \n

      For MySQL 5.6, minor version 5.6.34 or higher

      \n
      • \n
    • \n

      For MySQL 5.7, minor version 5.7.16 or higher

      \n
      • \n
    • \n

      Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

      \n
      • \n
    " } }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Contains the master username for the DB instance.

    " + "smithy.api#documentation": "

    Specifies whether the DB instance is encrypted.

    " } }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " - } - }, - "ListenerEndpoint": { - "target": "com.amazonaws.rds#Endpoint", - "traits": { - "smithy.api#documentation": "

    Specifies the listener connection endpoint for SQL Server Always On.

    " - } - }, - "DBInstanceIdentifier": { + "Timezone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    " - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n

    " } }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", + "DbiResourceId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + "smithy.api#documentation": "

    The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

    " } }, - "StorageType": { - "target": "com.amazonaws.rds#String", + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

    Specifies the storage type associated with DB instance.

    " + "smithy.api#documentation": "

    Provides a list of VPC security group elements that the DB instance belongs to.

    " } }, "PreferredMaintenanceWindow": { @@ -4896,28 +4902,16 @@ "smithy.api#documentation": "

    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    " } }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    License model information for this DB instance.

    " - } - }, - "ReadReplicaSourceDBInstanceIdentifier": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains the identifier of the source DB instance if this DB instance is a read\n replica.

    " - } - }, - "DBSubnetGroup": { - "target": "com.amazonaws.rds#DBSubnetGroup", - "traits": { - "smithy.api#documentation": "

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

    " + "smithy.api#documentation": "

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

    " } }, - "AllocatedStorage": { + "DbInstancePort": { "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    Specifies the allocated storage size specified in gibibytes.

    " + "smithy.api#documentation": "

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

    " } }, "Endpoint": { @@ -4926,28 +4920,28 @@ "smithy.api#documentation": "

    Specifies the connection endpoint.

    " } }, - "ReadReplicaDBInstanceIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", + "DBInstanceArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains one or more identifiers of the read replicas associated with this DB\n instance.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB instance.

    " } }, - "DbInstancePort": { - "target": "com.amazonaws.rds#Integer", + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

    " + "smithy.api#documentation": "

    Specifies if the DB instance is a Multi-AZ deployment.

    " } }, - "CACertificateIdentifier": { + "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the CA certificate for this DB instance.

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS\n encryption key.

    " } }, - "DBName": { + "TdeCredentialArn": { "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, MariaDB, SQL Server, PostgreSQL\n

    \n

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    \n

    Type: String

    \n

    \n Oracle\n

    \n

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

    " + "smithy.api#documentation": "

    The ARN from the key store with which the instance is associated for TDE encryption.

    " } }, "DBParameterGroups": { @@ -4956,88 +4950,82 @@ "smithy.api#documentation": "

    Provides the list of DB parameter groups applied to this DB instance.

    " } }, - "PerformanceInsightsKMSKeyId": { + "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS\n encryption key.

    " + "smithy.api#documentation": "

    Contains the name of the compute and memory capacity class of the DB instance.

    " } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    Provides the name of the database engine to be used for this DB instance.

    " + "smithy.api#documentation": "

    Specifies the latest time to which a database can be restored with point-in-time restore.

    " } }, - "CopyTagsToSnapshot": { + "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

    " + "smithy.api#documentation": "

    Indicates that minor version patches are applied automatically.

    " } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

    Specifies the Provisioned IOPS (I/O operations per second) value.

    " + "smithy.api#documentation": "

    \n A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

    " } }, - "DBInstanceArn": { + "DBInstanceStatus": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB instance.

    " + "smithy.api#documentation": "

    Specifies the current state of this database.

    \n

    For information about DB instance statuses, see\n DB Instance Status in the Amazon RDS User Guide.\n

    " } }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

    \n

    Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " } }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

    " + "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

    " } }, - "SecondaryAvailabilityZone": { + "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    " + "smithy.api#documentation": "

    Specifies the storage type associated with DB instance.

    " } }, - "Timezone": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n

    " - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether the DB instance is encrypted.

    " + "smithy.api#documentation": "

    Indicates the database engine version.

    " } }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    \n\n

    IAM database authentication can be enabled for the following database engines

    \n
      \n
    • \n

      For MySQL 5.6, minor version 5.6.34 or higher

      \n
      • \n
    • \n

      For MySQL 5.7, minor version 5.7.16 or higher

      \n
      • \n
    • \n

      Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

      \n
      • \n
    " + "smithy.api#documentation": "

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    " } }, - "DBClusterIdentifier": { + "ReadReplicaSourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

    " + "smithy.api#documentation": "

    Contains the identifier of the source DB instance if this DB instance is a read\n replica.

    " } }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", + "ReadReplicaDBClusterIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which the instance is associated for TDE encryption.

    " + "smithy.api#documentation": "

    Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output does not contain information about cross region Aurora read\n replicas.

    \n \n

    Currently, each RDS DB instance can have only one Aurora read replica.

    \n     " } }, - "DomainMemberships": { - "target": "com.amazonaws.rds#DomainMembershipList", + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The Active Directory Domain membership records associated with the DB instance.

    " + "smithy.api#documentation": "

    Specifies the allocated storage size specified in gibibytes.

    " } }, "MaxAllocatedStorage": { @@ -5046,52 +5034,58 @@ "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " } }, - "PendingModifiedValues": { - "target": "com.amazonaws.rds#PendingModifiedValues", + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", "traits": { - "smithy.api#documentation": "

    Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

    " + "smithy.api#documentation": "

    The Active Directory Domain membership records associated with the DB instance.

    " } }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "PubliclyAccessible": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    \n A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

    " + "smithy.api#documentation": "

    Specifies the accessibility options for the DB instance.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " } }, - "PerformanceInsightsEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", + "DeletionProtection": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    True if Performance Insights is enabled for the DB instance, and otherwise false.

    " + "smithy.api#documentation": "

    Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.\n

    " } }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#Boolean", + "MasterUsername": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the accessibility options for the DB instance.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " + "smithy.api#documentation": "

    Contains the master username for the DB instance.

    " } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#Integer", + "KmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the number of days for which automatic DB snapshots are retained.

    " + "smithy.api#documentation": "

    \n If StorageEncrypted is true, the AWS KMS key identifier \n for the encrypted DB instance.\n

    " } }, - "EngineVersion": { + "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates the database engine version.

    " + "smithy.api#documentation": "

    Specifies the name of the Availability Zone the DB instance is located in.

    " } }, - "KmsKeyId": { + "NcharCharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n If StorageEncrypted is true, the AWS KMS key identifier \n for the encrypted DB instance.\n

    " + "smithy.api#documentation": "

    The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.\n

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.rds#Boolean", + "SecondaryAvailabilityZone": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.\n

    " + "smithy.api#documentation": "

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    " + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    " } }, "EnhancedMonitoringResourceArn": { @@ -5100,76 +5094,121 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

    " } }, - "AvailabilityZone": { + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

    " + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBInstanceRoles", + "traits": { + "smithy.api#documentation": "

    \n The AWS Identity and Access Management (IAM) roles associated with the DB instance.\n

    " + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

    Provides the date and time the DB instance was created.

    " + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + } + }, + "ListenerEndpoint": { + "target": "com.amazonaws.rds#Endpoint", + "traits": { + "smithy.api#documentation": "

    Specifies the listener connection endpoint for SQL Server Always On.

    " + } + }, + "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the Availability Zone the DB instance is located in.

    " + "smithy.api#documentation": "

    The identifier of the CA certificate for this DB instance.

    " } }, - "VpcSecurityGroups": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    Provides a list of VPC security group elements that the DB instance belongs to.

    " + "smithy.api#documentation": "

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

    \n

    Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n

    " } }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", + "CharacterSetName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

    " + "smithy.api#documentation": "

    If present, specifies the name of the character set that this instance is associated with.

    " } }, - "ReadReplicaDBClusterIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", + "ReadReplicaDBInstanceIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", "traits": { - "smithy.api#documentation": "

    Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output does not contain information about cross region Aurora read\n replicas.

    \n \n

    Currently, each RDS DB instance can have only one Aurora read replica.

    \n     " + "smithy.api#documentation": "

    Contains one or more identifiers of the read replicas associated with this DB\n instance.

    " } }, - "AutoMinorVersionUpgrade": { + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates that minor version patches are applied automatically.

    " + "smithy.api#documentation": "

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

    " } }, - "AssociatedRoles": { - "target": "com.amazonaws.rds#DBInstanceRoles", + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

    \n The AWS Identity and Access Management (IAM) roles associated with the DB instance.\n

    " + "smithy.api#documentation": "

    The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

    \n \n

    This attribute is only supported in RDS for Oracle.

    \n     " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", + "Engine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies if the DB instance is a Multi-AZ deployment.

    " + "smithy.api#documentation": "

    The name of the database engine to be used for this DB instance.

    " } }, - "DBInstanceClass": { + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    Specifies the Provisioned IOPS (I/O operations per second) value.

    " + } + }, + "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains the name of the compute and memory capacity class of the DB instance.

    " + "smithy.api#documentation": "

    License model information for this DB instance.

    " } }, - "OptionGroupMemberships": { - "target": "com.amazonaws.rds#OptionGroupMembershipList", + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup", "traits": { - "smithy.api#documentation": "

    Provides the list of option group memberships for this DB instance.

    " + "smithy.api#documentation": "

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

    " } }, - "LatestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the latest time to which a database can be restored with point-in-time restore.

    " + "smithy.api#documentation": "

    \n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

    " } }, - "StatusInfos": { - "target": "com.amazonaws.rds#DBInstanceStatusInfoList", + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The status of a read replica. If the instance isn't a read replica, this is\n blank.

    " + "smithy.api#documentation": "

    Specifies the number of days for which automatic DB snapshots are retained.

    " } }, - "DBInstanceStatus": { + "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the current state of this database.

    \n

    For information about DB instance statuses, see\n DB Instance Status in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    The meaning of this parameter differs according to the database engine you use.

    \n

    \n MySQL, MariaDB, SQL Server, PostgreSQL\n

    \n

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    \n

    Type: String

    \n

    \n Oracle\n

    \n

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

    " + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    True if Performance Insights is enabled for the DB instance, and otherwise false.

    " } } }, @@ -5193,10 +5232,28 @@ "com.amazonaws.rds#DBInstanceAutomatedBackup": { "type": "structure", "members": { + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The license model of an automated backup.

    " + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

    " + } + }, "DBInstanceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the automated backup.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the automated backup.

    " + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#documentation": "

    The port number that the automated backup used for connections.

    \n

    Default: Inherits from the source DB instance

    \n

    Valid Values: 1150-65535\n

    " } }, "RestoreWindow": { @@ -5205,22 +5262,22 @@ "smithy.api#documentation": "

    Earliest and latest time an instance can be restored to.

    " } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The IOPS (I/O operations per second) value for the automated backup.

    " + "smithy.api#documentation": "

    Specifies whether the automated backup is encrypted.

    " } }, - "EngineVersion": { + "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version of the database engine for the automated backup.

    " + "smithy.api#documentation": "

    The ARN from the key store with which the automated backup is associated for TDE encryption.

    " } }, - "DbiResourceId": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

    " + "smithy.api#documentation": "

    The name of the database engine for this automated backup.

    " } }, "DBInstanceIdentifier": { @@ -5229,70 +5286,58 @@ "smithy.api#documentation": "

    The customer id of the instance that is/was associated with the automated backup.\n

    " } }, - "StorageType": { + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the storage type associated with the automated backup.

    " + "smithy.api#documentation": "

    The option group the automated backup is associated with. \n If omitted, the default option group for the engine specified is used.

    " } }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    License model information for the automated backup.

    " + "smithy.api#documentation": "

    Specifies the allocated storage size in gibibytes (GiB).

    " } }, - "Timezone": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.

    " - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

    " + "smithy.api#documentation": "

    Provides a list of status information for an automated backup:

    \n
      \n
    • \n

      \n active - automated backups for current instances

      \n
      • \n
    • \n

      \n retained - automated backups for deleted instances

      \n
      • \n
    • \n

      \n creating - automated backups that are waiting\n for the first automated snapshot to be available.

      \n
      • \n
    " } }, - "MasterUsername": { + "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The license model of an automated backup.

    " + "smithy.api#documentation": "

    Specifies the storage type associated with the automated backup.

    " } }, - "Status": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides a list of status information for an automated backup:

    \n
      \n
    • \n

      \n active - automated backups for current instances

      \n
      • \n
    • \n

      \n retained - automated backups for deleted instances

      \n
      • \n
    • \n

      \n creating - automated backups that are waiting\n for the first automated snapshot to be available.

      \n
      • \n
    " - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#documentation": "

    The port number that the automated backup used for connections.

    \n

    Default: Inherits from the source DB instance

    \n

    Valid Values: 1150-65535\n

    " + "smithy.api#documentation": "

    The version of the database engine for the automated backup.

    " } }, - "AvailabilityZone": { + "Region": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Availability Zone that the automated backup was created in. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.

    " + "smithy.api#documentation": "

    The AWS Region associated with the automated backup.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The AWS KMS key ID for an automated backup. \n The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    " + "smithy.api#documentation": "

    The IOPS (I/O operations per second) value for the automated backup.

    " } }, - "Encrypted": { - "target": "com.amazonaws.rds#Boolean", + "Timezone": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies whether the automated backup is encrypted.

    " + "smithy.api#documentation": "

    The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.

    " } }, - "Region": { + "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS Region associated with the automated backup.

    " + "smithy.api#documentation": "

    License model information for the automated backup.

    " } }, "InstanceCreateTime": { @@ -5301,34 +5346,28 @@ "smithy.api#documentation": "

    Provides the date and time that the DB instance was created.\n

    " } }, - "VpcId": { - "target": "com.amazonaws.rds#String", + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Provides the VPC ID associated with the DB instance

    " + "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

    " } }, - "OptionGroupName": { + "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The option group the automated backup is associated with. \n If omitted, the default option group for the engine specified is used.

    " - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#documentation": "

    Specifies the allocated storage size in gibibytes (GiB).

    " + "smithy.api#documentation": "

    Provides the VPC ID associated with the DB instance

    " } }, - "Engine": { + "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the database engine for this automated backup.

    " + "smithy.api#documentation": "

    The Availability Zone that the automated backup was created in. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.

    " } }, - "TdeCredentialArn": { + "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which the automated backup is associated for TDE encryption.

    " + "smithy.api#documentation": "

    The AWS KMS key ID for an automated backup. \n The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    " } } }, @@ -5436,12 +5475,6 @@ "com.amazonaws.rds#DBInstanceRole": { "type": "structure", "members": { - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the feature associated with the AWS Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n

    " - } - }, "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { @@ -5453,6 +5486,12 @@ "traits": { "smithy.api#documentation": "

    Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

    \n
      \n
    • \n

      \n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other AWS services on your behalf.

      \n
      • \n
    • \n

      \n PENDING - the IAM role ARN is being associated with the DB instance.

      \n
      • \n
    • \n

      \n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other AWS services on your behalf.

      \n
      • \n
    " } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the feature associated with the AWS Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n

    " + } } }, "traits": { @@ -5510,28 +5549,28 @@ "com.amazonaws.rds#DBInstanceStatusInfo": { "type": "structure", "members": { - "StatusType": { - "target": "com.amazonaws.rds#String", + "Normal": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    This value is currently \"read replication.\"

    " + "smithy.api#documentation": "

    Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

    " } }, - "Message": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

    " + "smithy.api#documentation": "

    Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

    " } }, - "Status": { + "Message": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

    " + "smithy.api#documentation": "

    Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

    " } }, - "Normal": { - "target": "com.amazonaws.rds#Boolean", + "StatusType": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

    " + "smithy.api#documentation": "

    This value is currently \"read replication.\"

    " } } }, @@ -5567,25 +5606,25 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the name of the DB parameter group.

    " + "smithy.api#documentation": "

    The name of the DB parameter group.

    " } }, - "Description": { + "DBParameterGroupArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the customer-specified description for this DB parameter group.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB parameter group.

    " } }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the name of the DB parameter group family that this DB parameter group is compatible with.

    " + "smithy.api#documentation": "

    The name of the DB parameter group family that this DB parameter group is compatible with.

    " } }, - "DBParameterGroupArn": { + "Description": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB parameter group.

    " + "smithy.api#documentation": "

    Provides the customer-specified description for this DB parameter group.

    " } } }, @@ -5609,17 +5648,17 @@ "com.amazonaws.rds#DBParameterGroupDetails": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

    \n A list of Parameter values.\n

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

    \n A list of Parameter values.\n

    " + } } }, "traits": { @@ -5641,7 +5680,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the name of the DB parameter group.

    " + "smithy.api#documentation": "

    The name of the DB parameter group.

    " } } }, @@ -5678,16 +5717,16 @@ "com.amazonaws.rds#DBParameterGroupStatus": { "type": "structure", "members": { - "ParameterApplyStatus": { + "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of parameter updates.

    " + "smithy.api#documentation": "

    The name of the DB parameter group.

    " } }, - "DBParameterGroupName": { + "ParameterApplyStatus": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group.

    " + "smithy.api#documentation": "

    The status of parameter updates.

    " } } }, @@ -5727,88 +5766,88 @@ "com.amazonaws.rds#DBProxy": { "type": "structure", "members": { - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigInfoList", + "Endpoint": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.

    " + "smithy.api#documentation": "

    The endpoint that you can use to connect to the proxy. You include the endpoint value in the\n connection string for a database client application.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", + "RequireTLS": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The date and time when the proxy was first created.

    " + "smithy.api#documentation": "

    Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

    " } }, - "DBProxyArn": { + "EngineFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the proxy.

    " + "smithy.api#documentation": "

    The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

    " } }, - "VpcSecurityGroupIds": { + "VpcSubnetIds": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    Provides a list of VPC security groups that the proxy belongs to.

    " + "smithy.api#documentation": "

    The EC2 subnet IDs for the proxy.

    " } }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#Integer", + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

    \n

    Default: 1800 (30 minutes)

    \n

    Constraints: 1 to 28,800

    " + "smithy.api#documentation": "

    The date and time when the proxy was first created.

    " } }, - "DebugLogging": { - "target": "com.amazonaws.rds#Boolean", + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigInfoList", "traits": { - "smithy.api#documentation": "

    Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

    " + "smithy.api#documentation": "

    One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.

    " } }, - "RoleArn": { + "DBProxyArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the proxy.

    " } }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", + "Status": { + "target": "com.amazonaws.rds#DBProxyStatus", "traits": { - "smithy.api#documentation": "

    The EC2 subnet IDs for the proxy.

    " + "smithy.api#documentation": "

    The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.

    " } }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

    " + "smithy.api#documentation": "

    Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

    " } }, - "UpdatedDate": { - "target": "com.amazonaws.rds#TStamp", + "RoleArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The date and time when the proxy was last updated.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

    " } }, - "Endpoint": { - "target": "com.amazonaws.rds#String", + "IdleClientTimeout": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The endpoint that you can use to connect to the proxy. You include the endpoint value in the\n connection string for a database client application.

    " + "smithy.api#documentation": "

    The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

    \n

    Default: 1800 (30 minutes)

    \n

    Constraints: 1 to 28,800

    " } }, - "Status": { - "target": "com.amazonaws.rds#DBProxyStatus", + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.

    " + "smithy.api#documentation": "

    The date and time when the proxy was last updated.

    " } }, - "RequireTLS": { - "target": "com.amazonaws.rds#Boolean", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

    " + "smithy.api#documentation": "

    Provides a list of VPC security groups that the proxy belongs to.

    " } }, - "EngineFamily": { + "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

    " + "smithy.api#documentation": "

    The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

    " } } }, @@ -5907,10 +5946,16 @@ "com.amazonaws.rds#DBProxyTarget": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The writer endpoint for the RDS DB instance or Aurora DB cluster.

    " + "smithy.api#documentation": "

    The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

    " + } + }, + "TargetHealth": { + "target": "com.amazonaws.rds#TargetHealth", + "traits": { + "smithy.api#documentation": "

    Information about the connection health of the RDS Proxy target.

    " } }, "Type": { @@ -5919,34 +5964,28 @@ "smithy.api#documentation": "

    Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

    " } }, - "RdsResourceId": { + "TargetArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

    " } }, - "TrackedClusterId": { + "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

    " - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#documentation": "

    The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

    " + "smithy.api#documentation": "

    The writer endpoint for the RDS DB instance or Aurora DB cluster.

    " } }, - "TargetHealth": { - "target": "com.amazonaws.rds#TargetHealth", + "RdsResourceId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Information about the connection health of the RDS Proxy target.

    " + "smithy.api#documentation": "

    The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.

    " } }, - "TargetArn": { + "TrackedClusterId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

    " + "smithy.api#documentation": "

    The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

    " } } }, @@ -5970,28 +6009,34 @@ "com.amazonaws.rds#DBProxyTargetGroup": { "type": "structure", "members": { - "UpdatedDate": { - "target": "com.amazonaws.rds#TStamp", + "Status": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The date and time when the target group was last updated.

    " + "smithy.api#documentation": "

    The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.

    " } }, - "DBProxyName": { + "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the RDS proxy associated with this target group.

    " + "smithy.api#documentation": "

    The identifier for the target group. This name must be unique for all target groups owned by your AWS account in the specified AWS Region.

    " } }, - "ConnectionPoolConfig": { - "target": "com.amazonaws.rds#ConnectionPoolConfigurationInfo", + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The settings that determine the size and behavior of the connection pool for the target group.

    " + "smithy.api#documentation": "

    The date and time when the target group was first created.

    " } }, - "TargetGroupName": { + "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the target group. This name must be unique for all target groups owned by your AWS account in the specified AWS Region.

    " + "smithy.api#documentation": "

    The identifier for the RDS proxy associated with this target group.

    " + } + }, + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

    The date and time when the target group was last updated.

    " } }, "TargetGroupArn": { @@ -6006,16 +6051,10 @@ "smithy.api#documentation": "

    Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

    The date and time when the target group was first created.

    " - } - }, - "Status": { - "target": "com.amazonaws.rds#String", + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfigurationInfo", "traits": { - "smithy.api#documentation": "

    The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.

    " + "smithy.api#documentation": "

    The settings that determine the size and behavior of the connection pool for the target group.

    " } } }, @@ -6052,12 +6091,24 @@ "com.amazonaws.rds#DBSecurityGroup": { "type": "structure", "members": { + "OwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Provides the AWS ID of the owner of a specific DB security group.

    " + } + }, "DBSecurityGroupArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB security group.

    " } }, + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Specifies the name of the DB security group.

    " + } + }, "IPRanges": { "target": "com.amazonaws.rds#IPRangeList", "traits": { @@ -6070,28 +6121,16 @@ "smithy.api#documentation": "

    \n Contains a list of EC2SecurityGroup elements.\n

    " } }, - "DBSecurityGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    Provides the description of the DB security group.

    " - } - }, "VpcId": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    Provides the VpcId of the DB security group.

    " } }, - "OwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    Provides the AWS ID of the owner of a specific DB security group.

    " - } - }, - "DBSecurityGroupName": { + "DBSecurityGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the DB security group.

    " + "smithy.api#documentation": "

    Provides the description of the DB security group.

    " } } }, @@ -6115,16 +6154,16 @@ "com.amazonaws.rds#DBSecurityGroupMembership": { "type": "structure", "members": { - "DBSecurityGroupName": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB security group.

    " + "smithy.api#documentation": "

    The status of the DB security group.

    " } }, - "Status": { + "DBSecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of the DB security group.

    " + "smithy.api#documentation": "

    The name of the DB security group.

    " } } }, @@ -6144,17 +6183,17 @@ "com.amazonaws.rds#DBSecurityGroupMessage": { "type": "structure", "members": { - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroups", - "traits": { - "smithy.api#documentation": "

    \n A list of DBSecurityGroup instances.\n

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroups", + "traits": { + "smithy.api#documentation": "

    \n A list of DBSecurityGroup instances.\n

    " + } } }, "traits": { @@ -6221,130 +6260,133 @@ "com.amazonaws.rds#DBSnapshot": { "type": "structure", "members": { - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", "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 when the DB snapshot was created.

    " + "smithy.api#documentation": "

    Specifies the identifier for the DB snapshot.

    " } }, - "Encrypted": { - "target": "com.amazonaws.rds#Boolean", + "SourceDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies whether the DB snapshot is encrypted.

    " + "smithy.api#documentation": "

    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

    " } }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.

    " + "smithy.api#documentation": "

    The percentage of the estimated data that has been transferred.

    " } }, - "Timezone": { - "target": "com.amazonaws.rds#String", + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n

    " + "smithy.api#documentation": "

    Specifies whether the DB snapshot is encrypted.

    " } }, - "DbiResourceId": { + "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

    " + "smithy.api#documentation": "

    Specifies the storage type associated with DB snapshot.

    " } }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", + "EngineVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    " + "smithy.api#documentation": "

    Specifies the version of the database engine.

    " } }, - "DBSnapshotIdentifier": { + "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the identifier for the DB snapshot.

    " + "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " } }, - "VpcId": { + "DBSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the VPC ID associated with the DB snapshot.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB snapshot.

    " } }, - "SnapshotType": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the type of the DB snapshot.

    " + "smithy.api#documentation": "

    Specifies the name of the database engine.

    " } }, - "PercentProgress": { + "AllocatedStorage": { "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The percentage of the estimated data that has been transferred.

    " + "smithy.api#documentation": "

    Specifies the allocated storage size in gibibytes (GiB).

    " } }, - "AvailabilityZone": { + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    " + "smithy.api#documentation": "

    Provides the option group name for the DB snapshot.

    " } }, - "Port": { - "target": "com.amazonaws.rds#Integer", + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

    Specifies the port that the database engine was listening on at the time of the snapshot.

    " + "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 when the DB snapshot was created.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    \n If Encrypted is true, the AWS KMS key identifier \n for the encrypted DB snapshot.\n

    " + "smithy.api#documentation": "

    Specifies when the snapshot was taken in Coodinated Universal Time (UTC).

    " } }, - "MasterUsername": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the master username for the DB snapshot.

    " + "smithy.api#documentation": "

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    " } }, - "Status": { + "SourceRegion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the status of this DB snapshot.

    " + "smithy.api#documentation": "

    The AWS Region that the DB snapshot was created in or copied from.

    " } }, - "SourceDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

    " + "smithy.api#documentation": "

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    " } }, - "Engine": { + "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the database engine.

    " + "smithy.api#documentation": "

    Provides the type of the DB snapshot.

    " } }, - "DBSnapshotArn": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB snapshot.

    " + "smithy.api#documentation": "

    Specifies the port that the database engine was listening on at the time of the snapshot.

    " } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "Status": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    " + "smithy.api#documentation": "

    Specifies the status of this DB snapshot.

    " } }, - "EngineVersion": { + "Timezone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the version of the database engine.

    " + "smithy.api#documentation": "

    The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.\n

    " } }, - "SnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies when the snapshot was taken in Coodinated Universal Time (UTC).

    " + "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    " } }, "LicenseModel": { @@ -6353,40 +6395,40 @@ "smithy.api#documentation": "

    License model information for the restored DB instance.

    " } }, - "SourceRegion": { + "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS Region that the DB snapshot was created in or copied from.

    " + "smithy.api#documentation": "

    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

    " } }, - "StorageType": { + "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the storage type associated with DB snapshot.

    " + "smithy.api#documentation": "

    Provides the master username for the DB snapshot.

    " } }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the allocated storage size in gibibytes (GiB).

    " + "smithy.api#documentation": "

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    " } }, - "DBInstanceIdentifier": { + "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    " + "smithy.api#documentation": "

    \n If Encrypted is true, the AWS KMS key identifier \n for the encrypted DB snapshot.\n

    " } }, - "OptionGroupName": { + "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the option group name for the DB snapshot.

    " + "smithy.api#documentation": "

    Provides the VPC ID associated with the DB snapshot.

    " } }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + "smithy.api#documentation": "

    Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.

    " } } }, @@ -6410,17 +6452,17 @@ "com.amazonaws.rds#DBSnapshotAttribute": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the manual DB snapshot attribute.

    \n

    The attribute named restore refers to the list of AWS accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

    " - } - }, "AttributeValues": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { "smithy.api#documentation": "

    The value or values for the manual DB snapshot attribute.

    \n

    If the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any AWS account to copy or restore.

    " } + }, + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the manual DB snapshot attribute.

    \n

    The attribute named restore refers to the list of AWS accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

    " + } } }, "traits": { @@ -6439,16 +6481,16 @@ "com.amazonaws.rds#DBSnapshotAttributesResult": { "type": "structure", "members": { - "DBSnapshotAttributes": { - "target": "com.amazonaws.rds#DBSnapshotAttributeList", + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The list of attributes and values for the manual DB snapshot.

    " + "smithy.api#documentation": "

    The identifier of the manual DB snapshot that the attributes apply to.

    " } }, - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", + "DBSnapshotAttributes": { + "target": "com.amazonaws.rds#DBSnapshotAttributeList", "traits": { - "smithy.api#documentation": "

    The identifier of the manual DB snapshot that the attributes apply to.

    " + "smithy.api#documentation": "

    The list of attributes and values for the manual DB snapshot.

    " } } }, @@ -6468,17 +6510,17 @@ "com.amazonaws.rds#DBSnapshotMessage": { "type": "structure", "members": { - "DBSnapshots": { - "target": "com.amazonaws.rds#DBSnapshotList", - "traits": { - "smithy.api#documentation": "

    \n A list of DBSnapshot instances.\n

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "DBSnapshots": { + "target": "com.amazonaws.rds#DBSnapshotList", + "traits": { + "smithy.api#documentation": "

    \n A list of DBSnapshot instances.\n

    " + } } }, "traits": { @@ -6501,22 +6543,16 @@ "com.amazonaws.rds#DBSubnetGroup": { "type": "structure", "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the DB subnet group.

    " - } - }, "DBSubnetGroupArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB subnet group.

    " } }, - "SubnetGroupStatus": { + "DBSubnetGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the status of the DB subnet group.

    " + "smithy.api#documentation": "

    Provides the description of the DB subnet group.

    " } }, "Subnets": { @@ -6525,16 +6561,22 @@ "smithy.api#documentation": "

    \n Contains a list of Subnet elements.\n

    " } }, - "DBSubnetGroupDescription": { + "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the description of the DB subnet group.

    " + "smithy.api#documentation": "

    Provides the VpcId of the DB subnet group.

    " } }, - "VpcId": { + "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the VpcId of the DB subnet group.

    " + "smithy.api#documentation": "

    The name of the DB subnet group.

    " + } + }, + "SubnetGroupStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Provides the status of the DB subnet group.

    " } } }, @@ -6769,6 +6811,12 @@ "com.amazonaws.rds#DeleteDBClusterMessage": { "type": "structure", "members": { + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

    \n \n

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

    \n     " + } + }, "FinalDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -6781,12 +6829,6 @@ "smithy.api#documentation": "

    The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match an existing DBClusterIdentifier.

      \n
      • \n
    ", "smithy.api#required": {} } - }, - "SkipFinalSnapshot": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

    \n \n

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

    \n     " - } } }, "traits": { @@ -6967,17 +7009,17 @@ "smithy.api#documentation": "

    A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted.\n If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot \n is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

    \n

    When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

    \n

    Specify skip when deleting a read replica.

    \n \n

    The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

    \n     " } }, - "DeleteAutomatedBackups": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

    " - } - }, "FinalDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.\n

    \n \n

    Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

    \n     \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    • \n

      Can't be specified when deleting a read replica.

      \n
      • \n
    " } + }, + "DeleteAutomatedBackups": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

    " + } } }, "traits": { @@ -7350,10 +7392,11 @@ "com.amazonaws.rds#DeregisterDBProxyTargetsRequest": { "type": "structure", "members": { - "TargetGroupName": { + "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the DBProxyTargetGroup.

    " + "smithy.api#documentation": "

    The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

    ", + "smithy.api#required": {} } }, "DBClusterIdentifiers": { @@ -7362,18 +7405,17 @@ "smithy.api#documentation": "

    One or more DB cluster identifiers.

    " } }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

    ", - "smithy.api#required": {} - } - }, "DBInstanceIdentifiers": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "

    One or more DB instance identifiers.

    " } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The identifier of the DBProxyTargetGroup.

    " + } } } }, @@ -7426,10 +7468,10 @@ "com.amazonaws.rds#DescribeCertificatesMessage": { "type": "structure", "members": { - "CertificateIdentifier": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match an existing CertificateIdentifier.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, "MaxRecords": { @@ -7438,16 +7480,16 @@ "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match an existing CertificateIdentifier.

      \n
      • \n
    " } }, - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } } }, @@ -7487,12 +7529,6 @@ "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    A filter that specifies one or more custom AZs to describe.

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { @@ -7504,6 +7540,12 @@ "traits": { "smithy.api#documentation": "

    The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

    " } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    A filter that specifies one or more custom AZs to describe.

    " + } } } }, @@ -7542,12 +7584,6 @@ "smithy.api#documentation": "

    A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

    \n
      \n
    • \n

      \n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.

      \n
      • \n
    • \n

      \n db-cluster-backtrack-status - Accepts any of the following backtrack status values:

      \n
        \n
      • \n

        \n applying\n

        \n
        • \n
      • \n

        \n completed\n

        \n
        • \n
      • \n

        \n failed\n

        \n
        • \n
      • \n

        \n pending\n

        \n
        • \n
      \n

      The results list includes information about only the backtracks identified\n by these values.

      \n
      • \n
    " } }, - "BacktrackIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    If specified, this value is the backtrack identifier of the backtrack to be\n described.

    \n

    Constraints:

    \n \n

    Example: 123e4567-e89b-12d3-a456-426655440000\n

    " - } - }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -7555,10 +7591,10 @@ "smithy.api#required": {} } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "BacktrackIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    If specified, this value is the backtrack identifier of the backtrack to be\n described.

    \n

    Constraints:

    \n \n

    Example: 123e4567-e89b-12d3-a456-426655440000\n

    " } }, "Marker": { @@ -7566,6 +7602,12 @@ "traits": { "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + } } }, "traits": { @@ -7598,10 +7640,10 @@ "com.amazonaws.rds#DescribeDBClusterEndpointsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

    " } }, "DBClusterEndpointIdentifier": { @@ -7610,22 +7652,22 @@ "smithy.api#documentation": "

    The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

    " } }, - "DBClusterIdentifier": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

    " + "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.\n

    " + "smithy.api#documentation": "

    A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.\n

    " } }, - "Marker": { - "target": "com.amazonaws.rds#String", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } } } @@ -7656,28 +7698,28 @@ "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    The name of a specific DB cluster parameter group to return details for.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBClusterParameterGroup.

      \n
      • \n
    " } }, - "DBClusterParameterGroupName": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of a specific DB cluster parameter group to return details for.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBClusterParameterGroup.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } } }, @@ -7711,18 +7753,6 @@ "com.amazonaws.rds#DescribeDBClusterParametersMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " - } - }, "Source": { "target": "com.amazonaws.rds#String", "traits": { @@ -7741,6 +7771,18 @@ "traits": { "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + } } }, "traits": { @@ -7813,28 +7855,34 @@ "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.

    \n

    You can give an AWS account permission to restore a manual DB cluster snapshot from\n another AWS account by the ModifyDBClusterSnapshotAttribute API action.

    " } }, - "DBClusterSnapshotIdentifier": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBClusterSnapshot.

      \n
      • \n
    • \n

      If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

      \n
      • \n
    " + "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The type of DB cluster snapshots to be returned. You can specify one of the following values:

    \n
      \n
    • \n

      \n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my AWS account.

      \n
      • \n
    • \n

      \n manual - Return all DB cluster snapshots that have been taken by my AWS account.

      \n
      • \n
    • \n

      \n shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

      \n
      • \n
    • \n

      \n public - Return all DB cluster snapshots that have been marked as public.

      \n
      • \n
    \n

    If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

    \n

    The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

    " + "smithy.api#documentation": "

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.

    \n

    You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

    " } }, - "DBClusterIdentifier": { + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + } + }, + "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBCluster.

      \n
      • \n
    " + "smithy.api#documentation": "

    A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBClusterSnapshot.

      \n
      • \n
    • \n

      If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

      \n
      • \n
    " } }, "Filters": { @@ -7843,22 +7891,16 @@ "smithy.api#documentation": "

    A filter that specifies one or more DB cluster snapshots to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).

      \n
      • \n
    • \n

      \n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

      \n
      • \n
    • \n

      \n snapshot-type - Accepts types of DB cluster snapshots.

      \n
      • \n
    • \n

      \n engine - Accepts names of database engines.

      \n
      • \n
    " } }, - "IncludePublic": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.

    \n

    You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

    " - } - }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.

    \n

    You can give an AWS account permission to restore a manual DB cluster snapshot from\n another AWS account by the ModifyDBClusterSnapshotAttribute API action.

    " + "smithy.api#documentation": "

    The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBCluster.

      \n
      • \n
    " } }, - "Marker": { + "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    The type of DB cluster snapshots to be returned. You can specify one of the following values:

    \n
      \n
    • \n

      \n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my AWS account.

      \n
      • \n
    • \n

      \n manual - Return all DB cluster snapshots that have been taken by my AWS account.

      \n
      • \n
    • \n

      \n shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

      \n
      • \n
    • \n

      \n public - Return all DB cluster snapshots that have been marked as public.

      \n
      • \n
    \n

    If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

    \n

    The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

    " } } }, @@ -7892,10 +7934,16 @@ "com.amazonaws.rds#DescribeDBClustersMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A filter that specifies one or more DB clusters to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about\n the DB clusters identified by these ARNs.

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, "IncludeShared": { @@ -7910,16 +7958,10 @@ "smithy.api#documentation": "

    The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match an existing DBClusterIdentifier.

      \n
      • \n
    " } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    A filter that specifies one or more DB clusters to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about\n the DB clusters identified by these ARNs.

      \n
      • \n
    " } } }, @@ -7948,16 +7990,22 @@ "com.amazonaws.rds#DescribeDBEngineVersionsMessage": { "type": "structure", "members": { - "EngineVersion": { + "ListSupportedTimezones": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to list the supported time zones for each engine version.

    \n

    If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.\n

    " + } + }, + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database engine version to return.

    \n

    Example: 5.1.49\n

    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "DefaultOnly": { - "target": "com.amazonaws.rds#Boolean", + "ListSupportedCharacterSets": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

    " + "smithy.api#documentation": "

    A value that indicates whether to list the supported character sets for each engine version.

    \n

    If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, \n the response includes a list of supported character sets for each engine version.\n

    " } }, "Filters": { @@ -7966,46 +8014,40 @@ "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "DefaultOnly": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

    " } }, - "Engine": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database engine to return.

    " - } - }, - "IncludeAll": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

    " + "smithy.api#documentation": "

    The database engine version to return.

    \n

    Example: 5.1.49\n

    " } }, - "Marker": { + "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    The name of a specific DB parameter group family to return details for.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match an existing DBParameterGroupFamily.

      \n
      • \n
    " } }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The name of a specific DB parameter group family to return details for.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match an existing DBParameterGroupFamily.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "ListSupportedCharacterSets": { + "IncludeAll": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to list the supported character sets for each engine version.

    \n

    If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, \n the response includes a list of supported character sets for each engine version.\n

    " + "smithy.api#documentation": "

    A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

    " } }, - "ListSupportedTimezones": { - "target": "com.amazonaws.rds#BooleanOptional", + "Engine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to list the supported time zones for each engine version.

    \n

    If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.\n

    " + "smithy.api#documentation": "

    The database engine to return.

    " } } } @@ -8036,34 +8078,34 @@ "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    The pagination token provided in the previous request. If this parameter is specified the response \n\t\t\tincludes only records beyond the marker, up to MaxRecords.

    " + "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
    • \n\t\t\t\t

      \n\t\t\t\t\t status\n\t\t\t\t

      \n\t\t\t
        \n
      • \n

        \n active - automated backups for current instances

        \n
        • \n
      • \n

        \n retained - automated backups for deleted instances

        \n
        • \n
      • \n

        \n creating - automated backups that are waiting\n\t\t\t for the first automated snapshot to be available

        \n
        • \n
      \n\t\t\t
      • \n
    • \n

      \n\t\t db-instance-id - Accepts DB instance identifiers and \n\t\t Amazon Resource Names (ARNs) for DB instances. The results list includes only information about\n\t\t the DB instance automated backupss identified by these ARNs.

      \n\t\t
      • \n
    • \n

      \n\t\t dbi-resource-id - Accepts DB instance resource identifiers and DB \n\t\t Amazon Resource Names (ARNs) for DB instances. The results list includes only information about\n\t\t the DB instance resources identified by these ARNs.

      \n\t\t
      • \n
    \n\t\t

    Returns all resources by default. The status for each resource is specified in the response.

    " } }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    (Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.

    " + "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist than the specified \n\t\t\tMaxRecords value, a pagination token called a marker is included in the response so that \n\t\t\tyou can retrieve the remaining results.

    " } }, - "DbiResourceId": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The resource ID of the DB instance that is the source of \n\t\t the automated backup. This parameter isn't case-sensitive.

    " + "smithy.api#documentation": "

    (Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "Marker": { + "target": "com.amazonaws.rds#String", "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
    • \n\t\t\t\t

      \n\t\t\t\t\t status\n\t\t\t\t

      \n\t\t\t
        \n
      • \n

        \n active - automated backups for current instances

        \n
        • \n
      • \n

        \n retained - automated backups for deleted instances

        \n
        • \n
      • \n

        \n creating - automated backups that are waiting\n\t\t\t for the first automated snapshot to be available

        \n
        • \n
      \n\t\t\t
      • \n
    • \n

      \n\t\t db-instance-id - Accepts DB instance identifiers and \n\t\t Amazon Resource Names (ARNs) for DB instances. The results list includes only information about\n\t\t the DB instance automated backupss identified by these ARNs.

      \n\t\t
      • \n
    • \n

      \n\t\t dbi-resource-id - Accepts DB instance resource identifiers and DB \n\t\t Amazon Resource Names (ARNs) for DB instances. The results list includes only information about\n\t\t the DB instance resources identified by these ARNs.

      \n\t\t
      • \n
    \n\t\t

    Returns all resources by default. The status for each resource is specified in the response.

    " + "smithy.api#documentation": "

    The pagination token provided in the previous request. If this parameter is specified the response \n\t\t\tincludes only records beyond the marker, up to MaxRecords.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "DbiResourceId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist than the specified \n\t\t\tMaxRecords value, a pagination token called a marker is included in the response so that \n\t\t\tyou can retrieve the remaining results.

    " + "smithy.api#documentation": "

    The resource ID of the DB instance that is the source of \n\t\t the automated backup. This parameter isn't case-sensitive.

    " } } }, @@ -8097,10 +8139,10 @@ "com.amazonaws.rds#DescribeDBInstancesMessage": { "type": "structure", "members": { - "DBInstanceIdentifier": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBInstance.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, "MaxRecords": { @@ -8109,16 +8151,16 @@ "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A filter that specifies one or more DB instances to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about \n the DB instances associated with the DB clusters identified by these ARNs.

      \n
      • \n
    • \n

      \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list will only include information about\n the DB instances identified by these ARNs.

      \n
      • \n
    • \n

      \n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.

      \n
      • \n
    • \n

      \n domain - Accepts Active Directory directory IDs. The results list will only \n include information about the DB instances associated with these domains.

      \n
      • \n
    • \n

      \n engine - Accepts engine names. The results list will only include information \n about the DB instances for these engines.

      \n
      • \n
    " + "smithy.api#documentation": "

    The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBInstance.

      \n
      • \n
    " } }, - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    A filter that specifies one or more DB instances to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about \n the DB instances associated with the DB clusters identified by these ARNs.

      \n
      • \n
    • \n

      \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list will only include information about\n the DB instances identified by these ARNs.

      \n
      • \n
    • \n

      \n dbi-resource-id - Accepts DB instance resource identifiers. The results list will \n only include information about the DB instances identified by these DB instance resource identifiers.

      \n
      • \n
    • \n

      \n domain - Accepts Active Directory directory IDs. The results list will only \n include information about the DB instances associated with these domains.

      \n
      • \n
    • \n

      \n engine - Accepts engine names. The results list will only include information \n about the DB instances for these engines.

      \n
      • \n
    " } } }, @@ -8152,12 +8194,6 @@ "com.amazonaws.rds#DescribeDBLogFilesDetails": { "type": "structure", "members": { - "LogFileName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the log file for the specified DB instance.

    " - } - }, "LastWritten": { "target": "com.amazonaws.rds#Long", "traits": { @@ -8169,6 +8205,12 @@ "traits": { "smithy.api#documentation": "

    The size, in bytes, of the log file for the specified DB instance.

    " } + }, + "LogFileName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the log file for the specified DB instance.

    " + } } }, "traits": { @@ -8187,10 +8229,17 @@ "com.amazonaws.rds#DescribeDBLogFilesMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "FileLastWritten": { + "target": "com.amazonaws.rds#Long", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

    " + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The customer-assigned name of the DB instance that contains the log files you want to list.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBInstance.

      \n
      • \n
    ", + "smithy.api#required": {} } }, "MaxRecords": { @@ -8199,16 +8248,10 @@ "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    " } }, - "FileLastWritten": { + "FileSize": { "target": "com.amazonaws.rds#Long", "traits": { - "smithy.api#documentation": "

    Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

    " - } - }, - "FilenameContains": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    Filters the available log files for log file names that contain the specified string.

    " + "smithy.api#documentation": "

    Filters the available log files for files larger than the specified size.

    " } }, "Marker": { @@ -8217,17 +8260,16 @@ "smithy.api#documentation": "

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    " } }, - "DBInstanceIdentifier": { + "FilenameContains": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The customer-assigned name of the DB instance that contains the log files you want to list.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBInstance.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Filters the available log files for log file names that contain the specified string.

    " } }, - "FileSize": { - "target": "com.amazonaws.rds#Long", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    Filters the available log files for files larger than the specified size.

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } } }, @@ -8281,6 +8323,12 @@ "com.amazonaws.rds#DescribeDBParameterGroupsMessage": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + } + }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { @@ -8298,12 +8346,6 @@ "traits": { "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " - } } }, "traits": { @@ -8336,18 +8378,6 @@ "com.amazonaws.rds#DescribeDBParametersMessage": { "type": "structure", "members": { - "Source": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The parameter types to return.

    \n

    Default: All parameter types returned

    \n

    Valid Values: user | system | engine-default\n

    " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " - } - }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { @@ -8366,6 +8396,18 @@ "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The parameter types to return.

    \n

    Default: All parameter types returned

    \n

    Valid Values: user | system | engine-default\n

    " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + } } } }, @@ -8395,18 +8437,6 @@ "com.amazonaws.rds#DescribeDBProxiesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    This parameter is not currently supported.

    " - } - }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the DB proxy.

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { @@ -8418,23 +8448,35 @@ "traits": { "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    This parameter is not currently supported.

    " + } + }, + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the DB proxy.

    " + } } } }, "com.amazonaws.rds#DescribeDBProxiesResponse": { "type": "structure", "members": { - "DBProxies": { - "target": "com.amazonaws.rds#DBProxyList", - "traits": { - "smithy.api#documentation": "

    A return value representing an arbitrary number of DBProxy data structures.

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "DBProxies": { + "target": "com.amazonaws.rds#DBProxyList", + "traits": { + "smithy.api#documentation": "

    A return value representing an arbitrary number of DBProxy data structures.

    " + } } } }, @@ -8470,16 +8512,10 @@ "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest": { "type": "structure", "members": { - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The identifier of the DBProxyTargetGroup to describe.

    " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", "traits": { - "smithy.api#documentation": "

    This parameter is not currently supported.

    " + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, "DBProxyName": { @@ -8489,16 +8525,22 @@ "smithy.api#required": {} } }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", + "Marker": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "Marker": { + "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    The identifier of the DBProxyTargetGroup to describe.

    " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    This parameter is not currently supported.

    " } } } @@ -8555,10 +8597,11 @@ "com.amazonaws.rds#DescribeDBProxyTargetsRequest": { "type": "structure", "members": { - "TargetGroupName": { + "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the DBProxyTargetGroup to describe.

    " + "smithy.api#documentation": "

    The identifier of the DBProxyTarget to describe.

    ", + "smithy.api#required": {} } }, "MaxRecords": { @@ -8567,11 +8610,16 @@ "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "DBProxyName": { + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    This parameter is not currently supported.

    " + } + }, + "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the DBProxyTarget to describe.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The identifier of the DBProxyTargetGroup to describe.

    " } }, "Marker": { @@ -8579,29 +8627,23 @@ "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    This parameter is not currently supported.

    " - } } } }, "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " - } - }, "Targets": { "target": "com.amazonaws.rds#TargetList", "traits": { "smithy.api#documentation": "

    An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + } } } }, @@ -8631,10 +8673,10 @@ "com.amazonaws.rds#DescribeDBSecurityGroupsMessage": { "type": "structure", "members": { - "Marker": { + "DBSecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    The name of the DB security group to return details for.

    " } }, "Filters": { @@ -8643,17 +8685,17 @@ "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } }, - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the DB security group to return details for.

    " - } - }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + } } }, "traits": { @@ -8726,40 +8768,40 @@ "com.amazonaws.rds#DescribeDBSnapshotsMessage": { "type": "structure", "members": { - "SnapshotType": { - "target": "com.amazonaws.rds#String", + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The type of snapshots to be returned. You can specify one of the following values:

    \n
      \n
    • \n

      \n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my AWS account.

      \n
      • \n
    • \n

      \n manual - Return all DB snapshots that have been taken by my AWS account.

      \n
      • \n
    • \n

      \n shared - Return all manual DB snapshots that have been shared to my AWS account.

      \n
      • \n
    • \n

      \n public - Return all DB snapshots that have been marked as public.

      \n
      • \n
    • \n

      \n awsbackup - Return the DB snapshots managed by the AWS Backup service.

      \n

      For information about AWS Backup, see the \n \n AWS Backup Developer Guide.\n \n

      \n

      The awsbackup type does not apply to Aurora.

      \n
      • \n
    \n

    If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

    \n

    The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

    " + "smithy.api#documentation": "

    A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.

    \n

    You can give an AWS account permission to restore a manual DB snapshot from\n another AWS account by using the ModifyDBSnapshotAttribute API action.

    " } }, - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    A filter that specifies one or more DB snapshots to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).

      \n
      • \n
    • \n

      \n db-snapshot-id - Accepts DB snapshot identifiers.

      \n
      • \n
    • \n

      \n dbi-resource-id - Accepts identifiers of source DB instances.

      \n
      • \n
    • \n

      \n snapshot-type - Accepts types of DB snapshots.

      \n
      • \n
    • \n

      \n engine - Accepts names of database engines.

      \n
      • \n
    " } }, - "IncludePublic": { - "target": "com.amazonaws.rds#Boolean", + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.

    \n

    You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

    " + "smithy.api#documentation": "

    \n A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBSnapshot.

      \n
      • \n
    • \n

      If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

      \n
      • \n
    " } }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", + "Marker": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.

    \n

    You can give an AWS account permission to restore a manual DB snapshot from\n another AWS account by using the ModifyDBSnapshotAttribute API action.

    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A filter that specifies one or more DB snapshots to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).

      \n
      • \n
    • \n

      \n db-snapshot-id - Accepts DB snapshot identifiers.

      \n
      • \n
    • \n

      \n dbi-resource-id - Accepts identifiers of source DB instances.

      \n
      • \n
    • \n

      \n snapshot-type - Accepts types of DB snapshots.

      \n
      • \n
    • \n

      \n engine - Accepts names of database engines.

      \n
      • \n
    " + "smithy.api#documentation": "

    The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter can't be used in conjunction with DBSnapshotIdentifier.\n This parameter isn't case-sensitive.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBInstance.

      \n
      • \n
    " } }, - "DBSnapshotIdentifier": { + "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBSnapshot.

      \n
      • \n
    • \n

      If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

      \n
      • \n
    " + "smithy.api#documentation": "

    A specific DB resource ID to describe.

    " } }, "MaxRecords": { @@ -8768,16 +8810,16 @@ "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    A specific DB resource ID to describe.

    " + "smithy.api#documentation": "

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.

    \n

    You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

    " } }, - "DBInstanceIdentifier": { + "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter can't be used in conjunction with DBSnapshotIdentifier.\n This parameter isn't case-sensitive.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the identifier of an existing DBInstance.

      \n
      • \n
    " + "smithy.api#documentation": "

    The type of snapshots to be returned. You can specify one of the following values:

    \n
      \n
    • \n

      \n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my AWS account.

      \n
      • \n
    • \n

      \n manual - Return all DB snapshots that have been taken by my AWS account.

      \n
      • \n
    • \n

      \n shared - Return all manual DB snapshots that have been shared to my AWS account.

      \n
      • \n
    • \n

      \n public - Return all DB snapshots that have been marked as public.

      \n
      • \n
    • \n

      \n awsbackup - Return the DB snapshots managed by the AWS Backup service.

      \n

      For information about AWS Backup, see the \n \n AWS Backup Developer Guide.\n \n

      \n

      The awsbackup type does not apply to Aurora.

      \n
      • \n
    \n

    If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

    \n

    The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

    " } } }, @@ -8817,10 +8859,10 @@ "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } }, - "DBSubnetGroupName": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB subnet group to return details for.

    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, "MaxRecords": { @@ -8829,10 +8871,10 @@ "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "Marker": { + "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    The name of the DB subnet group to return details for.

    " } } }, @@ -8855,23 +8897,17 @@ "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { "type": "structure", "members": { - "Marker": { + "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    The name of the DB cluster parameter group family to return engine parameter information for.

    ", + "smithy.api#required": {} } }, - "DBParameterGroupFamily": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB cluster parameter group family to return engine parameter information for.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, "MaxRecords": { @@ -8879,6 +8915,12 @@ "traits": { "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + } } }, "traits": { @@ -8902,23 +8944,22 @@ "target": "com.amazonaws.rds#DescribeEngineDefaultParametersResult" }, "traits": { - "smithy.api#documentation": "

    Returns the default engine and system parameter information for the specified database engine.

    " + "smithy.api#documentation": "

    Returns the default engine and system parameter information for the specified database engine.

    ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "EngineDefaults.Marker", + "items": "EngineDefaults.Parameters", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.rds#DescribeEngineDefaultParametersMessage": { "type": "structure", "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group family.

    ", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } }, "MaxRecords": { @@ -8927,10 +8968,17 @@ "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "Marker": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the DB parameter group family.

    ", + "smithy.api#required": {} } } }, @@ -8955,7 +9003,7 @@ "target": "com.amazonaws.rds#EventCategoriesMessage" }, "traits": { - "smithy.api#documentation": "

    Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can see a list of the event categories and source types \n in the \n Events topic in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can see a list of the event categories and source types \n in \n Events in the Amazon RDS User Guide.\n

    " } }, "com.amazonaws.rds#DescribeEventCategoriesMessage": { @@ -8970,7 +9018,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The type of source that is generating the events.

    \n

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    " + "smithy.api#documentation": "

    The type of source that is generating the events.

    \n

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot\n

    " } } }, @@ -8992,7 +9040,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    \n

    If you specify a SubscriptionName, lists the description for that subscription.

    ", + "smithy.api#documentation": "

    Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    \n

    If you specify a SubscriptionName, lists the description for that subscription.

    ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9004,6 +9052,12 @@ "com.amazonaws.rds#DescribeEventSubscriptionsMessage": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " + } + }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { @@ -9021,12 +9075,6 @@ "traits": { "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " - } } }, "traits": { @@ -9042,7 +9090,7 @@ "target": "com.amazonaws.rds#EventsMessage" }, "traits": { - "smithy.api#documentation": "

    Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

    ", + "smithy.api#documentation": "

    Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days. \n Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be \n obtained by providing the name as a parameter.

    \n \n

    By default, the past hour of events are returned.

    \n     ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9054,28 +9102,22 @@ "com.amazonaws.rds#DescribeEventsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " - } - }, - "SourceType": { - "target": "com.amazonaws.rds#SourceType", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The event source to retrieve events for. If no value is specified, all events are returned.

    " + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "Marker": { - "target": "com.amazonaws.rds#String", + "EndTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    \n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

    \n

    Example: 2009-07-08T18:00Z

    " } }, - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", + "StartTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

    \n

    Constraints:

    \n
      \n
    • \n

      If SourceIdentifier is supplied, SourceType must also be provided.

      \n
      • \n
    • \n

      If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

      \n
      • \n
    • \n

      If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

      \n
      • \n
    • \n

      If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

      \n
      • \n
    • \n

      If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

    \n

    Example: 2009-07-08T18:00Z

    " } }, "EventCategories": { @@ -9084,28 +9126,34 @@ "smithy.api#documentation": "

    A list of event categories that trigger notifications for a event notification subscription.

    " } }, - "StartTime": { - "target": "com.amazonaws.rds#TStamp", + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

    \n

    Example: 2009-07-08T18:00Z

    " + "smithy.api#documentation": "

    The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

    \n

    Constraints:

    \n
      \n
    • \n

      If SourceIdentifier is supplied, SourceType must also be provided.

      \n
      • \n
    • \n

      If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

      \n
      • \n
    • \n

      If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " } }, - "MaxRecords": { + "Duration": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    The number of minutes to retrieve events for.

    \n

    Default: 60

    " } }, - "EndTime": { - "target": "com.amazonaws.rds#TStamp", + "SourceType": { + "target": "com.amazonaws.rds#SourceType", "traits": { - "smithy.api#documentation": "

    \n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

    \n

    Example: 2009-07-08T18:00Z

    " + "smithy.api#documentation": "

    The event source to retrieve events for. If no value is specified, all events are returned.

    " } }, - "Duration": { - "target": "com.amazonaws.rds#IntegerOptional", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    The number of minutes to retrieve events for.

    \n

    Default: 60

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } } }, @@ -9139,10 +9187,10 @@ "com.amazonaws.rds#DescribeExportTasksMessage": { "type": "structure", "members": { - "Marker": { + "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.\n

    " + "smithy.api#documentation": "

    The identifier of the snapshot export task to be described.

    " } }, "MaxRecords": { @@ -9151,22 +9199,22 @@ "smithy.api#documentation": "

    \n The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "SourceArn": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

    " + "smithy.api#documentation": "

    Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

    \n

    Supported filters include the following:

    \n
      \n
    • \n

      \n export-task-identifier - An identifier for the snapshot export task.

      \n
      • \n
    • \n

      \n s3-bucket - The Amazon S3 bucket the snapshot is exported to.

      \n
      • \n
    • \n

      \n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

      \n
      • \n
    • \n

      \n status - The status of the export task. Must be lowercase, for example, complete.

      \n
      • \n
    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "Marker": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Filters specify one or more snapshot exports to describe. The filters are specified\n as name-value pairs that define what to include in the output.

    \n

    Supported filters include the following:

    \n
      \n
    • \n

      \n export-task-identifier - An identifier for the snapshot export task.

      \n
      • \n
    • \n

      \n s3-bucket - The Amazon S3 bucket the snapshot is exported to.

      \n
      • \n
    • \n

      \n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

      \n
      • \n
    • \n

      \n status - The status of the export task.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.\n

    " } }, - "ExportTaskIdentifier": { + "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the snapshot export task to be described.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

    " } } } @@ -9197,28 +9245,28 @@ "com.amazonaws.rds#DescribeGlobalClustersMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "Marker": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A filter that specifies one or more global DB clusters to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about\n the DB clusters identified by these ARNs.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.\n

    " } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    A filter that specifies one or more global DB clusters to describe.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include information about\n the DB clusters identified by these ARNs.

      \n
      • \n
    " } }, - "Marker": { + "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    \n The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match an existing DBClusterIdentifier.

      \n
      • \n
    " } }, - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    \n The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match an existing DBClusterIdentifier.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } } } @@ -9249,16 +9297,16 @@ "com.amazonaws.rds#DescribeInstallationMediaMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "Marker": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

    " + "smithy.api#documentation": "

    An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A filter that specifies one or more installation media to describe. Supported filters\n include the following:

    \n
      \n
    • \n

      \n custom-availability-zone-id - Accepts custom Availability Zone (AZ)\n identifiers. The results list includes information about only the custom AZs\n identified by these identifiers.

      \n
      • \n
    • \n

      \n engine - Accepts database engines. The results list includes information about \n only the database engines identified by these identifiers.

      \n

      For more information about the valid engines for installation media, see ImportInstallationMedia.

      \n
      • \n
    " + "smithy.api#documentation": "

    An optional pagination token provided by a previous DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

    " } }, "InstallationMediaId": { @@ -9267,10 +9315,10 @@ "smithy.api#documentation": "

    The installation medium ID.

    " } }, - "Marker": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " + "smithy.api#documentation": "

    A filter that specifies one or more installation media to describe. Supported filters\n include the following:

    \n
      \n
    • \n

      \n custom-availability-zone-id - Accepts custom Availability Zone (AZ)\n identifiers. The results list includes information about only the custom AZs\n identified by these identifiers.

      \n
      • \n
    • \n

      \n engine - Accepts database engines. The results list includes information about \n only the database engines identified by these identifiers.

      \n

      For more information about the valid engines for installation media, see ImportInstallationMedia.

      \n
      • \n
    " } } } @@ -9296,24 +9344,18 @@ "com.amazonaws.rds#DescribeOptionGroupOptionsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    If specified, filters the results to include only options for the specified major engine version.

    " - } - }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + } + }, "EngineName": { "target": "com.amazonaws.rds#String", "traits": { @@ -9321,10 +9363,16 @@ "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "Marker": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    If specified, filters the results to include only options for the specified major engine version.

    " } } }, @@ -9358,16 +9406,10 @@ "com.amazonaws.rds#DescribeOptionGroupsMessage": { "type": "structure", "members": { - "MajorEngineVersion": { + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

    " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

    " } }, "Marker": { @@ -9376,10 +9418,10 @@ "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } }, "EngineName": { @@ -9388,10 +9430,16 @@ "smithy.api#documentation": "

    Filters the list of option groups to only include groups associated with a specific database engine.

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

    " } } }, @@ -9420,28 +9468,10 @@ "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage": { "type": "structure", "members": { - "AvailabilityZoneGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

    \n

    Omit this parameter to show the available offerings in the specified AWS Region.

    " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " - } - }, - "LicenseModel": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " } }, "DBInstanceClass": { @@ -9463,16 +9493,34 @@ "smithy.api#documentation": "

    The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

    " } }, - "Marker": { + "Vpc": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to show only VPC or non-VPC offerings.

    " + } + }, + "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " + "smithy.api#documentation": "

    The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

    " } }, - "Vpc": { - "target": "com.amazonaws.rds#BooleanOptional", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to show only VPC or non-VPC offerings.

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

    \n

    Omit this parameter to show the available offerings in the specified AWS Region.

    " } } }, @@ -9506,18 +9554,6 @@ "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage": { "type": "structure", "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The ARN of a resource to return pending maintenance actions for.

    " - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n

    " - } - }, "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { @@ -9529,6 +9565,18 @@ "traits": { "smithy.api#documentation": "

    A filter that specifies one or more resources to return pending maintenance actions for.

    \n

    Supported filters:

    \n
      \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance \n actions for the DB clusters identified by these ARNs.

      \n
      • \n
    • \n

      \n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list will only include pending maintenance \n actions for the DB instances identified by these ARNs.

      \n
      • \n
    " } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The ARN of a resource to return pending maintenance actions for.

    " + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n

    " + } } }, "traits": { @@ -9561,34 +9609,34 @@ "com.amazonaws.rds#DescribeReservedDBInstancesMessage": { "type": "structure", "members": { - "ProductDescription": { + "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

    " + "smithy.api#documentation": "

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    \n

    Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

    " } }, - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } }, - "Duration": { - "target": "com.amazonaws.rds#String", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    \n

    Valid Values: 1 | 3 | 31536000 | 94608000\n

    " + "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, - "DBInstanceClass": { + "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

    " + "smithy.api#documentation": "

    The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

    " } }, - "LeaseId": { - "target": "com.amazonaws.rds#String", + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

    \n \n

    AWS Support might request the lease ID for an issue related to a reserved DB instance.

    \n     " + "smithy.api#documentation": "

    A value that indicates whether to show only those reservations that support Multi-AZ.

    " } }, "ReservedDBInstanceId": { @@ -9597,34 +9645,34 @@ "smithy.api#documentation": "

    The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

    " } }, - "Marker": { + "Duration": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " + "smithy.api#documentation": "

    The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    \n

    Valid Values: 1 | 3 | 31536000 | 94608000\n

    " } }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "ProductDescription": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

    " } }, - "OfferingType": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    \n

    Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

    " + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to show only those reservations that support Multi-AZ.

    " + "smithy.api#documentation": "

    The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "LeaseId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.\n

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

    \n \n

    AWS Support might request the lease ID for an issue related to a reserved DB instance.

    \n     " } } }, @@ -9658,22 +9706,10 @@ "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage": { "type": "structure", "members": { - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    " - } - }, - "ReservedDBInstancesOfferingId": { + "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

    \n

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

    " - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to show only those reservations that support Multi-AZ.

    " + "smithy.api#documentation": "

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    \n

    Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

    " } }, "Filters": { @@ -9688,10 +9724,16 @@ "smithy.api#documentation": "

    Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

    \n \n

    The results show offerings that partially match the filter value.

    \n     " } }, - "Duration": { + "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    \n

    Valid Values: 1 | 3 | 31536000 | 94608000\n

    " + "smithy.api#documentation": "

    The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

    \n

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

    " + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    " } }, "Marker": { @@ -9700,10 +9742,16 @@ "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } }, - "OfferingType": { + "Duration": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    \n

    Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

    " + "smithy.api#documentation": "

    Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    \n

    Valid Values: 1 | 3 | 31536000 | 94608000\n

    " + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to show only those reservations that support Multi-AZ.

    " } }, "MaxRecords": { @@ -9738,10 +9786,10 @@ "com.amazonaws.rds#DescribeSourceRegionsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.rds#FilterList", + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    This parameter isn't currently supported.

    " + "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " } }, "Marker": { @@ -9756,10 +9804,10 @@ "smithy.api#documentation": "

    The source AWS Region name. For example, us-east-1.

    \n

    Constraints:

    \n
      \n
    • \n

      Must specify a valid AWS Region name.

      \n
      • \n
    " } }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", + "Filters": { + "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

    \n

    Default: 100

    \n

    Constraints: Minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    This parameter isn't currently supported.

    " } } }, @@ -9813,28 +9861,28 @@ "com.amazonaws.rds#DomainMembership": { "type": "structure", "members": { - "IAMRoleName": { + "FQDN": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    The fully qualified domain name of the Active Directory Domain.

    " } }, - "Domain": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the Active Directory Domain.

    " + "smithy.api#documentation": "

    The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

    " } }, - "FQDN": { + "IAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The fully qualified domain name of the Active Directory Domain.

    " + "smithy.api#documentation": "

    The name of the IAM role to be used when making API calls to the Directory Service.

    " } }, - "Status": { + "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

    " + "smithy.api#documentation": "

    The identifier of the Active Directory Domain.

    " } } }, @@ -9928,16 +9976,16 @@ "com.amazonaws.rds#DownloadDBLogFilePortionDetails": { "type": "structure", "members": { - "Marker": { + "LogFileData": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a later DownloadDBLogFilePortion request.

    " + "smithy.api#documentation": "

    Entries from the specified log file.

    " } }, - "LogFileData": { + "Marker": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Entries from the specified log file.

    " + "smithy.api#documentation": "

    A pagination token that can be used in a later DownloadDBLogFilePortion request.

    " } }, "AdditionalDataPending": { @@ -9954,10 +10002,10 @@ "com.amazonaws.rds#DownloadDBLogFilePortionMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", + "NumberOfLines": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

    " + "smithy.api#documentation": "

    The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

    \n

    If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

    \n
      \n
    • \n

      If neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.

      \n
      • \n
    • \n

      If \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.

      \n
      • \n
    • \n

      If Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.

      \n
      • \n
    • \n

      You can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.

      \n
      • \n
    " } }, "LogFileName": { @@ -9967,18 +10015,18 @@ "smithy.api#required": {} } }, - "NumberOfLines": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#documentation": "

    The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

    \n

    If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

    \n
      \n
    • \n

      If neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.

      \n
      • \n
    • \n

      If \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.

      \n
      • \n
    • \n

      If Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.

      \n
      • \n
    • \n

      You can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.

      \n
      • \n
    " - } - }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The customer-assigned name of the DB instance that contains the log files you want to list.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBInstance.

      \n
      • \n
    ", "smithy.api#required": {} } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

    " + } } }, "traits": { @@ -9988,28 +10036,28 @@ "com.amazonaws.rds#EC2SecurityGroup": { "type": "structure", "members": { - "Status": { + "EC2SecurityGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " + "smithy.api#documentation": "

    Specifies the name of the EC2 security group.

    " } }, - "EC2SecurityGroupOwnerId": { + "EC2SecurityGroupId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

    " + "smithy.api#documentation": "

    Specifies the id of the EC2 security group.

    " } }, - "EC2SecurityGroupId": { + "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the id of the EC2 security group.

    " + "smithy.api#documentation": "

    \n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

    " } }, - "EC2SecurityGroupName": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the EC2 security group.

    " + "smithy.api#documentation": "

    Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " } } }, @@ -10029,10 +10077,10 @@ "com.amazonaws.rds#Endpoint": { "type": "structure", "members": { - "HostedZoneId": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " + "smithy.api#documentation": "

    Specifies the port that the database engine is listening on.

    " } }, "Address": { @@ -10041,10 +10089,10 @@ "smithy.api#documentation": "

    Specifies the DNS address of the DB instance.

    " } }, - "Port": { - "target": "com.amazonaws.rds#Integer", + "HostedZoneId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the port that the database engine is listening on.

    " + "smithy.api#documentation": "

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " } } }, @@ -10055,6 +10103,12 @@ "com.amazonaws.rds#EngineDefaults": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous \n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " + } + }, "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { @@ -10066,12 +10120,6 @@ "traits": { "smithy.api#documentation": "

    Specifies the name of the DB parameter group family that the engine default parameters apply to.

    " } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous \n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " - } } }, "traits": { @@ -10102,10 +10150,16 @@ "com.amazonaws.rds#Event": { "type": "structure", "members": { - "Date": { - "target": "com.amazonaws.rds#TStamp", + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the date and time of the event.

    " + "smithy.api#documentation": "

    Provides the identifier for the source of the event.

    " + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the event.

    " } }, "EventCategories": { @@ -10114,10 +10168,10 @@ "smithy.api#documentation": "

    Specifies the category for the event.

    " } }, - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", + "SourceType": { + "target": "com.amazonaws.rds#SourceType", "traits": { - "smithy.api#documentation": "

    Provides the identifier for the source of the event.

    " + "smithy.api#documentation": "

    Specifies the source type for this event.

    " } }, "Message": { @@ -10126,16 +10180,10 @@ "smithy.api#documentation": "

    Provides the text of this event.

    " } }, - "SourceType": { - "target": "com.amazonaws.rds#SourceType", - "traits": { - "smithy.api#documentation": "

    Specifies the source type for this event.

    " - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", + "Date": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the event.

    " + "smithy.api#documentation": "

    Specifies the date and time of the event.

    " } } }, @@ -10169,7 +10217,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the results of a successful invocation of the DescribeEventCategories action.

    " + "smithy.api#documentation": "

    Contains the results of a successful invocation of the DescribeEventCategories operation.

    " } }, "com.amazonaws.rds#EventCategoriesMapList": { @@ -10192,7 +10240,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Data returned from the DescribeEventCategories action.

    " + "smithy.api#documentation": "

    Data returned from the DescribeEventCategories operation.

    " } }, "com.amazonaws.rds#EventList": { @@ -10207,64 +10255,64 @@ "com.amazonaws.rds#EventSubscription": { "type": "structure", "members": { - "CustSubscriptionId": { + "SnsTopicArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The RDS event notification subscription Id.

    " + "smithy.api#documentation": "

    The topic ARN of the RDS event notification subscription.

    " } }, - "SourceIdsList": { - "target": "com.amazonaws.rds#SourceIdsList", + "EventSubscriptionArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of source IDs for the RDS event notification subscription.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the event subscription.

    " } }, - "SourceType": { - "target": "com.amazonaws.rds#String", + "Enabled": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The source type for the RDS event notification subscription.

    " + "smithy.api#documentation": "

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

    " } }, - "EventCategoriesList": { - "target": "com.amazonaws.rds#EventCategoriesList", + "CustSubscriptionId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of event categories for the RDS event notification subscription.

    " + "smithy.api#documentation": "

    The RDS event notification subscription Id.

    " } }, - "EventSubscriptionArn": { + "CustomerAwsId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the event subscription.

    " + "smithy.api#documentation": "

    The AWS customer account associated with the RDS event notification subscription.

    " } }, - "SnsTopicArn": { + "SubscriptionCreationTime": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The topic ARN of the RDS event notification subscription.

    " + "smithy.api#documentation": "

    The time the RDS event notification subscription was created.

    " } }, - "Status": { + "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of the RDS event notification subscription.

    \n

    Constraints:

    \n

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    \n

    The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

    " + "smithy.api#documentation": "

    The source type for the RDS event notification subscription.

    " } }, - "SubscriptionCreationTime": { - "target": "com.amazonaws.rds#String", + "SourceIdsList": { + "target": "com.amazonaws.rds#SourceIdsList", "traits": { - "smithy.api#documentation": "

    The time the RDS event notification subscription was created.

    " + "smithy.api#documentation": "

    A list of source IDs for the RDS event notification subscription.

    " } }, - "CustomerAwsId": { - "target": "com.amazonaws.rds#String", + "EventCategoriesList": { + "target": "com.amazonaws.rds#EventCategoriesList", "traits": { - "smithy.api#documentation": "

    The AWS customer account associated with the RDS event notification subscription.

    " + "smithy.api#documentation": "

    A list of event categories for the RDS event notification subscription.

    " } }, - "Enabled": { - "target": "com.amazonaws.rds#Boolean", + "Status": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

    " + "smithy.api#documentation": "

    The status of the RDS event notification subscription.

    \n

    Constraints:

    \n

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    \n

    The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

    " } } }, @@ -10346,10 +10394,16 @@ "smithy.api#documentation": "

    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

    " } }, - "TotalExtractedDataInGB": { - "target": "com.amazonaws.rds#Integer", + "KmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The total amount of data exported, in gigabytes.

    " + "smithy.api#documentation": "

    The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or\n the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.

    " + } + }, + "SnapshotTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

    The time that the snapshot was created.

    " } }, "SourceArn": { @@ -10358,16 +10412,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

    " } }, - "S3Bucket": { + "WarningMessage": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon S3 bucket that the snapshot is exported to.

    " + "smithy.api#documentation": "

    A warning about the snapshot export task.

    " } }, - "SnapshotTime": { - "target": "com.amazonaws.rds#TStamp", + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The time that the snapshot was created.

    " + "smithy.api#documentation": "

    A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.

    " } }, "Status": { @@ -10376,10 +10430,10 @@ "smithy.api#documentation": "

    The progress status of the export task.

    " } }, - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", + "TaskStartTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.

    " + "smithy.api#documentation": "

    The time that the snapshot export task started.

    " } }, "FailureCause": { @@ -10400,34 +10454,28 @@ "smithy.api#documentation": "

    The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or\n the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.

    " - } - }, "TaskEndTime": { "target": "com.amazonaws.rds#TStamp", "traits": { "smithy.api#documentation": "

    The time that the snapshot export task completed.

    " } }, - "ExportOnly": { - "target": "com.amazonaws.rds#StringList", + "TotalExtractedDataInGB": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The data exported from the snapshot. Valid values are the following:

    \n
      \n
    • \n

      \n database - Export all the data from a specified database.

      \n
      • \n
    • \n

      \n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      \n
      • \n
    • \n

      \n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    • \n

      \n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    " + "smithy.api#documentation": "

    The total amount of data exported, in gigabytes.

    " } }, - "WarningMessage": { + "S3Bucket": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A warning about the snapshot export task.

    " + "smithy.api#documentation": "

    The Amazon S3 bucket that the snapshot is exported to.

    " } }, - "TaskStartTime": { - "target": "com.amazonaws.rds#TStamp", + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    The time that the snapshot export task started.

    " + "smithy.api#documentation": "

    The data exported from the snapshot. Valid values are the following:

    \n
      \n
    • \n

      \n database - Export all the data from a specified database.

      \n
      • \n
    • \n

      \n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      \n
      • \n
    • \n

      \n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    • \n

      \n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    " } } }, @@ -10473,17 +10521,17 @@ "com.amazonaws.rds#ExportTasksMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.

    " - } - }, "ExportTasks": { "target": "com.amazonaws.rds#ExportTasksList", "traits": { "smithy.api#documentation": "

    Information about an export of a snapshot to Amazon S3.

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.

    " + } } } }, @@ -10548,17 +10596,17 @@ "com.amazonaws.rds#Filter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.rds#String", + "Values": { + "target": "com.amazonaws.rds#FilterValueList", "traits": { - "smithy.api#documentation": "

    The name of the filter. Filter names are case-sensitive.

    ", + "smithy.api#documentation": "

    One or more filter values. Filter values are case-sensitive.

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.rds#FilterValueList", + "Name": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    One or more filter values. Filter values are case-sensitive.

    ", + "smithy.api#documentation": "

    The name of the filter. Filter names are case-sensitive.

    ", "smithy.api#required": {} } } @@ -10588,10 +10636,10 @@ "com.amazonaws.rds#GlobalCluster": { "type": "structure", "members": { - "Engine": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The Aurora database engine used by the global database cluster.\n

    " + "smithy.api#documentation": "

    Indicates the database engine version.

    " } }, "GlobalClusterResourceId": { @@ -10600,22 +10648,16 @@ "smithy.api#documentation": "

    \n The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in\n AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.\n

    " } }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    Indicates the database engine version.

    " - } - }, - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "GlobalClusterMembers": { + "target": "com.amazonaws.rds#GlobalClusterMemberList", "traits": { - "smithy.api#documentation": "

    \n Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.\n

    " + "smithy.api#documentation": "

    \n The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to\n 1 item.\n

    " } }, - "GlobalClusterArn": { - "target": "com.amazonaws.rds#String", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the global database cluster.

    " + "smithy.api#documentation": "

    \n The deletion protection setting for the new global database cluster.\n

    " } }, "StorageEncrypted": { @@ -10624,28 +10666,34 @@ "smithy.api#documentation": "

    \n The storage encryption setting for the global database cluster.\n

    " } }, - "GlobalClusterMembers": { - "target": "com.amazonaws.rds#GlobalClusterMemberList", + "Status": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to\n 1 item.\n

    " + "smithy.api#documentation": "

    Specifies the current state of this global database cluster.

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", + "DatabaseName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The deletion protection setting for the new global database cluster.\n

    " + "smithy.api#documentation": "

    \n The default database name within the new global database cluster.\n

    " + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n The Aurora database engine used by the global database cluster.\n

    " } }, - "DatabaseName": { + "GlobalClusterArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The default database name within the new global database cluster.\n

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the global database cluster.

    " } }, - "Status": { + "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the current state of this global database cluster.

    " + "smithy.api#documentation": "

    \n Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.\n

    " } } }, @@ -10678,16 +10726,16 @@ "com.amazonaws.rds#GlobalClusterMember": { "type": "structure", "members": { - "GlobalWriteForwardingStatus": { - "target": "com.amazonaws.rds#WriteForwardingStatus", + "DBClusterArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

    " + "smithy.api#documentation": "

    \n The Amazon Resource Name (ARN) for each Aurora cluster.\n

    " } }, - "IsWriter": { - "target": "com.amazonaws.rds#Boolean", + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", "traits": { - "smithy.api#documentation": "

    \n Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.\n

    " + "smithy.api#documentation": "

    Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

    " } }, "Readers": { @@ -10696,10 +10744,10 @@ "smithy.api#documentation": "

    \n The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Aurora global database.\n

    " } }, - "DBClusterArn": { - "target": "com.amazonaws.rds#String", + "IsWriter": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    \n The Amazon Resource Name (ARN) for each Aurora cluster.\n

    " + "smithy.api#documentation": "

    \n Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.\n

    " } } }, @@ -10745,17 +10793,17 @@ "com.amazonaws.rds#GlobalClustersMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.\n

    " - } - }, "GlobalClusters": { "target": "com.amazonaws.rds#GlobalClusterList", "traits": { "smithy.api#documentation": "

    \n The list of global clusters returned by this request.\n

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.\n

    " + } } } }, @@ -10777,16 +10825,16 @@ "com.amazonaws.rds#IPRange": { "type": "structure", "members": { - "CIDRIP": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the IP range.

    " + "smithy.api#documentation": "

    Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " } }, - "Status": { + "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " + "smithy.api#documentation": "

    Specifies the IP range.

    " } } }, @@ -10852,38 +10900,38 @@ "com.amazonaws.rds#ImportInstallationMediaMessage": { "type": "structure", "members": { - "EngineVersion": { + "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    For a list of valid engine versions, call DescribeDBEngineVersions.

    \n

    The following are the database engines and links to information about the major and minor \n versions. The list only includes DB engines that require an on-premises \n customer provided license.

    \n \n

    \n Microsoft SQL Server\n

    \n \n

    See Version and Feature Support on Amazon RDS in the \n Amazon RDS User Guide.\n

    ", + "smithy.api#documentation": "

    The identifier of the custom Availability Zone (AZ) to import the installation media to.

    ", "smithy.api#required": {} } }, - "Engine": { + "OSInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the database engine to be used for this instance.\n

    \n \n

    The list only includes supported DB engines that require an on-premises \n customer provided license.\n

    \n \n

    Valid Values:\n

    \n
      \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The path to the installation medium for the operating system associated with the specified DB engine.

    \n

    Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso\n

    ", "smithy.api#required": {} } }, - "OSInstallationMediaPath": { + "EngineInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The path to the installation medium for the operating system associated with the specified DB engine.

    \n

    Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso\n

    ", + "smithy.api#documentation": "

    The path to the installation medium for the specified DB engine.

    \n

    Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso\n

    ", "smithy.api#required": {} } }, - "CustomAvailabilityZoneId": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the custom Availability Zone (AZ) to import the installation media to.

    ", + "smithy.api#documentation": "

    The name of the database engine to be used for this instance.\n

    \n \n

    The list only includes supported DB engines that require an on-premises \n customer provided license.\n

    \n \n

    Valid Values:\n

    \n
      \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    ", "smithy.api#required": {} } }, - "EngineInstallationMediaPath": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The path to the installation medium for the specified DB engine.

    \n

    Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso\n

    ", + "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    For a list of valid engine versions, call DescribeDBEngineVersions.

    \n

    The following are the database engines and links to information about the major and minor \n versions. The list only includes DB engines that require an on-premises \n customer provided license.

    \n \n

    \n Microsoft SQL Server\n

    \n \n

    See \n Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.\n

    ", "smithy.api#required": {} } } @@ -10892,52 +10940,52 @@ "com.amazonaws.rds#InstallationMedia": { "type": "structure", "members": { - "Status": { + "OSInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of the installation medium.

    " + "smithy.api#documentation": "

    The path to the installation medium for the operating system associated with the DB engine.

    " } }, - "EngineVersion": { + "CustomAvailabilityZoneId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The engine version of the DB engine.

    " + "smithy.api#documentation": "

    The custom Availability Zone (AZ) that contains the installation media.

    " } }, - "CustomAvailabilityZoneId": { + "EngineInstallationMediaPath": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The custom Availability Zone (AZ) that contains the installation media.

    " + "smithy.api#documentation": "

    The path to the installation medium for the DB engine.

    " } }, - "OSInstallationMediaPath": { + "InstallationMediaId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The path to the installation medium for the operating system associated with the DB engine.

    " + "smithy.api#documentation": "

    The installation medium ID.

    " } }, - "Engine": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB engine.

    " + "smithy.api#documentation": "

    The status of the installation medium.

    " } }, - "FailureCause": { - "target": "com.amazonaws.rds#InstallationMediaFailureCause", + "EngineVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If an installation media failure occurred, the cause of the failure.

    " + "smithy.api#documentation": "

    The engine version of the DB engine.

    " } }, - "InstallationMediaId": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The installation medium ID.

    " + "smithy.api#documentation": "

    The DB engine.

    " } }, - "EngineInstallationMediaPath": { - "target": "com.amazonaws.rds#String", + "FailureCause": { + "target": "com.amazonaws.rds#InstallationMediaFailureCause", "traits": { - "smithy.api#documentation": "

    The path to the installation medium for the DB engine.

    " + "smithy.api#documentation": "

    If an installation media failure occurred, the cause of the failure.

    " } } }, @@ -10984,17 +11032,17 @@ "com.amazonaws.rds#InstallationMediaMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " - } - }, "InstallationMedia": { "target": "com.amazonaws.rds#InstallationMediaList", "traits": { "smithy.api#documentation": "

    The list of InstallationMedia objects for the AWS account.

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " + } } } }, @@ -11024,6 +11072,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.rds#InsufficientDBClusterCapacityFault": { "type": "structure", "members": { @@ -11514,17 +11575,17 @@ "com.amazonaws.rds#ModifyCertificatesMessage": { "type": "structure", "members": { - "RemoveCustomerOverride": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

    " - } - }, "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The new default certificate identifier to override the current one with.

    \n

    To determine the valid values, use the describe-certificates AWS CLI\n command or the DescribeCertificates API operation.

    " } + }, + "RemoveCustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

    " + } } } }, @@ -11562,18 +11623,6 @@ "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { "type": "structure", "members": { - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The amount of time, in seconds, that Aurora Serverless tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

    \n
      \n
    • \n

      Value must be from 10 through 600.

      \n
      • \n
    " - } - }, - "Capacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The DB cluster capacity.

    \n

    When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.

    \n

    Constraints:

    \n
      \n
    • \n

      For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

      \n
      • \n
    • \n

      For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

      \n
      • \n
    " - } - }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -11586,6 +11635,18 @@ "traits": { "smithy.api#documentation": "

    The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

    \n

    \n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

    \n

    \n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

    " } + }, + "Capacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The DB cluster capacity.

    \n

    When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.

    \n

    Constraints:

    \n
      \n
    • \n

      For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

      \n
      • \n
    • \n

      For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

      \n
      • \n
    " + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The amount of time, in seconds, that Aurora Serverless tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

    \n
      \n
    • \n

      Value must be from 10 through 600.

      \n
      • \n
    " + } } } }, @@ -11671,10 +11732,10 @@ "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { "type": "structure", "members": { - "EndpointType": { - "target": "com.amazonaws.rds#String", + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    The type of the endpoint. One of: READER, WRITER, ANY.

    " + "smithy.api#documentation": "

    List of DB instance identifiers that are part of the custom endpoint group.

    " } }, "ExcludedMembers": { @@ -11683,52 +11744,46 @@ "smithy.api#documentation": "

    List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

    " } }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

    List of DB instance identifiers that are part of the custom endpoint group.

    " - } - }, "DBClusterEndpointIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

    ", "smithy.api#required": {} } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The type of the endpoint. One of: READER, WRITER, ANY.

    " + } } } }, "com.amazonaws.rds#ModifyDBClusterMessage": { "type": "structure", "members": { - "NewDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      The first character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-cluster2\n

    " - } - }, - "ApplyImmediately": { + "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.

    \n

    The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.

    \n

    By default, this parameter is disabled.

    " + "smithy.api#documentation": "

    A value that indicates whether major version upgrades are allowed.

    \n

    Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

    " } }, - "DBInstanceParameterGroupName": { - "target": "com.amazonaws.rds#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group to apply to all instances of the DB cluster.

    \n \n

    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes aren't\n applied during the next maintenance window but instead are applied immediately.

    \n     \n

    Default: The existing name setting

    \n

    Constraints:

    \n
      \n
    • \n

      The DB parameter group must be in the same DB parameter group family as this DB cluster.

      \n
      • \n
    • \n

      The DBInstanceParameterGroupName parameter is only valid in combination with \n the AllowMajorVersionUpgrade parameter.

      \n
      • \n
    " + "smithy.api#documentation": "

    A list of VPC security groups that the DB cluster will belong to.

    " } }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

    The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    " + "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " + "smithy.api#documentation": "

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 1 to 35

      \n
      • \n
    " } }, "DBClusterParameterGroupName": { @@ -11737,52 +11792,71 @@ "smithy.api#documentation": "

    The name of the DB cluster parameter group to use for the DB cluster.

    " } }, - "PreferredMaintenanceWindow": { + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

    " + } + }, + "NewDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n

    Constraints: Minimum 30-minute window.

    " + "smithy.api#documentation": "

    The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      The first character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-cluster2\n

    " } }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", + "DBInstanceParameterGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

    " + "smithy.api#documentation": "

    The name of the DB parameter group to apply to all instances of the DB cluster.

    \n \n

    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes aren't\n applied during the next maintenance window but instead are applied immediately.

    \n     \n

    Default: The existing name setting

    \n

    Constraints:

    \n
      \n
    • \n

      The DB parameter group must be in the same DB parameter group family as this DB cluster.

      \n
      • \n
    • \n

      The DBInstanceParameterGroupName parameter is only valid in combination with \n the AllowMajorVersionUpgrade parameter.

      \n
      • \n
    " } }, - "DeletionProtection": { + "EnableHttpEndpoint": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n

    " + "smithy.api#documentation": "

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.

    \n

    When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

    \n

    For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

    " } }, - "MasterUserPassword": { + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The port number on which the DB cluster accepts connections.

    \n

    Constraints: Value must be 1150-65535\n

    \n

    Default: The same port as the original DB cluster.

    " + } + }, + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n

    Constraints: Must contain from 8 to 41 characters.

    " + "smithy.api#documentation": "

    The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    " } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", + "OptionGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 1 to 35

      \n
      • \n
    " + "smithy.api#documentation": "

    A value that indicates that the DB cluster should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case, and the change \n is applied during the next maintenance window\n unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n

    \n

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    " } }, - "Domain": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.\n

    " + "smithy.api#documentation": "

    The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

    \n

    Constraints: This identifier must match the identifier of an existing DB\n cluster.

    ", + "smithy.api#required": {} } }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n

    Constraints: Must contain from 8 to 41 characters.

    " + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " + "smithy.api#documentation": "

    The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.\n

    \n

    For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

    " } }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "

    A value that indicates whether major version upgrades are allowed.

    \n

    Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

    " + "smithy.api#documentation": "

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

    " } }, "DomainIAMRoleName": { @@ -11791,22 +11865,16 @@ "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

    The port number on which the DB cluster accepts connections.

    \n

    Constraints: Value must be 1150-65535\n

    \n

    Default: The same port as the original DB cluster.

    " + "smithy.api#documentation": "

    The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

    " } }, - "EnableHttpEndpoint": { + "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint \n is disabled.

    \n

    When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless DB cluster. You can also query your database\n from inside the RDS console with the query editor.

    \n

    For more information, see Using the Data API for Aurora Serverless in the \n Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " } }, "EnableGlobalWriteForwarding": { @@ -11815,35 +11883,28 @@ "smithy.api#documentation": "

    A value that indicates whether to enable write operations to be forwarded\n from this cluster to the primary cluster in an Aurora global database. The\n resulting changes are replicated back to this cluster. This parameter only\n applies to DB clusters that are secondary clusters in an Aurora global database.\n By default, Aurora disallows write operations for secondary clusters.

    " } }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", - "traits": { - "smithy.api#documentation": "

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

    " - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

    " + "smithy.api#documentation": "

    A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.

    \n

    The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.

    \n

    By default, this parameter is disabled.

    " } }, - "OptionGroupName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates that the DB cluster should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case, and the change \n is applied during the next maintenance window\n unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n

    \n

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    " + "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n

    Constraints: Minimum 30-minute window.

    " } }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

    \n

    Constraints: This identifier must match the identifier of an existing DB\n cluster.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of VPC security groups that the DB cluster will belong to.

    " + "smithy.api#documentation": "

    The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " } } }, @@ -11874,17 +11935,17 @@ "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of parameters in the DB cluster parameter group to modify.

    ", + "smithy.api#documentation": "

    The name of the DB cluster parameter group to modify.

    ", "smithy.api#required": {} } }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "

    The name of the DB cluster parameter group to modify.

    ", + "smithy.api#documentation": "

    A list of parameters in the DB cluster parameter group to modify.

    ", "smithy.api#required": {} } } @@ -11927,30 +11988,30 @@ "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { "type": "structure", "members": { - "ValuesToAdd": { - "target": "com.amazonaws.rds#AttributeValueList", + "AttributeName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

    \n

    To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any AWS account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all AWS accounts.

    " + "smithy.api#documentation": "

    The name of the DB cluster snapshot attribute to modify.

    \n

    To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

    \n \n

    To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API action.

    \n     ", + "smithy.api#required": {} } }, - "ValuesToRemove": { + "ValuesToAdd": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

    A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

    \n

    To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

    " + "smithy.api#documentation": "

    A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

    \n

    To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any AWS account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all AWS accounts.

    " } }, - "AttributeName": { + "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB cluster snapshot attribute to modify.

    \n

    To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

    \n \n

    To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API action.

    \n     ", + "smithy.api#documentation": "

    The identifier for the DB cluster snapshot to modify the attributes for.

    ", "smithy.api#required": {} } }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

    The identifier for the DB cluster snapshot to modify the attributes for.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

    \n

    To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

    " } } }, @@ -12040,34 +12101,22 @@ "com.amazonaws.rds#ModifyDBInstanceMessage": { "type": "structure", "members": { - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " - } - }, - "MultiAZ": { + "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment. \n Changing this parameter doesn't result in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is \n enabled for this request.\n

    " + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " } }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

    \n

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " + "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " } }, - "DomainIAMRoleName": { + "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the IAM role to use when making API calls to the Directory Service.

    " - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    \n

    Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. \n These changes are applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another \n non-zero value, the change is asynchronously applied as soon as possible.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

    \n

    Default: Uses existing setting

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 0 to 35

      \n
      • \n
    • \n

      Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later

      \n
      • \n
    • \n

      Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5

      \n
      • \n
    • \n

      Can't be set to 0 if the DB instance is a source to read replicas

      \n
      • \n
    " + "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS\n encryption key.

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " } }, "PromotionTier": { @@ -12076,28 +12125,28 @@ "smithy.api#documentation": "

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n

    \n

    Default: 1

    \n

    Valid Values: 0 - 15

    " } }, - "PerformanceInsightsKMSKeyId": { + "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID\n is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS\n encryption key.

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " + "smithy.api#documentation": "

    Indicates the certificate that needs to be associated with the instance.

    " } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

    \n

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " } }, - "CopyTagsToSnapshot": { + "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment. \n Changing this parameter doesn't result in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is \n enabled for this request.\n

    " } }, - "NewDBInstanceIdentifier": { + "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The new DB instance identifier for the DB instance when renaming a DB\n instance. When you change the DB instance identifier, an instance \n reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored \n as a lowercase string. \n

    \n\n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      The first character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n

    Example: mydbinstance\n

    " + "smithy.api#documentation": "

    The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n

    \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.\n

    \n \n

    Default: Uses existing setting

    \n\n

    \n MariaDB\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n \n

    \n Microsoft SQL Server\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    \n \n

    \n MySQL\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n \n

    \n Oracle\n

    \n

    Constraints: Must contain from 8 to 30 characters.

    \n \n

    \n PostgreSQL\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    \n\n \n

    Amazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.\n

    \n     " } }, "CertificateRotationRestart": { @@ -12106,53 +12155,64 @@ "smithy.api#documentation": "

    A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

    \n

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

    \n \n

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    \n     \n

    If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

    \n " } }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

    \n

    A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

    " + "smithy.api#documentation": "

    The name of the IAM role to use when making API calls to the Directory Service.

    " } }, - "DBInstanceIdentifier": { + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "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.

    " + } + }, + "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB instance identifier. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBInstance.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " } }, - "OptionGroupName": { + "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n Indicates that the DB instance should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled \n for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n

    \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + "smithy.api#documentation": "

    The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

    \n

    For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "

    A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match existing VpcSecurityGroupIds.

      \n
      • \n
    " + "smithy.api#documentation": "

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

    \n

    A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

    " } }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + "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

    " } }, - "StorageType": { - "target": "com.amazonaws.rds#String", + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.\n

    \n

    If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.\n

    \n

    If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " + "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " } }, - "PerformanceInsightsRetentionPeriod": { + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

    " + } + }, + "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    \n

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

    \n

    Valid Values: 0, 1, 5, 10, 15, 30, 60\n

    " } }, - "EngineVersion": { + "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is eanbled for this request.\n

    \n

    For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

    \n

    For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

    " + "smithy.api#documentation": "

    \n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

    \n \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi

      \n
      • \n
    • \n

      Must be in Universal Time Coordinated (UTC)

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window

      \n
      • \n
    • \n

      Must be at least 30 minutes

      \n
      • \n
    " } }, "LicenseModel": { @@ -12161,16 +12221,16 @@ "smithy.api#documentation": "

    The license model for the DB instance.

    \n

    Valid values: license-included | bring-your-own-license | \n general-public-license\n

    " } }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is \n disabled.\n

    \n

    \n If this parameter is disabled, changes to the\n DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. \n Review the table of parameters in Modifying a DB Instance \n in the Amazon RDS User Guide. to see the impact of enabling\n or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.\n

    " + "smithy.api#documentation": "

    The new Provisioned IOPS (I/O operations per second) value for the RDS instance. \n

    \n

    Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.\n

    \n

    If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

    \n

    Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. \n

    \n

    Default: Uses existing setting

    " } }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The new amount of storage (in gibibytes) to allocate for the DB instance.\n

    \n \n

    For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.\n

    \n \n

    For the valid values for allocated storage for each engine,\n see CreateDBInstance.\n

    " + "smithy.api#documentation": "

    The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

    \n

    Default: Uses existing setting

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi

    \n

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    \n

    Constraints: Must be at least 30 minutes

    " } }, "TdeCredentialPassword": { @@ -12179,10 +12239,16 @@ "smithy.api#documentation": "

    The password for the given ARN from the key store in order to access the device.

    " } }, - "PreferredMaintenanceWindow": { + "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

    \n

    Default: Uses existing setting

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi

    \n

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    \n

    Constraints: Must be at least 30 minutes

    " + "smithy.api#documentation": "

    The name of the DB parameter group to apply to the DB instance. Changing this\n setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically and the\n parameter changes isn't applied during the next maintenance window.

    \n

    Default: Uses existing setting

    \n

    Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    " + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

    " } }, "AutoMinorVersionUpgrade": { @@ -12191,10 +12257,10 @@ "smithy.api#documentation": "

    \n A value that indicates whether minor version upgrades are applied automatically\n to the DB instance during the maintenance window. \n Changing this parameter doesn't result in an outage except in the following case \n and the change is asynchronously applied as soon as possible.\n An outage results if this parameter is enabled during the maintenance window, \n and a newer minor version is available, and RDS has enabled auto patching for that engine version.\n

    " } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The new Provisioned IOPS (I/O operations per second) value for the RDS instance. \n

    \n

    Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.\n

    \n

    If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

    \n

    Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. \n

    \n

    Default: Uses existing setting

    " + "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

    " } }, "EnablePerformanceInsights": { @@ -12203,10 +12269,16 @@ "smithy.api#documentation": "

    A value that indicates whether to enable Performance Insights for the DB instance.

    \n

    For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

    " } }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.\n

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    \n PubliclyAccessible only applies to DB instances in a VPC. \n The DB instance must be part of a public subnet and \n PubliclyAccessible must be enabled for it to be publicly accessible.\n

    \n

    Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

    " + "smithy.api#documentation": "

    The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    \n

    If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n

    \n

    Default: Uses existing setting

    " + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

    A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match existing VpcSecurityGroupIds.

      \n
      • \n
    " } }, "DBPortNumber": { @@ -12215,82 +12287,77 @@ "smithy.api#documentation": "

    The port number on which the database accepts connections.

    \n

    The value of the DBPortNumber parameter must not match any of the port values specified for options in the option\n group for the DB instance.

    \n

    Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately\n parameter.

    \n

    \n MySQL\n

    \n

    \n Default: 3306\n

    \n

    Valid values: 1150-65535\n

    \n

    \n MariaDB\n

    \n

    \n Default: 3306\n

    \n

    Valid values: 1150-65535\n

    \n

    \n PostgreSQL\n

    \n

    \n Default: 5432\n

    \n

    Valid values: 1150-65535\n

    \n

    Type: Integer

    \n

    \n Oracle\n

    \n

    \n Default: 1521\n

    \n

    Valid values: 1150-65535\n

    \n

    \n SQL Server\n

    \n

    \n Default: 1433\n

    \n

    Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

    \n

    \n Amazon Aurora\n

    \n

    \n Default: 3306\n

    \n

    Valid values: 1150-65535\n

    " } }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

    The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    \n

    If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n

    \n

    Default: Uses existing setting

    " + "smithy.api#documentation": "

    A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match existing DBSecurityGroups.

      \n
      • \n
    " } }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    \n

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

    \n

    Valid Values: 0, 1, 5, 10, 15, 30, 60\n

    " + "smithy.api#documentation": "

    A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

    \n

    Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    " } }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates the certificate that needs to be associated with the instance.

    " + "smithy.api#documentation": "

    A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is \n disabled.\n

    \n

    \n If this parameter is disabled, changes to the\n DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. \n Review the table of parameters in Modifying a DB Instance \n in the Amazon RDS User Guide. to see the impact of enabling\n or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.\n

    " } }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

    \n

    Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    " + "smithy.api#documentation": "

    The new amount of storage (in gibibytes) to allocate for the DB instance.\n

    \n \n

    For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.\n

    \n \n

    For the valid values for allocated storage for each engine,\n see CreateDBInstance.\n

    " } }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n

    \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.\n

    \n \n

    Default: Uses existing setting

    \n\n

    \n MariaDB\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n \n

    \n Microsoft SQL Server\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    \n \n

    \n MySQL\n

    \n

    Constraints: Must contain from 8 to 41 characters.

    \n \n

    \n Oracle\n

    \n

    Constraints: Must contain from 8 to 30 characters.

    \n \n

    \n PostgreSQL\n

    \n

    Constraints: Must contain from 8 to 128 characters.

    \n\n \n

    Amazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.\n

    \n     " + "smithy.api#documentation": "

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    \n

    Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. \n These changes are applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another \n non-zero value, the change is asynchronously applied as soon as possible.

    \n

    \n Amazon Aurora\n

    \n

    Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

    \n

    Default: Uses existing setting

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 0 to 35

      \n
      • \n
    • \n

      Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later

      \n
      • \n
    • \n

      Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5

      \n
      • \n
    • \n

      Can't be set to 0 if the DB instance is a source to read replicas

      \n
      • \n
    " } }, - "Domain": { + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n The domain must be created prior to this operation. Currently, only Microsoft SQL Server and \n Oracle DB instances can be created in an Active Directory Domain.\n

    \n

    For Microsoft SQL Server DB instances, Amazon RDS can use \n Windows Authentication to authenticate users that connect to the DB instance. For more\n information, see \n Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the \n Amazon RDS User Guide.

    \n

    For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. \n For more information, see \n Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    \n Indicates that the DB instance should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled \n for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n

    \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " } }, - "UseDefaultProcessorFeatures": { + "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.\n

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    \n PubliclyAccessible only applies to DB instances in a VPC. \n The DB instance must be part of a public subnet and \n PubliclyAccessible must be enabled for it to be publicly accessible.\n

    \n

    Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

    " } }, - "DBParameterGroupName": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group to apply to the DB instance. Changing this\n setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically and the\n parameter changes isn't applied during the next maintenance window.

    \n

    Default: Uses existing setting

    \n

    Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    " + "smithy.api#documentation": "

    \n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is eanbled for this request.\n

    \n

    For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

    \n

    For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

    " } }, - "MaxAllocatedStorage": { + "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " + "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " } }, - "PreferredBackupWindow": { + "NewDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n

    \n \n

    \n Amazon Aurora\n

    \n

    Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

    \n \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi

      \n
      • \n
    • \n

      Must be in Universal Time Coordinated (UTC)

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window

      \n
      • \n
    • \n

      Must be at least 30 minutes

      \n
      • \n
    " - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

    A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match existing DBSecurityGroups.

      \n
      • \n
    " + "smithy.api#documentation": "

    \n The new DB instance identifier for the DB instance when renaming a DB\n instance. When you change the DB instance identifier, an instance \n reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored \n as a lowercase string. \n

    \n\n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      The first character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n

    Example: mydbinstance\n

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", + "StorageType": { + "target": "com.amazonaws.rds#String", "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

    " + "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.\n

    \n

    If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.\n

    \n

    If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " } }, - "DBSubnetGroupName": { + "DBInstanceIdentifier": { "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 DB instance identifier. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBInstance.

      \n
      • \n
    ", + "smithy.api#required": {} } } }, @@ -12329,17 +12396,17 @@ "com.amazonaws.rds#ModifyDBParameterGroupMessage": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

    \n

    Valid Values (for the application method): immediate | pending-reboot\n

    \n \n

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

    \n     ", + "smithy.api#documentation": "

    The name of the DB parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBParameterGroup.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBParameterGroup.

      \n
      • \n
    ", + "smithy.api#documentation": "

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

    \n

    Valid Values (for the application method): immediate | pending-reboot\n

    \n \n

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

    \n     ", "smithy.api#required": {} } } @@ -12374,10 +12441,10 @@ "com.amazonaws.rds#ModifyDBProxyRequest": { "type": "structure", "members": { - "RequireTLS": { - "target": "com.amazonaws.rds#BooleanOptional", + "IdleClientTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.

    " + "smithy.api#documentation": "

    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

    " } }, "SecurityGroups": { @@ -12386,41 +12453,41 @@ "smithy.api#documentation": "

    The new list of security groups for the DBProxy.

    " } }, - "NewDBProxyName": { + "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    " + "smithy.api#documentation": "

    The identifier for the DBProxy to modify.

    ", + "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.rds#String", + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

    " + "smithy.api#documentation": "

    The new authentication settings for the DBProxy.

    " } }, - "DebugLogging": { - "target": "com.amazonaws.rds#BooleanOptional", + "NewDBProxyName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

    " + "smithy.api#documentation": "

    The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    " } }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", + "RequireTLS": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

    " + "smithy.api#documentation": "

    Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.

    " } }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", + "DebugLogging": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The identifier for the DBProxy to modify.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

    " } }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigList", + "RoleArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The new authentication settings for the DBProxy.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

    " } } } @@ -12462,17 +12529,16 @@ "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest": { "type": "structure", "members": { - "ConnectionPoolConfig": { - "target": "com.amazonaws.rds#ConnectionPoolConfiguration", + "NewName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The settings that determine the size and behavior of the connection pool for the target group.

    " + "smithy.api#documentation": "

    The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    " } }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfiguration", "traits": { - "smithy.api#documentation": "

    The name of the new proxy to which to assign the target group.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The settings that determine the size and behavior of the connection pool for the target group.

    " } }, "TargetGroupName": { @@ -12482,10 +12548,11 @@ "smithy.api#required": {} } }, - "NewName": { + "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    " + "smithy.api#documentation": "

    The name of the new proxy to which to assign the target group.

    ", + "smithy.api#required": {} } } } @@ -12544,19 +12611,6 @@ "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { "type": "structure", "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The identifier for the DB snapshot to modify the attributes for.

    ", - "smithy.api#required": {} - } - }, - "ValuesToRemove": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

    A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

    \n

    To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include \n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB snapshot. If you specify all, an AWS account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

    " - } - }, "ValuesToAdd": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { @@ -12569,6 +12623,19 @@ "smithy.api#documentation": "

    The name of the DB snapshot attribute to modify.

    \n

    To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, \n set this value to restore.

    \n \n

    To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.

    \n     ", "smithy.api#required": {} } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The identifier for the DB snapshot to modify the attributes for.

    ", + "smithy.api#required": {} + } + }, + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

    A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

    \n

    To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include \n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB snapshot. If you specify all, an AWS account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

    " + } } }, "traits": { @@ -12586,13 +12653,6 @@ "com.amazonaws.rds#ModifyDBSnapshotMessage": { "type": "structure", "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The identifier of the DB snapshot to modify.

    ", - "smithy.api#required": {} - } - }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { @@ -12604,6 +12664,13 @@ "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

    " } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The identifier of the DB snapshot to modify.

    ", + "smithy.api#required": {} + } } } }, @@ -12709,7 +12776,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    \n

    You can see a list of the event categories for a given SourceType \n in the Events topic in the Amazon RDS User Guide \n or by using the DescribeEventCategories action.

    " + "smithy.api#documentation": "

    Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    \n

    You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

    " } }, "com.amazonaws.rds#ModifyEventSubscriptionMessage": { @@ -12718,7 +12785,13 @@ "EventCategories": { "target": "com.amazonaws.rds#EventCategoriesList", "traits": { - "smithy.api#documentation": "

    \n A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType \n in the Events topic in the Amazon RDS User Guide \n or by using the DescribeEventCategories action.\n

    " + "smithy.api#documentation": "

    \n A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.\n

    " + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    " } }, "SubscriptionName": { @@ -12737,13 +12810,7 @@ "SourceType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. If this value isn't specified, all events are returned.

    \n

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    " - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    " + "smithy.api#documentation": "

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. If this value isn't specified, all events are returned.

    \n

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot \n

    " } } }, @@ -12782,6 +12849,12 @@ "com.amazonaws.rds#ModifyGlobalClusterMessage": { "type": "structure", "members": { + "NewGlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      The first character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-cluster2\n

    " + } + }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -12793,12 +12866,6 @@ "traits": { "smithy.api#documentation": "

    \n The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing global database cluster.

      \n
      • \n
    " } - }, - "NewGlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      The first character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-cluster2\n

    " - } } } }, @@ -12833,29 +12900,29 @@ "com.amazonaws.rds#ModifyOptionGroupMessage": { "type": "structure", "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the option group to be modified.

    \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    ", - "smithy.api#required": {} - } - }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#documentation": "

    A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

    " } }, + "OptionsToRemove": { + "target": "com.amazonaws.rds#OptionNamesList", + "traits": { + "smithy.api#documentation": "

    Options in this list are removed from the option group.

    " + } + }, "OptionsToInclude": { "target": "com.amazonaws.rds#OptionConfigurationList", "traits": { "smithy.api#documentation": "

    Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

    " } }, - "OptionsToRemove": { - "target": "com.amazonaws.rds#OptionNamesList", + "OptionGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Options in this list are removed from the option group.

    " + "smithy.api#documentation": "

    The name of the option group to be modified.

    \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    ", + "smithy.api#required": {} } } }, @@ -12874,103 +12941,103 @@ "com.amazonaws.rds#Option": { "type": "structure", "members": { - "OptionVersion": { - "target": "com.amazonaws.rds#String", + "OptionSettings": { + "target": "com.amazonaws.rds#OptionSettingConfigurationList", "traits": { - "smithy.api#documentation": "

    The version of the option.

    " + "smithy.api#documentation": "

    The option settings for this option.

    " } }, - "OptionDescription": { - "target": "com.amazonaws.rds#String", + "Persistent": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The description of the option.

    " + "smithy.api#documentation": "

    Indicate if this option is persistent.

    " } }, - "OptionSettings": { - "target": "com.amazonaws.rds#OptionSettingConfigurationList", + "DBSecurityGroupMemberships": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

    The option settings for this option.

    " + "smithy.api#documentation": "

    If the option requires access to a port, then this DB security group allows access to the port.

    " } }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "OptionName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If required, the port configured for this option to use.

    " + "smithy.api#documentation": "

    The name of the option.

    " } }, - "VpcSecurityGroupMemberships": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "OptionVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If the option requires access to a port, then this VPC security group allows access to the port.

    " + "smithy.api#documentation": "

    The version of the option.

    " } }, - "Permanent": { - "target": "com.amazonaws.rds#Boolean", + "OptionDescription": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicate if this option is permanent.

    " + "smithy.api#documentation": "

    The description of the option.

    " } }, - "Persistent": { - "target": "com.amazonaws.rds#Boolean", + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

    Indicate if this option is persistent.

    " + "smithy.api#documentation": "

    If the option requires access to a port, then this VPC security group allows access to the port.

    " } }, - "OptionName": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The name of the option.

    " + "smithy.api#documentation": "

    If required, the port configured for this option to use.

    " } }, - "DBSecurityGroupMemberships": { - "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "Permanent": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    If the option requires access to a port, then this DB security group allows access to the port.

    " + "smithy.api#documentation": "

    Indicate if this option is permanent.

    " } } }, "traits": { "smithy.api#documentation": "

    Option details.

    " } - }, - "com.amazonaws.rds#OptionConfiguration": { - "type": "structure", - "members": { - "VpcSecurityGroupMemberships": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

    A list of VpcSecurityGroupMembership name strings used for this option.

    " - } - }, - "OptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The configuration of options to include in a group.

    ", - "smithy.api#required": {} - } - }, + }, + "com.amazonaws.rds#OptionConfiguration": { + "type": "structure", + "members": { "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

    The optional port for the option.

    " } }, + "OptionVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The version for the option.

    " + } + }, "OptionSettings": { "target": "com.amazonaws.rds#OptionSettingsList", "traits": { "smithy.api#documentation": "

    The option settings to include in an option group.

    " } }, + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

    A list of VpcSecurityGroupMembership name strings used for this option.

    " + } + }, "DBSecurityGroupMemberships": { "target": "com.amazonaws.rds#DBSecurityGroupNameList", "traits": { "smithy.api#documentation": "

    A list of DBSecurityGroupMembership name strings used for this option.

    " } }, - "OptionVersion": { + "OptionName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version for the option.

    " + "smithy.api#documentation": "

    The configuration of options to include in a group.

    ", + "smithy.api#required": {} } } }, @@ -12990,16 +13057,16 @@ "com.amazonaws.rds#OptionGroup": { "type": "structure", "members": { - "OptionGroupDescription": { + "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides a description of the option group.

    " + "smithy.api#documentation": "

    Indicates the name of the engine that this option group can be applied to.

    " } }, - "Options": { - "target": "com.amazonaws.rds#OptionsList", + "OptionGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates what options are available in the option group.

    " + "smithy.api#documentation": "

    Specifies the name of the option group.

    " } }, "OptionGroupArn": { @@ -13008,34 +13075,34 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the option group.

    " } }, - "EngineName": { + "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates the name of the engine that this option group can be applied to.

    " + "smithy.api#documentation": "

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n

    " } }, - "MajorEngineVersion": { + "OptionGroupDescription": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates the major engine version associated with this option group.

    " + "smithy.api#documentation": "

    Provides a description of the option group.

    " } }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", + "AllowsVpcAndNonVpcInstanceMemberships": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the name of the option group.

    " + "smithy.api#documentation": "

    Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.\n

    " } }, - "VpcId": { + "MajorEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n

    " + "smithy.api#documentation": "

    Indicates the major engine version associated with this option group.

    " } }, - "AllowsVpcAndNonVpcInstanceMemberships": { - "target": "com.amazonaws.rds#Boolean", + "Options": { + "target": "com.amazonaws.rds#OptionsList", "traits": { - "smithy.api#documentation": "

    Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.\n

    " + "smithy.api#documentation": "

    Indicates what options are available in the option group.

    " } } }, @@ -13101,34 +13168,34 @@ "com.amazonaws.rds#OptionGroupOption": { "type": "structure", "members": { - "EngineName": { - "target": "com.amazonaws.rds#String", + "OptionsConflictsWith": { + "target": "com.amazonaws.rds#OptionsConflictsWith", "traits": { - "smithy.api#documentation": "

    The name of the engine that this option can be applied to.

    " + "smithy.api#documentation": "

    The options that conflict with this option.

    " } }, - "OptionGroupOptionSettings": { - "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", + "OptionGroupOptionVersions": { + "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", "traits": { - "smithy.api#documentation": "

    The option settings that are available (and the default value) for each option in an option group.

    " + "smithy.api#documentation": "

    The versions that are available for the option.

    " } }, - "DefaultPort": { - "target": "com.amazonaws.rds#IntegerOptional", + "PortRequired": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    If the option requires a port, specifies the default port for the option.

    " + "smithy.api#documentation": "

    Specifies whether the option requires a port.

    " } }, - "Permanent": { - "target": "com.amazonaws.rds#Boolean", + "EngineName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

    " + "smithy.api#documentation": "

    The name of the engine that this option can be applied to.

    " } }, - "RequiresAutoMinorEngineVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", + "SupportsOptionVersionDowngrade": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.\n

    " + "smithy.api#documentation": "

    If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.\n

    " } }, "OptionsDependedOn": { @@ -13137,16 +13204,22 @@ "smithy.api#documentation": "

    The options that are prerequisites for this option.

    " } }, - "PortRequired": { + "RequiresAutoMinorEngineVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies whether the option requires a port.

    " + "smithy.api#documentation": "

    If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.\n

    " } }, - "SupportsOptionVersionDowngrade": { - "target": "com.amazonaws.rds#BooleanOptional", + "Permanent": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.\n

    " + "smithy.api#documentation": "

    Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

    " + } + }, + "DefaultPort": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    If the option requires a port, specifies the default port for the option.

    " } }, "Name": { @@ -13155,46 +13228,40 @@ "smithy.api#documentation": "

    The name of the option.

    " } }, - "Persistent": { + "VpcOnly": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

    " - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    Indicates the major engine version that the option is available for.

    " + "smithy.api#documentation": "

    If true, you can only use this option with a DB instance that is in a VPC.\n

    " } }, - "Description": { + "MinimumRequiredMinorEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The description of the option.

    " + "smithy.api#documentation": "

    The minimum required engine version for the option to be applied.

    " } }, - "OptionsConflictsWith": { - "target": "com.amazonaws.rds#OptionsConflictsWith", + "Persistent": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The options that conflict with this option.

    " + "smithy.api#documentation": "

    Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

    " } }, - "MinimumRequiredMinorEngineVersion": { + "MajorEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The minimum required engine version for the option to be applied.

    " + "smithy.api#documentation": "

    Indicates the major engine version that the option is available for.

    " } }, - "OptionGroupOptionVersions": { - "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", + "OptionGroupOptionSettings": { + "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", "traits": { - "smithy.api#documentation": "

    The versions that are available for the option.

    " + "smithy.api#documentation": "

    The option settings that are available (and the default value) for each option in an option group.

    " } }, - "VpcOnly": { - "target": "com.amazonaws.rds#Boolean", + "Description": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    If true, you can only use this option with a DB instance that is in a VPC.\n

    " + "smithy.api#documentation": "

    The description of the option.

    " } } }, @@ -13205,28 +13272,16 @@ "com.amazonaws.rds#OptionGroupOptionSetting": { "type": "structure", "members": { - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    Boolean value where true indicates that this option group option can be changed from the default value.

    " - } - }, - "MinimumEngineVersionPerAllowedValue": { - "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", - "traits": { - "smithy.api#documentation": "

    The minimum DB engine version required for the corresponding allowed value for this option setting.

    " - } - }, "SettingName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The name of the option group option.

    " } }, - "SettingDescription": { + "ApplyType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The description of the option group option.

    " + "smithy.api#documentation": "

    The DB engine specific parameter type for the option group option.

    " } }, "DefaultValue": { @@ -13235,12 +13290,6 @@ "smithy.api#documentation": "

    The default value for the option group option.

    " } }, - "ApplyType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The DB engine specific parameter type for the option group option.

    " - } - }, "IsRequired": { "target": "com.amazonaws.rds#Boolean", "traits": { @@ -13252,6 +13301,24 @@ "traits": { "smithy.api#documentation": "

    Indicates the acceptable values for the option group option.

    " } + }, + "SettingDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The description of the option group option.

    " + } + }, + "MinimumEngineVersionPerAllowedValue": { + "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", + "traits": { + "smithy.api#documentation": "

    The minimum DB engine version required for the corresponding allowed value for this option setting.

    " + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    Boolean value where true indicates that this option group option can be changed from the default value.

    " + } } }, "traits": { @@ -13356,34 +13423,34 @@ "com.amazonaws.rds#OptionSetting": { "type": "structure", "members": { - "IsCollection": { - "target": "com.amazonaws.rds#Boolean", + "Name": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates if the option setting is part of a collection.

    " + "smithy.api#documentation": "

    The name of the option that has settings that you can set.

    " } }, - "DefaultValue": { + "DataType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The default value of the option setting.

    " + "smithy.api#documentation": "

    The data type of the option setting.

    " } }, - "ApplyType": { + "Value": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB engine specific parameter type.

    " + "smithy.api#documentation": "

    The current value of the option setting.

    " } }, - "Description": { + "ApplyType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The description of the option setting.

    " + "smithy.api#documentation": "

    The DB engine specific parameter type.

    " } }, - "DataType": { + "DefaultValue": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The data type of the option setting.

    " + "smithy.api#documentation": "

    The default value of the option setting.

    " } }, "IsModifiable": { @@ -13392,22 +13459,22 @@ "smithy.api#documentation": "

    A Boolean value that, when true, indicates the option setting can be modified from the default.

    " } }, - "Name": { + "AllowedValues": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the option that has settings that you can set.

    " + "smithy.api#documentation": "

    The allowed values of the option setting.

    " } }, - "Value": { - "target": "com.amazonaws.rds#String", + "IsCollection": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The current value of the option setting.

    " + "smithy.api#documentation": "

    Indicates if the option setting is part of a collection.

    " } }, - "AllowedValues": { + "Description": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The allowed values of the option setting.

    " + "smithy.api#documentation": "

    The description of the option setting.

    " } } }, @@ -13483,112 +13550,118 @@ "com.amazonaws.rds#OrderableDBInstanceOption": { "type": "structure", "members": { - "Vpc": { + "SupportsStorageEncryption": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates whether a DB instance is in a VPC.

    " + "smithy.api#documentation": "

    Indicates whether a DB instance supports encrypted storage.

    " } }, - "MultiAZCapable": { - "target": "com.amazonaws.rds#Boolean", + "SupportsKerberosAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Indicates whether a DB instance is Multi-AZ capable.

    " + "smithy.api#documentation": "

    Whether a DB instance supports Kerberos Authentication.

    " } }, - "MaxStorageSize": { - "target": "com.amazonaws.rds#IntegerOptional", + "MaxIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", "traits": { - "smithy.api#documentation": "

    Maximum storage size for a DB instance.

    " + "smithy.api#documentation": "

    Maximum provisioned IOPS per GiB for a DB instance.

    " } }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", + "SupportsIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    A list of the supported DB engine modes.

    \n \n

    \n global engine mode only applies for global database clusters created with Aurora MySQL version\n 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned\n engine mode.\n

    \n     " + "smithy.api#documentation": "

    Indicates whether a DB instance supports IAM database authentication.

    " } }, - "MaxIopsPerGib": { - "target": "com.amazonaws.rds#DoubleOptional", + "MultiAZCapable": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Maximum provisioned IOPS per GiB for a DB instance.

    " + "smithy.api#documentation": "

    Indicates whether a DB instance is Multi-AZ capable.

    " } }, - "ReadReplicaCapable": { - "target": "com.amazonaws.rds#Boolean", + "StorageType": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates whether a DB instance can have a read replica.

    " + "smithy.api#documentation": "

    Indicates the storage type for a DB instance.

    " } }, - "SupportsIAMDatabaseAuthentication": { + "Vpc": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates whether a DB instance supports IAM database authentication.

    " + "smithy.api#documentation": "

    Indicates whether a DB instance is in a VPC.

    " } }, - "SupportsKerberosAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "MinIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Whether a DB instance supports Kerberos Authentication.

    " + "smithy.api#documentation": "

    Minimum total provisioned IOPS for a DB instance.

    " } }, - "SupportsStorageAutoscaling": { - "target": "com.amazonaws.rds#BooleanOptional", + "MaxStorageSize": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

    " + "smithy.api#documentation": "

    Maximum storage size for a DB instance.

    " } }, - "SupportsStorageEncryption": { + "SupportsGlobalDatabases": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates whether a DB instance supports encrypted storage.

    " + "smithy.api#documentation": "

    A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

    " } }, - "OutpostCapable": { - "target": "com.amazonaws.rds#Boolean", + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZoneList", "traits": { - "smithy.api#documentation": "

    Whether a DB instance supports RDS on Outposts.

    \n

    For more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    A list of Availability Zones for a DB instance.

    " } }, - "MinIopsPerGib": { - "target": "com.amazonaws.rds#DoubleOptional", + "LicenseModel": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Minimum provisioned IOPS per GiB for a DB instance.

    " + "smithy.api#documentation": "

    The license model for a DB instance.

    " } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "AvailableProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", "traits": { - "smithy.api#documentation": "

    The engine type of a DB instance.

    " + "smithy.api#documentation": "

    A list of the available processor features for the DB instance class of a DB instance.

    " } }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", "traits": { - "smithy.api#documentation": "

    The DB instance class for a DB instance.

    " + "smithy.api#documentation": "

    A list of the supported DB engine modes.

    " } }, - "MinStorageSize": { - "target": "com.amazonaws.rds#IntegerOptional", + "SupportsPerformanceInsights": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Minimum storage size for a DB instance.

    " + "smithy.api#documentation": "

    True if a DB instance supports Performance Insights, otherwise false.

    " } }, - "MinIopsPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", + "SupportsEnhancedMonitoring": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Minimum total provisioned IOPS for a DB instance.

    " + "smithy.api#documentation": "

    Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

    " } }, - "StorageType": { + "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates the storage type for a DB instance.

    " + "smithy.api#documentation": "

    The Availability Zone group for a DB instance.

    " } }, - "MaxIopsPerDbInstance": { + "SupportsIops": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether a DB instance supports provisioned IOPS.

    " + } + }, + "MinStorageSize": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Maximum total provisioned IOPS for a DB instance.

    " + "smithy.api#documentation": "

    Minimum storage size for a DB instance.

    " } }, "EngineVersion": { @@ -13597,52 +13670,46 @@ "smithy.api#documentation": "

    The engine version of a DB instance.

    " } }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

    A list of Availability Zones for a DB instance.

    " - } - }, - "SupportsEnhancedMonitoring": { + "OutpostCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

    " + "smithy.api#documentation": "

    Whether a DB instance supports RDS on Outposts.

    \n

    For more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n

    " } }, - "AvailableProcessorFeatures": { - "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of the available processor features for the DB instance class of a DB instance.

    " + "smithy.api#documentation": "

    The DB instance class for a DB instance.

    " } }, - "SupportsIops": { - "target": "com.amazonaws.rds#Boolean", + "MinIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", "traits": { - "smithy.api#documentation": "

    Indicates whether a DB instance supports provisioned IOPS.

    " + "smithy.api#documentation": "

    Minimum provisioned IOPS per GiB for a DB instance.

    " } }, - "LicenseModel": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The license model for a DB instance.

    " + "smithy.api#documentation": "

    The engine type of a DB instance.

    " } }, - "SupportsPerformanceInsights": { - "target": "com.amazonaws.rds#Boolean", + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    True if a DB instance supports Performance Insights, otherwise false.

    " + "smithy.api#documentation": "

    Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

    " } }, - "AvailabilityZoneGroup": { - "target": "com.amazonaws.rds#String", + "ReadReplicaCapable": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The Availability Zone group for a DB instance.

    " + "smithy.api#documentation": "

    Indicates whether a DB instance can have a read replica.

    " } }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#Boolean", + "MaxIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

    " + "smithy.api#documentation": "

    Maximum total provisioned IOPS for a DB instance.

    " } } }, @@ -13662,17 +13729,17 @@ "com.amazonaws.rds#OrderableDBInstanceOptionsMessage": { "type": "structure", "members": { - "OrderableDBInstanceOptions": { - "target": "com.amazonaws.rds#OrderableDBInstanceOptionsList", - "traits": { - "smithy.api#documentation": "

    An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

    " } + }, + "OrderableDBInstanceOptions": { + "target": "com.amazonaws.rds#OrderableDBInstanceOptionsList", + "traits": { + "smithy.api#documentation": "

    An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

    " + } } }, "traits": { @@ -13696,70 +13763,70 @@ "com.amazonaws.rds#Parameter": { "type": "structure", "members": { - "Source": { - "target": "com.amazonaws.rds#String", + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", "traits": { - "smithy.api#documentation": "

    Indicates the source of the parameter value.

    " + "smithy.api#documentation": "

    The valid DB engine modes.

    " } }, - "MinimumEngineVersion": { + "Description": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The earliest engine version to which the parameter can apply.

    " + "smithy.api#documentation": "

    Provides a description of the parameter.

    " } }, - "Description": { + "ApplyType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides a description of the parameter.

    " + "smithy.api#documentation": "

    Specifies the engine specific parameters type.

    " } }, - "ApplyMethod": { - "target": "com.amazonaws.rds#ApplyMethod", + "AllowedValues": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates when to apply parameter updates.

    " + "smithy.api#documentation": "

    Specifies the valid range of values for the parameter.

    " } }, - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", + "ParameterValue": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

    " + "smithy.api#documentation": "

    Specifies the value of the parameter.

    " } }, - "ApplyType": { + "ParameterName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the engine specific parameters type.

    " + "smithy.api#documentation": "

    Specifies the name of the parameter.

    " } }, - "DataType": { + "Source": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the valid data type for the parameter.

    " + "smithy.api#documentation": "

    Indicates the source of the parameter value.

    " } }, - "ParameterName": { + "DataType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the parameter.

    " + "smithy.api#documentation": "

    Specifies the valid data type for the parameter.

    " } }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", + "MinimumEngineVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The valid DB engine modes.

    " + "smithy.api#documentation": "

    The earliest engine version to which the parameter can apply.

    " } }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", + "ApplyMethod": { + "target": "com.amazonaws.rds#ApplyMethod", "traits": { - "smithy.api#documentation": "

    Specifies the valid range of values for the parameter.

    " + "smithy.api#documentation": "

    Indicates when to apply parameter updates.

    " } }, - "ParameterValue": { - "target": "com.amazonaws.rds#String", + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the value of the parameter.

    " + "smithy.api#documentation": "

    \n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

    " } } }, @@ -13779,16 +13846,16 @@ "com.amazonaws.rds#PendingCloudwatchLogsExports": { "type": "structure", "members": { - "LogTypesToEnable": { + "LogTypesToDisable": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

    " + "smithy.api#documentation": "

    Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

    " } }, - "LogTypesToDisable": { + "LogTypesToEnable": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

    " + "smithy.api#documentation": "

    Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

    " } } }, @@ -13799,16 +13866,10 @@ "com.amazonaws.rds#PendingMaintenanceAction": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.

    " - } - }, - "ForcedApplyDate": { + "AutoAppliedAfterDate": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The date when the maintenance action is automatically applied.\n The maintenance action is applied to the resource on this date\n regardless of the maintenance window for the resource.

    " + "smithy.api#documentation": "

    The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.

    " } }, "CurrentApplyDate": { @@ -13817,22 +13878,28 @@ "smithy.api#documentation": "

    The effective date when the pending maintenance action is applied \n to the resource. This date takes into account opt-in requests received from\n the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate,\n and the ForcedApplyDate. This value is blank if an \n opt-in request has not been received and nothing has been specified as\n AutoAppliedAfterDate or ForcedApplyDate.

    " } }, - "Description": { + "OptInStatus": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A description providing more detail about the maintenance action.

    " + "smithy.api#documentation": "

    Indicates the type of opt-in request that has been received for the resource.

    " } }, - "AutoAppliedAfterDate": { + "ForcedApplyDate": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.

    " + "smithy.api#documentation": "

    The date when the maintenance action is automatically applied.

    \n

    On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

    " } }, - "OptInStatus": { + "Action": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates the type of opt-in request that has been received for the resource.

    " + "smithy.api#documentation": "

    The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.

    " + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    A description providing more detail about the maintenance action.

    " } } }, @@ -13861,17 +13928,17 @@ "com.amazonaws.rds#PendingMaintenanceActionsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n

    " - } - }, "PendingMaintenanceActions": { "target": "com.amazonaws.rds#PendingMaintenanceActions", "traits": { "smithy.api#documentation": "

    A list of the pending maintenance actions for the resource.

    " } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    \n An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.\n

    " + } } }, "traits": { @@ -13881,34 +13948,16 @@ "com.amazonaws.rds#PendingModifiedValues": { "type": "structure", "members": { - "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.

    " - } - }, - "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

    " - } - }, - "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.

    " - } - }, - "StorageType": { + "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.

    " + "smithy.api#documentation": "

    Specifies the identifier of the CA certificate for the DB instance.

    " } }, - "EngineVersion": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates the database engine version.

    " + "smithy.api#documentation": "

    \n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is currently being applied.\n

    " } }, "DBSubnetGroupName": { @@ -13917,55 +13966,73 @@ "smithy.api#documentation": "

    The new DB subnet group for the DB instance.\n

    " } }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "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.

    " - } - }, - "DBInstanceIdentifier": { + "MasterUserPassword": { "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": "

    Contains the pending or currently-in-progress change of the master credentials for the DB instance.

    " } }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Specifies the identifier of the CA certificate for the DB instance.

    " + "smithy.api#documentation": "

    Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

    " } }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", "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": "

    \n Contains the new DBInstanceClass for the DB instance\n that will be applied or is currently being applied.\n

    " } }, - "LicenseModel": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The license model for the DB instance.

    \n

    Valid values: license-included | bring-your-own-license | \n general-public-license\n

    " + "smithy.api#documentation": "

    Indicates the database engine version.

    " } }, "PendingCloudwatchLogsExports": { "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.

    " + } + }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

    Specifies the pending port 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

    " + } + }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

    Specifies the pending number of days for which automated backups are retained.

    " } }, - "MasterUserPassword": { + "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.

    " + } + }, + "LicenseModel": { "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 license model for the DB instance.

    \n

    Valid values: license-included | bring-your-own-license | \n general-public-license\n

    " + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "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.

    " } } }, @@ -14003,7 +14070,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the processor features of a DB instance class.

    \n

    To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

    \n

    You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

    \n
      \n
    • \n

      \n CreateDBInstance\n

      \n
      • \n
    • \n

      \n ModifyDBInstance\n

      \n
      • \n
    • \n

      \n RestoreDBInstanceFromDBSnapshot\n

      \n
      • \n
    • \n

      \n RestoreDBInstanceFromS3\n

      \n
      • \n
    • \n

      \n RestoreDBInstanceToPointInTime\n

      \n
      • \n
    \n

    You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

    \n

    In addition, you can use the following actions for DB instance class processor information:

    \n
      \n
    • \n

      \n DescribeDBInstances\n

      \n
      • \n
    • \n

      \n DescribeDBSnapshots\n

      \n
      • \n
    • \n

      \n DescribeValidDBInstanceModifications\n

      \n
      • \n
    \n

    For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

    " + "smithy.api#documentation": "

    Contains the processor features of a DB instance class.

    \n

    To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

    \n

    You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

    \n
      \n
    • \n

      \n CreateDBInstance\n

      \n
      • \n
    • \n

      \n ModifyDBInstance\n

      \n
      • \n
    • \n

      \n RestoreDBInstanceFromDBSnapshot\n

      \n
      • \n
    • \n

      \n RestoreDBInstanceFromS3\n

      \n
      • \n
    • \n

      \n RestoreDBInstanceToPointInTime\n

      \n
      • \n
    \n

    You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

    \n

    In addition, you can use the following actions for DB instance class processor information:

    \n
      \n
    • \n

      \n DescribeDBInstances\n

      \n
      • \n
    • \n

      \n DescribeDBSnapshots\n

      \n
      • \n
    • \n

      \n DescribeValidDBInstanceModifications\n

      \n
      • \n
    \n

    If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

    \n
      \n
    • \n

      You are accessing an Oracle DB instance.

      \n
      • \n
    • \n

      Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

      \n
      • \n
    • \n

      The current number CPU cores and threads is set to a non-default value.

      \n
      • \n
    \n

    For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

    " } }, "com.amazonaws.rds#ProcessorFeatureList": { @@ -14081,13 +14148,6 @@ "com.amazonaws.rds#PromoteReadReplicaMessage": { "type": "structure", "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The DB instance identifier. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing read replica DB instance.

      \n
      • \n
    \n

    Example: mydbinstance\n

    ", - "smithy.api#required": {} - } - }, "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { @@ -14099,6 +14159,13 @@ "traits": { "smithy.api#documentation": "

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 0 to 35.

      \n
      • \n
    • \n

      Can't be set to 0 if the DB instance is a source to read replicas.

      \n
      • \n
    " } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The DB instance identifier. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing read replica DB instance.

      \n
      • \n
    \n

    Example: mydbinstance\n

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -14152,26 +14219,26 @@ "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { "type": "structure", "members": { - "ReservedDBInstanceId": { + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Customer-specified identifier to track this reservation.

    \n

    Example: myreservationID

    " + "smithy.api#documentation": "

    The ID of the Reserved DB instance offering to purchase.

    \n

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    ", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, "DBInstanceCount": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

    The number of instances to reserve.

    \n

    Default: 1\n

    " } }, - "ReservedDBInstancesOfferingId": { + "ReservedDBInstanceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ID of the Reserved DB instance offering to purchase.

    \n

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Customer-specified identifier to track this reservation.

    \n

    Example: myreservationID

    " } } }, @@ -14190,12 +14257,6 @@ "com.amazonaws.rds#Range": { "type": "structure", "members": { - "Step": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...\n

    " - } - }, "To": { "target": "com.amazonaws.rds#Integer", "traits": { @@ -14207,6 +14268,12 @@ "traits": { "smithy.api#documentation": "

    The minimum value in the range.

    " } + }, + "Step": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...\n

    " + } } }, "traits": { @@ -14278,18 +14345,18 @@ "com.amazonaws.rds#RebootDBInstanceMessage": { "type": "structure", "members": { + "ForceFailover": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    \n A value that indicates whether the reboot is conducted through a Multi-AZ failover.\n

    \n

    Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

    " + } + }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The DB instance identifier. This parameter is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBInstance.

      \n
      • \n
    ", "smithy.api#required": {} } - }, - "ForceFailover": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    \n A value that indicates whether the reboot is conducted through a Multi-AZ failover.\n

    \n

    Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

    " - } } }, "traits": { @@ -14357,6 +14424,9 @@ { "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" }, + { + "target": "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault" + }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, @@ -14374,18 +14444,18 @@ "com.amazonaws.rds#RegisterDBProxyTargetsRequest": { "type": "structure", "members": { - "DBInstanceIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

    One or more DB instance identifiers.

    " - } - }, "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The identifier of the DBProxyTargetGroup.

    " } }, + "DBClusterIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

    One or more DB cluster identifiers.

    " + } + }, "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { @@ -14393,10 +14463,10 @@ "smithy.api#required": {} } }, - "DBClusterIdentifiers": { + "DBInstanceIdentifiers": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    One or more DB cluster identifiers.

    " + "smithy.api#documentation": "

    One or more DB instance identifiers.

    " } } } @@ -14483,13 +14553,6 @@ "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { "type": "structure", "members": { - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.

    ", - "smithy.api#required": {} - } - }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -14502,6 +14565,13 @@ "traits": { "smithy.api#documentation": "

    The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For the list of supported feature names, see DBEngineVersion.

    " } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.

    ", + "smithy.api#required": {} + } } } }, @@ -14528,24 +14598,24 @@ "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { "type": "structure", "members": { - "DBInstanceIdentifier": { + "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB instance to disassociate the IAM role from.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example arn:aws:iam::123456789012:role/AccessRole.

    ", "smithy.api#required": {} } }, - "RoleArn": { + "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example arn:aws:iam::123456789012:role/AccessRole.

    ", + "smithy.api#documentation": "

    The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For the list of supported feature names, see DBEngineVersion.\n

    ", "smithy.api#required": {} } }, - "FeatureName": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For the list of supported feature names, see DBEngineVersion.\n

    ", + "smithy.api#documentation": "

    The name of the DB instance to disassociate the IAM role from.

    ", "smithy.api#required": {} } } @@ -14630,17 +14700,17 @@ "com.amazonaws.rds#RemoveTagsFromResourceMessage": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.rds#KeyList", + "ResourceName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The tag key (name) of the tag to be removed.

    ", + "smithy.api#documentation": "

    The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

    ", "smithy.api#required": {} } }, - "ResourceName": { - "target": "com.amazonaws.rds#String", + "TagKeys": { + "target": "com.amazonaws.rds#KeyList", "traits": { - "smithy.api#documentation": "

    The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

    ", + "smithy.api#documentation": "

    The tag key (name) of the tag to be removed.

    ", "smithy.api#required": {} } } @@ -14649,25 +14719,58 @@ "smithy.api#documentation": "

    " } }, + "com.amazonaws.rds#ReplicaMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "open-read-only", + "name": "OPEN_READ_ONLY" + }, + { + "value": "mounted", + "name": "MOUNTED" + } + ] + } + }, "com.amazonaws.rds#ReservedDBInstance": { "type": "structure", "members": { - "ReservedDBInstanceId": { + "ReservedDBInstanceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for the reservation.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the reserved DB instance.

    " } }, - "Duration": { + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates if the reservation applies to Multi-AZ deployments.

    " + } + }, + "DBInstanceCount": { "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The duration of the reservation in seconds.

    " + "smithy.api#documentation": "

    The number of reserved DB instances.

    " } }, - "LeaseId": { + "ReservedDBInstancesOfferingId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for the lease associated with the reserved DB instance.

    \n \n

    AWS Support might request the lease ID for an issue related to a reserved DB instance.

    \n     " + "smithy.api#documentation": "

    The offering identifier.

    " + } + }, + "FixedPrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

    The fixed price charged for this reserved DB instance.

    " + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The DB instance class for the reserved DB instance.

    " } }, "ProductDescription": { @@ -14688,22 +14791,16 @@ "smithy.api#documentation": "

    The currency code for the reserved DB instance.

    " } }, - "UsagePrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#documentation": "

    The hourly price charged for this reserved DB instance.

    " - } - }, "RecurringCharges": { "target": "com.amazonaws.rds#RecurringChargeList", "traits": { "smithy.api#documentation": "

    The recurring price charged to run this reserved DB instance.

    " } }, - "ReservedDBInstancesOfferingId": { + "State": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The offering identifier.

    " + "smithy.api#documentation": "

    The state of the reserved DB instance.

    " } }, "StartTime": { @@ -14712,40 +14809,28 @@ "smithy.api#documentation": "

    The time the reservation started.

    " } }, - "State": { - "target": "com.amazonaws.rds#String", + "Duration": { + "target": "com.amazonaws.rds#Integer", "traits": { - "smithy.api#documentation": "

    The state of the reserved DB instance.

    " + "smithy.api#documentation": "

    The duration of the reservation in seconds.

    " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", + "UsagePrice": { + "target": "com.amazonaws.rds#Double", "traits": { - "smithy.api#documentation": "

    Indicates if the reservation applies to Multi-AZ deployments.

    " + "smithy.api#documentation": "

    The hourly price charged for this reserved DB instance.

    " } }, - "ReservedDBInstanceArn": { + "ReservedDBInstanceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the reserved DB instance.

    " + "smithy.api#documentation": "

    The unique identifier for the reservation.

    " } }, - "DBInstanceClass": { + "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB instance class for the reserved DB instance.

    " - } - }, - "FixedPrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#documentation": "

    The fixed price charged for this reserved DB instance.

    " - } - }, - "DBInstanceCount": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#documentation": "

    The number of reserved DB instances.

    " + "smithy.api#documentation": "

    The unique identifier for the lease associated with the reserved DB instance.

    \n \n

    AWS Support might request the lease ID for an issue related to a reserved DB instance.

    \n     " } } }, @@ -14824,34 +14909,28 @@ "com.amazonaws.rds#ReservedDBInstancesOffering": { "type": "structure", "members": { - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    Indicates if the offering applies to Multi-AZ deployments.

    " - } - }, - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", + "FixedPrice": { + "target": "com.amazonaws.rds#Double", "traits": { - "smithy.api#documentation": "

    The offering identifier.

    " + "smithy.api#documentation": "

    The fixed price charged for this offering.

    " } }, - "DBInstanceClass": { + "CurrencyCode": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB instance class for the reserved DB instance.

    " + "smithy.api#documentation": "

    The currency code for the reserved DB instance offering.

    " } }, - "OfferingType": { - "target": "com.amazonaws.rds#String", + "RecurringCharges": { + "target": "com.amazonaws.rds#RecurringChargeList", "traits": { - "smithy.api#documentation": "

    The offering type.

    " + "smithy.api#documentation": "

    The recurring price charged to run this reserved DB instance.

    " } }, - "ProductDescription": { + "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database engine used by the offering.

    " + "smithy.api#documentation": "

    The DB instance class for the reserved DB instance.

    " } }, "Duration": { @@ -14860,28 +14939,34 @@ "smithy.api#documentation": "

    The duration of the offering in seconds.

    " } }, - "UsagePrice": { - "target": "com.amazonaws.rds#Double", + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The hourly price charged for this offering.

    " + "smithy.api#documentation": "

    The offering identifier.

    " } }, - "FixedPrice": { - "target": "com.amazonaws.rds#Double", + "ProductDescription": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The fixed price charged for this offering.

    " + "smithy.api#documentation": "

    The database engine used by the offering.

    " } }, - "CurrencyCode": { + "OfferingType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The currency code for the reserved DB instance offering.

    " + "smithy.api#documentation": "

    The offering type.

    " } }, - "RecurringCharges": { - "target": "com.amazonaws.rds#RecurringChargeList", + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The recurring price charged to run this reserved DB instance.

    " + "smithy.api#documentation": "

    Indicates if the offering applies to Multi-AZ deployments.

    " + } + }, + "UsagePrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#documentation": "

    The hourly price charged for this offering.

    " } } }, @@ -14901,17 +14986,17 @@ "com.amazonaws.rds#ReservedDBInstancesOfferingMessage": { "type": "structure", "members": { - "ReservedDBInstancesOfferings": { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingList", - "traits": { - "smithy.api#documentation": "

    A list of reserved DB instance offerings.

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "ReservedDBInstancesOfferings": { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingList", + "traits": { + "smithy.api#documentation": "

    A list of reserved DB instance offerings.

    " + } } }, "traits": { @@ -15001,6 +15086,12 @@ "com.amazonaws.rds#ResetDBParameterGroupMessage": { "type": "structure", "members": { + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

    To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

    \n

    \n MySQL\n

    \n

    Valid Values (for Apply method): immediate | pending-reboot\n

    \n

    You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

    \n

    \n MariaDB\n

    \n

    Valid Values (for Apply method): immediate | pending-reboot\n

    \n

    You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

    \n

    \n Oracle\n

    \n

    Valid Values (for Apply method): pending-reboot\n

    " + } + }, "ResetAllParameters": { "target": "com.amazonaws.rds#Boolean", "traits": { @@ -15013,12 +15104,6 @@ "smithy.api#documentation": "

    The name of the DB parameter group.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the name of an existing DBParameterGroup.

      \n
      • \n
    ", "smithy.api#required": {} } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

    To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

    \n

    \n MySQL\n

    \n

    Valid Values (for Apply method): immediate | pending-reboot\n

    \n

    You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

    \n

    \n MariaDB\n

    \n

    Valid Values (for Apply method): immediate | pending-reboot\n

    \n

    You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

    \n

    \n Oracle\n

    \n

    Valid Values (for Apply method): pending-reboot\n

    " - } } }, "traits": { @@ -15041,17 +15126,17 @@ "com.amazonaws.rds#ResourcePendingMaintenanceActions": { "type": "structure", "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The ARN of the resource that has pending maintenance actions.

    " - } - }, "PendingMaintenanceActionDetails": { "target": "com.amazonaws.rds#PendingMaintenanceActionDetails", "traits": { "smithy.api#documentation": "

    A list that provides details about the pending maintenance actions for the resource.

    " } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The ARN of the resource that has pending maintenance actions.

    " + } } }, "traits": { @@ -15111,35 +15196,22 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be\n authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as \n described in \n Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

    \n \n

    This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n

    \n \n

    This action only applies to Aurora DB clusters.

    \n     " + "smithy.api#documentation": "

    Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

    \n \n

    This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n

    \n \n

    This action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.

    \n     " } }, "com.amazonaws.rds#RestoreDBClusterFromS3Message": { "type": "structure", "members": { - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with the restored DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.\n

    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " } }, - "S3IngestionRoleArn": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

    ", - "smithy.api#required": {} - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

    A list of EC2 VPC security groups to associate with the restored DB cluster.

    " + "smithy.api#documentation": "

    The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBClusterParameterGroup.

      \n
      • \n
    " } }, "PreferredBackupWindow": { @@ -15148,12 +15220,6 @@ "smithy.api#documentation": "

    The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " } }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    \n Aurora MySQL\n

    \n

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n

    \n

    \n Aurora PostgreSQL\n

    \n

    Example: 9.6.3, 10.7\n

    " - } - }, "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -15161,40 +15227,47 @@ "smithy.api#required": {} } }, - "SourceEngine": { + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 1 to 35

      \n
      • \n
    " + } + }, + "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.\n

    \n

    Valid values: mysql\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

    " } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " + "smithy.api#documentation": "

    The port number on which the instances in the restored DB cluster accept connections.

    \n

    \n Default: 3306\n

    " } }, - "SourceEngineVersion": { + "S3BucketName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version of the database that the backup files were created from.

    \n

    MySQL versions 5.5, 5.6, and 5.7 are supported.\n

    \n

    Example: 5.6.40\n

    ", + "smithy.api#documentation": "

    The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " + } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

    The name of the database engine to be used for the restored DB cluster.

    \n

    Valid Values: aurora, aurora-postgresql\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " } }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " } }, "Domain": { @@ -15203,28 +15276,29 @@ "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n

    \n

    \n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

    " } }, - "StorageEncrypted": { + "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the restored DB cluster is encrypted.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n

    " } }, - "OptionGroupName": { + "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates that the restored DB cluster should be associated with the specified option group.

    \n

    Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

    " + "smithy.api#documentation": "

    A DB subnet group to associate with the restored DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.\n

    \n

    Example: mySubnetgroup\n

    " } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n

    Constraints: Minimum 30-minute window.

    " + "smithy.api#documentation": "

    A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

    " } }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "MasterUsername": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The port number on which the instances in the restored DB cluster accept connections.

    \n

    \n Default: 3306\n

    " + "smithy.api#documentation": "

    The name of the master user for the restored DB cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    ", + "smithy.api#required": {} } }, "KmsKeyId": { @@ -15233,79 +15307,90 @@ "smithy.api#documentation": "

    The AWS KMS key identifier for an encrypted DB cluster.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    \n

    If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default encryption key. AWS KMS creates the \n default encryption key for your AWS account. Your AWS account has a different\n default encryption key for each AWS Region.

    " } }, - "S3Prefix": { + "SourceEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.

    " + "smithy.api#documentation": "

    The version of the database that the backup files were created from.

    \n

    MySQL versions 5.5, 5.6, and 5.7 are supported.\n

    \n

    Example: 5.6.40, 5.7.28\n

    ", + "smithy.api#required": {} } }, - "CharacterSetName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

    " + "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.\n

    \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n

    Constraints: Minimum 30-minute window.

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", + "DatabaseName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n

    " + "smithy.api#documentation": "

    The database name for the restored DB cluster.

    " } }, - "DatabaseName": { + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database name for the restored DB cluster.

    " + "smithy.api#documentation": "

    A value that indicates that the restored DB cluster should be associated with the specified option group.

    \n

    Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

    " } }, - "MasterUsername": { + "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the master user for the restored DB cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n

    Constraints: Must contain from 8 to 41 characters.

    ", "smithy.api#required": {} } }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", + "EngineVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

    " + "smithy.api#documentation": "

    The version number of the database engine to use.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    \n Aurora MySQL\n

    \n

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n

    \n

    \n Aurora PostgreSQL\n

    \n

    Example: 9.6.3, 10.7\n

    " } }, - "DBClusterParameterGroupName": { + "S3Prefix": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.\n

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBClusterParameterGroup.

      \n
      • \n
    " + "smithy.api#documentation": "

    The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.

    " } }, - "S3BucketName": { + "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

    ", + "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the database engine to be used for this DB cluster.

    \n

    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n

    ", "smithy.api#required": {} } }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", + "SourceEngine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

    \n

    Default: 1

    \n

    Constraints:

    \n
      \n
    • \n

      Must be a value from 1 to 35

      \n
      • \n
    " + "smithy.api#documentation": "

    The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.\n

    \n

    Valid values: mysql\n

    ", + "smithy.api#required": {} } }, - "MasterUserPassword": { + "S3IngestionRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n

    Constraints: Must contain from 8 to 41 characters.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

    ", "smithy.api#required": {} } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    A list of EC2 VPC security groups to associate with the restored DB cluster.

    " } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    A value that indicates whether the restored DB cluster is encrypted.

    " } } } @@ -15386,109 +15471,121 @@ "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { "type": "structure", "members": { - "DBClusterParameterGroupName": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing default DB cluster parameter group.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " + "smithy.api#documentation": "

    The version of the database engine to use for the new DB cluster.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    \n \n

    If you aren't using the default engine version, then you must specify the engine version.

    \n     \n

    \n Aurora MySQL\n

    \n

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n

    \n

    \n Aurora PostgreSQL\n

    \n

    Example: 9.6.3, 10.7\n

    " } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "EngineMode": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " + "smithy.api#documentation": "

    The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

    \n

    For more information, see \n CreateDBCluster.

    " } }, - "DBClusterIdentifier": { + "SnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-snapshot-id\n

    ", + "smithy.api#documentation": "

    The identifier for the DB snapshot or DB cluster snapshot to restore from.

    \n

    You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing Snapshot.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "OptionGroupName": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the option group to use for the restored DB cluster.

    " + "smithy.api#documentation": "

    The database engine to use for the new DB cluster.

    \n

    Default: The same as source

    \n

    Constraint: Must be compatible with the engine of the source

    ", + "smithy.api#required": {} } }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    " + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The port number on which the new DB cluster accepts connections.

    \n

    Constraints: This value must be 1150-65535\n

    \n

    Default: The same port as the original DB cluster.

    " + "smithy.api#documentation": "

    The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used. For more information, see\n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon\n Aurora User Guide.

    " } }, - "DeletionProtection": { + "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n

    " + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " } }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The database name for the restored DB cluster.

    " + "smithy.api#documentation": "

    The port number on which the new DB cluster accepts connections.

    \n

    Constraints: This value must be 1150-65535\n

    \n

    Default: The same port as the original DB cluster.

    " } }, - "KmsKeyId": { + "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption\n key. If you are restoring a DB cluster with the same AWS account that owns the KMS\n encryption key used to encrypt the new DB cluster, then you can use the KMS key alias\n instead of the ARN for the KMS encryption key.

    \n

    If you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

    \n
      \n
    • \n

      If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.

      \n
      • \n
    • \n

      If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing default DB cluster parameter group.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " } }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    " + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " } }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", + "Tags": { + "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

    The version of the database engine to use for the new DB cluster.

    \n

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

    \n

    To list all of the available engine versions for aurora-postgresql, use the following command:

    \n

    \n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

    \n \n

    If you aren't using the default engine version, then you must specify the engine version.

    \n     \n

    \n Aurora MySQL\n

    \n

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n

    \n

    \n Aurora PostgreSQL\n

    \n

    Example: 9.6.3, 10.7\n

    " + "smithy.api#documentation": "

    The tags to be assigned to the restored DB cluster.

    " } }, - "DomainIAMRoleName": { + "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

    \n

    For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.\n

    " } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", "traits": { - "smithy.api#documentation": "

    The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used. For more information, see\n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon\n Aurora User Guide.

    " + "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " } }, - "Engine": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database engine to use for the new DB cluster.

    \n

    Default: The same as source

    \n

    Constraint: Must be compatible with the engine of the source

    ", + "smithy.api#documentation": "

    The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-snapshot-id\n

    ", "smithy.api#required": {} } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "DatabaseName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    The database name for the restored DB cluster.

    " } }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", + "OptionGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

    " + "smithy.api#documentation": "

    The name of the option group to use for the restored DB cluster.

    " } }, - "SnapshotIdentifier": { + "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the DB snapshot or DB cluster snapshot to restore from.

    \n

    You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing Snapshot.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption\n key. If you are restoring a DB cluster with the same AWS account that owns the KMS\n encryption key used to encrypt the new DB cluster, then you can use the KMS key alias\n instead of the ARN for the KMS encryption key.

    \n

    If you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

    \n
      \n
    • \n

      If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.

      \n
      • \n
    • \n

      If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.

      \n
      • \n
    " } }, - "EngineMode": { - "target": "com.amazonaws.rds#String", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n

    " } }, "DBSubnetGroupName": { @@ -15503,22 +15600,10 @@ "smithy.api#documentation": "

    A list of VPC security groups that the new DB cluster will belong to.

    " } }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

    The tags to be assigned to the restored DB cluster.

    " - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n

    " - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " + "smithy.api#documentation": "

    Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

    " } } }, @@ -15605,34 +15690,6 @@ "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { "type": "structure", "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DB cluster parameter group.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the option group for the new DB cluster.

    " - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the new DB cluster to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    ", - "smithy.api#required": {} - } - }, - "RestoreType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The type of restore to be performed. You can specify one of the following values:

    \n
      \n
    • \n

      \n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.

      \n
      • \n
    • \n

      \n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.

      \n
      • \n
    \n

    Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

    \n

    If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

    " - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, "RestoreToTime": { "target": "com.amazonaws.rds#TStamp", "traits": { @@ -15645,17 +15702,16 @@ "smithy.api#documentation": "

    The port number on which the new DB cluster accepts connections.

    \n

    Constraints: A value from 1150-65535.\n

    \n

    Default: The default port for the engine.

    " } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "KmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " + "smithy.api#documentation": "

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    \n

    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

    \n

    If you don't specify a value for the KmsKeyId parameter, then the following occurs:

    \n
      \n
    • \n

      If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

      \n
      • \n
    • \n

      If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

      \n
      • \n
    \n\n

    If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

    " } }, - "SourceDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The identifier of the source DB cluster from which to restore.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBCluster.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " } }, "EnableCloudwatchLogsExports": { @@ -15664,22 +15720,22 @@ "smithy.api#documentation": "

    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "Domain": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

    \n \n

    For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n

    \n

    \n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

    " } }, - "Domain": { + "RestoreType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.\n

    \n

    \n For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.\n

    " + "smithy.api#documentation": "

    The type of restore to be performed. You can specify one of the following values:

    \n
      \n
    • \n

      \n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.

      \n
      • \n
    • \n

      \n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.

      \n
      • \n
    \n

    Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

    \n

    If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

    " } }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.rds#Boolean", + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.\n

    \n

    Constraints: Can't be specified if RestoreToTime parameter is provided.

    " + "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " } }, "BacktrackWindow": { @@ -15688,16 +15744,38 @@ "smithy.api#documentation": "

    The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

    \n \n

    Currently, Backtrack is only supported for Aurora MySQL DB clusters.

    \n     \n

    Default: 0

    \n

    Constraints:

    \n
      \n
    • \n

      If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      \n
      • \n
    " } }, - "DomainIAMRoleName": { + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

    A list of VPC security groups that the new DB cluster belongs to.

    " + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " + } + }, + "DBClusterParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DB cluster parameter group.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " } }, - "DBSubnetGroupName": { + "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB subnet group name to use for the new DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    The identifier of the source DB cluster from which to restore.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBCluster.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.\n

    \n

    Constraints: Can't be specified if RestoreToTime parameter is provided.

    " } }, "DeletionProtection": { @@ -15706,16 +15784,23 @@ "smithy.api#documentation": "

    A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled.\n

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of VPC security groups that the new DB cluster belongs to.

    " + "smithy.api#documentation": "

    The DB subnet group name to use for the new DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    " } }, - "KmsKeyId": { + "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    \n

    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

    \n

    If you don't specify a value for the KmsKeyId parameter, then the following occurs:

    \n
      \n
    • \n

      If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

      \n
      • \n
    • \n

      If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

      \n
      • \n
    \n\n

    If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

    " + "smithy.api#documentation": "

    The name of the new DB cluster to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the option group for the new DB cluster.

    " } } }, @@ -15808,17 +15893,22 @@ "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { "type": "structure", "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 numbers, letters, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-snapshot-id\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The port number on which the database accepts connections.

    \n

    Default: The same port as the original DB instance

    \n

    Constraints: Value must be 1150-65535\n

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    \n A list of EC2 VPC security groups to associate with this DB instance.\n

    \n

    \n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

    " + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    " + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

    " } }, "DBSubnetGroupName": { @@ -15827,103 +15917,108 @@ "smithy.api#documentation": "

    The DB subnet group name to use for the new instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    " } }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The password for the given ARN from the key store in order to access the device.

    " + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " } }, - "LicenseModel": { + "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    License model information for the restored DB instance.

    \n

    Default: Same as source.

    \n

    \n Valid values: license-included | bring-your-own-license | general-public-license\n

    " + "smithy.api#documentation": "

    The identifier for the DB snapshot to restore from.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBSnapshot.

      \n
      • \n
    • \n

      If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " + "smithy.api#documentation": "

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " } }, - "TdeCredentialArn": { + "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

    \n

    For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

    " } }, - "Engine": { + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "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

    " + } + }, + "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database engine to use for the new instance.

    \n

    Default: The same as source

    \n

    Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

    \n\n

    Valid Values:

    \n \n
      \n
    • \n

      \n mariadb\n

      \n
      • \n
    • \n

      \n mysql\n

      \n
      • \n
    • \n

      \n oracle-ee\n

      \n
      • \n
    • \n

      \n oracle-se2\n

      \n
      • \n
    • \n

      \n oracle-se1\n

      \n
      • \n
    • \n

      \n oracle-se\n

      \n
      • \n
    • \n

      \n postgres\n

      \n
      • \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The database name for the restored DB instance.

    \n \n

    This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

    \n     " } }, - "DomainIAMRoleName": { + "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    The name of the option group to be used for the restored DB instance.

    \n \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "LicenseModel": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.\n

    \n

    The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

    \n

    Constraints: Must be an integer greater than 1000.

    " + "smithy.api#documentation": "

    License model information for the restored DB instance.

    \n

    Default: Same as source.

    \n

    \n Valid values: license-included | bring-your-own-license | general-public-license\n

    " } }, - "AutoMinorVersionUpgrade": { + "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " } }, - "DBInstanceClass": { + "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    \n

    Default: The same DBInstanceClass as the original DB instance.

    " + "smithy.api#documentation": "

    The Availability Zone (AZ) where the DB instance will be created.

    \n

    Default: A random, system-chosen Availability Zone.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    \n

    Example: us-east-1a\n

    " } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    " + "smithy.api#documentation": "

    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.\n

    \n

    The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

    \n

    Constraints: Must be an integer greater than 1000.

    " } }, - "DBParameterGroupName": { + "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBParameterGroup.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " + "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    \n If you specify io1, you must also include a value for the\n Iops parameter.\n

    \n

    \n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "Domain": { + "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only Microsoft SQL Server and \n Oracle DB instances can be created in an Active Directory Domain.\n

    \n

    For Microsoft SQL Server DB instances, Amazon RDS can use \n Windows Authentication to authenticate users that connect to the DB instance. For more\n information, see \n Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the \n Amazon RDS User Guide.

    \n

    For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. \n For more information, see \n Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBParameterGroup.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " } }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The Availability Zone (AZ) where the DB instance will be created.

    \n

    Default: A random, system-chosen Availability Zone.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    \n

    Example: us-east-1a\n

    " + "smithy.api#documentation": "

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

    " } }, - "DBName": { + "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database name for the restored DB instance.

    \n \n

    This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

    \n     " + "smithy.api#documentation": "

    The password for the given ARN from the key store in order to access the device.

    " } }, - "OptionGroupName": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the option group to be used for the restored DB instance.

    \n \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + "smithy.api#documentation": "

    Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 numbers, letters, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-snapshot-id\n

    ", + "smithy.api#required": {} } }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "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

    " + "smithy.api#documentation": "

    \n A list of EC2 VPC security groups to associate with this DB instance.\n

    \n

    \n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

    " } }, "ProcessorFeatures": { @@ -15932,47 +16027,37 @@ "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " } }, - "StorageType": { + "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    \n If you specify io1, you must also include a value for the\n Iops parameter.\n

    \n

    \n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

    " + "smithy.api#documentation": "

    The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    \n

    Default: The same DBInstanceClass as the original DB instance.

    " } }, - "DBSnapshotIdentifier": { + "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the DB snapshot to restore from.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBSnapshot.

      \n
      • \n
    • \n

      If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " } }, - "EnableIAMDatabaseAuthentication": { + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " } }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " + "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " } }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "Engine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The port number on which the database accepts connections.

    \n

    Default: The same port as the original DB instance

    \n

    Constraints: Value must be 1150-65535\n

    " + "smithy.api#documentation": "

    The database engine to use for the new instance.

    \n

    Default: The same as source

    \n

    Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

    \n\n

    Valid Values:

    \n \n
      \n
    • \n

      \n mariadb\n

      \n
      • \n
    • \n

      \n mysql\n

      \n
      • \n
    • \n

      \n oracle-ee\n

      \n
      • \n
    • \n

      \n oracle-se2\n

      \n
      • \n
    • \n

      \n oracle-se1\n

      \n
      • \n
    • \n

      \n oracle-se\n

      \n
      • \n
    • \n

      \n postgres\n

      \n
      • \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    " } } }, @@ -16056,89 +16141,79 @@ "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { "type": "structure", "members": { - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", + "StorageType": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. \n

    " + "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.\n

    \n

    Valid values: standard | gp2 | io1\n

    \n

    If you specify io1, \n you must also include a value for the Iops parameter.\n

    \n

    Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

    " } }, - "SourceEngineVersion": { + "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version of the database that the backup files were created from.

    \n

    MySQL versions 5.6 and 5.7 are supported.\n

    \n

    Example: 5.6.40\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The license model for this DB instance.\n Use general-public-license.\n

    " } }, - "AvailabilityZone": { + "S3Prefix": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Availability Zone that the DB instance is created in. \n For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

    \n

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.\n

    \n

    \n Example: us-east-1d\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

    " + "smithy.api#documentation": "

    The prefix of your Amazon S3 bucket.\n

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "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

    " + "smithy.api#documentation": "

    The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.\n

    \n \n \n

    Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth. \n

    \n     " } }, - "OptionGroupName": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.\n

    " + "smithy.api#documentation": "

    The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.\n

    " } }, - "LicenseModel": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The license model for this DB instance.\n Use general-public-license.\n

    " + "smithy.api#documentation": "

    The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

    \n\n

    Constraints:

    \n
      \n
    • \n

      Must be in the format ddd:hh24:mi-ddd:hh24:mi.

      \n
      • \n
    • \n

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred backup window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " } }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

    " + "smithy.api#documentation": "

    The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

    " } }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.\n

    " + "smithy.api#documentation": "

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " } }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.\n

    \n \n \n

    Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth. \n

    \n     " + "smithy.api#documentation": "

    A value that indicates whether to enable Performance Insights for the DB instance.\n

    \n

    For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

    " } }, - "S3Prefix": { + "S3BucketName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The prefix of your Amazon S3 bucket.\n

    " + "smithy.api#documentation": "

    The name of your Amazon S3 bucket \n that contains your database backup file. \n

    ", + "smithy.api#required": {} } }, - "StorageType": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.\n

    \n

    Valid values: standard | gp2 | io1\n

    \n

    If you specify io1, \n you must also include a value for the Iops parameter.\n

    \n

    Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

    " + "smithy.api#documentation": "

    The name of the database engine to be used for this instance.\n

    \n \n

    Valid Values: mysql\n

    ", + "smithy.api#required": {} } }, - "PreferredMaintenanceWindow": { + "SourceEngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

    \n\n

    Constraints:

    \n
      \n
    • \n

      Must be in the format ddd:hh24:mi-ddd:hh24:mi.

      \n
      • \n
    • \n

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred backup window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    The version of the database that the backup files were created from.

    \n

    MySQL versions 5.6 and 5.7 are supported.\n

    \n

    Example: 5.6.40\n

    ", + "smithy.api#required": {} } }, "PerformanceInsightsRetentionPeriod": { @@ -16147,53 +16222,68 @@ "smithy.api#documentation": "

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " } }, - "S3BucketName": { + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " + } + }, + "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of your Amazon S3 bucket \n that contains your database backup file. \n

    ", + "smithy.api#documentation": "

    The compute and memory capacity of the DB instance, \n for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

    \n

    Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n

    ", "smithy.api#required": {} } }, - "DBSubnetGroupName": { + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

    A list of VPC security groups to associate with this DB instance.\n

    " + } + }, + "S3IngestionRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    " + "smithy.api#documentation": "

    An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. \n

    ", + "smithy.api#required": {} } }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "Tags": { + "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

    A list of DB security groups to associate with this DB instance.

    \n

    Default: The default DB security group for the database engine.

    " + "smithy.api#documentation": "

    A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide. \n

    " } }, - "KmsKeyId": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for an encrypted DB instance.\n

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. \n If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, \n then you can use the KMS key alias instead of the ARN for the KM encryption key.\n

    \n

    If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default encryption key. \n AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.\n

    " + "smithy.api#documentation": "

    The DB instance identifier. This parameter is stored as a lowercase string.\n

    \n\n

    Constraints:

    \n\n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n\n

    Example: mydbinstance\n

    ", + "smithy.api#required": {} } }, - "MasterUserPassword": { + "SourceEngine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n

    \n \n

    Constraints: Must contain from 8 to 41 characters.

    " + "smithy.api#documentation": "

    The name of the engine of your source database.\n

    \n \n

    Valid Values: mysql\n

    ", + "smithy.api#required": {} } }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", + "OptionGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

    " + "smithy.api#documentation": "

    The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.\n

    " } }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " } }, - "DBName": { - "target": "com.amazonaws.rds#String", + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.\n

    " + "smithy.api#documentation": "

    A value that indicates whether the new DB instance is encrypted or not.\n

    " } }, "MonitoringRoleArn": { @@ -16202,16 +16292,10 @@ "smithy.api#documentation": "

    The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

    \n

    If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.\n

    " } }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see The Backup Window in the Amazon RDS User Guide.\n

    \n \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The name for the master user.\n

    \n \n

    Constraints:\n

    \n
      \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    " + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. \n

    " } }, "BackupRetentionPeriod": { @@ -16220,16 +16304,22 @@ "smithy.api#documentation": "

    The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.\n

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A list of VPC security groups to associate with this DB instance.\n

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data.\n The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, \n or the KMS key alias for the KMS encryption key.\n

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " } }, - "CopyTagsToSnapshot": { + "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. \n

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.\n

    " + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " } }, "Port": { @@ -16238,11 +16328,10 @@ "smithy.api#documentation": "

    The port number on which the database accepts connections.\n

    \n

    Type: Integer\n

    \n

    Valid Values: 1150-65535\n

    \n

    Default: 3306\n

    " } }, - "SourceEngine": { + "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the engine of your source database.\n

    \n \n

    Valid Values: mysql\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n

    \n \n

    Constraints: Must contain from 8 to 41 characters.

    " } }, "MonitoringInterval": { @@ -16251,74 +16340,76 @@ "smithy.api#documentation": "

    The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.\n

    \n\n

    If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.\n

    \n\n

    Valid Values: 0, 1, 5, 10, 15, 30, 60\n

    \n

    Default: 0\n

    " } }, - "AutoMinorVersionUpgrade": { + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

    A list of DB security groups to associate with this DB instance.

    \n

    Default: The default DB security group for the database engine.

    " + } + }, + "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.\n

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

    " } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance \n in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.\n

    " } }, - "DBInstanceIdentifier": { + "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB instance identifier. This parameter is stored as a lowercase string.\n

    \n\n

    Constraints:

    \n\n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    \n\n

    Example: mydbinstance\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

    " } }, - "Engine": { + "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the database engine to be used for this instance.\n

    \n \n

    Valid Values: mysql\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name for the master user.\n

    \n \n

    Constraints:\n

    \n
      \n
    • \n

      Must be 1 to 16 letters or numbers.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't be a reserved word for the chosen database engine.

      \n
      • \n
    " } }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to enable Performance Insights for the DB instance.\n

    \n

    For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n

    " + "smithy.api#documentation": "

    The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see The Backup Window in the Amazon RDS User Guide.\n

    \n \n

    Constraints:

    \n
      \n
    • \n

      Must be in the format hh24:mi-hh24:mi.

      \n
      • \n
    • \n

      Must be in Universal Coordinated Time (UTC).

      \n
      • \n
    • \n

      Must not conflict with the preferred maintenance window.

      \n
      • \n
    • \n

      Must be at least 30 minutes.

      \n
      • \n
    " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", + "DBName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.\n

    " + "smithy.api#documentation": "

    The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.\n

    " } }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the new DB instance is encrypted or not.\n

    " + "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " } }, - "DBInstanceClass": { + "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The compute and memory capacity of the DB instance, \n for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

    \n

    Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    " } }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + "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

    " } }, - "S3IngestionRoleArn": { + "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. \n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Availability Zone that the DB instance is created in. \n For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

    \n

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.\n

    \n

    \n Example: us-east-1d\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

    " } }, - "PerformanceInsightsKMSKeyId": { + "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of Performance Insights data.\n The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, \n or the KMS key alias for the KMS encryption key.\n

    \n

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for an encrypted DB instance.\n

    \n

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. \n If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, \n then you can use the KMS key alias instead of the ARN for the KM encryption key.\n

    \n

    If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default encryption key. \n AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS Region.\n

    " } } } @@ -16414,22 +16505,40 @@ "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { "type": "structure", "members": { - "SourceDBInstanceIdentifier": { + "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the source DB instance from which to restore.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DB instance.

      \n
      • \n
    " + "smithy.api#documentation": "

    The DB subnet group name to use for the new instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    " } }, - "LicenseModel": { + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    " + } + }, + "SourceDbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    License model information for the restored DB instance.

    \n

    Default: Same as source.

    \n

    \n Valid values: license-included | bring-your-own-license | general-public-license\n

    " + "smithy.api#documentation": "

    The resource ID of the source DB instance from which to restore.

    " } }, - "Engine": { + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

    \n A list of EC2 VPC security groups to associate with this DB instance.\n

    \n

    \n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

    " + } + }, + "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database engine to use for the new instance.

    \n

    Default: The same as source

    \n

    Constraint: Must be compatible with the engine of the source

    \n\n

    Valid Values:

    \n \n
      \n
    • \n

      \n mariadb\n

      \n
      • \n
    • \n

      \n mysql\n

      \n
      • \n
    • \n

      \n oracle-ee\n

      \n
      • \n
    • \n

      \n oracle-se2\n

      \n
      • \n
    • \n

      \n oracle-se1\n

      \n
      • \n
    • \n

      \n oracle-se\n

      \n
      • \n
    • \n

      \n postgres\n

      \n
      • \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    \n

    Default: The same DBInstanceClass as the original DB instance.

    " + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

    " } }, "Iops": { @@ -16438,10 +16547,10 @@ "smithy.api#documentation": "

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    \n

    Constraints: Must be an integer greater than 1000.

    \n

    \n SQL Server\n

    \n

    Setting the IOPS value for the SQL Server database engine isn't supported.

    " } }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    \n A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.\n

    \n

    Constraints: Can't be specified if the RestoreTime parameter is provided.

    " } }, "StorageType": { @@ -16450,64 +16559,61 @@ "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB instance.

    \n

    \n Valid values: standard | gp2 | io1\n

    \n

    \n If you specify io1, you must also include a value for the\n Iops parameter.\n

    \n

    \n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

    " } }, - "TdeCredentialPassword": { + "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The password for the given ARN from the key store in order to access the device.

    " + "smithy.api#documentation": "

    The identifier of the source DB instance from which to restore.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DB instance.

      \n
      • \n
    " } }, - "DBSubnetGroupName": { + "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB subnet group name to use for the new instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    The password for the given ARN from the key store in order to access the device.

    " } }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.rds#Boolean", + "OptionGroupName": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.\n

    \n

    Constraints: Can't be specified if the RestoreTime parameter is provided.

    " + "smithy.api#documentation": "

    The name of the option group to be used for the restored DB instance.

    \n \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " } }, - "DeletionProtection": { + "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "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

    " + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    " } }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The name of the option group to be used for the restored DB instance.

    \n \n

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " } }, - "DBName": { + "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The database name for the restored DB instance.

    \n \n

    This parameter isn't used for the MySQL or MariaDB engines.

    \n     " + "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

    \n A list of EC2 VPC security groups to associate with this DB instance.\n

    \n

    \n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n

    " - } + "Tags": { + "target": "com.amazonaws.rds#TagList" }, - "AvailabilityZone": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Availability Zone (AZ) where the DB instance will be created.

    \n

    Default: A random, system-chosen Availability Zone.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    \n

    Example: us-east-1a\n

    " + "smithy.api#documentation": "

    The database engine to use for the new instance.

    \n

    Default: The same as source

    \n

    Constraint: Must be compatible with the engine of the source

    \n\n

    Valid Values:

    \n \n
      \n
    • \n

      \n mariadb\n

      \n
      • \n
    • \n

      \n mysql\n

      \n
      • \n
    • \n

      \n oracle-ee\n

      \n
      • \n
    • \n

      \n oracle-se2\n

      \n
      • \n
    • \n

      \n oracle-se1\n

      \n
      • \n
    • \n

      \n oracle-se\n

      \n
      • \n
    • \n

      \n postgres\n

      \n
      • \n
    • \n

      \n sqlserver-ee\n

      \n
      • \n
    • \n

      \n sqlserver-se\n

      \n
      • \n
    • \n

      \n sqlserver-ex\n

      \n
      • \n
    • \n

      \n sqlserver-web\n

      \n
      • \n
    " } }, - "SourceDbiResourceId": { + "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The resource ID of the source DB instance from which to restore.

    " + "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only Microsoft SQL Server and \n Oracle DB instances can be created in an Active Directory Domain.\n

    \n

    For Microsoft SQL Server DB instances, Amazon RDS can use \n Windows Authentication to authenticate users that connect to the DB instance. For more\n information, see \n Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the \n Amazon RDS User Guide.

    \n

    For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. \n For more information, see \n Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

    \n

    For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

    " } }, "EnableIAMDatabaseAuthentication": { @@ -16516,86 +16622,77 @@ "smithy.api#documentation": "

    A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled. \n For information about the supported DB engines, see CreateDBInstance.

    \n \n

    For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

    " } }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    " - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", + "TargetDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " + "smithy.api#documentation": "

    The name of the new DB instance to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

    The port number on which the database accepts connections.

    \n

    Constraints: Value must be 1150-65535\n

    \n

    Default: The same port as the original DB instance.

    " + "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " } }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", + "RestoreTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    A value that indicates whether the DB instance is a Multi-AZ deployment.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " + "smithy.api#documentation": "

    The date and time to restore from.

    \n

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    \n

    Constraints:

    \n
      \n
    • \n

      Must be before the latest restorable time for the DB instance

      \n
      • \n
    • \n

      Can't be specified if the UseLatestRestorableTime parameter is enabled

      \n
      • \n
    \n

    Example: 2009-09-07T23:45:00Z\n

    " } }, - "DomainIAMRoleName": { + "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBParameterGroup.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " } }, - "RestoreTime": { - "target": "com.amazonaws.rds#TStamp", + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The date and time to restore from.

    \n

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    \n

    Constraints:

    \n
      \n
    • \n

      Must be before the latest restorable time for the DB instance

      \n
      • \n
    • \n

      Can't be specified if the UseLatestRestorableTime parameter is enabled

      \n
      • \n
    \n

    Example: 2009-09-07T23:45:00Z\n

    " + "smithy.api#documentation": "

    The port number on which the database accepts connections.

    \n

    Constraints: Value must be 1150-65535\n

    \n

    Default: The same port as the original DB instance.

    " } }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + "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

    " } }, - "TargetDBInstanceIdentifier": { + "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the new DB instance to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 letters, numbers, or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The database name for the restored DB instance.

    \n \n

    This parameter isn't used for the MySQL or MariaDB engines.

    \n     " } }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", + "LicenseModel": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + "smithy.api#documentation": "

    License model information for the restored DB instance.

    \n

    Default: Same as source.

    \n

    \n Valid values: license-included | bring-your-own-license | general-public-license\n

    " } }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "DBParameterGroupName": { + "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB parameter group to associate with this DB instance.

    \n

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

    \n

    Constraints:

    \n
      \n
    • \n

      If supplied, must match the name of an existing DBParameterGroup.

      \n
      • \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " + "smithy.api#documentation": "

    The Availability Zone (AZ) where the DB instance will be created.

    \n

    Default: A random, system-chosen Availability Zone.

    \n

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    \n

    Example: us-east-1a\n

    " } }, - "AutoMinorVersionUpgrade": { + "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

    " + "smithy.api#documentation": "

    A value that indicates whether the DB instance is publicly accessible.

    \n

    When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    \n

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    \n

    For more information, see CreateDBInstance.

    " } }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    " + "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " } }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

    The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

    \n

    Default: The same DBInstanceClass as the original DB instance.

    " + "smithy.api#documentation": "

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " } } }, @@ -16614,16 +16711,16 @@ "com.amazonaws.rds#RestoreWindow": { "type": "structure", "members": { - "EarliestTime": { + "LatestTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The earliest time you can restore an instance to.

    " + "smithy.api#documentation": "

    The latest time you can restore an instance to.

    " } }, - "LatestTime": { + "EarliestTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The latest time you can restore an instance to.

    " + "smithy.api#documentation": "

    The earliest time you can restore an instance to.

    " } } }, @@ -16657,13 +16754,6 @@ "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { "type": "structure", "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The name of the DB security group to revoke ingress from.

    ", - "smithy.api#required": {} - } - }, "CIDRIP": { "target": "com.amazonaws.rds#String", "traits": { @@ -16682,6 +16772,13 @@ "smithy.api#documentation": "

    \n The AWS account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

    " } }, + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The name of the DB security group to revoke ingress from.

    ", + "smithy.api#required": {} + } + }, "EC2SecurityGroupId": { "target": "com.amazonaws.rds#String", "traits": { @@ -16743,10 +16840,10 @@ "com.amazonaws.rds#ScalingConfiguration": { "type": "structure", "members": { - "SecondsUntilAutoPause": { - "target": "com.amazonaws.rds#IntegerOptional", + "AutoPause": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

    " + "smithy.api#documentation": "

    A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. \n A DB cluster can be paused only when it's idle (it has no connections).

    \n \n

    If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. \n In this case, the DB cluster is restored when there is a request to connect to it.

    \n     " } }, "TimeoutAction": { @@ -16755,22 +16852,22 @@ "smithy.api#documentation": "

    The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

    \n

    \n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

    \n

    \n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

    \n \n

    If you specify ForceApplyCapacityChange, connections that \n prevent Aurora Serverless from finding a scaling point might be dropped.

    \n     \n

    For more information, see \n Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

    " } }, - "MinCapacity": { + "MaxCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

    \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n

    The minimum capacity must be less than or equal to the maximum capacity.

    " + "smithy.api#documentation": "

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n

    The maximum capacity must be greater than or equal to the minimum capacity.

    " } }, - "MaxCapacity": { + "SecondsUntilAutoPause": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n

    The maximum capacity must be greater than or equal to the minimum capacity.

    " + "smithy.api#documentation": "

    The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

    " } }, - "AutoPause": { - "target": "com.amazonaws.rds#BooleanOptional", + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. \n A DB cluster can be paused only when it's idle (it has no connections).

    \n \n

    If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. \n In this case, the DB cluster is restored when there is a request to connect to it.

    \n     " + "smithy.api#documentation": "

    The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

    \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n

    The minimum capacity must be less than or equal to the maximum capacity.

    " } } }, @@ -16781,10 +16878,10 @@ "com.amazonaws.rds#ScalingConfigurationInfo": { "type": "structure", "members": { - "TimeoutAction": { - "target": "com.amazonaws.rds#String", + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.

    " + "smithy.api#documentation": "

    The maximum capacity for the Aurora DB cluster in serverless DB engine\n mode.

    " } }, "SecondsUntilAutoPause": { @@ -16793,6 +16890,12 @@ "smithy.api#documentation": "

    The remaining amount of time, in seconds, before the Aurora DB cluster in\n serverless mode is paused. A DB cluster can be paused only when\n it's idle (it has no connections).

    " } }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.

    " + } + }, "AutoPause": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -16802,13 +16905,7 @@ "MaxCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    " - } - }, - "MinCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum capacity for the Aurora DB cluster in serverless DB engine\n mode.

    " + "smithy.api#documentation": "

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    " } } }, @@ -16867,12 +16964,6 @@ "com.amazonaws.rds#SourceRegion": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

    The endpoint for the source AWS Region endpoint.

    " - } - }, "Status": { "target": "com.amazonaws.rds#String", "traits": { @@ -16884,6 +16975,12 @@ "traits": { "smithy.api#documentation": "

    The name of the source AWS Region.

    " } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The endpoint for the source AWS Region endpoint.

    " + } } }, "traits": { @@ -16902,17 +16999,17 @@ "com.amazonaws.rds#SourceRegionMessage": { "type": "structure", "members": { - "SourceRegions": { - "target": "com.amazonaws.rds#SourceRegionList", - "traits": { - "smithy.api#documentation": "

    A list of SourceRegion instances that contains each source AWS Region that the\n current AWS Region can get a read replica or a DB snapshot from.

    " - } - }, "Marker": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    \n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

    " } + }, + "SourceRegions": { + "target": "com.amazonaws.rds#SourceRegionList", + "traits": { + "smithy.api#documentation": "

    A list of SourceRegion instances that contains each source AWS Region that the\n current AWS Region can get a read replica or a DB snapshot from.

    " + } } }, "traits": { @@ -16979,10 +17076,11 @@ "com.amazonaws.rds#StartActivityStreamRequest": { "type": "structure", "members": { - "ApplyImmediately": { - "target": "com.amazonaws.rds#BooleanOptional", + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", "traits": { - "smithy.api#documentation": "

    Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

    " + "smithy.api#documentation": "

    Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n

    ", + "smithy.api#required": {} } }, "ResourceArn": { @@ -16999,11 +17097,10 @@ "smithy.api#required": {} } }, - "Mode": { - "target": "com.amazonaws.rds#ActivityStreamMode", + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

    " } } } @@ -17011,16 +17108,22 @@ "com.amazonaws.rds#StartActivityStreamResponse": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

    The status of the database activity stream.

    " + } + }, "KinesisStreamName": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The name of the Amazon Kinesis data stream to be used for the database activity stream.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of messages in the database activity stream.

    " + "smithy.api#documentation": "

    Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

    " } }, "Mode": { @@ -17029,16 +17132,10 @@ "smithy.api#documentation": "

    The mode of the database activity stream.

    " } }, - "Status": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

    The status of the database activity stream.

    " - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", + "KmsKeyId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

    " + "smithy.api#documentation": "

    The AWS KMS key identifier for encryption of messages in the database activity stream.

    " } } } @@ -17197,51 +17294,51 @@ "com.amazonaws.rds#StartExportTaskMessage": { "type": "structure", "members": { - "ExportTaskIdentifier": { + "SourceArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

    ", "smithy.api#required": {} } }, - "ExportOnly": { - "target": "com.amazonaws.rds#StringList", + "S3Prefix": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:

    \n
      \n
    • \n

      \n database - Export all the data from a specified database.

      \n
      • \n
    • \n

      \n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      \n
      • \n
    • \n

      \n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    • \n

      \n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    " + "smithy.api#documentation": "

    The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

    " } }, - "S3BucketName": { + "IamRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the Amazon S3 bucket to export the snapshot to.

    ", + "smithy.api#documentation": "

    The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.

    ", "smithy.api#required": {} } }, - "KmsKeyId": { + "S3BucketName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The\n KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key\n alias for the KMS encryption key. The IAM role used for the snapshot export must have\n encryption and decryption permissions to use this KMS key.

    ", + "smithy.api#documentation": "

    The name of the Amazon S3 bucket to export the snapshot to.

    ", "smithy.api#required": {} } }, - "SourceArn": { - "target": "com.amazonaws.rds#String", + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:

    \n
      \n
    • \n

      \n database - Export all the data from a specified database.

      \n
      • \n
    • \n

      \n database.table \n table-name - \n Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      \n
      • \n
    • \n

      \n database.schema \n schema-name - Export a database schema of the snapshot. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    • \n

      \n database.schema.table \n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    " } }, - "IamRoleArn": { + "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.

    ", + "smithy.api#documentation": "

    The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The\n KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key\n alias for the KMS encryption key. The caller of this operation must be authorized to \n execute the following operations. These can be set in the KMS key policy:

    \n
      \n
    • \n

      GrantOperation.Encrypt

      \n
      • \n
    • \n

      GrantOperation.Decrypt

      \n
      • \n
    • \n

      GrantOperation.GenerateDataKey

      \n
      • \n
    • \n

      GrantOperation.GenerateDataKeyWithoutPlaintext

      \n
      • \n
    • \n

      GrantOperation.ReEncryptFrom

      \n
      • \n
    • \n

      GrantOperation.ReEncryptTo

      \n
      • \n
    • \n

      GrantOperation.CreateGrant

      \n
      • \n
    • \n

      GrantOperation.DescribeKey

      \n
      • \n
    • \n

      GrantOperation.RetireGrant

      \n
      • \n
    ", "smithy.api#required": {} } }, - "S3Prefix": { + "ExportTaskIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

    " + "smithy.api#documentation": "

    A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.

    ", + "smithy.api#required": {} } } } @@ -17278,18 +17375,18 @@ "com.amazonaws.rds#StopActivityStreamRequest": { "type": "structure", "members": { - "ApplyImmediately": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.

    " - } - }, "ResourceArn": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.\n

    ", "smithy.api#required": {} } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.

    " + } } } }, @@ -17391,17 +17488,17 @@ "com.amazonaws.rds#StopDBInstanceMessage": { "type": "structure", "members": { - "DBInstanceIdentifier": { + "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The user-supplied instance identifier.\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    \n The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.\n

    " } }, - "DBSnapshotIdentifier": { + "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    \n The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.\n

    " + "smithy.api#documentation": "

    \n The user-supplied instance identifier.\n

    ", + "smithy.api#required": {} } } } @@ -17464,15 +17561,15 @@ "smithy.api#documentation": "

    The identifier of the subnet.

    " } }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.rds#AvailabilityZone" + }, "SubnetStatus": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

    The status of the subnet.

    " } }, - "SubnetAvailabilityZone": { - "target": "com.amazonaws.rds#AvailabilityZone" - }, "SubnetOutpost": { "target": "com.amazonaws.rds#Outpost", "traits": { @@ -17581,13 +17678,13 @@ "Value": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

    " + "smithy.api#documentation": "

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

    " } }, "Key": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

    " + "smithy.api#documentation": "

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

    " } } }, @@ -17630,10 +17727,10 @@ "com.amazonaws.rds#TargetHealth": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.rds#TargetHealthReason", + "Description": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The reason for the current health State of the RDS Proxy target.

    " + "smithy.api#documentation": "

    A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.

    " } }, "State": { @@ -17642,10 +17739,10 @@ "smithy.api#documentation": "

    The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:\n

    \n

    \n registering > unavailable > available > unavailable > available\n

    " } }, - "Description": { - "target": "com.amazonaws.rds#String", + "Reason": { + "target": "com.amazonaws.rds#TargetHealthReason", "traits": { - "smithy.api#documentation": "

    A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.

    " + "smithy.api#documentation": "

    The reason for the current health State of the RDS Proxy target.

    " } } }, @@ -17737,16 +17834,10 @@ "com.amazonaws.rds#UpgradeTarget": { "type": "structure", "members": { - "EngineVersion": { + "Description": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version number of the upgrade target database engine.

    " - } - }, - "AutoUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

    " + "smithy.api#documentation": "

    The version of the database engine that a DB instance can be upgraded to.

    " } }, "IsMajorVersionUpgrade": { @@ -17755,16 +17846,22 @@ "smithy.api#documentation": "

    A value that indicates whether a database engine is upgraded to a major version.

    " } }, - "Description": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The version of the database engine that a DB instance can be upgraded to.

    " + "smithy.api#documentation": "

    The name of the upgrade target database engine.

    " } }, - "Engine": { + "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the upgrade target database engine.

    " + "smithy.api#documentation": "

    The version number of the upgrade target database engine.

    " + } + }, + "AutoUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

    " } } }, @@ -17775,10 +17872,10 @@ "com.amazonaws.rds#UserAuthConfig": { "type": "structure", "members": { - "AuthScheme": { - "target": "com.amazonaws.rds#AuthScheme", + "SecretArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The type of authentication that the proxy uses for connections from the proxy to the underlying database.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    " } }, "IAMAuth": { @@ -17787,10 +17884,10 @@ "smithy.api#documentation": "

    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

    " } }, - "SecretArn": { + "UserName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    " + "smithy.api#documentation": "

    The name of the database user to which the proxy connects.

    " } }, "Description": { @@ -17799,10 +17896,10 @@ "smithy.api#documentation": "

    A user-specified description about the authentication used by a proxy to log in as a specific database user.

    " } }, - "UserName": { - "target": "com.amazonaws.rds#String", + "AuthScheme": { + "target": "com.amazonaws.rds#AuthScheme", "traits": { - "smithy.api#documentation": "

    The name of the database user to which the proxy connects.

    " + "smithy.api#documentation": "

    The type of authentication that the proxy uses for connections from the proxy to the underlying database.

    " } } }, @@ -17813,16 +17910,16 @@ "com.amazonaws.rds#UserAuthConfigInfo": { "type": "structure", "members": { - "UserName": { + "SecretArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the database user to which the proxy connects.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    " } }, - "SecretArn": { + "UserName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

    " + "smithy.api#documentation": "

    The name of the database user to which the proxy connects.

    " } }, "Description": { @@ -17863,17 +17960,17 @@ "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { "type": "structure", "members": { - "ValidProcessorFeatures": { - "target": "com.amazonaws.rds#AvailableProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

    Valid processor features for your DB instance.\n

    " - } - }, "Storage": { "target": "com.amazonaws.rds#ValidStorageOptionsList", "traits": { "smithy.api#documentation": "

    Valid storage options for your DB instance.\n

    " } + }, + "ValidProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

    Valid processor features for your DB instance.\n

    " + } } }, "traits": { @@ -17883,6 +17980,18 @@ "com.amazonaws.rds#ValidStorageOptions": { "type": "structure", "members": { + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

    " + } + }, + "IopsToStorageRatio": { + "target": "com.amazonaws.rds#DoubleRangeList", + "traits": { + "smithy.api#documentation": "

    The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.\n

    " + } + }, "StorageSize": { "target": "com.amazonaws.rds#RangeList", "traits": { @@ -17900,18 +18009,6 @@ "traits": { "smithy.api#documentation": "

    The valid storage types for your DB instance.\n For example, gp2, io1.\n

    " } - }, - "SupportsStorageAutoscaling": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

    Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

    " - } - }, - "IopsToStorageRatio": { - "target": "com.amazonaws.rds#DoubleRangeList", - "traits": { - "smithy.api#documentation": "

    The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.\n

    " - } } }, "traits": { @@ -17948,16 +18045,16 @@ "com.amazonaws.rds#VpcSecurityGroupMembership": { "type": "structure", "members": { - "Status": { + "VpcSecurityGroupId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of the VPC security group.

    " + "smithy.api#documentation": "

    The name of the VPC security group.

    " } }, - "VpcSecurityGroupId": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the VPC security group.

    " + "smithy.api#documentation": "

    The status of the VPC security group.

    " } } }, @@ -17977,40 +18074,40 @@ "com.amazonaws.rds#VpnDetails": { "type": "structure", "members": { - "VpnTunnelOriginatorIP": { + "VpnId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

    " + "smithy.api#documentation": "

    The ID of the VPN.

    " } }, - "VpnPSK": { - "target": "com.amazonaws.rds#StringSensitive", + "VpnState": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The preshared key (PSK) for the VPN.

    " + "smithy.api#documentation": "

    The state of the VPN.

    " } }, - "VpnId": { + "VpnTunnelOriginatorIP": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The ID of the VPN.

    " + "smithy.api#documentation": "

    The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

    " } }, - "VpnGatewayIp": { + "VpnName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The IP address of network traffic from AWS to your on-premises data center.

    " + "smithy.api#documentation": "

    The name of the VPN.

    " } }, - "VpnState": { - "target": "com.amazonaws.rds#String", + "VpnPSK": { + "target": "com.amazonaws.rds#StringSensitive", "traits": { - "smithy.api#documentation": "

    The state of the VPN.

    " + "smithy.api#documentation": "

    The preshared key (PSK) for the VPN.

    " } }, - "VpnName": { + "VpnGatewayIp": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the VPN.

    " + "smithy.api#documentation": "

    The IP address of network traffic from AWS to your on-premises data center.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json b/codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json new file mode 100644 index 000000000000..f74b94d0c5dc --- /dev/null +++ b/codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json @@ -0,0 +1,1399 @@ +{ + "smithy": "1.0", + "shapes": { + "aws.api#ArnNamespace": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9.\\-]{1,63}$", + "smithy.api#private": {} + } + }, + "com.amazonaws.redshiftdata#Blob": { + "type": "blob" + }, + "com.amazonaws.redshiftdata#BoxedBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.redshiftdata#BoxedDouble": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.redshiftdata#BoxedLong": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.redshiftdata#CancelStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#CancelStatementRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#CancelStatementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Cancels a running query. To be canceled, a query must be running.

    " + } + }, + "com.amazonaws.redshiftdata#CancelStatementRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

    The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. \n This identifier is returned by ExecuteStatment and ListStatements.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.redshiftdata#CancelStatementResponse": { + "type": "structure", + "members": { + "Status": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the cancel statement succeeded (true).

    " + } + } + } + }, + "aws.api#CloudFormationName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Z][A-Za-z0-9]+$", + "smithy.api#private": {} + } + }, + "com.amazonaws.redshiftdata#ColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#ColumnMetadata" + } + }, + "com.amazonaws.redshiftdata#ColumnMetadata": { + "type": "structure", + "members": { + "isCaseSensitive": { + "target": "com.amazonaws.redshiftdata#bool", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the column is case-sensitive.

    " + } + }, + "isCurrency": { + "target": "com.amazonaws.redshiftdata#bool", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the column contains currency values.

    " + } + }, + "isSigned": { + "target": "com.amazonaws.redshiftdata#bool", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether an integer column is signed.

    " + } + }, + "label": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The label for the column.

    " + } + }, + "name": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the column.

    " + } + }, + "nullable": { + "target": "com.amazonaws.redshiftdata#Integer", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the column is nullable.

    " + } + }, + "precision": { + "target": "com.amazonaws.redshiftdata#Integer", + "traits": { + "smithy.api#documentation": "

    The precision value of a decimal number column.

    " + } + }, + "scale": { + "target": "com.amazonaws.redshiftdata#Integer", + "traits": { + "smithy.api#documentation": "

    The scale value of a decimal number column.

    " + } + }, + "schemaName": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the schema that contains the table that includes the column.

    " + } + }, + "tableName": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the table that includes the column.

    " + } + }, + "typeName": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database-specific data type of the column.

    " + } + }, + "length": { + "target": "com.amazonaws.redshiftdata#Integer", + "traits": { + "smithy.api#documentation": "

    The length of the column.

    " + } + }, + "columnDefault": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The default value of the column.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The properties (metadata) of a column.

    " + } + }, + "com.amazonaws.redshiftdata#ColumnMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#ColumnMetadata" + } + }, + "com.amazonaws.redshiftdata#DatabaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#String" + } + }, + "com.amazonaws.redshiftdata#DescribeStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#DescribeStatementRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#DescribeStatementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information\n includes when the query started, when it finished, the query status, the number of rows returned, and the SQL\n statement.

    ", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftdata#DescribeStatementRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

    The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. \n This identifier is returned by ExecuteStatment and ListStatements.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.redshiftdata#DescribeStatementResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

    The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    ", + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.redshiftdata#StatementString", + "traits": { + "smithy.api#documentation": "

    The SQL statement text.

    " + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

    " + } + }, + "DbUser": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database user name.

    " + } + }, + "Database": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the database.

    " + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The cluster identifier.

    " + } + }, + "ResultRows": { + "target": "com.amazonaws.redshiftdata#Long", + "traits": { + "smithy.api#documentation": "

    Either the number of rows returned from the SQL statement or the number of rows affected.\n If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.

    " + } + }, + "ResultSize": { + "target": "com.amazonaws.redshiftdata#Long", + "traits": { + "smithy.api#documentation": "

    The size in bytes of the returned results.

    " + } + }, + "Duration": { + "target": "com.amazonaws.redshiftdata#Long", + "traits": { + "smithy.api#documentation": "

    The amount of time in nanoseconds that the statement ran.

    " + } + }, + "Error": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The error message from the cluster if the SQL statement encountered an error while running.

    " + } + }, + "Status": { + "target": "com.amazonaws.redshiftdata#StatusString", + "traits": { + "smithy.api#documentation": "

    The status of the SQL statement being described. Status values are defined as follows:

    \n
      \n
    • \n

      ABORTED - The query run was stopped by the user.

      \n
      • \n
    • \n

      ALL - A status value that includes all query statuses. This value can be used to filter results.

      \n
      • \n
    • \n

      FAILED - The query run failed.

      \n
      • \n
    • \n

      FINISHED - The query has finished running.

      \n
      • \n
    • \n

      PICKED - The query has been chosen to be run.

      \n
      • \n
    • \n

      STARTED - The query run has started.

      \n
      • \n
    • \n

      SUBMITTED - The query was submitted, but not yet processed.

      \n
      • \n
    " + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time (UTC) when the SQL statement was submitted to run.

    " + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time (UTC) that the metadata for the SQL statement was last updated. An\n example is the time the status last changed.

    " + } + }, + "RedshiftQueryId": { + "target": "com.amazonaws.redshiftdata#Long", + "traits": { + "smithy.api#documentation": "

    The identifier of the query generated by Amazon Redshift. \n These identifiers are also available in the query column of the STL_QUERY system view.

    " + } + }, + "RedshiftPid": { + "target": "com.amazonaws.redshiftdata#Long", + "traits": { + "smithy.api#documentation": "

    The process identifier from Amazon Redshift.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#DescribeTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#DescribeTableRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#DescribeTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

    \n
      \n
    • \n

      AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the \n cluster identifier that matches the cluster in the secret.

      \n
      • \n
    • \n

      Temporary credentials - specify the cluster identifier, the database name, and the database\n user name. Permission to call the redshift:GetClusterCredentials operation is\n required to use this method.

      \n
      • \n
    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ColumnList", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftdata#DescribeTableRequest": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshiftdata#Location", + "traits": { + "smithy.api#documentation": "

    The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

    ", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

    " + } + }, + "DbUser": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database user name. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "Database": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the database. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "Schema": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

    " + } + }, + "Table": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The table name. If no table is specified, then all tables for all matching schemas are returned. \n If no table and no schema is specified, then all tables for all schemas in the database are returned

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.redshiftdata#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of tables to return in the response. \n If more tables exist than fit in one response, then NextToken is returned to page through the results.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#DescribeTableResponse": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The table name.

    " + } + }, + "ColumnList": { + "target": "com.amazonaws.redshiftdata#ColumnList", + "traits": { + "smithy.api#documentation": "

    A list of columns in the table.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ExecuteStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#ExecuteStatementInput" + }, + "output": { + "target": "com.amazonaws.redshiftdata#ExecuteStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#ExecuteStatementException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:

    \n
      \n
    • \n

      AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the \n cluster identifier that matches the cluster in the secret.

      \n
      • \n
    • \n

      Temporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.

      \n
      • \n
    " + } + }, + "com.amazonaws.redshiftdata#ExecuteStatementException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The exception message.

    ", + "smithy.api#required": {} + } + }, + "StatementId": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    Statement identifier of the exception.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The SQL statement encountered an environmental error while running.

    ", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.redshiftdata#ExecuteStatementInput": { + "type": "structure", + "members": { + "Sql": { + "target": "com.amazonaws.redshiftdata#StatementString", + "traits": { + "smithy.api#documentation": "

    The SQL statement text to run.

    ", + "smithy.api#required": {} + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshiftdata#Location", + "traits": { + "smithy.api#documentation": "

    The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

    ", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

    " + } + }, + "DbUser": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database user name. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "Database": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the database. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "WithEvent": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

    " + } + }, + "StatementName": { + "target": "com.amazonaws.redshiftdata#StatementNameString", + "traits": { + "smithy.api#documentation": "

    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ExecuteStatementOutput": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

    The identifier of the statement to be run. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    " + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time (UTC) the statement was created.

    " + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshiftdata#Location", + "traits": { + "smithy.api#documentation": "

    The cluster identifier.

    " + } + }, + "DbUser": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database user name.

    " + } + }, + "Database": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the database.

    " + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or ARN of the secret that enables access to the database.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#Field": { + "type": "union", + "members": { + "isNull": { + "target": "com.amazonaws.redshiftdata#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether the data is NULL.

    " + } + }, + "booleanValue": { + "target": "com.amazonaws.redshiftdata#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

    A value of the Boolean data type.

    " + } + }, + "longValue": { + "target": "com.amazonaws.redshiftdata#BoxedLong", + "traits": { + "smithy.api#documentation": "

    A value of the long data type.

    " + } + }, + "doubleValue": { + "target": "com.amazonaws.redshiftdata#BoxedDouble", + "traits": { + "smithy.api#documentation": "

    A value of the double data type.

    " + } + }, + "stringValue": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value of the string data type.

    " + } + }, + "blobValue": { + "target": "com.amazonaws.redshiftdata#Blob", + "traits": { + "smithy.api#documentation": "

    A value of the BLOB data type.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A data value in a column.

    " + } + }, + "com.amazonaws.redshiftdata#FieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#Field" + } + }, + "com.amazonaws.redshiftdata#GetStatementResult": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#GetStatementResultRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#GetStatementResultResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Fetches the temporarily cached result of an SQL statement. \n A token is returned to page through the statement results.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Records" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftdata#GetStatementResultRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

    The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. \n This identifier is returned by ExecuteStatment and ListStatements.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#GetStatementResultResponse": { + "type": "structure", + "members": { + "Records": { + "target": "com.amazonaws.redshiftdata#SqlRecords", + "traits": { + "smithy.api#documentation": "

    The results of the SQL statement.

    ", + "smithy.api#required": {} + } + }, + "ColumnMetadata": { + "target": "com.amazonaws.redshiftdata#ColumnMetadataList", + "traits": { + "smithy.api#documentation": "

    The properties (metadata) of a column.

    " + } + }, + "TotalNumRows": { + "target": "com.amazonaws.redshiftdata#Long", + "traits": { + "smithy.api#documentation": "

    The total number of rows in the result set returned from a query. \n You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#Integer": { + "type": "integer" + }, + "com.amazonaws.redshiftdata#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The exception message.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The Amazon Redshift Data API operation failed due to invalid input.

    ", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.redshiftdata#ListDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#ListDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#ListDatabasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

    \n
      \n
    • \n

      AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the \n cluster identifier that matches the cluster in the secret.

      \n
      • \n
    • \n

      Temporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.

      \n
      • \n
    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Databases", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftdata#ListDatabasesRequest": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshiftdata#Location", + "traits": { + "smithy.api#documentation": "

    The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

    ", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the database. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

    " + } + }, + "DbUser": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database user name. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.redshiftdata#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of databases to return in the response. \n If more databases exist than fit in one response, then NextToken is returned to page through the results.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ListDatabasesResponse": { + "type": "structure", + "members": { + "Databases": { + "target": "com.amazonaws.redshiftdata#DatabaseList", + "traits": { + "smithy.api#documentation": "

    The names of databases.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ListSchemas": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#ListSchemasRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#ListSchemasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

    \n
      \n
    • \n

      AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the \n cluster identifier that matches the cluster in the secret.

      \n
      • \n
    • \n

      Temporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.

      \n
      • \n
    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Schemas", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftdata#ListSchemasRequest": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshiftdata#Location", + "traits": { + "smithy.api#documentation": "

    The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

    ", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

    " + } + }, + "DbUser": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database user name. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "Database": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the database. This parameter is required when authenticating using temporary credentials.

    ", + "smithy.api#required": {} + } + }, + "SchemaPattern": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A pattern to filter results by schema name. Within a schema pattern, \"%\" means match any\n substring of 0 or more characters and \"_\" means match any one character. Only schema name\n entries matching the search pattern are returned.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.redshiftdata#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of schemas to return in the response. \n If more schemas exist than fit in one response, then NextToken is returned to page through the results.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ListSchemasResponse": { + "type": "structure", + "members": { + "Schemas": { + "target": "com.amazonaws.redshiftdata#SchemaList", + "traits": { + "smithy.api#documentation": "

    The schemas that match the request pattern.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ListStatements": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#ListStatementsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#ListStatementsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    List of SQL statements. By default, only finished statements are shown. \n A token is returned to page through the statement list.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Statements", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftdata#ListStatementsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.redshiftdata#ListStatementsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.redshiftdata#ListStatementsLimit", + "traits": { + "smithy.api#documentation": "

    The maximum number of SQL statements to return in the response. \n If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.

    " + } + }, + "StatementName": { + "target": "com.amazonaws.redshiftdata#StatementNameString", + "traits": { + "smithy.api#documentation": "

    The name of the SQL statement specified as input to ExecuteStatement to identify the query. \n You can list multiple statements by providing a prefix that matches the beginning of the statement name. \n For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. \n Data API does a case-sensitive match of SQL statement names to the prefix value you provide.

    " + } + }, + "Status": { + "target": "com.amazonaws.redshiftdata#StatusString", + "traits": { + "smithy.api#documentation": "

    The status of the SQL statement to list. Status values are defined as follows:

    \n
      \n
    • \n

      ABORTED - The query run was stopped by the user.

      \n
      • \n
    • \n

      ALL - A status value that includes all query statuses. This value can be used to filter results.

      \n
      • \n
    • \n

      FAILED - The query run failed.

      \n
      • \n
    • \n

      FINISHED - The query has finished running.

      \n
      • \n
    • \n

      PICKED - The query has been chosen to be run.

      \n
      • \n
    • \n

      STARTED - The query run has started.

      \n
      • \n
    • \n

      SUBMITTED - The query was submitted, but not yet processed.

      \n
      • \n
    " + } + } + } + }, + "com.amazonaws.redshiftdata#ListStatementsResponse": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.redshiftdata#StatementList", + "traits": { + "smithy.api#documentation": "

    The SQL statements.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ListTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftdata#ListTablesRequest" + }, + "output": { + "target": "com.amazonaws.redshiftdata#ListTablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftdata#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftdata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

    \n
      \n
    • \n

      AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the \n cluster identifier that matches the cluster in the secret.

      \n
      • \n
    • \n

      Temporary credentials - specify the cluster identifier, the database name, and the\n database user name. Permission to call the redshift:GetClusterCredentials\n operation is required to use this method.

      \n
      • \n
    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tables", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftdata#ListTablesRequest": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshiftdata#Location", + "traits": { + "smithy.api#documentation": "

    The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

    ", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

    " + } + }, + "DbUser": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The database user name. This parameter is required when authenticating using temporary credentials.

    " + } + }, + "Database": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the database. This parameter is required when authenticating using temporary credentials.

    ", + "smithy.api#required": {} + } + }, + "SchemaPattern": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A pattern to filter results by schema name. Within a schema pattern, \"%\" means match any\n substring of 0 or more characters and \"_\" means match any one character. Only schema name\n entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match \n TablePattern are returned. \n If neither SchemaPattern or TablePattern are specified, then all tables are returned.

    " + } + }, + "TablePattern": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A pattern to filter results by table name. Within a table pattern, \"%\" means match any\n substring of 0 or more characters and \"_\" means match any one character. Only table name\n entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match \n SchemaPatternare returned. \n If neither SchemaPattern or TablePattern are specified, then all tables are returned.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.redshiftdata#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of tables to return in the response. \n If more tables exist than fit in one response, then NextToken is returned to page through the results.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#ListTablesResponse": { + "type": "structure", + "members": { + "Tables": { + "target": "com.amazonaws.redshiftdata#TableList", + "traits": { + "smithy.api#documentation": "

    The tables that match the request pattern.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    " + } + } + } + }, + "com.amazonaws.redshiftdata#Location": { + "type": "string" + }, + "com.amazonaws.redshiftdata#Long": { + "type": "long" + }, + "com.amazonaws.redshiftdata#PageSize": { + "type": "integer" + }, + "com.amazonaws.redshiftdata#RedshiftData": { + "type": "service", + "version": "2019-12-20", + "operations": [ + { + "target": "com.amazonaws.redshiftdata#CancelStatement" + }, + { + "target": "com.amazonaws.redshiftdata#DescribeStatement" + }, + { + "target": "com.amazonaws.redshiftdata#DescribeTable" + }, + { + "target": "com.amazonaws.redshiftdata#ExecuteStatement" + }, + { + "target": "com.amazonaws.redshiftdata#GetStatementResult" + }, + { + "target": "com.amazonaws.redshiftdata#ListDatabases" + }, + { + "target": "com.amazonaws.redshiftdata#ListSchemas" + }, + { + "target": "com.amazonaws.redshiftdata#ListStatements" + }, + { + "target": "com.amazonaws.redshiftdata#ListTables" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Redshift Data", + "arnNamespace": "redshift-data", + "cloudFormationName": "RedshiftData", + "cloudTrailEventSource": "redshift-data.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "redshift-data" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

    You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run individual SQL statements, which are committed if the statement succeeds.

    ", + "smithy.api#title": "Redshift Data API Service" + } + }, + "com.amazonaws.redshiftdata#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The exception message.

    ", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    Resource identifier associated with the exception.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The Amazon Redshift Data API operation failed due to a missing resource.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.redshiftdata#SchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#String" + } + }, + "com.amazonaws.redshiftdata#SecretArn": { + "type": "string" + }, + "com.amazonaws.redshiftdata#SqlRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#FieldList" + } + }, + "com.amazonaws.redshiftdata#StatementData": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.redshiftdata#UUID", + "traits": { + "smithy.api#documentation": "

    The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    ", + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.redshiftdata#StatementString", + "traits": { + "smithy.api#documentation": "

    The SQL statement.

    " + } + }, + "SecretArn": { + "target": "com.amazonaws.redshiftdata#SecretArn", + "traits": { + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

    " + } + }, + "Status": { + "target": "com.amazonaws.redshiftdata#StatusString", + "traits": { + "smithy.api#documentation": "

    The status of the SQL statement. An\n example is the that the SQL statement finished.\n

    " + } + }, + "StatementName": { + "target": "com.amazonaws.redshiftdata#StatementNameString", + "traits": { + "smithy.api#documentation": "

    The name of the SQL statement.

    " + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time (UTC) the statement was created.

    " + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time (UTC) that the statement metadata was last updated.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The SQL statement to run.

    " + } + }, + "com.amazonaws.redshiftdata#StatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#StatementData" + } + }, + "com.amazonaws.redshiftdata#StatementNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 500 + } + } + }, + "com.amazonaws.redshiftdata#StatementString": { + "type": "string" + }, + "com.amazonaws.redshiftdata#StatusString": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "PICKED", + "name": "PICKED" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "FINISHED", + "name": "FINISHED" + }, + { + "value": "ABORTED", + "name": "ABORTED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.redshiftdata#String": { + "type": "string" + }, + "aws.protocols#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#private": {} + } + }, + "com.amazonaws.redshiftdata#TableList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#TableMember" + } + }, + "com.amazonaws.redshiftdata#TableMember": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The name of the table.

    " + } + }, + "type": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL\n TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.

    " + } + }, + "schema": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The schema containing the table.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The properties of a table.

    " + } + }, + "com.amazonaws.redshiftdata#UUID": { + "type": "string" + }, + "com.amazonaws.redshiftdata#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.redshiftdata#String", + "traits": { + "smithy.api#documentation": "

    The exception message.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The Amazon Redshift Data API operation failed due to invalid input.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "aws.protocols#awsJson1_1": { + "type": "structure", + "members": { + "http": { + "target": "aws.protocols#StringList" + }, + "eventStreamHttp": { + "target": "aws.protocols#StringList" + } + }, + "traits": { + "smithy.api#documentation": "An RPC-based protocol that sends JSON payloads. This protocol does not use HTTP binding traits.", + "smithy.api#protocolDefinition": { + "traits": ["smithy.api#jsonName"] + }, + "smithy.api#trait": { + "selector": "service" + } + } + }, + "com.amazonaws.redshiftdata#bool": { + "type": "boolean" + }, + "aws.api#service": { + "type": "structure", + "members": { + "sdkId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "arnNamespace": { + "target": "aws.api#ArnNamespace" + }, + "cloudFormationName": { + "target": "aws.api#CloudFormationName" + }, + "cloudTrailEventSource": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#trait": { + "selector": "service" + } + } + }, + "aws.auth#sigv4": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The signature version 4 service signing name to use in the credential scope when signing requests. This value SHOULD match the `arnNamespace` property of the `aws.api#service-trait`.", + "smithy.api#externalDocumentation": { + "Reference": "https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html" + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Signature Version 4 is the process to add authentication information to AWS requests sent by HTTP. For security, most requests to AWS must be signed with an access key, which consists of an access key ID and secret access key. These two keys are commonly referred to as your security credentials.", + "smithy.api#externalDocumentation": { + "Reference": "https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html" + }, + "smithy.api#trait": { + "selector": "service" + } + } + } + } +} 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 3f1cb5874b7b..6cd7c86346bc 100644 --- a/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json +++ b/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json @@ -110,17 +110,17 @@ "com.amazonaws.redshift#AccountAttribute": { "type": "structure", "members": { - "AttributeName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the attribute.

    " - } - }, "AttributeValues": { "target": "com.amazonaws.redshift#AttributeValueList", "traits": { "smithy.api#documentation": "

    A list of attribute values.

    " } + }, + "AttributeName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the attribute.

    " + } } }, "traits": { @@ -141,16 +141,16 @@ "com.amazonaws.redshift#AccountWithRestoreAccess": { "type": "structure", "members": { - "AccountId": { + "AccountAlias": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of an AWS customer account authorized to restore a\n snapshot.

    " + "smithy.api#documentation": "

    The identifier of an AWS support account authorized to restore a snapshot. For AWS\n support, the identifier is amazon-redshift-support.

    " } }, - "AccountAlias": { + "AccountId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of an AWS support account authorized to restore a snapshot. For AWS\n support, the identifier is amazon-redshift-support.

    " + "smithy.api#documentation": "

    The identifier of an AWS customer account authorized to restore a\n snapshot.

    " } } }, @@ -304,11 +304,10 @@ "com.amazonaws.redshift#AuthorizeClusterSecurityGroupIngressMessage": { "type": "structure", "members": { - "ClusterSecurityGroupName": { + "EC2SecurityGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the security group to which the ingress rule is added.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The EC2 security group to be added the Amazon Redshift security group.

    " } }, "CIDRIP": { @@ -317,16 +316,17 @@ "smithy.api#documentation": "

    The IP range to be added the Amazon Redshift security group.

    " } }, - "EC2SecurityGroupName": { + "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The EC2 security group to be added the Amazon Redshift security group.

    " + "smithy.api#documentation": "

    The AWS account number of the owner of the security group specified by the\n EC2SecurityGroupName parameter. The AWS Access Key ID is not an\n acceptable value.

    \n

    Example: 111122223333\n

    " } }, - "EC2SecurityGroupOwnerId": { + "ClusterSecurityGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The AWS account number of the owner of the security group specified by the\n EC2SecurityGroupName parameter. The AWS Access Key ID is not an\n acceptable value.

    \n

    Example: 111122223333\n

    " + "smithy.api#documentation": "

    The name of the security group to which the ingress rule is added.

    ", + "smithy.api#required": {} } } }, @@ -413,17 +413,17 @@ "com.amazonaws.redshift#AvailabilityZone": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the availability zone.

    " - } - }, "SupportedPlatforms": { "target": "com.amazonaws.redshift#SupportedPlatformsList", "traits": { "smithy.api#documentation": "

    " } + }, + "Name": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the availability zone.

    " + } } }, "traits": { @@ -540,18 +540,18 @@ "smithy.api#documentation": "

    The number of days that a manual snapshot is retained. If you specify the value -1,\n the manual snapshot is retained indefinitely.

    \n

    The number must be either -1 or an integer between 1 and 3,653.

    \n

    If you decrease the manual snapshot retention period from its current value, existing\n manual snapshots that fall outside of the new retention period will return an error. If\n you want to suppress the errors and delete the snapshots, use the force option.

    " } }, - "Force": { - "target": "com.amazonaws.redshift#Boolean", - "traits": { - "smithy.api#documentation": "

    A boolean value indicating whether to override an exception if the retention period\n has passed.

    " - } - }, "SnapshotIdentifierList": { "target": "com.amazonaws.redshift#SnapshotIdentifierList", "traits": { "smithy.api#documentation": "

    A list of snapshot identifiers you want to modify.

    ", "smithy.api#required": {} } + }, + "Force": { + "target": "com.amazonaws.redshift#Boolean", + "traits": { + "smithy.api#documentation": "

    A boolean value indicating whether to override an exception if the retention period\n has passed.

    " + } } } }, @@ -653,58 +653,46 @@ "com.amazonaws.redshift#Cluster": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.redshift#Endpoint", - "traits": { - "smithy.api#documentation": "

    The connection endpoint.

    " - } - }, - "HsmStatus": { - "target": "com.amazonaws.redshift#HsmStatus", + "ExpectedNextSnapshotScheduleTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    A value that reports whether the Amazon Redshift cluster has finished applying any\n hardware security module (HSM) settings changes specified in a modify cluster\n command.

    \n

    Values: active, applying

    " + "smithy.api#documentation": "

    The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

    " } }, - "PubliclyAccessible": { + "Encrypted": { "target": "com.amazonaws.redshift#Boolean", "traits": { - "smithy.api#documentation": "

    A boolean value that, if true, indicates that the cluster can be\n accessed from a public network.

    " + "smithy.api#documentation": "

    A boolean value that, if true, indicates that data in the cluster is\n encrypted at rest.

    " } }, - "ClusterSnapshotCopyStatus": { - "target": "com.amazonaws.redshift#ClusterSnapshotCopyStatus", + "PendingActions": { + "target": "com.amazonaws.redshift#PendingActionsList", "traits": { - "smithy.api#documentation": "

    A value that returns the destination region and retention period that are\n configured for cross-region snapshot copy.

    " + "smithy.api#documentation": "

    Cluster operations that are waiting to be started.

    " } }, - "VpcId": { + "ClusterRevisionNumber": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the VPC the cluster is in, if the cluster is in a VPC.

    " - } - }, - "ElasticIpStatus": { - "target": "com.amazonaws.redshift#ElasticIpStatus", - "traits": { - "smithy.api#documentation": "

    The status of the elastic IP (EIP) address.

    " + "smithy.api#documentation": "

    The specific revision number of the database in the cluster.

    " } }, - "ModifyStatus": { - "target": "com.amazonaws.redshift#String", + "ClusterCreateTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The status of a modify operation, if any, initiated for the cluster.

    " + "smithy.api#documentation": "

    The date and time that the cluster was created.

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", + "SnapshotScheduleState": { + "target": "com.amazonaws.redshift#ScheduleState", "traits": { - "smithy.api#documentation": "

    The unique identifier of the cluster.

    " + "smithy.api#documentation": "

    The current state of the cluster snapshot schedule.

    " } }, - "Tags": { - "target": "com.amazonaws.redshift#TagList", + "ClusterNodes": { + "target": "com.amazonaws.redshift#ClusterNodesList", "traits": { - "smithy.api#documentation": "

    The list of tags for the cluster.

    " + "smithy.api#documentation": "

    The nodes in the cluster.

    " } }, "VpcSecurityGroups": { @@ -713,58 +701,58 @@ "smithy.api#documentation": "

    A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are\n associated with the cluster. This parameter is returned only if the cluster is in a\n VPC.

    " } }, - "ClusterNodes": { - "target": "com.amazonaws.redshift#ClusterNodesList", + "ElasticIpStatus": { + "target": "com.amazonaws.redshift#ElasticIpStatus", "traits": { - "smithy.api#documentation": "

    The nodes in the cluster.

    " + "smithy.api#documentation": "

    The status of the elastic IP (EIP) address.

    " } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.redshift#String", + "NumberOfNodes": { + "target": "com.amazonaws.redshift#Integer", "traits": { - "smithy.api#documentation": "

    The weekly time range, in Universal Coordinated Time (UTC), during which system\n maintenance can occur.

    " + "smithy.api#documentation": "

    The number of compute nodes in the cluster.

    " } }, - "SnapshotScheduleState": { - "target": "com.amazonaws.redshift#ScheduleState", + "EnhancedVpcRouting": { + "target": "com.amazonaws.redshift#Boolean", "traits": { - "smithy.api#documentation": "

    The current state of the cluster snapshot schedule.

    " + "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " } }, - "NextMaintenanceWindowStartTime": { - "target": "com.amazonaws.redshift#TStamp", + "RestoreStatus": { + "target": "com.amazonaws.redshift#RestoreStatus", "traits": { - "smithy.api#documentation": "

    The date and time in UTC when system maintenance can begin.

    " + "smithy.api#documentation": "

    A value that describes the status of a cluster restore action. This parameter\n returns null if the cluster was not created by restoring a snapshot.

    " } }, - "PendingActions": { - "target": "com.amazonaws.redshift#PendingActionsList", + "Endpoint": { + "target": "com.amazonaws.redshift#Endpoint", "traits": { - "smithy.api#documentation": "

    Cluster operations that are waiting to be started.

    " + "smithy.api#documentation": "

    The connection endpoint.

    " } }, - "ExpectedNextSnapshotScheduleTime": { - "target": "com.amazonaws.redshift#TStamp", + "SnapshotScheduleIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

    " + "smithy.api#documentation": "

    A unique identifier for the cluster snapshot schedule.

    " } }, - "ExpectedNextSnapshotScheduleTimeStatus": { - "target": "com.amazonaws.redshift#String", + "Tags": { + "target": "com.amazonaws.redshift#TagList", "traits": { - "smithy.api#documentation": "

    The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

    \n
      \n
    • \n

      OnTrack - The next snapshot is expected to be taken on time.

      \n
      • \n
    • \n

      Pending - The next snapshot is pending to be taken.

      \n
      • \n
    " + "smithy.api#documentation": "

    The list of tags for the cluster.

    " } }, - "ResizeInfo": { - "target": "com.amazonaws.redshift#ResizeInfo", + "DeferredMaintenanceWindows": { + "target": "com.amazonaws.redshift#DeferredMaintenanceWindowsList", "traits": { - "smithy.api#documentation": "

    Returns the following:

    \n
      \n
    • \n

      AllowCancelResize: a boolean value indicating if the resize operation can be\n cancelled.

      \n
      • \n
    • \n

      ResizeType: Returns ClassicResize

      \n
      • \n
    " + "smithy.api#documentation": "

    Describes a group of DeferredMaintenanceWindow objects.

    " } }, - "ClusterPublicKey": { - "target": "com.amazonaws.redshift#String", + "HsmStatus": { + "target": "com.amazonaws.redshift#HsmStatus", "traits": { - "smithy.api#documentation": "

    The public key for the cluster.

    " + "smithy.api#documentation": "

    A value that reports whether the Amazon Redshift cluster has finished applying any\n hardware security module (HSM) settings changes specified in a modify cluster\n command.

    \n

    Values: active, applying

    " } }, "AutomatedSnapshotRetentionPeriod": { @@ -779,6 +767,12 @@ "smithy.api#documentation": "

    The list of cluster parameter groups that are associated with this cluster. Each\n parameter group in the list is returned with its status.

    " } }, + "ResizeInfo": { + "target": "com.amazonaws.redshift#ResizeInfo", + "traits": { + "smithy.api#documentation": "

    Returns the following:

    \n
      \n
    • \n

      AllowCancelResize: a boolean value indicating if the resize operation can be\n cancelled.

      \n
      • \n
    • \n

      ResizeType: Returns ClassicResize

      \n
      • \n
    " + } + }, "MaintenanceTrackName": { "target": "com.amazonaws.redshift#String", "traits": { @@ -791,46 +785,46 @@ "smithy.api#documentation": "

    " } }, - "SnapshotScheduleIdentifier": { - "target": "com.amazonaws.redshift#String", + "NextMaintenanceWindowStartTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    A unique identifier for the cluster snapshot schedule.

    " + "smithy.api#documentation": "

    The date and time in UTC when system maintenance can begin.

    " } }, - "ClusterVersion": { + "ExpectedNextSnapshotScheduleTimeStatus": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The version ID of the Amazon Redshift engine that is running on the cluster.

    " + "smithy.api#documentation": "

    The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

    \n
      \n
    • \n

      OnTrack - The next snapshot is expected to be taken on time.

      \n
      • \n
    • \n

      Pending - The next snapshot is pending to be taken.

      \n
      • \n
    " } }, - "NodeType": { + "ClusterVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The node type for the nodes in the cluster.

    " + "smithy.api#documentation": "

    The version ID of the Amazon Redshift engine that is running on the cluster.

    " } }, - "ElasticResizeNumberOfNodeOptions": { - "target": "com.amazonaws.redshift#String", + "IamRoles": { + "target": "com.amazonaws.redshift#ClusterIamRoleList", "traits": { - "smithy.api#documentation": "

    The number of nodes that you can resize the cluster to with the elastic resize method.\n

    " + "smithy.api#documentation": "

    A list of AWS Identity and Access Management (IAM) roles that can be used by the\n cluster to access other AWS services.

    " } }, - "RestoreStatus": { - "target": "com.amazonaws.redshift#RestoreStatus", + "ClusterSecurityGroups": { + "target": "com.amazonaws.redshift#ClusterSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

    A value that describes the status of a cluster restore action. This parameter\n returns null if the cluster was not created by restoring a snapshot.

    " + "smithy.api#documentation": "

    A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains\n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status\n subelements.

    \n

    Cluster security groups are used when the cluster is not created in an Amazon\n Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups,\n which are listed by the VpcSecurityGroups parameter.\n

    " } }, - "DeferredMaintenanceWindows": { - "target": "com.amazonaws.redshift#DeferredMaintenanceWindowsList", + "ClusterAvailabilityStatus": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Describes a group of DeferredMaintenanceWindow objects.

    " + "smithy.api#documentation": "

    The availability status of the cluster for queries. Possible values are the following:

    \n
      \n
    • \n

      Available - The cluster is available for queries.

      \n
      • \n
    • \n

      Unavailable - The cluster is not available for queries.

      \n
      • \n
    • \n

      Maintenance - The cluster is intermittently available for queries due to maintenance activities.

      \n
      • \n
    • \n

      Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

      \n
      • \n
    • \n

      Failed - The cluster failed and is not available for queries.

      \n
      • \n
    " } }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.redshift#Boolean", + "ClusterPublicKey": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " + "smithy.api#documentation": "

    The public key for the cluster.

    " } }, "AllowVersionUpgrade": { @@ -839,40 +833,46 @@ "smithy.api#documentation": "

    A boolean value that, if true, indicates that major version upgrades\n will be applied automatically to the cluster during the maintenance window.

    " } }, - "NumberOfNodes": { - "target": "com.amazonaws.redshift#Integer", + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The number of compute nodes in the cluster.

    " + "smithy.api#documentation": "

    The weekly time range, in Universal Coordinated Time (UTC), during which system\n maintenance can occur.

    " } }, - "Encrypted": { - "target": "com.amazonaws.redshift#Boolean", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A boolean value that, if true, indicates that data in the cluster is\n encrypted at rest.

    " + "smithy.api#documentation": "

    The unique identifier of the cluster.

    " } }, - "ClusterCreateTime": { - "target": "com.amazonaws.redshift#TStamp", + "NodeType": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The date and time that the cluster was created.

    " + "smithy.api#documentation": "

    The node type for the nodes in the cluster.

    " } }, - "IamRoles": { - "target": "com.amazonaws.redshift#ClusterIamRoleList", + "ModifyStatus": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of AWS Identity and Access Management (IAM) roles that can be used by the\n cluster to access other AWS services.

    " + "smithy.api#documentation": "

    The status of a modify operation, if any, initiated for the cluster.

    " } }, - "ClusterStatus": { - "target": "com.amazonaws.redshift#String", + "PubliclyAccessible": { + "target": "com.amazonaws.redshift#Boolean", "traits": { - "smithy.api#documentation": "

    The current state of the cluster. Possible values are the following:

    \n
      \n
    • \n

      \n available\n

      \n
      • \n
    • \n

      \n available, prep-for-resize\n

      \n
      • \n
    • \n

      \n available, resize-cleanup\n

      \n
      • \n
    • \n

      \n cancelling-resize\n

      \n
      • \n
    • \n

      \n creating\n

      \n
      • \n
    • \n

      \n deleting\n

      \n
      • \n
    • \n

      \n final-snapshot\n

      \n
      • \n
    • \n

      \n hardware-failure\n

      \n
      • \n
    • \n

      \n incompatible-hsm\n

      \n
      • \n
    • \n

      \n incompatible-network\n

      \n
      • \n
    • \n

      \n incompatible-parameters\n

      \n
      • \n
    • \n

      \n incompatible-restore\n

      \n
      • \n
    • \n

      \n modifying\n

      \n
      • \n
    • \n

      \n paused\n

      \n
      • \n
    • \n

      \n rebooting\n

      \n
      • \n
    • \n

      \n renaming\n

      \n
      • \n
    • \n

      \n resizing\n

      \n
      • \n
    • \n

      \n rotating-keys\n

      \n
      • \n
    • \n

      \n storage-full\n

      \n
      • \n
    • \n

      \n updating-hsm\n

      \n
      • \n
    " + "smithy.api#documentation": "

    A boolean value that, if true, indicates that the cluster can be\n accessed from a public network.

    " } }, - "ClusterAvailabilityStatus": { + "ClusterSnapshotCopyStatus": { + "target": "com.amazonaws.redshift#ClusterSnapshotCopyStatus", + "traits": { + "smithy.api#documentation": "

    A value that returns the destination region and retention period that are\n configured for cross-region snapshot copy.

    " + } + }, + "ElasticResizeNumberOfNodeOptions": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The availability status of the cluster for queries. Possible values are the following:

    \n
      \n
    • \n

      Available - The cluster is available for queries.

      \n
      • \n
    • \n

      Unavailable - The cluster is not available for queries.

      \n
      • \n
    • \n

      Maintenance - The cluster is intermittently available for queries due to maintenance activities.

      \n
      • \n
    • \n

      Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

      \n
      • \n
    • \n

      Failed - The cluster failed and is not available for queries.

      \n
      • \n
    " + "smithy.api#documentation": "

    The number of nodes that you can resize the cluster to with the elastic resize method.\n

    " } }, "AvailabilityZone": { @@ -881,34 +881,28 @@ "smithy.api#documentation": "

    The name of the Availability Zone in which the cluster is located.

    " } }, - "ClusterSecurityGroups": { - "target": "com.amazonaws.redshift#ClusterSecurityGroupMembershipList", + "VpcId": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains\n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status\n subelements.

    \n

    Cluster security groups are used when the cluster is not created in an Amazon\n Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups,\n which are listed by the VpcSecurityGroups parameter.\n

    " + "smithy.api#documentation": "

    The identifier of the VPC the cluster is in, if the cluster is in a VPC.

    " } }, - "KmsKeyId": { + "ClusterStatus": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key ID of the encryption key used to\n encrypt data in the cluster.

    " + "smithy.api#documentation": "

    The current state of the cluster. Possible values are the following:

    \n
      \n
    • \n

      \n available\n

      \n
      • \n
    • \n

      \n available, prep-for-resize\n

      \n
      • \n
    • \n

      \n available, resize-cleanup\n

      \n
      • \n
    • \n

      \n cancelling-resize\n

      \n
      • \n
    • \n

      \n creating\n

      \n
      • \n
    • \n

      \n deleting\n

      \n
      • \n
    • \n

      \n final-snapshot\n

      \n
      • \n
    • \n

      \n hardware-failure\n

      \n
      • \n
    • \n

      \n incompatible-hsm\n

      \n
      • \n
    • \n

      \n incompatible-network\n

      \n
      • \n
    • \n

      \n incompatible-parameters\n

      \n
      • \n
    • \n

      \n incompatible-restore\n

      \n
      • \n
    • \n

      \n modifying\n

      \n
      • \n
    • \n

      \n paused\n

      \n
      • \n
    • \n

      \n rebooting\n

      \n
      • \n
    • \n

      \n renaming\n

      \n
      • \n
    • \n

      \n resizing\n

      \n
      • \n
    • \n

      \n rotating-keys\n

      \n
      • \n
    • \n

      \n storage-full\n

      \n
      • \n
    • \n

      \n updating-hsm\n

      \n
      • \n
    " } }, - "ManualSnapshotRetentionPeriod": { - "target": "com.amazonaws.redshift#Integer", - "traits": { - "smithy.api#documentation": "

    The default number of days to retain a manual snapshot. If the value is -1, the\n snapshot is retained indefinitely. This setting doesn't change the retention period\n of existing snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " - } - }, - "ClusterRevisionNumber": { + "KmsKeyId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The specific revision number of the database in the cluster.

    " + "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key ID of the encryption key used to\n encrypt data in the cluster.

    " } }, - "PendingModifiedValues": { - "target": "com.amazonaws.redshift#PendingModifiedValues", + "DBName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A value that, if present, indicates that changes to the cluster are pending.\n Specific pending changes are identified by subelements.

    " + "smithy.api#documentation": "

    The name of the initial database that was created when the cluster was created.\n This same name is returned for the life of the cluster. If an initial database was not\n specified, a database named devdev was created by default.

    " } }, "ClusterSubnetGroupName": { @@ -923,10 +917,16 @@ "smithy.api#documentation": "

    The master user name for the cluster. This name is used to connect to the database\n that is specified in the DBName parameter.

    " } }, - "DBName": { - "target": "com.amazonaws.redshift#String", + "PendingModifiedValues": { + "target": "com.amazonaws.redshift#PendingModifiedValues", "traits": { - "smithy.api#documentation": "

    The name of the initial database that was created when the cluster was created.\n This same name is returned for the life of the cluster. If an initial database was not\n specified, a database named devdev was created by default.

    " + "smithy.api#documentation": "

    A value that, if present, indicates that changes to the cluster are pending.\n Specific pending changes are identified by subelements.

    " + } + }, + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.redshift#Integer", + "traits": { + "smithy.api#documentation": "

    The default number of days to retain a manual snapshot. If the value is -1, the\n snapshot is retained indefinitely. This setting doesn't change the retention period\n of existing snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " } } }, @@ -950,14 +950,14 @@ "com.amazonaws.redshift#ClusterAssociatedToSchedule": { "type": "structure", "members": { - "ScheduleAssociationState": { - "target": "com.amazonaws.redshift#ScheduleState", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", + "ScheduleAssociationState": { + "target": "com.amazonaws.redshift#ScheduleState", "traits": { "smithy.api#documentation": "

    " } @@ -970,12 +970,6 @@ "com.amazonaws.redshift#ClusterCredentials": { "type": "structure", "members": { - "DbPassword": { - "target": "com.amazonaws.redshift#SensitiveString", - "traits": { - "smithy.api#documentation": "

    A temporary password that authorizes the user name returned by DbUser\n to log on to the database DbName.

    " - } - }, "DbUser": { "target": "com.amazonaws.redshift#String", "traits": { @@ -987,6 +981,12 @@ "traits": { "smithy.api#documentation": "

    The date and time the password in DbPassword expires.

    " } + }, + "DbPassword": { + "target": "com.amazonaws.redshift#SensitiveString", + "traits": { + "smithy.api#documentation": "

    A temporary password that authorizes the user name returned by DbUser\n to log on to the database DbName.

    " + } } }, "traits": { @@ -996,28 +996,28 @@ "com.amazonaws.redshift#ClusterDbRevision": { "type": "structure", "members": { - "CurrentDatabaseRevision": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A string representing the current cluster version.

    " - } - }, "DatabaseRevisionReleaseDate": { "target": "com.amazonaws.redshift#TStamp", "traits": { "smithy.api#documentation": "

    The date on which the database revision was released.

    " } }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The unique identifier of the cluster.

    " + } + }, "RevisionTargets": { "target": "com.amazonaws.redshift#RevisionTargetsList", "traits": { "smithy.api#documentation": "

    A list of RevisionTarget objects, where each object describes the\n database revision that a cluster can be updated to.

    " } }, - "ClusterIdentifier": { + "CurrentDatabaseRevision": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The unique identifier of the cluster.

    " + "smithy.api#documentation": "

    A string representing the current cluster version.

    " } } }, @@ -1092,22 +1092,22 @@ "com.amazonaws.redshift#ClusterNode": { "type": "structure", "members": { - "PrivateIPAddress": { + "PublicIPAddress": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The private IP address of a node within a cluster.

    " + "smithy.api#documentation": "

    The public IP address of a node within a cluster.

    " } }, - "NodeRole": { + "PrivateIPAddress": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Whether the node is a leader node or a compute node.

    " + "smithy.api#documentation": "

    The private IP address of a node within a cluster.

    " } }, - "PublicIPAddress": { + "NodeRole": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The public IP address of a node within a cluster.

    " + "smithy.api#documentation": "

    Whether the node is a leader node or a compute node.

    " } } }, @@ -1150,16 +1150,10 @@ "com.amazonaws.redshift#ClusterParameterGroup": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.redshift#TagList", - "traits": { - "smithy.api#documentation": "

    The list of tags for the cluster parameter group.

    " - } - }, - "Description": { + "ParameterGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The description of the parameter group.

    " + "smithy.api#documentation": "

    The name of the cluster parameter group.

    " } }, "ParameterGroupFamily": { @@ -1168,10 +1162,16 @@ "smithy.api#documentation": "

    The name of the cluster parameter group family that this cluster parameter group is\n compatible with.

    " } }, - "ParameterGroupName": { + "Description": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the cluster parameter group.

    " + "smithy.api#documentation": "

    The description of the parameter group.

    " + } + }, + "Tags": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

    The list of tags for the cluster parameter group.

    " } } }, @@ -1261,10 +1261,10 @@ "com.amazonaws.redshift#ClusterParameterGroupStatus": { "type": "structure", "members": { - "ParameterGroupName": { - "target": "com.amazonaws.redshift#String", + "ClusterParameterStatusList": { + "target": "com.amazonaws.redshift#ClusterParameterStatusList", "traits": { - "smithy.api#documentation": "

    The name of the cluster parameter group.

    " + "smithy.api#documentation": "

    The list of parameter statuses.

    \n

    \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    " } }, "ParameterApplyStatus": { @@ -1273,10 +1273,10 @@ "smithy.api#documentation": "

    The status of parameter updates.

    " } }, - "ClusterParameterStatusList": { - "target": "com.amazonaws.redshift#ClusterParameterStatusList", + "ParameterGroupName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The list of parameter statuses.

    \n

    \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    " + "smithy.api#documentation": "

    The name of the cluster parameter group.

    " } } }, @@ -1296,17 +1296,17 @@ "com.amazonaws.redshift#ClusterParameterGroupsMessage": { "type": "structure", "members": { - "ParameterGroups": { - "target": "com.amazonaws.redshift#ParameterGroupList", - "traits": { - "smithy.api#documentation": "

    A list of ClusterParameterGroup instances. Each instance\n describes one cluster parameter group.

    " - } - }, "Marker": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " } + }, + "ParameterGroups": { + "target": "com.amazonaws.redshift#ParameterGroupList", + "traits": { + "smithy.api#documentation": "

    A list of ClusterParameterGroup instances. Each instance\n describes one cluster parameter group.

    " + } } }, "traits": { @@ -1322,16 +1322,16 @@ "smithy.api#documentation": "

    The status of the parameter that indicates whether the parameter is in sync with\n the database, waiting for a cluster reboot, or encountered an error when being\n applied.

    \n

    The following are possible statuses and descriptions.

    \n
      \n
    • \n

      \n in-sync: The parameter value is in sync with the\n database.

      \n
      • \n
    • \n

      \n pending-reboot: The parameter value will be applied after the\n cluster reboots.

      \n
      • \n
    • \n

      \n applying: The parameter value is being applied to the\n database.

      \n
      • \n
    • \n

      \n invalid-parameter: Cannot apply the parameter value because it has\n an invalid value or syntax.

      \n
      • \n
    • \n

      \n apply-deferred: The parameter contains static property changes. The\n changes are deferred until the cluster reboots.

      \n
      • \n
    • \n

      \n apply-error: Cannot connect to the cluster. The parameter change\n will be applied after the cluster reboots.

      \n
      • \n
    • \n

      \n unknown-error: Cannot apply the parameter change right now. The\n change will be applied after the cluster reboots.

      \n
      • \n
    " } }, - "ParameterApplyErrorDescription": { + "ParameterName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The error that prevented the parameter from being applied to the\n database.

    " + "smithy.api#documentation": "

    The name of the parameter.

    " } }, - "ParameterName": { + "ParameterApplyErrorDescription": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the parameter.

    " + "smithy.api#documentation": "

    The error that prevented the parameter from being applied to the\n database.

    " } } }, @@ -1361,34 +1361,34 @@ "com.amazonaws.redshift#ClusterSecurityGroup": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.redshift#TagList", + "EC2SecurityGroups": { + "target": "com.amazonaws.redshift#EC2SecurityGroupList", "traits": { - "smithy.api#documentation": "

    The list of tags for the cluster security group.

    " + "smithy.api#documentation": "

    A list of EC2 security groups that are permitted to access clusters associated with\n this cluster security group.

    " } }, - "ClusterSecurityGroupName": { - "target": "com.amazonaws.redshift#String", + "IPRanges": { + "target": "com.amazonaws.redshift#IPRangeList", "traits": { - "smithy.api#documentation": "

    The name of the cluster security group to which the operation was\n applied.

    " + "smithy.api#documentation": "

    A list of IP ranges (CIDR blocks) that are permitted to access clusters associated\n with this cluster security group.

    " } }, - "Description": { + "ClusterSecurityGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A description of the security group.

    " + "smithy.api#documentation": "

    The name of the cluster security group to which the operation was\n applied.

    " } }, - "EC2SecurityGroups": { - "target": "com.amazonaws.redshift#EC2SecurityGroupList", + "Tags": { + "target": "com.amazonaws.redshift#TagList", "traits": { - "smithy.api#documentation": "

    A list of EC2 security groups that are permitted to access clusters associated with\n this cluster security group.

    " + "smithy.api#documentation": "

    The list of tags for the cluster security group.

    " } }, - "IPRanges": { - "target": "com.amazonaws.redshift#IPRangeList", + "Description": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of IP ranges (CIDR blocks) that are permitted to access clusters associated\n with this cluster security group.

    " + "smithy.api#documentation": "

    A description of the security group.

    " } } }, @@ -1518,18 +1518,18 @@ "com.amazonaws.redshift#ClusterSnapshotCopyStatus": { "type": "structure", "members": { - "RetentionPeriod": { - "target": "com.amazonaws.redshift#Long", - "traits": { - "smithy.api#documentation": "

    The number of days that automated snapshots are retained in the destination region\n after they are copied from a source region.

    " - } - }, "SnapshotCopyGrantName": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The name of the snapshot copy grant.

    " } }, + "RetentionPeriod": { + "target": "com.amazonaws.redshift#Long", + "traits": { + "smithy.api#documentation": "

    The number of days that automated snapshots are retained in the destination region\n after they are copied from a source region.

    " + } + }, "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.redshift#Integer", "traits": { @@ -1582,35 +1582,35 @@ "smithy.api#documentation": "

    The description of the cluster subnet group.

    " } }, - "Subnets": { - "target": "com.amazonaws.redshift#SubnetList", - "traits": { - "smithy.api#documentation": "

    A list of the VPC Subnet elements.

    " - } - }, "ClusterSubnetGroupName": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The name of the cluster subnet group.

    " } }, - "VpcId": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The VPC ID of the cluster subnet group.

    " - } - }, "Tags": { "target": "com.amazonaws.redshift#TagList", "traits": { "smithy.api#documentation": "

    The list of tags for the cluster subnet group.

    " } }, + "Subnets": { + "target": "com.amazonaws.redshift#SubnetList", + "traits": { + "smithy.api#documentation": "

    A list of the VPC Subnet elements.

    " + } + }, "SubnetGroupStatus": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The status of the cluster subnet group. Possible values are Complete,\n Incomplete and Invalid.

    " } + }, + "VpcId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The VPC ID of the cluster subnet group.

    " + } } }, "traits": { @@ -1633,17 +1633,17 @@ "com.amazonaws.redshift#ClusterSubnetGroupMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " - } - }, "ClusterSubnetGroups": { "target": "com.amazonaws.redshift#ClusterSubnetGroups", "traits": { "smithy.api#documentation": "

    A list of ClusterSubnetGroup instances.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " + } } }, "traits": { @@ -1756,17 +1756,17 @@ "com.amazonaws.redshift#ClustersMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " - } - }, "Clusters": { "target": "com.amazonaws.redshift#ClusterList", "traits": { "smithy.api#documentation": "

    A list of Cluster objects, where each object describes one cluster.\n

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " + } } }, "traits": { @@ -1805,16 +1805,23 @@ "com.amazonaws.redshift#CopyClusterSnapshotMessage": { "type": "structure", "members": { + "SourceSnapshotClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The identifier of the cluster the source snapshot was created from. This parameter\n is required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be the identifier for a valid cluster.

      \n
      • \n
    " + } + }, "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The number of days that a manual snapshot is retained. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    \n

    The default value is -1.

    " } }, - "SourceSnapshotClusterIdentifier": { + "TargetSnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the cluster the source snapshot was created from. This parameter\n is required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be the identifier for a valid cluster.

      \n
      • \n
    " + "smithy.api#documentation": "

    The identifier given to the new manual snapshot.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot be null, empty, or blank.

      \n
      • \n
    • \n

      Must contain from 1 to 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    • \n

      Must be unique for the AWS account that is making the request.

      \n
      • \n
    ", + "smithy.api#required": {} } }, "SourceSnapshotIdentifier": { @@ -1823,13 +1830,6 @@ "smithy.api#documentation": "

    The identifier for the source snapshot.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be the identifier for a valid automated snapshot whose state is\n available.

      \n
      • \n
    ", "smithy.api#required": {} } - }, - "TargetSnapshotIdentifier": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The identifier given to the new manual snapshot.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot be null, empty, or blank.

      \n
      • \n
    • \n

      Must contain from 1 to 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    • \n

      Must be unique for the AWS account that is making the request.

      \n
      • \n
    ", - "smithy.api#required": {} - } } }, "traits": { @@ -1940,72 +1940,65 @@ "com.amazonaws.redshift#CreateClusterMessage": { "type": "structure", "members": { - "KmsKeyId": { + "MasterUserPassword": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to\n use to encrypt data in the cluster.

    " + "smithy.api#documentation": "

    The password associated with the master user account for the cluster that is being\n created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be between 8 and 64 characters in length.

      \n
      • \n
    • \n

      Must contain at least one uppercase letter.

      \n
      • \n
    • \n

      Must contain at least one lowercase letter.

      \n
      • \n
    • \n

      Must contain one number.

      \n
      • \n
    • \n

      Can be any printable ASCII character (ASCII code 33 to 126) except '\n (single quote), \" (double quote), \\, /, @, or space.

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "AvailabilityZone": { - "target": "com.amazonaws.redshift#String", + "PubliclyAccessible": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the\n cluster. For example, if you have several EC2 instances running in a specific\n Availability Zone, then you might want the cluster to be provisioned in the same zone in\n order to decrease network latency.

    \n

    Default: A random, system-chosen Availability Zone in the region that is specified\n by the endpoint.

    \n

    Example: us-east-2d\n

    \n

    Constraint: The specified Availability Zone must be in the same region as the\n current endpoint.

    " + "smithy.api#documentation": "

    If true, the cluster can be accessed from a public network.

    " } }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.redshift#String", + "Tags": { + "target": "com.amazonaws.redshift#TagList", "traits": { - "smithy.api#documentation": "

    The weekly time range (in UTC) during which automated cluster maintenance can\n occur.

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    Default: A 30-minute window selected at random from an 8-hour block of time per\n region, occurring on a random day of the week. For more information about the time\n blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    \n

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    \n

    Constraints: Minimum 30-minute window.

    " + "smithy.api#documentation": "

    A list of tag instances.

    " } }, - "AdditionalInfo": { + "HsmClientCertificateIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Reserved.

    " + "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " } }, - "DBName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the first database to be created when the cluster is created.

    \n

    To create additional databases after the cluster is created, connect to the cluster\n with a SQL client and use SQL commands to create a database. For more information, go to\n Create\n a Database in the Amazon Redshift Database Developer Guide.

    \n

    Default: dev\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain 1 to 64 alphanumeric characters.

      \n
      • \n
    • \n

      Must contain only lowercase letters.

      \n
      • \n
    • \n

      Cannot be a word that is reserved by the service. A list of reserved words\n can be found in Reserved Words in the\n Amazon Redshift Database Developer Guide.

      \n
      • \n
    " - } - }, - "PubliclyAccessible": { + "Encrypted": { "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    If true, the cluster can be accessed from a public network.

    " + "smithy.api#documentation": "

    If true, the data in the cluster is encrypted at rest.

    \n

    Default: false

    " } }, - "Tags": { - "target": "com.amazonaws.redshift#TagList", + "AutomatedSnapshotRetentionPeriod": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A list of tag instances.

    " + "smithy.api#documentation": "

    The number of days that automated snapshots are retained. If the value is 0,\n automated snapshots are disabled. Even if automated snapshots are disabled, you can\n still create manual snapshots when you want with CreateClusterSnapshot.

    \n

    Default: 1\n

    \n

    Constraints: Must be a value from 0 to 35.

    " } }, - "MasterUserPassword": { - "target": "com.amazonaws.redshift#String", + "Port": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The password associated with the master user account for the cluster that is being\n created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be between 8 and 64 characters in length.

      \n
      • \n
    • \n

      Must contain at least one uppercase letter.

      \n
      • \n
    • \n

      Must contain at least one lowercase letter.

      \n
      • \n
    • \n

      Must contain one number.

      \n
      • \n
    • \n

      Can be any printable ASCII character (ASCII code 33 to 126) except '\n (single quote), \" (double quote), \\, /, @, or space.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The port number on which the cluster accepts incoming connections.

    \n

    The cluster is accessible only via the JDBC and ODBC connection strings. Part of\n the connection string requires the port on which the cluster will listen for incoming\n connections.

    \n

    Default: 5439\n

    \n

    Valid Values: 1150-65535\n

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.redshift#VpcSecurityGroupIdList", + "HsmConfigurationIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of Virtual Private Cloud (VPC) security groups to be associated with the\n cluster.

    \n

    Default: The default VPC security group is associated with the cluster.

    " + "smithy.api#documentation": "

    Specifies the name of the HSM configuration that contains the information the\n Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    " } }, - "MaintenanceTrackName": { + "ClusterVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An optional parameter for the name of the maintenance track for the cluster. If you\n don't provide a maintenance track name, the cluster is assigned to the\n current track.

    " + "smithy.api#documentation": "

    The version of the Amazon Redshift engine software that you want to deploy on the\n cluster.

    \n

    The version selected runs on all the nodes in the cluster.

    \n

    Constraints: Only version 1.0 is currently available.

    \n

    Example: 1.0\n

    " } }, - "NodeType": { + "ClusterType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The node type to be provisioned for the cluster. For information about node types,\n go to Working with\n Clusters in the Amazon Redshift Cluster Management Guide.

    \n

    Valid Values: ds2.xlarge | ds2.8xlarge |\n dc1.large | dc1.8xlarge | \n dc2.large | dc2.8xlarge | \n ra3.4xlarge | ra3.16xlarge\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The type of the cluster. When cluster type is specified as

    \n
      \n
    • \n

      \n single-node, the NumberOfNodes\n parameter is not required.

      \n
      • \n
    • \n

      \n multi-node, the NumberOfNodes\n parameter is required.

      \n
      • \n
    \n

    Valid Values: multi-node | single-node\n

    \n

    Default: multi-node\n

    " } }, "SnapshotScheduleIdentifier": { @@ -2014,89 +2007,89 @@ "smithy.api#documentation": "

    A unique identifier for the snapshot schedule.

    " } }, - "HsmConfigurationIdentifier": { - "target": "com.amazonaws.redshift#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.redshift#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

    Specifies the name of the HSM configuration that contains the information the\n Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    " + "smithy.api#documentation": "

    A list of Virtual Private Cloud (VPC) security groups to be associated with the\n cluster.

    \n

    Default: The default VPC security group is associated with the cluster.

    " } }, - "ClusterVersion": { + "ClusterSubnetGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The version of the Amazon Redshift engine software that you want to deploy on the\n cluster.

    \n

    The version selected runs on all the nodes in the cluster.

    \n

    Constraints: Only version 1.0 is currently available.

    \n

    Example: 1.0\n

    " + "smithy.api#documentation": "

    The name of a cluster subnet group to be associated with this cluster.

    \n

    If this parameter is not provided the resulting cluster will be deployed outside\n virtual private cloud (VPC).

    " } }, - "ClusterType": { - "target": "com.amazonaws.redshift#String", + "AllowVersionUpgrade": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The type of the cluster. When cluster type is specified as

    \n
      \n
    • \n

      \n single-node, the NumberOfNodes\n parameter is not required.

      \n
      • \n
    • \n

      \n multi-node, the NumberOfNodes\n parameter is required.

      \n
      • \n
    \n

    Valid Values: multi-node | single-node\n

    \n

    Default: multi-node\n

    " + "smithy.api#documentation": "

    If true, major version upgrades can be applied during the maintenance\n window to the Amazon Redshift engine that is running on the cluster.

    \n

    When a new major version of the Amazon Redshift engine is released, you can request that\n the service automatically apply upgrades during the maintenance window to the Amazon Redshift\n engine that is running on your cluster.

    \n

    Default: true\n

    " } }, - "Port": { + "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The port number on which the cluster accepts incoming connections.

    \n

    The cluster is accessible only via the JDBC and ODBC connection strings. Part of\n the connection string requires the port on which the cluster will listen for incoming\n connections.

    \n

    Default: 5439\n

    \n

    Valid Values: 1150-65535\n

    " + "smithy.api#documentation": "

    The default number of days to retain a manual snapshot. If the value is -1, the\n snapshot is retained indefinitely. This setting doesn't change the retention period\n of existing snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " } }, - "AutomatedSnapshotRetentionPeriod": { - "target": "com.amazonaws.redshift#IntegerOptional", + "MaintenanceTrackName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The number of days that automated snapshots are retained. If the value is 0,\n automated snapshots are disabled. Even if automated snapshots are disabled, you can\n still create manual snapshots when you want with CreateClusterSnapshot.

    \n

    Default: 1\n

    \n

    Constraints: Must be a value from 0 to 35.

    " + "smithy.api#documentation": "

    An optional parameter for the name of the maintenance track for the cluster. If you\n don't provide a maintenance track name, the cluster is assigned to the\n current track.

    " } }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.redshift#BooleanOptional", + "AdditionalInfo": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " + "smithy.api#documentation": "

    Reserved.

    " } }, - "MasterUsername": { + "NodeType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The user name associated with the master user account for the cluster that is being\n created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 - 128 alphanumeric characters. The user name can't be\n PUBLIC.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n\n

      Cannot be a reserved word. A list of reserved words can be found in Reserved\n Words in the Amazon Redshift Database Developer Guide.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The node type to be provisioned for the cluster. For information about node types,\n go to Working with\n Clusters in the Amazon Redshift Cluster Management Guide.

    \n

    Valid Values: ds2.xlarge | ds2.8xlarge |\n dc1.large | dc1.8xlarge | \n dc2.large | dc2.8xlarge | \n ra3.4xlarge | ra3.16xlarge\n

    ", "smithy.api#required": {} } }, - "NumberOfNodes": { - "target": "com.amazonaws.redshift#IntegerOptional", + "KmsKeyId": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The number of compute nodes in the cluster. This parameter is required when the\n ClusterType parameter is specified as\n multi-node.

    \n

    For information about determining how many nodes you need, go to Working with\n Clusters in the Amazon Redshift Cluster Management Guide.

    \n

    If you don't specify this parameter, you get a single-node cluster. When requesting\n a multi-node cluster, you must specify the number of nodes that you want in the\n cluster.

    \n

    Default: 1\n

    \n

    Constraints: Value must be at least 1 and no more than 100.

    " + "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to\n use to encrypt data in the cluster.

    " } }, - "ElasticIp": { - "target": "com.amazonaws.redshift#String", + "IamRoles": { + "target": "com.amazonaws.redshift#IamRoleArnList", "traits": { - "smithy.api#documentation": "

    The Elastic IP (EIP) address for the cluster.

    \n

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible\n through an Internet gateway. For more information about provisioning clusters in\n EC2-VPC, go to Supported\n Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    " + "smithy.api#documentation": "

    A list of AWS Identity and Access Management (IAM) roles that can be used by the\n cluster to access other AWS services. You must supply the IAM roles in their Amazon\n Resource Name (ARN) format. You can supply up to 10 IAM roles in a single\n request.

    \n

    A cluster can have up to 10 IAM roles associated with it at any time.

    " } }, - "Encrypted": { - "target": "com.amazonaws.redshift#BooleanOptional", + "ElasticIp": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    If true, the data in the cluster is encrypted at rest.

    \n

    Default: false

    " + "smithy.api#documentation": "

    The Elastic IP (EIP) address for the cluster.

    \n

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible\n through an Internet gateway. For more information about provisioning clusters in\n EC2-VPC, go to Supported\n Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    " } }, - "HsmClientCertificateIdentifier": { + "DBName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " + "smithy.api#documentation": "

    The name of the first database to be created when the cluster is created.

    \n

    To create additional databases after the cluster is created, connect to the cluster\n with a SQL client and use SQL commands to create a database. For more information, go to\n Create\n a Database in the Amazon Redshift Database Developer Guide.

    \n

    Default: dev\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain 1 to 64 alphanumeric characters.

      \n
      • \n
    • \n

      Must contain only lowercase letters.

      \n
      • \n
    • \n

      Cannot be a word that is reserved by the service. A list of reserved words\n can be found in Reserved Words in the\n Amazon Redshift Database Developer Guide.

      \n
      • \n
    " } }, - "ManualSnapshotRetentionPeriod": { + "NumberOfNodes": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The default number of days to retain a manual snapshot. If the value is -1, the\n snapshot is retained indefinitely. This setting doesn't change the retention period\n of existing snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " + "smithy.api#documentation": "

    The number of compute nodes in the cluster. This parameter is required when the\n ClusterType parameter is specified as\n multi-node.

    \n

    For information about determining how many nodes you need, go to Working with\n Clusters in the Amazon Redshift Cluster Management Guide.

    \n

    If you don't specify this parameter, you get a single-node cluster. When requesting\n a multi-node cluster, you must specify the number of nodes that you want in the\n cluster.

    \n

    Default: 1\n

    \n

    Constraints: Value must be at least 1 and no more than 100.

    " } }, - "AllowVersionUpgrade": { + "EnhancedVpcRouting": { "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    If true, major version upgrades can be applied during the maintenance\n window to the Amazon Redshift engine that is running on the cluster.

    \n

    When a new major version of the Amazon Redshift engine is released, you can request that\n the service automatically apply upgrades during the maintenance window to the Amazon Redshift\n engine that is running on your cluster.

    \n

    Default: true\n

    " + "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " } }, - "ClusterSubnetGroupName": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of a cluster subnet group to be associated with this cluster.

    \n

    If this parameter is not provided the resulting cluster will be deployed outside\n virtual private cloud (VPC).

    " + "smithy.api#documentation": "

    The weekly time range (in UTC) during which automated cluster maintenance can\n occur.

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi\n

    \n

    Default: A 30-minute window selected at random from an 8-hour block of time per\n region, occurring on a random day of the week. For more information about the time\n blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    \n

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    \n

    Constraints: Minimum 30-minute window.

    " } }, "ClusterParameterGroupName": { @@ -2105,23 +2098,30 @@ "smithy.api#documentation": "

    The name of the parameter group to be associated with this cluster.

    \n

    Default: The default Amazon Redshift cluster parameter group. For information about the\n default parameter group, go to Working with Amazon\n Redshift Parameter Groups\n

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " } }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A unique identifier for the cluster. You use this identifier to refer to the\n cluster for any subsequent cluster operations such as deleting or modifying. The\n identifier also appears in the Amazon Redshift console.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Alphabetic characters must be lowercase.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    • \n

      Must be unique for all clusters within an AWS account.

      \n
      • \n
    \n\n

    Example: myexamplecluster\n

    ", + "smithy.api#required": {} + } + }, "ClusterSecurityGroups": { "target": "com.amazonaws.redshift#ClusterSecurityGroupNameList", "traits": { "smithy.api#documentation": "

    A list of security groups to be associated with this cluster.

    \n

    Default: The default cluster security group for Amazon Redshift.

    " } }, - "IamRoles": { - "target": "com.amazonaws.redshift#IamRoleArnList", + "MasterUsername": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of AWS Identity and Access Management (IAM) roles that can be used by the\n cluster to access other AWS services. You must supply the IAM roles in their Amazon\n Resource Name (ARN) format. You can supply up to 10 IAM roles in a single\n request.

    \n

    A cluster can have up to 10 IAM roles associated with it at any time.

    " + "smithy.api#documentation": "

    The user name associated with the master user account for the cluster that is being\n created.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 - 128 alphanumeric characters. The user name can't be\n PUBLIC.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n\n

      Cannot be a reserved word. A list of reserved words can be found in Reserved\n Words in the Amazon Redshift Database Developer Guide.

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "ClusterIdentifier": { + "AvailabilityZone": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A unique identifier for the cluster. You use this identifier to refer to the\n cluster for any subsequent cluster operations such as deleting or modifying. The\n identifier also appears in the Amazon Redshift console.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Alphabetic characters must be lowercase.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    • \n

      Must be unique for all clusters within an AWS account.

      \n
      • \n
    \n\n

    Example: myexamplecluster\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the\n cluster. For example, if you have several EC2 instances running in a specific\n Availability Zone, then you might want the cluster to be provisioned in the same zone in\n order to decrease network latency.

    \n

    Default: A random, system-chosen Availability Zone in the region that is specified\n by the endpoint.

    \n

    Example: us-east-2d\n

    \n

    Constraint: The specified Availability Zone must be in the same region as the\n current endpoint.

    " } } }, @@ -2158,6 +2158,13 @@ "com.amazonaws.redshift#CreateClusterParameterGroupMessage": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A description of the parameter group.

    ", + "smithy.api#required": {} + } + }, "ParameterGroupName": { "target": "com.amazonaws.redshift#String", "traits": { @@ -2177,13 +2184,6 @@ "traits": { "smithy.api#documentation": "

    A list of tag instances.

    " } - }, - "Description": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A description of the parameter group.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -2235,10 +2235,10 @@ "com.amazonaws.redshift#CreateClusterSecurityGroupMessage": { "type": "structure", "members": { - "Description": { + "ClusterSecurityGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A description for the security group.

    ", + "smithy.api#documentation": "

    The name for the security group. Amazon Redshift stores the value as a lowercase\n string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain no more than 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Must not be \"Default\".

      \n
      • \n
    • \n

      Must be unique for all security groups that are created by your AWS\n account.

      \n
      • \n
    \n

    Example: examplesecuritygroup\n

    ", "smithy.api#required": {} } }, @@ -2248,10 +2248,10 @@ "smithy.api#documentation": "

    A list of tag instances.

    " } }, - "ClusterSecurityGroupName": { + "Description": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name for the security group. Amazon Redshift stores the value as a lowercase\n string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain no more than 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Must not be \"Default\".

      \n
      • \n
    • \n

      Must be unique for all security groups that are created by your AWS\n account.

      \n
      • \n
    \n

    Example: examplesecuritygroup\n

    ", + "smithy.api#documentation": "

    A description for the security group.

    ", "smithy.api#required": {} } } @@ -2306,10 +2306,11 @@ "com.amazonaws.redshift#CreateClusterSnapshotMessage": { "type": "structure", "members": { - "ManualSnapshotRetentionPeriod": { - "target": "com.amazonaws.redshift#IntegerOptional", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The number of days that a manual snapshot is retained. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n\n

    The value must be either -1 or an integer between 1 and 3,653.

    \n\n

    The default value is -1.

    " + "smithy.api#documentation": "

    The cluster identifier for which you want a snapshot.

    ", + "smithy.api#required": {} } }, "Tags": { @@ -2318,18 +2319,17 @@ "smithy.api#documentation": "

    A list of tag instances.

    " } }, - "ClusterIdentifier": { + "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The cluster identifier for which you want a snapshot.

    ", + "smithy.api#documentation": "

    A unique identifier for the snapshot that you are requesting. This identifier must\n be unique for all snapshots within the AWS account.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 alphanumeric characters or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-snapshot-id\n

    ", "smithy.api#required": {} } }, - "SnapshotIdentifier": { - "target": "com.amazonaws.redshift#String", + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A unique identifier for the snapshot that you are requesting. This identifier must\n be unique for all snapshots within the AWS account.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot be null, empty, or blank

      \n
      • \n
    • \n

      Must contain from 1 to 255 alphanumeric characters or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    \n

    Example: my-snapshot-id\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of days that a manual snapshot is retained. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n\n

    The value must be either -1 or an integer between 1 and 3,653.

    \n\n

    The default value is -1.

    " } } }, @@ -2399,17 +2399,17 @@ "smithy.api#required": {} } }, - "ClusterSubnetGroupName": { + "Description": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name for the subnet group. Amazon Redshift stores the value as a lowercase\n string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain no more than 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Must not be \"Default\".

      \n
      • \n
    • \n

      Must be unique for all subnet groups that are created by your AWS\n account.

      \n
      • \n
    \n

    Example: examplesubnetgroup\n

    ", + "smithy.api#documentation": "

    A description for the subnet group.

    ", "smithy.api#required": {} } }, - "Description": { + "ClusterSubnetGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A description for the subnet group.

    ", + "smithy.api#documentation": "

    The name for the subnet group. Amazon Redshift stores the value as a lowercase\n string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain no more than 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Must not be \"Default\".

      \n
      • \n
    • \n

      Must be unique for all subnet groups that are created by your AWS\n account.

      \n
      • \n
    \n

    Example: examplesubnetgroup\n

    ", "smithy.api#required": {} } } @@ -2483,34 +2483,41 @@ "smithy.api#required": {} } }, + "EventCategories": { + "target": "com.amazonaws.redshift#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

    Specifies the Amazon Redshift event categories to be published by the event notification\n subscription.

    \n

    Values: configuration, management, monitoring, security

    " + } + }, "Enabled": { "target": "com.amazonaws.redshift#BooleanOptional", "traits": { "smithy.api#documentation": "

    A boolean value; set to true to activate the subscription, and set to\n false to create the subscription but not activate it.

    " } }, - "Severity": { + "SourceType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Specifies the Amazon Redshift event severity to be published by the event notification\n subscription.

    \n

    Values: ERROR, INFO

    " + "smithy.api#documentation": "

    The type of source that will be generating the events. For example, if you want to\n be notified of events generated by a cluster, you would set this parameter to cluster.\n If this value is not specified, events are returned for all Amazon Redshift objects in your\n AWS account. You must specify a source type in order to specify source IDs.

    \n

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    " } }, - "SourceIds": { - "target": "com.amazonaws.redshift#SourceIdsList", + "SubscriptionName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects\n must be of the same type as was specified in the source type parameter. The event\n subscription will return only events generated by the specified objects. If not\n specified, then events are returned for all objects within the source type\n specified.

    \n

    Example: my-cluster-1, my-cluster-2

    \n

    Example: my-snapshot-20131010

    " + "smithy.api#documentation": "

    The name of the event subscription to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot be null, empty, or blank.

      \n
      • \n
    • \n

      Must contain from 1 to 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "EventCategories": { - "target": "com.amazonaws.redshift#EventCategoriesList", + "Severity": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Specifies the Amazon Redshift event categories to be published by the event notification\n subscription.

    \n

    Values: configuration, management, monitoring, security

    " + "smithy.api#documentation": "

    Specifies the Amazon Redshift event severity to be published by the event notification\n subscription.

    \n

    Values: ERROR, INFO

    " } }, - "SourceType": { - "target": "com.amazonaws.redshift#String", + "SourceIds": { + "target": "com.amazonaws.redshift#SourceIdsList", "traits": { - "smithy.api#documentation": "

    The type of source that will be generating the events. For example, if you want to\n be notified of events generated by a cluster, you would set this parameter to cluster.\n If this value is not specified, events are returned for all Amazon Redshift objects in your\n AWS account. You must specify a source type in order to specify source IDs.

    \n

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    " + "smithy.api#documentation": "

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects\n must be of the same type as was specified in the source type parameter. The event\n subscription will return only events generated by the specified objects. If not\n specified, then events are returned for all objects within the source type\n specified.

    \n

    Example: my-cluster-1, my-cluster-2

    \n

    Example: my-snapshot-20131010

    " } }, "Tags": { @@ -2518,13 +2525,6 @@ "traits": { "smithy.api#documentation": "

    A list of tag instances.

    " } - }, - "SubscriptionName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the event subscription to be created.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot be null, empty, or blank.

      \n
      • \n
    • \n

      Must contain from 1 to 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    ", - "smithy.api#required": {} - } } }, "traits": { @@ -2623,24 +2623,30 @@ "com.amazonaws.redshift#CreateHsmConfigurationMessage": { "type": "structure", "members": { - "HsmIpAddress": { + "HsmPartitionName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The IP address that the Amazon Redshift cluster must use to access the HSM.

    ", + "smithy.api#documentation": "

    The name of the partition in the HSM where the Amazon Redshift clusters will store their\n database encryption keys.

    ", "smithy.api#required": {} } }, - "HsmServerPublicCertificate": { + "Tags": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

    A list of tag instances.

    " + } + }, + "HsmConfigurationIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The HSMs public certificate file. When using Cloud HSM, the file name is\n server.pem.

    ", + "smithy.api#documentation": "

    The identifier to be assigned to the new Amazon Redshift HSM configuration.

    ", "smithy.api#required": {} } }, - "Description": { + "HsmIpAddress": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A text description of the HSM configuration to be created.

    ", + "smithy.api#documentation": "

    The IP address that the Amazon Redshift cluster must use to access the HSM.

    ", "smithy.api#required": {} } }, @@ -2651,23 +2657,17 @@ "smithy.api#required": {} } }, - "HsmPartitionName": { + "Description": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the partition in the HSM where the Amazon Redshift clusters will store their\n database encryption keys.

    ", + "smithy.api#documentation": "

    A text description of the HSM configuration to be created.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.redshift#TagList", - "traits": { - "smithy.api#documentation": "

    A list of tag instances.

    " - } - }, - "HsmConfigurationIdentifier": { + "HsmServerPublicCertificate": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier to be assigned to the new Amazon Redshift HSM configuration.

    ", + "smithy.api#documentation": "

    The HSMs public certificate file. When using Cloud HSM, the file name is\n server.pem.

    ", "smithy.api#required": {} } } @@ -2739,17 +2739,10 @@ "smithy.api#required": {} } }, - "ScheduledActionDescription": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The description of the scheduled action. \n

    " - } - }, - "ScheduledActionName": { - "target": "com.amazonaws.redshift#String", + "StartTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The name of the scheduled action. The name must be unique within an account. \n For more information about this parameter, see ScheduledAction.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The start time in UTC of the scheduled action. \n Before this time, the scheduled action does not trigger.\n For more information about this parameter, see ScheduledAction.

    " } }, "EndTime": { @@ -2758,17 +2751,24 @@ "smithy.api#documentation": "

    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. \n For more information about this parameter, see ScheduledAction.

    " } }, - "Schedule": { + "ScheduledActionDescription": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The description of the scheduled action. \n

    " + } + }, + "Schedule": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The schedule in at( ) or cron( ) format. \n For more information about this parameter, see ScheduledAction.

    ", "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.redshift#TStamp", + "ScheduledActionName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The start time in UTC of the scheduled action. \n Before this time, the scheduled action does not trigger.\n For more information about this parameter, see ScheduledAction.

    " + "smithy.api#documentation": "

    The name of the scheduled action. The name must be unique within an account. \n For more information about this parameter, see ScheduledAction.

    ", + "smithy.api#required": {} } } } @@ -2808,6 +2808,12 @@ "com.amazonaws.redshift#CreateSnapshotCopyGrantMessage": { "type": "structure", "members": { + "KmsKeyId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift\n permission. If no key is specified, the default key is used.

    " + } + }, "SnapshotCopyGrantName": { "target": "com.amazonaws.redshift#String", "traits": { @@ -2820,12 +2826,6 @@ "traits": { "smithy.api#documentation": "

    A list of tag instances.

    " } - }, - "KmsKeyId": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift\n permission. If no key is specified, the default key is used.

    " - } } }, "traits": { @@ -2878,16 +2878,10 @@ "smithy.api#documentation": "

    The description of the snapshot schedule.

    " } }, - "ScheduleDefinitions": { - "target": "com.amazonaws.redshift#ScheduleDefinitionList", - "traits": { - "smithy.api#documentation": "

    The definition of the snapshot schedule. The definition is made up of schedule\n expressions, for example \"cron(30 12 *)\" or \"rate(12 hours)\".

    " - } - }, - "DryRun": { - "target": "com.amazonaws.redshift#BooleanOptional", + "Tags": { + "target": "com.amazonaws.redshift#TagList", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    An optional set of tags you can use to search for the schedule.

    " } }, "NextInvocations": { @@ -2902,10 +2896,16 @@ "smithy.api#documentation": "

    A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed\n for the identifier.

    " } }, - "Tags": { - "target": "com.amazonaws.redshift#TagList", + "DryRun": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    An optional set of tags you can use to search for the schedule.

    " + "smithy.api#documentation": "

    " + } + }, + "ScheduleDefinitions": { + "target": "com.amazonaws.redshift#ScheduleDefinitionList", + "traits": { + "smithy.api#documentation": "

    The definition of the snapshot schedule. The definition is made up of schedule\n expressions, for example \"cron(30 12 *)\" or \"rate(12 hours)\".

    " } } } @@ -2990,42 +2990,42 @@ "com.amazonaws.redshift#CreateUsageLimitMessage": { "type": "structure", "members": { - "FeatureType": { - "target": "com.amazonaws.redshift#UsageLimitFeatureType", - "traits": { - "smithy.api#documentation": "

    The Amazon Redshift feature that you want to limit.

    ", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.redshift#TagList", "traits": { "smithy.api#documentation": "

    A list of tag instances.

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", + "Amount": { + "target": "com.amazonaws.redshift#Long", "traits": { - "smithy.api#documentation": "

    The identifier of the cluster that you want to limit usage.

    ", + "smithy.api#documentation": "

    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).\n The value must be a positive number.\n

    ", "smithy.api#required": {} } }, + "Period": { + "target": "com.amazonaws.redshift#UsageLimitPeriod", + "traits": { + "smithy.api#documentation": "

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. \n

    " + } + }, "BreachAction": { "target": "com.amazonaws.redshift#UsageLimitBreachAction", "traits": { "smithy.api#documentation": "

    The action that Amazon Redshift takes when the limit is reached. The default is log. \n For more information about this parameter, see UsageLimit.

    " } }, - "Period": { - "target": "com.amazonaws.redshift#UsageLimitPeriod", + "FeatureType": { + "target": "com.amazonaws.redshift#UsageLimitFeatureType", "traits": { - "smithy.api#documentation": "

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. \n

    " + "smithy.api#documentation": "

    The Amazon Redshift feature that you want to limit.

    ", + "smithy.api#required": {} } }, - "Amount": { - "target": "com.amazonaws.redshift#Long", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).\n The value must be a positive number.\n

    ", + "smithy.api#documentation": "

    The identifier of the cluster that you want to limit usage.

    ", "smithy.api#required": {} } }, @@ -3070,6 +3070,12 @@ "smithy.api#documentation": "

    Describes the status of the cluster. While the transfer is in progress the status is\n transferringdata.

    " } }, + "CurrentRateInMegaBytesPerSecond": { + "target": "com.amazonaws.redshift#DoubleOptional", + "traits": { + "smithy.api#documentation": "

    Describes the data transfer rate in MB's per second.

    " + } + }, "ElapsedTimeInSeconds": { "target": "com.amazonaws.redshift#LongOptional", "traits": { @@ -3087,12 +3093,6 @@ "traits": { "smithy.api#documentation": "

    Describes the total amount of data that has been transfered in MB's.

    " } - }, - "CurrentRateInMegaBytesPerSecond": { - "target": "com.amazonaws.redshift#DoubleOptional", - "traits": { - "smithy.api#documentation": "

    Describes the data transfer rate in MB's per second.

    " - } } }, "traits": { @@ -3117,16 +3117,16 @@ "smithy.api#documentation": "

    The list of cluster default parameters.

    " } }, - "Marker": { + "ParameterGroupFamily": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " + "smithy.api#documentation": "

    The name of the cluster parameter group family to which the engine default\n parameters apply.

    " } }, - "ParameterGroupFamily": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the cluster parameter group family to which the engine default\n parameters apply.

    " + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " } } }, @@ -3137,18 +3137,18 @@ "com.amazonaws.redshift#DeferredMaintenanceWindow": { "type": "structure", "members": { - "DeferMaintenanceIdentifier": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A unique identifier for the maintenance window.

    " - } - }, "DeferMaintenanceEndTime": { "target": "com.amazonaws.redshift#TStamp", "traits": { "smithy.api#documentation": "

    A timestamp for the end of the time period when we defer maintenance.

    " } }, + "DeferMaintenanceIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A unique identifier for the maintenance window.

    " + } + }, "DeferMaintenanceStartTime": { "target": "com.amazonaws.redshift#TStamp", "traits": { @@ -3214,17 +3214,17 @@ "smithy.api#documentation": "

    Determines whether a final snapshot of the cluster is created before Amazon Redshift\n deletes the cluster. If true, a final cluster snapshot is not created. If\n false, a final cluster snapshot is created before the cluster is\n deleted.

    \n \n

    The FinalClusterSnapshotIdentifier parameter must be\n specified if SkipFinalClusterSnapshot is\n false.

    \n     \n

    Default: false\n

    " } }, - "FinalClusterSnapshotIdentifier": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The identifier of the final snapshot that is to be created immediately before\n deleting the cluster. If this parameter is provided,\n SkipFinalClusterSnapshot must be false.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 alphanumeric characters.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " - } - }, "FinalClusterSnapshotRetentionPeriod": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The number of days that a manual snapshot is retained. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    \n

    The default value is -1.

    " } + }, + "FinalClusterSnapshotIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The identifier of the final snapshot that is to be created immediately before\n deleting the cluster. If this parameter is provided,\n SkipFinalClusterSnapshot must be false.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 alphanumeric characters.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " + } } }, "traits": { @@ -3326,17 +3326,17 @@ "com.amazonaws.redshift#DeleteClusterSnapshotMessage": { "type": "structure", "members": { - "SnapshotClusterIdentifier": { + "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The unique identifier of the cluster the snapshot was created from. This parameter\n is required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    \n

    Constraints: Must be the name of valid cluster.

    " + "smithy.api#documentation": "

    The unique identifier of the manual snapshot to be deleted.

    \n

    Constraints: Must be the name of an existing snapshot that is in the\n available, failed, or cancelled\n state.

    ", + "smithy.api#required": {} } }, - "SnapshotIdentifier": { + "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The unique identifier of the manual snapshot to be deleted.

    \n

    Constraints: Must be the name of an existing snapshot that is in the\n available, failed, or cancelled\n state.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The unique identifier of the cluster the snapshot was created from. This parameter\n is required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    \n

    Constraints: Must be the name of valid cluster.

    " } } }, @@ -3602,17 +3602,17 @@ "com.amazonaws.redshift#DeleteTagsMessage": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.redshift#TagKeyList", + "ResourceName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The tag key that you want to delete.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For\n example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    ", "smithy.api#required": {} } }, - "ResourceName": { - "target": "com.amazonaws.redshift#String", + "TagKeys": { + "target": "com.amazonaws.redshift#TagKeyList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For\n example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    ", + "smithy.api#documentation": "

    The tag key that you want to delete.

    ", "smithy.api#required": {} } } @@ -3728,17 +3728,17 @@ "smithy.api#documentation": "

    An optional parameter that specifies the starting point for returning a set of\n response records. When the results of a DescribeClusterDbRevisions request\n exceed the value specified in MaxRecords, Amazon Redshift returns a value\n in the marker field of the response. You can retrieve the next set of\n response records by providing the returned marker value in the\n marker parameter and retrying the request.

    \n

    Constraints: You can specify either the ClusterIdentifier parameter, or\n the marker parameter, but not both.

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A unique identifier for a cluster whose ClusterDbRevisions you are\n requesting. This parameter is case sensitive. All clusters defined for an account are\n returned by default.

    " - } - }, "MaxRecords": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value is returned\n in the marker field of the response. You can retrieve the next set of\n response records by providing the returned marker value in the\n marker parameter and retrying the request.

    \n

    Default: 100

    \n

    Constraints: minimum 20, maximum 100.

    " } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A unique identifier for a cluster whose ClusterDbRevisions you are\n requesting. This parameter is case sensitive. All clusters defined for an account are\n returned by default.

    " + } } } }, @@ -3771,18 +3771,18 @@ "com.amazonaws.redshift#DescribeClusterParameterGroupsMessage": { "type": "structure", "members": { - "ParameterGroupName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of a specific parameter group for which to return details. By default,\n details about all parameter groups and the default parameter group are\n returned.

    " - } - }, "MaxRecords": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } }, + "ParameterGroupName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of a specific parameter group for which to return details. By default,\n details about all parameter groups and the default parameter group are\n returned.

    " + } + }, "TagKeys": { "target": "com.amazonaws.redshift#TagKeyList", "traits": { @@ -3832,10 +3832,10 @@ "com.amazonaws.redshift#DescribeClusterParametersMessage": { "type": "structure", "members": { - "Source": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The parameter types to return. Specify user to show parameters that\n are different form the default. Similarly, specify engine-default to show\n parameters that are the same as the default parameter group.

    \n

    Default: All parameter types returned.

    \n

    Valid Values: user | engine-default\n

    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterParameters request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } }, "ParameterGroupName": { @@ -3851,10 +3851,10 @@ "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } }, - "Marker": { + "Source": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterParameters request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + "smithy.api#documentation": "

    The parameter types to return. Specify user to show parameters that\n are different form the default. Similarly, specify engine-default to show\n parameters that are the same as the default parameter group.

    \n

    Default: All parameter types returned.

    \n

    Valid Values: user | engine-default\n

    " } } }, @@ -3891,16 +3891,22 @@ "com.amazonaws.redshift#DescribeClusterSecurityGroupsMessage": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterSecurityGroups request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    \n

    Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

    " + } + }, "TagValues": { "target": "com.amazonaws.redshift#TagValueList", "traits": { "smithy.api#documentation": "

    A tag value or values for which you want to return all matching cluster security\n groups that are associated with the specified tag value or values. For example, suppose\n that you have security groups that are tagged with values called admin and\n test. If you specify both of these tag values in the request, Amazon Redshift\n returns a response with the security groups that have either or both of these tag values\n associated with them.

    " } }, - "Marker": { + "ClusterSecurityGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterSecurityGroups request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    \n

    Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

    " + "smithy.api#documentation": "

    The name of a cluster security group for which you are requesting details. You can\n specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

    \n

    Example: securitygroup1\n

    " } }, "TagKeys": { @@ -3914,12 +3920,6 @@ "traits": { "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } - }, - "ClusterSecurityGroupName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of a cluster security group for which you are requesting details. You can\n specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

    \n

    Example: securitygroup1\n

    " - } } }, "traits": { @@ -3964,10 +3964,16 @@ "smithy.api#documentation": "

    The identifier of the cluster which generated the requested snapshots.

    " } }, - "SnapshotIdentifier": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The snapshot identifier of the snapshot about which to return\n information.

    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterSnapshots request exceed\n the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + } + }, + "OwnerAccount": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The AWS customer account used to create or copy the snapshot. Use this field to\n filter the results to snapshots owned by a particular account. To describe snapshots you\n own, either specify your AWS customer account, or do not specify the\n parameter.

    " } }, "SnapshotType": { @@ -3976,16 +3982,16 @@ "smithy.api#documentation": "

    The type of snapshots for which you are requesting information. By default,\n snapshots of all types are returned.

    \n

    Valid Values: automated | manual\n

    " } }, - "StartTime": { - "target": "com.amazonaws.redshift#TStamp", + "SnapshotIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A value that requests only snapshots created at or after the specified time. The\n time value is specified in ISO 8601 format. For more information about ISO 8601, go to\n the ISO8601 Wikipedia page.\n

    \n

    Example: 2012-07-16T18:00:00Z\n

    " + "smithy.api#documentation": "

    The snapshot identifier of the snapshot about which to return\n information.

    " } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    A time value that requests only snapshots created at or before the specified time.\n The time value is specified in ISO 8601 format. For more information about ISO 8601, go\n to the ISO8601 Wikipedia\n page.\n

    \n

    Example: 2012-07-16T18:00:00Z\n

    " + "smithy.api#documentation": "

    A value that requests only snapshots created at or after the specified time. The\n time value is specified in ISO 8601 format. For more information about ISO 8601, go to\n the ISO8601 Wikipedia page.\n

    \n

    Example: 2012-07-16T18:00:00Z\n

    " } }, "TagKeys": { @@ -4000,34 +4006,28 @@ "smithy.api#documentation": "

    " } }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " - } - }, - "ClusterExists": { - "target": "com.amazonaws.redshift#BooleanOptional", + "EndTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to return snapshots only for an existing cluster.\n You can perform table-level restore only by using a snapshot of an existing cluster,\n that is, a cluster that has not been deleted. Values for this parameter work as follows:

    \n
      \n
    • \n

      If ClusterExists is set to true,\n ClusterIdentifier is required.

      \n
      • \n
    • \n

      If ClusterExists is set to false and\n ClusterIdentifier isn't specified, all snapshots\n associated with deleted clusters (orphaned snapshots) are returned.

      \n
      • \n
    • \n

      If ClusterExists is set to false and\n ClusterIdentifier is specified for a deleted cluster, snapshots\n associated with that cluster are returned.

      \n
      • \n
    • \n

      If ClusterExists is set to false and\n ClusterIdentifier is specified for an existing cluster, no\n snapshots are returned.

      \n
      • \n
    " + "smithy.api#documentation": "

    A time value that requests only snapshots created at or before the specified time.\n The time value is specified in ISO 8601 format. For more information about ISO 8601, go\n to the ISO8601 Wikipedia\n page.\n

    \n

    Example: 2012-07-16T18:00:00Z\n

    " } }, - "OwnerAccount": { - "target": "com.amazonaws.redshift#String", + "TagValues": { + "target": "com.amazonaws.redshift#TagValueList", "traits": { - "smithy.api#documentation": "

    The AWS customer account used to create or copy the snapshot. Use this field to\n filter the results to snapshots owned by a particular account. To describe snapshots you\n own, either specify your AWS customer account, or do not specify the\n parameter.

    " + "smithy.api#documentation": "

    A tag value or values for which you want to return all matching cluster snapshots\n that are associated with the specified tag value or values. For example, suppose that\n you have snapshots that are tagged with values called admin and\n test. If you specify both of these tag values in the request, Amazon Redshift\n returns a response with the snapshots that have either or both of these tag values\n associated with them.

    " } }, - "Marker": { - "target": "com.amazonaws.redshift#String", + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterSnapshots request exceed\n the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } }, - "TagValues": { - "target": "com.amazonaws.redshift#TagValueList", + "ClusterExists": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A tag value or values for which you want to return all matching cluster snapshots\n that are associated with the specified tag value or values. For example, suppose that\n you have snapshots that are tagged with values called admin and\n test. If you specify both of these tag values in the request, Amazon Redshift\n returns a response with the snapshots that have either or both of these tag values\n associated with them.

    " + "smithy.api#documentation": "

    A value that indicates whether to return snapshots only for an existing cluster.\n You can perform table-level restore only by using a snapshot of an existing cluster,\n that is, a cluster that has not been deleted. Values for this parameter work as follows:

    \n
      \n
    • \n

      If ClusterExists is set to true,\n ClusterIdentifier is required.

      \n
      • \n
    • \n

      If ClusterExists is set to false and\n ClusterIdentifier isn't specified, all snapshots\n associated with deleted clusters (orphaned snapshots) are returned.

      \n
      • \n
    • \n

      If ClusterExists is set to false and\n ClusterIdentifier is specified for a deleted cluster, snapshots\n associated with that cluster are returned.

      \n
      • \n
    • \n

      If ClusterExists is set to false and\n ClusterIdentifier is specified for an existing cluster, no\n snapshots are returned.

      \n
      • \n
    " } } }, @@ -4064,14 +4064,20 @@ "com.amazonaws.redshift#DescribeClusterSubnetGroupsMessage": { "type": "structure", "members": { - "TagValues": { - "target": "com.amazonaws.redshift#TagValueList", + "Marker": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A tag value or values for which you want to return all matching cluster subnet\n groups that are associated with the specified tag value or values. For example, suppose\n that you have subnet groups that are tagged with values called admin and\n test. If you specify both of these tag values in the request, Amazon Redshift\n returns a response with the subnet groups that have either or both of these tag values\n associated with them.

    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterSubnetGroups request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", + "ClusterSubnetGroupName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the cluster subnet group for which information is requested.

    " + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } @@ -4082,16 +4088,10 @@ "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching cluster subnet groups\n that are associated with the specified key or keys. For example, suppose that you have\n subnet groups that are tagged with keys called owner and\n environment. If you specify both of these tag keys in the request,\n Amazon Redshift returns a response with the subnet groups that have either or both of these\n tag keys associated with them.

    " } }, - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterSubnetGroups request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " - } - }, - "ClusterSubnetGroupName": { - "target": "com.amazonaws.redshift#String", + "TagValues": { + "target": "com.amazonaws.redshift#TagValueList", "traits": { - "smithy.api#documentation": "

    The name of the cluster subnet group for which information is requested.

    " + "smithy.api#documentation": "

    A tag value or values for which you want to return all matching cluster subnet\n groups that are associated with the specified tag value or values. For example, suppose\n that you have subnet groups that are tagged with values called admin and\n test. If you specify both of these tag values in the request, Amazon Redshift\n returns a response with the subnet groups that have either or both of these tag values\n associated with them.

    " } } }, @@ -4128,16 +4128,16 @@ "smithy.api#documentation": "

    An integer value for the maximum number of maintenance tracks to return.

    " } }, - "MaintenanceTrackName": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the maintenance track.

    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterTracks request exceed the\n value specified in MaxRecords, Amazon Redshift returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } }, - "Marker": { + "MaintenanceTrackName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusterTracks request exceed the\n value specified in MaxRecords, Amazon Redshift returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + "smithy.api#documentation": "

    The name of the maintenance track.

    " } } } @@ -4221,18 +4221,6 @@ "com.amazonaws.redshift#DescribeClustersMessage": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.redshift#TagKeyList", - "traits": { - "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching clusters that are\n associated with the specified key or keys. For example, suppose that you have clusters\n that are tagged with keys called owner and environment. If you\n specify both of these tag keys in the request, Amazon Redshift returns a response with the\n clusters that have either or both of these tag keys associated with them.

    " - } - }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " - } - }, "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { @@ -4245,11 +4233,23 @@ "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeClusters request exceed the\n value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    \n

    Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

    " } }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " + } + }, "TagValues": { "target": "com.amazonaws.redshift#TagValueList", "traits": { "smithy.api#documentation": "

    A tag value or values for which you want to return all matching clusters that are\n associated with the specified tag value or values. For example, suppose that you have\n clusters that are tagged with values called admin and test. If\n you specify both of these tag values in the request, Amazon Redshift returns a response with\n the clusters that have either or both of these tag values associated with\n them.

    " } + }, + "TagKeys": { + "target": "com.amazonaws.redshift#TagKeyList", + "traits": { + "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching clusters that are\n associated with the specified key or keys. For example, suppose that you have clusters\n that are tagged with keys called owner and environment. If you\n specify both of these tag keys in the request, Amazon Redshift returns a response with the\n clusters that have either or both of these tag keys associated with them.

    " + } } }, "traits": { @@ -4265,7 +4265,13 @@ "target": "com.amazonaws.redshift#DescribeDefaultClusterParametersResult" }, "traits": { - "smithy.api#documentation": "

    Returns a list of parameter settings for the specified parameter group\n family.

    \n

    \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    " + "smithy.api#documentation": "

    Returns a list of parameter settings for the specified parameter group\n family.

    \n

    \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "DefaultClusterParameters.Marker", + "items": "DefaultClusterParameters.Parameters", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.redshift#DescribeDefaultClusterParametersMessage": { @@ -4278,17 +4284,17 @@ "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDefaultClusterParameters\n request exceed the value specified in MaxRecords, AWS returns a value in\n the Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " - } - }, "MaxRecords": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDefaultClusterParameters\n request exceed the value specified in MaxRecords, AWS returns a value in\n the Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + } } }, "traits": { @@ -4358,6 +4364,12 @@ "com.amazonaws.redshift#DescribeEventSubscriptionsMessage": { "type": "structure", "members": { + "SubscriptionName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the Amazon Redshift event notification subscription to be\n described.

    " + } + }, "TagValues": { "target": "com.amazonaws.redshift#TagValueList", "traits": { @@ -4370,22 +4382,16 @@ "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeEventSubscriptions request exceed the value\n specified in MaxRecords, AWS returns a value in the Marker\n field of the response. You can retrieve the next set of response records by providing\n the returned marker value in the Marker parameter and retrying the request.\n

    " } }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " - } - }, "TagKeys": { "target": "com.amazonaws.redshift#TagKeyList", "traits": { "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching event notification\n subscriptions that are associated with the specified key or keys. For example, suppose\n that you have subscriptions that are tagged with keys called owner and\n environment. If you specify both of these tag keys in the request,\n Amazon Redshift returns a response with the subscriptions that have either or both of these\n tag keys associated with them.

    " } }, - "SubscriptionName": { - "target": "com.amazonaws.redshift#String", + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The name of the Amazon Redshift event notification subscription to be\n described.

    " + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } } }, @@ -4414,16 +4420,22 @@ "com.amazonaws.redshift#DescribeEventsMessage": { "type": "structure", "members": { + "SourceType": { + "target": "com.amazonaws.redshift#SourceType", + "traits": { + "smithy.api#documentation": "

    The event source to retrieve events for. If no value is specified, all events are\n returned.

    \n

    Constraints:

    \n

    If SourceType is supplied,\n SourceIdentifier must also be provided.

    \n
      \n
    • \n

      Specify cluster when SourceIdentifier is\n a cluster identifier.

      \n
      • \n
    • \n

      Specify cluster-security-group when\n SourceIdentifier is a cluster security group\n name.

      \n
      • \n
    • \n

      Specify cluster-parameter-group when\n SourceIdentifier is a cluster parameter group\n name.

      \n
      • \n
    • \n

      Specify cluster-snapshot when\n SourceIdentifier is a cluster snapshot\n identifier.

      \n
      • \n
    " + } + }, "Duration": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The number of minutes prior to the time of the request for which to retrieve\n events. For example, if the request is sent at 18:00 and you specify a duration of 60,\n then only events which have occurred after 17:00 will be returned.

    \n

    Default: 60\n

    " } }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", + "EndTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    The end of the time interval for which to retrieve events, specified in ISO 8601\n format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.\n

    \n

    Example: 2009-07-08T18:00Z\n

    " } }, "SourceIdentifier": { @@ -4432,16 +4444,10 @@ "smithy.api#documentation": "

    The identifier of the event source for which events will be returned. If this\n parameter is not specified, then all sources are included in the response.

    \n

    Constraints:

    \n

    If SourceIdentifier is supplied,\n SourceType must also be provided.

    \n
      \n
    • \n

      Specify a cluster identifier when SourceType is\n cluster.

      \n
      • \n
    • \n

      Specify a cluster security group name when SourceType\n is cluster-security-group.

      \n
      • \n
    • \n

      Specify a cluster parameter group name when SourceType\n is cluster-parameter-group.

      \n
      • \n
    • \n

      Specify a cluster snapshot identifier when SourceType\n is cluster-snapshot.

      \n
      • \n
    " } }, - "EndTime": { - "target": "com.amazonaws.redshift#TStamp", - "traits": { - "smithy.api#documentation": "

    The end of the time interval for which to retrieve events, specified in ISO 8601\n format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.\n

    \n

    Example: 2009-07-08T18:00Z\n

    " - } - }, - "Marker": { - "target": "com.amazonaws.redshift#String", + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeEvents request exceed the value\n specified in MaxRecords, AWS returns a value in the Marker\n field of the response. You can retrieve the next set of response records by providing\n the returned marker value in the Marker parameter and retrying the request.\n

    " + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } }, "StartTime": { @@ -4450,10 +4456,10 @@ "smithy.api#documentation": "

    The beginning of the time interval to retrieve events for, specified in ISO 8601\n format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.\n

    \n

    Example: 2009-07-08T18:00Z\n

    " } }, - "SourceType": { - "target": "com.amazonaws.redshift#SourceType", + "Marker": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The event source to retrieve events for. If no value is specified, all events are\n returned.

    \n

    Constraints:

    \n

    If SourceType is supplied,\n SourceIdentifier must also be provided.

    \n
      \n
    • \n

      Specify cluster when SourceIdentifier is\n a cluster identifier.

      \n
      • \n
    • \n

      Specify cluster-security-group when\n SourceIdentifier is a cluster security group\n name.

      \n
      • \n
    • \n

      Specify cluster-parameter-group when\n SourceIdentifier is a cluster parameter group\n name.

      \n
      • \n
    • \n

      Specify cluster-snapshot when\n SourceIdentifier is a cluster snapshot\n identifier.

      \n
      • \n
    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeEvents request exceed the value\n specified in MaxRecords, AWS returns a value in the Marker\n field of the response. You can retrieve the next set of response records by providing\n the returned marker value in the Marker parameter and retrying the request.\n

    " } } }, @@ -4502,6 +4508,12 @@ "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeHsmClientCertificates request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + } + }, "TagValues": { "target": "com.amazonaws.redshift#TagValueList", "traits": { @@ -4513,12 +4525,6 @@ "traits": { "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching HSM client certificates\n that are associated with the specified key or keys. For example, suppose that you have\n HSM client certificates that are tagged with keys called owner and\n environment. If you specify both of these tag keys in the request,\n Amazon Redshift returns a response with the HSM client certificates that have either or both\n of these tag keys associated with them.

    " } - }, - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeHsmClientCertificates request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " - } } }, "traits": { @@ -4554,28 +4560,22 @@ "com.amazonaws.redshift#DescribeHsmConfigurationsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " - } - }, "TagKeys": { "target": "com.amazonaws.redshift#TagKeyList", "traits": { "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching HSM configurations that\n are associated with the specified key or keys. For example, suppose that you have HSM\n configurations that are tagged with keys called owner and\n environment. If you specify both of these tag keys in the request,\n Amazon Redshift returns a response with the HSM configurations that have either or both of\n these tag keys associated with them.

    " } }, - "HsmConfigurationIdentifier": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of a specific Amazon Redshift HSM configuration to be described. If no\n identifier is specified, information is returned for all HSM configurations owned by\n your AWS customer account.

    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeHsmConfigurations request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } }, - "Marker": { + "HsmConfigurationIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeHsmConfigurations request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + "smithy.api#documentation": "

    The identifier of a specific Amazon Redshift HSM configuration to be described. If no\n identifier is specified, information is returned for all HSM configurations owned by\n your AWS customer account.

    " } }, "TagValues": { @@ -4583,6 +4583,12 @@ "traits": { "smithy.api#documentation": "

    A tag value or values for which you want to return all matching HSM configurations\n that are associated with the specified tag value or values. For example, suppose that\n you have HSM configurations that are tagged with values called admin and\n test. If you specify both of these tag values in the request, Amazon Redshift\n returns a response with the HSM configurations that have either or both of these tag\n values associated with them.

    " } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " + } } }, "traits": { @@ -4669,35 +4675,35 @@ "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 500\n

    \n

    Constraints: minimum 100, maximum 500.

    " } }, - "Filters": { - "target": "com.amazonaws.redshift#NodeConfigurationOptionsFilterList", + "Marker": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A set of name, operator, and value items to filter the results.

    ", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeNodeConfigurationOptions request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } }, - "SnapshotIdentifier": { + "OwnerAccount": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the snapshot to evaluate for possible node configurations.

    " + "smithy.api#documentation": "

    The AWS customer account used to create or copy the snapshot. \n Required if you are restoring a snapshot you do not own, \n optional if you own the snapshot.

    " } }, - "ClusterIdentifier": { + "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the cluster to evaluate for possible node configurations.

    " + "smithy.api#documentation": "

    The identifier of the snapshot to evaluate for possible node configurations.

    " } }, - "Marker": { - "target": "com.amazonaws.redshift#String", + "Filters": { + "target": "com.amazonaws.redshift#NodeConfigurationOptionsFilterList", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeNodeConfigurationOptions request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + "smithy.api#documentation": "

    A set of name, operator, and value items to filter the results.

    ", + "smithy.api#xmlName": "Filter" } }, - "OwnerAccount": { + "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The AWS customer account used to create or copy the snapshot. \n Required if you are restoring a snapshot you do not own, \n optional if you own the snapshot.

    " + "smithy.api#documentation": "

    The identifier of the cluster to evaluate for possible node configurations.

    " } } } @@ -4723,28 +4729,28 @@ "com.amazonaws.redshift#DescribeOrderableClusterOptionsMessage": { "type": "structure", "members": { - "NodeType": { - "target": "com.amazonaws.redshift#String", + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The node type filter value. Specify this parameter to show only the available\n offerings matching the specified node type.

    " + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } }, - "ClusterVersion": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The version filter value. Specify this parameter to show only the available\n offerings matching the specified version.

    \n

    Default: All versions.

    \n

    Constraints: Must be one of the version returned from DescribeClusterVersions.

    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeOrderableClusterOptions request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } }, - "Marker": { + "ClusterVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeOrderableClusterOptions request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + "smithy.api#documentation": "

    The version filter value. Specify this parameter to show only the available\n offerings matching the specified version.

    \n

    Default: All versions.

    \n

    Constraints: Must be one of the version returned from DescribeClusterVersions.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", + "NodeType": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    The node type filter value. Specify this parameter to show only the available\n offerings matching the specified node type.

    " } } }, @@ -4784,18 +4790,18 @@ "com.amazonaws.redshift#DescribeReservedNodeOfferingsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " - } - }, "ReservedNodeOfferingId": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The unique identifier for the offering.

    " } }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " + } + }, "Marker": { "target": "com.amazonaws.redshift#String", "traits": { @@ -4842,17 +4848,17 @@ "smithy.api#documentation": "

    Identifier for the node reservation.

    " } }, - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeReservedNodes request exceed\n the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " - } - }, "MaxRecords": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeReservedNodes request exceed\n the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + } } }, "traits": { @@ -4923,10 +4929,10 @@ "com.amazonaws.redshift#DescribeScheduledActionsMessage": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.redshift#TStamp", + "Filters": { + "target": "com.amazonaws.redshift#ScheduledActionFilterList", "traits": { - "smithy.api#documentation": "

    The start time in UTC of the scheduled actions to retrieve. \n Only active scheduled actions that have invocations after this time are retrieved.

    " + "smithy.api#documentation": "

    List of scheduled action filters.

    " } }, "Active": { @@ -4959,16 +4965,16 @@ "smithy.api#documentation": "

    The end time in UTC of the scheduled action to retrieve. \n Only active scheduled actions that have invocations before this time are retrieved.

    " } }, - "TargetActionType": { - "target": "com.amazonaws.redshift#ScheduledActionTypeValues", + "StartTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The type of the scheduled actions to retrieve.

    " + "smithy.api#documentation": "

    The start time in UTC of the scheduled actions to retrieve. \n Only active scheduled actions that have invocations after this time are retrieved.

    " } }, - "Filters": { - "target": "com.amazonaws.redshift#ScheduledActionFilterList", + "TargetActionType": { + "target": "com.amazonaws.redshift#ScheduledActionTypeValues", "traits": { - "smithy.api#documentation": "

    List of scheduled action filters.

    " + "smithy.api#documentation": "

    The type of the scheduled actions to retrieve.

    " } } } @@ -4996,24 +5002,18 @@ "com.amazonaws.redshift#DescribeSnapshotCopyGrantsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " - } - }, - "TagValues": { - "target": "com.amazonaws.redshift#TagValueList", - "traits": { - "smithy.api#documentation": "

    A tag value or values for which you want to return all matching resources that are\n associated with the specified value or values. For example, suppose that you have\n resources tagged with values called admin and test. If you\n specify both of these tag values in the request, Amazon Redshift returns a response with all\n resources that have either or both of these tag values associated with them.

    " - } - }, "TagKeys": { "target": "com.amazonaws.redshift#TagKeyList", "traits": { "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching resources that are\n associated with the specified key or keys. For example, suppose that you have resources\n tagged with keys called owner and environment. If you specify\n both of these tag keys in the request, Amazon Redshift returns a response with all resources\n that have either or both of these tag keys associated with them.

    " } }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " + } + }, "Marker": { "target": "com.amazonaws.redshift#String", "traits": { @@ -5025,10 +5025,16 @@ "traits": { "smithy.api#documentation": "

    The name of the snapshot copy grant.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    The result of the DescribeSnapshotCopyGrants action.

    " + }, + "TagValues": { + "target": "com.amazonaws.redshift#TagValueList", + "traits": { + "smithy.api#documentation": "

    A tag value or values for which you want to return all matching resources that are\n associated with the specified value or values. For example, suppose that you have\n resources tagged with values called admin and test. If you\n specify both of these tag values in the request, Amazon Redshift returns a response with all\n resources that have either or both of these tag values associated with them.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The result of the DescribeSnapshotCopyGrants action.

    " } }, "com.amazonaws.redshift#DescribeSnapshotSchedules": { @@ -5046,16 +5052,16 @@ "com.amazonaws.redshift#DescribeSnapshotSchedulesMessage": { "type": "structure", "members": { - "ScheduleIdentifier": { + "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A unique identifier for a snapshot schedule.

    " + "smithy.api#documentation": "

    The unique identifier for the cluster whose snapshot schedules you want to\n view.

    " } }, - "TagKeys": { - "target": "com.amazonaws.redshift#TagKeyList", + "TagValues": { + "target": "com.amazonaws.redshift#TagValueList", "traits": { - "smithy.api#documentation": "

    The key value for a snapshot schedule tag.

    " + "smithy.api#documentation": "

    The value corresponding to the key of the snapshot schedule tag.

    " } }, "MaxRecords": { @@ -5064,16 +5070,16 @@ "smithy.api#documentation": "

    The maximum number or response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker\n value.

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", + "TagKeys": { + "target": "com.amazonaws.redshift#TagKeyList", "traits": { - "smithy.api#documentation": "

    The unique identifier for the cluster whose snapshot schedules you want to\n view.

    " + "smithy.api#documentation": "

    The key value for a snapshot schedule tag.

    " } }, - "TagValues": { - "target": "com.amazonaws.redshift#TagValueList", + "ScheduleIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The value corresponding to the key of the snapshot schedule tag.

    " + "smithy.api#documentation": "

    A unique identifier for a snapshot schedule.

    " } }, "Marker": { @@ -5133,10 +5139,10 @@ "com.amazonaws.redshift#DescribeTableRestoreStatusMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeTableRestoreStatus request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by the\n MaxRecords parameter.

    " + "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

    " } }, "TableRestoreRequestId": { @@ -5145,16 +5151,16 @@ "smithy.api#documentation": "

    The identifier of the table restore request to return status for. If you don't\n specify a TableRestoreRequestId value, then\n DescribeTableRestoreStatus returns the status of all in-progress table\n restore requests.

    " } }, - "ClusterIdentifier": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The Amazon Redshift cluster that the table is being restored to.

    " + "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeTableRestoreStatus request. If this parameter is specified, the\n response includes only records beyond the marker, up to the value specified by the\n MaxRecords parameter.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    The Amazon Redshift cluster that the table is being restored to.

    " } } }, @@ -5185,18 +5191,6 @@ "com.amazonaws.redshift#DescribeTagsMessage": { "type": "structure", "members": { - "TagValues": { - "target": "com.amazonaws.redshift#TagValueList", - "traits": { - "smithy.api#documentation": "

    A tag value or values for which you want to return all matching resources that are\n associated with the specified value or values. For example, suppose that you have\n resources tagged with values called admin and test. If you\n specify both of these tag values in the request, Amazon Redshift returns a response with all\n resources that have either or both of these tag values associated with them.

    " - } - }, - "ResourceName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For\n example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    " - } - }, "Marker": { "target": "com.amazonaws.redshift#String", "traits": { @@ -5220,6 +5214,18 @@ "traits": { "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching resources that are\n associated with the specified key or keys. For example, suppose that you have resources\n tagged with keys called owner and environment. If you specify\n both of these tag keys in the request, Amazon Redshift returns a response with all resources\n that have either or both of these tag keys associated with them.

    " } + }, + "TagValues": { + "target": "com.amazonaws.redshift#TagValueList", + "traits": { + "smithy.api#documentation": "

    A tag value or values for which you want to return all matching resources that are\n associated with the specified value or values. For example, suppose that you have\n resources tagged with values called admin and test. If you\n specify both of these tag values in the request, Amazon Redshift returns a response with all\n resources that have either or both of these tag values associated with them.

    " + } + }, + "ResourceName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For\n example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    " + } } }, "traits": { @@ -5255,40 +5261,34 @@ "com.amazonaws.redshift#DescribeUsageLimitsMessage": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.redshift#TagKeyList", - "traits": { - "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching usage limit objects\n that are associated with the specified key or keys. For example, suppose that you\n have parameter groups that are tagged with keys called owner and\n environment. If you specify both of these tag keys in the request,\n Amazon Redshift returns a response with the usage limit objects have either or both of these\n tag keys associated with them.

    " - } - }, "FeatureType": { "target": "com.amazonaws.redshift#UsageLimitFeatureType", "traits": { "smithy.api#documentation": "

    The feature type for which you want to describe usage limits.

    " } }, - "UsageLimitId": { - "target": "com.amazonaws.redshift#String", + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The identifier of the usage limit to describe.

    " + "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", + "TagKeys": { + "target": "com.amazonaws.redshift#TagKeyList", "traits": { - "smithy.api#documentation": "

    The identifier of the cluster for which you want to describe usage limits.

    " + "smithy.api#documentation": "

    A tag key or keys for which you want to return all matching usage limit objects\n that are associated with the specified key or keys. For example, suppose that you\n have parameter groups that are tagged with keys called owner and\n environment. If you specify both of these tag keys in the request,\n Amazon Redshift returns a response with the usage limit objects have either or both of these\n tag keys associated with them.

    " } }, - "Marker": { + "UsageLimitId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeUsageLimits request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " + "smithy.api#documentation": "

    The identifier of the usage limit to describe.

    " } }, - "MaxRecords": { - "target": "com.amazonaws.redshift#IntegerOptional", + "Marker": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

    \n

    Default: 100\n

    \n

    Constraints: minimum 20, maximum 100.

    " + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeUsageLimits request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } }, "TagValues": { @@ -5296,6 +5296,12 @@ "traits": { "smithy.api#documentation": "

    A tag value or values for which you want to return all matching usage limit objects\n that are associated with the specified tag value or values. For example, suppose\n that you have parameter groups that are tagged with values called admin and\n test. If you specify both of these tag values in the request, Amazon Redshift\n returns a response with the usage limit objects that have either or both of these tag\n values associated with them.

    " } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The identifier of the cluster for which you want to describe usage limits.

    " + } } } }, @@ -5398,18 +5404,18 @@ "smithy.api#documentation": "

    The AWS ID of the owner of the EC2 security group specified in the\n EC2SecurityGroupName field.

    " } }, - "EC2SecurityGroupName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the EC2 Security Group.

    " - } - }, "Tags": { "target": "com.amazonaws.redshift#TagList", "traits": { "smithy.api#documentation": "

    The list of tags for the EC2 security group.

    " } }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the EC2 Security Group.

    " + } + }, "Status": { "target": "com.amazonaws.redshift#String", "traits": { @@ -5433,16 +5439,16 @@ "com.amazonaws.redshift#ElasticIpStatus": { "type": "structure", "members": { - "Status": { + "ElasticIp": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The status of the elastic IP (EIP) address.

    " + "smithy.api#documentation": "

    The elastic IP (EIP) address for the cluster.

    " } }, - "ElasticIp": { + "Status": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The elastic IP (EIP) address for the cluster.

    " + "smithy.api#documentation": "

    The status of the elastic IP (EIP) address.

    " } } }, @@ -5494,10 +5500,11 @@ "com.amazonaws.redshift#EnableLoggingMessage": { "type": "structure", "members": { - "S3KeyPrefix": { + "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The prefix applied to the log file names.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot exceed 512 characters

      \n
      • \n
    • \n

      Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash\n (\\), or control characters. The hexadecimal codes for invalid characters are:

      \n
        \n
      • \n

        x00 to x20

        \n
        • \n
      • \n

        x22

        \n
        • \n
      • \n

        x27

        \n
        • \n
      • \n

        x5c

        \n
        • \n
      • \n

        x7f or larger

        \n
        • \n
      \n
      • \n
    " + "smithy.api#documentation": "

    The identifier of the cluster on which logging is to be started.

    \n

    Example: examplecluster\n

    ", + "smithy.api#required": {} } }, "BucketName": { @@ -5507,11 +5514,10 @@ "smithy.api#required": {} } }, - "ClusterIdentifier": { + "S3KeyPrefix": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the cluster on which logging is to be started.

    \n

    Example: examplecluster\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The prefix applied to the log file names.

    \n

    Constraints:

    \n
      \n
    • \n

      Cannot exceed 512 characters

      \n
      • \n
    • \n

      Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash\n (\\), or control characters. The hexadecimal codes for invalid characters are:

      \n
        \n
      • \n

        x00 to x20

        \n
        • \n
      • \n

        x22

        \n
        • \n
      • \n

        x27

        \n
        • \n
      • \n

        x5c

        \n
        • \n
      • \n

        x7f or larger

        \n
        • \n
      \n
      • \n
    " } } }, @@ -5569,17 +5575,10 @@ "com.amazonaws.redshift#EnableSnapshotCopyMessage": { "type": "structure", "members": { - "ManualSnapshotRetentionPeriod": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The number of days to retain newly copied snapshots in the destination AWS Region\n after they are copied from the source AWS Region. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " - } - }, - "DestinationRegion": { + "SnapshotCopyGrantName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The destination AWS Region that you want to copy snapshots to.

    \n

    Constraints: Must be the name of a valid AWS Region. For more information, see\n Regions and Endpoints in the Amazon Web Services General Reference.\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted\n cluster are copied to the destination region.

    " } }, "ClusterIdentifier": { @@ -5595,10 +5594,17 @@ "smithy.api#documentation": "

    The number of days to retain automated snapshots in the destination region after\n they are copied from the source region.

    \n

    Default: 7.

    \n

    Constraints: Must be at least 1 and no more than 35.

    " } }, - "SnapshotCopyGrantName": { + "DestinationRegion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted\n cluster are copied to the destination region.

    " + "smithy.api#documentation": "

    The destination AWS Region that you want to copy snapshots to.

    \n

    Constraints: Must be the name of a valid AWS Region. For more information, see\n Regions and Endpoints in the Amazon Web Services General Reference.\n

    ", + "smithy.api#required": {} + } + }, + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The number of days to retain newly copied snapshots in the destination AWS Region\n after they are copied from the source AWS Region. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " } } }, @@ -5637,10 +5643,10 @@ "com.amazonaws.redshift#Event": { "type": "structure", "members": { - "Date": { - "target": "com.amazonaws.redshift#TStamp", + "Message": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The date and time of the event.

    " + "smithy.api#documentation": "

    The text of this event.

    " } }, "SourceType": { @@ -5649,12 +5655,6 @@ "smithy.api#documentation": "

    The source type for this event.

    " } }, - "Severity": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The severity of the event.

    \n

    Values: ERROR, INFO

    " - } - }, "SourceIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { @@ -5673,10 +5673,16 @@ "smithy.api#documentation": "

    A list of the event categories.

    \n

    Values: Configuration, Management, Monitoring, Security

    " } }, - "Message": { + "Severity": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The text of this event.

    " + "smithy.api#documentation": "

    The severity of the event.

    \n

    Values: ERROR, INFO

    " + } + }, + "Date": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "

    The date and time of the event.

    " } } }, @@ -5696,17 +5702,17 @@ "com.amazonaws.redshift#EventCategoriesMap": { "type": "structure", "members": { - "SourceType": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The source type, such as cluster or cluster-snapshot, that the returned categories\n belong to.

    " - } - }, "Events": { "target": "com.amazonaws.redshift#EventInfoMapList", "traits": { "smithy.api#documentation": "

    The events in the event category.

    " } + }, + "SourceType": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The source type, such as cluster or cluster-snapshot, that the returned categories\n belong to.

    " + } } }, "traits": { @@ -5739,12 +5745,6 @@ "com.amazonaws.redshift#EventInfoMap": { "type": "structure", "members": { - "Severity": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The severity of the event.

    \n

    Values: ERROR, INFO

    " - } - }, "EventCategories": { "target": "com.amazonaws.redshift#EventCategoriesList", "traits": { @@ -5762,6 +5762,12 @@ "traits": { "smithy.api#documentation": "

    The description of an Amazon Redshift event.

    " } + }, + "Severity": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The severity of the event.

    \n

    Values: ERROR, INFO

    " + } } }, "traits": { @@ -5789,40 +5795,34 @@ "com.amazonaws.redshift#EventSubscription": { "type": "structure", "members": { - "SourceIdsList": { - "target": "com.amazonaws.redshift#SourceIdsList", - "traits": { - "smithy.api#documentation": "

    A list of the sources that publish events to the Amazon Redshift event notification\n subscription.

    " - } - }, "Status": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The status of the Amazon Redshift event notification subscription.

    \n

    Constraints:

    \n
      \n
    • \n

      Can be one of the following: active | no-permission |\n topic-not-exist

      \n
      • \n
    • \n

      The status \"no-permission\" indicates that Amazon Redshift no longer has\n permission to post to the Amazon SNS topic. The status \"topic-not-exist\"\n indicates that the topic was deleted after the subscription was\n created.

      \n
      • \n
    " } }, - "EventCategoriesList": { - "target": "com.amazonaws.redshift#EventCategoriesList", + "Tags": { + "target": "com.amazonaws.redshift#TagList", "traits": { - "smithy.api#documentation": "

    The list of Amazon Redshift event categories specified in the event notification\n subscription.

    \n

    Values: Configuration, Management, Monitoring, Security

    " + "smithy.api#documentation": "

    The list of tags for the event subscription.

    " } }, - "SourceType": { - "target": "com.amazonaws.redshift#String", + "SourceIdsList": { + "target": "com.amazonaws.redshift#SourceIdsList", "traits": { - "smithy.api#documentation": "

    The source type of the events returned by the Amazon Redshift event notification, such as\n cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

    " + "smithy.api#documentation": "

    A list of the sources that publish events to the Amazon Redshift event notification\n subscription.

    " } }, - "Enabled": { - "target": "com.amazonaws.redshift#Boolean", + "CustSubscriptionId": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A boolean value indicating whether the subscription is enabled; true\n indicates that the subscription is enabled.

    " + "smithy.api#documentation": "

    The name of the Amazon Redshift event notification subscription.

    " } }, - "CustSubscriptionId": { + "CustomerAwsId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the Amazon Redshift event notification subscription.

    " + "smithy.api#documentation": "

    The AWS customer account associated with the Amazon Redshift event notification\n subscription.

    " } }, "SubscriptionCreationTime": { @@ -5837,22 +5837,28 @@ "smithy.api#documentation": "

    The event severity specified in the Amazon Redshift event notification\n subscription.

    \n

    Values: ERROR, INFO

    " } }, - "CustomerAwsId": { - "target": "com.amazonaws.redshift#String", + "Enabled": { + "target": "com.amazonaws.redshift#Boolean", "traits": { - "smithy.api#documentation": "

    The AWS customer account associated with the Amazon Redshift event notification\n subscription.

    " + "smithy.api#documentation": "

    A boolean value indicating whether the subscription is enabled; true\n indicates that the subscription is enabled.

    " } }, - "Tags": { - "target": "com.amazonaws.redshift#TagList", + "SnsTopicArn": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The list of tags for the event subscription.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event\n notification subscription.

    " } }, - "SnsTopicArn": { + "SourceType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event\n notification subscription.

    " + "smithy.api#documentation": "

    The source type of the events returned by the Amazon Redshift event notification, such as\n cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

    " + } + }, + "EventCategoriesList": { + "target": "com.amazonaws.redshift#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

    The list of Amazon Redshift event categories specified in the event notification\n subscription.

    \n

    Values: Configuration, Management, Monitoring, Security

    " } } }, @@ -5948,18 +5954,19 @@ "com.amazonaws.redshift#GetClusterCredentialsMessage": { "type": "structure", "members": { - "DbGroups": { - "target": "com.amazonaws.redshift#DbGroupList", - "traits": { - "smithy.api#documentation": "

    A list of the names of existing database groups that the user named in\n DbUser will join for the current session, in addition to any group\n memberships for an existing user. If not specified, a new user is added only to\n PUBLIC.

    \n

    Database group name constraints

    \n
      \n
    • \n

      Must be 1 to 64 alphanumeric characters or hyphens

      \n
      • \n
    • \n

      Must contain only lowercase letters, numbers, underscore, plus sign, period\n (dot), at symbol (@), or hyphen.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Must not contain a colon ( : ) or slash ( / ).

      \n
      • \n
    • \n

      Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon\n Redshift Database Developer Guide.

      \n
      • \n
    " - } - }, "DurationSeconds": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The number of seconds until the returned temporary password expires.

    \n

    Constraint: minimum 900, maximum 3600.

    \n

    Default: 900

    " } }, + "DbUser": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of a database user. If a user name matching DbUser exists in\n the database, the temporary user credentials have the same permissions as the existing\n user. If DbUser doesn't exist in the database and Autocreate\n is True, a new user is created using the value for DbUser with\n PUBLIC permissions. If a database user matching the value for DbUser\n doesn't exist and Autocreate is False, then the command\n succeeds but the connection attempt will fail because the user doesn't exist in the\n database.

    \n

    For more information, see CREATE USER in the Amazon\n Redshift Database Developer Guide.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be\n PUBLIC.

      \n
      • \n
    • \n

      Must contain only lowercase letters, numbers, underscore, plus sign, period\n (dot), at symbol (@), or hyphen.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Must not contain a colon ( : ) or slash ( / ).

      \n
      • \n
    • \n

      Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon\n Redshift Database Developer Guide.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, "AutoCreate": { "target": "com.amazonaws.redshift#BooleanOptional", "traits": { @@ -5979,11 +5986,10 @@ "smithy.api#required": {} } }, - "DbUser": { - "target": "com.amazonaws.redshift#String", + "DbGroups": { + "target": "com.amazonaws.redshift#DbGroupList", "traits": { - "smithy.api#documentation": "

    The name of a database user. If a user name matching DbUser exists in\n the database, the temporary user credentials have the same permissions as the existing\n user. If DbUser doesn't exist in the database and Autocreate\n is True, a new user is created using the value for DbUser with\n PUBLIC permissions. If a database user matching the value for DbUser\n doesn't exist and Autocreate is False, then the command\n succeeds but the connection attempt will fail because the user doesn't exist in the\n database.

    \n

    For more information, see CREATE USER in the Amazon\n Redshift Database Developer Guide.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be\n PUBLIC.

      \n
      • \n
    • \n

      Must contain only lowercase letters, numbers, underscore, plus sign, period\n (dot), at symbol (@), or hyphen.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Must not contain a colon ( : ) or slash ( / ).

      \n
      • \n
    • \n

      Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon\n Redshift Database Developer Guide.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of the names of existing database groups that the user named in\n DbUser will join for the current session, in addition to any group\n memberships for an existing user. If not specified, a new user is added only to\n PUBLIC.

    \n

    Database group name constraints

    \n
      \n
    • \n

      Must be 1 to 64 alphanumeric characters or hyphens

      \n
      • \n
    • \n

      Must contain only lowercase letters, numbers, underscore, plus sign, period\n (dot), at symbol (@), or hyphen.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Must not contain a colon ( : ) or slash ( / ).

      \n
      • \n
    • \n

      Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon\n Redshift Database Developer Guide.

      \n
      • \n
    " } } }, @@ -6032,17 +6038,17 @@ "smithy.api#documentation": "

    An integer setting the maximum number of ReservedNodeOfferings to\n retrieve.

    " } }, - "Marker": { + "ReservedNodeId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A value that indicates the starting point for the next set of\n ReservedNodeOfferings.

    " + "smithy.api#documentation": "

    A string representing the node identifier for the DC1 Reserved Node to be\n exchanged.

    ", + "smithy.api#required": {} } }, - "ReservedNodeId": { + "Marker": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A string representing the node identifier for the DC1 Reserved Node to be\n exchanged.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of\n ReservedNodeOfferings.

    " } } }, @@ -6053,17 +6059,17 @@ "com.amazonaws.redshift#GetReservedNodeExchangeOfferingsOutputMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point for returning a set of\n response records. When the results of a GetReservedNodeExchangeOfferings\n request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the\n marker field of the response. You can retrieve the next set of response records by\n providing the returned marker value in the marker parameter and retrying the request.\n

    " - } - }, "ReservedNodeOfferings": { "target": "com.amazonaws.redshift#ReservedNodeOfferingList", "traits": { "smithy.api#documentation": "

    Returns an array of ReservedNodeOffering objects.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    An optional parameter that specifies the starting point for returning a set of\n response records. When the results of a GetReservedNodeExchangeOfferings\n request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the\n marker field of the response. You can retrieve the next set of response records by\n providing the returned marker value in the marker parameter and retrying the request.\n

    " + } } } }, @@ -6118,17 +6124,17 @@ "com.amazonaws.redshift#HsmClientCertificateMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " - } - }, "HsmClientCertificates": { "target": "com.amazonaws.redshift#HsmClientCertificateList", "traits": { "smithy.api#documentation": "

    A list of the identifiers for one or more HSM client certificates used by Amazon Redshift\n clusters to store and retrieve database encryption keys in an HSM.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " + } } }, "traits": { @@ -6170,16 +6176,10 @@ "smithy.api#documentation": "

    A text description of the HSM configuration.

    " } }, - "Tags": { - "target": "com.amazonaws.redshift#TagList", - "traits": { - "smithy.api#documentation": "

    The list of tags for the HSM configuration.

    " - } - }, - "HsmPartitionName": { + "HsmIpAddress": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the partition in the HSM where the Amazon Redshift clusters will store their\n database encryption keys.

    " + "smithy.api#documentation": "

    The IP address that the Amazon Redshift cluster must use to access the HSM.

    " } }, "HsmConfigurationIdentifier": { @@ -6188,10 +6188,16 @@ "smithy.api#documentation": "

    The name of the Amazon Redshift HSM configuration.

    " } }, - "HsmIpAddress": { + "Tags": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

    The list of tags for the HSM configuration.

    " + } + }, + "HsmPartitionName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The IP address that the Amazon Redshift cluster must use to access the HSM.

    " + "smithy.api#documentation": "

    The name of the partition in the HSM where the Amazon Redshift clusters will store their\n database encryption keys.

    " } } }, @@ -6270,16 +6276,16 @@ "com.amazonaws.redshift#HsmStatus": { "type": "structure", "members": { - "Status": { + "HsmClientCertificateIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Reports whether the Amazon Redshift cluster has finished applying any HSM settings\n changes specified in a modify cluster command.

    \n

    Values: active, applying

    " + "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " } }, - "HsmClientCertificateIdentifier": { + "Status": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " + "smithy.api#documentation": "

    Reports whether the Amazon Redshift cluster has finished applying any HSM settings\n changes specified in a modify cluster command.

    \n

    Values: active, applying

    " } }, "HsmConfigurationIdentifier": { @@ -6757,18 +6763,6 @@ "com.amazonaws.redshift#LoggingStatus": { "type": "structure", "members": { - "S3KeyPrefix": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The prefix applied to the log file names.

    " - } - }, - "LastFailureMessage": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The message indicating that logs failed to be delivered.

    " - } - }, "LoggingEnabled": { "target": "com.amazonaws.redshift#Boolean", "traits": { @@ -6781,16 +6775,28 @@ "smithy.api#documentation": "

    The last time when logs failed to be delivered.

    " } }, + "LastSuccessfulDeliveryTime": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "

    The last time that logs were delivered.

    " + } + }, "BucketName": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The name of the S3 bucket where the log files are stored.

    " } }, - "LastSuccessfulDeliveryTime": { - "target": "com.amazonaws.redshift#TStamp", + "LastFailureMessage": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The last time that logs were delivered.

    " + "smithy.api#documentation": "

    The message indicating that logs failed to be delivered.

    " + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The prefix applied to the log file names.

    " } } }, @@ -6810,18 +6816,18 @@ "com.amazonaws.redshift#MaintenanceTrack": { "type": "structure", "members": { - "MaintenanceTrackName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the maintenance track. Possible values are current and\n trailing.

    " - } - }, "UpdateTargets": { "target": "com.amazonaws.redshift#EligibleTracksToUpdateList", "traits": { "smithy.api#documentation": "

    An array of UpdateTarget objects to update with the maintenance\n track.

    " } }, + "MaintenanceTrackName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the maintenance track. Possible values are current and\n trailing.

    " + } + }, "DatabaseVersion": { "target": "com.amazonaws.redshift#String", "traits": { @@ -6999,16 +7005,16 @@ "smithy.api#required": {} } }, - "AddIamRoles": { + "RemoveIamRoles": { "target": "com.amazonaws.redshift#IamRoleArnList", "traits": { - "smithy.api#documentation": "

    Zero or more IAM roles to associate with the cluster. The roles must be in their\n Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single\n cluster in a single request.

    " + "smithy.api#documentation": "

    Zero or more IAM roles in ARN format to disassociate from the cluster. You can\n disassociate up to 10 IAM roles from a single cluster in a single request.

    " } }, - "RemoveIamRoles": { + "AddIamRoles": { "target": "com.amazonaws.redshift#IamRoleArnList", "traits": { - "smithy.api#documentation": "

    Zero or more IAM roles in ARN format to disassociate from the cluster. You can\n disassociate up to 10 IAM roles from a single cluster in a single request.

    " + "smithy.api#documentation": "

    Zero or more IAM roles to associate with the cluster. The roles must be in their\n Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single\n cluster in a single request.

    " } } }, @@ -7047,10 +7053,10 @@ "com.amazonaws.redshift#ModifyClusterMaintenanceMessage": { "type": "structure", "members": { - "DeferMaintenanceEndTime": { - "target": "com.amazonaws.redshift#TStamp", + "DeferMaintenance": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A timestamp indicating end time for the deferred maintenance window. If you specify an\n end time, you can't specify a duration.

    " + "smithy.api#documentation": "

    A boolean indicating whether to enable the deferred maintenance window.

    " } }, "DeferMaintenanceStartTime": { @@ -7059,10 +7065,10 @@ "smithy.api#documentation": "

    A timestamp indicating the start time for the deferred maintenance window.

    " } }, - "DeferMaintenance": { - "target": "com.amazonaws.redshift#BooleanOptional", + "DeferMaintenanceDuration": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A boolean indicating whether to enable the deferred maintenance window.

    " + "smithy.api#documentation": "

    An integer indicating the duration of the maintenance window in days. If you specify a\n duration, you can't specify an end time. The duration must be 45 days or less.

    " } }, "ClusterIdentifier": { @@ -7072,10 +7078,10 @@ "smithy.api#required": {} } }, - "DeferMaintenanceDuration": { - "target": "com.amazonaws.redshift#IntegerOptional", + "DeferMaintenanceEndTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    An integer indicating the duration of the maintenance window in days. If you specify a\n duration, you can't specify an end time. The duration must be 45 days or less.

    " + "smithy.api#documentation": "

    A timestamp indicating end time for the deferred maintenance window. If you specify an\n end time, you can't specify a duration.

    " } }, "DeferMaintenanceIdentifier": { @@ -7097,40 +7103,40 @@ "com.amazonaws.redshift#ModifyClusterMessage": { "type": "structure", "members": { - "KmsKeyId": { + "NodeType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use\n to encrypt data in the cluster.

    " + "smithy.api#documentation": "

    The new node type of the cluster. If you specify a new node type, you must also\n specify the number of nodes parameter.

    \n

    \nFor more information about resizing clusters, go to \nResizing Clusters in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.

    \n \n

    Valid Values: ds2.xlarge | ds2.8xlarge |\n dc1.large | dc1.8xlarge | \n dc2.large | dc2.8xlarge | \n ra3.4xlarge | ra3.16xlarge \n

    " } }, - "Encrypted": { + "AllowVersionUpgrade": { "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Indicates whether the cluster is encrypted. If the value is encrypted (true) and you\n provide a value for the KmsKeyId parameter, we encrypt the cluster\n with the provided KmsKeyId. If you don't provide a KmsKeyId,\n we encrypt with the default key. In the China region we use legacy encryption\n if you specify that the cluster is encrypted.

    \n

    If the value is not encrypted (false), then the cluster is decrypted.

    " + "smithy.api#documentation": "

    If true, major version upgrades will be applied automatically to the\n cluster during the maintenance window.

    \n

    Default: false\n

    " } }, - "HsmClientCertificateIdentifier": { + "MasterUserPassword": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " + "smithy.api#documentation": "

    The new password for the cluster master user. This change is asynchronously applied\n as soon as possible. Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

    \n \n

    Operations never return the password, so this operation provides a way to\n regain access to the master user account for a cluster if the password is\n lost.

    \n     \n

    Default: Uses existing setting.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be between 8 and 64 characters in length.

      \n
      • \n
    • \n

      Must contain at least one uppercase letter.

      \n
      • \n
    • \n

      Must contain at least one lowercase letter.

      \n
      • \n
    • \n

      Must contain one number.

      \n
      • \n
    • \n

      Can be any printable ASCII character (ASCII code 33 to 126) except '\n (single quote), \" (double quote), \\, /, @, or space.

      \n
      • \n
    " } }, - "AutomatedSnapshotRetentionPeriod": { + "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The number of days that automated snapshots are retained. If the value is 0,\n automated snapshots are disabled. Even if automated snapshots are disabled, you can\n still create manual snapshots when you want with CreateClusterSnapshot.

    \n

    If you decrease the automated snapshot retention period from its current value,\n existing automated snapshots that fall outside of the new retention period will be\n immediately deleted.

    \n

    Default: Uses existing setting.

    \n

    Constraints: Must be a value from 0 to 35.

    " + "smithy.api#documentation": "

    The default for number of days that a newly created manual snapshot is retained. If\n the value is -1, the manual snapshot is retained indefinitely. This value doesn't\n retroactively change the retention periods of existing manual snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    \n

    The default value is -1.

    " } }, - "ClusterVersion": { + "MaintenanceTrackName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The new version number of the Amazon Redshift engine to upgrade to.

    \n

    For major version upgrades, if a non-default cluster parameter group is currently\n in use, a new cluster parameter group in the cluster parameter group family for the new\n version must be specified. The new cluster parameter group can be the default for that\n cluster parameter group family. \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    \n

    Example: 1.0\n

    " + "smithy.api#documentation": "

    The name for the maintenance track that you want to assign for the cluster. This name\n change is asynchronous. The new track name stays in the\n PendingModifiedValues for the cluster until the next maintenance\n window. When the maintenance track changes, the cluster is switched to the latest\n cluster release available for the maintenance track. At this point, the maintenance\n track name is applied.

    " } }, - "NewClusterIdentifier": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The new identifier for the cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Alphabetic characters must be lowercase.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    • \n

      Must be unique for all clusters within an AWS account.

      \n
      • \n
    \n\n

    Example: examplecluster\n

    " + "smithy.api#documentation": "

    The weekly time range (in UTC) during which system maintenance can occur, if\n necessary. If system maintenance is necessary during the window, it may result in an\n outage.

    \n

    This maintenance window change is made immediately. If the new maintenance window\n indicates the current time, there must be at least 120 minutes between the current time\n and end of the window in order to ensure that pending changes are applied.

    \n

    Default: Uses existing setting.

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi, for example\n wed:07:30-wed:08:00.

    \n

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    \n

    Constraints: Must be at least 30 minutes.

    " } }, "NumberOfNodes": { @@ -7139,70 +7145,71 @@ "smithy.api#documentation": "

    The new number of nodes of the cluster. If you specify a new number of nodes, you\n must also specify the node type parameter.

    \n

    \nFor more information about resizing clusters, go to \nResizing Clusters in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.

    \n \n

    Valid Values: Integer greater than 0.

    " } }, - "ElasticIp": { - "target": "com.amazonaws.redshift#String", + "PubliclyAccessible": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The Elastic IP (EIP) address for the cluster.

    \n

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible\n through an Internet gateway. For more information about provisioning clusters in\n EC2-VPC, go to Supported\n Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    " + "smithy.api#documentation": "

    If true, the cluster can be accessed from a public network. Only\n clusters in VPCs can be set to be publicly available.

    " } }, - "MaintenanceTrackName": { - "target": "com.amazonaws.redshift#String", + "Encrypted": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The name for the maintenance track that you want to assign for the cluster. This name\n change is asynchronous. The new track name stays in the\n PendingModifiedValues for the cluster until the next maintenance\n window. When the maintenance track changes, the cluster is switched to the latest\n cluster release available for the maintenance track. At this point, the maintenance\n track name is applied.

    " + "smithy.api#documentation": "

    Indicates whether the cluster is encrypted. If the value is encrypted (true) and you\n provide a value for the KmsKeyId parameter, we encrypt the cluster\n with the provided KmsKeyId. If you don't provide a KmsKeyId,\n we encrypt with the default key.

    \n

    If the value is not encrypted (false), then the cluster is decrypted.

    " } }, - "PubliclyAccessible": { - "target": "com.amazonaws.redshift#BooleanOptional", + "HsmClientCertificateIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    If true, the cluster can be accessed from a public network. Only\n clusters in VPCs can be set to be publicly available.

    " + "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " } }, - "MasterUserPassword": { + "ElasticIp": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The new password for the cluster master user. This change is asynchronously applied\n as soon as possible. Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

    \n \n

    Operations never return the password, so this operation provides a way to\n regain access to the master user account for a cluster if the password is\n lost.

    \n     \n

    Default: Uses existing setting.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be between 8 and 64 characters in length.

      \n
      • \n
    • \n

      Must contain at least one uppercase letter.

      \n
      • \n
    • \n

      Must contain at least one lowercase letter.

      \n
      • \n
    • \n

      Must contain one number.

      \n
      • \n
    • \n

      Can be any printable ASCII character (ASCII code 33 to 126) except '\n (single quote), \" (double quote), \\, /, @, or space.

      \n
      • \n
    " + "smithy.api#documentation": "

    The Elastic IP (EIP) address for the cluster.

    \n

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible\n through an Internet gateway. For more information about provisioning clusters in\n EC2-VPC, go to Supported\n Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    " } }, - "AllowVersionUpgrade": { - "target": "com.amazonaws.redshift#BooleanOptional", + "NewClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    If true, major version upgrades will be applied automatically to the\n cluster during the maintenance window.

    \n

    Default: false\n

    " + "smithy.api#documentation": "

    The new identifier for the cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain from 1 to 63 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      Alphabetic characters must be lowercase.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    • \n

      Must be unique for all clusters within an AWS account.

      \n
      • \n
    \n\n

    Example: examplecluster\n

    " } }, - "ManualSnapshotRetentionPeriod": { + "AutomatedSnapshotRetentionPeriod": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The default for number of days that a newly created manual snapshot is retained. If\n the value is -1, the manual snapshot is retained indefinitely. This value doesn't\n retroactively change the retention periods of existing manual snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    \n

    The default value is -1.

    " + "smithy.api#documentation": "

    The number of days that automated snapshots are retained. If the value is 0,\n automated snapshots are disabled. Even if automated snapshots are disabled, you can\n still create manual snapshots when you want with CreateClusterSnapshot.

    \n

    If you decrease the automated snapshot retention period from its current value,\n existing automated snapshots that fall outside of the new retention period will be\n immediately deleted.

    \n

    Default: Uses existing setting.

    \n

    Constraints: Must be a value from 0 to 35.

    " } }, - "NodeType": { - "target": "com.amazonaws.redshift#String", + "EnhancedVpcRouting": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The new node type of the cluster. If you specify a new node type, you must also\n specify the number of nodes parameter.

    \n

    \nFor more information about resizing clusters, go to \nResizing Clusters in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.

    \n \n

    Valid Values: ds2.xlarge | ds2.8xlarge |\n dc1.large | dc1.8xlarge | \n dc2.large | dc2.8xlarge | \n ra3.4xlarge | ra3.16xlarge \n

    " + "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.redshift#VpcSecurityGroupIdList", + "ClusterSecurityGroups": { + "target": "com.amazonaws.redshift#ClusterSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

    A list of virtual private cloud (VPC) security groups to be associated with the\n cluster. This change is asynchronously applied as soon as possible.

    " + "smithy.api#documentation": "

    A list of cluster security groups to be authorized on this cluster. This change is\n asynchronously applied as soon as possible.

    \n

    Security groups currently associated with the cluster, and not in the list of\n groups to apply, will be revoked from the cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 alphanumeric characters or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    " } }, - "PreferredMaintenanceWindow": { + "ClusterType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The weekly time range (in UTC) during which system maintenance can occur, if\n necessary. If system maintenance is necessary during the window, it may result in an\n outage.

    \n

    This maintenance window change is made immediately. If the new maintenance window\n indicates the current time, there must be at least 120 minutes between the current time\n and end of the window in order to ensure that pending changes are applied.

    \n

    Default: Uses existing setting.

    \n

    Format: ddd:hh24:mi-ddd:hh24:mi, for example\n wed:07:30-wed:08:00.

    \n

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    \n

    Constraints: Must be at least 30 minutes.

    " + "smithy.api#documentation": "

    The new cluster type.

    \n

    When you submit your cluster resize request, your existing cluster goes into a\n read-only mode. After Amazon Redshift provisions a new cluster based on your resize\n requirements, there will be outage for a period while the old cluster is deleted and\n your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

    \n

    Valid Values: multi-node | single-node \n

    " } }, - "ClusterSecurityGroups": { - "target": "com.amazonaws.redshift#ClusterSecurityGroupNameList", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of cluster security groups to be authorized on this cluster. This change is\n asynchronously applied as soon as possible.

    \n

    Security groups currently associated with the cluster, and not in the list of\n groups to apply, will be revoked from the cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 alphanumeric characters or hyphens

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens

      \n
      • \n
    " + "smithy.api#documentation": "

    The unique identifier of the cluster to be modified.

    \n

    Example: examplecluster\n

    ", + "smithy.api#required": {} } }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.redshift#BooleanOptional", + "ClusterParameterGroupName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " + "smithy.api#documentation": "

    The name of the cluster parameter group to apply to this cluster. This change is\n applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

    \n

    Default: Uses existing setting.

    \n

    Constraints: The cluster parameter group must be in the same parameter group family\n that matches the cluster version.

    " } }, "HsmConfigurationIdentifier": { @@ -7211,23 +7218,22 @@ "smithy.api#documentation": "

    Specifies the name of the HSM configuration that contains the information the\n Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    " } }, - "ClusterType": { + "KmsKeyId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The new cluster type.

    \n

    When you submit your cluster resize request, your existing cluster goes into a\n read-only mode. After Amazon Redshift provisions a new cluster based on your resize\n requirements, there will be outage for a period while the old cluster is deleted and\n your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

    \n

    Valid Values: multi-node | single-node \n

    " + "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use\n to encrypt data in the cluster.

    " } }, - "ClusterParameterGroupName": { + "ClusterVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the cluster parameter group to apply to this cluster. This change is\n applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

    \n

    Default: Uses existing setting.

    \n

    Constraints: The cluster parameter group must be in the same parameter group family\n that matches the cluster version.

    " + "smithy.api#documentation": "

    The new version number of the Amazon Redshift engine to upgrade to.

    \n

    For major version upgrades, if a non-default cluster parameter group is currently\n in use, a new cluster parameter group in the cluster parameter group family for the new\n version must be specified. The new cluster parameter group can be the default for that\n cluster parameter group family. \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    \n

    Example: 1.0\n

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.redshift#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

    The unique identifier of the cluster to be modified.

    \n

    Example: examplecluster\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of virtual private cloud (VPC) security groups to be associated with the\n cluster. This change is asynchronously applied as soon as possible.

    " } } }, @@ -7274,7 +7280,7 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    Describes a modify cluster parameter group operation.

    " } }, "com.amazonaws.redshift#ModifyClusterResult": { @@ -7369,18 +7375,18 @@ "smithy.api#documentation": "

    A boolean to indicate whether to remove the assoiciation between the cluster and the\n schedule.

    " } }, - "ClusterIdentifier": { + "ScheduleIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A unique identifier for the cluster whose snapshot schedule you want to modify.\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A unique alphanumeric identifier for the schedule that you want to associate with the\n cluster.

    " } }, - "ScheduleIdentifier": { + "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A unique alphanumeric identifier for the schedule that you want to associate with the\n cluster.

    " - } + "smithy.api#documentation": "

    A unique identifier for the cluster whose snapshot schedule you want to modify.\n

    ", + "smithy.api#required": {} + } } } }, @@ -7419,6 +7425,13 @@ "com.amazonaws.redshift#ModifyClusterSubnetGroupMessage": { "type": "structure", "members": { + "SubnetIds": { + "target": "com.amazonaws.redshift#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

    An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single\n request.

    ", + "smithy.api#required": {} + } + }, "ClusterSubnetGroupName": { "target": "com.amazonaws.redshift#String", "traits": { @@ -7431,13 +7444,6 @@ "traits": { "smithy.api#documentation": "

    A text description of the subnet group to be modified.

    " } - }, - "SubnetIds": { - "target": "com.amazonaws.redshift#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

    An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single\n request.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -7496,24 +7502,12 @@ "com.amazonaws.redshift#ModifyEventSubscriptionMessage": { "type": "structure", "members": { - "Severity": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    Specifies the Amazon Redshift event severity to be published by the event notification\n subscription.

    \n

    Values: ERROR, INFO

    " - } - }, "SourceIds": { "target": "com.amazonaws.redshift#SourceIdsList", "traits": { "smithy.api#documentation": "

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects\n must be of the same type as was specified in the source type parameter. The event\n subscription will return only events generated by the specified objects. If not\n specified, then events are returned for all objects within the source type\n specified.

    \n

    Example: my-cluster-1, my-cluster-2

    \n

    Example: my-snapshot-20131010

    " } }, - "Enabled": { - "target": "com.amazonaws.redshift#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    A Boolean value indicating if the subscription is enabled. true\n indicates the subscription is enabled

    " - } - }, "SubscriptionName": { "target": "com.amazonaws.redshift#String", "traits": { @@ -7521,10 +7515,16 @@ "smithy.api#required": {} } }, - "SourceType": { + "Severity": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The type of source that will be generating the events. For example, if you want to\n be notified of events generated by a cluster, you would set this parameter to cluster.\n If this value is not specified, events are returned for all Amazon Redshift objects in your\n AWS account. You must specify a source type in order to specify source IDs.

    \n

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    " + "smithy.api#documentation": "

    Specifies the Amazon Redshift event severity to be published by the event notification\n subscription.

    \n

    Values: ERROR, INFO

    " + } + }, + "EventCategories": { + "target": "com.amazonaws.redshift#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

    Specifies the Amazon Redshift event categories to be published by the event notification\n subscription.

    \n

    Values: configuration, management, monitoring, security

    " } }, "SnsTopicArn": { @@ -7533,10 +7533,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SNS topic to be used by the event\n notification subscription.

    " } }, - "EventCategories": { - "target": "com.amazonaws.redshift#EventCategoriesList", + "SourceType": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Specifies the Amazon Redshift event categories to be published by the event notification\n subscription.

    \n

    Values: configuration, management, monitoring, security

    " + "smithy.api#documentation": "

    The type of source that will be generating the events. For example, if you want to\n be notified of events generated by a cluster, you would set this parameter to cluster.\n If this value is not specified, events are returned for all Amazon Redshift objects in your\n AWS account. You must specify a source type in order to specify source IDs.

    \n

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    " + } + }, + "Enabled": { + "target": "com.amazonaws.redshift#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    A Boolean value indicating if the subscription is enabled. true\n indicates the subscription is enabled

    " } } }, @@ -7590,28 +7596,28 @@ "smithy.api#documentation": "

    A modified JSON format of the scheduled action. \n For more information about this parameter, see ScheduledAction.

    " } }, - "EndTime": { - "target": "com.amazonaws.redshift#TStamp", + "Schedule": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A modified end time of the scheduled action. \n For more information about this parameter, see ScheduledAction.

    " + "smithy.api#documentation": "

    A modified schedule in either at( ) or cron( ) format. \n For more information about this parameter, see ScheduledAction.

    " } }, - "Enable": { - "target": "com.amazonaws.redshift#BooleanOptional", + "ScheduledActionDescription": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

    " + "smithy.api#documentation": "

    A modified description of the scheduled action.

    " } }, - "IamRole": { - "target": "com.amazonaws.redshift#String", + "StartTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    A different IAM role to assume to run the target action. \n For more information about this parameter, see ScheduledAction.

    " + "smithy.api#documentation": "

    A modified start time of the scheduled action. \n For more information about this parameter, see ScheduledAction.

    " } }, - "ScheduledActionDescription": { - "target": "com.amazonaws.redshift#String", + "EndTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    A modified description of the scheduled action.

    " + "smithy.api#documentation": "

    A modified end time of the scheduled action. \n For more information about this parameter, see ScheduledAction.

    " } }, "ScheduledActionName": { @@ -7621,16 +7627,16 @@ "smithy.api#required": {} } }, - "Schedule": { + "IamRole": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A modified schedule in either at( ) or cron( ) format. \n For more information about this parameter, see ScheduledAction.

    " + "smithy.api#documentation": "

    A different IAM role to assume to run the target action. \n For more information about this parameter, see ScheduledAction.

    " } }, - "StartTime": { - "target": "com.amazonaws.redshift#TStamp", + "Enable": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A modified start time of the scheduled action. \n For more information about this parameter, see ScheduledAction.

    " + "smithy.api#documentation": "

    A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

    " } } } @@ -7667,13 +7673,6 @@ "com.amazonaws.redshift#ModifySnapshotCopyRetentionPeriodMessage": { "type": "structure", "members": { - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The unique identifier of the cluster for which you want to change the retention\n period for either automated or manual snapshots that are copied to a destination AWS\n Region.

    \n

    Constraints: Must be the valid name of an existing cluster that has cross-region\n snapshot copy enabled.

    ", - "smithy.api#required": {} - } - }, "RetentionPeriod": { "target": "com.amazonaws.redshift#Integer", "traits": { @@ -7686,6 +7685,13 @@ "traits": { "smithy.api#documentation": "

    Indicates whether to apply the snapshot retention period to newly copied manual\n snapshots instead of automated snapshots.

    " } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The unique identifier of the cluster for which you want to change the retention\n period for either automated or manual snapshots that are copied to a destination AWS\n Region.

    \n

    Constraints: Must be the valid name of an existing cluster that has cross-region\n snapshot copy enabled.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -7726,17 +7732,17 @@ "com.amazonaws.redshift#ModifySnapshotScheduleMessage": { "type": "structure", "members": { - "ScheduleIdentifier": { - "target": "com.amazonaws.redshift#String", + "ScheduleDefinitions": { + "target": "com.amazonaws.redshift#ScheduleDefinitionList", "traits": { - "smithy.api#documentation": "

    A unique alphanumeric identifier of the schedule to modify.

    ", + "smithy.api#documentation": "

    An updated list of schedule definitions. A schedule definition is made up of schedule\n expressions, for example, \"cron(30 12 *)\" or \"rate(12 hours)\".

    ", "smithy.api#required": {} } }, - "ScheduleDefinitions": { - "target": "com.amazonaws.redshift#ScheduleDefinitionList", + "ScheduleIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An updated list of schedule definitions. A schedule definition is made up of schedule\n expressions, for example, \"cron(30 12 *)\" or \"rate(12 hours)\".

    ", + "smithy.api#documentation": "

    A unique alphanumeric identifier of the schedule to modify.

    ", "smithy.api#required": {} } } @@ -7768,6 +7774,12 @@ "com.amazonaws.redshift#ModifyUsageLimitMessage": { "type": "structure", "members": { + "BreachAction": { + "target": "com.amazonaws.redshift#UsageLimitBreachAction", + "traits": { + "smithy.api#documentation": "

    The new action that Amazon Redshift takes when the limit is reached. \n For more information about this parameter, see UsageLimit.

    " + } + }, "UsageLimitId": { "target": "com.amazonaws.redshift#String", "traits": { @@ -7780,12 +7792,6 @@ "traits": { "smithy.api#documentation": "

    The new limit amount. \n For more information about this parameter, see UsageLimit.

    " } - }, - "BreachAction": { - "target": "com.amazonaws.redshift#UsageLimitBreachAction", - "traits": { - "smithy.api#documentation": "

    The new action that Amazon Redshift takes when the limit is reached. \n For more information about this parameter, see UsageLimit.

    " - } } } }, @@ -7798,18 +7804,18 @@ "smithy.api#documentation": "

    The estimated disk utilizaton percentage.

    " } }, - "Mode": { - "target": "com.amazonaws.redshift#Mode", - "traits": { - "smithy.api#documentation": "

    The category of the node configuration recommendation.

    " - } - }, "NodeType": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The node type, such as, \"ds2.8xlarge\".

    " } }, + "Mode": { + "target": "com.amazonaws.redshift#Mode", + "traits": { + "smithy.api#documentation": "

    The category of the node configuration recommendation.

    " + } + }, "NumberOfNodes": { "target": "com.amazonaws.redshift#Integer", "traits": { @@ -7833,6 +7839,12 @@ "com.amazonaws.redshift#NodeConfigurationOptionsFilter": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.redshift#NodeConfigurationOptionsFilterName", + "traits": { + "smithy.api#documentation": "

    The name of the element to filter.

    " + } + }, "Values": { "target": "com.amazonaws.redshift#ValueStringList", "traits": { @@ -7845,12 +7857,6 @@ "traits": { "smithy.api#documentation": "

    The filter operator.\n If filter Name is NodeType only the 'in' operator is supported.\n Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. \n Provide two values to evaluate for 'between'.\n Provide a list of values for 'in'.

    " } - }, - "Name": { - "target": "com.amazonaws.redshift#NodeConfigurationOptionsFilterName", - "traits": { - "smithy.api#documentation": "

    The name of the element to filter.

    " - } } }, "traits": { @@ -7892,17 +7898,17 @@ "com.amazonaws.redshift#NodeConfigurationOptionsMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " - } - }, "NodeConfigurationOptionList": { "target": "com.amazonaws.redshift#NodeConfigurationOptionList", "traits": { "smithy.api#documentation": "

    A list of valid node configurations.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " + } } } }, @@ -7976,10 +7982,10 @@ "smithy.api#documentation": "

    The cluster type, for example multi-node.

    " } }, - "NodeType": { + "ClusterVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The node type for the orderable cluster.

    " + "smithy.api#documentation": "

    The version of the orderable cluster.

    " } }, "AvailabilityZones": { @@ -7988,10 +7994,10 @@ "smithy.api#documentation": "

    A list of availability zones for the orderable cluster.

    " } }, - "ClusterVersion": { + "NodeType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The version of the orderable cluster.

    " + "smithy.api#documentation": "

    The node type for the orderable cluster.

    " } } }, @@ -8031,34 +8037,34 @@ "com.amazonaws.redshift#Parameter": { "type": "structure", "members": { - "DataType": { + "Source": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The data type of the parameter.

    " + "smithy.api#documentation": "

    The source of the parameter value, such as \"engine-default\" or \"user\".

    " } }, - "AllowedValues": { + "ParameterName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The valid range of values for the parameter.

    " + "smithy.api#documentation": "

    The name of the parameter.

    " } }, - "Source": { + "DataType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The source of the parameter value, such as \"engine-default\" or \"user\".

    " + "smithy.api#documentation": "

    The data type of the parameter.

    " } }, - "ParameterName": { + "MinimumEngineVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the parameter.

    " + "smithy.api#documentation": "

    The earliest engine version to which the parameter can apply.

    " } }, - "ApplyType": { - "target": "com.amazonaws.redshift#ParameterApplyType", + "AllowedValues": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    Specifies how to apply the WLM configuration parameter. Some properties can be\n applied dynamically, while other properties require that any associated clusters be\n rebooted for the configuration changes to be applied. \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    " + "smithy.api#documentation": "

    The valid range of values for the parameter.

    " } }, "ParameterValue": { @@ -8067,22 +8073,22 @@ "smithy.api#documentation": "

    The value of the parameter.

    " } }, - "IsModifiable": { - "target": "com.amazonaws.redshift#Boolean", - "traits": { - "smithy.api#documentation": "

    If true, the parameter can be modified. Some parameters have security\n or operational implications that prevent them from being changed.

    " - } - }, "Description": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    A description of the parameter.

    " } }, - "MinimumEngineVersion": { - "target": "com.amazonaws.redshift#String", + "ApplyType": { + "target": "com.amazonaws.redshift#ParameterApplyType", "traits": { - "smithy.api#documentation": "

    The earliest engine version to which the parameter can apply.

    " + "smithy.api#documentation": "

    Specifies how to apply the WLM configuration parameter. Some properties can be\n applied dynamically, while other properties require that any associated clusters be\n rebooted for the configuration changes to be applied. \nFor more information about parameters and parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Cluster Management Guide.

    " + } + }, + "IsModifiable": { + "target": "com.amazonaws.redshift#Boolean", + "traits": { + "smithy.api#documentation": "

    If true, the parameter can be modified. Some parameters have security\n or operational implications that prevent them from being changed.

    " } } }, @@ -8151,6 +8157,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

    Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster API operation.

    " } }, "com.amazonaws.redshift#PauseClusterResult": { @@ -8170,10 +8179,10 @@ "com.amazonaws.redshift#PendingModifiedValues": { "type": "structure", "members": { - "ClusterVersion": { + "ClusterType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The pending or in-progress change of the service version.

    " + "smithy.api#documentation": "

    The pending or in-progress change of the cluster type.

    " } }, "PubliclyAccessible": { @@ -8182,22 +8191,28 @@ "smithy.api#documentation": "

    The pending or in-progress change of the ability to connect to the cluster from the\n public network.

    " } }, - "ClusterIdentifier": { + "ClusterVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The pending or in-progress change of the new identifier for the cluster.

    " + "smithy.api#documentation": "

    The pending or in-progress change of the service version.

    " } }, - "NumberOfNodes": { - "target": "com.amazonaws.redshift#IntegerOptional", + "MasterUserPassword": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The pending or in-progress change of the number of nodes in the cluster.

    " + "smithy.api#documentation": "

    The pending or in-progress change of the master user password for the\n cluster.

    " } }, - "ClusterType": { + "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The pending or in-progress change of the cluster type.

    " + "smithy.api#documentation": "

    The pending or in-progress change of the new identifier for the cluster.

    " + } + }, + "EncryptionType": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The encryption type for a cluster. Possible values are: KMS and None.

    " } }, "MaintenanceTrackName": { @@ -8206,16 +8221,16 @@ "smithy.api#documentation": "

    The name of the maintenance track that the cluster will change to during the next\n maintenance window.

    " } }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.redshift#BooleanOptional", + "NodeType": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " + "smithy.api#documentation": "

    The pending or in-progress change of the cluster's node type.

    " } }, - "MasterUserPassword": { - "target": "com.amazonaws.redshift#String", + "EnhancedVpcRouting": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The pending or in-progress change of the master user password for the\n cluster.

    " + "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " } }, "AutomatedSnapshotRetentionPeriod": { @@ -8224,16 +8239,10 @@ "smithy.api#documentation": "

    The pending or in-progress change of the automated snapshot retention\n period.

    " } }, - "EncryptionType": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The encryption type for a cluster. Possible values are: KMS and None. For the China\n region the possible values are None, and Legacy.

    " - } - }, - "NodeType": { - "target": "com.amazonaws.redshift#String", + "NumberOfNodes": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The pending or in-progress change of the cluster's node type.

    " + "smithy.api#documentation": "

    The pending or in-progress change of the number of nodes in the cluster.

    " } } }, @@ -8270,18 +8279,18 @@ "com.amazonaws.redshift#PurchaseReservedNodeOfferingMessage": { "type": "structure", "members": { - "ReservedNodeOfferingId": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The unique identifier of the reserved node offering you want to purchase.

    ", - "smithy.api#required": {} - } - }, "NodeCount": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { "smithy.api#documentation": "

    The number of reserved nodes that you want to purchase.

    \n

    Default: 1\n

    " } + }, + "ReservedNodeOfferingId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The unique identifier of the reserved node offering you want to purchase.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -8654,7 +8663,7 @@ "sdkId": "Redshift", "arnNamespace": "redshift", "cloudFormationName": "Redshift", - "cloudTrailEventSource": "v20121201.admin.redshift" + "cloudTrailEventSource": "redshift.amazonaws.com" }, "aws.auth#sigv4": { "name": "redshift" @@ -8670,40 +8679,28 @@ "com.amazonaws.redshift#ReservedNode": { "type": "structure", "members": { - "RecurringCharges": { - "target": "com.amazonaws.redshift#RecurringChargeList", - "traits": { - "smithy.api#documentation": "

    The recurring charges for the reserved node.

    " - } - }, - "ReservedNodeOfferingType": { - "target": "com.amazonaws.redshift#ReservedNodeOfferingType", - "traits": { - "smithy.api#documentation": "

    " - } - }, "FixedPrice": { "target": "com.amazonaws.redshift#Double", "traits": { "smithy.api#documentation": "

    The fixed cost Amazon Redshift charges you for this reserved node.

    " } }, - "ReservedNodeOfferingId": { + "State": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier for the reserved node offering.

    " + "smithy.api#documentation": "

    The state of the reserved compute node.

    \n

    Possible Values:

    \n
      \n
    • \n

      pending-payment-This reserved node has recently been purchased, and the\n sale has been approved, but payment has not yet been confirmed.

      \n
      • \n
    • \n

      active-This reserved node is owned by the caller and is available for\n use.

      \n
      • \n
    • \n

      payment-failed-Payment failed for the purchase attempt.

      \n
      • \n
    • \n

      retired-The reserved node is no longer available.

      \n
      • \n
    • \n

      exchanging-The owner is exchanging the reserved node for another reserved\n node.

      \n
      • \n
    " } }, - "StartTime": { - "target": "com.amazonaws.redshift#TStamp", + "CurrencyCode": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The time the reservation started. You purchase a reserved node offering for a\n duration. This is the start time of that duration.

    " + "smithy.api#documentation": "

    The currency code for the reserved cluster.

    " } }, - "State": { + "ReservedNodeOfferingId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The state of the reserved compute node.

    \n

    Possible Values:

    \n
      \n
    • \n

      pending-payment-This reserved node has recently been purchased, and the\n sale has been approved, but payment has not yet been confirmed.

      \n
      • \n
    • \n

      active-This reserved node is owned by the caller and is available for\n use.

      \n
      • \n
    • \n

      payment-failed-Payment failed for the purchase attempt.

      \n
      • \n
    • \n

      retired-The reserved node is no longer available.

      \n
      • \n
    • \n

      exchanging-The owner is exchanging the reserved node for another reserved\n node.

      \n
      • \n
    " + "smithy.api#documentation": "

    The identifier for the reserved node offering.

    " } }, "NodeType": { @@ -8712,16 +8709,22 @@ "smithy.api#documentation": "

    The node type of the reserved node.

    " } }, - "NodeCount": { - "target": "com.amazonaws.redshift#Integer", + "ReservedNodeOfferingType": { + "target": "com.amazonaws.redshift#ReservedNodeOfferingType", "traits": { - "smithy.api#documentation": "

    The number of reserved compute nodes.

    " + "smithy.api#documentation": "

    " } }, - "Duration": { + "RecurringCharges": { + "target": "com.amazonaws.redshift#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

    The recurring charges for the reserved node.

    " + } + }, + "NodeCount": { "target": "com.amazonaws.redshift#Integer", "traits": { - "smithy.api#documentation": "

    The duration of the node reservation in seconds.

    " + "smithy.api#documentation": "

    The number of reserved compute nodes.

    " } }, "OfferingType": { @@ -8730,16 +8733,16 @@ "smithy.api#documentation": "

    The anticipated utilization of the reserved node, as defined in the reserved node\n offering.

    " } }, - "ReservedNodeId": { - "target": "com.amazonaws.redshift#String", + "StartTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The unique identifier for the reservation.

    " + "smithy.api#documentation": "

    The time the reservation started. You purchase a reserved node offering for a\n duration. This is the start time of that duration.

    " } }, - "CurrencyCode": { - "target": "com.amazonaws.redshift#String", + "Duration": { + "target": "com.amazonaws.redshift#Integer", "traits": { - "smithy.api#documentation": "

    The currency code for the reserved cluster.

    " + "smithy.api#documentation": "

    The duration of the node reservation in seconds.

    " } }, "UsagePrice": { @@ -8747,6 +8750,12 @@ "traits": { "smithy.api#documentation": "

    The hourly rate Amazon Redshift charges you for this reserved node.

    " } + }, + "ReservedNodeId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the reservation.

    " + } } }, "traits": { @@ -8810,22 +8819,16 @@ "smithy.api#documentation": "

    " } }, - "CurrencyCode": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The currency code for the compute nodes offering.

    " - } - }, "OfferingType": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The anticipated utilization of the reserved node, as defined in the reserved node\n offering.

    " } }, - "UsagePrice": { - "target": "com.amazonaws.redshift#Double", + "CurrencyCode": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The rate you are charged for each hour the cluster that is using the offering is\n running.

    " + "smithy.api#documentation": "

    The currency code for the compute nodes offering.

    " } }, "NodeType": { @@ -8834,22 +8837,16 @@ "smithy.api#documentation": "

    The node type offered by the reserved node offering.

    " } }, - "RecurringCharges": { - "target": "com.amazonaws.redshift#RecurringChargeList", - "traits": { - "smithy.api#documentation": "

    The charge to your account regardless of whether you are creating any clusters\n using the node offering. Recurring charges are only in effect for heavy-utilization\n reserved nodes.

    " - } - }, "ReservedNodeOfferingId": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    The offering identifier.

    " } }, - "Duration": { - "target": "com.amazonaws.redshift#Integer", + "RecurringCharges": { + "target": "com.amazonaws.redshift#RecurringChargeList", "traits": { - "smithy.api#documentation": "

    The duration, in seconds, for which the offering will reserve the node.

    " + "smithy.api#documentation": "

    The charge to your account regardless of whether you are creating any clusters\n using the node offering. Recurring charges are only in effect for heavy-utilization\n reserved nodes.

    " } }, "FixedPrice": { @@ -8857,6 +8854,18 @@ "traits": { "smithy.api#documentation": "

    The upfront fixed charge you will pay to purchase the specific reserved node\n offering.

    " } + }, + "UsagePrice": { + "target": "com.amazonaws.redshift#Double", + "traits": { + "smithy.api#documentation": "

    The rate you are charged for each hour the cluster that is using the offering is\n running.

    " + } + }, + "Duration": { + "target": "com.amazonaws.redshift#Integer", + "traits": { + "smithy.api#documentation": "

    The duration, in seconds, for which the offering will reserve the node.

    " + } } }, "traits": { @@ -8901,17 +8910,17 @@ "com.amazonaws.redshift#ReservedNodeOfferingsMessage": { "type": "structure", "members": { - "ReservedNodeOfferings": { - "target": "com.amazonaws.redshift#ReservedNodeOfferingList", - "traits": { - "smithy.api#documentation": "

    A list of ReservedNodeOffering objects.

    " - } - }, "Marker": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " } + }, + "ReservedNodeOfferings": { + "target": "com.amazonaws.redshift#ReservedNodeOfferingList", + "traits": { + "smithy.api#documentation": "

    A list of ReservedNodeOffering objects.

    " + } } }, "traits": { @@ -8974,12 +8983,6 @@ "com.amazonaws.redshift#ResetClusterParameterGroupMessage": { "type": "structure", "members": { - "ResetAllParameters": { - "target": "com.amazonaws.redshift#Boolean", - "traits": { - "smithy.api#documentation": "

    If true, all parameters in the specified parameter group will be reset\n to their default values.

    \n

    Default: true\n

    " - } - }, "ParameterGroupName": { "target": "com.amazonaws.redshift#String", "traits": { @@ -8987,6 +8990,12 @@ "smithy.api#required": {} } }, + "ResetAllParameters": { + "target": "com.amazonaws.redshift#Boolean", + "traits": { + "smithy.api#documentation": "

    If true, all parameters in the specified parameter group will be reset\n to their default values.

    \n

    Default: true\n

    " + } + }, "Parameters": { "target": "com.amazonaws.redshift#ParametersList", "traits": { @@ -9036,7 +9045,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Changes the size of the cluster. You can change the cluster's type, or change the\n number or type of nodes. The default behavior is to use the elastic resize method. With\n an elastic resize, your cluster is available for read and write operations more quickly\n than with the classic resize method.

    \n

    Elastic resize operations have the following restrictions:

    \n
      \n
    • \n

      You can only resize clusters of the following types:

      \n
        \n
      • \n

        dc2.large

        \n
        • \n
      • \n

        dc2.8xlarge

        \n
        • \n
      • \n

        ds2.xlarge

        \n
        • \n
      • \n

        ds2.8xlarge

        \n
        • \n
      • \n

        ra3.4xlarge

        \n
        • \n
      • \n

        ra3.16xlarge

        \n
        • \n
      \n
      • \n
    • \n

      The type of nodes that you add must match the node type for the\n cluster.

      \n
      • \n
    " + "smithy.api#documentation": "

    Changes the size of the cluster. You can change the cluster's type, or change the\n number or type of nodes. The default behavior is to use the elastic resize method. With\n an elastic resize, your cluster is available for read and write operations more quickly\n than with the classic resize method.

    \n

    Elastic resize operations have the following restrictions:

    \n
      \n
    • \n

      You can only resize clusters of the following types:

      \n
        \n
      • \n

        dc1.large (if your cluster is in a VPC)

        \n
        • \n
      • \n

        dc1.8xlarge (if your cluster is in a VPC)

        \n
        • \n
      • \n

        dc2.large

        \n
        • \n
      • \n

        dc2.8xlarge

        \n
        • \n
      • \n

        ds2.xlarge

        \n
        • \n
      • \n

        ds2.8xlarge

        \n
        • \n
      • \n

        ra3.4xlarge

        \n
        • \n
      • \n

        ra3.16xlarge

        \n
        • \n
      \n
      • \n
    • \n

      The type of nodes that you add must match the node type for the\n cluster.

      \n
      • \n
    " } }, "com.amazonaws.redshift#ResizeClusterMessage": { @@ -9057,22 +9066,25 @@ "NumberOfNodes": { "target": "com.amazonaws.redshift#Integer", "traits": { - "smithy.api#documentation": "

    The new number of nodes for the cluster.

    " + "smithy.api#documentation": "

    The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

    " } }, - "ClusterIdentifier": { + "ClusterType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for the cluster to resize.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The new cluster type for the specified cluster.

    " } }, - "ClusterType": { + "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The new cluster type for the specified cluster.

    " + "smithy.api#documentation": "

    The unique identifier for the cluster to resize.

    ", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

    Describes a resize cluster operation. For example, a scheduled action to run the ResizeCluster API operation.

    " } }, "com.amazonaws.redshift#ResizeClusterResult": { @@ -9086,17 +9098,17 @@ "com.amazonaws.redshift#ResizeInfo": { "type": "structure", "members": { - "AllowCancelResize": { - "target": "com.amazonaws.redshift#Boolean", - "traits": { - "smithy.api#documentation": "

    A boolean value indicating if the resize operation can be cancelled.

    " - } - }, "ResizeType": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    Returns the value ClassicResize.

    " } + }, + "AllowCancelResize": { + "target": "com.amazonaws.redshift#Boolean", + "traits": { + "smithy.api#documentation": "

    A boolean value indicating if the resize operation can be cancelled.

    " + } } }, "traits": { @@ -9119,28 +9131,16 @@ "com.amazonaws.redshift#ResizeProgressMessage": { "type": "structure", "members": { - "ResizeType": { + "Status": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    An enum with possible values of ClassicResize and\n ElasticResize. These values describe the type of resize operation being\n performed.

    " - } - }, - "TargetNumberOfNodes": { - "target": "com.amazonaws.redshift#IntegerOptional", - "traits": { - "smithy.api#documentation": "

    The number of nodes that the cluster will have after the resize operation is\n complete.

    " - } - }, - "AvgResizeRateInMegaBytesPerSecond": { - "target": "com.amazonaws.redshift#DoubleOptional", - "traits": { - "smithy.api#documentation": "

    The average rate of the resize operation over the last few minutes, measured in\n megabytes per second. After the resize operation completes, this value shows the average\n rate of the entire resize operation.

    " + "smithy.api#documentation": "

    The status of the resize operation.

    \n

    Valid Values: NONE | IN_PROGRESS | FAILED |\n SUCCEEDED | CANCELLING\n

    " } }, - "EstimatedTimeToCompletionInSeconds": { + "ElapsedTimeInSeconds": { "target": "com.amazonaws.redshift#LongOptional", "traits": { - "smithy.api#documentation": "

    The estimated time remaining, in seconds, until the resize operation is complete.\n This value is calculated based on the average resize rate and the estimated amount of\n data remaining to be processed. Once the resize operation is complete, this value will\n be 0.

    " + "smithy.api#documentation": "

    The amount of seconds that have elapsed since the resize operation began. After the\n resize operation completes, this value shows the total actual time, in seconds, for the\n resize operation.

    " } }, "ImportTablesNotStarted": { @@ -9149,22 +9149,22 @@ "smithy.api#documentation": "

    The names of tables that have not been yet imported.

    \n

    Valid Values: List of table names

    " } }, - "ElapsedTimeInSeconds": { - "target": "com.amazonaws.redshift#LongOptional", + "TargetClusterType": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The amount of seconds that have elapsed since the resize operation began. After the\n resize operation completes, this value shows the total actual time, in seconds, for the\n resize operation.

    " + "smithy.api#documentation": "

    The cluster type after the resize operation is complete.

    \n

    Valid Values: multi-node | single-node\n

    " } }, - "TargetClusterType": { + "TargetEncryptionType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The cluster type after the resize operation is complete.

    \n

    Valid Values: multi-node | single-node\n

    " + "smithy.api#documentation": "

    The type of encryption for the cluster after the resize is complete.

    \n

    Possible values are KMS and None.

    " } }, - "DataTransferProgressPercent": { - "target": "com.amazonaws.redshift#DoubleOptional", + "EstimatedTimeToCompletionInSeconds": { + "target": "com.amazonaws.redshift#LongOptional", "traits": { - "smithy.api#documentation": "

    The percent of data transferred from source cluster to target cluster.

    " + "smithy.api#documentation": "

    The estimated time remaining, in seconds, until the resize operation is complete.\n This value is calculated based on the average resize rate and the estimated amount of\n data remaining to be processed. Once the resize operation is complete, this value will\n be 0.

    " } }, "TargetNodeType": { @@ -9179,22 +9179,16 @@ "smithy.api#documentation": "

    The names of tables that have been completely imported .

    \n

    Valid Values: List of table names.

    " } }, - "Message": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    An optional string to provide additional details about the resize action.

    " - } - }, - "TotalResizeDataInMegaBytes": { - "target": "com.amazonaws.redshift#LongOptional", + "TargetNumberOfNodes": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The estimated total amount of data, in megabytes, on the cluster before the resize\n operation began.

    " + "smithy.api#documentation": "

    The number of nodes that the cluster will have after the resize operation is\n complete.

    " } }, - "TargetEncryptionType": { + "ResizeType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The type of encryption for the cluster after the resize is complete.

    \n

    Possible values are KMS and None. In the China region\n possible values are: Legacy and None.

    " + "smithy.api#documentation": "

    An enum with possible values of ClassicResize and\n ElasticResize. These values describe the type of resize operation being\n performed.

    " } }, "ProgressInMegaBytes": { @@ -9203,16 +9197,34 @@ "smithy.api#documentation": "

    While the resize operation is in progress, this value shows the current amount of\n data, in megabytes, that has been processed so far. When the resize operation is\n complete, this value shows the total amount of data, in megabytes, on the cluster, which\n may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data\n before resize).

    " } }, + "AvgResizeRateInMegaBytesPerSecond": { + "target": "com.amazonaws.redshift#DoubleOptional", + "traits": { + "smithy.api#documentation": "

    The average rate of the resize operation over the last few minutes, measured in\n megabytes per second. After the resize operation completes, this value shows the average\n rate of the entire resize operation.

    " + } + }, "ImportTablesInProgress": { "target": "com.amazonaws.redshift#ImportTablesInProgress", "traits": { "smithy.api#documentation": "

    The names of tables that are being currently imported.

    \n

    Valid Values: List of table names.

    " } }, - "Status": { + "Message": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The status of the resize operation.

    \n

    Valid Values: NONE | IN_PROGRESS | FAILED |\n SUCCEEDED | CANCELLING\n

    " + "smithy.api#documentation": "

    An optional string to provide additional details about the resize action.

    " + } + }, + "TotalResizeDataInMegaBytes": { + "target": "com.amazonaws.redshift#LongOptional", + "traits": { + "smithy.api#documentation": "

    The estimated total amount of data, in megabytes, on the cluster before the resize\n operation began.

    " + } + }, + "DataTransferProgressPercent": { + "target": "com.amazonaws.redshift#DoubleOptional", + "traits": { + "smithy.api#documentation": "

    The percent of data transferred from source cluster to target cluster.

    " } } }, @@ -9334,28 +9346,35 @@ "com.amazonaws.redshift#RestoreFromClusterSnapshotMessage": { "type": "structure", "members": { - "OwnerAccount": { + "HsmClientCertificateIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The AWS customer account used to create or copy the snapshot. Required if you are\n restoring a snapshot you do not own, optional if you own the snapshot.

    " + "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " } }, - "PubliclyAccessible": { - "target": "com.amazonaws.redshift#BooleanOptional", + "AutomatedSnapshotRetentionPeriod": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    If true, the cluster can be accessed from a public network.

    " + "smithy.api#documentation": "

    The number of days that automated snapshots are retained. If the value is 0,\n automated snapshots are disabled. Even if automated snapshots are disabled, you can\n still create manual snapshots when you want with CreateClusterSnapshot.

    \n

    Default: The value selected for the cluster from which the snapshot was\n taken.

    \n

    Constraints: Must be a value from 0 to 35.

    " } }, - "SnapshotClusterIdentifier": { + "Port": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

    The port number on which the cluster accepts connections.

    \n

    Default: The same port as the original cluster.

    \n

    Constraints: Must be between 1115 and 65535.

    " + } + }, + "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the cluster the source snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    " + "smithy.api#documentation": "

    The name of the snapshot from which to create the new cluster. This parameter isn't\n case sensitive.

    \n

    Example: my-snapshot-id\n

    ", + "smithy.api#required": {} } }, - "IamRoles": { - "target": "com.amazonaws.redshift#IamRoleArnList", + "NumberOfNodes": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    A list of AWS Identity and Access Management (IAM) roles that can be used by the\n cluster to access other AWS services. You must supply the IAM roles in their Amazon\n Resource Name (ARN) format. You can supply up to 10 IAM roles in a single\n request.

    \n

    A cluster can have up to 10 IAM roles associated at any time.

    " + "smithy.api#documentation": "

    The number of nodes specified when provisioning the restored cluster.

    " } }, "ElasticIp": { @@ -9364,22 +9383,22 @@ "smithy.api#documentation": "

    The elastic IP (EIP) address for the cluster.

    " } }, - "AvailabilityZone": { - "target": "com.amazonaws.redshift#String", + "AllowVersionUpgrade": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    The Amazon EC2 Availability Zone in which to restore the cluster.

    \n

    Default: A random, system-chosen Availability Zone.

    \n

    Example: us-east-2a\n

    " + "smithy.api#documentation": "

    If true, major version upgrades can be applied during the maintenance\n window to the Amazon Redshift engine that is running on the cluster.

    \n

    Default: true\n

    " } }, - "HsmClientCertificateIdentifier": { - "target": "com.amazonaws.redshift#String", + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to\n retrieve the data encryption keys stored in an HSM.

    " + "smithy.api#documentation": "

    The default number of days to retain a manual snapshot. If the value is -1, the\n snapshot is retained indefinitely. This setting doesn't change the retention period\n of existing snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " } }, - "KmsKeyId": { + "ClusterSubnetGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to\n use to encrypt data in the cluster that you restore from a shared snapshot.

    " + "smithy.api#documentation": "

    The name of the subnet group where you want to cluster restored.

    \n

    A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must\n provide subnet group name where you want the cluster restored.

    " } }, "PreferredMaintenanceWindow": { @@ -9394,16 +9413,22 @@ "smithy.api#documentation": "

    A list of security groups to be associated with this cluster.

    \n

    Default: The default cluster security group for Amazon Redshift.

    \n

    Cluster security groups only apply to clusters outside of VPCs.

    " } }, - "ClusterParameterGroupName": { + "EnhancedVpcRouting": { + "target": "com.amazonaws.redshift#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " + } + }, + "AvailabilityZone": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the parameter group to be associated with this cluster.

    \n

    Default: The default Amazon Redshift cluster parameter group. For information about the\n default parameter group, go to Working with Amazon\n Redshift Parameter Groups.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " + "smithy.api#documentation": "

    The Amazon EC2 Availability Zone in which to restore the cluster.

    \n

    Default: A random, system-chosen Availability Zone.

    \n

    Example: us-east-2a\n

    " } }, - "NumberOfNodes": { - "target": "com.amazonaws.redshift#IntegerOptional", + "IamRoles": { + "target": "com.amazonaws.redshift#IamRoleArnList", "traits": { - "smithy.api#documentation": "

    The number of nodes specified when provisioning the restored cluster.

    " + "smithy.api#documentation": "

    A list of AWS Identity and Access Management (IAM) roles that can be used by the\n cluster to access other AWS services. You must supply the IAM roles in their Amazon\n Resource Name (ARN) format. You can supply up to 10 IAM roles in a single\n request.

    \n

    A cluster can have up to 10 IAM roles associated at any time.

    " } }, "ClusterIdentifier": { @@ -9413,46 +9438,34 @@ "smithy.api#required": {} } }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.redshift#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " - } - }, - "AllowVersionUpgrade": { - "target": "com.amazonaws.redshift#BooleanOptional", - "traits": { - "smithy.api#documentation": "

    If true, major version upgrades can be applied during the maintenance\n window to the Amazon Redshift engine that is running on the cluster.

    \n

    Default: true\n

    " - } - }, - "ClusterSubnetGroupName": { + "ClusterParameterGroupName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the subnet group where you want to cluster restored.

    \n

    A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must\n provide subnet group name where you want the cluster restored.

    " + "smithy.api#documentation": "

    The name of the parameter group to be associated with this cluster.

    \n

    Default: The default Amazon Redshift cluster parameter group. For information about the\n default parameter group, go to Working with Amazon\n Redshift Parameter Groups.

    \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 alphanumeric characters or hyphens.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    • \n

      Cannot end with a hyphen or contain two consecutive hyphens.

      \n
      • \n
    " } }, - "NodeType": { + "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The node type that the restored cluster will be provisioned with.

    \n

    Default: The node type of the cluster from which the snapshot was taken. You can\n modify this if you are using any DS node type. In that case, you can choose to restore\n into another DS node type of the same size. For example, you can restore ds1.8xlarge\n into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you\n must restore into that same instance type and size. In other words, you can only restore\n a dc1.large instance type into another dc1.large instance type or dc2.large instance\n type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge\n cluster, then resize to a dc2.8large cluster. For more information about node types, see\n \n About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

    " + "smithy.api#documentation": "

    The name of the cluster the source snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    " } }, - "SnapshotScheduleIdentifier": { + "KmsKeyId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A unique identifier for the snapshot schedule.

    " + "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to\n use to encrypt data in the cluster that you restore from a shared snapshot.

    " } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.redshift#VpcSecurityGroupIdList", + "AdditionalInfo": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A list of Virtual Private Cloud (VPC) security groups to be associated with the\n cluster.

    \n

    Default: The default VPC security group is associated with the cluster.

    \n

    VPC security groups only apply to clusters in VPCs.

    " + "smithy.api#documentation": "

    Reserved.

    " } }, - "ManualSnapshotRetentionPeriod": { - "target": "com.amazonaws.redshift#IntegerOptional", + "OwnerAccount": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The default number of days to retain a manual snapshot. If the value is -1, the\n snapshot is retained indefinitely. This setting doesn't change the retention period\n of existing snapshots.

    \n

    The value must be either -1 or an integer between 1 and 3,653.

    " + "smithy.api#documentation": "

    The AWS customer account used to create or copy the snapshot. Required if you are\n restoring a snapshot you do not own, optional if you own the snapshot.

    " } }, "MaintenanceTrackName": { @@ -9461,29 +9474,28 @@ "smithy.api#documentation": "

    The name of the maintenance track for the restored cluster. When you take a snapshot,\n the snapshot inherits the MaintenanceTrack value from the cluster. The\n snapshot might be on a different track than the cluster that was the source for the\n snapshot. For example, suppose that you take a snapshot of a cluster that is on the\n current track and then change the cluster to be on the trailing track. In this case, the\n snapshot and the source cluster are on different tracks.

    " } }, - "AdditionalInfo": { - "target": "com.amazonaws.redshift#String", + "PubliclyAccessible": { + "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

    Reserved.

    " + "smithy.api#documentation": "

    If true, the cluster can be accessed from a public network.

    " } }, - "AutomatedSnapshotRetentionPeriod": { - "target": "com.amazonaws.redshift#IntegerOptional", + "SnapshotScheduleIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The number of days that automated snapshots are retained. If the value is 0,\n automated snapshots are disabled. Even if automated snapshots are disabled, you can\n still create manual snapshots when you want with CreateClusterSnapshot.

    \n

    Default: The value selected for the cluster from which the snapshot was\n taken.

    \n

    Constraints: Must be a value from 0 to 35.

    " + "smithy.api#documentation": "

    A unique identifier for the snapshot schedule.

    " } }, - "Port": { - "target": "com.amazonaws.redshift#IntegerOptional", + "NodeType": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The port number on which the cluster accepts connections.

    \n

    Default: The same port as the original cluster.

    \n

    Constraints: Must be between 1115 and 65535.

    " + "smithy.api#documentation": "

    The node type that the restored cluster will be provisioned with.

    \n

    Default: The node type of the cluster from which the snapshot was taken. You can\n modify this if you are using any DS node type. In that case, you can choose to restore\n into another DS node type of the same size. For example, you can restore ds1.8xlarge\n into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you\n must restore into that same instance type and size. In other words, you can only restore\n a dc1.large instance type into another dc1.large instance type or dc2.large instance\n type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge\n cluster, then resize to a dc2.8large cluster. For more information about node types, see\n \n About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

    " } }, - "SnapshotIdentifier": { - "target": "com.amazonaws.redshift#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.redshift#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

    The name of the snapshot from which to create the new cluster. This parameter isn't\n case sensitive.

    \n

    Example: my-snapshot-id\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of Virtual Private Cloud (VPC) security groups to be associated with the\n cluster.

    \n

    Default: The default VPC security group is associated with the cluster.

    \n

    VPC security groups only apply to clusters in VPCs.

    " } }, "HsmConfigurationIdentifier": { @@ -9514,10 +9526,16 @@ "smithy.api#documentation": "

    The size of the set of snapshot data used to restore the cluster.\n This field is only updated when you restore to DC2 and DS2 node types.

    " } }, - "ProgressInMegaBytes": { + "ElapsedTimeInSeconds": { "target": "com.amazonaws.redshift#Long", "traits": { - "smithy.api#documentation": "

    The number of megabytes that have been transferred from snapshot storage.\n This field is only updated when you restore to DC2 and DS2 node types.

    " + "smithy.api#documentation": "

    The amount of time an in-progress restore has been running, or the amount of time\n it took a completed restore to finish.\n This field is only updated when you restore to DC2 and DS2 node types.

    " + } + }, + "EstimatedTimeToCompletionInSeconds": { + "target": "com.amazonaws.redshift#Long", + "traits": { + "smithy.api#documentation": "

    The estimate of the time remaining before the restore will complete. Returns 0 for\n a completed restore.\n This field is only updated when you restore to DC2 and DS2 node types.

    " } }, "Status": { @@ -9532,16 +9550,10 @@ "smithy.api#documentation": "

    The number of megabytes per second being transferred from the backup storage.\n Returns the average rate for a completed backup.\n This field is only updated when you restore to DC2 and DS2 node types.

    " } }, - "EstimatedTimeToCompletionInSeconds": { - "target": "com.amazonaws.redshift#Long", - "traits": { - "smithy.api#documentation": "

    The estimate of the time remaining before the restore will complete. Returns 0 for\n a completed restore.\n This field is only updated when you restore to DC2 and DS2 node types.

    " - } - }, - "ElapsedTimeInSeconds": { + "ProgressInMegaBytes": { "target": "com.amazonaws.redshift#Long", "traits": { - "smithy.api#documentation": "

    The amount of time an in-progress restore has been running, or the amount of time\n it took a completed restore to finish.\n This field is only updated when you restore to DC2 and DS2 node types.

    " + "smithy.api#documentation": "

    The number of megabytes that have been transferred from snapshot storage.\n This field is only updated when you restore to DC2 and DS2 node types.

    " } } }, @@ -9593,24 +9605,17 @@ "smithy.api#documentation": "

    The name of the schema to restore the table to.

    " } }, - "SourceSchemaName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the source schema that contains the table to restore from. If you do\n not specify a SourceSchemaName value, the default is\n public.

    " - } - }, - "SnapshotIdentifier": { + "SourceDatabaseName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the snapshot to restore the table from. This snapshot must have\n been created from the Amazon Redshift cluster specified by the\n ClusterIdentifier parameter.

    ", + "smithy.api#documentation": "

    The name of the source database that contains the table to restore from.

    ", "smithy.api#required": {} } }, - "SourceDatabaseName": { + "SourceSchemaName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the source database that contains the table to restore from.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the source schema that contains the table to restore from. If you do\n not specify a SourceSchemaName value, the default is\n public.

    " } }, "TargetDatabaseName": { @@ -9626,17 +9631,24 @@ "smithy.api#required": {} } }, - "ClusterIdentifier": { + "NewTableName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Redshift cluster to restore the table to.

    ", + "smithy.api#documentation": "

    The name of the table to create as a result of the current request.

    ", "smithy.api#required": {} } }, - "NewTableName": { + "SnapshotIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The identifier of the snapshot to restore the table from. This snapshot must have\n been created from the Amazon Redshift cluster specified by the\n ClusterIdentifier parameter.

    ", + "smithy.api#required": {} + } + }, + "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the table to create as a result of the current request.

    ", + "smithy.api#documentation": "

    The identifier of the Amazon Redshift cluster to restore the table to.

    ", "smithy.api#required": {} } } @@ -9683,6 +9695,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

    Describes a resume cluster operation. For example, a scheduled action to run the ResumeCluster API operation.

    " } }, "com.amazonaws.redshift#ResumeClusterResult": { @@ -9760,13 +9775,6 @@ "smithy.api#documentation": "

    The AWS account number of the owner of the security group specified in the\n EC2SecurityGroupName parameter. The AWS access key ID is not an\n acceptable value. If EC2SecurityGroupOwnerId is specified,\n EC2SecurityGroupName must also be provided. and CIDRIP\n cannot be provided.

    \n

    Example: 111122223333\n

    " } }, - "ClusterSecurityGroupName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the security Group from which to revoke the ingress rule.

    ", - "smithy.api#required": {} - } - }, "CIDRIP": { "target": "com.amazonaws.redshift#String", "traits": { @@ -9778,6 +9786,13 @@ "traits": { "smithy.api#documentation": "

    The name of the EC2 Security Group whose access is to be revoked. If\n EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId\n must also be provided and CIDRIP cannot be provided.

    " } + }, + "ClusterSecurityGroupName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the security Group from which to revoke the ingress rule.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -9818,11 +9833,10 @@ "com.amazonaws.redshift#RevokeSnapshotAccessMessage": { "type": "structure", "members": { - "SnapshotIdentifier": { + "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the snapshot that the account can no longer access.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    " } }, "AccountWithRestoreAccess": { @@ -9832,10 +9846,11 @@ "smithy.api#required": {} } }, - "SnapshotClusterIdentifier": { + "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.

    " + "smithy.api#documentation": "

    The identifier of the snapshot that the account can no longer access.

    ", + "smithy.api#required": {} } } }, @@ -9977,10 +9992,10 @@ "com.amazonaws.redshift#ScheduledAction": { "type": "structure", "members": { - "NextInvocations": { - "target": "com.amazonaws.redshift#ScheduledActionTimeList", + "IamRole": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    List of times when the scheduled action will run.

    " + "smithy.api#documentation": "

    The IAM role to assume to run the scheduled action. \n This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action.\n This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.\n \nFor more information about the IAM role to use with the Amazon Redshift scheduler, see \nUsing Identity-Based Policies for Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

    " } }, "ScheduledActionDescription": { @@ -9989,16 +10004,10 @@ "smithy.api#documentation": "

    The description of the scheduled action.

    " } }, - "ScheduledActionName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the scheduled action.

    " - } - }, - "IamRole": { - "target": "com.amazonaws.redshift#String", + "EndTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The IAM role to assume to run the scheduled action. \n This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action.\n This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.\n \nFor more information about the IAM role to use with the Amazon Redshift scheduler, see \nUsing Identity-Based Policies for Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

    " + "smithy.api#documentation": "

    The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

    " } }, "TargetAction": { @@ -10007,10 +10016,16 @@ "smithy.api#documentation": "

    A JSON format string of the Amazon Redshift API operation with input parameters.

    \n

    \"{\\\"ResizeCluster\\\":{\\\"NodeType\\\":\\\"ds2.8xlarge\\\",\\\"ClusterIdentifier\\\":\\\"my-test-cluster\\\",\\\"NumberOfNodes\\\":3}}\".

    " } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

    " + "smithy.api#documentation": "

    The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

    " + } + }, + "Schedule": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The schedule for a one-time (at format) or recurring (cron format) scheduled action. \n Schedule invocations must be separated by at least one hour.

    \n

    Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".

    \n

    Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". \n For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions \n in the Amazon CloudWatch Events User Guide.

    " } }, "State": { @@ -10019,16 +10034,16 @@ "smithy.api#documentation": "

    The state of the scheduled action. For example, DISABLED.

    " } }, - "Schedule": { - "target": "com.amazonaws.redshift#String", + "NextInvocations": { + "target": "com.amazonaws.redshift#ScheduledActionTimeList", "traits": { - "smithy.api#documentation": "

    The schedule for a one-time (at format) or recurring (cron format) scheduled action. \n Schedule invocations must be separated by at least one hour.

    \n

    Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".

    \n

    Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". \n For example, \"cron(0 10 ? * MON *)\". For more information, see \n Cron Expressions \n in the Amazon CloudWatch Events User Guide.

    " + "smithy.api#documentation": "

    List of times when the scheduled action will run.

    " } }, - "StartTime": { - "target": "com.amazonaws.redshift#TStamp", + "ScheduledActionName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

    " + "smithy.api#documentation": "

    The name of the scheduled action.

    " } } }, @@ -10157,10 +10172,10 @@ "com.amazonaws.redshift#ScheduledActionType": { "type": "structure", "members": { - "ResizeCluster": { - "target": "com.amazonaws.redshift#ResizeClusterMessage", + "PauseCluster": { + "target": "com.amazonaws.redshift#PauseClusterMessage", "traits": { - "smithy.api#documentation": "

    An action that runs a ResizeCluster API operation.

    " + "smithy.api#documentation": "

    An action that runs a PauseCluster API operation.

    " } }, "ResumeCluster": { @@ -10169,10 +10184,10 @@ "smithy.api#documentation": "

    An action that runs a ResumeCluster API operation.

    " } }, - "PauseCluster": { - "target": "com.amazonaws.redshift#PauseClusterMessage", + "ResizeCluster": { + "target": "com.amazonaws.redshift#ResizeClusterMessage", "traits": { - "smithy.api#documentation": "

    An action that runs a PauseCluster API operation.

    " + "smithy.api#documentation": "

    An action that runs a ResizeCluster API operation.

    " } } }, @@ -10215,17 +10230,17 @@ "com.amazonaws.redshift#ScheduledActionsMessage": { "type": "structure", "members": { - "ScheduledActions": { - "target": "com.amazonaws.redshift#ScheduledActionList", - "traits": { - "smithy.api#documentation": "

    List of retrieved scheduled actions.

    " - } - }, "Marker": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeScheduledActions request\n exceed the value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    " } + }, + "ScheduledActions": { + "target": "com.amazonaws.redshift#ScheduledActionList", + "traits": { + "smithy.api#documentation": "

    List of retrieved scheduled actions.

    " + } } } }, @@ -10247,28 +10262,40 @@ "com.amazonaws.redshift#Snapshot": { "type": "structure", "members": { - "EncryptedWithHSM": { - "target": "com.amazonaws.redshift#Boolean", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM\n keys.

    " + "smithy.api#documentation": "

    The identifier of the cluster for which the snapshot was taken.

    " } }, - "ClusterVersion": { + "VpcId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The version ID of the Amazon Redshift engine that is running on the cluster.

    " + "smithy.api#documentation": "

    The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.\n Otherwise, this field is not in the output.

    " } }, - "MaintenanceTrackName": { + "Tags": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

    The list of tags for the cluster snapshot.

    " + } + }, + "Status": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the maintenance track for the snapshot.

    " + "smithy.api#documentation": "

    The snapshot status. The value of the status depends on the API operation used:

    \n " } }, - "EstimatedSecondsToCompletion": { - "target": "com.amazonaws.redshift#Long", + "ManualSnapshotRemainingDays": { + "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The estimate of the time remaining before the snapshot backup will complete.\n Returns 0 for a completed backup.

    " + "smithy.api#documentation": "

    The number of days until a manual snapshot will pass its retention period.

    " + } + }, + "Encrypted": { + "target": "com.amazonaws.redshift#Boolean", + "traits": { + "smithy.api#documentation": "

    If true, the data in the snapshot is encrypted at rest.

    " } }, "ElapsedTimeInSeconds": { @@ -10277,28 +10304,34 @@ "smithy.api#documentation": "

    The amount of time an in-progress snapshot backup has been running, or the amount\n of time it took a completed backup to finish.

    " } }, - "CurrentBackupRateInMegaBytesPerSecond": { - "target": "com.amazonaws.redshift#Double", + "KmsKeyId": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The number of megabytes per second being transferred to the snapshot backup.\n Returns 0 for a completed backup.

    " + "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that was used to\n encrypt data in the cluster from which the snapshot was taken.

    " } }, - "ManualSnapshotRemainingDays": { + "SourceRegion": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The source region from which the snapshot was copied.

    " + } + }, + "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "

    The number of days until a manual snapshot will pass its retention period.

    " + "smithy.api#documentation": "

    The number of days that a manual snapshot is retained. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n\n

    The value must be either -1 or an integer between 1 and 3,653.

    " } }, - "Status": { + "DBName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The snapshot status. The value of the status depends on the API operation used:

    \n " + "smithy.api#documentation": "

    The name of the database that was created when the cluster was created.

    " } }, - "ClusterIdentifier": { + "AvailabilityZone": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the cluster for which the snapshot was taken.

    " + "smithy.api#documentation": "

    The Availability Zone in which the cluster was created.

    " } }, "BackupProgressInMegaBytes": { @@ -10319,76 +10352,76 @@ "smithy.api#documentation": "

    The size of the incremental backup.

    " } }, - "NumberOfNodes": { - "target": "com.amazonaws.redshift#Integer", + "MasterUsername": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The number of nodes in the cluster.

    " + "smithy.api#documentation": "

    The master user name for the cluster.

    " } }, - "ManualSnapshotRetentionPeriod": { - "target": "com.amazonaws.redshift#IntegerOptional", + "CurrentBackupRateInMegaBytesPerSecond": { + "target": "com.amazonaws.redshift#Double", "traits": { - "smithy.api#documentation": "

    The number of days that a manual snapshot is retained. If the value is -1, the manual\n snapshot is retained indefinitely.

    \n\n

    The value must be either -1 or an integer between 1 and 3,653.

    " + "smithy.api#documentation": "

    The number of megabytes per second being transferred to the snapshot backup.\n Returns 0 for a completed backup.

    " } }, - "SnapshotCreateTime": { - "target": "com.amazonaws.redshift#TStamp", + "TotalBackupSizeInMegaBytes": { + "target": "com.amazonaws.redshift#Double", "traits": { - "smithy.api#documentation": "

    The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a\n copy of the cluster data as of this exact time.

    " + "smithy.api#documentation": "

    The size of the complete set of backup data that would be used to restore the\n cluster.

    " } }, - "EnhancedVpcRouting": { - "target": "com.amazonaws.redshift#Boolean", + "EstimatedSecondsToCompletion": { + "target": "com.amazonaws.redshift#Long", "traits": { - "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " + "smithy.api#documentation": "

    The estimate of the time remaining before the snapshot backup will complete.\n Returns 0 for a completed backup.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.redshift#String", + "Port": { + "target": "com.amazonaws.redshift#Integer", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (KMS) key ID of the encryption key that was used to\n encrypt data in the cluster from which the snapshot was taken.

    " + "smithy.api#documentation": "

    The port that the cluster is listening on.

    " } }, - "SourceRegion": { - "target": "com.amazonaws.redshift#String", + "SnapshotCreateTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The source region from which the snapshot was copied.

    " + "smithy.api#documentation": "

    The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a\n copy of the cluster data as of this exact time.

    " } }, - "DBName": { - "target": "com.amazonaws.redshift#String", + "EnhancedVpcRouting": { + "target": "com.amazonaws.redshift#Boolean", "traits": { - "smithy.api#documentation": "

    The name of the database that was created when the cluster was created.

    " + "smithy.api#documentation": "

    An option that specifies whether to create the cluster with enhanced VPC routing\n enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a\n VPC. For more information, see Enhanced VPC Routing in\n the Amazon Redshift Cluster Management Guide.

    \n

    If this option is true, enhanced VPC routing is enabled.

    \n

    Default: false

    " } }, - "MasterUsername": { + "SnapshotType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The master user name for the cluster.

    " + "smithy.api#documentation": "

    The snapshot type. Snapshots created using CreateClusterSnapshot\n and CopyClusterSnapshot are of type \"manual\".

    " } }, - "AvailabilityZone": { - "target": "com.amazonaws.redshift#String", + "ClusterCreateTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The Availability Zone in which the cluster was created.

    " + "smithy.api#documentation": "

    The time (UTC) when the cluster was originally created.

    " } }, - "VpcId": { - "target": "com.amazonaws.redshift#String", + "NumberOfNodes": { + "target": "com.amazonaws.redshift#Integer", "traits": { - "smithy.api#documentation": "

    The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.\n Otherwise, this field is not in the output.

    " + "smithy.api#documentation": "

    The number of nodes in the cluster.

    " } }, - "Encrypted": { - "target": "com.amazonaws.redshift#Boolean", + "NodeType": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    If true, the data in the snapshot is encrypted at rest.

    " + "smithy.api#documentation": "

    The node type of the nodes in the cluster.

    " } }, - "SnapshotIdentifier": { - "target": "com.amazonaws.redshift#String", + "EncryptedWithHSM": { + "target": "com.amazonaws.redshift#Boolean", "traits": { - "smithy.api#documentation": "

    The snapshot identifier that is provided in the request.

    " + "smithy.api#documentation": "

    A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM\n keys.

    " } }, "RestorableNodeTypes": { @@ -10397,52 +10430,34 @@ "smithy.api#documentation": "

    The list of node types that this cluster snapshot is able to restore\n into.

    " } }, - "Port": { - "target": "com.amazonaws.redshift#Integer", - "traits": { - "smithy.api#documentation": "

    The port that the cluster is listening on.

    " - } - }, - "TotalBackupSizeInMegaBytes": { - "target": "com.amazonaws.redshift#Double", - "traits": { - "smithy.api#documentation": "

    The size of the complete set of backup data that would be used to restore the\n cluster.

    " - } - }, - "ClusterCreateTime": { + "SnapshotRetentionStartTime": { "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The time (UTC) when the cluster was originally created.

    " + "smithy.api#documentation": "

    A timestamp representing the start of the retention period for the snapshot.

    " } }, - "SnapshotType": { + "MaintenanceTrackName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The snapshot type. Snapshots created using CreateClusterSnapshot\n and CopyClusterSnapshot are of type \"manual\".

    " + "smithy.api#documentation": "

    The name of the maintenance track for the snapshot.

    " } }, - "NodeType": { + "OwnerAccount": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The node type of the nodes in the cluster.

    " - } - }, - "Tags": { - "target": "com.amazonaws.redshift#TagList", - "traits": { - "smithy.api#documentation": "

    The list of tags for the cluster snapshot.

    " + "smithy.api#documentation": "

    For manual snapshots, the AWS customer account used to create or copy the snapshot.\n For automatic snapshots, the owner of the cluster. The owner can perform all snapshot\n actions, such as sharing a manual snapshot.

    " } }, - "OwnerAccount": { + "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    For manual snapshots, the AWS customer account used to create or copy the snapshot.\n For automatic snapshots, the owner of the cluster. The owner can perform all snapshot\n actions, such as sharing a manual snapshot.

    " + "smithy.api#documentation": "

    The snapshot identifier that is provided in the request.

    " } }, - "SnapshotRetentionStartTime": { - "target": "com.amazonaws.redshift#TStamp", + "ClusterVersion": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    A timestamp representing the start of the retention period for the snapshot.

    " + "smithy.api#documentation": "

    The version ID of the Amazon Redshift engine that is running on the cluster.

    " } } }, @@ -10517,16 +10532,16 @@ "smithy.api#documentation": "

    A list of tag instances.

    " } }, - "SnapshotCopyGrantName": { + "KmsKeyId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the snapshot copy grant.

    " + "smithy.api#documentation": "

    The unique identifier of the customer master key (CMK) in AWS KMS to which\n Amazon Redshift is granted permission.

    " } }, - "KmsKeyId": { + "SnapshotCopyGrantName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The unique identifier of the customer master key (CMK) in AWS KMS to which\n Amazon Redshift is granted permission.

    " + "smithy.api#documentation": "

    The name of the snapshot copy grant.

    " } } }, @@ -10559,17 +10574,17 @@ "com.amazonaws.redshift#SnapshotCopyGrantMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeSnapshotCopyGrant request exceed the\n value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    \n

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

    " - } - }, "SnapshotCopyGrants": { "target": "com.amazonaws.redshift#SnapshotCopyGrantList", "traits": { "smithy.api#documentation": "

    The list of SnapshotCopyGrant objects.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeSnapshotCopyGrant request exceed the\n value specified in MaxRecords, AWS returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.

    \n

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

    " + } } }, "traits": { @@ -10611,12 +10626,6 @@ "smithy.api#documentation": "

    The text message describing the error.

    " } }, - "SnapshotIdentifier": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A unique identifier for the snapshot returning the error.

    " - } - }, "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { @@ -10628,6 +10637,12 @@ "traits": { "smithy.api#documentation": "

    The failure code for the error.

    " } + }, + "SnapshotIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A unique identifier for the snapshot returning the error.

    " + } } }, "traits": { @@ -10675,16 +10690,16 @@ "com.amazonaws.redshift#SnapshotSchedule": { "type": "structure", "members": { - "NextInvocations": { - "target": "com.amazonaws.redshift#ScheduledSnapshotTimeList", + "ScheduleIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    A unique identifier for the schedule.

    " } }, - "AssociatedClusters": { - "target": "com.amazonaws.redshift#AssociatedClusterList", + "NextInvocations": { + "target": "com.amazonaws.redshift#ScheduledSnapshotTimeList", "traits": { - "smithy.api#documentation": "

    A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

    " + "smithy.api#documentation": "

    " } }, "AssociatedClusterCount": { @@ -10693,10 +10708,10 @@ "smithy.api#documentation": "

    The number of clusters associated with the schedule.

    " } }, - "ScheduleIdentifier": { - "target": "com.amazonaws.redshift#String", + "AssociatedClusters": { + "target": "com.amazonaws.redshift#AssociatedClusterList", "traits": { - "smithy.api#documentation": "

    A unique identifier for the schedule.

    " + "smithy.api#documentation": "

    A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

    " } }, "Tags": { @@ -10705,17 +10720,17 @@ "smithy.api#documentation": "

    An optional set of tags describing the schedule.

    " } }, - "ScheduleDescription": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The description of the schedule.

    " - } - }, "ScheduleDefinitions": { "target": "com.amazonaws.redshift#ScheduleDefinitionList", "traits": { "smithy.api#documentation": "

    A list of ScheduleDefinitions.

    " } + }, + "ScheduleDescription": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The description of the schedule.

    " + } } }, "traits": { @@ -10786,18 +10801,18 @@ "com.amazonaws.redshift#SnapshotSortingEntity": { "type": "structure", "members": { + "SortOrder": { + "target": "com.amazonaws.redshift#SortByOrder", + "traits": { + "smithy.api#documentation": "

    The order for listing the attributes.

    " + } + }, "Attribute": { "target": "com.amazonaws.redshift#SnapshotAttributeToSortBy", "traits": { "smithy.api#documentation": "

    The category for sorting the snapshots.

    ", "smithy.api#required": {} } - }, - "SortOrder": { - "target": "com.amazonaws.redshift#SortByOrder", - "traits": { - "smithy.api#documentation": "

    The order for listing the attributes.

    " - } } }, "traits": { @@ -10878,12 +10893,6 @@ "com.amazonaws.redshift#Subnet": { "type": "structure", "members": { - "SubnetAvailabilityZone": { - "target": "com.amazonaws.redshift#AvailabilityZone", - "traits": { - "smithy.api#documentation": "

    " - } - }, "SubnetIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { @@ -10895,6 +10904,12 @@ "traits": { "smithy.api#documentation": "

    The status of the subnet.

    " } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.redshift#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

    " + } } }, "traits": { @@ -11075,16 +11090,22 @@ "com.amazonaws.redshift#TableRestoreStatus": { "type": "structure", "members": { - "TargetSchemaName": { + "SourceDatabaseName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the schema to restore the table to.

    " + "smithy.api#documentation": "

    The name of the source database that contains the table being restored.

    " } }, - "TotalDataInMegaBytes": { - "target": "com.amazonaws.redshift#LongOptional", + "RequestTime": { + "target": "com.amazonaws.redshift#TStamp", "traits": { - "smithy.api#documentation": "

    The total amount of data to restore to the new table, in megabytes (MB).

    " + "smithy.api#documentation": "

    The time that the table restore request was made, in Universal Coordinated Time\n (UTC).

    " + } + }, + "SourceTableName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The name of the source table being restored.

    " } }, "TargetDatabaseName": { @@ -11099,34 +11120,34 @@ "smithy.api#documentation": "

    The identifier of the snapshot that the table is being restored from.

    " } }, - "ClusterIdentifier": { - "target": "com.amazonaws.redshift#String", + "TotalDataInMegaBytes": { + "target": "com.amazonaws.redshift#LongOptional", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Redshift cluster that the table is being restored\n to.

    " + "smithy.api#documentation": "

    The total amount of data to restore to the new table, in megabytes (MB).

    " } }, - "RequestTime": { - "target": "com.amazonaws.redshift#TStamp", + "TargetSchemaName": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The time that the table restore request was made, in Universal Coordinated Time\n (UTC).

    " + "smithy.api#documentation": "

    The name of the schema to restore the table to.

    " } }, - "ProgressInMegaBytes": { - "target": "com.amazonaws.redshift#LongOptional", + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The amount of data restored to the new table so far, in megabytes (MB).

    " + "smithy.api#documentation": "

    The identifier of the Amazon Redshift cluster that the table is being restored\n to.

    " } }, - "SourceDatabaseName": { + "NewTableName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the source database that contains the table being restored.

    " + "smithy.api#documentation": "

    The name of the table to create as a result of the table restore request.

    " } }, - "Message": { - "target": "com.amazonaws.redshift#String", + "Status": { + "target": "com.amazonaws.redshift#TableRestoreStatusType", "traits": { - "smithy.api#documentation": "

    A description of the status of the table restore request. Status values include\n SUCCEEDED, FAILED, CANCELED,\n PENDING, IN_PROGRESS.

    " + "smithy.api#documentation": "

    A value that describes the current state of the table restore request.

    \n

    Valid Values: SUCCEEDED, FAILED, CANCELED,\n PENDING, IN_PROGRESS\n

    " } }, "SourceSchemaName": { @@ -11135,16 +11156,16 @@ "smithy.api#documentation": "

    The name of the source schema that contains the table being restored.

    " } }, - "SourceTableName": { + "Message": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the source table being restored.

    " + "smithy.api#documentation": "

    A description of the status of the table restore request. Status values include\n SUCCEEDED, FAILED, CANCELED,\n PENDING, IN_PROGRESS.

    " } }, - "Status": { - "target": "com.amazonaws.redshift#TableRestoreStatusType", + "ProgressInMegaBytes": { + "target": "com.amazonaws.redshift#LongOptional", "traits": { - "smithy.api#documentation": "

    A value that describes the current state of the table restore request.

    \n

    Valid Values: SUCCEEDED, FAILED, CANCELED,\n PENDING, IN_PROGRESS\n

    " + "smithy.api#documentation": "

    The amount of data restored to the new table so far, in megabytes (MB).

    " } }, "TableRestoreRequestId": { @@ -11152,12 +11173,6 @@ "traits": { "smithy.api#documentation": "

    The unique identifier for the table restore request.

    " } - }, - "NewTableName": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The name of the table to create as a result of the table restore request.

    " - } } }, "traits": { @@ -11176,17 +11191,17 @@ "com.amazonaws.redshift#TableRestoreStatusMessage": { "type": "structure", "members": { - "TableRestoreStatusDetails": { - "target": "com.amazonaws.redshift#TableRestoreStatusList", - "traits": { - "smithy.api#documentation": "

    A list of status details for one or more table restore requests.

    " - } - }, "Marker": { "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#documentation": "

    A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

    " } + }, + "TableRestoreStatusDetails": { + "target": "com.amazonaws.redshift#TableRestoreStatusList", + "traits": { + "smithy.api#documentation": "

    A list of status details for one or more table restore requests.

    " + } } }, "traits": { @@ -11218,16 +11233,16 @@ "com.amazonaws.redshift#Tag": { "type": "structure", "members": { - "Value": { + "Key": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The value for the resource tag.

    " + "smithy.api#documentation": "

    The key, or name, for the resource tag.

    " } }, - "Key": { + "Value": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The key, or name, for the resource tag.

    " + "smithy.api#documentation": "

    The value for the resource tag.

    " } } }, @@ -11278,12 +11293,6 @@ "com.amazonaws.redshift#TaggedResource": { "type": "structure", "members": { - "Tag": { - "target": "com.amazonaws.redshift#Tag", - "traits": { - "smithy.api#documentation": "

    The tag for the resource.

    " - } - }, "ResourceName": { "target": "com.amazonaws.redshift#String", "traits": { @@ -11295,6 +11304,12 @@ "traits": { "smithy.api#documentation": "

    The type of resource with which the tag is associated. Valid resource types are:

    \n
      \n
    • \n

      Cluster

      \n
      • \n
    • \n

      CIDR/IP

      \n
      • \n
    • \n

      EC2 security group

      \n
      • \n
    • \n

      Snapshot

      \n
      • \n
    • \n

      Cluster security group

      \n
      • \n
    • \n

      Subnet group

      \n
      • \n
    • \n

      HSM connection

      \n
      • \n
    • \n

      HSM certificate

      \n
      • \n
    • \n

      Parameter group

      \n
      • \n
    \n

    For more information about Amazon Redshift resource types and constructing ARNs, go to\n Constructing an Amazon Redshift Amazon Resource Name (ARN) in the\n Amazon Redshift Cluster Management Guide.

    " } + }, + "Tag": { + "target": "com.amazonaws.redshift#Tag", + "traits": { + "smithy.api#documentation": "

    The tag for the resource.

    " + } } }, "traits": { @@ -11342,17 +11357,17 @@ "com.amazonaws.redshift#TrackListMessage": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    The starting point to return a set of response tracklist records. You can retrieve the\n next set of response records by providing the returned marker value in the\n Marker parameter and retrying the request.

    " - } - }, "MaintenanceTracks": { "target": "com.amazonaws.redshift#TrackList", "traits": { "smithy.api#documentation": "

    A list of maintenance tracks output by the DescribeClusterTracks\n operation.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    The starting point to return a set of response tracklist records. You can retrieve the\n next set of response records by providing the returned marker value in the\n Marker parameter and retrying the request.

    " + } } } }, @@ -11411,16 +11426,16 @@ "com.amazonaws.redshift#UpdateTarget": { "type": "structure", "members": { - "MaintenanceTrackName": { + "DatabaseVersion": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The name of the new maintenance track.

    " + "smithy.api#documentation": "

    The cluster version for the new maintenance track.

    " } }, - "DatabaseVersion": { + "MaintenanceTrackName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The cluster version for the new maintenance track.

    " + "smithy.api#documentation": "

    The name of the new maintenance track.

    " } }, "SupportedOperations": { @@ -11443,40 +11458,34 @@ "smithy.api#documentation": "

    The identifier of the cluster with a usage limit.

    " } }, - "FeatureType": { - "target": "com.amazonaws.redshift#UsageLimitFeatureType", - "traits": { - "smithy.api#documentation": "

    The Amazon Redshift feature to which the limit applies.

    " - } - }, "Tags": { "target": "com.amazonaws.redshift#TagList", "traits": { "smithy.api#documentation": "

    A list of tag instances.

    " } }, - "LimitType": { - "target": "com.amazonaws.redshift#UsageLimitLimitType", + "UsageLimitId": { + "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The type of limit. Depending on the feature type, this can be based on a time duration or data size.

    " + "smithy.api#documentation": "

    The identifier of the usage limit.

    " } }, - "BreachAction": { - "target": "com.amazonaws.redshift#UsageLimitBreachAction", + "FeatureType": { + "target": "com.amazonaws.redshift#UsageLimitFeatureType", "traits": { - "smithy.api#documentation": "

    The action that Amazon Redshift takes when the limit is reached. Possible values are:

    \n
      \n
    • \n

      \n log - To log an event in a system table. The default is log.

      \n
      • \n
    • \n

      \n emit-metric - To emit CloudWatch metrics.

      \n
      • \n
    • \n

      \n disable - To disable the feature until the next usage period begins.

      \n
      • \n
    " + "smithy.api#documentation": "

    The Amazon Redshift feature to which the limit applies.

    " } }, - "Period": { - "target": "com.amazonaws.redshift#UsageLimitPeriod", + "BreachAction": { + "target": "com.amazonaws.redshift#UsageLimitBreachAction", "traits": { - "smithy.api#documentation": "

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

    " + "smithy.api#documentation": "

    The action that Amazon Redshift takes when the limit is reached. Possible values are:

    \n
      \n
    • \n

      \n log - To log an event in a system table. The default is log.

      \n
      • \n
    • \n

      \n emit-metric - To emit CloudWatch metrics.

      \n
      • \n
    • \n

      \n disable - To disable the feature until the next usage period begins.

      \n
      • \n
    " } }, - "UsageLimitId": { - "target": "com.amazonaws.redshift#String", + "LimitType": { + "target": "com.amazonaws.redshift#UsageLimitLimitType", "traits": { - "smithy.api#documentation": "

    The identifier of the usage limit.

    " + "smithy.api#documentation": "

    The type of limit. Depending on the feature type, this can be based on a time duration or data size.

    " } }, "Amount": { @@ -11484,6 +11493,12 @@ "traits": { "smithy.api#documentation": "

    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

    " } + }, + "Period": { + "target": "com.amazonaws.redshift#UsageLimitPeriod", + "traits": { + "smithy.api#documentation": "

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

    " + } } }, "traits": { @@ -11555,17 +11570,17 @@ "com.amazonaws.redshift#UsageLimitList": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.redshift#String", - "traits": { - "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " - } - }, "UsageLimits": { "target": "com.amazonaws.redshift#UsageLimits", "traits": { "smithy.api#documentation": "

    Contains the output from the DescribeUsageLimits\n action.

    " } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

    A value that indicates the starting point for the next set of response records in a\n subsequent request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.

    " + } } } }, @@ -11628,16 +11643,16 @@ "com.amazonaws.redshift#VpcSecurityGroupMembership": { "type": "structure", "members": { - "VpcSecurityGroupId": { + "Status": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The identifier of the VPC security group.

    " + "smithy.api#documentation": "

    The status of the VPC security group.

    " } }, - "Status": { + "VpcSecurityGroupId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

    The status of the VPC security group.

    " + "smithy.api#documentation": "

    The identifier of the VPC security group.

    " } } }, 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 6ed955f7f025..fc1baa31ff76 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json +++ b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json @@ -53,16 +53,16 @@ "com.amazonaws.rekognition#AgeRange": { "type": "structure", "members": { - "High": { + "Low": { "target": "com.amazonaws.rekognition#UInteger", "traits": { - "smithy.api#documentation": "

    The highest estimated age.

    " + "smithy.api#documentation": "

    The lowest estimated age.

    " } }, - "Low": { + "High": { "target": "com.amazonaws.rekognition#UInteger", "traits": { - "smithy.api#documentation": "

    The lowest estimated age.

    " + "smithy.api#documentation": "

    The highest estimated age.

    " } } }, @@ -78,7 +78,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Assets are the images that you use to train and evaluate a model version. \n Assets are referenced by Sagemaker GroundTruth manifest files.\n

    " + "smithy.api#documentation": "

    Assets are the images that you use to train and evaluate a model version. \n Assets can also contain validation information that you use to debug a failed model training.\n

    " } }, "com.amazonaws.rekognition#Assets": { @@ -111,16 +111,16 @@ "com.amazonaws.rekognition#AudioMetadata": { "type": "structure", "members": { - "NumberOfChannels": { + "DurationMillis": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "

    The number of audio channels in the segement.

    " + "smithy.api#documentation": "

    The duration of the audio stream in milliseconds.

    " } }, - "DurationMillis": { + "SampleRate": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "

    The duration of the audio stream in milliseconds.

    " + "smithy.api#documentation": "

    The sample rate for the audio stream.

    " } }, "Codec": { @@ -129,10 +129,10 @@ "smithy.api#documentation": "

    The audio codec used to encode or decode the audio stream.

    " } }, - "SampleRate": { + "NumberOfChannels": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "

    The sample rate for the audio stream.

    " + "smithy.api#documentation": "

    The number of audio channels in the segment.

    " } } }, @@ -149,56 +149,85 @@ "com.amazonaws.rekognition#Beard": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.rekognition#Boolean", - "traits": { - "smithy.api#documentation": "

    Boolean value that indicates whether the face has beard or not.

    " - } - }, "Confidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { "smithy.api#documentation": "

    Level of confidence in the determination.

    " } + }, + "Value": { + "target": "com.amazonaws.rekognition#Boolean", + "traits": { + "smithy.api#documentation": "

    Boolean value that indicates whether the face has beard or not.

    " + } } }, "traits": { "smithy.api#documentation": "

    Indicates whether or not the face has a beard, and the confidence level in the\n determination.

    " } }, + "com.amazonaws.rekognition#BodyPart": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FACE", + "name": "FACE" + }, + { + "value": "HEAD", + "name": "HEAD" + }, + { + "value": "LEFT_HAND", + "name": "LEFT_HAND" + }, + { + "value": "RIGHT_HAND", + "name": "RIGHT_HAND" + } + ] + } + }, + "com.amazonaws.rekognition#BodyParts": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentBodyPart" + } + }, "com.amazonaws.rekognition#Boolean": { "type": "boolean" }, "com.amazonaws.rekognition#BoundingBox": { "type": "structure", "members": { - "Width": { + "Left": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    Width of the bounding box as a ratio of the overall image width.

    " + "smithy.api#documentation": "

    Left coordinate of the bounding box as a ratio of overall image width.

    " } }, - "Height": { + "Top": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    Height of the bounding box as a ratio of the overall image height.

    " + "smithy.api#documentation": "

    Top coordinate of the bounding box as a ratio of overall image height.

    " } }, - "Left": { + "Width": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    Left coordinate of the bounding box as a ratio of overall image width.

    " + "smithy.api#documentation": "

    Width of the bounding box as a ratio of the overall image width.

    " } }, - "Top": { + "Height": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    Top coordinate of the bounding box as a ratio of overall image height.

    " + "smithy.api#documentation": "

    Height of the bounding box as a ratio of the overall image height.

    " } } }, "traits": { - "smithy.api#documentation": "

    Identifies the bounding box around the label, face, or text. The left\n (x-coordinate) and top (y-coordinate) are coordinates representing the top and\n left sides of the bounding box. Note that the upper-left corner of the image is the origin\n (0,0).

    \n

    The top and left values returned are ratios of the overall\n image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\n the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700)\n and a top value of 0.25 (50/200).

    \n

    The width and height values represent the dimensions of the\n bounding box as a ratio of the overall image dimension. For example, if the input image is\n 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

    \n \n

    The bounding box coordinates can have negative values. For example, if Amazon Rekognition is\n able to detect a face that is at the image edge and is only partially visible, the service\n can return coordinates that are outside the image bounds and, depending on the image edge,\n you might get negative values or values greater than 1 for the left or\n top values.

    \n     " + "smithy.api#documentation": "

    Identifies the bounding box around the label, face, text or personal protective equipment.\n The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and\n left sides of the bounding box. Note that the upper-left corner of the image is the origin\n (0,0).

    \n

    The top and left values returned are ratios of the overall\n image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\n the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700)\n and a top value of 0.25 (50/200).

    \n

    The width and height values represent the dimensions of the\n bounding box as a ratio of the overall image dimension. For example, if the input image is\n 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

    \n \n

    The bounding box coordinates can have negative values. For example, if Amazon Rekognition is\n able to detect a face that is at the image edge and is only partially visible, the service\n can return coordinates that are outside the image bounds and, depending on the image edge,\n you might get negative values or values greater than 1 for the left or\n top values.

    \n     " } }, "com.amazonaws.rekognition#BoundingBoxHeight": { @@ -224,34 +253,34 @@ "com.amazonaws.rekognition#Celebrity": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.rekognition#RekognitionUniqueId", + "Urls": { + "target": "com.amazonaws.rekognition#Urls", "traits": { - "smithy.api#documentation": "

    A unique identifier for the celebrity.

    " + "smithy.api#documentation": "

    An array of URLs pointing to additional information about the celebrity. If there is no\n additional information about the celebrity, this list is empty.

    " } }, - "MatchConfidence": { - "target": "com.amazonaws.rekognition#Percent", + "Face": { + "target": "com.amazonaws.rekognition#ComparedFace", "traits": { - "smithy.api#documentation": "

    The confidence, in percentage, that Amazon Rekognition has that the recognized face is the\n celebrity.

    " + "smithy.api#documentation": "

    Provides information about the celebrity's face, such as its location on the\n image.

    " } }, - "Name": { - "target": "com.amazonaws.rekognition#String", + "Id": { + "target": "com.amazonaws.rekognition#RekognitionUniqueId", "traits": { - "smithy.api#documentation": "

    The name of the celebrity.

    " + "smithy.api#documentation": "

    A unique identifier for the celebrity.

    " } }, - "Urls": { - "target": "com.amazonaws.rekognition#Urls", + "Name": { + "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    An array of URLs pointing to additional information about the celebrity. If there is no\n additional information about the celebrity, this list is empty.

    " + "smithy.api#documentation": "

    The name of the celebrity.

    " } }, - "Face": { - "target": "com.amazonaws.rekognition#ComparedFace", + "MatchConfidence": { + "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

    Provides information about the celebrity's face, such as its location on the\n image.

    " + "smithy.api#documentation": "

    The confidence, in percentage, that Amazon Rekognition has that the recognized face is the\n celebrity.

    " } } }, @@ -262,16 +291,10 @@ "com.amazonaws.rekognition#CelebrityDetail": { "type": "structure", "members": { - "BoundingBox": { - "target": "com.amazonaws.rekognition#BoundingBox", - "traits": { - "smithy.api#documentation": "

    Bounding box around the body of a celebrity.

    " - } - }, - "Name": { - "target": "com.amazonaws.rekognition#String", + "Id": { + "target": "com.amazonaws.rekognition#RekognitionUniqueId", "traits": { - "smithy.api#documentation": "

    The name of the celebrity.

    " + "smithy.api#documentation": "

    The unique identifier for the celebrity.

    " } }, "Confidence": { @@ -280,22 +303,28 @@ "smithy.api#documentation": "

    The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.

    " } }, + "Face": { + "target": "com.amazonaws.rekognition#FaceDetail", + "traits": { + "smithy.api#documentation": "

    Face details for the recognized celebrity.

    " + } + }, "Urls": { "target": "com.amazonaws.rekognition#Urls", "traits": { "smithy.api#documentation": "

    An array of URLs pointing to additional celebrity information.

    " } }, - "Face": { - "target": "com.amazonaws.rekognition#FaceDetail", + "Name": { + "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    Face details for the recognized celebrity.

    " + "smithy.api#documentation": "

    The name of the celebrity.

    " } }, - "Id": { - "target": "com.amazonaws.rekognition#RekognitionUniqueId", + "BoundingBox": { + "target": "com.amazonaws.rekognition#BoundingBox", "traits": { - "smithy.api#documentation": "

    The unique identifier for the celebrity.

    " + "smithy.api#documentation": "

    Bounding box around the body of a celebrity.

    " } } }, @@ -411,23 +440,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Compares a face in the source input image with\n each of the 100 largest faces detected in the target input image.\n

    \n \n

    If the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image.

    \n     \n\n\n

    You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.

    \n

    In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

    \n\n \n

    By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

    \n     \n\n

    \n CompareFaces also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.

    \n \n

    The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use QualityFilter to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default value is NONE.

    \n \n

    To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.

    \n     \n

    If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.

    \n

    If no faces are detected in the source or target images, CompareFaces returns an \n InvalidParameterException error.

    \n\n\n \n

    This is a stateless API operation. That is, data returned by this operation doesn't persist.

    \n     \n\n \n

    For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

    \n

    This operation requires permissions to perform the rekognition:CompareFaces\n action.

    " + "smithy.api#documentation": "

    Compares a face in the source input image with\n each of the 100 largest faces detected in the target input image.\n

    \n \n

    If the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image.

    \n     \n\n\n

    You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.

    \n

    In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

    \n\n \n

    By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

    \n     \n\n

    \n CompareFaces also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.

    \n \n

    The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use QualityFilter to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default value is NONE.

    \n\n

    If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.

    \n

    If no faces are detected in the source or target images, CompareFaces returns an \n InvalidParameterException error.

    \n\n\n \n

    This is a stateless API operation. That is, data returned by this operation doesn't persist.

    \n     \n\n \n

    For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

    \n

    This operation requires permissions to perform the rekognition:CompareFaces\n action.

    " } }, "com.amazonaws.rekognition#CompareFacesMatch": { "type": "structure", "members": { - "Similarity": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Level of confidence that the faces match.

    " - } - }, "Face": { "target": "com.amazonaws.rekognition#ComparedFace", "traits": { "smithy.api#documentation": "

    Provides face metadata (bounding box and confidence that the bounding box actually\n contains a face).

    " } + }, + "Similarity": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Level of confidence that the faces match.

    " + } } }, "traits": { @@ -443,6 +472,12 @@ "com.amazonaws.rekognition#CompareFacesRequest": { "type": "structure", "members": { + "QualityFilter": { + "target": "com.amazonaws.rekognition#QualityFilter", + "traits": { + "smithy.api#documentation": "

    A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar.\n If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed. The default value is NONE.\n

    \n

    To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

    " + } + }, "SourceImage": { "target": "com.amazonaws.rekognition#Image", "traits": { @@ -450,12 +485,6 @@ "smithy.api#required": {} } }, - "QualityFilter": { - "target": "com.amazonaws.rekognition#QualityFilter", - "traits": { - "smithy.api#documentation": "

    A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar.\n If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed. The default value is NONE.\n

    \n

    To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

    " - } - }, "TargetImage": { "target": "com.amazonaws.rekognition#Image", "traits": { @@ -480,18 +509,6 @@ "smithy.api#documentation": "

    The value of TargetImageOrientationCorrection is always null.

    \n

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.

    \n

    Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n

    " } }, - "SourceImageFace": { - "target": "com.amazonaws.rekognition#ComparedSourceImageFace", - "traits": { - "smithy.api#documentation": "

    The face in the source image that was used for comparison.

    " - } - }, - "FaceMatches": { - "target": "com.amazonaws.rekognition#CompareFacesMatchList", - "traits": { - "smithy.api#documentation": "

    An array of faces in the target image that match the source image face. Each\n CompareFacesMatch object provides the bounding box, the confidence level that\n the bounding box contains a face, and the similarity score for the face in the bounding box\n and the face in the source image.

    " - } - }, "UnmatchedFaces": { "target": "com.amazonaws.rekognition#CompareFacesUnmatchList", "traits": { @@ -503,6 +520,18 @@ "traits": { "smithy.api#documentation": "

    The value of SourceImageOrientationCorrection is always null.

    \n

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.

    \n

    Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n

    " } + }, + "SourceImageFace": { + "target": "com.amazonaws.rekognition#ComparedSourceImageFace", + "traits": { + "smithy.api#documentation": "

    The face in the source image that was used for comparison.

    " + } + }, + "FaceMatches": { + "target": "com.amazonaws.rekognition#CompareFacesMatchList", + "traits": { + "smithy.api#documentation": "

    An array of faces in the target image that match the source image face. Each\n CompareFacesMatch object provides the bounding box, the confidence level that\n the bounding box contains a face, and the similarity score for the face in the bounding box\n and the face in the source image.

    " + } } } }, @@ -515,16 +544,16 @@ "com.amazonaws.rekognition#ComparedFace": { "type": "structure", "members": { - "Landmarks": { - "target": "com.amazonaws.rekognition#Landmarks", + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

    An array of facial landmarks.

    " + "smithy.api#documentation": "

    Level of confidence that what the bounding box contains is a face.

    " } }, - "BoundingBox": { - "target": "com.amazonaws.rekognition#BoundingBox", + "Landmarks": { + "target": "com.amazonaws.rekognition#Landmarks", "traits": { - "smithy.api#documentation": "

    Bounding box of the face.

    " + "smithy.api#documentation": "

    An array of facial landmarks.

    " } }, "Quality": { @@ -533,17 +562,17 @@ "smithy.api#documentation": "

    Identifies face image brightness and sharpness.

    " } }, - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Level of confidence that what the bounding box contains is a face.

    " - } - }, "Pose": { "target": "com.amazonaws.rekognition#Pose", "traits": { "smithy.api#documentation": "

    Indicates the pose of the face as determined by its pitch, roll, and yaw.

    " } + }, + "BoundingBox": { + "target": "com.amazonaws.rekognition#BoundingBox", + "traits": { + "smithy.api#documentation": "

    Bounding box of the face.

    " + } } }, "traits": { @@ -559,17 +588,17 @@ "com.amazonaws.rekognition#ComparedSourceImageFace": { "type": "structure", "members": { - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Confidence level that the selected bounding box contains a face.

    " - } - }, "BoundingBox": { "target": "com.amazonaws.rekognition#BoundingBox", "traits": { "smithy.api#documentation": "

    Bounding box of the face.

    " } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Confidence level that the selected bounding box contains a face.

    " + } } }, "traits": { @@ -606,17 +635,17 @@ "com.amazonaws.rekognition#ContentModerationDetection": { "type": "structure", "members": { - "ModerationLabel": { - "target": "com.amazonaws.rekognition#ModerationLabel", - "traits": { - "smithy.api#documentation": "

    The unsafe content label detected by in the stored video.

    " - } - }, "Timestamp": { "target": "com.amazonaws.rekognition#Timestamp", "traits": { "smithy.api#documentation": "

    Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.

    " } + }, + "ModerationLabel": { + "target": "com.amazonaws.rekognition#ModerationLabel", + "traits": { + "smithy.api#documentation": "

    The unsafe content label detected by in the stored video.

    " + } } }, "traits": { @@ -644,6 +673,26 @@ ] } }, + "com.amazonaws.rekognition#CoversBodyPart": { + "type": "structure", + "members": { + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    The confidence that Amazon Rekognition has in the value of Value.

    " + } + }, + "Value": { + "target": "com.amazonaws.rekognition#Boolean", + "traits": { + "smithy.api#documentation": "

    True if the PPE covers the corresponding body part, otherwise false.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an item of Personal Protective Equipment covering a corresponding body part. For more \n information, see DetectProtectiveEquipment.

    " + } + }, "com.amazonaws.rekognition#CreateCollection": { "type": "operation", "input": { @@ -691,16 +740,16 @@ "com.amazonaws.rekognition#CreateCollectionResponse": { "type": "structure", "members": { - "FaceModelVersion": { + "CollectionArn": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    Version number of the face detection model associated with the collection you are creating.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on\n your resources.

    " } }, - "CollectionArn": { + "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on\n your resources.

    " + "smithy.api#documentation": "

    Version number of the face detection model associated with the collection you are creating.

    " } }, "StatusCode": { @@ -810,13 +859,6 @@ "com.amazonaws.rekognition#CreateProjectVersionRequest": { "type": "structure", "members": { - "OutputConfig": { - "target": "com.amazonaws.rekognition#OutputConfig", - "traits": { - "smithy.api#documentation": "

    The Amazon S3 location to store the results of training.

    ", - "smithy.api#required": {} - } - }, "VersionName": { "target": "com.amazonaws.rekognition#VersionName", "traits": { @@ -824,10 +866,17 @@ "smithy.api#required": {} } }, - "ProjectArn": { - "target": "com.amazonaws.rekognition#ProjectArn", + "OutputConfig": { + "target": "com.amazonaws.rekognition#OutputConfig", "traits": { - "smithy.api#documentation": "

    The ARN of the Amazon Rekognition Custom Labels project that \n manages the model that you want to train.

    ", + "smithy.api#documentation": "

    The Amazon S3 location to store the results of training.

    ", + "smithy.api#required": {} + } + }, + "TestingData": { + "target": "com.amazonaws.rekognition#TestingData", + "traits": { + "smithy.api#documentation": "

    The dataset to use for testing.

    ", "smithy.api#required": {} } }, @@ -838,10 +887,10 @@ "smithy.api#required": {} } }, - "TestingData": { - "target": "com.amazonaws.rekognition#TestingData", + "ProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", "traits": { - "smithy.api#documentation": "

    The dataset to use for testing.

    ", + "smithy.api#documentation": "

    The ARN of the Amazon Rekognition Custom Labels project that \n manages the model that you want to train.

    ", "smithy.api#required": {} } } @@ -896,31 +945,31 @@ "com.amazonaws.rekognition#CreateStreamProcessorRequest": { "type": "structure", "members": { - "Settings": { - "target": "com.amazonaws.rekognition#StreamProcessorSettings", + "Output": { + "target": "com.amazonaws.rekognition#StreamProcessorOutput", "traits": { - "smithy.api#documentation": "

    Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face\n attributes to detect.

    ", + "smithy.api#documentation": "

    Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.rekognition#StreamProcessorName", + "Input": { + "target": "com.amazonaws.rekognition#StreamProcessorInput", "traits": { - "smithy.api#documentation": "

    An identifier you assign to the stream processor. You can use Name to\n manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor.\n Name is idempotent.\n

    ", + "smithy.api#documentation": "

    Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

    ", "smithy.api#required": {} } }, - "Output": { - "target": "com.amazonaws.rekognition#StreamProcessorOutput", + "Name": { + "target": "com.amazonaws.rekognition#StreamProcessorName", "traits": { - "smithy.api#documentation": "

    Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

    ", + "smithy.api#documentation": "

    An identifier you assign to the stream processor. You can use Name to\n manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor.\n Name is idempotent.\n

    ", "smithy.api#required": {} } }, - "Input": { - "target": "com.amazonaws.rekognition#StreamProcessorInput", + "Settings": { + "target": "com.amazonaws.rekognition#StreamProcessorSettings", "traits": { - "smithy.api#documentation": "

    Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

    ", + "smithy.api#documentation": "

    Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face\n attributes to detect.

    ", "smithy.api#required": {} } }, @@ -947,6 +996,12 @@ "com.amazonaws.rekognition#CustomLabel": { "type": "structure", "members": { + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    The confidence that the model has in the detection of the custom label. The \n range is 0-100. A higher value indicates a higher confidence.

    " + } + }, "Name": { "target": "com.amazonaws.rekognition#String", "traits": { @@ -958,12 +1013,6 @@ "traits": { "smithy.api#documentation": "

    The location of the detected object on the image that corresponds to the custom label. \n Includes an axis aligned coarse bounding box surrounding the object and a finer grain polygon\n for more accurate spatial information.

    " } - }, - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    The confidence that the model has in the detection of the custom label. The \n range is 0-100. A higher value indicates a higher confidence.

    " - } } }, "traits": { @@ -1320,22 +1369,16 @@ "com.amazonaws.rekognition#DescribeCollectionResponse": { "type": "structure", "members": { - "CreationTimestamp": { - "target": "com.amazonaws.rekognition#DateTime", - "traits": { - "smithy.api#documentation": "

    The number of milliseconds since the Unix epoch time until the creation of the collection.\n The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

    " - } - }, "CollectionARN": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the collection.

    " } }, - "FaceModelVersion": { - "target": "com.amazonaws.rekognition#String", + "CreationTimestamp": { + "target": "com.amazonaws.rekognition#DateTime", "traits": { - "smithy.api#documentation": "

    The version of the face model that's used by the collection for face detection.

    \n \n

    For more information, see Model Versioning in the \n Amazon Rekognition Developer Guide.

    " + "smithy.api#documentation": "

    The number of milliseconds since the Unix epoch time until the creation of the collection.\n The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

    " } }, "FaceCount": { @@ -1343,6 +1386,12 @@ "traits": { "smithy.api#documentation": "

    The number of faces that are indexed into the collection. To index faces into a\n collection, use IndexFaces.

    " } + }, + "FaceModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

    The version of the face model that's used by the collection for face detection.

    \n \n

    For more information, see Model Versioning in the \n Amazon Rekognition Developer Guide.

    " + } } } }, @@ -1390,10 +1439,11 @@ "com.amazonaws.rekognition#DescribeProjectVersionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.rekognition#ExtendedPaginationToken", + "ProjectArn": { + "target": "com.amazonaws.rekognition#ProjectArn", "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

    ", + "smithy.api#required": {} } }, "MaxResults": { @@ -1402,11 +1452,10 @@ "smithy.api#documentation": "

    The maximum number of results to return per paginated call. \n The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.

    " } }, - "ProjectArn": { - "target": "com.amazonaws.rekognition#ProjectArn", + "NextToken": { + "target": "com.amazonaws.rekognition#ExtendedPaginationToken", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

    " } }, "VersionNames": { @@ -1553,6 +1602,18 @@ "com.amazonaws.rekognition#DescribeStreamProcessorResponse": { "type": "structure", "members": { + "StreamProcessorArn": { + "target": "com.amazonaws.rekognition#StreamProcessorArn", + "traits": { + "smithy.api#documentation": "

    ARN of the stream processor.

    " + } + }, + "Status": { + "target": "com.amazonaws.rekognition#StreamProcessorStatus", + "traits": { + "smithy.api#documentation": "

    Current status of the stream processor.

    " + } + }, "RoleArn": { "target": "com.amazonaws.rekognition#RoleArn", "traits": { @@ -1565,12 +1626,6 @@ "smithy.api#documentation": "

    The time, in Unix format, the stream processor was last updated. For example, when the stream\n processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

    " } }, - "Status": { - "target": "com.amazonaws.rekognition#StreamProcessorStatus", - "traits": { - "smithy.api#documentation": "

    Current status of the stream processor.

    " - } - }, "Input": { "target": "com.amazonaws.rekognition#StreamProcessorInput", "traits": { @@ -1595,23 +1650,17 @@ "smithy.api#documentation": "

    Name of the stream processor.

    " } }, - "CreationTimestamp": { - "target": "com.amazonaws.rekognition#DateTime", - "traits": { - "smithy.api#documentation": "

    Date and time the stream processor was created

    " - } - }, - "StreamProcessorArn": { - "target": "com.amazonaws.rekognition#StreamProcessorArn", - "traits": { - "smithy.api#documentation": "

    ARN of the stream processor.

    " - } - }, "Output": { "target": "com.amazonaws.rekognition#StreamProcessorOutput", "traits": { "smithy.api#documentation": "

    Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

    " } + }, + "CreationTimestamp": { + "target": "com.amazonaws.rekognition#DateTime", + "traits": { + "smithy.api#documentation": "

    Date and time the stream processor was created

    " + } } } }, @@ -1677,16 +1726,16 @@ "smithy.api#documentation": "

    Maximum number of results you want the service to return in the response. \n The service returns the specified number of highest confidence labels ranked from highest confidence \n to lowest.

    " } }, - "Image": { - "target": "com.amazonaws.rekognition#Image", + "ProjectVersionArn": { + "target": "com.amazonaws.rekognition#ProjectVersionArn", "traits": { + "smithy.api#documentation": "

    The ARN of the model version that you want to use.

    ", "smithy.api#required": {} } }, - "ProjectVersionArn": { - "target": "com.amazonaws.rekognition#ProjectVersionArn", + "Image": { + "target": "com.amazonaws.rekognition#Image", "traits": { - "smithy.api#documentation": "

    The ARN of the model version that you want to use.

    ", "smithy.api#required": {} } } @@ -1744,18 +1793,18 @@ "com.amazonaws.rekognition#DetectFacesRequest": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.rekognition#Attributes", - "traits": { - "smithy.api#documentation": "

    An array of facial attributes you want to be returned. This can be the default list of\n attributes or all attributes. If you don't specify a value for Attributes or if\n you specify [\"DEFAULT\"], the API returns the following subset of facial\n attributes: BoundingBox, Confidence, Pose,\n Quality, and Landmarks. If you provide [\"ALL\"], all\n facial attributes are returned, but the operation takes longer to complete.

    \n

    If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes).

    " - } - }, "Image": { "target": "com.amazonaws.rekognition#Image", "traits": { "smithy.api#documentation": "

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    \n

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.

    ", "smithy.api#required": {} } + }, + "Attributes": { + "target": "com.amazonaws.rekognition#Attributes", + "traits": { + "smithy.api#documentation": "

    An array of facial attributes you want to be returned. This can be the default list of\n attributes or all attributes. If you don't specify a value for Attributes or if\n you specify [\"DEFAULT\"], the API returns the following subset of facial\n attributes: BoundingBox, Confidence, Pose,\n Quality, and Landmarks. If you provide [\"ALL\"], all\n facial attributes are returned, but the operation takes longer to complete.

    \n

    If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes).

    " + } } } }, @@ -1817,6 +1866,12 @@ "com.amazonaws.rekognition#DetectLabelsRequest": { "type": "structure", "members": { + "MinConfidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't\n return any labels with confidence lower than this specified value.

    \n

    If MinConfidence is not specified, the operation returns labels with a\n confidence values greater than or equal to 55 percent.

    " + } + }, "Image": { "target": "com.amazonaws.rekognition#Image", "traits": { @@ -1824,12 +1879,6 @@ "smithy.api#required": {} } }, - "MinConfidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't\n return any labels with confidence lower than this specified value.

    \n

    If MinConfidence is not specified, the operation returns labels with a\n confidence values greater than or equal to 55 percent.

    " - } - }, "MaxLabels": { "target": "com.amazonaws.rekognition#UInteger", "traits": { @@ -1841,18 +1890,18 @@ "com.amazonaws.rekognition#DetectLabelsResponse": { "type": "structure", "members": { - "OrientationCorrection": { - "target": "com.amazonaws.rekognition#OrientationCorrection", - "traits": { - "smithy.api#documentation": "

    The value of OrientationCorrection is always null.

    \n

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.

    \n

    Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n

    " - } - }, "LabelModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    Version number of the label detection model that was used to detect labels.

    " } }, + "OrientationCorrection": { + "target": "com.amazonaws.rekognition#OrientationCorrection", + "traits": { + "smithy.api#documentation": "

    The value of OrientationCorrection is always null.

    \n

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction. The bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata.

    \n

    Amazon Rekognition doesn’t perform image correction for images in .png format and\n .jpeg images without orientation information in the image Exif metadata. The bounding box\n coordinates aren't translated and represent the object locations before the image is rotated.\n

    " + } + }, "Labels": { "target": "com.amazonaws.rekognition#Labels", "traits": { @@ -1929,22 +1978,101 @@ "com.amazonaws.rekognition#DetectModerationLabelsResponse": { "type": "structure", "members": { + "ModerationModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

    Version number of the moderation detection model that was used to detect unsafe content.

    " + } + }, "HumanLoopActivationOutput": { "target": "com.amazonaws.rekognition#HumanLoopActivationOutput", "traits": { "smithy.api#documentation": "

    Shows the results of the human in the loop evaluation.

    " } }, - "ModerationModelVersion": { + "ModerationLabels": { + "target": "com.amazonaws.rekognition#ModerationLabels", + "traits": { + "smithy.api#documentation": "

    Array of detected Moderation labels and the time, in milliseconds from the\n start of the video, they were detected.

    " + } + } + } + }, + "com.amazonaws.rekognition#DetectProtectiveEquipment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#DetectProtectiveEquipmentRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#DetectProtectiveEquipmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#ImageTooLargeException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidImageFormatException" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#InvalidS3ObjectException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the \n following types of PPE.

    \n
      \n
    • \n

      Face cover

      \n
      • \n
    • \n

      Hand cover

      \n
      • \n
    • \n

      Head cover

      \n
      • \n
    \n \n

    You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.\n The image must be either a PNG or JPG formatted file.

    \n \n

    \n DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

    \n

    For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).\n For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE\n covers the body part. The API returns the confidence it has in each detection\n (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected \n person and each detected item of PPE.

    \n

    You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter.\n The summary provides the following information.

    \n
      \n
    • \n

      The persons detected as wearing all of the types of PPE that you specify.

      \n
      • \n
    • \n

      The persons detected as not wearing all of the types PPE that you specify.

      \n
      • \n
    • \n

      The persons detected where PPE adornment could not be determined.

      \n
      • \n
    \n

    This is a stateless API operation. That is, the operation does not persist any data.

    \n \n

    This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.

    " + } + }, + "com.amazonaws.rekognition#DetectProtectiveEquipmentRequest": { + "type": "structure", + "members": { + "SummarizationAttributes": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentSummarizationAttributes", + "traits": { + "smithy.api#documentation": "

    An array of PPE types that you want to summarize.

    " + } + }, + "Image": { + "target": "com.amazonaws.rekognition#Image", + "traits": { + "smithy.api#documentation": "

    The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can \n reference an image stored in an Amazon S3 bucket.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rekognition#DetectProtectiveEquipmentResponse": { + "type": "structure", + "members": { + "Persons": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentPersons", + "traits": { + "smithy.api#documentation": "

    An array of persons detected in the image (including persons not wearing PPE).

    " + } + }, + "ProtectiveEquipmentModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    Version number of the moderation detection model that was used to detect unsafe content.

    " + "smithy.api#documentation": "

    The version number of the PPE detection model used to detect PPE in the image.

    " } }, - "ModerationLabels": { - "target": "com.amazonaws.rekognition#ModerationLabels", + "Summary": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentSummary", "traits": { - "smithy.api#documentation": "

    Array of detected Moderation labels and the time, in milliseconds from the\n start of the video, they were detected.

    " + "smithy.api#documentation": "

    Summary information for the types of PPE specified in the SummarizationAttributes input\n parameter.

    " } } } @@ -1990,14 +2118,14 @@ "com.amazonaws.rekognition#DetectTextFilters": { "type": "structure", "members": { - "WordFilter": { - "target": "com.amazonaws.rekognition#DetectionFilter" - }, "RegionsOfInterest": { "target": "com.amazonaws.rekognition#RegionsOfInterest", "traits": { "smithy.api#documentation": "

    A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region\n of the image.

    " } + }, + "WordFilter": { + "target": "com.amazonaws.rekognition#DetectionFilter" } }, "traits": { @@ -2025,24 +2153,30 @@ "com.amazonaws.rekognition#DetectTextResponse": { "type": "structure", "members": { - "TextModelVersion": { - "target": "com.amazonaws.rekognition#String", - "traits": { - "smithy.api#documentation": "

    The model version used to detect text.

    " - } - }, "TextDetections": { "target": "com.amazonaws.rekognition#TextDetectionList", "traits": { "smithy.api#documentation": "

    An array of text that was detected in the input image.

    " } + }, + "TextModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

    The model version used to detect text.

    " + } } } }, "com.amazonaws.rekognition#DetectionFilter": { "type": "structure", "members": { - "MinBoundingBoxHeight": { + "MinConfidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Sets confidence of word detection. Words with detection confidence below this will be excluded \n from the result. Values should be between 0.5 and 1 as Text in Video will not return any result below \n 0.5.

    " + } + }, + "MinBoundingBoxHeight": { "target": "com.amazonaws.rekognition#BoundingBoxHeight", "traits": { "smithy.api#documentation": "

    Sets the minimum height of the word bounding box. Words with bounding box heights lesser than \n this value will be excluded from the result. Value is relative to the video frame height.

    " @@ -2053,12 +2187,6 @@ "traits": { "smithy.api#documentation": "

    Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than \n this value will be excluded from the result. Value is relative to the video frame width.

    " } - }, - "MinConfidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Sets confidence of word detection. Words with detection confidence below this will be excluded \n from the result. Values should be between 0.5 and 1 as Text in Video will not return any result below \n 0.5.

    " - } } }, "traits": { @@ -2068,17 +2196,17 @@ "com.amazonaws.rekognition#Emotion": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.rekognition#EmotionName", - "traits": { - "smithy.api#documentation": "

    Type of emotion detected.

    " - } - }, "Confidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { "smithy.api#documentation": "

    Level of confidence in the determination.

    " } + }, + "Type": { + "target": "com.amazonaws.rekognition#EmotionName", + "traits": { + "smithy.api#documentation": "

    Type of emotion detected.

    " + } } }, "traits": { @@ -2125,20 +2253,58 @@ "target": "com.amazonaws.rekognition#Emotion" } }, - "com.amazonaws.rekognition#EvaluationResult": { + "com.amazonaws.rekognition#EquipmentDetection": { "type": "structure", "members": { - "F1Score": { - "target": "com.amazonaws.rekognition#Float", + "BoundingBox": { + "target": "com.amazonaws.rekognition#BoundingBox", "traits": { - "smithy.api#documentation": "

    The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision\n and recall performance of the model as a single value. A higher value indicates better precision\n and recall performance. A lower score indicates that precision, recall, or both are performing poorly.\n \n

    " + "smithy.api#documentation": "

    A bounding box surrounding the item of detected PPE.

    " + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    The confidence that Amazon Rekognition has that the bounding box (BoundingBox) contains an item of PPE.

    " } }, + "CoversBodyPart": { + "target": "com.amazonaws.rekognition#CoversBodyPart", + "traits": { + "smithy.api#documentation": "

    Information about the body part covered by the detected PPE.

    " + } + }, + "Type": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentType", + "traits": { + "smithy.api#documentation": "

    The type of detected PPE.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an item of Personal Protective Equipment (PPE) detected by\n DetectProtectiveEquipment. For more \n information, see DetectProtectiveEquipment.

    " + } + }, + "com.amazonaws.rekognition#EquipmentDetections": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#EquipmentDetection" + } + }, + "com.amazonaws.rekognition#EvaluationResult": { + "type": "structure", + "members": { "Summary": { "target": "com.amazonaws.rekognition#Summary", "traits": { "smithy.api#documentation": "

    The S3 bucket that contains the training summary.

    " } + }, + "F1Score": { + "target": "com.amazonaws.rekognition#Float", + "traits": { + "smithy.api#documentation": "

    The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision\n and recall performance of the model as a single value. A higher value indicates better precision\n and recall performance. A lower score indicates that precision, recall, or both are performing poorly.\n \n

    " + } } }, "traits": { @@ -2167,17 +2333,17 @@ "com.amazonaws.rekognition#EyeOpen": { "type": "structure", "members": { - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Level of confidence in the determination.

    " - } - }, "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { "smithy.api#documentation": "

    Boolean value that indicates whether the eyes on the face are open.

    " } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Level of confidence in the determination.

    " + } } }, "traits": { @@ -2187,17 +2353,17 @@ "com.amazonaws.rekognition#Eyeglasses": { "type": "structure", "members": { - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Level of confidence in the determination.

    " - } - }, "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { "smithy.api#documentation": "

    Boolean value that indicates whether the face is wearing eye glasses or not.

    " } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Level of confidence in the determination.

    " + } } }, "traits": { @@ -2207,10 +2373,10 @@ "com.amazonaws.rekognition#Face": { "type": "structure", "members": { - "FaceId": { - "target": "com.amazonaws.rekognition#FaceId", + "BoundingBox": { + "target": "com.amazonaws.rekognition#BoundingBox", "traits": { - "smithy.api#documentation": "

    Unique identifier that Amazon Rekognition assigns to the face.

    " + "smithy.api#documentation": "

    Bounding box of the face.

    " } }, "Confidence": { @@ -2225,17 +2391,17 @@ "smithy.api#documentation": "

    Unique identifier that Amazon Rekognition assigns to the input image.

    " } }, - "BoundingBox": { - "target": "com.amazonaws.rekognition#BoundingBox", - "traits": { - "smithy.api#documentation": "

    Bounding box of the face.

    " - } - }, "ExternalImageId": { "target": "com.amazonaws.rekognition#ExternalImageId", "traits": { "smithy.api#documentation": "

    Identifier that you assign to all the faces in the input image.

    " } + }, + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "

    Unique identifier that Amazon Rekognition assigns to the face.

    " + } } }, "traits": { @@ -2260,58 +2426,46 @@ "com.amazonaws.rekognition#FaceDetail": { "type": "structure", "members": { - "MouthOpen": { - "target": "com.amazonaws.rekognition#MouthOpen", - "traits": { - "smithy.api#documentation": "

    Indicates whether or not the mouth on the face is open, and the confidence level in the\n determination.

    " - } - }, - "Sunglasses": { - "target": "com.amazonaws.rekognition#Sunglasses", - "traits": { - "smithy.api#documentation": "

    Indicates whether or not the face is wearing sunglasses, and the confidence level in\n the determination.

    " - } - }, "EyesOpen": { "target": "com.amazonaws.rekognition#EyeOpen", "traits": { "smithy.api#documentation": "

    Indicates whether or not the eyes on the face are open, and the confidence level in the\n determination.

    " } }, - "Gender": { - "target": "com.amazonaws.rekognition#Gender", + "Quality": { + "target": "com.amazonaws.rekognition#ImageQuality", "traits": { - "smithy.api#documentation": "

    The predicted gender of a detected face.\n

    " + "smithy.api#documentation": "

    Identifies image brightness and sharpness. Default attribute.

    " } }, - "Mustache": { - "target": "com.amazonaws.rekognition#Mustache", + "MouthOpen": { + "target": "com.amazonaws.rekognition#MouthOpen", "traits": { - "smithy.api#documentation": "

    Indicates whether or not the face has a mustache, and the confidence level in the\n determination.

    " + "smithy.api#documentation": "

    Indicates whether or not the mouth on the face is open, and the confidence level in the\n determination.

    " } }, - "Quality": { - "target": "com.amazonaws.rekognition#ImageQuality", + "BoundingBox": { + "target": "com.amazonaws.rekognition#BoundingBox", "traits": { - "smithy.api#documentation": "

    Identifies image brightness and sharpness. Default attribute.

    " + "smithy.api#documentation": "

    Bounding box of the face. Default attribute.

    " } }, - "Eyeglasses": { - "target": "com.amazonaws.rekognition#Eyeglasses", + "Pose": { + "target": "com.amazonaws.rekognition#Pose", "traits": { - "smithy.api#documentation": "

    Indicates whether or not the face is wearing eye glasses, and the confidence level in\n the determination.

    " + "smithy.api#documentation": "

    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

    " } }, - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", + "Landmarks": { + "target": "com.amazonaws.rekognition#Landmarks", "traits": { - "smithy.api#documentation": "

    Confidence level that the bounding box contains a face (and not a different object such\n as a tree). Default attribute.

    " + "smithy.api#documentation": "

    Indicates the location of landmarks on the face. Default attribute.

    " } }, - "Smile": { - "target": "com.amazonaws.rekognition#Smile", + "Emotions": { + "target": "com.amazonaws.rekognition#Emotions", "traits": { - "smithy.api#documentation": "

    Indicates whether or not the face is smiling, and the confidence level in the\n determination.

    " + "smithy.api#documentation": "

    The emotions that appear to be expressed on the face, and the confidence level in the determination. \n The API is only making a determination of the physical appearance of a person's face. It is not a determination\n of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have\n a sad face might not be sad emotionally.

    " } }, "Beard": { @@ -2320,34 +2474,46 @@ "smithy.api#documentation": "

    Indicates whether or not the face has a beard, and the confidence level in the\n determination.

    " } }, - "Emotions": { - "target": "com.amazonaws.rekognition#Emotions", + "AgeRange": { + "target": "com.amazonaws.rekognition#AgeRange", "traits": { - "smithy.api#documentation": "

    The emotions that appear to be expressed on the face, and the confidence level in the determination. \n The API is only making a determination of the physical appearance of a person's face. It is not a determination\n of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have\n a sad face might not be sad emotionally.

    " + "smithy.api#documentation": "

    The estimated age range, in years, for the face. Low represents the lowest estimated\n age and High represents the highest estimated age.

    " } }, - "BoundingBox": { - "target": "com.amazonaws.rekognition#BoundingBox", + "Sunglasses": { + "target": "com.amazonaws.rekognition#Sunglasses", "traits": { - "smithy.api#documentation": "

    Bounding box of the face. Default attribute.

    " + "smithy.api#documentation": "

    Indicates whether or not the face is wearing sunglasses, and the confidence level in\n the determination.

    " } }, - "Landmarks": { - "target": "com.amazonaws.rekognition#Landmarks", + "Mustache": { + "target": "com.amazonaws.rekognition#Mustache", "traits": { - "smithy.api#documentation": "

    Indicates the location of landmarks on the face. Default attribute.

    " + "smithy.api#documentation": "

    Indicates whether or not the face has a mustache, and the confidence level in the\n determination.

    " } }, - "AgeRange": { - "target": "com.amazonaws.rekognition#AgeRange", + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

    The estimated age range, in years, for the face. Low represents the lowest estimated\n age and High represents the highest estimated age.

    " + "smithy.api#documentation": "

    Confidence level that the bounding box contains a face (and not a different object such\n as a tree). Default attribute.

    " } }, - "Pose": { - "target": "com.amazonaws.rekognition#Pose", + "Gender": { + "target": "com.amazonaws.rekognition#Gender", "traits": { - "smithy.api#documentation": "

    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

    " + "smithy.api#documentation": "

    The predicted gender of a detected face.\n

    " + } + }, + "Eyeglasses": { + "target": "com.amazonaws.rekognition#Eyeglasses", + "traits": { + "smithy.api#documentation": "

    Indicates whether or not the face is wearing eye glasses, and the confidence level in\n the determination.

    " + } + }, + "Smile": { + "target": "com.amazonaws.rekognition#Smile", + "traits": { + "smithy.api#documentation": "

    Indicates whether or not the face is smiling, and the confidence level in the\n determination.

    " } } }, @@ -2364,17 +2530,17 @@ "com.amazonaws.rekognition#FaceDetection": { "type": "structure", "members": { - "Timestamp": { - "target": "com.amazonaws.rekognition#Timestamp", - "traits": { - "smithy.api#documentation": "

    Time, in milliseconds from the start of the video, that the face was detected.

    " - } - }, "Face": { "target": "com.amazonaws.rekognition#FaceDetail", "traits": { "smithy.api#documentation": "

    The face properties for the detected face.

    " } + }, + "Timestamp": { + "target": "com.amazonaws.rekognition#Timestamp", + "traits": { + "smithy.api#documentation": "

    Time, in milliseconds from the start of the video, that the face was detected.

    " + } } }, "traits": { @@ -2414,17 +2580,17 @@ "com.amazonaws.rekognition#FaceMatch": { "type": "structure", "members": { - "Similarity": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Confidence in the match of this face with the input face.

    " - } - }, "Face": { "target": "com.amazonaws.rekognition#Face", "traits": { "smithy.api#documentation": "

    Describes the face properties such as the bounding box, face ID, image ID of the source\n image, and external image ID that you assigned.

    " } + }, + "Similarity": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Confidence in the match of this face with the input face.

    " + } } }, "traits": { @@ -2446,17 +2612,17 @@ "com.amazonaws.rekognition#FaceRecord": { "type": "structure", "members": { - "Face": { - "target": "com.amazonaws.rekognition#Face", - "traits": { - "smithy.api#documentation": "

    Describes the face properties such as the bounding box, face ID, image ID of the input\n image, and external image ID that you assigned.

    " - } - }, "FaceDetail": { "target": "com.amazonaws.rekognition#FaceDetail", "traits": { "smithy.api#documentation": "

    Structure containing attributes of the face that the algorithm detected.

    " } + }, + "Face": { + "target": "com.amazonaws.rekognition#Face", + "traits": { + "smithy.api#documentation": "

    Describes the face properties such as the bounding box, face ID, image ID of the input\n image, and external image ID that you assigned.

    " + } } }, "traits": { @@ -2522,17 +2688,17 @@ "com.amazonaws.rekognition#Gender": { "type": "structure", "members": { - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Level of confidence in the prediction.

    " - } - }, "Value": { "target": "com.amazonaws.rekognition#GenderType", "traits": { "smithy.api#documentation": "

    The predicted gender of the face.

    " } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Level of confidence in the prediction.

    " + } } }, "traits": { @@ -2621,17 +2787,17 @@ "com.amazonaws.rekognition#GetCelebrityInfoResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.rekognition#String", - "traits": { - "smithy.api#documentation": "

    The name of the celebrity.

    " - } - }, "Urls": { "target": "com.amazonaws.rekognition#Urls", "traits": { "smithy.api#documentation": "

    An array of URLs pointing to additional celebrity information.

    " } + }, + "Name": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

    The name of the celebrity.

    " + } } } }, @@ -2678,10 +2844,11 @@ "com.amazonaws.rekognition#GetCelebrityRecognitionRequest": { "type": "structure", "members": { - "SortBy": { - "target": "com.amazonaws.rekognition#CelebrityRecognitionSortBy", + "JobId": { + "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "

    Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier,\n specify TIMESTAMP to sort by the time the celebrity was recognized.

    " + "smithy.api#documentation": "

    Job identifier for the required celebrity recognition analysis. You can get the job identifer from\n a call to StartCelebrityRecognition.

    ", + "smithy.api#required": {} } }, "MaxResults": { @@ -2696,11 +2863,10 @@ "smithy.api#documentation": "

    If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of celebrities.

    " } }, - "JobId": { - "target": "com.amazonaws.rekognition#JobId", + "SortBy": { + "target": "com.amazonaws.rekognition#CelebrityRecognitionSortBy", "traits": { - "smithy.api#documentation": "

    Job identifier for the required celebrity recognition analysis. You can get the job identifer from\n a call to StartCelebrityRecognition.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier,\n specify TIMESTAMP to sort by the time the celebrity was recognized.

    " } } } @@ -2708,22 +2874,16 @@ "com.amazonaws.rekognition#GetCelebrityRecognitionResponse": { "type": "structure", "members": { - "Celebrities": { - "target": "com.amazonaws.rekognition#CelebrityRecognitions", - "traits": { - "smithy.api#documentation": "

    Array of celebrities recognized in the video.

    " - } - }, "NextToken": { "target": "com.amazonaws.rekognition#PaginationToken", "traits": { "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request\n to retrieve the next set of celebrities.

    " } }, - "JobStatus": { - "target": "com.amazonaws.rekognition#VideoJobStatus", + "VideoMetadata": { + "target": "com.amazonaws.rekognition#VideoMetadata", "traits": { - "smithy.api#documentation": "

    The current status of the celebrity recognition job.

    " + "smithy.api#documentation": "

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in\n every page of paginated responses from a Amazon Rekognition Video operation.

    " } }, "StatusMessage": { @@ -2732,10 +2892,16 @@ "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " } }, - "VideoMetadata": { - "target": "com.amazonaws.rekognition#VideoMetadata", + "Celebrities": { + "target": "com.amazonaws.rekognition#CelebrityRecognitions", "traits": { - "smithy.api#documentation": "

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in\n every page of paginated responses from a Amazon Rekognition Video operation.

    " + "smithy.api#documentation": "

    Array of celebrities recognized in the video.

    " + } + }, + "JobStatus": { + "target": "com.amazonaws.rekognition#VideoJobStatus", + "traits": { + "smithy.api#documentation": "

    The current status of the celebrity recognition job.

    " } } } @@ -2789,18 +2955,18 @@ "smithy.api#documentation": "

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.

    " } }, - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition\n returns a pagination token in the response. You can use this pagination token\n to retrieve the next set of unsafe content labels.

    " - } - }, "SortBy": { "target": "com.amazonaws.rekognition#ContentModerationSortBy", "traits": { "smithy.api#documentation": "

    Sort to use for elements in the ModerationLabelDetections array.\n Use TIMESTAMP to sort array elements by the time labels are detected.\n Use NAME to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by TIMESTAMP.

    " } }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition\n returns a pagination token in the response. You can use this pagination token\n to retrieve the next set of unsafe content labels.

    " + } + }, "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { @@ -2813,18 +2979,6 @@ "com.amazonaws.rekognition#GetContentModerationResponse": { "type": "structure", "members": { - "JobStatus": { - "target": "com.amazonaws.rekognition#VideoJobStatus", - "traits": { - "smithy.api#documentation": "

    The current status of the unsafe content analysis job.

    " - } - }, - "ModerationLabels": { - "target": "com.amazonaws.rekognition#ContentModerationDetections", - "traits": { - "smithy.api#documentation": "

    The detected unsafe content labels and the time(s) they were detected.

    " - } - }, "NextToken": { "target": "com.amazonaws.rekognition#PaginationToken", "traits": { @@ -2837,12 +2991,24 @@ "smithy.api#documentation": "

    Version number of the moderation detection model that was used to detect unsafe content.

    " } }, + "JobStatus": { + "target": "com.amazonaws.rekognition#VideoJobStatus", + "traits": { + "smithy.api#documentation": "

    The current status of the unsafe content analysis job.

    " + } + }, "VideoMetadata": { "target": "com.amazonaws.rekognition#VideoMetadata", "traits": { "smithy.api#documentation": "

    Information about a video that Amazon Rekognition analyzed. Videometadata\n is returned in every page of paginated responses from GetContentModeration.

    " } }, + "ModerationLabels": { + "target": "com.amazonaws.rekognition#ContentModerationDetections", + "traits": { + "smithy.api#documentation": "

    The detected unsafe content labels and the time(s) they were detected.

    " + } + }, "StatusMessage": { "target": "com.amazonaws.rekognition#StatusMessage", "traits": { @@ -2894,12 +3060,6 @@ "com.amazonaws.rekognition#GetFaceDetectionRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of faces.

    " - } - }, "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { @@ -2907,6 +3067,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of faces.

    " + } + }, "MaxResults": { "target": "com.amazonaws.rekognition#MaxResults", "traits": { @@ -2918,22 +3084,16 @@ "com.amazonaws.rekognition#GetFaceDetectionResponse": { "type": "structure", "members": { - "VideoMetadata": { - "target": "com.amazonaws.rekognition#VideoMetadata", - "traits": { - "smithy.api#documentation": "

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in\n every page of paginated responses from a Amazon Rekognition video operation.

    " - } - }, "StatusMessage": { "target": "com.amazonaws.rekognition#StatusMessage", "traits": { "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " } }, - "Faces": { - "target": "com.amazonaws.rekognition#FaceDetections", + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

    An array of faces detected in the video. Each element contains a detected face's details and the time,\n in milliseconds from the start of the video, the face was detected.

    " + "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

    " } }, "JobStatus": { @@ -2942,10 +3102,16 @@ "smithy.api#documentation": "

    The current status of the face detection job.

    " } }, - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", + "VideoMetadata": { + "target": "com.amazonaws.rekognition#VideoMetadata", "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

    " + "smithy.api#documentation": "

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in\n every page of paginated responses from a Amazon Rekognition video operation.

    " + } + }, + "Faces": { + "target": "com.amazonaws.rekognition#FaceDetections", + "traits": { + "smithy.api#documentation": "

    An array of faces detected in the video. Each element contains a detected face's details and the time,\n in milliseconds from the start of the video, the face was detected.

    " } } } @@ -2999,18 +3165,18 @@ "smithy.api#documentation": "

    Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time\n that they are recognized. Use INDEX to sort by recognized faces.

    " } }, - "MaxResults": { - "target": "com.amazonaws.rekognition#MaxResults", - "traits": { - "smithy.api#documentation": "

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.

    " - } - }, "NextToken": { "target": "com.amazonaws.rekognition#PaginationToken", "traits": { "smithy.api#documentation": "

    If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of search results.

    " } }, + "MaxResults": { + "target": "com.amazonaws.rekognition#MaxResults", + "traits": { + "smithy.api#documentation": "

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. \n If you specify a value greater than 1000, a maximum of 1000 results is returned.\n The default value is 1000.

    " + } + }, "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { @@ -3041,17 +3207,17 @@ "smithy.api#documentation": "

    The current status of the face search job.

    " } }, - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

    " - } - }, "Persons": { "target": "com.amazonaws.rekognition#PersonMatches", "traits": { "smithy.api#documentation": "

    An array of persons, PersonMatch,\n in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information\n for when persons are matched in the video.\n You specify the input collection in an initial call to StartFaceSearch.\n Each Persons element includes a time the person was matched,\n face match details (FaceMatches) for matching faces in the collection,\n and person information (Person) for the matched person.

    " } + }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

    " + } } } }, @@ -3098,6 +3264,12 @@ "com.amazonaws.rekognition#GetLabelDetectionRequest": { "type": "structure", "members": { + "SortBy": { + "target": "com.amazonaws.rekognition#LabelDetectionSortBy", + "traits": { + "smithy.api#documentation": "

    Sort to use for elements in the Labels array.\n Use TIMESTAMP to sort array elements by the time labels are detected.\n Use NAME to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by TIMESTAMP.

    " + } + }, "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { @@ -3105,12 +3277,6 @@ "smithy.api#required": {} } }, - "SortBy": { - "target": "com.amazonaws.rekognition#LabelDetectionSortBy", - "traits": { - "smithy.api#documentation": "

    Sort to use for elements in the Labels array.\n Use TIMESTAMP to sort array elements by the time labels are detected.\n Use NAME to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by TIMESTAMP.

    " - } - }, "MaxResults": { "target": "com.amazonaws.rekognition#MaxResults", "traits": { @@ -3128,16 +3294,10 @@ "com.amazonaws.rekognition#GetLabelDetectionResponse": { "type": "structure", "members": { - "LabelModelVersion": { - "target": "com.amazonaws.rekognition#String", - "traits": { - "smithy.api#documentation": "

    Version number of the label detection model that was used to detect labels.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", + "StatusMessage": { + "target": "com.amazonaws.rekognition#StatusMessage", "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request\n to retrieve the next set of labels.

    " + "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " } }, "Labels": { @@ -3146,16 +3306,16 @@ "smithy.api#documentation": "

    An array of labels detected in the video. Each element contains the detected label and the time,\n in milliseconds from the start of the video, that the label was detected.

    " } }, - "JobStatus": { - "target": "com.amazonaws.rekognition#VideoJobStatus", + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

    The current status of the label detection job.

    " + "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request\n to retrieve the next set of labels.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.rekognition#StatusMessage", + "JobStatus": { + "target": "com.amazonaws.rekognition#VideoJobStatus", "traits": { - "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " + "smithy.api#documentation": "

    The current status of the label detection job.

    " } }, "VideoMetadata": { @@ -3163,6 +3323,12 @@ "traits": { "smithy.api#documentation": "

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in\n every page of paginated responses from a Amazon Rekognition video operation.

    " } + }, + "LabelModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

    Version number of the label detection model that was used to detect labels.

    " + } } } }, @@ -3215,13 +3381,6 @@ "smithy.api#documentation": "

    Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements\n by the time persons are detected. Use INDEX to sort by the tracked persons.\n If you sort by INDEX, the array elements for each person are sorted by detection confidence.\n The default sort is by TIMESTAMP.

    " } }, - "JobId": { - "target": "com.amazonaws.rekognition#JobId", - "traits": { - "smithy.api#documentation": "

    The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.\n

    ", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.rekognition#MaxResults", "traits": { @@ -3233,6 +3392,13 @@ "traits": { "smithy.api#documentation": "

    If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of persons.

    " } + }, + "JobId": { + "target": "com.amazonaws.rekognition#JobId", + "traits": { + "smithy.api#documentation": "

    The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.\n

    ", + "smithy.api#required": {} + } } } }, @@ -3251,12 +3417,6 @@ "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.

    " } }, - "Persons": { - "target": "com.amazonaws.rekognition#PersonDetections", - "traits": { - "smithy.api#documentation": "

    An array of the persons detected in the video and the time(s) their path was tracked throughout the video.\n An array element will exist for each time a person's path is tracked.

    " - } - }, "VideoMetadata": { "target": "com.amazonaws.rekognition#VideoMetadata", "traits": { @@ -3268,6 +3428,12 @@ "traits": { "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " } + }, + "Persons": { + "target": "com.amazonaws.rekognition#PersonDetections", + "traits": { + "smithy.api#documentation": "

    An array of the persons detected in the video and the time(s) their path was tracked throughout the video.\n An array element will exist for each time a person's path is tracked.

    " + } } } }, @@ -3320,58 +3486,52 @@ "smithy.api#documentation": "

    Maximum number of results to return per paginated call. The largest value you can specify is 1000.

    " } }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent \n request to retrieve the next set of text.

    " + } + }, "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { "smithy.api#documentation": "

    Job identifier for the text detection operation for which you want results returned. \n You get the job identifer from an initial call to StartSegmentDetection.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent \n request to retrieve the next set of text.

    " - } } } }, "com.amazonaws.rekognition#GetSegmentDetectionResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns \n a pagination token in the response. You can use this pagination token to retrieve the next set of text.

    " - } - }, "AudioMetadata": { "target": "com.amazonaws.rekognition#AudioMetadataList", "traits": { "smithy.api#documentation": "

    An array of \n objects. There can be multiple audio streams. \n Each AudioMetadata object contains metadata for a single audio stream.\n Audio information in an AudioMetadata objects includes \n the audio codec, the number of audio channels, the duration of the audio stream,\n and the sample rate. Audio metadata is returned in each page of information returned\n by GetSegmentDetection.

    " } }, - "Segments": { - "target": "com.amazonaws.rekognition#SegmentDetections", + "VideoMetadata": { + "target": "com.amazonaws.rekognition#VideoMetadataList", "traits": { - "smithy.api#documentation": "

    An array of segments detected in a video.

    " + "smithy.api#documentation": "

    Currently, Amazon Rekognition Video returns a single object in the\n VideoMetadata array. The object\n contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. \n The VideoMetadata object includes the video codec, video format and other information.\n Video metadata is returned in each page of information returned by GetSegmentDetection.

    " } }, - "SelectedSegmentTypes": { - "target": "com.amazonaws.rekognition#SegmentTypesInfo", + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

    An array containing the segment types requested in the call to StartSegmentDetection.\n

    " + "smithy.api#documentation": "

    If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns \n a pagination token in the response. You can use this pagination token to retrieve the next set of text.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.rekognition#StatusMessage", + "SelectedSegmentTypes": { + "target": "com.amazonaws.rekognition#SegmentTypesInfo", "traits": { - "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " + "smithy.api#documentation": "

    An array containing the segment types requested in the call to StartSegmentDetection.\n

    " } }, - "VideoMetadata": { - "target": "com.amazonaws.rekognition#VideoMetadataList", + "Segments": { + "target": "com.amazonaws.rekognition#SegmentDetections", "traits": { - "smithy.api#documentation": "

    Currently, Amazon Rekognition Video returns a single object in the\n VideoMetadata array. The object\n contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. \n The VideoMetadata object includes the video codec, video format and other information.\n Video metadata is returned in each page of information returned by GetSegmentDetection.

    " + "smithy.api#documentation": "

    An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) \n specified in the SegmentTypes input parameter of StartSegmentDetection. Within\n each segment type the array is sorted by timestamp values.

    " } }, "JobStatus": { @@ -3379,6 +3539,12 @@ "traits": { "smithy.api#documentation": "

    Current status of the segment detection job.

    " } + }, + "StatusMessage": { + "target": "com.amazonaws.rekognition#StatusMessage", + "traits": { + "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " + } } } }, @@ -3425,11 +3591,10 @@ "com.amazonaws.rekognition#GetTextDetectionRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.rekognition#JobId", + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

    Job identifier for the text detection operation for which you want results returned. \n You get the job identifer from an initial call to StartTextDetection.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns \n a pagination token in the response. You can use this pagination token to retrieve the next set of text.

    " } }, "MaxResults": { @@ -3438,10 +3603,11 @@ "smithy.api#documentation": "

    Maximum number of results to return per paginated call. The largest value you can specify is 1000.

    " } }, - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", + "JobId": { + "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns \n a pagination token in the response. You can use this pagination token to retrieve the next set of text.

    " + "smithy.api#documentation": "

    Job identifier for the text detection operation for which you want results returned. \n You get the job identifer from an initial call to StartTextDetection.

    ", + "smithy.api#required": {} } } } @@ -3449,11 +3615,8 @@ "com.amazonaws.rekognition#GetTextDetectionResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent \n request to retrieve the next set of text.

    " - } + "VideoMetadata": { + "target": "com.amazonaws.rekognition#VideoMetadata" }, "TextModelVersion": { "target": "com.amazonaws.rekognition#String", @@ -3461,14 +3624,17 @@ "smithy.api#documentation": "

    Version number of the text detection model that was used to detect text.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.rekognition#StatusMessage", + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " + "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent \n request to retrieve the next set of text.

    " } }, - "VideoMetadata": { - "target": "com.amazonaws.rekognition#VideoMetadata" + "TextDetections": { + "target": "com.amazonaws.rekognition#TextDetectionResults", + "traits": { + "smithy.api#documentation": "

    An array of text detected in the video. Each element contains the detected text, the time in milliseconds\n from the start of the video that the text was detected, and where it was detected on the screen.

    " + } }, "JobStatus": { "target": "com.amazonaws.rekognition#VideoJobStatus", @@ -3476,10 +3642,10 @@ "smithy.api#documentation": "

    Current status of the text detection job.

    " } }, - "TextDetections": { - "target": "com.amazonaws.rekognition#TextDetectionResults", + "StatusMessage": { + "target": "com.amazonaws.rekognition#StatusMessage", "traits": { - "smithy.api#documentation": "

    An array of text detected in the video. Each element contains the detected text, the time in milliseconds\n from the start of the video that the text was detected, and where it was detected on the screen.

    " + "smithy.api#documentation": "

    If the job fails, StatusMessage provides a descriptive error message.

    " } } } @@ -3492,18 +3658,12 @@ } }, "traits": { - "smithy.api#documentation": "

    The S3 bucket that contains the Ground Truth manifest file.

    " + "smithy.api#documentation": "

    The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file. \n

    " } }, "com.amazonaws.rekognition#HumanLoopActivationOutput": { "type": "structure", "members": { - "HumanLoopActivationConditionsEvaluationResults": { - "target": "com.amazonaws.rekognition#SynthesizedJsonHumanLoopActivationConditionsEvaluationResults", - "traits": { - "smithy.api#documentation": "

    Shows the result of condition evaluations, including those conditions which activated a \n human review.

    " - } - }, "HumanLoopArn": { "target": "com.amazonaws.rekognition#HumanLoopArn", "traits": { @@ -3515,6 +3675,12 @@ "traits": { "smithy.api#documentation": "

    Shows if and why human review was needed.

    " } + }, + "HumanLoopActivationConditionsEvaluationResults": { + "target": "com.amazonaws.rekognition#SynthesizedJsonHumanLoopActivationConditionsEvaluationResults", + "traits": { + "smithy.api#documentation": "

    Shows the result of condition evaluations, including those conditions which activated a \n human review.

    " + } } }, "traits": { @@ -3599,21 +3765,18 @@ "com.amazonaws.rekognition#HumanLoopQuotaExceededException": { "type": "structure", "members": { - "ResourceType": { + "QuotaCode": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    The resource type.

    " + "smithy.api#documentation": "

    The quota code.

    " } }, - "QuotaCode": { + "ServiceCode": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    The quota code.

    " + "smithy.api#documentation": "

    The service code.

    " } }, - "Message": { - "target": "com.amazonaws.rekognition#String" - }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { @@ -3623,10 +3786,13 @@ "Code": { "target": "com.amazonaws.rekognition#String" }, - "ServiceCode": { + "Message": { + "target": "com.amazonaws.rekognition#String" + }, + "ResourceType": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    The service code.

    " + "smithy.api#documentation": "

    The resource type.

    " } } }, @@ -3639,6 +3805,9 @@ "com.amazonaws.rekognition#IdempotentParameterMismatchException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.rekognition#String" + }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { @@ -3647,9 +3816,6 @@ }, "Code": { "target": "com.amazonaws.rekognition#String" - }, - "Message": { - "target": "com.amazonaws.rekognition#String" } }, "traits": { @@ -3695,16 +3861,16 @@ "com.amazonaws.rekognition#ImageQuality": { "type": "structure", "members": { - "Sharpness": { + "Brightness": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    Value representing sharpness of the face. The service returns a value between 0 and 100\n (inclusive). A higher value indicates a sharper face image.

    " + "smithy.api#documentation": "

    Value representing brightness of the face. The service returns a value between 0 and\n 100 (inclusive). A higher value indicates a brighter face image.

    " } }, - "Brightness": { + "Sharpness": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    Value representing brightness of the face. The service returns a value between 0 and\n 100 (inclusive). A higher value indicates a brighter face image.

    " + "smithy.api#documentation": "

    Value representing sharpness of the face. The service returns a value between 0 and 100\n (inclusive). A higher value indicates a sharper face image.

    " } } }, @@ -3715,17 +3881,17 @@ "com.amazonaws.rekognition#ImageTooLargeException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.rekognition#String" + }, + "Code": { + "target": "com.amazonaws.rekognition#String" + }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } - }, - "Code": { - "target": "com.amazonaws.rekognition#String" - }, - "Message": { - "target": "com.amazonaws.rekognition#String" } }, "traits": { @@ -3766,6 +3932,9 @@ { "target": "com.amazonaws.rekognition#ResourceNotFoundException" }, + { + "target": "com.amazonaws.rekognition#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.rekognition#ThrottlingException" } @@ -3777,19 +3946,18 @@ "com.amazonaws.rekognition#IndexFacesRequest": { "type": "structure", "members": { - "CollectionId": { - "target": "com.amazonaws.rekognition#CollectionId", - "traits": { - "smithy.api#documentation": "

    The ID of an existing collection to which you want to add the faces that are detected\n in the input images.

    ", - "smithy.api#required": {} - } - }, "ExternalImageId": { "target": "com.amazonaws.rekognition#ExternalImageId", "traits": { "smithy.api#documentation": "

    The ID you want to assign to all the faces detected in the image.

    " } }, + "MaxFaces": { + "target": "com.amazonaws.rekognition#MaxFacesToIndex", + "traits": { + "smithy.api#documentation": "

    The maximum number of faces to index. The value of MaxFaces must be greater\n than or equal to 1. IndexFaces returns no more than 100 detected faces in an\n image, even if you specify a larger value for MaxFaces.

    \n

    If IndexFaces detects more faces than the value of MaxFaces, the\n faces with the lowest quality are filtered out first. If there are still more faces than the\n value of MaxFaces, the faces with the smallest bounding boxes are filtered out\n (up to the number that's needed to satisfy the value of MaxFaces). Information\n about the unindexed faces is available in the UnindexedFaces array.

    \n

    The faces that are returned by IndexFaces are sorted by the largest face\n bounding box size to the smallest size, in descending order.

    \n

    \n MaxFaces can be used with a collection associated with any version of \n the face model.

    " + } + }, "DetectionAttributes": { "target": "com.amazonaws.rekognition#Attributes", "traits": { @@ -3803,16 +3971,17 @@ "smithy.api#required": {} } }, - "QualityFilter": { - "target": "com.amazonaws.rekognition#QualityFilter", + "CollectionId": { + "target": "com.amazonaws.rekognition#CollectionId", "traits": { - "smithy.api#documentation": "

    A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar.\n If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar. The default value is AUTO.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed.\n

    \n

    To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

    " + "smithy.api#documentation": "

    The ID of an existing collection to which you want to add the faces that are detected\n in the input images.

    ", + "smithy.api#required": {} } }, - "MaxFaces": { - "target": "com.amazonaws.rekognition#MaxFacesToIndex", + "QualityFilter": { + "target": "com.amazonaws.rekognition#QualityFilter", "traits": { - "smithy.api#documentation": "

    The maximum number of faces to index. The value of MaxFaces must be greater\n than or equal to 1. IndexFaces returns no more than 100 detected faces in an\n image, even if you specify a larger value for MaxFaces.

    \n

    If IndexFaces detects more faces than the value of MaxFaces, the\n faces with the lowest quality are filtered out first. If there are still more faces than the\n value of MaxFaces, the faces with the smallest bounding boxes are filtered out\n (up to the number that's needed to satisfy the value of MaxFaces). Information\n about the unindexed faces is available in the UnindexedFaces array.

    \n

    The faces that are returned by IndexFaces are sorted by the largest face\n bounding box size to the smallest size, in descending order.

    \n

    \n MaxFaces can be used with a collection associated with any version of \n the face model.

    " + "smithy.api#documentation": "

    A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar.\n If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar. The default value is AUTO.\n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed.\n

    \n

    To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

    " } } } @@ -3820,10 +3989,10 @@ "com.amazonaws.rekognition#IndexFacesResponse": { "type": "structure", "members": { - "UnindexedFaces": { - "target": "com.amazonaws.rekognition#UnindexedFaces", + "OrientationCorrection": { + "target": "com.amazonaws.rekognition#OrientationCorrection", "traits": { - "smithy.api#documentation": "

    An array of faces that were detected in the image but weren't indexed. They weren't\n indexed because the quality filter identified them as low quality, or the\n MaxFaces request parameter filtered them out. To use the quality filter, you\n specify the QualityFilter request parameter.

    " + "smithy.api#documentation": "

    If your collection is associated with a face detection model that's later \n than version 3.0, the value of OrientationCorrection\n is always null and no orientation information is returned.

    \n \n

    If your collection is associated with a face detection model that's\n version 3.0 or earlier, the following applies:

    \n
      \n
    • \n

      If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction - the bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata. The value of OrientationCorrection\n is null.

      \n
      • \n
    • \n

      If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns\n an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform \n image correction for images. The bounding box coordinates aren't translated and represent the \n object locations before the image is rotated.

      \n
      • \n
    \n \n \n \n

    Bounding box information is returned in the FaceRecords array. You can get the \n version of the face detection model by calling DescribeCollection.

    " } }, "FaceModelVersion": { @@ -3832,17 +4001,17 @@ "smithy.api#documentation": "

    The version number of the face detection model that's associated with the input\n collection (CollectionId).

    " } }, - "OrientationCorrection": { - "target": "com.amazonaws.rekognition#OrientationCorrection", - "traits": { - "smithy.api#documentation": "

    If your collection is associated with a face detection model that's later \n than version 3.0, the value of OrientationCorrection\n is always null and no orientation information is returned.

    \n \n

    If your collection is associated with a face detection model that's\n version 3.0 or earlier, the following applies:

    \n
      \n
    • \n

      If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata\n that includes the image's orientation. Amazon Rekognition uses this orientation information to perform \n image correction - the bounding box coordinates are translated to represent object locations\n after the orientation information in the Exif metadata is used to correct the image orientation. \n Images in .png format don't contain Exif metadata. The value of OrientationCorrection\n is null.

      \n
      • \n
    • \n

      If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns\n an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform \n image correction for images. The bounding box coordinates aren't translated and represent the \n object locations before the image is rotated.

      \n
      • \n
    \n \n \n \n

    Bounding box information is returned in the FaceRecords array. You can get the \n version of the face detection model by calling DescribeCollection.

    " - } - }, "FaceRecords": { "target": "com.amazonaws.rekognition#FaceRecordList", "traits": { "smithy.api#documentation": "

    An array of faces detected and added to the collection.\n For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.\n

    " } + }, + "UnindexedFaces": { + "target": "com.amazonaws.rekognition#UnindexedFaces", + "traits": { + "smithy.api#documentation": "

    An array of faces that were detected in the image but weren't indexed. They weren't\n indexed because the quality filter identified them as low quality, or the\n MaxFaces request parameter filtered them out. To use the quality filter, you\n specify the QualityFilter request parameter.

    " + } } } }, @@ -3926,7 +4095,7 @@ "com.amazonaws.rekognition#InvalidPaginationTokenException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.rekognition#String" }, "Logref": { @@ -3935,7 +4104,7 @@ "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } }, - "Message": { + "Code": { "target": "com.amazonaws.rekognition#String" } }, @@ -3950,14 +4119,14 @@ "Code": { "target": "com.amazonaws.rekognition#String" }, - "Message": { - "target": "com.amazonaws.rekognition#String" - }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } + }, + "Message": { + "target": "com.amazonaws.rekognition#String" } }, "traits": { @@ -4049,6 +4218,12 @@ "com.amazonaws.rekognition#Label": { "type": "structure", "members": { + "Parents": { + "target": "com.amazonaws.rekognition#Parents", + "traits": { + "smithy.api#documentation": "

    The parent labels for a label. The response includes all ancestor labels.

    " + } + }, "Name": { "target": "com.amazonaws.rekognition#String", "traits": { @@ -4061,12 +4236,6 @@ "smithy.api#documentation": "

    If Label represents an object, Instances contains the bounding boxes for each instance of the detected object.\n Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.

    " } }, - "Parents": { - "target": "com.amazonaws.rekognition#Parents", - "traits": { - "smithy.api#documentation": "

    The parent labels for a label. The response includes all ancestor labels.

    " - } - }, "Confidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { @@ -4134,16 +4303,16 @@ "smithy.api#documentation": "

    Type of landmark.

    " } }, - "Y": { + "X": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    The y-coordinate from the top left of the landmark expressed as the ratio of the height\n of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is\n at 100 pixels, this value is 0.5.

    " + "smithy.api#documentation": "

    The x-coordinate of the landmark expressed as a ratio of the width of the image. \n The x-coordinate is measured from the left-side of the image. \n For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

    " } }, - "X": { + "Y": { "target": "com.amazonaws.rekognition#Float", "traits": { - "smithy.api#documentation": "

    The x-coordinate from the top left of the landmark expressed as the ratio of the width\n of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is\n at 350 pixels, this value is 0.5.

    " + "smithy.api#documentation": "

    The y-coordinate of the landmark expressed as a ratio of the height of the image. \n The y-coordinate is measured from the top of the image. \n For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

    " } } }, @@ -4287,15 +4456,15 @@ "com.amazonaws.rekognition#LimitExceededException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.rekognition#String" - }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } }, + "Message": { + "target": "com.amazonaws.rekognition#String" + }, "Code": { "target": "com.amazonaws.rekognition#String" } @@ -4366,18 +4535,18 @@ "com.amazonaws.rekognition#ListCollectionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the result is truncated, the response provides a NextToken that you can\n use in the subsequent request to fetch the next set of collection IDs.

    " - } - }, "CollectionIds": { "target": "com.amazonaws.rekognition#CollectionIdList", "traits": { "smithy.api#documentation": "

    An array of collection IDs.

    " } }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the result is truncated, the response provides a NextToken that you can\n use in the subsequent request to fetch the next set of collection IDs.

    " + } + }, "FaceModelVersions": { "target": "com.amazonaws.rekognition#FaceModelVersionList", "traits": { @@ -4430,6 +4599,12 @@ "com.amazonaws.rekognition#ListFacesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous response was incomplete (because there is more data to retrieve),\n Amazon Rekognition returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of faces.

    " + } + }, "CollectionId": { "target": "com.amazonaws.rekognition#CollectionId", "traits": { @@ -4442,28 +4617,22 @@ "traits": { "smithy.api#documentation": "

    Maximum number of faces to return.

    " } - }, - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there is more data to retrieve),\n Amazon Rekognition returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of faces.

    " - } } } }, "com.amazonaws.rekognition#ListFacesResponse": { "type": "structure", "members": { - "NextToken": { + "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition returns this token that you can use in the\n subsequent request to retrieve the next set of faces.

    " + "smithy.api#documentation": "

    Version number of the face detection model associated with the input collection (CollectionId).

    " } }, - "FaceModelVersion": { + "NextToken": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    Version number of the face detection model associated with the input collection (CollectionId).

    " + "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition returns this token that you can use in the\n subsequent request to retrieve the next set of faces.

    " } }, "Faces": { @@ -4514,16 +4683,16 @@ "com.amazonaws.rekognition#ListStreamProcessorsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", + "MaxResults": { + "target": "com.amazonaws.rekognition#MaxResults", "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video\n returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.

    " + "smithy.api#documentation": "

    Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.

    " } }, - "MaxResults": { - "target": "com.amazonaws.rekognition#MaxResults", + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

    Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.

    " + "smithy.api#documentation": "

    If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video\n returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.

    " } } } @@ -4531,17 +4700,17 @@ "com.amazonaws.rekognition#ListStreamProcessorsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.rekognition#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent\n request to retrieve the next set of stream processors.

    " - } - }, "StreamProcessors": { "target": "com.amazonaws.rekognition#StreamProcessorList", "traits": { "smithy.api#documentation": "

    List of stream processors that you have created.

    " } + }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent\n request to retrieve the next set of stream processors.

    " + } } } }, @@ -4576,10 +4745,10 @@ "com.amazonaws.rekognition#ModerationLabel": { "type": "structure", "members": { - "ParentName": { - "target": "com.amazonaws.rekognition#String", + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

    The name for the parent label. Labels at the top level of the hierarchy have the parent\n label \"\".

    " + "smithy.api#documentation": "

    Specifies the confidence that Amazon Rekognition has that the label has been correctly\n identified.

    \n

    If you don't specify the MinConfidence parameter in the call to\n DetectModerationLabels, the operation returns labels with a confidence value\n greater than or equal to 50 percent.

    " } }, "Name": { @@ -4588,10 +4757,10 @@ "smithy.api#documentation": "

    The label name for the type of unsafe content detected in the image.

    " } }, - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", + "ParentName": { + "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    Specifies the confidence that Amazon Rekognition has that the label has been correctly\n identified.

    \n

    If you don't specify the MinConfidence parameter in the call to\n DetectModerationLabels, the operation returns labels with a confidence value\n greater than or equal to 50 percent.

    " + "smithy.api#documentation": "

    The name for the parent label. Labels at the top level of the hierarchy have the parent\n label \"\".

    " } } }, @@ -4608,17 +4777,17 @@ "com.amazonaws.rekognition#MouthOpen": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.rekognition#Boolean", - "traits": { - "smithy.api#documentation": "

    Boolean value that indicates whether the mouth on the face is open or not.

    " - } - }, "Confidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { "smithy.api#documentation": "

    Level of confidence in the determination.

    " } + }, + "Value": { + "target": "com.amazonaws.rekognition#Boolean", + "traits": { + "smithy.api#documentation": "

    Boolean value that indicates whether the mouth on the face is open or not.

    " + } } }, "traits": { @@ -4628,17 +4797,17 @@ "com.amazonaws.rekognition#Mustache": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.rekognition#Boolean", - "traits": { - "smithy.api#documentation": "

    Boolean value that indicates whether the face has mustache or not.

    " - } - }, "Confidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { "smithy.api#documentation": "

    Level of confidence in the determination.

    " } + }, + "Value": { + "target": "com.amazonaws.rekognition#Boolean", + "traits": { + "smithy.api#documentation": "

    Boolean value that indicates whether the face has mustache or not.

    " + } } }, "traits": { @@ -4817,6 +4986,12 @@ "com.amazonaws.rekognition#PersonMatch": { "type": "structure", "members": { + "Person": { + "target": "com.amazonaws.rekognition#PersonDetail", + "traits": { + "smithy.api#documentation": "

    Information about the matched person.

    " + } + }, "FaceMatches": { "target": "com.amazonaws.rekognition#FaceMatchList", "traits": { @@ -4828,12 +5003,6 @@ "traits": { "smithy.api#documentation": "

    The time, in milliseconds from the beginning of the video, that the person was matched in the video.

    " } - }, - "Person": { - "target": "com.amazonaws.rekognition#PersonDetail", - "traits": { - "smithy.api#documentation": "

    Information about the matched person.

    " - } } }, "traits": { @@ -4926,12 +5095,6 @@ "com.amazonaws.rekognition#ProjectDescription": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.rekognition#ProjectStatus", - "traits": { - "smithy.api#documentation": "

    The current status of the project.

    " - } - }, "ProjectArn": { "target": "com.amazonaws.rekognition#ProjectArn", "traits": { @@ -4943,6 +5106,12 @@ "traits": { "smithy.api#documentation": "

    The Unix timestamp for the date and time that the project was created.

    " } + }, + "Status": { + "target": "com.amazonaws.rekognition#ProjectStatus", + "traits": { + "smithy.api#documentation": "

    The current status of the project.

    " + } } }, "traits": { @@ -4997,10 +5166,16 @@ "com.amazonaws.rekognition#ProjectVersionDescription": { "type": "structure", "members": { - "OutputConfig": { - "target": "com.amazonaws.rekognition#OutputConfig", + "ManifestSummary": { + "target": "com.amazonaws.rekognition#GroundTruthManifest", "traits": { - "smithy.api#documentation": "

    The location where training results are saved.

    " + "smithy.api#documentation": "

    The location of the summary manifest. The summary manifest provides aggregate data validation results for the training\n and test datasets.

    " + } + }, + "EvaluationResult": { + "target": "com.amazonaws.rekognition#EvaluationResult", + "traits": { + "smithy.api#documentation": "

    The training results. EvaluationResult is only returned if training is successful.

    " } }, "Status": { @@ -5009,10 +5184,16 @@ "smithy.api#documentation": "

    The current status of the model version.

    " } }, - "MinInferenceUnits": { - "target": "com.amazonaws.rekognition#InferenceUnits", + "OutputConfig": { + "target": "com.amazonaws.rekognition#OutputConfig", "traits": { - "smithy.api#documentation": "

    The minimum number of inference units used by the model. For more information,\n see StartProjectVersion.

    " + "smithy.api#documentation": "

    The location where training results are saved.

    " + } + }, + "TrainingDataResult": { + "target": "com.amazonaws.rekognition#TrainingDataResult", + "traits": { + "smithy.api#documentation": "

    Contains information about the training results.

    " } }, "TrainingEndTimestamp": { @@ -5021,16 +5202,16 @@ "smithy.api#documentation": "

    The Unix date and time that training of the model ended.

    " } }, - "TestingDataResult": { - "target": "com.amazonaws.rekognition#TestingDataResult", + "MinInferenceUnits": { + "target": "com.amazonaws.rekognition#InferenceUnits", "traits": { - "smithy.api#documentation": "

    The manifest file that represents the testing results.

    " + "smithy.api#documentation": "

    The minimum number of inference units used by the model. For more information,\n see StartProjectVersion.

    " } }, - "TrainingDataResult": { - "target": "com.amazonaws.rekognition#TrainingDataResult", + "TestingDataResult": { + "target": "com.amazonaws.rekognition#TestingDataResult", "traits": { - "smithy.api#documentation": "

    The manifest file that represents the training results.

    " + "smithy.api#documentation": "

    Contains information about the testing results.

    " } }, "ProjectVersionArn": { @@ -5039,10 +5220,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model version.

    " } }, - "EvaluationResult": { - "target": "com.amazonaws.rekognition#EvaluationResult", + "StatusMessage": { + "target": "com.amazonaws.rekognition#StatusMessage", "traits": { - "smithy.api#documentation": "

    The training results. EvaluationResult is only returned if training is successful.

    " + "smithy.api#documentation": "

    A descriptive message for an error or warning that occurred.

    " } }, "BillableTrainingTimeInSeconds": { @@ -5051,12 +5232,6 @@ "smithy.api#documentation": "

    The duration, in seconds, that the model version has been billed for training. \n This value is only returned if the model version has been successfully trained.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.rekognition#StatusMessage", - "traits": { - "smithy.api#documentation": "

    A descriptive message for an error or warning that occurred.

    " - } - }, "CreationTimestamp": { "target": "com.amazonaws.rekognition#DateTime", "traits": { @@ -5137,12 +5312,152 @@ } } }, - "com.amazonaws.rekognition#ProvisionedThroughputExceededException": { + "com.amazonaws.rekognition#ProtectiveEquipmentBodyPart": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.rekognition#String" + "Name": { + "target": "com.amazonaws.rekognition#BodyPart", + "traits": { + "smithy.api#documentation": "

    The detected body part.

    " + } + }, + "EquipmentDetections": { + "target": "com.amazonaws.rekognition#EquipmentDetections", + "traits": { + "smithy.api#documentation": "

    An array of Personal Protective Equipment items detected around a body part.

    " + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a body part detected by DetectProtectiveEquipment that contains PPE.\n An array of ProtectiveEquipmentBodyPart objects is returned for each person detected by \n DetectProtectiveEquipment.

    " + } + }, + "com.amazonaws.rekognition#ProtectiveEquipmentPerson": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.rekognition#BoundingBox", + "traits": { + "smithy.api#documentation": "

    A bounding box around the detected person.

    " + } + }, + "BodyParts": { + "target": "com.amazonaws.rekognition#BodyParts", + "traits": { + "smithy.api#documentation": "

    An array of body parts detected on a person's body (including body parts without PPE).

    " + } + }, + "Id": { + "target": "com.amazonaws.rekognition#UInteger", + "traits": { + "smithy.api#documentation": "

    The identifier for the detected person. The identifier is only unique for a single call to\n DetectProtectiveEquipment.

    " + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    The confidence that Amazon Rekognition has that the bounding box contains a person.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A person detected by a call to DetectProtectiveEquipment. The API returns \n all persons detected in the input\n image in an array of ProtectiveEquipmentPerson objects.

    " + } + }, + "com.amazonaws.rekognition#ProtectiveEquipmentPersonIds": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UInteger" + } + }, + "com.amazonaws.rekognition#ProtectiveEquipmentPersons": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentPerson" + } + }, + "com.amazonaws.rekognition#ProtectiveEquipmentSummarizationAttributes": { + "type": "structure", + "members": { + "MinConfidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    The minimum confidence level for which you want summary information. \n The confidence level applies to person detection, body part detection, equipment detection, and body part coverage.\n Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a\n default value.

    \n

    Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment\n returns predictions only where the detection confidence is between 50% - 100%. \n If you specify a value that is less than 50%, the results are the same specifying a value of 50%.

    \n

    \n

    ", + "smithy.api#required": {} + } + }, + "RequiredEquipmentTypes": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentTypes", + "traits": { + "smithy.api#documentation": "

    An array of personal protective equipment types for which you want summary information. \n If a person is detected wearing a required requipment type, the person's ID is added to the\n PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary\n by DetectProtectiveEquipment.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Specifies summary attributes to return from a call to DetectProtectiveEquipment.\n You can specify which types of PPE to summarize. You can also specify a minimum confidence value for detections.\n Summary information is returned in the Summary (ProtectiveEquipmentSummary) field of the response from \n DetectProtectiveEquipment.\n The summary includes which persons in an image were detected wearing the requested types of person protective equipment (PPE), which persons\n were detected as not wearing PPE, and the persons in which a determination could not be made. For more information, \n see ProtectiveEquipmentSummary.

    " + } + }, + "com.amazonaws.rekognition#ProtectiveEquipmentSummary": { + "type": "structure", + "members": { + "PersonsWithoutRequiredEquipment": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentPersonIds", + "traits": { + "smithy.api#documentation": "

    An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of\n the detected personal protective equipment.\n

    " + } }, + "PersonsWithRequiredEquipment": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentPersonIds", + "traits": { + "smithy.api#documentation": "

    An array of IDs for persons who are wearing detected personal protective equipment.\n

    " + } + }, + "PersonsIndeterminate": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentPersonIds", + "traits": { + "smithy.api#documentation": "

    An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Summary information for required items of personal protective equipment (PPE) detected on persons by a call\n to DetectProtectiveEquipment. You specify the required type of PPE in\n the SummarizationAttributes\n (ProtectiveEquipmentSummarizationAttributes) input parameter.\n The summary includes which persons were detected wearing the required personal protective equipment\n (PersonsWithRequiredEquipment),\n which persons were detected as not wearing the required PPE (PersonsWithoutRequiredEquipment), \n and the persons in which a determination\n could not be made (PersonsIndeterminate).

    \n

    To get a total for each category, use the size of the field array. For example, \n to find out how many people were detected as wearing the specified PPE,\n use the size of the PersonsWithRequiredEquipment array. \n If you want to find out more about a person, such as the \n location (BoundingBox) of the person on the image, use the person ID in each array element. \n Each person ID matches the ID field of a ProtectiveEquipmentPerson object returned\n in the Persons array by DetectProtectiveEquipment.

    " + } + }, + "com.amazonaws.rekognition#ProtectiveEquipmentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FACE_COVER", + "name": "FACE_COVER" + }, + { + "value": "HAND_COVER", + "name": "HAND_COVER" + }, + { + "value": "HEAD_COVER", + "name": "HEAD_COVER" + } + ] + } + }, + "com.amazonaws.rekognition#ProtectiveEquipmentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#ProtectiveEquipmentType" + } + }, + "com.amazonaws.rekognition#ProvisionedThroughputExceededException": { + "type": "structure", + "members": { "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { @@ -5151,6 +5466,9 @@ }, "Message": { "target": "com.amazonaws.rekognition#String" + }, + "Code": { + "target": "com.amazonaws.rekognition#String" } }, "traits": { @@ -5261,7 +5579,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities\n in the Amazon Rekognition Developer Guide.

    \n

    \n RecognizeCelebrities returns the 100 largest faces in the image. It lists\n recognized celebrities in the CelebrityFaces array and unrecognized faces in the\n UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 100 faces in the image.

    \n\n

    For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

    \n

    Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

    \n

    You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

    \n\n\n\n \n

    For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

    \n

    This operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.

    " + "smithy.api#documentation": "

    Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities\n in the Amazon Rekognition Developer Guide.

    \n

    \n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n recognized celebrities in the CelebrityFaces array and unrecognized faces in the\n UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.

    \n\n

    For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

    \n

    Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

    \n

    You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

    \n\n\n\n \n

    For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

    \n

    This operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.

    " } }, "com.amazonaws.rekognition#RecognizeCelebritiesRequest": { @@ -5279,22 +5597,22 @@ "com.amazonaws.rekognition#RecognizeCelebritiesResponse": { "type": "structure", "members": { - "UnrecognizedFaces": { - "target": "com.amazonaws.rekognition#ComparedFaceList", - "traits": { - "smithy.api#documentation": "

    Details about each unrecognized face in the image.

    " - } - }, "OrientationCorrection": { "target": "com.amazonaws.rekognition#OrientationCorrection", "traits": { "smithy.api#documentation": "

    The orientation of the input image (counterclockwise direction). If your application\n displays the image, you can use this value to correct the orientation. The bounding box\n coordinates returned in CelebrityFaces and UnrecognizedFaces\n represent face locations before the image orientation is corrected.

    \n \n

    If the input image is in .jpeg format, it might contain exchangeable image (Exif)\n metadata that includes the image's orientation. If so, and the Exif metadata for the input\n image populates the orientation field, the value of OrientationCorrection is\n null. The CelebrityFaces and UnrecognizedFaces bounding box\n coordinates represent face locations after Exif metadata is used to correct the image\n orientation. Images in .png format don't contain Exif metadata.

    \n     " } }, + "UnrecognizedFaces": { + "target": "com.amazonaws.rekognition#ComparedFaceList", + "traits": { + "smithy.api#documentation": "

    Details about each unrecognized face in the image.

    " + } + }, "CelebrityFaces": { "target": "com.amazonaws.rekognition#CelebrityList", "traits": { - "smithy.api#documentation": "

    Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15\n celebrities in an image.

    " + "smithy.api#documentation": "

    Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64\n celebrities in an image.

    " } } } @@ -5383,6 +5701,9 @@ { "target": "com.amazonaws.rekognition#DetectModerationLabels" }, + { + "target": "com.amazonaws.rekognition#DetectProtectiveEquipment" + }, { "target": "com.amazonaws.rekognition#DetectText" }, @@ -5476,7 +5797,7 @@ "sdkId": "Rekognition", "arnNamespace": "rekognition", "cloudFormationName": "Rekognition", - "cloudTrailEventSource": "rekognitionservice.amazonaws.com" + "cloudTrailEventSource": "rekognition.amazonaws.com" }, "aws.auth#sigv4": { "name": "rekognition" @@ -5498,14 +5819,14 @@ "Code": { "target": "com.amazonaws.rekognition#String" }, + "Message": { + "target": "com.amazonaws.rekognition#String" + }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } - }, - "Message": { - "target": "com.amazonaws.rekognition#String" } }, "traits": { @@ -5516,15 +5837,15 @@ "com.amazonaws.rekognition#ResourceInUseException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.rekognition#String" - }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } }, + "Code": { + "target": "com.amazonaws.rekognition#String" + }, "Message": { "target": "com.amazonaws.rekognition#String" } @@ -5558,6 +5879,9 @@ "com.amazonaws.rekognition#ResourceNotReadyException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.rekognition#String" + }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { @@ -5566,9 +5890,6 @@ }, "Code": { "target": "com.amazonaws.rekognition#String" - }, - "Message": { - "target": "com.amazonaws.rekognition#String" } }, "traits": { @@ -5602,20 +5923,20 @@ } }, "com.amazonaws.rekognition#S3Object": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.rekognition#S3Bucket", - "traits": { - "smithy.api#documentation": "

    Name of the S3 bucket.

    " - } - }, + "type": "structure", + "members": { "Version": { "target": "com.amazonaws.rekognition#S3ObjectVersion", "traits": { "smithy.api#documentation": "

    If the bucket is versioning enabled, you can specify the object version.

    " } }, + "Bucket": { + "target": "com.amazonaws.rekognition#S3Bucket", + "traits": { + "smithy.api#documentation": "

    Name of the S3 bucket.

    " + } + }, "Name": { "target": "com.amazonaws.rekognition#S3ObjectName", "traits": { @@ -5727,12 +6048,6 @@ "com.amazonaws.rekognition#SearchFacesByImageRequest": { "type": "structure", "members": { - "MaxFaces": { - "target": "com.amazonaws.rekognition#MaxFaces", - "traits": { - "smithy.api#documentation": "

    Maximum number of faces to return. The operation returns the maximum number of faces\n with the highest confidence in the match.

    " - } - }, "FaceMatchThreshold": { "target": "com.amazonaws.rekognition#Percent", "traits": { @@ -5746,17 +6061,23 @@ "smithy.api#required": {} } }, + "CollectionId": { + "target": "com.amazonaws.rekognition#CollectionId", + "traits": { + "smithy.api#documentation": "

    ID of the collection to search.

    ", + "smithy.api#required": {} + } + }, "QualityFilter": { "target": "com.amazonaws.rekognition#QualityFilter", "traits": { "smithy.api#documentation": "

    A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition \n chooses the quality bar. If you specify LOW, \n MEDIUM, or HIGH, filtering removes all faces that\n don’t meet the chosen quality bar. \n \n The quality bar is based on a variety of common use cases. Low-quality\n detections can occur for a number of reasons. Some examples are an object that's misidentified\n as a face, a face that's too blurry, or a face with a\n pose that's too extreme to use. If you specify NONE, no\n filtering is performed. The default value is NONE.\n

    \n

    To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

    " } }, - "CollectionId": { - "target": "com.amazonaws.rekognition#CollectionId", + "MaxFaces": { + "target": "com.amazonaws.rekognition#MaxFaces", "traits": { - "smithy.api#documentation": "

    ID of the collection to search.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Maximum number of faces to return. The operation returns the maximum number of faces\n with the highest confidence in the match.

    " } } } @@ -5764,35 +6085,41 @@ "com.amazonaws.rekognition#SearchFacesByImageResponse": { "type": "structure", "members": { - "SearchedFaceConfidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    The level of confidence that the searchedFaceBoundingBox, contains a\n face.

    " - } - }, "SearchedFaceBoundingBox": { "target": "com.amazonaws.rekognition#BoundingBox", "traits": { "smithy.api#documentation": "

    The bounding box around the face in the input image that Amazon Rekognition used for the\n search.

    " } }, - "FaceMatches": { - "target": "com.amazonaws.rekognition#FaceMatchList", - "traits": { - "smithy.api#documentation": "

    An array of faces that match the input face, along with the confidence in the\n match.

    " - } - }, "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    Version number of the face detection model associated with the input collection (CollectionId).

    " } + }, + "SearchedFaceConfidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    The level of confidence that the searchedFaceBoundingBox, contains a\n face.

    " + } + }, + "FaceMatches": { + "target": "com.amazonaws.rekognition#FaceMatchList", + "traits": { + "smithy.api#documentation": "

    An array of faces that match the input face, along with the confidence in the\n match.

    " + } } } }, "com.amazonaws.rekognition#SearchFacesRequest": { "type": "structure", "members": { + "FaceMatchThreshold": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Optional value specifying the minimum confidence in the face match to return. For\n example, don't return any matches where confidence in matches is less than 70%. \n The default value is 80%.\n

    " + } + }, "FaceId": { "target": "com.amazonaws.rekognition#FaceId", "traits": { @@ -5800,12 +6127,6 @@ "smithy.api#required": {} } }, - "MaxFaces": { - "target": "com.amazonaws.rekognition#MaxFaces", - "traits": { - "smithy.api#documentation": "

    Maximum number of faces to return. The operation returns the maximum number of faces\n with the highest confidence in the match.

    " - } - }, "CollectionId": { "target": "com.amazonaws.rekognition#CollectionId", "traits": { @@ -5813,10 +6134,10 @@ "smithy.api#required": {} } }, - "FaceMatchThreshold": { - "target": "com.amazonaws.rekognition#Percent", + "MaxFaces": { + "target": "com.amazonaws.rekognition#MaxFaces", "traits": { - "smithy.api#documentation": "

    Optional value specifying the minimum confidence in the face match to return. For\n example, don't return any matches where confidence in matches is less than 70%. \n The default value is 80%.\n

    " + "smithy.api#documentation": "

    Maximum number of faces to return. The operation returns the maximum number of faces\n with the highest confidence in the match.

    " } } } @@ -5830,17 +6151,17 @@ "smithy.api#documentation": "

    ID of the face that was searched for matches in a collection.

    " } }, - "FaceModelVersion": { - "target": "com.amazonaws.rekognition#String", - "traits": { - "smithy.api#documentation": "

    Version number of the face detection model associated with the input collection (CollectionId).

    " - } - }, "FaceMatches": { "target": "com.amazonaws.rekognition#FaceMatchList", "traits": { "smithy.api#documentation": "

    An array of faces that matched the input face, along with the confidence in the\n match.

    " } + }, + "FaceModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

    Version number of the face detection model associated with the input collection (CollectionId).

    " + } } } }, @@ -5857,16 +6178,22 @@ "com.amazonaws.rekognition#SegmentDetection": { "type": "structure", "members": { - "StartTimecodeSMPTE": { - "target": "com.amazonaws.rekognition#Timecode", + "DurationMillis": { + "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "

    The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.\n StartTimecode is in HH:MM:SS:fr format\n (and ;fr for drop frame-rates).

    " + "smithy.api#documentation": "

    The duration of the detected segment in milliseconds.

    " } }, - "DurationSMPTE": { - "target": "com.amazonaws.rekognition#Timecode", + "StartTimestampMillis": { + "target": "com.amazonaws.rekognition#Timestamp", "traits": { - "smithy.api#documentation": "

    The duration of the timecode for the detected segment in SMPTE format.

    " + "smithy.api#documentation": "

    The start time of the detected segment in milliseconds from the start of the video. This value\n is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of\n 100 millis.

    " + } + }, + "EndTimestampMillis": { + "target": "com.amazonaws.rekognition#Timestamp", + "traits": { + "smithy.api#documentation": "

    The end time of the detected segment, in milliseconds, from the start of the video.\n This value is rounded down.

    " } }, "ShotSegment": { @@ -5881,22 +6208,10 @@ "smithy.api#documentation": "

    The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. \n EndTimecode is in HH:MM:SS:fr format\n (and ;fr for drop frame-rates).

    " } }, - "EndTimestampMillis": { - "target": "com.amazonaws.rekognition#Timestamp", - "traits": { - "smithy.api#documentation": "

    The end time of the detected segment, in milliseconds, from the start of the video.

    " - } - }, - "StartTimestampMillis": { - "target": "com.amazonaws.rekognition#Timestamp", - "traits": { - "smithy.api#documentation": "

    The start time of the detected segment in milliseconds from the start of the video.

    " - } - }, - "Type": { - "target": "com.amazonaws.rekognition#SegmentType", + "DurationSMPTE": { + "target": "com.amazonaws.rekognition#Timecode", "traits": { - "smithy.api#documentation": "

    The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

    " + "smithy.api#documentation": "

    The duration of the timecode for the detected segment in SMPTE format.

    " } }, "TechnicalCueSegment": { @@ -5905,10 +6220,16 @@ "smithy.api#documentation": "

    If the segment is a technical cue, contains information about the technical cue.

    " } }, - "DurationMillis": { - "target": "com.amazonaws.rekognition#ULong", + "StartTimecodeSMPTE": { + "target": "com.amazonaws.rekognition#Timecode", "traits": { - "smithy.api#documentation": "

    The duration of the detected segment in milliseconds.

    " + "smithy.api#documentation": "

    The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.\n StartTimecode is in HH:MM:SS:fr format\n (and ;fr for drop frame-rates).

    " + } + }, + "Type": { + "target": "com.amazonaws.rekognition#SegmentType", + "traits": { + "smithy.api#documentation": "

    The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

    " } } }, @@ -5974,19 +6295,40 @@ "target": "com.amazonaws.rekognition#SegmentTypeInfo" } }, - "com.amazonaws.rekognition#ShotSegment": { + "com.amazonaws.rekognition#ServiceQuotaExceededException": { "type": "structure", "members": { - "Confidence": { - "target": "com.amazonaws.rekognition#SegmentConfidence", + "Code": { + "target": "com.amazonaws.rekognition#String" + }, + "Message": { + "target": "com.amazonaws.rekognition#String" + }, + "Logref": { + "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

    The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.

    " + "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } - }, + } + }, + "traits": { + "smithy.api#documentation": "

    \n \n \n

    The size of the collection exceeds the allowed limit. For more information, see \n Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

    ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.rekognition#ShotSegment": { + "type": "structure", + "members": { "Index": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "

    An Identifier for a shot detection segment detected in a video

    " + "smithy.api#documentation": "

    An Identifier for a shot detection segment detected in a video.

    " + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#SegmentConfidence", + "traits": { + "smithy.api#documentation": "

    The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.

    " } } }, @@ -5997,17 +6339,17 @@ "com.amazonaws.rekognition#Smile": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.rekognition#Boolean", - "traits": { - "smithy.api#documentation": "

    Boolean value that indicates whether the face is smiling or not.

    " - } - }, "Confidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { "smithy.api#documentation": "

    Level of confidence in the determination.

    " } + }, + "Value": { + "target": "com.amazonaws.rekognition#Boolean", + "traits": { + "smithy.api#documentation": "

    Boolean value that indicates whether the face is smiling or not.

    " + } } }, "traits": { @@ -6059,12 +6401,6 @@ "com.amazonaws.rekognition#StartCelebrityRecognitionRequest": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.rekognition#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

    Idempotent token used to identify the start request. If you use the same token with multiple\n StartCelebrityRecognition requests, the same JobId is returned. Use\n ClientRequestToken to prevent the same job from being accidently started more than once.

    " - } - }, "Video": { "target": "com.amazonaws.rekognition#Video", "traits": { @@ -6072,10 +6408,10 @@ "smithy.api#required": {} } }, - "NotificationChannel": { - "target": "com.amazonaws.rekognition#NotificationChannel", + "ClientRequestToken": { + "target": "com.amazonaws.rekognition#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n celebrity recognition analysis to.

    " + "smithy.api#documentation": "

    Idempotent token used to identify the start request. If you use the same token with multiple\n StartCelebrityRecognition requests, the same JobId is returned. Use\n ClientRequestToken to prevent the same job from being accidently started more than once.

    " } }, "JobTag": { @@ -6083,6 +6419,12 @@ "traits": { "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " } + }, + "NotificationChannel": { + "target": "com.amazonaws.rekognition#NotificationChannel", + "traits": { + "smithy.api#documentation": "

    The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n celebrity recognition analysis to.

    " + } } } }, @@ -6142,12 +6484,6 @@ "com.amazonaws.rekognition#StartContentModerationRequest": { "type": "structure", "members": { - "MinConfidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence\n represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level\n lower than this specified value. If you don't specify MinConfidence, GetContentModeration\n returns labels with confidence values greater than or equal to 50 percent.

    " - } - }, "Video": { "target": "com.amazonaws.rekognition#Video", "traits": { @@ -6155,10 +6491,10 @@ "smithy.api#required": {} } }, - "JobTag": { - "target": "com.amazonaws.rekognition#JobTag", + "MinConfidence": { + "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + "smithy.api#documentation": "

    Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence\n represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level\n lower than this specified value. If you don't specify MinConfidence, GetContentModeration\n returns labels with confidence values greater than or equal to 50 percent.

    " } }, "NotificationChannel": { @@ -6172,6 +6508,12 @@ "traits": { "smithy.api#documentation": "

    Idempotent token used to identify the start request. If you use the same token with multiple\n StartContentModeration requests, the same JobId is returned. Use\n ClientRequestToken to prevent the same job from being accidently started more than once.

    " } + }, + "JobTag": { + "target": "com.amazonaws.rekognition#JobTag", + "traits": { + "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } } } }, @@ -6231,10 +6573,17 @@ "com.amazonaws.rekognition#StartFaceDetectionRequest": { "type": "structure", "members": { - "NotificationChannel": { - "target": "com.amazonaws.rekognition#NotificationChannel", + "FaceAttributes": { + "target": "com.amazonaws.rekognition#FaceAttributes", "traits": { - "smithy.api#documentation": "

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n face detection operation.

    " + "smithy.api#documentation": "

    The face attributes you want returned.

    \n

    \n DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

    \n

    \n ALL - All facial attributes are returned.

    " + } + }, + "Video": { + "target": "com.amazonaws.rekognition#Video", + "traits": { + "smithy.api#documentation": "

    The video in which you want to detect faces. The video must be stored\n in an Amazon S3 bucket.

    ", + "smithy.api#required": {} } }, "ClientRequestToken": { @@ -6243,11 +6592,10 @@ "smithy.api#documentation": "

    Idempotent token used to identify the start request. If you use the same token with multiple\n StartFaceDetection requests, the same JobId is returned. Use\n ClientRequestToken to prevent the same job from being accidently started more than once.

    " } }, - "Video": { - "target": "com.amazonaws.rekognition#Video", + "NotificationChannel": { + "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

    The video in which you want to detect faces. The video must be stored\n in an Amazon S3 bucket.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n face detection operation.

    " } }, "JobTag": { @@ -6255,12 +6603,6 @@ "traits": { "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " } - }, - "FaceAttributes": { - "target": "com.amazonaws.rekognition#FaceAttributes", - "traits": { - "smithy.api#documentation": "

    The face attributes you want returned.

    \n

    \n DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

    \n

    \n ALL - All facial attributes are returned.

    " - } } } }, @@ -6323,12 +6665,6 @@ "com.amazonaws.rekognition#StartFaceSearchRequest": { "type": "structure", "members": { - "FaceMatchThreshold": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.\n The default value is 80%.

    " - } - }, "CollectionId": { "target": "com.amazonaws.rekognition#CollectionId", "traits": { @@ -6336,29 +6672,35 @@ "smithy.api#required": {} } }, + "JobTag": { + "target": "com.amazonaws.rekognition#JobTag", + "traits": { + "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } + }, "ClientRequestToken": { "target": "com.amazonaws.rekognition#ClientRequestToken", "traits": { "smithy.api#documentation": "

    Idempotent token used to identify the start request. If you use the same token with multiple\n StartFaceSearch requests, the same JobId is returned. Use\n ClientRequestToken to prevent the same job from being accidently started more than once.

    " } }, + "NotificationChannel": { + "target": "com.amazonaws.rekognition#NotificationChannel", + "traits": { + "smithy.api#documentation": "

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

    " + } + }, "Video": { "target": "com.amazonaws.rekognition#Video", "traits": { "smithy.api#documentation": "

    The video you want to search. The video must be stored in an Amazon S3 bucket.

    ", "smithy.api#required": {} } - }, - "JobTag": { - "target": "com.amazonaws.rekognition#JobTag", - "traits": { - "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " - } - }, - "NotificationChannel": { - "target": "com.amazonaws.rekognition#NotificationChannel", + }, + "FaceMatchThreshold": { + "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

    " + "smithy.api#documentation": "

    The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.\n The default value is 80%.

    " } } } @@ -6431,10 +6773,10 @@ "smithy.api#documentation": "

    Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence\n represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level\n lower than this specified value.

    \n

    If you don't specify MinConfidence, the operation returns labels with confidence\n values greater than or equal to 50 percent.

    " } }, - "NotificationChannel": { - "target": "com.amazonaws.rekognition#NotificationChannel", + "JobTag": { + "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "

    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection\n operation to.

    " + "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " } }, "Video": { @@ -6444,10 +6786,10 @@ "smithy.api#required": {} } }, - "JobTag": { - "target": "com.amazonaws.rekognition#JobTag", + "NotificationChannel": { + "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + "smithy.api#documentation": "

    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection\n operation to.

    " } } } @@ -6521,17 +6863,17 @@ "smithy.api#required": {} } }, - "JobTag": { - "target": "com.amazonaws.rekognition#JobTag", - "traits": { - "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " - } - }, "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { "smithy.api#documentation": "

    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection\n operation to.

    " } + }, + "JobTag": { + "target": "com.amazonaws.rekognition#JobTag", + "traits": { + "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } } } }, @@ -6659,17 +7001,17 @@ "com.amazonaws.rekognition#StartSegmentDetectionFilters": { "type": "structure", "members": { - "ShotFilter": { - "target": "com.amazonaws.rekognition#StartShotDetectionFilter", - "traits": { - "smithy.api#documentation": "

    Filters that are specific to shot detections.

    " - } - }, "TechnicalCueFilter": { "target": "com.amazonaws.rekognition#StartTechnicalCueDetectionFilter", "traits": { "smithy.api#documentation": "

    Filters that are specific to technical cues.

    " } + }, + "ShotFilter": { + "target": "com.amazonaws.rekognition#StartShotDetectionFilter", + "traits": { + "smithy.api#documentation": "

    Filters that are specific to shot detections.

    " + } } }, "traits": { @@ -6679,6 +7021,12 @@ "com.amazonaws.rekognition#StartSegmentDetectionRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.rekognition#StartSegmentDetectionFilters", + "traits": { + "smithy.api#documentation": "

    Filters for technical cue or shot detection.

    " + } + }, "SegmentTypes": { "target": "com.amazonaws.rekognition#SegmentTypes", "traits": { @@ -6686,35 +7034,29 @@ "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.rekognition#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

    Idempotent token used to identify the start request. If you use the same token with multiple\n StartSegmentDetection requests, the same JobId is returned. Use\n ClientRequestToken to prevent the same job from being accidently started more than once.

    " - } - }, - "NotificationChannel": { - "target": "com.amazonaws.rekognition#NotificationChannel", - "traits": { - "smithy.api#documentation": "

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n segment detection operation.

    " - } - }, - "Filters": { - "target": "com.amazonaws.rekognition#StartSegmentDetectionFilters", - "traits": { - "smithy.api#documentation": "

    Filters for technical cue or shot detection.

    " - } - }, "Video": { "target": "com.amazonaws.rekognition#Video", "traits": { "smithy.api#required": {} } }, + "ClientRequestToken": { + "target": "com.amazonaws.rekognition#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    Idempotent token used to identify the start request. If you use the same token with multiple\n StartSegmentDetection requests, the same JobId is returned. Use\n ClientRequestToken to prevent the same job from being accidently started more than once.

    " + } + }, "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { "smithy.api#documentation": "

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " } + }, + "NotificationChannel": { + "target": "com.amazonaws.rekognition#NotificationChannel", + "traits": { + "smithy.api#documentation": "

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n segment detection operation.

    " + } } } }, @@ -6853,17 +7195,17 @@ "com.amazonaws.rekognition#StartTextDetectionFilters": { "type": "structure", "members": { - "RegionsOfInterest": { - "target": "com.amazonaws.rekognition#RegionsOfInterest", - "traits": { - "smithy.api#documentation": "

    Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region\n of the screen.

    " - } - }, "WordFilter": { "target": "com.amazonaws.rekognition#DetectionFilter", "traits": { "smithy.api#documentation": "

    Filters focusing on qualities of the text, such as confidence or size.

    " } + }, + "RegionsOfInterest": { + "target": "com.amazonaws.rekognition#RegionsOfInterest", + "traits": { + "smithy.api#documentation": "

    Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region\n of the screen.

    " + } } }, "traits": { @@ -6873,12 +7215,6 @@ "com.amazonaws.rekognition#StartTextDetectionRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.rekognition#StartTextDetectionFilters", - "traits": { - "smithy.api#documentation": "

    Optional parameters that let you set criteria the text must meet to be included in your response.

    " - } - }, "ClientRequestToken": { "target": "com.amazonaws.rekognition#ClientRequestToken", "traits": { @@ -6891,14 +7227,20 @@ "smithy.api#required": {} } }, + "NotificationChannel": { + "target": "com.amazonaws.rekognition#NotificationChannel" + }, "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { "smithy.api#documentation": "

    An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs\n and identify them in the completion notification.

    " } }, - "NotificationChannel": { - "target": "com.amazonaws.rekognition#NotificationChannel" + "Filters": { + "target": "com.amazonaws.rekognition#StartTextDetectionFilters", + "traits": { + "smithy.api#documentation": "

    Optional parameters that let you set criteria the text must meet to be included in your response.

    " + } } } }, @@ -7028,17 +7370,17 @@ "com.amazonaws.rekognition#StreamProcessor": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.rekognition#StreamProcessorName", - "traits": { - "smithy.api#documentation": "

    Name of the Amazon Rekognition stream processor.

    " - } - }, "Status": { "target": "com.amazonaws.rekognition#StreamProcessorStatus", "traits": { "smithy.api#documentation": "

    Current status of the Amazon Rekognition stream processor.

    " } + }, + "Name": { + "target": "com.amazonaws.rekognition#StreamProcessorName", + "traits": { + "smithy.api#documentation": "

    Name of the Amazon Rekognition stream processor.

    " + } } }, "traits": { @@ -7153,17 +7495,17 @@ "com.amazonaws.rekognition#Sunglasses": { "type": "structure", "members": { - "Confidence": { - "target": "com.amazonaws.rekognition#Percent", - "traits": { - "smithy.api#documentation": "

    Level of confidence in the determination.

    " - } - }, "Value": { "target": "com.amazonaws.rekognition#Boolean", "traits": { "smithy.api#documentation": "

    Boolean value that indicates whether the face is wearing sunglasses or not.

    " } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

    Level of confidence in the determination.

    " + } } }, "traits": { @@ -7222,17 +7564,17 @@ "com.amazonaws.rekognition#TestingData": { "type": "structure", "members": { - "Assets": { - "target": "com.amazonaws.rekognition#Assets", - "traits": { - "smithy.api#documentation": "

    The assets used for testing.

    " - } - }, "AutoCreate": { "target": "com.amazonaws.rekognition#Boolean", "traits": { "smithy.api#documentation": "

    If specified, Amazon Rekognition Custom Labels creates a testing dataset with an 80/20 split of the training dataset.

    " } + }, + "Assets": { + "target": "com.amazonaws.rekognition#Assets", + "traits": { + "smithy.api#documentation": "

    The assets used for testing.

    " + } } }, "traits": { @@ -7242,6 +7584,12 @@ "com.amazonaws.rekognition#TestingDataResult": { "type": "structure", "members": { + "Validation": { + "target": "com.amazonaws.rekognition#ValidationData", + "traits": { + "smithy.api#documentation": "

    The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.

    " + } + }, "Input": { "target": "com.amazonaws.rekognition#TestingData", "traits": { @@ -7256,22 +7604,16 @@ } }, "traits": { - "smithy.api#documentation": "

    A Sagemaker Groundtruth format manifest file representing the dataset used for testing.

    " + "smithy.api#documentation": "

    Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.

    " } }, "com.amazonaws.rekognition#TextDetection": { "type": "structure", "members": { - "Id": { + "ParentId": { "target": "com.amazonaws.rekognition#UInteger", "traits": { - "smithy.api#documentation": "

    The identifier for the detected text. The identifier is only unique for a single call\n to DetectText.

    " - } - }, - "Geometry": { - "target": "com.amazonaws.rekognition#Geometry", - "traits": { - "smithy.api#documentation": "

    The location of the detected text on the image. Includes an axis aligned coarse\n bounding box surrounding the text and a finer grain polygon for more accurate spatial\n information.

    " + "smithy.api#documentation": "

    The Parent identifier for the detected text identified by the value of ID.\n If the type of detected text is LINE, the value of ParentId is\n Null.

    " } }, "Type": { @@ -7280,16 +7622,16 @@ "smithy.api#documentation": "

    The type of text that was detected.

    " } }, - "DetectedText": { - "target": "com.amazonaws.rekognition#String", + "Geometry": { + "target": "com.amazonaws.rekognition#Geometry", "traits": { - "smithy.api#documentation": "

    The word or line of text recognized by Amazon Rekognition.

    " + "smithy.api#documentation": "

    The location of the detected text on the image. Includes an axis aligned coarse\n bounding box surrounding the text and a finer grain polygon for more accurate spatial\n information.

    " } }, - "ParentId": { + "Id": { "target": "com.amazonaws.rekognition#UInteger", "traits": { - "smithy.api#documentation": "

    The Parent identifier for the detected text identified by the value of ID.\n If the type of detected text is LINE, the value of ParentId is\n Null.

    " + "smithy.api#documentation": "

    The identifier for the detected text. The identifier is only unique for a single call\n to DetectText.

    " } }, "Confidence": { @@ -7297,6 +7639,12 @@ "traits": { "smithy.api#documentation": "

    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy\n of the geometry points around the detected text.

    " } + }, + "DetectedText": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

    The word or line of text recognized by Amazon Rekognition.

    " + } } }, "traits": { @@ -7312,17 +7660,17 @@ "com.amazonaws.rekognition#TextDetectionResult": { "type": "structure", "members": { - "TextDetection": { - "target": "com.amazonaws.rekognition#TextDetection", - "traits": { - "smithy.api#documentation": "

    Details about text detected in a video.

    " - } - }, "Timestamp": { "target": "com.amazonaws.rekognition#Timestamp", "traits": { "smithy.api#documentation": "

    The time, in milliseconds from the start of the video, that the text was detected.

    " } + }, + "TextDetection": { + "target": "com.amazonaws.rekognition#TextDetection", + "traits": { + "smithy.api#documentation": "

    Details about text detected in a video.

    " + } } }, "traits": { @@ -7353,7 +7701,7 @@ "com.amazonaws.rekognition#ThrottlingException": { "type": "structure", "members": { - "Message": { + "Code": { "target": "com.amazonaws.rekognition#String" }, "Logref": { @@ -7362,7 +7710,7 @@ "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } }, - "Code": { + "Message": { "target": "com.amazonaws.rekognition#String" } }, @@ -7394,21 +7742,27 @@ "com.amazonaws.rekognition#TrainingDataResult": { "type": "structure", "members": { - "Output": { + "Input": { "target": "com.amazonaws.rekognition#TrainingData", "traits": { - "smithy.api#documentation": "

    The images (assets) that were actually trained by Amazon Rekognition Custom Labels.

    " + "smithy.api#documentation": "

    The training assets that you supplied for training.

    " } }, - "Input": { + "Validation": { + "target": "com.amazonaws.rekognition#ValidationData", + "traits": { + "smithy.api#documentation": "

    The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.

    " + } + }, + "Output": { "target": "com.amazonaws.rekognition#TrainingData", "traits": { - "smithy.api#documentation": "

    The training assets that you supplied for training.

    " + "smithy.api#documentation": "

    The images (assets) that were actually trained by Amazon Rekognition Custom Labels.

    " } } }, "traits": { - "smithy.api#documentation": "

    A Sagemaker Groundtruth format manifest file that represents the dataset used for training.

    " + "smithy.api#documentation": "

    Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.

    " } }, "com.amazonaws.rekognition#UInteger": { @@ -7432,17 +7786,17 @@ "com.amazonaws.rekognition#UnindexedFace": { "type": "structure", "members": { - "Reasons": { - "target": "com.amazonaws.rekognition#Reasons", - "traits": { - "smithy.api#documentation": "

    An array of reasons that specify why a face wasn't indexed.

    \n
      \n
    • \n

      EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned\n too far away from the camera.

      \n
      • \n
    • \n

      EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the \n MaxFaces input parameter for IndexFaces.

      \n
      • \n
    • \n

      LOW_BRIGHTNESS - The image is too dark.

      \n
      • \n
    • \n

      LOW_SHARPNESS - The image is too blurry.

      \n
      • \n
    • \n

      LOW_CONFIDENCE - The face was detected with a low confidence.

      \n
      • \n
    • \n

      SMALL_BOUNDING_BOX - The bounding box around the face is too small.

      \n
      • \n
    " - } - }, "FaceDetail": { "target": "com.amazonaws.rekognition#FaceDetail", "traits": { "smithy.api#documentation": "

    The\n structure that contains attributes of a face that\n IndexFacesdetected, but didn't index.

    " } + }, + "Reasons": { + "target": "com.amazonaws.rekognition#Reasons", + "traits": { + "smithy.api#documentation": "

    An array of reasons that specify why a face wasn't indexed.

    \n
      \n
    • \n

      EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned\n too far away from the camera.

      \n
      • \n
    • \n

      EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the \n MaxFaces input parameter for IndexFaces.

      \n
      • \n
    • \n

      LOW_BRIGHTNESS - The image is too dark.

      \n
      • \n
    • \n

      LOW_SHARPNESS - The image is too blurry.

      \n
      • \n
    • \n

      LOW_CONFIDENCE - The face was detected with a low confidence.

      \n
      • \n
    • \n

      SMALL_BOUNDING_BOX - The bounding box around the face is too small.

      \n
      • \n
    " + } } }, "traits": { @@ -7464,6 +7818,20 @@ "target": "com.amazonaws.rekognition#Url" } }, + "com.amazonaws.rekognition#ValidationData": { + "type": "structure", + "members": { + "Assets": { + "target": "com.amazonaws.rekognition#Assets", + "traits": { + "smithy.api#documentation": "

    The assets that comprise the validation data.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains the Amazon S3 bucket location of the validation data for a model training job.

    \n \n

    The validation data includes error information for individual \n JSON lines in the dataset. \n For more information, see Debugging a Failed Model Training in the\n Amazon Rekognition Custom Labels Developer Guide.

    \n

    You get the ValidationData object for the training dataset (TrainingDataResult)\n and the test dataset (TestingDataResult) by calling DescribeProjectVersions.

    \n

    The assets array contains a single Asset object. \n The GroundTruthManifest field of the Asset object contains the S3 bucket location of\n the validation data. \n

    " + } + }, "com.amazonaws.rekognition#VersionName": { "type": "string", "traits": { @@ -7522,24 +7890,12 @@ "com.amazonaws.rekognition#VideoMetadata": { "type": "structure", "members": { - "DurationMillis": { - "target": "com.amazonaws.rekognition#ULong", - "traits": { - "smithy.api#documentation": "

    Length of the video in milliseconds.

    " - } - }, "FrameHeight": { "target": "com.amazonaws.rekognition#ULong", "traits": { "smithy.api#documentation": "

    Vertical pixel dimension of the video.

    " } }, - "FrameRate": { - "target": "com.amazonaws.rekognition#Float", - "traits": { - "smithy.api#documentation": "

    Number of frames per second in the video.

    " - } - }, "FrameWidth": { "target": "com.amazonaws.rekognition#ULong", "traits": { @@ -7557,6 +7913,18 @@ "traits": { "smithy.api#documentation": "

    Type of compression used in the analyzed video.

    " } + }, + "DurationMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

    Length of the video in milliseconds.

    " + } + }, + "FrameRate": { + "target": "com.amazonaws.rekognition#Float", + "traits": { + "smithy.api#documentation": "

    Number of frames per second in the video.

    " + } } }, "traits": { @@ -7572,17 +7940,17 @@ "com.amazonaws.rekognition#VideoTooLargeException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.rekognition#String" - }, - "Code": { - "target": "com.amazonaws.rekognition#String" - }, "Logref": { "target": "com.amazonaws.rekognition#String", "traits": { "smithy.api#documentation": "

    A universally unique identifier (UUID) for the request.

    " } + }, + "Message": { + "target": "com.amazonaws.rekognition#String" + }, + "Code": { + "target": "com.amazonaws.rekognition#String" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/resource-groups-tagging-api.2017-01-26.json b/codegen/sdk-codegen/aws-models/resource-groups-tagging-api.2017-01-26.json index 47d9f0d0c7f1..1a47db06d727 100644 --- a/codegen/sdk-codegen/aws-models/resource-groups-tagging-api.2017-01-26.json +++ b/codegen/sdk-codegen/aws-models/resource-groups-tagging-api.2017-01-26.json @@ -42,18 +42,18 @@ "com.amazonaws.resourcegroupstaggingapi#ComplianceDetails": { "type": "structure", "members": { - "KeysWithNoncompliantValues": { - "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", - "traits": { - "smithy.api#documentation": "

    These are keys defined in the effective policy that are on the resource with either\n incorrect case treatment or noncompliant values.

    " - } - }, "ComplianceStatus": { "target": "com.amazonaws.resourcegroupstaggingapi#ComplianceStatus", "traits": { "smithy.api#documentation": "

    Whether a resource is compliant with the effective tag policy.

    " } }, + "KeysWithNoncompliantValues": { + "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", + "traits": { + "smithy.api#documentation": "

    These are keys defined in the effective policy that are on the resource with either\n incorrect case treatment or noncompliant values.

    " + } + }, "NoncompliantKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", "traits": { @@ -128,29 +128,29 @@ "com.amazonaws.resourcegroupstaggingapi#DescribeReportCreationOutput": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.resourcegroupstaggingapi#ErrorMessage", - "traits": { - "smithy.api#documentation": "

    Details of the common errors that all operations return.

    " - } - }, "StartDate": { "target": "com.amazonaws.resourcegroupstaggingapi#StartDate", "traits": { "smithy.api#documentation": "

    The date and time that the report was started.

    " } }, - "S3Location": { - "target": "com.amazonaws.resourcegroupstaggingapi#S3Location", - "traits": { - "smithy.api#documentation": "

    The path to the Amazon S3 bucket where the report was stored on creation.

    " - } - }, "Status": { "target": "com.amazonaws.resourcegroupstaggingapi#Status", "traits": { "smithy.api#documentation": "

    Reports the status of the operation.

    \n

    The operation status can be one of the following:

    \n
      \n
    • \n

      \n RUNNING - Report creation is in progress.

      \n
      • \n
    • \n

      \n SUCCEEDED - Report creation is complete. You can open the report\n from the Amazon S3 bucket that you specified when you ran\n StartReportCreation.

      \n
      • \n
    • \n

      \n FAILED - Report creation timed out or the Amazon S3 bucket is not\n accessible.

      \n
      • \n
    • \n

      \n NO REPORT - No report was generated in the last 90 days.

      \n
      • \n
    " } + }, + "ErrorMessage": { + "target": "com.amazonaws.resourcegroupstaggingapi#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    Details of the common errors that all operations return.

    " + } + }, + "S3Location": { + "target": "com.amazonaws.resourcegroupstaggingapi#S3Location", + "traits": { + "smithy.api#documentation": "

    The path to the Amazon S3 bucket where the report was stored on creation.

    " + } } } }, @@ -257,16 +257,28 @@ "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummaryInput": { "type": "structure", "members": { + "TagKeyFilters": { + "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyFilterList", + "traits": { + "smithy.api#documentation": "

    A list of tag keys to limit the output by. If you use this parameter, the count of\n returned noncompliant resources includes only resources that have the specified tag\n keys.

    " + } + }, + "ResourceTypeFilters": { + "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList", + "traits": { + "smithy.api#documentation": "

    The constraints on the resources that you want returned. The format of each resource\n type is service[:resourceType]. For example, specifying a resource type of\n ec2 returns all Amazon EC2 resources (which includes EC2 instances).\n Specifying a resource type of ec2:instance returns only EC2 instances.

    \n

    The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). Consult the AWS General\n Reference for the following:

    \n \n

    You can specify multiple resource types by using an array. The array can include up to\n 100 items. Note that the length constraint requirement applies to each resource type\n filter.

    " + } + }, "TargetIdFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#TargetIdFilterList", "traits": { "smithy.api#documentation": "

    The target identifiers (usually, specific account IDs) to limit the output by. If you\n use this parameter, the count of returned noncompliant resources includes only resources\n with the specified target IDs.

    " } }, - "TagKeyFilters": { - "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyFilterList", + "GroupBy": { + "target": "com.amazonaws.resourcegroupstaggingapi#GroupBy", "traits": { - "smithy.api#documentation": "

    A list of tag keys to limit the output by. If you use this parameter, the count of\n returned noncompliant resources includes only resources that have the specified tag\n keys.

    " + "smithy.api#documentation": "

    A list of attributes to group the counts of noncompliant resources by. If supplied,\n the counts are sorted by those attributes.

    " } }, "RegionFilters": { @@ -275,12 +287,6 @@ "smithy.api#documentation": "

    A list of Regions to limit the output by. If you use this parameter, the count of\n returned noncompliant resources includes only resources in the specified Regions.

    " } }, - "ResourceTypeFilters": { - "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList", - "traits": { - "smithy.api#documentation": "

    The constraints on the resources that you want returned. The format of each resource\n type is service[:resourceType]. For example, specifying a resource type of\n ec2 returns all Amazon EC2 resources (which includes EC2 instances).\n Specifying a resource type of ec2:instance returns only EC2 instances.

    \n

    The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). Consult the AWS General\n Reference for the following:

    \n \n

    You can specify multiple resource types by using an array. The array can include up to\n 100 items. Note that the length constraint requirement applies to each resource type\n filter.

    " - } - }, "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { @@ -292,12 +298,6 @@ "traits": { "smithy.api#documentation": "

    A limit that restricts the number of results that are returned per page.

    " } - }, - "GroupBy": { - "target": "com.amazonaws.resourcegroupstaggingapi#GroupBy", - "traits": { - "smithy.api#documentation": "

    A list of attributes to group the counts of noncompliant resources by. If supplied,\n the counts are sorted by those attributes.

    " - } } } }, @@ -359,40 +359,40 @@ "smithy.api#documentation": "

    AWS recommends using ResourcesPerPage instead of this parameter.

    \n

    A limit that restricts the number of tags (key and value pairs) returned by\n GetResources in paginated output. A resource with no tags is counted as having one tag\n (one key and value pair).

    \n

    \n GetResources does not split a resource and its associated tags across\n pages. If the specified TagsPerPage would cause such a break, a\n PaginationToken is returned in place of the affected resource and its\n tags. Use that token in another request to get the remaining data. For example, if you\n specify a TagsPerPage of 100 and the account has 22 resources\n with 10 tags each (meaning that each resource has 10 key and value pairs), the output\n will consist of three pages. The first page displays the first 10 resources, each with\n its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The\n third page displays the remaining 2 resources, each with its 10 tags.

    \n

    You can set TagsPerPage to a minimum of 100 items and the maximum of 500\n items.

    " } }, - "ResourcesPerPage": { - "target": "com.amazonaws.resourcegroupstaggingapi#ResourcesPerPage", - "traits": { - "smithy.api#documentation": "

    A limit that restricts the number of resources returned by GetResources in paginated\n output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100\n items.

    " - } - }, - "PaginationToken": { - "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", - "traits": { - "smithy.api#documentation": "

    A string that indicates that additional data is available. Leave this value empty for\n your initial request. If the response includes a PaginationToken, use that\n string for this value to request an additional page of data.

    " - } - }, "TagFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#TagFilterList", "traits": { "smithy.api#documentation": "

    A list of TagFilters (keys and values). Each TagFilter specified must contain a key\n with values as optional. A request can include up to 50 keys, and each key can include\n up to 20 values.

    \n

    Note the following when deciding how to use TagFilters:

    \n
      \n
    • \n

      If you do specify a TagFilter, the response returns only\n those resources that are currently associated with the specified tag.

      \n
      • \n
    • \n

      If you don't specify a TagFilter, the response includes\n all resources that were ever associated with tags. Resources that currently\n don't have associated tags are shown with an empty tag set, like this:\n \"Tags\": [].

      \n
      • \n
    • \n

      If you specify more than one filter in a single request, the response returns\n only those resources that satisfy all specified filters.

      \n
      • \n
    • \n

      If you specify a filter that contains more than one value for a key, the\n response returns resources that match any of the specified values for that\n key.

      \n
      • \n
    • \n

      If you don't specify any values for a key, the response returns resources that\n are tagged with that key irrespective of the value.

      \n

      For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2,\n {value2,value3,value4}} , filter3 = {key3}:

      \n
        \n
      • \n

        GetResources( {filter1} ) returns resources tagged with\n key1=value1

        \n
        • \n
      • \n

        GetResources( {filter2} ) returns resources tagged with key2=value2 or\n key2=value3 or key2=value4

        \n
        • \n
      • \n

        GetResources( {filter3} ) returns resources tagged with any tag\n containing key3 as its tag key, irrespective of its value

        \n
        • \n
      • \n

        GetResources( {filter1,filter2,filter3} ) returns resources tagged\n with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and\n (key3, irrespective of the value)

        \n
        • \n
      \n
      • \n
    " } }, + "IncludeComplianceDetails": { + "target": "com.amazonaws.resourcegroupstaggingapi#IncludeComplianceDetails", + "traits": { + "smithy.api#documentation": "

    Specifies whether to include details regarding the compliance with the effective tag\n policy. Set this to true to determine whether resources are compliant with\n the tag policy and to get details.

    " + } + }, "ExcludeCompliantResources": { "target": "com.amazonaws.resourcegroupstaggingapi#ExcludeCompliantResources", "traits": { "smithy.api#documentation": "

    Specifies whether to exclude resources that are compliant with the tag policy. Set\n this to true if you are interested in retrieving information on\n noncompliant resources only.

    \n

    You can use this parameter only if the IncludeComplianceDetails parameter\n is also set to true.

    " } }, + "ResourcesPerPage": { + "target": "com.amazonaws.resourcegroupstaggingapi#ResourcesPerPage", + "traits": { + "smithy.api#documentation": "

    A limit that restricts the number of resources returned by GetResources in paginated\n output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100\n items.

    " + } + }, "ResourceTypeFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList", "traits": { "smithy.api#documentation": "

    The constraints on the resources that you want returned. The format of each resource\n type is service[:resourceType]. For example, specifying a resource type of\n ec2 returns all Amazon EC2 resources (which includes EC2 instances).\n Specifying a resource type of ec2:instance returns only EC2 instances.

    \n

    The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). Consult the AWS General\n Reference for the following:

    \n \n

    You can specify multiple resource types by using an array. The array can include up to\n 100 items. Note that the length constraint requirement applies to each resource type\n filter.

    " } }, - "IncludeComplianceDetails": { - "target": "com.amazonaws.resourcegroupstaggingapi#IncludeComplianceDetails", + "PaginationToken": { + "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { - "smithy.api#documentation": "

    Specifies whether to include details regarding the compliance with the effective tag\n policy. Set this to true to determine whether resources are compliant with\n the tag policy and to get details.

    " + "smithy.api#documentation": "

    A string that indicates that additional data is available. Leave this value empty for\n your initial request. If the response includes a PaginationToken, use that\n string for this value to request an additional page of data.

    " } } } @@ -448,31 +448,31 @@ "com.amazonaws.resourcegroupstaggingapi#GetTagKeysInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.resourcegroupstaggingapi#MaxResultTagsDS1" - }, "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

    A string that indicates that additional data is available. Leave this value empty for\n your initial request. If the response includes a PaginationToken, use that\n string for this value to request an additional page of data.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.resourcegroupstaggingapi#MaxResultTagsDS1" } } }, "com.amazonaws.resourcegroupstaggingapi#GetTagKeysOutput": { "type": "structure", "members": { - "PaginationToken": { - "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", - "traits": { - "smithy.api#documentation": "

    A string that indicates that the response contains more data than can be returned in a\n single response. To receive additional data, specify this string for the\n PaginationToken value in a subsequent request.

    " - } - }, "TagKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", "traits": { "smithy.api#documentation": "

    A list of all tag keys in the AWS account.

    " } + }, + "PaginationToken": { + "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", + "traits": { + "smithy.api#documentation": "

    A string that indicates that the response contains more data than can be returned in a\n single response. To receive additional data, specify this string for the\n PaginationToken value in a subsequent request.

    " + } } } }, @@ -510,11 +510,8 @@ "com.amazonaws.resourcegroupstaggingapi#GetTagValuesInput": { "type": "structure", "members": { - "PaginationToken": { - "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", - "traits": { - "smithy.api#documentation": "

    A string that indicates that additional data is available. Leave this value empty for\n your initial request. If the response includes a PaginationToken, use that\n string for this value to request an additional page of data.

    " - } + "MaxResults": { + "target": "com.amazonaws.resourcegroupstaggingapi#MaxResultTagsDS1" }, "Key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", @@ -523,25 +520,28 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.resourcegroupstaggingapi#MaxResultTagsDS1" + "PaginationToken": { + "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", + "traits": { + "smithy.api#documentation": "

    A string that indicates that additional data is available. Leave this value empty for\n your initial request. If the response includes a PaginationToken, use that\n string for this value to request an additional page of data.

    " + } } } }, "com.amazonaws.resourcegroupstaggingapi#GetTagValuesOutput": { "type": "structure", "members": { - "PaginationToken": { - "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", - "traits": { - "smithy.api#documentation": "

    A string that indicates that the response contains more data than can be returned in a\n single response. To receive additional data, specify this string for the\n PaginationToken value in a subsequent request.

    " - } - }, "TagValues": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValuesOutputList", "traits": { "smithy.api#documentation": "

    A list of all tag values for the specified key in the AWS account.

    " } + }, + "PaginationToken": { + "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", + "traits": { + "smithy.api#documentation": "

    A string that indicates that the response contains more data than can be returned in a\n single response. To receive additional data, specify this string for the\n PaginationToken value in a subsequent request.

    " + } } } }, @@ -732,7 +732,7 @@ "name": "tagging" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Resource Groups Tagging API\n\n

    This guide describes the API operations for the resource groups tagging.

    \n

    A tag is a label that you assign to an AWS resource. A tag consists of a key and a\n value, both of which you define. For example, if you have two Amazon EC2 instances, you might\n assign both a tag key of \"Stack.\" But the value of \"Stack\" might be \"Testing\" for one\n and \"Production\" for the other.

    \n

    Tagging can help you organize your resources and enables you to simplify resource\n management, access management and cost allocation.

    \n

    You can use the resource groups tagging API operations to complete the following\n tasks:

    \n\n
      \n
    • \n

      Tag and untag supported resources located in the specified Region for the\n AWS account.

      \n
      • \n
    • \n

      Use tag-based filters to search for resources located in the specified Region\n for the AWS account.

      \n
      • \n
    • \n

      List all existing tag keys in the specified Region for the AWS\n account.

      \n
      • \n
    • \n

      List all existing values for the specified key in the specified Region for the\n AWS account.

      \n
      • \n
    \n\n

    To use resource groups tagging API operations, you must add the following permissions\n to your IAM policy:

    \n\n
      \n
    • \n

      \n tag:GetResources\n

      \n
      • \n
    • \n

      \n tag:TagResources\n

      \n
      • \n
    • \n

      \n tag:UntagResources\n

      \n
      • \n
    • \n

      \n tag:GetTagKeys\n

      \n
      • \n
    • \n

      \n tag:GetTagValues\n

      \n
      • \n
    \n\n

    You'll also need permissions to access the resources of individual services so that\n you can tag and untag those resources.

    \n

    For more information on IAM policies, see Managing IAM\n Policies in the IAM User Guide.

    \n

    You can use the Resource Groups Tagging API to tag resources for the following AWS\n services.

    \n\n
      \n
    • \n

      Alexa for Business (a4b)

      \n
      • \n
    • \n

      API Gateway

      \n
      • \n
    • \n

      Amazon AppStream

      \n
      • \n
    • \n

      AWS AppSync

      \n
      • \n
    • \n

      AWS App Mesh

      \n
      • \n
    • \n

      Amazon Athena

      \n
      • \n
    • \n

      Amazon Aurora

      \n
      • \n
    • \n

      AWS Backup

      \n
      • \n
    • \n

      AWS Certificate Manager

      \n
      • \n
    • \n

      AWS Certificate Manager Private CA

      \n
      • \n
    • \n

      Amazon Cloud Directory

      \n
      • \n
    • \n

      AWS CloudFormation

      \n
      • \n
    • \n

      Amazon CloudFront

      \n
      • \n
    • \n

      AWS CloudHSM

      \n
      • \n
    • \n

      AWS CloudTrail

      \n
      • \n
    • \n

      Amazon CloudWatch (alarms only)

      \n
      • \n
    • \n

      Amazon CloudWatch Events

      \n
      • \n
    • \n

      Amazon CloudWatch Logs

      \n
      • \n
    • \n

      AWS CodeBuild

      \n
      • \n
    • \n

      AWS CodeCommit

      \n
      • \n
    • \n

      AWS CodePipeline

      \n
      • \n
    • \n

      AWS CodeStar

      \n
      • \n
    • \n

      Amazon Cognito Identity

      \n
      • \n
    • \n

      Amazon Cognito User Pools

      \n
      • \n
    • \n

      Amazon Comprehend

      \n
      • \n
    • \n

      AWS Config

      \n
      • \n
    • \n

      AWS Data Exchange

      \n
      • \n
    • \n

      AWS Data Pipeline

      \n
      • \n
    • \n

      AWS Database Migration Service

      \n
      • \n
    • \n

      AWS DataSync

      \n
      • \n
    • \n

      AWS Device Farm

      \n
      • \n
    • \n

      AWS Direct Connect

      \n
      • \n
    • \n

      AWS Directory Service

      \n
      • \n
    • \n

      Amazon DynamoDB

      \n
      • \n
    • \n

      Amazon EBS

      \n
      • \n
    • \n

      Amazon EC2

      \n
      • \n
    • \n

      Amazon ECR

      \n
      • \n
    • \n

      Amazon ECS

      \n
      • \n
    • \n

      Amazon EKS

      \n
      • \n
    • \n

      AWS Elastic Beanstalk

      \n
      • \n
    • \n

      Amazon Elastic File System

      \n
      • \n
    • \n

      Elastic Load Balancing

      \n
      • \n
    • \n

      Amazon ElastiCache

      \n
      • \n
    • \n

      Amazon Elasticsearch Service

      \n
      • \n
    • \n

      AWS Elemental MediaLive

      \n
      • \n
    • \n

      AWS Elemental MediaPackage

      \n
      • \n
    • \n

      AWS Elemental MediaTailor

      \n
      • \n
    • \n

      Amazon EMR

      \n
      • \n
    • \n

      Amazon FSx

      \n
      • \n
    • \n

      Amazon S3 Glacier

      \n
      • \n
    • \n

      AWS Glue

      \n
      • \n
    • \n

      Amazon GuardDuty

      \n
      • \n
    • \n

      Amazon Inspector

      \n
      • \n
    • \n

      AWS IoT Analytics

      \n
      • \n
    • \n

      AWS IoT Core

      \n
      • \n
    • \n

      AWS IoT Device Defender

      \n
      • \n
    • \n

      AWS IoT Device Management

      \n
      • \n
    • \n

      AWS IoT Events

      \n
      • \n
    • \n

      AWS IoT Greengrass

      \n
      • \n
    • \n

      AWS IoT 1-Click

      \n
      • \n
    • \n

      AWS IoT Things Graph

      \n
      • \n
    • \n

      AWS Key Management Service

      \n
      • \n
    • \n

      Amazon Kinesis

      \n
      • \n
    • \n

      Amazon Kinesis Data Analytics

      \n
      • \n
    • \n

      Amazon Kinesis Data Firehose

      \n
      • \n
    • \n

      AWS Lambda

      \n
      • \n
    • \n

      AWS License Manager

      \n
      • \n
    • \n

      Amazon Machine Learning

      \n
      • \n
    • \n

      Amazon MQ

      \n
      • \n
    • \n

      Amazon MSK

      \n
      • \n
    • \n

      Amazon Neptune

      \n
      • \n
    • \n

      AWS OpsWorks

      \n
      • \n
    • \n

      AWS Organizations

      \n
      • \n
    • \n

      Amazon Quantum Ledger Database (QLDB)

      \n
      • \n
    • \n

      Amazon RDS

      \n
      • \n
    • \n

      Amazon Redshift

      \n
      • \n
    • \n

      AWS Resource Access Manager

      \n
      • \n
    • \n

      AWS Resource Groups

      \n
      • \n
    • \n

      AWS RoboMaker

      \n
      • \n
    • \n

      Amazon Route 53

      \n
      • \n
    • \n

      Amazon Route 53 Resolver

      \n
      • \n
    • \n

      Amazon S3 (buckets only)

      \n
      • \n
    • \n

      Amazon SageMaker

      \n
      • \n
    • \n

      AWS Secrets Manager

      \n
      • \n
    • \n

      AWS Security Hub

      \n
      • \n
    • \n

      AWS Service Catalog

      \n
      • \n
    • \n

      Amazon Simple Email Service (SES)

      \n
      • \n
    • \n

      Amazon Simple Notification Service (SNS)

      \n
      • \n
    • \n

      Amazon Simple Queue Service (SQS)

      \n
      • \n
    • \n

      Amazon Simple Workflow Service

      \n
      • \n
    • \n

      AWS Step Functions

      \n
      • \n
    • \n

      AWS Storage Gateway

      \n
      • \n
    • \n

      AWS Systems Manager

      \n
      • \n
    • \n

      AWS Transfer for SFTP

      \n
      • \n
    • \n

      AWS WAF Regional

      \n
      • \n
    • \n

      Amazon VPC

      \n
      • \n
    • \n

      Amazon WorkSpaces

      \n
      • \n
    ", + "smithy.api#documentation": "Resource Groups Tagging API\n

    This guide describes the API operations for the resource groups tagging.

    \n

    A tag is a label that you assign to an AWS resource. A tag consists of a key and a\n value, both of which you define. For example, if you have two Amazon EC2 instances, you might\n assign both a tag key of \"Stack.\" But the value of \"Stack\" might be \"Testing\" for one\n and \"Production\" for the other.

    \n \n

    Do not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.

    \n     \n

    Tagging can help you organize your resources and enables you to simplify resource\n management, access management and cost allocation.

    \n

    You can use the resource groups tagging API operations to complete the following\n tasks:

    \n
      \n
    • \n

      Tag and untag supported resources located in the specified Region for the\n AWS account.

      \n
      • \n
    • \n

      Use tag-based filters to search for resources located in the specified Region\n for the AWS account.

      \n
      • \n
    • \n

      List all existing tag keys in the specified Region for the AWS\n account.

      \n
      • \n
    • \n

      List all existing values for the specified key in the specified Region for the\n AWS account.

      \n
      • \n
    \n

    To use resource groups tagging API operations, you must add the following permissions\n to your IAM policy:

    \n
      \n
    • \n

      \n tag:GetResources\n

      \n
      • \n
    • \n

      \n tag:TagResources\n

      \n
      • \n
    • \n

      \n tag:UntagResources\n

      \n
      • \n
    • \n

      \n tag:GetTagKeys\n

      \n
      • \n
    • \n

      \n tag:GetTagValues\n

      \n
      • \n
    \n

    You'll also need permissions to access the resources of individual services so that\n you can tag and untag those resources.

    \n

    For more information on IAM policies, see Managing IAM\n Policies in the IAM User Guide.

    \n

    \n \n Services that support the Resource Groups Tagging\n API\n \n

    \n

    You can use the Resource Groups Tagging API to tag resources for the following AWS\n services.

    \n ", "smithy.api#title": "AWS Resource Groups Tagging API" } }, @@ -787,7 +787,7 @@ "min": 3, "max": 63 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "[a-z0-9.-]*" } }, "com.amazonaws.resourcegroupstaggingapi#S3Location": { @@ -850,10 +850,10 @@ "com.amazonaws.resourcegroupstaggingapi#Summary": { "type": "structure", "members": { - "LastUpdated": { - "target": "com.amazonaws.resourcegroupstaggingapi#LastUpdated", + "TargetId": { + "target": "com.amazonaws.resourcegroupstaggingapi#TargetId", "traits": { - "smithy.api#documentation": "

    The timestamp that shows when this summary was generated in this Region.

    " + "smithy.api#documentation": "

    The account identifier or the root identifier of the organization. If you don't know\n the root ID, you can call the AWS Organizations ListRoots API.

    " } }, "ResourceType": { @@ -862,29 +862,29 @@ "smithy.api#documentation": "

    The AWS resource type.

    " } }, - "Region": { - "target": "com.amazonaws.resourcegroupstaggingapi#Region", - "traits": { - "smithy.api#documentation": "

    The AWS Region that the summary applies to.

    " - } - }, "TargetIdType": { "target": "com.amazonaws.resourcegroupstaggingapi#TargetIdType", "traits": { "smithy.api#documentation": "

    Whether the target is an account, an OU, or the organization root.

    " } }, - "TargetId": { - "target": "com.amazonaws.resourcegroupstaggingapi#TargetId", - "traits": { - "smithy.api#documentation": "

    The account identifier or the root identifier of the organization. If you don't know\n the root ID, you can call the AWS Organizations ListRoots API.

    " - } - }, "NonCompliantResources": { "target": "com.amazonaws.resourcegroupstaggingapi#NonCompliantResources", "traits": { "smithy.api#documentation": "

    The count of noncompliant resources.

    " } + }, + "LastUpdated": { + "target": "com.amazonaws.resourcegroupstaggingapi#LastUpdated", + "traits": { + "smithy.api#documentation": "

    The timestamp that shows when this summary was generated in this Region.

    " + } + }, + "Region": { + "target": "com.amazonaws.resourcegroupstaggingapi#Region", + "traits": { + "smithy.api#documentation": "

    The AWS Region that the summary applies to.

    " + } } }, "traits": { @@ -900,17 +900,17 @@ "com.amazonaws.resourcegroupstaggingapi#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.resourcegroupstaggingapi#TagValue", + "Key": { + "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", "traits": { - "smithy.api#documentation": "

    One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

    ", + "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    ", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", + "Value": { + "target": "com.amazonaws.resourcegroupstaggingapi#TagValue", "traits": { - "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    ", + "smithy.api#documentation": "

    One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

    ", "smithy.api#required": {} } } @@ -922,17 +922,17 @@ "com.amazonaws.resourcegroupstaggingapi#TagFilter": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", - "traits": { - "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    " - } - }, "Values": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValueList", "traits": { "smithy.api#documentation": "

    One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

    " } + }, + "Key": { + "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", + "traits": { + "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    " + } } }, "traits": { @@ -1032,7 +1032,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Applies one or more tags to the specified resources. Note the following:

    \n
      \n
    • \n

      Not all resources can have tags. For a list of services that support tagging,\n see this list.

      \n
      • \n
    • \n

      Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage\n Conventions in the AWS General\n Reference.\n

      \n
      • \n
    • \n

      You can only tag resources that are located in the specified Region for the\n AWS account.

      \n
      • \n
    • \n

      To add tags to a resource, you need the necessary permissions for the service\n that the resource belongs to as well as permissions for adding tags. For more\n information, see this list.

      \n
      • \n
    " + "smithy.api#documentation": "

    Applies one or more tags to the specified resources. Note the following:

    \n
      \n
    • \n

      Not all resources can have tags. For a list of services that support tagging,\n see this list.

      \n
      • \n
    • \n

      Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage\n Conventions in the AWS General\n Reference.\n

      \n
      • \n
    • \n

      You can only tag resources that are located in the specified Region for the\n AWS account.

      \n
      • \n
    • \n

      To add tags to a resource, you need the necessary permissions for the service\n that the resource belongs to as well as permissions for adding tags. For more\n information, see this list.

      \n
      • \n
    \n \n

    Do not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.

    \n     " } }, "com.amazonaws.resourcegroupstaggingapi#TagResourcesInput": { @@ -1106,7 +1106,7 @@ "min": 6, "max": 68 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "[a-zA-Z0-9-]*" } }, "com.amazonaws.resourcegroupstaggingapi#TargetIdFilterList": { @@ -1178,17 +1178,17 @@ "com.amazonaws.resourcegroupstaggingapi#UntagResourcesInput": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyListForUntag", + "ResourceARNList": { + "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNList", "traits": { - "smithy.api#documentation": "

    A list of the tag keys that you want to remove from the specified resources.

    ", + "smithy.api#documentation": "

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. For more\n information, see Amazon Resource\n Names (ARNs) and AWS Service Namespaces in the AWS General\n Reference.

    ", "smithy.api#required": {} } }, - "ResourceARNList": { - "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNList", + "TagKeys": { + "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyListForUntag", "traits": { - "smithy.api#documentation": "

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. For more\n information, see Amazon Resource\n Names (ARNs) and AWS Service Namespaces in the AWS General\n Reference.

    ", + "smithy.api#documentation": "

    A list of the tag keys that you want to remove from the specified resources.

    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/resource-groups.2017-11-27.json b/codegen/sdk-codegen/aws-models/resource-groups.2017-11-27.json index e5a675c2ef54..9e051601bc10 100644 --- a/codegen/sdk-codegen/aws-models/resource-groups.2017-11-27.json +++ b/codegen/sdk-codegen/aws-models/resource-groups.2017-11-27.json @@ -90,7 +90,7 @@ "name": "resource-groups" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Resource Groups\n\n

    AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances,\n Amazon Relational Database Service databases, and Amazon S3 buckets into groups using\n criteria that you define as tags. A resource group is a collection of resources that\n match the resource types specified in a query, and share one or more tags or portions of\n tags. You can create a group of resources based on their roles in your cloud\n infrastructure, lifecycle stages, regions, application layers, or virtually any\n criteria. Resource groups enable you to automate management tasks, such as those in AWS\n Systems Manager Automation documents, on tag-related resources in AWS Systems Manager.\n Groups of tagged resources also let you quickly view a custom console in AWS Systems\n Manager that shows AWS Config compliance and other monitoring data about member\n resources.

    \n

    To create a resource group, build a resource query, and specify tags that identify the\n criteria that members of the group have in common. Tags are key-value pairs.

    \n

    For more information about Resource Groups, see the AWS Resource Groups User\n Guide.

    \n

    AWS Resource Groups uses a REST-compliant API that you can use to perform the\n following types of operations.

    \n
      \n
    • \n

      Create, Read, Update, and Delete (CRUD) operations on resource groups and\n resource query entities

      \n
      • \n
    • \n

      Applying, editing, and removing tags from resource groups

      \n
      • \n
    • \n

      Resolving resource group member ARNs so they can be returned as search\n results

      \n
      • \n
    • \n

      Getting data about resources that are members of a group

      \n
      • \n
    • \n

      Searching AWS resources based on a resource query

      \n
      • \n
    ", + "smithy.api#documentation": "AWS Resource Groups\n\n

    AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service\n databases, and Amazon S3 buckets into groups using criteria that you define as tags. A\n resource group is a collection of resources that match the resource types specified in a\n query, and share one or more tags or portions of tags. You can create a group of\n resources based on their roles in your cloud infrastructure, lifecycle stages, regions,\n application layers, or virtually any criteria. Resource Groups enable you to automate management\n tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in\n AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in\n AWS Systems Manager that shows AWS Config compliance and other monitoring data about member\n resources.

    \n

    To create a resource group, build a resource query, and specify tags that identify the\n criteria that members of the group have in common. Tags are key-value pairs.

    \n

    For more information about Resource Groups, see the AWS Resource Groups User Guide.

    \n

    AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of\n operations.

    \n
      \n
    • \n

      Create, Read, Update, and Delete (CRUD) operations on resource groups and\n resource query entities

      \n
      • \n
    • \n

      Applying, editing, and removing tags from resource groups

      \n
      • \n
    • \n

      Resolving resource group member ARNs so they can be returned as search\n results

      \n
      • \n
    • \n

      Getting data about resources that are members of a group

      \n
      • \n
    • \n

      Searching AWS resources based on a resource query

      \n
      • \n
    ", "smithy.api#title": "AWS Resource Groups" } }, @@ -144,10 +144,10 @@ "com.amazonaws.resourcegroups#CreateGroupInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.resourcegroups#Tags", + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery", "traits": { - "smithy.api#documentation": "

    The tags to add to the group. A tag is key-value pair string.

    " + "smithy.api#documentation": "

    The resource query that determines which AWS resources are members of this\n group.

    \n \n

    You can specify either a ResourceQuery or a\n Configuration, but not both.

    \n     " } }, "Description": { @@ -163,10 +163,10 @@ "smithy.api#required": {} } }, - "ResourceQuery": { - "target": "com.amazonaws.resourcegroups#ResourceQuery", + "Tags": { + "target": "com.amazonaws.resourcegroups#Tags", "traits": { - "smithy.api#documentation": "

    The resource query that determines which AWS resources are members of this\n group.

    \n \n

    You can specify either a ResourceQuery or a\n Configuration, but not both.

    \n     " + "smithy.api#documentation": "

    The tags to add to the group. A tag is key-value pair string.

    " } }, "Configuration": { @@ -180,10 +180,10 @@ "com.amazonaws.resourcegroups#CreateGroupOutput": { "type": "structure", "members": { - "Group": { - "target": "com.amazonaws.resourcegroups#Group", + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery", "traits": { - "smithy.api#documentation": "

    The description of the resource group.

    " + "smithy.api#documentation": "

    The resource query associated with the group.

    " } }, "Tags": { @@ -198,10 +198,10 @@ "smithy.api#documentation": "

    The service configuration associated with the resource group. AWS Resource Groups\n supports adding service configurations for the following resource group types:

    \n " } }, - "ResourceQuery": { - "target": "com.amazonaws.resourcegroups#ResourceQuery", + "Group": { + "target": "com.amazonaws.resourcegroups#Group", "traits": { - "smithy.api#documentation": "

    The resource query associated with the group.

    " + "smithy.api#documentation": "

    The description of the resource group.

    " } } } @@ -246,6 +246,12 @@ "com.amazonaws.resourcegroups#DeleteGroupInput": { "type": "structure", "members": { + "Group": { + "target": "com.amazonaws.resourcegroups#GroupString", + "traits": { + "smithy.api#documentation": "

    The name or the ARN of the resource group to delete.

    " + } + }, "GroupName": { "target": "com.amazonaws.resourcegroups#GroupName", "traits": { @@ -254,12 +260,6 @@ }, "smithy.api#documentation": "

    Don't use this parameter. Use Group instead.

    " } - }, - "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", - "traits": { - "smithy.api#documentation": "

    The name or the ARN of the resource group to delete.

    " - } } } }, @@ -305,10 +305,10 @@ "com.amazonaws.resourcegroups#FailedResource": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.resourcegroups#ErrorCode", + "ResourceArn": { + "target": "com.amazonaws.resourcegroups#ResourceArn", "traits": { - "smithy.api#documentation": "

    The error code associated with the failure.

    " + "smithy.api#documentation": "

    The ARN of the resource that failed to be added or removed.

    " } }, "ErrorMessage": { @@ -317,10 +317,10 @@ "smithy.api#documentation": "

    The error message text associated with the failure.

    " } }, - "ResourceArn": { - "target": "com.amazonaws.resourcegroups#ResourceArn", + "ErrorCode": { + "target": "com.amazonaws.resourcegroups#ErrorCode", "traits": { - "smithy.api#documentation": "

    The ARN of the resource that failed to be added or removed.

    " + "smithy.api#documentation": "

    The error code associated with the failure.

    " } } }, @@ -446,6 +446,12 @@ "com.amazonaws.resourcegroups#GetGroupInput": { "type": "structure", "members": { + "Group": { + "target": "com.amazonaws.resourcegroups#GroupString", + "traits": { + "smithy.api#documentation": "

    The name or the ARN of the resource group to retrieve.

    " + } + }, "GroupName": { "target": "com.amazonaws.resourcegroups#GroupName", "traits": { @@ -454,12 +460,6 @@ }, "smithy.api#documentation": "

    Don't use this parameter. Use Group instead.

    " } - }, - "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", - "traits": { - "smithy.api#documentation": "

    The name or the ARN of the resource group to retrieve.

    " - } } } }, @@ -595,28 +595,27 @@ "com.amazonaws.resourcegroups#GetTagsOutput": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", - "traits": { - "smithy.api#documentation": "

    The ARN of the tagged resource group.

    " - } - }, "Tags": { "target": "com.amazonaws.resourcegroups#Tags", "traits": { "smithy.api#documentation": "

    The tags associated with the specified resource group.

    " } + }, + "Arn": { + "target": "com.amazonaws.resourcegroups#GroupArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the tagged resource group.

    " + } } } }, "com.amazonaws.resourcegroups#Group": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.resourcegroups#GroupName", + "Description": { + "target": "com.amazonaws.resourcegroups#Description", "traits": { - "smithy.api#documentation": "

    The name of the resource group.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The description of the resource group.

    " } }, "GroupArn": { @@ -626,15 +625,16 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.resourcegroups#Description", + "Name": { + "target": "com.amazonaws.resourcegroups#GroupName", "traits": { - "smithy.api#documentation": "

    The description of the resource group.

    " + "smithy.api#documentation": "

    The name of the resource group.

    ", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    A resource group that contains AWS resources. You can assign resources to the group by\n associating either of the following elements with the group:

    \n
      \n
    • \n

      \n ResourceQuery - Use a resource query to specify a set of tag\n keys and values. All resources in the same AWS Region and AWS account that have\n those keys with the same values are included in the group. You can add a\n resource query when you create the\n group.

      \n
      • \n
    • \n

      \n GroupConfiguration - Use a service configuration to\n associate the group with an AWS service. The configuration specifies which\n resource types can be included in the group.

      \n
      • \n
    " + "smithy.api#documentation": "

    A resource group that contains AWS resources. You can assign resources to the group\n by associating either of the following elements with the group:

    \n
      \n
    • \n

      \n ResourceQuery - Use a resource query to specify a set of tag\n keys and values. All resources in the same AWS Region and AWS account that\n have those keys with the same values are included in the group. You can add a\n resource query when you create the\n group.

      \n
      • \n
    • \n

      \n GroupConfiguration - Use a service configuration to\n associate the group with an AWS service. The configuration specifies which\n resource types can be included in the group.

      \n
      • \n
    " } }, "com.amazonaws.resourcegroups#GroupArn": { @@ -650,18 +650,18 @@ "com.amazonaws.resourcegroups#GroupConfiguration": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.resourcegroups#GroupConfigurationStatus", - "traits": { - "smithy.api#documentation": "

    The current status of an attempt to update the group configuration.

    " - } - }, "ProposedConfiguration": { "target": "com.amazonaws.resourcegroups#GroupConfigurationList", "traits": { "smithy.api#documentation": "

    If present, the new configuration that is in the process of being applied to the\n group.

    " } }, + "Status": { + "target": "com.amazonaws.resourcegroups#GroupConfigurationStatus", + "traits": { + "smithy.api#documentation": "

    The current status of an attempt to update the group configuration.

    " + } + }, "FailureReason": { "target": "com.amazonaws.resourcegroups#GroupConfigurationFailureReason", "traits": { @@ -688,7 +688,7 @@ "Type": { "target": "com.amazonaws.resourcegroups#GroupConfigurationType", "traits": { - "smithy.api#documentation": "

    Specifies the type of group configuration item. Each item must have a unique value for\n type.

    \n

    You can specify the following string values:

    \n
      \n
    • \n

      \n AWS::EC2::CapacityReservationPool\n

      \n

      For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users\n Guide.

      \n
      • \n
    • \n

      \n AWS::ResourceGroups::Generic - Supports parameters that configure\n the behavior of resource groups of any type.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies the type of group configuration item. Each item must have a unique value for\n type.

    \n

    You can specify the following string values:

    \n
      \n
    • \n

      \n AWS::EC2::CapacityReservationPool\n

      \n

      For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2\n Users Guide.

      \n
      • \n
    • \n

      \n AWS::ResourceGroups::Generic - Supports parameters that configure\n the behavior of resource groups of any type.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -721,7 +721,7 @@ "Name": { "target": "com.amazonaws.resourcegroups#GroupConfigurationParameterName", "traits": { - "smithy.api#documentation": "

    The name of the group configuration parameter.

    \n

    You can specify the following string values:

    \n
      \n
    • \n

      For configuration item type AWS::ResourceGroups::Generic:

      \n
        \n
      • \n

        \n allowed-resource-types\n

        \n

        Specifies the types of resources that you can add to this group by\n using the GroupResources operation.

        \n
        • \n
      \n
      • \n
    • \n

      For configuration item type\n AWS::EC2::CapacityReservationPool:

      \n
        \n
      • \n

        None - This configuration item type doesn't support any\n parameters.

        \n
        • \n
      \n

      For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users\n Guide.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the group configuration parameter.

    \n

    You can specify the following string values:

    \n
      \n
    • \n

      For configuration item type AWS::ResourceGroups::Generic:

      \n
        \n
      • \n

        \n allowed-resource-types\n

        \n

        Specifies the types of resources that you can add to this group by\n using the GroupResources operation.

        \n
        • \n
      \n
      • \n
    • \n

      For configuration item type\n AWS::EC2::CapacityReservationPool:

      \n
        \n
      • \n

        None - This configuration item type doesn't support any\n parameters.

        \n
        • \n
      \n

      For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2\n Users Guide.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -794,17 +794,17 @@ "com.amazonaws.resourcegroups#GroupFilter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.resourcegroups#GroupFilterName", + "Values": { + "target": "com.amazonaws.resourcegroups#GroupFilterValues", "traits": { - "smithy.api#documentation": "

    The name of the filter. Filter names are case-sensitive.

    ", + "smithy.api#documentation": "

    One or more filter values. Allowed filter values vary by group filter name, and are\n case-sensitive.

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.resourcegroups#GroupFilterValues", + "Name": { + "target": "com.amazonaws.resourcegroups#GroupFilterName", "traits": { - "smithy.api#documentation": "

    One or more filter values. Allowed filter values vary by group filter name, and are\n case-sensitive.

    ", + "smithy.api#documentation": "

    The name of the filter. Filter names are case-sensitive.

    ", "smithy.api#required": {} } } @@ -859,17 +859,17 @@ "com.amazonaws.resourcegroups#GroupIdentifier": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.resourcegroups#GroupName", - "traits": { - "smithy.api#documentation": "

    The name of the resource group.

    " - } - }, "GroupArn": { "target": "com.amazonaws.resourcegroups#GroupArn", "traits": { "smithy.api#documentation": "

    The ARN of the resource group.

    " } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "

    The name of the resource group.

    " + } } }, "traits": { @@ -907,17 +907,17 @@ "com.amazonaws.resourcegroups#GroupQuery": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.resourcegroups#GroupName", + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery", "traits": { - "smithy.api#documentation": "

    The name of the resource group that is associated with the specified resource\n query.

    ", + "smithy.api#documentation": "

    The resource query that determines which AWS resources are members of the associated\n resource group.

    ", "smithy.api#required": {} } }, - "ResourceQuery": { - "target": "com.amazonaws.resourcegroups#ResourceQuery", + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", "traits": { - "smithy.api#documentation": "

    The resource query that determines which AWS resources are members of the associated\n resource group.

    ", + "smithy.api#documentation": "

    The name of the resource group that is associated with the specified resource\n query.

    ", "smithy.api#required": {} } } @@ -1070,37 +1070,37 @@ "com.amazonaws.resourcegroups#ListGroupResourcesInput": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.resourcegroups#MaxResults", + "traits": { + "smithy.api#documentation": "

    The total number of results that you want included on each page of the \nresponse. If you do not include this parameter, it defaults to a value that is specific to the \noperation. If additional items exist beyond the maximum you specify, the NextToken \nresponse element is present and has a value (is not null). Include that value as the \nNextToken request parameter in the next call to the operation to get the next part \nof the results. Note that the service might return fewer results than the maximum even when there \nare more results available. You should check NextToken after every operation to \nensure that you receive all of the results.

    " + } + }, "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { "smithy.api#documentation": "

    The name or the ARN of the resource group

    " } }, - "GroupName": { - "target": "com.amazonaws.resourcegroups#GroupName", + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", "traits": { - "smithy.api#deprecated": { - "message": "This field is deprecated, use Group instead." - }, - "smithy.api#documentation": "

    Don't use this parameter. Use Group instead.

    " + "smithy.api#documentation": "

    The parameter for receiving additional results if you receive a\nNextToken response in a previous request. A NextToken response \nindicates that more output is available. Set this parameter to the value provided by a previous \ncall's NextToken response to indicate where the output should continue from.

    " } }, "Filters": { "target": "com.amazonaws.resourcegroups#ResourceFilterList", "traits": { - "smithy.api#documentation": "

    Filters, formatted as ResourceFilter objects, that you want to apply\n to a ListGroupResources operation. Filters the results to include only\n those of the specified resource types.

    \n
      \n
    • \n

      \n resource-type - Filter resources by their type. Specify up to\n five resource types in the format AWS::ServiceCode::ResourceType.\n For example, AWS::EC2::Instance, or AWS::S3::Bucket.\n

      \n
      • \n
    \n

    When you specify a resource-type filter for\n ListGroupResources, AWS Resource Groups validates your filter resource\n types against the types that are defined in the query associated with the group. For\n example, if a group contains only S3 buckets because its query specifies only that\n resource type, but your resource-type filter includes EC2 instances, AWS\n Resource Groups does not filter for EC2 instances. In this case, a\n ListGroupResources request returns a BadRequestException\n error with a message similar to the following:

    \n

    \n The resource types specified as filters in the request are not\n valid.\n

    \n

    The error includes a list of resource types that failed the validation because they\n are not part of the query associated with the group. This validation doesn't occur when\n the group query specifies AWS::AllSupported, because a group based on such\n a query can contain any of the allowed resource types for the query type (tag-based or\n AWS CloudFormation stack-based queries).

    " + "smithy.api#documentation": "

    Filters, formatted as ResourceFilter objects, that you want to apply\n to a ListGroupResources operation. Filters the results to include only\n those of the specified resource types.

    \n
      \n
    • \n

      \n resource-type - Filter resources by their type. Specify up to\n five resource types in the format AWS::ServiceCode::ResourceType.\n For example, AWS::EC2::Instance, or AWS::S3::Bucket.\n

      \n
      • \n
    \n

    When you specify a resource-type filter for\n ListGroupResources, AWS Resource Groups validates your filter resource types\n against the types that are defined in the query associated with the group. For example,\n if a group contains only S3 buckets because its query specifies only that resource type,\n but your resource-type filter includes EC2 instances, AWS Resource Groups\n does not filter for EC2 instances. In this case, a ListGroupResources\n request returns a BadRequestException error with a message similar to the\n following:

    \n

    \n The resource types specified as filters in the request are not\n valid.\n

    \n

    The error includes a list of resource types that failed the validation because they\n are not part of the query associated with the group. This validation doesn't occur when\n the group query specifies AWS::AllSupported, because a group based on such\n a query can contain any of the allowed resource types for the query type (tag-based or\n AWS CloudFormation stack-based queries).

    " } }, - "NextToken": { - "target": "com.amazonaws.resourcegroups#NextToken", - "traits": { - "smithy.api#documentation": "

    The parameter for receiving additional results if you receive a\n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value provided by a previous \n call's NextToken response to indicate where the output should continue from.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.resourcegroups#MaxResults", + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", "traits": { - "smithy.api#documentation": "

    The total number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value that is specific to the \n operation. If additional items exist beyond the maximum you specify, the NextToken \n response element is present and has a value (is not null). Include that value as the \n NextToken request parameter in the next call to the operation to get the next part \n of the results. Note that the service might return fewer results than the maximum even when there \n are more results available. You should check NextToken after every operation to \n ensure that you receive all of the results.

    " + "smithy.api#deprecated": { + "message": "This field is deprecated, use Group instead." + }, + "smithy.api#documentation": "

    Don't use this parameter. Use Group instead.

    " } } } @@ -1108,10 +1108,10 @@ "com.amazonaws.resourcegroups#ListGroupResourcesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.resourcegroups#NextToken", + "ResourceIdentifiers": { + "target": "com.amazonaws.resourcegroups#ResourceIdentifierList", "traits": { - "smithy.api#documentation": "

    If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

    " + "smithy.api#documentation": "

    The ARNs and resource types of resources that are members of the group that you\n specified.

    " } }, "QueryErrors": { @@ -1120,10 +1120,10 @@ "smithy.api#documentation": "

    A list of QueryError objects. Each error is an object that contains\n ErrorCode and Message structures. Possible values for\n ErrorCode are CLOUDFORMATION_STACK_INACTIVE and\n CLOUDFORMATION_STACK_NOT_EXISTING.

    " } }, - "ResourceIdentifiers": { - "target": "com.amazonaws.resourcegroups#ResourceIdentifierList", + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", "traits": { - "smithy.api#documentation": "

    The ARNs and resource types of resources that are members of the group that you\n specified.

    " + "smithy.api#documentation": "

    If present, indicates that more output is available than is \nincluded in the current response. Use this value in the NextToken request parameter \nin a subsequent call to the operation to get the next part of the output. You should repeat this \nuntil the NextToken response element comes back as null.

    " } } } @@ -1170,20 +1170,20 @@ "com.amazonaws.resourcegroups#ListGroupsInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.resourcegroups#NextToken", - "traits": { - "smithy.api#documentation": "

    The parameter for receiving additional results if you receive a\n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value provided by a previous \n call's NextToken response to indicate where the output should continue from.

    ", - "smithy.api#httpQuery": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.resourcegroups#MaxResults", "traits": { - "smithy.api#documentation": "

    The total number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value that is specific to the \n operation. If additional items exist beyond the maximum you specify, the NextToken \n response element is present and has a value (is not null). Include that value as the \n NextToken request parameter in the next call to the operation to get the next part \n of the results. Note that the service might return fewer results than the maximum even when there \n are more results available. You should check NextToken after every operation to \n ensure that you receive all of the results.

    ", + "smithy.api#documentation": "

    The total number of results that you want included on each page of the \nresponse. If you do not include this parameter, it defaults to a value that is specific to the \noperation. If additional items exist beyond the maximum you specify, the NextToken \nresponse element is present and has a value (is not null). Include that value as the \nNextToken request parameter in the next call to the operation to get the next part \nof the results. Note that the service might return fewer results than the maximum even when there \nare more results available. You should check NextToken after every operation to \nensure that you receive all of the results.

    ", "smithy.api#httpQuery": "maxResults" } }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "

    The parameter for receiving additional results if you receive a\nNextToken response in a previous request. A NextToken response \nindicates that more output is available. Set this parameter to the value provided by a previous \ncall's NextToken response to indicate where the output should continue from.

    ", + "smithy.api#httpQuery": "nextToken" + } + }, "Filters": { "target": "com.amazonaws.resourcegroups#GroupFilterList", "traits": { @@ -1195,16 +1195,16 @@ "com.amazonaws.resourcegroups#ListGroupsOutput": { "type": "structure", "members": { - "GroupIdentifiers": { - "target": "com.amazonaws.resourcegroups#GroupIdentifierList", + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", "traits": { - "smithy.api#documentation": "

    A list of GroupIdentifier objects. Each identifier is an object that\n contains both the Name and the GroupArn.

    " + "smithy.api#documentation": "

    If present, indicates that more output is available than is \nincluded in the current response. Use this value in the NextToken request parameter \nin a subsequent call to the operation to get the next part of the output. You should repeat this \nuntil the NextToken response element comes back as null.

    " } }, - "NextToken": { - "target": "com.amazonaws.resourcegroups#NextToken", + "GroupIdentifiers": { + "target": "com.amazonaws.resourcegroups#GroupIdentifierList", "traits": { - "smithy.api#documentation": "

    If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

    " + "smithy.api#documentation": "

    A list of GroupIdentifier objects. Each identifier is an object that\n contains both the Name and the GroupArn.

    " } }, "Groups": { @@ -1291,7 +1291,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A two-part error structure that can occur in ListGroupResources or\n SearchResources operations on CloudFormation stack-based queries. The\n error occurs if the CloudFormation stack on which the query is based either does not\n exist, or has a status that renders the stack inactive. A QueryError\n occurrence does not necessarily mean that AWS Resource Groups could not complete the\n operation, but the resulting group might have no member resources.

    " + "smithy.api#documentation": "

    A two-part error structure that can occur in ListGroupResources or\n SearchResources operations on CloudFormation stack-based queries. The error\n occurs if the CloudFormation stack on which the query is based either does not exist, or has a\n status that renders the stack inactive. A QueryError occurrence does not\n necessarily mean that AWS Resource Groups could not complete the operation, but the resulting\n group might have no member resources.

    " } }, "com.amazonaws.resourcegroups#QueryErrorCode": { @@ -1359,17 +1359,17 @@ "com.amazonaws.resourcegroups#ResourceFilter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.resourcegroups#ResourceFilterName", + "Values": { + "target": "com.amazonaws.resourcegroups#ResourceFilterValues", "traits": { - "smithy.api#documentation": "

    The name of the filter. Filter names are case-sensitive.

    ", + "smithy.api#documentation": "

    One or more filter values. Allowed filter values vary by resource filter name, and are\n case-sensitive.

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.resourcegroups#ResourceFilterValues", + "Name": { + "target": "com.amazonaws.resourcegroups#ResourceFilterName", "traits": { - "smithy.api#documentation": "

    One or more filter values. Allowed filter values vary by resource filter name, and are\n case-sensitive.

    ", + "smithy.api#documentation": "

    The name of the filter. Filter names are case-sensitive.

    ", "smithy.api#required": {} } } @@ -1420,17 +1420,17 @@ "com.amazonaws.resourcegroups#ResourceIdentifier": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.resourcegroups#ResourceType", - "traits": { - "smithy.api#documentation": "

    The resource type of a resource, such as AWS::EC2::Instance.

    " - } - }, "ResourceArn": { "target": "com.amazonaws.resourcegroups#ResourceArn", "traits": { "smithy.api#documentation": "

    The ARN of a resource.

    " } + }, + "ResourceType": { + "target": "com.amazonaws.resourcegroups#ResourceType", + "traits": { + "smithy.api#documentation": "

    The resource type of a resource, such as AWS::EC2::Instance.

    " + } } }, "traits": { @@ -1446,23 +1446,23 @@ "com.amazonaws.resourcegroups#ResourceQuery": { "type": "structure", "members": { - "Query": { - "target": "com.amazonaws.resourcegroups#Query", + "Type": { + "target": "com.amazonaws.resourcegroups#QueryType", "traits": { - "smithy.api#documentation": "

    The query that defines a group or a search.

    ", + "smithy.api#documentation": "

    The type of the query. You can use the following values:

    \n
      \n
    • \n

      \n \n CLOUDFORMATION_STACK_1_0:\n Specifies that the\n Query contains an ARN for a CloudFormation stack.

      \n
      • \n
    • \n

      \n \n TAG_FILTERS_1_0:\n Specifies that the\n Query parameter contains a JSON string that represents a\n collection of simple tag filters for resource types and tags. The JSON string\n uses a syntax similar to the \n GetResources\n operation, but uses only the \n ResourceTypeFilters\n and \n TagFilters\n fields. If you specify more than one tag key,\n only resources that match all tag keys, and at least one value of each specified\n tag key, are returned in your query. If you specify more than one value for a\n tag key, a resource matches the filter if it has a tag key value that matches\n any of the specified values.

      \n

      For example, consider the following sample query for resources that have two\n tags, Stage and Version, with two values each:

      \n

      \n [{\"Stage\":[\"Test\",\"Deploy\"]},{\"Version\":[\"1\",\"2\"]}]\n

      \n

      The results of this query could include the following.

      \n
        \n
      • \n

        An EC2 instance that has the following two tags:\n {\"Stage\":\"Deploy\"}, and\n {\"Version\":\"2\"}\n

        \n
        • \n
      • \n

        An S3 bucket that has the following two tags:\n {\"Stage\":\"Test\"}, and\n {\"Version\":\"1\"}\n

        \n
        • \n
      \n

      The query would not include the following items in the results, however.

      \n
        \n
      • \n

        An EC2 instance that has only the following tag:\n {\"Stage\":\"Deploy\"}.

        \n

        The instance does not have all of the\n tag keys specified in the filter, so it is excluded from the\n results.

        \n
        • \n
      • \n

        An RDS database that has the following two tags:\n {\"Stage\":\"Archived\"} and\n {\"Version\":\"4\"}\n

        \n

        The database has all of the tag keys, but none of those keys has an\n associated value that matches at least one of the specified values in\n the filter.

        \n
        • \n
      \n
      • \n
    ", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.resourcegroups#QueryType", + "Query": { + "target": "com.amazonaws.resourcegroups#Query", "traits": { - "smithy.api#documentation": "

    The type of the query. You can use the following values:

    \n
      \n
    • \n

      \n \n CLOUDFORMATION_STACK_1_0:\n A JSON syntax that\n lets you specify a CloudFormation stack ARN.

      \n
      • \n
    • \n

      \n \n TAG_FILTERS_1_0:\n A JSON syntax that lets you\n specify a collection of simple tag filters for resource types and tags, as\n supported by the AWS Tagging API \n ResourceTypeFilters parameter of the\n tagging:GetResources\n operation. If you specify more\n than one tag key, only resources that match all tag keys, and at least one value\n of each specified tag key, are returned in your query. If you specify more than\n one value for a tag key, a resource matches the filter if it has a tag key value\n that matches any of the specified values.

      \n

      For example, consider the following sample query for resources that have two\n tags, Stage and Version, with two values each:

      \n

      \n [{\"Key\":\"Stage\",\"Values\":[\"Test\",\"Deploy\"]},{\"Key\":\"Version\",\"Values\":[\"1\",\"2\"]}]\n

      \n

      The results of this query could include the following.

      \n
        \n
      • \n

        An EC2 instance that has the following two tags:\n {\"Key\":\"Stage\",\"Value\":\"Deploy\"}, and\n {\"Key\":\"Version\",\"Value\":\"2\"}\n

        \n
        • \n
      • \n

        An S3 bucket that has the following two tags:\n {\"Key\":\"Stage\",\"Value\":\"Test\"}, and\n {\"Key\":\"Version\",\"Value\":\"1\"}\n

        \n
        • \n
      \n

      The query would not include the following items in the results, however.

      \n
        \n
      • \n

        An EC2 instance that has only the following tag:\n {\"Key\":\"Stage\",\"Value\":\"Deploy\"}.

        \n

        The instance does not have all of the\n tag keys specified in the filter, so it is excluded from the\n results.

        \n
        • \n
      • \n

        An RDS database that has the following two tags:\n {\"Key\":\"Stage\",\"Value\":\"Archived\"}, and\n {\"Key\":\"Version\",\"Value\":\"4\"}\n

        \n

        The database has all of the tag keys, but none of those keys has an\n associated value that matches at least one of the specified values in\n the filter.

        \n
        • \n
      \n
      • \n
    ", + "smithy.api#documentation": "

    The query that defines a group or a search.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    The query that is used to define a resource group or a search for resources.

    " + "smithy.api#documentation": "

    The query that is used to define a resource group or a search for resources. A query\n specifies both a query type and a query string as a JSON object. See the examples\n section for example JSON strings.

    \n

    The examples that follow are shown as standard JSON strings. If you include such a\n string as a parameter to the AWS CLI or an SDK API, you might need to 'escape' the\n string into a single line. For example, see the Quoting\n strings in the AWS CLI User Guide.

    \n

    \n Example 1\n

    \n

    The following generic example shows a resource query JSON string that includes\n only resources that meet the following criteria:

    \n
      \n
    • \n

      The resource type must be either resource_type1 or\n resource_type2.

      \n
      • \n
    • \n

      The resource must have a tag Key1 with a value of either\n ValueA or ValueB.

      \n
      • \n
    • \n

      The resource must have a tag Key2 with a value of either\n ValueC or ValueD.

      \n
      • \n
    \n

    \n {\n \"Type\": \"TAG_FILTERS_1_0\",\n \"Query\": {\n \"ResourceTypeFilters\": [ \"resource_type1\", \"resource_type2\"],\n \"TagFilters\": [\n {\n \"Key\": \"Key1\",\n \"Values\": [\"ValueA\",\"ValueB\"]\n },\n {\n \"Key\":\"Key2\",\n \"Values\":[\"ValueC\",\"ValueD\"]\n }\n ]\n }\n}\n

    \n

    This has the equivalent \"shortcut\" syntax of the following:

    \n

    \n {\n \"Type\": \"TAG_FILTERS_1_0\",\n \"Query\": {\n \"ResourceTypeFilters\": [ \"resource_type1\", \"resource_type2\"],\n \"TagFilters\": [\n { \"Key1\": [\"ValueA\",\"ValueB\"] },\n { \"Key2\": [\"ValueC\",\"ValueD\"]\n }\n ]\n }\n}\n

    \n

    \n Example 2\n

    \n

    The following example shows a resource query JSON string that includes only\n Amazon EC2 instances that are tagged Stage with a value of\n Test.

    \n

    \n {\n \"Type\": \"TAG_FILTERS_1_0\",\n \"Query\": \"{\n \"ResourceTypeFilters\": \"AWS::EC2::Instance\",\n \"TagFilters\": { \"Stage\": \"Test\" }\n }\n}\n

    \n

    \n Example 3\n

    \n

    The following example shows a resource query JSON string that includes\n resource of any supported type as long as it is tagged Stage with a\n value of Prod.

    \n

    \n {\n \"Type\": \"TAG_FILTERS_1_0\",\n \"Query\": {\n \"ResourceTypeFilters\": \"AWS::AllSupported\",\n \"TagFilters\": { \"Stage\": \"Prod\" }\n }\n}\n

    \n

    \n Example 4\n

    \n

    The following example shows a resource query JSON string that includes only\n Amazon EC2 instances and Amazon S3 buckets that are part of the specified AWS CloudFormation\n stack.

    \n

    \n {\n \"Type\": \"CLOUDFORMATION_STACK_1_0\",\n \"Query\": {\n \"ResourceTypeFilters\": [ \"AWS::EC2::Instance\", \"AWS::S3::Bucket\" ],\n \"StackIdentifier\": \"arn:aws:cloudformation:us-west-2:123456789012:stack/AWStestuseraccount/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE\"\n }\n}\n

    " } }, "com.amazonaws.resourcegroups#ResourceType": { @@ -1500,7 +1500,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of AWS resource identifiers that matches tne specified query. The query\n uses the same format as a resource query in a CreateGroup or UpdateGroupQuery\n operation.

    ", + "smithy.api#documentation": "

    Returns a list of AWS resource identifiers that matches the specified query. The\n query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery\n operation.

    ", "smithy.api#http": { "method": "POST", "uri": "/resources/search", @@ -1516,6 +1516,12 @@ "com.amazonaws.resourcegroups#SearchResourcesInput": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.resourcegroups#MaxResults", + "traits": { + "smithy.api#documentation": "

    The total number of results that you want included on each page of the \nresponse. If you do not include this parameter, it defaults to a value that is specific to the \noperation. If additional items exist beyond the maximum you specify, the NextToken \nresponse element is present and has a value (is not null). Include that value as the \nNextToken request parameter in the next call to the operation to get the next part \nof the results. Note that the service might return fewer results than the maximum even when there \nare more results available. You should check NextToken after every operation to \nensure that you receive all of the results.

    " + } + }, "ResourceQuery": { "target": "com.amazonaws.resourcegroups#ResourceQuery", "traits": { @@ -1523,16 +1529,10 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.resourcegroups#MaxResults", - "traits": { - "smithy.api#documentation": "

    The total number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value that is specific to the \n operation. If additional items exist beyond the maximum you specify, the NextToken \n response element is present and has a value (is not null). Include that value as the \n NextToken request parameter in the next call to the operation to get the next part \n of the results. Note that the service might return fewer results than the maximum even when there \n are more results available. You should check NextToken after every operation to \n ensure that you receive all of the results.

    " - } - }, "NextToken": { "target": "com.amazonaws.resourcegroups#NextToken", "traits": { - "smithy.api#documentation": "

    The parameter for receiving additional results if you receive a\n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value provided by a previous \n call's NextToken response to indicate where the output should continue from.

    " + "smithy.api#documentation": "

    The parameter for receiving additional results if you receive a\nNextToken response in a previous request. A NextToken response \nindicates that more output is available. Set this parameter to the value provided by a previous \ncall's NextToken response to indicate where the output should continue from.

    " } } } @@ -1540,6 +1540,12 @@ "com.amazonaws.resourcegroups#SearchResourcesOutput": { "type": "structure", "members": { + "ResourceIdentifiers": { + "target": "com.amazonaws.resourcegroups#ResourceIdentifierList", + "traits": { + "smithy.api#documentation": "

    The ARNs and resource types of resources that are members of the group that you\n specified.

    " + } + }, "QueryErrors": { "target": "com.amazonaws.resourcegroups#QueryErrorList", "traits": { @@ -1549,13 +1555,7 @@ "NextToken": { "target": "com.amazonaws.resourcegroups#NextToken", "traits": { - "smithy.api#documentation": "

    If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

    " - } - }, - "ResourceIdentifiers": { - "target": "com.amazonaws.resourcegroups#ResourceIdentifierList", - "traits": { - "smithy.api#documentation": "

    The ARNs and resource types of resources that are members of the group that you\n specified.

    " + "smithy.api#documentation": "

    If present, indicates that more output is available than is \nincluded in the current response. Use this value in the NextToken request parameter \nin a subsequent call to the operation to get the next part of the output. You should repeat this \nuntil the NextToken response element comes back as null.

    " } } } @@ -1735,17 +1735,17 @@ "com.amazonaws.resourcegroups#UngroupResourcesInput": { "type": "structure", "members": { - "ResourceArns": { - "target": "com.amazonaws.resourcegroups#ResourceArnList", + "Group": { + "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "

    The ARNs of the resources to be removed from the group.

    ", + "smithy.api#documentation": "

    The name or the ARN of the resource group from which to remove the resources.

    ", "smithy.api#required": {} } }, - "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "ResourceArns": { + "target": "com.amazonaws.resourcegroups#ResourceArnList", "traits": { - "smithy.api#documentation": "

    The name or the ARN of the resource group from which to remove the resources.

    ", + "smithy.api#documentation": "

    The ARNs of the resources to be removed from the group.

    ", "smithy.api#required": {} } } @@ -1808,13 +1808,6 @@ "com.amazonaws.resourcegroups#UntagInput": { "type": "structure", "members": { - "Keys": { - "target": "com.amazonaws.resourcegroups#TagKeyList", - "traits": { - "smithy.api#documentation": "

    The keys of the tags to be removed.

    ", - "smithy.api#required": {} - } - }, "Arn": { "target": "com.amazonaws.resourcegroups#GroupArn", "traits": { @@ -1822,23 +1815,30 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Keys": { + "target": "com.amazonaws.resourcegroups#TagKeyList", + "traits": { + "smithy.api#documentation": "

    The keys of the tags to be removed.

    ", + "smithy.api#required": {} + } } } }, "com.amazonaws.resourcegroups#UntagOutput": { "type": "structure", "members": { - "Keys": { - "target": "com.amazonaws.resourcegroups#TagKeyList", - "traits": { - "smithy.api#documentation": "

    The keys of the tags that were removed.

    " - } - }, "Arn": { "target": "com.amazonaws.resourcegroups#GroupArn", "traits": { "smithy.api#documentation": "

    The ARN of the resource group from which tags have been removed.

    " } + }, + "Keys": { + "target": "com.amazonaws.resourcegroups#TagKeyList", + "traits": { + "smithy.api#documentation": "

    The keys of the tags that were removed.

    " + } } } }, @@ -1891,17 +1891,17 @@ "smithy.api#documentation": "

    Don't use this parameter. Use Group instead.

    " } }, - "Description": { - "target": "com.amazonaws.resourcegroups#Description", - "traits": { - "smithy.api#documentation": "

    The new description that you want to update the resource group with. Descriptions can\n contain letters, numbers, hyphens, underscores, periods, and spaces.

    " - } - }, "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { "smithy.api#documentation": "

    The name or the ARN of the resource group to modify.

    " } + }, + "Description": { + "target": "com.amazonaws.resourcegroups#Description", + "traits": { + "smithy.api#documentation": "

    The new description that you want to update the resource group with. Descriptions can\n contain letters, numbers, hyphens, underscores, periods, and spaces.

    " + } } } }, @@ -1956,13 +1956,6 @@ "com.amazonaws.resourcegroups#UpdateGroupQueryInput": { "type": "structure", "members": { - "ResourceQuery": { - "target": "com.amazonaws.resourcegroups#ResourceQuery", - "traits": { - "smithy.api#documentation": "

    The resource query to determine which AWS resources are members of this resource\n group.

    ", - "smithy.api#required": {} - } - }, "GroupName": { "target": "com.amazonaws.resourcegroups#GroupName", "traits": { @@ -1972,6 +1965,13 @@ "smithy.api#documentation": "

    Don't use this parameter. Use Group instead.

    " } }, + "ResourceQuery": { + "target": "com.amazonaws.resourcegroups#ResourceQuery", + "traits": { + "smithy.api#documentation": "

    The resource query to determine which AWS resources are members of this resource\n group.

    ", + "smithy.api#required": {} + } + }, "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { diff --git a/codegen/sdk-codegen/aws-models/robomaker.2018-06-29.json b/codegen/sdk-codegen/aws-models/robomaker.2018-06-29.json index 5817c5d15305..017466cf222b 100644 --- a/codegen/sdk-codegen/aws-models/robomaker.2018-06-29.json +++ b/codegen/sdk-codegen/aws-models/robomaker.2018-06-29.json @@ -70,6 +70,57 @@ } } }, + "com.amazonaws.robomaker#BatchDeleteWorlds": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#BatchDeleteWorldsRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#BatchDeleteWorldsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes one or more worlds in a batch operation.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/batchDeleteWorlds", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#BatchDeleteWorldsRequest": { + "type": "structure", + "members": { + "worlds": { + "target": "com.amazonaws.robomaker#Arns", + "traits": { + "smithy.api#documentation": "

    A list of Amazon Resource Names (arns) that correspond to worlds to delete.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#BatchDeleteWorldsResponse": { + "type": "structure", + "members": { + "unprocessedWorlds": { + "target": "com.amazonaws.robomaker#Arns", + "traits": { + "smithy.api#documentation": "

    A list of unprocessed worlds associated with the call. These worlds were not deleted.

    " + } + } + } + }, "com.amazonaws.robomaker#BatchDescribeSimulationJob": { "type": "operation", "input": { @@ -116,34 +167,34 @@ "com.amazonaws.robomaker#BatchDescribeSimulationJobResponse": { "type": "structure", "members": { - "jobs": { - "target": "com.amazonaws.robomaker#SimulationJobs", - "traits": { - "smithy.api#documentation": "

    A list of simulation jobs.

    " - } - }, "unprocessedJobs": { "target": "com.amazonaws.robomaker#Arns", "traits": { "smithy.api#documentation": "

    A list of unprocessed simulation job Amazon Resource Names (ARNs).

    " } + }, + "jobs": { + "target": "com.amazonaws.robomaker#SimulationJobs", + "traits": { + "smithy.api#documentation": "

    A list of simulation jobs.

    " + } } } }, "com.amazonaws.robomaker#BatchPolicy": { "type": "structure", "members": { - "timeoutInSeconds": { - "target": "com.amazonaws.robomaker#BatchTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "

    The amount of time, in seconds, to wait for the batch to complete. \n \n

    \n

    If a batch times out, and there are pending requests that \n were failing due to an internal failure (like InternalServiceError), \n they will be moved to the \n failed list and the batch status will be Failed.\n If the pending requests were failing for any other reason, \n the failed pending requests will be moved to the failed list \n and the batch status will be TimedOut.\n

    " - } - }, "maxConcurrency": { "target": "com.amazonaws.robomaker#MaxConcurrency", "traits": { "smithy.api#documentation": "

    The number of active simulation jobs create as part of the batch that \n can be in an active state at the same time. \n

    \n

    Active states include: Pending,Preparing, \n Running, Restarting, RunningFailed and\n Terminating. All other states are terminal states. \n

    " } + }, + "timeoutInSeconds": { + "target": "com.amazonaws.robomaker#BatchTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

    The amount of time, in seconds, to wait for the batch to complete. \n \n

    \n

    If a batch times out, and there are pending requests that \n were failing due to an internal failure (like InternalServiceError), \n they will be moved to the \n failed list and the batch status will be Failed.\n If the pending requests were failing for any other reason, \n the failed pending requests will be moved to the failed list \n and the batch status will be TimedOut.\n

    " + } } }, "traits": { @@ -306,6 +357,100 @@ "type": "structure", "members": {} }, + "com.amazonaws.robomaker#CancelWorldExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#CancelWorldExportJobRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#CancelWorldExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Cancels the specified export job.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/cancelWorldExportJob", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#CancelWorldExportJobRequest": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world export job to cancel.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#CancelWorldExportJobResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.robomaker#CancelWorldGenerationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#CancelWorldGenerationJobRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#CancelWorldGenerationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Cancels the specified world generator job.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/cancelWorldGenerationJob", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#CancelWorldGenerationJobRequest": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world generator job to cancel.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#CancelWorldGenerationJobResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.robomaker#ClientRequestToken": { "type": "string", "traits": { @@ -332,7 +477,7 @@ "simulationUnitLimit": { "target": "com.amazonaws.robomaker#SimulationUnit", "traits": { - "smithy.api#documentation": "

    The simulation unit limit. Your simulation is allocated CPU and memory \n proportional to the supplied simulation unit limit. A simulation\n unit is 1 vcpu and 2GB of memory. You are only billed\n for the SU utilization you consume up to the maximim value provided.\n

    " + "smithy.api#documentation": "

    The simulation unit limit. Your simulation is allocated CPU and memory \n proportional to the supplied simulation unit limit. A simulation\n unit is 1 vcpu and 2GB of memory. You are only billed\n for the SU utilization you consume up to the maximim value provided. \n The default is 15.\n

    " } } }, @@ -346,7 +491,7 @@ "simulationUnitLimit": { "target": "com.amazonaws.robomaker#SimulationUnit", "traits": { - "smithy.api#documentation": "

    The simulation unit limit. Your simulation is allocated CPU and memory \n proportional to the supplied simulation unit limit. A simulation\n unit is 1 vcpu and 2GB of memory. You are only billed\n for the SU utilization you consume up to the maximim value provided.\n

    " + "smithy.api#documentation": "

    The simulation unit limit. Your simulation is allocated CPU and memory \n proportional to the supplied simulation unit limit. A simulation\n unit is 1 vcpu and 2GB of memory. You are only billed\n for the SU utilization you consume up to the maximim value provided. \n The default is 15.\n

    " } } }, @@ -423,11 +568,10 @@ "smithy.api#required": {} } }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The deployment application configuration.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the deployment job.

    " } }, "clientRequestToken": { @@ -438,10 +582,11 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "deploymentApplicationConfigs": { + "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the deployment job.

    " + "smithy.api#documentation": "

    The deployment application configuration.

    ", + "smithy.api#required": {} } } } @@ -449,40 +594,40 @@ "com.amazonaws.robomaker#CreateDeploymentJobResponse": { "type": "structure", "members": { - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", + "deploymentConfig": { + "target": "com.amazonaws.robomaker#DeploymentConfig", "traits": { - "smithy.api#documentation": "

    The deployment application configuration.

    " + "smithy.api#documentation": "

    The deployment configuration.

    " } }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", + "fleet": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The failure code of the simulation job if it failed:

    \n
    \n
    BadPermissionError
    \n
    \n\n

    AWS Greengrass requires a service-level role permission to access\n other services. The role must include the \n \n AWSGreengrassResourceAccessRolePolicy \n managed policy.\n

    \n
    \n
    ExtractingBundleFailure
    \n
    \n

    The robot application could not be extracted from the bundle.

    \n
    \n
    FailureThresholdBreached
    \n
    \n

    The percentage of robots that could not be updated exceeded the percentage\n set for the deployment.

    \n
    \n
    GreengrassDeploymentFailed
    \n
    \n

    The robot application could not be deployed to the robot.

    \n
    \n
    GreengrassGroupVersionDoesNotExist
    \n
    \n

    The AWS Greengrass group or version associated with a robot is missing.

    \n
    \n
    InternalServerError
    \n
    \n

    An internal error has occurred. Retry your request, but if the problem persists, \n contact us with details.

    \n
    \n
    MissingRobotApplicationArchitecture
    \n
    \n

    The robot application does not have a source that matches the architecture of the robot.

    \n
    \n
    MissingRobotDeploymentResource
    \n
    \n

    One or more of the resources specified for the robot application are missing. For\n example, does the robot application have the correct launch package and launch file?

    \n
    \n
    PostLaunchFileFailure
    \n
    \n

    The post-launch script failed.

    \n
    \n
    PreLaunchFileFailure
    \n
    \n

    The pre-launch script failed.

    \n
    \n
    ResourceNotFound
    \n
    \n

    One or more deployment resources are missing. For example, do robot application \n source bundles still exist?

    \n
    \n
    RobotDeploymentNoResponse
    \n
    \n

    There is no response from the robot. It might not be powered on or \n connected to the internet.

    \n
    \n
    " + "smithy.api#documentation": "

    The target fleet for the deployment job.

    " } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the deployment job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    " } }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", + "deploymentApplicationConfigs": { + "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The deployment configuration.

    " + "smithy.api#documentation": "

    The deployment application configuration.

    " } }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "failureCode": { + "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " + "smithy.api#documentation": "

    The failure code of the simulation job if it failed:

    \n
    \n
    BadPermissionError
    \n
    \n

    AWS Greengrass requires a service-level role permission to access\n other services. The role must include the \n \n AWSGreengrassResourceAccessRolePolicy \n managed policy.\n

    \n
    \n
    ExtractingBundleFailure
    \n
    \n

    The robot application could not be extracted from the bundle.

    \n
    \n
    FailureThresholdBreached
    \n
    \n

    The percentage of robots that could not be updated exceeded the percentage\n set for the deployment.

    \n
    \n
    GreengrassDeploymentFailed
    \n
    \n

    The robot application could not be deployed to the robot.

    \n
    \n
    GreengrassGroupVersionDoesNotExist
    \n
    \n

    The AWS Greengrass group or version associated with a robot is missing.

    \n
    \n
    InternalServerError
    \n
    \n

    An internal error has occurred. Retry your request, but if the problem persists, \n contact us with details.

    \n
    \n
    MissingRobotApplicationArchitecture
    \n
    \n

    The robot application does not have a source that matches the architecture of the robot.

    \n
    \n
    MissingRobotDeploymentResource
    \n
    \n

    One or more of the resources specified for the robot application are missing. For\n example, does the robot application have the correct launch package and launch file?

    \n
    \n
    PostLaunchFileFailure
    \n
    \n

    The post-launch script failed.

    \n
    \n
    PreLaunchFileFailure
    \n
    \n

    The pre-launch script failed.

    \n
    \n
    ResourceNotFound
    \n
    \n

    One or more deployment resources are missing. For example, do robot application \n source bundles still exist?

    \n
    \n
    RobotDeploymentNoResponse
    \n
    \n

    There is no response from the robot. It might not be powered on or \n connected to the internet.

    \n
    \n
    " } }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The target fleet for the deployment job.

    " + "smithy.api#documentation": "

    The failure reason of the deployment job if it failed.

    " } }, "status": { @@ -491,16 +636,16 @@ "smithy.api#documentation": "

    The status of the deployment job.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    " + "smithy.api#documentation": "

    The list of all tags added to the deployment job.

    " } }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The failure reason of the deployment job if it failed.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " } } } @@ -539,36 +684,24 @@ "com.amazonaws.robomaker#CreateFleetRequest": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the fleet.

    " + } + }, "name": { "target": "com.amazonaws.robomaker#Name", "traits": { "smithy.api#documentation": "

    The name of the fleet.

    ", "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the fleet.

    " - } } } }, "com.amazonaws.robomaker#CreateFleetResponse": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

    The list of all tags added to the fleet.

    " - } - }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { @@ -580,6 +713,18 @@ "traits": { "smithy.api#documentation": "

    The name of the fleet.

    " } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    The list of all tags added to the fleet.

    " + } + }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " + } } } }, @@ -664,13 +809,6 @@ "smithy.api#required": {} } }, - "sources": { - "target": "com.amazonaws.robomaker#SourceConfigs", - "traits": { - "smithy.api#documentation": "

    The sources of the robot application.

    ", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.robomaker#TagMap", "traits": { @@ -683,46 +821,53 @@ "smithy.api#documentation": "

    The name of the robot application.

    ", "smithy.api#required": {} } + }, + "sources": { + "target": "com.amazonaws.robomaker#SourceConfigs", + "traits": { + "smithy.api#documentation": "

    The sources of the robot application.

    ", + "smithy.api#required": {} + } } } }, "com.amazonaws.robomaker#CreateRobotApplicationResponse": { "type": "structure", "members": { - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " } }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The sources of the robot application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + "smithy.api#documentation": "

    The name of the robot application.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "sources": { + "target": "com.amazonaws.robomaker#Sources", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    " + "smithy.api#documentation": "

    The sources of the robot application.

    " } }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The revision id of the robot application.

    " + "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The version of the robot application.

    " + "smithy.api#documentation": "

    The revision id of the robot application.

    " } }, "tags": { @@ -731,10 +876,10 @@ "smithy.api#documentation": "

    The list of all tags added to the robot application.

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "version": { + "target": "com.amazonaws.robomaker#Version", "traits": { - "smithy.api#documentation": "

    The name of the robot application.

    " + "smithy.api#documentation": "

    The version of the robot application.

    " } } } @@ -776,64 +921,64 @@ "com.amazonaws.robomaker#CreateRobotApplicationVersionRequest": { "type": "structure", "members": { + "currentRevisionId": { + "target": "com.amazonaws.robomaker#RevisionId", + "traits": { + "smithy.api#documentation": "

    The current revision id for the robot application. If you provide a value and it\n matches the latest revision ID, a new version will be created.

    " + } + }, "application": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The application information for the robot application.

    ", "smithy.api#required": {} } - }, - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

    The current revision id for the robot application. If you provide a value and it\n matches the latest revision ID, a new version will be created.

    " - } } } }, "com.amazonaws.robomaker#CreateRobotApplicationVersionResponse": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    " + "smithy.api#documentation": "

    The name of the robot application.

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "version": { + "target": "com.amazonaws.robomaker#Version", "traits": { - "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " + "smithy.api#documentation": "

    The version of the robot application.

    " } }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The sources of the robot application.

    " + "smithy.api#documentation": "

    The revision id of the robot application.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The version of the robot application.

    " + "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The name of the robot application.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " } }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "sources": { + "target": "com.amazonaws.robomaker#Sources", "traits": { - "smithy.api#documentation": "

    The revision id of the robot application.

    " + "smithy.api#documentation": "

    The sources of the robot application.

    " } } } @@ -841,10 +986,16 @@ "com.amazonaws.robomaker#CreateRobotRequest": { "type": "structure", "members": { - "greengrassGroupId": { - "target": "com.amazonaws.robomaker#Id", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The Greengrass group id.

    ", + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the robot.

    " + } + }, + "architecture": { + "target": "com.amazonaws.robomaker#Architecture", + "traits": { + "smithy.api#documentation": "

    The target architecture of the robot.

    ", "smithy.api#required": {} } }, @@ -855,16 +1006,10 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the robot.

    " - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", + "greengrassGroupId": { + "target": "com.amazonaws.robomaker#Id", "traits": { - "smithy.api#documentation": "

    The target architecture of the robot.

    ", + "smithy.api#documentation": "

    The Greengrass group id.

    ", "smithy.api#required": {} } } @@ -873,16 +1018,10 @@ "com.amazonaws.robomaker#CreateRobotResponse": { "type": "structure", "members": { - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", - "traits": { - "smithy.api#documentation": "

    The target architecture of the robot.

    " - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The name of the robot.

    " + "smithy.api#documentation": "

    The list of all tags added to the robot.

    " } }, "createdAt": { @@ -891,16 +1030,16 @@ "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot was created.

    " } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "architecture": { + "target": "com.amazonaws.robomaker#Architecture", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the robot.

    " + "smithy.api#documentation": "

    The target architecture of the robot.

    " } }, - "greengrassGroupId": { - "target": "com.amazonaws.robomaker#Id", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.

    " + "smithy.api#documentation": "

    The name of the robot.

    " } }, "arn": { @@ -908,6 +1047,12 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " } + }, + "greengrassGroupId": { + "target": "com.amazonaws.robomaker#Id", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.

    " + } } } }, @@ -951,6 +1096,20 @@ "com.amazonaws.robomaker#CreateSimulationApplicationRequest": { "type": "structure", "members": { + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "traits": { + "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the simulation application.

    ", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the simulation application.

    ", + "smithy.api#required": {} + } + }, "tags": { "target": "com.amazonaws.robomaker#TagMap", "traits": { @@ -976,84 +1135,70 @@ "smithy.api#documentation": "

    The sources of the simulation application.

    ", "smithy.api#required": {} } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the simulation application.

    ", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

    The name of the simulation application.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.robomaker#CreateSimulationApplicationResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the simulation application.

    " + "smithy.api#documentation": "

    The revision id of the simulation application.

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The name of the simulation application.

    " + "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "renderingEngine": { + "target": "com.amazonaws.robomaker#RenderingEngine", "traits": { - "smithy.api#documentation": "

    The version of the simulation application.

    " + "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " } }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The revision id of the simulation application.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "sources": { + "target": "com.amazonaws.robomaker#Sources", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation application.

    " + "smithy.api#documentation": "

    The sources of the simulation application.

    " } }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " + "smithy.api#documentation": "

    The name of the simulation application.

    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "simulationSoftwareSuite": { + "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", "traits": { - "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " + "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + "smithy.api#documentation": "

    The list of all tags added to the simulation application.

    " } }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation application.

    " } }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", + "version": { + "target": "com.amazonaws.robomaker#Version", "traits": { - "smithy.api#documentation": "

    The sources of the simulation application.

    " + "smithy.api#documentation": "

    The version of the simulation application.

    " } } } @@ -1095,28 +1240,28 @@ "com.amazonaws.robomaker#CreateSimulationApplicationVersionRequest": { "type": "structure", "members": { - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

    The current revision id for the simulation application. If you provide a value and it\n matches the latest revision ID, a new version will be created.

    " - } - }, "application": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The application information for the simulation application.

    ", "smithy.api#required": {} } + }, + "currentRevisionId": { + "target": "com.amazonaws.robomaker#RevisionId", + "traits": { + "smithy.api#documentation": "

    The current revision id for the simulation application. If you provide a value and it\n matches the latest revision ID, a new version will be created.

    " + } } } }, "com.amazonaws.robomaker#CreateSimulationApplicationVersionResponse": { "type": "structure", "members": { - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + "smithy.api#documentation": "

    The revision ID of the simulation application.

    " } }, "version": { @@ -1125,22 +1270,16 @@ "smithy.api#documentation": "

    The version of the simulation application.

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "simulationSoftwareSuite": { + "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The name of the simulation application.

    " - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " + "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation application.

    " + "smithy.api#documentation": "

    The name of the simulation application.

    " } }, "lastUpdatedAt": { @@ -1149,22 +1288,28 @@ "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " } }, + "renderingEngine": { + "target": "com.amazonaws.robomaker#RenderingEngine", + "traits": { + "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + } + }, "sources": { "target": "com.amazonaws.robomaker#Sources", "traits": { "smithy.api#documentation": "

    The sources of the simulation application.

    " } }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The revision ID of the simulation application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation application.

    " } }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " + "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " } } } @@ -1212,12 +1357,30 @@ "com.amazonaws.robomaker#CreateSimulationJobRequest": { "type": "structure", "members": { + "robotApplications": { + "target": "com.amazonaws.robomaker#RobotApplicationConfigs", + "traits": { + "smithy.api#documentation": "

    The robot application to use in the simulation job.

    " + } + }, "dataSources": { "target": "com.amazonaws.robomaker#DataSourceConfigs", "traits": { "smithy.api#documentation": "

    Specify data sources to mount read-only files from S3 into your simulation. These files are \n available under /opt/robomaker/datasources/data_source_name.\n

    \n \n

    There is a limit of 100 files and a combined size of 25GB for all\n DataSourceConfig objects. \n

    \n     " } }, + "simulationApplications": { + "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", + "traits": { + "smithy.api#documentation": "

    The simulation application to use in the simulation job.

    " + } + }, + "compute": { + "target": "com.amazonaws.robomaker#Compute", + "traits": { + "smithy.api#documentation": "

    Compute information for the simulation job.

    " + } + }, "clientRequestToken": { "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { @@ -1225,6 +1388,12 @@ "smithy.api#idempotencyToken": {} } }, + "loggingConfig": { + "target": "com.amazonaws.robomaker#LoggingConfig", + "traits": { + "smithy.api#documentation": "

    The logging configuration.

    " + } + }, "maxJobDurationInSeconds": { "target": "com.amazonaws.robomaker#JobDuration", "traits": { @@ -1232,12 +1401,6 @@ "smithy.api#required": {} } }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", - "traits": { - "smithy.api#documentation": "

    Location for output files generated by the simulation job.

    " - } - }, "tags": { "target": "com.amazonaws.robomaker#TagMap", "traits": { @@ -1251,16 +1414,10 @@ "smithy.api#required": {} } }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig", - "traits": { - "smithy.api#documentation": "

    The logging configuration.

    " - } - }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfig", + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation", "traits": { - "smithy.api#documentation": "

    If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. \n These must belong to the same VPC. You must provide at least one security group and one subnet ID.

    " + "smithy.api#documentation": "

    Location for output files generated by the simulation job.

    " } }, "failureBehavior": { @@ -1269,22 +1426,10 @@ "smithy.api#documentation": "

    The failure behavior the simulation job.

    \n
    \n
    Continue
    \n
    \n

    Restart the simulation job in the same host instance.

    \n
    \n
    Fail
    \n
    \n

    Stop the simulation job and terminate the instance.

    \n
    \n
    " } }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", - "traits": { - "smithy.api#documentation": "

    The robot application to use in the simulation job.

    " - } - }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", - "traits": { - "smithy.api#documentation": "

    The simulation application to use in the simulation job.

    " - } - }, - "compute": { - "target": "com.amazonaws.robomaker#Compute", + "vpcConfig": { + "target": "com.amazonaws.robomaker#VPCConfig", "traits": { - "smithy.api#documentation": "

    Compute information for the simulation job.

    " + "smithy.api#documentation": "

    If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. \n These must belong to the same VPC. You must provide at least one security group and one subnet ID.

    " } } } @@ -1296,17 +1441,18 @@ }, "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 1000 } } }, "com.amazonaws.robomaker#CreateSimulationJobResponse": { "type": "structure", "members": { - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    Simulation job output files location.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " } }, "lastUpdatedAt": { @@ -1315,76 +1461,70 @@ "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " } }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobErrorCode", - "traits": { - "smithy.api#documentation": "

    The failure code of the simulation job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    RobotApplicationCrash
    \n
    \n

    Robot application exited abnormally.

    \n
    \n
    SimulationApplicationCrash
    \n
    \n

    Simulation application exited abnormally.

    \n
    \n
    BadPermissionsRobotApplication
    \n
    \n

    Robot application bundle could not be downloaded.

    \n
    \n
    BadPermissionsSimulationApplication
    \n
    \n

    Simulation application bundle could not be downloaded.

    \n
    \n
    BadPermissionsS3Output
    \n
    \n

    Unable to publish outputs to customer-provided S3 bucket.

    \n
    \n
    BadPermissionsCloudwatchLogs
    \n
    \n

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    \n
    \n
    SubnetIpLimitExceeded
    \n
    \n

    Subnet IP limit exceeded.

    \n
    \n
    ENILimitExceeded
    \n
    \n

    ENI limit exceeded.

    \n
    \n
    BadPermissionsUserCredentials
    \n
    \n

    Unable to use the Role provided.

    \n
    \n
    InvalidBundleRobotApplication
    \n
    \n

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    InvalidBundleSimulationApplication
    \n
    \n

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    RobotApplicationVersionMismatchedEtag
    \n
    \n

    Etag for RobotApplication does not match value during version creation.

    \n
    \n
    SimulationApplicationVersionMismatchedEtag
    \n
    \n

    Etag for SimulationApplication does not match value during version creation.

    \n
    \n
    " - } - }, "simulationApplications": { "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", "traits": { "smithy.api#documentation": "

    The simulation application used by the simulation job.

    " } }, - "lastStartedAt": { - "target": "com.amazonaws.robomaker#LastStartedAt", + "robotApplications": { + "target": "com.amazonaws.robomaker#RobotApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " + "smithy.api#documentation": "

    The robot application used by the simulation job.

    " } }, - "failureBehavior": { - "target": "com.amazonaws.robomaker#FailureBehavior", + "dataSources": { + "target": "com.amazonaws.robomaker#DataSources", "traits": { - "smithy.api#documentation": "

    the failure behavior for the simulation job.

    " + "smithy.api#documentation": "

    The data sources for the simulation job.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "failureCode": { + "target": "com.amazonaws.robomaker#SimulationJobErrorCode", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " + "smithy.api#documentation": "

    The failure code of the simulation job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    RobotApplicationCrash
    \n
    \n

    Robot application exited abnormally.

    \n
    \n
    SimulationApplicationCrash
    \n
    \n

    Simulation application exited abnormally.

    \n
    \n
    BadPermissionsRobotApplication
    \n
    \n

    Robot application bundle could not be downloaded.

    \n
    \n
    BadPermissionsSimulationApplication
    \n
    \n

    Simulation application bundle could not be downloaded.

    \n
    \n
    BadPermissionsS3Output
    \n
    \n

    Unable to publish outputs to customer-provided S3 bucket.

    \n
    \n
    BadPermissionsCloudwatchLogs
    \n
    \n

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    \n
    \n
    SubnetIpLimitExceeded
    \n
    \n

    Subnet IP limit exceeded.

    \n
    \n
    ENILimitExceeded
    \n
    \n

    ENI limit exceeded.

    \n
    \n
    BadPermissionsUserCredentials
    \n
    \n

    Unable to use the Role provided.

    \n
    \n
    InvalidBundleRobotApplication
    \n
    \n

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    InvalidBundleSimulationApplication
    \n
    \n

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    RobotApplicationVersionMismatchedEtag
    \n
    \n

    Etag for RobotApplication does not match value during version creation.

    \n
    \n
    SimulationApplicationVersionMismatchedEtag
    \n
    \n

    Etag for SimulationApplication does not match value during version creation.

    \n
    \n
    " } }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The status of the simulation job.

    " + "smithy.api#documentation": "

    The list of all tags added to the simulation job.

    " } }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", + "failureBehavior": { + "target": "com.amazonaws.robomaker#FailureBehavior", "traits": { - "smithy.api#documentation": "

    The robot application used by the simulation job.

    " + "smithy.api#documentation": "

    the failure behavior for the simulation job.

    " } }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSources", + "simulationTimeMillis": { + "target": "com.amazonaws.robomaker#SimulationTimeMillis", "traits": { - "smithy.api#documentation": "

    The data sources for the simulation job.

    " + "smithy.api#documentation": "

    The simulation job execution duration in milliseconds.

    " } }, - "compute": { - "target": "com.amazonaws.robomaker#ComputeResponse", + "iamRole": { + "target": "com.amazonaws.robomaker#IamRole", "traits": { - "smithy.api#documentation": "

    Compute information for the simulation job.

    " + "smithy.api#documentation": "

    The IAM role that allows the simulation job to call the AWS APIs that \n are specified in its associated policies on your behalf.

    " } }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfigResponse", + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation", "traits": { - "smithy.api#documentation": "

    Information about the vpc configuration.

    " + "smithy.api#documentation": "

    Simulation job output files location.

    " } }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", + "vpcConfig": { + "target": "com.amazonaws.robomaker#VPCConfigResponse", "traits": { - "smithy.api#documentation": "

    The IAM role that allows the simulation job to call the AWS APIs that \n are specified in its associated policies on your behalf.

    " + "smithy.api#documentation": "

    Information about the vpc configuration.

    " } }, - "simulationTimeMillis": { - "target": "com.amazonaws.robomaker#SimulationTimeMillis", + "lastStartedAt": { + "target": "com.amazonaws.robomaker#LastStartedAt", "traits": { - "smithy.api#documentation": "

    The simulation job execution duration in milliseconds.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " } }, "loggingConfig": { @@ -1393,16 +1533,10 @@ "smithy.api#documentation": "

    The logging configuration.

    " } }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "status": { + "target": "com.amazonaws.robomaker#SimulationJobStatus", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the simulation job.

    " + "smithy.api#documentation": "

    The status of the simulation job.

    " } }, "maxJobDurationInSeconds": { @@ -1410,144 +1544,158 @@ "traits": { "smithy.api#documentation": "

    The maximum simulation job duration in seconds.\n

    " } - } - } - }, - "com.amazonaws.robomaker#CreatedAt": { - "type": "timestamp" - }, - "com.amazonaws.robomaker#DataSource": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

    The name of the data source.

    " - } }, - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", + "compute": { + "target": "com.amazonaws.robomaker#ComputeResponse", "traits": { - "smithy.api#documentation": "

    The S3 bucket where the data files are located.

    " + "smithy.api#documentation": "

    Compute information for the simulation job.

    " } }, - "s3Keys": { - "target": "com.amazonaws.robomaker#S3KeyOutputs", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The list of S3 keys identifying the data source files.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } } + } + }, + "com.amazonaws.robomaker#CreateWorldExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#CreateWorldExportJobRequest" }, + "output": { + "target": "com.amazonaws.robomaker#CreateWorldExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], "traits": { - "smithy.api#documentation": "

    Information about a data source.

    " + "smithy.api#documentation": "

    Creates a world export job.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/createWorldExportJob", + "code": 200 + } } }, - "com.amazonaws.robomaker#DataSourceConfig": { + "com.amazonaws.robomaker#CreateWorldExportJobRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation", "traits": { - "smithy.api#documentation": "

    The name of the data source.

    ", "smithy.api#required": {} } }, - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The S3 bucket where the data files are located.

    ", + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world export job.

    " + } + }, + "worlds": { + "target": "com.amazonaws.robomaker#Arns", + "traits": { + "smithy.api#documentation": "

    A list of Amazon Resource Names (arns) that correspond to worlds to export.

    ", "smithy.api#required": {} } }, - "s3Keys": { - "target": "com.amazonaws.robomaker#S3Keys", + "iamRole": { + "target": "com.amazonaws.robomaker#IamRole", "traits": { - "smithy.api#documentation": "

    The list of S3 keys identifying the data source files.

    ", + "smithy.api#documentation": "

    The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

    ", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

    Information about a data source.

    " - } - }, - "com.amazonaws.robomaker#DataSourceConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#DataSourceConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.robomaker#DataSourceNames": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Name" - } - }, - "com.amazonaws.robomaker#DataSources": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#DataSource" - } - }, - "com.amazonaws.robomaker#DeleteFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeleteFleetRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeleteFleetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes a fleet.

    ", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteFleet", - "code": 200 + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "smithy.api#idempotencyToken": {} + } } } }, - "com.amazonaws.robomaker#DeleteFleetRequest": { + "com.amazonaws.robomaker#CreateWorldExportJobResponse": { "type": "structure", "members": { - "fleet": { + "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world export job.

    " + } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world export job.

    " + } + }, + "status": { + "target": "com.amazonaws.robomaker#WorldExportJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the world export job.

    \n
    \n
    Pending
    \n
    \n

    The world export job request is pending.

    \n
    \n
    Running
    \n
    \n

    The world export job is running.

    \n
    \n
    Completed
    \n
    \n

    The world export job completed.\n

    \n
    \n
    Failed
    \n
    \n

    The world export job failed. See failureCode for more information.\n

    \n
    \n
    Canceled
    \n
    \n

    The world export job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The world export job is being cancelled.

    \n
    \n
    " + } + }, + "iamRole": { + "target": "com.amazonaws.robomaker#IamRole", + "traits": { + "smithy.api#documentation": "

    The IAM role that the world export process uses to access the Amazon S3 bucket and\n put the export.\n

    " + } + }, + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation" + }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world export job was created.

    " + } + }, + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + }, + "failureCode": { + "target": "com.amazonaws.robomaker#WorldExportJobErrorCode", + "traits": { + "smithy.api#documentation": "

    The failure code of the world export job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    LimitExceeded
    \n
    \n

    The requested resource exceeds the maximum number allowed, or the number of concurrent \n stream requests exceeds the maximum number allowed. \n

    \n
    \n
    ResourceNotFound
    \n
    \n

    The specified resource could not be found. \n

    \n
    \n
    RequestThrottled
    \n
    \n

    The request was throttled.

    \n
    \n
    InvalidInput
    \n
    \n

    An input parameter in the request is not valid.

    \n
    \n
    " } } } }, - "com.amazonaws.robomaker#DeleteFleetResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.robomaker#DeleteRobot": { + "com.amazonaws.robomaker#CreateWorldGenerationJob": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DeleteRobotRequest" + "target": "com.amazonaws.robomaker#CreateWorldGenerationJobRequest" }, "output": { - "target": "com.amazonaws.robomaker#DeleteRobotResponse" + "target": "com.amazonaws.robomaker#CreateWorldGenerationJobResponse" }, "errors": [ + { + "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" + }, { "target": "com.amazonaws.robomaker#InternalServerException" }, @@ -1555,91 +1703,119 @@ "target": "com.amazonaws.robomaker#InvalidParameterException" }, { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

    Deletes a robot.

    ", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteRobot", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DeleteRobotApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeleteRobotApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeleteRobotApplicationResponse" - }, - "errors": [ + "target": "com.amazonaws.robomaker#LimitExceededException" + }, { - "target": "com.amazonaws.robomaker#InternalServerException" + "target": "com.amazonaws.robomaker#ResourceNotFoundException" }, { - "target": "com.amazonaws.robomaker#InvalidParameterException" + "target": "com.amazonaws.robomaker#ServiceUnavailableException" }, { "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Deletes a robot application.

    ", + "smithy.api#documentation": "

    Creates worlds using the specified template.

    ", "smithy.api#http": { "method": "POST", - "uri": "/deleteRobotApplication", + "uri": "/createWorldGenerationJob", "code": 200 } } }, - "com.amazonaws.robomaker#DeleteRobotApplicationRequest": { + "com.amazonaws.robomaker#CreateWorldGenerationJobRequest": { "type": "structure", "members": { - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The version of the robot application to delete.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "smithy.api#idempotencyToken": {} } }, - "application": { + "template": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the the robot application.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

    ", + "smithy.api#required": {} + } + }, + "worldCount": { + "target": "com.amazonaws.robomaker#WorldCount", + "traits": { + "smithy.api#documentation": "

    Information about the world count.

    ", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world generator job.

    " + } } } }, - "com.amazonaws.robomaker#DeleteRobotApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.robomaker#DeleteRobotRequest": { + "com.amazonaws.robomaker#CreateWorldGenerationJobResponse": { "type": "structure", "members": { - "robot": { + "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world generator job.

    " + } + }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world generator job was created.

    " + } + }, + "template": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template.

    " + } + }, + "status": { + "target": "com.amazonaws.robomaker#WorldGenerationJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the world generator job.

    \n
    \n
    Pending
    \n
    \n

    The world generator job request is pending.

    \n
    \n
    Running
    \n
    \n

    The world generator job is running.

    \n
    \n
    Completed
    \n
    \n

    The world generator job completed.\n

    \n
    \n
    Failed
    \n
    \n

    The world generator job failed. See failureCode for more information.\n

    \n
    \n
    PartialFailed
    \n
    \n

    Some worlds did not generate.

    \n
    \n
    Canceled
    \n
    \n

    The world generator job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The world generator job is being cancelled.

    \n
    \n
    " + } + }, + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + }, + "failureCode": { + "target": "com.amazonaws.robomaker#WorldGenerationJobErrorCode", + "traits": { + "smithy.api#documentation": "

    The failure code of the world generator job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    LimitExceeded
    \n
    \n

    The requested resource exceeds the maximum number allowed, or the number of concurrent \n stream requests exceeds the maximum number allowed. \n

    \n
    \n
    ResourceNotFound
    \n
    \n

    The specified resource could not be found. \n

    \n
    \n
    RequestThrottled
    \n
    \n

    The request was throttled.

    \n
    \n
    InvalidInput
    \n
    \n

    An input parameter in the request is not valid.

    \n
    \n
    " + } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world generator job.

    " + } + }, + "worldCount": { + "target": "com.amazonaws.robomaker#WorldCount", + "traits": { + "smithy.api#documentation": "

    Information about the world count.

    " } } } }, - "com.amazonaws.robomaker#DeleteRobotResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.robomaker#DeleteSimulationApplication": { + "com.amazonaws.robomaker#CreateWorldTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DeleteSimulationApplicationRequest" + "target": "com.amazonaws.robomaker#CreateWorldTemplateRequest" }, "output": { - "target": "com.amazonaws.robomaker#DeleteSimulationApplicationResponse" + "target": "com.amazonaws.robomaker#CreateWorldTemplateResponse" }, "errors": [ { @@ -1648,64 +1824,438 @@ { "target": "com.amazonaws.robomaker#InvalidParameterException" }, + { + "target": "com.amazonaws.robomaker#LimitExceededException" + }, + { + "target": "com.amazonaws.robomaker#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, { "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Deletes a simulation application.

    ", + "smithy.api#documentation": "

    Creates a world template.

    ", "smithy.api#http": { "method": "POST", - "uri": "/deleteSimulationApplication", + "uri": "/createWorldTemplate", "code": 200 } } }, - "com.amazonaws.robomaker#DeleteSimulationApplicationRequest": { + "com.amazonaws.robomaker#CreateWorldTemplateRequest": { "type": "structure", "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", + "templateBody": { + "target": "com.amazonaws.robomaker#Json", "traits": { - "smithy.api#documentation": "

    The application information for the simulation application to delete.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The world template body.

    " } }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The version of the simulation application to delete.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + }, + "templateLocation": { + "target": "com.amazonaws.robomaker#TemplateLocation", + "traits": { + "smithy.api#documentation": "

    The location of the world template.

    " + } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world template.

    " + } + }, + "name": { + "target": "com.amazonaws.robomaker#TemplateName", + "traits": { + "smithy.api#documentation": "

    The name of the world template.

    " } } } }, - "com.amazonaws.robomaker#DeleteSimulationApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.robomaker#DeploymentApplicationConfig": { + "com.amazonaws.robomaker#CreateWorldTemplateResponse": { "type": "structure", "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world template was created.

    " } }, - "launchConfig": { - "target": "com.amazonaws.robomaker#DeploymentLaunchConfig", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The launch configuration.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world template.

    " } }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#DeploymentVersion", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world template.

    " + } + }, + "name": { + "target": "com.amazonaws.robomaker#TemplateName", + "traits": { + "smithy.api#documentation": "

    The name of the world template.

    " + } + }, + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + } + }, + "com.amazonaws.robomaker#CreatedAt": { + "type": "timestamp" + }, + "com.amazonaws.robomaker#DataSource": { + "type": "structure", + "members": { + "s3Keys": { + "target": "com.amazonaws.robomaker#S3KeyOutputs", + "traits": { + "smithy.api#documentation": "

    The list of S3 keys identifying the data source files.

    " + } + }, + "s3Bucket": { + "target": "com.amazonaws.robomaker#S3Bucket", + "traits": { + "smithy.api#documentation": "

    The S3 bucket where the data files are located.

    " + } + }, + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the data source.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a data source.

    " + } + }, + "com.amazonaws.robomaker#DataSourceConfig": { + "type": "structure", + "members": { + "s3Keys": { + "target": "com.amazonaws.robomaker#S3Keys", + "traits": { + "smithy.api#documentation": "

    The list of S3 keys identifying the data source files.

    ", + "smithy.api#required": {} + } + }, + "s3Bucket": { + "target": "com.amazonaws.robomaker#S3Bucket", + "traits": { + "smithy.api#documentation": "

    The S3 bucket where the data files are located.

    ", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the data source.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a data source.

    " + } + }, + "com.amazonaws.robomaker#DataSourceConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#DataSourceConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.robomaker#DataSourceNames": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#Name" + } + }, + "com.amazonaws.robomaker#DataSources": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#DataSource" + } + }, + "com.amazonaws.robomaker#DeleteFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DeleteFleetRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DeleteFleetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a fleet.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/deleteFleet", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DeleteFleetRequest": { + "type": "structure", + "members": { + "fleet": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DeleteFleetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.robomaker#DeleteRobot": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DeleteRobotRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DeleteRobotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a robot.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/deleteRobot", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DeleteRobotApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DeleteRobotApplicationRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DeleteRobotApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a robot application.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/deleteRobotApplication", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DeleteRobotApplicationRequest": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the the robot application.

    ", + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.robomaker#Version", + "traits": { + "smithy.api#documentation": "

    The version of the robot application to delete.

    " + } + } + } + }, + "com.amazonaws.robomaker#DeleteRobotApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.robomaker#DeleteRobotRequest": { + "type": "structure", + "members": { + "robot": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DeleteRobotResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.robomaker#DeleteSimulationApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DeleteSimulationApplicationRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DeleteSimulationApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a simulation application.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/deleteSimulationApplication", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DeleteSimulationApplicationRequest": { + "type": "structure", + "members": { + "applicationVersion": { + "target": "com.amazonaws.robomaker#Version", + "traits": { + "smithy.api#documentation": "

    The version of the simulation application to delete.

    " + } + }, + "application": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The application information for the simulation application to delete.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DeleteSimulationApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.robomaker#DeleteWorldTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DeleteWorldTemplateRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DeleteWorldTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a world template.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/deleteWorldTemplate", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DeleteWorldTemplateRequest": { + "type": "structure", + "members": { + "template": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template you want to delete.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DeleteWorldTemplateResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.robomaker#DeploymentApplicationConfig": { + "type": "structure", + "members": { + "applicationVersion": { + "target": "com.amazonaws.robomaker#DeploymentVersion", "traits": { "smithy.api#documentation": "

    The version of the application.

    ", "smithy.api#required": {} } + }, + "application": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    ", + "smithy.api#required": {} + } + }, + "launchConfig": { + "target": "com.amazonaws.robomaker#DeploymentLaunchConfig", + "traits": { + "smithy.api#documentation": "

    The launch configuration.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -1727,28 +2277,28 @@ "com.amazonaws.robomaker#DeploymentConfig": { "type": "structure", "members": { - "failureThresholdPercentage": { - "target": "com.amazonaws.robomaker#Percentage", - "traits": { - "smithy.api#documentation": "

    The percentage of deployments that need to fail before stopping deployment.

    " - } - }, "downloadConditionFile": { "target": "com.amazonaws.robomaker#S3Object", "traits": { "smithy.api#documentation": "

    The download condition file.

    " } }, - "robotDeploymentTimeoutInSeconds": { - "target": "com.amazonaws.robomaker#DeploymentTimeout", + "concurrentDeploymentPercentage": { + "target": "com.amazonaws.robomaker#Percentage", "traits": { - "smithy.api#documentation": "

    The amount of time, in seconds, to wait for deployment to a single robot to complete. \n Choose a time between 1 minute and 7 days. The default is 5 hours.

    " + "smithy.api#documentation": "

    The percentage of robots receiving the deployment at the same time.

    " } }, - "concurrentDeploymentPercentage": { + "failureThresholdPercentage": { "target": "com.amazonaws.robomaker#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of robots receiving the deployment at the same time.

    " + "smithy.api#documentation": "

    The percentage of deployments that need to fail before stopping deployment.

    " + } + }, + "robotDeploymentTimeoutInSeconds": { + "target": "com.amazonaws.robomaker#DeploymentTimeout", + "traits": { + "smithy.api#documentation": "

    The amount of time, in seconds, to wait for deployment to a single robot to complete. \n Choose a time between 1 minute and 7 days. The default is 5 hours.

    " } } }, @@ -1759,52 +2309,52 @@ "com.amazonaws.robomaker#DeploymentJob": { "type": "structure", "members": { - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    A short description of the reason why the deployment job failed.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment job was created.

    " } }, - "status": { - "target": "com.amazonaws.robomaker#DeploymentStatus", + "fleet": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The status of the deployment job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", + "deploymentConfig": { + "target": "com.amazonaws.robomaker#DeploymentConfig", "traits": { - "smithy.api#documentation": "

    The deployment job failure code.

    " + "smithy.api#documentation": "

    The deployment configuration.

    " } }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment job was created.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    " } - }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", + }, + "status": { + "target": "com.amazonaws.robomaker#DeploymentStatus", "traits": { - "smithy.api#documentation": "

    The deployment configuration.

    " + "smithy.api#documentation": "

    The status of the deployment job.

    " } }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The deployment application configuration.

    " + "smithy.api#documentation": "

    A short description of the reason why the deployment job failed.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "failureCode": { + "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    " + "smithy.api#documentation": "

    The deployment job failure code.

    " } }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", + "deploymentApplicationConfigs": { + "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " + "smithy.api#documentation": "

    The deployment application configuration.

    " } } }, @@ -1914,10 +2464,11 @@ "com.amazonaws.robomaker#DeploymentLaunchConfig": { "type": "structure", "members": { - "preLaunchFile": { - "target": "com.amazonaws.robomaker#Path", + "packageName": { + "target": "com.amazonaws.robomaker#Command", "traits": { - "smithy.api#documentation": "

    The deployment pre-launch file. This file will be executed prior to the launch file.

    " + "smithy.api#documentation": "

    The package name.

    ", + "smithy.api#required": {} } }, "postLaunchFile": { @@ -1926,85 +2477,259 @@ "smithy.api#documentation": "

    The deployment post-launch file. This file will be executed after the launch file.

    " } }, - "packageName": { + "preLaunchFile": { + "target": "com.amazonaws.robomaker#Path", + "traits": { + "smithy.api#documentation": "

    The deployment pre-launch file. This file will be executed prior to the launch file.

    " + } + }, + "environmentVariables": { + "target": "com.amazonaws.robomaker#EnvironmentVariableMap", + "traits": { + "smithy.api#documentation": "

    An array of key/value pairs specifying environment variables for the robot application

    " + } + }, + "launchFile": { "target": "com.amazonaws.robomaker#Command", "traits": { - "smithy.api#documentation": "

    The package name.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The launch file name.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Configuration information for a deployment launch.

    " + } + }, + "com.amazonaws.robomaker#DeploymentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Pending", + "name": "Pending" + }, + { + "value": "Preparing", + "name": "Preparing" + }, + { + "value": "InProgress", + "name": "InProgress" + }, + { + "value": "Failed", + "name": "Failed" + }, + { + "value": "Succeeded", + "name": "Succeeded" + }, + { + "value": "Canceled", + "name": "Canceled" + } + ] + } + }, + "com.amazonaws.robomaker#DeploymentTimeout": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.robomaker#DeploymentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "[0-9]*" + } + }, + "com.amazonaws.robomaker#DeregisterRobot": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DeregisterRobotRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DeregisterRobotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deregisters a robot.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/deregisterRobot", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DeregisterRobotRequest": { + "type": "structure", + "members": { + "robot": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    ", + "smithy.api#required": {} + } + }, + "fleet": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DeregisterRobotResponse": { + "type": "structure", + "members": { + "fleet": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " + } + }, + "robot": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " + } + } + } + }, + "com.amazonaws.robomaker#DescribeDeploymentJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DescribeDeploymentJobRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DescribeDeploymentJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes a deployment job.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/describeDeploymentJob", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DescribeDeploymentJobRequest": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DescribeDeploymentJobResponse": { + "type": "structure", + "members": { + "robotDeploymentSummary": { + "target": "com.amazonaws.robomaker#RobotDeploymentSummary", + "traits": { + "smithy.api#documentation": "

    A list of robot deployment summaries.

    " + } + }, + "deploymentApplicationConfigs": { + "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", + "traits": { + "smithy.api#documentation": "

    The deployment application configuration.

    " + } + }, + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", + "traits": { + "smithy.api#documentation": "

    A short description of the reason why the deployment job failed.

    " + } + }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment job was created.

    " + } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    The list of all tags added to the specified deployment job.

    " + } + }, + "failureCode": { + "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", + "traits": { + "smithy.api#documentation": "

    The deployment job failure code.

    " + } + }, + "status": { + "target": "com.amazonaws.robomaker#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

    The status of the deployment job.

    " + } + }, + "arn": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    " } }, - "launchFile": { - "target": "com.amazonaws.robomaker#Command", + "deploymentConfig": { + "target": "com.amazonaws.robomaker#DeploymentConfig", "traits": { - "smithy.api#documentation": "

    The launch file name.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The deployment configuration.

    " } }, - "environmentVariables": { - "target": "com.amazonaws.robomaker#EnvironmentVariableMap", + "fleet": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    An array of key/value pairs specifying environment variables for the robot application

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } } - }, - "traits": { - "smithy.api#documentation": "

    Configuration information for a deployment launch.

    " - } - }, - "com.amazonaws.robomaker#DeploymentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "Pending" - }, - { - "value": "Preparing", - "name": "Preparing" - }, - { - "value": "InProgress", - "name": "InProgress" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "Succeeded", - "name": "Succeeded" - }, - { - "value": "Canceled", - "name": "Canceled" - } - ] - } - }, - "com.amazonaws.robomaker#DeploymentTimeout": { - "type": "long", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.robomaker#DeploymentVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "[0-9]*" } }, - "com.amazonaws.robomaker#DeregisterRobot": { + "com.amazonaws.robomaker#DescribeFleet": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DeregisterRobotRequest" + "target": "com.amazonaws.robomaker#DescribeFleetRequest" }, "output": { - "target": "com.amazonaws.robomaker#DeregisterRobotResponse" + "target": "com.amazonaws.robomaker#DescribeFleetResponse" }, "errors": [ { @@ -2021,15 +2746,15 @@ } ], "traits": { - "smithy.api#documentation": "

    Deregisters a robot.

    ", + "smithy.api#documentation": "

    Describes a fleet.

    ", "smithy.api#http": { "method": "POST", - "uri": "/deregisterRobot", + "uri": "/describeFleet", "code": 200 } } }, - "com.amazonaws.robomaker#DeregisterRobotRequest": { + "com.amazonaws.robomaker#DescribeFleetRequest": { "type": "structure", "members": { "fleet": { @@ -2038,40 +2763,69 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    ", "smithy.api#required": {} } - }, - "robot": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    ", - "smithy.api#required": {} - } } } }, - "com.amazonaws.robomaker#DeregisterRobotResponse": { + "com.amazonaws.robomaker#DescribeFleetResponse": { "type": "structure", "members": { - "robot": { + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the fleet.

    " + } + }, + "lastDeploymentTime": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time of the last deployment.

    " + } + }, + "robots": { + "target": "com.amazonaws.robomaker#Robots", + "traits": { + "smithy.api#documentation": "

    A list of robots.

    " + } + }, + "lastDeploymentJob": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the last deployment job.

    " } }, - "fleet": { + "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    The list of all tags added to the specified fleet.

    " + } + }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " + } + }, + "lastDeploymentStatus": { + "target": "com.amazonaws.robomaker#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

    The status of the last deployment.

    " + } } } }, - "com.amazonaws.robomaker#DescribeDeploymentJob": { + "com.amazonaws.robomaker#DescribeRobot": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DescribeDeploymentJobRequest" + "target": "com.amazonaws.robomaker#DescribeRobotRequest" }, "output": { - "target": "com.amazonaws.robomaker#DescribeDeploymentJobResponse" + "target": "com.amazonaws.robomaker#DescribeRobotResponse" }, "errors": [ { @@ -2088,98 +2842,200 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a deployment job.

    ", + "smithy.api#documentation": "

    Describes a robot.

    ", "smithy.api#http": { "method": "POST", - "uri": "/describeDeploymentJob", + "uri": "/describeRobot", "code": 200 } } }, - "com.amazonaws.robomaker#DescribeDeploymentJobRequest": { + "com.amazonaws.robomaker#DescribeRobotApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DescribeRobotApplicationRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DescribeRobotApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes a robot application.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/describeRobotApplication", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DescribeRobotApplicationRequest": { "type": "structure", "members": { - "job": { + "applicationVersion": { + "target": "com.amazonaws.robomaker#Version", + "traits": { + "smithy.api#documentation": "

    The version of the robot application to describe.

    " + } + }, + "application": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#DescribeDeploymentJobResponse": { + "com.amazonaws.robomaker#DescribeRobotApplicationResponse": { "type": "structure", "members": { - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The deployment job failure code.

    " + "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " } }, - "status": { - "target": "com.amazonaws.robomaker#DeploymentStatus", + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The status of the deployment job.

    " + "smithy.api#documentation": "

    The revision id of the robot application.

    " + } + }, + "version": { + "target": "com.amazonaws.robomaker#Version", + "traits": { + "smithy.api#documentation": "

    The version of the robot application.

    " + } + }, + "arn": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    " + } + }, + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the robot application.

    " + } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    The list of all tags added to the specified robot application.

    " + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + } + }, + "sources": { + "target": "com.amazonaws.robomaker#Sources", + "traits": { + "smithy.api#documentation": "

    The sources of the robot application.

    " + } + } + } + }, + "com.amazonaws.robomaker#DescribeRobotRequest": { + "type": "structure", + "members": { + "robot": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot to be described.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DescribeRobotResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " } }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    A short description of the reason why the deployment job failed.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot was created.

    " } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "greengrassGroupId": { + "target": "com.amazonaws.robomaker#Id", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the specified deployment job.

    " + "smithy.api#documentation": "

    The Greengrass group id.

    " } }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", + "lastDeploymentJob": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The deployment application configuration.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the last deployment job.

    " } }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The deployment configuration.

    " + "smithy.api#documentation": "

    The name of the robot.

    " } }, - "fleet": { + "fleetArn": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "status": { + "target": "com.amazonaws.robomaker#RobotStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    " + "smithy.api#documentation": "

    The status of the fleet.

    " } }, - "robotDeploymentSummary": { - "target": "com.amazonaws.robomaker#RobotDeploymentSummary", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    A list of robot deployment summaries.

    " + "smithy.api#documentation": "

    The list of all tags added to the specified robot.

    " } }, - "createdAt": { + "lastDeploymentTime": { "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment job was created.

    " + "smithy.api#documentation": "

    The time of the last deployment job.

    " + } + }, + "architecture": { + "target": "com.amazonaws.robomaker#Architecture", + "traits": { + "smithy.api#documentation": "

    The target architecture of the robot application.

    " } } } }, - "com.amazonaws.robomaker#DescribeFleet": { + "com.amazonaws.robomaker#DescribeSimulationApplication": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DescribeFleetRequest" + "target": "com.amazonaws.robomaker#DescribeSimulationApplicationRequest" }, "output": { - "target": "com.amazonaws.robomaker#DescribeFleetResponse" + "target": "com.amazonaws.robomaker#DescribeSimulationApplicationResponse" }, "errors": [ { @@ -2196,86 +3052,104 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a fleet.

    ", + "smithy.api#documentation": "

    Describes a simulation application.

    ", "smithy.api#http": { "method": "POST", - "uri": "/describeFleet", + "uri": "/describeSimulationApplication", "code": 200 } } }, - "com.amazonaws.robomaker#DescribeFleetRequest": { + "com.amazonaws.robomaker#DescribeSimulationApplicationRequest": { "type": "structure", "members": { - "fleet": { + "applicationVersion": { + "target": "com.amazonaws.robomaker#Version", + "traits": { + "smithy.api#documentation": "

    The version of the simulation application to describe.

    " + } + }, + "application": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    ", + "smithy.api#documentation": "

    The application information for the simulation application.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#DescribeFleetResponse": { + "com.amazonaws.robomaker#DescribeSimulationApplicationResponse": { "type": "structure", "members": { + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + } + }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot simulation application.

    " } }, - "lastDeploymentStatus": { - "target": "com.amazonaws.robomaker#DeploymentStatus", + "sources": { + "target": "com.amazonaws.robomaker#Sources", "traits": { - "smithy.api#documentation": "

    The status of the last deployment.

    " + "smithy.api#documentation": "

    The sources of the simulation application.

    " } }, - "lastDeploymentTime": { - "target": "com.amazonaws.robomaker#CreatedAt", + "renderingEngine": { + "target": "com.amazonaws.robomaker#RenderingEngine", "traits": { - "smithy.api#documentation": "

    The time of the last deployment.

    " + "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "simulationSoftwareSuite": { + "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the specified fleet.

    " + "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " } }, - "robots": { - "target": "com.amazonaws.robomaker#Robots", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    A list of robots.

    " + "smithy.api#documentation": "

    The list of all tags added to the specified simulation application.

    " } }, - "lastDeploymentJob": { - "target": "com.amazonaws.robomaker#Arn", + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the last deployment job.

    " + "smithy.api#documentation": "

    The revision id of the simulation application.

    " } }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "version": { + "target": "com.amazonaws.robomaker#Version", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " + "smithy.api#documentation": "

    The version of the simulation application.

    " } }, "name": { "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The name of the fleet.

    " + "smithy.api#documentation": "

    The name of the simulation application.

    " + } + }, + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "traits": { + "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " } } } }, - "com.amazonaws.robomaker#DescribeRobot": { + "com.amazonaws.robomaker#DescribeSimulationJob": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DescribeRobotRequest" + "target": "com.amazonaws.robomaker#DescribeSimulationJobRequest" }, "output": { - "target": "com.amazonaws.robomaker#DescribeRobotResponse" + "target": "com.amazonaws.robomaker#DescribeSimulationJobResponse" }, "errors": [ { @@ -2292,21 +3166,21 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a robot.

    ", + "smithy.api#documentation": "

    Describes a simulation job.

    ", "smithy.api#http": { "method": "POST", - "uri": "/describeRobot", + "uri": "/describeSimulationJob", "code": 200 } } }, - "com.amazonaws.robomaker#DescribeRobotApplication": { + "com.amazonaws.robomaker#DescribeSimulationJobBatch": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DescribeRobotApplicationRequest" + "target": "com.amazonaws.robomaker#DescribeSimulationJobBatchRequest" }, "output": { - "target": "com.amazonaws.robomaker#DescribeRobotApplicationResponse" + "target": "com.amazonaws.robomaker#DescribeSimulationJobBatchResponse" }, "errors": [ { @@ -2317,289 +3191,256 @@ }, { "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Describes a robot application.

    ", + "smithy.api#documentation": "

    Describes a simulation job batch.

    ", "smithy.api#http": { "method": "POST", - "uri": "/describeRobotApplication", + "uri": "/describeSimulationJobBatch", "code": 200 } } }, - "com.amazonaws.robomaker#DescribeRobotApplicationRequest": { + "com.amazonaws.robomaker#DescribeSimulationJobBatchRequest": { "type": "structure", "members": { - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

    The version of the robot application to describe.

    " - } - }, - "application": { + "batch": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    ", + "smithy.api#documentation": "

    The id of the batch to describe.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#DescribeRobotApplicationResponse": { + "com.amazonaws.robomaker#DescribeSimulationJobBatchResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the specified robot application.

    " + "smithy.api#documentation": "

    The reason the simulation job batch failed.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The version of the robot application.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "failureCode": { + "target": "com.amazonaws.robomaker#SimulationJobBatchErrorCode", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + "smithy.api#documentation": "

    The failure code of the simulation job batch.

    " } }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The sources of the robot application.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the simulation job batch.

    " } }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "status": { + "target": "com.amazonaws.robomaker#SimulationJobBatchStatus", "traits": { - "smithy.api#documentation": "

    The revision id of the robot application.

    " + "smithy.api#documentation": "

    The status of the batch.

    \n
    \n
    Pending
    \n
    \n

    The simulation job batch request is pending.

    \n
    \n
    InProgress
    \n
    \n

    The simulation job batch is in progress.

    \n
    \n
    Failed
    \n
    \n

    The simulation job batch failed. One or more simulation job requests could not be completed\n due to an internal failure (like InternalServiceError). \n See failureCode and failureReason for more information.

    \n
    \n
    Completed
    \n
    \n

    The simulation batch job completed. A batch is complete when (1) there are \n no pending simulation job requests in the batch and none of the \n failed simulation job requests are due to InternalServiceError and (2)\n when all created simulation jobs have reached a terminal state (for example, \n Completed or Failed).\n

    \n
    \n
    Canceled
    \n
    \n

    The simulation batch job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The simulation batch job is being cancelled.

    \n
    \n
    Completing
    \n
    \n

    The simulation batch job is completing.

    \n
    \n
    TimingOut
    \n
    \n

    The simulation job batch is timing out.

    \n

    If a batch timing out, and there are pending requests that \n were failing due to an internal failure (like InternalServiceError), \n the batch status will be Failed. If there are no such failing request, \n the batch status will be TimedOut.\n

    \n
    \n
    TimedOut
    \n
    \n

    The simulation batch job timed out.

    \n
    \n
    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "failedRequests": { + "target": "com.amazonaws.robomaker#FailedCreateSimulationJobRequests", "traits": { - "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " + "smithy.api#documentation": "

    A list of failed create simulation job requests. The request failed to \n be created into a simulation job. Failed requests do not \n have a simulation job ID.\n

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "batchPolicy": { + "target": "com.amazonaws.robomaker#BatchPolicy", "traits": { - "smithy.api#documentation": "

    The name of the robot application.

    " + "smithy.api#documentation": "

    The batch policy.

    " } }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the batch.

    " + } + }, + "createdRequests": { + "target": "com.amazonaws.robomaker#SimulationJobSummaries", + "traits": { + "smithy.api#documentation": "

    A list of created simulation job summaries.

    " + } + }, + "pendingRequests": { + "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", + "traits": { + "smithy.api#documentation": "

    A list of pending simulation job requests. These requests have\n not yet been created into simulation jobs.

    " + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was last updated.

    " + } + }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was created.

    " } } } }, - "com.amazonaws.robomaker#DescribeRobotRequest": { + "com.amazonaws.robomaker#DescribeSimulationJobRequest": { "type": "structure", "members": { - "robot": { + "job": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot to be described.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job to be described.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#DescribeRobotResponse": { + "com.amazonaws.robomaker#DescribeSimulationJobResponse": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot was created.

    " - } - }, - "status": { - "target": "com.amazonaws.robomaker#RobotStatus", - "traits": { - "smithy.api#documentation": "

    The status of the fleet.

    " - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the specified robot.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " } }, - "lastDeploymentJob": { - "target": "com.amazonaws.robomaker#Arn", + "robotApplications": { + "target": "com.amazonaws.robomaker#RobotApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the last deployment job.

    " + "smithy.api#documentation": "

    A list of robot applications.

    " } }, - "lastDeploymentTime": { - "target": "com.amazonaws.robomaker#CreatedAt", + "dataSources": { + "target": "com.amazonaws.robomaker#DataSources", "traits": { - "smithy.api#documentation": "

    The time of the last deployment job.

    " + "smithy.api#documentation": "

    The data sources for the simulation job.

    " } }, - "fleetArn": { - "target": "com.amazonaws.robomaker#Arn", + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " + "smithy.api#documentation": "

    Location for output files generated by the simulation job.

    " } }, "name": { "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The name of the robot.

    " + "smithy.api#documentation": "

    The name of the simulation job.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "failureBehavior": { + "target": "com.amazonaws.robomaker#FailureBehavior", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " + "smithy.api#documentation": "

    The failure behavior for the simulation job.

    " } }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The target architecture of the robot application.

    " + "smithy.api#documentation": "

    Details about why the simulation job failed. For more information\n about troubleshooting, see Troubleshooting.

    " } }, - "greengrassGroupId": { - "target": "com.amazonaws.robomaker#Id", + "lastStartedAt": { + "target": "com.amazonaws.robomaker#LastStartedAt", "traits": { - "smithy.api#documentation": "

    The Greengrass group id.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " } - } - } - }, - "com.amazonaws.robomaker#DescribeSimulationApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeSimulationApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeSimulationApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" + "status": { + "target": "com.amazonaws.robomaker#SimulationJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the simulation job.

    " + } }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

    Describes a simulation application.

    ", - "smithy.api#http": { - "method": "POST", - "uri": "/describeSimulationApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeSimulationApplicationRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", + "simulationApplications": { + "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The application information for the simulation application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of simulation applications.

    " } }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", + "failureCode": { + "target": "com.amazonaws.robomaker#SimulationJobErrorCode", "traits": { - "smithy.api#documentation": "

    The version of the simulation application to describe.

    " + "smithy.api#documentation": "

    The failure code of the simulation job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    RobotApplicationCrash
    \n
    \n

    Robot application exited abnormally.

    \n
    \n
    SimulationApplicationCrash
    \n
    \n

    Simulation application exited abnormally.

    \n
    \n
    BadPermissionsRobotApplication
    \n
    \n

    Robot application bundle could not be downloaded.

    \n
    \n
    BadPermissionsSimulationApplication
    \n
    \n

    Simulation application bundle could not be downloaded.

    \n
    \n
    BadPermissionsS3Output
    \n
    \n

    Unable to publish outputs to customer-provided S3 bucket.

    \n
    \n
    BadPermissionsCloudwatchLogs
    \n
    \n

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    \n
    \n
    SubnetIpLimitExceeded
    \n
    \n

    Subnet IP limit exceeded.

    \n
    \n
    ENILimitExceeded
    \n
    \n

    ENI limit exceeded.

    \n
    \n
    BadPermissionsUserCredentials
    \n
    \n

    Unable to use the Role provided.

    \n
    \n
    InvalidBundleRobotApplication
    \n
    \n

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    InvalidBundleSimulationApplication
    \n
    \n

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    RobotApplicationVersionMismatchedEtag
    \n
    \n

    Etag for RobotApplication does not match value during version creation.

    \n
    \n
    SimulationApplicationVersionMismatchedEtag
    \n
    \n

    Etag for SimulationApplication does not match value during version creation.

    \n
    \n
    " } - } - } - }, - "com.amazonaws.robomaker#DescribeSimulationApplicationResponse": { - "type": "structure", - "members": { - "sources": { - "target": "com.amazonaws.robomaker#Sources", + }, + "iamRole": { + "target": "com.amazonaws.robomaker#IamRole", "traits": { - "smithy.api#documentation": "

    The sources of the simulation application.

    " + "smithy.api#documentation": "

    The IAM role that allows the simulation instance to call the AWS APIs that \n are specified in its associated policies on your behalf.

    " } }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "simulationTimeMillis": { + "target": "com.amazonaws.robomaker#SimulationTimeMillis", "traits": { - "smithy.api#documentation": "

    The revision id of the simulation application.

    " + "smithy.api#documentation": "

    The simulation job execution duration in milliseconds.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "vpcConfig": { + "target": "com.amazonaws.robomaker#VPCConfigResponse", "traits": { - "smithy.api#documentation": "

    The version of the simulation application.

    " + "smithy.api#documentation": "

    The VPC configuration.

    " } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "loggingConfig": { + "target": "com.amazonaws.robomaker#LoggingConfig", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the specified simulation application.

    " + "smithy.api#documentation": "

    The logging configuration.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "networkInterface": { + "target": "com.amazonaws.robomaker#NetworkInterface", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot simulation application.

    " + "smithy.api#documentation": "

    The network interface information for the simulation job.

    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "maxJobDurationInSeconds": { + "target": "com.amazonaws.robomaker#JobDuration", "traits": { - "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " + "smithy.api#documentation": "

    The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.

    " } }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", + "compute": { + "target": "com.amazonaws.robomaker#ComputeResponse", "traits": { - "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + "smithy.api#documentation": "

    Compute information for the simulation job.

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The name of the simulation application.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " + "smithy.api#documentation": "

    The list of all tags added to the specified simulation job.

    " } }, "lastUpdatedAt": { "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " } } } }, - "com.amazonaws.robomaker#DescribeSimulationJob": { + "com.amazonaws.robomaker#DescribeWorld": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobRequest" + "target": "com.amazonaws.robomaker#DescribeWorldRequest" }, "output": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobResponse" + "target": "com.amazonaws.robomaker#DescribeWorldResponse" }, "errors": [ { @@ -2616,21 +3457,21 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a simulation job.

    ", + "smithy.api#documentation": "

    Describes a world.

    ", "smithy.api#http": { "method": "POST", - "uri": "/describeSimulationJob", + "uri": "/describeWorld", "code": 200 } } }, - "com.amazonaws.robomaker#DescribeSimulationJobBatch": { + "com.amazonaws.robomaker#DescribeWorldExportJob": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobBatchRequest" + "target": "com.amazonaws.robomaker#DescribeWorldExportJobRequest" }, "output": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobBatchResponse" + "target": "com.amazonaws.robomaker#DescribeWorldExportJobResponse" }, "errors": [ { @@ -2641,30 +3482,33 @@ }, { "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Describes a simulation job batch.

    ", + "smithy.api#documentation": "

    Describes a world export job.

    ", "smithy.api#http": { "method": "POST", - "uri": "/describeSimulationJobBatch", + "uri": "/describeWorldExportJob", "code": 200 } } }, - "com.amazonaws.robomaker#DescribeSimulationJobBatchRequest": { + "com.amazonaws.robomaker#DescribeWorldExportJobRequest": { "type": "structure", "members": { - "batch": { + "job": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The id of the batch to describe.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world export job to describe.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#DescribeSimulationJobBatchResponse": { + "com.amazonaws.robomaker#DescribeWorldExportJobResponse": { "type": "structure", "members": { "clientRequestToken": { @@ -2673,213 +3517,294 @@ "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "status": { + "target": "com.amazonaws.robomaker#WorldExportJobStatus", "traits": { - "smithy.api#documentation": "

    The reason the simulation job batch failed.

    " + "smithy.api#documentation": "

    The status of the world export job.

    \n
    \n
    Pending
    \n
    \n

    The world export job request is pending.

    \n
    \n
    Running
    \n
    \n

    The world export job is running.

    \n
    \n
    Completed
    \n
    \n

    The world export job completed.\n

    \n
    \n
    Failed
    \n
    \n

    The world export job failed. See failureCode and failureReason\n for more information.\n

    \n
    \n
    Canceled
    \n
    \n

    The world export job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The world export job is being cancelled.

    \n
    \n
    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "worlds": { + "target": "com.amazonaws.robomaker#Arns", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was last updated.

    " + "smithy.api#documentation": "

    A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

    " } }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation" + }, + "iamRole": { + "target": "com.amazonaws.robomaker#IamRole", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was created.

    " + "smithy.api#documentation": "

    The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

    " } }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobBatchStatus", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The status of the batch.

    \n
    \n
    Pending
    \n
    \n

    The simulation job batch request is pending.

    \n
    \n
    InProgress
    \n
    \n

    The simulation job batch is in progress.

    \n
    \n
    Failed
    \n
    \n

    The simulation job batch failed. One or more simulation job requests could not be completed\n due to an internal failure (like InternalServiceError). \n See failureCode and failureReason for more information.

    \n
    \n
    Completed
    \n
    \n

    The simulation batch job completed. A batch is complete when (1) there are \n no pending simulation job requests in the batch and none of the \n failed simulation job requests are due to InternalServiceError and (2)\n when all created simulation jobs have reached a terminal state (for example, \n Completed or Failed).\n

    \n
    \n
    Canceled
    \n
    \n

    The simulation batch job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The simulation batch job is being cancelled.

    \n
    \n
    Completing
    \n
    \n

    The simulation batch job is completing.

    \n
    \n
    TimingOut
    \n
    \n

    The simulation job batch is timing out.

    \n

    If a batch timing out, and there are pending requests that \n were failing due to an internal failure (like InternalServiceError), \n the batch status will be Failed. If there are no such failing request, \n the batch status will be TimedOut.\n

    \n
    \n
    TimedOut
    \n
    \n

    The simulation batch job timed out.

    \n
    \n
    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world export job was created.

    " } }, - "pendingRequests": { - "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    A list of pending simulation job requests. These requests have\n not yet been created into simulation jobs.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world export job.

    " } }, - "createdRequests": { - "target": "com.amazonaws.robomaker#SimulationJobSummaries", + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    A list of created simulation job summaries.

    " + "smithy.api#documentation": "

    The reason why the world export job failed.

    " } }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the batch.

    " - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the simulation job batch.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world export job.

    " } }, "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobBatchErrorCode", + "target": "com.amazonaws.robomaker#WorldExportJobErrorCode", "traits": { - "smithy.api#documentation": "

    The failure code of the simulation job batch.

    " + "smithy.api#documentation": "

    The failure code of the world export job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    LimitExceeded
    \n
    \n

    The requested resource exceeds the maximum number allowed, or the number of concurrent \n stream requests exceeds the maximum number allowed. \n

    \n
    \n
    ResourceNotFound
    \n
    \n

    The specified resource could not be found. \n

    \n
    \n
    RequestThrottled
    \n
    \n

    The request was throttled.

    \n
    \n
    InvalidInput
    \n
    \n

    An input parameter in the request is not valid.

    \n
    \n
    " } + } + } + }, + "com.amazonaws.robomaker#DescribeWorldGenerationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DescribeWorldGenerationJobRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DescribeWorldGenerationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" }, - "batchPolicy": { - "target": "com.amazonaws.robomaker#BatchPolicy", - "traits": { - "smithy.api#documentation": "

    The batch policy.

    " - } + { + "target": "com.amazonaws.robomaker#InvalidParameterException" }, - "failedRequests": { - "target": "com.amazonaws.robomaker#FailedCreateSimulationJobRequests", - "traits": { - "smithy.api#documentation": "

    A list of failed create simulation job requests. The request failed to \n be created into a simulation job. Failed requests do not \n have a simulation job ID.\n

    " - } + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes a world generation job.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/describeWorldGenerationJob", + "code": 200 } } }, - "com.amazonaws.robomaker#DescribeSimulationJobRequest": { + "com.amazonaws.robomaker#DescribeWorldGenerationJobRequest": { "type": "structure", "members": { "job": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job to be described.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world generation job to describe.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#DescribeSimulationJobResponse": { + "com.amazonaws.robomaker#DescribeWorldGenerationJobResponse": { "type": "structure", "members": { - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "failureCode": { + "target": "com.amazonaws.robomaker#WorldGenerationJobErrorCode", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " + "smithy.api#documentation": "

    The failure code of the world generation job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    LimitExceeded
    \n
    \n

    The requested resource exceeds the maximum number allowed, or the number of concurrent \n stream requests exceeds the maximum number allowed. \n

    \n
    \n
    ResourceNotFound
    \n
    \n

    The specified resource could not be found. \n

    \n
    \n
    RequestThrottled
    \n
    \n

    The request was throttled.

    \n
    \n
    InvalidInput
    \n
    \n

    An input parameter in the request is not valid.

    \n
    \n
    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The name of the simulation job.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world generation job.

    " } }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig", + "template": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The logging configuration.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template.

    " } }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    A list of robot applications.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSources", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The data sources for the simulation job.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world generation job was created.

    " } }, "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", + "target": "com.amazonaws.robomaker#WorldGenerationJobStatus", "traits": { - "smithy.api#documentation": "

    The status of the simulation job.

    " + "smithy.api#documentation": "

    The status of the world generation job:

    \n
    \n
    Pending
    \n
    \n

    The world generation job request is pending.

    \n
    \n
    Running
    \n
    \n

    The world generation job is running.

    \n
    \n
    Completed
    \n
    \n

    The world generation job completed.\n

    \n
    \n
    Failed
    \n
    \n

    The world generation job failed. See failureCode for more information.\n

    \n
    \n
    PartialFailed
    \n
    \n

    Some worlds did not generate.

    \n
    \n
    Canceled
    \n
    \n

    The world generation job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The world generation job is being cancelled.

    \n
    \n
    " } }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world generation job.

    " } }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", + "finishedWorldsSummary": { + "target": "com.amazonaws.robomaker#FinishedWorldsSummary", "traits": { - "smithy.api#documentation": "

    A list of simulation applications.

    " + "smithy.api#documentation": "

    Summary information about finished worlds.

    " } }, - "simulationTimeMillis": { - "target": "com.amazonaws.robomaker#SimulationTimeMillis", + "worldCount": { + "target": "com.amazonaws.robomaker#WorldCount", "traits": { - "smithy.api#documentation": "

    The simulation job execution duration in milliseconds.

    " + "smithy.api#documentation": "

    Information about the world count.

    " } }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The IAM role that allows the simulation instance to call the AWS APIs that \n are specified in its associated policies on your behalf.

    " + "smithy.api#documentation": "

    The reason why the world generation job failed.

    " } - }, - "compute": { - "target": "com.amazonaws.robomaker#ComputeResponse", + } + } + }, + "com.amazonaws.robomaker#DescribeWorldRequest": { + "type": "structure", + "members": { + "world": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    Compute information for the simulation job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world you want to describe.

    ", + "smithy.api#required": {} } - }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfigResponse", + } + } + }, + "com.amazonaws.robomaker#DescribeWorldResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The VPC configuration.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world.

    " } }, - "networkInterface": { - "target": "com.amazonaws.robomaker#NetworkInterface", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The network interface information for the simulation job.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world was created.

    " } }, - "failureBehavior": { - "target": "com.amazonaws.robomaker#FailureBehavior", + "template": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The failure behavior for the simulation job.

    " + "smithy.api#documentation": "

    The world template.

    " } }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    Details about why the simulation job failed. For more information\n about troubleshooting, see Troubleshooting.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world.

    " } }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", + "generationJob": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world generation job that generated the world.

    " } + } + } + }, + "com.amazonaws.robomaker#DescribeWorldTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#DescribeWorldTemplateRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#DescribeWorldTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" }, - "lastStartedAt": { - "target": "com.amazonaws.robomaker#LastStartedAt", + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes a world template.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/describeWorldTemplate", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#DescribeWorldTemplateRequest": { + "type": "structure", + "members": { + "template": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template you want to describe.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#DescribeWorldTemplateResponse": { + "type": "structure", + "members": { + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world template was created.

    " } }, - "maxJobDurationInSeconds": { - "target": "com.amazonaws.robomaker#JobDuration", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, "tags": { "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the specified simulation job.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the world template.

    " } }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobErrorCode", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The failure code of the simulation job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    RobotApplicationCrash
    \n
    \n

    Robot application exited abnormally.

    \n
    \n
    SimulationApplicationCrash
    \n
    \n

    Simulation application exited abnormally.

    \n
    \n
    BadPermissionsRobotApplication
    \n
    \n

    Robot application bundle could not be downloaded.

    \n
    \n
    BadPermissionsSimulationApplication
    \n
    \n

    Simulation application bundle could not be downloaded.

    \n
    \n
    BadPermissionsS3Output
    \n
    \n

    Unable to publish outputs to customer-provided S3 bucket.

    \n
    \n
    BadPermissionsCloudwatchLogs
    \n
    \n

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    \n
    \n
    SubnetIpLimitExceeded
    \n
    \n

    Subnet IP limit exceeded.

    \n
    \n
    ENILimitExceeded
    \n
    \n

    ENI limit exceeded.

    \n
    \n
    BadPermissionsUserCredentials
    \n
    \n

    Unable to use the Role provided.

    \n
    \n
    InvalidBundleRobotApplication
    \n
    \n

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    InvalidBundleSimulationApplication
    \n
    \n

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    RobotApplicationVersionMismatchedEtag
    \n
    \n

    Etag for RobotApplication does not match value during version creation.

    \n
    \n
    SimulationApplicationVersionMismatchedEtag
    \n
    \n

    Etag for SimulationApplication does not match value during version creation.

    \n
    \n
    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world template was last updated.

    " } }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", + "name": { + "target": "com.amazonaws.robomaker#TemplateName", "traits": { - "smithy.api#documentation": "

    Location for output files generated by the simulation job.

    " + "smithy.api#documentation": "

    The name of the world template.

    " + } + }, + "arn": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world template.

    " } } } @@ -2925,18 +3850,6 @@ "com.amazonaws.robomaker#FailedCreateSimulationJobRequest": { "type": "structure", "members": { - "failedAt": { - "target": "com.amazonaws.robomaker#FailedAt", - "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch failed.

    " - } - }, - "request": { - "target": "com.amazonaws.robomaker#SimulationJobRequest", - "traits": { - "smithy.api#documentation": "

    The simulation job request.

    " - } - }, "failureCode": { "target": "com.amazonaws.robomaker#SimulationJobErrorCode", "traits": { @@ -2948,6 +3861,18 @@ "traits": { "smithy.api#documentation": "

    The failure reason of the simulation job request.

    " } + }, + "request": { + "target": "com.amazonaws.robomaker#SimulationJobRequest", + "traits": { + "smithy.api#documentation": "

    The simulation job request.

    " + } + }, + "failedAt": { + "target": "com.amazonaws.robomaker#FailedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch failed.

    " + } } }, "traits": { @@ -2975,20 +3900,40 @@ ] } }, - "com.amazonaws.robomaker#Filter": { + "com.amazonaws.robomaker#FailureSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", + "failures": { + "target": "com.amazonaws.robomaker#WorldFailures", "traits": { - "smithy.api#documentation": "

    The name of the filter.

    " + "smithy.api#documentation": "

    The worlds that failed.

    " } }, + "totalFailureCount": { + "target": "com.amazonaws.robomaker#Integer", + "traits": { + "smithy.api#documentation": "

    The total number of failures.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about worlds that failed.

    " + } + }, + "com.amazonaws.robomaker#Filter": { + "type": "structure", + "members": { "values": { "target": "com.amazonaws.robomaker#FilterValues", "traits": { "smithy.api#documentation": "

    A list of values.

    " } + }, + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the filter.

    " + } } }, "traits": { @@ -3019,31 +3964,45 @@ } } }, - "com.amazonaws.robomaker#Fleet": { + "com.amazonaws.robomaker#FinishedWorldsSummary": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "finishedCount": { + "target": "com.amazonaws.robomaker#Integer", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " + "smithy.api#documentation": "

    The total number of finished worlds.

    " } }, - "lastDeploymentStatus": { - "target": "com.amazonaws.robomaker#DeploymentStatus", + "failureSummary": { + "target": "com.amazonaws.robomaker#FailureSummary", "traits": { - "smithy.api#documentation": "

    The status of the last fleet deployment.

    " + "smithy.api#documentation": "

    Information about worlds that failed.

    " } }, + "succeededWorlds": { + "target": "com.amazonaws.robomaker#Arns", + "traits": { + "smithy.api#documentation": "

    A list of worlds that succeeded.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about worlds that finished.

    " + } + }, + "com.amazonaws.robomaker#Fleet": { + "type": "structure", + "members": { "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "lastDeploymentStatus": { + "target": "com.amazonaws.robomaker#DeploymentStatus", "traits": { - "smithy.api#documentation": "

    The name of the fleet.

    " + "smithy.api#documentation": "

    The status of the last fleet deployment.

    " } }, "lastDeploymentTime": { @@ -3052,11 +4011,23 @@ "smithy.api#documentation": "

    The time of the last deployment.

    " } }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " + } + }, "lastDeploymentJob": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the last deployment job.

    " } + }, + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the fleet.

    " + } } }, "traits": { @@ -3075,20 +4046,85 @@ } } }, + "com.amazonaws.robomaker#FloorplanCount": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.robomaker#GenericInteger": { "type": "integer", "traits": { "smithy.api#box": {} } }, - "com.amazonaws.robomaker#GenericString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 + "com.amazonaws.robomaker#GenericString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.robomaker#GetWorldTemplateBody": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#GetWorldTemplateBodyRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#GetWorldTemplateBodyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gets the world template body.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/getWorldTemplateBody", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#GetWorldTemplateBodyRequest": { + "type": "structure", + "members": { + "generationJob": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world generator job.

    " + } }, - "smithy.api#pattern": ".*" + "template": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template.

    " + } + } + } + }, + "com.amazonaws.robomaker#GetWorldTemplateBodyResponse": { + "type": "structure", + "members": { + "templateBody": { + "target": "com.amazonaws.robomaker#Json", + "traits": { + "smithy.api#documentation": "

    The world template body.

    " + } + } } }, "com.amazonaws.robomaker#IamRole": { @@ -3127,6 +4163,12 @@ "com.amazonaws.robomaker#Integer": { "type": "integer" }, + "com.amazonaws.robomaker#InteriorCountPerFloorplan": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.robomaker#InternalServerException": { "type": "structure", "members": { @@ -3156,6 +4198,16 @@ "com.amazonaws.robomaker#JobDuration": { "type": "long" }, + "com.amazonaws.robomaker#Json": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 262144 + }, + "smithy.api#pattern": "[\\S\\s]+" + } + }, "com.amazonaws.robomaker#LastStartedAt": { "type": "timestamp" }, @@ -3165,6 +4217,12 @@ "com.amazonaws.robomaker#LaunchConfig": { "type": "structure", "members": { + "streamUI": { + "target": "com.amazonaws.robomaker#Boolean", + "traits": { + "smithy.api#documentation": "

    Boolean indicating whether a streaming session will be configured for the application. If True,\n AWS RoboMaker will configure a connection so you can interact with your application as it is\n running in the simulation. You must configure and luanch the component. It must have a graphical\n user interface.\n

    " + } + }, "packageName": { "target": "com.amazonaws.robomaker#Command", "traits": { @@ -3172,56 +4230,281 @@ "smithy.api#required": {} } }, + "portForwardingConfig": { + "target": "com.amazonaws.robomaker#PortForwardingConfig", + "traits": { + "smithy.api#documentation": "

    The port forwarding configuration.

    " + } + }, "environmentVariables": { "target": "com.amazonaws.robomaker#EnvironmentVariableMap", "traits": { - "smithy.api#documentation": "

    The environment variables for the application launch.

    " + "smithy.api#documentation": "

    The environment variables for the application launch.

    " + } + }, + "launchFile": { + "target": "com.amazonaws.robomaker#Command", + "traits": { + "smithy.api#documentation": "

    The launch file name.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a launch configuration.

    " + } + }, + "com.amazonaws.robomaker#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.robomaker#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The requested resource exceeds the maximum number allowed, or the number of concurrent \n stream requests exceeds the maximum number allowed.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.robomaker#ListDeploymentJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#ListDeploymentJobsRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#ListDeploymentJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve \n specific deployment jobs. \n

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/listDeploymentJobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.robomaker#ListDeploymentJobsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.robomaker#MaxResults", + "traits": { + "smithy.api#documentation": "

    When this parameter is used, ListDeploymentJobs only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListDeploymentJobs request with the returned \n nextToken value. \n This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs\n returns up to 200 results and a nextToken value if applicable.

    " + } + }, + "filters": { + "target": "com.amazonaws.robomaker#Filters", + "traits": { + "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter names status and fleetName are supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters,\n but they must be for the same named item. For example, if you are looking for items with the status\n InProgress or the status Pending.

    " + } + }, + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListDeploymentJobs again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + } + } + }, + "com.amazonaws.robomaker#ListDeploymentJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListDeploymentJobs again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + }, + "deploymentJobs": { + "target": "com.amazonaws.robomaker#DeploymentJobs", + "traits": { + "smithy.api#documentation": "

    A list of deployment jobs that meet the criteria of the request.

    " + } + } + } + }, + "com.amazonaws.robomaker#ListFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#ListFleetsRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#ListFleetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Returns a list of fleets. You can optionally provide filters to retrieve \n specific fleets.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/listFleets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.robomaker#ListFleetsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListFleets again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    \n \n

    This token should be treated as an opaque identifier that is only used to retrieve \n the next items in a list and not for other programmatic purposes.

    \n     " + } + }, + "maxResults": { + "target": "com.amazonaws.robomaker#MaxResults", + "traits": { + "smithy.api#documentation": "

    When this parameter is used, ListFleets only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListFleets request with the returned \n nextToken value. \n This value can be between 1 and 200. If this parameter is not used, then ListFleets\n returns up to 200 results and a nextToken value if applicable.

    " + } + }, + "filters": { + "target": "com.amazonaws.robomaker#Filters", + "traits": { + "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter name name is supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    " + } + } + } + }, + "com.amazonaws.robomaker#ListFleetsResponse": { + "type": "structure", + "members": { + "fleetDetails": { + "target": "com.amazonaws.robomaker#Fleets", + "traits": { + "smithy.api#documentation": "

    A list of fleet details meeting the request criteria.

    " + } + }, + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListFleets again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + } + } + }, + "com.amazonaws.robomaker#ListRobotApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#ListRobotApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#ListRobotApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Returns a list of robot application. You can optionally provide filters to retrieve \n specific robot applications.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/listRobotApplications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.robomaker#ListRobotApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListRobotApplications again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, - "launchFile": { - "target": "com.amazonaws.robomaker#Command", + "filters": { + "target": "com.amazonaws.robomaker#Filters", "traits": { - "smithy.api#documentation": "

    The launch file name.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter name name is supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    " } }, - "streamUI": { - "target": "com.amazonaws.robomaker#Boolean", + "maxResults": { + "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    Boolean indicating whether a streaming session will be configured for the application. If True,\n AWS RoboMaker will configure a connection so you can interact with your application as it is\n running in the simulation. You must configure and luanch the component. It must have a graphical\n user interface.\n

    " + "smithy.api#documentation": "

    When this parameter is used, ListRobotApplications only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListRobotApplications request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications\n returns up to 100 results and a nextToken value if applicable.

    " } }, - "portForwardingConfig": { - "target": "com.amazonaws.robomaker#PortForwardingConfig", + "versionQualifier": { + "target": "com.amazonaws.robomaker#VersionQualifier", "traits": { - "smithy.api#documentation": "

    The port forwarding configuration.

    " + "smithy.api#documentation": "

    The version qualifier of the robot application.

    " } } - }, - "traits": { - "smithy.api#documentation": "

    Information about a launch configuration.

    " } }, - "com.amazonaws.robomaker#LimitExceededException": { + "com.amazonaws.robomaker#ListRobotApplicationsResponse": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListRobotApplications again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + }, + "robotApplicationSummaries": { + "target": "com.amazonaws.robomaker#RobotApplicationSummaries", + "traits": { + "smithy.api#documentation": "

    A list of robot application summaries that meet the criteria of the request.

    " + } } - }, - "traits": { - "smithy.api#documentation": "

    The requested resource exceeds the maximum number allowed, or the number of concurrent \n stream requests exceeds the maximum number allowed.

    ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 } }, - "com.amazonaws.robomaker#ListDeploymentJobs": { + "com.amazonaws.robomaker#ListRobots": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListDeploymentJobsRequest" + "target": "com.amazonaws.robomaker#ListRobotsRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListDeploymentJobsResponse" + "target": "com.amazonaws.robomaker#ListRobotsResponse" }, "errors": [ { @@ -3238,10 +4521,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve \n specific deployment jobs. \n

    ", + "smithy.api#documentation": "

    Returns a list of robots. You can optionally provide filters to retrieve \n specific robots.

    ", "smithy.api#http": { "method": "POST", - "uri": "/listDeploymentJobs", + "uri": "/listRobots", "code": 200 }, "smithy.api#paginated": { @@ -3251,53 +4534,53 @@ } } }, - "com.amazonaws.robomaker#ListDeploymentJobsRequest": { + "com.amazonaws.robomaker#ListRobotsRequest": { "type": "structure", "members": { - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter names status and fleetName are supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters,\n but they must be for the same named item. For example, if you are looking for items with the status\n InProgress or the status Pending.

    " - } - }, "maxResults": { "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    When this parameter is used, ListDeploymentJobs only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListDeploymentJobs request with the returned \n nextToken value. \n This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs\n returns up to 200 results and a nextToken value if applicable.

    " + "smithy.api#documentation": "

    When this parameter is used, ListRobots only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListRobots request with the returned \n nextToken value. \n This value can be between 1 and 200. If this parameter is not used, then ListRobots\n returns up to 200 results and a nextToken value if applicable.

    " } }, "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value returned from a previous paginated \n ListDeploymentJobs request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListRobots again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + }, + "filters": { + "target": "com.amazonaws.robomaker#Filters", + "traits": { + "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter names status and fleetName are supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters,\n but they must be for the same named item. For example, if you are looking for items with the status\n Registered or the status Available.

    " } } } }, - "com.amazonaws.robomaker#ListDeploymentJobsResponse": { + "com.amazonaws.robomaker#ListRobotsResponse": { "type": "structure", "members": { - "deploymentJobs": { - "target": "com.amazonaws.robomaker#DeploymentJobs", + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    A list of deployment jobs that meet the criteria of the request.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListRobots again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", + "robots": { + "target": "com.amazonaws.robomaker#Robots", "traits": { - "smithy.api#documentation": "

    The nextToken value to include in a future ListDeploymentJobs request. \n When the results of a ListDeploymentJobs request exceed maxResults, this \n value can be used to retrieve the next page of results. This value is null when there are no more \n results to return.

    " + "smithy.api#documentation": "

    A list of robots that meet the criteria of the request.

    " } } } }, - "com.amazonaws.robomaker#ListFleets": { + "com.amazonaws.robomaker#ListSimulationApplications": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListFleetsRequest" + "target": "com.amazonaws.robomaker#ListSimulationApplicationsRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListFleetsResponse" + "target": "com.amazonaws.robomaker#ListSimulationApplicationsResponse" }, "errors": [ { @@ -3306,18 +4589,15 @@ { "target": "com.amazonaws.robomaker#InvalidParameterException" }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, { "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Returns a list of fleets. You can optionally provide filters to retrieve \n specific fleets.

    ", + "smithy.api#documentation": "

    Returns a list of simulation applications. You can optionally provide filters to retrieve \n specific simulation applications.

    ", "smithy.api#http": { "method": "POST", - "uri": "/listFleets", + "uri": "/listSimulationApplications", "code": 200 }, "smithy.api#paginated": { @@ -3327,53 +4607,59 @@ } } }, - "com.amazonaws.robomaker#ListFleetsRequest": { + "com.amazonaws.robomaker#ListSimulationApplicationsRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.robomaker#Filters", "traits": { - "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter name name is supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    " + "smithy.api#documentation": "

    Optional list of filters to limit results.

    \n

    The filter name name is supported. When filtering, you must use the complete \n value of the filtered item. You can use up to three filters.

    " } }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", + "versionQualifier": { + "target": "com.amazonaws.robomaker#VersionQualifier", "traits": { - "smithy.api#documentation": "

    When this parameter is used, ListFleets only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListFleets request with the returned \n nextToken value. \n This value can be between 1 and 200. If this parameter is not used, then ListFleets\n returns up to 200 results and a nextToken value if applicable.

    " + "smithy.api#documentation": "

    The version qualifier of the simulation application.

    " } }, "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value returned from a previous paginated \n ListFleets request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

    \n \n

    This token should be treated as an opaque identifier that is only used to retrieve \n the next items in a list and not for other programmatic purposes.

    \n     " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListSimulationApplications again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + }, + "maxResults": { + "target": "com.amazonaws.robomaker#MaxResults", + "traits": { + "smithy.api#documentation": "

    When this parameter is used, ListSimulationApplications only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListSimulationApplications request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications\n returns up to 100 results and a nextToken value if applicable.

    " } } } }, - "com.amazonaws.robomaker#ListFleetsResponse": { + "com.amazonaws.robomaker#ListSimulationApplicationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value to include in a future ListDeploymentJobs request. \n When the results of a ListFleets request exceed maxResults, this \n value can be used to retrieve the next page of results. This value is null when there are no more \n results to return.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListSimulationApplications again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, - "fleetDetails": { - "target": "com.amazonaws.robomaker#Fleets", + "simulationApplicationSummaries": { + "target": "com.amazonaws.robomaker#SimulationApplicationSummaries", "traits": { - "smithy.api#documentation": "

    A list of fleet details meeting the request criteria.

    " + "smithy.api#documentation": "

    A list of simulation application summaries that meet the criteria of the request.

    " } } } }, - "com.amazonaws.robomaker#ListRobotApplications": { + "com.amazonaws.robomaker#ListSimulationJobBatches": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListRobotApplicationsRequest" + "target": "com.amazonaws.robomaker#ListSimulationJobBatchesRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListRobotApplicationsResponse" + "target": "com.amazonaws.robomaker#ListSimulationJobBatchesResponse" }, "errors": [ { @@ -3381,16 +4667,13 @@ }, { "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Returns a list of robot application. You can optionally provide filters to retrieve \n specific robot applications.

    ", + "smithy.api#documentation": "

    Returns a list simulation job batches. You can optionally provide filters to retrieve \n specific simulation batch jobs. \n

    ", "smithy.api#http": { "method": "POST", - "uri": "/listRobotApplications", + "uri": "/listSimulationJobBatches", "code": 200 }, "smithy.api#paginated": { @@ -3400,59 +4683,53 @@ } } }, - "com.amazonaws.robomaker#ListRobotApplicationsRequest": { + "com.amazonaws.robomaker#ListSimulationJobBatchesRequest": { "type": "structure", "members": { + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListSimulationJobBatches again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + }, "filters": { "target": "com.amazonaws.robomaker#Filters", "traits": { - "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter name name is supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    " + "smithy.api#documentation": "

    Optional filters to limit results.

    " } }, "maxResults": { "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    When this parameter is used, ListRobotApplications only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListRobotApplications request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications\n returns up to 100 results and a nextToken value if applicable.

    " - } - }, - "versionQualifier": { - "target": "com.amazonaws.robomaker#VersionQualifier", - "traits": { - "smithy.api#documentation": "

    The version qualifier of the robot application.

    " - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The nextToken value returned from a previous paginated \n ListRobotApplications request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

    " + "smithy.api#documentation": "

    When this parameter is used, ListSimulationJobBatches only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListSimulationJobBatches request with the returned \n nextToken value. \n

    " } } } }, - "com.amazonaws.robomaker#ListRobotApplicationsResponse": { + "com.amazonaws.robomaker#ListSimulationJobBatchesResponse": { "type": "structure", "members": { - "robotApplicationSummaries": { - "target": "com.amazonaws.robomaker#RobotApplicationSummaries", + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    A list of robot application summaries that meet the criteria of the request.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListSimulationJobBatches again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", + "simulationJobBatchSummaries": { + "target": "com.amazonaws.robomaker#SimulationJobBatchSummaries", "traits": { - "smithy.api#documentation": "

    The nextToken value to include in a future ListRobotApplications request. \n When the results of a ListRobotApplications request exceed maxResults, this \n value can be used to retrieve the next page of results. This value is null when there are no more \n results to return.

    " + "smithy.api#documentation": "

    A list of simulation job batch summaries.

    " } } } }, - "com.amazonaws.robomaker#ListRobots": { + "com.amazonaws.robomaker#ListSimulationJobs": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListRobotsRequest" + "target": "com.amazonaws.robomaker#ListSimulationJobsRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListRobotsResponse" + "target": "com.amazonaws.robomaker#ListSimulationJobsResponse" }, "errors": [ { @@ -3461,18 +4738,15 @@ { "target": "com.amazonaws.robomaker#InvalidParameterException" }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, { "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Returns a list of robots. You can optionally provide filters to retrieve \n specific robots.

    ", + "smithy.api#documentation": "

    Returns a list of simulation jobs. You can optionally provide filters to retrieve \n specific simulation jobs.

    ", "smithy.api#http": { "method": "POST", - "uri": "/listRobots", + "uri": "/listSimulationJobs", "code": 200 }, "smithy.api#paginated": { @@ -3482,53 +4756,109 @@ } } }, - "com.amazonaws.robomaker#ListRobotsRequest": { + "com.amazonaws.robomaker#ListSimulationJobsRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.robomaker#Filters", "traits": { - "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter names status and fleetName are supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters,\n but they must be for the same named item. For example, if you are looking for items with the status\n Registered or the status Available.

    " + "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter names status and simulationApplicationName \n and robotApplicationName are supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters,\n but they must be for the same named item. For example, if you are looking for items with the status\n Preparing or the status Running.

    " } }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", + "maxResults": { + "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    The nextToken value returned from a previous paginated \n ListRobots request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

    " + "smithy.api#documentation": "

    When this parameter is used, ListSimulationJobs only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListSimulationJobs request with the returned \n nextToken value. \n This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs\n returns up to 1000 results and a nextToken value if applicable.

    " } }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    When this parameter is used, ListRobots only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListRobots request with the returned \n nextToken value. \n This value can be between 1 and 200. If this parameter is not used, then ListRobots\n returns up to 200 results and a nextToken value if applicable.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListSimulationJobs again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } } } }, - "com.amazonaws.robomaker#ListRobotsResponse": { + "com.amazonaws.robomaker#ListSimulationJobsResponse": { "type": "structure", "members": { - "robots": { - "target": "com.amazonaws.robomaker#Robots", + "simulationJobSummaries": { + "target": "com.amazonaws.robomaker#SimulationJobSummaries", "traits": { - "smithy.api#documentation": "

    A list of robots that meet the criteria of the request.

    " + "smithy.api#documentation": "

    A list of simulation job summaries that meet the criteria of the request.

    ", + "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value to include in a future ListRobots request. \n When the results of a ListRobot request exceed maxResults, this \n value can be used to retrieve the next page of results. This value is null when there are no more \n results to return.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListSimulationJobs again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + } + } + }, + "com.amazonaws.robomaker#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists all tags on a AWS RoboMaker resource.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.robomaker#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    The list of all tags added to the specified resource.

    " } } } }, - "com.amazonaws.robomaker#ListSimulationApplications": { + "com.amazonaws.robomaker#ListWorldExportJobs": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListSimulationApplicationsRequest" + "target": "com.amazonaws.robomaker#ListWorldExportJobsRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListSimulationApplicationsResponse" + "target": "com.amazonaws.robomaker#ListWorldExportJobsResponse" }, "errors": [ { @@ -3542,10 +4872,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of simulation applications. You can optionally provide filters to retrieve \n specific simulation applications.

    ", + "smithy.api#documentation": "

    Lists world export jobs.

    ", "smithy.api#http": { "method": "POST", - "uri": "/listSimulationApplications", + "uri": "/listWorldExportJobs", "code": 200 }, "smithy.api#paginated": { @@ -3555,59 +4885,54 @@ } } }, - "com.amazonaws.robomaker#ListSimulationApplicationsRequest": { + "com.amazonaws.robomaker#ListWorldExportJobsRequest": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.robomaker#Filters", "traits": { - "smithy.api#documentation": "

    Optional list of filters to limit results.

    \n

    The filter name name is supported. When filtering, you must use the complete \n value of the filtered item. You can use up to three filters.

    " - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

    When this parameter is used, ListSimulationApplications only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListSimulationApplications request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications\n returns up to 100 results and a nextToken value if applicable.

    " + "smithy.api#documentation": "

    Optional filters to limit results. You can use generationJobId and templateId.

    " } }, "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value returned from a previous paginated \n ListSimulationApplications request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorldExportJobs again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, - "versionQualifier": { - "target": "com.amazonaws.robomaker#VersionQualifier", + "maxResults": { + "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    The version qualifier of the simulation application.

    " + "smithy.api#documentation": "

    When this parameter is used, ListWorldExportJobs only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListWorldExportJobs request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs\n returns up to 100 results and a nextToken value if applicable. \n

    " } } } }, - "com.amazonaws.robomaker#ListSimulationApplicationsResponse": { + "com.amazonaws.robomaker#ListWorldExportJobsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value to include in a future ListSimulationApplications request. \n When the results of a ListRobot request exceed maxResults, this \n value can be used to retrieve the next page of results. This value is null when there are no more \n results to return.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorldExportJobsRequest again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, - "simulationApplicationSummaries": { - "target": "com.amazonaws.robomaker#SimulationApplicationSummaries", + "worldExportJobSummaries": { + "target": "com.amazonaws.robomaker#WorldExportJobSummaries", "traits": { - "smithy.api#documentation": "

    A list of simulation application summaries that meet the criteria of the request.

    " + "smithy.api#documentation": "

    Summary information for world export jobs.

    ", + "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#ListSimulationJobBatches": { + "com.amazonaws.robomaker#ListWorldGenerationJobs": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListSimulationJobBatchesRequest" + "target": "com.amazonaws.robomaker#ListWorldGenerationJobsRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListSimulationJobBatchesResponse" + "target": "com.amazonaws.robomaker#ListWorldGenerationJobsResponse" }, "errors": [ { @@ -3615,13 +4940,16 @@ }, { "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Returns a list simulation job batches. You can optionally provide filters to retrieve \n specific simulation batch jobs. \n

    ", + "smithy.api#documentation": "

    Lists world generator jobs.

    ", "smithy.api#http": { "method": "POST", - "uri": "/listSimulationJobBatches", + "uri": "/listWorldGenerationJobs", "code": 200 }, "smithy.api#paginated": { @@ -3631,53 +4959,54 @@ } } }, - "com.amazonaws.robomaker#ListSimulationJobBatchesRequest": { + "com.amazonaws.robomaker#ListWorldGenerationJobsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    When this parameter is used, ListSimulationJobBatches only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListSimulationJobBatches request with the returned \n nextToken value. \n

    " + "smithy.api#documentation": "

    When this parameter is used, ListWorldGeneratorJobs only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListWorldGeneratorJobs request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs\n returns up to 100 results and a nextToken value if applicable. \n

    " } }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", + "filters": { + "target": "com.amazonaws.robomaker#Filters", "traits": { - "smithy.api#documentation": "

    The nextToken value returned from a previous paginated \n ListSimulationJobBatches request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

    " + "smithy.api#documentation": "

    Optional filters to limit results. You can use status and templateId.

    " } }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    Optional filters to limit results.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorldGenerationJobsRequest again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } } } }, - "com.amazonaws.robomaker#ListSimulationJobBatchesResponse": { + "com.amazonaws.robomaker#ListWorldGenerationJobsResponse": { "type": "structure", "members": { - "simulationJobBatchSummaries": { - "target": "com.amazonaws.robomaker#SimulationJobBatchSummaries", + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    A list of simulation job batch summaries.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorldGeneratorJobsRequest again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", + "worldGenerationJobSummaries": { + "target": "com.amazonaws.robomaker#WorldGenerationJobSummaries", "traits": { - "smithy.api#documentation": "

    The nextToken value to include in a future ListSimulationJobBatches request. \n When the results of a ListSimulationJobBatches request exceed maxResults, this \n value can be used to retrieve the next page of results. This value is null when there are no more \n results to return. \n

    " + "smithy.api#documentation": "

    Summary information for world generator jobs.

    ", + "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#ListSimulationJobs": { + "com.amazonaws.robomaker#ListWorldTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListSimulationJobsRequest" + "target": "com.amazonaws.robomaker#ListWorldTemplatesRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListSimulationJobsResponse" + "target": "com.amazonaws.robomaker#ListWorldTemplatesResponse" }, "errors": [ { @@ -3691,10 +5020,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of simulation jobs. You can optionally provide filters to retrieve \n specific simulation jobs.

    ", + "smithy.api#documentation": "

    Lists world templates.

    ", "smithy.api#http": { "method": "POST", - "uri": "/listSimulationJobs", + "uri": "/listWorldTemplates", "code": 200 }, "smithy.api#paginated": { @@ -3704,54 +5033,47 @@ } } }, - "com.amazonaws.robomaker#ListSimulationJobsRequest": { + "com.amazonaws.robomaker#ListWorldTemplatesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value returned from a previous paginated \n ListSimulationJobs request where maxResults was used and the results \n exceeded the value of that parameter. Pagination continues from the end of the previous results \n that returned the nextToken value. \n

    \n \n

    This token should be treated as an opaque identifier that is only used to retrieve \n the next items in a list and not for other programmatic purposes.

    \n     " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorldTemplates again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } }, "maxResults": { "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    When this parameter is used, ListSimulationJobs only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListSimulationJobs request with the returned \n nextToken value. \n This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs\n returns up to 1000 results and a nextToken value if applicable.

    " - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter names status and simulationApplicationName \n and robotApplicationName are supported.\n When filtering, you must use the complete value of the filtered item. You can use up to three filters,\n but they must be for the same named item. For example, if you are looking for items with the status\n Preparing or the status Running.

    " + "smithy.api#documentation": "

    When this parameter is used, ListWorldTemplates only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListWorldTemplates request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates\n returns up to 100 results and a nextToken value if applicable. \n

    " } } } }, - "com.amazonaws.robomaker#ListSimulationJobsResponse": { + "com.amazonaws.robomaker#ListWorldTemplatesResponse": { "type": "structure", "members": { - "simulationJobSummaries": { - "target": "com.amazonaws.robomaker#SimulationJobSummaries", + "templateSummaries": { + "target": "com.amazonaws.robomaker#TemplateSummaries", "traits": { - "smithy.api#documentation": "

    A list of simulation job summaries that meet the criteria of the request.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Summary information for templates.

    " } }, "nextToken": { "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The nextToken value to include in a future ListSimulationJobs request. \n When the results of a ListRobot request exceed maxResults, this \n value can be used to retrieve the next page of results. This value is null when there are no more \n results to return.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorldTemplates again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " } } } }, - "com.amazonaws.robomaker#ListTagsForResource": { + "com.amazonaws.robomaker#ListWorlds": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#ListTagsForResourceRequest" + "target": "com.amazonaws.robomaker#ListWorldsRequest" }, "output": { - "target": "com.amazonaws.robomaker#ListTagsForResourceResponse" + "target": "com.amazonaws.robomaker#ListWorldsResponse" }, "errors": [ { @@ -3760,42 +5082,60 @@ { "target": "com.amazonaws.robomaker#InvalidParameterException" }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, { "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Lists all tags on a AWS RoboMaker resource.

    ", + "smithy.api#documentation": "

    Lists worlds.

    ", "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", + "method": "POST", + "uri": "/listWorlds", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, - "com.amazonaws.robomaker#ListTagsForResourceRequest": { + "com.amazonaws.robomaker#ListWorldsRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.robomaker#Arn", + "maxResults": { + "target": "com.amazonaws.robomaker#MaxResults", "traits": { - "smithy.api#documentation": "

    The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    When this parameter is used, ListWorlds only returns \n maxResults results in a single page along with a nextToken response \n element. The remaining results of the initial request \n can be seen by sending another ListWorlds request with the returned \n nextToken value. \n This value can be between 1 and 100. If this parameter is not used, then ListWorlds\n returns up to 100 results and a nextToken value if applicable. \n

    " + } + }, + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorlds again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + }, + "filters": { + "target": "com.amazonaws.robomaker#Filters", + "traits": { + "smithy.api#documentation": "

    Optional filters to limit results. You can use status.

    " } } } }, - "com.amazonaws.robomaker#ListTagsForResourceResponse": { + "com.amazonaws.robomaker#ListWorldsResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "nextToken": { + "target": "com.amazonaws.robomaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    The list of all tags added to the specified resource.

    " + "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, \n the response object's nextToken parameter value is set to a token. To retrieve \n the next set of results, call ListWorlds again and assign that token \n to the request object's nextToken parameter. If there are no remaining results, \n the previous response object's NextToken parameter is set to null. \n

    " + } + }, + "worldSummaries": { + "target": "com.amazonaws.robomaker#WorldSummaries", + "traits": { + "smithy.api#documentation": "

    Summary information for worlds.

    " } } } @@ -3840,10 +5180,10 @@ "com.amazonaws.robomaker#NetworkInterface": { "type": "structure", "members": { - "privateIpAddress": { + "publicIpAddress": { "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The IPv4 address of the network interface within the subnet.

    " + "smithy.api#documentation": "

    The IPv4 public address of the network interface.

    " } }, "networkInterfaceId": { @@ -3852,10 +5192,10 @@ "smithy.api#documentation": "

    The ID of the network interface.

    " } }, - "publicIpAddress": { + "privateIpAddress": { "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The IPv4 public address of the network interface.

    " + "smithy.api#documentation": "

    The IPv4 address of the network interface within the subnet.

    " } } }, @@ -3968,13 +5308,6 @@ "com.amazonaws.robomaker#PortMapping": { "type": "structure", "members": { - "jobPort": { - "target": "com.amazonaws.robomaker#Port", - "traits": { - "smithy.api#documentation": "

    The port number on the simulation job instance to use as a remote connection point.

    ", - "smithy.api#required": {} - } - }, "applicationPort": { "target": "com.amazonaws.robomaker#NonSystemPort", "traits": { @@ -3987,6 +5320,13 @@ "traits": { "smithy.api#documentation": "

    A Boolean indicating whether to enable this port mapping on public IP.

    " } + }, + "jobPort": { + "target": "com.amazonaws.robomaker#Port", + "traits": { + "smithy.api#documentation": "

    The port number on the simulation job instance to use as a remote connection point.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -4008,12 +5348,6 @@ "com.amazonaws.robomaker#ProgressDetail": { "type": "structure", "members": { - "percentDone": { - "target": "com.amazonaws.robomaker#PercentDone", - "traits": { - "smithy.api#documentation": "

    Precentage of the step that is done. This currently only applies to the Downloading/Extracting \n step of the deployment. It is empty for other steps.

    " - } - }, "currentProgress": { "target": "com.amazonaws.robomaker#RobotDeploymentStep", "traits": { @@ -4031,6 +5365,12 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the deployment job.

    " } + }, + "percentDone": { + "target": "com.amazonaws.robomaker#PercentDone", + "traits": { + "smithy.api#documentation": "

    Precentage of the step that is done. This currently only applies to the Downloading/Extracting \n step of the deployment. It is empty for other steps.

    " + } } }, "traits": { @@ -4237,22 +5577,16 @@ "com.amazonaws.robomaker#Robot": { "type": "structure", "members": { - "lastDeploymentJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the last deployment job.

    " - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", + "greenGrassGroupId": { + "target": "com.amazonaws.robomaker#Id", "traits": { - "smithy.api#documentation": "

    The architecture of the robot.

    " + "smithy.api#documentation": "

    The Greengrass group associated with the robot.

    " } }, - "lastDeploymentTime": { + "createdAt": { "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The time of the last deployment.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot was created.

    " } }, "status": { @@ -4261,28 +5595,28 @@ "smithy.api#documentation": "

    The status of the robot.

    " } }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot was created.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " } }, - "fleetArn": { + "lastDeploymentJob": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the last deployment job.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "lastDeploymentTime": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " + "smithy.api#documentation": "

    The time of the last deployment.

    " } }, - "greenGrassGroupId": { - "target": "com.amazonaws.robomaker#Id", + "fleetArn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Greengrass group associated with the robot.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } }, "name": { @@ -4290,6 +5624,12 @@ "traits": { "smithy.api#documentation": "

    The name of the robot.

    " } + }, + "architecture": { + "target": "com.amazonaws.robomaker#Architecture", + "traits": { + "smithy.api#documentation": "

    The architecture of the robot.

    " + } } }, "traits": { @@ -4299,10 +5639,11 @@ "com.amazonaws.robomaker#RobotApplicationConfig": { "type": "structure", "members": { - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", + "application": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The version of the robot application.

    " + "smithy.api#documentation": "

    The application information for the robot application.

    ", + "smithy.api#required": {} } }, "launchConfig": { @@ -4312,11 +5653,10 @@ "smithy.api#required": {} } }, - "application": { - "target": "com.amazonaws.robomaker#Arn", + "applicationVersion": { + "target": "com.amazonaws.robomaker#Version", "traits": { - "smithy.api#documentation": "

    The application information for the robot application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The version of the robot application.

    " } } }, @@ -4357,22 +5697,16 @@ "com.amazonaws.robomaker#RobotApplicationSummary": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

    The version of the robot application.

    " - } - }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + "smithy.api#documentation": "

    Information about a robot software suite (ROS distribution).

    " } }, "name": { @@ -4381,20 +5715,44 @@ "smithy.api#documentation": "

    The name of the robot application.

    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + } + }, + "version": { + "target": "com.amazonaws.robomaker#Version", + "traits": { + "smithy.api#documentation": "

    The version of the robot application.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Summary information for a robot application.

    " + } + }, + "com.amazonaws.robomaker#RobotDeployment": { + "type": "structure", + "members": { + "progressDetail": { + "target": "com.amazonaws.robomaker#ProgressDetail", + "traits": { + "smithy.api#documentation": "

    Information about how the deployment is progressing.

    " + } + }, + "deploymentStartTime": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment was started.

    " + } + }, + "deploymentFinishTime": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    Information about a robot software suite (ROS distribution).

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment finished.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Summary information for a robot application.

    " - } - }, - "com.amazonaws.robomaker#RobotDeployment": { - "type": "structure", - "members": { + }, "status": { "target": "com.amazonaws.robomaker#RobotStatus", "traits": { @@ -4407,34 +5765,16 @@ "smithy.api#documentation": "

    A short description of the reason why the robot deployment failed.

    " } }, - "deploymentStartTime": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment was started.

    " - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", - "traits": { - "smithy.api#documentation": "

    The robot deployment failure code.

    " - } - }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { "smithy.api#documentation": "

    The robot deployment Amazon Resource Name (ARN).

    " } }, - "progressDetail": { - "target": "com.amazonaws.robomaker#ProgressDetail", - "traits": { - "smithy.api#documentation": "

    Information about how the deployment is progressing.

    " - } - }, - "deploymentFinishTime": { - "target": "com.amazonaws.robomaker#CreatedAt", + "failureCode": { + "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the deployment finished.

    " + "smithy.api#documentation": "

    The robot deployment failure code.

    " } } }, @@ -4610,17 +5950,17 @@ "com.amazonaws.robomaker#S3KeyOutput": { "type": "structure", "members": { - "s3Key": { - "target": "com.amazonaws.robomaker#S3Key", - "traits": { - "smithy.api#documentation": "

    The S3 key.

    " - } - }, "etag": { "target": "com.amazonaws.robomaker#S3Etag", "traits": { "smithy.api#documentation": "

    The etag for the object.

    " } + }, + "s3Key": { + "target": "com.amazonaws.robomaker#S3Key", + "traits": { + "smithy.api#documentation": "

    The S3 key.

    " + } } }, "traits": { @@ -4648,10 +5988,11 @@ "com.amazonaws.robomaker#S3Object": { "type": "structure", "members": { - "etag": { - "target": "com.amazonaws.robomaker#S3Etag", + "bucket": { + "target": "com.amazonaws.robomaker#S3Bucket", "traits": { - "smithy.api#documentation": "

    The etag of the object.

    " + "smithy.api#documentation": "

    The bucket containing the object.

    ", + "smithy.api#required": {} } }, "key": { @@ -4661,11 +6002,10 @@ "smithy.api#required": {} } }, - "bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", + "etag": { + "target": "com.amazonaws.robomaker#S3Etag", "traits": { - "smithy.api#documentation": "

    The bucket containing the object.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The etag of the object.

    " } } }, @@ -4708,17 +6048,23 @@ "smithy.api#required": {} } }, + "application": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The application information for the simulation application.

    ", + "smithy.api#required": {} + } + }, "applicationVersion": { "target": "com.amazonaws.robomaker#Version", "traits": { "smithy.api#documentation": "

    The version of the simulation application.

    " } }, - "application": { - "target": "com.amazonaws.robomaker#Arn", + "worldConfigs": { + "target": "com.amazonaws.robomaker#WorldConfigs", "traits": { - "smithy.api#documentation": "

    The application information for the simulation application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of world configurations.

    " } } }, @@ -4759,16 +6105,10 @@ "com.amazonaws.robomaker#SimulationApplicationSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

    The name of the simulation application.

    " - } - }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "version": { + "target": "com.amazonaws.robomaker#Version", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation application.

    " + "smithy.api#documentation": "

    The version of the simulation application.

    " } }, "simulationSoftwareSuite": { @@ -4777,10 +6117,16 @@ "smithy.api#documentation": "

    Information about a simulation software suite.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The version of the simulation application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation application.

    " + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " } }, "robotSoftwareSuite": { @@ -4789,10 +6135,10 @@ "smithy.api#documentation": "

    Information about a robot software suite (ROS distribution).

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + "smithy.api#documentation": "

    The name of the simulation application.

    " } } }, @@ -4809,22 +6155,40 @@ "smithy.api#documentation": "

    The logging configuration.

    " } }, - "networkInterface": { - "target": "com.amazonaws.robomaker#NetworkInterface", - "traits": { - "smithy.api#documentation": "

    Information about a network interface.

    " - } - }, "maxJobDurationInSeconds": { "target": "com.amazonaws.robomaker#JobDuration", "traits": { "smithy.api#documentation": "

    The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

    " } }, - "simulationTimeMillis": { - "target": "com.amazonaws.robomaker#SimulationTimeMillis", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The simulation job execution duration in milliseconds.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the simulation job.

    " + } + }, + "status": { + "target": "com.amazonaws.robomaker#SimulationJobStatus", + "traits": { + "smithy.api#documentation": "

    Status of the simulation job.

    " + } + }, + "failureCode": { + "target": "com.amazonaws.robomaker#SimulationJobErrorCode", + "traits": { + "smithy.api#documentation": "

    The failure code of the simulation job if it failed.

    " + } + }, + "compute": { + "target": "com.amazonaws.robomaker#ComputeResponse", + "traits": { + "smithy.api#documentation": "

    Compute information for the simulation job

    " + } + }, + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation", + "traits": { + "smithy.api#documentation": "

    Location for output files generated by the simulation job.

    " } }, "iamRole": { @@ -4833,16 +6197,22 @@ "smithy.api#documentation": "

    The IAM role that allows the simulation instance to call the AWS APIs that \n are specified in its associated policies on your behalf. This is how credentials are passed in to your \n simulation job.\n

    " } }, + "simulationTimeMillis": { + "target": "com.amazonaws.robomaker#SimulationTimeMillis", + "traits": { + "smithy.api#documentation": "

    The simulation job execution duration in milliseconds.

    " + } + }, "vpcConfig": { "target": "com.amazonaws.robomaker#VPCConfigResponse", "traits": { "smithy.api#documentation": "

    VPC configuration information.

    " } }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", + "networkInterface": { + "target": "com.amazonaws.robomaker#NetworkInterface", "traits": { - "smithy.api#documentation": "

    Status of the simulation job.

    " + "smithy.api#documentation": "

    Information about a network interface.

    " } }, "failureBehavior": { @@ -4851,22 +6221,16 @@ "smithy.api#documentation": "

    The failure behavior the simulation job.

    \n
    \n
    Continue
    \n
    \n

    Restart the simulation job in the same host instance.

    \n
    \n
    Fail
    \n
    \n

    Stop the simulation job and terminate the instance.

    \n
    \n
    " } }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

    A unique identifier for this SimulationJob request.

    " - } - }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    A list of simulation applications.

    " + "smithy.api#documentation": "

    The reason why the simulation job failed.

    " } }, - "compute": { - "target": "com.amazonaws.robomaker#ComputeResponse", + "lastStartedAt": { + "target": "com.amazonaws.robomaker#LastStartedAt", "traits": { - "smithy.api#documentation": "

    Compute information for the simulation job

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " } }, "name": { @@ -4875,58 +6239,40 @@ "smithy.api#documentation": "

    The name of the simulation job.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " - } - }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSources", - "traits": { - "smithy.api#documentation": "

    The data sources for the simulation job.

    " - } - }, "robotApplications": { "target": "com.amazonaws.robomaker#RobotApplicationConfigs", "traits": { "smithy.api#documentation": "

    A list of robot applications.

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "dataSources": { + "target": "com.amazonaws.robomaker#DataSources", "traits": { - "smithy.api#documentation": "

    The reason why the simulation job failed.

    " + "smithy.api#documentation": "

    The data sources for the simulation job.

    " } }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the simulation job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " } }, - "lastStartedAt": { - "target": "com.amazonaws.robomaker#LastStartedAt", + "simulationApplications": { + "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " + "smithy.api#documentation": "

    A list of simulation applications.

    " } }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobErrorCode", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The failure code of the simulation job if it failed.

    " + "smithy.api#documentation": "

    A unique identifier for this SimulationJob request.

    " } }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    Location for output files generated by the simulation job.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " } } }, @@ -4997,10 +6343,10 @@ "com.amazonaws.robomaker#SimulationJobBatchSummary": { "type": "structure", "members": { - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was created.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was last updated.

    " } }, "arn": { @@ -5009,16 +6355,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the batch.

    " } }, - "failedRequestCount": { + "createdRequestCount": { "target": "com.amazonaws.robomaker#Integer", "traits": { - "smithy.api#documentation": "

    The number of failed simulation job requests.

    " + "smithy.api#documentation": "

    The number of created simulation job requests.

    " } }, - "pendingRequestCount": { - "target": "com.amazonaws.robomaker#Integer", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The number of pending simulation job requests.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was created.

    " } }, "status": { @@ -5027,16 +6373,16 @@ "smithy.api#documentation": "

    The status of the simulation job batch.

    \n
    \n
    Pending
    \n
    \n

    The simulation job batch request is pending.

    \n
    \n
    InProgress
    \n
    \n

    The simulation job batch is in progress.

    \n
    \n
    Failed
    \n
    \n

    The simulation job batch failed. One or more simulation job requests could not be completed\n due to an internal failure (like InternalServiceError). \n See failureCode and failureReason for more information.

    \n
    \n
    Completed
    \n
    \n

    The simulation batch job completed. A batch is complete when (1) there are \n no pending simulation job requests in the batch and none of the \n failed simulation job requests are due to InternalServiceError and (2)\n when all created simulation jobs have reached a terminal state (for example, \n Completed or Failed).\n

    \n
    \n
    Canceled
    \n
    \n

    The simulation batch job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The simulation batch job is being cancelled.

    \n
    \n
    Completing
    \n
    \n

    The simulation batch job is completing.

    \n
    \n
    TimingOut
    \n
    \n

    The simulation job batch is timing out.

    \n

    If a batch timing out, and there are pending requests that \n were failing due to an internal failure (like InternalServiceError), \n the batch status will be Failed. If there are no such failing request, \n the batch status will be TimedOut.\n

    \n
    \n
    TimedOut
    \n
    \n

    The simulation batch job timed out.

    \n
    \n
    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "pendingRequestCount": { + "target": "com.amazonaws.robomaker#Integer", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was last updated.

    " + "smithy.api#documentation": "

    The number of pending simulation job requests.

    " } }, - "createdRequestCount": { + "failedRequestCount": { "target": "com.amazonaws.robomaker#Integer", "traits": { - "smithy.api#documentation": "

    The number of created simulation job requests.

    " + "smithy.api#documentation": "

    The number of failed simulation job requests.

    " } } }, @@ -5169,20 +6515,17 @@ "smithy.api#required": {} } }, - "compute": { - "target": "com.amazonaws.robomaker#Compute", - "traits": { - "smithy.api#documentation": "

    Compute information for the simulation job

    " - } + "loggingConfig": { + "target": "com.amazonaws.robomaker#LoggingConfig" }, - "useDefaultApplications": { - "target": "com.amazonaws.robomaker#BoxedBoolean", + "iamRole": { + "target": "com.amazonaws.robomaker#IamRole", "traits": { - "smithy.api#documentation": "

    Boolean indicating whether to use default simulation tool applications.

    " + "smithy.api#documentation": "

    The IAM role name that allows the simulation instance to call the AWS APIs that \n are specified in its associated policies on your behalf. This is how credentials are passed in to your \n simulation job. \n

    " } }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig" + "vpcConfig": { + "target": "com.amazonaws.robomaker#VPCConfig" }, "dataSources": { "target": "com.amazonaws.robomaker#DataSourceConfigs", @@ -5190,25 +6533,22 @@ "smithy.api#documentation": "

    Specify data sources to mount read-only files from S3 into your simulation. These files are \n available under /opt/robomaker/datasources/data_source_name.\n

    \n \n

    There is a limit of 100 files and a combined size of 25GB for all\n DataSourceConfig objects. \n

    \n     " } }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", + "simulationApplications": { + "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The robot applications to use in the simulation job.

    " + "smithy.api#documentation": "

    The simulation applications to use in the simulation job.

    " } }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation" - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "compute": { + "target": "com.amazonaws.robomaker#Compute", "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the simulation job request.

    " + "smithy.api#documentation": "

    Compute information for the simulation job

    " } }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", + "robotApplications": { + "target": "com.amazonaws.robomaker#RobotApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The simulation applications to use in the simulation job.

    " + "smithy.api#documentation": "

    The robot applications to use in the simulation job.

    " } }, "failureBehavior": { @@ -5217,13 +6557,19 @@ "smithy.api#documentation": "

    The failure behavior the simulation job.

    \n
    \n
    Continue
    \n
    \n

    Restart the simulation job in the same host instance.

    \n
    \n
    Fail
    \n
    \n

    Stop the simulation job and terminate the instance.

    \n
    \n
    " } }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfig" + "outputLocation": { + "target": "com.amazonaws.robomaker#OutputLocation" }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The IAM role name that allows the simulation instance to call the AWS APIs that \n are specified in its associated policies on your behalf. This is how credentials are passed in to your \n simulation job. \n

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the simulation job request.

    " + } + }, + "useDefaultApplications": { + "target": "com.amazonaws.robomaker#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

    Boolean indicating whether to use default simulation tool applications.

    " } } }, @@ -5290,202 +6636,491 @@ } } }, - "com.amazonaws.robomaker#SimulationJobSummary": { + "com.amazonaws.robomaker#SimulationJobSummary": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.robomaker#SimulationJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the simulation job.

    " + } + }, + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the simulation job.

    " + } + }, + "arn": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " + } + }, + "simulationApplicationNames": { + "target": "com.amazonaws.robomaker#SimulationApplicationNames", + "traits": { + "smithy.api#documentation": "

    A list of simulation job simulation application names.

    " + } + }, + "dataSourceNames": { + "target": "com.amazonaws.robomaker#DataSourceNames", + "traits": { + "smithy.api#documentation": "

    The names of the data sources.

    " + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " + } + }, + "robotApplicationNames": { + "target": "com.amazonaws.robomaker#RobotApplicationNames", + "traits": { + "smithy.api#documentation": "

    A list of simulation job robot application names.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Summary information for a simulation job.

    " + } + }, + "com.amazonaws.robomaker#SimulationJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#SimulationJob" + } + }, + "com.amazonaws.robomaker#SimulationSoftwareSuite": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteVersionType", + "traits": { + "smithy.api#documentation": "

    The version of the simulation software suite.

    " + } + }, + "name": { + "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteType", + "traits": { + "smithy.api#documentation": "

    The name of the simulation software suite.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a simulation software suite.

    " + } + }, + "com.amazonaws.robomaker#SimulationSoftwareSuiteType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Gazebo", + "name": "Gazebo" + }, + { + "value": "RosbagPlay", + "name": "RosbagPlay" + } + ] + } + }, + "com.amazonaws.robomaker#SimulationSoftwareSuiteVersionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "7|9|Kinetic|Melodic|Dashing" + } + }, + "com.amazonaws.robomaker#SimulationTimeMillis": { + "type": "long" + }, + "com.amazonaws.robomaker#SimulationUnit": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 15 + } + } + }, + "com.amazonaws.robomaker#Source": { + "type": "structure", + "members": { + "architecture": { + "target": "com.amazonaws.robomaker#Architecture", + "traits": { + "smithy.api#documentation": "

    The taget processor architecture for the application.

    " + } + }, + "s3Bucket": { + "target": "com.amazonaws.robomaker#S3Bucket", + "traits": { + "smithy.api#documentation": "

    The s3 bucket name.

    " + } + }, + "etag": { + "target": "com.amazonaws.robomaker#S3Etag", + "traits": { + "smithy.api#documentation": "

    A hash of the object specified by s3Bucket and s3Key.

    " + } + }, + "s3Key": { + "target": "com.amazonaws.robomaker#S3Key", + "traits": { + "smithy.api#documentation": "

    The s3 object key.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a source.

    " + } + }, + "com.amazonaws.robomaker#SourceConfig": { + "type": "structure", + "members": { + "s3Key": { + "target": "com.amazonaws.robomaker#S3Key", + "traits": { + "smithy.api#documentation": "

    The s3 object key.

    " + } + }, + "s3Bucket": { + "target": "com.amazonaws.robomaker#S3Bucket", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 bucket name.

    " + } + }, + "architecture": { + "target": "com.amazonaws.robomaker#Architecture", + "traits": { + "smithy.api#documentation": "

    The target processor architecture for the application.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a source configuration.

    " + } + }, + "com.amazonaws.robomaker#SourceConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#SourceConfig" + } + }, + "com.amazonaws.robomaker#Sources": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#Source" + } + }, + "com.amazonaws.robomaker#StartSimulationJobBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#StartSimulationJobBatchRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#StartSimulationJobBatchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#LimitExceededException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.\n

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/startSimulationJobBatch", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#StartSimulationJobBatchRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    The name of the simulation job.

    " + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "smithy.api#idempotencyToken": {} } }, - "simulationApplicationNames": { - "target": "com.amazonaws.robomaker#SimulationApplicationNames", + "createSimulationJobRequests": { + "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", "traits": { - "smithy.api#documentation": "

    A list of simulation job simulation application names.

    " + "smithy.api#documentation": "

    A list of simulation job requests to create in the batch.

    ", + "smithy.api#required": {} } }, - "robotApplicationNames": { - "target": "com.amazonaws.robomaker#RobotApplicationNames", + "batchPolicy": { + "target": "com.amazonaws.robomaker#BatchPolicy", "traits": { - "smithy.api#documentation": "

    A list of simulation job robot application names.

    " + "smithy.api#documentation": "

    The batch policy.

    " } }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", + "tags": { + "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the deployment job batch.

    " + } + } + } + }, + "com.amazonaws.robomaker#StartSimulationJobBatchResponse": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " } }, - "dataSourceNames": { - "target": "com.amazonaws.robomaker#DataSourceNames", + "failureCode": { + "target": "com.amazonaws.robomaker#SimulationJobBatchErrorCode", "traits": { - "smithy.api#documentation": "

    The names of the data sources.

    " + "smithy.api#documentation": "

    The failure code if the simulation job batch failed.

    " + } + }, + "failedRequests": { + "target": "com.amazonaws.robomaker#FailedCreateSimulationJobRequests", + "traits": { + "smithy.api#documentation": "

    A list of failed simulation job requests. The request failed to \n be created into a simulation job. Failed requests do not \n have a simulation job ID.\n

    " + } + }, + "tags": { + "target": "com.amazonaws.robomaker#TagMap", + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the deployment job batch.

    " } }, "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", + "target": "com.amazonaws.robomaker#SimulationJobBatchStatus", "traits": { - "smithy.api#documentation": "

    The status of the simulation job.

    " + "smithy.api#documentation": "

    The status of the simulation job batch.

    \n
    \n
    Pending
    \n
    \n

    The simulation job batch request is pending.

    \n
    \n
    InProgress
    \n
    \n

    The simulation job batch is in progress.

    \n
    \n
    Failed
    \n
    \n

    The simulation job batch failed. One or more simulation job requests could not be completed\n due to an internal failure (like InternalServiceError). \n See failureCode and failureReason for more information.

    \n
    \n
    Completed
    \n
    \n

    The simulation batch job completed. A batch is complete when (1) there are \n no pending simulation job requests in the batch and none of the \n failed simulation job requests are due to InternalServiceError and (2)\n when all created simulation jobs have reached a terminal state (for example, \n Completed or Failed).\n

    \n
    \n
    Canceled
    \n
    \n

    The simulation batch job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The simulation batch job is being cancelled.

    \n
    \n
    Completing
    \n
    \n

    The simulation batch job is completing.

    \n
    \n
    TimingOut
    \n
    \n

    The simulation job batch is timing out.

    \n

    If a batch timing out, and there are pending requests that \n were failing due to an internal failure (like InternalServiceError), \n the batch status will be Failed. If there are no such failing request, \n the batch status will be TimedOut.\n

    \n
    \n
    TimedOut
    \n
    \n

    The simulation batch job timed out.

    \n
    \n
    " } }, "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the simulation job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the batch.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Summary information for a simulation job.

    " - } - }, - "com.amazonaws.robomaker#SimulationJobs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SimulationJob" - } - }, - "com.amazonaws.robomaker#SimulationSoftwareSuite": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteType", + }, + "batchPolicy": { + "target": "com.amazonaws.robomaker#BatchPolicy", "traits": { - "smithy.api#documentation": "

    The name of the simulation software suite.

    " + "smithy.api#documentation": "

    The batch policy.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteVersionType", + "pendingRequests": { + "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", "traits": { - "smithy.api#documentation": "

    The version of the simulation software suite.

    " + "smithy.api#documentation": "

    A list of pending simulation job requests. These requests have\n not yet been created into simulation jobs.

    " + } + }, + "createdRequests": { + "target": "com.amazonaws.robomaker#SimulationJobSummaries", + "traits": { + "smithy.api#documentation": "

    A list of created simulation job request summaries.

    " + } + }, + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was created.

    " + } + }, + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", + "traits": { + "smithy.api#documentation": "

    The reason the simulation job batch failed.

    " } } - }, - "traits": { - "smithy.api#documentation": "

    Information about a simulation software suite.

    " } }, - "com.amazonaws.robomaker#SimulationSoftwareSuiteType": { - "type": "string", + "com.amazonaws.robomaker#Subnets": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#NonEmptyString" + }, "traits": { - "smithy.api#enum": [ - { - "value": "Gazebo", - "name": "Gazebo" - }, - { - "value": "RosbagPlay", - "name": "RosbagPlay" - } - ] + "smithy.api#length": { + "min": 1, + "max": 16 + } } }, - "com.amazonaws.robomaker#SimulationSoftwareSuiteVersionType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 + "com.amazonaws.robomaker#SyncDeploymentJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#SyncDeploymentJobRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#SyncDeploymentJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#ConcurrentDeploymentException" }, - "smithy.api#pattern": "7|9|Kinetic|Melodic|Dashing" + { + "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.robomaker#InternalServerException" + }, + { + "target": "com.amazonaws.robomaker#InvalidParameterException" + }, + { + "target": "com.amazonaws.robomaker#LimitExceededException" + }, + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/syncDeploymentJob", + "code": 200 + } } }, - "com.amazonaws.robomaker#SimulationTimeMillis": { - "type": "long" - }, - "com.amazonaws.robomaker#SimulationUnit": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 15 + "com.amazonaws.robomaker#SyncDeploymentJobRequest": { + "type": "structure", + "members": { + "fleet": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The target fleet for the synchronization.

    ", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.robomaker#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } } } }, - "com.amazonaws.robomaker#Source": { + "com.amazonaws.robomaker#SyncDeploymentJobResponse": { "type": "structure", "members": { - "s3Key": { - "target": "com.amazonaws.robomaker#S3Key", + "deploymentApplicationConfigs": { + "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", "traits": { - "smithy.api#documentation": "

    The s3 object key.

    " + "smithy.api#documentation": "

    Information about the deployment application configurations.

    " } }, - "etag": { - "target": "com.amazonaws.robomaker#S3Etag", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    A hash of the object specified by s3Bucket and s3Key.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " } }, - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", + "deploymentConfig": { + "target": "com.amazonaws.robomaker#DeploymentConfig", "traits": { - "smithy.api#documentation": "

    The s3 bucket name.

    " + "smithy.api#documentation": "

    Information about the deployment configuration.

    " } }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", + "status": { + "target": "com.amazonaws.robomaker#DeploymentStatus", "traits": { - "smithy.api#documentation": "

    The taget processor architecture for the application.

    " + "smithy.api#documentation": "

    The status of the synchronization job.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Information about a source.

    " - } - }, - "com.amazonaws.robomaker#SourceConfig": { - "type": "structure", - "members": { - "s3Key": { - "target": "com.amazonaws.robomaker#S3Key", + }, + "failureReason": { + "target": "com.amazonaws.robomaker#GenericString", + "traits": { + "smithy.api#documentation": "

    The failure reason if the job fails.

    " + } + }, + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The s3 object key.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the synchronization request.

    " } }, - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", + "fleet": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon S3 bucket name.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", + "failureCode": { + "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", "traits": { - "smithy.api#documentation": "

    The target processor architecture for the application.

    " + "smithy.api#documentation": "

    The failure code if the job fails:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    RobotApplicationCrash
    \n
    \n

    Robot application exited abnormally.

    \n
    \n
    SimulationApplicationCrash
    \n
    \n

    Simulation application exited abnormally.

    \n
    \n
    BadPermissionsRobotApplication
    \n
    \n

    Robot application bundle could not be downloaded.

    \n
    \n
    BadPermissionsSimulationApplication
    \n
    \n

    Simulation application bundle could not be downloaded.

    \n
    \n
    BadPermissionsS3Output
    \n
    \n

    Unable to publish outputs to customer-provided S3 bucket.

    \n
    \n
    BadPermissionsCloudwatchLogs
    \n
    \n

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    \n
    \n
    SubnetIpLimitExceeded
    \n
    \n

    Subnet IP limit exceeded.

    \n
    \n
    ENILimitExceeded
    \n
    \n

    ENI limit exceeded.

    \n
    \n
    BadPermissionsUserCredentials
    \n
    \n

    Unable to use the Role provided.

    \n
    \n
    InvalidBundleRobotApplication
    \n
    \n

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    InvalidBundleSimulationApplication
    \n
    \n

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    RobotApplicationVersionMismatchedEtag
    \n
    \n

    Etag for RobotApplication does not match value during version creation.

    \n
    \n
    SimulationApplicationVersionMismatchedEtag
    \n
    \n

    Etag for SimulationApplication does not match value during version creation.

    \n
    \n
    " } } - }, + } + }, + "com.amazonaws.robomaker#TagKey": { + "type": "string", "traits": { - "smithy.api#documentation": "

    Information about a source configuration.

    " + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "[a-zA-Z0-9 _.\\-\\/+=:]*" } }, - "com.amazonaws.robomaker#SourceConfigs": { + "com.amazonaws.robomaker#TagKeyList": { "type": "list", "member": { - "target": "com.amazonaws.robomaker#SourceConfig" + "target": "com.amazonaws.robomaker#TagKey" } }, - "com.amazonaws.robomaker#Sources": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Source" + "com.amazonaws.robomaker#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.robomaker#TagKey" + }, + "value": { + "target": "com.amazonaws.robomaker#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } } }, - "com.amazonaws.robomaker#StartSimulationJobBatch": { + "com.amazonaws.robomaker#TagResource": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#StartSimulationJobBatchRequest" + "target": "com.amazonaws.robomaker#TagResourceRequest" }, "output": { - "target": "com.amazonaws.robomaker#StartSimulationJobBatchResponse" + "target": "com.amazonaws.robomaker#TagResourceResponse" }, "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, { "target": "com.amazonaws.robomaker#InternalServerException" }, @@ -5493,150 +7128,203 @@ "target": "com.amazonaws.robomaker#InvalidParameterException" }, { - "target": "com.amazonaws.robomaker#LimitExceededException" + "target": "com.amazonaws.robomaker#ResourceNotFoundException" }, { "target": "com.amazonaws.robomaker#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.\n

    ", + "smithy.api#documentation": "

    Adds or edits tags for a AWS RoboMaker resource.

    \n

    Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.

    \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 Guide.

    ", "smithy.api#http": { "method": "POST", - "uri": "/startSimulationJobBatch", + "uri": "/tags/{resourceArn}", "code": 200 } } }, - "com.amazonaws.robomaker#StartSimulationJobBatchRequest": { + "com.amazonaws.robomaker#TagResourceRequest": { "type": "structure", "members": { - "batchPolicy": { - "target": "com.amazonaws.robomaker#BatchPolicy", + "resourceArn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The batch policy.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.robomaker#TagMap", "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the deployment job batch.

    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the resource.

    ", + "smithy.api#required": {} } + } + } + }, + "com.amazonaws.robomaker#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.robomaker#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 }, - "createSimulationJobRequests": { - "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", + "smithy.api#pattern": "[a-zA-Z0-9 _.\\-\\/+=:]*" + } + }, + "com.amazonaws.robomaker#TemplateLocation": { + "type": "structure", + "members": { + "s3Bucket": { + "target": "com.amazonaws.robomaker#S3Bucket", "traits": { - "smithy.api#documentation": "

    A list of simulation job requests to create in the batch.

    ", + "smithy.api#documentation": "

    The Amazon S3 bucket name.

    ", "smithy.api#required": {} } }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", + "s3Key": { + "target": "com.amazonaws.robomaker#S3Key", "traits": { - "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    The list of S3 keys identifying the data source files.

    ", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

    Information about a template location.

    " } }, - "com.amazonaws.robomaker#StartSimulationJobBatchResponse": { + "com.amazonaws.robomaker#TemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.robomaker#TemplateSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#TemplateSummary" + } + }, + "com.amazonaws.robomaker#TemplateSummary": { "type": "structure", "members": { - "failedRequests": { - "target": "com.amazonaws.robomaker#FailedCreateSimulationJobRequests", - "traits": { - "smithy.api#documentation": "

    A list of failed simulation job requests. The request failed to \n be created into a simulation job. Failed requests do not \n have a simulation job ID.\n

    " - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The reason the simulation job batch failed.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the template was last updated.

    " } }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the template.

    " } }, - "pendingRequests": { - "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", + "name": { + "target": "com.amazonaws.robomaker#TemplateName", "traits": { - "smithy.api#documentation": "

    A list of pending simulation job requests. These requests have\n not yet been created into simulation jobs.

    " + "smithy.api#documentation": "

    The name of the template.

    " } }, "createdAt": { "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation job batch was created.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the template was created.

    " } + } + }, + "traits": { + "smithy.api#documentation": "

    Summary information for a template.

    " + } + }, + "com.amazonaws.robomaker#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.robomaker#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    AWS RoboMaker is temporarily unable to process the request. Try your call again.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.robomaker#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.robomaker#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.robomaker#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.robomaker#InternalServerException" }, - "createdRequests": { - "target": "com.amazonaws.robomaker#SimulationJobSummaries", - "traits": { - "smithy.api#documentation": "

    A list of created simulation job request summaries.

    " - } + { + "target": "com.amazonaws.robomaker#InvalidParameterException" }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobBatchErrorCode", - "traits": { - "smithy.api#documentation": "

    The failure code if the simulation job batch failed.

    " - } + { + "target": "com.amazonaws.robomaker#ResourceNotFoundException" }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobBatchStatus", + { + "target": "com.amazonaws.robomaker#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Removes the specified tags from the specified AWS RoboMaker resource.

    \n

    To remove a tag, specify the tag key. To change the tag value of an existing tag key, use \n \n TagResource\n .\n

    ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.robomaker#UntagResourceRequest": { + "type": "structure", + "members": { + "tagKeys": { + "target": "com.amazonaws.robomaker#TagKeyList", "traits": { - "smithy.api#documentation": "

    The status of the simulation job batch.

    \n
    \n
    Pending
    \n
    \n

    The simulation job batch request is pending.

    \n
    \n
    InProgress
    \n
    \n

    The simulation job batch is in progress.

    \n
    \n
    Failed
    \n
    \n

    The simulation job batch failed. One or more simulation job requests could not be completed\n due to an internal failure (like InternalServiceError). \n See failureCode and failureReason for more information.

    \n
    \n
    Completed
    \n
    \n

    The simulation batch job completed. A batch is complete when (1) there are \n no pending simulation job requests in the batch and none of the \n failed simulation job requests are due to InternalServiceError and (2)\n when all created simulation jobs have reached a terminal state (for example, \n Completed or Failed).\n

    \n
    \n
    Canceled
    \n
    \n

    The simulation batch job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The simulation batch job is being cancelled.

    \n
    \n
    Completing
    \n
    \n

    The simulation batch job is completing.

    \n
    \n
    TimingOut
    \n
    \n

    The simulation job batch is timing out.

    \n

    If a batch timing out, and there are pending requests that \n were failing due to an internal failure (like InternalServiceError), \n the batch status will be Failed. If there are no such failing request, \n the batch status will be TimedOut.\n

    \n
    \n
    TimedOut
    \n
    \n

    The simulation batch job timed out.

    \n
    \n
    " + "smithy.api#documentation": "

    A map that contains tag keys and tag values that will be unattached from the resource.

    ", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} } }, - "arn": { + "resourceArn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the batch.

    " - } - }, - "batchPolicy": { - "target": "com.amazonaws.robomaker#BatchPolicy", - "traits": { - "smithy.api#documentation": "

    The batch policy.

    " - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the deployment job batch.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#Subnets": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } + "com.amazonaws.robomaker#UntagResourceResponse": { + "type": "structure", + "members": {} }, - "com.amazonaws.robomaker#SyncDeploymentJob": { + "com.amazonaws.robomaker#UpdateRobotApplication": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#SyncDeploymentJobRequest" + "target": "com.amazonaws.robomaker#UpdateRobotApplicationRequest" }, "output": { - "target": "com.amazonaws.robomaker#SyncDeploymentJobResponse" + "target": "com.amazonaws.robomaker#UpdateRobotApplicationResponse" }, "errors": [ - { - "target": "com.amazonaws.robomaker#ConcurrentDeploymentException" - }, - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, { "target": "com.amazonaws.robomaker#InternalServerException" }, @@ -5654,125 +7342,100 @@ } ], "traits": { - "smithy.api#documentation": "

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

    ", + "smithy.api#documentation": "

    Updates a robot application.

    ", "smithy.api#http": { "method": "POST", - "uri": "/syncDeploymentJob", + "uri": "/updateRobotApplication", "code": 200 } } }, - "com.amazonaws.robomaker#SyncDeploymentJobRequest": { + "com.amazonaws.robomaker#UpdateRobotApplicationRequest": { "type": "structure", "members": { - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", + "application": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "

    The application information for the robot application.

    ", "smithy.api#required": {} } }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", + "currentRevisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The target fleet for the synchronization.

    ", + "smithy.api#documentation": "

    The revision id for the robot application.

    " + } + }, + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "traits": { + "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    ", + "smithy.api#required": {} + } + }, + "sources": { + "target": "com.amazonaws.robomaker#SourceConfigs", + "traits": { + "smithy.api#documentation": "

    The sources of the robot application.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.robomaker#SyncDeploymentJobResponse": { + "com.amazonaws.robomaker#UpdateRobotApplicationResponse": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.robomaker#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

    The status of the synchronization job.

    " - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", + "version": { + "target": "com.amazonaws.robomaker#Version", "traits": { - "smithy.api#documentation": "

    The failure reason if the job fails.

    " + "smithy.api#documentation": "

    The version of the robot application.

    " } }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    Information about the deployment application configurations.

    " + "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " } }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", "traits": { - "smithy.api#documentation": "

    The failure code if the job fails:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    RobotApplicationCrash
    \n
    \n

    Robot application exited abnormally.

    \n
    \n
    SimulationApplicationCrash
    \n
    \n

    Simulation application exited abnormally.

    \n
    \n
    BadPermissionsRobotApplication
    \n
    \n

    Robot application bundle could not be downloaded.

    \n
    \n
    BadPermissionsSimulationApplication
    \n
    \n

    Simulation application bundle could not be downloaded.

    \n
    \n
    BadPermissionsS3Output
    \n
    \n

    Unable to publish outputs to customer-provided S3 bucket.

    \n
    \n
    BadPermissionsCloudwatchLogs
    \n
    \n

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    \n
    \n
    SubnetIpLimitExceeded
    \n
    \n

    Subnet IP limit exceeded.

    \n
    \n
    ENILimitExceeded
    \n
    \n

    ENI limit exceeded.

    \n
    \n
    BadPermissionsUserCredentials
    \n
    \n

    Unable to use the Role provided.

    \n
    \n
    InvalidBundleRobotApplication
    \n
    \n

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    InvalidBundleSimulationApplication
    \n
    \n

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    \n
    \n
    RobotApplicationVersionMismatchedEtag
    \n
    \n

    Etag for RobotApplication does not match value during version creation.

    \n
    \n
    SimulationApplicationVersionMismatchedEtag
    \n
    \n

    Etag for SimulationApplication does not match value during version creation.

    \n
    \n
    " + "smithy.api#documentation": "

    The revision id of the robot application.

    " } }, - "fleet": { + "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the updated robot application.

    " } }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", + "name": { + "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

    Information about the deployment configuration.

    " + "smithy.api#documentation": "

    The name of the robot application.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the synchronization request.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " } }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", + "sources": { + "target": "com.amazonaws.robomaker#Sources", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " + "smithy.api#documentation": "

    The sources of the robot application.

    " } } } }, - "com.amazonaws.robomaker#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "[a-zA-Z0-9 _.\\-\\/+=:]*" - } - }, - "com.amazonaws.robomaker#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#TagKey" - } - }, - "com.amazonaws.robomaker#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.robomaker#TagKey" - }, - "value": { - "target": "com.amazonaws.robomaker#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.robomaker#TagResource": { + "com.amazonaws.robomaker#UpdateSimulationApplication": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#TagResourceRequest" + "target": "com.amazonaws.robomaker#UpdateSimulationApplicationRequest" }, "output": { - "target": "com.amazonaws.robomaker#TagResourceResponse" + "target": "com.amazonaws.robomaker#UpdateSimulationApplicationResponse" }, "errors": [ { @@ -5781,6 +7444,9 @@ { "target": "com.amazonaws.robomaker#InvalidParameterException" }, + { + "target": "com.amazonaws.robomaker#LimitExceededException" + }, { "target": "com.amazonaws.robomaker#ResourceNotFoundException" }, @@ -5789,124 +7455,125 @@ } ], "traits": { - "smithy.api#documentation": "

    Adds or edits tags for a AWS RoboMaker resource.

    \n

    Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.

    \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 Guide.

    ", + "smithy.api#documentation": "

    Updates a simulation application.

    ", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", + "uri": "/updateSimulationApplication", "code": 200 } } }, - "com.amazonaws.robomaker#TagResourceRequest": { + "com.amazonaws.robomaker#UpdateSimulationApplicationRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.robomaker#TagMap", + "simulationSoftwareSuite": { + "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the resource.

    ", + "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    ", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.robomaker#Arn", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    ", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.robomaker#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.robomaker#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 }, - "smithy.api#pattern": "[a-zA-Z0-9 _.\\-\\/+=:]*" - } - }, - "com.amazonaws.robomaker#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

    AWS RoboMaker is temporarily unable to process the request. Try your call again.

    ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" + "currentRevisionId": { + "target": "com.amazonaws.robomaker#RevisionId", + "traits": { + "smithy.api#documentation": "

    The revision id for the robot application.

    " + } }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" + "application": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The application information for the simulation application.

    ", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" + "sources": { + "target": "com.amazonaws.robomaker#SourceConfigs", + "traits": { + "smithy.api#documentation": "

    The sources of the simulation application.

    ", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

    Removes the specified tags from the specified AWS RoboMaker resource.

    \n

    To remove a tag, specify the tag key. To change the tag value of an existing tag key, use \n \n TagResource\n .\n

    ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "renderingEngine": { + "target": "com.amazonaws.robomaker#RenderingEngine", + "traits": { + "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + } } } }, - "com.amazonaws.robomaker#UntagResourceRequest": { + "com.amazonaws.robomaker#UpdateSimulationApplicationResponse": { "type": "structure", "members": { - "resourceArn": { + "name": { + "target": "com.amazonaws.robomaker#Name", + "traits": { + "smithy.api#documentation": "

    The name of the simulation application.

    " + } + }, + "renderingEngine": { + "target": "com.amazonaws.robomaker#RenderingEngine", + "traits": { + "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + } + }, + "sources": { + "target": "com.amazonaws.robomaker#Sources", + "traits": { + "smithy.api#documentation": "

    The sources of the simulation application.

    " + } + }, + "simulationSoftwareSuite": { + "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", + "traits": { + "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.robomaker#LastUpdatedAt", + "traits": { + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + } + }, + "revisionId": { + "target": "com.amazonaws.robomaker#RevisionId", + "traits": { + "smithy.api#documentation": "

    The revision id of the simulation application.

    " + } + }, + "version": { + "target": "com.amazonaws.robomaker#Version", + "traits": { + "smithy.api#documentation": "

    The version of the robot application.

    " + } + }, + "arn": { "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the updated simulation application.

    " } }, - "tagKeys": { - "target": "com.amazonaws.robomaker#TagKeyList", + "robotSoftwareSuite": { + "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

    A map that contains tag keys and tag values that will be unattached from the resource.

    ", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} + "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " } } } }, - "com.amazonaws.robomaker#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.robomaker#UpdateRobotApplication": { + "com.amazonaws.robomaker#UpdateWorldTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.robomaker#UpdateRobotApplicationRequest" + "target": "com.amazonaws.robomaker#UpdateWorldTemplateRequest" }, "output": { - "target": "com.amazonaws.robomaker#UpdateRobotApplicationResponse" + "target": "com.amazonaws.robomaker#UpdateWorldTemplateResponse" }, "errors": [ { @@ -5915,9 +7582,6 @@ { "target": "com.amazonaws.robomaker#InvalidParameterException" }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, { "target": "com.amazonaws.robomaker#ResourceNotFoundException" }, @@ -5926,308 +7590,506 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates a robot application.

    ", + "smithy.api#documentation": "

    Updates a world template.

    ", "smithy.api#http": { "method": "POST", - "uri": "/updateRobotApplication", + "uri": "/updateWorldTemplate", "code": 200 } } }, - "com.amazonaws.robomaker#UpdateRobotApplicationRequest": { + "com.amazonaws.robomaker#UpdateWorldTemplateRequest": { "type": "structure", "members": { - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "template": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The revision id for the robot application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template to update.

    ", + "smithy.api#required": {} } }, - "sources": { - "target": "com.amazonaws.robomaker#SourceConfigs", + "templateBody": { + "target": "com.amazonaws.robomaker#Json", "traits": { - "smithy.api#documentation": "

    The sources of the robot application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The world template body.

    " } }, - "application": { - "target": "com.amazonaws.robomaker#Arn", + "templateLocation": { + "target": "com.amazonaws.robomaker#TemplateLocation", "traits": { - "smithy.api#documentation": "

    The application information for the robot application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The location of the world template.

    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "name": { + "target": "com.amazonaws.robomaker#TemplateName", "traits": { - "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the template.

    " } } } }, - "com.amazonaws.robomaker#UpdateRobotApplicationResponse": { + "com.amazonaws.robomaker#UpdateWorldTemplateResponse": { "type": "structure", "members": { - "sources": { - "target": "com.amazonaws.robomaker#Sources", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The sources of the robot application.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world template was created.

    " + } + }, + "name": { + "target": "com.amazonaws.robomaker#TemplateName", + "traits": { + "smithy.api#documentation": "

    The name of the world template.

    " } }, "lastUpdatedAt": { "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world template was last updated.

    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The robot software suite (ROS distribution) used by the robot application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template.

    " + } + } + } + }, + "com.amazonaws.robomaker#VPCConfig": { + "type": "structure", + "members": { + "securityGroups": { + "target": "com.amazonaws.robomaker#SecurityGroups", + "traits": { + "smithy.api#documentation": "

    A list of one or more security groups IDs in your VPC.

    " } }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "assignPublicIp": { + "target": "com.amazonaws.robomaker#Boolean", "traits": { - "smithy.api#documentation": "

    The revision id of the robot application.

    " + "smithy.api#documentation": "

    A boolean indicating whether to assign a public IP address.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "subnets": { + "target": "com.amazonaws.robomaker#Subnets", "traits": { - "smithy.api#documentation": "

    The version of the robot application.

    " + "smithy.api#documentation": "

    A list of one or more subnet IDs in your VPC.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security \n group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one \n security group and two subnet IDs.

    " + } + }, + "com.amazonaws.robomaker#VPCConfigResponse": { + "type": "structure", + "members": { + "vpcId": { + "target": "com.amazonaws.robomaker#GenericString", + "traits": { + "smithy.api#documentation": "

    The VPC ID associated with your simulation job.

    " } }, - "name": { - "target": "com.amazonaws.robomaker#Name", + "assignPublicIp": { + "target": "com.amazonaws.robomaker#Boolean", "traits": { - "smithy.api#documentation": "

    The name of the robot application.

    " + "smithy.api#documentation": "

    A boolean indicating if a public IP was assigned.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "securityGroups": { + "target": "com.amazonaws.robomaker#SecurityGroups", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the updated robot application.

    " + "smithy.api#documentation": "

    A list of security group IDs associated with the simulation job.

    " + } + }, + "subnets": { + "target": "com.amazonaws.robomaker#Subnets", + "traits": { + "smithy.api#documentation": "

    A list of subnet IDs associated with the simulation job.

    " } } + }, + "traits": { + "smithy.api#documentation": "

    VPC configuration associated with your simulation job.

    " } }, - "com.amazonaws.robomaker#UpdateSimulationApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#UpdateSimulationApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#UpdateSimulationApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" + "com.amazonaws.robomaker#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" + "smithy.api#pattern": "(\\$LATEST)|[0-9]*" + } + }, + "com.amazonaws.robomaker#VersionQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" + "smithy.api#pattern": "ALL" + } + }, + "com.amazonaws.robomaker#WorldConfig": { + "type": "structure", + "members": { + "world": { + "target": "com.amazonaws.robomaker#Arn", + "traits": { + "smithy.api#documentation": "

    The world generated by Simulation WorldForge.

    " + } } - ], + }, "traits": { - "smithy.api#documentation": "

    Updates a simulation application.

    ", - "smithy.api#http": { - "method": "POST", - "uri": "/updateSimulationApplication", - "code": 200 + "smithy.api#documentation": "

    Configuration information for a world.

    " + } + }, + "com.amazonaws.robomaker#WorldConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#WorldConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 } } }, - "com.amazonaws.robomaker#UpdateSimulationApplicationRequest": { + "com.amazonaws.robomaker#WorldCount": { "type": "structure", "members": { - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", + "floorplanCount": { + "target": "com.amazonaws.robomaker#FloorplanCount", "traits": { - "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of unique floorplans.

    " } }, - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", + "interiorCountPerFloorplan": { + "target": "com.amazonaws.robomaker#InteriorCountPerFloorplan", "traits": { - "smithy.api#documentation": "

    The revision id for the robot application.

    " + "smithy.api#documentation": "

    The number of unique interiors per floorplan.

    " } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + } + }, + "traits": { + "smithy.api#documentation": "

    The number of worlds that will be created. You can configure the number\n of unique floorplans and the number of unique interiors for each floor plan. For example,\n if you want 1 world with 20 unique interiors, you set floorplanCount = 1\n and interiorCountPerFloorplan = 20. This will result in 20 worlds \n (floorplanCount * interiorCountPerFloorplan).\n

    \n

    If you set floorplanCount = 4 and interiorCountPerFloorplan = 5,\n there will be 20 worlds with 5 unique floor plans. \n

    " + } + }, + "com.amazonaws.robomaker#WorldExportJobErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InternalServiceError", + "name": "InternalServiceError" + }, + { + "value": "LimitExceeded", + "name": "LimitExceeded" + }, + { + "value": "ResourceNotFound", + "name": "ResourceNotFound" + }, + { + "value": "RequestThrottled", + "name": "RequestThrottled" + }, + { + "value": "InvalidInput", + "name": "InvalidInput" + }, + { + "value": "AccessDenied", + "name": "AccessDenied" + } + ] + } + }, + "com.amazonaws.robomaker#WorldExportJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Pending", + "name": "Pending" + }, + { + "value": "Running", + "name": "Running" + }, + { + "value": "Completed", + "name": "Completed" + }, + { + "value": "Failed", + "name": "Failed" + }, + { + "value": "Canceling", + "name": "Canceling" + }, + { + "value": "Canceled", + "name": "Canceled" + } + ] + } + }, + "com.amazonaws.robomaker#WorldExportJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#WorldExportJobSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.robomaker#WorldExportJobSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world export job.

    " } }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world export job was created.

    " } }, - "sources": { - "target": "com.amazonaws.robomaker#SourceConfigs", + "worlds": { + "target": "com.amazonaws.robomaker#Arns", "traits": { - "smithy.api#documentation": "

    The sources of the simulation application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of worlds.

    " } }, - "application": { - "target": "com.amazonaws.robomaker#Arn", + "status": { + "target": "com.amazonaws.robomaker#WorldExportJobStatus", "traits": { - "smithy.api#documentation": "

    The application information for the simulation application.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The status of the world export job.

    \n
    \n
    Pending
    \n
    \n

    The world export job request is pending.

    \n
    \n
    Running
    \n
    \n

    The world export job is running.

    \n
    \n
    Completed
    \n
    \n

    The world export job completed.\n

    \n
    \n
    Failed
    \n
    \n

    The world export job failed. See failureCode for more information.\n

    \n
    \n
    Canceled
    \n
    \n

    The world export job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The world export job is being cancelled.

    \n
    \n
    " } } + }, + "traits": { + "smithy.api#documentation": "

    Information about a world export job.

    " } }, - "com.amazonaws.robomaker#UpdateSimulationApplicationResponse": { + "com.amazonaws.robomaker#WorldFailure": { "type": "structure", "members": { - "sources": { - "target": "com.amazonaws.robomaker#Sources", + "failureCount": { + "target": "com.amazonaws.robomaker#Integer", "traits": { - "smithy.api#documentation": "

    The sources of the simulation application.

    " + "smithy.api#documentation": "

    The number of failed worlds.

    " } }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", + "sampleFailureReason": { + "target": "com.amazonaws.robomaker#GenericString", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the updated simulation application.

    " + "smithy.api#documentation": "

    The sample reason why the world failed. World errors are aggregated. A sample is used\n as the sampleFailureReason.\n

    " } }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", + "failureCode": { + "target": "com.amazonaws.robomaker#WorldGenerationJobErrorCode", "traits": { - "smithy.api#documentation": "

    The simulation software suite used by the simulation application.

    " + "smithy.api#documentation": "

    The failure code of the world export job if it failed:

    \n
    \n
    InternalServiceError
    \n
    \n

    Internal service error.

    \n
    \n
    LimitExceeded
    \n
    \n

    The requested resource exceeds the maximum number allowed, or the number of concurrent \n stream requests exceeds the maximum number allowed. \n

    \n
    \n
    ResourceNotFound
    \n
    \n

    The specified resource could not be found. \n

    \n
    \n
    RequestThrottled
    \n
    \n

    The request was throttled.

    \n
    \n
    InvalidInput
    \n
    \n

    An input parameter in the request is not valid.

    \n
    \n
    " } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a failed world.

    " + } + }, + "com.amazonaws.robomaker#WorldFailures": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#WorldFailure" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.robomaker#WorldGenerationJobErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InternalServiceError", + "name": "InternalServiceError" + }, + { + "value": "LimitExceeded", + "name": "LimitExceeded" + }, + { + "value": "ResourceNotFound", + "name": "ResourceNotFound" + }, + { + "value": "RequestThrottled", + "name": "RequestThrottled" + }, + { + "value": "InvalidInput", + "name": "InvalidInput" + }, + { + "value": "AllWorldGenerationFailed", + "name": "AllWorldGenerationFailed" } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

    The revision id of the simulation application.

    " + ] + } + }, + "com.amazonaws.robomaker#WorldGenerationJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Pending", + "name": "Pending" + }, + { + "value": "Running", + "name": "Running" + }, + { + "value": "Completed", + "name": "Completed" + }, + { + "value": "Failed", + "name": "Failed" + }, + { + "value": "PartialFailed", + "name": "PartialFailed" + }, + { + "value": "Canceling", + "name": "Canceling" + }, + { + "value": "Canceled", + "name": "Canceled" } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", + ] + } + }, + "com.amazonaws.robomaker#WorldGenerationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#WorldGenerationJobSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.robomaker#WorldGenerationJobSummary": { + "type": "structure", + "members": { + "succeededWorldCount": { + "target": "com.amazonaws.robomaker#Integer", "traits": { - "smithy.api#documentation": "

    The name of the simulation application.

    " + "smithy.api#documentation": "

    The number of worlds that were generated.

    " } }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    Information about the robot software suite (ROS distribution).

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world generator job was created.

    " } }, - "version": { - "target": "com.amazonaws.robomaker#Version", + "template": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The version of the robot application.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template.

    " } }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", + "failedWorldCount": { + "target": "com.amazonaws.robomaker#Integer", "traits": { - "smithy.api#documentation": "

    The rendering engine for the simulation application.

    " + "smithy.api#documentation": "

    The number of worlds that failed.

    " } - } - } - }, - "com.amazonaws.robomaker#VPCConfig": { - "type": "structure", - "members": { - "subnets": { - "target": "com.amazonaws.robomaker#Subnets", + }, + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    A list of one or more subnet IDs in your VPC.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world generator job.

    " } }, - "assignPublicIp": { - "target": "com.amazonaws.robomaker#Boolean", + "worldCount": { + "target": "com.amazonaws.robomaker#WorldCount", "traits": { - "smithy.api#documentation": "

    A boolean indicating whether to assign a public IP address.

    " + "smithy.api#documentation": "

    Information about the world count.

    " } }, - "securityGroups": { - "target": "com.amazonaws.robomaker#SecurityGroups", + "status": { + "target": "com.amazonaws.robomaker#WorldGenerationJobStatus", "traits": { - "smithy.api#documentation": "

    A list of one or more security groups IDs in your VPC.

    " + "smithy.api#documentation": "

    The status of the world generator job:

    \n
    \n
    Pending
    \n
    \n

    The world generator job request is pending.

    \n
    \n
    Running
    \n
    \n

    The world generator job is running.

    \n
    \n
    Completed
    \n
    \n

    The world generator job completed.\n

    \n
    \n
    Failed
    \n
    \n

    The world generator job failed. See failureCode for more information.\n

    \n
    \n
    PartialFailed
    \n
    \n

    Some worlds did not generate.

    \n
    \n
    Canceled
    \n
    \n

    The world generator job was cancelled.

    \n
    \n
    Canceling
    \n
    \n

    The world generator job is being cancelled.

    \n
    \n
    " } } }, "traits": { - "smithy.api#documentation": "

    If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security \n group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one \n security group and two subnet IDs.

    " + "smithy.api#documentation": "

    Information about a world generator job.

    " } }, - "com.amazonaws.robomaker#VPCConfigResponse": { + "com.amazonaws.robomaker#WorldSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#WorldSummary" + } + }, + "com.amazonaws.robomaker#WorldSummary": { "type": "structure", "members": { - "vpcId": { - "target": "com.amazonaws.robomaker#GenericString", + "template": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    The VPC ID associated with your simulation job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world template.

    " } }, - "securityGroups": { - "target": "com.amazonaws.robomaker#SecurityGroups", + "createdAt": { + "target": "com.amazonaws.robomaker#CreatedAt", "traits": { - "smithy.api#documentation": "

    A list of security group IDs associated with the simulation job.

    " + "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the world was created.

    " } }, - "subnets": { - "target": "com.amazonaws.robomaker#Subnets", + "generationJob": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    A list of subnet IDs associated with the simulation job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (arn) of the world generation job.

    " } }, - "assignPublicIp": { - "target": "com.amazonaws.robomaker#Boolean", + "arn": { + "target": "com.amazonaws.robomaker#Arn", "traits": { - "smithy.api#documentation": "

    A boolean indicating if a public IP was assigned.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the world.

    " } } }, "traits": { - "smithy.api#documentation": "

    VPC configuration associated with your simulation job.

    " - } - }, - "com.amazonaws.robomaker#Version": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "(\\$LATEST)|[0-9]*" - } - }, - "com.amazonaws.robomaker#VersionQualifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "ALL" + "smithy.api#documentation": "

    Information about a world.

    " } }, "com.amazonaws.robomaker#errorMessage": { @@ -6237,6 +8099,9 @@ "type": "service", "version": "2018-06-29", "operations": [ + { + "target": "com.amazonaws.robomaker#BatchDeleteWorlds" + }, { "target": "com.amazonaws.robomaker#BatchDescribeSimulationJob" }, @@ -6249,6 +8114,12 @@ { "target": "com.amazonaws.robomaker#CancelSimulationJobBatch" }, + { + "target": "com.amazonaws.robomaker#CancelWorldExportJob" + }, + { + "target": "com.amazonaws.robomaker#CancelWorldGenerationJob" + }, { "target": "com.amazonaws.robomaker#CreateDeploymentJob" }, @@ -6273,6 +8144,15 @@ { "target": "com.amazonaws.robomaker#CreateSimulationJob" }, + { + "target": "com.amazonaws.robomaker#CreateWorldExportJob" + }, + { + "target": "com.amazonaws.robomaker#CreateWorldGenerationJob" + }, + { + "target": "com.amazonaws.robomaker#CreateWorldTemplate" + }, { "target": "com.amazonaws.robomaker#DeleteFleet" }, @@ -6285,6 +8165,9 @@ { "target": "com.amazonaws.robomaker#DeleteSimulationApplication" }, + { + "target": "com.amazonaws.robomaker#DeleteWorldTemplate" + }, { "target": "com.amazonaws.robomaker#DeregisterRobot" }, @@ -6309,6 +8192,21 @@ { "target": "com.amazonaws.robomaker#DescribeSimulationJobBatch" }, + { + "target": "com.amazonaws.robomaker#DescribeWorld" + }, + { + "target": "com.amazonaws.robomaker#DescribeWorldExportJob" + }, + { + "target": "com.amazonaws.robomaker#DescribeWorldGenerationJob" + }, + { + "target": "com.amazonaws.robomaker#DescribeWorldTemplate" + }, + { + "target": "com.amazonaws.robomaker#GetWorldTemplateBody" + }, { "target": "com.amazonaws.robomaker#ListDeploymentJobs" }, @@ -6333,6 +8231,18 @@ { "target": "com.amazonaws.robomaker#ListTagsForResource" }, + { + "target": "com.amazonaws.robomaker#ListWorldExportJobs" + }, + { + "target": "com.amazonaws.robomaker#ListWorldGenerationJobs" + }, + { + "target": "com.amazonaws.robomaker#ListWorlds" + }, + { + "target": "com.amazonaws.robomaker#ListWorldTemplates" + }, { "target": "com.amazonaws.robomaker#RegisterRobot" }, @@ -6356,6 +8266,9 @@ }, { "target": "com.amazonaws.robomaker#UpdateSimulationApplication" + }, + { + "target": "com.amazonaws.robomaker#UpdateWorldTemplate" } ], "traits": { diff --git a/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json b/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json index 0ee3226b2ced..66b1273fb007 100644 --- a/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json +++ b/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json @@ -106,18 +106,24 @@ "com.amazonaws.route53domains#BillingRecord": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.route53domains#DomainName", - "traits": { - "smithy.api#documentation": "

    The name of the domain that the billing record applies to. If the domain name contains characters \n\t\t\tother than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. \n\t\t\tFor more information, see \n\t\t\tDNS Domain Name Format \n\t\t\tin the Amazon Route 53 Developer Guide.

    " - } - }, "Operation": { "target": "com.amazonaws.route53domains#OperationType", "traits": { "smithy.api#documentation": "

    The operation that you were charged for.

    " } }, + "InvoiceId": { + "target": "com.amazonaws.route53domains#InvoiceId", + "traits": { + "smithy.api#documentation": "

    The ID of the invoice that is associated with the billing record.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

    The name of the domain that the billing record applies to. If the domain name contains characters \n\t\t\tother than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. \n\t\t\tFor more information, see \n\t\t\tDNS Domain Name Format \n\t\t\tin the Amazon Route 53 Developer Guide.

    " + } + }, "Price": { "target": "com.amazonaws.route53domains#Price", "traits": { @@ -129,12 +135,6 @@ "traits": { "smithy.api#documentation": "

    The date that the operation was billed, in Unix format.

    " } - }, - "InvoiceId": { - "target": "com.amazonaws.route53domains#InvoiceId", - "traits": { - "smithy.api#documentation": "

    The ID of the invoice that is associated with the billing record.

    " - } } }, "traits": { @@ -225,18 +225,18 @@ "com.amazonaws.route53domains#CheckDomainAvailabilityRequest": { "type": "structure", "members": { - "IdnLangCode": { - "target": "com.amazonaws.route53domains#LangCode", - "traits": { - "smithy.api#documentation": "

    Reserved for future use.

    " - } - }, "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { "smithy.api#documentation": "

    The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    \n\t\t

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports \n\t\t\tinternationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\tFor more information, see \n\t\t\tFormatting Internationalized Domain Names.\n\t\t

    ", "smithy.api#required": {} } + }, + "IdnLangCode": { + "target": "com.amazonaws.route53domains#LangCode", + "traits": { + "smithy.api#documentation": "

    Reserved for future use.

    " + } } }, "traits": { @@ -281,18 +281,18 @@ "com.amazonaws.route53domains#CheckDomainTransferabilityRequest": { "type": "structure", "members": { - "AuthCode": { - "target": "com.amazonaws.route53domains#DomainAuthCode", - "traits": { - "smithy.api#documentation": "

    If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, \n\t\t\tthe code that you got from the current registrar for the domain.

    " - } - }, "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { "smithy.api#documentation": "

    The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    ", "smithy.api#required": {} } + }, + "AuthCode": { + "target": "com.amazonaws.route53domains#DomainAuthCode", + "traits": { + "smithy.api#documentation": "

    If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, \n\t\t\tthe code that you got from the current registrar for the domain.

    " + } } }, "traits": { @@ -326,40 +326,46 @@ "com.amazonaws.route53domains#ContactDetail": { "type": "structure", "members": { - "City": { - "target": "com.amazonaws.route53domains#City", + "Fax": { + "target": "com.amazonaws.route53domains#ContactNumber", "traits": { - "smithy.api#documentation": "

    The city of the contact's address.

    " + "smithy.api#documentation": "

    Fax number of the contact.

    \n\t\t

    Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".

    " } }, - "AddressLine1": { - "target": "com.amazonaws.route53domains#AddressLine", + "FirstName": { + "target": "com.amazonaws.route53domains#ContactName", "traits": { - "smithy.api#documentation": "

    First line of the contact's address.

    " + "smithy.api#documentation": "

    First name of contact.

    " } }, - "PhoneNumber": { - "target": "com.amazonaws.route53domains#ContactNumber", + "OrganizationName": { + "target": "com.amazonaws.route53domains#ContactName", "traits": { - "smithy.api#documentation": "

    The phone number of the contact.

    \n\t\t

    Constraints: Phone number must be specified in the format \"+[country\tdialing code].[number including any area code>]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".

    " + "smithy.api#documentation": "

    Name of the organization for contact types other than PERSON.

    " } }, - "AddressLine2": { + "Email": { + "target": "com.amazonaws.route53domains#Email", + "traits": { + "smithy.api#documentation": "

    Email address of the contact.

    " + } + }, + "AddressLine1": { "target": "com.amazonaws.route53domains#AddressLine", "traits": { - "smithy.api#documentation": "

    Second line of contact's address, if any.

    " + "smithy.api#documentation": "

    First line of the contact's address.

    " } }, - "ZipCode": { - "target": "com.amazonaws.route53domains#ZipCode", + "AddressLine2": { + "target": "com.amazonaws.route53domains#AddressLine", "traits": { - "smithy.api#documentation": "

    The zip or postal code of the contact's address.

    " + "smithy.api#documentation": "

    Second line of contact's address, if any.

    " } }, - "LastName": { - "target": "com.amazonaws.route53domains#ContactName", + "CountryCode": { + "target": "com.amazonaws.route53domains#CountryCode", "traits": { - "smithy.api#documentation": "

    Last name of contact.

    " + "smithy.api#documentation": "

    Code for the country of the contact's address.

    " } }, "State": { @@ -368,16 +374,16 @@ "smithy.api#documentation": "

    The state or province of the contact's city.

    " } }, - "CountryCode": { - "target": "com.amazonaws.route53domains#CountryCode", + "PhoneNumber": { + "target": "com.amazonaws.route53domains#ContactNumber", "traits": { - "smithy.api#documentation": "

    Code for the country of the contact's address.

    " + "smithy.api#documentation": "

    The phone number of the contact.

    \n\t\t

    Constraints: Phone number must be specified in the format \"+[country\tdialing code].[number including any area code>]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".

    " } }, - "OrganizationName": { + "LastName": { "target": "com.amazonaws.route53domains#ContactName", "traits": { - "smithy.api#documentation": "

    Name of the organization for contact types other than PERSON.

    " + "smithy.api#documentation": "

    Last name of contact.

    " } }, "ExtraParams": { @@ -386,22 +392,16 @@ "smithy.api#documentation": "

    A list of name-value pairs for parameters required by certain top-level domains.

    " } }, - "Fax": { - "target": "com.amazonaws.route53domains#ContactNumber", - "traits": { - "smithy.api#documentation": "

    Fax number of the contact.

    \n\t\t

    Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".

    " - } - }, - "FirstName": { - "target": "com.amazonaws.route53domains#ContactName", + "City": { + "target": "com.amazonaws.route53domains#City", "traits": { - "smithy.api#documentation": "

    First name of contact.

    " + "smithy.api#documentation": "

    The city of the contact's address.

    " } }, - "Email": { - "target": "com.amazonaws.route53domains#Email", + "ZipCode": { + "target": "com.amazonaws.route53domains#ZipCode", "traits": { - "smithy.api#documentation": "

    Email address of the contact.

    " + "smithy.api#documentation": "

    The zip or postal code of the contact's address.

    " } }, "ContactType": { @@ -1410,6 +1410,12 @@ "smithy.api#documentation": "

    Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).

    " } }, + "AutoRenew": { + "target": "com.amazonaws.route53domains#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the domain is automatically renewed upon expiration.

    " + } + }, "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { @@ -1417,12 +1423,6 @@ "smithy.api#required": {} } }, - "AutoRenew": { - "target": "com.amazonaws.route53domains#Boolean", - "traits": { - "smithy.api#documentation": "

    Indicates whether the domain is automatically renewed upon expiration.

    " - } - }, "TransferLock": { "target": "com.amazonaws.route53domains#Boolean", "traits": { @@ -1839,36 +1839,28 @@ "com.amazonaws.route53domains#GetDomainDetailResponse": { "type": "structure", "members": { - "Reseller": { - "target": "com.amazonaws.route53domains#Reseller", - "traits": { - "smithy.api#documentation": "

    Reseller of the domain. Domains registered or transferred using Route 53 domains will have \"Amazon\" \n\t\t\tas the reseller.

    " - } - }, - "UpdatedDate": { - "target": "com.amazonaws.route53domains#Timestamp", + "AutoRenew": { + "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

    The last updated date of the domain as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

    " + "smithy.api#documentation": "

    Specifies whether the domain registration is set to renew automatically.

    " } }, - "RegistrantContact": { - "target": "com.amazonaws.route53domains#ContactDetail", + "AdminPrivacy": { + "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

    Provides details about the domain registrant.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

    " } }, - "TechPrivacy": { - "target": "com.amazonaws.route53domains#Boolean", + "CreationDate": { + "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

    " + "smithy.api#documentation": "

    The date when the domain was created as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

    " } }, - "TechContact": { - "target": "com.amazonaws.route53domains#ContactDetail", + "AbuseContactEmail": { + "target": "com.amazonaws.route53domains#Email", "traits": { - "smithy.api#documentation": "

    Provides details about the domain technical contact.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Email address to contact to report incorrect contact information for a domain, to report that the domain \n\t\t\tis being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

    " } }, "DomainName": { @@ -1878,22 +1870,16 @@ "smithy.api#required": {} } }, - "AdminPrivacy": { - "target": "com.amazonaws.route53domains#Boolean", - "traits": { - "smithy.api#documentation": "

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

    " - } - }, - "AbuseContactEmail": { - "target": "com.amazonaws.route53domains#Email", + "UpdatedDate": { + "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

    Email address to contact to report incorrect contact information for a domain, to report that the domain \n\t\t\tis being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

    " + "smithy.api#documentation": "

    The last updated date of the domain as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

    " } }, - "CreationDate": { - "target": "com.amazonaws.route53domains#Timestamp", + "Reseller": { + "target": "com.amazonaws.route53domains#Reseller", "traits": { - "smithy.api#documentation": "

    The date when the domain was created as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

    " + "smithy.api#documentation": "

    Reseller of the domain. Domains registered or transferred using Route 53 domains will have \"Amazon\" \n\t\t\tas the reseller.

    " } }, "DnsSec": { @@ -1902,22 +1888,23 @@ "smithy.api#documentation": "

    Reserved for future use.

    " } }, - "AutoRenew": { - "target": "com.amazonaws.route53domains#Boolean", + "RegistrantContact": { + "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

    Specifies whether the domain registration is set to renew automatically.

    " + "smithy.api#documentation": "

    Provides details about the domain registrant.

    ", + "smithy.api#required": {} } }, - "RegistrarUrl": { - "target": "com.amazonaws.route53domains#RegistrarUrl", + "TechPrivacy": { + "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

    Web address of the registrar.

    " + "smithy.api#documentation": "

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

    " } }, - "WhoIsServer": { - "target": "com.amazonaws.route53domains#RegistrarWhoIsServer", + "RegistrantPrivacy": { + "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

    The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

    " + "smithy.api#documentation": "

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

    " } }, "Nameservers": { @@ -1927,22 +1914,29 @@ "smithy.api#required": {} } }, - "RegistrantPrivacy": { - "target": "com.amazonaws.route53domains#Boolean", + "TechContact": { + "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

    " + "smithy.api#documentation": "

    Provides details about the domain technical contact.

    ", + "smithy.api#required": {} } }, - "StatusList": { - "target": "com.amazonaws.route53domains#DomainStatusList", + "WhoIsServer": { + "target": "com.amazonaws.route53domains#RegistrarWhoIsServer", "traits": { - "smithy.api#documentation": "

    An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

    \n\t\t

    ICANN, the organization that maintains a central database of domain names, has developed a set of domain name \n\t\t\tstatus codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, \n\t\t\ttransferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars \n\t\t\tuse this same set of status codes.

    \n\t\t

    For a current list of domain name status codes and an explanation of what each code means, go to the\n\t\t\tICANN website and search for epp status codes.\n\t\t\t(Search on the ICANN website; web searches sometimes return an old version of the document.)

    " + "smithy.api#documentation": "

    The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

    " } }, - "RegistryDomainId": { - "target": "com.amazonaws.route53domains#RegistryDomainId", + "RegistrarUrl": { + "target": "com.amazonaws.route53domains#RegistrarUrl", "traits": { - "smithy.api#documentation": "

    Reserved for future use.

    " + "smithy.api#documentation": "

    Web address of the registrar.

    " + } + }, + "ExpirationDate": { + "target": "com.amazonaws.route53domains#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date when the registration for the domain is set to expire. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

    " } }, "AbuseContactPhone": { @@ -1951,17 +1945,16 @@ "smithy.api#documentation": "

    Phone number for reporting abuse.

    " } }, - "AdminContact": { - "target": "com.amazonaws.route53domains#ContactDetail", + "StatusList": { + "target": "com.amazonaws.route53domains#DomainStatusList", "traits": { - "smithy.api#documentation": "

    Provides details about the domain administrative contact.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

    \n\t\t

    ICANN, the organization that maintains a central database of domain names, has developed a set of domain name \n\t\t\tstatus codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, \n\t\t\ttransferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars \n\t\t\tuse this same set of status codes.

    \n\t\t

    For a current list of domain name status codes and an explanation of what each code means, go to the\n\t\t\tICANN website and search for epp status codes.\n\t\t\t(Search on the ICANN website; web searches sometimes return an old version of the document.)

    " } }, - "ExpirationDate": { - "target": "com.amazonaws.route53domains#Timestamp", + "RegistryDomainId": { + "target": "com.amazonaws.route53domains#RegistryDomainId", "traits": { - "smithy.api#documentation": "

    The date when the registration for the domain is set to expire. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

    " + "smithy.api#documentation": "

    Reserved for future use.

    " } }, "RegistrarName": { @@ -1969,6 +1962,13 @@ "traits": { "smithy.api#documentation": "

    Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by \n\t\t\tAmazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by \n\t\t\tGandi is \"GANDI SAS\".

    " } + }, + "AdminContact": { + "target": "com.amazonaws.route53domains#ContactDetail", + "traits": { + "smithy.api#documentation": "

    Provides details about the domain administrative contact.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -1998,6 +1998,13 @@ "com.amazonaws.route53domains#GetDomainSuggestionsRequest": { "type": "structure", "members": { + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

    A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, \n\t\t\tmust be a TLD that Route 53 supports. For a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    \n\t\t

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use \n\t\t\tsupports internationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\t

    ", + "smithy.api#required": {} + } + }, "SuggestionCount": { "target": "com.amazonaws.route53domains#Integer", "traits": { @@ -2011,13 +2018,6 @@ "smithy.api#documentation": "

    If OnlyAvailable is true, Route 53 returns only domain names that are available. \n\t\t\tIf OnlyAvailable is false, Route 53 returns domain names without checking whether they're \n\t\t\tavailable to be registered. To determine whether the domain is available, you can call checkDomainAvailability \n\t\t\tfor each suggestion.

    ", "smithy.api#required": {} } - }, - "DomainName": { - "target": "com.amazonaws.route53domains#DomainName", - "traits": { - "smithy.api#documentation": "

    A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, \n\t\t\tmust be a TLD that Route 53 supports. For a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    \n\t\t

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use \n\t\t\tsupports internationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\t

    ", - "smithy.api#required": {} - } } } }, @@ -2067,22 +2067,16 @@ "com.amazonaws.route53domains#GetOperationDetailResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.route53domains#ErrorMessage", - "traits": { - "smithy.api#documentation": "

    Detailed information on the status including possible errors.

    " - } - }, "Type": { "target": "com.amazonaws.route53domains#OperationType", "traits": { "smithy.api#documentation": "

    The type of operation that was requested.

    " } }, - "DomainName": { - "target": "com.amazonaws.route53domains#DomainName", + "Status": { + "target": "com.amazonaws.route53domains#OperationStatus", "traits": { - "smithy.api#documentation": "

    The name of a domain.

    " + "smithy.api#documentation": "

    The current status of the requested operation in the system.

    " } }, "SubmittedDate": { @@ -2097,10 +2091,16 @@ "smithy.api#documentation": "

    The identifier for the operation.

    " } }, - "Status": { - "target": "com.amazonaws.route53domains#OperationStatus", + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

    The current status of the requested operation in the system.

    " + "smithy.api#documentation": "

    The name of a domain.

    " + } + }, + "Message": { + "target": "com.amazonaws.route53domains#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    Detailed information on the status including possible errors.

    " } } }, @@ -2260,17 +2260,17 @@ "smithy.api#documentation": "

    For an initial request for a list of operations, omit this element. If the number of operations that are\n\t\t\tnot yet complete is greater than the value that you specified for MaxItems, you can use Marker\n\t\t\tto return additional operations. Get the value of NextPageMarker from the previous response,\n\t\t\tand submit another request that includes the value of NextPageMarker in the Marker element.

    " } }, - "MaxItems": { - "target": "com.amazonaws.route53domains#PageMaxItems", - "traits": { - "smithy.api#documentation": "

    Number of domains to be returned.

    \n\t\t

    Default: 20

    " - } - }, "SubmittedSince": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { "smithy.api#documentation": "

    An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. \n\t\t\tSpecify the date and time in Unix time format and Coordinated Universal time (UTC).

    " } + }, + "MaxItems": { + "target": "com.amazonaws.route53domains#PageMaxItems", + "traits": { + "smithy.api#documentation": "

    Number of domains to be returned.

    \n\t\t

    Default: 20

    " + } } }, "traits": { @@ -2435,17 +2435,17 @@ "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.route53domains#OperationStatus", + "Type": { + "target": "com.amazonaws.route53domains#OperationType", "traits": { - "smithy.api#documentation": "

    The current status of the requested operation in the system.

    ", + "smithy.api#documentation": "

    Type of the action requested.

    ", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.route53domains#OperationType", + "Status": { + "target": "com.amazonaws.route53domains#OperationStatus", "traits": { - "smithy.api#documentation": "

    Type of the action requested.

    ", + "smithy.api#documentation": "

    The current status of the requested operation in the system.

    ", "smithy.api#required": {} } }, @@ -2628,10 +2628,11 @@ "smithy.api#required": {} } }, - "PrivacyProtectTechContact": { - "target": "com.amazonaws.route53domains#Boolean", + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

    \n\t\t

    Default: true\n

    " + "smithy.api#documentation": "

    The domain name that you want to register. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    \n\t\t

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports \n\t\t\tinternationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\tFor more information, see \n\t\t\tFormatting Internationalized Domain Names.\n\t\t

    ", + "smithy.api#required": {} } }, "PrivacyProtectRegistrantContact": { @@ -2640,16 +2641,23 @@ "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (the domain owner).

    \n\t\t

    Default: true\n

    " } }, + "PrivacyProtectAdminContact": { + "target": "com.amazonaws.route53domains#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

    \n\t\t

    Default: true\n

    " + } + }, "AutoRenew": { "target": "com.amazonaws.route53domains#Boolean", "traits": { "smithy.api#documentation": "

    Indicates whether the domain will be automatically renewed (true) or not (false). \n\t\t\tAutorenewal only takes effect after the account is charged.

    \n\t\t

    Default: true\n

    " } }, - "PrivacyProtectAdminContact": { - "target": "com.amazonaws.route53domains#Boolean", + "AdminContact": { + "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

    \n\t\t

    Default: true\n

    " + "smithy.api#documentation": "

    Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.

    ", + "smithy.api#required": {} } }, "IdnLangCode": { @@ -2658,27 +2666,19 @@ "smithy.api#documentation": "

    Reserved for future use.

    " } }, - "RegistrantContact": { - "target": "com.amazonaws.route53domains#ContactDetail", + "PrivacyProtectTechContact": { + "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

    Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

    \n\t\t

    Default: true\n

    " } }, - "AdminContact": { + "RegistrantContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { "smithy.api#documentation": "

    Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.

    ", "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.route53domains#DomainName", - "traits": { - "smithy.api#documentation": "

    The domain name that you want to register. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    \n\t\t

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports \n\t\t\tinternationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\tFor more information, see \n\t\t\tFormatting Internationalized Domain Names.\n\t\t

    ", - "smithy.api#required": {} - } - }, "TechContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { @@ -2806,18 +2806,18 @@ "smithy.api#required": {} } }, + "DurationInYears": { + "target": "com.amazonaws.route53domains#DurationInYears", + "traits": { + "smithy.api#documentation": "

    The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. \n\t\t\tFor the range of valid values for your domain, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    Default: 1

    " + } + }, "CurrentExpiryYear": { "target": "com.amazonaws.route53domains#CurrentExpiryYear", "traits": { "smithy.api#documentation": "

    The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.

    ", "smithy.api#required": {} } - }, - "DurationInYears": { - "target": "com.amazonaws.route53domains#DurationInYears", - "traits": { - "smithy.api#documentation": "

    The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. \n\t\t\tFor the range of valid values for your domain, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    Default: 1

    " - } } }, "traits": { @@ -2876,12 +2876,6 @@ "com.amazonaws.route53domains#ResendContactReachabilityEmailResponse": { "type": "structure", "members": { - "isAlreadyVerified": { - "target": "com.amazonaws.route53domains#Boolean", - "traits": { - "smithy.api#documentation": "

    \n True if the email address for the registrant contact has already been verified, and false otherwise. \n\t\t\tIf the email address has already been verified, we don't send another confirmation email.

    " - } - }, "emailAddress": { "target": "com.amazonaws.route53domains#Email", "traits": { @@ -2893,6 +2887,12 @@ "traits": { "smithy.api#documentation": "

    The domain name for which you requested a confirmation email.

    " } + }, + "isAlreadyVerified": { + "target": "com.amazonaws.route53domains#Boolean", + "traits": { + "smithy.api#documentation": "

    \n True if the email address for the registrant contact has already been verified, and false otherwise. \n\t\t\tIf the email address has already been verified, we don't send another confirmation email.

    " + } } } }, @@ -3040,7 +3040,7 @@ "sdkId": "Route 53 Domains", "arnNamespace": "route53domains", "cloudFormationName": "Route53Domains", - "cloudTrailEventSource": "v20140515.route53domains.amazonaws.com" + "cloudTrailEventSource": "route53domains.amazonaws.com" }, "aws.auth#sigv4": { "name": "route53domains" @@ -3164,10 +3164,17 @@ "smithy.api#required": {} } }, - "PrivacyProtectTechContact": { - "target": "com.amazonaws.route53domains#Boolean", + "AuthCode": { + "target": "com.amazonaws.route53domains#DomainAuthCode", "traits": { - "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

    \n\t\t

    Default: true\n

    " + "smithy.api#documentation": "

    The authorization code for the domain. You get this value from the current registrar.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

    The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    ", + "smithy.api#required": {} } }, "AutoRenew": { @@ -3176,10 +3183,11 @@ "smithy.api#documentation": "

    Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect \n\t\t\tafter the account is charged.

    \n\t\t

    Default: true

    " } }, - "Nameservers": { - "target": "com.amazonaws.route53domains#NameserverList", + "AdminContact": { + "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

    Contains details for the host and glue IP addresses.

    " + "smithy.api#documentation": "

    Provides detailed contact information.

    ", + "smithy.api#required": {} } }, "PrivacyProtectRegistrantContact": { @@ -3188,32 +3196,31 @@ "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

    \n\t\t

    Default: true\n

    " } }, - "AuthCode": { - "target": "com.amazonaws.route53domains#DomainAuthCode", - "traits": { - "smithy.api#documentation": "

    The authorization code for the domain. You get this value from the current registrar.

    " - } - }, "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

    \n\t\t

    Default: true\n

    " } }, + "Nameservers": { + "target": "com.amazonaws.route53domains#NameserverList", + "traits": { + "smithy.api#documentation": "

    Contains details for the host and glue IP addresses.

    " + } + }, "IdnLangCode": { "target": "com.amazonaws.route53domains#LangCode", "traits": { "smithy.api#documentation": "

    Reserved for future use.

    " } }, - "DomainName": { - "target": "com.amazonaws.route53domains#DomainName", + "PrivacyProtectTechContact": { + "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

    The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t

    The domain name can contain only the following characters:

    \n\t\t
      \n
    • \n

      Letters a through z. Domain names are not case sensitive.

      \n
      • \n
    • \n

      Numbers 0 through 9.

      \n
      • \n
    • \n

      Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

      \n
      • \n
    • \n

      Period (.) to separate the labels in the name, such as the . in example.com.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

    \n\t\t

    Default: true\n

    " } }, - "AdminContact": { + "TechContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { "smithy.api#documentation": "

    Provides detailed contact information.

    ", @@ -3226,13 +3233,6 @@ "smithy.api#documentation": "

    Provides detailed contact information.

    ", "smithy.api#required": {} } - }, - "TechContact": { - "target": "com.amazonaws.route53domains#ContactDetail", - "traits": { - "smithy.api#documentation": "

    Provides detailed contact information.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -3422,6 +3422,12 @@ "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

    " } }, + "RegistrantPrivacy": { + "target": "com.amazonaws.route53domains#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

    " + } + }, "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { @@ -3434,12 +3440,6 @@ "traits": { "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

    " } - }, - "RegistrantPrivacy": { - "target": "com.amazonaws.route53domains#Boolean", - "traits": { - "smithy.api#documentation": "

    Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

    " - } } }, "traits": { @@ -3470,12 +3470,6 @@ "smithy.api#documentation": "

    Provides detailed contact information.

    " } }, - "RegistrantContact": { - "target": "com.amazonaws.route53domains#ContactDetail", - "traits": { - "smithy.api#documentation": "

    Provides detailed contact information.

    " - } - }, "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { @@ -3483,6 +3477,12 @@ "smithy.api#required": {} } }, + "RegistrantContact": { + "target": "com.amazonaws.route53domains#ContactDetail", + "traits": { + "smithy.api#documentation": "

    Provides detailed contact information.

    " + } + }, "TechContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { @@ -3682,17 +3682,17 @@ "com.amazonaws.route53domains#ViewBillingResponse": { "type": "structure", "members": { - "BillingRecords": { - "target": "com.amazonaws.route53domains#BillingRecords", - "traits": { - "smithy.api#documentation": "

    A summary of billing records.

    " - } - }, "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { "smithy.api#documentation": "

    If there are more billing records than you specified for MaxItems in the request, submit another \n\t\t\trequest and include the value of NextPageMarker in the value of Marker.

    " } + }, + "BillingRecords": { + "target": "com.amazonaws.route53domains#BillingRecords", + "traits": { + "smithy.api#documentation": "

    A summary of billing records.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json b/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json index bb83cc23f59f..efb1daea3dbd 100644 --- a/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json +++ b/codegen/sdk-codegen/aws-models/route-53.2013-04-01.json @@ -213,7 +213,7 @@ "sdkId": "Route 53", "arnNamespace": "route53", "cloudFormationName": "Route53", - "cloudTrailEventSource": "v20130401.dns.webservices.amazon.com" + "cloudTrailEventSource": "route53.amazonaws.com" }, "aws.auth#sigv4": { "name": "route53" @@ -273,17 +273,17 @@ "com.amazonaws.route53#AlarmIdentifier": { "type": "structure", "members": { - "Region": { - "target": "com.amazonaws.route53#CloudWatchRegion", + "Name": { + "target": "com.amazonaws.route53#AlarmName", "traits": { - "smithy.api#documentation": "

    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, \n\t\t\tthe region that the alarm was created in.

    \n\t\t

    For the current list of CloudWatch regions, see Amazon CloudWatch in \n\t\t\tthe AWS Service Endpoints chapter of the Amazon Web Services General Reference.

    ", + "smithy.api#documentation": "

    The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

    \n\t\t \n

    Route 53 supports CloudWatch alarms with the following features:

    \n\t\t\t
      \n
    • \n

      Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see \n\t\t\t\t\tHigh-Resolution Metrics \n\t\t\t\t\tin the Amazon CloudWatch User Guide.

      \n
      • \n
    • \n

      Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.

      \n
      • \n
    \n\t\t     ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.route53#AlarmName", + "Region": { + "target": "com.amazonaws.route53#CloudWatchRegion", "traits": { - "smithy.api#documentation": "

    The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

    \n\t\t \n

    Route 53 supports CloudWatch alarms with the following features:

    \n\t\t\t
      \n
    • \n

      Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see \n\t\t\t\t\tHigh-Resolution Metrics \n\t\t\t\t\tin the Amazon CloudWatch User Guide.

      \n
      • \n
    • \n

      Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.

      \n
      • \n
    \n\t\t     ", + "smithy.api#documentation": "

    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, \n\t\t\tthe region that the alarm was created in.

    \n\t\t

    For the current list of CloudWatch regions, see Amazon CloudWatch in \n\t\t\tthe AWS Service Endpoints chapter of the Amazon Web Services General Reference.

    ", "smithy.api#required": {} } } @@ -371,7 +371,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Associates an Amazon VPC with a private hosted zone.

    \n\t\t\n\t\t \n

    To perform the association, the VPC and the private hosted zone must already exist. \n\t\t\tAlso, you can't convert a public hosted zone into a private hosted zone.

    \n\t\t     \n\t\t\n\t\t

    If you want to associate a VPC that was created by one AWS account with a private hosted zone that was created \n\t\t\tby a different account, do one of the following:

    \n\t\t
      \n
    • \n

      Use the AWS account that created the private hosted zone to submit a \n\t\t\t\tCreateVPCAssociationAuthorization\n\t\t\t\trequest. Then use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

      \n
      • \n
    • \n

      If a subnet in the VPC was shared with another account, you can use the account that the subnet was shared with \n\t\t\t\tto submit an AssociateVPCWithHostedZone request. For more information about sharing subnets, see \n\t\t\t\tWorking with Shared VPCs.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Associates an Amazon VPC with a private hosted zone.

    \n\t\t \n

    To perform the association, the VPC and the private hosted zone must already exist. \n\t\t\tYou can't convert a public hosted zone into a private hosted zone.

    \n     \n\t\t \n

    If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created \n\t\t\tby using a different account, the AWS account that created the private hosted zone must first submit a \n\t\t\tCreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an \n\t\t\tAssociateVPCWithHostedZone request.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/associatevpc", @@ -390,18 +390,18 @@ "smithy.api#required": {} } }, - "Comment": { - "target": "com.amazonaws.route53#AssociateVPCComment", - "traits": { - "smithy.api#documentation": "

    \n Optional: A comment about the association request.

    " - } - }, "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { "smithy.api#documentation": "

    A complex type that contains information about the VPC that you want to associate with a private hosted zone.

    ", "smithy.api#required": {} } + }, + "Comment": { + "target": "com.amazonaws.route53#AssociateVPCComment", + "traits": { + "smithy.api#documentation": "

    \n Optional: A comment about the association request.

    " + } } }, "traits": { @@ -464,18 +464,18 @@ "com.amazonaws.route53#ChangeBatch": { "type": "structure", "members": { + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

    \n Optional: Any comments you want to include about a change batch\n\t\t\trequest.

    " + } + }, "Changes": { "target": "com.amazonaws.route53#Changes", "traits": { "smithy.api#documentation": "

    Information about the changes to make to the record sets.

    ", "smithy.api#required": {} } - }, - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

    \n Optional: Any comments you want to include about a change batch\n\t\t\trequest.

    " - } } }, "traits": { @@ -492,12 +492,6 @@ "smithy.api#required": {} } }, - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

    A complex type that describes change information about changes made to your hosted\n\t\t\tzone.

    \n\t\t

    This element contains an ID that you use when performing a \n\t\t\tGetChange \n\t\t\taction to get detailed information about the change.

    " - } - }, "SubmittedAt": { "target": "com.amazonaws.route53#TimeStamp", "traits": { @@ -505,6 +499,12 @@ "smithy.api#required": {} } }, + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

    A complex type that describes change information about changes made to your hosted\n\t\t\tzone.

    \n\t\t

    This element contains an ID that you use when performing a \n\t\t\tGetChange \n\t\t\taction to get detailed information about the change.

    " + } + }, "Status": { "target": "com.amazonaws.route53#ChangeStatus", "traits": { @@ -717,20 +717,6 @@ "com.amazonaws.route53#CloudWatchAlarmConfiguration": { "type": "structure", "members": { - "Threshold": { - "target": "com.amazonaws.route53#Threshold", - "traits": { - "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

    ", - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.route53#Namespace", - "traits": { - "smithy.api#documentation": "

    The namespace of the metric that the alarm is associated with. For more information, see \n\t\t\tAmazon CloudWatch Namespaces, Dimensions, and Metrics Reference \n\t\t\tin the Amazon CloudWatch User Guide.

    ", - "smithy.api#required": {} - } - }, "Period": { "target": "com.amazonaws.route53#Period", "traits": { @@ -744,10 +730,17 @@ "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. \n\t\t\tFor information, see \n\t\t\tAmazon CloudWatch Namespaces, Dimensions, and Metrics Reference \n\t\t\tin the Amazon CloudWatch User Guide.

    " } }, - "EvaluationPeriods": { - "target": "com.amazonaws.route53#EvaluationPeriods", + "Namespace": { + "target": "com.amazonaws.route53#Namespace", "traits": { - "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

    ", + "smithy.api#documentation": "

    The namespace of the metric that the alarm is associated with. For more information, see \n\t\t\tAmazon CloudWatch Namespaces, Dimensions, and Metrics Reference \n\t\t\tin the Amazon CloudWatch User Guide.

    ", + "smithy.api#required": {} + } + }, + "Threshold": { + "target": "com.amazonaws.route53#Threshold", + "traits": { + "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

    ", "smithy.api#required": {} } }, @@ -758,6 +751,13 @@ "smithy.api#required": {} } }, + "MetricName": { + "target": "com.amazonaws.route53#MetricName", + "traits": { + "smithy.api#documentation": "

    The name of the CloudWatch metric that the alarm is associated with.

    ", + "smithy.api#required": {} + } + }, "Statistic": { "target": "com.amazonaws.route53#Statistic", "traits": { @@ -765,10 +765,10 @@ "smithy.api#required": {} } }, - "MetricName": { - "target": "com.amazonaws.route53#MetricName", + "EvaluationPeriods": { + "target": "com.amazonaws.route53#EvaluationPeriods", "traits": { - "smithy.api#documentation": "

    The name of the CloudWatch metric that the alarm is associated with.

    ", + "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

    ", "smithy.api#required": {} } } @@ -1057,13 +1057,6 @@ "com.amazonaws.route53#CreateHostedZoneRequest": { "type": "structure", "members": { - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without \n\t\t\tthe risk of executing the operation twice. You must use a unique CallerReference string every time you submit a \n\t\t\tCreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

    ", - "smithy.api#required": {} - } - }, "HostedZoneConfig": { "target": "com.amazonaws.route53#HostedZoneConfig", "traits": { @@ -1077,16 +1070,23 @@ "smithy.api#required": {} } }, + "DelegationSetId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

    If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set \n\t\t\twhen you created it. For more information about reusable delegation sets, see \n\t\t\tCreateReusableDelegationSet.

    " + } + }, "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { "smithy.api#documentation": "

    (Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

    \n\t\t

    You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, \n\t\t\tuse AssociateVPCWithHostedZone\n\t\t\tafter you create a hosted zone.

    " } }, - "DelegationSetId": { - "target": "com.amazonaws.route53#ResourceId", + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", "traits": { - "smithy.api#documentation": "

    If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set \n\t\t\twhen you created it. For more information about reusable delegation sets, see \n\t\t\tCreateReusableDelegationSet.

    " + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without \n\t\t\tthe risk of executing the operation twice. You must use a unique CallerReference string every time you submit a \n\t\t\tCreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

    ", + "smithy.api#required": {} } } }, @@ -1104,19 +1104,6 @@ "smithy.api#required": {} } }, - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the CreateHostedZone request.

    ", - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

    A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

    " - } - }, "Location": { "target": "com.amazonaws.route53#ResourceURI", "traits": { @@ -1125,12 +1112,25 @@ "smithy.api#required": {} } }, + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

    A complex type that contains information about the CreateHostedZone request.

    ", + "smithy.api#required": {} + } + }, "DelegationSet": { "target": "com.amazonaws.route53#DelegationSet", "traits": { "smithy.api#documentation": "

    A complex type that describes the name servers for this hosted zone.

    ", "smithy.api#required": {} } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

    A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

    " + } } }, "traits": { @@ -1177,17 +1177,17 @@ "com.amazonaws.route53#CreateQueryLoggingConfigRequest": { "type": "structure", "members": { - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format \n\t\t\tof the ARN:

    \n\t\t\n\t\t

    arn:aws:logs:region:account-id:log-group:log_group_name\n

    \n\t\t\n\t\t

    To get the ARN for a log group, you can use the CloudWatch console, the \n\t\t\tDescribeLogGroups API action, \n\t\t\tthe describe-log-groups command, \n\t\t\tor the applicable command in one of the AWS SDKs.

    ", + "smithy.api#documentation": "

    The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

    ", "smithy.api#required": {} } }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format \n\t\t\tof the ARN:

    \n\t\t\n\t\t

    arn:aws:logs:region:account-id:log-group:log_group_name\n

    \n\t\t\n\t\t

    To get the ARN for a log group, you can use the CloudWatch console, the \n\t\t\tDescribeLogGroups API action, \n\t\t\tthe describe-log-groups command, \n\t\t\tor the applicable command in one of the AWS SDKs.

    ", "smithy.api#required": {} } } @@ -1256,18 +1256,18 @@ "com.amazonaws.route53#CreateReusableDelegationSetRequest": { "type": "structure", "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

    If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.

    " - } - }, "CallerReference": { "target": "com.amazonaws.route53#Nonce", "traits": { "smithy.api#documentation": "

    A unique string that identifies the request, and that allows you to retry failed\n\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time you\n\t\t\tsubmit a CreateReusableDelegationSet request. CallerReference can be\n\t\t\tany unique string, for example a date/time stamp.

    ", "smithy.api#required": {} } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

    If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.

    " + } } } }, @@ -1359,13 +1359,6 @@ "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

    The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using \n\t\t\tthe resource record sets that Route 53 creates for this traffic policy instance.

    ", - "smithy.api#required": {} - } - }, "TTL": { "target": "com.amazonaws.route53#TTL", "traits": { @@ -1373,10 +1366,10 @@ "smithy.api#required": {} } }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

    ", + "smithy.api#documentation": "

    The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.

    ", "smithy.api#required": {} } }, @@ -1387,10 +1380,17 @@ "smithy.api#required": {} } }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.

    ", + "smithy.api#documentation": "

    The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

    ", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

    The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using \n\t\t\tthe resource record sets that Route 53 creates for this traffic policy instance.

    ", "smithy.api#required": {} } } @@ -1402,13 +1402,6 @@ "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { "type": "structure", "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "

    A complex type that contains settings for the new traffic policy instance.

    ", - "smithy.api#required": {} - } - }, "Location": { "target": "com.amazonaws.route53#ResourceURI", "traits": { @@ -1416,6 +1409,13 @@ "smithy.api#httpHeader": "Location", "smithy.api#required": {} } + }, + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "

    A complex type that contains settings for the new traffic policy instance.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -1432,18 +1432,18 @@ "smithy.api#required": {} } }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

    (Optional) Any comments that you want to include about the traffic policy.

    " + } + }, "Document": { "target": "com.amazonaws.route53#TrafficPolicyDocument", "traits": { "smithy.api#documentation": "

    The definition of this traffic policy in JSON format. For more information, see \n\t\t\tTraffic Policy Document Format.

    ", "smithy.api#required": {} } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

    (Optional) Any comments that you want to include about the traffic policy.

    " - } } }, "traits": { @@ -1619,17 +1619,17 @@ "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { "type": "structure", "members": { - "VPC": { - "target": "com.amazonaws.route53#VPC", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    The VPC that you authorized associating with a hosted zone.

    ", + "smithy.api#documentation": "

    The ID of the hosted zone that you authorized associating a VPC with.

    ", "smithy.api#required": {} } }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "VPC": { + "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that you authorized associating a VPC with.

    ", + "smithy.api#documentation": "

    The VPC that you authorized associating with a hosted zone.

    ", "smithy.api#required": {} } } @@ -1660,17 +1660,17 @@ "smithy.api#required": {} } }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

    The value that you specified for CallerReference when you created the reusable delegation set.

    " - } - }, "Id": { "target": "com.amazonaws.route53#ResourceId", "traits": { "smithy.api#documentation": "

    The ID that Amazon Route 53 assigns to a reusable delegation set.

    " } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

    The value that you specified for CallerReference when you created the reusable delegation set.

    " + } } }, "traits": { @@ -2013,7 +2013,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a traffic policy.

    ", + "smithy.api#documentation": "

    Deletes a traffic policy.

    \n\t\t

    When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes \n\t\t\tthe traffic policy. Note the following:

    \n\t\t
      \n
    • \n

      Deleted traffic policies aren't listed if you run ListTrafficPolicies.

      \n
      • \n
    • \n

      \tThere's no way to get a list of deleted policies.

      \n
      • \n
    • \n

      If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running \n\t\t\t\tGetTrafficPolicy.

      \n
      • \n
    ", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", @@ -2140,13 +2140,6 @@ "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest": { "type": "structure", "members": { - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

    When removing authorization to associate a VPC that was created by one AWS account with a hosted zone \n\t\t\tthat was created with a different AWS account, a complex type that includes the ID and region of the VPC.

    ", - "smithy.api#required": {} - } - }, "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { @@ -2154,6 +2147,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

    When removing authorization to associate a VPC that was created by one AWS account with a hosted zone \n\t\t\tthat was created with a different AWS account, a complex type that includes the ID and region of the VPC.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -2170,17 +2170,17 @@ "com.amazonaws.route53#Dimension": { "type": "structure", "members": { - "Name": { + "Value": { "target": "com.amazonaws.route53#DimensionField", "traits": { - "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the name of one dimension.

    ", + "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the value of one dimension.

    ", "smithy.api#required": {} } }, - "Value": { + "Name": { "target": "com.amazonaws.route53#DimensionField", "traits": { - "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the value of one dimension.

    ", + "smithy.api#documentation": "

    For the metric that the CloudWatch alarm is associated with, the name of one dimension.

    ", "smithy.api#required": {} } } @@ -2259,6 +2259,14 @@ "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest": { "type": "structure", "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the private hosted zone that you want to disassociate a VPC from.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Comment": { "target": "com.amazonaws.route53#DisassociateVPCComment", "traits": { @@ -2271,14 +2279,6 @@ "smithy.api#documentation": "

    A complex type that contains information about the VPC that you're disassociating\n\t\t\tfrom the specified hosted zone.

    ", "smithy.api#required": {} } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the private hosted zone that you want to disassociate a VPC from.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -2411,28 +2411,22 @@ "com.amazonaws.route53#GeoLocationDetails": { "type": "structure", "members": { - "CountryName": { - "target": "com.amazonaws.route53#GeoLocationCountryName", - "traits": { - "smithy.api#documentation": "

    The name of the country.

    " - } - }, "ContinentName": { "target": "com.amazonaws.route53#GeoLocationContinentName", "traits": { "smithy.api#documentation": "

    The full name of the continent.

    " } }, - "SubdivisionName": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionName", + "CountryName": { + "target": "com.amazonaws.route53#GeoLocationCountryName", "traits": { - "smithy.api#documentation": "

    The full name of the subdivision. Route 53 currently supports only states in the United States.

    " + "smithy.api#documentation": "

    The name of the country.

    " } }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "SubdivisionName": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionName", "traits": { - "smithy.api#documentation": "

    The code for the subdivision. Route 53 currently supports only states in the United States.

    " + "smithy.api#documentation": "

    The full name of the subdivision. Route 53 currently supports only states in the United States.

    " } }, "ContinentCode": { @@ -2446,6 +2440,12 @@ "traits": { "smithy.api#documentation": "

    The two-letter code for the country.

    " } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

    The code for the subdivision. Route 53 currently supports only states in the United States.

    " + } } }, "traits": { @@ -3037,17 +3037,17 @@ "com.amazonaws.route53#GetHostedZoneLimitResponse": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.route53#HostedZoneLimit", + "Count": { + "target": "com.amazonaws.route53#UsageCount", "traits": { - "smithy.api#documentation": "

    The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of \n\t\t\tType in the request, the value of Limit is the maximum number of records that you can create \n\t\t\tin the specified hosted zone.

    ", + "smithy.api#documentation": "

    The current number of entities that you have created of the specified type. For example, if you specified \n\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count \n\t\t\tis the current number of records that you have created in the specified hosted zone.

    ", "smithy.api#required": {} } }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", + "Limit": { + "target": "com.amazonaws.route53#HostedZoneLimit", "traits": { - "smithy.api#documentation": "

    The current number of entities that you have created of the specified type. For example, if you specified \n\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count \n\t\t\tis the current number of records that you have created in the specified hosted zone.

    ", + "smithy.api#documentation": "

    The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of \n\t\t\tType in the request, the value of Limit is the maximum number of records that you can create \n\t\t\tin the specified hosted zone.

    ", "smithy.api#required": {} } } @@ -3075,10 +3075,10 @@ "com.amazonaws.route53#GetHostedZoneResponse": { "type": "structure", "members": { - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", + "VPCs": { + "target": "com.amazonaws.route53#VPCs", "traits": { - "smithy.api#documentation": "

    A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.

    " + "smithy.api#documentation": "

    A complex type that contains information about the VPCs that are associated with the specified hosted zone.

    " } }, "HostedZone": { @@ -3088,10 +3088,10 @@ "smithy.api#required": {} } }, - "VPCs": { - "target": "com.amazonaws.route53#VPCs", + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the VPCs that are associated with the specified hosted zone.

    " + "smithy.api#documentation": "

    A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.

    " } } }, @@ -3296,7 +3296,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets information about a specific traffic policy version.

    ", + "smithy.api#documentation": "

    Gets information about a specific traffic policy version.

    \n\t\t

    For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see \n\t\t\tDeleteTrafficPolicy.\n\t\t

    ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", @@ -3448,19 +3448,13 @@ "smithy.api#required": {} } }, - "HealthCheckConfig": { - "target": "com.amazonaws.route53#HealthCheckConfig", + "HealthCheckVersion": { + "target": "com.amazonaws.route53#HealthCheckVersion", "traits": { - "smithy.api#documentation": "

    A complex type that contains detailed information about one health check.

    ", + "smithy.api#documentation": "

    The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting \n\t\t\tanother change to the health check.

    ", "smithy.api#required": {} } }, - "CloudWatchAlarmConfiguration": { - "target": "com.amazonaws.route53#CloudWatchAlarmConfiguration", - "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

    " - } - }, "CallerReference": { "target": "com.amazonaws.route53#HealthCheckNonce", "traits": { @@ -3468,10 +3462,10 @@ "smithy.api#required": {} } }, - "HealthCheckVersion": { - "target": "com.amazonaws.route53#HealthCheckVersion", + "HealthCheckConfig": { + "target": "com.amazonaws.route53#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

    The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting \n\t\t\tanother change to the health check.

    ", + "smithy.api#documentation": "

    A complex type that contains detailed information about one health check.

    ", "smithy.api#required": {} } }, @@ -3480,6 +3474,12 @@ "traits": { "smithy.api#documentation": "

    If the health check was created by another service, the service that created the health check. When a health check is created \n\t\t\tby another service, you can't edit or delete it using Amazon Route 53.

    " } + }, + "CloudWatchAlarmConfiguration": { + "target": "com.amazonaws.route53#CloudWatchAlarmConfiguration", + "traits": { + "smithy.api#documentation": "

    A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

    " + } } }, "traits": { @@ -3505,95 +3505,95 @@ "com.amazonaws.route53#HealthCheckConfig": { "type": "structure", "members": { - "HealthThreshold": { - "target": "com.amazonaws.route53#HealthThreshold", + "FailureThreshold": { + "target": "com.amazonaws.route53#FailureThreshold", "traits": { - "smithy.api#documentation": "

    The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the \n\t\t\tCALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a \n\t\t\tCALCULATED health check, use the \n\t\t\tChildHealthChecks \n\t\t\telement.

    \n\t\t

    Note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify 0, Route 53 always considers this health check to be healthy.

      \n\t\t\t
      • \n
    " + "smithy.api#documentation": "

    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint \n\t\t\tfrom unhealthy to healthy or vice versa. For more information, see \n\t\t\tHow Amazon Route 53 Determines Whether an Endpoint Is Healthy \n\t\t\tin the Amazon Route 53 Developer Guide.

    \n\t\t

    If you don't specify a value for FailureThreshold, the default value is three health checks.

    " } }, - "AlarmIdentifier": { - "target": "com.amazonaws.route53#AlarmIdentifier", + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", "traits": { - "smithy.api#documentation": "

    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether \n\t\t\tthe specified health check is healthy.

    " + "smithy.api#documentation": "

    When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Healthy: Route 53 considers the health check to be healthy.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Unhealthy: Route 53 considers the health check to be unhealthy.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data \n\t\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the default status for the health check is \n\t\t\t\t\thealthy.

      \n\t\t\t
      • \n
    " } }, - "Type": { - "target": "com.amazonaws.route53#HealthCheckType", + "SearchString": { + "target": "com.amazonaws.route53#SearchString", "traits": { - "smithy.api#documentation": "

    The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

    \n\t\t \n\t\t\t

    You can't change the value of Type after you create a health check.

    \n\t\t     \n\t\t

    You can create the following types of health checks:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request \n\t\t\t\t\tand waits for an HTTP status code of 200 or greater and less than 400.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request \n\t\t\t\t\tand waits for an HTTP status code of 200 or greater and less than 400.

      \n\t\t\t\t \n\t\t\t\t\t

      If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

      \n\t\t\t\t       \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an \n\t\t\t\t\tHTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an \n\t\t\t\t\tHTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n TCP: Route 53 tries to establish a TCP connection.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is \n\t\t\t\t\tOK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. \n\t\t\t\t\tIf CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status \n\t\t\t\t\tdepends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or \n\t\t\t\t\tLastKnownStatus.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up \n\t\t\t\t\tthe number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of \n\t\t\t\t\tHealthThreshold.

      \n\t\t\t
      • \n
    \n\t\t

    For more information, see \n\t\t\tHow Route 53 \n\t\t\tDetermines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the \n\t\t\tresponse body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

    \n\t\t

    Route 53 considers case when searching for SearchString in the response body.

    " } }, - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", + "RequestInterval": { + "target": "com.amazonaws.route53#RequestInterval", "traits": { - "smithy.api#documentation": "

    The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for \n\t\t\tIPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName \n\t\t\tat the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health \n\t\t\tof the endpoint.

    \n\n\t\t

    Use one of the following formats for the value of IPAddress:

    \n\t\t
      \n
    • \n

      \n IPv4 address: four values between 0 and 255, separated by periods (.), \n\t\t\t\tfor example, 192.0.2.44.

      \n
      • \n
    • \n

      \n IPv6 address: eight groups of four hexadecimal values, separated by colons (:), \n\t\t\t\tfor example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, \n\t\t\t\tfor example, 2001:db8:85a3::abcd:1:2345.

      \n
      • \n
    \n\t\t

    If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and \n\t\t\tspecify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

    \n\t\t

    For more information, see \n\t\t\tFullyQualifiedDomainName.\n\t\t

    \n\t\t

    Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or \n\t\t\tmulticast ranges. For more information about IP addresses for which you can't create health checks, see the following \n\t\t\tdocuments:

    \n\t\t \n\t\t

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

    " + "smithy.api#documentation": "

    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next \n\t\t\thealth check request. Each Route 53 health checker makes requests at this interval.

    \n\t\t \n\t\t\t

    You can't change the value of RequestInterval after you create a health check.

    \n\t\t     \n\t\t

    If you don't specify a value for RequestInterval, the default value is 30 seconds.

    " } }, - "ResourcePath": { - "target": "com.amazonaws.route53#ResourcePath", + "Inverted": { + "target": "com.amazonaws.route53#Inverted", "traits": { - "smithy.api#documentation": "

    The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint \n\t\t\twill return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. \n\t\t\tYou can also include query string parameters, for example, /welcome.html?language=jp&login=y. \n\t\t

    " + "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it \n\t\t\totherwise would be considered healthy.

    " } }, - "Disabled": { - "target": "com.amazonaws.route53#Disabled", + "FullyQualifiedDomainName": { + "target": "com.amazonaws.route53#FullyQualifiedDomainName", "traits": { - "smithy.api#documentation": "

    Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

    \n\t\t
      \n
    • \n

      \n Health checks that check the health of endpoints: \n\t\t\t\tRoute 53 stops submitting requests to your application, server, or other resource.

      \n
      • \n
    • \n

      \n Calculated health checks: \n\t\t\t\tRoute 53 stops aggregating the status of the referenced health checks.

      \n
      • \n
    • \n

      \n Health checks that monitor CloudWatch alarms: \n\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

      \n
      • \n
    \n\t\t\n\t\t

    After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, \n\t\t\tRoute 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of \n\t\t\tInverted.\n\t\t

    \n\t\t\n\t\t

    Charges for a health check still apply when the health check is disabled. For more information, see \n\t\t\tAmazon Route 53 Pricing.

    " + "smithy.api#documentation": "

    Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

    \n\t\t\n\t\t

    \n If you specify a value for \n IPAddress:

    \n\t\t

    Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

    \n\t\t

    When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the Host header.

      \n\t\t\t
      • \n
    \n\t\t

    If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the \n\t\t\tHost header in each of the preceding cases.

    \n\t\t\n\t\t

    \n If you don't specify a value for IPAddress\n :

    \n\t\t

    Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for \n\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

    \n\t\t \n

    If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's \n\t\t\tno resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \n\t\t\t\"DNS resolution failed\" error.

    \n     \n\t\t

    If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

    \n\t\t \n\t\t\t

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the \n\t\t\t\tresource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

    \n\t\t     \n\t\t

    In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you \n\t\t\tspecify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

    " } }, - "EnableSNI": { - "target": "com.amazonaws.route53#EnableSNI", + "ResourcePath": { + "target": "com.amazonaws.route53#ResourcePath", "traits": { - "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello\n\t\t\tmessage during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable \n\t\t\tSSL/TLS certificate.

    \n\t\t

    Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't \n\t\t\tenable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for \n\t\t\tother reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that \n\t\t\tyour certificate is valid.

    \n\t\t

    The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the \n\t\t\tSubject Alternative Names field. One of the domain names in the certificate should match the value that you specify for \n\t\t\tFullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not \n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the \n\t\t\tsecond attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

    " + "smithy.api#documentation": "

    The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint \n\t\t\twill return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. \n\t\t\tYou can also include query string parameters, for example, /welcome.html?language=jp&login=y. \n\t\t

    " } }, - "FullyQualifiedDomainName": { - "target": "com.amazonaws.route53#FullyQualifiedDomainName", + "Regions": { + "target": "com.amazonaws.route53#HealthCheckRegionList", "traits": { - "smithy.api#documentation": "

    Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

    \n\t\t\n\t\t

    \n If you specify a value for \n IPAddress:

    \n\t\t

    Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

    \n\t\t

    When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the Host header.

      \n\t\t\t
      • \n
    \n\t\t

    If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the \n\t\t\tHost header in each of the preceding cases.

    \n\t\t\n\t\t

    \n If you don't specify a value for IPAddress\n :

    \n\t\t

    Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for \n\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

    \n\t\t \n

    If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's \n\t\t\tno resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \n\t\t\t\"DNS resolution failed\" error.

    \n     \n\t\t

    If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

    \n\t\t \n\t\t\t

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the \n\t\t\t\tresource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

    \n\t\t     \n\t\t

    In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you \n\t\t\tspecify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

    " + "smithy.api#documentation": "

    A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the \n\t\t\tspecified endpoint.

    \n\t\t

    If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under \n\t\t\tValid Values.

    \n\t\t

    If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks \n\t\t\tfrom that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with \n\t\t\tfour different regions).

    " } }, - "RequestInterval": { - "target": "com.amazonaws.route53#RequestInterval", + "EnableSNI": { + "target": "com.amazonaws.route53#EnableSNI", "traits": { - "smithy.api#documentation": "

    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next \n\t\t\thealth check request. Each Route 53 health checker makes requests at this interval.

    \n\t\t \n\t\t\t

    You can't change the value of RequestInterval after you create a health check.

    \n\t\t     \n\t\t

    If you don't specify a value for RequestInterval, the default value is 30 seconds.

    " + "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello\n\t\t\tmessage during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable \n\t\t\tSSL/TLS certificate.

    \n\t\t

    Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't \n\t\t\tenable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for \n\t\t\tother reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that \n\t\t\tyour certificate is valid.

    \n\t\t

    The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the \n\t\t\tSubject Alternative Names field. One of the domain names in the certificate should match the value that you specify for \n\t\t\tFullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not \n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the \n\t\t\tsecond attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

    " } }, - "Inverted": { - "target": "com.amazonaws.route53#Inverted", + "AlarmIdentifier": { + "target": "com.amazonaws.route53#AlarmIdentifier", "traits": { - "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it \n\t\t\totherwise would be considered healthy.

    " + "smithy.api#documentation": "

    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether \n\t\t\tthe specified health check is healthy.

    " } }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "HealthThreshold": { + "target": "com.amazonaws.route53#HealthThreshold", "traits": { - "smithy.api#documentation": "

    When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Healthy: Route 53 considers the health check to be healthy.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Unhealthy: Route 53 considers the health check to be unhealthy.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data \n\t\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the default status for the health check is \n\t\t\t\t\thealthy.

      \n\t\t\t
      • \n
    " + "smithy.api#documentation": "

    The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the \n\t\t\tCALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a \n\t\t\tCALCULATED health check, use the \n\t\t\tChildHealthChecks \n\t\t\telement.

    \n\t\t

    Note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify 0, Route 53 always considers this health check to be healthy.

      \n\t\t\t
      • \n
    " } }, - "FailureThreshold": { - "target": "com.amazonaws.route53#FailureThreshold", + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", "traits": { - "smithy.api#documentation": "

    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint \n\t\t\tfrom unhealthy to healthy or vice versa. For more information, see \n\t\t\tHow Amazon Route 53 Determines Whether an Endpoint Is Healthy \n\t\t\tin the Amazon Route 53 Developer Guide.

    \n\t\t

    If you don't specify a value for FailureThreshold, the default value is three health checks.

    " + "smithy.api#documentation": "

    The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for \n\t\t\tIPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName \n\t\t\tat the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health \n\t\t\tof the endpoint.

    \n\n\t\t

    Use one of the following formats for the value of IPAddress:

    \n\t\t
      \n
    • \n

      \n IPv4 address: four values between 0 and 255, separated by periods (.), \n\t\t\t\tfor example, 192.0.2.44.

      \n
      • \n
    • \n

      \n IPv6 address: eight groups of four hexadecimal values, separated by colons (:), \n\t\t\t\tfor example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, \n\t\t\t\tfor example, 2001:db8:85a3::abcd:1:2345.

      \n
      • \n
    \n\t\t

    If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and \n\t\t\tspecify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

    \n\t\t

    For more information, see \n\t\t\tFullyQualifiedDomainName.\n\t\t

    \n\t\t

    Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or \n\t\t\tmulticast ranges. For more information about IP addresses for which you can't create health checks, see the following \n\t\t\tdocuments:

    \n\t\t \n\t\t

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

    " } }, - "SearchString": { - "target": "com.amazonaws.route53#SearchString", + "Disabled": { + "target": "com.amazonaws.route53#Disabled", "traits": { - "smithy.api#documentation": "

    If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the \n\t\t\tresponse body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

    \n\t\t

    Route 53 considers case when searching for SearchString in the response body.

    " + "smithy.api#documentation": "

    Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

    \n\t\t
      \n
    • \n

      \n Health checks that check the health of endpoints: \n\t\t\t\tRoute 53 stops submitting requests to your application, server, or other resource.

      \n
      • \n
    • \n

      \n Calculated health checks: \n\t\t\t\tRoute 53 stops aggregating the status of the referenced health checks.

      \n
      • \n
    • \n

      \n Health checks that monitor CloudWatch alarms: \n\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

      \n
      • \n
    \n\t\t\n\t\t

    After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, \n\t\t\tRoute 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of \n\t\t\tInverted.\n\t\t

    \n\t\t\n\t\t

    Charges for a health check still apply when the health check is disabled. For more information, see \n\t\t\tAmazon Route 53 Pricing.

    " } }, - "Regions": { - "target": "com.amazonaws.route53#HealthCheckRegionList", + "Type": { + "target": "com.amazonaws.route53#HealthCheckType", "traits": { - "smithy.api#documentation": "

    A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the \n\t\t\tspecified endpoint.

    \n\t\t

    If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under \n\t\t\tValid Values.

    \n\t\t

    If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks \n\t\t\tfrom that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with \n\t\t\tfour different regions).

    " + "smithy.api#documentation": "

    The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

    \n\t\t \n\t\t\t

    You can't change the value of Type after you create a health check.

    \n\t\t     \n\t\t

    You can create the following types of health checks:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request \n\t\t\t\t\tand waits for an HTTP status code of 200 or greater and less than 400.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request \n\t\t\t\t\tand waits for an HTTP status code of 200 or greater and less than 400.

      \n\t\t\t\t \n\t\t\t\t\t

      If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

      \n\t\t\t\t       \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an \n\t\t\t\t\tHTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an \n\t\t\t\t\tHTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n TCP: Route 53 tries to establish a TCP connection.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is \n\t\t\t\t\tOK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. \n\t\t\t\t\tIf CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status \n\t\t\t\t\tdepends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or \n\t\t\t\t\tLastKnownStatus.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up \n\t\t\t\t\tthe number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of \n\t\t\t\t\tHealthThreshold.

      \n\t\t\t
      • \n
    \n\t\t

    For more information, see \n\t\t\tHow Route 53 \n\t\t\tDetermines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

    ", + "smithy.api#required": {} } }, - "MeasureLatency": { - "target": "com.amazonaws.route53#MeasureLatency", + "ChildHealthChecks": { + "target": "com.amazonaws.route53#ChildHealthCheckList", "traits": { - "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to \n\t\t\tdisplay CloudWatch latency graphs on the Health Checks page in the Route 53 console.

    \n\t\t \n\t\t\t

    You can't change the value of MeasureLatency after you create a health check.

    \n\t\t     " + "smithy.api#documentation": "

    (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that \n\t\t\tyou want to associate with a CALCULATED health check.

    " } }, "Port": { @@ -3602,10 +3602,10 @@ "smithy.api#documentation": "

    The port on the endpoint that you want Amazon Route 53 to perform health checks on.

    \n\t\t \n\t\t\t

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or \n\t\t\t\tCALCULATED.

    \n\t\t     " } }, - "ChildHealthChecks": { - "target": "com.amazonaws.route53#ChildHealthCheckList", + "MeasureLatency": { + "target": "com.amazonaws.route53#MeasureLatency", "traits": { - "smithy.api#documentation": "

    (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that \n\t\t\tyou want to associate with a CALCULATED health check.

    " + "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to \n\t\t\tdisplay CloudWatch latency graphs on the Health Checks page in the Route 53 console.

    \n\t\t \n\t\t\t

    You can't change the value of MeasureLatency after you create a health check.

    \n\t\t     " } } }, @@ -3824,6 +3824,13 @@ "smithy.api#documentation": "

    The number of resource record sets in the hosted zone.

    " } }, + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    ", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.route53#DNSName", "traits": { @@ -3831,6 +3838,13 @@ "smithy.api#required": {} } }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

    The value that you specified for CallerReference when you created the\n\t\t\thosted zone.

    ", + "smithy.api#required": {} + } + }, "Config": { "target": "com.amazonaws.route53#HostedZoneConfig", "traits": { @@ -3842,20 +3856,6 @@ "traits": { "smithy.api#documentation": "

    If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created \n\t\t\tby another service, you can't edit or delete it using Route 53.

    " } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

    The value that you specified for CallerReference when you created the\n\t\t\thosted zone.

    ", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -3881,17 +3881,17 @@ "com.amazonaws.route53#HostedZoneConfig": { "type": "structure", "members": { - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

    Any comments that you want to include about the hosted zone.

    " - } - }, "PrivateZone": { "target": "com.amazonaws.route53#IsPrivateZone", "traits": { "smithy.api#documentation": "

    A value that indicates whether this is a private hosted zone.

    " } + }, + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

    Any comments that you want to include about the hosted zone.

    " + } } }, "traits": { @@ -4283,17 +4283,17 @@ "com.amazonaws.route53#LinkedService": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

    If the health check or hosted zone was created by another service, an optional description that can be provided by the other service.\n\t\t\tWhen a resource is created by another service, you can't edit or delete it using Amazon Route 53.

    " - } - }, "ServicePrincipal": { "target": "com.amazonaws.route53#ServicePrincipal", "traits": { "smithy.api#documentation": "

    If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created \n\t\t\tby another service, you can't edit or delete it using Amazon Route 53.

    " } + }, + "Description": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

    If the health check or hosted zone was created by another service, an optional description that can be provided by the other service.\n\t\t\tWhen a resource is created by another service, you can't edit or delete it using Amazon Route 53.

    " + } } }, "traits": { @@ -4325,13 +4325,6 @@ "com.amazonaws.route53#ListGeoLocationsRequest": { "type": "structure", "members": { - "StartContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

    The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already \n\t\t\treturned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous \n\t\t\tresponse has a value, enter that value in startcontinentcode to return the next page of results.

    \n\t\t

    Include startcontinentcode only if you want to list continents. Don't include startcontinentcode \n\t\t\twhen you're listing countries or countries with their subdivisions.

    ", - "smithy.api#httpQuery": "startcontinentcode" - } - }, "StartSubdivisionCode": { "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", "traits": { @@ -4339,6 +4332,13 @@ "smithy.api#httpQuery": "startsubdivisioncode" } }, + "StartContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

    The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already \n\t\t\treturned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous \n\t\t\tresponse has a value, enter that value in startcontinentcode to return the next page of results.

    \n\t\t

    Include startcontinentcode only if you want to list continents. Don't include startcontinentcode \n\t\t\twhen you're listing countries or countries with their subdivisions.

    ", + "smithy.api#httpQuery": "startcontinentcode" + } + }, "StartCountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { @@ -4361,23 +4361,29 @@ "com.amazonaws.route53#ListGeoLocationsResponse": { "type": "structure", "members": { - "GeoLocationDetailsList": { - "target": "com.amazonaws.route53#GeoLocationDetailsList", + "NextSubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request.

    " + } + }, + "GeoLocationDetailsList": { + "target": "com.amazonaws.route53#GeoLocationDetailsList", "traits": { "smithy.api#documentation": "

    A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

    ", "smithy.api#required": {} } }, - "NextSubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "NextCountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request.

    " + "smithy.api#documentation": "

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextCountryCode in the startcountrycode parameter in another ListGeoLocations request.

    " } }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of \n\t\t\tIsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, \n\t\t\tNextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and \n\t\t\tstartsubdivisioncode, as applicable.

    ", + "smithy.api#documentation": "

    The value that you specified for MaxItems in the request.

    ", "smithy.api#required": {} } }, @@ -4387,16 +4393,10 @@ "smithy.api#documentation": "

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextContinentCode in the startcontinentcode parameter in another ListGeoLocations request.

    " } }, - "NextCountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextCountryCode in the startcountrycode parameter in another ListGeoLocations request.

    " - } - }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

    The value that you specified for MaxItems in the request.

    ", + "smithy.api#documentation": "

    A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of \n\t\t\tIsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, \n\t\t\tNextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and \n\t\t\tstartsubdivisioncode, as applicable.

    ", "smithy.api#required": {} } } @@ -4433,19 +4433,19 @@ "com.amazonaws.route53#ListHealthChecksRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", - "traits": { - "smithy.api#documentation": "

    The maximum number of health checks that you want ListHealthChecks to return in response to the current request. \n\t\t\tAmazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks.

    ", - "smithy.api#httpQuery": "maxitems" - } - }, "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, \n\t\t\tsubmit another ListHealthChecks request.

    \n\t\t

    For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first health check that Amazon Route 53 will return if you submit another request.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more health checks to get.

    ", "smithy.api#httpQuery": "marker" } + }, + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", + "traits": { + "smithy.api#documentation": "

    The maximum number of health checks that you want ListHealthChecks to return in response to the current request. \n\t\t\tAmazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks.

    ", + "smithy.api#httpQuery": "maxitems" + } } }, "traits": { @@ -4455,10 +4455,10 @@ "com.amazonaws.route53#ListHealthChecksResponse": { "type": "structure", "members": { - "HealthChecks": { - "target": "com.amazonaws.route53#HealthChecks", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    A complex type that contains one HealthCheck element for each health check that is associated with the current \n\t\t\tAWS account.

    ", + "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the \n\t\t\tcurrent response.

    ", "smithy.api#required": {} } }, @@ -4469,13 +4469,6 @@ "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", - "traits": { - "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the \n\t\t\tcurrent response.

    ", - "smithy.api#required": {} - } - }, "NextMarker": { "target": "com.amazonaws.route53#PageMarker", "traits": { @@ -4488,6 +4481,13 @@ "smithy.api#documentation": "

    For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the \n\t\t\tmarker parameter in the previous request.

    ", "smithy.api#required": {} } + }, + "HealthChecks": { + "target": "com.amazonaws.route53#HealthChecks", + "traits": { + "smithy.api#documentation": "

    A complex type that contains one HealthCheck element for each health check that is associated with the current \n\t\t\tAWS account.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -4557,19 +4557,19 @@ "smithy.api#httpQuery": "dnsname" } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", - "traits": { - "smithy.api#documentation": "

    The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems \n\t\t\thosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and \n\t\t\tNextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

    ", - "smithy.api#httpQuery": "maxitems" - } - }, "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { "smithy.api#documentation": "

    (Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

    \n\t\t

    If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first \n\t\t\tmaxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to \n\t\t\tListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of \n\t\t\thostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

    ", "smithy.api#httpQuery": "hostedzoneid" } + }, + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", + "traits": { + "smithy.api#documentation": "

    The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems \n\t\t\thosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and \n\t\t\tNextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

    ", + "smithy.api#httpQuery": "maxitems" + } } }, "traits": { @@ -4585,22 +4585,24 @@ "smithy.api#documentation": "

    If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the \n\t\t\tnext group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName \n\t\t\tand NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    \n\t\t

    This element is present only if IsTruncated is true.

    " } }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", "traits": { - "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    " + "smithy.api#documentation": "

    A complex type that contains general information about the hosted zone.

    ", + "smithy.api#required": {} } }, - "DNSName": { - "target": "com.amazonaws.route53#DNSName", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the \n\t\t\tdnsname parameter in the request that produced the current response.

    " + "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    " } }, - "NextDNSName": { - "target": "com.amazonaws.route53#DNSName", + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of \n\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName \n\t\t\tand NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    \n\t\t

    This element is present only if IsTruncated is true.

    " + "smithy.api#documentation": "

    A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of \n\t\t\tmaxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and \n\t\t\tNextHostedZoneId elements in the dnsname and hostedzoneid parameters.

    ", + "smithy.api#required": {} } }, "MaxItems": { @@ -4610,18 +4612,16 @@ "smithy.api#required": {} } }, - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", + "NextDNSName": { + "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

    A complex type that contains general information about the hosted zone.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of \n\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName \n\t\t\tand NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    \n\t\t

    This element is present only if IsTruncated is true.

    " } }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", + "DNSName": { + "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

    A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of \n\t\t\tmaxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and \n\t\t\tNextHostedZoneId elements in the dnsname and hostedzoneid parameters.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the \n\t\t\tdnsname parameter in the request that produced the current response.

    " } } }, @@ -4665,6 +4665,13 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. \n\t\t\tTo get more hosted zones, submit another ListHostedZonesByVPC request.

    \n\t\t

    For the value of NextToken, specify the value of NextToken from the previous response.

    \n\t\t

    If the previous response didn't include a NextToken element, there are no more hosted zones to get.

    ", + "smithy.api#httpQuery": "nexttoken" + } + }, "VPCId": { "target": "com.amazonaws.route53#VPCId", "traits": { @@ -4673,17 +4680,10 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. \n\t\t\tTo get more hosted zones, submit another ListHostedZonesByVPC request.

    \n\t\t

    For the value of NextToken, specify the value of NextToken from the previous response.

    \n\t\t

    If the previous response didn't include a NextToken element, there are no more hosted zones to get.

    ", - "smithy.api#httpQuery": "nexttoken" - } - }, "MaxItems": { "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with \n\t\t\tmore than MaxItems hosted zones, the response includes a NextToken element. NextToken contains \n\t\t\tthe hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

    ", + "smithy.api#documentation": "

    (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with \n\t\t\tmore than MaxItems hosted zones, the response includes a NextToken element. NextToken contains \n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.

    ", "smithy.api#httpQuery": "maxitems" } } @@ -4695,6 +4695,13 @@ "com.amazonaws.route53#ListHostedZonesByVPCResponse": { "type": "structure", "members": { + "HostedZoneSummaries": { + "target": "com.amazonaws.route53#HostedZoneSummaries", + "traits": { + "smithy.api#documentation": "

    A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. \n\t\t\tEach HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

    ", + "smithy.api#required": {} + } + }, "MaxItems": { "target": "com.amazonaws.route53#PageMaxItems", "traits": { @@ -4707,13 +4714,6 @@ "traits": { "smithy.api#documentation": "

    The value that you specified for NextToken in the most recent ListHostedZonesByVPC request.

    " } - }, - "HostedZoneSummaries": { - "target": "com.amazonaws.route53#HostedZoneSummaries", - "traits": { - "smithy.api#documentation": "

    A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. \n\t\t\tEach HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

    ", - "smithy.api#required": {} - } } } }, @@ -4727,19 +4727,19 @@ "smithy.api#httpQuery": "delegationsetid" } }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more hosted zones. \n\t\t\tTo get more hosted zones, submit another ListHostedZones request.

    \n\t\t

    For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

    ", - "smithy.api#httpQuery": "marker" - } - }, "MaxItems": { "target": "com.amazonaws.route53#PageMaxItems", "traits": { "smithy.api#documentation": "

    (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems \n\t\t\thosted zones, the value of IsTruncated in the response is true, and the value of NextMarker \n\t\t\tis the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

    ", "smithy.api#httpQuery": "maxitems" } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more hosted zones. \n\t\t\tTo get more hosted zones, submit another ListHostedZones request.

    \n\t\t

    For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

    ", + "smithy.api#httpQuery": "marker" + } } }, "traits": { @@ -4755,10 +4755,10 @@ "smithy.api#documentation": "

    If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group \n\t\t\tof hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the \n\t\t\tmarker parameter.

    \n\t\t

    This element is present only if IsTruncated is true.

    " } }, - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", + "Marker": { + "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

    A complex type that contains general information about the hosted zone.

    ", + "smithy.api#documentation": "

    For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the \n\t\t\tmarker parameter in the request that produced the current response.

    ", "smithy.api#required": {} } }, @@ -4769,17 +4769,17 @@ "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", "traits": { - "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the call to ListHostedZones that \n\t\t\tproduced the current response.

    ", + "smithy.api#documentation": "

    A complex type that contains general information about the hosted zone.

    ", "smithy.api#required": {} } }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the \n\t\t\tmarker parameter in the request that produced the current response.

    ", + "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the call to ListHostedZones that \n\t\t\tproduced the current response.

    ", "smithy.api#required": {} } } @@ -4842,18 +4842,18 @@ "com.amazonaws.route53#ListQueryLoggingConfigsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If a response includes the last of the query logging configurations that are associated with the current AWS account, \n\t\t\tNextToken doesn't appear in the response.

    \n\t\t

    If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListQueryLoggingConfigs \n\t\t\trequest. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in \n\t\t\tNextToken in the next request.

    " + } + }, "QueryLoggingConfigs": { "target": "com.amazonaws.route53#QueryLoggingConfigs", "traits": { "smithy.api#documentation": "

    An array that contains one \n\t\t\tQueryLoggingConfig element \n\t\t\tfor each configuration for DNS query logging that is associated with the current AWS account.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If a response includes the last of the query logging configurations that are associated with the current AWS account, \n\t\t\tNextToken doesn't appear in the response.

    \n\t\t

    If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListQueryLoggingConfigs \n\t\t\trequest. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in \n\t\t\tNextToken in the next request.

    " - } } } }, @@ -4885,19 +4885,18 @@ "com.amazonaws.route53#ListResourceRecordSetsRequest": { "type": "structure", "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "StartRecordType": { + "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that contains the resource record sets that you want to list.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The type of resource record set to begin the record listing from.

    \n\t\t

    Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | \n\t\t\tNAPTR | NS | PTR | SOA | SPF | SRV | TXT\n

    \n\t\t

    Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | \n\t\t\tMX | NAPTR | PTR | SPF | SRV | TXT\n

    \n\t\t

    Values for alias resource record sets:

    \n\t\t
      \n
    • \n

      \n API Gateway custom regional API or edge-optimized API: A

      \n
      • \n
    • \n

      \n CloudFront distribution: A or AAAA

      \n
      • \n
    • \n

      \n Elastic Beanstalk environment that has a regionalized subdomain: A

      \n
      • \n
    • \n

      \n Elastic Load Balancing load balancer: A | AAAA

      \n
      • \n
    • \n

      \n S3 bucket: A

      \n
      • \n
    • \n

      \n VPC interface VPC endpoint: A

      \n
      • \n
    • \n

      \n Another resource record set in this hosted zone: The type of the resource record set \n\t\t\t\tthat the alias references.

      \n
      • \n
    \n\t\t

    Constraint: Specifying type without specifying name returns an InvalidInput error.

    ", + "smithy.api#httpQuery": "type" } }, - "StartRecordName": { - "target": "com.amazonaws.route53#DNSName", + "StartRecordIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", "traits": { - "smithy.api#documentation": "

    The first name in the lexicographic ordering of resource record sets that you want to list. \n\t\t\tIf the specified record name doesn't exist, the results begin with the first resource record set that has a name \n\t\t\tgreater than the value of name.

    ", - "smithy.api#httpQuery": "name" + "smithy.api#documentation": "

    \n Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, \n\t\t\tspecify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current \n\t\t\tDNS name and type.

    ", + "smithy.api#httpQuery": "identifier" } }, "MaxItems": { @@ -4907,18 +4906,19 @@ "smithy.api#httpQuery": "maxitems" } }, - "StartRecordIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    \n Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, \n\t\t\tspecify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current \n\t\t\tDNS name and type.

    ", - "smithy.api#httpQuery": "identifier" + "smithy.api#documentation": "

    The ID of the hosted zone that contains the resource record sets that you want to list.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "StartRecordType": { - "target": "com.amazonaws.route53#RRType", + "StartRecordName": { + "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

    The type of resource record set to begin the record listing from.

    \n\t\t

    Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | \n\t\t\tNAPTR | NS | PTR | SOA | SPF | SRV | TXT\n

    \n\t\t

    Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | \n\t\t\tMX | NAPTR | PTR | SPF | SRV | TXT\n

    \n\t\t

    Values for alias resource record sets:

    \n\t\t
      \n
    • \n

      \n API Gateway custom regional API or edge-optimized API: A

      \n
      • \n
    • \n

      \n CloudFront distribution: A or AAAA

      \n
      • \n
    • \n

      \n Elastic Beanstalk environment that has a regionalized subdomain: A

      \n
      • \n
    • \n

      \n Elastic Load Balancing load balancer: A | AAAA

      \n
      • \n
    • \n

      \n S3 bucket: A

      \n
      • \n
    • \n

      \n VPC interface VPC endpoint: A

      \n
      • \n
    • \n

      \n Another resource record set in this hosted zone: The type of the resource record set \n\t\t\t\tthat the alias references.

      \n
      • \n
    \n\t\t

    Constraint: Specifying type without specifying name returns an InvalidInput error.

    ", - "smithy.api#httpQuery": "type" + "smithy.api#documentation": "

    The first name in the lexicographic ordering of resource record sets that you want to list. \n\t\t\tIf the specified record name doesn't exist, the results begin with the first resource record set that has a name \n\t\t\tgreater than the value of name.

    ", + "smithy.api#httpQuery": "name" } } }, @@ -4936,17 +4936,22 @@ "smithy.api#required": {} } }, - "ResourceRecordSets": { - "target": "com.amazonaws.route53#ResourceRecordSets", + "NextRecordName": { + "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

    Information about multiple resource record sets.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the results were truncated, the name of the next record in the list.

    \n\t\t

    This element is present only if IsTruncated is true.

    " } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "NextRecordType": { + "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

    The maximum number of records you requested.

    ", + "smithy.api#documentation": "

    If the results were truncated, the type of the next record in the list.

    \n\t\t

    This element is present only if IsTruncated is true.

    " + } + }, + "ResourceRecordSets": { + "target": "com.amazonaws.route53#ResourceRecordSets", + "traits": { + "smithy.api#documentation": "

    Information about multiple resource record sets.

    ", "smithy.api#required": {} } }, @@ -4956,16 +4961,11 @@ "smithy.api#documentation": "

    \n Resource record sets that have a routing policy other than simple: If results were truncated for a given \n\t\t\tDNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

    \n\t\t

    For information about routing policies, see \n\t\t\tChoosing a Routing Policy \n\t\t\tin the Amazon Route 53 Developer Guide.

    " } }, - "NextRecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

    If the results were truncated, the type of the next record in the list.

    \n\t\t

    This element is present only if IsTruncated is true.

    " - } - }, - "NextRecordName": { - "target": "com.amazonaws.route53#DNSName", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    If the results were truncated, the name of the next record in the list.

    \n\t\t

    This element is present only if IsTruncated is true.

    " + "smithy.api#documentation": "

    The maximum number of records you requested.

    ", + "smithy.api#required": {} } } }, @@ -4998,19 +4998,19 @@ "com.amazonaws.route53#ListReusableDelegationSetsRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. \n\t\t\tTo get another group, submit another ListReusableDelegationSets request.

    \n\t\t

    For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.

    ", - "smithy.api#httpQuery": "marker" - } - }, "MaxItems": { "target": "com.amazonaws.route53#PageMaxItems", "traits": { "smithy.api#documentation": "

    The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value \n\t\t\tgreater than 100, Route 53 returns only the first 100 reusable delegation sets.

    ", "smithy.api#httpQuery": "maxitems" } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. \n\t\t\tTo get another group, submit another ListReusableDelegationSets request.

    \n\t\t

    For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.

    ", + "smithy.api#httpQuery": "marker" + } } }, "traits": { @@ -5020,24 +5020,24 @@ "com.amazonaws.route53#ListReusableDelegationSetsResponse": { "type": "structure", "members": { - "DelegationSets": { - "target": "com.amazonaws.route53#DelegationSets", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    A complex type that contains one DelegationSet element for each reusable delegation set that was created \n\t\t\tby the current AWS account.

    ", + "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that \n\t\t\tproduced the current response.

    ", "smithy.api#required": {} } }, - "Marker": { + "NextMarker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

    For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified \n\t\t\tfor the marker parameter in the request that produced the current response.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set \n\t\t\tthat Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker \n\t\t\tin the marker parameter.

    " } }, - "NextMarker": { + "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set \n\t\t\tthat Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker \n\t\t\tin the marker parameter.

    " + "smithy.api#documentation": "

    For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified \n\t\t\tfor the marker parameter in the request that produced the current response.

    ", + "smithy.api#required": {} } }, "IsTruncated": { @@ -5047,10 +5047,10 @@ "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "DelegationSets": { + "target": "com.amazonaws.route53#DelegationSets", "traits": { - "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that \n\t\t\tproduced the current response.

    ", + "smithy.api#documentation": "

    A complex type that contains one DelegationSet element for each reusable delegation set that was created \n\t\t\tby the current AWS account.

    ", "smithy.api#required": {} } } @@ -5169,18 +5169,18 @@ "com.amazonaws.route53#ListTagsForResourcesRequest": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", + "ResourceIds": { + "target": "com.amazonaws.route53#TagResourceIdList", "traits": { - "smithy.api#documentation": "

    The type of the resources.

    \n\t\t
      \n
    • \n

      The resource type for health checks is healthcheck.

      \n
      • \n
    • \n

      The resource type for hosted zones is hostedzone.

      \n
      • \n
    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

    ", "smithy.api#required": {} } }, - "ResourceIds": { - "target": "com.amazonaws.route53#TagResourceIdList", + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", "traits": { - "smithy.api#documentation": "

    A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

    ", + "smithy.api#documentation": "

    The type of the resources.

    \n\t\t
      \n
    • \n

      The resource type for health checks is healthcheck.

      \n
      • \n
    • \n

      The resource type for hosted zones is hostedzone.

      \n
      • \n
    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -5218,7 +5218,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets information about the latest version for every traffic policy that is associated with the current AWS account. \n\t\t\tPolicies are listed in the order that they were created in.

    ", + "smithy.api#documentation": "

    Gets information about the latest version for every traffic policy that is associated with the current AWS account. \n\t\t\tPolicies are listed in the order that they were created in.

    \n\t\t\n\t\t

    For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see \n\t\t\tDeleteTrafficPolicy.\n\n\t\t

    ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicies", @@ -5258,17 +5258,17 @@ "smithy.api#required": {} } }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of \n\t\t\ttraffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker \n\t\t\tin the TrafficPolicyIdMarker request parameter.

    ", + "smithy.api#documentation": "

    The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced \n\t\t\tthe current response.

    ", "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

    The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced \n\t\t\tthe current response.

    ", + "smithy.api#documentation": "

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of \n\t\t\ttraffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker \n\t\t\tin the TrafficPolicyIdMarker request parameter.

    ", "smithy.api#required": {} } }, @@ -5340,6 +5340,13 @@ "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest": { "type": "structure", "members": { + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

    If the value of IsTruncated in the previous response is true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, \n\t\t\tspecify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "smithy.api#httpQuery": "trafficpolicyinstancename" + } + }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { @@ -5347,14 +5354,6 @@ "smithy.api#httpQuery": "trafficpolicyinstancetype" } }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that you want to list traffic policy instances for.

    ", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, "MaxItems": { "target": "com.amazonaws.route53#PageMaxItems", "traits": { @@ -5362,11 +5361,12 @@ "smithy.api#httpQuery": "maxitems" } }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    If the value of IsTruncated in the previous response is true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, \n\t\t\tspecify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", - "smithy.api#httpQuery": "trafficpolicyinstancename" + "smithy.api#documentation": "

    The ID of the hosted zone that you want to list traffic policy instances for.

    ", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} } } }, @@ -5377,10 +5377,16 @@ "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { "type": "structure", "members": { - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the \n\t\t\tnext group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying \n\t\t\tthe values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\tin the corresponding request parameters.

    ", + "smithy.api#documentation": "

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are \n\t\t\tassociated with the first traffic policy instance in the next group of traffic policy instances.

    " + } + }, + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    ", "smithy.api#required": {} } }, @@ -5391,10 +5397,10 @@ "smithy.api#required": {} } }, - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    ", + "smithy.api#documentation": "

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the \n\t\t\tnext group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying \n\t\t\tthe values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\tin the corresponding request parameters.

    ", "smithy.api#required": {} } }, @@ -5403,12 +5409,6 @@ "traits": { "smithy.api#documentation": "

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy \n\t\t\tinstance in the next group of traffic policy instances.

    " } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are \n\t\t\tassociated with the first traffic policy instance in the next group of traffic policy instances.

    " - } } }, "traits": { @@ -5453,11 +5453,19 @@ "smithy.api#httpQuery": "trafficpolicyinstancetype" } }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

    \n\t\t

    For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, \n\t\t\twhich is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", - "smithy.api#httpQuery": "hostedzoneid" + "smithy.api#documentation": "

    The maximum number of traffic policy instances to be included in the response body for this request. If you have more than \n\t\t\tMaxItems traffic policy instances, the value of the IsTruncated element in the response is true, \n\t\t\tand the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\trepresent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    ", + "smithy.api#httpQuery": "maxitems" + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

    The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the \n\t\t\ttraffic policy that is specified by TrafficPolicyId.

    ", + "smithy.api#httpQuery": "version", + "smithy.api#required": {} } }, "TrafficPolicyId": { @@ -5475,19 +5483,11 @@ "smithy.api#httpQuery": "trafficpolicyinstancename" } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", - "traits": { - "smithy.api#documentation": "

    The maximum number of traffic policy instances to be included in the response body for this request. If you have more than \n\t\t\tMaxItems traffic policy instances, the value of the IsTruncated element in the response is true, \n\t\t\tand the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\trepresent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    ", - "smithy.api#httpQuery": "maxitems" - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the \n\t\t\ttraffic policy that is specified by TrafficPolicyId.

    ", - "smithy.api#httpQuery": "version", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

    \n\t\t

    For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, \n\t\t\twhich is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "smithy.api#httpQuery": "hostedzoneid" } } }, @@ -5498,17 +5498,24 @@ "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { "type": "structure", "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    ", + "smithy.api#documentation": "

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first \n\t\t\ttraffic policy instance in the next group of traffic policy instances.

    " + } + }, + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", + "traits": { + "smithy.api#documentation": "

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced \n\t\t\tthe current response.

    ", "smithy.api#required": {} } }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance \n\t\t\tin the next group of MaxItems traffic policy instances.

    " + "smithy.api#documentation": "

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    ", + "smithy.api#required": {} } }, "IsTruncated": { @@ -5518,11 +5525,10 @@ "smithy.api#required": {} } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced \n\t\t\tthe current response.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance \n\t\t\tin the next group of MaxItems traffic policy instances.

    " } }, "TrafficPolicyInstanceTypeMarker": { @@ -5530,12 +5536,6 @@ "traits": { "smithy.api#documentation": "

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets \n\t\t\tthat are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

    " } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first \n\t\t\ttraffic policy instance in the next group of traffic policy instances.

    " - } } }, "traits": { @@ -5545,20 +5545,6 @@ "com.amazonaws.route53#ListTrafficPolicyInstancesRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", - "traits": { - "smithy.api#documentation": "

    The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. \n\t\t\tIf you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is \n\t\t\ttrue, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and \n\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems \n\t\t\ttraffic policy instances.

    ", - "smithy.api#httpQuery": "maxitems" - } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, \n\t\t\tspecify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", - "smithy.api#httpQuery": "hostedzoneid" - } - }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { @@ -5566,12 +5552,26 @@ "smithy.api#httpQuery": "trafficpolicyinstancetype" } }, + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", + "traits": { + "smithy.api#documentation": "

    The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. \n\t\t\tIf you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is \n\t\t\ttrue, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and \n\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems \n\t\t\ttraffic policy instances.

    ", + "smithy.api#httpQuery": "maxitems" + } + }, "TrafficPolicyInstanceNameMarker": { "target": "com.amazonaws.route53#DNSName", "traits": { "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, \n\t\t\tspecify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", "smithy.api#httpQuery": "trafficpolicyinstancename" } + }, + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, \n\t\t\tspecify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

    \n\t\t

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "smithy.api#httpQuery": "hostedzoneid" + } } }, "traits": { @@ -5587,10 +5587,10 @@ "smithy.api#documentation": "

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy \n\t\t\tinstance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

    " } }, - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements \n\t\t\tin the request.

    ", + "smithy.api#documentation": "

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances \n\t\t\tthat produced the current response.

    ", "smithy.api#required": {} } }, @@ -5613,10 +5613,10 @@ "smithy.api#documentation": "

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first \n\t\t\ttraffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

    " } }, - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", "traits": { - "smithy.api#documentation": "

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances \n\t\t\tthat produced the current response.

    ", + "smithy.api#documentation": "

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements \n\t\t\tin the request.

    ", "smithy.api#required": {} } } @@ -5653,6 +5653,14 @@ "com.amazonaws.route53#ListTrafficPolicyVersionsRequest": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

    Specify the value of Id of the traffic policy for which you want to list all versions.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxItems": { "target": "com.amazonaws.route53#PageMaxItems", "traits": { @@ -5666,14 +5674,6 @@ "smithy.api#documentation": "

    For your first request to ListTrafficPolicyVersions, don't include the TrafficPolicyVersionMarker parameter.

    \n\t\t

    If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only \n\t\t\tthe first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions \n\t\t\trequest. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous \n\t\t\tresponse.

    ", "smithy.api#httpQuery": "trafficpolicyversion" } - }, - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

    Specify the value of Id of the traffic policy for which you want to list all versions.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -5683,31 +5683,31 @@ "com.amazonaws.route53#ListTrafficPolicyVersionsResponse": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.route53#PageMaxItems", + "TrafficPolicyVersionMarker": { + "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", "traits": { - "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced \n\t\t\tthe current response.

    ", + "smithy.api#documentation": "

    If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy \n\t\t\tthat Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of \n\t\t\tTrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

    \n\t\t

    This element is present only if IsTruncated is true.

    ", "smithy.api#required": {} } }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", + "TrafficPolicies": { + "target": "com.amazonaws.route53#TrafficPolicies", "traits": { - "smithy.api#documentation": "

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of \n\t\t\ttraffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker \n\t\t\tin the marker parameter.

    ", + "smithy.api#documentation": "

    A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.

    ", "smithy.api#required": {} } }, - "TrafficPolicyVersionMarker": { - "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", + "MaxItems": { + "target": "com.amazonaws.route53#PageMaxItems", "traits": { - "smithy.api#documentation": "

    If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy \n\t\t\tthat Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of \n\t\t\tTrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

    \n\t\t

    This element is present only if IsTruncated is true.

    ", + "smithy.api#documentation": "

    The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced \n\t\t\tthe current response.

    ", "smithy.api#required": {} } }, - "TrafficPolicies": { - "target": "com.amazonaws.route53#TrafficPolicies", + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

    A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.

    ", + "smithy.api#documentation": "

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of \n\t\t\ttraffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker \n\t\t\tin the marker parameter.

    ", "smithy.api#required": {} } } @@ -5747,6 +5747,14 @@ "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest": { "type": "structure", "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.route53#MaxResults", "traits": { @@ -5760,14 +5768,6 @@ "smithy.api#documentation": "

    \n Optional: If a response includes a NextToken element, there are more VPCs \n\t\t\tthat can be associated with the specified hosted zone. To get the next page of results, submit another request, \n\t\t\tand include the value of NextToken from the response in the nexttoken parameter \n\t\t\tin another ListVPCAssociationAuthorizations request.

    ", "smithy.api#httpQuery": "nexttoken" } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -5777,10 +5777,10 @@ "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { "type": "structure", "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "VPCs": { + "target": "com.amazonaws.route53#VPCs", "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that you can associate the listed VPCs with.

    ", + "smithy.api#documentation": "

    The list of VPCs that are authorized to be associated with the specified hosted zone.

    ", "smithy.api#required": {} } }, @@ -5790,10 +5790,10 @@ "smithy.api#documentation": "

    When the response includes a NextToken element, there are more VPCs that can be associated \n\t\t\twith the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, \n\t\t\tand include the value of the NextToken element from the response in the nexttoken request parameter.

    " } }, - "VPCs": { - "target": "com.amazonaws.route53#VPCs", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    The list of VPCs that are authorized to be associated with the specified hosted zone.

    ", + "smithy.api#documentation": "

    The ID of the hosted zone that you can associate the listed VPCs with.

    ", "smithy.api#required": {} } } @@ -6088,17 +6088,17 @@ "smithy.api#required": {} } }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that CloudWatch Logs is logging queries for.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.

    ", "smithy.api#required": {} } }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.

    ", + "smithy.api#documentation": "

    The ID of the hosted zone that CloudWatch Logs is logging queries for.

    ", "smithy.api#required": {} } } @@ -6302,28 +6302,16 @@ "com.amazonaws.route53#ResourceRecordSet": { "type": "structure", "members": { - "SetIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", - "traits": { - "smithy.api#documentation": "

    \n Resource record sets that have a routing policy other than simple: An identifier that differentiates among \n\t\t\tmultiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named \n\t\t\tacme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier \n\t\t\tmust be unique for each resource record set.

    \n\t\t

    For information about routing policies, see \n\t\t\tChoosing a Routing Policy \n\t\t\tin the Amazon Route 53 Developer Guide.

    " - } - }, - "AliasTarget": { - "target": "com.amazonaws.route53#AliasTarget", - "traits": { - "smithy.api#documentation": "

    \n Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an \n\t\t\tAmazon S3 bucket, that you want to route traffic to.

    \n\t\t

    If you're creating resource records sets for a private hosted zone, note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      For information about creating failover resource record sets in a private hosted zone, see \n\t\t\t\t\tConfiguring Failover in a Private Hosted Zone in the\n\t\t\t\t\tAmazon Route 53 Developer Guide.

      \n\t\t\t
      • \n
    " - } - }, - "Weight": { - "target": "com.amazonaws.route53#ResourceRecordSetWeight", + "MultiValueAnswer": { + "target": "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer", "traits": { - "smithy.api#documentation": "

    \n Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, \n\t\t\ta value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the \n\t\t\tsum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries \n\t\t\tbased on the ratio of a resource's weight to the total. Note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      You must specify a value for the Weight element for every weighted resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can only specify one ResourceRecord per weighted resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can't create latency, failover, or geolocation resource record sets that have the same values for the \n\t\t\t\t\tName and Type elements as weighted resource record sets.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can create a maximum of 100 weighted resource record sets that have the same values for the Name and \n\t\t\t\t\tType elements.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a \n\t\t\t\t\tresource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set \n\t\t\t\t\t\tWeight to 0 for all resource record sets that have the same combination of DNS name and type, \n\t\t\t\t\ttraffic is routed to all resources with equal probability.

      \n\t\t\t\t

      The effect of setting Weight to 0 is different when you associate health checks with weighted \n\t\t\t\t\tresource record sets. For more information, see \n\t\t\t\t\tOptions for Configuring Route 53 Active-Active and Active-Passive Failover \n\t\t\t\t\tin the Amazon Route 53 Developer Guide.

      \n\t\t\t
      • \n
    " + "smithy.api#documentation": "

    \n Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, \n\t\t\tsuch as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. \n\t\t\tNote the following:

    \n\t\t
      \n
    • \n

      If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries \n\t\t\t\twith the corresponding IP address only when the health check is healthy.

      \n
      • \n
    • \n

      If you don't associate a health check with a multivalue answer record, Route 53 always considers the record \n\t\t\t\tto be healthy.

      \n
      • \n
    • \n

      Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, \n\t\t\t\tRoute 53 responds to all DNS queries with all the healthy records.

      \n
      • \n
    • \n

      If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of \n\t\t\t\thealthy records.

      \n
      • \n
    • \n

      When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

      \n
      • \n
    • \n

      If a resource becomes unavailable after a resolver caches a response, client software typically tries another \n\t\t\t\tof the IP addresses in the response.

      \n
      • \n
    \n\t\t

    You can't create multivalue answer alias records.

    " } }, - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", + "TTL": { + "target": "com.amazonaws.route53#TTL", "traits": { - "smithy.api#documentation": "

    If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a \n\t\t\thealth check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

    \n\t\t

    Route 53 determines whether a resource record set is healthy based on one of the following:

    \n\t\t
      \n
    • \n

      By periodically sending a request to the endpoint that is specified in the health check

      \n
      • \n
    • \n

      By aggregating the status of a specified group of health checks (calculated health checks)

      \n
      • \n
    • \n

      By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

      \n
      • \n
    \n\n\t\t \n\t\t\t

    Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint \n\t\t\t\tspecified by the IP address in the Value element. When you add a HealthCheckId element to a \n\t\t\t\tresource record set, Route 53 checks the health of the endpoint that you specified in the health check.

    \n\t\t     \n\n\t\t

    For more information, see the following topics in the Amazon Route 53 Developer Guide:

    \n\t\t \n\t\t\n\t\t

    \n When to Specify HealthCheckId\n

    \n\t\t

    Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets \n\t\t\tto respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks \n\t\t\tmakes sense only in the following configurations:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Non-alias resource record sets: You're checking the health of a group of non-alias \n\t\t\t\t\tresource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com \n\t\t\t\t\twith a type of A) and you specify health check IDs for all the resource record sets.

      \n\t\t\t\t

      If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it \n\t\t\t\t\tresponds to DNS queries with.

      \n\t\t\t\t

      If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value \n\t\t\t\t\tfor that resource record set.

      \n\t\t\t\t

      If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets \n\t\t\t\t\tin the group healthy and responds to DNS queries accordingly.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Alias resource record sets: You specify the following settings:

      \n\t\t\t\t
        \n
      • \n

        You set EvaluateTargetHealth to true for an alias resource record set in a group of \n\t\t\t\t\t\tresource record sets that have the same routing policy, name, and type (such as multiple weighted records named \n\t\t\t\t\t\twww.example.com with a type of A).

        \n
        • \n
      • \n

        You configure the alias resource record set to route traffic to a non-alias resource record set \n\t\t\t\t\t\tin the same hosted zone.

        \n
        • \n
      • \n

        You specify a health check ID for the non-alias resource record set.

        \n
        • \n
      \n\t\t\t\t

      If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the \n\t\t\t\t\talias record among the records that it responds to DNS queries with.

      \n\t\t\t\t

      If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

      \n\t\t\t\t \n\t\t\t\t\t

      The alias resource record set can also route traffic to a group of non-alias resource record sets \n\t\t\t\t\t\tthat have the same routing policy, name, and type. In that configuration, associate health checks with all of the \n\t\t\t\t\t\tresource record sets in the group of non-alias resource record sets.

      \n\t\t\t\t       \n\t\t\t
      • \n
    \n\t\t\n\t\t

    \n Geolocation Routing\n

    \n\t\t

    For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated \n\t\t\tgeographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, \n\t\t\tfor North America, and a resource record set that has * for CountryCode is *, which applies to \n\t\t\tall locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the \n\t\t\tfollowing order until it finds a resource record set for which the endpoint is healthy:

    \n\t\t\t
      \n
    • \n

      The United States

      \n
      • \n
    • \n

      North America

      \n
      • \n
    • \n

      The default resource record set

      \n
      • \n
    \n\t\t\n\t\t

    \n Specifying the Health Check Endpoint by Domain Name\n

    \n\t\t

    If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. \n\t\t\tFor example, create a health check for each HTTP server that is serving content for www.example.com. For the \n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), \n\t\t\tnot the name of the resource record sets (www.example.com).

    \n\t\t \n\t\t\t

    Health check results will be unpredictable if you do the following:

    \n\t\t\t
      \n
    • \n

      Create a health check that has the same value for FullyQualifiedDomainName as the name of a \n\t\t\t\t\tresource record set.

      \n
      • \n
    • \n

      Associate that health check with the resource record set.

      \n
      • \n
    \n\t\t     " + "smithy.api#documentation": "

    The resource record cache time to live (TTL), in seconds. Note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL \n\t\t\t\t\tfor the alias target.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), \n\t\t\t\t\twe recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the \n\t\t\t\t\talias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the \n\t\t\t\t\tnon-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for \n\t\t\t\t\tload balancers) will change the effect of the values that you specify for Weight.

      \n\t\t\t
      • \n
    " } }, "Region": { @@ -6332,41 +6320,47 @@ "smithy.api#documentation": "

    \n Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this \n\t\t\tresource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is \n\t\t\treferred to by an IP address or a DNS domain name, depending on the record type.

    \n\t\t \n\t\t\t

    Although creating latency and latency alias resource record sets in a private hosted zone is allowed, \n\t\t\t\tit's not supported.

    \n\t\t     \n\t\t

    When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 \n\t\t\tselects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then \n\t\t\treturns the value that is associated with the selected resource record set.

    \n\t\t

    Note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      You can only specify one ResourceRecord per latency resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can only create one latency resource record set for each Amazon EC2 Region.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the \n\t\t\t\t\tbest latency from among the regions that you create latency resource record sets for.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can't create non-latency resource record sets that have the same values for the Name and Type \n\t\t\t\t\telements as latency resource record sets.

      \n\t\t\t
      • \n
    " } }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

    The DNS record type. For information about different record types and how data is encoded for them, see \n\t\t\tSupported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

    \n\t\t

    Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | \n\t\t\tNAPTR | NS | PTR | SOA | SPF | SRV | TXT\n

    \n\t\t

    Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | \n\t\t\tCNAME | MX | NAPTR | PTR | SPF | SRV | TXT. \n\t\t\tWhen creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the \n\t\t\tresource record sets in the group.

    \n\t\t

    Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | \n\t\t\tPTR | SPF | SRV | TXT\n

    \n\t\t \n\t\t\t

    SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create \n\t\t\t\tresource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for \n\t\t\t\tAuthorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] \n\t\t\t\thave led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to \n\t\t\t\tuse it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

    \n\t\t     \n\t\t

    Values for alias resource record sets:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Amazon API Gateway custom regional APIs and edge-optimized APIs: \n A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n CloudFront distributions: \n A\n

      \n\t\t\t\t

      If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, \n\t\t\t\t\tone with a value of A and one with a value of AAAA.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Amazon API Gateway environment that has a regionalized subdomain: A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n ELB load balancers: \n A | AAAA\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Amazon S3 buckets: \n A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Amazon Virtual Private Cloud interface VPC endpoints \n A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Another resource record set in this hosted zone: Specify the type of the resource record set \n\t\t\t\t\tthat you're creating the alias for. All values are supported except NS and SOA.

      \n\t\t\t\t \n

      If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't \n\t\t\t\t\troute traffic to a record for which the value of Type is CNAME. This is because the alias record \n\t\t\t\t\tmust have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex \n\t\t\t\t\tisn't supported even for an alias record.

      \n       \n\t\t\t
      • \n
    ", + "smithy.api#required": {} + } + }, "GeoLocation": { "target": "com.amazonaws.route53#GeoLocation", "traits": { "smithy.api#documentation": "

    \n Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries \n\t\t\tbased on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address \n\t\t\tof 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of \n\t\t\tAF.

    \n\t\t \n\t\t\t

    Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, \n\t\t\t\tit's not supported.

    \n\t\t     \n\t\t

    If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and \n\t\t\tone for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a \n\t\t\tcontinent to one resource and to route queries for a country on that continent to a different resource.

    \n\t\t

    You can't create two geolocation resource record sets that specify the same geographic location.

    \n\t\t

    The value * in the CountryCode element matches all geographic locations that aren't specified in other \n\t\t\tgeolocation resource record sets that have the same values for the Name and Type elements.

    \n\t\t \n\t\t\t

    Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, \n\t\t\t\tso even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations \n\t\t\t\tthat it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. \n\t\t\t\tTwo groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't \n\t\t\t\tcreated geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a \n\t\t\t\t* resource record set, Route 53 returns a \"no answer\" response for queries from those locations.

    \n\t\t     \n\t\t

    You can't create non-geolocation resource record sets that have the same values for the Name and Type elements \n\t\t\tas geolocation resource record sets.

    " } }, - "ResourceRecords": { - "target": "com.amazonaws.route53#ResourceRecords", + "AliasTarget": { + "target": "com.amazonaws.route53#AliasTarget", "traits": { - "smithy.api#documentation": "

    Information about the resource records to act upon.

    \n\t\t \n

    If you're creating an alias resource record set, omit ResourceRecords.

    \n     " + "smithy.api#documentation": "

    \n Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an \n\t\t\tAmazon S3 bucket, that you want to route traffic to.

    \n\t\t

    If you're creating resource records sets for a private hosted zone, note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      For information about creating failover resource record sets in a private hosted zone, see \n\t\t\t\t\tConfiguring Failover in a Private Hosted Zone in the\n\t\t\t\t\tAmazon Route 53 Developer Guide.

      \n\t\t\t
      • \n
    " } }, - "Failover": { - "target": "com.amazonaws.route53#ResourceRecordSetFailover", + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", "traits": { - "smithy.api#documentation": "

    \n Failover resource record sets only: To configure failover, you add the Failover element to \n\t\t\ttwo resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other\n\t\t\tresource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the \n\t\t\thealth check that you want Amazon Route 53 to perform for each resource record set.

    \n\t\t

    Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both \n\t\t\tresource record sets:

    \n\t\t
      \n
    • \n\t\t\t\t

      When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the \n\t\t\t\t\tprimary resource record set regardless of the health of the secondary resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to \n\t\t\t\t\tDNS queries with the applicable value from the secondary resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the \n\t\t\t\t\tprimary resource record set regardless of the health of the primary resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set \n\t\t\t\t\tis unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true \n\t\t\t\t\tregardless of the health of the associated endpoint.

      \n\t\t\t
      • \n
    \n\t\t

    You can't create non-failover resource record sets that have the same values for the Name and Type elements \n\t\t\tas failover resource record sets.

    \n\t\t

    For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

    \n\t\t

    For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

    \n\t\t " + "smithy.api#documentation": "

    If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a \n\t\t\thealth check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

    \n\t\t

    Route 53 determines whether a resource record set is healthy based on one of the following:

    \n\t\t
      \n
    • \n

      By periodically sending a request to the endpoint that is specified in the health check

      \n
      • \n
    • \n

      By aggregating the status of a specified group of health checks (calculated health checks)

      \n
      • \n
    • \n

      By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

      \n
      • \n
    \n\n\t\t \n\t\t\t

    Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint \n\t\t\t\tspecified by the IP address in the Value element. When you add a HealthCheckId element to a \n\t\t\t\tresource record set, Route 53 checks the health of the endpoint that you specified in the health check.

    \n\t\t     \n\n\t\t

    For more information, see the following topics in the Amazon Route 53 Developer Guide:

    \n\t\t \n\t\t\n\t\t

    \n When to Specify HealthCheckId\n

    \n\t\t

    Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets \n\t\t\tto respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks \n\t\t\tmakes sense only in the following configurations:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Non-alias resource record sets: You're checking the health of a group of non-alias \n\t\t\t\t\tresource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com \n\t\t\t\t\twith a type of A) and you specify health check IDs for all the resource record sets.

      \n\t\t\t\t

      If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it \n\t\t\t\t\tresponds to DNS queries with.

      \n\t\t\t\t

      If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value \n\t\t\t\t\tfor that resource record set.

      \n\t\t\t\t

      If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets \n\t\t\t\t\tin the group healthy and responds to DNS queries accordingly.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Alias resource record sets: You specify the following settings:

      \n\t\t\t\t
        \n
      • \n

        You set EvaluateTargetHealth to true for an alias resource record set in a group of \n\t\t\t\t\t\tresource record sets that have the same routing policy, name, and type (such as multiple weighted records named \n\t\t\t\t\t\twww.example.com with a type of A).

        \n
        • \n
      • \n

        You configure the alias resource record set to route traffic to a non-alias resource record set \n\t\t\t\t\t\tin the same hosted zone.

        \n
        • \n
      • \n

        You specify a health check ID for the non-alias resource record set.

        \n
        • \n
      \n\t\t\t\t

      If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the \n\t\t\t\t\talias record among the records that it responds to DNS queries with.

      \n\t\t\t\t

      If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

      \n\t\t\t\t \n\t\t\t\t\t

      The alias resource record set can also route traffic to a group of non-alias resource record sets \n\t\t\t\t\t\tthat have the same routing policy, name, and type. In that configuration, associate health checks with all of the \n\t\t\t\t\t\tresource record sets in the group of non-alias resource record sets.

      \n\t\t\t\t       \n\t\t\t
      • \n
    \n\t\t\n\t\t

    \n Geolocation Routing\n

    \n\t\t

    For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated \n\t\t\tgeographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, \n\t\t\tfor North America, and a resource record set that has * for CountryCode is *, which applies to \n\t\t\tall locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the \n\t\t\tfollowing order until it finds a resource record set for which the endpoint is healthy:

    \n\t\t\t
      \n
    • \n

      The United States

      \n
      • \n
    • \n

      North America

      \n
      • \n
    • \n

      The default resource record set

      \n
      • \n
    \n\t\t\n\t\t

    \n Specifying the Health Check Endpoint by Domain Name\n

    \n\t\t

    If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. \n\t\t\tFor example, create a health check for each HTTP server that is serving content for www.example.com. For the \n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), \n\t\t\tnot the name of the resource record sets (www.example.com).

    \n\t\t \n\t\t\t

    Health check results will be unpredictable if you do the following:

    \n\t\t\t
      \n
    • \n

      Create a health check that has the same value for FullyQualifiedDomainName as the name of a \n\t\t\t\t\tresource record set.

      \n
      • \n
    • \n

      Associate that health check with the resource record set.

      \n
      • \n
    \n\t\t     " } }, - "Type": { - "target": "com.amazonaws.route53#RRType", + "ResourceRecords": { + "target": "com.amazonaws.route53#ResourceRecords", "traits": { - "smithy.api#documentation": "

    The DNS record type. For information about different record types and how data is encoded for them, see \n\t\t\tSupported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

    \n\t\t

    Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | \n\t\t\tNAPTR | NS | PTR | SOA | SPF | SRV | TXT\n

    \n\t\t

    Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | \n\t\t\tCNAME | MX | NAPTR | PTR | SPF | SRV | TXT. \n\t\t\tWhen creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the \n\t\t\tresource record sets in the group.

    \n\t\t

    Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | \n\t\t\tPTR | SPF | SRV | TXT\n

    \n\t\t \n\t\t\t

    SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create \n\t\t\t\tresource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for \n\t\t\t\tAuthorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] \n\t\t\t\thave led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to \n\t\t\t\tuse it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

    \n\t\t     \n\t\t

    Values for alias resource record sets:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Amazon API Gateway custom regional APIs and edge-optimized APIs: \n A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n CloudFront distributions: \n A\n

      \n\t\t\t\t

      If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, \n\t\t\t\t\tone with a value of A and one with a value of AAAA.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Amazon API Gateway environment that has a regionalized subdomain: A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n ELB load balancers: \n A | AAAA\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Amazon S3 buckets: \n A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Amazon Virtual Private Cloud interface VPC endpoints \n A\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Another resource record set in this hosted zone: Specify the type of the resource record set \n\t\t\t\t\tthat you're creating the alias for. All values are supported except NS and SOA.

      \n\t\t\t\t \n

      If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't \n\t\t\t\t\troute traffic to a record for which the value of Type is CNAME. This is because the alias record \n\t\t\t\t\tmust have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex \n\t\t\t\t\tisn't supported even for an alias record.

      \n       \n\t\t\t
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Information about the resource records to act upon.

    \n\t\t \n

    If you're creating an alias resource record set, omit ResourceRecords.

    \n     " } }, - "TTL": { - "target": "com.amazonaws.route53#TTL", + "SetIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", "traits": { - "smithy.api#documentation": "

    The resource record cache time to live (TTL), in seconds. Note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL \n\t\t\t\t\tfor the alias target.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), \n\t\t\t\t\twe recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the \n\t\t\t\t\talias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the \n\t\t\t\t\tnon-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for \n\t\t\t\t\tload balancers) will change the effect of the values that you specify for Weight.

      \n\t\t\t
      • \n
    " + "smithy.api#documentation": "

    \n Resource record sets that have a routing policy other than simple: An identifier that differentiates among \n\t\t\tmultiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named \n\t\t\tacme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier \n\t\t\tmust be unique for each resource record set.

    \n\t\t

    For information about routing policies, see \n\t\t\tChoosing a Routing Policy \n\t\t\tin the Amazon Route 53 Developer Guide.

    " } }, - "MultiValueAnswer": { - "target": "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer", + "Weight": { + "target": "com.amazonaws.route53#ResourceRecordSetWeight", "traits": { - "smithy.api#documentation": "

    \n Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, \n\t\t\tsuch as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. \n\t\t\tNote the following:

    \n\t\t
      \n
    • \n

      If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries \n\t\t\t\twith the corresponding IP address only when the health check is healthy.

      \n
      • \n
    • \n

      If you don't associate a health check with a multivalue answer record, Route 53 always considers the record \n\t\t\t\tto be healthy.

      \n
      • \n
    • \n

      Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, \n\t\t\t\tRoute 53 responds to all DNS queries with all the healthy records.

      \n
      • \n
    • \n

      If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of \n\t\t\t\thealthy records.

      \n
      • \n
    • \n

      When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

      \n
      • \n
    • \n

      If a resource becomes unavailable after a resolver caches a response, client software typically tries another \n\t\t\t\tof the IP addresses in the response.

      \n
      • \n
    \n\t\t

    You can't create multivalue answer alias records.

    " + "smithy.api#documentation": "

    \n Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, \n\t\t\ta value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the \n\t\t\tsum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries \n\t\t\tbased on the ratio of a resource's weight to the total. Note the following:

    \n\t\t
      \n
    • \n\t\t\t\t

      You must specify a value for the Weight element for every weighted resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can only specify one ResourceRecord per weighted resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can't create latency, failover, or geolocation resource record sets that have the same values for the \n\t\t\t\t\tName and Type elements as weighted resource record sets.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      You can create a maximum of 100 weighted resource record sets that have the same values for the Name and \n\t\t\t\t\tType elements.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a \n\t\t\t\t\tresource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set \n\t\t\t\t\t\tWeight to 0 for all resource record sets that have the same combination of DNS name and type, \n\t\t\t\t\ttraffic is routed to all resources with equal probability.

      \n\t\t\t\t

      The effect of setting Weight to 0 is different when you associate health checks with weighted \n\t\t\t\t\tresource record sets. For more information, see \n\t\t\t\t\tOptions for Configuring Route 53 Active-Active and Active-Passive Failover \n\t\t\t\t\tin the Amazon Route 53 Developer Guide.

      \n\t\t\t
      • \n
    " } }, "Name": { @@ -6381,6 +6375,12 @@ "traits": { "smithy.api#documentation": "

    When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID \n\t\t\tof the traffic policy instance that Route 53 created this resource record set for.

    \n\t\t \n

    To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. \n\t\t\tRoute 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, \n\t\t\tRoute 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

    \n\t\t     " } + }, + "Failover": { + "target": "com.amazonaws.route53#ResourceRecordSetFailover", + "traits": { + "smithy.api#documentation": "

    \n Failover resource record sets only: To configure failover, you add the Failover element to \n\t\t\ttwo resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other\n\t\t\tresource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the \n\t\t\thealth check that you want Amazon Route 53 to perform for each resource record set.

    \n\t\t

    Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both \n\t\t\tresource record sets:

    \n\t\t
      \n
    • \n\t\t\t\t

      When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the \n\t\t\t\t\tprimary resource record set regardless of the health of the secondary resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to \n\t\t\t\t\tDNS queries with the applicable value from the secondary resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the \n\t\t\t\t\tprimary resource record set regardless of the health of the primary resource record set.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set \n\t\t\t\t\tis unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true \n\t\t\t\t\tregardless of the health of the associated endpoint.

      \n\t\t\t
      • \n
    \n\t\t

    You can't create non-failover resource record sets that have the same values for the Name and Type elements \n\t\t\tas failover resource record sets.

    \n\t\t

    For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

    \n\t\t

    For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

    \n\t\t " + } } }, "traits": { @@ -6689,17 +6689,17 @@ "com.amazonaws.route53#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.route53#TagKey", - "traits": { - "smithy.api#documentation": "

    The value of Key depends on the operation that you want to perform:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Edit a tag: Key is the name of the tag that you want to change the Value for.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Delete a key: Key is the name of the tag you want to remove.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, \n\t\t\t\t\tthe list of your health checks includes a Name column that lets you see the name that you've \n\t\t\t\t\tgiven to each health check.

      \n\t\t\t
      • \n
    " - } - }, "Value": { "target": "com.amazonaws.route53#TagValue", "traits": { "smithy.api#documentation": "

    The value of Value depends on the operation that you want to perform:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Add a tag to a health check or hosted zone: Value is the value that you want to give \n\t\t\t\t\tthe new tag.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Edit a tag: Value is the new value that you want to assign the tag.

      \n\t\t\t
      • \n
    " } + }, + "Key": { + "target": "com.amazonaws.route53#TagKey", + "traits": { + "smithy.api#documentation": "

    The value of Key depends on the operation that you want to perform:

    \n\t\t
      \n
    • \n\t\t\t\t

      \n Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Edit a tag: Key is the name of the tag that you want to change the Value for.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Delete a key: Key is the name of the tag you want to remove.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, \n\t\t\t\t\tthe list of your health checks includes a Name column that lets you see the name that you've \n\t\t\t\t\tgiven to each health check.

      \n\t\t\t
      • \n
    " + } } }, "traits": { @@ -6819,11 +6819,11 @@ "com.amazonaws.route53#TestDNSAnswerRequest": { "type": "structure", "members": { - "ResolverIP": { - "target": "com.amazonaws.route53#IPAddress", + "EDNS0ClientSubnetMask": { + "target": "com.amazonaws.route53#SubnetMask", "traits": { - "smithy.api#documentation": "

    If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. \n\t\t\tIf you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region \n\t\t\t(us-east-1).

    ", - "smithy.api#httpQuery": "resolverip" + "smithy.api#documentation": "

    If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address \n\t\t\tthat you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for \n\t\t\tedns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from \n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.

    \n\t\t

    The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address:

    \n\t\t
      \n
    • \n

      \n IPv4: Specify a value between 0 and 32

      \n
      • \n
    • \n

      \n IPv6: Specify a value between 0 and 128

      \n
      • \n
    ", + "smithy.api#httpQuery": "edns0clientsubnetmask" } }, "HostedZoneId": { @@ -6834,6 +6834,20 @@ "smithy.api#required": {} } }, + "EDNS0ClientSubnetIP": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

    If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client \n\t\t\tin the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

    ", + "smithy.api#httpQuery": "edns0clientsubnetip" + } + }, + "ResolverIP": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

    If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. \n\t\t\tIf you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region \n\t\t\t(us-east-1).

    ", + "smithy.api#httpQuery": "resolverip" + } + }, "RecordName": { "target": "com.amazonaws.route53#DNSName", "traits": { @@ -6842,13 +6856,6 @@ "smithy.api#required": {} } }, - "EDNS0ClientSubnetMask": { - "target": "com.amazonaws.route53#SubnetMask", - "traits": { - "smithy.api#documentation": "

    If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address \n\t\t\tthat you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for \n\t\t\tedns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from \n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.

    \n\t\t

    The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address:

    \n\t\t
      \n
    • \n

      \n IPv4: Specify a value between 0 and 32

      \n
      • \n
    • \n

      \n IPv6: Specify a value between 0 and 128

      \n
      • \n
    ", - "smithy.api#httpQuery": "edns0clientsubnetmask" - } - }, "RecordType": { "target": "com.amazonaws.route53#RRType", "traits": { @@ -6856,13 +6863,6 @@ "smithy.api#httpQuery": "recordtype", "smithy.api#required": {} } - }, - "EDNS0ClientSubnetIP": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

    If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client \n\t\t\tin the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

    ", - "smithy.api#httpQuery": "edns0clientsubnetip" - } } }, "traits": { @@ -6872,10 +6872,10 @@ "com.amazonaws.route53#TestDNSAnswerResponse": { "type": "structure", "members": { - "Nameserver": { - "target": "com.amazonaws.route53#Nameserver", + "RecordType": { + "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

    The Amazon Route 53 name server used to respond to the request.

    ", + "smithy.api#documentation": "

    The type of the resource record set that you submitted a request for.

    ", "smithy.api#required": {} } }, @@ -6886,17 +6886,17 @@ "smithy.api#required": {} } }, - "RecordName": { - "target": "com.amazonaws.route53#DNSName", + "ResponseCode": { + "target": "com.amazonaws.route53#DNSRCode", "traits": { - "smithy.api#documentation": "

    The name of the resource record set that you submitted a request for.

    ", + "smithy.api#documentation": "

    A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that \n\t\t\tthe request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. \n\t\t\tFor a list of possible response codes, see \n\t\t\tDNS RCODES on the IANA website.

    ", "smithy.api#required": {} } }, - "ResponseCode": { - "target": "com.amazonaws.route53#DNSRCode", + "RecordName": { + "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

    A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that \n\t\t\tthe request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. \n\t\t\tFor a list of possible response codes, see \n\t\t\tDNS RCODES on the IANA website.

    ", + "smithy.api#documentation": "

    The name of the resource record set that you submitted a request for.

    ", "smithy.api#required": {} } }, @@ -6907,10 +6907,10 @@ "smithy.api#required": {} } }, - "RecordType": { - "target": "com.amazonaws.route53#RRType", + "Nameserver": { + "target": "com.amazonaws.route53#Nameserver", "traits": { - "smithy.api#documentation": "

    The type of the resource record set that you submitted a request for.

    ", + "smithy.api#documentation": "

    The Amazon Route 53 name server used to respond to the request.

    ", "smithy.api#required": {} } } @@ -7045,6 +7045,13 @@ "com.amazonaws.route53#TrafficPolicy": { "type": "structure", "members": { + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "

    The definition of a traffic policy in JSON format. You specify the JSON document to use for a new \n\t\t\ttraffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see \n\t\t\tTraffic Policy Document Format.

    ", + "smithy.api#required": {} + } + }, "Type": { "target": "com.amazonaws.route53#RRType", "traits": { @@ -7065,10 +7072,10 @@ "smithy.api#required": {} } }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

    The definition of a traffic policy in JSON format. You specify the JSON document to use for a new \n\t\t\ttraffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see \n\t\t\tTraffic Policy Document Format.

    ", + "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to a traffic policy when you created it.

    ", "smithy.api#required": {} } }, @@ -7078,13 +7085,6 @@ "smithy.api#documentation": "

    The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, \n\t\t\tthe value of Version is always 1.

    ", "smithy.api#required": {} } - }, - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to a traffic policy when you created it.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -7153,31 +7153,31 @@ "com.amazonaws.route53#TrafficPolicyInstance": { "type": "structure", "members": { - "TTL": { - "target": "com.amazonaws.route53#TTL", + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", "traits": { - "smithy.api#documentation": "

    The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

    ", + "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the new traffic policy instance.

    ", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "State": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceState", "traits": { - "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the new traffic policy instance.

    ", + "smithy.api#documentation": "

    The value of State is one of the following values:

    \n\t\t
    \n
    Applied
    \n
    \n

    Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.

    \n
    \n
    Creating
    \n
    \n

    Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the \n\t\t\t\t\tCreateTrafficPolicyInstance request completed successfully.

    \n
    \n
    Failed
    \n
    \n

    Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, \n\t\t\t\t\tsee Message for an explanation of what caused the request to fail.

    \n
    \n
    ", "smithy.api#required": {} } }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", + "TrafficPolicyType": { + "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

    The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

    ", + "smithy.api#documentation": "

    The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.route53#DNSName", + "TTL": { + "target": "com.amazonaws.route53#TTL", "traits": { - "smithy.api#documentation": "

    The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the \n\t\t\tresource record sets that are associated with this traffic policy instance.

    ", + "smithy.api#documentation": "

    The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

    ", "smithy.api#required": {} } }, @@ -7188,31 +7188,31 @@ "smithy.api#required": {} } }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

    ", + "smithy.api#documentation": "

    The ID of the hosted zone that Amazon Route 53 created resource record sets in.

    ", "smithy.api#required": {} } }, - "TrafficPolicyType": { - "target": "com.amazonaws.route53#RRType", + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

    The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

    ", + "smithy.api#documentation": "

    The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

    ", "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceState", + "Name": { + "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

    The value of State is one of the following values:

    \n\t\t
    \n
    Applied
    \n
    \n

    Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.

    \n
    \n
    Creating
    \n
    \n

    Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the \n\t\t\t\t\tCreateTrafficPolicyInstance request completed successfully.

    \n
    \n
    Failed
    \n
    \n

    Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, \n\t\t\t\t\tsee Message for an explanation of what caused the request to fail.

    \n
    \n
    ", + "smithy.api#documentation": "

    The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the \n\t\t\tresource record sets that are associated with this traffic policy instance.

    ", "smithy.api#required": {} } }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

    The ID of the hosted zone that Amazon Route 53 created resource record sets in.

    ", + "smithy.api#documentation": "

    The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

    ", "smithy.api#required": {} } } @@ -7292,31 +7292,31 @@ "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.route53#RRType", + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

    The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy \n\t\t\tto create a traffic policy instance.

    ", + "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the traffic policy when you created it.

    ", "smithy.api#required": {} } }, - "LatestVersion": { + "TrafficPolicyCount": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

    The version number of the latest version of the traffic policy.

    ", + "smithy.api#documentation": "

    The number of traffic policies that are associated with the current AWS account.

    ", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", + "Type": { + "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

    The ID that Amazon Route 53 assigned to the traffic policy when you created it.

    ", + "smithy.api#documentation": "

    The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy \n\t\t\tto create a traffic policy instance.

    ", "smithy.api#required": {} } }, - "TrafficPolicyCount": { + "LatestVersion": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

    The number of traffic policies that are associated with the current AWS account.

    ", + "smithy.api#documentation": "

    The version number of the latest version of the traffic policy.

    ", "smithy.api#required": {} } } @@ -7378,34 +7378,34 @@ "com.amazonaws.route53#UpdateHealthCheckRequest": { "type": "structure", "members": { - "Disabled": { - "target": "com.amazonaws.route53#Disabled", + "Regions": { + "target": "com.amazonaws.route53#HealthCheckRegionList", "traits": { - "smithy.api#documentation": "

    Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

    \n\t\t
      \n
    • \n

      \n Health checks that check the health of endpoints: \n\t\t\t\tRoute 53 stops submitting requests to your application, server, or other resource.

      \n
      • \n
    • \n

      \n Calculated health checks: \n\t\t\t\tRoute 53 stops aggregating the status of the referenced health checks.

      \n
      • \n
    • \n

      \n Health checks that monitor CloudWatch alarms: \n\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

      \n
      • \n
    \n\t\t\t\n\t\t

    After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, \n\t\t\tRoute 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of \n\t\t\tInverted.\n\t\t

    \n\t\t\n\t\t

    Charges for a health check still apply when the health check is disabled. For more information, see \n\t\t\tAmazon Route 53 Pricing.

    " + "smithy.api#documentation": "

    A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check \n\t\t\tthe specified endpoint from.

    " } }, - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", + "HealthCheckVersion": { + "target": "com.amazonaws.route53#HealthCheckVersion", "traits": { - "smithy.api#documentation": "

    The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for \n\t\t\tIPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName \n\t\t\tat the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then \n\t\t\tchecks the health of the endpoint.

    \n\t\t

    Use one of the following formats for the value of IPAddress:

    \n\t\t
      \n
    • \n

      \n IPv4 address: four values between 0 and 255, separated by periods (.), \n\t\t\t\tfor example, 192.0.2.44.

      \n
      • \n
    • \n

      \n IPv6 address: eight groups of four hexadecimal values, separated by colons (:), \n\t\t\t\tfor example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, \n\t\t\t\tfor example, 2001:db8:85a3::abcd:1:2345.

      \n
      • \n
    \n\t\t

    If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and \n\t\t\tspecify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, \n\t\t\tsee the applicable documentation:

    \n\t\t \n\t\t \n

    If a health check already has a value for IPAddress, you can change the value. However, you can't update an \n\t\t\texisting health check to add or remove the value of IPAddress.

    \n\t\t     \n\t\t

    For more information, see \n\t\t\tFullyQualifiedDomainName.\n\t\t

    \n\t\t

    Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or \n\t\t\tmulticast ranges. For more information about IP addresses for which you can't create health checks, see the following \n\t\t\tdocuments:

    \n\t\t " + "smithy.api#documentation": "

    A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you \n\t\t\tupdate settings for the health check.

    \n\t\t

    We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of \n\t\t\tHealthCheckVersion for the health check that you want to update, and that you include that value in your \n\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

    \n\t\t
      \n
    • \n\t\t\t\t

      If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the \n\t\t\t\t\thealth check, Route 53 updates the health check with the new settings.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If the value of HealthCheckVersion in the health check is greater, the health check was changed after you \n\t\t\t\t\tgot the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

      \n\t\t\t
      • \n
    " } }, - "AlarmIdentifier": { - "target": "com.amazonaws.route53#AlarmIdentifier", + "FailureThreshold": { + "target": "com.amazonaws.route53#FailureThreshold", "traits": { - "smithy.api#documentation": "

    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether \n\t\t\tthe specified health check is healthy.

    " + "smithy.api#documentation": "

    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint \n\t\t\tfrom unhealthy to healthy or vice versa. For more information, see \n\t\t\tHow Amazon Route 53 Determines Whether an Endpoint Is Healthy \n\t\t\tin the Amazon Route 53 Developer Guide.

    \n\t\t

    If you don't specify a value for FailureThreshold, the default value is three health checks.

    " } }, - "Port": { - "target": "com.amazonaws.route53#Port", + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", "traits": { - "smithy.api#documentation": "

    The port on the endpoint that you want Amazon Route 53 to perform health checks on.

    \n\t\t \n\t\t\t

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or \n\t\t\t\tCALCULATED.

    \n\t\t     " + "smithy.api#documentation": "

    When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign \n\t\t\tto the health check:

    \n\t\t
      \n
    • \n

      \n Healthy: Route 53 considers the health check to be healthy.

      \n
      • \n
    • \n

      \n Unhealthy: Route 53 considers the health check to be unhealthy.

      \n
      • \n
    • \n

      \n LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data \n\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

      \n
      • \n
    " } }, - "ResourcePath": { - "target": "com.amazonaws.route53#ResourcePath", + "SearchString": { + "target": "com.amazonaws.route53#SearchString", "traits": { - "smithy.api#documentation": "

    The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint \n\t\t\twill return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. \n\t\t\tYou can also include query string parameters, for example, /welcome.html?language=jp&login=y.

    \n\t\t

    Specify this value only if you want to change it.

    " + "smithy.api#documentation": "

    If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want \n\t\t\tAmazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers \n\t\t\tthe resource healthy. (You can't change the value of Type when you update a health check.)

    " } }, "Inverted": { @@ -7414,40 +7414,40 @@ "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it \n\t\t\totherwise would be considered healthy.

    " } }, - "EnableSNI": { - "target": "com.amazonaws.route53#EnableSNI", + "ResourcePath": { + "target": "com.amazonaws.route53#ResourcePath", "traits": { - "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello\n\t\t\tmessage during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable \n\t\t\tSSL/TLS certificate.

    \n\t\t

    Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, \n\t\t\tthe status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. \n\t\t\tIf SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

    \n\t\t

    The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more \n\t\t\tin the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for \n\t\t\tFullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not \n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the \n\t\t\tsecond attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

    " + "smithy.api#documentation": "

    The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint \n\t\t\twill return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. \n\t\t\tYou can also include query string parameters, for example, /welcome.html?language=jp&login=y.

    \n\t\t

    Specify this value only if you want to change it.

    " } }, - "FailureThreshold": { - "target": "com.amazonaws.route53#FailureThreshold", + "FullyQualifiedDomainName": { + "target": "com.amazonaws.route53#FullyQualifiedDomainName", "traits": { - "smithy.api#documentation": "

    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint \n\t\t\tfrom unhealthy to healthy or vice versa. For more information, see \n\t\t\tHow Amazon Route 53 Determines Whether an Endpoint Is Healthy \n\t\t\tin the Amazon Route 53 Developer Guide.

    \n\t\t

    If you don't specify a value for FailureThreshold, the default value is three health checks.

    " + "smithy.api#documentation": "

    Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

    \n\t\t\n\t\t \n

    If a health check already has a value for IPAddress, you can change the value. However, you can't update an \n\t\t\texisting health check to add or remove the value of IPAddress.

    \n     \n\t\t\n\t\t

    \n If you specify a value for \n IPAddress:

    \n\t\t

    Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

    \n\t\t

    When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\t\n FullyQualifiedDomainName:Port\n to the endpoint in the Host header.

      \n\t\t\t
      • \n
    \n\t\t

    If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress \n\t\t\tin the Host header in each of the above cases.

    \n\t\t\n\t\t

    \n If you don't specify a value for \n IPAddress:

    \n\t\t

    If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in \n\t\t\tFullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is \n\t\t\treturned by DNS, Route 53 then checks the health of the endpoint.

    \n\t\t \n

    If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. \n\t\t\tIf there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, \n\t\t\tthe health check fails with a \"DNS resolution failed\" error.

    \n     \n\t\t

    If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

    \n\t\t \n\t\t\t

    In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and \n\t\t\t\tyou then associate the health check with those resource record sets, health check results will be unpredictable.

    \n\t\t     \n\t\t

    In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does \n\t\t\twhen you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a \n\t\t\tHost header.

    " } }, - "Regions": { - "target": "com.amazonaws.route53#HealthCheckRegionList", + "EnableSNI": { + "target": "com.amazonaws.route53#EnableSNI", "traits": { - "smithy.api#documentation": "

    A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check \n\t\t\tthe specified endpoint from.

    " + "smithy.api#documentation": "

    Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello\n\t\t\tmessage during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable \n\t\t\tSSL/TLS certificate.

    \n\t\t

    Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, \n\t\t\tthe status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. \n\t\t\tIf SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

    \n\t\t

    The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more \n\t\t\tin the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for \n\t\t\tFullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not \n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the \n\t\t\tsecond attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

    " } }, - "FullyQualifiedDomainName": { - "target": "com.amazonaws.route53#FullyQualifiedDomainName", + "Disabled": { + "target": "com.amazonaws.route53#Disabled", "traits": { - "smithy.api#documentation": "

    Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

    \n\t\t\n\t\t \n

    If a health check already has a value for IPAddress, you can change the value. However, you can't update an \n\t\t\texisting health check to add or remove the value of IPAddress.

    \n     \n\t\t\n\t\t

    \n If you specify a value for \n IPAddress:

    \n\t\t

    Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

    \n\t\t

    When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

    \n\t\t
      \n
    • \n\t\t\t\t

      If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\t\n FullyQualifiedDomainName:Port\n to the endpoint in the Host header.

      \n\t\t\t
      • \n
    \n\t\t

    If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress \n\t\t\tin the Host header in each of the above cases.

    \n\t\t\n\t\t

    \n If you don't specify a value for \n IPAddress:

    \n\t\t

    If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in \n\t\t\tFullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is \n\t\t\treturned by DNS, Route 53 then checks the health of the endpoint.

    \n\t\t \n

    If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. \n\t\t\tIf there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, \n\t\t\tthe health check fails with a \"DNS resolution failed\" error.

    \n     \n\t\t

    If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

    \n\t\t \n\t\t\t

    In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and \n\t\t\t\tyou then associate the health check with those resource record sets, health check results will be unpredictable.

    \n\t\t     \n\t\t

    In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does \n\t\t\twhen you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a \n\t\t\tHost header.

    " + "smithy.api#documentation": "

    Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

    \n\t\t
      \n
    • \n

      \n Health checks that check the health of endpoints: \n\t\t\t\tRoute 53 stops submitting requests to your application, server, or other resource.

      \n
      • \n
    • \n

      \n Calculated health checks: \n\t\t\t\tRoute 53 stops aggregating the status of the referenced health checks.

      \n
      • \n
    • \n

      \n Health checks that monitor CloudWatch alarms: \n\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

      \n
      • \n
    \n\t\t\t\n\t\t

    After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, \n\t\t\tRoute 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of \n\t\t\tInverted.\n\t\t

    \n\t\t\n\t\t

    Charges for a health check still apply when the health check is disabled. For more information, see \n\t\t\tAmazon Route 53 Pricing.

    " } }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "ChildHealthChecks": { + "target": "com.amazonaws.route53#ChildHealthCheckList", "traits": { - "smithy.api#documentation": "

    When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign \n\t\t\tto the health check:

    \n\t\t
      \n
    • \n

      \n Healthy: Route 53 considers the health check to be healthy.

      \n
      • \n
    • \n

      \n Unhealthy: Route 53 considers the health check to be unhealthy.

      \n
      • \n
    • \n

      \n LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data \n\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

      \n
      • \n
    " + "smithy.api#documentation": "

    A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a \n\t\t\tCALCULATED health check.

    " } }, - "SearchString": { - "target": "com.amazonaws.route53#SearchString", + "AlarmIdentifier": { + "target": "com.amazonaws.route53#AlarmIdentifier", "traits": { - "smithy.api#documentation": "

    If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want \n\t\t\tAmazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers \n\t\t\tthe resource healthy. (You can't change the value of Type when you update a health check.)

    " + "smithy.api#documentation": "

    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether \n\t\t\tthe specified health check is healthy.

    " } }, "HealthCheckId": { @@ -7458,10 +7458,10 @@ "smithy.api#required": {} } }, - "HealthCheckVersion": { - "target": "com.amazonaws.route53#HealthCheckVersion", + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", "traits": { - "smithy.api#documentation": "

    A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you \n\t\t\tupdate settings for the health check.

    \n\t\t

    We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of \n\t\t\tHealthCheckVersion for the health check that you want to update, and that you include that value in your \n\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

    \n\t\t
      \n
    • \n\t\t\t\t

      If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the \n\t\t\t\t\thealth check, Route 53 updates the health check with the new settings.

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      If the value of HealthCheckVersion in the health check is greater, the health check was changed after you \n\t\t\t\t\tgot the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

      \n\t\t\t
      • \n
    " + "smithy.api#documentation": "

    The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for \n\t\t\tIPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName \n\t\t\tat the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then \n\t\t\tchecks the health of the endpoint.

    \n\t\t

    Use one of the following formats for the value of IPAddress:

    \n\t\t
      \n
    • \n

      \n IPv4 address: four values between 0 and 255, separated by periods (.), \n\t\t\t\tfor example, 192.0.2.44.

      \n
      • \n
    • \n

      \n IPv6 address: eight groups of four hexadecimal values, separated by colons (:), \n\t\t\t\tfor example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, \n\t\t\t\tfor example, 2001:db8:85a3::abcd:1:2345.

      \n
      • \n
    \n\t\t

    If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and \n\t\t\tspecify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, \n\t\t\tsee the applicable documentation:

    \n\t\t \n\t\t \n

    If a health check already has a value for IPAddress, you can change the value. However, you can't update an \n\t\t\texisting health check to add or remove the value of IPAddress.

    \n\t\t     \n\t\t

    For more information, see \n\t\t\tFullyQualifiedDomainName.\n\t\t

    \n\t\t

    Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or \n\t\t\tmulticast ranges. For more information about IP addresses for which you can't create health checks, see the following \n\t\t\tdocuments:

    \n\t\t " } }, "HealthThreshold": { @@ -7476,10 +7476,10 @@ "smithy.api#documentation": "

    A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. \n\t\t\tValid values for ResettableElementName include the following:

    \n\t\t
      \n
    • \n

      \n ChildHealthChecks: Amazon Route 53 resets \n\t\t\t\tChildHealthChecks \n\t\t\t\tto null.

      \n
      • \n
    • \n

      \n FullyQualifiedDomainName: Route 53 resets \n\t\t\t\tFullyQualifiedDomainName.\n\t\t\t\tto null.

      \n
      • \n
    • \n

      \n Regions: Route 53 resets the \n\t\t\t\tRegions \n\t\t\t\tlist to the default set of regions.

      \n
      • \n
    • \n

      \n ResourcePath: Route 53 resets \n\t\t\t\tResourcePath \n\t\t\t\tto null.

      \n
      • \n
    " } }, - "ChildHealthChecks": { - "target": "com.amazonaws.route53#ChildHealthCheckList", + "Port": { + "target": "com.amazonaws.route53#Port", "traits": { - "smithy.api#documentation": "

    A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a \n\t\t\tCALCULATED health check.

    " + "smithy.api#documentation": "

    The port on the endpoint that you want Amazon Route 53 to perform health checks on.

    \n\t\t \n\t\t\t

    Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or \n\t\t\t\tCALCULATED.

    \n\t\t     " } } }, @@ -7530,6 +7530,12 @@ "com.amazonaws.route53#UpdateHostedZoneCommentRequest": { "type": "structure", "members": { + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

    The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the \n\t\t\tComment element, if any.

    " + } + }, "Id": { "target": "com.amazonaws.route53#ResourceId", "traits": { @@ -7537,12 +7543,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

    The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the \n\t\t\tComment element, if any.

    " - } } }, "traits": { @@ -7595,14 +7595,6 @@ "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

    The value of Version for the traffic policy that you want to update the comment for.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "Comment": { "target": "com.amazonaws.route53#TrafficPolicyComment", "traits": { @@ -7617,6 +7609,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

    The value of Version for the traffic policy that you want to update the comment for.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -7682,10 +7682,11 @@ "smithy.api#required": {} } }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", "traits": { - "smithy.api#documentation": "

    The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

    ", + "smithy.api#documentation": "

    The ID of the traffic policy instance that you want to update.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -7696,11 +7697,10 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

    The ID of the traffic policy instance that you want to update.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

    ", "smithy.api#required": {} } } @@ -7735,14 +7735,14 @@ "com.amazonaws.route53#VPC": { "type": "structure", "members": { + "VPCId": { + "target": "com.amazonaws.route53#VPCId" + }, "VPCRegion": { "target": "com.amazonaws.route53#VPCRegion", "traits": { "smithy.api#documentation": "

    (Private hosted zones only) The region that an Amazon VPC was created in.

    " } - }, - "VPCId": { - "target": "com.amazonaws.route53#VPCId" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json b/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json index ce7e50313e53..5dbb26bb7885 100644 --- a/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/route53resolver.2018-04-01.json @@ -29,6 +29,18 @@ ] }, "shapes": { + "com.amazonaws.route53resolver#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53resolver#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

    ", + "smithy.api#error": "client" + } + }, "com.amazonaws.route53resolver#AccountId": { "type": "string", "traits": { @@ -79,23 +91,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, \n\t\t\tsubmit one AssociateResolverEndpointIpAddress request for each IP address.

    \n\t\t

    To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.

    " + "smithy.api#documentation": "

    Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, \n\t\t\tsubmit one AssociateResolverEndpointIpAddress request for each IP address.

    \n\t\t

    To remove an IP address from an endpoint, see \n\t\t\tDisassociateResolverEndpointIpAddress.\n\t\t

    " } }, "com.amazonaws.route53resolver#AssociateResolverEndpointIpAddressRequest": { "type": "structure", "members": { - "IpAddress": { - "target": "com.amazonaws.route53resolver#IpAddressUpdate", + "ResolverEndpointId": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    Either the IPv4 address that you want to add to a resolver endpoint or a subnet ID. If you specify a subnet ID, \n\t\t\tResolver chooses an IP address for you from the available IPs in the specified subnet.

    ", + "smithy.api#documentation": "

    The ID of the Resolver endpoint that you want to associate IP addresses with.

    ", "smithy.api#required": {} } }, - "ResolverEndpointId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "IpAddress": { + "target": "com.amazonaws.route53resolver#IpAddressUpdate", "traits": { - "smithy.api#documentation": "

    The ID of the resolver endpoint that you want to associate IP addresses with.

    ", + "smithy.api#documentation": "

    Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, \n\t\t\tResolver chooses an IP address for you from the available IPs in the specified subnet.

    ", "smithy.api#required": {} } } @@ -112,6 +124,74 @@ } } }, + "com.amazonaws.route53resolver#AssociateResolverQueryLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#AssociateResolverQueryLogConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#AssociateResolverQueryLogConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#LimitExceededException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceExistsException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs \n\t\t\tthat are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig \n\t\t\trequest for each VPC.

    \n\t\t\n\t\t \n

    The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.

    \n     \n\t\t\n\t\t

    To remove a VPC from a query logging configuration, see \n\t\t\tDisassociateResolverQueryLogConfig.\n\t\t\t

    " + } + }, + "com.amazonaws.route53resolver#AssociateResolverQueryLogConfigRequest": { + "type": "structure", + "members": { + "ResolverQueryLogConfigId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the query logging configuration that you want to associate a VPC with.

    ", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of an Amazon VPC that you want this query logging configuration to log queries for.

    \n\t\t\n\t\t \n\t\t\t

    The VPCs and the query logging configuration must be in the same Region.

    \n\t\t     ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#AssociateResolverQueryLogConfigResponse": { + "type": "structure", + "members": { + "ResolverQueryLogConfigAssociation": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociation", + "traits": { + "smithy.api#documentation": "

    A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

    " + } + } + } + }, "com.amazonaws.route53resolver#AssociateResolverRule": { "type": "operation", "input": { @@ -130,6 +210,9 @@ { "target": "com.amazonaws.route53resolver#InvalidRequestException" }, + { + "target": "com.amazonaws.route53resolver#LimitExceededException" + }, { "target": "com.amazonaws.route53resolver#ResourceExistsException" }, @@ -144,30 +227,30 @@ } ], "traits": { - "smithy.api#documentation": "

    Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries \n\t\t\tfor the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the \n\t\t\tIP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see \n\t\t\tCreateResolverRule.

    " + "smithy.api#documentation": "

    Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries \n\t\t\tfor the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the \n\t\t\tIP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see \n\t\t\tCreateResolverRule.

    " } }, "com.amazonaws.route53resolver#AssociateResolverRuleRequest": { "type": "structure", "members": { - "ResolverRuleId": { + "VPCId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use \n\t\t\tListResolverRules.

    ", + "smithy.api#documentation": "

    The ID of the VPC that you want to associate the Resolver rule with.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.route53resolver#Name", + "ResolverRuleId": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    A name for the association that you're creating between a resolver rule and a VPC.

    " + "smithy.api#documentation": "

    The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use \n\t\t\tListResolverRules.

    ", + "smithy.api#required": {} } }, - "VPCId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "Name": { + "target": "com.amazonaws.route53resolver#Name", "traits": { - "smithy.api#documentation": "

    The ID of the VPC that you want to associate the resolver rule with.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A name for the association that you're creating between a Resolver rule and a VPC.

    " } } } @@ -186,6 +269,9 @@ "com.amazonaws.route53resolver#Boolean": { "type": "boolean" }, + "com.amazonaws.route53resolver#Count": { + "type": "integer" + }, "com.amazonaws.route53resolver#CreateResolverEndpoint": { "type": "operation", "input": { @@ -218,29 +304,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound:

    \n\t\t
      \n
    • \n

      An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC \n\t\t\t\tfrom your network or another VPC.

      \n
      • \n
    • \n

      An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC \n\t\t\t\tto your network or another VPC.

      \n
      • \n
    " + "smithy.api#documentation": "

    Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:

    \n\t\t
      \n
    • \n

      An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC \n\t\t\t\tfrom your network.

      \n
      • \n
    • \n

      An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC \n\t\t\t\tto your network.

      \n
      • \n
    " } }, "com.amazonaws.route53resolver#CreateResolverEndpointRequest": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.route53resolver#SecurityGroupIds", + "CreatorRequestId": { + "target": "com.amazonaws.route53resolver#CreatorRequestId", "traits": { - "smithy.api#documentation": "

    The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify \n\t\t\tmust include one or more inbound rules (for inbound resolver endpoints) or outbound rules (for outbound resolver endpoints).

    ", + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. \n\t\t\tCreatorRequestId can be any unique string, for example, a date/time stamp.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.route53resolver#Name", - "traits": { - "smithy.api#documentation": "

    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

    " - } - }, "IpAddresses": { "target": "com.amazonaws.route53resolver#IpAddressesRequest", "traits": { - "smithy.api#documentation": "

    The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network \n\t\t\t(for outbound endpoints) or on the way from your network to your VPCs (for inbound resolver endpoints).

    ", + "smithy.api#documentation": "

    The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward \n\t\t\tDNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.

    ", "smithy.api#required": {} } }, @@ -250,17 +330,23 @@ "smithy.api#documentation": "

    A list of the tag keys and values that you want to associate with the endpoint.

    " } }, - "CreatorRequestId": { - "target": "com.amazonaws.route53resolver#CreatorRequestId", + "Name": { + "target": "com.amazonaws.route53resolver#Name", "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. \n\t\t\tCreatorRequestId can be any unique string, for example, a date/time stamp.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

    " } }, "Direction": { "target": "com.amazonaws.route53resolver#ResolverEndpointDirection", "traits": { - "smithy.api#documentation": "

    Specify the applicable value:

    \n\t\t
      \n
    • \n

      \n INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC

      \n
      • \n
    • \n

      \n OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specify the applicable value:

    \n\t\t
      \n
    • \n

      \n INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network

      \n
      • \n
    • \n

      \n OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.route53resolver#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

    The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify \n\t\t\tmust include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). \n\t\t\tInbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port \n\t\t\tthat you're using for DNS queries on your network.

    ", "smithy.api#required": {} } } @@ -277,6 +363,88 @@ } } }, + "com.amazonaws.route53resolver#CreateResolverQueryLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#CreateResolverQueryLogConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#CreateResolverQueryLogConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#LimitExceededException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceExistsException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. \n\t\t\tResolver can log queries only for VPCs that are in the same Region as the query logging configuration.

    \n\t\t\n\t\t

    To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see \n\t\t\tAssociateResolverQueryLogConfig.

    \n\t\t\n\t\t

    You can optionally use AWS Resource Access Manager (AWS RAM) to share a query logging configuration with other AWS accounts. The other accounts \n\t\t\tcan then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all \n\t\t\tVPCs that are associated with the configuration.

    " + } + }, + "com.amazonaws.route53resolver#CreateResolverQueryLogConfigRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigName", + "traits": { + "smithy.api#documentation": "

    The name that you want to give the query logging configuration

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.route53resolver#TagList", + "traits": { + "smithy.api#documentation": "

    A list of the tag keys and values that you want to associate with the query logging configuration.

    " + } + }, + "DestinationArn": { + "target": "com.amazonaws.route53resolver#DestinationArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, \n\t\t\tor a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

    \n\t\t\n\t\t
      \n
    • \n\t\t\t\t

      \n S3 bucket:

      \n\t\t\t\t

      \n arn:aws:s3:::examplebucket\n

      \n\t\t\t\t

      You can optionally append a file prefix to the end of the ARN.

      \n\t\t\t\t

      \n arn:aws:s3:::examplebucket/development/\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n CloudWatch Logs log group:

      \n\t\t\t\t

      \n arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*\n

      \n\t\t\t
      • \n
    • \n\t\t\t\t

      \n Kinesis Data Firehose delivery stream:

      \n\t\t\t\t

      \n arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name\n

      \n\t\t\t
      • \n
    ", + "smithy.api#required": {} + } + }, + "CreatorRequestId": { + "target": "com.amazonaws.route53resolver#CreatorRequestId", + "traits": { + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. \n\t\t\tCreatorRequestId can be any unique string, for example, a date/time stamp.

    ", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#CreateResolverQueryLogConfigResponse": { + "type": "structure", + "members": { + "ResolverQueryLogConfig": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfig", + "traits": { + "smithy.api#documentation": "

    Information about the CreateResolverQueryLogConfig request, including the status of the request.

    " + } + } + } + }, "com.amazonaws.route53resolver#CreateResolverRule": { "type": "operation", "input": { @@ -312,55 +480,55 @@ } ], "traits": { - "smithy.api#documentation": "

    For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, \n\t\t\tone domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

    " + "smithy.api#documentation": "

    For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, \n\t\t\tone domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

    " } }, "com.amazonaws.route53resolver#CreateResolverRuleRequest": { "type": "structure", "members": { - "CreatorRequestId": { - "target": "com.amazonaws.route53resolver#CreatorRequestId", + "RuleType": { + "target": "com.amazonaws.route53resolver#RuleTypeOption", "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. \n\t\t\tCreatorRequestId can be any unique string, for example, a date/time stamp.

    ", + "smithy.api#documentation": "

    When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

    \n\t\t

    When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for \n\t\t\ta subdomain of that domain, specify SYSTEM.

    \n\t\t

    For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD \n\t\t\tfor RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify \n\t\t\tSYSTEM for RuleType.

    \n\t\t

    Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

    ", "smithy.api#required": {} } }, - "RuleType": { - "target": "com.amazonaws.route53resolver#RuleTypeOption", + "CreatorRequestId": { + "target": "com.amazonaws.route53resolver#CreatorRequestId", "traits": { - "smithy.api#documentation": "

    Specify FORWARD. Other resolver rule types aren't supported.

    ", + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. \n\t\t\tCreatorRequestId can be any unique string, for example, a date/time stamp.

    ", "smithy.api#required": {} } }, "TargetIps": { "target": "com.amazonaws.route53resolver#TargetList", "traits": { - "smithy.api#documentation": "

    The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

    " + "smithy.api#documentation": "

    The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

    \n\t\t

    \n TargetIps is available only when the value of Rule type is FORWARD.

    " } }, - "Name": { - "target": "com.amazonaws.route53resolver#Name", + "Tags": { + "target": "com.amazonaws.route53resolver#TagList", "traits": { - "smithy.api#documentation": "

    A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

    " + "smithy.api#documentation": "

    A list of the tag keys and values that you want to associate with the endpoint.

    " } }, - "DomainName": { - "target": "com.amazonaws.route53resolver#DomainName", + "Name": { + "target": "com.amazonaws.route53resolver#Name", "traits": { - "smithy.api#documentation": "

    DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches \n\t\t\tmultiple resolver rules (example.com and www.example.com), outbound DNS queries are routed using the resolver rule that contains \n\t\t\tthe most specific domain name (www.example.com).

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

    " } }, - "Tags": { - "target": "com.amazonaws.route53resolver#TagList", + "ResolverEndpointId": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    A list of the tag keys and values that you want to associate with the endpoint.

    " + "smithy.api#documentation": "

    The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify \n\t\t\tin TargetIps.

    " } }, - "ResolverEndpointId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "DomainName": { + "target": "com.amazonaws.route53resolver#DomainName", "traits": { - "smithy.api#documentation": "

    The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify \n\t\t\tin TargetIps.

    " + "smithy.api#documentation": "

    DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches \n\t\t\tmultiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains \n\t\t\tthe most specific domain name (www.example.com).

    ", + "smithy.api#required": {} } } } @@ -411,7 +579,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound \n\t\t\tresolver endpoint:

    \n\t\t
      \n
    • \n

      \n Inbound: DNS queries from your network or another VPC are no longer routed \n\t\t\t\tto the DNS service for the specified VPC.

      \n
      • \n
    • \n

      \n Outbound: DNS queries from a VPC are no longer routed to your network or \n\t\t\t\tto another VPC.

      \n
      • \n
    " + "smithy.api#documentation": "

    Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound \n\t\t\tResolver endpoint:

    \n\t\t
      \n
    • \n

      \n Inbound: DNS queries from your network are no longer routed \n\t\t\t\tto the DNS service for the specified VPC.

      \n
      • \n
    • \n

      \n Outbound: DNS queries from a VPC are no longer routed to your network.

      \n
      • \n
    " } }, "com.amazonaws.route53resolver#DeleteResolverEndpointRequest": { @@ -420,7 +588,7 @@ "ResolverEndpointId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver endpoint that you want to delete.

    ", + "smithy.api#documentation": "

    The ID of the Resolver endpoint that you want to delete.

    ", "smithy.api#required": {} } } @@ -437,15 +605,18 @@ } } }, - "com.amazonaws.route53resolver#DeleteResolverRule": { + "com.amazonaws.route53resolver#DeleteResolverQueryLogConfig": { "type": "operation", "input": { - "target": "com.amazonaws.route53resolver#DeleteResolverRuleRequest" + "target": "com.amazonaws.route53resolver#DeleteResolverQueryLogConfigRequest" }, "output": { - "target": "com.amazonaws.route53resolver#DeleteResolverRuleResponse" + "target": "com.amazonaws.route53resolver#DeleteResolverQueryLogConfigResponse" }, "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, { "target": "com.amazonaws.route53resolver#InternalServiceErrorException" }, @@ -453,7 +624,7 @@ "target": "com.amazonaws.route53resolver#InvalidParameterException" }, { - "target": "com.amazonaws.route53resolver#ResourceInUseException" + "target": "com.amazonaws.route53resolver#InvalidRequestException" }, { "target": "com.amazonaws.route53resolver#ResourceNotFoundException" @@ -463,39 +634,39 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you \n\t\t\tassociated the resolver rule with. For more infomation, see DisassociateResolverRule.

    " + "smithy.api#documentation": "

    Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are \n\t\t\tassociated with the configuration. This also applies if the query logging configuration is shared with other AWS accounts, and \n\t\t\tthe other accounts have associated VPCs with the shared configuration.

    \n\t\t\n\t\t

    Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See \n\t\t\tDisassociateResolverQueryLogConfig.

    \n\t\t\t\n\t\t

    If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing \n\t\t\tthe configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs \n\t\t\tthat they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically \n\t\t\tdisassociated from the configuration.

    " } }, - "com.amazonaws.route53resolver#DeleteResolverRuleRequest": { + "com.amazonaws.route53resolver#DeleteResolverQueryLogConfigRequest": { "type": "structure", "members": { - "ResolverRuleId": { + "ResolverQueryLogConfigId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule that you want to delete.

    ", + "smithy.api#documentation": "

    The ID of the query logging configuration that you want to delete.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.route53resolver#DeleteResolverRuleResponse": { + "com.amazonaws.route53resolver#DeleteResolverQueryLogConfigResponse": { "type": "structure", "members": { - "ResolverRule": { - "target": "com.amazonaws.route53resolver#ResolverRule", + "ResolverQueryLogConfig": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfig", "traits": { - "smithy.api#documentation": "

    Information about the DeleteResolverRule request, including the status of the request.

    " + "smithy.api#documentation": "

    Information about the query logging configuration that you deleted, including the status of the request.

    " } } } }, - "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddress": { + "com.amazonaws.route53resolver#DeleteResolverRule": { "type": "operation", "input": { - "target": "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressRequest" + "target": "com.amazonaws.route53resolver#DeleteResolverRuleRequest" }, "output": { - "target": "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressResponse" + "target": "com.amazonaws.route53resolver#DeleteResolverRuleResponse" }, "errors": [ { @@ -505,10 +676,7 @@ "target": "com.amazonaws.route53resolver#InvalidParameterException" }, { - "target": "com.amazonaws.route53resolver#InvalidRequestException" - }, - { - "target": "com.amazonaws.route53resolver#ResourceExistsException" + "target": "com.amazonaws.route53resolver#ResourceInUseException" }, { "target": "com.amazonaws.route53resolver#ResourceNotFoundException" @@ -518,44 +686,170 @@ } ], "traits": { - "smithy.api#documentation": "

    Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, \n\t\t\tsubmit one DisassociateResolverEndpointIpAddress request for each IP address.

    \n\t\t

    To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.

    " + "smithy.api#documentation": "

    Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you \n\t\t\tassociated the Resolver rule with. For more information, see \n\t\t\tDisassociateResolverRule.

    " } }, - "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressRequest": { + "com.amazonaws.route53resolver#DeleteResolverRuleRequest": { "type": "structure", "members": { - "ResolverEndpointId": { + "ResolverRuleId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver endpoint that you want to disassociate an IP address from.

    ", - "smithy.api#required": {} - } - }, - "IpAddress": { - "target": "com.amazonaws.route53resolver#IpAddressUpdate", - "traits": { - "smithy.api#documentation": "

    The IPv4 address that you want to remove from a resolver endpoint.

    ", + "smithy.api#documentation": "

    The ID of the Resolver rule that you want to delete.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressResponse": { + "com.amazonaws.route53resolver#DeleteResolverRuleResponse": { "type": "structure", "members": { - "ResolverEndpoint": { - "target": "com.amazonaws.route53resolver#ResolverEndpoint", + "ResolverRule": { + "target": "com.amazonaws.route53resolver#ResolverRule", "traits": { - "smithy.api#documentation": "

    The response to an DisassociateResolverEndpointIpAddress request.

    " + "smithy.api#documentation": "

    Information about the DeleteResolverRule request, including the status of the request.

    " } } } }, - "com.amazonaws.route53resolver#DisassociateResolverRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53resolver#DisassociateResolverRuleRequest" - }, + "com.amazonaws.route53resolver#DestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 600 + } + } + }, + "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddress": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceExistsException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, \n\t\t\tsubmit one DisassociateResolverEndpointIpAddress request for each IP address.

    \n\t\t

    To add an IP address to an endpoint, see \n\t\t\tAssociateResolverEndpointIpAddress.\n\t\t

    " + } + }, + "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressRequest": { + "type": "structure", + "members": { + "IpAddress": { + "target": "com.amazonaws.route53resolver#IpAddressUpdate", + "traits": { + "smithy.api#documentation": "

    The IPv4 address that you want to remove from a Resolver endpoint.

    ", + "smithy.api#required": {} + } + }, + "ResolverEndpointId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the Resolver endpoint that you want to disassociate an IP address from.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddressResponse": { + "type": "structure", + "members": { + "ResolverEndpoint": { + "target": "com.amazonaws.route53resolver#ResolverEndpoint", + "traits": { + "smithy.api#documentation": "

    The response to an DisassociateResolverEndpointIpAddress request.

    " + } + } + } + }, + "com.amazonaws.route53resolver#DisassociateResolverQueryLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#DisassociateResolverQueryLogConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#DisassociateResolverQueryLogConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Disassociates a VPC from a query logging configuration.

    \n\t\t\n\t\t \n\t\t\t

    Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used \n\t\t\t\tResource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration \n\t\t\t\tin the following ways:

    \n\t\t\t
      \n
    • \n

      The accounts that you shared the configuration with can disassociate VPCs from the configuration.

      \n
      • \n
    • \n

      You can stop sharing the configuration.

      \n
      • \n
    \n\t\t     " + } + }, + "com.amazonaws.route53resolver#DisassociateResolverQueryLogConfigRequest": { + "type": "structure", + "members": { + "ResolverQueryLogConfigId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the query logging configuration that you want to disassociate a specified VPC from.

    ", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#DisassociateResolverQueryLogConfigResponse": { + "type": "structure", + "members": { + "ResolverQueryLogConfigAssociation": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociation", + "traits": { + "smithy.api#documentation": "

    A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.

    " + } + } + } + }, + "com.amazonaws.route53resolver#DisassociateResolverRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#DisassociateResolverRuleRequest" + }, "output": { "target": "com.amazonaws.route53resolver#DisassociateResolverRuleResponse" }, @@ -574,23 +868,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Removes the association between a specified resolver rule and a specified VPC.

    \n\t\t \n\t\t\t

    If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the \n\t\t\t\tdomain name that you specified in the resolver rule.

    \n\t\t     " + "smithy.api#documentation": "

    Removes the association between a specified Resolver rule and a specified VPC.

    \n\t\t \n\t\t\t

    If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the \n\t\t\t\tdomain name that you specified in the Resolver rule.

    \n\t\t     " } }, "com.amazonaws.route53resolver#DisassociateResolverRuleRequest": { "type": "structure", "members": { - "ResolverRuleId": { + "VPCId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule that you want to disassociate from the specified VPC.

    ", + "smithy.api#documentation": "

    The ID of the VPC that you want to disassociate the Resolver rule from.

    ", "smithy.api#required": {} } }, - "VPCId": { + "ResolverRuleId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the VPC that you want to disassociate the resolver rule from.

    ", + "smithy.api#documentation": "

    The ID of the Resolver rule that you want to disassociate from the specified VPC.

    ", "smithy.api#required": {} } } @@ -625,18 +919,18 @@ "Name": { "target": "com.amazonaws.route53resolver#FilterName", "traits": { - "smithy.api#documentation": "

    When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules,\n\t\t\tthe name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify \n\t\t\tDirection for the value of Name.

    " + "smithy.api#documentation": "

    The name of the parameter that you want to use to filter objects.

    \n\t\t

    The valid values for Name depend on the action that you're including the filter in, \n\t\t\tListResolverEndpoints, \n\t\t\tListResolverRules, \n\t\t\tListResolverRuleAssociations, \n\t\t\tListResolverQueryLogConfigs,\n\t\t\tor \n\t\t\tListResolverQueryLogConfigAssociations.

    \n\t\t\n\t\t \n\t\t\t

    In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, \n\t\t\t\tCreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

    \n\t\t     \n\t\t\n\t\t

    \n ListResolverEndpoints\n

    \n\t\t

    Valid values for Name include the following:

    \n\t\t
      \n
    • \n

      \n CreatorRequestId: The value that you specified when you created the Resolver endpoint.

      \n
      • \n
    • \n

      \n Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION \n\t\t\t\tfor Name, specify INBOUND or OUTBOUND for Values.

      \n
      • \n
    • \n

      \n HostVpcId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or \n\t\t\t\tthe VPC that outbound queries pass through on the way from your VPCs to your network. In a \n\t\t\t\tCreateResolverEndpoint\n\t\t\t\trequest, SubnetId indirectly identifies the VPC. In a \n\t\t\t\tGetResolverEndpoint\n\t\t\t\trequest, the VPC ID for a Resolver endpoint \n\t\t\t\tis returned in the HostVPCId element.

      \n
      • \n
    • \n

      \n IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.

      \n
      • \n
    • \n

      \n Name: The name of the Resolver endpoint.

      \n
      • \n
    • \n

      \n SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the \n\t\t\t\tResolver endpoint.

      \n
      • \n
    • \n

      \n Status: The status of the Resolver endpoint. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING,\n\t\t\t\tAUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in\n\t\t\t\tResolverEndpoint.

      \n
      • \n
    \n\t\t\n\t\t

    \n ListResolverRules\n

    \n\t\t

    Valid values for Name include the following:

    \n\t\t
      \n
    • \n

      \n CreatorRequestId: The value that you specified when you created the Resolver rule.

      \n
      • \n
    • \n

      \n DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value that \n\t\t\t\tyou specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, \n\t\t\t\tspecify the following value. Note the \".\" after com:

      \n\t\t\t\t

      \n example.com.\n

      \n\t\t\t
      • \n
    • \n

      \n Name: The name of the Resolver rule.

      \n
      • \n
    • \n

      \n ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.

      \n\t\t\t\t \n

      You can filter on the Resolver endpoint only for rules that have a value of FORWARD for \n\t\t\t\t\tRuleType.

      \n       \n\t\t\t
      • \n
    • \n

      \n Status: The status of the Resolver rule. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, \n\t\t\t\tor FAILED.

      \n
      • \n
    • \n

      \n Type: The type of the Resolver rule. If you specify TYPE \n\t\t\t\tfor Name, specify FORWARD or SYSTEM for Values.

      \n
      • \n
    \n\t\t\n\t\t

    \n ListResolverRuleAssociations\n

    \n\t\t

    Valid values for Name include the following:

    \n\t\t
      \n
    • \n

      \n Name: The name of the Resolver rule association.

      \n
      • \n
    • \n

      \n ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.

      \n
      • \n
    • \n

      \n Status: The status of the Resolver rule association. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or \n\t\t\t\tFAILED.

      \n\t\t\t
      • \n
    • \n

      \n VPCId: The ID of the VPC that the Resolver rule is associated with.

      \n
      • \n
    \n\n\t\t

    \n ListResolverQueryLogConfigs\n

    \n\t\t

    Valid values for Name include the following:

    \n\t\t
      \n
    • \n

      \n Arn: The ARN for the query logging configuration.

      \n
      • \n
    • \n

      \n AssociationCount: The number of VPCs that are associated with the query logging configuration.

      \n
      • \n
    • \n

      \n CreationTime: The date and time that the query logging configuration was created, in Unix time format and \n\t\t\t\tCoordinated Universal Time (UTC).

      \n
      • \n
    • \n

      \n CreatorRequestId: A unique string that identifies the request that created the query logging configuration.

      \n
      • \n
    • \n

      \n Destination: The AWS service that you want to forward query logs to. Valid values include the following:

      \n\t\t\t\t
        \n
      • \n

        \n S3\n

        \n
        • \n
      • \n

        \n CloudWatchLogs\n

        \n
        • \n
      • \n

        \n KinesisFirehose\n

        \n
        • \n
      \n\t\t\t
      • \n
    • \n

      \n DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an \n\t\t\t\tS3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.

      \n
      • \n
    • \n

      \n Id: The ID of the query logging configuration

      \n
      • \n
    • \n

      \n Name: The name of the query logging configuration

      \n
      • \n
    • \n

      \n OwnerId: The AWS account ID for the account that created the query logging configuration.

      \n
      • \n
    • \n

      \n ShareStatus: An indication of whether the query logging configuration is shared with other AWS accounts, \n\t\t\t\tor was shared with the current account by another AWS account. Valid values include: NOT_SHARED, SHARED_WITH_ME, \n\t\t\t\tor SHARED_BY_ME.

      \n
      • \n
    • \n

      \n Status: The status of the query logging configuration. If you specify Status for Name, \n\t\t\t\tspecify the applicable status code for Values: CREATING, CREATED, \n\t\t\t\tDELETING, or FAILED. For more information, see \n\t\t\t\tStatus.\n\t\t\t\t

      \n\t\t\t
      • \n
    \n\t\t\n\t\t

    \n ListResolverQueryLogConfigAssociations\n

    \n\t\t

    Valid values for Name include the following:

    \n\t\t
      \n
    • \n

      \n CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and \n\t\t\t\tCoordinated Universal Time (UTC).

      \n
      • \n
    • \n

      \n Error: If the value of Status is FAILED, specify the cause: \n\t\t\t\tDESTINATION_NOT_FOUND or ACCESS_DENIED.

      \n
      • \n
    • \n

      \n Id: The ID of the query logging association.

      \n
      • \n
    • \n

      \n ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.

      \n
      • \n
    • \n

      \n ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.

      \n
      • \n
    • \n

      \n Status: The status of the query logging association. If you specify Status for Name, \n\t\t\t\tspecify the applicable status code for Values: CREATING, CREATED, \n\t\t\t\tDELETING, or FAILED. For more information, see \n\t\t\t\tStatus.\n\t\t\t\t

      \n\t\t\t
      • \n
    " } }, "Values": { "target": "com.amazonaws.route53resolver#FilterValues", "traits": { - "smithy.api#documentation": "

    When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules,\n\t\t\tthe value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify \n\t\t\tINBOUND for the value of Values.

    " + "smithy.api#documentation": "

    When you're using a List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules,\n\t\t\tthe value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for \n\t\t\tName and specify INBOUND for Values.

    " } } }, "traits": { - "smithy.api#documentation": "

    For List operations, an optional specification to return a subset of objects, such as resolver endpoints or resolver rules.

    " + "smithy.api#documentation": "

    For Resolver list operations \n\t\t\t(ListResolverEndpoints, \n\t\t\tListResolverRules, \n\t\t\tListResolverRuleAssociations, \n\t\t\tListResolverQueryLogConfigs,\n\t\t\tand\n\t\t\tListResolverQueryLogConfigAssociations), \n\t\t\tan optional specification to return a subset of objects.

    \n\t\t

    To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, \n\t\t\tto list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

    " } }, "com.amazonaws.route53resolver#FilterName": { @@ -653,7 +947,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 64 + "max": 600 } } }, @@ -692,7 +986,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the \n\t\t\tcurrent status of the endpoint.

    " + "smithy.api#documentation": "

    Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the \n\t\t\tcurrent status of the endpoint.

    " } }, "com.amazonaws.route53resolver#GetResolverEndpointRequest": { @@ -701,7 +995,7 @@ "ResolverEndpointId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver endpoint that you want to get information about.

    ", + "smithy.api#documentation": "

    The ID of the Resolver endpoint that you want to get information about.

    ", "smithy.api#required": {} } } @@ -713,7 +1007,169 @@ "ResolverEndpoint": { "target": "com.amazonaws.route53resolver#ResolverEndpoint", "traits": { - "smithy.api#documentation": "

    Information about the resolver endpoint that you specified in a GetResolverEndpoint request.

    " + "smithy.api#documentation": "

    Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.

    " + } + } + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration \n\t\t\tis logging queries for and the location that logs are sent to.

    " + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigAssociationRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC \n\t\t\twith a query logging configuration, Resolver logs DNS queries that originate in that VPC.

    " + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigAssociationRequest": { + "type": "structure", + "members": { + "ResolverQueryLogConfigAssociationId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the Resolver query logging configuration association that you want to get information about.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigAssociationResponse": { + "type": "structure", + "members": { + "ResolverQueryLogConfigAssociation": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociation", + "traits": { + "smithy.api#documentation": "

    Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation request.

    " + } + } + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#UnknownResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gets information about a query logging policy. A query logging policy specifies the Resolver query logging \n\t\t\toperations and resources that you want to allow another AWS account to be able to use.

    " + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigPolicyRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53resolver#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN of the query logging configuration that you want to get the query logging policy for.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigPolicyResponse": { + "type": "structure", + "members": { + "ResolverQueryLogConfigPolicy": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigPolicy", + "traits": { + "smithy.api#documentation": "

    Information about the query logging policy for the query logging configuration that you specified in a \n\t\t\tGetResolverQueryLogConfigPolicy request.

    " + } + } + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigRequest": { + "type": "structure", + "members": { + "ResolverQueryLogConfigId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the Resolver query logging configuration that you want to get information about.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#GetResolverQueryLogConfigResponse": { + "type": "structure", + "members": { + "ResolverQueryLogConfig": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfig", + "traits": { + "smithy.api#documentation": "

    Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig request.

    " } } } @@ -741,7 +1197,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the \n\t\t\toutbound resolver endpoint that the rule is associated with.

    " + "smithy.api#documentation": "

    Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the \n\t\t\toutbound Resolver endpoint that the rule is associated with.

    " } }, "com.amazonaws.route53resolver#GetResolverRuleAssociation": { @@ -767,7 +1223,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using \n\t\t\tAssociateResolverRule.

    " + "smithy.api#documentation": "

    Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using \n\t\t\tAssociateResolverRule.

    " } }, "com.amazonaws.route53resolver#GetResolverRuleAssociationRequest": { @@ -776,7 +1232,7 @@ "ResolverRuleAssociationId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule association that you want to get information about.

    ", + "smithy.api#documentation": "

    The ID of the Resolver rule association that you want to get information about.

    ", "smithy.api#required": {} } } @@ -788,7 +1244,7 @@ "ResolverRuleAssociation": { "target": "com.amazonaws.route53resolver#ResolverRuleAssociation", "traits": { - "smithy.api#documentation": "

    Information about the resolver rule association that you specified in a GetResolverRuleAssociation request.

    " + "smithy.api#documentation": "

    Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.

    " } } } @@ -813,7 +1269,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources \n\t\t\tthat you want to allow another AWS account to be able to use.

    " + "smithy.api#documentation": "

    Gets information about a Resolver rule policy. A Resolver rule policy specifies the Resolver operations and resources \n\t\t\tthat you want to allow another AWS account to be able to use.

    " } }, "com.amazonaws.route53resolver#GetResolverRulePolicyRequest": { @@ -822,7 +1278,7 @@ "Arn": { "target": "com.amazonaws.route53resolver#Arn", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule policy that you want to get information about.

    ", + "smithy.api#documentation": "

    The ID of the Resolver rule policy that you want to get information about.

    ", "smithy.api#required": {} } } @@ -834,7 +1290,7 @@ "ResolverRulePolicy": { "target": "com.amazonaws.route53resolver#ResolverRulePolicy", "traits": { - "smithy.api#documentation": "

    Information about the resolver rule policy that you specified in a GetResolverRulePolicy request.

    " + "smithy.api#documentation": "

    Information about the Resolver rule policy that you specified in a GetResolverRulePolicy request.

    " } } } @@ -845,7 +1301,7 @@ "ResolverRuleId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule that you want to get information about.

    ", + "smithy.api#documentation": "

    The ID of the Resolver rule that you want to get information about.

    ", "smithy.api#required": {} } } @@ -857,7 +1313,7 @@ "ResolverRule": { "target": "com.amazonaws.route53resolver#ResolverRule", "traits": { - "smithy.api#documentation": "

    Information about the resolver rule that you specified in a GetResolverRule request.

    " + "smithy.api#documentation": "

    Information about the Resolver rule that you specified in a GetResolverRule request.

    " } } } @@ -915,7 +1371,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The specified resolver rule policy is invalid.

    ", + "smithy.api#documentation": "

    The specified Resolver rule policy is invalid.

    ", "smithy.api#error": "client" } }, @@ -961,37 +1417,31 @@ "com.amazonaws.route53resolver#IpAddressRequest": { "type": "structure", "members": { - "Ip": { - "target": "com.amazonaws.route53resolver#Ip", + "SubnetId": { + "target": "com.amazonaws.route53resolver#SubnetId", "traits": { - "smithy.api#documentation": "

    The IP address that you want to use for DNS queries.

    " + "smithy.api#documentation": "

    The ID of the subnet that contains the IP address.

    ", + "smithy.api#required": {} } }, - "SubnetId": { - "target": "com.amazonaws.route53resolver#SubnetId", + "Ip": { + "target": "com.amazonaws.route53resolver#Ip", "traits": { - "smithy.api#documentation": "

    The subnet that contains the IP address.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The IP address that you want to use for DNS queries.

    " } } }, "traits": { - "smithy.api#documentation": "

    In an CreateResolverEndpoint request, a subnet and IP address that you want to use for DNS queries.

    " + "smithy.api#documentation": "

    In a \n\t\t\tCreateResolverEndpoint \n\t\t\trequest, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). \n\t\t\tIpAddressRequest also includes the ID of the subnet that contains the IP address.

    " } }, "com.amazonaws.route53resolver#IpAddressResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.route53resolver#IpAddressStatus", - "traits": { - "smithy.api#documentation": "

    A status code that gives the current status of the request.

    " - } - }, - "IpId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "ModificationTime": { + "target": "com.amazonaws.route53resolver#Rfc3339TimeString", "traits": { - "smithy.api#documentation": "

    The ID of one IP address.

    " + "smithy.api#documentation": "

    The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

    " } }, "SubnetId": { @@ -1000,10 +1450,10 @@ "smithy.api#documentation": "

    The ID of one subnet.

    " } }, - "ModificationTime": { - "target": "com.amazonaws.route53resolver#Rfc3339TimeString", + "StatusMessage": { + "target": "com.amazonaws.route53resolver#StatusMessage", "traits": { - "smithy.api#documentation": "

    The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

    " + "smithy.api#documentation": "

    A message that provides additional information about the status of the request.

    " } }, "CreationTime": { @@ -1012,21 +1462,27 @@ "smithy.api#documentation": "

    The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

    " } }, - "StatusMessage": { - "target": "com.amazonaws.route53resolver#StatusMessage", + "Status": { + "target": "com.amazonaws.route53resolver#IpAddressStatus", "traits": { - "smithy.api#documentation": "

    A message that provides additional information about the status of the request.

    " + "smithy.api#documentation": "

    A status code that gives the current status of the request.

    " + } + }, + "IpId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of one IP address.

    " } }, "Ip": { "target": "com.amazonaws.route53resolver#Ip", "traits": { - "smithy.api#documentation": "

    One IP address that the resolver endpoint uses for DNS queries.

    " + "smithy.api#documentation": "

    One IP address that the Resolver endpoint uses for DNS queries.

    " } } }, "traits": { - "smithy.api#documentation": "

    In the response to a GetResolverEndpoint request, information about the IP addresses that \n\t\t\tthe resolver endpoint uses for DNS queries.

    " + "smithy.api#documentation": "

    In the response to a \n\t\t\tGetResolverEndpoint\n\t\t\trequest, information about the IP addresses that the Resolver endpoint uses for DNS queries.

    " } }, "com.amazonaws.route53resolver#IpAddressStatus": { @@ -1079,27 +1535,27 @@ "com.amazonaws.route53resolver#IpAddressUpdate": { "type": "structure", "members": { - "Ip": { - "target": "com.amazonaws.route53resolver#Ip", - "traits": { - "smithy.api#documentation": "

    The new IP address.

    " - } - }, "SubnetId": { "target": "com.amazonaws.route53resolver#SubnetId", "traits": { - "smithy.api#documentation": "

    The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

    " + "smithy.api#documentation": "

    The ID of the subnet that includes the IP address that you want to update. To get this ID, use \n\t\t\tGetResolverEndpoint.

    " } }, "IpId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    \n Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. \n\t\t\tTo get this ID, use GetResolverEndpoint.

    " + "smithy.api#documentation": "

    \n Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. \n\t\t\tTo get this ID, use \n\t\t\tGetResolverEndpoint.

    " + } + }, + "Ip": { + "target": "com.amazonaws.route53resolver#Ip", + "traits": { + "smithy.api#documentation": "

    The new IP address.

    " } } }, "traits": { - "smithy.api#documentation": "

    In an UpdateResolverEndpoint request, information about an IP address to update.

    " + "smithy.api#documentation": "

    In an \n\t\t\tUpdateResolverEndpoint \n\t\t\trequest, information about an IP address to update.

    " } }, "com.amazonaws.route53resolver#IpAddressesRequest": { @@ -1164,7 +1620,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets the IP addresses for a specified resolver endpoint.

    ", + "smithy.api#documentation": "

    Gets the IP addresses for a specified Resolver endpoint.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1175,12 +1631,6 @@ "com.amazonaws.route53resolver#ListResolverEndpointIpAddressesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.route53resolver#NextToken", - "traits": { - "smithy.api#documentation": "

    For the first ListResolverEndpointIpAddresses request, omit this value.

    \n\t\t

    If the specified resolver endpoint has more than MaxResults IP addresses, you can submit another \n\t\t\tListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " - } - }, "MaxResults": { "target": "com.amazonaws.route53resolver#MaxResults", "traits": { @@ -1191,9 +1641,15 @@ "ResolverEndpointId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver endpoint that you want to get IP addresses for.

    ", + "smithy.api#documentation": "

    The ID of the Resolver endpoint that you want to get IP addresses for.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", + "traits": { + "smithy.api#documentation": "

    For the first ListResolverEndpointIpAddresses request, omit this value.

    \n\t\t

    If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another \n\t\t\tListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " + } } } }, @@ -1215,7 +1671,7 @@ "IpAddresses": { "target": "com.amazonaws.route53resolver#IpAddressesResponse", "traits": { - "smithy.api#documentation": "

    The IP addresses that DNS queries pass through on their way to your network (outbound endpoint) or on the way to \n\t\t\tResolver (inbound endpoint).

    " + "smithy.api#documentation": "

    Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward \n\t\t\tDNS queries to (for inbound endpoints).

    " } } } @@ -1246,7 +1702,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists all the resolver endpoints that were created using the current AWS account.

    ", + "smithy.api#documentation": "

    Lists all the Resolver endpoints that were created using the current AWS account.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1257,23 +1713,23 @@ "com.amazonaws.route53resolver#ListResolverEndpointsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.route53resolver#MaxResults", + "Filters": { + "target": "com.amazonaws.route53resolver#Filters", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of resolver endpoints that you want to return in the response to a ListResolverEndpoints request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 resolver endpoints.

    " + "smithy.api#documentation": "

    An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

    \n\t\t \n

    If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, \n\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n     " } }, "NextToken": { "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

    For the first ListResolverEndpoints request, omit this value.

    \n\t\t

    If you have more than MaxResults resolver endpoints, you can submit another ListResolverEndpoints request \n\t\t\tto get the next group of resolver endpoints. In the next request, specify the value of NextToken from the previous response.

    " + "smithy.api#documentation": "

    For the first ListResolverEndpoints request, omit this value.

    \n\t\t

    If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request \n\t\t\tto get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.

    " } }, - "Filters": { - "target": "com.amazonaws.route53resolver#Filters", + "MaxResults": { + "target": "com.amazonaws.route53resolver#MaxResults", "traits": { - "smithy.api#documentation": "

    An optional specification to return a subset of resolver endpoints, such as all inbound resolver endpoints.

    \n\t\t \n

    If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, \n\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n     " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints.

    " } } } @@ -1281,10 +1737,10 @@ "com.amazonaws.route53resolver#ListResolverEndpointsResponse": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.route53resolver#MaxResults", + "ResolverEndpoints": { + "target": "com.amazonaws.route53resolver#ResolverEndpoints", "traits": { - "smithy.api#documentation": "

    The value that you specified for MaxResults in the request.

    " + "smithy.api#documentation": "

    The Resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

    " } }, "NextToken": { @@ -1293,28 +1749,28 @@ "smithy.api#documentation": "

    If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request \n\t\t\tto get the next group of results. In the next request, specify the value of NextToken from the previous response.

    " } }, - "ResolverEndpoints": { - "target": "com.amazonaws.route53resolver#ResolverEndpoints", + "MaxResults": { + "target": "com.amazonaws.route53resolver#MaxResults", "traits": { - "smithy.api#documentation": "

    The resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

    " + "smithy.api#documentation": "

    The value that you specified for MaxResults in the request.

    " } } } }, - "com.amazonaws.route53resolver#ListResolverRuleAssociations": { + "com.amazonaws.route53resolver#ListResolverQueryLogConfigAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.route53resolver#ListResolverRuleAssociationsRequest" + "target": "com.amazonaws.route53resolver#ListResolverQueryLogConfigAssociationsRequest" }, "output": { - "target": "com.amazonaws.route53resolver#ListResolverRuleAssociationsResponse" + "target": "com.amazonaws.route53resolver#ListResolverQueryLogConfigAssociationsResponse" }, "errors": [ { - "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + "target": "com.amazonaws.route53resolver#AccessDeniedException" }, { - "target": "com.amazonaws.route53resolver#InvalidNextTokenException" + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" }, { "target": "com.amazonaws.route53resolver#InvalidParameterException" @@ -1322,12 +1778,15 @@ { "target": "com.amazonaws.route53resolver#InvalidRequestException" }, + { + "target": "com.amazonaws.route53resolver#LimitExceededException" + }, { "target": "com.amazonaws.route53resolver#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Lists the associations that were created between resolver rules and VPCs using the current AWS account.

    ", + "smithy.api#documentation": "

    Lists information about associations between Amazon VPCs and query logging configurations.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1335,62 +1794,82 @@ } } }, - "com.amazonaws.route53resolver#ListResolverRuleAssociationsRequest": { + "com.amazonaws.route53resolver#ListResolverQueryLogConfigAssociationsRequest": { "type": "structure", "members": { + "SortBy": { + "target": "com.amazonaws.route53resolver#SortByKey", + "traits": { + "smithy.api#documentation": "

    The element that you want Resolver to sort query logging associations by.

    \n\t\t \n\t\t\t

    If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, \n\t\t\t\tyou must use the same value for SortBy, if any, as in the previous request.

    \n\t\t     \n\t\t\n\t\t

    Valid values include the following elements:

    \n\t\t
      \n
    • \n

      \n CreationTime: The ID of the query logging association.

      \n
      • \n
    • \n

      \n Error: If the value of Status is FAILED, the value of Error \n\t\t\t\tindicates the cause:

      \n\t\t\t\t
        \n
      • \n

        \n DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.

        \n
        • \n
      • \n

        \n ACCESS_DENIED: Permissions don't allow sending logs to the destination.

        \n
        • \n
      \n\t\t\t\t

      If Status is a value other than FAILED, ERROR is null.

      \n\t\t\t
      • \n
    • \n

      \n Id: The ID of the query logging association

      \n
      • \n
    • \n

      \n ResolverQueryLogConfigId: The ID of the query logging configuration

      \n
      • \n
    • \n

      \n ResourceId: The ID of the VPC that is associated with the query logging configuration

      \n
      • \n
    • \n

      \n Status: The current status of the configuration. Valid values include the following:

      \n\t\t\t\t\n\t\t\t\t
        \n
      • \n

        \n CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.

        \n
        • \n
      • \n

        \n CREATED: The association between an Amazon VPC and a query logging configuration \n\t\t\t\t\t\twas successfully created. Resolver is logging queries that originate in the specified VPC.

        \n
        • \n
      • \n

        \n DELETING: Resolver is deleting this query logging association.

        \n
        • \n
      • \n

        \n FAILED: Resolver either couldn't create or couldn't delete the query logging association. \n\t\t\t\t\t\tHere are two common causes:

        \n\t\t\t\t\t\t
          \n
        • \n

          The specified destination (for example, an Amazon S3 bucket) was deleted.

          \n
          • \n
        • \n

          Permissions don't allow sending logs to the destination.

          \n
          • \n
        \n\t\t\t\t\t
        • \n
      \n\t\t\t
      • \n
    " + } + }, "MaxResults": { "target": "com.amazonaws.route53resolver#MaxResults", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 rule associations.

    " + "smithy.api#documentation": "

    The maximum number of query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 query logging associations.

    " } }, - "Filters": { - "target": "com.amazonaws.route53resolver#Filters", + "SortOrder": { + "target": "com.amazonaws.route53resolver#SortOrder", "traits": { - "smithy.api#documentation": "

    An optional specification to return a subset of resolver rules, such as resolver rules that are associated with the same VPC ID.

    \n\t\t \n

    If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, \n\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n     " + "smithy.api#documentation": "

    If you specified a value for SortBy, the order that you want query logging associations to be listed in, \n\t\t\tASCENDING or DESCENDING.

    \n\t\t \n\t\t\t

    If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, \n\t\t\t\tyou must use the same value for SortOrder, if any, as in the previous request.

    \n\t\t     " } }, "NextToken": { "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

    For the first ListResolverRuleAssociation request, omit this value.

    \n\t\t

    If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request \n\t\t\tto get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

    " + "smithy.api#documentation": "

    For the first ListResolverQueryLogConfigAssociations request, omit this value.

    \n\t\t

    If there are more than MaxResults query logging associations that match the values that you specify for Filters, \n\t\t\tyou can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " + } + }, + "Filters": { + "target": "com.amazonaws.route53resolver#Filters", + "traits": { + "smithy.api#documentation": "

    An optional specification to return a subset of query logging associations.

    \n\t\t \n\t\t\t

    If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, \n\t\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n\t\t     " } } } }, - "com.amazonaws.route53resolver#ListResolverRuleAssociationsResponse": { + "com.amazonaws.route53resolver#ListResolverQueryLogConfigAssociationsResponse": { "type": "structure", "members": { - "ResolverRuleAssociations": { - "target": "com.amazonaws.route53resolver#ResolverRuleAssociations", + "TotalFilteredCount": { + "target": "com.amazonaws.route53resolver#Count", "traits": { - "smithy.api#documentation": "

    The associations that were created between resolver rules and VPCs using the current AWS account, and that match the \n\t\t\tspecified filters, if any.

    " + "smithy.api#documentation": "

    The total number of query logging associations that were created by the current account in the specified Region and that match the filters \n\t\t\tthat were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the \n\t\t\tcurrent account in the specified Region, see TotalCount.

    " } }, - "MaxResults": { - "target": "com.amazonaws.route53resolver#MaxResults", + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

    The value that you specified for MaxResults in the request.

    " + "smithy.api#documentation": "

    If there are more than MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request \n\t\t\tto get the next group of associations. In the next request, specify the value of NextToken from the previous response.

    " } }, - "NextToken": { - "target": "com.amazonaws.route53resolver#NextToken", + "ResolverQueryLogConfigAssociations": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationList", "traits": { - "smithy.api#documentation": "

    If more than MaxResults rule associations match the specified criteria, you can submit another \n\t\t\tListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " + "smithy.api#documentation": "

    A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the \n\t\t\tvalues that you specified for Filter.

    " + } + }, + "TotalCount": { + "target": "com.amazonaws.route53resolver#Count", + "traits": { + "smithy.api#documentation": "

    The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the \n\t\t\tnumber of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify \n\t\t\tin the request.

    " } } } }, - "com.amazonaws.route53resolver#ListResolverRules": { + "com.amazonaws.route53resolver#ListResolverQueryLogConfigs": { "type": "operation", "input": { - "target": "com.amazonaws.route53resolver#ListResolverRulesRequest" + "target": "com.amazonaws.route53resolver#ListResolverQueryLogConfigsRequest" }, "output": { - "target": "com.amazonaws.route53resolver#ListResolverRulesResponse" + "target": "com.amazonaws.route53resolver#ListResolverQueryLogConfigsResponse" }, "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, { "target": "com.amazonaws.route53resolver#InternalServiceErrorException" }, @@ -1408,7 +1887,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the resolver rules that were created using the current AWS account.

    ", + "smithy.api#documentation": "

    Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save \n\t\t\tDNS query logs and specifies the VPCs that you want to log queries for.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1416,60 +1895,78 @@ } } }, - "com.amazonaws.route53resolver#ListResolverRulesRequest": { + "com.amazonaws.route53resolver#ListResolverQueryLogConfigsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.route53resolver#NextToken", - "traits": { - "smithy.api#documentation": "

    For the first ListResolverRules request, omit this value.

    \n\t\t

    If you have more than MaxResults resolver rules, you can submit another ListResolverRules request \n\t\t\tto get the next group of resolver rules. In the next request, specify the value of NextToken from the previous response.

    " - } - }, "MaxResults": { "target": "com.amazonaws.route53resolver#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of resolver rules that you want to return in the response to a ListResolverRules request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 resolver rules.

    " + "smithy.api#documentation": "

    The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 query logging configurations.

    " + } + }, + "SortOrder": { + "target": "com.amazonaws.route53resolver#SortOrder", + "traits": { + "smithy.api#documentation": "

    If you specified a value for SortBy, the order that you want query logging configurations to be listed in, \n\t\t\tASCENDING or DESCENDING.

    \n\t\t \n\t\t\t

    If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, \n\t\t\t\tyou must use the same value for SortOrder, if any, as in the previous request.

    \n\t\t     " } }, "Filters": { "target": "com.amazonaws.route53resolver#Filters", "traits": { - "smithy.api#documentation": "

    An optional specification to return a subset of resolver rules, such as all resolver rules that are associated with the same resolver endpoint.

    \n\t\t \n

    If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, \n\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n     " + "smithy.api#documentation": "

    An optional specification to return a subset of query logging configurations.

    \n\t\t \n\t\t\t

    If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, \n\t\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n\t\t     " + } + }, + "SortBy": { + "target": "com.amazonaws.route53resolver#SortByKey", + "traits": { + "smithy.api#documentation": "

    The element that you want Resolver to sort query logging configurations by.

    \n\t\t \n\t\t\t

    If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, \n\t\t\t\tyou must use the same value for SortBy, if any, as in the previous request.

    \n\t\t     \n\t\t\n\t\t

    Valid values include the following elements:

    \n\t\t
      \n
    • \n

      \n Arn: The ARN of the query logging configuration

      \n
      • \n
    • \n

      \n AssociationCount: The number of VPCs that are associated with the specified configuration

      \n
      • \n
    • \n

      \n CreationTime: The date and time that Resolver returned when the configuration was created

      \n
      • \n
    • \n

      \n CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created

      \n
      • \n
    • \n

      \n DestinationArn: The location that logs are sent to

      \n
      • \n
    • \n

      \n Id: The ID of the configuration

      \n
      • \n
    • \n

      \n Name: The name of the configuration

      \n
      • \n
    • \n

      \n OwnerId: The AWS account number of the account that created the configuration

      \n
      • \n
    • \n

      \n ShareStatus: Whether the configuration is shared with other AWS accounts or shared with the current account by \n\t\t\t\tanother AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

      \n
      • \n
    • \n

      \n Status: The current status of the configuration. Valid values include the following:

      \n\t\t\t\t\n\t\t\t\t
        \n
      • \n

        \n CREATING: Resolver is creating the query logging configuration.

        \n
        • \n
      • \n

        \n CREATED: The query logging configuration was successfully created. \n\t\t\t\t\t\tResolver is logging queries that originate in the specified VPC.

        \n
        • \n
      • \n

        \n DELETING: Resolver is deleting this query logging configuration.

        \n
        • \n
      • \n

        \n FAILED: Resolver either couldn't create or couldn't delete the query logging configuration.\n\t\t\t\t\t\tHere are two common causes:

        \n\t\t\t\t\t\t
          \n
        • \n

          The specified destination (for example, an Amazon S3 bucket) was deleted.

          \n
          • \n
        • \n

          Permissions don't allow sending logs to the destination.

          \n
          • \n
        \n\t\t\t\t\t
        • \n
      \n\t\t\t
      • \n
    " + } + }, + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", + "traits": { + "smithy.api#documentation": "

    For the first ListResolverQueryLogConfigs request, omit this value.

    \n\t\t

    If there are more than MaxResults query logging configurations that match the values that you specify for Filters, \n\t\t\tyou can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " } } } }, - "com.amazonaws.route53resolver#ListResolverRulesResponse": { + "com.amazonaws.route53resolver#ListResolverQueryLogConfigsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.route53resolver#NextToken", + "ResolverQueryLogConfigs": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigList", "traits": { - "smithy.api#documentation": "

    If more than MaxResults resolver rules match the specified criteria, you can submit another \n\t\t\tListResolverRules request to get the next group of results. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " + "smithy.api#documentation": "

    A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the \n\t\t\tvalues that you specified for Filter.

    " } }, - "MaxResults": { - "target": "com.amazonaws.route53resolver#MaxResults", + "TotalFilteredCount": { + "target": "com.amazonaws.route53resolver#Count", "traits": { - "smithy.api#documentation": "

    The value that you specified for MaxResults in the request.

    " + "smithy.api#documentation": "

    The total number of query logging configurations that were created by the current account in the specified Region and that match the filters \n\t\t\tthat were specified in the ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the \n\t\t\tcurrent account in the specified Region, see TotalCount.

    " } }, - "ResolverRules": { - "target": "com.amazonaws.route53resolver#ResolverRules", + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

    The resolver rules that were created using the current AWS account and that match the specified filters, if any.

    " + "smithy.api#documentation": "

    If there are more than MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request \n\t\t\tto get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

    " + } + }, + "TotalCount": { + "target": "com.amazonaws.route53resolver#Count", + "traits": { + "smithy.api#documentation": "

    The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the \n\t\t\tnumber of query logging configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify \n\t\t\tin the request.

    " } } } }, - "com.amazonaws.route53resolver#ListTagsForResource": { + "com.amazonaws.route53resolver#ListResolverRuleAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.route53resolver#ListTagsForResourceRequest" + "target": "com.amazonaws.route53resolver#ListResolverRuleAssociationsRequest" }, "output": { - "target": "com.amazonaws.route53resolver#ListTagsForResourceResponse" + "target": "com.amazonaws.route53resolver#ListResolverRuleAssociationsResponse" }, "errors": [ { @@ -1484,137 +1981,369 @@ { "target": "com.amazonaws.route53resolver#InvalidRequestException" }, - { - "target": "com.amazonaws.route53resolver#ResourceNotFoundException" - }, { "target": "com.amazonaws.route53resolver#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Lists the tags that you associated with the specified resource.

    " + "smithy.api#documentation": "

    Lists the associations that were created between Resolver rules and VPCs using the current AWS account.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.route53resolver#ListTagsForResourceRequest": { + "com.amazonaws.route53resolver#ListResolverRuleAssociationsRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.route53resolver#Arn", + "Filters": { + "target": "com.amazonaws.route53resolver#Filters", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the resource that you want to list tags for.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.

    \n\t\t \n

    If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, \n\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n     " } }, "MaxResults": { "target": "com.amazonaws.route53resolver#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of tags that you want to return in the response to a ListTagsForResource request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 tags.

    " + "smithy.api#documentation": "

    The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 rule associations.

    " } }, "NextToken": { "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

    For the first ListTagsForResource request, omit this value.

    \n\t\t

    If you have more than MaxResults tags, you can submit another ListTagsForResource request \n\t\t\tto get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

    " + "smithy.api#documentation": "

    For the first ListResolverRuleAssociation request, omit this value.

    \n\t\t

    If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request \n\t\t\tto get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

    " } } } }, - "com.amazonaws.route53resolver#ListTagsForResourceResponse": { + "com.amazonaws.route53resolver#ListResolverRuleAssociationsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

    If more than MaxResults tags match the specified criteria, you can submit another \n\t\t\tListTagsForResource request to get the next group of results. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " + "smithy.api#documentation": "

    If more than MaxResults rule associations match the specified criteria, you can submit another \n\t\t\tListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " } }, - "Tags": { - "target": "com.amazonaws.route53resolver#TagList", + "MaxResults": { + "target": "com.amazonaws.route53resolver#MaxResults", "traits": { - "smithy.api#documentation": "

    The tags that are associated with the resource that you specified in the ListTagsForResource request.

    " + "smithy.api#documentation": "

    The value that you specified for MaxResults in the request.

    " } - } - } - }, - "com.amazonaws.route53resolver#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.route53resolver#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 }, - "smithy.api#pattern": "(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)" - } - }, - "com.amazonaws.route53resolver#NextToken": { - "type": "string" - }, - "com.amazonaws.route53resolver#Port": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 0, - "max": 65535 + "ResolverRuleAssociations": { + "target": "com.amazonaws.route53resolver#ResolverRuleAssociations", + "traits": { + "smithy.api#documentation": "

    The associations that were created between Resolver rules and VPCs using the current AWS account, and that match the \n\t\t\tspecified filters, if any.

    " + } } } }, - "com.amazonaws.route53resolver#PutResolverRulePolicy": { + "com.amazonaws.route53resolver#ListResolverRules": { "type": "operation", "input": { - "target": "com.amazonaws.route53resolver#PutResolverRulePolicyRequest" + "target": "com.amazonaws.route53resolver#ListResolverRulesRequest" }, "output": { - "target": "com.amazonaws.route53resolver#PutResolverRulePolicyResponse" + "target": "com.amazonaws.route53resolver#ListResolverRulesResponse" }, "errors": [ { "target": "com.amazonaws.route53resolver#InternalServiceErrorException" }, + { + "target": "com.amazonaws.route53resolver#InvalidNextTokenException" + }, { "target": "com.amazonaws.route53resolver#InvalidParameterException" }, { - "target": "com.amazonaws.route53resolver#InvalidPolicyDocument" + "target": "com.amazonaws.route53resolver#InvalidRequestException" }, { - "target": "com.amazonaws.route53resolver#UnknownResourceException" + "target": "com.amazonaws.route53resolver#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

    Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

    " + "smithy.api#documentation": "

    Lists the Resolver rules that were created using the current AWS account.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.route53resolver#PutResolverRulePolicyRequest": { + "com.amazonaws.route53resolver#ListResolverRulesRequest": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.route53resolver#Arn", + "MaxResults": { + "target": "com.amazonaws.route53resolver#MaxResults", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the account that you want to grant permissions to.

    ", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 Resolver rules.

    " } }, - "ResolverRulePolicy": { - "target": "com.amazonaws.route53resolver#ResolverRulePolicy", + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

    An AWS Identity and Access Management policy statement that lists the permissions that you want to grant to another AWS account.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    For the first ListResolverRules request, omit this value.

    \n\t\t

    If you have more than MaxResults Resolver rules, you can submit another ListResolverRules request \n\t\t\tto get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.

    " } - } - } - }, + }, + "Filters": { + "target": "com.amazonaws.route53resolver#Filters", + "traits": { + "smithy.api#documentation": "

    An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.

    \n\t\t \n

    If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, \n\t\t\tyou must use the same values for Filters, if any, as in the previous request.

    \n     " + } + } + } + }, + "com.amazonaws.route53resolver#ListResolverRulesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", + "traits": { + "smithy.api#documentation": "

    If more than MaxResults Resolver rules match the specified criteria, you can submit another \n\t\t\tListResolverRules request to get the next group of results. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " + } + }, + "ResolverRules": { + "target": "com.amazonaws.route53resolver#ResolverRules", + "traits": { + "smithy.api#documentation": "

    The Resolver rules that were created using the current AWS account and that match the specified filters, if any.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.route53resolver#MaxResults", + "traits": { + "smithy.api#documentation": "

    The value that you specified for MaxResults in the request.

    " + } + } + } + }, + "com.amazonaws.route53resolver#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the tags that you associated with the specified resource.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53resolver#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.route53resolver#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of tags that you want to return in the response to a ListTagsForResource request. \n\t\t\tIf you don't specify a value for MaxResults, Resolver returns up to 100 tags.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", + "traits": { + "smithy.api#documentation": "

    For the first ListTagsForResource request, omit this value.

    \n\t\t

    If you have more than MaxResults tags, you can submit another ListTagsForResource request \n\t\t\tto get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

    " + } + }, + "ResourceArn": { + "target": "com.amazonaws.route53resolver#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the resource that you want to list tags for.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53resolver#NextToken", + "traits": { + "smithy.api#documentation": "

    If more than MaxResults tags match the specified criteria, you can submit another \n\t\t\tListTagsForResource request to get the next group of results. In the next request, specify the value of \n\t\t\tNextToken from the previous response.

    " + } + }, + "Tags": { + "target": "com.amazonaws.route53resolver#TagList", + "traits": { + "smithy.api#documentation": "

    The tags that are associated with the resource that you specified in the ListTagsForResource request.

    " + } + } + } + }, + "com.amazonaws.route53resolver#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.route53resolver#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)" + } + }, + "com.amazonaws.route53resolver#NextToken": { + "type": "string" + }, + "com.amazonaws.route53resolver#Port": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.route53resolver#PutResolverQueryLogConfigPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#PutResolverQueryLogConfigPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#PutResolverQueryLogConfigPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidPolicyDocument" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#UnknownResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

    Specifies an AWS account that you want to share a query logging configuration with, the query logging configuration that you want to share, \n\t\t\tand the operations that you want the account to be able to perform on the configuration.

    " + } + }, + "com.amazonaws.route53resolver#PutResolverQueryLogConfigPolicyRequest": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53resolver#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the account that you want to share rules with.

    ", + "smithy.api#required": {} + } + }, + "ResolverQueryLogConfigPolicy": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigPolicy", + "traits": { + "smithy.api#documentation": "

    An AWS Identity and Access Management policy statement that lists the query logging configurations that you want to share with another AWS account \n\t\t\tand the operations that you want the account to be able to perform. You can specify the following operations in the Actions section \n\t\t\tof the statement:

    \n\t\t
      \n
    • \n

      \n route53resolver:AssociateResolverQueryLogConfig\n

      \n
      • \n
    • \n

      \n route53resolver:DisassociateResolverQueryLogConfig\n

      \n
      • \n
    • \n

      \n route53resolver:ListResolverQueryLogConfigAssociations\n

      \n
      • \n
    • \n

      \n route53resolver:ListResolverQueryLogConfigs\n

      \n
      • \n
    \n\t\t\n\t\t

    In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share \n\t\t\twith the account that you specified in Arn.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#PutResolverQueryLogConfigPolicyResponse": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.route53resolver#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the PutResolverQueryLogConfigPolicy request was successful.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The response to a PutResolverQueryLogConfigPolicy request.

    " + } + }, + "com.amazonaws.route53resolver#PutResolverRulePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#PutResolverRulePolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#PutResolverRulePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidPolicyDocument" + }, + { + "target": "com.amazonaws.route53resolver#UnknownResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

    Specifies an AWS account that you want to share rules with, the Resolver rules that you want to share, and the operations that you want \n\t\t\tthe account to be able to perform on those rules.

    " + } + }, + "com.amazonaws.route53resolver#PutResolverRulePolicyRequest": { + "type": "structure", + "members": { + "ResolverRulePolicy": { + "target": "com.amazonaws.route53resolver#ResolverRulePolicy", + "traits": { + "smithy.api#documentation": "

    An AWS Identity and Access Management policy statement that lists the rules that you want to share with another AWS account and the operations that you want the account \n\t\t\tto be able to perform. You can specify the following operations in the Actions section of the statement:

    \n\t\t\t
      \n
    • \n

      \n route53resolver:GetResolverRule\n

      \n
      • \n
    • \n

      \n route53resolver:AssociateResolverRule\n

      \n
      • \n
    • \n

      \n route53resolver:DisassociateResolverRule\n

      \n
      • \n
    • \n

      \n route53resolver:ListResolverRules\n

      \n
      • \n
    • \n

      \n route53resolver:ListResolverRuleAssociations\n

      \n
      • \n
    \n\t\t\n\t\t

    In the Resource section of the statement, you specify the ARNs for the rules that you want to share with the account that you \n\t\t\tspecified in Arn.

    ", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.route53resolver#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the account that you want to share rules with.

    ", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.route53resolver#PutResolverRulePolicyResponse": { "type": "structure", "members": { @@ -1632,99 +2361,338 @@ "com.amazonaws.route53resolver#ResolverEndpoint": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.route53resolver#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) for the Resolver endpoint.

    " + } + }, + "HostVPCId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the VPC that you want to create the Resolver endpoint in.

    " + } + }, + "Direction": { + "target": "com.amazonaws.route53resolver#ResolverEndpointDirection", + "traits": { + "smithy.api#documentation": "

    Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

    \n\t\t
      \n
    • \n

      \n INBOUND: allows DNS queries to your VPC from your network

      \n
      • \n
    • \n

      \n OUTBOUND: allows DNS queries from your VPC to your network

      \n
      • \n
    " + } + }, + "CreatorRequestId": { + "target": "com.amazonaws.route53resolver#CreatorRequestId", + "traits": { + "smithy.api#documentation": "

    A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests \n\t\t\tto be retried without the risk of executing the operation twice.

    " + } + }, + "Id": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the Resolver endpoint.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.route53resolver#Rfc3339TimeString", + "traits": { + "smithy.api#documentation": "

    The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

    " + } + }, "Name": { "target": "com.amazonaws.route53resolver#Name", "traits": { - "smithy.api#documentation": "

    The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

    " + "smithy.api#documentation": "

    The name that you assigned to the Resolver endpoint when you submitted a \n\t\t\tCreateResolverEndpoint \n\t\t\trequest.

    " } }, - "ModificationTime": { - "target": "com.amazonaws.route53resolver#Rfc3339TimeString", + "StatusMessage": { + "target": "com.amazonaws.route53resolver#StatusMessage", "traits": { - "smithy.api#documentation": "

    The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

    " + "smithy.api#documentation": "

    A detailed description of the status of the Resolver endpoint.

    " } }, "SecurityGroupIds": { "target": "com.amazonaws.route53resolver#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

    The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

    " + "smithy.api#documentation": "

    The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules \n\t\t\t(for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. \n\t\t\tFor inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

    " + } + }, + "IpAddressCount": { + "target": "com.amazonaws.route53resolver#IpAddressCount", + "traits": { + "smithy.api#documentation": "

    The number of IP addresses that the Resolver endpoint can use for DNS queries.

    " } }, + "ModificationTime": { + "target": "com.amazonaws.route53resolver#Rfc3339TimeString", + "traits": { + "smithy.api#documentation": "

    The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

    " + } + }, + "Status": { + "target": "com.amazonaws.route53resolver#ResolverEndpointStatus", + "traits": { + "smithy.api#documentation": "

    A code that specifies the current status of the Resolver endpoint. Valid values include the following:

    \n\t\t
      \n
    • \n

      \n CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces \n\t\t\t\tfor this endpoint.

      \n
      • \n
    • \n

      \n OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and \n\t\t\t\table to pass inbound or outbound DNS queries between your network and Resolver.

      \n
      • \n
    • \n

      \n UPDATING: Resolver is associating or disassociating one or more network interfaces \n\t\t\t\twith this endpoint.

      \n
      • \n
    • \n

      \n AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces \n\t\t\t\tthat are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the \n\t\t\t\tlimit on the number of DNS queries per IP address (per network interface). For the current limit, see \n\t\t\t\tLimits on Route 53 Resolver.

      \n
      • \n
    • \n

      \n ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. \n\t\t\t\tTo resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address \n\t\t\t\tthat isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include \n\t\t\t\tat least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:

      \n\t\t\t\t
        \n
      • \n

        One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.

        \n
        • \n
      • \n

        The network interface couldn't be created for some reason that's outside the control of Resolver.

        \n
        • \n
      \n\t\t\t
      • \n
    • \n

      \n DELETING: Resolver is deleting this endpoint and the associated network interfaces.

      \n
      • \n
    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    In the response to a \n\t\t\tCreateResolverEndpoint, \n\t\t\tDeleteResolverEndpoint, \n\t\t\tGetResolverEndpoint, \n\t\t\tListResolverEndpoints, \n\t\t\tor \n\t\t\tUpdateResolverEndpoint \n\t\t\trequest, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.

    " + } + }, + "com.amazonaws.route53resolver#ResolverEndpointDirection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INBOUND", + "name": "Inbound" + }, + { + "value": "OUTBOUND", + "name": "Outbound" + } + ] + } + }, + "com.amazonaws.route53resolver#ResolverEndpointStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "Creating" + }, + { + "value": "OPERATIONAL", + "name": "Operational" + }, + { + "value": "UPDATING", + "name": "Updating" + }, + { + "value": "AUTO_RECOVERING", + "name": "AutoRecovering" + }, + { + "value": "ACTION_NEEDED", + "name": "ActionNeeded" + }, + { + "value": "DELETING", + "name": "Deleting" + } + ] + } + }, + "com.amazonaws.route53resolver#ResolverEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.route53resolver#ResolverEndpoint" + } + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfig": { + "type": "structure", + "members": { "CreationTime": { "target": "com.amazonaws.route53resolver#Rfc3339TimeString", "traits": { - "smithy.api#documentation": "

    The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

    " + "smithy.api#documentation": "

    The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).

    " } }, - "HostVPCId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "Arn": { + "target": "com.amazonaws.route53resolver#Arn", + "traits": { + "smithy.api#documentation": "

    The ARN for the query logging configuration.

    " + } + }, + "CreatorRequestId": { + "target": "com.amazonaws.route53resolver#CreatorRequestId", + "traits": { + "smithy.api#documentation": "

    A unique string that identifies the request that created the query logging configuration. The CreatorRequestId allows failed requests \n\t\t\tto be retried without the risk of executing the operation twice.

    " + } + }, + "Name": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigName", + "traits": { + "smithy.api#documentation": "

    The name of the query logging configuration.

    " + } + }, + "DestinationArn": { + "target": "com.amazonaws.route53resolver#DestinationArn", "traits": { - "smithy.api#documentation": "

    The ID of the VPC that you want to create the resolver endpoint in.

    " + "smithy.api#documentation": "

    The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or \n\t\t\ta Kinesis Data Firehose delivery stream.

    " + } + }, + "Status": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigStatus", + "traits": { + "smithy.api#documentation": "

    The status of the specified query logging configuration. Valid values include the following:

    \n\t\t
      \n
    • \n

      \n CREATING: Resolver is creating the query logging configuration.

      \n
      • \n
    • \n

      \n CREATED: The query logging configuration was successfully created. \n\t\t\t\tResolver is logging queries that originate in the specified VPC.

      \n
      • \n
    • \n

      \n DELETING: Resolver is deleting this query logging configuration.

      \n
      • \n
    • \n

      \n FAILED: Resolver can't deliver logs to the location that is specified in the query logging configuration. \n\t\t\t\tHere are two common causes:

      \n\t\t\t\t
        \n
      • \n

        The specified destination (for example, an Amazon S3 bucket) was deleted.

        \n
        • \n
      • \n

        Permissions don't allow sending logs to the destination.

        \n
        • \n
      \n\t\t\t
      • \n
    " } }, "Id": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver endpoint.

    " + "smithy.api#documentation": "

    The ID for the query logging configuration.

    " } }, - "Direction": { - "target": "com.amazonaws.route53resolver#ResolverEndpointDirection", + "ShareStatus": { + "target": "com.amazonaws.route53resolver#ShareStatus", "traits": { - "smithy.api#documentation": "

    Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

    \n\t\t
      \n
    • \n

      \n INBOUND: allows DNS queries to your VPC from your network or another VPC

      \n
      • \n
    • \n

      \n OUTBOUND: allows DNS queries from your VPC to your network or another VPC

      \n
      • \n
    " + "smithy.api#documentation": "

    An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another \n\t\t\tAWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

    " } }, + "OwnerId": { + "target": "com.amazonaws.route53resolver#AccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID for the account that created the query logging configuration.

    " + } + }, + "AssociationCount": { + "target": "com.amazonaws.route53resolver#Count", + "traits": { + "smithy.api#documentation": "

    The number of VPCs that are associated with the query logging configuration.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    In the response to a \n\t\t\tCreateResolverQueryLogConfig, \n\t\t\tDeleteResolverQueryLogConfig, \n\t\t\tGetResolverQueryLogConfig, \n\t\t\tor \n\t\t\tListResolverQueryLogConfigs \n\t\t\trequest, a complex type that contains settings for one query logging configuration.

    " + } + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociation": { + "type": "structure", + "members": { "Status": { - "target": "com.amazonaws.route53resolver#ResolverEndpointStatus", + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationStatus", "traits": { - "smithy.api#documentation": "

    A code that specifies the current status of the resolver endpoint.

    " + "smithy.api#documentation": "

    The status of the specified query logging association. Valid values include the following:

    \n\t\t
      \n
    • \n

      \n CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.

      \n
      • \n
    • \n

      \n CREATED: The association between an Amazon VPC and a query logging configuration \n\t\t\t\twas successfully created. Resolver is logging queries that originate in the specified VPC.

      \n
      • \n
    • \n

      \n DELETING: Resolver is deleting this query logging association.

      \n
      • \n
    • \n

      \n FAILED: Resolver either couldn't create or couldn't delete the query logging association.

      \n
      • \n
    " } }, - "Arn": { - "target": "com.amazonaws.route53resolver#Arn", + "ResolverQueryLogConfigId": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ARN (Amazon Resource Name) for the resolver endpoint.

    " + "smithy.api#documentation": "

    The ID of the query logging configuration that a VPC is associated with.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.route53resolver#StatusMessage", + "Id": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    A detailed description of the status of the resolver endpoint.

    " + "smithy.api#documentation": "

    The ID of the query logging association.

    " } }, - "CreatorRequestId": { - "target": "com.amazonaws.route53resolver#CreatorRequestId", + "ErrorMessage": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationErrorMessage", "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests \n\t\t\tto be retried without the risk of executing the operation twice.

    " + "smithy.api#documentation": "

    Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

    " } }, - "IpAddressCount": { - "target": "com.amazonaws.route53resolver#IpAddressCount", + "ResourceId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the Amazon VPC that is associated with the query logging configuration.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.route53resolver#Rfc3339TimeString", + "traits": { + "smithy.api#documentation": "

    The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

    " + } + }, + "Error": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationError", "traits": { - "smithy.api#documentation": "

    The number of IP addresses that the resolver endpoint can use for DNS queries.

    " + "smithy.api#documentation": "

    If the value of Status is FAILED, the value of Error indicates the cause:

    \n\t\t
      \n
    • \n

      \n DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.

      \n
      • \n
    • \n

      \n ACCESS_DENIED: Permissions don't allow sending logs to the destination.

      \n
      • \n
    \n\t\t

    If the value of Status is a value other than FAILED, Error is null.

    " } } }, "traits": { - "smithy.api#documentation": "

    In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint,\n\t\t\tListResolverEndpoints, or UpdateResolverEndpoint request, a complex type that contains settings \n\t\t\tfor an existing inbound or outbound resolver endpoint.

    " + "smithy.api#documentation": "

    In the response to an \n\t\t\tAssociateResolverQueryLogConfig, \n\t\t\tDisassociateResolverQueryLogConfig, \n\t\t\tGetResolverQueryLogConfigAssociation, \n\t\t\tor \n\t\t\tListResolverQueryLogConfigAssociations,\n\t\t\trequest, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

    " } }, - "com.amazonaws.route53resolver#ResolverEndpointDirection": { + "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationError": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "None" + }, + { + "value": "DESTINATION_NOT_FOUND", + "name": "DestinationNotFound" + }, + { + "value": "ACCESS_DENIED", + "name": "AccessDenied" + }, + { + "value": "INTERNAL_SERVICE_ERROR", + "name": "InternalServiceError" + } + ] + } + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationErrorMessage": { + "type": "string" + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociation" + } + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfigAssociationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "Creating" + }, + { + "value": "ACTIVE", + "name": "Active" + }, + { + "value": "ACTION_NEEDED", + "name": "ActionNeeded" + }, + { + "value": "DELETING", + "name": "Deleting" + }, + { + "value": "FAILED", + "name": "Failed" + } + ] + } + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53resolver#ResolverQueryLogConfig" + } + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfigName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)" + } + }, + "com.amazonaws.route53resolver#ResolverQueryLogConfigPolicy": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "INBOUND", - "name": "Inbound" - }, - { - "value": "OUTBOUND", - "name": "Outbound" - } - ] + "smithy.api#length": { + "min": 0, + "max": 5000 + } } }, - "com.amazonaws.route53resolver#ResolverEndpointStatus": { + "com.amazonaws.route53resolver#ResolverQueryLogConfigStatus": { "type": "string", "traits": { "smithy.api#enum": [ @@ -1733,77 +2701,75 @@ "name": "Creating" }, { - "value": "OPERATIONAL", - "name": "Operational" - }, - { - "value": "UPDATING", - "name": "Updating" - }, - { - "value": "AUTO_RECOVERING", - "name": "AutoRecovering" - }, - { - "value": "ACTION_NEEDED", - "name": "ActionNeeded" + "value": "CREATED", + "name": "Created" }, { "value": "DELETING", "name": "Deleting" + }, + { + "value": "FAILED", + "name": "Failed" } ] } }, - "com.amazonaws.route53resolver#ResolverEndpoints": { - "type": "list", - "member": { - "target": "com.amazonaws.route53resolver#ResolverEndpoint" - } - }, "com.amazonaws.route53resolver#ResolverRule": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.route53resolver#Arn", + "ModificationTime": { + "target": "com.amazonaws.route53resolver#Rfc3339TimeString", "traits": { - "smithy.api#documentation": "

    The ARN (Amazon Resource Name) for the resolver rule specified by Id.

    " + "smithy.api#documentation": "

    The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

    " } }, - "RuleType": { - "target": "com.amazonaws.route53resolver#RuleTypeOption", + "DomainName": { + "target": "com.amazonaws.route53resolver#DomainName", "traits": { - "smithy.api#documentation": "

    This value is always FORWARD. Other resolver rule types aren't supported.

    " + "smithy.api#documentation": "

    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches \n\t\t\tmultiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name \n\t\t\t(www.example.com).

    " } }, - "CreatorRequestId": { - "target": "com.amazonaws.route53resolver#CreatorRequestId", + "Id": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests \n\t\t\tto be retried without the risk of executing the operation twice.

    " + "smithy.api#documentation": "

    The ID that Resolver assigned to the Resolver rule when you created it.

    " } }, - "Id": { + "ResolverEndpointId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID that Resolver assigned to the resolver rule when you created it.

    " + "smithy.api#documentation": "

    The ID of the endpoint that the rule is associated with.

    " } }, - "ShareStatus": { - "target": "com.amazonaws.route53resolver#ShareStatus", + "StatusMessage": { + "target": "com.amazonaws.route53resolver#StatusMessage", "traits": { - "smithy.api#documentation": "

    Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or \n\t\t\tanother account is sharing the rule with the current account.

    " + "smithy.api#documentation": "

    A detailed description of the status of a Resolver rule.

    " } }, - "Status": { - "target": "com.amazonaws.route53resolver#ResolverRuleStatus", + "RuleType": { + "target": "com.amazonaws.route53resolver#RuleTypeOption", "traits": { - "smithy.api#documentation": "

    A code that specifies the current status of the resolver rule.

    " + "smithy.api#documentation": "

    When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

    \n\t\t

    When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for \n\t\t\ta subdomain of that domain, specify SYSTEM.

    \n\t\t

    For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD \n\t\t\tfor RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify \n\t\t\tSYSTEM for RuleType.

    \n\t\t

    Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

    " } }, - "DomainName": { - "target": "com.amazonaws.route53resolver#DomainName", + "CreatorRequestId": { + "target": "com.amazonaws.route53resolver#CreatorRequestId", + "traits": { + "smithy.api#documentation": "

    A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and \n\t\t\tallows failed requests to be retried without the risk of executing the operation twice.

    " + } + }, + "TargetIps": { + "target": "com.amazonaws.route53resolver#TargetList", "traits": { - "smithy.api#documentation": "

    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches \n\t\t\tmultiple resolver rules (example.com and www.example.com), the query is routed using the resolver rule that contains the most specific domain name \n\t\t\t(www.example.com).

    " + "smithy.api#documentation": "

    An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, \n\t\t\tthese are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

    " + } + }, + "Name": { + "target": "com.amazonaws.route53resolver#Name", + "traits": { + "smithy.api#documentation": "

    The name for the Resolver rule, which you specified when you created the Resolver rule.

    " } }, "OwnerId": { @@ -1812,77 +2778,77 @@ "smithy.api#documentation": "

    When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

    " } }, - "ResolverEndpointId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "ShareStatus": { + "target": "com.amazonaws.route53resolver#ShareStatus", "traits": { - "smithy.api#documentation": "

    The ID of the endpoint that the rule is associated with.

    " + "smithy.api#documentation": "

    Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or \n\t\t\tanother account is sharing the rule with the current account.

    " } }, - "TargetIps": { - "target": "com.amazonaws.route53resolver#TargetList", + "CreationTime": { + "target": "com.amazonaws.route53resolver#Rfc3339TimeString", "traits": { - "smithy.api#documentation": "

    An array that contains the IP addresses and ports that you want to forward

    " + "smithy.api#documentation": "

    The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

    " } }, - "Name": { - "target": "com.amazonaws.route53resolver#Name", + "Arn": { + "target": "com.amazonaws.route53resolver#Arn", "traits": { - "smithy.api#documentation": "

    The name for the resolver rule, which you specified when you created the resolver rule.

    " + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) for the Resolver rule specified by Id.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.route53resolver#StatusMessage", + "Status": { + "target": "com.amazonaws.route53resolver#ResolverRuleStatus", "traits": { - "smithy.api#documentation": "

    A detailed description of the status of a resolver rule.

    " + "smithy.api#documentation": "

    A code that specifies the current status of the Resolver rule.

    " } } }, "traits": { - "smithy.api#documentation": "

    For queries that originate in your VPC, detailed information about a resolver rule, which specifies how to route DNS queries \n\t\t\tout of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, \n\t\t\tDeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule \n\t\t\trequest.

    " + "smithy.api#documentation": "

    For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries \n\t\t\tout of the VPC. The ResolverRule parameter appears in the response to a \n\t\t\tCreateResolverRule, \n\t\t\tDeleteResolverRule, \n\t\t\tGetResolverRule, \n\t\t\tListResolverRules, \n\t\t\tor \n\t\t\tUpdateResolverRule request.

    " } }, "com.amazonaws.route53resolver#ResolverRuleAssociation": { "type": "structure", "members": { - "VPCId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "StatusMessage": { + "target": "com.amazonaws.route53resolver#StatusMessage", "traits": { - "smithy.api#documentation": "

    The ID of the VPC that you associated the resolver rule with.

    " + "smithy.api#documentation": "

    A detailed description of the status of the association between a Resolver rule and a VPC.

    " } }, - "Status": { - "target": "com.amazonaws.route53resolver#ResolverRuleAssociationStatus", + "Name": { + "target": "com.amazonaws.route53resolver#Name", "traits": { - "smithy.api#documentation": "

    A code that specifies the current status of the association between a resolver rule and a VPC.

    " + "smithy.api#documentation": "

    The name of an association between a Resolver rule and a VPC.

    " } }, - "ResolverRuleId": { + "Id": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule that you associated with the VPC that is specified by VPCId.

    " + "smithy.api#documentation": "

    The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an \n\t\t\tAssociateResolverRule \n\t\t\trequest.

    " } }, - "Id": { - "target": "com.amazonaws.route53resolver#ResourceId", + "Status": { + "target": "com.amazonaws.route53resolver#ResolverRuleAssociationStatus", "traits": { - "smithy.api#documentation": "

    The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an \n\t\t\tAssociateResolverRule request.

    " + "smithy.api#documentation": "

    A code that specifies the current status of the association between a Resolver rule and a VPC.

    " } }, - "Name": { - "target": "com.amazonaws.route53resolver#Name", + "VPCId": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The name of an association between a resolver rule and a VPC.

    " + "smithy.api#documentation": "

    The ID of the VPC that you associated the Resolver rule with.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.route53resolver#StatusMessage", + "ResolverRuleId": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    A detailed description of the status of the association between a resolver rule and a VPC.

    " + "smithy.api#documentation": "

    The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.

    " } } }, "traits": { - "smithy.api#documentation": "

    In the response to an AssociateResolverRule, \n\t\t\tDisassociateResolverRule, or ListResolverRuleAssociations request, \n\t\t\tinformation about an association between a resolver rule and a VPC.

    " + "smithy.api#documentation": "

    In the response to an \n\t\t\tAssociateResolverRule, \n\t\t\tDisassociateResolverRule, \n\t\t\tor \n\t\t\tListResolverRuleAssociations \n\t\t\trequest, provides information about an association between a Resolver rule and a VPC. \n\t\t\tThe association determines which DNS queries that originate in the VPC are forwarded to your network.

    " } }, "com.amazonaws.route53resolver#ResolverRuleAssociationStatus": { @@ -1924,24 +2890,24 @@ "ResolverEndpointId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the new outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in \n\t\t\tTargetIps.

    " + "smithy.api#documentation": "

    The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in \n\t\t\tTargetIps.

    " } }, - "TargetIps": { - "target": "com.amazonaws.route53resolver#TargetList", + "Name": { + "target": "com.amazonaws.route53resolver#Name", "traits": { - "smithy.api#documentation": "

    For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

    " + "smithy.api#documentation": "

    The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

    " } }, - "Name": { - "target": "com.amazonaws.route53resolver#Name", + "TargetIps": { + "target": "com.amazonaws.route53resolver#TargetList", "traits": { - "smithy.api#documentation": "

    The new name for the resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

    " + "smithy.api#documentation": "

    For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

    " } } }, "traits": { - "smithy.api#documentation": "

    In an UpdateResolverRule request, information about the changes that you want to make.

    " + "smithy.api#documentation": "

    In an \n\t\t\tUpdateResolverRule\n\t\t\trequest, information about the changes that you want to make.

    " } }, "com.amazonaws.route53resolver#ResolverRulePolicy": { @@ -1985,14 +2951,14 @@ "com.amazonaws.route53resolver#ResourceExistsException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.route53resolver#String" + }, "ResourceType": { "target": "com.amazonaws.route53resolver#String", "traits": { "smithy.api#documentation": "

    For a ResourceExistsException error, the type of resource that the error applies to.

    " } - }, - "Message": { - "target": "com.amazonaws.route53resolver#String" } }, "traits": { @@ -2012,14 +2978,14 @@ "com.amazonaws.route53resolver#ResourceInUseException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.route53resolver#String" + }, "ResourceType": { "target": "com.amazonaws.route53resolver#String", "traits": { "smithy.api#documentation": "

    For a ResourceInUseException error, the type of resource that is currently in use.

    " } - }, - "Message": { - "target": "com.amazonaws.route53resolver#String" } }, "traits": { @@ -2048,14 +3014,14 @@ "com.amazonaws.route53resolver#ResourceUnavailableException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.route53resolver#String" + }, "ResourceType": { "target": "com.amazonaws.route53resolver#String", "traits": { "smithy.api#documentation": "

    For a ResourceUnavailableException error, the type of resource that isn't available.

    " } - }, - "Message": { - "target": "com.amazonaws.route53resolver#String" } }, "traits": { @@ -2079,30 +3045,51 @@ { "target": "com.amazonaws.route53resolver#AssociateResolverEndpointIpAddress" }, + { + "target": "com.amazonaws.route53resolver#AssociateResolverQueryLogConfig" + }, { "target": "com.amazonaws.route53resolver#AssociateResolverRule" }, { "target": "com.amazonaws.route53resolver#CreateResolverEndpoint" }, + { + "target": "com.amazonaws.route53resolver#CreateResolverQueryLogConfig" + }, { "target": "com.amazonaws.route53resolver#CreateResolverRule" }, { "target": "com.amazonaws.route53resolver#DeleteResolverEndpoint" }, + { + "target": "com.amazonaws.route53resolver#DeleteResolverQueryLogConfig" + }, { "target": "com.amazonaws.route53resolver#DeleteResolverRule" }, { "target": "com.amazonaws.route53resolver#DisassociateResolverEndpointIpAddress" }, + { + "target": "com.amazonaws.route53resolver#DisassociateResolverQueryLogConfig" + }, { "target": "com.amazonaws.route53resolver#DisassociateResolverRule" }, { "target": "com.amazonaws.route53resolver#GetResolverEndpoint" }, + { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfig" + }, + { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigAssociation" + }, + { + "target": "com.amazonaws.route53resolver#GetResolverQueryLogConfigPolicy" + }, { "target": "com.amazonaws.route53resolver#GetResolverRule" }, @@ -2118,6 +3105,12 @@ { "target": "com.amazonaws.route53resolver#ListResolverEndpoints" }, + { + "target": "com.amazonaws.route53resolver#ListResolverQueryLogConfigAssociations" + }, + { + "target": "com.amazonaws.route53resolver#ListResolverQueryLogConfigs" + }, { "target": "com.amazonaws.route53resolver#ListResolverRuleAssociations" }, @@ -2127,6 +3120,9 @@ { "target": "com.amazonaws.route53resolver#ListTagsForResource" }, + { + "target": "com.amazonaws.route53resolver#PutResolverQueryLogConfigPolicy" + }, { "target": "com.amazonaws.route53resolver#PutResolverRulePolicy" }, @@ -2154,7 +3150,7 @@ "name": "route53resolver" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

    Here's how you set up to query an Amazon Route 53 private hosted zone from your network:

    \n\t\t\n\t\t
      \n
    1. \n

      Connect your network to a VPC using AWS Direct Connect or a VPN.

      \n
      2. \n
    2. \n

      Run the following AWS CLI command to create a Resolver endpoint:

      \n\t\t\t\t

      \n create-resolver-endpoint --name [endpoint_name] --direction INBOUND \n\t\t\t\t\t--creator-request-id [unique_string] --security-group-ids [security_group_with_inbound_rules] \n\t\t\t\t\t--ip-addresses SubnetId=[subnet_id] SubnetId=[subnet_id_in_different_AZ]\n

      \n\t\t\t\t

      Note the resolver endpoint ID that appears in the response. You'll use it in step 3.

      \n\t\t\t
      3. \n
    3. \n

      Get the IP addresses for the Resolver endpoints:

      \n\t\t\t\t

      \n get-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]\n

      \n\t\t\t
      4. \n
    4. \n

      In your network configuration, define the IP addresses that you got in step 3 as DNS servers.

      \n\t\t\t\t

      You can now query instance names in your VPCs and the names of records in your private hosted zone.

      \n\t\t\t
      5. \n
    \n\n\t\t

    You can also perform the following operations using the AWS CLI:

    \n\t\t
      \n
    • \n

      \n list-resolver-endpoints: List all endpoints. The syntax includes options for pagination and filtering.

      \n
      • \n
    • \n

      \n update-resolver-endpoints: Add IP addresses to an endpoint or remove IP addresses from an endpoint.

      \n
      • \n
    \n\n\t\t

    To delete an endpoint, use the following AWS CLI command:

    \n\t\t

    \n delete-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]\n

    ", + "smithy.api#documentation": "

    When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. \n\t\t\tBy default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or ELB load balancers. \n\t\t\tResolver performs recursive lookups against public name servers for all other domain names.

    \n\n\t\t

    You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

    \n\n\t\t

    \n Forward DNS queries from resolvers on your network to Route 53 Resolver\n

    \n\n\t\t

    DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers \n\t\t\tto easily resolve domain names for AWS resources such as EC2 instances or records in a Route 53 private hosted zone. \n\t\t\tFor more information, see \n\t\t\tHow DNS Resolvers \n\t\t\ton Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

    \n\t\t\n\t\t

    \n Conditionally forward queries from a VPC to resolvers on your network\n

    \n\n\t\t

    You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. \n\t\t\tTo forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward \n\t\t\t(such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. \n\t\t\tIf a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match \n\t\t\t(acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see \n\t\t\tHow Route 53 Resolver \n\t\t\tForwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

    \n\n\t\t

    Like Amazon VPC, Resolver is regional. In each region where you have VPCs, you can choose whether to forward queries from your VPCs \n\t\t\tto your network (outbound queries), from your network to your VPCs (inbound queries), or both.

    ", "smithy.api#title": "Amazon Route 53 Resolver" } }, @@ -2202,6 +3198,30 @@ ] } }, + "com.amazonaws.route53resolver#SortByKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53resolver#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASCENDING", + "name": "Ascending" + }, + { + "value": "DESCENDING", + "name": "Descending" + } + ] + } + }, "com.amazonaws.route53resolver#StatusMessage": { "type": "string", "traits": { @@ -2226,16 +3246,18 @@ "com.amazonaws.route53resolver#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.route53resolver#TagKey", + "Value": { + "target": "com.amazonaws.route53resolver#TagValue", "traits": { - "smithy.api#documentation": "

    The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, \n\t\t\tthe value of Key might be account-id.

    " + "smithy.api#documentation": "

    The value for the tag. For example, if Key is account-id, then Value might be the ID of the \n\t\t\tcustomer account that you're creating the resource for.

    ", + "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.route53resolver#TagValue", + "Key": { + "target": "com.amazonaws.route53resolver#TagKey", "traits": { - "smithy.api#documentation": "

    The value for the tag. For example, if Key is account-id, then Value might be the ID of the \n\t\t\tcustomer account that you're creating the resource for.

    " + "smithy.api#documentation": "

    The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, \n\t\t\tthe value of Key might be account-id.

    ", + "smithy.api#required": {} } } }, @@ -2244,18 +3266,36 @@ } }, "com.amazonaws.route53resolver#TagKey": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } }, "com.amazonaws.route53resolver#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.route53resolver#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } } }, "com.amazonaws.route53resolver#TagList": { "type": "list", "member": { "target": "com.amazonaws.route53resolver#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } } }, "com.amazonaws.route53resolver#TagResource": { @@ -2273,6 +3313,9 @@ { "target": "com.amazonaws.route53resolver#InvalidParameterException" }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, { "target": "com.amazonaws.route53resolver#InvalidTagException" }, @@ -2293,17 +3336,17 @@ "com.amazonaws.route53resolver#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.route53resolver#TagList", + "ResourceArn": { + "target": "com.amazonaws.route53resolver#Arn", "traits": { - "smithy.api#documentation": "

    The tags that you want to add to the specified resource.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable \n\t\t\tGet or List command:

    \n\t\t\t ", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.route53resolver#Arn", + "Tags": { + "target": "com.amazonaws.route53resolver#TagList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable \n\t\t\tGet or List command:

    \n\t\t\t ", + "smithy.api#documentation": "

    The tags that you want to add to the specified resource.

    ", "smithy.api#required": {} } } @@ -2314,28 +3357,34 @@ "members": {} }, "com.amazonaws.route53resolver#TagValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, "com.amazonaws.route53resolver#TargetAddress": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.route53resolver#Port", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The port at Ip that you want to forward DNS queries to.

    " - } - }, "Ip": { "target": "com.amazonaws.route53resolver#Ip", "traits": { "smithy.api#documentation": "

    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

    ", "smithy.api#required": {} } + }, + "Port": { + "target": "com.amazonaws.route53resolver#Port", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The port at Ip that you want to forward DNS queries to.

    " + } } }, "traits": { - "smithy.api#documentation": "

    In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

    " + "smithy.api#documentation": "

    In a \n\t\t\tCreateResolverRule\n\t\t\trequest, an array of the IPs that you want to forward DNS queries to.

    " } }, "com.amazonaws.route53resolver#TargetList": { @@ -2388,6 +3437,9 @@ { "target": "com.amazonaws.route53resolver#InvalidParameterException" }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, { "target": "com.amazonaws.route53resolver#ResourceNotFoundException" }, @@ -2405,7 +3457,7 @@ "ResourceArn": { "target": "com.amazonaws.route53resolver#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable \n\t\t\tGet or List command:

    \n\t\t\t ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable \n\t\t\tGet or List command:

    \n\t\t\t ", "smithy.api#required": {} } }, @@ -2448,7 +3500,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates the name of an inbound or an outbound resolver endpoint.

    " + "smithy.api#documentation": "

    Updates the name of an inbound or an outbound Resolver endpoint.

    " } }, "com.amazonaws.route53resolver#UpdateResolverEndpointRequest": { @@ -2457,14 +3509,14 @@ "ResolverEndpointId": { "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the resolver endpoint that you want to update.

    ", + "smithy.api#documentation": "

    The ID of the Resolver endpoint that you want to update.

    ", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.route53resolver#Name", "traits": { - "smithy.api#documentation": "

    The name of the resolver endpoint that you want to update.

    " + "smithy.api#documentation": "

    The name of the Resolver endpoint that you want to update.

    " } } } @@ -2512,23 +3564,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. \n\t\t\tIf you don't specify a parameter, it retains its current value.

    " + "smithy.api#documentation": "

    Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. \n\t\t\tIf you don't specify a parameter, it retains its current value.

    " } }, "com.amazonaws.route53resolver#UpdateResolverRuleRequest": { "type": "structure", "members": { - "Config": { - "target": "com.amazonaws.route53resolver#ResolverRuleConfig", + "ResolverRuleId": { + "target": "com.amazonaws.route53resolver#ResourceId", "traits": { - "smithy.api#documentation": "

    The new settings for the resolver rule.

    ", + "smithy.api#documentation": "

    The ID of the Resolver rule that you want to update.

    ", "smithy.api#required": {} } }, - "ResolverRuleId": { - "target": "com.amazonaws.route53resolver#ResourceId", + "Config": { + "target": "com.amazonaws.route53resolver#ResolverRuleConfig", "traits": { - "smithy.api#documentation": "

    The ID of the resolver rule that you want to update.

    ", + "smithy.api#documentation": "

    The new settings for the Resolver rule.

    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json b/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json index 7d793ab5169b..e0cd3e50f9fe 100644 --- a/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json +++ b/codegen/sdk-codegen/aws-models/s3-control.2018-08-20.json @@ -141,7 +141,7 @@ "name": "s3" }, "aws.protocols#restXml": {}, - "smithy.api#documentation": "

    \n AWS S3 Control provides access to Amazon S3 control plane operations.\n

    ", + "smithy.api#documentation": "

    \n AWS S3 Control provides access to Amazon S3 control plane operations.\n \n

    ", "smithy.api#title": "AWS S3 Control", "smithy.api#xmlNamespace": { "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" @@ -152,42 +152,51 @@ "type": "structure", "members": { "DaysAfterInitiation": { - "target": "com.amazonaws.s3control#DaysAfterInitiation" + "target": "com.amazonaws.s3control#DaysAfterInitiation", + "traits": { + "smithy.api#documentation": "

    Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to\n the Outposts bucket.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container for abort incomplete multipart upload

    " } }, "com.amazonaws.s3control#AccessPoint": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.s3control#AccessPointName", + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", "traits": { - "smithy.api#documentation": "

    The name of this access point.

    ", + "smithy.api#documentation": "

    The name of the bucket associated with this access point.

    ", "smithy.api#required": {} } }, - "NetworkOrigin": { - "target": "com.amazonaws.s3control#NetworkOrigin", + "AccessPointArn": { + "target": "com.amazonaws.s3control#S3AccessPointArn", "traits": { - "smithy.api#documentation": "

    Indicates whether this access point allows access from the public internet. If\n VpcConfiguration is specified for this access point, then\n NetworkOrigin is VPC, and the access point doesn't allow access from\n the public internet. Otherwise, NetworkOrigin is Internet, and\n the access point allows access from the public internet, subject to the access point and bucket access\n policies.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ARN for the access point.

    " } }, - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", + "NetworkOrigin": { + "target": "com.amazonaws.s3control#NetworkOrigin", "traits": { - "smithy.api#documentation": "

    The name of the bucket associated with this access point.

    ", + "smithy.api#documentation": "

    Indicates whether this access point allows access from the public internet. If\n VpcConfiguration is specified for this access point, then\n NetworkOrigin is VPC, and the access point doesn't allow access from\n the public internet. Otherwise, NetworkOrigin is Internet, and\n the access point allows access from the public internet, subject to the access point and bucket access\n policies.

    ", "smithy.api#required": {} } }, - "AccessPointArn": { - "target": "com.amazonaws.s3control#S3AccessPointArn" - }, "VpcConfiguration": { "target": "com.amazonaws.s3control#VpcConfiguration", "traits": { "smithy.api#documentation": "

    The virtual private cloud (VPC) configuration for this access point, if one exists.

    " } + }, + "Name": { + "target": "com.amazonaws.s3control#AccessPointName", + "traits": { + "smithy.api#documentation": "

    The name of this access point.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -241,6 +250,7 @@ "type": "structure", "members": {}, "traits": { + "smithy.api#documentation": "

    The requested Outposts bucket name is not available. The bucket namespace is shared by\n all users of the AWS Outposts in this Region. Select a different name and try\n again.

    ", "smithy.api#error": "client" } }, @@ -248,6 +258,7 @@ "type": "structure", "members": {}, "traits": { + "smithy.api#documentation": "

    The Outposts bucket you tried to create already exists, and you own it.

    ", "smithy.api#error": "client" } }, @@ -334,7 +345,7 @@ "target": "com.amazonaws.s3control#CreateAccessPointResult" }, "traits": { - "smithy.api#documentation": "

    Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

    ", + "smithy.api#documentation": "

    Creates an access point and associates it with the specified bucket. For more information, see \n Managing Data Access with Amazon S3 Access \n Points in the Amazon Simple Storage Service Developer Guide.

    \n

    \n

    \n Using this action with Amazon S3 on Outposts\n

    \n

    This action:

    \n
      \n
    • \n

      Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.

      \n
      • \n
    • \n

      Does not support ACL on S3 on Outposts buckets.

      \n
      • \n
    • \n

      Does not support Public Access on S3 on Outposts buckets.

      \n
      • \n
    • \n

      Does not support object lock for S3 on Outposts buckets.

      \n
      • \n
    \n

    For more information, see \n Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .

    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n

    \n

    The following actions are related to CreateAccessPoint:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -348,15 +359,6 @@ "com.amazonaws.s3control#CreateAccessPointRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.s3control#AccountId", - "traits": { - "smithy.api#documentation": "

    The AWS account ID for the owner of the bucket for which you want to create an access point.

    ", - "smithy.api#hostLabel": {}, - "smithy.api#httpHeader": "x-amz-account-id", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { @@ -368,7 +370,7 @@ "VpcConfiguration": { "target": "com.amazonaws.s3control#VpcConfiguration", "traits": { - "smithy.api#documentation": "

    If you include this field, Amazon S3 restricts access to this access point to requests from the\n specified virtual private cloud (VPC).

    " + "smithy.api#documentation": "

    If you include this field, Amazon S3 restricts access to this access point to requests from the\n specified virtual private cloud (VPC).

    \n \n

    This is required for creating an access point for Amazon S3 on Outposts buckets.

    \n     " } }, "PublicAccessBlockConfiguration": { @@ -377,7 +379,16 @@ "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { - "smithy.api#documentation": "

    The name of the bucket that you want to associate this access point with.

    ", + "smithy.api#documentation": "

    The name of the bucket that you want to associate this access point with.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID for the owner of the bucket for which you want to create an access point.

    ", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } } @@ -387,7 +398,10 @@ "type": "structure", "members": { "AccessPointArn": { - "target": "com.amazonaws.s3control#S3AccessPointArn" + "target": "com.amazonaws.s3control#S3AccessPointArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the access point.

    " + } } } }, @@ -408,6 +422,7 @@ } ], "traits": { + "smithy.api#documentation": "\n

    This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API.\n

    \n     \n

    Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. \n For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.

    \n

    Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

    \n \n

    S3 on Outposts buckets do not support

    \n
      \n
    • \n

      ACLs. Instead, configure access point policies to manage\n access to buckets.

      \n
      • \n
    • \n

      Public access.

      \n
      • \n
    • \n

      Object Lock

      \n
      • \n
    • \n

      Bucket Location constraint

      \n
      • \n
    \n

    For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the \n \n Example section below.

    \n \n

    The following actions are related to CreateBucket for Amazon S3 on Outposts:

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/v20180820/bucket/{Bucket}", @@ -420,87 +435,107 @@ "type": "structure", "members": { "LocationConstraint": { - "target": "com.amazonaws.s3control#BucketLocationConstraint" + "target": "com.amazonaws.s3control#BucketLocationConstraint", + "traits": { + "smithy.api#documentation": "

    Specifies the Region where the bucket will be created. \n If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), \n you do not need to specify the location.\n

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container for the bucket configuration.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     " } }, "com.amazonaws.s3control#CreateBucketRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantFullControl": { - "target": "com.amazonaws.s3control#GrantFullControl", + "ObjectLockEnabledForBucket": { + "target": "com.amazonaws.s3control#ObjectLockEnabledForBucket", "traits": { - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" } }, "GrantRead": { "target": "com.amazonaws.s3control#GrantRead", "traits": { + "smithy.api#documentation": "

    Allows grantee to list the objects in the bucket.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", "smithy.api#httpHeader": "x-amz-grant-read" } }, - "GrantReadACP": { - "target": "com.amazonaws.s3control#GrantReadACP", - "traits": { - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, "ACL": { "target": "com.amazonaws.s3control#BucketCannedACL", "traits": { + "smithy.api#documentation": "

    The canned ACL to apply to the bucket.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", "smithy.api#httpHeader": "x-amz-acl" } }, "GrantWrite": { "target": "com.amazonaws.s3control#GrantWrite", "traits": { + "smithy.api#documentation": "

    Allows grantee to create, overwrite, and delete any object in the bucket.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", "smithy.api#httpHeader": "x-amz-grant-write" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3control#GrantWriteACP", + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", "traits": { - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "smithy.api#documentation": "

    The name of the bucket.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3control#GrantFullControl", + "traits": { + "smithy.api#documentation": "

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, "CreateBucketConfiguration": { "target": "com.amazonaws.s3control#CreateBucketConfiguration", "traits": { + "smithy.api#documentation": "

    The configuration information for the bucket.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", "smithy.api#httpPayload": {} } }, - "ObjectLockEnabledForBucket": { - "target": "com.amazonaws.s3control#ObjectLockEnabledForBucket", + "GrantReadACP": { + "target": "com.amazonaws.s3control#GrantReadACP", "traits": { - "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" + "smithy.api#documentation": "

    Allows grantee to read the bucket ACL.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", + "smithy.api#httpHeader": "x-amz-grant-read-acp" } }, "OutpostId": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { + "smithy.api#documentation": "

    The ID of the Outposts where the bucket is being created.

    \n \n

    This is required by Amazon S3 on Outposts buckets.

    \n     ", "smithy.api#httpHeader": "x-amz-outpost-id" } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3control#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable bucket.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } } } }, "com.amazonaws.s3control#CreateBucketResult": { "type": "structure", "members": { - "BucketArn": { - "target": "com.amazonaws.s3control#S3RegionalBucketArn" - }, "Location": { "target": "com.amazonaws.s3control#Location", "traits": { + "smithy.api#documentation": "

    The location of the bucket.

    ", "smithy.api#httpHeader": "Location" } + }, + "BucketArn": { + "target": "com.amazonaws.s3control#S3RegionalBucketArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    " + } } } }, @@ -527,7 +562,10 @@ } ], "traits": { - "smithy.api#documentation": "

    S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can\n execute a single operation or action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in\n the Amazon Simple Storage Service Developer Guide.

    \n

    This operation creates a S3 Batch Operations job.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a\n single operation or action on lists of Amazon S3 objects that you specify. For more information,\n see S3 Batch Operations in the\n Amazon Simple Storage Service Developer Guide.

    \n

    This operation creates a S3 Batch Operations job.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "POST", "uri": "/v20180820/jobs", @@ -538,74 +576,75 @@ "com.amazonaws.s3control#CreateJobRequest": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

    An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

    ", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "

    The AWS account ID that creates the job.

    ", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } }, - "Priority": { - "target": "com.amazonaws.s3control#JobPriority", + "Manifest": { + "target": "com.amazonaws.s3control#JobManifest", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The numerical priority for this job. Higher numbers indicate higher priority.

    ", + "smithy.api#documentation": "

    Configuration parameters for the manifest.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.s3control#S3TagSet", + "Description": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength256String", "traits": { - "smithy.api#documentation": "

    A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

    " + "smithy.api#documentation": "

    A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

    " } }, - "RoleArn": { - "target": "com.amazonaws.s3control#IAMRoleArn", + "Operation": { + "target": "com.amazonaws.s3control#JobOperation", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role\n that Batch Operations will use to execute this job's operation on each object in the\n manifest.

    ", + "smithy.api#documentation": "

    The operation that you want this job to perform on each object listed in the manifest.\n For more information about the available operations, see Operations in the\n Amazon Simple Storage Service Developer Guide.

    ", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength256String", + "ClientRequestToken": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { - "smithy.api#documentation": "

    A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

    " + "smithy.api#documentation": "

    An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

    ", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } }, - "ConfirmationRequired": { - "target": "com.amazonaws.s3control#ConfirmationRequired", + "Priority": { + "target": "com.amazonaws.s3control#JobPriority", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

    " + "smithy.api#documentation": "

    The numerical priority for this job. Higher numbers indicate higher priority.

    ", + "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.s3control#AccountId", + "ConfirmationRequired": { + "target": "com.amazonaws.s3control#ConfirmationRequired", "traits": { - "smithy.api#documentation": "

    ", - "smithy.api#httpHeader": "x-amz-account-id", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

    Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

    " } }, - "Manifest": { - "target": "com.amazonaws.s3control#JobManifest", + "Report": { + "target": "com.amazonaws.s3control#JobReport", "traits": { - "smithy.api#documentation": "

    Configuration parameters for the manifest.

    ", + "smithy.api#documentation": "

    Configuration parameters for the optional job-completion report.

    ", "smithy.api#required": {} } }, - "Operation": { - "target": "com.amazonaws.s3control#JobOperation", + "Tags": { + "target": "com.amazonaws.s3control#S3TagSet", "traits": { - "smithy.api#documentation": "

    The operation that you want this job to perform on each object listed in the manifest.\n For more information about the available operations, see Operations in the\n Amazon Simple Storage Service Developer Guide.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

    " } }, - "Report": { - "target": "com.amazonaws.s3control#JobReport", + "RoleArn": { + "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

    Configuration parameters for the optional job-completion report.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role\n that Batch Operations will use to run this job's operation on each object in the\n manifest.

    ", "smithy.api#required": {} } } @@ -640,7 +679,7 @@ "target": "com.amazonaws.s3control#DeleteAccessPointRequest" }, "traits": { - "smithy.api#documentation": "

    Deletes the specified access point.

    ", + "smithy.api#documentation": "

    Deletes the specified access point.

    \n \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the ARN, see the \n \n Example section below.

    \n

    The following actions are related to DeleteAccessPoint:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -657,7 +696,7 @@ "target": "com.amazonaws.s3control#DeleteAccessPointPolicyRequest" }, "traits": { - "smithy.api#documentation": "

    Deletes the access point policy for the specified access point.

    ", + "smithy.api#documentation": "

    Deletes the access point policy for the specified access point.

    \n

    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n

    The following actions are related to DeleteAccessPointPolicy:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -683,7 +722,7 @@ "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

    The name of the access point whose policy you want to delete.

    ", + "smithy.api#documentation": "

    The name of the access point whose policy you want to delete.

    \n

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -693,14 +732,6 @@ "com.amazonaws.s3control#DeleteAccessPointRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.s3control#AccessPointName", - "traits": { - "smithy.api#documentation": "

    The name of the access point you want to delete.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { @@ -709,6 +740,14 @@ "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.s3control#AccessPointName", + "traits": { + "smithy.api#documentation": "

    The name of the access point you want to delete.

    \n

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -718,6 +757,7 @@ "target": "com.amazonaws.s3control#DeleteBucketRequest" }, "traits": { + "smithy.api#documentation": "\n

    This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, \n see DeleteBucket in the Amazon Simple Storage Service API.\n

    \n     \n

    Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the\n bucket must be deleted before the bucket itself can be deleted. \n For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.

    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n

    \n Related Resources\n

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -734,6 +774,7 @@ "target": "com.amazonaws.s3control#DeleteBucketLifecycleConfigurationRequest" }, "traits": { + "smithy.api#documentation": "\n

    This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an \n S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API.\n

    \n     \n

    Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration \n rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically \n deletes any objects on the basis of rules contained in the deleted lifecycle configuration. \n For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.

    \n

    To use this operation, you must have permission to perform the\n s3outposts:DeleteLifecycleConfiguration action. By default, the bucket\n owner has this permission and the Outposts bucket owner can grant this permission to\n others.

    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    For more information about object expiration, see \n Elements to Describe Lifecycle Actions.

    \n

    Related actions include:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -747,20 +788,22 @@ "com.amazonaws.s3control#DeleteBucketLifecycleConfigurationRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The account ID of the lifecycle configuration to delete.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } + }, + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "

    The bucket ARN of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -770,6 +813,7 @@ "target": "com.amazonaws.s3control#DeleteBucketPolicyRequest" }, "traits": { + "smithy.api#documentation": "\n

    This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an \n S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API.\n

    \n     \n

    This implementation of the DELETE operation uses the policy subresource to delete the\n policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the\n root user of the AWS account that owns the bucket, the calling identity must have the\n s3outposts:DeleteBucketPolicy permissions on the specified Outposts bucket\n and belong to the bucket owner's account to use this operation. For more information, see\n Using Amazon S3 on Outposts in\n Amazon Simple Storage Service Developer Guide.

    \n \n

    If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a\n 403 Access Denied error. If you have the correct permissions, but you're\n not using an identity that belongs to the bucket owner's account, Amazon S3 returns a\n 405 Method Not Allowed error.

    \n \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation,\n even if the policy explicitly denies the root user the ability to perform this action.

    \n     \n \n

    For more information about bucket policies, see Using Bucket Policies and User\n Policies.

    \n \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    The following actions are related to DeleteBucketPolicy:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -783,20 +827,22 @@ "com.amazonaws.s3control#DeleteBucketPolicyRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } + }, + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "

    The ARN of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -806,6 +852,7 @@ "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { + "smithy.api#documentation": "

    Specifies the bucket being deleted.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -813,6 +860,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The account ID that owns the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} @@ -826,6 +874,7 @@ "target": "com.amazonaws.s3control#DeleteBucketTaggingRequest" }, "traits": { + "smithy.api#documentation": "\n

    This API operation deletes an Amazon S3 on Outposts bucket's tags. To delete an \n S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API.\n

    \n     \n

    Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in\n Amazon Simple Storage Service Developer Guide.

    \n \n

    To use this operation, you must have permission to perform the PutBucketTagging action. \n By default, the bucket owner has this permission and can grant this permission to others. \n

    \n \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    The following actions are related to DeleteBucketTagging:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -842,6 +891,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket tag set to be removed.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} @@ -850,6 +900,7 @@ "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { + "smithy.api#documentation": "

    The bucket ARN that has the tag set to be removed.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -876,7 +927,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Removes the entire tag set from the specified S3 Batch Operations job. To use this operation,\n you must have permission to perform the s3:DeleteJobTagging action. For more\n information, see Controlling access and labeling jobs using tags in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    Removes the entire tag set from the specified S3 Batch Operations job. To use this operation,\n you must have permission to perform the s3:DeleteJobTagging action. For more\n information, see Controlling access and labeling jobs using tags in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "DELETE", "uri": "/v20180820/jobs/{JobId}/tagging", @@ -899,6 +953,7 @@ "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "

    The AWS account ID associated with the S3 Batch Operations job.

    ", + "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } @@ -915,7 +970,7 @@ "target": "com.amazonaws.s3control#DeletePublicAccessBlockRequest" }, "traits": { - "smithy.api#documentation": "

    Removes the PublicAccessBlock configuration for an AWS account.

    ", + "smithy.api#documentation": "

    Removes the PublicAccessBlock configuration for an AWS account. For more\n information, see Using Amazon S3 block\n public access.

    \n

    Related actions include:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -963,7 +1018,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the configuration parameters and status for a Batch Operations job. For more\n information, see S3 Batch Operations in\n the Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    Retrieves the configuration parameters and status for a Batch Operations job. For more\n information, see S3 Batch Operations in\n the Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/jobs/{JobId}", @@ -974,14 +1032,6 @@ "com.amazonaws.s3control#DescribeJobRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.s3control#AccountId", - "traits": { - "smithy.api#documentation": "

    ", - "smithy.api#httpHeader": "x-amz-account-id", - "smithy.api#required": {} - } - }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { @@ -989,6 +1039,15 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

    ", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {} + } } } }, @@ -1047,7 +1106,7 @@ "target": "com.amazonaws.s3control#GetAccessPointResult" }, "traits": { - "smithy.api#documentation": "

    Returns configuration information about the specified access point.

    ", + "smithy.api#documentation": "

    Returns configuration information about the specified access point.

    \n

    \n \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n

    The following actions are related to GetAccessPoint:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -1067,7 +1126,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "

    Returns the access point policy associated with the specified access point.

    ", + "smithy.api#documentation": "

    Returns the access point policy associated with the specified access point.

    \n

    The following actions are related to GetAccessPointPolicy:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -1084,7 +1143,7 @@ "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

    The name of the access point whose policy you want to retrieve.

    ", + "smithy.api#documentation": "

    The name of the access point whose policy you want to retrieve.

    \n

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1134,6 +1193,14 @@ "com.amazonaws.s3control#GetAccessPointPolicyStatusRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.s3control#AccessPointName", + "traits": { + "smithy.api#documentation": "

    The name of the access point whose policy status you want to retrieve.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { @@ -1142,14 +1209,6 @@ "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } - }, - "Name": { - "target": "com.amazonaws.s3control#AccessPointName", - "traits": { - "smithy.api#documentation": "

    The name of the access point whose policy status you want to retrieve.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -1170,7 +1229,7 @@ "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

    The name of the access point whose configuration information you want to retrieve.

    ", + "smithy.api#documentation": "

    The name of the access point whose configuration information you want to retrieve.

    \n

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1189,10 +1248,16 @@ "com.amazonaws.s3control#GetAccessPointResult": { "type": "structure", "members": { - "NetworkOrigin": { - "target": "com.amazonaws.s3control#NetworkOrigin", + "Name": { + "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

    Indicates whether this access point allows access from the public internet. If\n VpcConfiguration is specified for this access point, then\n NetworkOrigin is VPC, and the access point doesn't allow access from\n the public internet. Otherwise, NetworkOrigin is Internet, and\n the access point allows access from the public internet, subject to the access point and bucket access\n policies.

    " + "smithy.api#documentation": "

    The name of the specified access point.

    " + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.s3control#VpcConfiguration", + "traits": { + "smithy.api#documentation": "

    Contains the virtual private cloud (VPC) configuration for the specified access point.

    " } }, "Bucket": { @@ -1207,20 +1272,14 @@ "smithy.api#documentation": "

    The date and time when the specified access point was created.

    " } }, - "PublicAccessBlockConfiguration": { - "target": "com.amazonaws.s3control#PublicAccessBlockConfiguration" - }, - "Name": { - "target": "com.amazonaws.s3control#AccessPointName", + "NetworkOrigin": { + "target": "com.amazonaws.s3control#NetworkOrigin", "traits": { - "smithy.api#documentation": "

    The name of the specified access point.

    " + "smithy.api#documentation": "

    Indicates whether this access point allows access from the public internet. If\n VpcConfiguration is specified for this access point, then\n NetworkOrigin is VPC, and the access point doesn't allow access from\n the public internet. Otherwise, NetworkOrigin is Internet, and\n the access point allows access from the public internet, subject to the access point and bucket access\n policies.

    \n

    This will always be true for an Amazon S3 on Outposts access point

    " } }, - "VpcConfiguration": { - "target": "com.amazonaws.s3control#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

    Contains the virtual private cloud (VPC) configuration for the specified access point.

    " - } + "PublicAccessBlockConfiguration": { + "target": "com.amazonaws.s3control#PublicAccessBlockConfiguration" } } }, @@ -1233,6 +1292,7 @@ "target": "com.amazonaws.s3control#GetBucketResult" }, "traits": { + "smithy.api#documentation": "

    Gets an Amazon S3 on Outposts bucket. For more information, see \n Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

    \n

    The following actions are related to GetBucket for Amazon S3 on Outposts:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -1252,6 +1312,7 @@ "target": "com.amazonaws.s3control#GetBucketLifecycleConfigurationResult" }, "traits": { + "smithy.api#documentation": "\n

    This API operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an \n S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API.\n

    \n     \n

    Returns the lifecycle configuration information set on the Outposts bucket. For more\n information, see Using Amazon S3 on Outposts and for\n information about lifecycle configuration, see Object Lifecycle Management in\n Amazon Simple Storage Service Developer Guide.

    \n \n

    To use this operation, you must have permission to perform the s3outposts:GetLifecycleConfiguration action. \n The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more \n information about permissions, see \n Permissions \n Related to Bucket Subresource Operations and Managing Access \n Permissions to Your Amazon S3 Resources.

    \n \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    \n GetBucketLifecycleConfiguration has the following special error:

    \n
      \n
    • \n

      Error code: NoSuchLifecycleConfiguration\n

      \n
        \n
      • \n

        Description: The lifecycle configuration does not exist.

        \n
        • \n
      • \n

        HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    \n

    The following actions are related to GetBucketLifecycleConfiguration:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -1265,18 +1326,20 @@ "com.amazonaws.s3control#GetBucketLifecycleConfigurationRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.s3control#AccountId", + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", "traits": { - "smithy.api#hostLabel": {}, - "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } } @@ -1286,7 +1349,10 @@ "type": "structure", "members": { "Rules": { - "target": "com.amazonaws.s3control#LifecycleRules" + "target": "com.amazonaws.s3control#LifecycleRules", + "traits": { + "smithy.api#documentation": "

    Container for the lifecycle rule of the Outposts bucket.

    " + } } } }, @@ -1299,6 +1365,7 @@ "target": "com.amazonaws.s3control#GetBucketPolicyResult" }, "traits": { + "smithy.api#documentation": "\n

    This API action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3\n bucket, see GetBucketPolicy in the\n Amazon Simple Storage Service API.

    \n     \n

    Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon Simple Storage Service Developer Guide.

    \n

    If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity \n must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

    \n \n

    If you don't have s3outposts:GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, \n but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

    \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy \n explicitly denies the root user the ability to perform this action.

    \n     \n \n

    For more information about bucket policies, see Using Bucket Policies and User Policies.

    \n \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    The following actions are related to GetBucketPolicy:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -1312,20 +1379,22 @@ "com.amazonaws.s3control#GetBucketPolicyRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", - "traits": { - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } + }, + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "

    The ARN of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -1333,7 +1402,10 @@ "type": "structure", "members": { "Policy": { - "target": "com.amazonaws.s3control#Policy" + "target": "com.amazonaws.s3control#Policy", + "traits": { + "smithy.api#documentation": "

    The policy of the Outposts bucket.

    " + } } } }, @@ -1343,6 +1415,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} @@ -1351,6 +1424,7 @@ "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { + "smithy.api#documentation": "

    The ARN of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1360,14 +1434,23 @@ "com.amazonaws.s3control#GetBucketResult": { "type": "structure", "members": { + "CreationDate": { + "target": "com.amazonaws.s3control#CreationDate", + "traits": { + "smithy.api#documentation": "

    The creation date of the Outposts bucket.

    " + } + }, "PublicAccessBlockEnabled": { - "target": "com.amazonaws.s3control#PublicAccessBlockEnabled" + "target": "com.amazonaws.s3control#PublicAccessBlockEnabled", + "traits": { + "smithy.api#documentation": "

    " + } }, "Bucket": { - "target": "com.amazonaws.s3control#BucketName" - }, - "CreationDate": { - "target": "com.amazonaws.s3control#CreationDate" + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "

    The Outposts bucket requested.

    " + } } } }, @@ -1380,6 +1463,7 @@ "target": "com.amazonaws.s3control#GetBucketTaggingResult" }, "traits": { + "smithy.api#documentation": "\n

    This API operation gets an Amazon S3 on Outposts bucket's tags. To get an \n S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API.\n

    \n     \n

    Returns the tag set associated with the Outposts bucket. For more information, see\n Using Amazon S3 on Outposts in the\n Amazon Simple Storage Service Developer Guide.

    \n

    To use this operation, you must have permission to perform the GetBucketTagging action. \n By default, the bucket owner has this permission and can grant this permission to others.

    \n \n

    \n GetBucketTagging has the following special error:

    \n
      \n
    • \n

      Error code: NoSuchTagSetError\n

      \n
        \n
      • \n

        Description: There is no tag set associated with the bucket.

        \n
        • \n
      \n
      • \n
    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    The following actions are related to GetBucketTagging:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -1396,6 +1480,7 @@ "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { + "smithy.api#documentation": "

    The ARN of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1403,6 +1488,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} @@ -1416,6 +1502,7 @@ "TagSet": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { + "smithy.api#documentation": "

    The tags set of the Outposts bucket.

    ", "smithy.api#required": {} } } @@ -1441,7 +1528,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns the tags on an S3 Batch Operations job. To use this operation, you must have\n permission to perform the s3:GetJobTagging action. For more information, see\n Controlling\n access and labeling jobs using tags in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    Returns the tags on an S3 Batch Operations job. To use this operation, you must have\n permission to perform the s3:GetJobTagging action. For more information, see\n Controlling\n access and labeling jobs using tags in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/jobs/{JobId}/tagging", @@ -1464,6 +1554,7 @@ "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "

    The AWS account ID associated with the S3 Batch Operations job.

    ", + "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } @@ -1495,7 +1586,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the PublicAccessBlock configuration for an AWS account.

    ", + "smithy.api#documentation": "

    Retrieves the PublicAccessBlock configuration for an AWS account. For more\n information, see Using Amazon S3 block\n public access.

    \n

    Related actions include:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -1627,18 +1718,18 @@ "com.amazonaws.s3control#JobDescriptor": { "type": "structure", "members": { - "JobArn": { - "target": "com.amazonaws.s3control#JobArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for this job.

    " - } - }, "Manifest": { "target": "com.amazonaws.s3control#JobManifest", "traits": { "smithy.api#documentation": "

    The configuration information for the specified job's manifest object.

    " } }, + "ProgressSummary": { + "target": "com.amazonaws.s3control#JobProgressSummary", + "traits": { + "smithy.api#documentation": "

    Describes the total number of tasks that the specified job has run, the number of tasks\n that succeeded, and the number of tasks that failed.

    " + } + }, "ConfirmationRequired": { "target": "com.amazonaws.s3control#ConfirmationRequired", "traits": { @@ -1646,22 +1737,28 @@ "smithy.api#documentation": "

    Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

    " } }, - "SuspendedDate": { - "target": "com.amazonaws.s3control#SuspendedDate", + "JobArn": { + "target": "com.amazonaws.s3control#JobArn", "traits": { - "smithy.api#documentation": "

    The timestamp when this job was suspended, if it has been suspended.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for this job.

    " } }, - "CreationTime": { - "target": "com.amazonaws.s3control#JobCreationTime", + "Priority": { + "target": "com.amazonaws.s3control#JobPriority", "traits": { - "smithy.api#documentation": "

    A timestamp indicating when this job was created.

    " + "smithy.api#documentation": "

    The priority of the specified job.

    " } }, - "JobId": { - "target": "com.amazonaws.s3control#JobId", + "Report": { + "target": "com.amazonaws.s3control#JobReport", "traits": { - "smithy.api#documentation": "

    The ID for the specified job.

    " + "smithy.api#documentation": "

    Contains the configuration information for the job-completion report if you requested one in the Create Job request.

    " + } + }, + "Status": { + "target": "com.amazonaws.s3control#JobStatus", + "traits": { + "smithy.api#documentation": "

    The current status of the specified job.

    " } }, "TerminationDate": { @@ -1670,16 +1767,34 @@ "smithy.api#documentation": "

    A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

    " } }, + "SuspendedCause": { + "target": "com.amazonaws.s3control#SuspendedCause", + "traits": { + "smithy.api#documentation": "

    The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters\n the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

    " + } + }, "Description": { "target": "com.amazonaws.s3control#NonEmptyMaxLength256String", "traits": { "smithy.api#documentation": "

    The description for this job, if one was provided in this job's Create Job request.

    " } }, + "Operation": { + "target": "com.amazonaws.s3control#JobOperation", + "traits": { + "smithy.api#documentation": "

    The operation that the specified job is configured to run on the objects listed in the manifest.

    " + } + }, "RoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role\n assigned to execute the tasks for this job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role\n assigned to run the tasks for this job.

    " + } + }, + "SuspendedDate": { + "target": "com.amazonaws.s3control#SuspendedDate", + "traits": { + "smithy.api#documentation": "

    The timestamp when this job was suspended, if it has been suspended.

    " } }, "FailureReasons": { @@ -1691,43 +1806,19 @@ "StatusUpdateReason": { "target": "com.amazonaws.s3control#JobStatusUpdateReason", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    The reason for updating the job.

    " } }, - "Priority": { - "target": "com.amazonaws.s3control#JobPriority", - "traits": { - "smithy.api#documentation": "

    The priority of the specified job.

    " - } - }, - "SuspendedCause": { - "target": "com.amazonaws.s3control#SuspendedCause", - "traits": { - "smithy.api#documentation": "

    The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters\n the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

    " - } - }, - "Report": { - "target": "com.amazonaws.s3control#JobReport", - "traits": { - "smithy.api#documentation": "

    Contains the configuration information for the job-completion report if you requested one in the Create Job request.

    " - } - }, - "Status": { - "target": "com.amazonaws.s3control#JobStatus", - "traits": { - "smithy.api#documentation": "

    The current status of the specified job.

    " - } - }, - "Operation": { - "target": "com.amazonaws.s3control#JobOperation", + "CreationTime": { + "target": "com.amazonaws.s3control#JobCreationTime", "traits": { - "smithy.api#documentation": "

    The operation that the specified job is configured to execute on the objects listed in the manifest.

    " + "smithy.api#documentation": "

    A timestamp indicating when this job was created.

    " } }, - "ProgressSummary": { - "target": "com.amazonaws.s3control#JobProgressSummary", + "JobId": { + "target": "com.amazonaws.s3control#JobId", "traits": { - "smithy.api#documentation": "

    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

    " + "smithy.api#documentation": "

    The ID for the specified job.

    " } } }, @@ -1792,34 +1883,22 @@ "com.amazonaws.s3control#JobListDescriptor": { "type": "structure", "members": { - "ProgressSummary": { - "target": "com.amazonaws.s3control#JobProgressSummary", - "traits": { - "smithy.api#documentation": "

    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

    " - } - }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "

    The ID for the specified job.

    " } }, - "CreationTime": { - "target": "com.amazonaws.s3control#JobCreationTime", - "traits": { - "smithy.api#documentation": "

    A timestamp indicating when the specified job was created.

    " - } - }, - "TerminationDate": { - "target": "com.amazonaws.s3control#JobTerminationDate", + "Priority": { + "target": "com.amazonaws.s3control#JobPriority", "traits": { - "smithy.api#documentation": "

    A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

    " + "smithy.api#documentation": "

    The current priority for the specified job.

    " } }, - "Status": { - "target": "com.amazonaws.s3control#JobStatus", + "ProgressSummary": { + "target": "com.amazonaws.s3control#JobProgressSummary", "traits": { - "smithy.api#documentation": "

    The specified job's current status.

    " + "smithy.api#documentation": "

    Describes the total number of tasks that the specified job has run, the number of tasks\n that succeeded, and the number of tasks that failed.

    " } }, "Description": { @@ -1834,10 +1913,22 @@ "smithy.api#documentation": "

    The operation that the specified job is configured to run on each object listed in the manifest.

    " } }, - "Priority": { - "target": "com.amazonaws.s3control#JobPriority", + "CreationTime": { + "target": "com.amazonaws.s3control#JobCreationTime", "traits": { - "smithy.api#documentation": "

    The current priority for the specified job.

    " + "smithy.api#documentation": "

    A timestamp indicating when the specified job was created.

    " + } + }, + "TerminationDate": { + "target": "com.amazonaws.s3control#JobTerminationDate", + "traits": { + "smithy.api#documentation": "

    A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

    " + } + }, + "Status": { + "target": "com.amazonaws.s3control#JobStatus", + "traits": { + "smithy.api#documentation": "

    The specified job's current status.

    " } } }, @@ -1920,12 +2011,6 @@ "com.amazonaws.s3control#JobManifestLocation": { "type": "structure", "members": { - "ObjectVersionId": { - "target": "com.amazonaws.s3control#S3ObjectVersionId", - "traits": { - "smithy.api#documentation": "

    The optional version ID to identify a specific version of the manifest object.

    " - } - }, "ETag": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { @@ -1939,6 +2024,12 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for a manifest object.

    ", "smithy.api#required": {} } + }, + "ObjectVersionId": { + "target": "com.amazonaws.s3control#S3ObjectVersionId", + "traits": { + "smithy.api#documentation": "

    The optional version ID to identify a specific version of the manifest object.

    " + } } }, "traits": { @@ -1948,18 +2039,18 @@ "com.amazonaws.s3control#JobManifestSpec": { "type": "structure", "members": { - "Fields": { - "target": "com.amazonaws.s3control#JobManifestFieldList", - "traits": { - "smithy.api#documentation": "

    If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

    " - } - }, "Format": { "target": "com.amazonaws.s3control#JobManifestFormat", "traits": { "smithy.api#documentation": "

    Indicates which of the available formats the specified manifest uses.

    ", "smithy.api#required": {} } + }, + "Fields": { + "target": "com.amazonaws.s3control#JobManifestFieldList", + "traits": { + "smithy.api#documentation": "

    If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

    " + } } }, "traits": { @@ -1985,40 +2076,40 @@ "com.amazonaws.s3control#JobOperation": { "type": "structure", "members": { - "S3PutObjectTagging": { - "target": "com.amazonaws.s3control#S3SetObjectTaggingOperation", - "traits": { - "smithy.api#documentation": "

    Directs the specified job to execute a PUT Object tagging call on each object in the manifest.

    " - } - }, - "S3PutObjectAcl": { - "target": "com.amazonaws.s3control#S3SetObjectAclOperation", - "traits": { - "smithy.api#documentation": "

    Directs the specified job to execute a PUT Object acl call on each object in the manifest.

    " - } - }, "S3PutObjectLegalHold": { "target": "com.amazonaws.s3control#S3SetObjectLegalHoldOperation" }, - "LambdaInvoke": { - "target": "com.amazonaws.s3control#LambdaInvokeOperation", + "S3PutObjectCopy": { + "target": "com.amazonaws.s3control#S3CopyObjectOperation", "traits": { - "smithy.api#documentation": "

    Directs the specified job to invoke an AWS Lambda function on each object in the manifest.

    " + "smithy.api#documentation": "

    Directs the specified job to run a PUT Copy object call on each object in the manifest.

    " } }, "S3InitiateRestoreObject": { "target": "com.amazonaws.s3control#S3InitiateRestoreObjectOperation", "traits": { - "smithy.api#documentation": "

    Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.

    " + "smithy.api#documentation": "

    Directs the specified job to run an Initiate Glacier Restore call on each object in the manifest.

    " + } + }, + "S3PutObjectTagging": { + "target": "com.amazonaws.s3control#S3SetObjectTaggingOperation", + "traits": { + "smithy.api#documentation": "

    Directs the specified job to run a PUT Object tagging call on each object in the manifest.

    " } }, "S3PutObjectRetention": { "target": "com.amazonaws.s3control#S3SetObjectRetentionOperation" }, - "S3PutObjectCopy": { - "target": "com.amazonaws.s3control#S3CopyObjectOperation", + "LambdaInvoke": { + "target": "com.amazonaws.s3control#LambdaInvokeOperation", + "traits": { + "smithy.api#documentation": "

    Directs the specified job to invoke an AWS Lambda function on each object in the manifest.

    " + } + }, + "S3PutObjectAcl": { + "target": "com.amazonaws.s3control#S3SetObjectAclOperation", "traits": { - "smithy.api#documentation": "

    Directs the specified job to execute a PUT Copy object call on each object in the manifest.

    " + "smithy.api#documentation": "

    Directs the specified job to run a PUT Object acl call on each object in the manifest.

    " } } }, @@ -2038,8 +2129,8 @@ "com.amazonaws.s3control#JobProgressSummary": { "type": "structure", "members": { - "NumberOfTasksFailed": { - "target": "com.amazonaws.s3control#JobNumberOfTasksFailed", + "NumberOfTasksSucceeded": { + "target": "com.amazonaws.s3control#JobNumberOfTasksSucceeded", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

    " @@ -2052,8 +2143,8 @@ "smithy.api#documentation": "

    " } }, - "NumberOfTasksSucceeded": { - "target": "com.amazonaws.s3control#JobNumberOfTasksSucceeded", + "NumberOfTasksFailed": { + "target": "com.amazonaws.s3control#JobNumberOfTasksFailed", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

    " @@ -2061,12 +2152,18 @@ } }, "traits": { - "smithy.api#documentation": "

    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

    " + "smithy.api#documentation": "

    Describes the total number of tasks that the specified job has started, the number of tasks that succeeded, and the number of tasks that failed.

    " } }, "com.amazonaws.s3control#JobReport": { "type": "structure", "members": { + "Format": { + "target": "com.amazonaws.s3control#JobReportFormat", + "traits": { + "smithy.api#documentation": "

    The format of the specified job-completion report.

    " + } + }, "ReportScope": { "target": "com.amazonaws.s3control#JobReportScope", "traits": { @@ -2079,12 +2176,6 @@ "smithy.api#documentation": "

    An optional prefix to describe where in the specified bucket the job-completion report\n will be stored. Amazon S3 stores the job-completion report at\n /job-/report.json.

    " } }, - "Bucket": { - "target": "com.amazonaws.s3control#S3BucketArnString", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

    " - } - }, "Enabled": { "target": "com.amazonaws.s3control#Boolean", "traits": { @@ -2092,10 +2183,10 @@ "smithy.api#required": {} } }, - "Format": { - "target": "com.amazonaws.s3control#JobReportFormat", + "Bucket": { + "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { - "smithy.api#documentation": "

    The format of the specified job-completion report.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

    " } } }, @@ -2253,65 +2344,117 @@ "type": "structure", "members": { "Rules": { - "target": "com.amazonaws.s3control#LifecycleRules" + "target": "com.amazonaws.s3control#LifecycleRules", + "traits": { + "smithy.api#documentation": "

    A lifecycle rule for individual objects in an Outposts bucket.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container for the Outposts bucket lifecycle configuration.

    " } }, "com.amazonaws.s3control#LifecycleExpiration": { "type": "structure", "members": { "ExpiredObjectDeleteMarker": { - "target": "com.amazonaws.s3control#ExpiredObjectDeleteMarker" - }, - "Days": { - "target": "com.amazonaws.s3control#Days" + "target": "com.amazonaws.s3control#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.

    " + } }, "Date": { - "target": "com.amazonaws.s3control#Date" + "target": "com.amazonaws.s3control#Date", + "traits": { + "smithy.api#documentation": "

    Indicates at what date the object is to be deleted. Should be in GMT ISO 8601\n format.

    " + } + }, + "Days": { + "target": "com.amazonaws.s3control#Days", + "traits": { + "smithy.api#documentation": "

    Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container of the Outposts bucket lifecycle expiration.

    " } }, "com.amazonaws.s3control#LifecycleRule": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.s3control#ExpirationStatus", + "ID": { + "target": "com.amazonaws.s3control#ID", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

    Unique identifier for the rule. The value cannot be longer than 255 characters.

    " } }, - "NoncurrentVersionExpiration": { - "target": "com.amazonaws.s3control#NoncurrentVersionExpiration" + "Filter": { + "target": "com.amazonaws.s3control#LifecycleRuleFilter", + "traits": { + "smithy.api#documentation": "

    The container for the filter of lifecycle rule.

    " + } }, - "AbortIncompleteMultipartUpload": { - "target": "com.amazonaws.s3control#AbortIncompleteMultipartUpload" + "Expiration": { + "target": "com.amazonaws.s3control#LifecycleExpiration", + "traits": { + "smithy.api#documentation": "

    Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object \n has a delete marker.

    " + } }, "Transitions": { - "target": "com.amazonaws.s3control#TransitionList" + "target": "com.amazonaws.s3control#TransitionList", + "traits": { + "smithy.api#documentation": "

    Specifies when an Amazon S3 object transitions to a specified storage class.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     " + } }, - "ID": { - "target": "com.amazonaws.s3control#ID" + "NoncurrentVersionExpiration": { + "target": "com.amazonaws.s3control#NoncurrentVersionExpiration", + "traits": { + "smithy.api#documentation": "

    The noncurrent version expiration of the lifecycle rule.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     " + } }, "NoncurrentVersionTransitions": { - "target": "com.amazonaws.s3control#NoncurrentVersionTransitionList" + "target": "com.amazonaws.s3control#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.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     " + } }, - "Expiration": { - "target": "com.amazonaws.s3control#LifecycleExpiration" + "Status": { + "target": "com.amazonaws.s3control#ExpirationStatus", + "traits": { + "smithy.api#documentation": "

    If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

    ", + "smithy.api#required": {} + } }, - "Filter": { - "target": "com.amazonaws.s3control#LifecycleRuleFilter" + "AbortIncompleteMultipartUpload": { + "target": "com.amazonaws.s3control#AbortIncompleteMultipartUpload", + "traits": { + "smithy.api#documentation": "

    Specifies the days since the initiation of an incomplete multipart upload that Amazon S3\n waits before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the\n Amazon Simple Storage Service Developer Guide.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container for the Outposts bucket lifecycle rule.

    " } }, "com.amazonaws.s3control#LifecycleRuleAndOperator": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.s3control#Prefix" - }, "Tags": { - "target": "com.amazonaws.s3control#S3TagSet" + "target": "com.amazonaws.s3control#S3TagSet", + "traits": { + "smithy.api#documentation": "

    All of these tags must exist in the object's tag set in order for the rule to apply.

    " + } + }, + "Prefix": { + "target": "com.amazonaws.s3control#Prefix", + "traits": { + "smithy.api#documentation": "

    Prefix identifying one or more objects to which the rule applies.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container for the Outposts bucket lifecycle rule and operator.

    " } }, "com.amazonaws.s3control#LifecycleRuleFilter": { @@ -2321,11 +2464,20 @@ "target": "com.amazonaws.s3control#S3Tag" }, "Prefix": { - "target": "com.amazonaws.s3control#Prefix" + "target": "com.amazonaws.s3control#Prefix", + "traits": { + "smithy.api#documentation": "

    Prefix identifying one or more objects to which the rule applies.

    " + } }, "And": { - "target": "com.amazonaws.s3control#LifecycleRuleAndOperator" + "target": "com.amazonaws.s3control#LifecycleRuleAndOperator", + "traits": { + "smithy.api#documentation": "

    The container for the AND condition for the lifecycle rule.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container for the filter of the lifecycle rule.

    " } }, "com.amazonaws.s3control#LifecycleRules": { @@ -2346,7 +2498,7 @@ "target": "com.amazonaws.s3control#ListAccessPointsResult" }, "traits": { - "smithy.api#documentation": "

    Returns a list of the access points currently associated with the specified bucket. You\n can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000\n access points (or the number specified in maxResults, whichever is less), the\n response will include a continuation token that you can use to list the additional access\n points.

    ", + "smithy.api#documentation": "

    Returns a list of the access points currently associated with the specified bucket. You\n can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000\n access points (or the number specified in maxResults, whichever is less), the\n response will include a continuation token that you can use to list the additional access\n points.

    \n

    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n

    The following actions are related to ListAccessPoints:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -2365,19 +2517,10 @@ "com.amazonaws.s3control#ListAccessPointsRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.s3control#AccountId", - "traits": { - "smithy.api#documentation": "

    The AWS account ID for owner of the bucket whose access points you want to list.

    ", - "smithy.api#hostLabel": {}, - "smithy.api#httpHeader": "x-amz-account-id", - "smithy.api#required": {} - } - }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { - "smithy.api#documentation": "

    The name of the bucket whose associated access points you want to list.

    ", + "smithy.api#documentation": "

    The name of the bucket whose associated access points you want to list.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", "smithy.api#httpQuery": "bucket" } }, @@ -2388,6 +2531,15 @@ "smithy.api#httpQuery": "maxResults" } }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID for owner of the bucket whose access points you want to list.

    ", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { @@ -2400,16 +2552,16 @@ "com.amazonaws.s3control#ListAccessPointsResult": { "type": "structure", "members": { - "AccessPointList": { - "target": "com.amazonaws.s3control#AccessPointList", + "NextToken": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { - "smithy.api#documentation": "

    Contains identification and configuration information for one or more access points\n associated with the specified bucket.

    " + "smithy.api#documentation": "

    If the specified bucket has more access points than can be returned in one call to this\n API, this field contains a continuation token that you can provide in subsequent calls to\n this API to retrieve additional access points.

    " } }, - "NextToken": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "AccessPointList": { + "target": "com.amazonaws.s3control#AccessPointList", "traits": { - "smithy.api#documentation": "

    If the specified bucket has more access points than can be returned in one call to this\n API, then this field contains a continuation token that you can provide in subsequent calls\n to this API to retrieve additional access points.

    " + "smithy.api#documentation": "

    Contains identification and configuration information for one or more access points\n associated with the specified bucket.

    " } } } @@ -2434,7 +2586,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for\n the AWS account making the request. For more information, see S3 Batch Operations in the\n Amazon Simple Storage Service Developer Guide.

    \n

    Related actions include:

    \n

    \n ", + "smithy.api#documentation": "

    Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for\n the AWS account making the request. For more information, see S3 Batch Operations in the\n Amazon Simple Storage Service Developer Guide.

    \n

    Related actions include:

    \n

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/jobs", @@ -2450,6 +2605,21 @@ "com.amazonaws.s3control#ListJobsRequest": { "type": "structure", "members": { + "JobStatuses": { + "target": "com.amazonaws.s3control#JobStatusList", + "traits": { + "smithy.api#documentation": "

    The List Jobs request returns jobs that match the statuses listed in this element.

    ", + "smithy.api#httpQuery": "jobStatuses" + } + }, + "MaxResults": { + "target": "com.amazonaws.s3control#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

    ", + "smithy.api#httpQuery": "maxResults" + } + }, "NextToken": { "target": "com.amazonaws.s3control#StringForNextToken", "traits": { @@ -2461,24 +2631,10 @@ "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "

    ", + "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } - }, - "MaxResults": { - "target": "com.amazonaws.s3control#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

    ", - "smithy.api#httpQuery": "maxResults" - } - }, - "JobStatuses": { - "target": "com.amazonaws.s3control#JobStatusList", - "traits": { - "smithy.api#documentation": "

    The List Jobs request returns jobs that match the statuses listed in this element.

    ", - "smithy.api#httpQuery": "jobStatuses" - } } } }, @@ -2508,6 +2664,7 @@ "target": "com.amazonaws.s3control#ListRegionalBucketsResult" }, "traits": { + "smithy.api#documentation": "

    Returns a list of all Outposts buckets in an Outposts that are owned by the\n authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

    \n

    For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and outpost-id in your API request, see the \n \n Example section below.

    ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -2529,39 +2686,49 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.s3control#MaxResults", + "traits": { + "smithy.api#documentation": "

    ", + "smithy.api#httpQuery": "maxResults" + } + }, "OutpostId": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { + "smithy.api#documentation": "

    The ID of the AWS Outposts.

    \n \n

    This is required by Amazon S3 on Outposts buckets.

    \n     ", "smithy.api#httpHeader": "x-amz-outpost-id" } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { + "smithy.api#documentation": "

    ", "smithy.api#httpQuery": "nextToken" } - }, - "MaxResults": { - "target": "com.amazonaws.s3control#MaxResults", - "traits": { - "smithy.api#httpQuery": "maxResults" - } } } }, "com.amazonaws.s3control#ListRegionalBucketsResult": { "type": "structure", "members": { - "RegionalBucketList": { - "target": "com.amazonaws.s3control#RegionalBucketList" - }, "NextToken": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String" + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "traits": { + "smithy.api#documentation": "

    \n NextToken is sent when isTruncated is true, which means\n there are more buckets that can be listed. The next list requests to Amazon S3\n can be continued with this NextToken.\n NextToken is obfuscated and is not a real key.

    " + } + }, + "RegionalBucketList": { + "target": "com.amazonaws.s3control#RegionalBucketList", + "traits": { + "smithy.api#documentation": "

    " + } } } }, @@ -2657,19 +2824,34 @@ "type": "structure", "members": { "NoncurrentDays": { - "target": "com.amazonaws.s3control#Days" + "target": "com.amazonaws.s3control#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\n Simple Storage Service Developer Guide.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container of the noncurrent version expiration.

    " } }, "com.amazonaws.s3control#NoncurrentVersionTransition": { "type": "structure", "members": { - "StorageClass": { - "target": "com.amazonaws.s3control#TransitionStorageClass" - }, "NoncurrentDays": { - "target": "com.amazonaws.s3control#Days" + "target": "com.amazonaws.s3control#Days", + "traits": { + "smithy.api#documentation": "

    Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. \n For information about the noncurrent days calculations, see \n \n How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide.

    " + } + }, + "StorageClass": { + "target": "com.amazonaws.s3control#TransitionStorageClass", + "traits": { + "smithy.api#documentation": "

    The class of storage used to store the object.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    The container for the noncurrent version transition.

    " } }, "com.amazonaws.s3control#NoncurrentVersionTransitionList": { @@ -2755,37 +2937,37 @@ "com.amazonaws.s3control#PublicAccessBlockConfiguration": { "type": "structure", "members": { - "BlockPublicAcls": { - "target": "com.amazonaws.s3control#Setting", - "traits": { - "smithy.api#documentation": "

    Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in\n this account. Setting this element to TRUE causes the following behavior:

    \n
      \n
    • \n

      PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

      \n
      • \n
    • \n

      PUT Object calls fail if the request includes a public ACL.

      \n
      • \n
    • \n

      PUT Bucket calls fail if the request includes a public ACL.

      \n
      • \n
    \n

    Enabling this setting doesn't affect existing policies or ACLs.

    ", - "smithy.api#xmlName": "BlockPublicAcls" - } - }, "RestrictPublicBuckets": { "target": "com.amazonaws.s3control#Setting", "traits": { - "smithy.api#documentation": "

    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account.\n Setting this element to TRUE restricts access to buckets with public policies\n to only AWS services and authorized users within this account.

    \n

    Enabling this setting doesn't affect previously stored bucket policies, except that public\n and cross-account access within any public bucket policy, including non-public delegation to\n specific accounts, is blocked.

    ", + "smithy.api#documentation": "

    Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account.\n Setting this element to TRUE restricts access to buckets with public policies\n to only AWS services and authorized users within this account.

    \n

    Enabling this setting doesn't affect previously stored bucket policies, except that public\n and cross-account access within any public bucket policy, including non-public delegation to\n specific accounts, is blocked.

    \n

    This is not supported for Amazon S3 on Outposts.

    ", "smithy.api#xmlName": "RestrictPublicBuckets" } }, "BlockPublicPolicy": { "target": "com.amazonaws.s3control#Setting", "traits": { - "smithy.api#documentation": "

    Specifies whether Amazon S3 should block public bucket policies for buckets in this account.\n Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket\n policy if the specified bucket policy allows public access.

    \n

    Enabling this setting doesn't affect existing bucket policies.

    ", + "smithy.api#documentation": "

    Specifies whether Amazon S3 should block public bucket policies for buckets in this account.\n Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket\n policy if the specified bucket policy allows public access.

    \n

    Enabling this setting doesn't affect existing bucket policies.

    \n

    This is not supported for Amazon S3 on Outposts.

    ", "smithy.api#xmlName": "BlockPublicPolicy" } }, + "BlockPublicAcls": { + "target": "com.amazonaws.s3control#Setting", + "traits": { + "smithy.api#documentation": "

    Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in\n this account. Setting this element to TRUE causes the following behavior:

    \n
      \n
    • \n

      PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

      \n
      • \n
    • \n

      PUT Object calls fail if the request includes a public ACL.

      \n
      • \n
    • \n

      PUT Bucket calls fail if the request includes a public ACL.

      \n
      • \n
    \n

    Enabling this setting doesn't affect existing policies or ACLs.

    \n

    This is not supported for Amazon S3 on Outposts.

    ", + "smithy.api#xmlName": "BlockPublicAcls" + } + }, "IgnorePublicAcls": { "target": "com.amazonaws.s3control#Setting", "traits": { - "smithy.api#documentation": "

    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this\n element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this\n account and any objects that they contain.

    \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#documentation": "

    Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this\n element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this\n account and any objects that they contain.

    \n

    Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.

    \n

    This is not supported for Amazon S3 on Outposts.

    ", "smithy.api#xmlName": "IgnorePublicAcls" } } }, "traits": { - "smithy.api#documentation": "

    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.\n You can enable the configuration options in any combination. For more information about\n 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#documentation": "

    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.\n You can enable the configuration options in any combination. For more information about\n when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer\n Guide.

    \n

    This is not supported for Amazon S3 on Outposts.

    " } }, "com.amazonaws.s3control#PublicAccessBlockEnabled": { @@ -2797,7 +2979,7 @@ "target": "com.amazonaws.s3control#PutAccessPointPolicyRequest" }, "traits": { - "smithy.api#documentation": "

    Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

    ", + "smithy.api#documentation": "

    Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API \n replaces any existing policy associated with the specified access point.

    \n

    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n

    The following actions are related to PutAccessPointPolicy:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -2811,19 +2993,10 @@ "com.amazonaws.s3control#PutAccessPointPolicyRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.s3control#AccountId", - "traits": { - "smithy.api#documentation": "

    The AWS account ID for owner of the bucket associated with the specified access point.

    ", - "smithy.api#hostLabel": {}, - "smithy.api#httpHeader": "x-amz-account-id", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

    The name of the access point that you want to associate with the specified policy.

    ", + "smithy.api#documentation": "

    The name of the access point that you want to associate with the specified policy.

    \n

    For Amazon S3 on Outposts specify the ARN of the access point accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2834,6 +3007,15 @@ "smithy.api#documentation": "

    The policy that you want to apply to the specified access point. For more information about access point policies, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

    ", "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID for owner of the bucket associated with the specified access point.

    ", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {} + } } } }, @@ -2843,6 +3025,7 @@ "target": "com.amazonaws.s3control#PutBucketLifecycleConfigurationRequest" }, "traits": { + "smithy.api#documentation": "\n

    This API action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, \n see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API.\n

    \n     \n

    Creates a new lifecycle configuration for the Outposts bucket or replaces an existing\n lifecycle configuration. Outposts buckets can only support a lifecycle that deletes objects\n after a certain period of time. For more information, see Managing Lifecycle Permissions for Amazon S3 on Outposts.

    \n

    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n

    The following actions are related to PutBucketLifecycleConfiguration:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -2860,6 +3043,7 @@ "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { + "smithy.api#documentation": "

    The name of the bucket for which to set the configuration.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2867,6 +3051,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} @@ -2875,6 +3060,7 @@ "LifecycleConfiguration": { "target": "com.amazonaws.s3control#LifecycleConfiguration", "traits": { + "smithy.api#documentation": "

    Container for lifecycle rules. You can add as many as 1,000 rules.

    ", "smithy.api#httpPayload": {} } } @@ -2886,6 +3072,7 @@ "target": "com.amazonaws.s3control#PutBucketPolicyRequest" }, "traits": { + "smithy.api#documentation": "\n

    This API action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, \n see PutBucketPolicy in the Amazon Simple Storage Service API.\n

    \n     \n

    Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon Simple Storage Service Developer Guide.

    \n

    If you are using an identity other than the root user of the AWS account that owns the\n Outposts bucket, the calling identity must have the PutBucketPolicy\n permissions on the specified Outposts bucket and belong to the bucket owner's account in\n order to use this operation.

    \n \n

    If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, \n but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

    \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy \n explicitly denies the root user the ability to perform this action.\n

    \n     \n \n \n

    For more information about bucket policies, see Using Bucket Policies and User Policies.

    \n \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    The following actions are related to PutBucketPolicy:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -2900,30 +3087,34 @@ "com.amazonaws.s3control#PutBucketPolicyRequest": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.s3control#Policy", - "traits": { - "smithy.api#required": {} - } - }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } }, + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "

    The ARN of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ConfirmRemoveSelfBucketAccess": { "target": "com.amazonaws.s3control#ConfirmRemoveSelfBucketAccess", "traits": { + "smithy.api#documentation": "

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

    \n \n

    This is not supported by Amazon S3 on Outposts buckets.

    \n     ", "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" } }, - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", + "Policy": { + "target": "com.amazonaws.s3control#Policy", "traits": { - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The bucket policy as a JSON document.

    ", "smithy.api#required": {} } } @@ -2935,6 +3126,7 @@ "target": "com.amazonaws.s3control#PutBucketTaggingRequest" }, "traits": { + "smithy.api#documentation": "\n

    This API action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see\n PutBucketTagging in the Amazon Simple Storage Service API.

    \n     \n

    Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon Simple Storage Service Developer Guide.

    \n

    Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your \n AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your \n billing information according to resources with the same tag key values. For example, you can tag several \n resources with a specific application name, and then organize your billing information to see the total cost \n of that application across several services. For more information, see \n Cost Allocation and Tagging.

    \n \n \n

    Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites \n the old value. For more information, see Using Cost Allocation in Amazon S3 \n Bucket Tags.

    \n     \n

    To use this operation, you must have permissions to perform the\n s3outposts:PutBucketTagging action. The Outposts bucket owner has this\n permission by default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

    \n \n

    \n PutBucketTagging has the following special errors:

    \n
      \n
    • \n

      Error code: InvalidTagError\n

      \n \n
      • \n
    • \n

      Error code: MalformedXMLError\n

      \n
        \n
      • \n

        Description: The XML provided does not match the schema.

        \n
        • \n
      \n
      • \n
    • \n

      Error code: OperationAbortedError \n

      \n
        \n
      • \n

        Description: A conflicting conditional operation is currently in progress against this\n resource. Try again.

        \n
        • \n
      \n
      • \n
    • \n

      Error code: InternalError\n

      \n
        \n
      • \n

        Description: The service was unable to apply the provided tag to the bucket.

        \n
        • \n
      \n
      • \n
    \n

    All Amazon S3 on Outposts REST API requests for this action require an additional parameter of outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the outpost-id derived using the access point ARN, see the \n \n Example section below.

    \n \n

    The following actions are related to PutBucketTagging:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -2949,25 +3141,28 @@ "com.amazonaws.s3control#PutBucketTaggingRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", + "Tagging": { + "target": "com.amazonaws.s3control#Tagging", "traits": { - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    ", + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { + "smithy.api#documentation": "

    The AWS account ID of the Outposts bucket.

    ", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } }, - "Tagging": { - "target": "com.amazonaws.s3control#Tagging", + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", "traits": { - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the bucket.

    \n

    For Amazon S3 on Outposts specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -2996,7 +3191,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Sets the supplied tag-set on an S3 Batch Operations job.

    \n

    A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending\n a PUT request against the tagging subresource that is associated with the job. To modify\n the existing tag set, you can either replace the existing tag set entirely, or make changes\n within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the\n tag set with the one you modified. For more information, see Controlling access and\n labeling jobs using tags in the Amazon Simple Storage Service Developer Guide.

    \n

    \n \n
      \n
    • \n

      If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the\n Batch Operations job. If you use this method, you are charged for a Tier 1 Request\n (PUT). For more information, see Amazon S3\n pricing.

      \n
      • \n
    • \n

      For deleting existing tags for your Batch Operations job, a DeleteJobTagging\n request is preferred because it achieves the same result without incurring\n charges.

      \n
      • \n
    • \n

      A few things to consider about using tags:

      \n
        \n
      • \n

        Amazon S3 limits the maximum number of tags to 50 tags per job.

        \n
        • \n
      • \n

        You can associate up to 50 tags with a job as long as they have unique tag keys.

        \n
        • \n
      • \n

        A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.

        \n
        • \n
      • \n

        The key and values are case sensitive.

        \n
        • \n
      • \n

        For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and\n Cost Management User Guide.

        \n
        • \n
      \n
      • \n
    \n     \n

    \n

    To use this operation, you must have permission to perform the s3:PutJobTagging action.

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    Sets the supplied tag-set on an S3 Batch Operations job.

    \n

    A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending\n a PUT request against the tagging subresource that is associated with the job. To modify\n the existing tag set, you can either replace the existing tag set entirely, or make changes\n within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the\n tag set with the one you modified. For more information, see Controlling access and\n labeling jobs using tags in the Amazon Simple Storage Service Developer Guide.

    \n

    \n \n
      \n
    • \n

      If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the\n Batch Operations job. If you use this method, you are charged for a Tier 1 Request\n (PUT). For more information, see Amazon S3\n pricing.

      \n
      • \n
    • \n

      For deleting existing tags for your Batch Operations job, a DeleteJobTagging\n request is preferred because it achieves the same result without incurring\n charges.

      \n
      • \n
    • \n

      A few things to consider about using tags:

      \n
        \n
      • \n

        Amazon S3 limits the maximum number of tags to 50 tags per job.

        \n
        • \n
      • \n

        You can associate up to 50 tags with a job as long as they have unique tag keys.

        \n
        • \n
      • \n

        A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.

        \n
        • \n
      • \n

        The key and values are case sensitive.

        \n
        • \n
      • \n

        For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and\n Cost Management User Guide.

        \n
        • \n
      \n
      • \n
    \n     \n

    \n

    To use this operation, you must have permission to perform the s3:PutJobTagging action.

    \n

    Related actions include:

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "PUT", "uri": "/v20180820/jobs/{JobId}/tagging", @@ -3006,19 +3204,12 @@ }, "com.amazonaws.s3control#PutJobTaggingRequest": { "type": "structure", - "members": { - "JobId": { - "target": "com.amazonaws.s3control#JobId", - "traits": { - "smithy.api#documentation": "

    The ID for the S3 Batch Operations job whose tags you want to replace.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, + "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "

    The AWS account ID associated with the S3 Batch Operations job.

    ", + "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } @@ -3029,6 +3220,14 @@ "smithy.api#documentation": "

    The set of tags to associate with the S3 Batch Operations job.

    ", "smithy.api#required": {} } + }, + "JobId": { + "target": "com.amazonaws.s3control#JobId", + "traits": { + "smithy.api#documentation": "

    The ID for the S3 Batch Operations job whose tags you want to replace.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -3042,7 +3241,7 @@ "target": "com.amazonaws.s3control#PutPublicAccessBlockRequest" }, "traits": { - "smithy.api#documentation": "

    Creates or modifies the PublicAccessBlock configuration for an AWS\n account.

    ", + "smithy.api#documentation": "

    Creates or modifies the PublicAccessBlock configuration for an AWS account. For\n more information, see Using Amazon S3 block\n public access.

    \n

    Related actions include:

    \n ", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -3056,6 +3255,14 @@ "com.amazonaws.s3control#PutPublicAccessBlockRequest": { "type": "structure", "members": { + "PublicAccessBlockConfiguration": { + "target": "com.amazonaws.s3control#PublicAccessBlockConfiguration", + "traits": { + "smithy.api#documentation": "

    The PublicAccessBlock configuration that you want to apply to the specified AWS\n account.

    ", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { @@ -3064,44 +3271,48 @@ "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } - }, - "PublicAccessBlockConfiguration": { - "target": "com.amazonaws.s3control#PublicAccessBlockConfiguration", - "traits": { - "smithy.api#documentation": "

    The PublicAccessBlock configuration that you want to apply to the specified AWS\n account.

    ", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.s3control#RegionalBucket": { "type": "structure", "members": { - "BucketArn": { - "target": "com.amazonaws.s3control#S3RegionalBucketArn" - }, - "CreationDate": { - "target": "com.amazonaws.s3control#CreationDate", + "PublicAccessBlockEnabled": { + "target": "com.amazonaws.s3control#PublicAccessBlockEnabled", "traits": { + "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "OutpostId": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength64String" - }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { + "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "PublicAccessBlockEnabled": { - "target": "com.amazonaws.s3control#PublicAccessBlockEnabled", + "BucketArn": { + "target": "com.amazonaws.s3control#S3RegionalBucketArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the regional bucket.

    " + } + }, + "OutpostId": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", + "traits": { + "smithy.api#documentation": "

    The AWS Outposts ID of the regional bucket.

    " + } + }, + "CreationDate": { + "target": "com.amazonaws.s3control#CreationDate", "traits": { + "smithy.api#documentation": "

    The creation date of the regional bucket

    ", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

    The container for the regional bucket.

    " } }, "com.amazonaws.s3control#RegionalBucketList": { @@ -3140,18 +3351,18 @@ "com.amazonaws.s3control#S3AccessControlList": { "type": "structure", "members": { + "Grants": { + "target": "com.amazonaws.s3control#S3GrantList", + "traits": { + "smithy.api#documentation": "

    " + } + }, "Owner": { "target": "com.amazonaws.s3control#S3ObjectOwner", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } - }, - "Grants": { - "target": "com.amazonaws.s3control#S3GrantList", - "traits": { - "smithy.api#documentation": "

    " - } } }, "traits": { @@ -3243,28 +3454,16 @@ "com.amazonaws.s3control#S3CopyObjectOperation": { "type": "structure", "members": { - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3control#S3ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "

    The legal hold status to be applied to all objects in the Batch Operations job.

    " - } - }, - "MetadataDirective": { - "target": "com.amazonaws.s3control#S3MetadataDirective", - "traits": { - "smithy.api#documentation": "

    " - } - }, - "StorageClass": { - "target": "com.amazonaws.s3control#S3StorageClass", + "SSEAwsKmsKeyId": { + "target": "com.amazonaws.s3control#KmsKeyArnString", "traits": { "smithy.api#documentation": "

    " } }, - "SSEAwsKmsKeyId": { - "target": "com.amazonaws.s3control#KmsKeyArnString", + "ObjectLockMode": { + "target": "com.amazonaws.s3control#S3ObjectLockMode", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    The retention mode to be applied to all objects in the Batch Operations job.

    " } }, "AccessControlGrants": { @@ -3285,26 +3484,26 @@ "smithy.api#documentation": "

    The date when the applied object retention configuration expires on all objects in\n the Batch Operations job.

    " } }, - "RequesterPays": { - "target": "com.amazonaws.s3control#Boolean", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3control#S3ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    The legal hold status to be applied to all objects in the Batch Operations job.

    " } }, - "NewObjectTagging": { - "target": "com.amazonaws.s3control#S3TagSet", + "MetadataDirective": { + "target": "com.amazonaws.s3control#S3MetadataDirective", "traits": { "smithy.api#documentation": "

    " } }, - "ObjectLockMode": { - "target": "com.amazonaws.s3control#S3ObjectLockMode", + "TargetKeyPrefix": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { - "smithy.api#documentation": "

    The retention mode to be applied to all objects in the Batch Operations job.

    " + "smithy.api#documentation": "

    " } }, - "ModifiedSinceConstraint": { - "target": "com.amazonaws.s3control#TimeStamp", + "TargetResource": { + "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { "smithy.api#documentation": "

    " } @@ -3315,26 +3514,38 @@ "smithy.api#documentation": "

    " } }, - "UnModifiedSinceConstraint": { + "CannedAccessControlList": { + "target": "com.amazonaws.s3control#S3CannedAccessControlList", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "NewObjectTagging": { + "target": "com.amazonaws.s3control#S3TagSet", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "ModifiedSinceConstraint": { "target": "com.amazonaws.s3control#TimeStamp", "traits": { "smithy.api#documentation": "

    " } }, - "CannedAccessControlList": { - "target": "com.amazonaws.s3control#S3CannedAccessControlList", + "UnModifiedSinceConstraint": { + "target": "com.amazonaws.s3control#TimeStamp", "traits": { "smithy.api#documentation": "

    " } }, - "TargetKeyPrefix": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "RequesterPays": { + "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#documentation": "

    " } }, - "TargetResource": { - "target": "com.amazonaws.s3control#S3BucketArnString", + "StorageClass": { + "target": "com.amazonaws.s3control#S3StorageClass", "traits": { "smithy.api#documentation": "

    " } @@ -3370,14 +3581,14 @@ "com.amazonaws.s3control#S3Grant": { "type": "structure", "members": { - "Permission": { - "target": "com.amazonaws.s3control#S3Permission", + "Grantee": { + "target": "com.amazonaws.s3control#S3Grantee", "traits": { "smithy.api#documentation": "

    " } }, - "Grantee": { - "target": "com.amazonaws.s3control#S3Grantee", + "Permission": { + "target": "com.amazonaws.s3control#S3Permission", "traits": { "smithy.api#documentation": "

    " } @@ -3396,14 +3607,14 @@ "com.amazonaws.s3control#S3Grantee": { "type": "structure", "members": { - "DisplayName": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "TypeIdentifier": { + "target": "com.amazonaws.s3control#S3GranteeTypeIdentifier", "traits": { "smithy.api#documentation": "

    " } }, - "TypeIdentifier": { - "target": "com.amazonaws.s3control#S3GranteeTypeIdentifier", + "DisplayName": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "

    " } @@ -3441,14 +3652,14 @@ "com.amazonaws.s3control#S3InitiateRestoreObjectOperation": { "type": "structure", "members": { - "GlacierJobTier": { - "target": "com.amazonaws.s3control#S3GlacierJobTier", + "ExpirationInDays": { + "target": "com.amazonaws.s3control#S3ExpirationInDays", "traits": { "smithy.api#documentation": "

    " } }, - "ExpirationInDays": { - "target": "com.amazonaws.s3control#S3ExpirationInDays", + "GlacierJobTier": { + "target": "com.amazonaws.s3control#S3GlacierJobTier", "traits": { "smithy.api#documentation": "

    " } @@ -3546,13 +3757,19 @@ "com.amazonaws.s3control#S3ObjectMetadata": { "type": "structure", "members": { - "UserMetadata": { - "target": "com.amazonaws.s3control#S3UserMetadata", + "ContentEncoding": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "

    " } }, - "ContentLanguage": { + "ContentDisposition": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "ContentType": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "

    " @@ -3565,7 +3782,7 @@ "smithy.api#documentation": "

    " } }, - "ContentEncoding": { + "CacheControl": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "

    " @@ -3577,38 +3794,32 @@ "smithy.api#documentation": "

    " } }, - "ContentDisposition": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", - "traits": { - "smithy.api#documentation": "

    " - } - }, "SSEAlgorithm": { "target": "com.amazonaws.s3control#S3SSEAlgorithm", "traits": { "smithy.api#documentation": "

    " } }, - "ContentMD5": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "UserMetadata": { + "target": "com.amazonaws.s3control#S3UserMetadata", "traits": { "smithy.api#documentation": "

    " } }, - "RequesterCharged": { - "target": "com.amazonaws.s3control#Boolean", + "ContentMD5": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "

    " } }, - "CacheControl": { + "ContentLanguage": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "

    " } }, - "ContentType": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", + "RequesterCharged": { + "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#documentation": "

    " } @@ -3750,19 +3961,19 @@ "com.amazonaws.s3control#S3SetObjectRetentionOperation": { "type": "structure", "members": { - "Retention": { - "target": "com.amazonaws.s3control#S3Retention", - "traits": { - "smithy.api#documentation": "

    Contains the Object Lock retention mode to be applied to all objects in the Batch Operations\n job. For more information, see Using S3 Object Lock retention\n with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

    ", - "smithy.api#required": {} - } - }, "BypassGovernanceRetention": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

    Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock \n GOVERNANCE type in place.

    " } + }, + "Retention": { + "target": "com.amazonaws.s3control#S3Retention", + "traits": { + "smithy.api#documentation": "

    Contains the Object Lock retention mode to be applied to all objects in the Batch Operations\n job. For more information, see Using S3 Object Lock retention\n with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -3839,10 +4050,7 @@ "com.amazonaws.s3control#S3TagSet": { "type": "list", "member": { - "target": "com.amazonaws.s3control#S3Tag", - "traits": { - "smithy.api#xmlName": "Tag" - } + "target": "com.amazonaws.s3control#S3Tag" } }, "com.amazonaws.s3control#S3UserMetadata": { @@ -3911,9 +4119,13 @@ "TagSet": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { + "smithy.api#documentation": "

    A collection for a set of tags.

    ", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

    " } }, "com.amazonaws.s3control#TimeStamp": { @@ -3946,15 +4158,27 @@ "com.amazonaws.s3control#Transition": { "type": "structure", "members": { - "StorageClass": { - "target": "com.amazonaws.s3control#TransitionStorageClass" - }, "Date": { - "target": "com.amazonaws.s3control#Date" + "target": "com.amazonaws.s3control#Date", + "traits": { + "smithy.api#documentation": "

    Indicates when objects are transitioned to the specified storage class. \n The date value must be in ISO 8601 format. The time is always midnight UTC.

    " + } + }, + "StorageClass": { + "target": "com.amazonaws.s3control#TransitionStorageClass", + "traits": { + "smithy.api#documentation": "

    The storage class to which you want the object to transition.

    " + } }, "Days": { - "target": "com.amazonaws.s3control#Days" + "target": "com.amazonaws.s3control#Days", + "traits": { + "smithy.api#documentation": "

    Indicates the number of days after creation when objects are transitioned to the specified storage class. \n The value must be a positive integer.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    Specifies when an object transitions to a specified storage class. For more information\n about Amazon S3 Lifecycle configuration rules, see \n Transitioning Objects Using Amazon S3 Lifecycle in the\n Amazon Simple Storage Service Developer Guide.

    " } }, "com.amazonaws.s3control#TransitionList": { @@ -4011,7 +4235,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "POST", "uri": "/v20180820/jobs/{JobId}/priority", @@ -4022,14 +4249,6 @@ "com.amazonaws.s3control#UpdateJobPriorityRequest": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.s3control#AccountId", - "traits": { - "smithy.api#documentation": "

    ", - "smithy.api#httpHeader": "x-amz-account-id", - "smithy.api#required": {} - } - }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { @@ -4038,6 +4257,15 @@ "smithy.api#required": {} } }, + "AccountId": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

    ", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "x-amz-account-id", + "smithy.api#required": {} + } + }, "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { @@ -4093,7 +4321,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates the status for the specified job. Use this operation to confirm that you want to\n run a job or to cancel an existing job. For more information, see S3 Batch Operations in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    Updates the status for the specified job. Use this operation to confirm that you want to\n run a job or to cancel an existing job. For more information, see S3 Batch Operations in the\n Amazon Simple Storage Service Developer Guide.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#endpoint": { + "hostPrefix": "{AccountId}." + }, "smithy.api#http": { "method": "POST", "uri": "/v20180820/jobs/{JobId}/status", @@ -4131,6 +4362,7 @@ "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "

    ", + "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {} } @@ -4140,6 +4372,12 @@ "com.amazonaws.s3control#UpdateJobStatusResult": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.s3control#JobStatus", + "traits": { + "smithy.api#documentation": "

    The current status for the specified job.

    " + } + }, "StatusUpdateReason": { "target": "com.amazonaws.s3control#JobStatusUpdateReason", "traits": { @@ -4151,12 +4389,6 @@ "traits": { "smithy.api#documentation": "

    The ID for the job whose status was updated.

    " } - }, - "Status": { - "target": "com.amazonaws.s3control#JobStatus", - "traits": { - "smithy.api#documentation": "

    The current status for the specified job.

    " - } } } }, 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 82223112b09a..7c85157b085f 100644 --- a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json +++ b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json @@ -60,7 +60,7 @@ } ], "traits": { - "smithy.api#documentation": "

    This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

    \n

    To verify that all parts have been removed, so you don't get charged for the part storage, you\n should call the ListParts operation and ensure that the parts list is\n empty.

    \n

    For information about permissions required to use the multipart upload API, see Multipart\n Upload API and Permissions.

    \n

    The following operations are related to AbortMultipartUpload:

    \n ", + "smithy.api#documentation": "

    This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

    \n

    To verify that all parts have been removed, so you don't get charged for the part storage, you\n should call the ListParts operation and ensure that the parts list is\n empty.

    \n

    For information about permissions required to use the multipart upload API, see Multipart\n Upload API and Permissions.

    \n

    The following operations are related to AbortMultipartUpload:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}/{Key+}?x-id=AbortMultipartUpload", @@ -82,11 +82,11 @@ "com.amazonaws.s3#AbortMultipartUploadRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", "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 using 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#documentation": "

    Upload ID that identifies the multipart upload.

    ", + "smithy.api#httpQuery": "uploadId", "smithy.api#required": {} } }, @@ -96,12 +96,11 @@ "smithy.api#httpHeader": "x-amz-request-payer" } }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Upload ID that identifies the multipart upload.

    ", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} + "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" } }, "Key": { @@ -111,6 +110,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "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": {} + } } } }, @@ -243,6 +250,9 @@ { "target": "com.amazonaws.s3#DeleteBucketMetricsConfiguration" }, + { + "target": "com.amazonaws.s3#DeleteBucketOwnershipControls" + }, { "target": "com.amazonaws.s3#DeleteBucketPolicy" }, @@ -300,6 +310,9 @@ { "target": "com.amazonaws.s3#GetBucketNotificationConfiguration" }, + { + "target": "com.amazonaws.s3#GetBucketOwnershipControls" + }, { "target": "com.amazonaws.s3#GetBucketPolicy" }, @@ -408,6 +421,9 @@ { "target": "com.amazonaws.s3#PutBucketNotificationConfiguration" }, + { + "target": "com.amazonaws.s3#PutBucketOwnershipControls" + }, { "target": "com.amazonaws.s3#PutBucketPolicy" }, @@ -483,6 +499,12 @@ "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 to be included in the metrics results.

    " + } + }, "Tags": { "target": "com.amazonaws.s3#TagSet", "traits": { @@ -490,12 +512,6 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } - }, - "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 to be included in the metrics results.

    " - } } }, "traits": { @@ -554,12 +570,6 @@ "com.amazonaws.s3#AnalyticsFilter": { "type": "structure", "members": { - "And": { - "target": "com.amazonaws.s3#AnalyticsAndOperator", - "traits": { - "smithy.api#documentation": "

    A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

    " - } - }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { @@ -571,6 +581,12 @@ "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 filter. The operator must have at least two predicates.

    " + } } }, "traits": { @@ -583,19 +599,18 @@ "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": {} - } - }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { "smithy.api#documentation": "

    The prefix to use when exporting data. The prefix is prepended to all results.

    " } }, + "BucketAccountId": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

    The account ID that owns the destination S3 bucket. \n If no account ID is provided, the owner is not validated before exporting data.

    \n \n

    \n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket \n ownership changes.\n

    \n     " + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -603,10 +618,11 @@ "smithy.api#required": {} } }, - "BucketAccountId": { - "target": "com.amazonaws.s3#AccountId", + "Format": { + "target": "com.amazonaws.s3#AnalyticsS3ExportFileFormat", "traits": { - "smithy.api#documentation": "

    The account ID that owns the destination S3 bucket. \n If no account ID is provided, the owner is not validated before exporting data.

    \n \n

    \n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket \n ownership changes.\n

    \n     " + "smithy.api#documentation": "

    Specifies the file format used when exporting data to Amazon S3.

    ", + "smithy.api#required": {} } } }, @@ -664,7 +680,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

    The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.

    ", + "smithy.api#documentation": "

    The requested bucket name is not available. The bucket namespace is shared by all users of the\n system. Select a different name and try again.

    ", "smithy.api#error": "client" } }, @@ -717,16 +733,19 @@ "traits": { "smithy.api#enum": [ { - "value": "EU" + "value": "af-south-1" }, { - "value": "eu-west-1" + "value": "ap-east-1" }, { - "value": "us-west-1" + "value": "ap-northeast-1" }, { - "value": "us-west-2" + "value": "ap-northeast-2" + }, + { + "value": "ap-northeast-3" }, { "value": "ap-south-1" @@ -738,16 +757,55 @@ "value": "ap-southeast-2" }, { - "value": "ap-northeast-1" + "value": "ca-central-1" }, { - "value": "sa-east-1" + "value": "cn-north-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" } ] } @@ -836,10 +894,12 @@ "com.amazonaws.s3#CORSRule": { "type": "structure", "members": { - "MaxAgeSeconds": { - "target": "com.amazonaws.s3#MaxAgeSeconds", + "AllowedHeaders": { + "target": "com.amazonaws.s3#AllowedHeaders", "traits": { - "smithy.api#documentation": "

    The time in seconds that your browser is to cache the preflight response for the specified resource.

    " + "smithy.api#documentation": "

    Headers that are specified in the Access-Control-Request-Headers\n header. These headers are allowed in a preflight OPTIONS request. In response to\n any preflight OPTIONS request, Amazon S3 returns any requested headers that are\n allowed.

    ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AllowedHeader" } }, "AllowedOrigins": { @@ -851,12 +911,18 @@ "smithy.api#xmlName": "AllowedOrigin" } }, - "AllowedHeaders": { - "target": "com.amazonaws.s3#AllowedHeaders", + "MaxAgeSeconds": { + "target": "com.amazonaws.s3#MaxAgeSeconds", "traits": { - "smithy.api#documentation": "

    Headers that are specified in the Access-Control-Request-Headers\n header. These headers are allowed in a preflight OPTIONS request. In response to\n any preflight OPTIONS request, Amazon S3 returns any requested headers that are\n allowed.

    ", + "smithy.api#documentation": "

    The time in seconds that your browser is to cache the preflight response for the specified resource.

    " + } + }, + "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 their applications (for example, from a JavaScript XMLHttpRequest object).

    ", "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AllowedHeader" + "smithy.api#xmlName": "ExposeHeader" } }, "AllowedMethods": { @@ -867,14 +933,6 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AllowedMethod" } - }, - "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 their applications (for example, from a JavaScript XMLHttpRequest object).

    ", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "ExposeHeader" - } } }, "traits": { @@ -890,16 +948,10 @@ "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
      \n
    • \n

      \n NONE: First line is not a header.

      \n
      • \n
    • \n

      \n IGNORE: First line is a header, but you can't use the header values to\n indicate the column in an expression. You can use column\n position (such as _1, _2, …) to indicate the column\n (SELECT s._1 FROM OBJECT s).

      \n
      • \n
    • \n

      \n Use: First line is a header, and you can use the header value to\n identify a column in an expression (SELECT \"name\"\n FROM OBJECT).

      \n
      • \n
    " - } - }, - "Comments": { - "target": "com.amazonaws.s3#Comments", + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", "traits": { - "smithy.api#documentation": "

    A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line.

    " + "smithy.api#documentation": "

    A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

    " } }, "AllowQuotedRecordDelimiter": { @@ -908,10 +960,10 @@ "smithy.api#documentation": "

    Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

    " } }, - "FieldDelimiter": { - "target": "com.amazonaws.s3#FieldDelimiter", + "FileHeaderInfo": { + "target": "com.amazonaws.s3#FileHeaderInfo", "traits": { - "smithy.api#documentation": "

    A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

    " + "smithy.api#documentation": "

    Describes the first line of input. Valid values are:

    \n
      \n
    • \n

      \n NONE: First line is not a header.

      \n
      • \n
    • \n

      \n IGNORE: First line is a header, but you can't use the header values to\n indicate the column in an expression. You can use column\n position (such as _1, _2, …) to indicate the column\n (SELECT s._1 FROM OBJECT s).

      \n
      • \n
    • \n

      \n Use: First line is a header, and you can use the header value to\n identify a column in an expression (SELECT \"name\"\n FROM OBJECT).

      \n
      • \n
    " } }, "QuoteCharacter": { @@ -931,6 +983,12 @@ "traits": { "smithy.api#documentation": "

    A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

    " } + }, + "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 present at the start of that row. You can specify any character to indicate a comment line.

    " + } } }, "traits": { @@ -940,10 +998,16 @@ "com.amazonaws.s3#CSVOutput": { "type": "structure", "members": { - "QuoteEscapeCharacter": { - "target": "com.amazonaws.s3#QuoteEscapeCharacter", + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", "traits": { - "smithy.api#documentation": "

    The single character used for escaping the quote character inside an already escaped\n value.

    " + "smithy.api#documentation": "

    The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

    " + } + }, + "QuoteFields": { + "target": "com.amazonaws.s3#QuoteFields", + "traits": { + "smithy.api#documentation": "

    Indicates whether to use quotation marks around output fields.

    \n
      \n
    • \n

      \n ALWAYS: Always use quotation marks for output fields.

      \n
      • \n
    • \n

      \n ASNEEDED: Use quotation marks for output fields when needed.

      \n
      • \n
    " } }, "QuoteCharacter": { @@ -958,16 +1022,10 @@ "smithy.api#documentation": "

    A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

    " } }, - "QuoteFields": { - "target": "com.amazonaws.s3#QuoteFields", - "traits": { - "smithy.api#documentation": "

    Indicates whether to use quotation marks around output fields.

    \n
      \n
    • \n

      \n ALWAYS: Always use quotation marks for output fields.

      \n
      • \n
    • \n

      \n ASNEEDED: Use quotation marks for output fields when needed.

      \n
      • \n
    " - } - }, - "FieldDelimiter": { - "target": "com.amazonaws.s3#FieldDelimiter", + "QuoteEscapeCharacter": { + "target": "com.amazonaws.s3#QuoteEscapeCharacter", "traits": { - "smithy.api#documentation": "

    The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

    " + "smithy.api#documentation": "

    The single character used for escaping the quote character inside an already escaped\n value.

    " } } }, @@ -1013,7 +1071,7 @@ "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 operation. After successfully uploading all relevant parts of an\n upload, you call this operation to complete the upload. Upon receiving this request, Amazon\n S3 concatenates all the parts in ascending order by part number to create a new object. In\n the Complete Multipart Upload request, you must provide the parts list. You must ensure\n that the parts list is complete. This operation concatenates the parts that you provide in\n the list. For each part in the list, you must provide the part number and the\n ETag value, returned after that part was uploaded.

    \n

    Processing of a Complete Multipart Upload request could take several minutes to complete.\n 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\n white space characters to keep the connection from timing out. Because a request could fail\n after the initial 200 OK response has been sent, it is important that you check the\n response body to determine whether the request succeeded.

    \n

    Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

    \n

    For more information about multipart uploads, see Uploading\n Objects Using Multipart Upload.

    \n

    For information about permissions required to use the multipart upload API, see Multipart\n Upload API and Permissions.

    \n \n \n

    \n GetBucketLifecycle has the following special errors:

    \n
      \n
    • \n

      Error code: EntityTooSmall\n

      \n
        \n
      • \n

        Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.

        \n
        • \n
      • \n

        400 Bad Request

        \n
        • \n
      \n
      • \n
    • \n

      Error code: InvalidPart\n

      \n
        \n
      • \n

        Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.

        \n
        • \n
      • \n

        400 Bad Request

        \n
        • \n
      \n
      • \n
    • \n

      Error code: InvalidPartOrder\n

      \n
        \n
      • \n

        Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.

        \n
        • \n
      • \n

        400 Bad Request

        \n
        • \n
      \n
      • \n
    • \n

      Error code: NoSuchUpload\n

      \n
        \n
      • \n

        Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

        \n
        • \n
      • \n

        404 Not Found

        \n
        • \n
      \n
      • \n
    \n \n

    The following operations are related to CompleteMultipartUpload:

    \n ", + "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 \n UploadPart operation. After successfully uploading all relevant parts of an\n upload, you call this operation to complete the upload. Upon receiving this request, Amazon\n S3 concatenates all the parts in ascending order by part number to create a new object. In\n the Complete Multipart Upload request, you must provide the parts list. You must ensure\n that the parts list is complete. This operation concatenates the parts that you provide in\n the list. For each part in the list, you must provide the part number and the\n ETag value, returned after that part was uploaded.

    \n

    Processing of a Complete Multipart Upload request could take several minutes to complete.\n 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\n white space characters to keep the connection from timing out. Because a request could fail\n after the initial 200 OK response has been sent, it is important that you check the\n response body to determine whether the request succeeded.

    \n

    Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

    \n

    For more information about multipart uploads, see Uploading\n Objects Using Multipart Upload.

    \n

    For information about permissions required to use the multipart upload API, see Multipart\n Upload API and Permissions.

    \n \n \n

    \n CompleteMultipartUpload has the following special errors:

    \n
      \n
    • \n

      Error code: EntityTooSmall\n

      \n
        \n
      • \n

        Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.

        \n
        • \n
      • \n

        400 Bad Request

        \n
        • \n
      \n
      • \n
    • \n

      Error code: InvalidPart\n

      \n
        \n
      • \n

        Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.

        \n
        • \n
      • \n

        400 Bad Request

        \n
        • \n
      \n
      • \n
    • \n

      Error code: InvalidPartOrder\n

      \n
        \n
      • \n

        Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.

        \n
        • \n
      • \n

        400 Bad Request

        \n
        • \n
      \n
      • \n
    • \n

      Error code: NoSuchUpload\n

      \n
        \n
      • \n

        Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

        \n
        • \n
      • \n

        404 Not Found

        \n
        • \n
      \n
      • \n
    \n \n

    The following operations are related to CompleteMultipartUpload:

    \n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}", @@ -1024,29 +1082,24 @@ "com.amazonaws.s3#CompleteMultipartUploadOutput": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

    The object key of the newly created object.

    " - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "Expiration": { + "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "

    Version ID of the newly created object, in case the bucket has versioning turned on.

    ", - "smithy.api#httpHeader": "x-amz-version-id" + "smithy.api#documentation": "

    If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

    ", + "smithy.api#httpHeader": "x-amz-expiration" } }, - "Location": { - "target": "com.amazonaws.s3#Location", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The URI that identifies the newly created object.

    " + "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.

    " } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "

    If you specified server-side encryption either with an Amazon S3-managed encryption key or an AWS KMS customer master key (CMK) in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, "SSEKMSKeyId": { @@ -1056,30 +1109,35 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "Location": { + "target": "com.amazonaws.s3#Location", "traits": { - "smithy.api#documentation": "

    If you specified server-side encryption either with an Amazon S3-managed encryption key or an AWS KMS customer master key (CMK) in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption" + "smithy.api#documentation": "

    The URI that identifies the newly created object.

    " } }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "

    If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

    ", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#documentation": "

    Version ID of the newly created object, in case the bucket has versioning turned on.

    ", + "smithy.api#httpHeader": "x-amz-version-id" } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "

    Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.

    " + "smithy.api#httpHeader": "x-amz-request-charged" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

    The object key of the newly created object.

    " + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "

    The name of the bucket that contains the newly created object.

    " + "smithy.api#documentation": "

    Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.

    " } } } @@ -1087,12 +1145,11 @@ "com.amazonaws.s3#CompleteMultipartUploadRequest": { "type": "structure", "members": { - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    ID for the initiated multipart upload.

    ", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} + "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" } }, "RequestPayer": { @@ -1101,12 +1158,12 @@ "smithy.api#httpHeader": "x-amz-request-payer" } }, - "MultipartUpload": { - "target": "com.amazonaws.s3#CompletedMultipartUpload", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    The container for the multipart upload request information.

    ", - "smithy.api#httpPayload": {}, - "smithy.api#xmlName": "CompleteMultipartUpload" + "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Bucket": { @@ -1117,13 +1174,21 @@ "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", "traits": { - "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    ID for the initiated multipart upload.

    ", + "smithy.api#httpQuery": "uploadId", "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" + } } } }, @@ -1250,7 +1315,7 @@ } ], "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 object\n up to 5 GB in size in a single atomic operation using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For\n more information, see Copy\n Object Using the REST Multipart Upload API.

    \n     \n

    All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

    \n

    A copy request might return an error when Amazon S3 receives the copy request or while\n Amazon S3 is copying the files. If the error occurs before the copy operation starts, you\n receive a standard Amazon S3 error. If the error occurs during the copy operation, the\n\n error response is embedded in the 200 OK response. This means that a 200\n OK response can contain either a success or an error. Design your application to\n parse the 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
    • \n

      \n x-amz-copy-source-if-match\n

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-none-match\n

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-unmodified-since\n

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-modified-since\n

      \n
      • \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\n\n request and evaluate as follows, Amazon S3 returns 200 OK and copies the\n data:

    \n
      \n
    • \n

      \n x-amz-copy-source-if-match condition evaluates to true

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-unmodified-since condition evaluates to false

      \n
      • \n
    \n \n

    If both the x-amz-copy-source-if-none-match and\n\n x-amz-copy-source-if-modified-since headers are present in the\n request and evaluate as follows, Amazon S3 returns the 412 Precondition\n Failed response code:

    \n
      \n
    • \n

      \n x-amz-copy-source-if-none-match condition evaluates to false

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-modified-since condition evaluates to true

      \n
      • \n
    \n \n \n

    All headers with the x-amz- prefix, including x-amz-copy-source,\n must be signed.

    \n     \n

    \n Encryption\n

    \n

    The source object that you are copying can be encrypted or unencrypted. The source object\n can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or\n SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts the data when\n you access it.

    \n

    You can optionally use the appropriate encryption-related headers to request server-side\n encryption for the target object. You have the option to provide your own encryption key or\n use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to\n encrypt the source object. You can even request encryption if the source object was not\n encrypted. For more information about server-side encryption, see Using\n Server-Side Encryption.

    \n

    \n Access Control List (ACL)-Specific Request Headers\n

    \n

    When copying an object, you can optionally use headers to grant ACL-based permissions. By\n default, all objects are private. Only the owner has full access control. When adding a new\n 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.\n For 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\n for 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 .

    \n

    The following operations are related to CopyObject:

    \n \n

    For more information, see Copying Objects.

    ", + "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 object\n up to 5 GB in size in a single atomic operation using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For\n more information, see Copy\n Object Using the REST Multipart Upload API.

    \n     \n

    All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

    \n

    A copy request might return an error when Amazon S3 receives the copy request or while\n Amazon S3 is copying the files. If the error occurs before the copy operation starts, you\n receive a standard Amazon S3 error. If the error occurs during the copy operation, the\n\n error response is embedded in the 200 OK response. This means that a 200\n OK response can contain either a success or an error. Design your application to\n parse the 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
    • \n

      \n x-amz-copy-source-if-match\n

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-none-match\n

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-unmodified-since\n

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-modified-since\n

      \n
      • \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\n\n request and evaluate as follows, Amazon S3 returns 200 OK and copies the\n data:

    \n
      \n
    • \n

      \n x-amz-copy-source-if-match condition evaluates to true

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-unmodified-since condition evaluates to false

      \n
      • \n
    \n \n

    If both the x-amz-copy-source-if-none-match and\n\n x-amz-copy-source-if-modified-since headers are present in the\n request and evaluate as follows, Amazon S3 returns the 412 Precondition\n Failed response code:

    \n
      \n
    • \n

      \n x-amz-copy-source-if-none-match condition evaluates to false

      \n
      • \n
    • \n

      \n x-amz-copy-source-if-modified-since condition evaluates to true

      \n
      • \n
    \n \n \n

    All headers with the x-amz- prefix, including x-amz-copy-source,\n must be signed.

    \n     \n

    \n Encryption\n

    \n

    The source object that you are copying can be encrypted or unencrypted. The source object\n can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or\n SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts the data when\n you access it.

    \n

    You can optionally use the appropriate encryption-related headers to request server-side\n encryption for the target object. You have the option to provide your own encryption key or\n use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to\n encrypt the source object. You can even request encryption if the source object was not\n encrypted. For more information about server-side encryption, see Using\n Server-Side Encryption.

    \n

    \n Access Control List (ACL)-Specific Request Headers\n

    \n

    When copying an object, you can optionally use headers to grant ACL-based permissions. By\n default, all objects are private. Only the owner has full access control. When adding a new\n 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.\n For 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\n for 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 Objects.

    ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=CopyObject", @@ -1261,13 +1326,6 @@ "com.amazonaws.s3#CopyObjectOutput": { "type": "structure", "members": { - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the 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": { @@ -1275,11 +1333,25 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "Expiration": { + "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "

    If the object expiration is configured, the response includes this header.

    ", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

    Version ID of the newly created copy.

    ", + "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 response will include this header confirming the encryption algorithm used.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, "CopySourceVersionId": { @@ -1289,13 +1361,6 @@ "smithy.api#httpHeader": "x-amz-copy-source-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" - } - }, "CopyObjectResult": { "target": "com.amazonaws.s3#CopyObjectResult", "traits": { @@ -1310,24 +1375,24 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "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" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "

    Version ID of the newly created copy.

    ", - "smithy.api#httpHeader": "x-amz-version-id" + "smithy.api#httpHeader": "x-amz-request-charged" } }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

    If the object expiration is configured, the response includes this header.

    ", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#documentation": "

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } } } @@ -1335,68 +1400,74 @@ "com.amazonaws.s3#CopyObjectRequest": { "type": "structure", "members": { - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", "traits": { - "smithy.api#documentation": "

    Allows grantee to read the object ACL.

    ", - "smithy.api#httpHeader": "x-amz-grant-read-acp" + "smithy.api#documentation": "

    The tag-set for the object destination object this value must be used in conjunction with the\n TaggingDirective. The tag-set must be encoded as URL Query\n parameters.

    ", + "smithy.api#httpHeader": "x-amz-tagging" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

    The key of the destination object.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", "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" + "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" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "

    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an\n object protected by AWS KMS will fail if not made via SSL or using SigV4. For information\n about configuring using any of the officially 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" + "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", + "smithy.api#httpHeader": "Expires" } }, - "CopySourceSSECustomerAlgorithm": { - "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use when decrypting the source object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + "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" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "CopySourceIfModifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfModifiedSince", "traits": { - "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", - "smithy.api#httpHeader": "Content-Encoding" + "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" } }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", "traits": { - "smithy.api#documentation": "

    Allows grantee to read the object data and its metadata.

    ", - "smithy.api#httpHeader": "x-amz-grant-read" + "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", + "smithy.api#httpHeader": "Content-Disposition" } }, - "CopySourceIfUnmodifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "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" + "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" } }, - "TaggingDirective": { - "target": "com.amazonaws.s3#TaggingDirective", + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "

    Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

    ", - "smithy.api#httpHeader": "x-amz-tagging-directive" + "smithy.api#documentation": "

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "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" } }, "ContentLanguage": { @@ -1406,32 +1477,55 @@ "smithy.api#httpHeader": "Content-Language" } }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", - "smithy.api#httpHeader": "Content-Disposition" + "smithy.api#documentation": "

    Allows grantee to read the object data and its metadata.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-read" } }, - "CopySourceIfMatch": { - "target": "com.amazonaws.s3#CopySourceIfMatch", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "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" + "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" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    ", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

    The key of the destination object.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "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" + "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable object.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "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 formats, depending on whether you want \n to access the source object through an access point:

    \n
      \n
    • \n

      For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). \n For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

      \n
      • \n
    • \n

      For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

      \n \n

      Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

      \n       \n

      Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

      \n
      • \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": {} + } + }, + "CopySourceSSECustomerAlgorithm": { + "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

    Specifies the algorithm to use when decrypting the source object (for example, 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 object. The encryption key provided in this header must be one that was used when the source object was created.

    ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" } }, "CopySourceSSECustomerKeyMD5": { @@ -1441,19 +1535,18 @@ "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "traits": { - "smithy.api#documentation": "

    The name of the destination bucket.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", + "smithy.api#httpHeader": "Cache-Control" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "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" } }, "RequestPayer": { @@ -1462,117 +1555,89 @@ "smithy.api#httpHeader": "x-amz-request-payer" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "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" + "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", - "smithy.api#httpHeader": "Expires" + "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" } }, - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", + "TaggingDirective": { + "target": "com.amazonaws.s3#TaggingDirective", "traits": { - "smithy.api#documentation": "

    The tag-set for the object destination object this value must be used in conjunction with the\n TaggingDirective. The tag-set must be encoded as URL Query\n parameters.

    ", - "smithy.api#httpHeader": "x-amz-tagging" + "smithy.api#documentation": "

    Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

    ", + "smithy.api#httpHeader": "x-amz-tagging-directive" } }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", "traits": { - "smithy.api#documentation": "

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", - "smithy.api#httpHeader": "x-amz-website-redirect-location" + "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "smithy.api#httpHeader": "Content-Encoding" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable object.

    ", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", - "traits": { - "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", - "smithy.api#httpHeader": "Cache-Control" - } - }, - "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" - } - }, - "CopySource": { - "target": "com.amazonaws.s3#CopySource", - "traits": { - "smithy.api#documentation": "

    The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

    ", - "smithy.api#httpHeader": "x-amz-copy-source", - "smithy.api#required": {} - } - }, - "CopySourceSSECustomerKey": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", "traits": { - "smithy.api#documentation": "

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

    ", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + "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" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "

    The type of storage to use for the object. Defaults to 'STANDARD'.

    ", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    ", + "smithy.api#httpHeader": "Content-Type" } }, - "CopySourceIfModifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfModifiedSince", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "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" + "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", + "CopySourceIfMatch": { + "target": "com.amazonaws.s3#CopySourceIfMatch", "traits": { - "smithy.api#documentation": "

    The canned ACL to apply to the object.

    ", - "smithy.api#httpHeader": "x-amz-acl" + "smithy.api#documentation": "

    Copies the object if its entity tag (ETag) matches the specified tag.

    ", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    ", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "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": {} } }, - "CopySourceIfNoneMatch": { - "target": "com.amazonaws.s3#CopySourceIfNoneMatch", + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", "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" + "smithy.api#documentation": "

    The Object Lock mode that you want to apply to the copied object.

    ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" } }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "smithy.api#documentation": "

    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an\n object protected by AWS KMS will fail if not made via SSL or using SigV4. For information\n about configuring using any of the officially 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", + "ExpectedSourceBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + "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" } }, "ServerSideEncryption": { @@ -1589,11 +1654,25 @@ "smithy.api#httpHeader": "x-amz-metadata-directive" } }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "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" + "smithy.api#documentation": "

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "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" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.\n The 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 \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.

    ", + "smithy.api#httpHeader": "x-amz-storage-class" } } } @@ -1601,17 +1680,17 @@ "com.amazonaws.s3#CopyObjectResult": { "type": "structure", "members": { - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

    Returns the date that the object was last modified.

    " - } - }, "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 object, not its metadata. The source and destination ETag is identical for a successfully copied object.

    " } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

    Returns the date that the object was last modified.

    " + } } }, "traits": { @@ -1691,7 +1770,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

    \n

    Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

    \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 How to Select a Region for Your Buckets.

    \n \n

    If you send your create bucket request to the s3.amazonaws.com endpoint, the\n 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\n Hosting of Buckets.

    \n     \n

    When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.

    \n
      \n
    • \n

      Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a\n predefined set of grantees and permissions. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL.\n For more information, see Access\n Control List (ACL) Overview.

      \n

      You specify each grantee as a type=value pair, where the type is one of the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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

    You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

    \n     \n \n \n

    The following operations are related to CreateBucket:

    \n ", + "smithy.api#documentation": "

    Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to 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, the\n 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 groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.

    \n
      \n
    • \n

      Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a\n predefined set of grantees and permissions. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.

      \n

      You specify each grantee as a type=value pair, where the type is one of the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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

    You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

    \n     \n \n \n

    The following operations are related to CreateBucket:

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}", @@ -1728,18 +1807,18 @@ "com.amazonaws.s3#CreateBucketRequest": { "type": "structure", "members": { - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#documentation": "

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-write" + "smithy.api#documentation": "

    Allows grantee to read the bucket ACL.

    ", + "smithy.api#httpHeader": "x-amz-grant-read-acp" } }, - "ObjectLockEnabledForBucket": { - "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "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" + "smithy.api#documentation": "

    Allows grantee to list the objects in the bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-read" } }, "ACL": { @@ -1749,47 +1828,47 @@ "smithy.api#httpHeader": "x-amz-acl" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", "traits": { - "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "smithy.api#documentation": "

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-write" } }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Allows grantee to list the objects in the bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-read" + "smithy.api#documentation": "

    The name of the bucket to create.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "CreateBucketConfiguration": { - "target": "com.amazonaws.s3#CreateBucketConfiguration", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "

    The configuration information for the bucket.

    ", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", + "ObjectLockEnabledForBucket": { + "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", "traits": { - "smithy.api#documentation": "

    Allows grantee to read the bucket ACL.

    ", - "smithy.api#httpHeader": "x-amz-grant-read-acp" + "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" } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "CreateBucketConfiguration": { + "target": "com.amazonaws.s3#CreateBucketConfiguration", "traits": { - "smithy.api#documentation": "

    The name of the bucket to create.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The configuration information for the bucket.

    ", + "smithy.api#httpPayload": {} } } } @@ -1803,7 +1882,7 @@ "target": "com.amazonaws.s3#CreateMultipartUploadOutput" }, "traits": { - "smithy.api#documentation": "

    This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload 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 upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

    \n \n

    For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

    \n \n

    For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).

    \n \n \n

    After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.\n

    \n     \n \n

    You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart) and UploadPartCopy) requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.

    \n

    To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, and kms:DescribeKey actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.

    \n \n

    If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

    \n \n \n

    For more information, see Protecting 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 should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

    \n
      \n
    • \n

      Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

      \n
      • \n
    \n

    You can use either a canned ACL or specify access permissions explicitly. You 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 encryption.\n Server-side encryption is for data encryption at rest. Amazon S3 encrypts your\n data as it writes it to disks in its data centers and decrypts it when you access\n it. The option you use depends on whether you want to use AWS managed encryption\n keys or provide your own encryption key.

    \n
      \n
    • \n

      Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key\n Management Service (AWS KMS) – If you want AWS to manage the keys used to\n 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 don't provide\n x-amz-server-side-encryption-aws-kms-key-id, Amazon S3\n 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 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 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 operation. By default,\n all objects are private. Only the owner has full access control. When adding a new\n object, you can grant permissions to individual AWS accounts or to predefined\n groups defined by Amazon S3. These permissions are then added to the access\n control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions\n using one of the following two methods:

    \n
      \n
    • \n

      Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs,\n known as canned ACLs. Each canned ACL has a predefined\n set of grantees and permissions. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly — To explicitly grant access permissions to specific AWS\n accounts or groups, use the following headers. Each header maps to specific\n permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview. In the header, you specify a\n list of grantees who get the specific permission. To grant permissions\n explicitly, 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 the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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#documentation": "

    This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload 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 upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

    \n \n

    For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

    \n \n

    For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).

    \n \n \n

    After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.\n

    \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 have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, and kms:DescribeKey actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.

    \n \n

    If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

    \n \n \n

    For more information, see Protecting 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 should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

    \n
      \n
    • \n

      Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

      \n
      • \n
    \n

    You can use either a canned ACL or specify access permissions explicitly. You 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 encryption.\n Server-side encryption is for data encryption at rest. Amazon S3 encrypts your\n data as it writes it to disks in its data centers and decrypts it when you access\n it. The option you use depends on whether you want to use AWS managed encryption\n keys or provide your own encryption key.

    \n
      \n
    • \n

      Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key\n Management Service (AWS KMS) – If you want AWS to manage the keys used to\n 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 don't provide\n x-amz-server-side-encryption-aws-kms-key-id, Amazon S3\n 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 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 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 operation. By default,\n all objects are private. Only the owner has full access control. When adding a new\n object, you can grant permissions to individual AWS accounts or to predefined\n groups defined by Amazon S3. These permissions are then added to the access\n control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions\n using one of the following two methods:

    \n
      \n
    • \n

      Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs,\n known as canned ACLs. Each canned ACL has a predefined\n set of grantees and permissions. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly — To explicitly grant access permissions to specific AWS\n accounts or groups, use the following headers. Each header maps to specific\n permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview. In the header, you specify a\n list of grantees who get the specific permission. To grant permissions\n explicitly, 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 the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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", @@ -1814,20 +1893,6 @@ "com.amazonaws.s3#CreateMultipartUploadOutput": { "type": "structure", "members": { - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

    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 using 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#xmlName": "Bucket" - } - }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { @@ -1835,20 +1900,6 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "AbortRuleId": { - "target": "com.amazonaws.s3#AbortRuleId", - "traits": { - "smithy.api#documentation": "

    This header is returned along with the x-amz-abort-date header. It identifies the\n applicable lifecycle configuration rule that defines the action to abort incomplete\n multipart uploads.

    ", - "smithy.api#httpHeader": "x-amz-abort-rule-id" - } - }, "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { @@ -1856,10 +1907,10 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    ID for the initiated multipart upload.

    " + "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    " } }, "RequestCharged": { @@ -1875,10 +1926,18 @@ "smithy.api#httpHeader": "x-amz-abort-date" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    " + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "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" } }, "SSEKMSKeyId": { @@ -1887,59 +1946,52 @@ "smithy.api#documentation": "

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.

    ", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } + }, + "AbortRuleId": { + "target": "com.amazonaws.s3#AbortRuleId", + "traits": { + "smithy.api#documentation": "

    This header is returned along with the x-amz-abort-date header. It identifies the\n applicable lifecycle configuration rule that defines the action to abort incomplete\n multipart uploads.

    ", + "smithy.api#httpHeader": "x-amz-abort-rule-id" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

    ID for the initiated multipart upload.

    " + } } } }, "com.amazonaws.s3#CreateMultipartUploadRequest": { "type": "structure", "members": { - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "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" + "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, - "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 object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", - "smithy.api#httpHeader": "x-amz-website-redirect-location" - } - }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable object.

    ", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "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" - } - }, - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", - "traits": { - "smithy.api#documentation": "

    The canned ACL to apply to the object.

    ", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", - "smithy.api#httpHeader": "Expires" + "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": {} } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, "SSECustomerKeyMD5": { @@ -1949,11 +2001,11 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "

    Allows grantee to read the object ACL.

    ", - "smithy.api#httpHeader": "x-amz-grant-read-acp" + "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, "Key": { @@ -1964,6 +2016,13 @@ "smithy.api#required": {} } }, + "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 encryption. All GET and PUT requests for an\n object protected by AWS KMS will fail if not made via SSL or using SigV4. For information\n about configuring using any of the officially 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" + } + }, "ObjectLockLegalHoldStatus": { "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { @@ -1971,32 +2030,38 @@ "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#httpHeader": "x-amz-request-payer" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    ", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

    Allows grantee to read the object data and its metadata.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-read" } }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "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" + "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable object.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "

    Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an\n object protected by AWS KMS will fail if not made via SSL or using SigV4. For information\n about configuring using any of the officially 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" + "smithy.api#documentation": "

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "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" } }, "ContentLanguage": { @@ -2006,81 +2071,102 @@ "smithy.api#httpHeader": "Content-Language" } }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "traits": { - "smithy.api#documentation": "

    Allows grantee to read the object data and its metadata.

    ", - "smithy.api#httpHeader": "x-amz-grant-read" + "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", + "smithy.api#httpHeader": "Cache-Control" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "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" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", "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" + "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" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

    The name of the bucket to which to initiate the upload

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", "traits": { - "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", - "smithy.api#httpHeader": "Content-Disposition" + "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" } }, "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#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" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", - "smithy.api#httpHeader": "Content-Encoding" + "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" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "

    The type of storage to use for the object. Defaults to 'STANDARD'.

    ", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", + "smithy.api#httpHeader": "Expires" } }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", "traits": { - "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "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" } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    ", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "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" } }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", "traits": { - "smithy.api#documentation": "

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "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" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.\n The 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 \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.

    ", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "smithy.api#httpHeader": "Content-Encoding" } } } @@ -2103,18 +2189,18 @@ "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 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.

    " } }, + "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 specified bucket.

    " + } + }, "Years": { "target": "com.amazonaws.s3#Years", "traits": { @@ -2155,7 +2241,7 @@ "target": "com.amazonaws.s3#DeleteBucketRequest" }, "traits": { - "smithy.api#documentation": "

    Deletes the bucket. All objects (including all object versions and delete markers) in the\n bucket must be deleted before the bucket itself can be deleted.

    \n \n

    \n Related Resources\n

    \n
      \n
    • \n

      \n \n

      \n
      • \n
    • \n

      \n \n

      \n
      • \n
    ", + "smithy.api#documentation": "

    Deletes the S3 bucket. All objects (including all object versions and delete markers) in the\n 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}", @@ -2169,7 +2255,7 @@ "target": "com.amazonaws.s3#DeleteBucketAnalyticsConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Deletes an analytics configuration for the bucket (specified by the analytics 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\n Access Permissions to Your Amazon S3 Resources.

    \n \n

    For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

    \n \n

    The following operations are related to DeleteBucketAnalyticsConfiguration:

    \n
      \n
    • \n

      \n \n

      \n
      • \n
    • \n

      \n \n

      \n
      • \n
    • \n

      \n \n

      \n
      • \n
    ", + "smithy.api#documentation": "

    Deletes an analytics configuration for the bucket (specified by the analytics 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\n Access Permissions to Your Amazon S3 Resources.

    \n \n

    For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

    \n \n

    The following operations are related to DeleteBucketAnalyticsConfiguration:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?analytics", @@ -2180,14 +2266,6 @@ "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": { @@ -2195,6 +2273,21 @@ "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" + } + }, + "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": {} + } } } }, @@ -2204,7 +2297,7 @@ "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 s3:PutBucketCORS action. \n The bucket owner has this permission by default 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#documentation": "

    Deletes the cors configuration information set for the bucket.

    \n

    To use this operation, you must have permission to perform the s3:PutBucketCORS action. \n The bucket owner has this permission by default 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", @@ -2215,6 +2308,13 @@ "com.amazonaws.s3#DeleteBucketCorsRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -2231,7 +2331,7 @@ "target": "com.amazonaws.s3#DeleteBucketEncryptionRequest" }, "traits": { - "smithy.api#documentation": "

    This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 \n 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 s3:PutEncryptionConfiguration action. The bucket owner \n has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see \n Permissions Related to \n 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#documentation": "

    This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 \n 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 s3:PutEncryptionConfiguration action. The bucket owner \n has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see \n Permissions Related to \n 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", @@ -2249,6 +2349,13 @@ "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" + } } } }, @@ -2258,7 +2365,7 @@ "target": "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Deletes an inventory configuration (identified by the inventory ID) from the bucket.

    \n

    To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n

    For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

    \n

    Operations related to DeleteBucketInventoryConfiguration include:

    \n ", + "smithy.api#documentation": "

    Deletes an inventory configuration (identified by the inventory ID) from the bucket.

    \n

    To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner 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 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", @@ -2269,12 +2376,11 @@ "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.s3#InventoryId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    The ID used to identify the inventory configuration.

    ", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} + "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" } }, "Bucket": { @@ -2284,6 +2390,14 @@ "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": {} + } } } }, @@ -2293,7 +2407,7 @@ "target": "com.amazonaws.s3#DeleteBucketLifecycleRequest" }, "traits": { - "smithy.api#documentation": "

    Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

    \n

    To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this 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 propagated to all the Amazon S3 systems.

    \n \n

    For more information about the object expiration, see Elements to Describe Lifecycle Actions.

    \n

    Related actions include:

    \n ", + "smithy.api#documentation": "

    Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

    \n

    To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this 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 propagated to all the Amazon S3 systems.

    \n \n

    For more information about the object expiration, see Elements to Describe Lifecycle Actions.

    \n

    Related actions include:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?lifecycle", @@ -2311,6 +2425,13 @@ "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" + } } } }, @@ -2320,7 +2441,7 @@ "target": "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

    \n \n

    To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.\n

    \n

    The following operations are related to\n DeleteBucketMetricsConfiguration:

    \n ", + "smithy.api#documentation": "

    Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

    \n \n

    To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.\n

    \n

    The following operations are related to\n DeleteBucketMetricsConfiguration:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?metrics", @@ -2331,12 +2452,11 @@ "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    The name of the bucket containing the metrics configuration to delete.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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" } }, "Id": { @@ -2346,24 +2466,65 @@ "smithy.api#httpQuery": "id", "smithy.api#required": {} } + }, + "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": {} + } } } }, - "com.amazonaws.s3#DeleteBucketPolicy": { + "com.amazonaws.s3#DeleteBucketOwnershipControls": { "type": "operation", "input": { - "target": "com.amazonaws.s3#DeleteBucketPolicyRequest" + "target": "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest" }, "traits": { - "smithy.api#documentation": "

    This implementation of the DELETE operation uses the policy subresource to delete the policy\n of a specified bucket. If you are using an identity other than the root user of the AWS\n 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\n 403 Access Denied error. If you have the correct permissions, but you're\n not using an identity that belongs to the bucket owner's account, Amazon S3 returns a\n 405 Method Not Allowed error.

    \n \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

    \n     \n \n \n \n

    For more information about bucket policies, see Using Bucket Policies and UserPolicies.\n

    \n

    The following operations are related to DeleteBucketPolicy\n

    \n ", + "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}?policy", + "uri": "/{Bucket}?ownershipControls", "code": 204 } } }, - "com.amazonaws.s3#DeleteBucketPolicyRequest": { + "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest": { + "type": "structure", + "members": { + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "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": {} + } + } + } + }, + "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 policy\n of a specified bucket. If you are using an identity other than the root user of the AWS\n 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\n 403 Access Denied error. If you have the correct permissions, but you're\n not using an identity that belongs to the bucket owner's account, Amazon S3 returns a\n 405 Method Not Allowed error.

    \n \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

    \n     \n \n \n \n

    For more information about bucket policies, see Using Bucket Policies and UserPolicies.\n

    \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": { @@ -2373,6 +2534,13 @@ "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" + } } } }, @@ -2382,7 +2550,7 @@ "target": "com.amazonaws.s3#DeleteBucketReplicationRequest" }, "traits": { - "smithy.api#documentation": "

    \n Deletes the replication configuration from the bucket.

    \n

    To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

    \n \n

    It can take a while for the deletion of a replication configuration to fully propagate.

    \n     \n \n

    For information about replication configuration, see Replication in the Amazon S3 Developer Guide. \n

    \n \n

    The following operations are related to DeleteBucketReplication:

    \n ", + "smithy.api#documentation": "

    \n Deletes the replication configuration from the bucket.

    \n

    To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

    \n \n

    It can take a while for the deletion of a replication configuration to fully propagate.

    \n     \n \n

    For information about replication configuration, see Replication in the Amazon S3 Developer Guide. \n

    \n \n

    The following operations are related to DeleteBucketReplication:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?replication", @@ -2400,12 +2568,26 @@ "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": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -2422,7 +2604,7 @@ "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 s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. \n

    \n

    The following operations are related to DeleteBucketTagging:

    \n ", + "smithy.api#documentation": "

    Deletes the tags from the bucket.

    \n \n

    To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others. \n

    \n

    The following operations are related to DeleteBucketTagging:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?tagging", @@ -2433,6 +2615,13 @@ "com.amazonaws.s3#DeleteBucketTaggingRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -2449,7 +2638,7 @@ "target": "com.amazonaws.s3#DeleteBucketWebsiteRequest" }, "traits": { - "smithy.api#documentation": "

    This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

    \n \n

    This DELETE operation requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

    \n \n

    For more information about hosting websites, see Hosting Websites on Amazon S3.\n

    \n \n

    The following operations are related to DeleteBucketWebsite:

    \n ", + "smithy.api#documentation": "

    This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

    \n \n

    This DELETE operation requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

    \n \n

    For more information about hosting websites, see Hosting Websites on Amazon S3.\n

    \n \n

    The following operations are related to DeleteBucketWebsite:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?website", @@ -2460,6 +2649,13 @@ "com.amazonaws.s3#DeleteBucketWebsiteRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -2488,10 +2684,10 @@ "smithy.api#documentation": "

    Date and time the object was last modified.

    " } }, - "Owner": { - "target": "com.amazonaws.s3#Owner", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    The account that created the delete marker.>

    " + "smithy.api#documentation": "

    The object key.

    " } }, "IsLatest": { @@ -2500,10 +2696,10 @@ "smithy.api#documentation": "

    Specifies whether the object is (true) or is not (false) the latest version of an object.

    " } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Owner": { + "target": "com.amazonaws.s3#Owner", "traits": { - "smithy.api#documentation": "

    The object key.

    " + "smithy.api#documentation": "

    The account that created the delete marker.>

    " } } }, @@ -2556,7 +2752,7 @@ "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, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does 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 enable Amazon S3 to remove them for\n you. If you want to block users or accounts from removing or deleting objects from your\n 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#documentation": "

    Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does 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 enable Amazon S3 to remove them for\n you. If you want to block users or accounts from removing or deleting objects from your\n 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", @@ -2567,11 +2763,11 @@ "com.amazonaws.s3#DeleteObjectOutput": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#documentation": "

    Returns the version ID of the delete marker created as a result of the DELETE operation.

    ", - "smithy.api#httpHeader": "x-amz-version-id" + "smithy.api#documentation": "

    Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

    ", + "smithy.api#httpHeader": "x-amz-delete-marker" } }, "RequestCharged": { @@ -2580,11 +2776,11 @@ "smithy.api#httpHeader": "x-amz-request-charged" } }, - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "

    Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

    ", - "smithy.api#httpHeader": "x-amz-delete-marker" + "smithy.api#documentation": "

    Returns the version ID of the delete marker created as a result of the DELETE operation.

    ", + "smithy.api#httpHeader": "x-amz-version-id" } } } @@ -2592,6 +2788,28 @@ "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": {} + } + }, + "MFA": { + "target": "com.amazonaws.s3#MFA", + "traits": { + "smithy.api#documentation": "

    The concatenation of the authentication device's serial number, a space, and the value that is\n displayed on your authentication device. Required to permanently delete a versioned object\n if versioning is configured with MFA delete enabled.

    ", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "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" + } + }, "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { @@ -2607,19 +2825,6 @@ "smithy.api#required": {} } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "MFA": { - "target": "com.amazonaws.s3#MFA", - "traits": { - "smithy.api#documentation": "

    The concatenation of the authentication device's serial number, a space, and the value that is\n displayed on your authentication device. Required to permanently delete a versioned object\n if versioning is configured with MFA delete enabled.

    ", - "smithy.api#httpHeader": "x-amz-mfa" - } - }, "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { @@ -2627,12 +2832,10 @@ "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "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 using 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": {} + "smithy.api#httpHeader": "x-amz-request-payer" } } } @@ -2646,7 +2849,7 @@ "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 \n Object 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#documentation": "

    Removes the entire tag set from the specified object. For more information about \n managing object tags, see \n Object 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", @@ -2669,27 +2872,34 @@ "com.amazonaws.s3#DeleteObjectTaggingRequest": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The versionId of the object that the tag-set will be removed from.

    ", - "smithy.api#httpQuery": "versionId" + "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 tag.

    ", + "smithy.api#documentation": "

    Name of the object key.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "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 using 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": {} + "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" + } + }, + "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" } } } @@ -2703,7 +2913,7 @@ "target": "com.amazonaws.s3#DeleteObjectsOutput" }, "traits": { - "smithy.api#documentation": "

    This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request 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\n the 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 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#documentation": "

    This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request 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\n the 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 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", @@ -2715,6 +2925,14 @@ "com.amazonaws.s3#DeleteObjectsOutput": { "type": "structure", "members": { + "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 delete and the error it encountered.

    ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Error" + } + }, "Deleted": { "target": "com.amazonaws.s3#DeletedObjects", "traits": { @@ -2727,24 +2945,17 @@ "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 delete and the error it encountered.

    ", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Error" - } } } }, "com.amazonaws.s3#DeleteObjectsRequest": { "type": "structure", "members": { - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "MFA": { + "target": "com.amazonaws.s3#MFA", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "

    The concatenation of the authentication device's serial number, a space, and the value that is\n displayed on your authentication device. Required to permanently delete a versioned object\n if versioning is configured with MFA delete enabled.

    ", + "smithy.api#httpHeader": "x-amz-mfa" } }, "BypassGovernanceRetention": { @@ -2754,27 +2965,33 @@ "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } }, - "Delete": { - "target": "com.amazonaws.s3#Delete", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Container for the request.

    ", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "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" } }, "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 using 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#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": {} } }, - "MFA": { - "target": "com.amazonaws.s3#MFA", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "

    The concatenation of the authentication device's serial number, a space, and the value that is\n displayed on your authentication device. Required to permanently delete a versioned object\n if versioning is configured with MFA delete enabled.

    ", - "smithy.api#httpHeader": "x-amz-mfa" + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Delete": { + "target": "com.amazonaws.s3#Delete", + "traits": { + "smithy.api#documentation": "

    Container for the request.

    ", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } } } @@ -2785,7 +3002,7 @@ "target": "com.amazonaws.s3#DeletePublicAccessBlockRequest" }, "traits": { - "smithy.api#documentation": "

    Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

    \n \n

    The following operations are related to DeletePublicAccessBlock:

    \n ", + "smithy.api#documentation": "

    Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

    \n \n

    The following operations are related to DeletePublicAccessBlock:

    \n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?publicAccessBlock", @@ -2796,6 +3013,13 @@ "com.amazonaws.s3#DeletePublicAccessBlockRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -2809,29 +3033,29 @@ "com.amazonaws.s3#DeletedObject": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

    The name of the deleted object.

    " - } - }, - "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 delete a specific object version, the value returned by this header is the version ID of the object version deleted.

    " - } - }, "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { "smithy.api#documentation": "

    Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.

    " } }, + "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.

    " } + }, + "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 delete a specific object version, the value returned by this header is the version ID of the object version deleted.

    " + } } }, "traits": { @@ -2853,22 +3077,17 @@ "com.amazonaws.s3#Destination": { "type": "structure", "members": { - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

    \n The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.\n

    \n

    For valid values, see the StorageClass element of the\n PUT Bucket\n replication action in the Amazon Simple Storage Service API Reference.

    " - } - }, - "Metrics": { - "target": "com.amazonaws.s3#Metrics", + "EncryptionConfiguration": { + "target": "com.amazonaws.s3#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

    \n A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). \n Must be specified together with a ReplicationTime block.\n

    " + "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", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    \n A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. \n Must be specified together with a Metrics block.\n

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

    ", + "smithy.api#required": {} } }, "Account": { @@ -2877,17 +3096,16 @@ "smithy.api#documentation": "

    Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3\n to change replica ownership to the AWS account that owns the destination bucket by\n specifying the AccessControlTranslation property, this is the account ID of\n the destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon Simple Storage\n Service Developer Guide.

    " } }, - "EncryptionConfiguration": { - "target": "com.amazonaws.s3#EncryptionConfiguration", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

    A container that provides information about encryption. If\n SourceSelectionCriteria is specified, you must specify this element.

    " + "smithy.api#documentation": "

    \n The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.\n

    \n

    For valid values, see the StorageClass element of the\n PUT Bucket\n replication action in the Amazon Simple Storage Service API Reference.

    " } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Metrics": { + "target": "com.amazonaws.s3#Metrics", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    \n A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). \n Must be specified together with a ReplicationTime block.\n

    " } }, "AccessControlTranslation": { @@ -2895,6 +3113,12 @@ "traits": { "smithy.api#documentation": "

    Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.

    " } + }, + "ReplicationTime": { + "target": "com.amazonaws.s3#ReplicationTime", + "traits": { + "smithy.api#documentation": "

    \n A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. \n Must be specified together with a Metrics block.\n

    " + } } }, "traits": { @@ -2927,22 +3151,22 @@ "com.amazonaws.s3#Encryption": { "type": "structure", "members": { - "KMSContext": { - "target": "com.amazonaws.s3#KMSContext", - "traits": { - "smithy.api#documentation": "

    If the encryption type is aws:kms, this optional value can be used to specify the\n encryption context for the restore results.

    " - } - }, "KMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { "smithy.api#documentation": "

    If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK\n to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

    " } }, - "EncryptionType": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "KMSContext": { + "target": "com.amazonaws.s3#KMSContext", "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#documentation": "

    If the encryption type is aws:kms, this optional value can be used to specify the\n encryption context for the restore results.

    " + } + }, + "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": {} } } @@ -2978,10 +3202,10 @@ "com.amazonaws.s3#Error": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Message": { + "target": "com.amazonaws.s3#Message", "traits": { - "smithy.api#documentation": "

    The error key.

    " + "smithy.api#documentation": "

    The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.

    " } }, "Code": { @@ -2990,10 +3214,10 @@ "smithy.api#documentation": "

    The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.

    \n

    \n Amazon S3 error codes\n

    \n
      \n
    • \n
        \n
      • \n

        \n Code: AccessDenied

        \n
        • \n
      • \n

        \n Description: Access Denied

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: AccountProblem

        \n
        • \n
      • \n

        \n Description: There is a problem with your AWS account that prevents the operation\n\t\t\t\t\t\t\tfrom completing successfully. \n\t\t\t\t\t\t\tContact AWS Support for further assistance.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: AllAccessDisabled

        \n
        • \n
      • \n

        \n Description: All access to this Amazon S3 resource has been disabled. \n\t\t\t\t\t\t\tContact AWS Support for further assistance.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: AmbiguousGrantByEmailAddress

        \n
        • \n
      • \n

        \n Description: The email address you provided is associated with more than one\n\t\t\t\t\t\t\taccount.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: AuthorizationHeaderMalformed

        \n\t\t\t\t\t\t
        • \n
      • \n

        \n Description: The authorization header you provided is invalid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n HTTP Status Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: BadDigest

        \n
        • \n
      • \n

        \n Description: The Content-MD5 you specified did not match what we received.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: BucketAlreadyExists

        \n
        • \n
      • \n

        \n Description: The requested bucket name is not available. The bucket namespace is\n\t\t\t\t\t\t\tshared by all users of the system. Please select a different name and\n\t\t\t\t\t\t\ttry again.

        \n
        • \n
      • \n

        \n HTTP Status Code: 409 Conflict

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: BucketAlreadyOwnedByYou

        \n
        • \n
      • \n

        \n Description: The bucket you tried to create already exists, and you own\n it. Amazon S3 returns this error in all AWS Regions except in the North Virginia\n Region. For legacy compatibility, if you re-create an existing bucket that you\n already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the\n bucket access control lists (ACLs).

        \n
        • \n
      • \n

        \n Code: 409 Conflict (in all Regions except the North Virginia Region)

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: BucketNotEmpty

        \n
        • \n
      • \n

        \n Description: The bucket you tried to delete is not empty.

        \n
        • \n
      • \n

        \n HTTP Status Code: 409 Conflict

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: CredentialsNotSupported

        \n
        • \n
      • \n

        \n Description: This request does not support credentials.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: CrossLocationLoggingProhibited

        \n
        • \n
      • \n

        \n Description: Cross-location logging not allowed. Buckets in one geographic\n\t\t\t\t\t\t\tlocation cannot log information to a bucket in another location.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: EntityTooSmall

        \n
        • \n
      • \n

        \n Description: Your proposed upload is smaller than the minimum allowed object\n\t\t\t\t\t\t\tsize.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: EntityTooLarge

        \n
        • \n
      • \n

        \n Description: Your proposed upload exceeds the maximum allowed object size.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: ExpiredToken

        \n
        • \n
      • \n

        \n Description: The provided token has expired.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: IllegalVersioningConfigurationException

        \n
        • \n
      • \n

        \n Description: Indicates that the versioning configuration specified in the request\n\t\t\t\t\t\t\tis invalid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: IncompleteBody

        \n
        • \n
      • \n

        \n Description: You did not provide the number of bytes specified by the\n\t\t\t\t\t\t\tContent-Length HTTP header

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: IncorrectNumberOfFilesInPostRequest

        \n
        • \n
      • \n

        \n Description: POST requires exactly one file upload per request.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InlineDataTooLarge

        \n
        • \n
      • \n

        \n Description: Inline data exceeds the maximum allowed size.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InternalError

        \n
        • \n
      • \n

        \n Description: We encountered an internal error. Please try again.

        \n
        • \n
      • \n

        \n HTTP Status Code: 500 Internal Server Error

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Server

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidAccessKeyId

        \n
        • \n
      • \n

        \n Description: The AWS access key ID you provided does not exist in our records.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidAddressingHeader

        \n
        • \n
      • \n

        \n Description: You must specify the Anonymous role.

        \n
        • \n
      • \n

        \n HTTP Status Code: N/A

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidArgument

        \n
        • \n
      • \n

        \n Description: Invalid Argument

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidBucketName

        \n
        • \n
      • \n

        \n Description: The specified bucket is not valid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidBucketState

        \n
        • \n
      • \n

        \n Description: The request is not valid with the current state of the bucket.

        \n
        • \n
      • \n

        \n HTTP Status Code: 409 Conflict

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidDigest

        \n
        • \n
      • \n

        \n Description: The Content-MD5 you specified is not valid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidEncryptionAlgorithmError

        \n
        • \n
      • \n

        \n Description: The encryption request you specified is not valid. The valid value is AES256.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidLocationConstraint

        \n
        • \n
      • \n

        \n Description: The specified location constraint is not valid. For more information about Regions, see\n\t\t\t\t\t\t\t\tHow to\n\t\t\t\t\t\t\t\tSelect a Region for Your Buckets.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidObjectState

        \n
        • \n
      • \n

        \n Description: The operation is not valid for the current state of the object.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidPart

        \n
        • \n
      • \n

        \n Description: One or more of the specified parts could not be found. The part might not have been\n\t\t\t\t\t\t\tuploaded, or the specified entity tag might not have matched the part's\n\t\t\t\t\t\t\tentity tag.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidPartOrder

        \n
        • \n
      • \n

        \n Description: The list of parts was not in ascending order. Parts list must be specified in order by\n\t\t\t\t\t\t\tpart number.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidPayer

        \n
        • \n
      • \n

        \n Description: All access to this object has been disabled. \n\t\t\t\t\t\t\tPlease contact AWS Support for further assistance.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidPolicyDocument

        \n
        • \n
      • \n

        \n Description: The content of the form does not meet the conditions specified in the\n\t\t\t\t\t\t\tpolicy document.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRange

        \n
        • \n
      • \n

        \n Description: The requested range cannot be satisfied.

        \n
        • \n
      • \n

        \n HTTP Status Code: 416 Requested Range Not Satisfiable

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Please use AWS4-HMAC-SHA256.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: SOAP requests must be made over an HTTPS connection.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant\n\t\t\t\t\t\t\tnames.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their\n\t\t\t\t\t\t\tnames.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Amazon S3 Transfer Accelerate is not configured on this bucket.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Amazon S3 Transfer Accelerate is disabled on this bucket.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact AWS Support for\n\t\t\t\t\t\t\tmore information.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest

        \n
        • \n
      • \n

        \n Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact AWS Support for\n\t\t\t\t\t\t\tmore information.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n Code: N/A

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidSecurity

        \n
        • \n
      • \n

        \n Description: The provided security credentials are not valid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidSOAPRequest

        \n
        • \n
      • \n

        \n Description: The SOAP request body is invalid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidStorageClass

        \n
        • \n
      • \n

        \n Description: The storage class you specified is not valid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidTargetBucketForLogging

        \n
        • \n
      • \n

        \n Description: The target bucket for logging does not exist, is not owned by you, or\n\t\t\t\t\t\t\tdoes not have the appropriate grants for the log-delivery group.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidToken

        \n
        • \n
      • \n

        \n Description: The provided token is malformed or otherwise invalid.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidURI

        \n
        • \n
      • \n

        \n Description: Couldn't parse the specified URI.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: KeyTooLongError

        \n
        • \n
      • \n

        \n Description: Your key is too long.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MalformedACLError

        \n
        • \n
      • \n

        \n Description: The XML you provided was not well-formed or did not validate against\n\t\t\t\t\t\t\tour published schema.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MalformedPOSTRequest

        \n
        • \n
      • \n

        \n Description: The body of your POST request is not well-formed\n\t\t\t\t\t\t\tmultipart/form-data.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MalformedXML

        \n
        • \n
      • \n

        \n Description: This happens when the user sends malformed XML (XML that doesn't conform to the\n\t\t\t\t\t\t\tpublished XSD) for the configuration. The error message is, \"The XML you\n\t\t\t\t\t\t\tprovided was not well-formed or did not validate against our published\n\t\t\t\t\t\t\tschema.\"

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MaxMessageLengthExceeded

        \n
        • \n
      • \n

        \n Description: Your request was too big.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MaxPostPreDataLengthExceededError

        \n
        • \n
      • \n

        \n Description: Your POST request fields preceding the upload file were too\n\t\t\t\t\t\t\tlarge.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MetadataTooLarge

        \n
        • \n
      • \n

        \n Description: Your metadata headers exceed the maximum allowed metadata\n\t\t\t\t\t\t\tsize.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MethodNotAllowed

        \n
        • \n
      • \n

        \n Description: The specified method is not allowed against this resource.

        \n
        • \n
      • \n

        \n HTTP Status Code: 405 Method Not Allowed

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MissingAttachment

        \n
        • \n
      • \n

        \n Description: A SOAP attachment was expected, but none were found.

        \n
        • \n
      • \n

        \n HTTP Status Code: N/A

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MissingContentLength

        \n
        • \n
      • \n

        \n Description: You must provide the Content-Length HTTP header.

        \n
        • \n
      • \n

        \n HTTP Status Code: 411 Length Required

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MissingRequestBodyError

        \n
        • \n
      • \n

        \n Description: This happens when the user sends an empty XML document as a request. The error message\n\t\t\t\t\t\t\tis, \"Request body is empty.\"

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MissingSecurityElement

        \n
        • \n
      • \n

        \n Description: The SOAP 1.1 request is missing a security element.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MissingSecurityHeader

        \n
        • \n
      • \n

        \n Description: Your request is missing a required header.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NoLoggingStatusForKey

        \n
        • \n
      • \n

        \n Description: There is no such thing as a logging status subresource for a\n\t\t\t\t\t\t\tkey.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NoSuchBucket

        \n
        • \n
      • \n

        \n Description: The specified bucket does not exist.

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NoSuchBucketPolicy

        \n
        • \n
      • \n

        \n Description: The specified bucket does not have a bucket policy.

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NoSuchKey

        \n
        • \n
      • \n

        \n Description: The specified key does not exist.

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NoSuchLifecycleConfiguration

        \n
        • \n
      • \n

        \n Description: The lifecycle configuration does not exist.

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NoSuchUpload

        \n
        • \n
      • \n

        \n Description: The specified multipart upload does not exist. The upload ID might be invalid, or the\n\t\t\t\t\t\t\tmultipart upload might have been aborted or completed.

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NoSuchVersion

        \n
        • \n
      • \n

        \n Description: Indicates that the version ID specified in the request does not match\n\t\t\t\t\t\t\tan existing version.

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NotImplemented

        \n
        • \n
      • \n

        \n Description: A header you provided implies functionality that is not\n\t\t\t\t\t\t\timplemented.

        \n
        • \n
      • \n

        \n HTTP Status Code: 501 Not Implemented

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Server

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: NotSignedUp

        \n
        • \n
      • \n

        \n Description: Your account is not signed up for the Amazon S3 service. You must sign up\n\t\t\t\t\t\t\tbefore you can use Amazon S3. You can sign up at the following URL:\n\t\t\t\t\t\t\thttps://aws.amazon.com/s3

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: OperationAborted

        \n
        • \n
      • \n

        \n Description: A conflicting conditional operation is currently in progress against\n\t\t\t\t\t\t\tthis resource. Try again.

        \n
        • \n
      • \n

        \n HTTP Status Code: 409 Conflict

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: PermanentRedirect

        \n
        • \n
      • \n

        \n Description: The bucket you are attempting to access must be addressed using the\n\t\t\t\t\t\t\tspecified endpoint. Send all future requests to this\n\t\t\t\t\t\t\tendpoint.

        \n
        • \n
      • \n

        \n HTTP Status Code: 301 Moved Permanently

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: PreconditionFailed

        \n
        • \n
      • \n

        \n Description: At least one of the preconditions you specified did not hold.

        \n
        • \n
      • \n

        \n HTTP Status Code: 412 Precondition Failed

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: Redirect

        \n
        • \n
      • \n

        \n Description: Temporary redirect.

        \n
        • \n
      • \n

        \n HTTP Status Code: 307 Moved Temporarily

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: RestoreAlreadyInProgress

        \n
        • \n
      • \n

        \n Description: Object restore is already in progress.

        \n
        • \n
      • \n

        \n HTTP Status Code: 409 Conflict

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: RequestIsNotMultiPartContent

        \n
        • \n
      • \n

        \n Description: Bucket POST must be of the enclosure-type\n\t\t\t\t\t\t\tmultipart/form-data.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: RequestTimeout

        \n
        • \n
      • \n

        \n Description: Your socket connection to the server was not read from or written to\n\t\t\t\t\t\t\twithin the timeout period.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: RequestTimeTooSkewed

        \n
        • \n
      • \n

        \n Description: The difference between the request time and the server's time is too\n\t\t\t\t\t\t\tlarge.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: RequestTorrentOfBucketError

        \n
        • \n
      • \n

        \n Description: Requesting the torrent file of a bucket is not permitted.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: SignatureDoesNotMatch

        \n
        • \n
      • \n

        \n Description: The request signature we calculated does not match the signature you\n\t\t\t\t\t\t\tprovided. Check your AWS secret access key and signing method. For more\n\t\t\t\t\t\t\tinformation, see REST Authentication and SOAP Authentication for details.

        \n
        • \n
      • \n

        \n HTTP Status Code: 403 Forbidden

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: ServiceUnavailable

        \n
        • \n
      • \n

        \n Description: Reduce your request rate.

        \n
        • \n
      • \n

        \n HTTP Status Code: 503 Service Unavailable

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Server

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: SlowDown

        \n
        • \n
      • \n

        \n Description: Reduce your request rate.

        \n
        • \n
      • \n

        \n HTTP Status Code: 503 Slow Down

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Server

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: TemporaryRedirect

        \n
        • \n
      • \n

        \n Description: You are being redirected to the bucket while DNS updates.

        \n
        • \n
      • \n

        \n HTTP Status Code: 307 Moved Temporarily

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: TokenRefreshRequired

        \n
        • \n
      • \n

        \n Description: The provided token must be refreshed.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: TooManyBuckets

        \n
        • \n
      • \n

        \n Description: You have attempted to create more buckets than allowed.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: UnexpectedContent

        \n
        • \n
      • \n

        \n Description: This request does not support content.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: UnresolvableGrantByEmailAddress

        \n
        • \n
      • \n

        \n Description: The email address you provided does not match any account on\n\t\t\t\t\t\t\trecord.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: UserKeyMustBeSpecified

        \n
        • \n
      • \n

        \n Description: The bucket POST must contain the specified field name. If it is\n\t\t\t\t\t\t\tspecified, check the order of the fields.

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    \n

    " } }, - "Message": { - "target": "com.amazonaws.s3#Message", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.

    " + "smithy.api#documentation": "

    The error key.

    " } }, "VersionId": { @@ -3244,7 +3468,7 @@ "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput" }, "traits": { - "smithy.api#documentation": "

    This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration \n state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level \n feature that 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 Suspended by using \n the PutBucketAccelerateConfiguration operation.

    \n

    A GET accelerate request does not return a state value for a bucket that has\n no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has\n 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#documentation": "

    This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration \n state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level \n feature that 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 Suspended by using \n the PutBucketAccelerateConfiguration operation.

    \n

    A GET accelerate request does not return a state value for a bucket that has\n no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has\n 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", @@ -3266,10 +3490,17 @@ "com.amazonaws.s3#GetBucketAccelerateConfigurationRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Name of the bucket for which the accelerate configuration is retrieved.

    ", + "smithy.api#documentation": "

    The name of the bucket for which the accelerate configuration is retrieved.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3285,7 +3516,7 @@ "target": "com.amazonaws.s3#GetBucketAclOutput" }, "traits": { - "smithy.api#documentation": "

    This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket. \n To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP \n permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

    \n \n

    \n Related Resources\n

    \n
      \n
    • \n

      \n \n

      \n
      • \n
    ", + "smithy.api#documentation": "

    This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket. \n To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP \n permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

    \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?acl", @@ -3296,24 +3527,31 @@ "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" } - }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

    Container for the bucket owner's display name and ID.

    " - } } } }, "com.amazonaws.s3#GetBucketAclRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3333,7 +3571,7 @@ "target": "com.amazonaws.s3#GetBucketAnalyticsConfigurationOutput" }, "traits": { - "smithy.api#documentation": "

    This implementation of the GET operation returns an analytics configuration (identified by\n 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\n permission by default. The bucket owner can grant this permission to others. For more\n 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

    For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the\n Amazon Simple Storage Service Developer Guide.

    \n \n

    \n Related Resources\n

    \n
      \n
    • \n

      \n \n

      \n
      • \n
    • \n

      \n \n

      \n
      • \n
    • \n

      \n \n

      \n
      • \n
    ", + "smithy.api#documentation": "

    This implementation of the GET operation returns an analytics configuration (identified by\n 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\n permission by default. The bucket owner can grant this permission to others. For more\n 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

    For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the\n Amazon Simple Storage Service Developer Guide.

    \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?analytics&x-id=GetBucketAnalyticsConfiguration", @@ -3356,6 +3594,13 @@ "com.amazonaws.s3#GetBucketAnalyticsConfigurationRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3383,7 +3628,7 @@ "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. By default, the bucket owner has this permission and can grant it to others.

    \n \n

    For more information about cors, see Enabling Cross-Origin\n Resource Sharing.

    \n \n

    The following operations are related to GetBucketCors:

    \n ", + "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. By default, the bucket owner has this permission and can grant it to others.

    \n \n

    For more information about cors, see Enabling Cross-Origin\n Resource Sharing.

    \n \n

    The following operations are related to GetBucketCors:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?cors", @@ -3414,6 +3659,13 @@ "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" + } } } }, @@ -3426,7 +3678,7 @@ "target": "com.amazonaws.s3#GetBucketEncryptionOutput" }, "traits": { - "smithy.api#documentation": "

    Returns the default encryption configuration for an Amazon S3 bucket. For information about 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 s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n

    The following operations are related to GetBucketEncryption:

    \n ", + "smithy.api#documentation": "

    Returns the default encryption configuration for an Amazon S3 bucket. For information about 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 s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n

    The following operations are related to GetBucketEncryption:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?encryption", @@ -3448,6 +3700,13 @@ "com.amazonaws.s3#GetBucketEncryptionRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3467,7 +3726,7 @@ "target": "com.amazonaws.s3#GetBucketInventoryConfigurationOutput" }, "traits": { - "smithy.api#documentation": "

    Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default 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 Resources.

    \n \n

    For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

    \n \n

    The following operations are related to GetBucketInventoryConfiguration:

    \n ", + "smithy.api#documentation": "

    Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default 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 Resources.

    \n \n

    For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

    \n \n

    The following operations are related to GetBucketInventoryConfiguration:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?inventory&x-id=GetBucketInventoryConfiguration", @@ -3490,12 +3749,11 @@ "com.amazonaws.s3#GetBucketInventoryConfigurationRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.s3#InventoryId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    The ID used to identify the inventory configuration.

    ", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} + "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" } }, "Bucket": { @@ -3505,6 +3763,14 @@ "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": {} + } } } }, @@ -3517,7 +3783,7 @@ "target": "com.amazonaws.s3#GetBucketLifecycleConfigurationOutput" }, "traits": { - "smithy.api#documentation": "\n

    Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are still using previous version of the lifecycle configuration, it works. For the earlier API description, see GetBucketLifecycle.

    \n     \n \n

    Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

    \n \n

    To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner 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 Resources.

    \n \n

    \n GetBucketLifecycleConfiguration has the following special error:

    \n
      \n
    • \n

      Error code: NoSuchLifecycleConfiguration\n

      \n
        \n
      • \n

        Description: The lifecycle configuration does not exist.

        \n
        • \n
      • \n

        HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    \n

    The following operations are related to GetBucketLifecycleConfiguration:

    \n ", + "smithy.api#documentation": "\n

    Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key\n name prefix, one or more object tags, or a combination of both. Accordingly, this\n section describes the latest API. The response describes the new filter element that you\n can use to specify a filter to select a subset of objects to which the rule applies. If\n you are using a previous version of the lifecycle configuration, it still works. For the\n earlier API description, see GetBucketLifecycle.

    \n     \n

    Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, \n see Object Lifecycle Management.

    \n \n

    To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner 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 Resources.

    \n \n

    \n GetBucketLifecycleConfiguration has the following special error:

    \n
      \n
    • \n

      Error code: NoSuchLifecycleConfiguration\n

      \n
        \n
      • \n

        Description: The lifecycle configuration does not exist.

        \n
        • \n
      • \n

        HTTP Status Code: 404 Not Found

        \n
        • \n
      • \n

        SOAP Fault Code Prefix: Client

        \n
        • \n
      \n
      • \n
    \n

    The following operations are related to GetBucketLifecycleConfiguration:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?lifecycle", @@ -3548,6 +3814,13 @@ "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" + } } } }, @@ -3560,7 +3833,7 @@ "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#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", @@ -3582,6 +3855,13 @@ "com.amazonaws.s3#GetBucketLocationRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3601,7 +3881,7 @@ "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 that status. To use GET, you must be the bucket owner.

    \n \n

    The following operations are related to GetBucketLogging:

    \n ", + "smithy.api#documentation": "

    Returns the logging status of a bucket and the permissions users have to view and modify 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", @@ -3627,6 +3907,13 @@ "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" + } } } }, @@ -3639,7 +3926,7 @@ "target": "com.amazonaws.s3#GetBucketMetricsConfigurationOutput" }, "traits": { - "smithy.api#documentation": "

    Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

    \n \n

    The following operations are related to GetBucketMetricsConfiguration:

    \n ", + "smithy.api#documentation": "

    Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

    \n \n

    The following operations are related to GetBucketMetricsConfiguration:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?metrics&x-id=GetBucketMetricsConfiguration", @@ -3662,6 +3949,13 @@ "com.amazonaws.s3#GetBucketMetricsConfigurationRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3689,7 +3983,7 @@ "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 NotificationConfiguration element.

    \n \n

    By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

    \n \n

    For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

    \n \n

    The following operation is related to GetBucketNotification:

    \n ", + "smithy.api#documentation": "

    Returns the notification configuration of a bucket.

    \n

    If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration element.

    \n \n

    By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

    \n \n

    For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of 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", @@ -3698,15 +3992,70 @@ } }, "com.amazonaws.s3#GetBucketNotificationConfigurationRequest": { + "type": "structure", + "members": { + "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" + } + }, + "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": {} + } + } + } + }, + "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": "

    Name of the bucket for which to get the notification configuration.

    ", + "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#httpHeader": "x-amz-expected-bucket-owner" + } } } }, @@ -3719,7 +4068,7 @@ "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 root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

    \n \n

    If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

    \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

    \n     \n \n

    For more information about bucket policies, see Using Bucket Policies and User Policies.

    \n \n

    The following operation is related to GetBucketPolicy:

    \n ", + "smithy.api#documentation": "

    Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

    \n \n

    If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

    \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

    \n     \n \n

    For more information about bucket policies, see Using Bucket Policies and User Policies.

    \n \n

    The following operation is related to GetBucketPolicy:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?policy", @@ -3748,6 +4097,13 @@ "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" + } } } }, @@ -3760,7 +4116,7 @@ "target": "com.amazonaws.s3#GetBucketPolicyStatusOutput" }, "traits": { - "smithy.api#documentation": "

    Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a 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#documentation": "

    Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a 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", @@ -3783,6 +4139,13 @@ "com.amazonaws.s3#GetBucketPolicyStatusRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3802,7 +4165,7 @@ "target": "com.amazonaws.s3#GetBucketReplicationOutput" }, "traits": { - "smithy.api#documentation": "

    Returns the replication configuration of a bucket.

    \n \n

    \n It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, \n a get request soon after put or delete can return a wrong result.\n

    \n     \n

    For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.

    \n \n

    This operation requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

    \n \n

    If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

    \n \n

    For information about GetBucketReplication errors, see ReplicationErrorCodeList\n

    \n \n \n

    The following operations are related to GetBucketReplication:

    \n ", + "smithy.api#documentation": "

    Returns the replication configuration of a bucket.

    \n \n

    \n It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, \n a get request soon after put or delete can return a wrong result.\n

    \n     \n

    For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.

    \n \n

    This operation requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

    \n \n

    If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

    \n \n

    For information about GetBucketReplication errors, see List of replication-related error codes\n

    \n \n \n

    The following operations are related to GetBucketReplication:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?replication", @@ -3824,6 +4187,13 @@ "com.amazonaws.s3#GetBucketReplicationRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3843,7 +4213,7 @@ "target": "com.amazonaws.s3#GetBucketRequestPaymentOutput" }, "traits": { - "smithy.api#documentation": "

    Returns the request payment configuration of a bucket. \n To use this version of the operation, you must be the bucket owner. For more information, see \n Requester Pays Buckets.

    \n \n

    The following operations are related to GetBucketRequestPayment:

    \n ", + "smithy.api#documentation": "

    Returns the request payment configuration of a bucket. \n To use this version of the operation, you must be the bucket owner. For more information, see \n Requester Pays Buckets.

    \n \n

    The following operations are related to GetBucketRequestPayment:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?requestPayment", @@ -3872,6 +4242,13 @@ "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" + } } } }, @@ -3884,7 +4261,7 @@ "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 s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

    \n \n

    \n GetBucketTagging has the following special error:

    \n
      \n
    • \n

      Error code: NoSuchTagSetError\n

      \n
        \n
      • \n

        Description: There is no tag set associated with the bucket.

        \n
        • \n
      \n
      • \n
    \n \n

    The following operations are related to GetBucketTagging:

    \n ", + "smithy.api#documentation": "

    Returns the tag set associated with the bucket.

    \n

    To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

    \n \n

    \n GetBucketTagging has the following special error:

    \n
      \n
    • \n

      Error code: NoSuchTagSetError\n

      \n
        \n
      • \n

        Description: There is no tag set associated with the bucket.

        \n
        • \n
      \n
      • \n
    \n \n

    The following operations are related to GetBucketTagging:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?tagging", @@ -3907,6 +4284,13 @@ "com.amazonaws.s3#GetBucketTaggingRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3926,7 +4310,7 @@ "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#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", @@ -3937,24 +4321,31 @@ "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 element is only returned if the bucket has been configured with MFA delete. If the bucket 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.

    " - } } } }, "com.amazonaws.s3#GetBucketVersioningRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -3974,7 +4365,7 @@ "target": "com.amazonaws.s3#GetBucketWebsiteOutput" }, "traits": { - "smithy.api#documentation": "

    Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.\n

    \n

    This GET operation requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

    \n

    The following operations are related to DeleteBucketWebsite:

    \n ", + "smithy.api#documentation": "

    Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.\n

    \n

    This GET operation requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

    \n

    The following operations are related to DeleteBucketWebsite:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?website", @@ -3985,22 +4376,16 @@ "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 bucket.

    " - } - }, "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.

    " } }, - "IndexDocument": { - "target": "com.amazonaws.s3#IndexDocument", + "RedirectAllRequestsTo": { + "target": "com.amazonaws.s3#RedirectAllRequestsTo", "traits": { - "smithy.api#documentation": "

    The name of the index document for the website (for example index.html).

    " + "smithy.api#documentation": "

    Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

    " } }, "RoutingRules": { @@ -4008,12 +4393,25 @@ "traits": { "smithy.api#documentation": "

    Rules that define when a redirect is applied and the redirect behavior.

    " } + }, + "IndexDocument": { + "target": "com.amazonaws.s3#IndexDocument", + "traits": { + "smithy.api#documentation": "

    The name of the index document for the website (for example index.html).

    " + } } } }, "com.amazonaws.s3#GetBucketWebsiteRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -4038,7 +4436,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can 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 file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, 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 BitTorrent. For more information, see Amazon S3 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 GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects.

    \n \n

    Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your 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 encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    \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 SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

    \n \n

    Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging action), the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

    \n \n

    \n Permissions\n

    \n

    You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.

      \n
      • \n
    \n \n \n

    \n Versioning\n

    \n

    By default, the GET operation returns the current version of an object. To return a 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 object was deleted and includes x-amz-delete-marker: true in the 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 response. For example, you might override the Content-Disposition response header value in your GET request.

    \n \n

    You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these 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, when using these parameters. They cannot be used with an unsigned (anonymous) request.

    \n     \n
      \n
    • \n

      \n response-content-type\n

      \n
      • \n
    • \n

      \n response-content-language\n

      \n
      • \n
    • \n

      \n response-expires\n

      \n
      • \n
    • \n

      \n response-cache-control\n

      \n
      • \n
    • \n

      \n response-content-disposition\n

      \n
      • \n
    • \n

      \n response-content-encoding\n

      \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 present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to 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 present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to 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#documentation": "

    Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can 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 file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, 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 BitTorrent. For more information, see Amazon S3 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 GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects.

    \n \n

    Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your 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 encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

    \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 SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

    \n \n

    Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging action), \n the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. \n You can use GetObjectTagging to retrieve the tag set associated with an object.

    \n \n

    \n Permissions\n

    \n

    You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.

      \n
      • \n
    \n \n \n

    \n Versioning\n

    \n

    By default, the GET operation returns the current version of an object. To return a 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 object was deleted and includes x-amz-delete-marker: true in the 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 response. For example, you might override the Content-Disposition response header value in your GET request.

    \n \n

    You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these 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, when using these parameters. They cannot be used with an unsigned (anonymous) request.

    \n     \n
      \n
    • \n

      \n response-content-type\n

      \n
      • \n
    • \n

      \n response-content-language\n

      \n
      • \n
    • \n

      \n response-expires\n

      \n
      • \n
    • \n

      \n response-cache-control\n

      \n
      • \n
    • \n

      \n response-content-disposition\n

      \n
      • \n
    • \n

      \n response-content-encoding\n

      \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 present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to 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 present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to 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", @@ -4060,7 +4458,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.

    \n \n

    \n Versioning\n

    \n

    By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

    \n \n

    The following operations are related to GetObjectAcl:

    \n ", + "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

    \n Versioning\n

    \n

    By default, GET returns ACL information about the current version of an object. To 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", @@ -4071,10 +4469,11 @@ "com.amazonaws.s3#GetObjectAclOutput": { "type": "structure", "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "Grants": { + "target": "com.amazonaws.s3#Grants", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "

    A list of grants.

    ", + "smithy.api#xmlName": "AccessControlList" } }, "Owner": { @@ -4083,11 +4482,10 @@ "smithy.api#documentation": "

    \t\n Container for the bucket owner's display name and ID.

    " } }, - "Grants": { - "target": "com.amazonaws.s3#Grants", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "

    A list of grants.

    ", - "smithy.api#xmlName": "AccessControlList" + "smithy.api#httpHeader": "x-amz-request-charged" } } } @@ -4095,19 +4493,6 @@ "com.amazonaws.s3#GetObjectAclRequest": { "type": "structure", "members": { - "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" - } - }, "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { @@ -4119,10 +4504,30 @@ "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 using 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#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": {} } + }, + "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" + } + }, + "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" + } } } }, @@ -4135,7 +4540,7 @@ "target": "com.amazonaws.s3#GetObjectLegalHoldOutput" }, "traits": { - "smithy.api#documentation": "

    Gets an object's current Legal Hold\n status. For more information, see Locking Objects.

    ", + "smithy.api#documentation": "

    Gets an object's current Legal Hold\n 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", @@ -4166,10 +4571,17 @@ "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The bucket name containing the object whose Legal\n 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 using 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#documentation": "

    The bucket name containing the object whose Legal\n 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": {} } @@ -4180,11 +4592,11 @@ "smithy.api#httpHeader": "x-amz-request-payer" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    The version ID of the object whose Legal Hold status you want to retrieve.

    ", - "smithy.api#httpQuery": "versionId" + "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" } } } @@ -4224,55 +4636,56 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The bucket whose Object Lock configuration you want to retrieve.

    ", + "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": { - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "

    The Object Lock mode currently in place for this object.

    ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "

    The language the content is in.

    ", + "smithy.api#httpHeader": "Content-Language" } }, - "Restore": { - "target": "com.amazonaws.s3#Restore", - "traits": { - "smithy.api#documentation": "

    Provides information about object restoration operation and expiration time of the restored object copy.

    ", - "smithy.api#httpHeader": "x-amz-restore" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", "traits": { - "smithy.api#documentation": "

    Last modified date of the object

    ", - "smithy.api#httpHeader": "Last-Modified" + "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", + "smithy.api#httpHeader": "Content-Disposition" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "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" + "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", + "smithy.api#httpHeader": "Cache-Control" } }, - "PartsCount": { - "target": "com.amazonaws.s3#PartsCount", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "

    The count of parts this object has.

    ", - "smithy.api#httpHeader": "x-amz-mp-parts-count" + "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    ", + "smithy.api#httpHeader": "Content-Type" } }, "ContentRange": { @@ -4282,13 +4695,6 @@ "smithy.api#httpHeader": "Content-Range" } }, - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", - "traits": { - "smithy.api#documentation": "

    Object data.

    ", - "smithy.api#httpPayload": {} - } - }, "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { @@ -4296,32 +4702,25 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "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" - } - }, - "AcceptRanges": { - "target": "com.amazonaws.s3#AcceptRanges", + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#documentation": "

    Indicates that a range of bytes was specified.

    ", - "smithy.api#httpHeader": "accept-ranges" + "smithy.api#documentation": "

    Size of the body in bytes.

    ", + "smithy.api#httpHeader": "Content-Length" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", "traits": { - "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", - "smithy.api#httpHeader": "Content-Encoding" + "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" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "

    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

    ", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "

    Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

    ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, "Metadata": { @@ -4331,13 +4730,6 @@ "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, - "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" - } - }, "DeleteMarker": { "target": "com.amazonaws.s3#DeleteMarker", "traits": { @@ -4345,46 +4737,60 @@ "smithy.api#httpHeader": "x-amz-delete-marker" } }, - "MissingMeta": { - "target": "com.amazonaws.s3#MissingMeta", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

    This is set to the number of metadata entries not returned in x-amz-meta headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.

    ", - "smithy.api#httpHeader": "x-amz-missing-meta" + "smithy.api#documentation": "

    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

    ", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", "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" + "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "smithy.api#httpHeader": "Content-Encoding" } }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", + "Restore": { + "target": "com.amazonaws.s3#Restore", "traits": { - "smithy.api#documentation": "

    The language the content is in.

    ", - "smithy.api#httpHeader": "Content-Language" + "smithy.api#documentation": "

    Provides information about object restoration operation and expiration time of the restored object copy.

    ", + "smithy.api#httpHeader": "x-amz-restore" } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", - "smithy.api#httpHeader": "Expires" + "smithy.api#documentation": "

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

    Size of the body in bytes.

    ", - "smithy.api#httpHeader": "Content-Length" + "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" } }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", "traits": { - "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", - "smithy.api#httpHeader": "Content-Disposition" + "smithy.api#documentation": "

    The count of parts this object has.

    ", + "smithy.api#httpHeader": "x-amz-mp-parts-count" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", + "traits": { + "smithy.api#documentation": "

    Indicates that a range of bytes was specified.

    ", + "smithy.api#httpHeader": "accept-ranges" } }, "VersionId": { @@ -4394,32 +4800,46 @@ "smithy.api#httpHeader": "x-amz-version-id" } }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", "traits": { - "smithy.api#documentation": "

    Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

    ", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + "smithy.api#documentation": "

    Object data.

    ", + "smithy.api#httpPayload": {} } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    ", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", + "smithy.api#httpHeader": "Expires" } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "Expiration": { + "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs providing object expiration\n information. The value of the rule-id is URL encoded.

    ", + "smithy.api#httpHeader": "x-amz-expiration" } }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", "traits": { - "smithy.api#documentation": "

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", - "smithy.api#httpHeader": "x-amz-website-redirect-location" + "smithy.api#documentation": "

    This is set to the number of metadata entries not returned in x-amz-meta headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.

    ", + "smithy.api#httpHeader": "x-amz-missing-meta" + } + }, + "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 destination in a replication rule.

    ", + "smithy.api#httpHeader": "x-amz-replication-status" + } + }, + "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" } }, "SSECustomerKeyMD5": { @@ -4429,6 +4849,13 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

    Last modified date of the object

    ", + "smithy.api#httpHeader": "Last-Modified" + } + }, "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { @@ -4436,18 +4863,10 @@ "smithy.api#httpHeader": "ETag" } }, - "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 destination in a replication rule.

    ", - "smithy.api#httpHeader": "x-amz-replication-status" - } - }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs providing object expiration\n information. The value of the rule-id is URL encoded.

    ", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#httpHeader": "x-amz-request-charged" } } } @@ -4455,60 +4874,61 @@ "com.amazonaws.s3#GetObjectRequest": { "type": "structure", "members": { - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "ResponseContentEncoding": { + "target": "com.amazonaws.s3#ResponseContentEncoding", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "

    Sets the Content-Encoding header of the response.

    ", + "smithy.api#httpQuery": "response-content-encoding" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "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" + "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" } }, "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 using 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#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": {} } }, - "IfNoneMatch": { - "target": "com.amazonaws.s3#IfNoneMatch", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "

    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    ", - "smithy.api#httpHeader": "If-None-Match" + "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "IfMatch": { - "target": "com.amazonaws.s3#IfMatch", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    ", - "smithy.api#httpHeader": "If-Match" + "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" } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "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" + "smithy.api#httpHeader": "x-amz-request-payer" } }, - "Range": { - "target": "com.amazonaws.s3#Range", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    Downloads the specified range bytes of an object. For more information about the HTTP Range\n 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 request.

    \n     ", - "smithy.api#httpHeader": "Range" + "smithy.api#documentation": "

    Key of the object to get.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ResponseContentDisposition": { - "target": "com.amazonaws.s3#ResponseContentDisposition", + "ResponseCacheControl": { + "target": "com.amazonaws.s3#ResponseCacheControl", "traits": { - "smithy.api#documentation": "

    Sets the Content-Disposition header of the response

    ", - "smithy.api#httpQuery": "response-content-disposition" + "smithy.api#documentation": "

    Sets the Cache-Control header of the response.

    ", + "smithy.api#httpQuery": "response-cache-control" } }, "ResponseContentLanguage": { @@ -4518,33 +4938,32 @@ "smithy.api#httpQuery": "response-content-language" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    VersionId used to reference a specific version of the object.

    ", - "smithy.api#httpQuery": "versionId" + "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" } }, - "ResponseContentEncoding": { - "target": "com.amazonaws.s3#ResponseContentEncoding", + "ResponseContentDisposition": { + "target": "com.amazonaws.s3#ResponseContentDisposition", "traits": { - "smithy.api#documentation": "

    Sets the Content-Encoding header of the response.

    ", - "smithy.api#httpQuery": "response-content-encoding" + "smithy.api#documentation": "

    Sets the Content-Disposition header of the response

    ", + "smithy.api#httpQuery": "response-content-disposition" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "IfUnmodifiedSince": { + "target": "com.amazonaws.s3#IfUnmodifiedSince", "traits": { - "smithy.api#documentation": "

    Key of the object to get.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    ", + "smithy.api#httpHeader": "If-Unmodified-Since" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

    ", + "smithy.api#httpQuery": "partNumber" } }, "IfModifiedSince": { @@ -4554,11 +4973,25 @@ "smithy.api#httpHeader": "If-Modified-Since" } }, - "ResponseCacheControl": { - "target": "com.amazonaws.s3#ResponseCacheControl", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "

    Sets the Cache-Control header of the response.

    ", - "smithy.api#httpQuery": "response-cache-control" + "smithy.api#documentation": "

    VersionId used to reference a specific version of the object.

    ", + "smithy.api#httpQuery": "versionId" + } + }, + "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, otherwise return a 304 (not modified).

    ", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "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, otherwise return a 412 (precondition failed).

    ", + "smithy.api#httpHeader": "If-Match" } }, "ResponseExpires": { @@ -4568,26 +5001,19 @@ "smithy.api#httpQuery": "response-expires" } }, + "Range": { + "target": "com.amazonaws.s3#Range", + "traits": { + "smithy.api#documentation": "

    Downloads the specified range bytes of an object. For more information about the HTTP Range\n 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 request.

    \n     ", + "smithy.api#httpHeader": "Range" + } + }, "ResponseContentType": { "target": "com.amazonaws.s3#ResponseContentType", "traits": { "smithy.api#documentation": "

    Sets the Content-Type header of the response.

    ", "smithy.api#httpQuery": "response-content-type" } - }, - "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 return a 412 (precondition failed).

    ", - "smithy.api#httpHeader": "If-Unmodified-Since" - } - }, - "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. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

    ", - "smithy.api#httpQuery": "partNumber" - } } } }, @@ -4600,7 +5026,7 @@ "target": "com.amazonaws.s3#GetObjectRetentionOutput" }, "traits": { - "smithy.api#documentation": "

    Retrieves an object's retention settings. For more information, see Locking Objects.

    ", + "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", @@ -4623,12 +5049,6 @@ "com.amazonaws.s3#GetObjectRetentionRequest": { "type": "structure", "members": { - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { @@ -4636,12 +5056,11 @@ "smithy.api#httpQuery": "versionId" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "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 using 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": {} + "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" } }, "Key": { @@ -4651,6 +5070,20 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "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": {} + } } } }, @@ -4663,7 +5096,7 @@ "target": "com.amazonaws.s3#GetObjectTaggingOutput" }, "traits": { - "smithy.api#documentation": "

    Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

    \n \n

    To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

    \n \n

    By default, the bucket owner has this permission and can grant this permission to 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#documentation": "

    Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

    \n \n

    To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

    \n \n

    By default, the bucket owner has this permission and can grant this permission to 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", @@ -4693,6 +5126,14 @@ "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": {} + } + }, "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { @@ -4700,12 +5141,11 @@ "smithy.api#httpQuery": "versionId" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "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 using 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": {} + "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" } }, "Key": { @@ -4727,7 +5167,7 @@ "target": "com.amazonaws.s3#GetObjectTorrentOutput" }, "traits": { - "smithy.api#documentation": "

    Return torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Amazon S3 Torrent.

    \n \n \n

    You can get torrent only for objects that are less than 5 GB in size and that are not encrypted using server-side encryption with customer-provided encryption key.

    \n     \n \n \n \n

    To use GET, you must have READ access to the object.

    \n \n

    The following operation is related to GetObjectTorrent:

    \n ", + "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 not\n encrypted using server-side encryption with a customer-provided encryption 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 \n

    The following operation is related to GetObjectTorrent:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?torrent", @@ -4738,32 +5178,24 @@ "com.amazonaws.s3#GetObjectTorrentOutput": { "type": "structure", "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, "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": { - "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": { @@ -4777,6 +5209,21 @@ "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": {} + } + }, + "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" + } } } }, @@ -4789,7 +5236,7 @@ "target": "com.amazonaws.s3#GetPublicAccessBlockOutput" }, "traits": { - "smithy.api#documentation": "

    Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To\n use this operation, you must have the s3:GetBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

    \n \n \n

    When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and 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#documentation": "

    Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To\n use this operation, you must have the s3:GetBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

    \n \n \n

    When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and 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", @@ -4812,6 +5259,13 @@ "com.amazonaws.s3#GetPublicAccessBlockRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -4840,17 +5294,17 @@ "com.amazonaws.s3#Grant": { "type": "structure", "members": { - "Permission": { - "target": "com.amazonaws.s3#Permission", - "traits": { - "smithy.api#documentation": "

    Specifies the permission given to the grantee.

    " - } - }, "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": { @@ -4875,10 +5329,10 @@ "com.amazonaws.s3#Grantee": { "type": "structure", "members": { - "ID": { - "target": "com.amazonaws.s3#ID", + "EmailAddress": { + "target": "com.amazonaws.s3#EmailAddress", "traits": { - "smithy.api#documentation": "

    The canonical user ID of the grantee.

    " + "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
    • \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     " } }, "DisplayName": { @@ -4887,18 +5341,18 @@ "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
    • \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     " - } - }, "URI": { "target": "com.amazonaws.s3#URI", "traits": { "smithy.api#documentation": "

    URI of the grantee group.

    " } }, + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

    The canonical user ID of the grantee.

    " + } + }, "Type": { "target": "com.amazonaws.s3#Type", "traits": { @@ -4948,10 +5402,17 @@ "com.amazonaws.s3#HeadBucketRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The bucket name.

    ", + "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": {} } @@ -4972,7 +5433,7 @@ } ], "traits": { - "smithy.api#documentation": "

    The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

    \n \n

    A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body.

    \n \n

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

    \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 SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

    \n \n

    Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest 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 Headers.

    \n

    Consider the following when using request headers:

    \n
      \n
    • \n

      Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

      \n
        \n
      • \n

        \n If-Match condition evaluates to true, and;

        \n
        • \n
      • \n

        \n If-Unmodified-Since condition evaluates to false;

        \n
        • \n
      \n

      Then Amazon S3 returns 200 OK and the data requested.

      \n
      • \n
    • \n

      \n Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

      \n
        \n
      • \n

        \n If-None-Match condition evaluates to false, and;

        \n
        • \n
      • \n

        \n If-Modified-Since condition evaluates to true;

        \n
        • \n
      \n

      Then Amazon S3 returns the 304 Not Modified response code.

      \n
      • \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 information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP\n status code 404 (\"no such key\") error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status\n code 403 (\"access denied\") error.

      \n
      • \n
    \n \n

    The following operation is related to HeadObject:

    \n ", + "smithy.api#documentation": "

    The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

    \n \n

    A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body.

    \n \n

    If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

    \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 SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

    \n \n

    Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest 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 Headers.

    \n

    Consider the following when using request headers:

    \n
      \n
    • \n

      Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

      \n
        \n
      • \n

        \n If-Match condition evaluates to true, and;

        \n
        • \n
      • \n

        \n If-Unmodified-Since condition evaluates to false;

        \n
        • \n
      \n

      Then Amazon S3 returns 200 OK and the data requested.

      \n
      • \n
    • \n

      \n Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

      \n
        \n
      • \n

        \n If-None-Match condition evaluates to false, and;

        \n
        • \n
      • \n

        \n If-Modified-Since condition evaluates to true;

        \n
        • \n
      \n

      Then Amazon S3 returns the 304 Not Modified response code.

      \n
      • \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 information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP\n status code 404 (\"no such key\") error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status\n code 403 (\"access denied\") error.

      \n
      • \n
    \n \n

    The following operation is related to HeadObject:

    \n ", "smithy.api#http": { "method": "HEAD", "uri": "/{Bucket}/{Key+}", @@ -4983,87 +5444,88 @@ "com.amazonaws.s3#HeadObjectOutput": { "type": "structure", "members": { - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", + "smithy.api#httpHeader": "Cache-Control" } }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#documentation": "

    Last modified date of the object

    ", - "smithy.api#httpHeader": "Last-Modified" + "smithy.api#documentation": "

    Size of the body in bytes.

    ", + "smithy.api#httpHeader": "Content-Length" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "

    The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

    ", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" } }, - "PartsCount": { - "target": "com.amazonaws.s3#PartsCount", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "

    The count of parts this object has.

    ", - "smithy.api#httpHeader": "x-amz-mp-parts-count" + "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    ", + "smithy.api#httpHeader": "Content-Type" } }, - "ReplicationStatus": { - "target": "com.amazonaws.s3#ReplicationStatus", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "

    Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.

    \n \n

    In replication, you have a source bucket on which you configure replication and\n destination bucket 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\n response as follows:

    \n
      \n
    • \n

      If requesting an object from the source bucket — Amazon S3 will return the\n x-amz-replication-status header if the object in your request is\n eligible for replication.

      \n

      For example, suppose that in your replication configuration, you specify\n object prefix TaxDocs requesting Amazon S3 to replicate objects with key\n prefix TaxDocs. Any objects you upload with this key name prefix, for\n example TaxDocs/document1.pdf, are eligible for replication. For any\n object request with this key name prefix, Amazon S3 will return the\n x-amz-replication-status header with value PENDING, COMPLETED or\n FAILED indicating object replication status.

      \n
      • \n
    • \n

      If requesting an object from the destination bucket — Amazon S3 will return the\n x-amz-replication-status header with value REPLICA if the object in\n your request is a replica that Amazon S3 created.

      \n
      • \n
    \n \n

    For more information, see Replication.

    ", - "smithy.api#httpHeader": "x-amz-replication-status" + "smithy.api#documentation": "

    An ETag is an opaque identifier assigned by a web server to a specific version of a resource\n found at a URL.

    ", + "smithy.api#httpHeader": "ETag" } }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", "traits": { - "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", + "smithy.api#httpHeader": "Content-Disposition" } }, - "Restore": { - "target": "com.amazonaws.s3#Restore", + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", "traits": { - "smithy.api#documentation": "

    If the object is an archived object (an object whose storage class is GLACIER), the 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 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 GMT\"\n

    \n \n

    If the object restoration is in progress, the header returns the value ongoing-request=\"true\".

    \n \n

    For more information about archiving objects, see Transitioning Objects: General Considerations.

    ", - "smithy.api#httpHeader": "x-amz-restore" + "smithy.api#documentation": "

    The language the content is in.

    ", + "smithy.api#httpHeader": "Content-Language" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "Expiration": { + "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", - "smithy.api#httpHeader": "Content-Encoding" + "smithy.api#documentation": "

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs providing object expiration\n information. The value of the rule-id is URL encoded.

    ", + "smithy.api#httpHeader": "x-amz-expiration" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", + "smithy.api#httpHeader": "Expires" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    Version of the object.

    ", - "smithy.api#httpHeader": "x-amz-version-id" + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "ReplicationStatus": { + "target": "com.amazonaws.s3#ReplicationStatus", "traits": { - "smithy.api#documentation": "

    Specifies caching behavior along the request/reply chain.

    ", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "

    Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.

    \n \n

    In replication, you have a source bucket on which you configure replication and\n destination bucket 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\n response as follows:

    \n
      \n
    • \n

      If requesting an object from the source bucket — Amazon S3 will return the\n x-amz-replication-status header if the object in your request is\n eligible for replication.

      \n

      For example, suppose that in your replication configuration, you specify\n object prefix TaxDocs requesting Amazon S3 to replicate objects with key\n prefix TaxDocs. Any objects you upload with this key name prefix, for\n example TaxDocs/document1.pdf, are eligible for replication. For any\n object request with this key name prefix, Amazon S3 will return the\n x-amz-replication-status header with value PENDING, COMPLETED or\n FAILED indicating object replication status.

      \n
      • \n
    • \n

      If requesting an object from the destination bucket — Amazon S3 will return the\n x-amz-replication-status header with value REPLICA if the object in\n your request is a replica that Amazon S3 created.

      \n
      • \n
    \n \n

    For more information, see Replication.

    ", + "smithy.api#httpHeader": "x-amz-replication-status" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "

    The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

    ", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + "smithy.api#documentation": "

    Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

    ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, "WebsiteRedirectLocation": { @@ -5073,95 +5535,94 @@ "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

    Size of the body in bytes.

    ", - "smithy.api#httpHeader": "Content-Length" + "smithy.api#documentation": "

    If the object is stored using server-side encryption either with an AWS KMS customer master\n 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" } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable.

    ", - "smithy.api#httpHeader": "Expires" + "smithy.api#documentation": "

    Version of the object.

    ", + "smithy.api#httpHeader": "x-amz-version-id" } }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "

    Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

    ", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "MissingMeta": { - "target": "com.amazonaws.s3#MissingMeta", + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", "traits": { - "smithy.api#documentation": "

    This is set to the number of metadata entries not returned in x-amz-meta headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.

    ", - "smithy.api#httpHeader": "x-amz-missing-meta" + "smithy.api#documentation": "

    The count of parts this object has.

    ", + "smithy.api#httpHeader": "x-amz-mp-parts-count" } }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "

    Specifies presentational information for the object.

    ", - "smithy.api#httpHeader": "Content-Disposition" + "smithy.api#httpHeader": "x-amz-request-charged" } }, - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", + "LastModified": { + "target": "com.amazonaws.s3#LastModified", "traits": { - "smithy.api#documentation": "

    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

    ", - "smithy.api#httpHeader": "x-amz-delete-marker" + "smithy.api#documentation": "

    Last modified date of the object

    ", + "smithy.api#httpHeader": "Last-Modified" } }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", "traits": { - "smithy.api#documentation": "

    The language the content is in.

    ", - "smithy.api#httpHeader": "Content-Language" + "smithy.api#documentation": "

    This is set to the number of metadata entries not returned in x-amz-meta headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.

    ", + "smithy.api#httpHeader": "x-amz-missing-meta" } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "Restore": { + "target": "com.amazonaws.s3#Restore", "traits": { - "smithy.api#documentation": "

    An ETag is an opaque identifier assigned by a web server to a specific version of a resource\n found at a URL.

    ", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "

    If the object is an archived object (an object whose storage class is GLACIER), \n the 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 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 GMT\"\n

    \n \n

    If the object restoration is in progress, the header returns the value ongoing-request=\"true\".

    \n \n

    For more information about archiving objects, see Transitioning Objects: General Considerations.

    ", + "smithy.api#httpHeader": "x-amz-restore" } }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", "traits": { - "smithy.api#documentation": "

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs providing object expiration\n information. The value of the rule-id is URL encoded.

    ", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "smithy.api#httpHeader": "Content-Encoding" } }, - "AcceptRanges": { - "target": "com.amazonaws.s3#AcceptRanges", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

    Indicates that a range of bytes was specified.

    ", - "smithy.api#httpHeader": "accept-ranges" + "smithy.api#documentation": "

    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

    \n \n

    For more information, see Storage Classes.

    ", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "traits": { - "smithy.api#documentation": "

    The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

    ", - "smithy.api#httpHeader": "x-amz-object-lock-mode" + "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    ", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

    ", + "smithy.api#httpHeader": "x-amz-delete-marker" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", "traits": { - "smithy.api#documentation": "

    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

    \n \n

    For more information, see Storage Classes.

    ", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "

    The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

    ", + "smithy.api#httpHeader": "x-amz-object-lock-mode" } }, "SSEKMSKeyId": { @@ -5171,11 +5632,11 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", "traits": { - "smithy.api#documentation": "

    If the object is stored using server-side encryption either with an AWS KMS customer master\n 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" + "smithy.api#documentation": "

    Indicates that a range of bytes was specified.

    ", + "smithy.api#httpHeader": "accept-ranges" } } } @@ -5183,34 +5644,41 @@ "com.amazonaws.s3#HeadObjectRequest": { "type": "structure", "members": { - "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" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "

    The name of the bucket containing the object.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "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" } }, "Range": { "target": "com.amazonaws.s3#Range", "traits": { - "smithy.api#documentation": "

    Downloads the specified range bytes of an object. For more information about the HTTP Range\n 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 request.

    \n     ", + "smithy.api#documentation": "

    Downloads the specified range bytes of an object. For more information about the HTTP Range\n 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 request.

    \n     ", "smithy.api#httpHeader": "Range" } }, + "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, otherwise return a 304 (not modified).

    ", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "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. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

    ", + "smithy.api#httpQuery": "partNumber" + } + }, "IfUnmodifiedSince": { "target": "com.amazonaws.s3#IfUnmodifiedSince", "traits": { @@ -5218,40 +5686,48 @@ "smithy.api#httpHeader": "If-Unmodified-Since" } }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", + "IfModifiedSince": { + "target": "com.amazonaws.s3#IfModifiedSince", "traits": { - "smithy.api#documentation": "

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

    ", - "smithy.api#httpQuery": "partNumber" + "smithy.api#documentation": "

    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    ", + "smithy.api#httpHeader": "If-Modified-Since" } }, - "IfNoneMatch": { - "target": "com.amazonaws.s3#IfNoneMatch", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    ", - "smithy.api#httpHeader": "If-None-Match" + "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" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    The object key.

    ", + "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" + } + }, + "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": {} } }, - "IfModifiedSince": { - "target": "com.amazonaws.s3#IfModifiedSince", + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", "traits": { - "smithy.api#documentation": "

    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    ", - "smithy.api#httpHeader": "If-Modified-Since" + "smithy.api#documentation": "

    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    ", + "smithy.api#httpHeader": "If-Match" } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "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" + "smithy.api#documentation": "

    The object key.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "VersionId": { @@ -5261,18 +5737,10 @@ "smithy.api#httpQuery": "versionId" } }, - "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, otherwise return a 412 (precondition failed).

    ", - "smithy.api#httpHeader": "If-Match" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#httpHeader": "x-amz-request-payer" } } } @@ -5342,6 +5810,12 @@ "com.amazonaws.s3#InputSerialization": { "type": "structure", "members": { + "JSON": { + "target": "com.amazonaws.s3#JSONInput", + "traits": { + "smithy.api#documentation": "

    Specifies JSON as object's input serialization format.

    " + } + }, "CompressionType": { "target": "com.amazonaws.s3#CompressionType", "traits": { @@ -5359,12 +5833,6 @@ "traits": { "smithy.api#documentation": "

    Describes the serialization of a CSV-encoded object.

    " } - }, - "JSON": { - "target": "com.amazonaws.s3#JSONInput", - "traits": { - "smithy.api#documentation": "

    Specifies JSON as object's input serialization format.

    " - } } }, "traits": { @@ -5374,23 +5842,24 @@ "com.amazonaws.s3#InventoryConfiguration": { "type": "structure", "members": { - "OptionalFields": { - "target": "com.amazonaws.s3#InventoryOptionalFields", + "IncludedObjectVersions": { + "target": "com.amazonaws.s3#InventoryIncludedObjectVersions", "traits": { - "smithy.api#documentation": "

    Contains the optional fields that are included in the inventory results.

    " + "smithy.api#documentation": "

    Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

    ", + "smithy.api#required": {} } }, - "Destination": { - "target": "com.amazonaws.s3#InventoryDestination", + "IsEnabled": { + "target": "com.amazonaws.s3#IsEnabled", "traits": { - "smithy.api#documentation": "

    Contains information about where to publish the inventory results.

    ", + "smithy.api#documentation": "

    Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

    ", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.s3#InventoryId", + "Schedule": { + "target": "com.amazonaws.s3#InventorySchedule", "traits": { - "smithy.api#documentation": "

    The ID used to identify the inventory configuration.

    ", + "smithy.api#documentation": "

    Specifies the schedule for generating inventory results.

    ", "smithy.api#required": {} } }, @@ -5400,24 +5869,23 @@ "smithy.api#documentation": "

    Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

    " } }, - "Schedule": { - "target": "com.amazonaws.s3#InventorySchedule", + "OptionalFields": { + "target": "com.amazonaws.s3#InventoryOptionalFields", "traits": { - "smithy.api#documentation": "

    Specifies the schedule for generating inventory results.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Contains the optional fields that are included in the inventory results.

    " } }, - "IsEnabled": { - "target": "com.amazonaws.s3#IsEnabled", + "Destination": { + "target": "com.amazonaws.s3#InventoryDestination", "traits": { - "smithy.api#documentation": "

    Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

    ", + "smithy.api#documentation": "

    Contains information about where to publish the inventory results.

    ", "smithy.api#required": {} } }, - "IncludedObjectVersions": { - "target": "com.amazonaws.s3#InventoryIncludedObjectVersions", + "Id": { + "target": "com.amazonaws.s3#InventoryId", "traits": { - "smithy.api#documentation": "

    Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

    ", + "smithy.api#documentation": "

    The ID used to identify the inventory configuration.

    ", "smithy.api#required": {} } } @@ -5450,19 +5918,19 @@ "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" } + }, + "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" + } } }, "traits": { @@ -5581,19 +6049,13 @@ "com.amazonaws.s3#InventoryS3BucketDestination": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Format": { + "target": "com.amazonaws.s3#InventoryFormat", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

    ", + "smithy.api#documentation": "

    Specifies the output format of the inventory results.

    ", "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

    The account ID that owns the destination S3 bucket. \n If no account ID is provided, the owner is not validated before exporting data.

    \n \n

    \n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket \n ownership changes.\n

    \n     " - } - }, "Encryption": { "target": "com.amazonaws.s3#InventoryEncryption", "traits": { @@ -5606,12 +6068,18 @@ "smithy.api#documentation": "

    The prefix that is prepended to all inventory results.

    " } }, - "Format": { - "target": "com.amazonaws.s3#InventoryFormat", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Specifies the output format of the inventory results.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

    ", "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

    The account ID that owns the destination S3 bucket. \n If no account ID is provided, the owner is not validated before exporting data.

    \n \n

    \n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket \n ownership changes.\n

    \n     " + } } }, "traits": { @@ -5665,7 +6133,7 @@ "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, Amazon S3 uses a newline character ('\\n').

    " + "smithy.api#documentation": "

    The value used to separate individual records in the output. If no value is specified, Amazon S3 \n uses a newline character ('\\n').

    " } } }, @@ -5706,17 +6174,6 @@ "com.amazonaws.s3#LambdaFunctionConfiguration": { "type": "structure", "members": { - "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 specified event type occurs.

    ", - "smithy.api#required": {}, - "smithy.api#xmlName": "CloudFunction" - } - }, - "Id": { - "target": "com.amazonaws.s3#NotificationId" - }, "Events": { "target": "com.amazonaws.s3#EventList", "traits": { @@ -5728,6 +6185,17 @@ }, "Filter": { "target": "com.amazonaws.s3#NotificationConfigurationFilter" + }, + "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 specified event type occurs.

    ", + "smithy.api#required": {}, + "smithy.api#xmlName": "CloudFunction" + } + }, + "Id": { + "target": "com.amazonaws.s3#NotificationId" } }, "traits": { @@ -5746,10 +6214,10 @@ "com.amazonaws.s3#LifecycleExpiration": { "type": "structure", "members": { - "Date": { - "target": "com.amazonaws.s3#Date", + "Days": { + "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#documentation": "

    Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

    " + "smithy.api#documentation": "

    Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

    " } }, "ExpiredObjectDeleteMarker": { @@ -5758,10 +6226,10 @@ "smithy.api#documentation": "

    Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

    " } }, - "Days": { - "target": "com.amazonaws.s3#Days", + "Date": { + "target": "com.amazonaws.s3#Date", "traits": { - "smithy.api#documentation": "

    Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

    " + "smithy.api#documentation": "

    Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

    " } } }, @@ -5772,22 +6240,6 @@ "com.amazonaws.s3#LifecycleRule": { "type": "structure", "members": { - "ID": { - "target": "com.amazonaws.s3#ID", - "traits": { - "smithy.api#documentation": "

    Unique identifier for the rule. The value cannot be longer than 255 characters.

    " - } - }, - "Status": { - "target": "com.amazonaws.s3#ExpirationStatus", - "traits": { - "smithy.api#documentation": "

    If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

    ", - "smithy.api#required": {} - } - }, - "AbortIncompleteMultipartUpload": { - "target": "com.amazonaws.s3#AbortIncompleteMultipartUpload" - }, "NoncurrentVersionTransitions": { "target": "com.amazonaws.s3#NoncurrentVersionTransitionList", "traits": { @@ -5796,11 +6248,16 @@ "smithy.api#xmlName": "NoncurrentVersionTransition" } }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "Expiration": { + "target": "com.amazonaws.s3#LifecycleExpiration", "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.

    " + "smithy.api#documentation": "

    Specifies the expiration for the lifecycle of the object in the form of date, days and, 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.

    " } }, "Transitions": { @@ -5811,17 +6268,28 @@ "smithy.api#xmlName": "Transition" } }, - "Filter": { - "target": "com.amazonaws.s3#LifecycleRuleFilter" - }, - "Expiration": { - "target": "com.amazonaws.s3#LifecycleExpiration", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

    Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

    " + "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.

    " } }, "NoncurrentVersionExpiration": { "target": "com.amazonaws.s3#NoncurrentVersionExpiration" + }, + "AbortIncompleteMultipartUpload": { + "target": "com.amazonaws.s3#AbortIncompleteMultipartUpload" + }, + "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 currently being applied.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -5831,6 +6299,12 @@ "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": { @@ -5838,12 +6312,6 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

    Prefix identifying one or more objects to which the rule applies.

    " - } } }, "traits": { @@ -5888,7 +6356,7 @@ "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput" }, "traits": { - "smithy.api#documentation": "

    Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

    \n \n

    This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

    \n \n

    The following operations are related to ListBucketAnalyticsConfigurations:

    \n ", + "smithy.api#documentation": "

    Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

    \n \n

    This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

    \n \n

    The following operations are related to ListBucketAnalyticsConfigurations:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?analytics&x-id=ListBucketAnalyticsConfigurations", @@ -5898,19 +6366,7 @@ }, "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput": { "type": "structure", - "members": { - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

    The marker that is used as a starting point for this analytics configuration list 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.

    " - } - }, + "members": { "AnalyticsConfigurationList": { "target": "com.amazonaws.s3#AnalyticsConfigurationList", "traits": { @@ -5919,23 +6375,34 @@ "smithy.api#xmlName": "AnalyticsConfiguration" } }, + "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.

    " + } + }, "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { "smithy.api#documentation": "

    Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided 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 response. This value is present if it was sent in the request.

    " + } } } }, "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    The name of the bucket from which analytics configurations are retrieved.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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" } }, "ContinuationToken": { @@ -5944,6 +6411,14 @@ "smithy.api#documentation": "

    The ContinuationToken that represents a placeholder from where this request should begin.

    ", "smithy.api#httpQuery": "continuation-token" } + }, + "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": {} + } } } }, @@ -5956,7 +6431,7 @@ "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 analytics configurations per bucket.

    \n \n

    This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n

    \n \n

    The following operations are related to ListBucketInventoryConfigurations:

    \n ", + "smithy.api#documentation": "

    Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

    \n \n

    This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n

    \n \n

    The following operations are related to ListBucketInventoryConfigurations:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?inventory&x-id=ListBucketInventoryConfigurations", @@ -5981,30 +6456,23 @@ "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\n understands.

    " } }, - "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 configuration list response.

    " - } - }, "IsTruncated": { "target": "com.amazonaws.s3#IsTruncated", "traits": { "smithy.api#documentation": "

    Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

    " } + }, + "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 configuration list response.

    " + } } } }, "com.amazonaws.s3#ListBucketInventoryConfigurationsRequest": { "type": "structure", "members": { - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

    The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

    ", - "smithy.api#httpQuery": "continuation-token" - } - }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -6012,6 +6480,20 @@ "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" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

    The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

    ", + "smithy.api#httpQuery": "continuation-token" + } } } }, @@ -6024,7 +6506,7 @@ "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput" }, "traits": { - "smithy.api#documentation": "

    Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. 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 at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

    \n \n

    The following operations are related to ListBucketMetricsConfigurations:

    \n ", + "smithy.api#documentation": "

    Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. 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 at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

    \n \n

    To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

    \n \n

    The following operations are related to ListBucketMetricsConfigurations:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?metrics&x-id=ListBucketMetricsConfigurations", @@ -6035,6 +6517,12 @@ "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput": { "type": "structure", "members": { + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

    The marker used to continue a metrics configuration listing that has been truncated. Use the\n NextContinuationToken from a previously truncated list response to continue\n the listing. The continuation token is an opaque value that Amazon S3 understands.

    " + } + }, "MetricsConfigurationList": { "target": "com.amazonaws.s3#MetricsConfigurationList", "traits": { @@ -6043,12 +6531,6 @@ "smithy.api#xmlName": "MetricsConfiguration" } }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", - "traits": { - "smithy.api#documentation": "

    The marker used to continue a metrics configuration listing that has been truncated. Use the\n NextContinuationToken from a previously truncated list response to continue\n the listing. The continuation token is an opaque value that Amazon S3 understands.

    " - } - }, "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { @@ -6073,6 +6555,13 @@ "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -6100,17 +6589,17 @@ "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.

    " } + }, + "Buckets": { + "target": "com.amazonaws.s3#Buckets", + "traits": { + "smithy.api#documentation": "

    The list of buckets owned by the requestor.

    " + } } } }, @@ -6123,7 +6612,7 @@ "target": "com.amazonaws.s3#ListMultipartUploadsOutput" }, "traits": { - "smithy.api#documentation": "

    This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

    \n \n

    This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the 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 than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

    \n \n

    For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

    \n \n

    For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

    \n \n

    The following operations are related to ListMultipartUploads:

    \n ", + "smithy.api#documentation": "

    This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

    \n \n

    This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the 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 than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

    \n \n

    For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

    \n \n

    For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

    \n \n

    The following operations are related to ListMultipartUploads:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?uploads", @@ -6134,10 +6623,22 @@ "com.amazonaws.s3#ListMultipartUploadsOutput": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

    When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

    " + "smithy.api#documentation": "

    Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

    " + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

    The key at or after which the listing began.

    " + } + }, + "MaxUploads": { + "target": "com.amazonaws.s3#MaxUploads", + "traits": { + "smithy.api#documentation": "

    Maximum number of multipart uploads that could have been included in the response.

    " } }, "EncodingType": { @@ -6146,6 +6647,12 @@ "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 in the response, and returns encoded key name values in the following response elements:

    \n \n

    \n Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

    " } }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

    Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

    " + } + }, "Uploads": { "target": "com.amazonaws.s3#MultipartUploadList", "traits": { @@ -6154,28 +6661,16 @@ "smithy.api#xmlName": "Upload" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

    Name of the bucket to which the multipart upload was initiated.

    " - } - }, - "MaxUploads": { - "target": "com.amazonaws.s3#MaxUploads", - "traits": { - "smithy.api#documentation": "

    Maximum number of multipart uploads that could have been included in 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.

    " } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", "traits": { - "smithy.api#documentation": "

    Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

    " + "smithy.api#documentation": "

    Upload ID after which listing began.

    " } }, "CommonPrefixes": { @@ -6185,28 +6680,22 @@ "smithy.api#xmlFlattened": {} } }, - "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 key-marker request parameter in a subsequent request.

    " - } - }, - "KeyMarker": { - "target": "com.amazonaws.s3#KeyMarker", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

    The key at or after which the listing began.

    " + "smithy.api#documentation": "

    When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

    " } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "NextKeyMarker": { + "target": "com.amazonaws.s3#NextKeyMarker", "traits": { - "smithy.api#documentation": "

    Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

    " + "smithy.api#documentation": "

    When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

    " } }, - "UploadIdMarker": { - "target": "com.amazonaws.s3#UploadIdMarker", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Upload ID after which listing began.

    " + "smithy.api#documentation": "

    The name of the bucket to which the multipart upload was initiated.

    " } } } @@ -6214,17 +6703,19 @@ "com.amazonaws.s3#ListMultipartUploadsRequest": { "type": "structure", "members": { - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", "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 occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

    ", - "smithy.api#httpQuery": "delimiter" + "smithy.api#documentation": "

    Together with key-marker, specifies the multipart upload after which listing should begin. If\n key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any\n multipart uploads for a key equal to the key-marker might be included in the list only if\n they have an upload ID lexicographically greater than the specified\n upload-id-marker.

    ", + "smithy.api#httpQuery": "upload-id-marker" } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#httpQuery": "encoding-type" + "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": {} } }, "Prefix": { @@ -6234,6 +6725,20 @@ "smithy.api#httpQuery": "prefix" } }, + "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 occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

    ", + "smithy.api#httpQuery": "delimiter" + } + }, + "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 body. 1,000 is the maximum number of uploads that can be returned in a response.

    ", + "smithy.api#httpQuery": "max-uploads" + } + }, "KeyMarker": { "target": "com.amazonaws.s3#KeyMarker", "traits": { @@ -6241,26 +6746,17 @@ "smithy.api#httpQuery": "key-marker" } }, - "UploadIdMarker": { - "target": "com.amazonaws.s3#UploadIdMarker", - "traits": { - "smithy.api#documentation": "

    Together with key-marker, specifies the multipart upload after which listing should begin. If\n key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any\n multipart uploads for a key equal to the key-marker might be included in the list only if\n they have an upload ID lexicographically greater than the specified\n upload-id-marker.

    ", - "smithy.api#httpQuery": "upload-id-marker" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    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 using 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": {} + "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" } }, - "MaxUploads": { - "target": "com.amazonaws.s3#MaxUploads", + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", "traits": { - "smithy.api#documentation": "

    Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

    ", - "smithy.api#httpQuery": "max-uploads" + "smithy.api#httpQuery": "encoding-type" } } } @@ -6274,7 +6770,7 @@ "target": "com.amazonaws.s3#ListObjectVersionsOutput" }, "traits": { - "smithy.api#documentation": "

    Returns metadata about all of the versions of objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

    \n \n \n

    A 200 OK response can contain valid or invalid XML. Make sure to design your 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

    The following operations are related to ListObjectVersions:

    \n ", + "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 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 ListObjectVersions:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?versions", @@ -6285,49 +6781,41 @@ "com.amazonaws.s3#ListObjectVersionsOutput": { "type": "structure", "members": { - "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" - } - }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", + "Name": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

    ", - "smithy.api#xmlFlattened": {} + "smithy.api#documentation": "

    The bucket name.

    " } }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

    Selects objects that start with the value supplied by this parameter.

    " + "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.

    " } }, - "NextKeyMarker": { - "target": "com.amazonaws.s3#NextKeyMarker", + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", "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.

    " + "smithy.api#documentation": "

    \t\n 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 response, and returns encoded key name values in the following response elements:

    \n \n

    \n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

    " } }, - "Name": { - "target": "com.amazonaws.s3#BucketName", + "NextVersionIdMarker": { + "target": "com.amazonaws.s3#NextVersionIdMarker", "traits": { - "smithy.api#documentation": "

    Bucket name.

    " + "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.

    " } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "NextKeyMarker": { + "target": "com.amazonaws.s3#NextKeyMarker", "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.

    " + "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.

    " } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", "traits": { - "smithy.api#documentation": "

    \t\n 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 response, and returns encoded key name values in the following response elements:

    \n \n

    \n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

    " + "smithy.api#documentation": "

    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

    ", + "smithy.api#xmlFlattened": {} } }, "VersionIdMarker": { @@ -6336,28 +6824,22 @@ "smithy.api#documentation": "

    Marks the last version of the key returned in a truncated response.

    " } }, - "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.

    " - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#documentation": "

    Specifies the maximum number of objects to return.

    " + "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.

    " } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", "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.

    " + "smithy.api#documentation": "

    Specifies the maximum number of objects to return.

    " } }, - "KeyMarker": { - "target": "com.amazonaws.s3#KeyMarker", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

    Marks the last key returned in a truncated response.

    " + "smithy.api#documentation": "

    Selects objects that start with the value supplied by this parameter.

    " } }, "Versions": { @@ -6367,25 +6849,26 @@ "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" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

    Marks the last key returned in a truncated response.

    " + } } } }, "com.amazonaws.s3#ListObjectVersionsRequest": { "type": "structure", "members": { - "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 can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

    ", - "smithy.api#httpQuery": "prefix" - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#httpQuery": "encoding-type" - } - }, "KeyMarker": { "target": "com.amazonaws.s3#KeyMarker", "traits": { @@ -6400,6 +6883,20 @@ "smithy.api#httpQuery": "max-keys" } }, + "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" + } + }, + "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 same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

    ", + "smithy.api#httpQuery": "delimiter" + } + }, "VersionIdMarker": { "target": "com.amazonaws.s3#VersionIdMarker", "traits": { @@ -6410,16 +6907,22 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The bucket name that contains 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 using 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#documentation": "

    The bucket name that contains the objects.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

    A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

    ", - "smithy.api#httpQuery": "delimiter" + "smithy.api#documentation": "

    Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

    ", + "smithy.api#httpQuery": "prefix" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" } } } @@ -6438,7 +6941,7 @@ } ], "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, Amazon S3 continues to support ListObjects.

    \n     \n \n \n

    The following operations are related to ListObjects:

    \n ", + "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, 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}", @@ -6449,28 +6952,29 @@ "com.amazonaws.s3#ListObjectsOutput": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#documentation": "

    Keys that begin with the indicated prefix.

    " + "smithy.api#documentation": "

    The maximum number of keys returned in the response body.

    " } }, - "Marker": { - "target": "com.amazonaws.s3#Marker", + "Contents": { + "target": "com.amazonaws.s3#ObjectList", "traits": { - "smithy.api#documentation": "

    Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

    " + "smithy.api#documentation": "

    Metadata about each object returned.

    ", + "smithy.api#xmlFlattened": {} } }, - "Name": { - "target": "com.amazonaws.s3#BucketName", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

    Bucket name.

    " + "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.

    " } }, - "NextMarker": { - "target": "com.amazonaws.s3#NextMarker", + "Name": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

    " + "smithy.api#documentation": "

    The bucket name.

    " } }, "IsTruncated": { @@ -6479,36 +6983,35 @@ "smithy.api#documentation": "

    A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria.

    " } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "NextMarker": { + "target": "com.amazonaws.s3#NextMarker", "traits": { - "smithy.api#documentation": "

    Encoding type used by Amazon S3 to encode object keys in the response.

    " + "smithy.api#documentation": "

    When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

    " } }, - "Contents": { - "target": "com.amazonaws.s3#ObjectList", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

    Metadata about each object returned.

    ", - "smithy.api#xmlFlattened": {} + "smithy.api#documentation": "

    Keys that begin with the indicated prefix.

    " } }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", + "Marker": { + "target": "com.amazonaws.s3#Marker", "traits": { - "smithy.api#documentation": "

    All of the keys rolled up in a common prefix count as a single return when calculating 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 occurrence of the string specified by the delimiter.

    \n \n

    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

    \n \n

    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

    ", - "smithy.api#xmlFlattened": {} + "smithy.api#documentation": "

    Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

    " } }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", "traits": { - "smithy.api#documentation": "

    The maximum number of keys returned in the response body.

    " + "smithy.api#documentation": "

    Encoding type used by Amazon S3 to encode object keys in the response.

    " } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", "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.

    " + "smithy.api#documentation": "

    All of the keys rolled up in a common prefix count as a single return when calculating 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 occurrence of the string specified by the delimiter.

    \n \n

    CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

    \n \n

    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

    ", + "smithy.api#xmlFlattened": {} } } } @@ -6516,11 +7019,18 @@ "com.amazonaws.s3#ListObjectsRequest": { "type": "structure", "members": { - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#documentation": "

    Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

    ", - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "

    Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

    ", + "smithy.api#httpQuery": "max-keys" + } + }, + "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" } }, "Marker": { @@ -6537,32 +7047,32 @@ "smithy.api#httpQuery": "prefix" } }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

    A delimiter is a character you use to group keys.

    ", + "smithy.api#httpQuery": "delimiter" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The name of the bucket containing the objects.

    ", + "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": {} } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#httpQuery": "encoding-type" - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "

    Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

    ", - "smithy.api#httpQuery": "max-keys" + "smithy.api#documentation": "

    Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

    ", + "smithy.api#httpHeader": "x-amz-request-payer" } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", "traits": { - "smithy.api#documentation": "

    A delimiter is a character you use to group keys.

    ", - "smithy.api#httpQuery": "delimiter" + "smithy.api#httpQuery": "encoding-type" } } } @@ -6581,7 +7091,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your 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 have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default 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 Resources.

    \n \n

    This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to 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#documentation": "

    Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your 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 have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default 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 Resources.

    \n \n

    This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to 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", @@ -6597,47 +7107,34 @@ "com.amazonaws.s3#ListObjectsV2Output": { "type": "structure", "members": { - "StartAfter": { - "target": "com.amazonaws.s3#StartAfter", - "traits": { - "smithy.api#documentation": "

    If StartAfter was sent with the request, it is included in the response.

    " - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

    \t\n Keys that begin with the indicated prefix.

    " - } - }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

    \n \n

    A response can contain CommonPrefixes only if you specify a delimiter.

    \n \n

    \n CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

    \n \n

    \n CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

    \n \n

    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

    ", - "smithy.api#xmlFlattened": {} + "smithy.api#documentation": "

    Causes keys that contain the same string between the prefix and the first occurrence of the\n delimiter to be rolled up into a single result element in the CommonPrefixes collection.\n These rolled-up keys are not returned elsewhere in the response. Each rolled-up result\n counts as only one return against the MaxKeys value.

    " } }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#documentation": "

    Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

    " + "smithy.api#documentation": "

    Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

    " } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "Name": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Causes keys that contain the same string between the prefix and the first occurrence of the\n delimiter to be rolled up into a single result element in the CommonPrefixes collection.\n These rolled-up keys are not returned elsewhere in the response. Each rolled-up result\n counts as only one return against the MaxKeys value.

    " + "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.

    " } }, - "KeyCount": { - "target": "com.amazonaws.s3#KeyCount", + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", "traits": { - "smithy.api#documentation": "

    KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

    " + "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 response, and returns encoded key name values in the following response elements:

    \n \n

    \n Delimiter, Prefix, Key, and StartAfter.

    " } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "

    Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

    " + "smithy.api#documentation": "

    \t\n If ContinuationToken was sent with the request, it is included in the response.

    " } }, "Contents": { @@ -6647,16 +7144,17 @@ "smithy.api#xmlFlattened": {} } }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", "traits": { - "smithy.api#documentation": "

    \t\n If ContinuationToken was sent with the request, it is included in the response.

    " + "smithy.api#documentation": "

    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

    \n \n

    A response can contain CommonPrefixes only if you specify a delimiter.

    \n \n

    \n CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

    \n \n

    \n CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

    \n \n

    For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

    ", + "smithy.api#xmlFlattened": {} } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "StartAfter": { + "target": "com.amazonaws.s3#StartAfter", "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 response, and returns encoded key name values in the following response elements:

    \n \n

    \n Delimiter, Prefix, Key, and StartAfter.

    " + "smithy.api#documentation": "

    If StartAfter was sent with the request, it is included in the response.

    " } }, "NextContinuationToken": { @@ -6665,10 +7163,22 @@ "smithy.api#documentation": "

    \n NextContinuationToken is sent when isTruncated is true, which means\n 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

    " } }, - "Name": { - "target": "com.amazonaws.s3#BucketName", + "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 to 1,000 key names. The response might contain fewer keys but will never contain more.

    " + } + }, + "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 than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

    " + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

    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 using 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#documentation": "

    \t\n Keys that begin with the indicated prefix.

    " } } } @@ -6676,32 +7186,39 @@ "com.amazonaws.s3#ListObjectsV2Request": { "type": "structure", "members": { - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "

    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

    ", - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "

    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

    ", + "smithy.api#httpQuery": "continuation-token" } }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

    ", - "smithy.api#httpQuery": "max-keys" + "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" } }, - "StartAfter": { - "target": "com.amazonaws.s3#StartAfter", + "FetchOwner": { + "target": "com.amazonaws.s3#FetchOwner", "traits": { - "smithy.api#documentation": "

    StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

    ", - "smithy.api#httpQuery": "start-after" + "smithy.api#documentation": "

    The owner field is not present in listV2 by default, if you want to return owner field with\n each key in the result then set the fetch owner field to true.

    ", + "smithy.api#httpQuery": "fetch-owner" + } + }, + "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" } }, - "FetchOwner": { - "target": "com.amazonaws.s3#FetchOwner", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "

    The owner field is not present in listV2 by default, if you want to return owner field with\n each key in the result then set the fetch owner field to true.

    ", - "smithy.api#httpQuery": "fetch-owner" + "smithy.api#documentation": "

    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

    ", + "smithy.api#httpHeader": "x-amz-request-payer" } }, "Prefix": { @@ -6711,33 +7228,33 @@ "smithy.api#httpQuery": "prefix" } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "StartAfter": { + "target": "com.amazonaws.s3#StartAfter", "traits": { - "smithy.api#documentation": "

    A delimiter is a character you use to group keys.

    ", - "smithy.api#httpQuery": "delimiter" + "smithy.api#documentation": "

    StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

    ", + "smithy.api#httpQuery": "start-after" } }, "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 using 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#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": {} } }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "

    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

    ", - "smithy.api#httpQuery": "continuation-token" + "smithy.api#documentation": "

    A delimiter is a character you use to group keys.

    ", + "smithy.api#httpQuery": "delimiter" } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#documentation": "

    Encoding type used by Amazon S3 to encode object keys in the response.

    ", - "smithy.api#httpQuery": "encoding-type" + "smithy.api#documentation": "

    Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

    ", + "smithy.api#httpQuery": "max-keys" } } } @@ -6751,7 +7268,7 @@ "target": "com.amazonaws.s3#ListPartsOutput" }, "traits": { - "smithy.api#documentation": "

    Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

    \n \n

    For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

    \n \n

    For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

    \n \n

    The following operations are related to ListParts:

    \n ", + "smithy.api#documentation": "

    Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

    \n \n

    For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

    \n \n

    For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

    \n \n

    The following operations are related to ListParts:

    \n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?x-id=ListParts", @@ -6762,10 +7279,17 @@ "com.amazonaws.s3#ListPartsOutput": { "type": "structure", "members": { - "Initiator": { - "target": "com.amazonaws.s3#Initiator", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "

    Container element that identifies who initiated the multipart upload. If the initiator is an\n AWS account, this element provides the same information as the Owner element.\n If the initiator is an IAM User, this element provides the user ARN and display\n name.

    " + "smithy.api#documentation": "

    Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

    " + } + }, + "AbortRuleId": { + "target": "com.amazonaws.s3#AbortRuleId", + "traits": { + "smithy.api#documentation": "

    This header is returned along with the x-amz-abort-date header. It identifies\n applicable lifecycle configuration rule that defines the action to abort incomplete\n multipart uploads.

    ", + "smithy.api#httpHeader": "x-amz-abort-rule-id" } }, "Owner": { @@ -6774,8 +7298,8 @@ "smithy.api#documentation": "

    \t\n Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

    " } }, - "PartNumberMarker": { - "target": "com.amazonaws.s3#PartNumberMarker", + "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 the value to use for the part-number-marker request parameter in a subsequent request.

    " } @@ -6786,43 +7310,28 @@ "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    " } }, - "MaxParts": { - "target": "com.amazonaws.s3#MaxParts", - "traits": { - "smithy.api#documentation": "

    Maximum number of parts that were allowed in the response.

    " - } - }, - "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" - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", "traits": { - "smithy.api#documentation": "

    Upload ID identifying the multipart upload whose parts are being listed.

    " + "smithy.api#documentation": "

    When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

    " } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Initiator": { + "target": "com.amazonaws.s3#Initiator", "traits": { - "smithy.api#documentation": "

    Name of the bucket to which the multipart upload was initiated.

    " + "smithy.api#documentation": "

    Container element that identifies who initiated the multipart upload. If the initiator is an\n AWS account, this element provides the same information as the Owner element.\n If the initiator is an IAM User, this element provides the user ARN and display\n name.

    " } }, - "AbortRuleId": { - "target": "com.amazonaws.s3#AbortRuleId", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "

    This header is returned along with the x-amz-abort-date header. It identifies\n applicable lifecycle configuration rule that defines the action to abort incomplete\n multipart uploads.

    ", - "smithy.api#httpHeader": "x-amz-abort-rule-id" + "smithy.api#httpHeader": "x-amz-request-charged" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", "traits": { - "smithy.api#documentation": "

    Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

    " + "smithy.api#documentation": "

    Maximum number of parts that were allowed in the response.

    " } }, "AbortDate": { @@ -6832,16 +7341,18 @@ "smithy.api#httpHeader": "x-amz-abort-date" } }, - "NextPartNumberMarker": { - "target": "com.amazonaws.s3#NextPartNumberMarker", + "Parts": { + "target": "com.amazonaws.s3#Parts", "traits": { - "smithy.api#documentation": "

    When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

    " + "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" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "

    The name of the bucket to which the multipart upload was initiated.

    " } }, "IsTruncated": { @@ -6849,24 +7360,22 @@ "traits": { "smithy.api#documentation": "

    \t\n Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

    " } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

    Upload ID identifying the multipart upload whose parts are being listed.

    " + } } } }, "com.amazonaws.s3#ListPartsRequest": { "type": "structure", "members": { - "PartNumberMarker": { - "target": "com.amazonaws.s3#PartNumberMarker", - "traits": { - "smithy.api#documentation": "

    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

    ", - "smithy.api#httpQuery": "part-number-marker" - } - }, - "MaxParts": { - "target": "com.amazonaws.s3#MaxParts", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "

    Sets the maximum number of parts to return.

    ", - "smithy.api#httpQuery": "max-parts" + "smithy.api#httpHeader": "x-amz-request-payer" } }, "UploadId": { @@ -6877,27 +7386,42 @@ "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    ", + "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": {} } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "

    Sets the maximum number of parts to return.

    ", + "smithy.api#httpQuery": "max-parts" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", + "traits": { + "smithy.api#documentation": "

    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

    ", + "smithy.api#httpQuery": "part-number-marker" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    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 using 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#documentation": "

    Object key for which the multipart upload was initiated.

    ", "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" + } } } }, @@ -6910,6 +7434,12 @@ "com.amazonaws.s3#LoggingEnabled": { "type": "structure", "members": { + "TargetGrants": { + "target": "com.amazonaws.s3#TargetGrants", + "traits": { + "smithy.api#documentation": "

    Container for granting information.

    " + } + }, "TargetBucket": { "target": "com.amazonaws.s3#TargetBucket", "traits": { @@ -6923,12 +7453,6 @@ "smithy.api#documentation": "

    A prefix for all log object keys. If you store log files from multiple Amazon S3\n buckets in a single bucket, you can use a prefix to distinguish which log files\n came from which bucket.

    ", "smithy.api#required": {} } - }, - "TargetGrants": { - "target": "com.amazonaws.s3#TargetGrants", - "traits": { - "smithy.api#documentation": "

    Container for granting information.

    " - } } }, "traits": { @@ -7007,17 +7531,17 @@ "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.

    " } + }, + "Name": { + "target": "com.amazonaws.s3#MetadataKey", + "traits": { + "smithy.api#documentation": "

    Name of the Object.

    " + } } }, "traits": { @@ -7033,17 +7557,17 @@ "com.amazonaws.s3#Metrics": { "type": "structure", "members": { - "EventThreshold": { - "target": "com.amazonaws.s3#ReplicationTimeValue", + "Status": { + "target": "com.amazonaws.s3#MetricsStatus", "traits": { - "smithy.api#documentation": "

    \n A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.\n

    ", + "smithy.api#documentation": "

    \n Specifies whether the replication metrics are enabled.\n

    ", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.s3#MetricsStatus", + "EventThreshold": { + "target": "com.amazonaws.s3#ReplicationTimeValue", "traits": { - "smithy.api#documentation": "

    \n Specifies whether the replication metrics are enabled.\n

    ", + "smithy.api#documentation": "

    \n A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.\n

    ", "smithy.api#required": {} } } @@ -7077,18 +7601,18 @@ "com.amazonaws.s3#MetricsConfiguration": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.s3#MetricsFilter", - "traits": { - "smithy.api#documentation": "

    Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).

    " - } - }, "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 objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).

    " + } } }, "traits": { @@ -7104,18 +7628,18 @@ "com.amazonaws.s3#MetricsFilter": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

    The prefix 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. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

    " } }, + "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": { @@ -7152,10 +7676,10 @@ "com.amazonaws.s3#MultipartUpload": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Initiator": { + "target": "com.amazonaws.s3#Initiator", "traits": { - "smithy.api#documentation": "

    Key of the object for which the multipart upload was initiated.

    " + "smithy.api#documentation": "

    Identifies who initiated the multipart upload.

    " } }, "UploadId": { @@ -7164,10 +7688,10 @@ "smithy.api#documentation": "

    Upload ID that identifies the multipart upload.

    " } }, - "Initiated": { - "target": "com.amazonaws.s3#Initiated", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    Date and time at which the multipart upload was initiated.

    " + "smithy.api#documentation": "

    Key of the object for which the multipart upload was initiated.

    " } }, "Owner": { @@ -7176,17 +7700,17 @@ "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.

    " - } - }, "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { "smithy.api#documentation": "

    The class of storage used to store the object.

    " } + }, + "Initiated": { + "target": "com.amazonaws.s3#Initiated", + "traits": { + "smithy.api#documentation": "

    Date and time at which the multipart upload was initiated.

    " + } } }, "traits": { @@ -7261,17 +7785,17 @@ "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 associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the 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.

    " } + }, + "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 associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide.

    " + } } }, "traits": { @@ -7287,12 +7811,12 @@ "com.amazonaws.s3#NotificationConfiguration": { "type": "structure", "members": { - "LambdaFunctionConfigurations": { - "target": "com.amazonaws.s3#LambdaFunctionConfigurationList", + "TopicConfigurations": { + "target": "com.amazonaws.s3#TopicConfigurationList", "traits": { - "smithy.api#documentation": "

    Describes the AWS Lambda functions to invoke and the events for which to invoke them.

    ", + "smithy.api#documentation": "

    The topic to which notifications are sent and the events for which notifications are generated.

    ", "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "CloudFunctionConfiguration" + "smithy.api#xmlName": "TopicConfiguration" } }, "QueueConfigurations": { @@ -7302,13 +7826,13 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "QueueConfiguration" } - }, - "TopicConfigurations": { - "target": "com.amazonaws.s3#TopicConfigurationList", + }, + "LambdaFunctionConfigurations": { + "target": "com.amazonaws.s3#LambdaFunctionConfigurationList", "traits": { - "smithy.api#documentation": "

    The topic to which notifications are sent and the events for which notifications are generated.

    ", + "smithy.api#documentation": "

    Describes the AWS Lambda functions to invoke and the events for which to invoke them.

    ", "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "TopicConfiguration" + "smithy.api#xmlName": "CloudFunctionConfiguration" } } }, @@ -7339,34 +7863,28 @@ "com.amazonaws.s3#Object": { "type": "structure", "members": { - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

    The owner of the object

    " - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#ObjectStorageClass", + "Size": { + "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#documentation": "

    The class of storage used to store the object.

    " + "smithy.api#documentation": "

    Size in bytes of the object

    " } }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "

    The date the Object was Last Modified

    " + "smithy.api#documentation": "

    The entity tag is a hash of the object. The ETag reflects changes only to the\n contents of an object, not its metadata. The ETag may or may not be an MD5 digest of\n the object data. Whether or not it is depends on how the object was created and how it\n is encrypted as described below:

    \n
      \n
    • \n

      Objects created by the PUT Object, POST Object, or Copy operation, or through\n the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags\n that are an MD5 digest of their object data.

      \n
      • \n
    • \n

      Objects created by the PUT Object, POST Object, or Copy operation, or through\n the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have\n ETags that are not an MD5 digest of their object data.

      \n
      • \n
    • \n

      If an object is created by either the Multipart Upload or Part Copy operation,\n the ETag is not an MD5 digest, regardless of the method of encryption.

      \n
      • \n
    " } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "Owner": { + "target": "com.amazonaws.s3#Owner", "traits": { - "smithy.api#documentation": "

    The entity tag is an MD5 hash of the object. ETag reflects only changes\n to the contents of an object, not its metadata.

    " + "smithy.api#documentation": "

    The owner of the object

    " } }, - "Size": { - "target": "com.amazonaws.s3#Size", + "StorageClass": { + "target": "com.amazonaws.s3#ObjectStorageClass", "traits": { - "smithy.api#documentation": "

    Size in bytes of the object

    " + "smithy.api#documentation": "

    The class of storage used to store the object.

    " } }, "Key": { @@ -7374,6 +7892,12 @@ "traits": { "smithy.api#documentation": "

    The name that you assign to an object. You use the object key to retrieve the object.

    " } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

    The date the Object was Last Modified

    " + } } }, "traits": { @@ -7594,6 +8118,20 @@ "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": { @@ -7618,6 +8156,9 @@ }, { "value": "DEEP_ARCHIVE" + }, + { + "value": "OUTPOSTS" } ] } @@ -7625,46 +8166,40 @@ "com.amazonaws.s3#ObjectVersion": { "type": "structure", "members": { - "StorageClass": { - "target": "com.amazonaws.s3#ObjectVersionStorageClass", - "traits": { - "smithy.api#documentation": "

    The class of storage used to store the object.

    " - } - }, - "IsLatest": { - "target": "com.amazonaws.s3#IsLatest", + "Size": { + "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#documentation": "

    Specifies whether the object is (true) or is not (false) the latest version of an object.

    " + "smithy.api#documentation": "

    Size in bytes of the object.

    " } }, - "Owner": { - "target": "com.amazonaws.s3#Owner", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    Specifies the owner of the object.

    " + "smithy.api#documentation": "

    The object key.

    " } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "StorageClass": { + "target": "com.amazonaws.s3#ObjectVersionStorageClass", "traits": { - "smithy.api#documentation": "

    The entity tag is an MD5 hash of that version of the object.

    " + "smithy.api#documentation": "

    The class of storage used to store the object.

    " } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "Owner": { + "target": "com.amazonaws.s3#Owner", "traits": { - "smithy.api#documentation": "

    Version ID of an object.

    " + "smithy.api#documentation": "

    Specifies the owner of the object.

    " } }, - "Size": { - "target": "com.amazonaws.s3#Size", + "IsLatest": { + "target": "com.amazonaws.s3#IsLatest", "traits": { - "smithy.api#documentation": "

    Size in bytes of the object.

    " + "smithy.api#documentation": "

    Specifies whether the object is (true) or is not (false) the latest version of an object.

    " } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "

    The object key.

    " + "smithy.api#documentation": "

    The entity tag is an MD5 hash of that version of the object.

    " } }, "LastModified": { @@ -7672,6 +8207,12 @@ "traits": { "smithy.api#documentation": "

    Date and time the object was last modified.

    " } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

    Version ID of an object.

    " + } } }, "traits": { @@ -7714,17 +8255,17 @@ "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.

    " } + }, + "CSV": { + "target": "com.amazonaws.s3#CSVOutput", + "traits": { + "smithy.api#documentation": "

    Describes the serialization of CSV-encoded Select results.

    " + } } }, "traits": { @@ -7761,6 +8302,43 @@ ] } }, + "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": {}, @@ -7771,16 +8349,10 @@ "com.amazonaws.s3#Part": { "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", + "Size": { + "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#documentation": "

    Part number identifying the part. This is a positive integer between 1 and 10,000.

    " + "smithy.api#documentation": "

    Size in bytes of the uploaded part data.

    " } }, "LastModified": { @@ -7789,10 +8361,16 @@ "smithy.api#documentation": "

    Date and time at which the part was uploaded.

    " } }, - "Size": { - "target": "com.amazonaws.s3#Size", + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#documentation": "

    Size in bytes of the uploaded part data.

    " + "smithy.api#documentation": "

    Part number identifying the part. This is a positive integer between 1 and 10,000.

    " + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

    Entity tag returned when the part was uploaded.

    " } } }, @@ -7931,11 +8509,11 @@ "com.amazonaws.s3#PublicAccessBlockConfiguration": { "type": "structure", "members": { - "RestrictPublicBuckets": { + "BlockPublicPolicy": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#documentation": "

    Specifies whether Amazon S3 should restrict public bucket policies for this bucket.\n Setting this element to TRUE restricts access to this bucket to only AWS services\n and authorized users within this account if the bucket has a public policy.

    \n

    Enabling this setting doesn't affect previously stored bucket policies, except that public\n and cross-account access within any public bucket policy, including non-public delegation to\n specific accounts, is blocked.

    ", - "smithy.api#xmlName": "RestrictPublicBuckets" + "smithy.api#documentation": "

    Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting\n this 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" } }, "BlockPublicAcls": { @@ -7945,18 +8523,18 @@ "smithy.api#xmlName": "BlockPublicAcls" } }, - "IgnorePublicAcls": { + "RestrictPublicBuckets": { "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\n on 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" + "smithy.api#documentation": "

    Specifies whether Amazon S3 should restrict public bucket policies for this bucket.\n Setting this element to TRUE restricts access to this bucket to only AWS services\n and authorized users within this account if the bucket has a public policy.

    \n

    Enabling this setting doesn't affect previously stored bucket policies, except that public\n and cross-account access within any public bucket policy, including non-public delegation to\n specific accounts, is blocked.

    ", + "smithy.api#xmlName": "RestrictPublicBuckets" } }, - "BlockPublicPolicy": { + "IgnorePublicAcls": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#documentation": "

    Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting\n this 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" + "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\n on 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" } } }, @@ -7970,7 +8548,7 @@ "target": "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a 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 s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    The Transfer Acceleration state of a bucket can be set to one of the following two values:

    \n
      \n
    • \n

      Enabled – Enables accelerated data transfers to the bucket.

      \n
      • \n
    • \n

      Suspended – Disables accelerated data transfers to the bucket.

      \n
      • \n
    \n \n \n

    The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.

    \n \n

    After setting the Transfer Acceleration state of a bucket to Enabled, it might take up 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 not contain periods (\".\").

    \n \n

    For more information about transfer acceleration, see Transfer Acceleration.

    \n \n

    The following operations are related to PutBucketAccelerateConfiguration:

    \n ", + "smithy.api#documentation": "

    Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a 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 s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n

    The Transfer Acceleration state of a bucket can be set to one of the following two values:

    \n
      \n
    • \n

      Enabled – Enables accelerated data transfers to the bucket.

      \n
      • \n
    • \n

      Suspended – Disables accelerated data transfers to the bucket.

      \n
      • \n
    \n \n \n

    The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.

    \n \n

    After setting the Transfer Acceleration state of a bucket to Enabled, it might take up 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 not contain periods (\".\").

    \n \n

    For more information about transfer acceleration, see Transfer Acceleration.

    \n \n

    The following operations are related to PutBucketAccelerateConfiguration:

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?accelerate", @@ -7984,11 +8562,18 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Name of the bucket for which the accelerate configuration is set.

    ", + "smithy.api#documentation": "

    The name of the bucket for which the accelerate configuration is set.

    ", "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" + } + }, "AccelerateConfiguration": { "target": "com.amazonaws.s3#AccelerateConfiguration", "traits": { @@ -8005,7 +8590,7 @@ "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\n ACLs. To set the ACL of a bucket, you must have WRITE_ACP\n permission.

    \n \n

    You can use one of the following two ways to set a bucket's permissions:

    \n
      \n
    • \n

      Specify the ACL in the request body

      \n
      • \n
    • \n

      Specify permissions using request headers

      \n
      • \n
    \n \n \n

    You cannot specify access permission using both the body and the request headers.

    \n     \n \n

    Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

    \n \n \n

    \n Access Permissions\n

    \n

    You can set access permissions using one of the following methods:

    \n
      \n
    • \n

      Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a\n predefined set of grantees and permissions. Specify the canned ACL name as the value\n of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups)\n who will receive the permission. If you use these ACL-specific headers, you cannot\n use the x-amz-acl header to set a canned ACL. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview.

      \n

      You specify each grantee as a type=value pair, where the type is one of the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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-write header grants\n create, overwrite, and delete objects permission to LogDelivery group predefined by\n Amazon S3 and two AWS accounts identified by their email addresses.

      \n

      \n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\", id=\"555566667777\"\n \n

      \n \n
      • \n
    \n

    You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

    \n

    \n Grantee Values\n

    \n

    You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

    \n
      \n
    • \n

      By the person's ID:

      \n

      \n <>ID<><>GranteesEmail<>\n \n

      \n

      DisplayName is optional and ignored in the request

      \n
      • \n
    • \n

      By URI:

      \n

      \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

      \n
      • \n
    • \n

      By Email address:

      \n

      \n <>Grantees@email.com<>lt;/Grantee>\n

      \n

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.\n

      \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 \n \n

    \n Related Resources\n

    \n ", + "smithy.api#documentation": "

    Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using\n ACLs. To set the ACL of a bucket, you must have WRITE_ACP\n permission.

    \n \n

    You can use one of the following two ways to set a bucket's permissions:

    \n
      \n
    • \n

      Specify the ACL in the request body

      \n
      • \n
    • \n

      Specify permissions using request headers

      \n
      • \n
    \n \n \n

    You cannot specify access permission using both the body and the request headers.

    \n     \n \n

    Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

    \n \n \n

    \n Access Permissions\n

    \n

    You can set access permissions using one of the following methods:

    \n
      \n
    • \n

      Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a\n predefined set of grantees and permissions. Specify the canned ACL name as the value\n of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups)\n who will receive the permission. If you use these ACL-specific headers, you cannot\n use the x-amz-acl header to set a canned ACL. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview.

      \n

      You specify each grantee as a type=value pair, where the type is one of the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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-write header grants\n create, overwrite, and delete objects permission to LogDelivery group predefined by\n Amazon S3 and two AWS accounts identified by their email addresses.

      \n

      \n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\", id=\"555566667777\"\n \n

      \n \n
      • \n
    \n

    You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

    \n

    \n Grantee Values\n

    \n

    You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

    \n
      \n
    • \n

      By the person's ID:

      \n

      \n <>ID<><>GranteesEmail<>\n \n

      \n

      DisplayName is optional and ignored in the request

      \n
      • \n
    • \n

      By URI:

      \n

      \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

      \n
      • \n
    • \n

      By Email address:

      \n

      \n <>Grantees@email.com<>lt;/Grantee>\n

      \n

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.\n

      \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 \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?acl", @@ -8017,18 +8602,19 @@ "com.amazonaws.s3#PutBucketAclRequest": { "type": "structure", "members": { - "AccessControlPolicy": { - "target": "com.amazonaws.s3#AccessControlPolicy", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "

    Contains the elements that set the ACL permissions for an object per grantee.

    ", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Allows grantee to list the objects in the bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-read" + "smithy.api#documentation": "

    The bucket to which to apply the ACL.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "GrantReadACP": { @@ -8038,6 +8624,13 @@ "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" + } + }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { @@ -8055,33 +8648,32 @@ "smithy.api#httpHeader": "x-amz-acl" } }, - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-write" + "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", "traits": { - "smithy.api#documentation": "

    The bucket to which to apply the ACL.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Contains the elements that set the ACL permissions for an object per grantee.

    ", + "smithy.api#httpPayload": {} } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "

    Allows grantee to list the objects in the bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-read" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "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" } } } @@ -8092,7 +8684,7 @@ "target": "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Sets an analytics configuration for the bucket (specified by the analytics configuration 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 Analysis.

    \n \n \n

    You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example 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 s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n \n

    \n Special Errors\n

    \n
      \n
    • \n
        \n
      • \n

        \n HTTP Error: HTTP 400 Bad Request \n

        \n
        • \n
      • \n

        \n Code: InvalidArgument \n

        \n
        • \n
      • \n

        \n Cause: Invalid argument. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n HTTP Error: HTTP 400 Bad Request \n

        \n
        • \n
      • \n

        \n Code: TooManyConfigurations \n

        \n
        • \n
      • \n

        \n Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n HTTP Error: HTTP 403 Forbidden \n

        \n
        • \n
      • \n

        \n Code: AccessDenied \n

        \n
        • \n
      • \n

        \n Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket. \n

        \n
        • \n
      \n
      • \n
    \n \n \n \n \n \n \n

    \n Related Resources\n

    \n
      \n
    • \n

      \n \n

      \n
      • \n
    • \n

      \n \n

      \n
      • \n
    • \n

      \n \n

      \n
      • \n
    ", + "smithy.api#documentation": "

    Sets an analytics configuration for the bucket (specified by the analytics configuration 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 Analysis.

    \n \n \n

    You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example 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 s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner 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 Resources.

    \n \n \n

    \n Special Errors\n

    \n
      \n
    • \n
        \n
      • \n

        \n HTTP Error: HTTP 400 Bad Request \n

        \n
        • \n
      • \n

        \n Code: InvalidArgument \n

        \n
        • \n
      • \n

        \n Cause: Invalid argument. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n HTTP Error: HTTP 400 Bad Request \n

        \n
        • \n
      • \n

        \n Code: TooManyConfigurations \n

        \n
        • \n
      • \n

        \n Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n HTTP Error: HTTP 403 Forbidden \n

        \n
        • \n
      • \n

        \n Code: AccessDenied \n

        \n
        • \n
      • \n

        \n Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket. \n

        \n
        • \n
      \n
      • \n
    \n \n \n \n \n \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?analytics", @@ -8111,14 +8703,6 @@ "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": {} - } - }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -8126,6 +8710,21 @@ "smithy.api#httpLabel": {}, "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" + } } } }, @@ -8135,7 +8734,7 @@ "target": "com.amazonaws.s3#PutBucketCorsRequest" }, "traits": { - "smithy.api#documentation": "

    Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

    \n

    To use this operation, you must be allowed to perform the s3:PutBucketCORS action. \n 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 requests.\n For example, you might want to enable a request whose origin is http://www.example.com to access your \n Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

    \n

    To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. \n The cors subresource is an XML document in which you configure rules that identify origins and the HTTP \n methods that can 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\n first 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
    • \n

      The request's Origin header must match AllowedOrigin\n elements.

      \n
      • \n
    • \n

      The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method header in case of a pre-flight\n OPTIONS request must be one of the AllowedMethod\n elements.

      \n
      • \n
    • \n

      Every header specified in the Access-Control-Request-Headers request header of a\n pre-flight request must match an AllowedHeader element.

      \n
      • \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#documentation": "

    Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

    \n

    To use this operation, you must be allowed to perform the s3:PutBucketCORS action. \n 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 requests.\n For example, you might want to enable a request whose origin is http://www.example.com to access your \n Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

    \n

    To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. \n The cors subresource is an XML document in which you configure rules that identify origins and the HTTP \n methods that can 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\n first 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
    • \n

      The request's Origin header must match AllowedOrigin\n elements.

      \n
      • \n
    • \n

      The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method header in case of a pre-flight\n OPTIONS request must be one of the AllowedMethod\n elements.

      \n
      • \n
    • \n

      Every header specified in the Access-Control-Request-Headers request header of a\n pre-flight request must match an AllowedHeader element.

      \n
      • \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", @@ -8147,11 +8746,11 @@ "com.amazonaws.s3#PutBucketCorsRequest": { "type": "structure", "members": { - "CORSConfiguration": { - "target": "com.amazonaws.s3#CORSConfiguration", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "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#documentation": "

    Specifies the bucket impacted by the corsconfiguration.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -8165,13 +8764,20 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "CORSConfiguration": { + "target": "com.amazonaws.s3#CORSConfiguration", "traits": { - "smithy.api#documentation": "

    Specifies the bucket impacted by the corsconfiguration.

    ", - "smithy.api#httpLabel": {}, + "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": {} } + }, + "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" + } } } }, @@ -8181,7 +8787,7 @@ "target": "com.amazonaws.s3#PutBucketEncryptionRequest" }, "traits": { - "smithy.api#documentation": "

    This implementation of the PUT operation uses the encryption subresource to set the default encryption \n state of an existing bucket.

    \n

    This implementation of the PUT operation sets default encryption for a\n bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer\n master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

    \n \n

    This operation requires AWS Signature Version 4. For more information, see \n Authenticating Requests (AWS Signature Version 4).\n

    \n     \n

    To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. \n The bucket owner has this permission by default. The bucket owner can grant this permission to others. \n For more information about permissions, see \n Permissions Related to Bucket Subresource Operations \n and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. \n

    \n \n

    \n Related Resources\n

    \n ", + "smithy.api#documentation": "

    This implementation of the PUT operation uses the encryption subresource to set the default encryption \n state of an existing bucket.

    \n

    This implementation of the PUT operation sets default encryption for a\n bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer\n master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

    \n \n

    This operation requires AWS Signature Version 4. For more information, see \n Authenticating Requests (AWS Signature Version 4).\n

    \n     \n

    To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. \n The bucket owner has this permission by default. The bucket owner can grant this permission to others. \n For more information about permissions, see \n Permissions Related to Bucket Subresource Operations \n and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. \n

    \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?encryption", @@ -8193,11 +8799,11 @@ "com.amazonaws.s3#PutBucketEncryptionRequest": { "type": "structure", "members": { - "ServerSideEncryptionConfiguration": { - "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} + "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" } }, "ContentMD5": { @@ -8217,6 +8823,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "ServerSideEncryptionConfiguration": { + "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -8226,7 +8839,7 @@ "target": "com.amazonaws.s3#PutBucketInventoryConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    This implementation of the PUT operation adds an inventory configuration (identified \n by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. \n

    \n

    Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published \n to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the \n inventory flat file is stored is called the destination bucket. The destination bucket must be in the same \n AWS Region as the source bucket.

    \n

    When you configure an inventory for a source bucket, you specify the destination bucket\n where you want the inventory to be stored, and 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. For more information, see \n Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.

    \n \n

    You must create a bucket policy on the destination bucket to grant\n 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 s3:PutInventoryConfiguration action. The bucket \n owner has this permission by default and can grant this permission to others. For more information about permissions, see \n Permissions Related to \n Bucket Subresource Operations and Managing Access Permissions to Your \n Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

    \n \n

    \n Special Errors\n

    \n
      \n
    • \n

      \n HTTP 400 Bad Request Error\n

      \n
        \n
      • \n

        \n Code: InvalidArgument

        \n
        • \n
      • \n

        \n Cause: Invalid Argument

        \n
        • \n
      \n
      • \n
    • \n

      \n HTTP 400 Bad Request Error\n

      \n
        \n
      • \n

        \n Code: TooManyConfigurations

        \n
        • \n
      • \n

        \n Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration \n limit.

        \n
        • \n
      \n
      • \n
    • \n

      \n HTTP 403 Forbidden Error\n

      \n
        \n
      • \n

        \n Code: AccessDenied

        \n
        • \n
      • \n

        \n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration bucket\n permission to set the configuration on the bucket.

        \n
        • \n
      \n
      • \n
    \n \n

    \n Related Resources\n

    \n ", + "smithy.api#documentation": "

    This implementation of the PUT operation adds an inventory configuration (identified \n by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. \n

    \n

    Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published \n to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the \n inventory flat file is stored is called the destination bucket. The destination bucket must be in the same \n AWS Region as the source bucket.

    \n

    When you configure an inventory for a source bucket, you specify the destination bucket\n where you want the inventory to be stored, and 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. For more information, see \n Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.

    \n \n

    You must create a bucket policy on the destination bucket to grant\n 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 s3:PutInventoryConfiguration action. The bucket \n owner has this permission by default and can grant this permission to others. For more information about permissions, see \n Permissions Related to \n Bucket Subresource Operations and Managing Access Permissions to Your \n Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

    \n \n

    \n Special Errors\n

    \n
      \n
    • \n

      \n HTTP 400 Bad Request Error\n

      \n
        \n
      • \n

        \n Code: InvalidArgument

        \n
        • \n
      • \n

        \n Cause: Invalid Argument

        \n
        • \n
      \n
      • \n
    • \n

      \n HTTP 400 Bad Request Error\n

      \n
        \n
      • \n

        \n Code: TooManyConfigurations

        \n
        • \n
      • \n

        \n Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration \n limit.

        \n
        • \n
      \n
      • \n
    • \n

      \n HTTP 403 Forbidden Error\n

      \n
        \n
      • \n

        \n Code: AccessDenied

        \n
        • \n
      • \n

        \n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration bucket\n permission to set the configuration on the bucket.

        \n
        • \n
      \n
      • \n
    \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?inventory", @@ -8237,14 +8850,6 @@ "com.amazonaws.s3#PutBucketInventoryConfigurationRequest": { "type": "structure", "members": { - "InventoryConfiguration": { - "target": "com.amazonaws.s3#InventoryConfiguration", - "traits": { - "smithy.api#documentation": "

    Specifies the inventory configuration.

    ", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -8260,6 +8865,21 @@ "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" + } } } }, @@ -8269,7 +8889,7 @@ "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.

    \n \n \n

    Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

    \n     \n \n \n

    \n Rules \n

    \n

    You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:

    \n \n
      \n
    • \n

      Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.

      \n
      • \n
    • \n

      Status whether the rule is in effect.

      \n
      • \n
    • \n

      One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

      \n
      • \n
    \n \n

    For more information, see Object 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 subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

    \n \n

    You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

    \n \n
      \n
    • \n

      s3:DeleteObject

      \n
      • \n
    • \n

      s3:DeleteObjectVersion

      \n
      • \n
    • \n

      s3:PutLifecycleConfiguration

      \n
      • \n
    \n \n \n

    For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

    \n \n

    The following are related to PutBucketLifecycleConfiguration:

    \n ", + "smithy.api#documentation": "

    Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.

    \n \n \n

    Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

    \n     \n \n \n

    \n Rules \n

    \n

    You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:

    \n \n
      \n
    • \n

      Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.

      \n
      • \n
    • \n

      Status whether the rule is in effect.

      \n
      • \n
    • \n

      One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

      \n
      • \n
    \n \n

    For more information, see Object 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 subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

    \n \n

    You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

    \n \n
      \n
    • \n

      s3:DeleteObject

      \n
      • \n
    • \n

      s3:DeleteObjectVersion

      \n
      • \n
    • \n

      s3:PutLifecycleConfiguration

      \n
      • \n
    \n \n \n

    For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

    \n \n

    The following are related to PutBucketLifecycleConfiguration:

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?lifecycle", @@ -8281,6 +8901,13 @@ "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest": { "type": "structure", "members": { + "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": {} + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -8289,11 +8916,11 @@ "smithy.api#required": {} } }, - "LifecycleConfiguration": { - "target": "com.amazonaws.s3#BucketLifecycleConfiguration", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Container for lifecycle rules. You can add as many as 1,000 rules.

    ", - "smithy.api#httpPayload": {} + "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" } } } @@ -8304,7 +8931,7 @@ "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 modify the logging parameters. All logs are saved to buckets in the same AWS Region as the 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 request elements) in the following ways:

    \n \n
      \n
    • \n

      By the person's ID:

      \n

      \n <>ID<><>GranteesEmail<>\n \n

      \n

      DisplayName is optional and ignored in the request.

      \n
      • \n
    • \n

      By Email address:

      \n

      \n <>Grantees@email.com<>\n

      \n

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

      \n
      • \n
    • \n

      By URI:

      \n

      \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

      \n
      • \n
    \n \n \n

    To enable logging, you use LoggingEnabled and its children request elements. To disable 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 information about returning the logging status of a bucket, see GetBucketLogging.

    \n \n

    The following operations are related to PutBucketLogging:

    \n ", + "smithy.api#documentation": "

    Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the 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 request elements) in the following ways:

    \n \n
      \n
    • \n

      By the person's ID:

      \n

      \n <>ID<><>GranteesEmail<>\n \n

      \n

      DisplayName is optional and ignored in the request.

      \n
      • \n
    • \n

      By Email address:

      \n

      \n <>Grantees@email.com<>\n

      \n

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

      \n
      • \n
    • \n

      By URI:

      \n

      \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

      \n
      • \n
    \n \n \n

    To enable logging, you use LoggingEnabled and its children request elements. To disable 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. \n For more 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", @@ -8316,6 +8943,21 @@ "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": {} + } + }, + "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" + } + }, "BucketLoggingStatus": { "target": "com.amazonaws.s3#BucketLoggingStatus", "traits": { @@ -8333,14 +8975,6 @@ "smithy.api#documentation": "

    The MD5 hash of the PutBucketLogging request body.

    ", "smithy.api#httpHeader": "Content-MD5" } - }, - "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": {} - } } } }, @@ -8350,7 +8984,7 @@ "target": "com.amazonaws.s3#PutBucketMetricsConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics 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\n Access Permissions to Your Amazon S3 Resources.

    \n \n

    For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

    \n \n

    The following operations are related to PutBucketMetricsConfiguration:

    \n \n \n \n \n \n \n \n

    \n GetBucketLifecycle has the following special error:

    \n
      \n
    • \n

      Error code: TooManyConfigurations\n

      \n
        \n
      • \n

        Description: You are attempting to create a new configuration but have already reached the\n 1,000-configuration limit.

        \n
        • \n
      • \n

        HTTP Status Code: HTTP 400 Bad Request

        \n
        • \n
      \n
      • \n
    ", + "smithy.api#documentation": "

    Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics 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\n Access Permissions to Your Amazon S3 Resources.

    \n \n

    For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

    \n \n

    The following operations are related to PutBucketMetricsConfiguration:

    \n \n \n \n \n \n \n \n

    \n GetBucketLifecycle has the following special error:

    \n
      \n
    • \n

      Error code: TooManyConfigurations\n

      \n
        \n
      • \n

        Description: You are attempting to create a new configuration but have already reached the\n 1,000-configuration limit.

        \n
        • \n
      • \n

        HTTP Status Code: HTTP 400 Bad Request

        \n
        • \n
      \n
      • \n
    ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?metrics", @@ -8361,6 +8995,13 @@ "com.amazonaws.s3#PutBucketMetricsConfigurationRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -8393,7 +9034,7 @@ "target": "com.amazonaws.s3#PutBucketNotificationConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

    Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

    \n \n

    Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

    \n \n

    By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

    \n \n

    \n \n

    \n

    \n \n

    \n

    This operation replaces the existing notification configuration with the configuration you include in the request body.

    \n \n

    After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

    \n \n

    You can disable notifications by adding the empty NotificationConfiguration element.

    \n \n

    By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

    \n \n \n

    The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add 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#documentation": "

    Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

    \n \n

    Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

    \n \n

    By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

    \n \n

    \n \n

    \n

    \n \n

    \n

    This operation replaces the existing notification configuration with the configuration you include in the request body.

    \n \n

    After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

    \n \n

    You can disable notifications by adding the empty NotificationConfiguration element.

    \n \n

    By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

    \n \n \n

    The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add 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", @@ -8404,6 +9045,13 @@ "com.amazonaws.s3#PutBucketNotificationConfigurationRequest": { "type": "structure", "members": { + "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" + } + }, "NotificationConfiguration": { "target": "com.amazonaws.s3#NotificationConfiguration", "traits": { @@ -8421,44 +9069,77 @@ } } }, - "com.amazonaws.s3#PutBucketPolicy": { + "com.amazonaws.s3#PutBucketOwnershipControls": { "type": "operation", "input": { - "target": "com.amazonaws.s3#PutBucketPolicyRequest" + "target": "com.amazonaws.s3#PutBucketOwnershipControlsRequest" }, "traits": { - "smithy.api#documentation": "

    Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

    \n \n

    If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

    \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.\n

    \n     \n \n \n

    For more information about bucket policies, see Using Bucket Policies and User Policies.

    \n \n

    The following operations are related to PutBucketPolicy:

    \n ", + "smithy.api#documentation": "

    Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:GetBucketOwnershipControls 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 GetBucketOwnershipControls:

    \n ", "smithy.api#http": { "method": "PUT", - "uri": "/{Bucket}?policy", + "uri": "/{Bucket}?ownershipControls", "code": 200 - }, - "smithy.api#httpChecksumRequired": {} + } } }, - "com.amazonaws.s3#PutBucketPolicyRequest": { + "com.amazonaws.s3#PutBucketOwnershipControlsRequest": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The name of the bucket.

    ", + "smithy.api#documentation": "

    The name of the Amazon S3 bucket whose OwnershipControls you want to set.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Policy": { - "target": "com.amazonaws.s3#Policy", + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

    The bucket policy as a JSON document.

    ", + "smithy.api#documentation": "

    The MD5 hash of the OwnershipControls request body.

    ", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "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": {} } }, - "ConfirmRemoveSelfBucketAccess": { - "target": "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

    ", - "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "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 the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

    \n \n

    If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

    \n \n \n

    As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.\n

    \n     \n \n \n

    For more information about bucket policies, see Using Bucket Policies and User 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": { + "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" } }, "ContentMD5": { @@ -8470,6 +9151,28 @@ "smithy.api#documentation": "

    The MD5 hash of the request body.

    ", "smithy.api#httpHeader": "Content-MD5" } + }, + "Policy": { + "target": "com.amazonaws.s3#Policy", + "traits": { + "smithy.api#documentation": "

    The bucket policy as a JSON document.

    ", + "smithy.api#required": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

    The name of the bucket.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "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 this bucket policy in the future.

    ", + "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" + } } } }, @@ -8479,7 +9182,7 @@ "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 iam:PassRole permission.

    \n     \n

    Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.

    \n \n \n

    A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.

    \n \n

    To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

    \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 perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your 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 encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.

    \n \n

    For information on PutBucketReplication errors, see ReplicationErrorCodeList\n

    \n \n \n

    The following operations are related to PutBucketReplication:

    \n ", + "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 iam:PassRole permission.

    \n     \n

    Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.

    \n \n \n

    A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.

    \n \n

    To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element.\n You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, \n you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

    \n \n

    The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that contain the Filter \n element for rules, and rules that specify S3 Replication Time Control (S3 RTC). In XML V2 replication configurations, Amazon S3 doesn't replicate delete markers. Therefore, you must set the \n DeleteMarkerReplication element to Disabled. For backward compatibility, Amazon S3 continues to support the XML V1 replication configuration.

    \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 perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your 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 encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.

    \n \n

    For information on PutBucketReplication errors, see List of replication-related error codes\n

    \n \n \n

    The following operations are related to PutBucketReplication:

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?replication", @@ -8491,12 +9194,11 @@ "com.amazonaws.s3#PutBucketReplicationRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Token": { + "target": "com.amazonaws.s3#ObjectLockToken", "traits": { - "smithy.api#documentation": "

    The name of the bucket

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    ", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" } }, "ReplicationConfiguration": { @@ -8506,6 +9208,13 @@ "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" + } + }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { @@ -8516,11 +9225,12 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "Token": { - "target": "com.amazonaws.s3#ObjectLockToken", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    ", - "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" + "smithy.api#documentation": "

    The name of the bucket

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -8531,7 +9241,7 @@ "target": "com.amazonaws.s3#PutBucketRequestPaymentRequest" }, "traits": { - "smithy.api#documentation": "

    Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

    \n \n

    The following operations are related to PutBucketRequestPayment:

    \n ", + "smithy.api#documentation": "

    Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

    \n \n

    The following operations are related to PutBucketRequestPayment:

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?requestPayment", @@ -8543,6 +9253,14 @@ "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": {} + } + }, "RequestPaymentConfiguration": { "target": "com.amazonaws.s3#RequestPaymentConfiguration", "traits": { @@ -8561,12 +9279,11 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    The bucket name.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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" } } } @@ -8577,7 +9294,7 @@ "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 up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.

    \n \n \n

    Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.

    \n     \n

    To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default 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 Resources.

    \n \n

    \n PutBucketTagging has the following special errors:

    \n
      \n
    • \n

      Error code: InvalidTagError\n

      \n \n
      • \n
    • \n

      Error code: MalformedXMLError\n

      \n
        \n
      • \n

        Description: The XML provided does not match the schema.

        \n
        • \n
      \n
      • \n
    • \n

      Error code: OperationAbortedError \n

      \n
        \n
      • \n

        Description: A conflicting conditional operation is currently in progress against this resource. Please try again.

        \n
        • \n
      \n
      • \n
    • \n

      Error code: InternalError\n

      \n
        \n
      • \n

        Description: The service was unable to apply the provided tag to the bucket.

        \n
        • \n
      \n
      • \n
    \n \n \n

    The following operations are related to PutBucketTagging:

    \n ", + "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 up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.

    \n \n \n

    Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.

    \n     \n

    To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default 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 Resources.

    \n \n

    \n PutBucketTagging has the following special errors:

    \n
      \n
    • \n

      Error code: InvalidTagError\n

      \n \n
      • \n
    • \n

      Error code: MalformedXMLError\n

      \n
        \n
      • \n

        Description: The XML provided does not match the schema.

        \n
        • \n
      \n
      • \n
    • \n

      Error code: OperationAbortedError \n

      \n
        \n
      • \n

        Description: A conflicting conditional operation is currently in progress against this resource. Please try again.

        \n
        • \n
      \n
      • \n
    • \n

      Error code: InternalError\n

      \n
        \n
      • \n

        Description: The service was unable to apply the provided tag to the bucket.

        \n
        • \n
      \n
      • \n
    \n \n \n

    The following operations are related to PutBucketTagging:

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?tagging", @@ -8589,14 +9306,11 @@ "com.amazonaws.s3#PutBucketTaggingRequest": { "type": "structure", "members": { - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#deprecated": { - "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." - }, - "smithy.api#documentation": "

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    ", - "smithy.api#httpHeader": "Content-MD5" + "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" } }, "Bucket": { @@ -8614,6 +9328,16 @@ "smithy.api#httpPayload": {}, "smithy.api#required": {} } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#deprecated": { + "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." + }, + "smithy.api#documentation": "

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    ", + "smithy.api#httpHeader": "Content-MD5" + } } } }, @@ -8623,7 +9347,7 @@ "target": "com.amazonaws.s3#PutBucketVersioningRequest" }, "traits": { - "smithy.api#documentation": "

    Sets the versioning state of an existing bucket. To set the versioning state, you must 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 bucket. All objects added to the bucket receive a unique version ID.

    \n \n

    \n Suspended—Disables versioning for the objects in the 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 GetBucketVersioning request does not return a versioning state value.

    \n \n

    If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket\n owner must include the x-amz-mfa request header and the Status\n and the MfaDelete request elements in a request to set the versioning state of\n the bucket.

    \n \n \n

    If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

    \n     \n \n

    \n Related Resources\n

    \n ", + "smithy.api#documentation": "

    Sets the versioning state of an existing bucket. To set the versioning state, you must 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 bucket. All objects added to the bucket receive a unique version ID.

    \n \n

    \n Suspended—Disables versioning for the objects in the 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 GetBucketVersioning request does not return a versioning state value.

    \n \n

    If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket\n owner must include the x-amz-mfa request header and the Status\n and the MfaDelete request elements in a request to set the versioning state of\n the bucket.

    \n \n \n

    If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

    \n     \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?versioning", @@ -8635,11 +9359,14 @@ "com.amazonaws.s3#PutBucketVersioningRequest": { "type": "structure", "members": { - "MFA": { - "target": "com.amazonaws.s3#MFA", + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

    ", - "smithy.api#httpHeader": "x-amz-mfa" + "smithy.api#deprecated": { + "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." + }, + "smithy.api#documentation": "

    >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    ", + "smithy.api#httpHeader": "Content-MD5" } }, "Bucket": { @@ -8650,14 +9377,11 @@ "smithy.api#required": {} } }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", + "MFA": { + "target": "com.amazonaws.s3#MFA", "traits": { - "smithy.api#deprecated": { - "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." - }, - "smithy.api#documentation": "

    >The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

    ", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#documentation": "

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

    ", + "smithy.api#httpHeader": "x-amz-mfa" } }, "VersioningConfiguration": { @@ -8667,6 +9391,13 @@ "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" + } } } }, @@ -8688,14 +9419,21 @@ "com.amazonaws.s3#PutBucketWebsiteRequest": { "type": "structure", "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "WebsiteConfiguration": { + "target": "com.amazonaws.s3#WebsiteConfiguration", "traits": { - "smithy.api#documentation": "

    The bucket name.

    ", - "smithy.api#httpLabel": {}, + "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" + } + }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { @@ -8706,11 +9444,11 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "WebsiteConfiguration": { - "target": "com.amazonaws.s3#WebsiteConfiguration", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Container for the request.

    ", - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The bucket name.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -8725,7 +9463,7 @@ "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 to it.

    \n \n\n

    Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

    \n \n

    Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

    \n \n

    To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

    \n \n

    \n The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon Simple Storage Service Developer Guide.\n

    \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. For more information, see Using Server-Side\n Encryption.

    \n

    \n Access Control List (ACL)-Specific Request 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.\n The STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different storage class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.

    \n \n

    \n Versioning\n

    \n

    If you enable versioning for a bucket, Amazon S3 automatically generates a unique\n version ID for the object being stored. Amazon S3 returns this ID in the response. When you\n enable versioning for a bucket, if Amazon S3 receives multiple write requests for the\n same object 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#documentation": "

    Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

    \n \n\n

    Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

    \n \n

    Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

    \n \n

    To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

    \n \n

    \n The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon Simple Storage Service Developer Guide.\n

    \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. For more information, see Using Server-Side\n Encryption.

    \n

    \n Access Control List (ACL)-Specific Request 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.\n The 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 \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.

    \n \n \n

    \n Versioning\n

    \n

    If you enable versioning for a bucket, Amazon S3 automatically generates a unique\n version ID for the object being stored. Amazon S3 returns this ID in the response. When you\n enable versioning for a bucket, if Amazon S3 receives multiple write requests for the\n same object 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", @@ -8747,7 +9485,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Uses the acl subresource to set the access control list (ACL) permissions for an\n object that already exists in a bucket. You must have WRITE_ACP permission to\n set the ACL of an object.

    \n

    Depending on your application needs, you can choose to set the ACL on an object 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, you can continue to use that\n approach. For more information, see\n Access Control List (ACL) Overview in the Amazon S3 Developer Guide.

    \n \n \n \n

    \n Access Permissions\n

    \n

    You can set access permissions using one of the following methods:

    \n
      \n
    • \n

      Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of\n grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups)\n who will receive the permission. If you use these ACL-specific headers, you cannot\n use x-amz-acl header to set a canned ACL. These parameters map to the\n\n set of permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview.

      \n\n

      You specify each grantee as a type=value pair, where the type is one of the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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 list\n objects permission to the two AWS accounts identified by their email\n addresses.

      \n

      \n x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"\n \n

      \n \n
      • \n
    \n

    You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

    \n

    \n Grantee Values\n

    \n

    You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

    \n
      \n
    • \n

      By the person's ID:

      \n

      \n <>ID<><>GranteesEmail<>\n \n

      \n

      DisplayName is optional and ignored in the request.

      \n
      • \n
    • \n

      By URI:

      \n

      \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

      \n
      • \n
    • \n

      By Email address:

      \n

      \n <>Grantees@email.com<>lt;/Grantee>\n

      \n

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

      \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

    \n Versioning\n

    \n

    The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

    \n

    \n Related Resources\n

    \n ", + "smithy.api#documentation": "

    Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have WRITE_ACP permission to\n set the ACL of an object. For more information, see What 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 the ACL on an object 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, you can continue to use that\n approach. For more information, see\n Access Control List (ACL) Overview in the Amazon S3 Developer Guide.

    \n \n \n \n

    \n Access Permissions\n

    \n

    You can set access permissions using one of the following methods:

    \n
      \n
    • \n

      Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of\n grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

      \n
      • \n
    • \n

      Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups)\n who will receive the permission. If you use these ACL-specific headers, you cannot\n use x-amz-acl header to set a canned ACL. These parameters map to the\n\n set of permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview.

      \n\n

      You specify each grantee as a type=value pair, where the type is one of the following:

      \n
        \n
      • \n

        \n id – if the value specified is the canonical user ID of an AWS account

        \n
        • \n
      • \n

        \n uri – if you are granting permissions to a predefined group

        \n
        • \n
      • \n

        \n emailAddress – if the value specified is the email address of an AWS\n 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 list\n objects permission to the two AWS accounts identified by their email\n addresses.

      \n

      \n x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"\n \n

      \n \n
      • \n
    \n

    You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

    \n

    \n Grantee Values\n

    \n

    You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

    \n
      \n
    • \n

      By the person's ID:

      \n

      \n <>ID<><>GranteesEmail<>\n \n

      \n

      DisplayName is optional and ignored in the request.

      \n
      • \n
    • \n

      By URI:

      \n

      \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

      \n
      • \n
    • \n

      By Email address:

      \n

      \n <>Grantees@email.com<>lt;/Grantee>\n

      \n

      The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.

      \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

    \n Versioning\n

    \n

    The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

    \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?acl", @@ -8770,6 +9508,26 @@ "com.amazonaws.s3#PutObjectAclRequest": { "type": "structure", "members": { + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "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.

    ", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "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" + } + }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { @@ -8780,82 +9538,69 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "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" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

    VersionId used to reference a specific version of the object.

    ", - "smithy.api#httpQuery": "versionId" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", "traits": { - "smithy.api#documentation": "

    Key for which the PUT operation was initiated.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Contains the elements that set the ACL permissions for an object per grantee.

    ", + "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 bucket.

    ", + "smithy.api#documentation": "

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "AccessControlPolicy": { - "target": "com.amazonaws.s3#AccessControlPolicy", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#documentation": "

    Contains the elements that set the ACL permissions for an object per grantee.

    ", - "smithy.api#httpPayload": {} + "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" } }, "GrantRead": { "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "

    Allows grantee to list the objects in the bucket.

    ", + "smithy.api#documentation": "

    Allows grantee to list the objects in the bucket.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", "smithy.api#httpHeader": "x-amz-grant-read" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", "traits": { - "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "smithy.api#documentation": "

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", + "smithy.api#httpHeader": "x-amz-grant-write" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "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 using 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#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": {} } }, - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", - "smithy.api#httpHeader": "x-amz-grant-write" + "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable bucket.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "

    The canned ACL to apply to the object. For more information, see Canned\n ACL.

    ", - "smithy.api#httpHeader": "x-amz-acl" + "smithy.api#documentation": "

    VersionId used to reference a specific version of the object.

    ", + "smithy.api#httpQuery": "versionId" + } + }, + "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": {} } } } @@ -8869,7 +9614,7 @@ "target": "com.amazonaws.s3#PutObjectLegalHoldOutput" }, "traits": { - "smithy.api#documentation": "

    Applies a Legal Hold configuration to the specified object.

    \n

    \n Related Resources\n

    \n ", + "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", @@ -8892,11 +9637,12 @@ "com.amazonaws.s3#PutObjectLegalHoldRequest": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The version ID of the object that you want to place a Legal Hold on.

    ", - "smithy.api#httpQuery": "versionId" + "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": {} } }, "ContentMD5": { @@ -8909,34 +9655,40 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "LegalHold": { + "target": "com.amazonaws.s3#ObjectLockLegalHold", "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": {} + "smithy.api#documentation": "

    Container element for the Legal Hold configuration you want to apply to the specified object.

    ", + "smithy.api#httpPayload": {} } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "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" } }, - "LegalHold": { - "target": "com.amazonaws.s3#ObjectLockLegalHold", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "

    Container element for the Legal Hold configuration you want to apply to the specified object.

    ", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

    The version ID of the object that you want to place a Legal Hold on.

    ", + "smithy.api#httpQuery": "versionId" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "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 using 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#documentation": "

    The key name for the object that you want to place a Legal Hold on.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } } } }, @@ -8972,6 +9724,26 @@ "com.amazonaws.s3#PutObjectLockConfigurationRequest": { "type": "structure", "members": { + "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" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "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": {} + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -8990,24 +9762,11 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "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" - } - }, - "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", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "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" } } } @@ -9015,24 +9774,32 @@ "com.amazonaws.s3#PutObjectOutput": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

    Version of the object.

    ", - "smithy.api#httpHeader": "x-amz-version-id" + "smithy.api#documentation": "

    If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "Expiration": { + "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "

    \t\n If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

    ", + "smithy.api#httpHeader": "x-amz-expiration" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "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 object.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

    Entity tag for the uploaded object.

    ", + "smithy.api#httpHeader": "ETag" } }, "SSECustomerAlgorithm": { @@ -9042,18 +9809,24 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "

    Version of the object.

    ", + "smithy.api#httpHeader": "x-amz-version-id" } }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "

    If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "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 object.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "ServerSideEncryption": { @@ -9062,52 +9835,66 @@ "smithy.api#documentation": "

    If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.

    ", "smithy.api#httpHeader": "x-amz-server-side-encryption" } + } + } + }, + "com.amazonaws.s3#PutObjectRequest": { + "type": "structure", + "members": { + "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": {} + } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "

    Entity tag for the uploaded object.

    ", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "traits": { - "smithy.api#documentation": "

    \t\n If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

    ", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

    ", + "smithy.api#httpHeader": "Content-Encoding" } - } - } - }, - "com.amazonaws.s3#PutObjectRequest": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "

    Object data.

    ", - "smithy.api#httpPayload": {} + "smithy.api#httpHeader": "x-amz-request-payer" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#documentation": "

    If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

    ", - "smithy.api#httpHeader": "x-amz-storage-class" + "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" } }, - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, \"Key1=Value1\")

    ", - "smithy.api#httpHeader": "x-amz-tagging" + "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" } }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "traits": { - "smithy.api#documentation": "

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + "smithy.api#documentation": "

    \t\n Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

    ", + "smithy.api#httpHeader": "Cache-Control" } }, "WebsiteRedirectLocation": { @@ -9117,53 +9904,47 @@ "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "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" + "smithy.api#documentation": "

    Object key for which the PUT operation was initiated.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

    ", - "smithy.api#httpHeader": "Expires" + "smithy.api#documentation": "

    Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

    ", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, "GrantWriteACP": { "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable object.

    ", + "smithy.api#documentation": "

    Allows grantee to write the ACL for the applicable object.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", "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" + "smithy.api#documentation": "

    Size of the body in bytes. This parameter is useful when the size of the body cannot be 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", + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", "traits": { - "smithy.api#documentation": "

    The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

    ", - "smithy.api#httpHeader": "Content-MD5" + "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" } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    ", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, "ContentDisposition": { @@ -9173,81 +9954,67 @@ "smithy.api#httpHeader": "Content-Disposition" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

    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 using 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": {} - } - }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "

    Allows grantee to read the object ACL.

    ", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "

    Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

    ", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + "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" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

    ", - "smithy.api#httpHeader": "Content-Encoding" + "smithy.api#documentation": "

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", "traits": { - "smithy.api#documentation": "

    A map of metadata to store with the object in S3.

    ", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "smithy.api#documentation": "

    The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, \"Key1=Value1\")

    ", + "smithy.api#httpHeader": "x-amz-tagging" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "

    The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

    ", + "smithy.api#httpHeader": "Expires" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "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" + "smithy.api#documentation": "

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.\n The 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 \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.

    ", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    \t\n Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

    ", - "smithy.api#httpHeader": "Cache-Control" + "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" } }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", "traits": { - "smithy.api#documentation": "

    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

    ", - "smithy.api#httpHeader": "Content-Length" + "smithy.api#documentation": "

    Object data.

    ", + "smithy.api#httpPayload": {} } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", "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" + "smithy.api#documentation": "

    The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

    ", + "smithy.api#httpHeader": "Content-MD5" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "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 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 the object. If you specify\n x-amz-server-side-encryption:aws:kms, but do not provide\n x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK\n in AWS to protect the data.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "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" } }, "ObjectLockMode": { @@ -9257,12 +10024,11 @@ "smithy.api#httpHeader": "x-amz-object-lock-mode" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

    Object key for which the PUT operation was initiated.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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 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 the object. If you specify\n x-amz-server-side-encryption:aws:kms, but do not provide\n x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK\n in AWS to protect the data.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "ContentLanguage": { @@ -9272,10 +10038,17 @@ "smithy.api#httpHeader": "Content-Language" } }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

    Allows grantee to read the object data and its metadata.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, "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#documentation": "

    The canned ACL to apply to the object. For more information, see Canned ACL.

    \n

    This action is not supported by Amazon S3 on Outposts.

    ", "smithy.api#httpHeader": "x-amz-acl" } }, @@ -9285,13 +10058,6 @@ "smithy.api#documentation": "

    A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

    ", "smithy.api#httpHeader": "Content-Type" } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "

    Allows grantee to read the object data and its metadata.

    ", - "smithy.api#httpHeader": "x-amz-grant-read" - } } } }, @@ -9304,7 +10070,7 @@ "target": "com.amazonaws.s3#PutObjectRetentionOutput" }, "traits": { - "smithy.api#documentation": "

    Places an Object Retention configuration on an object.

    \n

    \n Related Resources\n

    \n ", + "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", @@ -9327,37 +10093,49 @@ "com.amazonaws.s3#PutObjectRetentionRequest": { "type": "structure", "members": { - "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 to.

    ", - "smithy.api#httpQuery": "versionId" - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#deprecated": { - "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." - }, - "smithy.api#documentation": "

    The MD5 hash for the request body.

    ", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#documentation": "

    The key name for the object that you want to apply this Object Retention configuration to.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The bucket name that contains the object you want to apply this Object Retention 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 using 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#documentation": "

    The bucket name that contains the object you want to apply this Object Retention 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": {} } }, + "Retention": { + "target": "com.amazonaws.s3#ObjectLockRetention", + "traits": { + "smithy.api#documentation": "

    The container element for the Object Retention configuration.

    ", + "smithy.api#httpPayload": {} + } + }, + "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 to.

    ", + "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" + } + }, "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { @@ -9365,19 +10143,14 @@ "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } }, - "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 to.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Retention": { - "target": "com.amazonaws.s3#ObjectLockRetention", + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

    The container element for the Object Retention configuration.

    ", - "smithy.api#httpPayload": {} + "smithy.api#deprecated": { + "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." + }, + "smithy.api#documentation": "

    The MD5 hash for the request body.

    ", + "smithy.api#httpHeader": "Content-MD5" } } } @@ -9391,7 +10164,7 @@ "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 request against the tagging subresource that is associated with the object. You can 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 Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

    \n \n

    To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

    \n \n

    To put tags of any other version, use the versionId query parameter. You 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 Code: InvalidTagError \n

        \n
        • \n
      • \n

        \n Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging. \n

        \n
        • \n
      \n
      • \n
    • \n

      \n \n

      \n
        \n
      • \n

        \n Code: MalformedXMLError \n

        \n
        • \n
      • \n

        \n Cause: The XML provided does not match the schema. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: OperationAbortedError \n

        \n
        • \n
      • \n

        \n Cause: A conflicting conditional operation is currently in progress against this resource. Please try again. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InternalError \n

        \n
        • \n
      • \n

        \n Cause: The service was unable to apply the provided tag to the object. \n

        \n
        • \n
      \n
      • \n
    \n \n \n \n \n \n \n

    \n Related Resources\n

    \n ", + "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 request against the tagging subresource that is associated with the object. You can 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 Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

    \n \n

    To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

    \n \n

    To put tags of any other version, use the versionId query parameter. You 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 Code: InvalidTagError \n

        \n
        • \n
      • \n

        \n Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: MalformedXMLError \n

        \n
        • \n
      • \n

        \n Cause: The XML provided does not match the schema. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: OperationAbortedError \n

        \n
        • \n
      • \n

        \n Cause: A conflicting conditional operation is currently in progress against this resource. Please try again. \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InternalError \n

        \n
        • \n
      • \n

        \n Cause: The service was unable to apply the provided tag to the object. \n

        \n
        • \n
      \n
      • \n
    \n \n \n \n \n \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?tagging", @@ -9415,6 +10188,22 @@ "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": { @@ -9422,12 +10211,11 @@ "smithy.api#httpQuery": "versionId" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "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 using 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": {} + "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" } }, "Tagging": { @@ -9447,14 +10235,6 @@ "smithy.api#documentation": "

    The MD5 hash for the request body.

    ", "smithy.api#httpHeader": "Content-MD5" } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

    Name of the tag.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -9464,7 +10244,7 @@ "target": "com.amazonaws.s3#PutPublicAccessBlockRequest" }, "traits": { - "smithy.api#documentation": "

    Creates or modifies the PublicAccessBlock configuration for an Amazon S3\n bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

    \n \n \n

    When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an\n object, it checks the PublicAccessBlock configuration for both the bucket\n (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#documentation": "

    Creates or modifies the PublicAccessBlock configuration for an Amazon S3\n bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

    \n \n \n

    When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an\n object, it checks the PublicAccessBlock configuration for both the bucket\n (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", @@ -9476,6 +10256,21 @@ "com.amazonaws.s3#PutPublicAccessBlockRequest": { "type": "structure", "members": { + "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" + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -9493,14 +10288,6 @@ "smithy.api#documentation": "

    The MD5 hash of the PutPublicAccessBlock request body.

    ", "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": {} - } } } }, @@ -9510,9 +10297,6 @@ "com.amazonaws.s3#QueueConfiguration": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.s3#NotificationId" - }, "Events": { "target": "com.amazonaws.s3#EventList", "traits": { @@ -9522,6 +10306,12 @@ "smithy.api#xmlName": "Event" } }, + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "Filter": { + "target": "com.amazonaws.s3#NotificationConfigurationFilter" + }, "QueueArn": { "target": "com.amazonaws.s3#QueueArn", "traits": { @@ -9529,9 +10319,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "Queue" } - }, - "Filter": { - "target": "com.amazonaws.s3#NotificationConfigurationFilter" } }, "traits": { @@ -9592,16 +10379,10 @@ "com.amazonaws.s3#Redirect": { "type": "structure", "members": { - "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 the original request.

    " - } - }, - "ReplaceKeyWith": { - "target": "com.amazonaws.s3#ReplaceKeyWith", + "HttpRedirectCode": { + "target": "com.amazonaws.s3#HttpRedirectCode", "traits": { - "smithy.api#documentation": "

    The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

    " + "smithy.api#documentation": "

    The HTTP redirect code to use on the response. Not required if one of the siblings is present.

    " } }, "ReplaceKeyPrefixWith": { @@ -9610,16 +10391,22 @@ "smithy.api#documentation": "

    The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

    " } }, + "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 the original request.

    " + } + }, "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", + "ReplaceKeyWith": { + "target": "com.amazonaws.s3#ReplaceKeyWith", "traits": { - "smithy.api#documentation": "

    The HTTP redirect code to use on the response. Not required if one of the siblings is present.

    " + "smithy.api#documentation": "

    The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

    " } } }, @@ -9684,24 +10471,11 @@ "com.amazonaws.s3#ReplicationRule": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.s3#ReplicationRuleStatus", - "traits": { - "smithy.api#documentation": "

    Specifies whether the rule is enabled.

    ", - "smithy.api#required": {} - } - }, - "Priority": { - "target": "com.amazonaws.s3#Priority", - "traits": { - "smithy.api#documentation": "

    The priority associated with the rule. If you specify multiple rules in a replication\n configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or\n more rules identify the same object based on a specified filter, the rule with higher priority\n takes precedence. For example:

    \n
      \n
    • \n

      Same object quality prefix-based filter criteria if prefixes you specified in multiple rules\n overlap

      \n
      • \n
    • \n

      Same object qualify tag-based filter criteria specified in multiple rules

      \n
      • \n
    \n

    For more information, see Replication in the Amazon Simple Storage Service Developer\n Guide.

    " - } - }, - "Destination": { - "target": "com.amazonaws.s3#Destination", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "

    A container for information about the replication destination\n and its configurations including enabling the S3 Replication Time Control (S3 RTC).

    ", - "smithy.api#required": {} + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

    An object key name prefix that identifies the object or objects to which the rule applies.\n The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify\n an empty string.

    " } }, "ID": { @@ -9716,24 +10490,37 @@ "smithy.api#documentation": "

    A container that describes additional filters for identifying the source objects that you\n want to replicate. You can choose to enable or disable the replication of these objects.\n Currently, Amazon S3 supports only the filter that you can specify for objects created with\n server-side encryption using a customer master key (CMK) stored in AWS Key Management Service (SSE-KMS).

    " } }, - "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 applies.\n The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify\n an empty string.

    " - } + "DeleteMarkerReplication": { + "target": "com.amazonaws.s3#DeleteMarkerReplication" }, "Filter": { "target": "com.amazonaws.s3#ReplicationRuleFilter" }, + "Priority": { + "target": "com.amazonaws.s3#Priority", + "traits": { + "smithy.api#documentation": "

    The priority associated with the rule. If you specify multiple rules in a replication\n configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or\n more rules identify the same object based on a specified filter, the rule with higher priority\n takes precedence. For example:

    \n
      \n
    • \n

      Same object quality prefix-based filter criteria if prefixes you specified in multiple rules\n overlap

      \n
      • \n
    • \n

      Same object qualify tag-based filter criteria specified in multiple rules

      \n
      • \n
    \n

    For more information, see Replication in the Amazon Simple Storage Service Developer\n Guide.

    " + } + }, + "Status": { + "target": "com.amazonaws.s3#ReplicationRuleStatus", + "traits": { + "smithy.api#documentation": "

    Specifies whether the rule is enabled.

    ", + "smithy.api#required": {} + } + }, "ExistingObjectReplication": { "target": "com.amazonaws.s3#ExistingObjectReplication", "traits": { "smithy.api#documentation": "

    " } }, - "DeleteMarkerReplication": { - "target": "com.amazonaws.s3#DeleteMarkerReplication" + "Destination": { + "target": "com.amazonaws.s3#Destination", + "traits": { + "smithy.api#documentation": "

    A container for information about the replication destination\n and its configurations including enabling the S3 Replication Time Control (S3 RTC).

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -9743,6 +10530,12 @@ "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": { @@ -9750,12 +10543,6 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } - }, - "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.

    " - } } }, "traits": { @@ -9765,10 +10552,10 @@ "com.amazonaws.s3#ReplicationRuleFilter": { "type": "structure", "members": { - "And": { - "target": "com.amazonaws.s3#ReplicationRuleAndOperator", + "Tag": { + "target": "com.amazonaws.s3#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. For\n example:

    \n
      \n
    • \n

      If you specify both a Prefix and a Tag filter, wrap these filters\n in an And tag.

      \n
      • \n
    • \n

      If you specify a filter based on multiple tags, wrap the Tag elements in an\n And tag.

      \n
      • \n
    " + "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.

    " } }, "Prefix": { @@ -9777,10 +10564,10 @@ "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#ReplicationRuleAndOperator", "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.

    " + "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. For\n example:

    \n
      \n
    • \n

      If you specify both a Prefix and a Tag filter, wrap these filters\n in an And tag.

      \n
      • \n
    • \n

      If you specify a filter based on multiple tags, wrap the Tag elements in an\n And tag.

      \n
      • \n
    " } } }, @@ -9829,17 +10616,17 @@ "com.amazonaws.s3#ReplicationTime": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.s3#ReplicationTimeStatus", + "Time": { + "target": "com.amazonaws.s3#ReplicationTimeValue", "traits": { - "smithy.api#documentation": "

    \n Specifies whether the replication time is enabled.\n

    ", + "smithy.api#documentation": "

    A container specifying the time by which replication should be complete for all objects and\n operations on objects.

    ", "smithy.api#required": {} } }, - "Time": { - "target": "com.amazonaws.s3#ReplicationTimeValue", + "Status": { + "target": "com.amazonaws.s3#ReplicationTimeStatus", "traits": { - "smithy.api#documentation": "

    A container specifying the time by which replication should be complete for all objects and\n operations on objects.

    ", + "smithy.api#documentation": "

    \n Specifies whether the replication time is enabled.\n

    ", "smithy.api#required": {} } } @@ -9961,7 +10748,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Restores an archived copy of an object back into Amazon S3

    \n

    This operation performs the following types of requests:

    \n
      \n
    • \n

      \n select - Perform a select query on an archived object

      \n
      • \n
    • \n

      \n restore an archive - Restore an archived object

      \n
      • \n
    \n

    To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner\n has this permission by default and can grant this permission to others. For more\n 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
    • \n

      Define an output location for the select query's output. This must be an Amazon S3\n bucket in the same AWS Region as the bucket that contains the archive object that is\n being queried. The AWS account that initiates the job must have permissions to write\n to the S3 bucket. You can specify the storage class and encryption for the output\n objects stored in the bucket. For more information about output, see Querying Archived Objects\n in the Amazon Simple Storage Service Developer Guide.

      \n

      For more information about the S3 structure in the request body, see\n the following:

      \n \n
      • \n
    • \n

      Define the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.

      \n
        \n
      • \n

        The following expression returns all records from the specified\n object.

        \n

        \n SELECT * FROM Object\n

        \n
        • \n
      • \n

        Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.

        \n

        \n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n

        \n
        • \n
      • \n

        If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.

        \n

        \n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n

        \n
        • \n
      \n
      • \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
    • \n

      To expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.

      \n
      • \n
    • \n

      Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.

      \n
      • \n
    \n

    The following are additional important facts about the select feature:

    \n
      \n
    • \n

      The output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle policy.

      \n
      • \n
    • \n

      You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n deduplicate requests, so avoid issuing duplicate requests.

      \n
      • \n
    • \n

      Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.

      \n
      • \n
    \n

    \n Restoring Archives\n

    \n

    Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an\n archived object, you must first initiate a restore request. This restores a temporary copy\n of the archived object. In a restore request, you specify the number of days that you want\n the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but\n the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was\n restored from.

    \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

    The time it takes restore jobs to finish depends on which storage class the object is\n being restored from and which data access tier you specify.

    \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
    • \n

      \n \n Expedited\n - Expedited retrievals\n allow you to quickly access your data stored in the GLACIER storage class when\n occasional urgent requests for a subset of archives are required. For all but the\n largest archived objects (250 MB+), data accessed using Expedited retrievals are\n typically made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it. Expedited\n retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage\n class.

      \n
      • \n
    • \n

      \n \n Standard\n - S3 Standard retrievals allow\n you to access any of your archived objects within several hours. This is the default\n option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the\n retrieval option. S3 Standard retrievals typically complete within 3-5 hours from the\n GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE\n storage class.

      \n
      • \n
    • \n

      \n \n Bulk\n - Bulk retrievals are Amazon S3\n Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even\n petabytes, of data inexpensively in a day. Bulk retrievals typically complete within\n 5-12 hours from the GLACIER storage class and typically complete within 48 hours from\n the DEEP_ARCHIVE storage class.

      \n
      • \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. You upgrade the speed of an in-progress restoration by issuing\n another restore request to the same object, setting a new Tier request\n element. When issuing a request to upgrade the restore tier, you must choose a tier that is\n faster than the tier that the in-progress restore is using. You must not change any other\n parameters, such as the Days request element. 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\n Object Lifecycle Management\n in 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

      If the object copy is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

      \n
      • \n
    • \n

      If the object copy is previously restored, Amazon S3 returns 200 OK in the\n response.

      \n
      • \n
    \n

    \n Special Errors\n

    \n
      \n
    • \n

      \n \n

      \n
        \n
      • \n

        \n Code: RestoreAlreadyInProgress\n

        \n
        • \n
      • \n

        \n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n

        \n
        • \n
      • \n

        \n HTTP Status Code: 409 Conflict\n

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client\n

        \n
        • \n
      \n
      • \n
    • \n

      \n \n

      \n
        \n
      • \n

        \n Code: GlacierExpeditedRetrievalNotAvailable\n

        \n
        • \n
      • \n

        \n Cause: S3 Glacier expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to process the\n Expedited request. This error applies only to Expedited retrievals and not\n to S3 Standard or Bulk retrievals.)\n

        \n
        • \n
      • \n

        \n HTTP Status Code: 503\n

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: N/A\n

        \n
        • \n
      \n
      • \n
    \n \n

    \n Related Resources\n

    \n ", + "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
    • \n

      \n select - Perform a select query on an archived object

      \n
      • \n
    • \n

      \n restore an archive - Restore an archived object

      \n
      • \n
    \n

    To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner\n has this permission by default and can grant this permission to others. For more\n 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
    • \n

      Define an output location for the select query's output. This must be an Amazon S3\n bucket in the same AWS Region as the bucket that contains the archive object that is\n being queried. The AWS account that initiates the job must have permissions to write\n to the S3 bucket. You can specify the storage class and encryption for the output\n objects stored in the bucket. For more information about output, see Querying Archived Objects\n in the Amazon Simple Storage Service Developer Guide.

      \n

      For more information about the S3 structure in the request body, see\n the following:

      \n \n
      • \n
    • \n

      Define the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.

      \n
        \n
      • \n

        The following expression returns all records from the specified\n object.

        \n

        \n SELECT * FROM Object\n

        \n
        • \n
      • \n

        Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.

        \n

        \n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n

        \n
        • \n
      • \n

        If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.

        \n

        \n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n

        \n
        • \n
      \n
      • \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
    • \n

      To expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.

      \n
      • \n
    • \n

      Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.

      \n
      • \n
    \n

    The following are additional important facts about the select feature:

    \n
      \n
    • \n

      The output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle policy.

      \n
      • \n
    • \n

      You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n deduplicate requests, so avoid issuing duplicate requests.

      \n
      • \n
    • \n

      Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.

      \n
      • \n
    \n

    \n Restoring Archives\n

    \n

    Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an\n archived object, you must first initiate a restore request. This restores a temporary copy\n of the archived object. In a restore request, you specify the number of days that you want\n the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but\n the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was\n restored from.

    \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

    The time it takes restore jobs to finish depends on which storage class the object is\n being restored from and which data access tier you specify.

    \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
    • \n

      \n \n Expedited\n - Expedited retrievals\n allow you to quickly access your data stored in the GLACIER storage class when\n occasional urgent requests for a subset of archives are required. For all but the\n largest archived objects (250 MB+), data accessed using Expedited retrievals are\n typically made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it. Expedited\n retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage\n class.

      \n
      • \n
    • \n

      \n \n Standard\n - S3 Standard retrievals allow\n you to access any of your archived objects within several hours. This is the default\n option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the\n retrieval option. S3 Standard retrievals typically complete within 3-5 hours from the\n GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE\n storage class.

      \n
      • \n
    • \n

      \n \n Bulk\n - Bulk retrievals are Amazon S3\n Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even\n petabytes, of data inexpensively in a day. Bulk retrievals typically complete within\n 5-12 hours from the GLACIER storage class and typically complete within 48 hours from\n the DEEP_ARCHIVE storage class.

      \n
      • \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. You upgrade the speed of an in-progress restoration by issuing\n another restore request to the same object, setting a new Tier request\n element. When issuing a request to upgrade the restore tier, you must choose a tier that is\n faster than the tier that the in-progress restore is using. You must not change any other\n parameters, such as the Days request element. 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\n Object Lifecycle Management\n in 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

      If the object copy is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

      \n
      • \n
    • \n

      If the object copy is previously restored, Amazon S3 returns 200 OK in the\n response.

      \n
      • \n
    \n

    \n Special Errors\n

    \n
      \n
    • \n
        \n
      • \n

        \n Code: RestoreAlreadyInProgress\n

        \n
        • \n
      • \n

        \n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n

        \n
        • \n
      • \n

        \n HTTP Status Code: 409 Conflict\n

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client\n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: GlacierExpeditedRetrievalNotAvailable\n

        \n
        • \n
      • \n

        \n Cause: S3 Glacier expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to process the\n Expedited request. This error applies only to Expedited retrievals and not\n to S3 Standard or Bulk retrievals.)\n

        \n
        • \n
      • \n

        \n HTTP Status Code: 503\n

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: N/A\n

        \n
        • \n
      \n
      • \n
    \n \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?restore", @@ -9972,51 +10759,43 @@ "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 restored to.

    ", "smithy.api#httpHeader": "x-amz-restore-output-path" } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } } } }, "com.amazonaws.s3#RestoreObjectRequest": { "type": "structure", "members": { - "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": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

    The bucket name or 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 using 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": {} - } - }, "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" + } + }, "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { @@ -10024,6 +10803,21 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

    The bucket name or 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": {} + } + }, + "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" + } } } }, @@ -10033,24 +10827,12 @@ "com.amazonaws.s3#RestoreRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.s3#Description", - "traits": { - "smithy.api#documentation": "

    The optional description for the job.

    " - } - }, "GlacierJobParameters": { "target": "com.amazonaws.s3#GlacierJobParameters", "traits": { "smithy.api#documentation": "

    S3 Glacier related parameters pertaining to this job. Do not use with restores that specify\n OutputLocation.

    " } }, - "Tier": { - "target": "com.amazonaws.s3#Tier", - "traits": { - "smithy.api#documentation": "

    S3 Glacier retrieval tier at which the restore will be processed.

    " - } - }, "Days": { "target": "com.amazonaws.s3#Days", "traits": { @@ -10069,6 +10851,18 @@ "smithy.api#documentation": "

    Describes the parameters for Select job types.

    " } }, + "Tier": { + "target": "com.amazonaws.s3#Tier", + "traits": { + "smithy.api#documentation": "

    S3 Glacier 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.

    " + } + }, "Type": { "target": "com.amazonaws.s3#RestoreRequestType", "traits": { @@ -10097,22 +10891,22 @@ "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 apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect 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 another\n page, or with another protocol. In the event of an error, you can specify a different error\n code to return.

    ", "smithy.api#required": {} } + }, + "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 apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

    " + } } }, "traits": { - "smithy.api#documentation": "

    Specifies the redirect behavior and when a redirect is applied.

    " + "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": { @@ -10142,10 +10936,11 @@ "com.amazonaws.s3#S3Location": { "type": "structure", "members": { - "UserMetadata": { - "target": "com.amazonaws.s3#UserMetadata", + "BucketName": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    A list of metadata to store with the restore results in S3.

    " + "smithy.api#documentation": "

    The name of the bucket where the restore results will be placed.

    ", + "smithy.api#required": {} } }, "StorageClass": { @@ -10160,8 +10955,11 @@ "smithy.api#documentation": "

    The canned ACL to apply to the restore results.

    " } }, - "Encryption": { - "target": "com.amazonaws.s3#Encryption" + "UserMetadata": { + "target": "com.amazonaws.s3#UserMetadata", + "traits": { + "smithy.api#documentation": "

    A list of metadata to store with the restore results in S3.

    " + } }, "Prefix": { "target": "com.amazonaws.s3#LocationPrefix", @@ -10170,24 +10968,20 @@ "smithy.api#required": {} } }, - "BucketName": { - "target": "com.amazonaws.s3#BucketName", + "Tagging": { + "target": "com.amazonaws.s3#Tagging", "traits": { - "smithy.api#documentation": "

    The name of the bucket where the restore results will be placed.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The tag-set that is applied to the restore results.

    " } }, + "Encryption": { + "target": "com.amazonaws.s3#Encryption" + }, "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.

    " - } } }, "traits": { @@ -10245,17 +11039,17 @@ "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: non-negative integers. The default value is 0. \n If only start is supplied, it means scan from that point to the end of the file.For example; 50 means scan 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: non-negative\n integers. The default value is one less than the size of the object being queried. If only\n the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file.\n For example, 50\n means scan the last 50 bytes.

    " } + }, + "Start": { + "target": "com.amazonaws.s3#Start", + "traits": { + "smithy.api#documentation": "

    Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. \n If only start is supplied, it means scan from that point to the end of the file.For example; 50 means scan from byte 50 until the end of the file.

    " + } } }, "traits": { @@ -10271,7 +11065,7 @@ "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\n uses this format to parse object data into records, and returns only records that match\n the specified SQL expression. You must also specify the data serialization format for\n the response.

    \n

    For more information about Amazon S3 Select, see \n Selecting Content from Objects\n 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\n Select 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\n does not support anonymous access. For more information about permissions, see\n Specifying Permissions in a\n Policy 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 CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.

      \n
      • \n
    • \n

      \n UTF-8 - UTF-8 is the only encoding\n type Amazon S3 Select supports.

      \n
      • \n
    • \n

      \n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.

      \n
      • \n
    • \n

      \n Server-side encryption - Amazon S3 Select\n supports querying objects that are protected with server-side\n encryption.

      \n

      For objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more information\n about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon Simple Storage Service Developer Guide.

      \n

      For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3)\n and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is\n handled transparently, so you don't need to specify anything. For more\n information about server-side encryption, including SSE-S3 and SSE-KMS, see\n Protecting Data Using\n Server-Side Encryption in the\n Amazon Simple Storage Service Developer Guide.

      \n
      • \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 messages and includes a Transfer-Encoding header with chunked\n as its value in the response. For more information, see RESTSelectObjectAppendix\n .

    \n \n

    \n

    \n GetObject Support\n

    \n

    The SelectObjectContent operation does not support the following GetObject functionality. For more information, see GetObject.

    \n
      \n
    • \n

      \n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest$ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.

      \n
      • \n
    • \n

      GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You\n cannot specify the GLACIER, DEEP_ARCHIVE, or \n REDUCED_REDUNDANCY storage classes. For more information, about\n storage classes see Storage\n Classes in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    \n

    \n

    \n Special Errors\n

    \n\n

    For a list of special errors for this operation, see SelectObjectContentErrorCodeList\n

    \n

    \n Related Resources\n

    \n ", + "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\n uses this format to parse object data into records, and returns only records that match\n the specified SQL expression. You must also specify the data serialization format for\n the response.

    \n

    This action is not supported by Amazon S3 on Outposts.

    \n

    For more information about Amazon S3 Select, see \n Selecting Content from Objects\n 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\n Select 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\n does not support anonymous access. For more information about permissions, see\n Specifying Permissions in a\n Policy 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 CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.

      \n
      • \n
    • \n

      \n UTF-8 - UTF-8 is the only encoding\n type Amazon S3 Select supports.

      \n
      • \n
    • \n

      \n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.

      \n
      • \n
    • \n

      \n Server-side encryption - Amazon S3 Select\n supports querying objects that are protected with server-side\n encryption.

      \n

      For objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more information\n about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon Simple Storage Service Developer Guide.

      \n

      For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3)\n and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is\n handled transparently, so you don't need to specify anything. For more\n information about server-side encryption, including SSE-S3 and SSE-KMS, see\n Protecting Data Using\n Server-Side Encryption in the\n Amazon Simple Storage Service Developer Guide.

      \n
      • \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 messages and includes a Transfer-Encoding header with chunked\n as its value in the response. For more information, see Appendix: SelectObjectContent Response\n .

    \n \n

    \n

    \n GetObject Support\n

    \n

    The SelectObjectContent operation does not support the following GetObject functionality. For more information, see GetObject.

    \n
      \n
    • \n

      \n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.

      \n
      • \n
    • \n

      GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You\n cannot specify the GLACIER, DEEP_ARCHIVE, or \n REDUCED_REDUNDANCY storage classes. For more information, about\n storage classes see Storage\n Classes in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    \n

    \n

    \n Special Errors\n

    \n\n

    For a list of special errors for this operation, see \n List of SELECT Object Content Error Codes\n

    \n

    \n Related Resources\n

    \n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?select&select-type=2", @@ -10282,6 +11076,18 @@ "com.amazonaws.s3#SelectObjectContentEventStream": { "type": "union", "members": { + "Cont": { + "target": "com.amazonaws.s3#ContinuationEvent", + "traits": { + "smithy.api#documentation": "

    The Continuation Event.

    " + } + }, + "Progress": { + "target": "com.amazonaws.s3#ProgressEvent", + "traits": { + "smithy.api#documentation": "

    The Progress Event.

    " + } + }, "Stats": { "target": "com.amazonaws.s3#StatsEvent", "traits": { @@ -10294,23 +11100,11 @@ "smithy.api#documentation": "

    The End Event.

    " } }, - "Progress": { - "target": "com.amazonaws.s3#ProgressEvent", - "traits": { - "smithy.api#documentation": "

    The Progress Event.

    " - } - }, "Records": { "target": "com.amazonaws.s3#RecordsEvent", "traits": { "smithy.api#documentation": "

    The Records Event.

    " } - }, - "Cont": { - "target": "com.amazonaws.s3#ContinuationEvent", - "traits": { - "smithy.api#documentation": "

    The Continuation Event.

    " - } } }, "traits": { @@ -10333,23 +11127,25 @@ "com.amazonaws.s3#SelectObjectContentRequest": { "type": "structure", "members": { - "RequestProgress": { - "target": "com.amazonaws.s3#RequestProgress", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    Specifies if periodic request progress information should be enabled.

    " + "smithy.api#documentation": "

    The object key.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "InputSerialization": { - "target": "com.amazonaws.s3#InputSerialization", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "

    Describes the format of the data in the object that is being queried.

    ", - "smithy.api#required": {} + "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" } }, - "ExpressionType": { - "target": "com.amazonaws.s3#ExpressionType", + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", "traits": { - "smithy.api#documentation": "

    The type of the provided expression (for example, SQL).

    ", + "smithy.api#documentation": "

    Describes the format of the data that you want Amazon S3 to return in response.

    ", "smithy.api#required": {} } }, @@ -10360,34 +11156,27 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", "traits": { - "smithy.api#documentation": "

    The object key.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The type of the provided expression (for example, SQL).

    ", "smithy.api#required": {} } }, - "OutputSerialization": { - "target": "com.amazonaws.s3#OutputSerialization", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

    Describes the format of the data that you want Amazon S3 to return in response.

    ", - "smithy.api#required": {} + "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" } }, - "Expression": { - "target": "com.amazonaws.s3#Expression", + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", "traits": { - "smithy.api#documentation": "

    The expression that is used to query the object.

    ", + "smithy.api#documentation": "

    Describes the format of the data in the object that is being queried.

    ", "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 when its first byte is contained by the range. This parameter is optional,\n but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

    \n

    \n ScanRangemay be used in the following ways:

    \n
      \n
    • \n

      \n 50100 - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

      \n
      • \n
    • \n

      \n 50 - process only the records starting after the byte 50

      \n
      • \n
    • \n

      \n 50 - process only the records within the last 50 bytes of the file.

      \n
      • \n
    " - } - }, "SSECustomerKeyMD5": { "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { @@ -10395,6 +11184,13 @@ "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": {} + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -10403,11 +11199,16 @@ "smithy.api#required": {} } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "RequestProgress": { + "target": "com.amazonaws.s3#RequestProgress", "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" + "smithy.api#documentation": "

    Specifies if periodic request progress information should be enabled.

    " + } + }, + "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 when its first byte is contained by the range. This parameter is optional,\n but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

    \n

    \n ScanRangemay be used in the following ways:

    \n
      \n
    • \n

      \n 50100 - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

      \n
      • \n
    • \n

      \n 50 - process only the records starting after the byte 50

      \n
      • \n
    • \n

      \n 50 - process only the records within the last 50 bytes of the file.

      \n
      • \n
    " } } }, @@ -10418,31 +11219,31 @@ "com.amazonaws.s3#SelectParameters": { "type": "structure", "members": { - "Expression": { - "target": "com.amazonaws.s3#Expression", + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", "traits": { - "smithy.api#documentation": "

    The expression that is used to query the object.

    ", + "smithy.api#documentation": "

    The type of the provided expression (for example, SQL).

    ", "smithy.api#required": {} } }, - "InputSerialization": { - "target": "com.amazonaws.s3#InputSerialization", + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", "traits": { - "smithy.api#documentation": "

    Describes the serialization format of the object.

    ", + "smithy.api#documentation": "

    Describes how the results of the Select job are serialized.

    ", "smithy.api#required": {} } }, - "ExpressionType": { - "target": "com.amazonaws.s3#ExpressionType", + "Expression": { + "target": "com.amazonaws.s3#Expression", "traits": { - "smithy.api#documentation": "

    The type of the provided expression (for example, SQL).

    ", + "smithy.api#documentation": "

    The expression that is used to query the object.

    ", "smithy.api#required": {} } }, - "OutputSerialization": { - "target": "com.amazonaws.s3#OutputSerialization", + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", "traits": { - "smithy.api#documentation": "

    Describes how the results of the Select job are serialized.

    ", + "smithy.api#documentation": "

    Describes the serialization format of the object.

    ", "smithy.api#required": {} } } @@ -10467,18 +11268,18 @@ "com.amazonaws.s3#ServerSideEncryptionByDefault": { "type": "structure", "members": { - "KMSMasterKeyID": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

    AWS Key Management Service (KMS) customer master key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

    \n

    You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are using encryption with cross-account operations, you must use a fully qualified CMK ARN. For more information, see Using encryption for cross-account operations.

    \n

    \n For example:\n

    \n
      \n
    • \n

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    \n \n

    Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

    \n     " - } - }, "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 encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

    \n

    You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are using encryption with cross-account operations, you must use a fully qualified CMK ARN. For more information, see Using encryption for cross-account operations.

    \n

    \n For example:\n

    \n
      \n
    • \n

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    \n \n

    Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

    \n     " + } } }, "traits": { @@ -10641,6 +11442,9 @@ }, { "value": "DEEP_ARCHIVE" + }, + { + "value": "OUTPOSTS" } ] } @@ -10662,17 +11466,17 @@ "com.amazonaws.s3#StorageClassAnalysisDataExport": { "type": "structure", "members": { - "Destination": { - "target": "com.amazonaws.s3#AnalyticsExportDestination", + "OutputSchemaVersion": { + "target": "com.amazonaws.s3#StorageClassAnalysisSchemaVersion", "traits": { - "smithy.api#documentation": "

    The place to store the data for an analysis.

    ", + "smithy.api#documentation": "

    The version of the output schema to use when exporting data. Must be V_1.

    ", "smithy.api#required": {} } }, - "OutputSchemaVersion": { - "target": "com.amazonaws.s3#StorageClassAnalysisSchemaVersion", + "Destination": { + "target": "com.amazonaws.s3#AnalyticsExportDestination", "traits": { - "smithy.api#documentation": "

    The version of the output schema to use when exporting data. Must be V_1.

    ", + "smithy.api#documentation": "

    The place to store the data for an analysis.

    ", "smithy.api#required": {} } } @@ -10703,17 +11507,17 @@ "com.amazonaws.s3#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Value": { + "target": "com.amazonaws.s3#Value", "traits": { - "smithy.api#documentation": "

    Name of the tag.

    ", + "smithy.api#documentation": "

    Value of the tag.

    ", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.s3#Value", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    Value of the tag.

    ", + "smithy.api#documentation": "

    Name of the object key.

    ", "smithy.api#required": {} } } @@ -10780,7 +11584,7 @@ "Permission": { "target": "com.amazonaws.s3#BucketLogsPermission", "traits": { - "smithy.api#documentation": "

    Logging permissions assigned to the Grantee for the bucket.

    " + "smithy.api#documentation": "

    Logging permissions assigned to the grantee for the bucket.

    " } } }, @@ -10825,28 +11629,28 @@ "com.amazonaws.s3#TopicConfiguration": { "type": "structure", "members": { - "TopicArn": { - "target": "com.amazonaws.s3#TopicArn", + "Events": { + "target": "com.amazonaws.s3#EventList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a\n message when it detects events of the specified type.

    ", + "smithy.api#documentation": "

    The Amazon S3 bucket event about which to send notifications. For more\n information, see Supported Event\n Types in the Amazon Simple Storage Service Developer Guide.

    ", "smithy.api#required": {}, - "smithy.api#xmlName": "Topic" + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Event" } }, - "Id": { - "target": "com.amazonaws.s3#NotificationId" - }, "Filter": { "target": "com.amazonaws.s3#NotificationConfigurationFilter" }, - "Events": { - "target": "com.amazonaws.s3#EventList", + "TopicArn": { + "target": "com.amazonaws.s3#TopicArn", "traits": { - "smithy.api#documentation": "

    The Amazon S3 bucket event about which to send notifications. For more\n information, see Supported Event\n Types in the Amazon Simple Storage Service Developer Guide.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a\n message when it detects events of the specified type.

    ", "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Event" + "smithy.api#xmlName": "Topic" } + }, + "Id": { + "target": "com.amazonaws.s3#NotificationId" } }, "traits": { @@ -10862,18 +11666,18 @@ "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 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 specified storage class. The value must be a positive integer.

    " } }, + "Date": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "

    Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

    " + } + }, "StorageClass": { "target": "com.amazonaws.s3#TransitionStorageClass", "traits": { @@ -10944,7 +11748,7 @@ "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\n option to specify your existing Amazon S3 object as a data source for the part you are\n uploading. To upload a part from an existing object, you use the UploadPartCopy\n operation.

    \n     \n \n

    You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to\n your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must\n 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\n data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

    \n \n \n \n

    \n Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts 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\n key in your initiate multipart upload request, you must provide identical\n encryption information in each part upload using the following headers.

    \n \n \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 \n

    \n Special Errors\n

    \n
      \n
    • \n

      \n \n

      \n
        \n
      • \n

        \n Code: NoSuchUpload \n

        \n
        • \n
      • \n

        \n Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. \n

        \n
        • \n
      • \n

        \n \tHTTP Status Code: 404 Not Found\t \n

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client \n

        \n
        • \n
      \n
      • \n
    \n \n \n \n \n \n \n

    \n Related Resources\n

    \n ", + "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\n option to specify your existing Amazon S3 object as a data source for the part you are\n uploading. To upload a part from an existing object, you use the UploadPartCopy\n operation.

    \n     \n \n

    You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to\n your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must\n 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\n data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

    \n\t\t\n\t\t

    If the upload request is signed with Signature Version 4, then AWS S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (AWS Signature Version 4).

    \n \n \n \n

    \n Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts 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\n key in your initiate multipart upload request, you must provide identical\n encryption information in each part upload using the following headers.

    \n \n \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 \n

    \n Special Errors\n

    \n
      \n
    • \n
        \n
      • \n

        \n Code: NoSuchUpload \n

        \n
        • \n
      • \n

        \n Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. \n

        \n
        • \n
      • \n

        \n \tHTTP Status Code: 404 Not Found\t \n

        \n
        • \n
      • \n

        \n SOAP Fault Code Prefix: Client \n

        \n
        • \n
      \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", @@ -10961,7 +11765,7 @@ "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 a\n byte range by adding the request header x-amz-copy-source-range in your request.

    \n

    The minimum allowable part size for a multipart upload is 5 MB. For more information about\n multipart upload limits, go to Quick Facts in the\n Amazon Simple Storage Service Developer Guide.

    \n \n

    Instead of using an existing object as part data, you might use the UploadPart 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
    • \n

      For conceptual information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    • \n

      For information about permissions required to use the multipart upload API, see\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    • \n

      For information about copying objects using a single atomic operation vs. the\n multipart upload, see Operations on\n Objects in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    • \n

      For information about using server-side encryption with customer-provided\n encryption keys with the UploadPartCopy operation, see CopyObject\n and UploadPart.

      \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
    • \n

      \n Consideration 1 - If both of the\n x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the\n request as follows:

      \n

      \n x-amz-copy-source-if-match condition evaluates to true,\n and;

      \n

      \n x-amz-copy-source-if-unmodified-since condition evaluates to\n false;

      \n

      Amazon S3 returns 200 OK and copies the data.\n

      \n \n
      • \n
    • \n

      \n Consideration 2 - If both of the\n x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request\n as follows:

      \n

      \n x-amz-copy-source-if-none-match condition evaluates to\n false, and;

      \n

      \n x-amz-copy-source-if-modified-since condition evaluates to\n true;

      \n

      Amazon S3 returns 412 Precondition Failed response code.\n

      \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\n the object to copy. If the current version is a delete marker and you don't specify a\n versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because\n the object does not exist. If you specify versionId in the\n x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns\n an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the\n 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 Code: NoSuchUpload \n

        \n
        • \n
      • \n

        \n Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. \n

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found \n

        \n
        • \n
      \n
      • \n
    • \n

      \n \n

      \n
        \n
      • \n

        \n Code: InvalidRequest \n

        \n
        • \n
      • \n

        \n Cause: The specified copy source is not supported as a byte-range copy source. \n

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request \n

        \n
        • \n
      \n
      • \n
    \n \n \n \n \n \n \n

    \n Related Resources\n

    \n ", + "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 a\n byte range by adding the request header x-amz-copy-source-range in your request.

    \n

    The minimum allowable part size for a multipart upload is 5 MB. For more information about\n multipart upload limits, go to Quick Facts in the\n Amazon Simple Storage Service Developer Guide.

    \n \n

    Instead of using an existing object as part data, you might use the UploadPart 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
    • \n

      For conceptual information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    • \n

      For information about permissions required to use the multipart upload API, see\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    • \n

      For information about copying objects using a single atomic operation vs. the\n multipart upload, see Operations on\n Objects in the Amazon Simple Storage Service Developer Guide.

      \n
      • \n
    • \n

      For information about using server-side encryption with customer-provided\n encryption keys with the UploadPartCopy operation, see CopyObject\n and UploadPart.

      \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
    • \n

      \n Consideration 1 - If both of the\n x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the\n request as follows:

      \n

      \n x-amz-copy-source-if-match condition evaluates to true,\n and;

      \n

      \n x-amz-copy-source-if-unmodified-since condition evaluates to\n false;

      \n

      Amazon S3 returns 200 OK and copies the data.\n

      \n \n
      • \n
    • \n

      \n Consideration 2 - If both of the\n x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request\n as follows:

      \n

      \n x-amz-copy-source-if-none-match condition evaluates to\n false, and;

      \n

      \n x-amz-copy-source-if-modified-since condition evaluates to\n true;

      \n

      Amazon S3 returns 412 Precondition Failed response code.\n

      \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\n the object to copy. If the current version is a delete marker and you don't specify a\n versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because\n the object does not exist. If you specify versionId in the\n x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns\n an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the\n 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 Code: NoSuchUpload \n

        \n
        • \n
      • \n

        \n Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. \n

        \n
        • \n
      • \n

        \n HTTP Status Code: 404 Not Found \n

        \n
        • \n
      \n
      • \n
    • \n
        \n
      • \n

        \n Code: InvalidRequest \n

        \n
        • \n
      • \n

        \n Cause: The specified copy source is not supported as a byte-range copy source. \n

        \n
        • \n
      • \n

        \n HTTP Status Code: 400 Bad Request \n

        \n
        • \n
      \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", @@ -10972,25 +11776,25 @@ "com.amazonaws.s3#UploadPartCopyOutput": { "type": "structure", "members": { - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "CopySourceVersionId": { + "target": "com.amazonaws.s3#CopySourceVersionId", "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "

    The version of the source object that was copied, if you have enabled versioning on the source bucket.

    ", + "smithy.api#httpHeader": "x-amz-copy-source-version-id" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "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" + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, "CopyPartResult": { @@ -11006,18 +11810,18 @@ "smithy.api#httpHeader": "x-amz-request-charged" } }, - "CopySourceVersionId": { - "target": "com.amazonaws.s3#CopySourceVersionId", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

    The version of the source object that was copied, if you have enabled versioning on the source bucket.

    ", - "smithy.api#httpHeader": "x-amz-copy-source-version-id" + "smithy.api#documentation": "

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "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" } } } @@ -11025,61 +11829,76 @@ "com.amazonaws.s3#UploadPartCopyRequest": { "type": "structure", "members": { + "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": {} + } + }, "RequestPayer": { "target": "com.amazonaws.s3#RequestPayer", "traits": { "smithy.api#httpHeader": "x-amz-request-payer" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "CopySourceRange": { + "target": "com.amazonaws.s3#CopySourceRange", "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" + "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" } }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "

    Upload ID identifying the multipart upload whose part is being copied.

    ", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} + "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" } }, - "CopySourceIfUnmodifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "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" + "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "CopySourceIfNoneMatch": { - "target": "com.amazonaws.s3#CopySourceIfNoneMatch", + "CopySourceIfMatch": { + "target": "com.amazonaws.s3#CopySourceIfMatch", "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" + "smithy.api#documentation": "

    Copies the object if its entity tag (ETag) matches the specified tag.

    ", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" } }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    The bucket name.

    ", + "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": {} } }, - "CopySourceIfMatch": { - "target": "com.amazonaws.s3#CopySourceIfMatch", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "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" + "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" } }, - "CopySourceSSECustomerKeyMD5": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", + "CopySourceSSECustomerKey": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKey", "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" + "smithy.api#documentation": "

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

    ", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + } + }, + "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 formats, depending on whether you want \n to access the source object through an access point:

    \n
      \n
    • \n

      For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). \n For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

      \n
      • \n
    • \n

      For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

      \n \n

      Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

      \n       \n

      Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

      \n
      • \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": {} } }, "PartNumber": { @@ -11090,11 +11909,11 @@ "smithy.api#required": {} } }, - "CopySourceSSECustomerKey": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "CopySourceIfModifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfModifiedSince", "traits": { - "smithy.api#documentation": "

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

    ", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + "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" } }, "CopySourceSSECustomerAlgorithm": { @@ -11104,48 +11923,47 @@ "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" } }, - "CopySourceIfModifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfModifiedSince", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "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" + "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "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" } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "ExpectedSourceBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "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" + "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" } }, - "CopySourceRange": { - "target": "com.amazonaws.s3#CopySourceRange", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "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" + "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" } }, - "CopySource": { - "target": "com.amazonaws.s3#CopySource", + "CopySourceIfNoneMatch": { + "target": "com.amazonaws.s3#CopySourceIfNoneMatch", "traits": { - "smithy.api#documentation": "

    The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

    ", - "smithy.api#httpHeader": "x-amz-copy-source", - "smithy.api#required": {} + "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" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "CopySourceSSECustomerKeyMD5": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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" } } } @@ -11153,11 +11971,11 @@ "com.amazonaws.s3#UploadPartOutput": { "type": "structure", "members": { - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) was used for the object.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, "ServerSideEncryption": { @@ -11167,6 +11985,20 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) was used for the object.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, "RequestCharged": { "target": "com.amazonaws.s3#RequestCharged", "traits": { @@ -11179,53 +12011,32 @@ "smithy.api#documentation": "

    Entity tag for the uploaded object.

    ", "smithy.api#httpHeader": "ETag" } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } } } }, "com.amazonaws.s3#UploadPartRequest": { "type": "structure", "members": { - "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 determined automatically.

    ", - "smithy.api#httpHeader": "Content-Length" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#documentation": "

    Name of the bucket to which the multipart upload was initiated.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    Part number of part being uploaded. This is a positive integer between 1 and 10,000.

    ", + "smithy.api#httpQuery": "partNumber", "smithy.api#required": {} } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", "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" + "smithy.api#documentation": "

    Object data.

    ", + "smithy.api#httpPayload": {} } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "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" + "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" } }, "RequestPayer": { @@ -11234,35 +12045,43 @@ "smithy.api#httpHeader": "x-amz-request-payer" } }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#documentation": "

    The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when\n using the command from the CLI. This parameter is required if object lock parameters are\n specified.

    ", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#documentation": "

    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    ", + "smithy.api#httpHeader": "Content-Length" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "

    Specifies the algorithm to use to when encrypting the object (for example, AES256).

    ", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "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" } }, - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

    Object data.

    ", - "smithy.api#httpPayload": {} + "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": {} } }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

    Part number of part being uploaded. This is a positive integer between 1 and 10,000.

    ", - "smithy.api#httpQuery": "partNumber", + "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    ", + "smithy.api#httpLabel": {}, "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, AES256).

    ", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, "UploadId": { "target": "com.amazonaws.s3#MultipartUploadId", "traits": { @@ -11271,12 +12090,18 @@ "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "

    Object key for which the multipart upload was initiated.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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" + } + }, + "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 when\n using the command from the CLI. This parameter is required if object lock parameters are\n specified.

    ", + "smithy.api#httpHeader": "Content-MD5" } } } @@ -11299,18 +12124,18 @@ "com.amazonaws.s3#VersioningConfiguration": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.s3#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "

    The versioning state of the bucket.

    " + } + }, "MFADelete": { "target": "com.amazonaws.s3#MFADelete", "traits": { "smithy.api#documentation": "

    Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket 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": { @@ -11320,16 +12145,10 @@ "com.amazonaws.s3#WebsiteConfiguration": { "type": "structure", "members": { - "RoutingRules": { - "target": "com.amazonaws.s3#RoutingRules", - "traits": { - "smithy.api#documentation": "

    Rules that define when a redirect is applied and the redirect behavior.

    " - } - }, - "IndexDocument": { - "target": "com.amazonaws.s3#IndexDocument", + "ErrorDocument": { + "target": "com.amazonaws.s3#ErrorDocument", "traits": { - "smithy.api#documentation": "

    The name of the index document for the website.

    " + "smithy.api#documentation": "

    The name of the error document for the website.

    " } }, "RedirectAllRequestsTo": { @@ -11338,10 +12157,16 @@ "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     " } }, - "ErrorDocument": { - "target": "com.amazonaws.s3#ErrorDocument", + "IndexDocument": { + "target": "com.amazonaws.s3#IndexDocument", "traits": { - "smithy.api#documentation": "

    The name of the error document for the website.

    " + "smithy.api#documentation": "

    The name of the index document for the website.

    " + } + }, + "RoutingRules": { + "target": "com.amazonaws.s3#RoutingRules", + "traits": { + "smithy.api#documentation": "

    Rules that define when a redirect is applied and the redirect behavior.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/s3outposts.2017-07-25.json b/codegen/sdk-codegen/aws-models/s3outposts.2017-07-25.json new file mode 100644 index 000000000000..1a9ced2f25b8 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/s3outposts.2017-07-25.json @@ -0,0 +1,498 @@ +{ + "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.s3outposts#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.s3outposts#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    Access was denied for this action.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.s3outposts#CidrBlock": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.s3outposts#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.s3outposts#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    There was a conflict with this action, and it could not be completed.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.s3outposts#CreateEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3outposts#CreateEndpointRequest" + }, + "output": { + "target": "com.amazonaws.s3outposts#CreateEndpointResult" + }, + "errors": [ + { + "target": "com.amazonaws.s3outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3outposts#ConflictException" + }, + { + "target": "com.amazonaws.s3outposts#InternalServerException" + }, + { + "target": "com.amazonaws.s3outposts#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.s3outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    S3 on Outposts access points simplify managing data access at scale for shared datasets \n in Amazon S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform \n actions within your virtual private cloud (VPC).

    \n

    This action creates an endpoint and associates it with the specified Outpost.

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#http": { + "method": "POST", + "uri": "/S3Outposts/CreateEndpoint", + "code": 200 + } + } + }, + "com.amazonaws.s3outposts#CreateEndpointRequest": { + "type": "structure", + "members": { + "OutpostId": { + "target": "com.amazonaws.s3outposts#OutpostId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS Outpost.

    ", + "smithy.api#required": {} + } + }, + "SecurityGroupId": { + "target": "com.amazonaws.s3outposts#SecurityGroupId", + "traits": { + "smithy.api#documentation": "

    The ID of the security group to use with the endpoint.

    ", + "smithy.api#required": {} + } + }, + "SubnetId": { + "target": "com.amazonaws.s3outposts#SubnetId", + "traits": { + "smithy.api#documentation": "

    The ID of the subnet in the selected VPC.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3outposts#CreateEndpointResult": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.s3outposts#EndpointArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint.

    " + } + } + } + }, + "com.amazonaws.s3outposts#CreationTime": { + "type": "timestamp" + }, + "com.amazonaws.s3outposts#DeleteEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3outposts#DeleteEndpointRequest" + }, + "errors": [ + { + "target": "com.amazonaws.s3outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3outposts#InternalServerException" + }, + { + "target": "com.amazonaws.s3outposts#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.s3outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    S3 on Outposts access points simplify managing data access at scale for shared datasets \n in Amazon S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform \n actions within your virtual private cloud (VPC).

    \n

    This action deletes an endpoint.\n

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/S3Outposts/DeleteEndpoint", + "code": 200 + } + } + }, + "com.amazonaws.s3outposts#DeleteEndpointRequest": { + "type": "structure", + "members": { + "EndpointId": { + "target": "com.amazonaws.s3outposts#EndpointId", + "traits": { + "smithy.api#documentation": "

    The ID of the end point.

    ", + "smithy.api#httpQuery": "endpointId", + "smithy.api#required": {} + } + }, + "OutpostId": { + "target": "com.amazonaws.s3outposts#OutpostId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS Outpost.

    ", + "smithy.api#httpQuery": "outpostId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3outposts#Endpoint": { + "type": "structure", + "members": { + "OutpostsId": { + "target": "com.amazonaws.s3outposts#OutpostId", + "traits": { + "smithy.api#documentation": "

    The ID of the AWS Outpost.

    " + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.s3outposts#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "

    The network interface of the endpoint.

    " + } + }, + "Status": { + "target": "com.amazonaws.s3outposts#EndpointStatus", + "traits": { + "smithy.api#documentation": "

    The status of the endpoint.

    " + } + }, + "CidrBlock": { + "target": "com.amazonaws.s3outposts#CidrBlock", + "traits": { + "smithy.api#documentation": "

    The VPC CIDR committed by this endpoint.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.s3outposts#CreationTime", + "traits": { + "smithy.api#documentation": "

    The time the endpoint was created.

    " + } + }, + "EndpointArn": { + "target": "com.amazonaws.s3outposts#EndpointArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    S3 on Outposts access points simplify managing data access at scale for shared datasets \n in Amazon S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform \n actions within your virtual private cloud (VPC).

    " + } + }, + "com.amazonaws.s3outposts#EndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 500 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z\\-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|ec2)/endpoint/[a-zA-Z0-9]{19}$" + } + }, + "com.amazonaws.s3outposts#EndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 500 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{19}$" + } + }, + "com.amazonaws.s3outposts#EndpointStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + } + ] + } + }, + "com.amazonaws.s3outposts#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.s3outposts#Endpoint" + } + }, + "com.amazonaws.s3outposts#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.s3outposts#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.s3outposts#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    There was an exception with the internal server.

    ", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.s3outposts#ListEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3outposts#ListEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.s3outposts#ListEndpointsResult" + }, + "errors": [ + { + "target": "com.amazonaws.s3outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.s3outposts#InternalServerException" + }, + { + "target": "com.amazonaws.s3outposts#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.s3outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    S3 on Outposts access points simplify managing data access at scale for shared datasets \n in Amazon S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform \n actions within your virtual private cloud (VPC).

    \n

    This action lists endpoints associated with the Outpost.\n

    \n

    \n

    Related actions include:

    \n ", + "smithy.api#http": { + "method": "GET", + "uri": "/S3Outposts/ListEndpoints", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Endpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.s3outposts#ListEndpointsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.s3outposts#MaxResults", + "traits": { + "smithy.api#documentation": "

    The max number of endpoints that can be returned on the request.

    ", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.s3outposts#NextToken", + "traits": { + "smithy.api#documentation": "

    The next endpoint requested in the list.

    ", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.s3outposts#ListEndpointsResult": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.s3outposts#Endpoints", + "traits": { + "smithy.api#documentation": "

    Returns an array of endpoints associated with AWS Outpost.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.s3outposts#NextToken", + "traits": { + "smithy.api#documentation": "

    The next endpoint returned in the list.

    " + } + } + } + }, + "com.amazonaws.s3outposts#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.s3outposts#NetworkInterface": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.s3outposts#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

    The ID for the network interface.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The container for the network interface.

    " + } + }, + "com.amazonaws.s3outposts#NetworkInterfaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.s3outposts#NetworkInterfaces": { + "type": "list", + "member": { + "target": "com.amazonaws.s3outposts#NetworkInterface" + } + }, + "com.amazonaws.s3outposts#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\+\\:\\/\\=\\?\\#-_]+$" + } + }, + "com.amazonaws.s3outposts#OutpostId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(op-[a-f0-9]{17}|\\d{12}|ec2)$" + } + }, + "com.amazonaws.s3outposts#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.s3outposts#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The requested resource was not found.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.s3outposts#S3Outposts": { + "type": "service", + "version": "2017-07-25", + "operations": [ + { + "target": "com.amazonaws.s3outposts#CreateEndpoint" + }, + { + "target": "com.amazonaws.s3outposts#DeleteEndpoint" + }, + { + "target": "com.amazonaws.s3outposts#ListEndpoints" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "S3Outposts", + "arnNamespace": "s3-outposts", + "cloudFormationName": "S3Outposts", + "cloudTrailEventSource": "model.s3outposts.northstar.seaport.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "s3-outposts" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

    Amazon S3 on Outposts provides access to S3 on Outposts operations.

    ", + "smithy.api#title": "Amazon S3 on Outposts" + } + }, + "com.amazonaws.s3outposts#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^sg-([0-9a-f]{8}|[0-9a-f]{17})$" + } + }, + "com.amazonaws.s3outposts#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" + } + }, + "com.amazonaws.s3outposts#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.s3outposts#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    There was an exception validating this data.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/sagemaker-a2i-runtime.2019-11-07.json b/codegen/sdk-codegen/aws-models/sagemaker-a2i-runtime.2019-11-07.json index 8185fbfc9f23..1d9791cd90d0 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker-a2i-runtime.2019-11-07.json +++ b/codegen/sdk-codegen/aws-models/sagemaker-a2i-runtime.2019-11-07.json @@ -54,7 +54,7 @@ "sdkId": "SageMaker A2I Runtime", "arnNamespace": "sagemaker", "cloudFormationName": "SageMakerA2IRuntime", - "cloudTrailEventSource": "runtime.a2i.sagemaker.amazonaws.com" + "cloudTrailEventSource": "sagemakera2iruntime.amazonaws.com" }, "aws.auth#sigv4": { "name": "sagemaker" @@ -199,6 +199,13 @@ "com.amazonaws.sagemakera2iruntime#DescribeHumanLoopResponse": { "type": "structure", "members": { + "HumanLoopName": { + "target": "com.amazonaws.sagemakera2iruntime#HumanLoopName", + "traits": { + "smithy.api#documentation": "

    The name of the human loop. The name must be lowercase, unique within the Region in your\n account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

    ", + "smithy.api#required": {} + } + }, "HumanLoopStatus": { "target": "com.amazonaws.sagemakera2iruntime#HumanLoopStatus", "traits": { @@ -206,10 +213,17 @@ "smithy.api#required": {} } }, - "FailureCode": { + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemakera2iruntime#FlowDefinitionArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the flow definition.

    ", + "smithy.api#required": {} + } + }, + "FailureReason": { "target": "com.amazonaws.sagemakera2iruntime#String", "traits": { - "smithy.api#documentation": "

    A failure code that identifies\n the\n type of failure.

    " + "smithy.api#documentation": "

    The reason why a human loop failed. The failure reason is returned when the status of the\n human loop is Failed.

    " } }, "HumanLoopOutput": { @@ -232,24 +246,10 @@ "smithy.api#required": {} } }, - "FailureReason": { + "FailureCode": { "target": "com.amazonaws.sagemakera2iruntime#String", "traits": { - "smithy.api#documentation": "

    The reason why a human loop failed. The failure reason is returned when the status of the\n human loop is Failed.

    " - } - }, - "HumanLoopName": { - "target": "com.amazonaws.sagemakera2iruntime#HumanLoopName", - "traits": { - "smithy.api#documentation": "

    The name of the human loop. The name must be lowercase, unique within the Region in your\n account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

    ", - "smithy.api#required": {} - } - }, - "FlowDefinitionArn": { - "target": "com.amazonaws.sagemakera2iruntime#FlowDefinitionArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the flow definition.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A failure code that identifies\n the\n type of failure.

    " } } } @@ -374,18 +374,24 @@ "com.amazonaws.sagemakera2iruntime#HumanLoopSummary": { "type": "structure", "members": { - "HumanLoopName": { - "target": "com.amazonaws.sagemakera2iruntime#HumanLoopName", - "traits": { - "smithy.api#documentation": "

    The name of the human loop.

    " - } - }, "FlowDefinitionArn": { "target": "com.amazonaws.sagemakera2iruntime#FlowDefinitionArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the flow definition used to configure the human\n loop.

    " } }, + "FailureReason": { + "target": "com.amazonaws.sagemakera2iruntime#FailureReason", + "traits": { + "smithy.api#documentation": "

    The reason why the human loop failed. A failure reason is returned when the status of the\n human loop is Failed.

    " + } + }, + "HumanLoopName": { + "target": "com.amazonaws.sagemakera2iruntime#HumanLoopName", + "traits": { + "smithy.api#documentation": "

    The name of the human loop.

    " + } + }, "HumanLoopStatus": { "target": "com.amazonaws.sagemakera2iruntime#HumanLoopStatus", "traits": { @@ -397,12 +403,6 @@ "traits": { "smithy.api#documentation": "

    When Amazon Augmented AI created the human loop.

    " } - }, - "FailureReason": { - "target": "com.amazonaws.sagemakera2iruntime#FailureReason", - "traits": { - "smithy.api#documentation": "

    The reason why the human loop failed. A failure reason is returned when the status of the\n human loop is Failed.

    " - } } }, "traits": { @@ -477,6 +477,13 @@ "smithy.api#httpQuery": "CreationTimeAfter" } }, + "NextToken": { + "target": "com.amazonaws.sagemakera2iruntime#NextToken", + "traits": { + "smithy.api#documentation": "

    A token to display the next page of results.

    ", + "smithy.api#httpQuery": "NextToken" + } + }, "CreationTimeBefore": { "target": "com.amazonaws.sagemakera2iruntime#Timestamp", "traits": { @@ -492,13 +499,6 @@ "smithy.api#httpQuery": "MaxResults" } }, - "NextToken": { - "target": "com.amazonaws.sagemakera2iruntime#NextToken", - "traits": { - "smithy.api#documentation": "

    A token to display the next page of results.

    ", - "smithy.api#httpQuery": "NextToken" - } - }, "FlowDefinitionArn": { "target": "com.amazonaws.sagemakera2iruntime#FlowDefinitionArn", "traits": { @@ -519,18 +519,18 @@ "com.amazonaws.sagemakera2iruntime#ListHumanLoopsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemakera2iruntime#NextToken", - "traits": { - "smithy.api#documentation": "

    A token to display the next page of results.

    " - } - }, "HumanLoopSummaries": { "target": "com.amazonaws.sagemakera2iruntime#HumanLoopSummaries", "traits": { "smithy.api#documentation": "

    An array of objects that contain information about the human loops.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.sagemakera2iruntime#NextToken", + "traits": { + "smithy.api#documentation": "

    A token to display the next page of results.

    " + } } } }, @@ -638,13 +638,6 @@ "smithy.api#required": {} } }, - "HumanLoopInput": { - "target": "com.amazonaws.sagemakera2iruntime#HumanLoopInput", - "traits": { - "smithy.api#documentation": "

    An object that contains information about the human loop.

    ", - "smithy.api#required": {} - } - }, "HumanLoopName": { "target": "com.amazonaws.sagemakera2iruntime#HumanLoopName", "traits": { @@ -657,6 +650,13 @@ "traits": { "smithy.api#documentation": "

    Attributes of the specified data. Use DataAttributes to specify if your data\n is free of personally identifiable information and/or free of adult content.

    " } + }, + "HumanLoopInput": { + "target": "com.amazonaws.sagemakera2iruntime#HumanLoopInput", + "traits": { + "smithy.api#documentation": "

    An object that contains information about the human loop.

    ", + "smithy.api#required": {} + } } } }, diff --git a/codegen/sdk-codegen/aws-models/sagemaker-runtime.2017-05-13.json b/codegen/sdk-codegen/aws-models/sagemaker-runtime.2017-05-13.json index c7198ec9d47a..1417655a6893 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker-runtime.2017-05-13.json +++ b/codegen/sdk-codegen/aws-models/sagemaker-runtime.2017-05-13.json @@ -42,13 +42,13 @@ "sdkId": "SageMaker Runtime", "arnNamespace": "sagemaker", "cloudFormationName": "SageMakerRuntime", - "cloudTrailEventSource": "runtime.sagemaker.amazonaws.com" + "cloudTrailEventSource": "sagemakerruntime.amazonaws.com" }, "aws.auth#sigv4": { "name": "sagemaker" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

    \n Amazon SageMaker runtime API.\n

    ", + "smithy.api#documentation": "

    The Amazon SageMaker runtime API.

    ", "smithy.api#title": "Amazon SageMaker Runtime" } }, @@ -57,11 +57,22 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 5242880 + "max": 6291456 }, "smithy.api#sensitive": {} } }, + "com.amazonaws.sagemakerruntime#CustomAttributesHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "\\p{ASCII}*", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.sagemakerruntime#EndpointName": { "type": "string", "traits": { @@ -78,7 +89,8 @@ "smithy.api#length": { "min": 0, "max": 1024 - } + }, + "smithy.api#pattern": "\\p{ASCII}*" } }, "com.amazonaws.sagemakerruntime#InternalFailure": { @@ -89,7 +101,7 @@ } }, "traits": { - "smithy.api#documentation": "

    \n Internal failure occurred. \n

    ", + "smithy.api#documentation": "

    An internal failure occurred.

    ", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -117,7 +129,7 @@ } ], "traits": { - "smithy.api#documentation": "

    After you deploy a model into production using Amazon SageMaker hosting services, your\n client applications use this API to get inferences from the model hosted at the\n specified endpoint.

    \n

    For an overview of Amazon SageMaker, see How It Works\n

    \n

    \n Amazon SageMaker strips all POST headers except those supported by \n the API. Amazon SageMaker might add additional headers. You should \n not rely on the behavior of headers outside those enumerated in the request syntax.\n

    ", + "smithy.api#documentation": "

    After you deploy a model into production using Amazon SageMaker hosting services, your\n client applications use this API to get inferences from the model hosted at the\n specified endpoint.

    \n

    For an overview of Amazon SageMaker, see How It Works.

    \n

    Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

    \n

    Calls to InvokeEndpoint are authenticated by using AWS Signature Version\n 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API\n Reference.

    \n

    A customer's model containers must respond to requests within 60 seconds. The model\n itself can have a maximum processing time of 60 seconds before responding to the\n /invocations. If your model is going to take 50-60 seconds of processing time, the SDK\n socket timeout should be set to be 70 seconds.

    \n \n

    Endpoints are scoped to an individual account, and are not public. The URL does\n not contain the account ID, but Amazon SageMaker determines the account ID from the\n authentication token that is supplied by the caller.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/endpoints/{EndpointName}/invocations", @@ -135,14 +147,28 @@ "smithy.api#httpHeader": "Content-Type" } }, + "TargetModel": { + "target": "com.amazonaws.sagemakerruntime#TargetModelHeader", + "traits": { + "smithy.api#documentation": "

    The model to request for inference when invoking a multi-model endpoint.

    ", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Target-Model" + } + }, "Body": { "target": "com.amazonaws.sagemakerruntime#BodyBlob", "traits": { - "smithy.api#documentation": "

    Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker passes all of the data in the body to the model.

    ", + "smithy.api#documentation": "

    Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker passes all of the data in the body to the model.

    \n

    For information about the format of the request body, see Common Data\n Formats-Inference.

    ", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, + "CustomAttributes": { + "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", + "traits": { + "smithy.api#documentation": "

    Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to provide an ID that you can\n use to track a request or to provide other metadata that a service endpoint was\n programmed to process. The value must consist of no more than 1024 visible US-ASCII\n characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). This feature is\n currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

    ", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" + } + }, "EndpointName": { "target": "com.amazonaws.sagemakerruntime#EndpointName", "traits": { @@ -151,6 +177,13 @@ "smithy.api#required": {} } }, + "TargetVariant": { + "target": "com.amazonaws.sagemakerruntime#TargetVariantHeader", + "traits": { + "smithy.api#documentation": "

    Specify the production variant to send the inference request to when\n invoking an endpoint that is running two or more variants. Note that this parameter\n overrides the default behavior for the endpoint, which is to distribute the invocation\n traffic based on the variant weights.

    ", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Target-Variant" + } + }, "Accept": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { @@ -163,14 +196,6 @@ "com.amazonaws.sagemakerruntime#InvokeEndpointOutput": { "type": "structure", "members": { - "Body": { - "target": "com.amazonaws.sagemakerruntime#BodyBlob", - "traits": { - "smithy.api#documentation": "

    Includes the inference provided by the model.

    ", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "InvokedProductionVariant": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { @@ -178,12 +203,27 @@ "smithy.api#httpHeader": "x-Amzn-Invoked-Production-Variant" } }, + "Body": { + "target": "com.amazonaws.sagemakerruntime#BodyBlob", + "traits": { + "smithy.api#documentation": "

    Includes the inference provided by the model.

    \n

    For information about the format of the response body, see Common Data\n Formats-Inference.

    ", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, "ContentType": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { "smithy.api#documentation": "

    The MIME type of the inference returned in the response body.

    ", "smithy.api#httpHeader": "Content-Type" } + }, + "CustomAttributes": { + "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", + "traits": { + "smithy.api#documentation": "

    Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.

    \n

    This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker\n Python SDK.

    ", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" + } } } }, @@ -205,19 +245,19 @@ "LogStreamArn": { "target": "com.amazonaws.sagemakerruntime#LogStreamArn", "traits": { - "smithy.api#documentation": "

    \n Amazon Resource Name (ARN) of the log stream. \n

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the log stream.

    " } }, - "OriginalStatusCode": { - "target": "com.amazonaws.sagemakerruntime#StatusCode", + "OriginalMessage": { + "target": "com.amazonaws.sagemakerruntime#Message", "traits": { - "smithy.api#documentation": "

    \n Original status code. \n

    " + "smithy.api#documentation": "

    Original message.

    " } }, - "OriginalMessage": { - "target": "com.amazonaws.sagemakerruntime#Message", + "OriginalStatusCode": { + "target": "com.amazonaws.sagemakerruntime#StatusCode", "traits": { - "smithy.api#documentation": "

    \n Original message. \n

    " + "smithy.api#documentation": "

    Original status code.

    " } }, "Message": { @@ -225,7 +265,7 @@ } }, "traits": { - "smithy.api#documentation": "

    \n Model (owned by the customer in the container) returned an error 500. \n

    ", + "smithy.api#documentation": "

    Model (owned by the customer in the container) returned 4xx or 5xx error code.\n

    ", "smithy.api#error": "client", "smithy.api#httpError": 424 } @@ -238,7 +278,7 @@ } }, "traits": { - "smithy.api#documentation": "

    \n Service is unavailable. Try your call again.\n

    ", + "smithy.api#documentation": "

    The service is unavailable. Try your call again.

    ", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -249,6 +289,26 @@ "smithy.api#box": {} } }, + "com.amazonaws.sagemakerruntime#TargetModelHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "\\A\\S[\\p{Print}]*\\z" + } + }, + "com.amazonaws.sagemakerruntime#TargetVariantHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + } + }, "com.amazonaws.sagemakerruntime#ValidationError": { "type": "structure", "members": { @@ -257,7 +317,7 @@ } }, "traits": { - "smithy.api#documentation": "

    \n Inspect your request and try again.\n \n

    ", + "smithy.api#documentation": "

    Inspect your request and try again.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json b/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json index 200756ece528..9c8962ce6b47 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json @@ -137,17 +137,10 @@ "com.amazonaws.sagemaker#AlgorithmSpecification": { "type": "structure", "members": { - "TrainingInputMode": { - "target": "com.amazonaws.sagemaker#TrainingInputMode", - "traits": { - "smithy.api#documentation": "

    The input mode that the algorithm supports. For the input modes that Amazon SageMaker\n algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker\n downloads the training data from S3 to the provisioned ML storage Volume, and mounts the\n directory to docker volume for training container. If an algorithm supports the\n Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

    \n

    In File mode, make sure you provision ML storage volume with sufficient capacity\n to accommodate the data download from S3. In addition to the training data, the ML\n storage volume also stores the output model. The algorithm container use ML storage\n volume to also store intermediate information, if any.

    \n

    For distributed algorithms using File mode, training data is distributed\n uniformly, and your training duration is predictable if the input data objects size is\n approximately same. Amazon SageMaker does not split the files any further for model training. If the\n object sizes are skewed, training won't be optimal as the data distribution is also\n skewed where one host in a training cluster is overloaded, thus becoming bottleneck in\n training.

    ", - "smithy.api#required": {} - } - }, - "EnableSageMakerMetricsTimeSeries": { - "target": "com.amazonaws.sagemaker#Boolean", + "TrainingImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", "traits": { - "smithy.api#documentation": "

    To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:

    \n
      \n
    • \n

      You use one of the Amazon SageMaker built-in algorithms

      \n
      • \n
    • \n

      You use one of the following Prebuilt Amazon SageMaker Docker Images:

      \n
        \n
      • \n

        Tensorflow (version >= 1.15)

        \n
        • \n
      • \n

        MXNet (version >= 1.6)

        \n
        • \n
      • \n

        PyTorch (version >= 1.3)

        \n
        • \n
      \n
      • \n
    • \n

      You specify at least one MetricDefinition\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

    " } }, "AlgorithmName": { @@ -162,10 +155,17 @@ "smithy.api#documentation": "

    A list of metric definition objects. Each object specifies the metric name and regular\n expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

    " } }, - "TrainingImage": { - "target": "com.amazonaws.sagemaker#AlgorithmImage", + "EnableSageMakerMetricsTimeSeries": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

    " + "smithy.api#documentation": "

    To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:

    \n
      \n
    • \n

      You use one of the Amazon SageMaker built-in algorithms

      \n
      • \n
    • \n

      You use one of the following Prebuilt Amazon SageMaker Docker Images:

      \n
        \n
      • \n

        Tensorflow (version >= 1.15)

        \n
        • \n
      • \n

        MXNet (version >= 1.6)

        \n
        • \n
      • \n

        PyTorch (version >= 1.3)

        \n
        • \n
      \n
      • \n
    • \n

      You specify at least one MetricDefinition\n

      \n
      • \n
    " + } + }, + "TrainingInputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#documentation": "

    The input mode that the algorithm supports. For the input modes that Amazon SageMaker\n algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker\n downloads the training data from S3 to the provisioned ML storage Volume, and mounts the\n directory to docker volume for training container. If an algorithm supports the\n Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

    \n

    In File mode, make sure you provision ML storage volume with sufficient capacity\n to accommodate the data download from S3. In addition to the training data, the ML\n storage volume also stores the output model. The algorithm container use ML storage\n volume to also store intermediate information, if any.

    \n

    For distributed algorithms using File mode, training data is distributed\n uniformly, and your training duration is predictable if the input data objects size is\n approximately same. Amazon SageMaker does not split the files any further for model training. If the\n object sizes are skewed, training won't be optimal as the data distribution is also\n skewed where one host in a training cluster is overloaded, thus becoming bottleneck in\n training.

    ", + "smithy.api#required": {} } } }, @@ -203,16 +203,16 @@ "com.amazonaws.sagemaker#AlgorithmStatusDetails": { "type": "structure", "members": { - "ValidationStatuses": { + "ImageScanStatuses": { "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", "traits": { - "smithy.api#documentation": "

    The status of algorithm validation.

    " + "smithy.api#documentation": "

    The status of the scan of the algorithm's Docker image container.

    " } }, - "ImageScanStatuses": { + "ValidationStatuses": { "target": "com.amazonaws.sagemaker#AlgorithmStatusItemList", "traits": { - "smithy.api#documentation": "

    The status of the scan of the algorithm's Docker image container.

    " + "smithy.api#documentation": "

    The status of algorithm validation.

    " } } }, @@ -223,10 +223,10 @@ "com.amazonaws.sagemaker#AlgorithmStatusItem": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.sagemaker#DetailedAlgorithmStatus", + "Name": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    The current status.

    ", + "smithy.api#documentation": "

    The name of the algorithm for which the overall status is being reported.

    ", "smithy.api#required": {} } }, @@ -236,10 +236,10 @@ "smithy.api#documentation": "

    if the overall status is Failed, the reason for the failure.

    " } }, - "Name": { - "target": "com.amazonaws.sagemaker#EntityName", + "Status": { + "target": "com.amazonaws.sagemaker#DetailedAlgorithmStatus", "traits": { - "smithy.api#documentation": "

    The name of the algorithm for which the overall status is being reported.

    ", + "smithy.api#documentation": "

    The current status.

    ", "smithy.api#required": {} } } @@ -257,13 +257,6 @@ "com.amazonaws.sagemaker#AlgorithmSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the algorithm was created.

    ", - "smithy.api#required": {} - } - }, "AlgorithmDescription": { "target": "com.amazonaws.sagemaker#EntityDescription", "traits": { @@ -277,6 +270,13 @@ "smithy.api#required": {} } }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

    A timestamp that shows when the algorithm was created.

    ", + "smithy.api#required": {} + } + }, "AlgorithmArn": { "target": "com.amazonaws.sagemaker#AlgorithmArn", "traits": { @@ -305,13 +305,6 @@ "com.amazonaws.sagemaker#AlgorithmValidationProfile": { "type": "structure", "members": { - "TrainingJobDefinition": { - "target": "com.amazonaws.sagemaker#TrainingJobDefinition", - "traits": { - "smithy.api#documentation": "

    The TrainingJobDefinition object that describes the training job that\n Amazon SageMaker runs to validate your algorithm.

    ", - "smithy.api#required": {} - } - }, "ProfileName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { @@ -324,6 +317,13 @@ "traits": { "smithy.api#documentation": "

    The TransformJobDefinition object that describes the transform job that\n Amazon SageMaker runs to validate your algorithm.

    " } + }, + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#TrainingJobDefinition", + "traits": { + "smithy.api#documentation": "

    The TrainingJobDefinition object that describes the training job that\n Amazon SageMaker runs to validate your algorithm.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -392,6 +392,12 @@ "com.amazonaws.sagemaker#AppDetails": { "type": "structure", "members": { + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "

    The type of app.

    " + } + }, "AppName": { "target": "com.amazonaws.sagemaker#AppName", "traits": { @@ -404,18 +410,6 @@ "smithy.api#documentation": "

    The creation time.

    " } }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "

    The domain ID.

    " - } - }, - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", - "traits": { - "smithy.api#documentation": "

    The type of app.

    " - } - }, "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { @@ -427,6 +421,12 @@ "traits": { "smithy.api#documentation": "

    The status.

    " } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

    The domain ID.

    " + } } }, "traits": { @@ -584,6 +584,21 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, + "com.amazonaws.sagemaker#AppNetworkAccessType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PublicInternetOnly", + "name": "PublicInternetOnly" + }, + { + "value": "VpcOnly", + "name": "VpcOnly" + } + ] + } + }, "com.amazonaws.sagemaker#AppSortKey": { "type": "string", "traits": { @@ -598,10 +613,10 @@ "com.amazonaws.sagemaker#AppSpecification": { "type": "structure", "members": { - "ContainerArguments": { - "target": "com.amazonaws.sagemaker#ContainerArguments", + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", "traits": { - "smithy.api#documentation": "

    The arguments for a container used to run a processing job.

    " + "smithy.api#documentation": "

    The entrypoint for a container used to run a processing job.

    " } }, "ImageUri": { @@ -611,10 +626,10 @@ "smithy.api#required": {} } }, - "ContainerEntrypoint": { - "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#ContainerArguments", "traits": { - "smithy.api#documentation": "

    The entrypoint for a container used to run a processing job.

    " + "smithy.api#documentation": "

    The arguments for a container used to run a processing job.

    " } } }, @@ -716,17 +731,17 @@ "com.amazonaws.sagemaker#AssociateTrialComponentRequest": { "type": "structure", "members": { - "TrialComponentName": { + "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the component to associated with the trial.

    ", + "smithy.api#documentation": "

    The name of the trial to associate with.

    ", "smithy.api#required": {} } }, - "TrialName": { + "TrialComponentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the trial to associate with.

    ", + "smithy.api#documentation": "

    The name of the component to associated with the trial.

    ", "smithy.api#required": {} } } @@ -735,17 +750,17 @@ "com.amazonaws.sagemaker#AssociateTrialComponentResponse": { "type": "structure", "members": { - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "

    The ARN of the trial component.

    " - } - }, "TrialArn": { "target": "com.amazonaws.sagemaker#TrialArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial.

    " } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the trial component.

    " + } } } }, @@ -789,84 +804,77 @@ "com.amazonaws.sagemaker#AutoMLCandidate": { "type": "structure", "members": { - "CandidateName": { - "target": "com.amazonaws.sagemaker#CandidateName", + "InferenceContainers": { + "target": "com.amazonaws.sagemaker#AutoMLContainerDefinitions", "traits": { - "smithy.api#documentation": "

    The candidate name.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The inference containers.

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "FinalAutoMLJobObjectiveMetric": { + "target": "com.amazonaws.sagemaker#FinalAutoMLJobObjectiveMetric" + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The failure reason.

    " + "smithy.api#documentation": "

    The end time.

    " } }, - "CandidateStatus": { - "target": "com.amazonaws.sagemaker#CandidateStatus", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The candidate's status.

    ", + "smithy.api#documentation": "

    The creation time.

    ", "smithy.api#required": {} } }, - "ObjectiveStatus": { - "target": "com.amazonaws.sagemaker#ObjectiveStatus", + "CandidateSteps": { + "target": "com.amazonaws.sagemaker#CandidateSteps", "traits": { - "smithy.api#documentation": "

    The objective status.

    ", + "smithy.api#documentation": "

    The candidate's steps.

    ", "smithy.api#required": {} } }, - "FinalAutoMLJobObjectiveMetric": { - "target": "com.amazonaws.sagemaker#FinalAutoMLJobObjectiveMetric" - }, - "EndTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The end time.

    " + "smithy.api#documentation": "

    The last modified time.

    ", + "smithy.api#required": {} } }, - "InferenceContainers": { - "target": "com.amazonaws.sagemaker#AutoMLContainerDefinitions", + "ObjectiveStatus": { + "target": "com.amazonaws.sagemaker#ObjectiveStatus", "traits": { - "smithy.api#documentation": "

    The inference containers.

    " + "smithy.api#documentation": "

    The objective status.

    ", + "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "CandidateStatus": { + "target": "com.amazonaws.sagemaker#CandidateStatus", "traits": { - "smithy.api#documentation": "

    The creation time.

    ", + "smithy.api#documentation": "

    The candidate's status.

    ", "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", "traits": { - "smithy.api#documentation": "

    The last modified time.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The failure reason.

    " } }, - "CandidateSteps": { - "target": "com.amazonaws.sagemaker#CandidateSteps", + "CandidateName": { + "target": "com.amazonaws.sagemaker#CandidateName", "traits": { - "smithy.api#documentation": "

    The candidate's steps.

    ", + "smithy.api#documentation": "

    The candidate name.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    An AutoPilot job will return recommendations, or candidates. Each candidate has futher details\n about the steps involed, and the status.

    " + "smithy.api#documentation": "

    An Autopilot job returns recommendations, or candidates. Each candidate has futher details\n about the steps involed, and the status.

    " } }, "com.amazonaws.sagemaker#AutoMLCandidateStep": { "type": "structure", "members": { - "CandidateStepName": { - "target": "com.amazonaws.sagemaker#CandidateStepName", - "traits": { - "smithy.api#documentation": "

    The name for the Candidate's step.

    ", - "smithy.api#required": {} - } - }, "CandidateStepType": { "target": "com.amazonaws.sagemaker#CandidateStepType", "traits": { @@ -880,6 +888,13 @@ "smithy.api#documentation": "

    The ARN for the Candidate's step.

    ", "smithy.api#required": {} } + }, + "CandidateStepName": { + "target": "com.amazonaws.sagemaker#CandidateStepName", + "traits": { + "smithy.api#documentation": "

    The name for the Candidate's step.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -895,13 +910,6 @@ "com.amazonaws.sagemaker#AutoMLChannel": { "type": "structure", "members": { - "TargetAttributeName": { - "target": "com.amazonaws.sagemaker#TargetAttributeName", - "traits": { - "smithy.api#documentation": "

    The name of the target variable in supervised learning, a.k.a. 'y'.

    ", - "smithy.api#required": {} - } - }, "DataSource": { "target": "com.amazonaws.sagemaker#AutoMLDataSource", "traits": { @@ -914,6 +922,13 @@ "traits": { "smithy.api#documentation": "

    You can use Gzip or None. The default value is None.

    " } + }, + "TargetAttributeName": { + "target": "com.amazonaws.sagemaker#TargetAttributeName", + "traits": { + "smithy.api#documentation": "

    The name of the target variable in supervised learning, a.k.a. 'y'.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -966,13 +981,13 @@ "S3DataSource": { "target": "com.amazonaws.sagemaker#AutoMLS3DataSource", "traits": { - "smithy.api#documentation": "

    The Amazon S3 location of the input data.

    \n \n

    The input data must be in CSV format and contain at least 1000 rows.

    \n     ", + "smithy.api#documentation": "

    The Amazon S3 location of the input data.

    \n \n

    The input data must be in CSV format and contain at least 500 rows.

    \n     ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    The data source for the AutoPilot job.

    " + "smithy.api#documentation": "

    The data source for the Autopilot job.

    " } }, "com.amazonaws.sagemaker#AutoMLFailureReason": { @@ -1035,17 +1050,17 @@ "smithy.api#documentation": "

    The maximum time, in seconds, a job is allowed to run.

    " } }, - "MaxCandidates": { - "target": "com.amazonaws.sagemaker#MaxCandidates", - "traits": { - "smithy.api#documentation": "

    The maximum number of times a training job is allowed to run.

    " - } - }, "MaxAutoMLJobRuntimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds", "traits": { "smithy.api#documentation": "

    The maximum time, in seconds, an AutoML job is allowed to wait for a trial to complete.\n It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds.

    " } + }, + "MaxCandidates": { + "target": "com.amazonaws.sagemaker#MaxCandidates", + "traits": { + "smithy.api#documentation": "

    The maximum number of times a training job is allowed to run.

    " + } } }, "traits": { @@ -1088,13 +1103,13 @@ "MetricName": { "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", "traits": { - "smithy.api#documentation": "

    The name of the metric.

    ", + "smithy.api#documentation": "

    The name of the objective metric used to measure the predictive quality of a machine\n learning system. This metric is optimized during training to provide the best estimate for\n model parameter values from data.

    \n

    Here are the options:

    \n
      \n
    • \n

      \n MSE: The mean squared error (MSE) is\n the average of the squared differences between the predicted and actual values. It is\n used for regression. MSE values are always positive, the better a model is at\n predicting the actual values the smaller the MSE value. When the data contains\n outliers, they tend to dominate the MSE which might cause subpar prediction\n performance.

      \n
      • \n
    • \n

      \n Accuracy: The ratio of the number\n correctly classified items to the total number (correctly and incorrectly)\n classified. It is used for binary and multiclass classification. Measures how close\n the predicted class values are to the actual values. Accuracy values vary between\n zero and one, one being perfect accuracy and zero perfect inaccuracy.

      \n
      • \n
    • \n

      \n F1: The F1 score is the harmonic\n mean of the precision and recall. It is used for binary classification into classes\n traditionally referred to as positive and negative. Predictions are said to be true\n when they match their actual (correct) class; false when they do not. Precision is\n the ratio of the true positive predictions to all positive predictions (including the\n false positives) in a data set and measures the quality of the prediction when it\n predicts the positive class. Recall (or sensitivity) is the ratio of the true\n positive predictions to all actual positive instances and measures how completely a\n model predicts the actual class members in a data set. The standard F1 score weighs\n precision and recall equally. But which metric is paramount typically depends on\n specific aspects of a problem. F1 scores vary between zero and one, one being the\n best possible performance and zero the worst.

      \n
      • \n
    • \n

      \n AUC: The area under the curve (AUC)\n metric is used to compare and evaluate binary classification by algorithms such as\n logistic regression that return probabilities. A threshold is needed to map the\n probabilities into classifications. The relevant curve is the receiver operating\n characteristic curve that plots the true positive rate (TPR) of predictions (or\n recall) against the false positive rate (FPR) as a function of the threshold value,\n above which a prediction is considered positive. Increasing the threshold results in\n fewer false positives but more false negatives. AUC is the area under this receiver\n operating characteristic curve and so provides an aggregated measure of the model\n performance across all possible classification thresholds. The AUC score can also be\n interpreted as the probability that a randomly selected positive data point is more\n likely to be predicted positive than a randomly selected negative example. AUC scores\n vary between zero and one, one being perfect accuracy and one half not better than a\n random classifier. Values less that one half predict worse than a random predictor\n and such consistently bad predictors can be inverted to obtain better than random\n predictors.

      \n
      • \n
    • \n

      \n F1macro: The F1macro score applies\n F1 scoring to multiclass classification. In this context, you have multiple classes\n to predict. You just calculate the precision and recall for each class as you did for\n the positive class in binary classification. Then used these values to calculate the\n F1 score for each class and average them to obtain the F1macro score. F1macro scores\n vary between zero and one, one being the best possible performance and zero the\n worst.

      \n
      • \n
    \n

    If you do not specify a metric explicitly, the default behavior is to automatically\n use:

    \n
      \n
    • \n

      \n MSE: for regression.

      \n
      • \n
    • \n

      \n F1: for binary classification

      \n
      • \n
    • \n

      \n Accuracy: for multiclass classification.

      \n
      • \n
    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Applies a metric to minimize or maximize for the job's objective.

    " + "smithy.api#documentation": "

    Specifies a metric to minimize or maximize as the objective of a job.

    " } }, "com.amazonaws.sagemaker#AutoMLJobObjectiveType": { @@ -1195,57 +1210,57 @@ "com.amazonaws.sagemaker#AutoMLJobSummary": { "type": "structure", "members": { - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", "traits": { - "smithy.api#documentation": "

    The ARN of the job.

    ", + "smithy.api#documentation": "

    The job's secondary status.

    ", "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The failure reason.

    " + "smithy.api#documentation": "

    The end time of an AutoML job.

    " } }, - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the object you are requesting.

    ", + "smithy.api#documentation": "

    When the job was created.

    ", "smithy.api#required": {} } }, - "EndTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The end time.

    " + "smithy.api#documentation": "

    When the job was last modified.

    ", + "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", "traits": { - "smithy.api#documentation": "

    When the job was created.

    ", + "smithy.api#documentation": "

    The job's status.

    ", "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "

    When the job was last modified.

    ", + "smithy.api#documentation": "

    The ARN of the job.

    ", "smithy.api#required": {} } }, - "AutoMLJobSecondaryStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", "traits": { - "smithy.api#documentation": "

    The job's secondary status.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The failure reason of a job.

    " } }, - "AutoMLJobStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { - "smithy.api#documentation": "

    The job's status.

    ", + "smithy.api#documentation": "

    The name of the object you are requesting.

    ", "smithy.api#required": {} } } @@ -1282,6 +1297,10 @@ { "value": "F1macro", "name": "F1_MACRO" + }, + { + "value": "AUC", + "name": "AUC" } ] } @@ -1320,17 +1339,17 @@ "com.amazonaws.sagemaker#AutoMLS3DataSource": { "type": "structure", "members": { - "S3DataType": { - "target": "com.amazonaws.sagemaker#AutoMLS3DataType", + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    The data type.

    ", + "smithy.api#documentation": "

    The URL to the Amazon S3 data source.

    ", "smithy.api#required": {} } }, - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", + "S3DataType": { + "target": "com.amazonaws.sagemaker#AutoMLS3DataType", "traits": { - "smithy.api#documentation": "

    The URL to the Amazon S3 data source.

    ", + "smithy.api#documentation": "

    The data type.

    ", "smithy.api#required": {} } } @@ -1357,18 +1376,18 @@ "com.amazonaws.sagemaker#AutoMLSecurityConfig": { "type": "structure", "members": { - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "

    VPC configuration.

    " - } - }, "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { "smithy.api#documentation": "

    Whether to use traffic encryption between the container layers.

    " } }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

    VPC configuration.

    " + } + }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { @@ -1591,14 +1610,14 @@ "com.amazonaws.sagemaker#CaptureContentTypeHeader": { "type": "structure", "members": { - "CsvContentTypes": { - "target": "com.amazonaws.sagemaker#CsvContentTypes", + "JsonContentTypes": { + "target": "com.amazonaws.sagemaker#JsonContentTypes", "traits": { "smithy.api#documentation": "

    " } }, - "JsonContentTypes": { - "target": "com.amazonaws.sagemaker#JsonContentTypes", + "CsvContentTypes": { + "target": "com.amazonaws.sagemaker#CsvContentTypes", "traits": { "smithy.api#documentation": "

    " } @@ -1729,28 +1748,17 @@ "com.amazonaws.sagemaker#Channel": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.sagemaker#ContentType", - "traits": { - "smithy.api#documentation": "

    The MIME type of the data.

    " - } - }, - "InputMode": { - "target": "com.amazonaws.sagemaker#TrainingInputMode", - "traits": { - "smithy.api#documentation": "

    (Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, Amazon SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification\n request when you have a channel that needs a different input mode from the training\n job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML\n storage volume, and mount the directory to a Docker volume, use File input\n mode. To stream data directly from Amazon S3 to the container, choose Pipe input\n mode.

    \n

    To use a model for incremental training, choose File input model.

    " - } - }, - "ShuffleConfig": { - "target": "com.amazonaws.sagemaker#ShuffleConfig", + "DataSource": { + "target": "com.amazonaws.sagemaker#DataSource", "traits": { - "smithy.api#documentation": "

    A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

    \n

    For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.

    " + "smithy.api#documentation": "

    The location of the channel data.

    ", + "smithy.api#required": {} } }, - "RecordWrapperType": { - "target": "com.amazonaws.sagemaker#RecordWrapper", + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", "traits": { - "smithy.api#documentation": "

    \n

    Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.

    \n

    In File mode, leave this field unset or set it to None.

    " + "smithy.api#documentation": "

    The MIME type of the data.

    " } }, "ChannelName": { @@ -1766,11 +1774,22 @@ "smithy.api#documentation": "

    If training data is compressed, the compression type. The default value is\n None. CompressionType is used only in Pipe input mode. In\n File mode, leave this field unset or set it to None.

    " } }, - "DataSource": { - "target": "com.amazonaws.sagemaker#DataSource", + "ShuffleConfig": { + "target": "com.amazonaws.sagemaker#ShuffleConfig", "traits": { - "smithy.api#documentation": "

    The location of the channel data.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

    \n

    For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.

    " + } + }, + "InputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#documentation": "

    (Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, Amazon SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification\n request when you have a channel that needs a different input mode from the training\n job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML\n storage volume, and mount the directory to a Docker volume, use File input\n mode. To stream data directly from Amazon S3 to the container, choose Pipe input\n mode.

    \n

    To use a model for incremental training, choose File input model.

    " + } + }, + "RecordWrapperType": { + "target": "com.amazonaws.sagemaker#RecordWrapper", + "traits": { + "smithy.api#documentation": "

    \n

    Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.

    \n

    In File mode, leave this field unset or set it to None.

    " } } }, @@ -1791,17 +1810,17 @@ "com.amazonaws.sagemaker#ChannelSpecification": { "type": "structure", "members": { - "SupportedContentTypes": { - "target": "com.amazonaws.sagemaker#ContentTypes", + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", "traits": { - "smithy.api#documentation": "

    The supported MIME types for the data.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A brief description of the channel.

    " } }, - "IsRequired": { - "target": "com.amazonaws.sagemaker#Boolean", + "SupportedInputModes": { + "target": "com.amazonaws.sagemaker#InputModes", "traits": { - "smithy.api#documentation": "

    Indicates whether the channel is required by the algorithm.

    " + "smithy.api#documentation": "

    The allowed input mode, either FILE or PIPE.

    \n

    In FILE mode, Amazon SageMaker copies the data from the input source onto the local\n Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm.\n This is the most commonly used input mode.

    \n

    In PIPE mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.

    ", + "smithy.api#required": {} } }, "SupportedCompressionTypes": { @@ -1810,16 +1829,10 @@ "smithy.api#documentation": "

    The allowed compression types, if data compression is used.

    " } }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "

    A brief description of the channel.

    " - } - }, - "SupportedInputModes": { - "target": "com.amazonaws.sagemaker#InputModes", + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", "traits": { - "smithy.api#documentation": "

    The allowed input mode, either FILE or PIPE.

    \n

    In FILE mode, Amazon SageMaker copies the data from the input source onto the local\n Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm.\n This is the most commonly used input mode.

    \n

    In PIPE mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.

    ", + "smithy.api#documentation": "

    The supported MIME types for the data.

    ", "smithy.api#required": {} } }, @@ -1829,6 +1842,12 @@ "smithy.api#documentation": "

    The name of the channel.

    ", "smithy.api#required": {} } + }, + "IsRequired": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the channel is required by the algorithm.

    " + } } }, "traits": { @@ -1850,18 +1869,18 @@ "com.amazonaws.sagemaker#CheckpointConfig": { "type": "structure", "members": { - "LocalPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", - "traits": { - "smithy.api#documentation": "

    (Optional) The local directory where checkpoints are written. The default directory is\n /opt/ml/checkpoints/.

    " - } - }, "S3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#documentation": "

    Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.

    ", "smithy.api#required": {} } + }, + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "

    (Optional) The local directory where checkpoints are written. The default directory is\n /opt/ml/checkpoints/.

    " + } } }, "traits": { @@ -1982,13 +2001,6 @@ "com.amazonaws.sagemaker#CodeRepositorySummary": { "type": "structure", "members": { - "CodeRepositoryArn": { - "target": "com.amazonaws.sagemaker#CodeRepositoryArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Git repository.

    ", - "smithy.api#required": {} - } - }, "CreationTime": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { @@ -2015,6 +2027,13 @@ "smithy.api#documentation": "

    The name of the Git repository.

    ", "smithy.api#required": {} } + }, + "CodeRepositoryArn": { + "target": "com.amazonaws.sagemaker#CodeRepositoryArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Git repository.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -2030,17 +2049,17 @@ "com.amazonaws.sagemaker#CognitoConfig": { "type": "structure", "members": { - "ClientId": { - "target": "com.amazonaws.sagemaker#ClientId", + "UserPool": { + "target": "com.amazonaws.sagemaker#CognitoUserPool", "traits": { - "smithy.api#documentation": "

    The client ID for your Amazon Cognito user pool.

    ", + "smithy.api#documentation": "

    A \n user pool is a user directory in Amazon Cognito. \n With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. \n Your users can also sign in through social identity providers like \n Google, Facebook, Amazon, or Apple, and through SAML identity providers.

    ", "smithy.api#required": {} } }, - "UserPool": { - "target": "com.amazonaws.sagemaker#CognitoUserPool", + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", "traits": { - "smithy.api#documentation": "

    A \n user pool is a user directory in Amazon Cognito. \n With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. \n Your users can also sign in through social identity providers like \n Google, Facebook, Amazon, or Apple, and through SAML identity providers.

    ", + "smithy.api#documentation": "

    The client ID for your Amazon Cognito user pool.

    ", "smithy.api#required": {} } } @@ -2052,13 +2071,6 @@ "com.amazonaws.sagemaker#CognitoMemberDefinition": { "type": "structure", "members": { - "ClientId": { - "target": "com.amazonaws.sagemaker#ClientId", - "traits": { - "smithy.api#documentation": "

    An identifier for an application client. You must create the app client ID using\n Amazon Cognito.

    ", - "smithy.api#required": {} - } - }, "UserPool": { "target": "com.amazonaws.sagemaker#CognitoUserPool", "traits": { @@ -2072,6 +2084,13 @@ "smithy.api#documentation": "

    An identifier for a user group.

    ", "smithy.api#required": {} } + }, + "ClientId": { + "target": "com.amazonaws.sagemaker#ClientId", + "traits": { + "smithy.api#documentation": "

    An identifier for an application client. You must create the app client ID using\n Amazon Cognito.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -2101,17 +2120,17 @@ "com.amazonaws.sagemaker#CollectionConfiguration": { "type": "structure", "members": { - "CollectionParameters": { - "target": "com.amazonaws.sagemaker#CollectionParameters", - "traits": { - "smithy.api#documentation": "

    Parameter values for the tensor collection. The allowed parameters are\n \"name\", \"include_regex\", \"reduction_config\",\n \"save_config\", \"tensor_names\", and\n \"save_histogram\".

    " - } - }, "CollectionName": { "target": "com.amazonaws.sagemaker#CollectionName", "traits": { "smithy.api#documentation": "

    The name of the tensor collection. The name must be unique relative to other rule configuration names.

    " } + }, + "CollectionParameters": { + "target": "com.amazonaws.sagemaker#CollectionParameters", + "traits": { + "smithy.api#documentation": "

    Parameter values for the tensor collection. The allowed parameters are\n \"name\", \"include_regex\", \"reduction_config\",\n \"save_config\", \"tensor_names\", and\n \"save_histogram\".

    " + } } }, "traits": { @@ -2205,34 +2224,36 @@ "com.amazonaws.sagemaker#CompilationJobSummary": { "type": "structure", "members": { - "CompilationTargetPlatformOs": { - "target": "com.amazonaws.sagemaker#TargetPlatformOs", + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    The type of OS that the model will run on after the compilation job has completed.

    " + "smithy.api#documentation": "

    The name of the model compilation job that you want a summary for.

    ", + "smithy.api#required": {} } }, - "CompilationTargetDevice": { - "target": "com.amazonaws.sagemaker#TargetDevice", + "CompilationJobStatus": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", "traits": { - "smithy.api#documentation": "

    The type of device that the model will run on after the compilation job has completed.

    " + "smithy.api#documentation": "

    The status of the model compilation job.

    ", + "smithy.api#required": {} } }, - "CompilationTargetPlatformArch": { - "target": "com.amazonaws.sagemaker#TargetPlatformArch", + "CompilationTargetPlatformOs": { + "target": "com.amazonaws.sagemaker#TargetPlatformOs", "traits": { - "smithy.api#documentation": "

    The type of architecture that the model will run on after the compilation job has completed.

    " + "smithy.api#documentation": "

    The type of OS that the model will run on after the compilation job has\n completed.

    " } }, - "CompilationEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "CompilationTargetPlatformAccelerator": { + "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", "traits": { - "smithy.api#documentation": "

    The time when the model compilation job completed.

    " + "smithy.api#documentation": "

    The type of accelerator that the model will run on after the compilation job has\n completed.

    " } }, - "CompilationTargetPlatformAccelerator": { - "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", + "CompilationTargetDevice": { + "target": "com.amazonaws.sagemaker#TargetDevice", "traits": { - "smithy.api#documentation": "

    The type of accelerator that the model will run on after the compilation job has completed.

    " + "smithy.api#documentation": "

    The type of device that the model will run on after the compilation job has\n completed.

    " } }, "CreationTime": { @@ -2242,16 +2263,28 @@ "smithy.api#required": {} } }, + "CompilationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time when the model compilation job started.

    " + } + }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { "smithy.api#documentation": "

    The time when the model compilation job was last modified.

    " } }, - "CompilationStartTime": { + "CompilationTargetPlatformArch": { + "target": "com.amazonaws.sagemaker#TargetPlatformArch", + "traits": { + "smithy.api#documentation": "

    The type of architecture that the model will run on after the compilation job has\n completed.

    " + } + }, + "CompilationEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The time when the model compilation job started.

    " + "smithy.api#documentation": "

    The time when the model compilation job completed.

    " } }, "CompilationJobArn": { @@ -2260,20 +2293,6 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model compilation job.

    ", "smithy.api#required": {} } - }, - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the model compilation job that you want a summary for.

    ", - "smithy.api#required": {} - } - }, - "CompilationJobStatus": { - "target": "com.amazonaws.sagemaker#CompilationJobStatus", - "traits": { - "smithy.api#documentation": "

    The status of the model compilation job.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -2368,40 +2387,46 @@ "com.amazonaws.sagemaker#ContainerDefinition": { "type": "structure", "members": { - "Environment": { - "target": "com.amazonaws.sagemaker#EnvironmentMap", + "ContainerHostname": { + "target": "com.amazonaws.sagemaker#ContainerHostname", "traits": { - "smithy.api#documentation": "

    The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.

    " + "smithy.api#documentation": "

    This parameter is ignored for models that contain only a\n PrimaryContainer.

    \n

    When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.

    " } }, - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#ArnOrName", + "ImageConfig": { + "target": "com.amazonaws.sagemaker#ImageConfig", "traits": { - "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the model package to use to create the\n model.

    " + "smithy.api#documentation": "

    Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your\n Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry,\n see Use a Private Docker\n Registry for Real-Time Inference Containers\n

    " } }, - "Mode": { - "target": "com.amazonaws.sagemaker#ContainerMode", + "Image": { + "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { - "smithy.api#documentation": "

    Whether the container hosts a single model or multiple models.

    " + "smithy.api#documentation": "

    The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your\n own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must\n meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information,\n see Using\n Your Own Algorithms with Amazon SageMaker\n

    " } }, - "ContainerHostname": { - "target": "com.amazonaws.sagemaker#ContainerHostname", + "ModelDataUrl": { + "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

    This parameter is ignored for models that contain only a\n PrimaryContainer.

    \n

    When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.

    " + "smithy.api#documentation": "

    The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

    \n \n

    The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

    \n     \n

    If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to\n download model artifacts from the S3 path you provide. AWS STS is activated in your\n IAM user account by default. If you previously deactivated AWS STS for a region, you\n need to reactivate AWS STS for that region. For more information, see Activating and\n Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User\n Guide.

    \n \n

    If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

    \n     " } }, - "Image": { - "target": "com.amazonaws.sagemaker#ContainerImage", + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", "traits": { - "smithy.api#documentation": "

    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your\n own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must\n meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information,\n see Using\n Your Own Algorithms with Amazon SageMaker\n

    " + "smithy.api#documentation": "

    The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.

    " } }, - "ModelDataUrl": { - "target": "com.amazonaws.sagemaker#Url", + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#ArnOrName", + "traits": { + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the model package to use to create the\n model.

    " + } + }, + "Mode": { + "target": "com.amazonaws.sagemaker#ContainerMode", "traits": { - "smithy.api#documentation": "

    The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

    \n

    If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to\n download model artifacts from the S3 path you provide. AWS STS is activated in your\n IAM user account by default. If you previously deactivated AWS STS for a region, you\n need to reactivate AWS STS for that region. For more information, see Activating and\n Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User\n Guide.

    \n \n

    If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

    \n     " + "smithy.api#documentation": "

    Whether the container hosts a single model or multiple models.

    " } } }, @@ -2524,19 +2549,13 @@ "com.amazonaws.sagemaker#ContinuousParameterRange": { "type": "structure", "members": { - "MaxValue": { + "MinValue": { "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { - "smithy.api#documentation": "

    The maximum value for the hyperparameter. The tuning job uses floating-point values\n between MinValue value and this value for tuning.

    ", + "smithy.api#documentation": "

    The minimum value for the hyperparameter.\n The\n tuning job uses floating-point values between this value and MaxValuefor\n tuning.

    ", "smithy.api#required": {} } }, - "ScalingType": { - "target": "com.amazonaws.sagemaker#HyperParameterScalingType", - "traits": { - "smithy.api#documentation": "

    The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

    \n
    \n
    Auto
    \n
    \n

    Amazon SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

    \n
    \n
    Linear
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

    \n
    \n
    Logarithmic
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

    \n

    Logarithmic scaling works only for ranges that have only values greater\n than 0.

    \n
    \n
    ReverseLogarithmic
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.

    \n

    Reverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.

    \n
    \n
    " - } - }, "Name": { "target": "com.amazonaws.sagemaker#ParameterKey", "traits": { @@ -2544,12 +2563,18 @@ "smithy.api#required": {} } }, - "MinValue": { + "MaxValue": { "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { - "smithy.api#documentation": "

    The minimum value for the hyperparameter.\n The\n tuning job uses floating-point values between this value and MaxValuefor\n tuning.

    ", + "smithy.api#documentation": "

    The maximum value for the hyperparameter. The tuning job uses floating-point values\n between MinValue value and this value for tuning.

    ", "smithy.api#required": {} } + }, + "ScalingType": { + "target": "com.amazonaws.sagemaker#HyperParameterScalingType", + "traits": { + "smithy.api#documentation": "

    The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

    \n
    \n
    Auto
    \n
    \n

    Amazon SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

    \n
    \n
    Linear
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

    \n
    \n
    Logarithmic
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

    \n

    Logarithmic scaling works only for ranges that have only values greater\n than 0.

    \n
    \n
    ReverseLogarithmic
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.

    \n

    Reverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.

    \n
    \n
    " + } } }, "traits": { @@ -2605,19 +2630,6 @@ "com.amazonaws.sagemaker#CreateAlgorithmInput": { "type": "structure", "members": { - "TrainingSpecification": { - "target": "com.amazonaws.sagemaker#TrainingSpecification", - "traits": { - "smithy.api#documentation": "

    Specifies details about training jobs run by this algorithm, including the\n following:

    \n
      \n
    • \n

      The Amazon ECR path of the container and the version digest of the\n algorithm.

      \n
      • \n
    • \n

      The hyperparameters that the algorithm supports.

      \n
      • \n
    • \n

      The instance types that the algorithm supports for training.

      \n
      • \n
    • \n

      Whether the algorithm supports distributed training.

      \n
      • \n
    • \n

      The metrics that the algorithm emits to Amazon CloudWatch.

      \n
      • \n
    • \n

      Which metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.

      \n
      • \n
    • \n

      The input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.

      \n
      • \n
    ", - "smithy.api#required": {} - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", - "traits": { - "smithy.api#documentation": "

    Specifies details about inference jobs that the algorithm runs, including the\n following:

    \n
      \n
    • \n

      The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

      \n
      • \n
    • \n

      The instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.

      \n
      • \n
    • \n

      The input and output content formats that the algorithm supports for\n inference.

      \n
      • \n
    " - } - }, "AlgorithmDescription": { "target": "com.amazonaws.sagemaker#EntityDescription", "traits": { @@ -2642,6 +2654,19 @@ "traits": { "smithy.api#documentation": "

    Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the\n algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker\n runs to test the algorithm's inference code.

    " } + }, + "TrainingSpecification": { + "target": "com.amazonaws.sagemaker#TrainingSpecification", + "traits": { + "smithy.api#documentation": "

    Specifies details about training jobs run by this algorithm, including the\n following:

    \n
      \n
    • \n

      The Amazon ECR path of the container and the version digest of the\n algorithm.

      \n
      • \n
    • \n

      The hyperparameters that the algorithm supports.

      \n
      • \n
    • \n

      The instance types that the algorithm supports for training.

      \n
      • \n
    • \n

      Whether the algorithm supports distributed training.

      \n
      • \n
    • \n

      The metrics that the algorithm emits to Amazon CloudWatch.

      \n
      • \n
    • \n

      Which metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.

      \n
      • \n
    • \n

      The input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

    Specifies details about inference jobs that the algorithm runs, including the\n following:

    \n
      \n
    • \n

      The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

      \n
      • \n
    • \n

      The instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.

      \n
      • \n
    • \n

      The input and output content formats that the algorithm supports for\n inference.

      \n
      • \n
    " + } } } }, @@ -2680,17 +2705,17 @@ "com.amazonaws.sagemaker#CreateAppRequest": { "type": "structure", "members": { - "ResourceSpec": { - "target": "com.amazonaws.sagemaker#ResourceSpec", + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

    The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

    " + "smithy.api#documentation": "

    The user profile name.

    ", + "smithy.api#required": {} } }, - "AppName": { - "target": "com.amazonaws.sagemaker#AppName", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The name of the app.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Each tag consists of a key and an optional value.\n Tag keys must be unique per resource.

    " } }, "AppType": { @@ -2700,24 +2725,24 @@ "smithy.api#required": {} } }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", "traits": { - "smithy.api#documentation": "

    The domain ID.

    ", + "smithy.api#documentation": "

    The name of the app.

    ", "smithy.api#required": {} } }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", + "ResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "

    The user profile name.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", "traits": { - "smithy.api#documentation": "

    Each tag consists of a key and an optional value.\n Tag keys must be unique per resource.

    " + "smithy.api#documentation": "

    The domain ID.

    ", + "smithy.api#required": {} } } } @@ -2750,68 +2775,68 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an AutoPilot job.

    \n

    After you run an AutoPilot job, you can find the best performing model by calling , and then deploy that model by following the steps\n described in Step 6.1: Deploy the Model to Amazon SageMaker Hosting Services.

    \n

    For information about how to use AutoPilot, see Use AutoPilot to Automate\n Model Development.

    " + "smithy.api#documentation": "

    Creates an Autopilot job.

    \n

    Find the best performing model after you run an Autopilot job by calling . Deploy that model by following the steps described in\n Step 6.1:\n Deploy the Model to Amazon SageMaker Hosting Services.

    \n

    For information about how to use Autopilot, see Automate Model\n Development with Amazon SageMaker Autopilot.

    " } }, "com.amazonaws.sagemaker#CreateAutoMLJobRequest": { "type": "structure", "members": { - "AutoMLJobName": { - "target": "com.amazonaws.sagemaker#AutoMLJobName", + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", "traits": { - "smithy.api#documentation": "

    Identifies an AutoPilot job. Must be unique to your account and is case-insensitive.

    ", + "smithy.api#documentation": "

    Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV.

    ", "smithy.api#required": {} } }, - "AutoMLJobObjective": { - "target": "com.amazonaws.sagemaker#AutoMLJobObjective", + "GenerateCandidateDefinitionsOnly": { + "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", "traits": { - "smithy.api#documentation": "

    Defines the job's objective. You provide a MetricName and AutoML will infer minimize or\n maximize. If this is not provided, the most commonly used ObjectiveMetric for problem type\n will be selected.

    " + "smithy.api#documentation": "

    Generates possible candidates without training a model. A candidate is a combination of\n data preprocessors, algorithms, and algorithm parameter settings.

    " } }, - "ProblemType": { - "target": "com.amazonaws.sagemaker#ProblemType", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    Defines the kind of preprocessing and algorithms intended for the candidates. Options\n include: BinaryClassification, MulticlassClassification, and Regression.

    " + "smithy.api#documentation": "

    The ARN of the role that is used to access the data.

    ", + "smithy.api#required": {} } }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", + "AutoMLJobName": { + "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { - "smithy.api#documentation": "

    Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of\n 1000 rows.

    ", + "smithy.api#documentation": "

    Identifies an Autopilot job. Must be unique to your account and is case-insensitive.

    ", "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective", "traits": { - "smithy.api#documentation": "

    The ARN of the role that will be used to access the data.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Defines the objective of a an AutoML job. You provide a AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or\n maximize it. If a metric is not specified, the most commonly used ObjectiveMetric for\n problem type is automaically selected.

    " } }, - "AutoMLJobConfig": { - "target": "com.amazonaws.sagemaker#AutoMLJobConfig", + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", "traits": { - "smithy.api#documentation": "

    Contains CompletionCriteria and SecurityConfig.

    " + "smithy.api#documentation": "

    Defines the kind of preprocessing and algorithms intended for the candidates. Options\n include: BinaryClassification, MulticlassClassification, and Regression.

    " } }, - "GenerateCandidateDefinitionsOnly": { - "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    This will generate possible candidates without training a model. A candidate is a\n combination of data preprocessors, algorithms, and algorithm parameter settings.

    " + "smithy.api#documentation": "

    Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.

    " } }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", "traits": { - "smithy.api#documentation": "

    Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV.

    ", + "smithy.api#documentation": "

    Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of 500\n rows.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "AutoMLJobConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobConfig", "traits": { - "smithy.api#documentation": "

    Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.

    " + "smithy.api#documentation": "

    Contains CompletionCriteria and SecurityConfig.

    " } } } @@ -2894,10 +2919,10 @@ "com.amazonaws.sagemaker#CreateCompilationJobRequest": { "type": "structure", "members": { - "OutputConfig": { - "target": "com.amazonaws.sagemaker#OutputConfig", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    Provides information about the output location for the compiled model and the target\n device the model runs on.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on\n your behalf.

    \n

    During model compilation, Amazon SageMaker needs your permission to:

    \n
      \n
    • \n

      Read input data from an S3 bucket

      \n
      • \n
    • \n

      Write model artifacts to an S3 bucket

      \n
      • \n
    • \n

      Write logs to Amazon CloudWatch Logs

      \n
      • \n
    • \n

      Publish metrics to Amazon CloudWatch

      \n
      • \n
    \n

    You grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker\n Roles.\n

    ", "smithy.api#required": {} } }, @@ -2908,24 +2933,24 @@ "smithy.api#required": {} } }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#InputConfig", + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.

    ", + "smithy.api#documentation": "

    A name for the model compilation job. The name must be unique within the AWS Region\n and within your AWS account.

    ", "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "InputConfig": { + "target": "com.amazonaws.sagemaker#InputConfig", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on\n your behalf.

    \n

    During model compilation, Amazon SageMaker needs your permission to:

    \n
      \n
    • \n

      Read input data from an S3 bucket

      \n
      • \n
    • \n

      Write model artifacts to an S3 bucket

      \n
      • \n
    • \n

      Write logs to Amazon CloudWatch Logs

      \n
      • \n
    • \n

      Publish metrics to Amazon CloudWatch

      \n
      • \n
    \n

    You grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker\n Roles.\n

    ", + "smithy.api#documentation": "

    Provides information about the location of input model artifacts, the name and shape\n of the expected data inputs, and the framework in which the model was trained.

    ", "smithy.api#required": {} } }, - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OutputConfig", "traits": { - "smithy.api#documentation": "

    A name for the model compilation job. The name must be unique within the AWS Region\n and within your AWS account.

    ", + "smithy.api#documentation": "

    Provides information about the output location for the compiled model and the target\n device the model runs on.

    ", "smithy.api#required": {} } } @@ -2960,37 +2985,35 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a Domain used by SageMaker Studio. A domain consists of an associated\n directory, a list of authorized users, and a variety of security, application, policy, and\n Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users\n within a domain can share notebook files and other artifacts with each other.

    \n

    When a domain is created, an Amazon Elastic File System (EFS) volume is also created for use by all of the users\n within the domain. Each user receives a private home directory within the EFS for notebooks,\n Git repositories, and data files.

    \n

    All traffic between the domain and the EFS volume is communicated through the specified\n subnet IDs. All other traffic goes over the Internet through an Amazon SageMaker system VPC. The EFS\n traffic uses the NFS/TCP protocol over port 2049.

    \n \n

    NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a SageMaker Studio app successfully.

    \n     " + "smithy.api#documentation": "

    Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region.\n Users within a domain can share notebook files and other artifacts with each other.

    \n

    When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

    \n\n

    \n VPC configuration\n

    \n

    All SageMaker Studio traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to Studio. The following options are available:

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker, which allows internet access. This is the default value.

      \n
      • \n
    • \n

      \n VpcOnly - All Studio traffic is through the specified VPC and subnets.\n Internet access is disabled by default. To allow internet access, you must specify a\n NAT gateway.

      \n

      When internet access is disabled, you won't be able to train or host models unless\n your VPC has an interface endpoint (PrivateLink) or a NAT gateway and your security groups\n allow outbound connections.

      \n
      • \n
    \n\n

    \n \n VpcOnly network access type\n

    \n

    When you choose VpcOnly, you must specify the following:

    \n
      \n
    • \n

      Security group inbound and outbound rules to allow NFS traffic over TCP on port 2049\n between the domain and the EFS volume

      \n \n
      • \n
    • \n

      Security group inbound and outbound rules to allow traffic between the JupyterServer\n app and the KernelGateway apps

      \n
      • \n
    • \n

      Interface endpoints to access the SageMaker API and SageMaker runtime

      \n
      • \n
    \n

    For more information, see:

    \n " } }, "com.amazonaws.sagemaker#CreateDomainRequest": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.sagemaker#VpcId", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud (VPC) to use for communication with the EFS volume.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Tags to associated with the Domain. Each tag consists of a key and an optional value.\n Tag keys must be unique per resource. Tags are searchable using the\n Search API.

    " } }, - "DefaultUserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", + "VpcId": { + "target": "com.amazonaws.sagemaker#VpcId", "traits": { - "smithy.api#documentation": "

    The default user settings.

    ", + "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

    ", "smithy.api#required": {} } }, - "AuthMode": { - "target": "com.amazonaws.sagemaker#AuthMode", + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "

    The mode of authentication that members use to access the domain.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access

      \n
      • \n
    • \n

      \n VpcOnly - All Studio traffic is through the specified VPC and subnets

      \n
      • \n
    " } }, - "SubnetIds": { - "target": "com.amazonaws.sagemaker#Subnets", + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", "traits": { - "smithy.api#documentation": "

    The VPC subnets to use for communication with the EFS volume.

    ", + "smithy.api#documentation": "

    A name for the domain.

    ", "smithy.api#required": {} } }, @@ -3000,16 +3023,24 @@ "smithy.api#documentation": "

    The AWS Key Management Service (KMS) encryption key ID.\n Encryption with a customer master key (CMK) is not supported.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "AuthMode": { + "target": "com.amazonaws.sagemaker#AuthMode", "traits": { - "smithy.api#documentation": "

    Tags to associated with the Domain. Each tag consists of a key and an optional value.\n Tag keys must be unique per resource. Tags are searchable using the\n Search API.

    " + "smithy.api#documentation": "

    The mode of authentication that members use to access the domain.

    ", + "smithy.api#required": {} } }, - "DomainName": { - "target": "com.amazonaws.sagemaker#DomainName", + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", "traits": { - "smithy.api#documentation": "

    A name for the domain.

    ", + "smithy.api#documentation": "

    The default user settings.

    ", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", + "traits": { + "smithy.api#documentation": "

    The VPC subnets that Studio uses for communication.

    ", "smithy.api#required": {} } } @@ -3018,17 +3049,17 @@ "com.amazonaws.sagemaker#CreateDomainResponse": { "type": "structure", "members": { - "Url": { - "target": "com.amazonaws.sagemaker#String1024", - "traits": { - "smithy.api#documentation": "

    The URL to the created domain.

    " - } - }, "DomainArn": { "target": "com.amazonaws.sagemaker#DomainArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the created domain.

    " } + }, + "Url": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

    The URL to the created domain.

    " + } } } }, @@ -3069,10 +3100,13 @@ "com.amazonaws.sagemaker#CreateEndpointConfigInput": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

    \n

    The KmsKeyId can be any of the following formats:

    \n
      \n
    • \n

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Alias name: alias/ExampleAlias\n

      \n
      • \n
    • \n

      Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

      \n
      • \n
    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the AWS Key Management Service section Using Key\n Policies in AWS KMS \n

    \n \n

    Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

    \n

    For a list of instance types that support local instance storage, see Instance Store Volumes.

    \n

    For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

    \n     " + "smithy.api#documentation": "

    A list of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " } }, "EndpointConfigName": { @@ -3082,12 +3116,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "

    A list of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " - } - }, "ProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantList", "traits": { @@ -3095,8 +3123,11 @@ "smithy.api#required": {} } }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#DataCaptureConfig" + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

    \n

    The KmsKeyId can be any of the following formats:

    \n
      \n
    • \n

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Alias name: alias/ExampleAlias\n

      \n
      • \n
    • \n

      Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

      \n
      • \n
    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the AWS Key Management Service section Using Key\n Policies in AWS KMS \n

    \n \n

    Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

    \n

    For a list of instance types that support local instance storage, see Instance Store Volumes.

    \n

    For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

    \n     " + } } } }, @@ -3121,17 +3152,17 @@ "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tagsin the AWS Billing and Cost Management User\n Guide.\n \n

    " } }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", "traits": { - "smithy.api#documentation": "

    The name of the endpoint. The name must be unique within an AWS Region in your AWS\n account.

    ", + "smithy.api#documentation": "

    The name of an endpoint configuration. For more information, see \n CreateEndpointConfig.

    ", "smithy.api#required": {} } }, - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    The name of an endpoint configuration. For more information, see \n CreateEndpointConfig.

    ", + "smithy.api#documentation": "

    The name of the endpoint. The name must be unique within an AWS Region in your AWS\n account.

    ", "smithy.api#required": {} } } @@ -3175,11 +3206,10 @@ "smithy.api#documentation": "

    The description of the experiment.

    " } }, - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The name of the experiment. The name must be unique in your AWS account and is not\n case-sensitive.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of tags to associate with the experiment. You can use Search API\n to search on the tags.

    " } }, "DisplayName": { @@ -3188,10 +3218,11 @@ "smithy.api#documentation": "

    The name of the experiment as displayed. The name doesn't need to be unique. If you don't\n specify DisplayName, the value in ExperimentName is\n displayed.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    A list of tags to associate with the experiment. You can use Search API\n to search on the tags.

    " + "smithy.api#documentation": "

    The name of the experiment. The name must be unique in your AWS account and is not\n case-sensitive.

    ", + "smithy.api#required": {} } } } @@ -3230,24 +3261,23 @@ "com.amazonaws.sagemaker#CreateFlowDefinitionRequest": { "type": "structure", "members": { - "HumanLoopConfig": { - "target": "com.amazonaws.sagemaker#HumanLoopConfig", + "OutputConfig": { + "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", "traits": { - "smithy.api#documentation": "

    An object containing information about the tasks the human reviewers will perform.

    ", + "smithy.api#documentation": "

    An object containing information about where the human review results will be uploaded.

    ", "smithy.api#required": {} } }, - "HumanLoopRequestSource": { - "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    Container for configuring the source of human task requests. Use to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.

    " + "smithy.api#documentation": "

    An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

    " } }, - "FlowDefinitionName": { - "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "HumanLoopRequestSource": { + "target": "com.amazonaws.sagemaker#HumanLoopRequestSource", "traits": { - "smithy.api#documentation": "

    The name of your flow definition.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Container for configuring the source of human task requests. Use to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.

    " } }, "HumanLoopActivationConfig": { @@ -3256,12 +3286,6 @@ "smithy.api#documentation": "

    An object containing information about the events that trigger a human workflow.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "

    An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

    " - } - }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { @@ -3269,10 +3293,17 @@ "smithy.api#required": {} } }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", + "HumanLoopConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopConfig", "traits": { - "smithy.api#documentation": "

    An object containing information about where the human review results will be uploaded.

    ", + "smithy.api#documentation": "

    An object containing information about the tasks the human reviewers will perform.

    ", + "smithy.api#required": {} + } + }, + "FlowDefinitionName": { + "target": "com.amazonaws.sagemaker#FlowDefinitionName", + "traits": { + "smithy.api#documentation": "

    The name of your flow definition.

    ", "smithy.api#required": {} } } @@ -3313,6 +3344,12 @@ "com.amazonaws.sagemaker#CreateHumanTaskUiRequest": { "type": "structure", "members": { + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplate", + "traits": { + "smithy.api#required": {} + } + }, "HumanTaskUiName": { "target": "com.amazonaws.sagemaker#HumanTaskUiName", "traits": { @@ -3325,12 +3362,6 @@ "traits": { "smithy.api#documentation": "

    An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

    " } - }, - "UiTemplate": { - "target": "com.amazonaws.sagemaker#UiTemplate", - "traits": { - "smithy.api#required": {} - } } } }, @@ -3369,17 +3400,16 @@ "com.amazonaws.sagemaker#CreateHyperParameterTuningJobRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", "traits": { - "smithy.api#documentation": "

    An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see AWS\n Tagging Strategies.

    \n

    Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

    " + "smithy.api#documentation": "

    The HyperParameterTrainingJobDefinition object that describes the\n training jobs that this tuning job launches,\n including\n static hyperparameters, input data configuration, output data configuration, resource\n configuration, and stopping condition.

    " } }, - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "WarmStartConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", "traits": { - "smithy.api#documentation": "

    The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same AWS account and\n AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z,\n 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.

    \n

    All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.

    \n \n

    All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

    \n     " } }, "TrainingJobDefinitions": { @@ -3388,12 +3418,6 @@ "smithy.api#documentation": "

    A list of the HyperParameterTrainingJobDefinition objects launched\n for this tuning job.

    " } }, - "TrainingJobDefinition": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", - "traits": { - "smithy.api#documentation": "

    The HyperParameterTrainingJobDefinition object that describes the\n training jobs that this tuning job launches,\n including\n static hyperparameters, input data configuration, output data configuration, resource\n configuration, and stopping condition.

    " - } - }, "HyperParameterTuningJobConfig": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", "traits": { @@ -3401,10 +3425,17 @@ "smithy.api#required": {} } }, - "WarmStartConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.

    \n

    All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.

    \n \n

    All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

    \n     " + "smithy.api#documentation": "

    An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see AWS\n Tagging Strategies.

    \n

    Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

    " + } + }, + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#documentation": "

    The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same AWS account and\n AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z,\n 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

    ", + "smithy.api#required": {} } } } @@ -3444,23 +3475,10 @@ "com.amazonaws.sagemaker#CreateLabelingJobRequest": { "type": "structure", "members": { - "StoppingConditions": { - "target": "com.amazonaws.sagemaker#LabelingJobStoppingConditions", - "traits": { - "smithy.api#documentation": "

    A set of conditions for stopping the labeling job. If any of the conditions are met,\n the job is automatically stopped. You can use these conditions to control the cost of\n data labeling.

    " - } - }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", - "traits": { - "smithy.api#documentation": "

    Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.

    ", - "smithy.api#required": {} - } - }, - "HumanTaskConfig": { - "target": "com.amazonaws.sagemaker#HumanTaskConfig", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

    ", + "smithy.api#documentation": "

    The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker\n can successfully complete data labeling.

    ", "smithy.api#required": {} } }, @@ -3477,23 +3495,23 @@ "smithy.api#documentation": "

    An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

    " } }, - "LabelCategoryConfigS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", + "LabelAttributeName": { + "target": "com.amazonaws.sagemaker#LabelAttributeName", "traits": { - "smithy.api#documentation": "

    The S3 URL of the file that defines the categories used to label the data\n objects.

    \n

    For 3D point cloud task types, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

    \n

    For all other built-in task types and custom tasks, your label category configuration file must be a JSON\n file in the following format. Identify the labels you want to use by replacing\n label_1, label_2,...,label_n\n with your label categories.

    \n

    \n {\n

    \n

    \n \"document-version\": \"2018-11-28\"\n

    \n

    \n \"labels\": [\n

    \n

    \n {\n

    \n

    \n \"label\": \"label_1\"\n

    \n

    \n },\n

    \n

    \n {\n

    \n

    \n \"label\": \"label_2\"\n

    \n

    \n },\n

    \n

    \n ...\n

    \n

    \n {\n

    \n

    \n \"label\": \"label_n\"\n

    \n

    \n }\n

    \n

    \n ]\n

    \n

    \n }\n

    " + "smithy.api#documentation": "

    The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n name can't end with \"-metadata\". If you are running a semantic segmentation labeling\n job, the attribute name must end with \"-ref\". If you are running any other kind of\n labeling job, the attribute name must not end with \"-ref\".

    ", + "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#LabelingJobStoppingConditions", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker\n can successfully complete data labeling.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A set of conditions for stopping the labeling job. If any of the conditions are met,\n the job is automatically stopped. You can use these conditions to control the cost of\n data labeling.

    " } }, - "LabelAttributeName": { - "target": "com.amazonaws.sagemaker#LabelAttributeName", + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", "traits": { - "smithy.api#documentation": "

    The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n name can't end with \"-metadata\". If you are running a semantic segmentation labeling\n job, the attribute name must end with \"-ref\". If you are running any other kind of\n labeling job, the attribute name must not end with \"-ref\".

    ", + "smithy.api#documentation": "

    Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.

    ", "smithy.api#required": {} } }, @@ -3503,12 +3521,25 @@ "smithy.api#documentation": "

    Configures the information required to perform automated data labeling.

    " } }, + "HumanTaskConfig": { + "target": "com.amazonaws.sagemaker#HumanTaskConfig", + "traits": { + "smithy.api#documentation": "

    Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

    ", + "smithy.api#required": {} + } + }, "OutputConfig": { "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", "traits": { "smithy.api#documentation": "

    The location of the output data and the AWS Key Management Service key ID for the key used to encrypt\n the output data, if any.

    ", "smithy.api#required": {} } + }, + "LabelCategoryConfigS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

    The S3 URL of the file that defines the categories used to label the data\n objects.

    \n

    For 3D point cloud task types, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

    \n

    For all other built-in task types and custom tasks, your label category configuration file must be a JSON\n file in the following format. Identify the labels you want to use by replacing\n label_1, label_2,...,label_n\n with your label categories.

    \n

    \n {\n

    \n

    \n \"document-version\": \"2018-11-28\"\n

    \n

    \n \"labels\": [\n

    \n

    \n {\n

    \n

    \n \"label\": \"label_1\"\n

    \n

    \n },\n

    \n

    \n {\n

    \n

    \n \"label\": \"label_2\"\n

    \n

    \n },\n

    \n

    \n ...\n

    \n

    \n {\n

    \n

    \n \"label\": \"label_n\"\n

    \n

    \n }\n

    \n

    \n ]\n

    \n

    \n }\n

    " + } } } }, @@ -3544,22 +3575,29 @@ "com.amazonaws.sagemaker#CreateModelInput": { "type": "structure", "members": { - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", + "PrimaryContainer": { + "target": "com.amazonaws.sagemaker#ContainerDefinition", "traits": { - "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that you want your model\n to connect to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.

    " + "smithy.api#documentation": "

    The location of the primary docker image containing inference code, associated\n artifacts, and custom environment map that the inference code uses when the model is\n deployed for predictions.

    " } }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", "traits": { - "smithy.api#documentation": "

    Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.

    " + "smithy.api#documentation": "

    Specifies the containers in the inference pipeline.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.\n

    " + "smithy.api#documentation": "

    The name of the new model.

    ", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that you want your model\n to connect to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.

    " } }, "ExecutionRoleArn": { @@ -3569,23 +3607,16 @@ "smithy.api#required": {} } }, - "PrimaryContainer": { - "target": "com.amazonaws.sagemaker#ContainerDefinition", - "traits": { - "smithy.api#documentation": "

    The location of the primary docker image containing inference code, associated\n artifacts, and custom environment map that the inference code uses when the model is\n deployed for predictions.

    " - } - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The name of the new model.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.\n

    " } }, - "Containers": { - "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the containers in the inference pipeline.

    " + "smithy.api#documentation": "

    Isolates the model container. No inbound or outbound network calls can be made to or\n from the model container.

    " } } } @@ -3617,22 +3648,11 @@ "com.amazonaws.sagemaker#CreateModelPackageInput": { "type": "structure", "members": { - "SourceAlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", - "traits": { - "smithy.api#documentation": "

    Details about the algorithm that was used to create the model package.

    " - } - }, - "ValidationSpecification": { - "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", - "traits": { - "smithy.api#documentation": "

    Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the\n model package.

    " - } - }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    A description of the model package.

    " + "smithy.api#documentation": "

    The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).

    ", + "smithy.api#required": {} } }, "InferenceSpecification": { @@ -3641,11 +3661,16 @@ "smithy.api#documentation": "

    Specifies details about inference jobs that can be run with models based on this model\n package, including the following:

    \n
      \n
    • \n

      The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

      \n
      • \n
    • \n

      The instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.

      \n
      • \n
    • \n

      The input and output content formats that the model package supports for\n inference.

      \n
      • \n
    " } }, - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#EntityName", + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", "traits": { - "smithy.api#documentation": "

    The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Details about the algorithm that was used to create the model package.

    " + } + }, + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", + "traits": { + "smithy.api#documentation": "

    A description of the model package.

    " } }, "CertifyForMarketplace": { @@ -3653,6 +3678,12 @@ "traits": { "smithy.api#documentation": "

    Whether to certify the model package for listing on AWS Marketplace.

    " } + }, + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", + "traits": { + "smithy.api#documentation": "

    Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the\n model package.

    " + } } } }, @@ -3745,28 +3776,29 @@ "com.amazonaws.sagemaker#CreateNotebookInstanceInput": { "type": "structure", "members": { - "DefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

    " + "smithy.api#documentation": "

    When you send any requests to AWS resources from the notebook instance, Amazon SageMaker\n assumes this role to perform tasks on your behalf. You must grant this role necessary\n permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service\n principal (sagemaker.amazonaws.com) permissions to assume this role. For more\n information, see Amazon SageMaker Roles.

    \n \n

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     ", + "smithy.api#required": {} } }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "SubnetId": { + "target": "com.amazonaws.sagemaker#SubnetId", "traits": { - "smithy.api#documentation": "

    An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

    " + "smithy.api#documentation": "

    The ID of the subnet in a VPC to which you would like to have a connectivity from\n your ML compute instance.

    " } }, - "DirectInternetAccess": { - "target": "com.amazonaws.sagemaker#DirectInternetAccess", + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

    Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this\n to Disabled this notebook instance will be able to access resources only in\n your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless\n your configure a NAT Gateway in your VPC.

    \n

    For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.

    " + "smithy.api#documentation": "

    The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB.

    " } }, - "SubnetId": { - "target": "com.amazonaws.sagemaker#SubnetId", + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

    The ID of the subnet in a VPC to which you would like to have a connectivity from\n your ML compute instance.

    " + "smithy.api#documentation": "

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be\n for the same VPC as specified in the subnet.

    " } }, "AcceleratorTypes": { @@ -3775,29 +3807,28 @@ "smithy.api#documentation": "

    A list of Elastic Inference (EI) instance types to associate with this notebook\n instance. Currently, only one instance type can be associated with a notebook instance.\n For more information, see Using Elastic Inference in Amazon SageMaker.

    " } }, - "LifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

    The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.

    " + "smithy.api#documentation": "

    An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

    " } }, - "RootAccess": { - "target": "com.amazonaws.sagemaker#RootAccess", + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

    Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

    \n \n

    Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

    \n     " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to your notebook instance. The KMS key you provide must be\n enabled. For information, see Enabling and Disabling\n Keys in the AWS Key Management Service Developer Guide.

    " } }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", + "DirectInternetAccess": { + "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "

    The type of ML compute instance to launch for the notebook instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this\n to Disabled this notebook instance will be able to access resources only in\n your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless\n your configure a NAT Gateway in your VPC.

    \n

    For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.

    " } }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "

    The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB.

    " + "smithy.api#documentation": "

    Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

    \n \n

    Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

    \n     " } }, "Tags": { @@ -3806,30 +3837,30 @@ "smithy.api#documentation": "

    A list of tags to associate with the notebook instance. You can add tags later by\n using the CreateTags API.

    " } }, - "NotebookInstanceName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

    The name of the new notebook instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "LifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to your notebook instance. The KMS key you provide must be\n enabled. For information, see Enabling and Disabling\n Keys in the AWS Key Management Service Developer Guide.

    " + "smithy.api#documentation": "

    The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.

    " } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", "traits": { - "smithy.api#documentation": "

    When you send any requests to AWS resources from the notebook instance, Amazon SageMaker\n assumes this role to perform tasks on your behalf. You must grant this role necessary\n permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service\n principal (sagemaker.amazonaws.com) permissions to assume this role. For more\n information, see Amazon SageMaker Roles.

    \n \n

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     ", + "smithy.api#documentation": "

    The type of ML compute instance to launch for the notebook instance.

    ", "smithy.api#required": {} } }, - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", "traits": { - "smithy.api#documentation": "

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be\n for the same VPC as specified in the subnet.

    " + "smithy.api#documentation": "

    The name of the new notebook instance.

    ", + "smithy.api#required": {} } } } @@ -3854,6 +3885,13 @@ "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput": { "type": "structure", "members": { + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "traits": { + "smithy.api#documentation": "

    The name of the lifecycle configuration.

    ", + "smithy.api#required": {} + } + }, "OnCreate": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", "traits": { @@ -3865,13 +3903,6 @@ "traits": { "smithy.api#documentation": "

    A shell script that runs every time you start a notebook instance, including when you\n create the notebook instance. The shell script must be a base64-encoded string.

    " } - }, - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", - "traits": { - "smithy.api#documentation": "

    The name of the lifecycle configuration.

    ", - "smithy.api#required": {} - } } } }, @@ -3911,12 +3942,18 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

    " + "smithy.api#documentation": "

    Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

    \n \n

    The URL that you get from a call to CreatePresignedDomainUrl is valid\n only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you\n are directed to the AWS console sign-in page.

    \n     " } }, "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest": { "type": "structure", "members": { + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "

    The session expiration duration in seconds.

    " + } + }, "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { @@ -3930,12 +3967,6 @@ "smithy.api#documentation": "

    The domain ID.

    ", "smithy.api#required": {} } - }, - "SessionExpirationDurationInSeconds": { - "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", - "traits": { - "smithy.api#documentation": "

    The session expiration duration in seconds.

    " - } } } }, @@ -3965,18 +3996,18 @@ "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput": { "type": "structure", "members": { + "SessionExpirationDurationInSeconds": { + "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", + "traits": { + "smithy.api#documentation": "

    The duration of the session, in seconds. The default is 12 hours.

    " + } + }, "NotebookInstanceName": { "target": "com.amazonaws.sagemaker#NotebookInstanceName", "traits": { "smithy.api#documentation": "

    The name of the notebook instance.

    ", "smithy.api#required": {} } - }, - "SessionExpirationDurationInSeconds": { - "target": "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds", - "traits": { - "smithy.api#documentation": "

    The duration of the session, in seconds. The default is 12 hours.

    " - } } } }, @@ -4017,72 +4048,72 @@ "com.amazonaws.sagemaker#CreateProcessingJobRequest": { "type": "structure", "members": { - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The name of the processing job. The name must be unique within an AWS Region in the\n AWS account.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

    " } }, - "AppSpecification": { - "target": "com.amazonaws.sagemaker#AppSpecification", + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", "traits": { - "smithy.api#documentation": "

    Configures the processing job to run a specified Docker container image.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The time limit for how long the processing job is allowed to run.

    " } }, - "Environment": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources", "traits": { - "smithy.api#documentation": "

    Sets the environment variables in the Docker container.

    " + "smithy.api#documentation": "

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.

    ", + "smithy.api#required": {} } }, - "ProcessingOutputConfig": { - "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", "traits": { - "smithy.api#documentation": "

    Output configuration for the processing job.

    " + "smithy.api#documentation": "

    For each input, data is downloaded from S3 into the processing container before the\n processing job begins running if \"S3InputMode\" is set to File.

    " } }, - "ProcessingResources": { - "target": "com.amazonaws.sagemaker#ProcessingResources", + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification", "traits": { - "smithy.api#documentation": "

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.

    ", + "smithy.api#documentation": "

    Configures the processing job to run a specified Docker container image.

    ", "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Output configuration for the processing job.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", "traits": { - "smithy.api#documentation": "

    (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

    " + "smithy.api#documentation": "

    Networking options for a processing job.

    " } }, - "ProcessingInputs": { - "target": "com.amazonaws.sagemaker#ProcessingInputs", + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", "traits": { - "smithy.api#documentation": "

    For each input, data is downloaded from S3 into the processing container before the\n processing job begins running if \"S3InputMode\" is set to File.

    " + "smithy.api#documentation": "

    Sets the environment variables in the Docker container.

    " } }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { - "smithy.api#documentation": "

    The time limit for how long the processing job is allowed to run.

    " + "smithy.api#documentation": "

    The name of the processing job. The name must be unique within an AWS Region in the\n AWS account.

    ", + "smithy.api#required": {} } }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#NetworkConfig", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    Networking options for a processing job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.

    ", + "smithy.api#required": {} } - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" } } }, @@ -4124,69 +4155,65 @@ "com.amazonaws.sagemaker#CreateTrainingJobRequest": { "type": "structure", "members": { - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", "traits": { - "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training. For more information, see Protect Communications Between ML\n Compute Instances in a Distributed Training Job.

    " + "smithy.api#documentation": "

    The name of the training job. The name must be unique within an AWS Region in an\n AWS account.

    ", + "smithy.api#required": {} } }, - "HyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

    Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by Amazon SageMaker, see Algorithms.

    \n

    You can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.

    " + "smithy.api#documentation": "

    The registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by Amazon SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

    ", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.\n \n

    " + "smithy.api#documentation": "

    The resources, including the ML compute instances and ML storage volumes, to use\n for model training.

    \n

    ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

    ", + "smithy.api#required": {} } }, - "DebugRuleConfigurations": { - "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "

    Configuration information for debugging rules.

    " + "smithy.api#documentation": "

    Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by Amazon SageMaker, see Algorithms.

    \n

    You can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.

    " } }, - "TensorBoardOutputConfig": { - "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" - }, - "AlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "

    The registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by Amazon SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

    ", + "smithy.api#documentation": "

    Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker\n creates subfolders for the artifacts.

    ", "smithy.api#required": {} } }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#InputDataConfig", + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig", "traits": { - "smithy.api#documentation": "

    An array of Channel objects. Each channel is a named input source.\n InputDataConfig\n \n describes the input data and its location.

    \n

    Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

    \n

    Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files will be made available as input streams. They do not need to be\n downloaded.

    " + "smithy.api#documentation": "

    Contains information about the output location for managed spot training checkpoint\n data.

    " } }, - "DebugHookConfig": { - "target": "com.amazonaws.sagemaker#DebugHookConfig" - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform\n tasks on your behalf.

    \n

    During model training, Amazon SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker\n Roles.

    \n \n

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training. For more information, see Protect Communications Between ML\n Compute Instances in a Distributed Training Job.

    " } }, - "EnableManagedSpotTraining": { - "target": "com.amazonaws.sagemaker#Boolean", + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "

    To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.

    \n

    The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.

    " + "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that you want your\n training job to connect to. Control access to and from your training container by\n configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

    " } }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

    " + "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.\n \n

    " } }, "StoppingCondition": { @@ -4196,37 +4223,41 @@ "smithy.api#required": {} } }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", "traits": { - "smithy.api#documentation": "

    The resources, including the ML compute instances and ML storage volumes, to use\n for model training.

    \n

    ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Configuration information for debugging rules.

    " } }, - "CheckpointConfig": { - "target": "com.amazonaws.sagemaker#CheckpointConfig", + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    Contains information about the output location for managed spot training checkpoint\n data.

    " + "smithy.api#documentation": "

    Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

    " } }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#OutputDataConfig", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker\n creates subfolders for the artifacts.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform\n tasks on your behalf.

    \n

    During model training, Amazon SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker\n Roles.

    \n \n

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     ", "smithy.api#required": {} } }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", + "DebugHookConfig": { + "target": "com.amazonaws.sagemaker#DebugHookConfig" + }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that you want your\n training job to connect to. Control access to and from your training container by\n configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

    " + "smithy.api#documentation": "

    An array of Channel objects. Each channel is a named input source.\n InputDataConfig\n \n describes the input data and its location.

    \n

    Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

    \n

    Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files will be made available as input streams. They do not need to be\n downloaded.

    " } }, - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    The name of the training job. The name must be unique within an AWS Region in an\n AWS account.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.

    \n

    The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.

    " } } } @@ -4269,23 +4300,15 @@ "com.amazonaws.sagemaker#CreateTransformJobRequest": { "type": "structure", "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "

    The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an AWS\n Region in an AWS account.

    ", - "smithy.api#required": {} - } + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" }, - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput", + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "

    Describes the results of the transform job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.

    \n

    To enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.

    \n

    To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.

    \n

    To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.

    " } }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, "TransformJobName": { "target": "com.amazonaws.sagemaker#TransformJobName", "traits": { @@ -4293,16 +4316,11 @@ "smithy.api#required": {} } }, - "MaxPayloadInMB": { - "target": "com.amazonaws.sagemaker#MaxPayloadInMB", - "traits": { - "smithy.api#documentation": "

    The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n

    \n

    For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.

    " - } - }, - "BatchStrategy": { - "target": "com.amazonaws.sagemaker#BatchStrategy", + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", "traits": { - "smithy.api#documentation": "

    Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.

    \n

    To enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.

    \n

    To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.

    \n

    To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.

    " + "smithy.api#documentation": "

    Describes the resources, including\n ML\n instance types and ML instance count, to use for the transform\n job.

    ", + "smithy.api#required": {} } }, "Tags": { @@ -4311,17 +4329,30 @@ "smithy.api#documentation": "

    (Optional)\n An\n array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " } }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources", + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", "traits": { - "smithy.api#documentation": "

    Describes the resources, including\n ML\n instance types and ML instance count, to use for the transform\n job.

    ", + "smithy.api#documentation": "

    The maximum number of parallel requests that can be sent to each instance in a\n transform job. If MaxConcurrentTransforms is set to 0 or left\n unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your\n chosen algorithm. If the execution-parameters endpoint is not enabled, the default value\n is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to\n set a value for MaxConcurrentTransforms.

    " + } + }, + "ModelClientConfig": { + "target": "com.amazonaws.sagemaker#ModelClientConfig", + "traits": { + "smithy.api#documentation": "

    Configures the timeout and maximum number of retries for processing a transform job\n invocation.

    " + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", + "traits": { + "smithy.api#documentation": "

    Describes the results of the transform job.

    ", "smithy.api#required": {} } }, - "DataProcessing": { - "target": "com.amazonaws.sagemaker#DataProcessing", + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", "traits": { - "smithy.api#documentation": "

    The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.

    " + "smithy.api#documentation": "

    Describes the input source and\n the\n way the transform job consumes it.

    ", + "smithy.api#required": {} } }, "Environment": { @@ -4330,23 +4361,23 @@ "smithy.api#documentation": "

    The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.

    " } }, - "ModelClientConfig": { - "target": "com.amazonaws.sagemaker#ModelClientConfig", + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing", "traits": { - "smithy.api#documentation": "

    Configures the timeout and maximum number of retries for processing a transform job invocation.

    " + "smithy.api#documentation": "

    The data structure used to specify the data to be used for inference in a batch\n transform job and to associate the data that is relevant to the prediction results in\n the output. The input filter provided allows you to exclude input data that is not\n needed for inference in a batch transform job. The output filter provided allows you to\n include input data relevant to interpreting the predictions in the output from the job.\n For more information, see Associate Prediction\n Results with their Corresponding Input Records.

    " } }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput", + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

    Describes the input source and\n the\n way the transform job consumes it.

    ", + "smithy.api#documentation": "

    The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an AWS\n Region in an AWS account.

    ", "smithy.api#required": {} } }, - "MaxConcurrentTransforms": { - "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "

    The maximum number of parallel requests that can be sent to each instance in a\n transform job. If MaxConcurrentTransforms is set to 0 or left\n unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your\n chosen algorithm. If the execution-parameters endpoint is not enabled, the default value\n is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to\n set a value for MaxConcurrentTransforms.

    " + "smithy.api#documentation": "

    The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n

    \n

    For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.

    " } } } @@ -4403,16 +4434,10 @@ "com.amazonaws.sagemaker#CreateTrialComponentRequest": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.sagemaker#TrialComponentParameters", - "traits": { - "smithy.api#documentation": "

    The hyperparameters for the component.

    " - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The status of the component. States include:

    \n
      \n
    • \n

      InProgress

      \n
      • \n
    • \n

      Completed

      \n
      • \n
    • \n

      Failed

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.

    " } }, "EndTime": { @@ -4421,17 +4446,16 @@ "smithy.api#documentation": "

    When the component ended.

    " } }, - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", "traits": { - "smithy.api#documentation": "

    The name of the component. The name must be unique in your AWS account and is not\n case-sensitive.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The input artifacts for the component. Examples of input artifacts are datasets,\n algorithms, hyperparameters, source code, and instance types.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", "traits": { - "smithy.api#documentation": "

    A list of tags to associate with the component. You can use Search API\n to search on the tags.

    " + "smithy.api#documentation": "

    The status of the component. States include:

    \n
      \n
    • \n

      InProgress

      \n
      • \n
    • \n

      Completed

      \n
      • \n
    • \n

      Failed

      \n
      • \n
    " } }, "OutputArtifacts": { @@ -4440,22 +4464,29 @@ "smithy.api#documentation": "

    The output artifacts for the component. Examples of output artifacts are metrics,\n snapshots, logs, and images.

    " } }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "

    The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.

    " - } - }, "StartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { "smithy.api#documentation": "

    When the component started.

    " } }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The input artifacts for the component. Examples of input artifacts are datasets,\n algorithms, hyperparameters, source code, and instance types.

    " + "smithy.api#documentation": "

    A list of tags to associate with the component. You can use Search API\n to search on the tags.

    " + } + }, + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "traits": { + "smithy.api#documentation": "

    The hyperparameters for the component.

    " + } + }, + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

    The name of the component. The name must be unique in your AWS account and is not\n case-sensitive.

    ", + "smithy.api#required": {} } } } @@ -4474,6 +4505,12 @@ "com.amazonaws.sagemaker#CreateTrialRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "

    A list of tags to associate with the trial. You can use Search API to\n search on the tags.

    " + } + }, "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { @@ -4493,12 +4530,6 @@ "smithy.api#documentation": "

    The name of the trial. The name must be unique in your AWS account and is not\n case-sensitive.

    ", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "

    A list of tags to associate with the trial. You can use Search API to\n search on the tags.

    " - } } } }, @@ -4536,18 +4567,24 @@ "com.amazonaws.sagemaker#CreateUserProfileRequest": { "type": "structure", "members": { - "SingleSignOnUserValue": { - "target": "com.amazonaws.sagemaker#String256", - "traits": { - "smithy.api#documentation": "

    The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is\n required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.\n

    " - } - }, "UserSettings": { "target": "com.amazonaws.sagemaker#UserSettings", "traits": { "smithy.api#documentation": "

    A collection of settings.

    " } }, + "SingleSignOnUserIdentifier": { + "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", + "traits": { + "smithy.api#documentation": "

    A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\".\n If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.\n

    " + } + }, + "SingleSignOnUserValue": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

    The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is\n required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.\n

    " + } + }, "DomainId": { "target": "com.amazonaws.sagemaker#DomainId", "traits": { @@ -4555,12 +4592,6 @@ "smithy.api#required": {} } }, - "SingleSignOnUserIdentifier": { - "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", - "traits": { - "smithy.api#documentation": "

    A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\".\n If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.\n

    " - } - }, "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { @@ -4596,22 +4627,23 @@ "target": "com.amazonaws.sagemaker#CreateWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

    Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the AWS Region that you specify. You can only\n create one workforce in each AWS Region.

    \n\n

    If you want to create a new workforce in an AWS Region where the \n a workforce already exists, use the API\n operation to delete the existing workforce and then use this operation \n to create a new workforce.

    \n\n

    To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).

    \n\n

    To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. You must create a OIDC IdP workforce using\n this API operation. For more information, see \n \n Create a Private Workforce (OIDC IdP).

    " + "smithy.api#documentation": "

    Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the AWS Region that you specify. You can only\n create one workforce in each AWS Region per AWS account.

    \n\n

    If you want to create a new workforce in an AWS Region where \n a workforce already exists, use the API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.

    \n\n

    To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).

    \n\n

    To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).

    " } }, "com.amazonaws.sagemaker#CreateWorkforceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", "traits": { - "smithy.api#documentation": "

    An array of key-value pairs that contain metadata to help you categorize and \n organize our workforce. Each tag consists of a key and a value, \n both of which you define.

    " + "smithy.api#documentation": "

    The name of the private workforce.

    ", + "smithy.api#required": {} } }, "OidcConfig": { "target": "com.amazonaws.sagemaker#OidcConfig", "traits": { - "smithy.api#documentation": "

    Use this parameter to configure a private workforce using your own OIDC Identity Provider.\n Do not use CognitoConfig if you specify values for \n OidcConfig.

    " + "smithy.api#documentation": "

    Use this parameter to configure a private workforce using your own OIDC Identity Provider.

    \n

    Do not use CognitoConfig if you specify values for \n OidcConfig.

    " } }, "CognitoConfig": { @@ -4623,11 +4655,10 @@ "SourceIpConfig": { "target": "com.amazonaws.sagemaker#SourceIpConfig" }, - "WorkforceName": { - "target": "com.amazonaws.sagemaker#WorkforceName", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The name of the private workforce.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of key-value pairs that contain metadata to help you categorize and \n organize our workforce. Each tag consists of a key and a value, \n both of which you define.

    " } } } @@ -4667,17 +4698,10 @@ "com.amazonaws.sagemaker#CreateWorkteamRequest": { "type": "structure", "members": { - "NotificationConfiguration": { - "target": "com.amazonaws.sagemaker#NotificationConfiguration", - "traits": { - "smithy.api#documentation": "

    Configures notification of workers regarding available or expiring work items.

    " - } - }, - "WorkteamName": { - "target": "com.amazonaws.sagemaker#WorkteamName", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The name of the work team. Use this name to identify the work team.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of key-value pairs.

    \n

    For more information, see Resource\n Tag and Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " } }, "Description": { @@ -4687,11 +4711,10 @@ "smithy.api#required": {} } }, - "MemberDefinitions": { - "target": "com.amazonaws.sagemaker#MemberDefinitions", + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", "traits": { - "smithy.api#documentation": "

    A list of MemberDefinition objects that contains objects that identify\n the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User\n Pools.

    \n

    All of the CognitoMemberDefinition objects that make up the member\n definition must have the same ClientId and UserPool\n values.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Configures notification of workers regarding available or expiring work items.

    " } }, "WorkforceName": { @@ -4700,10 +4723,18 @@ "smithy.api#documentation": "

    The name of the workforce.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", "traits": { - "smithy.api#documentation": "

    An array of key-value pairs.

    \n

    For more information, see Resource\n Tag and Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " + "smithy.api#documentation": "

    The name of the work team. Use this name to identify the work team.

    ", + "smithy.api#required": {} + } + }, + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", + "traits": { + "smithy.api#documentation": "

    A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

    \n

    Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For\n private workforces created using Amazon Cognito use CognitoMemberDefinition. For\n workforces created using your own OIDC identity provider (IdP) use\n OidcMemberDefinition. Do not provide input for both of these parameters\n in a single request.

    \n

    For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

    \n

    For workforces created using your own OIDC IdP, specify the user groups that you want to \n include in your private work team in OidcMemberDefinition by listing those groups\n in Groups.

    ", + "smithy.api#required": {} } } } @@ -4747,8 +4778,8 @@ "com.amazonaws.sagemaker#DataCaptureConfig": { "type": "structure", "members": { - "EnableCapture": { - "target": "com.amazonaws.sagemaker#EnableCapture", + "CaptureContentTypeHeader": { + "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader", "traits": { "smithy.api#documentation": "

    " } @@ -4759,13 +4790,19 @@ "smithy.api#documentation": "

    " } }, - "DestinationS3Uri": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "CaptureOptions": { + "target": "com.amazonaws.sagemaker#CaptureOptionList", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, + "EnableCapture": { + "target": "com.amazonaws.sagemaker#EnableCapture", + "traits": { + "smithy.api#documentation": "

    " + } + }, "InitialSamplingPercentage": { "target": "com.amazonaws.sagemaker#SamplingPercentage", "traits": { @@ -4773,18 +4810,12 @@ "smithy.api#required": {} } }, - "CaptureOptions": { - "target": "com.amazonaws.sagemaker#CaptureOptionList", + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } - }, - "CaptureContentTypeHeader": { - "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader", - "traits": { - "smithy.api#documentation": "

    " - } } }, "traits": { @@ -4794,36 +4825,36 @@ "com.amazonaws.sagemaker#DataCaptureConfigSummary": { "type": "structure", "members": { - "DestinationS3Uri": { - "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "CaptureStatus": { + "target": "com.amazonaws.sagemaker#CaptureStatus", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "CaptureStatus": { - "target": "com.amazonaws.sagemaker#CaptureStatus", + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "CurrentSamplingPercentage": { + "target": "com.amazonaws.sagemaker#SamplingPercentage", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "EnableCapture": { - "target": "com.amazonaws.sagemaker#EnableCapture", + "DestinationS3Uri": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "CurrentSamplingPercentage": { - "target": "com.amazonaws.sagemaker#SamplingPercentage", + "EnableCapture": { + "target": "com.amazonaws.sagemaker#EnableCapture", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} @@ -4855,12 +4886,6 @@ "com.amazonaws.sagemaker#DataProcessing": { "type": "structure", "members": { - "InputFilter": { - "target": "com.amazonaws.sagemaker#JsonPath", - "traits": { - "smithy.api#documentation": "

    A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.

    \n

    Examples: \"$\", \"$[1:]\", \"$.features\"\n

    " - } - }, "JoinSource": { "target": "com.amazonaws.sagemaker#JoinSource", "traits": { @@ -4872,6 +4897,12 @@ "traits": { "smithy.api#documentation": "

    A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.

    \n

    Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n

    " } + }, + "InputFilter": { + "target": "com.amazonaws.sagemaker#JsonPath", + "traits": { + "smithy.api#documentation": "

    A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.

    \n

    Examples: \"$\", \"$[1:]\", \"$.features\"\n

    " + } } }, "traits": { @@ -4881,17 +4912,17 @@ "com.amazonaws.sagemaker#DataSource": { "type": "structure", "members": { - "S3DataSource": { - "target": "com.amazonaws.sagemaker#S3DataSource", - "traits": { - "smithy.api#documentation": "

    The S3 location of the data source that is associated with a channel.

    " - } - }, "FileSystemDataSource": { "target": "com.amazonaws.sagemaker#FileSystemDataSource", "traits": { "smithy.api#documentation": "

    The file system that is associated with a channel.

    " } + }, + "S3DataSource": { + "target": "com.amazonaws.sagemaker#S3DataSource", + "traits": { + "smithy.api#documentation": "

    The S3 location of the data source that is associated with a channel.

    " + } } }, "traits": { @@ -4901,10 +4932,11 @@ "com.amazonaws.sagemaker#DebugHookConfig": { "type": "structure", "members": { - "CollectionConfigurations": { - "target": "com.amazonaws.sagemaker#CollectionConfigurations", + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    Configuration information for tensor collections.

    " + "smithy.api#documentation": "

    Path to Amazon S3 storage location for tensors.

    ", + "smithy.api#required": {} } }, "LocalPath": { @@ -4913,17 +4945,16 @@ "smithy.api#documentation": "

    Path to local storage location for tensors. Defaults to\n /opt/ml/output/tensors/.

    " } }, - "HookParameters": { - "target": "com.amazonaws.sagemaker#HookParameters", + "CollectionConfigurations": { + "target": "com.amazonaws.sagemaker#CollectionConfigurations", "traits": { - "smithy.api#documentation": "

    Configuration information for the debug hook parameters.

    " + "smithy.api#documentation": "

    Configuration information for tensor collections.

    " } }, - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3Uri", + "HookParameters": { + "target": "com.amazonaws.sagemaker#HookParameters", "traits": { - "smithy.api#documentation": "

    Path to Amazon S3 storage location for tensors.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Configuration information for the debug hook parameters.

    " } } }, @@ -4934,30 +4965,23 @@ "com.amazonaws.sagemaker#DebugRuleConfiguration": { "type": "structure", "members": { - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3Uri", - "traits": { - "smithy.api#documentation": "

    Path to Amazon S3 storage location for rules.

    " - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", "traits": { - "smithy.api#documentation": "

    The instance type to deploy for a training job.

    " + "smithy.api#documentation": "

    The name of the rule configuration. It must be unique relative to other rule\n configuration names.

    ", + "smithy.api#required": {} } }, - "RuleEvaluatorImage": { - "target": "com.amazonaws.sagemaker#AlgorithmImage", + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", "traits": { - "smithy.api#documentation": "

    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Path to local storage location for output of rules. Defaults to\n /opt/ml/processing/output/rule/.

    " } }, - "RuleConfigurationName": { - "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

    The name of the rule configuration. It must be unique relative to other rule\n configuration names.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The size, in GB, of the ML storage volume attached to the processing instance.

    " } }, "RuleParameters": { @@ -4966,16 +4990,23 @@ "smithy.api#documentation": "

    Runtime configuration for rule container.

    " } }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    The size, in GB, of the ML storage volume attached to the processing instance.

    " + "smithy.api#documentation": "

    Path to Amazon S3 storage location for rules.

    " } }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", "traits": { - "smithy.api#documentation": "

    Path to local storage location for output of rules. Defaults to\n /opt/ml/processing/output/rule/.

    " + "smithy.api#documentation": "

    The instance type to deploy for a training job.

    " + } + }, + "RuleEvaluatorImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#documentation": "

    The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

    ", + "smithy.api#required": {} } } }, @@ -4998,10 +5029,10 @@ "com.amazonaws.sagemaker#DebugRuleEvaluationStatus": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "RuleConfigurationName": { + "target": "com.amazonaws.sagemaker#RuleConfigurationName", "traits": { - "smithy.api#documentation": "

    Timestamp when the rule evaluation status was last modified.

    " + "smithy.api#documentation": "

    The name of the rule configuration

    " } }, "StatusDetails": { @@ -5010,22 +5041,22 @@ "smithy.api#documentation": "

    Details from the rule evaluation.

    " } }, - "RuleEvaluationJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the rule evaluation job.

    " - } - }, "RuleEvaluationStatus": { "target": "com.amazonaws.sagemaker#RuleEvaluationStatus", "traits": { "smithy.api#documentation": "

    Status of the rule evaluation.

    " } }, - "RuleConfigurationName": { - "target": "com.amazonaws.sagemaker#RuleConfigurationName", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the rule configuration

    " + "smithy.api#documentation": "

    Timestamp when the rule evaluation status was last modified.

    " + } + }, + "RuleEvaluationJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the rule evaluation job.

    " } } }, @@ -5086,10 +5117,10 @@ "com.amazonaws.sagemaker#DeleteAppRequest": { "type": "structure", "members": { - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", "traits": { - "smithy.api#documentation": "

    The type of app.

    ", + "smithy.api#documentation": "

    The domain ID.

    ", "smithy.api#required": {} } }, @@ -5107,10 +5138,10 @@ "smithy.api#required": {} } }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", "traits": { - "smithy.api#documentation": "

    The domain ID.

    ", + "smithy.api#documentation": "

    The type of app.

    ", "smithy.api#required": {} } } @@ -5448,17 +5479,17 @@ "com.amazonaws.sagemaker#DeleteTagsInput": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.sagemaker#TagKeyList", + "ResourceArn": { + "target": "com.amazonaws.sagemaker#ResourceArn", "traits": { - "smithy.api#documentation": "

    An array or one or more tag keys to delete.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource whose tags you want to\n delete.

    ", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.sagemaker#ResourceArn", + "TagKeys": { + "target": "com.amazonaws.sagemaker#TagKeyList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource whose tags you want to\n delete.

    ", + "smithy.api#documentation": "

    An array or one or more tag keys to delete.

    ", "smithy.api#required": {} } } @@ -5593,7 +5624,7 @@ "target": "com.amazonaws.sagemaker#DeleteWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

    Use this operation to delete a workforce.

    \n\n

    If you want to create a new workforce in an AWS Region where the \n a workforce already exists, use this operation to delete the \n existing workforce and then use \n to create a new workforce.

    " + "smithy.api#documentation": "

    Use this operation to delete a workforce.

    \n\n

    If you want to create a new workforce in an AWS Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use \n to create a new workforce.

    \n \n

    If a private workforce contains one or more work teams, you must use \n the \n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will recieve a ResourceInUse error.

    \n     " } }, "com.amazonaws.sagemaker#DeleteWorkforceRequest": { @@ -5656,6 +5687,12 @@ "com.amazonaws.sagemaker#DeployedImage": { "type": "structure", "members": { + "SpecifiedImage": { + "target": "com.amazonaws.sagemaker#ContainerImage", + "traits": { + "smithy.api#documentation": "

    The image path you specified when you created the model.

    " + } + }, "ResolutionTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { @@ -5667,12 +5704,6 @@ "traits": { "smithy.api#documentation": "

    The specific digest path of the image hosted in this\n ProductionVariant.

    " } - }, - "SpecifiedImage": { - "target": "com.amazonaws.sagemaker#ContainerImage", - "traits": { - "smithy.api#documentation": "

    The image path you specified when you created the model.

    " - } } }, "traits": { @@ -5712,42 +5743,31 @@ "com.amazonaws.sagemaker#DescribeAlgorithmOutput": { "type": "structure", "members": { - "CertifyForMarketplace": { - "target": "com.amazonaws.sagemaker#CertifyForMarketplace", - "traits": { - "smithy.api#documentation": "

    Whether the algorithm is certified to be listed in AWS Marketplace.

    " - } - }, - "TrainingSpecification": { - "target": "com.amazonaws.sagemaker#TrainingSpecification", + "AlgorithmStatus": { + "target": "com.amazonaws.sagemaker#AlgorithmStatus", "traits": { - "smithy.api#documentation": "

    Details about training jobs run by this algorithm.

    ", + "smithy.api#documentation": "

    The current status of the algorithm.

    ", "smithy.api#required": {} } }, - "ProductId": { - "target": "com.amazonaws.sagemaker#ProductId", - "traits": { - "smithy.api#documentation": "

    The product identifier of the algorithm.

    " - } - }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", + "ValidationSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", "traits": { - "smithy.api#documentation": "

    Details about inference jobs that the algorithm runs.

    " + "smithy.api#documentation": "

    Details about configurations for one or more training jobs that Amazon SageMaker runs to test the\n algorithm.

    " } }, - "AlgorithmStatus": { - "target": "com.amazonaws.sagemaker#AlgorithmStatus", + "TrainingSpecification": { + "target": "com.amazonaws.sagemaker#TrainingSpecification", "traits": { - "smithy.api#documentation": "

    The current status of the algorithm.

    ", + "smithy.api#documentation": "

    Details about training jobs run by this algorithm.

    ", "smithy.api#required": {} } }, - "ValidationSpecification": { - "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", + "AlgorithmName": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    Details about configurations for one or more training jobs that Amazon SageMaker runs to test the\n algorithm.

    " + "smithy.api#documentation": "

    The name of the algorithm being described.

    ", + "smithy.api#required": {} } }, "AlgorithmStatusDetails": { @@ -5763,11 +5783,10 @@ "smithy.api#documentation": "

    A brief summary about the algorithm.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

    A timestamp specifying when the algorithm was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether the algorithm is certified to be listed in AWS Marketplace.

    " } }, "AlgorithmArn": { @@ -5777,12 +5796,24 @@ "smithy.api#required": {} } }, - "AlgorithmName": { - "target": "com.amazonaws.sagemaker#EntityName", + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    The name of the algorithm being described.

    ", + "smithy.api#documentation": "

    A timestamp specifying when the algorithm was created.

    ", "smithy.api#required": {} } + }, + "ProductId": { + "target": "com.amazonaws.sagemaker#ProductId", + "traits": { + "smithy.api#documentation": "

    The product identifier of the algorithm.

    " + } + }, + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", + "traits": { + "smithy.api#documentation": "

    Details about inference jobs that the algorithm runs.

    " + } } } }, @@ -5806,10 +5837,17 @@ "com.amazonaws.sagemaker#DescribeAppRequest": { "type": "structure", "members": { - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

    The type of app.

    ", + "smithy.api#documentation": "

    The user profile name.

    ", + "smithy.api#required": {} + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

    The domain ID.

    ", "smithy.api#required": {} } }, @@ -5820,17 +5858,10 @@ "smithy.api#required": {} } }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", "traits": { - "smithy.api#documentation": "

    The user profile name.

    ", - "smithy.api#required": {} - } - }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", - "traits": { - "smithy.api#documentation": "

    The domain ID.

    ", + "smithy.api#documentation": "

    The type of app.

    ", "smithy.api#required": {} } } @@ -5839,10 +5870,28 @@ "com.amazonaws.sagemaker#DescribeAppResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.sagemaker#AppStatus", + "LastUserActivityTimestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The status.

    " + "smithy.api#documentation": "

    The timestamp of the last user's activity.

    " + } + }, + "AppName": { + "target": "com.amazonaws.sagemaker#AppName", + "traits": { + "smithy.api#documentation": "

    The name of the app.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

    The creation time.

    " + } + }, + "AppType": { + "target": "com.amazonaws.sagemaker#AppType", + "traits": { + "smithy.api#documentation": "

    The type of app.

    " } }, "UserProfileName": { @@ -5857,28 +5906,28 @@ "smithy.api#documentation": "

    The app's Amazon Resource Name (ARN).

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "

    The failure reason.

    " - } - }, "DomainId": { "target": "com.amazonaws.sagemaker#DomainId", "traits": { "smithy.api#documentation": "

    The domain ID.

    " } }, + "Status": { + "target": "com.amazonaws.sagemaker#AppStatus", + "traits": { + "smithy.api#documentation": "

    The status.

    " + } + }, "ResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { "smithy.api#documentation": "

    The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

    " } }, - "AppName": { - "target": "com.amazonaws.sagemaker#AppName", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The name of the app.

    " + "smithy.api#documentation": "

    The failure reason.

    " } }, "LastHealthCheckTimestamp": { @@ -5886,24 +5935,6 @@ "traits": { "smithy.api#documentation": "

    The timestamp of the last health check.

    " } - }, - "LastUserActivityTimestamp": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The timestamp of the last user's activity.

    " - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "

    The creation time.

    " - } - }, - "AppType": { - "target": "com.amazonaws.sagemaker#AppType", - "traits": { - "smithy.api#documentation": "

    The type of app.

    " - } } } }, @@ -5939,32 +5970,19 @@ "com.amazonaws.sagemaker#DescribeAutoMLJobResponse": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "AutoMLJobConfig": { + "target": "com.amazonaws.sagemaker#AutoMLJobConfig", "traits": { - "smithy.api#documentation": "

    Returns the job's creation time.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Returns the job's config.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "AutoMLJobStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobStatus", "traits": { - "smithy.api#documentation": "

    Returns the job's last modified time.

    ", + "smithy.api#documentation": "

    Returns the job's AutoMLJobStatus.

    ", "smithy.api#required": {} } }, - "BestCandidate": { - "target": "com.amazonaws.sagemaker#AutoMLCandidate", - "traits": { - "smithy.api#documentation": "

    Returns the job's BestCandidate.

    " - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    Returns the job's end time.

    " - } - }, "AutoMLJobName": { "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { @@ -5972,41 +5990,29 @@ "smithy.api#required": {} } }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", "traits": { - "smithy.api#documentation": "

    Returns the job's ARN.

    ", + "smithy.api#documentation": "

    Returns the job's input data config.

    ", "smithy.api#required": {} } }, - "GenerateCandidateDefinitionsOnly": { - "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", - "traits": { - "smithy.api#documentation": "

    Returns the job's output from GenerateCandidateDefinitionsOnly.

    " - } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#AutoMLFailureReason", - "traits": { - "smithy.api#documentation": "

    Returns the job's FailureReason.

    " - } - }, "AutoMLJobObjective": { "target": "com.amazonaws.sagemaker#AutoMLJobObjective", "traits": { "smithy.api#documentation": "

    Returns the job's objective.

    " } }, - "AutoMLJobArtifacts": { - "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts", + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Returns information on the job's artifacts found in AutoMLJobArtifacts.

    " + "smithy.api#documentation": "

    Returns the job's end time.

    " } }, - "AutoMLJobSecondaryStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", "traits": { - "smithy.api#documentation": "

    Returns the job's AutoMLJobSecondaryStatus.

    ", + "smithy.api#documentation": "

    Returns the job's output data config.

    ", "smithy.api#required": {} } }, @@ -6016,45 +6022,70 @@ "smithy.api#documentation": "

    This contains ProblemType, AutoMLJobObjective and CompletionCriteria. They're\n auto-inferred values, if not provided by you. If you do provide them, then they'll be the\n same as provided.

    " } }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    Returns the job's output data config.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to\n the input data location and write permission to the output data location in Amazon S3.

    ", "smithy.api#required": {} } }, + "BestCandidate": { + "target": "com.amazonaws.sagemaker#AutoMLCandidate", + "traits": { + "smithy.api#documentation": "

    Returns the job's BestCandidate.

    " + } + }, "ProblemType": { "target": "com.amazonaws.sagemaker#ProblemType", "traits": { "smithy.api#documentation": "

    Returns the job's problem type.

    " } }, - "AutoMLJobStatus": { - "target": "com.amazonaws.sagemaker#AutoMLJobStatus", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Returns the job's AutoMLJobStatus.

    ", + "smithy.api#documentation": "

    Returns the job's creation time.

    ", "smithy.api#required": {} } }, - "AutoMLJobConfig": { - "target": "com.amazonaws.sagemaker#AutoMLJobConfig", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Returns the job's config.

    " + "smithy.api#documentation": "

    Returns the job's last modified time.

    ", + "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "AutoMLJobSecondaryStatus": { + "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to\n the input data location and write permission to the output data location in Amazon S3.

    ", + "smithy.api#documentation": "

    Returns the job's AutoMLJobSecondaryStatus.

    ", "smithy.api#required": {} } }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "

    Returns the job's input data config.

    ", + "smithy.api#documentation": "

    Returns the job's ARN.

    ", "smithy.api#required": {} } + }, + "AutoMLJobArtifacts": { + "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts", + "traits": { + "smithy.api#documentation": "

    Returns information on the job's artifacts found in AutoMLJobArtifacts.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#AutoMLFailureReason", + "traits": { + "smithy.api#documentation": "

    Returns the job's FailureReason.

    " + } + }, + "GenerateCandidateDefinitionsOnly": { + "target": "com.amazonaws.sagemaker#GenerateCandidateDefinitionsOnly", + "traits": { + "smithy.api#documentation": "

    Returns the job's output from GenerateCandidateDefinitionsOnly.

    " + } } } }, @@ -6092,6 +6123,12 @@ "smithy.api#required": {} } }, + "GitConfig": { + "target": "com.amazonaws.sagemaker#GitConfig", + "traits": { + "smithy.api#documentation": "

    Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets\n Manager secret that contains the credentials used to access the repository.

    " + } + }, "CodeRepositoryName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { @@ -6099,12 +6136,6 @@ "smithy.api#required": {} } }, - "GitConfig": { - "target": "com.amazonaws.sagemaker#GitConfig", - "traits": { - "smithy.api#documentation": "

    Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets\n Manager secret that contains the credentials used to access the repository.

    " - } - }, "CreationTime": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { @@ -6153,6 +6184,13 @@ "com.amazonaws.sagemaker#DescribeCompilationJobResponse": { "type": "structure", "members": { + "CompilationJobStatus": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the model compilation job.

    ", + "smithy.api#required": {} + } + }, "ModelArtifacts": { "target": "com.amazonaws.sagemaker#ModelArtifacts", "traits": { @@ -6160,10 +6198,10 @@ "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "CompilationJobArn": { + "target": "com.amazonaws.sagemaker#CompilationJobArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model compilation job.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model\n compilation job.

    ", "smithy.api#required": {} } }, @@ -6173,20 +6211,6 @@ "smithy.api#documentation": "

    The time when the model compilation job started the CompilationJob\n instances.

    \n

    You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs,\n the start time might be later than this time. That's because it takes time to download\n the compilation job, which depends on the size of the compilation job container.

    " } }, - "CompilationJobName": { - "target": "com.amazonaws.sagemaker#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the model compilation job.

    ", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "

    The time that the model compilation job was created.

    ", - "smithy.api#required": {} - } - }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { @@ -6194,10 +6218,10 @@ "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    If a model compilation job failed, the reason it failed.

    ", + "smithy.api#documentation": "

    The time that the model compilation job was created.

    ", "smithy.api#required": {} } }, @@ -6215,13 +6239,19 @@ "smithy.api#required": {} } }, - "CompilationJobStatus": { - "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The status of the model compilation job.

    ", + "smithy.api#documentation": "

    If a model compilation job failed, the reason it failed.

    ", "smithy.api#required": {} } }, + "CompilationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time when the model compilation job on a compilation job instance ended. For a\n successful or stopped job, this is when the job's model artifacts have finished\n uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

    " + } + }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { @@ -6229,17 +6259,18 @@ "smithy.api#required": {} } }, - "CompilationJobArn": { - "target": "com.amazonaws.sagemaker#CompilationJobArn", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model\n compilation job.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model compilation job.

    ", "smithy.api#required": {} } }, - "CompilationEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "CompilationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    The time when the model compilation job on a compilation job instance ended. For a\n successful or stopped job, this is when the job's model artifacts have finished\n uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

    " + "smithy.api#documentation": "

    The name of the model compilation job.

    ", + "smithy.api#required": {} } } } @@ -6276,76 +6307,76 @@ "com.amazonaws.sagemaker#DescribeDomainResponse": { "type": "structure", "members": { - "DefaultUserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", "traits": { - "smithy.api#documentation": "

    Settings which are applied to all UserProfile in this domain, if settings are not explicitly specified\n in a given UserProfile.\n

    " + "smithy.api#documentation": "

    The domain name.

    " } }, - "HomeEfsFileSystemKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service encryption key ID.

    " + "smithy.api#documentation": "

    The domain's Amazon Resource Name (ARN).

    " } }, - "Url": { - "target": "com.amazonaws.sagemaker#String1024", + "SubnetIds": { + "target": "com.amazonaws.sagemaker#Subnets", "traits": { - "smithy.api#documentation": "

    The domain's URL.

    " + "smithy.api#documentation": "

    The VPC subnets that Studio uses for communication.

    " } }, - "SubnetIds": { - "target": "com.amazonaws.sagemaker#Subnets", + "AppNetworkAccessType": { + "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "

    Security setting to limit to a set of subnets.

    " + "smithy.api#documentation": "

    Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.

    \n
      \n
    • \n

      \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access

      \n
      • \n
    • \n

      \n VpcOnly - All Studio traffic is through the specified VPC and subnets

      \n
      • \n
    " } }, - "DomainArn": { - "target": "com.amazonaws.sagemaker#DomainArn", + "Status": { + "target": "com.amazonaws.sagemaker#DomainStatus", "traits": { - "smithy.api#documentation": "

    The domain's Amazon Resource Name (ARN).

    " + "smithy.api#documentation": "

    The status.

    " } }, - "VpcId": { - "target": "com.amazonaws.sagemaker#VpcId", + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", "traits": { - "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud.

    " + "smithy.api#documentation": "

    Settings which are applied to all UserProfile in this domain, if settings are not explicitly specified\n in a given UserProfile.\n

    " } }, - "DomainName": { - "target": "com.amazonaws.sagemaker#DomainName", + "SingleSignOnManagedApplicationInstanceId": { + "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "

    The domain name.

    " + "smithy.api#documentation": "

    The SSO managed application instance ID.

    " } }, - "AuthMode": { - "target": "com.amazonaws.sagemaker#AuthMode", + "Url": { + "target": "com.amazonaws.sagemaker#String1024", "traits": { - "smithy.api#documentation": "

    The domain's authentication mode.

    " + "smithy.api#documentation": "

    The domain's URL.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "VpcId": { + "target": "com.amazonaws.sagemaker#VpcId", "traits": { - "smithy.api#documentation": "

    The creation time.

    " + "smithy.api#documentation": "

    The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", "traits": { - "smithy.api#documentation": "

    The last modified time.

    " + "smithy.api#documentation": "

    The domain ID.

    " } }, - "SingleSignOnManagedApplicationInstanceId": { - "target": "com.amazonaws.sagemaker#String256", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The SSO managed application instance ID.

    " + "smithy.api#documentation": "

    The failure reason.

    " } }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", + "AuthMode": { + "target": "com.amazonaws.sagemaker#AuthMode", "traits": { - "smithy.api#documentation": "

    The domain ID.

    " + "smithy.api#documentation": "

    The domain's authentication mode.

    " } }, "HomeEfsFileSystemId": { @@ -6354,16 +6385,22 @@ "smithy.api#documentation": "

    The ID of the Amazon Elastic File System (EFS) managed by this Domain.

    " } }, - "Status": { - "target": "com.amazonaws.sagemaker#DomainStatus", + "HomeEfsFileSystemKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

    The status.

    " + "smithy.api#documentation": "

    The AWS Key Management Service encryption key ID.

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    The failure reason.

    " + "smithy.api#documentation": "

    The creation time.

    " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

    The last modified time.

    " } } } @@ -6407,20 +6444,10 @@ "com.amazonaws.sagemaker#DescribeEndpointConfigOutput": { "type": "structure", "members": { - "ProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantList", - "traits": { - "smithy.api#documentation": "

    An array of ProductionVariant objects, one for each model that you\n want to host at this endpoint.

    ", - "smithy.api#required": {} - } - }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#DataCaptureConfig" - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the endpoint configuration was created.

    ", + "smithy.api#documentation": "

    Name of the Amazon SageMaker endpoint configuration.

    ", "smithy.api#required": {} } }, @@ -6437,12 +6464,22 @@ "smithy.api#documentation": "

    AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

    " } }, - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantList", "traits": { - "smithy.api#documentation": "

    Name of the Amazon SageMaker endpoint configuration.

    ", + "smithy.api#documentation": "

    An array of ProductionVariant objects, one for each model that you\n want to host at this endpoint.

    ", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A timestamp that shows when the endpoint configuration was created.

    ", "smithy.api#required": {} } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfig" } } }, @@ -6461,62 +6498,62 @@ "com.amazonaws.sagemaker#DescribeEndpointOutput": { "type": "structure", "members": { - "EndpointStatus": { - "target": "com.amazonaws.sagemaker#EndpointStatus", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of the endpoint.

    \n
      \n
    • \n

      \n OutOfService: Endpoint is not available to take incoming\n requests.

      \n
      • \n
    • \n

      \n Creating: CreateEndpoint is executing.

      \n
      • \n
    • \n

      \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      \n
      • \n
    • \n

      \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

      \n
      • \n
    • \n

      \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

      \n
      • \n
    • \n

      \n InService: Endpoint is available to process incoming\n requests.

      \n
      • \n
    • \n

      \n Deleting: DeleteEndpoint is executing.

      \n
      • \n
    • \n

      \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

      \n
      • \n
    ", + "smithy.api#documentation": "

    A timestamp that shows when the endpoint was created.

    ", "smithy.api#required": {} } }, - "ProductionVariants": { - "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    An array of ProductionVariantSummary objects, one for each model\n hosted behind this endpoint.

    " + "smithy.api#documentation": "

    A timestamp that shows when the endpoint was last modified.

    ", + "smithy.api#required": {} } }, - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" + }, + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "

    The name of the endpoint configuration associated with this endpoint.

    ", + "smithy.api#documentation": "

    The status of the endpoint.

    \n
      \n
    • \n

      \n OutOfService: Endpoint is not available to take incoming\n requests.

      \n
      • \n
    • \n

      \n Creating: CreateEndpoint is executing.

      \n
      • \n
    • \n

      \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      \n
      • \n
    • \n

      \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

      \n
      • \n
    • \n

      \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

      \n
      • \n
    • \n

      \n InService: Endpoint is available to process incoming\n requests.

      \n
      • \n
    • \n

      \n Deleting: DeleteEndpoint is executing.

      \n
      • \n
    • \n

      \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", "traits": { - "smithy.api#documentation": "

    Name of the endpoint.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint.

    ", "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "

    If the status of the endpoint is Failed, the reason why it failed.\n

    " + "smithy.api#documentation": "

    An array of ProductionVariantSummary objects, one for each model\n hosted behind this endpoint.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the endpoint was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the status of the endpoint is Failed, the reason why it failed.\n

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the endpoint was last modified.

    ", + "smithy.api#documentation": "

    The name of the endpoint configuration associated with this endpoint.

    ", "smithy.api#required": {} } }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint.

    ", + "smithy.api#documentation": "

    Name of the endpoint.

    ", "smithy.api#required": {} } - }, - "DataCaptureConfig": { - "target": "com.amazonaws.sagemaker#DataCaptureConfigSummary" } } }, @@ -6552,16 +6589,22 @@ "com.amazonaws.sagemaker#DescribeExperimentResponse": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", "traits": { - "smithy.api#documentation": "

    When the experiment was created.

    " + "smithy.api#documentation": "

    Who created the experiment.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    When the experiment was last modified.

    " + "smithy.api#documentation": "

    The name of the experiment.

    " + } + }, + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the experiment.

    " } }, "DisplayName": { @@ -6570,6 +6613,18 @@ "smithy.api#documentation": "

    The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.

    " } }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    When the experiment was last modified.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    When the experiment was created.

    " + } + }, "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext", "traits": { @@ -6582,29 +6637,11 @@ "smithy.api#documentation": "

    The ARN of the source and, optionally, the type.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", - "traits": { - "smithy.api#documentation": "

    Who created the experiment.

    " - } - }, "Description": { "target": "com.amazonaws.sagemaker#ExperimentDescription", "traits": { "smithy.api#documentation": "

    The description of the experiment.

    " } - }, - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "

    The name of the experiment.

    " - } - }, - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the experiment.

    " - } } } }, @@ -6640,31 +6677,16 @@ "com.amazonaws.sagemaker#DescribeFlowDefinitionResponse": { "type": "structure", "members": { - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.

    ", - "smithy.api#required": {} - } - }, - "FlowDefinitionStatus": { - "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", - "traits": { - "smithy.api#documentation": "

    The status of the flow definition. Valid values are listed below.

    ", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The timestamp when the flow definition was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The reason your flow definition failed.

    " } }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", + "HumanLoopConfig": { + "target": "com.amazonaws.sagemaker#HumanLoopConfig", "traits": { - "smithy.api#documentation": "

    An object containing information about the output file.

    ", + "smithy.api#documentation": "

    An object containing information about who works on the task, the workforce task price, and other task details.

    ", "smithy.api#required": {} } }, @@ -6680,23 +6702,17 @@ "smithy.api#documentation": "

    Container for configuring the source of human task requests. Used to specify if\n Amazon Rekognition or Amazon Textract is used as an integration source.

    " } }, - "HumanLoopConfig": { - "target": "com.amazonaws.sagemaker#HumanLoopConfig", + "FlowDefinitionArn": { + "target": "com.amazonaws.sagemaker#FlowDefinitionArn", "traits": { - "smithy.api#documentation": "

    An object containing information about who works on the task, the workforce task price, and other task details.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the flow defintion.

    ", "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "

    The reason your flow definition failed.

    " - } - }, - "FlowDefinitionArn": { - "target": "com.amazonaws.sagemaker#FlowDefinitionArn", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the flow defintion.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.

    ", "smithy.api#required": {} } }, @@ -6706,9 +6722,30 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the flow definition.

    ", "smithy.api#required": {} } - } - } - }, + }, + "FlowDefinitionStatus": { + "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", + "traits": { + "smithy.api#documentation": "

    The status of the flow definition. Valid values are listed below.

    ", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#FlowDefinitionOutputConfig", + "traits": { + "smithy.api#documentation": "

    An object containing information about the output file.

    ", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp when the flow definition was created.

    ", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.sagemaker#DescribeHumanTaskUi": { "type": "operation", "input": { @@ -6748,23 +6785,16 @@ "smithy.api#required": {} } }, - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the human task user interface (worker task template).

    ", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "UiTemplate": { + "target": "com.amazonaws.sagemaker#UiTemplateInfo", "traits": { - "smithy.api#documentation": "

    The timestamp when the human task user interface was created.

    ", "smithy.api#required": {} } }, - "UiTemplate": { - "target": "com.amazonaws.sagemaker#UiTemplateInfo", + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the human task user interface (worker task template).

    ", "smithy.api#required": {} } }, @@ -6773,6 +6803,13 @@ "traits": { "smithy.api#documentation": "

    The status of the human task user interface (worker task template). Valid values are listed below.

    " } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp when the human task user interface was created.

    ", + "smithy.api#required": {} + } } } }, @@ -6808,36 +6845,38 @@ "com.amazonaws.sagemaker#DescribeHyperParameterTuningJobResponse": { "type": "structure", "members": { - "HyperParameterTuningJobConfig": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", + "HyperParameterTuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", "traits": { - "smithy.api#documentation": "

    The HyperParameterTuningJobConfig object that specifies the\n configuration of the tuning job.

    ", + "smithy.api#documentation": "

    The\n Amazon Resource Name (ARN) of the tuning job.

    ", "smithy.api#required": {} } }, - "OverallBestTrainingJob": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", + "TrainingJobDefinitions": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", "traits": { - "smithy.api#documentation": "

    If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective\n metric value of all training jobs launched by this tuning job and all parent jobs\n specified for the warm start tuning job.

    " + "smithy.api#documentation": "

    A list of the HyperParameterTrainingJobDefinition objects launched\n for this tuning job.

    " } }, - "TrainingJobStatusCounters": { - "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", "traits": { - "smithy.api#documentation": "

    The TrainingJobStatusCounters object that specifies the number of\n training jobs, categorized by status, that this tuning job launched.

    ", + "smithy.api#documentation": "

    The status of the tuning job: InProgress, Completed, Failed, Stopping, or\n Stopped.

    ", "smithy.api#required": {} } }, - "HyperParameterTuningEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "HyperParameterTuningJobConfig": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobConfig", "traits": { - "smithy.api#documentation": "

    The date and time that the tuning job ended.

    " + "smithy.api#documentation": "

    The HyperParameterTuningJobConfig object that specifies the\n configuration of the tuning job.

    ", + "smithy.api#required": {} } }, - "TrainingJobDefinition": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", + "TrainingJobStatusCounters": { + "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", "traits": { - "smithy.api#documentation": "

    The HyperParameterTrainingJobDefinition object that specifies the\n definition of the training jobs that this tuning job launches.

    " + "smithy.api#documentation": "

    The TrainingJobStatusCounters object that specifies the number of\n training jobs, categorized by status, that this tuning job launched.

    ", + "smithy.api#required": {} } }, "WarmStartConfig": { @@ -6846,31 +6885,35 @@ "smithy.api#documentation": "

    The configuration for starting the hyperparameter parameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.

    " } }, - "ObjectiveStatusCounters": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", + "BestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", "traits": { - "smithy.api#documentation": "

    The ObjectiveStatusCounters object that specifies the number of\n training jobs, categorized by the status of their final objective metric, that this\n tuning job launched.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A TrainingJobSummary object that describes the training job that\n completed with the best current HyperParameterTuningJobObjective.

    " } }, - "HyperParameterTuningJobStatus": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The status of the tuning job: InProgress, Completed, Failed, Stopping, or\n Stopped.

    ", + "smithy.api#documentation": "

    If the tuning job failed, the reason it failed.

    " + } + }, + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "traits": { + "smithy.api#documentation": "

    The name of the tuning job.

    ", "smithy.api#required": {} } }, - "TrainingJobDefinitions": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", + "OverallBestTrainingJob": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", "traits": { - "smithy.api#documentation": "

    A list of the HyperParameterTrainingJobDefinition objects launched\n for this tuning job.

    " + "smithy.api#documentation": "

    If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective\n metric value of all training jobs launched by this tuning job and all parent jobs\n specified for the warm start tuning job.

    " } }, - "CreationTime": { + "HyperParameterTuningEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time that the tuning job started.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The date and time that the tuning job ended.

    " } }, "LastModifiedTime": { @@ -6879,31 +6922,25 @@ "smithy.api#documentation": "

    The date and time that the status of the tuning job was modified.

    " } }, - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the tuning job.

    ", + "smithy.api#documentation": "

    The date and time that the tuning job started.

    ", "smithy.api#required": {} } }, - "BestTrainingJob": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", + "TrainingJobDefinition": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", "traits": { - "smithy.api#documentation": "

    A TrainingJobSummary object that describes the training job that\n completed with the best current HyperParameterTuningJobObjective.

    " + "smithy.api#documentation": "

    The HyperParameterTrainingJobDefinition object that specifies the\n definition of the training jobs that this tuning job launches.

    " } }, - "HyperParameterTuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", "traits": { - "smithy.api#documentation": "

    The\n Amazon Resource Name (ARN) of the tuning job.

    ", + "smithy.api#documentation": "

    The ObjectiveStatusCounters object that specifies the number of\n training jobs, categorized by the status of their final objective metric, that this\n tuning job launched.

    ", "smithy.api#required": {} } - }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "

    If the tuning job failed, the reason it failed.

    " - } } } }, @@ -6939,27 +6976,32 @@ "com.amazonaws.sagemaker#DescribeLabelingJobResponse": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", "traits": { - "smithy.api#documentation": "

    The date and time that the labeling job was last updated.

    ", + "smithy.api#documentation": "

    The name assigned to the labeling job when it was created.

    ", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The date and time that the labeling job was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of key/value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " } }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", + "OutputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", "traits": { - "smithy.api#documentation": "

    Input configuration information for the labeling job, such as the Amazon S3 location of the\n data objects and the location of the manifest file that describes the data\n objects.

    ", + "smithy.api#documentation": "

    The location of the job's output data and the AWS Key Management Service key ID for the key used to\n encrypt the output data, if any.

    ", "smithy.api#required": {} } }, + "LabelCategoryConfigS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

    The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:

    \n
      \n
    • \n

      Semantic segmentation labeling jobs using automated labeling: 20 labels

      \n
      • \n
    • \n

      Box bounding labeling jobs (all): 10 labels

      \n
      • \n
    \n

    The file is a JSON structure in the following format:

    \n

    \n {\n

    \n

    \n \"document-version\": \"2018-11-28\"\n

    \n

    \n \"labels\": [\n

    \n

    \n {\n

    \n

    \n \"label\": \"label 1\"\n

    \n

    \n },\n

    \n

    \n {\n

    \n

    \n \"label\": \"label 2\"\n

    \n

    \n },\n

    \n

    \n ...\n

    \n

    \n {\n

    \n

    \n \"label\": \"label n\"\n

    \n

    \n }\n

    \n

    \n ]\n

    \n

    \n }\n

    " + } + }, "HumanTaskConfig": { "target": "com.amazonaws.sagemaker#HumanTaskConfig", "traits": { @@ -6967,95 +7009,90 @@ "smithy.api#required": {} } }, - "StoppingConditions": { - "target": "com.amazonaws.sagemaker#LabelingJobStoppingConditions", - "traits": { - "smithy.api#documentation": "

    A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped.

    " - } - }, "LabelingJobAlgorithmsConfig": { "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig", "traits": { "smithy.api#documentation": "

    Configuration information for automated data labeling.

    " } }, - "LabelingJobStatus": { - "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "LabelAttributeName": { + "target": "com.amazonaws.sagemaker#LabelAttributeName", "traits": { - "smithy.api#documentation": "

    The processing status of the labeling job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The attribute used as the label in the output manifest file.

    " } }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", + "JobReferenceCode": { + "target": "com.amazonaws.sagemaker#JobReferenceCode", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the labeling job.

    ", + "smithy.api#documentation": "

    A unique identifier for work done as part of a labeling job.

    ", "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCounters", "traits": { - "smithy.api#documentation": "

    If the job failed, the reason that it failed.

    " + "smithy.api#documentation": "

    Provides a breakdown of the number of data objects labeled by humans, the number of\n objects labeled by machine, the number of objects than couldn't be labeled, and the\n total number of objects labeled.

    ", + "smithy.api#required": {} } }, - "LabelingJobName": { - "target": "com.amazonaws.sagemaker#LabelingJobName", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    The name assigned to the labeling job when it was created.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling.

    ", "smithy.api#required": {} } }, - "LabelCategoryConfigS3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", + "LabelingJobOutput": { + "target": "com.amazonaws.sagemaker#LabelingJobOutput", "traits": { - "smithy.api#documentation": "

    The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:

    \n
      \n
    • \n

      Semantic segmentation labeling jobs using automated labeling: 20 labels

      \n
      • \n
    • \n

      Box bounding labeling jobs (all): 10 labels

      \n
      • \n
    \n

    The file is a JSON structure in the following format:

    \n

    \n {\n

    \n

    \n \"document-version\": \"2018-11-28\"\n

    \n

    \n \"labels\": [\n

    \n

    \n {\n

    \n

    \n \"label\": \"label 1\"\n

    \n

    \n },\n

    \n

    \n {\n

    \n

    \n \"label\": \"label 2\"\n

    \n

    \n },\n

    \n

    \n ...\n

    \n

    \n {\n

    \n

    \n \"label\": \"label n\"\n

    \n

    \n }\n

    \n

    \n ]\n

    \n

    \n }\n

    " + "smithy.api#documentation": "

    The location of the output produced by the labeling job.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "LabelingJobStatus": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", "traits": { - "smithy.api#documentation": "

    An array of key/value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " + "smithy.api#documentation": "

    The processing status of the labeling job.

    ", + "smithy.api#required": {} } }, - "LabelingJobOutput": { - "target": "com.amazonaws.sagemaker#LabelingJobOutput", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The location of the output produced by the labeling job.

    " + "smithy.api#documentation": "

    The date and time that the labeling job was created.

    ", + "smithy.api#required": {} } }, - "LabelAttributeName": { - "target": "com.amazonaws.sagemaker#LabelAttributeName", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The attribute used as the label in the output manifest file.

    " + "smithy.api#documentation": "

    The date and time that the labeling job was last updated.

    ", + "smithy.api#required": {} } }, - "JobReferenceCode": { - "target": "com.amazonaws.sagemaker#JobReferenceCode", + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", "traits": { - "smithy.api#documentation": "

    A unique identifier for work done as part of a labeling job.

    ", + "smithy.api#documentation": "

    Input configuration information for the labeling job, such as the Amazon S3 location of the\n data objects and the location of the manifest file that describes the data\n objects.

    ", "smithy.api#required": {} } }, - "LabelCounters": { - "target": "com.amazonaws.sagemaker#LabelCounters", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    Provides a breakdown of the number of data objects labeled by humans, the number of\n objects labeled by machine, the number of objects than couldn't be labeled, and the\n total number of objects labeled.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the job failed, the reason that it failed.

    " } }, - "OutputConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { - "smithy.api#documentation": "

    The location of the job's output data and the AWS Key Management Service key ID for the key used to\n encrypt the output data, if any.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the labeling job.

    ", "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "StoppingConditions": { + "target": "com.amazonaws.sagemaker#LabelingJobStoppingConditions", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped.

    " } } } @@ -7087,19 +7124,19 @@ "com.amazonaws.sagemaker#DescribeModelOutput": { "type": "structure", "members": { - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", - "traits": { - "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that this model has access\n to. For more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n

    " - } - }, - "ModelArn": { - "target": "com.amazonaws.sagemaker#ModelArn", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model.

    ", + "smithy.api#documentation": "

    A timestamp that shows when the model was created.

    ", "smithy.api#required": {} } }, + "Containers": { + "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "traits": { + "smithy.api#documentation": "

    The containers in the inference pipeline.

    " + } + }, "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { @@ -7107,17 +7144,23 @@ "smithy.api#required": {} } }, - "Containers": { - "target": "com.amazonaws.sagemaker#ContainerDefinitionList", + "ModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", "traits": { - "smithy.api#documentation": "

    The containers in the inference pipeline.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model.

    ", + "smithy.api#required": {} } }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    Name of the Amazon SageMaker model.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If True, no inbound or outbound network calls can be made to or from the\n model container.

    " + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", + "traits": { + "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that this model has access\n to. For more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n

    " } }, "PrimaryContainer": { @@ -7126,18 +7169,12 @@ "smithy.api#documentation": "

    The location of the primary inference code, associated artifacts, and custom\n environment map that the inference code uses when it is deployed in production.\n

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the model was created.

    ", + "smithy.api#documentation": "

    Name of the Amazon SageMaker model.

    ", "smithy.api#required": {} } - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "

    If True, no inbound or outbound network calls can be made to or from the\n model container.

    " - } } } }, @@ -7168,31 +7205,30 @@ "com.amazonaws.sagemaker#DescribeModelPackageOutput": { "type": "structure", "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#EntityName", + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", "traits": { - "smithy.api#documentation": "

    The name of the model package being described.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A brief summary of the model package.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "CertifyForMarketplace": { + "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

    A timestamp specifying when the model package was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether the model package is certified for listing on AWS Marketplace.

    " } }, - "ModelPackageArn": { - "target": "com.amazonaws.sagemaker#ModelPackageArn", + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model package.

    ", + "smithy.api#documentation": "

    The current status of the model package.

    ", "smithy.api#required": {} } }, - "SourceAlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    Details about the algorithm that was used to create the model package.

    " + "smithy.api#documentation": "

    A timestamp specifying when the model package was created.

    ", + "smithy.api#required": {} } }, "ModelPackageStatusDetails": { @@ -7208,29 +7244,30 @@ "smithy.api#documentation": "

    Configurations for one or more transform jobs that Amazon SageMaker runs to test the model\n package.

    " } }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    A brief summary of the model package.

    " + "smithy.api#documentation": "

    The name of the model package being described.

    ", + "smithy.api#required": {} } }, - "CertifyForMarketplace": { - "target": "com.amazonaws.sagemaker#CertifyForMarketplace", + "InferenceSpecification": { + "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "

    Whether the model package is certified for listing on AWS Marketplace.

    " + "smithy.api#documentation": "

    Details about inference jobs that can be run with models based on this model\n package.

    " } }, - "ModelPackageStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "SourceAlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#SourceAlgorithmSpecification", "traits": { - "smithy.api#documentation": "

    The current status of the model package.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Details about the algorithm that was used to create the model package.

    " } }, - "InferenceSpecification": { - "target": "com.amazonaws.sagemaker#InferenceSpecification", + "ModelPackageArn": { + "target": "com.amazonaws.sagemaker#ModelPackageArn", "traits": { - "smithy.api#documentation": "

    Details about inference jobs that can be run with models based on this model\n package.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the model package.

    ", + "smithy.api#required": {} } } } @@ -7267,63 +7304,63 @@ "com.amazonaws.sagemaker#DescribeMonitoringScheduleResponse": { "type": "structure", "members": { - "MonitoringScheduleStatus": { - "target": "com.amazonaws.sagemaker#ScheduleStatus", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of an monitoring job.

    ", + "smithy.api#documentation": "

    The time at which the monitoring job was created.

    ", "smithy.api#required": {} } }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the endpoint for the monitoring job.

    " + "smithy.api#documentation": "

    The time at which the monitoring job was last modified.

    ", + "smithy.api#required": {} } }, - "LastMonitoringExecutionSummary": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    Describes metadata on the last execution to run, if there was one.

    " + "smithy.api#documentation": "

    A string, up to one KB in size, that contains the reason a monitoring job failed, if it\n failed.

    " } }, - "MonitoringScheduleConfig": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "

    The configuration object that specifies the monitoring schedule and defines the\n monitoring job.

    ", + "smithy.api#documentation": "

    Name of the monitoring schedule.

    ", "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", "traits": { - "smithy.api#documentation": "

    A string, up to one KB in size, that contains the reason a monitoring job failed, if it\n failed.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the monitoring schedule.

    ", + "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "LastMonitoringExecutionSummary": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSummary", "traits": { - "smithy.api#documentation": "

    The time at which the monitoring job was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Describes metadata on the last execution to run, if there was one.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { - "smithy.api#documentation": "

    The time at which the monitoring job was last modified.

    ", + "smithy.api#documentation": "

    The configuration object that specifies the monitoring schedule and defines the\n monitoring job.

    ", "smithy.api#required": {} } }, - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    Name of the monitoring schedule.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the endpoint for the monitoring job.

    " } }, - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "MonitoringScheduleStatus": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the monitoring schedule.

    ", + "smithy.api#documentation": "

    The status of an monitoring job.

    ", "smithy.api#required": {} } } @@ -7380,10 +7417,10 @@ "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput": { "type": "structure", "members": { - "OnStart": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "NotebookInstanceLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", "traits": { - "smithy.api#documentation": "

    The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    " } }, "LastModifiedTime": { @@ -7398,12 +7435,6 @@ "smithy.api#documentation": "

    A timestamp that tells when the lifecycle configuration was created.

    " } }, - "NotebookInstanceLifecycleConfigArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    " - } - }, "OnCreate": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", "traits": { @@ -7415,64 +7446,70 @@ "traits": { "smithy.api#documentation": "

    The name of the lifecycle configuration.

    " } + }, + "OnStart": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigList", + "traits": { + "smithy.api#documentation": "

    The shell script that runs every time you start a notebook instance, including when\n you create the notebook instance.

    " + } } } }, "com.amazonaws.sagemaker#DescribeNotebookInstanceOutput": { "type": "structure", "members": { - "RootAccess": { - "target": "com.amazonaws.sagemaker#RootAccess", + "Url": { + "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", "traits": { - "smithy.api#documentation": "

    Whether root access is enabled or disabled for users of the notebook instance.

    \n \n

    Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

    \n     " + "smithy.api#documentation": "

    The URL that you use to connect to the Jupyter notebook that is running in your\n notebook instance.

    " } }, - "NotebookInstanceName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "

    The name of the Amazon SageMaker notebook instance.

    " + "smithy.api#documentation": "

    A list of the Elastic Inference (EI) instance types associated with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in Amazon\n SageMaker.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "DirectInternetAccess": { + "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "

    A timestamp. Use this parameter to return the time when the notebook instance was\n created

    " + "smithy.api#documentation": "

    Describes whether Amazon SageMaker provides internet access to the notebook instance. If this\n value is set to Disabled, the notebook instance does not have\n internet access, and cannot connect to Amazon SageMaker training and endpoint services.

    \n

    For more information, see Notebook Instances Are Internet-Enabled by Default.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", + "SubnetId": { + "target": "com.amazonaws.sagemaker#SubnetId", "traits": { - "smithy.api#documentation": "

    A timestamp. Use this parameter to retrieve the time when the notebook instance was\n last modified.

    " + "smithy.api#documentation": "

    The ID of the VPC subnet.

    " } }, - "Url": { - "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The URL that you use to connect to the Jupyter notebook that is running in your\n notebook instance.

    " + "smithy.api#documentation": "

    If status is Failed, the reason it failed.

    " } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.sagemaker#NetworkInterfaceId", + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

    The network interface IDs that Amazon SageMaker created at the time of creating the instance.\n

    " + "smithy.api#documentation": "

    The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

    " } }, - "AcceleratorTypes": { - "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

    A list of the Elastic Inference (EI) instance types associated with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in Amazon\n SageMaker.

    " + "smithy.api#documentation": "

    An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

    " } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "NotebookInstanceStatus": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n

    " + "smithy.api#documentation": "

    The status of the notebook instance.

    " } }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", "traits": { - "smithy.api#documentation": "

    The size, in GB, of the ML storage volume attached to the notebook instance.

    " + "smithy.api#documentation": "

    The type of ML compute instance running on the notebook instance.

    " } }, "NotebookInstanceLifecycleConfigName": { @@ -7481,40 +7518,16 @@ "smithy.api#documentation": "

    Returns the name of a notebook instance lifecycle configuration.

    \n

    For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance\n

    " } }, - "DirectInternetAccess": { - "target": "com.amazonaws.sagemaker#DirectInternetAccess", - "traits": { - "smithy.api#documentation": "

    Describes whether Amazon SageMaker provides internet access to the notebook instance. If this\n value is set to Disabled, the notebook instance does not have\n internet access, and cannot connect to Amazon SageMaker training and endpoint services.

    \n

    For more information, see Notebook Instances Are Internet-Enabled by Default.

    " - } - }, - "NotebookInstanceArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the notebook instance.

    " - } - }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { "smithy.api#documentation": "

    The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

    " } }, - "SubnetId": { - "target": "com.amazonaws.sagemaker#SubnetId", - "traits": { - "smithy.api#documentation": "

    The ID of the VPC subnet.

    " - } - }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", - "traits": { - "smithy.api#documentation": "

    An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

    " - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

    The type of ML compute instance running on the notebook instance.

    " + "smithy.api#documentation": "

    The size, in GB, of the ML storage volume attached to the notebook instance.

    " } }, "SecurityGroups": { @@ -7523,22 +7536,46 @@ "smithy.api#documentation": "

    The IDs of the VPC security groups.

    " } }, - "DefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n

    " } }, - "NotebookInstanceStatus": { - "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "NetworkInterfaceId": { + "target": "com.amazonaws.sagemaker#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "

    The status of the notebook instance.

    " + "smithy.api#documentation": "

    The network interface IDs that Amazon SageMaker created at the time of creating the instance.\n

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", "traits": { - "smithy.api#documentation": "

    If status is Failed, the reason it failed.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the notebook instance.

    " + } + }, + "NotebookInstanceName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceName", + "traits": { + "smithy.api#documentation": "

    The name of the Amazon SageMaker notebook instance.

    " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "

    A timestamp. Use this parameter to retrieve the time when the notebook instance was\n last modified.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

    A timestamp. Use this parameter to return the time when the notebook instance was\n created

    " + } + }, + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", + "traits": { + "smithy.api#documentation": "

    Whether root access is enabled or disabled for users of the notebook instance.

    \n \n

    Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

    \n     " } } } @@ -7575,41 +7612,29 @@ "com.amazonaws.sagemaker#DescribeProcessingJobResponse": { "type": "structure", "members": { - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#documentation": "

    The ARN of a monitoring schedule for an endpoint associated with this processing\n job.

    " - } - }, - "ProcessingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The time at which the processing job started.

    " - } - }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig", + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", "traits": { - "smithy.api#documentation": "

    The configuration information used to create an experiment.

    " + "smithy.api#documentation": "

    The ARN of a training job associated with this processing job.

    " } }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification", "traits": { - "smithy.api#documentation": "

    The time limit for how long the processing job is allowed to run.

    " + "smithy.api#documentation": "

    Configures the processing job to run a specified container image.

    ", + "smithy.api#required": {} } }, - "ProcessingResources": { - "target": "com.amazonaws.sagemaker#ProcessingResources", + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", "traits": { - "smithy.api#documentation": "

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The environment variables set in the Docker container.

    " } }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#NetworkConfig", + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig", "traits": { - "smithy.api#documentation": "

    Networking options for a processing job.

    " + "smithy.api#documentation": "

    The configuration information used to create an experiment.

    " } }, "AutoMLJobArn": { @@ -7624,28 +7649,28 @@ "smithy.api#documentation": "

    A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.

    " } }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", "traits": { - "smithy.api#documentation": "

    The ARN of a training job associated with this processing job.

    " + "smithy.api#documentation": "

    The ARN of a monitoring schedule for an endpoint associated with this processing\n job.

    " } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.

    " + "smithy.api#documentation": "

    Output configuration for the processing job.

    " } }, - "ProcessingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", "traits": { - "smithy.api#documentation": "

    The time at which the processing job completed.

    " + "smithy.api#documentation": "

    Networking options for a processing job.

    " } }, - "ProcessingInputs": { - "target": "com.amazonaws.sagemaker#ProcessingInputs", + "ProcessingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The inputs for a processing job.

    " + "smithy.api#documentation": "

    The time at which the processing job started.

    " } }, "ProcessingJobName": { @@ -7655,11 +7680,10 @@ "smithy.api#required": {} } }, - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the processing job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The time at which the processing job completed.

    " } }, "ExitMessage": { @@ -7668,43 +7692,56 @@ "smithy.api#documentation": "

    An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.

    " } }, - "ProcessingJobStatus": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    Provides the status of a processing job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on\n your behalf.

    " } }, - "AppSpecification": { - "target": "com.amazonaws.sagemaker#AppSpecification", + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", "traits": { - "smithy.api#documentation": "

    Configures the processing job to run a specified container image.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the processing job.

    ", "smithy.api#required": {} } }, - "ProcessingOutputConfig": { - "target": "com.amazonaws.sagemaker#ProcessingOutputConfig", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Output configuration for the processing job.

    " + "smithy.api#documentation": "

    The time at which the processing job was created.

    ", + "smithy.api#required": {} } }, - "CreationTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The time at which the processing job was created.

    ", + "smithy.api#documentation": "

    The time at which the processing job was last modified.

    " + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#documentation": "

    Provides the status of a processing job.

    ", "smithy.api#required": {} } }, - "Environment": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition", "traits": { - "smithy.api#documentation": "

    The environment variables set in the Docker container.

    " + "smithy.api#documentation": "

    The time limit for how long the processing job is allowed to run.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources", "traits": { - "smithy.api#documentation": "

    The time at which the processing job was last modified.

    " + "smithy.api#documentation": "

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n processing job. In distributed training, you specify more than one instance.

    ", + "smithy.api#required": {} + } + }, + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", + "traits": { + "smithy.api#documentation": "

    The inputs for a processing job.

    " } } } @@ -7777,56 +7814,75 @@ "com.amazonaws.sagemaker#DescribeTrainingJobResponse": { "type": "structure", "members": { - "TensorBoardOutputConfig": { - "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithms in\n distributed training.

    " + } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

    If the training job failed, the reason it failed.

    " + "smithy.api#documentation": "

    The status of the\n training\n job.

    \n

    Amazon SageMaker provides the following training job statuses:

    \n
      \n
    • \n

      \n InProgress - The training is in progress.

      \n
      • \n
    • \n

      \n Completed - The training job has completed.

      \n
      • \n
    • \n

      \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

      \n
      • \n
    • \n

      \n Stopping - The training job is stopping.

      \n
      • \n
    • \n

      \n Stopped - The training job has stopped.

      \n
      • \n
    \n

    For\n more detailed information, see SecondaryStatus.

    ", + "smithy.api#required": {} } }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", + "BillableTimeInSeconds": { + "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.

    " + "smithy.api#documentation": "

    The billable time in seconds.

    \n

    You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.

    " } }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", "traits": { - "smithy.api#documentation": "

    If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

    " + "smithy.api#documentation": "

    Configuration information for debugging rules.

    " } }, - "TrainingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "TuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", "traits": { - "smithy.api#documentation": "

    Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.

    " } }, - "CheckpointConfig": { - "target": "com.amazonaws.sagemaker#CheckpointConfig" + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the training job.

    ", + "smithy.api#required": {} + } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

    A timestamp that indicates when the training job was created.

    ", + "smithy.api#documentation": "

    Specifies a limit to how long a model training job can run. It also specifies the\n maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends\n the training job. Use this API to cap model training costs.

    \n

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

    ", "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "SecondaryStatusTransitions": { + "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", "traits": { - "smithy.api#documentation": "

    A timestamp that indicates when the status of the training job was last\n modified.

    " + "smithy.api#documentation": "

    A history of all of the secondary statuses that the training job has transitioned\n through.

    " } }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    Resources, including ML compute instances and ML storage volumes, that are\n configured for model training.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A Boolean indicating whether managed spot training is enabled (True) or\n not (False).

    " } }, + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", + "traits": { + "smithy.api#documentation": "

    An array of Channel objects that describes each data input channel.\n

    " + } + }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig" + }, "FinalMetricDataList": { "target": "com.amazonaws.sagemaker#FinalMetricDataList", "traits": { @@ -7840,142 +7896,123 @@ "smithy.api#required": {} } }, - "SecondaryStatus": { - "target": "com.amazonaws.sagemaker#SecondaryStatus", + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "

    Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.

    \n

    Amazon SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

    \n
    \n
    InProgress
    \n
    \n
      \n
    • \n

      \n Starting\n - Starting the training job.

      \n
      • \n
    • \n

      \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

      \n
      • \n
    • \n

      \n Training - Training is in progress.

      \n
      • \n
    • \n

      \n Interrupted - The job stopped because the managed\n spot training instances were interrupted.

      \n
      • \n
    • \n

      \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

      \n
      • \n
    \n
    \n
    Completed
    \n
    \n
      \n
    • \n

      \n Completed - The training job has completed.

      \n
      • \n
    \n
    \n
    Failed
    \n
    \n
      \n
    • \n

      \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

      \n
      • \n
    \n
    \n
    Stopped
    \n
    \n
      \n
    • \n

      \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

      \n
      • \n
    • \n

      \n MaxWaitTmeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.

      \n
      • \n
    • \n

      \n Stopped - The training job has stopped.

      \n
      • \n
    \n
    \n
    Stopping
    \n
    \n
      \n
    • \n

      \n Stopping - Stopping the training job.

      \n
      • \n
    \n
    \n
    \n \n \n

    Valid values for SecondaryStatus are subject to change.

    \n     \n

    We no longer support the following secondary statuses:

    \n
      \n
    • \n

      \n LaunchingMLInstances\n

      \n
      • \n
    • \n

      \n PreparingTrainingStack\n

      \n
      • \n
    • \n

      \n DownloadingTrainingImage\n

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Algorithm-specific parameters.

    " } }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#InputDataConfig", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    An array of Channel objects that describes each data input channel.\n

    " + "smithy.api#documentation": "

    If the training job failed, the reason it failed.

    " } }, - "BillableTimeInSeconds": { - "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { - "smithy.api#documentation": "

    The billable time in seconds.

    \n

    You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.

    " } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) role configured for the training job.

    " + "smithy.api#documentation": "

    Indicates the time when the training job starts on training instances. You are\n billed for the time interval between this time and the value of\n TrainingEndTime. The start time in CloudWatch Logs might be later than this time.\n The difference is due to the time it takes to download the training data and to the size\n of the training container.

    " } }, - "ModelArtifacts": { - "target": "com.amazonaws.sagemaker#ModelArtifacts", + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

    Information about the Amazon S3 location that is configured for storing model artifacts.\n

    ", + "smithy.api#documentation": "

    Information about the algorithm used for training, and algorithm metadata.\n

    ", "smithy.api#required": {} } }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Specifies a limit to how long a model training job can run. It also specifies the\n maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends\n the training job. Use this API to cap model training costs.

    \n

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " } }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "TuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.

    " + "smithy.api#documentation": "

    A timestamp that indicates when the status of the training job was last\n modified.

    " } }, - "DebugRuleConfigurations": { - "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Configuration information for debugging rules.

    " + "smithy.api#documentation": "

    A timestamp that indicates when the training job was created.

    ", + "smithy.api#required": {} } }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "DebugRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an AutoML job.

    " + "smithy.api#documentation": "

    Status about the debug rule evaluation.

    " } }, - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", "traits": { - "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithms in\n distributed training.

    " + "smithy.api#documentation": "

    Information about the Amazon S3 location that is configured for storing model artifacts.\n

    ", + "smithy.api#required": {} } }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that this training job has\n access to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

    " + "smithy.api#documentation": "

    The S3 path where model artifacts that you configured when creating the job are\n stored. Amazon SageMaker creates subfolders for model artifacts.

    " } }, - "TrainingJobStatus": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, + "TrainingTimeInSeconds": { + "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", "traits": { - "smithy.api#documentation": "

    The status of the\n training\n job.

    \n

    Amazon SageMaker provides the following training job statuses:

    \n
      \n
    • \n

      \n InProgress - The training is in progress.

      \n
      • \n
    • \n

      \n Completed - The training job has completed.

      \n
      • \n
    • \n

      \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

      \n
      • \n
    • \n

      \n Stopping - The training job is stopping.

      \n
      • \n
    • \n

      \n Stopped - The training job has stopped.

      \n
      • \n
    \n

    For\n more detailed information, see SecondaryStatus.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The training time in seconds.

    " } }, - "SecondaryStatusTransitions": { - "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    A history of all of the secondary statuses that the training job has transitioned\n through.

    " + "smithy.api#documentation": "

    If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

    " } }, - "EnableManagedSpotTraining": { - "target": "com.amazonaws.sagemaker#Boolean", + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "

    A Boolean indicating whether managed spot training is enabled (True) or\n not (False).

    " + "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that this training job has\n access to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

    " } }, "DebugHookConfig": { "target": "com.amazonaws.sagemaker#DebugHookConfig" }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#OutputDataConfig", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    The S3 path where model artifacts that you configured when creating the job are\n stored. Amazon SageMaker creates subfolders for model artifacts.

    " + "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) role configured for the training job.

    " } }, - "AlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "SecondaryStatus": { + "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { - "smithy.api#documentation": "

    Information about the algorithm used for training, and algorithm metadata.\n

    ", + "smithy.api#documentation": "

    Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.

    \n

    Amazon SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

    \n
    \n
    InProgress
    \n
    \n
      \n
    • \n

      \n Starting\n - Starting the training job.

      \n
      • \n
    • \n

      \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

      \n
      • \n
    • \n

      \n Training - Training is in progress.

      \n
      • \n
    • \n

      \n Interrupted - The job stopped because the managed\n spot training instances were interrupted.

      \n
      • \n
    • \n

      \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

      \n
      • \n
    \n
    \n
    Completed
    \n
    \n
      \n
    • \n

      \n Completed - The training job has completed.

      \n
      • \n
    \n
    \n
    Failed
    \n
    \n
      \n
    • \n

      \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

      \n
      • \n
    \n
    \n
    Stopped
    \n
    \n
      \n
    • \n

      \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

      \n
      • \n
    • \n

      \n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.

      \n
      • \n
    • \n

      \n Stopped - The training job has stopped.

      \n
      • \n
    \n
    \n
    Stopping
    \n
    \n
      \n
    • \n

      \n Stopping - Stopping the training job.

      \n
      • \n
    \n
    \n
    \n \n \n

    Valid values for SecondaryStatus are subject to change.

    \n     \n

    We no longer support the following secondary statuses:

    \n
      \n
    • \n

      \n LaunchingMLInstances\n

      \n
      • \n
    • \n

      \n PreparingTrainingStack\n

      \n
      • \n
    • \n

      \n DownloadingTrainingImage\n

      \n
      • \n
    ", "smithy.api#required": {} } }, - "TrainingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    Indicates the time when the training job starts on training instances. You are\n billed for the time interval between this time and the value of\n TrainingEndTime. The start time in CloudWatch Logs might be later than this time.\n The difference is due to the time it takes to download the training data and to the size\n of the training container.

    " - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the training job.

    ", + "smithy.api#documentation": "

    Resources, including ML compute instances and ML storage volumes, that are\n configured for model training.

    ", "smithy.api#required": {} } }, - "TrainingTimeInSeconds": { - "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", - "traits": { - "smithy.api#documentation": "

    The training time in seconds.

    " - } - }, - "DebugRuleEvaluationStatuses": { - "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", - "traits": { - "smithy.api#documentation": "

    Status about the debug rule evaluation.

    " - } - }, - "HyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "

    Algorithm-specific parameters.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an AutoML job.

    " } } } @@ -8012,18 +8049,10 @@ "com.amazonaws.sagemaker#DescribeTransformJobResponse": { "type": "structure", "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", - "traits": { - "smithy.api#documentation": "

    The name of the model used in the transform job.

    ", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the transform Job was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AutoML transform job.

    " } }, "BatchStrategy": { @@ -8032,10 +8061,10 @@ "smithy.api#documentation": "

    Specifies the number of records to include in a mini-batch for an HTTP inference\n request.\n A record\n is a single unit of input data that inference\n can be made on. For example, a single line in a CSV file is a record.

    \n

    To enable the batch strategy, you must set SplitType\n to\n Line, RecordIO, or\n TFRecord.

    " } }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.

    " + "smithy.api#documentation": "

    If the transform job failed, FailureReason describes\n why\n it failed. A transform job creates a log file, which includes error\n messages, and stores it\n as\n an Amazon S3 object. For more information, see Log Amazon SageMaker Events with\n Amazon CloudWatch.

    " } }, "TransformJobName": { @@ -8045,92 +8074,100 @@ "smithy.api#required": {} } }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "MaxPayloadInMB": { - "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", "traits": { - "smithy.api#documentation": "

    The\n maximum\n payload size, in MB, used in the\n transform job.

    " + "smithy.api#documentation": "

    The\n status of the transform job. If the transform job failed, the reason\n is returned in the FailureReason field.

    ", + "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "ModelClientConfig": { + "target": "com.amazonaws.sagemaker#ModelClientConfig", "traits": { - "smithy.api#documentation": "

    If the transform job failed, FailureReason describes\n why\n it failed. A transform job creates a log file, which includes error\n messages, and stores it\n as\n an Amazon S3 object. For more information, see Log Amazon SageMaker Events with\n Amazon CloudWatch.

    " + "smithy.api#documentation": "

    The timeout and maximum number of retries for processing a transform job\n invocation.

    " } }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AutoML transform job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.

    " } }, - "TransformJobStatus": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The\n status of the transform job. If the transform job failed, the reason\n is returned in the FailureReason field.

    ", + "smithy.api#documentation": "

    A timestamp that shows when the transform Job was created.

    ", "smithy.api#required": {} } }, - "TransformEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", "traits": { - "smithy.api#documentation": "

    Indicates when the transform job has been\n \n completed, or has stopped or failed. You are billed for the time\n interval between this time and the value of TransformStartTime.

    " + "smithy.api#documentation": "

    Describes\n the resources, including ML instance types and ML instance count, to\n use for the transform job.

    ", + "smithy.api#required": {} } }, - "DataProcessing": { - "target": "com.amazonaws.sagemaker#DataProcessing" + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the transform job.

    ", + "smithy.api#required": {} + } }, - "MaxConcurrentTransforms": { - "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", "traits": { - "smithy.api#documentation": "

    The\n maximum number\n of\n parallel requests on each instance node\n that can be launched in a transform job. The default value is 1.

    " + "smithy.api#documentation": "

    The\n environment variables to set in the Docker container. We support up to 16 key and values\n entries in the map.

    " } }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources", + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", "traits": { - "smithy.api#documentation": "

    Describes\n the resources, including ML instance types and ML instance count, to\n use for the transform job.

    ", + "smithy.api#documentation": "

    Describes the dataset to be transformed and the Amazon S3 location where it is\n stored.

    ", "smithy.api#required": {} } }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput", + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "traits": { + "smithy.api#documentation": "

    The\n maximum\n payload size, in MB, used in the\n transform job.

    " + } + }, + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", "traits": { - "smithy.api#documentation": "

    Describes the dataset to be transformed and the Amazon S3 location where it is\n stored.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.

    " } }, - "TransformStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", "traits": { - "smithy.api#documentation": "

    Indicates when the transform job starts\n on\n ML instances. You are billed for the time interval between this time\n and the value of TransformEndTime.

    " + "smithy.api#documentation": "

    The\n maximum number\n of\n parallel requests on each instance node\n that can be launched in a transform job. The default value is 1.

    " } }, - "TransformJobArn": { - "target": "com.amazonaws.sagemaker#TransformJobArn", + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the transform job.

    ", + "smithy.api#documentation": "

    The name of the model used in the transform job.

    ", "smithy.api#required": {} } }, - "ModelClientConfig": { - "target": "com.amazonaws.sagemaker#ModelClientConfig", + "TransformStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The timeout and maximum number of retries for processing a transform job invocation.

    " + "smithy.api#documentation": "

    Indicates when the transform job starts\n on\n ML instances. You are billed for the time interval between this time\n and the value of TransformEndTime.

    " } }, - "Environment": { - "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", - "traits": { - "smithy.api#documentation": "

    The\n environment variables to set in the Docker container. We support up to 16 key and values\n entries in the map.

    " - } + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing" }, - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput", + "TransformEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.

    " + "smithy.api#documentation": "

    Indicates when the transform job has been\n \n completed, or has stopped or failed. You are billed for the time\n interval between this time and the value of TransformStartTime.

    " } } } @@ -8184,16 +8221,10 @@ "com.amazonaws.sagemaker#DescribeTrialComponentResponse": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    When the component started.

    " - } - }, - "Metrics": { - "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", "traits": { - "smithy.api#documentation": "

    The metrics for the component.

    " + "smithy.api#documentation": "

    Who created the component.

    " } }, "Parameters": { @@ -8202,52 +8233,58 @@ "smithy.api#documentation": "

    The hyperparameters of the component.

    " } }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialComponentSource", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    " + } + }, "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext", "traits": { "smithy.api#documentation": "

    Who last modified the component.

    " } }, - "Source": { - "target": "com.amazonaws.sagemaker#TrialComponentSource", + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial component.

    " } }, - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", "traits": { - "smithy.api#documentation": "

    The name of the trial component.

    " + "smithy.api#documentation": "

    The output artifacts of the component.

    " } }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", "traits": { - "smithy.api#documentation": "

    When the component ended.

    " + "smithy.api#documentation": "

    The status of the component. States include:

    \n
      \n
    • \n

      InProgress

      \n
      • \n
    • \n

      Completed

      \n
      • \n
    • \n

      Failed

      \n
      • \n
    " } }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The input artifacts of the component.

    " + "smithy.api#documentation": "

    The name of the trial component.

    " } }, - "OutputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "Metrics": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", "traits": { - "smithy.api#documentation": "

    The output artifacts of the component.

    " + "smithy.api#documentation": "

    The metrics for the component.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Who created the component.

    " + "smithy.api#documentation": "

    When the component was created.

    " } }, - "Status": { - "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of the component. States include:

    \n
      \n
    • \n

      InProgress

      \n
      • \n
    • \n

      Completed

      \n
      • \n
    • \n

      Failed

      \n
      • \n
    " + "smithy.api#documentation": "

    When the component was last modified.

    " } }, "DisplayName": { @@ -8256,22 +8293,22 @@ "smithy.api#documentation": "

    The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

    " } }, - "LastModifiedTime": { + "EndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    When the component was last modified.

    " + "smithy.api#documentation": "

    When the component ended.

    " } }, - "CreationTime": { + "StartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    When the component was created.

    " + "smithy.api#documentation": "

    When the component started.

    " } }, - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial component.

    " + "smithy.api#documentation": "

    The input artifacts of the component.

    " } } } @@ -8291,58 +8328,58 @@ "com.amazonaws.sagemaker#DescribeTrialResponse": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", "traits": { - "smithy.api#documentation": "

    When the trial was last modified.

    " + "smithy.api#documentation": "

    Who created the trial.

    " } }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "Source": { + "target": "com.amazonaws.sagemaker#TrialSource", "traits": { - "smithy.api#documentation": "

    The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    " } }, - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial.

    " + "smithy.api#documentation": "

    Who last modified the trial.

    " } }, - "CreationTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    When the trial was created.

    " + "smithy.api#documentation": "

    When the trial was last modified.

    " } }, - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the experiment the trial is part of.

    " + "smithy.api#documentation": "

    When the trial was created.

    " } }, - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", "traits": { - "smithy.api#documentation": "

    The name of the trial.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    Who created the trial.

    " + "smithy.api#documentation": "

    The name of the experiment the trial is part of.

    " } }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext", + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    Who last modified the trial.

    " + "smithy.api#documentation": "

    The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

    " } }, - "Source": { - "target": "com.amazonaws.sagemaker#TrialSource", + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source and, optionally, the job type.

    " + "smithy.api#documentation": "

    The name of the trial.

    " } } } @@ -8367,17 +8404,17 @@ "com.amazonaws.sagemaker#DescribeUserProfileRequest": { "type": "structure", "members": { - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", "traits": { - "smithy.api#documentation": "

    The user profile name.

    ", + "smithy.api#documentation": "

    The domain ID.

    ", "smithy.api#required": {} } }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

    The domain ID.

    ", + "smithy.api#documentation": "

    The user profile name.

    ", "smithy.api#required": {} } } @@ -8386,16 +8423,16 @@ "com.amazonaws.sagemaker#DescribeUserProfileResponse": { "type": "structure", "members": { - "UserProfileArn": { - "target": "com.amazonaws.sagemaker#UserProfileArn", + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", "traits": { - "smithy.api#documentation": "

    The user profile Amazon Resource Name (ARN).

    " + "smithy.api#documentation": "

    The ID of the domain that contains the profile.

    " } }, - "SingleSignOnUserValue": { - "target": "com.amazonaws.sagemaker#String256", + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

    The SSO user value.

    " + "smithy.api#documentation": "

    The user profile name.

    " } }, "HomeEfsFileSystemUid": { @@ -8404,16 +8441,16 @@ "smithy.api#documentation": "

    The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    The failure reason.

    " + "smithy.api#documentation": "

    The creation time.

    " } }, - "UserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "

    A collection of settings.

    " + "smithy.api#documentation": "

    The last modified time.

    " } }, "SingleSignOnUserIdentifier": { @@ -8422,10 +8459,10 @@ "smithy.api#documentation": "

    The SSO user identifier.

    " } }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", + "SingleSignOnUserValue": { + "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "

    The ID of the domain that contains the profile.

    " + "smithy.api#documentation": "

    The SSO user value.

    " } }, "Status": { @@ -8434,22 +8471,22 @@ "smithy.api#documentation": "

    The status.

    " } }, - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The user profile name.

    " + "smithy.api#documentation": "

    The failure reason.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", + "UserProfileArn": { + "target": "com.amazonaws.sagemaker#UserProfileArn", "traits": { - "smithy.api#documentation": "

    The last modified time.

    " + "smithy.api#documentation": "

    The user profile Amazon Resource Name (ARN).

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", "traits": { - "smithy.api#documentation": "

    The creation time.

    " + "smithy.api#documentation": "

    A collection of settings.

    " } } } @@ -8529,13 +8566,6 @@ "com.amazonaws.sagemaker#DesiredWeightAndCapacity": { "type": "structure", "members": { - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", - "traits": { - "smithy.api#documentation": "

    The name of the\n variant\n to update.

    ", - "smithy.api#required": {} - } - }, "DesiredInstanceCount": { "target": "com.amazonaws.sagemaker#TaskCount", "traits": { @@ -8547,6 +8577,13 @@ "traits": { "smithy.api#documentation": "

    The variant's weight.

    " } + }, + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

    The name of the\n variant\n to update.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -8677,36 +8714,36 @@ "com.amazonaws.sagemaker#DisassociateTrialComponentRequest": { "type": "structure", "members": { - "TrialName": { + "TrialComponentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the trial to disassociate from.

    ", + "smithy.api#documentation": "

    The name of the component to disassociate from the trial.

    ", "smithy.api#required": {} } }, - "TrialComponentName": { + "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the component to disassociate from the trial.

    ", + "smithy.api#documentation": "

    The name of the trial to disassociate from.

    ", "smithy.api#required": {} } } - } - }, - "com.amazonaws.sagemaker#DisassociateTrialComponentResponse": { - "type": "structure", - "members": { - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", - "traits": { - "smithy.api#documentation": "

    The ARN of the trial component.

    " - } - }, + } + }, + "com.amazonaws.sagemaker#DisassociateTrialComponentResponse": { + "type": "structure", + "members": { "TrialArn": { "target": "com.amazonaws.sagemaker#TrialArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial.

    " } + }, + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the trial component.

    " + } } } }, @@ -8732,16 +8769,10 @@ "com.amazonaws.sagemaker#DomainDetails": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.sagemaker#DomainName", - "traits": { - "smithy.api#documentation": "

    The domain name.

    " - } - }, - "DomainId": { - "target": "com.amazonaws.sagemaker#DomainId", + "Url": { + "target": "com.amazonaws.sagemaker#String1024", "traits": { - "smithy.api#documentation": "

    The domain ID.

    " + "smithy.api#documentation": "

    The domain's URL.

    " } }, "Status": { @@ -8750,10 +8781,10 @@ "smithy.api#documentation": "

    The status.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "DomainArn": { + "target": "com.amazonaws.sagemaker#DomainArn", "traits": { - "smithy.api#documentation": "

    The creation time.

    " + "smithy.api#documentation": "

    The domain's Amazon Resource Name (ARN).

    " } }, "LastModifiedTime": { @@ -8762,16 +8793,22 @@ "smithy.api#documentation": "

    The last modified time.

    " } }, - "Url": { - "target": "com.amazonaws.sagemaker#String1024", + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    The domain's URL.

    " + "smithy.api#documentation": "

    The creation time.

    " } }, - "DomainArn": { - "target": "com.amazonaws.sagemaker#DomainArn", + "DomainName": { + "target": "com.amazonaws.sagemaker#DomainName", "traits": { - "smithy.api#documentation": "

    The domain's Amazon Resource Name (ARN).

    " + "smithy.api#documentation": "

    The domain name.

    " + } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#DomainId", + "traits": { + "smithy.api#documentation": "

    The domain ID.

    " } } }, @@ -8904,10 +8941,10 @@ "com.amazonaws.sagemaker#EndpointConfigSummary": { "type": "structure", "members": { - "EndpointConfigName": { - "target": "com.amazonaws.sagemaker#EndpointConfigName", + "EndpointConfigArn": { + "target": "com.amazonaws.sagemaker#EndpointConfigArn", "traits": { - "smithy.api#documentation": "

    The name of the endpoint configuration.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint configuration.

    ", "smithy.api#required": {} } }, @@ -8918,10 +8955,10 @@ "smithy.api#required": {} } }, - "EndpointConfigArn": { - "target": "com.amazonaws.sagemaker#EndpointConfigArn", + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint configuration.

    ", + "smithy.api#documentation": "

    The name of the endpoint configuration.

    ", "smithy.api#required": {} } } @@ -8939,17 +8976,18 @@ "com.amazonaws.sagemaker#EndpointInput": { "type": "structure", "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "

    An endpoint in customer's account which has enabled DataCaptureConfig\n enabled.

    ", + "smithy.api#documentation": "

    Path to the filesystem where the endpoint data is available to the container.

    ", "smithy.api#required": {} } }, - "S3InputMode": { - "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    Whether the Pipe or File is used as the input mode for\n transfering data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.

    " + "smithy.api#documentation": "

    An endpoint in customer's account which has enabled DataCaptureConfig\n enabled.

    ", + "smithy.api#required": {} } }, "S3DataDistributionType": { @@ -8958,11 +8996,10 @@ "smithy.api#documentation": "

    Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.\n Defauts to FullyReplicated\n

    " } }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "S3InputMode": { + "target": "com.amazonaws.sagemaker#ProcessingS3InputMode", "traits": { - "smithy.api#documentation": "

    Path to the filesystem where the endpoint data is available to the container.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether the Pipe or File is used as the input mode for\n transfering data for the monitoring job. Pipe mode is recommended for large\n datasets. File mode is useful for small files that fit in memory. Defaults to\n File.

    " } } }, @@ -9051,38 +9088,38 @@ "com.amazonaws.sagemaker#EndpointSummary": { "type": "structure", "members": { - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "EndpointArn": { + "target": "com.amazonaws.sagemaker#EndpointArn", "traits": { - "smithy.api#documentation": "

    The name of the endpoint.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint.

    ", "smithy.api#required": {} } }, - "EndpointStatus": { - "target": "com.amazonaws.sagemaker#EndpointStatus", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of the endpoint.

    \n
      \n
    • \n

      \n OutOfService: Endpoint is not available to take incoming\n requests.

      \n
      • \n
    • \n

      \n Creating: CreateEndpoint is executing.

      \n
      • \n
    • \n

      \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      \n
      • \n
    • \n

      \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

      \n
      • \n
    • \n

      \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

      \n
      • \n
    • \n

      \n InService: Endpoint is available to process incoming\n requests.

      \n
      • \n
    • \n

      \n Deleting: DeleteEndpoint is executing.

      \n
      • \n
    • \n

      \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

      \n
      • \n
    \n

    To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

    ", + "smithy.api#documentation": "

    A timestamp that shows when the endpoint was last modified.

    ", "smithy.api#required": {} } }, - "EndpointArn": { - "target": "com.amazonaws.sagemaker#EndpointArn", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the endpoint.

    ", + "smithy.api#documentation": "

    A timestamp that shows when the endpoint was created.

    ", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "EndpointStatus": { + "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the endpoint was created.

    ", + "smithy.api#documentation": "

    The status of the endpoint.

    \n
      \n
    • \n

      \n OutOfService: Endpoint is not available to take incoming\n requests.

      \n
      • \n
    • \n

      \n Creating: CreateEndpoint is executing.

      \n
      • \n
    • \n

      \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      \n
      • \n
    • \n

      \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

      \n
      • \n
    • \n

      \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

      \n
      • \n
    • \n

      \n InService: Endpoint is available to process incoming\n requests.

      \n
      • \n
    • \n

      \n Deleting: DeleteEndpoint is executing.

      \n
      • \n
    • \n

      \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

      \n
      • \n
    \n

    To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

    ", "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the endpoint was last modified.

    ", + "smithy.api#documentation": "

    The name of the endpoint.

    ", "smithy.api#required": {} } } @@ -9200,25 +9237,13 @@ "com.amazonaws.sagemaker#Experiment": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", - "traits": { - "smithy.api#documentation": "

    The list of tags that are associated with the experiment. You can use Search API to search on the tags.

    " - } - }, - "Source": { - "target": "com.amazonaws.sagemaker#ExperimentSource" - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, "Description": { "target": "com.amazonaws.sagemaker#ExperimentDescription", "traits": { "smithy.api#documentation": "

    The description of the experiment.

    " } }, - "CreatedBy": { + "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" }, "ExperimentName": { @@ -9227,16 +9252,16 @@ "smithy.api#documentation": "

    The name of the experiment.

    " } }, - "ExperimentArn": { - "target": "com.amazonaws.sagemaker#ExperimentArn", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the experiment.

    " + "smithy.api#documentation": "

    The list of tags that are associated with the experiment. You can use Search API to search on the tags.

    " } }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.

    " + "smithy.api#documentation": "

    When the experiment was created.

    " } }, "LastModifiedTime": { @@ -9245,10 +9270,22 @@ "smithy.api#documentation": "

    When the experiment was last modified.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    When the experiment was created.

    " + "smithy.api#documentation": "

    The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.

    " + } + }, + "Source": { + "target": "com.amazonaws.sagemaker#ExperimentSource" + }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "ExperimentArn": { + "target": "com.amazonaws.sagemaker#ExperimentArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the experiment.

    " } } }, @@ -9269,10 +9306,10 @@ "com.amazonaws.sagemaker#ExperimentConfig": { "type": "structure", "members": { - "TrialName": { + "TrialComponentDisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of an existing trial to associate the trial component with. If not specified, a\n new trial is created.

    " + "smithy.api#documentation": "

    The display name for the trial component. If this key isn't specified, the display name is\n the trial component name.

    " } }, "ExperimentName": { @@ -9281,10 +9318,10 @@ "smithy.api#documentation": "

    The name of an existing experiment to associate the trial component with.

    " } }, - "TrialComponentDisplayName": { + "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The display name for the trial component. If this key isn't specified, the display name is\n the trial component name.

    " + "smithy.api#documentation": "

    The name of an existing trial to associate the trial component with. If not specified, a\n new trial is created.

    " } } }, @@ -9315,18 +9352,18 @@ "com.amazonaws.sagemaker#ExperimentSource": { "type": "structure", "members": { + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "

    The source type.

    " + } + }, "SourceArn": { "target": "com.amazonaws.sagemaker#ExperimentSourceArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source.

    ", "smithy.api#required": {} } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#SourceType", - "traits": { - "smithy.api#documentation": "

    The source type.

    " - } } }, "traits": { @@ -9352,9 +9389,6 @@ "com.amazonaws.sagemaker#ExperimentSummary": { "type": "structure", "members": { - "ExperimentSource": { - "target": "com.amazonaws.sagemaker#ExperimentSource" - }, "ExperimentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { @@ -9367,16 +9401,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the experiment.

    " } }, - "CreationTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    When the experiment was created.

    " + "smithy.api#documentation": "

    When the experiment was last modified.

    " } }, - "LastModifiedTime": { + "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    When the experiment was last modified.

    " + "smithy.api#documentation": "

    When the experiment was created.

    " } }, "DisplayName": { @@ -9384,6 +9418,9 @@ "traits": { "smithy.api#documentation": "

    The name of the experiment as displayed. If DisplayName isn't specified,\n ExperimentName is displayed.

    " } + }, + "ExperimentSource": { + "target": "com.amazonaws.sagemaker#ExperimentSource" } }, "traits": { @@ -9417,17 +9454,17 @@ "com.amazonaws.sagemaker#FileSystemDataSource": { "type": "structure", "members": { - "DirectoryPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", + "FileSystemId": { + "target": "com.amazonaws.sagemaker#FileSystemId", "traits": { - "smithy.api#documentation": "

    The full path to the directory to associate with the channel.

    ", + "smithy.api#documentation": "

    The file system id.

    ", "smithy.api#required": {} } }, - "FileSystemAccessMode": { - "target": "com.amazonaws.sagemaker#FileSystemAccessMode", + "DirectoryPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", "traits": { - "smithy.api#documentation": "

    The access mode of the mount of the directory associated with the channel. A directory\n can be mounted either in ro (read-only) or rw (read-write)\n mode.

    ", + "smithy.api#documentation": "

    The full path to the directory to associate with the channel.

    ", "smithy.api#required": {} } }, @@ -9438,10 +9475,10 @@ "smithy.api#required": {} } }, - "FileSystemId": { - "target": "com.amazonaws.sagemaker#FileSystemId", + "FileSystemAccessMode": { + "target": "com.amazonaws.sagemaker#FileSystemAccessMode", "traits": { - "smithy.api#documentation": "

    The file system id.

    ", + "smithy.api#documentation": "

    The access mode of the mount of the directory associated with the channel. A directory\n can be mounted either in ro (read-only) or rw (read-write)\n mode.

    ", "smithy.api#required": {} } } @@ -9477,12 +9514,6 @@ "com.amazonaws.sagemaker#Filter": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.sagemaker#FilterValue", - "traits": { - "smithy.api#documentation": "

    A value used with Name and Operator to determine which\n resources satisfy the filter's condition. For numerical properties, Value\n must be an integer or floating-point decimal. For timestamp properties,\n Value must be an ISO 8601 date-time string of the following format:\n YYYY-mm-dd'T'HH:MM:SS.

    " - } - }, "Name": { "target": "com.amazonaws.sagemaker#ResourcePropertyName", "traits": { @@ -9495,6 +9526,12 @@ "traits": { "smithy.api#documentation": "

    A Boolean binary operator that is used to evaluate the filter. The operator field\n contains one of the following values:

    \n
    \n
    Equals
    \n
    \n

    The value of Name equals Value.

    \n
    \n
    NotEquals
    \n
    \n

    The value of Name doesn't equal Value.

    \n
    \n
    Exists
    \n
    \n

    The Name property exists.

    \n
    \n
    NotExists
    \n
    \n

    The Name property does not exist.

    \n
    \n
    GreaterThan
    \n
    \n

    The value of Name is greater than Value.\n Not supported for text properties.

    \n
    \n
    GreaterThanOrEqualTo
    \n
    \n

    The value of Name is greater than or equal to Value.\n Not supported for text properties.

    \n
    \n
    LessThan
    \n
    \n

    The value of Name is less than Value.\n Not supported for text properties.

    \n
    \n
    LessThanOrEqualTo
    \n
    \n

    The value of Name is less than or equal to Value.\n Not supported for text properties.

    \n
    \n
    In
    \n
    \n

    The value of Name is one of the comma delimited strings in\n Value. Only supported for text properties.

    \n
    \n
    Contains
    \n
    \n

    The value of Name contains the string Value.\n Only supported for text properties.

    \n

    A SearchExpression can include the Contains operator\n multiple times when the value of Name is one of the following:

    \n
      \n
    • \n

      \n Experiment.DisplayName\n

      \n
      • \n
    • \n

      \n Experiment.ExperimentName\n

      \n
      • \n
    • \n

      \n Experiment.Tags\n

      \n
      • \n
    • \n

      \n Trial.DisplayName\n

      \n
      • \n
    • \n

      \n Trial.TrialName\n

      \n
      • \n
    • \n

      \n Trial.Tags\n

      \n
      • \n
    • \n

      \n TrialComponent.DisplayName\n

      \n
      • \n
    • \n

      \n TrialComponent.TrialComponentName\n

      \n
      • \n
    • \n

      \n TrialComponent.Tags\n

      \n
      • \n
    • \n

      \n TrialComponent.InputArtifacts\n

      \n
      • \n
    • \n

      \n TrialComponent.OutputArtifacts\n

      \n
      • \n
    \n

    A SearchExpression can include only one Contains operator\n for all other values of Name. In these cases, if you include multiple\n Contains operators in the SearchExpression, the result is\n the following error message: \"'CONTAINS' operator usage limit of 1\n exceeded.\"

    \n
    \n
    " } + }, + "Value": { + "target": "com.amazonaws.sagemaker#FilterValue", + "traits": { + "smithy.api#documentation": "

    A value used with Name and Operator to determine which\n resources satisfy the filter's condition. For numerical properties, Value\n must be an integer or floating-point decimal. For timestamp properties,\n Value must be an ISO 8601 date-time string of the following format:\n YYYY-mm-dd'T'HH:MM:SS.

    " + } } }, "traits": { @@ -9526,34 +9563,41 @@ "com.amazonaws.sagemaker#FinalAutoMLJobObjectiveMetric": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.sagemaker#MetricValue", - "traits": { - "smithy.api#documentation": "

    The value of the metric.

    ", - "smithy.api#required": {} - } - }, "Type": { "target": "com.amazonaws.sagemaker#AutoMLJobObjectiveType", "traits": { - "smithy.api#documentation": "

    The metric type used.

    " + "smithy.api#documentation": "

    The type of metric with the best result.

    " } }, "MetricName": { "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", "traits": { - "smithy.api#documentation": "

    The name of the metric.

    ", + "smithy.api#documentation": "

    The name of the metric with the best result. For a description of the possible objective\n metrics, see AutoMLJobObjective$MetricName.

    ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#MetricValue", + "traits": { + "smithy.api#documentation": "

    The value of the metric with the best result.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    The candidate result from a job.

    " + "smithy.api#documentation": "

    The best candidate result from an AutoML training job.

    " } }, "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric": { "type": "structure", "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", + "traits": { + "smithy.api#documentation": "

    The name of the\n objective\n metric.

    ", + "smithy.api#required": {} + } + }, "Type": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", "traits": { @@ -9566,13 +9610,6 @@ "smithy.api#documentation": "

    The value of the objective metric.

    ", "smithy.api#required": {} } - }, - "MetricName": { - "target": "com.amazonaws.sagemaker#MetricName", - "traits": { - "smithy.api#documentation": "

    The name of the\n objective\n metric.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -9617,18 +9654,18 @@ "com.amazonaws.sagemaker#FlowDefinitionOutputConfig": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "

    The Amazon Key Management Service (KMS) key ID for server-side encryption.

    " - } - }, "S3OutputPath": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#documentation": "

    The Amazon S3 path where the object containing human output will be made available.

    ", "smithy.api#required": {} } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The Amazon Key Management Service (KMS) key ID for server-side encryption.

    " + } } }, "traits": { @@ -9667,26 +9704,12 @@ "com.amazonaws.sagemaker#FlowDefinitionSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The timestamp when SageMaker created the flow definition.

    ", - "smithy.api#required": {} - } - }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { "smithy.api#documentation": "

    The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

    " } }, - "FlowDefinitionStatus": { - "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", - "traits": { - "smithy.api#documentation": "

    The status of the flow definition. Valid values:

    ", - "smithy.api#required": {} - } - }, "FlowDefinitionArn": { "target": "com.amazonaws.sagemaker#FlowDefinitionArn", "traits": { @@ -9700,6 +9723,20 @@ "smithy.api#documentation": "

    The name of the flow definition.

    ", "smithy.api#required": {} } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp when SageMaker created the flow definition.

    ", + "smithy.api#required": {} + } + }, + "FlowDefinitionStatus": { + "target": "com.amazonaws.sagemaker#FlowDefinitionStatus", + "traits": { + "smithy.api#documentation": "

    The status of the flow definition. Valid values:

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -9831,18 +9868,18 @@ "com.amazonaws.sagemaker#GetSearchSuggestionsRequest": { "type": "structure", "members": { - "SuggestionQuery": { - "target": "com.amazonaws.sagemaker#SuggestionQuery", - "traits": { - "smithy.api#documentation": "

    Limits the property names that are included in the response.

    " - } - }, "Resource": { "target": "com.amazonaws.sagemaker#ResourceType", "traits": { "smithy.api#documentation": "

    The name of the Amazon SageMaker resource to search for.

    ", "smithy.api#required": {} } + }, + "SuggestionQuery": { + "target": "com.amazonaws.sagemaker#SuggestionQuery", + "traits": { + "smithy.api#documentation": "

    Limits the property names that are included in the response.

    " + } } } }, @@ -9860,12 +9897,6 @@ "com.amazonaws.sagemaker#GitConfig": { "type": "structure", "members": { - "Branch": { - "target": "com.amazonaws.sagemaker#Branch", - "traits": { - "smithy.api#documentation": "

    The default branch for the Git repository.

    " - } - }, "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { @@ -9878,6 +9909,12 @@ "smithy.api#documentation": "

    The URL where the Git repository is located.

    ", "smithy.api#required": {} } + }, + "Branch": { + "target": "com.amazonaws.sagemaker#Branch", + "traits": { + "smithy.api#documentation": "

    The default branch for the Git repository.

    " + } } }, "traits": { @@ -9974,15 +10011,16 @@ "com.amazonaws.sagemaker#HumanLoopConfig": { "type": "structure", "members": { - "PublicWorkforceTaskPrice": { - "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice" - }, - "TaskTimeLimitInSeconds": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds", + "TaskTitle": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTitle", "traits": { - "smithy.api#documentation": "

    The amount of time that a worker has to complete a task.

    " + "smithy.api#documentation": "

    A title for the human worker task.

    ", + "smithy.api#required": {} } }, + "PublicWorkforceTaskPrice": { + "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice" + }, "TaskCount": { "target": "com.amazonaws.sagemaker#FlowDefinitionTaskCount", "traits": { @@ -9990,30 +10028,17 @@ "smithy.api#required": {} } }, - "TaskKeywords": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords", + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "

    Keywords used to describe the task so that workers can discover the task.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the human task user interface.

    ", + "smithy.api#required": {} } }, "TaskAvailabilityLifetimeInSeconds": { "target": "com.amazonaws.sagemaker#FlowDefinitionTaskAvailabilityLifetimeInSeconds", "traits": { - "smithy.api#documentation": "

    The length of time that a task remains available for labeling by human workers.

    " - } - }, - "TaskTitle": { - "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTitle", - "traits": { - "smithy.api#documentation": "

    A title for the human worker task.

    ", - "smithy.api#required": {} - } - }, - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the human task user interface.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The length of time that a task remains available for review by human workers.

    " } }, "TaskDescription": { @@ -10023,12 +10048,24 @@ "smithy.api#required": {} } }, + "TaskTimeLimitInSeconds": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskTimeLimitInSeconds", + "traits": { + "smithy.api#documentation": "

    The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour)

    " + } + }, "WorkteamArn": { "target": "com.amazonaws.sagemaker#WorkteamArn", "traits": { "smithy.api#documentation": "

    Amazon Resource Name (ARN) of a team of workers.

    ", "smithy.api#required": {} } + }, + "TaskKeywords": { + "target": "com.amazonaws.sagemaker#FlowDefinitionTaskKeywords", + "traits": { + "smithy.api#documentation": "

    Keywords used to describe the task so that workers can discover the task.

    " + } } }, "traits": { @@ -10053,37 +10090,37 @@ "com.amazonaws.sagemaker#HumanTaskConfig": { "type": "structure", "members": { - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", + "PreHumanTaskLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

    \n

    For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

    \n \n \n\n

    \n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n

      \n
      • \n
    \n \n\n

    \n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

    \n\n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n

      \n
      • \n
    \n \n

    \n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    \n \n

    \n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n

      \n
      • \n
    \n \n

    \n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n

      \n
      • \n
    \n \n

    \n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    \n \n

    \n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    \n \n \n \n \n

    \n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

    \n \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n

      \n
      • \n
    \n \n

    \n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

    \n \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n

      \n
      • \n
    \n \n

    \n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n

      \n
      • \n
    \n \n \n \n\n

    \n 3D Point Cloud Modalities\n

    \n

    Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

    \n\n \n

    \n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    \n \n

    \n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    \n \n \n \n

    \n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    \n \n

    \n Use the following ARNs for Label Verification and Adjustment Jobs\n

    \n

    Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

    \n \n

    \n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    \n \n

    \n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    \n \n

    \n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    \n \n

    \n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    \n \n \n \n \n

    \n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

    \n \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    \n \n

    \n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    \n \n \n \n \n

    \n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    \n \n

    \n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    \n \n

    \n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    ", "smithy.api#required": {} } }, - "MaxConcurrentTaskCount": { - "target": "com.amazonaws.sagemaker#MaxConcurrentTaskCount", + "TaskKeywords": { + "target": "com.amazonaws.sagemaker#TaskKeywords", "traits": { - "smithy.api#documentation": "

    Defines the maximum number of data objects that can be labeled by human workers at the\n same time. Also referred to as batch size. Each object may have more than one worker at one time.\n The default value is 1000 objects.

    " + "smithy.api#documentation": "

    Keywords used to describe the task so that workers on Amazon Mechanical Turk can\n discover the task.

    " } }, - "AnnotationConsolidationConfig": { - "target": "com.amazonaws.sagemaker#AnnotationConsolidationConfig", + "PublicWorkforceTaskPrice": { + "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice", "traits": { - "smithy.api#documentation": "

    Configures how labels are consolidated across human workers.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The price that you pay for each task performed by an Amazon Mechanical Turk worker.

    " } }, - "UiConfig": { - "target": "com.amazonaws.sagemaker#UiConfig", + "NumberOfHumanWorkersPerDataObject": { + "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", "traits": { - "smithy.api#documentation": "

    Information about the user interface that workers use to complete the labeling\n task.

    ", + "smithy.api#documentation": "

    The number of human workers that will label an object.

    ", "smithy.api#required": {} } }, - "TaskKeywords": { - "target": "com.amazonaws.sagemaker#TaskKeywords", + "AnnotationConsolidationConfig": { + "target": "com.amazonaws.sagemaker#AnnotationConsolidationConfig", "traits": { - "smithy.api#documentation": "

    Keywords used to describe the task so that workers on Amazon Mechanical Turk can\n discover the task.

    " + "smithy.api#documentation": "

    Configures how labels are consolidated across human workers.

    ", + "smithy.api#required": {} } }, "TaskTimeLimitInSeconds": { @@ -10093,17 +10130,10 @@ "smithy.api#required": {} } }, - "TaskTitle": { - "target": "com.amazonaws.sagemaker#TaskTitle", - "traits": { - "smithy.api#documentation": "

    A title for the task for your human workers.

    ", - "smithy.api#required": {} - } - }, - "PreHumanTaskLambdaArn": { - "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "TaskDescription": { + "target": "com.amazonaws.sagemaker#TaskDescription", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

    \n

    For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

    \n \n \n\n

    \n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n

      \n
      • \n
    \n \n\n

    \n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

    \n\n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n

      \n
      • \n
    \n \n

    \n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n

      \n
      • \n
    \n \n

    \n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n

      \n
      • \n
    \n \n

    \n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n

      \n
      • \n
    \n \n

    \n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n

      \n
      • \n
    \n \n

    \n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n

      \n
      • \n
    \n \n \n \n \n

    \n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

    \n \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n

      \n
      • \n
    \n \n

    \n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

    \n \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n

      \n
      • \n
    \n \n

    \n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n

      \n
      • \n
    \n \n \n \n\n

    \n 3D Point Cloud Modalities\n

    \n

    Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

    \n\n \n

    \n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n

      \n
      • \n
    \n \n

    \n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n

      \n
      • \n
    \n \n \n \n

    \n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n

      \n
      • \n
    \n \n

    \n Use the following ARNs for Label Verification and Adjustment Jobs\n

    \n

    Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

    \n \n

    \n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    \n \n

    \n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n

      \n
      • \n
    \n \n

    \n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n

      \n
      • \n
    \n \n

    \n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n

      \n
      • \n
    \n \n \n \n \n

    \n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

    \n \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n

      \n
      • \n
    \n \n

    \n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n

      \n
      • \n
    \n \n \n \n \n

    \n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n

      \n
      • \n
    \n \n

    \n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

      \n
      • \n
    \n \n

    \n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

    \n
      \n
    • \n

      \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    • \n

      \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    A description of the task for your human workers.

    ", "smithy.api#required": {} } }, @@ -10113,23 +10143,30 @@ "smithy.api#documentation": "

    The length of time that a task remains available for labeling by human workers.\n If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours\n (43200). The default value is 864000 seconds (10 days). For private and vendor workforces, the maximum is as\n listed.

    " } }, - "PublicWorkforceTaskPrice": { - "target": "com.amazonaws.sagemaker#PublicWorkforceTaskPrice", + "UiConfig": { + "target": "com.amazonaws.sagemaker#UiConfig", "traits": { - "smithy.api#documentation": "

    The price that you pay for each task performed by an Amazon Mechanical Turk worker.

    " + "smithy.api#documentation": "

    Information about the user interface that workers use to complete the labeling\n task.

    ", + "smithy.api#required": {} } }, - "NumberOfHumanWorkersPerDataObject": { - "target": "com.amazonaws.sagemaker#NumberOfHumanWorkersPerDataObject", + "MaxConcurrentTaskCount": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTaskCount", "traits": { - "smithy.api#documentation": "

    The number of human workers that will label an object.

    ", + "smithy.api#documentation": "

    Defines the maximum number of data objects that can be labeled by human workers at the\n same time. Also referred to as batch size. Each object may have more than one worker at one time.\n The default value is 1000 objects.

    " + } + }, + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

    ", "smithy.api#required": {} } }, - "TaskDescription": { - "target": "com.amazonaws.sagemaker#TaskDescription", + "TaskTitle": { + "target": "com.amazonaws.sagemaker#TaskTitle", "traits": { - "smithy.api#documentation": "

    A description of the task for your human workers.

    ", + "smithy.api#documentation": "

    A title for the task for your human workers.

    ", "smithy.api#required": {} } } @@ -10189,17 +10226,17 @@ "smithy.api#required": {} } }, - "HumanTaskUiName": { - "target": "com.amazonaws.sagemaker#HumanTaskUiName", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the human task user interface.

    ", + "smithy.api#documentation": "

    A timestamp when SageMaker created the human task user interface.

    ", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "HumanTaskUiName": { + "target": "com.amazonaws.sagemaker#HumanTaskUiName", "traits": { - "smithy.api#documentation": "

    A timestamp when SageMaker created the human task user interface.

    ", + "smithy.api#documentation": "

    The name of the human task user interface.

    ", "smithy.api#required": {} } } @@ -10211,29 +10248,29 @@ "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification": { "type": "structure", "members": { - "TrainingInputMode": { - "target": "com.amazonaws.sagemaker#TrainingInputMode", - "traits": { - "smithy.api#documentation": "

    The input mode that the algorithm supports:\n File\n or Pipe. In File input mode, Amazon SageMaker downloads the training data from\n Amazon S3 to the\n storage\n volume that is attached to the training instance and mounts the directory to the Docker\n volume for the training container. In Pipe input mode, Amazon SageMaker streams\n data directly from Amazon S3 to the container.

    \n

    If you specify File mode, make sure that\n you\n provision the storage volume that is attached to the training instance with enough\n capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and\n intermediate\n information.

    \n

    \n

    For more information about input modes, see Algorithms.

    ", - "smithy.api#required": {} - } - }, "MetricDefinitions": { "target": "com.amazonaws.sagemaker#MetricDefinitionList", "traits": { "smithy.api#documentation": "

    An array of MetricDefinition objects that specify the\n metrics\n that the algorithm emits.

    " } }, + "TrainingImage": { + "target": "com.amazonaws.sagemaker#AlgorithmImage", + "traits": { + "smithy.api#documentation": "

    The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

    " + } + }, "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { "smithy.api#documentation": "

    The name of the resource algorithm to use for the hyperparameter tuning job. If you\n specify a value for this parameter, do not specify a value for\n TrainingImage.

    " } }, - "TrainingImage": { - "target": "com.amazonaws.sagemaker#AlgorithmImage", + "TrainingInputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", "traits": { - "smithy.api#documentation": "

    The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

    " + "smithy.api#documentation": "

    The input mode that the algorithm supports:\n File\n or Pipe. In File input mode, Amazon SageMaker downloads the training data from\n Amazon S3 to the\n storage\n volume that is attached to the training instance and mounts the directory to the Docker\n volume for the training container. In Pipe input mode, Amazon SageMaker streams\n data directly from Amazon S3 to the container.

    \n

    If you specify File mode, make sure that\n you\n provision the storage volume that is attached to the training instance with enough\n capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and\n intermediate\n information.

    \n

    \n

    For more information about input modes, see Algorithms.

    ", + "smithy.api#required": {} } } }, @@ -10267,25 +10304,18 @@ "com.amazonaws.sagemaker#HyperParameterSpecification": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.sagemaker#ParameterType", - "traits": { - "smithy.api#documentation": "

    The type of this hyperparameter. The valid types are Integer,\n Continuous, Categorical, and FreeText.

    ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.sagemaker#EntityDescription", - "traits": { - "smithy.api#documentation": "

    A brief description of the hyperparameter.

    " - } - }, "Range": { "target": "com.amazonaws.sagemaker#ParameterRange", "traits": { "smithy.api#documentation": "

    The allowed range for this hyperparameter.

    " } }, + "IsRequired": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether this hyperparameter is required.

    " + } + }, "Name": { "target": "com.amazonaws.sagemaker#ParameterName", "traits": { @@ -10293,6 +10323,13 @@ "smithy.api#required": {} } }, + "Type": { + "target": "com.amazonaws.sagemaker#ParameterType", + "traits": { + "smithy.api#documentation": "

    The type of this hyperparameter. The valid types are Integer,\n Continuous, Categorical, and FreeText.

    ", + "smithy.api#required": {} + } + }, "DefaultValue": { "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { @@ -10305,10 +10342,10 @@ "smithy.api#documentation": "

    Indicates whether this hyperparameter is tunable in a hyperparameter tuning\n job.

    " } }, - "IsRequired": { - "target": "com.amazonaws.sagemaker#Boolean", + "Description": { + "target": "com.amazonaws.sagemaker#EntityDescription", "traits": { - "smithy.api#documentation": "

    Indicates whether this hyperparameter is required.

    " + "smithy.api#documentation": "

    A brief description of the hyperparameter.

    " } } }, @@ -10324,41 +10361,19 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition": { - "type": "structure", - "members": { - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.

    " - } - }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", - "traits": { - "smithy.api#documentation": "

    Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

    " - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", - "traits": { - "smithy.api#documentation": "

    Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long you are willing to wait for a managed spot training job to complete.\n When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model\n training costs.

    ", - "smithy.api#required": {} - } - }, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition": { + "type": "structure", + "members": { "StaticHyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { "smithy.api#documentation": "

    Specifies the values of hyperparameters\n that\n do not change for the tuning job.

    " } }, - "HyperParameterRanges": { - "target": "com.amazonaws.sagemaker#ParameterRanges" - }, "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { @@ -10366,24 +10381,27 @@ "smithy.api#required": {} } }, - "TuningObjective": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective" + "HyperParameterRanges": { + "target": "com.amazonaws.sagemaker#ParameterRanges" }, - "AlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification", + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    The HyperParameterAlgorithmSpecification object that\n specifies\n the resource algorithm to use for the training jobs that the tuning\n job launches.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A Boolean indicating whether managed spot training is enabled (True) or\n not (False).

    " } }, - "DefinitionName": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    The job definition name.

    " + "smithy.api#documentation": "

    Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

    " } }, - "CheckpointConfig": { - "target": "com.amazonaws.sagemaker#CheckpointConfig" + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#documentation": "

    Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long you are willing to wait for a managed spot training job to complete.\n When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model\n training costs.

    ", + "smithy.api#required": {} + } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", @@ -10398,6 +10416,15 @@ "smithy.api#required": {} } }, + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig" + }, + "DefinitionName": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "traits": { + "smithy.api#documentation": "

    The job definition name.

    " + } + }, "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { @@ -10411,11 +10438,21 @@ "smithy.api#required": {} } }, - "EnableManagedSpotTraining": { + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#HyperParameterAlgorithmSpecification", + "traits": { + "smithy.api#documentation": "

    The HyperParameterAlgorithmSpecification object that\n specifies\n the resource algorithm to use for the training jobs that the tuning\n job launches.

    ", + "smithy.api#required": {} + } + }, + "EnableInterContainerTrafficEncryption": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    A Boolean indicating whether managed spot training is enabled (True) or\n not (False).

    " + "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.

    " } + }, + "TuningObjective": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective" } }, "traits": { @@ -10453,23 +10490,10 @@ "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary": { "type": "structure", "members": { - "TrainingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date and time that the training job started.

    " - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date and time that the training job was created.

    ", - "smithy.api#required": {} - } - }, - "TrainingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "FinalHyperParameterTuningJobObjectiveMetric": { + "target": "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric", "traits": { - "smithy.api#documentation": "

    Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " + "smithy.api#documentation": "

    The FinalHyperParameterTuningJobObjectiveMetric object that\n specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.

    " } }, "FailureReason": { @@ -10478,37 +10502,37 @@ "smithy.api#documentation": "

    The\n reason that the training job failed.\n

    " } }, - "TrainingJobDefinitionName": { - "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "TunedHyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "

    The training job definition name.

    " + "smithy.api#documentation": "

    A\n list of the hyperparameters for which you specified ranges to\n search.

    ", + "smithy.api#required": {} } }, - "TuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", "traits": { - "smithy.api#documentation": "

    The HyperParameter tuning job that launched the training job.

    " + "smithy.api#documentation": "

    The name of the training job.

    ", + "smithy.api#required": {} } }, - "TrainingJobStatus": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "TuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", "traits": { - "smithy.api#documentation": "

    The\n status\n of the training job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The HyperParameter tuning job that launched the training job.

    " } }, - "TunedHyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", "traits": { - "smithy.api#documentation": "

    A\n list of the hyperparameters for which you specified ranges to\n search.

    ", + "smithy.api#documentation": "

    The\n Amazon\n Resource Name (ARN) of the training job.

    ", "smithy.api#required": {} } }, - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the training job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The date and time that the training job started.

    " } }, "ObjectiveStatus": { @@ -10517,16 +10541,29 @@ "smithy.api#documentation": "

    The status of the objective metric for the training job:

    \n
      \n
    • \n

      Succeeded: The\n final\n objective metric for the training job was evaluated by the\n hyperparameter tuning job and\n used\n in the hyperparameter tuning process.

      \n
      • \n
    \n
      \n
    • \n

      Pending: The training job is in progress and evaluation of its final objective\n metric is pending.

      \n
      • \n
    \n
      \n
    • \n

      Failed:\n The final objective metric for the training job was not evaluated, and was not\n used in the hyperparameter tuning process. This typically occurs when the\n training job failed or did not emit an objective\n metric.

      \n
      • \n
    " } }, - "FinalHyperParameterTuningJobObjectiveMetric": { - "target": "com.amazonaws.sagemaker#FinalHyperParameterTuningJobObjectiveMetric", + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The FinalHyperParameterTuningJobObjectiveMetric object that\n specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.

    " + "smithy.api#documentation": "

    Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " } }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

    The\n Amazon\n Resource Name (ARN) of the training job.

    ", + "smithy.api#documentation": "

    The\n status\n of the training job.

    ", + "smithy.api#required": {} + } + }, + "TrainingJobDefinitionName": { + "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitionName", + "traits": { + "smithy.api#documentation": "

    The training job definition name.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that the training job was created.

    ", "smithy.api#required": {} } } @@ -10548,10 +10585,10 @@ "com.amazonaws.sagemaker#HyperParameterTuningJobConfig": { "type": "structure", "members": { - "HyperParameterTuningJobObjective": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective", + "ParameterRanges": { + "target": "com.amazonaws.sagemaker#ParameterRanges", "traits": { - "smithy.api#documentation": "

    The HyperParameterTuningJobObjective object that specifies the\n objective\n metric for this tuning job.

    " + "smithy.api#documentation": "

    The ParameterRanges object that specifies the ranges of\n hyperparameters\n that this tuning job searches.

    " } }, "TuningJobCompletionCriteria": { @@ -10560,11 +10597,10 @@ "smithy.api#documentation": "

    The tuning job's completion criteria.

    " } }, - "ResourceLimits": { - "target": "com.amazonaws.sagemaker#ResourceLimits", + "HyperParameterTuningJobObjective": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective", "traits": { - "smithy.api#documentation": "

    The ResourceLimits object that specifies the\n maximum\n number of training jobs and parallel training jobs for this tuning\n job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The HyperParameterTuningJobObjective object that specifies the\n objective\n metric for this tuning job.

    " } }, "Strategy": { @@ -10580,10 +10616,11 @@ "smithy.api#documentation": "

    Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. This can be one of the following values (the default value is\n OFF):

    \n
    \n
    OFF
    \n
    \n

    Training jobs launched by the hyperparameter tuning job do not use early\n stopping.

    \n
    \n
    AUTO
    \n
    \n

    Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.

    \n
    \n
    " } }, - "ParameterRanges": { - "target": "com.amazonaws.sagemaker#ParameterRanges", + "ResourceLimits": { + "target": "com.amazonaws.sagemaker#ResourceLimits", "traits": { - "smithy.api#documentation": "

    The ParameterRanges object that specifies the ranges of\n hyperparameters\n that this tuning job searches.

    " + "smithy.api#documentation": "

    The ResourceLimits object that specifies the\n maximum\n number of training jobs and parallel training jobs for this tuning\n job.

    ", + "smithy.api#required": {} } } }, @@ -10604,17 +10641,17 @@ "com.amazonaws.sagemaker#HyperParameterTuningJobObjective": { "type": "structure", "members": { - "MetricName": { - "target": "com.amazonaws.sagemaker#MetricName", + "Type": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", "traits": { - "smithy.api#documentation": "

    The\n name of the metric to use for the objective metric.

    ", + "smithy.api#documentation": "

    Whether to\n minimize\n or maximize the objective metric.

    ", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectiveType", + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", "traits": { - "smithy.api#documentation": "

    Whether to\n minimize\n or maximize the objective metric.

    ", + "smithy.api#documentation": "

    The\n name of the metric to use for the objective metric.

    ", "smithy.api#required": {} } } @@ -10715,16 +10752,10 @@ "com.amazonaws.sagemaker#HyperParameterTuningJobSummary": { "type": "structure", "members": { - "ResourceLimits": { - "target": "com.amazonaws.sagemaker#ResourceLimits", - "traits": { - "smithy.api#documentation": "

    The ResourceLimits object that specifies the maximum number of\n training jobs and parallel training jobs allowed for this tuning job.

    " - } - }, - "LastModifiedTime": { + "HyperParameterTuningEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time that the tuning job was\n modified.

    " + "smithy.api#documentation": "

    The date and time that the tuning job ended.

    " } }, "HyperParameterTuningJobArn": { @@ -10734,10 +10765,17 @@ "smithy.api#required": {} } }, - "Strategy": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", "traits": { - "smithy.api#documentation": "

    Specifies the search strategy hyperparameter tuning uses to choose which\n hyperparameters to\n use\n for each iteration. Currently, the only valid value is\n Bayesian.

    ", + "smithy.api#documentation": "

    The name of the tuning job.

    ", + "smithy.api#required": {} + } + }, + "ObjectiveStatusCounters": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", + "traits": { + "smithy.api#documentation": "

    The ObjectiveStatusCounters object that specifies the numbers of\n training jobs, categorized by objective metric status, that this tuning job\n launched.

    ", "smithy.api#required": {} } }, @@ -10748,17 +10786,22 @@ "smithy.api#required": {} } }, - "HyperParameterTuningJobStatus": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of the\n tuning\n job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The date and time that the tuning job was\n modified.

    " } }, - "ObjectiveStatusCounters": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", + "ResourceLimits": { + "target": "com.amazonaws.sagemaker#ResourceLimits", "traits": { - "smithy.api#documentation": "

    The ObjectiveStatusCounters object that specifies the numbers of\n training jobs, categorized by objective metric status, that this tuning job\n launched.

    ", + "smithy.api#documentation": "

    The ResourceLimits object that specifies the maximum number of\n training jobs and parallel training jobs allowed for this tuning job.

    " + } + }, + "HyperParameterTuningJobStatus": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the\n tuning\n job.

    ", "smithy.api#required": {} } }, @@ -10769,16 +10812,10 @@ "smithy.api#required": {} } }, - "HyperParameterTuningEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date and time that the tuning job ended.

    " - } - }, - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "Strategy": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStrategyType", "traits": { - "smithy.api#documentation": "

    The name of the tuning job.

    ", + "smithy.api#documentation": "

    Specifies the search strategy hyperparameter tuning uses to choose which\n hyperparameters to\n use\n for each iteration. Currently, the only valid value is\n Bayesian.

    ", "smithy.api#required": {} } } @@ -10790,17 +10827,17 @@ "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig": { "type": "structure", "members": { - "ParentHyperParameterTuningJobs": { - "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs", + "WarmStartType": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType", "traits": { - "smithy.api#documentation": "

    An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.

    \n

    Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.

    ", + "smithy.api#documentation": "

    Specifies one of the following:

    \n
    \n
    IDENTICAL_DATA_AND_ALGORITHM
    \n
    \n

    The new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.

    \n
    \n
    TRANSFER_LEARNING
    \n
    \n

    The new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.

    \n
    \n
    ", "smithy.api#required": {} } }, - "WarmStartType": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType", + "ParentHyperParameterTuningJobs": { + "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs", "traits": { - "smithy.api#documentation": "

    Specifies one of the following:

    \n
    \n
    IDENTICAL_DATA_AND_ALGORITHM
    \n
    \n

    The new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.

    \n
    \n
    TRANSFER_LEARNING
    \n
    \n

    The new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.

    \n
    \n
    ", + "smithy.api#documentation": "

    An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.

    \n

    Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.

    ", "smithy.api#required": {} } } @@ -10849,6 +10886,21 @@ "smithy.api#pattern": "^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$" } }, + "com.amazonaws.sagemaker#ImageConfig": { + "type": "structure", + "members": { + "RepositoryAccessMode": { + "target": "com.amazonaws.sagemaker#RepositoryAccessMode", + "traits": { + "smithy.api#documentation": "

    Set this to one of the following values:

    \n
      \n
    • \n

      \n Platform - The model image is hosted in Amazon ECR.

      \n
      • \n
    • \n

      \n Vpc - The model image is hosted in a private Docker registry in\n your VPC.

      \n
      • \n
    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your\n Amazon Virtual Private Cloud (VPC).

    " + } + }, "com.amazonaws.sagemaker#ImageDigest": { "type": "string", "traits": { @@ -10872,17 +10924,10 @@ "com.amazonaws.sagemaker#InferenceSpecification": { "type": "structure", "members": { - "SupportedRealtimeInferenceInstanceTypes": { - "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", - "traits": { - "smithy.api#documentation": "

    A list of the instance types that are used to generate inferences in real-time.

    ", - "smithy.api#required": {} - } - }, - "SupportedContentTypes": { - "target": "com.amazonaws.sagemaker#ContentTypes", + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#ResponseMIMETypes", "traits": { - "smithy.api#documentation": "

    The supported MIME types for the input data.

    ", + "smithy.api#documentation": "

    The supported MIME types for the output data.

    ", "smithy.api#required": {} } }, @@ -10893,17 +10938,24 @@ "smithy.api#required": {} } }, - "SupportedResponseMIMETypes": { - "target": "com.amazonaws.sagemaker#ResponseMIMETypes", + "Containers": { + "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList", "traits": { - "smithy.api#documentation": "

    The supported MIME types for the output data.

    ", + "smithy.api#documentation": "

    The Amazon ECR registry path of the Docker image that contains the inference code.

    ", "smithy.api#required": {} } }, - "Containers": { - "target": "com.amazonaws.sagemaker#ModelPackageContainerDefinitionList", + "SupportedContentTypes": { + "target": "com.amazonaws.sagemaker#ContentTypes", "traits": { - "smithy.api#documentation": "

    The Amazon ECR registry path of the Docker image that contains the inference code.

    ", + "smithy.api#documentation": "

    The supported MIME types for the input data.

    ", + "smithy.api#required": {} + } + }, + "SupportedRealtimeInferenceInstanceTypes": { + "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", + "traits": { + "smithy.api#documentation": "

    A list of the instance types that are used to generate inferences in real-time.

    ", "smithy.api#required": {} } } @@ -10925,7 +10977,7 @@ "DataInputConfig": { "target": "com.amazonaws.sagemaker#DataInputConfig", "traits": { - "smithy.api#documentation": "

    Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are InputConfig$Framework\n specific.

    \n
      \n
    • \n

      \n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.

      \n
        \n
      • \n

        Examples for one input:

        \n
          \n
        • \n

          If using the console,\n {\"input\":[1,1024,1024,3]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Examples for two inputs:

        \n
          \n
        • \n

          If using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n

          \n
          • \n
        • \n

          If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.

      \n
        \n
      • \n

        Examples for one input:

        \n
          \n
        • \n

          If using the console,\n {\"input_1\":[1,3,224,224]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Examples for two inputs:

        \n
          \n
        • \n

          If using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n

          \n
          • \n
        • \n

          If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n MXNET/ONNX: You must specify the name and shape (NCHW format) of\n the expected data inputs in order using a dictionary format for your trained\n model. The dictionary formats required for the console and CLI are\n different.

      \n
        \n
      • \n

        Examples for one input:

        \n
          \n
        • \n

          If using the console,\n {\"data\":[1,3,1024,1024]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Examples for two inputs:

        \n
          \n
        • \n

          If using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n

          \n
          • \n
        • \n

          If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.

      \n
        \n
      • \n

        Examples for one input in dictionary format:

        \n
          \n
        • \n

          If using the console,\n {\"input0\":[1,3,224,224]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Example for one input in list format:\n [[1,3,224,224]]\n

        \n
        • \n
      • \n

        Examples for two inputs in dictionary format:

        \n
          \n
        • \n

          If using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n

          \n
          • \n
        • \n

          If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n

          \n
          • \n
        \n
        • \n
      • \n

        Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n

        \n
        • \n
      \n
      • \n
    • \n

      \n XGBOOST: input data name and shape are not needed.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are InputConfig$Framework\n specific.

    \n
      \n
    • \n

      \n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.

      \n
        \n
      • \n

        Examples for one input:

        \n
          \n
        • \n

          If using the console,\n {\"input\":[1,1024,1024,3]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Examples for two inputs:

        \n
          \n
        • \n

          If using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n

          \n
          • \n
        • \n

          If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.

      \n
        \n
      • \n

        Examples for one input:

        \n
          \n
        • \n

          If using the console,\n {\"input_1\":[1,3,224,224]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Examples for two inputs:

        \n
          \n
        • \n

          If using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n

          \n
          • \n
        • \n

          If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n MXNET/ONNX: You must specify the name and shape (NCHW format) of\n the expected data inputs in order using a dictionary format for your trained\n model. The dictionary formats required for the console and CLI are\n different.

      \n
        \n
      • \n

        Examples for one input:

        \n
          \n
        • \n

          If using the console,\n {\"data\":[1,3,1024,1024]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Examples for two inputs:

        \n
          \n
        • \n

          If using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n

          \n
          • \n
        • \n

          If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.

      \n
        \n
      • \n

        Examples for one input in dictionary format:

        \n
          \n
        • \n

          If using the console,\n {\"input0\":[1,3,224,224]}\n

          \n
          • \n
        • \n

          If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n

          \n
          • \n
        \n
        • \n
      • \n

        Example for one input in list format:\n [[1,3,224,224]]\n

        \n
        • \n
      • \n

        Examples for two inputs in dictionary format:

        \n
          \n
        • \n

          If using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n

          \n
          • \n
        • \n

          If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n

          \n
          • \n
        \n
        • \n
      • \n

        Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n

        \n
        • \n
      \n
      • \n
    • \n

      \n XGBOOST: input data name and shape are not needed.

      \n
      • \n
    \n

    \n DataInputConfig supports the following parameters for CoreML\n OutputConfig$TargetDevice (ML Model format):

    \n
      \n
    • \n

      \n shape: Input shape, for example {\"input_1\": {\"shape\": [1,224,224,3]}}.\n In addition to static input shapes, CoreML converter supports Flexible input shapes:

      \n
        \n
      • \n

        Range Dimension. You can use the Range Dimension feature if you know the input shape\n will be within some specific interval in that dimension,\n for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3]}}\n

        \n
        • \n
      • \n

        Enumerated shapes. Sometimes, the models are trained to work only on a select\n set of inputs. You can enumerate all supported input shapes,\n for example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160, 3]]}}\n

        \n
        • \n
      \n
      • \n
    • \n

      \n default_shape: Default input shape. You can set a default shape during\n conversion for both Range Dimension and Enumerated Shapes. For example\n {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1, 224, 224, 3]}}\n

      \n
      • \n
    • \n

      \n type: Input type. Allowed values: Image and Tensor.\n By default, the converter generates an ML Model with inputs of type Tensor (MultiArray).\n User can set input type to be Image. Image input type requires additional input parameters\n such as bias and scale.

      \n
      • \n
    • \n

      \n bias: If the input type is an Image, you need to provide the bias vector.

      \n
      • \n
    • \n

      \n scale: If the input type is an Image, you need to provide a scale factor.

      \n
      • \n
    \n

    CoreML ClassifierConfig parameters can be specified using\n OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.\n CoreML conversion examples:

    \n
      \n
    • \n

      Tensor type input:

      \n
        \n
      • \n

        \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\":\n [1,224,224,3]}}\n

        \n
        • \n
      \n
      • \n
    • \n

      Tensor type input without input name (PyTorch):

      \n
        \n
      • \n

        \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\":\n [1,3,224,224]}]\n

        \n
        • \n
      \n
      • \n
    • \n

      Image type input:

      \n
        \n
      • \n

        \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\":\n [1,224,224,3], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}\n

        \n
        • \n
      • \n

        \n \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}\n

        \n
        • \n
      \n
      • \n
    • \n

      Image type input without input name (PyTorch):

      \n
        \n
      • \n

        \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\":\n [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}]\n

        \n
        • \n
      • \n

        \n \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}\n

        \n
        • \n
      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -11126,23 +11178,17 @@ "com.amazonaws.sagemaker#IntegerParameterRange": { "type": "structure", "members": { - "ScalingType": { - "target": "com.amazonaws.sagemaker#HyperParameterScalingType", - "traits": { - "smithy.api#documentation": "

    The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

    \n
    \n
    Auto
    \n
    \n

    Amazon SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

    \n
    \n
    Linear
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

    \n
    \n
    Logarithmic
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

    \n

    Logarithmic scaling works only for ranges that have only values greater\n than 0.

    \n
    \n
    " - } - }, - "MaxValue": { + "MinValue": { "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { - "smithy.api#documentation": "

    The maximum\n value\n of the hyperparameter to search.

    ", + "smithy.api#documentation": "

    The minimum\n value\n of the hyperparameter to search.

    ", "smithy.api#required": {} } }, - "MinValue": { + "MaxValue": { "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { - "smithy.api#documentation": "

    The minimum\n value\n of the hyperparameter to search.

    ", + "smithy.api#documentation": "

    The maximum\n value\n of the hyperparameter to search.

    ", "smithy.api#required": {} } }, @@ -11152,6 +11198,12 @@ "smithy.api#documentation": "

    The name of the hyperparameter to search.

    ", "smithy.api#required": {} } + }, + "ScalingType": { + "target": "com.amazonaws.sagemaker#HyperParameterScalingType", + "traits": { + "smithy.api#documentation": "

    The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

    \n
    \n
    Auto
    \n
    \n

    Amazon SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

    \n
    \n
    Linear
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

    \n
    \n
    Logarithmic
    \n
    \n

    Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

    \n

    Logarithmic scaling works only for ranges that have only values greater\n than 0.

    \n
    \n
    " + } } }, "traits": { @@ -11161,17 +11213,17 @@ "com.amazonaws.sagemaker#IntegerParameterRangeSpecification": { "type": "structure", "members": { - "MaxValue": { + "MinValue": { "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { - "smithy.api#documentation": "

    The maximum integer value allowed.

    ", + "smithy.api#documentation": "

    The minimum integer value allowed.

    ", "smithy.api#required": {} } }, - "MinValue": { + "MaxValue": { "target": "com.amazonaws.sagemaker#ParameterValue", "traits": { - "smithy.api#documentation": "

    The minimum integer value allowed.

    ", + "smithy.api#documentation": "

    The maximum integer value allowed.

    ", "smithy.api#required": {} } } @@ -11336,10 +11388,10 @@ "com.amazonaws.sagemaker#LabelCounters": { "type": "structure", "members": { - "MachineLabeled": { + "Unlabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { - "smithy.api#documentation": "

    The total number of objects labeled by automated data labeling.

    " + "smithy.api#documentation": "

    The total number of objects not yet labeled.

    " } }, "FailedNonRetryableError": { @@ -11360,10 +11412,10 @@ "smithy.api#documentation": "

    The total number of objects labeled by a human worker.

    " } }, - "Unlabeled": { + "MachineLabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { - "smithy.api#documentation": "

    The total number of objects not yet labeled.

    " + "smithy.api#documentation": "

    The total number of objects labeled by automated data labeling.

    " } } }, @@ -11374,10 +11426,10 @@ "com.amazonaws.sagemaker#LabelCountersForWorkteam": { "type": "structure", "members": { - "PendingHuman": { + "HumanLabeled": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { - "smithy.api#documentation": "

    The total number of data objects that need to be labeled by a human worker.

    " + "smithy.api#documentation": "

    The total number of data objects labeled by a human worker.

    " } }, "Total": { @@ -11386,10 +11438,10 @@ "smithy.api#documentation": "

    The total number of tasks in the labeling job.

    " } }, - "HumanLabeled": { + "PendingHuman": { "target": "com.amazonaws.sagemaker#LabelCounter", "traits": { - "smithy.api#documentation": "

    The total number of data objects labeled by a human worker.

    " + "smithy.api#documentation": "

    The total number of data objects that need to be labeled by a human worker.

    " } } }, @@ -11410,12 +11462,6 @@ "com.amazonaws.sagemaker#LabelingJobAlgorithmsConfig": { "type": "structure", "members": { - "InitialActiveLearningModelArn": { - "target": "com.amazonaws.sagemaker#ModelArn", - "traits": { - "smithy.api#documentation": "

    At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final\n model used for auto-labeling. You can use this model as the starting point for\n subsequent similar jobs by providing the ARN of the model here.

    " - } - }, "LabelingJobResourceConfig": { "target": "com.amazonaws.sagemaker#LabelingJobResourceConfig", "traits": { @@ -11428,6 +11474,12 @@ "smithy.api#documentation": "

    Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You\n must select one of the following ARNs:

    \n
      \n
    • \n

      \n Image classification\n

      \n

      \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification\n

      \n
      • \n
    • \n

      \n Text classification\n

      \n

      \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification\n

      \n
      • \n
    • \n

      \n Object detection\n

      \n

      \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection\n

      \n
      • \n
    • \n

      \n Semantic Segmentation\n

      \n

      \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation\n

      \n
      • \n
    ", "smithy.api#required": {} } + }, + "InitialActiveLearningModelArn": { + "target": "com.amazonaws.sagemaker#ModelArn", + "traits": { + "smithy.api#documentation": "

    At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final\n model used for auto-labeling. You can use this model as the starting point for\n subsequent similar jobs by providing the ARN of the model here.

    " + } } }, "traits": { @@ -11461,6 +11513,12 @@ "com.amazonaws.sagemaker#LabelingJobDataSource": { "type": "structure", "members": { + "SnsDataSource": { + "target": "com.amazonaws.sagemaker#LabelingJobSnsDataSource", + "traits": { + "smithy.api#documentation": "

    An Amazon SNS data source used for streaming labeling jobs.

    " + } + }, "S3DataSource": { "target": "com.amazonaws.sagemaker#LabelingJobS3DataSource", "traits": { @@ -11469,22 +11527,22 @@ } }, "traits": { - "smithy.api#documentation": "

    Provides information about the location of input data.

    " + "smithy.api#documentation": "

    Provides information about the location of input data.

    \n

    You must specify at least one of the following: S3DataSource or SnsDataSource.

    \n

    Use SnsDataSource to specify an SNS input topic\n for a streaming labeling job. If you do not specify \n and SNS input topic ARN, Ground Truth will create a one-time labeling job.

    \n

    Use S3DataSource to specify an input \n manifest file for both streaming and one-time labeling jobs.\n Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

    " } }, "com.amazonaws.sagemaker#LabelingJobForWorkteamSummary": { "type": "structure", "members": { - "LabelCounters": { - "target": "com.amazonaws.sagemaker#LabelCountersForWorkteam", + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", "traits": { - "smithy.api#documentation": "

    Provides information about the progress of a labeling job.

    " + "smithy.api#documentation": "

    The name of the labeling job that the work team is assigned to.

    " } }, - "JobReferenceCode": { - "target": "com.amazonaws.sagemaker#JobReferenceCode", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A unique identifier for a labeling job. You can use this to refer to a specific\n labeling job.

    ", + "smithy.api#documentation": "

    The date and time that the labeling job was created.

    ", "smithy.api#required": {} } }, @@ -11494,24 +11552,24 @@ "smithy.api#documentation": "

    The configured number of workers per data object.

    " } }, - "WorkRequesterAccountId": { - "target": "com.amazonaws.sagemaker#AccountId", + "JobReferenceCode": { + "target": "com.amazonaws.sagemaker#JobReferenceCode", "traits": { - "smithy.api#documentation": "

    ", + "smithy.api#documentation": "

    A unique identifier for a labeling job. You can use this to refer to a specific\n labeling job.

    ", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCountersForWorkteam", "traits": { - "smithy.api#documentation": "

    The date and time that the labeling job was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Provides information about the progress of a labeling job.

    " } }, - "LabelingJobName": { - "target": "com.amazonaws.sagemaker#LabelingJobName", + "WorkRequesterAccountId": { + "target": "com.amazonaws.sagemaker#AccountId", "traits": { - "smithy.api#documentation": "

    The name of the labeling job that the work team is assigned to.

    " + "smithy.api#documentation": "

    ", + "smithy.api#required": {} } } }, @@ -11580,10 +11638,10 @@ "com.amazonaws.sagemaker#LabelingJobOutputConfig": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "SnsTopicArn": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service ID of the key used to encrypt the output data, if any.

    \n

    If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a\n bucket policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateLabelingJob request. For more information, see Using\n Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

    " + "smithy.api#documentation": "

    An Amazon Simple Notification Service (Amazon SNS) output topic ARN.

    \n

    When workers complete labeling tasks, Ground Truth will send \n labeling task output data to the SNS output topic you specify here.

    \n

    You must provide a value for this parameter\n if you provide an Amazon SNS input topic in SnsDataSource\n in InputConfig.

    " } }, "S3OutputPath": { @@ -11592,6 +11650,12 @@ "smithy.api#documentation": "

    The Amazon S3 location to write output data.

    ", "smithy.api#required": {} } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The AWS Key Management Service ID of the key used to encrypt the output data, if any.

    \n

    If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a\n bucket policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateLabelingJob request. For more information, see Using\n Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

    " + } } }, "traits": { @@ -11627,6 +11691,21 @@ "smithy.api#documentation": "

    The Amazon S3 location of the input data objects.

    " } }, + "com.amazonaws.sagemaker#LabelingJobSnsDataSource": { + "type": "structure", + "members": { + "SnsTopicArn": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

    The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic\n you will use to send new data objects to a streaming labeling job.

    \n

    If you specify an input topic for SnsTopicArn in InputConfig,\n you must specify a value for SnsTopicArn in OutputConfig.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    An Amazon SNS data source used for streaming labeling jobs.

    " + } + }, "com.amazonaws.sagemaker#LabelingJobStatus": { "type": "string", "traits": { @@ -11681,56 +11760,50 @@ "com.amazonaws.sagemaker#LabelingJobSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "LabelingJobName": { + "target": "com.amazonaws.sagemaker#LabelingJobName", "traits": { - "smithy.api#documentation": "

    The date and time that the job was created (timestamp).

    ", + "smithy.api#documentation": "

    The name of the labeling job.

    ", "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "LabelCounters": { + "target": "com.amazonaws.sagemaker#LabelCounters", "traits": { - "smithy.api#documentation": "

    The date and time that the job was last modified (timestamp).

    ", + "smithy.api#documentation": "

    Counts showing the progress of the labeling job.

    ", "smithy.api#required": {} } }, - "LabelingJobStatus": { - "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "WorkteamArn": { + "target": "com.amazonaws.sagemaker#WorkteamArn", "traits": { - "smithy.api#documentation": "

    The current status of the labeling job.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the work team assigned to the job.

    ", "smithy.api#required": {} } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "LabelingJobOutput": { + "target": "com.amazonaws.sagemaker#LabelingJobOutput", "traits": { - "smithy.api#documentation": "

    If the LabelingJobStatus field is Failed, this field\n contains a description of the error.

    " + "smithy.api#documentation": "

    The location of the output produced by the labeling job.

    " } }, - "AnnotationConsolidationLambdaArn": { - "target": "com.amazonaws.sagemaker#LambdaFunctionArn", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Lambda function used to consolidate the\n annotations from individual workers into a label for a data object. For more\n information, see Annotation\n Consolidation.

    " + "smithy.api#documentation": "

    If the LabelingJobStatus field is Failed, this field\n contains a description of the error.

    " } }, - "LabelCounters": { - "target": "com.amazonaws.sagemaker#LabelCounters", + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { - "smithy.api#documentation": "

    Counts showing the progress of the labeling job.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) assigned to the labeling job when it was\n created.

    ", "smithy.api#required": {} } }, - "InputConfig": { - "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", - "traits": { - "smithy.api#documentation": "

    Input configuration for the labeling job.

    " - } - }, - "LabelingJobName": { - "target": "com.amazonaws.sagemaker#LabelingJobName", + "LabelingJobStatus": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", "traits": { - "smithy.api#documentation": "

    The name of the labeling job.

    ", + "smithy.api#documentation": "

    The current status of the labeling job.

    ", "smithy.api#required": {} } }, @@ -11741,24 +11814,30 @@ "smithy.api#required": {} } }, - "WorkteamArn": { - "target": "com.amazonaws.sagemaker#WorkteamArn", + "AnnotationConsolidationLambdaArn": { + "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the work team assigned to the job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Lambda function used to consolidate the\n annotations from individual workers into a label for a data object. For more\n information, see Annotation\n Consolidation.

    " } }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", + "InputConfig": { + "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) assigned to the labeling job when it was\n created.

    ", + "smithy.api#documentation": "

    Input configuration for the labeling job.

    " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that the job was last modified (timestamp).

    ", "smithy.api#required": {} } }, - "LabelingJobOutput": { - "target": "com.amazonaws.sagemaker#LabelingJobOutput", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The location of the output produced by the labeling job.

    " + "smithy.api#documentation": "

    The date and time that the job was created (timestamp).

    ", + "smithy.api#required": {} } } }, @@ -11805,34 +11884,28 @@ "com.amazonaws.sagemaker#ListAlgorithmsInput": { "type": "structure", "members": { - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", - "traits": { - "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "

    A string in the algorithm name. This filter returns only algorithms whose name\n contains the specified string.

    " - } - }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { "smithy.api#documentation": "

    A filter that returns only algorithms created before the specified time\n (timestamp).

    " } }, + "SortBy": { + "target": "com.amazonaws.sagemaker#AlgorithmSortBy", + "traits": { + "smithy.api#documentation": "

    The parameter by which to sort the results. The default is\n CreationTime.

    " + } + }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { "smithy.api#documentation": "

    A filter that returns only algorithms created after the specified time\n (timestamp).

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    The maximum number of algorithms to return in the response.

    " + "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " } }, "NextToken": { @@ -11841,10 +11914,16 @@ "smithy.api#documentation": "

    If the response to a previous ListAlgorithms request was truncated, the\n response includes a NextToken. To retrieve the next set of algorithms, use\n the token in the next request.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#AlgorithmSortBy", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    The parameter by which to sort the results. The default is\n CreationTime.

    " + "smithy.api#documentation": "

    The maximum number of algorithms to return in the response.

    " + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

    A string in the algorithm name. This filter returns only algorithms whose name\n contains the specified string.

    " } } } @@ -11852,18 +11931,18 @@ "com.amazonaws.sagemaker#ListAlgorithmsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.

    " - } - }, "AlgorithmSummaryList": { "target": "com.amazonaws.sagemaker#AlgorithmSummaryList", "traits": { "smithy.api#documentation": "

    >An array of AlgorithmSummary objects, each of which lists an\n algorithm.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.

    " + } } } }, @@ -11887,16 +11966,16 @@ "com.amazonaws.sagemaker#ListAppsRequest": { "type": "structure", "members": { - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "DomainIdEquals": { + "target": "com.amazonaws.sagemaker#DomainId", "traits": { - "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " + "smithy.api#documentation": "

    A parameter to search for the domain ID.

    " } }, - "UserProfileNameEquals": { - "target": "com.amazonaws.sagemaker#UserProfileName", + "SortBy": { + "target": "com.amazonaws.sagemaker#AppSortKey", "traits": { - "smithy.api#documentation": "

    A parameter to search by user profile name.

    " + "smithy.api#documentation": "

    The parameter by which to sort the results. The default is CreationTime.

    " } }, "NextToken": { @@ -11911,16 +11990,16 @@ "smithy.api#documentation": "

    Returns a list up to a specified limit.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#AppSortKey", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    The parameter by which to sort the results. The default is CreationTime.

    " + "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " } }, - "DomainIdEquals": { - "target": "com.amazonaws.sagemaker#DomainId", + "UserProfileNameEquals": { + "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

    A parameter to search for the domain ID.

    " + "smithy.api#documentation": "

    A parameter to search by user profile name.

    " } } } @@ -11928,17 +12007,17 @@ "com.amazonaws.sagemaker#ListAppsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.

    " - } - }, "Apps": { "target": "com.amazonaws.sagemaker#AppList", "traits": { "smithy.api#documentation": "

    The list of apps.

    " } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.

    " + } } } }, @@ -11962,16 +12041,10 @@ "com.amazonaws.sagemaker#ListAutoMLJobsRequest": { "type": "structure", "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#AutoMLSortBy", - "traits": { - "smithy.api#documentation": "

    The parameter by which to sort the results. The default is AutoMLJobName.

    " - } - }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "SortOrder": { + "target": "com.amazonaws.sagemaker#AutoMLSortOrder", "traits": { - "smithy.api#documentation": "

    Request a list of jobs, using a filter for time.

    " + "smithy.api#documentation": "

    The sort order for the results. The default is Descending.

    " } }, "StatusEquals": { @@ -11980,47 +12053,53 @@ "smithy.api#documentation": "

    Request a list of jobs, using a filter for status.

    " } }, - "LastModifiedTimeBefore": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#AutoMLMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    Request a list of jobs up to a specified limit.

    " + } + }, + "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { "smithy.api#documentation": "

    Request a list of jobs, using a filter for time.

    " } }, - "CreationTimeAfter": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { "smithy.api#documentation": "

    Request a list of jobs, using a filter for time.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#AutoMLNameContains", + "SortBy": { + "target": "com.amazonaws.sagemaker#AutoMLSortBy", "traits": { - "smithy.api#documentation": "

    Request a list of jobs, using a search filter for name.

    " + "smithy.api#documentation": "

    The parameter by which to sort the results. The default is AutoMLJobName.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#AutoMLSortOrder", + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The sort order for the results. The default is Descending.

    " + "smithy.api#documentation": "

    Request a list of jobs, using a filter for time.

    " } }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

    " + "smithy.api#documentation": "

    If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

    " } }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NameContains": { + "target": "com.amazonaws.sagemaker#AutoMLNameContains", "traits": { - "smithy.api#documentation": "

    Request a list of jobs, using a filter for time.

    " + "smithy.api#documentation": "

    Request a list of jobs, using a search filter for name.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#AutoMLMaxResults", + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Request a list of jobs up to a specified limit.

    " + "smithy.api#documentation": "

    Request a list of jobs, using a filter for time.

    " } } } @@ -12028,18 +12107,18 @@ "com.amazonaws.sagemaker#ListAutoMLJobsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

    " + } + }, "AutoMLJobSummaries": { "target": "com.amazonaws.sagemaker#AutoMLJobSummaries", "traits": { "smithy.api#documentation": "

    Returns a summary list of jobs.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

    " - } } } }, @@ -12068,16 +12147,16 @@ "com.amazonaws.sagemaker#ListCandidatesForAutoMLJobRequest": { "type": "structure", "members": { - "StatusEquals": { - "target": "com.amazonaws.sagemaker#CandidateStatus", + "CandidateNameEquals": { + "target": "com.amazonaws.sagemaker#CandidateName", "traits": { - "smithy.api#documentation": "

    List the Candidates for the job and filter by status.

    " + "smithy.api#documentation": "

    List the Candidates for the job and filter by candidate name.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#CandidateSortBy", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    The parameter by which to sort the results. The default is Descending.

    " + "smithy.api#documentation": "

    If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

    " } }, "SortOrder": { @@ -12086,6 +12165,12 @@ "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " } }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#CandidateStatus", + "traits": { + "smithy.api#documentation": "

    List the Candidates for the job and filter by status.

    " + } + }, "MaxResults": { "target": "com.amazonaws.sagemaker#AutoMLMaxResults", "traits": { @@ -12100,16 +12185,10 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

    " - } - }, - "CandidateNameEquals": { - "target": "com.amazonaws.sagemaker#CandidateName", + "SortBy": { + "target": "com.amazonaws.sagemaker#CandidateSortBy", "traits": { - "smithy.api#documentation": "

    List the Candidates for the job and filter by candidate name.

    " + "smithy.api#documentation": "

    The parameter by which to sort the results. The default is Descending.

    " } } } @@ -12127,7 +12206,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.

    " + "smithy.api#documentation": "

    If the previous response was truncated, you receive this token. Use it in your next\n request to receive the next set of results.

    " } } } @@ -12152,16 +12231,16 @@ "com.amazonaws.sagemaker#ListCodeRepositoriesInput": { "type": "structure", "members": { - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that returns only Git repositories that were last modified after the\n specified time.

    " + "smithy.api#documentation": "

    If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameContains", + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A string in the Git repositories name. This filter returns only repositories whose\n name contains the specified string.

    " + "smithy.api#documentation": "

    A filter that returns only Git repositories that were created after the specified\n time.

    " } }, "LastModifiedTimeBefore": { @@ -12170,16 +12249,10 @@ "smithy.api#documentation": "

    A filter that returns only Git repositories that were last modified before the\n specified time.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", - "traits": { - "smithy.api#documentation": "

    A filter that returns only Git repositories that were created before the specified\n time.

    " - } - }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", + "SortBy": { + "target": "com.amazonaws.sagemaker#CodeRepositorySortBy", "traits": { - "smithy.api#documentation": "

    A filter that returns only Git repositories that were created after the specified\n time.

    " + "smithy.api#documentation": "

    The field to sort results by. The default is Name.

    " } }, "SortOrder": { @@ -12188,10 +12261,10 @@ "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    If the result of a ListCodeRepositoriesOutput request was truncated, the\n response includes a NextToken. To get the next set of Git repositories, use\n the token in the next request.

    " + "smithy.api#documentation": "

    A filter that returns only Git repositories that were created before the specified\n time.

    " } }, "MaxResults": { @@ -12200,10 +12273,16 @@ "smithy.api#documentation": "

    The maximum number of Git repositories to return in the response.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#CodeRepositorySortBy", + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The field to sort results by. The default is Name.

    " + "smithy.api#documentation": "

    A filter that returns only Git repositories that were last modified after the\n specified time.

    " + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameContains", + "traits": { + "smithy.api#documentation": "

    A string in the Git repositories name. This filter returns only repositories whose\n name contains the specified string.

    " } } } @@ -12246,16 +12325,17 @@ "com.amazonaws.sagemaker#ListCompilationJobsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of model compilation jobs to return in the response.

    " } }, - "CreationTimeAfter": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A filter that returns the model compilation jobs that were created after a specified\n time.

    " + "smithy.api#documentation": "

    A filter that returns the model compilation jobs that were created before a specified\n time.

    " } }, "LastModifiedTimeBefore": { @@ -12264,23 +12344,10 @@ "smithy.api#documentation": "

    A filter that returns the model compilation jobs that were modified before a specified\n time.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ListCompilationJobsSortBy", - "traits": { - "smithy.api#documentation": "

    The field by which to sort results. The default is CreationTime.

    " - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "

    A filter that returns the model compilation jobs whose name contains a specified\n string.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#CompilationJobStatus", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of model compilation jobs to return in the response.

    " + "smithy.api#documentation": "

    A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

    " } }, "LastModifiedTimeAfter": { @@ -12289,22 +12356,34 @@ "smithy.api#documentation": "

    A filter that returns the model compilation jobs that were modified after a specified\n time.

    " } }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

    A filter that returns the model compilation jobs whose name contains a specified\n string.

    " + } + }, "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#CompilationJobStatus", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

    " + "smithy.api#documentation": "

    If the result of the previous ListCompilationJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n compilation jobs, use the token in the next request.

    " } }, - "CreationTimeBefore": { + "SortBy": { + "target": "com.amazonaws.sagemaker#ListCompilationJobsSortBy", + "traits": { + "smithy.api#documentation": "

    The field by which to sort results. The default is CreationTime.

    " + } + }, + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A filter that returns the model compilation jobs that were created before a specified\n time.

    " + "smithy.api#documentation": "

    A filter that returns the model compilation jobs that were created after a specified\n time.

    " } } } @@ -12366,17 +12445,17 @@ "com.amazonaws.sagemaker#ListDomainsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "

    Returns a list up to a specified limit.

    " - } - }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

    Returns a list up to a specified limit.

    " + } } } }, @@ -12417,22 +12496,16 @@ "com.amazonaws.sagemaker#ListEndpointConfigsInput": { "type": "structure", "members": { - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    A filter that returns only endpoint configurations created before the specified\n time (timestamp).

    " - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#EndpointConfigNameContains", + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", "traits": { - "smithy.api#documentation": "

    A string in the endpoint configuration name. This filter returns only endpoint\n configurations whose name contains the specified string.

    " + "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " } }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only endpoint configurations with a creation time greater\n than or equal to the specified time (timestamp).

    " + "smithy.api#documentation": "

    The maximum number of training jobs to return in the response.

    " } }, "NextToken": { @@ -12441,22 +12514,28 @@ "smithy.api#documentation": "

    If the result of the previous ListEndpointConfig request was\n truncated, the response includes a NextToken. To retrieve the next set of\n endpoint configurations, use the token in the next request.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "SortBy": { + "target": "com.amazonaws.sagemaker#EndpointConfigSortKey", "traits": { - "smithy.api#documentation": "

    The maximum number of training jobs to return in the response.

    " + "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#EndpointConfigSortKey", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A filter that returns only endpoint configurations created before the specified\n time (timestamp).

    " + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " + "smithy.api#documentation": "

    A filter that returns only endpoint configurations with a creation time greater\n than or equal to the specified time (timestamp).

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#OrderKey", + "NameContains": { + "target": "com.amazonaws.sagemaker#EndpointConfigNameContains", "traits": { - "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " + "smithy.api#documentation": "

    A string in the endpoint configuration name. This filter returns only endpoint\n configurations whose name contains the specified string.

    " } } } @@ -12499,16 +12578,22 @@ "com.amazonaws.sagemaker#ListEndpointsInput": { "type": "structure", "members": { - "StatusEquals": { - "target": "com.amazonaws.sagemaker#EndpointStatus", + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", "traits": { - "smithy.api#documentation": "

    A filter that returns only endpoints with the specified status.

    " + "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " } }, - "LastModifiedTimeAfter": { + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only endpoints that were modified after the specified\n timestamp.

    " + "smithy.api#documentation": "

    A filter that returns only endpoints with a creation time greater than or equal to\n the specified time (timestamp).

    " + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#EndpointNameContains", + "traits": { + "smithy.api#documentation": "

    A string in endpoint names. This filter returns only endpoints whose name contains\n the specified string.

    " } }, "SortBy": { @@ -12517,10 +12602,10 @@ "smithy.api#documentation": "

    Sorts the list of results. The default is CreationTime.

    " } }, - "CreationTimeBefore": { + "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only endpoints that were created before the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only endpoints that were modified after the specified\n timestamp.

    " } }, "NextToken": { @@ -12535,28 +12620,22 @@ "smithy.api#documentation": "

    The maximum number of endpoints to return in the response.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#EndpointNameContains", - "traits": { - "smithy.api#documentation": "

    A string in endpoint names. This filter returns only endpoints whose name contains\n the specified string.

    " - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#OrderKey", + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " + "smithy.api#documentation": "

    A filter that returns only endpoints that were modified before the specified\n timestamp.

    " } }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "

    A filter that returns only endpoints with a creation time greater than or equal to\n the specified time (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only endpoints with the specified status.

    " } }, - "LastModifiedTimeBefore": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only endpoints that were modified before the specified\n timestamp.

    " + "smithy.api#documentation": "

    A filter that returns only endpoints that were created before the specified time\n (timestamp).

    " } } } @@ -12564,18 +12643,18 @@ "com.amazonaws.sagemaker#ListEndpointsOutput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

    " + } + }, "Endpoints": { "target": "com.amazonaws.sagemaker#EndpointSummaryList", "traits": { "smithy.api#documentation": "

    An array or endpoint objects.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

    " - } } } }, @@ -12599,22 +12678,22 @@ "com.amazonaws.sagemaker#ListExperimentsRequest": { "type": "structure", "members": { - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    The sort order. The default value is Descending.

    " + "smithy.api#documentation": "

    If the previous call to ListExperiments didn't return the full set of\n experiments, the call returns a token for getting the next set of experiments.

    " } }, - "CreatedBefore": { + "CreatedAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only experiments created before the specified time.

    " + "smithy.api#documentation": "

    A filter that returns only experiments created after the specified time.

    " } }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only experiments created after the specified time.

    " + "smithy.api#documentation": "

    The maximum number of experiments to return in the response. The default value is\n 10.

    " } }, "SortBy": { @@ -12623,16 +12702,16 @@ "smithy.api#documentation": "

    The property used to sort results. The default value is CreationTime.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    If the previous call to ListExperiments didn't return the full set of\n experiments, the call returns a token for getting the next set of experiments.

    " + "smithy.api#documentation": "

    The sort order. The default value is Descending.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The maximum number of experiments to return in the response. The default value is\n 10.

    " + "smithy.api#documentation": "

    A filter that returns only experiments created before the specified time.

    " } } } @@ -12674,10 +12753,10 @@ "com.amazonaws.sagemaker#ListFlowDefinitionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A token to resume pagination.

    " + "smithy.api#documentation": "

    A filter that returns only flow definitions that were created before the specified timestamp.

    " } }, "SortOrder": { @@ -12686,12 +12765,6 @@ "smithy.api#documentation": "

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    " } }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

    " - } - }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { @@ -12699,10 +12772,16 @@ "smithy.api#documentation": "

    The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

    " } }, - "CreationTimeBefore": { + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only flow definitions that were created before the specified timestamp.

    " + "smithy.api#documentation": "

    A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    A token to resume pagination.

    " } } } @@ -12745,6 +12824,18 @@ "com.amazonaws.sagemaker#ListHumanTaskUisRequest": { "type": "structure", "members": { + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    A token to resume pagination.

    " + } + }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { @@ -12752,28 +12843,16 @@ "smithy.api#documentation": "

    The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    A filter that returns only human task user interfaces that were created before the specified timestamp.

    " - } - }, "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { "smithy.api#documentation": "

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    A token to resume pagination.

    " - } - }, - "CreationTimeAfter": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

    " + "smithy.api#documentation": "

    A filter that returns only human task user interfaces that were created before the specified timestamp.

    " } } } @@ -12781,18 +12860,18 @@ "com.amazonaws.sagemaker#ListHumanTaskUisResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    A token to resume pagination.

    " + } + }, "HumanTaskUiSummaries": { "target": "com.amazonaws.sagemaker#HumanTaskUiSummaries", "traits": { "smithy.api#documentation": "

    An array of objects describing the human task user interfaces.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    A token to resume pagination.

    " - } } } }, @@ -12816,34 +12895,22 @@ "com.amazonaws.sagemaker#ListHyperParameterTuningJobsRequest": { "type": "structure", "members": { - "CreationTimeAfter": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only tuning jobs that were created after the\n specified\n time.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the result of the previous ListHyperParameterTuningJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n tuning jobs, use the token in the next request.

    " - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", - "traits": { - "smithy.api#documentation": "

    A string in the tuning job name. This filter returns only tuning jobs whose name\n contains the specified string.

    " + "smithy.api#documentation": "

    A filter that returns only tuning jobs that were created before the\n specified\n time.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", "traits": { - "smithy.api#documentation": "

    A filter that returns only tuning jobs that were created before the\n specified\n time.

    " + "smithy.api#documentation": "

    A filter that returns only tuning jobs with the\n specified\n status.

    " } }, - "LastModifiedTimeBefore": { + "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only tuning jobs that were modified before the specified\n time.

    " + "smithy.api#documentation": "

    A filter that returns only tuning jobs that were modified after the specified\n time.

    " } }, "MaxResults": { @@ -12853,16 +12920,10 @@ "smithy.api#documentation": "

    The\n maximum number of tuning jobs to return. The default value is\n 10.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", - "traits": { - "smithy.api#documentation": "

    A filter that returns only tuning jobs with the\n specified\n status.

    " - } - }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that returns only tuning jobs that were modified after the specified\n time.

    " + "smithy.api#documentation": "

    If the result of the previous ListHyperParameterTuningJobs request was\n truncated, the response includes a NextToken. To retrieve the next set of\n tuning jobs, use the token in the next request.

    " } }, "SortBy": { @@ -12876,6 +12937,24 @@ "traits": { "smithy.api#documentation": "

    The sort\n order\n for results. The default is Ascending.

    " } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

    A string in the tuning job name. This filter returns only tuning jobs whose name\n contains the specified string.

    " + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A filter that returns only tuning jobs that were created after the\n specified\n time.

    " + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A filter that returns only tuning jobs that were modified before the specified\n time.

    " + } } } }, @@ -12939,36 +13018,18 @@ "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamRequest": { "type": "structure", "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions", - "traits": { - "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " - } - }, "JobReferenceCodeContains": { "target": "com.amazonaws.sagemaker#JobReferenceCodeContains", "traits": { "smithy.api#documentation": "

    A filter the limits jobs to only the ones whose job reference code contains the\n specified string.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the result of the previous ListLabelingJobsForWorkteam request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.

    " - } - }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { "smithy.api#documentation": "

    The maximum number of labeling jobs to return in each page of the response.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    A filter that returns only labeling jobs created before the specified time\n (timestamp).

    " - } - }, "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { @@ -12987,6 +13048,24 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the work team for which you want to see labeling\n jobs for.

    ", "smithy.api#required": {} } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListLabelingJobsForWorkteamSortByOptions", + "traits": { + "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A filter that returns only labeling jobs created before the specified time\n (timestamp).

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the result of the previous ListLabelingJobsForWorkteam request was\n truncated, the response includes a NextToken. To retrieve the next set of\n labeling jobs, use the token in the next request.

    " + } } } }, @@ -13022,28 +13101,34 @@ "com.amazonaws.sagemaker#ListLabelingJobsRequest": { "type": "structure", "members": { - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A string in the labeling job name. This filter returns only labeling jobs whose name\n contains the specified string.

    " + "smithy.api#documentation": "

    A filter that returns only labeling jobs created before the specified time\n (timestamp).

    " + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#LabelingJobStatus", + "traits": { + "smithy.api#documentation": "

    A filter that retrieves only labeling jobs with a specific status.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    If the result of the previous ListLabelingJobs request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.

    " + "smithy.api#documentation": "

    A filter that returns only labeling jobs modified before the specified time\n (timestamp).

    " } }, - "CreationTimeAfter": { + "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only labeling jobs created after the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only labeling jobs modified after the specified time\n (timestamp).

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " + "smithy.api#documentation": "

    A string in the labeling job name. This filter returns only labeling jobs whose name\n contains the specified string.

    " } }, "SortOrder": { @@ -13052,34 +13137,28 @@ "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#LabelingJobStatus", - "traits": { - "smithy.api#documentation": "

    A filter that retrieves only labeling jobs with a specific status.

    " - } - }, - "LastModifiedTimeAfter": { + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only labeling jobs modified after the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only labeling jobs created after the specified time\n (timestamp).

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", "traits": { - "smithy.api#documentation": "

    The maximum number of labeling jobs to return in each page of the response.

    " + "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that returns only labeling jobs created before the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    If the result of the previous ListLabelingJobs request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.

    " } }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only labeling jobs modified before the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    The maximum number of labeling jobs to return in each page of the response.

    " } } } @@ -13121,22 +13200,16 @@ "com.amazonaws.sagemaker#ListModelPackagesInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of model packages to return in the response.

    " - } - }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " + "smithy.api#documentation": "

    If the response to a previous ListModelPackages request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n packages, use the token in the next request.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ModelPackageSortBy", + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "

    The parameter by which to sort the results. The default is\n CreationTime.

    " + "smithy.api#documentation": "

    A string in the model package name. This filter returns only model packages whose name\n contains the specified string.

    " } }, "CreationTimeAfter": { @@ -13151,16 +13224,22 @@ "smithy.api#documentation": "

    A filter that returns only model packages created before the specified time\n (timestamp).

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    If the response to a previous ListModelPackages request was truncated,\n the response includes a NextToken. To retrieve the next set of model\n packages, use the token in the next request.

    " + "smithy.api#documentation": "

    The maximum number of model packages to return in the response.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    A string in the model package name. This filter returns only model packages whose name\n contains the specified string.

    " + "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelPackageSortBy", + "traits": { + "smithy.api#documentation": "

    The parameter by which to sort the results. The default is\n CreationTime.

    " } } } @@ -13168,18 +13247,18 @@ "com.amazonaws.sagemaker#ListModelPackagesOutput": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.

    " + } + }, "ModelPackageSummaryList": { "target": "com.amazonaws.sagemaker#ModelPackageSummaryList", "traits": { "smithy.api#documentation": "

    An array of ModelPackageSummary objects, each of which lists a model\n package.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.

    " - } } } }, @@ -13203,28 +13282,28 @@ "com.amazonaws.sagemaker#ListModelsInput": { "type": "structure", "members": { - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "SortBy": { + "target": "com.amazonaws.sagemaker#ModelSortKey", "traits": { - "smithy.api#documentation": "

    A filter that returns only models with a creation time greater than or equal to the\n specified time (timestamp).

    " + "smithy.api#documentation": "

    Sorts the list of results. The default is CreationTime.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#PaginationToken", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    If the response to a previous ListModels request was truncated, the\n response includes a NextToken. To retrieve the next set of models, use the\n token in the next request.

    " + "smithy.api#documentation": "

    A filter that returns only models created before the specified time\n (timestamp).

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#ModelNameContains", + "SortOrder": { + "target": "com.amazonaws.sagemaker#OrderKey", "traits": { - "smithy.api#documentation": "

    A string in the training job name. This filter returns only models in the training\n job whose name contains the specified string.

    " + "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "

    A filter that returns only models created before the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    If the response to a previous ListModels request was truncated, the\n response includes a NextToken. To retrieve the next set of models, use the\n token in the next request.

    " } }, "MaxResults": { @@ -13233,16 +13312,16 @@ "smithy.api#documentation": "

    The maximum number of models to return in the response.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#ModelSortKey", + "NameContains": { + "target": "com.amazonaws.sagemaker#ModelNameContains", "traits": { - "smithy.api#documentation": "

    Sorts the list of results. The default is CreationTime.

    " + "smithy.api#documentation": "

    A string in the training job name. This filter returns only models in the training\n job whose name contains the specified string.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#OrderKey", + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " + "smithy.api#documentation": "

    A filter that returns only models with a creation time greater than or equal to the\n specified time (timestamp).

    " } } } @@ -13250,18 +13329,18 @@ "com.amazonaws.sagemaker#ListModelsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.

    " - } - }, "Models": { "target": "com.amazonaws.sagemaker#ModelSummaryList", "traits": { "smithy.api#documentation": "

    An array of ModelSummary objects, each of which lists a\n model.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.

    " + } } } }, @@ -13291,22 +13370,22 @@ "smithy.api#documentation": "

    Whether to sort the results in Ascending or Descending order.\n The default is Descending.

    " } }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "

    A filter that returns only jobs modified after a specified time.

    " + "smithy.api#documentation": "

    Name of a specific schedule to fetch jobs for.

    " } }, - "LastModifiedTimeAfter": { + "ScheduledTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only jobs modified before a specified time.

    " + "smithy.api#documentation": "

    Filter for jobs scheduled after a specified time.

    " } }, - "ScheduledTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    Filter for jobs scheduled after a specified time.

    " + "smithy.api#documentation": "

    The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.

    " } }, "MaxResults": { @@ -13315,52 +13394,52 @@ "smithy.api#documentation": "

    The maximum number of jobs to return in the response. The default value is 10.

    " } }, - "ScheduledTimeBefore": { + "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Filter for jobs scheduled before a specified time.

    " + "smithy.api#documentation": "

    A filter that returns only jobs modified after a specified time.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringExecutionSortKey", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ExecutionStatus", "traits": { - "smithy.api#documentation": "

    Whether to sort results by Status, CreationTime,\n ScheduledTime field. The default is CreationTime.

    " + "smithy.api#documentation": "

    A filter that retrieves only jobs with a specific status.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.

    " + "smithy.api#documentation": "

    A filter that returns only jobs modified before a specified time.

    " } }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Name of a specific endpoint to fetch jobs for.

    " + "smithy.api#documentation": "

    A filter that returns only jobs created before a specified time.

    " } }, - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringExecutionSortKey", "traits": { - "smithy.api#documentation": "

    Name of a specific schedule to fetch jobs for.

    " + "smithy.api#documentation": "

    Whether to sort results by Status, CreationTime,\n ScheduledTime field. The default is CreationTime.

    " } }, - "CreationTimeBefore": { + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only jobs created before a specified time.

    " + "smithy.api#documentation": "

    A filter that returns only jobs created after a specified time.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#ExecutionStatus", + "ScheduledTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that retrieves only jobs with a specific status.

    " + "smithy.api#documentation": "

    Filter for jobs scheduled before a specified time.

    " } }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    A filter that returns only jobs created after a specified time.

    " + "smithy.api#documentation": "

    Name of a specific endpoint to fetch jobs for.

    " } } } @@ -13403,70 +13482,70 @@ "com.amazonaws.sagemaker#ListMonitoringSchedulesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "

    The maximum number of jobs to return in the response. The default value is 10.

    " + "smithy.api#documentation": "

    Filter for monitoring schedules whose name contains a specified string.

    " } }, - "LastModifiedTimeAfter": { + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only monitoring schedules modified after a specified time.

    " + "smithy.api#documentation": "

    A filter that returns only monitoring schedules created after a specified time.

    " } }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Name of a specific endpoint to fetch schedules for.

    " + "smithy.api#documentation": "

    A filter that returns only monitoring schedules modified before a specified time.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleSortKey", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ScheduleStatus", "traits": { - "smithy.api#documentation": "

    Whether to sort results by Status, CreationTime,\n ScheduledTime field. The default is CreationTime.

    " + "smithy.api#documentation": "

    A filter that returns only monitoring schedules modified before a specified time.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    Whether to sort the results in Ascending or Descending order.\n The default is Descending.

    " + "smithy.api#documentation": "

    Name of a specific endpoint to fetch schedules for.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.

    " + "smithy.api#documentation": "

    A filter that returns only monitoring schedules modified after a specified time.

    " } }, - "CreationTimeAfter": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only monitoring schedules created after a specified time.

    " + "smithy.api#documentation": "

    A filter that returns only monitoring schedules created before a specified time.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    Filter for monitoring schedules whose name contains a specified string.

    " + "smithy.api#documentation": "

    The maximum number of jobs to return in the response. The default value is 10.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that returns only monitoring schedules created before a specified time.

    " + "smithy.api#documentation": "

    The token returned if the response is truncated. To retrieve the next set of job\n executions, use it in the next request.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#ScheduleStatus", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    A filter that returns only monitoring schedules modified before a specified time.

    " + "smithy.api#documentation": "

    Whether to sort the results in Ascending or Descending order.\n The default is Descending.

    " } }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "SortBy": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleSortKey", "traits": { - "smithy.api#documentation": "

    A filter that returns only monitoring schedules modified before a specified time.

    " + "smithy.api#documentation": "

    Whether to sort results by Status, CreationTime,\n ScheduledTime field. The default is CreationTime.

    " } } } @@ -13509,28 +13588,28 @@ "com.amazonaws.sagemaker#ListNotebookInstanceLifecycleConfigsInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "SortOrder": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortOrder", "traits": { - "smithy.api#documentation": "

    The maximum number of lifecycle configurations to return in the response.

    " + "smithy.api#documentation": "

    The sort order for results.

    " } }, - "LastModifiedTimeAfter": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", + "NameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains", "traits": { - "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were modified after the\n specified time (timestamp).

    " + "smithy.api#documentation": "

    A string in the lifecycle configuration name. This filter returns only lifecycle\n configurations whose name contains the specified string.

    " } }, - "CreationTimeBefore": { + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were created before the\n specified time (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were created after the\n specified time (timestamp).

    " } }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were modified before the\n specified time (timestamp).

    " + "smithy.api#documentation": "

    The maximum number of lifecycle configurations to return in the response.

    " } }, "NextToken": { @@ -13539,28 +13618,28 @@ "smithy.api#documentation": "

    If the result of a ListNotebookInstanceLifecycleConfigs request was\n truncated, the response includes a NextToken. To get the next set of\n lifecycle configurations, use the token in the next request.

    " } }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#CreationTime", + "SortBy": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey", "traits": { - "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were created after the\n specified time (timestamp).

    " + "smithy.api#documentation": "

    Sorts the list of results. The default is CreationTime.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigNameContains", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A string in the lifecycle configuration name. This filter returns only lifecycle\n configurations whose name contains the specified string.

    " + "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were created before the\n specified time (timestamp).

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortKey", + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "

    Sorts the list of results. The default is CreationTime.

    " + "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were modified after the\n specified time (timestamp).

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSortOrder", + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "

    The sort order for results.

    " + "smithy.api#documentation": "

    A filter that returns only lifecycle configurations that were modified before the\n specified time (timestamp).

    " } } } @@ -13602,10 +13681,10 @@ "com.amazonaws.sagemaker#ListNotebookInstancesInput": { "type": "structure", "members": { - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A filter that returns only notebook instances that were modified before the\n specified time (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only notebook instances that were created after the specified\n time (timestamp).

    " } }, "NotebookInstanceLifecycleConfigNameContains": { @@ -13626,10 +13705,16 @@ "smithy.api#documentation": "

    The field to sort results by. The default is Name.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#NotebookInstanceSortOrder", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", "traits": { - "smithy.api#documentation": "

    The sort order for results.

    " + "smithy.api#documentation": "

    A filter that returns only notebook instances with the specified status.

    " + } + }, + "AdditionalCodeRepositoryEquals": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "traits": { + "smithy.api#documentation": "

    A filter that returns only notebook instances with associated with the specified git\n repository.

    " } }, "LastModifiedTimeAfter": { @@ -13638,46 +13723,40 @@ "smithy.api#documentation": "

    A filter that returns only notebook instances that were modified after the\n specified time (timestamp).

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "

    The maximum number of notebook instances to return.

    " + "smithy.api#documentation": "

    A filter that returns only notebook instances that were modified before the\n specified time (timestamp).

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#CreationTime", + "NameContains": { + "target": "com.amazonaws.sagemaker#NotebookInstanceNameContains", "traits": { - "smithy.api#documentation": "

    A filter that returns only notebook instances that were created before the\n specified time (timestamp).

    " + "smithy.api#documentation": "

    A string in the notebook instances' name. This filter returns only notebook\n instances whose name contains the specified string.

    " } }, - "DefaultCodeRepositoryContains": { - "target": "com.amazonaws.sagemaker#CodeRepositoryContains", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A string in the name or URL of a Git repository associated with this notebook\n instance. This filter returns only notebook instances associated with a git repository\n with a name that contains the specified string.

    " + "smithy.api#documentation": "

    The maximum number of notebook instances to return.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "SortOrder": { + "target": "com.amazonaws.sagemaker#NotebookInstanceSortOrder", "traits": { - "smithy.api#documentation": "

    A filter that returns only notebook instances with the specified status.

    " + "smithy.api#documentation": "

    The sort order for results.

    " } }, - "CreationTimeAfter": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A filter that returns only notebook instances that were created after the specified\n time (timestamp).

    " - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NotebookInstanceNameContains", - "traits": { - "smithy.api#documentation": "

    A string in the notebook instances' name. This filter returns only notebook\n instances whose name contains the specified string.

    " + "smithy.api#documentation": "

    A filter that returns only notebook instances that were created before the\n specified time (timestamp).

    " } }, - "AdditionalCodeRepositoryEquals": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", + "DefaultCodeRepositoryContains": { + "target": "com.amazonaws.sagemaker#CodeRepositoryContains", "traits": { - "smithy.api#documentation": "

    A filter that returns only notebook instances with associated with the specified git\n repository.

    " + "smithy.api#documentation": "

    A string in the name or URL of a Git repository associated with this notebook\n instance. This filter returns only notebook instances associated with a git repository\n with a name that contains the specified string.

    " } } } @@ -13685,17 +13764,17 @@ "com.amazonaws.sagemaker#ListNotebookInstancesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the response to the previous ListNotebookInstances request was\n truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use\n the token in the next request.

    " - } - }, "NotebookInstances": { "target": "com.amazonaws.sagemaker#NotebookInstanceSummaryList", "traits": { "smithy.api#documentation": "

    An array of NotebookInstanceSummary objects, one for each notebook\n instance.

    " } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the response to the previous ListNotebookInstances request was\n truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use\n the token in the next request.

    " + } } } }, @@ -13719,16 +13798,23 @@ "com.amazonaws.sagemaker#ListProcessingJobsRequest": { "type": "structure", "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " + "smithy.api#documentation": "

    A filter that returns only processing jobs modified after the specified time.

    " } }, - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only processing jobs created after the specified time.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of processing jobs to return in the response.

    " + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    A string in the processing job name. This filter returns only processing jobs whose\n name contains the specified string.

    " } }, "CreationTimeAfter": { @@ -13743,41 +13829,34 @@ "smithy.api#documentation": "

    A filter that returns only processing jobs modified before the specified time.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that retrieves only processing jobs with a specific status.

    " + "smithy.api#documentation": "

    If the result of the previous ListProcessingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of processing\n jobs, use the token in the next request.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", "traits": { - "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " + "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    If the result of the previous ListProcessingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of processing\n jobs, use the token in the next request.

    " + "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of processing jobs to return in the response.

    " + "smithy.api#documentation": "

    A filter that retrieves only processing jobs with a specific status.

    " } }, - "LastModifiedTimeAfter": { + "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only processing jobs modified after the specified time.

    " - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "

    A string in the processing job name. This filter returns only processing jobs whose\n name contains the specified string.

    " + "smithy.api#documentation": "

    A filter that returns only processing jobs created after the specified time.

    " } } } @@ -13820,6 +13899,13 @@ "com.amazonaws.sagemaker#ListSubscribedWorkteamsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of work teams to return in each page of the response.

    " + } + }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { @@ -13831,13 +13917,6 @@ "traits": { "smithy.api#documentation": "

    A string in the work team name. This filter returns only work teams whose name\n contains the specified string.

    " } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of work teams to return in each page of the response.

    " - } } } }, @@ -13879,11 +13958,10 @@ "com.amazonaws.sagemaker#ListTagsInput": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.sagemaker#ResourceArn", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource whose tags you want to\n retrieve.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the response to the previous ListTags request is truncated, Amazon SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n

    " } }, "MaxResults": { @@ -13892,10 +13970,11 @@ "smithy.api#documentation": "

    Maximum number of tags to return.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "ResourceArn": { + "target": "com.amazonaws.sagemaker#ResourceArn", "traits": { - "smithy.api#documentation": "

    If the response to the previous ListTags request is truncated, Amazon SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource whose tags you want to\n retrieve.

    ", + "smithy.api#required": {} } } } @@ -13968,22 +14047,17 @@ "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobRequest": { "type": "structure", "members": { - "SortBy": { - "target": "com.amazonaws.sagemaker#TrainingJobSortByOptions", - "traits": { - "smithy.api#documentation": "

    The field to sort\n results\n by. The default is Name.

    \n

    If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

    The maximum number of training jobs to return. The default value is 10.

    " + "smithy.api#documentation": "

    A filter that returns only training jobs with the\n specified\n status.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "HyperParameterTuningJobName": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", "traits": { - "smithy.api#documentation": "

    If the result of the previous ListTrainingJobsForHyperParameterTuningJob\n request was truncated, the response includes a NextToken. To retrieve the\n next set of training jobs, use the token in the next request.

    " + "smithy.api#documentation": "

    The name of the tuning job whose training jobs you want to list.

    ", + "smithy.api#required": {} } }, "SortOrder": { @@ -13992,17 +14066,22 @@ "smithy.api#documentation": "

    The sort order\n for\n results. The default is Ascending.

    " } }, - "HyperParameterTuningJobName": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", + "SortBy": { + "target": "com.amazonaws.sagemaker#TrainingJobSortByOptions", "traits": { - "smithy.api#documentation": "

    The name of the tuning job whose training jobs you want to list.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The field to sort\n results\n by. The default is Name.

    \n

    If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only training jobs with the\n specified\n status.

    " + "smithy.api#documentation": "

    The maximum number of training jobs to return. The default value is 10.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the result of the previous ListTrainingJobsForHyperParameterTuningJob\n request was truncated, the response includes a NextToken. To retrieve the\n next set of training jobs, use the token in the next request.

    " } } } @@ -14010,59 +14089,59 @@ "com.amazonaws.sagemaker#ListTrainingJobsForHyperParameterTuningJobResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the result of this ListTrainingJobsForHyperParameterTuningJob request\n was truncated, the response includes a NextToken. To retrieve the next set\n of training jobs, use the token in the next request.

    " + } + }, "TrainingJobSummaries": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummaries", "traits": { "smithy.api#documentation": "

    A list of TrainingJobSummary objects that\n describe\n the training jobs that the\n ListTrainingJobsForHyperParameterTuningJob request returned.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the result of this ListTrainingJobsForHyperParameterTuningJob request\n was truncated, the response includes a NextToken. To retrieve the next set\n of training jobs, use the token in the next request.

    " - } } } }, "com.amazonaws.sagemaker#ListTrainingJobsRequest": { "type": "structure", "members": { - "CreationTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only training jobs created before the specified time\n (timestamp).

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of training jobs to return in the response.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " + "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " } }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", "traits": { - "smithy.api#documentation": "

    A filter that returns only training jobs modified before the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    A string in the training job name. This filter returns only training jobs whose\n name contains the specified string.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of training jobs to return in the response.

    " + "smithy.api#documentation": "

    A filter that returns only training jobs created after the specified time\n (timestamp).

    " } }, - "LastModifiedTimeAfter": { + "LastModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only training jobs modified after the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only training jobs modified before the specified time\n (timestamp).

    " } }, - "StatusEquals": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", "traits": { - "smithy.api#documentation": "

    A filter that retrieves only training jobs with a specific status.

    " + "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " } }, "NextToken": { @@ -14071,22 +14150,22 @@ "smithy.api#documentation": "

    If the result of the previous ListTrainingJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of training\n jobs, use the token in the next request.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " + "smithy.api#documentation": "

    A filter that returns only training jobs created before the specified time\n (timestamp).

    " } }, - "CreationTimeAfter": { + "LastModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only training jobs created after the specified time\n (timestamp).

    " + "smithy.api#documentation": "

    A filter that returns only training jobs modified after the specified time\n (timestamp).

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

    A string in the training job name. This filter returns only training jobs whose\n name contains the specified string.

    " + "smithy.api#documentation": "

    A filter that retrieves only training jobs with a specific status.

    " } } } @@ -14094,18 +14173,18 @@ "com.amazonaws.sagemaker#ListTrainingJobsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

    " - } - }, "TrainingJobSummaries": { "target": "com.amazonaws.sagemaker#TrainingJobSummaries", "traits": { "smithy.api#documentation": "

    An array of TrainingJobSummary objects, each listing a training\n job.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

    " + } } } }, @@ -14129,16 +14208,16 @@ "com.amazonaws.sagemaker#ListTransformJobsRequest": { "type": "structure", "members": { - "StatusEquals": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that retrieves only transform jobs with a specific status.

    " + "smithy.api#documentation": "

    If the result of the previous ListTransformJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of transform\n jobs, use the token in the next request.

    " } }, - "LastModifiedTimeAfter": { + "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only transform jobs modified after the specified time.

    " + "smithy.api#documentation": "

    A filter that returns only transform jobs created after the specified time.

    " } }, "SortOrder": { @@ -14147,10 +14226,16 @@ "smithy.api#documentation": "

    The sort order for results. The default is Descending.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    If the result of the previous ListTransformJobs request was truncated,\n the response includes a NextToken. To retrieve the next set of transform\n jobs, use the token in the next request.

    " + "smithy.api#documentation": "

    A filter that returns only transform jobs modified before the specified time.

    " + } + }, + "NameContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "

    A string in the transform job name. This filter returns only transform jobs whose name\n contains the specified string.

    " } }, "MaxResults": { @@ -14160,16 +14245,16 @@ "smithy.api#documentation": "

    The maximum number of\n transform\n jobs to return in the response. The default value is\n 10.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortBy", + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " + "smithy.api#documentation": "

    A filter that returns only transform jobs modified after the specified time.

    " } }, - "LastModifiedTimeBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "StatusEquals": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", "traits": { - "smithy.api#documentation": "

    A filter that returns only transform jobs modified before the specified time.

    " + "smithy.api#documentation": "

    A filter that retrieves only transform jobs with a specific status.

    " } }, "CreationTimeBefore": { @@ -14178,16 +14263,10 @@ "smithy.api#documentation": "

    A filter that returns only transform jobs created before the specified time.

    " } }, - "CreationTimeAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    A filter that returns only transform jobs created after the specified time.

    " - } - }, - "NameContains": { - "target": "com.amazonaws.sagemaker#NameContains", + "SortBy": { + "target": "com.amazonaws.sagemaker#SortBy", "traits": { - "smithy.api#documentation": "

    A string in the transform job name. This filter returns only transform jobs whose name\n contains the specified string.

    " + "smithy.api#documentation": "

    The field to sort results by. The default is CreationTime.

    " } } } @@ -14241,46 +14320,46 @@ "com.amazonaws.sagemaker#ListTrialComponentsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "TrialName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    If the previous call to ListTrialComponents didn't return the full set of\n components, the call returns a token for getting the next set of components.

    " + "smithy.api#documentation": "

    A filter that returns only components that are part of the specified trial. If you specify\n TrialName, you can't filter by ExperimentName or\n SourceArn.

    " } }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    A filter that returns only components created before the specified time.

    " + "smithy.api#documentation": "

    A filter that returns only components that are part of the specified experiment. If you\n specify ExperimentName, you can't filter by SourceArn or\n TrialName.

    " } }, - "SourceArn": { - "target": "com.amazonaws.sagemaker#String256", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that returns only components that have the specified source Amazon Resource Name\n (ARN). If you specify SourceArn, you can't filter by ExperimentName\n or TrialName.

    " + "smithy.api#documentation": "

    If the previous call to ListTrialComponents didn't return the full set of\n components, the call returns a token for getting the next set of components.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "SourceArn": { + "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "

    The maximum number of components to return in the response. The default value is\n 10.

    " + "smithy.api#documentation": "

    A filter that returns only components that have the specified source Amazon Resource Name\n (ARN). If you specify SourceArn, you can't filter by ExperimentName\n or TrialName.

    " } }, - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only components that are part of the specified experiment. If you\n specify ExperimentName, you can't filter by SourceArn or\n TrialName.

    " + "smithy.api#documentation": "

    A filter that returns only components created after the specified time.

    " } }, - "TrialName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only components that are part of the specified trial. If you specify\n TrialName, you can't filter by ExperimentName or\n SourceArn.

    " + "smithy.api#documentation": "

    The maximum number of components to return in the response. The default value is\n 10.

    " } }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    A filter that returns only components created after the specified time.

    " + "smithy.api#documentation": "

    The sort order. The default value is Descending.

    " } }, "SortBy": { @@ -14289,10 +14368,10 @@ "smithy.api#documentation": "

    The property used to sort results. The default value is CreationTime.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The sort order. The default value is Descending.

    " + "smithy.api#documentation": "

    A filter that returns only components created before the specified time.

    " } } } @@ -14339,28 +14418,28 @@ "com.amazonaws.sagemaker#ListTrialsRequest": { "type": "structure", "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "SortBy": { + "target": "com.amazonaws.sagemaker#SortTrialsBy", "traits": { - "smithy.api#documentation": "

    A filter that returns only trials that are part of the specified experiment.

    " + "smithy.api#documentation": "

    The property used to sort results. The default value is CreationTime.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    If the previous call to ListTrials didn't return the full set of trials, the\n call returns a token for getting the next set of trials.

    " + "smithy.api#documentation": "

    A filter that returns only trials that are associated with the specified trial\n component.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The maximum number of trials to return in the response. The default value is 10.

    " + "smithy.api#documentation": "

    A filter that returns only trials that are part of the specified experiment.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#SortTrialsBy", + "CreatedBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The property used to sort results. The default value is CreationTime.

    " + "smithy.api#documentation": "

    A filter that returns only trials created before the specified time.

    " } }, "SortOrder": { @@ -14369,22 +14448,22 @@ "smithy.api#documentation": "

    The sort order. The default value is Descending.

    " } }, - "CreatedAfter": { - "target": "com.amazonaws.sagemaker#Timestamp", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter that returns only trials created after the specified time.

    " + "smithy.api#documentation": "

    If the previous call to ListTrials didn't return the full set of trials, the\n call returns a token for getting the next set of trials.

    " } }, - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "CreatedAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A filter that returns only trials that are associated with the specified trial\n component.

    " + "smithy.api#documentation": "

    A filter that returns only trials created after the specified time.

    " } }, - "CreatedBefore": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A filter that returns only trials created before the specified time.

    " + "smithy.api#documentation": "

    The maximum number of trials to return in the response. The default value is 10.

    " } } } @@ -14426,10 +14505,10 @@ "com.amazonaws.sagemaker#ListUserProfilesRequest": { "type": "structure", "members": { - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "DomainIdEquals": { + "target": "com.amazonaws.sagemaker#DomainId", "traits": { - "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " + "smithy.api#documentation": "

    A parameter by which to filter the results.

    " } }, "UserProfileNameContains": { @@ -14444,22 +14523,22 @@ "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.

    " } }, - "SortBy": { - "target": "com.amazonaws.sagemaker#UserProfileSortKey", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    The parameter by which to sort the results. The default is CreationTime.

    " + "smithy.api#documentation": "

    Returns a list up to a specified limit.

    " } }, - "DomainIdEquals": { - "target": "com.amazonaws.sagemaker#DomainId", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

    A parameter by which to filter the results.

    " + "smithy.api#documentation": "

    The sort order for the results. The default is Ascending.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "SortBy": { + "target": "com.amazonaws.sagemaker#UserProfileSortKey", "traits": { - "smithy.api#documentation": "

    Returns a list up to a specified limit.

    " + "smithy.api#documentation": "

    The parameter by which to sort the results. The default is CreationTime.

    " } } } @@ -14467,17 +14546,17 @@ "com.amazonaws.sagemaker#ListUserProfilesResponse": { "type": "structure", "members": { - "UserProfiles": { - "target": "com.amazonaws.sagemaker#UserProfileList", - "traits": { - "smithy.api#documentation": "

    The list of user profiles.

    " - } - }, "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { "smithy.api#documentation": "

    If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.

    " } + }, + "UserProfiles": { + "target": "com.amazonaws.sagemaker#UserProfileList", + "traits": { + "smithy.api#documentation": "

    The list of user profiles.

    " + } } } }, @@ -14501,10 +14580,11 @@ "com.amazonaws.sagemaker#ListWorkforcesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A token to resume pagination.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of workforces returned in the response.

    " } }, "SortBy": { @@ -14513,23 +14593,22 @@ "smithy.api#documentation": "

    Sort workforces using the workforce name or creation date.

    " } }, - "SortOrder": { - "target": "com.amazonaws.sagemaker#SortOrder", + "NameContains": { + "target": "com.amazonaws.sagemaker#WorkforceName", "traits": { - "smithy.api#documentation": "

    Sort workforces in ascending or descending order.

    " + "smithy.api#documentation": "

    A filter you can use to search for workforces using part of the workforce name.

    " } }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of workforces returned in the response.

    " + "smithy.api#documentation": "

    Sort workforces in ascending or descending order.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#WorkforceName", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    A filter you can use to search for workforces using part of the workforce name.

    " + "smithy.api#documentation": "

    A token to resume pagination.

    " } } } @@ -14537,18 +14616,18 @@ "com.amazonaws.sagemaker#ListWorkforcesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    A token to resume pagination.

    " - } - }, "Workforces": { "target": "com.amazonaws.sagemaker#Workforces", "traits": { "smithy.api#documentation": "

    A list containing information about your workforce.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    A token to resume pagination.

    " + } } } }, @@ -14576,7 +14655,7 @@ "target": "com.amazonaws.sagemaker#ListWorkteamsResponse" }, "traits": { - "smithy.api#documentation": "

    Gets a list of work teams that you have defined in a region. The list may be empty if\n no work team satisfies the filter specified in the NameContains\n parameter.

    ", + "smithy.api#documentation": "

    Gets a list of private work teams that you have defined in a region. The list may be empty if\n no work team satisfies the filter specified in the NameContains\n parameter.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -14587,17 +14666,10 @@ "com.amazonaws.sagemaker#ListWorkteamsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", - "traits": { - "smithy.api#documentation": "

    If the result of the previous ListWorkteams request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.

    " - } - }, - "MaxResults": { - "target": "com.amazonaws.sagemaker#MaxResults", + "NameContains": { + "target": "com.amazonaws.sagemaker#WorkteamName", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of work teams to return in each page of the response.

    " + "smithy.api#documentation": "

    A string in the work team's name. This filter returns only work teams whose name\n contains the specified string.

    " } }, "SortBy": { @@ -14612,10 +14684,17 @@ "smithy.api#documentation": "

    The sort order for results. The default is Ascending.

    " } }, - "NameContains": { - "target": "com.amazonaws.sagemaker#WorkteamName", + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

    A string in the work team's name. This filter returns only work teams whose name\n contains the specified string.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of work teams to return in each page of the response.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

    If the result of the previous ListWorkteams request was truncated, the\n response includes a NextToken. To retrieve the next set of labeling jobs,\n use the token in the next request.

    " } } } @@ -14783,21 +14862,21 @@ "com.amazonaws.sagemaker#MemberDefinition": { "type": "structure", "members": { - "CognitoMemberDefinition": { - "target": "com.amazonaws.sagemaker#CognitoMemberDefinition", + "OidcMemberDefinition": { + "target": "com.amazonaws.sagemaker#OidcMemberDefinition", "traits": { - "smithy.api#documentation": "

    The Amazon Cognito user group that is part of the work team.

    " + "smithy.api#documentation": "

    A list user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.

    " } }, - "OidcMemberDefinition": { - "target": "com.amazonaws.sagemaker#OidcMemberDefinition", + "CognitoMemberDefinition": { + "target": "com.amazonaws.sagemaker#CognitoMemberDefinition", "traits": { - "smithy.api#documentation": "

    A list user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.

    " + "smithy.api#documentation": "

    The Amazon Cognito user group that is part of the work team.

    " } } }, "traits": { - "smithy.api#documentation": "

    Defines the Amazon Cognito user group that is part of a work team.

    " + "smithy.api#documentation": "

    Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

    " } }, "com.amazonaws.sagemaker#MemberDefinitions": { @@ -14821,17 +14900,17 @@ "smithy.api#documentation": "

    The name of the metric.

    " } }, - "Timestamp": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date and time that the algorithm emitted the metric.

    " - } - }, "Value": { "target": "com.amazonaws.sagemaker#Float", "traits": { "smithy.api#documentation": "

    The value of the metric.

    " } + }, + "Timestamp": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that the algorithm emitted the metric.

    " + } } }, "traits": { @@ -14923,21 +15002,21 @@ "com.amazonaws.sagemaker#ModelClientConfig": { "type": "structure", "members": { - "InvocationsTimeoutInSeconds": { - "target": "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "

    The timeout value in seconds for an invocation request.

    " - } - }, "InvocationsMaxRetries": { "target": "com.amazonaws.sagemaker#InvocationsMaxRetries", "traits": { "smithy.api#documentation": "

    The maximum number of retries when invocation requests are failing.

    " } + }, + "InvocationsTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "

    The timeout value in seconds for an invocation request.

    " + } } }, "traits": { - "smithy.api#documentation": "

    Configures the timeout and maximum number of retries for processing a transform job invocation.

    " + "smithy.api#documentation": "

    Configures the timeout and maximum number of retries for processing a transform job\n invocation.

    " } }, "com.amazonaws.sagemaker#ModelName": { @@ -14973,22 +15052,16 @@ "com.amazonaws.sagemaker#ModelPackageContainerDefinition": { "type": "structure", "members": { - "ProductId": { - "target": "com.amazonaws.sagemaker#ProductId", + "ImageDigest": { + "target": "com.amazonaws.sagemaker#ImageDigest", "traits": { - "smithy.api#documentation": "

    The AWS Marketplace product ID of the model package.

    " + "smithy.api#documentation": "

    An MD5 hash of the training algorithm that identifies the Docker image used for\n training.

    " } }, "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

    The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

    " - } - }, - "ContainerHostname": { - "target": "com.amazonaws.sagemaker#ContainerHostname", - "traits": { - "smithy.api#documentation": "

    The DNS host name for the Docker container.

    " + "smithy.api#documentation": "

    The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

    \n \n

    The model artifacts must be in an S3 bucket that is in the same region as the\n model package.

    \n     " } }, "Image": { @@ -14998,10 +15071,16 @@ "smithy.api#required": {} } }, - "ImageDigest": { - "target": "com.amazonaws.sagemaker#ImageDigest", + "ContainerHostname": { + "target": "com.amazonaws.sagemaker#ContainerHostname", "traits": { - "smithy.api#documentation": "

    An MD5 hash of the training algorithm that identifies the Docker image used for\n training.

    " + "smithy.api#documentation": "

    The DNS host name for the Docker container.

    " + } + }, + "ProductId": { + "target": "com.amazonaws.sagemaker#ProductId", + "traits": { + "smithy.api#documentation": "

    The AWS Marketplace product ID of the model package.

    " } } }, @@ -15066,17 +15145,17 @@ "com.amazonaws.sagemaker#ModelPackageStatusDetails": { "type": "structure", "members": { - "ValidationStatuses": { + "ImageScanStatuses": { "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", "traits": { - "smithy.api#documentation": "

    The validation status of the model package.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The status of the scan of the Docker image container for the model package.

    " } }, - "ImageScanStatuses": { + "ValidationStatuses": { "target": "com.amazonaws.sagemaker#ModelPackageStatusItemList", "traits": { - "smithy.api#documentation": "

    The status of the scan of the Docker image container for the model package.

    " + "smithy.api#documentation": "

    The validation status of the model package.

    ", + "smithy.api#required": {} } } }, @@ -15087,6 +15166,13 @@ "com.amazonaws.sagemaker#ModelPackageStatusItem": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.sagemaker#DetailedModelPackageStatus", + "traits": { + "smithy.api#documentation": "

    The current status.

    ", + "smithy.api#required": {} + } + }, "FailureReason": { "target": "com.amazonaws.sagemaker#String", "traits": { @@ -15099,13 +15185,6 @@ "smithy.api#documentation": "

    The name of the model package for which the overall status is being reported.

    ", "smithy.api#required": {} } - }, - "Status": { - "target": "com.amazonaws.sagemaker#DetailedModelPackageStatus", - "traits": { - "smithy.api#documentation": "

    The current status.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -15121,10 +15200,10 @@ "com.amazonaws.sagemaker#ModelPackageSummary": { "type": "structure", "members": { - "ModelPackageName": { - "target": "com.amazonaws.sagemaker#EntityName", + "ModelPackageStatus": { + "target": "com.amazonaws.sagemaker#ModelPackageStatus", "traits": { - "smithy.api#documentation": "

    The name of the model package.

    ", + "smithy.api#documentation": "

    The overall status of the model package.

    ", "smithy.api#required": {} } }, @@ -15135,24 +15214,24 @@ "smithy.api#required": {} } }, - "ModelPackageDescription": { - "target": "com.amazonaws.sagemaker#EntityDescription", + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", "traits": { - "smithy.api#documentation": "

    A brief description of the model package.

    " + "smithy.api#documentation": "

    A timestamp that shows when the model package was created.

    ", + "smithy.api#required": {} } }, - "ModelPackageStatus": { - "target": "com.amazonaws.sagemaker#ModelPackageStatus", + "ModelPackageName": { + "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    The overall status of the model package.

    ", + "smithy.api#documentation": "

    The name of the model package.

    ", "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "ModelPackageDescription": { + "target": "com.amazonaws.sagemaker#EntityDescription", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the model package was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A brief description of the model package.

    " } } }, @@ -15203,17 +15282,17 @@ "com.amazonaws.sagemaker#ModelPackageValidationSpecification": { "type": "structure", "members": { - "ValidationProfiles": { - "target": "com.amazonaws.sagemaker#ModelPackageValidationProfiles", + "ValidationRole": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that Amazon SageMaker runs to validate your model package.

    ", + "smithy.api#documentation": "

    The IAM roles to be used for the validation of the model package.

    ", "smithy.api#required": {} } }, - "ValidationRole": { - "target": "com.amazonaws.sagemaker#RoleArn", + "ValidationProfiles": { + "target": "com.amazonaws.sagemaker#ModelPackageValidationProfiles", "traits": { - "smithy.api#documentation": "

    The IAM roles to be used for the validation of the model package.

    ", + "smithy.api#documentation": "

    An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that Amazon SageMaker runs to validate your model package.

    ", "smithy.api#required": {} } } @@ -15240,13 +15319,6 @@ "com.amazonaws.sagemaker#ModelSummary": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    A timestamp that indicates when the model was created.

    ", - "smithy.api#required": {} - } - }, "ModelArn": { "target": "com.amazonaws.sagemaker#ModelArn", "traits": { @@ -15260,6 +15332,13 @@ "smithy.api#documentation": "

    The name of the model that you want a summary for.

    ", "smithy.api#required": {} } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A timestamp that indicates when the model was created.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -15275,17 +15354,16 @@ "com.amazonaws.sagemaker#MonitoringAppSpecification": { "type": "structure", "members": { - "ImageUri": { - "target": "com.amazonaws.sagemaker#ImageUri", + "ContainerArguments": { + "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", "traits": { - "smithy.api#documentation": "

    The container image to be run by the monitoring job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of arguments for the container used to run the monitoring job.

    " } }, - "ContainerEntrypoint": { - "target": "com.amazonaws.sagemaker#ContainerEntrypoint", + "RecordPreprocessorSourceUri": { + "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    Specifies the entrypoint for a container used to run the monitoring job.

    " + "smithy.api#documentation": "

    An Amazon S3 URI to a script that is called per row prior to running analysis. It can\n base64 decode the payload and convert it into a flatted json so that the built-in container\n can use the converted data. Applicable only for the built-in (first party)\n containers.

    " } }, "PostAnalyticsProcessorSourceUri": { @@ -15294,16 +15372,17 @@ "smithy.api#documentation": "

    An Amazon S3 URI to a script that is called after analysis has been performed.\n Applicable only for the built-in (first party) containers.

    " } }, - "ContainerArguments": { - "target": "com.amazonaws.sagemaker#MonitoringContainerArguments", + "ContainerEntrypoint": { + "target": "com.amazonaws.sagemaker#ContainerEntrypoint", "traits": { - "smithy.api#documentation": "

    An array of arguments for the container used to run the monitoring job.

    " + "smithy.api#documentation": "

    Specifies the entrypoint for a container used to run the monitoring job.

    " } }, - "RecordPreprocessorSourceUri": { - "target": "com.amazonaws.sagemaker#S3Uri", + "ImageUri": { + "target": "com.amazonaws.sagemaker#ImageUri", "traits": { - "smithy.api#documentation": "

    An Amazon S3 URI to a script that is called per row prior to running analysis. It can\n base64 decode the payload and convert it into a flatted json so that the built-in container\n can use the converted data. Applicable only for the built-in (first party)\n containers.

    " + "smithy.api#documentation": "

    The container image to be run by the monitoring job.

    ", + "smithy.api#required": {} } } }, @@ -15314,17 +15393,17 @@ "com.amazonaws.sagemaker#MonitoringBaselineConfig": { "type": "structure", "members": { - "StatisticsResource": { - "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource", - "traits": { - "smithy.api#documentation": "

    The baseline statistics file in Amazon S3 that the current monitoring job should be\n validated against.

    " - } - }, "ConstraintsResource": { "target": "com.amazonaws.sagemaker#MonitoringConstraintsResource", "traits": { "smithy.api#documentation": "

    The baseline constraint file in Amazon S3 that the current monitoring job should\n validated against.

    " } + }, + "StatisticsResource": { + "target": "com.amazonaws.sagemaker#MonitoringStatisticsResource", + "traits": { + "smithy.api#documentation": "

    The baseline statistics file in Amazon S3 that the current monitoring job should be\n validated against.

    " + } } }, "traits": { @@ -15334,13 +15413,6 @@ "com.amazonaws.sagemaker#MonitoringClusterConfig": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", - "traits": { - "smithy.api#documentation": "

    The number of ML compute instances to use in the model monitoring job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.

    ", - "smithy.api#required": {} - } - }, "InstanceType": { "target": "com.amazonaws.sagemaker#ProcessingInstanceType", "traits": { @@ -15348,18 +15420,25 @@ "smithy.api#required": {} } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data\n on the storage volume attached to the ML compute instance(s) that run the model monitoring\n job.

    " - } - }, "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", "traits": { "smithy.api#documentation": "

    The size of the ML storage volume, in gigabytes, that you want to provision. You must\n specify sufficient ML storage for your scenario.

    ", "smithy.api#required": {} } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", + "traits": { + "smithy.api#documentation": "

    The number of ML compute instances to use in the model monitoring job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.

    ", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data\n on the storage volume attached to the ML compute instance(s) that run the model monitoring\n job.

    " + } } }, "traits": { @@ -15429,44 +15508,37 @@ "com.amazonaws.sagemaker#MonitoringExecutionSummary": { "type": "structure", "members": { - "ScheduledTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The time the monitoring job was scheduled.

    ", - "smithy.api#required": {} - } - }, - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the monitoring job.

    " + "smithy.api#documentation": "

    The name of teh endpoint used to run the monitoring job.

    " } }, - "MonitoringExecutionStatus": { - "target": "com.amazonaws.sagemaker#ExecutionStatus", + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "

    The status of the monitoring job.

    ", + "smithy.api#documentation": "

    The name of the monitoring schedule.

    ", "smithy.api#required": {} } }, - "LastModifiedTime": { + "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A timestamp that indicates the last time the monitoring job was modified.

    ", + "smithy.api#documentation": "

    The time at which the monitoring job was created.

    ", "smithy.api#required": {} } }, - "CreationTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The time at which the monitoring job was created.

    ", + "smithy.api#documentation": "

    A timestamp that indicates the last time the monitoring job was modified.

    ", "smithy.api#required": {} } }, - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "ScheduledTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the monitoring schedule.

    ", + "smithy.api#documentation": "

    The time the monitoring job was scheduled.

    ", "smithy.api#required": {} } }, @@ -15476,10 +15548,17 @@ "smithy.api#documentation": "

    Contains the reason a monitoring job failed, if it failed.

    " } }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", "traits": { - "smithy.api#documentation": "

    The name of teh endpoint used to run the monitoring job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the monitoring job.

    " + } + }, + "MonitoringExecutionStatus": { + "target": "com.amazonaws.sagemaker#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

    The status of the monitoring job.

    ", + "smithy.api#required": {} } } }, @@ -15523,24 +15602,28 @@ "com.amazonaws.sagemaker#MonitoringJobDefinition": { "type": "structure", "members": { - "MonitoringOutputConfig": { - "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition", "traits": { - "smithy.api#documentation": "

    The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage\n Service (Amazon S3).

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies a time limit for how long the monitoring job is allowed to run.

    " } }, - "MonitoringResources": { - "target": "com.amazonaws.sagemaker#MonitoringResources", + "BaselineConfig": { + "target": "com.amazonaws.sagemaker#MonitoringBaselineConfig", "traits": { - "smithy.api#documentation": "

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n monitoring job. In distributed processing, you specify more than one instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Baseline configuration used to validate that the data conforms to the specified\n constraints and statistics

    " } }, - "MonitoringAppSpecification": { - "target": "com.amazonaws.sagemaker#MonitoringAppSpecification", + "NetworkConfig": { + "target": "com.amazonaws.sagemaker#NetworkConfig", "traits": { - "smithy.api#documentation": "

    Configures the monitoring job to run a specified Docker container image.

    ", + "smithy.api#documentation": "

    Specifies networking options for an monitoring job.

    " + } + }, + "MonitoringInputs": { + "target": "com.amazonaws.sagemaker#MonitoringInputs", + "traits": { + "smithy.api#documentation": "

    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker\n Endpoint.

    ", "smithy.api#required": {} } }, @@ -15557,29 +15640,25 @@ "smithy.api#documentation": "

    Sets the environment variables in the Docker container.

    " } }, - "BaselineConfig": { - "target": "com.amazonaws.sagemaker#MonitoringBaselineConfig", - "traits": { - "smithy.api#documentation": "

    Baseline configuration used to validate that the data conforms to the specified\n constraints and statistics

    " - } - }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#MonitoringStoppingCondition", + "MonitoringResources": { + "target": "com.amazonaws.sagemaker#MonitoringResources", "traits": { - "smithy.api#documentation": "

    Specifies a time limit for how long the monitoring job is allowed to run.

    " + "smithy.api#documentation": "

    Identifies the resources, ML compute instances, and ML storage volumes to deploy for a\n monitoring job. In distributed processing, you specify more than one instance.

    ", + "smithy.api#required": {} } }, - "MonitoringInputs": { - "target": "com.amazonaws.sagemaker#MonitoringInputs", + "MonitoringAppSpecification": { + "target": "com.amazonaws.sagemaker#MonitoringAppSpecification", "traits": { - "smithy.api#documentation": "

    The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker\n Endpoint.

    ", + "smithy.api#documentation": "

    Configures the monitoring job to run a specified Docker container image.

    ", "smithy.api#required": {} } }, - "NetworkConfig": { - "target": "com.amazonaws.sagemaker#NetworkConfig", + "MonitoringOutputConfig": { + "target": "com.amazonaws.sagemaker#MonitoringOutputConfig", "traits": { - "smithy.api#documentation": "

    Specifies networking options for an monitoring job.

    " + "smithy.api#documentation": "

    The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage\n Service (Amazon S3).

    ", + "smithy.api#required": {} } } }, @@ -15614,18 +15693,18 @@ "com.amazonaws.sagemaker#MonitoringOutputConfig": { "type": "structure", "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model\n artifacts at rest using Amazon S3 server-side encryption.

    " + } + }, "MonitoringOutputs": { "target": "com.amazonaws.sagemaker#MonitoringOutputs", "traits": { "smithy.api#documentation": "

    Monitoring outputs for monitoring jobs. This is where the output of the periodic\n monitoring jobs is uploaded.

    ", "smithy.api#required": {} } - }, - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model\n artifacts at rest using Amazon S3 server-side encryption.

    " - } } }, "traits": { @@ -15662,10 +15741,10 @@ "com.amazonaws.sagemaker#MonitoringS3Output": { "type": "structure", "members": { - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "S3Uri": { + "target": "com.amazonaws.sagemaker#MonitoringS3Uri", "traits": { - "smithy.api#documentation": "

    The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a\n monitoring job. LocalPath is an absolute path for the output data.

    ", + "smithy.api#documentation": "

    A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a\n monitoring job.

    ", "smithy.api#required": {} } }, @@ -15675,10 +15754,10 @@ "smithy.api#documentation": "

    Whether to upload the results of the monitoring job continuously or after the job\n completes.

    " } }, - "S3Uri": { - "target": "com.amazonaws.sagemaker#MonitoringS3Uri", + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "

    A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a\n monitoring job.

    ", + "smithy.api#documentation": "

    The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a\n monitoring job. LocalPath is an absolute path for the output data.

    ", "smithy.api#required": {} } } @@ -15710,18 +15789,18 @@ "com.amazonaws.sagemaker#MonitoringScheduleConfig": { "type": "structure", "members": { + "ScheduleConfig": { + "target": "com.amazonaws.sagemaker#ScheduleConfig", + "traits": { + "smithy.api#documentation": "

    Configures the monitoring schedule.

    " + } + }, "MonitoringJobDefinition": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinition", "traits": { "smithy.api#documentation": "

    Defines the monitoring job.

    ", "smithy.api#required": {} } - }, - "ScheduleConfig": { - "target": "com.amazonaws.sagemaker#ScheduleConfig", - "traits": { - "smithy.api#documentation": "

    Configures the monitoring schedule.

    " - } } }, "traits": { @@ -15760,10 +15839,17 @@ "com.amazonaws.sagemaker#MonitoringScheduleSummary": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "

    The last time the monitoring schedule was modified.

    ", + "smithy.api#documentation": "

    The name of the monitoring schedule.

    ", + "smithy.api#required": {} + } + }, + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the monitoring schedule.

    ", "smithy.api#required": {} } }, @@ -15774,6 +15860,13 @@ "smithy.api#required": {} } }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The last time the monitoring schedule was modified.

    ", + "smithy.api#required": {} + } + }, "EndpointName": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { @@ -15786,20 +15879,6 @@ "smithy.api#documentation": "

    The status of the monitoring schedule.

    ", "smithy.api#required": {} } - }, - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", - "traits": { - "smithy.api#documentation": "

    The name of the monitoring schedule.

    ", - "smithy.api#required": {} - } - }, - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the monitoring schedule.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -15888,6 +15967,9 @@ "com.amazonaws.sagemaker#NetworkConfig": { "type": "structure", "members": { + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig" + }, "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { @@ -15899,9 +15981,6 @@ "traits": { "smithy.api#documentation": "

    Whether to encrypt all communications between distributed processing jobs. Choose\n True to encrypt communications. Encryption provides greater security for distributed\n processing jobs, but the processing might take longer.

    " } - }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig" } }, "traits": { @@ -16055,11 +16134,16 @@ "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigSummary": { "type": "structure", "members": { - "NotebookInstanceLifecycleConfigName": { - "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "

    The name of the lifecycle configuration.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A timestamp that tells when the lifecycle configuration was last modified.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "

    A timestamp that tells when the lifecycle configuration was created.

    " } }, "NotebookInstanceLifecycleConfigArn": { @@ -16069,16 +16153,11 @@ "smithy.api#required": {} } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", - "traits": { - "smithy.api#documentation": "

    A timestamp that tells when the lifecycle configuration was last modified.

    " - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#CreationTime", + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "

    A timestamp that tells when the lifecycle configuration was created.

    " + "smithy.api#documentation": "

    The name of the lifecycle configuration.

    ", + "smithy.api#required": {} } } }, @@ -16198,6 +16277,13 @@ "com.amazonaws.sagemaker#NotebookInstanceSummary": { "type": "structure", "members": { + "NotebookInstanceArn": { + "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the notebook instance.

    ", + "smithy.api#required": {} + } + }, "CreationTime": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { @@ -16210,29 +16296,34 @@ "smithy.api#documentation": "

    The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

    " } }, + "NotebookInstanceStatus": { + "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "traits": { + "smithy.api#documentation": "

    The status of the notebook instance.

    " + } + }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { "smithy.api#documentation": "

    An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#LastModifiedTime", + "Url": { + "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the notebook instance was last modified.

    " + "smithy.api#documentation": "

    The\n URL that you use to connect to the Jupyter instance running in your notebook instance.\n

    " } }, - "NotebookInstanceArn": { - "target": "com.amazonaws.sagemaker#NotebookInstanceArn", + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the notebook instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A timestamp that shows when the notebook instance was last modified.

    " } }, - "NotebookInstanceStatus": { - "target": "com.amazonaws.sagemaker#NotebookInstanceStatus", + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", "traits": { - "smithy.api#documentation": "

    The status of the notebook instance.

    " + "smithy.api#documentation": "

    The type of ML compute instance that the notebook instance is running on.

    " } }, "NotebookInstanceLifecycleConfigName": { @@ -16247,18 +16338,6 @@ "smithy.api#documentation": "

    The name of the notebook instance that you want a summary for.

    ", "smithy.api#required": {} } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", - "traits": { - "smithy.api#documentation": "

    The type of ML compute instance that the notebook instance is running on.

    " - } - }, - "Url": { - "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", - "traits": { - "smithy.api#documentation": "

    The\n URL that you use to connect to the Jupyter instance running in your notebook instance.\n

    " - } } }, "traits": { @@ -16359,12 +16438,6 @@ "com.amazonaws.sagemaker#ObjectiveStatusCounters": { "type": "structure", "members": { - "Pending": { - "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", - "traits": { - "smithy.api#documentation": "

    The number of training jobs that are in progress and pending evaluation of their final\n objective metric.

    " - } - }, "Failed": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", "traits": { @@ -16376,6 +16449,12 @@ "traits": { "smithy.api#documentation": "

    The number of training jobs whose final objective metric was evaluated by the\n hyperparameter tuning job and used in the hyperparameter tuning process.

    " } + }, + "Pending": { + "target": "com.amazonaws.sagemaker#ObjectiveStatusCounter", + "traits": { + "smithy.api#documentation": "

    The number of training jobs that are in progress and pending evaluation of their final\n objective metric.

    " + } } }, "traits": { @@ -16384,25 +16463,11 @@ }, "com.amazonaws.sagemaker#OidcConfig": { "type": "structure", - "members": { - "LogoutEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "

    The OIDC IdP logout endpoint used to configure your private workforce.

    ", - "smithy.api#required": {} - } - }, - "JwksUri": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    ", - "smithy.api#required": {} - } - }, - "TokenEndpoint": { + "members": { + "Issuer": { "target": "com.amazonaws.sagemaker#OidcEndpoint", "traits": { - "smithy.api#documentation": "

    The OIDC IdP token endpoint used to configure your private workforce.

    ", + "smithy.api#documentation": "

    The OIDC IdP issuer used to configure your private workforce.

    ", "smithy.api#required": {} } }, @@ -16427,17 +16492,31 @@ "smithy.api#required": {} } }, - "Issuer": { + "ClientSecret": { + "target": "com.amazonaws.sagemaker#ClientSecret", + "traits": { + "smithy.api#documentation": "

    The OIDC IdP client secret used to configure your private workforce.

    ", + "smithy.api#required": {} + } + }, + "LogoutEndpoint": { "target": "com.amazonaws.sagemaker#OidcEndpoint", "traits": { - "smithy.api#documentation": "

    The OIDC IdP issuer used to configure your private workforce.

    ", + "smithy.api#documentation": "

    The OIDC IdP logout endpoint used to configure your private workforce.

    ", "smithy.api#required": {} } }, - "ClientSecret": { - "target": "com.amazonaws.sagemaker#ClientSecret", + "JwksUri": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", "traits": { - "smithy.api#documentation": "

    The OIDC IdP client secret used to configure your private workforce.

    ", + "smithy.api#documentation": "

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    ", + "smithy.api#required": {} + } + }, + "TokenEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

    The OIDC IdP token endpoint used to configure your private workforce.

    ", "smithy.api#required": {} } } @@ -16449,22 +16528,10 @@ "com.amazonaws.sagemaker#OidcConfigForResponse": { "type": "structure", "members": { - "TokenEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "

    The OIDC IdP token endpoint used to configure your private workforce.

    " - } - }, - "LogoutEndpoint": { - "target": "com.amazonaws.sagemaker#OidcEndpoint", - "traits": { - "smithy.api#documentation": "

    The OIDC IdP logout endpoint used to configure your private workforce.

    " - } - }, - "JwksUri": { + "AuthorizationEndpoint": { "target": "com.amazonaws.sagemaker#OidcEndpoint", "traits": { - "smithy.api#documentation": "

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    " + "smithy.api#documentation": "

    The OIDC IdP authorization endpoint used to configure your private workforce.

    " } }, "UserInfoEndpoint": { @@ -16485,15 +16552,27 @@ "smithy.api#documentation": "

    The OIDC IdP issuer used to configure your private workforce.

    " } }, - "AuthorizationEndpoint": { + "TokenEndpoint": { "target": "com.amazonaws.sagemaker#OidcEndpoint", "traits": { - "smithy.api#documentation": "

    The OIDC IdP authorization endpoint used to configure your private workforce.

    " + "smithy.api#documentation": "

    The OIDC IdP token endpoint used to configure your private workforce.

    " + } + }, + "LogoutEndpoint": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

    The OIDC IdP logout endpoint used to configure your private workforce.

    " + } + }, + "JwksUri": { + "target": "com.amazonaws.sagemaker#OidcEndpoint", + "traits": { + "smithy.api#documentation": "

    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

    " } } }, "traits": { - "smithy.api#documentation": "

    Your Amazon Cognito workforce configuration.

    " + "smithy.api#documentation": "

    Your OIDC IdP workforce configuration.

    " } }, "com.amazonaws.sagemaker#OidcEndpoint": { @@ -16512,13 +16591,13 @@ "Groups": { "target": "com.amazonaws.sagemaker#Groups", "traits": { - "smithy.api#documentation": "

    A list of comma seperated strings that identifies\n user groups in your OIDC IdP. Each user group is\n made up of a group of private workers.

    ", + "smithy.api#documentation": "

    A list of comma seperated strings that identifies\n user groups in your OIDC IdP. Each user group is\n made up of a group of private workers.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    A list user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.

    " + "smithy.api#documentation": "

    A list of user groups that exist in your OIDC Identity Provider (IdP). \n One to ten groups can be used to create a single private work team. \n When you add a user group to the list of Groups, you can add that user group to one or more\n private work teams. If you add a user group to a private work team, all workers in that user group \n are added to the work team.

    " } }, "com.amazonaws.sagemaker#Operator": { @@ -16606,10 +16685,16 @@ "com.amazonaws.sagemaker#OutputConfig": { "type": "structure", "members": { - "CompilerOptions": { - "target": "com.amazonaws.sagemaker#CompilerOptions", + "TargetPlatform": { + "target": "com.amazonaws.sagemaker#TargetPlatform", "traits": { - "smithy.api#documentation": "

    Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA\n accelerators and highly recommended for CPU compliations. For any other cases, it is\n optional to specify CompilerOptions.\n

    \n
      \n
    • \n

      \n CPU: Compilation for CPU supports the following compiler options.

      \n
        \n
      • \n

        \n mcpu: CPU micro-architecture. For example,\n {'mcpu': 'skylake-avx512'}\n

        \n
        • \n
      • \n

        \n mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}\n

        \n
        • \n
      \n
      • \n
    • \n

      \n ARM: Details of ARM CPU compilations.

      \n
        \n
      • \n

        \n NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

        \n

        For example, add {'mattr': ['+neon']} to the compiler options if compiling\n for ARM 32-bit platform with the NEON support.

        \n
        • \n
      \n
      • \n
    • \n

      \n NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

      \n
        \n
      • \n

        \n gpu_code: Specifies the targeted architecture.

        \n
        • \n
      • \n

        \n trt-ver: Specifies the TensorRT versions in x.y.z. format.

        \n
        • \n
      • \n

        \n cuda-ver: Specifies the CUDA version in x.y format.

        \n
        • \n
      \n

      For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}\n

      \n
      • \n
    • \n

      \n ANDROID: Compilation for the Android OS supports the following compiler options:

      \n
        \n
      • \n

        \n ANDROID_PLATFORM: Specifies the Android API levels. Available levels range\n from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.

        \n
        • \n
      • \n

        \n mattr: Add {'mattr': ['+neon']} to compiler options if compiling\n for ARM 32-bit platform with NEON support.

        \n
        • \n
      \n
      • \n
    " + "smithy.api#documentation": "

    Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.

    \n

    The following examples show how to configure the TargetPlatform and\n CompilerOptions JSON strings for popular target platforms:

    \n
      \n
    • \n

      Raspberry Pi 3 Model B+

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},\n

      \n

      \n \"CompilerOptions\": {'mattr': ['+neon']}\n

      \n
      • \n
    • \n

      Jetson TX2

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"NVIDIA\"},\n

      \n

      \n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1',\n 'cuda-ver': '10.0'}\n

      \n
      • \n
    • \n

      EC2 m5.2xlarge instance OS

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n

      \n

      \n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n

      \n
      • \n
    • \n

      RK3399

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"MALI\"}\n

      \n
      • \n
    • \n

      ARMv7 phone (CPU)

      \n

      \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},\n

      \n

      \n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr':\n ['+neon']}\n

      \n
      • \n
    • \n

      ARMv8 phone (CPU)

      \n

      \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},\n

      \n

      \n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n

      \n
      • \n
    " + } + }, + "TargetDevice": { + "target": "com.amazonaws.sagemaker#TargetDevice", + "traits": { + "smithy.api#documentation": "

    Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform fields. It can be\n used instead of TargetPlatform.

    " } }, "S3OutputLocation": { @@ -16619,16 +16704,10 @@ "smithy.api#required": {} } }, - "TargetPlatform": { - "target": "com.amazonaws.sagemaker#TargetPlatform", - "traits": { - "smithy.api#documentation": "

    Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.

    \n

    The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings\n for popular target platforms:\n

    \n
      \n
    • \n

      Raspberry Pi 3 Model B+

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\", \n \"Arch\": \"ARM_EABIHF\"},\n

      \n

      \n \n \"CompilerOptions\": {'mattr': ['+neon']}\n

      \n
      • \n
    • \n

      Jetson TX2

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\",\n \"Arch\": \"ARM64\",\n \"Accelerator\": \"NVIDIA\"},\n

      \n

      \n \n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}\n

      \n
      • \n
    • \n

      EC2 m5.2xlarge instance OS

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n

      \n

      \n \n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n

      \n
      • \n
    • \n

      RK3399

      \n

      \n \"TargetPlatform\": {\"Os\": \"LINUX\",\n \"Arch\": \"ARM64\",\n \"Accelerator\": \"MALI\"}\n

      \n
      • \n
    • \n

      ARMv7 phone (CPU)

      \n

      \n \"TargetPlatform\": {\"Os\": \"ANDROID\",\n \"Arch\": \"ARM_EABI\"},\n

      \n

      \n \n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}\n

      \n
      • \n
    • \n

      ARMv8 phone (CPU)

      \n

      \n \"TargetPlatform\": {\"Os\": \"ANDROID\",\n \"Arch\": \"ARM64\"},\n

      \n

      \n \n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n

      \n
      • \n
    " - } - }, - "TargetDevice": { - "target": "com.amazonaws.sagemaker#TargetDevice", + "CompilerOptions": { + "target": "com.amazonaws.sagemaker#CompilerOptions", "traits": { - "smithy.api#documentation": "

    Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform fields. It can be\n used instead of TargetPlatform.

    " + "smithy.api#documentation": "

    Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n

    \n
      \n
    • \n

      \n CPU: Compilation for CPU supports the following compiler\n options.

      \n
        \n
      • \n

        \n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n

        \n
        • \n
      • \n

        \n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n

        \n
        • \n
      \n
      • \n
    • \n

      \n ARM: Details of ARM CPU compilations.

      \n
        \n
      • \n

        \n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.

        \n

        For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.

        \n
        • \n
      \n
      • \n
    • \n

      \n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.

      \n
        \n
      • \n

        \n gpu_code: Specifies the targeted architecture.

        \n
        • \n
      • \n

        \n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.

        \n
        • \n
      • \n

        \n cuda-ver: Specifies the CUDA version in x.y\n format.

        \n
        • \n
      \n

      For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n

      \n
      • \n
    • \n

      \n ANDROID: Compilation for the Android OS supports the following\n compiler options:

      \n
        \n
      • \n

        \n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.

        \n
        • \n
      • \n

        \n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.

        \n
        • \n
      \n
      • \n
    • \n

      \n CoreML: Compilation for the CoreML OutputConfig$TargetDevice\n supports the following compiler options:

      \n
        \n
      • \n

        \n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example,\n {\"class_labels\": \"imagenet_labels_1000.txt\"}.\n Labels inside the txt file should be separated by newlines.

        \n
        • \n
      \n
      • \n
    " } } }, @@ -16639,18 +16718,18 @@ "com.amazonaws.sagemaker#OutputDataConfig": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

    \n
      \n
    • \n

      // KMS Key ID

      \n

      \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      // Amazon Resource Name (ARN) of a KMS Key

      \n

      \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      // KMS Key Alias

      \n

      \n \"alias/ExampleAlias\"\n

      \n
      • \n
    • \n

      // Amazon Resource Name (ARN) of a KMS Key Alias

      \n

      \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

      \n
      • \n
    \n \n

    If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

    " - } - }, "S3OutputPath": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#documentation": "

    Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.

    ", "smithy.api#required": {} } + }, + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

    \n
      \n
    • \n

      // KMS Key ID

      \n

      \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      // Amazon Resource Name (ARN) of a KMS Key

      \n

      \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      // KMS Key Alias

      \n

      \n \"alias/ExampleAlias\"\n

      \n
      • \n
    • \n

      // Amazon Resource Name (ARN) of a KMS Key Alias

      \n

      \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

      \n
      • \n
    \n \n

    If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

    " + } } }, "traits": { @@ -16690,10 +16769,10 @@ "com.amazonaws.sagemaker#ParameterRange": { "type": "structure", "members": { - "IntegerParameterRangeSpecification": { - "target": "com.amazonaws.sagemaker#IntegerParameterRangeSpecification", + "ContinuousParameterRangeSpecification": { + "target": "com.amazonaws.sagemaker#ContinuousParameterRangeSpecification", "traits": { - "smithy.api#documentation": "

    A IntegerParameterRangeSpecification object that defines the possible\n values for an integer hyperparameter.

    " + "smithy.api#documentation": "

    A ContinuousParameterRangeSpecification object that defines the possible\n values for a continuous hyperparameter.

    " } }, "CategoricalParameterRangeSpecification": { @@ -16702,10 +16781,10 @@ "smithy.api#documentation": "

    A CategoricalParameterRangeSpecification object that defines the possible\n values for a categorical hyperparameter.

    " } }, - "ContinuousParameterRangeSpecification": { - "target": "com.amazonaws.sagemaker#ContinuousParameterRangeSpecification", + "IntegerParameterRangeSpecification": { + "target": "com.amazonaws.sagemaker#IntegerParameterRangeSpecification", "traits": { - "smithy.api#documentation": "

    A ContinuousParameterRangeSpecification object that defines the possible\n values for a continuous hyperparameter.

    " + "smithy.api#documentation": "

    A IntegerParameterRangeSpecification object that defines the possible\n values for an integer hyperparameter.

    " } } }, @@ -16716,18 +16795,18 @@ "com.amazonaws.sagemaker#ParameterRanges": { "type": "structure", "members": { - "CategoricalParameterRanges": { - "target": "com.amazonaws.sagemaker#CategoricalParameterRanges", - "traits": { - "smithy.api#documentation": "

    The array of CategoricalParameterRange objects that specify ranges\n of categorical hyperparameters that a hyperparameter tuning job searches.

    " - } - }, "ContinuousParameterRanges": { "target": "com.amazonaws.sagemaker#ContinuousParameterRanges", "traits": { "smithy.api#documentation": "

    The array of ContinuousParameterRange objects that specify ranges of\n continuous hyperparameters that a hyperparameter tuning job searches.

    " } }, + "CategoricalParameterRanges": { + "target": "com.amazonaws.sagemaker#CategoricalParameterRanges", + "traits": { + "smithy.api#documentation": "

    The array of CategoricalParameterRange objects that specify ranges\n of categorical hyperparameters that a hyperparameter tuning job searches.

    " + } + }, "IntegerParameterRanges": { "target": "com.amazonaws.sagemaker#IntegerParameterRanges", "traits": { @@ -16787,16 +16866,16 @@ "com.amazonaws.sagemaker#Parent": { "type": "structure", "members": { - "ExperimentName": { + "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the experiment.

    " + "smithy.api#documentation": "

    The name of the trial.

    " } }, - "TrialName": { + "ExperimentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the trial.

    " + "smithy.api#documentation": "

    The name of the experiment.

    " } } }, @@ -16861,30 +16940,30 @@ "com.amazonaws.sagemaker#ProcessingClusterConfig": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

    The number of ML compute instances to use in the processing job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n

    " } }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceType", "traits": { - "smithy.api#documentation": "

    The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.

    ", + "smithy.api#documentation": "

    The ML compute instance type for the processing job.

    ", "smithy.api#required": {} } }, - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "InstanceCount": { + "target": "com.amazonaws.sagemaker#ProcessingInstanceCount", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n

    " + "smithy.api#documentation": "

    The number of ML compute instances to use in the processing job. For distributed\n processing jobs, specify a value greater than 1. The default value is 1.

    ", + "smithy.api#required": {} } }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProcessingInstanceType", + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

    The ML compute instance type for the processing job.

    ", + "smithy.api#documentation": "

    The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.

    ", "smithy.api#required": {} } } @@ -16931,17 +17010,17 @@ "com.amazonaws.sagemaker#ProcessingInput": { "type": "structure", "members": { - "InputName": { - "target": "com.amazonaws.sagemaker#String", + "S3Input": { + "target": "com.amazonaws.sagemaker#ProcessingS3Input", "traits": { - "smithy.api#documentation": "

    The name of the inputs for the processing job.

    ", + "smithy.api#documentation": "

    The S3 inputs for the processing job.

    ", "smithy.api#required": {} } }, - "S3Input": { - "target": "com.amazonaws.sagemaker#ProcessingS3Input", + "InputName": { + "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

    The S3 inputs for the processing job.

    ", + "smithy.api#documentation": "

    The name of the inputs for the processing job.

    ", "smithy.api#required": {} } } @@ -17134,40 +17213,25 @@ "com.amazonaws.sagemaker#ProcessingJob": { "type": "structure", "members": { - "ProcessingInputs": { - "target": "com.amazonaws.sagemaker#ProcessingInputs", - "traits": { - "smithy.api#documentation": "

    For each input, data is downloaded from S3 into the processing container before the\n processing job begins running if \"S3InputMode\" is set to File.

    " - } - }, - "ProcessingJobName": { - "target": "com.amazonaws.sagemaker#ProcessingJobName", - "traits": { - "smithy.api#documentation": "

    The name of the processing job.

    " - } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "ProcessingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The ARN of the role used to create the processing job.

    " + "smithy.api#documentation": "

    The time that the processing job ended.

    " } }, - "ProcessingOutputConfig": { - "target": "com.amazonaws.sagemaker#ProcessingOutputConfig" - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", "traits": { - "smithy.api#documentation": "

    The ARN of the training job associated with this processing job.

    " + "smithy.api#documentation": "

    The status of the processing job.

    " } }, "NetworkConfig": { "target": "com.amazonaws.sagemaker#NetworkConfig" }, - "ProcessingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ExitMessage": { + "target": "com.amazonaws.sagemaker#ExitMessage", "traits": { - "smithy.api#documentation": "

    The time that the processing job ended.

    " + "smithy.api#documentation": "

    A string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.

    " } }, "ProcessingJobArn": { @@ -17176,77 +17240,92 @@ "smithy.api#documentation": "

    The ARN of the processing job.

    " } }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition" }, - "ProcessingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The time that the processing job started.

    " + "smithy.api#documentation": "

    A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.

    " } }, - "MonitoringScheduleArn": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "

    The ARN of a monitoring schedule for an endpoint associated with this processing\n job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "ProcessingJobName": { + "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { - "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

    " + "smithy.api#documentation": "

    The name of the processing job.

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "ProcessingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.

    " + "smithy.api#documentation": "

    The time that the processing job started.

    " } }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "ProcessingOutputConfig": { + "target": "com.amazonaws.sagemaker#ProcessingOutputConfig" + }, + "Environment": { + "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

    " + "smithy.api#documentation": "

    Sets the environment variables in the Docker container.

    " } }, - "ProcessingResources": { - "target": "com.amazonaws.sagemaker#ProcessingResources" + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time the processing job was last modified.

    " + } }, - "ExitMessage": { - "target": "com.amazonaws.sagemaker#ExitMessage", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.

    " + "smithy.api#documentation": "

    The time the processing job was created.

    " } }, - "ProcessingJobStatus": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The status of the processing job.

    " + "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "AppSpecification": { + "target": "com.amazonaws.sagemaker#AppSpecification" + }, + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", "traits": { - "smithy.api#documentation": "

    The time the processing job was last modified.

    " + "smithy.api#documentation": "

    The ARN of the training job associated with this processing job.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MonitoringScheduleArn": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleArn", "traits": { - "smithy.api#documentation": "

    The time the processing job was created.

    " + "smithy.api#documentation": "

    The ARN of a monitoring schedule for an endpoint associated with this processing\n job.

    " } }, - "Environment": { - "target": "com.amazonaws.sagemaker#ProcessingEnvironmentMap", + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "ProcessingInputs": { + "target": "com.amazonaws.sagemaker#ProcessingInputs", "traits": { - "smithy.api#documentation": "

    Sets the environment variables in the Docker container.

    " + "smithy.api#documentation": "

    For each input, data is downloaded from S3 into the processing container before the\n processing job begins running if \"S3InputMode\" is set to File.

    " } }, - "AppSpecification": { - "target": "com.amazonaws.sagemaker#AppSpecification" + "ProcessingResources": { + "target": "com.amazonaws.sagemaker#ProcessingResources" }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#ProcessingStoppingCondition" + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the role used to create the processing job.

    " + } } }, "traits": { @@ -17309,23 +17388,10 @@ "com.amazonaws.sagemaker#ProcessingJobSummary": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    A timestamp that indicates the last time the processing job was modified.

    " - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The time at which the processing job was created.

    ", - "smithy.api#required": {} - } - }, - "ProcessingJobStatus": { - "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "ProcessingJobArn": { + "target": "com.amazonaws.sagemaker#ProcessingJobArn", "traits": { - "smithy.api#documentation": "

    The status of the processing job.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the processing job..

    ", "smithy.api#required": {} } }, @@ -17341,13 +17407,6 @@ "smithy.api#documentation": "

    An optional string, up to one KB in size, that contains metadata from the processing\n container when the processing job exits.

    " } }, - "ProcessingJobArn": { - "target": "com.amazonaws.sagemaker#ProcessingJobArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the processing job..

    ", - "smithy.api#required": {} - } - }, "ProcessingJobName": { "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { @@ -17360,6 +17419,26 @@ "traits": { "smithy.api#documentation": "

    A string, up to one KB in size, that contains the reason a processing job failed, if\n it failed.

    " } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A timestamp that indicates the last time the processing job was modified.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time at which the processing job was created.

    ", + "smithy.api#required": {} + } + }, + "ProcessingJobStatus": { + "target": "com.amazonaws.sagemaker#ProcessingJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the processing job.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -17503,6 +17582,13 @@ "com.amazonaws.sagemaker#ProcessingS3Input": { "type": "structure", "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

    The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed\n to run a processing job.

    ", + "smithy.api#required": {} + } + }, "S3DataType": { "target": "com.amazonaws.sagemaker#ProcessingS3DataType", "traits": { @@ -17510,10 +17596,11 @@ "smithy.api#required": {} } }, - "S3DataDistributionType": { - "target": "com.amazonaws.sagemaker#ProcessingS3DataDistributionType", + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "

    Whether the data stored in Amazon S3 is FullyReplicated or\n ShardedByS3Key.

    " + "smithy.api#documentation": "

    The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to\n run a processing job. LocalPath is an absolute path to the input\n data.

    ", + "smithy.api#required": {} } }, "S3InputMode": { @@ -17523,24 +17610,16 @@ "smithy.api#required": {} } }, - "S3CompressionType": { - "target": "com.amazonaws.sagemaker#ProcessingS3CompressionType", - "traits": { - "smithy.api#documentation": "

    Whether to use Gzip compression for Amazon S3 storage.

    " - } - }, - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", + "S3DataDistributionType": { + "target": "com.amazonaws.sagemaker#ProcessingS3DataDistributionType", "traits": { - "smithy.api#documentation": "

    The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed\n to run a processing job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether the data stored in Amazon S3 is FullyReplicated or\n ShardedByS3Key.

    " } }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "S3CompressionType": { + "target": "com.amazonaws.sagemaker#ProcessingS3CompressionType", "traits": { - "smithy.api#documentation": "

    The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to\n run a processing job. LocalPath is an absolute path to the input\n data.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Whether to use Gzip compression for Amazon S3 storage.

    " } } }, @@ -17566,10 +17645,10 @@ "com.amazonaws.sagemaker#ProcessingS3Output": { "type": "structure", "members": { - "LocalPath": { - "target": "com.amazonaws.sagemaker#ProcessingLocalPath", + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    The local path to the Amazon S3 bucket where you want Amazon SageMaker to save the results of an\n processing job. LocalPath is an absolute path to the input data.

    ", + "smithy.api#documentation": "

    A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of\n a processing job.

    ", "smithy.api#required": {} } }, @@ -17580,10 +17659,10 @@ "smithy.api#required": {} } }, - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", + "LocalPath": { + "target": "com.amazonaws.sagemaker#ProcessingLocalPath", "traits": { - "smithy.api#documentation": "

    A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of\n a processing job.

    ", + "smithy.api#documentation": "

    The local path to the Amazon S3 bucket where you want Amazon SageMaker to save the results of an\n processing job. LocalPath is an absolute path to the input data.

    ", "smithy.api#required": {} } } @@ -17651,25 +17730,23 @@ "com.amazonaws.sagemaker#ProductionVariant": { "type": "structure", "members": { - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", + "InitialVariantWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", "traits": { - "smithy.api#documentation": "

    The name of the model that you want to host. This is the name that you specified\n when creating the model.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Determines initial traffic distribution among all of the models that you specify in\n the endpoint configuration. The traffic to a production variant is determined by the\n ratio of the VariantWeight to the sum of all VariantWeight\n values across all ProductionVariants. If unspecified, it defaults to 1.0.\n

    " } }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

    The ML compute instance type.

    ", + "smithy.api#documentation": "

    The name of the model that you want to host. This is the name that you specified\n when creating the model.

    ", "smithy.api#required": {} } }, - "InitialInstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", + "AcceleratorType": { + "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", "traits": { - "smithy.api#documentation": "

    Number of instances to launch initially.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The size of the Elastic Inference (EI) instance to use for the production variant. EI\n instances provide on-demand GPU computing for inference. For more information, see\n Using Elastic\n Inference in Amazon SageMaker.

    " } }, "VariantName": { @@ -17679,16 +17756,18 @@ "smithy.api#required": {} } }, - "InitialVariantWeight": { - "target": "com.amazonaws.sagemaker#VariantWeight", + "InitialInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", "traits": { - "smithy.api#documentation": "

    Determines initial traffic distribution among all of the models that you specify in\n the endpoint configuration. The traffic to a production variant is determined by the\n ratio of the VariantWeight to the sum of all VariantWeight\n values across all ProductionVariants. If unspecified, it defaults to 1.0.\n

    " + "smithy.api#documentation": "

    Number of instances to launch initially.

    ", + "smithy.api#required": {} } }, - "AcceleratorType": { - "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", "traits": { - "smithy.api#documentation": "

    The size of the Elastic Inference (EI) instance to use for the production variant. EI\n instances provide on-demand GPU computing for inference. For more information, see\n Using Elastic\n Inference in Amazon SageMaker.

    " + "smithy.api#documentation": "

    The ML compute instance type.

    ", + "smithy.api#required": {} } } }, @@ -18013,17 +18092,16 @@ "com.amazonaws.sagemaker#ProductionVariantSummary": { "type": "structure", "members": { - "DesiredWeight": { - "target": "com.amazonaws.sagemaker#VariantWeight", + "DeployedImages": { + "target": "com.amazonaws.sagemaker#DeployedImages", "traits": { - "smithy.api#documentation": "

    The requested weight, as specified in the\n UpdateEndpointWeightsAndCapacities request.

    " + "smithy.api#documentation": "

    An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the\n inference images deployed on instances of this ProductionVariant.

    " } }, - "VariantName": { - "target": "com.amazonaws.sagemaker#VariantName", + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", "traits": { - "smithy.api#documentation": "

    The name of the variant.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of instances requested in the\n UpdateEndpointWeightsAndCapacities request.

    " } }, "CurrentInstanceCount": { @@ -18032,22 +18110,23 @@ "smithy.api#documentation": "

    The number of instances associated with the variant.

    " } }, - "DesiredInstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", - "traits": { - "smithy.api#documentation": "

    The number of instances requested in the\n UpdateEndpointWeightsAndCapacities request.

    " - } - }, "CurrentWeight": { "target": "com.amazonaws.sagemaker#VariantWeight", "traits": { "smithy.api#documentation": "

    The weight associated with the variant.

    " } }, - "DeployedImages": { - "target": "com.amazonaws.sagemaker#DeployedImages", + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", "traits": { - "smithy.api#documentation": "

    An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the\n inference images deployed on instances of this ProductionVariant.

    " + "smithy.api#documentation": "

    The name of the variant.

    ", + "smithy.api#required": {} + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

    The requested weight, as specified in the\n UpdateEndpointWeightsAndCapacities request.

    " } } }, @@ -18166,6 +18245,13 @@ "com.amazonaws.sagemaker#RenderUiTemplateRequest": { "type": "structure", "members": { + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the\n template.

    ", + "smithy.api#required": {} + } + }, "UiTemplate": { "target": "com.amazonaws.sagemaker#UiTemplate", "traits": { @@ -18175,7 +18261,7 @@ "HumanTaskUiArn": { "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "

    The HumanTaskUiArn of the worker UI that you want to render. \n Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

    \n

    See a list\n of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

    " + "smithy.api#documentation": "

    The HumanTaskUiArn of the worker UI that you want to render. Do not\n provide a HumanTaskUiArn if you use the UiTemplate\n parameter.

    \n

    See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

    " } }, "Task": { @@ -18184,30 +18270,23 @@ "smithy.api#documentation": "

    A RenderableTask object containing a representative task to\n render.

    ", "smithy.api#required": {} } - }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the\n template.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.sagemaker#RenderUiTemplateResponse": { "type": "structure", "members": { - "RenderedContent": { - "target": "com.amazonaws.sagemaker#String", + "Errors": { + "target": "com.amazonaws.sagemaker#RenderingErrorList", "traits": { - "smithy.api#documentation": "

    A Liquid template that renders the HTML for the worker UI.

    ", + "smithy.api#documentation": "

    A list of one or more RenderingError objects if any were encountered\n while rendering the template. If there were no errors, the list is empty.

    ", "smithy.api#required": {} } }, - "Errors": { - "target": "com.amazonaws.sagemaker#RenderingErrorList", + "RenderedContent": { + "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

    A list of one or more RenderingError objects if any were encountered\n while rendering the template. If there were no errors, the list is empty.

    ", + "smithy.api#documentation": "

    A Liquid template that renders the HTML for the worker UI.

    ", "smithy.api#required": {} } } @@ -18231,17 +18310,17 @@ "com.amazonaws.sagemaker#RenderingError": { "type": "structure", "members": { - "Message": { + "Code": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

    A human-readable message describing the error.

    ", + "smithy.api#documentation": "

    A unique identifier for a specific class of errors.

    ", "smithy.api#required": {} } }, - "Code": { + "Message": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

    A unique identifier for a specific class of errors.

    ", + "smithy.api#documentation": "

    A human-readable message describing the error.

    ", "smithy.api#required": {} } } @@ -18256,6 +18335,21 @@ "target": "com.amazonaws.sagemaker#RenderingError" } }, + "com.amazonaws.sagemaker#RepositoryAccessMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Platform", + "name": "PLATFORM" + }, + { + "value": "Vpc", + "name": "VPC" + } + ] + } + }, "com.amazonaws.sagemaker#ResolvedAttributes": { "type": "structure", "members": { @@ -18265,11 +18359,11 @@ "smithy.api#documentation": "

    The problem type.

    " } }, - "CompletionCriteria": { - "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" - }, "AutoMLJobObjective": { "target": "com.amazonaws.sagemaker#AutoMLJobObjective" + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" } }, "traits": { @@ -18284,24 +18378,11 @@ "max": 256 }, "smithy.api#pattern": "arn:.*" - } - }, - "com.amazonaws.sagemaker#ResourceConfig": { - "type": "structure", - "members": { - "VolumeKmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", - "traits": { - "smithy.api#documentation": "

    The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.

    \n \n

    Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

    \n

    For a list of instance types that support local instance storage, see Instance Store Volumes.

    \n

    For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

    \n     \n

    The VolumeKmsKeyId can be in any of the following formats:

    \n
      \n
    • \n

      // KMS Key ID

      \n

      \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      // Amazon Resource Name (ARN) of a KMS Key

      \n

      \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    " - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#TrainingInstanceType", - "traits": { - "smithy.api#documentation": "

    The ML compute instance type.

    ", - "smithy.api#required": {} - } - }, + } + }, + "com.amazonaws.sagemaker#ResourceConfig": { + "type": "structure", + "members": { "InstanceCount": { "target": "com.amazonaws.sagemaker#TrainingInstanceCount", "traits": { @@ -18315,6 +18396,19 @@ "smithy.api#documentation": "

    The size of the ML storage volume that you want to provision.

    \n

    ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.

    \n

    You must specify sufficient ML storage for your scenario.

    \n \n

    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.\n

    \n     \n \n

    Certain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for training, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.

    \n

    For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.

    \n     ", "smithy.api#required": {} } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#documentation": "

    The ML compute instance type.

    ", + "smithy.api#required": {} + } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.

    \n \n

    Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

    \n

    For a list of instance types that support local instance storage, see Instance Store Volumes.

    \n

    For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

    \n     \n

    The VolumeKmsKeyId can be in any of the following formats:

    \n
      \n
    • \n

      // KMS Key ID

      \n

      \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      // Amazon Resource Name (ARN) of a KMS Key

      \n

      \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    " + } } }, "traits": { @@ -18357,17 +18451,17 @@ "com.amazonaws.sagemaker#ResourceLimits": { "type": "structure", "members": { - "MaxParallelTrainingJobs": { - "target": "com.amazonaws.sagemaker#MaxParallelTrainingJobs", + "MaxNumberOfTrainingJobs": { + "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs", "traits": { - "smithy.api#documentation": "

    The\n maximum\n number of concurrent training jobs that a hyperparameter tuning job can\n launch.

    ", + "smithy.api#documentation": "

    The\n maximum\n number of training jobs that a hyperparameter tuning job can\n launch.

    ", "smithy.api#required": {} } }, - "MaxNumberOfTrainingJobs": { - "target": "com.amazonaws.sagemaker#MaxNumberOfTrainingJobs", + "MaxParallelTrainingJobs": { + "target": "com.amazonaws.sagemaker#MaxParallelTrainingJobs", "traits": { - "smithy.api#documentation": "

    The\n maximum\n number of training jobs that a hyperparameter tuning job can\n launch.

    ", + "smithy.api#documentation": "

    The\n maximum\n number of concurrent training jobs that a hyperparameter tuning job can\n launch.

    ", "smithy.api#required": {} } } @@ -18585,12 +18679,6 @@ "com.amazonaws.sagemaker#S3DataSource": { "type": "structure", "members": { - "S3DataDistributionType": { - "target": "com.amazonaws.sagemaker#S3DataDistribution", - "traits": { - "smithy.api#documentation": "

    If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.

    \n

    If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.

    \n

    Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.

    \n

    In distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.

    " - } - }, "AttributeNames": { "target": "com.amazonaws.sagemaker#AttributeNames", "traits": { @@ -18607,9 +18695,15 @@ "S3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:

    \n
      \n
    • \n

      A key name prefix might look like this:\n s3://bucketname/exampleprefix\n

      \n
      • \n
    • \n

      A manifest might look like this:\n s3://bucketname/example.manifest\n

      \n

      A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set\n of S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.

      \n

      The following code example shows a valid manifest format:

      \n

      \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

      \n

      \n \"relative/path/to/custdata-1\",\n

      \n

      \n \"relative/path/custdata-2\",\n

      \n

      \n ...\n

      \n

      \n \"relative/path/custdata-N\"\n

      \n

      \n ]\n

      \n

      This JSON is equivalent to the following S3Uri list:

      \n

      \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

      \n

      \n ...\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

      \n

      The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on\n your behalf.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:

    \n
      \n
    • \n

      A key name prefix might look like this:\n s3://bucketname/exampleprefix\n

      \n
      • \n
    • \n

      A manifest might look like this:\n s3://bucketname/example.manifest\n

      \n

      A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set\n of S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.

      \n

      The following code example shows a valid manifest format:

      \n

      \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

      \n

      \n \"relative/path/to/custdata-1\",\n

      \n

      \n \"relative/path/custdata-2\",\n

      \n

      \n ...\n

      \n

      \n \"relative/path/custdata-N\"\n

      \n

      \n ]\n

      \n

      This JSON is equivalent to the following S3Uri\n list:

      \n

      \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

      \n

      \n ...\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

      \n

      The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on\n your behalf.

      \n
      • \n
    ", "smithy.api#required": {} } + }, + "S3DataDistributionType": { + "target": "com.amazonaws.sagemaker#S3DataDistribution", + "traits": { + "smithy.api#documentation": "

    If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.

    \n

    If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.

    \n

    Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.

    \n

    In distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.

    " + } } }, "traits": { @@ -19066,7 +19160,7 @@ "sdkId": "SageMaker", "arnNamespace": "sagemaker", "cloudFormationName": "SageMaker", - "cloudTrailEventSource": "api.sagemaker.amazonaws.com" + "cloudTrailEventSource": "sagemaker.amazonaws.com" }, "aws.auth#sigv4": { "name": "sagemaker" @@ -19156,12 +19250,6 @@ "com.amazonaws.sagemaker#SearchExpression": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.sagemaker#FilterList", - "traits": { - "smithy.api#documentation": "

    A list of filter objects.

    " - } - }, "SubExpressions": { "target": "com.amazonaws.sagemaker#SearchExpressionList", "traits": { @@ -19179,6 +19267,12 @@ "traits": { "smithy.api#documentation": "

    A list of nested filter objects.

    " } + }, + "Filters": { + "target": "com.amazonaws.sagemaker#FilterList", + "traits": { + "smithy.api#documentation": "

    A list of filter objects.

    " + } } }, "traits": { @@ -19200,18 +19294,6 @@ "com.amazonaws.sagemaker#SearchRecord": { "type": "structure", "members": { - "Trial": { - "target": "com.amazonaws.sagemaker#Trial", - "traits": { - "smithy.api#documentation": "

    The properties of a trial.

    " - } - }, - "Experiment": { - "target": "com.amazonaws.sagemaker#Experiment", - "traits": { - "smithy.api#documentation": "

    The properties of an experiment.

    " - } - }, "TrialComponent": { "target": "com.amazonaws.sagemaker#TrialComponent", "traits": { @@ -19223,6 +19305,18 @@ "traits": { "smithy.api#documentation": "

    The properties of a training job.

    " } + }, + "Experiment": { + "target": "com.amazonaws.sagemaker#Experiment", + "traits": { + "smithy.api#documentation": "

    The properties of an experiment.

    " + } + }, + "Trial": { + "target": "com.amazonaws.sagemaker#Trial", + "traits": { + "smithy.api#documentation": "

    The properties of a trial.

    " + } } }, "traits": { @@ -19232,11 +19326,10 @@ "com.amazonaws.sagemaker#SearchRequest": { "type": "structure", "members": { - "Resource": { - "target": "com.amazonaws.sagemaker#ResourceType", + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

    The name of the Amazon SageMaker resource to search for.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If more than MaxResults resources match the specified\n SearchExpression, the response includes a\n NextToken. The NextToken can be passed to the next\n SearchRequest to continue retrieving results.

    " } }, "SortOrder": { @@ -19257,10 +19350,11 @@ "smithy.api#documentation": "

    The name of the resource property used to sort the SearchResults. The\n default is LastModifiedTime.

    " } }, - "NextToken": { - "target": "com.amazonaws.sagemaker#NextToken", + "Resource": { + "target": "com.amazonaws.sagemaker#ResourceType", "traits": { - "smithy.api#documentation": "

    If more than MaxResults resources match the specified\n SearchExpression, the response includes a\n NextToken. The NextToken can be passed to the next\n SearchRequest to continue retrieving results.

    " + "smithy.api#documentation": "

    The name of the Amazon SageMaker resource to search for.

    ", + "smithy.api#required": {} } }, "MaxResults": { @@ -19382,11 +19476,10 @@ "smithy.api#documentation": "

    A detailed description of the progress within a secondary status.\n

    \n

    Amazon SageMaker provides secondary statuses and status messages that apply to each of\n them:

    \n
    \n
    Starting
    \n
    \n
      \n
    • \n

      Starting the training job.

      \n
      • \n
    • \n

      Launching\n requested ML instances.

      \n
      • \n
    • \n

      Insufficient\n capacity error from EC2 while launching instances,\n retrying!

      \n
      • \n
    • \n

      Launched\n instance was unhealthy, replacing it!

      \n
      • \n
    • \n

      Preparing the instances for training.

      \n
      • \n
    \n
    \n
    Training
    \n
    \n
      \n
    • \n

      Downloading the training image.

      \n
      • \n
    • \n

      Training\n image download completed. Training in\n progress.

      \n
      • \n
    \n
    \n
    \n \n

    Status messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.

    \n     \n

    To have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For\n example, at the start of a training job, you might see the following:

    \n
      \n
    • \n

      \n TrainingJobStatus - InProgress

      \n
      • \n
    • \n

      \n SecondaryStatus - Training

      \n
      • \n
    • \n

      \n StatusMessage - Downloading the training image

      \n
      • \n
    " } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the training job transitioned to the current secondary\n status state.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A timestamp that shows when the training job transitioned out of this secondary status\n state into another secondary status state or when the training job has ended.

    " } }, "Status": { @@ -19396,10 +19489,11 @@ "smithy.api#required": {} } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the training job transitioned out of this secondary status\n state into another secondary status state or when the training job has ended.

    " + "smithy.api#documentation": "

    A timestamp that shows when the training job transitioned to the current secondary\n status state.

    ", + "smithy.api#required": {} } } }, @@ -19461,22 +19555,22 @@ "com.amazonaws.sagemaker#SharingSettings": { "type": "structure", "members": { - "NotebookOutputOption": { - "target": "com.amazonaws.sagemaker#NotebookOutputOption", + "S3KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

    Whether to include the notebook cell output when sharing the notebook. The default\n is Disabled.

    " + "smithy.api#documentation": "

    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS)\n encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

    " } }, "S3OutputPath": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    When NotebookOutputOption is Allowed, the Amazon S3 bucket used\n to save the notebook cell output. If S3OutputPath isn't specified, a default\n bucket is used.

    " + "smithy.api#documentation": "

    When NotebookOutputOption is Allowed, the Amazon S3 bucket used\n to save the notebook cell output.

    " } }, - "S3KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "NotebookOutputOption": { + "target": "com.amazonaws.sagemaker#NotebookOutputOption", "traits": { - "smithy.api#documentation": "

    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS)\n encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

    " + "smithy.api#documentation": "

    Whether to include the notebook cell output when sharing the notebook. The default\n is Disabled.

    " } } }, @@ -19505,6 +19599,16 @@ "smithy.api#pattern": "UserName" } }, + "com.amazonaws.sagemaker#SnsTopicArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*" + } + }, "com.amazonaws.sagemaker#SortBy": { "type": "string", "traits": { @@ -19597,7 +19701,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

    The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

    " + "smithy.api#documentation": "

    The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

    \n \n

    The model artifacts must be in an S3 bucket that is in the same region as the\n algorithm.

    \n     " } } }, @@ -19644,7 +19748,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. For more information, see .

    " + "smithy.api#documentation": "

    A list of IP address ranges (CIDRs). Used to create an allow\n list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an \n IP address within this range. By default, a workforce isn't restricted to specific IP addresses.

    " } }, "com.amazonaws.sagemaker#SourceType": { @@ -19976,17 +20080,17 @@ "com.amazonaws.sagemaker#StoppingCondition": { "type": "structure", "members": { - "MaxWaitTimeInSeconds": { - "target": "com.amazonaws.sagemaker#MaxWaitTimeInSeconds", - "traits": { - "smithy.api#documentation": "

    The maximum length of time, in seconds, how long you are willing to wait for a managed\n spot training job to complete. It is the amount of time spent waiting for Spot capacity\n plus the amount of time the training job runs. It must be equal to or greater than\n MaxRuntimeInSeconds.

    " - } - }, "MaxRuntimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxRuntimeInSeconds", "traits": { "smithy.api#documentation": "

    The maximum length of time, in seconds, that the training or compilation job can run.\n If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified,\n default value is 1 day. The maximum value is 28 days.

    " } + }, + "MaxWaitTimeInSeconds": { + "target": "com.amazonaws.sagemaker#MaxWaitTimeInSeconds", + "traits": { + "smithy.api#documentation": "

    The maximum length of time, in seconds, how long you are willing to wait for a managed\n spot training job to complete. It is the amount of time spent waiting for Spot capacity\n plus the amount of time the training job runs. It must be equal to or greater than\n MaxRuntimeInSeconds.

    " + } } }, "traits": { @@ -20059,6 +20163,12 @@ "com.amazonaws.sagemaker#SubscribedWorkteam": { "type": "structure", "members": { + "MarketplaceDescription": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#documentation": "

    The description of the vendor from the Amazon Marketplace.

    " + } + }, "WorkteamArn": { "target": "com.amazonaws.sagemaker#WorkteamArn", "traits": { @@ -20066,10 +20176,10 @@ "smithy.api#required": {} } }, - "MarketplaceTitle": { - "target": "com.amazonaws.sagemaker#String200", + "SellerName": { + "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

    The title of the service provided by the vendor in the Amazon Marketplace.

    " + "smithy.api#documentation": "

    The name of the vendor in the Amazon Marketplace.

    " } }, "ListingId": { @@ -20078,16 +20188,10 @@ "smithy.api#documentation": "

    Marketplace product listing ID.

    " } }, - "MarketplaceDescription": { + "MarketplaceTitle": { "target": "com.amazonaws.sagemaker#String200", "traits": { - "smithy.api#documentation": "

    The description of the vendor from the Amazon Marketplace.

    " - } - }, - "SellerName": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "

    The name of the vendor in the Amazon Marketplace.

    " + "smithy.api#documentation": "

    The title of the service provided by the vendor in the Amazon Marketplace.

    " } } }, @@ -20131,17 +20235,17 @@ "com.amazonaws.sagemaker#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.sagemaker#TagValue", + "Key": { + "target": "com.amazonaws.sagemaker#TagKey", "traits": { - "smithy.api#documentation": "

    The tag value.

    ", + "smithy.api#documentation": "

    The tag key.

    ", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.sagemaker#TagKey", + "Value": { + "target": "com.amazonaws.sagemaker#TagValue", "traits": { - "smithy.api#documentation": "

    The tag key.

    ", + "smithy.api#documentation": "

    The tag value.

    ", "smithy.api#required": {} } } @@ -20309,6 +20413,10 @@ { "value": "x86_win64", "name": "X86_WIN64" + }, + { + "value": "coreml", + "name": "COREML" } ] } @@ -20322,29 +20430,29 @@ "com.amazonaws.sagemaker#TargetPlatform": { "type": "structure", "members": { + "Arch": { + "target": "com.amazonaws.sagemaker#TargetPlatformArch", + "traits": { + "smithy.api#documentation": "

    Specifies a target platform architecture.

    \n
      \n
    • \n

      \n X86_64: 64-bit version of the x86 instruction set.

      \n
      • \n
    • \n

      \n X86: 32-bit version of the x86 instruction set.

      \n
      • \n
    • \n

      \n ARM64: ARMv8 64-bit CPU.

      \n
      • \n
    • \n

      \n ARM_EABIHF: ARMv7 32-bit, Hard Float.

      \n
      • \n
    • \n

      \n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM\n platform.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, "Os": { "target": "com.amazonaws.sagemaker#TargetPlatformOs", "traits": { - "smithy.api#documentation": "

    Specifies a target platform OS.

    \n
      \n
    • \n

      \n LINUX: Linux-based operating systems.

      \n
      • \n
    • \n

      \n ANDROID: Android operating systems. Android API level can be specified\n using the ANDROID_PLATFORM compiler option. \n For example, \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies a target platform OS.

    \n
      \n
    • \n

      \n LINUX: Linux-based operating systems.

      \n
      • \n
    • \n

      \n ANDROID: Android operating systems. Android API level can be\n specified using the ANDROID_PLATFORM compiler option. For example,\n \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n

      \n
      • \n
    ", "smithy.api#required": {} } }, "Accelerator": { "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", "traits": { - "smithy.api#documentation": "

    Specifies a target platform accelerator (optional).

    \n
      \n
    • \n

      \n NVIDIA: Nvidia graphics processing unit. It also requires gpu-code,\n trt-ver, cuda-ver compiler options

      \n
      • \n
    • \n

      \n MALI: ARM Mali graphics processor

      \n
      • \n
    • \n

      \n INTEL_GRAPHICS: Integrated Intel graphics

      \n
      • \n
    " - } - }, - "Arch": { - "target": "com.amazonaws.sagemaker#TargetPlatformArch", - "traits": { - "smithy.api#documentation": "

    Specifies a target platform architecture.

    \n
      \n
    • \n

      \n X86_64: 64-bit version of the x86 instruction set.

      \n
      • \n
    • \n

      \n X86: 32-bit version of the x86 instruction set.

      \n
      • \n
    • \n

      \n ARM64: ARMv8 64-bit CPU.

      \n
      • \n
    • \n

      \n ARM_EABIHF: ARMv7 32-bit, Hard Float.

      \n
      • \n
    • \n

      \n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies a target platform accelerator (optional).

    \n
      \n
    • \n

      \n NVIDIA: Nvidia graphics processing unit. It also requires\n gpu-code, trt-ver, cuda-ver compiler\n options

      \n
      • \n
    • \n

      \n MALI: ARM Mali graphics processor

      \n
      • \n
    • \n

      \n INTEL_GRAPHICS: Integrated Intel graphics

      \n
      • \n
    " } } }, "traits": { - "smithy.api#documentation": "

    Contains information about a target platform that you want your model to run on,\n such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

    " + "smithy.api#documentation": "

    Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.

    " } }, "com.amazonaws.sagemaker#TargetPlatformAccelerator": { @@ -20534,18 +20642,18 @@ "com.amazonaws.sagemaker#TensorBoardOutputConfig": { "type": "structure", "members": { + "LocalPath": { + "target": "com.amazonaws.sagemaker#DirectoryPath", + "traits": { + "smithy.api#documentation": "

    Path to local storage location for tensorBoard output. Defaults to\n /opt/ml/output/tensorboard.

    " + } + }, "S3OutputPath": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#documentation": "

    Path to Amazon S3 storage location for TensorBoard output.

    ", "smithy.api#required": {} } - }, - "LocalPath": { - "target": "com.amazonaws.sagemaker#DirectoryPath", - "traits": { - "smithy.api#documentation": "

    Path to local storage location for tensorBoard output. Defaults to\n /opt/ml/output/tensorboard.

    " - } } }, "traits": { @@ -20755,130 +20863,133 @@ "com.amazonaws.sagemaker#TrainingJob": { "type": "structure", "members": { - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", - "traits": { - "smithy.api#documentation": "

    Resources, including ML compute instances and ML storage volumes, that are configured\n for model training.

    " - } - }, - "OutputDataConfig": { - "target": "com.amazonaws.sagemaker#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

    The S3 path where model artifacts that you configured when creating the job are\n stored. Amazon SageMaker creates subfolders for model artifacts.

    " - } - }, - "ModelArtifacts": { - "target": "com.amazonaws.sagemaker#ModelArtifacts", + "EnableManagedSpotTraining": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    Information about the Amazon S3 location that is configured for storing model\n artifacts.

    " + "smithy.api#documentation": "

    When true, enables managed spot training using Amazon EC2 Spot instances to run\n training jobs instead of on-demand instances. For more information, see Managed Spot Training.

    " } }, - "DebugRuleEvaluationStatuses": { - "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", - "traits": { - "smithy.api#documentation": "

    Information about the evaluation status of the rules for the training job.

    " - } + "CheckpointConfig": { + "target": "com.amazonaws.sagemaker#CheckpointConfig" }, - "VpcConfig": { - "target": "com.amazonaws.sagemaker#VpcConfig", + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that this training job has\n access to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

    " + "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) role configured for the training job.

    " } }, - "InputDataConfig": { - "target": "com.amazonaws.sagemaker#InputDataConfig", - "traits": { - "smithy.api#documentation": "

    An array of Channel objects that describes each data input\n channel.

    " - } + "DebugHookConfig": { + "target": "com.amazonaws.sagemaker#DebugHookConfig" }, - "EnableNetworkIsolation": { - "target": "com.amazonaws.sagemaker#Boolean", + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    If the TrainingJob was created with network isolation, the value is set\n to true. If network isolation is enabled, nodes can't communicate beyond\n the VPC they run in.

    " + "smithy.api#documentation": "

    Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " } }, - "StoppingCondition": { - "target": "com.amazonaws.sagemaker#StoppingCondition", + "TrainingStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Specifies a limit to how long a model training job can run. When the job reaches the\n time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    \n

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

    " + "smithy.api#documentation": "

    Indicates the time when the training job starts on training instances. You are billed\n for the time interval between this time and the value of TrainingEndTime.\n The start time in CloudWatch Logs might be later than this time. The difference is due to the time\n it takes to download the training data and to the size of the training container.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "AlgorithmSpecification": { + "target": "com.amazonaws.sagemaker#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " + "smithy.api#documentation": "

    Information about the algorithm used for training, and algorithm metadata.

    " } }, - "DebugRuleConfigurations": { - "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", + "TrainingTimeInSeconds": { + "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", "traits": { - "smithy.api#documentation": "

    Information about the debug rule configuration.

    " + "smithy.api#documentation": "

    The training time in seconds.

    " } }, - "AutoMLJobArn": { - "target": "com.amazonaws.sagemaker#AutoMLJobArn", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the job.

    " + "smithy.api#documentation": "

    If the training job failed, the reason it failed.

    " } }, - "TrainingStartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "LabelingJobArn": { + "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { - "smithy.api#documentation": "

    Indicates the time when the training job starts on training instances. You are billed\n for the time interval between this time and the value of TrainingEndTime.\n The start time in CloudWatch Logs might be later than this time. The difference is due to the time\n it takes to download the training data and to the size of the training container.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the labeling job.

    " } }, - "AlgorithmSpecification": { - "target": "com.amazonaws.sagemaker#AlgorithmSpecification", + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", "traits": { - "smithy.api#documentation": "

    Information about the algorithm used for training, and algorithm metadata.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the training job.

    " } }, - "TrainingJobName": { - "target": "com.amazonaws.sagemaker#TrainingJobName", + "SecondaryStatusTransitions": { + "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", "traits": { - "smithy.api#documentation": "

    The name of the training job.

    " + "smithy.api#documentation": "

    A history of all of the secondary statuses that the training job has transitioned\n through.

    " } }, + "TensorBoardOutputConfig": { + "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" + }, "SecondaryStatus": { "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { "smithy.api#documentation": "

    Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.

    \n

    Amazon SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

    \n
    \n
    InProgress
    \n
    \n
      \n
    • \n

      \n Starting\n - Starting the training job.

      \n
      • \n
    • \n

      \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

      \n
      • \n
    • \n

      \n Training - Training is in progress.

      \n
      • \n
    • \n

      \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

      \n
      • \n
    \n
    \n
    Completed
    \n
    \n
      \n
    • \n

      \n Completed - The training job has completed.

      \n
      • \n
    \n
    \n
    Failed
    \n
    \n
      \n
    • \n

      \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

      \n
      • \n
    \n
    \n
    Stopped
    \n
    \n
      \n
    • \n

      \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

      \n
      • \n
    • \n

      \n Stopped - The training job has stopped.

      \n
      • \n
    \n
    \n
    Stopping
    \n
    \n
      \n
    • \n

      \n Stopping - Stopping the training job.

      \n
      • \n
    \n
    \n
    \n \n

    Valid values for SecondaryStatus are subject to change.

    \n     \n

    We no longer support the following secondary statuses:

    \n
      \n
    • \n

      \n LaunchingMLInstances\n

      \n
      • \n
    • \n

      \n PreparingTrainingStack\n

      \n
      • \n
    • \n

      \n DownloadingTrainingImage\n

      \n
      • \n
    " } }, + "BillableTimeInSeconds": { + "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", + "traits": { + "smithy.api#documentation": "

    The billable time in seconds.

    " + } + }, "HyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { "smithy.api#documentation": "

    Algorithm-specific parameters.

    " } }, - "FinalMetricDataList": { - "target": "com.amazonaws.sagemaker#FinalMetricDataList", + "TuningJobArn": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", "traits": { - "smithy.api#documentation": "

    A list of final metric values that are set when the training job completes. Used only\n if the training job was configured to use metrics.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.

    " } }, - "SecondaryStatusTransitions": { - "target": "com.amazonaws.sagemaker#SecondaryStatusTransitions", + "EnableInterContainerTrafficEncryption": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    A history of all of the secondary statuses that the training job has transitioned\n through.

    " + "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.

    " } }, - "BillableTimeInSeconds": { - "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", + "EnableNetworkIsolation": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    The billable time in seconds.

    " + "smithy.api#documentation": "

    If the TrainingJob was created with network isolation, the value is set\n to true. If network isolation is enabled, nodes can't communicate beyond\n the VPC they run in.

    " } }, - "CheckpointConfig": { - "target": "com.amazonaws.sagemaker#CheckpointConfig" + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A timestamp that indicates when the status of the training job was last\n modified.

    " + } }, - "DebugHookConfig": { - "target": "com.amazonaws.sagemaker#DebugHookConfig" + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A timestamp that indicates when the training job was created.

    " + } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "TrainingJobName": { + "target": "com.amazonaws.sagemaker#TrainingJobName", "traits": { - "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) role configured for the training job.

    " + "smithy.api#documentation": "

    The name of the training job.

    " + } + }, + "FinalMetricDataList": { + "target": "com.amazonaws.sagemaker#FinalMetricDataList", + "traits": { + "smithy.api#documentation": "

    A list of final metric values that are set when the training job completes. Used only\n if the training job was configured to use metrics.

    " } }, "TrainingJobStatus": { @@ -20887,70 +20998,67 @@ "smithy.api#documentation": "

    The status of the\n training\n job.

    \n

    Training job statuses are:

    \n
      \n
    • \n

      \n InProgress - The training is in progress.

      \n
      • \n
    • \n

      \n Completed - The training job has completed.

      \n
      • \n
    • \n

      \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

      \n
      • \n
    • \n

      \n Stopping - The training job is stopping.

      \n
      • \n
    • \n

      \n Stopped - The training job has stopped.

      \n
      • \n
    \n

    For\n more detailed information, see SecondaryStatus.

    " } }, - "EnableManagedSpotTraining": { - "target": "com.amazonaws.sagemaker#Boolean", + "VpcConfig": { + "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "

    When true, enables managed spot training using Amazon EC2 Spot instances to run\n training jobs instead of on-demand instances. For more information, see Managed Spot Training.

    " + "smithy.api#documentation": "

    A VpcConfig object that specifies the VPC that this training job has\n access to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.

    " } }, - "TuningJobArn": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", + "InputDataConfig": { + "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the\n training job was launched by a hyperparameter tuning job.

    " + "smithy.api#documentation": "

    An array of Channel objects that describes each data input\n channel.

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "OutputDataConfig": { + "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "

    If the training job failed, the reason it failed.

    " + "smithy.api#documentation": "

    The S3 path where model artifacts that you configured when creating the job are\n stored. Amazon SageMaker creates subfolders for model artifacts.

    " } }, - "LabelingJobArn": { - "target": "com.amazonaws.sagemaker#LabelingJobArn", + "ModelArtifacts": { + "target": "com.amazonaws.sagemaker#ModelArtifacts", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the labeling job.

    " + "smithy.api#documentation": "

    Information about the Amazon S3 location that is configured for storing model\n artifacts.

    " } }, - "ExperimentConfig": { - "target": "com.amazonaws.sagemaker#ExperimentConfig" - }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "AutoMLJobArn": { + "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "

    A timestamp that indicates when the status of the training job was last\n modified.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the job.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ExperimentConfig": { + "target": "com.amazonaws.sagemaker#ExperimentConfig" + }, + "DebugRuleEvaluationStatuses": { + "target": "com.amazonaws.sagemaker#DebugRuleEvaluationStatuses", "traits": { - "smithy.api#documentation": "

    A timestamp that indicates when the training job was created.

    " + "smithy.api#documentation": "

    Information about the evaluation status of the rules for the training job.

    " } }, - "TensorBoardOutputConfig": { - "target": "com.amazonaws.sagemaker#TensorBoardOutputConfig" - }, - "TrainingTimeInSeconds": { - "target": "com.amazonaws.sagemaker#TrainingTimeInSeconds", + "DebugRuleConfigurations": { + "target": "com.amazonaws.sagemaker#DebugRuleConfigurations", "traits": { - "smithy.api#documentation": "

    The training time in seconds.

    " + "smithy.api#documentation": "

    Information about the debug rule configuration.

    " } }, - "EnableInterContainerTrafficEncryption": { - "target": "com.amazonaws.sagemaker#Boolean", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    To encrypt all communications between ML compute instances in distributed training,\n choose True. Encryption provides greater security for distributed training,\n but training might take longer. How long it takes depends on the amount of communication\n between compute instances, especially if you use a deep learning algorithm in\n distributed training.

    " + "smithy.api#documentation": "

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

    " } }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the training job.

    " + "smithy.api#documentation": "

    Specifies a limit to how long a model training job can run. When the job reaches the\n time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    \n

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

    " } }, - "TrainingEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

    Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " + "smithy.api#documentation": "

    Resources, including ML compute instances and ML storage volumes, that are configured\n for model training.

    " } } }, @@ -20971,19 +21079,6 @@ "com.amazonaws.sagemaker#TrainingJobDefinition": { "type": "structure", "members": { - "TrainingInputMode": { - "target": "com.amazonaws.sagemaker#TrainingInputMode", - "traits": { - "smithy.api#documentation": "

    The input mode used by the algorithm for the training job. For the input modes that\n Amazon SageMaker algorithms support, see Algorithms.

    \n

    If an algorithm supports the File input mode, Amazon SageMaker downloads the training\n data from S3 to the provisioned ML storage Volume, and mounts the directory to docker\n volume for training container. If an algorithm supports the Pipe input\n mode, Amazon SageMaker streams data directly from S3 to the container.

    ", - "smithy.api#required": {} - } - }, - "HyperParameters": { - "target": "com.amazonaws.sagemaker#HyperParameters", - "traits": { - "smithy.api#documentation": "

    The hyperparameters used for the training job.

    " - } - }, "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { @@ -20998,10 +21093,16 @@ "smithy.api#required": {} } }, - "ResourceConfig": { - "target": "com.amazonaws.sagemaker#ResourceConfig", + "HyperParameters": { + "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "

    The resources, including the ML compute instances and ML storage volumes, to use for\n model training.

    ", + "smithy.api#documentation": "

    The hyperparameters used for the training job.

    " + } + }, + "TrainingInputMode": { + "target": "com.amazonaws.sagemaker#TrainingInputMode", + "traits": { + "smithy.api#documentation": "

    The input mode used by the algorithm for the training job. For the input modes that\n Amazon SageMaker algorithms support, see Algorithms.

    \n

    If an algorithm supports the File input mode, Amazon SageMaker downloads the training\n data from S3 to the provisioned ML storage Volume, and mounts the directory to docker\n volume for training container. If an algorithm supports the Pipe input\n mode, Amazon SageMaker streams data directly from S3 to the container.

    ", "smithy.api#required": {} } }, @@ -21011,6 +21112,13 @@ "smithy.api#documentation": "

    Specifies a limit to how long a model training job can run. When the job reaches the\n time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    \n

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.

    ", "smithy.api#required": {} } + }, + "ResourceConfig": { + "target": "com.amazonaws.sagemaker#ResourceConfig", + "traits": { + "smithy.api#documentation": "

    The resources, including the ML compute instances and ML storage volumes, to use for\n model training.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -21103,34 +21211,34 @@ "com.amazonaws.sagemaker#TrainingJobStatusCounters": { "type": "structure", "members": { - "RetryableError": { + "InProgress": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "

    The number of training jobs that failed, but can be retried. A failed training job can\n be retried only if it failed because an internal service error occurred.

    " + "smithy.api#documentation": "

    The number of in-progress training jobs launched by a hyperparameter tuning\n job.

    " } }, - "NonRetryableError": { + "Stopped": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "

    The number of training jobs that failed and can't be retried. A failed training job\n can't be retried if it failed because a client error occurred.

    " + "smithy.api#documentation": "

    The number of training jobs launched by a hyperparameter tuning job that were\n manually\n stopped.

    " } }, - "Completed": { + "NonRetryableError": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "

    The number of completed training jobs launched by the hyperparameter tuning\n job.

    " + "smithy.api#documentation": "

    The number of training jobs that failed and can't be retried. A failed training job\n can't be retried if it failed because a client error occurred.

    " } }, - "Stopped": { + "RetryableError": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "

    The number of training jobs launched by a hyperparameter tuning job that were\n manually\n stopped.

    " + "smithy.api#documentation": "

    The number of training jobs that failed, but can be retried. A failed training job can\n be retried only if it failed because an internal service error occurred.

    " } }, - "InProgress": { + "Completed": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounter", "traits": { - "smithy.api#documentation": "

    The number of in-progress training jobs launched by a hyperparameter tuning\n job.

    " + "smithy.api#documentation": "

    The number of completed training jobs launched by the hyperparameter tuning\n job.

    " } } }, @@ -21147,24 +21255,11 @@ "com.amazonaws.sagemaker#TrainingJobSummary": { "type": "structure", "members": { - "TrainingJobStatus": { - "target": "com.amazonaws.sagemaker#TrainingJobStatus", - "traits": { - "smithy.api#documentation": "

    The status of the training job.

    ", - "smithy.api#required": {} - } - }, - "TrainingJobArn": { - "target": "com.amazonaws.sagemaker#TrainingJobArn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the training job.

    ", - "smithy.api#required": {} - } - }, - "TrainingEndTime": { + "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the training job ended. This field is set only if the\n training job has one of the terminal statuses (Completed,\n Failed, or Stopped).

    " + "smithy.api#documentation": "

    A timestamp that shows when the training job was created.

    ", + "smithy.api#required": {} } }, "LastModifiedTime": { @@ -21180,12 +21275,25 @@ "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "TrainingJobArn": { + "target": "com.amazonaws.sagemaker#TrainingJobArn", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the training job was created.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the training job.

    ", "smithy.api#required": {} } + }, + "TrainingJobStatus": { + "target": "com.amazonaws.sagemaker#TrainingJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the training job.

    ", + "smithy.api#required": {} + } + }, + "TrainingEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    A timestamp that shows when the training job ended. This field is set only if the\n training job has one of the terminal statuses (Completed,\n Failed, or Stopped).

    " + } } }, "traits": { @@ -21195,23 +21303,11 @@ "com.amazonaws.sagemaker#TrainingSpecification": { "type": "structure", "members": { - "SupportedTuningJobObjectiveMetrics": { - "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectives", - "traits": { - "smithy.api#documentation": "

    A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.

    " - } - }, - "TrainingChannels": { - "target": "com.amazonaws.sagemaker#ChannelSpecifications", - "traits": { - "smithy.api#documentation": "

    A list of ChannelSpecification objects, which specify the input sources\n to be used by the algorithm.

    ", - "smithy.api#required": {} - } - }, - "SupportsDistributedTraining": { - "target": "com.amazonaws.sagemaker#Boolean", + "SupportedTrainingInstanceTypes": { + "target": "com.amazonaws.sagemaker#TrainingInstanceTypes", "traits": { - "smithy.api#documentation": "

    Indicates whether the algorithm supports distributed training. If set to false, buyers\n can't request more than one instance during training.

    " + "smithy.api#documentation": "

    A list of the instance types that this algorithm can use for training.

    ", + "smithy.api#required": {} } }, "SupportedHyperParameters": { @@ -21220,6 +21316,12 @@ "smithy.api#documentation": "

    A list of the HyperParameterSpecification objects, that define the\n supported hyperparameters. This is required if the algorithm supports automatic model\n tuning.>

    " } }, + "SupportsDistributedTraining": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the algorithm supports distributed training. If set to false, buyers\n can't request more than one instance during training.

    " + } + }, "MetricDefinitions": { "target": "com.amazonaws.sagemaker#MetricDefinitionList", "traits": { @@ -21233,17 +21335,23 @@ "smithy.api#required": {} } }, + "TrainingChannels": { + "target": "com.amazonaws.sagemaker#ChannelSpecifications", + "traits": { + "smithy.api#documentation": "

    A list of ChannelSpecification objects, which specify the input sources\n to be used by the algorithm.

    ", + "smithy.api#required": {} + } + }, "TrainingImageDigest": { "target": "com.amazonaws.sagemaker#ImageDigest", "traits": { "smithy.api#documentation": "

    An MD5 hash of the training algorithm that identifies the Docker image used for\n training.

    " } }, - "SupportedTrainingInstanceTypes": { - "target": "com.amazonaws.sagemaker#TrainingInstanceTypes", + "SupportedTuningJobObjectiveMetrics": { + "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjectives", "traits": { - "smithy.api#documentation": "

    A list of the instance types that this algorithm can use for training.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.

    " } } }, @@ -21313,6 +21421,12 @@ "com.amazonaws.sagemaker#TransformInput": { "type": "structure", "members": { + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "

    The multipurpose internet mail extension\n (MIME)\n type of the data. Amazon SageMaker uses the MIME type with each http call to\n transfer data to the transform job.

    " + } + }, "CompressionType": { "target": "com.amazonaws.sagemaker#CompressionType", "traits": { @@ -21326,16 +21440,10 @@ "smithy.api#required": {} } }, - "ContentType": { - "target": "com.amazonaws.sagemaker#ContentType", - "traits": { - "smithy.api#documentation": "

    The multipurpose internet mail extension\n (MIME)\n type of the data. Amazon SageMaker uses the MIME type with each http call to\n transfer data to the transform job.

    " - } - }, "SplitType": { "target": "com.amazonaws.sagemaker#SplitType", "traits": { - "smithy.api#documentation": "

    The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats.

    \n

    When splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.

    \n \n

    Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.

    \n

    For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

    \n     " + "smithy.api#documentation": "

    The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats. Currently, the supported record formats are:

    \n
      \n
    • \n

      RecordIO

      \n
      • \n
    • \n

      TFRecord

      \n
      • \n
    \n

    When splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.

    \n \n

    Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.

    \n

    For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

    \n     " } } }, @@ -21477,67 +21585,70 @@ "com.amazonaws.sagemaker#TransformJob": { "type": "structure", "members": { - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput" - }, - "ModelName": { - "target": "com.amazonaws.sagemaker#ModelName", + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", "traits": { - "smithy.api#documentation": "

    The name of the model associated with the transform job.

    " + "smithy.api#documentation": "

    The status of the transform job.

    \n

    Transform job statuses are:

    \n
      \n
    • \n

      \n InProgress - The job is in progress.

      \n
      • \n
    • \n

      \n Completed - The job has completed.

      \n
      • \n
    • \n

      \n Failed - The transform job has failed. To see the reason for the failure,\n see the FailureReason field in the response to a\n DescribeTransformJob call.

      \n
      • \n
    • \n

      \n Stopping - The transform job is stopping.

      \n
      • \n
    • \n

      \n Stopped - The transform job has stopped.

      \n
      • \n
    " } }, - "MaxPayloadInMB": { - "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The maximum allowed size of the payload, in MB. A payload is the data portion of a record\n (without metadata). The value in MaxPayloadInMB must be greater than, or equal\n to, the size of a single record. To estimate the size of a record in MB, divide the size of\n your dataset by the number of records. To ensure that the records fit within the maximum\n payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases\n where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,\n set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in\n algorithms do not support HTTP chunked encoding.

    " + "smithy.api#documentation": "

    A timestamp that shows when the transform Job was created.

    " } }, - "Environment": { - "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "ModelName": { + "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

    The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.

    " + "smithy.api#documentation": "

    The name of the model associated with the transform job.

    " } }, - "CreationTime": { + "TransformStartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the transform Job was created.

    " + "smithy.api#documentation": "

    Indicates when the transform job starts on ML instances. You are billed for the time\n interval between this time and the value of TransformEndTime.

    " } }, - "BatchStrategy": { - "target": "com.amazonaws.sagemaker#BatchStrategy", - "traits": { - "smithy.api#documentation": "

    Specifies the number of records to include in a mini-batch for an HTTP inference request.\n A record is a single unit of input data that inference can be made on. For example, a single\n line in a CSV file is a record.

    " - } + "ModelClientConfig": { + "target": "com.amazonaws.sagemaker#ModelClientConfig" }, - "TransformJobName": { - "target": "com.amazonaws.sagemaker#TransformJobName", + "MaxConcurrentTransforms": { + "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", "traits": { - "smithy.api#documentation": "

    The name of the transform job.

    " + "smithy.api#documentation": "

    The maximum number of parallel requests that can be sent to each instance in a transform\n job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the\n optional execution-parameters to determine the settings for your chosen algorithm. If the\n execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,\n you don't need to set a value for MaxConcurrentTransforms.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput" + }, + "TransformJobArn": { + "target": "com.amazonaws.sagemaker#TransformJobArn", "traits": { - "smithy.api#documentation": "

    A list of tags associated with the transform job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the transform job.

    " } }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources" + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput" }, - "TransformStartTime": { + "TransformEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Indicates when the transform job starts on ML instances. You are billed for the time\n interval between this time and the value of TransformEndTime.

    " + "smithy.api#documentation": "

    Indicates when the transform job has been completed, or has stopped or failed. You are\n billed for the time interval between this time and the value of\n TransformStartTime.

    " } }, - "ModelClientConfig": { - "target": "com.amazonaws.sagemaker#ModelClientConfig" + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "traits": { + "smithy.api#documentation": "

    The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.

    " + } }, - "MaxConcurrentTransforms": { - "target": "com.amazonaws.sagemaker#MaxConcurrentTransforms", + "DataProcessing": { + "target": "com.amazonaws.sagemaker#DataProcessing" + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The maximum number of parallel requests that can be sent to each instance in a transform\n job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the\n optional execution-parameters to determine the settings for your chosen algorithm. If the\n execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms,\n you don't need to set a value for MaxConcurrentTransforms.

    " + "smithy.api#documentation": "

    A list of tags associated with the transform job.

    " } }, "LabelingJobArn": { @@ -21549,41 +21660,38 @@ "ExperimentConfig": { "target": "com.amazonaws.sagemaker#ExperimentConfig" }, + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources" + }, "AutoMLJobArn": { "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

    " } }, - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "

    If the transform job failed, the reason it failed.

    " + "smithy.api#documentation": "

    Specifies the number of records to include in a mini-batch for an HTTP inference request.\n A record is a single unit of input data that inference can be made on. For example, a single\n line in a CSV file is a record.

    " } }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput" - }, - "TransformJobStatus": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", + "TransformJobName": { + "target": "com.amazonaws.sagemaker#TransformJobName", "traits": { - "smithy.api#documentation": "

    The status of the transform job.

    \n

    Transform job statuses are:

    \n
      \n
    • \n

      \n InProgress - The job is in progress.

      \n
      • \n
    • \n

      \n Completed - The job has completed.

      \n
      • \n
    • \n

      \n Failed - The transform job has failed. To see the reason for the failure,\n see the FailureReason field in the response to a\n DescribeTransformJob call.

      \n
      • \n
    • \n

      \n Stopping - The transform job is stopping.

      \n
      • \n
    • \n

      \n Stopped - The transform job has stopped.

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the transform job.

    " } }, - "TransformJobArn": { - "target": "com.amazonaws.sagemaker#TransformJobArn", + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the transform job.

    " + "smithy.api#documentation": "

    If the transform job failed, the reason it failed.

    " } }, - "TransformEndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "

    Indicates when the transform job has been completed, or has stopped or failed. You are\n billed for the time interval between this time and the value of\n TransformStartTime.

    " + "smithy.api#documentation": "

    The maximum allowed size of the payload, in MB. A payload is the data portion of a record\n (without metadata). The value in MaxPayloadInMB must be greater than, or equal\n to, the size of a single record. To estimate the size of a record in MB, divide the size of\n your dataset by the number of records. To ensure that the records fit within the maximum\n payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases\n where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding,\n set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in\n algorithms do not support HTTP chunked encoding.

    " } - }, - "DataProcessing": { - "target": "com.amazonaws.sagemaker#DataProcessing" } }, "traits": { @@ -21603,22 +21711,23 @@ "com.amazonaws.sagemaker#TransformJobDefinition": { "type": "structure", "members": { - "Environment": { - "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", + "MaxPayloadInMB": { + "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "

    The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.

    " + "smithy.api#documentation": "

    The maximum payload size allowed, in MB. A payload is the data portion of a record\n (without metadata).

    " } }, - "BatchStrategy": { - "target": "com.amazonaws.sagemaker#BatchStrategy", + "TransformResources": { + "target": "com.amazonaws.sagemaker#TransformResources", "traits": { - "smithy.api#documentation": "

    A string that determines the number of records included in a single mini-batch.

    \n

    \n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.

    " + "smithy.api#documentation": "

    Identifies the ML compute instances for the transform job.

    ", + "smithy.api#required": {} } }, - "TransformInput": { - "target": "com.amazonaws.sagemaker#TransformInput", + "TransformOutput": { + "target": "com.amazonaws.sagemaker#TransformOutput", "traits": { - "smithy.api#documentation": "

    A description of the input source and the way the transform job consumes it.

    ", + "smithy.api#documentation": "

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results\n from the transform job.

    ", "smithy.api#required": {} } }, @@ -21628,24 +21737,23 @@ "smithy.api#documentation": "

    The maximum number of parallel requests that can be sent to each instance in a\n transform job. The default value is 1.

    " } }, - "TransformOutput": { - "target": "com.amazonaws.sagemaker#TransformOutput", + "Environment": { + "target": "com.amazonaws.sagemaker#TransformEnvironmentMap", "traits": { - "smithy.api#documentation": "

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results\n from the transform job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The environment variables to set in the Docker container. We support up to 16 key and\n values entries in the map.

    " } }, - "TransformResources": { - "target": "com.amazonaws.sagemaker#TransformResources", + "BatchStrategy": { + "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "

    Identifies the ML compute instances for the transform job.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A string that determines the number of records included in a single mini-batch.

    \n

    \n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.

    " } }, - "MaxPayloadInMB": { - "target": "com.amazonaws.sagemaker#MaxPayloadInMB", + "TransformInput": { + "target": "com.amazonaws.sagemaker#TransformInput", "traits": { - "smithy.api#documentation": "

    The maximum payload size allowed, in MB. A payload is the data portion of a record\n (without metadata).

    " + "smithy.api#documentation": "

    A description of the input source and the way the transform job consumes it.

    ", + "smithy.api#required": {} } } }, @@ -21699,36 +21807,23 @@ "com.amazonaws.sagemaker#TransformJobSummary": { "type": "structure", "members": { - "FailureReason": { - "target": "com.amazonaws.sagemaker#FailureReason", - "traits": { - "smithy.api#documentation": "

    If the transform job failed,\n the\n reason it failed.

    " - } - }, - "TransformJobStatus": { - "target": "com.amazonaws.sagemaker#TransformJobStatus", - "traits": { - "smithy.api#documentation": "

    The status of the transform job.

    ", - "smithy.api#required": {} - } - }, "TransformEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { "smithy.api#documentation": "

    Indicates when the transform\n job\n ends on compute instances. For successful jobs and stopped jobs, this\n is the exact time\n recorded\n after the results are uploaded. For failed jobs, this is when Amazon SageMaker\n detected that the job failed.

    " } }, - "LastModifiedTime": { + "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Indicates when the transform job was last modified.

    " + "smithy.api#documentation": "

    A timestamp that shows when the transform Job was created.

    ", + "smithy.api#required": {} } }, - "CreationTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the transform Job was created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates when the transform job was last modified.

    " } }, "TransformJobArn": { @@ -21738,12 +21833,25 @@ "smithy.api#required": {} } }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "

    If the transform job failed,\n the\n reason it failed.

    " + } + }, "TransformJobName": { "target": "com.amazonaws.sagemaker#TransformJobName", "traits": { "smithy.api#documentation": "

    The name of the transform job.

    ", "smithy.api#required": {} } + }, + "TransformJobStatus": { + "target": "com.amazonaws.sagemaker#TransformJobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the transform job.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -21753,10 +21861,11 @@ "com.amazonaws.sagemaker#TransformOutput": { "type": "structure", "members": { - "KmsKeyId": { - "target": "com.amazonaws.sagemaker#KmsKeyId", + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

    \n
      \n
    • \n

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Alias name: alias/ExampleAlias\n

      \n
      • \n
    • \n

      Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

      \n
      • \n
    \n \n \n

    If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n \n

    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateModel request. For more information, see Using\n Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

    " + "smithy.api#documentation": "

    The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.

    \n

    For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.

    ", + "smithy.api#required": {} } }, "AssembleWith": { @@ -21771,11 +21880,10 @@ "smithy.api#documentation": "

    The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http\n call to transfer data from the transform job.

    " } }, - "S3OutputPath": { - "target": "com.amazonaws.sagemaker#S3Uri", + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

    The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.

    \n

    For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

    \n
      \n
    • \n

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Alias name: alias/ExampleAlias\n

      \n
      • \n
    • \n

      Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

      \n
      • \n
    \n \n \n

    If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n \n

    \n

    The KMS key policy must grant permission to the IAM role that you specify in your\n CreateModel request. For more information, see Using\n Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

    " } } }, @@ -21786,13 +21894,6 @@ "com.amazonaws.sagemaker#TransformResources": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.sagemaker#TransformInstanceCount", - "traits": { - "smithy.api#documentation": "

    The number of\n ML\n compute instances to use in the transform job. For distributed\n transform jobs, specify a value greater than 1. The default value is\n 1.

    ", - "smithy.api#required": {} - } - }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { @@ -21805,6 +21906,13 @@ "smithy.api#documentation": "

    The ML compute instance type for the transform job. If you are using built-in\n algorithms to\n transform\n moderately sized datasets, we recommend using ml.m4.xlarge or\n ml.m5.large\n instance types.

    ", "smithy.api#required": {} } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TransformInstanceCount", + "traits": { + "smithy.api#documentation": "

    The number of\n ML\n compute instances to use in the transform job. For distributed\n transform jobs, specify a value greater than 1. The default value is\n 1.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -21814,17 +21922,17 @@ "com.amazonaws.sagemaker#TransformS3DataSource": { "type": "structure", "members": { - "S3Uri": { - "target": "com.amazonaws.sagemaker#S3Uri", + "S3DataType": { + "target": "com.amazonaws.sagemaker#S3DataType", "traits": { - "smithy.api#documentation": "

    Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:

    \n
      \n
    • \n

      A key name prefix might look like this:\n s3://bucketname/exampleprefix.

      \n
      • \n
    • \n

      A manifest might look like this:\n s3://bucketname/example.manifest\n

      \n

      The manifest is an S3 object which is a JSON file with the following format:

      \n

      \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

      \n

      \n \"relative/path/to/custdata-1\",\n

      \n

      \n \"relative/path/custdata-2\",\n

      \n

      \n ...\n

      \n

      \n \"relative/path/custdata-N\"\n

      \n

      \n ]\n

      \n

      The preceding JSON matches the following S3Uris:

      \n

      \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

      \n

      \n ...\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

      \n

      The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.

      \n
      • \n
    ", + "smithy.api#documentation": "

    If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

    \n

    If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.

    \n

    The following values are compatible: ManifestFile,\n S3Prefix\n

    \n

    The following value is not compatible: AugmentedManifestFile\n

    ", "smithy.api#required": {} } }, - "S3DataType": { - "target": "com.amazonaws.sagemaker#S3DataType", + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

    If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

    \n

    If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.

    \n

    The following values are compatible: ManifestFile,\n S3Prefix\n

    \n

    The following value is not compatible: AugmentedManifestFile\n

    ", + "smithy.api#documentation": "

    Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:

    \n
      \n
    • \n

      A key name prefix might look like this:\n s3://bucketname/exampleprefix.

      \n
      • \n
    • \n

      A manifest might look like this:\n s3://bucketname/example.manifest\n

      \n

      The manifest is an S3 object which is a JSON file with the following format:

      \n

      \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

      \n

      \n \"relative/path/to/custdata-1\",\n

      \n

      \n \"relative/path/custdata-2\",\n

      \n

      \n ...\n

      \n

      \n \"relative/path/custdata-N\"\n

      \n

      \n ]\n

      \n

      The preceding JSON matches the following S3Uris:

      \n

      \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

      \n

      \n ...\n

      \n

      \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

      \n

      The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -21835,18 +21943,15 @@ }, "com.amazonaws.sagemaker#Trial": { "type": "structure", - "members": { - "ExperimentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "members": { + "TrialComponentSummaries": { + "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummaries", "traits": { - "smithy.api#documentation": "

    The name of the experiment the trial is part of.

    " + "smithy.api#documentation": "

    A list of the components associated with the trial. For each component, a summary of the\n component's properties is included.

    " } }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    When the trial was created.

    " - } + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" }, "TrialArn": { "target": "com.amazonaws.sagemaker#TrialArn", @@ -21860,8 +21965,20 @@ "smithy.api#documentation": "

    The name of the trial.

    " } }, - "Source": { - "target": "com.amazonaws.sagemaker#TrialSource" + "ExperimentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

    The name of the experiment the trial is part of.

    " + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    When the trial was created.

    " + } }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", @@ -21875,23 +21992,14 @@ "smithy.api#documentation": "

    The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" - }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { "smithy.api#documentation": "

    The list of tags that are associated with the trial. You can use Search\n API to search on the tags.

    " } }, - "TrialComponentSummaries": { - "target": "com.amazonaws.sagemaker#TrialComponentSimpleSummaries", - "traits": { - "smithy.api#documentation": "

    A list of the components associated with the trial. For each component, a summary of the\n component's properties is included.

    " - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" + "Source": { + "target": "com.amazonaws.sagemaker#TrialSource" } }, "traits": { @@ -21911,16 +22019,10 @@ "com.amazonaws.sagemaker#TrialComponent": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    When the component ended.

    " - } - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", "traits": { - "smithy.api#documentation": "

    When the component was created.

    " + "smithy.api#documentation": "

    The input artifacts of the component.

    " } }, "LastModifiedTime": { @@ -21929,8 +22031,11 @@ "smithy.api#documentation": "

    When the component was last modified.

    " } }, - "LastModifiedBy": { - "target": "com.amazonaws.sagemaker#UserContext" + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "traits": { + "smithy.api#documentation": "

    The output artifacts of the component.

    " + } }, "TrialComponentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", @@ -21938,19 +22043,22 @@ "smithy.api#documentation": "

    The name of the trial component.

    " } }, - "Metrics": { - "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The metrics for the component.

    " + "smithy.api#documentation": "

    The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    When the component was created.

    " + } }, - "Parameters": { - "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "Metrics": { + "target": "com.amazonaws.sagemaker#TrialComponentMetricSummaries", "traits": { - "smithy.api#documentation": "

    The hyperparameters of the component.

    " + "smithy.api#documentation": "

    The metrics for the component.

    " } }, "Parents": { @@ -21959,22 +22067,25 @@ "smithy.api#documentation": "

    An array of the parents of the component. A parent is a trial the component is associated\n with and the experiment the trial is part of. A component might not have any parents.

    " } }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The input artifacts of the component.

    " + "smithy.api#documentation": "

    When the component ended.

    " } }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "LastModifiedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "Source": { + "target": "com.amazonaws.sagemaker#TrialComponentSource", "traits": { - "smithy.api#documentation": "

    When the component started.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) and job type of the source of the component.

    " } }, - "TrialComponentArn": { - "target": "com.amazonaws.sagemaker#TrialComponentArn", + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial component.

    " + "smithy.api#documentation": "

    When the component started.

    " } }, "SourceDetail": { @@ -21983,32 +22094,29 @@ "smithy.api#documentation": "

    Details of the source of the component.

    " } }, - "Tags": { - "target": "com.amazonaws.sagemaker#TagList", + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", "traits": { - "smithy.api#documentation": "

    The list of tags that are associated with the component. You can use Search API to search on the tags.

    " + "smithy.api#documentation": "

    The hyperparameters of the component.

    " } }, - "Source": { - "target": "com.amazonaws.sagemaker#TrialComponentSource", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) and job type of the source of the component.

    " - } + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus" }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "TrialComponentArn": { + "target": "com.amazonaws.sagemaker#TrialComponentArn", "traits": { - "smithy.api#documentation": "

    The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial component.

    " } }, - "OutputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

    The output artifacts of the component.

    " + "smithy.api#documentation": "

    The list of tags that are associated with the component. You can use Search API to search on the tags.

    " } }, - "Status": { - "target": "com.amazonaws.sagemaker#TrialComponentStatus" + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" } }, "traits": { @@ -22028,18 +22136,18 @@ "com.amazonaws.sagemaker#TrialComponentArtifact": { "type": "structure", "members": { + "MediaType": { + "target": "com.amazonaws.sagemaker#MediaType", + "traits": { + "smithy.api#documentation": "

    The media type of the artifact, which indicates the type of data in the artifact file. The\n media type consists of a type and a subtype\n concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The\n type specifies the category of the media. The subtype specifies the kind of data.

    " + } + }, "Value": { "target": "com.amazonaws.sagemaker#TrialComponentArtifactValue", "traits": { "smithy.api#documentation": "

    The location of the artifact.

    ", "smithy.api#required": {} } - }, - "MediaType": { - "target": "com.amazonaws.sagemaker#MediaType", - "traits": { - "smithy.api#documentation": "

    The media type of the artifact, which indicates the type of data in the artifact file. The\n media type consists of a type and a subtype\n concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The\n type specifies the category of the media. The subtype specifies the kind of data.

    " - } } }, "traits": { @@ -22100,22 +22208,16 @@ "com.amazonaws.sagemaker#TrialComponentMetricSummary": { "type": "structure", "members": { - "TimeStamp": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    When the metric was last updated.

    " - } - }, - "SourceArn": { - "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "Max": { + "target": "com.amazonaws.sagemaker#OptionalDouble", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source.

    " + "smithy.api#documentation": "

    The maximum value of the metric.

    " } }, - "Last": { + "Avg": { "target": "com.amazonaws.sagemaker#OptionalDouble", "traits": { - "smithy.api#documentation": "

    The most recent value of the metric.

    " + "smithy.api#documentation": "

    The average value of the metric.

    " } }, "Count": { @@ -22130,10 +22232,10 @@ "smithy.api#documentation": "

    The minimum value of the metric.

    " } }, - "Avg": { - "target": "com.amazonaws.sagemaker#OptionalDouble", + "MetricName": { + "target": "com.amazonaws.sagemaker#MetricName", "traits": { - "smithy.api#documentation": "

    The average value of the metric.

    " + "smithy.api#documentation": "

    The name of the metric.

    " } }, "StdDev": { @@ -22142,16 +22244,22 @@ "smithy.api#documentation": "

    The standard deviation of the metric.

    " } }, - "Max": { - "target": "com.amazonaws.sagemaker#OptionalDouble", + "TimeStamp": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The maximum value of the metric.

    " + "smithy.api#documentation": "

    When the metric was last updated.

    " } }, - "MetricName": { - "target": "com.amazonaws.sagemaker#MetricName", + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", "traits": { - "smithy.api#documentation": "

    The name of the metric.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source.

    " + } + }, + "Last": { + "target": "com.amazonaws.sagemaker#OptionalDouble", + "traits": { + "smithy.api#documentation": "

    The most recent value of the metric.

    " } } }, @@ -22162,17 +22270,17 @@ "com.amazonaws.sagemaker#TrialComponentParameterValue": { "type": "structure", "members": { - "StringValue": { - "target": "com.amazonaws.sagemaker#StringParameterValue", - "traits": { - "smithy.api#documentation": "

    The string value of a categorical hyperparameter. If you specify a value for this\n parameter, you can't specify the NumberValue parameter.

    " - } - }, "NumberValue": { "target": "com.amazonaws.sagemaker#DoubleParameterValue", "traits": { "smithy.api#documentation": "

    The numeric value of a numeric hyperparameter. If you specify a value for this parameter,\n you can't specify the StringValue parameter.

    " } + }, + "StringValue": { + "target": "com.amazonaws.sagemaker#StringParameterValue", + "traits": { + "smithy.api#documentation": "

    The string value of a categorical hyperparameter. If you specify a value for this\n parameter, you can't specify the NumberValue parameter.

    " + } } }, "traits": { @@ -22230,15 +22338,18 @@ "com.amazonaws.sagemaker#TrialComponentSimpleSummary": { "type": "structure", "members": { - "TrialComponentSource": { - "target": "com.amazonaws.sagemaker#TrialComponentSource" - }, "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { "smithy.api#documentation": "

    When the component was created.

    " } }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext" + }, + "TrialComponentSource": { + "target": "com.amazonaws.sagemaker#TrialComponentSource" + }, "TrialComponentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { @@ -22250,9 +22361,6 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial component.

    " } - }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext" } }, "traits": { @@ -22262,18 +22370,18 @@ "com.amazonaws.sagemaker#TrialComponentSource": { "type": "structure", "members": { + "SourceType": { + "target": "com.amazonaws.sagemaker#SourceType", + "traits": { + "smithy.api#documentation": "

    The source job type.

    " + } + }, "SourceArn": { "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", "traits": { "smithy.api#documentation": "

    The source ARN.

    ", "smithy.api#required": {} } - }, - "SourceType": { - "target": "com.amazonaws.sagemaker#SourceType", - "traits": { - "smithy.api#documentation": "

    The source job type.

    " - } } }, "traits": { @@ -22293,28 +22401,28 @@ "com.amazonaws.sagemaker#TrialComponentSourceDetail": { "type": "structure", "members": { - "ProcessingJob": { - "target": "com.amazonaws.sagemaker#ProcessingJob", + "TrainingJob": { + "target": "com.amazonaws.sagemaker#TrainingJob", "traits": { - "smithy.api#documentation": "

    Information about a processing job that's the source of a trial component.

    " + "smithy.api#documentation": "

    Information about a training job that's the source of a trial component.

    " } }, - "SourceArn": { - "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", + "ProcessingJob": { + "target": "com.amazonaws.sagemaker#ProcessingJob", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source.

    " + "smithy.api#documentation": "

    Information about a processing job that's the source of a trial component.

    " } }, - "TrainingJob": { - "target": "com.amazonaws.sagemaker#TrainingJob", + "TransformJob": { + "target": "com.amazonaws.sagemaker#TransformJob", "traits": { - "smithy.api#documentation": "

    Information about a training job that's the source of a trial component.

    " + "smithy.api#documentation": "

    Information about a transform job that's the source of a trial component.

    " } }, - "TransformJob": { - "target": "com.amazonaws.sagemaker#TransformJob", + "SourceArn": { + "target": "com.amazonaws.sagemaker#TrialComponentSourceArn", "traits": { - "smithy.api#documentation": "

    Information about a transform job that's the source of the trial component.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source.

    " } } }, @@ -22325,17 +22433,17 @@ "com.amazonaws.sagemaker#TrialComponentStatus": { "type": "structure", "members": { - "PrimaryStatus": { - "target": "com.amazonaws.sagemaker#TrialComponentPrimaryStatus", - "traits": { - "smithy.api#documentation": "

    The status of the trial component.

    " - } - }, "Message": { "target": "com.amazonaws.sagemaker#TrialComponentStatusMessage", "traits": { "smithy.api#documentation": "

    If the component failed, a message describing why.

    " } + }, + "PrimaryStatus": { + "target": "com.amazonaws.sagemaker#TrialComponentPrimaryStatus", + "traits": { + "smithy.api#documentation": "

    The status of the trial component.

    " + } } }, "traits": { @@ -22361,10 +22469,10 @@ "com.amazonaws.sagemaker#TrialComponentSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of the component. States include:

    \n
      \n
    • \n

      InProgress

      \n
      • \n
    • \n

      Completed

      \n
      • \n
    • \n

      Failed

      \n
      • \n
    " + "smithy.api#documentation": "

    When the component ended.

    " } }, "LastModifiedBy": { @@ -22373,10 +22481,10 @@ "smithy.api#documentation": "

    Who last modified the component.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.sagemaker#UserContext", + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    Who created the component.

    " + "smithy.api#documentation": "

    The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

    " } }, "CreationTime": { @@ -22385,28 +22493,16 @@ "smithy.api#documentation": "

    When the component was created.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    When the component was last modified.

    " - } - }, - "StartTime": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    When the component started.

    " - } - }, "TrialComponentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { "smithy.api#documentation": "

    The name of the trial component.

    " } }, - "EndTime": { + "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    When the component ended.

    " + "smithy.api#documentation": "

    When the component was last modified.

    " } }, "TrialComponentArn": { @@ -22415,13 +22511,25 @@ "smithy.api#documentation": "

    The ARN of the trial component.

    " } }, + "CreatedBy": { + "target": "com.amazonaws.sagemaker#UserContext", + "traits": { + "smithy.api#documentation": "

    Who created the component.

    " + } + }, "TrialComponentSource": { "target": "com.amazonaws.sagemaker#TrialComponentSource" }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", "traits": { - "smithy.api#documentation": "

    The name of the component as displayed. If DisplayName isn't specified,\n TrialComponentName is displayed.

    " + "smithy.api#documentation": "

    The status of the component. States include:

    \n
      \n
    • \n

      InProgress

      \n
      • \n
    • \n

      Completed

      \n
      • \n
    • \n

      Failed

      \n
      • \n
    " + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    When the component started.

    " } } }, @@ -22469,19 +22577,19 @@ "com.amazonaws.sagemaker#TrialSummary": { "type": "structure", "members": { - "TrialName": { + "TrialSource": { + "target": "com.amazonaws.sagemaker#TrialSource" + }, + "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the trial.

    " + "smithy.api#documentation": "

    The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

    " } }, - "TrialSource": { - "target": "com.amazonaws.sagemaker#TrialSource" - }, - "CreationTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "TrialArn": { + "target": "com.amazonaws.sagemaker#TrialArn", "traits": { - "smithy.api#documentation": "

    When the trial was created.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial.

    " } }, "LastModifiedTime": { @@ -22490,16 +22598,16 @@ "smithy.api#documentation": "

    When the trial was last modified.

    " } }, - "TrialArn": { - "target": "com.amazonaws.sagemaker#TrialArn", + "CreationTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the trial.

    " + "smithy.api#documentation": "

    When the trial was created.

    " } }, - "DisplayName": { + "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the trial as displayed. If DisplayName isn't specified,\n TrialName is displayed.

    " + "smithy.api#documentation": "

    The name of the trial.

    " } } }, @@ -22513,7 +22621,7 @@ "TargetObjectiveMetricValue": { "target": "com.amazonaws.sagemaker#TargetObjectiveMetricValue", "traits": { - "smithy.api#documentation": "

    The objective metric's value.

    ", + "smithy.api#documentation": "

    The value of the objective metric.

    ", "smithy.api#required": {} } } @@ -22551,17 +22659,17 @@ "com.amazonaws.sagemaker#UiConfig": { "type": "structure", "members": { - "HumanTaskUiArn": { - "target": "com.amazonaws.sagemaker#HumanTaskUiArn", - "traits": { - "smithy.api#documentation": "

    The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

    \n

    Use this parameter when you are creating a labeling job for 3D point cloud \n and video fram labeling jobs. Use your labeling job task type to select one of the following ARN's and use\n it with this parameter when you create a labeling job. Replace aws-region\n with the AWS region you are creating your labeling job in.

    \n\n

    \n 3D Point Cloud HumanTaskUiArns\n

    \n\n

    Use this HumanTaskUiArn for 3D point cloud object detection and\n 3D point cloud object detection adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n

      \n
      • \n
    \n \n

    Use this HumanTaskUiArn for 3D point cloud object tracking and\n 3D point cloud object tracking adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n

      \n
      • \n
    \n \n

    Use this HumanTaskUiArn for 3D point cloud semantic segmentation\n and 3D point cloud semantic segmentation adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n

      \n
      • \n
    \n\n

    \n Video Frame HumanTaskUiArns\n

    \n\n

    Use this HumanTaskUiArn for video frame object detection and\n video frame object detection adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n

      \n
      • \n
    \n \n

    Use this HumanTaskUiArn for video frame object tracking and\n video frame object tracking adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n

      \n
      • \n
    " - } - }, "UiTemplateS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#documentation": "

    The Amazon S3 bucket location of the UI template, or worker task template. This is the\n template used to render the worker UI and tools for labeling job tasks. For more\n information about the contents of a UI template, see Creating Your Custom\n Labeling Task Template.

    " } + }, + "HumanTaskUiArn": { + "target": "com.amazonaws.sagemaker#HumanTaskUiArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

    \n

    Use this parameter when you are creating a labeling job for 3D point cloud and video\n fram labeling jobs. Use your labeling job task type to select one of the following ARN's\n and use it with this parameter when you create a labeling job. Replace\n aws-region with the AWS region you are creating your labeling job\n in.

    \n\n

    \n 3D Point Cloud HumanTaskUiArns\n

    \n\n

    Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n

      \n
      • \n
    \n\n

    Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n

      \n
      • \n
    \n\n

    Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n

      \n
      • \n
    \n\n

    \n Video Frame HumanTaskUiArns\n

    \n\n

    Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n

      \n
      • \n
    \n\n

    Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

    \n
      \n
    • \n

      \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n

      \n
      • \n
    " + } } }, "traits": { @@ -22586,17 +22694,17 @@ "com.amazonaws.sagemaker#UiTemplateInfo": { "type": "structure", "members": { - "ContentSha256": { - "target": "com.amazonaws.sagemaker#TemplateContentSha256", - "traits": { - "smithy.api#documentation": "

    The SHA-256 digest of the contents of the template.

    " - } - }, "Url": { "target": "com.amazonaws.sagemaker#TemplateUrl", "traits": { "smithy.api#documentation": "

    The URL for the user interface template.

    " } + }, + "ContentSha256": { + "target": "com.amazonaws.sagemaker#TemplateContentSha256", + "traits": { + "smithy.api#documentation": "

    The SHA-256 digest of the contents of the template.

    " + } } }, "traits": { @@ -22671,18 +22779,18 @@ "com.amazonaws.sagemaker#UpdateDomainRequest": { "type": "structure", "members": { + "DefaultUserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "

    A collection of settings.

    " + } + }, "DomainId": { "target": "com.amazonaws.sagemaker#DomainId", "traits": { "smithy.api#documentation": "

    The ID of the domain to be updated.

    ", "smithy.api#required": {} } - }, - "DefaultUserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#documentation": "

    A collection of settings.

    " - } } } }, @@ -22724,10 +22832,11 @@ "smithy.api#required": {} } }, - "RetainAllVariantProperties": { - "target": "com.amazonaws.sagemaker#Boolean", + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

    When updating endpoint resources, enables or disables the retention of variant\n properties, such as the instance count or the variant weight. To retain the variant\n properties of an endpoint when updating it, set RetainAllVariantProperties\n to true. To use the variant properties specified in a new\n EndpointConfig call when updating an endpoint, set\n RetainAllVariantProperties to false.

    " + "smithy.api#documentation": "

    The name of the endpoint whose configuration you want to update.

    ", + "smithy.api#required": {} } }, "ExcludeRetainedVariantProperties": { @@ -22736,11 +22845,10 @@ "smithy.api#documentation": "

    When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose value is set to\n true, ExcludeRetainedVariantProperties specifies the list\n of type VariantProperty to override with the values provided by\n EndpointConfig. If you don't specify a value for\n ExcludeAllVariantProperties, no variant properties are overridden.\n

    " } }, - "EndpointName": { - "target": "com.amazonaws.sagemaker#EndpointName", + "RetainAllVariantProperties": { + "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

    The name of the endpoint whose configuration you want to update.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    When updating endpoint resources, enables or disables the retention of variant\n properties, such as the instance count or the variant weight. To retain the variant\n properties of an endpoint when updating it, set RetainAllVariantProperties\n to true. To use the variant properties specified in a new\n EndpointConfig call when updating an endpoint, set\n RetainAllVariantProperties to false.

    " } } } @@ -22828,6 +22936,12 @@ "com.amazonaws.sagemaker#UpdateExperimentRequest": { "type": "structure", "members": { + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

    The name of the experiment as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, ExperimentName is displayed.

    " + } + }, "Description": { "target": "com.amazonaws.sagemaker#ExperimentDescription", "traits": { @@ -22840,12 +22954,6 @@ "smithy.api#documentation": "

    The name of the experiment to update.

    ", "smithy.api#required": {} } - }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "

    The name of the experiment as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, ExperimentName is displayed.

    " - } } } }, @@ -22883,17 +22991,17 @@ "com.amazonaws.sagemaker#UpdateMonitoringScheduleRequest": { "type": "structure", "members": { - "MonitoringScheduleName": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleName", + "MonitoringScheduleConfig": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", "traits": { - "smithy.api#documentation": "

    The name of the monitoring schedule. The name must be unique within an AWS Region within\n an AWS account.

    ", + "smithy.api#documentation": "

    The configuration object that specifies the monitoring schedule and defines the\n monitoring job.

    ", "smithy.api#required": {} } }, - "MonitoringScheduleConfig": { - "target": "com.amazonaws.sagemaker#MonitoringScheduleConfig", + "MonitoringScheduleName": { + "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "

    The configuration object that specifies the monitoring schedule and defines the\n monitoring job.

    ", + "smithy.api#documentation": "

    The name of the monitoring schedule. The name must be unique within an AWS Region within\n an AWS account.

    ", "smithy.api#required": {} } } @@ -22931,16 +23039,10 @@ "com.amazonaws.sagemaker#UpdateNotebookInstanceInput": { "type": "structure", "members": { - "DisassociateAcceleratorTypes": { - "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes", - "traits": { - "smithy.api#documentation": "

    A list of the Elastic Inference (EI) instance types to remove from this notebook\n instance. This operation is idempotent. If you specify an accelerator type that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.

    " - } - }, - "InstanceType": { - "target": "com.amazonaws.sagemaker#InstanceType", + "RootAccess": { + "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "

    The Amazon ML compute instance type.

    " + "smithy.api#documentation": "

    Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

    \n \n

    If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.

    \n     " } }, "NotebookInstanceName": { @@ -22950,10 +23052,10 @@ "smithy.api#required": {} } }, - "RoleArn": { - "target": "com.amazonaws.sagemaker#RoleArn", + "DisassociateAcceleratorTypes": { + "target": "com.amazonaws.sagemaker#DisassociateNotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the\n notebook instance. For more information, see Amazon SageMaker Roles.

    \n \n

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     " + "smithy.api#documentation": "

    A list of the Elastic Inference (EI) instance types to remove from this notebook\n instance. This operation is idempotent. If you specify an accelerator type that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.

    " } }, "DisassociateLifecycleConfig": { @@ -22962,22 +23064,16 @@ "smithy.api#documentation": "

    Set to true to remove the notebook instance lifecycle configuration\n currently associated with the notebook instance. This operation is idempotent. If you\n specify a lifecycle configuration that is not associated with the notebook instance when\n you call this method, it does not throw an error.

    " } }, - "DefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", - "traits": { - "smithy.api#documentation": "

    The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

    " - } - }, - "AdditionalCodeRepositories": { - "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "InstanceType": { + "target": "com.amazonaws.sagemaker#InstanceType", "traits": { - "smithy.api#documentation": "

    An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

    " + "smithy.api#documentation": "

    The Amazon ML compute instance type.

    " } }, - "AcceleratorTypes": { - "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", + "VolumeSizeInGB": { + "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

    A list of the Elastic Inference (EI) instance types to associate with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in Amazon\n SageMaker.

    " + "smithy.api#documentation": "

    The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the\n amount of available free space on the volume. Because of this, you can increase the\n volume size when you update a notebook instance, but you can't decrease the volume size.\n If you want to decrease the size of the ML storage volume in use, create a new notebook\n instance with the desired size.

    " } }, "LifecycleConfigName": { @@ -22986,28 +23082,40 @@ "smithy.api#documentation": "

    The name of a lifecycle configuration to associate with the notebook instance. For\n information about lifestyle configurations, see Step 2.1: (Optional)\n Customize a Notebook Instance.

    " } }, - "DisassociateDefaultCodeRepository": { - "target": "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository", - "traits": { - "smithy.api#documentation": "

    The name or URL of the default Git repository to remove from this notebook instance.\n This operation is idempotent. If you specify a Git repository that is not associated\n with the notebook instance when you call this method, it does not throw an error.

    " - } - }, "DisassociateAdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#DisassociateAdditionalCodeRepositories", "traits": { "smithy.api#documentation": "

    A list of names or URLs of the default Git repositories to remove from this notebook\n instance. This operation is idempotent. If you specify a Git repository that is not\n associated with the notebook instance when you call this method, it does not throw an\n error.

    " } }, - "RootAccess": { - "target": "com.amazonaws.sagemaker#RootAccess", + "AcceleratorTypes": { + "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "

    Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

    \n \n

    If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.

    \n     " + "smithy.api#documentation": "

    A list of the Elastic Inference (EI) instance types to associate with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in Amazon\n SageMaker.

    " } }, - "VolumeSizeInGB": { - "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", + "DefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

    The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the\n amount of available free space on the volume. Because of this, you can increase the\n volume size when you update a notebook instance, but you can't decrease the volume size.\n If you want to decrease the size of the ML storage volume in use, create a new notebook\n instance with the desired size.

    " + "smithy.api#documentation": "

    The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

    " + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", + "traits": { + "smithy.api#documentation": "

    An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

    " + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the\n notebook instance. For more information, see Amazon SageMaker Roles.

    \n \n

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

    \n     " + } + }, + "DisassociateDefaultCodeRepository": { + "target": "com.amazonaws.sagemaker#DisassociateDefaultCodeRepository", + "traits": { + "smithy.api#documentation": "

    The name or URL of the default Git repository to remove from this notebook instance.\n This operation is idempotent. If you specify a Git repository that is not associated\n with the notebook instance when you call this method, it does not throw an error.

    " } } } @@ -23104,46 +23212,53 @@ "com.amazonaws.sagemaker#UpdateTrialComponentRequest": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.sagemaker#TrialComponentParameters", + "ParametersToRemove": { + "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", "traits": { - "smithy.api#documentation": "

    Replaces all of the component's hyperparameters with the specified hyperparameters.

    " + "smithy.api#documentation": "

    The hyperparameters to remove from the component.

    " } }, - "OutputArtifactsToRemove": { + "InputArtifactsToRemove": { "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", "traits": { - "smithy.api#documentation": "

    The output artifacts to remove from the component.

    " + "smithy.api#documentation": "

    The input artifacts to remove from the component.

    " } }, - "Status": { - "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The new status of the component.

    " + "smithy.api#documentation": "

    When the component ended.

    " } }, - "InputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "DisplayName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    Replaces all of the component's input artifacts with the specified artifacts.

    " + "smithy.api#documentation": "

    The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.

    " } }, - "InputArtifactsToRemove": { - "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", + "TrialComponentName": { + "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The input artifacts to remove from the component.

    " + "smithy.api#documentation": "

    The name of the component to update.

    ", + "smithy.api#required": {} } }, - "OutputArtifacts": { - "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", + "Parameters": { + "target": "com.amazonaws.sagemaker#TrialComponentParameters", "traits": { - "smithy.api#documentation": "

    Replaces all of the component's output artifacts with the specified artifacts.

    " + "smithy.api#documentation": "

    Replaces all of the component's hyperparameters with the specified hyperparameters.

    " } }, - "ParametersToRemove": { + "Status": { + "target": "com.amazonaws.sagemaker#TrialComponentStatus", + "traits": { + "smithy.api#documentation": "

    The new status of the component.

    " + } + }, + "OutputArtifactsToRemove": { "target": "com.amazonaws.sagemaker#ListTrialComponentKey256", "traits": { - "smithy.api#documentation": "

    The hyperparameters to remove from the component.

    " + "smithy.api#documentation": "

    The output artifacts to remove from the component.

    " } }, "StartTime": { @@ -23152,23 +23267,16 @@ "smithy.api#documentation": "

    When the component started.

    " } }, - "TrialComponentName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", - "traits": { - "smithy.api#documentation": "

    The name of the component to update.

    ", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.sagemaker#Timestamp", + "InputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", "traits": { - "smithy.api#documentation": "

    When the component ended.

    " + "smithy.api#documentation": "

    Replaces all of the component's input artifacts with the specified artifacts.

    " } }, - "DisplayName": { - "target": "com.amazonaws.sagemaker#ExperimentEntityName", + "OutputArtifacts": { + "target": "com.amazonaws.sagemaker#TrialComponentArtifacts", "traits": { - "smithy.api#documentation": "

    The name of the component as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialComponentName is\n displayed.

    " + "smithy.api#documentation": "

    Replaces all of the component's output artifacts with the specified artifacts.

    " } } } @@ -23187,17 +23295,17 @@ "com.amazonaws.sagemaker#UpdateTrialRequest": { "type": "structure", "members": { - "TrialName": { + "DisplayName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the trial to update.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.

    " } }, - "DisplayName": { + "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

    The name of the trial as displayed. The name doesn't need to be unique. If\n DisplayName isn't specified, TrialName is displayed.

    " + "smithy.api#documentation": "

    The name of the trial to update.

    ", + "smithy.api#required": {} } } } @@ -23246,18 +23354,18 @@ "smithy.api#required": {} } }, + "UserSettings": { + "target": "com.amazonaws.sagemaker#UserSettings", + "traits": { + "smithy.api#documentation": "

    A collection of settings.

    " + } + }, "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { "smithy.api#documentation": "

    The user profile name.

    ", "smithy.api#required": {} } - }, - "UserSettings": { - "target": "com.amazonaws.sagemaker#UserSettings", - "traits": { - "smithy.api#documentation": "

    A collection of settings.

    " - } } } }, @@ -23281,7 +23389,7 @@ "target": "com.amazonaws.sagemaker#UpdateWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

    Restricts access to tasks assigned to workers in the specified workforce to those\n within specific ranges of IP addresses. You specify allowed IP addresses by creating a\n list of up to ten CIDRs.

    \n

    By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied access and get a Not Found error message on\n the worker portal. After restricting access with this operation, you can see the allowed\n IP values for a private workforce with the \n operation.

    \n \n

    This operation applies only to private workforces.

    \n     " + "smithy.api#documentation": "

    Use this operation to update your workforce. You can use this operation to \n require that workers use specific IP addresses to work on tasks\n and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

    \n \n

    Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. \n You specify allowed IP addresses by creating a list of up to ten CIDRs.\n By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied and get a Not Found error message on\n the worker portal.

    \n

    Use OidcConfig to update the configuration of a workforce created using\n your own OIDC IdP.

    \n \n

    You can only update your OIDC IdP configuration when there are no work teams\n associated with your workforce. You can delete work teams using the operation.

    \n     \n

    After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you\n can view details about your update workforce using the \n operation.

    \n \n

    This operation only applies to private workforces.

    \n     " } }, "com.amazonaws.sagemaker#UpdateWorkforceRequest": { @@ -23293,18 +23401,18 @@ "smithy.api#documentation": "

    Use this parameter to update your OIDC Identity Provider (IdP) \n configuration for a workforce made using your own IdP.

    " } }, - "WorkforceName": { - "target": "com.amazonaws.sagemaker#WorkforceName", - "traits": { - "smithy.api#documentation": "

    The name of the private workforce whose access you want to restrict.\n WorkforceName is automatically set to default when a\n workforce is created and cannot be modified.

    ", - "smithy.api#required": {} - } - }, "SourceIpConfig": { "target": "com.amazonaws.sagemaker#SourceIpConfig", "traits": { "smithy.api#documentation": "

    A list of one to ten worker IP address ranges (CIDRs) that can be used to\n access tasks assigned to this workforce.

    \n

    Maximum: Ten CIDR values

    " } + }, + "WorkforceName": { + "target": "com.amazonaws.sagemaker#WorkforceName", + "traits": { + "smithy.api#documentation": "

    The name of the private workforce that you want to update. You can find your workforce\n name by using the operation.

    ", + "smithy.api#required": {} + } } } }, @@ -23314,7 +23422,7 @@ "Workforce": { "target": "com.amazonaws.sagemaker#Workforce", "traits": { - "smithy.api#documentation": "

    A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each AWS Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

    ", + "smithy.api#documentation": "

    A single private workforce. You can create one private work force in each AWS Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

    ", "smithy.api#required": {} } } @@ -23340,10 +23448,16 @@ "com.amazonaws.sagemaker#UpdateWorkteamRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.sagemaker#String200", + "traits": { + "smithy.api#documentation": "

    An updated description for the work team.

    " + } + }, "MemberDefinitions": { "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { - "smithy.api#documentation": "

    A list of MemberDefinition objects that contain the updated work team\n members.

    " + "smithy.api#documentation": "

    A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

    \n

    Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition. You should not provide input\n for both of these parameters in a single request.

    \n

    For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

    \n

    For workforces created using your own OIDC IdP, specify the user groups that you want\n to include in your private work team in OidcMemberDefinition by listing\n those groups in Groups. Be aware that user groups that are already in the\n work team must also be listed in Groups when you make this request to\n remain on the work team. If you do not include these user groups, they will no longer be\n associated with the work team you update.

    " } }, "WorkteamName": { @@ -23353,12 +23467,6 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.sagemaker#String200", - "traits": { - "smithy.api#documentation": "

    An updated description for the work team.

    " - } - }, "NotificationConfiguration": { "target": "com.amazonaws.sagemaker#NotificationConfiguration", "traits": { @@ -23392,12 +23500,6 @@ "com.amazonaws.sagemaker#UserContext": { "type": "structure", "members": { - "DomainId": { - "target": "com.amazonaws.sagemaker#String", - "traits": { - "smithy.api#documentation": "

    The domain associated with the user.

    " - } - }, "UserProfileName": { "target": "com.amazonaws.sagemaker#String", "traits": { @@ -23409,6 +23511,12 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the user's profile.

    " } + }, + "DomainId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The domain associated with the user.

    " + } } }, "traits": { @@ -23428,24 +23536,18 @@ "com.amazonaws.sagemaker#UserProfileDetails": { "type": "structure", "members": { - "UserProfileName": { - "target": "com.amazonaws.sagemaker#UserProfileName", - "traits": { - "smithy.api#documentation": "

    The user profile name.

    " - } - }, - "Status": { - "target": "com.amazonaws.sagemaker#UserProfileStatus", - "traits": { - "smithy.api#documentation": "

    The status.

    " - } - }, "DomainId": { "target": "com.amazonaws.sagemaker#DomainId", "traits": { "smithy.api#documentation": "

    The domain ID.

    " } }, + "UserProfileName": { + "target": "com.amazonaws.sagemaker#UserProfileName", + "traits": { + "smithy.api#documentation": "

    The user profile name.

    " + } + }, "LastModifiedTime": { "target": "com.amazonaws.sagemaker#LastModifiedTime", "traits": { @@ -23457,6 +23559,12 @@ "traits": { "smithy.api#documentation": "

    The creation time.

    " } + }, + "Status": { + "target": "com.amazonaws.sagemaker#UserProfileStatus", + "traits": { + "smithy.api#documentation": "

    The status.

    " + } } }, "traits": { @@ -23520,40 +23628,40 @@ "com.amazonaws.sagemaker#UserSettings": { "type": "structure", "members": { - "ExecutionRole": { - "target": "com.amazonaws.sagemaker#RoleArn", + "KernelGatewayAppSettings": { + "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings", "traits": { - "smithy.api#documentation": "

    The execution role for the user.

    " + "smithy.api#documentation": "

    The kernel gateway app settings.

    " } }, - "JupyterServerAppSettings": { - "target": "com.amazonaws.sagemaker#JupyterServerAppSettings", + "SecurityGroups": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

    The Jupyter server's app settings.

    " + "smithy.api#documentation": "

    The security groups.

    " } }, - "TensorBoardAppSettings": { - "target": "com.amazonaws.sagemaker#TensorBoardAppSettings", + "SharingSettings": { + "target": "com.amazonaws.sagemaker#SharingSettings", "traits": { - "smithy.api#documentation": "

    The TensorBoard app settings.

    " + "smithy.api#documentation": "

    The sharing settings.

    " } }, - "KernelGatewayAppSettings": { - "target": "com.amazonaws.sagemaker#KernelGatewayAppSettings", + "ExecutionRole": { + "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

    The kernel gateway app settings.

    " + "smithy.api#documentation": "

    The execution role for the user.

    " } }, - "SharingSettings": { - "target": "com.amazonaws.sagemaker#SharingSettings", + "JupyterServerAppSettings": { + "target": "com.amazonaws.sagemaker#JupyterServerAppSettings", "traits": { - "smithy.api#documentation": "

    The sharing settings.

    " + "smithy.api#documentation": "

    The Jupyter server's app settings.

    " } }, - "SecurityGroups": { - "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "TensorBoardAppSettings": { + "target": "com.amazonaws.sagemaker#TensorBoardAppSettings", "traits": { - "smithy.api#documentation": "

    The security groups.

    " + "smithy.api#documentation": "

    The TensorBoard app settings.

    " } } }, @@ -23637,17 +23745,17 @@ "com.amazonaws.sagemaker#VpcConfig": { "type": "structure", "members": { - "Subnets": { - "target": "com.amazonaws.sagemaker#Subnets", + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", "traits": { - "smithy.api#documentation": "

    The ID of the subnets in the VPC to which you want to connect your training job or\n model. For information about the availability of specific instance types, see Supported\n Instance Types and Availability Zones.

    ", + "smithy.api#documentation": "

    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for\n the VPC that is specified in the Subnets field.

    ", "smithy.api#required": {} } }, - "SecurityGroupIds": { - "target": "com.amazonaws.sagemaker#VpcSecurityGroupIds", + "Subnets": { + "target": "com.amazonaws.sagemaker#Subnets", "traits": { - "smithy.api#documentation": "

    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for\n the VPC that is specified in the Subnets field.

    ", + "smithy.api#documentation": "

    The ID of the subnets in the VPC to which you want to connect your training job or\n model. For information about the availability of specific instance types, see Supported\n Instance Types and Availability Zones.

    ", "smithy.api#required": {} } } @@ -23681,10 +23789,17 @@ "com.amazonaws.sagemaker#Workforce": { "type": "structure", "members": { - "OidcConfig": { - "target": "com.amazonaws.sagemaker#OidcConfigForResponse", + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", "traits": { - "smithy.api#documentation": "

    The configuration of an OIDC Identity Provider (IdP) private workforce.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the private workforce.

    ", + "smithy.api#required": {} + } + }, + "CreateDate": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date that the workforce is created.

    " } }, "WorkforceName": { @@ -23694,16 +23809,10 @@ "smithy.api#required": {} } }, - "LastUpdatedDate": { - "target": "com.amazonaws.sagemaker#Timestamp", - "traits": { - "smithy.api#documentation": "

    The most recent date that was used to\n successfully add one or more IP address ranges (CIDRs) to a private workforce's\n allow list.

    " - } - }, - "SubDomain": { - "target": "com.amazonaws.sagemaker#String", + "SourceIpConfig": { + "target": "com.amazonaws.sagemaker#SourceIpConfig", "traits": { - "smithy.api#documentation": "

    The subdomain for your OIDC Identity Provider.

    " + "smithy.api#documentation": "

    A list of one to ten IP address ranges (CIDRs) to be added to the\n workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

    " } }, "CognitoConfig": { @@ -23712,23 +23821,22 @@ "smithy.api#documentation": "

    The configuration of an Amazon Cognito workforce. \n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.

    " } }, - "SourceIpConfig": { - "target": "com.amazonaws.sagemaker#SourceIpConfig", + "SubDomain": { + "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

    A list of one to ten IP address ranges (CIDRs) to be added to the\n workforce allow list.

    " + "smithy.api#documentation": "

    The subdomain for your OIDC Identity Provider.

    " } }, - "CreateDate": { - "target": "com.amazonaws.sagemaker#Timestamp", + "OidcConfig": { + "target": "com.amazonaws.sagemaker#OidcConfigForResponse", "traits": { - "smithy.api#documentation": "

    The date that the workforce is created.

    " + "smithy.api#documentation": "

    The configuration of an OIDC Identity Provider (IdP) private workforce.

    " } }, - "WorkforceArn": { - "target": "com.amazonaws.sagemaker#WorkforceArn", + "LastUpdatedDate": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the private workforce.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The most recent date that was used to\n successfully add one or more IP address ranges (CIDRs) to a private workforce's\n allow list.

    " } } }, @@ -23765,29 +23873,36 @@ "com.amazonaws.sagemaker#Workteam": { "type": "structure", "members": { - "LastUpdatedDate": { - "target": "com.amazonaws.sagemaker#Timestamp", + "MemberDefinitions": { + "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { - "smithy.api#documentation": "

    The date and time that the work team was last updated (timestamp).

    " + "smithy.api#documentation": "

    A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

    \n

    Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition.

    ", + "smithy.api#required": {} } }, - "CreateDate": { - "target": "com.amazonaws.sagemaker#Timestamp", + "ProductListingIds": { + "target": "com.amazonaws.sagemaker#ProductListings", "traits": { - "smithy.api#documentation": "

    The date and time that the work team was created (timestamp).

    " + "smithy.api#documentation": "

    The Amazon Marketplace identifier for a vendor's work team.

    " } }, - "SubDomain": { - "target": "com.amazonaws.sagemaker#String", + "WorkteamName": { + "target": "com.amazonaws.sagemaker#WorkteamName", "traits": { - "smithy.api#documentation": "

    The URI of the labeling job's user interface. Workers open this URI to start labeling\n your data objects.

    " + "smithy.api#documentation": "

    The name of the work team.

    ", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.sagemaker#String200", + "NotificationConfiguration": { + "target": "com.amazonaws.sagemaker#NotificationConfiguration", "traits": { - "smithy.api#documentation": "

    A description of the work team.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Configures SNS notifications of available or expiring work items for work\n teams.

    " + } + }, + "WorkforceArn": { + "target": "com.amazonaws.sagemaker#WorkforceArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the workforce.

    " } }, "WorkteamArn": { @@ -23797,35 +23912,28 @@ "smithy.api#required": {} } }, - "ProductListingIds": { - "target": "com.amazonaws.sagemaker#ProductListings", - "traits": { - "smithy.api#documentation": "

    The Amazon Marketplace identifier for a vendor's work team.

    " - } - }, - "NotificationConfiguration": { - "target": "com.amazonaws.sagemaker#NotificationConfiguration", + "LastUpdatedDate": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    Configures SNS notifications of available or expiring work items for work\n teams.

    " + "smithy.api#documentation": "

    The date and time that the work team was last updated (timestamp).

    " } }, - "WorkforceArn": { - "target": "com.amazonaws.sagemaker#WorkforceArn", + "CreateDate": { + "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the workforce.

    " + "smithy.api#documentation": "

    The date and time that the work team was created (timestamp).

    " } }, - "MemberDefinitions": { - "target": "com.amazonaws.sagemaker#MemberDefinitions", + "SubDomain": { + "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

    The Amazon Cognito user groups that make up the work team.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The URI of the labeling job's user interface. Workers open this URI to start labeling\n your data objects.

    " } }, - "WorkteamName": { - "target": "com.amazonaws.sagemaker#WorkteamName", + "Description": { + "target": "com.amazonaws.sagemaker#String200", "traits": { - "smithy.api#documentation": "

    The name of the work team.

    ", + "smithy.api#documentation": "

    A description of the work team.

    ", "smithy.api#required": {} } } 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 87c7f31aec8d..7ae66bf15854 100644 --- a/codegen/sdk-codegen/aws-models/savingsplans.2019-06-28.json +++ b/codegen/sdk-codegen/aws-models/savingsplans.2019-06-28.json @@ -36,6 +36,9 @@ { "target": "com.amazonaws.savingsplans#CreateSavingsPlan" }, + { + "target": "com.amazonaws.savingsplans#DeleteQueuedSavingsPlan" + }, { "target": "com.amazonaws.savingsplans#DescribeSavingsPlanRates" }, @@ -63,7 +66,7 @@ "sdkId": "savingsplans", "arnNamespace": "savingsplans", "cloudFormationName": "Savingsplans", - "cloudTrailEventSource": "awssavingsplan.amazonaws.com" + "cloudTrailEventSource": "savingsplans.amazonaws.com" }, "aws.auth#sigv4": { "name": "savingsplans" @@ -113,13 +116,6 @@ "com.amazonaws.savingsplans#CreateSavingsPlanRequest": { "type": "structure", "members": { - "clientToken": { - "target": "com.amazonaws.savingsplans#ClientToken", - "traits": { - "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", - "smithy.api#idempotencyToken": {} - } - }, "savingsPlanOfferingId": { "target": "com.amazonaws.savingsplans#SavingsPlanOfferingId", "traits": { @@ -127,11 +123,10 @@ "smithy.api#required": {} } }, - "commitment": { - "target": "com.amazonaws.savingsplans#Amount", + "tags": { + "target": "com.amazonaws.savingsplans#TagMap", "traits": { - "smithy.api#documentation": "

    The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more\n than three digits after the decimal point.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    One or more tags.

    " } }, "upfrontPaymentAmount": { @@ -140,10 +135,24 @@ "smithy.api#documentation": "

    The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan.\n This parameter is supported only if the payment option is Partial Upfront.

    " } }, - "tags": { - "target": "com.amazonaws.savingsplans#TagMap", + "purchaseTime": { + "target": "com.amazonaws.savingsplans#DateTime", "traits": { - "smithy.api#documentation": "

    One or more tags.

    " + "smithy.api#documentation": "

    The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

    " + } + }, + "commitment": { + "target": "com.amazonaws.savingsplans#Amount", + "traits": { + "smithy.api#documentation": "

    The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more\n than three digits after the decimal point.

    ", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.savingsplans#ClientToken", + "traits": { + "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "smithy.api#idempotencyToken": {} } } } @@ -178,6 +187,56 @@ "target": "com.amazonaws.savingsplans#CurrencyCode" } }, + "com.amazonaws.savingsplans#DateTime": { + "type": "timestamp" + }, + "com.amazonaws.savingsplans#DeleteQueuedSavingsPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.savingsplans#DeleteQueuedSavingsPlanRequest" + }, + "output": { + "target": "com.amazonaws.savingsplans#DeleteQueuedSavingsPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.savingsplans#InternalServerException" + }, + { + "target": "com.amazonaws.savingsplans#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.savingsplans#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.savingsplans#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the queued purchase for the specified Savings Plan.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteQueuedSavingsPlan", + "code": 200 + } + } + }, + "com.amazonaws.savingsplans#DeleteQueuedSavingsPlanRequest": { + "type": "structure", + "members": { + "savingsPlanId": { + "target": "com.amazonaws.savingsplans#SavingsPlanId", + "traits": { + "smithy.api#documentation": "

    The ID of the Savings Plan.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.savingsplans#DeleteQueuedSavingsPlanResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.savingsplans#DescribeSavingsPlanRates": { "type": "operation", "input": { @@ -206,6 +265,12 @@ "com.amazonaws.savingsplans#DescribeSavingsPlanRatesRequest": { "type": "structure", "members": { + "filters": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateFilterList", + "traits": { + "smithy.api#documentation": "

    The filters.

    " + } + }, "maxResults": { "target": "com.amazonaws.savingsplans#MaxResults", "traits": { @@ -224,22 +289,16 @@ "traits": { "smithy.api#documentation": "

    The token for the next page of results.

    " } - }, - "filters": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateFilterList", - "traits": { - "smithy.api#documentation": "

    The filters.

    " - } } } }, "com.amazonaws.savingsplans#DescribeSavingsPlanRatesResponse": { "type": "structure", "members": { - "searchResults": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateList", + "savingsPlanId": { + "target": "com.amazonaws.savingsplans#SavingsPlanId", "traits": { - "smithy.api#documentation": "

    Information about the Savings Plans rates.

    " + "smithy.api#documentation": "

    The ID of the Savings Plan.

    " } }, "nextToken": { @@ -248,10 +307,10 @@ "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more \n results to return.

    " } }, - "savingsPlanId": { - "target": "com.amazonaws.savingsplans#SavingsPlanId", + "searchResults": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateList", "traits": { - "smithy.api#documentation": "

    The ID of the Savings Plan.

    " + "smithy.api#documentation": "

    Information about the Savings Plans rates.

    " } } } @@ -309,16 +368,16 @@ "com.amazonaws.savingsplans#DescribeSavingsPlansOfferingRatesRequest": { "type": "structure", "members": { - "serviceCodes": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateServiceCodeList", + "usageTypes": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateUsageTypeList", "traits": { - "smithy.api#documentation": "

    The services.

    " + "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " } }, - "savingsPlanPaymentOptions": { - "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOptionList", + "nextToken": { + "target": "com.amazonaws.savingsplans#PaginationToken", "traits": { - "smithy.api#documentation": "

    The payment options.

    " + "smithy.api#documentation": "

    The token for the next page of results.

    " } }, "products": { @@ -327,34 +386,28 @@ "smithy.api#documentation": "

    The AWS products.

    " } }, - "nextToken": { - "target": "com.amazonaws.savingsplans#PaginationToken", - "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " - } - }, "savingsPlanOfferingIds": { "target": "com.amazonaws.savingsplans#UUIDs", "traits": { "smithy.api#documentation": "

    The IDs of the offerings.

    " } }, - "maxResults": { - "target": "com.amazonaws.savingsplans#PageSize", + "operations": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateOperationList", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call. To retrieve additional results, make another\n call with the returned token value.

    " + "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " } }, - "usageTypes": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateUsageTypeList", + "maxResults": { + "target": "com.amazonaws.savingsplans#PageSize", "traits": { - "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " + "smithy.api#documentation": "

    The maximum number of results to return with a single call. To retrieve additional results, make another\n call with the returned token value.

    " } }, - "operations": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateOperationList", + "savingsPlanPaymentOptions": { + "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOptionList", "traits": { - "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " + "smithy.api#documentation": "

    The payment options.

    " } }, "savingsPlanTypes": { @@ -368,6 +421,12 @@ "traits": { "smithy.api#documentation": "

    The filters.

    " } + }, + "serviceCodes": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateServiceCodeList", + "traits": { + "smithy.api#documentation": "

    The services.

    " + } } } }, @@ -416,22 +475,22 @@ "com.amazonaws.savingsplans#DescribeSavingsPlansOfferingsRequest": { "type": "structure", "members": { - "descriptions": { - "target": "com.amazonaws.savingsplans#SavingsPlanDescriptionsList", + "filters": { + "target": "com.amazonaws.savingsplans#SavingsPlanOfferingFiltersList", "traits": { - "smithy.api#documentation": "

    The descriptions.

    " + "smithy.api#documentation": "

    The filters.

    " } }, - "offeringIds": { - "target": "com.amazonaws.savingsplans#UUIDs", + "serviceCodes": { + "target": "com.amazonaws.savingsplans#SavingsPlanServiceCodeList", "traits": { - "smithy.api#documentation": "

    The IDs of the offerings.

    " + "smithy.api#documentation": "

    The services.

    " } }, - "currencies": { - "target": "com.amazonaws.savingsplans#CurrencyList", + "operations": { + "target": "com.amazonaws.savingsplans#SavingsPlanOperationList", "traits": { - "smithy.api#documentation": "

    The currencies.

    " + "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " } }, "usageTypes": { @@ -440,16 +499,10 @@ "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " } }, - "planTypes": { - "target": "com.amazonaws.savingsplans#SavingsPlanTypeList", - "traits": { - "smithy.api#documentation": "

    The plan type.

    " - } - }, - "durations": { - "target": "com.amazonaws.savingsplans#DurationsList", + "productType": { + "target": "com.amazonaws.savingsplans#SavingsPlanProductType", "traits": { - "smithy.api#documentation": "

    The durations, in seconds.

    " + "smithy.api#documentation": "

    The product type.

    " } }, "paymentOptions": { @@ -458,34 +511,34 @@ "smithy.api#documentation": "

    The payment options.

    " } }, - "operations": { - "target": "com.amazonaws.savingsplans#SavingsPlanOperationList", + "durations": { + "target": "com.amazonaws.savingsplans#DurationsList", "traits": { - "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " + "smithy.api#documentation": "

    The durations, in seconds.

    " } }, - "filters": { - "target": "com.amazonaws.savingsplans#SavingsPlanOfferingFiltersList", + "planTypes": { + "target": "com.amazonaws.savingsplans#SavingsPlanTypeList", "traits": { - "smithy.api#documentation": "

    The filters.

    " + "smithy.api#documentation": "

    The plan type.

    " } }, - "productType": { - "target": "com.amazonaws.savingsplans#SavingsPlanProductType", + "descriptions": { + "target": "com.amazonaws.savingsplans#SavingsPlanDescriptionsList", "traits": { - "smithy.api#documentation": "

    The product type.

    " + "smithy.api#documentation": "

    The descriptions.

    " } }, - "serviceCodes": { - "target": "com.amazonaws.savingsplans#SavingsPlanServiceCodeList", + "offeringIds": { + "target": "com.amazonaws.savingsplans#UUIDs", "traits": { - "smithy.api#documentation": "

    The services.

    " + "smithy.api#documentation": "

    The IDs of the offerings.

    " } }, - "maxResults": { - "target": "com.amazonaws.savingsplans#PageSize", + "currencies": { + "target": "com.amazonaws.savingsplans#CurrencyList", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call. To retrieve additional results, make another\n call with the returned token value.

    " + "smithy.api#documentation": "

    The currencies.

    " } }, "nextToken": { @@ -493,6 +546,12 @@ "traits": { "smithy.api#documentation": "

    The token for the next page of results.

    " } + }, + "maxResults": { + "target": "com.amazonaws.savingsplans#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return with a single call. To retrieve additional results, make another\n call with the returned token value.

    " + } } } }, @@ -516,10 +575,10 @@ "com.amazonaws.savingsplans#DescribeSavingsPlansRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.savingsplans#MaxResults", + "filters": { + "target": "com.amazonaws.savingsplans#SavingsPlanFilterList", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return with a single call. To retrieve additional results, make another\n call with the returned token value.

    " + "smithy.api#documentation": "

    The filters.

    " } }, "savingsPlanArns": { @@ -528,16 +587,16 @@ "smithy.api#documentation": "

    The Amazon Resource Names (ARN) of the Savings Plans.

    " } }, - "savingsPlanIds": { - "target": "com.amazonaws.savingsplans#SavingsPlanIdList", + "maxResults": { + "target": "com.amazonaws.savingsplans#MaxResults", "traits": { - "smithy.api#documentation": "

    The IDs of the Savings Plans.

    " + "smithy.api#documentation": "

    The maximum number of results to return with a single call. To retrieve additional results, make another\n call with the returned token value.

    " } }, - "nextToken": { - "target": "com.amazonaws.savingsplans#PaginationToken", + "savingsPlanIds": { + "target": "com.amazonaws.savingsplans#SavingsPlanIdList", "traits": { - "smithy.api#documentation": "

    The token for the next page of results.

    " + "smithy.api#documentation": "

    The IDs of the Savings Plans.

    " } }, "states": { @@ -546,10 +605,10 @@ "smithy.api#documentation": "

    The states.

    " } }, - "filters": { - "target": "com.amazonaws.savingsplans#SavingsPlanFilterList", + "nextToken": { + "target": "com.amazonaws.savingsplans#PaginationToken", "traits": { - "smithy.api#documentation": "

    The filters.

    " + "smithy.api#documentation": "

    The token for the next page of results.

    " } } } @@ -703,16 +762,16 @@ "smithy.api#documentation": "

    The duration, in seconds.

    " } }, - "planDescription": { - "target": "com.amazonaws.savingsplans#SavingsPlanDescription", + "paymentOption": { + "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOption", "traits": { - "smithy.api#documentation": "

    The description.

    " + "smithy.api#documentation": "

    The payment option.

    " } }, - "offeringId": { - "target": "com.amazonaws.savingsplans#UUID", + "planDescription": { + "target": "com.amazonaws.savingsplans#SavingsPlanDescription", "traits": { - "smithy.api#documentation": "

    The ID of the offering.

    " + "smithy.api#documentation": "

    The description.

    " } }, "currency": { @@ -721,17 +780,17 @@ "smithy.api#documentation": "

    The currency.

    " } }, - "paymentOption": { - "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOption", - "traits": { - "smithy.api#documentation": "

    The payment option.

    " - } - }, "planType": { "target": "com.amazonaws.savingsplans#SavingsPlanType", "traits": { "smithy.api#documentation": "

    The plan type.

    " } + }, + "offeringId": { + "target": "com.amazonaws.savingsplans#UUID", + "traits": { + "smithy.api#documentation": "

    The ID of the offering.

    " + } } }, "traits": { @@ -758,36 +817,18 @@ } }, "com.amazonaws.savingsplans#SavingsPlan": { - "type": "structure", - "members": { - "commitment": { - "target": "com.amazonaws.savingsplans#Amount", - "traits": { - "smithy.api#documentation": "

    The hourly commitment, in USD.

    " - } - }, - "end": { - "target": "com.amazonaws.savingsplans#String", - "traits": { - "smithy.api#documentation": "

    The end time.

    " - } - }, - "start": { - "target": "com.amazonaws.savingsplans#String", - "traits": { - "smithy.api#documentation": "

    The start time.

    " - } - }, - "paymentOption": { - "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOption", + "type": "structure", + "members": { + "currency": { + "target": "com.amazonaws.savingsplans#CurrencyCode", "traits": { - "smithy.api#documentation": "

    The payment option.

    " + "smithy.api#documentation": "

    The currency.

    " } }, - "upfrontPaymentAmount": { - "target": "com.amazonaws.savingsplans#Amount", + "state": { + "target": "com.amazonaws.savingsplans#SavingsPlanState", "traits": { - "smithy.api#documentation": "

    The up-front payment amount.

    " + "smithy.api#documentation": "

    The state.

    " } }, "tags": { @@ -796,16 +837,28 @@ "smithy.api#documentation": "

    One or more tags.

    " } }, + "productTypes": { + "target": "com.amazonaws.savingsplans#SavingsPlanProductTypeList", + "traits": { + "smithy.api#documentation": "

    The product types.

    " + } + }, "savingsPlanArn": { "target": "com.amazonaws.savingsplans#SavingsPlanArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Savings Plan.

    " } }, - "offeringId": { - "target": "com.amazonaws.savingsplans#SavingsPlanOfferingId", + "upfrontPaymentAmount": { + "target": "com.amazonaws.savingsplans#Amount", "traits": { - "smithy.api#documentation": "

    The ID of the offering.

    " + "smithy.api#documentation": "

    The up-front payment amount.

    " + } + }, + "ec2InstanceFamily": { + "target": "com.amazonaws.savingsplans#EC2InstanceFamily", + "traits": { + "smithy.api#documentation": "

    The EC2 instance family.

    " } }, "description": { @@ -814,40 +867,40 @@ "smithy.api#documentation": "

    The description.

    " } }, - "ec2InstanceFamily": { - "target": "com.amazonaws.savingsplans#EC2InstanceFamily", + "commitment": { + "target": "com.amazonaws.savingsplans#Amount", "traits": { - "smithy.api#documentation": "

    The EC2 instance family.

    " + "smithy.api#documentation": "

    The hourly commitment, in USD.

    " } }, - "currency": { - "target": "com.amazonaws.savingsplans#CurrencyCode", + "start": { + "target": "com.amazonaws.savingsplans#String", "traits": { - "smithy.api#documentation": "

    The currency.

    " + "smithy.api#documentation": "

    The start time.

    " } }, - "region": { - "target": "com.amazonaws.savingsplans#Region", + "offeringId": { + "target": "com.amazonaws.savingsplans#SavingsPlanOfferingId", "traits": { - "smithy.api#documentation": "

    The AWS Region.

    " + "smithy.api#documentation": "

    The ID of the offering.

    " } }, - "state": { - "target": "com.amazonaws.savingsplans#SavingsPlanState", + "paymentOption": { + "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOption", "traits": { - "smithy.api#documentation": "

    The state.

    " + "smithy.api#documentation": "

    The payment option.

    " } }, - "productTypes": { - "target": "com.amazonaws.savingsplans#SavingsPlanProductTypeList", + "end": { + "target": "com.amazonaws.savingsplans#String", "traits": { - "smithy.api#documentation": "

    The product types.

    " + "smithy.api#documentation": "

    The end time.

    " } }, - "recurringPaymentAmount": { - "target": "com.amazonaws.savingsplans#Amount", + "region": { + "target": "com.amazonaws.savingsplans#Region", "traits": { - "smithy.api#documentation": "

    The recurring payment amount.

    " + "smithy.api#documentation": "

    The AWS Region.

    " } }, "termDurationInSeconds": { @@ -856,10 +909,10 @@ "smithy.api#documentation": "

    The duration of the term, in seconds.

    " } }, - "savingsPlanType": { - "target": "com.amazonaws.savingsplans#SavingsPlanType", + "recurringPaymentAmount": { + "target": "com.amazonaws.savingsplans#Amount", "traits": { - "smithy.api#documentation": "

    The plan type.

    " + "smithy.api#documentation": "

    The recurring payment amount.

    " } }, "savingsPlanId": { @@ -867,6 +920,12 @@ "traits": { "smithy.api#documentation": "

    The ID of the Savings Plan.

    " } + }, + "savingsPlanType": { + "target": "com.amazonaws.savingsplans#SavingsPlanType", + "traits": { + "smithy.api#documentation": "

    The plan type.

    " + } } }, "traits": { @@ -947,58 +1006,58 @@ "com.amazonaws.savingsplans#SavingsPlanOffering": { "type": "structure", "members": { - "planType": { - "target": "com.amazonaws.savingsplans#SavingsPlanType", + "operation": { + "target": "com.amazonaws.savingsplans#SavingsPlanOperation", "traits": { - "smithy.api#documentation": "

    The plan type.

    " + "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " } }, - "properties": { - "target": "com.amazonaws.savingsplans#SavingsPlanOfferingPropertyList", + "durationSeconds": { + "target": "com.amazonaws.savingsplans#SavingsPlansDuration", "traits": { - "smithy.api#documentation": "

    The properties.

    " + "smithy.api#documentation": "

    The duration, in seconds.

    " } }, - "description": { - "target": "com.amazonaws.savingsplans#SavingsPlanDescription", + "planType": { + "target": "com.amazonaws.savingsplans#SavingsPlanType", "traits": { - "smithy.api#documentation": "

    The description.

    " + "smithy.api#documentation": "

    The plan type.

    " } }, - "productTypes": { - "target": "com.amazonaws.savingsplans#SavingsPlanProductTypeList", + "usageType": { + "target": "com.amazonaws.savingsplans#SavingsPlanUsageType", "traits": { - "smithy.api#documentation": "

    The product type.

    " + "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " } }, - "serviceCode": { - "target": "com.amazonaws.savingsplans#SavingsPlanServiceCode", + "description": { + "target": "com.amazonaws.savingsplans#SavingsPlanDescription", "traits": { - "smithy.api#documentation": "

    The service.

    " + "smithy.api#documentation": "

    The description.

    " } }, - "durationSeconds": { - "target": "com.amazonaws.savingsplans#SavingsPlansDuration", + "paymentOption": { + "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOption", "traits": { - "smithy.api#documentation": "

    The duration, in seconds.

    " + "smithy.api#documentation": "

    The payment option.

    " } }, - "operation": { - "target": "com.amazonaws.savingsplans#SavingsPlanOperation", + "properties": { + "target": "com.amazonaws.savingsplans#SavingsPlanOfferingPropertyList", "traits": { - "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " + "smithy.api#documentation": "

    The properties.

    " } }, - "usageType": { - "target": "com.amazonaws.savingsplans#SavingsPlanUsageType", + "serviceCode": { + "target": "com.amazonaws.savingsplans#SavingsPlanServiceCode", "traits": { - "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " + "smithy.api#documentation": "

    The service.

    " } }, - "paymentOption": { - "target": "com.amazonaws.savingsplans#SavingsPlanPaymentOption", + "productTypes": { + "target": "com.amazonaws.savingsplans#SavingsPlanProductTypeList", "traits": { - "smithy.api#documentation": "

    The payment option.

    " + "smithy.api#documentation": "

    The product type.

    " } }, "offeringId": { @@ -1036,17 +1095,17 @@ "com.amazonaws.savingsplans#SavingsPlanOfferingFilterElement": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.savingsplans#SavingsPlanOfferingFilterAttribute", - "traits": { - "smithy.api#documentation": "

    The filter name.

    " - } - }, "values": { "target": "com.amazonaws.savingsplans#FilterValuesList", "traits": { "smithy.api#documentation": "

    The filter values.

    " } + }, + "name": { + "target": "com.amazonaws.savingsplans#SavingsPlanOfferingFilterAttribute", + "traits": { + "smithy.api#documentation": "

    The filter name.

    " + } } }, "traits": { @@ -1065,17 +1124,17 @@ "com.amazonaws.savingsplans#SavingsPlanOfferingProperty": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.savingsplans#JsonSafeFilterValueString", - "traits": { - "smithy.api#documentation": "

    The property value.

    " - } - }, "name": { "target": "com.amazonaws.savingsplans#SavingsPlanOfferingPropertyKey", "traits": { "smithy.api#documentation": "

    The property name.

    " } + }, + "value": { + "target": "com.amazonaws.savingsplans#JsonSafeFilterValueString", + "traits": { + "smithy.api#documentation": "

    The property value.

    " + } } }, "traits": { @@ -1106,24 +1165,6 @@ "com.amazonaws.savingsplans#SavingsPlanOfferingRate": { "type": "structure", "members": { - "serviceCode": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateServiceCode", - "traits": { - "smithy.api#documentation": "

    The service.

    " - } - }, - "operation": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateOperation", - "traits": { - "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " - } - }, - "unit": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateUnit", - "traits": { - "smithy.api#documentation": "

    The unit.

    " - } - }, "properties": { "target": "com.amazonaws.savingsplans#SavingsPlanOfferingRatePropertyList", "traits": { @@ -1136,16 +1177,34 @@ "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " } }, + "productType": { + "target": "com.amazonaws.savingsplans#SavingsPlanProductType", + "traits": { + "smithy.api#documentation": "

    The product type.

    " + } + }, "savingsPlanOffering": { "target": "com.amazonaws.savingsplans#ParentSavingsPlanOffering", "traits": { "smithy.api#documentation": "

    The Savings Plan offering.

    " } }, - "productType": { - "target": "com.amazonaws.savingsplans#SavingsPlanProductType", + "unit": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateUnit", "traits": { - "smithy.api#documentation": "

    The product type.

    " + "smithy.api#documentation": "

    The unit.

    " + } + }, + "serviceCode": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateServiceCode", + "traits": { + "smithy.api#documentation": "

    The service.

    " + } + }, + "operation": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateOperation", + "traits": { + "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " } }, "rate": { @@ -1292,22 +1351,22 @@ "com.amazonaws.savingsplans#SavingsPlanRate": { "type": "structure", "members": { - "rate": { - "target": "com.amazonaws.savingsplans#Amount", + "currency": { + "target": "com.amazonaws.savingsplans#CurrencyCode", "traits": { - "smithy.api#documentation": "

    The rate.

    " + "smithy.api#documentation": "

    The currency.

    " } }, - "usageType": { - "target": "com.amazonaws.savingsplans#SavingsPlanRateUsageType", + "properties": { + "target": "com.amazonaws.savingsplans#SavingsPlanRatePropertyList", "traits": { - "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " + "smithy.api#documentation": "

    The properties.

    " } }, - "currency": { - "target": "com.amazonaws.savingsplans#CurrencyCode", + "usageType": { + "target": "com.amazonaws.savingsplans#SavingsPlanRateUsageType", "traits": { - "smithy.api#documentation": "

    The currency.

    " + "smithy.api#documentation": "

    The usage details of the line item in the billing report.

    " } }, "serviceCode": { @@ -1322,6 +1381,12 @@ "smithy.api#documentation": "

    The unit.

    " } }, + "rate": { + "target": "com.amazonaws.savingsplans#Amount", + "traits": { + "smithy.api#documentation": "

    The rate.

    " + } + }, "productType": { "target": "com.amazonaws.savingsplans#SavingsPlanProductType", "traits": { @@ -1333,12 +1398,6 @@ "traits": { "smithy.api#documentation": "

    The specific AWS operation for the line item in the billing report.

    " } - }, - "properties": { - "target": "com.amazonaws.savingsplans#SavingsPlanRatePropertyList", - "traits": { - "smithy.api#documentation": "

    The properties.

    " - } } }, "traits": { @@ -1469,17 +1528,17 @@ "com.amazonaws.savingsplans#SavingsPlanRateProperty": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.savingsplans#JsonSafeFilterValueString", - "traits": { - "smithy.api#documentation": "

    The property value.

    " - } - }, "name": { "target": "com.amazonaws.savingsplans#SavingsPlanRatePropertyKey", "traits": { "smithy.api#documentation": "

    The property name.

    " } + }, + "value": { + "target": "com.amazonaws.savingsplans#JsonSafeFilterValueString", + "traits": { + "smithy.api#documentation": "

    The property value.

    " + } } }, "traits": { @@ -1614,6 +1673,14 @@ { "value": "retired", "name": "RETIRED" + }, + { + "value": "queued", + "name": "QUEUED" + }, + { + "value": "queued-deleted", + "name": "QUEUED_DELETED" } ] } @@ -1852,17 +1919,17 @@ "com.amazonaws.savingsplans#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.savingsplans#TagKeyList", + "resourceArn": { + "target": "com.amazonaws.savingsplans#SavingsPlanArn", "traits": { - "smithy.api#documentation": "

    The tag keys.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", "smithy.api#required": {} } }, - "resourceArn": { - "target": "com.amazonaws.savingsplans#SavingsPlanArn", + "tagKeys": { + "target": "com.amazonaws.savingsplans#TagKeyList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", + "smithy.api#documentation": "

    The tag keys.

    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/schemas.2019-12-02.json b/codegen/sdk-codegen/aws-models/schemas.2019-12-02.json index 118b3cf7b95c..059418ca9668 100644 --- a/codegen/sdk-codegen/aws-models/schemas.2019-12-02.json +++ b/codegen/sdk-codegen/aws-models/schemas.2019-12-02.json @@ -32,17 +32,17 @@ "com.amazonaws.schemas#BadRequestException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The error code.

    ", + "smithy.api#documentation": "

    The message string of the error output.

    ", "smithy.api#required": {} } }, - "Message": { + "Code": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The message string of the error output.

    ", + "smithy.api#documentation": "

    The error code.

    ", "smithy.api#required": {} } } @@ -162,23 +162,16 @@ "com.amazonaws.schemas#CreateDiscovererResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.schemas#Tags", - "traits": { - "smithy.api#documentation": "

    Tags associated with the resource.

    ", - "smithy.api#jsonName": "tags" - } - }, "DiscovererArn": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The ARN of the discoverer.

    " } }, - "DiscovererId": { - "target": "com.amazonaws.schemas#__string", + "State": { + "target": "com.amazonaws.schemas#DiscovererState", "traits": { - "smithy.api#documentation": "

    The ID of the discoverer.

    " + "smithy.api#documentation": "

    The state of the discoverer.

    " } }, "Description": { @@ -187,16 +180,23 @@ "smithy.api#documentation": "

    The description of the discoverer.

    " } }, + "DiscovererId": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The ID of the discoverer.

    " + } + }, "SourceArn": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The ARN of the event bus.

    " } }, - "State": { - "target": "com.amazonaws.schemas#DiscovererState", + "Tags": { + "target": "com.amazonaws.schemas#Tags", "traits": { - "smithy.api#documentation": "

    The state of the discoverer.

    " + "smithy.api#documentation": "

    Tags associated with the resource.

    ", + "smithy.api#jsonName": "tags" } } } @@ -241,13 +241,6 @@ "com.amazonaws.schemas#CreateRegistryRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.schemas#Tags", - "traits": { - "smithy.api#documentation": "

    Tags to associate with the registry.

    ", - "smithy.api#jsonName": "tags" - } - }, "Description": { "target": "com.amazonaws.schemas#__stringMin0Max256", "traits": { @@ -261,6 +254,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.schemas#Tags", + "traits": { + "smithy.api#documentation": "

    Tags to associate with the registry.

    ", + "smithy.api#jsonName": "tags" + } } } }, @@ -273,10 +273,10 @@ "smithy.api#documentation": "

    The description of the registry.

    " } }, - "RegistryArn": { + "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The ARN of the registry.

    " + "smithy.api#documentation": "

    The name of the registry.

    " } }, "Tags": { @@ -286,10 +286,10 @@ "smithy.api#jsonName": "tags" } }, - "RegistryName": { + "RegistryArn": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    " + "smithy.api#documentation": "

    The ARN of the registry.

    " } } } @@ -328,10 +328,11 @@ "com.amazonaws.schemas#CreateSchemaRequest": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.schemas#__stringMin1Max100000", + "RegistryName": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The source of the schema definition.

    ", + "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -343,17 +344,10 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.schemas#Tags", - "traits": { - "smithy.api#documentation": "

    Tags associated with the schema.

    ", - "smithy.api#jsonName": "tags" - } - }, - "Type": { - "target": "com.amazonaws.schemas#Type", + "Content": { + "target": "com.amazonaws.schemas#__stringMin1Max100000", "traits": { - "smithy.api#documentation": "

    The type of schema.

    ", + "smithy.api#documentation": "

    The source of the schema definition.

    ", "smithy.api#required": {} } }, @@ -363,23 +357,29 @@ "smithy.api#documentation": "

    A description of the schema.

    " } }, - "RegistryName": { - "target": "com.amazonaws.schemas#__string", + "Type": { + "target": "com.amazonaws.schemas#Type", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The type of schema.

    ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.schemas#Tags", + "traits": { + "smithy.api#documentation": "

    Tags associated with the schema.

    ", + "smithy.api#jsonName": "tags" + } } } }, "com.amazonaws.schemas#CreateSchemaResponse": { "type": "structure", "members": { - "SchemaName": { - "target": "com.amazonaws.schemas#__string", + "VersionCreatedDate": { + "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    " + "smithy.api#documentation": "

    The date the schema version was created.

    " } }, "SchemaArn": { @@ -388,22 +388,16 @@ "smithy.api#documentation": "

    The ARN of the schema.

    " } }, - "VersionCreatedDate": { - "target": "com.amazonaws.schemas#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

    The date the schema version was created.

    " - } - }, - "SchemaVersion": { - "target": "com.amazonaws.schemas#__string", + "Tags": { + "target": "com.amazonaws.schemas#Tags", "traits": { - "smithy.api#documentation": "

    The version number of the schema

    " + "smithy.api#jsonName": "tags" } }, - "Description": { + "Type": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The description of the schema.

    " + "smithy.api#documentation": "

    The type of the schema.

    " } }, "LastModified": { @@ -412,16 +406,22 @@ "smithy.api#documentation": "

    The date and time that schema was modified.

    " } }, - "Type": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The type of the schema.

    " + "smithy.api#documentation": "

    The name of the schema.

    " } }, - "Tags": { - "target": "com.amazonaws.schemas#Tags", + "SchemaVersion": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The version number of the schema

    " + } + }, + "Description": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The description of the schema.

    " } } } @@ -603,18 +603,18 @@ "com.amazonaws.schemas#DeleteSchemaRequest": { "type": "structure", "members": { - "RegistryName": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#documentation": "

    The name of the schema.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "SchemaName": { + "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    ", + "smithy.api#documentation": "

    The name of the registry.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -731,10 +731,10 @@ "smithy.api#httpQuery": "schemaVersion" } }, - "RegistryName": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#documentation": "

    The name of the schema.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -747,10 +747,10 @@ "smithy.api#required": {} } }, - "SchemaName": { + "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    ", + "smithy.api#documentation": "

    The name of the registry.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -760,28 +760,28 @@ "com.amazonaws.schemas#DescribeCodeBindingResponse": { "type": "structure", "members": { - "SchemaVersion": { - "target": "com.amazonaws.schemas#__string", + "Status": { + "target": "com.amazonaws.schemas#CodeGenerationStatus", "traits": { - "smithy.api#documentation": "

    The version number of the schema.

    " + "smithy.api#documentation": "

    The current status of code binding generation.

    " } }, - "CreationDate": { + "LastModified": { "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The time and date that the code binding was created.

    " + "smithy.api#documentation": "

    The date and time that code bindings were modified.

    " } }, - "LastModified": { + "CreationDate": { "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The date and time that code bindings were modified.

    " + "smithy.api#documentation": "

    The time and date that the code binding was created.

    " } }, - "Status": { - "target": "com.amazonaws.schemas#CodeGenerationStatus", + "SchemaVersion": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The current status of code binding generation.

    " + "smithy.api#documentation": "

    The version number of the schema.

    " } } } @@ -839,16 +839,28 @@ "com.amazonaws.schemas#DescribeDiscovererResponse": { "type": "structure", "members": { + "SourceArn": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The ARN of the event bus.

    " + } + }, + "Description": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The description of the discoverer.

    " + } + }, "State": { "target": "com.amazonaws.schemas#DiscovererState", "traits": { "smithy.api#documentation": "

    The state of the discoverer.

    " } }, - "Description": { + "DiscovererId": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The description of the discoverer.

    " + "smithy.api#documentation": "

    The ID of the discoverer.

    " } }, "DiscovererArn": { @@ -863,18 +875,6 @@ "smithy.api#documentation": "

    Tags associated with the resource.

    ", "smithy.api#jsonName": "tags" } - }, - "DiscovererId": { - "target": "com.amazonaws.schemas#__string", - "traits": { - "smithy.api#documentation": "

    The ID of the discoverer.

    " - } - }, - "SourceArn": { - "target": "com.amazonaws.schemas#__string", - "traits": { - "smithy.api#documentation": "

    The ARN of the event bus.

    " - } } } }, @@ -931,17 +931,16 @@ "com.amazonaws.schemas#DescribeRegistryResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.schemas#Tags", + "Description": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    Tags associated with the registry.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The description of the registry.

    " } }, - "Description": { + "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The description of the registry.

    " + "smithy.api#documentation": "

    The name of the registry.

    " } }, "RegistryArn": { @@ -950,10 +949,11 @@ "smithy.api#documentation": "

    The ARN of the registry.

    " } }, - "RegistryName": { - "target": "com.amazonaws.schemas#__string", + "Tags": { + "target": "com.amazonaws.schemas#Tags", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    " + "smithy.api#documentation": "

    Tags associated with the registry.

    ", + "smithy.api#jsonName": "tags" } } } @@ -1026,29 +1026,28 @@ "com.amazonaws.schemas#DescribeSchemaResponse": { "type": "structure", "members": { - "SchemaVersion": { + "Type": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The version number of the schema

    " + "smithy.api#documentation": "

    The type of the schema.

    " } }, - "Type": { + "SchemaVersion": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The type of the schema.

    " + "smithy.api#documentation": "

    The version number of the schema

    " } }, - "Tags": { - "target": "com.amazonaws.schemas#Tags", + "VersionCreatedDate": { + "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    Tags associated with the resource.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The date the schema version was created.

    " } }, - "SchemaArn": { + "Content": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The ARN of the schema.

    " + "smithy.api#documentation": "

    The source of the schema definition.

    " } }, "SchemaName": { @@ -1057,28 +1056,29 @@ "smithy.api#documentation": "

    The name of the schema.

    " } }, - "LastModified": { - "target": "com.amazonaws.schemas#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

    The date and time that schema was modified.

    " - } - }, "Description": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The description of the schema.

    " } }, - "Content": { + "LastModified": { + "target": "com.amazonaws.schemas#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

    The date and time that schema was modified.

    " + } + }, + "SchemaArn": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The source of the schema definition.

    " + "smithy.api#documentation": "

    The ARN of the schema.

    " } }, - "VersionCreatedDate": { - "target": "com.amazonaws.schemas#__timestampIso8601", + "Tags": { + "target": "com.amazonaws.schemas#Tags", "traits": { - "smithy.api#documentation": "

    The date the schema version was created.

    " + "smithy.api#documentation": "

    Tags associated with the resource.

    ", + "smithy.api#jsonName": "tags" } } } @@ -1101,10 +1101,17 @@ "com.amazonaws.schemas#DiscovererSummary": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.schemas#DiscovererState", + "DiscovererArn": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The state of the discoverer.

    " + "smithy.api#documentation": "

    The ARN of the discoverer.

    " + } + }, + "Tags": { + "target": "com.amazonaws.schemas#Tags", + "traits": { + "smithy.api#documentation": "

    Tags associated with the resource.

    ", + "smithy.api#jsonName": "tags" } }, "SourceArn": { @@ -1119,18 +1126,105 @@ "smithy.api#documentation": "

    The ID of the discoverer.

    " } }, - "Tags": { - "target": "com.amazonaws.schemas#Tags", + "State": { + "target": "com.amazonaws.schemas#DiscovererState", "traits": { - "smithy.api#documentation": "

    Tags associated with the resource.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The state of the discoverer.

    " } + } + } + }, + "com.amazonaws.schemas#ExportSchema": { + "type": "operation", + "input": { + "target": "com.amazonaws.schemas#ExportSchemaRequest" + }, + "output": { + "target": "com.amazonaws.schemas#ExportSchemaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.schemas#BadRequestException" }, - "DiscovererArn": { + { + "target": "com.amazonaws.schemas#ForbiddenException" + }, + { + "target": "com.amazonaws.schemas#InternalServerErrorException" + }, + { + "target": "com.amazonaws.schemas#NotFoundException" + }, + { + "target": "com.amazonaws.schemas#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.schemas#TooManyRequestsException" + }, + { + "target": "com.amazonaws.schemas#UnauthorizedException" + } + ], + "traits": { + "smithy.api#http": { + "method": "GET", + "uri": "/v1/registries/name/{RegistryName}/schemas/name/{SchemaName}/export", + "code": 200 + } + } + }, + "com.amazonaws.schemas#ExportSchemaRequest": { + "type": "structure", + "members": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The ARN of the discoverer.

    " + "smithy.api#documentation": "

    The name of the schema.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } + }, + "SchemaVersion": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    Specifying this limits the results to only this schema version.

    ", + "smithy.api#httpQuery": "schemaVersion" + } + }, + "RegistryName": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#httpQuery": "type", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.schemas#ExportSchemaResponse": { + "type": "structure", + "members": { + "Content": { + "target": "com.amazonaws.schemas#__string" + }, + "SchemaArn": { + "target": "com.amazonaws.schemas#__string" + }, + "SchemaName": { + "target": "com.amazonaws.schemas#__string" + }, + "SchemaVersion": { + "target": "com.amazonaws.schemas#__string" + }, + "Type": { + "target": "com.amazonaws.schemas#__string" } } }, @@ -1197,35 +1291,35 @@ "com.amazonaws.schemas#GetCodeBindingSourceRequest": { "type": "structure", "members": { - "RegistryName": { + "SchemaVersion": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifying this limits the results to only this schema version.

    ", + "smithy.api#httpQuery": "schemaVersion" } }, - "Language": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The language of the code binding.

    ", + "smithy.api#documentation": "

    The name of the schema.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "SchemaName": { + "Language": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    ", + "smithy.api#documentation": "

    The language of the code binding.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "SchemaVersion": { + "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    Specifying this limits the results to only this schema version.

    ", - "smithy.api#httpQuery": "schemaVersion" + "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -1278,17 +1372,17 @@ "com.amazonaws.schemas#GetDiscoveredSchemaRequest": { "type": "structure", "members": { - "Events": { - "target": "com.amazonaws.schemas#__listOfGetDiscoveredSchemaVersionItemInput", + "Type": { + "target": "com.amazonaws.schemas#Type", "traits": { - "smithy.api#documentation": "

    An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.

    ", + "smithy.api#documentation": "

    The type of event.

    ", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.schemas#Type", + "Events": { + "target": "com.amazonaws.schemas#__listOfGetDiscoveredSchemaVersionItemInput", "traits": { - "smithy.api#documentation": "

    The type of event.

    ", + "smithy.api#documentation": "

    An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.

    ", "smithy.api#required": {} } } @@ -1383,17 +1477,17 @@ "com.amazonaws.schemas#GoneException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The error code.

    ", + "smithy.api#documentation": "

    The message string of the error output.

    ", "smithy.api#required": {} } }, - "Message": { + "Code": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The message string of the error output.

    ", + "smithy.api#documentation": "

    The error code.

    ", "smithy.api#required": {} } } @@ -1406,17 +1500,17 @@ "com.amazonaws.schemas#InternalServerErrorException": { "type": "structure", "members": { - "Message": { + "Code": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The message string of the error output.

    ", + "smithy.api#documentation": "

    The error code.

    ", "smithy.api#required": {} } }, - "Code": { + "Message": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The error code.

    ", + "smithy.api#documentation": "

    The message string of the error output.

    ", "smithy.api#required": {} } } @@ -1457,18 +1551,18 @@ "method": "GET", "uri": "/v1/discoverers", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Discoverers", + "pageSize": "Limit" } } }, "com.amazonaws.schemas#ListDiscoverersRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.schemas#__integer", - "traits": { - "smithy.api#httpQuery": "limit" - } - }, "DiscovererIdPrefix": { "target": "com.amazonaws.schemas#__string", "traits": { @@ -1476,11 +1570,10 @@ "smithy.api#httpQuery": "discovererIdPrefix" } }, - "NextToken": { - "target": "com.amazonaws.schemas#__string", + "Limit": { + "target": "com.amazonaws.schemas#__integer", "traits": { - "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    ", - "smithy.api#httpQuery": "nextToken" + "smithy.api#httpQuery": "limit" } }, "SourceArnPrefix": { @@ -1489,6 +1582,13 @@ "smithy.api#documentation": "

    Specifying this limits the results to only those ARNs that start with the specified prefix.

    ", "smithy.api#httpQuery": "sourceArnPrefix" } + }, + "NextToken": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    ", + "smithy.api#httpQuery": "nextToken" + } } } }, @@ -1540,24 +1640,30 @@ "method": "GET", "uri": "/v1/registries", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Registries", + "pageSize": "Limit" } } }, "com.amazonaws.schemas#ListRegistriesRequest": { "type": "structure", "members": { - "NextToken": { + "Scope": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    ", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

    Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

    ", + "smithy.api#httpQuery": "scope" } }, - "RegistryNamePrefix": { + "NextToken": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    Specifying this limits the results to only those registry names that start with the specified prefix.

    ", - "smithy.api#httpQuery": "registryNamePrefix" + "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    ", + "smithy.api#httpQuery": "nextToken" } }, "Limit": { @@ -1566,11 +1672,11 @@ "smithy.api#httpQuery": "limit" } }, - "Scope": { + "RegistryNamePrefix": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

    ", - "smithy.api#httpQuery": "scope" + "smithy.api#documentation": "

    Specifying this limits the results to only those registry names that start with the specified prefix.

    ", + "smithy.api#httpQuery": "registryNamePrefix" } } } @@ -1626,6 +1732,12 @@ "method": "GET", "uri": "/v1/registries/name/{RegistryName}/schemas/name/{SchemaName}/versions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SchemaVersions", + "pageSize": "Limit" } } }, @@ -1640,19 +1752,19 @@ "smithy.api#required": {} } }, - "SchemaName": { + "NextToken": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    ", + "smithy.api#httpQuery": "nextToken" } }, - "NextToken": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    ", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

    The name of the schema.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Limit": { @@ -1666,17 +1778,17 @@ "com.amazonaws.schemas#ListSchemaVersionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.schemas#__string", - "traits": { - "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    " - } - }, "SchemaVersions": { "target": "com.amazonaws.schemas#__listOfSchemaVersionSummary", "traits": { "smithy.api#documentation": "

    An array of schema version summaries.

    " } + }, + "NextToken": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    " + } } } }, @@ -1711,6 +1823,12 @@ "method": "GET", "uri": "/v1/registries/name/{RegistryName}/schemas", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Schemas", + "pageSize": "Limit" } } }, @@ -1724,11 +1842,10 @@ "smithy.api#httpQuery": "nextToken" } }, - "SchemaNamePrefix": { - "target": "com.amazonaws.schemas#__string", + "Limit": { + "target": "com.amazonaws.schemas#__integer", "traits": { - "smithy.api#documentation": "

    Specifying this limits the results to only those schema names that start with the specified prefix.

    ", - "smithy.api#httpQuery": "schemaNamePrefix" + "smithy.api#httpQuery": "limit" } }, "RegistryName": { @@ -1739,10 +1856,11 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.schemas#__integer", + "SchemaNamePrefix": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

    Specifying this limits the results to only those schema names that start with the specified prefix.

    ", + "smithy.api#httpQuery": "schemaNamePrefix" } } } @@ -1750,17 +1868,17 @@ "com.amazonaws.schemas#ListSchemasResponse": { "type": "structure", "members": { - "Schemas": { - "target": "com.amazonaws.schemas#__listOfSchemaSummary", - "traits": { - "smithy.api#documentation": "

    An array of schema summaries.

    " - } - }, "NextToken": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    " } + }, + "Schemas": { + "target": "com.amazonaws.schemas#__listOfSchemaSummary", + "traits": { + "smithy.api#documentation": "

    An array of schema summaries.

    " + } } } }, @@ -1845,17 +1963,17 @@ "com.amazonaws.schemas#PreconditionFailedException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The error code.

    ", + "smithy.api#documentation": "

    The message string of the error output.

    ", "smithy.api#required": {} } }, - "Message": { + "Code": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The message string of the error output.

    ", + "smithy.api#documentation": "

    The error code.

    ", "smithy.api#required": {} } } @@ -1915,26 +2033,26 @@ "smithy.api#httpQuery": "schemaVersion" } }, - "SchemaName": { + "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    ", + "smithy.api#documentation": "

    The name of the registry.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Language": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The language of the code binding.

    ", + "smithy.api#documentation": "

    The name of the schema.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RegistryName": { + "Language": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#documentation": "

    The language of the code binding.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1944,16 +2062,16 @@ "com.amazonaws.schemas#PutCodeBindingResponse": { "type": "structure", "members": { - "CreationDate": { - "target": "com.amazonaws.schemas#__timestampIso8601", + "Status": { + "target": "com.amazonaws.schemas#CodeGenerationStatus", "traits": { - "smithy.api#documentation": "

    The time and date that the code binding was created.

    " + "smithy.api#documentation": "

    The current status of code binding generation.

    " } }, - "LastModified": { + "CreationDate": { "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The date and time that code bindings were modified.

    " + "smithy.api#documentation": "

    The time and date that the code binding was created.

    " } }, "SchemaVersion": { @@ -1961,11 +2079,11 @@ "traits": { "smithy.api#documentation": "

    The version number of the schema.

    " } - }, - "Status": { - "target": "com.amazonaws.schemas#CodeGenerationStatus", + }, + "LastModified": { + "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The current status of code binding generation.

    " + "smithy.api#documentation": "

    The date and time that code bindings were modified.

    " } } } @@ -2013,6 +2131,13 @@ "com.amazonaws.schemas#PutResourcePolicyRequest": { "type": "structure", "members": { + "RegistryName": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#httpQuery": "registryName" + } + }, "RevisionId": { "target": "com.amazonaws.schemas#__string", "traits": { @@ -2025,13 +2150,6 @@ "smithy.api#documentation": "

    The resource-based policy.

    ", "smithy.api#required": {} } - }, - "RegistryName": { - "target": "com.amazonaws.schemas#__string", - "traits": { - "smithy.api#documentation": "

    The name of the registry.

    ", - "smithy.api#httpQuery": "registryName" - } } }, "traits": { @@ -2058,10 +2176,11 @@ "com.amazonaws.schemas#RegistrySummary": { "type": "structure", "members": { - "RegistryArn": { - "target": "com.amazonaws.schemas#__string", + "Tags": { + "target": "com.amazonaws.schemas#Tags", "traits": { - "smithy.api#documentation": "

    The ARN of the registry.

    " + "smithy.api#documentation": "

    Tags associated with the registry.

    ", + "smithy.api#jsonName": "tags" } }, "RegistryName": { @@ -2070,11 +2189,10 @@ "smithy.api#documentation": "

    The name of the registry.

    " } }, - "Tags": { - "target": "com.amazonaws.schemas#Tags", + "RegistryArn": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    Tags associated with the registry.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "

    The ARN of the registry.

    " } } } @@ -2094,12 +2212,6 @@ "smithy.api#documentation": "

    The ARN of the schema.

    " } }, - "VersionCount": { - "target": "com.amazonaws.schemas#__long", - "traits": { - "smithy.api#documentation": "

    The number of versions available for the schema.

    " - } - }, "LastModified": { "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { @@ -2112,6 +2224,12 @@ "smithy.api#documentation": "

    Tags associated with the schema.

    ", "smithy.api#jsonName": "tags" } + }, + "VersionCount": { + "target": "com.amazonaws.schemas#__long", + "traits": { + "smithy.api#documentation": "

    The number of versions available for the schema.

    " + } } }, "traits": { @@ -2127,6 +2245,12 @@ "smithy.api#documentation": "

    The version number of the schema.

    " } }, + "Type": { + "target": "com.amazonaws.schemas#Type", + "traits": { + "smithy.api#documentation": "

    The type of schema.

    " + } + }, "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { @@ -2144,18 +2268,18 @@ "com.amazonaws.schemas#SearchSchemaSummary": { "type": "structure", "members": { - "SchemaVersions": { - "target": "com.amazonaws.schemas#__listOfSearchSchemaVersionSummary", - "traits": { - "smithy.api#documentation": "

    An array of schema version summaries.

    " - } - }, "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The name of the schema.

    " } }, + "SchemaVersions": { + "target": "com.amazonaws.schemas#__listOfSearchSchemaVersionSummary", + "traits": { + "smithy.api#documentation": "

    An array of schema version summaries.

    " + } + }, "SchemaArn": { "target": "com.amazonaws.schemas#__string", "traits": { @@ -2179,6 +2303,12 @@ "smithy.api#documentation": "

    The version number of the schema

    " } }, + "Type": { + "target": "com.amazonaws.schemas#Type", + "traits": { + "smithy.api#documentation": "

    The type of schema.

    " + } + }, "CreatedDate": { "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { @@ -2218,25 +2348,29 @@ "method": "GET", "uri": "/v1/registries/name/{RegistryName}/schemas/search", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Schemas", + "pageSize": "Limit" } } }, "com.amazonaws.schemas#SearchSchemasRequest": { "type": "structure", "members": { - "Keywords": { - "target": "com.amazonaws.schemas#__string", + "Limit": { + "target": "com.amazonaws.schemas#__integer", "traits": { - "smithy.api#documentation": "

    Specifying this limits the results to only schemas that include the provided keywords.

    ", - "smithy.api#httpQuery": "keywords", - "smithy.api#required": {} + "smithy.api#httpQuery": "limit" } }, - "RegistryName": { + "Keywords": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    Specifying this limits the results to only schemas that include the provided keywords.

    ", + "smithy.api#httpQuery": "keywords", "smithy.api#required": {} } }, @@ -2247,10 +2381,12 @@ "smithy.api#httpQuery": "nextToken" } }, - "Limit": { - "target": "com.amazonaws.schemas#__integer", + "RegistryName": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

    The name of the registry.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -2258,17 +2394,17 @@ "com.amazonaws.schemas#SearchSchemasResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.schemas#__string", - "traits": { - "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    " - } - }, "Schemas": { "target": "com.amazonaws.schemas#__listOfSearchSchemaSummary", "traits": { "smithy.api#documentation": "

    An array of SearchSchemaSummary information.

    " } + }, + "NextToken": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

    " + } } } }, @@ -2348,17 +2484,17 @@ "com.amazonaws.schemas#StartDiscovererResponse": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.schemas#DiscovererState", - "traits": { - "smithy.api#documentation": "

    The state of the discoverer.

    " - } - }, "DiscovererId": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The ID of the discoverer.

    " } + }, + "State": { + "target": "com.amazonaws.schemas#DiscovererState", + "traits": { + "smithy.api#documentation": "

    The state of the discoverer.

    " + } } } }, @@ -2415,17 +2551,17 @@ "com.amazonaws.schemas#StopDiscovererResponse": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.schemas#DiscovererState", - "traits": { - "smithy.api#documentation": "

    The state of the discoverer.

    " - } - }, "DiscovererId": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The ID of the discoverer.

    " } + }, + "State": { + "target": "com.amazonaws.schemas#DiscovererState", + "traits": { + "smithy.api#documentation": "

    The state of the discoverer.

    " + } } } }, @@ -2529,6 +2665,10 @@ { "value": "OpenApi3", "name": "OpenApi3" + }, + { + "value": "JSONSchemaDraft4", + "name": "JSONSchemaDraft4" } ] } @@ -2536,17 +2676,17 @@ "com.amazonaws.schemas#UnauthorizedException": { "type": "structure", "members": { - "Message": { + "Code": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The message string of the error output.

    ", + "smithy.api#documentation": "

    The error code.

    ", "smithy.api#required": {} } }, - "Code": { + "Message": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The error code.

    ", + "smithy.api#documentation": "

    The message string of the error output.

    ", "smithy.api#required": {} } } @@ -2645,12 +2785,6 @@ "com.amazonaws.schemas#UpdateDiscovererRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.schemas#__stringMin0Max256", - "traits": { - "smithy.api#documentation": "

    The description of the discoverer to update.

    " - } - }, "DiscovererId": { "target": "com.amazonaws.schemas#__string", "traits": { @@ -2658,29 +2792,28 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Description": { + "target": "com.amazonaws.schemas#__stringMin0Max256", + "traits": { + "smithy.api#documentation": "

    The description of the discoverer to update.

    " + } } } }, "com.amazonaws.schemas#UpdateDiscovererResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.schemas#Tags", - "traits": { - "smithy.api#documentation": "

    Tags associated with the resource.

    ", - "smithy.api#jsonName": "tags" - } - }, "Description": { "target": "com.amazonaws.schemas#__string", "traits": { "smithy.api#documentation": "

    The description of the discoverer.

    " } }, - "DiscovererArn": { + "DiscovererId": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The ARN of the discoverer.

    " + "smithy.api#documentation": "

    The ID of the discoverer.

    " } }, "State": { @@ -2695,10 +2828,17 @@ "smithy.api#documentation": "

    The ARN of the event bus.

    " } }, - "DiscovererId": { + "Tags": { + "target": "com.amazonaws.schemas#Tags", + "traits": { + "smithy.api#documentation": "

    Tags associated with the resource.

    ", + "smithy.api#jsonName": "tags" + } + }, + "DiscovererArn": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The ID of the discoverer.

    " + "smithy.api#documentation": "

    The ARN of the discoverer.

    " } } } @@ -2743,6 +2883,12 @@ "com.amazonaws.schemas#UpdateRegistryRequest": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.schemas#__stringMin0Max256", + "traits": { + "smithy.api#documentation": "

    The description of the registry to update.

    " + } + }, "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { @@ -2750,12 +2896,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "Description": { - "target": "com.amazonaws.schemas#__stringMin0Max256", - "traits": { - "smithy.api#documentation": "

    The description of the registry to update.

    " - } } }, "traits": { @@ -2765,10 +2905,10 @@ "com.amazonaws.schemas#UpdateRegistryResponse": { "type": "structure", "members": { - "RegistryName": { + "RegistryArn": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The name of the registry.

    " + "smithy.api#documentation": "

    The ARN of the registry.

    " } }, "Tags": { @@ -2784,10 +2924,10 @@ "smithy.api#documentation": "

    The description of the registry.

    " } }, - "RegistryArn": { + "RegistryName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The ARN of the registry.

    " + "smithy.api#documentation": "

    The name of the registry.

    " } } } @@ -2829,10 +2969,10 @@ "com.amazonaws.schemas#UpdateSchemaRequest": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.schemas#__stringMin1Max100000", + "Type": { + "target": "com.amazonaws.schemas#Type", "traits": { - "smithy.api#documentation": "

    The source of the schema definition.

    " + "smithy.api#documentation": "

    The schema type for the events schema.

    " } }, "RegistryName": { @@ -2843,12 +2983,10 @@ "smithy.api#required": {} } }, - "SchemaName": { - "target": "com.amazonaws.schemas#__string", + "Content": { + "target": "com.amazonaws.schemas#__stringMin1Max100000", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The source of the schema definition.

    " } }, "Description": { @@ -2857,34 +2995,30 @@ "smithy.api#documentation": "

    The description of the schema.

    " } }, - "Type": { - "target": "com.amazonaws.schemas#Type", - "traits": { - "smithy.api#documentation": "

    The schema type for the events schema.

    " - } - }, "ClientTokenId": { "target": "com.amazonaws.schemas#__stringMin0Max36", "traits": { "smithy.api#documentation": "

    The ID of the client token.

    ", "smithy.api#idempotencyToken": {} } + }, + "SchemaName": { + "target": "com.amazonaws.schemas#__string", + "traits": { + "smithy.api#documentation": "

    The name of the schema.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.schemas#UpdateSchemaResponse": { "type": "structure", "members": { - "Description": { + "SchemaName": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The description of the schema.

    " - } - }, - "LastModified": { - "target": "com.amazonaws.schemas#__timestampIso8601", - "traits": { - "smithy.api#documentation": "

    The date and time that schema was modified.

    " + "smithy.api#documentation": "

    The name of the schema.

    " } }, "SchemaArn": { @@ -2893,22 +3027,22 @@ "smithy.api#documentation": "

    The ARN of the schema.

    " } }, - "SchemaName": { - "target": "com.amazonaws.schemas#__string", + "VersionCreatedDate": { + "target": "com.amazonaws.schemas#__timestampIso8601", "traits": { - "smithy.api#documentation": "

    The name of the schema.

    " + "smithy.api#documentation": "

    The date the schema version was created.

    " } }, - "SchemaVersion": { + "Type": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The version number of the schema

    " + "smithy.api#documentation": "

    The type of the schema.

    " } }, - "VersionCreatedDate": { - "target": "com.amazonaws.schemas#__timestampIso8601", + "SchemaVersion": { + "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The date the schema version was created.

    " + "smithy.api#documentation": "

    The version number of the schema

    " } }, "Tags": { @@ -2917,10 +3051,16 @@ "smithy.api#jsonName": "tags" } }, - "Type": { + "Description": { "target": "com.amazonaws.schemas#__string", "traits": { - "smithy.api#documentation": "

    The type of the schema.

    " + "smithy.api#documentation": "

    The description of the schema.

    " + } + }, + "LastModified": { + "target": "com.amazonaws.schemas#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

    The date and time that schema was modified.

    " } } } @@ -3070,6 +3210,9 @@ { "target": "com.amazonaws.schemas#DescribeSchema" }, + { + "target": "com.amazonaws.schemas#ExportSchema" + }, { "target": "com.amazonaws.schemas#GetCodeBindingSource" }, diff --git a/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json b/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json index 1698deac3761..55fffa7c6d63 100644 --- a/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json +++ b/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json @@ -82,18 +82,18 @@ "com.amazonaws.secretsmanager#CancelRotateSecretResponse": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.secretsmanager#SecretVersionIdType", - "traits": { - "smithy.api#documentation": "

    The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. At the very\n least, you should remove the VersionStage value AWSPENDING to enable this\n version to be deleted. Failing to clean up a cancelled rotation can block you from\n successfully starting future rotations.

    " - } - }, "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

    The ARN of the secret for which rotation was canceled.

    " } }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

    The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. At the very\n least, you should remove the VersionStage value AWSPENDING to enable this\n version to be deleted. Failing to clean up a cancelled rotation can block you from\n successfully starting future rotations.

    " + } + }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { @@ -162,10 +162,16 @@ "smithy.api#required": {} } }, - "SecretString": { - "target": "com.amazonaws.secretsmanager#SecretStringType", + "Tags": { + "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "

    (Optional) Specifies text data that you want to encrypt and store in this new version of\n the secret.

    \n

    Either SecretString or SecretBinary must have a value, but not\n both. They cannot both be empty.

    \n

    If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected\n secret text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that the Lambda rotation function knows how\n to parse.

    \n

    For storing multiple values, we recommend that you use a JSON text string argument and\n specify key/value pairs. For information on how to format a JSON parameter for the various\n command line tool environments, see Using JSON for\n Parameters in the AWS CLI User Guide. For example:

    \n

    \n {\"username\":\"bob\",\"password\":\"abc123xyz456\"}\n

    \n

    If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.

    " + "smithy.api#documentation": "

    (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag\n is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list\n of tags. To remove tags, you must use UntagResource.

    \n \n
      \n
    • \n

      Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".

      \n
      • \n
    • \n

      If you check tags in IAM policy Condition elements as part of your\n security strategy, then adding or removing a tag can change permissions. If the\n successful completion of this operation would result in you losing your permissions for\n this secret, then this operation is blocked and returns an Access Denied\n error.

      \n
      • \n
    \n     \n

    This parameter requires a JSON text string argument. For information on how to format a\n JSON parameter for the various command line tool environments, see Using JSON for\n Parameters in the AWS CLI User Guide. For example:

    \n

    \n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n

    \n

    If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.

    \n

    The following basic restrictions apply to tags:

    \n
      \n
    • \n

      Maximum number of tags per secret—50

      \n
      • \n
    • \n

      Maximum key length—127 Unicode characters in UTF-8

      \n
      • \n
    • \n

      Maximum value length—255 Unicode characters in UTF-8

      \n
      • \n
    • \n

      Tag keys and values are case sensitive.

      \n
      • \n
    • \n

      Do not use the aws: prefix in your tag names or values because AWS reserves it\n for AWS use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.

      \n
      • \n
    • \n

      If you use your tagging schema across multiple services and resources,\n remember other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.

      \n
      • \n
    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "traits": { + "smithy.api#documentation": "

    (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to\n be used to encrypt the SecretString or SecretBinary values in the\n versions stored in this secret.

    \n

    You can specify any of the supported ways to identify a AWS KMS key ID. If you need to\n reference a CMK in a different account, you can use only the key ARN or the alias ARN.

    \n

    If you don't specify this value, then Secrets Manager defaults to using the AWS account's\n default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet\n exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a\n version's SecretString or SecretBinary fields.

    \n \n

    You can use the account default CMK to encrypt and decrypt only if you call this\n operation using credentials from the same account that owns the secret. If the secret\n resides in a different account, then you must create a custom CMK and specify the ARN in\n this field.

    \n     " } }, "Description": { @@ -174,6 +180,12 @@ "smithy.api#documentation": "

    (Optional) Specifies a user-provided description of the secret.

    " } }, + "SecretString": { + "target": "com.amazonaws.secretsmanager#SecretStringType", + "traits": { + "smithy.api#documentation": "

    (Optional) Specifies text data that you want to encrypt and store in this new version of\n the secret.

    \n

    Either SecretString or SecretBinary must have a value, but not\n both. They cannot both be empty.

    \n

    If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected\n secret text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that the Lambda rotation function knows how\n to parse.

    \n

    For storing multiple values, we recommend that you use a JSON text string argument and\n specify key/value pairs. For information on how to format a JSON parameter for the various\n command line tool environments, see Using JSON for\n Parameters in the AWS CLI User Guide. For example:

    \n

    \n {\"username\":\"bob\",\"password\":\"abc123xyz456\"}\n

    \n

    If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.

    " + } + }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { @@ -186,36 +198,24 @@ "smithy.api#documentation": "

    (Optional) If you include SecretString or SecretBinary, then an\n initial version is created as part of the secret, and this parameter specifies a unique\n identifier for the new version.

    \n \n

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it\n as the value for this parameter in the request. If you don't use the SDK and instead\n generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for the new version and include the value in the\n request.

    \n     \n

    This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during a rotation. We\n recommend that you generate a UUID-type value to\n ensure uniqueness of your versions within the specified secret.

    \n
      \n
    • \n

      If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

      \n
      • \n
    • \n

      If a version with this value already exists and the version SecretString\n and SecretBinary values are the same as those in the request, then the\n request is ignored.

      \n
      • \n
    • \n

      If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from those\n in the request then the request fails because you cannot modify an existing version.\n Instead, use PutSecretValue to create a new version.

      \n
      • \n
    \n

    This value becomes the VersionId of the new version.

    ", "smithy.api#idempotencyToken": {} } - }, - "KmsKeyId": { - "target": "com.amazonaws.secretsmanager#KmsKeyIdType", - "traits": { - "smithy.api#documentation": "

    (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to\n be used to encrypt the SecretString or SecretBinary values in the\n versions stored in this secret.

    \n

    You can specify any of the supported ways to identify a AWS KMS key ID. If you need to\n reference a CMK in a different account, you can use only the key ARN or the alias ARN.

    \n

    If you don't specify this value, then Secrets Manager defaults to using the AWS account's\n default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet\n exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a\n version's SecretString or SecretBinary fields.

    \n \n

    You can use the account default CMK to encrypt and decrypt only if you call this\n operation using credentials from the same account that owns the secret. If the secret\n resides in a different account, then you must create a custom CMK and specify the ARN in\n this field.

    \n     " - } - }, - "Tags": { - "target": "com.amazonaws.secretsmanager#TagListType", - "traits": { - "smithy.api#documentation": "

    (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag\n is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list\n of tags. To remove tags, you must use UntagResource.

    \n \n
      \n
    • \n

      Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".

      \n
      • \n
    • \n

      If you check tags in IAM policy Condition elements as part of your\n security strategy, then adding or removing a tag can change permissions. If the\n successful completion of this operation would result in you losing your permissions for\n this secret, then this operation is blocked and returns an Access Denied\n error.

      \n
      • \n
    \n     \n

    This parameter requires a JSON text string argument. For information on how to format a\n JSON parameter for the various command line tool environments, see Using JSON for\n Parameters in the AWS CLI User Guide. For example:

    \n

    \n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n

    \n

    If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.

    \n

    The following basic restrictions apply to tags:

    \n
      \n
    • \n

      Maximum number of tags per secret—50

      \n
      • \n
    • \n

      Maximum key length—127 Unicode characters in UTF-8

      \n
      • \n
    • \n

      Maximum value length—255 Unicode characters in UTF-8

      \n
      • \n
    • \n

      Tag keys and values are case sensitive.

      \n
      • \n
    • \n

      Do not use the aws: prefix in your tag names or values because AWS reserves it\n for AWS use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.

      \n
      • \n
    • \n

      If you use your tagging schema across multiple services and resources,\n remember other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.

      \n
      • \n
    " - } } } }, "com.amazonaws.secretsmanager#CreateSecretResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.secretsmanager#SecretNameType", - "traits": { - "smithy.api#documentation": "

    The friendly name of the secret that you just created.

    " - } - }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { "smithy.api#documentation": "

    The unique identifier associated with the version of the secret you just\n created.

    " } }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

    The friendly name of the secret that you just created.

    " + } + }, "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { @@ -277,17 +277,17 @@ "com.amazonaws.secretsmanager#DeleteResourcePolicyResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.secretsmanager#NameType", - "traits": { - "smithy.api#documentation": "

    The friendly name of the secret that the resource-based policy was deleted for.

    " - } - }, "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { "smithy.api#documentation": "

    The ARN of the secret that the resource-based policy was deleted for.

    " } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#NameType", + "traits": { + "smithy.api#documentation": "

    The friendly name of the secret that the resource-based policy was deleted for.

    " + } } } }, @@ -327,19 +327,19 @@ "smithy.api#documentation": "

    (Optional) Specifies that the secret is to be deleted without any recovery window. You\n can't use both this parameter and the RecoveryWindowInDays parameter in the same\n API call.

    \n

    An asynchronous background process performs the actual deletion, so there can be a short\n delay before the operation completes. If you write code to delete and then immediately\n recreate a secret with the same name, ensure that your code includes appropriate back off and\n retry logic.

    \n \n

    Use this parameter with caution. This parameter causes the operation to skip the normal\n waiting period before the permanent deletion that AWS would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithouRecovery parameter, then you have no opportunity to recover\n the secret. It is permanently lost.

    \n     " } }, - "SecretId": { - "target": "com.amazonaws.secretsmanager#SecretIdType", - "traits": { - "smithy.api#documentation": "

    Specifies the secret that you want to delete. You can specify either the Amazon Resource\n Name (ARN) or the friendly name of the secret.

    \n \n

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can \n specify a partial ARN too—for example, if you don’t include the final hyphen and six random \n characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN \n match can work as long as it uniquely matches only one secret. However, if your secret has a \n name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six \n characters to the ARN) and you try to use that as a partial ARN, then those characters cause \n Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected \n results. To avoid this situation, we recommend that you don’t create secret names ending \n with a hyphen followed by six characters.

    \n

    If you specify an incomplete ARN without the random suffix, and instead provide the \n 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, \n you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

    \n     ", - "smithy.api#required": {} - } - }, "RecoveryWindowInDays": { "target": "com.amazonaws.secretsmanager#RecoveryWindowInDaysType", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

    (Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret.\n You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in\n the same API call.

    \n

    This value can range from 7 to 30 days. The default value is 30.

    " } + }, + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

    Specifies the secret that you want to delete. You can specify either the Amazon Resource\n Name (ARN) or the friendly name of the secret.

    \n \n

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can \n specify a partial ARN too—for example, if you don’t include the final hyphen and six random \n characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN \n match can work as long as it uniquely matches only one secret. However, if your secret has a \n name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six \n characters to the ARN) and you try to use that as a partial ARN, then those characters cause \n Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected \n results. To avoid this situation, we recommend that you don’t create secret names ending \n with a hyphen followed by six characters.

    \n

    If you specify an incomplete ARN without the random suffix, and instead provide the \n 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, \n you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

    \n     ", + "smithy.api#required": {} + } } } }, @@ -407,95 +407,95 @@ "com.amazonaws.secretsmanager#DescribeSecretResponse": { "type": "structure", "members": { - "RotationLambdaARN": { - "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", + "LastRotatedDate": { + "target": "com.amazonaws.secretsmanager#LastRotatedDateType", "traits": { - "smithy.api#documentation": "

    The ARN of a Lambda function that's invoked by Secrets Manager to rotate the\n secret either automatically per the schedule or manually by a call to\n RotateSecret.

    " + "smithy.api#documentation": "

    The most recent date and time that the Secrets Manager rotation process was successfully\n completed. This value is null if the secret has never rotated.

    " } }, - "LastAccessedDate": { - "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "Description": { + "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { - "smithy.api#documentation": "

    The last date that this secret was accessed. This value is truncated to midnight of the\n date and therefore shows only the date, not the time.

    " + "smithy.api#documentation": "

    The user-provided description of the secret.

    " } }, - "Tags": { - "target": "com.amazonaws.secretsmanager#TagListType", + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

    The list of user-defined tags that are associated with the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.

    " + "smithy.api#documentation": "

    The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the\n SecretString or SecretBinary fields in each version of the secret.\n If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the\n default AWS KMS CMK (the one named awssecretsmanager) for this account.

    " } }, - "OwningService": { - "target": "com.amazonaws.secretsmanager#OwningServiceType", + "VersionIdsToStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", "traits": { - "smithy.api#documentation": "

    Returns the name of the service that created this secret.

    " + "smithy.api#documentation": "

    A list of all of the currently assigned VersionStage staging labels and the\n VersionId that each is attached to. Staging labels are used to keep track of\n the different versions during the rotation process.

    \n \n

    A version that does not have any staging labels attached is considered deprecated and\n subject to deletion. Such versions are not included in this list.

    \n     " } }, - "DeletedDate": { - "target": "com.amazonaws.secretsmanager#DeletedDateType", + "LastChangedDate": { + "target": "com.amazonaws.secretsmanager#LastChangedDateType", "traits": { - "smithy.api#documentation": "

    This value exists if the secret is scheduled for deletion. Some time after the specified\n date and time, Secrets Manager deletes the secret and all of its versions.

    \n

    If a secret is scheduled for deletion, then its details, including the encrypted secret\n information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.

    " + "smithy.api#documentation": "

    The last date and time that this secret was modified in any way.

    " } }, - "VersionIdsToStages": { - "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", + "RotationRules": { + "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { - "smithy.api#documentation": "

    A list of all of the currently assigned VersionStage staging labels and the\n VersionId that each is attached to. Staging labels are used to keep track of\n the different versions during the rotation process.

    \n \n

    A version that does not have any staging labels attached is considered deprecated and\n subject to deletion. Such versions are not included in this list.

    \n     " + "smithy.api#documentation": "

    A structure that contains the rotation configuration for this secret.

    " } }, - "ARN": { - "target": "com.amazonaws.secretsmanager#SecretARNType", + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

    The ARN of the secret.

    " + "smithy.api#documentation": "

    The user-provided friendly name of the secret.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.secretsmanager#TimestampType", + "RotationEnabled": { + "target": "com.amazonaws.secretsmanager#RotationEnabledType", "traits": { - "smithy.api#documentation": "

    The date that the secret was created.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    Specifies whether automatic rotation is enabled for this secret.

    \n

    To enable rotation, use RotateSecret with\n AutomaticallyRotateAfterDays set to a value greater than 0. To disable\n rotation, use CancelRotateSecret.

    " } }, - "LastRotatedDate": { - "target": "com.amazonaws.secretsmanager#LastRotatedDateType", + "LastAccessedDate": { + "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { - "smithy.api#documentation": "

    The most recent date and time that the Secrets Manager rotation process was successfully\n completed. This value is null if the secret has never rotated.

    " + "smithy.api#documentation": "

    The last date that this secret was accessed. This value is truncated to midnight of the\n date and therefore shows only the date, not the time.

    " } }, - "Name": { - "target": "com.amazonaws.secretsmanager#SecretNameType", + "CreatedDate": { + "target": "com.amazonaws.secretsmanager#TimestampType", "traits": { - "smithy.api#documentation": "

    The user-provided friendly name of the secret.

    " + "smithy.api#documentation": "

    The date that the secret was created.

    " } }, - "Description": { - "target": "com.amazonaws.secretsmanager#DescriptionType", + "DeletedDate": { + "target": "com.amazonaws.secretsmanager#DeletedDateType", "traits": { - "smithy.api#documentation": "

    The user-provided description of the secret.

    " + "smithy.api#documentation": "

    This value exists if the secret is scheduled for deletion. Some time after the specified\n date and time, Secrets Manager deletes the secret and all of its versions.

    \n

    If a secret is scheduled for deletion, then its details, including the encrypted secret\n information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.

    " } }, - "RotationRules": { - "target": "com.amazonaws.secretsmanager#RotationRulesType", + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

    A structure that contains the rotation configuration for this secret.

    " + "smithy.api#documentation": "

    The ARN of the secret.

    " } }, - "RotationEnabled": { - "target": "com.amazonaws.secretsmanager#RotationEnabledType", + "OwningService": { + "target": "com.amazonaws.secretsmanager#OwningServiceType", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Specifies whether automatic rotation is enabled for this secret.

    \n

    To enable rotation, use RotateSecret with\n AutomaticallyRotateAfterDays set to a value greater than 0. To disable\n rotation, use CancelRotateSecret.

    " + "smithy.api#documentation": "

    Returns the name of the service that created this secret.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "RotationLambdaARN": { + "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { - "smithy.api#documentation": "

    The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the\n SecretString or SecretBinary fields in each version of the secret.\n If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the\n default AWS KMS CMK (the one named awssecretsmanager) for this account.

    " + "smithy.api#documentation": "

    The ARN of a Lambda function that's invoked by Secrets Manager to rotate the\n secret either automatically per the schedule or manually by a call to\n RotateSecret.

    " } }, - "LastChangedDate": { - "target": "com.amazonaws.secretsmanager#LastChangedDateType", + "Tags": { + "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "

    The last date and time that this secret was modified in any way.

    " + "smithy.api#documentation": "

    The list of user-defined tags that are associated with the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.

    " } } } @@ -647,12 +647,6 @@ "com.amazonaws.secretsmanager#GetRandomPasswordRequest": { "type": "structure", "members": { - "ExcludeCharacters": { - "target": "com.amazonaws.secretsmanager#ExcludeCharactersType", - "traits": { - "smithy.api#documentation": "

    A string that includes characters that should not be included in the generated password.\n The default is that all characters from the included sets can be used.

    " - } - }, "ExcludeNumbers": { "target": "com.amazonaws.secretsmanager#ExcludeNumbersType", "traits": { @@ -660,11 +654,17 @@ "smithy.api#documentation": "

    Specifies that the generated password should not include digits. The default if you do not\n include this switch parameter is that digits can be included.

    " } }, - "ExcludeLowercase": { - "target": "com.amazonaws.secretsmanager#ExcludeLowercaseType", + "ExcludeCharacters": { + "target": "com.amazonaws.secretsmanager#ExcludeCharactersType", + "traits": { + "smithy.api#documentation": "

    A string that includes characters that should not be included in the generated password.\n The default is that all characters from the included sets can be used.

    " + } + }, + "PasswordLength": { + "target": "com.amazonaws.secretsmanager#PasswordLengthType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    Specifies that the generated password should not include lowercase letters. The default if\n you do not include this switch parameter is that lowercase letters can be included.

    " + "smithy.api#documentation": "

    The desired length of the generated password. The default value if you do not include this\n parameter is 32 characters.

    " } }, "RequireEachIncludedType": { @@ -674,11 +674,11 @@ "smithy.api#documentation": "

    A boolean value that specifies whether the generated password must include at least one of\n every allowed character type. The default value is True and the operation\n requires at least one of every character type.

    " } }, - "ExcludeUppercase": { - "target": "com.amazonaws.secretsmanager#ExcludeUppercaseType", + "IncludeSpace": { + "target": "com.amazonaws.secretsmanager#IncludeSpaceType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    Specifies that the generated password should not include uppercase letters. The default if\n you do not include this switch parameter is that uppercase letters can be included.

    " + "smithy.api#documentation": "

    Specifies that the generated password can include the space character. The default if you\n do not include this switch parameter is that the space character is not included.

    " } }, "ExcludePunctuation": { @@ -688,18 +688,18 @@ "smithy.api#documentation": "

    Specifies that the generated password should not include punctuation characters. The\n default if you do not include this switch parameter is that punctuation characters can be\n included.

    \n

    The following are the punctuation characters that can be included in\n the generated password if you don't explicitly exclude them with\n ExcludeCharacters or ExcludePunctuation:

    \n

    \n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | }\n ~\n

    " } }, - "IncludeSpace": { - "target": "com.amazonaws.secretsmanager#IncludeSpaceType", + "ExcludeLowercase": { + "target": "com.amazonaws.secretsmanager#ExcludeLowercaseType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    Specifies that the generated password can include the space character. The default if you\n do not include this switch parameter is that the space character is not included.

    " + "smithy.api#documentation": "

    Specifies that the generated password should not include lowercase letters. The default if\n you do not include this switch parameter is that lowercase letters can be included.

    " } }, - "PasswordLength": { - "target": "com.amazonaws.secretsmanager#PasswordLengthType", + "ExcludeUppercase": { + "target": "com.amazonaws.secretsmanager#ExcludeUppercaseType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    The desired length of the generated password. The default value if you do not include this\n parameter is 32 characters.

    " + "smithy.api#documentation": "

    Specifies that the generated password should not include uppercase letters. The default if\n you do not include this switch parameter is that uppercase letters can be included.

    " } } } @@ -753,12 +753,6 @@ "com.amazonaws.secretsmanager#GetResourcePolicyResponse": { "type": "structure", "members": { - "ARN": { - "target": "com.amazonaws.secretsmanager#SecretARNType", - "traits": { - "smithy.api#documentation": "

    The ARN of the secret that the resource-based policy was retrieved for.

    " - } - }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { @@ -770,6 +764,12 @@ "traits": { "smithy.api#documentation": "

    The friendly name of the secret that the resource-based policy was retrieved for.

    " } + }, + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

    The ARN of the secret that the resource-based policy was retrieved for.

    " + } } } }, @@ -812,27 +812,27 @@ "smithy.api#required": {} } }, - "VersionId": { - "target": "com.amazonaws.secretsmanager#SecretVersionIdType", - "traits": { - "smithy.api#documentation": "

    Specifies the unique identifier of the version of the secret that you want to retrieve. If\n you specify this parameter then don't specify VersionStage. If you\n don't specify either a VersionStage or VersionId then the\n default is to perform the operation on the version with the VersionStage value of\n AWSCURRENT.

    \n

    This value is typically a UUID-type value with\n 32 hexadecimal digits.

    " - } - }, "VersionStage": { "target": "com.amazonaws.secretsmanager#SecretVersionStageType", "traits": { "smithy.api#documentation": "

    Specifies the secret version that you want to retrieve by the staging label attached to\n the version.

    \n

    Staging labels are used to keep track of different versions during the rotation process.\n If you use this parameter then don't specify VersionId. If you don't\n specify either a VersionStage or VersionId, then the default is to\n perform the operation on the version with the VersionStage value of\n AWSCURRENT.

    " } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

    Specifies the unique identifier of the version of the secret that you want to retrieve. If\n you specify this parameter then don't specify VersionStage. If you\n don't specify either a VersionStage or VersionId then the\n default is to perform the operation on the version with the VersionStage value of\n AWSCURRENT.

    \n

    This value is typically a UUID-type value with\n 32 hexadecimal digits.

    " + } } } }, "com.amazonaws.secretsmanager#GetSecretValueResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.secretsmanager#SecretNameType", + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

    The friendly name of the secret.

    " + "smithy.api#documentation": "

    The unique identifier of this version of the secret.

    " } }, "CreatedDate": { @@ -841,22 +841,28 @@ "smithy.api#documentation": "

    The date and time that this version of the secret was created.

    " } }, + "SecretString": { + "target": "com.amazonaws.secretsmanager#SecretStringType", + "traits": { + "smithy.api#documentation": "

    The decrypted part of the protected secret information that was originally provided as a\n string.

    \n

    If you create this secret by using the Secrets Manager console then only the\n SecretString parameter contains data. Secrets Manager stores the information as a\n JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

    \n

    If you store custom information in the secret by using the CreateSecret,\n UpdateSecret, or PutSecretValue API operations instead\n of the Secrets Manager console, or by using the Other secret type in\n the console, then you must code your Lambda rotation function to parse and interpret those\n values.

    " + } + }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { "smithy.api#documentation": "

    The decrypted part of the protected secret information that was originally provided as\n binary data in the form of a byte array. The response parameter represents the binary data as\n a base64-encoded\n string.

    \n

    This parameter is not used if the secret is created by the Secrets Manager console.

    \n

    If you store custom information in this field of the secret, then you must code your\n Lambda rotation function to parse and interpret whatever you store in the\n SecretString or SecretBinary fields.

    " } }, - "SecretString": { - "target": "com.amazonaws.secretsmanager#SecretStringType", + "VersionStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { - "smithy.api#documentation": "

    The decrypted part of the protected secret information that was originally provided as a\n string.

    \n

    If you create this secret by using the Secrets Manager console then only the\n SecretString parameter contains data. Secrets Manager stores the information as a\n JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

    \n

    If you store custom information in the secret by using the CreateSecret,\n UpdateSecret, or PutSecretValue API operations instead\n of the Secrets Manager console, or by using the Other secret type in\n the console, then you must code your Lambda rotation function to parse and interpret those\n values.

    " + "smithy.api#documentation": "

    A list of all of the staging labels currently attached to this version of the\n secret.

    " } }, - "VersionId": { - "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

    The unique identifier of this version of the secret.

    " + "smithy.api#documentation": "

    The friendly name of the secret.

    " } }, "ARN": { @@ -864,12 +870,6 @@ "traits": { "smithy.api#documentation": "

    The ARN of the secret.

    " } - }, - "VersionStages": { - "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", - "traits": { - "smithy.api#documentation": "

    A list of all of the staging labels currently attached to this version of the\n secret.

    " - } } } }, @@ -992,13 +992,6 @@ "smithy.api#documentation": "

    (Optional) Limits the number of results you want to include in \n the response. If you don't include this parameter, it defaults to a value that's \n specific to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (isn't null). Include\n that value as the NextToken request parameter in the next call to the operation to \n get the next part of the results. Note that Secrets Manager might return fewer results than the maximum \n even when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

    " } }, - "IncludeDeprecated": { - "target": "com.amazonaws.secretsmanager#BooleanType", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    (Optional) Specifies that you want the results to include versions that do not have any\n staging labels attached to them. Such versions are considered deprecated and are subject to\n deletion by Secrets Manager as needed.

    " - } - }, "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { @@ -1011,24 +1004,19 @@ "traits": { "smithy.api#documentation": "

    (Optional) Use this parameter in a request if you receive a \n NextToken response in a previous request indicating there's more\n output available. In a subsequent call, set it to the value of the previous call \n NextToken response to indicate where the output should continue from.

    " } + }, + "IncludeDeprecated": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    (Optional) Specifies that you want the results to include versions that do not have any\n staging labels attached to them. Such versions are considered deprecated and are subject to\n deletion by Secrets Manager as needed.

    " + } } } }, "com.amazonaws.secretsmanager#ListSecretVersionIdsResponse": { "type": "structure", "members": { - "ARN": { - "target": "com.amazonaws.secretsmanager#SecretARNType", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the secret.

    \n \n

    Secrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.

    \n     " - } - }, - "Name": { - "target": "com.amazonaws.secretsmanager#SecretNameType", - "traits": { - "smithy.api#documentation": "

    The friendly name of the secret.

    " - } - }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { @@ -1040,6 +1028,18 @@ "traits": { "smithy.api#documentation": "

    The list of the currently available versions of the specified secret.

    " } + }, + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the secret.

    \n \n

    Secrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.

    \n     " + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

    The friendly name of the secret.

    " + } } } }, @@ -1074,12 +1074,6 @@ "com.amazonaws.secretsmanager#ListSecretsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.secretsmanager#FiltersListType", - "traits": { - "smithy.api#documentation": "

    Lists the secret request filters.

    " - } - }, "MaxResults": { "target": "com.amazonaws.secretsmanager#MaxResultsType", "traits": { @@ -1087,16 +1081,22 @@ "smithy.api#documentation": "

    (Optional) Limits the number of results you want to include in \n the response. If you don't include this parameter, it defaults to a value that's \n specific to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (isn't null). Include\n that value as the NextToken request parameter in the next call to the operation to \n get the next part of the results. Note that Secrets Manager might return fewer results than the maximum \n even when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

    " } }, + "SortOrder": { + "target": "com.amazonaws.secretsmanager#SortOrderType", + "traits": { + "smithy.api#documentation": "

    Lists secrets in the requested order.

    " + } + }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { "smithy.api#documentation": "

    (Optional) Use this parameter in a request if you receive a \n NextToken response in a previous request indicating there's more\n output available. In a subsequent call, set it to the value of the previous call \n NextToken response to indicate where the output should continue from.

    " } }, - "SortOrder": { - "target": "com.amazonaws.secretsmanager#SortOrderType", + "Filters": { + "target": "com.amazonaws.secretsmanager#FiltersListType", "traits": { - "smithy.api#documentation": "

    Lists secrets in the requested order.

    " + "smithy.api#documentation": "

    Lists the secret request filters.

    " } } } @@ -1104,17 +1104,17 @@ "com.amazonaws.secretsmanager#ListSecretsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.secretsmanager#NextTokenType", - "traits": { - "smithy.api#documentation": "

    If present in the response, this value indicates that \n there's more output available than included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a very long list. Use this value in the NextToken request parameter in a \n subsequent call to the operation to continue processing and get the next part of the output. You \n should repeat this until the NextToken response element comes back empty (as \n null).

    " - } - }, "SecretList": { "target": "com.amazonaws.secretsmanager#SecretListType", "traits": { "smithy.api#documentation": "

    A list of the secrets in the account.

    " } + }, + "NextToken": { + "target": "com.amazonaws.secretsmanager#NextTokenType", + "traits": { + "smithy.api#documentation": "

    If present in the response, this value indicates that \n there's more output available than included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a very long list. Use this value in the NextToken request parameter in a \n subsequent call to the operation to continue processing and get the next part of the output. You \n should repeat this until the NextToken response element comes back empty (as \n null).

    " + } } } }, @@ -1243,13 +1243,6 @@ "com.amazonaws.secretsmanager#PutResourcePolicyRequest": { "type": "structure", "members": { - "BlockPublicPolicy": { - "target": "com.amazonaws.secretsmanager#BooleanType", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.

    " - } - }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { @@ -1257,6 +1250,13 @@ "smithy.api#required": {} } }, + "BlockPublicPolicy": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.

    " + } + }, "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { @@ -1269,16 +1269,16 @@ "com.amazonaws.secretsmanager#PutResourcePolicyResponse": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.secretsmanager#NameType", + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

    The friendly name of the secret that the retrieved by the resource-based policy.

    " + "smithy.api#documentation": "

    The ARN of the secret retrieved by the resource-based policy.

    " } }, - "ARN": { - "target": "com.amazonaws.secretsmanager#SecretARNType", + "Name": { + "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "

    The ARN of the secret retrieved by the resource-based policy.

    " + "smithy.api#documentation": "

    The friendly name of the secret that the retrieved by the resource-based policy.

    " } } } @@ -1321,6 +1321,13 @@ "com.amazonaws.secretsmanager#PutSecretValueRequest": { "type": "structure", "members": { + "ClientRequestToken": { + "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", + "traits": { + "smithy.api#documentation": "

    (Optional) Specifies a unique identifier for the new version of the secret.

    \n \n

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request. If you don't use the SDK and instead generate a raw HTTP request to the\n Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself\n for new versions and include that value in the request.

    \n     \n

    This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during the Lambda rotation\n function's processing. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.

    \n
      \n
    • \n

      If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

      \n
      • \n
    • \n

      If a version with this value already exists and that version's\n SecretString or SecretBinary values are the same as those in\n the request then the request is ignored (the operation is idempotent).

      \n
      • \n
    • \n

      If a version with this value already exists and the version of the\n SecretString and SecretBinary values are different from those\n in the request then the request fails because you cannot modify an existing secret\n version. You can only create new versions to store new secret values.

      \n
      • \n
    \n

    This value becomes the VersionId of the new version.

    ", + "smithy.api#idempotencyToken": {} + } + }, "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { @@ -1328,23 +1335,16 @@ "smithy.api#required": {} } }, - "SecretBinary": { - "target": "com.amazonaws.secretsmanager#SecretBinaryType", - "traits": { - "smithy.api#documentation": "

    (Optional) Specifies binary data that you want to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then use the appropriate technique for your tool to pass the\n contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.

    \n \n

    This parameter is not accessible if the secret using the Secrets Manager console.

    \n

    " - } - }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { "smithy.api#documentation": "

    (Optional) Specifies text data that you want to encrypt and store in this new version of\n the secret. Either SecretString or SecretBinary must have a value,\n but not both. They cannot both be empty.

    \n \n

    If you create this secret by using the Secrets Manager console then Secrets Manager puts the\n protected secret text in only the SecretString parameter. The Secrets Manager console\n stores the information as a JSON structure of key/value pairs that the default Lambda rotation\n function knows how to parse.

    \n

    For storing multiple values, we recommend that you use a JSON text string argument and\n specify key/value pairs. For information on how to format a JSON parameter for the various\n command line tool environments, see Using JSON for\n Parameters in the AWS CLI User Guide.

    \n

    For example:

    \n

    \n [{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]\n

    \n

    If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.

    " } }, - "ClientRequestToken": { - "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", + "SecretBinary": { + "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { - "smithy.api#documentation": "

    (Optional) Specifies a unique identifier for the new version of the secret.

    \n \n

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request. If you don't use the SDK and instead generate a raw HTTP request to the\n Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself\n for new versions and include that value in the request.

    \n     \n

    This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during the Lambda rotation\n function's processing. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.

    \n
      \n
    • \n

      If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

      \n
      • \n
    • \n

      If a version with this value already exists and that version's\n SecretString or SecretBinary values are the same as those in\n the request then the request is ignored (the operation is idempotent).

      \n
      • \n
    • \n

      If a version with this value already exists and the version of the\n SecretString and SecretBinary values are different from those\n in the request then the request fails because you cannot modify an existing secret\n version. You can only create new versions to store new secret values.

      \n
      • \n
    \n

    This value becomes the VersionId of the new version.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    (Optional) Specifies binary data that you want to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then use the appropriate technique for your tool to pass the\n contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.

    \n \n

    This parameter is not accessible if the secret using the Secrets Manager console.

    \n

    " } }, "VersionStages": { @@ -1358,12 +1358,6 @@ "com.amazonaws.secretsmanager#PutSecretValueResponse": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.secretsmanager#SecretVersionIdType", - "traits": { - "smithy.api#documentation": "

    The unique identifier of the version of the secret you just created or updated.

    " - } - }, "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { @@ -1381,6 +1375,12 @@ "traits": { "smithy.api#documentation": "

    The friendly name of the secret for which you just created or updated a version.

    " } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

    The unique identifier of the version of the secret you just created or updated.

    " + } } } }, @@ -1508,6 +1508,13 @@ "com.amazonaws.secretsmanager#RotateSecretRequest": { "type": "structure", "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

    Specifies the secret that you want to rotate. You can specify either the Amazon Resource\n Name (ARN) or the friendly name of the secret.

    \n \n

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can \n specify a partial ARN too—for example, if you don’t include the final hyphen and six random \n characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN \n match can work as long as it uniquely matches only one secret. However, if your secret has a \n name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six \n characters to the ARN) and you try to use that as a partial ARN, then those characters cause \n Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected \n results. To avoid this situation, we recommend that you don’t create secret names ending \n with a hyphen followed by six characters.

    \n

    If you specify an incomplete ARN without the random suffix, and instead provide the \n 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, \n you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

    \n     ", + "smithy.api#required": {} + } + }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { @@ -1515,23 +1522,16 @@ "smithy.api#idempotencyToken": {} } }, - "RotationLambdaARN": { - "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", - "traits": { - "smithy.api#documentation": "

    (Optional) Specifies the ARN of the Lambda function that can rotate the secret.

    " - } - }, "RotationRules": { "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { "smithy.api#documentation": "

    A structure that defines the rotation configuration for this secret.

    " } }, - "SecretId": { - "target": "com.amazonaws.secretsmanager#SecretIdType", + "RotationLambdaARN": { + "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { - "smithy.api#documentation": "

    Specifies the secret that you want to rotate. You can specify either the Amazon Resource\n Name (ARN) or the friendly name of the secret.

    \n \n

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can \n specify a partial ARN too—for example, if you don’t include the final hyphen and six random \n characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN \n match can work as long as it uniquely matches only one secret. However, if your secret has a \n name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six \n characters to the ARN) and you try to use that as a partial ARN, then those characters cause \n Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected \n results. To avoid this situation, we recommend that you don’t create secret names ending \n with a hyphen followed by six characters.

    \n

    If you specify an incomplete ARN without the random suffix, and instead provide the \n 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, \n you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    (Optional) Specifies the ARN of the Lambda function that can rotate the secret.

    " } } } @@ -1539,10 +1539,10 @@ "com.amazonaws.secretsmanager#RotateSecretResponse": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

    The ID of the new version of the secret created by the rotation started by this\n request.

    " + "smithy.api#documentation": "

    The ARN of the secret.

    " } }, "Name": { @@ -1551,10 +1551,10 @@ "smithy.api#documentation": "

    The friendly name of the secret.

    " } }, - "ARN": { - "target": "com.amazonaws.secretsmanager#SecretARNType", + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

    The ARN of the secret.

    " + "smithy.api#documentation": "

    The ID of the new version of the secret created by the rotation started by this\n request.

    " } } } @@ -1617,95 +1617,95 @@ "com.amazonaws.secretsmanager#SecretListEntry": { "type": "structure", "members": { - "RotationLambdaARN": { - "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", + "LastRotatedDate": { + "target": "com.amazonaws.secretsmanager#LastRotatedDateType", "traits": { - "smithy.api#documentation": "

    The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and expire the\n secret either automatically per the schedule or manually by a call to RotateSecret.

    " + "smithy.api#documentation": "

    The last date and time that the rotation process for this secret was invoked.

    " } }, - "LastAccessedDate": { - "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "Description": { + "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { - "smithy.api#documentation": "

    The last date that this secret was accessed. This value is truncated to midnight of the\n date and therefore shows only the date, not the time.

    " + "smithy.api#documentation": "

    The user-provided description of the secret.

    " } }, - "Tags": { - "target": "com.amazonaws.secretsmanager#TagListType", + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

    The list of user-defined tags associated with the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.

    " + "smithy.api#documentation": "

    The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the\n SecretString and SecretBinary fields in each version of the\n secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with\n the default KMS CMK, the key named awssecretsmanager, for this account.

    " } }, - "OwningService": { - "target": "com.amazonaws.secretsmanager#OwningServiceType", + "SecretVersionsToStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", "traits": { - "smithy.api#documentation": "

    Returns the name of the service that created the secret.

    " + "smithy.api#documentation": "

    A list of all of the currently assigned SecretVersionStage staging labels and\n the SecretVersionId attached to each one. Staging labels are used to keep\n track of the different versions during the rotation process.

    \n \n

    A version that does not have any SecretVersionStage is considered\n deprecated and subject to deletion. Such versions are not included in this list.

    \n     " } }, - "RotationEnabled": { - "target": "com.amazonaws.secretsmanager#RotationEnabledType", + "CreatedDate": { + "target": "com.amazonaws.secretsmanager#TimestampType", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Indicates whether automatic, scheduled rotation is enabled for this secret.

    " + "smithy.api#documentation": "

    The date and time when a secret was created.

    " } }, - "KmsKeyId": { - "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "DeletedDate": { + "target": "com.amazonaws.secretsmanager#DeletedDateType", "traits": { - "smithy.api#documentation": "

    The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the\n SecretString and SecretBinary fields in each version of the\n secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with\n the default KMS CMK, the key named awssecretsmanager, for this account.

    " + "smithy.api#documentation": "

    The date and time the deletion of the secret occurred. Not present on active secrets. The\n secret can be recovered until the number of days in the recovery window has passed, as\n specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

    " } }, - "SecretVersionsToStages": { - "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

    A list of all of the currently assigned SecretVersionStage staging labels and\n the SecretVersionId attached to each one. Staging labels are used to keep\n track of the different versions during the rotation process.

    \n \n

    A version that does not have any SecretVersionStage is considered\n deprecated and subject to deletion. Such versions are not included in this list.

    \n     " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the secret.

    \n

    For more information about ARNs in Secrets Manager, see Policy Resources in the\n AWS Secrets Manager User Guide.

    " } }, - "LastChangedDate": { - "target": "com.amazonaws.secretsmanager#LastChangedDateType", + "OwningService": { + "target": "com.amazonaws.secretsmanager#OwningServiceType", "traits": { - "smithy.api#documentation": "

    The last date and time that this secret was modified in any way.

    " + "smithy.api#documentation": "

    Returns the name of the service that created the secret.

    " } }, - "RotationRules": { - "target": "com.amazonaws.secretsmanager#RotationRulesType", + "RotationLambdaARN": { + "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { - "smithy.api#documentation": "

    A structure that defines the rotation configuration for the secret.

    " + "smithy.api#documentation": "

    The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and expire the\n secret either automatically per the schedule or manually by a call to RotateSecret.

    " } }, - "Name": { - "target": "com.amazonaws.secretsmanager#SecretNameType", + "Tags": { + "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "

    The friendly name of the secret. You can use forward slashes in the name to represent a\n path hierarchy. For example, /prod/databases/dbserver1 could represent the secret\n for a server named dbserver1 in the folder databases in the folder\n prod.

    " + "smithy.api#documentation": "

    The list of user-defined tags associated with the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.

    " } }, - "Description": { - "target": "com.amazonaws.secretsmanager#DescriptionType", + "RotationEnabled": { + "target": "com.amazonaws.secretsmanager#RotationEnabledType", "traits": { - "smithy.api#documentation": "

    The user-provided description of the secret.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    Indicates whether automatic, scheduled rotation is enabled for this secret.

    " } }, - "ARN": { - "target": "com.amazonaws.secretsmanager#SecretARNType", + "LastAccessedDate": { + "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the secret.

    \n

    For more information about ARNs in Secrets Manager, see Policy Resources in the\n AWS Secrets Manager User Guide.

    " + "smithy.api#documentation": "

    The last date that this secret was accessed. This value is truncated to midnight of the\n date and therefore shows only the date, not the time.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.secretsmanager#TimestampType", + "LastChangedDate": { + "target": "com.amazonaws.secretsmanager#LastChangedDateType", "traits": { - "smithy.api#documentation": "

    The date and time when a secret was created.

    " + "smithy.api#documentation": "

    The last date and time that this secret was modified in any way.

    " } }, - "DeletedDate": { - "target": "com.amazonaws.secretsmanager#DeletedDateType", + "RotationRules": { + "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { - "smithy.api#documentation": "

    The date and time the deletion of the secret occurred. Not present on active secrets. The\n secret can be recovered until the number of days in the recovery window has passed, as\n specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

    " + "smithy.api#documentation": "

    A structure that defines the rotation configuration for the secret.

    " } }, - "LastRotatedDate": { - "target": "com.amazonaws.secretsmanager#LastRotatedDateType", + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

    The last date and time that the rotation process for this secret was invoked.

    " + "smithy.api#documentation": "

    The friendly name of the secret. You can use forward slashes in the name to represent a\n path hierarchy. For example, /prod/databases/dbserver1 could represent the secret\n for a server named dbserver1 in the folder databases in the folder\n prod.

    " } } }, @@ -1771,16 +1771,10 @@ "com.amazonaws.secretsmanager#SecretVersionsListEntry": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.secretsmanager#SecretVersionIdType", - "traits": { - "smithy.api#documentation": "

    The unique version identifier of this version of the secret.

    " - } - }, - "LastAccessedDate": { - "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "VersionStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { - "smithy.api#documentation": "

    The date that this version of the secret was last accessed. Note that the resolution of\n this field is at the date level and does not include the time.

    " + "smithy.api#documentation": "

    An array of staging labels that are currently associated with this version of the\n secret.

    " } }, "CreatedDate": { @@ -1789,10 +1783,16 @@ "smithy.api#documentation": "

    The date and time this version of the secret was created.

    " } }, - "VersionStages": { - "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

    An array of staging labels that are currently associated with this version of the\n secret.

    " + "smithy.api#documentation": "

    The unique version identifier of this version of the secret.

    " + } + }, + "LastAccessedDate": { + "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "traits": { + "smithy.api#documentation": "

    The date that this version of the secret was last accessed. Note that the resolution of\n this field is at the date level and does not include the time.

    " } } }, @@ -2011,12 +2011,6 @@ "com.amazonaws.secretsmanager#UpdateSecretRequest": { "type": "structure", "members": { - "SecretBinary": { - "target": "com.amazonaws.secretsmanager#SecretBinaryType", - "traits": { - "smithy.api#documentation": "

    (Optional) Specifies updated binary data that you want to encrypt and store in the new\n version of the secret. To use this parameter in the command-line tools, we recommend that you\n store your binary data in a file and then use the appropriate technique for your tool to pass\n the contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.

    \n

    This parameter is not accessible using the Secrets Manager console.

    " - } - }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { @@ -2029,12 +2023,6 @@ "smithy.api#documentation": "

    (Optional) Specifies an updated ARN or alias of the AWS KMS customer master key (CMK) to be\n used to encrypt the protected text in new versions of this secret.

    \n \n

    You can only use the account's default CMK to encrypt and decrypt if you call this\n operation using credentials from the same account that owns the secret. If the secret is in\n a different account, then you must create a custom CMK and provide the ARN of that CMK in\n this field. The user making the call must have permissions to both the secret and the CMK in\n their respective accounts.

    \n     " } }, - "Description": { - "target": "com.amazonaws.secretsmanager#DescriptionType", - "traits": { - "smithy.api#documentation": "

    (Optional) Specifies an updated user-provided description of the secret.

    " - } - }, "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { @@ -2042,22 +2030,34 @@ "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.secretsmanager#DescriptionType", + "traits": { + "smithy.api#documentation": "

    (Optional) Specifies an updated user-provided description of the secret.

    " + } + }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { "smithy.api#documentation": "

    (Optional) If you want to add a new version to the secret, this parameter specifies a\n unique identifier for the new version that helps ensure idempotency.

    \n

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager\n service endpoint, then you must generate a ClientRequestToken yourself for new\n versions and include that value in the request.

    \n

    You typically only need to interact with this value if you implement your own retry logic\n and want to ensure that a given secret is not created twice. We recommend that you generate a\n UUID-type\n value to ensure uniqueness within the specified secret.

    \n

    Secrets Manager uses this value to prevent the accidental creation of duplicate versions if\n there are failures and retries during the Lambda rotation function's processing.

    \n
      \n
    • \n

      If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

      \n
      • \n
    • \n

      If a version with this value already exists and that version's\n SecretString and SecretBinary values are the same as those in\n the request then the request is ignored (the operation is idempotent).

      \n
      • \n
    • \n

      If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from the\n request then an error occurs because you cannot modify an existing secret value.

      \n
      • \n
    \n

    This value becomes the VersionId of the new version.

    ", "smithy.api#idempotencyToken": {} } + }, + "SecretBinary": { + "target": "com.amazonaws.secretsmanager#SecretBinaryType", + "traits": { + "smithy.api#documentation": "

    (Optional) Specifies updated binary data that you want to encrypt and store in the new\n version of the secret. To use this parameter in the command-line tools, we recommend that you\n store your binary data in a file and then use the appropriate technique for your tool to pass\n the contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.

    \n

    This parameter is not accessible using the Secrets Manager console.

    " + } } } }, "com.amazonaws.secretsmanager#UpdateSecretResponse": { "type": "structure", "members": { - "ARN": { - "target": "com.amazonaws.secretsmanager#SecretARNType", + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

    The ARN of the secret that was updated.

    \n \n

    Secrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.

    \n     " + "smithy.api#documentation": "

    The friendly name of the secret that was updated.

    " } }, "VersionId": { @@ -2066,10 +2066,10 @@ "smithy.api#documentation": "

    If a new version of the secret was created by this operation, then VersionId\n contains the unique identifier of the new version.

    " } }, - "Name": { - "target": "com.amazonaws.secretsmanager#SecretNameType", + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

    The friendly name of the secret that was updated.

    " + "smithy.api#documentation": "

    The ARN of the secret that was updated.

    \n \n

    Secrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.

    \n     " } } } @@ -2183,52 +2183,52 @@ "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest": { "type": "structure", "members": { - "SecretId": { - "target": "com.amazonaws.secretsmanager#SecretIdType", - "traits": { - "smithy.api#documentation": "

    The identifier for the secret that you want to validate a resource policy. You can specify either\n the Amazon Resource Name (ARN) or the friendly name of the secret.

    \n \n

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can \n specify a partial ARN too—for example, if you don’t include the final hyphen and six random \n characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN \n match can work as long as it uniquely matches only one secret. However, if your secret has a \n name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six \n characters to the ARN) and you try to use that as a partial ARN, then those characters cause \n Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected \n results. To avoid this situation, we recommend that you don’t create secret names ending \n with a hyphen followed by six characters.

    \n

    If you specify an incomplete ARN without the random suffix, and instead provide the \n 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, \n you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

    \n     " - } - }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { "smithy.api#documentation": "

    Identifies the Resource Policy attached to the secret.

    ", "smithy.api#required": {} } + }, + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

    The identifier for the secret that you want to validate a resource policy. You can specify either\n the Amazon Resource Name (ARN) or the friendly name of the secret.

    \n \n

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can \n specify a partial ARN too—for example, if you don’t include the final hyphen and six random \n characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN \n match can work as long as it uniquely matches only one secret. However, if your secret has a \n name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six \n characters to the ARN) and you try to use that as a partial ARN, then those characters cause \n Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected \n results. To avoid this situation, we recommend that you don’t create secret names ending \n with a hyphen followed by six characters.

    \n

    If you specify an incomplete ARN without the random suffix, and instead provide the \n 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, \n you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

    \n     " + } } } }, "com.amazonaws.secretsmanager#ValidateResourcePolicyResponse": { "type": "structure", "members": { - "PolicyValidationPassed": { - "target": "com.amazonaws.secretsmanager#BooleanType", - "traits": { - "smithy.api#documentation": "

    Returns a message stating that your Reource Policy passed validation.

    " - } - }, "ValidationErrors": { "target": "com.amazonaws.secretsmanager#ValidationErrorsType", "traits": { "smithy.api#documentation": "

    Returns an error message if your policy doesn't pass validatation.

    " } + }, + "PolicyValidationPassed": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#documentation": "

    Returns a message stating that your Reource Policy passed validation.

    " + } } } }, "com.amazonaws.secretsmanager#ValidationErrorsEntry": { "type": "structure", "members": { - "CheckName": { - "target": "com.amazonaws.secretsmanager#NameType", - "traits": { - "smithy.api#documentation": "

    Checks the name of the policy.

    " - } - }, "ErrorMessage": { "target": "com.amazonaws.secretsmanager#ErrorMessage", "traits": { "smithy.api#documentation": "

    Displays error messages if validation encounters problems during validation of the resource policy.

    " } + }, + "CheckName": { + "target": "com.amazonaws.secretsmanager#NameType", + "traits": { + "smithy.api#documentation": "

    Checks the name of the policy.

    " + } } }, "traits": { @@ -2308,7 +2308,7 @@ "sdkId": "Secrets Manager", "arnNamespace": "secretsmanager", "cloudFormationName": "SecretsManager", - "cloudTrailEventSource": "AWSMimirService.amazon.com" + "cloudTrailEventSource": "secretsmanager.amazonaws.com" }, "aws.auth#sigv4": { "name": "secretsmanager" 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 62b1a81ad564..09ff637122cf 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json +++ b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json @@ -89,10 +89,10 @@ "com.amazonaws.securityhub#AccessDeniedException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.securityhub#NonEmptyString" }, - "Message": { + "Code": { "target": "com.amazonaws.securityhub#NonEmptyString" } }, @@ -105,17 +105,17 @@ "com.amazonaws.securityhub#AccountDetails": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.securityhub#AccountId", - "traits": { - "smithy.api#documentation": "

    The ID of an AWS account.

    " - } - }, "Email": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#documentation": "

    The email of an AWS account.

    " } + }, + "AccountId": { + "target": "com.amazonaws.securityhub#AccountId", + "traits": { + "smithy.api#documentation": "

    The ID of an AWS account.

    " + } } }, "traits": { @@ -140,10 +140,10 @@ "com.amazonaws.securityhub#ActionTarget": { "type": "structure", "members": { - "ActionTargetArn": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN for the target action.

    ", + "smithy.api#documentation": "

    The name of the action target.

    ", "smithy.api#required": {} } }, @@ -154,10 +154,10 @@ "smithy.api#required": {} } }, - "Name": { + "ActionTargetArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the action target.

    ", + "smithy.api#documentation": "

    The ARN for the target action.

    ", "smithy.api#required": {} } } @@ -181,16 +181,16 @@ "com.amazonaws.securityhub#AvailabilityZone": { "type": "structure", "members": { - "SubnetId": { + "ZoneName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the subnet. You can specify one subnet per Availability Zone.

    " + "smithy.api#documentation": "

    The name of the Availability Zone.

    " } }, - "ZoneName": { + "SubnetId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the Availability Zone.

    " + "smithy.api#documentation": "

    The ID of the subnet. You can specify one subnet per Availability Zone.

    " } } }, @@ -204,1709 +204,6339 @@ "target": "com.amazonaws.securityhub#AvailabilityZone" } }, - "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails": { + "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings": { "type": "structure", "members": { - "HealthCheckGracePeriod": { - "target": "com.amazonaws.securityhub#Integer", + "DestinationArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the\n health status of an EC2 instance that has come into service.

    " + "smithy.api#documentation": "

    The ARN of the CloudWatch Logs log group that receives the access logs.

    " } }, - "HealthCheckType": { + "Format": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The service to use for the health checks.

    " + "smithy.api#documentation": "

    A single-line format of the access logs of data, as specified by selected\n $context variables. The format must include at least\n $context.requestId.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about settings for logging access for the stage.

    " + } + }, + "com.amazonaws.securityhub#AwsApiGatewayCanarySettings": { + "type": "structure", + "members": { + "DeploymentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The deployment identifier for the canary deployment.

    " } }, - "LoadBalancerNames": { - "target": "com.amazonaws.securityhub#StringList", + "PercentTraffic": { + "target": "com.amazonaws.securityhub#Double", "traits": { - "smithy.api#documentation": "

    The list of load balancers associated with the group.

    " + "smithy.api#documentation": "

    The percentage of traffic that is diverted to a canary deployment.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "UseStageCache": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    The datetime when the auto scaling group was created.

    " + "smithy.api#documentation": "

    Indicates whether the canary deployment uses the stage cache.

    " } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "StageVariableOverrides": { + "target": "com.amazonaws.securityhub#FieldMap", "traits": { - "smithy.api#documentation": "

    The name of the launch configuration.

    " + "smithy.api#documentation": "

    Stage variables that are overridden in the canary release deployment. The variables\n include new stage variables that are introduced in the canary.

    \n

    Each variable is represented as a string-to-string map between the stage variable name\n and the variable value.

    " } } }, "traits": { - "smithy.api#documentation": "

    Provides details about an auto scaling group.

    " + "smithy.api#documentation": "

    Contains information about settings for canary deployment in the stage.

    " } }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails": { + "com.amazonaws.securityhub#AwsApiGatewayEndpointConfiguration": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Types": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

    The date and time that the distribution was last modified.

    " + "smithy.api#documentation": "

    A list of endpoint types for the REST API.

    \n

    For an edge-optimized API, the endpoint type is EDGE. For a Regional API,\n the endpoint type is REGIONAL. For a private API, the endpoint type is\n PRIVATE.

    " } - }, - "WebAclId": { + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the endpoints for the API.

    " + } + }, + "com.amazonaws.securityhub#AwsApiGatewayMethodSettings": { + "type": "structure", + "members": { + "HttpMethod": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

    " + "smithy.api#documentation": "

    The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to\n multiple methods.

    " } }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "RequireAuthorizationForCacheControl": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    The domain name corresponding to the distribution.

    " + "smithy.api#documentation": "

    Indicates whether authorization is required for a cache invalidation request.

    " } }, - "ETag": { + "ResourcePath": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The entity tag is a hash of the object.

    " + "smithy.api#documentation": "

    The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial\n slash must include a forward slash.

    \n

    For example, the path value /resource/subresource must be encoded as\n /~1resource~1subresource.

    \n

    To specify the root path, use only a slash (/). You can use an asterisk (*) as a\n wildcard to apply method settings to multiple methods.

    " } }, - "Status": { + "LoggingLevel": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Indicates the current status of the distribution.

    " + "smithy.api#documentation": "

    The logging level for this method. The logging level affects the log entries that are\n pushed to CloudWatch Logs.

    \n

    If the logging level is ERROR, then the logs only include error-level\n entries.

    \n

    If the logging level is INFO, then the logs include both ERROR\n events and extra informational events.

    \n

    Valid values: OFF | ERROR | INFO\n

    " } }, - "Logging": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging", + "CachingEnabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    A complex type that controls whether access logs are written for the distribution.

    " + "smithy.api#documentation": "

    Indicates whether responses are cached and returned for requests. For responses to be\n cached, a cache cluster must be enabled on the stage.

    " } }, - "Origins": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins", - "traits": { - "smithy.api#documentation": "

    A complex type that contains information about origins for this distribution.

    " - } - } - }, - "traits": { - "smithy.api#documentation": "

    A distribution configuration.

    " - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging": { - "type": "structure", - "members": { - "Enabled": { + "DataTraceEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    With this field, you can enable or disable the selected distribution.

    " + "smithy.api#documentation": "

    Indicates whether data trace logging is enabled for the method. Data trace logging\n affects the log entries that are pushed to CloudWatch Logs.

    " } }, - "Prefix": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ThrottlingBurstLimit": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    An optional string that you want CloudFront to use as a prefix to the access log\n filenames for this distribution.

    " + "smithy.api#documentation": "

    The throttling burst limit for the method.

    " } }, - "IncludeCookies": { - "target": "com.amazonaws.securityhub#Boolean", + "ThrottlingRateLimit": { + "target": "com.amazonaws.securityhub#Double", "traits": { - "smithy.api#documentation": "

    Specifies whether you want CloudFront to include cookies in access logs.

    " + "smithy.api#documentation": "

    The throttling rate limit for the method.

    " } }, - "Bucket": { + "UnauthorizedCacheControlHeaderStrategy": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The Amazon S3 bucket to store the access logs in.

    " + "smithy.api#documentation": "

    Indicates how to handle unauthorized requests for cache invalidation.

    \n

    Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER |\n SUCCEED_WITHOUT_RESPONSE_HEADER\n

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    A complex type that controls whether access logs are written for the distribution.

    " - } - }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", + }, + "CacheDataEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    A unique identifier for the origin or origin group.

    " + "smithy.api#documentation": "

    Indicates whether the cached responses are encrypted.

    " } }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "MetricsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin.

    " + "smithy.api#documentation": "

    Indicates whether CloudWatch metrics are enabled for the method.

    " } }, - "OriginPath": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "CacheTtlInSeconds": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.

    " + "smithy.api#documentation": "

    Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL,\n the longer the response is cached.

    " } } }, "traits": { - "smithy.api#documentation": "

    A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web\n server), Amazon Elemental MediaStore, or other server from which CloudFront gets your\n files.

    " + "smithy.api#documentation": "

    Defines settings for a method for the stage.

    " } }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList": { + "com.amazonaws.securityhub#AwsApiGatewayMethodSettingsList": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem" + "target": "com.amazonaws.securityhub#AwsApiGatewayMethodSettings" } }, - "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins": { + "com.amazonaws.securityhub#AwsApiGatewayRestApiDetails": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList", + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A complex type that contains origins or origin groups for this distribution.

    " + "smithy.api#documentation": "

    A description of the REST API.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    A complex type that contains information about origins and origin groups for this distribution.

    " - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectDetails": { - "type": "structure", - "members": { - "Environment": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment", + }, + "BinaryMediaTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

    Information about the build environment for this build project.

    " + "smithy.api#documentation": "

    The list of binary media types supported by the REST API.

    " } }, - "Name": { + "ApiKeySource": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the build project.

    " + "smithy.api#documentation": "

    The source of the API key for metering requests according to a usage plan.

    \n

    \n HEADER indicates whether to read the API key from the X-API-Key header of a\n request.

    \n

    \n AUTHORIZER indicates whether to read the API key from the\n UsageIdentifierKey from a custom authorizer.

    " } }, - "Source": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectSource", + "MinimumCompressionSize": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    Information about the build input source code for this build project.

    " + "smithy.api#documentation": "

    The minimum size in bytes of a payload before compression is enabled.

    \n

    If null, then compression is disabled.

    \n

    If 0, then all payloads are compressed.

    " } }, - "ServiceRole": { + "Id": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS\n services on behalf of the AWS account.

    " + "smithy.api#documentation": "

    The identifier of the REST API.

    " } }, - "EncryptionKey": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the\n build output artifacts.

    \n

    You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the\n CMK alias (using the format alias/alias-name).

    " + "smithy.api#documentation": "

    The name of the REST API.

    " } }, - "VpcConfig": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig", + "EndpointConfiguration": { + "target": "com.amazonaws.securityhub#AwsApiGatewayEndpointConfiguration", "traits": { - "smithy.api#documentation": "

    Information about the VPC configuration that AWS CodeBuild accesses.

    " + "smithy.api#documentation": "

    The endpoint configuration of the REST API.

    " + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version identifier for the REST API.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the API was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } } }, "traits": { - "smithy.api#documentation": "

    Information about an AWS CodeBuild project.

    " + "smithy.api#documentation": "

    contains information about a REST API in version 1 of Amazon API Gateway.

    " } }, - "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment": { + "com.amazonaws.securityhub#AwsApiGatewayStageDetails": { "type": "structure", "members": { - "Certificate": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "MethodSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayMethodSettingsList", "traits": { - "smithy.api#documentation": "

    The certificate to use with this build project.

    " + "smithy.api#documentation": "

    Defines the method settings for the stage.

    " } }, - "RegistryCredential": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential", + "CanarySettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayCanarySettings", "traits": { - "smithy.api#documentation": "

    The credentials for access to a private registry.

    " + "smithy.api#documentation": "

    Information about settings for canary deployment in the stage.

    " } }, - "ImagePullCredentialsType": { + "CacheClusterStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of credentials AWS CodeBuild uses to pull images in your build.

    \n

    Valid values:

    \n
      \n
    • \n

      \n CODEBUILD specifies that AWS CodeBuild uses its own credentials. This\n requires that you modify your ECR repository policy to trust the AWS CodeBuild\n service principal.

      \n
      • \n
    • \n

      \n SERVICE_ROLE specifies that AWS CodeBuild uses your build project's\n service role.

      \n
      • \n
    \n

    When you use a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you\n must use CODEBUILD credentials.

    " + "smithy.api#documentation": "

    If a cache cluster is enabled, the status of the cache cluster.

    " } }, - "Type": { + "CreatedDate": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of build environment to use for related builds.

    \n

    The environment type ARM_CONTAINER is available only in Regions US East (N.\n Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia\n Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

    \n

    The environment type LINUX_CONTAINER with compute type\n build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N.\n Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe\n (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia\n Pacific (Sydney), China (Beijing), and China (Ningxia).

    \n

    The environment type LINUX_GPU_CONTAINER is available only in Regions US\n East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe\n (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China\n (Ningxia).

    \n

    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER |\n LINUX_GPU_CONTAINER | ARM_CONTAINER\n

    " + "smithy.api#documentation": "

    Indicates when the stage was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Information about the build environment for this build project.

    " - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential": { - "type": "structure", - "members": { - "CredentialProvider": { + }, + "LastUpdatedDate": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The service that created the credentials to access a private Docker registry.

    \n

    The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.

    " + "smithy.api#documentation": "

    Indicates when the stage was most recently updated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "Credential": { + "WebAclArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets\n Manager.

    \n \n

    The credential can use the name of the credentials only if they exist in your current\n AWS Region.

    \n     " + "smithy.api#documentation": "

    The ARN of the web ACL associated with the stage.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    The credentials for access to a private registry.

    " - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectSource": { - "type": "structure", - "members": { - "Location": { + }, + "StageName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Information about the location of the source code to be built.

    \n

    Valid values include:

    \n
      \n
    • \n

      For source code settings that are specified in the source action of a pipeline in\n AWS CodePipeline, location should not be specified. If it is specified, AWS\n CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a\n pipeline's source action instead of this value.

      \n
      • \n
    • \n

      For source code in an AWS CodeCommit repository, the HTTPS clone URL to the\n repository that contains the source code and the build spec file (for example,\n https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name\n ).

      \n
      • \n
    • \n

      For source code in an S3 input bucket, one of the following.

      \n
        \n
      • \n

        The path to the ZIP file that contains the source code (for example,\n bucket-name/path/to/object-name.zip).

        \n
        • \n
      • \n

        The path to the folder that contains the source code (for example,\n bucket-name/path/to/source-code/folder/).

        \n
        • \n
      \n
      • \n
    • \n

      For source code in a GitHub repository, the HTTPS clone URL to the repository that\n contains the source and the build spec file.

      \n
      • \n
    • \n

      For source code in a Bitbucket repository, the HTTPS clone URL to the repository\n that contains the source and the build spec file.

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the stage.

    " } }, - "GitCloneDepth": { - "target": "com.amazonaws.securityhub#Integer", + "CacheClusterSize": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Information about the Git clone depth for the build project.

    " + "smithy.api#documentation": "

    If a cache cluster is enabled, the size of the cache cluster.

    " } }, - "Type": { + "AccessLogSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings", + "traits": { + "smithy.api#documentation": "

    Settings for logging access for the stage.

    " + } + }, + "DocumentationVersion": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of repository that contains the source code to be built. Valid values\n are:

    \n
      \n
    • \n

      \n BITBUCKET - The source code is in a Bitbucket repository.

      \n
      • \n
    • \n

      \n CODECOMMIT - The source code is in an AWS CodeCommit\n repository.

      \n
      • \n
    • \n

      \n CODEPIPELINE - The source code settings are specified in the source\n action of a pipeline in AWS CodePipeline.

      \n
      • \n
    • \n

      \n GITHUB - The source code is in a GitHub repository.

      \n
      • \n
    • \n

      \n GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise\n repository.

      \n
      • \n
    • \n

      \n NO_SOURCE - The project does not have input source code.

      \n
      • \n
    • \n

      \n S3 - The source code is in an S3 input bucket.

      \n
      • \n
    " + "smithy.api#documentation": "

    The version of the API documentation that is associated with the stage.

    " } }, - "InsecureSsl": { + "TracingEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    Whether to ignore SSL warnings while connecting to the project source code.

    " + "smithy.api#documentation": "

    Indicates whether active tracing with AWS X-Ray is enabled for the stage.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Information about the build input source code for this build project.

    " - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig": { - "type": "structure", - "members": { - "Subnets": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + }, + "DeploymentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A list of one or more subnet IDs in your Amazon VPC.

    " + "smithy.api#documentation": "

    The identifier of the deployment that the stage points to.

    " } }, - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A list of one or more security group IDs in your Amazon VPC.

    " + "smithy.api#documentation": "

    A description of the stage.

    " } }, - "VpcId": { + "ClientCertificateId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the VPC.

    " + "smithy.api#documentation": "

    The identifier of the client certificate for the stage.

    " } - } + }, + "CacheClusterEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether a cache cluster is enabled for the stage.

    " + } + }, + "Variables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

    A map that defines the stage variables for the stage.

    \n

    Variable names can have alphanumeric and underscore characters.

    \n

    Variable values can contain the following characters:

    \n
      \n
    • \n

      Uppercase and lowercase letters

      \n
      • \n
    • \n

      Numbers

      \n
      • \n
    • \n

      Special characters -._~:/?#&=,

      \n
      • \n
    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about a version 1 Amazon API Gateway stage.

    " + } + }, + "com.amazonaws.securityhub#AwsApiGatewayV2ApiDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the API.

    " + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version identifier for the API.

    " + } + }, + "CorsConfiguration": { + "target": "com.amazonaws.securityhub#AwsCorsConfiguration", + "traits": { + "smithy.api#documentation": "

    A cross-origin resource sharing (CORS) configuration. Supported only for HTTP\n APIs.

    " + } + }, + "RouteSelectionExpression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The route selection expression for the API.

    \n

    For HTTP APIs, must be ${request.method} ${request.path}. This is the\n default value for HTTP APIs.

    \n

    For WebSocket APIs, there is no default value.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the API was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "ApiEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The URI of the API.

    \n

    Uses the format\n \n .execute-api..amazonaws.com\n

    \n

    The stage name is typically appended to the URI to form a complete path to a deployed\n API stage.

    " + } + }, + "ApiKeySelectionExpression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    An API key selection expression. Supported only for WebSocket APIs.

    " + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A description of the API.

    " + } + }, + "ProtocolType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The API protocol for the API.

    \n

    Valid values: WEBSOCKET | HTTP\n

    " + } + }, + "ApiId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the API.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about a version 2 API in Amazon API Gateway.

    " + } + }, + "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings": { + "type": "structure", + "members": { + "ThrottlingRateLimit": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#documentation": "

    The throttling rate limit.

    " + } + }, + "DataTraceEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether data trace logging is enabled. Data trace logging affects the log\n entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.

    " + } + }, + "DetailedMetricsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether detailed metrics are enabled.

    " + } + }, + "ThrottlingBurstLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The throttling burst limit.

    " + } + }, + "LoggingLevel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The logging level. The logging level affects the log entries that are pushed to\n CloudWatch Logs. Supported only for WebSocket APIs.

    \n

    If the logging level is ERROR, then the logs only include error-level\n entries.

    \n

    If the logging level is INFO, then the logs include both ERROR\n events and extra informational events.

    \n

    Valid values: OFF | ERROR | INFO\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains route settings for a stage.

    " + } + }, + "com.amazonaws.securityhub#AwsApiGatewayV2StageDetails": { + "type": "structure", + "members": { + "LastUpdatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the stage was most recently updated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "DeploymentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the deployment that the stage is associated with.

    " + } + }, + "ApiGatewayManaged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the stage is managed by API Gateway.

    " + } + }, + "RouteSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings", + "traits": { + "smithy.api#documentation": "

    The route settings for the stage.

    " + } + }, + "LastDeploymentStatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the last deployment of a stage. Supported only if the stage has automatic\n deployment enabled.

    " + } + }, + "StageVariables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

    A map that defines the stage variables for the stage.

    \n

    Variable names can have alphanumeric and underscore characters.

    \n

    Variable values can contain the following characters:

    \n
      \n
    • \n

      Uppercase and lowercase letters

      \n
      • \n
    • \n

      Numbers

      \n
      • \n
    • \n

      Special characters -._~:/?#&=,

      \n
      • \n
    " + } + }, + "StageName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the stage.

    " + } + }, + "AccessLogSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayAccessLogSettings", + "traits": { + "smithy.api#documentation": "

    Information about settings for logging access for the stage.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the stage was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "DefaultRouteSettings": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2RouteSettings", + "traits": { + "smithy.api#documentation": "

    Default route settings for the stage.

    " + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The description of the stage.

    " + } + }, + "AutoDeploy": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether updates to an API automatically trigger a new deployment.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about a version 2 stage for Amazon API Gateway.

    " + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails": { + "type": "structure", + "members": { + "HealthCheckGracePeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the\n health status of an EC2 instance that has come into service.

    " + } + }, + "LoadBalancerNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The list of load balancers associated with the group.

    " + } + }, + "LaunchConfigurationName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the launch configuration.

    " + } + }, + "CreatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the auto scaling group was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "HealthCheckType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The service to use for the health checks.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides details about an auto scaling group.

    " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails": { + "type": "structure", + "members": { + "KeyAlgorithm": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The algorithm that was used to generate the public-private key pair.

    \n

    Valid values: RSA_2048 | RSA_1024 | RSA_4096 |\n EC_prime256v1 | EC_secp384r1 |\n EC_secp521r1\n

    " + } + }, + "CertificateAuthorityArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the private certificate authority (CA) that will be used to issue the\n certificate.

    " + } + }, + "ImportedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the certificate was imported. Provided if the certificate type is\n IMPORTED.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The source of the certificate. For certificates that AWS Certificate Manager provides,\n Type is AMAZON_ISSUED. For certificates that are imported with\n ImportCertificate, Type is IMPORTED.

    \n

    Valid values: IMPORTED | AMAZON_ISSUED |\n PRIVATE\n

    " + } + }, + "RenewalSummary": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateRenewalSummary", + "traits": { + "smithy.api#documentation": "

    Information about the status of the AWS Certificate Manager managed renewal for the\n certificate. Provided only when the certificate type is AMAZON_ISSUED.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    For a failed certificate request, the reason for the failure.

    \n

    Valid values: NO_AVAILABLE_CONTACTS |\n ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED |\n INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED |\n CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN\n | PCA_INVALID_STATE | PCA_REQUEST_FAILED |\n PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND |\n PCA_INVALID_ARGS | PCA_INVALID_DURATION |\n PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER\n

    " + } + }, + "KeyUsages": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsages", + "traits": { + "smithy.api#documentation": "

    A list of key usage X.509 v3 extension objects.

    " + } + }, + "SubjectAlternativeNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    One or more domain names (subject alternative names) included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate.

    \n

    The subject alternative names include the canonical domain name (CN) of the certificate\n and additional domain names that can be used to connect to the website.

    " + } + }, + "DomainValidationOptions": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions", + "traits": { + "smithy.api#documentation": "

    Contains information about the initial validation of each domain name that occurs as a\n result of the RequestCertificate request.

    \n

    Only provided if the certificate type is AMAZON_ISSUED.

    " + } + }, + "InUseBy": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The list of ARNs for the AWS resources that use the certificate.

    " + } + }, + "Serial": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The serial number of the certificate.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The fully qualified domain name (FQDN), such as www.example.com, that is secured by the\n certificate.

    " + } + }, + "IssuedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the certificate was issued. Provided if the certificate type is\n AMAZON_ISSUED.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Options": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateOptions", + "traits": { + "smithy.api#documentation": "

    Provides a value that specifies whether to add the certificate to a transparency\n log.

    " + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the certificate was requested.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "NotBefore": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The time before which the certificate is not valid.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Issuer": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the certificate authority that issued and signed the certificate.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the certificate.

    \n

    Valid values: PENDING_VALIDATION | ISSUED |\n INACTIVE | EXPIRED | VALIDATION_TIMED_OUT |\n REVOKED | FAILED\n

    " + } + }, + "SignatureAlgorithm": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The algorithm that was used to sign the certificate.

    " + } + }, + "Subject": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the entity that is associated with the public key contained in the\n certificate.

    " + } + }, + "RenewalEligibility": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Whether the certificate is eligible for renewal.

    \n

    Valid values: ELIGIBLE | INELIGIBLE\n

    " + } + }, + "NotAfter": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The time after which the certificate becomes invalid.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "ExtendedKeyUsages": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsages", + "traits": { + "smithy.api#documentation": "

    Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies\n a purpose for which the certificate public key can be used and consists of a name and an\n object identifier (OID).

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides details about an AWS Certificate Manager certificate.

    " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOption": { + "type": "structure", + "members": { + "ValidationStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The validation status of the domain name.

    " + } + }, + "ResourceRecord": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateResourceRecord", + "traits": { + "smithy.api#documentation": "

    The CNAME record that is added to the DNS database for domain validation.

    " + } + }, + "ValidationEmails": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of email addresses that AWS Certificate Manager uses to send domain validation\n emails.

    " + } + }, + "ValidationDomain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The domain name that AWS Certificate Manager uses to send domain validation\n emails.

    " + } + }, + "ValidationMethod": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The method used to validate the domain name.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A fully qualified domain name (FQDN) in the certificate.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about one of the following:

    \n
      \n
    • \n

      The initial validation of each domain name that occurs as a result of the\n RequestCertificate request

      \n
      • \n
    • \n

      The validation of each domain name in the certificate, as it pertains to AWS\n Certificate Manager managed renewal

      \n
      • \n
    " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOption" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsage": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of an extension value. Indicates the purpose for which the certificate public\n key can be used.

    " + } + }, + "OId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    An object identifier (OID) for the extension value.

    \n

    The format is numbers separated by periods.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about an extended key usage X.509 v3 extension object.

    " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsages": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateExtendedKeyUsage" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsage": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The key usage extension name.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about a key usage X.509 v3 extension object.

    " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsages": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateKeyUsage" + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateOptions": { + "type": "structure", + "members": { + "CertificateTransparencyLoggingPreference": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Whether to add the certificate to a transparency log.

    \n

    Valid values: DISABLED | ENABLED\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains other options for the certificate.

    " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateRenewalSummary": { + "type": "structure", + "members": { + "RenewalStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the AWS Certificate Manager managed renewal of the certificate.

    \n

    Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION |\n SUCCESS | FAILED\n

    " + } + }, + "DomainValidationOptions": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDomainValidationOptions", + "traits": { + "smithy.api#documentation": "

    Information about the validation of each domain name in the certificate, as it pertains\n to AWS Certificate Manager managed renewal. Provided only when the certificate type is\n AMAZON_ISSUED.

    " + } + }, + "RenewalStatusReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The reason that a renewal request was unsuccessful.

    \n

    Valid values: NO_AVAILABLE_CONTACTS |\n ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED |\n INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED |\n CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN\n | PCA_INVALID_STATE | PCA_REQUEST_FAILED |\n PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND |\n PCA_INVALID_ARGS | PCA_INVALID_DURATION |\n PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER\n

    " + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the renewal summary was last updated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the AWS Certificate Manager managed renewal for an\n AMAZON_ISSUED certificate.

    " + } + }, + "com.amazonaws.securityhub#AwsCertificateManagerCertificateResourceRecord": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of resource.

    " + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The value of the resource.

    " + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the resource.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides details about the CNAME record that is added to the DNS database for domain\n validation.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehavior": { + "type": "structure", + "members": { + "ViewerProtocolPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The protocol that viewers can use to access the files in an origin. You can specify the\n following options:

    \n
      \n
    • \n

      \n allow-all - Viewers can use HTTP or HTTPS.

      \n
      • \n
    • \n

      \n redirect-to-https - CloudFront responds to HTTP requests with an HTTP\n status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the\n new URL to resubmit.

      \n
      • \n
    • \n

      \n https-only - CloudFront responds to HTTP request with an HTTP status\n code of 403 (Forbidden).

      \n
      • \n
    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a cache behavior for the distribution.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviors": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviorsItemList", + "traits": { + "smithy.api#documentation": "

    The cache behaviors for the distribution.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about caching for the distribution.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviorsItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehavior" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionDefaultCacheBehavior": { + "type": "structure", + "members": { + "ViewerProtocolPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The protocol that viewers can use to access the files in an origin. You can specify the\n following options:

    \n
      \n
    • \n

      \n allow-all - Viewers can use HTTP or HTTPS.

      \n
      • \n
    • \n

      \n redirect-to-https - CloudFront responds to HTTP requests with an HTTP\n status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the\n new URL to resubmit.

      \n
      • \n
    • \n

      \n https-only - CloudFront responds to HTTP request with an HTTP status\n code of 403 (Forbidden).

      \n
      • \n
    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the default cache configuration for the distribution.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails": { + "type": "structure", + "members": { + "WebAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

    " + } + }, + "ETag": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The entity tag is a hash of the object.

    " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when that the distribution was last modified.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "DefaultRootObject": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The object that CloudFront sends in response to requests from the origin (for example,\n index.html) when a viewer requests the root URL for the distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/product-description.html).

    " + } + }, + "CacheBehaviors": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviors", + "traits": { + "smithy.api#documentation": "

    Provides information about the cache configuration for the distribution.

    " + } + }, + "Logging": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging", + "traits": { + "smithy.api#documentation": "

    A complex type that controls whether access logs are written for the distribution.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates the current status of the distribution.

    " + } + }, + "DefaultCacheBehavior": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionDefaultCacheBehavior", + "traits": { + "smithy.api#documentation": "

    The default cache behavior for the configuration.

    " + } + }, + "Origins": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins", + "traits": { + "smithy.api#documentation": "

    A complex type that contains information about origins for this distribution.

    " + } + }, + "OriginGroups": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroups", + "traits": { + "smithy.api#documentation": "

    Provides information about the origin groups in the distribution.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The domain name corresponding to the distribution.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A distribution configuration.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    An optional string that you want CloudFront to use as a prefix to the access log\n filenames for this distribution.

    " + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    With this field, you can enable or disable the selected distribution.

    " + } + }, + "Bucket": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 bucket to store the access logs in.

    " + } + }, + "IncludeCookies": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether you want CloudFront to include cookies in access logs.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A complex type that controls whether access logs are written for the distribution.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroup": { + "type": "structure", + "members": { + "FailoverCriteria": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailover", + "traits": { + "smithy.api#documentation": "

    Provides the criteria for an origin group to fail over.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an origin group for the distribution.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailover": { + "type": "structure", + "members": { + "StatusCodes": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodes", + "traits": { + "smithy.api#documentation": "

    Information about the status codes that cause an origin group to fail over.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about when an origin group fails over.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodes": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList", + "traits": { + "smithy.api#documentation": "

    The list of status code values that can cause a failover to the next origin.

    " + } + }, + "Quantity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of status codes that can cause a failover.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The status codes that cause an origin group to fail over.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Integer" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroups": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupsItemList", + "traits": { + "smithy.api#documentation": "

    The list of origin groups.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about origin groups that are associated with the\n distribution.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupsItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroup" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem": { + "type": "structure", + "members": { + "S3OriginConfig": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginS3OriginConfig", + "traits": { + "smithy.api#documentation": "

    An origin that is an S3 bucket that is not configured with static website\n hosting.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin.

    " + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A unique identifier for the origin or origin group.

    " + } + }, + "OriginPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web\n server), Amazon Elemental MediaStore, or other server from which CloudFront gets your\n files.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItem" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginS3OriginConfig": { + "type": "structure", + "members": { + "OriginAccessIdentity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The CloudFront origin access identity to associate with the origin.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an origin that is an S3 bucket that is not configured with static\n website hosting.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList", + "traits": { + "smithy.api#documentation": "

    A complex type that contains origins or origin groups for this distribution.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A complex type that contains information about origins and origin groups for this distribution.

    " + } + }, + "com.amazonaws.securityhub#AwsCloudTrailTrailDetails": { + "type": "structure", + "members": { + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the role that the CloudWatch Logs endpoint assumes when it writes to the log\n group.

    " + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the SNS topic that is used for notifications of log file delivery.

    " + } + }, + "S3BucketName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the S3 bucket where the log files are published.

    " + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the trail publishes events from global services such as IAM to the log\n files.

    " + } + }, + "HomeRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Region where the trail was created.

    " + } + }, + "SnsTopicName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the SNS topic that is used for notifications of log file delivery.

    " + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the trail is created for all accounts in an organization in AWS Organizations,\n or only for the current AWS account.

    " + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the trail.

    " + } + }, + "HasCustomEventSelectors": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the trail has custom event selectors.

    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The AWS KMS key ID to use to encrypt the logs.

    " + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log\n files are published.

    " + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the log group that CloudTrail logs are delivered to.

    " + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether CloudTrail log file validation is enabled.

    " + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the trail applies only to the current Region or to all Regions.

    " + } + }, + "TrailArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the trail.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides details about a CloudTrail trail.

    " + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectDetails": { + "type": "structure", + "members": { + "VpcConfig": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig", + "traits": { + "smithy.api#documentation": "

    Information about the VPC configuration that AWS CodeBuild accesses.

    " + } + }, + "Environment": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment", + "traits": { + "smithy.api#documentation": "

    Information about the build environment for this build project.

    " + } + }, + "ServiceRole": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS\n services on behalf of the AWS account.

    " + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the build project.

    " + } + }, + "Source": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectSource", + "traits": { + "smithy.api#documentation": "

    Information about the build input source code for this build project.

    " + } + }, + "EncryptionKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the\n build output artifacts.

    \n

    You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the\n CMK alias (using the format alias/alias-name).

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an AWS CodeBuild project.

    " + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment": { + "type": "structure", + "members": { + "RegistryCredential": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential", + "traits": { + "smithy.api#documentation": "

    The credentials for access to a private registry.

    " + } + }, + "ImagePullCredentialsType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of credentials AWS CodeBuild uses to pull images in your build.

    \n

    Valid values:

    \n
      \n
    • \n

      \n CODEBUILD specifies that AWS CodeBuild uses its own credentials. This\n requires that you modify your ECR repository policy to trust the AWS CodeBuild\n service principal.

      \n
      • \n
    • \n

      \n SERVICE_ROLE specifies that AWS CodeBuild uses your build project's\n service role.

      \n
      • \n
    \n

    When you use a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you\n must use CODEBUILD credentials.

    " + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of build environment to use for related builds.

    \n

    The environment type ARM_CONTAINER is available only in Regions US East (N.\n Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia\n Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

    \n

    The environment type LINUX_CONTAINER with compute type\n build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N.\n Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe\n (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia\n Pacific (Sydney), China (Beijing), and China (Ningxia).

    \n

    The environment type LINUX_GPU_CONTAINER is available only in Regions US\n East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe\n (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China\n (Ningxia).

    \n

    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER |\n LINUX_GPU_CONTAINER | ARM_CONTAINER\n

    " + } + }, + "Certificate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The certificate to use with this build project.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the build environment for this build project.

    " + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentRegistryCredential": { + "type": "structure", + "members": { + "CredentialProvider": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The service that created the credentials to access a private Docker registry.

    \n

    The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.

    " + } + }, + "Credential": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets\n Manager.

    \n \n

    The credential can use the name of the credentials only if they exist in your current\n AWS Region.

    \n     " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The credentials for access to a private registry.

    " + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectSource": { + "type": "structure", + "members": { + "GitCloneDepth": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    Information about the Git clone depth for the build project.

    " + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of repository that contains the source code to be built. Valid values\n are:

    \n
      \n
    • \n

      \n BITBUCKET - The source code is in a Bitbucket repository.

      \n
      • \n
    • \n

      \n CODECOMMIT - The source code is in an AWS CodeCommit\n repository.

      \n
      • \n
    • \n

      \n CODEPIPELINE - The source code settings are specified in the source\n action of a pipeline in AWS CodePipeline.

      \n
      • \n
    • \n

      \n GITHUB - The source code is in a GitHub repository.

      \n
      • \n
    • \n

      \n GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise\n repository.

      \n
      • \n
    • \n

      \n NO_SOURCE - The project does not have input source code.

      \n
      • \n
    • \n

      \n S3 - The source code is in an S3 input bucket.

      \n
      • \n
    " + } + }, + "Location": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Information about the location of the source code to be built.

    \n

    Valid values include:

    \n
      \n
    • \n

      For source code settings that are specified in the source action of a pipeline in\n AWS CodePipeline, location should not be specified. If it is specified, AWS\n CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a\n pipeline's source action instead of this value.

      \n
      • \n
    • \n

      For source code in an AWS CodeCommit repository, the HTTPS clone URL to the\n repository that contains the source code and the build spec file (for example,\n https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name\n ).

      \n
      • \n
    • \n

      For source code in an S3 input bucket, one of the following.

      \n
        \n
      • \n

        The path to the ZIP file that contains the source code (for example,\n bucket-name/path/to/object-name.zip).

        \n
        • \n
      • \n

        The path to the folder that contains the source code (for example,\n bucket-name/path/to/source-code/folder/).

        \n
        • \n
      \n
      • \n
    • \n

      For source code in a GitHub repository, the HTTPS clone URL to the repository that\n contains the source and the build spec file.

      \n
      • \n
    • \n

      For source code in a Bitbucket repository, the HTTPS clone URL to the repository\n that contains the source and the build spec file.

      \n
      • \n
    " + } + }, + "InsecureSsl": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether to ignore SSL warnings while connecting to the project source code.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the build input source code for this build project.

    " + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    A list of one or more security group IDs in your Amazon VPC.

    " + } + }, + "Subnets": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    A list of one or more subnet IDs in your Amazon VPC.

    " + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the VPC.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the VPC configuration that AWS CodeBuild accesses.

    " + } + }, + "com.amazonaws.securityhub#AwsCorsConfiguration": { + "type": "structure", + "members": { + "MaxAge": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of seconds for which the browser caches preflight request results.

    " + } + }, + "AllowMethods": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    The allowed methods for CORS requests.

    " + } + }, + "ExposeHeaders": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    The exposed headers for CORS requests.

    " + } + }, + "AllowCredentials": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the CORS request includes credentials.

    " + } + }, + "AllowHeaders": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    The allowed headers for CORS requests.

    " + } + }, + "AllowOrigins": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    The allowed origins for CORS requests.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is\n only supported for HTTP APIs.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the attribute.

    " + } + }, + "AttributeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of the attribute.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains a definition of an attribute for the table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinition" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableBillingModeSummary": { + "type": "structure", + "members": { + "LastUpdateToPayPerRequestDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was\n set to that value.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "BillingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The method used to charge for read and write throughput and to manage capacity.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about the billing for read/write capacity on the table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableDetails": { + "type": "structure", + "members": { + "SseDescription": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableSseDescription", + "traits": { + "smithy.api#documentation": "

    Information about the server-side encryption for the table.

    " + } + }, + "ItemCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of items in the table.

    " + } + }, + "StreamSpecification": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableStreamSpecification", + "traits": { + "smithy.api#documentation": "

    The current DynamoDB Streams configuration for the table.

    " + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

    List of global secondary indexes for the table.

    " + } + }, + "TableSizeBytes": { + "target": "com.amazonaws.securityhub#SizeBytes", + "traits": { + "smithy.api#documentation": "

    The total size of the table in bytes.

    " + } + }, + "TableName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the table.

    " + } + }, + "AttributeDefinitions": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableAttributeDefinitionList", + "traits": { + "smithy.api#documentation": "

    A list of attribute definitions for the table.

    " + } + }, + "KeySchema": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", + "traits": { + "smithy.api#documentation": "

    The primary key structure for the table.

    " + } + }, + "LatestStreamLabel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The label of the latest stream. The label is not a unique identifier.

    " + } + }, + "BillingModeSummary": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableBillingModeSummary", + "traits": { + "smithy.api#documentation": "

    Information about the billing for read/write capacity on the table.

    " + } + }, + "LatestStreamArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the latest stream for the table.

    " + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

    The list of local secondary indexes for the table.

    " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

    Information about the provisioned throughput for the table.

    " + } + }, + "TableStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The current status of the table.

    " + } + }, + "CreationDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the table was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "TableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the table.

    " + } + }, + "Replicas": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaList", + "traits": { + "smithy.api#documentation": "

    The list of replicas of this table.

    " + } + }, + "RestoreSummary": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableRestoreSummary", + "traits": { + "smithy.api#documentation": "

    Information about the restore for the table.

    " + } + }, + "GlobalTableVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version of global tables being used.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides details about a DynamoDB table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndex": { + "type": "structure", + "members": { + "KeySchema": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", + "traits": { + "smithy.api#documentation": "

    The key schema for the index.

    " + } + }, + "ItemCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of items in the index.

    " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

    Information about the provisioned throughput settings for the indexes.

    " + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.securityhub#SizeBytes", + "traits": { + "smithy.api#documentation": "

    The total size in bytes of the index.

    " + } + }, + "Projection": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProjection", + "traits": { + "smithy.api#documentation": "

    Attributes that are copied from the table into an index.

    " + } + }, + "Backfilling": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the index is currently backfilling.

    " + } + }, + "IndexArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the index.

    " + } + }, + "IndexName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the index.

    " + } + }, + "IndexStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The current status of the index.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information abut a global secondary index for the table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableGlobalSecondaryIndex" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableKeySchema": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the key schema attribute.

    " + } + }, + "KeyType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of key used for the key schema attribute.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A component of the key schema for the DynamoDB table, a global secondary index, or a\n local secondary index.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchema" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndex": { + "type": "structure", + "members": { + "Projection": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProjection", + "traits": { + "smithy.api#documentation": "

    Attributes that are copied from the table into the index. These are in addition to the\n primary key attributes and index key attributes, which are automatically projected.

    " + } + }, + "IndexArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the index.

    " + } + }, + "KeySchema": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableKeySchemaList", + "traits": { + "smithy.api#documentation": "

    The complete key schema for the index.

    " + } + }, + "IndexName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the index.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a local secondary index for a DynamoDB table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableLocalSecondaryIndex" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableProjection": { + "type": "structure", + "members": { + "ProjectionType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The types of attributes that are projected into the index.

    " + } + }, + "NonKeyAttributes": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The nonkey attributes that are projected into the index. For each attribute, provide the\n attribute name.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    For global and local secondary indexes, identifies the attributes that are copied from\n the table into the index.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughput": { + "type": "structure", + "members": { + "WriteCapacityUnits": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

    " + } + }, + "LastDecreaseDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the provisioned throughput was last decreased.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "NumberOfDecreasesToday": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of times during the current UTC calendar day that the provisioned throughput\n was decreased.

    " + } + }, + "ReadCapacityUnits": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

    " + } + }, + "LastIncreaseDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the provisioned throughput was last increased.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the provisioned throughput for the table or for a global secondary\n index.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The read capacity units for the replica.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Replica-specific configuration for the provisioned throughput.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplica": { + "type": "structure", + "members": { + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

    List of global secondary indexes for the replica.

    " + } + }, + "KmsMasterKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS KMS customer master key (CMK) that will be used for AWS KMS\n encryption for the replica.

    " + } + }, + "RegionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the Region where the replica is located.

    " + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

    Replica-specific configuration for the provisioned throughput.

    " + } + }, + "ReplicaStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The current status of the replica.

    " + } + }, + "ReplicaStatusDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Detailed information about the replica status.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a replica of a DynamoDB table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the index.

    " + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

    Replica-specific configuration for the provisioned throughput for the index.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a global secondary index for a DynamoDB table replica.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplicaGlobalSecondaryIndex" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableReplicaList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableReplica" + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableRestoreSummary": { + "type": "structure", + "members": { + "RestoreDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates the point in time that the table was restored to.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "SourceBackupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the source backup from which the table was restored.

    " + } + }, + "SourceTableArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the source table for the backup.

    " + } + }, + "RestoreInProgress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether a restore is currently in progress.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the restore for the table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableSseDescription": { + "type": "structure", + "members": { + "KmsMasterKeyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the AWS KMS customer master key (CMK) that is used for the AWS KMS\n encryption.

    " + } + }, + "SseType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of server-side encryption.

    " + } + }, + "InaccessibleEncryptionDateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    If the key is inaccessible, the date and time when DynamoDB detected that the key was\n inaccessible.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the server-side encryption.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the server-side encryption for the table.

    " + } + }, + "com.amazonaws.securityhub#AwsDynamoDbTableStreamSpecification": { + "type": "structure", + "members": { + "StreamViewType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Determines the information that is written to the table.

    " + } + }, + "StreamEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether DynamoDB Streams is enabled on the table.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The current DynamoDB Streams configuration for the table.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2EipDetails": { + "type": "structure", + "members": { + "PublicIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A public IP address that is associated with the EC2 instance.

    " + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the network interface.

    " + } + }, + "Domain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The domain in which to allocate the address.

    \n

    If the address is for use with EC2 instances in a VPC, then Domain is\n vpc. Otherwise, Domain is standard.

    " + } + }, + "AllocationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier that AWS assigns to represent the allocation of the Elastic IP address\n for use with Amazon VPC.

    " + } + }, + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the EC2 instance.

    " + } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the location from which the Elastic IP address is advertised.

    " + } + }, + "AssociationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier that represents the association of the Elastic IP address with an EC2\n instance.

    " + } + }, + "PublicIpv4Pool": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP\n address from the address pool.

    " + } + }, + "NetworkInterfaceOwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The AWS account ID of the owner of the network interface.

    " + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The private IP address that is associated with the Elastic IP address.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an Elastic IP address.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceDetails": { + "type": "structure", + "members": { + "IpV4Addresses": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The IPv4 addresses associated with the instance.

    " + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the VPC that the instance was launched in.

    " + } + }, + "ImageId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Amazon Machine Image (AMI) ID of the instance.

    " + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the subnet that the instance was launched in.

    " + } + }, + "LaunchedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the instance was launched.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The instance type of the instance.

    " + } + }, + "IamInstanceProfileArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The IAM profile ARN of the instance.

    " + } + }, + "KeyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The key name associated with the instance.

    " + } + }, + "IpV6Addresses": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The IPv6 addresses associated with the instance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The details of an Amazon EC2 instance.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the instance.

    " + } + }, + "AttachmentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the network interface attachment

    " + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the network interface is deleted when the instance is\n terminated.

    " + } + }, + "AttachTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the attachment initiated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "DeviceIndex": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The device index of the network interface attachment on the instance.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The attachment state.

    \n

    Valid values: attaching | attached | detaching |\n detached\n

    " + } + }, + "InstanceOwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The AWS account ID of the owner of the instance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the network interface attachment.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment", + "traits": { + "smithy.api#documentation": "

    The network interface attachment.

    " + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList", + "traits": { + "smithy.api#documentation": "

    Security groups for the network interface.

    " + } + }, + "SourceDestCheck": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether traffic to or from the instance is validated.

    " + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the network interface.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about the network interface

    " + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the security group.

    " + } + }, + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the security group.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A security group associated with the network interface.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    [VPC only] The ID of the VPC for the security group.

    " + } + }, + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the security group.

    " + } + }, + "IpPermissionsEgress": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", + "traits": { + "smithy.api#documentation": "

    [VPC only] The outbound rules associated with the security group.

    " + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The AWS account ID of the owner of the security group.

    " + } + }, + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the security group.

    " + } + }, + "IpPermissions": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", + "traits": { + "smithy.api#documentation": "

    The inbound rules associated with the security group.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about an EC2 security group.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission": { + "type": "structure", + "members": { + "IpProtocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The IP protocol name (tcp, udp, icmp,\n icmpv6) or number.

    \n

    [VPC only] Use -1 to specify all protocols.

    \n

    When authorizing security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify.

    \n

    For tcp, udp, and icmp, you must specify a port\n range.

    \n

    For icmpv6, the port range is optional. If you omit the port range, traffic\n for all types and codes is allowed.

    " + } + }, + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type\n number.

    \n

    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.

    " + } + }, + "IpRanges": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList", + "traits": { + "smithy.api#documentation": "

    The IPv4 ranges.

    " + } + }, + "UserIdGroupPairs": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList", + "traits": { + "smithy.api#documentation": "

    The security group and AWS account ID pairs.

    " + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

    \n

    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.

    " + } + }, + "PrefixListIds": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList", + "traits": { + "smithy.api#documentation": "

    [VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS\n service to access through a VPC endpoint from instances associated with the security\n group.

    " + } + }, + "Ipv6Ranges": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList", + "traits": { + "smithy.api#documentation": "

    The IPv6 ranges.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An IP permission for an EC2 security group.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange": { + "type": "structure", + "members": { + "CidrIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv4 address, use the /32 prefix length.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A range of IPv4 addresses.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range": { + "type": "structure", + "members": { + "CidrIpv6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv6 address, use the /128 prefix length.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A range of IPv6 addresses.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId": { + "type": "structure", + "members": { + "PrefixListId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the prefix.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A prefix list ID.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId" + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the security group.

    " + } + }, + "UserId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of an AWS account.

    \n

    For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

    \n

    [EC2-Classic] Required when adding or removing rules that reference a security group in\n another AWS.

    " + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the VPC peering connection, if applicable.

    " + } + }, + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the security group.

    " + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the VPC for the referenced security group, if applicable.

    " + } + }, + "PeeringStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of a VPC peering connection, if applicable.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A relationship between a security group and a user.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair" + } + }, + "com.amazonaws.securityhub#AwsEc2VolumeAttachment": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the EC2 instance.

    " + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the EBS volume is deleted when the EC2 instance is terminated.

    " + } + }, + "AttachTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The datetime when the attachment initiated.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The attachment state of the volume.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An attachment to an AWS EC2 volume.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachment" + } + }, + "com.amazonaws.securityhub#AwsEc2VolumeDetails": { + "type": "structure", + "members": { + "Attachments": { + "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList", + "traits": { + "smithy.api#documentation": "

    The volume attachments.

    " + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the volume is encrypted.

    " + } + }, + "SnapshotId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The snapshot from which the volume was created.

    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was\n used to protect the volume encryption key for the volume.

    " + } + }, + "Size": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The size of the volume, in GiBs.

    " + } + }, + "CreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the volume was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The volume state.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about an EC2 volume.

    " + } + }, + "com.amazonaws.securityhub#AwsEc2VpcDetails": { + "type": "structure", + "members": { + "DhcpOptionsId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are\n associated with the VPC. If the default options are associated with the VPC, then this is\n default.

    " + } + }, + "State": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The current state of the VPC.

    " + } + }, + "CidrBlockAssociationSet": { + "target": "com.amazonaws.securityhub#CidrBlockAssociationList", + "traits": { + "smithy.api#documentation": "

    Information about the IPv4 CIDR blocks associated with the VPC.

    " + } + }, + "Ipv6CidrBlockAssociationSet": { + "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList", + "traits": { + "smithy.api#documentation": "

    Information about the IPv6 CIDR blocks associated with the VPC.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about an EC2 VPC.

    " + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainDetails": { + "type": "structure", + "members": { + "DomainId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Unique identifier for an Amazon ES domain.

    " + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Domain-specific endpoint used to submit index, search, and data upload requests to an\n Amazon ES domain.

    \n

    The endpoint is a service URL.

    " + } + }, + "VPCOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions", + "traits": { + "smithy.api#documentation": "

    Information that Amazon ES derives based on VPCOptions for the\n domain.

    " + } + }, + "NodeToNodeEncryptionOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions", + "traits": { + "smithy.api#documentation": "

    Details about the configuration for node-to-node encryption.

    " + } + }, + "AccessPolicies": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    IAM policy document specifying the access policies for the new Amazon ES domain.

    " + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions", + "traits": { + "smithy.api#documentation": "

    Details about the configuration for encryption at rest.

    " + } + }, + "DomainEndpointOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions", + "traits": { + "smithy.api#documentation": "

    Additional options for the domain endpoint.

    " + } + }, + "Endpoints": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

    The key-value pair that exists if the Amazon ES domain uses VPC endpoints.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Name of an Amazon ES domain.

    \n

    Domain names are unique across all domains owned by the same account within an AWS\n Region.

    \n

    Domain names must start with a lowercase letter and must be between 3 and 28\n characters.

    \n

    Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

    " + } + }, + "ElasticsearchVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Elasticsearch version.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an Elasticsearch domain.

    " + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions": { + "type": "structure", + "members": { + "EnforceHTTPS": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether to require that all traffic to the domain arrive over HTTPS.

    " + } + }, + "TLSSecurityPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch\n domain.

    \n

    Valid values:

    \n
      \n
    • \n

      \n Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher

      \n
      • \n
    • \n

      \n Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2

      \n
      • \n
    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

    " + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

    " + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether encryption at rest is enabled.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about the configuration for encryption at rest.

    " + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether node-to-node encryption is enabled.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about the configuration for node-to-node encryption.

    " + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    A list of subnet IDs associated with the VPC endpoints for the domain.

    " + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    The list of security group IDs associated with the VPC endpoints for the domain.

    " + } + }, + "VPCId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    ID for the VPC.

    " + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    The list of Availability Zones associated with the VPC subnets.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information that Amazon ES derives based on VPCOptions for the\n domain.

    " + } + }, + "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicy" + } + }, + "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The mnemonic name for the policy being created. The name must be unique within the set\n of policies for the load balancer.

    " + } + }, + "CookieName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the application cookie used for stickiness.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about a stickiness policy that was created using\n CreateAppCookieStickinessPolicy.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicy" + } + }, + "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the policy. The name must be unique within the set of policies for the load\n balancer.

    " + } + }, + "CookieExpirationPeriod": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#documentation": "

    The amount of time, in seconds, after which the cookie is considered stale. If an\n expiration period is not specified, the stickiness session lasts for the duration of the\n browser session.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about a stickiness policy that was created using\n CreateLBCookieStickinessPolicy.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerAccessLog": { + "type": "structure", + "members": { + "S3BucketPrefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The logical hierarchy that was created for the S3 bucket.

    \n

    If a prefix is not provided, the log is placed at the root level of the bucket.

    " + } + }, + "EmitInterval": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The interval in minutes for publishing the access logs.

    \n

    You can publish access logs either every 5 minutes or every 60 minutes.

    " + } + }, + "S3BucketName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the S3 bucket where the access logs are stored.

    " + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether access logs are enabled for the load balancer.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the access log configuration for the load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerAttributes": { + "type": "structure", + "members": { + "ConnectionDraining": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionDraining", + "traits": { + "smithy.api#documentation": "

    Information about the connection draining configuration for the load balancer.

    \n

    If connection draining is enabled, the load balancer allows existing requests to\n complete before it shifts traffic away from a deregistered or unhealthy instance.

    " + } + }, + "ConnectionSettings": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionSettings", + "traits": { + "smithy.api#documentation": "

    Connection settings for the load balancer.

    \n

    If an idle timeout is configured, the load balancer allows connections to remain idle\n for the specified duration. When a connection is idle, no data is sent over the\n connection.

    " + } + }, + "CrossZoneLoadBalancing": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerCrossZoneLoadBalancing", + "traits": { + "smithy.api#documentation": "

    Cross-zone load balancing settings for the load balancer.

    \n

    If cross-zone load balancing is enabled, the load balancer routes the request traffic\n evenly across all instances regardless of the Availability Zones.

    " + } + }, + "AccessLog": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAccessLog", + "traits": { + "smithy.api#documentation": "

    Information about the access log configuration for the load balancer.

    \n

    If the access log is enabled, the load balancer captures detailed information about all\n requests. It delivers the information to a specified S3 bucket.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains attributes for the load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescription": { + "type": "structure", + "members": { + "InstancePort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The port on which the EC2 instance is listening.

    " + } + }, + "PolicyNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The names of the policies that are enabled for the EC2 instance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about the configuration of an EC2 instance for the load\n balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescription" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionDraining": { + "type": "structure", + "members": { + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The maximum time, in seconds, to keep the existing connections open before deregistering\n the instances.

    " + } + }, + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether connection draining is enabled for the load balancer.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the connection draining configuration for the load\n balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerConnectionSettings": { + "type": "structure", + "members": { + "IdleTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The time, in seconds, that the connection can be idle (no data is sent over the\n connection) before it is closed by the load balancer.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains connection settings for the load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerCrossZoneLoadBalancing": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether cross-zone load balancing is enabled for the load balancer.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains cross-zone load balancing settings for the load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerDetails": { + "type": "structure", + "members": { + "CanonicalHostedZoneNameID": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the Amazon Route 53 hosted zone for the load balancer.

    " + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the VPC for the load balancer.

    " + } + }, + "BackendServerDescriptions": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerBackendServerDescriptions", + "traits": { + "smithy.api#documentation": "

    Information about the configuration of the EC2 instances.

    " + } + }, + "HealthCheck": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerHealthCheck", + "traits": { + "smithy.api#documentation": "

    Information about the health checks that are conducted on the load balancer.

    " + } + }, + "ListenerDescriptions": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescriptions", + "traits": { + "smithy.api#documentation": "

    The policies that are enabled for the load balancer listeners.

    " + } + }, + "Instances": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerInstances", + "traits": { + "smithy.api#documentation": "

    List of EC2 instances for the load balancer.

    " + } + }, + "Scheme": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of load balancer. Only provided if the load balancer is in a VPC.

    \n

    If Scheme is internet-facing, the load balancer has a public\n DNS name that resolves to a public IP address.

    \n

    If Scheme is internal, the load balancer has a public DNS name\n that resolves to a private IP address.

    " + } + }, + "CanonicalHostedZoneName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the Amazon Route 53 hosted zone for the load balancer.

    " + } + }, + "CreatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the load balancer was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "DnsName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The DNS name of the load balancer.

    " + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The security groups for the load balancer. Only provided if the load balancer is in a\n VPC.

    " + } + }, + "SourceSecurityGroup": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerSourceSecurityGroup", + "traits": { + "smithy.api#documentation": "

    Information about the security group for the load balancer. This is the security group\n that is used for inbound rules.

    " + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The list of Availability Zones for the load balancer.

    " + } + }, + "LoadBalancerAttributes": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerAttributes", + "traits": { + "smithy.api#documentation": "

    The attributes for a load balancer.

    " + } + }, + "Policies": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerPolicies", + "traits": { + "smithy.api#documentation": "

    The policies for a load balancer.

    " + } + }, + "Subnets": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The list of subnet identifiers for the load balancer.

    " + } + }, + "LoadBalancerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the load balancer.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains details about a Classic Load Balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerHealthCheck": { + "type": "structure", + "members": { + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The amount of time, in seconds, during which no response means a failed health\n check.

    " + } + }, + "UnhealthyThreshold": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of consecutive health check failures that must occur before the instance is\n moved to the Unhealthy state.

    " + } + }, + "HealthyThreshold": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of consecutive health check successes required before the instance is moved\n to the Healthy state.

    " + } + }, + "Target": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The instance that is being checked. The target specifies the protocol and port. The\n available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through\n 65535.

    \n

    For the HTTP and HTTPS protocols, the target also specifies the ping path.

    \n

    For the TCP protocol, the target is specified as TCP:\n \n .

    \n

    For the SSL protocol, the target is specified as\n SSL.\n .

    \n

    For the HTTP and HTTPS protocols, the target is specified as\n \n :/\n .

    " + } + }, + "Interval": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The approximate interval, in seconds, between health checks of an individual\n instance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the health checks that are conducted on the load\n balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerInstance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The instance identifier.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about an EC2 instance for a load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerInstance" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerListener": { + "type": "structure", + "members": { + "InstanceProtocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The protocol to use to route traffic to instances.

    \n

    Valid values: HTTP | HTTPS | TCP |\n SSL\n

    " + } + }, + "InstancePort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The port on which the instance is listening.

    " + } + }, + "SslCertificateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the server certificate.

    " + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The load balancer transport protocol to use for routing.

    \n

    Valid values: HTTP | HTTPS | TCP |\n SSL\n

    " + } + }, + "LoadBalancerPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The port on which the load balancer is listening.

    \n

    On EC2-VPC, you can specify any port from the range 1-65535.

    \n

    On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587,\n 1024-65535.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a load balancer listener.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescription": { + "type": "structure", + "members": { + "PolicyNames": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The policies enabled for the listener.

    " + } + }, + "Listener": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListener", + "traits": { + "smithy.api#documentation": "

    Information about the listener.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Lists the policies that are enabled for a load balancer listener.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescriptions": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerListenerDescription" + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerPolicies": { + "type": "structure", + "members": { + "OtherPolicies": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The policies other than the stickiness policies.

    " + } + }, + "LbCookieStickinessPolicies": { + "target": "com.amazonaws.securityhub#AwsElbLbCookieStickinessPolicies", + "traits": { + "smithy.api#documentation": "

    The stickiness policies that are created using\n CreateLBCookieStickinessPolicy.

    " + } + }, + "AppCookieStickinessPolicies": { + "target": "com.amazonaws.securityhub#AwsElbAppCookieStickinessPolicies", + "traits": { + "smithy.api#documentation": "

    The stickiness policies that are created using\n CreateAppCookieStickinessPolicy.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the policies for a load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbLoadBalancerSourceSecurityGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the security group.

    " + } + }, + "OwnerAlias": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The owner of the security group.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the security group for the load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the VPC for the load balancer.

    " + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of load balancer.

    " + } + }, + "IpAddressType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of IP addresses used by the subnets for your load balancer. The possible values\n are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6\n addresses).

    " + } + }, + "Scheme": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The nodes of an Internet-facing load balancer have public IP addresses.

    " + } + }, + "CreatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the load balancer was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

    The Availability Zones for the load balancer.

    " + } + }, + "DNSName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The public DNS name of the load balancer.

    " + } + }, + "State": { + "target": "com.amazonaws.securityhub#LoadBalancerState", + "traits": { + "smithy.api#documentation": "

    The state of the load balancer.

    " + } + }, + "CanonicalHostedZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the Amazon Route 53 hosted zone associated with the load balancer.

    " + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#SecurityGroups", + "traits": { + "smithy.api#documentation": "

    The IDs of the security groups for the load balancer.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a load balancer.

    " + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeyDetails": { + "type": "structure", + "members": { + "SessionContext": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContext", + "traits": { + "smithy.api#documentation": "

    Information about the session that the key was used for.

    " + } + }, + "AccessKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the access key.

    " + } + }, + "PrincipalId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the principal associated with an access key.

    " + } + }, + "PrincipalName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the principal.

    " + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the IAM access key was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "UserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#deprecated": { + "message": "This field is deprecated, use PrincipalName instead." + }, + "smithy.api#documentation": "

    The user associated with the IAM access key related to a finding.

    \n

    The UserName parameter has been replaced with the\n PrincipalName parameter because access keys can also be assigned to\n principals that are not IAM users.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeyStatus", + "traits": { + "smithy.api#documentation": "

    The status of the IAM access key related to a finding.

    " + } + }, + "PrincipalType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of principal associated with an access key.

    " + } + }, + "AccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The AWS account ID of the account for the key.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    IAM access key details related to a finding.

    " + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeySessionContext": { + "type": "structure", + "members": { + "SessionIssuer": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContextSessionIssuer", + "traits": { + "smithy.api#documentation": "

    Information about the entity that created the session.

    " + } + }, + "Attributes": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeySessionContextAttributes", + "traits": { + "smithy.api#documentation": "

    Attributes of the session that the key was used for.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about the session that the key was used for.

    " + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeySessionContextAttributes": { + "type": "structure", + "members": { + "CreationDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the session was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "MfaAuthenticated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the session used multi-factor authentication (MFA).

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Attributes of the session that the key was used for.

    " + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeySessionContextSessionIssuer": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of principal (user, role, or group) that created the session.

    " + } + }, + "AccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account that created the session.

    " + } + }, + "PrincipalId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The principal ID of the principal (user, role, or group) that created the\n session.

    " + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the session.

    " + } + }, + "UserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the principal that created the session.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the entity that created the session.

    " + } + }, + "com.amazonaws.securityhub#AwsIamAccessKeyStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Active", + "name": "ACTIVE" + }, + { + "value": "Inactive", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.securityhub#AwsIamAttachedManagedPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the policy.

    " + } + }, + "PolicyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the policy.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A managed policy that is attached to an IAM principal.

    " + } + }, + "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicy" + } + }, + "com.amazonaws.securityhub#AwsIamGroupDetails": { + "type": "structure", + "members": { + "AttachedManagedPolicies": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", + "traits": { + "smithy.api#documentation": "

    A list of the managed policies that are attached to the IAM group.

    " + } + }, + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the IAM group.

    " + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The path to the group.

    " + } + }, + "GroupPolicyList": { + "target": "com.amazonaws.securityhub#AwsIamGroupPolicyList", + "traits": { + "smithy.api#documentation": "

    The list of inline policies that are embedded in the group.

    " + } + }, + "GroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the IAM group.

    " + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the IAM group was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains details about an IAM group.

    " + } + }, + "com.amazonaws.securityhub#AwsIamGroupPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the policy.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A managed policy that is attached to the IAM group.

    " + } + }, + "com.amazonaws.securityhub#AwsIamGroupPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamGroupPolicy" + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfile": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The path to the instance profile.

    " + } + }, + "InstanceProfileName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the instance profile.

    " + } + }, + "InstanceProfileId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the instance profile.

    " + } + }, + "Roles": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfileRoles", + "traits": { + "smithy.api#documentation": "

    The roles associated with the instance profile.

    " + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the instance profile.

    " + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the instance profile was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an instance profile.

    " + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfile" + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfileRole": { + "type": "structure", + "members": { + "RoleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the role.

    " + } + }, + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument", + "traits": { + "smithy.api#documentation": "

    The policy that grants an entity permission to assume the role.

    " + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the role.

    " + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The path to the role.

    " + } + }, + "RoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the role.

    " + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the role was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about a role associated with an instance profile.

    " + } + }, + "com.amazonaws.securityhub#AwsIamInstanceProfileRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfileRole" + } + }, + "com.amazonaws.securityhub#AwsIamPermissionsBoundary": { + "type": "structure", + "members": { + "PermissionsBoundaryArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the policy used to set the permissions boundary.

    " + } + }, + "PermissionsBoundaryType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The usage type for the permissions boundary.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the policy used to set the permissions boundary for an IAM\n principal.

    " + } + }, + "com.amazonaws.securityhub#AwsIamPolicyDetails": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The path to the policy.

    " + } + }, + "AttachmentCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of users, groups, and roles that the policy is attached to.

    " + } + }, + "UpdateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    When the policy was most recently updated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "PolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The unique identifier of the policy.

    " + } + }, + "IsAttachable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the policy can be attached to a user, group, or role.

    " + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    When the policy was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "DefaultVersionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the default version of the policy.

    " + } + }, + "PolicyVersionList": { + "target": "com.amazonaws.securityhub#AwsIamPolicyVersionList", + "traits": { + "smithy.api#documentation": "

    List of versions of the policy.

    " + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A description of the policy.

    " + } + }, + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the policy.

    " + } + }, + "PermissionsBoundaryUsageCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of users and roles that use the policy to set the permissions\n boundary.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents an IAM permissions policy.

    " + } + }, + "com.amazonaws.securityhub#AwsIamPolicyVersion": { + "type": "structure", + "members": { + "IsDefaultVersion": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the version is the default version.

    " + } + }, + "VersionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the policy version.

    " + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the version was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A version of an IAM policy.

    " + } + }, + "com.amazonaws.securityhub#AwsIamPolicyVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamPolicyVersion" + } + }, + "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" + } + }, + "com.amazonaws.securityhub#AwsIamRoleDetails": { + "type": "structure", + "members": { + "AttachedManagedPolicies": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", + "traits": { + "smithy.api#documentation": "

    The list of the managed policies that are attached to the role.

    " + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The path to the role.

    " + } + }, + "MaxSessionDuration": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The maximum session duration (in seconds) that you want to set for the specified role.

    " + } + }, + "RoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The friendly name that identifies the role.

    " + } + }, + "RolePolicyList": { + "target": "com.amazonaws.securityhub#AwsIamRolePolicyList", + "traits": { + "smithy.api#documentation": "

    The list of inline policies that are embedded in the role.

    " + } + }, + "AssumeRolePolicyDocument": { + "target": "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument", + "traits": { + "smithy.api#documentation": "

    The trust policy that grants permission to assume the role.

    " + } + }, + "InstanceProfileList": { + "target": "com.amazonaws.securityhub#AwsIamInstanceProfileList", + "traits": { + "smithy.api#documentation": "

    The list of instance profiles that contain this role.

    " + } + }, + "RoleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The stable and unique string identifying the role.

    " + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.securityhub#AwsIamPermissionsBoundary" + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the role was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about an IAM role, including all of the role's policies.

    " + } + }, + "com.amazonaws.securityhub#AwsIamRolePolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the policy.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An inline policy that is embedded in the role.

    " + } + }, + "com.amazonaws.securityhub#AwsIamRolePolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamRolePolicy" + } + }, + "com.amazonaws.securityhub#AwsIamUserDetails": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The path to the user.

    " + } + }, + "AttachedManagedPolicies": { + "target": "com.amazonaws.securityhub#AwsIamAttachedManagedPolicyList", + "traits": { + "smithy.api#documentation": "

    A list of the managed policies that are attached to the user.

    " + } + }, + "UserId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The unique identifier for the user.

    " + } + }, + "GroupList": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of IAM groups that the user belongs to.

    " + } + }, + "UserPolicyList": { + "target": "com.amazonaws.securityhub#AwsIamUserPolicyList", + "traits": { + "smithy.api#documentation": "

    The list of inline policies that are embedded in the user.

    " + } + }, + "CreateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the user was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "UserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the user.

    " + } + }, + "PermissionsBoundary": { + "target": "com.amazonaws.securityhub#AwsIamPermissionsBoundary", + "traits": { + "smithy.api#documentation": "

    The permissions boundary for the user.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an IAM user.

    " + } + }, + "com.amazonaws.securityhub#AwsIamUserPolicy": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the policy.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an inline policy that is embedded in the user.

    " + } + }, + "com.amazonaws.securityhub#AwsIamUserPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsIamUserPolicy" + } + }, + "com.amazonaws.securityhub#AwsKmsKeyDetails": { + "type": "structure", + "members": { + "Origin": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The source of the CMK's key material.

    \n

    When this value is AWS_KMS, AWS KMS created the key material.

    \n

    When this value is EXTERNAL, the key material was imported from your\n existing key management infrastructure or the CMK lacks key material.

    \n

    When this value is AWS_CLOUDHSM, the key material was created in the AWS\n CloudHSM cluster associated with a custom key store.

    " + } + }, + "CreationDate": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#documentation": "

    Indicates when the CMK was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "KeyManager": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.

    " + } + }, + "KeyState": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The state of the CMK.

    " + } + }, + "AWSAccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The twelve-digit account ID of the AWS account that owns the CMK.

    " + } + }, + "KeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The globally unique identifier for the CMK.

    " + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A description of the key.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains metadata about a customer master key (CMK).

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionCode": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

    " + } + }, + "ZipFile": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.

    " + } + }, + "S3Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 key of the deployment package.

    " + } + }, + "S3ObjectVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    For versioned objects, the version of the deployment package object to use.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The dead-letter queue for failed asynchronous invocations.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionDetails": { + "type": "structure", + "members": { + "KmsKeyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.

    " + } + }, + "MasterArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    For Lambda@Edge functions, the ARN of the master function.

    " + } + }, + "FunctionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the function.

    " + } + }, + "LastModified": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the function was last updated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Runtime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The runtime environment for the Lambda function.

    " + } + }, + "CodeSha256": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The SHA256 hash of the function's deployment package.

    " + } + }, + "RevisionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The latest updated revision of the function or alias.

    " + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version of the Lambda function.

    " + } + }, + "Code": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionCode", + "traits": { + "smithy.api#documentation": "

    An AwsLambdaFunctionCode object.

    " + } + }, + "MemorySize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The memory that's allocated to the function.

    " + } + }, + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The amount of time that Lambda allows a function to run before stopping it.

    " + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig", + "traits": { + "smithy.api#documentation": "

    The function's dead letter queue.

    " + } + }, + "Handler": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The function that Lambda calls to begin executing your function.

    " + } + }, + "TracingConfig": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig", + "traits": { + "smithy.api#documentation": "

    The function's AWS X-Ray tracing configuration.

    " + } + }, + "Layers": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayerList", + "traits": { + "smithy.api#documentation": "

    The function's layers.

    " + } + }, + "Environment": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment", + "traits": { + "smithy.api#documentation": "

    The function's environment variables.

    " + } + }, + "Role": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The function's execution role.

    " + } + }, + "VpcConfig": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig", + "traits": { + "smithy.api#documentation": "

    The function's networking configuration.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about a function's configuration.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { + "type": "structure", + "members": { + "Variables": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

    Environment variable key-value pairs.

    " + } + }, + "Error": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", + "traits": { + "smithy.api#documentation": "

    An AwsLambdaFunctionEnvironmentError object.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A function's environment variable settings.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The error code.

    " + } + }, + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The error message.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Error messages for environment variables that couldn't be applied.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the function layer.

    " + } + }, + "CodeSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The size of the layer archive in bytes.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An AWS Lambda layer.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The tracing mode.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The function's AWS X-Ray tracing configuration.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    A list of VPC security groups IDs.

    " + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ID of the VPC.

    " + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    A list of VPC subnet IDs.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { + "type": "structure", + "members": { + "CreatedDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the version was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "CompatibleRuntimes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

    The layer's compatible runtimes. Maximum number of five items.

    \n

    Valid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n

    " + } + }, + "Version": { + "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", + "traits": { + "smithy.api#documentation": "

    The version number.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about a Lambda layer version.

    " + } + }, + "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { + "type": "long" + }, + "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRole": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the association between the IAM role and the DB cluster.

    " + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the IAM role.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An IAM role that is associated with the Amazon RDS DB cluster.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRole" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterDetails": { + "type": "structure", + "members": { + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The port number on which the DB instances in the DB cluster accept connections.

    " + } + }, + "HttpEndpointEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

    " + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the database activity stream.

    " + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the DB cluster is encrypted.

    " + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of days for which automated backups are retained.

    " + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The range of time each day when automated backups are created, if automated backups are\n enabled.

    \n

    Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

    " + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the DB cluster. The identifier must be unique within each AWS Region\n and is immutable.

    " + } + }, + "DomainMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbDomainMemberships", + "traits": { + "smithy.api#documentation": "

    The Active Directory domain membership records that are associated with the DB\n cluster.

    " + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the master user for the DB cluster.

    " + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups", + "traits": { + "smithy.api#documentation": "

    A list of VPC security groups that the DB cluster belongs to.

    " + } + }, + "DbClusterOptionGroupMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMemberships", + "traits": { + "smithy.api#documentation": "

    The list of option group memberships for this DB cluster.

    " + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether tags are copied from the DB cluster to snapshots of the DB cluster.

    " + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

    \n

    Uses the format :HH:MM-:HH:MM.

    \n

    For the day values, use\n mon|tue|wed|thu|fri|sat|sun.

    \n

    For example, sun:09:32-sun:10:02.

    " + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterAssociatedRoles", + "traits": { + "smithy.api#documentation": "

    A list of the IAM roles that are associated with the DB cluster.

    " + } + }, + "CrossAccountClone": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the DB cluster is a clone of a DB cluster owned by a different AWS\n account.

    " + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The DB cluster identifier that the user assigned to the cluster. This identifier is the\n unique key that identifies a DB cluster.

    " + } + }, + "EnabledCloudWatchLogsExports": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of log types that this DB cluster is configured to export to CloudWatch\n Logs.

    " + } + }, + "DeletionProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the DB cluster has deletion protection enabled.

    " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    For all database engines except Aurora, specifies the allocated storage size in\n gibibytes (GiB).

    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the AWS KMS master key that is used to encrypt the database instances in the\n DB cluster.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The current status of this DB cluster.

    " + } + }, + "DatabaseName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the database.

    " + } + }, + "MultiAz": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the DB cluster has instances in multiple Availability Zones.

    " + } + }, + "DbClusterParameterGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the DB cluster parameter group for the DB cluster.

    " + } + }, + "IamDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the mapping of IAM accounts to database accounts is enabled.

    " + } + }, + "HostedZoneId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Specifies the identifier that Amazon Route 53 assigns when you create a hosted\n zone.

    " + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of Availability Zones (AZs) where instances in the DB cluster can be\n created.

    " + } + }, + "Engine": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the database engine to use for this DB cluster.

    " + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The connection endpoint for the primary instance of the DB cluster.

    " + } + }, + "CustomEndpoints": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of custom endpoints for the DB cluster.

    " + } + }, + "DbClusterMembers": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterMembers", + "traits": { + "smithy.api#documentation": "

    The list of instances that make up the DB cluster.

    " + } + }, + "ReadReplicaIdentifiers": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the read replicas that are associated with this DB cluster.

    " + } + }, + "DbSubnetGroup": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The subnet group that is associated with the DB cluster, including the name,\n description, and subnets in the subnet group.

    " + } + }, + "ReaderEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The reader endpoint for the DB cluster.

    " + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "EngineMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The database engine mode of the DB cluster.

    " + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version number of the database engine to use.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an Amazon RDS DB cluster.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterMember": { + "type": "structure", + "members": { + "PromotionTier": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    Specifies the order in which an Aurora replica is promoted to the primary instance when\n the existing primary instance fails.

    " + } + }, + "IsClusterWriter": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the cluster member is the primary instance for the DB cluster.

    " + } + }, + "DbInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The instance identifier for this member of the DB cluster.

    " + } + }, + "DbClusterParameterGroupStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the DB cluster parameter group for this member of the DB cluster.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an instance in the DB cluster.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterMembers": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterMember" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMembership": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the DB cluster option group.

    " + } + }, + "DbClusterOptionGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the DB cluster option group.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an option group membership for a DB cluster.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterOptionGroupMembership" + } + }, + "com.amazonaws.securityhub#AwsRdsDbClusterSnapshotDetails": { + "type": "structure", + "members": { + "SnapshotCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the snapshot was taken.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "Engine": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the DB cluster is encrypted.

    " + } + }, + "LicenseModel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The license model information for this DB cluster snapshot.

    " + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The VPC ID that is associated with the DB cluster snapshot.

    " + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of Availability Zones where instances in the DB cluster can be created.

    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the AWS KMS master key that is used to encrypt the database instances in the\n DB cluster.

    " + } + }, + "SnapshotType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of DB cluster snapshot.

    " + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the master user for the DB cluster.

    " + } + }, + "PercentProgress": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    Specifies the percentage of the estimated data that has been transferred.

    " + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The DB cluster identifier.

    " + } + }, + "IamDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether mapping of IAM accounts to database accounts is enabled.

    " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    Specifies the allocated storage size in gibibytes (GiB).

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of this DB cluster snapshot.

    " + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version of the database engine to use.

    " + } + }, + "DbClusterSnapshotIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the DB cluster snapshot.

    " + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The port number on which the DB instances in the DB cluster accept connections.

    " + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an Amazon RDS DB cluster snapshot.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbDomainMembership": { + "type": "structure", + "members": { + "IamRoleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the IAM role to use when making API calls to the Directory Service.

    " + } + }, + "Fqdn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The fully qualified domain name of the Active Directory domain.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The status of the Active Directory Domain membership for the DB instance.

    " + } + }, + "Domain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the Active Directory domain.

    " + } + } }, "traits": { - "smithy.api#documentation": "

    Information about the VPC configuration that AWS CodeBuild accesses.

    " + "smithy.api#documentation": "

    Information about an Active Directory domain membership record associated with the DB\n instance.

    " } }, - "com.amazonaws.securityhub#AwsEc2InstanceDetails": { + "com.amazonaws.securityhub#AwsRdsDbDomainMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbDomainMembership" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole": { "type": "structure", "members": { - "LaunchedAt": { + "FeatureName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the feature associated with the IAM)role.

    " + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Describes the state of the association between the IAM role and the DB instance. The\n Status property returns one of the following values:

    \n
      \n
    • \n

      \n ACTIVE - The IAM role ARN is associated with the DB instance and can\n be used to access other AWS services on your behalf.

      \n
      • \n
    • \n

      \n PENDING - The IAM role ARN is being associated with the DB\n instance.

      \n
      • \n
    • \n

      \n INVALID - The IAM role ARN is associated with the DB instance. But\n the DB instance is unable to assume the IAM role in order to access other AWS\n services on your behalf.

      \n
      • \n
    " + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An AWS Identity and Access Management (IAM) role associated with the DB instance.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole" + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceDetails": { + "type": "structure", + "members": { + "PreferredBackupWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The range of time each day when automated backups are created, if automated backups are\n enabled.

    \n

    Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

    " + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether to copy resource tags to snapshots of the DB instance.

    " + } + }, + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The master user name of the DB instance.

    " + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to\n CloudWatch Logs.

    " + } + }, + "DbSubnetGroup": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroup", + "traits": { + "smithy.api#documentation": "

    Information about the subnet group that is associated with the DB instance.

    " + } + }, + "PromotionTier": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The order in which to promote an Aurora replica to the primary instance after a failure\n of the existing primary instance.

    " + } + }, + "MultiAz": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the DB instance is a multiple Availability Zone deployment.

    " + } + }, + "PerformanceInsightsKmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS KMS key used to encrypt the Performance Insights data.

    " + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", + "traits": { + "smithy.api#documentation": "

    The number of CPU cores and the number of threads per core for the DB instance class of\n the DB instance.

    " + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of days to retain Performance Insights data.

    " + } + }, + "DbSecurityGroups": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of the DB security groups to assign to the DB instance.

    " + } + }, + "ListenerEndpoint": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint" + }, + "CharacterSetName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the character set that this DB instance is associated with.

    " + } + }, + "StorageType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The storage type for the DB instance.

    " + } + }, + "EnabledCloudWatchLogsExports": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of log types that this DB instance is configured to export to CloudWatch\n Logs.

    " + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Contains a user-supplied database identifier. This identifier is the unique key that\n identifies a DB instance.

    " + } + }, + "ReadReplicaDBInstanceIdentifiers": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    List of identifiers of the read replicas associated with this DB instance.

    " + } + }, + "DBName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The meaning of this parameter differs according to the database engine you use.

    \n

    \n MySQL, MariaDB, SQL Server, PostgreSQL\n

    \n

    Contains the name of the initial database of this instance that was provided at create\n time, if one was specified when the DB instance was created. This same name is returned for\n the life of the DB instance.

    \n

    \n Oracle\n

    \n

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the\n returned parameters do not apply to an Oracle DB instance.

    " + } + }, + "DbInstancePort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB\n cluster, this can be a different port than the DB cluster port.

    " + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint", + "traits": { + "smithy.api#documentation": "

    Specifies the connection endpoint.

    " + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the CA certificate for this DB instance.

    " + } + }, + "Engine": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Provides the name of the database engine to use for this DB instance.

    " + } + }, + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

    " + } + }, + "DbParameterGroups": { + "target": "com.amazonaws.securityhub#AwsRdsDbParameterGroups", + "traits": { + "smithy.api#documentation": "

    A list of the DB parameter groups to assign to the DB instance.

    " + } + }, + "LicenseModel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    License model information for this DB instance.

    " + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts is enabled, and otherwise false.

    \n

    IAM database authentication can be enabled for the following database engines.

    \n
      \n
    • \n

      For MySQL 5.6, minor version 5.6.34 or higher

      \n
      • \n
    • \n

      For MySQL 5.7, minor version 5.7.16 or higher

      \n
      • \n
    • \n

      Aurora 5.6 or higher

      \n
      • \n
    " + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

    \n

    Uses the format :HH:MM-:HH:MM.

    \n

    For the day values, use\n mon|tue|wed|thu|fri|sat|sun.

    \n

    For example, sun:09:32-sun:10:02.

    " + } + }, + "DbiResourceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The AWS Region-unique, immutable identifier for the DB instance. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is\n accessed.

    " + } + }, + "DomainMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbDomainMemberships", + "traits": { + "smithy.api#documentation": "

    The Active Directory domain membership records associated with the DB instance.

    " + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The upper limit to which Amazon RDS can automatically scale the storage of the DB\n instance.

    " + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of days for which to retain automated backups.

    " + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that\n the DB instance is a member of.

    " + } + }, + "SecondaryAvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    For a DB instance with multi-Availability Zone support, the name of the secondary\n Availability Zone.

    " + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether Performance Insights is enabled for the DB instance.

    " + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN from the key store with which the instance is associated for TDE\n encryption.

    " + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the DB instance is encrypted.

    " + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates the database engine version.

    " + } + }, + "ReadReplicaSourceDBInstanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    If this DB instance is a read replica, contains the identifier of the source DB\n instance.

    " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The amount of storage (in gigabytes) to initially allocate for the DB instance.

    " + } + }, + "DbInstanceStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The current status of the DB instance.

    " + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Specifies the accessibility options for the DB instance.

    \n

    A value of true specifies an Internet-facing instance with a publicly resolvable DNS\n name, which resolves to a public IP address.

    \n

    A value of false specifies an internal instance with a DNS name that resolves to a\n private IP address.

    " + } + }, + "DeletionProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether the DB instance has deletion protection enabled.

    \n

    When deletion protection is enabled, the database cannot be deleted.

    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted\n DB instance.

    " + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The Availability Zone where the DB instance will be created.

    " + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.securityhub#AwsRdsDbPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

    Changes to the DB instance that are currently pending.

    " + } + }, + "EnhancedMonitoringResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics\n data for the DB instance.

    " + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Specifies the latest time to which a database can be restored with point-in-time\n restore.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "DBInstanceClass": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date/time the instance was launched.

    " + "smithy.api#documentation": "

    Contains the name of the compute and memory capacity class of the DB instance.

    " } }, - "Type": { + "InstanceCreateTime": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The instance type of the instance.

    " + "smithy.api#documentation": "

    Indicates when the DB instance was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "IpV6Addresses": { - "target": "com.amazonaws.securityhub#StringList", + "AssociatedRoles": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles", "traits": { - "smithy.api#documentation": "

    The IPv6 addresses associated with the instance.

    " + "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) roles associated with the DB\n instance.

    " } }, - "ImageId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "StatusInfos": { + "target": "com.amazonaws.securityhub#AwsRdsDbStatusInfos", "traits": { - "smithy.api#documentation": "

    The Amazon Machine Image (AMI) ID of the instance.

    " + "smithy.api#documentation": "

    The status of a read replica. If the instance isn't a read replica, this is\n empty.

    " } }, - "VpcId": { + "OptionGroupMemberships": { + "target": "com.amazonaws.securityhub#AwsRdsDbOptionGroupMemberships", + "traits": { + "smithy.api#documentation": "

    The list of option group memberships for this DB instance.

    " + } + }, + "Timezone": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the VPC that the instance was launched in.

    " + "smithy.api#documentation": "

    The time zone of the DB instance.

    " } }, - "IpV4Addresses": { - "target": "com.amazonaws.securityhub#StringList", + "MonitoringInterval": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The IPv4 addresses associated with the instance.

    " + "smithy.api#documentation": "

    The interval, in seconds, between points when enhanced monitoring metrics are collected\n for the DB instance.

    " } }, - "KeyName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ReadReplicaDBClusterIdentifiers": { + "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "

    The key name associated with the instance.

    " + "smithy.api#documentation": "

    List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as\n a read replica.

    " } }, - "IamInstanceProfileArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    The IAM profile ARN of the instance.

    " + "smithy.api#documentation": "

    Indicates whether minor version patches are applied automatically.

    " } }, - "SubnetId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups", "traits": { - "smithy.api#documentation": "

    The identifier of the subnet that the instance was launched in.

    " + "smithy.api#documentation": "

    A list of VPC security groups that the DB instance belongs to.

    " } } }, "traits": { - "smithy.api#documentation": "

    The details of an Amazon EC2 instance.

    " + "smithy.api#documentation": "

    Contains the details of an Amazon RDS DB instance.

    " } }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment": { + "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint": { "type": "structure", "members": { - "Status": { + "HostedZoneId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The attachment state.

    \n

    Valid values: attaching | attached | detaching |\n detached\n

    " + "smithy.api#documentation": "

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " } }, - "InstanceOwnerId": { + "Address": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The AWS account ID of the owner of the instance.

    " + "smithy.api#documentation": "

    Specifies the DNS address of the DB instance.

    " } }, - "AttachTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Port": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The timestamp indicating when the attachment initiated.

    " + "smithy.api#documentation": "

    Specifies the port that the database engine is listening on.

    " } - }, - "AttachmentId": { + } + }, + "traits": { + "smithy.api#documentation": "

    Specifies the connection endpoint.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup": { + "type": "structure", + "members": { + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the network interface attachment

    " - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#documentation": "

    Indicates whether the network interface is deleted when the instance is\n terminated.

    " - } - }, - "DeviceIndex": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#documentation": "

    The device index of the network interface attachment on the instance.

    " + "smithy.api#documentation": "

    The status of the VPC security group.

    " } }, - "InstanceId": { + "VpcSecurityGroupId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the instance.

    " + "smithy.api#documentation": "

    The name of the VPC security group.

    " } } }, "traits": { - "smithy.api#documentation": "

    Information about the network interface attachment.

    " + "smithy.api#documentation": "

    A VPC security groups that the DB instance belongs to.

    " } }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails": { + "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsRdsDbOptionGroupMembership": { "type": "structure", "members": { - "Attachment": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceAttachment", - "traits": { - "smithy.api#documentation": "

    The network interface attachment.

    " - } - }, - "NetworkInterfaceId": { + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the network interface.

    " - } - }, - "SourceDestCheck": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#documentation": "

    Indicates whether traffic to or from the instance is validated.

    " + "smithy.api#documentation": "

    " } }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList", + "OptionGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Security groups for the network interface.

    " + "smithy.api#documentation": "

    " } } }, "traits": { - "smithy.api#documentation": "

    Details about the network interface

    " + "smithy.api#documentation": "

    " } }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup": { + "com.amazonaws.securityhub#AwsRdsDbOptionGroupMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbOptionGroupMembership" + } + }, + "com.amazonaws.securityhub#AwsRdsDbParameterGroup": { "type": "structure", "members": { - "GroupName": { + "ParameterApplyStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the security group.

    " + "smithy.api#documentation": "

    " } }, - "GroupId": { + "DbParameterGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the security group.

    " + "smithy.api#documentation": "

    " } } }, "traits": { - "smithy.api#documentation": "

    A security group associated with the network interface.

    " + "smithy.api#documentation": "

    " } }, - "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroupList": { + "com.amazonaws.securityhub#AwsRdsDbParameterGroups": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceSecurityGroup" + "target": "com.amazonaws.securityhub#AwsRdsDbParameterGroup" } }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails": { + "com.amazonaws.securityhub#AwsRdsDbPendingModifiedValues": { "type": "structure", "members": { - "IpPermissions": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", + "PendingCloudWatchLogsExports": { + "target": "com.amazonaws.securityhub#AwsRdsPendingCloudWatchLogsExports", "traits": { - "smithy.api#documentation": "

    The inbound rules associated with the security group.

    " + "smithy.api#documentation": "

    " } }, - "OwnerId": { + "DbSubnetGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The AWS account ID of the owner of the security group.

    " + "smithy.api#documentation": "

    " } }, - "GroupName": { + "DbInstanceClass": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the security group.

    " + "smithy.api#documentation": "

    " } }, - "VpcId": { + "MasterUserPassword": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    [VPC only] The ID of the VPC for the security group.

    " + "smithy.api#documentation": "

    " } }, - "GroupId": { + "ProcessorFeatures": { + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "DbInstanceIdentifier": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the security group.

    " + "smithy.api#documentation": "

    " } }, - "IpPermissionsEgress": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList", + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    [VPC only] The outbound rules associated with the security group.

    " + "smithy.api#documentation": "

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Details about an EC2 security group.

    " - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission": { - "type": "structure", - "members": { - "PrefixListIds": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList", + }, + "StorageType": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    [VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS\n service to access through a VPC endpoint from instances associated with the security\n group.

    " + "smithy.api#documentation": "

    " } }, - "Ipv6Ranges": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList", + "LicenseModel": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The IPv6 ranges.

    " + "smithy.api#documentation": "

    " } }, - "UserIdGroupPairs": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList", + "MultiAZ": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    The security group and AWS account ID pairs.

    " + "smithy.api#documentation": "

    " } }, - "IpRanges": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList", + "CaCertificateIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The IPv4 ranges.

    " + "smithy.api#documentation": "

    " } }, - "FromPort": { + "BackupRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type\n number.

    \n

    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.

    " + "smithy.api#documentation": "

    " } }, - "IpProtocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The IP protocol name (tcp, udp, icmp,\n icmpv6) or number.

    \n

    [VPC only] Use -1 to specify all protocols.

    \n

    When authorizing security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify.

    \n

    For tcp, udp, and icmp, you must specify a port\n range.

    \n

    For icmpv6, the port range is optional. If you omit the port range, traffic\n for all types and codes is allowed.

    " + "smithy.api#documentation": "

    " } }, - "ToPort": { + "Iops": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

    \n

    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.

    " + "smithy.api#documentation": "

    " + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    " } } }, "traits": { - "smithy.api#documentation": "

    An IP permission for an EC2 security group.

    " - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission" + "smithy.api#documentation": "

    " } }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange": { + "com.amazonaws.securityhub#AwsRdsDbProcessorFeature": { "type": "structure", "members": { - "CidrIp": { + "Value": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv4 address, use the /32 prefix length.

    " + "smithy.api#documentation": "

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    A range of IPv4 addresses.

    " - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpRange" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range": { - "type": "structure", - "members": { - "CidrIpv6": { + }, + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but\n not both. To specify a single IPv6 address, use the /128 prefix length.

    " + "smithy.api#documentation": "

    " } } }, "traits": { - "smithy.api#documentation": "

    A range of IPv6 addresses.

    " + "smithy.api#documentation": "

    " } }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6RangeList": { + "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupIpv6Range" + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeature" } }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId": { + "com.amazonaws.securityhub#AwsRdsDbSnapshotDetails": { "type": "structure", "members": { - "PrefixListId": { + "ProcessorFeatures": { + "target": "com.amazonaws.securityhub#AwsRdsDbProcessorFeatures", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "TdeCredentialArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the prefix.

    " + "smithy.api#documentation": "

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    A prefix list ID.

    " - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupPrefixListId" - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair": { - "type": "structure", - "members": { - "PeeringStatus": { + }, + "IamDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "Port": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "AvailabilityZone": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The status of a VPC peering connection, if applicable.

    " + "smithy.api#documentation": "

    " } }, - "VpcId": { + "DbiResourceId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the VPC for the referenced security group, if applicable.

    " + "smithy.api#documentation": "

    " } }, - "GroupId": { + "SnapshotType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the security group.

    " + "smithy.api#documentation": "

    " } }, - "VpcPeeringConnectionId": { + "LicenseModel": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the VPC peering connection, if applicable.

    " + "smithy.api#documentation": "

    " } }, - "UserId": { + "InstanceCreateTime": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of an AWS account.

    \n

    For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

    \n

    [EC2-Classic] Required when adding or removing rules that reference a security group in\n another AWS.

    " + "smithy.api#documentation": "

    " } }, - "GroupName": { + "VpcId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the security group.

    " + "smithy.api#documentation": "

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    A relationship between a security group and a user.

    " - } - }, - "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPairList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupUserIdGroupPair" - } - }, - "com.amazonaws.securityhub#AwsEc2VolumeAttachment": { - "type": "structure", - "members": { - "InstanceId": { + }, + "Timezone": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the EC2 instance.

    " + "smithy.api#documentation": "

    " } }, - "Status": { + "DbInstanceIdentifier": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The attachment state of the volume.

    " + "smithy.api#documentation": "

    " } }, - "AttachTime": { + "KmsKeyId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The datetime when the attachment initiated.

    " + "smithy.api#documentation": "

    " } }, - "DeleteOnTermination": { - "target": "com.amazonaws.securityhub#Boolean", + "MasterUsername": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Whether the EBS volume is deleted when the EC2 instance is terminated.

    " + "smithy.api#documentation": "

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    An attachment to an AWS EC2 volume.

    " - } - }, - "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachment" - } - }, - "com.amazonaws.securityhub#AwsEc2VolumeDetails": { - "type": "structure", - "members": { - "Attachments": { - "target": "com.amazonaws.securityhub#AwsEc2VolumeAttachmentList", + }, + "DbSnapshotIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The volume attachments.

    " + "smithy.api#documentation": "

    " } }, - "SnapshotId": { + "SourceRegion": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The snapshot from which the volume was created.

    " + "smithy.api#documentation": "

    " } }, - "KmsKeyId": { + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "SnapshotCreateTime": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was\n used to protect the volume encryption key for the volume.

    " + "smithy.api#documentation": "

    " } }, - "Status": { + "Engine": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The volume state.

    " + "smithy.api#documentation": "

    " } }, - "Encrypted": { - "target": "com.amazonaws.securityhub#Boolean", + "SourceDbSnapshotIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Whether the volume is encrypted.

    " + "smithy.api#documentation": "

    " } }, - "CreateTime": { + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The datetime when the volume was created.

    " + "smithy.api#documentation": "

    " } }, - "Size": { - "target": "com.amazonaws.securityhub#Integer", + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The size of the volume, in GiBs.

    " + "smithy.api#documentation": "

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Details about an EC2 volume.

    " - } - }, - "com.amazonaws.securityhub#AwsEc2VpcDetails": { - "type": "structure", - "members": { - "DhcpOptionsId": { + }, + "StorageType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are\n associated with the VPC. If the default options are associated with the VPC, then this is\n default.

    " + "smithy.api#documentation": "

    " } }, - "CidrBlockAssociationSet": { - "target": "com.amazonaws.securityhub#CidrBlockAssociationList", + "PercentProgress": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    Information about the IPv4 CIDR blocks associated with the VPC.

    " + "smithy.api#documentation": "

    " } }, - "State": { + "OptionGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The current state of the VPC.

    " + "smithy.api#documentation": "

    " } }, - "Ipv6CidrBlockAssociationSet": { - "target": "com.amazonaws.securityhub#Ipv6CidrBlockAssociationList", + "AllocatedStorage": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    Information about the IPv6 CIDR blocks associated with the VPC.

    " + "smithy.api#documentation": "

    " } } }, "traits": { - "smithy.api#documentation": "

    Details about an EC2 VPC.

    " + "smithy.api#documentation": "

    " } }, - "com.amazonaws.securityhub#AwsElasticsearchDomainDetails": { + "com.amazonaws.securityhub#AwsRdsDbStatusInfo": { "type": "structure", "members": { - "Endpoint": { + "Message": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Domain-specific endpoint used to submit index, search, and data upload requests to an\n Amazon ES domain.

    \n

    The endpoint is a service URL.

    " + "smithy.api#documentation": "

    If the read replica is currently in an error state, provides the error details.

    " } }, - "DomainName": { + "StatusType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Name of an Amazon ES domain.

    \n

    Domain names are unique across all domains owned by the same account within an AWS\n Region.

    \n

    Domain names must start with a lowercase letter and must be between 3 and 28\n characters.

    \n

    Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

    " + "smithy.api#documentation": "

    The type of status. For a read replica, the status type is read replication.

    " } }, - "NodeToNodeEncryptionOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions", + "Normal": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    Details about the configuration for node-to-node encryption.

    " + "smithy.api#documentation": "

    Whether the read replica instance is operating normally.

    " } }, - "DomainId": { + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Unique identifier for an Amazon ES domain.

    " + "smithy.api#documentation": "

    The status of the read replica instance.

    " } - }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions", + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the status of a read replica.

    " + } + }, + "com.amazonaws.securityhub#AwsRdsDbStatusInfos": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbStatusInfo" + } + }, + "com.amazonaws.securityhub#AwsRdsDbSubnetGroup": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Details about the configuration for encryption at rest.

    " + "smithy.api#documentation": "

    The VPC ID of the subnet group.

    " } }, - "AccessPolicies": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Subnets": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnets", "traits": { - "smithy.api#documentation": "

    IAM policy document specifying the access policies for the new Amazon ES domain.

    " + "smithy.api#documentation": "

    A list of subnets in the subnet group.

    " } }, - "ElasticsearchVersion": { + "SubnetGroupStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Elasticsearch version.

    " + "smithy.api#documentation": "

    The status of the subnet group.

    " } }, - "DomainEndpointOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions", + "DbSubnetGroupDescription": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Additional options for the domain endpoint.

    " + "smithy.api#documentation": "

    The description of the subnet group.

    " } }, - "Endpoints": { - "target": "com.amazonaws.securityhub#FieldMap", + "DbSubnetGroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The key-value pair that exists if the Amazon ES domain uses VPC endpoints.

    " + "smithy.api#documentation": "

    The name of the subnet group.

    " } }, - "VPCOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions", + "DbSubnetGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Information that Amazon ES derives based on VPCOptions for the\n domain.

    " + "smithy.api#documentation": "

    The ARN of the subnet group.

    " } } }, "traits": { - "smithy.api#documentation": "

    Information about an Elasticsearch domain.

    " + "smithy.api#documentation": "

    Information about the subnet group for the database instance.

    " } }, - "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions": { + "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnet": { "type": "structure", "members": { - "EnforceHTTPS": { - "target": "com.amazonaws.securityhub#Boolean", + "SubnetIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Whether to require that all traffic to the domain arrive over HTTPS.

    " + "smithy.api#documentation": "

    The identifier of a subnet in the subnet group.

    " } }, - "TLSSecurityPolicy": { + "SubnetStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch\n domain.

    \n

    Valid values:

    \n
      \n
    • \n

      \n Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher

      \n
      • \n
    • \n

      \n Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2

      \n
      • \n
    " + "smithy.api#documentation": "

    The status of a subnet in the subnet group.

    " + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnetAvailabilityZone", + "traits": { + "smithy.api#documentation": "

    Information about the Availability Zone for a subnet in the subnet group.

    " } } }, "traits": { - "smithy.api#documentation": "

    Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

    " + "smithy.api#documentation": "

    Information about a subnet in a subnet group.

    " } }, - "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions": { + "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnetAvailabilityZone": { "type": "structure", "members": { - "KmsKeyId": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

    " - } - }, - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#documentation": "

    Whether encryption at rest is enabled.

    " + "smithy.api#documentation": "

    The name of the Availability Zone for a subnet in the subnet group.

    " } } }, "traits": { - "smithy.api#documentation": "

    Details about the configuration for encryption at rest.

    " + "smithy.api#documentation": "

    An Availability Zone for a subnet in a subnet group.

    " } }, - "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions": { + "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRdsDbSubnetGroupSubnet" + } + }, + "com.amazonaws.securityhub#AwsRdsPendingCloudWatchLogsExports": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", + "LogTypesToEnable": { + "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "

    Whether node-to-node encryption is enabled.

    " + "smithy.api#documentation": "

    A list of log types that are being enabled.

    " + } + }, + "LogTypesToDisable": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "

    A list of log types that are being disabled.

    " } } }, "traits": { - "smithy.api#documentation": "

    Details about the configuration for node-to-node encryption.

    " + "smithy.api#documentation": "

    Identifies the log types to enable and disable.

    " } }, - "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions": { + "com.amazonaws.securityhub#AwsRedshiftClusterClusterNode": { "type": "structure", "members": { - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

    The list of Availability Zones associated with the VPC subnets.

    " - } - }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A list of subnet IDs associated with the VPC endpoints for the domain.

    " + "smithy.api#documentation": "

    The private IP address of the node.

    " } }, - "VPCId": { + "NodeRole": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    ID for the VPC.

    " + "smithy.api#documentation": "

    The role of the node. A node might be a leader node or a compute node.

    " } }, - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "PublicIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The list of security group IDs associated with the VPC endpoints for the domain.

    " + "smithy.api#documentation": "

    The public IP address of the node.

    " } } }, "traits": { - "smithy.api#documentation": "

    Information that Amazon ES derives based on VPCOptions for the\n domain.

    " + "smithy.api#documentation": "

    A node in an Amazon Redshift cluster.

    " } }, - "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails": { + "com.amazonaws.securityhub#AwsRedshiftClusterClusterNodes": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterNode" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroup": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.securityhub#LoadBalancerState", - "traits": { - "smithy.api#documentation": "

    The state of the load balancer.

    " - } - }, - "CanonicalHostedZoneId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The ID of the Amazon Route 53 hosted zone associated with the load balancer.

    " - } - }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The ID of the VPC for the load balancer.

    " - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.securityhub#AvailabilityZones", + "ClusterParameterStatusList": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatusList", "traits": { - "smithy.api#documentation": "

    The Availability Zones for the load balancer.

    " + "smithy.api#documentation": "

    The list of parameter statuses.

    " } }, - "Scheme": { + "ParameterApplyStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The nodes of an Internet-facing load balancer have public IP addresses.

    " - } - }, - "SecurityGroups": { - "target": "com.amazonaws.securityhub#SecurityGroups", - "traits": { - "smithy.api#documentation": "

    The IDs of the security groups for the load balancer.

    " + "smithy.api#documentation": "

    The status of updates to the parameters.

    " } }, - "CreatedTime": { + "ParameterGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time the load balancer was created.

    " + "smithy.api#documentation": "

    The name of the parameter group.

    " } - }, - "Type": { + } + }, + "traits": { + "smithy.api#documentation": "

    A cluster parameter group that is associated with an Amazon Redshift cluster.

    " + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroup" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatus": { + "type": "structure", + "members": { + "ParameterApplyErrorDescription": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of load balancer.

    " + "smithy.api#documentation": "

    The error that prevented the parameter from being applied to the database.

    " } }, - "DNSName": { + "ParameterName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The public DNS name of the load balancer.

    " + "smithy.api#documentation": "

    The name of the parameter.

    " } }, - "IpAddressType": { + "ParameterApplyStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of IP addresses used by the subnets for your load balancer. The possible values\n are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6\n addresses).

    " + "smithy.api#documentation": "

    The status of the parameter. Indicates whether the parameter is in sync with the\n database, waiting for a cluster reboot, or encountered an error when it was applied.

    \n

    Valid values: in-sync | pending-reboot | applying\n | invalid-parameter | apply-deferred | apply-error |\n unknown-error\n

    " } } }, "traits": { - "smithy.api#documentation": "

    Information about a load balancer.

    " + "smithy.api#documentation": "

    The status of a parameter in a cluster parameter group for an Amazon Redshift\n cluster.

    " } }, - "com.amazonaws.securityhub#AwsIamAccessKeyDetails": { + "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterStatus" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroup": { "type": "structure", "members": { - "PrincipalName": { + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the principal.

    " + "smithy.api#documentation": "

    The status of the cluster security group.

    " } }, - "PrincipalType": { + "ClusterSecurityGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of principal associated with an access key.

    " + "smithy.api#documentation": "

    The name of the cluster security group.

    " } - }, - "UserName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + } + }, + "traits": { + "smithy.api#documentation": "

    A security group that is associated with the cluster.

    " + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroup" + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterClusterSnapshotCopyStatus": { + "type": "structure", + "members": { + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#deprecated": { - "message": "This field is deprecated, use PrincipalName instead." - }, - "smithy.api#documentation": "

    The user associated with the IAM access key related to a finding.

    \n

    The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.

    " + "smithy.api#documentation": "

    The number of days that manual snapshots are retained in the destination region after\n they are copied from a source region.

    \n

    If the value is -1, then the manual snapshot is retained indefinitely.

    \n

    Valid values: Either -1 or an integer between 1 and 3,653

    " } }, - "CreatedAt": { + "DestinationRegion": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The creation date/time of the IAM access key related to a finding.

    " + "smithy.api#documentation": "

    The destination Region that snapshots are automatically copied to when cross-Region\n snapshot copy is enabled.

    " } }, - "Status": { - "target": "com.amazonaws.securityhub#AwsIamAccessKeyStatus", + "RetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The status of the IAM access key related to a finding.

    " + "smithy.api#documentation": "

    The number of days to retain automated snapshots in the destination Region after they\n are copied from a source Region.

    " } }, - "PrincipalId": { + "SnapshotCopyGrantName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of the principal associated with an access key.

    " + "smithy.api#documentation": "

    The name of the snapshot copy grant.

    " } } }, "traits": { - "smithy.api#documentation": "

    IAM access key details related to a finding.

    " + "smithy.api#documentation": "

    Information about a cross-Region snapshot copy.

    " } }, - "com.amazonaws.securityhub#AwsIamAccessKeyStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "ACTIVE" - }, - { - "value": "Inactive", - "name": "INACTIVE" + "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindow": { + "type": "structure", + "members": { + "DeferMaintenanceStartTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The start of the time window for which maintenance was deferred.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } - ] + }, + "DeferMaintenanceIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the maintenance window.

    " + } + }, + "DeferMaintenanceEndTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The end of the time window for which maintenance was deferred.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A time windows during which maintenance was deferred for an Amazon Redshift\n cluster.

    " } }, - "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 131072 - }, - "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" + "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindows": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindow" } }, - "com.amazonaws.securityhub#AwsIamRoleDetails": { + "com.amazonaws.securityhub#AwsRedshiftClusterDetails": { "type": "structure", "members": { - "AssumeRolePolicyDocument": { - "target": "com.amazonaws.securityhub#AwsIamRoleAssumeRolePolicyDocument", + "IamRoles": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterIamRoles", "traits": { - "smithy.api#documentation": "

    The trust policy that grants permission to assume the role.

    " + "smithy.api#documentation": "

    A list of IAM roles that the cluster can use to access other AWS services.

    " } }, - "CreateDate": { + "KmsKeyId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO 8601 date-time format, when the role was created.

    " + "smithy.api#documentation": "

    The identifier of the AWS KMS encryption key that is used to encrypt data in the\n cluster.

    " } }, - "Path": { + "ClusterAvailabilityStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The path to the role.

    " + "smithy.api#documentation": "

    The availability status of the cluster for queries. Possible values are the\n following:

    \n
      \n
    • \n

      \n Available - The cluster is available for queries.

      \n
      • \n
    • \n

      \n Unavailable - The cluster is not available for queries.

      \n
      • \n
    • \n

      \n Maintenance - The cluster is intermittently available for queries due\n to maintenance activities.

      \n
      • \n
    • \n

      \n Modifying -The cluster is intermittently available for queries due to\n changes that modify the cluster.

      \n
      • \n
    • \n

      \n Failed - The cluster failed and is not available for queries.

      \n
      • \n
    " } }, - "MaxSessionDuration": { - "target": "com.amazonaws.securityhub#Integer", + "DBName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The maximum session duration (in seconds) that you want to set for the specified role.

    " + "smithy.api#documentation": "

    The name of the initial database that was created when the cluster was created.

    \n

    The same name is returned for the life of the cluster.

    \n

    If an initial database is not specified, a database named devdev is created\n by default.

    " } }, - "RoleId": { + "AvailabilityZone": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The stable and unique string identifying the role.

    " + "smithy.api#documentation": "

    The name of the Availability Zone in which the cluster is located.

    " } }, - "RoleName": { + "ExpectedNextSnapshotScheduleTimeStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The friendly name that identifies the role.

    " + "smithy.api#documentation": "

    The status of the next expected snapshot.

    \n

    Valid values: OnTrack | Pending\n

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Contains information about an IAM role, including all of the role's policies.

    " - } - }, - "com.amazonaws.securityhub#AwsKmsKeyDetails": { - "type": "structure", - "members": { - "CreationDate": { - "target": "com.amazonaws.securityhub#Double", + }, + "ClusterVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time when the CMK was created.

    " + "smithy.api#documentation": "

    The version ID of the Amazon Redshift engine that runs on the cluster.

    " } }, - "Origin": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ResizeInfo": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterResizeInfo", "traits": { - "smithy.api#documentation": "

    The source of the CMK's key material.

    \n

    When this value is AWS_KMS, AWS KMS created the key material.

    \n

    When this value is EXTERNAL, the key material was imported from your\n existing key management infrastructure or the CMK lacks key material.

    \n

    When this value is AWS_CLOUDHSM, the key material was created in the AWS\n CloudHSM cluster associated with a custom key store.

    " + "smithy.api#documentation": "

    Information about the resize operation for the cluster.

    " } }, - "AWSAccountId": { + "NextMaintenanceWindowStartTime": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The twelve-digit account ID of the AWS account that owns the CMK.

    " + "smithy.api#documentation": "

    Indicates the start of the next maintenance window.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "KeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    The globally unique identifier for the CMK.

    " + "smithy.api#documentation": "

    Whether the cluster can be accessed from a public network.

    " } }, - "KeyManager": { + "MaintenanceTrackName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.

    " + "smithy.api#documentation": "

    The name of the maintenance track for the cluster.

    " } }, - "KeyState": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ClusterParameterGroups": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterParameterGroups", "traits": { - "smithy.api#documentation": "

    The state of the CMK.

    " + "smithy.api#documentation": "

    The list of cluster parameter groups that are associated with this cluster.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Contains metadata about a customer master key (CMK).

    " - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionCode": { - "type": "structure", - "members": { - "S3Bucket": { + }, + "ClusterStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

    " + "smithy.api#documentation": "

    The current status of the cluster.

    \n

    Valid values: available | available, prep-for-resize |\n available, resize-cleanup | cancelling-resize |\n creating | deleting | final-snapshot |\n hardware-failure | incompatible-hsm |\n incompatible-network | incompatible-parameters |\n incompatible-restore | modifying | paused |\n rebooting | renaming | resizing |\n rotating-keys | storage-full |\n updating-hsm\n

    " } }, - "S3Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ManualSnapshotRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The Amazon S3 key of the deployment package.

    " + "smithy.api#documentation": "

    The default number of days to retain a manual snapshot.

    \n

    If the value is -1, the snapshot is retained indefinitely.

    \n

    This setting doesn't change the retention period of existing snapshots.

    \n

    Valid values: Either -1 or an integer between 1 and 3,653

    " } }, - "ZipFile": { + "ClusterSubnetGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.

    " + "smithy.api#documentation": "

    The name of the subnet group that is associated with the cluster. This parameter is\n valid only when the cluster is in a VPC.

    " } }, - "S3ObjectVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "AllowVersionUpgrade": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    For versioned objects, the version of the deployment package object to use.

    " + "smithy.api#documentation": "

    Indicates whether major version upgrades are applied automatically to the cluster during\n the maintenance window.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.

    " - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + }, + "ClusterNodes": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterNodes", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

    " + "smithy.api#documentation": "

    The nodes in the cluster.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    The dead-letter queue for failed asynchronous invocations.

    " - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionDetails": { - "type": "structure", - "members": { - "KmsKeyArn": { + }, + "ElasticResizeNumberOfNodeOptions": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.

    " + "smithy.api#documentation": "

    The number of nodes that you can use the elastic resize method to resize the cluster\n to.

    " } }, - "MasterArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "PendingModifiedValues": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterPendingModifiedValues", "traits": { - "smithy.api#documentation": "

    For Lambda@Edge functions, the ARN of the master function.

    " + "smithy.api#documentation": "

    A list of changes to the cluster that are currently pending.

    " } }, - "FunctionName": { + "ClusterRevisionNumber": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the function.

    " + "smithy.api#documentation": "

    The specific revision number of the database in the cluster.

    " } }, - "Timeout": { - "target": "com.amazonaws.securityhub#Integer", + "ClusterSnapshotCopyStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSnapshotCopyStatus", "traits": { - "smithy.api#documentation": "

    The amount of time that Lambda allows a function to run before stopping it.

    " + "smithy.api#documentation": "

    Information about the destination Region and retention period for the cross-Region\n snapshot copy.

    " } }, - "VpcConfig": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig", + "ClusterIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The function's networking configuration.

    " + "smithy.api#documentation": "

    The unique identifier of the cluster.

    " } }, - "Runtime": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The runtime environment for the Lambda function.

    " + "smithy.api#documentation": "

    The weekly time range, in Universal Coordinated Time (UTC), during which system\n maintenance can occur.

    \n

    Format:\n \n :HH:MM-:HH:MM\n

    \n

    For the day values, use mon | tue | wed |\n thu | fri | sat | sun\n

    \n

    For example, sun:09:32-sun:10:02\n

    " } }, - "Environment": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment", + "NumberOfNodes": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The function's environment variables.

    " + "smithy.api#documentation": "

    The number of compute nodes in the cluster.

    " } }, - "Role": { + "ClusterSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterClusterSecurityGroups", + "traits": { + "smithy.api#documentation": "

    A list of cluster security groups that are associated with the cluster.

    " + } + }, + "VpcId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The function's execution role.

    " + "smithy.api#documentation": "

    The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

    " } }, - "Layers": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayerList", + "EnhancedVpcRouting": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    The function's layers.

    " + "smithy.api#documentation": "

    Indicates whether to create the cluster with enhanced VPC routing enabled.

    " } }, - "TracingConfig": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig", + "VpcSecurityGroups": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroups", "traits": { - "smithy.api#documentation": "

    The function's AWS X-Ray tracing configuration.

    " + "smithy.api#documentation": "

    The list of VPC security groups that the cluster belongs to, if the cluster is in a\n VPC.

    " } }, - "MemorySize": { + "AutomatedSnapshotRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The memory that's allocated to the function.

    " + "smithy.api#documentation": "

    The number of days that automatic cluster snapshots are retained.

    " } }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    The version of the Lambda function.

    " + "smithy.api#documentation": "

    Indicates whether the data in the cluster is encrypted at rest.

    " } }, - "DeadLetterConfig": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionDeadLetterConfig", + "PendingActions": { + "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "

    The function's dead letter queue.

    " + "smithy.api#documentation": "

    A list of cluster operations that are waiting to start.

    " } }, - "Code": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionCode", + "ClusterCreateTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    An AwsLambdaFunctionCode object.

    " + "smithy.api#documentation": "

    Indicates when the cluster was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "CodeSha256": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "DeferredMaintenanceWindows": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterDeferredMaintenanceWindows", "traits": { - "smithy.api#documentation": "

    The SHA256 hash of the function's deployment package.

    " + "smithy.api#documentation": "

    List of time windows during which maintenance was deferred.

    " } }, - "Handler": { + "MasterUsername": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The function that Lambda calls to begin executing your function.

    " + "smithy.api#documentation": "

    The master user name for the cluster. This name is used to connect to the database that\n is specified in as the value of DBName.

    " } }, - "RevisionId": { + "SnapshotScheduleState": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The latest updated revision of the function or alias.

    " + "smithy.api#documentation": "

    The current state of the cluster snapshot schedule.

    \n

    Valid values: MODIFYING | ACTIVE | FAILED\n

    " } }, - "LastModified": { + "ExpectedNextSnapshotScheduleTime": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    " + "smithy.api#documentation": "

    Indicates when the next snapshot is expected to be taken. The cluster must have a valid\n snapshot schedule and have backups enabled.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Details about a function's configuration.

    " - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironment": { - "type": "structure", - "members": { - "Variables": { - "target": "com.amazonaws.securityhub#FieldMap", + }, + "ElasticIpStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterElasticIpStatus", "traits": { - "smithy.api#documentation": "

    Environment variable key-value pairs.

    " + "smithy.api#documentation": "

    Information about the status of the Elastic IP (EIP) address.

    " } }, - "Error": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError", + "NodeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    An AwsLambdaFunctionEnvironmentError object.

    " + "smithy.api#documentation": "

    The node type for the nodes in the cluster.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    A function's environment variable settings.

    " - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionEnvironmentError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterEndpoint", "traits": { - "smithy.api#documentation": "

    The error code.

    " + "smithy.api#documentation": "

    The connection endpoint.

    " } }, - "Message": { + "SnapshotScheduleIdentifier": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The error message.

    " + "smithy.api#documentation": "

    A unique identifier for the cluster snapshot schedule.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Error messages for environment variables that couldn't be applied.

    " - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { - "type": "structure", - "members": { - "CodeSize": { - "target": "com.amazonaws.securityhub#Integer", + }, + "HsmStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterHsmStatus", "traits": { - "smithy.api#documentation": "

    The size of the layer archive in bytes.

    " + "smithy.api#documentation": "

    Information about whether the Amazon Redshift cluster finished applying any changes to\n hardware security module (HSM) settings that were specified in a modify cluster\n command.

    " } }, - "Arn": { + "RestoreStatus": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterRestoreStatus", + "traits": { + "smithy.api#documentation": "

    Information about the status of a cluster restore action. Only applies to a cluster that\n was created by restoring a snapshot.

    " + } + }, + "ClusterPublicKey": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the function layer.

    " + "smithy.api#documentation": "

    The public key for the cluster.

    " } } }, "traits": { - "smithy.api#documentation": "

    An AWS Lambda layer.

    " + "smithy.api#documentation": "

    Details about an Amazon Redshift cluster.

    " } }, - "com.amazonaws.securityhub#AwsLambdaFunctionLayerList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionLayer" - } - }, - "com.amazonaws.securityhub#AwsLambdaFunctionTracingConfig": { + "com.amazonaws.securityhub#AwsRedshiftClusterElasticIpStatus": { "type": "structure", "members": { - "Mode": { + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The tracing mode.

    " + "smithy.api#documentation": "

    The status of the elastic IP address.

    " + } + }, + "ElasticIp": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The elastic IP address for the cluster.

    " } } }, "traits": { - "smithy.api#documentation": "

    The function's AWS X-Ray tracing configuration.

    " + "smithy.api#documentation": "

    The status of the elastic IP (EIP) address for an Amazon Redshift cluster.

    " } }, - "com.amazonaws.securityhub#AwsLambdaFunctionVpcConfig": { + "com.amazonaws.securityhub#AwsRedshiftClusterEndpoint": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

    A list of VPC security groups IDs.

    " - } - }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "Address": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A list of VPC subnet IDs.

    " + "smithy.api#documentation": "

    The DNS address of the cluster.

    " } }, - "VpcId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Port": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The ID of the VPC.

    " + "smithy.api#documentation": "

    The port that the database engine listens on.

    " } } }, "traits": { - "smithy.api#documentation": "

    The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.

    " + "smithy.api#documentation": "

    The connection endpoint for an Amazon Redshift cluster.

    " } }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { + "com.amazonaws.securityhub#AwsRedshiftClusterHsmStatus": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber", + "HsmConfigurationIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The version number.

    " + "smithy.api#documentation": "

    The name of the HSM configuration that contains the information that the Amazon Redshift\n cluster can use to retrieve and store keys in an HSM.

    " } }, - "CreatedDate": { + "HsmClientCertificateIdentifier": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date that the version was created, in ISO 8601 format. For example,\n 2018-11-27T15:10:45.123+0000.

    " + "smithy.api#documentation": "

    The name of the HSM client certificate that the Amazon Redshift cluster uses to retrieve\n the data encryption keys that are stored in an HSM.

    " } }, - "CompatibleRuntimes": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The layer's compatible runtimes. Maximum number of five items.

    \n

    Valid values: nodejs10.x | nodejs12.x | java8 |\n java11 | python2.7 | python3.6 |\n python3.7 | python3.8 | dotnetcore1.0 |\n dotnetcore2.1 | go1.x | ruby2.5 |\n provided\n

    " + "smithy.api#documentation": "

    Indicates whether the Amazon Redshift cluster has finished applying any HSM settings\n changes specified in a modify cluster command.

    \n

    Type: String

    \n

    Valid values: active | applying\n

    " } } }, "traits": { - "smithy.api#documentation": "

    Details about a Lambda layer version.

    " + "smithy.api#documentation": "

    Information about whether an Amazon Redshift cluster finished applying any hardware\n changes to security module (HSM) settings that were specified in a modify cluster\n command.

    " } }, - "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { - "type": "long" - }, - "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole": { + "com.amazonaws.securityhub#AwsRedshiftClusterIamRole": { "type": "structure", "members": { - "FeatureName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The name of the feature associated with the IAM)role.

    " - } - }, - "RoleArn": { + "ApplyStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

    " + "smithy.api#documentation": "

    The status of the IAM role's association with the cluster.

    \n

    Valid values: in-sync | adding | removing\n

    " } }, - "Status": { + "IamRoleArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Describes the state of the association between the IAM role and the DB instance. The\n Status property returns one of the following values:

    \n
      \n
    • \n

      \n ACTIVE - The IAM role ARN is associated with the DB instance and can\n be used to access other AWS services on your behalf.

      \n
      • \n
    • \n

      \n PENDING - The IAM role ARN is being associated with the DB\n instance.

      \n
      • \n
    • \n

      \n INVALID - The IAM role ARN is associated with the DB instance. But\n the DB instance is unable to assume the IAM role in order to access other AWS\n services on your behalf.

      \n
      • \n
    " + "smithy.api#documentation": "

    The ARN of the IAM role.

    " } } }, "traits": { - "smithy.api#documentation": "

    An AWS Identity and Access Management (IAM) role associated with the DB instance.

    " + "smithy.api#documentation": "

    An IAM role that the cluster can use to access other AWS services.

    " } }, - "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles": { + "com.amazonaws.securityhub#AwsRedshiftClusterIamRoles": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRole" + "target": "com.amazonaws.securityhub#AwsRedshiftClusterIamRole" } }, - "com.amazonaws.securityhub#AwsRdsDbInstanceDetails": { + "com.amazonaws.securityhub#AwsRedshiftClusterPendingModifiedValues": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint", - "traits": { - "smithy.api#documentation": "

    Specifies the connection endpoint.

    " - } - }, - "DbiResourceId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The AWS Region-unique, immutable identifier for the DB instance. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is\n accessed.

    " - } - }, - "DBName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The meaning of this parameter differs according to the database engine you use.

    \n

    \n MySQL, MariaDB, SQL Server, PostgreSQL\n

    \n

    Contains the name of the initial database of this instance that was provided at create\n time, if one was specified when the DB instance was created. This same name is returned for\n the life of the DB instance.

    \n

    \n Oracle\n

    \n

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the\n returned parameters do not apply to an Oracle DB instance.

    " - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The identifier of the CA certificate for this DB instance.

    " - } - }, - "DbInstancePort": { + "NumberOfNodes": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB\n cluster, this can be a different port than the DB cluster port.

    " - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted\n DB instance.

    " - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups", - "traits": { - "smithy.api#documentation": "

    A list of VPC security groups that the DB instance belongs to.

    " + "smithy.api#documentation": "

    The pending or in-progress change to the number of nodes in the cluster.

    " } }, - "DeletionProtection": { - "target": "com.amazonaws.securityhub#Boolean", + "AutomatedSnapshotRetentionPeriod": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    Indicates whether the DB instance has deletion protection enabled.

    \n

    When deletion protection is enabled, the database cannot be deleted.

    " + "smithy.api#documentation": "

    The pending or in-progress change to the automated snapshot retention period.

    " } }, - "IAMDatabaseAuthenticationEnabled": { + "EnhancedVpcRouting": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    True if mapping of AWS Identity and Access Management (IAM) accounts to database\n accounts is enabled, and otherwise false.

    \n

    IAM database authentication can be enabled for the following database engines.

    \n
      \n
    • \n

      For MySQL 5.6, minor version 5.6.34 or higher

      \n
      • \n
    • \n

      For MySQL 5.7, minor version 5.7.16 or higher

      \n
      • \n
    • \n

      Aurora 5.6 or higher

      \n
      • \n
    " + "smithy.api#documentation": "

    Indicates whether to create the cluster with enhanced VPC routing enabled.

    " } }, - "StorageEncrypted": { - "target": "com.amazonaws.securityhub#Boolean", + "MaintenanceTrackName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Specifies whether the DB instance is encrypted.

    " + "smithy.api#documentation": "

    The name of the maintenance track that the cluster changes to during the next\n maintenance window.

    " } }, - "DBClusterIdentifier": { + "NodeType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that\n the DB instance is a member of.

    " + "smithy.api#documentation": "

    The pending or in-progress change to the cluster's node type.

    " } }, - "DBInstanceClass": { + "MasterUserPassword": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Contains the name of the compute and memory capacity class of the DB instance.

    " + "smithy.api#documentation": "

    The pending or in-progress change to the master user password for the cluster.

    " } }, - "Engine": { + "EncryptionType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Provides the name of the database engine to use for this DB instance.

    " + "smithy.api#documentation": "

    The encryption type for a cluster.

    " } }, - "TdeCredentialArn": { + "ClusterVersion": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN from the key store with which the instance is associated for TDE\n encryption.

    " + "smithy.api#documentation": "

    The pending or in-progress change to the service version.

    " } }, - "InstanceCreateTime": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "PubliclyAccessible": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    Provides the date and time the DB instance was created.

    " + "smithy.api#documentation": "

    The pending or in-progress change to whether the cluster can be connected to from the\n public network.

    " } }, - "DBInstanceIdentifier": { + "ClusterIdentifier": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Contains a user-supplied database identifier. This identifier is the unique key that\n identifies a DB instance.

    " + "smithy.api#documentation": "

    The pending or in-progress change to the identifier for the cluster.

    " } }, - "AssociatedRoles": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceAssociatedRoles", + "ClusterType": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The AWS Identity and Access Management (IAM) roles associated with the DB\n instance.

    " + "smithy.api#documentation": "

    The pending or in-progress change to the cluster type.

    " } - }, - "EngineVersion": { + } + }, + "traits": { + "smithy.api#documentation": "

    Changes to the Amazon Redshift cluster that are currently pending.

    " + } + }, + "com.amazonaws.securityhub#AwsRedshiftClusterResizeInfo": { + "type": "structure", + "members": { + "ResizeType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Indicates the database engine version.

    " + "smithy.api#documentation": "

    The type of resize operation.

    \n

    Valid values: ClassicResize\n

    " } }, - "PubliclyAccessible": { + "AllowCancelResize": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

    Specifies the accessibility options for the DB instance.

    \n

    A value of true specifies an Internet-facing instance with a publicly resolvable DNS\n name, which resolves to a public IP address.

    \n

    A value of false specifies an internal instance with a DNS name that resolves to a\n private IP address.

    " + "smithy.api#documentation": "

    Indicates whether the resize operation can be canceled.

    " } } }, "traits": { - "smithy.api#documentation": "

    Contains the details of an Amazon RDS DB instance.

    " + "smithy.api#documentation": "

    Information about the resize operation for the cluster.

    " } }, - "com.amazonaws.securityhub#AwsRdsDbInstanceEndpoint": { + "com.amazonaws.securityhub#AwsRedshiftClusterRestoreStatus": { "type": "structure", "members": { - "Address": { + "SnapshotSizeInMegaBytes": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#documentation": "

    The size of the set of snapshot data that was used to restore the cluster.

    \n

    This field is only updated when you restore to DC2 and DS2 node types.

    " + } + }, + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Specifies the DNS address of the DB instance.

    " + "smithy.api#documentation": "

    The status of the restore action.

    \n

    Valid values: starting | restoring | completed |\n failed\n

    " } }, - "Port": { - "target": "com.amazonaws.securityhub#Integer", + "ProgressInMegaBytes": { + "target": "com.amazonaws.securityhub#Long", "traits": { - "smithy.api#documentation": "

    Specifies the port that the database engine is listening on.

    " + "smithy.api#documentation": "

    The number of megabytes that were transferred from snapshot storage.

    \n

    This field is only updated when you restore to DC2 and DS2 node types.

    " } }, - "HostedZoneId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "CurrentRestoreRateInMegaBytesPerSecond": { + "target": "com.amazonaws.securityhub#Double", "traits": { - "smithy.api#documentation": "

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " + "smithy.api#documentation": "

    The number of megabytes per second being transferred from the backup storage. Returns\n the average rate for a completed backup.

    \n

    This field is only updated when you restore to DC2 and DS2 node types.

    " + } + }, + "EstimatedTimeToCompletionInSeconds": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#documentation": "

    The estimate of the time remaining before the restore is complete. Returns 0 for a\n completed restore.

    \n

    This field is only updated when you restore to DC2 and DS2 node types.

    " + } + }, + "ElapsedTimeInSeconds": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#documentation": "

    The amount of time an in-progress restore has been running, or the amount of time it\n took a completed restore to finish.

    \n

    This field is only updated when you restore to DC2 and DS2 node types.

    " } } }, "traits": { - "smithy.api#documentation": "

    Specifies the connection endpoint.

    " + "smithy.api#documentation": "

    Information about the status of a cluster restore action. It only applies if the cluster\n was created by restoring a snapshot.

    " } }, - "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup": { + "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup": { "type": "structure", "members": { - "VpcSecurityGroupId": { + "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the VPC security group.

    " + "smithy.api#documentation": "

    The status of the VPC security group.

    " } }, - "Status": { + "VpcSecurityGroupId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The status of the VPC security group.

    " + "smithy.api#documentation": "

    The identifier of the VPC security group.

    " } } }, "traits": { - "smithy.api#documentation": "

    A VPC security groups that the DB instance belongs to.

    " + "smithy.api#documentation": "

    A VPC security group that the cluster belongs to, if the cluster is in a VPC.

    " } }, - "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroups": { + "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroups": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceVpcSecurityGroup" + "target": "com.amazonaws.securityhub#AwsRedshiftClusterVpcSecurityGroup" } }, "com.amazonaws.securityhub#AwsS3BucketDetails": { @@ -1924,16 +6554,16 @@ "smithy.api#documentation": "

    The canonical user ID of the owner of the S3 bucket.

    " } }, - "OwnerName": { + "CreatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The display name of the owner of the S3 bucket.

    " + "smithy.api#documentation": "

    Indicates when the S3 bucket was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "CreatedAt": { + "OwnerName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time when the S3 bucket was created.

    " + "smithy.api#documentation": "

    The display name of the owner of the S3 bucket.

    " } } }, @@ -2010,16 +6640,22 @@ "smithy.api#documentation": "

    The identifier of the AWS Key Management Service (AWS KMS) symmetric customer managed\n customer master key (CMK) that was used for the object.

    " } }, - "VersionId": { + "ContentType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The version of the object.

    " + "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    " } }, "LastModified": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time when the object was last modified.

    " + "smithy.api#documentation": "

    Indicates when the object was last modified.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "VersionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version of the object.

    " } }, "ETag": { @@ -2027,39 +6663,109 @@ "traits": { "smithy.api#documentation": "

    The opaque identifier assigned by a web server to a specific version of a resource found\n at a URL.

    " } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about an Amazon S3 object.

    " + } + }, + "com.amazonaws.securityhub#AwsSecretsManagerSecretDetails": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The user-provided description of the secret.

    " + } }, - "ContentType": { + "RotationEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether rotation is enabled.

    " + } + }, + "RotationOccurredWithinFrequency": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the rotation occurred within the specified rotation frequency.

    " + } + }, + "RotationLambdaArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of the Lambda function that rotates the secret.

    " + } + }, + "RotationRules": { + "target": "com.amazonaws.securityhub#AwsSecretsManagerSecretRotationRules", + "traits": { + "smithy.api#documentation": "

    Defines the rotation schedule for the secret.

    " + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The name of the secret.

    " + } + }, + "Deleted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the secret is deleted.

    " + } + }, + "KmsKeyId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A standard MIME type describing the format of the object data.

    " + "smithy.api#documentation": "

    The ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the\n SecretString or SecretBinary values for versions of this\n secret.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details about an AWS Secrets Manager secret.

    " + } + }, + "com.amazonaws.securityhub#AwsSecretsManagerSecretRotationRules": { + "type": "structure", + "members": { + "AutomaticallyAfterDays": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of days after the previous rotation to rotate the secret.

    " } } }, "traits": { - "smithy.api#documentation": "

    Details about an Amazon S3 object.

    " + "smithy.api#documentation": "

    Defines the rotation schedule for the secret.

    " } }, "com.amazonaws.securityhub#AwsSecurityFinding": { "type": "structure", "members": { - "Types": { - "target": "com.amazonaws.securityhub#TypeList", + "ProductArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    One or more finding types in the format of namespace/category/classifier\n that classify a finding.

    \n

    Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

    ", + "smithy.api#documentation": "

    The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

    ", "smithy.api#required": {} } }, - "ProductArn": { + "CreatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

    ", + "smithy.api#documentation": "

    Indicates when the security-findings provider created the potential security issue that\n a finding captured.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    ", "smithy.api#required": {} } }, - "SourceUrl": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Criticality": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    A URL that links to a page about the current finding in the security-findings provider's\n solution.

    " + "smithy.api#documentation": "

    The level of importance assigned to the resources associated with the finding.

    \n

    A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

    " + } + }, + "Compliance": { + "target": "com.amazonaws.securityhub#Compliance", + "traits": { + "smithy.api#documentation": "

    This data type is exclusive to findings that are generated as the result of a check run\n against a specific rule in a supported security standard, such as CIS AWS Foundations.\n Contains security standard-related finding details.

    " } }, "ThreatIntelIndicators": { @@ -2068,92 +6774,91 @@ "smithy.api#documentation": "

    Threat intelligence details related to a finding.

    " } }, - "Description": { + "Id": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A finding's description.

    \n \n

    In this release, Description is a required property.

    \n     ", + "smithy.api#documentation": "

    The security findings provider-specific identifier for a finding.

    ", "smithy.api#required": {} } }, - "Vulnerabilities": { - "target": "com.amazonaws.securityhub#VulnerabilityList", + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Provides a list of vulnerabilities associated with the findings.

    " + "smithy.api#documentation": "

    A finding's description.

    \n \n

    In this release, Description is a required property.

    \n     ", + "smithy.api#required": {} } }, - "Criticality": { - "target": "com.amazonaws.securityhub#Integer", + "SourceUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The level of importance assigned to the resources associated with the finding.

    \n

    A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

    " + "smithy.api#documentation": "

    A URL that links to a page about the current finding in the security-findings provider's\n solution.

    " } }, - "VerificationState": { - "target": "com.amazonaws.securityhub#VerificationState", + "FirstObservedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Indicates the veracity of a finding.

    " + "smithy.api#documentation": "

    Indicates when the security-findings provider first observed the potential security\n issue that a finding captured.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "Resources": { - "target": "com.amazonaws.securityhub#ResourceList", + "LastObservedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A set of resource data types that describe the resources that the finding refers\n to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates when the security-findings provider most recently observed the potential\n security issue that a finding captured.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "Network": { - "target": "com.amazonaws.securityhub#Network", + "Process": { + "target": "com.amazonaws.securityhub#ProcessDetails", "traits": { - "smithy.api#documentation": "

    The details of network-related information about a finding.

    " + "smithy.api#documentation": "

    The details of process-related information about a finding.

    " } }, - "Malware": { - "target": "com.amazonaws.securityhub#MalwareList", + "Vulnerabilities": { + "target": "com.amazonaws.securityhub#VulnerabilityList", "traits": { - "smithy.api#documentation": "

    A list of malware related to a finding.

    " + "smithy.api#documentation": "

    Provides a list of vulnerabilities associated with the findings.

    " } }, - "NetworkPath": { - "target": "com.amazonaws.securityhub#NetworkPathList", + "UserDefinedFields": { + "target": "com.amazonaws.securityhub#FieldMap", "traits": { - "smithy.api#documentation": "

    Provides information about a network path that is relevant to a finding. Each entry\n under NetworkPath represents a component of that path.

    " + "smithy.api#documentation": "

    A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

    " } }, - "Workflow": { - "target": "com.amazonaws.securityhub#Workflow", + "Types": { + "target": "com.amazonaws.securityhub#TypeList", "traits": { - "smithy.api#documentation": "

    Provides information about the status of the investigation into a finding.

    " + "smithy.api#documentation": "

    One or more finding types in the format of namespace/category/classifier\n that classify a finding.

    \n

    Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual\n Behaviors | Sensitive Data Identifications

    ", + "smithy.api#required": {} } }, - "Process": { - "target": "com.amazonaws.securityhub#ProcessDetails", + "Network": { + "target": "com.amazonaws.securityhub#Network", "traits": { - "smithy.api#documentation": "

    The details of process-related information about a finding.

    " + "smithy.api#documentation": "

    The details of network-related information about a finding.

    " } }, - "RelatedFindings": { - "target": "com.amazonaws.securityhub#RelatedFindingList", + "Confidence": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    A list of related findings.

    " + "smithy.api#documentation": "

    A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

    \n

    Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

    " } }, - "FirstObservedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "VerificationState": { + "target": "com.amazonaws.securityhub#VerificationState", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider first\n observed the potential security issue that a finding captured.

    " + "smithy.api#documentation": "

    Indicates the veracity of a finding.

    " } }, - "Severity": { - "target": "com.amazonaws.securityhub#Severity", + "Remediation": { + "target": "com.amazonaws.securityhub#Remediation", "traits": { - "smithy.api#documentation": "

    A finding's severity.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A data type that describes the remediation options for a finding.

    " } }, - "SchemaVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ProductFields": { + "target": "com.amazonaws.securityhub#FieldMap", "traits": { - "smithy.api#documentation": "

    The schema version that a finding is formatted for.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A data type where security-findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.

    " } }, "RecordState": { @@ -2162,16 +6867,17 @@ "smithy.api#documentation": "

    The record state of a finding.

    " } }, - "ProductFields": { - "target": "com.amazonaws.securityhub#FieldMap", + "Malware": { + "target": "com.amazonaws.securityhub#MalwareList", "traits": { - "smithy.api#documentation": "

    A data type where security-findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.

    " + "smithy.api#documentation": "

    A list of malware related to a finding.

    " } }, - "Remediation": { - "target": "com.amazonaws.securityhub#Remediation", + "SchemaVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A data type that describes the remediation options for a finding.

    " + "smithy.api#documentation": "

    The schema version that a finding is formatted for.

    ", + "smithy.api#required": {} } }, "Title": { @@ -2181,76 +6887,76 @@ "smithy.api#required": {} } }, - "Confidence": { - "target": "com.amazonaws.securityhub#Integer", + "RelatedFindings": { + "target": "com.amazonaws.securityhub#RelatedFindingList", "traits": { - "smithy.api#documentation": "

    A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

    \n

    Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

    " + "smithy.api#documentation": "

    A list of related findings.

    " } }, - "LastObservedAt": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "NetworkPath": { + "target": "com.amazonaws.securityhub#NetworkPathList", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider most\n recently observed the potential security issue that a finding captured.

    " + "smithy.api#documentation": "

    Provides information about a network path that is relevant to a finding. Each entry\n under NetworkPath represents a component of that path.

    " } }, - "AwsAccountId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Severity": { + "target": "com.amazonaws.securityhub#Severity", "traits": { - "smithy.api#documentation": "

    The AWS account ID that a finding is generated in.

    ", + "smithy.api#documentation": "

    A finding's severity.

    ", "smithy.api#required": {} } }, - "Id": { + "GeneratorId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The security findings provider-specific identifier for a finding.

    ", + "smithy.api#documentation": "

    The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security-findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

    ", "smithy.api#required": {} } }, - "UserDefinedFields": { - "target": "com.amazonaws.securityhub#FieldMap", - "traits": { - "smithy.api#documentation": "

    A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

    " - } - }, - "WorkflowState": { - "target": "com.amazonaws.securityhub#WorkflowState", + "Workflow": { + "target": "com.amazonaws.securityhub#Workflow", "traits": { - "smithy.api#documentation": "

    The workflow state of a finding.

    " + "smithy.api#documentation": "

    Provides information about the status of the investigation into a finding.

    " } }, "UpdatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider last\n updated the finding record.

    ", + "smithy.api#documentation": "

    Indicates when the security-findings provider last updated the finding record.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    ", "smithy.api#required": {} } }, - "Compliance": { - "target": "com.amazonaws.securityhub#Compliance", - "traits": { - "smithy.api#documentation": "

    This data type is exclusive to findings that are generated as the result of a check run\n against a specific rule in a supported security standard, such as CIS AWS Foundations.\n Contains security standard-related finding details.

    " - } - }, "Note": { "target": "com.amazonaws.securityhub#Note", "traits": { "smithy.api#documentation": "

    A user-defined note added to a finding.

    " } }, - "CreatedAt": { + "WorkflowState": { + "target": "com.amazonaws.securityhub#WorkflowState", + "traits": { + "smithy.api#documentation": "

    The workflow state of a finding.

    " + } + }, + "AwsAccountId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider\n created the potential security issue that a finding captured.

    ", + "smithy.api#documentation": "

    The AWS account ID that a finding is generated in.

    ", "smithy.api#required": {} } }, - "GeneratorId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Resources": { + "target": "com.amazonaws.securityhub#ResourceList", "traits": { - "smithy.api#documentation": "

    The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security-findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

    ", + "smithy.api#documentation": "

    A set of resource data types that describe the resources that the finding refers\n to.

    ", "smithy.api#required": {} } + }, + "PatchSummary": { + "target": "com.amazonaws.securityhub#PatchSummary", + "traits": { + "smithy.api#documentation": "

    Provides an overview of the patch compliance status for an instance against a selected\n compliance standard.

    " + } } }, "traits": { @@ -2260,34 +6966,34 @@ "com.amazonaws.securityhub#AwsSecurityFindingFilters": { "type": "structure", "members": { - "ProcessPath": { + "ResourcePartition": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The path to the process executable.

    " + "smithy.api#documentation": "

    The canonical AWS partition name that the Region is assigned to.

    " } }, - "NetworkProtocol": { + "ProcessPath": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The protocol of network-related information about a finding.

    " + "smithy.api#documentation": "

    The path to the process executable.

    " } }, - "ResourceAwsEc2InstanceIpV4Addresses": { - "target": "com.amazonaws.securityhub#IpFilterList", + "NetworkSourceMac": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The IPv4 addresses associated with the instance.

    " + "smithy.api#documentation": "

    The source media access control (MAC) address of network-related information about a\n finding.

    " } }, - "ResourcePartition": { - "target": "com.amazonaws.securityhub#StringFilterList", + "Keyword": { + "target": "com.amazonaws.securityhub#KeywordFilterList", "traits": { - "smithy.api#documentation": "

    The canonical AWS partition name that the Region is assigned to.

    " + "smithy.api#documentation": "

    A keyword for a finding.

    " } }, - "ResourceAwsIamAccessKeyCreatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", + "RecommendationText": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The creation date/time of the IAM access key related to a finding.

    " + "smithy.api#documentation": "

    The recommendation of what to do about the issue described in a finding.

    " } }, "RelatedFindingsId": { @@ -2296,16 +7002,16 @@ "smithy.api#documentation": "

    The solution-generated identifier for a related finding.

    " } }, - "ResourceType": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ProcessTerminatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    Specifies the type of the resource that details are provided for.

    " + "smithy.api#documentation": "

    The date/time that the process was terminated.

    " } }, - "NetworkSourceIpV4": { - "target": "com.amazonaws.securityhub#IpFilterList", + "ResourceAwsEc2InstanceLaunchedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    The source IPv4 address of network-related information about a finding.

    " + "smithy.api#documentation": "

    The date and time the instance was launched.

    " } }, "NetworkSourceIpV6": { @@ -2314,82 +7020,52 @@ "smithy.api#documentation": "

    The source IPv6 address of network-related information about a finding.

    " } }, - "NoteUpdatedBy": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

    The principal that created a note.

    " - } - }, - "NetworkDirection": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

    Indicates the direction of network traffic associated with a finding.

    " - } - }, - "ResourceAwsEc2InstanceVpcId": { - "target": "com.amazonaws.securityhub#StringFilterList", - "traits": { - "smithy.api#documentation": "

    The identifier of the VPC that the instance was launched in.

    " - } - }, - "NetworkSourcePort": { - "target": "com.amazonaws.securityhub#NumberFilterList", - "traits": { - "smithy.api#documentation": "

    The source port of network-related information about a finding.

    " - } - }, - "ThreatIntelIndicatorType": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ResourceAwsEc2InstanceIpV4Addresses": { + "target": "com.amazonaws.securityhub#IpFilterList", "traits": { - "smithy.api#documentation": "

    The type of a threat intelligence indicator.

    " + "smithy.api#documentation": "

    The IPv4 addresses associated with the instance.

    " } }, - "FirstObservedAt": { + "ResourceAwsIamAccessKeyCreatedAt": { "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider first\n observed the potential security issue that a finding captured.

    " + "smithy.api#documentation": "

    The creation date/time of the IAM access key related to a finding.

    " } }, - "ThreatIntelIndicatorValue": { + "NetworkProtocol": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The value of a threat intelligence indicator.

    " + "smithy.api#documentation": "

    The protocol of network-related information about a finding.

    " } }, - "SeverityNormalized": { - "target": "com.amazonaws.securityhub#NumberFilterList", + "NetworkSourceIpV4": { + "target": "com.amazonaws.securityhub#IpFilterList", "traits": { - "smithy.api#documentation": "

    The normalized severity of a finding.

    " + "smithy.api#documentation": "

    The source IPv4 address of network-related information about a finding.

    " } }, - "ResourceContainerLaunchedAt": { + "NoteUpdatedAt": { "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    The date/time that the container was started.

    " + "smithy.api#documentation": "

    The timestamp of when the note was updated.

    " } }, - "ResourceAwsS3BucketOwnerName": { + "NetworkDirection": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The display name of the owner of the S3 bucket.

    " - } - }, - "ProcessLaunchedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", - "traits": { - "smithy.api#documentation": "

    The date/time that the process was launched.

    " + "smithy.api#documentation": "

    Indicates the direction of network traffic associated with a finding.

    " } }, - "Id": { + "ThreatIntelIndicatorValue": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The security findings provider-specific identifier for a finding.

    " + "smithy.api#documentation": "

    The value of a threat intelligence indicator.

    " } }, - "ResourceAwsIamAccessKeyUserName": { + "ResourceType": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The user associated with the IAM access key related to a finding.

    " + "smithy.api#documentation": "

    Specifies the type of the resource that details are provided for.

    " } }, "Criticality": { @@ -2398,160 +7074,172 @@ "smithy.api#documentation": "

    The level of importance assigned to the resources associated with the finding.

    \n

    A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

    " } }, - "NetworkDestinationPort": { - "target": "com.amazonaws.securityhub#NumberFilterList", + "ResourceAwsIamAccessKeyUserName": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The destination port of network-related information about a finding.

    " + "smithy.api#documentation": "

    The user associated with the IAM access key related to a finding.

    " } }, - "ResourceTags": { - "target": "com.amazonaws.securityhub#MapFilterList", + "Description": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    A list of AWS tags associated with a resource at the time the finding was\n processed.

    " + "smithy.api#documentation": "

    A finding's description.

    " } }, - "ResourceAwsEc2InstanceIamInstanceProfileArn": { - "target": "com.amazonaws.securityhub#StringFilterList", + "FirstObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    The IAM profile ARN of the instance.

    " + "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider first\n observed the potential security issue that a finding captured.

    " } }, - "NetworkDestinationIpV6": { - "target": "com.amazonaws.securityhub#IpFilterList", + "ProductName": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The destination IPv6 address of network-related information about a finding.

    " + "smithy.api#documentation": "

    The name of the solution (product) that generates findings.

    " } }, - "NoteUpdatedAt": { + "LastObservedAt": { "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    The timestamp of when the note was updated.

    " + "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider most\n recently observed the potential security issue that a finding captured.

    " } }, - "ResourceContainerImageId": { + "SourceUrl": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The identifier of the image related to a finding.

    " + "smithy.api#documentation": "

    A URL that links to a page about the current finding in the security-findings provider's\n solution.

    " } }, - "NetworkDestinationIpV4": { - "target": "com.amazonaws.securityhub#IpFilterList", + "ProcessName": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The destination IPv4 address of network-related information about a finding.

    " + "smithy.api#documentation": "

    The name of the process.

    " } }, - "MalwareType": { + "ResourceContainerName": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The type of the malware that was observed.

    " + "smithy.api#documentation": "

    The name of the container related to a finding.

    " } }, - "ProcessParentPid": { - "target": "com.amazonaws.securityhub#NumberFilterList", + "ResourceAwsEc2InstanceKeyName": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The parent process ID.

    " + "smithy.api#documentation": "

    The key name associated with the instance.

    " } }, - "ThreatIntelIndicatorSource": { + "ResourceAwsS3BucketOwnerId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The source of the threat intelligence.

    " + "smithy.api#documentation": "

    The canonical user ID of the owner of the S3 bucket.

    " } }, - "ResourceAwsEc2InstanceLaunchedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", + "ResourceRegion": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The date and time the instance was launched.

    " + "smithy.api#documentation": "

    The canonical AWS external Region name where this resource is located.

    " } }, - "RecommendationText": { + "ThreatIntelIndicatorSourceUrl": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The recommendation of what to do about the issue described in a finding.

    " + "smithy.api#documentation": "

    The URL for more details from the source of the threat intelligence.

    " } }, - "ResourceDetailsOther": { + "UserDefinedFields": { "target": "com.amazonaws.securityhub#MapFilterList", "traits": { - "smithy.api#documentation": "

    The details of a resource that doesn't have a specific subfield for the resource type\n defined.

    " + "smithy.api#documentation": "

    A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

    " } }, - "ComplianceStatus": { + "UpdatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider last\n updated the finding record.

    " + } + }, + "NoteText": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    Exclusive to findings that are generated as the result of a check run against a specific\n rule in a supported standard, such as CIS AWS Foundations. Contains security\n standard-related finding details.

    " + "smithy.api#documentation": "

    The text of a note.

    " } }, - "ProcessTerminatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", + "ThreatIntelIndicatorType": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The date/time that the process was terminated.

    " + "smithy.api#documentation": "

    The type of a threat intelligence indicator.

    " } }, - "ResourceAwsEc2InstanceType": { + "NetworkDestinationDomain": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The instance type of the instance.

    " + "smithy.api#documentation": "

    The destination domain of network-related information about a finding.

    " } }, - "CreatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", + "ResourceId": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider\n captured the potential security issue that a finding captured.

    " + "smithy.api#documentation": "

    The canonical identifier for the given resource type.

    " } }, - "ProcessPid": { - "target": "com.amazonaws.securityhub#NumberFilterList", + "GeneratorId": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The process ID.

    " + "smithy.api#documentation": "

    The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security-findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

    " } }, - "MalwareState": { + "Title": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The state of the malware that was observed.

    " + "smithy.api#documentation": "

    A finding's title.

    " } }, - "MalwarePath": { + "WorkflowState": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The filesystem path of the malware that was observed.

    " + "smithy.api#documentation": "

    The workflow state of a finding.

    \n

    Note that this field is deprecated. To search for a finding based on its workflow\n status, use WorkflowStatus.

    " } }, - "ResourceContainerImageName": { + "MalwareName": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The name of the image related to a finding.

    " + "smithy.api#documentation": "

    The name of the malware that was observed.

    " } }, - "WorkflowStatus": { + "Type": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The status of the investigation into a finding. Allowed values are the following.

    \n
      \n
    • \n

      \n NEW - The initial state of a finding, before it is reviewed.

      \n
      • \n
    • \n

      \n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.

      \n
      • \n
    • \n

      \n SUPPRESSED - The finding will not be reviewed again and will not be\n acted upon.

      \n
      • \n
    • \n

      \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

      \n
      • \n
    " + "smithy.api#documentation": "

    A finding type in the format of namespace/category/classifier that\n classifies a finding.

    " } }, - "AwsAccountId": { + "ResourceAwsEc2InstanceIpV6Addresses": { + "target": "com.amazonaws.securityhub#IpFilterList", + "traits": { + "smithy.api#documentation": "

    The IPv6 addresses associated with the instance.

    " + } + }, + "RecordState": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The AWS account ID that a finding is generated in.

    " + "smithy.api#documentation": "

    The updated record state for the finding.

    " } }, - "SeverityLabel": { + "MalwarePath": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The label of a finding's severity.

    " + "smithy.api#documentation": "

    The filesystem path of the malware that was observed.

    " } }, - "RelatedFindingsProductArn": { + "AwsAccountId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The ARN of the solution that generated a related finding.

    " + "smithy.api#documentation": "

    The AWS account ID that a finding is generated in.

    " } }, - "Title": { + "ResourceContainerImageName": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    A finding's title.

    " + "smithy.api#documentation": "

    The name of the image related to a finding.

    " } }, "ThreatIntelIndicatorCategory": { @@ -2560,16 +7248,22 @@ "smithy.api#documentation": "

    The category of a threat intelligence indicator.

    " } }, - "ResourceId": { + "ResourceAwsEc2InstanceSubnetId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The canonical identifier for the given resource type.

    " + "smithy.api#documentation": "

    The identifier of the subnet that the instance was launched in.

    " } }, - "ResourceAwsEc2InstanceSubnetId": { + "WorkflowStatus": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The identifier of the subnet that the instance was launched in.

    " + "smithy.api#documentation": "

    The status of the investigation into a finding. Allowed values are the following.

    \n
      \n
    • \n

      \n NEW - The initial state of a finding, before it is reviewed.

      \n
      • \n
    • \n

      \n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.

      \n
      • \n
    • \n

      \n SUPPRESSED - The finding will not be reviewed again and will not be\n acted upon.

      \n
      • \n
    • \n

      \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

      \n
      • \n
    " + } + }, + "ComplianceStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

    Exclusive to findings that are generated as the result of a check run against a specific\n rule in a supported standard, such as CIS AWS Foundations. Contains security\n standard-related finding details.

    " } }, "ProductFields": { @@ -2578,22 +7272,34 @@ "smithy.api#documentation": "

    A data type where security-findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.

    " } }, - "RecordState": { + "VerificationState": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The updated record state for the finding.

    " + "smithy.api#documentation": "

    The veracity of a finding.

    " } }, - "ResourceAwsEc2InstanceImageId": { + "Confidence": { + "target": "com.amazonaws.securityhub#NumberFilterList", + "traits": { + "smithy.api#documentation": "

    A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

    \n

    Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

    " + } + }, + "ResourceAwsIamAccessKeyStatus": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The Amazon Machine Image (AMI) ID of the instance.

    " + "smithy.api#documentation": "

    The status of the IAM access key related to a finding.

    " } }, - "CompanyName": { + "ProductArn": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The name of the findings provider (company) that owns the solution (product) that\n generates findings.

    " + "smithy.api#documentation": "

    The ARN generated by Security Hub that uniquely identifies a third-party company\n (security findings provider) after this provider's product (solution that generates\n findings) is registered with Security Hub.

    " + } + }, + "NetworkSourceDomain": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

    The source domain of network-related information about a finding.

    " } }, "SeverityProduct": { @@ -2602,187 +7308,187 @@ "smithy.api#documentation": "

    The native severity as defined by the security-findings provider's solution that\n generated the finding.

    " } }, - "ResourceAwsIamAccessKeyStatus": { + "CompanyName": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The status of the IAM access key related to a finding.

    " + "smithy.api#documentation": "

    The name of the findings provider (company) that owns the solution (product) that\n generates findings.

    " } }, - "ProductArn": { + "RelatedFindingsProductArn": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The ARN generated by Security Hub that uniquely identifies a third-party company\n (security findings provider) after this provider's product (solution that generates\n findings) is registered with Security Hub.

    " + "smithy.api#documentation": "

    The ARN of the solution that generated a related finding.

    " } }, - "ResourceRegion": { + "ResourceAwsS3BucketOwnerName": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The canonical AWS external Region name where this resource is located.

    " + "smithy.api#documentation": "

    The display name of the owner of the S3 bucket.

    " } }, - "ThreatIntelIndicatorLastObservedAt": { + "ResourceContainerLaunchedAt": { "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    The date/time of the last observation of a threat intelligence indicator.

    " + "smithy.api#documentation": "

    The date/time that the container was started.

    " } }, - "UserDefinedFields": { - "target": "com.amazonaws.securityhub#MapFilterList", + "SeverityNormalized": { + "target": "com.amazonaws.securityhub#NumberFilterList", "traits": { - "smithy.api#documentation": "

    A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

    " + "smithy.api#documentation": "

    The normalized severity of a finding.

    " } }, - "Description": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ProcessLaunchedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    A finding's description.

    " + "smithy.api#documentation": "

    The date/time that the process was launched.

    " } }, - "LastObservedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", + "Id": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider most\n recently observed the potential security issue that a finding captured.

    " + "smithy.api#documentation": "

    The security findings provider-specific identifier for a finding.

    " } }, - "MalwareName": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ResourceDetailsOther": { + "target": "com.amazonaws.securityhub#MapFilterList", "traits": { - "smithy.api#documentation": "

    The name of the malware that was observed.

    " + "smithy.api#documentation": "

    The details of a resource that doesn't have a specific subfield for the resource type\n defined.

    " } }, - "ThreatIntelIndicatorSourceUrl": { + "MalwareState": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The URL for more details from the source of the threat intelligence.

    " + "smithy.api#documentation": "

    The state of the malware that was observed.

    " } }, - "Type": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ProcessPid": { + "target": "com.amazonaws.securityhub#NumberFilterList", "traits": { - "smithy.api#documentation": "

    A finding type in the format of namespace/category/classifier that\n classifies a finding.

    " + "smithy.api#documentation": "

    The process ID.

    " } }, - "ResourceAwsEc2InstanceKeyName": { + "ResourceAwsEc2InstanceType": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The key name associated with the instance.

    " + "smithy.api#documentation": "

    The instance type of the instance.

    " } }, - "ResourceContainerName": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ThreatIntelIndicatorLastObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    The name of the container related to a finding.

    " + "smithy.api#documentation": "

    The date/time of the last observation of a threat intelligence indicator.

    " } }, - "ResourceAwsEc2InstanceIpV6Addresses": { - "target": "com.amazonaws.securityhub#IpFilterList", + "CreatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "

    The IPv6 addresses associated with the instance.

    " + "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider\n captured the potential security issue that a finding captured.

    " } }, - "SourceUrl": { + "ThreatIntelIndicatorSource": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    A URL that links to a page about the current finding in the security-findings provider's\n solution.

    " + "smithy.api#documentation": "

    The source of the threat intelligence.

    " } }, - "NetworkSourceDomain": { - "target": "com.amazonaws.securityhub#StringFilterList", + "NetworkSourcePort": { + "target": "com.amazonaws.securityhub#NumberFilterList", "traits": { - "smithy.api#documentation": "

    The source domain of network-related information about a finding.

    " + "smithy.api#documentation": "

    The source port of network-related information about a finding.

    " } }, - "VerificationState": { + "MalwareType": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The veracity of a finding.

    " + "smithy.api#documentation": "

    The type of the malware that was observed.

    " } }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#DateFilterList", + "NoteUpdatedBy": { + "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    An ISO8601-formatted timestamp that indicates when the security-findings provider last\n updated the finding record.

    " + "smithy.api#documentation": "

    The principal that created a note.

    " } }, - "NetworkDestinationDomain": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ProcessParentPid": { + "target": "com.amazonaws.securityhub#NumberFilterList", "traits": { - "smithy.api#documentation": "

    The destination domain of network-related information about a finding.

    " + "smithy.api#documentation": "

    The parent process ID.

    " } }, - "WorkflowState": { + "ResourceAwsEc2InstanceVpcId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The workflow state of a finding.

    \n

    Note that this field is deprecated. To search for a finding based on its workflow\n status, use WorkflowStatus.

    " + "smithy.api#documentation": "

    The identifier of the VPC that the instance was launched in.

    " } }, - "Confidence": { - "target": "com.amazonaws.securityhub#NumberFilterList", + "NetworkDestinationIpV6": { + "target": "com.amazonaws.securityhub#IpFilterList", "traits": { - "smithy.api#documentation": "

    A finding's confidence. Confidence is defined as the likelihood that a finding\n accurately identifies the behavior or issue that it was intended to identify.

    \n

    Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

    " + "smithy.api#documentation": "

    The destination IPv6 address of network-related information about a finding.

    " } }, - "ProcessName": { - "target": "com.amazonaws.securityhub#StringFilterList", + "ResourceTags": { + "target": "com.amazonaws.securityhub#MapFilterList", "traits": { - "smithy.api#documentation": "

    The name of the process.

    " + "smithy.api#documentation": "

    A list of AWS tags associated with a resource at the time the finding was\n processed.

    " } }, - "NetworkSourceMac": { + "ResourceAwsEc2InstanceImageId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The source media access control (MAC) address of network-related information about a\n finding.

    " + "smithy.api#documentation": "

    The Amazon Machine Image (AMI) ID of the instance.

    " } }, - "ProductName": { + "SeverityLabel": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The name of the solution (product) that generates findings.

    " + "smithy.api#documentation": "

    The label of a finding's severity.

    " } }, - "GeneratorId": { + "ResourceContainerImageId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security-findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.

    " + "smithy.api#documentation": "

    The identifier of the image related to a finding.

    " } }, - "ResourceAwsS3BucketOwnerId": { - "target": "com.amazonaws.securityhub#StringFilterList", + "NetworkDestinationPort": { + "target": "com.amazonaws.securityhub#NumberFilterList", "traits": { - "smithy.api#documentation": "

    The canonical user ID of the owner of the S3 bucket.

    " + "smithy.api#documentation": "

    The destination port of network-related information about a finding.

    " } }, - "NoteText": { + "ResourceAwsEc2InstanceIamInstanceProfileArn": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

    The text of a note.

    " + "smithy.api#documentation": "

    The IAM profile ARN of the instance.

    " } }, - "Keyword": { - "target": "com.amazonaws.securityhub#KeywordFilterList", + "NetworkDestinationIpV4": { + "target": "com.amazonaws.securityhub#IpFilterList", "traits": { - "smithy.api#documentation": "

    A keyword for a finding.

    " + "smithy.api#documentation": "

    The destination IPv4 address of network-related information about a finding.

    " } } }, "traits": { - "smithy.api#documentation": "

    A collection of attributes that are applied to all active Security Hub-aggregated findings and\n that result in a subset of findings that are included in this insight.

    " + "smithy.api#documentation": "

    A collection of attributes that are applied to all active Security Hub-aggregated findings and\n that result in a subset of findings that are included in this insight.

    \n

    You can filter by up to 10 finding attributes. For each attribute, you can provide up to\n 20 filter values.

    " } }, "com.amazonaws.securityhub#AwsSecurityFindingIdentifier": { "type": "structure", "members": { - "Id": { + "ProductArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the finding that was specified by the finding provider.

    ", + "smithy.api#documentation": "

    The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

    ", "smithy.api#required": {} } }, - "ProductArn": { + "Id": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN generated by Security Hub that uniquely identifies a product that generates findings.\n This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for\n a custom integration.

    ", + "smithy.api#documentation": "

    The identifier of the finding that was specified by the finding provider.

    ", "smithy.api#required": {} } } @@ -2806,16 +7512,16 @@ "com.amazonaws.securityhub#AwsSnsTopicDetails": { "type": "structure", "members": { - "KmsMasterKeyId": { + "Owner": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom\n CMK.

    " + "smithy.api#documentation": "

    The subscription's owner.

    " } }, - "Subscription": { - "target": "com.amazonaws.securityhub#AwsSnsTopicSubscriptionList", + "KmsMasterKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.

    " + "smithy.api#documentation": "

    The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom\n CMK.

    " } }, "TopicName": { @@ -2824,10 +7530,10 @@ "smithy.api#documentation": "

    The name of the topic.

    " } }, - "Owner": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Subscription": { + "target": "com.amazonaws.securityhub#AwsSnsTopicSubscriptionList", "traits": { - "smithy.api#documentation": "

    The subscription's owner.

    " + "smithy.api#documentation": "

    Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.

    " } } }, @@ -2838,16 +7544,16 @@ "com.amazonaws.securityhub#AwsSnsTopicSubscription": { "type": "structure", "members": { - "Endpoint": { + "Protocol": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The subscription's endpoint (format depends on the protocol).

    " + "smithy.api#documentation": "

    The subscription's protocol.

    " } }, - "Protocol": { + "Endpoint": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The subscription's protocol.

    " + "smithy.api#documentation": "

    The subscription's endpoint (format depends on the protocol).

    " } } }, @@ -2864,10 +7570,10 @@ "com.amazonaws.securityhub#AwsSqsQueueDetails": { "type": "structure", "members": { - "QueueName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "KmsDataKeyReusePeriodSeconds": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The name of the new queue.

    " + "smithy.api#documentation": "

    The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.

    " } }, "KmsMasterKeyId": { @@ -2882,10 +7588,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves\n messages after the value of maxReceiveCount is exceeded.

    " } }, - "KmsDataKeyReusePeriodSeconds": { - "target": "com.amazonaws.securityhub#Integer", + "QueueName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.

    " + "smithy.api#documentation": "

    The name of the new queue.

    " } } }, @@ -2902,18 +7608,18 @@ "smithy.api#documentation": "

    A unique identifier for a WebACL.

    " } }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    A friendly name or description of the WebACL. You can't change the name of a WebACL\n after you create it.

    " - } - }, "Rules": { "target": "com.amazonaws.securityhub#AwsWafWebAclRuleList", "traits": { "smithy.api#documentation": "

    An array that contains the action for each rule in a WebACL, the priority of the rule,\n and the ID of the rule.

    " } }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    A friendly name or description of the WebACL. You can't change the name of a WebACL\n after you create it.

    " + } + }, "DefaultAction": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -2928,16 +7634,16 @@ "com.amazonaws.securityhub#AwsWafWebAclRule": { "type": "structure", "members": { - "OverrideAction": { - "target": "com.amazonaws.securityhub#WafOverrideAction", + "ExcludedRules": { + "target": "com.amazonaws.securityhub#WafExcludedRuleList", "traits": { - "smithy.api#documentation": "

    Use the OverrideAction to test your RuleGroup.

    \n

    Any rule in a RuleGroup can potentially block a request. If you set the\n OverrideAction to None, the RuleGroup blocks a request if any\n individual rule in the RuleGroup matches the request and is configured to block that\n request.

    \n

    However, if you first want to test the RuleGroup, set the OverrideAction to\n Count. The RuleGroup then overrides any block action specified by\n individual rules contained within the group. Instead of blocking matching requests, those\n requests are counted.

    \n

    \n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup to a WebACL. In this case you do not use\n ActivatedRule|Action. For all other update requests,\n ActivatedRule|Action is used instead of\n ActivatedRule|OverrideAction.

    " + "smithy.api#documentation": "

    Rules to exclude from a rule group.

    " } }, - "Action": { - "target": "com.amazonaws.securityhub#WafAction", + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Specifies the action that CloudFront or AWS WAF takes when a web request matches the\n conditions in the rule.

    " + "smithy.api#documentation": "

    The rule type.

    \n

    Valid values: REGULAR | RATE_BASED | GROUP\n

    \n

    The default is REGULAR.

    " } }, "Priority": { @@ -2952,16 +7658,16 @@ "smithy.api#documentation": "

    The identifier for a rule.

    " } }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "OverrideAction": { + "target": "com.amazonaws.securityhub#WafOverrideAction", "traits": { - "smithy.api#documentation": "

    The rule type.

    \n

    Valid values: REGULAR | RATE_BASED | GROUP\n

    \n

    The default is REGULAR.

    " + "smithy.api#documentation": "

    Use the OverrideAction to test your RuleGroup.

    \n

    Any rule in a RuleGroup can potentially block a request. If you set the\n OverrideAction to None, the RuleGroup blocks a request if any\n individual rule in the RuleGroup matches the request and is configured to block that\n request.

    \n

    However, if you first want to test the RuleGroup, set the OverrideAction to\n Count. The RuleGroup then overrides any block action specified by\n individual rules contained within the group. Instead of blocking matching requests, those\n requests are counted.

    \n

    \n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup to a WebACL. In this case you do not use\n ActivatedRule|Action. For all other update requests,\n ActivatedRule|Action is used instead of\n ActivatedRule|OverrideAction.

    " } }, - "ExcludedRules": { - "target": "com.amazonaws.securityhub#WafExcludedRuleList", + "Action": { + "target": "com.amazonaws.securityhub#WafAction", "traits": { - "smithy.api#documentation": "

    Rules to exclude from a rule group.

    " + "smithy.api#documentation": "

    Specifies the action that CloudFront or AWS WAF takes when a web request matches the\n conditions in the rule.

    " } } }, @@ -3174,7 +7880,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Used by Security Hub customers to update information about their investigation into a finding.\n Requested by master accounts or member accounts. Master accounts can update findings for\n their account and their member accounts. Member accounts can update findings for their\n account.

    \n

    Updates from BatchUpdateFindings do not affect the value of\n UpdatedAt for a finding.

    \n

    Master accounts can use BatchUpdateFindings to update the following finding\n fields and objects.

    \n
      \n
    • \n

      \n Confidence\n

      \n
      • \n
    • \n

      \n Criticality\n

      \n
      • \n
    • \n

      \n Note\n

      \n
      • \n
    • \n

      \n RelatedFindings\n

      \n
      • \n
    • \n

      \n Severity\n

      \n
      • \n
    • \n

      \n Types\n

      \n
      • \n
    • \n

      \n UserDefinedFields\n

      \n
      • \n
    • \n

      \n VerificationState\n

      \n
      • \n
    • \n

      \n Workflow\n

      \n
      • \n
    \n

    Member accounts can only use BatchUpdateFindings to update the Note\n object.

    ", + "smithy.api#documentation": "

    Used by Security Hub customers to update information about their investigation into a finding.\n Requested by master accounts or member accounts. Master accounts can update findings for\n their account and their member accounts. Member accounts can update findings for their\n account.

    \n

    Updates from BatchUpdateFindings do not affect the value of\n UpdatedAt for a finding.

    \n

    Master and member accounts can use BatchUpdateFindings to update the\n following finding fields and objects.

    \n
      \n
    • \n

      \n Confidence\n

      \n
      • \n
    • \n

      \n Criticality\n

      \n
      • \n
    • \n

      \n Note\n

      \n
      • \n
    • \n

      \n RelatedFindings\n

      \n
      • \n
    • \n

      \n Severity\n

      \n
      • \n
    • \n

      \n Types\n

      \n
      • \n
    • \n

      \n UserDefinedFields\n

      \n
      • \n
    • \n

      \n VerificationState\n

      \n
      • \n
    • \n

      \n Workflow\n

      \n
      • \n
    \n

    You can configure IAM policies to restrict access to fields and field values. For\n example, you might not want member accounts to be able to suppress findings or change the\n finding severity. See Configuring access to BatchUpdateFindings in the\n AWS Security Hub User Guide.

    ", "smithy.api#http": { "method": "PATCH", "uri": "/findings/batchupdate", @@ -3185,6 +7891,12 @@ "com.amazonaws.securityhub#BatchUpdateFindingsRequest": { "type": "structure", "members": { + "Severity": { + "target": "com.amazonaws.securityhub#SeverityUpdate", + "traits": { + "smithy.api#documentation": "

    Used to update the finding severity.

    " + } + }, "VerificationState": { "target": "com.amazonaws.securityhub#VerificationState", "traits": { @@ -3210,37 +7922,31 @@ "smithy.api#documentation": "

    The updated value for the finding confidence. Confidence is defined as the likelihood\n that a finding accurately identifies the behavior or issue that it was intended to\n identify.

    \n

    Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent\n confidence and 100 means 100 percent confidence.

    " } }, - "Types": { - "target": "com.amazonaws.securityhub#TypeList", + "Workflow": { + "target": "com.amazonaws.securityhub#WorkflowUpdate", "traits": { - "smithy.api#documentation": "

    One or more finding types in the format of namespace/category/classifier that classify a\n finding.

    \n

    Valid namespace values are as follows.

    \n
      \n
    • \n

      Software and Configuration Checks

      \n
      • \n
    • \n

      TTPs

      \n
      • \n
    • \n

      Effects

      \n
      • \n
    • \n

      Unusual Behaviors

      \n
      • \n
    • \n

      Sensitive Data Identifications

      \n
      • \n
    " + "smithy.api#documentation": "

    Used to update the workflow status of a finding.

    \n

    The workflow status indicates the progress of the investigation into the finding.

    " } }, "Note": { "target": "com.amazonaws.securityhub#NoteUpdate" }, - "Criticality": { - "target": "com.amazonaws.securityhub#RatioScale", - "traits": { - "smithy.api#documentation": "

    The updated value for the level of importance assigned to the resources associated with\n the findings.

    \n

    A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

    " - } - }, "UserDefinedFields": { "target": "com.amazonaws.securityhub#FieldMap", "traits": { "smithy.api#documentation": "

    A list of name/value string pairs associated with the finding. These are custom,\n user-defined fields added to a finding.

    " } }, - "Workflow": { - "target": "com.amazonaws.securityhub#WorkflowUpdate", + "Types": { + "target": "com.amazonaws.securityhub#TypeList", "traits": { - "smithy.api#documentation": "

    Used to update the workflow status of a finding.

    \n

    The workflow status indicates the progress of the investigation into the finding.

    " + "smithy.api#documentation": "

    One or more finding types in the format of namespace/category/classifier that classify a\n finding.

    \n

    Valid namespace values are as follows.

    \n
      \n
    • \n

      Software and Configuration Checks

      \n
      • \n
    • \n

      TTPs

      \n
      • \n
    • \n

      Effects

      \n
      • \n
    • \n

      Unusual Behaviors

      \n
      • \n
    • \n

      Sensitive Data Identifications

      \n
      • \n
    " } }, - "Severity": { - "target": "com.amazonaws.securityhub#SeverityUpdate", + "Criticality": { + "target": "com.amazonaws.securityhub#RatioScale", "traits": { - "smithy.api#documentation": "

    Used to update the finding severity.

    " + "smithy.api#documentation": "

    The updated value for the level of importance assigned to the resources associated with\n the findings.

    \n

    A score of 0 means that the underlying resources have no criticality, and a score of 100\n is reserved for the most critical resources.

    " } } } @@ -3248,17 +7954,17 @@ "com.amazonaws.securityhub#BatchUpdateFindingsResponse": { "type": "structure", "members": { - "ProcessedFindings": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList", + "UnprocessedFindings": { + "target": "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFindingsList", "traits": { - "smithy.api#documentation": "

    The list of findings that were updated successfully.

    ", + "smithy.api#documentation": "

    The list of findings that were not updated.

    ", "smithy.api#required": {} } }, - "UnprocessedFindings": { - "target": "com.amazonaws.securityhub#BatchUpdateFindingsUnprocessedFindingsList", + "ProcessedFindings": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList", "traits": { - "smithy.api#documentation": "

    The list of findings that were not updated.

    ", + "smithy.api#documentation": "

    The list of findings that were updated successfully.

    ", "smithy.api#required": {} } } @@ -3311,16 +8017,16 @@ "com.amazonaws.securityhub#CidrBlockAssociation": { "type": "structure", "members": { - "AssociationId": { + "CidrBlock": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The association ID for the IPv4 CIDR block.

    " + "smithy.api#documentation": "

    The IPv4 CIDR block.

    " } }, - "CidrBlock": { + "AssociationId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The IPv4 CIDR block.

    " + "smithy.api#documentation": "

    The association ID for the IPv4 CIDR block.

    " } }, "CidrBlockState": { @@ -3398,22 +8104,22 @@ "smithy.api#documentation": "

    The name of the container related to a finding.

    " } }, - "ImageId": { + "ImageName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the image related to a finding.

    " + "smithy.api#documentation": "

    The name of the image related to a finding.

    " } }, "LaunchedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time when the container started.

    " + "smithy.api#documentation": "

    Indicates when the container started.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "ImageName": { + "ImageId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the image related to a finding.

    " + "smithy.api#documentation": "

    The identifier of the image related to a finding.

    " } } }, @@ -3473,24 +8179,24 @@ "com.amazonaws.securityhub#CreateActionTargetRequest": { "type": "structure", "members": { - "Id": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ID for the custom action target.

    ", + "smithy.api#documentation": "

    The name of the custom action target.

    ", "smithy.api#required": {} } }, - "Description": { + "Id": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The description for the custom action target.

    ", + "smithy.api#documentation": "

    The ID for the custom action target.

    ", "smithy.api#required": {} } }, - "Name": { + "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the custom action target.

    ", + "smithy.api#documentation": "

    The description for the custom action target.

    ", "smithy.api#required": {} } } @@ -3552,17 +8258,17 @@ "smithy.api#required": {} } }, - "GroupByAttribute": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", "traits": { - "smithy.api#documentation": "

    The attribute used to group the findings for the insight. The grouping attribute\n identifies the type of item that the insight applies to. For example, if an insight is\n grouped by resource identifier, then the insight produces a list of resource\n identifiers.

    ", + "smithy.api#documentation": "

    One or more attributes used to filter the findings included in the insight. The insight\n only includes findings that match the criteria defined in the filters.

    ", "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "GroupByAttribute": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    One or more attributes used to filter the findings included in the insight. The insight\n only includes findings that match the criteria defined in the filters.

    ", + "smithy.api#documentation": "

    The attribute used to group the findings for the insight. The grouping attribute\n identifies the type of item that the insight applies to. For example, if an insight is\n grouped by resource identifier, then the insight produces a list of resource\n identifiers.

    ", "smithy.api#required": {} } } @@ -3638,13 +8344,7 @@ }, "com.amazonaws.securityhub#Cvss": { "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The version of CVSS for the CVSS score.

    " - } - }, + "members": { "BaseScore": { "target": "com.amazonaws.securityhub#Double", "traits": { @@ -3656,6 +8356,12 @@ "traits": { "smithy.api#documentation": "

    The base scoring vector for the CVSS score.

    " } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The version of CVSS for the CVSS score.

    " + } } }, "traits": { @@ -3671,16 +8377,16 @@ "com.amazonaws.securityhub#DateFilter": { "type": "structure", "members": { - "Start": { + "End": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A start date for the date filter.

    " + "smithy.api#documentation": "

    An end date for the date filter.

    " } }, - "End": { + "Start": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    An end date for the date filter.

    " + "smithy.api#documentation": "

    A start date for the date filter.

    " } }, "DateRange": { @@ -4052,18 +8758,18 @@ "com.amazonaws.securityhub#DescribeActionTargetsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return.

    " - } - }, "NextToken": { "target": "com.amazonaws.securityhub#NextToken", "traits": { "smithy.api#documentation": "

    The token that is required for pagination. On your first call to the\n DescribeActionTargets operation, set the value of this parameter to\n NULL.

    \n

    For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

    " } }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return.

    " + } + }, "ActionTargetArns": { "target": "com.amazonaws.securityhub#ArnList", "traits": { @@ -4075,18 +8781,18 @@ "com.amazonaws.securityhub#DescribeActionTargetsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " - } - }, "ActionTargets": { "target": "com.amazonaws.securityhub#ActionTargetList", "traits": { "smithy.api#documentation": "

    A list of ActionTarget objects. Each object includes the ActionTargetArn,\n Description, and Name of a custom action target available in\n Security Hub.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " + } } } }, @@ -4304,13 +9010,6 @@ "com.amazonaws.securityhub#DescribeStandardsControlsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of security standard controls to return.

    ", - "smithy.api#httpQuery": "MaxResults" - } - }, "StandardsSubscriptionArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -4319,6 +9018,13 @@ "smithy.api#required": {} } }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of security standard controls to return.

    ", + "smithy.api#httpQuery": "MaxResults" + } + }, "NextToken": { "target": "com.amazonaws.securityhub#NextToken", "traits": { @@ -4348,36 +9054,36 @@ "com.amazonaws.securityhub#DescribeStandardsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of standards to return.

    ", - "smithy.api#httpQuery": "MaxResults" - } - }, "NextToken": { "target": "com.amazonaws.securityhub#NextToken", "traits": { "smithy.api#documentation": "

    The token that is required for pagination. On your first call to the\n DescribeStandards operation, set the value of this parameter to\n NULL.

    \n

    For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

    ", "smithy.api#httpQuery": "NextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of standards to return.

    ", + "smithy.api#httpQuery": "MaxResults" + } } } }, "com.amazonaws.securityhub#DescribeStandardsResponse": { "type": "structure", "members": { - "Standards": { - "target": "com.amazonaws.securityhub#Standards", - "traits": { - "smithy.api#documentation": "

    A list of available standards.

    " - } - }, "NextToken": { "target": "com.amazonaws.securityhub#NextToken", "traits": { "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " } + }, + "Standards": { + "target": "com.amazonaws.securityhub#Standards", + "traits": { + "smithy.api#documentation": "

    A list of available standards.

    " + } } } }, @@ -4659,17 +9365,17 @@ "com.amazonaws.securityhub#EnableSecurityHubRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.securityhub#TagMap", - "traits": { - "smithy.api#documentation": "

    The tags to add to the hub resource when you enable Security Hub.

    " - } - }, "EnableDefaultStandards": { "target": "com.amazonaws.securityhub#Boolean", "traits": { "smithy.api#documentation": "

    Whether to enable the security standards that Security Hub has designated as automatically\n enabled. If you do not provide a value for EnableDefaultStandards, it is set\n to true. To not enable the automatically enabled standards, set\n EnableDefaultStandards to false.

    " } + }, + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", + "traits": { + "smithy.api#documentation": "

    The tags to add to the hub resource when you enable Security Hub.

    " + } } } }, @@ -4725,6 +9431,12 @@ "com.amazonaws.securityhub#GetEnabledStandardsRequest": { "type": "structure", "members": { + "StandardsSubscriptionArns": { + "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", + "traits": { + "smithy.api#documentation": "

    The list of the standards subscription ARNs for the standards to retrieve.

    " + } + }, "NextToken": { "target": "com.amazonaws.securityhub#NextToken", "traits": { @@ -4736,29 +9448,23 @@ "traits": { "smithy.api#documentation": "

    The maximum number of results to return in the response.

    " } - }, - "StandardsSubscriptionArns": { - "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", - "traits": { - "smithy.api#documentation": "

    The list of the standards subscription ARNs for the standards to retrieve.

    " - } } } }, "com.amazonaws.securityhub#GetEnabledStandardsResponse": { "type": "structure", "members": { - "StandardsSubscriptions": { - "target": "com.amazonaws.securityhub#StandardsSubscriptions", - "traits": { - "smithy.api#documentation": "

    The list of StandardsSubscriptions objects that include information about\n the enabled standards.

    " - } - }, "NextToken": { "target": "com.amazonaws.securityhub#NextToken", "traits": { "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " } + }, + "StandardsSubscriptions": { + "target": "com.amazonaws.securityhub#StandardsSubscriptions", + "traits": { + "smithy.api#documentation": "

    The list of StandardsSubscriptions objects that include information about\n the enabled standards.

    " + } } } }, @@ -4804,13 +9510,13 @@ "Filters": { "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", "traits": { - "smithy.api#documentation": "

    The finding attributes used to define a condition to filter the returned\n findings.

    \n

    Note that in the available filter fields, WorkflowState is deprecated. To\n search for a finding based on its workflow status, use WorkflowStatus.

    " + "smithy.api#documentation": "

    The finding attributes used to define a condition to filter the returned\n findings.

    \n

    You can filter by up to 10 finding attributes. For each attribute, you can provide up to\n 20 filter values.

    \n

    Note that in the available filter fields, WorkflowState is deprecated. To\n search for a finding based on its workflow status, use WorkflowStatus.

    " } }, - "SortCriteria": { - "target": "com.amazonaws.securityhub#SortCriteria", + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", "traits": { - "smithy.api#documentation": "

    The finding attributes used to sort the list of returned findings.

    " + "smithy.api#documentation": "

    The token that is required for pagination. On your first call to the\n GetFindings operation, set the value of this parameter to\n NULL.

    \n

    For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

    " } }, "MaxResults": { @@ -4819,10 +9525,10 @@ "smithy.api#documentation": "

    The maximum number of findings to return.

    " } }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", + "SortCriteria": { + "target": "com.amazonaws.securityhub#SortCriteria", "traits": { - "smithy.api#documentation": "

    The token that is required for pagination. On your first call to the\n GetFindings operation, set the value of this parameter to\n NULL.

    \n

    For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

    " + "smithy.api#documentation": "

    The finding attributes used to sort the list of returned findings.

    " } } } @@ -4830,18 +9536,18 @@ "com.amazonaws.securityhub#GetFindingsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " - } - }, "Findings": { "target": "com.amazonaws.securityhub#AwsSecurityFindingList", "traits": { "smithy.api#documentation": "

    The findings that matched the filters specified in the request.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " + } } } }, @@ -4946,12 +9652,6 @@ "com.amazonaws.securityhub#GetInsightsRequest": { "type": "structure", "members": { - "InsightArns": { - "target": "com.amazonaws.securityhub#ArnList", - "traits": { - "smithy.api#documentation": "

    The ARNs of the insights to describe. If you do not provide any insight ARNs, then\n GetInsights returns all of your custom insights. It does not return any\n managed insights.

    " - } - }, "MaxResults": { "target": "com.amazonaws.securityhub#MaxResults", "traits": { @@ -4963,24 +9663,30 @@ "traits": { "smithy.api#documentation": "

    The token that is required for pagination. On your first call to the\n GetInsights operation, set the value of this parameter to\n NULL.

    \n

    For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

    " } + }, + "InsightArns": { + "target": "com.amazonaws.securityhub#ArnList", + "traits": { + "smithy.api#documentation": "

    The ARNs of the insights to describe. If you do not provide any insight ARNs, then\n GetInsights returns all of your custom insights. It does not return any\n managed insights.

    " + } } } }, "com.amazonaws.securityhub#GetInsightsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " - } - }, "Insights": { "target": "com.amazonaws.securityhub#InsightList", "traits": { "smithy.api#documentation": "

    The insights returned by the operation.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " + } } } }, @@ -5128,17 +9834,17 @@ "com.amazonaws.securityhub#GetMembersResponse": { "type": "structure", "members": { - "Members": { - "target": "com.amazonaws.securityhub#MemberList", - "traits": { - "smithy.api#documentation": "

    The list of details about the Security Hub member accounts.

    " - } - }, "UnprocessedAccounts": { "target": "com.amazonaws.securityhub#ResultList", "traits": { "smithy.api#documentation": "

    The list of AWS accounts that could not be processed. For each account, the list\n includes the account ID and the email address.

    " } + }, + "Members": { + "target": "com.amazonaws.securityhub#MemberList", + "traits": { + "smithy.api#documentation": "

    The list of details about the Security Hub member accounts.

    " + } } } }, @@ -5180,6 +9886,13 @@ "com.amazonaws.securityhub#Insight": { "type": "structure", "members": { + "InsightArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The ARN of a Security Hub insight.

    ", + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -5187,10 +9900,10 @@ "smithy.api#required": {} } }, - "InsightArn": { + "GroupByAttribute": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN of a Security Hub insight.

    ", + "smithy.api#documentation": "

    The grouping attribute for the insight's findings. Indicates how to group the matching\n findings, and identifies the type of item that the insight applies to. For example, if an\n insight is grouped by resource identifier, then the insight produces a list of resource\n identifiers.

    ", "smithy.api#required": {} } }, @@ -5200,13 +9913,6 @@ "smithy.api#documentation": "

    One or more attributes used to filter the findings included in the insight. The insight\n only includes findings that match the criteria defined in the filters.

    ", "smithy.api#required": {} } - }, - "GroupByAttribute": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The grouping attribute for the insight's findings. Indicates how to group the matching\n findings, and identifies the type of item that the insight applies to. For example, if an\n insight is grouped by resource identifier, then the insight produces a list of resource\n identifiers.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -5335,10 +10041,10 @@ "com.amazonaws.securityhub#InvalidInputException": { "type": "structure", "members": { - "Message": { + "Code": { "target": "com.amazonaws.securityhub#NonEmptyString" }, - "Code": { + "Message": { "target": "com.amazonaws.securityhub#NonEmptyString" } }, @@ -5351,10 +10057,10 @@ "com.amazonaws.securityhub#Invitation": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.securityhub#AccountId", + "InvitedAt": { + "target": "com.amazonaws.securityhub#Timestamp", "traits": { - "smithy.api#documentation": "

    The account ID of the Security Hub master account that the invitation was sent from.

    " + "smithy.api#documentation": "

    The timestamp of when the invitation was sent.

    " } }, "MemberStatus": { @@ -5369,10 +10075,10 @@ "smithy.api#documentation": "

    The ID of the invitation sent to the member account.

    " } }, - "InvitedAt": { - "target": "com.amazonaws.securityhub#Timestamp", + "AccountId": { + "target": "com.amazonaws.securityhub#AccountId", "traits": { - "smithy.api#documentation": "

    The timestamp of when the invitation was sent.

    " + "smithy.api#documentation": "

    The account ID of the Security Hub master account that the invitation was sent from.

    " } } }, @@ -5471,16 +10177,16 @@ "smithy.api#documentation": "

    The association ID for the IPv6 CIDR block.

    " } }, - "CidrBlockState": { + "Ipv6CidrBlock": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Information about the state of the CIDR block.

    " + "smithy.api#documentation": "

    The IPv6 CIDR block.

    " } }, - "Ipv6CidrBlock": { + "CidrBlockState": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The IPv6 CIDR block.

    " + "smithy.api#documentation": "

    Information about the state of the CIDR block.

    " } } }, @@ -5517,10 +10223,10 @@ "com.amazonaws.securityhub#LimitExceededException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.securityhub#NonEmptyString" }, - "Message": { + "Code": { "target": "com.amazonaws.securityhub#NonEmptyString" } }, @@ -5657,17 +10363,17 @@ "com.amazonaws.securityhub#ListInvitationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " - } - }, "Invitations": { "target": "com.amazonaws.securityhub#InvitationList", "traits": { "smithy.api#documentation": "

    The details of the invitations returned by the operation.

    " } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The pagination token to use to request the next page of results.

    " + } } } }, @@ -5710,6 +10416,13 @@ "com.amazonaws.securityhub#ListMembersRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return in the response.

    ", + "smithy.api#httpQuery": "MaxResults" + } + }, "OnlyAssociated": { "target": "com.amazonaws.securityhub#Boolean", "traits": { @@ -5723,13 +10436,6 @@ "smithy.api#documentation": "

    The token that is required for pagination. On your first call to the\n ListMembers operation, set the value of this parameter to\n NULL.

    \n

    For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

    ", "smithy.api#httpQuery": "NextToken" } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return in the response.

    ", - "smithy.api#httpQuery": "MaxResults" - } } } }, @@ -5805,16 +10511,16 @@ "com.amazonaws.securityhub#LoadBalancerState": { "type": "structure", "members": { - "Code": { + "Reason": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The state code. The initial state of the load balancer is provisioning.

    \n

    After the load balancer is fully set up and ready to route traffic, its state is\n active.

    \n

    If the load balancer could not be set up, its state is failed.

    " + "smithy.api#documentation": "

    A description of the state.

    " } }, - "Reason": { + "Code": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A description of the state.

    " + "smithy.api#documentation": "

    The state code. The initial state of the load balancer is provisioning.

    \n

    After the load balancer is fully set up and ready to route traffic, its state is\n active.

    \n

    If the load balancer could not be set up, its state is failed.

    " } } }, @@ -5822,6 +10528,9 @@ "smithy.api#documentation": "

    Information about the state of the load balancer.

    " } }, + "com.amazonaws.securityhub#Long": { + "type": "long" + }, "com.amazonaws.securityhub#Malware": { "type": "structure", "members": { @@ -5831,10 +10540,10 @@ "smithy.api#documentation": "

    The file system path of the malware that was observed.

    " } }, - "Type": { - "target": "com.amazonaws.securityhub#MalwareType", + "State": { + "target": "com.amazonaws.securityhub#MalwareState", "traits": { - "smithy.api#documentation": "

    The type of the malware that was observed.

    " + "smithy.api#documentation": "

    The state of the malware that was observed.

    " } }, "Name": { @@ -5844,10 +10553,10 @@ "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.securityhub#MalwareState", + "Type": { + "target": "com.amazonaws.securityhub#MalwareType", "traits": { - "smithy.api#documentation": "

    The state of the malware that was observed.

    " + "smithy.api#documentation": "

    The type of the malware that was observed.

    " } } }, @@ -5953,24 +10662,24 @@ "Value": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The value for the key in the map filter.

    " + "smithy.api#documentation": "

    The value for the key in the map filter. Filter values are case sensitive. For example,\n one of the values for a tag called Department might be Security.\n If you provide security as the filter value, then there is no match.

    " } }, - "Comparison": { - "target": "com.amazonaws.securityhub#MapFilterComparison", + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The condition to apply to a key value when querying for findings with a map\n filter.

    " + "smithy.api#documentation": "

    The key of the map filter. For example, for ResourceTags, Key\n identifies the name of the tag. For UserDefinedFields, Key is the\n name of the field.

    " } }, - "Key": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Comparison": { + "target": "com.amazonaws.securityhub#MapFilterComparison", "traits": { - "smithy.api#documentation": "

    The key of the map filter.

    " + "smithy.api#documentation": "

    The condition to apply to the key value when querying for findings with a map\n filter.

    \n

    To search for values that exactly match the filter value, use EQUALS. For\n example, for the ResourceTags field, the filter Department EQUALS\n Security matches findings that have the value Security for the tag\n Department.

    \n

    To search for values other than the filter value, use NOT_EQUALS. For\n example, for the ResourceTags field, the filter Department NOT_EQUALS\n Finance matches findings that do not have the value Finance for the\n tag Department.

    \n

    \n EQUALS filters on the same field are joined by OR. A finding\n matches if it matches any one of those filters.

    \n

    \n NOT_EQUALS filters on the same field are joined by AND. A\n finding matches only if it matches all of those filters.

    \n

    You cannot have both an EQUALS filter and a NOT_EQUALS filter\n on the same field.

    " } } }, "traits": { - "smithy.api#documentation": "

    The map filter for querying findings.

    " + "smithy.api#documentation": "

    A map filter for querying findings. Each map filter provides the field to check, the\n value to look for, and the comparison operator.

    " } }, "com.amazonaws.securityhub#MapFilterComparison": { @@ -5980,6 +10689,10 @@ { "value": "EQUALS", "name": "EQUALS" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" } ] } @@ -6002,10 +10715,16 @@ "com.amazonaws.securityhub#Member": { "type": "structure", "members": { - "MasterId": { + "Email": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The AWS account ID of the Security Hub master account associated with this member account.

    " + "smithy.api#documentation": "

    The email address of the member account.

    " + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp for the date and time when the member account was updated.

    " } }, "InvitedAt": { @@ -6017,19 +10736,13 @@ "MemberStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The status of the relationship between the member account and its master account.\n

    " - } - }, - "UpdatedAt": { - "target": "com.amazonaws.securityhub#Timestamp", - "traits": { - "smithy.api#documentation": "

    The timestamp for the date and time when the member account was updated.

    " + "smithy.api#documentation": "

    The status of the relationship between the member account and its master account.\n

    \n

    The status can have one of the following values:

    \n
      \n
    • \n

      \n CREATED - Indicates that the master account added the member account,\n but has not yet invited the member account.

      \n
      • \n
    • \n

      \n INVITED - Indicates that the master account invited the member\n account. The member account has not yet responded to the invitation.

      \n
      • \n
    • \n

      \n ASSOCIATED - Indicates that the member account accepted the\n invitation.

      \n
      • \n
    • \n

      \n REMOVED - Indicates that the master account disassociated the member\n account.

      \n
      • \n
    • \n

      \n RESIGNED - Indicates that the member account disassociated themselves\n from the master account.

      \n
      • \n
    • \n

      \n DELETED - Indicates that the master account deleted the member\n account.

      \n
      • \n
    " } }, - "Email": { + "MasterId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The email address of the member account.

    " + "smithy.api#documentation": "

    The AWS account ID of the Security Hub master account associated with this member account.

    " } }, "AccountId": { @@ -6052,16 +10765,10 @@ "com.amazonaws.securityhub#Network": { "type": "structure", "members": { - "SourcePort": { - "target": "com.amazonaws.securityhub#Integer", - "traits": { - "smithy.api#documentation": "

    The source port of network-related information about a finding.

    " - } - }, - "DestinationIpV6": { + "DestinationDomain": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The destination IPv6 address of network-related information about a finding.

    " + "smithy.api#documentation": "

    The destination domain of network-related information about a finding.

    " } }, "SourceIpV6": { @@ -6070,28 +10777,16 @@ "smithy.api#documentation": "

    The source IPv6 address of network-related information about a finding.

    " } }, - "DestinationIpV4": { + "SourceIpV4": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The destination IPv4 address of network-related information about a finding.

    " + "smithy.api#documentation": "

    The source IPv4 address of network-related information about a finding.

    " } }, - "DestinationPort": { + "SourcePort": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The destination port of network-related information about a finding.

    " - } - }, - "OpenPortRange": { - "target": "com.amazonaws.securityhub#PortRange", - "traits": { - "smithy.api#documentation": "

    The range of open ports that is present on the network.

    " - } - }, - "Direction": { - "target": "com.amazonaws.securityhub#NetworkDirection", - "traits": { - "smithy.api#documentation": "

    The direction of network traffic associated with a finding.

    " + "smithy.api#documentation": "

    The source port of network-related information about a finding.

    " } }, "Protocol": { @@ -6106,22 +10801,40 @@ "smithy.api#documentation": "

    The source domain of network-related information about a finding.

    " } }, - "SourceIpV4": { + "SourceMac": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The source IPv4 address of network-related information about a finding.

    " + "smithy.api#documentation": "

    The source media access control (MAC) address of network-related information about a\n finding.

    " } }, - "SourceMac": { + "OpenPortRange": { + "target": "com.amazonaws.securityhub#PortRange", + "traits": { + "smithy.api#documentation": "

    The range of open ports that is present on the network.

    " + } + }, + "Direction": { + "target": "com.amazonaws.securityhub#NetworkDirection", + "traits": { + "smithy.api#documentation": "

    The direction of network traffic associated with a finding.

    " + } + }, + "DestinationIpV4": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The source media access control (MAC) address of network-related information about a\n finding.

    " + "smithy.api#documentation": "

    The destination IPv4 address of network-related information about a finding.

    " } }, - "DestinationDomain": { + "DestinationPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The destination port of network-related information about a finding.

    " + } + }, + "DestinationIpV6": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The destination domain of network-related information about a finding.

    " + "smithy.api#documentation": "

    The destination IPv6 address of network-related information about a finding.

    " } } }, @@ -6147,10 +10860,10 @@ "com.amazonaws.securityhub#NetworkHeader": { "type": "structure", "members": { - "Protocol": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Source": { + "target": "com.amazonaws.securityhub#NetworkPathComponentDetails", "traits": { - "smithy.api#documentation": "

    The protocol used for the component.

    " + "smithy.api#documentation": "

    Information about the origin of the component.

    " } }, "Destination": { @@ -6159,10 +10872,10 @@ "smithy.api#documentation": "

    Information about the destination of the component.

    " } }, - "Source": { - "target": "com.amazonaws.securityhub#NetworkPathComponentDetails", + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Information about the origin of the component.

    " + "smithy.api#documentation": "

    The protocol used for the component.

    " } } }, @@ -6173,28 +10886,28 @@ "com.amazonaws.securityhub#NetworkPathComponent": { "type": "structure", "members": { - "ComponentType": { + "ComponentId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of component.

    " + "smithy.api#documentation": "

    The identifier of a component in the network path.

    " } }, - "ComponentId": { + "ComponentType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of a component in the network path.

    " + "smithy.api#documentation": "

    The type of component.

    " } }, - "Egress": { + "Ingress": { "target": "com.amazonaws.securityhub#NetworkHeader", "traits": { - "smithy.api#documentation": "

    Information about the component that comes after the current component in the network\n path.

    " + "smithy.api#documentation": "

    Information about the component that comes before the current node in the network\n path.

    " } }, - "Ingress": { + "Egress": { "target": "com.amazonaws.securityhub#NetworkHeader", "traits": { - "smithy.api#documentation": "

    Information about the component that comes before the current node in the network\n path.

    " + "smithy.api#documentation": "

    Information about the component that comes after the current component in the network\n path.

    " } } }, @@ -6205,17 +10918,17 @@ "com.amazonaws.securityhub#NetworkPathComponentDetails": { "type": "structure", "members": { - "PortRanges": { - "target": "com.amazonaws.securityhub#PortRangeList", - "traits": { - "smithy.api#documentation": "

    A list of port ranges for the destination.

    " - } - }, "Address": { "target": "com.amazonaws.securityhub#StringList", "traits": { "smithy.api#documentation": "

    The IP addresses of the destination.

    " } + }, + "PortRanges": { + "target": "com.amazonaws.securityhub#PortRangeList", + "traits": { + "smithy.api#documentation": "

    A list of port ranges for the destination.

    " + } } }, "traits": { @@ -6246,24 +10959,24 @@ "com.amazonaws.securityhub#Note": { "type": "structure", "members": { - "Text": { + "UpdatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The text of a note.

    ", + "smithy.api#documentation": "

    The timestamp of when the note was updated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    ", "smithy.api#required": {} } }, - "UpdatedAt": { + "UpdatedBy": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The timestamp of when the note was updated.

    ", + "smithy.api#documentation": "

    The principal that created a note.

    ", "smithy.api#required": {} } }, - "UpdatedBy": { + "Text": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The principal that created a note.

    ", + "smithy.api#documentation": "

    The text of a note.

    ", "smithy.api#required": {} } } @@ -6275,17 +10988,17 @@ "com.amazonaws.securityhub#NoteUpdate": { "type": "structure", "members": { - "UpdatedBy": { + "Text": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The principal that updated the note.

    ", + "smithy.api#documentation": "

    The updated note text.

    ", "smithy.api#required": {} } }, - "Text": { + "UpdatedBy": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The updated note text.

    ", + "smithy.api#documentation": "

    The principal that updated the note.

    ", "smithy.api#required": {} } } @@ -6297,10 +11010,10 @@ "com.amazonaws.securityhub#NumberFilter": { "type": "structure", "members": { - "Gte": { + "Lte": { "target": "com.amazonaws.securityhub#Double", "traits": { - "smithy.api#documentation": "

    The greater-than-equal condition to be applied to a single field when querying for\n findings.

    " + "smithy.api#documentation": "

    The less-than-equal condition to be applied to a single field when querying for\n findings.

    " } }, "Eq": { @@ -6309,10 +11022,10 @@ "smithy.api#documentation": "

    The equal-to condition to be applied to a single field when querying for\n findings.

    " } }, - "Lte": { + "Gte": { "target": "com.amazonaws.securityhub#Double", "traits": { - "smithy.api#documentation": "

    The less-than-equal condition to be applied to a single field when querying for\n findings.

    " + "smithy.api#documentation": "

    The greater-than-equal condition to be applied to a single field when querying for\n findings.

    " } } }, @@ -6345,20 +11058,95 @@ ] } }, - "com.amazonaws.securityhub#PortRange": { + "com.amazonaws.securityhub#PatchSummary": { "type": "structure", "members": { - "End": { + "InstalledPendingReboot": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The last port in the port range.

    " + "smithy.api#documentation": "

    The number of patches that were applied, but that require the instance to be rebooted in\n order to be marked as installed.

    " + } + }, + "FailedCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of patches from the compliance standard that failed to install.

    " + } + }, + "InstalledRejectedCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of patches that are installed but are also on a list of patches that the\n customer rejected.

    " + } + }, + "MissingCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of patches that are part of the compliance standard but are not installed.\n The count includes patches that failed to install.

    " + } + }, + "OperationStartTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the operation started.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "InstalledCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of patches from the compliance standard that were installed\n successfully.

    " + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the compliance standard that was used to determine the patch\n compliance status.

    ", + "smithy.api#required": {} + } + }, + "Operation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The type of patch operation performed. For Patch Manager, the values are\n SCAN and INSTALL.

    " + } + }, + "OperationEndTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    Indicates when the operation completed.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " + } + }, + "InstalledOtherCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The number of installed patches that are not part of the compliance standard.

    " } }, + "RebootOption": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The reboot option specified for the instance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides an overview of the patch compliance status for an instance against a selected\n compliance standard.

    " + } + }, + "com.amazonaws.securityhub#PortRange": { + "type": "structure", + "members": { "Begin": { "target": "com.amazonaws.securityhub#Integer", "traits": { "smithy.api#documentation": "

    The first port in the port range.

    " } + }, + "End": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

    The last port in the port range.

    " + } } }, "traits": { @@ -6374,28 +11162,28 @@ "com.amazonaws.securityhub#ProcessDetails": { "type": "structure", "members": { - "Pid": { - "target": "com.amazonaws.securityhub#Integer", + "TerminatedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The process ID.

    " + "smithy.api#documentation": "

    Indicates when the process was terminated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, "LaunchedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date/time that the process was launched.

    " + "smithy.api#documentation": "

    Indicates when the process was launched.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "ParentPid": { + "Pid": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The parent process ID.

    " + "smithy.api#documentation": "

    The process ID.

    " } }, - "TerminatedAt": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time when the process was terminated.

    " + "smithy.api#documentation": "

    The name of the process.

    " } }, "Path": { @@ -6404,10 +11192,10 @@ "smithy.api#documentation": "

    The path to the process executable.

    " } }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ParentPid": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

    The name of the process.

    " + "smithy.api#documentation": "

    The parent process ID.

    " } } }, @@ -6418,16 +11206,16 @@ "com.amazonaws.securityhub#Product": { "type": "structure", "members": { - "ProductName": { + "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the product.

    " + "smithy.api#documentation": "

    A description of the product.

    " } }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "IntegrationTypes": { + "target": "com.amazonaws.securityhub#IntegrationTypeList", "traits": { - "smithy.api#documentation": "

    A description of the product.

    " + "smithy.api#documentation": "

    The types of integration that the product supports. Available values are the\n following.

    \n
      \n
    • \n

      \n SEND_FINDINGS_TO_SECURITY_HUB - Indicates that the integration sends\n findings to Security Hub.

      \n
      • \n
    • \n

      \n RECEIVE_FINDINGS_FROM_SECURITY_HUB - Indicates that the integration\n receives findings from Security Hub.

      \n
      • \n
    " } }, "ProductSubscriptionResourcePolicy": { @@ -6442,35 +11230,35 @@ "smithy.api#documentation": "

    The URL for the page that contains more information about the product.

    " } }, - "CompanyName": { + "ProductName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the company that provides the product.

    " + "smithy.api#documentation": "

    The name of the product.

    " } }, - "IntegrationTypes": { - "target": "com.amazonaws.securityhub#IntegrationTypeList", + "Categories": { + "target": "com.amazonaws.securityhub#CategoryList", "traits": { - "smithy.api#documentation": "

    The types of integration that the product supports. Available values are the\n following.

    \n
      \n
    • \n

      \n SEND_FINDINGS_TO_SECURITY_HUB - Indicates that the integration sends\n findings to Security Hub.

      \n
      • \n
    • \n

      \n RECEIVE_FINDINGS_FROM_SECURITY_HUB - Indicates that the integration\n receives findings from Security Hub.

      \n
      • \n
    " + "smithy.api#documentation": "

    The categories assigned to the product.

    " } }, - "ProductArn": { + "ActivationUrl": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The ARN assigned to the product.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The URL used to activate the product.

    " } }, - "ActivationUrl": { + "ProductArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The URL used to activate the product.

    " + "smithy.api#documentation": "

    The ARN assigned to the product.

    ", + "smithy.api#required": {} } }, - "Categories": { - "target": "com.amazonaws.securityhub#CategoryList", + "CompanyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The categories assigned to the product.

    " + "smithy.api#documentation": "

    The name of the company that provides the product.

    " } } }, @@ -6502,16 +11290,16 @@ "com.amazonaws.securityhub#Recommendation": { "type": "structure", "members": { - "Text": { + "Url": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    Describes the recommended steps to take to remediate an issue identified in a finding.

    " + "smithy.api#documentation": "

    A URL to a page or site that contains information about how to remediate a finding.

    " } }, - "Url": { + "Text": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A URL to a page or site that contains information about how to remediate a finding.

    " + "smithy.api#documentation": "

    Describes the recommended steps to take to remediate an issue identified in a finding.

    " } } }, @@ -6591,6 +11379,19 @@ "smithy.api#documentation": "

    The canonical AWS external Region name where this resource is located.

    " } }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The canonical identifier for the given resource type.

    ", + "smithy.api#required": {} + } + }, + "Details": { + "target": "com.amazonaws.securityhub#ResourceDetails", + "traits": { + "smithy.api#documentation": "

    Additional details about the resource related to a finding.

    " + } + }, "Type": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -6604,23 +11405,16 @@ "smithy.api#documentation": "

    A list of AWS tags associated with a resource at the time the finding was\n processed.

    " } }, - "Details": { - "target": "com.amazonaws.securityhub#ResourceDetails", - "traits": { - "smithy.api#documentation": "

    Additional details about the resource related to a finding.

    " - } - }, "Partition": { "target": "com.amazonaws.securityhub#Partition", "traits": { "smithy.api#documentation": "

    The canonical AWS partition name that the Region is assigned to.

    " } }, - "Id": { + "ResourceRole": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The canonical identifier for the given resource type.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    " } } }, @@ -6637,10 +11431,10 @@ "com.amazonaws.securityhub#ResourceConflictException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.securityhub#NonEmptyString" }, - "Message": { + "Code": { "target": "com.amazonaws.securityhub#NonEmptyString" } }, @@ -6653,22 +11447,94 @@ "com.amazonaws.securityhub#ResourceDetails": { "type": "structure", "members": { + "AwsLambdaFunction": { + "target": "com.amazonaws.securityhub#AwsLambdaFunctionDetails", + "traits": { + "smithy.api#documentation": "

    Details about a Lambda function.

    " + } + }, + "AwsCloudTrailTrail": { + "target": "com.amazonaws.securityhub#AwsCloudTrailTrailDetails", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "AwsApiGatewayV2Stage": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2StageDetails", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "AwsApiGatewayV2Api": { + "target": "com.amazonaws.securityhub#AwsApiGatewayV2ApiDetails", + "traits": { + "smithy.api#documentation": "

    " + } + }, "AwsS3Object": { "target": "com.amazonaws.securityhub#AwsS3ObjectDetails", "traits": { "smithy.api#documentation": "

    Details about an Amazon S3 object related to a finding.

    " } }, - "AwsSnsTopic": { - "target": "com.amazonaws.securityhub#AwsSnsTopicDetails", + "AwsElbLoadBalancer": { + "target": "com.amazonaws.securityhub#AwsElbLoadBalancerDetails", "traits": { - "smithy.api#documentation": "

    Details about an SNS topic.

    " + "smithy.api#documentation": "

    " } }, - "AwsCodeBuildProject": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectDetails", + "AwsSecretsManagerSecret": { + "target": "com.amazonaws.securityhub#AwsSecretsManagerSecretDetails", "traits": { - "smithy.api#documentation": "

    Details for an AWS CodeBuild project.

    " + "smithy.api#documentation": "

    Details about a Secrets Manager secret.

    " + } + }, + "AwsElasticsearchDomain": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDetails", + "traits": { + "smithy.api#documentation": "

    Details for an Elasticsearch domain.

    " + } + }, + "AwsWafWebAcl": { + "target": "com.amazonaws.securityhub#AwsWafWebAclDetails", + "traits": { + "smithy.api#documentation": "

    Details for a WAF WebACL.

    " + } + }, + "AwsSqsQueue": { + "target": "com.amazonaws.securityhub#AwsSqsQueueDetails", + "traits": { + "smithy.api#documentation": "

    Details about an SQS queue.

    " + } + }, + "AwsRdsDbInstance": { + "target": "com.amazonaws.securityhub#AwsRdsDbInstanceDetails", + "traits": { + "smithy.api#documentation": "

    Details about an Amazon RDS database instance.

    " + } + }, + "AwsEc2Eip": { + "target": "com.amazonaws.securityhub#AwsEc2EipDetails", + "traits": { + "smithy.api#documentation": "

    Details about an Elastic IP address.

    " + } + }, + "AwsEc2SecurityGroup": { + "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails", + "traits": { + "smithy.api#documentation": "

    Details for an EC2 security group.

    " + } + }, + "AwsApiGatewayStage": { + "target": "com.amazonaws.securityhub#AwsApiGatewayStageDetails", + "traits": { + "smithy.api#documentation": "

    " + } + }, + "AwsIamUser": { + "target": "com.amazonaws.securityhub#AwsIamUserDetails", + "traits": { + "smithy.api#documentation": "

    Details about an IAM user.

    " } }, "Container": { @@ -6683,88 +11549,106 @@ "smithy.api#documentation": "

    Details about an Amazon EC2 instance related to a finding.

    " } }, - "AwsEc2Vpc": { - "target": "com.amazonaws.securityhub#AwsEc2VpcDetails", + "AwsDynamoDbTable": { + "target": "com.amazonaws.securityhub#AwsDynamoDbTableDetails", "traits": { - "smithy.api#documentation": "

    Details for an EC2 VPC.

    " + "smithy.api#documentation": "

    Details about a DynamoDB table.

    " } }, - "AwsKmsKey": { - "target": "com.amazonaws.securityhub#AwsKmsKeyDetails", + "AwsRdsDbCluster": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterDetails", "traits": { - "smithy.api#documentation": "

    Details about a KMS key.

    " + "smithy.api#documentation": "

    Details about an Amazon RDS database cluster.

    " } }, - "AwsAutoScalingAutoScalingGroup": { - "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails", + "AwsIamGroup": { + "target": "com.amazonaws.securityhub#AwsIamGroupDetails", "traits": { - "smithy.api#documentation": "

    Details for an autoscaling group.

    " + "smithy.api#documentation": "

    " } }, - "AwsCloudFrontDistribution": { - "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails", + "AwsSnsTopic": { + "target": "com.amazonaws.securityhub#AwsSnsTopicDetails", "traits": { - "smithy.api#documentation": "

    Details about a CloudFront distribution.

    " + "smithy.api#documentation": "

    Details about an SNS topic.

    " } }, - "AwsLambdaFunction": { - "target": "com.amazonaws.securityhub#AwsLambdaFunctionDetails", + "AwsElbv2LoadBalancer": { + "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails", "traits": { - "smithy.api#documentation": "

    Details about a Lambda function.

    " + "smithy.api#documentation": "

    Details about a load balancer.

    " } }, - "AwsS3Bucket": { - "target": "com.amazonaws.securityhub#AwsS3BucketDetails", + "AwsIamAccessKey": { + "target": "com.amazonaws.securityhub#AwsIamAccessKeyDetails", "traits": { - "smithy.api#documentation": "

    Details about an Amazon S3 bucket related to a finding.

    " + "smithy.api#documentation": "

    Details about an IAM access key related to a finding.

    " } }, - "AwsEc2NetworkInterface": { - "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails", + "AwsKmsKey": { + "target": "com.amazonaws.securityhub#AwsKmsKeyDetails", "traits": { - "smithy.api#documentation": "

    Details for an Amazon EC2 network interface.

    " + "smithy.api#documentation": "

    Details about a KMS key.

    " } }, - "AwsSqsQueue": { - "target": "com.amazonaws.securityhub#AwsSqsQueueDetails", + "AwsIamRole": { + "target": "com.amazonaws.securityhub#AwsIamRoleDetails", "traits": { - "smithy.api#documentation": "

    Details about an SQS queue.

    " + "smithy.api#documentation": "

    Details about an IAM role.

    " } }, - "AwsEc2SecurityGroup": { - "target": "com.amazonaws.securityhub#AwsEc2SecurityGroupDetails", + "AwsCertificateManagerCertificate": { + "target": "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails", "traits": { - "smithy.api#documentation": "

    Details for an EC2 security group.

    " + "smithy.api#documentation": "

    " } }, - "AwsIamRole": { - "target": "com.amazonaws.securityhub#AwsIamRoleDetails", + "Other": { + "target": "com.amazonaws.securityhub#FieldMap", "traits": { - "smithy.api#documentation": "

    Details about an IAM role.

    " + "smithy.api#documentation": "

    Details about a resource that are not available in a type-specific details object. Use\n the Other object in the following cases.

    \n
      \n
    • \n

      The type-specific object does not contain all of the fields that you want to\n populate. In this case, first use the type-specific object to populate those fields.\n Use the Other object to populate the fields that are missing from the\n type-specific object.

      \n
      • \n
    • \n

      The resource type does not have a corresponding object. This includes resources\n for which the type is Other.

      \n
      • \n
    " } }, - "AwsElasticsearchDomain": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDetails", + "AwsIamPolicy": { + "target": "com.amazonaws.securityhub#AwsIamPolicyDetails", "traits": { - "smithy.api#documentation": "

    Details for an Elasticsearch domain.

    " + "smithy.api#documentation": "

    Details about an IAM permissions policy.

    " } }, - "AwsRdsDbInstance": { - "target": "com.amazonaws.securityhub#AwsRdsDbInstanceDetails", + "AwsS3Bucket": { + "target": "com.amazonaws.securityhub#AwsS3BucketDetails", + "traits": { + "smithy.api#documentation": "

    Details about an Amazon S3 bucket related to a finding.

    " + } + }, + "AwsRedshiftCluster": { + "target": "com.amazonaws.securityhub#AwsRedshiftClusterDetails", "traits": { - "smithy.api#documentation": "

    Details for an Amazon RDS database instance.

    " + "smithy.api#documentation": "

    " } }, - "AwsEc2Volume": { - "target": "com.amazonaws.securityhub#AwsEc2VolumeDetails", + "AwsApiGatewayRestApi": { + "target": "com.amazonaws.securityhub#AwsApiGatewayRestApiDetails", "traits": { - "smithy.api#documentation": "

    Details for an EC2 volume.

    " + "smithy.api#documentation": "

    " } }, - "AwsElbv2LoadBalancer": { - "target": "com.amazonaws.securityhub#AwsElbv2LoadBalancerDetails", + "AwsCloudFrontDistribution": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails", "traits": { - "smithy.api#documentation": "

    Details about a load balancer.

    " + "smithy.api#documentation": "

    Details about a CloudFront distribution.

    " + } + }, + "AwsAutoScalingAutoScalingGroup": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails", + "traits": { + "smithy.api#documentation": "

    Details for an autoscaling group.

    " + } + }, + "AwsRdsDbSnapshot": { + "target": "com.amazonaws.securityhub#AwsRdsDbSnapshotDetails", + "traits": { + "smithy.api#documentation": "

    Details about an Amazon RDS database snapshot.

    " } }, "AwsLambdaLayerVersion": { @@ -6773,22 +11657,34 @@ "smithy.api#documentation": "

    Details for a Lambda layer version.

    " } }, - "AwsIamAccessKey": { - "target": "com.amazonaws.securityhub#AwsIamAccessKeyDetails", + "AwsEc2Vpc": { + "target": "com.amazonaws.securityhub#AwsEc2VpcDetails", "traits": { - "smithy.api#documentation": "

    Details about an IAM access key related to a finding.

    " + "smithy.api#documentation": "

    Details for an EC2 VPC.

    " } }, - "AwsWafWebAcl": { - "target": "com.amazonaws.securityhub#AwsWafWebAclDetails", + "AwsEc2Volume": { + "target": "com.amazonaws.securityhub#AwsEc2VolumeDetails", "traits": { - "smithy.api#documentation": "

    Details for a WAF WebACL.

    " + "smithy.api#documentation": "

    Details for an EC2 volume.

    " } }, - "Other": { - "target": "com.amazonaws.securityhub#FieldMap", + "AwsEc2NetworkInterface": { + "target": "com.amazonaws.securityhub#AwsEc2NetworkInterfaceDetails", "traits": { - "smithy.api#documentation": "

    Details about a resource that are not available in a type-specific details object. Use\n the Other object in the following cases.

    \n
      \n
    • \n

      The type-specific object does not contain all of the fields that you want to\n populate. In this case, first use the type-specific object to populate those fields.\n Use the Other object to populate the fields that are missing from the\n type-specific object.

      \n
      • \n
    • \n

      The resource type does not have a corresponding object. This includes resources\n for which the type is Other.

      \n
      • \n
    " + "smithy.api#documentation": "

    Details for an Amazon EC2 network interface.

    " + } + }, + "AwsCodeBuildProject": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectDetails", + "traits": { + "smithy.api#documentation": "

    Details for an AWS CodeBuild project.

    " + } + }, + "AwsRdsDbClusterSnapshot": { + "target": "com.amazonaws.securityhub#AwsRdsDbClusterSnapshotDetails", + "traits": { + "smithy.api#documentation": "

    Details about an Amazon RDS database cluster snapshot.

    " } } }, @@ -6821,17 +11717,17 @@ "com.amazonaws.securityhub#Result": { "type": "structure", "members": { - "ProcessingResult": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The reason that the account was not processed.

    " - } - }, "AccountId": { "target": "com.amazonaws.securityhub#AccountId", "traits": { "smithy.api#documentation": "

    An AWS account ID of the account that was not processed.

    " } + }, + "ProcessingResult": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The reason that the account was not processed.

    " + } } }, "traits": { @@ -6995,35 +11891,35 @@ "name": "securityhub" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

    Security Hub provides you with a comprehensive view of the security state of your AWS\n environment and resources. It also provides you with the readiness status of your\n environment based on controls from supported security standards. Security Hub collects security\n data from AWS accounts, services, and integrated third-party products and helps you analyze\n security trends in your environment to identify the highest priority security issues. For\n more information about Security Hub, see the \n AWS Security Hub User\n Guide\n .

    \n

    When you use operations in the Security Hub API, the requests are executed only in the AWS\n Region that is currently active or in the specific AWS Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

    \n

    For example, if your Region is set to us-west-2, when you use \n CreateMembers\n to add a member account to Security Hub, the association of\n the member account with the master account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

    \n

    The following throttling limits apply to using Security Hub API operations.

    \n
      \n
    • \n

      \n \n GetFindings\n - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

      \n
      • \n
    • \n

      \n \n UpdateFindings\n - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.

      \n
      • \n
    • \n

      All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Security Hub provides you with a comprehensive view of the security state of your AWS\n environment and resources. It also provides you with the readiness status of your\n environment based on controls from supported security standards. Security Hub collects security\n data from AWS accounts, services, and integrated third-party products and helps you analyze\n security trends in your environment to identify the highest priority security issues. For\n more information about Security Hub, see the \n AWS Security Hub User\n Guide\n .

    \n

    When you use operations in the Security Hub API, the requests are executed only in the AWS\n Region that is currently active or in the specific AWS Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

    \n

    For example, if your Region is set to us-west-2, when you use \n CreateMembers\n to add a member account to Security Hub, the association of\n the member account with the master account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

    \n

    The following throttling limits apply to using Security Hub API operations.

    \n
      \n
    • \n

      \n \n BatchEnableStandards\n - RateLimit of 1\n request per second, BurstLimit of 1 request per second.

      \n
      • \n
    • \n

      \n \n GetFindings\n - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

      \n
      • \n
    • \n

      \n \n UpdateFindings\n - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.

      \n
      • \n
    • \n

      \n \n UpdateStandardsControl\n - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.

      \n
      • \n
    • \n

      All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

      \n
      • \n
    ", "smithy.api#title": "AWS SecurityHub" } }, "com.amazonaws.securityhub#Severity": { "type": "structure", "members": { - "Original": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The native severity from the finding product that generated the finding.

    " - } - }, "Normalized": { "target": "com.amazonaws.securityhub#Integer", "traits": { "smithy.api#documentation": "

    Deprecated. The normalized severity of a finding. This attribute is being deprecated.\n Instead of providing Normalized, provide Label.

    \n

    If you provide Label and do not provide Normalized, then\n Normalized is set automatically as follows.

    \n
      \n
    • \n

      \n INFORMATIONAL - 0

      \n
      • \n
    • \n

      \n LOW - 1

      \n
      • \n
    • \n

      \n MEDIUM - 40

      \n
      • \n
    • \n

      \n HIGH - 70

      \n
      • \n
    • \n

      \n CRITICAL - 90

      \n
      • \n
    " } }, + "Label": { + "target": "com.amazonaws.securityhub#SeverityLabel", + "traits": { + "smithy.api#documentation": "

    The severity value of the finding. The allowed values are the following.

    \n
      \n
    • \n

      \n INFORMATIONAL - No issue was found.

      \n
      • \n
    • \n

      \n LOW - The issue does not require action on its own.

      \n
      • \n
    • \n

      \n MEDIUM - The issue must be addressed but not urgently.

      \n
      • \n
    • \n

      \n HIGH - The issue must be addressed as a priority.

      \n
      • \n
    • \n

      \n CRITICAL - The issue must be remediated immediately to avoid it\n escalating.

      \n
      • \n
    \n

    If you provide Normalized and do not provide Label, then\n Label is set automatically as follows.

    \n
      \n
    • \n

      0 - INFORMATIONAL\n

      \n
      • \n
    • \n

      1–39 - LOW\n

      \n
      • \n
    • \n

      40–69 - MEDIUM\n

      \n
      • \n
    • \n

      70–89 - HIGH\n

      \n
      • \n
    • \n

      90–100 - CRITICAL\n

      \n
      • \n
    " + } + }, "Product": { "target": "com.amazonaws.securityhub#Double", "traits": { "smithy.api#documentation": "

    Deprecated. This attribute is being deprecated. Instead of providing\n Product, provide Original.

    \n

    The native severity as defined by the AWS service or integrated partner product that\n generated the finding.

    " } }, - "Label": { - "target": "com.amazonaws.securityhub#SeverityLabel", + "Original": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The severity value of the finding. The allowed values are the following.

    \n
      \n
    • \n

      \n INFORMATIONAL - No issue was found.

      \n
      • \n
    • \n

      \n LOW - The issue does not require action on its own.

      \n
      • \n
    • \n

      \n MEDIUM - The issue must be addressed but not urgently.

      \n
      • \n
    • \n

      \n HIGH - The issue must be addressed as a priority.

      \n
      • \n
    • \n

      \n CRITICAL - The issue must be remediated immediately to avoid it\n escalating.

      \n
      • \n
    \n

    If you provide Normalized and do not provide Label, then\n Label is set automatically as follows.

    \n
      \n
    • \n

      0 - INFORMATIONAL\n

      \n
      • \n
    • \n

      1–39 - LOW\n

      \n
      • \n
    • \n

      40–69 - MEDIUM\n

      \n
      • \n
    • \n

      70–89 - HIGH\n

      \n
      • \n
    • \n

      90–100 - CRITICAL\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The native severity from the finding product that generated the finding.

    " } } }, @@ -7107,6 +12003,9 @@ "smithy.api#documentation": "

    Updates to the severity information for a finding.

    " } }, + "com.amazonaws.securityhub#SizeBytes": { + "type": "long" + }, "com.amazonaws.securityhub#SoftwarePackage": { "type": "structure", "members": { @@ -7116,10 +12015,10 @@ "smithy.api#documentation": "

    The name of the software package.

    " } }, - "Version": { + "Epoch": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The version of the software package.

    " + "smithy.api#documentation": "

    The epoch of the software package.

    " } }, "Release": { @@ -7128,16 +12027,16 @@ "smithy.api#documentation": "

    The release of the software package.

    " } }, - "Epoch": { + "Architecture": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The epoch of the software package.

    " + "smithy.api#documentation": "

    The architecture used for the software package.

    " } }, - "Architecture": { + "Version": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The architecture used for the software package.

    " + "smithy.api#documentation": "

    The version of the software package.

    " } } }, @@ -7160,17 +12059,17 @@ "com.amazonaws.securityhub#SortCriterion": { "type": "structure", "members": { - "Field": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The finding attribute used to sort findings.

    " - } - }, "SortOrder": { "target": "com.amazonaws.securityhub#SortOrder", "traits": { "smithy.api#documentation": "

    The order used to sort findings.

    " } + }, + "Field": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The finding attribute used to sort findings.

    " + } } }, "traits": { @@ -7201,12 +12100,6 @@ "smithy.api#documentation": "

    The ARN of a standard.

    " } }, - "EnabledByDefault": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#documentation": "

    Whether the standard is enabled by default. When Security Hub is enabled from the console, if a\n standard is enabled by default, the check box for that standard is selected by\n default.

    \n

    When Security Hub is enabled using the EnableSecurityHub API operation, the\n standard is enabled by default unless EnableDefaultStandards is set to\n false.

    " - } - }, "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -7218,6 +12111,12 @@ "traits": { "smithy.api#documentation": "

    The name of the standard.

    " } + }, + "EnabledByDefault": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the standard is enabled by default. When Security Hub is enabled from the console, if a\n standard is enabled by default, the check box for that standard is selected by\n default.

    \n

    When Security Hub is enabled using the EnableSecurityHub API operation, the\n standard is enabled by default unless EnableDefaultStandards is set to\n false.

    " + } } }, "traits": { @@ -7239,28 +12138,22 @@ "smithy.api#documentation": "

    A link to remediation information for the control in the Security Hub user\n documentation.

    " } }, - "ControlStatus": { - "target": "com.amazonaws.securityhub#ControlStatus", - "traits": { - "smithy.api#documentation": "

    The current status of the security standard control. Indicates whether the control is\n enabled or disabled. Security Hub does not check against disabled controls.

    " - } - }, - "RelatedRequirements": { - "target": "com.amazonaws.securityhub#RelatedRequirementsList", + "StandardsControlArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The list of requirements that are related to this control.

    " + "smithy.api#documentation": "

    The ARN of the security standard control.

    " } }, - "ControlId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ControlStatusUpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", "traits": { - "smithy.api#documentation": "

    The identifier of the security standard control.

    " + "smithy.api#documentation": "

    The date and time that the status of the security standard control was most recently\n updated.

    " } }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "RelatedRequirements": { + "target": "com.amazonaws.securityhub#RelatedRequirementsList", "traits": { - "smithy.api#documentation": "

    The longer description of the security standard control. Provides information about what\n the control is checking for.

    " + "smithy.api#documentation": "

    The list of requirements that are related to this control.

    " } }, "Title": { @@ -7275,22 +12168,28 @@ "smithy.api#documentation": "

    The reason provided for the most recent change in status for the control.

    " } }, + "ControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the security standard control.

    " + } + }, "SeverityRating": { "target": "com.amazonaws.securityhub#SeverityRating", "traits": { "smithy.api#documentation": "

    The severity of findings generated from this security standard control.

    \n

    The finding severity is based on an assessment of how easy it would be to compromise AWS\n resources if the issue is detected.

    " } }, - "ControlStatusUpdatedAt": { - "target": "com.amazonaws.securityhub#Timestamp", + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time that the status of the security standard control was most recently\n updated.

    " + "smithy.api#documentation": "

    The longer description of the security standard control. Provides information about what\n the control is checking for.

    " } }, - "StandardsControlArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ControlStatus": { + "target": "com.amazonaws.securityhub#ControlStatus", "traits": { - "smithy.api#documentation": "

    The ARN of the security standard control.

    " + "smithy.api#documentation": "

    The current status of the security standard control. Indicates whether the control is\n enabled or disabled. Security Hub does not check against disabled controls.

    " } } }, @@ -7343,17 +12242,17 @@ "com.amazonaws.securityhub#StandardsSubscription": { "type": "structure", "members": { - "StandardsStatus": { - "target": "com.amazonaws.securityhub#StandardsStatus", + "StandardsArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The status of the standards subscription.

    ", + "smithy.api#documentation": "

    The ARN of a standard.

    ", "smithy.api#required": {} } }, - "StandardsArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "StandardsStatus": { + "target": "com.amazonaws.securityhub#StandardsStatus", "traits": { - "smithy.api#documentation": "

    The ARN of a standard.

    ", + "smithy.api#documentation": "

    The status of the standards subscription.

    ", "smithy.api#required": {} } }, @@ -7430,17 +12329,17 @@ "com.amazonaws.securityhub#StatusReason": { "type": "structure", "members": { - "ReasonCode": { + "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    A code that represents a reason for the control status. For the list of status reason\n codes and their meanings, see Standards-related information in the ASFF in the\n AWS Security Hub User Guide.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The corresponding description for the status reason code.

    " } }, - "Description": { + "ReasonCode": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The corresponding description for the status reason code.

    " + "smithy.api#documentation": "

    A code that represents a reason for the control status. For the list of status reason\n codes and their meanings, see Standards-related information in the ASFF in the\n AWS Security Hub User Guide.

    ", + "smithy.api#required": {} } } }, @@ -7460,13 +12359,13 @@ "Comparison": { "target": "com.amazonaws.securityhub#StringFilterComparison", "traits": { - "smithy.api#documentation": "

    The condition to be applied to a string value when querying for findings.

    " + "smithy.api#documentation": "

    The condition to apply to a string value when querying for findings. To search for\n values that contain the filter criteria value, use one of the following comparison\n operators:

    \n
      \n
    • \n

      To search for values that exactly match the filter value, use\n EQUALS.

      \n

      For example, the filter ResourceType EQUALS AwsEc2SecurityGroup only\n matches findings that have a resource type of\n AwsEc2SecurityGroup.

      \n
      • \n
    • \n

      To search for values that start with the filter value, use\n PREFIX.

      \n

      For example, the filter ResourceType PREFIX AwsIam matches findings\n that have a resource type that starts with AwsIam. Findings with a\n resource type of AwsIamPolicy, AwsIamRole, or\n AwsIamUser would all match.

      \n
      • \n
    \n

    \n EQUALS and PREFIX filters on the same field are joined by\n OR. A finding matches if it matches any one of those filters.

    \n

    To search for values that do not contain the filter criteria value, use one of the\n following comparison operators:

    \n
      \n
    • \n

      To search for values that do not exactly match the filter value, use\n NOT_EQUALS.

      \n

      For example, the filter ResourceType NOT_EQUALS AwsIamPolicy matches\n findings that have a resource type other than AwsIamPolicy.

      \n
      • \n
    • \n

      To search for values that do not start with the filter value, use\n PREFIX_NOT_EQUALS.

      \n

      For example, the filter ResourceType PREFIX_NOT_EQUALS AwsIam matches\n findings that have a resource type that does not start with AwsIam.\n Findings with a resource type of AwsIamPolicy, AwsIamRole,\n or AwsIamUser would all be excluded from the results.

      \n
      • \n
    \n

    \n NOT_EQUALS and PREFIX_NOT_EQUALS filters on the same field are\n joined by AND. A finding matches only if it matches all of those\n filters.

    \n

    For filters on the same field, you cannot provide both an EQUALS filter and\n a NOT_EQUALS or PREFIX_NOT_EQUALS filter. Combining filters in\n this way always returns an error, even if the provided filter values would return valid\n results.

    \n

    You can combine PREFIX filters with NOT_EQUALS or\n PREFIX_NOT_EQUALS filters for the same field. Security Hub first processes the\n PREFIX filters, then the NOT_EQUALS or\n PREFIX_NOT_EQUALS filters.

    \n

    For example, for the following filter, Security Hub first identifies findings that have\n resource types that start with either AwsIAM or AwsEc2. It then\n excludes findings that have a resource type of AwsIamPolicy and findings that\n have a resource type of AwsEc2NetworkInterface.

    \n
      \n
    • \n

      \n ResourceType PREFIX AwsIam\n

      \n
      • \n
    • \n

      \n ResourceType PREFIX AwsEc2\n

      \n
      • \n
    • \n

      \n ResourceType NOT_EQUALS AwsIamPolicy\n

      \n
      • \n
    • \n

      \n ResourceType NOT_EQUALS AwsEc2NetworkInterface\n

      \n
      • \n
    " } }, "Value": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The string filter value.

    " + "smithy.api#documentation": "

    The string filter value. Filter values are case sensitive. For example, the product name\n for control-based findings is Security Hub. If you provide security hub\n as the filter text, then there is no match.

    " } } }, @@ -7485,6 +12384,14 @@ { "value": "PREFIX", "name": "PREFIX" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" + }, + { + "value": "PREFIX_NOT_EQUALS", + "name": "PREFIX_NOT_EQUALS" } ] } @@ -7569,18 +12476,18 @@ "com.amazonaws.securityhub#TagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.securityhub#ResourceArn", + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", "traits": { - "smithy.api#documentation": "

    The ARN of the resource to apply the tags to.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The tags to add to the resource.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.securityhub#TagMap", + "ResourceArn": { + "target": "com.amazonaws.securityhub#ResourceArn", "traits": { - "smithy.api#documentation": "

    The tags to add to the resource.

    ", + "smithy.api#documentation": "

    The ARN of the resource to apply the tags to.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -7602,16 +12509,10 @@ "com.amazonaws.securityhub#ThreatIntelIndicator": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The value of a threat intelligence indicator.

    " - } - }, - "SourceUrl": { + "Source": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The URL to the page or site where you can get more information about the threat\n intelligence indicator.

    " + "smithy.api#documentation": "

    The source of the threat intelligence indicator.

    " } }, "Type": { @@ -7626,16 +12527,22 @@ "smithy.api#documentation": "

    The category of a threat intelligence indicator.

    " } }, - "Source": { + "LastObservedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The source of the threat intelligence indicator.

    " + "smithy.api#documentation": "

    Indicates when the most recent instance of a threat intelligence indicator was\n observed.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "LastObservedAt": { + "SourceUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The URL to the page or site where you can get more information about the threat\n intelligence indicator.

    " + } + }, + "Value": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The date and time when the most recent instance of a threat intelligence indicator was\n observed.

    " + "smithy.api#documentation": "

    The value of a threat intelligence indicator.

    " } } }, @@ -7774,14 +12681,6 @@ "com.amazonaws.securityhub#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.securityhub#TagKeyList", - "traits": { - "smithy.api#documentation": "

    The tag keys associated with the tags to remove from the resource.

    ", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.securityhub#ResourceArn", "traits": { @@ -7789,6 +12688,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TagKeys": { + "target": "com.amazonaws.securityhub#TagKeyList", + "traits": { + "smithy.api#documentation": "

    The tag keys associated with the tags to remove from the resource.

    ", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -7830,6 +12737,12 @@ "com.amazonaws.securityhub#UpdateActionTargetRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The updated name of the custom action target.

    " + } + }, "ActionTargetArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -7843,12 +12756,6 @@ "traits": { "smithy.api#documentation": "

    The updated description for the custom action target.

    " } - }, - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The updated name of the custom action target.

    " - } } } }, @@ -7893,6 +12800,13 @@ "com.amazonaws.securityhub#UpdateFindingsRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "traits": { + "smithy.api#documentation": "

    A collection of attributes that specify which findings you want to update.

    ", + "smithy.api#required": {} + } + }, "RecordState": { "target": "com.amazonaws.securityhub#RecordState", "traits": { @@ -7904,13 +12818,6 @@ "traits": { "smithy.api#documentation": "

    The updated note for the finding.

    " } - }, - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", - "traits": { - "smithy.api#documentation": "

    A collection of attributes that specify which findings you want to update.

    ", - "smithy.api#required": {} - } } } }, @@ -7955,12 +12862,6 @@ "com.amazonaws.securityhub#UpdateInsightRequest": { "type": "structure", "members": { - "GroupByAttribute": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

    The updated GroupBy attribute that defines this insight.

    " - } - }, "InsightArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -7969,16 +12870,22 @@ "smithy.api#required": {} } }, - "Name": { + "Filters": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "traits": { + "smithy.api#documentation": "

    The updated filters that define this insight.

    " + } + }, + "GroupByAttribute": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The updated name for the insight.

    " + "smithy.api#documentation": "

    The updated GroupBy attribute that defines this insight.

    " } }, - "Filters": { - "target": "com.amazonaws.securityhub#AwsSecurityFindingFilters", + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The updated filters that define this insight.

    " + "smithy.api#documentation": "

    The updated name for the insight.

    " } } } @@ -8070,10 +12977,12 @@ "com.amazonaws.securityhub#UpdateStandardsControlRequest": { "type": "structure", "members": { - "ControlStatus": { - "target": "com.amazonaws.securityhub#ControlStatus", + "StandardsControlArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The updated status of the security standard control.

    " + "smithy.api#documentation": "

    The ARN of the security standard control to enable or disable.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "DisabledReason": { @@ -8082,12 +12991,10 @@ "smithy.api#documentation": "

    A description of the reason why you are disabling a security standard control. If you\n are disabling a control, then this is required.

    " } }, - "StandardsControlArn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ControlStatus": { + "target": "com.amazonaws.securityhub#ControlStatus", "traits": { - "smithy.api#documentation": "

    The ARN of the security standard control to enable or disable.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The updated status of the security standard control.

    " } } } @@ -8122,16 +13029,17 @@ "com.amazonaws.securityhub#Vulnerability": { "type": "structure", "members": { - "RelatedVulnerabilities": { - "target": "com.amazonaws.securityhub#StringList", + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    List of vulnerabilities that are related to this vulnerability.

    " + "smithy.api#documentation": "

    The identifier of the vulnerability.

    ", + "smithy.api#required": {} } }, - "Cvss": { - "target": "com.amazonaws.securityhub#CvssList", + "RelatedVulnerabilities": { + "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "

    CVSS scores from the advisory related to the vulnerability.

    " + "smithy.api#documentation": "

    List of vulnerabilities that are related to this vulnerability.

    " } }, "Vendor": { @@ -8146,11 +13054,10 @@ "smithy.api#documentation": "

    List of software packages that have the vulnerability.

    " } }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Cvss": { + "target": "com.amazonaws.securityhub#CvssList", "traits": { - "smithy.api#documentation": "

    The identifier of the vulnerability.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    CVSS scores from the advisory related to the vulnerability.

    " } }, "ReferenceUrls": { @@ -8176,32 +13083,32 @@ "VendorCreatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The datetime when the vulnerability advisory was created.

    " + "smithy.api#documentation": "

    Indicates when the vulnerability advisory was created.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "VendorUpdatedAt": { + "VendorSeverity": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The datetime when the vulnerability advisory was last updated.

    " + "smithy.api#documentation": "

    The severity that the vendor assigned to the vulnerability.

    " } }, - "VendorSeverity": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The severity that the vendor assigned to the vulnerability.

    " + "smithy.api#documentation": "

    The name of the vendor.

    ", + "smithy.api#required": {} } }, - "Url": { + "VendorUpdatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The URL of the vulnerability advisory.

    " + "smithy.api#documentation": "

    Indicates when the vulnerability advisory was last updated.

    \n

    Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

    " } }, - "Name": { + "Url": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The name of the vendor.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The URL of the vulnerability advisory.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/serverlessapplicationrepository.2017-09-08.json b/codegen/sdk-codegen/aws-models/serverlessapplicationrepository.2017-09-08.json index 00a799020fe4..cc8af3321a5c 100644 --- a/codegen/sdk-codegen/aws-models/serverlessapplicationrepository.2017-09-08.json +++ b/codegen/sdk-codegen/aws-models/serverlessapplicationrepository.2017-09-08.json @@ -63,19 +63,19 @@ "smithy.api#jsonName": "principalOrgIDs" } }, - "Actions": { + "Principals": { "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", "traits": { - "smithy.api#documentation": "

    For the list of actions supported for this operation, see Application \n Permissions.

    ", - "smithy.api#jsonName": "actions", + "smithy.api#documentation": "

    An array of AWS account IDs, or * to make the application public.

    ", + "smithy.api#jsonName": "principals", "smithy.api#required": {} } }, - "Principals": { + "Actions": { "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", "traits": { - "smithy.api#documentation": "

    An array of AWS account IDs, or * to make the application public.

    ", - "smithy.api#jsonName": "principals", + "smithy.api#documentation": "

    For the list of actions supported for this operation, see Application \n Permissions.

    ", + "smithy.api#jsonName": "actions", "smithy.api#required": {} } }, @@ -94,21 +94,14 @@ "com.amazonaws.serverlessapplicationrepository#ApplicationSummary": { "type": "structure", "members": { - "ApplicationId": { + "Author": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", - "smithy.api#jsonName": "applicationId", + "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", + "smithy.api#jsonName": "author", "smithy.api#required": {} } }, - "SpdxLicenseId": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", - "smithy.api#jsonName": "spdxLicenseId" - } - }, "HomePageUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -123,19 +116,26 @@ "smithy.api#jsonName": "labels" } }, - "Author": { + "Description": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", - "smithy.api#jsonName": "author", + "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", + "smithy.api#jsonName": "description", "smithy.api#required": {} } }, - "Description": { + "SpdxLicenseId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", - "smithy.api#jsonName": "description", + "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", + "smithy.api#jsonName": "spdxLicenseId" + } + }, + "ApplicationId": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", + "smithy.api#jsonName": "applicationId", "smithy.api#required": {} } }, @@ -268,62 +268,68 @@ "com.amazonaws.serverlessapplicationrepository#CreateApplicationRequest": { "type": "structure", "members": { - "Description": { + "SemanticVersion": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", - "smithy.api#jsonName": "description", - "smithy.api#required": {} + "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", + "smithy.api#jsonName": "semanticVersion" } }, - "SpdxLicenseId": { + "LicenseBody": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", - "smithy.api#jsonName": "spdxLicenseId" + "smithy.api#documentation": "

    A local text file that contains the license of the app that matches the spdxLicenseID value of your application.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    ", + "smithy.api#jsonName": "licenseBody" } }, - "TemplateBody": { + "ReadmeUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The local raw packaged AWS SAM template file of your application.\n The file has the format file://<path>/<filename>.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    ", - "smithy.api#jsonName": "templateBody" + "smithy.api#documentation": "

    A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    ", + "smithy.api#jsonName": "readmeUrl" } }, - "Author": { + "LicenseUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", - "smithy.api#jsonName": "author", - "smithy.api#required": {} + "smithy.api#documentation": "

    A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    ", + "smithy.api#jsonName": "licenseUrl" } }, - "TemplateUrl": { + "ReadmeBody": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the S3 object containing the packaged AWS SAM template of your application.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    ", - "smithy.api#jsonName": "templateUrl" + "smithy.api#documentation": "

    A local text readme file in Markdown language that contains a more detailed description of the application and how it works.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    ", + "smithy.api#jsonName": "readmeBody" } }, - "HomePageUrl": { + "SourceCodeUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", - "smithy.api#jsonName": "homePageUrl" + "smithy.api#documentation": "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    ", + "smithy.api#jsonName": "sourceCodeUrl" } }, - "ReadmeUrl": { + "SourceCodeArchiveUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    ", - "smithy.api#jsonName": "readmeUrl" + "smithy.api#documentation": "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    ", + "smithy.api#jsonName": "sourceCodeArchiveUrl" } }, - "LicenseUrl": { + "TemplateBody": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    ", - "smithy.api#jsonName": "licenseUrl" + "smithy.api#documentation": "

    The local raw packaged AWS SAM template file of your application.\n The file has the format file://<path>/<filename>.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    ", + "smithy.api#jsonName": "templateBody" + } + }, + "Name": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The name of the application that you want to publish.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    ", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, "Labels": { @@ -333,47 +339,41 @@ "smithy.api#jsonName": "labels" } }, - "SemanticVersion": { + "SpdxLicenseId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", - "smithy.api#jsonName": "semanticVersion" + "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", + "smithy.api#jsonName": "spdxLicenseId" } }, - "Name": { + "Description": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The name of the application that you want to publish.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    ", - "smithy.api#jsonName": "name", + "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", + "smithy.api#jsonName": "description", "smithy.api#required": {} } }, - "LicenseBody": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    A local text file that contains the license of the app that matches the spdxLicenseID value of your application.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    ", - "smithy.api#jsonName": "licenseBody" - } - }, - "ReadmeBody": { + "Author": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A local text readme file in Markdown language that contains a more detailed description of the application and how it works.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    ", - "smithy.api#jsonName": "readmeBody" + "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", + "smithy.api#jsonName": "author", + "smithy.api#required": {} } }, - "SourceCodeUrl": { + "TemplateUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    ", - "smithy.api#jsonName": "sourceCodeUrl" + "smithy.api#documentation": "

    A link to the S3 object containing the packaged AWS SAM template of your application.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    ", + "smithy.api#jsonName": "templateUrl" } }, - "SourceCodeArchiveUrl": { + "HomePageUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    ", - "smithy.api#jsonName": "sourceCodeArchiveUrl" + "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", + "smithy.api#jsonName": "homePageUrl" } } } @@ -381,11 +381,11 @@ "com.amazonaws.serverlessapplicationrepository#CreateApplicationResponse": { "type": "structure", "members": { - "Description": { + "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", + "smithy.api#jsonName": "applicationId" } }, "Author": { @@ -395,25 +395,25 @@ "smithy.api#jsonName": "author" } }, - "ApplicationId": { + "CreationTime": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", - "smithy.api#jsonName": "applicationId" + "smithy.api#documentation": "

    The date and time this resource was created.

    ", + "smithy.api#jsonName": "creationTime" } }, - "CreationTime": { + "Description": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The date and time this resource was created.

    ", - "smithy.api#jsonName": "creationTime" + "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", + "smithy.api#jsonName": "description" } }, - "Version": { - "target": "com.amazonaws.serverlessapplicationrepository#Version", + "ReadmeUrl": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    Version information about the application.

    ", - "smithy.api#jsonName": "version" + "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", + "smithy.api#jsonName": "readmeUrl" } }, "LicenseUrl": { @@ -423,25 +423,25 @@ "smithy.api#jsonName": "licenseUrl" } }, - "ReadmeUrl": { + "HomePageUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", - "smithy.api#jsonName": "readmeUrl" + "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", + "smithy.api#jsonName": "homePageUrl" } }, - "VerifiedAuthorUrl": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "Labels": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", "traits": { - "smithy.api#documentation": "

    The URL to the public profile of a verified author. This URL is submitted by the author.

    ", - "smithy.api#jsonName": "verifiedAuthorUrl" + "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", + "smithy.api#jsonName": "labels" } }, - "IsVerifiedAuthor": { - "target": "com.amazonaws.serverlessapplicationrepository#__boolean", + "SpdxLicenseId": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

    ", - "smithy.api#jsonName": "isVerifiedAuthor" + "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", + "smithy.api#jsonName": "spdxLicenseId" } }, "Name": { @@ -451,25 +451,25 @@ "smithy.api#jsonName": "name" } }, - "HomePageUrl": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "IsVerifiedAuthor": { + "target": "com.amazonaws.serverlessapplicationrepository#__boolean", "traits": { - "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", - "smithy.api#jsonName": "homePageUrl" + "smithy.api#documentation": "

    Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

    ", + "smithy.api#jsonName": "isVerifiedAuthor" } }, - "Labels": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", + "VerifiedAuthorUrl": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", - "smithy.api#jsonName": "labels" + "smithy.api#documentation": "

    The URL to the public profile of a verified author. This URL is submitted by the author.

    ", + "smithy.api#jsonName": "verifiedAuthorUrl" } }, - "SpdxLicenseId": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "Version": { + "target": "com.amazonaws.serverlessapplicationrepository#Version", "traits": { - "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", - "smithy.api#jsonName": "spdxLicenseId" + "smithy.api#documentation": "

    Version information about the application.

    ", + "smithy.api#jsonName": "version" } } } @@ -511,12 +511,11 @@ "com.amazonaws.serverlessapplicationrepository#CreateApplicationVersionRequest": { "type": "structure", "members": { - "SemanticVersion": { + "SourceCodeArchiveUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The semantic version of the new version.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    ", + "smithy.api#jsonName": "sourceCodeArchiveUrl" } }, "TemplateUrl": { @@ -526,13 +525,6 @@ "smithy.api#jsonName": "templateUrl" } }, - "SourceCodeArchiveUrl": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    ", - "smithy.api#jsonName": "sourceCodeArchiveUrl" - } - }, "SourceCodeUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -548,6 +540,14 @@ "smithy.api#required": {} } }, + "SemanticVersion": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The semantic version of the new version.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "TemplateBody": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -560,18 +560,18 @@ "com.amazonaws.serverlessapplicationrepository#CreateApplicationVersionResponse": { "type": "structure", "members": { - "SourceCodeArchiveUrl": { + "SemanticVersion": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    ", - "smithy.api#jsonName": "sourceCodeArchiveUrl" + "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", + "smithy.api#jsonName": "semanticVersion" } }, - "TemplateUrl": { + "CreationTime": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the packaged AWS SAM template of your application.

    ", - "smithy.api#jsonName": "templateUrl" + "smithy.api#documentation": "

    The date and time this resource was created.

    ", + "smithy.api#jsonName": "creationTime" } }, "ParameterDefinitions": { @@ -588,18 +588,18 @@ "smithy.api#jsonName": "sourceCodeUrl" } }, - "SemanticVersion": { + "SourceCodeArchiveUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", - "smithy.api#jsonName": "semanticVersion" + "smithy.api#documentation": "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    ", + "smithy.api#jsonName": "sourceCodeArchiveUrl" } }, - "CreationTime": { + "TemplateUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The date and time this resource was created.

    ", - "smithy.api#jsonName": "creationTime" + "smithy.api#documentation": "

    A link to the packaged AWS SAM template of your application.

    ", + "smithy.api#jsonName": "templateUrl" } }, "ResourcesSupported": { @@ -659,18 +659,11 @@ "com.amazonaws.serverlessapplicationrepository#CreateCloudFormationChangeSetRequest": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    ", - "smithy.api#jsonName": "templateId" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "ResourceTypes": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", "traits": { "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", - "smithy.api#jsonName": "changeSetName" + "smithy.api#jsonName": "resourceTypes" } }, "StackName": { @@ -681,46 +674,39 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOfTag", + "ClientToken": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", - "smithy.api#jsonName": "tags" + "smithy.api#jsonName": "clientToken" } }, - "RollbackConfiguration": { - "target": "com.amazonaws.serverlessapplicationrepository#RollbackConfiguration", + "ChangeSetName": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", - "smithy.api#jsonName": "rollbackConfiguration" + "smithy.api#jsonName": "changeSetName" } }, - "ResourceTypes": { + "NotificationArns": { "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", "traits": { "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", - "smithy.api#jsonName": "resourceTypes" - } - }, - "Capabilities": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", - "traits": { - "smithy.api#documentation": "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS:TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    ", - "smithy.api#jsonName": "capabilities" + "smithy.api#jsonName": "notificationArns" } }, - "ParameterOverrides": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOfParameterValue", + "Tags": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOfTag", "traits": { - "smithy.api#documentation": "

    A list of parameter values for the parameters of the application.

    ", - "smithy.api#jsonName": "parameterOverrides" + "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", + "smithy.api#jsonName": "tags" } }, - "Description": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "RollbackConfiguration": { + "target": "com.amazonaws.serverlessapplicationrepository#RollbackConfiguration", "traits": { "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", - "smithy.api#jsonName": "description" + "smithy.api#jsonName": "rollbackConfiguration" } }, "SemanticVersion": { @@ -730,13 +716,6 @@ "smithy.api#jsonName": "semanticVersion" } }, - "ClientToken": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", - "smithy.api#jsonName": "clientToken" - } - }, "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -745,11 +724,32 @@ "smithy.api#required": {} } }, - "NotificationArns": { + "TemplateId": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    ", + "smithy.api#jsonName": "templateId" + } + }, + "ParameterOverrides": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOfParameterValue", + "traits": { + "smithy.api#documentation": "

    A list of parameter values for the parameters of the application.

    ", + "smithy.api#jsonName": "parameterOverrides" + } + }, + "Capabilities": { "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", + "traits": { + "smithy.api#documentation": "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS:TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    ", + "smithy.api#jsonName": "capabilities" + } + }, + "Description": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { "smithy.api#documentation": "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    ", - "smithy.api#jsonName": "notificationArns" + "smithy.api#jsonName": "description" } } } @@ -771,18 +771,18 @@ "smithy.api#jsonName": "applicationId" } }, - "StackId": { + "SemanticVersion": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The unique ID of the stack.

    ", - "smithy.api#jsonName": "stackId" + "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", + "smithy.api#jsonName": "semanticVersion" } }, - "SemanticVersion": { + "StackId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", - "smithy.api#jsonName": "semanticVersion" + "smithy.api#documentation": "

    The unique ID of the stack.

    ", + "smithy.api#jsonName": "stackId" } } } @@ -844,25 +844,11 @@ "com.amazonaws.serverlessapplicationrepository#CreateCloudFormationTemplateResponse": { "type": "structure", "members": { - "ExpirationTime": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    The date and time this template expires. Templates\n expire 1 hour after creation.

    ", - "smithy.api#jsonName": "expirationTime" - } - }, - "Status": { - "target": "com.amazonaws.serverlessapplicationrepository#Status", - "traits": { - "smithy.api#documentation": "

    Status of the template creation workflow.

    Possible values: PREPARING | ACTIVE | EXPIRED\n

    ", - "smithy.api#jsonName": "status" - } - }, - "TemplateId": { + "SemanticVersion": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    ", - "smithy.api#jsonName": "templateId" + "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", + "smithy.api#jsonName": "semanticVersion" } }, "CreationTime": { @@ -872,6 +858,13 @@ "smithy.api#jsonName": "creationTime" } }, + "TemplateId": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    ", + "smithy.api#jsonName": "templateId" + } + }, "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -879,11 +872,18 @@ "smithy.api#jsonName": "applicationId" } }, - "SemanticVersion": { + "ExpirationTime": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", - "smithy.api#jsonName": "semanticVersion" + "smithy.api#documentation": "

    The date and time this template expires. Templates\n expire 1 hour after creation.

    ", + "smithy.api#jsonName": "expirationTime" + } + }, + "Status": { + "target": "com.amazonaws.serverlessapplicationrepository#Status", + "traits": { + "smithy.api#documentation": "

    Status of the template creation workflow.

    Possible values: PREPARING | ACTIVE | EXPIRED\n

    ", + "smithy.api#jsonName": "status" } }, "TemplateUrl": { @@ -1062,13 +1062,6 @@ "com.amazonaws.serverlessapplicationrepository#GetApplicationRequest": { "type": "structure", "members": { - "SemanticVersion": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    The semantic version of the application to get.

    ", - "smithy.api#httpQuery": "semanticVersion" - } - }, "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -1076,38 +1069,45 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "SemanticVersion": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The semantic version of the application to get.

    ", + "smithy.api#httpQuery": "semanticVersion" + } } } }, "com.amazonaws.serverlessapplicationrepository#GetApplicationResponse": { "type": "structure", "members": { - "VerifiedAuthorUrl": { + "HomePageUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The URL to the public profile of a verified author. This URL is submitted by the author.

    ", - "smithy.api#jsonName": "verifiedAuthorUrl" + "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", + "smithy.api#jsonName": "homePageUrl" } }, - "ReadmeUrl": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "Labels": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", "traits": { - "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", - "smithy.api#jsonName": "readmeUrl" + "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", + "smithy.api#jsonName": "labels" } }, - "ApplicationId": { + "LicenseUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", - "smithy.api#jsonName": "applicationId" + "smithy.api#documentation": "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    ", + "smithy.api#jsonName": "licenseUrl" } }, - "LicenseUrl": { + "Name": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    ", - "smithy.api#jsonName": "licenseUrl" + "smithy.api#documentation": "

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    ", + "smithy.api#jsonName": "name" } }, "IsVerifiedAuthor": { @@ -1117,25 +1117,18 @@ "smithy.api#jsonName": "isVerifiedAuthor" } }, - "CreationTime": { + "SpdxLicenseId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The date and time this resource was created.

    ", - "smithy.api#jsonName": "creationTime" - } - }, - "Version": { - "target": "com.amazonaws.serverlessapplicationrepository#Version", - "traits": { - "smithy.api#documentation": "

    Version information about the application.

    ", - "smithy.api#jsonName": "version" + "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", + "smithy.api#jsonName": "spdxLicenseId" } }, - "SpdxLicenseId": { + "ReadmeUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", - "smithy.api#jsonName": "spdxLicenseId" + "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", + "smithy.api#jsonName": "readmeUrl" } }, "Description": { @@ -1145,18 +1138,11 @@ "smithy.api#jsonName": "description" } }, - "Name": { + "CreationTime": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    ", - "smithy.api#jsonName": "name" - } - }, - "Labels": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", - "traits": { - "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", - "smithy.api#jsonName": "labels" + "smithy.api#documentation": "

    The date and time this resource was created.

    ", + "smithy.api#jsonName": "creationTime" } }, "Author": { @@ -1166,11 +1152,25 @@ "smithy.api#jsonName": "author" } }, - "HomePageUrl": { + "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", - "smithy.api#jsonName": "homePageUrl" + "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", + "smithy.api#jsonName": "applicationId" + } + }, + "VerifiedAuthorUrl": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The URL to the public profile of a verified author. This URL is submitted by the author.

    ", + "smithy.api#jsonName": "verifiedAuthorUrl" + } + }, + "Version": { + "target": "com.amazonaws.serverlessapplicationrepository#Version", + "traits": { + "smithy.api#documentation": "

    Version information about the application.

    ", + "smithy.api#jsonName": "version" } } } @@ -1233,25 +1233,25 @@ "com.amazonaws.serverlessapplicationrepository#GetCloudFormationTemplateResponse": { "type": "structure", "members": { - "SemanticVersion": { + "TemplateUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", - "smithy.api#jsonName": "semanticVersion" + "smithy.api#documentation": "

    A link to the template that can be used to deploy the application using\n AWS CloudFormation.

    ", + "smithy.api#jsonName": "templateUrl" } }, - "CreationTime": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "Status": { + "target": "com.amazonaws.serverlessapplicationrepository#Status", "traits": { - "smithy.api#documentation": "

    The date and time this resource was created.

    ", - "smithy.api#jsonName": "creationTime" + "smithy.api#documentation": "

    Status of the template creation workflow.

    Possible values: PREPARING | ACTIVE | EXPIRED\n

    ", + "smithy.api#jsonName": "status" } }, - "TemplateId": { + "SemanticVersion": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    ", - "smithy.api#jsonName": "templateId" + "smithy.api#documentation": "

    The semantic version of the application:

    \n https://semver.org/\n

    ", + "smithy.api#jsonName": "semanticVersion" } }, "ApplicationId": { @@ -1261,18 +1261,18 @@ "smithy.api#jsonName": "applicationId" } }, - "Status": { - "target": "com.amazonaws.serverlessapplicationrepository#Status", + "CreationTime": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    Status of the template creation workflow.

    Possible values: PREPARING | ACTIVE | EXPIRED\n

    ", - "smithy.api#jsonName": "status" + "smithy.api#documentation": "

    The date and time this resource was created.

    ", + "smithy.api#jsonName": "creationTime" } }, - "TemplateUrl": { + "TemplateId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the template that can be used to deploy the application using\n AWS CloudFormation.

    ", - "smithy.api#jsonName": "templateUrl" + "smithy.api#documentation": "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    ", + "smithy.api#jsonName": "templateId" } }, "ExpirationTime": { @@ -1339,27 +1339,17 @@ "method": "GET", "uri": "/applications/{ApplicationId}/dependencies", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxItems" } } }, "com.amazonaws.serverlessapplicationrepository#ListApplicationDependenciesRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.serverlessapplicationrepository#MaxItems", - "traits": { - "smithy.api#documentation": "

    The total number of items to return.

    ", - "smithy.api#httpQuery": "maxItems" - } - }, - "ApplicationId": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the application.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -1373,6 +1363,21 @@ "smithy.api#documentation": "

    The semantic version of the application to get.

    ", "smithy.api#httpQuery": "semanticVersion" } + }, + "ApplicationId": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the application.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "com.amazonaws.serverlessapplicationrepository#MaxItems", + "traits": { + "smithy.api#documentation": "

    The total number of items to return.

    ", + "smithy.api#httpQuery": "maxItems" + } } } }, @@ -1426,6 +1431,11 @@ "method": "GET", "uri": "/applications/{ApplicationId}/versions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxItems" } } }, @@ -1459,19 +1469,19 @@ "com.amazonaws.serverlessapplicationrepository#ListApplicationVersionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    The token to request the next page of results.

    ", - "smithy.api#jsonName": "nextToken" - } - }, "Versions": { "target": "com.amazonaws.serverlessapplicationrepository#__listOfVersionSummary", "traits": { "smithy.api#documentation": "

    An array of version summaries for the application.

    ", "smithy.api#jsonName": "versions" } + }, + "NextToken": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The token to request the next page of results.

    ", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -1503,6 +1513,11 @@ "method": "GET", "uri": "/applications", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxItems" } } }, @@ -1528,19 +1543,19 @@ "com.amazonaws.serverlessapplicationrepository#ListApplicationsResponse": { "type": "structure", "members": { - "Applications": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOfApplicationSummary", - "traits": { - "smithy.api#documentation": "

    An array of application summaries.

    ", - "smithy.api#jsonName": "applications" - } - }, "NextToken": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { "smithy.api#documentation": "

    The token to request the next page of results.

    ", "smithy.api#jsonName": "nextToken" } + }, + "Applications": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOfApplicationSummary", + "traits": { + "smithy.api#documentation": "

    An array of application summaries.

    ", + "smithy.api#jsonName": "applications" + } } } }, @@ -1580,33 +1595,61 @@ "com.amazonaws.serverlessapplicationrepository#ParameterDefinition": { "type": "structure", "members": { - "MinLength": { + "AllowedValues": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", + "traits": { + "smithy.api#documentation": "

    An array containing the list of values allowed for the parameter.

    ", + "smithy.api#jsonName": "allowedValues" + } + }, + "MaxLength": { "target": "com.amazonaws.serverlessapplicationrepository#__integer", "traits": { - "smithy.api#documentation": "

    An integer value that determines the smallest number of characters that you want to allow for String types.

    ", - "smithy.api#jsonName": "minLength" + "smithy.api#documentation": "

    An integer value that determines the largest number of characters that you want to allow for String types.

    ", + "smithy.api#jsonName": "maxLength" } }, - "Name": { + "MaxValue": { + "target": "com.amazonaws.serverlessapplicationrepository#__integer", + "traits": { + "smithy.api#documentation": "

    A numeric value that determines the largest numeric value that you want to allow for Number types.

    ", + "smithy.api#jsonName": "maxValue" + } + }, + "Description": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The name of the parameter.

    ", - "smithy.api#jsonName": "name", + "smithy.api#documentation": "

    A string of up to 4,000 characters that describes the parameter.

    ", + "smithy.api#jsonName": "description" + } + }, + "ReferencedByResources": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", + "traits": { + "smithy.api#documentation": "

    A list of AWS SAM resources that use this parameter.

    ", + "smithy.api#jsonName": "referencedByResources", "smithy.api#required": {} } }, - "DefaultValue": { + "NoEcho": { + "target": "com.amazonaws.serverlessapplicationrepository#__boolean", + "traits": { + "smithy.api#documentation": "

    Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the\n value to true, the parameter value is masked with asterisks (*****).

    ", + "smithy.api#jsonName": "noEcho" + } + }, + "Type": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A value of the appropriate type for the template to use if no value is specified when a stack is created.\n If you define constraints for the parameter, you must specify a value that adheres to those constraints.

    ", - "smithy.api#jsonName": "defaultValue" + "smithy.api#documentation": "

    The type of the parameter.

    Valid values: String | Number | List<Number> | CommaDelimitedList\n

    \n String: A literal string.

    For example, users can specify \"MyUserName\".

    \n Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the\n parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

    For example, users might specify \"8888\".

    \n List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when\n you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

    For example, users might specify \"80,20\", and then Ref results in [\"80\",\"20\"].

    \n CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas.\n Also, each member string is space-trimmed.

    For example, users might specify \"test,dev,prod\", and then Ref results in [\"test\",\"dev\",\"prod\"].

    ", + "smithy.api#jsonName": "type" } }, - "MaxValue": { - "target": "com.amazonaws.serverlessapplicationrepository#__integer", + "DefaultValue": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A numeric value that determines the largest numeric value that you want to allow for Number types.

    ", - "smithy.api#jsonName": "maxValue" + "smithy.api#documentation": "

    A value of the appropriate type for the template to use if no value is specified when a stack is created.\n If you define constraints for the parameter, you must specify a value that adheres to those constraints.

    ", + "smithy.api#jsonName": "defaultValue" } }, "AllowedPattern": { @@ -1616,13 +1659,6 @@ "smithy.api#jsonName": "allowedPattern" } }, - "MaxLength": { - "target": "com.amazonaws.serverlessapplicationrepository#__integer", - "traits": { - "smithy.api#documentation": "

    An integer value that determines the largest number of characters that you want to allow for String types.

    ", - "smithy.api#jsonName": "maxLength" - } - }, "ConstraintDescription": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -1637,41 +1673,20 @@ "smithy.api#jsonName": "minValue" } }, - "AllowedValues": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", - "traits": { - "smithy.api#documentation": "

    An array containing the list of values allowed for the parameter.

    ", - "smithy.api#jsonName": "allowedValues" - } - }, - "Type": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "MinLength": { + "target": "com.amazonaws.serverlessapplicationrepository#__integer", "traits": { - "smithy.api#documentation": "

    The type of the parameter.

    Valid values: String | Number | List<Number> | CommaDelimitedList\n

    \n String: A literal string.

    For example, users can specify \"MyUserName\".

    \n Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the\n parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

    For example, users might specify \"8888\".

    \n List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when\n you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

    For example, users might specify \"80,20\", and then Ref results in [\"80\",\"20\"].

    \n CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas.\n Also, each member string is space-trimmed.

    For example, users might specify \"test,dev,prod\", and then Ref results in [\"test\",\"dev\",\"prod\"].

    ", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "

    An integer value that determines the smallest number of characters that you want to allow for String types.

    ", + "smithy.api#jsonName": "minLength" } }, - "Description": { + "Name": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A string of up to 4,000 characters that describes the parameter.

    ", - "smithy.api#jsonName": "description" - } - }, - "ReferencedByResources": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", - "traits": { - "smithy.api#documentation": "

    A list of AWS SAM resources that use this parameter.

    ", - "smithy.api#jsonName": "referencedByResources", + "smithy.api#documentation": "

    The name of the parameter.

    ", + "smithy.api#jsonName": "name", "smithy.api#required": {} } - }, - "NoEcho": { - "target": "com.amazonaws.serverlessapplicationrepository#__boolean", - "traits": { - "smithy.api#documentation": "

    Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the\n value to true, the parameter value is masked with asterisks (*****).

    ", - "smithy.api#jsonName": "noEcho" - } } }, "traits": { @@ -1739,14 +1754,6 @@ "com.amazonaws.serverlessapplicationrepository#PutApplicationPolicyRequest": { "type": "structure", "members": { - "Statements": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOfApplicationPolicyStatement", - "traits": { - "smithy.api#documentation": "

    An array of policy statements applied to the application.

    ", - "smithy.api#jsonName": "statements", - "smithy.api#required": {} - } - }, "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -1754,6 +1761,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Statements": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOfApplicationPolicyStatement", + "traits": { + "smithy.api#documentation": "

    An array of policy statements applied to the application.

    ", + "smithy.api#jsonName": "statements", + "smithy.api#required": {} + } } } }, @@ -1794,19 +1809,19 @@ "com.amazonaws.serverlessapplicationrepository#RollbackTrigger": { "type": "structure", "members": { - "Arn": { + "Type": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { "smithy.api#documentation": "

    This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger\n Data Type.

    ", - "smithy.api#jsonName": "arn", + "smithy.api#jsonName": "type", "smithy.api#required": {} } }, - "Type": { + "Arn": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { "smithy.api#documentation": "

    This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger\n Data Type.

    ", - "smithy.api#jsonName": "type", + "smithy.api#jsonName": "arn", "smithy.api#required": {} } } @@ -1899,19 +1914,19 @@ "com.amazonaws.serverlessapplicationrepository#Tag": { "type": "structure", "members": { - "Key": { + "Value": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    This property corresponds to the content of the same name for the AWS CloudFormation Tag\n Data Type.

    ", - "smithy.api#jsonName": "key", + "smithy.api#documentation": "

    This property corresponds to the content of the same name for the AWS CloudFormation \n Tag\n \n Data Type.

    ", + "smithy.api#jsonName": "value", "smithy.api#required": {} } }, - "Value": { + "Key": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    This property corresponds to the content of the same name for the AWS CloudFormation \n Tag\n \n Data Type.

    ", - "smithy.api#jsonName": "value", + "smithy.api#documentation": "

    This property corresponds to the content of the same name for the AWS CloudFormation Tag\n Data Type.

    ", + "smithy.api#jsonName": "key", "smithy.api#required": {} } } @@ -1978,19 +1993,19 @@ "com.amazonaws.serverlessapplicationrepository#UnshareApplicationRequest": { "type": "structure", "members": { - "OrganizationId": { + "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The AWS Organization ID to unshare the application from.

    ", - "smithy.api#jsonName": "organizationId", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the application.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ApplicationId": { + "OrganizationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the application.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The AWS Organization ID to unshare the application from.

    ", + "smithy.api#jsonName": "organizationId", "smithy.api#required": {} } } @@ -2036,33 +2051,40 @@ "com.amazonaws.serverlessapplicationrepository#UpdateApplicationRequest": { "type": "structure", "members": { - "ApplicationId": { + "Description": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the application.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", + "smithy.api#jsonName": "description" } }, - "Author": { + "ReadmeUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", - "smithy.api#jsonName": "author" + "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", + "smithy.api#jsonName": "readmeUrl" } }, - "Description": { + "Labels": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", + "traits": { + "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", + "smithy.api#jsonName": "labels" + } + }, + "Author": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The description of the application.

    Minimum length=1. Maximum length=256

    ", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", + "smithy.api#jsonName": "author" } }, - "ReadmeUrl": { + "ApplicationId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", - "smithy.api#jsonName": "readmeUrl" + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the application.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ReadmeBody": { @@ -2078,52 +2100,31 @@ "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", "smithy.api#jsonName": "homePageUrl" } - }, - "Labels": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", - "traits": { - "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", - "smithy.api#jsonName": "labels" - } } } }, "com.amazonaws.serverlessapplicationrepository#UpdateApplicationResponse": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    The date and time this resource was created.

    ", - "smithy.api#jsonName": "creationTime" - } - }, - "ApplicationId": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", - "traits": { - "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", - "smithy.api#jsonName": "applicationId" - } - }, - "Author": { + "ReadmeUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", - "smithy.api#jsonName": "author" + "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", + "smithy.api#jsonName": "readmeUrl" } }, - "VerifiedAuthorUrl": { + "LicenseUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    The URL to the public profile of a verified author. This URL is submitted by the author.

    ", - "smithy.api#jsonName": "verifiedAuthorUrl" + "smithy.api#documentation": "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    ", + "smithy.api#jsonName": "licenseUrl" } }, - "Version": { - "target": "com.amazonaws.serverlessapplicationrepository#Version", + "IsVerifiedAuthor": { + "target": "com.amazonaws.serverlessapplicationrepository#__boolean", "traits": { - "smithy.api#documentation": "

    Version information about the application.

    ", - "smithy.api#jsonName": "version" + "smithy.api#documentation": "

    Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

    ", + "smithy.api#jsonName": "isVerifiedAuthor" } }, "Name": { @@ -2133,25 +2134,25 @@ "smithy.api#jsonName": "name" } }, - "LicenseUrl": { + "SpdxLicenseId": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    ", - "smithy.api#jsonName": "licenseUrl" + "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", + "smithy.api#jsonName": "spdxLicenseId" } }, - "IsVerifiedAuthor": { - "target": "com.amazonaws.serverlessapplicationrepository#__boolean", + "Labels": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", "traits": { - "smithy.api#documentation": "

    Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

    ", - "smithy.api#jsonName": "isVerifiedAuthor" + "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", + "smithy.api#jsonName": "labels" } }, - "ReadmeUrl": { + "HomePageUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    ", - "smithy.api#jsonName": "readmeUrl" + "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", + "smithy.api#jsonName": "homePageUrl" } }, "Description": { @@ -2161,25 +2162,39 @@ "smithy.api#jsonName": "description" } }, - "SpdxLicenseId": { + "Author": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A valid identifier from https://spdx.org/licenses/.

    ", - "smithy.api#jsonName": "spdxLicenseId" + "smithy.api#documentation": "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    ", + "smithy.api#jsonName": "author" } }, - "HomePageUrl": { + "CreationTime": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    ", - "smithy.api#jsonName": "homePageUrl" + "smithy.api#documentation": "

    The date and time this resource was created.

    ", + "smithy.api#jsonName": "creationTime" } }, - "Labels": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOf__string", + "ApplicationId": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { - "smithy.api#documentation": "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    ", - "smithy.api#jsonName": "labels" + "smithy.api#documentation": "

    The application Amazon Resource Name (ARN).

    ", + "smithy.api#jsonName": "applicationId" + } + }, + "Version": { + "target": "com.amazonaws.serverlessapplicationrepository#Version", + "traits": { + "smithy.api#documentation": "

    Version information about the application.

    ", + "smithy.api#jsonName": "version" + } + }, + "VerifiedAuthorUrl": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The URL to the public profile of a verified author. This URL is submitted by the author.

    ", + "smithy.api#jsonName": "verifiedAuthorUrl" } } } @@ -2187,11 +2202,19 @@ "com.amazonaws.serverlessapplicationrepository#Version": { "type": "structure", "members": { - "RequiredCapabilities": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOfCapability", + "ParameterDefinitions": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOfParameterDefinition", "traits": { - "smithy.api#documentation": "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS::TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    ", - "smithy.api#jsonName": "requiredCapabilities", + "smithy.api#documentation": "

    An array of parameter types supported by the application.

    ", + "smithy.api#jsonName": "parameterDefinitions", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.serverlessapplicationrepository#__string", + "traits": { + "smithy.api#documentation": "

    The date and time this resource was created.

    ", + "smithy.api#jsonName": "creationTime", "smithy.api#required": {} } }, @@ -2211,14 +2234,6 @@ "smithy.api#required": {} } }, - "ParameterDefinitions": { - "target": "com.amazonaws.serverlessapplicationrepository#__listOfParameterDefinition", - "traits": { - "smithy.api#documentation": "

    An array of parameter types supported by the application.

    ", - "smithy.api#jsonName": "parameterDefinitions", - "smithy.api#required": {} - } - }, "SourceCodeUrl": { "target": "com.amazonaws.serverlessapplicationrepository#__string", "traits": { @@ -2226,11 +2241,11 @@ "smithy.api#jsonName": "sourceCodeUrl" } }, - "CreationTime": { - "target": "com.amazonaws.serverlessapplicationrepository#__string", + "RequiredCapabilities": { + "target": "com.amazonaws.serverlessapplicationrepository#__listOfCapability", "traits": { - "smithy.api#documentation": "

    The date and time this resource was created.

    ", - "smithy.api#jsonName": "creationTime", + "smithy.api#documentation": "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS::TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    ", + "smithy.api#jsonName": "requiredCapabilities", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json b/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json index 1e4df13fe747..497c42b304e8 100644 --- a/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json +++ b/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json @@ -183,6 +183,9 @@ { "target": "com.amazonaws.servicecatalog#GetAWSOrganizationsAccessStatus" }, + { + "target": "com.amazonaws.servicecatalog#GetProvisionedProductOutputs" + }, { "target": "com.amazonaws.servicecatalog#ListAcceptedPortfolioShares" }, @@ -294,7 +297,7 @@ "name": "servicecatalog" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Service Catalog\n

    \n AWS Service Catalog enables\n organizations to create and manage catalogs of IT services that are approved for use on\n AWS. To get the most out of this documentation, you should be familiar with the \n terminology discussed in AWS Service Catalog Concepts.

    ", + "smithy.api#documentation": "AWS Service Catalog\n

    \n AWS Service Catalog enables\n organizations to create and manage catalogs of IT services that are approved for use on\n AWS. To get the most out of this\n documentation, you should be familiar with the \n terminology discussed in AWS Service Catalog Concepts.

    ", "smithy.api#title": "AWS Service Catalog" } }, @@ -342,7 +345,7 @@ "PortfolioShareType": { "target": "com.amazonaws.servicecatalog#PortfolioShareType", "traits": { - "smithy.api#documentation": "

    The type of shared portfolios to accept. The default is to accept imported portfolios.

    \n
      \n
    • \n

      \n AWS_ORGANIZATIONS - Accept portfolios shared by the master account of your organization.

      \n
      • \n
    • \n

      \n IMPORTED - Accept imported portfolios.

      \n
      • \n
    • \n

      \n AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

      \n
      • \n
    \n

    For example, aws servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS\n

    " + "smithy.api#documentation": "

    The type of shared portfolios to accept. The default is to accept imported portfolios.

    \n
      \n
    • \n

      \n AWS_ORGANIZATIONS - Accept portfolios shared by the management account of your\n organization.

      \n
      • \n
    • \n

      \n IMPORTED - Accept imported portfolios.

      \n
      • \n
    • \n

      \n AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

      \n
      • \n
    \n

    For example, aws servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS\n

    " } }, "PortfolioId": { @@ -530,17 +533,17 @@ "com.amazonaws.servicecatalog#AssociatePrincipalWithPortfolioInput": { "type": "structure", "members": { - "PrincipalType": { - "target": "com.amazonaws.servicecatalog#PrincipalType", + "PrincipalARN": { + "target": "com.amazonaws.servicecatalog#PrincipalARN", "traits": { - "smithy.api#documentation": "

    The principal type. The supported value is IAM.

    ", + "smithy.api#documentation": "

    The ARN of the principal (IAM user, role, or group).

    ", "smithy.api#required": {} } }, - "PrincipalARN": { - "target": "com.amazonaws.servicecatalog#PrincipalARN", + "PrincipalType": { + "target": "com.amazonaws.servicecatalog#PrincipalType", "traits": { - "smithy.api#documentation": "

    The ARN of the principal (IAM user, role, or group).

    ", + "smithy.api#documentation": "

    The principal type. The supported value is IAM.

    ", "smithy.api#required": {} } }, @@ -589,10 +592,11 @@ "com.amazonaws.servicecatalog#AssociateProductWithPortfolioInput": { "type": "structure", "members": { - "SourcePortfolioId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the source portfolio.

    " + "smithy.api#documentation": "

    The product identifier.

    ", + "smithy.api#required": {} } }, "PortfolioId": { @@ -602,17 +606,16 @@ "smithy.api#required": {} } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "SourcePortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The identifier of the source portfolio.

    " } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The product identifier.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } } } @@ -647,17 +650,17 @@ "com.amazonaws.servicecatalog#AssociateServiceActionWithProvisioningArtifactInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    ", + "smithy.api#required": {} } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "ServiceActionId": { @@ -667,10 +670,10 @@ "smithy.api#required": {} } }, - "ProvisioningArtifactId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    ", + "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    ", "smithy.api#required": {} } } @@ -715,17 +718,17 @@ "com.amazonaws.servicecatalog#AssociateTagOptionWithResourceInput": { "type": "structure", "members": { - "TagOptionId": { - "target": "com.amazonaws.servicecatalog#TagOptionId", + "ResourceId": { + "target": "com.amazonaws.servicecatalog#ResourceId", "traits": { - "smithy.api#documentation": "

    The TagOption identifier.

    ", + "smithy.api#documentation": "

    The resource identifier.

    ", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.servicecatalog#ResourceId", + "TagOptionId": { + "target": "com.amazonaws.servicecatalog#TagOptionId", "traits": { - "smithy.api#documentation": "

    The resource identifier.

    ", + "smithy.api#documentation": "

    The TagOption identifier.

    ", "smithy.api#required": {} } } @@ -804,18 +807,18 @@ "com.amazonaws.servicecatalog#BatchDisassociateServiceActionFromProvisioningArtifactInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, "ServiceActionAssociations": { "target": "com.amazonaws.servicecatalog#ServiceActionAssociations", "traits": { "smithy.api#documentation": "

    One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    ", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } } } }, @@ -916,28 +919,28 @@ "com.amazonaws.servicecatalog#ConstraintDetail": { "type": "structure", "members": { - "ProductId": { + "PortfolioId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

    " + "smithy.api#documentation": "

    The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

    " } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ConstraintDescription", + "ConstraintId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The description of the constraint.

    " + "smithy.api#documentation": "

    The identifier of the constraint.

    " } }, - "ConstraintId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the constraint.

    " + "smithy.api#documentation": "

    The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

    " } }, - "Type": { - "target": "com.amazonaws.servicecatalog#ConstraintType", + "Description": { + "target": "com.amazonaws.servicecatalog#ConstraintDescription", "traits": { - "smithy.api#documentation": "

    The type of constraint.

    \n
      \n
    • \n

      \n LAUNCH\n

      \n
      • \n
    • \n

      \n NOTIFICATION\n

      \n
      • \n
    • \n

      STACKSET

      \n
      • \n
    • \n

      \n TEMPLATE\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The description of the constraint.

    " } }, "Owner": { @@ -946,10 +949,10 @@ "smithy.api#documentation": "

    The owner of the constraint.

    " } }, - "PortfolioId": { - "target": "com.amazonaws.servicecatalog#Id", + "Type": { + "target": "com.amazonaws.servicecatalog#ConstraintType", "traits": { - "smithy.api#documentation": "

    The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

    " + "smithy.api#documentation": "

    The type of constraint.

    \n
      \n
    • \n

      \n LAUNCH\n

      \n
      • \n
    • \n

      \n NOTIFICATION\n

      \n
      • \n
    • \n

      STACKSET

      \n
      • \n
    • \n

      \n TEMPLATE\n

      \n
      • \n
    " } } }, @@ -1041,6 +1044,18 @@ "com.amazonaws.servicecatalog#CopyProductInput": { "type": "structure", "members": { + "TargetProductName": { + "target": "com.amazonaws.servicecatalog#ProductViewName", + "traits": { + "smithy.api#documentation": "

    A name for the target product. The default is the name of the source product.

    " + } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, "SourceProductArn": { "target": "com.amazonaws.servicecatalog#ProductArn", "traits": { @@ -1048,24 +1063,12 @@ "smithy.api#required": {} } }, - "TargetProductName": { - "target": "com.amazonaws.servicecatalog#ProductViewName", - "traits": { - "smithy.api#documentation": "

    A name for the target product. The default is the name of the source product.

    " - } - }, "SourceProvisioningArtifactIdentifiers": { "target": "com.amazonaws.servicecatalog#SourceProvisioningArtifactProperties", "traits": { "smithy.api#documentation": "

    The identifiers of the provisioning artifacts (also known as versions) of the product to copy. \n By default, all provisioning artifacts are copied.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, "CopyOptions": { "target": "com.amazonaws.servicecatalog#CopyOptions", "traits": { @@ -1147,23 +1150,17 @@ "com.amazonaws.servicecatalog#CreateConstraintInput": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.servicecatalog#ConstraintParameters", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    \n
    \n
    LAUNCH
    \n
    \n

    You are required to specify either the RoleArn or the LocalRoleName but can't use both.

    \n

    Specify the RoleArn property as follows:

    \n

    \n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

    \n

    Specify the LocalRoleName property as follows:

    \n

    \n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

    \n

    If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

    \n \n

    The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

    \n     \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    \n
    \n
    NOTIFICATION
    \n
    \n

    Specify the NotificationArns property as follows:

    \n

    \n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

    \n
    \n
    RESOURCE_UPDATE
    \n
    \n

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    \n

    \n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

    \n

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    \n
    \n
    STACKSET
    \n
    \n

    Specify the Parameters property as follows:

    \n

    \n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

    \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    \n

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    \n
    \n
    TEMPLATE
    \n
    \n

    Specify the Rules property. For more information, see\n Template Constraint Rules.

    \n
    \n
    ", + "smithy.api#documentation": "

    The product identifier.

    ", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ConstraintDescription", - "traits": { - "smithy.api#documentation": "

    The description of the constraint.

    " - } - }, - "Type": { - "target": "com.amazonaws.servicecatalog#ConstraintType", + "PortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The type of constraint.

    \n
      \n
    • \n

      \n LAUNCH\n

      \n
      • \n
    • \n

      \n NOTIFICATION\n

      \n
      • \n
    • \n

      \n RESOURCE_UPDATE\n

      \n
      • \n
    • \n

      \n STACKSET\n

      \n
      • \n
    • \n

      \n TEMPLATE\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The portfolio identifier.

    ", "smithy.api#required": {} } }, @@ -1175,20 +1172,26 @@ "smithy.api#required": {} } }, - "PortfolioId": { - "target": "com.amazonaws.servicecatalog#Id", + "Type": { + "target": "com.amazonaws.servicecatalog#ConstraintType", "traits": { - "smithy.api#documentation": "

    The portfolio identifier.

    ", + "smithy.api#documentation": "

    The type of constraint.

    \n
      \n
    • \n

      \n LAUNCH\n

      \n
      • \n
    • \n

      \n NOTIFICATION\n

      \n
      • \n
    • \n

      \n RESOURCE_UPDATE\n

      \n
      • \n
    • \n

      \n STACKSET\n

      \n
      • \n
    • \n

      \n TEMPLATE\n

      \n
      • \n
    ", "smithy.api#required": {} } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "Parameters": { + "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { - "smithy.api#documentation": "

    The product identifier.

    ", + "smithy.api#documentation": "

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    \n
    \n
    LAUNCH
    \n
    \n

    You are required to specify either the RoleArn or the LocalRoleName but can't use both.

    \n

    Specify the RoleArn property as follows:

    \n

    \n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

    \n

    Specify the LocalRoleName property as follows:

    \n

    \n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

    \n

    If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

    \n \n

    The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

    \n     \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    \n
    \n
    NOTIFICATION
    \n
    \n

    Specify the NotificationArns property as follows:

    \n

    \n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

    \n
    \n
    RESOURCE_UPDATE
    \n
    \n

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    \n

    \n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

    \n

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    \n
    \n
    STACKSET
    \n
    \n

    Specify the Parameters property as follows:

    \n

    \n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

    \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    \n

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    \n
    \n
    TEMPLATE
    \n
    \n

    Specify the Rules property. For more information, see\n Template Constraint Rules.

    \n
    \n
    ", "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.servicecatalog#ConstraintDescription", + "traits": { + "smithy.api#documentation": "

    The description of the constraint.

    " + } + }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -1200,6 +1203,12 @@ "com.amazonaws.servicecatalog#CreateConstraintOutput": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.servicecatalog#Status", + "traits": { + "smithy.api#documentation": "

    The status of the current request.

    " + } + }, "ConstraintParameters": { "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { @@ -1211,12 +1220,6 @@ "traits": { "smithy.api#documentation": "

    Information about the constraint.

    " } - }, - "Status": { - "target": "com.amazonaws.servicecatalog#Status", - "traits": { - "smithy.api#documentation": "

    The status of the current request.

    " - } } } }, @@ -1246,30 +1249,16 @@ "com.amazonaws.servicecatalog#CreatePortfolioInput": { "type": "structure", "members": { - "ProviderName": { - "target": "com.amazonaws.servicecatalog#ProviderName", - "traits": { - "smithy.api#documentation": "

    The name of the portfolio provider.

    ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.servicecatalog#PortfolioDescription", - "traits": { - "smithy.api#documentation": "

    The description of the portfolio.

    " - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, - "DisplayName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "Description": { + "target": "com.amazonaws.servicecatalog#PortfolioDescription", "traits": { - "smithy.api#documentation": "

    The name to use for display purposes.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The description of the portfolio.

    " } }, "IdempotencyToken": { @@ -1280,11 +1269,25 @@ "smithy.api#required": {} } }, + "ProviderName": { + "target": "com.amazonaws.servicecatalog#ProviderName", + "traits": { + "smithy.api#documentation": "

    The name of the portfolio provider.

    ", + "smithy.api#required": {} + } + }, "Tags": { "target": "com.amazonaws.servicecatalog#AddTags", "traits": { "smithy.api#documentation": "

    One or more tags.

    " } + }, + "DisplayName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "traits": { + "smithy.api#documentation": "

    The name to use for display purposes.

    ", + "smithy.api#required": {} + } } } }, @@ -1331,22 +1334,16 @@ } ], "traits": { - "smithy.api#documentation": "

    Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an organization or by a delegated \n administrator. You can share portfolios to an organization, 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. This includes portfolios that contain a shared product.

    " } }, "com.amazonaws.servicecatalog#CreatePortfolioShareInput": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.servicecatalog#AccountId", - "traits": { - "smithy.api#documentation": "

    The AWS account ID. For example, 123456789012.

    " - } - }, "OrganizationNode": { "target": "com.amazonaws.servicecatalog#OrganizationNode", "traits": { - "smithy.api#documentation": "

    The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node and its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process.

    " + "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.

    " } }, "AcceptLanguage": { @@ -1361,6 +1358,12 @@ "smithy.api#documentation": "

    The portfolio identifier.

    ", "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.servicecatalog#AccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID. For example, 123456789012.

    " + } } } }, @@ -1370,7 +1373,7 @@ "PortfolioShareToken": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The portfolio share unique identifier. This will only be returned if portfolio is shared to an organization node.

    " + "smithy.api#documentation": "

    The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

    " } } } @@ -1401,25 +1404,45 @@ "com.amazonaws.servicecatalog#CreateProductInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.

    ", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } }, - "SupportUrl": { - "target": "com.amazonaws.servicecatalog#SupportUrl", + "SupportDescription": { + "target": "com.amazonaws.servicecatalog#SupportDescription", "traits": { - "smithy.api#documentation": "

    The contact URL for product support.

    " + "smithy.api#documentation": "

    The support information about the product.

    " } }, - "ProvisioningArtifactParameters": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactProperties", + "Description": { + "target": "com.amazonaws.servicecatalog#ProductViewShortDescription", "traits": { - "smithy.api#documentation": "

    The configuration of the provisioning artifact.

    ", + "smithy.api#documentation": "

    The description of the product.

    " + } + }, + "Distributor": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "traits": { + "smithy.api#documentation": "

    The distributor of the product.

    " + } + }, + "Owner": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "traits": { + "smithy.api#documentation": "

    The owner of the product.

    ", "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.servicecatalog#AddTags", + "traits": { + "smithy.api#documentation": "

    One or more tags.

    " + } + }, "Name": { "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { @@ -1427,10 +1450,11 @@ "smithy.api#required": {} } }, - "SupportEmail": { - "target": "com.amazonaws.servicecatalog#SupportEmail", + "ProvisioningArtifactParameters": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactProperties", "traits": { - "smithy.api#documentation": "

    The contact email for product support.

    " + "smithy.api#documentation": "

    The configuration of the provisioning artifact.

    ", + "smithy.api#required": {} } }, "ProductType": { @@ -1440,43 +1464,22 @@ "smithy.api#required": {} } }, - "Distributor": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", - "traits": { - "smithy.api#documentation": "

    The distributor of the product.

    " - } - }, - "SupportDescription": { - "target": "com.amazonaws.servicecatalog#SupportDescription", - "traits": { - "smithy.api#documentation": "

    The support information about the product.

    " - } - }, - "Description": { - "target": "com.amazonaws.servicecatalog#ProductViewShortDescription", - "traits": { - "smithy.api#documentation": "

    The description of the product.

    " - } - }, - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.

    ", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#AddTags", + "SupportUrl": { + "target": "com.amazonaws.servicecatalog#SupportUrl", "traits": { - "smithy.api#documentation": "

    One or more tags.

    " + "smithy.api#documentation": "

    The contact URL for product support.

    " } }, - "Owner": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "SupportEmail": { + "target": "com.amazonaws.servicecatalog#SupportEmail", "traits": { - "smithy.api#documentation": "

    The owner of the product.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The contact email for product support.

    " } } } @@ -1484,10 +1487,10 @@ "com.amazonaws.servicecatalog#CreateProductOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "ProvisioningArtifactDetail": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDetail", "traits": { - "smithy.api#documentation": "

    Information about the tags associated with the product.

    " + "smithy.api#documentation": "

    Information about the provisioning artifact.

    " } }, "ProductViewDetail": { @@ -1496,10 +1499,10 @@ "smithy.api#documentation": "

    Information about the product view.

    " } }, - "ProvisioningArtifactDetail": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDetail", + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", "traits": { - "smithy.api#documentation": "

    Information about the provisioning artifact.

    " + "smithy.api#documentation": "

    Information about the tags associated with the product.

    " } } } @@ -1530,77 +1533,77 @@ "com.amazonaws.servicecatalog#CreateProvisionedProductPlanInput": { "type": "structure", "members": { - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "PlanType": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanType", "traits": { - "smithy.api#documentation": "

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.

    ", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "

    The plan type.

    ", "smithy.api#required": {} } }, - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "NotificationArns": { + "target": "com.amazonaws.servicecatalog#NotificationArns", "traits": { - "smithy.api#documentation": "

    A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.

    " } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    One or more tags.

    \n

    If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

    " + "smithy.api#documentation": "

    The product identifier.

    ", + "smithy.api#required": {} } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "PlanName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", "traits": { - "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.

    " + "smithy.api#documentation": "

    The name of the plan.

    ", + "smithy.api#required": {} } }, - "ProvisioningParameters": { - "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

    Parameters specified by the administrator that are required for provisioning the\n product.

    " + "smithy.api#documentation": "

    A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.

    ", + "smithy.api#required": {} } }, - "ProductId": { + "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The product identifier.

    ", + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    ", "smithy.api#required": {} } }, - "PlanName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "

    The name of the plan.

    ", + "smithy.api#documentation": "

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.

    ", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, - "PlanType": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanType", + "PathId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The plan type.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    One or more tags.

    \n

    If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

    " } }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProvisioningParameters": { + "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Parameters specified by the administrator that are required for provisioning the\n product.

    " } }, - "NotificationArns": { - "target": "com.amazonaws.servicecatalog#NotificationArns", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } } } @@ -1608,18 +1611,6 @@ "com.amazonaws.servicecatalog#CreateProvisionedProductPlanOutput": { "type": "structure", "members": { - "PlanName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", - "traits": { - "smithy.api#documentation": "

    The name of the plan.

    " - } - }, - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", - "traits": { - "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " - } - }, "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -1637,6 +1628,18 @@ "traits": { "smithy.api#documentation": "

    The product identifier.

    " } + }, + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "traits": { + "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " + } + }, + "PlanName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", + "traits": { + "smithy.api#documentation": "

    The name of the plan.

    " + } } } }, @@ -1666,6 +1669,19 @@ "com.amazonaws.servicecatalog#CreateProvisioningArtifactInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The product identifier.

    ", + "smithy.api#required": {} + } + }, "IdempotencyToken": { "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { @@ -1680,25 +1696,18 @@ "smithy.api#documentation": "

    The configuration for the provisioning artifact.

    ", "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The product identifier.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.servicecatalog#CreateProvisioningArtifactOutput": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.servicecatalog#Status", + "traits": { + "smithy.api#documentation": "

    The status of the current request.

    " + } + }, "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { @@ -1710,12 +1719,6 @@ "traits": { "smithy.api#documentation": "

    Information about the provisioning artifact.

    " } - }, - "Status": { - "target": "com.amazonaws.servicecatalog#Status", - "traits": { - "smithy.api#documentation": "

    The status of the current request.

    " - } } } }, @@ -1742,10 +1745,11 @@ "com.amazonaws.servicecatalog#CreateServiceActionInput": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#ServiceActionDescription", + "DefinitionType": { + "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionType", "traits": { - "smithy.api#documentation": "

    The self-service action description.

    " + "smithy.api#documentation": "

    The service action definition type. For example, SSM_AUTOMATION.

    ", + "smithy.api#required": {} } }, "Name": { @@ -1763,6 +1767,12 @@ "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.servicecatalog#ServiceActionDescription", + "traits": { + "smithy.api#documentation": "

    The self-service action description.

    " + } + }, "Definition": { "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionMap", "traits": { @@ -1775,13 +1785,6 @@ "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } - }, - "DefinitionType": { - "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionType", - "traits": { - "smithy.api#documentation": "

    The service action definition type. For example, SSM_AUTOMATION.

    ", - "smithy.api#required": {} - } } } }, @@ -1822,17 +1825,17 @@ "com.amazonaws.servicecatalog#CreateTagOptionInput": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.servicecatalog#TagOptionValue", + "Key": { + "target": "com.amazonaws.servicecatalog#TagOptionKey", "traits": { - "smithy.api#documentation": "

    The TagOption value.

    ", + "smithy.api#documentation": "

    The TagOption key.

    ", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.servicecatalog#TagOptionKey", + "Value": { + "target": "com.amazonaws.servicecatalog#TagOptionValue", "traits": { - "smithy.api#documentation": "

    The TagOption key.

    ", + "smithy.api#documentation": "

    The TagOption value.

    ", "smithy.api#required": {} } } @@ -1881,18 +1884,18 @@ "com.amazonaws.servicecatalog#DeleteConstraintInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The identifier of the constraint.

    ", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } } } }, @@ -1971,36 +1974,36 @@ } ], "traits": { - "smithy.api#documentation": "

    Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the master account of an organization or by a\n delegated administrator.

    \n

    Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

    " + "smithy.api#documentation": "

    Stops sharing the specified portfolio with the specified account or organization\n node. Shares to an organization node can only be deleted by the management account of an\n organization or by a delegated administrator.

    \n

    Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

    " } }, "com.amazonaws.servicecatalog#DeletePortfolioShareInput": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.servicecatalog#AccountId", - "traits": { - "smithy.api#documentation": "

    The AWS account ID.

    " - } - }, "OrganizationNode": { "target": "com.amazonaws.servicecatalog#OrganizationNode", "traits": { "smithy.api#documentation": "

    The organization node to whom you are going to stop sharing.

    " } }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "AccountId": { + "target": "com.amazonaws.servicecatalog#AccountId", + "traits": { + "smithy.api#documentation": "

    The AWS account ID.

    " + } + }, "PortfolioId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The portfolio identifier.

    ", "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } } } }, @@ -2044,18 +2047,18 @@ "com.amazonaws.servicecatalog#DeleteProductInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The product identifier.

    ", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } } } }, @@ -2086,18 +2089,18 @@ "com.amazonaws.servicecatalog#DeleteProvisionedProductPlanInput": { "type": "structure", "members": { - "IgnoreErrors": { - "target": "com.amazonaws.servicecatalog#IgnoreErrors", - "traits": { - "smithy.api#documentation": "

    If set to true, AWS Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.

    " - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, + "IgnoreErrors": { + "target": "com.amazonaws.servicecatalog#IgnoreErrors", + "traits": { + "smithy.api#documentation": "

    If set to true, AWS Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.

    " + } + }, "PlanId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -2137,6 +2140,13 @@ "com.amazonaws.servicecatalog#DeleteProvisioningArtifactInput": { "type": "structure", "members": { + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    ", + "smithy.api#required": {} + } + }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -2149,13 +2159,6 @@ "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } - }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    ", - "smithy.api#required": {} - } } } }, @@ -2283,10 +2286,10 @@ "com.amazonaws.servicecatalog#DescribeConstraintOutput": { "type": "structure", "members": { - "ConstraintParameters": { - "target": "com.amazonaws.servicecatalog#ConstraintParameters", + "ConstraintDetail": { + "target": "com.amazonaws.servicecatalog#ConstraintDetail", "traits": { - "smithy.api#documentation": "

    The constraint parameters.

    " + "smithy.api#documentation": "

    Information about the constraint.

    " } }, "Status": { @@ -2295,10 +2298,10 @@ "smithy.api#documentation": "

    The status of the current request.

    " } }, - "ConstraintDetail": { - "target": "com.amazonaws.servicecatalog#ConstraintDetail", + "ConstraintParameters": { + "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { - "smithy.api#documentation": "

    Information about the constraint.

    " + "smithy.api#documentation": "

    The constraint parameters.

    " } } } @@ -2341,18 +2344,18 @@ "com.amazonaws.servicecatalog#DescribeCopyProductStatusOutput": { "type": "structure", "members": { - "TargetProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the copied product.

    " - } - }, "CopyProductStatus": { "target": "com.amazonaws.servicecatalog#CopyProductStatus", "traits": { "smithy.api#documentation": "

    The status of the copy product operation.

    " } }, + "TargetProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the copied product.

    " + } + }, "StatusDetail": { "target": "com.amazonaws.servicecatalog#StatusDetail", "traits": { @@ -2381,46 +2384,46 @@ "com.amazonaws.servicecatalog#DescribePortfolioInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The portfolio identifier.

    ", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } } } }, "com.amazonaws.servicecatalog#DescribePortfolioOutput": { "type": "structure", "members": { - "Budgets": { - "target": "com.amazonaws.servicecatalog#Budgets", - "traits": { - "smithy.api#documentation": "

    Information about the associated budgets.

    " - } - }, "TagOptions": { "target": "com.amazonaws.servicecatalog#TagOptionDetails", "traits": { "smithy.api#documentation": "

    Information about the TagOptions associated with the portfolio.

    " } }, + "PortfolioDetail": { + "target": "com.amazonaws.servicecatalog#PortfolioDetail", + "traits": { + "smithy.api#documentation": "

    Information about the portfolio.

    " + } + }, "Tags": { "target": "com.amazonaws.servicecatalog#Tags", "traits": { "smithy.api#documentation": "

    Information about the tags associated with the portfolio.

    " } }, - "PortfolioDetail": { - "target": "com.amazonaws.servicecatalog#PortfolioDetail", + "Budgets": { + "target": "com.amazonaws.servicecatalog#Budgets", "traits": { - "smithy.api#documentation": "

    Information about the portfolio.

    " + "smithy.api#documentation": "

    Information about the associated budgets.

    " } } } @@ -2445,7 +2448,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets the status of the specified portfolio share operation. This API can only be called by the master account in the organization or by a delegated admin.

    " + "smithy.api#documentation": "

    Gets the status of the specified portfolio share operation. This API can only be called\n by the management account in the organization or by a delegated admin.

    " } }, "com.amazonaws.servicecatalog#DescribePortfolioShareStatusInput": { @@ -2463,6 +2466,18 @@ "com.amazonaws.servicecatalog#DescribePortfolioShareStatusOutput": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.servicecatalog#ShareStatus", + "traits": { + "smithy.api#documentation": "

    Status of the portfolio share operation.

    " + } + }, + "PortfolioShareToken": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The token for the portfolio share operation. For example, share-6v24abcdefghi.

    " + } + }, "OrganizationNodeValue": { "target": "com.amazonaws.servicecatalog#OrganizationNodeValue", "traits": { @@ -2480,18 +2495,6 @@ "traits": { "smithy.api#documentation": "

    Information about the portfolio share operation.

    " } - }, - "PortfolioShareToken": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The token for the portfolio share operation. For example, share-6v24abcdefghi.

    " - } - }, - "Status": { - "target": "com.amazonaws.servicecatalog#ShareStatus", - "traits": { - "smithy.api#documentation": "

    Status of the portfolio share operation.

    " - } } } }, @@ -2538,10 +2541,10 @@ "com.amazonaws.servicecatalog#DescribeProductAsAdminInput": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The product identifier.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "Name": { @@ -2550,10 +2553,10 @@ "smithy.api#documentation": "

    The product name.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Id": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The product identifier.

    " } } } @@ -2561,6 +2564,12 @@ "com.amazonaws.servicecatalog#DescribeProductAsAdminOutput": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", + "traits": { + "smithy.api#documentation": "

    Information about the tags associated with the product.

    " + } + }, "Budgets": { "target": "com.amazonaws.servicecatalog#Budgets", "traits": { @@ -2573,10 +2582,10 @@ "smithy.api#documentation": "

    Information about the provisioning artifacts (also known as versions) for the specified product.

    " } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "ProductViewDetail": { + "target": "com.amazonaws.servicecatalog#ProductViewDetail", "traits": { - "smithy.api#documentation": "

    Information about the tags associated with the product.

    " + "smithy.api#documentation": "

    Information about the product view.

    " } }, "TagOptions": { @@ -2584,18 +2593,18 @@ "traits": { "smithy.api#documentation": "

    Information about the TagOptions associated with the product.

    " } - }, - "ProductViewDetail": { - "target": "com.amazonaws.servicecatalog#ProductViewDetail", - "traits": { - "smithy.api#documentation": "

    Information about the product view.

    " - } } } }, "com.amazonaws.servicecatalog#DescribeProductInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, "Name": { "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { @@ -2607,22 +2616,16 @@ "traits": { "smithy.api#documentation": "

    The product identifier.

    " } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } } } }, "com.amazonaws.servicecatalog#DescribeProductOutput": { "type": "structure", "members": { - "ProductViewSummary": { - "target": "com.amazonaws.servicecatalog#ProductViewSummary", + "LaunchPaths": { + "target": "com.amazonaws.servicecatalog#LaunchPaths", "traits": { - "smithy.api#documentation": "

    Summary information about the product view.

    " + "smithy.api#documentation": "

    Information about the associated launch paths.

    " } }, "ProvisioningArtifacts": { @@ -2631,10 +2634,10 @@ "smithy.api#documentation": "

    Information about the provisioning artifacts for the specified product.

    " } }, - "LaunchPaths": { - "target": "com.amazonaws.servicecatalog#LaunchPaths", + "ProductViewSummary": { + "target": "com.amazonaws.servicecatalog#ProductViewSummary", "traits": { - "smithy.api#documentation": "

    Information about the associated launch paths.

    " + "smithy.api#documentation": "

    Summary information about the product view.

    " } }, "Budgets": { @@ -2686,17 +2689,17 @@ "com.amazonaws.servicecatalog#DescribeProductViewOutput": { "type": "structure", "members": { - "ProvisioningArtifacts": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifacts", - "traits": { - "smithy.api#documentation": "

    Information about the provisioning artifacts for the product.

    " - } - }, "ProductViewSummary": { "target": "com.amazonaws.servicecatalog#ProductViewSummary", "traits": { "smithy.api#documentation": "

    Summary information about the product.

    " } + }, + "ProvisioningArtifacts": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifacts", + "traits": { + "smithy.api#documentation": "

    Information about the provisioning artifacts for the product.

    " + } } } }, @@ -2709,6 +2712,9 @@ "target": "com.amazonaws.servicecatalog#DescribeProvisionedProductOutput" }, "errors": [ + { + "target": "com.amazonaws.servicecatalog#InvalidParametersException" + }, { "target": "com.amazonaws.servicecatalog#ResourceNotFoundException" } @@ -2720,11 +2726,10 @@ "com.amazonaws.servicecatalog#DescribeProvisionedProductInput": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

    The provisioned product identifier.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the provisioned product.

    " } }, "AcceptLanguage": { @@ -2732,23 +2737,32 @@ "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } + }, + "Id": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The provisioned product identifier.

    " + } } + }, + "traits": { + "smithy.api#documentation": "DescribeProvisionedProductAPI input structure.\n\n AcceptLanguage - [Optional]\n The language code for localization.\n\n Id - [Optional]\n The provisioned product identifier.\n\n Name - [Optional]\n Another provisioned product identifier. Customers must provide either Id or Name." } }, "com.amazonaws.servicecatalog#DescribeProvisionedProductOutput": { "type": "structure", "members": { - "CloudWatchDashboards": { - "target": "com.amazonaws.servicecatalog#CloudWatchDashboards", - "traits": { - "smithy.api#documentation": "

    Any CloudWatch dashboards that were created when provisioning the product.

    " - } - }, "ProvisionedProductDetail": { "target": "com.amazonaws.servicecatalog#ProvisionedProductDetail", "traits": { "smithy.api#documentation": "

    Information about the provisioned product.

    " } + }, + "CloudWatchDashboards": { + "target": "com.amazonaws.servicecatalog#CloudWatchDashboards", + "traits": { + "smithy.api#documentation": "

    Any CloudWatch dashboards that were created when provisioning the product.

    " + } } } }, @@ -2775,16 +2789,11 @@ "com.amazonaws.servicecatalog#DescribeProvisionedProductPlanInput": { "type": "structure", "members": { - "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.

    " - } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PlanId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The plan identifier.

    ", + "smithy.api#required": {} } }, "PageSize": { @@ -2793,11 +2802,16 @@ "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, - "PlanId": { - "target": "com.amazonaws.servicecatalog#Id", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The plan identifier.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "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.

    " } } } @@ -2805,12 +2819,6 @@ "com.amazonaws.servicecatalog#DescribeProvisionedProductPlanOutput": { "type": "structure", "members": { - "ResourceChanges": { - "target": "com.amazonaws.servicecatalog#ResourceChanges", - "traits": { - "smithy.api#documentation": "

    Information about the resource changes that will occur when the plan is executed.

    " - } - }, "ProvisionedProductPlanDetails": { "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanDetails", "traits": { @@ -2822,6 +2830,12 @@ "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.

    " } + }, + "ResourceChanges": { + "target": "com.amazonaws.servicecatalog#ResourceChanges", + "traits": { + "smithy.api#documentation": "

    Information about the resource changes that will occur when the plan is executed.

    " + } } } }, @@ -2848,10 +2862,10 @@ "com.amazonaws.servicecatalog#DescribeProvisioningArtifactInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Verbose": { + "target": "com.amazonaws.servicecatalog#Verbose", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    Indicates whether a verbose level of detail is enabled.

    " } }, "ProvisioningArtifactId": { @@ -2866,16 +2880,10 @@ "smithy.api#documentation": "

    The product identifier.

    " } }, - "ProductName": { - "target": "com.amazonaws.servicecatalog#ProductViewName", - "traits": { - "smithy.api#documentation": "

    The product name.

    " - } - }, - "Verbose": { - "target": "com.amazonaws.servicecatalog#Verbose", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    Indicates whether a verbose level of detail is enabled.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "ProvisioningArtifactName": { @@ -2883,24 +2891,30 @@ "traits": { "smithy.api#documentation": "

    The provisioning artifact name.

    " } + }, + "ProductName": { + "target": "com.amazonaws.servicecatalog#ProductViewName", + "traits": { + "smithy.api#documentation": "

    The product name.

    " + } } } }, "com.amazonaws.servicecatalog#DescribeProvisioningArtifactOutput": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.servicecatalog#Status", - "traits": { - "smithy.api#documentation": "

    The status of the current request.

    " - } - }, "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { "smithy.api#documentation": "

    The URL of the CloudFormation template in Amazon S3.

    " } }, + "Status": { + "target": "com.amazonaws.servicecatalog#Status", + "traits": { + "smithy.api#documentation": "

    The status of the current request.

    " + } + }, "ProvisioningArtifactDetail": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDetail", "traits": { @@ -2932,16 +2946,16 @@ "com.amazonaws.servicecatalog#DescribeProvisioningParametersInput": { "type": "structure", "members": { - "ProvisioningArtifactId": { + "PathId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    " } }, "PathName": { @@ -2950,10 +2964,10 @@ "smithy.api#documentation": "

    The name of the path. You must provide the name or ID, but not both.

    " } }, - "ProvisioningArtifactName": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "ProductId": { @@ -2962,16 +2976,16 @@ "smithy.api#documentation": "

    The product identifier. You must provide the product name or ID, but not both.

    " } }, - "ProductName": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "ProvisioningArtifactName": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "

    The name of the product. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    " } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProductName": { + "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { - "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The name of the product. You must provide the name or ID, but not both.

    " } } } @@ -2979,10 +2993,10 @@ "com.amazonaws.servicecatalog#DescribeProvisioningParametersOutput": { "type": "structure", "members": { - "ConstraintSummaries": { - "target": "com.amazonaws.servicecatalog#ConstraintSummaries", + "TagOptions": { + "target": "com.amazonaws.servicecatalog#TagOptionSummaries", "traits": { - "smithy.api#documentation": "

    Information about the constraints used to provision the product.

    " + "smithy.api#documentation": "

    Information about the TagOptions associated with the resource.

    " } }, "ProvisioningArtifactParameters": { @@ -2997,10 +3011,10 @@ "smithy.api#documentation": "

    An object that contains information about preferences, such as regions and accounts, for the provisioning artifact.

    " } }, - "TagOptions": { - "target": "com.amazonaws.servicecatalog#TagOptionSummaries", + "UsageInstructions": { + "target": "com.amazonaws.servicecatalog#UsageInstructions", "traits": { - "smithy.api#documentation": "

    Information about the TagOptions associated with the resource.

    " + "smithy.api#documentation": "

    Any additional metadata specifically related to the provisioning of the product. For\n example, see the Version field of the CloudFormation template.

    " } }, "ProvisioningArtifactOutputs": { @@ -3009,10 +3023,10 @@ "smithy.api#documentation": "

    The output of the provisioning artifact.

    " } }, - "UsageInstructions": { - "target": "com.amazonaws.servicecatalog#UsageInstructions", + "ConstraintSummaries": { + "target": "com.amazonaws.servicecatalog#ConstraintSummaries", "traits": { - "smithy.api#documentation": "

    Any additional metadata specifically related to the provisioning of the product. For\n example, see the Version field of the CloudFormation template.

    " + "smithy.api#documentation": "

    Information about the constraints used to provision the product.

    " } } } @@ -3037,10 +3051,10 @@ "com.amazonaws.servicecatalog#DescribeRecordInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, "PageToken": { @@ -3049,36 +3063,36 @@ "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#PageSize", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The record identifier of the provisioned product. This identifier is returned by the\n request operation.

    ", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } } } }, "com.amazonaws.servicecatalog#DescribeRecordOutput": { "type": "structure", "members": { - "RecordDetail": { - "target": "com.amazonaws.servicecatalog#RecordDetail", - "traits": { - "smithy.api#documentation": "

    Information about the product.

    " - } - }, "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.

    " } }, + "RecordDetail": { + "target": "com.amazonaws.servicecatalog#RecordDetail", + "traits": { + "smithy.api#documentation": "

    Information about the product.

    " + } + }, "RecordOutputs": { "target": "com.amazonaws.servicecatalog#RecordOutputs", "traits": { @@ -3127,6 +3141,13 @@ "com.amazonaws.servicecatalog#DescribeServiceActionExecutionParametersInput": { "type": "structure", "members": { + "ProvisionedProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the provisioned product.

    ", + "smithy.api#required": {} + } + }, "ServiceActionId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -3139,13 +3160,6 @@ "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } - }, - "ProvisionedProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the provisioned product.

    ", - "smithy.api#required": {} - } } } }, @@ -3256,7 +3270,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. \n Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the master account in the organization.

    \n

    This API can't be invoked if there are active delegated administrators in the organization.

    \n

    Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

    " + "smithy.api#documentation": "

    Disable portfolio sharing through AWS Organizations feature. This feature will not\n delete your current shares but it will prevent you from creating new shares throughout your\n organization. Current shares will not be in sync with your organization structure if it\n changes after calling this API. This API can only be called by the management account in\n the organization.

    \n

    This API can't be invoked if there are active delegated administrators in the organization.

    \n

    Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

    " } }, "com.amazonaws.servicecatalog#DisableAWSOrganizationsAccessInput": { @@ -3333,6 +3347,13 @@ "com.amazonaws.servicecatalog#DisassociatePrincipalFromPortfolioInput": { "type": "structure", "members": { + "PrincipalARN": { + "target": "com.amazonaws.servicecatalog#PrincipalARN", + "traits": { + "smithy.api#documentation": "

    The ARN of the principal (IAM user, role, or group).

    ", + "smithy.api#required": {} + } + }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -3345,13 +3366,6 @@ "smithy.api#documentation": "

    The portfolio identifier.

    ", "smithy.api#required": {} } - }, - "PrincipalARN": { - "target": "com.amazonaws.servicecatalog#PrincipalARN", - "traits": { - "smithy.api#documentation": "

    The ARN of the principal (IAM user, role, or group).

    ", - "smithy.api#required": {} - } } } }, @@ -3385,13 +3399,6 @@ "com.amazonaws.servicecatalog#DisassociateProductFromPortfolioInput": { "type": "structure", "members": { - "PortfolioId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The portfolio identifier.

    ", - "smithy.api#required": {} - } - }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -3404,6 +3411,13 @@ "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } + }, + "PortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The portfolio identifier.

    ", + "smithy.api#required": {} + } } } }, @@ -3431,17 +3445,17 @@ "com.amazonaws.servicecatalog#DisassociateServiceActionFromProvisioningArtifactInput": { "type": "structure", "members": { - "ProductId": { + "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    ", + "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    ", "smithy.api#required": {} } }, - "ProvisioningArtifactId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    ", + "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    ", "smithy.api#required": {} } }, @@ -3541,7 +3555,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Enable portfolio sharing feature through AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the master account in the organization.

    \n

    By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

    \n

    Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

    " + "smithy.api#documentation": "

    Enable portfolio sharing feature through AWS Organizations. This API will allow Service\n Catalog to receive updates on your organization in order to sync your shares with the\n current structure. This API can only be called by the management account in the\n organization.

    \n

    By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

    \n

    Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

    " } }, "com.amazonaws.servicecatalog#EnableAWSOrganizationsAccessInput": { @@ -3611,13 +3625,6 @@ "com.amazonaws.servicecatalog#ExecuteProvisionedProductPlanInput": { "type": "structure", "members": { - "PlanId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The plan identifier.

    ", - "smithy.api#required": {} - } - }, "IdempotencyToken": { "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { @@ -3626,6 +3633,13 @@ "smithy.api#required": {} } }, + "PlanId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The plan identifier.

    ", + "smithy.api#required": {} + } + }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -3677,10 +3691,10 @@ "smithy.api#documentation": "

    A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will \n override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for \n any special parameters such as TARGET.

    " } }, - "ServiceActionId": { + "ProvisionedProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    ", + "smithy.api#documentation": "

    The identifier of the provisioned product.

    ", "smithy.api#required": {} } }, @@ -3692,10 +3706,10 @@ "smithy.api#required": {} } }, - "ProvisionedProductId": { + "ServiceActionId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioned product.

    ", + "smithy.api#documentation": "

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    ", "smithy.api#required": {} } }, @@ -3721,12 +3735,6 @@ "com.amazonaws.servicecatalog#ExecutionParameter": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.servicecatalog#ExecutionParameterKey", - "traits": { - "smithy.api#documentation": "

    The name of the execution parameter.

    " - } - }, "Type": { "target": "com.amazonaws.servicecatalog#ExecutionParameterType", "traits": { @@ -3738,6 +3746,12 @@ "traits": { "smithy.api#documentation": "

    The default values for the execution parameter.

    " } + }, + "Name": { + "target": "com.amazonaws.servicecatalog#ExecutionParameterKey", + "traits": { + "smithy.api#documentation": "

    The name of the execution parameter.

    " + } } }, "traits": { @@ -3807,6 +3821,12 @@ "com.amazonaws.servicecatalog#FailedServiceActionAssociation": { "type": "structure", "members": { + "ErrorMessage": { + "target": "com.amazonaws.servicecatalog#ServiceActionAssociationErrorMessage", + "traits": { + "smithy.api#documentation": "

    A text description of the error.

    " + } + }, "ServiceActionId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -3819,10 +3839,10 @@ "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    " } }, - "ErrorMessage": { - "target": "com.amazonaws.servicecatalog#ServiceActionAssociationErrorMessage", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    A text description of the error.

    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " } }, "ErrorCode": { @@ -3830,12 +3850,6 @@ "traits": { "smithy.api#documentation": "

    The error code. Valid values are listed below.

    " } - }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " - } } }, "traits": { @@ -3871,7 +3885,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the master account in the organization or by a delegated admin.

    " + "smithy.api#documentation": "

    Get the Access Status for AWS Organization portfolio share feature. This API can only be\n called by the management account in the organization or by a delegated admin.

    " } }, "com.amazonaws.servicecatalog#GetAWSOrganizationsAccessStatusInput": { @@ -3889,39 +3903,122 @@ } } }, - "com.amazonaws.servicecatalog#HasDefaultPath": { - "type": "boolean" - }, - "com.amazonaws.servicecatalog#Id": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 + "com.amazonaws.servicecatalog#GetProvisionedProductOutputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicecatalog#GetProvisionedProductOutputsInput" + }, + "output": { + "target": "com.amazonaws.servicecatalog#GetProvisionedProductOutputsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.servicecatalog#InvalidParametersException" }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-]*" - } - }, - "com.amazonaws.servicecatalog#IdempotencyToken": { - "type": "string", + { + "target": "com.amazonaws.servicecatalog#ResourceNotFoundException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + "smithy.api#documentation": "

    This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

    ", + "smithy.api#paginated": { + "inputToken": "PageToken", + "outputToken": "NextPageToken", + "pageSize": "PageSize" + } } }, - "com.amazonaws.servicecatalog#IgnoreErrors": { - "type": "boolean" - }, - "com.amazonaws.servicecatalog#InstructionType": { - "type": "string" - }, - "com.amazonaws.servicecatalog#InstructionValue": { - "type": "string" - }, - "com.amazonaws.servicecatalog#InvalidParametersException": { + "com.amazonaws.servicecatalog#GetProvisionedProductOutputsInput": { + "type": "structure", + "members": { + "OutputKeys": { + "target": "com.amazonaws.servicecatalog#OutputKeys", + "traits": { + "smithy.api#documentation": "

    The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.

    " + } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "ProvisionedProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the provisioned product that you want the outputs from.

    " + } + }, + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + } + }, + "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.

    " + } + }, + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "traits": { + "smithy.api#documentation": "

    The name of the provisioned product that you want the outputs from.

    " + } + } + } + }, + "com.amazonaws.servicecatalog#GetProvisionedProductOutputsOutput": { + "type": "structure", + "members": { + "Outputs": { + "target": "com.amazonaws.servicecatalog#RecordOutputs", + "traits": { + "smithy.api#documentation": "

    Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.\n

    " + } + }, + "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.

    " + } + } + } + }, + "com.amazonaws.servicecatalog#HasDefaultPath": { + "type": "boolean" + }, + "com.amazonaws.servicecatalog#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]*" + } + }, + "com.amazonaws.servicecatalog#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + } + }, + "com.amazonaws.servicecatalog#IgnoreErrors": { + "type": "boolean" + }, + "com.amazonaws.servicecatalog#InstructionType": { + "type": "string" + }, + "com.amazonaws.servicecatalog#InstructionValue": { + "type": "string" + }, + "com.amazonaws.servicecatalog#InvalidParametersException": { "type": "structure", "members": { "Message": { @@ -4052,22 +4149,16 @@ "com.amazonaws.servicecatalog#ListAcceptedPortfolioSharesInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, "PageSize": { "target": "com.amazonaws.servicecatalog#PageSize", "traits": { "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, - "PortfolioShareType": { - "target": "com.amazonaws.servicecatalog#PortfolioShareType", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The type of shared portfolios to list. The default is to list imported portfolios.

    \n
      \n
    • \n

      \n AWS_ORGANIZATIONS - List portfolios shared by the master account of your organization

      \n
      • \n
    • \n

      \n AWS_SERVICECATALOG - List default portfolios

      \n
      • \n
    • \n

      \n IMPORTED - List imported portfolios

      \n
      • \n
    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "PageToken": { @@ -4075,6 +4166,12 @@ "traits": { "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " } + }, + "PortfolioShareType": { + "target": "com.amazonaws.servicecatalog#PortfolioShareType", + "traits": { + "smithy.api#documentation": "

    The type of shared portfolios to list. The default is to list imported portfolios.

    \n
      \n
    • \n

      \n AWS_ORGANIZATIONS - List portfolios shared by the management\n account of your organization

      \n
      • \n
    • \n

      \n AWS_SERVICECATALOG - List default portfolios

      \n
      • \n
    • \n

      \n IMPORTED - List imported portfolios

      \n
      • \n
    " + } } } }, @@ -4123,16 +4220,11 @@ "com.amazonaws.servicecatalog#ListBudgetsForResourceInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "ResourceId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + "smithy.api#documentation": "

    The resource identifier.

    ", + "smithy.api#required": {} } }, "PageSize": { @@ -4141,11 +4233,16 @@ "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, - "ResourceId": { - "target": "com.amazonaws.servicecatalog#Id", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "

    The resource identifier.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } } } @@ -4153,17 +4250,17 @@ "com.amazonaws.servicecatalog#ListBudgetsForResourceOutput": { "type": "structure", "members": { - "Budgets": { - "target": "com.amazonaws.servicecatalog#Budgets", - "traits": { - "smithy.api#documentation": "

    Information about the associated budgets.

    " - } - }, "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.

    " } + }, + "Budgets": { + "target": "com.amazonaws.servicecatalog#Budgets", + "traits": { + "smithy.api#documentation": "

    Information about the associated budgets.

    " + } } } }, @@ -4195,10 +4292,10 @@ "com.amazonaws.servicecatalog#ListConstraintsForPortfolioInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " } }, "PortfolioId": { @@ -4208,6 +4305,12 @@ "smithy.api#required": {} } }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -4219,29 +4322,23 @@ "traits": { "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } - }, - "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.

    " - } } } }, "com.amazonaws.servicecatalog#ListConstraintsForPortfolioOutput": { "type": "structure", "members": { - "ConstraintDetails": { - "target": "com.amazonaws.servicecatalog#ConstraintDetails", - "traits": { - "smithy.api#documentation": "

    Information about the constraints.

    " - } - }, "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.

    " } + }, + "ConstraintDetails": { + "target": "com.amazonaws.servicecatalog#ConstraintDetails", + "traits": { + "smithy.api#documentation": "

    Information about the constraints.

    " + } } } }, @@ -4280,10 +4377,10 @@ "smithy.api#required": {} } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, "PageToken": { @@ -4292,10 +4389,10 @@ "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#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } } } @@ -4337,7 +4434,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the organization nodes that have access to the specified portfolio. This API can only be called by the master account in the organization or by a delegated admin.

    \n

    If a delegated admin is de-registered, they can no longer perform this operation.

    ", + "smithy.api#documentation": "

    Lists the organization nodes that have access to the specified portfolio. This API can\n only be called by the management account in the organization or by a delegated\n admin.

    \n

    If a delegated admin is de-registered, they can no longer perform this operation.

    ", "smithy.api#paginated": { "inputToken": "PageToken", "outputToken": "NextPageToken", @@ -4348,6 +4445,12 @@ "com.amazonaws.servicecatalog#ListOrganizationPortfolioAccessInput": { "type": "structure", "members": { + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + } + }, "OrganizationNodeType": { "target": "com.amazonaws.servicecatalog#OrganizationNodeType", "traits": { @@ -4368,12 +4471,6 @@ "smithy.api#required": {} } }, - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -4385,17 +4482,17 @@ "com.amazonaws.servicecatalog#ListOrganizationPortfolioAccessOutput": { "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.

    " - } - }, "OrganizationNodes": { "target": "com.amazonaws.servicecatalog#OrganizationNodes", "traits": { "smithy.api#documentation": "

    Displays information about the organization nodes.

    " } + }, + "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.

    " + } } } }, @@ -4427,17 +4524,10 @@ "com.amazonaws.servicecatalog#ListPortfolioAccessInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " - } - }, - "PortfolioId": { - "target": "com.amazonaws.servicecatalog#Id", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "

    The portfolio identifier.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " } }, "AcceptLanguage": { @@ -4452,10 +4542,17 @@ "smithy.api#documentation": "

    The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

    " } }, - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "PortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + "smithy.api#documentation": "

    The portfolio identifier.

    ", + "smithy.api#required": {} + } + }, + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } } } @@ -4463,17 +4560,17 @@ "com.amazonaws.servicecatalog#ListPortfolioAccessOutput": { "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.

    " - } - }, "AccountIds": { "target": "com.amazonaws.servicecatalog#AccountIds", "traits": { "smithy.api#documentation": "

    Information about the AWS accounts with access to the portfolio.

    " } + }, + "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.

    " + } } } }, @@ -4533,6 +4630,12 @@ "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, + "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.

    " + } + }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -4545,28 +4648,22 @@ "traits": { "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } - }, - "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.

    " - } } } }, "com.amazonaws.servicecatalog#ListPortfoliosForProductOutput": { "type": "structure", "members": { - "PortfolioDetails": { - "target": "com.amazonaws.servicecatalog#PortfolioDetails", + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "

    Information about the portfolios.

    " + "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.

    " } }, - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "PortfolioDetails": { + "target": "com.amazonaws.servicecatalog#PortfolioDetails", "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.

    " + "smithy.api#documentation": "

    Information about the portfolios.

    " } } } @@ -4574,10 +4671,10 @@ "com.amazonaws.servicecatalog#ListPortfoliosInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "PageToken": { @@ -4586,10 +4683,10 @@ "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } } } @@ -4597,17 +4694,17 @@ "com.amazonaws.servicecatalog#ListPortfoliosOutput": { "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.

    " - } - }, "PortfolioDetails": { "target": "com.amazonaws.servicecatalog#PortfolioDetails", "traits": { "smithy.api#documentation": "

    Information about the portfolios.

    " } + }, + "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.

    " + } } } }, @@ -4639,12 +4736,6 @@ "com.amazonaws.servicecatalog#ListPrincipalsForPortfolioInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -4657,6 +4748,12 @@ "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#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + } + }, "PortfolioId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -4706,22 +4803,28 @@ "com.amazonaws.servicecatalog#ListProvisionedProductPlansInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, "AccessLevelFilter": { "target": "com.amazonaws.servicecatalog#AccessLevelFilter", "traits": { "smithy.api#documentation": "

    The access level to use to obtain results. The default is User.

    " } }, - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "ProvisionProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + "smithy.api#documentation": "

    The product identifier.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, "PageToken": { @@ -4729,29 +4832,23 @@ "traits": { "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " } - }, - "ProvisionProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The product identifier.

    " - } } } }, "com.amazonaws.servicecatalog#ListProvisionedProductPlansOutput": { "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.

    " - } - }, "ProvisionedProductPlans": { "target": "com.amazonaws.servicecatalog#ProvisionedProductPlans", "traits": { "smithy.api#documentation": "

    Information about the plans.

    " } + }, + "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.

    " + } } } }, @@ -4803,6 +4900,18 @@ "com.amazonaws.servicecatalog#ListProvisioningArtifactsForServiceActionInput": { "type": "structure", "members": { + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + } + }, + "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.

    " + } + }, "ServiceActionId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -4815,18 +4924,6 @@ "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } - }, - "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#PageSize", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " - } } } }, @@ -4902,16 +4999,16 @@ "com.amazonaws.servicecatalog#ListRecordHistoryInput": { "type": "structure", "members": { - "AccessLevelFilter": { - "target": "com.amazonaws.servicecatalog#AccessLevelFilter", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "

    The access level to use to obtain results. The default is User.

    " + "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#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "SearchFilter": { @@ -4920,16 +5017,16 @@ "smithy.api#documentation": "

    The search filter to scope the results.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "AccessLevelFilter": { + "target": "com.amazonaws.servicecatalog#AccessLevelFilter", "traits": { - "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + "smithy.api#documentation": "

    The access level to use to obtain results. The default is User.

    " } } } @@ -4937,17 +5034,17 @@ "com.amazonaws.servicecatalog#ListRecordHistoryOutput": { "type": "structure", "members": { - "RecordDetails": { - "target": "com.amazonaws.servicecatalog#RecordDetails", - "traits": { - "smithy.api#documentation": "

    The records, in reverse chronological order.

    " - } - }, "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.

    " } + }, + "RecordDetails": { + "target": "com.amazonaws.servicecatalog#RecordDetails", + "traits": { + "smithy.api#documentation": "

    The records, in reverse chronological order.

    " + } } } }, @@ -5002,6 +5099,20 @@ "com.amazonaws.servicecatalog#ListResourcesForTagOptionInput": { "type": "structure", "members": { + "ResourceType": { + "target": "com.amazonaws.servicecatalog#ResourceType", + "traits": { + "smithy.api#documentation": "

    The resource type.

    \n
      \n
    • \n

      \n Portfolio\n

      \n
      • \n
    • \n

      \n Product\n

      \n
      • \n
    ", + "smithy.api#httpQuery": "resourceType" + } + }, + "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.

    ", + "smithy.api#httpQuery": "pageToken" + } + }, "TagOptionId": { "target": "com.amazonaws.servicecatalog#TagOptionId", "traits": { @@ -5016,20 +5127,6 @@ "smithy.api#documentation": "

    The maximum number of items to return with this call.

    ", "smithy.api#httpQuery": "pageSize" } - }, - "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.

    ", - "smithy.api#httpQuery": "pageToken" - } - }, - "ResourceType": { - "target": "com.amazonaws.servicecatalog#ResourceType", - "traits": { - "smithy.api#documentation": "

    The resource type.

    \n
      \n
    • \n

      \n Portfolio\n

      \n
      • \n
    • \n

      \n Product\n

      \n
      • \n
    ", - "smithy.api#httpQuery": "resourceType" - } } } }, @@ -5137,27 +5234,27 @@ "com.amazonaws.servicecatalog#ListServiceActionsForProvisioningArtifactOutput": { "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.

    " - } - }, "ServiceActionSummaries": { "target": "com.amazonaws.servicecatalog#ServiceActionSummaries", "traits": { "smithy.api#documentation": "

    An object containing information about the self-service actions associated with the provisioning artifact.

    " } + }, + "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.

    " + } } } }, "com.amazonaws.servicecatalog#ListServiceActionsInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, "PageToken": { @@ -5166,10 +5263,10 @@ "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } } } @@ -5177,17 +5274,17 @@ "com.amazonaws.servicecatalog#ListServiceActionsOutput": { "type": "structure", "members": { - "ServiceActionSummaries": { - "target": "com.amazonaws.servicecatalog#ServiceActionSummaries", - "traits": { - "smithy.api#documentation": "

    An object containing information about the service actions associated with the provisioning artifact.

    " - } - }, "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.

    " } + }, + "ServiceActionSummaries": { + "target": "com.amazonaws.servicecatalog#ServiceActionSummaries", + "traits": { + "smithy.api#documentation": "

    An object containing information about the service actions associated with the provisioning artifact.

    " + } } } }, @@ -5214,6 +5311,18 @@ "com.amazonaws.servicecatalog#ListStackInstancesForProvisionedProductInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "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.

    " + } + }, "ProvisionedProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -5226,35 +5335,23 @@ "traits": { "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } - }, - "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.

    " - } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } } } }, "com.amazonaws.servicecatalog#ListStackInstancesForProvisionedProductOutput": { "type": "structure", "members": { - "StackInstances": { - "target": "com.amazonaws.servicecatalog#StackInstances", - "traits": { - "smithy.api#documentation": "

    List of stack instances.

    " - } - }, "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.

    " } + }, + "StackInstances": { + "target": "com.amazonaws.servicecatalog#StackInstances", + "traits": { + "smithy.api#documentation": "

    List of stack instances.

    " + } } } }, @@ -5292,17 +5389,17 @@ "smithy.api#documentation": "

    The TagOption key.

    " } }, - "Value": { - "target": "com.amazonaws.servicecatalog#TagOptionValue", - "traits": { - "smithy.api#documentation": "

    The TagOption value.

    " - } - }, "Active": { "target": "com.amazonaws.servicecatalog#TagOptionActive", "traits": { "smithy.api#documentation": "

    The active state.

    " } + }, + "Value": { + "target": "com.amazonaws.servicecatalog#TagOptionValue", + "traits": { + "smithy.api#documentation": "

    The TagOption value.

    " + } } }, "traits": { @@ -5312,8 +5409,14 @@ "com.amazonaws.servicecatalog#ListTagOptionsInput": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.servicecatalog#ListTagOptionsFilters", + "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.

    " + } + }, + "Filters": { + "target": "com.amazonaws.servicecatalog#ListTagOptionsFilters", "traits": { "smithy.api#documentation": "

    The search filters. If no search filters are specified, the output includes all TagOptions.

    " } @@ -5323,29 +5426,23 @@ "traits": { "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } - }, - "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.

    " - } } } }, "com.amazonaws.servicecatalog#ListTagOptionsOutput": { "type": "structure", "members": { - "TagOptionDetails": { - "target": "com.amazonaws.servicecatalog#TagOptionDetails", - "traits": { - "smithy.api#documentation": "

    Information about the TagOptions.

    " - } - }, "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.

    " } + }, + "TagOptionDetails": { + "target": "com.amazonaws.servicecatalog#TagOptionDetails", + "traits": { + "smithy.api#documentation": "

    Information about the TagOptions.

    " + } } } }, @@ -5401,17 +5498,17 @@ "com.amazonaws.servicecatalog#OrganizationNode": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.servicecatalog#OrganizationNodeValue", - "traits": { - "smithy.api#documentation": "

    The identifier of the organization node.

    " - } - }, "Type": { "target": "com.amazonaws.servicecatalog#OrganizationNodeType", "traits": { "smithy.api#documentation": "

    The organization node type.

    " } + }, + "Value": { + "target": "com.amazonaws.servicecatalog#OrganizationNodeValue", + "traits": { + "smithy.api#documentation": "

    The identifier of the organization node.

    " + } } }, "traits": { @@ -5461,6 +5558,18 @@ "com.amazonaws.servicecatalog#OutputKey": { "type": "string" }, + "com.amazonaws.servicecatalog#OutputKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.servicecatalog#OutputKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, "com.amazonaws.servicecatalog#OutputValue": { "type": "string" }, @@ -5545,6 +5654,18 @@ "com.amazonaws.servicecatalog#PortfolioDetail": { "type": "structure", "members": { + "ARN": { + "target": "com.amazonaws.servicecatalog#ResourceARN", + "traits": { + "smithy.api#documentation": "

    The ARN assigned to the portfolio.

    " + } + }, + "DisplayName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "traits": { + "smithy.api#documentation": "

    The name to use for display purposes.

    " + } + }, "CreatedTime": { "target": "com.amazonaws.servicecatalog#CreationTime", "traits": { @@ -5557,28 +5678,16 @@ "smithy.api#documentation": "

    The description of the portfolio.

    " } }, - "ProviderName": { - "target": "com.amazonaws.servicecatalog#ProviderName", - "traits": { - "smithy.api#documentation": "

    The name of the portfolio provider.

    " - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The portfolio identifier.

    " } }, - "ARN": { - "target": "com.amazonaws.servicecatalog#ResourceARN", - "traits": { - "smithy.api#documentation": "

    The ARN assigned to the portfolio.

    " - } - }, - "DisplayName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "ProviderName": { + "target": "com.amazonaws.servicecatalog#ProviderName", "traits": { - "smithy.api#documentation": "

    The name to use for display purposes.

    " + "smithy.api#documentation": "

    The name of the portfolio provider.

    " } } }, @@ -5715,17 +5824,17 @@ "com.amazonaws.servicecatalog#ProductViewAggregationValue": { "type": "structure", "members": { - "ApproximateCount": { - "target": "com.amazonaws.servicecatalog#ApproximateCount", - "traits": { - "smithy.api#documentation": "

    An approximate count of the products that match the value.

    " - } - }, "Value": { "target": "com.amazonaws.servicecatalog#AttributeValue", "traits": { "smithy.api#documentation": "

    The value of the product view aggregation.

    " } + }, + "ApproximateCount": { + "target": "com.amazonaws.servicecatalog#ApproximateCount", + "traits": { + "smithy.api#documentation": "

    An approximate count of the products that match the value.

    " + } } }, "traits": { @@ -5750,10 +5859,10 @@ "com.amazonaws.servicecatalog#ProductViewDetail": { "type": "structure", "members": { - "ProductViewSummary": { - "target": "com.amazonaws.servicecatalog#ProductViewSummary", + "ProductARN": { + "target": "com.amazonaws.servicecatalog#ResourceARN", "traits": { - "smithy.api#documentation": "

    Summary information about the product view.

    " + "smithy.api#documentation": "

    The ARN of the product.

    " } }, "CreatedTime": { @@ -5762,10 +5871,10 @@ "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " } }, - "ProductARN": { - "target": "com.amazonaws.servicecatalog#ResourceARN", + "ProductViewSummary": { + "target": "com.amazonaws.servicecatalog#ProductViewSummary", "traits": { - "smithy.api#documentation": "

    The ARN of the product.

    " + "smithy.api#documentation": "

    Summary information about the product view.

    " } }, "Status": { @@ -5884,28 +5993,22 @@ "com.amazonaws.servicecatalog#ProductViewSummary": { "type": "structure", "members": { - "HasDefaultPath": { - "target": "com.amazonaws.servicecatalog#HasDefaultPath", - "traits": { - "smithy.api#documentation": "

    Indicates whether the product has a default path.\n If the product does not have a default path, call ListLaunchPaths \n to disambiguate between paths. Otherwise, ListLaunchPaths is not \n required, and the output of ProductViewSummary can be used directly with \n DescribeProvisioningParameters.

    " - } - }, - "SupportDescription": { - "target": "com.amazonaws.servicecatalog#SupportDescription", + "Name": { + "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { - "smithy.api#documentation": "

    The description of the support for this Product.

    " + "smithy.api#documentation": "

    The name of the product.

    " } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "Owner": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", "traits": { - "smithy.api#documentation": "

    The product view identifier.

    " + "smithy.api#documentation": "

    The owner of the product. Contact the product administrator for the significance of\n this value.

    " } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "Type": { + "target": "com.amazonaws.servicecatalog#ProductType", "traits": { - "smithy.api#documentation": "

    The product identifier.

    " + "smithy.api#documentation": "

    The product type. Contact the product administrator for the significance of this\n value. If this value is MARKETPLACE, the product was created by AWS\n Marketplace.

    " } }, "ShortDescription": { @@ -5914,10 +6017,10 @@ "smithy.api#documentation": "

    Short description of the product.

    " } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "SupportDescription": { + "target": "com.amazonaws.servicecatalog#SupportDescription", "traits": { - "smithy.api#documentation": "

    The name of the product.

    " + "smithy.api#documentation": "

    The description of the support for this Product.

    " } }, "Distributor": { @@ -5926,28 +6029,34 @@ "smithy.api#documentation": "

    The distributor of the product. Contact the product administrator for the\n significance of this value.

    " } }, - "SupportUrl": { - "target": "com.amazonaws.servicecatalog#SupportUrl", + "Id": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The URL information to obtain support for this Product.

    " + "smithy.api#documentation": "

    The product view identifier.

    " } }, - "Type": { - "target": "com.amazonaws.servicecatalog#ProductType", + "SupportEmail": { + "target": "com.amazonaws.servicecatalog#SupportEmail", "traits": { - "smithy.api#documentation": "

    The product type. Contact the product administrator for the significance of this\n value. If this value is MARKETPLACE, the product was created by AWS\n Marketplace.

    " + "smithy.api#documentation": "

    The email contact information to obtain support for this Product.

    " } }, - "Owner": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "HasDefaultPath": { + "target": "com.amazonaws.servicecatalog#HasDefaultPath", "traits": { - "smithy.api#documentation": "

    The owner of the product. Contact the product administrator for the significance of\n this value.

    " + "smithy.api#documentation": "

    Indicates whether the product has a default path.\n If the product does not have a default path, call ListLaunchPaths \n to disambiguate between paths. Otherwise, ListLaunchPaths is not \n required, and the output of ProductViewSummary can be used directly with \n DescribeProvisioningParameters.

    " } }, - "SupportEmail": { - "target": "com.amazonaws.servicecatalog#SupportEmail", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The email contact information to obtain support for this Product.

    " + "smithy.api#documentation": "

    The product identifier.

    " + } + }, + "SupportUrl": { + "target": "com.amazonaws.servicecatalog#SupportUrl", + "traits": { + "smithy.api#documentation": "

    The URL information to obtain support for this Product.

    " } } }, @@ -6017,61 +6126,59 @@ "com.amazonaws.servicecatalog#ProvisionProductInput": { "type": "structure", "members": { - "ProvisionToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", "traits": { - "smithy.api#documentation": "

    An idempotency token that uniquely identifies the provisioning request.

    ", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    One or more tags.

    " } }, - "NotificationArns": { - "target": "com.amazonaws.servicecatalog#NotificationArns", + "PathId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.

    " + "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

    " } }, - "ProductName": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The name of the product. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    " } }, - "ProvisioningParameters": { - "target": "com.amazonaws.servicecatalog#ProvisioningParameters", + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

    Parameters specified by the administrator that are required for provisioning the\n product.

    " + "smithy.api#documentation": "

    A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.

    ", + "smithy.api#required": {} } }, - "ProvisioningPreferences": { - "target": "com.amazonaws.servicecatalog#ProvisioningPreferences", + "NotificationArns": { + "target": "com.amazonaws.servicecatalog#NotificationArns", "traits": { - "smithy.api#documentation": "

    An object that contains information about the provisioning preferences for a stack set.

    " + "smithy.api#documentation": "

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.

    " } }, - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "ProvisioningParameters": { + "target": "com.amazonaws.servicecatalog#ProvisioningParameters", "traits": { - "smithy.api#documentation": "

    A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Parameters specified by the administrator that are required for provisioning the\n product.

    " } }, - "ProvisioningArtifactId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The product identifier. You must provide the name or ID, but not both.

    " } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "ProvisioningArtifactName": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "

    One or more tags.

    " + "smithy.api#documentation": "

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "ProvisioningPreferences": { + "target": "com.amazonaws.servicecatalog#ProvisioningPreferences", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    An object that contains information about the provisioning preferences for a stack set.

    " } }, "PathName": { @@ -6080,22 +6187,24 @@ "smithy.api#documentation": "

    The name of the path. You must provide the name or ID, but not both.

    " } }, - "ProvisioningArtifactName": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProductName": { + "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { - "smithy.api#documentation": "

    The product identifier. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The name of the product. You must provide the name or ID, but not both.

    " } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProvisionToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    An idempotency token that uniquely identifies the provisioning request.

    ", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } } } @@ -6114,46 +6223,58 @@ "com.amazonaws.servicecatalog#ProvisionedProductAttribute": { "type": "structure", "members": { - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " + "smithy.api#documentation": "

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.

    " } }, - "UserArnSession": { - "target": "com.amazonaws.servicecatalog#UserArnSession", + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", "traits": { - "smithy.api#documentation": "

    The ARN of the IAM user in the session. This ARN might contain a session ID.

    " + "smithy.api#documentation": "

    One or more tags.

    " } }, - "Arn": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", + "LastProvisioningRecordId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The ARN of the provisioned product.

    " + "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " } }, - "Status": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductStatus", + "ProvisioningArtifactName": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "

    The current status of the provisioned product.

    \n
      \n
    • \n

      \n AVAILABLE - Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.

      \n
      • \n
    • \n

      \n UNDER_CHANGE - Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    • \n

      \n TAINTED - Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.

      \n
      • \n
    • \n

      \n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      \n
      • \n
    • \n

      \n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the provisioning artifact.

    " } }, - "UserArn": { - "target": "com.amazonaws.servicecatalog#UserArn", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM user.

    " + "smithy.api#documentation": "

    The product identifier.

    " } }, - "Id": { + "PhysicalId": { + "target": "com.amazonaws.servicecatalog#PhysicalId", + "traits": { + "smithy.api#documentation": "

    The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

    " + } + }, + "UserArnSession": { + "target": "com.amazonaws.servicecatalog#UserArnSession", + "traits": { + "smithy.api#documentation": "

    The ARN of the IAM user in the session. This ARN might contain a session ID.

    " + } + }, + "LastRecordId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioned product.

    " + "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product.

    " } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    One or more tags.

    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " } }, "Type": { @@ -6162,28 +6283,34 @@ "smithy.api#documentation": "

    The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

    " } }, - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "Status": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductStatus", "traits": { - "smithy.api#documentation": "

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.

    " + "smithy.api#documentation": "

    The current status of the provisioned product.

    \n
      \n
    • \n

      \n AVAILABLE - Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.

      \n
      • \n
    • \n

      \n UNDER_CHANGE - Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    • \n

      \n TAINTED - Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.

      \n
      • \n
    • \n

      \n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      \n
      • \n
    • \n

      \n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    " } }, - "LastRecordId": { + "UserArn": { + "target": "com.amazonaws.servicecatalog#UserArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM user.

    " + } + }, + "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product.

    " + "smithy.api#documentation": "

    The identifier of the provisioned product.

    " } }, - "PhysicalId": { - "target": "com.amazonaws.servicecatalog#PhysicalId", + "ProductName": { + "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { - "smithy.api#documentation": "

    The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

    " + "smithy.api#documentation": "

    The name of the product.

    " } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "Arn": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", "traits": { - "smithy.api#documentation": "

    The product identifier.

    " + "smithy.api#documentation": "

    The ARN of the provisioned product.

    " } }, "CreatedTime": { @@ -6203,6 +6330,12 @@ "traits": { "smithy.api#documentation": "

    The current status message of the provisioned product.

    " } + }, + "LastSuccessfulProvisioningRecordId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The record identifier of the last successful request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " + } } }, "traits": { @@ -6218,52 +6351,52 @@ "com.amazonaws.servicecatalog#ProvisionedProductDetail": { "type": "structure", "members": { - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "LastRecordId": { + "target": "com.amazonaws.servicecatalog#LastRequestId", "traits": { - "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    " + "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductStatusMessage", + "Status": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductStatus", "traits": { - "smithy.api#documentation": "

    The current status message of the provisioned product.

    " + "smithy.api#documentation": "

    The current status of the provisioned product.

    \n
      \n
    • \n

      \n AVAILABLE - Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.

      \n
      • \n
    • \n

      \n UNDER_CHANGE - Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    • \n

      \n TAINTED - Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.

      \n
      • \n
    • \n

      \n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      \n
      • \n
    • \n

      \n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    " } }, - "Id": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductId", + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioned product.

    " + "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " } }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", + "Arn": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " + "smithy.api#documentation": "

    The ARN of the provisioned product.

    " } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", + "Id": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductId", "traits": { - "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " + "smithy.api#documentation": "

    The identifier of the provisioned product.

    " } }, - "LastRecordId": { - "target": "com.amazonaws.servicecatalog#LastRequestId", + "LastSuccessfulProvisioningRecordId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product.

    " + "smithy.api#documentation": "

    The record identifier of the last successful request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " } }, - "Arn": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The ARN of the provisioned product.

    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#CreatedTime", + "LastProvisioningRecordId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " } }, "Type": { @@ -6278,10 +6411,22 @@ "smithy.api#documentation": "

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.

    " } }, - "Status": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductStatus", + "StatusMessage": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductStatusMessage", "traits": { - "smithy.api#documentation": "

    The current status of the provisioned product.

    \n
      \n
    • \n

      \n AVAILABLE - Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.

      \n
      • \n
    • \n

      \n UNDER_CHANGE - Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    • \n

      \n TAINTED - Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.

      \n
      • \n
    • \n

      \n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

      \n
      • \n
    • \n

      \n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

      \n
      • \n
    " + "smithy.api#documentation": "

    The current status message of the provisioned product.

    " + } + }, + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreatedTime", + "traits": { + "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + } + }, + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    " } } }, @@ -6330,10 +6475,16 @@ "com.amazonaws.servicecatalog#ProvisionedProductPlanDetails": { "type": "structure", "members": { - "PlanId": { - "target": "com.amazonaws.servicecatalog#Id", + "PlanName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", "traits": { - "smithy.api#documentation": "

    The plan identifier.

    " + "smithy.api#documentation": "

    The name of the plan.

    " + } + }, + "StatusMessage": { + "target": "com.amazonaws.servicecatalog#StatusMessage", + "traits": { + "smithy.api#documentation": "

    The status message.

    " } }, "Status": { @@ -6342,16 +6493,16 @@ "smithy.api#documentation": "

    The status.

    " } }, - "ProvisionProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "PlanId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " + "smithy.api#documentation": "

    The plan identifier.

    " } }, - "PlanType": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanType", + "ProvisioningParameters": { + "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", "traits": { - "smithy.api#documentation": "

    The plan type.

    " + "smithy.api#documentation": "

    Parameters specified by the administrator that are required for provisioning the\n product.

    " } }, "UpdatedTime": { @@ -6360,22 +6511,16 @@ "smithy.api#documentation": "

    The time when the plan was last updated.

    " } }, - "ProvisionProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The product identifier.

    " - } - }, "Tags": { "target": "com.amazonaws.servicecatalog#Tags", "traits": { "smithy.api#documentation": "

    One or more tags.

    " } }, - "ProvisioningParameters": { - "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", + "ProvisionProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    Parameters specified by the administrator that are required for provisioning the\n product.

    " + "smithy.api#documentation": "

    The product identifier.

    " } }, "ProvisioningArtifactId": { @@ -6384,40 +6529,40 @@ "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "PlanType": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanType", "traits": { - "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.

    " + "smithy.api#documentation": "

    The plan type.

    " } }, - "StatusMessage": { - "target": "com.amazonaws.servicecatalog#StatusMessage", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The status message.

    " + "smithy.api#documentation": "

    The product identifier.

    " } }, - "PlanName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", + "ProvisionProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

    The name of the plan.

    " + "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#CreatedTime", + "NotificationArns": { + "target": "com.amazonaws.servicecatalog#NotificationArns", "traits": { - "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + "smithy.api#documentation": "

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.

    " } }, - "ProductId": { + "PathId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The product identifier.

    " + "smithy.api#documentation": "

    The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.

    " } }, - "NotificationArns": { - "target": "com.amazonaws.servicecatalog#NotificationArns", + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreatedTime", "traits": { - "smithy.api#documentation": "

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.

    " + "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " } } }, @@ -6462,18 +6607,6 @@ "com.amazonaws.servicecatalog#ProvisionedProductPlanSummary": { "type": "structure", "members": { - "ProvisionProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", - "traits": { - "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " - } - }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " - } - }, "PlanId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -6497,6 +6630,18 @@ "traits": { "smithy.api#documentation": "

    The plan type.

    " } + }, + "ProvisionProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "traits": { + "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " + } + }, + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " + } } }, "traits": { @@ -6591,22 +6736,28 @@ "com.amazonaws.servicecatalog#ProvisioningArtifact": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "traits": { + "smithy.api#documentation": "

    The name of the provisioning artifact.

    " + } + }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactCreatedTime", "traits": { - "smithy.api#documentation": "

    The description of the provisioning artifact.

    " + "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "Description": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", "traits": { - "smithy.api#documentation": "

    The name of the provisioning artifact.

    " + "smithy.api#documentation": "

    The description of the provisioning artifact.

    " } }, "Guidance": { @@ -6614,12 +6765,6 @@ "traits": { "smithy.api#documentation": "

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    " } - }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactCreatedTime", - "traits": { - "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " - } } }, "traits": { @@ -6647,16 +6792,10 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactDetail": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " - } - }, - "Type": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreationTime", "traits": { - "smithy.api#documentation": "

    The type of provisioning artifact.

    \n
      \n
    • \n

      \n CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

      \n
      • \n
    • \n

      \n MARKETPLACE_AMI - AWS Marketplace AMI

      \n
      • \n
    • \n

      \n MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

      \n
      • \n
    " + "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " } }, "Active": { @@ -6665,6 +6804,18 @@ "smithy.api#documentation": "

    Indicates whether the product version is active.

    " } }, + "Id": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " + } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "traits": { + "smithy.api#documentation": "

    The description of the provisioning artifact.

    " + } + }, "Guidance": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactGuidance", "traits": { @@ -6677,16 +6828,10 @@ "smithy.api#documentation": "

    The name of the provisioning artifact.

    " } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", - "traits": { - "smithy.api#documentation": "

    The description of the provisioning artifact.

    " - } - }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#CreationTime", + "Type": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", "traits": { - "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + "smithy.api#documentation": "

    The type of provisioning artifact.

    \n
      \n
    • \n

      \n CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

      \n
      • \n
    • \n

      \n MARKETPLACE_AMI - AWS Marketplace AMI

      \n
      • \n
    • \n

      \n MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

      \n
      • \n
    " } } }, @@ -6748,17 +6893,17 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactOutput": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#OutputDescription", - "traits": { - "smithy.api#documentation": "

    Description of the provisioning artifact output key.

    " - } - }, "Key": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactOutputKey", "traits": { "smithy.api#documentation": "

    The provisioning artifact output key.

    " } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#OutputDescription", + "traits": { + "smithy.api#documentation": "

    Description of the provisioning artifact output key.

    " + } } }, "traits": { @@ -6790,6 +6935,18 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactParameter": { "type": "structure", "members": { + "ParameterType": { + "target": "com.amazonaws.servicecatalog#ParameterType", + "traits": { + "smithy.api#documentation": "

    The parameter type.

    " + } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#Description", + "traits": { + "smithy.api#documentation": "

    The description of the parameter.

    " + } + }, "IsNoEcho": { "target": "com.amazonaws.servicecatalog#NoEcho", "traits": { @@ -6802,10 +6959,10 @@ "smithy.api#documentation": "

    Constraints that the administrator has put on a parameter.

    " } }, - "ParameterType": { - "target": "com.amazonaws.servicecatalog#ParameterType", + "ParameterKey": { + "target": "com.amazonaws.servicecatalog#ParameterKey", "traits": { - "smithy.api#documentation": "

    The parameter type.

    " + "smithy.api#documentation": "

    The parameter key.

    " } }, "DefaultValue": { @@ -6813,18 +6970,6 @@ "traits": { "smithy.api#documentation": "

    The default value.

    " } - }, - "Description": { - "target": "com.amazonaws.servicecatalog#Description", - "traits": { - "smithy.api#documentation": "

    The description of the parameter.

    " - } - }, - "ParameterKey": { - "target": "com.amazonaws.servicecatalog#ParameterKey", - "traits": { - "smithy.api#documentation": "

    The parameter key.

    " - } } }, "traits": { @@ -6860,18 +7005,6 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactProperties": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", - "traits": { - "smithy.api#documentation": "

    The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

    " - } - }, - "DisableTemplateValidation": { - "target": "com.amazonaws.servicecatalog#DisableTemplateValidation", - "traits": { - "smithy.api#documentation": "

    If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

    " - } - }, "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { @@ -6890,6 +7023,18 @@ "traits": { "smithy.api#documentation": "

    The type of provisioning artifact.

    \n
      \n
    • \n

      \n CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

      \n
      • \n
    • \n

      \n MARKETPLACE_AMI - AWS Marketplace AMI

      \n
      • \n
    • \n

      \n MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

      \n
      • \n
    " } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", + "traits": { + "smithy.api#documentation": "

    The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

    " + } + }, + "DisableTemplateValidation": { + "target": "com.amazonaws.servicecatalog#DisableTemplateValidation", + "traits": { + "smithy.api#documentation": "

    If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

    " + } } }, "traits": { @@ -6919,34 +7064,34 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactSummary": { "type": "structure", "members": { - "ProvisioningArtifactMetadata": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", - "traits": { - "smithy.api#documentation": "

    The metadata for the provisioning artifact. This is used with AWS Marketplace products.

    " - } - }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", - "traits": { - "smithy.api#documentation": "

    The name of the provisioning artifact.

    " - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " } }, + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactCreatedTime", + "traits": { + "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + } + }, "Description": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", "traits": { "smithy.api#documentation": "

    The description of the provisioning artifact.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactCreatedTime", + "ProvisioningArtifactMetadata": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + "smithy.api#documentation": "

    The metadata for the provisioning artifact. This is used with AWS Marketplace products.

    " + } + }, + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "traits": { + "smithy.api#documentation": "

    The name of the provisioning artifact.

    " } } }, @@ -7008,17 +7153,17 @@ "com.amazonaws.servicecatalog#ProvisioningParameter": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.servicecatalog#ParameterKey", - "traits": { - "smithy.api#documentation": "

    The parameter key.

    " - } - }, "Value": { "target": "com.amazonaws.servicecatalog#ParameterValue", "traits": { "smithy.api#documentation": "

    The parameter value.

    " } + }, + "Key": { + "target": "com.amazonaws.servicecatalog#ParameterKey", + "traits": { + "smithy.api#documentation": "

    The parameter key.

    " + } } }, "traits": { @@ -7034,10 +7179,10 @@ "com.amazonaws.servicecatalog#ProvisioningPreferences": { "type": "structure", "members": { - "StackSetAccounts": { - "target": "com.amazonaws.servicecatalog#StackSetAccounts", + "StackSetMaxConcurrencyCount": { + "target": "com.amazonaws.servicecatalog#StackSetMaxConcurrencyCount", "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": "

    The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

    \n

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " } }, "StackSetRegions": { @@ -7052,6 +7197,12 @@ "smithy.api#documentation": "

    The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    \n

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    " } }, + "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.

    " + } + }, "StackSetFailureToleranceCount": { "target": "com.amazonaws.servicecatalog#StackSetFailureToleranceCount", "traits": { @@ -7063,12 +7214,6 @@ "traits": { "smithy.api#documentation": "

    The maximum percentage of accounts in which to perform this operation at one time.

    \n

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

    \n

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " } - }, - "StackSetMaxConcurrencyCount": { - "target": "com.amazonaws.servicecatalog#StackSetMaxConcurrencyCount", - "traits": { - "smithy.api#documentation": "

    The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

    \n

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " - } } }, "traits": { @@ -7078,28 +7223,34 @@ "com.amazonaws.servicecatalog#RecordDetail": { "type": "structure", "members": { + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreatedTime", + "traits": { + "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + } + }, "Status": { "target": "com.amazonaws.servicecatalog#RecordStatus", "traits": { "smithy.api#documentation": "

    The status of the provisioned product.

    \n
      \n
    • \n

      \n CREATED - The request was created but the operation has not started.

      \n
      • \n
    • \n

      \n IN_PROGRESS - The requested operation is in progress.

      \n
      • \n
    • \n

      \n IN_PROGRESS_IN_ERROR - The provisioned product is under change but the\n requested operation failed and some remediation is occurring. For example, a rollback.

      \n
      • \n
    • \n

      \n SUCCEEDED - The requested operation has successfully completed.

      \n
      • \n
    • \n

      \n FAILED - The requested operation has unsuccessfully completed.\n Investigate using the error messages returned.

      \n
      • \n
    " } }, - "RecordTags": { - "target": "com.amazonaws.servicecatalog#RecordTags", + "ProvisionedProductType": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductType", "traits": { - "smithy.api#documentation": "

    One or more tags.

    " + "smithy.api#documentation": "

    The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#CreatedTime", + "PathId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The UTC time stamp of the creation time.

    " + "smithy.api#documentation": "

    The path identifier.

    " } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

    The product identifier.

    " + "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " } }, "RecordType": { @@ -7108,52 +7259,46 @@ "smithy.api#documentation": "

    The record type.

    \n
      \n
    • \n

      \n PROVISION_PRODUCT\n

      \n
      • \n
    • \n

      \n UPDATE_PROVISIONED_PRODUCT\n

      \n
      • \n
    • \n

      \n TERMINATE_PROVISIONED_PRODUCT\n

      \n
      • \n
    " } }, - "ProvisionedProductType": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductType", - "traits": { - "smithy.api#documentation": "

    The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

    " - } - }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "RecordTags": { + "target": "com.amazonaws.servicecatalog#RecordTags", "traits": { - "smithy.api#documentation": "

    The path identifier.

    " + "smithy.api#documentation": "

    One or more tags.

    " } }, - "RecordId": { - "target": "com.amazonaws.servicecatalog#Id", + "UpdatedTime": { + "target": "com.amazonaws.servicecatalog#UpdatedTime", "traits": { - "smithy.api#documentation": "

    The identifier of the record.

    " + "smithy.api#documentation": "

    The time when the record was last updated.

    " } }, - "ProvisioningArtifactId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " + "smithy.api#documentation": "

    The product identifier.

    " } }, - "UpdatedTime": { - "target": "com.amazonaws.servicecatalog#UpdatedTime", + "RecordErrors": { + "target": "com.amazonaws.servicecatalog#RecordErrors", "traits": { - "smithy.api#documentation": "

    The time when the record was last updated.

    " + "smithy.api#documentation": "

    The errors that occurred.

    " } }, - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The user-friendly name of the provisioned product.

    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " } }, - "ProvisionedProductId": { + "RecordId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioned product.

    " + "smithy.api#documentation": "

    The identifier of the record.

    " } }, - "RecordErrors": { - "target": "com.amazonaws.servicecatalog#RecordErrors", + "ProvisionedProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The errors that occurred.

    " + "smithy.api#documentation": "

    The identifier of the provisioned product.

    " } } }, @@ -7196,12 +7341,6 @@ "com.amazonaws.servicecatalog#RecordOutput": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#Description", - "traits": { - "smithy.api#documentation": "

    The description of the output.

    " - } - }, "OutputKey": { "target": "com.amazonaws.servicecatalog#OutputKey", "traits": { @@ -7213,6 +7352,12 @@ "traits": { "smithy.api#documentation": "

    The output value.

    " } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#Description", + "traits": { + "smithy.api#documentation": "

    The description of the output.

    " + } } }, "traits": { @@ -7255,17 +7400,17 @@ "com.amazonaws.servicecatalog#RecordTag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.servicecatalog#RecordTagKey", - "traits": { - "smithy.api#documentation": "

    The key for this tag.

    " - } - }, "Value": { "target": "com.amazonaws.servicecatalog#RecordTagValue", "traits": { "smithy.api#documentation": "

    The value for this tag.

    " } + }, + "Key": { + "target": "com.amazonaws.servicecatalog#RecordTagKey", + "traits": { + "smithy.api#documentation": "

    The key for this tag.

    " + } } }, "traits": { @@ -7340,7 +7485,7 @@ "PortfolioShareType": { "target": "com.amazonaws.servicecatalog#PortfolioShareType", "traits": { - "smithy.api#documentation": "

    The type of shared portfolios to reject. The default is to reject imported portfolios.

    \n
      \n
    • \n

      \n AWS_ORGANIZATIONS - Reject portfolios shared by the master account of your organization.

      \n
      • \n
    • \n

      \n IMPORTED - Reject imported portfolios.

      \n
      • \n
    • \n

      \n AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

      \n
      • \n
    \n

    For example, aws servicecatalog reject-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS\n

    " + "smithy.api#documentation": "

    The type of shared portfolios to reject. The default is to reject imported portfolios.

    \n
      \n
    • \n

      \n AWS_ORGANIZATIONS - Reject portfolios shared by the management account of your\n organization.

      \n
      • \n
    • \n

      \n IMPORTED - Reject imported portfolios.

      \n
      • \n
    • \n

      \n AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

      \n
      • \n
    \n

    For example, aws servicecatalog reject-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS\n

    " } }, "AcceptLanguage": { @@ -7436,46 +7581,46 @@ "com.amazonaws.servicecatalog#ResourceChange": { "type": "structure", "members": { - "PhysicalResourceId": { - "target": "com.amazonaws.servicecatalog#PhysicalResourceId", + "Action": { + "target": "com.amazonaws.servicecatalog#ChangeAction", "traits": { - "smithy.api#documentation": "

    The ID of the resource, if it was already created.

    " + "smithy.api#documentation": "

    The change action.

    " } }, - "ResourceType": { - "target": "com.amazonaws.servicecatalog#PlanResourceType", + "LogicalResourceId": { + "target": "com.amazonaws.servicecatalog#LogicalResourceId", "traits": { - "smithy.api#documentation": "

    The type of resource.

    " + "smithy.api#documentation": "

    The ID of the resource, as defined in the CloudFormation template.

    " } }, - "Replacement": { - "target": "com.amazonaws.servicecatalog#Replacement", + "Scope": { + "target": "com.amazonaws.servicecatalog#Scope", "traits": { - "smithy.api#documentation": "

    If the change type is Modify, indicates whether the existing resource\n is deleted and replaced with a new one.

    " + "smithy.api#documentation": "

    The change scope.

    " } }, - "Action": { - "target": "com.amazonaws.servicecatalog#ChangeAction", + "Details": { + "target": "com.amazonaws.servicecatalog#ResourceChangeDetails", "traits": { - "smithy.api#documentation": "

    The change action.

    " + "smithy.api#documentation": "

    Information about the resource changes.

    " } }, - "Scope": { - "target": "com.amazonaws.servicecatalog#Scope", + "PhysicalResourceId": { + "target": "com.amazonaws.servicecatalog#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

    The change scope.

    " + "smithy.api#documentation": "

    The ID of the resource, if it was already created.

    " } }, - "LogicalResourceId": { - "target": "com.amazonaws.servicecatalog#LogicalResourceId", + "Replacement": { + "target": "com.amazonaws.servicecatalog#Replacement", "traits": { - "smithy.api#documentation": "

    The ID of the resource, as defined in the CloudFormation template.

    " + "smithy.api#documentation": "

    If the change type is Modify, indicates whether the existing resource\n is deleted and replaced with a new one.

    " } }, - "Details": { - "target": "com.amazonaws.servicecatalog#ResourceChangeDetails", + "ResourceType": { + "target": "com.amazonaws.servicecatalog#PlanResourceType", "traits": { - "smithy.api#documentation": "

    Information about the resource changes.

    " + "smithy.api#documentation": "

    The type of resource.

    " } } }, @@ -7492,17 +7637,17 @@ "smithy.api#documentation": "

    Information about the resource attribute to be modified.

    " } }, - "CausingEntity": { - "target": "com.amazonaws.servicecatalog#CausingEntity", - "traits": { - "smithy.api#documentation": "

    The ID of the entity that caused the change.

    " - } - }, "Evaluation": { "target": "com.amazonaws.servicecatalog#EvaluationType", "traits": { "smithy.api#documentation": "

    For static evaluations, the value of the resource attribute will change and the new value is known.\n For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.

    " } + }, + "CausingEntity": { + "target": "com.amazonaws.servicecatalog#CausingEntity", + "traits": { + "smithy.api#documentation": "

    The ID of the entity that caused the change.

    " + } } }, "traits": { @@ -7524,10 +7669,10 @@ "com.amazonaws.servicecatalog#ResourceDetail": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#ResourceDetailCreatedTime", + "ARN": { + "target": "com.amazonaws.servicecatalog#ResourceDetailARN", "traits": { - "smithy.api#documentation": "

    The creation time of the resource.

    " + "smithy.api#documentation": "

    The ARN of the resource.

    " } }, "Id": { @@ -7536,18 +7681,18 @@ "smithy.api#documentation": "

    The identifier of the resource.

    " } }, - "ARN": { - "target": "com.amazonaws.servicecatalog#ResourceDetailARN", - "traits": { - "smithy.api#documentation": "

    The ARN of the resource.

    " - } - }, "Description": { "target": "com.amazonaws.servicecatalog#ResourceDetailDescription", "traits": { "smithy.api#documentation": "

    The description of the resource.

    " } }, + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#ResourceDetailCreatedTime", + "traits": { + "smithy.api#documentation": "

    The creation time of the resource.

    " + } + }, "Name": { "target": "com.amazonaws.servicecatalog#ResourceDetailName", "traits": { @@ -7610,12 +7755,6 @@ "com.amazonaws.servicecatalog#ResourceTargetDefinition": { "type": "structure", "members": { - "RequiresRecreation": { - "target": "com.amazonaws.servicecatalog#RequiresRecreation", - "traits": { - "smithy.api#documentation": "

    If the attribute is Properties, indicates whether a change to this property\n causes the resource to be re-created.

    " - } - }, "Name": { "target": "com.amazonaws.servicecatalog#PropertyName", "traits": { @@ -7627,6 +7766,12 @@ "traits": { "smithy.api#documentation": "

    The attribute to be changed.

    " } + }, + "RequiresRecreation": { + "target": "com.amazonaws.servicecatalog#RequiresRecreation", + "traits": { + "smithy.api#documentation": "

    If the attribute is Properties, indicates whether a change to this property\n causes the resource to be re-created.

    " + } } }, "traits": { @@ -7656,46 +7801,46 @@ "com.amazonaws.servicecatalog#ScanProvisionedProductsInput": { "type": "structure", "members": { - "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.

    " - } - }, - "AccessLevelFilter": { - "target": "com.amazonaws.servicecatalog#AccessLevelFilter", - "traits": { - "smithy.api#documentation": "

    The access level to use to obtain results. The default is User.

    " - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, + "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#PageSize", "traits": { "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } + }, + "AccessLevelFilter": { + "target": "com.amazonaws.servicecatalog#AccessLevelFilter", + "traits": { + "smithy.api#documentation": "

    The access level to use to obtain results. The default is User.

    " + } } } }, "com.amazonaws.servicecatalog#ScanProvisionedProductsOutput": { "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.

    " - } - }, "ProvisionedProducts": { "target": "com.amazonaws.servicecatalog#ProvisionedProductDetails", "traits": { "smithy.api#documentation": "

    Information about the provisioned products.

    " } + }, + "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.

    " + } } } }, @@ -7761,22 +7906,22 @@ "com.amazonaws.servicecatalog#SearchProductsAsAdminInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, - "PortfolioId": { - "target": "com.amazonaws.servicecatalog#Id", + "SortOrder": { + "target": "com.amazonaws.servicecatalog#SortOrder", "traits": { - "smithy.api#documentation": "

    The portfolio identifier.

    " + "smithy.api#documentation": "

    The sort order. If no value is specified, the results are not sorted.

    " } }, - "ProductSource": { - "target": "com.amazonaws.servicecatalog#ProductSource", + "SortBy": { + "target": "com.amazonaws.servicecatalog#ProductViewSortBy", "traits": { - "smithy.api#documentation": "

    Access level of the source of the product.

    " + "smithy.api#documentation": "

    The sort field. If no value is specified, the results are not sorted.

    " } }, "Filters": { @@ -7785,28 +7930,28 @@ "smithy.api#documentation": "

    The search filters. If no search filters are specified, the output includes all products \n to which the administrator has access.

    " } }, - "SortOrder": { - "target": "com.amazonaws.servicecatalog#SortOrder", + "ProductSource": { + "target": "com.amazonaws.servicecatalog#ProductSource", "traits": { - "smithy.api#documentation": "

    The sort order. If no value is specified, the results are not sorted.

    " + "smithy.api#documentation": "

    Access level of the source of the product.

    " } }, - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, - "SortBy": { - "target": "com.amazonaws.servicecatalog#ProductViewSortBy", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "

    The sort field. If no value is specified, the results are not sorted.

    " + "smithy.api#documentation": "

    The page token for the next set of results. To retrieve the first set of results, use null.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The portfolio identifier.

    " } } } @@ -7837,12 +7982,6 @@ "smithy.api#documentation": "

    The search filters. If no search filters are specified, the output includes\n all products to which the caller has access.

    " } }, - "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#PageSize", "traits": { @@ -7866,16 +8005,22 @@ "traits": { "smithy.api#documentation": "

    The sort field. If no value is specified, the results are not sorted.

    " } + }, + "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.

    " + } } } }, "com.amazonaws.servicecatalog#SearchProductsOutput": { "type": "structure", "members": { - "ProductViewSummaries": { - "target": "com.amazonaws.servicecatalog#ProductViewSummaries", + "ProductViewAggregations": { + "target": "com.amazonaws.servicecatalog#ProductViewAggregations", "traits": { - "smithy.api#documentation": "

    Information about the product views.

    " + "smithy.api#documentation": "

    The product view aggregations.

    " } }, "NextPageToken": { @@ -7884,10 +8029,10 @@ "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.

    " } }, - "ProductViewAggregations": { - "target": "com.amazonaws.servicecatalog#ProductViewAggregations", + "ProductViewSummaries": { + "target": "com.amazonaws.servicecatalog#ProductViewSummaries", "traits": { - "smithy.api#documentation": "

    The product view aggregations.

    " + "smithy.api#documentation": "

    Information about the product views.

    " } } } @@ -7917,46 +8062,46 @@ "com.amazonaws.servicecatalog#SearchProvisionedProductsInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#SearchProvisionedProductsPageSize", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " - } - }, "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.

    " } }, - "SortOrder": { - "target": "com.amazonaws.servicecatalog#SortOrder", + "AccessLevelFilter": { + "target": "com.amazonaws.servicecatalog#AccessLevelFilter", "traits": { - "smithy.api#documentation": "

    The sort order. If no value is specified, the results are not sorted.

    " + "smithy.api#documentation": "

    The access level to use to obtain results. The default is User.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#SearchProvisionedProductsPageSize", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    " } }, - "SortBy": { - "target": "com.amazonaws.servicecatalog#SortField", + "Filters": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductFilters", "traits": { - "smithy.api#documentation": "

    The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, \n and lastRecordId.

    " + "smithy.api#documentation": "

    The search filters.

    \n

    When the key is SearchQuery, the searchable fields are arn, \n createdTime, id, lastRecordId,\n idempotencyToken, name, physicalId, productId, \n provisioningArtifact, type, status,\n tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, \n productName, and provisioningArtifactName.

    \n

    Example: \"SearchQuery\":[\"status:AVAILABLE\"]\n

    " } }, - "Filters": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductFilters", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "SortOrder": { + "target": "com.amazonaws.servicecatalog#SortOrder", "traits": { - "smithy.api#documentation": "

    The search filters.

    \n

    When the key is SearchQuery, the searchable fields are arn, \n createdTime, id, lastRecordId,\n idempotencyToken, name, physicalId, productId, \n provisioningArtifact, type, status,\n tags, userArn, and userArnSession.

    \n

    Example: \"SearchQuery\":[\"status:AVAILABLE\"]\n

    " + "smithy.api#documentation": "

    The sort order. If no value is specified, the results are not sorted.

    " } }, - "AccessLevelFilter": { - "target": "com.amazonaws.servicecatalog#AccessLevelFilter", + "SortBy": { + "target": "com.amazonaws.servicecatalog#SortField", "traits": { - "smithy.api#documentation": "

    The access level to use to obtain results. The default is User.

    " + "smithy.api#documentation": "

    The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, \n and lastRecordId.

    " } } } @@ -7964,10 +8109,10 @@ "com.amazonaws.servicecatalog#SearchProvisionedProductsOutput": { "type": "structure", "members": { - "TotalResultsCount": { - "target": "com.amazonaws.servicecatalog#TotalResultsCount", + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "

    The number of provisioned products found.

    " + "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.

    " } }, "ProvisionedProducts": { @@ -7976,10 +8121,10 @@ "smithy.api#documentation": "

    Information about the provisioned products.

    " } }, - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "TotalResultsCount": { + "target": "com.amazonaws.servicecatalog#TotalResultsCount", "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.

    " + "smithy.api#documentation": "

    The number of provisioned products found.

    " } } } @@ -7996,24 +8141,24 @@ "com.amazonaws.servicecatalog#ServiceActionAssociation": { "type": "structure", "members": { - "ServiceActionId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    ", + "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    ", "smithy.api#required": {} } }, - "ProvisioningArtifactId": { + "ServiceActionId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    ", + "smithy.api#documentation": "

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    ", "smithy.api#required": {} } }, - "ProductId": { + "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The product identifier. For example, prod-abcdzk7xy33qa.

    ", + "smithy.api#documentation": "

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    ", "smithy.api#required": {} } } @@ -8176,22 +8321,16 @@ "com.amazonaws.servicecatalog#ServiceActionSummary": { "type": "structure", "members": { - "DefinitionType": { - "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionType", - "traits": { - "smithy.api#documentation": "

    The self-service action definition type. For example, SSM_AUTOMATION.

    " - } - }, "Name": { "target": "com.amazonaws.servicecatalog#ServiceActionName", "traits": { "smithy.api#documentation": "

    The self-service action name.

    " } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ServiceActionDescription", + "DefinitionType": { + "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionType", "traits": { - "smithy.api#documentation": "

    The self-service action description.

    " + "smithy.api#documentation": "

    The self-service action definition type. For example, SSM_AUTOMATION.

    " } }, "Id": { @@ -8199,6 +8338,12 @@ "traits": { "smithy.api#documentation": "

    The self-service action identifier.

    " } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#ServiceActionDescription", + "traits": { + "smithy.api#documentation": "

    The self-service action description.

    " + } } }, "traits": { @@ -8228,10 +8373,10 @@ "com.amazonaws.servicecatalog#ShareError": { "type": "structure", "members": { - "Error": { - "target": "com.amazonaws.servicecatalog#Error", + "Accounts": { + "target": "com.amazonaws.servicecatalog#Namespaces", "traits": { - "smithy.api#documentation": "

    Error type that happened when processing the operation.

    " + "smithy.api#documentation": "

    List of accounts impacted by the error.

    " } }, "Message": { @@ -8240,10 +8385,10 @@ "smithy.api#documentation": "

    Information about the error.

    " } }, - "Accounts": { - "target": "com.amazonaws.servicecatalog#Namespaces", + "Error": { + "target": "com.amazonaws.servicecatalog#Error", "traits": { - "smithy.api#documentation": "

    List of accounts impacted by the error.

    " + "smithy.api#documentation": "

    Error type that happened when processing the operation.

    " } } }, @@ -8320,10 +8465,10 @@ "com.amazonaws.servicecatalog#StackInstance": { "type": "structure", "members": { - "StackInstanceStatus": { - "target": "com.amazonaws.servicecatalog#StackInstanceStatus", + "Region": { + "target": "com.amazonaws.servicecatalog#Region", "traits": { - "smithy.api#documentation": "

    The status of the stack instance, in terms of its synchronization with its associated stack set.

    \n
      \n
    • \n

      \n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

      \n
      • \n
    • \n

      \n OUTDATED: The stack isn't currently up to date with the stack set because either \n the associated stack failed during a CreateStackSet or UpdateStackSet operation, \n or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

      \n
      • \n
    • \n

      \n CURRENT: The stack is currently up to date with the stack set.

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the AWS region that the stack instance is associated with.

    " } }, "Account": { @@ -8332,10 +8477,10 @@ "smithy.api#documentation": "

    The name of the AWS account that the stack instance is associated with.

    " } }, - "Region": { - "target": "com.amazonaws.servicecatalog#Region", + "StackInstanceStatus": { + "target": "com.amazonaws.servicecatalog#StackInstanceStatus", "traits": { - "smithy.api#documentation": "

    The name of the AWS region that the stack instance is associated with.

    " + "smithy.api#documentation": "

    The status of the stack instance, in terms of its synchronization with its associated stack set.

    \n
      \n
    • \n

      \n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

      \n
      • \n
    • \n

      \n OUTDATED: The stack isn't currently up to date with the stack set because either \n the associated stack failed during a CreateStackSet or UpdateStackSet operation, \n or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

      \n
      • \n
    • \n

      \n CURRENT: The stack is currently up to date with the stack set.

      \n
      • \n
    " } } }, @@ -8498,17 +8643,17 @@ "com.amazonaws.servicecatalog#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.servicecatalog#TagValue", + "Key": { + "target": "com.amazonaws.servicecatalog#TagKey", "traits": { - "smithy.api#documentation": "

    The value for this key.

    ", + "smithy.api#documentation": "

    The tag key.

    ", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.servicecatalog#TagKey", + "Value": { + "target": "com.amazonaws.servicecatalog#TagValue", "traits": { - "smithy.api#documentation": "

    The tag key.

    ", + "smithy.api#documentation": "

    The value for this key.

    ", "smithy.api#required": {} } } @@ -8548,10 +8693,10 @@ "smithy.api#documentation": "

    The TagOption identifier.

    " } }, - "Key": { - "target": "com.amazonaws.servicecatalog#TagOptionKey", + "Active": { + "target": "com.amazonaws.servicecatalog#TagOptionActive", "traits": { - "smithy.api#documentation": "

    The TagOption key.

    " + "smithy.api#documentation": "

    The TagOption active state.

    " } }, "Value": { @@ -8560,10 +8705,10 @@ "smithy.api#documentation": "

    The TagOption value.

    " } }, - "Active": { - "target": "com.amazonaws.servicecatalog#TagOptionActive", + "Key": { + "target": "com.amazonaws.servicecatalog#TagOptionKey", "traits": { - "smithy.api#documentation": "

    The TagOption active state.

    " + "smithy.api#documentation": "

    The TagOption key.

    " } } }, @@ -8692,20 +8837,6 @@ "com.amazonaws.servicecatalog#TerminateProvisionedProductInput": { "type": "structure", "members": { - "TerminateToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

    An idempotency token that uniquely identifies the termination request. This token is\n only valid during the termination process. After the provisioned product is terminated,\n subsequent requests to terminate the same provisioned product always return\n ResourceNotFound.

    ", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "ProvisionedProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the provisioned product. You cannot specify both\n ProvisionedProductName and ProvisionedProductId.

    " - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -8723,6 +8854,20 @@ "traits": { "smithy.api#documentation": "

    The name of the provisioned product. You cannot specify both\n ProvisionedProductName and ProvisionedProductId.

    " } + }, + "ProvisionedProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the provisioned product. You cannot specify both\n ProvisionedProductName and ProvisionedProductId.

    " + } + }, + "TerminateToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

    An idempotency token that uniquely identifies the termination request. This token is\n only valid during the termination process. After the provisioned product is terminated,\n subsequent requests to terminate the same provisioned product always return\n ResourceNotFound.

    ", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } } } }, @@ -8763,10 +8908,10 @@ "com.amazonaws.servicecatalog#UpdateConstraintInput": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.servicecatalog#ConstraintParameters", + "Description": { + "target": "com.amazonaws.servicecatalog#ConstraintDescription", "traits": { - "smithy.api#documentation": "

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    \n
    \n
    LAUNCH
    \n
    \n

    You are required to specify either the RoleArn or the LocalRoleName but can't use both.

    \n

    Specify the RoleArn property as follows:

    \n

    \n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

    \n

    Specify the LocalRoleName property as follows:

    \n

    \n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

    \n

    If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

    \n \n

    The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

    \n     \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    \n
    \n
    NOTIFICATION
    \n
    \n

    Specify the NotificationArns property as follows:

    \n

    \n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

    \n
    \n
    RESOURCE_UPDATE
    \n
    \n

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    \n

    \n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

    \n

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    \n
    \n
    STACKSET
    \n
    \n

    Specify the Parameters property as follows:

    \n

    \n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

    \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    \n

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    \n
    \n
    TEMPLATE
    \n
    \n

    Specify the Rules property. For more information, see\n Template Constraint Rules.

    \n
    \n
    " + "smithy.api#documentation": "

    The updated description of the constraint.

    " } }, "Id": { @@ -8776,16 +8921,16 @@ "smithy.api#required": {} } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Parameters": { + "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    \n
    \n
    LAUNCH
    \n
    \n

    You are required to specify either the RoleArn or the LocalRoleName but can't use both.

    \n

    Specify the RoleArn property as follows:

    \n

    \n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}\n

    \n

    Specify the LocalRoleName property as follows:

    \n

    \n {\"LocalRoleName\": \"SCBasicLaunchRole\"}\n

    \n

    If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.

    \n \n

    The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

    \n     \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    \n
    \n
    NOTIFICATION
    \n
    \n

    Specify the NotificationArns property as follows:

    \n

    \n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}\n

    \n
    \n
    RESOURCE_UPDATE
    \n
    \n

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    \n

    \n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}\n

    \n

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    \n
    \n
    STACKSET
    \n
    \n

    Specify the Parameters property as follows:

    \n

    \n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}\n

    \n

    You cannot have both a LAUNCH and a STACKSET constraint.

    \n

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    \n

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    \n
    \n
    TEMPLATE
    \n
    \n

    Specify the Rules property. For more information, see\n Template Constraint Rules.

    \n
    \n
    " } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ConstraintDescription", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The updated description of the constraint.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } } } @@ -8793,6 +8938,12 @@ "com.amazonaws.servicecatalog#UpdateConstraintOutput": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.servicecatalog#Status", + "traits": { + "smithy.api#documentation": "

    The status of the current request.

    " + } + }, "ConstraintDetail": { "target": "com.amazonaws.servicecatalog#ConstraintDetail", "traits": { @@ -8804,12 +8955,6 @@ "traits": { "smithy.api#documentation": "

    The constraint parameters.

    " } - }, - "Status": { - "target": "com.amazonaws.servicecatalog#Status", - "traits": { - "smithy.api#documentation": "

    The status of the current request.

    " - } } } }, @@ -8842,12 +8987,6 @@ "com.amazonaws.servicecatalog#UpdatePortfolioInput": { "type": "structure", "members": { - "RemoveTags": { - "target": "com.amazonaws.servicecatalog#TagKeys", - "traits": { - "smithy.api#documentation": "

    The tags to remove.

    " - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -8855,12 +8994,6 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.servicecatalog#PortfolioDescription", - "traits": { - "smithy.api#documentation": "

    The updated description of the portfolio.

    " - } - }, "ProviderName": { "target": "com.amazonaws.servicecatalog#ProviderName", "traits": { @@ -8873,10 +9006,10 @@ "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } }, - "DisplayName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "Description": { + "target": "com.amazonaws.servicecatalog#PortfolioDescription", "traits": { - "smithy.api#documentation": "

    The name to use for display purposes.

    " + "smithy.api#documentation": "

    The updated description of the portfolio.

    " } }, "AddTags": { @@ -8884,23 +9017,35 @@ "traits": { "smithy.api#documentation": "

    The tags to add.

    " } + }, + "RemoveTags": { + "target": "com.amazonaws.servicecatalog#TagKeys", + "traits": { + "smithy.api#documentation": "

    The tags to remove.

    " + } + }, + "DisplayName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "traits": { + "smithy.api#documentation": "

    The name to use for display purposes.

    " + } } } }, "com.amazonaws.servicecatalog#UpdatePortfolioOutput": { "type": "structure", "members": { - "PortfolioDetail": { - "target": "com.amazonaws.servicecatalog#PortfolioDetail", - "traits": { - "smithy.api#documentation": "

    Information about the portfolio.

    " - } - }, "Tags": { "target": "com.amazonaws.servicecatalog#Tags", "traits": { "smithy.api#documentation": "

    Information about the tags associated with the portfolio.

    " } + }, + "PortfolioDetail": { + "target": "com.amazonaws.servicecatalog#PortfolioDetail", + "traits": { + "smithy.api#documentation": "

    Information about the portfolio.

    " + } } } }, @@ -8930,35 +9075,22 @@ "com.amazonaws.servicecatalog#UpdateProductInput": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The product identifier.

    ", - "smithy.api#required": {} - } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, - "Description": { - "target": "com.amazonaws.servicecatalog#ProductViewShortDescription", + "Distributor": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", "traits": { - "smithy.api#documentation": "

    The updated description of the product.

    " + "smithy.api#documentation": "

    The updated distributor of the product.

    " } }, - "SupportDescription": { - "target": "com.amazonaws.servicecatalog#SupportDescription", + "SupportEmail": { + "target": "com.amazonaws.servicecatalog#SupportEmail", "traits": { - "smithy.api#documentation": "

    The updated support description for the product.

    " + "smithy.api#documentation": "

    The updated support email for the product.

    " } }, - "SupportUrl": { - "target": "com.amazonaws.servicecatalog#SupportUrl", + "Owner": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", "traits": { - "smithy.api#documentation": "

    The updated support URL for the product.

    " + "smithy.api#documentation": "

    The updated owner of the product.

    " } }, "Name": { @@ -8967,28 +9099,35 @@ "smithy.api#documentation": "

    The updated product name.

    " } }, - "AddTags": { - "target": "com.amazonaws.servicecatalog#AddTags", + "Description": { + "target": "com.amazonaws.servicecatalog#ProductViewShortDescription", "traits": { - "smithy.api#documentation": "

    The tags to add to the product.

    " + "smithy.api#documentation": "

    The updated description of the product.

    " } }, - "Owner": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "Id": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The updated owner of the product.

    " + "smithy.api#documentation": "

    The product identifier.

    ", + "smithy.api#required": {} } }, - "SupportEmail": { - "target": "com.amazonaws.servicecatalog#SupportEmail", + "SupportDescription": { + "target": "com.amazonaws.servicecatalog#SupportDescription", "traits": { - "smithy.api#documentation": "

    The updated support email for the product.

    " + "smithy.api#documentation": "

    The updated support description for the product.

    " + } + }, + "AddTags": { + "target": "com.amazonaws.servicecatalog#AddTags", + "traits": { + "smithy.api#documentation": "

    The tags to add to the product.

    " } }, - "Distributor": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "SupportUrl": { + "target": "com.amazonaws.servicecatalog#SupportUrl", "traits": { - "smithy.api#documentation": "

    The updated distributor of the product.

    " + "smithy.api#documentation": "

    The updated support URL for the product.

    " } }, "RemoveTags": { @@ -8996,23 +9135,29 @@ "traits": { "smithy.api#documentation": "

    The tags to remove from the product.

    " } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } } } }, "com.amazonaws.servicecatalog#UpdateProductOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", - "traits": { - "smithy.api#documentation": "

    Information about the tags associated with the product.

    " - } - }, "ProductViewDetail": { "target": "com.amazonaws.servicecatalog#ProductViewDetail", "traits": { "smithy.api#documentation": "

    Information about the product view.

    " } + }, + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", + "traits": { + "smithy.api#documentation": "

    Information about the tags associated with the product.

    " + } } } }, @@ -9039,10 +9184,22 @@ "com.amazonaws.servicecatalog#UpdateProvisionedProductInput": { "type": "structure", "members": { - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", + "PathName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", "traits": { - "smithy.api#documentation": "

    The name of the provisioned product. You cannot specify both\n ProvisionedProductName and ProvisionedProductId.

    " + "smithy.api#documentation": "

    The name of the path. You must provide the name or ID, but not both.

    " + } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the product. You must provide the name or ID, but not both.

    " } }, "ProvisioningArtifactName": { @@ -9051,16 +9208,16 @@ "smithy.api#documentation": "

    The name of the provisioning artifact. You must provide the name or ID, but not both.

    " } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProvisioningParameters": { + "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", "traits": { - "smithy.api#documentation": "

    The path identifier. This value is optional if the product \n has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The new parameters.

    " } }, - "ProvisionedProductId": { + "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioned product. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " } }, "ProvisioningPreferences": { @@ -9069,28 +9226,16 @@ "smithy.api#documentation": "

    An object that contains information about the provisioning preferences for a stack set.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, - "PathName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", "traits": { - "smithy.api#documentation": "

    The name of the path. You must provide the name or ID, but not both.

    " + "smithy.api#documentation": "

    The name of the provisioned product. You cannot specify both\n ProvisionedProductName and ProvisionedProductId.

    " } }, - "ProvisioningArtifactId": { + "ProvisionedProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    " - } - }, - "ProvisioningParameters": { - "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", - "traits": { - "smithy.api#documentation": "

    The new parameters.

    " + "smithy.api#documentation": "

    The identifier of the provisioned product. You must provide the name or ID, but not both.

    " } }, "Tags": { @@ -9105,12 +9250,6 @@ "smithy.api#documentation": "

    The name of the product. You must provide the name or ID, but not both.

    " } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the product. You must provide the name or ID, but not both.

    " - } - }, "UpdateToken": { "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { @@ -9118,6 +9257,12 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "PathId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The path identifier. This value is optional if the product \n has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

    " + } } } }, @@ -9191,29 +9336,29 @@ "com.amazonaws.servicecatalog#UpdateProvisionedProductPropertiesOutput": { "type": "structure", "members": { - "ProvisionedProductProperties": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductProperties", - "traits": { - "smithy.api#documentation": "

    A map that contains the properties updated.

    " - } - }, "ProvisionedProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "

    The provisioned product identifier.

    " } }, - "RecordId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "

    The identifier of the record.

    " - } - }, "Status": { "target": "com.amazonaws.servicecatalog#RecordStatus", "traits": { "smithy.api#documentation": "

    The status of the request.

    " } + }, + "ProvisionedProductProperties": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductProperties", + "traits": { + "smithy.api#documentation": "

    A map that contains the properties updated.

    " + } + }, + "RecordId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the record.

    " + } } } }, @@ -9240,17 +9385,23 @@ "com.amazonaws.servicecatalog#UpdateProvisioningArtifactInput": { "type": "structure", "members": { - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "

    The product identifier.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The updated name of the provisioning artifact.

    " } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "

    The updated description of the provisioning artifact.

    " + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + } + }, + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    ", + "smithy.api#required": {} } }, "Guidance": { @@ -9259,29 +9410,23 @@ "smithy.api#documentation": "

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    \n

    The DEFAULT value indicates that the product version is active.

    \n

    The administrator can set the guidance to DEPRECATED to inform\n users that the product version is deprecated. Users are able to make updates to a provisioned product \n of a deprecated version but cannot launch new provisioned products using a deprecated version.

    " } }, - "ProvisioningArtifactId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The identifier of the provisioning artifact.

    ", + "smithy.api#documentation": "

    The product identifier.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", - "traits": { - "smithy.api#documentation": "

    The updated name of the provisioning artifact.

    " - } - }, "Active": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactActive", "traits": { "smithy.api#documentation": "

    Indicates whether the product version is active.

    \n

    Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

    " } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Description": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " + "smithy.api#documentation": "

    The updated description of the provisioning artifact.

    " } } } @@ -9295,27 +9440,27 @@ "smithy.api#documentation": "

    The status of the current request.

    " } }, - "ProvisioningArtifactDetail": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDetail", - "traits": { - "smithy.api#documentation": "

    Information about the provisioning artifact.

    " - } - }, "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { "smithy.api#documentation": "

    The URL of the CloudFormation template in Amazon S3.

    " } + }, + "ProvisioningArtifactDetail": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDetail", + "traits": { + "smithy.api#documentation": "

    Information about the provisioning artifact.

    " + } } } }, "com.amazonaws.servicecatalog#UpdateProvisioningParameter": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.servicecatalog#ParameterKey", + "Value": { + "target": "com.amazonaws.servicecatalog#ParameterValue", "traits": { - "smithy.api#documentation": "

    The parameter key.

    " + "smithy.api#documentation": "

    The parameter value.

    " } }, "UsePreviousValue": { @@ -9324,10 +9469,10 @@ "smithy.api#documentation": "

    If set to true, Value is ignored and the previous parameter value is kept.

    " } }, - "Value": { - "target": "com.amazonaws.servicecatalog#ParameterValue", + "Key": { + "target": "com.amazonaws.servicecatalog#ParameterKey", "traits": { - "smithy.api#documentation": "

    The parameter value.

    " + "smithy.api#documentation": "

    The parameter key.

    " } } }, @@ -9344,18 +9489,24 @@ "com.amazonaws.servicecatalog#UpdateProvisioningPreferences": { "type": "structure", "members": { - "StackSetRegions": { - "target": "com.amazonaws.servicecatalog#StackSetRegions", - "traits": { - "smithy.api#documentation": "

    One or more AWS Regions where the provisioned product will be available.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

    \n

    If no values are specified, the default value is all regions from the STACKSET constraint.

    " - } - }, "StackSetMaxConcurrencyCount": { "target": "com.amazonaws.servicecatalog#StackSetMaxConcurrencyCount", "traits": { "smithy.api#documentation": "

    The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

    \n

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " } }, + "StackSetFailureToleranceCount": { + "target": "com.amazonaws.servicecatalog#StackSetFailureToleranceCount", + "traits": { + "smithy.api#documentation": "

    The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    \n

    The default value is 0 if no value is specified.

    " + } + }, + "StackSetMaxConcurrencyPercentage": { + "target": "com.amazonaws.servicecatalog#StackSetMaxConcurrencyPercentage", + "traits": { + "smithy.api#documentation": "

    The maximum percentage of accounts in which to perform this operation at one time.

    \n

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

    \n

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " + } + }, "StackSetAccounts": { "target": "com.amazonaws.servicecatalog#StackSetAccounts", "traits": { @@ -9368,10 +9519,10 @@ "smithy.api#documentation": "

    Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n
    \n
    CREATE
    \n
    \n

    Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

    \n
    \n
    UPDATE
    \n
    \n

    Updates the stack set represented by the provisioned product and also its stack instances.

    \n
    \n
    DELETE
    \n
    \n

    Deletes a stack instance in the stack set represented by the provisioned product.

    \n
    \n
    " } }, - "StackSetFailureToleranceCount": { - "target": "com.amazonaws.servicecatalog#StackSetFailureToleranceCount", + "StackSetRegions": { + "target": "com.amazonaws.servicecatalog#StackSetRegions", "traits": { - "smithy.api#documentation": "

    The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    \n

    The default value is 0 if no value is specified.

    " + "smithy.api#documentation": "

    One or more AWS Regions where the provisioned product will be available.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

    \n

    If no values are specified, the default value is all regions from the STACKSET constraint.

    " } }, "StackSetFailureTolerancePercentage": { @@ -9379,12 +9530,6 @@ "traits": { "smithy.api#documentation": "

    The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    \n

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    " } - }, - "StackSetMaxConcurrencyPercentage": { - "target": "com.amazonaws.servicecatalog#StackSetMaxConcurrencyPercentage", - "traits": { - "smithy.api#documentation": "

    The maximum percentage of accounts in which to perform this operation at one time.

    \n

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

    \n

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    \n

    Applicable only to a CFN_STACKSET provisioned product type.

    \n

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " - } } }, "traits": { @@ -9414,35 +9559,35 @@ "com.amazonaws.servicecatalog#UpdateServiceActionInput": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.servicecatalog#ServiceActionName", - "traits": { - "smithy.api#documentation": "

    The self-service action name.

    " - } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " - } - }, "Description": { "target": "com.amazonaws.servicecatalog#ServiceActionDescription", "traits": { "smithy.api#documentation": "

    The self-service action description.

    " } }, + "Id": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

    The self-service action identifier.

    ", + "smithy.api#required": {} + } + }, "Definition": { "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionMap", "traits": { "smithy.api#documentation": "

    A map that defines the self-service action.

    " } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "Name": { + "target": "com.amazonaws.servicecatalog#ServiceActionName", "traits": { - "smithy.api#documentation": "

    The self-service action identifier.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The self-service action name.

    " + } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

    The language code.

    \n
      \n
    • \n

      \n en - English (default)

      \n
      • \n
    • \n

      \n jp - Japanese

      \n
      • \n
    • \n

      \n zh - Chinese

      \n
      • \n
    " } } } @@ -9487,6 +9632,12 @@ "com.amazonaws.servicecatalog#UpdateTagOptionInput": { "type": "structure", "members": { + "Active": { + "target": "com.amazonaws.servicecatalog#TagOptionActive", + "traits": { + "smithy.api#documentation": "

    The updated active state.

    " + } + }, "Id": { "target": "com.amazonaws.servicecatalog#TagOptionId", "traits": { @@ -9494,12 +9645,6 @@ "smithy.api#required": {} } }, - "Active": { - "target": "com.amazonaws.servicecatalog#TagOptionActive", - "traits": { - "smithy.api#documentation": "

    The updated active state.

    " - } - }, "Value": { "target": "com.amazonaws.servicecatalog#TagOptionValue", "traits": { @@ -9525,17 +9670,17 @@ "com.amazonaws.servicecatalog#UsageInstruction": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.servicecatalog#InstructionValue", - "traits": { - "smithy.api#documentation": "

    The usage instruction value for this type.

    " - } - }, "Type": { "target": "com.amazonaws.servicecatalog#InstructionType", "traits": { "smithy.api#documentation": "

    The usage instruction type for the value.

    " } + }, + "Value": { + "target": "com.amazonaws.servicecatalog#InstructionValue", + "traits": { + "smithy.api#documentation": "

    The usage instruction value for this type.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/service-quotas.2019-06-24.json b/codegen/sdk-codegen/aws-models/service-quotas.2019-06-24.json index e2d0b35fb149..f3f4d4e5682e 100644 --- a/codegen/sdk-codegen/aws-models/service-quotas.2019-06-24.json +++ b/codegen/sdk-codegen/aws-models/service-quotas.2019-06-24.json @@ -161,6 +161,13 @@ "com.amazonaws.servicequotas#DeleteServiceQuotaIncreaseRequestFromTemplateRequest": { "type": "structure", "members": { + "AwsRegion": { + "target": "com.amazonaws.servicequotas#AwsRegion", + "traits": { + "smithy.api#documentation": "

    Specifies the AWS Region for the quota that you want to delete.

    ", + "smithy.api#required": {} + } + }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { @@ -174,13 +181,6 @@ "smithy.api#documentation": "

    Specifies the code for the service that you want to delete.

    ", "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#required": {} - } } } }, @@ -328,17 +328,17 @@ "com.amazonaws.servicequotas#GetAWSDefaultServiceQuotaRequest": { "type": "structure", "members": { - "QuotaCode": { - "target": "com.amazonaws.servicequotas#QuotaCode", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

    Identifies the service quota you want to select.

    ", + "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", "smithy.api#required": {} } }, - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "QuotaCode": { + "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", + "smithy.api#documentation": "

    Identifies the service quota you want to select.

    ", "smithy.api#required": {} } } @@ -570,17 +570,17 @@ "com.amazonaws.servicequotas#GetServiceQuotaRequest": { "type": "structure", "members": { - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "QuotaCode": { + "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", + "smithy.api#documentation": "

    Identifies the service quota you want to select.

    ", "smithy.api#required": {} } }, - "QuotaCode": { - "target": "com.amazonaws.servicequotas#QuotaCode", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

    Identifies the service quota you want to select.

    ", + "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", "smithy.api#required": {} } } @@ -680,10 +680,11 @@ "com.amazonaws.servicequotas#ListAWSDefaultServiceQuotasRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.servicequotas#MaxResults", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "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": "

    Specifies the service that you want to use.

    ", + "smithy.api#required": {} } }, "NextToken": { @@ -692,11 +693,10 @@ "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.

    " } }, - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "MaxResults": { + "target": "com.amazonaws.servicequotas#MaxResults", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", - "smithy.api#required": {} + "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.

    " } } } @@ -797,11 +797,16 @@ "com.amazonaws.servicequotas#ListRequestedServiceQuotaChangeHistoryByQuotaRequest": { "type": "structure", "members": { - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "NextToken": { + "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", - "smithy.api#required": {} + "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.

    " + } + }, + "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.

    " } }, "Status": { @@ -817,16 +822,11 @@ "smithy.api#required": {} } }, - "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.

    " - } - }, - "NextToken": { - "target": "com.amazonaws.servicequotas#NextToken", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "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": "

    Specifies the service that you want to use.

    ", + "smithy.api#required": {} } } } @@ -857,6 +857,12 @@ "smithy.api#documentation": "

    Specifies the status value of the quota increase request.

    " } }, + "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.

    " + } + }, "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { @@ -868,29 +874,23 @@ "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.

    " } - }, - "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.

    " - } } } }, "com.amazonaws.servicequotas#ListRequestedServiceQuotaChangeHistoryResponse": { "type": "structure", "members": { - "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).

    " - } - }, "RequestedQuotas": { "target": "com.amazonaws.servicequotas#RequestedServiceQuotaChangeHistoryListDefinition", "traits": { "smithy.api#documentation": "

    Returns a list of service quota 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).

    " + } } } }, @@ -941,18 +941,6 @@ "com.amazonaws.servicequotas#ListServiceQuotaIncreaseRequestsInTemplateRequest": { "type": "structure", "members": { - "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.

    " - } - }, - "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.

    " - } - }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { @@ -964,6 +952,18 @@ "traits": { "smithy.api#documentation": "

    The identifier for a service. When performing an operation, use the\n ServiceCode to specify a particular service.

    " } + }, + "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.

    " + } + }, + "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.

    " + } } } }, @@ -1031,18 +1031,18 @@ "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.

    " } }, + "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.

    " + } + }, "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#required": {} } - }, - "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.

    " - } } } }, @@ -1118,17 +1118,17 @@ "com.amazonaws.servicequotas#ListServicesResponse": { "type": "structure", "members": { - "Services": { - "target": "com.amazonaws.servicequotas#ServiceInfoListDefinition", - "traits": { - "smithy.api#documentation": "

    Returns a list of services.

    " - } - }, "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).

    " } + }, + "Services": { + "target": "com.amazonaws.servicequotas#ServiceInfoListDefinition", + "traits": { + "smithy.api#documentation": "

    Returns a list of services.

    " + } } } }, @@ -1178,17 +1178,17 @@ "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.

    " } }, - "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.

    " - } - }, "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.

    " } + }, + "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.

    " + } } }, "traits": { @@ -1332,31 +1332,31 @@ "com.amazonaws.servicequotas#PutServiceQuotaIncreaseRequestIntoTemplateRequest": { "type": "structure", "members": { - "DesiredValue": { - "target": "com.amazonaws.servicequotas#QuotaValue", + "QuotaCode": { + "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

    Specifies the new, increased value for the quota.

    ", + "smithy.api#documentation": "

    Specifies the service quota that you want to use.

    ", "smithy.api#required": {} } }, - "AwsRegion": { - "target": "com.amazonaws.servicequotas#AwsRegion", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

    Specifies the AWS Region for the quota.

    ", + "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", "smithy.api#required": {} } }, - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "AwsRegion": { + "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", + "smithy.api#documentation": "

    Specifies the AWS Region for the quota.

    ", "smithy.api#required": {} } }, - "QuotaCode": { - "target": "com.amazonaws.servicequotas#QuotaCode", + "DesiredValue": { + "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

    Specifies the service quota that you want to use.

    ", + "smithy.api#documentation": "

    Specifies the new, increased value for the quota.

    ", "smithy.api#required": {} } } @@ -1414,17 +1414,17 @@ "com.amazonaws.servicequotas#QuotaPeriod": { "type": "structure", "members": { - "PeriodUnit": { - "target": "com.amazonaws.servicequotas#PeriodUnit", - "traits": { - "smithy.api#documentation": "

    The time unit of a period.

    " - } - }, "PeriodValue": { "target": "com.amazonaws.servicequotas#PeriodValue", "traits": { "smithy.api#documentation": "

    The value of a period.

    " } + }, + "PeriodUnit": { + "target": "com.amazonaws.servicequotas#PeriodUnit", + "traits": { + "smithy.api#documentation": "

    The time unit of a period.

    " + } } }, "traits": { @@ -1505,17 +1505,17 @@ "smithy.api#required": {} } }, - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "QuotaCode": { + "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", + "smithy.api#documentation": "

    Specifies the service quota that you want to use.

    ", "smithy.api#required": {} } }, - "QuotaCode": { - "target": "com.amazonaws.servicequotas#QuotaCode", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

    Specifies the service quota that you want to use.

    ", + "smithy.api#documentation": "

    Specifies the service that you want to use.

    ", "smithy.api#required": {} } } @@ -1562,76 +1562,76 @@ "com.amazonaws.servicequotas#RequestedServiceQuotaChange": { "type": "structure", "members": { - "Requester": { - "target": "com.amazonaws.servicequotas#Requester", + "Created": { + "target": "com.amazonaws.servicequotas#DateTime", "traits": { - "smithy.api#documentation": "

    The IAM identity who submitted the service quota increase request.

    " + "smithy.api#documentation": "

    The date and time when the service quota increase request was received and the case Id was\n created.

    " } }, - "ServiceName": { - "target": "com.amazonaws.servicequotas#ServiceName", + "Id": { + "target": "com.amazonaws.servicequotas#RequestId", "traits": { - "smithy.api#documentation": "

    The name of the AWS service specified in the increase request.

    " + "smithy.api#documentation": "

    The unique identifier of a requested service quota change.

    " } }, - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "Unit": { + "target": "com.amazonaws.servicequotas#QuotaUnit", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    " + "smithy.api#documentation": "

    Specifies the unit used for the quota.

    " } }, - "QuotaName": { - "target": "com.amazonaws.servicequotas#QuotaName", + "QuotaCode": { + "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

    Name of the service quota.

    " + "smithy.api#documentation": "

    Specifies the service quota that you want to use.

    " } }, - "QuotaArn": { - "target": "com.amazonaws.servicequotas#QuotaArn", + "DesiredValue": { + "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the service quota.

    " + "smithy.api#documentation": "

    New increased value for the service quota.

    " } }, - "Id": { - "target": "com.amazonaws.servicequotas#RequestId", + "GlobalQuota": { + "target": "com.amazonaws.servicequotas#GlobalQuota", "traits": { - "smithy.api#documentation": "

    The unique identifier of a requested service quota change.

    " + "smithy.api#documentation": "

    Identifies if the quota is global.

    " } }, - "DesiredValue": { - "target": "com.amazonaws.servicequotas#QuotaValue", + "ServiceName": { + "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "

    New increased value for the service quota.

    " + "smithy.api#documentation": "

    The name of the AWS service specified in the increase request.

    " } }, - "Unit": { - "target": "com.amazonaws.servicequotas#QuotaUnit", + "QuotaArn": { + "target": "com.amazonaws.servicequotas#QuotaArn", "traits": { - "smithy.api#documentation": "

    Specifies the unit used for the quota.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the service quota.

    " } }, - "Status": { - "target": "com.amazonaws.servicequotas#RequestStatus", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

    State of the service quota increase request.

    " + "smithy.api#documentation": "

    Specifies the service that you want to use.

    " } }, - "Created": { - "target": "com.amazonaws.servicequotas#DateTime", + "QuotaName": { + "target": "com.amazonaws.servicequotas#QuotaName", "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": "

    Name of the service quota.

    " } }, - "QuotaCode": { - "target": "com.amazonaws.servicequotas#QuotaCode", + "Requester": { + "target": "com.amazonaws.servicequotas#Requester", "traits": { - "smithy.api#documentation": "

    Specifies the service quota that you want to use.

    " + "smithy.api#documentation": "

    The IAM identity who submitted the service quota increase request.

    " } }, - "GlobalQuota": { - "target": "com.amazonaws.servicequotas#GlobalQuota", + "CaseId": { + "target": "com.amazonaws.servicequotas#CustomerServiceEngagementId", "traits": { - "smithy.api#documentation": "

    Identifies if the quota is global.

    " + "smithy.api#documentation": "

    The case Id for the service quota increase request.

    " } }, "LastUpdated": { @@ -1640,10 +1640,10 @@ "smithy.api#documentation": "

    The date and time of the most recent change in the service quota increase request.

    " } }, - "CaseId": { - "target": "com.amazonaws.servicequotas#CustomerServiceEngagementId", + "Status": { + "target": "com.amazonaws.servicequotas#RequestStatus", "traits": { - "smithy.api#documentation": "

    The case Id for the service quota increase request.

    " + "smithy.api#documentation": "

    State of the service quota increase request.

    " } } }, @@ -1699,17 +1699,17 @@ "com.amazonaws.servicequotas#ServiceInfo": { "type": "structure", "members": { - "ServiceName": { - "target": "com.amazonaws.servicequotas#ServiceName", - "traits": { - "smithy.api#documentation": "

    The name of the AWS service specified in the increase request.

    " - } - }, "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { "smithy.api#documentation": "

    Specifies the service that you want to use.

    " } + }, + "ServiceName": { + "target": "com.amazonaws.servicequotas#ServiceName", + "traits": { + "smithy.api#documentation": "

    The name of the AWS service specified in the increase request.

    " + } } }, "traits": { @@ -1728,76 +1728,76 @@ "com.amazonaws.servicequotas#ServiceQuota": { "type": "structure", "members": { - "Unit": { - "target": "com.amazonaws.servicequotas#QuotaUnit", + "QuotaName": { + "target": "com.amazonaws.servicequotas#QuotaName", "traits": { - "smithy.api#documentation": "

    The unit of measurement for the value of the service quota.

    " + "smithy.api#documentation": "

    The name identifier of the service quota.

    " } }, - "Adjustable": { - "target": "com.amazonaws.servicequotas#QuotaAdjustable", + "ServiceCode": { + "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

    Specifies if the quota value can be increased.

    " + "smithy.api#documentation": "

    Specifies the service that you want to use.

    " } }, - "Value": { - "target": "com.amazonaws.servicequotas#QuotaValue", + "Unit": { + "target": "com.amazonaws.servicequotas#QuotaUnit", "traits": { - "smithy.api#documentation": "

    The value of service quota.

    " + "smithy.api#documentation": "

    The unit of measurement for the value of the service quota.

    " } }, - "QuotaCode": { - "target": "com.amazonaws.servicequotas#QuotaCode", + "QuotaArn": { + "target": "com.amazonaws.servicequotas#QuotaArn", "traits": { - "smithy.api#documentation": "

    The code identifier for the service quota specified.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the service quota.

    " } }, - "GlobalQuota": { - "target": "com.amazonaws.servicequotas#GlobalQuota", + "UsageMetric": { + "target": "com.amazonaws.servicequotas#MetricInfo", "traits": { - "smithy.api#documentation": "

    Specifies if the quota is global.

    " + "smithy.api#documentation": "

    Specifies the details about the measurement.

    " } }, - "Period": { - "target": "com.amazonaws.servicequotas#QuotaPeriod", + "ServiceName": { + "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "

    Identifies the unit and value of how time is measured.

    " + "smithy.api#documentation": "

    The name of the AWS service specified in the increase request.

    " } }, - "ErrorReason": { - "target": "com.amazonaws.servicequotas#ErrorReason", + "Period": { + "target": "com.amazonaws.servicequotas#QuotaPeriod", "traits": { - "smithy.api#documentation": "

    Specifies the ErrorCode and ErrorMessage when success isn't\n achieved.

    " + "smithy.api#documentation": "

    Identifies the unit and value of how time is measured.

    " } }, - "ServiceName": { - "target": "com.amazonaws.servicequotas#ServiceName", + "QuotaCode": { + "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

    The name of the AWS service specified in the increase request.

    " + "smithy.api#documentation": "

    The code identifier for the service quota specified.

    " } }, - "QuotaArn": { - "target": "com.amazonaws.servicequotas#QuotaArn", + "Value": { + "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the service quota.

    " + "smithy.api#documentation": "

    The value of service quota.

    " } }, - "ServiceCode": { - "target": "com.amazonaws.servicequotas#ServiceCode", + "ErrorReason": { + "target": "com.amazonaws.servicequotas#ErrorReason", "traits": { - "smithy.api#documentation": "

    Specifies the service that you want to use.

    " + "smithy.api#documentation": "

    Specifies the ErrorCode and ErrorMessage when success isn't\n achieved.

    " } }, - "UsageMetric": { - "target": "com.amazonaws.servicequotas#MetricInfo", + "GlobalQuota": { + "target": "com.amazonaws.servicequotas#GlobalQuota", "traits": { - "smithy.api#documentation": "

    Specifies the details about the measurement.

    " + "smithy.api#documentation": "

    Specifies if the quota is global.

    " } }, - "QuotaName": { - "target": "com.amazonaws.servicequotas#QuotaName", + "Adjustable": { + "target": "com.amazonaws.servicequotas#QuotaAdjustable", "traits": { - "smithy.api#documentation": "

    The name identifier of the service quota.

    " + "smithy.api#documentation": "

    Specifies if the quota value can be increased.

    " } } }, @@ -1820,22 +1820,16 @@ "smithy.api#documentation": "

    Specifies if the quota is a global quota.

    " } }, - "AwsRegion": { - "target": "com.amazonaws.servicequotas#AwsRegion", - "traits": { - "smithy.api#documentation": "

    The AWS Region where the increase request occurs.

    " - } - }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { "smithy.api#documentation": "

    The name of the AWS service specified in the increase request.

    " } }, - "DesiredValue": { - "target": "com.amazonaws.servicequotas#QuotaValue", + "AwsRegion": { + "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "

    Identifies the new, increased value of the service quota in the increase request.

    " + "smithy.api#documentation": "

    The AWS Region where the increase request occurs.

    " } }, "ServiceCode": { @@ -1855,6 +1849,12 @@ "traits": { "smithy.api#documentation": "

    The unit of measure for the increase request.

    " } + }, + "DesiredValue": { + "target": "com.amazonaws.servicequotas#QuotaValue", + "traits": { + "smithy.api#documentation": "

    Identifies the new, increased value of the service quota in the increase request.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json b/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json index f4d904fea13e..ffa05ec2d0a6 100644 --- a/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json +++ b/codegen/sdk-codegen/aws-models/servicediscovery.2017-03-14.json @@ -105,18 +105,12 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a\n DiscoverInstances request but can't be discovered using DNS.

    \n

    For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the\n AWS Cloud Map Developer Guide.

    " + "smithy.api#documentation": "

    Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a\n DiscoverInstances request but can't be discovered using DNS.

    \n

    For the current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map quotas in the\n AWS Cloud Map Developer Guide.

    " } }, "com.amazonaws.servicediscovery#CreateHttpNamespaceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.servicediscovery#TagList", - "traits": { - "smithy.api#documentation": "

    The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum\n length of 256 characters.

    " - } - }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { @@ -136,6 +130,12 @@ "smithy.api#documentation": "

    The name that you want to assign to this namespace.

    ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.servicediscovery#TagList", + "traits": { + "smithy.api#documentation": "

    The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum\n length of 256 characters.

    " + } } } }, @@ -176,30 +176,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The\n namespace defines your service naming scheme. For example, if you name your namespace example.com and\n name your service backend, the resulting DNS name for the service will be\n backend.example.com. For the current limit on the number of namespaces that you can create using the\n same AWS account, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

    " + "smithy.api#documentation": "

    Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The\n namespace defines your service naming scheme. For example, if you name your namespace example.com and\n name your service backend, the resulting DNS name for the service will be\n backend.example.com. For the current quota on the number of namespaces that you can create using the\n same AWS account, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

    " } }, "com.amazonaws.servicediscovery#CreatePrivateDnsNamespaceRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.servicediscovery#NamespaceName", + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

    The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A description for the namespace.

    " } }, - "Vpc": { + "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the Amazon VPC that you want to associate the namespace with.

    ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.servicediscovery#ResourceDescription", - "traits": { - "smithy.api#documentation": "

    A description for the namespace.

    " + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace\n requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any\n unique string, for example, a date/time stamp.

    ", + "smithy.api#idempotencyToken": {} } }, "Tags": { @@ -208,11 +201,18 @@ "smithy.api#documentation": "

    The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum\n length of 256 characters.

    " } }, - "CreatorRequestId": { + "Name": { + "target": "com.amazonaws.servicediscovery#NamespaceName", + "traits": { + "smithy.api#documentation": "

    The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

    ", + "smithy.api#required": {} + } + }, + "Vpc": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace\n requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any\n unique string, for example, a date/time stamp.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    The ID of the Amazon VPC that you want to associate the namespace with.

    ", + "smithy.api#required": {} } } } @@ -254,18 +254,12 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your\n service naming scheme. For example, if you name your namespace example.com and name your service\n backend, the resulting DNS name for the service will be backend.example.com. For the\n current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the\n AWS Cloud Map Developer Guide.

    " + "smithy.api#documentation": "

    Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your\n service naming scheme. For example, if you name your namespace example.com and name your service\n backend, the resulting DNS name for the service will be backend.example.com. For the\n current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the\n AWS Cloud Map Developer Guide.

    " } }, "com.amazonaws.servicediscovery#CreatePublicDnsNamespaceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.servicediscovery#TagList", - "traits": { - "smithy.api#documentation": "

    The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum\n length of 256 characters.

    " - } - }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { @@ -285,6 +279,12 @@ "smithy.api#documentation": "

    The name that you want to assign to this namespace.

    ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.servicediscovery#TagList", + "traits": { + "smithy.api#documentation": "

    The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum\n length of 256 characters.

    " + } } } }, @@ -325,60 +325,60 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a service, which defines the configuration for the following entities:

    \n
      \n
    • \n

      For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

      \n
        \n
      • \n

        A

        \n
        • \n
      • \n

        AAAA

        \n
        • \n
      • \n

        A and AAAA

        \n
        • \n
      • \n

        SRV

        \n
        • \n
      • \n

        CNAME

        \n
        • \n
      \n
      • \n
    • \n

      Optionally, a health check

      \n
      • \n
    \n

    After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the\n values in the configuration to create the specified entities.

    \n

    For the current limit on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

    " + "smithy.api#documentation": "

    Creates a service, which defines the configuration for the following entities:

    \n
      \n
    • \n

      For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

      \n
        \n
      • \n

        \n A\n

        \n
        • \n
      • \n

        \n AAAA\n

        \n
        • \n
      • \n

        \n A and AAAA\n

        \n
        • \n
      • \n

        \n SRV\n

        \n
        • \n
      • \n

        \n CNAME\n

        \n
        • \n
      \n
      • \n
    • \n

      Optionally, a health check

      \n
      • \n
    \n

    After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the\n values in the configuration to create the specified entities.

    \n

    For the current quota on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

    " } }, "com.amazonaws.servicediscovery#CreateServiceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.servicediscovery#TagList", + "Name": { + "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "

    The tags to add to the service. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum\n length of 256 characters.

    " + "smithy.api#documentation": "

    The name that you want to assign to the service.

    \n

    If you want AWS Cloud Map to create an SRV record when you register an instance, and if you're using a\n system that requires a specific SRV format, such as HAProxy, specify the following for Name:

    \n
      \n
    • \n

      Start the name with an underscore (_), such as _exampleservice\n

      \n
      • \n
    • \n

      End the name with ._protocol, such as ._tcp\n

      \n
      • \n
    \n

    When you register an instance, AWS Cloud Map creates an SRV record and assigns a name to the record by\n concatenating the service name and the namespace name, for example:

    \n

    \n _exampleservice._tcp.example.com\n

    ", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.servicediscovery#ResourceDescription", + "CreatorRequestId": { + "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    A description for the service.

    " + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed CreateService requests to be\n retried without the risk of executing the operation twice. CreatorRequestId can be any unique string,\n for example, a date/time stamp.

    ", + "smithy.api#idempotencyToken": {} } }, - "DnsConfig": { - "target": "com.amazonaws.servicediscovery#DnsConfig", + "NamespaceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you\n register an instance.

    " + "smithy.api#documentation": "

    The ID of the namespace that you want to use to create the service.

    " } }, - "HealthCheckCustomConfig": { - "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", + "HealthCheckConfig": { + "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

    A complex type that contains information about an optional custom health check.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     \n

    You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing\n service.

    " + "smithy.api#documentation": "

    \n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the\n Route 53 DNS records that you specify in DnsConfig.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     \n

    For information about the charges for health checks, see AWS Cloud Map Pricing.

    " } }, - "Name": { - "target": "com.amazonaws.servicediscovery#ServiceName", + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

    The name that you want to assign to the service.

    \n

    If you want AWS Cloud Map to create an SRV record when you register an instance, and if you're using a system that\n requires a specific SRV format, such as HAProxy, specify the following\n for Name:

    \n
      \n
    • \n

      Start the name with an underscore (_), such as _exampleservice\n

      \n
      • \n
    • \n

      End the name with ._protocol, such as ._tcp\n

      \n
      • \n
    \n

    When you register an instance, AWS Cloud Map creates an SRV record and assigns a name to the record by\n concatenating the service name and the namespace name, for example:

    \n

    \n _exampleservice._tcp.example.com\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A description for the service.

    " } }, - "NamespaceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "Tags": { + "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

    The ID of the namespace that you want to use to create the service.

    " + "smithy.api#documentation": "

    The tags to add to the service. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum\n length of 256 characters.

    " } }, - "HealthCheckConfig": { - "target": "com.amazonaws.servicediscovery#HealthCheckConfig", + "HealthCheckCustomConfig": { + "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "

    \n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the\n Route 53 DNS records that you specify in DnsConfig.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     \n

    For information about the charges for health checks, see AWS Cloud Map Pricing.

    " + "smithy.api#documentation": "

    A complex type that contains information about an optional custom health check.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     \n

    You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing\n service.

    " } }, - "CreatorRequestId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "DnsConfig": { + "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed CreateService requests to be\n retried without the risk of executing the operation twice. CreatorRequestId can be any unique string,\n for example, a date/time stamp.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you\n register an instance.

    " } } } @@ -536,23 +536,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified\n instance.

    " + "smithy.api#documentation": "

    Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified\n instance.

    " } }, "com.amazonaws.servicediscovery#DeregisterInstanceRequest": { "type": "structure", "members": { - "InstanceId": { + "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The value that you specified for Id in the RegisterInstance request.

    ", + "smithy.api#documentation": "

    The ID of the service that the instance is associated with.

    ", "smithy.api#required": {} } }, - "ServiceId": { + "InstanceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the service that the instance is associated with.

    ", + "smithy.api#documentation": "

    The value that you specified for Id in the RegisterInstance request.

    ", "smithy.api#required": {} } } @@ -601,6 +601,12 @@ "com.amazonaws.servicediscovery#DiscoverInstancesRequest": { "type": "structure", "members": { + "QueryParameters": { + "target": "com.amazonaws.servicediscovery#Attributes", + "traits": { + "smithy.api#documentation": "

    Filters to scope the results based on custom attributes for the instance. For example, {version=v1,\n az=1a}. Only instances that match all the specified key-value pairs will be returned.

    " + } + }, "HealthStatus": { "target": "com.amazonaws.servicediscovery#HealthStatusFilter", "traits": { @@ -620,18 +626,18 @@ "smithy.api#documentation": "

    The maximum number of instances that you want AWS Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 instances.

    " } }, + "OptionalParameters": { + "target": "com.amazonaws.servicediscovery#Attributes", + "traits": { + "smithy.api#documentation": "

    Opportunistic filters to scope the results based on custom attributes. If there are instances that match\n both the filters specified in both the QueryParameters parameter and this parameter, they are\n returned. Otherwise, these filters are ignored and only instances that match the filters specified in the\n QueryParameters parameter are returned.

    " + } + }, "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { "smithy.api#documentation": "

    The name of the namespace that you specified when you registered the instance.

    ", "smithy.api#required": {} } - }, - "QueryParameters": { - "target": "com.amazonaws.servicediscovery#Attributes", - "traits": { - "smithy.api#documentation": "

    A string map that contains attributes with values that you can use to filter instances by any custom attribute\n that you specified when you registered the instance. Only instances that match all the specified key/value pairs will\n be returned.

    " - } } } }, @@ -659,10 +665,11 @@ "com.amazonaws.servicediscovery#DnsConfig": { "type": "structure", "members": { - "RoutingPolicy": { - "target": "com.amazonaws.servicediscovery#RoutingPolicy", + "DnsRecords": { + "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { - "smithy.api#documentation": "

    The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an\n instance and specify this service.

    \n \n

    If you want to use this service to register instances that create alias records, specify WEIGHTED\n for the routing policy.

    \n     \n

    You can specify the following values:

    \n

    \n MULTIVALUE\n

    \n

    If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value\n for up to eight instances.

    \n

    For example, suppose the service includes configurations for one A record and a health check, and you use the\n service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances.\n If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the\n healthy instances.

    \n

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the\n values for up to eight instances.

    \n

    For more information about the multivalue routing policy, see Multivalue Answer Routing\n in the Route 53 Developer Guide.

    \n

    \n WEIGHTED\n

    \n

    Route 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or less\n traffic to any instances.

    \n

    For example, suppose the service includes configurations for one A record and a health check, and you use the\n service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected\n instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of\n the instances were healthy.

    \n

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the\n applicable value for one randomly selected instance.

    \n

    For more information about the weighted routing policy, see Weighted Routing in the\n Route 53 Developer Guide.

    " + "smithy.api#documentation": "

    An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to\n create when you register an instance.

    ", + "smithy.api#required": {} } }, "NamespaceId": { @@ -674,16 +681,15 @@ "smithy.api#documentation": "

    The ID of the namespace to use for DNS configuration.

    " } }, - "DnsRecords": { - "target": "com.amazonaws.servicediscovery#DnsRecordList", + "RoutingPolicy": { + "target": "com.amazonaws.servicediscovery#RoutingPolicy", "traits": { - "smithy.api#documentation": "

    An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to\n create when you register an instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an\n instance and specify this service.

    \n \n

    If you want to use this service to register instances that create alias records, specify WEIGHTED\n for the routing policy.

    \n     \n

    You can specify the following values:

    \n

    \n MULTIVALUE\n

    \n

    If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value\n for up to eight instances.

    \n

    For example, suppose the service includes configurations for one A record and a health check, and\n you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy\n instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all\n of the healthy instances.

    \n

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the\n values for up to eight instances.

    \n

    For more information about the multivalue routing policy, see Multivalue Answer Routing\n in the Route 53 Developer Guide.

    \n

    \n WEIGHTED\n

    \n

    Route 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or less\n traffic to any instances.

    \n

    For example, suppose the service includes configurations for one A record and a health check, and\n you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly\n selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if\n all of the instances were healthy.

    \n

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the\n applicable value for one randomly selected instance.

    \n

    For more information about the weighted routing policy, see Weighted Routing in the\n Route 53 Developer Guide.

    " } } }, "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when\n you register an instance.

    " + "smithy.api#documentation": "

    A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when\n you register an instance.

    " } }, "com.amazonaws.servicediscovery#DnsConfigChange": { @@ -692,13 +698,13 @@ "DnsRecords": { "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { - "smithy.api#documentation": "

    An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to\n create when you register an instance.

    ", + "smithy.api#documentation": "

    An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to\n create when you register an instance.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you\n register an instance.

    " + "smithy.api#documentation": "

    A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you\n register an instance.

    " } }, "com.amazonaws.servicediscovery#DnsProperties": { @@ -707,34 +713,34 @@ "HostedZoneId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

    " + "smithy.api#documentation": "

    The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

    " } } }, "traits": { - "smithy.api#documentation": "

    A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.

    " + "smithy.api#documentation": "

    A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.

    " } }, "com.amazonaws.servicediscovery#DnsRecord": { "type": "structure", "members": { - "TTL": { - "target": "com.amazonaws.servicediscovery#RecordTTL", + "Type": { + "target": "com.amazonaws.servicediscovery#RecordType", "traits": { - "smithy.api#documentation": "

    The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

    \n \n

    Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes\n traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the\n TTL value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.

    \n     ", + "smithy.api#documentation": "

    The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You\n can specify values for Type in the following combinations:

    \n
      \n
    • \n

      \n A\n

      \n
      • \n
    • \n

      \n AAAA\n

      \n
      • \n
    • \n

      \n A and AAAA\n

      \n
      • \n
    • \n

      \n SRV\n

      \n
      • \n
    • \n

      \n CNAME\n

      \n
      • \n
    \n

    If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or\n AAAA for Type.

    \n

    You specify other settings, such as the IP address for A and AAAA records, when you\n register an instance. For more information, see RegisterInstance.

    \n

    The following values are supported:

    \n

    \n A\n \n \n \n

    \n

    Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

    \n

    \n AAAA\n \n \n \n

    \n

    Route 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    \n

    \n CNAME\n \n \n \n

    \n

    Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

    \n
      \n
    • \n

      You specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.

      \n
      • \n
    • \n

      You must specify WEIGHTED for the value of RoutingPolicy.

      \n
      • \n
    • \n

      You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

      \n
      • \n
    \n

    \n SRV\n

    \n

    Route 53 returns the value for an SRV record. The value for an SRV record uses the\n following values:

    \n

    \n priority weight port service-hostname\n

    \n

    Note the following about the values:

    \n
      \n
    • \n

      The values of priority and weight are both set to 1 and can't be\n changed.

      \n
      • \n
    • \n

      The value of port comes from the value that you specify for the AWS_INSTANCE_PORT\n attribute when you submit a RegisterInstance request.

      \n
      • \n
    • \n

      The value of service-hostname is a concatenation of the following values:

      \n
        \n
      • \n

        The value that you specify for InstanceId when you register an instance.

        \n
        • \n
      • \n

        The name of the service.

        \n
        • \n
      • \n

        The name of the namespace.

        \n
        • \n
      \n

      For example, if the value of InstanceId is test, the name of the service is\n backend, and the name of the namespace is example.com, the value of\n service-hostname is:

      \n

      \n test.backend.example.com\n

      \n
      • \n
    \n

    If you specify settings for an SRV record, note the following:

    \n
      \n
    • \n

      If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the\n RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA\n records that have the same name as the value of service-hostname in the SRV record. You\n can ignore these records.

      \n
      • \n
    • \n

      If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify\n the correct name format.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.servicediscovery#RecordType", + "TTL": { + "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "

    The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You\n can specify values for Type in the following combinations:

    \n
      \n
    • \n

      A

      \n
      • \n
    • \n

      AAAA

      \n
      • \n
    • \n

      A and AAAA

      \n
      • \n
    • \n

      SRV

      \n
      • \n
    • \n

      CNAME

      \n
      • \n
    \n

    If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or\n AAAA for Type.

    \n

    You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For\n more information, see RegisterInstance.

    \n

    The following values are supported:

    \n

    \n A\n

    \n

    Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

    \n

    \n AAAA\n

    \n

    Route 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    \n

    \n CNAME\n

    \n

    Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

    \n
      \n
    • \n

      You specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.

      \n
      • \n
    • \n

      You must specify WEIGHTED for the value of RoutingPolicy.

      \n
      • \n
    • \n

      You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

      \n
      • \n
    \n

    \n SRV\n

    \n

    Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

    \n

    \n priority weight port service-hostname\n

    \n

    Note the following about the values:

    \n
      \n
    • \n

      The values of priority and weight are both set to 1 and can't be\n changed.

      \n
      • \n
    • \n

      The value of port comes from the value that you specify for the AWS_INSTANCE_PORT\n attribute when you submit a RegisterInstance request.

      \n
      • \n
    • \n

      The value of service-hostname is a concatenation of the following values:

      \n
        \n
      • \n

        The value that you specify for InstanceId when you register an instance.

        \n
        • \n
      • \n

        The name of the service.

        \n
        • \n
      • \n

        The name of the namespace.

        \n
        • \n
      \n

      For example, if the value of InstanceId is test, the name of the service is\n backend, and the name of the namespace is example.com, the value of\n service-hostname is:

      \n

      \n test.backend.example.com\n

      \n
      • \n
    \n

    If you specify settings for an SRV record, note the following:

    \n
      \n
    • \n

      If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the\n RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA\n records that have the same name as the value of service-hostname in the SRV record. You can ignore\n these records.

      \n
      • \n
    • \n

      If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify\n the correct name format.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

    \n \n

    Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes\n traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the\n TTL value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.

    \n     ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

    " + "smithy.api#documentation": "

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

    " } }, "com.amazonaws.servicediscovery#DnsRecordList": { @@ -838,17 +844,17 @@ "com.amazonaws.servicediscovery#GetInstanceRequest": { "type": "structure", "members": { - "ServiceId": { + "InstanceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the service that the instance is associated with.

    ", + "smithy.api#documentation": "

    The ID of the instance that you want to get information about.

    ", "smithy.api#required": {} } }, - "InstanceId": { + "ServiceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the instance that you want to get information about.

    ", + "smithy.api#documentation": "

    The ID of the service that the instance is associated with.

    ", "smithy.api#required": {} } } @@ -896,13 +902,6 @@ "com.amazonaws.servicediscovery#GetInstancesHealthStatusRequest": { "type": "structure", "members": { - "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the service that the instance is associated with.

    ", - "smithy.api#required": {} - } - }, "Instances": { "target": "com.amazonaws.servicediscovery#InstanceIdList", "traits": { @@ -920,6 +919,13 @@ "traits": { "smithy.api#documentation": "

    The maximum number of instances that you want AWS Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map\n returns up to 100 instances.

    " } + }, + "ServiceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the service that the instance is associated with.

    ", + "smithy.api#required": {} + } } } }, @@ -1075,25 +1081,25 @@ "Type": { "target": "com.amazonaws.servicediscovery#HealthCheckType", "traits": { - "smithy.api#documentation": "

    The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is\n healthy.

    \n \n

    You can't change the value of Type after you create a health check.

    \n     \n

    You can create the following types of health checks:

    \n
      \n
    • \n

      \n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits\n an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

      \n
      • \n
    • \n

      \n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

      \n \n

      If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

      \n       \n
      • \n
    • \n

      \n TCP: Route 53 tries to establish a TCP connection.

      \n

      If you specify TCP for Type, don't specify a value for\n ResourcePath.

      \n
      • \n
    \n

    For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.

    ", + "smithy.api#documentation": "

    The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is\n healthy.

    \n \n

    You can't change the value of Type after you create a health check.

    \n     \n

    You can create the following types of health checks:

    \n
      \n
    • \n

      \n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits\n an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

      \n
      • \n
    • \n

      \n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

      \n \n

      If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

      \n       \n
      • \n
    • \n

      \n TCP: Route 53 tries to establish a TCP connection.

      \n

      If you specify TCP for Type, don't specify a value for\n ResourcePath.

      \n
      • \n
    \n

    For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.

    ", "smithy.api#required": {} } }, - "FailureThreshold": { - "target": "com.amazonaws.servicediscovery#FailureThreshold", + "ResourcePath": { + "target": "com.amazonaws.servicediscovery#ResourcePath", "traits": { - "smithy.api#documentation": "

    The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.

    " + "smithy.api#documentation": "

    The path that you want Route 53 to request when performing health checks. The path can be any value for which your\n endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file\n /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't\n specify a value for ResourcePath, the default value is /.

    \n

    If you specify TCP for Type, you must not specify a value for\n ResourcePath.

    " } }, - "ResourcePath": { - "target": "com.amazonaws.servicediscovery#ResourcePath", + "FailureThreshold": { + "target": "com.amazonaws.servicediscovery#FailureThreshold", "traits": { - "smithy.api#documentation": "

    The path that you want Route 53 to request when performing health checks. The path can be any value for which your\n endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file\n /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't\n specify a value for ResourcePath, the default value is /.

    \n

    If you specify TCP for Type, you must not specify a value for\n ResourcePath.

    " + "smithy.api#documentation": "

    The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.

    " } } }, "traits": { - "smithy.api#documentation": "

    \n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     \n

    Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.

    \n

    Note the following about configuring health checks.

    \n

    \n A and AAAA records\n

    \n

    If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check\n that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address\n is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

    \n

    \n CNAME records\n

    \n

    You can't specify settings for HealthCheckConfig when the DNSConfig includes\n CNAME for the value of Type. If you do, the CreateService request will fail\n with an InvalidInput error.

    \n

    \n Request interval\n

    \n

    A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30\n seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers\n don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with\n no health checks at all.

    \n

    \n Health checking regions\n

    \n

    Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see\n Regions.

    \n

    \n Alias records\n

    \n

    When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates\n a Route 53 alias record. Note the following:

    \n
      \n
    • \n

      Route 53 automatically sets EvaluateTargetHealth to true for alias records. When\n EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource.\n such as an ELB load balancer. For more information, see EvaluateTargetHealth.

      \n
      • \n
    • \n

      If you include HealthCheckConfig and then use the service to register an instance that creates an\n alias record, Route 53 doesn't create the health check.

      \n
      • \n
    \n

    \n Charges for health checks\n

    \n

    Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.

    " + "smithy.api#documentation": "

    \n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     \n

    Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.

    \n

    Note the following about configuring health checks.

    \n

    \n \n A and AAAA records\n

    \n

    If DnsConfig includes configurations for both A and AAAA records,\n AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint\n that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA\n records to be unhealthy.

    \n

    \n \n CNAME records\n

    \n

    You can't specify settings for HealthCheckConfig when the DNSConfig includes\n CNAME for the value of Type. If you do, the CreateService request will fail\n with an InvalidInput error.

    \n

    \n Request interval\n

    \n

    A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30\n seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers\n don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with\n no health checks at all.

    \n

    \n Health checking regions\n

    \n

    Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see\n Regions.

    \n

    \n Alias records\n

    \n

    When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates\n a Route 53 alias record. Note the following:

    \n
      \n
    • \n

      Route 53 automatically sets EvaluateTargetHealth to true for alias records. When\n EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource.\n such as an ELB load balancer. For more information, see EvaluateTargetHealth.

      \n
      • \n
    • \n

      If you include HealthCheckConfig and then use the service to register an instance that creates an\n alias record, Route 53 doesn't create the health check.

      \n
      • \n
    \n

    \n Charges for health checks\n

    \n

    Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.

    " } }, "com.amazonaws.servicediscovery#HealthCheckCustomConfig": { @@ -1102,7 +1108,7 @@ "FailureThreshold": { "target": "com.amazonaws.servicediscovery#FailureThreshold", "traits": { - "smithy.api#documentation": "

    The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For\n example, suppose you specify a value of 2 for FailureTheshold, and then your application\n sends an UpdateInstanceCustomHealthStatus request. AWS Cloud Map waits for approximately 60 seconds (2 x 30)\n before changing the status of the service instance based on that request.

    \n

    Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before\n FailureThreshold x 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits\n FailureThreshold x 30 seconds after the first request to make the change.

    " + "smithy.api#documentation": "\n

    This parameter has been deprecated and is always set to 1. AWS Cloud Map waits for approximately 30 seconds\n after receiving an UpdateInstanceCustomHealthStatus request before changing the status of\n the service instance.

    \n     \n \n

    The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a service\n instance.

    \n

    Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value\n before 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits\n 30 seconds after the first request to make the change.

    " } } }, @@ -1170,6 +1176,12 @@ "com.amazonaws.servicediscovery#HttpInstanceSummary": { "type": "structure", "members": { + "HealthStatus": { + "target": "com.amazonaws.servicediscovery#HealthStatus", + "traits": { + "smithy.api#documentation": "

    If you configured health checking in the service, the current health status of the service instance.

    " + } + }, "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { @@ -1182,22 +1194,16 @@ "smithy.api#documentation": "

    The ID of an instance that matches the values that you specified in the request.

    " } }, - "ServiceName": { - "target": "com.amazonaws.servicediscovery#ServiceName", - "traits": { - "smithy.api#documentation": "

    The name of the service that you specified when you registered the instance.

    " - } - }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { "smithy.api#documentation": "

    If you included any attributes when you registered the instance, the values of those attributes.

    " } }, - "HealthStatus": { - "target": "com.amazonaws.servicediscovery#HealthStatus", + "ServiceName": { + "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "

    If you configured health checking in the service, the current health status of the service instance.

    " + "smithy.api#documentation": "

    The name of the service that you specified when you registered the instance.

    " } } }, @@ -1228,24 +1234,24 @@ "com.amazonaws.servicediscovery#Instance": { "type": "structure", "members": { - "CreatorRequestId": { - "target": "com.amazonaws.servicediscovery#ResourceId", - "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed RegisterInstance requests to be\n retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string\n every time you submit a RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.

    " - } - }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

    A string map that contains the following information for the service that you specify in\n ServiceId:

    \n
      \n
    • \n

      The attributes that apply to the records that are defined in the service.

      \n
      • \n
    • \n

      For each attribute, the applicable value.

      \n
      • \n
    \n

    Supported attribute keys include the following:

    \n

    \n AWS_ALIAS_DNS_NAME\n

    \n

    \n \n

    \n

    If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load\n balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS\n name, see \"DNSName\" in the topic AliasTarget.

    \n

    Note the following:

    \n
      \n
    • \n

      The configuration for the service that is specified by ServiceId must include settings for an A\n record, an AAAA record, or both.

      \n
      • \n
    • \n

      In the service that is specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.

      \n
      • \n
    • \n

      If the service that is specified by ServiceId includes HealthCheckConfig settings,\n AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.

      \n
      • \n
    • \n

      Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than\n ELB load balancers.

      \n
      • \n
    • \n

      If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

      \n
      • \n
    \n

    \n AWS_INSTANCE_CNAME\n

    \n

    If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response\n to DNS queries, for example, example.com.

    \n

    This value is required if the service specified by ServiceId includes settings for an CNAME\n record.

    \n

    \n AWS_INSTANCE_IPV4\n

    \n

    If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to\n DNS queries, for example, 192.0.2.44.

    \n

    This value is required if the service specified by ServiceId includes settings for an A record. If\n the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_IPV6\n

    \n

    If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response\n to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    \n

    This value is required if the service specified by ServiceId includes settings for an AAAA record.\n If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_PORT\n

    \n

    If the service includes an SRV record, the value that you want Route 53 to return for the port.

    \n

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.

    \n

    This value is required if you specified settings for an SRV record or a Route 53 health check when you created the\n service.

    " + "smithy.api#documentation": "

    A string map that contains the following information for the service that you specify in\n ServiceId:

    \n
      \n
    • \n

      The attributes that apply to the records that are defined in the service.

      \n
      • \n
    • \n

      For each attribute, the applicable value.

      \n
      • \n
    \n

    Supported attribute keys include the following:

    \n

    \n AWS_ALIAS_DNS_NAME\n

    \n

    \n \n

    \n

    If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that is associated with the load balancer. For information about how to get the DNS\n name, see \"DNSName\" in the topic AliasTarget.

    \n

    Note the following:

    \n
      \n
    • \n

      The configuration for the service that is specified by ServiceId must include\n settings for an A record, an AAAA record, or both.

      \n
      • \n
    • \n

      In the service that is specified by ServiceId, the value of\n RoutingPolicy must be WEIGHTED.

      \n
      • \n
    • \n

      If the service that is specified by ServiceId includes HealthCheckConfig\n settings, AWS Cloud Map will create the health check, but it won't associate the health check with the\n alias record.

      \n
      • \n
    • \n

      Auto naming currently doesn't support creating alias records that route traffic to AWS resources\n other than ELB load balancers.

      \n
      • \n
    • \n

      If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

      \n
      • \n
    \n \n

    \n AWS_EC2_INSTANCE_ID\n

    \n

    \n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

    \n \n

    \n AWS_INSTANCE_CNAME\n

    \n

    If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries, for example, example.com.

    \n

    This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

    \n

    \n AWS_INSTANCE_IPV4\n

    \n

    If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries, for example, 192.0.2.44.

    \n

    This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify\n a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_IPV6\n

    \n

    If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    \n

    This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must\n specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_PORT\n

    \n

    If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

    \n

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to\n send requests to.

    \n

    This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.

    " } }, "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    An identifier that you want to associate with the instance. Note the following:

    \n
      \n
    • \n

      If the service that is specified by ServiceId includes settings for an SRV record, the value of\n InstanceId is automatically included as part of the value for the SRV record. For more information,\n see DnsRecord > Type.

      \n
      • \n
    • \n

      You can use this value to update an existing instance.

      \n
      • \n
    • \n

      To register a new instance, you must specify a value that is unique among instances that you register by using\n the same service.

      \n
      • \n
    • \n

      If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing\n DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new\n one.

      \n \n

      The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.

      \n       \n
      • \n
    ", + "smithy.api#documentation": "

    An identifier that you want to associate with the instance. Note the following:

    \n
      \n
    • \n

      If the service that is specified by ServiceId includes settings for an SRV record,\n the value of InstanceId is automatically included as part of the value for the SRV\n record. For more information, see DnsRecord > Type.

      \n
      • \n
    • \n

      You can use this value to update an existing instance.

      \n
      • \n
    • \n

      To register a new instance, you must specify a value that is unique among instances that you register by using\n the same service.

      \n
      • \n
    • \n

      If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing\n DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new\n one.

      \n \n

      The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.

      \n       \n
      • \n
    ", "smithy.api#required": {} } + }, + "CreatorRequestId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed RegisterInstance requests to be\n retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string\n every time you submit a RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.

    " + } } }, "traits": { @@ -1300,7 +1306,7 @@ "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

    A string map that contains the following information:

    \n
      \n
    • \n

      The attributes that are associate with the instance.

      \n
      • \n
    • \n

      For each attribute, the applicable value.

      \n
      • \n
    \n

    Supported attribute keys include the following:

    \n
      \n
    • \n

      \n AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic Load Balancing load\n balancer, the DNS name that is associated with the load balancer.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53 returns in response to DNS\n queries, for example, example.com.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns in response to DNS\n queries, for example, 192.0.2.44.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS\n queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns for the port. In addition, if\n the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

      \n
      • \n
    " + "smithy.api#documentation": "

    A string map that contains the following information:

    \n
      \n
    • \n

      The attributes that are associate with the instance.

      \n
      • \n
    • \n

      For each attribute, the applicable value.

      \n
      • \n
    \n

    Supported attribute keys include the following:

    \n
      \n
    • \n

      \n AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic Load Balancing load\n balancer, the DNS name that is associated with the load balancer.

      \n
      • \n
    • \n

      \n AWS_EC2_INSTANCE_ID: (HTTP namespaces only) The\n Amazon EC2 instance ID for the\n instance. When the AWS_EC2_INSTANCE_ID attribute is specified, then the\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53\n returns in response to DNS queries, for example, example.com.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns\n in response to DNS queries, for example, 192.0.2.44.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53\n returns in response to DNS queries, for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.

      \n
      • \n
    • \n

      \n AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns for\n the port. In addition, if the service includes HealthCheckConfig, the port on the\n endpoint that Route 53 sends requests to.

      \n
      • \n
    " } } }, @@ -1358,6 +1364,12 @@ "com.amazonaws.servicediscovery#ListInstancesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.servicediscovery#NextToken", + "traits": { + "smithy.api#documentation": "

    For the first ListInstances request, omit this value.

    \n

    If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of NextToken\n from the previous response in the next request.

    " + } + }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { @@ -1370,29 +1382,23 @@ "smithy.api#documentation": "

    The ID of the service that you want to list instances for.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.servicediscovery#NextToken", - "traits": { - "smithy.api#documentation": "

    For the first ListInstances request, omit this value.

    \n

    If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of NextToken\n from the previous response in the next request.

    " - } } } }, "com.amazonaws.servicediscovery#ListInstancesResponse": { "type": "structure", "members": { - "Instances": { - "target": "com.amazonaws.servicediscovery#InstanceSummaryList", - "traits": { - "smithy.api#documentation": "

    Summary information about the instances that are associated with the specified service.

    " - } - }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { "smithy.api#documentation": "

    If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of NextToken\n from the previous response in the next request.

    " } + }, + "Instances": { + "target": "com.amazonaws.servicediscovery#InstanceSummaryList", + "traits": { + "smithy.api#documentation": "

    Summary information about the instances that are associated with the specified service.

    " + } } } }, @@ -1421,10 +1427,10 @@ "com.amazonaws.servicediscovery#ListNamespacesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.servicediscovery#MaxResults", + "NextToken": { + "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

    The maximum number of namespaces that you want AWS Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 namespaces.

    " + "smithy.api#documentation": "

    For the first ListNamespaces request, omit this value.

    \n

    If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    \n     " } }, "Filters": { @@ -1433,10 +1439,10 @@ "smithy.api#documentation": "

    A complex type that contains specifications for the namespaces that you want to list.

    \n

    If you specify more than one filter, a namespace must match all filters to be returned by\n ListNamespaces.

    " } }, - "NextToken": { - "target": "com.amazonaws.servicediscovery#NextToken", + "MaxResults": { + "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

    For the first ListNamespaces request, omit this value.

    \n

    If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    \n     " + "smithy.api#documentation": "

    The maximum number of namespaces that you want AWS Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 namespaces.

    " } } } @@ -1444,17 +1450,17 @@ "com.amazonaws.servicediscovery#ListNamespacesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.servicediscovery#NextToken", - "traits": { - "smithy.api#documentation": "

    If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    \n     " - } - }, "Namespaces": { "target": "com.amazonaws.servicediscovery#NamespaceSummariesList", "traits": { "smithy.api#documentation": "

    An array that contains one NamespaceSummary object for each namespace that matches the specified\n filter criteria.

    " } + }, + "NextToken": { + "target": "com.amazonaws.servicediscovery#NextToken", + "traits": { + "smithy.api#documentation": "

    If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    \n     " + } } } }, @@ -1483,6 +1489,12 @@ "com.amazonaws.servicediscovery#ListOperationsRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.servicediscovery#OperationFilters", + "traits": { + "smithy.api#documentation": "

    A complex type that contains specifications for the operations that you want to list, for example, operations\n that you started between a specified start date and end date.

    \n

    If you specify more than one filter, an operation must match all filters to be returned by\n ListOperations.

    " + } + }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { @@ -1494,29 +1506,23 @@ "traits": { "smithy.api#documentation": "

    For the first ListOperations request, omit this value.

    \n

    If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.

    \n     " } - }, - "Filters": { - "target": "com.amazonaws.servicediscovery#OperationFilters", - "traits": { - "smithy.api#documentation": "

    A complex type that contains specifications for the operations that you want to list, for example, operations\n that you started between a specified start date and end date.

    \n

    If you specify more than one filter, an operation must match all filters to be returned by\n ListOperations.

    " - } } } }, "com.amazonaws.servicediscovery#ListOperationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.servicediscovery#NextToken", - "traits": { - "smithy.api#documentation": "

    If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.

    \n     " - } - }, "Operations": { "target": "com.amazonaws.servicediscovery#OperationSummaryList", "traits": { "smithy.api#documentation": "

    Summary information about the operations that match the specified criteria.

    " } + }, + "NextToken": { + "target": "com.amazonaws.servicediscovery#NextToken", + "traits": { + "smithy.api#documentation": "

    If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.

    \n     " + } } } }, @@ -1545,6 +1551,12 @@ "com.amazonaws.servicediscovery#ListServicesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.servicediscovery#NextToken", + "traits": { + "smithy.api#documentation": "

    For the first ListServices request, omit this value.

    \n

    If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

    \n     " + } + }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { @@ -1556,29 +1568,23 @@ "traits": { "smithy.api#documentation": "

    A complex type that contains specifications for the namespaces that you want to list services for.

    \n

    If you specify more than one filter, an operation must match all filters to be returned by\n ListServices.

    " } - }, - "NextToken": { - "target": "com.amazonaws.servicediscovery#NextToken", - "traits": { - "smithy.api#documentation": "

    For the first ListServices request, omit this value.

    \n

    If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

    \n     " - } } } }, "com.amazonaws.servicediscovery#ListServicesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.servicediscovery#NextToken", - "traits": { - "smithy.api#documentation": "

    If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

    \n     " - } - }, "Services": { "target": "com.amazonaws.servicediscovery#ServiceSummariesList", "traits": { "smithy.api#documentation": "

    An array that contains one ServiceSummary object for each service that matches the specified filter\n criteria.

    " } + }, + "NextToken": { + "target": "com.amazonaws.servicediscovery#NextToken", + "traits": { + "smithy.api#documentation": "

    If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

    \n \n

    AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

    \n     " + } } } }, @@ -1641,46 +1647,46 @@ "com.amazonaws.servicediscovery#Namespace": { "type": "structure", "members": { - "Properties": { - "target": "com.amazonaws.servicediscovery#NamespaceProperties", + "CreatorRequestId": { + "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    A complex type that contains information that's specific to the type of the namespace.

    " + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of\n executing an operation twice.

    " } }, - "CreateDate": { - "target": "com.amazonaws.servicediscovery#Timestamp", + "Id": { + "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The\n value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

    " + "smithy.api#documentation": "

    The ID of a namespace.

    " } }, - "Type": { - "target": "com.amazonaws.servicediscovery#NamespaceType", + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

    The type of the namespace. The methods for discovering instances depends on the value that you specify:

    \n
      \n
    • \n

      \n HTTP: Instances can be discovered only programmatically, using the AWS Cloud Map\n DiscoverInstances API.

      \n
      • \n
    • \n

      \n DNS_PUBLIC: Instances can be discovered using public DNS queries and using the\n DiscoverInstances API.

      \n
      • \n
    • \n

      \n DNS_PRIVATE: Instances can be discovered using DNS queries in VPCs and using the\n DiscoverInstances API.

      \n
      • \n
    " + "smithy.api#documentation": "

    The description that you specify for the namespace when you create it.

    " } }, - "ServiceCount": { - "target": "com.amazonaws.servicediscovery#ResourceCount", + "Type": { + "target": "com.amazonaws.servicediscovery#NamespaceType", "traits": { - "smithy.api#documentation": "

    The number of services that are associated with the namespace.

    " + "smithy.api#documentation": "

    The type of the namespace. The methods for discovering instances depends on the value that you specify:

    \n
      \n
    • \n

      \n HTTP: Instances can be discovered only programmatically, using the AWS Cloud Map\n DiscoverInstances API.

      \n
      • \n
    • \n

      \n DNS_PUBLIC: Instances can be discovered using public DNS queries and using the\n DiscoverInstances API.

      \n
      • \n
    • \n

      \n DNS_PRIVATE: Instances can be discovered using DNS queries in VPCs and using the\n DiscoverInstances API.

      \n
      • \n
    " } }, - "Name": { - "target": "com.amazonaws.servicediscovery#NamespaceName", + "CreateDate": { + "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the namespace, such as example.com.

    " + "smithy.api#documentation": "

    The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The\n value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

    " } }, - "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "Properties": { + "target": "com.amazonaws.servicediscovery#NamespaceProperties", "traits": { - "smithy.api#documentation": "

    The ID of a namespace.

    " + "smithy.api#documentation": "

    A complex type that contains information that's specific to the type of the namespace.

    " } }, - "CreatorRequestId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "Name": { + "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of\n executing an operation twice.

    " + "smithy.api#documentation": "

    The name of the namespace, such as example.com.

    " } }, "Arn": { @@ -1689,10 +1695,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

    " } }, - "Description": { - "target": "com.amazonaws.servicediscovery#ResourceDescription", + "ServiceCount": { + "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "

    The description that you specify for the namespace when you create it.

    " + "smithy.api#documentation": "

    The number of services that are associated with the namespace.

    " } } }, @@ -1703,6 +1709,12 @@ "com.amazonaws.servicediscovery#NamespaceAlreadyExists": { "type": "structure", "members": { + "CreatorRequestId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

    The CreatorRequestId that was used to create the namespace.

    " + } + }, "Message": { "target": "com.amazonaws.servicediscovery#ErrorMessage" }, @@ -1711,12 +1723,6 @@ "traits": { "smithy.api#documentation": "

    The ID of the existing namespace.

    " } - }, - "CreatorRequestId": { - "target": "com.amazonaws.servicediscovery#ResourceId", - "traits": { - "smithy.api#documentation": "

    The CreatorRequestId that was used to create the namespace.

    " - } } }, "traits": { @@ -1728,6 +1734,12 @@ "com.amazonaws.servicediscovery#NamespaceFilter": { "type": "structure", "members": { + "Condition": { + "target": "com.amazonaws.servicediscovery#FilterCondition", + "traits": { + "smithy.api#documentation": "

    The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid\n values for condition include:

    \n
      \n
    • \n

      \n EQ: When you specify EQ for the condition, you can choose to list only public\n namespaces or private namespaces, but not both. EQ is the default condition and can be omitted.

      \n
      • \n
    • \n

      \n IN: When you specify IN for the condition, you can choose to list public namespaces,\n private namespaces, or both.

      \n
      • \n
    • \n

      \n BETWEEN: Not applicable

      \n
      • \n
    " + } + }, "Name": { "target": "com.amazonaws.servicediscovery#NamespaceFilterName", "traits": { @@ -1741,12 +1753,6 @@ "smithy.api#documentation": "

    If you specify EQ for Condition, specify either DNS_PUBLIC or\n DNS_PRIVATE.

    \n

    If you specify IN for Condition, you can specify DNS_PUBLIC,\n DNS_PRIVATE, or both.

    ", "smithy.api#required": {} } - }, - "Condition": { - "target": "com.amazonaws.servicediscovery#FilterCondition", - "traits": { - "smithy.api#documentation": "

    The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid\n values for condition include:

    \n
      \n
    • \n

      \n EQ: When you specify EQ for the condition, you can choose to list only public\n namespaces or private namespaces, but not both. EQ is the default condition and can be omitted.

      \n
      • \n
    • \n

      \n IN: When you specify IN for the condition, you can choose to list public namespaces,\n private namespaces, or both.

      \n
      • \n
    • \n

      \n BETWEEN: Not applicable

      \n
      • \n
    " - } } }, "traits": { @@ -1798,17 +1804,17 @@ "com.amazonaws.servicediscovery#NamespaceProperties": { "type": "structure", "members": { - "DnsProperties": { - "target": "com.amazonaws.servicediscovery#DnsProperties", - "traits": { - "smithy.api#documentation": "

    A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.

    " - } - }, "HttpProperties": { "target": "com.amazonaws.servicediscovery#HttpProperties", "traits": { "smithy.api#documentation": "

    A complex type that contains the name of an HTTP namespace.

    " } + }, + "DnsProperties": { + "target": "com.amazonaws.servicediscovery#DnsProperties", + "traits": { + "smithy.api#documentation": "

    A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.

    " + } } }, "traits": { @@ -1824,31 +1830,28 @@ "com.amazonaws.servicediscovery#NamespaceSummary": { "type": "structure", "members": { - "CreateDate": { - "target": "com.amazonaws.servicediscovery#Timestamp", + "Name": { + "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "

    The date and time that the namespace was created.

    " + "smithy.api#documentation": "

    The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone\n that has the same name as the namespace.

    " } }, - "Type": { - "target": "com.amazonaws.servicediscovery#NamespaceType", + "ServiceCount": { + "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "

    The type of the namespace, either public or private.

    " + "smithy.api#documentation": "

    The number of services that were created using the namespace.

    " } }, - "Properties": { - "target": "com.amazonaws.servicediscovery#NamespaceProperties" - }, - "Name": { - "target": "com.amazonaws.servicediscovery#NamespaceName", + "Id": { + "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone\n that has the same name as the namespace.

    " + "smithy.api#documentation": "

    The ID of the namespace.

    " } }, - "ServiceCount": { - "target": "com.amazonaws.servicediscovery#ResourceCount", + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

    The number of services that were created using the namespace.

    " + "smithy.api#documentation": "

    A description for the namespace.

    " } }, "Arn": { @@ -1857,17 +1860,20 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

    " } }, - "Description": { - "target": "com.amazonaws.servicediscovery#ResourceDescription", + "CreateDate": { + "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

    A description for the namespace.

    " + "smithy.api#documentation": "

    The date and time that the namespace was created.

    " } }, - "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "Type": { + "target": "com.amazonaws.servicediscovery#NamespaceType", "traits": { - "smithy.api#documentation": "

    The ID of the namespace.

    " + "smithy.api#documentation": "

    The type of the namespace, either public or private.

    " } + }, + "Properties": { + "target": "com.amazonaws.servicediscovery#NamespaceProperties" } }, "traits": { @@ -1905,52 +1911,52 @@ "com.amazonaws.servicediscovery#Operation": { "type": "structure", "members": { - "CreateDate": { + "UpdateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).\n The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

    " + "smithy.api#documentation": "

    The date and time that the value of Status changed to the current value, in Unix date/time format\n and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example,\n the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " } }, - "Type": { - "target": "com.amazonaws.servicediscovery#OperationType", + "Targets": { + "target": "com.amazonaws.servicediscovery#OperationTargetsMap", "traits": { - "smithy.api#documentation": "

    The name of the operation that is associated with the specified ID.

    " + "smithy.api#documentation": "

    The name of the target entity that is associated with the operation:

    \n
      \n
    • \n

      \n NAMESPACE: The namespace ID is returned in the ResourceId\n property.

      \n
      • \n
    • \n

      \n SERVICE: The service ID is returned in the ResourceId\n property.

      \n
      • \n
    • \n

      \n INSTANCE: The instance ID is returned in the ResourceId\n property.

      \n
      • \n
    " } }, - "ErrorMessage": { - "target": "com.amazonaws.servicediscovery#Message", + "Id": { + "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

    If the value of Status is FAIL, the reason that the operation failed.

    " + "smithy.api#documentation": "

    The ID of the operation that you want to get information about.

    " } }, - "ErrorCode": { - "target": "com.amazonaws.servicediscovery#Code", + "Type": { + "target": "com.amazonaws.servicediscovery#OperationType", "traits": { - "smithy.api#documentation": "

    The code associated with ErrorMessage. Values for ErrorCode include the\n following:

    \n
      \n
    • \n

      \n ACCESS_DENIED\n

      \n
      • \n
    • \n

      \n CANNOT_CREATE_HOSTED_ZONE\n

      \n
      • \n
    • \n

      \n EXPIRED_TOKEN\n

      \n
      • \n
    • \n

      \n HOSTED_ZONE_NOT_FOUND\n

      \n
      • \n
    • \n

      \n INTERNAL_FAILURE\n

      \n
      • \n
    • \n

      \n INVALID_CHANGE_BATCH\n

      \n
      • \n
    • \n

      \n THROTTLED_REQUEST\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the operation that is associated with the specified ID.

    " } }, - "Status": { - "target": "com.amazonaws.servicediscovery#OperationStatus", + "CreateDate": { + "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of the operation. Values include the following:

    \n
      \n
    • \n

      \n SUBMITTED: This is the initial state immediately after you submit a\n request.

      \n
      • \n
    • \n

      \n PENDING: AWS Cloud Map is performing the operation.

      \n
      • \n
    • \n

      \n SUCCESS: The operation succeeded.

      \n
      • \n
    • \n

      \n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.

      \n
      • \n
    " + "smithy.api#documentation": "

    The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).\n The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

    " } }, - "UpdateDate": { - "target": "com.amazonaws.servicediscovery#Timestamp", + "ErrorMessage": { + "target": "com.amazonaws.servicediscovery#Message", "traits": { - "smithy.api#documentation": "

    The date and time that the value of Status changed to the current value, in Unix date/time format\n and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example,\n the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " + "smithy.api#documentation": "

    If the value of Status is FAIL, the reason that the operation failed.

    " } }, - "Id": { - "target": "com.amazonaws.servicediscovery#OperationId", + "Status": { + "target": "com.amazonaws.servicediscovery#OperationStatus", "traits": { - "smithy.api#documentation": "

    The ID of the operation that you want to get information about.

    " + "smithy.api#documentation": "

    The status of the operation. Values include the following:

    \n
      \n
    • \n

      \n SUBMITTED: This is the initial state immediately after you submit a\n request.

      \n
      • \n
    • \n

      \n PENDING: AWS Cloud Map is performing the operation.

      \n
      • \n
    • \n

      \n SUCCESS: The operation succeeded.

      \n
      • \n
    • \n

      \n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.

      \n
      • \n
    " } }, - "Targets": { - "target": "com.amazonaws.servicediscovery#OperationTargetsMap", + "ErrorCode": { + "target": "com.amazonaws.servicediscovery#Code", "traits": { - "smithy.api#documentation": "

    The name of the target entity that is associated with the operation:

    \n
      \n
    • \n

      \n NAMESPACE: The namespace ID is returned in the ResourceId\n property.

      \n
      • \n
    • \n

      \n SERVICE: The service ID is returned in the ResourceId\n property.

      \n
      • \n
    • \n

      \n INSTANCE: The instance ID is returned in the ResourceId\n property.

      \n
      • \n
    " + "smithy.api#documentation": "

    The code associated with ErrorMessage. Values for ErrorCode include the\n following:

    \n
      \n
    • \n

      \n ACCESS_DENIED\n

      \n
      • \n
    • \n

      \n CANNOT_CREATE_HOSTED_ZONE\n

      \n
      • \n
    • \n

      \n EXPIRED_TOKEN\n

      \n
      • \n
    • \n

      \n HOSTED_ZONE_NOT_FOUND\n

      \n
      • \n
    • \n

      \n INTERNAL_FAILURE\n

      \n
      • \n
    • \n

      \n INVALID_CHANGE_BATCH\n

      \n
      • \n
    • \n

      \n THROTTLED_REQUEST\n

      \n
      • \n
    " } } }, @@ -1961,12 +1967,6 @@ "com.amazonaws.servicediscovery#OperationFilter": { "type": "structure", "members": { - "Condition": { - "target": "com.amazonaws.servicediscovery#FilterCondition", - "traits": { - "smithy.api#documentation": "

    The operator that you want to use to determine whether an operation matches the specified value. Valid values\n for condition include:

    \n
      \n
    • \n

      \n EQ: When you specify EQ for the condition, you can specify only one value.\n EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and\n TYPE. EQ is the default condition and can be omitted.

      \n
      • \n
    • \n

      \n IN: When you specify IN for the condition, you can specify a list of one or more\n values. IN is supported for STATUS and TYPE. An operation must match one of\n the specified values to be returned in the response.

      \n
      • \n
    • \n

      \n BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal\n Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.\n

      \n
      • \n
    " - } - }, "Values": { "target": "com.amazonaws.servicediscovery#FilterValues", "traits": { @@ -1980,6 +1980,12 @@ "smithy.api#documentation": "

    Specify the operations that you want to get:

    \n
      \n
    • \n

      \n NAMESPACE_ID: Gets operations related to specified namespaces.

      \n
      • \n
    • \n

      \n SERVICE_ID: Gets operations related to specified services.

      \n
      • \n
    • \n

      \n STATUS: Gets operations based on the status of the operations:\n SUBMITTED, PENDING, SUCCEED, or FAIL.

      \n
      • \n
    • \n

      \n TYPE: Gets specified types of operation.

      \n
      • \n
    • \n

      \n UPDATE_DATE: Gets operations that changed status during a specified date/time\n range.

      \n
      • \n
    ", "smithy.api#required": {} } + }, + "Condition": { + "target": "com.amazonaws.servicediscovery#FilterCondition", + "traits": { + "smithy.api#documentation": "

    The operator that you want to use to determine whether an operation matches the specified value. Valid values\n for condition include:

    \n
      \n
    • \n

      \n EQ: When you specify EQ for the condition, you can specify only one value.\n EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and\n TYPE. EQ is the default condition and can be omitted.

      \n
      • \n
    • \n

      \n IN: When you specify IN for the condition, you can specify a list of one or more\n values. IN is supported for STATUS and TYPE. An operation must match one of\n the specified values to be returned in the response.

      \n
      • \n
    • \n

      \n BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal\n Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.\n

      \n
      • \n
    " + } } }, "traits": { @@ -2070,17 +2076,17 @@ "com.amazonaws.servicediscovery#OperationSummary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.servicediscovery#OperationId", - "traits": { - "smithy.api#documentation": "

    The ID for an operation.

    " - } - }, "Status": { "target": "com.amazonaws.servicediscovery#OperationStatus", "traits": { "smithy.api#documentation": "

    The status of the operation. Values include the following:

    \n
      \n
    • \n

      \n SUBMITTED: This is the initial state immediately after you submit a\n request.

      \n
      • \n
    • \n

      \n PENDING: AWS Cloud Map is performing the operation.

      \n
      • \n
    • \n

      \n SUCCESS: The operation succeeded.

      \n
      • \n
    • \n

      \n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.

      \n
      • \n
    " } + }, + "Id": { + "target": "com.amazonaws.servicediscovery#OperationId", + "traits": { + "smithy.api#documentation": "

    The ID for an operation.

    " + } } }, "traits": { @@ -2210,7 +2216,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance request, the following occurs:

    \n
      \n
    • \n

      For each DNS record that you define in the service that is specified by ServiceId, a record is\n created or updated in the hosted zone that is associated with the corresponding namespace.

      \n
      • \n
    • \n

      If the service includes HealthCheckConfig, a health check is created based on the settings in the\n health check configuration.

      \n
      • \n
    • \n

      The health check, if any, is associated with each of the new or updated records.

      \n
      • \n
    \n \n

    One RegisterInstance request must complete before you can submit another request and specify the\n same service ID and instance ID.

    \n     \n

    For more information, see CreateService.

    \n

    When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

    \n
      \n
    • \n

      \n If the health check is healthy: returns all the records

      \n
      • \n
    • \n

      \n If the health check is unhealthy: returns the applicable value for the last\n healthy instance

      \n
      • \n
    • \n

      \n If you didn't specify a health check configuration: returns all the\n records

      \n
      • \n
    \n

    For the current limit on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

    " + "smithy.api#documentation": "

    Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance request, the following occurs:

    \n
      \n
    • \n

      For each DNS record that you define in the service that is specified by ServiceId, a record is\n created or updated in the hosted zone that is associated with the corresponding namespace.

      \n
      • \n
    • \n

      If the service includes HealthCheckConfig, a health check is created based on the settings in the\n health check configuration.

      \n
      • \n
    • \n

      The health check, if any, is associated with each of the new or updated records.

      \n
      • \n
    \n \n

    One RegisterInstance request must complete before you can submit another request and specify the\n same service ID and instance ID.

    \n     \n

    For more information, see CreateService.

    \n

    When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

    \n
      \n
    • \n

      \n If the health check is healthy: returns all the records

      \n
      • \n
    • \n

      \n If the health check is unhealthy: returns the applicable value for the last\n healthy instance

      \n
      • \n
    • \n

      \n If you didn't specify a health check configuration: returns all the\n records

      \n
      • \n
    \n

    For the current quota on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

    " } }, "com.amazonaws.servicediscovery#RegisterInstanceRequest": { @@ -2223,24 +2229,24 @@ "smithy.api#idempotencyToken": {} } }, - "Attributes": { - "target": "com.amazonaws.servicediscovery#Attributes", + "ServiceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    A string map that contains the following information for the service that you specify in\n ServiceId:

    \n
      \n
    • \n

      The attributes that apply to the records that are defined in the service.

      \n
      • \n
    • \n

      For each attribute, the applicable value.

      \n
      • \n
    \n

    Supported attribute keys include the following:

    \n

    \n AWS_ALIAS_DNS_NAME\n

    \n

    \n \n

    \n

    If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load\n balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS\n name, see \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.

    \n

    Note the following:

    \n
      \n
    • \n

      The configuration for the service that is specified by ServiceId must include settings for an A\n record, an AAAA record, or both.

      \n
      • \n
    • \n

      In the service that is specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.

      \n
      • \n
    • \n

      If the service that is specified by ServiceId includes HealthCheckConfig settings,\n AWS Cloud Map will create the Route 53 health check, but it won't associate the health check with the alias\n record.

      \n
      • \n
    • \n

      Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than\n ELB load balancers.

      \n
      • \n
    • \n

      If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

      \n
      • \n
    \n

    \n AWS_INIT_HEALTH_STATUS\n

    \n

    If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY\n or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status\n is HEALTHY.

    \n

    \n AWS_INSTANCE_CNAME\n

    \n

    If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response\n to DNS queries, for example, example.com.

    \n

    This value is required if the service specified by ServiceId includes settings for an CNAME\n record.

    \n

    \n AWS_INSTANCE_IPV4\n

    \n

    If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to\n DNS queries, for example, 192.0.2.44.

    \n

    This value is required if the service specified by ServiceId includes settings for an A record. If\n the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_IPV6\n

    \n

    If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response\n to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    \n

    This value is required if the service specified by ServiceId includes settings for an AAAA record.\n If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_PORT\n

    \n

    If the service includes an SRV record, the value that you want Route 53 to return for the port.

    \n

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.

    \n

    This value is required if you specified settings for an SRV record or a Route 53 health check when you created the\n service.

    \n

    \n Custom attributes\n

    \n

    You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255\n characters, and the maximum length of the attribute value is 1,024\n characters. Total size of all provided\n attributes (sum of all keys and values) must not exceed 5,000 characters.

    ", + "smithy.api#documentation": "

    The ID of the service that you want to use for settings for the instance.

    ", "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "Attributes": { + "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

    An identifier that you want to associate with the instance. Note the following:

    \n
      \n
    • \n

      If the service that is specified by ServiceId includes settings for an SRV record, the value of\n InstanceId is automatically included as part of the value for the SRV record. For more information,\n see DnsRecord > Type.

      \n
      • \n
    • \n

      You can use this value to update an existing instance.

      \n
      • \n
    • \n

      To register a new instance, you must specify a value that is unique among instances that you register by using\n the same service.

      \n
      • \n
    • \n

      If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing\n DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates\n a new one.

      \n \n

      The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.

      \n       \n
      • \n
    ", + "smithy.api#documentation": "

    A string map that contains the following information for the service that you specify in\n ServiceId:

    \n
      \n
    • \n

      The attributes that apply to the records that are defined in the service.

      \n
      • \n
    • \n

      For each attribute, the applicable value.

      \n
      • \n
    \n

    Supported attribute keys include the following:

    \n

    \n AWS_ALIAS_DNS_NAME\n

    \n

    If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that is associated with the load balancer. For information about how to get the DNS\n name, see \"DNSName\" in the topic AliasTarget in the\n Route 53 API Reference.

    \n

    Note the following:

    \n
      \n
    • \n

      The configuration for the service that is specified by ServiceId must include\n settings for an A record, an AAAA record, or both.

      \n
      • \n
    • \n

      In the service that is specified by ServiceId, the value of\n RoutingPolicy must be WEIGHTED.

      \n
      • \n
    • \n

      If the service that is specified by ServiceId includes HealthCheckConfig\n settings, AWS Cloud Map will create the Route 53 health check, but it won't associate the health check\n with the alias record.

      \n
      • \n
    • \n

      Auto naming currently doesn't support creating alias records that route traffic to AWS resources\n other than Elastic Load Balancing load balancers.

      \n
      • \n
    • \n

      If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

      \n
      • \n
    \n \n

    \n AWS_EC2_INSTANCE_ID\n

    \n

    \n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be\n specified is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is\n specified, then the AWS_INSTANCE_IPV4 attribute will be filled out with the primary private\n IPv4 address.

    \n \n

    \n AWS_INIT_HEALTH_STATUS\n

    \n

    If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

    \n

    \n AWS_INSTANCE_CNAME\n

    \n

    If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries, for example, example.com.

    \n

    This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

    \n

    \n AWS_INSTANCE_IPV4\n

    \n

    If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries, for example, 192.0.2.44.

    \n

    This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify\n a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_IPV6\n

    \n

    If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    \n

    This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must\n specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    \n

    \n AWS_INSTANCE_PORT\n

    \n

    If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

    \n

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to\n send requests to.

    \n

    This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.

    \n

    \n Custom attributes\n

    \n

    You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name\n is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all\n provided attributes (sum of all keys and values) must not exceed 5,000 characters.

    ", "smithy.api#required": {} } }, - "ServiceId": { + "InstanceId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the service that you want to use for settings for the instance.

    ", + "smithy.api#documentation": "

    An identifier that you want to associate with the instance. Note the following:

    \n
      \n
    • \n

      If the service that is specified by ServiceId includes settings for an SRV record,\n the value of InstanceId is automatically included as part of the value for the SRV\n record. For more information, see DnsRecord > Type.

      \n
      • \n
    • \n

      You can use this value to update an existing instance.

      \n
      • \n
    • \n

      To register a new instance, you must specify a value that is unique among instances that you register by using\n the same service.

      \n
      • \n
    • \n

      If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing\n DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates\n a new one.

      \n \n

      The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.

      \n       \n
      • \n
    ", "smithy.api#required": {} } } @@ -2265,7 +2271,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The operation can't be completed because you've reached the limit on the number of requests.

    ", + "smithy.api#documentation": "

    The operation can't be completed because you've reached the quota for the number of requests. For more\n information, see AWS Cloud Map API request throttling\n quota in the AWS Cloud Map Developer Guide.

    ", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2315,7 +2321,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The resource can't be created because you've reached the limit on the number of resources.

    ", + "smithy.api#documentation": "

    The resource can't be created because you've reached the quota on the number of resources.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2449,70 +2455,70 @@ "com.amazonaws.servicediscovery#Service": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.servicediscovery#ResourceCount", + "Name": { + "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "

    The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that have been deleted are not included in the count. The count might not reflect\n pending registrations and deregistrations.

    " + "smithy.api#documentation": "

    The name of the service.

    " } }, - "Description": { - "target": "com.amazonaws.servicediscovery#ResourceDescription", + "HealthCheckCustomConfig": { + "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "

    The description of the service.

    " + "smithy.api#documentation": "

    A complex type that contains information about an optional custom health check.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     " } }, - "CreateDate": { - "target": "com.amazonaws.servicediscovery#Timestamp", + "NamespaceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value\n of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087 AM.

    " + "smithy.api#documentation": "

    The ID of the namespace that was used to create the service.

    " } }, - "CreatorRequestId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "HealthCheckConfig": { + "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of\n executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time\n stamp.

    " + "smithy.api#documentation": "

    \n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.

    \n

    For information about the charges for health checks, see Amazon Route 53 Pricing.

    " } }, - "Arn": { - "target": "com.amazonaws.servicediscovery#Arn", + "InstanceCount": { + "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

    " + "smithy.api#documentation": "

    The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that have been deleted are not included in the count. The count might not reflect\n pending registrations and deregistrations.

    " } }, - "Name": { - "target": "com.amazonaws.servicediscovery#ServiceName", + "DnsConfig": { + "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

    The name of the service.

    " + "smithy.api#documentation": "

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

    " } }, - "NamespaceId": { + "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID of the namespace that was used to create the service.

    " + "smithy.api#documentation": "

    The ID that AWS Cloud Map assigned to the service when you created it.

    " } }, - "HealthCheckConfig": { - "target": "com.amazonaws.servicediscovery#HealthCheckConfig", + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

    \n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.

    \n

    For information about the charges for health checks, see Amazon Route 53 Pricing.

    " + "smithy.api#documentation": "

    The description of the service.

    " } }, - "Id": { + "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

    The ID that AWS Cloud Map assigned to the service when you created it.

    " + "smithy.api#documentation": "

    A unique string that identifies the request and that allows failed requests to be retried without the risk of\n executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time\n stamp.

    " } }, - "DnsConfig": { - "target": "com.amazonaws.servicediscovery#DnsConfig", + "CreateDate": { + "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

    " + "smithy.api#documentation": "

    The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value\n of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087 AM.

    " } }, - "HealthCheckCustomConfig": { - "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", + "Arn": { + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

    A complex type that contains information about an optional custom health check.

    \n \n

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

    \n     " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

    " } } }, @@ -2523,6 +2529,9 @@ "com.amazonaws.servicediscovery#ServiceAlreadyExists": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.servicediscovery#ErrorMessage" + }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { @@ -2534,9 +2543,6 @@ "traits": { "smithy.api#documentation": "

    The ID of the existing service.

    " } - }, - "Message": { - "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { @@ -2548,6 +2554,12 @@ "com.amazonaws.servicediscovery#ServiceChange": { "type": "structure", "members": { + "DnsConfig": { + "target": "com.amazonaws.servicediscovery#DnsConfigChange", + "traits": { + "smithy.api#documentation": "

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

    " + } + }, "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { @@ -2556,12 +2568,6 @@ }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig" - }, - "DnsConfig": { - "target": "com.amazonaws.servicediscovery#DnsConfigChange", - "traits": { - "smithy.api#documentation": "

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

    " - } } }, "traits": { @@ -2578,18 +2584,18 @@ "smithy.api#required": {} } }, + "Condition": { + "target": "com.amazonaws.servicediscovery#FilterCondition", + "traits": { + "smithy.api#documentation": "

    The operator that you want to use to determine whether a service is returned by ListServices. Valid\n values for Condition include the following:

    \n
      \n
    • \n

      \n EQ: When you specify EQ, specify one namespace ID for Values.\n EQ is the default condition and can be omitted.

      \n
      • \n
    • \n

      \n IN: When you specify IN, specify a list of the IDs for the namespaces that you want\n ListServices to return a list of services for.

      \n
      • \n
    • \n

      \n BETWEEN: Not applicable.

      \n
      • \n
    " + } + }, "Values": { "target": "com.amazonaws.servicediscovery#FilterValues", "traits": { "smithy.api#documentation": "

    The values that are applicable to the value that you specify for Condition to filter the list of\n services.

    ", "smithy.api#required": {} } - }, - "Condition": { - "target": "com.amazonaws.servicediscovery#FilterCondition", - "traits": { - "smithy.api#documentation": "

    The operator that you want to use to determine whether a service is returned by ListServices. Valid\n values for Condition include the following:

    \n
      \n
    • \n

      \n EQ: When you specify EQ, specify one namespace ID for Values.\n EQ is the default condition and can be omitted.

      \n
      • \n
    • \n

      \n IN: When you specify IN, specify a list of the IDs for the namespaces that you want\n ListServices to return a list of services for.

      \n
      • \n
    • \n

      \n BETWEEN: Not applicable.

      \n
      • \n
    " - } } }, "traits": { @@ -2644,32 +2650,32 @@ "com.amazonaws.servicediscovery#ServiceSummary": { "type": "structure", "members": { - "HealthCheckCustomConfig": { - "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig" + "HealthCheckConfig": { + "target": "com.amazonaws.servicediscovery#HealthCheckConfig" }, - "CreateDate": { - "target": "com.amazonaws.servicediscovery#Timestamp", + "Name": { + "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "

    The date and time that the service was created.

    " + "smithy.api#documentation": "

    The name of the service.

    " } }, - "InstanceCount": { - "target": "com.amazonaws.servicediscovery#ResourceCount", + "DnsConfig": { + "target": "com.amazonaws.servicediscovery#DnsConfig" + }, + "Arn": { + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

    The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that have been deleted are not included in the count. The count might not reflect\n pending registrations and deregistrations.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

    " } }, - "HealthCheckConfig": { - "target": "com.amazonaws.servicediscovery#HealthCheckConfig" - }, "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { "smithy.api#documentation": "

    The ID that AWS Cloud Map assigned to the service when you created it.

    " } }, - "DnsConfig": { - "target": "com.amazonaws.servicediscovery#DnsConfig" + "HealthCheckCustomConfig": { + "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig" }, "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", @@ -2677,16 +2683,16 @@ "smithy.api#documentation": "

    The description that you specify when you create the service.

    " } }, - "Name": { - "target": "com.amazonaws.servicediscovery#ServiceName", + "CreateDate": { + "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the service.

    " + "smithy.api#documentation": "

    The date and time that the service was created.

    " } }, - "Arn": { - "target": "com.amazonaws.servicediscovery#Arn", + "InstanceCount": { + "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

    " + "smithy.api#documentation": "

    The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that have been deleted are not included in the count. The count might not reflect\n pending registrations and deregistrations.

    " } } }, @@ -2700,7 +2706,7 @@ "Value": { "target": "com.amazonaws.servicediscovery#TagValue", "traits": { - "smithy.api#documentation": "

    The string value that's associated with the key of the tag. You can set the value of a tag to an empty string,\n but you can't set the value of a tag to null.

    ", + "smithy.api#documentation": "

    The string value associated with the key of the tag. You can set the value of a tag to an empty string, but you\n can't set the value of a tag to null.

    ", "smithy.api#required": {} } }, @@ -2810,18 +2816,18 @@ "com.amazonaws.servicediscovery#TooManyTagsException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.servicediscovery#ErrorMessage" - }, "ResourceName": { "target": "com.amazonaws.servicediscovery#AmazonResourceName", "traits": { "smithy.api#documentation": "

    The name of the resource.

    " } + }, + "Message": { + "target": "com.amazonaws.servicediscovery#ErrorMessage" } }, "traits": { - "smithy.api#documentation": "

    The list of tags on the resource is over the limit. The maximum number of tags that can be applied to a resource\n is 50.

    ", + "smithy.api#documentation": "

    The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource\n is 50.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2889,12 +2895,19 @@ } ], "traits": { - "smithy.api#documentation": "

    Submits a request to change the health status of a custom health check to healthy or unhealthy.

    \n

    You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks,\n which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the\n status for Route 53 health checks, which you define using HealthCheckConfig.

    \n

    For more information, see HealthCheckCustomConfig.

    " + "smithy.api#documentation": "

    Submits a request to change the health status of a custom health check to healthy or unhealthy.

    \n

    You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks,\n which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the\n status for Route 53 health checks, which you define using HealthCheckConfig.

    \n

    For more information, see HealthCheckCustomConfig.

    " } }, "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatusRequest": { "type": "structure", "members": { + "InstanceId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

    The ID of the instance that you want to change the health status for.

    ", + "smithy.api#required": {} + } + }, "Status": { "target": "com.amazonaws.servicediscovery#CustomHealthStatus", "traits": { @@ -2908,13 +2921,6 @@ "smithy.api#documentation": "

    The ID of the service that includes the configuration for the custom health check that you want to change the\n status for.

    ", "smithy.api#required": {} } - }, - "InstanceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", - "traits": { - "smithy.api#documentation": "

    The ID of the instance that you want to change the health status for.

    ", - "smithy.api#required": {} - } } } }, 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 3b28aa58d1bd..410396b1a00f 100644 --- a/codegen/sdk-codegen/aws-models/ses.2010-12-01.json +++ b/codegen/sdk-codegen/aws-models/ses.2010-12-01.json @@ -76,14 +76,14 @@ "com.amazonaws.ses#AlreadyExistsException": { "type": "structure", "members": { + "message": { + "target": "com.amazonaws.ses#ErrorMessage" + }, "Name": { "target": "com.amazonaws.ses#RuleOrRuleSetName", "traits": { "smithy.api#documentation": "

    Indicates that a resource could not be created because the resource name already\n exists.

    " } - }, - "message": { - "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -116,16 +116,16 @@ "com.amazonaws.ses#Body": { "type": "structure", "members": { - "Text": { + "Html": { "target": "com.amazonaws.ses#Content", "traits": { - "smithy.api#documentation": "

    The content of the message, in text format. Use this for text-based email clients, or\n clients on high-latency networks (such as mobile devices).

    " + "smithy.api#documentation": "

    The content of the message, in HTML format. Use this for email clients that can\n process HTML. You can include clickable links, formatted text, and much more in an HTML\n message.

    " } }, - "Html": { + "Text": { "target": "com.amazonaws.ses#Content", "traits": { - "smithy.api#documentation": "

    The content of the message, in HTML format. Use this for email clients that can\n process HTML. You can include clickable links, formatted text, and much more in an HTML\n message.

    " + "smithy.api#documentation": "

    The content of the message, in text format. Use this for text-based email clients, or\n clients on high-latency networks (such as mobile devices).

    " } } }, @@ -143,13 +143,6 @@ "smithy.api#required": {} } }, - "Message": { - "target": "com.amazonaws.ses#BounceMessage", - "traits": { - "smithy.api#documentation": "

    Human-readable text to include in the bounce message.

    ", - "smithy.api#required": {} - } - }, "Sender": { "target": "com.amazonaws.ses#Address", "traits": { @@ -157,16 +150,23 @@ "smithy.api#required": {} } }, + "StatusCode": { + "target": "com.amazonaws.ses#BounceStatusCode", + "traits": { + "smithy.api#documentation": "

    The SMTP enhanced status code, as defined by RFC 3463.

    " + } + }, "TopicArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is\n taken. An example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.

    " } }, - "StatusCode": { - "target": "com.amazonaws.ses#BounceStatusCode", + "Message": { + "target": "com.amazonaws.ses#BounceMessage", "traits": { - "smithy.api#documentation": "

    The SMTP enhanced status code, as defined by RFC 3463.

    " + "smithy.api#documentation": "

    Human-readable text to include in the bounce message.

    ", + "smithy.api#required": {} } } }, @@ -223,13 +223,6 @@ "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to receive\n email for the recipient of the bounced email. For more information about sending\n authorization, see the Amazon SES Developer\n Guide.

    " } }, - "Recipient": { - "target": "com.amazonaws.ses#Address", - "traits": { - "smithy.api#documentation": "

    The email address of the recipient of the bounced email.

    ", - "smithy.api#required": {} - } - }, "BounceType": { "target": "com.amazonaws.ses#BounceType", "traits": { @@ -241,6 +234,13 @@ "traits": { "smithy.api#documentation": "

    Recipient-related DSN fields, most of which would normally be filled in automatically\n when provided with a BounceType. You must provide either this parameter or\n BounceType.

    " } + }, + "Recipient": { + "target": "com.amazonaws.ses#Address", + "traits": { + "smithy.api#documentation": "

    The email address of the recipient of the bounced email.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -256,10 +256,10 @@ "com.amazonaws.ses#BulkEmailDestination": { "type": "structure", "members": { - "ReplacementTemplateData": { - "target": "com.amazonaws.ses#TemplateData", + "ReplacementTags": { + "target": "com.amazonaws.ses#MessageTagList", "traits": { - "smithy.api#documentation": "

    A list of replacement values to apply to the template. This parameter is a JSON\n object, typically consisting of key-value pairs in which the keys correspond to\n replacement tags in the email template.

    " + "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using SendBulkTemplatedEmail. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events.

    " } }, "Destination": { @@ -268,10 +268,10 @@ "smithy.api#required": {} } }, - "ReplacementTags": { - "target": "com.amazonaws.ses#MessageTagList", + "ReplacementTemplateData": { + "target": "com.amazonaws.ses#TemplateData", "traits": { - "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using SendBulkTemplatedEmail. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events.

    " + "smithy.api#documentation": "

    A list of replacement values to apply to the template. This parameter is a JSON\n object, typically consisting of key-value pairs in which the keys correspond to\n replacement tags in the email template.

    " } } }, @@ -294,17 +294,17 @@ "smithy.api#documentation": "

    A description of an error that prevented a message being sent using the\n SendBulkTemplatedEmail operation.

    " } }, - "MessageId": { - "target": "com.amazonaws.ses#MessageId", - "traits": { - "smithy.api#documentation": "

    The unique message identifier returned from the SendBulkTemplatedEmail\n operation.

    " - } - }, "Status": { "target": "com.amazonaws.ses#BulkEmailStatus", "traits": { "smithy.api#documentation": "

    The status of a message sent using the SendBulkTemplatedEmail\n operation.

    \n

    Possible values for this parameter include:

    \n
      \n
    • \n

      \n Success: Amazon SES accepted the message, and will attempt to deliver\n it to the recipients.

      \n
      • \n
    • \n

      \n MessageRejected: The message was rejected because it contained a\n virus.

      \n
      • \n
    • \n

      \n MailFromDomainNotVerified: The sender's email address or domain\n was not verified.

      \n
      • \n
    • \n

      \n ConfigurationSetDoesNotExist: The configuration set you specified\n does not exist.

      \n
      • \n
    • \n

      \n TemplateDoesNotExist: The template you specified does not\n exist.

      \n
      • \n
    • \n

      \n AccountSuspended: Your account has been shut down because of\n issues related to your email sending practices.

      \n
      • \n
    • \n

      \n AccountThrottled: The number of emails you can send has been\n reduced because your account has exceeded its allocated sending limit.

      \n
      • \n
    • \n

      \n AccountDailyQuotaExceeded: You have reached or exceeded the\n maximum number of emails you can send from your account in a 24-hour\n period.

      \n
      • \n
    • \n

      \n InvalidSendingPoolName: The configuration set you specified\n refers to an IP pool that does not exist.

      \n
      • \n
    • \n

      \n AccountSendingPaused: Email sending for the Amazon SES account was\n disabled using the UpdateAccountSendingEnabled\n operation.

      \n
      • \n
    • \n

      \n ConfigurationSetSendingPaused: Email sending for this\n configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.

      \n
      • \n
    • \n

      \n InvalidParameterValue: One or more of the parameters you\n specified when calling this operation was invalid. See the error message for\n additional information.

      \n
      • \n
    • \n

      \n TransientFailure: Amazon SES was unable to process your request\n because of a temporary issue.

      \n
      • \n
    • \n

      \n Failed: Amazon SES was unable to process your request. See the error\n message for additional information.

      \n
      • \n
    " } + }, + "MessageId": { + "target": "com.amazonaws.ses#MessageId", + "traits": { + "smithy.api#documentation": "

    The unique message identifier returned from the SendBulkTemplatedEmail\n operation.

    " + } } }, "traits": { @@ -482,17 +482,17 @@ "smithy.api#required": {} } }, - "DimensionValueSource": { - "target": "com.amazonaws.ses#DimensionValueSource", + "DimensionName": { + "target": "com.amazonaws.ses#DimensionName", "traits": { - "smithy.api#documentation": "

    The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you\n want Amazon SES to use the message tags that you specify using an\n X-SES-MESSAGE-TAGS header or a parameter to the\n SendEmail/SendRawEmail API, choose\n messageTag. If you want Amazon SES to use your own email headers, choose\n emailHeader.

    ", + "smithy.api#documentation": "

    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name\n must:

    \n
      \n
    • \n

      This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).

      \n
      • \n
    • \n

      Contain less than 256 characters.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "DimensionName": { - "target": "com.amazonaws.ses#DimensionName", + "DimensionValueSource": { + "target": "com.amazonaws.ses#DimensionValueSource", "traits": { - "smithy.api#documentation": "

    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name\n must:

    \n
      \n
    • \n

      This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).

      \n
      • \n
    • \n

      Contain less than 256 characters.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you\n want Amazon SES to use the message tags that you specify using an\n X-SES-MESSAGE-TAGS header or a parameter to the\n SendEmail/SendRawEmail API, choose\n messageTag. If you want Amazon SES to use your own email headers, choose\n emailHeader.

    ", "smithy.api#required": {} } } @@ -525,14 +525,14 @@ "com.amazonaws.ses#ConfigurationSetAlreadyExistsException": { "type": "structure", "members": { + "message": { + "target": "com.amazonaws.ses#ErrorMessage" + }, "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { "smithy.api#documentation": "

    Indicates that the configuration set does not exist.

    " } - }, - "message": { - "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -699,17 +699,17 @@ "com.amazonaws.ses#CreateConfigurationSetEventDestinationRequest": { "type": "structure", "members": { - "EventDestination": { - "target": "com.amazonaws.ses#EventDestination", + "ConfigurationSetName": { + "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "

    An object that describes the AWS service that email sending event information will\n be published to.

    ", + "smithy.api#documentation": "

    The name of the configuration set that the event destination should be associated\n with.

    ", "smithy.api#required": {} } }, - "ConfigurationSetName": { - "target": "com.amazonaws.ses#ConfigurationSetName", + "EventDestination": { + "target": "com.amazonaws.ses#EventDestination", "traits": { - "smithy.api#documentation": "

    The name of the configuration set that the event destination should be associated\n with.

    ", + "smithy.api#documentation": "

    An object that describes the AWS service that email sending event information will\n be published to.

    ", "smithy.api#required": {} } } @@ -824,13 +824,6 @@ "com.amazonaws.ses#CreateCustomVerificationEmailTemplateRequest": { "type": "structure", "members": { - "TemplateContent": { - "target": "com.amazonaws.ses#TemplateContent", - "traits": { - "smithy.api#documentation": "

    The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.

    ", - "smithy.api#required": {} - } - }, "TemplateSubject": { "target": "com.amazonaws.ses#Subject", "traits": { @@ -838,17 +831,17 @@ "smithy.api#required": {} } }, - "FailureRedirectionURL": { - "target": "com.amazonaws.ses#FailureRedirectionURL", + "TemplateContent": { + "target": "com.amazonaws.ses#TemplateContent", "traits": { - "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    ", + "smithy.api#documentation": "

    The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.

    ", "smithy.api#required": {} } }, - "TemplateName": { - "target": "com.amazonaws.ses#TemplateName", + "FailureRedirectionURL": { + "target": "com.amazonaws.ses#FailureRedirectionURL", "traits": { - "smithy.api#documentation": "

    The name of the custom verification email template.

    ", + "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    ", "smithy.api#required": {} } }, @@ -865,6 +858,13 @@ "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

    ", "smithy.api#required": {} } + }, + "TemplateName": { + "target": "com.amazonaws.ses#TemplateName", + "traits": { + "smithy.api#documentation": "

    The name of the custom verification email template.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -957,17 +957,17 @@ "smithy.api#documentation": "

    The name of an existing rule after which the new rule will be placed. If this\n parameter is null, the new rule will be inserted at the beginning of the rule\n list.

    " } }, - "Rule": { - "target": "com.amazonaws.ses#ReceiptRule", + "RuleSetName": { + "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { - "smithy.api#documentation": "

    A data structure that contains the specified rule's name, actions, recipients,\n domains, enabled status, scan status, and TLS policy.

    ", + "smithy.api#documentation": "

    The name of the rule set that the receipt rule will be added to.

    ", "smithy.api#required": {} } }, - "RuleSetName": { - "target": "com.amazonaws.ses#ReceiptRuleSetName", + "Rule": { + "target": "com.amazonaws.ses#ReceiptRule", "traits": { - "smithy.api#documentation": "

    The name of the rule set that the receipt rule will be added to.

    ", + "smithy.api#documentation": "

    A data structure that contains the specified rule's name, actions, recipients,\n domains, enabled status, scan status, and TLS policy.

    ", "smithy.api#required": {} } } @@ -1115,18 +1115,6 @@ "smithy.api#documentation": "

    The email address that the custom verification email is sent from.

    " } }, - "FailureRedirectionURL": { - "target": "com.amazonaws.ses#FailureRedirectionURL", - "traits": { - "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " - } - }, - "TemplateSubject": { - "target": "com.amazonaws.ses#Subject", - "traits": { - "smithy.api#documentation": "

    The subject line of the custom verification email.

    " - } - }, "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { @@ -1138,6 +1126,18 @@ "traits": { "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

    " } + }, + "FailureRedirectionURL": { + "target": "com.amazonaws.ses#FailureRedirectionURL", + "traits": { + "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " + } + }, + "TemplateSubject": { + "target": "com.amazonaws.ses#Subject", + "traits": { + "smithy.api#documentation": "

    The subject line of the custom verification email.

    " + } } }, "traits": { @@ -1147,14 +1147,14 @@ "com.amazonaws.ses#CustomVerificationEmailTemplateAlreadyExistsException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ses#ErrorMessage" - }, "CustomVerificationEmailTemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { "smithy.api#documentation": "

    Indicates that the provided custom verification email template with the specified\n template name already exists.

    " } + }, + "message": { + "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -1630,17 +1630,17 @@ "com.amazonaws.ses#DescribeActiveReceiptRuleSetResponse": { "type": "structure", "members": { - "Metadata": { - "target": "com.amazonaws.ses#ReceiptRuleSetMetadata", - "traits": { - "smithy.api#documentation": "

    The metadata for the currently active receipt rule set. The metadata consists of the\n rule set name and a timestamp of when the rule set was created.

    " - } - }, "Rules": { "target": "com.amazonaws.ses#ReceiptRulesList", "traits": { "smithy.api#documentation": "

    The receipt rules that belong to the active rule set.

    " } + }, + "Metadata": { + "target": "com.amazonaws.ses#ReceiptRuleSetMetadata", + "traits": { + "smithy.api#documentation": "

    The metadata for the currently active receipt rule set. The metadata consists of the\n rule set name and a timestamp of when the rule set was created.

    " + } } }, "traits": { @@ -1700,18 +1700,18 @@ "smithy.api#documentation": "

    The name of the custom open and click tracking domain associated with the\n configuration set.

    " } }, - "ConfigurationSet": { - "target": "com.amazonaws.ses#ConfigurationSet", - "traits": { - "smithy.api#documentation": "

    The configuration set object associated with the specified configuration set.

    " - } - }, "EventDestinations": { "target": "com.amazonaws.ses#EventDestinations", "traits": { "smithy.api#documentation": "

    A list of event destinations associated with the configuration set.

    " } }, + "ConfigurationSet": { + "target": "com.amazonaws.ses#ConfigurationSet", + "traits": { + "smithy.api#documentation": "

    The configuration set object associated with the specified configuration set.

    " + } + }, "DeliveryOptions": { "target": "com.amazonaws.ses#DeliveryOptions" } @@ -1743,17 +1743,17 @@ "com.amazonaws.ses#DescribeReceiptRuleRequest": { "type": "structure", "members": { - "RuleName": { - "target": "com.amazonaws.ses#ReceiptRuleName", + "RuleSetName": { + "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { - "smithy.api#documentation": "

    The name of the receipt rule.

    ", + "smithy.api#documentation": "

    The name of the receipt rule set that the receipt rule belongs to.

    ", "smithy.api#required": {} } }, - "RuleSetName": { - "target": "com.amazonaws.ses#ReceiptRuleSetName", + "RuleName": { + "target": "com.amazonaws.ses#ReceiptRuleName", "traits": { - "smithy.api#documentation": "

    The name of the receipt rule set that the receipt rule belongs to.

    ", + "smithy.api#documentation": "

    The name of the receipt rule.

    ", "smithy.api#required": {} } } @@ -1831,16 +1831,16 @@ "com.amazonaws.ses#Destination": { "type": "structure", "members": { - "CcAddresses": { + "ToAddresses": { "target": "com.amazonaws.ses#AddressList", "traits": { - "smithy.api#documentation": "

    The recipients to place on the CC: line of the message.

    " + "smithy.api#documentation": "

    The recipients to place on the To: line of the message.

    " } }, - "ToAddresses": { + "CcAddresses": { "target": "com.amazonaws.ses#AddressList", "traits": { - "smithy.api#documentation": "

    The recipients to place on the To: line of the message.

    " + "smithy.api#documentation": "

    The recipients to place on the CC: line of the message.

    " } }, "BccAddresses": { @@ -1939,23 +1939,16 @@ "smithy.api#documentation": "

    An object that contains the names, default values, and sources of the dimensions\n associated with an Amazon CloudWatch event destination.

    " } }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.ses#KinesisFirehoseDestination", - "traits": { - "smithy.api#documentation": "

    An object that contains the delivery stream ARN and the IAM role ARN associated with\n an Amazon Kinesis Firehose event destination.

    " - } - }, "Enabled": { "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#documentation": "

    Sets whether Amazon SES publishes events to this destination when you send an email with\n the associated configuration set. Set to true to enable publishing to this\n destination; set to false to prevent publishing to this destination. The\n default value is false.

    " } }, - "Name": { - "target": "com.amazonaws.ses#EventDestinationName", + "SNSDestination": { + "target": "com.amazonaws.ses#SNSDestination", "traits": { - "smithy.api#documentation": "

    The name of the event destination. The name must:

    \n
      \n
    • \n

      This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).

      \n
      • \n
    • \n

      Contain less than 64 characters.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event\n destination.

    " } }, "MatchingEventTypes": { @@ -1965,10 +1958,17 @@ "smithy.api#required": {} } }, - "SNSDestination": { - "target": "com.amazonaws.ses#SNSDestination", + "Name": { + "target": "com.amazonaws.ses#EventDestinationName", "traits": { - "smithy.api#documentation": "

    An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event\n destination.

    " + "smithy.api#documentation": "

    The name of the event destination. The name must:

    \n
      \n
    • \n

      This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).

      \n
      • \n
    • \n

      Contain less than 64 characters.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, + "KinesisFirehoseDestination": { + "target": "com.amazonaws.ses#KinesisFirehoseDestination", + "traits": { + "smithy.api#documentation": "

    An object that contains the delivery stream ARN and the IAM role ARN associated with\n an Amazon Kinesis Firehose event destination.

    " } } }, @@ -2004,11 +2004,8 @@ "com.amazonaws.ses#EventDestinationDoesNotExistException": { "type": "structure", "members": { - "EventDestinationName": { - "target": "com.amazonaws.ses#EventDestinationName", - "traits": { - "smithy.api#documentation": "

    Indicates that the event destination does not exist.

    " - } + "message": { + "target": "com.amazonaws.ses#ErrorMessage" }, "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", @@ -2016,8 +2013,11 @@ "smithy.api#documentation": "

    Indicates that the configuration set does not exist.

    " } }, - "message": { - "target": "com.amazonaws.ses#ErrorMessage" + "EventDestinationName": { + "target": "com.amazonaws.ses#EventDestinationName", + "traits": { + "smithy.api#documentation": "

    Indicates that the event destination does not exist.

    " + } } }, "traits": { @@ -2086,17 +2086,17 @@ "com.amazonaws.ses#ExtensionField": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.ses#ExtensionFieldValue", + "Name": { + "target": "com.amazonaws.ses#ExtensionFieldName", "traits": { - "smithy.api#documentation": "

    The value of the header to add. Must be less than 2048 characters, and must not\n contain newline characters (\"\\r\" or \"\\n\").

    ", + "smithy.api#documentation": "

    The name of the header to add. Must be between 1 and 50 characters, inclusive, and\n consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.ses#ExtensionFieldName", + "Value": { + "target": "com.amazonaws.ses#ExtensionFieldValue", "traits": { - "smithy.api#documentation": "

    The name of the header to add. Must be between 1 and 50 characters, inclusive, and\n consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

    ", + "smithy.api#documentation": "

    The value of the header to add. Must be less than 2048 characters, and must not\n contain newline characters (\"\\r\" or \"\\n\").

    ", "smithy.api#required": {} } } @@ -2126,14 +2126,14 @@ "com.amazonaws.ses#FromEmailAddressNotVerifiedException": { "type": "structure", "members": { + "message": { + "target": "com.amazonaws.ses#ErrorMessage" + }, "FromEmailAddress": { "target": "com.amazonaws.ses#FromAddress", "traits": { "smithy.api#documentation": "

    Indicates that the from email address associated with the custom verification email\n template is not verified.

    " } - }, - "message": { - "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -2206,18 +2206,18 @@ "smithy.api#documentation": "

    The email address that the custom verification email is sent from.

    " } }, - "FailureRedirectionURL": { - "target": "com.amazonaws.ses#FailureRedirectionURL", - "traits": { - "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " - } - }, "SuccessRedirectionURL": { "target": "com.amazonaws.ses#SuccessRedirectionURL", "traits": { "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

    " } }, + "TemplateName": { + "target": "com.amazonaws.ses#TemplateName", + "traits": { + "smithy.api#documentation": "

    The name of the custom verification email template.

    " + } + }, "TemplateContent": { "target": "com.amazonaws.ses#TemplateContent", "traits": { @@ -2230,10 +2230,10 @@ "smithy.api#documentation": "

    The subject line of the custom verification email.

    " } }, - "TemplateName": { - "target": "com.amazonaws.ses#TemplateName", + "FailureRedirectionURL": { + "target": "com.amazonaws.ses#FailureRedirectionURL", "traits": { - "smithy.api#documentation": "

    The name of the custom verification email template.

    " + "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " } } }, @@ -2470,10 +2470,10 @@ "com.amazonaws.ses#GetSendQuotaResponse": { "type": "structure", "members": { - "SentLast24Hours": { - "target": "com.amazonaws.ses#SentLast24Hours", + "MaxSendRate": { + "target": "com.amazonaws.ses#MaxSendRate", "traits": { - "smithy.api#documentation": "

    The number of emails sent during the previous 24 hours.

    " + "smithy.api#documentation": "

    The maximum number of emails that Amazon SES can accept from the user's account per\n second.

    \n \n

    The rate at which Amazon SES accepts the user's messages might be less than the maximum\n send rate.

    \n     " } }, "Max24HourSend": { @@ -2482,10 +2482,10 @@ "smithy.api#documentation": "

    The maximum number of emails the user is allowed to send in a 24-hour interval. A\n value of -1 signifies an unlimited quota.

    " } }, - "MaxSendRate": { - "target": "com.amazonaws.ses#MaxSendRate", + "SentLast24Hours": { + "target": "com.amazonaws.ses#SentLast24Hours", "traits": { - "smithy.api#documentation": "

    The maximum number of emails that Amazon SES can accept from the user's account per\n second.

    \n \n

    The rate at which Amazon SES accepts the user's messages might be less than the maximum\n send rate.

    \n     " + "smithy.api#documentation": "

    The number of emails sent during the previous 24 hours.

    " } } }, @@ -2574,17 +2574,17 @@ "smithy.api#documentation": "

    A set of character strings that represent the domain's identity. Using these tokens,\n you need to create DNS CNAME records that point to DKIM public keys that are hosted by\n Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection\n process might take up to 72 hours. After successful detection, Amazon SES is able to\n DKIM-sign email originating from that domain. (This only applies to domain identities,\n not email address identities.)

    \n

    For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer\n Guide.

    " } }, - "DkimVerificationStatus": { - "target": "com.amazonaws.ses#VerificationStatus", + "DkimEnabled": { + "target": "com.amazonaws.ses#Enabled", "traits": { - "smithy.api#documentation": "

    Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens)\n published in the domain name's DNS. (This only applies to domain identities, not email\n address identities.)

    ", + "smithy.api#documentation": "

    Is true if DKIM signing is enabled for email sent from the identity. It's false\n otherwise. The default value is true.

    ", "smithy.api#required": {} } }, - "DkimEnabled": { - "target": "com.amazonaws.ses#Enabled", + "DkimVerificationStatus": { + "target": "com.amazonaws.ses#VerificationStatus", "traits": { - "smithy.api#documentation": "

    Is true if DKIM signing is enabled for email sent from the identity. It's false\n otherwise. The default value is true.

    ", + "smithy.api#documentation": "

    Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens)\n published in the domain name's DNS. (This only applies to domain identities, not email\n address identities.)

    ", "smithy.api#required": {} } } @@ -2602,10 +2602,10 @@ "com.amazonaws.ses#IdentityMailFromDomainAttributes": { "type": "structure", "members": { - "MailFromDomainStatus": { - "target": "com.amazonaws.ses#CustomMailFromStatus", + "BehaviorOnMXFailure": { + "target": "com.amazonaws.ses#BehaviorOnMXFailure", "traits": { - "smithy.api#documentation": "

    The state that indicates whether Amazon SES has successfully read the MX record required\n for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the\n specified custom MAIL FROM domain when the verified identity sends an email. All other\n states indicate that Amazon SES takes the action described by\n BehaviorOnMXFailure.

    ", + "smithy.api#documentation": "

    The action that Amazon SES takes if it cannot successfully read the required MX record when\n you send an email. A value of UseDefaultValue indicates that if Amazon SES\n cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as\n the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES\n cannot read the required MX record, Amazon SES returns a\n MailFromDomainNotVerified error and does not send the email.

    \n

    The custom MAIL FROM setup states that result in this behavior are\n Pending, Failed, and TemporaryFailure.

    ", "smithy.api#required": {} } }, @@ -2616,10 +2616,10 @@ "smithy.api#required": {} } }, - "BehaviorOnMXFailure": { - "target": "com.amazonaws.ses#BehaviorOnMXFailure", + "MailFromDomainStatus": { + "target": "com.amazonaws.ses#CustomMailFromStatus", "traits": { - "smithy.api#documentation": "

    The action that Amazon SES takes if it cannot successfully read the required MX record when\n you send an email. A value of UseDefaultValue indicates that if Amazon SES\n cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as\n the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES\n cannot read the required MX record, Amazon SES returns a\n MailFromDomainNotVerified error and does not send the email.

    \n

    The custom MAIL FROM setup states that result in this behavior are\n Pending, Failed, and TemporaryFailure.

    ", + "smithy.api#documentation": "

    The state that indicates whether Amazon SES has successfully read the MX record required\n for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the\n specified custom MAIL FROM domain when the verified identity sends an email. All other\n states indicate that Amazon SES takes the action described by\n BehaviorOnMXFailure.

    ", "smithy.api#required": {} } } @@ -2631,13 +2631,6 @@ "com.amazonaws.ses#IdentityNotificationAttributes": { "type": "structure", "members": { - "ForwardingEnabled": { - "target": "com.amazonaws.ses#Enabled", - "traits": { - "smithy.api#documentation": "

    Describes whether Amazon SES will forward bounce and complaint notifications as email.\n true indicates that Amazon SES will forward bounce and complaint\n notifications as email, while false indicates that bounce and complaint\n notifications will be published only to the specified bounce and complaint Amazon SNS\n topics.

    ", - "smithy.api#required": {} - } - }, "DeliveryTopic": { "target": "com.amazonaws.ses#NotificationTopic", "traits": { @@ -2645,10 +2638,11 @@ "smithy.api#required": {} } }, - "HeadersInDeliveryNotificationsEnabled": { + "ForwardingEnabled": { "target": "com.amazonaws.ses#Enabled", "traits": { - "smithy.api#documentation": "

    Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Delivery. A value of true specifies that Amazon SES will\n include headers in delivery notifications, and a value of false specifies\n that Amazon SES will not include headers in delivery notifications.

    " + "smithy.api#documentation": "

    Describes whether Amazon SES will forward bounce and complaint notifications as email.\n true indicates that Amazon SES will forward bounce and complaint\n notifications as email, while false indicates that bounce and complaint\n notifications will be published only to the specified bounce and complaint Amazon SNS\n topics.

    ", + "smithy.api#required": {} } }, "HeadersInBounceNotificationsEnabled": { @@ -2657,13 +2651,6 @@ "smithy.api#documentation": "

    Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Bounce. A value of true specifies that Amazon SES will include\n headers in bounce notifications, and a value of false specifies that Amazon SES\n will not include headers in bounce notifications.

    " } }, - "BounceTopic": { - "target": "com.amazonaws.ses#NotificationTopic", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce\n notifications.

    ", - "smithy.api#required": {} - } - }, "ComplaintTopic": { "target": "com.amazonaws.ses#NotificationTopic", "traits": { @@ -2676,6 +2663,19 @@ "traits": { "smithy.api#documentation": "

    Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Complaint. A value of true specifies that Amazon SES will\n include headers in complaint notifications, and a value of false specifies\n that Amazon SES will not include headers in complaint notifications.

    " } + }, + "HeadersInDeliveryNotificationsEnabled": { + "target": "com.amazonaws.ses#Enabled", + "traits": { + "smithy.api#documentation": "

    Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Delivery. A value of true specifies that Amazon SES will\n include headers in delivery notifications, and a value of false specifies\n that Amazon SES will not include headers in delivery notifications.

    " + } + }, + "BounceTopic": { + "target": "com.amazonaws.ses#NotificationTopic", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce\n notifications.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -2698,18 +2698,18 @@ "com.amazonaws.ses#IdentityVerificationAttributes": { "type": "structure", "members": { + "VerificationToken": { + "target": "com.amazonaws.ses#VerificationToken", + "traits": { + "smithy.api#documentation": "

    The verification token for a domain identity. Null for email address\n identities.

    " + } + }, "VerificationStatus": { "target": "com.amazonaws.ses#VerificationStatus", "traits": { "smithy.api#documentation": "

    The verification status of the identity: \"Pending\", \"Success\", \"Failed\", or\n \"TemporaryFailure\".

    ", "smithy.api#required": {} } - }, - "VerificationToken": { - "target": "com.amazonaws.ses#VerificationToken", - "traits": { - "smithy.api#documentation": "

    The verification token for a domain identity. Null for email address\n identities.

    " - } } }, "traits": { @@ -2725,14 +2725,14 @@ "smithy.api#documentation": "

    Indicates that the event destination does not exist.

    " } }, - "message": { - "target": "com.amazonaws.ses#ErrorMessage" - }, "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { "smithy.api#documentation": "

    Indicates that the configuration set does not exist.

    " } + }, + "message": { + "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -2776,14 +2776,14 @@ "smithy.api#documentation": "

    Indicates that the event destination does not exist.

    " } }, - "message": { - "target": "com.amazonaws.ses#ErrorMessage" - }, "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { "smithy.api#documentation": "

    Indicates that the configuration set does not exist.

    " } + }, + "message": { + "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -2795,14 +2795,14 @@ "com.amazonaws.ses#InvalidLambdaFunctionException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ses#ErrorMessage" - }, "FunctionArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { "smithy.api#documentation": "

    Indicates that the ARN of the function was not found.

    " } + }, + "message": { + "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -2827,11 +2827,11 @@ "com.amazonaws.ses#InvalidRenderingParameterException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ses#ErrorMessage" - }, "TemplateName": { "target": "com.amazonaws.ses#TemplateName" + }, + "message": { + "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -2865,17 +2865,17 @@ "message": { "target": "com.amazonaws.ses#ErrorMessage" }, - "ConfigurationSetName": { - "target": "com.amazonaws.ses#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "

    Indicates that the configuration set does not exist.

    " - } - }, "EventDestinationName": { "target": "com.amazonaws.ses#EventDestinationName", "traits": { "smithy.api#documentation": "

    Indicates that the event destination does not exist.

    " } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.ses#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "

    Indicates that the configuration set does not exist.

    " + } } }, "traits": { @@ -2887,14 +2887,14 @@ "com.amazonaws.ses#InvalidSnsTopicException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ses#ErrorMessage" - }, "Topic": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { "smithy.api#documentation": "

    Indicates that the topic does not exist.

    " } + }, + "message": { + "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -3028,17 +3028,17 @@ "com.amazonaws.ses#ListConfigurationSetsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ses#NextToken", - "traits": { - "smithy.api#documentation": "

    A token returned from a previous call to ListConfigurationSets to\n indicate the position of the configuration set in the configuration set list.

    " - } - }, "MaxItems": { "target": "com.amazonaws.ses#MaxItems", "traits": { "smithy.api#documentation": "

    The number of configuration sets to return.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ses#NextToken", + "traits": { + "smithy.api#documentation": "

    A token returned from a previous call to ListConfigurationSets to\n indicate the position of the configuration set in the configuration set list.

    " + } } }, "traits": { @@ -3143,12 +3143,6 @@ "com.amazonaws.ses#ListIdentitiesRequest": { "type": "structure", "members": { - "MaxItems": { - "target": "com.amazonaws.ses#MaxItems", - "traits": { - "smithy.api#documentation": "

    The maximum number of identities per page. Possible values are 1-1000\n inclusive.

    " - } - }, "IdentityType": { "target": "com.amazonaws.ses#IdentityType", "traits": { @@ -3160,6 +3154,12 @@ "traits": { "smithy.api#documentation": "

    The token to use for pagination.

    " } + }, + "MaxItems": { + "target": "com.amazonaws.ses#MaxItems", + "traits": { + "smithy.api#documentation": "

    The maximum number of identities per page. Possible values are 1-1000\n inclusive.

    " + } } }, "traits": { @@ -3291,17 +3291,17 @@ "com.amazonaws.ses#ListReceiptRuleSetsResponse": { "type": "structure", "members": { - "RuleSets": { - "target": "com.amazonaws.ses#ReceiptRuleSetsLists", - "traits": { - "smithy.api#documentation": "

    The metadata for the currently active receipt rule set. The metadata consists of the\n rule set name and the timestamp of when the rule set was created.

    " - } - }, "NextToken": { "target": "com.amazonaws.ses#NextToken", "traits": { "smithy.api#documentation": "

    A token indicating that there are additional receipt rule sets available to be listed.\n Pass this token to successive calls of ListReceiptRuleSets to retrieve up\n to 100 receipt rule sets at a time.

    " } + }, + "RuleSets": { + "target": "com.amazonaws.ses#ReceiptRuleSetsLists", + "traits": { + "smithy.api#documentation": "

    The metadata for the currently active receipt rule set. The metadata consists of the\n rule set name and the timestamp of when the rule set was created.

    " + } } }, "traits": { @@ -3323,17 +3323,17 @@ "com.amazonaws.ses#ListTemplatesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ses#NextToken", - "traits": { - "smithy.api#documentation": "

    A token returned from a previous call to ListTemplates to indicate the\n position in the list of email templates.

    " - } - }, "MaxItems": { "target": "com.amazonaws.ses#MaxItems", "traits": { "smithy.api#documentation": "

    The maximum number of templates to return. This value must be at least 1 and less than\n or equal to 10. If you do not specify a value, or if you specify a value less than 1 or\n greater than 10, the operation will return up to 10 results.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ses#NextToken", + "traits": { + "smithy.api#documentation": "

    A token returned from a previous call to ListTemplates to indicate the\n position in the list of email templates.

    " + } } } }, @@ -3427,17 +3427,17 @@ "com.amazonaws.ses#Message": { "type": "structure", "members": { - "Subject": { - "target": "com.amazonaws.ses#Content", + "Body": { + "target": "com.amazonaws.ses#Body", "traits": { - "smithy.api#documentation": "

    The subject of the message: A short summary of the content, which will appear in the\n recipient's inbox.

    ", + "smithy.api#documentation": "

    The message body.

    ", "smithy.api#required": {} } }, - "Body": { - "target": "com.amazonaws.ses#Body", + "Subject": { + "target": "com.amazonaws.ses#Content", "traits": { - "smithy.api#documentation": "

    The message body.

    ", + "smithy.api#documentation": "

    The subject of the message: A short summary of the content, which will appear in the\n recipient's inbox.

    ", "smithy.api#required": {} } } @@ -3452,6 +3452,12 @@ "com.amazonaws.ses#MessageDsn": { "type": "structure", "members": { + "ExtensionFields": { + "target": "com.amazonaws.ses#ExtensionFieldList", + "traits": { + "smithy.api#documentation": "

    Additional X-headers to include in the DSN.

    " + } + }, "ReportingMta": { "target": "com.amazonaws.ses#ReportingMta", "traits": { @@ -3459,12 +3465,6 @@ "smithy.api#required": {} } }, - "ExtensionFields": { - "target": "com.amazonaws.ses#ExtensionFieldList", - "traits": { - "smithy.api#documentation": "

    Additional X-headers to include in the DSN.

    " - } - }, "ArrivalDate": { "target": "com.amazonaws.ses#ArrivalDate", "traits": { @@ -3693,17 +3693,17 @@ "smithy.api#required": {} } }, - "PolicyName": { - "target": "com.amazonaws.ses#PolicyName", + "Identity": { + "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "

    The name of the policy.

    \n

    The policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.

    ", + "smithy.api#documentation": "

    The identity that the policy will apply to. You can specify an identity by using its\n name or by using its Amazon Resource Name (ARN). Examples:\n user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.

    \n

    To successfully call this API, you must own the identity.

    ", "smithy.api#required": {} } }, - "Identity": { - "target": "com.amazonaws.ses#Identity", + "PolicyName": { + "target": "com.amazonaws.ses#PolicyName", "traits": { - "smithy.api#documentation": "

    The identity that the policy will apply to. You can specify an identity by using its\n name or by using its Amazon Resource Name (ARN). Examples:\n user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.

    \n

    To successfully call this API, you must own the identity.

    ", + "smithy.api#documentation": "

    The name of the policy.

    \n

    The policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.

    ", "smithy.api#required": {} } } @@ -3740,22 +3740,22 @@ "com.amazonaws.ses#ReceiptAction": { "type": "structure", "members": { - "WorkmailAction": { - "target": "com.amazonaws.ses#WorkmailAction", + "StopAction": { + "target": "com.amazonaws.ses#StopAction", "traits": { - "smithy.api#documentation": "

    Calls Amazon WorkMail and, optionally, publishes a notification to Amazon\n Amazon SNS.

    " + "smithy.api#documentation": "

    Terminates the evaluation of the receipt rule set and optionally publishes a\n notification to Amazon SNS.

    " } }, - "SNSAction": { - "target": "com.amazonaws.ses#SNSAction", + "S3Action": { + "target": "com.amazonaws.ses#S3Action", "traits": { - "smithy.api#documentation": "

    Publishes the email content within a notification to Amazon SNS.

    " + "smithy.api#documentation": "

    Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a\n notification to Amazon SNS.

    " } }, - "AddHeaderAction": { - "target": "com.amazonaws.ses#AddHeaderAction", + "BounceAction": { + "target": "com.amazonaws.ses#BounceAction", "traits": { - "smithy.api#documentation": "

    Adds a header to the received email.

    " + "smithy.api#documentation": "

    Rejects the received email by returning a bounce response to the sender and,\n optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    " } }, "LambdaAction": { @@ -3764,22 +3764,22 @@ "smithy.api#documentation": "

    Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

    " } }, - "S3Action": { - "target": "com.amazonaws.ses#S3Action", + "AddHeaderAction": { + "target": "com.amazonaws.ses#AddHeaderAction", "traits": { - "smithy.api#documentation": "

    Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a\n notification to Amazon SNS.

    " + "smithy.api#documentation": "

    Adds a header to the received email.

    " } }, - "StopAction": { - "target": "com.amazonaws.ses#StopAction", + "SNSAction": { + "target": "com.amazonaws.ses#SNSAction", "traits": { - "smithy.api#documentation": "

    Terminates the evaluation of the receipt rule set and optionally publishes a\n notification to Amazon SNS.

    " + "smithy.api#documentation": "

    Publishes the email content within a notification to Amazon SNS.

    " } }, - "BounceAction": { - "target": "com.amazonaws.ses#BounceAction", + "WorkmailAction": { + "target": "com.amazonaws.ses#WorkmailAction", "traits": { - "smithy.api#documentation": "

    Rejects the received email by returning a bounce response to the sender and,\n optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    " + "smithy.api#documentation": "

    Calls Amazon WorkMail and, optionally, publishes a notification to Amazon\n Amazon SNS.

    " } } }, @@ -3842,17 +3842,17 @@ "com.amazonaws.ses#ReceiptIpFilter": { "type": "structure", "members": { - "Cidr": { - "target": "com.amazonaws.ses#Cidr", + "Policy": { + "target": "com.amazonaws.ses#ReceiptFilterPolicy", "traits": { - "smithy.api#documentation": "

    A single IP address or a range of IP addresses that you want to block or allow,\n specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single\n email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For\n more information about CIDR notation, see RFC 2317.

    ", + "smithy.api#documentation": "

    Indicates whether to block or allow incoming mail from the specified IP\n addresses.

    ", "smithy.api#required": {} } }, - "Policy": { - "target": "com.amazonaws.ses#ReceiptFilterPolicy", + "Cidr": { + "target": "com.amazonaws.ses#Cidr", "traits": { - "smithy.api#documentation": "

    Indicates whether to block or allow incoming mail from the specified IP\n addresses.

    ", + "smithy.api#documentation": "

    A single IP address or a range of IP addresses that you want to block or allow,\n specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single\n email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For\n more information about CIDR notation, see RFC 2317.

    ", "smithy.api#required": {} } } @@ -3864,12 +3864,25 @@ "com.amazonaws.ses#ReceiptRule": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.ses#ReceiptRuleName", + "traits": { + "smithy.api#documentation": "

    The name of the receipt rule. The name must:

    \n
      \n
    • \n

      This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).

      \n
      • \n
    • \n

      Start and end with a letter or number.

      \n
      • \n
    • \n

      Contain less than 64 characters.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, "Actions": { "target": "com.amazonaws.ses#ReceiptActionsList", "traits": { "smithy.api#documentation": "

    An ordered list of actions to perform on messages that match at least one of the\n recipient email addresses or domains specified in the receipt rule.

    " } }, + "TlsPolicy": { + "target": "com.amazonaws.ses#TlsPolicy", + "traits": { + "smithy.api#documentation": "

    Specifies whether Amazon SES should require that incoming email is delivered over a\n connection encrypted with Transport Layer Security (TLS). If this parameter is set to\n Require, Amazon SES will bounce emails that are not received over TLS. The\n default is Optional.

    " + } + }, "Enabled": { "target": "com.amazonaws.ses#Enabled", "traits": { @@ -3887,19 +3900,6 @@ "traits": { "smithy.api#documentation": "

    The recipient domains and email addresses that the receipt rule applies to. If this\n field is not specified, this rule will match all recipients under all verified\n domains.

    " } - }, - "TlsPolicy": { - "target": "com.amazonaws.ses#TlsPolicy", - "traits": { - "smithy.api#documentation": "

    Specifies whether Amazon SES should require that incoming email is delivered over a\n connection encrypted with Transport Layer Security (TLS). If this parameter is set to\n Require, Amazon SES will bounce emails that are not received over TLS. The\n default is Optional.

    " - } - }, - "Name": { - "target": "com.amazonaws.ses#ReceiptRuleName", - "traits": { - "smithy.api#documentation": "

    The name of the receipt rule. The name must:

    \n
      \n
    • \n

      This value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).

      \n
      • \n
    • \n

      Start and end with a letter or number.

      \n
      • \n
    • \n

      Contain less than 64 characters.

      \n
      • \n
    ", - "smithy.api#required": {} - } } }, "traits": { @@ -3962,11 +3962,10 @@ "smithy.api#documentation": "

    The time the final delivery attempt was made, in RFC 822 date-time format.

    " } }, - "Status": { - "target": "com.amazonaws.ses#DsnStatus", + "DiagnosticCode": { + "target": "com.amazonaws.ses#DiagnosticCode", "traits": { - "smithy.api#documentation": "

    The status code that indicates what went wrong. This is required by RFC 3464.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An extended explanation of what went wrong; this is usually an SMTP response. See\n RFC 3463 for the correct\n formatting of this parameter.

    " } }, "FinalRecipient": { @@ -3975,16 +3974,11 @@ "smithy.api#documentation": "

    The email address that the message was ultimately delivered to. This corresponds to\n the Final-Recipient in the DSN. If not specified,\n FinalRecipient will be set to the Recipient specified in\n the BouncedRecipientInfo structure. Either FinalRecipient or\n the recipient in BouncedRecipientInfo must be a recipient of the original\n bounced message.

    \n \n

    Do not prepend the FinalRecipient email address with rfc\n 822;, as described in RFC 3798.

    \n     " } }, - "DiagnosticCode": { - "target": "com.amazonaws.ses#DiagnosticCode", - "traits": { - "smithy.api#documentation": "

    An extended explanation of what went wrong; this is usually an SMTP response. See\n RFC 3463 for the correct\n formatting of this parameter.

    " - } - }, - "ExtensionFields": { - "target": "com.amazonaws.ses#ExtensionFieldList", + "Action": { + "target": "com.amazonaws.ses#DsnAction", "traits": { - "smithy.api#documentation": "

    Additional X-headers to include in the DSN.

    " + "smithy.api#documentation": "

    The action performed by the reporting mail transfer agent (MTA) as a result of its\n attempt to deliver the message to the recipient address. This is required by RFC 3464.

    ", + "smithy.api#required": {} } }, "RemoteMta": { @@ -3993,12 +3987,18 @@ "smithy.api#documentation": "

    The MTA to which the remote MTA attempted to deliver the message, formatted as\n specified in RFC 3464\n (mta-name-type; mta-name). This parameter typically applies only to\n propagating synchronous bounces.

    " } }, - "Action": { - "target": "com.amazonaws.ses#DsnAction", + "Status": { + "target": "com.amazonaws.ses#DsnStatus", "traits": { - "smithy.api#documentation": "

    The action performed by the reporting mail transfer agent (MTA) as a result of its\n attempt to deliver the message to the recipient address. This is required by RFC 3464.

    ", + "smithy.api#documentation": "

    The status code that indicates what went wrong. This is required by RFC 3464.

    ", "smithy.api#required": {} } + }, + "ExtensionFields": { + "target": "com.amazonaws.ses#ExtensionFieldList", + "traits": { + "smithy.api#documentation": "

    Additional X-headers to include in the DSN.

    " + } } }, "traits": { @@ -4078,17 +4078,17 @@ "smithy.api#documentation": "

    Describes whether email sending is enabled or disabled for the configuration set. If\n the value is true, then Amazon SES will send emails that use the configuration\n set. If the value is false, Amazon SES will not send emails that use the\n configuration set. The default value is true. You can change this setting\n using UpdateConfigurationSetSendingEnabled.

    " } }, - "LastFreshStart": { - "target": "com.amazonaws.ses#LastFreshStart", - "traits": { - "smithy.api#documentation": "

    The date and time at which the reputation metrics for the configuration set were last\n reset. Resetting these metrics is known as a fresh start.

    \n

    When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the\n reputation metrics for the configuration set (but not for the entire Amazon SES account) are\n reset.

    \n

    If email sending for the configuration set has never been disabled and later\n re-enabled, the value of this attribute is null.

    " - } - }, "ReputationMetricsEnabled": { "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#documentation": "

    Describes whether or not Amazon SES publishes reputation metrics for the configuration set,\n such as bounce and complaint rates, to Amazon CloudWatch.

    \n

    If the value is true, reputation metrics are published. If the value is\n false, reputation metrics are not published. The default value is\n false.

    " } + }, + "LastFreshStart": { + "target": "com.amazonaws.ses#LastFreshStart", + "traits": { + "smithy.api#documentation": "

    The date and time at which the reputation metrics for the configuration set were last\n reset. Resetting these metrics is known as a fresh start.

    \n

    When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the\n reputation metrics for the configuration set (but not for the entire Amazon SES account) are\n reset.

    \n

    If email sending for the configuration set has never been disabled and later\n re-enabled, the value of this attribute is null.

    " + } } }, "traits": { @@ -4098,14 +4098,14 @@ "com.amazonaws.ses#RuleDoesNotExistException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.ses#ErrorMessage" - }, "Name": { "target": "com.amazonaws.ses#RuleOrRuleSetName", "traits": { "smithy.api#documentation": "

    Indicates that the named receipt rule does not exist.

    " } + }, + "message": { + "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -4120,14 +4120,14 @@ "com.amazonaws.ses#RuleSetDoesNotExistException": { "type": "structure", "members": { + "message": { + "target": "com.amazonaws.ses#ErrorMessage" + }, "Name": { "target": "com.amazonaws.ses#RuleOrRuleSetName", "traits": { "smithy.api#documentation": "

    Indicates that the named receipt rule set does not exist.

    " } - }, - "message": { - "target": "com.amazonaws.ses#ErrorMessage" } }, "traits": { @@ -4146,10 +4146,10 @@ "smithy.api#required": {} } }, - "KmsKeyArn": { - "target": "com.amazonaws.ses#AmazonResourceName", + "ObjectKeyPrefix": { + "target": "com.amazonaws.ses#S3KeyPrefix", "traits": { - "smithy.api#documentation": "

    The customer master key that Amazon SES should use to encrypt your emails before saving\n them to the Amazon S3 bucket. You can use the default master key or a custom master key you\n created in AWS KMS as follows:

    \n
      \n
    • \n

      To use the default master key, provide an ARN in the form of\n arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses.\n For example, if your AWS account ID is 123456789012 and you want to use the\n default master key in the US West (Oregon) region, the ARN of the default master\n key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If\n you use the default master key, you don't need to perform any extra steps to\n give Amazon SES permission to use the key.

      \n
      • \n
    • \n

      To use a custom master key you created in AWS KMS, provide the ARN of the\n master key and ensure that you add a statement to your key's policy to give\n Amazon SES permission to use it. For more information about giving permissions, see\n the Amazon SES\n Developer Guide.

      \n
      • \n
    \n

    For more information about key policies, see the AWS KMS Developer Guide. If\n you do not specify a master key, Amazon SES will not encrypt your emails.

    \n \n

    Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail\n is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side\n encryption. This means that you must use the Amazon S3 encryption client to decrypt the\n email after retrieving it from Amazon S3, as the service has no access to use your AWS\n KMS keys for decryption. This encryption client is currently available with the\n AWS SDK for Java and AWS SDK for Ruby only. For more\n information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

    \n     " + "smithy.api#documentation": "

    The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that\n enables you to store similar data under the same directory in a bucket.

    " } }, "TopicArn": { @@ -4158,10 +4158,10 @@ "smithy.api#documentation": "

    The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An\n example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.

    " } }, - "ObjectKeyPrefix": { - "target": "com.amazonaws.ses#S3KeyPrefix", + "KmsKeyArn": { + "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that\n enables you to store similar data under the same directory in a bucket.

    " + "smithy.api#documentation": "

    The customer master key that Amazon SES should use to encrypt your emails before saving\n them to the Amazon S3 bucket. You can use the default master key or a custom master key you\n created in AWS KMS as follows:

    \n
      \n
    • \n

      To use the default master key, provide an ARN in the form of\n arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses.\n For example, if your AWS account ID is 123456789012 and you want to use the\n default master key in the US West (Oregon) region, the ARN of the default master\n key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If\n you use the default master key, you don't need to perform any extra steps to\n give Amazon SES permission to use the key.

      \n
      • \n
    • \n

      To use a custom master key you created in AWS KMS, provide the ARN of the\n master key and ensure that you add a statement to your key's policy to give\n Amazon SES permission to use it. For more information about giving permissions, see\n the Amazon SES\n Developer Guide.

      \n
      • \n
    \n

    For more information about key policies, see the AWS KMS Developer Guide. If\n you do not specify a master key, Amazon SES will not encrypt your emails.

    \n \n

    Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail\n is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side\n encryption. This means that you must use the Amazon S3 encryption client to decrypt the\n email after retrieving it from Amazon S3, as the service has no access to use your AWS\n KMS keys for decryption. This encryption client is currently available with the\n AWS SDK for Java and AWS SDK for Ruby only. For more\n information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

    \n     " } } }, @@ -4178,18 +4178,18 @@ "com.amazonaws.ses#SNSAction": { "type": "structure", "members": { + "Encoding": { + "target": "com.amazonaws.ses#SNSActionEncoding", + "traits": { + "smithy.api#documentation": "

    The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to\n use, but may not preserve all special characters when a message was encoded with a\n different encoding format. Base64 preserves all special characters. The default value is\n UTF-8.

    " + } + }, "TopicArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS\n topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more\n information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    ", "smithy.api#required": {} } - }, - "Encoding": { - "target": "com.amazonaws.ses#SNSActionEncoding", - "traits": { - "smithy.api#documentation": "

    The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to\n use, but may not preserve all special characters when a message was encoded with a\n different encoding format. Base64 preserves all special characters. The default value is\n UTF-8.

    " - } } }, "traits": { @@ -4246,6 +4246,12 @@ "com.amazonaws.ses#SendBounceRequest": { "type": "structure", "members": { + "BounceSenderArn": { + "target": "com.amazonaws.ses#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n address in the \"From\" header of the bounce. For more information about sending\n authorization, see the Amazon SES Developer\n Guide.

    " + } + }, "OriginalMessageId": { "target": "com.amazonaws.ses#MessageId", "traits": { @@ -4253,12 +4259,6 @@ "smithy.api#required": {} } }, - "MessageDsn": { - "target": "com.amazonaws.ses#MessageDsn", - "traits": { - "smithy.api#documentation": "

    Message-related DSN fields. If not specified, Amazon SES will choose the values.

    " - } - }, "BounceSender": { "target": "com.amazonaws.ses#Address", "traits": { @@ -4266,11 +4266,10 @@ "smithy.api#required": {} } }, - "BouncedRecipientInfoList": { - "target": "com.amazonaws.ses#BouncedRecipientInfoList", + "MessageDsn": { + "target": "com.amazonaws.ses#MessageDsn", "traits": { - "smithy.api#documentation": "

    A list of recipients of the bounced message, including the information required to\n create the Delivery Status Notifications (DSNs) for the recipients. You must specify at\n least one BouncedRecipientInfo in the list.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Message-related DSN fields. If not specified, Amazon SES will choose the values.

    " } }, "Explanation": { @@ -4279,10 +4278,11 @@ "smithy.api#documentation": "

    Human-readable text for the bounce message to explain the failure. If not specified,\n the text will be auto-generated based on the bounced recipient information.

    " } }, - "BounceSenderArn": { - "target": "com.amazonaws.ses#AmazonResourceName", + "BouncedRecipientInfoList": { + "target": "com.amazonaws.ses#BouncedRecipientInfoList", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n address in the \"From\" header of the bounce. For more information about sending\n authorization, see the Amazon SES Developer\n Guide.

    " + "smithy.api#documentation": "

    A list of recipients of the bounced message, including the information required to\n create the Delivery Status Notifications (DSNs) for the recipients. You must specify at\n least one BouncedRecipientInfo in the list.

    ", + "smithy.api#required": {} } } }, @@ -4339,12 +4339,6 @@ "com.amazonaws.ses#SendBulkTemplatedEmailRequest": { "type": "structure", "members": { - "TemplateArn": { - "target": "com.amazonaws.ses#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

    The ARN of the template to use when sending this email.

    " - } - }, "ReturnPathArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { @@ -4357,17 +4351,28 @@ "smithy.api#documentation": "

    The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.

    " } }, + "TemplateArn": { + "target": "com.amazonaws.ses#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    The ARN of the template to use when sending this email.

    " + } + }, "DefaultTemplateData": { "target": "com.amazonaws.ses#TemplateData", "traits": { "smithy.api#documentation": "

    A list of replacement values to apply to the template when replacement data is not\n specified in a Destination object. These values act as a default or fallback option when\n no other data is available.

    \n

    The template data is a JSON object, typically consisting of key-value pairs in which\n the keys correspond to replacement tags in the email template.

    " } }, - "Template": { - "target": "com.amazonaws.ses#TemplateName", + "SourceArn": { + "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The template to use when sending this email.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " + } + }, + "DefaultTags": { + "target": "com.amazonaws.ses#MessageTagList", + "traits": { + "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send to\n a destination using SendBulkTemplatedEmail.

    " } }, "ConfigurationSetName": { @@ -4389,12 +4394,6 @@ "smithy.api#required": {} } }, - "DefaultTags": { - "target": "com.amazonaws.ses#MessageTagList", - "traits": { - "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send to\n a destination using SendBulkTemplatedEmail.

    " - } - }, "Source": { "target": "com.amazonaws.ses#Address", "traits": { @@ -4402,10 +4401,11 @@ "smithy.api#required": {} } }, - "SourceArn": { - "target": "com.amazonaws.ses#AmazonResourceName", + "Template": { + "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " + "smithy.api#documentation": "

    The template to use when sending this email.

    ", + "smithy.api#required": {} } } }, @@ -4499,22 +4499,22 @@ "com.amazonaws.ses#SendDataPoint": { "type": "structure", "members": { - "Rejects": { + "Complaints": { "target": "com.amazonaws.ses#Counter", "traits": { - "smithy.api#documentation": "

    Number of emails rejected by Amazon SES.

    " + "smithy.api#documentation": "

    Number of unwanted emails that were rejected by recipients.

    " } }, - "DeliveryAttempts": { + "Bounces": { "target": "com.amazonaws.ses#Counter", "traits": { - "smithy.api#documentation": "

    Number of emails that have been sent.

    " + "smithy.api#documentation": "

    Number of emails that have bounced.

    " } }, - "Bounces": { + "Rejects": { "target": "com.amazonaws.ses#Counter", "traits": { - "smithy.api#documentation": "

    Number of emails that have bounced.

    " + "smithy.api#documentation": "

    Number of emails rejected by Amazon SES.

    " } }, "Timestamp": { @@ -4523,10 +4523,10 @@ "smithy.api#documentation": "

    Time of the data point.

    " } }, - "Complaints": { + "DeliveryAttempts": { "target": "com.amazonaws.ses#Counter", "traits": { - "smithy.api#documentation": "

    Number of unwanted emails that were rejected by recipients.

    " + "smithy.api#documentation": "

    Number of emails that have been sent.

    " } } }, @@ -4578,6 +4578,12 @@ "smithy.api#documentation": "

    The reply-to email address(es) for the message. If the recipient replies to the\n message, each reply-to address will receive the reply.

    " } }, + "ConfigurationSetName": { + "target": "com.amazonaws.ses#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "

    The name of the configuration set to use when you send an email using\n SendEmail.

    " + } + }, "Source": { "target": "com.amazonaws.ses#Address", "traits": { @@ -4585,28 +4591,29 @@ "smithy.api#required": {} } }, - "SourceArn": { - "target": "com.amazonaws.ses#AmazonResourceName", + "Tags": { + "target": "com.amazonaws.ses#MessageTagList", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " + "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using SendEmail. Tags correspond to characteristics of the email that you\n define, so that you can publish email sending events.

    " } }, - "ConfigurationSetName": { - "target": "com.amazonaws.ses#ConfigurationSetName", + "ReturnPathArn": { + "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The name of the configuration set to use when you send an email using\n SendEmail.

    " + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " } }, - "Tags": { - "target": "com.amazonaws.ses#MessageTagList", + "Destination": { + "target": "com.amazonaws.ses#Destination", "traits": { - "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using SendEmail. Tags correspond to characteristics of the email that you\n define, so that you can publish email sending events.

    " + "smithy.api#documentation": "

    The destination for this email, composed of To:, CC:, and BCC: fields.

    ", + "smithy.api#required": {} } }, - "ReturnPath": { - "target": "com.amazonaws.ses#Address", + "SourceArn": { + "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.

    " + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " } }, "Message": { @@ -4616,17 +4623,10 @@ "smithy.api#required": {} } }, - "ReturnPathArn": { - "target": "com.amazonaws.ses#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " - } - }, - "Destination": { - "target": "com.amazonaws.ses#Destination", + "ReturnPath": { + "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "

    The destination for this email, composed of To:, CC:, and BCC: fields.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.

    " } } }, @@ -4681,12 +4681,6 @@ "com.amazonaws.ses#SendRawEmailRequest": { "type": "structure", "members": { - "SourceArn": { - "target": "com.amazonaws.ses#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.

    \n

    Instead of using this parameter, you can use the X-header\n X-SES-SOURCE-ARN in the raw message of the email. If you use both the\n SourceArn parameter and the corresponding X-header, Amazon SES uses the\n value of the SourceArn parameter.

    \n \n

    For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    \n     " - } - }, "RawMessage": { "target": "com.amazonaws.ses#RawMessage", "traits": { @@ -4694,22 +4688,22 @@ "smithy.api#required": {} } }, - "FromArn": { + "SourceArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to specify a\n particular \"From\" address in the header of the raw email.

    \n

    Instead of using this parameter, you can use the X-header X-SES-FROM-ARN\n in the raw message of the email. If you use both the FromArn parameter and\n the corresponding X-header, Amazon SES uses the value of the FromArn\n parameter.

    \n \n

    For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    \n     " + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.

    \n

    Instead of using this parameter, you can use the X-header\n X-SES-SOURCE-ARN in the raw message of the email. If you use both the\n SourceArn parameter and the corresponding X-header, Amazon SES uses the\n value of the SourceArn parameter.

    \n \n

    For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    \n     " } }, - "Destinations": { - "target": "com.amazonaws.ses#AddressList", + "FromArn": { + "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    A list of destinations for the message, consisting of To:, CC:, and BCC:\n addresses.

    " + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to specify a\n particular \"From\" address in the header of the raw email.

    \n

    Instead of using this parameter, you can use the X-header X-SES-FROM-ARN\n in the raw message of the email. If you use both the FromArn parameter and\n the corresponding X-header, Amazon SES uses the value of the FromArn\n parameter.

    \n \n

    For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    \n     " } }, - "Source": { - "target": "com.amazonaws.ses#Address", + "ReturnPathArn": { + "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The identity's email address. If you do not provide a value for this parameter, you\n must specify a \"From\" address in the raw text of the message. (You can also specify\n both.)

    \n \n

    Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the\n local part of a source email address (the part of the email\n address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492. The sender name (also known as the friendly\n name) may contain non-ASCII characters. These characters must be\n encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word\n syntax uses the following form:\n =?charset?encoding?encoded-text?=.

    \n     \n\n

    If you specify the Source parameter and have feedback forwarding enabled,\n then bounces and complaints will be sent to this email address. This takes precedence\n over any Return-Path header that you might include in the raw text of the\n message.

    " + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.

    \n

    Instead of using this parameter, you can use the X-header\n X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both\n the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the\n value of the ReturnPathArn parameter.

    \n \n

    For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    \n     " } }, "Tags": { @@ -4718,10 +4712,10 @@ "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using SendRawEmail. Tags correspond to characteristics of the email that\n you define, so that you can publish email sending events.

    " } }, - "ReturnPathArn": { - "target": "com.amazonaws.ses#AmazonResourceName", + "Source": { + "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.

    \n

    Instead of using this parameter, you can use the X-header\n X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both\n the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the\n value of the ReturnPathArn parameter.

    \n \n

    For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    \n     " + "smithy.api#documentation": "

    The identity's email address. If you do not provide a value for this parameter, you\n must specify a \"From\" address in the raw text of the message. (You can also specify\n both.)

    \n \n

    Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the\n local part of a source email address (the part of the email\n address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492. The sender name (also known as the friendly\n name) may contain non-ASCII characters. These characters must be\n encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word\n syntax uses the following form:\n =?charset?encoding?encoded-text?=.

    \n     \n\n

    If you specify the Source parameter and have feedback forwarding enabled,\n then bounces and complaints will be sent to this email address. This takes precedence\n over any Return-Path header that you might include in the raw text of the\n message.

    " } }, "ConfigurationSetName": { @@ -4729,6 +4723,12 @@ "traits": { "smithy.api#documentation": "

    The name of the configuration set to use when you send an email using\n SendRawEmail.

    " } + }, + "Destinations": { + "target": "com.amazonaws.ses#AddressList", + "traits": { + "smithy.api#documentation": "

    A list of destinations for the message, consisting of To:, CC:, and BCC:\n addresses.

    " + } } }, "traits": { @@ -4798,6 +4798,13 @@ "smithy.api#required": {} } }, + "TemplateData": { + "target": "com.amazonaws.ses#TemplateData", + "traits": { + "smithy.api#documentation": "

    A list of replacement values to apply to the template. This parameter is a JSON\n object, typically consisting of key-value pairs in which the keys correspond to\n replacement tags in the email template.

    ", + "smithy.api#required": {} + } + }, "Template": { "target": "com.amazonaws.ses#TemplateName", "traits": { @@ -4805,16 +4812,17 @@ "smithy.api#required": {} } }, - "ConfigurationSetName": { - "target": "com.amazonaws.ses#ConfigurationSetName", + "Destination": { + "target": "com.amazonaws.ses#Destination", "traits": { - "smithy.api#documentation": "

    The name of the configuration set to use when you send an email using\n SendTemplatedEmail.

    " + "smithy.api#documentation": "

    The destination for this email, composed of To:, CC:, and BCC: fields. A Destination\n can include up to 50 recipients across these three fields.

    ", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.ses#MessageTagList", + "ReturnPathArn": { + "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using SendTemplatedEmail. Tags correspond to characteristics of the email\n that you define, so that you can publish email sending events.

    " + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " } }, "TemplateArn": { @@ -4823,17 +4831,16 @@ "smithy.api#documentation": "

    The ARN of the template to use when sending this email.

    " } }, - "ReturnPathArn": { - "target": "com.amazonaws.ses#AmazonResourceName", + "Tags": { + "target": "com.amazonaws.ses#MessageTagList", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " + "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using SendTemplatedEmail. Tags correspond to characteristics of the email\n that you define, so that you can publish email sending events.

    " } }, - "Destination": { - "target": "com.amazonaws.ses#Destination", + "ReturnPath": { + "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "

    The destination for this email, composed of To:, CC:, and BCC: fields. A Destination\n can include up to 50 recipients across these three fields.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.

    " } }, "SourceArn": { @@ -4842,17 +4849,10 @@ "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " } }, - "TemplateData": { - "target": "com.amazonaws.ses#TemplateData", - "traits": { - "smithy.api#documentation": "

    A list of replacement values to apply to the template. This parameter is a JSON\n object, typically consisting of key-value pairs in which the keys correspond to\n replacement tags in the email template.

    ", - "smithy.api#required": {} - } - }, - "ReturnPath": { - "target": "com.amazonaws.ses#Address", + "ConfigurationSetName": { + "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "

    The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.

    " + "smithy.api#documentation": "

    The name of the configuration set to use when you send an email using\n SendTemplatedEmail.

    " } } }, @@ -4969,17 +4969,17 @@ "com.amazonaws.ses#SetIdentityFeedbackForwardingEnabledRequest": { "type": "structure", "members": { - "Identity": { - "target": "com.amazonaws.ses#Identity", + "ForwardingEnabled": { + "target": "com.amazonaws.ses#Enabled", "traits": { - "smithy.api#documentation": "

    The identity for which to set bounce and complaint notification forwarding. Examples:\n user@example.com, example.com.

    ", + "smithy.api#documentation": "

    Sets whether Amazon SES will forward bounce and complaint notifications as email.\n true specifies that Amazon SES will forward bounce and complaint\n notifications as email, in addition to any Amazon SNS topic publishing otherwise specified.\n false specifies that Amazon SES will publish bounce and complaint\n notifications only through Amazon SNS. This value can only be set to false when\n Amazon SNS topics are set for both Bounce and Complaint\n notification types.

    ", "smithy.api#required": {} } }, - "ForwardingEnabled": { - "target": "com.amazonaws.ses#Enabled", + "Identity": { + "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "

    Sets whether Amazon SES will forward bounce and complaint notifications as email.\n true specifies that Amazon SES will forward bounce and complaint\n notifications as email, in addition to any Amazon SNS topic publishing otherwise specified.\n false specifies that Amazon SES will publish bounce and complaint\n notifications only through Amazon SNS. This value can only be set to false when\n Amazon SNS topics are set for both Bounce and Complaint\n notification types.

    ", + "smithy.api#documentation": "

    The identity for which to set bounce and complaint notification forwarding. Examples:\n user@example.com, example.com.

    ", "smithy.api#required": {} } } @@ -5010,10 +5010,10 @@ "com.amazonaws.ses#SetIdentityHeadersInNotificationsEnabledRequest": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.ses#Enabled", + "Identity": { + "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "

    Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the\n specified notification type. A value of true specifies that Amazon SES will\n include headers in notifications, and a value of false specifies that Amazon SES\n will not include headers in notifications.

    \n

    This value can only be set when NotificationType is already set to use a\n particular Amazon SNS topic.

    ", + "smithy.api#documentation": "

    The identity for which to enable or disable headers in notifications. Examples:\n user@example.com, example.com.

    ", "smithy.api#required": {} } }, @@ -5024,10 +5024,10 @@ "smithy.api#required": {} } }, - "Identity": { - "target": "com.amazonaws.ses#Identity", + "Enabled": { + "target": "com.amazonaws.ses#Enabled", "traits": { - "smithy.api#documentation": "

    The identity for which to enable or disable headers in notifications. Examples:\n user@example.com, example.com.

    ", + "smithy.api#documentation": "

    Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the\n specified notification type. A value of true specifies that Amazon SES will\n include headers in notifications, and a value of false specifies that Amazon SES\n will not include headers in notifications.

    \n

    This value can only be set when NotificationType is already set to use a\n particular Amazon SNS topic.

    ", "smithy.api#required": {} } } @@ -5058,11 +5058,10 @@ "com.amazonaws.ses#SetIdentityMailFromDomainRequest": { "type": "structure", "members": { - "Identity": { - "target": "com.amazonaws.ses#Identity", + "MailFromDomain": { + "target": "com.amazonaws.ses#MailFromDomainName", "traits": { - "smithy.api#documentation": "

    The verified identity for which you want to enable or disable the specified custom\n MAIL FROM domain.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM\n domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\"\n address if the MAIL FROM domain is the destination of email feedback forwarding (for\n more information, see the Amazon SES Developer Guide), and\n 3) not be used to receive emails. A value of null disables the custom MAIL\n FROM setting for the identity.

    " } }, "BehaviorOnMXFailure": { @@ -5071,10 +5070,11 @@ "smithy.api#documentation": "

    The action that you want Amazon SES to take if it cannot successfully read the required MX\n record when you send an email. If you choose UseDefaultValue, Amazon SES will\n use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose\n RejectMessage, Amazon SES will return a\n MailFromDomainNotVerified error and not send the email.

    \n

    The action specified in BehaviorOnMXFailure is taken when the custom MAIL\n FROM domain setup is in the Pending, Failed, and\n TemporaryFailure states.

    " } }, - "MailFromDomain": { - "target": "com.amazonaws.ses#MailFromDomainName", + "Identity": { + "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "

    The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM\n domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\"\n address if the MAIL FROM domain is the destination of email feedback forwarding (for\n more information, see the Amazon SES Developer Guide), and\n 3) not be used to receive emails. A value of null disables the custom MAIL\n FROM setting for the identity.

    " + "smithy.api#documentation": "

    The verified identity for which you want to enable or disable the specified custom\n MAIL FROM domain.

    ", + "smithy.api#required": {} } } }, @@ -5166,18 +5166,18 @@ "smithy.api#required": {} } }, - "After": { - "target": "com.amazonaws.ses#ReceiptRuleName", - "traits": { - "smithy.api#documentation": "

    The name of the receipt rule after which to place the specified receipt rule.

    " - } - }, "RuleSetName": { "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { "smithy.api#documentation": "

    The name of the receipt rule set that contains the receipt rule to reposition.

    ", "smithy.api#required": {} } + }, + "After": { + "target": "com.amazonaws.ses#ReceiptRuleName", + "traits": { + "smithy.api#documentation": "

    The name of the receipt rule after which to place the specified receipt rule.

    " + } } }, "traits": { @@ -5414,7 +5414,7 @@ "sdkId": "SES", "arnNamespace": "ses", "cloudFormationName": "SES", - "cloudTrailEventSource": "svc.frontend.bacon.amazon.com" + "cloudTrailEventSource": "ses.amazonaws.com" }, "aws.auth#sigv4": { "name": "ses" @@ -5430,18 +5430,18 @@ "com.amazonaws.ses#StopAction": { "type": "structure", "members": { + "TopicArn": { + "target": "com.amazonaws.ses#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is\n taken. An example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + } + }, "Scope": { "target": "com.amazonaws.ses#StopScope", "traits": { "smithy.api#documentation": "

    The scope of the StopAction. The only acceptable value is RuleSet.

    ", "smithy.api#required": {} } - }, - "TopicArn": { - "target": "com.amazonaws.ses#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is\n taken. An example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.

    " - } } }, "traits": { @@ -5471,10 +5471,10 @@ "com.amazonaws.ses#Template": { "type": "structure", "members": { - "HtmlPart": { - "target": "com.amazonaws.ses#HtmlPart", + "TextPart": { + "target": "com.amazonaws.ses#TextPart", "traits": { - "smithy.api#documentation": "

    The HTML body of the email.

    " + "smithy.api#documentation": "

    The email body that will be visible to recipients whose email clients do not display\n HTML.

    " } }, "SubjectPart": { @@ -5483,18 +5483,18 @@ "smithy.api#documentation": "

    The subject line of the email.

    " } }, - "TextPart": { - "target": "com.amazonaws.ses#TextPart", - "traits": { - "smithy.api#documentation": "

    The email body that will be visible to recipients whose email clients do not display\n HTML.

    " - } - }, "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { "smithy.api#documentation": "

    The name of the template. You will refer to this name when you send email using the\n SendTemplatedEmail or SendBulkTemplatedEmail\n operations.

    ", "smithy.api#required": {} } + }, + "HtmlPart": { + "target": "com.amazonaws.ses#HtmlPart", + "traits": { + "smithy.api#documentation": "

    The HTML body of the email.

    " + } } }, "traits": { @@ -5516,11 +5516,11 @@ "com.amazonaws.ses#TemplateDoesNotExistException": { "type": "structure", "members": { - "TemplateName": { - "target": "com.amazonaws.ses#TemplateName" - }, "message": { "target": "com.amazonaws.ses#ErrorMessage" + }, + "TemplateName": { + "target": "com.amazonaws.ses#TemplateName" } }, "traits": { @@ -5739,17 +5739,17 @@ "com.amazonaws.ses#UpdateConfigurationSetEventDestinationRequest": { "type": "structure", "members": { - "EventDestination": { - "target": "com.amazonaws.ses#EventDestination", + "ConfigurationSetName": { + "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "

    The event destination object that you want to apply to the specified configuration\n set.

    ", + "smithy.api#documentation": "

    The name of the configuration set that contains the event destination that you want to\n update.

    ", "smithy.api#required": {} } }, - "ConfigurationSetName": { - "target": "com.amazonaws.ses#ConfigurationSetName", + "EventDestination": { + "target": "com.amazonaws.ses#EventDestination", "traits": { - "smithy.api#documentation": "

    The name of the configuration set that contains the event destination that you want to\n update.

    ", + "smithy.api#documentation": "

    The event destination object that you want to apply to the specified configuration\n set.

    ", "smithy.api#required": {} } } @@ -5782,17 +5782,17 @@ "com.amazonaws.ses#UpdateConfigurationSetReputationMetricsEnabledRequest": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.ses#ConfigurationSetName", + "Enabled": { + "target": "com.amazonaws.ses#Enabled", "traits": { - "smithy.api#documentation": "

    The name of the configuration set that you want to update.

    ", + "smithy.api#documentation": "

    Describes whether or not Amazon SES will publish reputation metrics for the configuration\n set, such as bounce and complaint rates, to Amazon CloudWatch.

    ", "smithy.api#required": {} } }, - "Enabled": { - "target": "com.amazonaws.ses#Enabled", + "ConfigurationSetName": { + "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "

    Describes whether or not Amazon SES will publish reputation metrics for the configuration\n set, such as bounce and complaint rates, to Amazon CloudWatch.

    ", + "smithy.api#documentation": "

    The name of the configuration set that you want to update.

    ", "smithy.api#required": {} } } @@ -5863,16 +5863,16 @@ "com.amazonaws.ses#UpdateConfigurationSetTrackingOptionsRequest": { "type": "structure", "members": { - "TrackingOptions": { - "target": "com.amazonaws.ses#TrackingOptions", + "ConfigurationSetName": { + "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { + "smithy.api#documentation": "

    The name of the configuration set for which you want to update the custom tracking\n domain.

    ", "smithy.api#required": {} } }, - "ConfigurationSetName": { - "target": "com.amazonaws.ses#ConfigurationSetName", + "TrackingOptions": { + "target": "com.amazonaws.ses#TrackingOptions", "traits": { - "smithy.api#documentation": "

    The name of the configuration set for which you want to update the custom tracking\n domain.

    ", "smithy.api#required": {} } } @@ -5911,10 +5911,11 @@ "com.amazonaws.ses#UpdateCustomVerificationEmailTemplateRequest": { "type": "structure", "members": { - "TemplateContent": { - "target": "com.amazonaws.ses#TemplateContent", + "TemplateName": { + "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "

    The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.

    " + "smithy.api#documentation": "

    The name of the custom verification email template that you want to update.

    ", + "smithy.api#required": {} } }, "TemplateSubject": { @@ -5923,10 +5924,10 @@ "smithy.api#documentation": "

    The subject line of the custom verification email.

    " } }, - "SuccessRedirectionURL": { - "target": "com.amazonaws.ses#SuccessRedirectionURL", + "FailureRedirectionURL": { + "target": "com.amazonaws.ses#FailureRedirectionURL", "traits": { - "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

    " + "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " } }, "FromEmailAddress": { @@ -5935,17 +5936,16 @@ "smithy.api#documentation": "

    The email address that the custom verification email is sent from.

    " } }, - "FailureRedirectionURL": { - "target": "com.amazonaws.ses#FailureRedirectionURL", + "SuccessRedirectionURL": { + "target": "com.amazonaws.ses#SuccessRedirectionURL", "traits": { - "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " + "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

    " } }, - "TemplateName": { - "target": "com.amazonaws.ses#TemplateName", + "TemplateContent": { + "target": "com.amazonaws.ses#TemplateContent", "traits": { - "smithy.api#documentation": "

    The name of the custom verification email template that you want to update.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.

    " } } }, @@ -5988,17 +5988,17 @@ "com.amazonaws.ses#UpdateReceiptRuleRequest": { "type": "structure", "members": { - "RuleSetName": { - "target": "com.amazonaws.ses#ReceiptRuleSetName", + "Rule": { + "target": "com.amazonaws.ses#ReceiptRule", "traits": { - "smithy.api#documentation": "

    The name of the receipt rule set that the receipt rule belongs to.

    ", + "smithy.api#documentation": "

    A data structure that contains the updated receipt rule information.

    ", "smithy.api#required": {} } }, - "Rule": { - "target": "com.amazonaws.ses#ReceiptRule", + "RuleSetName": { + "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { - "smithy.api#documentation": "

    A data structure that contains the updated receipt rule information.

    ", + "smithy.api#documentation": "

    The name of the receipt rule set that the receipt rule belongs to.

    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json b/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json index 25f871136fe6..6f0eb5e2a185 100644 --- a/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json +++ b/codegen/sdk-codegen/aws-models/sesv2.2019-09-27.json @@ -32,12 +32,6 @@ "com.amazonaws.sesv2#AccountDetails": { "type": "structure", "members": { - "MailType": { - "target": "com.amazonaws.sesv2#MailType", - "traits": { - "smithy.api#documentation": "

    The type of email your account is sending. The mail type can be one of the\n following:

    \n
      \n
    • \n

      \n MARKETING – Most of your sending traffic is to keep your\n customers informed of your latest offering.

      \n
      • \n
    • \n

      \n TRANSACTIONAL – Most of your sending traffic is to\n communicate during a transaction with a customer.

      \n
      • \n
    " - } - }, "WebsiteURL": { "target": "com.amazonaws.sesv2#WebsiteURL", "traits": { @@ -67,6 +61,12 @@ "traits": { "smithy.api#documentation": "

    Information about the review of the latest details you submitted.

    " } + }, + "MailType": { + "target": "com.amazonaws.sesv2#MailType", + "traits": { + "smithy.api#documentation": "

    The type of email your account is sending. The mail type can be one of the\n following:

    \n
      \n
    • \n

      \n MARKETING – Most of your sending traffic is to keep your\n customers informed of your latest offering.

      \n
      • \n
    • \n

      \n TRANSACTIONAL – Most of your sending traffic is to\n communicate during a transaction with a customer.

      \n
      • \n
    " + } } }, "traits": { @@ -164,18 +164,18 @@ "com.amazonaws.sesv2#BlacklistEntry": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.sesv2#BlacklistingDescription", - "traits": { - "smithy.api#documentation": "

    Additional information about the blacklisting event, as provided by the blacklist\n maintainer.

    " - } - }, "ListingTime": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { "smithy.api#documentation": "

    The time when the blacklisting event occurred, shown in Unix time format.

    " } }, + "Description": { + "target": "com.amazonaws.sesv2#BlacklistingDescription", + "traits": { + "smithy.api#documentation": "

    Additional information about the blacklisting event, as provided by the blacklist\n maintainer.

    " + } + }, "RblName": { "target": "com.amazonaws.sesv2#RblName", "traits": { @@ -290,17 +290,17 @@ "smithy.api#documentation": "

    The unique message identifier returned from the SendBulkTemplatedEmail\n operation.

    " } }, - "Error": { - "target": "com.amazonaws.sesv2#ErrorMessage", - "traits": { - "smithy.api#documentation": "

    A description of an error that prevented a message being sent using the\n SendBulkTemplatedEmail operation.

    " - } - }, "Status": { "target": "com.amazonaws.sesv2#BulkEmailStatus", "traits": { "smithy.api#documentation": "

    The status of a message sent using the SendBulkTemplatedEmail\n operation.

    \n

    Possible values for this parameter include:

    \n
      \n
    • \n

      SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to\n the recipients.

      \n
      • \n
    • \n

      MESSAGE_REJECTED: The message was rejected because it contained a\n virus.

      \n
      • \n
    • \n

      MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not\n verified.

      \n
      • \n
    • \n

      CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not\n exist.

      \n
      • \n
    • \n

      TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.

      \n
      • \n
    • \n

      ACCOUNT_SUSPENDED: Your account has been shut down because of issues related\n to your email sending practices.

      \n
      • \n
    • \n

      ACCOUNT_THROTTLED: The number of emails you can send has been reduced because\n your account has exceeded its allocated sending limit.

      \n
      • \n
    • \n

      ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number\n of emails you can send from your account in a 24-hour period.

      \n
      • \n
    • \n

      INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP\n pool that does not exist.

      \n
      • \n
    • \n

      ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled\n using the UpdateAccountSendingEnabled operation.

      \n
      • \n
    • \n

      CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was\n disabled using the UpdateConfigurationSetSendingEnabled operation.

      \n
      • \n
    • \n

      INVALID_PARAMETER_VALUE: One or more of the parameters you specified when\n calling this operation was invalid. See the error message for additional\n information.

      \n
      • \n
    • \n

      TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a\n temporary issue.

      \n
      • \n
    • \n

      FAILED: Amazon SES was unable to process your request. See the error message\n for additional information.

      \n
      • \n
    " } + }, + "Error": { + "target": "com.amazonaws.sesv2#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    A description of an error that prevented a message being sent using the\n SendBulkTemplatedEmail operation.

    " + } } }, "traits": { @@ -586,18 +586,18 @@ "com.amazonaws.sesv2#CreateConfigurationSetEventDestinationRequest": { "type": "structure", "members": { - "ConfigurationSetName": { - "target": "com.amazonaws.sesv2#ConfigurationSetName", + "EventDestination": { + "target": "com.amazonaws.sesv2#EventDestinationDefinition", "traits": { - "smithy.api#documentation": "

    The name of the configuration set that you want to add an event destination to.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    An object that defines the event destination.

    ", "smithy.api#required": {} } }, - "EventDestination": { - "target": "com.amazonaws.sesv2#EventDestinationDefinition", + "ConfigurationSetName": { + "target": "com.amazonaws.sesv2#ConfigurationSetName", "traits": { - "smithy.api#documentation": "

    An object that defines the event destination.

    ", + "smithy.api#documentation": "

    The name of the configuration set that you want to add an event destination to.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -629,15 +629,15 @@ "smithy.api#documentation": "

    An object that defines whether or not Amazon SES can send email that you send using the\n configuration set.

    " } }, - "SuppressionOptions": { - "target": "com.amazonaws.sesv2#SuppressionOptions" - }, "DeliveryOptions": { "target": "com.amazonaws.sesv2#DeliveryOptions", "traits": { "smithy.api#documentation": "

    An object that defines the dedicated IP pool that is used to send emails that you send\n using the configuration set.

    " } }, + "SuppressionOptions": { + "target": "com.amazonaws.sesv2#SuppressionOptions" + }, "Tags": { "target": "com.amazonaws.sesv2#TagList", "traits": { @@ -650,18 +650,18 @@ "smithy.api#documentation": "

    An object that defines whether or not Amazon SES collects reputation metrics for the emails\n that you send that use the configuration set.

    " } }, + "TrackingOptions": { + "target": "com.amazonaws.sesv2#TrackingOptions", + "traits": { + "smithy.api#documentation": "

    An object that defines the open and click tracking options for emails that you send\n using the configuration set.

    " + } + }, "ConfigurationSetName": { "target": "com.amazonaws.sesv2#ConfigurationSetName", "traits": { "smithy.api#documentation": "

    The name of the configuration set.

    ", "smithy.api#required": {} } - }, - "TrackingOptions": { - "target": "com.amazonaws.sesv2#TrackingOptions", - "traits": { - "smithy.api#documentation": "

    An object that defines the open and click tracking options for emails that you send\n using the configuration set.

    " - } } }, "traits": { @@ -726,6 +726,13 @@ "smithy.api#required": {} } }, + "TemplateName": { + "target": "com.amazonaws.sesv2#EmailTemplateName", + "traits": { + "smithy.api#documentation": "

    The name of the custom verification email template.

    ", + "smithy.api#required": {} + } + }, "FailureRedirectionURL": { "target": "com.amazonaws.sesv2#FailureRedirectionURL", "traits": { @@ -746,13 +753,6 @@ "smithy.api#documentation": "

    The email address that the custom verification email is sent from.

    ", "smithy.api#required": {} } - }, - "TemplateName": { - "target": "com.amazonaws.sesv2#EmailTemplateName", - "traits": { - "smithy.api#documentation": "

    The name of the custom verification email template.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -890,18 +890,18 @@ "smithy.api#documentation": "

    A unique name that helps you to identify the predictive inbox placement test when you retrieve the\n results.

    " } }, - "Tags": { - "target": "com.amazonaws.sesv2#TagList", - "traits": { - "smithy.api#documentation": "

    An array of objects that define the tags (keys and values) that you want to associate\n with the predictive inbox placement test.

    " - } - }, "FromEmailAddress": { "target": "com.amazonaws.sesv2#EmailAddress", "traits": { "smithy.api#documentation": "

    The email address that the predictive inbox placement test email was sent from.

    ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.sesv2#TagList", + "traits": { + "smithy.api#documentation": "

    An array of objects that define the tags (keys and values) that you want to associate\n with the predictive inbox placement test.

    " + } } }, "traits": { @@ -1066,18 +1066,18 @@ "com.amazonaws.sesv2#CreateEmailIdentityResponse": { "type": "structure", "members": { - "VerifiedForSendingStatus": { - "target": "com.amazonaws.sesv2#Enabled", - "traits": { - "smithy.api#documentation": "

    Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the Amazon Pinpoint User Guide.

    " - } - }, "DkimAttributes": { "target": "com.amazonaws.sesv2#DkimAttributes", "traits": { "smithy.api#documentation": "

    An object that contains information about the DKIM attributes for the identity.

    " } }, + "VerifiedForSendingStatus": { + "target": "com.amazonaws.sesv2#Enabled", + "traits": { + "smithy.api#documentation": "

    Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the Amazon Pinpoint User Guide.

    " + } + }, "IdentityType": { "target": "com.amazonaws.sesv2#IdentityType", "traits": { @@ -1149,6 +1149,70 @@ "smithy.api#documentation": "

    If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

    " } }, + "com.amazonaws.sesv2#CreateImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#CreateImportJobRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#CreateImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#LimitExceededException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates an import job for a data destination.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/import-jobs", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#CreateImportJobRequest": { + "type": "structure", + "members": { + "ImportDataSource": { + "target": "com.amazonaws.sesv2#ImportDataSource", + "traits": { + "smithy.api#documentation": "

    The data source for the import job.

    ", + "smithy.api#required": {} + } + }, + "ImportDestination": { + "target": "com.amazonaws.sesv2#ImportDestination", + "traits": { + "smithy.api#documentation": "

    The destination for the import job.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents a request to create an import job from a data source for a data\n destination.

    " + } + }, + "com.amazonaws.sesv2#CreateImportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "

    A string that represents the import job ID.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

    " + } + }, "com.amazonaws.sesv2#CustomRedirectDomain": { "type": "string", "traits": { @@ -1158,12 +1222,24 @@ "com.amazonaws.sesv2#CustomVerificationEmailTemplateMetadata": { "type": "structure", "members": { + "TemplateSubject": { + "target": "com.amazonaws.sesv2#EmailTemplateSubject", + "traits": { + "smithy.api#documentation": "

    The subject line of the custom verification email.

    " + } + }, "SuccessRedirectionURL": { "target": "com.amazonaws.sesv2#SuccessRedirectionURL", "traits": { "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is successfully verified.

    " } }, + "FailureRedirectionURL": { + "target": "com.amazonaws.sesv2#FailureRedirectionURL", + "traits": { + "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " + } + }, "FromEmailAddress": { "target": "com.amazonaws.sesv2#EmailAddress", "traits": { @@ -1175,18 +1251,6 @@ "traits": { "smithy.api#documentation": "

    The name of the custom verification email template.

    " } - }, - "FailureRedirectionURL": { - "target": "com.amazonaws.sesv2#FailureRedirectionURL", - "traits": { - "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " - } - }, - "TemplateSubject": { - "target": "com.amazonaws.sesv2#EmailTemplateSubject", - "traits": { - "smithy.api#documentation": "

    The subject line of the custom verification email.

    " - } } }, "traits": { @@ -1211,17 +1275,17 @@ "smithy.api#documentation": "

    An object that contains inbox placement metrics for a specified day in the analysis\n period, broken out by the recipient's email provider.

    " } }, - "StartDate": { - "target": "com.amazonaws.sesv2#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date that the DailyVolume metrics apply to, in Unix time.

    " - } - }, "VolumeStatistics": { "target": "com.amazonaws.sesv2#VolumeStatistics", "traits": { "smithy.api#documentation": "

    An object that contains inbox placement metrics for a specific day in the analysis\n period.

    " } + }, + "StartDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date that the DailyVolume metrics apply to, in Unix time.

    " + } } }, "traits": { @@ -1234,6 +1298,22 @@ "target": "com.amazonaws.sesv2#DailyVolume" } }, + "com.amazonaws.sesv2#DataFormat": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    The data format of the import job's data source.

    ", + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, "com.amazonaws.sesv2#DedicatedIp": { "type": "structure", "members": { @@ -1740,12 +1820,6 @@ "com.amazonaws.sesv2#DeliverabilityTestReport": { "type": "structure", "members": { - "DeliverabilityTestStatus": { - "target": "com.amazonaws.sesv2#DeliverabilityTestStatus", - "traits": { - "smithy.api#documentation": "

    The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is COMPLETE, then the test is finished, and you can use\n the GetDeliverabilityTestReport to view the results of the test.

    " - } - }, "FromEmailAddress": { "target": "com.amazonaws.sesv2#EmailAddress", "traits": { @@ -1758,23 +1832,29 @@ "smithy.api#documentation": "

    A name that helps you identify a predictive inbox placement test report.

    " } }, - "Subject": { - "target": "com.amazonaws.sesv2#DeliverabilityTestSubject", - "traits": { - "smithy.api#documentation": "

    The subject line for an email that you submitted in a predictive inbox placement test.

    " - } - }, "ReportId": { "target": "com.amazonaws.sesv2#ReportId", "traits": { "smithy.api#documentation": "

    A unique string that identifies the predictive inbox placement test.

    " } }, + "Subject": { + "target": "com.amazonaws.sesv2#DeliverabilityTestSubject", + "traits": { + "smithy.api#documentation": "

    The subject line for an email that you submitted in a predictive inbox placement test.

    " + } + }, "CreateDate": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { "smithy.api#documentation": "

    The date and time when the predictive inbox placement test was created, in Unix time format.

    " } + }, + "DeliverabilityTestStatus": { + "target": "com.amazonaws.sesv2#DeliverabilityTestStatus", + "traits": { + "smithy.api#documentation": "

    The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test\n is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the\n test. If the status is COMPLETE, then the test is finished, and you can use\n the GetDeliverabilityTestReport to view the results of the test.

    " + } } }, "traits": { @@ -1838,16 +1918,16 @@ "smithy.api#documentation": "

    An array that contains the email addresses of the \"To\" recipients for the\n email.

    " } }, - "BccAddresses": { + "CcAddresses": { "target": "com.amazonaws.sesv2#EmailAddressList", "traits": { - "smithy.api#documentation": "

    An array that contains the email addresses of the \"BCC\" (blind carbon copy) recipients\n for the email.

    " + "smithy.api#documentation": "

    An array that contains the email addresses of the \"CC\" (carbon copy) recipients for\n the email.

    " } }, - "CcAddresses": { + "BccAddresses": { "target": "com.amazonaws.sesv2#EmailAddressList", "traits": { - "smithy.api#documentation": "

    An array that contains the email addresses of the \"CC\" (carbon copy) recipients for\n the email.

    " + "smithy.api#documentation": "

    An array that contains the email addresses of the \"BCC\" (blind carbon copy) recipients\n for the email.

    " } } }, @@ -1896,17 +1976,17 @@ "smithy.api#documentation": "

    A string that indicates how DKIM was configured for the identity. There are two\n possible values:

    \n
      \n
    • \n

      \n AWS_SES – Indicates that DKIM was configured for the\n identity by using Easy DKIM.

      \n
      • \n
    • \n

      \n EXTERNAL – Indicates that DKIM was configured for the\n identity by using Bring Your Own DKIM (BYODKIM).

      \n
      • \n
    " } }, - "Status": { - "target": "com.amazonaws.sesv2#DkimStatus", - "traits": { - "smithy.api#documentation": "

    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS\n records for the domain. The status can be one of the following:

    \n
      \n
    • \n

      \n PENDING – The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.

      \n
      • \n
    • \n

      \n SUCCESS – The verification process completed\n successfully.

      \n
      • \n
    • \n

      \n FAILED – The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.

      \n
      • \n
    • \n

      \n TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.

      \n
      • \n
    • \n

      \n NOT_STARTED – The DKIM verification process hasn't been\n initiated for the domain.

      \n
      • \n
    " - } - }, "SigningEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { "smithy.api#documentation": "

    If the value is true, then the messages that you send from the identity\n are signed using DKIM. If the value is false, then the messages that you\n send from the identity aren't DKIM-signed.

    " } + }, + "Status": { + "target": "com.amazonaws.sesv2#DkimStatus", + "traits": { + "smithy.api#documentation": "

    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS\n records for the domain. The status can be one of the following:

    \n
      \n
    • \n

      \n PENDING – The verification process was initiated, but Amazon SES\n hasn't yet detected the DKIM records in the DNS configuration for the\n domain.

      \n
      • \n
    • \n

      \n SUCCESS – The verification process completed\n successfully.

      \n
      • \n
    • \n

      \n FAILED – The verification process failed. This typically\n occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the\n domain.

      \n
      • \n
    • \n

      \n TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES\n from determining the DKIM authentication status of the domain.

      \n
      • \n
    • \n

      \n NOT_STARTED – The DKIM verification process hasn't been\n initiated for the domain.

      \n
      • \n
    " + } } }, "traits": { @@ -1916,17 +1996,17 @@ "com.amazonaws.sesv2#DkimSigningAttributes": { "type": "structure", "members": { - "DomainSigningSelector": { - "target": "com.amazonaws.sesv2#Selector", + "DomainSigningPrivateKey": { + "target": "com.amazonaws.sesv2#PrivateKey", "traits": { - "smithy.api#documentation": "

    A string that's used to identify a public key in the DNS configuration for a\n domain.

    ", + "smithy.api#documentation": "

    A private key that's used to generate a DKIM signature.

    \n

    The private key must use 1024-bit RSA encryption, and must be encoded using base64\n encoding.

    ", "smithy.api#required": {} } }, - "DomainSigningPrivateKey": { - "target": "com.amazonaws.sesv2#PrivateKey", + "DomainSigningSelector": { + "target": "com.amazonaws.sesv2#Selector", "traits": { - "smithy.api#documentation": "

    A private key that's used to generate a DKIM signature.

    \n

    The private key must use 1024-bit RSA encryption, and must be encoded using base64\n encoding.

    ", + "smithy.api#documentation": "

    A string that's used to identify a public key in the DNS configuration for a\n domain.

    ", "smithy.api#required": {} } } @@ -1999,40 +2079,34 @@ "smithy.api#documentation": "

    The number of email messages that were delivered to recipients’ inboxes.

    " } }, - "ImageUrl": { - "target": "com.amazonaws.sesv2#ImageUrl", - "traits": { - "smithy.api#documentation": "

    The URL of an image that contains a snapshot of the email message that was\n sent.

    " - } - }, "ReadDeleteRate": { "target": "com.amazonaws.sesv2#Percentage", "traits": { "smithy.api#documentation": "

    The percentage of email messages that were opened and then deleted by recipients. Due\n to technical limitations, this value only includes recipients who opened the message by\n using an email client that supports images.

    " } }, - "ProjectedVolume": { - "target": "com.amazonaws.sesv2#Volume", + "ImageUrl": { + "target": "com.amazonaws.sesv2#ImageUrl", "traits": { - "smithy.api#documentation": "

    The projected number of recipients that the email message was sent to.

    " + "smithy.api#documentation": "

    The URL of an image that contains a snapshot of the email message that was\n sent.

    " } }, - "SendingIps": { - "target": "com.amazonaws.sesv2#IpList", + "FirstSeenDateTime": { + "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "

    The IP addresses that were used to send the email message.

    " + "smithy.api#documentation": "

    The first time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

    " } }, - "SpamCount": { - "target": "com.amazonaws.sesv2#Volume", + "LastSeenDateTime": { + "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "

    The number of email messages that were delivered to recipients' spam or junk mail\n folders.

    " + "smithy.api#documentation": "

    The last time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

    " } }, - "ReadRate": { + "DeleteRate": { "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of email messages that were opened by recipients. Due to technical\n limitations, this value only includes recipients who opened the message by using an\n email client that supports images.

    " + "smithy.api#documentation": "

    The percentage of email messages that were deleted by recipients, without being opened\n first. Due to technical limitations, this value only includes recipients who opened the\n message by using an email client that supports images.

    " } }, "CampaignId": { @@ -2041,10 +2115,10 @@ "smithy.api#documentation": "

    The unique identifier for the campaign. The Deliverability dashboard automatically generates\n and assigns this identifier to a campaign.

    " } }, - "Esps": { - "target": "com.amazonaws.sesv2#Esps", + "Subject": { + "target": "com.amazonaws.sesv2#Subject", "traits": { - "smithy.api#documentation": "

    The major email providers who handled the email message.

    " + "smithy.api#documentation": "

    The subject line, or title, of the email message.

    " } }, "FromAddress": { @@ -2053,28 +2127,34 @@ "smithy.api#documentation": "

    The verified email address that the email message was sent from.

    " } }, - "Subject": { - "target": "com.amazonaws.sesv2#Subject", + "Esps": { + "target": "com.amazonaws.sesv2#Esps", "traits": { - "smithy.api#documentation": "

    The subject line, or title, of the email message.

    " + "smithy.api#documentation": "

    The major email providers who handled the email message.

    " } }, - "LastSeenDateTime": { - "target": "com.amazonaws.sesv2#Timestamp", + "ProjectedVolume": { + "target": "com.amazonaws.sesv2#Volume", "traits": { - "smithy.api#documentation": "

    The last time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

    " + "smithy.api#documentation": "

    The projected number of recipients that the email message was sent to.

    " } }, - "FirstSeenDateTime": { - "target": "com.amazonaws.sesv2#Timestamp", + "SendingIps": { + "target": "com.amazonaws.sesv2#IpList", "traits": { - "smithy.api#documentation": "

    The first time, in Unix time format, when the email message was delivered to any\n recipient's inbox. This value can help you determine how long it took for a campaign to\n deliver an email message.

    " + "smithy.api#documentation": "

    The IP addresses that were used to send the email message.

    " } }, - "DeleteRate": { + "SpamCount": { + "target": "com.amazonaws.sesv2#Volume", + "traits": { + "smithy.api#documentation": "

    The number of email messages that were delivered to recipients' spam or junk mail\n folders.

    " + } + }, + "ReadRate": { "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of email messages that were deleted by recipients, without being opened\n first. Due to technical limitations, this value only includes recipients who opened the\n message by using an email client that supports images.

    " + "smithy.api#documentation": "

    The percentage of email messages that were opened by recipients. Due to technical\n limitations, this value only includes recipients who opened the message by using an\n email client that supports images.

    " } } }, @@ -2094,6 +2174,12 @@ "com.amazonaws.sesv2#DomainDeliverabilityTrackingOption": { "type": "structure", "members": { + "SubscriptionStartDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date, in Unix time format, when you enabled the Deliverability dashboard for the\n domain.

    " + } + }, "InboxPlacementTrackingOption": { "target": "com.amazonaws.sesv2#InboxPlacementTrackingOption", "traits": { @@ -2105,12 +2191,6 @@ "traits": { "smithy.api#documentation": "

    A verified domain that’s associated with your AWS account and currently has an\n active Deliverability dashboard subscription.

    " } - }, - "SubscriptionStartDate": { - "target": "com.amazonaws.sesv2#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date, in Unix time format, when you enabled the Deliverability dashboard for the\n domain.

    " - } } }, "traits": { @@ -2129,16 +2209,16 @@ "com.amazonaws.sesv2#DomainIspPlacement": { "type": "structure", "members": { - "IspName": { - "target": "com.amazonaws.sesv2#IspName", + "InboxPercentage": { + "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The name of the email provider that the inbox placement data applies to.

    " + "smithy.api#documentation": "

    The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

    " } }, - "InboxPercentage": { + "SpamPercentage": { "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

    " + "smithy.api#documentation": "

    The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.

    " } }, "SpamRawCount": { @@ -2153,10 +2233,10 @@ "smithy.api#documentation": "

    The total number of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' inboxes.

    " } }, - "SpamPercentage": { - "target": "com.amazonaws.sesv2#Percentage", + "IspName": { + "target": "com.amazonaws.sesv2#IspName", "traits": { - "smithy.api#documentation": "

    The percentage of messages that were sent from the selected domain to the specified\n email provider that arrived in recipients' spam or junk mail folders.

    " + "smithy.api#documentation": "

    The name of the email provider that the inbox placement data applies to.

    " } } }, @@ -2188,17 +2268,17 @@ "smithy.api#documentation": "

    The raw email message. The message has to meet the following criteria:

    \n
      \n
    • \n

      The message has to contain a header and a body, separated by one blank\n line.

      \n
      • \n
    • \n

      All of the required header fields must be present in the message.

      \n
      • \n
    • \n

      Each part of a multipart MIME message must be formatted properly.

      \n
      • \n
    • \n

      If you include attachments, they must be in a file format that the Amazon SES API v2\n supports.\n

      \n
      • \n
    • \n

      The entire message must be Base64 encoded.

      \n
      • \n
    • \n

      If any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, you should encode that content to ensure that\n recipients' email clients render the message properly.

      \n
      • \n
    • \n

      The length of any single line of text in the message can't exceed 1,000\n characters. This restriction is defined in RFC 5321.

      \n
      • \n
    " } }, - "Simple": { - "target": "com.amazonaws.sesv2#Message", - "traits": { - "smithy.api#documentation": "

    The simple email message. The message consists of a subject and a message body.

    " - } - }, "Template": { "target": "com.amazonaws.sesv2#Template", "traits": { "smithy.api#documentation": "

    The template to use for the email message.

    " } + }, + "Simple": { + "target": "com.amazonaws.sesv2#Message", + "traits": { + "smithy.api#documentation": "

    The simple email message. The message consists of a subject and a message body.

    " + } } }, "traits": { @@ -2214,17 +2294,17 @@ "smithy.api#documentation": "

    The email body that will be visible to recipients whose email clients do not display\n HTML.

    " } }, - "Subject": { - "target": "com.amazonaws.sesv2#EmailTemplateSubject", - "traits": { - "smithy.api#documentation": "

    The subject line of the email.

    " - } - }, "Html": { "target": "com.amazonaws.sesv2#EmailTemplateHtml", "traits": { "smithy.api#documentation": "

    The HTML body of the email.

    " } + }, + "Subject": { + "target": "com.amazonaws.sesv2#EmailTemplateSubject", + "traits": { + "smithy.api#documentation": "

    The subject line of the email.

    " + } } }, "traits": { @@ -2321,10 +2401,10 @@ "com.amazonaws.sesv2#EventDestination": { "type": "structure", "members": { - "SnsDestination": { - "target": "com.amazonaws.sesv2#SnsDestination", + "KinesisFirehoseDestination": { + "target": "com.amazonaws.sesv2#KinesisFirehoseDestination", "traits": { - "smithy.api#documentation": "

    An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.

    " + "smithy.api#documentation": "

    An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

    " } }, "CloudWatchDestination": { @@ -2339,10 +2419,10 @@ "smithy.api#documentation": "

    If true, the event destination is enabled. When the event destination is\n enabled, the specified event types are sent to the destinations in this\n EventDestinationDefinition.

    \n

    If false, the event destination is disabled. When the event destination\n is disabled, events aren't sent to the specified destinations.

    " } }, - "PinpointDestination": { - "target": "com.amazonaws.sesv2#PinpointDestination", + "SnsDestination": { + "target": "com.amazonaws.sesv2#SnsDestination", "traits": { - "smithy.api#documentation": "

    An object that defines an Amazon Pinpoint project destination for email events. You can send\n email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging\n dashboards that are built in to Amazon Pinpoint. For more information, see Transactional\n Messaging Charts in the Amazon Pinpoint User Guide.

    " + "smithy.api#documentation": "

    An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to\n send notification when certain email events occur.

    " } }, "MatchingEventTypes": { @@ -2352,18 +2432,18 @@ "smithy.api#required": {} } }, + "PinpointDestination": { + "target": "com.amazonaws.sesv2#PinpointDestination", + "traits": { + "smithy.api#documentation": "

    An object that defines an Amazon Pinpoint project destination for email events. You can send\n email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging\n dashboards that are built in to Amazon Pinpoint. For more information, see Transactional\n Messaging Charts in the Amazon Pinpoint User Guide.

    " + } + }, "Name": { "target": "com.amazonaws.sesv2#EventDestinationName", "traits": { "smithy.api#documentation": "

    A name that identifies the event destination.

    ", "smithy.api#required": {} } - }, - "KinesisFirehoseDestination": { - "target": "com.amazonaws.sesv2#KinesisFirehoseDestination", - "traits": { - "smithy.api#documentation": "

    An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.

    " - } } }, "traits": { @@ -2476,6 +2556,35 @@ "target": "com.amazonaws.sesv2#EventType" } }, + "com.amazonaws.sesv2#FailedRecordsCount": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.sesv2#FailedRecordsS3Url": { + "type": "string" + }, + "com.amazonaws.sesv2#FailureInfo": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.sesv2#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    A message about why the import job failed.

    " + } + }, + "FailedRecordsS3Url": { + "target": "com.amazonaws.sesv2#FailedRecordsS3Url", + "traits": { + "smithy.api#documentation": "

    An Amazon S3 presigned URL that contains all the failed records and related\n information.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object that contains the failure details about an import job.

    " + } + }, "com.amazonaws.sesv2#FailureRedirectionURL": { "type": "string", "traits": { @@ -2529,24 +2638,18 @@ "smithy.api#documentation": "

    An object that contains information about the per-day and per-second sending limits\n for your Amazon SES account in the current AWS Region.

    " } }, - "SendingEnabled": { - "target": "com.amazonaws.sesv2#Enabled", - "traits": { - "smithy.api#documentation": "

    Indicates whether or not email sending is enabled for your Amazon SES account in the\n current AWS Region.

    " - } - }, - "SuppressionAttributes": { - "target": "com.amazonaws.sesv2#SuppressionAttributes", - "traits": { - "smithy.api#documentation": "

    An object that contains information about the email address suppression preferences\n for your account in the current AWS Region.

    " - } - }, "Details": { "target": "com.amazonaws.sesv2#AccountDetails", "traits": { "smithy.api#documentation": "

    An object that defines your account details.

    " } }, + "SendingEnabled": { + "target": "com.amazonaws.sesv2#Enabled", + "traits": { + "smithy.api#documentation": "

    Indicates whether or not email sending is enabled for your Amazon SES account in the\n current AWS Region.

    " + } + }, "ProductionAccessEnabled": { "target": "com.amazonaws.sesv2#Enabled", "traits": { @@ -2564,6 +2667,12 @@ "traits": { "smithy.api#documentation": "

    Indicates whether or not the automatic warm-up feature is enabled for dedicated IP\n addresses that are associated with your account.

    " } + }, + "SuppressionAttributes": { + "target": "com.amazonaws.sesv2#SuppressionAttributes", + "traits": { + "smithy.api#documentation": "

    An object that contains information about the email address suppression preferences\n for your account in the current AWS Region.

    " + } } }, "traits": { @@ -2734,10 +2843,10 @@ "com.amazonaws.sesv2#GetConfigurationSetResponse": { "type": "structure", "members": { - "SendingOptions": { - "target": "com.amazonaws.sesv2#SendingOptions", + "TrackingOptions": { + "target": "com.amazonaws.sesv2#TrackingOptions", "traits": { - "smithy.api#documentation": "

    An object that defines whether or not Amazon SES can send email that you send using the\n configuration set.

    " + "smithy.api#documentation": "

    An object that defines the open and click tracking options for emails that you send\n using the configuration set.

    " } }, "DeliveryOptions": { @@ -2746,30 +2855,30 @@ "smithy.api#documentation": "

    An object that defines the dedicated IP pool that is used to send emails that you send\n using the configuration set.

    " } }, - "TrackingOptions": { - "target": "com.amazonaws.sesv2#TrackingOptions", - "traits": { - "smithy.api#documentation": "

    An object that defines the open and click tracking options for emails that you send\n using the configuration set.

    " - } - }, "Tags": { "target": "com.amazonaws.sesv2#TagList", "traits": { "smithy.api#documentation": "

    An array of objects that define the tags (keys and values) that are associated with\n the configuration set.

    " } }, - "ConfigurationSetName": { - "target": "com.amazonaws.sesv2#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "

    The name of the configuration set.

    " - } - }, "ReputationOptions": { "target": "com.amazonaws.sesv2#ReputationOptions", "traits": { "smithy.api#documentation": "

    An object that defines whether or not Amazon SES collects reputation metrics for the emails\n that you send that use the configuration set.

    " } }, + "SendingOptions": { + "target": "com.amazonaws.sesv2#SendingOptions", + "traits": { + "smithy.api#documentation": "

    An object that defines whether or not Amazon SES can send email that you send using the\n configuration set.

    " + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.sesv2#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "

    The name of the configuration set.

    " + } + }, "SuppressionOptions": { "target": "com.amazonaws.sesv2#SuppressionOptions", "traits": { @@ -2828,12 +2937,24 @@ "com.amazonaws.sesv2#GetCustomVerificationEmailTemplateResponse": { "type": "structure", "members": { + "FailureRedirectionURL": { + "target": "com.amazonaws.sesv2#FailureRedirectionURL", + "traits": { + "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " + } + }, "FromEmailAddress": { "target": "com.amazonaws.sesv2#EmailAddress", "traits": { "smithy.api#documentation": "

    The email address that the custom verification email is sent from.

    " } }, + "TemplateSubject": { + "target": "com.amazonaws.sesv2#EmailTemplateSubject", + "traits": { + "smithy.api#documentation": "

    The subject line of the custom verification email.

    " + } + }, "TemplateContent": { "target": "com.amazonaws.sesv2#TemplateContent", "traits": { @@ -2851,18 +2972,6 @@ "traits": { "smithy.api#documentation": "

    The name of the custom verification email template.

    " } - }, - "FailureRedirectionURL": { - "target": "com.amazonaws.sesv2#FailureRedirectionURL", - "traits": { - "smithy.api#documentation": "

    The URL that the recipient of the verification email is sent to if his or her address\n is not successfully verified.

    " - } - }, - "TemplateSubject": { - "target": "com.amazonaws.sesv2#EmailTemplateSubject", - "traits": { - "smithy.api#documentation": "

    The subject line of the custom verification email.

    " - } } }, "traits": { @@ -2963,11 +3072,11 @@ "com.amazonaws.sesv2#GetDedicatedIpsRequest": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.sesv2#MaxItems", + "PoolName": { + "target": "com.amazonaws.sesv2#PoolName", "traits": { - "smithy.api#documentation": "

    The number of results to show in a single call to GetDedicatedIpsRequest.\n If the number of results is larger than the number you specified in this parameter, then\n the response includes a NextToken element, which you can use to obtain\n additional results.

    ", - "smithy.api#httpQuery": "PageSize" + "smithy.api#documentation": "

    The name of the IP pool that the dedicated IP address is associated with.

    ", + "smithy.api#httpQuery": "PoolName" } }, "NextToken": { @@ -2977,11 +3086,11 @@ "smithy.api#httpQuery": "NextToken" } }, - "PoolName": { - "target": "com.amazonaws.sesv2#PoolName", + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", "traits": { - "smithy.api#documentation": "

    The name of the IP pool that the dedicated IP address is associated with.

    ", - "smithy.api#httpQuery": "PoolName" + "smithy.api#documentation": "

    The number of results to show in a single call to GetDedicatedIpsRequest.\n If the number of results is larger than the number you specified in this parameter, then\n the response includes a NextToken element, which you can use to obtain\n additional results.

    ", + "smithy.api#httpQuery": "PageSize" } } }, @@ -3047,16 +3156,16 @@ "com.amazonaws.sesv2#GetDeliverabilityDashboardOptionsResponse": { "type": "structure", "members": { - "SubscriptionExpiryDate": { - "target": "com.amazonaws.sesv2#Timestamp", + "PendingExpirationSubscribedDomains": { + "target": "com.amazonaws.sesv2#DomainDeliverabilityTrackingOptions", "traits": { - "smithy.api#documentation": "

    The date, in Unix time format, when your current subscription to the Deliverability dashboard\n is scheduled to expire, if your subscription is scheduled to expire at the end of the\n current calendar month. This value is null if you have an active subscription that isn’t\n due to expire at the end of the month.

    " + "smithy.api#documentation": "

    An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that's scheduled to expire at the\n end of the current calendar month.

    " } }, - "PendingExpirationSubscribedDomains": { + "ActiveSubscribedDomains": { "target": "com.amazonaws.sesv2#DomainDeliverabilityTrackingOptions", "traits": { - "smithy.api#documentation": "

    An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that's scheduled to expire at the\n end of the current calendar month.

    " + "smithy.api#documentation": "

    An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at\n the end of the current calendar month.

    " } }, "DashboardEnabled": { @@ -3066,17 +3175,17 @@ "smithy.api#required": {} } }, - "ActiveSubscribedDomains": { - "target": "com.amazonaws.sesv2#DomainDeliverabilityTrackingOptions", - "traits": { - "smithy.api#documentation": "

    An array of objects, one for each verified domain that you use to send email and\n currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at\n the end of the current calendar month.

    " - } - }, "AccountStatus": { "target": "com.amazonaws.sesv2#DeliverabilityDashboardAccountStatus", "traits": { "smithy.api#documentation": "

    The current status of your Deliverability dashboard subscription. If this value is\n PENDING_EXPIRATION, your subscription is scheduled to expire at the end\n of the current calendar month.

    " } + }, + "SubscriptionExpiryDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date, in Unix time format, when your current subscription to the Deliverability dashboard\n is scheduled to expire, if your subscription is scheduled to expire at the end of the\n current calendar month. This value is null if you have an active subscription that isn’t\n due to expire at the end of the month.

    " + } } }, "traits": { @@ -3137,6 +3246,13 @@ "smithy.api#required": {} } }, + "DeliverabilityTestReport": { + "target": "com.amazonaws.sesv2#DeliverabilityTestReport", + "traits": { + "smithy.api#documentation": "

    An object that contains the results of the predictive inbox placement test.

    ", + "smithy.api#required": {} + } + }, "Tags": { "target": "com.amazonaws.sesv2#TagList", "traits": { @@ -3155,13 +3271,6 @@ "traits": { "smithy.api#documentation": "

    An object that contains the message that you sent when you performed this\n predictive inbox placement test.

    " } - }, - "DeliverabilityTestReport": { - "target": "com.amazonaws.sesv2#DeliverabilityTestReport", - "traits": { - "smithy.api#documentation": "

    An object that contains the results of the predictive inbox placement test.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -3414,10 +3523,10 @@ "com.amazonaws.sesv2#GetEmailIdentityResponse": { "type": "structure", "members": { - "IdentityType": { - "target": "com.amazonaws.sesv2#IdentityType", + "Tags": { + "target": "com.amazonaws.sesv2#TagList", "traits": { - "smithy.api#documentation": "

    The email identity type.

    " + "smithy.api#documentation": "

    An array of objects that define the tags (keys and values) that are associated with\n the email identity.

    " } }, "MailFromAttributes": { @@ -3426,16 +3535,10 @@ "smithy.api#documentation": "

    An object that contains information about the Mail-From attributes for the email\n identity.

    " } }, - "FeedbackForwardingStatus": { - "target": "com.amazonaws.sesv2#Enabled", - "traits": { - "smithy.api#documentation": "

    The feedback forwarding configuration for the identity.

    \n

    If the value is true, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the Return-Path header of the original email.

    \n

    You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).

    " - } - }, - "Tags": { - "target": "com.amazonaws.sesv2#TagList", + "IdentityType": { + "target": "com.amazonaws.sesv2#IdentityType", "traits": { - "smithy.api#documentation": "

    An array of objects that define the tags (keys and values) that are associated with\n the email identity.

    " + "smithy.api#documentation": "

    The email identity type.

    " } }, "Policies": { @@ -3444,10 +3547,10 @@ "smithy.api#documentation": "

    A map of policy names to policies.

    " } }, - "DkimAttributes": { - "target": "com.amazonaws.sesv2#DkimAttributes", + "FeedbackForwardingStatus": { + "target": "com.amazonaws.sesv2#Enabled", "traits": { - "smithy.api#documentation": "

    An object that contains information about the DKIM attributes for the identity.

    " + "smithy.api#documentation": "

    The feedback forwarding configuration for the identity.

    \n

    If the value is true, you receive email notifications when bounce or\n complaint events occur. These notifications are sent to the address that you specified\n in the Return-Path header of the original email.

    \n

    You're required to have a method of tracking bounces and complaints. If you haven't\n set up another mechanism for receiving bounce or complaint notifications (for example,\n by setting up an event destination), you receive an email notification when these events\n occur (even if this setting is disabled).

    " } }, "VerifiedForSendingStatus": { @@ -3455,6 +3558,12 @@ "traits": { "smithy.api#documentation": "

    Specifies whether or not the identity is verified. You can only send email from\n verified email addresses or domains. For more information about verifying identities,\n see the Amazon Pinpoint User Guide.

    " } + }, + "DkimAttributes": { + "target": "com.amazonaws.sesv2#DkimAttributes", + "traits": { + "smithy.api#documentation": "

    An object that contains information about the DKIM attributes for the identity.

    " + } } }, "traits": { @@ -3508,23 +3617,129 @@ "com.amazonaws.sesv2#GetEmailTemplateResponse": { "type": "structure", "members": { - "TemplateName": { - "target": "com.amazonaws.sesv2#EmailTemplateName", + "TemplateName": { + "target": "com.amazonaws.sesv2#EmailTemplateName", + "traits": { + "smithy.api#documentation": "

    The name of the template you want to retrieve.

    ", + "smithy.api#required": {} + } + }, + "TemplateContent": { + "target": "com.amazonaws.sesv2#EmailTemplateContent", + "traits": { + "smithy.api#documentation": "

    The content of the email template, composed of a subject line, an HTML part, and a\n text-only part.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The following element is returned by the service.

    " + } + }, + "com.amazonaws.sesv2#GetImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#GetImportJobRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#GetImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

    Provides information about an import job.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/import-jobs/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#GetImportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "

    The ID of the import job.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents a request for information about an import job using the import job\n ID.

    " + } + }, + "com.amazonaws.sesv2#GetImportJobResponse": { + "type": "structure", + "members": { + "CompletedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the template you want to retrieve.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The time stamp of when the import job was completed.

    " } }, - "TemplateContent": { - "target": "com.amazonaws.sesv2#EmailTemplateContent", + "FailureInfo": { + "target": "com.amazonaws.sesv2#FailureInfo", "traits": { - "smithy.api#documentation": "

    The content of the email template, composed of a subject line, an HTML part, and a\n text-only part.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The failure details about an import job.

    " + } + }, + "ImportDestination": { + "target": "com.amazonaws.sesv2#ImportDestination", + "traits": { + "smithy.api#documentation": "

    The destination of the import job.

    " + } + }, + "ProcessedRecordsCount": { + "target": "com.amazonaws.sesv2#ProcessedRecordsCount", + "traits": { + "smithy.api#documentation": "

    The current number of records processed.

    " + } + }, + "JobStatus": { + "target": "com.amazonaws.sesv2#JobStatus", + "traits": { + "smithy.api#documentation": "

    The status of the import job.

    " + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time stamp of when the import job was created.

    " + } + }, + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "

    A string that represents the import job ID.

    " + } + }, + "FailedRecordsCount": { + "target": "com.amazonaws.sesv2#FailedRecordsCount", + "traits": { + "smithy.api#documentation": "

    The number of records that failed processing because of invalid input or other\n reasons.

    " + } + }, + "ImportDataSource": { + "target": "com.amazonaws.sesv2#ImportDataSource", + "traits": { + "smithy.api#documentation": "

    The data source of the import job.

    " } } }, "traits": { - "smithy.api#documentation": "

    The following element is returned by the service.

    " + "smithy.api#documentation": "

    An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

    " } }, "com.amazonaws.sesv2#GetSuppressedDestination": { @@ -3597,18 +3812,18 @@ "com.amazonaws.sesv2#IdentityInfo": { "type": "structure", "members": { - "SendingEnabled": { - "target": "com.amazonaws.sesv2#Enabled", - "traits": { - "smithy.api#documentation": "

    Indicates whether or not you can send email from the identity.

    \n

    An identity is an email address or domain that you send email\n from. Before you can send email from an identity, you have to demostrate that you own\n the identity, and that you authorize Amazon SES to send email from that identity.

    " - } - }, "IdentityName": { "target": "com.amazonaws.sesv2#Identity", "traits": { "smithy.api#documentation": "

    The address or domain of the identity.

    " } }, + "SendingEnabled": { + "target": "com.amazonaws.sesv2#Enabled", + "traits": { + "smithy.api#documentation": "

    Indicates whether or not you can send email from the identity.

    \n

    An identity is an email address or domain that you send email\n from. Before you can send email from an identity, you have to demostrate that you own\n the identity, and that you authorize Amazon SES to send email from that identity.

    " + } + }, "IdentityType": { "target": "com.amazonaws.sesv2#IdentityType", "traits": { @@ -3649,6 +3864,84 @@ "com.amazonaws.sesv2#ImageUrl": { "type": "string" }, + "com.amazonaws.sesv2#ImportDataSource": { + "type": "structure", + "members": { + "DataFormat": { + "target": "com.amazonaws.sesv2#DataFormat", + "traits": { + "smithy.api#documentation": "

    The data format of the import job's data source.

    ", + "smithy.api#required": {} + } + }, + "S3Url": { + "target": "com.amazonaws.sesv2#S3Url", + "traits": { + "smithy.api#documentation": "

    An Amazon S3 URL in the format\n s3:///.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object that contains details about the data source of the import job.

    " + } + }, + "com.amazonaws.sesv2#ImportDestination": { + "type": "structure", + "members": { + "SuppressionListDestination": { + "target": "com.amazonaws.sesv2#SuppressionListDestination", + "traits": { + "smithy.api#documentation": "

    An object that contains the action of the import job towards suppression list.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object that contains details about the resource destination the import job is going\n to target.

    " + } + }, + "com.amazonaws.sesv2#ImportDestinationType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    The destination of the import job, which can be used to list import jobs that have a\n certain ImportDestinationType.

    ", + "smithy.api#enum": [ + { + "value": "SUPPRESSION_LIST", + "name": "SUPPRESSION_LIST" + } + ] + } + }, + "com.amazonaws.sesv2#ImportJobSummary": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.sesv2#JobStatus" + }, + "JobId": { + "target": "com.amazonaws.sesv2#JobId" + }, + "ImportDestination": { + "target": "com.amazonaws.sesv2#ImportDestination" + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp" + } + }, + "traits": { + "smithy.api#documentation": "

    A summary of the import job.

    " + } + }, + "com.amazonaws.sesv2#ImportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#ImportJobSummary" + }, + "traits": { + "smithy.api#documentation": "

    A list of the import job summaries.

    " + } + }, "com.amazonaws.sesv2#InboxPlacementTrackingOption": { "type": "structure", "members": { @@ -3732,20 +4025,53 @@ "target": "com.amazonaws.sesv2#IspPlacement" } }, + "com.amazonaws.sesv2#JobId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    A string that represents the import job ID.

    ", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sesv2#JobStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    The status of the import job.

    ", + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "PROCESSING", + "name": "PROCESSING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, "com.amazonaws.sesv2#KinesisFirehoseDestination": { "type": "structure", "members": { - "IamRoleArn": { + "DeliveryStreamArn": { "target": "com.amazonaws.sesv2#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email\n events to the Amazon Kinesis Data Firehose stream.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email\n events to.

    ", "smithy.api#required": {} } }, - "DeliveryStreamArn": { + "IamRoleArn": { "target": "com.amazonaws.sesv2#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email\n events to.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email\n events to the Amazon Kinesis Data Firehose stream.

    ", "smithy.api#required": {} } } @@ -3828,17 +4154,17 @@ "com.amazonaws.sesv2#ListConfigurationSetsResponse": { "type": "structure", "members": { - "ConfigurationSets": { - "target": "com.amazonaws.sesv2#ConfigurationSetNameList", - "traits": { - "smithy.api#documentation": "

    An array that contains all of the configuration sets in your Amazon SES account in the\n current AWS Region.

    " - } - }, "NextToken": { "target": "com.amazonaws.sesv2#NextToken", "traits": { "smithy.api#documentation": "

    A token that indicates that there are additional configuration sets to list. To view\n additional configuration sets, issue another request to\n ListConfigurationSets, and pass this token in the\n NextToken parameter.

    " } + }, + "ConfigurationSets": { + "target": "com.amazonaws.sesv2#ConfigurationSetNameList", + "traits": { + "smithy.api#documentation": "

    An array that contains all of the configuration sets in your Amazon SES account in the\n current AWS Region.

    " + } } }, "traits": { @@ -3878,19 +4204,19 @@ "com.amazonaws.sesv2#ListCustomVerificationEmailTemplatesRequest": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.sesv2#MaxItems", - "traits": { - "smithy.api#documentation": "

    The number of results to show in a single call to\n ListCustomVerificationEmailTemplates. If the number of results is\n larger than the number you specified in this parameter, then the response includes a\n NextToken element, which you can use to obtain additional\n results.

    \n

    The value you specify has to be at least 1, and can be no more than 50.

    ", - "smithy.api#httpQuery": "PageSize" - } - }, "NextToken": { "target": "com.amazonaws.sesv2#NextToken", "traits": { "smithy.api#documentation": "

    A token returned from a previous call to\n ListCustomVerificationEmailTemplates to indicate the position in the\n list of custom verification email templates.

    ", "smithy.api#httpQuery": "NextToken" } + }, + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", + "traits": { + "smithy.api#documentation": "

    The number of results to show in a single call to\n ListCustomVerificationEmailTemplates. If the number of results is\n larger than the number you specified in this parameter, then the response includes a\n NextToken element, which you can use to obtain additional\n results.

    \n

    The value you specify has to be at least 1, and can be no more than 50.

    ", + "smithy.api#httpQuery": "PageSize" + } } }, "traits": { @@ -4101,6 +4427,14 @@ "com.amazonaws.sesv2#ListDomainDeliverabilityCampaignsRequest": { "type": "structure", "members": { + "EndDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

    The last day, in Unix time format, that you want to obtain deliverability data for.\n This value has to be less than or equal to 30 days after the value of the\n StartDate parameter.

    ", + "smithy.api#httpQuery": "EndDate", + "smithy.api#required": {} + } + }, "PageSize": { "target": "com.amazonaws.sesv2#MaxItems", "traits": { @@ -4108,11 +4442,11 @@ "smithy.api#httpQuery": "PageSize" } }, - "EndDate": { + "StartDate": { "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "

    The last day, in Unix time format, that you want to obtain deliverability data for.\n This value has to be less than or equal to 30 days after the value of the\n StartDate parameter.

    ", - "smithy.api#httpQuery": "EndDate", + "smithy.api#documentation": "

    The first day, in Unix time format, that you want to obtain deliverability data\n for.

    ", + "smithy.api#httpQuery": "StartDate", "smithy.api#required": {} } }, @@ -4124,14 +4458,6 @@ "smithy.api#required": {} } }, - "StartDate": { - "target": "com.amazonaws.sesv2#Timestamp", - "traits": { - "smithy.api#documentation": "

    The first day, in Unix time format, that you want to obtain deliverability data\n for.

    ", - "smithy.api#httpQuery": "StartDate", - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.sesv2#NextToken", "traits": { @@ -4147,18 +4473,18 @@ "com.amazonaws.sesv2#ListDomainDeliverabilityCampaignsResponse": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

    A token that’s returned from a previous call to the\n ListDomainDeliverabilityCampaigns operation. This token indicates the\n position of the campaign in the list of campaigns.

    " + } + }, "DomainDeliverabilityCampaigns": { "target": "com.amazonaws.sesv2#DomainDeliverabilityCampaignList", "traits": { "smithy.api#documentation": "

    An array of responses, one for each campaign that used the domain to send email during\n the specified time range.

    ", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.sesv2#NextToken", - "traits": { - "smithy.api#documentation": "

    A token that’s returned from a previous call to the\n ListDomainDeliverabilityCampaigns operation. This token indicates the\n position of the campaign in the list of campaigns.

    " - } } }, "traits": { @@ -4309,6 +4635,84 @@ "smithy.api#documentation": "

    The following elements are returned by the service.

    " } }, + "com.amazonaws.sesv2#ListImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#ListImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#ListImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists all of the import jobs.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/import-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.sesv2#ListImportJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

    A string token indicating that there might be additional import jobs available to be\n listed. Copy this token to a subsequent call to ListImportJobs with the\n same parameters to retrieve the next page of import jobs.

    ", + "smithy.api#httpQuery": "NextToken" + } + }, + "ImportDestinationType": { + "target": "com.amazonaws.sesv2#ImportDestinationType", + "traits": { + "smithy.api#documentation": "

    The destination of the import job, which can be used to list import jobs that have a\n certain ImportDestinationType.

    " + } + }, + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", + "traits": { + "smithy.api#documentation": "

    Maximum number of import jobs to return at once. Use this parameter to paginate\n results. If additional import jobs exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent requests to retrieve additional\n addresses.

    ", + "smithy.api#httpQuery": "PageSize" + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents a request to list all of the import jobs for a data destination within the\n specified maximum number of import jobs.

    " + } + }, + "com.amazonaws.sesv2#ListImportJobsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

    A string token indicating that there might be additional import jobs available to be\n listed. Copy this token to a subsequent call to ListImportJobs with the\n same parameters to retrieve the next page of import jobs.

    " + } + }, + "ImportJobs": { + "target": "com.amazonaws.sesv2#ImportJobSummaryList", + "traits": { + "smithy.api#documentation": "

    A list of the import job summaries.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An HTTP 200 response if the request succeeds, or an error message if the request\n fails.

    " + } + }, "com.amazonaws.sesv2#ListOfDedicatedIpPools": { "type": "list", "member": { @@ -4674,19 +5078,19 @@ }, "com.amazonaws.sesv2#OverallVolume": { "type": "structure", - "members": { - "DomainIspPlacements": { - "target": "com.amazonaws.sesv2#DomainIspPlacements", - "traits": { - "smithy.api#documentation": "

    An object that contains inbox and junk mail placement metrics for individual email\n providers.

    " - } - }, + "members": { "VolumeStatistics": { "target": "com.amazonaws.sesv2#VolumeStatistics", "traits": { "smithy.api#documentation": "

    An object that contains information about the numbers of messages that arrived in\n recipients' inboxes and junk mail folders.

    " } }, + "DomainIspPlacements": { + "target": "com.amazonaws.sesv2#DomainIspPlacements", + "traits": { + "smithy.api#documentation": "

    An object that contains inbox and junk mail placement metrics for individual email\n providers.

    " + } + }, "ReadRatePercent": { "target": "com.amazonaws.sesv2#Percentage", "traits": { @@ -4728,16 +5132,16 @@ "com.amazonaws.sesv2#PlacementStatistics": { "type": "structure", "members": { - "InboxPercentage": { + "SpfPercentage": { "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

    " + "smithy.api#documentation": "

    The percentage of emails that were authenticated by using Sender Policy Framework\n (SPF) during the predictive inbox placement test.

    " } }, - "SpfPercentage": { + "MissingPercentage": { "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of emails that were authenticated by using Sender Policy Framework\n (SPF) during the predictive inbox placement test.

    " + "smithy.api#documentation": "

    The percentage of emails that didn't arrive in recipients' inboxes at all during the\n predictive inbox placement test.

    " } }, "DkimPercentage": { @@ -4746,16 +5150,16 @@ "smithy.api#documentation": "

    The percentage of emails that were authenticated by using DomainKeys Identified Mail\n (DKIM) during the predictive inbox placement test.

    " } }, - "SpamPercentage": { + "InboxPercentage": { "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of emails that arrived in recipients' spam or junk mail folders during\n the predictive inbox placement test.

    " + "smithy.api#documentation": "

    The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

    " } }, - "MissingPercentage": { + "SpamPercentage": { "target": "com.amazonaws.sesv2#Percentage", "traits": { - "smithy.api#documentation": "

    The percentage of emails that didn't arrive in recipients' inboxes at all during the\n predictive inbox placement test.

    " + "smithy.api#documentation": "

    The percentage of emails that arrived in recipients' spam or junk mail folders during\n the predictive inbox placement test.

    " } } }, @@ -4811,6 +5215,12 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.sesv2#ProcessedRecordsCount": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributes": { "type": "operation", "input": { @@ -4888,12 +5298,6 @@ "com.amazonaws.sesv2#PutAccountDetailsRequest": { "type": "structure", "members": { - "ProductionAccessEnabled": { - "target": "com.amazonaws.sesv2#EnabledWrapper", - "traits": { - "smithy.api#documentation": "

    Indicates whether or not your account should have production access in the current\n AWS Region.

    \n

    If the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.

    \n

    If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.

    " - } - }, "MailType": { "target": "com.amazonaws.sesv2#MailType", "traits": { @@ -4901,16 +5305,23 @@ "smithy.api#required": {} } }, + "UseCaseDescription": { + "target": "com.amazonaws.sesv2#UseCaseDescription", + "traits": { + "smithy.api#documentation": "

    A description of the types of email that you plan to send.

    ", + "smithy.api#required": {} + } + }, "ContactLanguage": { "target": "com.amazonaws.sesv2#ContactLanguage", "traits": { "smithy.api#documentation": "

    The language you would prefer to be contacted with.

    " } }, - "UseCaseDescription": { - "target": "com.amazonaws.sesv2#UseCaseDescription", + "WebsiteURL": { + "target": "com.amazonaws.sesv2#WebsiteURL", "traits": { - "smithy.api#documentation": "

    A description of the types of email that you plan to send.

    ", + "smithy.api#documentation": "

    The URL of your website. This information helps us better understand the type of\n content that you plan to send.

    ", "smithy.api#required": {} } }, @@ -4920,11 +5331,10 @@ "smithy.api#documentation": "

    Additional email addresses that you would like to be notified regarding Amazon SES\n matters.

    " } }, - "WebsiteURL": { - "target": "com.amazonaws.sesv2#WebsiteURL", + "ProductionAccessEnabled": { + "target": "com.amazonaws.sesv2#EnabledWrapper", "traits": { - "smithy.api#documentation": "

    The URL of your website. This information helps us better understand the type of\n content that you plan to send.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates whether or not your account should have production access in the current\n AWS Region.

    \n

    If the value is false, then your account is in the\n sandbox. When your account is in the sandbox, you can only send\n email to verified identities. Additionally, the maximum number of emails you can send in\n a 24-hour period (your sending quota) is 200, and the maximum number of emails you can\n send per second (your maximum sending rate) is 1.

    \n

    If the value is true, then your account has production access. When your\n account has production access, you can send email to any address. The sending quota and\n maximum sending rate for your account vary based on your specific use case.

    " } } }, @@ -5411,18 +5821,18 @@ "com.amazonaws.sesv2#PutDedicatedIpWarmupAttributesRequest": { "type": "structure", "members": { - "Ip": { - "target": "com.amazonaws.sesv2#Ip", + "WarmupPercentage": { + "target": "com.amazonaws.sesv2#Percentage100Wrapper", "traits": { - "smithy.api#documentation": "

    The dedicated IP address that you want to update the warm-up attributes for.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The warm-up percentage that you want to associate with the dedicated IP\n address.

    ", "smithy.api#required": {} } }, - "WarmupPercentage": { - "target": "com.amazonaws.sesv2#Percentage100Wrapper", + "Ip": { + "target": "com.amazonaws.sesv2#Ip", "traits": { - "smithy.api#documentation": "

    The warm-up percentage that you want to associate with the dedicated IP\n address.

    ", + "smithy.api#documentation": "

    The dedicated IP address that you want to update the warm-up attributes for.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -5722,6 +6132,12 @@ "com.amazonaws.sesv2#PutEmailIdentityMailFromAttributesRequest": { "type": "structure", "members": { + "BehaviorOnMxFailure": { + "target": "com.amazonaws.sesv2#BehaviorOnMxFailure", + "traits": { + "smithy.api#documentation": "

    The action that you want to take if the required MX record isn't found when you send\n an email. When you set this value to UseDefaultValue, the mail is sent\n using amazonses.com as the MAIL FROM domain. When you set this\n value to RejectMessage, the Amazon SES API v2 returns a\n MailFromDomainNotVerified error, and doesn't attempt to deliver the\n email.

    \n

    These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending, Failed, and TemporaryFailure\n states.

    " + } + }, "EmailIdentity": { "target": "com.amazonaws.sesv2#Identity", "traits": { @@ -5730,12 +6146,6 @@ "smithy.api#required": {} } }, - "BehaviorOnMxFailure": { - "target": "com.amazonaws.sesv2#BehaviorOnMxFailure", - "traits": { - "smithy.api#documentation": "

    The action that you want to take if the required MX record isn't found when you send\n an email. When you set this value to UseDefaultValue, the mail is sent\n using amazonses.com as the MAIL FROM domain. When you set this\n value to RejectMessage, the Amazon SES API v2 returns a\n MailFromDomainNotVerified error, and doesn't attempt to deliver the\n email.

    \n

    These behaviors are taken when the custom MAIL FROM domain configuration is in the\n Pending, Failed, and TemporaryFailure\n states.

    " - } - }, "MailFromDomain": { "target": "com.amazonaws.sesv2#MailFromDomainName", "traits": { @@ -5944,6 +6354,13 @@ ] } }, + "com.amazonaws.sesv2#S3Url": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    An Amazon S3 URL in the format\n s3:///.

    ", + "smithy.api#pattern": "^s3:\\/\\/([^\\/]+)\\/(.*?([^\\/]+)\\/?)$" + } + }, "com.amazonaws.sesv2#Selector": { "type": "string", "traits": { @@ -6000,35 +6417,22 @@ "com.amazonaws.sesv2#SendBulkEmailRequest": { "type": "structure", "members": { - "DefaultEmailTags": { - "target": "com.amazonaws.sesv2#MessageTagList", - "traits": { - "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using the SendEmail operation. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events.

    " - } - }, - "ConfigurationSetName": { - "target": "com.amazonaws.sesv2#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "

    The name of the configuration set that you want to use when sending the email.

    " - } - }, "ReplyToAddresses": { "target": "com.amazonaws.sesv2#EmailAddressList", "traits": { "smithy.api#documentation": "

    The \"Reply-to\" email addresses for the message. When the recipient replies to the\n message, each Reply-to address receives the reply.

    " } }, - "FromEmailAddressIdentityArn": { - "target": "com.amazonaws.sesv2#AmazonResourceName", + "DefaultEmailTags": { + "target": "com.amazonaws.sesv2#MessageTagList", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the FromEmailAddress parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use sender@example.com, then you would specify the\n FromEmailAddressIdentityArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n FromEmailAddress to be sender@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " + "smithy.api#documentation": "

    A list of tags, in the form of name/value pairs, to apply to an email that you send\n using the SendEmail operation. Tags correspond to characteristics of the\n email that you define, so that you can publish email sending events.

    " } }, - "BulkEmailEntries": { - "target": "com.amazonaws.sesv2#BulkEmailEntryList", + "FromEmailAddressIdentityArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The list of bulk email entry objects.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the FromEmailAddress parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use sender@example.com, then you would specify the\n FromEmailAddressIdentityArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n FromEmailAddress to be sender@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " } }, "DefaultContent": { @@ -6038,10 +6442,11 @@ "smithy.api#required": {} } }, - "FeedbackForwardingEmailAddressIdentityArn": { - "target": "com.amazonaws.sesv2#AmazonResourceName", + "BulkEmailEntries": { + "target": "com.amazonaws.sesv2#BulkEmailEntryList", "traits": { - "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the FeedbackForwardingEmailAddress\n parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use feedback@example.com, then you would specify the\n FeedbackForwardingEmailAddressIdentityArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n FeedbackForwardingEmailAddress to be feedback@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " + "smithy.api#documentation": "

    The list of bulk email entry objects.

    ", + "smithy.api#required": {} } }, "FeedbackForwardingEmailAddress": { @@ -6055,6 +6460,18 @@ "traits": { "smithy.api#documentation": "

    The email address that you want to use as the \"From\" address for the email. The\n address that you specify has to be verified.

    " } + }, + "FeedbackForwardingEmailAddressIdentityArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the FeedbackForwardingEmailAddress\n parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use feedback@example.com, then you would specify the\n FeedbackForwardingEmailAddressIdentityArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n FeedbackForwardingEmailAddress to be feedback@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " + } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.sesv2#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "

    The name of the configuration set that you want to use when sending the email.

    " + } } }, "traits": { @@ -6125,18 +6542,18 @@ "smithy.api#required": {} } }, - "ConfigurationSetName": { - "target": "com.amazonaws.sesv2#ConfigurationSetName", - "traits": { - "smithy.api#documentation": "

    Name of a configuration set to use when sending the verification email.

    " - } - }, "TemplateName": { "target": "com.amazonaws.sesv2#EmailTemplateName", "traits": { "smithy.api#documentation": "

    The name of the custom verification email template to use when sending the\n verification email.

    ", "smithy.api#required": {} } + }, + "ConfigurationSetName": { + "target": "com.amazonaws.sesv2#ConfigurationSetName", + "traits": { + "smithy.api#documentation": "

    Name of a configuration set to use when sending the verification email.

    " + } } }, "traits": { @@ -6203,12 +6620,6 @@ "com.amazonaws.sesv2#SendEmailRequest": { "type": "structure", "members": { - "ReplyToAddresses": { - "target": "com.amazonaws.sesv2#EmailAddressList", - "traits": { - "smithy.api#documentation": "

    The \"Reply-to\" email addresses for the message. When the recipient replies to the\n message, each Reply-to address receives the reply.

    " - } - }, "ConfigurationSetName": { "target": "com.amazonaws.sesv2#ConfigurationSetName", "traits": { @@ -6221,16 +6632,16 @@ "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the FromEmailAddress parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use sender@example.com, then you would specify the\n FromEmailAddressIdentityArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n FromEmailAddress to be sender@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    \n

    For Raw emails, the FromEmailAddressIdentityArn value overrides the\n X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message\n content.

    " } }, - "FeedbackForwardingEmailAddress": { - "target": "com.amazonaws.sesv2#EmailAddress", + "ReplyToAddresses": { + "target": "com.amazonaws.sesv2#EmailAddressList", "traits": { - "smithy.api#documentation": "

    The address that you want bounce and complaint notifications to be sent to.

    " + "smithy.api#documentation": "

    The \"Reply-to\" email addresses for the message. When the recipient replies to the\n message, each Reply-to address receives the reply.

    " } }, - "FromEmailAddress": { - "target": "com.amazonaws.sesv2#EmailAddress", + "Destination": { + "target": "com.amazonaws.sesv2#Destination", "traits": { - "smithy.api#documentation": "

    The email address that you want to use as the \"From\" address for the email. The\n address that you specify has to be verified.\n

    " + "smithy.api#documentation": "

    An object that contains the recipients of the email message.

    " } }, "FeedbackForwardingEmailAddressIdentityArn": { @@ -6239,10 +6650,16 @@ "smithy.api#documentation": "

    This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the FeedbackForwardingEmailAddress\n parameter.

    \n

    For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that\n authorizes you to use feedback@example.com, then you would specify the\n FeedbackForwardingEmailAddressIdentityArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n FeedbackForwardingEmailAddress to be feedback@example.com.

    \n

    For more information about sending authorization, see the Amazon SES Developer\n Guide.

    " } }, - "Destination": { - "target": "com.amazonaws.sesv2#Destination", + "FeedbackForwardingEmailAddress": { + "target": "com.amazonaws.sesv2#EmailAddress", "traits": { - "smithy.api#documentation": "

    An object that contains the recipients of the email message.

    " + "smithy.api#documentation": "

    The address that you want bounce and complaint notifications to be sent to.

    " + } + }, + "FromEmailAddress": { + "target": "com.amazonaws.sesv2#EmailAddress", + "traits": { + "smithy.api#documentation": "

    The email address that you want to use as the \"From\" address for the email. The\n address that you specify has to be verified.\n

    " } }, "Content": { @@ -6367,6 +6784,9 @@ { "target": "com.amazonaws.sesv2#CreateEmailTemplate" }, + { + "target": "com.amazonaws.sesv2#CreateImportJob" + }, { "target": "com.amazonaws.sesv2#DeleteConfigurationSet" }, @@ -6433,6 +6853,9 @@ { "target": "com.amazonaws.sesv2#GetEmailTemplate" }, + { + "target": "com.amazonaws.sesv2#GetImportJob" + }, { "target": "com.amazonaws.sesv2#GetSuppressedDestination" }, @@ -6457,6 +6880,9 @@ { "target": "com.amazonaws.sesv2#ListEmailTemplates" }, + { + "target": "com.amazonaws.sesv2#ListImportJobs" + }, { "target": "com.amazonaws.sesv2#ListSuppressedDestinations" }, @@ -6550,7 +6976,7 @@ "sdkId": "SESv2", "arnNamespace": "ses", "cloudFormationName": "SESv2", - "cloudTrailEventSource": "svc.frontend.pinpoint.bacon.amazon.com" + "cloudTrailEventSource": "sesv2.amazonaws.com" }, "aws.auth#sigv4": { "name": "ses" @@ -6587,17 +7013,17 @@ "com.amazonaws.sesv2#SuppressedDestination": { "type": "structure", "members": { - "EmailAddress": { - "target": "com.amazonaws.sesv2#EmailAddress", + "LastUpdateTime": { + "target": "com.amazonaws.sesv2#Timestamp", "traits": { - "smithy.api#documentation": "

    The email address that is on the suppression list for your account.

    ", + "smithy.api#documentation": "

    The date and time when the suppressed destination was last updated, shown in Unix time\n format.

    ", "smithy.api#required": {} } }, - "LastUpdateTime": { - "target": "com.amazonaws.sesv2#Timestamp", + "EmailAddress": { + "target": "com.amazonaws.sesv2#EmailAddress", "traits": { - "smithy.api#documentation": "

    The date and time when the suppressed destination was last updated, shown in Unix time\n format.

    ", + "smithy.api#documentation": "

    The email address that is on the suppression list for your account.

    ", "smithy.api#required": {} } }, @@ -6648,17 +7074,17 @@ "com.amazonaws.sesv2#SuppressedDestinationSummary": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.sesv2#SuppressionListReason", + "EmailAddress": { + "target": "com.amazonaws.sesv2#EmailAddress", "traits": { - "smithy.api#documentation": "

    The reason that the address was added to the suppression list for your account.

    ", + "smithy.api#documentation": "

    The email address that's on the suppression list for your account.

    ", "smithy.api#required": {} } }, - "EmailAddress": { - "target": "com.amazonaws.sesv2#EmailAddress", + "Reason": { + "target": "com.amazonaws.sesv2#SuppressionListReason", "traits": { - "smithy.api#documentation": "

    The email address that's on the suppression list for your account.

    ", + "smithy.api#documentation": "

    The reason that the address was added to the suppression list for your account.

    ", "smithy.api#required": {} } }, @@ -6688,6 +7114,37 @@ "smithy.api#documentation": "

    An object that contains information about the email address suppression preferences\n for your account in the current AWS Region.

    " } }, + "com.amazonaws.sesv2#SuppressionListDestination": { + "type": "structure", + "members": { + "SuppressionListImportAction": { + "target": "com.amazonaws.sesv2#SuppressionListImportAction", + "traits": { + "smithy.api#documentation": "

    The type of action that you want to perform on the address. Acceptable values:

    \n
      \n
    • \n

      PUT: add the addresses to the suppression list. If the record already exists,\n it will override it with the new value.

      \n
      • \n
    • \n

      DELETE: remove the addresses from the suppression list.

      \n
      • \n
    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object that contains details about the action of suppression list.

    " + } + }, + "com.amazonaws.sesv2#SuppressionListImportAction": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    The type of action that you want to perform on the address. Acceptable values:

    \n
      \n
    • \n

      PUT: add the addresses to the suppression list.

      \n
      • \n
    • \n

      DELETE: remove the address from the suppression list.

      \n
      • \n
    ", + "smithy.api#enum": [ + { + "value": "DELETE", + "name": "DELETE" + }, + { + "value": "PUT", + "name": "PUT" + } + ] + } + }, "com.amazonaws.sesv2#SuppressionListReason": { "type": "string", "traits": { @@ -7058,13 +7515,6 @@ "smithy.api#required": {} } }, - "EventDestination": { - "target": "com.amazonaws.sesv2#EventDestinationDefinition", - "traits": { - "smithy.api#documentation": "

    An object that defines the event destination.

    ", - "smithy.api#required": {} - } - }, "EventDestinationName": { "target": "com.amazonaws.sesv2#EventDestinationName", "traits": { @@ -7072,6 +7522,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "EventDestination": { + "target": "com.amazonaws.sesv2#EventDestinationDefinition", + "traits": { + "smithy.api#documentation": "

    An object that defines the event destination.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -7123,18 +7580,18 @@ "smithy.api#required": {} } }, - "TemplateName": { - "target": "com.amazonaws.sesv2#EmailTemplateName", + "TemplateSubject": { + "target": "com.amazonaws.sesv2#EmailTemplateSubject", "traits": { - "smithy.api#documentation": "

    The name of the custom verification email template that you want to update.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The subject line of the custom verification email.

    ", "smithy.api#required": {} } }, - "TemplateSubject": { - "target": "com.amazonaws.sesv2#EmailTemplateSubject", + "TemplateName": { + "target": "com.amazonaws.sesv2#EmailTemplateName", "traits": { - "smithy.api#documentation": "

    The subject line of the custom verification email.

    ", + "smithy.api#documentation": "

    The name of the custom verification email template that you want to update.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -7315,16 +7772,16 @@ "com.amazonaws.sesv2#VolumeStatistics": { "type": "structure", "members": { - "InboxRawCount": { + "ProjectedSpam": { "target": "com.amazonaws.sesv2#Volume", "traits": { - "smithy.api#documentation": "

    The total number of emails that arrived in recipients' inboxes.

    " + "smithy.api#documentation": "

    An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' spam or junk mail folders.

    " } }, - "ProjectedSpam": { + "InboxRawCount": { "target": "com.amazonaws.sesv2#Volume", "traits": { - "smithy.api#documentation": "

    An estimate of the percentage of emails sent from the current domain that will arrive\n in recipients' spam or junk mail folders.

    " + "smithy.api#documentation": "

    The total number of emails that arrived in recipients' inboxes.

    " } }, "ProjectedInbox": { 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 03ec5c5cddac..2495fd194f74 100644 --- a/codegen/sdk-codegen/aws-models/sfn.2016-11-23.json +++ b/codegen/sdk-codegen/aws-models/sfn.2016-11-23.json @@ -105,7 +105,7 @@ "sdkId": "SFN", "arnNamespace": "states", "cloudFormationName": "StepFunctions", - "cloudTrailEventSource": "model.v2.service.swf.amazonaws.com" + "cloudTrailEventSource": "sfn.amazonaws.com" }, "aws.auth#sigv4": { "name": "states" @@ -133,17 +133,17 @@ "com.amazonaws.sfn#ActivityFailedEventDetails": { "type": "structure", "members": { - "cause": { - "target": "com.amazonaws.sfn#SensitiveCause", - "traits": { - "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " - } - }, "error": { "target": "com.amazonaws.sfn#SensitiveError", "traits": { "smithy.api#documentation": "

    The error code of the failure.

    " } + }, + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", + "traits": { + "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " + } } }, "traits": { @@ -171,6 +171,13 @@ "com.amazonaws.sfn#ActivityListItem": { "type": "structure", "members": { + "activityArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that identifies the activity.

    ", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.sfn#Name", "traits": { @@ -184,13 +191,6 @@ "smithy.api#documentation": "

    The date the activity is created.

    ", "smithy.api#required": {} } - }, - "activityArn": { - "target": "com.amazonaws.sfn#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that identifies the activity.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -200,17 +200,17 @@ "com.amazonaws.sfn#ActivityScheduleFailedEventDetails": { "type": "structure", "members": { - "cause": { - "target": "com.amazonaws.sfn#SensitiveCause", - "traits": { - "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " - } - }, "error": { "target": "com.amazonaws.sfn#SensitiveError", "traits": { "smithy.api#documentation": "

    The error code of the failure.

    " } + }, + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", + "traits": { + "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " + } } }, "traits": { @@ -220,10 +220,17 @@ "com.amazonaws.sfn#ActivityScheduledEventDetails": { "type": "structure", "members": { - "input": { - "target": "com.amazonaws.sfn#SensitiveData", + "timeoutInSeconds": { + "target": "com.amazonaws.sfn#TimeoutInSeconds", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum allowed duration of the activity task.

    " + } + }, + "inputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", "traits": { - "smithy.api#documentation": "

    The JSON data input to the activity task.

    " + "smithy.api#documentation": "

    Contains details about the input for an execution history event.

    " } }, "resource": { @@ -233,18 +240,17 @@ "smithy.api#required": {} } }, - "timeoutInSeconds": { + "heartbeatInSeconds": { "target": "com.amazonaws.sfn#TimeoutInSeconds", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum allowed duration of the activity task.

    " + "smithy.api#documentation": "

    The maximum allowed duration between two heartbeats for the activity task.

    " } }, - "heartbeatInSeconds": { - "target": "com.amazonaws.sfn#TimeoutInSeconds", + "input": { + "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum allowed duration between two heartbeats for the activity task.

    " + "smithy.api#documentation": "

    The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } } }, @@ -269,10 +275,16 @@ "com.amazonaws.sfn#ActivitySucceededEventDetails": { "type": "structure", "members": { + "outputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about the output of an execution history event.

    " + } + }, "output": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The JSON data output by the activity task.

    " + "smithy.api#documentation": "

    The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } } }, @@ -283,17 +295,17 @@ "com.amazonaws.sfn#ActivityTimedOutEventDetails": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.sfn#SensitiveError", - "traits": { - "smithy.api#documentation": "

    The error code of the failure.

    " - } - }, "cause": { "target": "com.amazonaws.sfn#SensitiveCause", "traits": { "smithy.api#documentation": "

    A more detailed explanation of the cause of the timeout.

    " } + }, + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

    The error code of the failure.

    " + } } }, "traits": { @@ -321,6 +333,20 @@ } } }, + "com.amazonaws.sfn#CloudWatchEventsExecutionDataDetails": { + "type": "structure", + "members": { + "included": { + "target": "com.amazonaws.sfn#included", + "traits": { + "smithy.api#documentation": "

    Indicates whether input or output was included in the response. Always true\n for API calls.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides details about execution input or output.

    " + } + }, "com.amazonaws.sfn#CloudWatchLogsLogGroup": { "type": "structure", "members": { @@ -340,7 +366,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 32768 + "max": 262144 }, "smithy.api#sensitive": {} } @@ -372,18 +398,18 @@ "com.amazonaws.sfn#CreateActivityInput": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.sfn#TagList", - "traits": { - "smithy.api#documentation": "

    The list of tags to add to a resource.

    \n

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

    \n

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " - } - }, "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, \n see \n Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", + "smithy.api#documentation": "

    The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.sfn#TagList", + "traits": { + "smithy.api#documentation": "

    The list of tags to add to a resource.

    \n

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

    \n

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + } } } }, @@ -427,6 +453,9 @@ { "target": "com.amazonaws.sfn#InvalidName" }, + { + "target": "com.amazonaws.sfn#InvalidTracingConfiguration" + }, { "target": "com.amazonaws.sfn#StateMachineAlreadyExists" }, @@ -444,23 +473,25 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a state machine. A state machine consists of a collection of states that can do\n work (Task states), determine to which states to transition next\n (Choice states), stop an execution with an error (Fail states),\n and so on. State machines are specified using a JSON-based, structured language. For more\n information, see Amazon States\n Language in the AWS Step Functions User Guide.

    \n \n

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    \n     \n \n

    \n CreateStateMachine is an idempotent API. Subsequent requests won’t create a\n duplicate resource if it was already created. CreateStateMachine's idempotency\n check is based on the state machine name, definition,\n type, and LoggingConfiguration. If a following request has a\n different roleArn or tags, Step Functions will ignore these differences and\n treat it as an idempotent request of the previous. In this case, roleArn and\n tags will not be updated, even if they are different.

    \n     ", + "smithy.api#documentation": "

    Creates a state machine. A state machine consists of a collection of states that can do\n work (Task states), determine to which states to transition next\n (Choice states), stop an execution with an error (Fail states),\n and so on. State machines are specified using a JSON-based, structured language. For more\n information, see Amazon States\n Language in the AWS Step Functions User Guide.

    \n \n

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    \n     \n \n

    \n CreateStateMachine is an idempotent API. Subsequent requests won’t create a\n duplicate resource if it was already created. CreateStateMachine's idempotency\n check is based on the state machine name, definition,\n type, LoggingConfiguration and TracingConfiguration. If a following request has a\n different roleArn or tags, Step Functions will ignore these differences and\n treat it as an idempotent request of the previous. In this case, roleArn and\n tags will not be updated, even if they are different.

    \n     ", "smithy.api#idempotent": {} } }, "com.amazonaws.sfn#CreateStateMachineInput": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.sfn#TagList", + "name": { + "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    Tags to be added when creating a state machine.

    \n

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

    \n

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + "smithy.api#documentation": "

    The name of the state machine.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", + "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.sfn#StateMachineType", + "definition": { + "target": "com.amazonaws.sfn#Definition", "traits": { - "smithy.api#documentation": "

    Determines whether a Standard or Express state machine is created. The default is\n STANDARD. You cannot update the type of a state machine once it\n has been created.

    " + "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    ", + "smithy.api#required": {} } }, "loggingConfiguration": { @@ -469,24 +500,28 @@ "smithy.api#documentation": "

    Defines what execution history events are logged and where they are logged.

    \n \n

    By default, the level is set to OFF. For more information see\n Log\n Levels in the AWS Step Functions User Guide.

    \n     " } }, - "name": { - "target": "com.amazonaws.sfn#Name", + "type": { + "target": "com.amazonaws.sfn#StateMachineType", "traits": { - "smithy.api#documentation": "

    The name of the state machine.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Determines whether a Standard or Express state machine is created. The default is\n STANDARD. You cannot update the type of a state machine once it\n has been created.

    " } }, - "roleArn": { - "target": "com.amazonaws.sfn#Arn", + "tags": { + "target": "com.amazonaws.sfn#TagList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Tags to be added when creating a state machine.

    \n

    An array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide, and Controlling Access Using IAM\n Tags.

    \n

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " } }, - "definition": { - "target": "com.amazonaws.sfn#Definition", + "tracingConfiguration": { + "target": "com.amazonaws.sfn#TracingConfiguration", "traits": { - "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    ", + "smithy.api#documentation": "

    Selects whether AWS X-Ray tracing is enabled.

    " + } + }, + "roleArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

    ", "smithy.api#required": {} } } @@ -622,17 +657,17 @@ "com.amazonaws.sfn#DescribeActivityOutput": { "type": "structure", "members": { - "creationDate": { - "target": "com.amazonaws.sfn#Timestamp", + "name": { + "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    The date the activity is created.

    ", + "smithy.api#documentation": "

    The name of the activity.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.sfn#Name", + "creationDate": { + "target": "com.amazonaws.sfn#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the activity.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", + "smithy.api#documentation": "

    The date the activity is created.

    ", "smithy.api#required": {} } }, @@ -680,24 +715,26 @@ "com.amazonaws.sfn#DescribeExecutionOutput": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.sfn#ExecutionStatus", + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

    The current status of the execution.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the executed stated machine.

    ", "smithy.api#required": {} } }, - "stopDate": { - "target": "com.amazonaws.sfn#Timestamp", + "input": { + "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    If the execution has already ended, the date the execution stopped.

    " + "smithy.api#documentation": "

    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } }, - "startDate": { - "target": "com.amazonaws.sfn#Timestamp", + "outputDetails": { + "target": "com.amazonaws.sfn#CloudWatchEventsExecutionDataDetails" + }, + "output": { + "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The date the execution is started.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    \n \n

    This field is set only if the execution succeeds. If the execution fails, this field is\n null.

    \n     " } }, "name": { @@ -706,23 +743,26 @@ "smithy.api#documentation": "

    The name of the execution.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    " } }, - "output": { - "target": "com.amazonaws.sfn#SensitiveData", + "stopDate": { + "target": "com.amazonaws.sfn#Timestamp", "traits": { - "smithy.api#documentation": "

    The JSON output data of the execution.

    \n \n

    This field is set only if the execution succeeds. If the execution fails, this field is\n null.

    \n     " + "smithy.api#documentation": "

    If the execution has already ended, the date the execution stopped.

    " } }, - "stateMachineArn": { - "target": "com.amazonaws.sfn#Arn", + "status": { + "target": "com.amazonaws.sfn#ExecutionStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the executed stated machine.

    ", + "smithy.api#documentation": "

    The current status of the execution.

    ", "smithy.api#required": {} } }, - "input": { - "target": "com.amazonaws.sfn#SensitiveData", + "inputDetails": { + "target": "com.amazonaws.sfn#CloudWatchEventsExecutionDataDetails" + }, + "startDate": { + "target": "com.amazonaws.sfn#Timestamp", "traits": { - "smithy.api#documentation": "

    The string that contains the JSON input data of the execution.

    ", + "smithy.api#documentation": "

    The date the execution is started.

    ", "smithy.api#required": {} } }, @@ -732,6 +772,12 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that id entifies the execution.

    ", "smithy.api#required": {} } + }, + "traceHeader": { + "target": "com.amazonaws.sfn#TraceHeader", + "traits": { + "smithy.api#documentation": "

    The AWS X-Ray trace header which was passed to the execution.

    " + } } } }, @@ -790,16 +836,6 @@ "com.amazonaws.sfn#DescribeStateMachineForExecutionOutput": { "type": "structure", "members": { - "loggingConfiguration": { - "target": "com.amazonaws.sfn#LoggingConfiguration" - }, - "stateMachineArn": { - "target": "com.amazonaws.sfn#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the state machine associated with the execution.

    ", - "smithy.api#required": {} - } - }, "roleArn": { "target": "com.amazonaws.sfn#Arn", "traits": { @@ -814,10 +850,13 @@ "smithy.api#required": {} } }, - "definition": { - "target": "com.amazonaws.sfn#Definition", + "loggingConfiguration": { + "target": "com.amazonaws.sfn#LoggingConfiguration" + }, + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the state machine associated with the execution.

    ", "smithy.api#required": {} } }, @@ -827,6 +866,19 @@ "smithy.api#documentation": "

    The date and time the state machine associated with an execution was updated. For a newly\n created state machine, this is the creation date.

    ", "smithy.api#required": {} } + }, + "definition": { + "target": "com.amazonaws.sfn#Definition", + "traits": { + "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    ", + "smithy.api#required": {} + } + }, + "tracingConfiguration": { + "target": "com.amazonaws.sfn#TracingConfiguration", + "traits": { + "smithy.api#documentation": "

    Selects whether AWS X-Ray tracing is enabled.

    " + } } } }, @@ -845,11 +897,10 @@ "com.amazonaws.sfn#DescribeStateMachineOutput": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.sfn#Arn", + "tracingConfiguration": { + "target": "com.amazonaws.sfn#TracingConfiguration", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role\n maintains security by granting Step Functions access to AWS resources.)

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Selects whether AWS X-Ray tracing is enabled.

    " } }, "stateMachineArn": { @@ -862,17 +913,17 @@ "loggingConfiguration": { "target": "com.amazonaws.sfn#LoggingConfiguration" }, - "definition": { - "target": "com.amazonaws.sfn#Definition", + "roleArn": { + "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role\n maintains security by granting Step Functions access to AWS resources.)

    ", "smithy.api#required": {} } }, - "creationDate": { - "target": "com.amazonaws.sfn#Timestamp", + "definition": { + "target": "com.amazonaws.sfn#Definition", "traits": { - "smithy.api#documentation": "

    The date the state machine is created.

    ", + "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    ", "smithy.api#required": {} } }, @@ -883,6 +934,13 @@ "smithy.api#required": {} } }, + "creationDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date the state machine is created.

    ", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.sfn#Name", "traits": { @@ -898,6 +956,9 @@ } } }, + "com.amazonaws.sfn#Enabled": { + "type": "boolean" + }, "com.amazonaws.sfn#ErrorMessage": { "type": "string" }, @@ -989,10 +1050,10 @@ "com.amazonaws.sfn#ExecutionListItem": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.sfn#ExecutionStatus", + "executionArn": { + "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

    The current status of the execution.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that id entifies the execution.

    ", "smithy.api#required": {} } }, @@ -1003,13 +1064,6 @@ "smithy.api#required": {} } }, - "executionArn": { - "target": "com.amazonaws.sfn#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that id entifies the execution.

    ", - "smithy.api#required": {} - } - }, "startDate": { "target": "com.amazonaws.sfn#Timestamp", "traits": { @@ -1023,10 +1077,17 @@ "smithy.api#documentation": "

    If the execution already ended, the date the execution stopped.

    " } }, - "stateMachineArn": { - "target": "com.amazonaws.sfn#Arn", + "status": { + "target": "com.amazonaws.sfn#ExecutionStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the executed state machine.

    ", + "smithy.api#documentation": "

    The current status of the execution.

    ", + "smithy.api#required": {} + } + }, + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the executed state machine.

    ", "smithy.api#required": {} } } @@ -1038,16 +1099,22 @@ "com.amazonaws.sfn#ExecutionStartedEventDetails": { "type": "structure", "members": { + "input": { + "target": "com.amazonaws.sfn#SensitiveData", + "traits": { + "smithy.api#documentation": "

    The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " + } + }, "roleArn": { "target": "com.amazonaws.sfn#Arn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.

    " } }, - "input": { - "target": "com.amazonaws.sfn#SensitiveData", + "inputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", "traits": { - "smithy.api#documentation": "

    The JSON data input to the execution.

    " + "smithy.api#documentation": "

    Contains details about the input for an execution history event.

    " } } }, @@ -1080,10 +1147,16 @@ "com.amazonaws.sfn#ExecutionSucceededEventDetails": { "type": "structure", "members": { + "outputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about the output of an execution history event.

    " + } + }, "output": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The JSON data output by the execution.

    " + "smithy.api#documentation": "

    The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } } }, @@ -1094,17 +1167,17 @@ "com.amazonaws.sfn#ExecutionTimedOutEventDetails": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.sfn#SensitiveError", - "traits": { - "smithy.api#documentation": "

    The error code of the failure.

    " - } - }, "cause": { "target": "com.amazonaws.sfn#SensitiveCause", "traits": { "smithy.api#documentation": "

    A more detailed explanation of the cause of the timeout.

    " } + }, + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

    The error code of the failure.

    " + } } }, "traits": { @@ -1164,7 +1237,7 @@ "input": { "target": "com.amazonaws.sfn#SensitiveDataJobInput", "traits": { - "smithy.api#documentation": "

    The string that contains the JSON input data for the task.

    " + "smithy.api#documentation": "

    The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } } } @@ -1201,6 +1274,19 @@ "com.amazonaws.sfn#GetExecutionHistoryInput": { "type": "structure", "members": { + "executionArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the execution.

    ", + "smithy.api#required": {} + } + }, + "includeExecutionData": { + "target": "com.amazonaws.sfn#IncludeExecutionDataGetExecutionHistory", + "traits": { + "smithy.api#documentation": "

    You can select whether execution data (input or output of a history event) is returned.\n The default is true.

    " + } + }, "maxResults": { "target": "com.amazonaws.sfn#PageSize", "traits": { @@ -1218,13 +1304,6 @@ "traits": { "smithy.api#documentation": "

    Lists events in descending order of their timeStamp.

    " } - }, - "executionArn": { - "target": "com.amazonaws.sfn#Arn", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the execution.

    ", - "smithy.api#required": {} - } } } }, @@ -1249,21 +1328,48 @@ "com.amazonaws.sfn#HistoryEvent": { "type": "structure", "members": { - "activityScheduleFailedEventDetails": { - "target": "com.amazonaws.sfn#ActivityScheduleFailedEventDetails", + "lambdaFunctionStartFailedEventDetails": { + "target": "com.amazonaws.sfn#LambdaFunctionStartFailedEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about an activity schedule event that failed during an execution.

    " + "smithy.api#documentation": "

    Contains details about a lambda function that failed to start during an execution.

    " } }, - "executionSucceededEventDetails": { - "target": "com.amazonaws.sfn#ExecutionSucceededEventDetails" + "taskScheduledEventDetails": { + "target": "com.amazonaws.sfn#TaskScheduledEventDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about a task that was scheduled.

    " + } }, - "taskSucceededEventDetails": { - "target": "com.amazonaws.sfn#TaskSucceededEventDetails", + "lambdaFunctionScheduledEventDetails": { + "target": "com.amazonaws.sfn#LambdaFunctionScheduledEventDetails" + }, + "mapIterationFailedEventDetails": { + "target": "com.amazonaws.sfn#MapIterationEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about a task that succeeded.

    " + "smithy.api#documentation": "

    Contains details about an iteration of a Map state that failed.

    " + } + }, + "taskFailedEventDetails": { + "target": "com.amazonaws.sfn#TaskFailedEventDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about the failure of a task.

    " } }, + "activityFailedEventDetails": { + "target": "com.amazonaws.sfn#ActivityFailedEventDetails" + }, + "executionAbortedEventDetails": { + "target": "com.amazonaws.sfn#ExecutionAbortedEventDetails" + }, + "mapStateStartedEventDetails": { + "target": "com.amazonaws.sfn#MapStateStartedEventDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about Map state that was started.

    " + } + }, + "lambdaFunctionTimedOutEventDetails": { + "target": "com.amazonaws.sfn#LambdaFunctionTimedOutEventDetails" + }, "type": { "target": "com.amazonaws.sfn#HistoryEventType", "traits": { @@ -1271,23 +1377,32 @@ "smithy.api#required": {} } }, - "lambdaFunctionSucceededEventDetails": { - "target": "com.amazonaws.sfn#LambdaFunctionSucceededEventDetails", + "taskSubmitFailedEventDetails": { + "target": "com.amazonaws.sfn#TaskSubmitFailedEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about a lambda function that terminated successfully during an\n execution.

    " + "smithy.api#documentation": "

    Contains details about a task that where the submit failed.

    " } }, - "lambdaFunctionTimedOutEventDetails": { - "target": "com.amazonaws.sfn#LambdaFunctionTimedOutEventDetails" + "mapIterationStartedEventDetails": { + "target": "com.amazonaws.sfn#MapIterationEventDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about an iteration of a Map state that was started.

    " + } }, - "stateEnteredEventDetails": { - "target": "com.amazonaws.sfn#StateEnteredEventDetails" + "previousEventId": { + "target": "com.amazonaws.sfn#EventId", + "traits": { + "smithy.api#documentation": "

    The id of the previous event.

    " + } }, - "stateExitedEventDetails": { - "target": "com.amazonaws.sfn#StateExitedEventDetails" + "taskStartedEventDetails": { + "target": "com.amazonaws.sfn#TaskStartedEventDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about a task that was started.

    " + } }, - "executionTimedOutEventDetails": { - "target": "com.amazonaws.sfn#ExecutionTimedOutEventDetails" + "activityStartedEventDetails": { + "target": "com.amazonaws.sfn#ActivityStartedEventDetails" }, "timestamp": { "target": "com.amazonaws.sfn#Timestamp", @@ -1296,52 +1411,49 @@ "smithy.api#required": {} } }, - "activitySucceededEventDetails": { - "target": "com.amazonaws.sfn#ActivitySucceededEventDetails" - }, - "taskFailedEventDetails": { - "target": "com.amazonaws.sfn#TaskFailedEventDetails", - "traits": { - "smithy.api#documentation": "

    Contains details about the failure of a task.

    " - } + "executionTimedOutEventDetails": { + "target": "com.amazonaws.sfn#ExecutionTimedOutEventDetails" }, - "activityTimedOutEventDetails": { - "target": "com.amazonaws.sfn#ActivityTimedOutEventDetails" + "lambdaFunctionFailedEventDetails": { + "target": "com.amazonaws.sfn#LambdaFunctionFailedEventDetails" }, - "mapIterationFailedEventDetails": { - "target": "com.amazonaws.sfn#MapIterationEventDetails", + "lambdaFunctionSucceededEventDetails": { + "target": "com.amazonaws.sfn#LambdaFunctionSucceededEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about an iteration of a Map state that failed.

    " + "smithy.api#documentation": "

    Contains details about a lambda function that terminated successfully during an\n execution.

    " } }, - "mapIterationSucceededEventDetails": { - "target": "com.amazonaws.sfn#MapIterationEventDetails", + "taskTimedOutEventDetails": { + "target": "com.amazonaws.sfn#TaskTimedOutEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about an iteration of a Map state that succeeded.

    " + "smithy.api#documentation": "

    Contains details about a task that timed out.

    " } }, - "taskSubmittedEventDetails": { - "target": "com.amazonaws.sfn#TaskSubmittedEventDetails", + "activityTimedOutEventDetails": { + "target": "com.amazonaws.sfn#ActivityTimedOutEventDetails" + }, + "taskSucceededEventDetails": { + "target": "com.amazonaws.sfn#TaskSucceededEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about a submitted task.

    " + "smithy.api#documentation": "

    Contains details about a task that succeeded.

    " } }, - "activityScheduledEventDetails": { - "target": "com.amazonaws.sfn#ActivityScheduledEventDetails" + "executionSucceededEventDetails": { + "target": "com.amazonaws.sfn#ExecutionSucceededEventDetails" }, - "taskStartFailedEventDetails": { - "target": "com.amazonaws.sfn#TaskStartFailedEventDetails", - "traits": { - "smithy.api#documentation": "

    Contains details about a task that failed to start.

    " - } + "activitySucceededEventDetails": { + "target": "com.amazonaws.sfn#ActivitySucceededEventDetails" }, - "lambdaFunctionScheduleFailedEventDetails": { - "target": "com.amazonaws.sfn#LambdaFunctionScheduleFailedEventDetails" + "stateExitedEventDetails": { + "target": "com.amazonaws.sfn#StateExitedEventDetails" }, - "mapIterationAbortedEventDetails": { + "executionStartedEventDetails": { + "target": "com.amazonaws.sfn#ExecutionStartedEventDetails" + }, + "mapIterationSucceededEventDetails": { "target": "com.amazonaws.sfn#MapIterationEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about an iteration of a Map state that was aborted.

    " + "smithy.api#documentation": "

    Contains details about an iteration of a Map state that succeeded.

    " } }, "id": { @@ -1351,78 +1463,59 @@ "smithy.api#required": {} } }, - "lambdaFunctionStartFailedEventDetails": { - "target": "com.amazonaws.sfn#LambdaFunctionStartFailedEventDetails", - "traits": { - "smithy.api#documentation": "

    Contains details about a lambda function that failed to start during an execution.

    " - } - }, - "executionStartedEventDetails": { - "target": "com.amazonaws.sfn#ExecutionStartedEventDetails" - }, - "lambdaFunctionScheduledEventDetails": { - "target": "com.amazonaws.sfn#LambdaFunctionScheduledEventDetails" - }, "executionFailedEventDetails": { "target": "com.amazonaws.sfn#ExecutionFailedEventDetails" }, - "activityFailedEventDetails": { - "target": "com.amazonaws.sfn#ActivityFailedEventDetails" - }, - "executionAbortedEventDetails": { - "target": "com.amazonaws.sfn#ExecutionAbortedEventDetails" - }, - "taskSubmitFailedEventDetails": { - "target": "com.amazonaws.sfn#TaskSubmitFailedEventDetails", - "traits": { - "smithy.api#documentation": "

    Contains details about a task that where the submit failed.

    " - } + "stateEnteredEventDetails": { + "target": "com.amazonaws.sfn#StateEnteredEventDetails" }, - "taskTimedOutEventDetails": { - "target": "com.amazonaws.sfn#TaskTimedOutEventDetails", + "mapIterationAbortedEventDetails": { + "target": "com.amazonaws.sfn#MapIterationEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about a task that timed out.

    " + "smithy.api#documentation": "

    Contains details about an iteration of a Map state that was aborted.

    " } }, - "lambdaFunctionFailedEventDetails": { - "target": "com.amazonaws.sfn#LambdaFunctionFailedEventDetails" + "lambdaFunctionScheduleFailedEventDetails": { + "target": "com.amazonaws.sfn#LambdaFunctionScheduleFailedEventDetails" }, - "mapStateStartedEventDetails": { - "target": "com.amazonaws.sfn#MapStateStartedEventDetails", + "activityScheduleFailedEventDetails": { + "target": "com.amazonaws.sfn#ActivityScheduleFailedEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about Map state that was started.

    " + "smithy.api#documentation": "

    Contains details about an activity schedule event that failed during an execution.

    " } }, - "taskScheduledEventDetails": { - "target": "com.amazonaws.sfn#TaskScheduledEventDetails", - "traits": { - "smithy.api#documentation": "

    Contains details about a task that was scheduled.

    " - } + "activityScheduledEventDetails": { + "target": "com.amazonaws.sfn#ActivityScheduledEventDetails" }, - "previousEventId": { - "target": "com.amazonaws.sfn#EventId", + "taskStartFailedEventDetails": { + "target": "com.amazonaws.sfn#TaskStartFailedEventDetails", "traits": { - "smithy.api#documentation": "

    The id of the previous event.

    " + "smithy.api#documentation": "

    Contains details about a task that failed to start.

    " } }, - "taskStartedEventDetails": { - "target": "com.amazonaws.sfn#TaskStartedEventDetails", + "taskSubmittedEventDetails": { + "target": "com.amazonaws.sfn#TaskSubmittedEventDetails", "traits": { - "smithy.api#documentation": "

    Contains details about a task that was started.

    " + "smithy.api#documentation": "

    Contains details about a submitted task.

    " } - }, - "mapIterationStartedEventDetails": { - "target": "com.amazonaws.sfn#MapIterationEventDetails", + } + }, + "traits": { + "smithy.api#documentation": "

    Contains details about the events of an execution.

    " + } + }, + "com.amazonaws.sfn#HistoryEventExecutionDataDetails": { + "type": "structure", + "members": { + "truncated": { + "target": "com.amazonaws.sfn#truncated", "traits": { - "smithy.api#documentation": "

    Contains details about an iteration of a Map state that was started.

    " + "smithy.api#documentation": "

    Indicates whether input or output was truncated in the response. Always\n false for API calls.

    " } - }, - "activityStartedEventDetails": { - "target": "com.amazonaws.sfn#ActivityStartedEventDetails" } }, "traits": { - "smithy.api#documentation": "

    Contains details about the events of an execution.

    " + "smithy.api#documentation": "

    Provides details about input or output in an execution history event.

    " } }, "com.amazonaws.sfn#HistoryEventList": { @@ -1618,6 +1711,12 @@ "com.amazonaws.sfn#IncludeExecutionData": { "type": "boolean" }, + "com.amazonaws.sfn#IncludeExecutionDataGetExecutionHistory": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.sfn#InvalidArn": { "type": "structure", "members": { @@ -1702,20 +1801,32 @@ "smithy.api#error": "client" } }, + "com.amazonaws.sfn#InvalidTracingConfiguration": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sfn#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    Your tracingConfiguration key does not match, or enabled has not been set to true or false.

    ", + "smithy.api#error": "client" + } + }, "com.amazonaws.sfn#LambdaFunctionFailedEventDetails": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.sfn#SensitiveError", - "traits": { - "smithy.api#documentation": "

    The error code of the failure.

    " - } - }, "cause": { "target": "com.amazonaws.sfn#SensitiveCause", "traits": { "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " } + }, + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

    The error code of the failure.

    " + } } }, "traits": { @@ -1725,17 +1836,17 @@ "com.amazonaws.sfn#LambdaFunctionScheduleFailedEventDetails": { "type": "structure", "members": { - "cause": { - "target": "com.amazonaws.sfn#SensitiveCause", - "traits": { - "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " - } - }, "error": { "target": "com.amazonaws.sfn#SensitiveError", "traits": { "smithy.api#documentation": "

    The error code of the failure.

    " } + }, + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", + "traits": { + "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " + } } }, "traits": { @@ -1745,10 +1856,10 @@ "com.amazonaws.sfn#LambdaFunctionScheduledEventDetails": { "type": "structure", "members": { - "input": { - "target": "com.amazonaws.sfn#SensitiveData", + "inputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", "traits": { - "smithy.api#documentation": "

    The JSON data input to the lambda function.

    " + "smithy.api#documentation": "

    Contains details about input for an execution history event.

    " } }, "timeoutInSeconds": { @@ -1758,6 +1869,12 @@ "smithy.api#documentation": "

    The maximum allowed duration of the lambda function.

    " } }, + "input": { + "target": "com.amazonaws.sfn#SensitiveData", + "traits": { + "smithy.api#documentation": "

    The JSON data input to the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " + } + }, "resource": { "target": "com.amazonaws.sfn#Arn", "traits": { @@ -1773,17 +1890,17 @@ "com.amazonaws.sfn#LambdaFunctionStartFailedEventDetails": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.sfn#SensitiveError", - "traits": { - "smithy.api#documentation": "

    The error code of the failure.

    " - } - }, "cause": { "target": "com.amazonaws.sfn#SensitiveCause", "traits": { "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " } + }, + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

    The error code of the failure.

    " + } } }, "traits": { @@ -1793,10 +1910,16 @@ "com.amazonaws.sfn#LambdaFunctionSucceededEventDetails": { "type": "structure", "members": { + "outputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about the output of an execution history event.

    " + } + }, "output": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The JSON data output by the lambda function.

    " + "smithy.api#documentation": "

    The JSON data output by the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } } }, @@ -1850,17 +1973,17 @@ "com.amazonaws.sfn#ListActivitiesInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.sfn#PageToken", - "traits": { - "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " - } - }, "maxResults": { "target": "com.amazonaws.sfn#PageSize", "traits": { "smithy.api#documentation": "

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    \n

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    " } + }, + "nextToken": { + "target": "com.amazonaws.sfn#PageToken", + "traits": { + "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } } } }, @@ -1917,12 +2040,6 @@ "com.amazonaws.sfn#ListExecutionsInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.sfn#ListExecutionsPageToken", - "traits": { - "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " - } - }, "stateMachineArn": { "target": "com.amazonaws.sfn#Arn", "traits": { @@ -1936,6 +2053,12 @@ "smithy.api#documentation": "

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    \n

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    " } }, + "nextToken": { + "target": "com.amazonaws.sfn#ListExecutionsPageToken", + "traits": { + "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + }, "statusFilter": { "target": "com.amazonaws.sfn#ExecutionStatus", "traits": { @@ -1947,18 +2070,18 @@ "com.amazonaws.sfn#ListExecutionsOutput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.sfn#ListExecutionsPageToken", - "traits": { - "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " - } - }, "executions": { "target": "com.amazonaws.sfn#ExecutionList", "traits": { "smithy.api#documentation": "

    The list of matching executions.

    ", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.sfn#ListExecutionsPageToken", + "traits": { + "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } } } }, @@ -1997,17 +2120,17 @@ "com.amazonaws.sfn#ListStateMachinesInput": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.sfn#PageToken", - "traits": { - "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " - } - }, "maxResults": { "target": "com.amazonaws.sfn#PageSize", "traits": { "smithy.api#documentation": "

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.\n The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    \n

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    " } + }, + "nextToken": { + "target": "com.amazonaws.sfn#PageToken", + "traits": { + "smithy.api#documentation": "

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } } } }, @@ -2116,7 +2239,7 @@ "includeExecutionData": { "target": "com.amazonaws.sfn#IncludeExecutionData", "traits": { - "smithy.api#documentation": "

    Determines whether execution data is included in your log. When set to FALSE,\n data is excluded.

    " + "smithy.api#documentation": "

    Determines whether execution data is included in your log. When set to false,\n data is excluded.

    " } }, "destinations": { @@ -2212,11 +2335,11 @@ "com.amazonaws.sfn#ResourceNotFound": { "type": "structure", "members": { - "resourceName": { - "target": "com.amazonaws.sfn#Arn" - }, "message": { "target": "com.amazonaws.sfn#ErrorMessage" + }, + "resourceName": { + "target": "com.amazonaws.sfn#Arn" } }, "traits": { @@ -2254,12 +2377,6 @@ "com.amazonaws.sfn#SendTaskFailureInput": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.sfn#SensitiveError", - "traits": { - "smithy.api#documentation": "

    The error code of the failure.

    " - } - }, "taskToken": { "target": "com.amazonaws.sfn#TaskToken", "traits": { @@ -2267,6 +2384,12 @@ "smithy.api#required": {} } }, + "error": { + "target": "com.amazonaws.sfn#SensitiveError", + "traits": { + "smithy.api#documentation": "

    The error code of the failure.

    " + } + }, "cause": { "target": "com.amazonaws.sfn#SensitiveCause", "traits": { @@ -2347,17 +2470,17 @@ "com.amazonaws.sfn#SendTaskSuccessInput": { "type": "structure", "members": { - "taskToken": { - "target": "com.amazonaws.sfn#TaskToken", + "output": { + "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The token that represents this task. Task tokens are generated by Step Functions when\n tasks are assigned to a worker, or in the context object when a\n workflow enters a task state. See GetActivityTaskOutput$taskToken.

    ", + "smithy.api#documentation": "

    The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    ", "smithy.api#required": {} } }, - "output": { - "target": "com.amazonaws.sfn#SensitiveData", + "taskToken": { + "target": "com.amazonaws.sfn#TaskToken", "traits": { - "smithy.api#documentation": "

    The JSON output of the task.

    ", + "smithy.api#documentation": "

    The token that represents this task. Task tokens are generated by Step Functions when\n tasks are assigned to a worker, or in the context object when a\n workflow enters a task state. See GetActivityTaskOutput$taskToken.

    ", "smithy.api#required": {} } } @@ -2382,7 +2505,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 32768 + "max": 262144 }, "smithy.api#sensitive": {} } @@ -2392,7 +2515,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 65536 + "max": 262144 }, "smithy.api#sensitive": {} } @@ -2446,10 +2569,10 @@ "com.amazonaws.sfn#StartExecutionInput": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.sfn#Name", + "input": { + "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, \n see \n Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    " + "smithy.api#documentation": "

    The string that contains the JSON input data for the execution, for example:

    \n

    \n \"input\": \"{\\\"first_name\\\" : \\\"test\\\"}\"\n

    \n \n

    If you don't include any JSON input data, you still must include the two braces, for\n example: \"input\": \"{}\"\n

    \n     \n

    Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } }, "stateMachineArn": { @@ -2459,10 +2582,16 @@ "smithy.api#required": {} } }, - "input": { - "target": "com.amazonaws.sfn#SensitiveData", + "name": { + "target": "com.amazonaws.sfn#Name", + "traits": { + "smithy.api#documentation": "

    The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    " + } + }, + "traceHeader": { + "target": "com.amazonaws.sfn#TraceHeader", "traits": { - "smithy.api#documentation": "

    The string that contains the JSON input data for the execution, for example:

    \n

    \n \"input\": \"{\\\"first_name\\\" : \\\"test\\\"}\"\n

    \n \n

    If you don't include any JSON input data, you still must include the two braces, for\n example: \"input\": \"{}\"\n

    \n     " + "smithy.api#documentation": "

    Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

    " } } } @@ -2470,17 +2599,17 @@ "com.amazonaws.sfn#StartExecutionOutput": { "type": "structure", "members": { - "startDate": { - "target": "com.amazonaws.sfn#Timestamp", + "executionArn": { + "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

    The date the execution is started.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that id entifies the execution.

    ", "smithy.api#required": {} } }, - "executionArn": { - "target": "com.amazonaws.sfn#Arn", + "startDate": { + "target": "com.amazonaws.sfn#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that id entifies the execution.

    ", + "smithy.api#documentation": "

    The date the execution is started.

    ", "smithy.api#required": {} } } @@ -2489,6 +2618,12 @@ "com.amazonaws.sfn#StateEnteredEventDetails": { "type": "structure", "members": { + "input": { + "target": "com.amazonaws.sfn#SensitiveData", + "traits": { + "smithy.api#documentation": "

    The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " + } + }, "name": { "target": "com.amazonaws.sfn#Name", "traits": { @@ -2496,10 +2631,10 @@ "smithy.api#required": {} } }, - "input": { - "target": "com.amazonaws.sfn#SensitiveData", + "inputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", "traits": { - "smithy.api#documentation": "

    The string that contains the JSON input data for the state.

    " + "smithy.api#documentation": "

    Contains details about the input for an execution history event.

    " } } }, @@ -2520,7 +2655,13 @@ "output": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The JSON output data of the state.

    " + "smithy.api#documentation": "

    The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " + } + }, + "outputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about the output of an execution history event.

    " } } }, @@ -2585,13 +2726,6 @@ "com.amazonaws.sfn#StateMachineListItem": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.sfn#Name", - "traits": { - "smithy.api#documentation": "

    The name of the state machine.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", - "smithy.api#required": {} - } - }, "creationDate": { "target": "com.amazonaws.sfn#Timestamp", "traits": { @@ -2599,10 +2733,10 @@ "smithy.api#required": {} } }, - "stateMachineArn": { - "target": "com.amazonaws.sfn#Arn", + "name": { + "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that identifies the state machine.

    ", + "smithy.api#documentation": "

    The name of the state machine.

    \n

    A name must not contain:

    \n
      \n
    • \n

      white space

      \n
      • \n
    • \n

      brackets < > { } [ ]\n

      \n
      • \n
    • \n

      wildcard characters ? *\n

      \n
      • \n
    • \n

      special characters \" # % \\ ^ | ~ ` $ & , ; : /\n

      \n
      • \n
    • \n

      control characters (U+0000-001F, U+007F-009F)

      \n
      • \n
    \n

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

    ", "smithy.api#required": {} } }, @@ -2612,6 +2746,13 @@ "smithy.api#documentation": "

    ", "smithy.api#required": {} } + }, + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that identifies the state machine.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -2679,12 +2820,6 @@ "com.amazonaws.sfn#StopExecutionInput": { "type": "structure", "members": { - "cause": { - "target": "com.amazonaws.sfn#SensitiveCause", - "traits": { - "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " - } - }, "error": { "target": "com.amazonaws.sfn#SensitiveError", "traits": { @@ -2697,6 +2832,12 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the execution to stop.

    ", "smithy.api#required": {} } + }, + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", + "traits": { + "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " + } } } }, @@ -2715,17 +2856,17 @@ "com.amazonaws.sfn#Tag": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.sfn#TagKey", - "traits": { - "smithy.api#documentation": "

    The key of a tag.

    " - } - }, "value": { "target": "com.amazonaws.sfn#TagValue", "traits": { "smithy.api#documentation": "

    The value of a tag.

    " } + }, + "key": { + "target": "com.amazonaws.sfn#TagKey", + "traits": { + "smithy.api#documentation": "

    The key of a tag.

    " + } } }, "traits": { @@ -2822,10 +2963,10 @@ "com.amazonaws.sfn#TaskFailedEventDetails": { "type": "structure", "members": { - "cause": { - "target": "com.amazonaws.sfn#SensitiveCause", + "error": { + "target": "com.amazonaws.sfn#SensitiveError", "traits": { - "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " + "smithy.api#documentation": "

    The error code of the failure.

    " } }, "resource": { @@ -2835,10 +2976,10 @@ "smithy.api#required": {} } }, - "error": { - "target": "com.amazonaws.sfn#SensitiveError", + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", "traits": { - "smithy.api#documentation": "

    The error code of the failure.

    " + "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " } }, "resourceType": { @@ -2856,18 +2997,18 @@ "com.amazonaws.sfn#TaskScheduledEventDetails": { "type": "structure", "members": { - "resourceType": { + "resource": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    The action of the resource called by a task state.

    ", + "smithy.api#documentation": "

    The service name of the resource in a task state.

    ", "smithy.api#required": {} } }, - "resource": { - "target": "com.amazonaws.sfn#Name", + "heartbeatInSeconds": { + "target": "com.amazonaws.sfn#TimeoutInSeconds", "traits": { - "smithy.api#documentation": "

    The service name of the resource in a task state.

    ", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum allowed duration between two heartbeats for the task.

    " } }, "region": { @@ -2877,19 +3018,26 @@ "smithy.api#required": {} } }, - "timeoutInSeconds": { - "target": "com.amazonaws.sfn#TimeoutInSeconds", + "resourceType": { + "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum allowed duration of the task.

    " + "smithy.api#documentation": "

    The action of the resource called by a task state.

    ", + "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.sfn#ConnectorParameters", "traits": { - "smithy.api#documentation": "

    The JSON data passed to the resource referenced in a task state.

    ", + "smithy.api#documentation": "

    The JSON data passed to the resource referenced in a task state.\n Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    ", "smithy.api#required": {} } + }, + "timeoutInSeconds": { + "target": "com.amazonaws.sfn#TimeoutInSeconds", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum allowed duration of the task.

    " + } } }, "traits": { @@ -2899,10 +3047,11 @@ "com.amazonaws.sfn#TaskStartFailedEventDetails": { "type": "structure", "members": { - "cause": { - "target": "com.amazonaws.sfn#SensitiveCause", + "resource": { + "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " + "smithy.api#documentation": "

    The service name of the resource in a task state.

    ", + "smithy.api#required": {} } }, "error": { @@ -2918,11 +3067,10 @@ "smithy.api#required": {} } }, - "resource": { - "target": "com.amazonaws.sfn#Name", + "cause": { + "target": "com.amazonaws.sfn#SensitiveCause", "traits": { - "smithy.api#documentation": "

    The service name of the resource in a task state.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " } } }, @@ -2992,22 +3140,28 @@ "output": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The response from a resource when a task has started.

    " + "smithy.api#documentation": "

    The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } }, - "resource": { + "resourceType": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    The service name of the resource in a task state.

    ", + "smithy.api#documentation": "

    The action of the resource called by a task state.

    ", "smithy.api#required": {} } }, - "resourceType": { + "resource": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

    The action of the resource called by a task state.

    ", + "smithy.api#documentation": "

    The service name of the resource in a task state.

    ", "smithy.api#required": {} } + }, + "outputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about the output of an execution history event.

    " + } } }, "traits": { @@ -3017,6 +3171,12 @@ "com.amazonaws.sfn#TaskSucceededEventDetails": { "type": "structure", "members": { + "outputDetails": { + "target": "com.amazonaws.sfn#HistoryEventExecutionDataDetails", + "traits": { + "smithy.api#documentation": "

    Contains details about the output of an execution history event.

    " + } + }, "resourceType": { "target": "com.amazonaws.sfn#Name", "traits": { @@ -3034,7 +3194,7 @@ "output": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

    The full JSON response from a resource when a task has succeeded. This response becomes\n the output of the related task.

    " + "smithy.api#documentation": "

    The full JSON response from a resource when a task has succeeded. This response becomes\n the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    " } } }, @@ -3056,6 +3216,13 @@ "com.amazonaws.sfn#TaskTimedOutEventDetails": { "type": "structure", "members": { + "resourceType": { + "target": "com.amazonaws.sfn#Name", + "traits": { + "smithy.api#documentation": "

    The action of the resource called by a task state.

    ", + "smithy.api#required": {} + } + }, "error": { "target": "com.amazonaws.sfn#SensitiveError", "traits": { @@ -3074,13 +3241,6 @@ "traits": { "smithy.api#documentation": "

    A more detailed explanation of the cause of the failure.

    " } - }, - "resourceType": { - "target": "com.amazonaws.sfn#Name", - "traits": { - "smithy.api#documentation": "

    The action of the resource called by a task state.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -3105,11 +3265,11 @@ "com.amazonaws.sfn#TooManyTags": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.sfn#ErrorMessage" - }, "resourceName": { "target": "com.amazonaws.sfn#Arn" + }, + "message": { + "target": "com.amazonaws.sfn#ErrorMessage" } }, "traits": { @@ -3118,6 +3278,30 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.sfn#TraceHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\p{ASCII}*" + } + }, + "com.amazonaws.sfn#TracingConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.sfn#Enabled", + "traits": { + "smithy.api#documentation": "

    When set to true, AWS X-Ray tracing is enabled.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Selects whether or not the state machine's AWS X-Ray tracing is enabled. Default is false\n

    " + } + }, "com.amazonaws.sfn#UnsignedInteger": { "type": "integer", "traits": { @@ -3187,6 +3371,9 @@ { "target": "com.amazonaws.sfn#InvalidLoggingConfiguration" }, + { + "target": "com.amazonaws.sfn#InvalidTracingConfiguration" + }, { "target": "com.amazonaws.sfn#MissingRequiredParameter" }, @@ -3205,10 +3392,11 @@ "com.amazonaws.sfn#UpdateStateMachineInput": { "type": "structure", "members": { - "definition": { - "target": "com.amazonaws.sfn#Definition", + "stateMachineArn": { + "target": "com.amazonaws.sfn#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the state machine.

    ", + "smithy.api#required": {} } }, "loggingConfiguration": { @@ -3217,11 +3405,16 @@ "smithy.api#documentation": "

    The LoggingConfiguration data type is used to set CloudWatch Logs\n options.

    " } }, - "stateMachineArn": { - "target": "com.amazonaws.sfn#Arn", + "definition": { + "target": "com.amazonaws.sfn#Definition", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the state machine.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon States Language definition of the state machine. See Amazon States Language.

    " + } + }, + "tracingConfiguration": { + "target": "com.amazonaws.sfn#TracingConfiguration", + "traits": { + "smithy.api#documentation": "

    Selects whether AWS X-Ray tracing is enabled.

    " } }, "roleArn": { @@ -3243,6 +3436,12 @@ } } } + }, + "com.amazonaws.sfn#included": { + "type": "boolean" + }, + "com.amazonaws.sfn#truncated": { + "type": "boolean" } } } diff --git a/codegen/sdk-codegen/aws-models/shield.2016-06-02.json b/codegen/sdk-codegen/aws-models/shield.2016-06-02.json index cfe0346d73a2..6cb8861081f7 100644 --- a/codegen/sdk-codegen/aws-models/shield.2016-06-02.json +++ b/codegen/sdk-codegen/aws-models/shield.2016-06-02.json @@ -108,7 +108,7 @@ "sdkId": "Shield", "arnNamespace": "shield", "cloudFormationName": "Shield", - "cloudTrailEventSource": "v20160616.bardockcustomerapiservice.amazonaws.com" + "cloudTrailEventSource": "shield.amazonaws.com" }, "aws.auth#sigv4": { "name": "shield" @@ -347,12 +347,6 @@ "com.amazonaws.shield#AttackDetail": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.shield#AttackTimestamp", - "traits": { - "smithy.api#documentation": "

    The time the attack started, in Unix time in seconds. For more information see timestamp.

    " - } - }, "SubResources": { "target": "com.amazonaws.shield#SubResourceSummaryList", "traits": { @@ -371,16 +365,22 @@ "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the resource that was attacked.

    " } }, + "EndTime": { + "target": "com.amazonaws.shield#AttackTimestamp", + "traits": { + "smithy.api#documentation": "

    The time the attack ended, in Unix time in seconds. For more information see timestamp.

    " + } + }, "AttackId": { "target": "com.amazonaws.shield#AttackId", "traits": { "smithy.api#documentation": "

    The unique identifier (ID) of the attack.

    " } }, - "EndTime": { - "target": "com.amazonaws.shield#AttackTimestamp", + "Mitigations": { + "target": "com.amazonaws.shield#MitigationList", "traits": { - "smithy.api#documentation": "

    The time the attack ended, in Unix time in seconds. For more information see timestamp.

    " + "smithy.api#documentation": "

    List of mitigation actions taken for the attack.

    " } }, "AttackCounters": { @@ -389,10 +389,10 @@ "smithy.api#documentation": "

    List of counters that describe the attack for the specified time period.

    " } }, - "Mitigations": { - "target": "com.amazonaws.shield#MitigationList", + "StartTime": { + "target": "com.amazonaws.shield#AttackTimestamp", "traits": { - "smithy.api#documentation": "

    List of mitigation actions taken for the attack.

    " + "smithy.api#documentation": "

    The time the attack started, in Unix time in seconds. For more information see timestamp.

    " } } }, @@ -434,10 +434,10 @@ "com.amazonaws.shield#AttackProperty": { "type": "structure", "members": { - "Total": { - "target": "com.amazonaws.shield#Long", + "Unit": { + "target": "com.amazonaws.shield#Unit", "traits": { - "smithy.api#documentation": "

    The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.

    " + "smithy.api#documentation": "

    The unit of the Value of the contributions.

    " } }, "AttackLayer": { @@ -446,10 +446,10 @@ "smithy.api#documentation": "

    The type of distributed denial of service (DDoS) event that was observed.\n NETWORK indicates layer 3 and layer 4 events and APPLICATION\n indicates layer 7 events.

    " } }, - "Unit": { - "target": "com.amazonaws.shield#Unit", + "TopContributors": { + "target": "com.amazonaws.shield#TopContributors", "traits": { - "smithy.api#documentation": "

    The unit of the Value of the contributions.

    " + "smithy.api#documentation": "

    The array of Contributor objects that includes the top five contributors to an attack.

    " } }, "AttackPropertyIdentifier": { @@ -458,10 +458,10 @@ "smithy.api#documentation": "

    Defines the DDoS attack property information that is provided. The\n WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE\n values are valid only for WordPress reflective pingback DDoS attacks.

    " } }, - "TopContributors": { - "target": "com.amazonaws.shield#TopContributors", + "Total": { + "target": "com.amazonaws.shield#Long", "traits": { - "smithy.api#documentation": "

    The array of Contributor objects that includes the top five contributors to an attack.

    " + "smithy.api#documentation": "

    The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.

    " } } }, @@ -523,6 +523,12 @@ "smithy.api#documentation": "

    The unique identifier (ID) of the attack.

    " } }, + "EndTime": { + "target": "com.amazonaws.shield#AttackTimestamp", + "traits": { + "smithy.api#documentation": "

    The end time of the attack, in Unix time in seconds. For more information see timestamp.

    " + } + }, "AttackVectors": { "target": "com.amazonaws.shield#AttackVectorDescriptionList", "traits": { @@ -540,12 +546,6 @@ "traits": { "smithy.api#documentation": "

    The start time of the attack, in Unix time in seconds. For more information see timestamp.

    " } - }, - "EndTime": { - "target": "com.amazonaws.shield#AttackTimestamp", - "traits": { - "smithy.api#documentation": "

    The end time of the attack, in Unix time in seconds. For more information see timestamp.

    " - } } }, "traits": { @@ -1379,17 +1379,17 @@ "com.amazonaws.shield#Limit": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.shield#String", - "traits": { - "smithy.api#documentation": "

    The type of protection.

    " - } - }, "Max": { "target": "com.amazonaws.shield#Long", "traits": { "smithy.api#documentation": "

    The maximum number of protections that can be created for the specified Type.

    " } + }, + "Type": { + "target": "com.amazonaws.shield#String", + "traits": { + "smithy.api#documentation": "

    The type of protection.

    " + } } }, "traits": { @@ -1411,14 +1411,14 @@ "com.amazonaws.shield#LimitsExceededException": { "type": "structure", "members": { + "message": { + "target": "com.amazonaws.shield#errorMessage" + }, "Limit": { "target": "com.amazonaws.shield#LimitNumber" }, "Type": { "target": "com.amazonaws.shield#LimitType" - }, - "message": { - "target": "com.amazonaws.shield#errorMessage" } }, "traits": { @@ -1493,17 +1493,17 @@ "com.amazonaws.shield#ListAttacksResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.shield#Token", - "traits": { - "smithy.api#documentation": "

    The token returned by a previous call to indicate that there is more data available.\n If not null, more results are available. Pass this value for the NextMarker\n parameter in a subsequent call to ListAttacks to retrieve the next set of\n items.

    \n

    AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

    " - } - }, "AttackSummaries": { "target": "com.amazonaws.shield#AttackSummaries", "traits": { "smithy.api#documentation": "

    The attack information for the specified time range.

    " } + }, + "NextToken": { + "target": "com.amazonaws.shield#Token", + "traits": { + "smithy.api#documentation": "

    The token returned by a previous call to indicate that there is more data available.\n If not null, more results are available. Pass this value for the NextMarker\n parameter in a subsequent call to ListAttacks to retrieve the next set of\n items.

    \n

    AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

    " + } } } }, @@ -1556,17 +1556,17 @@ "com.amazonaws.shield#ListProtectionsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.shield#Token", - "traits": { - "smithy.api#documentation": "

    If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.

    \n

    AWS WAF might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

    " - } - }, "Protections": { "target": "com.amazonaws.shield#Protections", "traits": { "smithy.api#documentation": "

    The array of enabled Protection objects.

    " } + }, + "NextToken": { + "target": "com.amazonaws.shield#Token", + "traits": { + "smithy.api#documentation": "

    If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.

    \n

    AWS WAF might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

    " + } } } }, @@ -1804,12 +1804,6 @@ "com.amazonaws.shield#SubResourceSummary": { "type": "structure", "members": { - "Counters": { - "target": "com.amazonaws.shield#SummarizedCounterList", - "traits": { - "smithy.api#documentation": "

    The counters that describe the details of the attack.

    " - } - }, "Type": { "target": "com.amazonaws.shield#SubResourceType", "traits": { @@ -1827,6 +1821,12 @@ "traits": { "smithy.api#documentation": "

    The unique identifier (ID) of the SubResource.

    " } + }, + "Counters": { + "target": "com.amazonaws.shield#SummarizedCounterList", + "traits": { + "smithy.api#documentation": "

    The counters that describe the details of the attack.

    " + } } }, "traits": { @@ -1863,18 +1863,24 @@ "smithy.api#documentation": "

    The start time of the subscription, in Unix time in seconds. For more information see timestamp.

    " } }, - "Limits": { - "target": "com.amazonaws.shield#Limits", - "traits": { - "smithy.api#documentation": "

    Specifies how many protections of a given type you can create.

    " - } - }, "AutoRenew": { "target": "com.amazonaws.shield#AutoRenew", "traits": { "smithy.api#documentation": "

    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

    \n

    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

    " } }, + "ProactiveEngagementStatus": { + "target": "com.amazonaws.shield#ProactiveEngagementStatus", + "traits": { + "smithy.api#documentation": "

    If ENABLED, the DDoS Response Team (DRT) will use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.

    \n

    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

    \n

    If DISABLED, the DRT will not proactively notify contacts about escalations or to initiate proactive customer support.

    " + } + }, + "Limits": { + "target": "com.amazonaws.shield#Limits", + "traits": { + "smithy.api#documentation": "

    Specifies how many protections of a given type you can create.

    " + } + }, "EndTime": { "target": "com.amazonaws.shield#Timestamp", "traits": { @@ -1886,12 +1892,6 @@ "traits": { "smithy.api#documentation": "

    The length, in seconds, of the AWS Shield Advanced subscription for the account.

    " } - }, - "ProactiveEngagementStatus": { - "target": "com.amazonaws.shield#ProactiveEngagementStatus", - "traits": { - "smithy.api#documentation": "

    If ENABLED, the DDoS Response Team (DRT) will use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.

    \n

    If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.

    \n

    If DISABLED, the DRT will not proactively notify contacts about escalations or to initiate proactive customer support.

    " - } } }, "traits": { @@ -1916,18 +1916,18 @@ "com.amazonaws.shield#SummarizedAttackVector": { "type": "structure", "members": { - "VectorCounters": { - "target": "com.amazonaws.shield#SummarizedCounterList", - "traits": { - "smithy.api#documentation": "

    The list of counters that describe the details of the attack.

    " - } - }, "VectorType": { "target": "com.amazonaws.shield#String", "traits": { "smithy.api#documentation": "

    The attack type, for example, SNMP reflection or SYN flood.

    ", "smithy.api#required": {} } + }, + "VectorCounters": { + "target": "com.amazonaws.shield#SummarizedCounterList", + "traits": { + "smithy.api#documentation": "

    The list of counters that describe the details of the attack.

    " + } } }, "traits": { @@ -1943,22 +1943,16 @@ "com.amazonaws.shield#SummarizedCounter": { "type": "structure", "members": { - "N": { - "target": "com.amazonaws.shield#Integer", - "traits": { - "smithy.api#documentation": "

    The number of counters for a specified time period.

    " - } - }, "Unit": { "target": "com.amazonaws.shield#String", "traits": { "smithy.api#documentation": "

    The unit of the counters.

    " } }, - "Average": { + "Sum": { "target": "com.amazonaws.shield#Double", "traits": { - "smithy.api#documentation": "

    The average value of the counter for a specified time period.

    " + "smithy.api#documentation": "

    The total of counter values for a specified time period.

    " } }, "Max": { @@ -1967,10 +1961,16 @@ "smithy.api#documentation": "

    The maximum value of the counter for a specified time period.

    " } }, - "Sum": { + "Average": { "target": "com.amazonaws.shield#Double", "traits": { - "smithy.api#documentation": "

    The total of counter values for a specified time period.

    " + "smithy.api#documentation": "

    The average value of the counter for a specified time period.

    " + } + }, + "N": { + "target": "com.amazonaws.shield#Integer", + "traits": { + "smithy.api#documentation": "

    The number of counters for a specified time period.

    " } }, "Name": { @@ -1993,16 +1993,16 @@ "com.amazonaws.shield#TimeRange": { "type": "structure", "members": { - "FromInclusive": { + "ToExclusive": { "target": "com.amazonaws.shield#AttackTimestamp", "traits": { - "smithy.api#documentation": "

    The start time, in Unix time in seconds. For more information see timestamp.

    " + "smithy.api#documentation": "

    The end time, in Unix time in seconds. For more information see timestamp.

    " } }, - "ToExclusive": { + "FromInclusive": { "target": "com.amazonaws.shield#AttackTimestamp", "traits": { - "smithy.api#documentation": "

    The end time, in Unix time in seconds. For more information see timestamp.

    " + "smithy.api#documentation": "

    The start time, in Unix time in seconds. For more information see timestamp.

    " } } }, 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 1ce7d19dbbe7..1a144642859b 100644 --- a/codegen/sdk-codegen/aws-models/signer.2017-08-25.json +++ b/codegen/sdk-codegen/aws-models/signer.2017-08-25.json @@ -165,16 +165,16 @@ "com.amazonaws.signer#DescribeSigningJobResponse": { "type": "structure", "members": { - "source": { - "target": "com.amazonaws.signer#Source", + "profileName": { + "target": "com.amazonaws.signer#ProfileName", "traits": { - "smithy.api#documentation": "

    The object that contains the name of your S3 bucket or your raw code.

    " + "smithy.api#documentation": "

    The name of the profile that initiated the signing operation.

    " } }, - "jobId": { - "target": "com.amazonaws.signer#JobId", + "overrides": { + "target": "com.amazonaws.signer#SigningPlatformOverrides", "traits": { - "smithy.api#documentation": "

    The ID of the signing job on output.

    " + "smithy.api#documentation": "

    A list of any overrides that were applied to the signing operation.

    " } }, "signingMaterial": { @@ -183,16 +183,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of your code signing certificate.

    " } }, - "platformId": { - "target": "com.amazonaws.signer#PlatformId", - "traits": { - "smithy.api#documentation": "

    The microcontroller platform to which your signed code image will be\n\t\t\tdistributed.

    " - } - }, - "status": { - "target": "com.amazonaws.signer#SigningStatus", + "signingParameters": { + "target": "com.amazonaws.signer#SigningParameters", "traits": { - "smithy.api#documentation": "

    Status of the signing job.

    " + "smithy.api#documentation": "

    Map of user-assigned key-value pairs used during signing. These values contain any\n\t\t\tinformation that you specified for use in your signing job.

    " } }, "signedObject": { @@ -201,10 +195,16 @@ "smithy.api#documentation": "

    Name of the S3 bucket where the signed code image is saved by code signing.

    " } }, - "statusReason": { - "target": "com.amazonaws.signer#StatusReason", + "source": { + "target": "com.amazonaws.signer#Source", "traits": { - "smithy.api#documentation": "

    String value that contains the status reason.

    " + "smithy.api#documentation": "

    The object that contains the name of your S3 bucket or your raw code.

    " + } + }, + "jobId": { + "target": "com.amazonaws.signer#JobId", + "traits": { + "smithy.api#documentation": "

    The ID of the signing job on output.

    " } }, "requestedBy": { @@ -213,34 +213,34 @@ "smithy.api#documentation": "

    The IAM principal that requested the signing job.

    " } }, - "completedAt": { - "target": "com.amazonaws.signer#CompletedAt", + "platformId": { + "target": "com.amazonaws.signer#PlatformId", "traits": { - "smithy.api#documentation": "

    Date and time that the signing job was completed.

    " + "smithy.api#documentation": "

    The microcontroller platform to which your signed code image will be\n\t\t\tdistributed.

    " } }, - "overrides": { - "target": "com.amazonaws.signer#SigningPlatformOverrides", + "createdAt": { + "target": "com.amazonaws.signer#CreatedAt", "traits": { - "smithy.api#documentation": "

    A list of any overrides that were applied to the signing operation.

    " + "smithy.api#documentation": "

    Date and time that the signing job was created.

    " } }, - "signingParameters": { - "target": "com.amazonaws.signer#SigningParameters", + "status": { + "target": "com.amazonaws.signer#SigningStatus", "traits": { - "smithy.api#documentation": "

    Map of user-assigned key-value pairs used during signing. These values contain any\n\t\t\tinformation that you specified for use in your signing job.

    " + "smithy.api#documentation": "

    Status of the signing job.

    " } }, - "createdAt": { - "target": "com.amazonaws.signer#CreatedAt", + "completedAt": { + "target": "com.amazonaws.signer#CompletedAt", "traits": { - "smithy.api#documentation": "

    Date and time that the signing job was created.

    " + "smithy.api#documentation": "

    Date and time that the signing job was completed.

    " } }, - "profileName": { - "target": "com.amazonaws.signer#ProfileName", + "statusReason": { + "target": "com.amazonaws.signer#StatusReason", "traits": { - "smithy.api#documentation": "

    The name of the profile that initiated the signing operation.

    " + "smithy.api#documentation": "

    String value that contains the status reason.

    " } } } @@ -278,17 +278,17 @@ "com.amazonaws.signer#EncryptionAlgorithmOptions": { "type": "structure", "members": { - "defaultValue": { - "target": "com.amazonaws.signer#EncryptionAlgorithm", + "allowedValues": { + "target": "com.amazonaws.signer#EncryptionAlgorithms", "traits": { - "smithy.api#documentation": "

    The default encryption algorithm that is used by a code signing job.

    ", + "smithy.api#documentation": "

    The set of accepted encryption algorithms that are allowed in a code signing job.

    ", "smithy.api#required": {} } }, - "allowedValues": { - "target": "com.amazonaws.signer#EncryptionAlgorithms", + "defaultValue": { + "target": "com.amazonaws.signer#EncryptionAlgorithm", "traits": { - "smithy.api#documentation": "

    The set of accepted encryption algorithms that are allowed in a code signing job.

    ", + "smithy.api#documentation": "

    The default encryption algorithm that is used by a code signing job.

    ", "smithy.api#required": {} } } @@ -350,16 +350,10 @@ "com.amazonaws.signer#GetSigningPlatformResponse": { "type": "structure", "members": { - "partner": { + "target": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

    A list of partner entities that use the target signing platform.

    " - } - }, - "platformId": { - "target": "com.amazonaws.signer#PlatformId", - "traits": { - "smithy.api#documentation": "

    The ID of the target signing platform.

    " + "smithy.api#documentation": "

    The validation template that is used by the target signing platform.

    " } }, "signingConfiguration": { @@ -368,10 +362,16 @@ "smithy.api#documentation": "

    A list of configurations applied to the target platform at signing.

    " } }, - "category": { - "target": "com.amazonaws.signer#Category", + "displayName": { + "target": "com.amazonaws.signer#DisplayName", "traits": { - "smithy.api#documentation": "

    The category type of the target signing platform.

    " + "smithy.api#documentation": "

    The display name of the target signing platform.

    " + } + }, + "partner": { + "target": "com.amazonaws.signer#String", + "traits": { + "smithy.api#documentation": "

    A list of partner entities that use the target signing platform.

    " } }, "signingImageFormat": { @@ -380,22 +380,22 @@ "smithy.api#documentation": "

    The format of the target platform's signing image.

    " } }, - "maxSizeInMB": { - "target": "com.amazonaws.signer#MaxSizeInMB", + "platformId": { + "target": "com.amazonaws.signer#PlatformId", "traits": { - "smithy.api#documentation": "

    The maximum size (in MB) of the payload that can be signed by the target\n\t\t\tplatform.

    " + "smithy.api#documentation": "

    The ID of the target signing platform.

    " } }, - "target": { - "target": "com.amazonaws.signer#String", + "maxSizeInMB": { + "target": "com.amazonaws.signer#MaxSizeInMB", "traits": { - "smithy.api#documentation": "

    The validation template that is used by the target signing platform.

    " + "smithy.api#documentation": "

    The maximum size (in MB) of the payload that can be signed by the target\n\t\t\tplatform.

    " } }, - "displayName": { - "target": "com.amazonaws.signer#DisplayName", + "category": { + "target": "com.amazonaws.signer#Category", "traits": { - "smithy.api#documentation": "

    The display name of the target signing platform.

    " + "smithy.api#documentation": "

    The category type of the target signing platform.

    " } } } @@ -453,10 +453,10 @@ "smithy.api#documentation": "

    A list of overrides applied by the target signing profile for signing\n\t\t\toperations.

    " } }, - "arn": { - "target": "com.amazonaws.signer#String", + "profileName": { + "target": "com.amazonaws.signer#ProfileName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the signing profile.

    " + "smithy.api#documentation": "

    The name of the target signing profile.

    " } }, "signingParameters": { @@ -465,22 +465,22 @@ "smithy.api#documentation": "

    A map of key-value pairs for signing operations that is attached to the target signing\n\t\t\tprofile.

    " } }, - "signingMaterial": { - "target": "com.amazonaws.signer#SigningMaterial", - "traits": { - "smithy.api#documentation": "

    The ARN of the certificate that the target profile uses for signing operations.

    " - } - }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "

    The ID of the platform that is used by the target signing profile.

    " } }, - "tags": { - "target": "com.amazonaws.signer#TagMap", + "signingMaterial": { + "target": "com.amazonaws.signer#SigningMaterial", "traits": { - "smithy.api#documentation": "

    A list of tags associated with the signing profile.

    " + "smithy.api#documentation": "

    The ARN of the certificate that the target profile uses for signing operations.

    " + } + }, + "arn": { + "target": "com.amazonaws.signer#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the signing profile.

    " } }, "status": { @@ -489,10 +489,10 @@ "smithy.api#documentation": "

    The status of the target signing profile.

    " } }, - "profileName": { - "target": "com.amazonaws.signer#ProfileName", + "tags": { + "target": "com.amazonaws.signer#TagMap", "traits": { - "smithy.api#documentation": "

    The name of the target signing profile.

    " + "smithy.api#documentation": "

    A list of tags associated with the signing profile.

    " } } } @@ -618,13 +618,6 @@ "com.amazonaws.signer#ListSigningJobsRequest": { "type": "structure", "members": { - "platformId": { - "target": "com.amazonaws.signer#PlatformId", - "traits": { - "smithy.api#documentation": "

    The ID of microcontroller platform that you specified for the distribution of your\n\t\t\tcode image.

    ", - "smithy.api#httpQuery": "platformId" - } - }, "maxResults": { "target": "com.amazonaws.signer#MaxResults", "traits": { @@ -632,6 +625,13 @@ "smithy.api#httpQuery": "maxResults" } }, + "requestedBy": { + "target": "com.amazonaws.signer#RequestedBy", + "traits": { + "smithy.api#documentation": "

    The IAM principal that requested the signing job.

    ", + "smithy.api#httpQuery": "requestedBy" + } + }, "nextToken": { "target": "com.amazonaws.signer#NextToken", "traits": { @@ -639,11 +639,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "requestedBy": { - "target": "com.amazonaws.signer#RequestedBy", + "platformId": { + "target": "com.amazonaws.signer#PlatformId", "traits": { - "smithy.api#documentation": "

    The IAM principal that requested the signing job.

    ", - "smithy.api#httpQuery": "requestedBy" + "smithy.api#documentation": "

    The ID of microcontroller platform that you specified for the distribution of your\n\t\t\tcode image.

    ", + "smithy.api#httpQuery": "platformId" } }, "status": { @@ -658,17 +658,17 @@ "com.amazonaws.signer#ListSigningJobsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.signer#NextToken", - "traits": { - "smithy.api#documentation": "

    String for specifying the next set of paginated results.

    " - } - }, "jobs": { "target": "com.amazonaws.signer#SigningJobs", "traits": { "smithy.api#documentation": "

    A list of your signing jobs.

    " } + }, + "nextToken": { + "target": "com.amazonaws.signer#NextToken", + "traits": { + "smithy.api#documentation": "

    String for specifying the next set of paginated results.

    " + } } } }, @@ -718,20 +718,6 @@ "smithy.api#httpQuery": "nextToken" } }, - "maxResults": { - "target": "com.amazonaws.signer#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to be returned by this operation.

    ", - "smithy.api#httpQuery": "maxResults" - } - }, - "partner": { - "target": "com.amazonaws.signer#String", - "traits": { - "smithy.api#documentation": "

    Any partner entities connected to a signing platform.

    ", - "smithy.api#httpQuery": "partner" - } - }, "target": { "target": "com.amazonaws.signer#String", "traits": { @@ -745,6 +731,20 @@ "smithy.api#documentation": "

    The category type of a signing platform.

    ", "smithy.api#httpQuery": "category" } + }, + "partner": { + "target": "com.amazonaws.signer#String", + "traits": { + "smithy.api#documentation": "

    Any partner entities connected to a signing platform.

    ", + "smithy.api#httpQuery": "partner" + } + }, + "maxResults": { + "target": "com.amazonaws.signer#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to be returned by this operation.

    ", + "smithy.api#httpQuery": "maxResults" + } } } }, @@ -801,6 +801,13 @@ "com.amazonaws.signer#ListSigningProfilesRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.signer#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of profiles to be returned.

    ", + "smithy.api#httpQuery": "maxResults" + } + }, "includeCanceled": { "target": "com.amazonaws.signer#bool", "traits": { @@ -814,30 +821,23 @@ "smithy.api#documentation": "

    Value for specifying the next set of paginated results to return. After you receive a\n\t\t\tresponse with truncated results, use this parameter in a subsequent request. Set it to\n\t\t\tthe value of nextToken from the response that you just received.

    ", "smithy.api#httpQuery": "nextToken" } - }, - "maxResults": { - "target": "com.amazonaws.signer#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of profiles to be returned.

    ", - "smithy.api#httpQuery": "maxResults" - } } } }, "com.amazonaws.signer#ListSigningProfilesResponse": { "type": "structure", "members": { - "profiles": { - "target": "com.amazonaws.signer#SigningProfiles", - "traits": { - "smithy.api#documentation": "

    A list of profiles that are available in the AWS account. This includes profiles with\n\t\t\tthe status of CANCELED if the includeCanceled parameter is set\n\t\t\tto true.

    " - } - }, "nextToken": { "target": "com.amazonaws.signer#NextToken", "traits": { "smithy.api#documentation": "

    Value for specifying the next set of paginated results to return.

    " } + }, + "profiles": { + "target": "com.amazonaws.signer#SigningProfiles", + "traits": { + "smithy.api#documentation": "

    A list of profiles that are available in the AWS account. This includes profiles with\n\t\t\tthe status of CANCELED if the includeCanceled parameter is set\n\t\t\tto true.

    " + } } } }, @@ -975,6 +975,12 @@ "com.amazonaws.signer#PutSigningProfileRequest": { "type": "structure", "members": { + "signingParameters": { + "target": "com.amazonaws.signer#SigningParameters", + "traits": { + "smithy.api#documentation": "

    Map of key-value pairs for signing. These can include any information that you want to\n\t\t\tuse during signing.

    " + } + }, "tags": { "target": "com.amazonaws.signer#TagMap", "traits": { @@ -995,12 +1001,6 @@ "smithy.api#documentation": "

    A subfield of platform. This specifies any different configuration\n\t\t\toptions that you want to apply to the chosen platform (such as a different\n\t\t\t\thash-algorithm or signing-algorithm).

    " } }, - "signingParameters": { - "target": "com.amazonaws.signer#SigningParameters", - "traits": { - "smithy.api#documentation": "

    Map of key-value pairs for signing. These can include any information that you want to\n\t\t\tuse during signing.

    " - } - }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { @@ -1194,12 +1194,6 @@ "com.amazonaws.signer#SigningJob": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.signer#SigningStatus", - "traits": { - "smithy.api#documentation": "

    The status of the signing job.

    " - } - }, "source": { "target": "com.amazonaws.signer#Source", "traits": { @@ -1212,10 +1206,10 @@ "smithy.api#documentation": "

    The ID of the signing job.

    " } }, - "signingMaterial": { - "target": "com.amazonaws.signer#SigningMaterial", + "status": { + "target": "com.amazonaws.signer#SigningStatus", "traits": { - "smithy.api#documentation": "

    A SigningMaterial object that contains the Amazon Resource Name (ARN) of\n\t\t\tthe certificate used for the signing job.

    " + "smithy.api#documentation": "

    The status of the signing job.

    " } }, "createdAt": { @@ -1224,6 +1218,12 @@ "smithy.api#documentation": "

    The date and time that the signing job was created.

    " } }, + "signingMaterial": { + "target": "com.amazonaws.signer#SigningMaterial", + "traits": { + "smithy.api#documentation": "

    A SigningMaterial object that contains the Amazon Resource Name (ARN) of\n\t\t\tthe certificate used for the signing job.

    " + } + }, "signedObject": { "target": "com.amazonaws.signer#SignedObject", "traits": { @@ -1274,31 +1274,31 @@ "com.amazonaws.signer#SigningPlatform": { "type": "structure", "members": { - "target": { - "target": "com.amazonaws.signer#String", + "maxSizeInMB": { + "target": "com.amazonaws.signer#MaxSizeInMB", "traits": { - "smithy.api#documentation": "

    The types of targets that can be signed by a code signing platform.

    " + "smithy.api#documentation": "

    The maximum size (in MB) of code that can be signed by a code signing platform.

    " } }, - "displayName": { + "platformId": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

    The display name of a code signing platform.

    " - } - }, - "signingConfiguration": { - "target": "com.amazonaws.signer#SigningConfiguration", - "traits": { - "smithy.api#documentation": "

    The configuration of a code signing platform. This includes the designated hash algorithm\n\t\t\tand encryption algorithm of a signing platform.

    " + "smithy.api#documentation": "

    The ID of a code signing; platform.

    " } }, "signingImageFormat": { "target": "com.amazonaws.signer#SigningImageFormat" }, - "platformId": { + "partner": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

    The ID of a code signing; platform.

    " + "smithy.api#documentation": "

    Any partner entities linked to a code signing platform.

    " + } + }, + "displayName": { + "target": "com.amazonaws.signer#String", + "traits": { + "smithy.api#documentation": "

    The display name of a code signing platform.

    " } }, "category": { @@ -1307,16 +1307,16 @@ "smithy.api#documentation": "

    The category of a code signing platform.

    " } }, - "partner": { - "target": "com.amazonaws.signer#String", + "signingConfiguration": { + "target": "com.amazonaws.signer#SigningConfiguration", "traits": { - "smithy.api#documentation": "

    Any partner entities linked to a code signing platform.

    " + "smithy.api#documentation": "

    The configuration of a code signing platform. This includes the designated hash algorithm\n\t\t\tand encryption algorithm of a signing platform.

    " } }, - "maxSizeInMB": { - "target": "com.amazonaws.signer#MaxSizeInMB", + "target": { + "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

    The maximum size (in MB) of code that can be signed by a code signing platform.

    " + "smithy.api#documentation": "

    The types of targets that can be signed by a code signing platform.

    " } } }, @@ -1327,17 +1327,17 @@ "com.amazonaws.signer#SigningPlatformOverrides": { "type": "structure", "members": { - "signingConfiguration": { - "target": "com.amazonaws.signer#SigningConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

    A signing configuration that overrides the default encryption or hash algorithm of a\n\t\t\tsigning job.

    " - } - }, "signingImageFormat": { "target": "com.amazonaws.signer#ImageFormat", "traits": { "smithy.api#documentation": "

    A signed image is a JSON object. When overriding the default signing platform configuration,\n\t\t\ta customer can select either of two signing formats, JSONEmbedded or\n\t\t\t\tJSONDetached. (A third format value, JSON, is reserved\n\t\t\tfor future use.) With JSONEmbedded, the signing image has the payload\n\t\t\tembedded in it. With JSONDetached, the payload is not be embedded in the\n\t\t\tsigning image.

    " } + }, + "signingConfiguration": { + "target": "com.amazonaws.signer#SigningConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

    A signing configuration that overrides the default encryption or hash algorithm of a\n\t\t\tsigning job.

    " + } } }, "traits": { @@ -1353,10 +1353,16 @@ "com.amazonaws.signer#SigningProfile": { "type": "structure", "members": { - "signingMaterial": { - "target": "com.amazonaws.signer#SigningMaterial", + "platformId": { + "target": "com.amazonaws.signer#PlatformId", "traits": { - "smithy.api#documentation": "

    The ACM certificate that is available for use by a signing profile.

    " + "smithy.api#documentation": "

    The ID of a platform that is available for use by a signing profile.

    " + } + }, + "arn": { + "target": "com.amazonaws.signer#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the signing profile.

    " } }, "signingParameters": { @@ -1371,24 +1377,18 @@ "smithy.api#documentation": "

    The name of the signing profile.

    " } }, - "platformId": { - "target": "com.amazonaws.signer#PlatformId", - "traits": { - "smithy.api#documentation": "

    The ID of a platform that is available for use by a signing profile.

    " - } - }, - "arn": { - "target": "com.amazonaws.signer#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the signing profile.

    " - } - }, "tags": { "target": "com.amazonaws.signer#TagMap", "traits": { "smithy.api#documentation": "

    A list of tags associated with the signing profile.

    " } }, + "signingMaterial": { + "target": "com.amazonaws.signer#SigningMaterial", + "traits": { + "smithy.api#documentation": "

    The ACM certificate that is available for use by a signing profile.

    " + } + }, "status": { "target": "com.amazonaws.signer#SigningProfileStatus", "traits": { @@ -1486,12 +1486,6 @@ "com.amazonaws.signer#StartSigningJobRequest": { "type": "structure", "members": { - "profileName": { - "target": "com.amazonaws.signer#ProfileName", - "traits": { - "smithy.api#documentation": "

    The name of the signing profile.

    " - } - }, "clientRequestToken": { "target": "com.amazonaws.signer#ClientRequestToken", "traits": { @@ -1507,6 +1501,12 @@ "smithy.api#required": {} } }, + "profileName": { + "target": "com.amazonaws.signer#ProfileName", + "traits": { + "smithy.api#documentation": "

    The name of the signing profile.

    " + } + }, "destination": { "target": "com.amazonaws.signer#Destination", "traits": { @@ -1601,13 +1601,6 @@ "com.amazonaws.signer#TagResourceRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.signer#TagMap", - "traits": { - "smithy.api#documentation": "

    One or more tags to be associated with the signing profile.

    ", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.signer#String", "traits": { @@ -1615,6 +1608,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.signer#TagMap", + "traits": { + "smithy.api#documentation": "

    One or more tags to be associated with the signing profile.

    ", + "smithy.api#required": {} + } } } }, @@ -1675,14 +1675,6 @@ "com.amazonaws.signer#UntagResourceRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.signer#String", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the signing profile.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "tagKeys": { "target": "com.amazonaws.signer#TagKeyList", "traits": { @@ -1690,6 +1682,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "resourceArn": { + "target": "com.amazonaws.signer#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the signing profile.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -1759,7 +1759,7 @@ "sdkId": "signer", "arnNamespace": "signer", "cloudFormationName": "Signer", - "cloudTrailEventSource": "wallaby.amazonaws.com" + "cloudTrailEventSource": "signer.amazonaws.com" }, "aws.auth#sigv4": { "name": "signer" diff --git a/codegen/sdk-codegen/aws-models/sms.2016-10-24.json b/codegen/sdk-codegen/aws-models/sms.2016-10-24.json index 52f5e368d5de..964d84888343 100644 --- a/codegen/sdk-codegen/aws-models/sms.2016-10-24.json +++ b/codegen/sdk-codegen/aws-models/sms.2016-10-24.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.sms#DeleteAppReplicationConfiguration" }, + { + "target": "com.amazonaws.sms#DeleteAppValidationConfiguration" + }, { "target": "com.amazonaws.sms#DeleteReplicationJob" }, @@ -72,6 +75,12 @@ { "target": "com.amazonaws.sms#GetAppReplicationConfiguration" }, + { + "target": "com.amazonaws.sms#GetAppValidationConfiguration" + }, + { + "target": "com.amazonaws.sms#GetAppValidationOutput" + }, { "target": "com.amazonaws.sms#GetConnectors" }, @@ -84,6 +93,9 @@ { "target": "com.amazonaws.sms#GetServers" }, + { + "target": "com.amazonaws.sms#ImportAppCatalog" + }, { "target": "com.amazonaws.sms#ImportServerCatalog" }, @@ -93,15 +105,24 @@ { "target": "com.amazonaws.sms#ListApps" }, + { + "target": "com.amazonaws.sms#NotifyAppValidationOutput" + }, { "target": "com.amazonaws.sms#PutAppLaunchConfiguration" }, { "target": "com.amazonaws.sms#PutAppReplicationConfiguration" }, + { + "target": "com.amazonaws.sms#PutAppValidationConfiguration" + }, { "target": "com.amazonaws.sms#StartAppReplication" }, + { + "target": "com.amazonaws.sms#StartOnDemandAppReplication" + }, { "target": "com.amazonaws.sms#StartOnDemandReplicationRun" }, @@ -123,13 +144,13 @@ "sdkId": "SMS", "arnNamespace": "sms", "cloudFormationName": "SMS", - "cloudTrailEventSource": "V2016_10_24.servermigration.amazonaws.com" + "cloudTrailEventSource": "sms.amazonaws.com" }, "aws.auth#sigv4": { "name": "sms" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AAWS Sever Migration Service\n

    This is the AWS Sever Migration Service API Reference. It provides descriptions,\n syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service\n (AWS SMS). The topic for each action shows the Query API request parameters and the XML\n response. You can also view the XML request elements in the WSDL.

    \n

    Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see AWS SDKs.

    \n

    To learn more about the Server Migration Service, see the following resources:

    \n ", + "smithy.api#documentation": "AWS Server Migration Service\n

    AWS Server Migration Service (AWS SMS) makes it easier and faster for you to migrate your\n on-premises workloads to AWS. To learn more about AWS SMS, see the following \n resources:

    \n ", "smithy.api#title": "AWS Server Migration Service", "smithy.api#xmlNamespace": { "uri": "http://ec2.amazon.com/servermigration/2016-10-24/" @@ -145,12 +166,33 @@ "com.amazonaws.sms#AppId": { "type": "string" }, + "com.amazonaws.sms#AppIdWithValidation": { + "type": "string", + "traits": { + "smithy.api#pattern": "^app-[0-9a-f]{17}$" + } + }, "com.amazonaws.sms#AppIds": { "type": "list", "member": { "target": "com.amazonaws.sms#AppId" } }, + "com.amazonaws.sms#AppLaunchConfigurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_CONFIGURED", + "name": "NotConfigured" + }, + { + "value": "CONFIGURED", + "name": "Configured" + } + ] + } + }, "com.amazonaws.sms#AppLaunchStatus": { "type": "string", "traits": { @@ -187,6 +229,10 @@ "value": "LAUNCHED", "name": "Launched" }, + { + "value": "PARTIALLY_LAUNCHED", + "name": "PartiallyLaunched" + }, { "value": "DELTA_LAUNCH_IN_PROGRESS", "name": "DeltaLaunchInProgress" @@ -220,6 +266,21 @@ "com.amazonaws.sms#AppName": { "type": "string" }, + "com.amazonaws.sms#AppReplicationConfigurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_CONFIGURED", + "name": "NotConfigured" + }, + { + "value": "CONFIGURED", + "name": "Configured" + } + ] + } + }, "com.amazonaws.sms#AppReplicationStatus": { "type": "string", "traits": { @@ -256,6 +317,10 @@ "value": "REPLICATED", "name": "Replicated" }, + { + "value": "PARTIALLY_REPLICATED", + "name": "PartiallyReplicated" + }, { "value": "DELTA_REPLICATION_IN_PROGRESS", "name": "DeltaReplicationInProgress" @@ -327,100 +392,118 @@ "com.amazonaws.sms#AppSummary": { "type": "structure", "members": { + "launchStatusMessage": { + "target": "com.amazonaws.sms#AppLaunchStatusMessage", + "traits": { + "smithy.api#documentation": "

    A message related to the launch status of the application.

    " + } + }, "launchDetails": { "target": "com.amazonaws.sms#LaunchDetails", "traits": { "smithy.api#documentation": "

    Details about the latest launch of the application.

    " } }, - "status": { - "target": "com.amazonaws.sms#AppStatus", + "description": { + "target": "com.amazonaws.sms#AppDescription", "traits": { - "smithy.api#documentation": "

    Status of the application.

    " + "smithy.api#documentation": "

    The description of the application.

    " } }, - "launchStatus": { - "target": "com.amazonaws.sms#AppLaunchStatus", + "roleName": { + "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    Launch status of the application.

    " + "smithy.api#documentation": "

    The name of the service role in the customer's account used by AWS SMS.

    " } }, - "description": { - "target": "com.amazonaws.sms#AppDescription", + "statusMessage": { + "target": "com.amazonaws.sms#AppStatusMessage", "traits": { - "smithy.api#documentation": "

    Description of the application.

    " + "smithy.api#documentation": "

    A message related to the status of the application

    " } }, - "lastModified": { - "target": "com.amazonaws.sms#Timestamp", + "replicationStatusMessage": { + "target": "com.amazonaws.sms#AppReplicationStatusMessage", "traits": { - "smithy.api#documentation": "

    Timestamp of the application's creation.

    " + "smithy.api#documentation": "

    A message related to the replication status of the application.

    " } }, "creationTime": { "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    Time of creation of this application.

    " - } - }, - "statusMessage": { - "target": "com.amazonaws.sms#AppStatusMessage", - "traits": { - "smithy.api#documentation": "

    A message related to the status of the application

    " + "smithy.api#documentation": "

    The creation time of the application.

    " } }, "replicationStatus": { "target": "com.amazonaws.sms#AppReplicationStatus", "traits": { - "smithy.api#documentation": "

    Replication status of the application.

    " + "smithy.api#documentation": "

    The replication status of the application.

    " } }, - "launchStatusMessage": { - "target": "com.amazonaws.sms#AppLaunchStatusMessage", + "replicationConfigurationStatus": { + "target": "com.amazonaws.sms#AppReplicationConfigurationStatus", "traits": { - "smithy.api#documentation": "

    A message related to the launch status of the application.

    " + "smithy.api#documentation": "

    Status of the replication configuration.

    " } }, "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    Unique ID of the application.

    " + "smithy.api#documentation": "

    The unique ID of the application.

    " } }, - "totalServerGroups": { - "target": "com.amazonaws.sms#TotalServerGroups", + "latestReplicationTime": { + "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    Number of server groups present in the application.

    " + "smithy.api#documentation": "

    The timestamp of the application's most recent successful replication.

    " + } + }, + "name": { + "target": "com.amazonaws.sms#AppName", + "traits": { + "smithy.api#documentation": "

    The name of the application.

    " + } + }, + "status": { + "target": "com.amazonaws.sms#AppStatus", + "traits": { + "smithy.api#documentation": "

    Status of the application.

    " } }, "totalServers": { "target": "com.amazonaws.sms#TotalServers", "traits": { - "smithy.api#documentation": "

    Number of servers present in the application.

    " + "smithy.api#documentation": "

    The number of servers present in the application.

    " } }, - "name": { - "target": "com.amazonaws.sms#AppName", + "lastModified": { + "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    Name of the application.

    " + "smithy.api#documentation": "

    The last modified time of the application.

    " } }, - "replicationStatusMessage": { - "target": "com.amazonaws.sms#AppReplicationStatusMessage", + "totalServerGroups": { + "target": "com.amazonaws.sms#TotalServerGroups", "traits": { - "smithy.api#documentation": "

    A message related to the replication status of the application.

    " + "smithy.api#documentation": "

    The number of server groups present in the application.

    " } }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", + "launchStatus": { + "target": "com.amazonaws.sms#AppLaunchStatus", "traits": { - "smithy.api#documentation": "

    Name of the service role in the customer's account used by AWS SMS.

    " + "smithy.api#documentation": "

    The launch status of the application.

    " } }, - "latestReplicationTime": { - "target": "com.amazonaws.sms#Timestamp", + "launchConfigurationStatus": { + "target": "com.amazonaws.sms#AppLaunchConfigurationStatus", + "traits": { + "smithy.api#documentation": "

    Status of the launch configuration.

    " + } + }, + "importedAppId": { + "target": "com.amazonaws.sms#ImportedAppId", "traits": { - "smithy.api#documentation": "

    Timestamp of the application's most recent successful replication.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } }, @@ -428,6 +511,69 @@ "smithy.api#documentation": "

    Information about the application.

    " } }, + "com.amazonaws.sms#AppValidationConfiguration": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.sms#NonEmptyStringWithMaxLen255", + "traits": { + "smithy.api#documentation": "

    The name of the configuration.

    " + } + }, + "appValidationStrategy": { + "target": "com.amazonaws.sms#AppValidationStrategy", + "traits": { + "smithy.api#documentation": "

    The validation strategy.

    " + } + }, + "ssmValidationParameters": { + "target": "com.amazonaws.sms#SSMValidationParameters", + "traits": { + "smithy.api#documentation": "

    The validation parameters.

    " + } + }, + "validationId": { + "target": "com.amazonaws.sms#ValidationId", + "traits": { + "smithy.api#documentation": "

    The ID of the validation.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Configuration for validating an application.

    " + } + }, + "com.amazonaws.sms#AppValidationConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sms#AppValidationConfiguration" + } + }, + "com.amazonaws.sms#AppValidationOutput": { + "type": "structure", + "members": { + "ssmOutput": { + "target": "com.amazonaws.sms#SSMOutput", + "traits": { + "smithy.api#documentation": "

    Output from using SSM to validate the application.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Output from validating an application.

    " + } + }, + "com.amazonaws.sms#AppValidationStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSM", + "name": "SSM" + } + ] + } + }, "com.amazonaws.sms#Apps": { "type": "list", "member": { @@ -440,12 +586,27 @@ "smithy.api#box": {} } }, + "com.amazonaws.sms#AutoLaunch": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.sms#BucketName": { "type": "string" }, "com.amazonaws.sms#ClientToken": { "type": "string" }, + "com.amazonaws.sms#Command": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64000 + } + } + }, "com.amazonaws.sms#Connector": { "type": "structure", "members": { @@ -455,28 +616,34 @@ "smithy.api#documentation": "

    The name of the VM manager.

    " } }, - "macAddress": { - "target": "com.amazonaws.sms#MacAddress", + "vmManagerId": { + "target": "com.amazonaws.sms#VmManagerId", "traits": { - "smithy.api#documentation": "

    The MAC address of the connector.

    " + "smithy.api#documentation": "

    The ID of the VM manager.

    " } }, "connectorId": { "target": "com.amazonaws.sms#ConnectorId", "traits": { - "smithy.api#documentation": "

    The identifier of the connector.

    " + "smithy.api#documentation": "

    The ID of the connector.

    " } }, - "vmManagerId": { - "target": "com.amazonaws.sms#VmManagerId", + "associatedOn": { + "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    The identifier of the VM manager.

    " + "smithy.api#documentation": "

    The time the connector was associated.

    " } }, - "vmManagerType": { - "target": "com.amazonaws.sms#VmManagerType", + "status": { + "target": "com.amazonaws.sms#ConnectorStatus", "traits": { - "smithy.api#documentation": "

    The VM management product.

    " + "smithy.api#documentation": "

    The status of the connector.

    " + } + }, + "ipAddress": { + "target": "com.amazonaws.sms#IpAddress", + "traits": { + "smithy.api#documentation": "

    The IP address of the connector.

    " } }, "capabilityList": { @@ -491,22 +658,16 @@ "smithy.api#documentation": "

    The connector version.

    " } }, - "status": { - "target": "com.amazonaws.sms#ConnectorStatus", - "traits": { - "smithy.api#documentation": "

    The status of the connector.

    " - } - }, - "associatedOn": { - "target": "com.amazonaws.sms#Timestamp", + "macAddress": { + "target": "com.amazonaws.sms#MacAddress", "traits": { - "smithy.api#documentation": "

    The time the connector was associated.

    " + "smithy.api#documentation": "

    The MAC address of the connector.

    " } }, - "ipAddress": { - "target": "com.amazonaws.sms#IpAddress", + "vmManagerType": { + "target": "com.amazonaws.sms#VmManagerType", "traits": { - "smithy.api#documentation": "

    The IP address of the connector.

    " + "smithy.api#documentation": "

    The VM management product.

    " } } }, @@ -533,6 +694,10 @@ { "value": "SNAPSHOT_BATCHING", "name": "snapshotBatching" + }, + { + "value": "SMS_OPTIMIZED", + "name": "smsOptimized" } ] } @@ -608,40 +773,40 @@ "com.amazonaws.sms#CreateAppRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.sms#AppName", + "description": { + "target": "com.amazonaws.sms#AppDescription", "traits": { - "smithy.api#documentation": "

    Name of the new application.

    " + "smithy.api#documentation": "

    The description of the new application

    " } }, "clientToken": { "target": "com.amazonaws.sms#ClientToken", "traits": { - "smithy.api#documentation": "

    A unique, case-sensitive identifier you provide to ensure idempotency of application\n creation.

    " + "smithy.api#documentation": "

    A unique, case-sensitive identifier that you provide to ensure the idempotency of\n application creation.

    " } }, - "description": { - "target": "com.amazonaws.sms#AppDescription", + "name": { + "target": "com.amazonaws.sms#AppName", "traits": { - "smithy.api#documentation": "

    Description of the new application

    " + "smithy.api#documentation": "

    The name of the new application.

    " } }, - "tags": { - "target": "com.amazonaws.sms#Tags", + "roleName": { + "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    List of tags to be associated with the application.

    " + "smithy.api#documentation": "

    The name of the service role in the customer's account to be used by AWS SMS.

    " } }, "serverGroups": { "target": "com.amazonaws.sms#ServerGroups", "traits": { - "smithy.api#documentation": "

    List of server groups to include in the application.

    " + "smithy.api#documentation": "

    The server groups to include in the application.

    " } }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", + "tags": { + "target": "com.amazonaws.sms#Tags", "traits": { - "smithy.api#documentation": "

    Name of service role in customer's account to be used by AWS SMS.

    " + "smithy.api#documentation": "

    The tags to be associated with the application.

    " } } } @@ -649,22 +814,22 @@ "com.amazonaws.sms#CreateAppResponse": { "type": "structure", "members": { + "tags": { + "target": "com.amazonaws.sms#Tags", + "traits": { + "smithy.api#documentation": "

    The tags associated with the application.

    " + } + }, "appSummary": { "target": "com.amazonaws.sms#AppSummary", "traits": { - "smithy.api#documentation": "

    Summary description of the application.

    " + "smithy.api#documentation": "

    A summary description of the application.

    " } }, "serverGroups": { "target": "com.amazonaws.sms#ServerGroups", "traits": { - "smithy.api#documentation": "

    List of server groups included in the application.

    " - } - }, - "tags": { - "target": "com.amazonaws.sms#Tags", - "traits": { - "smithy.api#documentation": "

    List of taags associated with the application.

    " + "smithy.api#documentation": "

    The server groups included in the application.

    " } } } @@ -713,41 +878,22 @@ "com.amazonaws.sms#CreateReplicationJobRequest": { "type": "structure", "members": { - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

    The name of the IAM role to be used by the AWS SMS.

    " - } - }, - "serverId": { - "target": "com.amazonaws.sms#ServerId", - "traits": { - "smithy.api#documentation": "

    The identifier of the server.

    ", - "smithy.api#required": {} - } - }, - "runOnce": { - "target": "com.amazonaws.sms#RunOnce", - "traits": { - "smithy.api#documentation": "

    " - } - }, "description": { "target": "com.amazonaws.sms#Description", "traits": { "smithy.api#documentation": "

    The description of the replication job.

    " } }, - "frequency": { - "target": "com.amazonaws.sms#Frequency", + "roleName": { + "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    The time between consecutive replication runs, in hours.

    " + "smithy.api#documentation": "

    The name of the IAM role to be used by the AWS SMS.

    " } }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", + "kmsKeyId": { + "target": "com.amazonaws.sms#KmsKeyId", "traits": { - "smithy.api#documentation": "

    The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the\n maximum number is reached and a new AMI is created.

    " + "smithy.api#documentation": "

    The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to the KMS key ID

      \n
      • \n
    • \n

      ARN referring to the KMS key alias

      \n
      • \n
    \n

    If encrypted is true but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

    " } }, "licenseType": { @@ -759,13 +905,32 @@ "encrypted": { "target": "com.amazonaws.sms#Encrypted", "traits": { - "smithy.api#documentation": "

    When true, the replication job produces encrypted AMIs. See also\n KmsKeyId below.

    " + "smithy.api#documentation": "

    Indicates whether the replication job produces encrypted AMIs.

    " } }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", + "numberOfRecentAmisToKeep": { + "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", + "traits": { + "smithy.api#documentation": "

    The maximum number of SMS-created AMIs to retain. The oldest is deleted after the\n maximum number is reached and a new AMI is created.

    " + } + }, + "serverId": { + "target": "com.amazonaws.sms#ServerId", + "traits": { + "smithy.api#documentation": "

    The ID of the server.

    ", + "smithy.api#required": {} + } + }, + "frequency": { + "target": "com.amazonaws.sms#Frequency", + "traits": { + "smithy.api#documentation": "

    The time between consecutive replication runs, in hours.

    " + } + }, + "runOnce": { + "target": "com.amazonaws.sms#RunOnce", "traits": { - "smithy.api#documentation": "

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the\n following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to KMS key ID

      \n
      • \n
    • \n

      ARN referring to KMS key alias

      \n
      • \n
    \n

    If encrypted is true but a KMS key id is not specified, the\n customer's default KMS key for EBS is used.

    " + "smithy.api#documentation": "

    Indicates whether to run the replication job one time.

    " } }, "seedReplicationTime": { @@ -814,7 +979,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes an existing application. Optionally deletes the launched stack associated with\n the application and all AWS SMS replication jobs for servers in the application.

    " + "smithy.api#documentation": "

    Deletes the specified application. Optionally deletes the launched stack associated with\n the application and all AWS SMS replication jobs for servers in the application.

    " } }, "com.amazonaws.sms#DeleteAppLaunchConfiguration": { @@ -843,7 +1008,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes existing launch configuration for an application.

    " + "smithy.api#documentation": "

    Deletes the launch configuration for the specified application.

    " } }, "com.amazonaws.sms#DeleteAppLaunchConfigurationRequest": { @@ -852,7 +1017,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application associated with the launch configuration.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -887,7 +1052,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes existing replication configuration for an application.

    " + "smithy.api#documentation": "

    Deletes the replication configuration for the specified application.

    " } }, "com.amazonaws.sms#DeleteAppReplicationConfigurationRequest": { @@ -896,7 +1061,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application associated with the replication configuration.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -911,19 +1076,19 @@ "forceTerminateApp": { "target": "com.amazonaws.sms#ForceTerminateApp", "traits": { - "smithy.api#documentation": "

    While deleting the application, terminate the stack corresponding to the\n application.

    " + "smithy.api#documentation": "

    Indicates whether to terminate the stack corresponding to the\n application while deleting the application.

    " } }, "forceStopAppReplication": { "target": "com.amazonaws.sms#ForceStopAppReplication", "traits": { - "smithy.api#documentation": "

    While deleting the application, stop all replication jobs corresponding to the servers\n in the application.

    " + "smithy.api#documentation": "

    Indicates whether to stop all replication jobs corresponding to the servers\n in the application while deleting the application.

    " } }, "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application to delete.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -932,6 +1097,51 @@ "type": "structure", "members": {} }, + "com.amazonaws.sms#DeleteAppValidationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.sms#DeleteAppValidationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.sms#DeleteAppValidationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sms#InternalError" + }, + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, + { + "target": "com.amazonaws.sms#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.sms#UnauthorizedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the validation configuration for the specified application.

    " + } + }, + "com.amazonaws.sms#DeleteAppValidationConfigurationRequest": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.sms#AppIdWithValidation", + "traits": { + "smithy.api#documentation": "

    The ID of the application.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sms#DeleteAppValidationConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.sms#DeleteReplicationJob": { "type": "operation", "input": { @@ -967,7 +1177,7 @@ "replicationJobId": { "target": "com.amazonaws.sms#ReplicationJobId", "traits": { - "smithy.api#documentation": "

    The identifier of the replication job.

    ", + "smithy.api#documentation": "

    The ID of the replication job.

    ", "smithy.api#required": {} } } @@ -1046,7 +1256,7 @@ "connectorId": { "target": "com.amazonaws.sms#ConnectorId", "traits": { - "smithy.api#documentation": "

    The identifier of the connector.

    ", + "smithy.api#documentation": "

    The ID of the connector.

    ", "smithy.api#required": {} } } @@ -1056,6 +1266,19 @@ "type": "structure", "members": {} }, + "com.amazonaws.sms#DryRunOperationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sms#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The user has the required permissions, so the request would have succeeded, \n but a dry run was performed.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 412 + } + }, "com.amazonaws.sms#EC2KeyName": { "type": "string" }, @@ -1068,6 +1291,15 @@ "com.amazonaws.sms#ErrorMessage": { "type": "string" }, + "com.amazonaws.sms#ExecutionTimeoutSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 28800 + } + } + }, "com.amazonaws.sms#ForceStopAppReplication": { "type": "boolean", "traits": { @@ -1118,16 +1350,16 @@ "com.amazonaws.sms#GenerateChangeSetRequest": { "type": "structure", "members": { - "changesetFormat": { - "target": "com.amazonaws.sms#OutputFormat", + "appId": { + "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    Format for the change set.

    " + "smithy.api#documentation": "

    The ID of the application associated with the change set.

    " } }, - "appId": { - "target": "com.amazonaws.sms#AppId", + "changesetFormat": { + "target": "com.amazonaws.sms#OutputFormat", "traits": { - "smithy.api#documentation": "

    ID of the application associated with the change set.

    " + "smithy.api#documentation": "

    The format for the change set.

    " } } } @@ -1138,7 +1370,7 @@ "s3Location": { "target": "com.amazonaws.sms#S3Location", "traits": { - "smithy.api#documentation": "

    Location of the Amazon S3 object.

    " + "smithy.api#documentation": "

    The location of the Amazon S3 object.

    " } } } @@ -1169,7 +1401,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Generates an Amazon CloudFormation template based on the current launch configuration and writes it to\n an Amazon S3 object in the customer’s Amazon S3 bucket.

    " + "smithy.api#documentation": "

    Generates an AWS CloudFormation template based on the current launch configuration and writes it to\n an Amazon S3 object in the customer’s Amazon S3 bucket.

    " } }, "com.amazonaws.sms#GenerateTemplateRequest": { @@ -1178,13 +1410,13 @@ "templateFormat": { "target": "com.amazonaws.sms#OutputFormat", "traits": { - "smithy.api#documentation": "

    Format for generating the Amazon CloudFormation template.

    " + "smithy.api#documentation": "

    The format for generating the AWS CloudFormation template.

    " } }, "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application associated with the Amazon CloudFormation template.

    " + "smithy.api#documentation": "

    The ID of the application associated with the AWS CloudFormation template.

    " } } } @@ -1195,7 +1427,7 @@ "s3Location": { "target": "com.amazonaws.sms#S3Location", "traits": { - "smithy.api#documentation": "

    Location of the Amazon S3 object.

    " + "smithy.api#documentation": "

    The location of the Amazon S3 object.

    " } } } @@ -1226,7 +1458,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieve information about an application.

    " + "smithy.api#documentation": "

    Retrieve information about the specified application.

    " } }, "com.amazonaws.sms#GetAppLaunchConfiguration": { @@ -1255,7 +1487,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the application launch configuration associated with an application.

    " + "smithy.api#documentation": "

    Retrieves the application launch configuration associated with the specified application.

    " } }, "com.amazonaws.sms#GetAppLaunchConfigurationRequest": { @@ -1264,7 +1496,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application launch configuration.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -1275,19 +1507,25 @@ "serverGroupLaunchConfigurations": { "target": "com.amazonaws.sms#ServerGroupLaunchConfigurations", "traits": { - "smithy.api#documentation": "

    List of launch configurations for server groups in this application.

    " + "smithy.api#documentation": "

    The launch configurations for server groups in this application.

    " } }, "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    Name of the service role in the customer's account that Amazon CloudFormation uses to launch the\n application.

    " + "smithy.api#documentation": "

    The name of the service role in the customer's account that AWS CloudFormation uses to launch the\n application.

    " } }, "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application associated with the launch configuration.

    " + "smithy.api#documentation": "

    The ID of the application.

    " + } + }, + "autoLaunch": { + "target": "com.amazonaws.sms#AutoLaunch", + "traits": { + "smithy.api#documentation": "

    Indicates whether the application is configured to launch automatically after replication is complete.

    " } } } @@ -1318,7 +1556,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves an application replication configuration associatd with an\n application.

    " + "smithy.api#documentation": "

    Retrieves the application replication configuration associated with the specified\n application.

    " } }, "com.amazonaws.sms#GetAppReplicationConfigurationRequest": { @@ -1327,7 +1565,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application associated with the replication configuration.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -1338,7 +1576,7 @@ "serverGroupReplicationConfigurations": { "target": "com.amazonaws.sms#ServerGroupReplicationConfigurations", "traits": { - "smithy.api#documentation": "

    Replication configurations associated with server groups in this application.

    " + "smithy.api#documentation": "

    The replication configurations associated with server groups in this application.

    " } } } @@ -1349,7 +1587,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application whose information is being retrieved.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -1360,7 +1598,13 @@ "serverGroups": { "target": "com.amazonaws.sms#ServerGroups", "traits": { - "smithy.api#documentation": "

    List of server groups belonging to the application.

    " + "smithy.api#documentation": "

    The server groups that belong to the application.

    " + } + }, + "tags": { + "target": "com.amazonaws.sms#Tags", + "traits": { + "smithy.api#documentation": "

    The tags associated with the application.

    " } }, "appSummary": { @@ -1368,11 +1612,115 @@ "traits": { "smithy.api#documentation": "

    Information about the application.

    " } + } + } + }, + "com.amazonaws.sms#GetAppValidationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.sms#GetAppValidationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.sms#GetAppValidationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sms#InternalError" }, - "tags": { - "target": "com.amazonaws.sms#Tags", + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, + { + "target": "com.amazonaws.sms#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.sms#UnauthorizedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves information about a configuration for validating an application.

    " + } + }, + "com.amazonaws.sms#GetAppValidationConfigurationRequest": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.sms#AppIdWithValidation", + "traits": { + "smithy.api#documentation": "

    The ID of the application.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sms#GetAppValidationConfigurationResponse": { + "type": "structure", + "members": { + "serverGroupValidationConfigurations": { + "target": "com.amazonaws.sms#ServerGroupValidationConfigurations", + "traits": { + "smithy.api#documentation": "

    The configuration for instance validation.

    " + } + }, + "appValidationConfigurations": { + "target": "com.amazonaws.sms#AppValidationConfigurations", + "traits": { + "smithy.api#documentation": "

    The configuration for application validation.

    " + } + } + } + }, + "com.amazonaws.sms#GetAppValidationOutput": { + "type": "operation", + "input": { + "target": "com.amazonaws.sms#GetAppValidationOutputRequest" + }, + "output": { + "target": "com.amazonaws.sms#GetAppValidationOutputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sms#InternalError" + }, + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, + { + "target": "com.amazonaws.sms#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.sms#UnauthorizedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves output from validating an application.

    " + } + }, + "com.amazonaws.sms#GetAppValidationOutputRequest": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.sms#AppIdWithValidation", + "traits": { + "smithy.api#documentation": "

    The ID of the application.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sms#GetAppValidationOutputResponse": { + "type": "structure", + "members": { + "validationOutputList": { + "target": "com.amazonaws.sms#ValidationOutputList", "traits": { - "smithy.api#documentation": "

    List of tags associated with the application.

    " + "smithy.api#documentation": "

    The validation output.

    " } } } @@ -1466,16 +1814,16 @@ "com.amazonaws.sms#GetReplicationJobsRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", + "replicationJobId": { + "target": "com.amazonaws.sms#ReplicationJobId", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

    " + "smithy.api#documentation": "

    The ID of the replication job.

    " } }, - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", + "maxResults": { + "target": "com.amazonaws.sms#MaxResults", "traits": { - "smithy.api#documentation": "

    The identifier of the replication job.

    " + "smithy.api#documentation": "

    The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

    " } }, "nextToken": { @@ -1535,19 +1883,19 @@ "com.amazonaws.sms#GetReplicationRunsRequest": { "type": "structure", "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

    The identifier of the replication job.

    ", - "smithy.api#required": {} - } - }, "nextToken": { "target": "com.amazonaws.sms#NextToken", "traits": { "smithy.api#documentation": "

    The token for the next set of results.

    " } }, + "replicationJobId": { + "target": "com.amazonaws.sms#ReplicationJobId", + "traits": { + "smithy.api#documentation": "

    The ID of the replication job.

    ", + "smithy.api#required": {} + } + }, "maxResults": { "target": "com.amazonaws.sms#MaxResults", "traits": { @@ -1565,17 +1913,17 @@ "smithy.api#documentation": "

    Information about the replication job.

    " } }, - "replicationRunList": { - "target": "com.amazonaws.sms#ReplicationRunList", - "traits": { - "smithy.api#documentation": "

    Information about the replication runs.

    " - } - }, "nextToken": { "target": "com.amazonaws.sms#NextToken", "traits": { "smithy.api#documentation": "

    The token required to retrieve the next set of results. This value is null when\n there are no more results to return.

    " } + }, + "replicationRunList": { + "target": "com.amazonaws.sms#ReplicationRunList", + "traits": { + "smithy.api#documentation": "

    Information about the replication runs.

    " + } } } }, @@ -1588,6 +1936,15 @@ "target": "com.amazonaws.sms#GetServersResponse" }, "errors": [ + { + "target": "com.amazonaws.sms#InternalError" + }, + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, { "target": "com.amazonaws.sms#UnauthorizedOperationException" } @@ -1605,16 +1962,10 @@ "com.amazonaws.sms#GetServersRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

    " - } - }, "vmServerAddressList": { "target": "com.amazonaws.sms#VmServerAddressList", "traits": { - "smithy.api#documentation": "

    List of VmServerAddress objects

    " + "smithy.api#documentation": "

    The server addresses.

    " } }, "nextToken": { @@ -1622,22 +1973,28 @@ "traits": { "smithy.api#documentation": "

    The token for the next set of results.

    " } + }, + "maxResults": { + "target": "com.amazonaws.sms#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

    " + } } } }, "com.amazonaws.sms#GetServersResponse": { "type": "structure", "members": { - "serverCatalogStatus": { - "target": "com.amazonaws.sms#ServerCatalogStatus", + "lastModifiedOn": { + "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    The status of the server catalog.

    " + "smithy.api#documentation": "

    The time when the server was last modified.

    " } }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", + "serverCatalogStatus": { + "target": "com.amazonaws.sms#ServerCatalogStatus", "traits": { - "smithy.api#documentation": "

    The token required to retrieve the next set of results. This value is null when\n there are no more results to return.

    " + "smithy.api#documentation": "

    The status of the server catalog.

    " } }, "serverList": { @@ -1646,31 +2003,31 @@ "smithy.api#documentation": "

    Information about the servers.

    " } }, - "lastModifiedOn": { - "target": "com.amazonaws.sms#Timestamp", + "nextToken": { + "target": "com.amazonaws.sms#NextToken", "traits": { - "smithy.api#documentation": "

    The time when the server was last modified.

    " + "smithy.api#documentation": "

    The token required to retrieve the next set of results. This value is null when\n there are no more results to return.

    " } } } }, - "com.amazonaws.sms#ImportServerCatalog": { + "com.amazonaws.sms#ImportAppCatalog": { "type": "operation", "input": { - "target": "com.amazonaws.sms#ImportServerCatalogRequest" + "target": "com.amazonaws.sms#ImportAppCatalogRequest" }, "output": { - "target": "com.amazonaws.sms#ImportServerCatalogResponse" + "target": "com.amazonaws.sms#ImportAppCatalogResponse" }, "errors": [ { - "target": "com.amazonaws.sms#InvalidParameterException" + "target": "com.amazonaws.sms#InternalError" }, { - "target": "com.amazonaws.sms#MissingRequiredParameterException" + "target": "com.amazonaws.sms#InvalidParameterException" }, { - "target": "com.amazonaws.sms#NoConnectorsAvailableException" + "target": "com.amazonaws.sms#MissingRequiredParameterException" }, { "target": "com.amazonaws.sms#OperationNotPermittedException" @@ -1680,17 +2037,70 @@ } ], "traits": { - "smithy.api#documentation": "

    Gathers a complete list of on-premises servers. Connectors must be installed and\n monitoring all servers that you want to import.

    \n

    This call returns immediately, but might take additional time to retrieve all the\n servers.

    " + "smithy.api#documentation": "

    Allows application import from AWS Migration Hub.

    " } }, - "com.amazonaws.sms#ImportServerCatalogRequest": { + "com.amazonaws.sms#ImportAppCatalogRequest": { "type": "structure", - "members": {} - }, + "members": { + "roleName": { + "target": "com.amazonaws.sms#RoleName", + "traits": { + "smithy.api#documentation": "

    The name of the service role. If you omit this parameter, we create a service-linked role\n for AWS Migration Hub in your account. Otherwise, the role that you provide must have the policy\n and trust policy described in the AWS Migration Hub User Guide.

    " + } + } + } + }, + "com.amazonaws.sms#ImportAppCatalogResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.sms#ImportServerCatalog": { + "type": "operation", + "input": { + "target": "com.amazonaws.sms#ImportServerCatalogRequest" + }, + "output": { + "target": "com.amazonaws.sms#ImportServerCatalogResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, + { + "target": "com.amazonaws.sms#NoConnectorsAvailableException" + }, + { + "target": "com.amazonaws.sms#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.sms#UnauthorizedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gathers a complete list of on-premises servers. Connectors must be installed and\n monitoring all servers to import.

    \n

    This call returns immediately, but might take additional time to retrieve all the\n servers.

    " + } + }, + "com.amazonaws.sms#ImportServerCatalogRequest": { + "type": "structure", + "members": {} + }, "com.amazonaws.sms#ImportServerCatalogResponse": { "type": "structure", "members": {} }, + "com.amazonaws.sms#ImportedAppId": { + "type": "string" + }, + "com.amazonaws.sms#InstanceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" + } + }, "com.amazonaws.sms#InstanceType": { "type": "string" }, @@ -1723,9 +2133,6 @@ "com.amazonaws.sms#IpAddress": { "type": "string" }, - "com.amazonaws.sms#KeyName": { - "type": "string" - }, "com.amazonaws.sms#KmsKeyId": { "type": "string" }, @@ -1755,7 +2162,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Launches an application stack.

    " + "smithy.api#documentation": "

    Launches the specified application as a stack in AWS CloudFormation.

    " } }, "com.amazonaws.sms#LaunchAppRequest": { @@ -1764,7 +2171,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application to launch.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -1776,22 +2183,22 @@ "com.amazonaws.sms#LaunchDetails": { "type": "structure", "members": { + "stackId": { + "target": "com.amazonaws.sms#StackId", + "traits": { + "smithy.api#documentation": "

    The ID of the latest stack launched for this application.

    " + } + }, "stackName": { "target": "com.amazonaws.sms#StackName", "traits": { - "smithy.api#documentation": "

    Name of the latest stack launched for this application.

    " + "smithy.api#documentation": "

    The name of the latest stack launched for this application.

    " } }, "latestLaunchTime": { "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    Latest time this application was launched successfully.

    " - } - }, - "stackId": { - "target": "com.amazonaws.sms#StackId", - "traits": { - "smithy.api#documentation": "

    Identifier of the latest stack launched for this application.

    " + "smithy.api#documentation": "

    The latest time that this application was launched successfully.

    " } } }, @@ -1846,7 +2253,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of summaries for all applications.

    " + "smithy.api#documentation": "

    Retrieves summaries for all applications.

    " } }, "com.amazonaws.sms#ListAppsRequest": { @@ -1858,16 +2265,16 @@ "smithy.api#documentation": "

    The token for the next set of results.

    " } }, - "appIds": { - "target": "com.amazonaws.sms#AppIds", + "maxResults": { + "target": "com.amazonaws.sms#MaxResults", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    The maximum number of results to return in a single call. The default value is 100. To\n retrieve the remaining results, make another call with the returned\n NextToken value.

    " } }, - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", + "appIds": { + "target": "com.amazonaws.sms#AppIds", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in a single call. The default value is\n 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

    " + "smithy.api#documentation": "

    The unique application IDs.

    " } } } @@ -1875,17 +2282,17 @@ "com.amazonaws.sms#ListAppsResponse": { "type": "structure", "members": { - "apps": { - "target": "com.amazonaws.sms#Apps", - "traits": { - "smithy.api#documentation": "

    A list of application summaries.

    " - } - }, "nextToken": { "target": "com.amazonaws.sms#NextToken", "traits": { "smithy.api#documentation": "

    The token required to retrieve the next set of results. This value is null when there\n are no more results to return.

    " } + }, + "apps": { + "target": "com.amazonaws.sms#Apps", + "traits": { + "smithy.api#documentation": "

    The application summaries.

    " + } } } }, @@ -1930,6 +2337,93 @@ "smithy.api#httpError": 430 } }, + "com.amazonaws.sms#NonEmptyStringWithMaxLen255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.sms#NotificationContext": { + "type": "structure", + "members": { + "validationId": { + "target": "com.amazonaws.sms#ValidationId", + "traits": { + "smithy.api#documentation": "

    The ID of the validation.

    " + } + }, + "statusMessage": { + "target": "com.amazonaws.sms#ValidationStatusMessage", + "traits": { + "smithy.api#documentation": "

    The status message.

    " + } + }, + "status": { + "target": "com.amazonaws.sms#ValidationStatus", + "traits": { + "smithy.api#documentation": "

    The status of the validation.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains the status of validating an application.

    " + } + }, + "com.amazonaws.sms#NotifyAppValidationOutput": { + "type": "operation", + "input": { + "target": "com.amazonaws.sms#NotifyAppValidationOutputRequest" + }, + "output": { + "target": "com.amazonaws.sms#NotifyAppValidationOutputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sms#InternalError" + }, + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, + { + "target": "com.amazonaws.sms#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.sms#UnauthorizedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Provides information to AWS SMS about whether application validation is successful.

    " + } + }, + "com.amazonaws.sms#NotifyAppValidationOutputRequest": { + "type": "structure", + "members": { + "notificationContext": { + "target": "com.amazonaws.sms#NotificationContext", + "traits": { + "smithy.api#documentation": "

    The notification information.

    " + } + }, + "appId": { + "target": "com.amazonaws.sms#AppIdWithValidation", + "traits": { + "smithy.api#documentation": "

    The ID of the application.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sms#NotifyAppValidationOutputResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.sms#NumberOfRecentAmisToKeep": { "type": "integer", "traits": { @@ -1990,28 +2484,34 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a launch configuration for an application.

    " + "smithy.api#documentation": "

    Creates or updates the launch configuration for the specified application.

    " } }, "com.amazonaws.sms#PutAppLaunchConfigurationRequest": { "type": "structure", "members": { - "serverGroupLaunchConfigurations": { - "target": "com.amazonaws.sms#ServerGroupLaunchConfigurations", + "appId": { + "target": "com.amazonaws.sms#AppId", + "traits": { + "smithy.api#documentation": "

    The ID of the application.

    " + } + }, + "autoLaunch": { + "target": "com.amazonaws.sms#AutoLaunch", "traits": { - "smithy.api#documentation": "

    Launch configurations for server groups in the application.

    " + "smithy.api#documentation": "

    Indicates whether the application is configured to launch automatically after replication is complete.

    " } }, "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    Name of service role in the customer's account that Amazon CloudFormation uses to launch the\n application.

    " + "smithy.api#documentation": "

    The name of service role in the customer's account that AWS CloudFormation uses to launch the\n application.

    " } }, - "appId": { - "target": "com.amazonaws.sms#AppId", + "serverGroupLaunchConfigurations": { + "target": "com.amazonaws.sms#ServerGroupLaunchConfigurations", "traits": { - "smithy.api#documentation": "

    ID of the application associated with the launch configuration.

    " + "smithy.api#documentation": "

    Information about the launch configurations for server groups in the application.

    " } } } @@ -2046,7 +2546,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates or updates a replication configuration for an application.

    " + "smithy.api#documentation": "

    Creates or updates the replication configuration for the specified application.

    " } }, "com.amazonaws.sms#PutAppReplicationConfigurationRequest": { @@ -2055,13 +2555,13 @@ "serverGroupReplicationConfigurations": { "target": "com.amazonaws.sms#ServerGroupReplicationConfigurations", "traits": { - "smithy.api#documentation": "

    Replication configurations for server groups in the application.

    " + "smithy.api#documentation": "

    Information about the replication configurations for server groups in the application.

    " } }, "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application tassociated with the replication configuration.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -2070,37 +2570,70 @@ "type": "structure", "members": {} }, - "com.amazonaws.sms#ReplicationJob": { + "com.amazonaws.sms#PutAppValidationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.sms#PutAppValidationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.sms#PutAppValidationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sms#InternalError" + }, + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, + { + "target": "com.amazonaws.sms#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.sms#UnauthorizedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates or updates a validation configuration for the specified application.

    " + } + }, + "com.amazonaws.sms#PutAppValidationConfigurationRequest": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

    The description of the replication job.

    " - } - }, - "replicationRunList": { - "target": "com.amazonaws.sms#ReplicationRunList", + "appId": { + "target": "com.amazonaws.sms#AppIdWithValidation", "traits": { - "smithy.api#documentation": "

    Information about the replication runs.

    " + "smithy.api#documentation": "

    The ID of the application.

    ", + "smithy.api#required": {} } }, - "state": { - "target": "com.amazonaws.sms#ReplicationJobState", + "serverGroupValidationConfigurations": { + "target": "com.amazonaws.sms#ServerGroupValidationConfigurations", "traits": { - "smithy.api#documentation": "

    The state of the replication job.

    " + "smithy.api#documentation": "

    The configuration for instance validation.

    " } }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", + "appValidationConfigurations": { + "target": "com.amazonaws.sms#AppValidationConfigurations", "traits": { - "smithy.api#documentation": "

    The name of the IAM role to be used by the Server Migration Service.

    " + "smithy.api#documentation": "

    The configuration for application validation.

    " } - }, - "runOnce": { - "target": "com.amazonaws.sms#RunOnce", + } + } + }, + "com.amazonaws.sms#PutAppValidationConfigurationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.sms#ReplicationJob": { + "type": "structure", + "members": { + "latestAmiId": { + "target": "com.amazonaws.sms#AmiId", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    The ID of the latest Amazon Machine Image (AMI).

    " } }, "vmServer": { @@ -2109,16 +2642,22 @@ "smithy.api#documentation": "

    Information about the VM server.

    " } }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", + "state": { + "target": "com.amazonaws.sms#ReplicationJobState", "traits": { - "smithy.api#documentation": "

    Number of recent AMIs to keep in the customer's account for a replication job. By\n default the value is set to zero, meaning that all AMIs are kept.

    " + "smithy.api#documentation": "

    The state of the replication job.

    " } }, - "serverId": { - "target": "com.amazonaws.sms#ServerId", + "description": { + "target": "com.amazonaws.sms#Description", "traits": { - "smithy.api#documentation": "

    The identifier of the server.

    " + "smithy.api#documentation": "

    The description of the replication job.

    " + } + }, + "replicationRunList": { + "target": "com.amazonaws.sms#ReplicationRunList", + "traits": { + "smithy.api#documentation": "

    Information about the replication runs.

    " } }, "frequency": { @@ -2130,25 +2669,25 @@ "replicationJobId": { "target": "com.amazonaws.sms#ReplicationJobId", "traits": { - "smithy.api#documentation": "

    The identifier of the replication job.

    " + "smithy.api#documentation": "

    The ID of the replication job.

    " } }, - "statusMessage": { - "target": "com.amazonaws.sms#ReplicationJobStatusMessage", + "serverId": { + "target": "com.amazonaws.sms#ServerId", "traits": { - "smithy.api#documentation": "

    The description of the current status of the replication job.

    " + "smithy.api#documentation": "

    The ID of the server.

    " } }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", + "nextReplicationRunStartTime": { + "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    Whether the replication job should produce encrypted AMIs or not. See also\n KmsKeyId below.

    " + "smithy.api#documentation": "

    The start time of the next replication run.

    " } }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", + "roleName": { + "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the\n following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to KMS key ID

      \n
      • \n
    • \n

      ARN referring to KMS key alias

      \n
      • \n
    \n

    If encrypted is true but a KMS key id is not specified, the\n customer's default KMS key for EBS is used.

    " + "smithy.api#documentation": "

    The name of the IAM role to be used by AWS SMS.

    " } }, "licenseType": { @@ -2157,28 +2696,46 @@ "smithy.api#documentation": "

    The license type to be used for the AMI created by a successful replication\n run.

    " } }, - "serverType": { - "target": "com.amazonaws.sms#ServerType", + "kmsKeyId": { + "target": "com.amazonaws.sms#KmsKeyId", "traits": { - "smithy.api#documentation": "

    The type of server.

    " + "smithy.api#documentation": "

    The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to the KMS key ID

      \n
      • \n
    • \n

      ARN referring to the KMS key alias

      \n
      • \n
    \n

    If encrypted is enabled but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

    " } }, - "seedReplicationTime": { - "target": "com.amazonaws.sms#Timestamp", + "encrypted": { + "target": "com.amazonaws.sms#Encrypted", "traits": { - "smithy.api#documentation": "

    The seed replication time.

    " + "smithy.api#documentation": "

    Indicates whether the replication job should produce encrypted AMIs.

    " } }, - "nextReplicationRunStartTime": { + "numberOfRecentAmisToKeep": { + "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", + "traits": { + "smithy.api#documentation": "

    The number of recent AMIs to keep in the customer's account for a replication job. By\n default, the value is set to zero, meaning that all AMIs are kept.

    " + } + }, + "statusMessage": { + "target": "com.amazonaws.sms#ReplicationJobStatusMessage", + "traits": { + "smithy.api#documentation": "

    The description of the current status of the replication job.

    " + } + }, + "runOnce": { + "target": "com.amazonaws.sms#RunOnce", + "traits": { + "smithy.api#documentation": "

    Indicates whether to run the replication job one time.

    " + } + }, + "seedReplicationTime": { "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    The start time of the next replication run.

    " + "smithy.api#documentation": "

    The seed replication time.

    " } }, - "latestAmiId": { - "target": "com.amazonaws.sms#AmiId", + "serverType": { + "target": "com.amazonaws.sms#ServerType", "traits": { - "smithy.api#documentation": "

    The ID of the latest Amazon Machine Image (AMI).

    " + "smithy.api#documentation": "

    The type of server.

    " } } }, @@ -2275,16 +2832,22 @@ "com.amazonaws.sms#ReplicationRun": { "type": "structure", "members": { - "completedTime": { - "target": "com.amazonaws.sms#Timestamp", + "description": { + "target": "com.amazonaws.sms#Description", "traits": { - "smithy.api#documentation": "

    The completion time of the last replication run.

    " + "smithy.api#documentation": "

    The description of the replication run.

    " } }, "kmsKeyId": { "target": "com.amazonaws.sms#KmsKeyId", "traits": { - "smithy.api#documentation": "

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the\n following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to KMS key ID

      \n
      • \n
    • \n

      ARN referring to KMS key alias

      \n
      • \n
    \n

    If encrypted is true but a KMS key id is not specified, the\n customer's default KMS key for EBS is used.

    " + "smithy.api#documentation": "

    The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to the KMS key ID

      \n
      • \n
    • \n

      ARN referring to the KMS key alias

      \n
      • \n
    \n

    If encrypted is true but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

    " + } + }, + "encrypted": { + "target": "com.amazonaws.sms#Encrypted", + "traits": { + "smithy.api#documentation": "

    Indicates whether the replication run should produce an encrypted AMI.

    " } }, "state": { @@ -2293,52 +2856,46 @@ "smithy.api#documentation": "

    The state of the replication run.

    " } }, - "scheduledStartTime": { - "target": "com.amazonaws.sms#Timestamp", + "replicationRunId": { + "target": "com.amazonaws.sms#ReplicationRunId", "traits": { - "smithy.api#documentation": "

    The start time of the next replication run.

    " + "smithy.api#documentation": "

    The ID of the replication run.

    " } }, - "stageDetails": { - "target": "com.amazonaws.sms#ReplicationRunStageDetails", + "type": { + "target": "com.amazonaws.sms#ReplicationRunType", "traits": { - "smithy.api#documentation": "

    Details of the current stage of the replication run.

    " + "smithy.api#documentation": "

    The type of replication run.

    " } }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", + "statusMessage": { + "target": "com.amazonaws.sms#ReplicationRunStatusMessage", "traits": { - "smithy.api#documentation": "

    Whether the replication run should produce encrypted AMI or not. See also\n KmsKeyId below.

    " + "smithy.api#documentation": "

    The description of the current status of the replication job.

    " } }, "amiId": { "target": "com.amazonaws.sms#AmiId", "traits": { - "smithy.api#documentation": "

    The identifier of the Amazon Machine Image (AMI) from the replication\n run.

    " - } - }, - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

    The description of the replication run.

    " + "smithy.api#documentation": "

    The ID of the Amazon Machine Image (AMI) from the replication\n run.

    " } }, - "type": { - "target": "com.amazonaws.sms#ReplicationRunType", + "completedTime": { + "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    The type of replication run.

    " + "smithy.api#documentation": "

    The completion time of the last replication run.

    " } }, - "replicationRunId": { - "target": "com.amazonaws.sms#ReplicationRunId", + "stageDetails": { + "target": "com.amazonaws.sms#ReplicationRunStageDetails", "traits": { - "smithy.api#documentation": "

    The identifier of the replication run.

    " + "smithy.api#documentation": "

    Details about the current stage of the replication run.

    " } }, - "statusMessage": { - "target": "com.amazonaws.sms#ReplicationRunStatusMessage", + "scheduledStartTime": { + "target": "com.amazonaws.sms#Timestamp", "traits": { - "smithy.api#documentation": "

    The description of the current status of the replication job.

    " + "smithy.api#documentation": "

    The start time of the next replication run.

    " } } }, @@ -2380,13 +2937,13 @@ "stageProgress": { "target": "com.amazonaws.sms#ReplicationRunStageProgress", "traits": { - "smithy.api#documentation": "

    String describing the progress of the current stage of a replication run.

    " + "smithy.api#documentation": "

    The progress of the current stage of a replication run.

    " } }, "stage": { "target": "com.amazonaws.sms#ReplicationRunStage", "traits": { - "smithy.api#documentation": "

    String describing the current stage of a replication run.

    " + "smithy.api#documentation": "

    The current stage of a replication run.

    " } } }, @@ -2459,24 +3016,112 @@ "smithy.api#box": {} } }, + "com.amazonaws.sms#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.sms#S3KeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.sms#S3Location": { "type": "structure", "members": { "key": { - "target": "com.amazonaws.sms#KeyName", + "target": "com.amazonaws.sms#S3KeyName", "traits": { - "smithy.api#documentation": "

    Amazon S3 bucket key.

    " + "smithy.api#documentation": "

    The Amazon S3 bucket key.

    " } }, "bucket": { + "target": "com.amazonaws.sms#S3BucketName", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 bucket name.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Location of an Amazon S3 object.

    " + } + }, + "com.amazonaws.sms#SSMOutput": { + "type": "structure", + "members": { + "s3Location": { + "target": "com.amazonaws.sms#S3Location" + } + }, + "traits": { + "smithy.api#documentation": "

    Contains the location of validation output.

    " + } + }, + "com.amazonaws.sms#SSMValidationParameters": { + "type": "structure", + "members": { + "executionTimeoutSeconds": { + "target": "com.amazonaws.sms#ExecutionTimeoutSeconds", + "traits": { + "smithy.api#documentation": "

    The timeout interval, in seconds.

    " + } + }, + "source": { + "target": "com.amazonaws.sms#Source", + "traits": { + "smithy.api#documentation": "

    The location of the validation script.

    " + } + }, + "outputS3BucketName": { "target": "com.amazonaws.sms#BucketName", "traits": { - "smithy.api#documentation": "

    Amazon S3 bucket name.

    " + "smithy.api#documentation": "

    The name of the S3 bucket for output.

    " + } + }, + "scriptType": { + "target": "com.amazonaws.sms#ScriptType", + "traits": { + "smithy.api#documentation": "

    The type of validation script.

    " + } + }, + "command": { + "target": "com.amazonaws.sms#Command", + "traits": { + "smithy.api#documentation": "

    The command to run the validation script

    " + } + }, + "instanceId": { + "target": "com.amazonaws.sms#InstanceId", + "traits": { + "smithy.api#documentation": "

    The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

    " } } }, "traits": { - "smithy.api#documentation": "

    Location of the Amazon S3 object in the customer's account.

    " + "smithy.api#documentation": "

    Contains validation parameters.

    " + } + }, + "com.amazonaws.sms#ScriptType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHELL_SCRIPT", + "name": "SHELL_SCRIPT" + }, + { + "value": "POWERSHELL_SCRIPT", + "name": "POWERSHELL_SCRIPT" + } + ] } }, "com.amazonaws.sms#SecurityGroup": { @@ -2485,34 +3130,34 @@ "com.amazonaws.sms#Server": { "type": "structure", "members": { - "vmServer": { - "target": "com.amazonaws.sms#VmServer", + "replicationJobTerminated": { + "target": "com.amazonaws.sms#ReplicationJobTerminated", "traits": { - "smithy.api#documentation": "

    Information about the VM server.

    " + "smithy.api#documentation": "

    Indicates whether the replication job is deleted or failed.

    " } }, - "serverType": { - "target": "com.amazonaws.sms#ServerType", + "serverId": { + "target": "com.amazonaws.sms#ServerId", "traits": { - "smithy.api#documentation": "

    The type of server.

    " + "smithy.api#documentation": "

    The ID of the server.

    " } }, - "replicationJobTerminated": { - "target": "com.amazonaws.sms#ReplicationJobTerminated", + "vmServer": { + "target": "com.amazonaws.sms#VmServer", "traits": { - "smithy.api#documentation": "

    Indicates whether the replication job is deleted or failed.

    " + "smithy.api#documentation": "

    Information about the VM server.

    " } }, "replicationJobId": { "target": "com.amazonaws.sms#ReplicationJobId", "traits": { - "smithy.api#documentation": "

    The identifier of the replication job.

    " + "smithy.api#documentation": "

    The ID of the replication job.

    " } }, - "serverId": { - "target": "com.amazonaws.sms#ServerId", + "serverType": { + "target": "com.amazonaws.sms#ServerType", "traits": { - "smithy.api#documentation": "

    The identifier of the server.

    " + "smithy.api#documentation": "

    The type of server.

    " } } }, @@ -2566,24 +3211,24 @@ "serverGroupId": { "target": "com.amazonaws.sms#ServerGroupId", "traits": { - "smithy.api#documentation": "

    Identifier of a server group.

    " + "smithy.api#documentation": "

    The ID of a server group.

    " } }, - "name": { - "target": "com.amazonaws.sms#ServerGroupName", + "serverList": { + "target": "com.amazonaws.sms#ServerList", "traits": { - "smithy.api#documentation": "

    Name of a server group.

    " + "smithy.api#documentation": "

    The servers that belong to a server group.

    " } }, - "serverList": { - "target": "com.amazonaws.sms#ServerList", + "name": { + "target": "com.amazonaws.sms#ServerGroupName", "traits": { - "smithy.api#documentation": "

    List of servers belonging to a server group.

    " + "smithy.api#documentation": "

    The name of a server group.

    " } } }, "traits": { - "smithy.api#documentation": "

    A logical grouping of servers.

    " + "smithy.api#documentation": "

    Logical grouping of servers.

    " } }, "com.amazonaws.sms#ServerGroupId": { @@ -2595,19 +3240,19 @@ "launchOrder": { "target": "com.amazonaws.sms#LaunchOrder", "traits": { - "smithy.api#documentation": "

    Launch order of servers in the server group.

    " + "smithy.api#documentation": "

    The launch order of servers in the server group.

    " } }, "serverLaunchConfigurations": { "target": "com.amazonaws.sms#ServerLaunchConfigurations", "traits": { - "smithy.api#documentation": "

    Launch configuration for servers in the server group.

    " + "smithy.api#documentation": "

    The launch configuration for servers in the server group.

    " } }, "serverGroupId": { "target": "com.amazonaws.sms#ServerGroupId", "traits": { - "smithy.api#documentation": "

    Identifier of the server group the launch configuration is associated with.

    " + "smithy.api#documentation": "

    The ID of the server group with which the launch configuration is\n associated.

    " } } }, @@ -2630,13 +3275,13 @@ "serverReplicationConfigurations": { "target": "com.amazonaws.sms#ServerReplicationConfigurations", "traits": { - "smithy.api#documentation": "

    Replication configuration for servers in the server group.

    " + "smithy.api#documentation": "

    The replication configuration for servers in the server group.

    " } }, "serverGroupId": { "target": "com.amazonaws.sms#ServerGroupId", "traits": { - "smithy.api#documentation": "

    Identifier of the server group this replication configuration is associated\n with.

    " + "smithy.api#documentation": "

    The ID of the server group with which this replication configuration is\n associated.

    " } } }, @@ -2650,6 +3295,32 @@ "target": "com.amazonaws.sms#ServerGroupReplicationConfiguration" } }, + "com.amazonaws.sms#ServerGroupValidationConfiguration": { + "type": "structure", + "members": { + "serverGroupId": { + "target": "com.amazonaws.sms#ServerGroupId", + "traits": { + "smithy.api#documentation": "

    The ID of the server group.

    " + } + }, + "serverValidationConfigurations": { + "target": "com.amazonaws.sms#ServerValidationConfigurations", + "traits": { + "smithy.api#documentation": "

    The validation configuration.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Configuration for validating an instance.

    " + } + }, + "com.amazonaws.sms#ServerGroupValidationConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sms#ServerGroupValidationConfiguration" + } + }, "com.amazonaws.sms#ServerGroups": { "type": "list", "member": { @@ -2662,58 +3333,73 @@ "com.amazonaws.sms#ServerLaunchConfiguration": { "type": "structure", "members": { - "securityGroup": { - "target": "com.amazonaws.sms#SecurityGroup", + "instanceType": { + "target": "com.amazonaws.sms#InstanceType", + "traits": { + "smithy.api#documentation": "

    The instance type to use when launching the server.

    " + } + }, + "iamInstanceProfileName": { + "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    Identifier of the security group that applies to the launched server.

    " + "smithy.api#documentation": "

    The name of the IAM instance profile.

    " } }, "associatePublicIpAddress": { "target": "com.amazonaws.sms#AssociatePublicIpAddress", "traits": { - "smithy.api#documentation": "

    If true, a publicly accessible IP address is created when launching the server.

    " + "smithy.api#documentation": "

    Indicates whether a publicly accessible IP address is created when launching the server.

    " } }, "vpc": { "target": "com.amazonaws.sms#VPC", "traits": { - "smithy.api#documentation": "

    Identifier of the VPC the server should be launched into.

    " + "smithy.api#documentation": "

    The ID of the VPC into which the server should be launched.

    " } }, - "logicalId": { - "target": "com.amazonaws.sms#LogicalId", + "configureScriptType": { + "target": "com.amazonaws.sms#ScriptType", "traits": { - "smithy.api#documentation": "

    Logical ID of the server in the Amazon CloudFormation template.

    " + "smithy.api#documentation": "

    The type of configuration script.

    " } }, - "instanceType": { - "target": "com.amazonaws.sms#InstanceType", + "configureScript": { + "target": "com.amazonaws.sms#S3Location" + }, + "userData": { + "target": "com.amazonaws.sms#UserData", + "traits": { + "smithy.api#documentation": "

    Location of the user-data script to be executed when launching the server.

    " + } + }, + "ec2KeyName": { + "target": "com.amazonaws.sms#EC2KeyName", "traits": { - "smithy.api#documentation": "

    Instance type to be used for launching the server.

    " + "smithy.api#documentation": "

    The name of the Amazon EC2 SSH key to be used for connecting to the launched server.

    " } }, "subnet": { "target": "com.amazonaws.sms#Subnet", "traits": { - "smithy.api#documentation": "

    Identifier of the subnet the server should be launched into.

    " + "smithy.api#documentation": "

    The ID of the subnet the server should be launched into.

    " } }, - "server": { - "target": "com.amazonaws.sms#Server", + "securityGroup": { + "target": "com.amazonaws.sms#SecurityGroup", "traits": { - "smithy.api#documentation": "

    Identifier of the server the launch configuration is associated with.

    " + "smithy.api#documentation": "

    The ID of the security group that applies to the launched server.

    " } }, - "ec2KeyName": { - "target": "com.amazonaws.sms#EC2KeyName", + "logicalId": { + "target": "com.amazonaws.sms#LogicalId", "traits": { - "smithy.api#documentation": "

    Name of the EC2 SSH Key to be used for connecting to the launched server.

    " + "smithy.api#documentation": "

    The logical ID of the server in the AWS CloudFormation template.

    " } }, - "userData": { - "target": "com.amazonaws.sms#UserData", + "server": { + "target": "com.amazonaws.sms#Server", "traits": { - "smithy.api#documentation": "

    Location of the user-data script to be executed when launching the server.

    " + "smithy.api#documentation": "

    The ID of the server with which the launch configuration is associated.

    " } } }, @@ -2739,90 +3425,164 @@ "com.amazonaws.sms#ServerReplicationConfiguration": { "type": "structure", "members": { + "serverReplicationParameters": { + "target": "com.amazonaws.sms#ServerReplicationParameters", + "traits": { + "smithy.api#documentation": "

    The parameters for replicating the server.

    " + } + }, "server": { "target": "com.amazonaws.sms#Server", "traits": { - "smithy.api#documentation": "

    Identifier of the server this replication configuration is associated with.

    " + "smithy.api#documentation": "

    The ID of the server with which this replication configuration is\n associated.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Replication configuration of a server.

    " + } + }, + "com.amazonaws.sms#ServerReplicationConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sms#ServerReplicationConfiguration" + } + }, + "com.amazonaws.sms#ServerReplicationParameters": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.sms#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to the KMS key ID

      \n
      • \n
    • \n

      ARN referring to the KMS key alias

      \n
      • \n
    \n

    If encrypted is enabled but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

    " + } + }, + "encrypted": { + "target": "com.amazonaws.sms#Encrypted", + "traits": { + "smithy.api#documentation": "

    Indicates whether the replication job produces encrypted AMIs.

    " + } + }, + "licenseType": { + "target": "com.amazonaws.sms#LicenseType", + "traits": { + "smithy.api#documentation": "

    The license type for creating a replication job for the server.

    " + } + }, + "runOnce": { + "target": "com.amazonaws.sms#RunOnce", + "traits": { + "smithy.api#documentation": "

    Indicates whether to run the replication job one time.

    " + } + }, + "seedTime": { + "target": "com.amazonaws.sms#Timestamp", + "traits": { + "smithy.api#documentation": "

    The seed time for creating a replication job for the server.

    " + } + }, + "frequency": { + "target": "com.amazonaws.sms#Frequency", + "traits": { + "smithy.api#documentation": "

    The frequency of creating replication jobs for the server.

    " } }, - "serverReplicationParameters": { - "target": "com.amazonaws.sms#ServerReplicationParameters", + "numberOfRecentAmisToKeep": { + "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", "traits": { - "smithy.api#documentation": "

    Parameters for replicating the server.

    " + "smithy.api#documentation": "

    The number of recent AMIs to keep when creating a replication job for this server.

    " } } }, "traits": { - "smithy.api#documentation": "

    Replication configuration of a server.

    " + "smithy.api#documentation": "

    The replication parameters for replicating a server.

    " } }, - "com.amazonaws.sms#ServerReplicationConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerReplicationConfiguration" + "com.amazonaws.sms#ServerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VIRTUAL_MACHINE", + "name": "VirtualMachine" + } + ] } }, - "com.amazonaws.sms#ServerReplicationParameters": { + "com.amazonaws.sms#ServerValidationConfiguration": { "type": "structure", "members": { - "frequency": { - "target": "com.amazonaws.sms#Frequency", - "traits": { - "smithy.api#documentation": "

    Frequency of creating replication jobs for the server.

    " - } - }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", - "traits": { - "smithy.api#documentation": "

    \n

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the\n following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to KMS key ID

      \n
      • \n
    • \n

      ARN referring to KMS key alias

      \n
      • \n
    \n

    If encrypted is true but a KMS key id is not specified, the\n customer's default KMS key for EBS is used.

    " - } - }, - "runOnce": { - "target": "com.amazonaws.sms#RunOnce", + "validationId": { + "target": "com.amazonaws.sms#ValidationId", "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    The ID of the validation.

    " } }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", - "traits": { - "smithy.api#documentation": "

    Number of recent AMIs to keep when creating a replication job for this server.

    " - } + "server": { + "target": "com.amazonaws.sms#Server" }, - "licenseType": { - "target": "com.amazonaws.sms#LicenseType", + "serverValidationStrategy": { + "target": "com.amazonaws.sms#ServerValidationStrategy", "traits": { - "smithy.api#documentation": "

    License type for creating a replication job for the server.

    " + "smithy.api#documentation": "

    The validation strategy.

    " } }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", + "userDataValidationParameters": { + "target": "com.amazonaws.sms#UserDataValidationParameters", "traits": { - "smithy.api#documentation": "

    When true, the replication job produces encrypted AMIs. See also KmsKeyId\n below.

    " + "smithy.api#documentation": "

    The validation parameters.

    " } }, - "seedTime": { - "target": "com.amazonaws.sms#Timestamp", + "name": { + "target": "com.amazonaws.sms#NonEmptyStringWithMaxLen255", "traits": { - "smithy.api#documentation": "

    Seed time for creating a replication job for the server.

    " + "smithy.api#documentation": "

    The name of the configuration.

    " } } }, "traits": { - "smithy.api#documentation": "

    Replication parameters for replicating a server.

    " + "smithy.api#documentation": "

    Configuration for validating an instance.

    " } }, - "com.amazonaws.sms#ServerType": { + "com.amazonaws.sms#ServerValidationConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.sms#ServerValidationConfiguration" + } + }, + "com.amazonaws.sms#ServerValidationOutput": { + "type": "structure", + "members": { + "server": { + "target": "com.amazonaws.sms#Server" + } + }, + "traits": { + "smithy.api#documentation": "

    Contains output from validating an instance.

    " + } + }, + "com.amazonaws.sms#ServerValidationStrategy": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "VIRTUAL_MACHINE", - "name": "VirtualMachine" + "value": "USERDATA", + "name": "USERDATA" } ] } }, + "com.amazonaws.sms#Source": { + "type": "structure", + "members": { + "s3Location": { + "target": "com.amazonaws.sms#S3Location" + } + }, + "traits": { + "smithy.api#documentation": "

    Contains the location of a validation script.

    " + } + }, "com.amazonaws.sms#StackId": { "type": "string" }, @@ -2855,7 +3615,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts replicating an application.

    " + "smithy.api#documentation": "

    Starts replicating the specified application by creating replication jobs for each server in the\n application.

    " } }, "com.amazonaws.sms#StartAppReplicationRequest": { @@ -2864,7 +3624,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application to replicate.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -2873,6 +3633,57 @@ "type": "structure", "members": {} }, + "com.amazonaws.sms#StartOnDemandAppReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.sms#StartOnDemandAppReplicationRequest" + }, + "output": { + "target": "com.amazonaws.sms#StartOnDemandAppReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sms#InternalError" + }, + { + "target": "com.amazonaws.sms#InvalidParameterException" + }, + { + "target": "com.amazonaws.sms#MissingRequiredParameterException" + }, + { + "target": "com.amazonaws.sms#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.sms#UnauthorizedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Starts an on-demand replication run for the specified application.

    " + } + }, + "com.amazonaws.sms#StartOnDemandAppReplicationRequest": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.sms#AppId", + "traits": { + "smithy.api#documentation": "

    The ID of the application.

    ", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.sms#Description", + "traits": { + "smithy.api#documentation": "

    The description of the replication run.

    " + } + } + } + }, + "com.amazonaws.sms#StartOnDemandAppReplicationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.sms#StartOnDemandReplicationRun": { "type": "operation", "input": { @@ -2882,6 +3693,9 @@ "target": "com.amazonaws.sms#StartOnDemandReplicationRunResponse" }, "errors": [ + { + "target": "com.amazonaws.sms#DryRunOperationException" + }, { "target": "com.amazonaws.sms#InvalidParameterException" }, @@ -2899,7 +3713,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts an on-demand replication run for the specified replication job. This\n replication run starts immediately. This replication run is in addition to the ones\n already scheduled.

    \n

    There is a limit on the number of on-demand replications runs you can request in a\n 24-hour period.

    " + "smithy.api#documentation": "

    Starts an on-demand replication run for the specified replication job. This\n replication run starts immediately. This replication run is in addition to the ones\n already scheduled.

    \n

    There is a limit on the number of on-demand replications runs that you can request\n in a 24-hour period.

    " } }, "com.amazonaws.sms#StartOnDemandReplicationRunRequest": { @@ -2908,7 +3722,7 @@ "replicationJobId": { "target": "com.amazonaws.sms#ReplicationJobId", "traits": { - "smithy.api#documentation": "

    The identifier of the replication job.

    ", + "smithy.api#documentation": "

    The ID of the replication job.

    ", "smithy.api#required": {} } }, @@ -2926,7 +3740,7 @@ "replicationRunId": { "target": "com.amazonaws.sms#ReplicationRunId", "traits": { - "smithy.api#documentation": "

    The identifier of the replication run.

    " + "smithy.api#documentation": "

    The ID of the replication run.

    " } } } @@ -2957,7 +3771,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Stops replicating an application.

    " + "smithy.api#documentation": "

    Stops replicating the specified application by deleting the replication job for each server in\n the application.

    " } }, "com.amazonaws.sms#StopAppReplicationRequest": { @@ -2966,7 +3780,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application to stop replicating.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -2981,21 +3795,21 @@ "com.amazonaws.sms#Tag": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.sms#TagKey", + "value": { + "target": "com.amazonaws.sms#TagValue", "traits": { - "smithy.api#documentation": "

    Tag key.

    " + "smithy.api#documentation": "

    The tag value.

    " } }, - "value": { - "target": "com.amazonaws.sms#TagValue", + "key": { + "target": "com.amazonaws.sms#TagKey", "traits": { - "smithy.api#documentation": "

    Tag value.

    " + "smithy.api#documentation": "

    The tag key.

    " } } }, "traits": { - "smithy.api#documentation": "

    A label that can be assigned to an application.

    " + "smithy.api#documentation": "

    Key/value pair that can be assigned to an application.

    " } }, "com.amazonaws.sms#TagKey": { @@ -3045,7 +3859,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Terminates the stack for an application.

    " + "smithy.api#documentation": "

    Terminates the stack for the specified application.

    " } }, "com.amazonaws.sms#TerminateAppRequest": { @@ -3054,7 +3868,7 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    ID of the application to terminate.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -3086,7 +3900,7 @@ } }, "traits": { - "smithy.api#documentation": "

    You lack permissions needed to perform this operation. Check your IAM policies, and\n ensure that you are using the correct access keys.

    ", + "smithy.api#documentation": "

    You lack permissions needed to perform this operation. Check your IAM policies,\n and ensure that you are using the correct access keys.

    ", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -3117,46 +3931,46 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an application.

    " + "smithy.api#documentation": "

    Updates the specified application.

    " } }, "com.amazonaws.sms#UpdateAppRequest": { "type": "structure", "members": { - "roleName": { - "target": "com.amazonaws.sms#RoleName", + "description": { + "target": "com.amazonaws.sms#AppDescription", "traits": { - "smithy.api#documentation": "

    Name of the service role in the customer's account used by AWS SMS.

    " + "smithy.api#documentation": "

    The new description of the application.

    " } }, "name": { "target": "com.amazonaws.sms#AppName", "traits": { - "smithy.api#documentation": "

    New name of the application.

    " + "smithy.api#documentation": "

    The new name of the application.

    " } }, - "appId": { - "target": "com.amazonaws.sms#AppId", + "roleName": { + "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

    ID of the application to update.

    " + "smithy.api#documentation": "

    The name of the service role in the customer's account used by AWS SMS.

    " } }, - "serverGroups": { - "target": "com.amazonaws.sms#ServerGroups", + "tags": { + "target": "com.amazonaws.sms#Tags", "traits": { - "smithy.api#documentation": "

    List of server groups in the application to update.

    " + "smithy.api#documentation": "

    The tags to associate with the application.

    " } }, - "tags": { - "target": "com.amazonaws.sms#Tags", + "serverGroups": { + "target": "com.amazonaws.sms#ServerGroups", "traits": { - "smithy.api#documentation": "

    List of tags to associate with the application.

    " + "smithy.api#documentation": "

    The server groups in the application to update.

    " } }, - "description": { - "target": "com.amazonaws.sms#AppDescription", + "appId": { + "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

    New description of the application.

    " + "smithy.api#documentation": "

    The ID of the application.

    " } } } @@ -3167,19 +3981,19 @@ "appSummary": { "target": "com.amazonaws.sms#AppSummary", "traits": { - "smithy.api#documentation": "

    Summary description of the application.

    " + "smithy.api#documentation": "

    A summary description of the application.

    " } }, "tags": { "target": "com.amazonaws.sms#Tags", "traits": { - "smithy.api#documentation": "

    List of tags associated with the application.

    " + "smithy.api#documentation": "

    The tags associated with the application.

    " } }, "serverGroups": { "target": "com.amazonaws.sms#ServerGroups", "traits": { - "smithy.api#documentation": "

    List of updated server groups in the application.

    " + "smithy.api#documentation": "

    The updated server groups in the application.

    " } } } @@ -3225,10 +4039,10 @@ "com.amazonaws.sms#UpdateReplicationJobRequest": { "type": "structure", "members": { - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", + "numberOfRecentAmisToKeep": { + "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", "traits": { - "smithy.api#documentation": "

    When true, the replication job produces encrypted AMIs . See also\n KmsKeyId below.

    " + "smithy.api#documentation": "

    The maximum number of SMS-created AMIs to retain. The oldest is deleted after the\n maximum number is reached and a new AMI is created.

    " } }, "licenseType": { @@ -3237,10 +4051,10 @@ "smithy.api#documentation": "

    The license type to be used for the AMI created by a successful replication\n run.

    " } }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", + "kmsKeyId": { + "target": "com.amazonaws.sms#KmsKeyId", "traits": { - "smithy.api#documentation": "

    The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the\n maximum number is reached and a new AMI is created.

    " + "smithy.api#documentation": "

    The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to the KMS key ID

      \n
      • \n
    • \n

      ARN referring to the KMS key alias

      \n
      • \n
    \n

    If encrypted is enabled but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

    " } }, "nextReplicationRunStartTime": { @@ -3249,12 +4063,6 @@ "smithy.api#documentation": "

    The start time of the next replication run.

    " } }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", - "traits": { - "smithy.api#documentation": "

    \n

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the\n following:

    \n
      \n
    • \n

      KMS key ID

      \n
      • \n
    • \n

      KMS key alias

      \n
      • \n
    • \n

      ARN referring to KMS key ID

      \n
      • \n
    • \n

      ARN referring to KMS key alias

      \n
      • \n
    \n

    If encrypted is true but a KMS key id is not specified, the\n customer's default KMS key for EBS is used.

    " - } - }, "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { @@ -3270,10 +4078,16 @@ "replicationJobId": { "target": "com.amazonaws.sms#ReplicationJobId", "traits": { - "smithy.api#documentation": "

    The identifier of the replication job.

    ", + "smithy.api#documentation": "

    The ID of the replication job.

    ", "smithy.api#required": {} } }, + "encrypted": { + "target": "com.amazonaws.sms#Encrypted", + "traits": { + "smithy.api#documentation": "

    When true, the replication job produces encrypted AMIs. For more information,\n KmsKeyId.

    " + } + }, "description": { "target": "com.amazonaws.sms#Description", "traits": { @@ -3300,9 +4114,127 @@ "smithy.api#documentation": "

    A script that runs on first launch of an Amazon EC2 instance. Used for configuring the\n server during launch.

    " } }, + "com.amazonaws.sms#UserDataValidationParameters": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.sms#Source", + "traits": { + "smithy.api#documentation": "

    The location of the validation script.

    " + } + }, + "scriptType": { + "target": "com.amazonaws.sms#ScriptType", + "traits": { + "smithy.api#documentation": "

    The type of validation script.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains validation parameters.

    " + } + }, "com.amazonaws.sms#VPC": { "type": "string" }, + "com.amazonaws.sms#ValidationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^val-[0-9a-f]{17}$" + } + }, + "com.amazonaws.sms#ValidationOutput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.sms#NonEmptyStringWithMaxLen255", + "traits": { + "smithy.api#documentation": "

    The name of the validation.

    " + } + }, + "status": { + "target": "com.amazonaws.sms#ValidationStatus", + "traits": { + "smithy.api#documentation": "

    The status of the validation.

    " + } + }, + "appValidationOutput": { + "target": "com.amazonaws.sms#AppValidationOutput", + "traits": { + "smithy.api#documentation": "

    The output from validating an application.

    " + } + }, + "validationId": { + "target": "com.amazonaws.sms#ValidationId", + "traits": { + "smithy.api#documentation": "

    The ID of the validation.

    " + } + }, + "latestValidationTime": { + "target": "com.amazonaws.sms#Timestamp", + "traits": { + "smithy.api#documentation": "

    The latest time that the validation was performed.

    " + } + }, + "statusMessage": { + "target": "com.amazonaws.sms#ValidationStatusMessage", + "traits": { + "smithy.api#documentation": "

    The status message.

    " + } + }, + "serverValidationOutput": { + "target": "com.amazonaws.sms#ServerValidationOutput", + "traits": { + "smithy.api#documentation": "

    The output from validation an instance.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains validation output.

    " + } + }, + "com.amazonaws.sms#ValidationOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.sms#ValidationOutput" + } + }, + "com.amazonaws.sms#ValidationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "READY_FOR_VALIDATION", + "name": "ReadyForValidation" + }, + { + "value": "PENDING", + "name": "Pending" + }, + { + "value": "IN_PROGRESS", + "name": "InProgress" + }, + { + "value": "SUCCEEDED", + "name": "Succeeded" + }, + { + "value": "FAILED", + "name": "Failed" + } + ] + } + }, + "com.amazonaws.sms#ValidationStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2500 + } + } + }, "com.amazonaws.sms#VmId": { "type": "string" }, @@ -3352,6 +4284,12 @@ "smithy.api#documentation": "

    The name of the VM manager.

    " } }, + "vmManagerType": { + "target": "com.amazonaws.sms#VmManagerType", + "traits": { + "smithy.api#documentation": "

    The type of VM management product.

    " + } + }, "vmName": { "target": "com.amazonaws.sms#VmName", "traits": { @@ -3361,13 +4299,7 @@ "vmServerAddress": { "target": "com.amazonaws.sms#VmServerAddress", "traits": { - "smithy.api#documentation": "

    Information about the VM server location.

    " - } - }, - "vmManagerType": { - "target": "com.amazonaws.sms#VmManagerType", - "traits": { - "smithy.api#documentation": "

    The type of VM management product.

    " + "smithy.api#documentation": "

    The VM server location.

    " } } }, @@ -3378,16 +4310,16 @@ "com.amazonaws.sms#VmServerAddress": { "type": "structure", "members": { - "vmManagerId": { - "target": "com.amazonaws.sms#VmManagerId", + "vmId": { + "target": "com.amazonaws.sms#VmId", "traits": { - "smithy.api#documentation": "

    The identifier of the VM manager.

    " + "smithy.api#documentation": "

    The ID of the VM.

    " } }, - "vmId": { - "target": "com.amazonaws.sms#VmId", + "vmManagerId": { + "target": "com.amazonaws.sms#VmManagerId", "traits": { - "smithy.api#documentation": "

    The identifier of the VM.

    " + "smithy.api#documentation": "

    The ID of the VM manager.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json b/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json index 54cb5814382e..a81209cdcc82 100644 --- a/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json +++ b/codegen/sdk-codegen/aws-models/snowball.2016-06-30.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.snowball#CreateJob" }, + { + "target": "com.amazonaws.snowball#CreateReturnShippingLabel" + }, { "target": "com.amazonaws.snowball#DescribeAddress" }, @@ -60,6 +63,9 @@ { "target": "com.amazonaws.snowball#DescribeJob" }, + { + "target": "com.amazonaws.snowball#DescribeReturnShippingLabel" + }, { "target": "com.amazonaws.snowball#GetJobManifest" }, @@ -89,6 +95,9 @@ }, { "target": "com.amazonaws.snowball#UpdateJob" + }, + { + "target": "com.amazonaws.snowball#UpdateJobShipmentState" } ], "traits": { @@ -102,100 +111,100 @@ "name": "snowball" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

    AWS Snowball is a petabyte-scale data transport solution that uses secure devices to\n transfer large amounts of data between your on-premises data centers and Amazon Simple Storage\n Service (Amazon S3). The Snowball commands described here provide access to the same\n functionality that is available in the AWS Snowball Management Console, which enables you to\n create and manage jobs for Snowball. To transfer data locally with a Snowball device, you'll\n need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more\n information, see the User Guide.

    ", + "smithy.api#documentation": "

    AWS Snow Family is a petabyte-scale data transport solution that uses secure devices to\n transfer large amounts of data between your on-premises data centers and Amazon Simple Storage\n Service (Amazon S3). The Snow commands described here provide access to the same\n functionality that is available in the AWS Snow Family Management Console, which enables you to\n create and manage jobs for a Snow device. To transfer data locally with a Snow device, you'll\n need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or AWS OpsHub for Snow Family. For more\n information, see the User Guide.

    ", "smithy.api#title": "Amazon Import/Export Snowball" } }, "com.amazonaws.snowball#Address": { "type": "structure", "members": { - "Street2": { + "PhoneNumber": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The second line in a street address that a Snowball is to be delivered\n to.

    " + "smithy.api#documentation": "

    The phone number associated with an address that a Snow device is to be delivered\n to.

    " } }, - "Street3": { + "Company": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The third line in a street address that a Snowball is to be delivered\n to.

    " + "smithy.api#documentation": "

    The name of the company to receive a Snow device at an address.

    " } }, - "Country": { - "target": "com.amazonaws.snowball#String", + "AddressId": { + "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

    The country in an address that a Snowball is to be delivered to.

    " + "smithy.api#documentation": "

    The unique ID for an address.

    " } }, - "Street1": { - "target": "com.amazonaws.snowball#String", + "IsRestricted": { + "target": "com.amazonaws.snowball#Boolean", "traits": { - "smithy.api#documentation": "

    The first line in a street address that a Snowball is to be delivered\n to.

    " + "smithy.api#documentation": "

    If the address you are creating is a primary address, then set this option to\n true. This field is not supported in most regions.

    " } }, - "StateOrProvince": { + "PrefectureOrDistrict": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The state or province in an address that a Snowball is to be delivered to.

    " + "smithy.api#documentation": "

    This field is no longer used and the value is ignored.

    " } }, - "PrefectureOrDistrict": { + "Street2": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    This field is no longer used and the value is ignored.

    " + "smithy.api#documentation": "

    The second line in a street address that a Snow device is to be delivered\n to.

    " } }, - "IsRestricted": { - "target": "com.amazonaws.snowball#Boolean", + "Street3": { + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    If the address you are creating is a primary address, then set this option to\n true. This field is not supported in most regions.

    " + "smithy.api#documentation": "

    The third line in a street address that a Snow device is to be delivered\n to.

    " } }, - "PostalCode": { + "Street1": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The postal code in an address that a Snowball is to be delivered to.

    " + "smithy.api#documentation": "

    The first line in a street address that a Snow device is to be delivered\n to.

    " } }, - "City": { + "PostalCode": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The city in an address that a Snowball is to be delivered to.

    " + "smithy.api#documentation": "

    The postal code in an address that a Snow device is to be delivered to.

    " } }, - "Landmark": { + "Country": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    This field is no longer used and the value is ignored.

    " + "smithy.api#documentation": "

    The country in an address that a Snow device is to be delivered to.

    " } }, - "Name": { + "StateOrProvince": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The name of a person to receive a Snowball at an address.

    " + "smithy.api#documentation": "

    The state or province in an address that a Snow device is to be delivered to.

    " } }, - "Company": { + "Landmark": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The name of the company to receive a Snowball at an address.

    " + "smithy.api#documentation": "

    This field is no longer used and the value is ignored.

    " } }, - "PhoneNumber": { + "City": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The phone number associated with an address that a Snowball is to be delivered\n to.

    " + "smithy.api#documentation": "

    The city in an address that a Snow device is to be delivered to.

    " } }, - "AddressId": { - "target": "com.amazonaws.snowball#AddressId", + "Name": { + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The unique ID for an address.

    " + "smithy.api#documentation": "

    The name of a person to receive a Snow device at an address.

    " } } }, "traits": { - "smithy.api#documentation": "

    The address that you want the Snowball or Snowballs associated with a specific job to\n be shipped to. Addresses are validated at the time of creation. The address you provide must\n be located within the serviceable area of your region. Although no individual elements of the\n Address are required, if the address is invalid or unsupported, then an\n exception is thrown.

    " + "smithy.api#documentation": "

    The address that you want the Snow device(s) associated with a specific job to\n be shipped to. Addresses are validated at the time of creation. The address you provide must\n be located within the serviceable area of your region. Although no individual elements of the\n Address are required, if the address is invalid or unsupported, then an\n exception is thrown.

    " } }, "com.amazonaws.snowball#AddressId": { @@ -330,12 +339,6 @@ "com.amazonaws.snowball#ClusterListEntry": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.snowball#String", - "traits": { - "smithy.api#documentation": "

    Defines an optional description of the cluster, for example Environmental Data\n Cluster-01.

    " - } - }, "ClusterId": { "target": "com.amazonaws.snowball#String", "traits": { @@ -348,6 +351,12 @@ "smithy.api#documentation": "

    The creation date for this cluster.

    " } }, + "Description": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "

    Defines an optional description of the cluster, for example Environmental Data\n Cluster-01.

    " + } + }, "ClusterState": { "target": "com.amazonaws.snowball#ClusterState", "traits": { @@ -368,58 +377,52 @@ "com.amazonaws.snowball#ClusterMetadata": { "type": "structure", "members": { - "Notification": { - "target": "com.amazonaws.snowball#Notification", - "traits": { - "smithy.api#documentation": "

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this\n cluster.

    " - } - }, - "Resources": { - "target": "com.amazonaws.snowball#JobResource", + "JobType": { + "target": "com.amazonaws.snowball#JobType", "traits": { - "smithy.api#documentation": "

    The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

    " + "smithy.api#documentation": "

    The type of job for this cluster. Currently, the only job type supported for clusters\n is LOCAL_USE.

    " } }, - "ClusterState": { - "target": "com.amazonaws.snowball#ClusterState", + "KmsKeyARN": { + "target": "com.amazonaws.snowball#KmsKeyARN", "traits": { - "smithy.api#documentation": "

    The current status of the cluster.

    " + "smithy.api#documentation": "

    The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster.\n This ARN was created using the CreateKey API action in AWS Key\n Management Service (AWS KMS).

    " } }, - "AddressId": { - "target": "com.amazonaws.snowball#AddressId", + "RoleARN": { + "target": "com.amazonaws.snowball#RoleARN", "traits": { - "smithy.api#documentation": "

    The automatically generated ID for a specific address.

    " + "smithy.api#documentation": "

    The role ARN associated with this cluster. This ARN was created using the CreateRole\n API action in AWS Identity and Access Management (IAM).

    " } }, - "ClusterId": { - "target": "com.amazonaws.snowball#String", + "ShippingOption": { + "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

    The automatically generated ID for a cluster.

    " + "smithy.api#documentation": "

    The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:

    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries\n in the EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snow devices are delivered in one to seven days.

      \n
      • \n
    • \n

      In the US, you have access to one-day shipping and two-day shipping.

      \n
      • \n
    " } }, - "JobType": { - "target": "com.amazonaws.snowball#JobType", + "ForwardingAddressId": { + "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

    The type of job for this cluster. Currently, the only job type supported for clusters\n is LOCAL_USE.

    " + "smithy.api#documentation": "

    The ID of the address that you want a cluster shipped to, after it will be\n shipped to its primary address. This field is not supported in most regions.

    " } }, - "KmsKeyARN": { - "target": "com.amazonaws.snowball#KmsKeyARN", + "SnowballType": { + "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "

    The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster.\n This ARN was created using the CreateKey API action in AWS Key\n Management Service (AWS KMS).

    " + "smithy.api#documentation": "

    The type of AWS Snow device to use for this cluster. \n

    \n \n

    For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

    \n     " } }, - "Description": { - "target": "com.amazonaws.snowball#String", + "CreationDate": { + "target": "com.amazonaws.snowball#Timestamp", "traits": { - "smithy.api#documentation": "

    The optional description of the cluster.

    " + "smithy.api#documentation": "

    The creation date for this cluster.

    " } }, - "RoleARN": { - "target": "com.amazonaws.snowball#RoleARN", + "Notification": { + "target": "com.amazonaws.snowball#Notification", "traits": { - "smithy.api#documentation": "

    The role ARN associated with this cluster. This ARN was created using the CreateRole\n API action in AWS Identity and Access Management (IAM).

    " + "smithy.api#documentation": "

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this\n cluster.

    " } }, "TaxDocuments": { @@ -428,28 +431,34 @@ "smithy.api#documentation": "

    The tax documents required in your AWS Region.

    " } }, - "CreationDate": { - "target": "com.amazonaws.snowball#Timestamp", + "Description": { + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The creation date for this cluster.

    " + "smithy.api#documentation": "

    The optional description of the cluster.

    " } }, - "ForwardingAddressId": { + "ClusterState": { + "target": "com.amazonaws.snowball#ClusterState", + "traits": { + "smithy.api#documentation": "

    The current status of the cluster.

    " + } + }, + "AddressId": { "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

    The ID of the address that you want a cluster shipped to, after it will be\n shipped to its primary address. This field is not supported in most regions.

    " + "smithy.api#documentation": "

    The automatically generated ID for a specific address.

    " } }, - "ShippingOption": { - "target": "com.amazonaws.snowball#ShippingOption", + "ClusterId": { + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each Snowball Edge device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:

    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snowball Edges shipped express are delivered in about a day. In addition, most countries\n in the EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snowball Edges are delivered in one to seven days.

      \n
      • \n
    • \n

      In the US, you have access to one-day shipping and two-day shipping.

      \n
      • \n
    " + "smithy.api#documentation": "

    The automatically generated ID for a cluster.

    " } }, - "SnowballType": { - "target": "com.amazonaws.snowball#SnowballType", + "Resources": { + "target": "com.amazonaws.snowball#JobResource", "traits": { - "smithy.api#documentation": "

    The type of AWS Snowball device to use for this cluster. \n

    \n \n

    For cluster jobs, AWS Snowball currently supports only the EDGE device type.

    \n     " + "smithy.api#documentation": "

    The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

    " } } }, @@ -496,12 +505,12 @@ "AmiId": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for an individual Snowball Edge AMI.

    " + "smithy.api#documentation": "

    The unique identifier for an individual Snow device AMI.

    " } } }, "traits": { - "smithy.api#documentation": "

    A JSON-formatted object that describes a compatible Amazon Machine Image (AMI),\n including the ID and name for a Snowball Edge AMI. This AMI is compatible with the device's\n physical hardware requirements, and it should be able to be run in an SBE1 instance on the\n device.

    " + "smithy.api#documentation": "

    A JSON-formatted object that describes a compatible Amazon Machine Image (AMI),\n including the ID and name for a Snow device AMI. This AMI is compatible with the device's\n physical hardware requirements, and it should be able to be run in an SBE1 instance on the\n device.

    " } }, "com.amazonaws.snowball#CompatibleImageList": { @@ -510,6 +519,21 @@ "target": "com.amazonaws.snowball#CompatibleImage" } }, + "com.amazonaws.snowball#ConflictException": { + "type": "structure", + "members": { + "ConflictResource": { + "target": "com.amazonaws.snowball#String" + }, + "Message": { + "target": "com.amazonaws.snowball#String" + } + }, + "traits": { + "smithy.api#documentation": "

    You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.

    ", + "smithy.api#error": "client" + } + }, "com.amazonaws.snowball#CreateAddress": { "type": "operation", "input": { @@ -527,7 +551,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an address for a Snowball to be shipped to. In most regions,\n addresses are validated at the time of creation. The address you provide must be located\n within the serviceable area of your region. If the address is invalid or unsupported, then an\n exception is thrown.

    " + "smithy.api#documentation": "

    Creates an address for a Snow device to be shipped to. In most regions,\n addresses are validated at the time of creation. The address you provide must be located\n within the serviceable area of your region. If the address is invalid or unsupported, then an\n exception is thrown.

    " } }, "com.amazonaws.snowball#CreateAddressRequest": { @@ -536,7 +560,7 @@ "Address": { "target": "com.amazonaws.snowball#Address", "traits": { - "smithy.api#documentation": "

    The address that you want the Snowball shipped to.

    ", + "smithy.api#documentation": "

    The address that you want the Snow device shipped to.

    ", "smithy.api#required": {} } } @@ -548,7 +572,7 @@ "AddressId": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The automatically generated ID for a specific address. You'll use this ID when you\n create a job to specify which address you want the Snowball for that job shipped to.

    " + "smithy.api#documentation": "

    The automatically generated ID for a specific address. You'll use this ID when you\n create a job to specify which address you want the Snow device for that job shipped to.

    " } } } @@ -589,12 +613,6 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.snowball#String", - "traits": { - "smithy.api#documentation": "

    An optional description of this specific cluster, for example Environmental Data\n Cluster-01.

    " - } - }, "RoleARN": { "target": "com.amazonaws.snowball#RoleARN", "traits": { @@ -602,35 +620,37 @@ "smithy.api#required": {} } }, - "TaxDocuments": { - "target": "com.amazonaws.snowball#TaxDocuments", - "traits": { - "smithy.api#documentation": "

    The tax documents required in your AWS Region.

    " - } - }, - "ForwardingAddressId": { - "target": "com.amazonaws.snowball#AddressId", + "Resources": { + "target": "com.amazonaws.snowball#JobResource", "traits": { - "smithy.api#documentation": "

    The forwarding address ID for a cluster. This field is not supported in most\n regions.

    " + "smithy.api#documentation": "

    The resources associated with the cluster job. These resources include Amazon S3\n buckets and optional AWS Lambda functions written in the Python language.

    ", + "smithy.api#required": {} } }, "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

    The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each Snowball Edge device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:\n

    \n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, Snowballs shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snowballs shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snowballs are delivered in one to seven days.

      \n
      • \n
    • \n

      In the United States of America (US), you have access to one-day shipping and\n two-day shipping.

      \n
      • \n
    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snowball Edges shipped express are delivered in about a day. In addition, most countries\n in the EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snowball Edges are delivered in one to seven days.

      \n
      • \n
    • \n

      In the US, you have access to one-day shipping and two-day shipping.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each Snowball Edge device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:\n

    \n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snow device are delivered in one to seven days.

      \n
      • \n
    • \n

      In the United States of America (US), you have access to one-day shipping and\n two-day shipping.

      \n
      • \n
    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, devices shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries\n in the EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snow device are delivered in one to seven days.

      \n
      • \n
    • \n

      In the US, you have access to one-day shipping and two-day shipping.

      \n
      • \n
    ", "smithy.api#required": {} } }, + "ForwardingAddressId": { + "target": "com.amazonaws.snowball#AddressId", + "traits": { + "smithy.api#documentation": "

    The forwarding address ID for a cluster. This field is not supported in most\n regions.

    " + } + }, "SnowballType": { "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "

    The type of AWS Snowball device to use for this cluster. \n \n

    \n \n

    For cluster jobs, AWS Snowball currently supports only the EDGE device type.

    \n     " + "smithy.api#documentation": "

    The type of AWS Snow Family device to use for this cluster. \n \n

    \n \n

    For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

    \n     " } }, - "Notification": { - "target": "com.amazonaws.snowball#Notification", + "JobType": { + "target": "com.amazonaws.snowball#JobType", "traits": { - "smithy.api#documentation": "

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this\n cluster.

    " + "smithy.api#documentation": "

    The type of job for this cluster. Currently, the only job type supported for clusters\n is LOCAL_USE.

    ", + "smithy.api#required": {} } }, "KmsKeyARN": { @@ -639,18 +659,22 @@ "smithy.api#documentation": "

    The KmsKeyARN value that you want to associate with this cluster.\n KmsKeyARN values are created by using the CreateKey API action in AWS Key\n Management Service (AWS KMS).

    " } }, - "JobType": { - "target": "com.amazonaws.snowball#JobType", + "Notification": { + "target": "com.amazonaws.snowball#Notification", "traits": { - "smithy.api#documentation": "

    The type of job for this cluster. Currently, the only job type supported for clusters\n is LOCAL_USE.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this\n cluster.

    " } }, - "Resources": { - "target": "com.amazonaws.snowball#JobResource", + "TaxDocuments": { + "target": "com.amazonaws.snowball#TaxDocuments", "traits": { - "smithy.api#documentation": "

    The resources associated with the cluster job. These resources include Amazon S3\n buckets and optional AWS Lambda functions written in the Python language.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The tax documents required in your AWS Region.

    " + } + }, + "Description": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "

    An optional description of this specific cluster, for example Environmental Data\n Cluster-01.

    " } } } @@ -692,58 +716,58 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a job to import or export data between Amazon S3 and your on-premises data\n center. Your AWS account must have the right trust policies and permissions in place to create\n a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide\n the clusterId value; the other job attributes are inherited from the cluster.\n

    " + "smithy.api#documentation": "

    Creates a job to import or export data between Amazon S3 and your on-premises data\n center. Your AWS account must have the right trust policies and permissions in place to create\n a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide\n the clusterId value; the other job attributes are inherited from the cluster.\n

    " } }, "com.amazonaws.snowball#CreateJobRequest": { "type": "structure", "members": { - "ShippingOption": { - "target": "com.amazonaws.snowball#ShippingOption", + "RoleARN": { + "target": "com.amazonaws.snowball#RoleARN", "traits": { - "smithy.api#documentation": "

    The shipping speed for this job. This speed doesn't dictate how soon you'll get the\n Snowball, rather it represents how quickly the Snowball moves to its destination while in\n transit. Regional shipping speeds are as follows:

    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, Snowballs shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snowballs shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snowballs are delivered in one to seven days.

      \n
      • \n
    • \n

      In the US, you have access to one-day shipping and two-day shipping.

      \n
      • \n
    " + "smithy.api#documentation": "

    The RoleARN that you want to associate with this job.\n RoleArns are created using the CreateRole AWS Identity and\n Access Management (IAM) API action.

    " } }, - "ForwardingAddressId": { + "AddressId": { "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

    The forwarding address ID for a job. This field is not supported in most\n regions.

    " + "smithy.api#documentation": "

    The ID for the address that you want the Snow device shipped to.

    " } }, - "SnowballCapacityPreference": { - "target": "com.amazonaws.snowball#SnowballCapacity", + "TaxDocuments": { + "target": "com.amazonaws.snowball#TaxDocuments", "traits": { - "smithy.api#documentation": "

    If your job is being created in one of the US regions, you have the option of\n specifying what size Snowball you'd like for this job. In all other regions, Snowballs come\n with 80 TB in storage capacity.

    " + "smithy.api#documentation": "

    The tax documents required in your AWS Region.

    " } }, - "KmsKeyARN": { - "target": "com.amazonaws.snowball#KmsKeyARN", + "Description": { + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The KmsKeyARN that you want to associate with this job.\n KmsKeyARNs are created using the CreateKey AWS Key Management\n Service (KMS) API action.

    " + "smithy.api#documentation": "

    Defines an optional description of this specific job, for example Important\n Photos 2016-08-11.

    " } }, - "JobType": { - "target": "com.amazonaws.snowball#JobType", + "SnowballType": { + "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "

    Defines the type of job that you're creating.\n

    " + "smithy.api#documentation": "

    The type of AWS Snow Family device to use for this job. \n

    \n \n

    For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

    \n     \n

    The type of AWS Snow device to use for this job. Currently, the only supported\n device type for cluster jobs is EDGE.

    \n

    For more information, see Snowball Edge Device\n Options in the Snowball Edge Developer Guide.

    " } }, - "RoleARN": { - "target": "com.amazonaws.snowball#RoleARN", + "ClusterId": { + "target": "com.amazonaws.snowball#ClusterId", "traits": { - "smithy.api#documentation": "

    The RoleARN that you want to associate with this job.\n RoleArns are created using the CreateRole AWS Identity and\n Access Management (IAM) API action.

    " + "smithy.api#documentation": "

    The ID of a cluster. If you're creating a job for a node in a cluster, you need to\n provide only this clusterId value. The other job attributes are inherited from\n the cluster.

    " } }, - "Notification": { - "target": "com.amazonaws.snowball#Notification", + "JobType": { + "target": "com.amazonaws.snowball#JobType", "traits": { - "smithy.api#documentation": "

    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for\n this job.

    " + "smithy.api#documentation": "

    Defines the type of job that you're creating.\n

    " } }, - "TaxDocuments": { - "target": "com.amazonaws.snowball#TaxDocuments", + "Resources": { + "target": "com.amazonaws.snowball#JobResource", "traits": { - "smithy.api#documentation": "

    The tax documents required in your AWS Region.

    " + "smithy.api#documentation": "

    Defines the Amazon S3 buckets associated with this job.

    \n\n

    With IMPORT jobs, you specify the bucket or buckets that your transferred\n data will be imported into.

    \n\n

    With EXPORT jobs, you specify the bucket or buckets that your transferred\n data will be exported from. Optionally, you can also specify a KeyRange value. If\n you choose to export a range, you define the length of the range by providing either an\n inclusive BeginMarker value, an inclusive EndMarker value, or both.\n Ranges are UTF-8 binary sorted.

    " } }, "DeviceConfiguration": { @@ -752,34 +776,34 @@ "smithy.api#documentation": "

    Defines the device configuration for an AWS Snowcone job.

    " } }, - "SnowballType": { - "target": "com.amazonaws.snowball#SnowballType", + "SnowballCapacityPreference": { + "target": "com.amazonaws.snowball#SnowballCapacity", "traits": { - "smithy.api#documentation": "

    The type of AWS Snowball device to use for this job. \n

    \n \n

    For cluster jobs, AWS Snowball currently supports only the EDGE device type.

    \n     \n

    The type of AWS Snowball device to use for this job. Currently, the only supported\n device type for cluster jobs is EDGE.

    \n

    For more information, see Snowball Edge Device\n Options in the Snowball Edge Developer Guide.

    " + "smithy.api#documentation": "

    If your job is being created in one of the US regions, you have the option of\n specifying what size Snow device you'd like for this job. In all other regions, Snowballs come\n with 80 TB in storage capacity.

    " } }, - "Description": { - "target": "com.amazonaws.snowball#String", + "ForwardingAddressId": { + "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

    Defines an optional description of this specific job, for example Important\n Photos 2016-08-11.

    " + "smithy.api#documentation": "

    The forwarding address ID for a job. This field is not supported in most\n regions.

    " } }, - "Resources": { - "target": "com.amazonaws.snowball#JobResource", + "ShippingOption": { + "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

    Defines the Amazon S3 buckets associated with this job.

    \n\n

    With IMPORT jobs, you specify the bucket or buckets that your transferred\n data will be imported into.

    \n\n

    With EXPORT jobs, you specify the bucket or buckets that your transferred\n data will be exported from. Optionally, you can also specify a KeyRange value. If\n you choose to export a range, you define the length of the range by providing either an\n inclusive BeginMarker value, an inclusive EndMarker value, or both.\n Ranges are UTF-8 binary sorted.

    " + "smithy.api#documentation": "

    The shipping speed for this job. This speed doesn't dictate how soon you'll get the\n Snow device, rather it represents how quickly the Snow device moves to its destination while in\n transit. Regional shipping speeds are as follows:

    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snow devices are delivered in one to seven days.

      \n
      • \n
    • \n

      In the US, you have access to one-day shipping and two-day shipping.

      \n
      • \n
    " } }, - "ClusterId": { - "target": "com.amazonaws.snowball#ClusterId", + "Notification": { + "target": "com.amazonaws.snowball#Notification", "traits": { - "smithy.api#documentation": "

    The ID of a cluster. If you're creating a job for a node in a cluster, you need to\n provide only this clusterId value. The other job attributes are inherited from\n the cluster.

    " + "smithy.api#documentation": "

    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for\n this job.

    " } }, - "AddressId": { - "target": "com.amazonaws.snowball#AddressId", + "KmsKeyARN": { + "target": "com.amazonaws.snowball#KmsKeyARN", "traits": { - "smithy.api#documentation": "

    The ID for the address that you want the Snowball shipped to.

    " + "smithy.api#documentation": "

    The KmsKeyARN that you want to associate with this job.\n KmsKeyARNs are created using the CreateKey AWS Key Management\n Service (KMS) API action.

    " } } } @@ -795,36 +819,94 @@ } } }, - "com.amazonaws.snowball#DataTransfer": { + "com.amazonaws.snowball#CreateReturnShippingLabel": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowball#CreateReturnShippingLabelRequest" + }, + "output": { + "target": "com.amazonaws.snowball#CreateReturnShippingLabelResult" + }, + "errors": [ + { + "target": "com.amazonaws.snowball#ConflictException" + }, + { + "target": "com.amazonaws.snowball#InvalidInputCombinationException" + }, + { + "target": "com.amazonaws.snowball#InvalidJobStateException" + }, + { + "target": "com.amazonaws.snowball#InvalidResourceException" + }, + { + "target": "com.amazonaws.snowball#ReturnShippingLabelAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a shipping label that will be used to return the Snow device to AWS.

    " + } + }, + "com.amazonaws.snowball#CreateReturnShippingLabelRequest": { "type": "structure", "members": { - "ObjectsTransferred": { - "target": "com.amazonaws.snowball#Long", + "JobId": { + "target": "com.amazonaws.snowball#JobId", "traits": { - "smithy.api#documentation": "

    The number of objects transferred between a Snowball and Amazon S3.

    " + "smithy.api#documentation": "

    The ID for a job that you want to create the return shipping label for. For example\n JID123e4567-e89b-12d3-a456-426655440000.

    ", + "smithy.api#required": {} } }, + "ShippingOption": { + "target": "com.amazonaws.snowball#ShippingOption", + "traits": { + "smithy.api#documentation": "

    The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS.\n This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:

    " + } + } + } + }, + "com.amazonaws.snowball#CreateReturnShippingLabelResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.snowball#ShippingLabelStatus", + "traits": { + "smithy.api#documentation": "

    The status information of the task on a Snow device that is being returned to AWS.

    " + } + } + } + }, + "com.amazonaws.snowball#DataTransfer": { + "type": "structure", + "members": { "BytesTransferred": { "target": "com.amazonaws.snowball#Long", "traits": { - "smithy.api#documentation": "

    The number of bytes transferred between a Snowball and Amazon S3.

    " + "smithy.api#documentation": "

    The number of bytes transferred between a Snow device and Amazon S3.

    " } }, - "TotalBytes": { + "ObjectsTransferred": { "target": "com.amazonaws.snowball#Long", "traits": { - "smithy.api#documentation": "

    The total bytes of data for a transfer between a Snowball and Amazon S3. This value is\n set to 0 (zero) until all the keys that will be transferred have been listed.

    " + "smithy.api#documentation": "

    The number of objects transferred between a Snow device and Amazon S3.

    " } }, "TotalObjects": { "target": "com.amazonaws.snowball#Long", "traits": { - "smithy.api#documentation": "

    The total number of objects for a transfer between a Snowball and Amazon S3. This value\n is set to 0 (zero) until all the keys that will be transferred have been listed.

    " + "smithy.api#documentation": "

    The total number of objects for a transfer between a Snow device and Amazon S3. This value\n is set to 0 (zero) until all the keys that will be transferred have been listed.

    " + } + }, + "TotalBytes": { + "target": "com.amazonaws.snowball#Long", + "traits": { + "smithy.api#documentation": "

    The total bytes of data for a transfer between a Snow device and Amazon S3. This value is\n set to 0 (zero) until all the keys that will be transferred have been listed.

    " } } }, "traits": { - "smithy.api#documentation": "

    Defines the real-time status of a Snowball's data transfer while the device is at AWS.\n This data is only available while a job has a JobState value of\n InProgress, for both import and export jobs.

    " + "smithy.api#documentation": "

    Defines the real-time status of a Snow device's data transfer while the device is at AWS.\n This data is only available while a job has a JobState value of\n InProgress, for both import and export jobs.

    " } }, "com.amazonaws.snowball#DescribeAddress": { @@ -862,7 +944,7 @@ "Address": { "target": "com.amazonaws.snowball#Address", "traits": { - "smithy.api#documentation": "

    The address that you want the Snowball or Snowballs associated with a specific job to\n be shipped to.

    " + "smithy.api#documentation": "

    The address that you want the Snow device(s) associated with a specific job to\n be shipped to.

    " } } } @@ -896,17 +978,17 @@ "com.amazonaws.snowball#DescribeAddressesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.snowball#String", - "traits": { - "smithy.api#documentation": "

    HTTP requests are stateless. To identify what object comes \"next\" in the list of\n ADDRESS objects, you have the option of specifying a value for\n NextToken as the starting point for your list of returned addresses.

    " - } - }, "MaxResults": { "target": "com.amazonaws.snowball#ListLimit", "traits": { "smithy.api#documentation": "

    The number of ADDRESS objects to return.

    " } + }, + "NextToken": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "

    HTTP requests are stateless. To identify what object comes \"next\" in the list of\n ADDRESS objects, you have the option of specifying a value for\n NextToken as the starting point for your list of returned addresses.

    " + } } } }, @@ -916,7 +998,7 @@ "Addresses": { "target": "com.amazonaws.snowball#AddressList", "traits": { - "smithy.api#documentation": "

    The Snowball shipping addresses that were created for this account.

    " + "smithy.api#documentation": "

    The Snow device shipping addresses that were created for this account.

    " } }, "NextToken": { @@ -1013,6 +1095,57 @@ } } }, + "com.amazonaws.snowball#DescribeReturnShippingLabel": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowball#DescribeReturnShippingLabelRequest" + }, + "output": { + "target": "com.amazonaws.snowball#DescribeReturnShippingLabelResult" + }, + "errors": [ + { + "target": "com.amazonaws.snowball#ConflictException" + }, + { + "target": "com.amazonaws.snowball#InvalidJobStateException" + }, + { + "target": "com.amazonaws.snowball#InvalidResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

    Information on the shipping label of a Snow device that is being returned to AWS.

    " + } + }, + "com.amazonaws.snowball#DescribeReturnShippingLabelRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.snowball#JobId", + "traits": { + "smithy.api#documentation": "

    The automatically generated ID for a job, for example\n JID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + } + }, + "com.amazonaws.snowball#DescribeReturnShippingLabelResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.snowball#ShippingLabelStatus", + "traits": { + "smithy.api#documentation": "

    The status information of the task on a Snow device that is being returned to AWS.

    " + } + }, + "ExpirationDate": { + "target": "com.amazonaws.snowball#Timestamp", + "traits": { + "smithy.api#documentation": "

    The expiration date of the current return shipping label.

    " + } + } + } + }, "com.amazonaws.snowball#DeviceConfiguration": { "type": "structure", "members": { @@ -1030,22 +1163,22 @@ "com.amazonaws.snowball#Ec2AmiResource": { "type": "structure", "members": { + "SnowballAmiId": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "

    The ID of the AMI on the Snow device.

    " + } + }, "AmiId": { "target": "com.amazonaws.snowball#AmiId", "traits": { "smithy.api#documentation": "

    The ID of the AMI in Amazon EC2.

    ", "smithy.api#required": {} } - }, - "SnowballAmiId": { - "target": "com.amazonaws.snowball#String", - "traits": { - "smithy.api#documentation": "

    The ID of the AMI on the Snowball Edge device.

    " - } } }, "traits": { - "smithy.api#documentation": "

    A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI),\n including the Amazon EC2 AMI ID and the Snowball Edge AMI ID. Each AMI has these two IDs to\n simplify identifying the AMI in both the AWS Cloud and on the device.

    " + "smithy.api#documentation": "

    A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI),\n including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to\n simplify identifying the AMI in both the AWS Cloud and on the device.

    " } }, "com.amazonaws.snowball#Ec2AmiResourceList": { @@ -1109,7 +1242,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a link to an Amazon S3 presigned URL for the manifest file associated with the\n specified JobId value. You can access the manifest file for up to 60 minutes\n after this request has been made. To access the manifest file after 60 minutes have passed,\n you'll have to make another call to the GetJobManifest action.

    \n\n

    The manifest is an encrypted file that you can download after your job enters the\n WithCustomer status. The manifest is decrypted by using the\n UnlockCode code value, when you pass both values to the Snowball through the\n Snowball client when the client is started for the first time.

    \n\n\n

    As a best practice, we recommend that you don't save a copy of an\n UnlockCode value in the same location as the manifest file for that job. Saving\n these separately helps prevent unauthorized parties from gaining access to the Snowball\n associated with that job.

    \n\n\n

    The credentials of a given job, including its manifest file and unlock code, expire 90\n days after the job is created.

    " + "smithy.api#documentation": "

    Returns a link to an Amazon S3 presigned URL for the manifest file associated with the\n specified JobId value. You can access the manifest file for up to 60 minutes\n after this request has been made. To access the manifest file after 60 minutes have passed,\n you'll have to make another call to the GetJobManifest action.

    \n\n

    The manifest is an encrypted file that you can download after your job enters the\n WithCustomer status. The manifest is decrypted by using the\n UnlockCode code value, when you pass both values to the Snow device through the\n Snowball client when the client is started for the first time.

    \n\n\n

    As a best practice, we recommend that you don't save a copy of an\n UnlockCode value in the same location as the manifest file for that job. Saving\n these separately helps prevent unauthorized parties from gaining access to the Snow device\n associated with that job.

    \n\n\n

    The credentials of a given job, including its manifest file and unlock code, expire 90\n days after the job is created.

    " } }, "com.amazonaws.snowball#GetJobManifestRequest": { @@ -1152,7 +1285,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns the UnlockCode code value for the specified job. A particular\n UnlockCode value can be accessed for up to 90 days after the associated job has\n been created.

    \n\n

    The UnlockCode value is a 29-character code with 25 alphanumeric\n characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed\n along with the manifest to the Snowball through the Snowball client when the client is started\n for the first time.

    \n\n

    As a best practice, we recommend that you don't save a copy of the\n UnlockCode in the same location as the manifest file for that job. Saving these\n separately helps prevent unauthorized parties from gaining access to the Snowball associated\n with that job.

    " + "smithy.api#documentation": "

    Returns the UnlockCode code value for the specified job. A particular\n UnlockCode value can be accessed for up to 90 days after the associated job has\n been created.

    \n\n

    The UnlockCode value is a 29-character code with 25 alphanumeric\n characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed\n along with the manifest to the Snow device through the Snowball client when the client is started\n for the first time.

    \n\n

    As a best practice, we recommend that you don't save a copy of the\n UnlockCode in the same location as the manifest file for that job. Saving these\n separately helps prevent unauthorized parties from gaining access to the Snow device associated\n with that job.

    " } }, "com.amazonaws.snowball#GetJobUnlockCodeRequest": { @@ -1187,7 +1320,7 @@ "target": "com.amazonaws.snowball#GetSnowballUsageResult" }, "traits": { - "smithy.api#documentation": "

    Returns information about the Snowball service limit for your account, and also the\n number of Snowballs your account has in use.

    \n\n

    The default service limit for the number of Snowballs that you can have at one time is\n 1. If you want to increase your service limit, contact AWS Support.

    " + "smithy.api#documentation": "

    Returns information about the Snow Family service limit for your account, and also the\n number of Snow devices your account has in use.

    \n\n

    The default service limit for the number of Snow devices that you can have at one time is\n 1. If you want to increase your service limit, contact AWS Support.

    " } }, "com.amazonaws.snowball#GetSnowballUsageRequest": { @@ -1200,13 +1333,13 @@ "SnowballLimit": { "target": "com.amazonaws.snowball#Integer", "traits": { - "smithy.api#documentation": "

    The service limit for number of Snowballs this account can have at once. The default\n service limit is 1 (one).

    " + "smithy.api#documentation": "

    The service limit for number of Snow devices this account can have at once. The default\n service limit is 1 (one).

    " } }, "SnowballsInUse": { "target": "com.amazonaws.snowball#Integer", "traits": { - "smithy.api#documentation": "

    The number of Snowballs that this account is currently using.

    " + "smithy.api#documentation": "

    The number of Snow devices that this account is currently using.

    " } } } @@ -1359,34 +1492,28 @@ "smithy.api#documentation": "

    The current state of this job.

    " } }, - "JobId": { - "target": "com.amazonaws.snowball#String", + "JobType": { + "target": "com.amazonaws.snowball#JobType", "traits": { - "smithy.api#documentation": "

    The automatically generated ID for a job, for example\n JID123e4567-e89b-12d3-a456-426655440000.

    " + "smithy.api#documentation": "

    The type of job.

    " } }, "IsMaster": { "target": "com.amazonaws.snowball#Boolean", "traits": { - "smithy.api#documentation": "

    A value that indicates that this job is a master job. A master job represents a\n successful request to create an export job. Master jobs aren't associated with any Snowballs.\n Instead, each master job will have at least one job part, and each job part is associated with\n a Snowball. It might take some time before the job parts associated with a particular master\n job are listed, because they are created after the master job is created.

    " + "smithy.api#documentation": "

    A value that indicates that this job is a main job. A main job represents a\n successful request to create an export job. Main jobs aren't associated with any Snowballs.\n Instead, each main job will have at least one job part, and each job part is associated with\n a Snowball. It might take some time before the job parts associated with a particular main\n job are listed, because they are created after the main job is created.

    " } }, - "Description": { + "JobId": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The optional description of this specific job, for example Important Photos\n 2016-08-11.

    " - } - }, - "SnowballType": { - "target": "com.amazonaws.snowball#SnowballType", - "traits": { - "smithy.api#documentation": "

    The type of device used with this job.

    " + "smithy.api#documentation": "

    The automatically generated ID for a job, for example\n JID123e4567-e89b-12d3-a456-426655440000.

    " } }, - "JobType": { - "target": "com.amazonaws.snowball#JobType", + "Description": { + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The type of job.

    " + "smithy.api#documentation": "

    The optional description of this specific job, for example Important Photos\n 2016-08-11.

    " } }, "CreationDate": { @@ -1394,6 +1521,12 @@ "traits": { "smithy.api#documentation": "

    The creation date for this job.

    " } + }, + "SnowballType": { + "target": "com.amazonaws.snowball#SnowballType", + "traits": { + "smithy.api#documentation": "

    The type of device used with this job.

    " + } } }, "traits": { @@ -1415,42 +1548,48 @@ "smithy.api#documentation": "

    A link to an Amazon S3 presigned URL where the job completion report is\n located.

    " } }, - "JobSuccessLogURI": { + "JobFailureLogURI": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    A link to an Amazon S3 presigned URL where the job success log is located.

    " + "smithy.api#documentation": "

    A link to an Amazon S3 presigned URL where the job failure log is located.

    " } }, - "JobFailureLogURI": { + "JobSuccessLogURI": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    A link to an Amazon S3 presigned URL where the job failure log is located.

    " + "smithy.api#documentation": "

    A link to an Amazon S3 presigned URL where the job success log is located.

    " } } }, "traits": { - "smithy.api#documentation": "

    Contains job logs. Whenever Snowball is used to import data into or export data out of\n Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a\n part of the response syntax of the DescribeJob action in the\n JobMetadata data type. The job logs can be accessed for up to 60 minutes after\n this request has been made. To access any of the job logs after 60 minutes have passed, you'll\n have to make another call to the DescribeJob action.

    \n\n

    For import jobs, the PDF job report becomes available at the end of the import process.\n For export jobs, your job report typically becomes available while the Snowball for your job\n part is being delivered to you.

    \n\n

    The job report provides you insight into the state of your Amazon S3 data transfer. The\n report includes details about your job or job part for your records.

    \n\n

    For deeper visibility into the status of your transferred objects, you can look at the\n two associated logs: a success log and a failure log. The logs are saved in comma-separated\n value (CSV) format, and the name of each log includes the ID of the job or job part that the\n log describes.

    " + "smithy.api#documentation": "

    Contains job logs. Whenever a Snow device is used to import data into or export data out of\n Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a\n part of the response syntax of the DescribeJob action in the\n JobMetadata data type. The job logs can be accessed for up to 60 minutes after\n this request has been made. To access any of the job logs after 60 minutes have passed, you'll\n have to make another call to the DescribeJob action.

    \n\n

    For import jobs, the PDF job report becomes available at the end of the import process.\n For export jobs, your job report typically becomes available while the Snow device for your job\n part is being delivered to you.

    \n\n

    The job report provides you insight into the state of your Amazon S3 data transfer. The\n report includes details about your job or job part for your records.

    \n\n

    For deeper visibility into the status of your transferred objects, you can look at the\n two associated logs: a success log and a failure log. The logs are saved in comma-separated\n value (CSV) format, and the name of each log includes the ID of the job or job part that the\n log describes.

    " } }, "com.amazonaws.snowball#JobMetadata": { "type": "structure", "members": { - "DataTransferProgress": { - "target": "com.amazonaws.snowball#DataTransfer", + "ForwardingAddressId": { + "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

    A value that defines the real-time status of a Snowball's data transfer while the\n device is at AWS. This data is only available while a job has a JobState value of\n InProgress, for both import and export jobs.

    " + "smithy.api#documentation": "

    The ID of the address that you want a job shipped to, after it will be\n shipped to its primary address. This field is not supported in most regions.

    " } }, - "Resources": { - "target": "com.amazonaws.snowball#JobResource", + "RoleARN": { + "target": "com.amazonaws.snowball#RoleARN", "traits": { - "smithy.api#documentation": "

    An array of S3Resource objects. Each S3Resource object\n represents an Amazon S3 bucket that your transferred data will be exported from or imported\n into.

    " + "smithy.api#documentation": "

    The role ARN associated with this job. This ARN was created using the CreateRole\n API action in AWS Identity and Access Management (IAM).

    " } }, - "JobLogInfo": { - "target": "com.amazonaws.snowball#JobLogs", + "ShippingDetails": { + "target": "com.amazonaws.snowball#ShippingDetails", "traits": { - "smithy.api#documentation": "

    Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF\n job report becomes available at the end of the import process. For export jobs, your job\n report typically becomes available while the Snowball for your job part is being delivered to\n you.

    " + "smithy.api#documentation": "

    A job's shipping information, including inbound and outbound tracking numbers and\n shipping speed options.

    " + } + }, + "KmsKeyARN": { + "target": "com.amazonaws.snowball#KmsKeyARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key\n associated with this job. This ARN was created using the CreateKey API action in AWS\n KMS.

    " } }, "Notification": { @@ -1465,46 +1604,28 @@ "smithy.api#documentation": "

    The current status of the jobs.

    " } }, - "SnowballType": { - "target": "com.amazonaws.snowball#SnowballType", - "traits": { - "smithy.api#documentation": "

    The type of device used with this job.

    " - } - }, "ClusterId": { - "target": "com.amazonaws.snowball#String", - "traits": { - "smithy.api#documentation": "

    The 39-character ID for the cluster, for example\n CID123e4567-e89b-12d3-a456-426655440000.

    " - } - }, - "TaxDocuments": { - "target": "com.amazonaws.snowball#TaxDocuments", - "traits": { - "smithy.api#documentation": "

    The metadata associated with the tax documents required in your AWS Region.

    " - } - }, - "SnowballCapacityPreference": { - "target": "com.amazonaws.snowball#SnowballCapacity", + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The Snowball capacity preference for this job, specified at job creation. In US\n regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB\n capacity Snowballs.

    " + "smithy.api#documentation": "

    The 39-character ID for the cluster, for example\n CID123e4567-e89b-12d3-a456-426655440000.

    " } }, - "AddressId": { - "target": "com.amazonaws.snowball#AddressId", + "JobLogInfo": { + "target": "com.amazonaws.snowball#JobLogs", "traits": { - "smithy.api#documentation": "

    The ID for the address that you want the Snowball shipped to.

    " + "smithy.api#documentation": "

    Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF\n job report becomes available at the end of the import process. For export jobs, your job\n report typically becomes available while the Snow device for your job part is being delivered to\n you.

    " } }, - "CreationDate": { - "target": "com.amazonaws.snowball#Timestamp", + "SnowballType": { + "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "

    The creation date for this job.

    " + "smithy.api#documentation": "

    The type of device used with this job.

    " } }, - "JobType": { - "target": "com.amazonaws.snowball#JobType", + "Resources": { + "target": "com.amazonaws.snowball#JobResource", "traits": { - "smithy.api#documentation": "

    The type of job.

    " + "smithy.api#documentation": "

    An array of S3Resource objects. Each S3Resource object\n represents an Amazon S3 bucket that your transferred data will be exported from or imported\n into.

    " } }, "Description": { @@ -1513,6 +1634,18 @@ "smithy.api#documentation": "

    The description of the job, provided at job creation.

    " } }, + "AddressId": { + "target": "com.amazonaws.snowball#AddressId", + "traits": { + "smithy.api#documentation": "

    The ID for the address that you want the Snow device shipped to.

    " + } + }, + "SnowballCapacityPreference": { + "target": "com.amazonaws.snowball#SnowballCapacity", + "traits": { + "smithy.api#documentation": "

    The Snow device capacity preference for this job, specified at job creation. In US\n regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB\n capacity Snowballs.

    " + } + }, "JobId": { "target": "com.amazonaws.snowball#String", "traits": { @@ -1522,28 +1655,28 @@ "DeviceConfiguration": { "target": "com.amazonaws.snowball#DeviceConfiguration" }, - "ShippingDetails": { - "target": "com.amazonaws.snowball#ShippingDetails", + "CreationDate": { + "target": "com.amazonaws.snowball#Timestamp", "traits": { - "smithy.api#documentation": "

    A job's shipping information, including inbound and outbound tracking numbers and\n shipping speed options.

    " + "smithy.api#documentation": "

    The creation date for this job.

    " } }, - "RoleARN": { - "target": "com.amazonaws.snowball#RoleARN", + "JobType": { + "target": "com.amazonaws.snowball#JobType", "traits": { - "smithy.api#documentation": "

    The role ARN associated with this job. This ARN was created using the CreateRole\n API action in AWS Identity and Access Management (IAM).

    " + "smithy.api#documentation": "

    The type of job.

    " } }, - "ForwardingAddressId": { - "target": "com.amazonaws.snowball#AddressId", + "DataTransferProgress": { + "target": "com.amazonaws.snowball#DataTransfer", "traits": { - "smithy.api#documentation": "

    The ID of the address that you want a job shipped to, after it will be\n shipped to its primary address. This field is not supported in most regions.

    " + "smithy.api#documentation": "

    A value that defines the real-time status of a Snow device's data transfer while the\n device is at AWS. This data is only available while a job has a JobState value of\n InProgress, for both import and export jobs.

    " } }, - "KmsKeyARN": { - "target": "com.amazonaws.snowball#KmsKeyARN", + "TaxDocuments": { + "target": "com.amazonaws.snowball#TaxDocuments", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key\n associated with this job. This ARN was created using the CreateKey API action in AWS\n KMS.

    " + "smithy.api#documentation": "

    The metadata associated with the tax documents required in your AWS Region.

    " } } }, @@ -1682,16 +1815,16 @@ "com.amazonaws.snowball#KeyRange": { "type": "structure", "members": { - "EndMarker": { + "BeginMarker": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The key that ends an optional key range for an export job. Ranges are inclusive and\n UTF-8 binary sorted.

    " + "smithy.api#documentation": "

    The key that starts an optional key range for an export job. Ranges are inclusive and\n UTF-8 binary sorted.

    " } }, - "BeginMarker": { + "EndMarker": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The key that starts an optional key range for an export job. Ranges are inclusive and\n UTF-8 binary sorted.

    " + "smithy.api#documentation": "

    The key that ends an optional key range for an export job. Ranges are inclusive and\n UTF-8 binary sorted.

    " } } }, @@ -1758,12 +1891,6 @@ "com.amazonaws.snowball#ListClusterJobsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.snowball#String", - "traits": { - "smithy.api#documentation": "

    HTTP requests are stateless. To identify what object comes \"next\" in the list of\n JobListEntry objects, you have the option of specifying NextToken\n as the starting point for your returned list.

    " - } - }, "ClusterId": { "target": "com.amazonaws.snowball#ClusterId", "traits": { @@ -1771,6 +1898,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "

    HTTP requests are stateless. To identify what object comes \"next\" in the list of\n JobListEntry objects, you have the option of specifying NextToken\n as the starting point for your returned list.

    " + } + }, "MaxResults": { "target": "com.amazonaws.snowball#ListLimit", "traits": { @@ -1782,17 +1915,17 @@ "com.amazonaws.snowball#ListClusterJobsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.snowball#String", - "traits": { - "smithy.api#documentation": "

    HTTP requests are stateless. If you use the automatically generated\n NextToken value in your next ListClusterJobsResult call, your list\n of returned jobs will start from this point in the array.

    " - } - }, "JobListEntries": { "target": "com.amazonaws.snowball#JobListEntryList", "traits": { "smithy.api#documentation": "

    Each JobListEntry object contains a job's state, a job's ID, and a value\n that indicates whether the job is a job part, in the case of export jobs.

    " } + }, + "NextToken": { + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "

    HTTP requests are stateless. If you use the automatically generated\n NextToken value in your next ListClusterJobsResult call, your list\n of returned jobs will start from this point in the array.

    " + } } } }, @@ -1864,7 +1997,7 @@ } ], "traits": { - "smithy.api#documentation": "

    This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs)\n that are owned by your AWS account that would be supported for use on a Snowball Edge device.\n Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server\n 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS\n Marketplace.

    " + "smithy.api#documentation": "

    This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs)\n that are owned by your AWS account that would be supported for use on a Snow device.\n Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server\n 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS\n Marketplace.

    " } }, "com.amazonaws.snowball#ListCompatibleImagesRequest": { @@ -1887,17 +2020,17 @@ "com.amazonaws.snowball#ListCompatibleImagesResult": { "type": "structure", "members": { - "CompatibleImages": { - "target": "com.amazonaws.snowball#CompatibleImageList", - "traits": { - "smithy.api#documentation": "

    A JSON-formatted object that describes a compatible AMI, including the ID and name for\n a Snowball Edge AMI.

    " - } - }, "NextToken": { "target": "com.amazonaws.snowball#String", "traits": { "smithy.api#documentation": "

    Because HTTP requests are stateless, this is the starting point for your next list of\n returned images.

    " } + }, + "CompatibleImages": { + "target": "com.amazonaws.snowball#CompatibleImageList", + "traits": { + "smithy.api#documentation": "

    A JSON-formatted object that describes a compatible AMI, including the ID and name for\n a Snow device AMI.

    " + } } } }, @@ -1944,17 +2077,17 @@ "com.amazonaws.snowball#ListJobsResult": { "type": "structure", "members": { - "JobListEntries": { - "target": "com.amazonaws.snowball#JobListEntryList", - "traits": { - "smithy.api#documentation": "

    Each JobListEntry object contains a job's state, a job's ID, and a value\n that indicates whether the job is a job part, in the case of export jobs.

    " - } - }, "NextToken": { "target": "com.amazonaws.snowball#String", "traits": { "smithy.api#documentation": "

    HTTP requests are stateless. If you use this automatically generated\n NextToken value in your next ListJobs call, your returned\n JobListEntry objects will start from this point in the array.

    " } + }, + "JobListEntries": { + "target": "com.amazonaws.snowball#JobListEntryList", + "traits": { + "smithy.api#documentation": "

    Each JobListEntry object contains a job's state, a job's ID, and a value\n that indicates whether the job is a job part, in the case of export jobs.

    " + } } } }, @@ -2006,6 +2139,18 @@ } } }, + "com.amazonaws.snowball#ReturnShippingLabelAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.snowball#String" + } + }, + "traits": { + "smithy.api#documentation": "

    You get this exception if you call CreateReturnShippingLabel and a valid return\n shipping label already exists. In this case, use\n DescribeReturnShippingLabel to get the url.

    ", + "smithy.api#error": "client" + } + }, "com.amazonaws.snowball#RoleARN": { "type": "string", "traits": { @@ -2048,7 +2193,7 @@ "TrackingNumber": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The tracking number for this job. Using this tracking number with your region's\n carrier's website, you can track a Snowball as the carrier transports it.

    \n

    For India, the carrier is Amazon Logistics. For all other regions, UPS is the\n carrier.

    " + "smithy.api#documentation": "

    The tracking number for this job. Using this tracking number with your region's\n carrier's website, you can track a Snow device as the carrier transports it.

    \n

    For India, the carrier is Amazon Logistics. For all other regions, UPS is the\n carrier.

    " } }, "Status": { @@ -2062,25 +2207,40 @@ "smithy.api#documentation": "

    The Status and TrackingNumber information for an inbound or\n outbound shipment.

    " } }, + "com.amazonaws.snowball#ShipmentState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RECEIVED", + "name": "RECEIVED" + }, + { + "value": "RETURNED", + "name": "RETURNED" + } + ] + } + }, "com.amazonaws.snowball#ShippingDetails": { "type": "structure", "members": { "InboundShipment": { "target": "com.amazonaws.snowball#Shipment", "traits": { - "smithy.api#documentation": "

    The Status and TrackingNumber values for a Snowball being\n returned to AWS for a particular job.

    " + "smithy.api#documentation": "

    The Status and TrackingNumber values for a Snow device being\n returned to AWS for a particular job.

    " } }, "OutboundShipment": { "target": "com.amazonaws.snowball#Shipment", "traits": { - "smithy.api#documentation": "

    The Status and TrackingNumber values for a Snowball being\n delivered to the address that you specified for a particular job.

    " + "smithy.api#documentation": "

    The Status and TrackingNumber values for a Snow device being\n delivered to the address that you specified for a particular job.

    " } }, "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

    The shipping speed for a particular job. This speed doesn't dictate how soon you'll get\n the Snowball from the job's creation date. This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:

    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, Snowballs shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snowballs shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snowballs are delivered in one to seven days.

      \n
      • \n
    • \n

      In the United States of America (US), you have access to one-day shipping and\n two-day shipping.

      \n
      • \n
    " + "smithy.api#documentation": "

    The shipping speed for a particular job. This speed doesn't dictate how soon you'll get\n the Snow device from the job's creation date. This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:

    \n\n
      \n
    • \n

      In Australia, you have access to express shipping. Typically, Snow devices shipped\n express are delivered in about a day.

      \n
      • \n
    • \n

      In the European Union (EU), you have access to express shipping. Typically,\n Snow devices shipped express are delivered in about a day. In addition, most countries in the\n EU have access to standard shipping, which typically takes less than a week, one\n way.

      \n
      • \n
    • \n

      In India, Snow device are delivered in one to seven days.

      \n
      • \n
    • \n

      In the United States of America (US), you have access to one-day shipping and\n two-day shipping.

      \n
      • \n
    " } } }, @@ -2088,6 +2248,29 @@ "smithy.api#documentation": "

    A job's shipping information, including inbound and outbound tracking numbers and\n shipping speed options.

    " } }, + "com.amazonaws.snowball#ShippingLabelStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InProgress", + "name": "IN_PROGRESS" + }, + { + "value": "TimedOut", + "name": "TIMED_OUT" + }, + { + "value": "Succeeded", + "name": "SUCCEEDED" + }, + { + "value": "Failed", + "name": "FAILED" + } + ] + } + }, "com.amazonaws.snowball#ShippingOption": { "type": "string", "traits": { @@ -2267,16 +2450,28 @@ "com.amazonaws.snowball#UpdateClusterRequest": { "type": "structure", "members": { + "RoleARN": { + "target": "com.amazonaws.snowball#RoleARN", + "traits": { + "smithy.api#documentation": "

    The new role Amazon Resource Name (ARN) that you want to associate with this cluster.\n To create a role ARN, use the CreateRole API action in AWS\n Identity and Access Management (IAM).

    " + } + }, "ForwardingAddressId": { "target": "com.amazonaws.snowball#AddressId", "traits": { "smithy.api#documentation": "

    The updated ID for the forwarding address for a cluster. This field is not\n supported in most regions.

    " } }, - "ShippingOption": { - "target": "com.amazonaws.snowball#ShippingOption", + "Description": { + "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

    The updated shipping option value of this cluster's ShippingDetails\n object.

    " + "smithy.api#documentation": "

    The updated description of this cluster.

    " + } + }, + "AddressId": { + "target": "com.amazonaws.snowball#AddressId", + "traits": { + "smithy.api#documentation": "

    The ID of the updated Address object.

    " } }, "ClusterId": { @@ -2286,10 +2481,10 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.snowball#String", + "ShippingOption": { + "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

    The updated description of this cluster.

    " + "smithy.api#documentation": "

    The updated shipping option value of this cluster's ShippingDetails\n object.

    " } }, "Resources": { @@ -2298,23 +2493,11 @@ "smithy.api#documentation": "

    The updated arrays of JobResource objects that can include updated\n S3Resource objects or LambdaResource objects.

    " } }, - "AddressId": { - "target": "com.amazonaws.snowball#AddressId", - "traits": { - "smithy.api#documentation": "

    The ID of the updated Address object.

    " - } - }, "Notification": { "target": "com.amazonaws.snowball#Notification", "traits": { "smithy.api#documentation": "

    The new or updated Notification object.

    " } - }, - "RoleARN": { - "target": "com.amazonaws.snowball#RoleARN", - "traits": { - "smithy.api#documentation": "

    The new role Amazon Resource Name (ARN) that you want to associate with this cluster.\n To create a role ARN, use the CreateRole API action in AWS\n Identity and Access Management (IAM).

    " - } } } }, @@ -2357,16 +2540,10 @@ "com.amazonaws.snowball#UpdateJobRequest": { "type": "structure", "members": { - "ShippingOption": { - "target": "com.amazonaws.snowball#ShippingOption", - "traits": { - "smithy.api#documentation": "

    The updated shipping option value of this job's ShippingDetails\n object.

    " - } - }, - "ForwardingAddressId": { - "target": "com.amazonaws.snowball#AddressId", + "RoleARN": { + "target": "com.amazonaws.snowball#RoleARN", "traits": { - "smithy.api#documentation": "

    The updated ID for the forwarding address for a job. This field is not\n supported in most regions.

    " + "smithy.api#documentation": "

    The new role Amazon Resource Name (ARN) that you want to associate with this job. To\n create a role ARN, use the CreateRoleAWS Identity and Access\n Management (IAM) API action.

    " } }, "Description": { @@ -2375,46 +2552,95 @@ "smithy.api#documentation": "

    The updated description of this job's JobMetadata object.

    " } }, + "SnowballCapacityPreference": { + "target": "com.amazonaws.snowball#SnowballCapacity", + "traits": { + "smithy.api#documentation": "

    The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US\n regions.

    " + } + }, "AddressId": { "target": "com.amazonaws.snowball#AddressId", "traits": { "smithy.api#documentation": "

    The ID of the updated Address object.

    " } }, + "JobId": { + "target": "com.amazonaws.snowball#JobId", + "traits": { + "smithy.api#documentation": "

    The job ID of the job that you want to update, for example\n JID123e4567-e89b-12d3-a456-426655440000.

    ", + "smithy.api#required": {} + } + }, "Notification": { "target": "com.amazonaws.snowball#Notification", "traits": { "smithy.api#documentation": "

    The new or updated Notification object.

    " } }, - "JobId": { - "target": "com.amazonaws.snowball#JobId", + "Resources": { + "target": "com.amazonaws.snowball#JobResource", "traits": { - "smithy.api#documentation": "

    The job ID of the job that you want to update, for example\n JID123e4567-e89b-12d3-a456-426655440000.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The updated JobResource object, or the updated JobResource object.

    " } }, - "RoleARN": { - "target": "com.amazonaws.snowball#RoleARN", + "ForwardingAddressId": { + "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

    The new role Amazon Resource Name (ARN) that you want to associate with this job. To\n create a role ARN, use the CreateRoleAWS Identity and Access\n Management (IAM) API action.

    " + "smithy.api#documentation": "

    The updated ID for the forwarding address for a job. This field is not\n supported in most regions.

    " } }, - "SnowballCapacityPreference": { - "target": "com.amazonaws.snowball#SnowballCapacity", + "ShippingOption": { + "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

    The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US\n regions.

    " + "smithy.api#documentation": "

    The updated shipping option value of this job's ShippingDetails\n object.

    " + } + } + } + }, + "com.amazonaws.snowball#UpdateJobResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.snowball#UpdateJobShipmentState": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowball#UpdateJobShipmentStateRequest" + }, + "output": { + "target": "com.amazonaws.snowball#UpdateJobShipmentStateResult" + }, + "errors": [ + { + "target": "com.amazonaws.snowball#InvalidJobStateException" + }, + { + "target": "com.amazonaws.snowball#InvalidResourceException" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates the state when a the shipment states changes to a different state.

    " + } + }, + "com.amazonaws.snowball#UpdateJobShipmentStateRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.snowball#JobId", + "traits": { + "smithy.api#documentation": "

    The job ID of the job whose shipment date you want to update, for example\n JID123e4567-e89b-12d3-a456-426655440000.

    ", + "smithy.api#required": {} } }, - "Resources": { - "target": "com.amazonaws.snowball#JobResource", + "ShipmentState": { + "target": "com.amazonaws.snowball#ShipmentState", "traits": { - "smithy.api#documentation": "

    The updated JobResource object, or the updated JobResource object.

    " + "smithy.api#documentation": "

    The state of a device when it is being shipped.

    \n

    Set to RECEIVED when the device arrives at your location.

    \n

    Set to RETURNED when you have returned the device to AWS.

    ", + "smithy.api#required": {} } } } }, - "com.amazonaws.snowball#UpdateJobResult": { + "com.amazonaws.snowball#UpdateJobShipmentStateResult": { "type": "structure", "members": {} }, diff --git a/codegen/sdk-codegen/aws-models/sns.2010-03-31.json b/codegen/sdk-codegen/aws-models/sns.2010-03-31.json index 42e1ee415e67..c9401bc5a08a 100644 --- a/codegen/sdk-codegen/aws-models/sns.2010-03-31.json +++ b/codegen/sdk-codegen/aws-models/sns.2010-03-31.json @@ -209,7 +209,7 @@ "sdkId": "SNS", "arnNamespace": "sns", "cloudFormationName": "SNS", - "cloudTrailEventSource": "onlines.cloudcast.amazon.com" + "cloudTrailEventSource": "sns.amazonaws.com" }, "aws.auth#sigv4": { "name": "sns" @@ -348,18 +348,18 @@ "smithy.api#required": {} } }, - "AuthenticateOnUnsubscribe": { - "target": "com.amazonaws.sns#authenticateOnUnsubscribe", - "traits": { - "smithy.api#documentation": "

    Disallows unauthenticated unsubscribes of the subscription. If the value of this\n parameter is true and the request has an AWS signature, then only the topic\n owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action\n requires AWS authentication.

    " - } - }, "TopicArn": { "target": "com.amazonaws.sns#topicARN", "traits": { "smithy.api#documentation": "

    The ARN of the topic for which you wish to confirm a subscription.

    ", "smithy.api#required": {} } + }, + "AuthenticateOnUnsubscribe": { + "target": "com.amazonaws.sns#authenticateOnUnsubscribe", + "traits": { + "smithy.api#documentation": "

    Disallows unauthenticated unsubscribes of the subscription. If the value of this\n parameter is true and the request has an AWS signature, then only the topic\n owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action\n requires AWS authentication.

    " + } } }, "traits": { @@ -420,10 +420,10 @@ "com.amazonaws.sns#CreatePlatformApplicationInput": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.sns#MapStringToString", + "Name": { + "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

    For a list of attributes, see SetPlatformApplicationAttributes\n

    ", + "smithy.api#documentation": "

    Application names must be made up of only uppercase and lowercase ASCII letters,\n numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters\n long.

    ", "smithy.api#required": {} } }, @@ -434,10 +434,10 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.sns#String", + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", "traits": { - "smithy.api#documentation": "

    Application names must be made up of only uppercase and lowercase ASCII letters,\n numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters\n long.

    ", + "smithy.api#documentation": "

    For a list of attributes, see SetPlatformApplicationAttributes\n

    ", "smithy.api#required": {} } } @@ -495,13 +495,6 @@ "smithy.api#documentation": "

    For a list of attributes, see SetEndpointAttributes.

    " } }, - "PlatformApplicationArn": { - "target": "com.amazonaws.sns#String", - "traits": { - "smithy.api#documentation": "

    PlatformApplicationArn returned from CreatePlatformApplication is used to create a an\n endpoint.

    ", - "smithy.api#required": {} - } - }, "CustomUserData": { "target": "com.amazonaws.sns#String", "traits": { @@ -514,6 +507,13 @@ "smithy.api#documentation": "

    Unique identifier created by the notification service for an app on a device. The\n specific name for Token will vary, depending on which notification service is being\n used. For example, when using APNS as the notification service, you need the device\n token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token\n equivalent is called the registration ID.

    ", "smithy.api#required": {} } + }, + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

    PlatformApplicationArn returned from CreatePlatformApplication is used to create a an\n endpoint.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -558,7 +558,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a topic to which notifications can be published. Users can create at most\n 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester\n already owns a topic with the specified name, that topic's ARN is returned without\n creating a new topic.

    " + "smithy.api#documentation": "

    Creates a topic to which notifications can be published. Users can create at most\n 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester\n already owns a topic with the specified name, that topic's ARN is returned without\n creating a new topic.

    " } }, "com.amazonaws.sns#CreateTopicInput": { @@ -573,13 +573,13 @@ "Attributes": { "target": "com.amazonaws.sns#TopicAttributesMap", "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\n parameters that the CreateTopic action uses:

    \n
      \n
    • \n

      \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

      \n
      • \n
    • \n

      \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

      \n
      • \n
    • \n

      \n FifoTopic – Set to true to create a FIFO topic.

      \n
      • \n
    • \n

      \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

      \n
      • \n
    \n \n

    The following attribute applies only to server-side-encryption:

    \n
      \n
    • \n

      \n KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK)\n for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the AWS Key Management Service API\n Reference.

      \n
      • \n
    \n \n \n

    The following attribute applies only to FIFO topics:

    \n
      \n
    • \n

      \n ContentBasedDeduplication – Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the message (but not the\n attributes of the message).

      \n
      • \n
    • \n

      \n When ContentBasedDeduplication is in effect, messages with identical content sent\n within the deduplication interval are treated as duplicates and only one copy of the message is\n delivered.\n

      \n
      • \n
    • \n

      \n If the queue has ContentBasedDeduplication set, your MessageDeduplicationId\n overrides the generated one.\n

      \n
      • \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\n parameters that the CreateTopic action uses:

    \n
      \n
    • \n

      \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

      \n
      • \n
    • \n

      \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

      \n
      • \n
    • \n

      \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

      \n
      • \n
    \n \n

    The following attribute applies only to server-side-encryption:

    \n
      \n
    • \n

      \n KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK)\n for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the AWS Key Management Service API\n Reference.

      \n
      • \n
    " } }, "Name": { "target": "com.amazonaws.sns#topicName", "traits": { - "smithy.api#documentation": "

    The name of the topic you want to create.

    \n

    Constraints: Topic names must be made up of only uppercase and lowercase ASCII\n letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters\n long.

    \n

    For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.

    ", + "smithy.api#documentation": "

    The name of the topic you want to create.

    \n

    Constraints: Topic names must be made up of only uppercase and lowercase ASCII\n letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters\n long.

    ", "smithy.api#required": {} } } @@ -1311,17 +1311,17 @@ "com.amazonaws.sns#ListPhoneNumbersOptedOutResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.sns#String", - "traits": { - "smithy.api#documentation": "

    A NextToken string is returned when you call the\n ListPhoneNumbersOptedOut action if additional records are available\n after the first page of results.

    " - } - }, "phoneNumbers": { "target": "com.amazonaws.sns#PhoneNumberList", "traits": { "smithy.api#documentation": "

    A list of phone numbers that are opted out of receiving SMS messages. The list is\n paginated, and each page can contain up to 100 phone numbers.

    " } + }, + "nextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

    A NextToken string is returned when you call the\n ListPhoneNumbersOptedOut action if additional records are available\n after the first page of results.

    " + } } }, "traits": { @@ -1373,17 +1373,17 @@ "com.amazonaws.sns#ListPlatformApplicationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sns#String", - "traits": { - "smithy.api#documentation": "

    NextToken string is returned when calling ListPlatformApplications action if\n additional records are available after the first page results.

    " - } - }, "PlatformApplications": { "target": "com.amazonaws.sns#ListOfPlatformApplications", "traits": { "smithy.api#documentation": "

    Platform applications returned when calling ListPlatformApplications action.

    " } + }, + "NextToken": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

    NextToken string is returned when calling ListPlatformApplications action if\n additional records are available after the first page results.

    " + } } }, "traits": { @@ -1458,18 +1458,18 @@ "com.amazonaws.sns#ListSubscriptionsByTopicInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sns#nextToken", - "traits": { - "smithy.api#documentation": "

    Token returned by the previous ListSubscriptionsByTopic request.

    " - } - }, "TopicArn": { "target": "com.amazonaws.sns#topicARN", "traits": { "smithy.api#documentation": "

    The ARN of the topic for which you wish to find subscriptions.

    ", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

    Token returned by the previous ListSubscriptionsByTopic request.

    " + } } }, "traits": { @@ -1479,17 +1479,17 @@ "com.amazonaws.sns#ListSubscriptionsByTopicResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sns#nextToken", - "traits": { - "smithy.api#documentation": "

    Token to pass along to the next ListSubscriptionsByTopic request. This\n element is returned if there are more subscriptions to retrieve.

    " - } - }, "Subscriptions": { "target": "com.amazonaws.sns#SubscriptionsList", "traits": { "smithy.api#documentation": "

    A list of subscriptions.

    " } + }, + "NextToken": { + "target": "com.amazonaws.sns#nextToken", + "traits": { + "smithy.api#documentation": "

    Token to pass along to the next ListSubscriptionsByTopic request. This\n element is returned if there are more subscriptions to retrieve.

    " + } } }, "traits": { @@ -1765,17 +1765,17 @@ "com.amazonaws.sns#PlatformApplication": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.sns#MapStringToString", - "traits": { - "smithy.api#documentation": "

    Attributes for platform application object.

    " - } - }, "PlatformApplicationArn": { "target": "com.amazonaws.sns#String", "traits": { "smithy.api#documentation": "

    PlatformApplicationArn for platform application object.

    " } + }, + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", + "traits": { + "smithy.api#documentation": "

    Attributes for platform application object.

    " + } } }, "traits": { @@ -1857,6 +1857,12 @@ "com.amazonaws.sns#PublishInput": { "type": "structure", "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

    The topic you want to publish to.

    \n

    If you don't specify a value for the TopicArn parameter, you must specify\n a value for the PhoneNumber or TargetArn parameters.

    " + } + }, "Message": { "target": "com.amazonaws.sns#message", "traits": { @@ -1864,10 +1870,16 @@ "smithy.api#required": {} } }, - "Subject": { - "target": "com.amazonaws.sns#subject", + "MessageStructure": { + "target": "com.amazonaws.sns#messageStructure", "traits": { - "smithy.api#documentation": "

    Optional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.

    \n

    Constraints: Subjects must be ASCII text that begins with a letter, number, or\n punctuation mark; must not include line breaks or control characters; and must be less\n than 100 characters long.

    " + "smithy.api#documentation": "

    Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:

    \n
      \n
    • \n

      be a syntactically valid JSON object; and

      \n
      • \n
    • \n

      contain at least a top-level JSON key of \"default\" with a value that is a\n string.

      \n
      • \n
    \n

    You can define other top-level keys that define the message you want to send to a\n specific transport protocol (e.g., \"http\").

    \n

    Valid value: json\n

    " + } + }, + "PhoneNumber": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

    The phone number to which you want to deliver an SMS message. Use E.164 format.

    \n

    If you don't specify a value for the PhoneNumber parameter, you must\n specify a value for the TargetArn or TopicArn\n parameters.

    " } }, "TargetArn": { @@ -1882,22 +1894,10 @@ "smithy.api#documentation": "

    Message attributes for Publish action.

    " } }, - "PhoneNumber": { - "target": "com.amazonaws.sns#String", - "traits": { - "smithy.api#documentation": "

    The phone number to which you want to deliver an SMS message. Use E.164 format.

    \n

    If you don't specify a value for the PhoneNumber parameter, you must\n specify a value for the TargetArn or TopicArn\n parameters.

    " - } - }, - "MessageStructure": { - "target": "com.amazonaws.sns#messageStructure", - "traits": { - "smithy.api#documentation": "

    Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:

    \n
      \n
    • \n

      be a syntactically valid JSON object; and

      \n
      • \n
    • \n

      contain at least a top-level JSON key of \"default\" with a value that is a\n string.

      \n
      • \n
    \n

    You can define other top-level keys that define the message you want to send to a\n specific transport protocol (e.g., \"http\").

    \n

    Valid value: json\n

    " - } - }, - "TopicArn": { - "target": "com.amazonaws.sns#topicARN", + "Subject": { + "target": "com.amazonaws.sns#subject", "traits": { - "smithy.api#documentation": "

    The topic you want to publish to.

    \n

    If you don't specify a value for the TopicArn parameter, you must specify\n a value for the PhoneNumber or TargetArn parameters.

    " + "smithy.api#documentation": "

    Optional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.

    \n

    Constraints: Subjects must be ASCII text that begins with a letter, number, or\n punctuation mark; must not include line breaks or control characters; and must be less\n than 100 characters long.

    " } } }, @@ -1945,17 +1945,17 @@ "com.amazonaws.sns#RemovePermissionInput": { "type": "structure", "members": { - "TopicArn": { - "target": "com.amazonaws.sns#topicARN", + "Label": { + "target": "com.amazonaws.sns#label", "traits": { - "smithy.api#documentation": "

    The ARN of the topic whose access control policy you wish to modify.

    ", + "smithy.api#documentation": "

    The unique label of the statement you want to remove.

    ", "smithy.api#required": {} } }, - "Label": { - "target": "com.amazonaws.sns#label", + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", "traits": { - "smithy.api#documentation": "

    The unique label of the statement you want to remove.

    ", + "smithy.api#documentation": "

    The ARN of the topic whose access control policy you wish to modify.

    ", "smithy.api#required": {} } } @@ -2048,17 +2048,17 @@ "com.amazonaws.sns#SetPlatformApplicationAttributesInput": { "type": "structure", "members": { - "PlatformApplicationArn": { - "target": "com.amazonaws.sns#String", + "Attributes": { + "target": "com.amazonaws.sns#MapStringToString", "traits": { - "smithy.api#documentation": "

    PlatformApplicationArn for SetPlatformApplicationAttributes action.

    ", + "smithy.api#documentation": "

    A map of the platform application attributes. Attributes in this map include the\n following:

    \n
      \n
    • \n

      \n PlatformCredential – The credential received from the\n notification service. For APNS and APNS_SANDBOX,\n PlatformCredential is private key. For\n GCM (Firebase Cloud Messaging), PlatformCredential\n is API key. For ADM, PlatformCredential\n is client secret.

      \n
      • \n
    • \n

      \n PlatformPrincipal – The principal received from the\n notification service. For APNS and APNS_SANDBOX,\n PlatformPrincipal is SSL certificate. For\n GCM (Firebase Cloud Messaging), there is no\n PlatformPrincipal. For ADM,\n PlatformPrincipal is client id.

      \n
      • \n
    • \n

      \n EventEndpointCreated – Topic ARN to which\n EndpointCreated event notifications are sent.

      \n
      • \n
    • \n

      \n EventEndpointDeleted – Topic ARN to which\n EndpointDeleted event notifications are sent.

      \n
      • \n
    • \n

      \n EventEndpointUpdated – Topic ARN to which\n EndpointUpdate event notifications are sent.

      \n
      • \n
    • \n

      \n EventDeliveryFailure – Topic ARN to which\n DeliveryFailure event notifications are sent upon Direct\n Publish delivery failure (permanent) to one of the application's\n endpoints.

      \n
      • \n
    • \n

      \n SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.

      \n
      • \n
    • \n

      \n FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.

      \n
      • \n
    • \n

      \n SuccessFeedbackSampleRate – Sample rate percentage (0-100)\n of successfully delivered messages.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Attributes": { - "target": "com.amazonaws.sns#MapStringToString", + "PlatformApplicationArn": { + "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

    A map of the platform application attributes. Attributes in this map include the\n following:

    \n
      \n
    • \n

      \n PlatformCredential – The credential received from the\n notification service. For APNS and APNS_SANDBOX,\n PlatformCredential is private key. For\n GCM (Firebase Cloud Messaging), PlatformCredential\n is API key. For ADM, PlatformCredential\n is client secret.

      \n
      • \n
    • \n

      \n PlatformPrincipal – The principal received from the\n notification service. For APNS and APNS_SANDBOX,\n PlatformPrincipal is SSL certificate. For\n GCM (Firebase Cloud Messaging), there is no\n PlatformPrincipal. For ADM,\n PlatformPrincipal is client id.

      \n
      • \n
    • \n

      \n EventEndpointCreated – Topic ARN to which\n EndpointCreated event notifications are sent.

      \n
      • \n
    • \n

      \n EventEndpointDeleted – Topic ARN to which\n EndpointDeleted event notifications are sent.

      \n
      • \n
    • \n

      \n EventEndpointUpdated – Topic ARN to which\n EndpointUpdate event notifications are sent.

      \n
      • \n
    • \n

      \n EventDeliveryFailure – Topic ARN to which\n DeliveryFailure event notifications are sent upon Direct\n Publish delivery failure (permanent) to one of the application's\n endpoints.

      \n
      • \n
    • \n

      \n SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.

      \n
      • \n
    • \n

      \n FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS\n write access to use CloudWatch Logs on your behalf.

      \n
      • \n
    • \n

      \n SuccessFeedbackSampleRate – Sample rate percentage (0-100)\n of successfully delivered messages.

      \n
      • \n
    ", + "smithy.api#documentation": "

    PlatformApplicationArn for SetPlatformApplicationAttributes action.

    ", "smithy.api#required": {} } } @@ -2144,11 +2144,10 @@ "com.amazonaws.sns#SetSubscriptionAttributesInput": { "type": "structure", "members": { - "SubscriptionArn": { - "target": "com.amazonaws.sns#subscriptionARN", + "AttributeValue": { + "target": "com.amazonaws.sns#attributeValue", "traits": { - "smithy.api#documentation": "

    The ARN of the subscription to modify.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The new value for the attribute in JSON format.

    " } }, "AttributeName": { @@ -2158,10 +2157,11 @@ "smithy.api#required": {} } }, - "AttributeValue": { - "target": "com.amazonaws.sns#attributeValue", + "SubscriptionArn": { + "target": "com.amazonaws.sns#subscriptionARN", "traits": { - "smithy.api#documentation": "

    The new value for the attribute in JSON format.

    " + "smithy.api#documentation": "

    The ARN of the subscription to modify.

    ", + "smithy.api#required": {} } } }, @@ -2198,13 +2198,6 @@ "com.amazonaws.sns#SetTopicAttributesInput": { "type": "structure", "members": { - "TopicArn": { - "target": "com.amazonaws.sns#topicARN", - "traits": { - "smithy.api#documentation": "

    The ARN of the topic to modify.

    ", - "smithy.api#required": {} - } - }, "AttributeValue": { "target": "com.amazonaws.sns#attributeValue", "traits": { @@ -2214,7 +2207,14 @@ "AttributeName": { "target": "com.amazonaws.sns#attributeName", "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\n parameters that the SetTopicAttributes action uses:

    \n
      \n
    • \n

      \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

      \n
      • \n
    • \n

      \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

      \n
      • \n
    • \n

      \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

      \n
      • \n
    \n \n

    The following attribute applies only to server-side-encryption:

    \n
      \n
    • \n

      \n KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK)\n for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the AWS Key Management Service API\n Reference.

      \n
      • \n
    \n \n \n

    The following attribute applies only to FIFO topics:

    \n
      \n
    • \n

      \n ContentBasedDeduplication – Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the message (but not the\n attributes of the message).

      \n
      • \n
    • \n

      \n When ContentBasedDeduplication is in effect, messages with identical content sent\n within the deduplication interval are treated as duplicates and only one copy of the message is\n delivered.\n

      \n
      • \n
    • \n

      \n If the queue has ContentBasedDeduplication set, your MessageDeduplicationId\n overrides the generated one.\n

      \n
      • \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\n parameters that the SetTopicAttributes action uses:

    \n
      \n
    • \n

      \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

      \n
      • \n
    • \n

      \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

      \n
      • \n
    • \n

      \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

      \n
      • \n
    \n \n

    The following attribute applies only to server-side-encryption:

    \n
      \n
    • \n

      \n KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK)\n for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the AWS Key Management Service API\n Reference.

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

    The ARN of the topic to modify.

    ", "smithy.api#required": {} } } @@ -2277,11 +2277,16 @@ "com.amazonaws.sns#SubscribeInput": { "type": "structure", "members": { - "TopicArn": { - "target": "com.amazonaws.sns#topicARN", + "Endpoint": { + "target": "com.amazonaws.sns#Endpoint2", "traits": { - "smithy.api#documentation": "

    The ARN of the topic you want to subscribe to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The endpoint that you want to receive notifications. Endpoints vary by\n protocol:

    \n
      \n
    • \n

      For the http protocol, the (public) endpoint is a URL beginning\n with http://\n

      \n
      • \n
    • \n

      For the https protocol, the (public) endpoint is a URL beginning\n with https://\n

      \n
      • \n
    • \n

      For the email protocol, the endpoint is an email address

      \n
      • \n
    • \n

      For the email-json protocol, the endpoint is an email\n address

      \n
      • \n
    • \n

      For the sms protocol, the endpoint is a phone number of an\n SMS-enabled device

      \n
      • \n
    • \n

      For the sqs protocol, the endpoint is the ARN of an Amazon SQS\n queue

      \n
      • \n
    • \n

      For the application protocol, the endpoint is the EndpointArn of\n a mobile app and device.

      \n
      • \n
    • \n

      For the lambda protocol, the endpoint is the ARN of an Amazon Lambda\n function.

      \n
      • \n
    " + } + }, + "Attributes": { + "target": "com.amazonaws.sns#SubscriptionAttributesMap", + "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\n parameters that the SetTopicAttributes action uses:

    \n
      \n
    • \n

      \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

      \n
      • \n
    • \n

      \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

      \n
      • \n
    • \n

      \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

      \n
      • \n
    • \n

      \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

      \n
      • \n
    " } }, "Protocol": { @@ -2291,22 +2296,17 @@ "smithy.api#required": {} } }, - "Endpoint": { - "target": "com.amazonaws.sns#Endpoint2", + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", "traits": { - "smithy.api#documentation": "

    The endpoint that you want to receive notifications. Endpoints vary by\n protocol:

    \n
      \n
    • \n

      For the http protocol, the (public) endpoint is a URL beginning\n with http://\n

      \n
      • \n
    • \n

      For the https protocol, the (public) endpoint is a URL beginning\n with https://\n

      \n
      • \n
    • \n

      For the email protocol, the endpoint is an email address

      \n
      • \n
    • \n

      For the email-json protocol, the endpoint is an email\n address

      \n
      • \n
    • \n

      For the sms protocol, the endpoint is a phone number of an\n SMS-enabled device

      \n
      • \n
    • \n

      For the sqs protocol, the endpoint is the ARN of an Amazon SQS\n queue

      \n
      • \n
    • \n

      For the application protocol, the endpoint is the EndpointArn of\n a mobile app and device.

      \n
      • \n
    • \n

      For the lambda protocol, the endpoint is the ARN of an Amazon Lambda\n function.

      \n
      • \n
    " + "smithy.api#documentation": "

    The ARN of the topic you want to subscribe to.

    ", + "smithy.api#required": {} } }, "ReturnSubscriptionArn": { "target": "com.amazonaws.sns#boolean", "traits": { - "smithy.api#documentation": "

    Sets whether the response from the Subscribe request includes the\n subscription ARN, even if the subscription is not yet confirmed.

    \n
      \n
    • \n

      If you set this parameter to true, the response includes the ARN in all cases, even\n if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response\n also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A\n subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a\n confirmation token.

      \n
      • \n
    \n

    \n

    The default value is false.

    " - } - }, - "Attributes": { - "target": "com.amazonaws.sns#SubscriptionAttributesMap", - "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\n parameters that the SetTopicAttributes action uses:

    \n
      \n
    • \n

      \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

      \n
      • \n
    • \n

      \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

      \n
      • \n
    • \n

      \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

      \n
      • \n
    • \n

      \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

      \n
      • \n
    " + "smithy.api#documentation": "

    Sets whether the response from the Subscribe request includes the\n subscription ARN, even if the subscription is not yet confirmed.

    \n

    If you set this parameter to true, the response includes the ARN in all cases, even\n if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response\n also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A\n subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a\n confirmation token.

    \n

    \n

    The default value is false.

    " } } }, @@ -2331,12 +2331,6 @@ "com.amazonaws.sns#Subscription": { "type": "structure", "members": { - "Protocol": { - "target": "com.amazonaws.sns#protocol", - "traits": { - "smithy.api#documentation": "

    The subscription's protocol.

    " - } - }, "Owner": { "target": "com.amazonaws.sns#account", "traits": { @@ -2349,16 +2343,22 @@ "smithy.api#documentation": "

    The subscription's ARN.

    " } }, + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

    The ARN of the subscription's topic.

    " + } + }, "Endpoint": { "target": "com.amazonaws.sns#Endpoint2", "traits": { "smithy.api#documentation": "

    The subscription's endpoint (format depends on the protocol).

    " } }, - "TopicArn": { - "target": "com.amazonaws.sns#topicARN", + "Protocol": { + "target": "com.amazonaws.sns#protocol", "traits": { - "smithy.api#documentation": "

    The ARN of the subscription's topic.

    " + "smithy.api#documentation": "

    The subscription's protocol.

    " } } }, @@ -2501,17 +2501,17 @@ "com.amazonaws.sns#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.sns#TagList", + "ResourceArn": { + "target": "com.amazonaws.sns#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The tags to be added to the specified topic. A tag consists of a required key\n and an optional value.

    ", + "smithy.api#documentation": "

    The ARN of the topic to which to add tags.

    ", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.sns#AmazonResourceName", + "Tags": { + "target": "com.amazonaws.sns#TagList", "traits": { - "smithy.api#documentation": "

    The ARN of the topic to which to add tags.

    ", + "smithy.api#documentation": "

    The tags to be added to the specified topic. A tag consists of a required key\n and an optional value.

    ", "smithy.api#required": {} } } 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 2bd9076f33aa..3896452b8dab 100644 --- a/codegen/sdk-codegen/aws-models/sqs.2012-11-05.json +++ b/codegen/sdk-codegen/aws-models/sqs.2012-11-05.json @@ -58,6 +58,15 @@ "com.amazonaws.sqs#AddPermissionRequest": { "type": "structure", "members": { + "Actions": { + "target": "com.amazonaws.sqs#ActionNameList", + "traits": { + "smithy.api#documentation": "

    The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

    \n

    For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon Simple Queue Service Developer Guide.

    \n

    Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.

    ", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ActionName" + } + }, "Label": { "target": "com.amazonaws.sqs#String", "traits": { @@ -65,15 +74,6 @@ "smithy.api#required": {} } }, - "AWSAccountIds": { - "target": "com.amazonaws.sqs#AWSAccountIdList", - "traits": { - "smithy.api#documentation": "

    The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS\n account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

    ", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AWSAccountId" - } - }, "QueueUrl": { "target": "com.amazonaws.sqs#String", "traits": { @@ -81,13 +81,13 @@ "smithy.api#required": {} } }, - "Actions": { - "target": "com.amazonaws.sqs#ActionNameList", + "AWSAccountIds": { + "target": "com.amazonaws.sqs#AWSAccountIdList", "traits": { - "smithy.api#documentation": "

    The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

    \n

    For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon Simple Queue Service Developer Guide.

    \n

    Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.

    ", + "smithy.api#documentation": "

    The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS\n account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

    ", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "ActionName" + "smithy.api#xmlName": "AWSAccountId" } } }, @@ -171,7 +171,7 @@ "name": "sqs" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "

    Welcome to the Amazon Simple Queue Service API Reference.

    \n

    Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

    \n

    You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

    \n
      \n
    • \n

      Cryptographically sign your service requests

      \n
      • \n
    • \n

      Retry requests

      \n
      • \n
    • \n

      Handle error responses

      \n
      • \n
    \n \n

    \n Additional Information\n

    \n ", + "smithy.api#documentation": "

    Welcome to the Amazon Simple Queue Service API Reference.

    \n

    Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

    \n

    For information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon Simple Queue Service Developer Guide.\n

    \n

    You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

    \n
      \n
    • \n

      Cryptographically sign your service requests

      \n
      • \n
    • \n

      Retry requests

      \n
      • \n
    • \n

      Handle error responses

      \n
      • \n
    \n \n

    \n Additional Information\n

    \n ", "smithy.api#title": "Amazon Simple Queue Service", "smithy.api#xmlNamespace": { "uri": "http://queue.amazonaws.com/doc/2012-11-05/" @@ -205,31 +205,31 @@ "com.amazonaws.sqs#BatchResultErrorEntry": { "type": "structure", "members": { - "SenderFault": { - "target": "com.amazonaws.sqs#Boolean", + "Code": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    Specifies whether the error happened due to the caller of the batch API action.

    ", + "smithy.api#documentation": "

    An error code representing why the action failed on this entry.

    ", "smithy.api#required": {} } }, - "Code": { + "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An error code representing why the action failed on this entry.

    ", + "smithy.api#documentation": "

    The Id of an entry in a batch request.

    ", "smithy.api#required": {} } }, - "Message": { - "target": "com.amazonaws.sqs#String", + "SenderFault": { + "target": "com.amazonaws.sqs#Boolean", "traits": { - "smithy.api#documentation": "

    A message explaining why the action failed on this entry.

    " + "smithy.api#documentation": "

    Specifies whether the error happened due to the caller of the batch API action.

    ", + "smithy.api#required": {} } }, - "Id": { + "Message": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The Id of an entry in a batch request.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A message explaining why the action failed on this entry.

    " } } }, @@ -310,6 +310,13 @@ "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequest": { "type": "structure", "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    The URL of the Amazon SQS queue whose messages' visibility is changed.

    \n

    Queue URLs and names are case-sensitive.

    ", + "smithy.api#required": {} + } + }, "Entries": { "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList", "traits": { @@ -318,13 +325,6 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" } - }, - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    The URL of the Amazon SQS queue whose messages' visibility is changed.

    \n

    Queue URLs and names are case-sensitive.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -334,13 +334,6 @@ "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry": { "type": "structure", "members": { - "ReceiptHandle": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    A receipt handle.

    ", - "smithy.api#required": {} - } - }, "VisibilityTimeout": { "target": "com.amazonaws.sqs#Integer", "traits": { @@ -353,6 +346,13 @@ "smithy.api#documentation": "

    An identifier for this particular receipt handle used to communicate the result.

    \n \n

    The Ids of a batch request need to be unique within a request.

    \n

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    \n     ", "smithy.api#required": {} } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    A receipt handle.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -415,24 +415,24 @@ "com.amazonaws.sqs#ChangeMessageVisibilityRequest": { "type": "structure", "members": { - "ReceiptHandle": { + "QueueUrl": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the \n ReceiveMessage\n action.

    ", + "smithy.api#documentation": "

    The URL of the Amazon SQS queue whose message's visibility is changed.

    \n

    Queue URLs and names are case-sensitive.

    ", "smithy.api#required": {} } }, "VisibilityTimeout": { "target": "com.amazonaws.sqs#Integer", "traits": { - "smithy.api#documentation": "

    The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.

    ", + "smithy.api#documentation": "

    The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.

    ", "smithy.api#required": {} } }, - "QueueUrl": { + "ReceiptHandle": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The URL of the Amazon SQS queue whose message's visibility is changed.

    \n

    Queue URLs and names are case-sensitive.

    ", + "smithy.api#documentation": "

    The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the \n ReceiveMessage\n action.

    ", "smithy.api#required": {} } } @@ -549,6 +549,13 @@ "com.amazonaws.sqs#DeleteMessageBatchRequest": { "type": "structure", "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    The URL of the Amazon SQS queue from which messages are deleted.

    \n

    Queue URLs and names are case-sensitive.

    ", + "smithy.api#required": {} + } + }, "Entries": { "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList", "traits": { @@ -557,13 +564,6 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" } - }, - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    The URL of the Amazon SQS queue from which messages are deleted.

    \n

    Queue URLs and names are case-sensitive.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -573,17 +573,17 @@ "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { "type": "structure", "members": { - "Id": { + "ReceiptHandle": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An identifier for this particular receipt handle. This is used to communicate the result.

    \n \n

    The Ids of a batch request need to be unique within a request.

    \n

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    \n     ", + "smithy.api#documentation": "

    A receipt handle.

    ", "smithy.api#required": {} } }, - "ReceiptHandle": { + "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    A receipt handle.

    ", + "smithy.api#documentation": "

    An identifier for this particular receipt handle. This is used to communicate the result.

    \n \n

    The Ids of a batch request need to be unique within a request.

    \n

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    \n     ", "smithy.api#required": {} } } @@ -601,22 +601,22 @@ "com.amazonaws.sqs#DeleteMessageBatchResult": { "type": "structure", "members": { - "Failed": { - "target": "com.amazonaws.sqs#BatchResultErrorEntryList", + "Successful": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", "traits": { - "smithy.api#documentation": "

    A list of \n BatchResultErrorEntry\n items.

    ", + "smithy.api#documentation": "

    A list of \n DeleteMessageBatchResultEntry\n items.

    ", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "BatchResultErrorEntry" + "smithy.api#xmlName": "DeleteMessageBatchResultEntry" } }, - "Successful": { - "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", + "Failed": { + "target": "com.amazonaws.sqs#BatchResultErrorEntryList", "traits": { - "smithy.api#documentation": "

    A list of \n DeleteMessageBatchResultEntry\n items.

    ", + "smithy.api#documentation": "

    A list of \n BatchResultErrorEntry\n items.

    ", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "DeleteMessageBatchResultEntry" + "smithy.api#xmlName": "BatchResultErrorEntry" } } }, @@ -858,7 +858,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

    \n \n \n

    For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon Simple Queue Service Developer Guide.

    ", + "smithy.api#documentation": "

    Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

    \n

    The ListDeadLetterSourceQueues 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 ListDeadLetterSourceQueues to receive the next page of results.

    \n \n

    For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon Simple Queue Service Developer Guide.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -877,17 +877,17 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.sqs#BoxedInteger", - "traits": { - "smithy.api#documentation": "

    Maximum number of results to include in the response.

    " - } - }, "NextToken": { "target": "com.amazonaws.sqs#Token", "traits": { "smithy.api#documentation": "

    Pagination token to request the next set of results.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

    Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.

    " + } } }, "traits": { @@ -897,12 +897,6 @@ "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sqs#Token", - "traits": { - "smithy.api#documentation": "

    Pagination token to include in the next request.

    " - } - }, "queueUrls": { "target": "com.amazonaws.sqs#QueueUrlList", "traits": { @@ -911,6 +905,12 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "QueueUrl" } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

    Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.

    " + } } }, "traits": { @@ -963,22 +963,22 @@ "target": "com.amazonaws.sqs#ListQueuesResult" }, "traits": { - "smithy.api#documentation": "

    Returns a list of your queues. The maximum number of queues that can be returned is 1,000. 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 \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", + "items": "QueueUrls", + "pageSize": "MaxResults" + } } }, "com.amazonaws.sqs#ListQueuesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.sqs#Token", - "traits": { - "smithy.api#documentation": "

    Pagination token to request the next set of results.

    " - } - }, "MaxResults": { "target": "com.amazonaws.sqs#BoxedInteger", "traits": { - "smithy.api#documentation": "

    Maximum number of results to include in the response.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.

    " } }, "QueueNamePrefix": { @@ -986,6 +986,12 @@ "traits": { "smithy.api#documentation": "

    A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

    \n

    Queue URLs and names are case-sensitive.

    " } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

    Pagination token to request the next set of results.

    " + } } }, "traits": { @@ -998,7 +1004,7 @@ "NextToken": { "target": "com.amazonaws.sqs#Token", "traits": { - "smithy.api#documentation": "

    Pagination token to include in the next request.

    " + "smithy.api#documentation": "

    Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.

    " } }, "QueueUrls": { @@ -1017,12 +1023,10 @@ "com.amazonaws.sqs#Message": { "type": "structure", "members": { - "MessageAttributes": { - "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "MD5OfBody": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "MessageAttribute" + "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message body string.

    " } }, "MD5OfMessageAttributes": { @@ -1051,16 +1055,18 @@ "smithy.api#documentation": "

    A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.

    " } }, - "MD5OfBody": { + "Body": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message body string.

    " + "smithy.api#documentation": "

    The message's contents (not URL-encoded).

    " } }, - "Body": { - "target": "com.amazonaws.sqs#String", + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { - "smithy.api#documentation": "

    The message's contents (not URL-encoded).

    " + "smithy.api#documentation": "

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" } } }, @@ -1080,18 +1086,6 @@ "com.amazonaws.sqs#MessageAttributeValue": { "type": "structure", "members": { - "StringValue": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    " - } - }, - "BinaryValue": { - "target": "com.amazonaws.sqs#Binary", - "traits": { - "smithy.api#documentation": "

    Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

    " - } - }, "BinaryListValues": { "target": "com.amazonaws.sqs#BinaryList", "traits": { @@ -1111,9 +1105,21 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    \n

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "smithy.api#documentation": "

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    \n

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", "smithy.api#required": {} } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "

    Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

    " + } + }, + "StringValue": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    " + } } }, "traits": { @@ -1224,6 +1230,19 @@ "com.amazonaws.sqs#MessageSystemAttributeValue": { "type": "structure", "members": { + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    \n

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "smithy.api#required": {} + } + }, + "StringValue": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    " + } + }, "BinaryListValues": { "target": "com.amazonaws.sqs#BinaryList", "traits": { @@ -1240,24 +1259,11 @@ "smithy.api#xmlName": "StringListValue" } }, - "DataType": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    \n

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", - "smithy.api#required": {} - } - }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { "smithy.api#documentation": "

    Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

    " } - }, - "StringValue": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    " - } } }, "traits": { @@ -1451,18 +1457,22 @@ "com.amazonaws.sqs#ReceiveMessageRequest": { "type": "structure", "members": { - "MessageAttributeNames": { - "target": "com.amazonaws.sqs#MessageAttributeNameList", + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#Integer", "traits": { - "smithy.api#documentation": "

    The name of the message attribute, where N is the index.

    \n
      \n
    • \n

      The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).

      \n
      • \n
    • \n

      The name is case-sensitive and must be unique among all attribute names for the message.

      \n
      • \n
    • \n

      The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).

      \n
      • \n
    • \n

      The name must not start or end with a period (.), and it should not have periods in succession (..).

      \n
      • \n
    • \n

      The name can be up to 256 characters long.

      \n
      • \n
    \n \n

    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. \n You can also use all message attributes starting with a prefix, for example bar.*.

    ", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "MessageAttributeName" + "smithy.api#documentation": "

    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

    " } }, - "WaitTimeSeconds": { + "ReceiveRequestAttemptId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

    \n
      \n
    • \n

      You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

      \n
      • \n
    • \n

      When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

      \n
      • \n
    • \n

      If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

      \n
      • \n
    • \n

      It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

      \n
      • \n
    • \n

      During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, \n it resets the visibility timeout. For more information, see\n Visibility Timeout\n in the Amazon Simple Queue Service Developer Guide.

      \n \n

      If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.

      \n

      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

      \n       \n
      • \n
    • \n

      While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive\n messages with another MessageGroupId as long as it is also visible.

      \n
      • \n
    • \n

      If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but\n the messages in the queue remain in a strict order.

      \n
      • \n
    \n

    The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    \n

    For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon Simple Queue Service Developer Guide.

    " + } + }, + "MaxNumberOfMessages": { "target": "com.amazonaws.sqs#Integer", "traits": { - "smithy.api#documentation": "

    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.\n If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

    \n \n

    To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage\n requests is longer than the WaitTimeSeconds parameter. For example,\n with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.

    \n     " + "smithy.api#documentation": "

    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

    " } }, "QueueUrl": { @@ -1472,6 +1482,12 @@ "smithy.api#required": {} } }, + "WaitTimeSeconds": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#documentation": "

    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.\n If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

    \n \n

    To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage\n requests is longer than the WaitTimeSeconds parameter. For example,\n with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.

    \n     " + } + }, "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { @@ -1480,22 +1496,12 @@ "smithy.api#xmlName": "AttributeName" } }, - "MaxNumberOfMessages": { - "target": "com.amazonaws.sqs#Integer", - "traits": { - "smithy.api#documentation": "

    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

    " - } - }, - "VisibilityTimeout": { - "target": "com.amazonaws.sqs#Integer", - "traits": { - "smithy.api#documentation": "

    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

    " - } - }, - "ReceiveRequestAttemptId": { - "target": "com.amazonaws.sqs#String", + "MessageAttributeNames": { + "target": "com.amazonaws.sqs#MessageAttributeNameList", "traits": { - "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

    \n
      \n
    • \n

      You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

      \n
      • \n
    • \n

      When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

      \n
      • \n
    • \n

      If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

      \n
      • \n
    • \n

      It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

      \n
      • \n
    • \n

      During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, \n it resets the visibility timeout. For more information, see\n Visibility Timeout\n in the Amazon Simple Queue Service Developer Guide.

      \n \n

      If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.

      \n

      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

      \n       \n
      • \n
    • \n

      While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive\n messages with another MessageGroupId as long as it is also visible.

      \n
      • \n
    • \n

      If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but\n the messages in the queue remain in a strict order.

      \n
      • \n
    \n

    The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    \n

    For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon Simple Queue Service Developer Guide.

    " + "smithy.api#documentation": "

    The name of the message attribute, where N is the index.

    \n
      \n
    • \n

      The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).

      \n
      • \n
    • \n

      The name is case-sensitive and must be unique among all attribute names for the message.

      \n
      • \n
    • \n

      The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).

      \n
      • \n
    • \n

      The name must not start or end with a period (.), and it should not have periods in succession (..).

      \n
      • \n
    • \n

      The name can be up to 256 characters long.

      \n
      • \n
    \n \n

    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. \n You can also use all message attributes starting with a prefix, for example bar.*.

    ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttributeName" } } }, @@ -1531,17 +1537,17 @@ "com.amazonaws.sqs#RemovePermissionRequest": { "type": "structure", "members": { - "QueueUrl": { + "Label": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The URL of the Amazon SQS queue from which permissions are removed.

    \n

    Queue URLs and names are case-sensitive.

    ", + "smithy.api#documentation": "

    The identification of the permission to remove. This is the label added using the \n AddPermission\n action.

    ", "smithy.api#required": {} } }, - "Label": { + "QueueUrl": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The identification of the permission to remove. This is the label added using the \n AddPermission\n action.

    ", + "smithy.api#documentation": "

    The URL of the Amazon SQS queue from which permissions are removed.

    \n

    Queue URLs and names are case-sensitive.

    ", "smithy.api#required": {} } } @@ -1629,10 +1635,10 @@ "com.amazonaws.sqs#SendMessageBatchRequestEntry": { "type": "structure", "members": { - "MessageBody": { + "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The body of the message.

    ", + "smithy.api#documentation": "

    An identifier for a message in this batch used to communicate the result.

    \n \n

    The Ids of a batch request need to be unique within a request.

    \n

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    \n     ", "smithy.api#required": {} } }, @@ -1642,19 +1648,10 @@ "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular \n MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are \n accepted successfully but aren't delivered. For more information, see \n Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

    \n
      \n
    • \n

      Every message must have a unique MessageDeduplicationId,

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId explicitly.

        \n
        • \n
      • \n

        If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n

        \n
        • \n
      • \n

        If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.

        \n
        • \n
      • \n

        If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

        \n
        • \n
      \n
      • \n
    • \n

      When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.

      \n
      • \n
    • \n

      If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n

      \n
      • \n
    \n \n

    The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

    \n

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    \n

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    \n     \n

    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    \n

    For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon Simple Queue Service Developer Guide.

    " } }, - "MessageAttributes": { - "target": "com.amazonaws.sqs#MessageBodyAttributeMap", - "traits": { - "smithy.api#documentation": "

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "MessageAttribute" - } - }, - "Id": { - "target": "com.amazonaws.sqs#String", + "DelaySeconds": { + "target": "com.amazonaws.sqs#Integer", "traits": { - "smithy.api#documentation": "

    An identifier for a message in this batch used to communicate the result.

    \n \n

    The Ids of a batch request need to be unique within a request.

    \n

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue is applied.\n

    \n \n

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

    \n     " } }, "MessageGroupId": { @@ -1671,10 +1668,19 @@ "smithy.api#xmlName": "MessageSystemAttribute" } }, - "DelaySeconds": { - "target": "com.amazonaws.sqs#Integer", + "MessageBody": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue is applied.\n

    \n \n

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

    \n     " + "smithy.api#documentation": "

    The body of the message.

    ", + "smithy.api#required": {} + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" } } }, @@ -1717,23 +1723,23 @@ "com.amazonaws.sqs#SendMessageBatchResultEntry": { "type": "structure", "members": { - "Id": { + "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An identifier for the message in this batch.

    ", + "smithy.api#documentation": "

    An identifier for the message.

    ", "smithy.api#required": {} } }, - "MD5OfMessageSystemAttributes": { + "MD5OfMessageAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " } }, - "MD5OfMessageAttributes": { + "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " } }, "MD5OfMessageBody": { @@ -1743,17 +1749,17 @@ "smithy.api#required": {} } }, - "SequenceNumber": { + "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The large, non-consecutive number that Amazon SQS assigns to each message.

    \n

    The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

    " + "smithy.api#documentation": "

    An identifier for the message in this batch.

    ", + "smithy.api#required": {} } }, - "MessageId": { + "SequenceNumber": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An identifier for the message.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The large, non-consecutive number that Amazon SQS assigns to each message.

    \n

    The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

    " } } }, @@ -1770,24 +1776,19 @@ "com.amazonaws.sqs#SendMessageRequest": { "type": "structure", "members": { - "MessageAttributes": { - "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "MessageSystemAttributes": { + "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", "traits": { - "smithy.api#documentation": "

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "smithy.api#documentation": "

    The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

    \n \n
      \n
    • \n

      Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n AWS X-Ray trace header string.

      \n
      • \n
    • \n

      The size of a message system attribute doesn't count towards the total size of a message.

      \n
      • \n
    \n     ", "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "MessageAttribute" - } - }, - "MessageGroupId": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

    \n
      \n
    • \n

      You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

      \n
      • \n
    • \n

      \n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.

      \n
      • \n
    \n

    The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    \n

    For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon Simple Queue Service Developer Guide.

    \n \n

    \n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

    \n     " + "smithy.api#xmlName": "MessageSystemAttribute" } }, - "MessageDeduplicationId": { + "QueueUrl": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

    \n
      \n
    • \n

      Every message must have a unique MessageDeduplicationId,

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId explicitly.

        \n
        • \n
      • \n

        If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n

        \n
        • \n
      • \n

        If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.

        \n
        • \n
      • \n

        If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

        \n
        • \n
      \n
      • \n
    • \n

      When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.

      \n
      • \n
    • \n

      If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n

      \n
      • \n
    \n \n

    The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

    \n

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    \n

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    \n     \n

    The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    \n

    For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon Simple Queue Service Developer Guide.

    " + "smithy.api#documentation": "

    The URL of the Amazon SQS queue to which a message is sent.

    \n

    Queue URLs and names are case-sensitive.

    ", + "smithy.api#required": {} } }, "DelaySeconds": { @@ -1796,26 +1797,31 @@ "smithy.api#documentation": "

    \n The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue applies.\n

    \n \n

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

    \n     " } }, - "QueueUrl": { + "MessageBody": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The URL of the Amazon SQS queue to which a message is sent.

    \n

    Queue URLs and names are case-sensitive.

    ", + "smithy.api#documentation": "

    The message to send. The minimum size is one character. The maximum size is 256 KB.

    \n \n

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    \n

    \n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

    \n\t

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    \n     ", "smithy.api#required": {} } }, - "MessageSystemAttributes": { - "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { - "smithy.api#documentation": "

    The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

    \n \n
      \n
    • \n

      Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n AWS X-Ray trace header string.

      \n
      • \n
    • \n

      The size of a message system attribute doesn't count towards the total size of a message.

      \n
      • \n
    \n     ", + "smithy.api#documentation": "

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "MessageSystemAttribute" + "smithy.api#xmlName": "MessageAttribute" } }, - "MessageBody": { + "MessageDeduplicationId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The message to send. The maximum string size is 256 KB.

    \n \n

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    \n

    \n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

    \n\t

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

    \n
      \n
    • \n

      Every message must have a unique MessageDeduplicationId,

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId explicitly.

        \n
        • \n
      • \n

        If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n

        \n
        • \n
      • \n

        If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.

        \n
        • \n
      • \n

        If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

        \n
        • \n
      \n
      • \n
    • \n

      When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.

      \n
      • \n
    • \n

      If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n

      \n
      • \n
    \n \n

    The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

    \n

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    \n

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    \n     \n

    The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    \n

    For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon Simple Queue Service Developer Guide.

    " + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

    \n
      \n
    • \n

      You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

      \n
      • \n
    • \n

      \n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.

      \n
      • \n
    \n

    The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    \n

    For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon Simple Queue Service Developer Guide.

    \n \n

    \n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

    \n     " } } }, @@ -1826,16 +1832,16 @@ "com.amazonaws.sqs#SendMessageResult": { "type": "structure", "members": { - "MD5OfMessageSystemAttributes": { + "MD5OfMessageBody": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

    " + "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " } }, - "SequenceNumber": { + "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The large, non-consecutive number that Amazon SQS assigns to each message.

    \n

    The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

    " + "smithy.api#documentation": "

    An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers\n in the Amazon Simple Queue Service Developer Guide.\n

    " } }, "MD5OfMessageAttributes": { @@ -1844,16 +1850,16 @@ "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " } }, - "MD5OfMessageBody": { + "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + "smithy.api#documentation": "

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

    " } }, - "MessageId": { + "SequenceNumber": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers\n in the Amazon Simple Queue Service Developer Guide.\n

    " + "smithy.api#documentation": "

    This parameter applies only to FIFO (first-in-first-out) queues.

    \n

    The large, non-consecutive number that Amazon SQS assigns to each message.

    \n

    The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

    " } } }, @@ -2001,13 +2007,6 @@ "com.amazonaws.sqs#UntagQueueRequest": { "type": "structure", "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "

    The URL of the queue.

    ", - "smithy.api#required": {} - } - }, "TagKeys": { "target": "com.amazonaws.sqs#TagKeyList", "traits": { @@ -2016,6 +2015,13 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "TagKey" } + }, + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

    The URL of the queue.

    ", + "smithy.api#required": {} + } } } } 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 a1428c00a48f..b089e4dd93d1 100644 --- a/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json +++ b/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json @@ -100,22 +100,34 @@ "com.amazonaws.ssm#Activation": { "type": "structure", "members": { + "IamRole": { + "target": "com.amazonaws.ssm#IamRole", + "traits": { + "smithy.api#documentation": "

    The Amazon Identity and Access Management (IAM) role to assign to the managed\n instance.

    " + } + }, + "DefaultInstanceName": { + "target": "com.amazonaws.ssm#DefaultInstanceName", + "traits": { + "smithy.api#documentation": "

    A name for the managed instance when it is created.

    " + } + }, "Description": { "target": "com.amazonaws.ssm#ActivationDescription", "traits": { "smithy.api#documentation": "

    A user defined description of the activation.

    " } }, - "RegistrationLimit": { - "target": "com.amazonaws.ssm#RegistrationLimit", + "ActivationId": { + "target": "com.amazonaws.ssm#ActivationId", "traits": { - "smithy.api#documentation": "

    The maximum number of managed instances that can be registered using this activation.

    " + "smithy.api#documentation": "

    The ID created by Systems Manager when you submitted the activation.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.ssm#CreatedDate", + "Tags": { + "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

    The date the activation was created.

    " + "smithy.api#documentation": "

    Tags assigned to the activation.

    " } }, "ExpirationDate": { @@ -124,10 +136,10 @@ "smithy.api#documentation": "

    The date when this activation can no longer be used to register managed instances.

    " } }, - "DefaultInstanceName": { - "target": "com.amazonaws.ssm#DefaultInstanceName", + "RegistrationLimit": { + "target": "com.amazonaws.ssm#RegistrationLimit", "traits": { - "smithy.api#documentation": "

    A name for the managed instance when it is created.

    " + "smithy.api#documentation": "

    The maximum number of managed instances that can be registered using this activation.

    " } }, "Expired": { @@ -136,16 +148,10 @@ "smithy.api#documentation": "

    Whether or not the activation is expired.

    " } }, - "ActivationId": { - "target": "com.amazonaws.ssm#ActivationId", - "traits": { - "smithy.api#documentation": "

    The ID created by Systems Manager when you submitted the activation.

    " - } - }, - "Tags": { - "target": "com.amazonaws.ssm#TagList", + "CreatedDate": { + "target": "com.amazonaws.ssm#CreatedDate", "traits": { - "smithy.api#documentation": "

    Tags assigned to the activation.

    " + "smithy.api#documentation": "

    The date the activation was created.

    " } }, "RegistrationsCount": { @@ -153,12 +159,6 @@ "traits": { "smithy.api#documentation": "

    The number of managed instances already registered with this activation.

    " } - }, - "IamRole": { - "target": "com.amazonaws.ssm#IamRole", - "traits": { - "smithy.api#documentation": "

    The Amazon Identity and Access Management (IAM) role to assign to the managed\n instance.

    " - } } }, "traits": { @@ -227,13 +227,6 @@ "com.amazonaws.ssm#AddTagsToResourceRequest": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.ssm#ResourceTypeForTagging", - "traits": { - "smithy.api#documentation": "

    Specifies the type of resource you are tagging.

    \n \n

    The ManagedInstance type for this API action is for on-premises managed instances. You must\n specify the name of the managed instance in the following format: mi-ID_number. For example,\n mi-1a2b3c4d5e6f.

    \n     ", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.ssm#TagList", "traits": { @@ -247,6 +240,13 @@ "smithy.api#documentation": "

    The resource ID you want to tag.

    \n

    Use the ID of the resource. Here are some examples:

    \n

    ManagedInstance: mi-012345abcde

    \n

    MaintenanceWindow: mw-012345abcde

    \n

    PatchBaseline: pb-012345abcde

    \n

    For the Document and Parameter values, use the name of the resource.

    \n \n

    The ManagedInstance type for this API action is only for on-premises managed instances. You\n must specify the name of the managed instance in the following format: mi-ID_number. For\n example, mi-1a2b3c4d5e6f.

    \n     ", "smithy.api#required": {} } + }, + "ResourceType": { + "target": "com.amazonaws.ssm#ResourceTypeForTagging", + "traits": { + "smithy.api#documentation": "

    Specifies the type of resource you are tagging.

    \n \n

    The ManagedInstance type for this API action is for on-premises managed instances. You must\n specify the name of the managed instance in the following format: mi-ID_number. For example,\n mi-1a2b3c4d5e6f.

    \n     ", + "smithy.api#required": {} + } } } }, @@ -663,7 +663,7 @@ "sdkId": "SSM", "arnNamespace": "ssm", "cloudFormationName": "SSM", - "cloudTrailEventSource": "ssm.services.amazonaws.com" + "cloudTrailEventSource": "ssm.amazonaws.com" }, "aws.auth#sigv4": { "name": "ssm" @@ -699,16 +699,22 @@ "com.amazonaws.ssm#Association": { "type": "structure", "members": { + "Overview": { + "target": "com.amazonaws.ssm#AssociationOverview", + "traits": { + "smithy.api#documentation": "

    Information about the association.

    " + } + }, "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { "smithy.api#documentation": "

    The instances targeted by the request to create an association.

    " } }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The ID of the instance.

    " + "smithy.api#documentation": "

    The version of the document used in the association.

    " } }, "AssociationVersion": { @@ -717,22 +723,10 @@ "smithy.api#documentation": "

    The association version.

    " } }, - "AssociationId": { - "target": "com.amazonaws.ssm#AssociationId", - "traits": { - "smithy.api#documentation": "

    The ID created by the system when you create an association. An association is a binding\n between a document and a set of targets with a schedule.

    " - } - }, - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", - "traits": { - "smithy.api#documentation": "

    The name of the Systems Manager document.

    " - } - }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The version of the document used in the association.

    " + "smithy.api#documentation": "

    The ID of the instance.

    " } }, "ScheduleExpression": { @@ -753,10 +747,16 @@ "smithy.api#documentation": "

    The date on which the association was last run.

    " } }, - "Overview": { - "target": "com.amazonaws.ssm#AssociationOverview", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    Information about the association.

    " + "smithy.api#documentation": "

    The name of the Systems Manager document.

    " + } + }, + "AssociationId": { + "target": "com.amazonaws.ssm#AssociationId", + "traits": { + "smithy.api#documentation": "

    The ID created by the system when you create an association. An association is a binding\n between a document and a set of targets with a schedule.

    " } } }, @@ -802,34 +802,22 @@ "com.amazonaws.ssm#AssociationDescription": { "type": "structure", "members": { - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", - "traits": { - "smithy.api#documentation": "

    The document version.

    " - } - }, - "OutputLocation": { - "target": "com.amazonaws.ssm#InstanceAssociationOutputLocation", - "traits": { - "smithy.api#documentation": "

    An S3 bucket where you want to store the output details of the request.

    " - } - }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "LastSuccessfulExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The ID of the instance.

    " + "smithy.api#documentation": "

    The last date on which the association was successfully run.

    " } }, - "LastExecutionDate": { - "target": "com.amazonaws.ssm#DateTime", + "Parameters": { + "target": "com.amazonaws.ssm#Parameters", "traits": { - "smithy.api#documentation": "

    The date on which the association was last run.

    " + "smithy.api#documentation": "

    A description of the parameters for a document.

    " } }, - "AssociationId": { - "target": "com.amazonaws.ssm#AssociationId", + "ScheduleExpression": { + "target": "com.amazonaws.ssm#ScheduleExpression", "traits": { - "smithy.api#documentation": "

    The association ID.

    " + "smithy.api#documentation": "

    A cron expression that specifies a schedule when the association runs.

    " } }, "MaxErrors": { @@ -838,28 +826,28 @@ "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " } }, - "AutomationTargetParameterName": { - "target": "com.amazonaws.ssm#AutomationTargetParameterName", + "Status": { + "target": "com.amazonaws.ssm#AssociationStatus", "traits": { - "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " + "smithy.api#documentation": "

    The association status.

    " } }, - "ScheduleExpression": { - "target": "com.amazonaws.ssm#ScheduleExpression", + "Overview": { + "target": "com.amazonaws.ssm#AssociationOverview", "traits": { - "smithy.api#documentation": "

    A cron expression that specifies a schedule when the association runs.

    " + "smithy.api#documentation": "

    Information about the association.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", + "AssociationVersion": { + "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "

    The name of the Systems Manager document.

    " + "smithy.api#documentation": "

    The association version.

    " } }, - "ComplianceSeverity": { - "target": "com.amazonaws.ssm#AssociationComplianceSeverity", + "LastUpdateAssociationDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The severity level that is assigned to the association.

    " + "smithy.api#documentation": "

    The date when the association was last updated.

    " } }, "AssociationName": { @@ -868,40 +856,40 @@ "smithy.api#documentation": "

    The association name.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "ComplianceSeverity": { + "target": "com.amazonaws.ssm#AssociationComplianceSeverity", "traits": { - "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " + "smithy.api#documentation": "

    The severity level that is assigned to the association.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#AssociationStatus", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The association status.

    " + "smithy.api#documentation": "

    The ID of the instance.

    " } }, - "AssociationVersion": { - "target": "com.amazonaws.ssm#AssociationVersion", + "AssociationId": { + "target": "com.amazonaws.ssm#AssociationId", "traits": { - "smithy.api#documentation": "

    The association version.

    " + "smithy.api#documentation": "

    The association ID.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#Parameters", + "AutomationTargetParameterName": { + "target": "com.amazonaws.ssm#AutomationTargetParameterName", "traits": { - "smithy.api#documentation": "

    A description of the parameters for a document.

    " + "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " } }, - "LastUpdateAssociationDate": { - "target": "com.amazonaws.ssm#DateTime", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The date when the association was last updated.

    " + "smithy.api#documentation": "

    The document version.

    " } }, - "ApplyOnlyAtCronInterval": { - "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", + "LastExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", "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.

    " + "smithy.api#documentation": "

    The date on which the association was last run.

    " } }, "SyncCompliance": { @@ -916,16 +904,28 @@ "smithy.api#documentation": "

    The instances targeted by the request.

    " } }, - "LastSuccessfulExecutionDate": { - "target": "com.amazonaws.ssm#DateTime", + "OutputLocation": { + "target": "com.amazonaws.ssm#InstanceAssociationOutputLocation", "traits": { - "smithy.api#documentation": "

    The last date on which the association was successfully run.

    " + "smithy.api#documentation": "

    An S3 bucket where you want to store the output details of the request.

    " } }, - "Overview": { - "target": "com.amazonaws.ssm#AssociationOverview", + "ApplyOnlyAtCronInterval": { + "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", "traits": { - "smithy.api#documentation": "

    Information about the association.

    " + "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.

    " + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", + "traits": { + "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " + } + }, + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", + "traits": { + "smithy.api#documentation": "

    The name of the Systems Manager document.

    " } }, "Date": { @@ -963,16 +963,10 @@ "com.amazonaws.ssm#AssociationExecution": { "type": "structure", "members": { - "ResourceCountByStatus": { - "target": "com.amazonaws.ssm#ResourceCountByStatus", - "traits": { - "smithy.api#documentation": "

    An aggregate status of the resources in the execution based on the status type.

    " - } - }, - "DetailedStatus": { - "target": "com.amazonaws.ssm#StatusName", + "AssociationId": { + "target": "com.amazonaws.ssm#AssociationId", "traits": { - "smithy.api#documentation": "

    Detailed status information about the execution.

    " + "smithy.api#documentation": "

    The association ID.

    " } }, "AssociationVersion": { @@ -981,10 +975,16 @@ "smithy.api#documentation": "

    The association version.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#StatusName", + "ExecutionId": { + "target": "com.amazonaws.ssm#AssociationExecutionId", "traits": { - "smithy.api#documentation": "

    The status of the association execution.

    " + "smithy.api#documentation": "

    The execution ID for the association.

    " + } + }, + "ResourceCountByStatus": { + "target": "com.amazonaws.ssm#ResourceCountByStatus", + "traits": { + "smithy.api#documentation": "

    An aggregate status of the resources in the execution based on the status type.

    " } }, "CreatedTime": { @@ -993,22 +993,22 @@ "smithy.api#documentation": "

    The time the execution started.

    " } }, - "LastExecutionDate": { - "target": "com.amazonaws.ssm#DateTime", + "DetailedStatus": { + "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "

    The date of the last execution.

    " + "smithy.api#documentation": "

    Detailed status information about the execution.

    " } }, - "AssociationId": { - "target": "com.amazonaws.ssm#AssociationId", + "Status": { + "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "

    The association ID.

    " + "smithy.api#documentation": "

    The status of the association execution.

    " } }, - "ExecutionId": { - "target": "com.amazonaws.ssm#AssociationExecutionId", + "LastExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The execution ID for the association.

    " + "smithy.api#documentation": "

    The date of the last execution.

    " } } }, @@ -1038,17 +1038,17 @@ "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.ssm#AssociationExecutionFilterValue", + "Key": { + "target": "com.amazonaws.ssm#AssociationExecutionFilterKey", "traits": { - "smithy.api#documentation": "

    The value specified for the key.

    ", + "smithy.api#documentation": "

    The key value used in the request.

    ", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.ssm#AssociationExecutionFilterKey", + "Value": { + "target": "com.amazonaws.ssm#AssociationExecutionFilterValue", "traits": { - "smithy.api#documentation": "

    The key value used in the request.

    ", + "smithy.api#documentation": "

    The value specified for the key.

    ", "smithy.api#required": {} } } @@ -1107,22 +1107,22 @@ "com.amazonaws.ssm#AssociationExecutionTarget": { "type": "structure", "members": { - "DetailedStatus": { - "target": "com.amazonaws.ssm#StatusName", - "traits": { - "smithy.api#documentation": "

    Detailed information about the execution status.

    " - } - }, "AssociationId": { "target": "com.amazonaws.ssm#AssociationId", "traits": { "smithy.api#documentation": "

    The association ID.

    " } }, - "AssociationVersion": { - "target": "com.amazonaws.ssm#AssociationVersion", + "DetailedStatus": { + "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "

    The association version.

    " + "smithy.api#documentation": "

    Detailed information about the execution status.

    " + } + }, + "OutputSource": { + "target": "com.amazonaws.ssm#OutputSource", + "traits": { + "smithy.api#documentation": "

    The location where the association details are saved.

    " } }, "ResourceId": { @@ -1131,22 +1131,22 @@ "smithy.api#documentation": "

    The resource ID, for example, the instance ID where the association ran.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#StatusName", + "ResourceType": { + "target": "com.amazonaws.ssm#AssociationResourceType", "traits": { - "smithy.api#documentation": "

    The association execution status.

    " + "smithy.api#documentation": "

    The resource type, for example, instance.

    " } }, - "LastExecutionDate": { - "target": "com.amazonaws.ssm#DateTime", + "AssociationVersion": { + "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "

    The date of the last execution.

    " + "smithy.api#documentation": "

    The association version.

    " } }, - "ResourceType": { - "target": "com.amazonaws.ssm#AssociationResourceType", + "Status": { + "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "

    The resource type, for example, instance.

    " + "smithy.api#documentation": "

    The association execution status.

    " } }, "ExecutionId": { @@ -1155,10 +1155,10 @@ "smithy.api#documentation": "

    The execution ID.

    " } }, - "OutputSource": { - "target": "com.amazonaws.ssm#OutputSource", + "LastExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The location where the association details are saved.

    " + "smithy.api#documentation": "

    The date of the last execution.

    " } } }, @@ -1399,16 +1399,16 @@ "smithy.api#documentation": "

    Returns the number of targets for the association status. For example, if you created an\n association with two instances, and one of them was successful, this would return the count of\n instances by status.

    " } }, - "Status": { + "DetailedStatus": { "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "

    The status of the association. Status can be: Pending, Success, or Failed.

    " + "smithy.api#documentation": "

    A detailed status of the association.

    " } }, - "DetailedStatus": { + "Status": { "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "

    A detailed status of the association.

    " + "smithy.api#documentation": "

    The status of the association. Status can be: Pending, Success, or Failed.

    " } } }, @@ -1444,10 +1444,10 @@ "smithy.api#required": {} } }, - "Date": { - "target": "com.amazonaws.ssm#DateTime", + "Message": { + "target": "com.amazonaws.ssm#StatusMessage", "traits": { - "smithy.api#documentation": "

    The date when the status changed.

    ", + "smithy.api#documentation": "

    The reason for the status.

    ", "smithy.api#required": {} } }, @@ -1457,10 +1457,10 @@ "smithy.api#documentation": "

    A user-defined string.

    " } }, - "Message": { - "target": "com.amazonaws.ssm#StatusMessage", + "Date": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The reason for the status.

    ", + "smithy.api#documentation": "

    The date when the status changed.

    ", "smithy.api#required": {} } } @@ -1521,34 +1521,34 @@ "com.amazonaws.ssm#AssociationVersionInfo": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", + "OutputLocation": { + "target": "com.amazonaws.ssm#InstanceAssociationOutputLocation", "traits": { - "smithy.api#documentation": "

    The name specified when the association was created.

    " + "smithy.api#documentation": "

    The location in Amazon S3 specified for the association when the association version was\n created.

    " } }, - "AssociationVersion": { - "target": "com.amazonaws.ssm#AssociationVersion", + "AssociationId": { + "target": "com.amazonaws.ssm#AssociationId", "traits": { - "smithy.api#documentation": "

    The association version.

    " + "smithy.api#documentation": "

    The ID created by the system when the association was created.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.ssm#DateTime", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The date the association version was created.

    " + "smithy.api#documentation": "

    The version of a Systems Manager document used when the association version was created.

    " } }, - "ComplianceSeverity": { - "target": "com.amazonaws.ssm#AssociationComplianceSeverity", + "SyncCompliance": { + "target": "com.amazonaws.ssm#AssociationSyncCompliance", "traits": { - "smithy.api#documentation": "

    The severity level that is assigned to the association.

    " + "smithy.api#documentation": "

    The mode for generating association compliance. You can specify AUTO or\n MANUAL. In AUTO mode, the system uses the status of the association\n execution to determine the compliance status. If the association execution runs successfully,\n then the association is COMPLIANT. If the association execution doesn't run\n successfully, the association is NON-COMPLIANT.

    \n

    In MANUAL mode, you must specify the AssociationId as a parameter\n for the PutComplianceItems API action. In this case, compliance data is not\n managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

    \n

    By default, all associations use AUTO mode.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "ApplyOnlyAtCronInterval": { + "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", "traits": { - "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " + "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.

    " } }, "ScheduleExpression": { @@ -1563,52 +1563,52 @@ "smithy.api#documentation": "

    The name specified for the association version when the association version was\n created.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#Parameters", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    Parameters specified when the association version was created.

    " + "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " } }, - "ApplyOnlyAtCronInterval": { - "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "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.

    " + "smithy.api#documentation": "

    The name specified when the association was created.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "AssociationVersion": { + "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " + "smithy.api#documentation": "

    The association version.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "CreatedDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The version of a Systems Manager document used when the association version was created.

    " + "smithy.api#documentation": "

    The date the association version was created.

    " } }, - "OutputLocation": { - "target": "com.amazonaws.ssm#InstanceAssociationOutputLocation", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The location in Amazon S3 specified for the association when the association version was\n created.

    " + "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "Parameters": { + "target": "com.amazonaws.ssm#Parameters", "traits": { - "smithy.api#documentation": "

    The targets specified for the association when the association version was created.

    " + "smithy.api#documentation": "

    Parameters specified when the association version was created.

    " } }, - "SyncCompliance": { - "target": "com.amazonaws.ssm#AssociationSyncCompliance", + "ComplianceSeverity": { + "target": "com.amazonaws.ssm#AssociationComplianceSeverity", "traits": { - "smithy.api#documentation": "

    The mode for generating association compliance. You can specify AUTO or\n MANUAL. In AUTO mode, the system uses the status of the association\n execution to determine the compliance status. If the association execution runs successfully,\n then the association is COMPLIANT. If the association execution doesn't run\n successfully, the association is NON-COMPLIANT.

    \n

    In MANUAL mode, you must specify the AssociationId as a parameter\n for the PutComplianceItems API action. In this case, compliance data is not\n managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

    \n

    By default, all associations use AUTO mode.

    " + "smithy.api#documentation": "

    The severity level that is assigned to the association.

    " } }, - "AssociationId": { - "target": "com.amazonaws.ssm#AssociationId", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The ID created by the system when the association was created.

    " + "smithy.api#documentation": "

    The targets specified for the association when the association version was created.

    " } } }, @@ -1648,18 +1648,18 @@ "smithy.api#documentation": "

    The name of an attachment.

    " } }, - "Hash": { - "target": "com.amazonaws.ssm#AttachmentHash", - "traits": { - "smithy.api#documentation": "

    The cryptographic hash value of the document content.

    " - } - }, "Url": { "target": "com.amazonaws.ssm#AttachmentUrl", "traits": { "smithy.api#documentation": "

    The URL location of the attachment content.

    " } }, + "Hash": { + "target": "com.amazonaws.ssm#AttachmentHash", + "traits": { + "smithy.api#documentation": "

    The cryptographic hash value of the document content.

    " + } + }, "HashType": { "target": "com.amazonaws.ssm#AttachmentHashType", "traits": { @@ -1747,6 +1747,12 @@ "com.amazonaws.ssm#AttachmentsSource": { "type": "structure", "members": { + "Values": { + "target": "com.amazonaws.ssm#AttachmentsSourceValues", + "traits": { + "smithy.api#documentation": "

    The value of a key-value pair that identifies the location of an attachment to a document.\n The format for Value depends on the type of key you\n specify.

    \n
      \n
    • \n

      For the key SourceUrl, the value is an S3 bucket location. For\n example:

      \n

      \n \"Values\": [ \"s3://doc-example-bucket/my-folder\" ]\n

      \n
      • \n
    • \n

      For the key S3FileUrl, the value is a file in an S3 bucket. For\n example:

      \n

      \n \"Values\": [ \"s3://doc-example-bucket/my-folder/my-file.py\" ]\n

      \n
      • \n
    • \n

      For the key AttachmentReference, the value is constructed from the\n name of another SSM document in your account, a version number of that document, and a file\n attached to that document version that you want to reuse. For example:

      \n

      \n \"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]\n

      \n

      However, if the SSM document is shared with you from another account, the full SSM\n document ARN must be specified instead of the document name only. For example:

      \n

      \n \"Values\": [\n \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\"\n ]\n

      \n
      • \n
    " + } + }, "Name": { "target": "com.amazonaws.ssm#AttachmentIdentifier", "traits": { @@ -1758,12 +1764,6 @@ "traits": { "smithy.api#documentation": "

    The key of a key-value pair that identifies the location of an attachment to a\n document.

    " } - }, - "Values": { - "target": "com.amazonaws.ssm#AttachmentsSourceValues", - "traits": { - "smithy.api#documentation": "

    The value of a key-value pair that identifies the location of an attachment to a document.\n The format for Value depends on the type of key you\n specify.

    \n
      \n
    • \n

      For the key SourceUrl, the value is an S3 bucket location. For\n example:

      \n

      \n \"Values\": [ \"s3://my-bucket/my-folder\" ]\n

      \n
      • \n
    • \n

      For the key S3FileUrl, the value is a file in an S3 bucket. For\n example:

      \n

      \n \"Values\": [ \"s3://my-bucket/my-folder/my-file.py\" ]\n

      \n
      • \n
    • \n

      For the key AttachmentReference, the value is constructed from the\n name of another SSM document in your account, a version number of that document, and a file\n attached to that document version that you want to reuse. For example:

      \n

      \n \"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]\n

      \n

      However, if the SSM document is shared with you from another account, the full SSM\n document ARN must be specified instead of the document name only. For example:

      \n

      \n \"Values\": [\n \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\"\n ]\n

      \n
      • \n
    " - } } }, "traits": { @@ -1873,28 +1873,22 @@ "com.amazonaws.ssm#AutomationExecution": { "type": "structure", "members": { - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", - "traits": { - "smithy.api#documentation": "

    The MaxErrors value specified by the user when the execution started.

    " - } - }, - "ResolvedTargets": { - "target": "com.amazonaws.ssm#ResolvedTargets", + "StepExecutionsTruncated": { + "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#documentation": "

    A list of resolved targets in the rate control execution.

    " + "smithy.api#documentation": "

    A boolean value that indicates if the response contains the full list of the Automation step\n executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of\n step executions.

    " } }, - "ExecutionStartTime": { - "target": "com.amazonaws.ssm#DateTime", + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    The time the execution started.

    " + "smithy.api#documentation": "

    The name of the Automation document used during the execution.

    " } }, - "CurrentAction": { + "ExecutedBy": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The action of the step that is currently running.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the user who ran the automation.

    " } }, "TargetLocations": { @@ -1903,28 +1897,28 @@ "smithy.api#documentation": "

    The combination of AWS Regions and/or AWS accounts where you want to run the\n Automation.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "ExecutionStartTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The version of the document to use during execution.

    " + "smithy.api#documentation": "

    The time the execution started.

    " } }, - "FailureMessage": { - "target": "com.amazonaws.ssm#String", + "Outputs": { + "target": "com.amazonaws.ssm#AutomationParameterMap", "traits": { - "smithy.api#documentation": "

    A message describing why an execution has failed, if the status is set to Failed.

    " + "smithy.api#documentation": "

    The list of execution outputs as defined in the automation document.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "ParentAutomationExecutionId": { + "target": "com.amazonaws.ssm#AutomationExecutionId", "traits": { - "smithy.api#documentation": "

    The specified targets.

    " + "smithy.api#documentation": "

    The AutomationExecutionId of the parent automation.

    " } }, - "TargetParameterName": { - "target": "com.amazonaws.ssm#AutomationParameterKey", + "CurrentStepName": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The parameter name.

    " + "smithy.api#documentation": "

    The name of the step that is currently running.

    " } }, "TargetMaps": { @@ -1933,28 +1927,34 @@ "smithy.api#documentation": "

    The specified key-value mapping of document parameters to target resources.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#AutomationParameterMap", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The key-value map of execution parameters, which were supplied when calling\n StartAutomationExecution.

    " + "smithy.api#documentation": "

    The MaxConcurrency value specified by the user when the execution started.

    " } }, - "Outputs": { + "TargetParameterName": { + "target": "com.amazonaws.ssm#AutomationParameterKey", + "traits": { + "smithy.api#documentation": "

    The parameter name.

    " + } + }, + "Parameters": { "target": "com.amazonaws.ssm#AutomationParameterMap", "traits": { - "smithy.api#documentation": "

    The list of execution outputs as defined in the automation document.

    " + "smithy.api#documentation": "

    The key-value map of execution parameters, which were supplied when calling\n StartAutomationExecution.

    " } }, - "CurrentStepName": { - "target": "com.amazonaws.ssm#String", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The name of the step that is currently running.

    " + "smithy.api#documentation": "

    The specified targets.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "ResolvedTargets": { + "target": "com.amazonaws.ssm#ResolvedTargets", "traits": { - "smithy.api#documentation": "

    The MaxConcurrency value specified by the user when the execution started.

    " + "smithy.api#documentation": "

    A list of resolved targets in the rate control execution.

    " } }, "Mode": { @@ -1963,34 +1963,34 @@ "smithy.api#documentation": "

    The automation execution mode.

    " } }, - "ParentAutomationExecutionId": { - "target": "com.amazonaws.ssm#AutomationExecutionId", + "FailureMessage": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The AutomationExecutionId of the parent automation.

    " + "smithy.api#documentation": "

    A message describing why an execution has failed, if the status is set to Failed.

    " } }, - "DocumentName": { - "target": "com.amazonaws.ssm#DocumentName", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The name of the Automation document used during the execution.

    " + "smithy.api#documentation": "

    The version of the document to use during execution.

    " } }, - "ExecutedBy": { + "CurrentAction": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the user who ran the automation.

    " + "smithy.api#documentation": "

    The action of the step that is currently running.

    " } }, - "StepExecutionsTruncated": { - "target": "com.amazonaws.ssm#Boolean", + "StepExecutions": { + "target": "com.amazonaws.ssm#StepExecutionList", "traits": { - "smithy.api#documentation": "

    A boolean value that indicates if the response contains the full list of the Automation step\n executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of\n step executions.

    " + "smithy.api#documentation": "

    A list of details about the current state of all steps that comprise an execution. An\n Automation document contains a list of steps that are run in order.

    " } }, - "AutomationExecutionStatus": { - "target": "com.amazonaws.ssm#AutomationExecutionStatus", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    The execution status of the Automation.

    " + "smithy.api#documentation": "

    The MaxErrors value specified by the user when the execution started.

    " } }, "AutomationExecutionId": { @@ -1999,18 +1999,6 @@ "smithy.api#documentation": "

    The execution ID.

    " } }, - "Target": { - "target": "com.amazonaws.ssm#String", - "traits": { - "smithy.api#documentation": "

    The target of the execution.

    " - } - }, - "StepExecutions": { - "target": "com.amazonaws.ssm#StepExecutionList", - "traits": { - "smithy.api#documentation": "

    A list of details about the current state of all steps that comprise an execution. An\n Automation document contains a list of steps that are run in order.

    " - } - }, "ExecutionEndTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { @@ -2022,6 +2010,18 @@ "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.

    " } + }, + "Target": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

    The target of the execution.

    " + } + }, + "AutomationExecutionStatus": { + "target": "com.amazonaws.ssm#AutomationExecutionStatus", + "traits": { + "smithy.api#documentation": "

    The execution status of the Automation.

    " + } } }, "traits": { @@ -2031,17 +2031,17 @@ "com.amazonaws.ssm#AutomationExecutionFilter": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.ssm#AutomationExecutionFilterKey", + "Values": { + "target": "com.amazonaws.ssm#AutomationExecutionFilterValueList", "traits": { - "smithy.api#documentation": "

    One or more keys to limit the results. Valid filter keys include the following:\n DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction,\n StartTimeBefore, StartTimeAfter.

    ", + "smithy.api#documentation": "

    The values used to limit the execution information associated with the filter's key.

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.ssm#AutomationExecutionFilterValueList", + "Key": { + "target": "com.amazonaws.ssm#AutomationExecutionFilterKey", "traits": { - "smithy.api#documentation": "

    The values used to limit the execution information associated with the filter's key.

    ", + "smithy.api#documentation": "

    One or more keys to limit the results. Valid filter keys include the following:\n DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction,\n StartTimeBefore, StartTimeAfter.

    ", "smithy.api#required": {} } } @@ -2150,70 +2150,76 @@ "com.amazonaws.ssm#AutomationExecutionMetadata": { "type": "structure", "members": { - "ParentAutomationExecutionId": { - "target": "com.amazonaws.ssm#AutomationExecutionId", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The ExecutionId of the parent Automation.

    " + "smithy.api#documentation": "

    The targets defined by the user when starting the Automation.

    " } }, - "AutomationExecutionId": { - "target": "com.amazonaws.ssm#AutomationExecutionId", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The execution ID.

    " + "smithy.api#documentation": "

    The document version used during the execution.

    " } }, - "ResolvedTargets": { - "target": "com.amazonaws.ssm#ResolvedTargets", + "FailureMessage": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    A list of targets that resolved during the execution.

    " + "smithy.api#documentation": "

    The list of execution outputs as defined in the Automation document.

    " } }, - "AutomationType": { - "target": "com.amazonaws.ssm#AutomationType", + "Mode": { + "target": "com.amazonaws.ssm#ExecutionMode", "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.

    " + "smithy.api#documentation": "

    The Automation execution mode.

    " } }, - "ExecutedBy": { - "target": "com.amazonaws.ssm#String", + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", "traits": { - "smithy.api#documentation": "

    The IAM role ARN of the user who ran the Automation.

    " + "smithy.api#documentation": "

    The specified key-value mapping of document parameters to target resources.

    " } }, - "CurrentStepName": { + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", + "traits": { + "smithy.api#documentation": "

    The MaxErrors value specified by the user when starting the Automation.

    " + } + }, + "ExecutedBy": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The name of the step that is currently running.

    " + "smithy.api#documentation": "

    The IAM role ARN of the user who ran the Automation.

    " } }, - "DocumentName": { - "target": "com.amazonaws.ssm#DocumentName", + "Outputs": { + "target": "com.amazonaws.ssm#AutomationParameterMap", "traits": { - "smithy.api#documentation": "

    The name of the Automation document used during execution.

    " + "smithy.api#documentation": "

    The list of execution outputs as defined in the Automation document.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "CurrentAction": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The MaxConcurrency value specified by the user when starting the Automation.

    " + "smithy.api#documentation": "

    The action of the step that is currently running.

    " } }, - "TargetParameterName": { - "target": "com.amazonaws.ssm#AutomationParameterKey", + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    The list of execution outputs as defined in the Automation document.

    " + "smithy.api#documentation": "

    The name of the Automation document used during execution.

    " } }, - "LogFile": { - "target": "com.amazonaws.ssm#String", + "AutomationExecutionId": { + "target": "com.amazonaws.ssm#AutomationExecutionId", "traits": { - "smithy.api#documentation": "

    An S3 bucket where execution information is stored.

    " + "smithy.api#documentation": "

    The execution ID.

    " } }, - "ExecutionEndTime": { + "ExecutionStartTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The time the execution finished. This is not populated if the execution is still in\n progress.

    " + "smithy.api#documentation": "

    The time the execution started.

    " } }, "Target": { @@ -2222,64 +2228,58 @@ "smithy.api#documentation": "

    The list of execution outputs as defined in the Automation document.

    " } }, - "AutomationExecutionStatus": { - "target": "com.amazonaws.ssm#AutomationExecutionStatus", - "traits": { - "smithy.api#documentation": "

    The status of the execution.

    " - } - }, - "Outputs": { - "target": "com.amazonaws.ssm#AutomationParameterMap", + "AutomationType": { + "target": "com.amazonaws.ssm#AutomationType", "traits": { - "smithy.api#documentation": "

    The list of execution outputs as defined in the Automation document.

    " + "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.

    " } }, - "CurrentAction": { - "target": "com.amazonaws.ssm#String", + "ParentAutomationExecutionId": { + "target": "com.amazonaws.ssm#AutomationExecutionId", "traits": { - "smithy.api#documentation": "

    The action of the step that is currently running.

    " + "smithy.api#documentation": "

    The ExecutionId of the parent Automation.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "TargetParameterName": { + "target": "com.amazonaws.ssm#AutomationParameterKey", "traits": { - "smithy.api#documentation": "

    The MaxErrors value specified by the user when starting the Automation.

    " + "smithy.api#documentation": "

    The list of execution outputs as defined in the Automation document.

    " } }, - "Mode": { - "target": "com.amazonaws.ssm#ExecutionMode", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The Automation execution mode.

    " + "smithy.api#documentation": "

    The MaxConcurrency value specified by the user when starting the Automation.

    " } }, - "TargetMaps": { - "target": "com.amazonaws.ssm#TargetMaps", + "ResolvedTargets": { + "target": "com.amazonaws.ssm#ResolvedTargets", "traits": { - "smithy.api#documentation": "

    The specified key-value mapping of document parameters to target resources.

    " + "smithy.api#documentation": "

    A list of targets that resolved during the execution.

    " } }, - "FailureMessage": { + "CurrentStepName": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The list of execution outputs as defined in the Automation document.

    " + "smithy.api#documentation": "

    The name of the step that is currently running.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "AutomationExecutionStatus": { + "target": "com.amazonaws.ssm#AutomationExecutionStatus", "traits": { - "smithy.api#documentation": "

    The document version used during the execution.

    " + "smithy.api#documentation": "

    The status of the execution.

    " } }, - "ExecutionStartTime": { + "ExecutionEndTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The time the execution started.

    " + "smithy.api#documentation": "

    The time the execution finished. This is not populated if the execution is still in\n progress.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "LogFile": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The targets defined by the user when starting the Automation.

    " + "smithy.api#documentation": "

    An S3 bucket where execution information is stored.

    " } } }, @@ -2625,40 +2625,22 @@ "com.amazonaws.ssm#Command": { "type": "structure", "members": { - "CommandId": { - "target": "com.amazonaws.ssm#CommandId", - "traits": { - "smithy.api#documentation": "

    A unique identifier for this command.

    " - } - }, - "OutputS3KeyPrefix": { - "target": "com.amazonaws.ssm#S3KeyPrefix", - "traits": { - "smithy.api#documentation": "

    The S3 directory path inside the bucket where the responses to the command executions should\n be stored. This was requested when issuing the command.

    " - } - }, - "TimeoutSeconds": { - "target": "com.amazonaws.ssm#TimeoutSeconds", - "traits": { - "smithy.api#documentation": "

    The TimeoutSeconds value specified for a command.

    " - } - }, - "DocumentName": { - "target": "com.amazonaws.ssm#DocumentName", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The name of the document requested for execution.

    " + "smithy.api#documentation": "

    An array of search criteria that targets instances using a Key,Value combination that you\n specify. Targets is required if you don't provide one or more instance IDs in the call.

    " } }, - "OutputS3BucketName": { - "target": "com.amazonaws.ssm#S3BucketName", + "OutputS3Region": { + "target": "com.amazonaws.ssm#S3Region", "traits": { - "smithy.api#documentation": "

    The S3 bucket where the responses to the command executions should be stored. This was\n requested when issuing the command.

    " + "smithy.api#documentation": "

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.

    " } }, - "CloudWatchOutputConfig": { - "target": "com.amazonaws.ssm#CloudWatchOutputConfig", + "CompletedCount": { + "target": "com.amazonaws.ssm#CompletedCount", "traits": { - "smithy.api#documentation": "

    CloudWatch Logs information where you want Systems Manager to send the command output.

    " + "smithy.api#documentation": "

    The number of targets for which the command invocation reached a terminal state. Terminal\n states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled,\n Terminated, or Undeliverable.

    " } }, "ServiceRole": { @@ -2667,22 +2649,10 @@ "smithy.api#documentation": "

    The IAM service role that Run Command uses to act on your behalf when sending notifications\n about command status changes.

    " } }, - "ExpiresAfter": { - "target": "com.amazonaws.ssm#DateTime", - "traits": { - "smithy.api#documentation": "

    If this time is reached and the command has not already started running, it will not run.\n Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

    " - } - }, - "RequestedDateTime": { - "target": "com.amazonaws.ssm#DateTime", - "traits": { - "smithy.api#documentation": "

    The date and time the command was requested.

    " - } - }, - "InstanceIds": { - "target": "com.amazonaws.ssm#InstanceIdList", + "ErrorCount": { + "target": "com.amazonaws.ssm#ErrorCount", "traits": { - "smithy.api#documentation": "

    The instance IDs against which this command was requested.

    " + "smithy.api#documentation": "

    The number of targets for which the status is Failed or Execution Timed Out.

    " } }, "DocumentVersion": { @@ -2691,52 +2661,76 @@ "smithy.api#documentation": "

    The SSM document version.

    " } }, + "NotificationConfig": { + "target": "com.amazonaws.ssm#NotificationConfig", + "traits": { + "smithy.api#documentation": "

    Configurations for sending notifications about command status changes.

    " + } + }, "Status": { "target": "com.amazonaws.ssm#CommandStatus", "traits": { "smithy.api#documentation": "

    The status of the command.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "TimeoutSeconds": { + "target": "com.amazonaws.ssm#TimeoutSeconds", "traits": { - "smithy.api#documentation": "

    An array of search criteria that targets instances using a Key,Value combination that you\n specify. Targets is required if you don't provide one or more instance IDs in the call.

    " + "smithy.api#documentation": "

    The TimeoutSeconds value specified for a command.

    " } }, - "NotificationConfig": { - "target": "com.amazonaws.ssm#NotificationConfig", + "CloudWatchOutputConfig": { + "target": "com.amazonaws.ssm#CloudWatchOutputConfig", "traits": { - "smithy.api#documentation": "

    Configurations for sending notifications about command status changes.

    " + "smithy.api#documentation": "

    CloudWatch Logs information where you want Systems Manager to send the command output.

    " } }, - "ErrorCount": { - "target": "com.amazonaws.ssm#ErrorCount", + "ExpiresAfter": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The number of targets for which the status is Failed or Execution Timed Out.

    " + "smithy.api#documentation": "

    If this time is reached and the command has not already started running, it will not run.\n Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

    " } }, - "Comment": { - "target": "com.amazonaws.ssm#Comment", + "CommandId": { + "target": "com.amazonaws.ssm#CommandId", "traits": { - "smithy.api#documentation": "

    User-specified information about the command, such as a brief description of what the\n command should do.

    " + "smithy.api#documentation": "

    A unique identifier for this command.

    " } }, - "DeliveryTimedOutCount": { - "target": "com.amazonaws.ssm#DeliveryTimedOutCount", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The number of targets for which the status is Delivery Timed Out.

    " + "smithy.api#documentation": "

    The maximum number of instances that are allowed to run the command at the same time. You\n can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The\n default value is 50. For more information about how to use MaxConcurrency, see Running commands\n using Systems Manager Run Command in the AWS Systems Manager User Guide.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    The maximum number of errors allowed before the system stops sending the command to\n additional targets. You can specify a number of errors, such as 10, or a percentage or errors,\n such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands\n using Systems Manager Run Command in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    The name of the document requested for execution.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#Parameters", + "OutputS3BucketName": { + "target": "com.amazonaws.ssm#S3BucketName", "traits": { - "smithy.api#documentation": "

    The parameter values to be inserted in the document when running the command.

    " + "smithy.api#documentation": "

    The S3 bucket where the responses to the command executions should be stored. This was\n requested when issuing the command.

    " + } + }, + "InstanceIds": { + "target": "com.amazonaws.ssm#InstanceIdList", + "traits": { + "smithy.api#documentation": "

    The instance IDs against which this command was requested.

    " + } + }, + "OutputS3KeyPrefix": { + "target": "com.amazonaws.ssm#S3KeyPrefix", + "traits": { + "smithy.api#documentation": "

    The S3 directory path inside the bucket where the responses to the command executions should\n be stored. This was requested when issuing the command.

    " + } + }, + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", + "traits": { + "smithy.api#documentation": "

    The maximum number of errors allowed before the system stops sending the command to\n additional targets. You can specify a number of errors, such as 10, or a percentage or errors,\n such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands\n using Systems Manager Run Command in the AWS Systems Manager User Guide.

    " } }, "TargetCount": { @@ -2745,28 +2739,34 @@ "smithy.api#documentation": "

    The number of targets for the command.

    " } }, - "CompletedCount": { - "target": "com.amazonaws.ssm#CompletedCount", + "Parameters": { + "target": "com.amazonaws.ssm#Parameters", "traits": { - "smithy.api#documentation": "

    The number of targets for which the command invocation reached a terminal state. Terminal\n states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled,\n Terminated, or Undeliverable.

    " + "smithy.api#documentation": "

    The parameter values to be inserted in the document when running the command.

    " } }, - "StatusDetails": { - "target": "com.amazonaws.ssm#StatusDetails", + "RequestedDateTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    A detailed status of the command execution. StatusDetails includes more information than\n Status because it includes states resulting from error and concurrency control parameters.\n StatusDetails can show different results than Status. For more information about these statuses,\n see Understanding command statuses in the AWS Systems Manager User Guide.\n StatusDetails can be one of the following values:

    \n
      \n
    • \n

      Pending: The command has not been sent to any instances.

      \n
      • \n
    • \n

      In Progress: The command has been sent to at least one instance but has not reached a\n final state on all instances.

      \n
      • \n
    • \n

      Success: The command successfully ran on all invocations. This is a terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of\n Delivery Timed Out. This is a terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: The value of MaxErrors or more command invocations shows a status of\n Execution Timed Out. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The value of MaxErrors or more command invocations shows a status of Failed. This\n is a terminal state.

      \n
      • \n
    • \n

      Incomplete: The command was attempted on all instances and one or more invocations does\n not have a value of Success but not enough invocations failed for the status to be Failed. This\n is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Rate Exceeded: The number of instances targeted by the command exceeded the account limit\n for pending invocations. The system has canceled the command before running it on any instance.\n This is a terminal state.

      \n
      • \n
    " + "smithy.api#documentation": "

    The date and time the command was requested.

    " } }, - "OutputS3Region": { - "target": "com.amazonaws.ssm#S3Region", + "DeliveryTimedOutCount": { + "target": "com.amazonaws.ssm#DeliveryTimedOutCount", "traits": { - "smithy.api#documentation": "

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.

    " + "smithy.api#documentation": "

    The number of targets for which the status is Delivery Timed Out.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "Comment": { + "target": "com.amazonaws.ssm#Comment", "traits": { - "smithy.api#documentation": "

    The maximum number of instances that are allowed to run the command at the same time. You\n can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The\n default value is 50. For more information about how to use MaxConcurrency, see Running commands\n using Systems Manager Run Command in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    User-specified information about the command, such as a brief description of what the\n command should do.

    " + } + }, + "StatusDetails": { + "target": "com.amazonaws.ssm#StatusDetails", + "traits": { + "smithy.api#documentation": "

    A detailed status of the command execution. StatusDetails includes more information than\n Status because it includes states resulting from error and concurrency control parameters.\n StatusDetails can show different results than Status. For more information about these statuses,\n see Understanding command statuses in the AWS Systems Manager User Guide.\n StatusDetails can be one of the following values:

    \n
      \n
    • \n

      Pending: The command has not been sent to any instances.

      \n
      • \n
    • \n

      In Progress: The command has been sent to at least one instance but has not reached a\n final state on all instances.

      \n
      • \n
    • \n

      Success: The command successfully ran on all invocations. This is a terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of\n Delivery Timed Out. This is a terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: The value of MaxErrors or more command invocations shows a status of\n Execution Timed Out. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The value of MaxErrors or more command invocations shows a status of Failed. This\n is a terminal state.

      \n
      • \n
    • \n

      Incomplete: The command was attempted on all instances and one or more invocations does\n not have a value of Success but not enough invocations failed for the status to be Failed. This\n is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Rate Exceeded: The number of instances targeted by the command exceeded the account limit\n for pending invocations. The system has canceled the command before running it on any instance.\n This is a terminal state.

      \n
      • \n
    " } } }, @@ -2856,86 +2856,80 @@ "com.amazonaws.ssm#CommandInvocation": { "type": "structure", "members": { - "CommandId": { - "target": "com.amazonaws.ssm#CommandId", - "traits": { - "smithy.api#documentation": "

    The command against which this invocation was requested.

    " - } - }, - "InstanceName": { - "target": "com.amazonaws.ssm#InstanceTagName", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The name of the invocation target. For EC2 instances this is the value for the aws:Name tag.\n For on-premises instances, this is the name of the instance.

    " + "smithy.api#documentation": "

    The instance ID in which this invocation was requested.

    " } }, - "StandardErrorUrl": { - "target": "com.amazonaws.ssm#Url", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The URL to the plugin's StdErr file in Amazon S3, if the S3 bucket was defined for the parent\n command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for\n the command, and the S3 bucket was defined for the command.

    " + "smithy.api#documentation": "

    The SSM document version.

    " } }, - "DocumentName": { - "target": "com.amazonaws.ssm#DocumentName", + "ServiceRole": { + "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "

    The document name that was requested for execution.

    " + "smithy.api#documentation": "

    The IAM service role that Run Command uses to act on your behalf when sending notifications\n about command status changes on a per instance basis.

    " } }, - "RequestedDateTime": { - "target": "com.amazonaws.ssm#DateTime", + "TraceOutput": { + "target": "com.amazonaws.ssm#InvocationTraceOutput", "traits": { - "smithy.api#documentation": "

    The time and date the request was sent to this instance.

    " + "smithy.api#documentation": "

    Gets the trace output sent by the agent.

    " } }, - "ServiceRole": { - "target": "com.amazonaws.ssm#ServiceRole", + "NotificationConfig": { + "target": "com.amazonaws.ssm#NotificationConfig", "traits": { - "smithy.api#documentation": "

    The IAM service role that Run Command uses to act on your behalf when sending notifications\n about command status changes on a per instance basis.

    " + "smithy.api#documentation": "

    Configurations for sending notifications about command status changes on a per instance\n basis.

    " } }, - "CommandPlugins": { - "target": "com.amazonaws.ssm#CommandPluginList" - }, "Status": { "target": "com.amazonaws.ssm#CommandInvocationStatus", "traits": { "smithy.api#documentation": "

    Whether or not the invocation succeeded, failed, or is pending.

    " } }, + "InstanceName": { + "target": "com.amazonaws.ssm#InstanceTagName", + "traits": { + "smithy.api#documentation": "

    The name of the invocation target. For EC2 instances this is the value for the aws:Name tag.\n For on-premises instances, this is the name of the instance.

    " + } + }, "CloudWatchOutputConfig": { "target": "com.amazonaws.ssm#CloudWatchOutputConfig", "traits": { "smithy.api#documentation": "

    CloudWatch Logs information where you want Systems Manager to send the command output.

    " } }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "CommandId": { + "target": "com.amazonaws.ssm#CommandId", "traits": { - "smithy.api#documentation": "

    The instance ID in which this invocation was requested.

    " + "smithy.api#documentation": "

    The command against which this invocation was requested.

    " } }, - "NotificationConfig": { - "target": "com.amazonaws.ssm#NotificationConfig", + "StatusDetails": { + "target": "com.amazonaws.ssm#StatusDetails", "traits": { - "smithy.api#documentation": "

    Configurations for sending notifications about command status changes on a per instance\n basis.

    " + "smithy.api#documentation": "

    A detailed status of the command execution for each invocation (each instance targeted by\n the command). StatusDetails includes more information than Status because it includes states\n resulting from error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding command\n statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the\n following values:

    \n
      \n
    • \n

      Pending: The command has not been sent to the instance.

      \n
      • \n
    • \n

      In Progress: The command has been sent to the instance but has not reached a terminal\n state.

      \n
      • \n
    • \n

      Success: The execution of the command or plugin was successfully completed. This is a\n terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The command was not delivered to the instance before the delivery\n timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit,\n but they do contribute to whether the parent command status is Success or Incomplete. This is a\n terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: Command execution started on the instance, but the execution was not\n complete before the execution timeout expired. Execution timeouts count against the MaxErrors\n limit of the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The command was not successful on the instance. For a plugin, this indicates that\n the result code was not zero. For a command invocation, this indicates that the result code for\n one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the\n parent command. This is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Undeliverable: The command can't be delivered to the instance. The instance might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.

      \n
      • \n
    • \n

      Terminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.

      \n
      • \n
    " } }, - "TraceOutput": { - "target": "com.amazonaws.ssm#InvocationTraceOutput", + "StandardErrorUrl": { + "target": "com.amazonaws.ssm#Url", "traits": { - "smithy.api#documentation": "

    Gets the trace output sent by the agent.

    " + "smithy.api#documentation": "

    The URL to the plugin's StdErr file in Amazon S3, if the S3 bucket was defined for the parent\n command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for\n the command, and the S3 bucket was defined for the command.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    The SSM document version.

    " + "smithy.api#documentation": "

    The document name that was requested for execution.

    " } }, - "Comment": { - "target": "com.amazonaws.ssm#Comment", - "traits": { - "smithy.api#documentation": "

    User-specified information about the command, such as a brief description of what the\n command should do.

    " - } + "CommandPlugins": { + "target": "com.amazonaws.ssm#CommandPluginList" }, "StandardOutputUrl": { "target": "com.amazonaws.ssm#Url", @@ -2943,10 +2937,16 @@ "smithy.api#documentation": "

    The URL to the plugin's StdOut file in Amazon S3, if the S3 bucket was defined for the parent\n command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined\n for the command, and the S3 bucket was defined for the command.

    " } }, - "StatusDetails": { - "target": "com.amazonaws.ssm#StatusDetails", + "Comment": { + "target": "com.amazonaws.ssm#Comment", "traits": { - "smithy.api#documentation": "

    A detailed status of the command execution for each invocation (each instance targeted by\n the command). StatusDetails includes more information than Status because it includes states\n resulting from error and concurrency control parameters. StatusDetails can show different results\n than Status. For more information about these statuses, see Understanding command\n statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the\n following values:

    \n
      \n
    • \n

      Pending: The command has not been sent to the instance.

      \n
      • \n
    • \n

      In Progress: The command has been sent to the instance but has not reached a terminal\n state.

      \n
      • \n
    • \n

      Success: The execution of the command or plugin was successfully completed. This is a\n terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The command was not delivered to the instance before the delivery\n timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit,\n but they do contribute to whether the parent command status is Success or Incomplete. This is a\n terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: Command execution started on the instance, but the execution was not\n complete before the execution timeout expired. Execution timeouts count against the MaxErrors\n limit of the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The command was not successful on the instance. For a plugin, this indicates that\n the result code was not zero. For a command invocation, this indicates that the result code for\n one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the\n parent command. This is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Undeliverable: The command can't be delivered to the instance. The instance might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.

      \n
      • \n
    • \n

      Terminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.

      \n
      • \n
    " + "smithy.api#documentation": "

    User-specified information about the command, such as a brief description of what the\n command should do.

    " + } + }, + "RequestedDateTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    The time and date the request was sent to this instance.

    " } } }, @@ -3017,22 +3017,16 @@ "com.amazonaws.ssm#CommandPlugin": { "type": "structure", "members": { - "StatusDetails": { - "target": "com.amazonaws.ssm#StatusDetails", - "traits": { - "smithy.api#documentation": "

    A detailed status of the plugin execution. StatusDetails includes more information than\n Status because it includes states resulting from error and concurrency control parameters.\n StatusDetails can show different results than Status. For more information about these statuses,\n see Understanding command statuses in the AWS Systems Manager User Guide.\n StatusDetails can be one of the following values:

    \n
      \n
    • \n

      Pending: The command has not been sent to the instance.

      \n
      • \n
    • \n

      In Progress: The command has been sent to the instance but has not reached a terminal\n state.

      \n
      • \n
    • \n

      Success: The execution of the command or plugin was successfully completed. This is a\n terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The command was not delivered to the instance before the delivery\n timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit,\n but they do contribute to whether the parent command status is Success or Incomplete. This is a\n terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: Command execution started on the instance, but the execution was not\n complete before the execution timeout expired. Execution timeouts count against the MaxErrors\n limit of the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The command was not successful on the instance. For a plugin, this indicates that\n the result code was not zero. For a command invocation, this indicates that the result code for\n one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the\n parent command. This is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Undeliverable: The command can't be delivered to the instance. The instance might not\n exist, or it might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit, and they don't contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.

      \n
      • \n
    • \n

      Terminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.

      \n
      • \n
    " - } - }, - "Status": { - "target": "com.amazonaws.ssm#CommandPluginStatus", + "StandardErrorUrl": { + "target": "com.amazonaws.ssm#Url", "traits": { - "smithy.api#documentation": "

    The status of this plugin. You can run a document with multiple plugins.

    " + "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stderr. If execution is not yet\n complete, then this string is empty.

    " } }, - "ResponseFinishDateTime": { - "target": "com.amazonaws.ssm#DateTime", + "OutputS3BucketName": { + "target": "com.amazonaws.ssm#S3BucketName", "traits": { - "smithy.api#documentation": "

    The time the plugin stopped running. Could stop prematurely if, for example, a cancel\n command was sent.

    " + "smithy.api#documentation": "

    The S3 bucket where the responses to the command executions should be stored. This was\n requested when issuing the command. For example, in the following response:

    \n

    doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

    \n

    doc-example-bucket is the name of the S3 bucket;

    \n

    ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

    \n

    i-02573cafcfEXAMPLE is the instance ID;

    \n

    awsrunShellScript is the name of the plugin.

    " } }, "Output": { @@ -3041,34 +3035,34 @@ "smithy.api#documentation": "

    Output of the plugin execution.

    " } }, - "ResponseStartDateTime": { + "ResponseFinishDateTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The time the plugin started running.

    " + "smithy.api#documentation": "

    The time the plugin stopped running. Could stop prematurely if, for example, a cancel\n command was sent.

    " } }, - "ResponseCode": { - "target": "com.amazonaws.ssm#ResponseCode", + "StatusDetails": { + "target": "com.amazonaws.ssm#StatusDetails", "traits": { - "smithy.api#documentation": "

    A numeric response code generated after running the plugin.

    " + "smithy.api#documentation": "

    A detailed status of the plugin execution. StatusDetails includes more information than\n Status because it includes states resulting from error and concurrency control parameters.\n StatusDetails can show different results than Status. For more information about these statuses,\n see Understanding command statuses in the AWS Systems Manager User Guide.\n StatusDetails can be one of the following values:

    \n
      \n
    • \n

      Pending: The command has not been sent to the instance.

      \n
      • \n
    • \n

      In Progress: The command has been sent to the instance but has not reached a terminal\n state.

      \n
      • \n
    • \n

      Success: The execution of the command or plugin was successfully completed. This is a\n terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The command was not delivered to the instance before the delivery\n timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit,\n but they do contribute to whether the parent command status is Success or Incomplete. This is a\n terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: Command execution started on the instance, but the execution was not\n complete before the execution timeout expired. Execution timeouts count against the MaxErrors\n limit of the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The command was not successful on the instance. For a plugin, this indicates that\n the result code was not zero. For a command invocation, this indicates that the result code for\n one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the\n parent command. This is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Undeliverable: The command can't be delivered to the instance. The instance might not\n exist, or it might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit, and they don't contribute to whether the parent command status is\n Success or Incomplete. This is a terminal state.

      \n
      • \n
    • \n

      Terminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.

      \n
      • \n
    " } }, - "OutputS3Region": { - "target": "com.amazonaws.ssm#S3Region", + "ResponseCode": { + "target": "com.amazonaws.ssm#ResponseCode", "traits": { - "smithy.api#documentation": "

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the S3 bucket region.

    " + "smithy.api#documentation": "

    A numeric response code generated after running the plugin.

    " } }, - "StandardOutputUrl": { - "target": "com.amazonaws.ssm#Url", + "ResponseStartDateTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for\n the command was not specified, then this string is empty.

    " + "smithy.api#documentation": "

    The time the plugin started running.

    " } }, "OutputS3KeyPrefix": { "target": "com.amazonaws.ssm#S3KeyPrefix", "traits": { - "smithy.api#documentation": "

    The S3 directory path inside the bucket where the responses to the command executions should\n be stored. This was requested when issuing the command. For example, in the following\n response:

    \n

    test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

    \n

    test_folder is the name of the S3 bucket;

    \n

    ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

    \n

    i-1234567876543 is the instance ID;

    \n

    awsrunShellScript is the name of the plugin.

    " + "smithy.api#documentation": "

    The S3 directory path inside the bucket where the responses to the command executions should\n be stored. This was requested when issuing the command. For example, in the following\n response:

    \n

    doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

    \n

    doc-example-bucket is the name of the S3 bucket;

    \n

    ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

    \n

    i-02573cafcfEXAMPLE is the instance ID;

    \n

    awsrunShellScript is the name of the plugin.

    " } }, "Name": { @@ -3077,16 +3071,22 @@ "smithy.api#documentation": "

    The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin,\n aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or\n aws:updateSSMAgent.

    " } }, - "OutputS3BucketName": { - "target": "com.amazonaws.ssm#S3BucketName", + "OutputS3Region": { + "target": "com.amazonaws.ssm#S3Region", "traits": { - "smithy.api#documentation": "

    The S3 bucket where the responses to the command executions should be stored. This was\n requested when issuing the command. For example, in the following response:

    \n

    test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

    \n

    test_folder is the name of the S3 bucket;

    \n

    ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

    \n

    i-1234567876543 is the instance ID;

    \n

    awsrunShellScript is the name of the plugin.

    " + "smithy.api#documentation": "

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the S3 bucket region.

    " } }, - "StandardErrorUrl": { + "Status": { + "target": "com.amazonaws.ssm#CommandPluginStatus", + "traits": { + "smithy.api#documentation": "

    The status of this plugin. You can run a document with multiple plugins.

    " + } + }, + "StandardOutputUrl": { "target": "com.amazonaws.ssm#Url", "traits": { - "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stderr. If execution is not yet\n complete, then this string is empty.

    " + "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for\n the command was not specified, then this string is empty.

    " } } }, @@ -3207,12 +3207,6 @@ "com.amazonaws.ssm#ComplianceExecutionSummary": { "type": "structure", "members": { - "ExecutionId": { - "target": "com.amazonaws.ssm#ComplianceExecutionId", - "traits": { - "smithy.api#documentation": "

    An ID created by the system when PutComplianceItems was called. For example,\n CommandID is a valid execution ID. You can use this ID in subsequent calls.

    " - } - }, "ExecutionType": { "target": "com.amazonaws.ssm#ComplianceExecutionType", "traits": { @@ -3225,6 +3219,12 @@ "smithy.api#documentation": "

    The time the execution ran as a datetime object that is saved in the following format:\n yyyy-MM-dd'T'HH:mm:ss'Z'.

    ", "smithy.api#required": {} } + }, + "ExecutionId": { + "target": "com.amazonaws.ssm#ComplianceExecutionId", + "traits": { + "smithy.api#documentation": "

    An ID created by the system when PutComplianceItems was called. For example,\n CommandID is a valid execution ID. You can use this ID in subsequent calls.

    " + } } }, "traits": { @@ -3246,28 +3246,16 @@ "com.amazonaws.ssm#ComplianceItem": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.ssm#ComplianceResourceId", - "traits": { - "smithy.api#documentation": "

    An ID for the resource. For a managed instance, this is the instance ID.

    " - } - }, - "ExecutionSummary": { - "target": "com.amazonaws.ssm#ComplianceExecutionSummary", - "traits": { - "smithy.api#documentation": "

    A summary for the compliance item. The summary includes an execution ID, the execution type\n (for example, command), and the execution time.

    " - } - }, "Id": { "target": "com.amazonaws.ssm#ComplianceItemId", "traits": { "smithy.api#documentation": "

    An ID for the compliance item. For example, if the compliance item is a Windows patch, the\n ID could be the number of the KB article; for example: KB4010320.

    " } }, - "Details": { - "target": "com.amazonaws.ssm#ComplianceItemDetails", + "ResourceId": { + "target": "com.amazonaws.ssm#ComplianceResourceId", "traits": { - "smithy.api#documentation": "

    A \"Key\": \"Value\" tag combination for the compliance item.

    " + "smithy.api#documentation": "

    An ID for the resource. For a managed instance, this is the instance ID.

    " } }, "Title": { @@ -3276,10 +3264,10 @@ "smithy.api#documentation": "

    A title for the compliance item. For example, if the compliance item is a Windows patch, the\n title could be the title of the KB article for the patch; for example: Security Update for Active\n Directory Federation Services.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#ComplianceStatus", + "ResourceType": { + "target": "com.amazonaws.ssm#ComplianceResourceType", "traits": { - "smithy.api#documentation": "

    The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

    " + "smithy.api#documentation": "

    The type of resource. ManagedInstance is currently the only supported resource\n type.

    " } }, "ComplianceType": { @@ -3288,16 +3276,28 @@ "smithy.api#documentation": "

    The compliance type. For example, Association (for a State Manager association), Patch, or\n Custom:string are all valid compliance types.

    " } }, - "Severity": { + "Status": { + "target": "com.amazonaws.ssm#ComplianceStatus", + "traits": { + "smithy.api#documentation": "

    The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty\n string (for Windows patches that aren't applicable).

    " + } + }, + "Severity": { "target": "com.amazonaws.ssm#ComplianceSeverity", "traits": { "smithy.api#documentation": "

    The severity of the compliance status. Severity can be one of the following: Critical, High,\n Medium, Low, Informational, Unspecified.

    " } }, - "ResourceType": { - "target": "com.amazonaws.ssm#ComplianceResourceType", + "Details": { + "target": "com.amazonaws.ssm#ComplianceItemDetails", "traits": { - "smithy.api#documentation": "

    The type of resource. ManagedInstance is currently the only supported resource\n type.

    " + "smithy.api#documentation": "

    A \"Key\": \"Value\" tag combination for the compliance item.

    " + } + }, + "ExecutionSummary": { + "target": "com.amazonaws.ssm#ComplianceExecutionSummary", + "traits": { + "smithy.api#documentation": "

    A summary for the compliance item. The summary includes an execution ID, the execution type\n (for example, command), and the execution time.

    " } } }, @@ -3332,6 +3332,12 @@ "smithy.api#documentation": "

    A \"Key\": \"Value\" tag combination for the compliance item.

    " } }, + "Title": { + "target": "com.amazonaws.ssm#ComplianceItemTitle", + "traits": { + "smithy.api#documentation": "

    The title of the compliance item. For example, if the compliance item is a Windows patch,\n the title could be the title of the KB article for the patch; for example: Security Update for\n Active Directory Federation Services.

    " + } + }, "Status": { "target": "com.amazonaws.ssm#ComplianceStatus", "traits": { @@ -3346,12 +3352,6 @@ "smithy.api#required": {} } }, - "Title": { - "target": "com.amazonaws.ssm#ComplianceItemTitle", - "traits": { - "smithy.api#documentation": "

    The title of the compliance item. For example, if the compliance item is a Windows patch,\n the title could be the title of the KB article for the patch; for example: Security Update for\n Active Directory Federation Services.

    " - } - }, "Id": { "target": "com.amazonaws.ssm#ComplianceItemId", "traits": { @@ -3518,17 +3518,17 @@ "smithy.api#documentation": "

    The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith,\n LessThan, or GreaterThan.

    " } }, - "Key": { - "target": "com.amazonaws.ssm#ComplianceStringFilterKey", - "traits": { - "smithy.api#documentation": "

    The name of the filter.

    " - } - }, "Values": { "target": "com.amazonaws.ssm#ComplianceStringFilterValueList", "traits": { "smithy.api#documentation": "

    The value for which to search.

    " } + }, + "Key": { + "target": "com.amazonaws.ssm#ComplianceStringFilterKey", + "traits": { + "smithy.api#documentation": "

    The name of the filter.

    " + } } }, "traits": { @@ -3574,18 +3574,18 @@ "com.amazonaws.ssm#ComplianceSummaryItem": { "type": "structure", "members": { - "ComplianceType": { - "target": "com.amazonaws.ssm#ComplianceTypeName", - "traits": { - "smithy.api#documentation": "

    The type of compliance item. For example, the compliance type can be Association, Patch, or\n Custom:string.

    " - } - }, "NonCompliantSummary": { "target": "com.amazonaws.ssm#NonCompliantSummary", "traits": { "smithy.api#documentation": "

    A list of NON_COMPLIANT items for the specified compliance type.

    " } }, + "ComplianceType": { + "target": "com.amazonaws.ssm#ComplianceTypeName", + "traits": { + "smithy.api#documentation": "

    The type of compliance item. For example, the compliance type can be Association, Patch, or\n Custom:string.

    " + } + }, "CompliantSummary": { "target": "com.amazonaws.ssm#CompliantSummary", "traits": { @@ -3646,17 +3646,17 @@ "com.amazonaws.ssm#CompliantSummary": { "type": "structure", "members": { - "SeveritySummary": { - "target": "com.amazonaws.ssm#SeveritySummary", - "traits": { - "smithy.api#documentation": "

    A summary of the compliance severity by compliance type.

    " - } - }, "CompliantCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { "smithy.api#documentation": "

    The total number of resources that are compliant.

    " } + }, + "SeveritySummary": { + "target": "com.amazonaws.ssm#SeveritySummary", + "traits": { + "smithy.api#documentation": "

    A summary of the compliance severity by compliance type.

    " + } } }, "traits": { @@ -3710,42 +3710,42 @@ "com.amazonaws.ssm#CreateActivationRequest": { "type": "structure", "members": { - "RegistrationLimit": { - "target": "com.amazonaws.ssm#RegistrationLimit", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Specify the maximum number of managed instances you want to register. The default value is 1\n instance.

    " - } - }, "Description": { "target": "com.amazonaws.ssm#ActivationDescription", "traits": { "smithy.api#documentation": "

    A user-defined description of the resource that you want to register with Systems Manager.

    \n \n

    Do not enter personally identifiable information in this field.

    \n     " } }, - "ExpirationDate": { - "target": "com.amazonaws.ssm#ExpirationDate", - "traits": { - "smithy.api#documentation": "

    The date by which this activation request should expire. The default value is 24\n hours.

    " - } - }, "DefaultInstanceName": { "target": "com.amazonaws.ssm#DefaultInstanceName", "traits": { "smithy.api#documentation": "

    The name of the registered, managed instance as it will appear in the Systems Manager console or when\n you use the AWS command line tools to list Systems Manager resources.

    \n \n

    Do not enter personally identifiable information in this field.

    \n     " } }, + "IamRole": { + "target": "com.amazonaws.ssm#IamRole", + "traits": { + "smithy.api#documentation": "

    The Amazon Identity and Access Management (IAM) role that you want to assign to the managed\n instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal\n ssm.amazonaws.com. For more information, see Create an IAM service role for a\n hybrid environment in the AWS Systems Manager User Guide.

    ", + "smithy.api#required": {} + } + }, + "ExpirationDate": { + "target": "com.amazonaws.ssm#ExpirationDate", + "traits": { + "smithy.api#documentation": "

    The date by which this activation request should expire. The default value is 24\n hours.

    " + } + }, "Tags": { "target": "com.amazonaws.ssm#TagList", "traits": { "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag an\n activation to identify which servers or virtual machines (VMs) in your on-premises environment\n you intend to activate. In this case, you could specify the following key name/value\n pairs:

    \n
      \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    • \n

      \n Key=Environment,Value=Production\n

      \n
      • \n
    \n \n

    When you install SSM Agent on your on-premises servers and VMs, you specify an activation\n ID and code. When you specify the activation ID and code, tags assigned to the activation are\n automatically applied to the on-premises servers or VMs.

    \n     \n\n

    You can't add tags to or delete tags from an existing activation. You can tag your\n on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a\n managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is\n prefixed with \"mi-\". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed\n instances, see RemoveTagsFromResource.

    " } }, - "IamRole": { - "target": "com.amazonaws.ssm#IamRole", + "RegistrationLimit": { + "target": "com.amazonaws.ssm#RegistrationLimit", "traits": { - "smithy.api#documentation": "

    The Amazon Identity and Access Management (IAM) role that you want to assign to the managed\n instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal\n ssm.amazonaws.com. For more information, see Create an IAM service role for a\n hybrid environment in the AWS Systems Manager User Guide.

    ", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

    Specify the maximum number of managed instances you want to register. The default value is 1\n instance.

    " } } } @@ -3753,17 +3753,17 @@ "com.amazonaws.ssm#CreateActivationResult": { "type": "structure", "members": { - "ActivationId": { - "target": "com.amazonaws.ssm#ActivationId", - "traits": { - "smithy.api#documentation": "

    The ID number generated by the system when it processed the activation. The activation ID\n functions like a user name.

    " - } - }, "ActivationCode": { "target": "com.amazonaws.ssm#ActivationCode", "traits": { "smithy.api#documentation": "

    The code the system generates when it processes the activation. The activation code\n functions like a password to validate the activation ID.

    " } + }, + "ActivationId": { + "target": "com.amazonaws.ssm#ActivationId", + "traits": { + "smithy.api#documentation": "

    The ID number generated by the system when it processed the activation. The activation ID\n functions like a user name.

    " + } } } }, @@ -3890,28 +3890,22 @@ "com.amazonaws.ssm#CreateAssociationBatchRequestEntry": { "type": "structure", "members": { - "Targets": { - "target": "com.amazonaws.ssm#Targets", - "traits": { - "smithy.api#documentation": "

    The instances targeted by the request.

    " - } - }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    The ID of the instance.

    " + "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " } }, - "AutomationTargetParameterName": { - "target": "com.amazonaws.ssm#AutomationTargetParameterName", + "ScheduleExpression": { + "target": "com.amazonaws.ssm#ScheduleExpression", "traits": { - "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " + "smithy.api#documentation": "

    A cron expression that specifies a schedule when the association runs.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "Parameters": { + "target": "com.amazonaws.ssm#Parameters", "traits": { - "smithy.api#documentation": "

    The document version.

    " + "smithy.api#documentation": "

    A description of the parameters for a document.

    " } }, "Name": { @@ -3921,34 +3915,28 @@ "smithy.api#required": {} } }, - "ComplianceSeverity": { - "target": "com.amazonaws.ssm#AssociationComplianceSeverity", - "traits": { - "smithy.api#documentation": "

    The severity level to assign to the association.

    " - } - }, - "AssociationName": { - "target": "com.amazonaws.ssm#AssociationName", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    Specify a descriptive name for the association.

    " + "smithy.api#documentation": "

    The instances targeted by the request.

    " } }, - "ScheduleExpression": { - "target": "com.amazonaws.ssm#ScheduleExpression", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    A cron expression that specifies a schedule when the association runs.

    " + "smithy.api#documentation": "

    The ID of the instance.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " + "smithy.api#documentation": "

    The document version.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "ComplianceSeverity": { + "target": "com.amazonaws.ssm#AssociationComplianceSeverity", "traits": { - "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " + "smithy.api#documentation": "

    The severity level to assign to the association.

    " } }, "SyncCompliance": { @@ -3957,10 +3945,16 @@ "smithy.api#documentation": "

    The mode for generating association compliance. You can specify AUTO or\n MANUAL. In AUTO mode, the system uses the status of the association\n execution to determine the compliance status. If the association execution runs successfully,\n then the association is COMPLIANT. If the association execution doesn't run\n successfully, the association is NON-COMPLIANT.

    \n

    In MANUAL mode, you must specify the AssociationId as a parameter\n for the PutComplianceItems API action. In this case, compliance data is not\n managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

    \n

    By default, all associations use AUTO mode.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#Parameters", + "AutomationTargetParameterName": { + "target": "com.amazonaws.ssm#AutomationTargetParameterName", "traits": { - "smithy.api#documentation": "

    A description of the parameters for a document.

    " + "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " + } + }, + "ApplyOnlyAtCronInterval": { + "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", + "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.

    " } }, "OutputLocation": { @@ -3969,10 +3963,16 @@ "smithy.api#documentation": "

    An S3 bucket where you want to store the results of this request.

    " } }, - "ApplyOnlyAtCronInterval": { - "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", + "AssociationName": { + "target": "com.amazonaws.ssm#AssociationName", "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.

    " + "smithy.api#documentation": "

    Specify a descriptive name for the association.

    " + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", + "traits": { + "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " } } }, @@ -3983,51 +3983,51 @@ "com.amazonaws.ssm#CreateAssociationBatchResult": { "type": "structure", "members": { - "Successful": { - "target": "com.amazonaws.ssm#AssociationDescriptionList", - "traits": { - "smithy.api#documentation": "

    Information about the associations that succeeded.

    " - } - }, "Failed": { "target": "com.amazonaws.ssm#FailedCreateAssociationList", "traits": { "smithy.api#documentation": "

    Information about the associations that failed.

    " } + }, + "Successful": { + "target": "com.amazonaws.ssm#AssociationDescriptionList", + "traits": { + "smithy.api#documentation": "

    Information about the associations that succeeded.

    " + } } } }, "com.amazonaws.ssm#CreateAssociationRequest": { "type": "structure", "members": { - "ApplyOnlyAtCronInterval": { - "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", + "AutomationTargetParameterName": { + "target": "com.amazonaws.ssm#AutomationTargetParameterName", "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.

    " + "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The document version you want to associate with the target(s). Can be a specific version or\n the default version.

    " + "smithy.api#documentation": "

    The instance ID.

    \n \n

    \n InstanceId has been deprecated. To specify an instance ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with SSM documents that use schema version 2.0 or later will\n fail. In addition, if you use the parameter InstanceId, you\n cannot use the parameters AssociationName, DocumentVersion,\n MaxErrors, MaxConcurrency, OutputLocation, or\n ScheduleExpression. To use these parameters, you must use the Targets\n parameter.

    \n     " } }, - "ComplianceSeverity": { - "target": "com.amazonaws.ssm#AssociationComplianceSeverity", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The severity level to assign to the association.

    " + "smithy.api#documentation": "

    The document version you want to associate with the target(s). Can be a specific version or\n the default version.

    " } }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "Parameters": { + "target": "com.amazonaws.ssm#Parameters", "traits": { - "smithy.api#documentation": "

    The instance ID.

    \n \n

    \n InstanceId has been deprecated. To specify an instance ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID with SSM documents that use schema version 2.0 or later will\n fail. In addition, if you use the parameter InstanceId, you\n cannot use the parameters AssociationName, DocumentVersion,\n MaxErrors, MaxConcurrency, OutputLocation, or\n ScheduleExpression. To use these parameters, you must use the Targets\n parameter.

    \n     " + "smithy.api#documentation": "

    The parameters for the runtime configuration of the document.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "OutputLocation": { + "target": "com.amazonaws.ssm#InstanceAssociationOutputLocation", "traits": { - "smithy.api#documentation": "

    The targets for the association. You can target instances by using tags, AWS Resource\n Groups, all instances in an AWS account, or individual instance IDs. For more information about\n choosing targets for an association, see Using targets and rate controls with State Manager associations in the\n AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    An S3 bucket where you want to store the output details of the request.

    " } }, "SyncCompliance": { @@ -4036,22 +4036,28 @@ "smithy.api#documentation": "

    The mode for generating association compliance. You can specify AUTO or\n MANUAL. In AUTO mode, the system uses the status of the association\n execution to determine the compliance status. If the association execution runs successfully,\n then the association is COMPLIANT. If the association execution doesn't run\n successfully, the association is NON-COMPLIANT.

    \n

    In MANUAL mode, you must specify the AssociationId as a parameter\n for the PutComplianceItems API action. In this case, compliance data is not\n managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

    \n

    By default, all associations use AUTO mode.

    " } }, - "ScheduleExpression": { - "target": "com.amazonaws.ssm#ScheduleExpression", + "ComplianceSeverity": { + "target": "com.amazonaws.ssm#AssociationComplianceSeverity", "traits": { - "smithy.api#documentation": "

    A cron expression when the association will be applied to the target(s).

    " + "smithy.api#documentation": "

    The severity level to assign to the association.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " + "smithy.api#documentation": "

    The targets for the association. You can target instances by using tags, AWS Resource\n Groups, all instances in an AWS account, or individual instance IDs. For more information about\n choosing targets for an association, see Using targets and rate controls with State Manager associations in the\n AWS Systems Manager User Guide.

    " } }, - "AutomationTargetParameterName": { - "target": "com.amazonaws.ssm#AutomationTargetParameterName", + "ApplyOnlyAtCronInterval": { + "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", "traits": { - "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " + "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.

    " + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", + "traits": { + "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " } }, "Name": { @@ -4061,16 +4067,16 @@ "smithy.api#required": {} } }, - "Parameters": { - "target": "com.amazonaws.ssm#Parameters", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    The parameters for the runtime configuration of the document.

    " + "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " } }, - "OutputLocation": { - "target": "com.amazonaws.ssm#InstanceAssociationOutputLocation", + "ScheduleExpression": { + "target": "com.amazonaws.ssm#ScheduleExpression", "traits": { - "smithy.api#documentation": "

    An S3 bucket where you want to store the output details of the request.

    " + "smithy.api#documentation": "

    A cron expression when the association will be applied to the target(s).

    " } }, "AssociationName": { @@ -4078,12 +4084,6 @@ "traits": { "smithy.api#documentation": "

    Specify a descriptive name for the association.

    " } - }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", - "traits": { - "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " - } } } }, @@ -4133,16 +4133,29 @@ "com.amazonaws.ssm#CreateDocumentRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.ssm#DocumentName", + "traits": { + "smithy.api#documentation": "

    A name for the Systems Manager document.

    \n \n

    You can't use the following strings as document name prefixes. These are reserved by AWS\n for use as document name prefixes:

    \n
      \n
    • \n

      \n aws-\n

      \n
      • \n
    • \n

      \n amazon\n

      \n
      • \n
    • \n

      \n amzn\n

      \n
      • \n
    \n     ", + "smithy.api#required": {} + } + }, "TargetType": { "target": "com.amazonaws.ssm#TargetType", "traits": { "smithy.api#documentation": "

    Specify a target type to define the kinds of resources the document can run on. For example,\n to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you\n specify a value of '/' the document can run on all types of resources. If you don't specify a\n value, the document can't run on any resources. For a list of valid resource types, see AWS resource and property types\n reference in the AWS CloudFormation User Guide.

    " } }, - "VersionName": { - "target": "com.amazonaws.ssm#DocumentVersionName", + "Attachments": { + "target": "com.amazonaws.ssm#AttachmentsSourceList", "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact you are creating with the document.\n For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n cannot be changed.

    " + "smithy.api#documentation": "

    A list of key and value pairs that describe attachments to a version of a document.

    " + } + }, + "Requires": { + "target": "com.amazonaws.ssm#DocumentRequiresList", + "traits": { + "smithy.api#documentation": "

    A list of SSM documents required by a document. This parameter is used exclusively by AWS\n AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also\n specify a required document for validation purposes. In this case, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document for validation purposes. For more\n information, see AWS AppConfig in the\n AWS Systems Manager User Guide.

    " } }, "Content": { @@ -4152,10 +4165,10 @@ "smithy.api#required": {} } }, - "DocumentType": { - "target": "com.amazonaws.ssm#DocumentType", + "VersionName": { + "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    The type of document to create.

    " + "smithy.api#documentation": "

    An optional field specifying the version of the artifact you are creating with the document.\n For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n cannot be changed.

    " } }, "Tags": { @@ -4164,29 +4177,16 @@ "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag an\n SSM document to identify the types of targets or the environment where it will run. In this case,\n you could specify the following key name/value pairs:

    \n\n
      \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    • \n

      \n Key=Environment,Value=Production\n

      \n
      • \n
    \n \n

    To add tags to an existing SSM document, use the AddTagsToResource\n action.

    \n     " } }, - "DocumentFormat": { - "target": "com.amazonaws.ssm#DocumentFormat", - "traits": { - "smithy.api#documentation": "

    Specify the document format for the request. The document format can be JSON, YAML, or TEXT.\n JSON is the default format.

    " - } - }, - "Requires": { - "target": "com.amazonaws.ssm#DocumentRequiresList", - "traits": { - "smithy.api#documentation": "

    A list of SSM documents required by a document. This parameter is used exclusively by AWS\n AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also\n specify a required document for validation purposes. In this case, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document for validation purposes. For more\n information, see AWS AppConfig in the\n AWS Systems Manager User Guide.

    " - } - }, - "Attachments": { - "target": "com.amazonaws.ssm#AttachmentsSourceList", + "DocumentType": { + "target": "com.amazonaws.ssm#DocumentType", "traits": { - "smithy.api#documentation": "

    A list of key and value pairs that describe attachments to a version of a document.

    " + "smithy.api#documentation": "

    The type of document to create.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#DocumentName", + "DocumentFormat": { + "target": "com.amazonaws.ssm#DocumentFormat", "traits": { - "smithy.api#documentation": "

    A name for the Systems Manager document.

    \n \n

    You can't use the following strings as document name prefixes. These are reserved by AWS\n for use as document name prefixes:

    \n
      \n
    • \n

      \n aws-\n

      \n
      • \n
    • \n

      \n amazon\n

      \n
      • \n
    • \n

      \n amzn\n

      \n
      • \n
    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specify the document format for the request. The document format can be JSON, YAML, or TEXT.\n JSON is the default format.

    " } } } @@ -4228,35 +4228,30 @@ "com.amazonaws.ssm#CreateMaintenanceWindowRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ssm#MaintenanceWindowDescription", - "traits": { - "smithy.api#documentation": "

    An optional description for the maintenance window. We recommend specifying a description to\n help you organize your maintenance windows.

    " - } - }, - "Tags": { - "target": "com.amazonaws.ssm#TagList", + "ClientToken": { + "target": "com.amazonaws.ssm#ClientToken", "traits": { - "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag a\n maintenance window to identify the type of tasks it will run, the types of targets, and the\n environment it will run in. In this case, you could specify the following key name/value\n pairs:

    \n
      \n
    • \n

      \n Key=TaskType,Value=AgentUpdate\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    • \n

      \n Key=Environment,Value=Production\n

      \n
      • \n
    \n \n

    To add tags to an existing maintenance window, use the AddTagsToResource\n action.

    \n     " + "smithy.api#documentation": "

    User-provided idempotency token.

    ", + "smithy.api#idempotencyToken": {} } }, - "ScheduleTimezone": { - "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", + "Description": { + "target": "com.amazonaws.ssm#MaintenanceWindowDescription", "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": "

    An optional description for the maintenance window. We recommend specifying a description to\n help you organize your maintenance windows.

    " } }, - "ClientToken": { - "target": "com.amazonaws.ssm#ClientToken", + "AllowUnassociatedTargets": { + "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "traits": { - "smithy.api#documentation": "

    User-provided idempotency token.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    Enables a maintenance window task to run on managed instances, even if you have not\n registered those instances as targets. If enabled, then you must specify the unregistered\n instances (by instance ID) when you register a task with the maintenance window.

    \n

    If you don't enable this option, then you must specify previously-registered targets when\n you register a task with the maintenance window.

    ", + "smithy.api#required": {} } }, - "StartDate": { + "EndDate": { "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window until the\n specified future date.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become inactive. EndDate allows you to set a date and time in the future when the maintenance\n window will no longer run.

    " } }, "Duration": { @@ -4280,10 +4275,10 @@ "smithy.api#required": {} } }, - "EndDate": { - "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", + "Tags": { + "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become inactive. EndDate allows you to set a date and time in the future when the maintenance\n window will no longer run.

    " + "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag a\n maintenance window to identify the type of tasks it will run, the types of targets, and the\n environment it will run in. In this case, you could specify the following key name/value\n pairs:

    \n
      \n
    • \n

      \n Key=TaskType,Value=AgentUpdate\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    • \n

      \n Key=Environment,Value=Production\n

      \n
      • \n
    \n \n

    To add tags to an existing maintenance window, use the AddTagsToResource\n action.

    \n     " } }, "Cutoff": { @@ -4293,19 +4288,24 @@ "smithy.api#required": {} } }, + "StartDate": { + "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", + "traits": { + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become active. StartDate allows you to delay activation of the maintenance window until the\n specified future date.

    " + } + }, + "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.

    " + } + }, "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.

    " } - }, - "AllowUnassociatedTargets": { - "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", - "traits": { - "smithy.api#documentation": "

    Enables a maintenance window task to run on managed instances, even if you have not\n registered those instances as targets. If enabled, then you must specify the unregistered\n instances (by instance ID) when you register a task with the maintenance window.

    \n

    If you don't enable this option, then you must specify previously-registered targets when\n you register a task with the maintenance window.

    ", - "smithy.api#required": {} - } } } }, @@ -4349,11 +4349,10 @@ "com.amazonaws.ssm#CreateOpsItemRequest": { "type": "structure", "members": { - "Title": { - "target": "com.amazonaws.ssm#OpsItemTitle", + "Severity": { + "target": "com.amazonaws.ssm#OpsItemSeverity", "traits": { - "smithy.api#documentation": "

    A short heading that describes the nature of the OpsItem and the impacted resource.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specify a severity to assign to an OpsItem.

    " } }, "Source": { @@ -4363,10 +4362,17 @@ "smithy.api#required": {} } }, - "OperationalData": { - "target": "com.amazonaws.ssm#OpsItemOperationalData", + "RelatedOpsItems": { + "target": "com.amazonaws.ssm#RelatedOpsItems", "traits": { - "smithy.api#documentation": "

    Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

    \n \n

    Operational data keys can't begin with the following: amazon, aws,\n amzn, ssm, /amazon, /aws, /amzn, /ssm.

    \n     \n

    You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API action) can view and search on the\n specified data. Operational data that is not searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API action).

    \n\n

    Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see\n Creating OpsItems manually in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    One or more OpsItems that share something in common with the current OpsItems. For example,\n related OpsItems can include OpsItems with similar error messages, impacted resources, or\n statuses for the impacted resource.

    " + } + }, + "Title": { + "target": "com.amazonaws.ssm#OpsItemTitle", + "traits": { + "smithy.api#documentation": "

    A short heading that describes the nature of the OpsItem and the impacted resource.

    ", + "smithy.api#required": {} } }, "Notifications": { @@ -4375,16 +4381,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this\n OpsItem is edited or changed.

    " } }, - "RelatedOpsItems": { - "target": "com.amazonaws.ssm#RelatedOpsItems", + "Tags": { + "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

    One or more OpsItems that share something in common with the current OpsItems. For example,\n related OpsItems can include OpsItems with similar error messages, impacted resources, or\n statuses for the impacted resource.

    " + "smithy.api#documentation": "

    Optional metadata that you assign to a resource. You can restrict access to OpsItems by\n using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

    \n

    Tags use a key-value pair. For example:

    \n\n

    \n Key=Department,Value=Finance\n

    \n\n \n

    To add tags to an existing OpsItem, use the AddTagsToResource\n action.

    \n     " } }, - "Category": { - "target": "com.amazonaws.ssm#OpsItemCategory", + "OperationalData": { + "target": "com.amazonaws.ssm#OpsItemOperationalData", "traits": { - "smithy.api#documentation": "

    Specify a category to assign to an OpsItem.

    " + "smithy.api#documentation": "

    Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

    \n \n

    Operational data keys can't begin with the following: amazon, aws,\n amzn, ssm, /amazon, /aws, /amzn, /ssm.

    \n     \n

    You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API action) can view and search on the\n specified data. Operational data that is not searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API action).

    \n\n

    Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see\n Creating OpsItems manually in the AWS Systems Manager User Guide.

    " } }, "Description": { @@ -4394,22 +4400,16 @@ "smithy.api#required": {} } }, - "Priority": { - "target": "com.amazonaws.ssm#OpsItemPriority", - "traits": { - "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " - } - }, - "Tags": { - "target": "com.amazonaws.ssm#TagList", + "Category": { + "target": "com.amazonaws.ssm#OpsItemCategory", "traits": { - "smithy.api#documentation": "

    Optional metadata that you assign to a resource. You can restrict access to OpsItems by\n using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

    \n

    Tags use a key-value pair. For example:

    \n\n

    \n Key=Department,Value=Finance\n

    \n\n \n

    To add tags to an existing OpsItem, use the AddTagsToResource\n action.

    \n     " + "smithy.api#documentation": "

    Specify a category to assign to an OpsItem.

    " } }, - "Severity": { - "target": "com.amazonaws.ssm#OpsItemSeverity", + "Priority": { + "target": "com.amazonaws.ssm#OpsItemPriority", "traits": { - "smithy.api#documentation": "

    Specify a severity to assign to an OpsItem.

    " + "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " } } } @@ -4451,30 +4451,28 @@ "com.amazonaws.ssm#CreatePatchBaselineRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ssm#BaselineDescription", + "RejectedPatchesAction": { + "target": "com.amazonaws.ssm#PatchAction", "traits": { - "smithy.api#documentation": "

    A description of the patch baseline.

    " + "smithy.api#documentation": "

    The action for Patch Manager to take on patches included in the RejectedPackages\n list.

    \n
      \n
    • \n

      \n ALLOW_AS_DEPENDENCY: A package in the Rejected patches\n list is installed only if it is a dependency of another package. It is considered compliant\n with the patch baseline, and its status is reported as InstalledOther.\n This is the default action if no option is specified.

      \n
      • \n
    • \n

      \n BLOCK: Packages in the RejectedPatches list, and packages\n that include them as dependencies, are not installed under any circumstances. If a package was\n installed before it was added to the Rejected patches list, it is considered non-compliant with\n the patch baseline, and its status is reported as\n InstalledRejected.

      \n
      • \n
    " } }, - "ClientToken": { - "target": "com.amazonaws.ssm#ClientToken", + "ApprovedPatchesComplianceLevel": { + "target": "com.amazonaws.ssm#PatchComplianceLevel", "traits": { - "smithy.api#documentation": "

    User-provided idempotency token.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    Defines the compliance level for approved patches. This means that if an approved patch is\n reported as missing, this is the severity of the compliance violation. The default value is\n UNSPECIFIED.

    " } }, - "OperatingSystem": { - "target": "com.amazonaws.ssm#OperatingSystem", + "Sources": { + "target": "com.amazonaws.ssm#PatchSourceList", "traits": { - "smithy.api#documentation": "

    Defines the operating system the patch baseline applies to. The Default value is\n WINDOWS.

    " + "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#BaselineName", + "ApprovedPatches": { + "target": "com.amazonaws.ssm#PatchIdList", "traits": { - "smithy.api#documentation": "

    The name of the patch baseline.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of explicitly approved patches for the baseline.

    \n

    For information about accepted formats for lists of approved patches and rejected patches,\n see About\n package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

    " } }, "RejectedPatches": { @@ -4483,40 +4481,30 @@ "smithy.api#documentation": "

    A list of explicitly rejected patches for the baseline.

    \n

    For information about accepted formats for lists of approved patches and rejected patches,\n see About\n package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

    " } }, - "ApprovalRules": { - "target": "com.amazonaws.ssm#PatchRuleGroup", - "traits": { - "smithy.api#documentation": "

    A set of rules used to include patches in the baseline.

    " - } - }, - "ApprovedPatches": { - "target": "com.amazonaws.ssm#PatchIdList", - "traits": { - "smithy.api#documentation": "

    A list of explicitly approved patches for the baseline.

    \n

    For information about accepted formats for lists of approved patches and rejected patches,\n see About\n package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

    " - } - }, - "RejectedPatchesAction": { - "target": "com.amazonaws.ssm#PatchAction", + "Name": { + "target": "com.amazonaws.ssm#BaselineName", "traits": { - "smithy.api#documentation": "

    The action for Patch Manager to take on patches included in the RejectedPackages\n list.

    \n
      \n
    • \n

      \n ALLOW_AS_DEPENDENCY: A package in the Rejected patches\n list is installed only if it is a dependency of another package. It is considered compliant\n with the patch baseline, and its status is reported as InstalledOther.\n This is the default action if no option is specified.

      \n
      • \n
    • \n

      \n BLOCK: Packages in the RejectedPatches list, and packages\n that include them as dependencies, are not installed under any circumstances. If a package was\n installed before it was added to the Rejected patches list, it is considered non-compliant with\n the patch baseline, and its status is reported as\n InstalledRejected.

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the patch baseline.

    ", + "smithy.api#required": {} } }, - "Sources": { - "target": "com.amazonaws.ssm#PatchSourceList", + "ApprovalRules": { + "target": "com.amazonaws.ssm#PatchRuleGroup", "traits": { - "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " + "smithy.api#documentation": "

    A set of rules used to include patches in the baseline.

    " } }, - "ApprovedPatchesComplianceLevel": { - "target": "com.amazonaws.ssm#PatchComplianceLevel", + "ClientToken": { + "target": "com.amazonaws.ssm#ClientToken", "traits": { - "smithy.api#documentation": "

    Defines the compliance level for approved patches. This means that if an approved patch is\n reported as missing, this is the severity of the compliance violation. The default value is\n UNSPECIFIED.

    " + "smithy.api#documentation": "

    User-provided idempotency token.

    ", + "smithy.api#idempotencyToken": {} } }, - "Tags": { - "target": "com.amazonaws.ssm#TagList", + "Description": { + "target": "com.amazonaws.ssm#BaselineDescription", "traits": { - "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag a\n patch baseline to identify the severity level of patches it specifies and the operating system\n family it applies to. In this case, you could specify the following key name/value pairs:

    \n
      \n
    • \n

      \n Key=PatchSeverity,Value=Critical\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    \n \n

    To add tags to an existing patch baseline, use the AddTagsToResource\n action.

    \n     " + "smithy.api#documentation": "

    A description of the patch baseline.

    " } }, "ApprovedPatchesEnableNonSecurity": { @@ -4531,6 +4519,18 @@ "traits": { "smithy.api#documentation": "

    A set of global filters used to include patches in the baseline.

    " } + }, + "OperatingSystem": { + "target": "com.amazonaws.ssm#OperatingSystem", + "traits": { + "smithy.api#documentation": "

    Defines the operating system the patch baseline applies to. The Default value is\n WINDOWS.

    " + } + }, + "Tags": { + "target": "com.amazonaws.ssm#TagList", + "traits": { + "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag a\n patch baseline to identify the severity level of patches it specifies and the operating system\n family it applies to. In this case, you could specify the following key name/value pairs:

    \n
      \n
    • \n

      \n Key=PatchSeverity,Value=Critical\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    \n \n

    To add tags to an existing patch baseline, use the AddTagsToResource\n action.

    \n     " + } } } }, @@ -4580,15 +4580,8 @@ "smithy.api#documentation": "

    Specify SyncToDestination to create a resource data sync that synchronizes data\n to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a\n value for S3Destination. Specify SyncFromSource to synchronize data\n from a single account and multiple Regions, or multiple AWS accounts and Regions, as listed in\n AWS Organizations for Explorer. If you specify SyncFromSource, you must provide a value for\n SyncSource. The default value is SyncToDestination.

    " } }, - "SyncName": { - "target": "com.amazonaws.ssm#ResourceDataSyncName", - "traits": { - "smithy.api#documentation": "

    A name for the configuration.

    ", - "smithy.api#required": {} - } - }, - "SyncSource": { - "target": "com.amazonaws.ssm#ResourceDataSyncSource", + "SyncSource": { + "target": "com.amazonaws.ssm#ResourceDataSyncSource", "traits": { "smithy.api#documentation": "

    Specify information about the data sources to synchronize. This parameter is required if the\n SyncType value is SyncFromSource.

    " } @@ -4598,6 +4591,13 @@ "traits": { "smithy.api#documentation": "

    Amazon S3 configuration details for the sync. This parameter is required if the\n SyncType value is SyncToDestination.

    " } + }, + "SyncName": { + "target": "com.amazonaws.ssm#ResourceDataSyncName", + "traits": { + "smithy.api#documentation": "

    A name for the configuration.

    ", + "smithy.api#required": {} + } } } }, @@ -4710,10 +4710,10 @@ "com.amazonaws.ssm#DeleteAssociationRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    The ID of the instance.

    " + "smithy.api#documentation": "

    The name of the Systems Manager document.

    " } }, "AssociationId": { @@ -4722,10 +4722,10 @@ "smithy.api#documentation": "

    The association ID that you want to delete.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The name of the Systems Manager document.

    " + "smithy.api#documentation": "

    The ID of the instance.

    " } } } @@ -4769,10 +4769,10 @@ "smithy.api#documentation": "

    Some SSM document types require that you specify a Force flag before you can\n delete the document. For example, you must specify a Force flag to delete a document\n of type ApplicationConfigurationSchema. You can restrict access to the\n Force flag in an AWS Identity and Access Management (IAM) policy.

    " } }, - "VersionName": { - "target": "com.amazonaws.ssm#DocumentVersionName", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The version name of the document that you want to delete. If not provided, all versions of\n the document are deleted.

    " + "smithy.api#documentation": "

    The version of the document that you want to delete. If not provided, all versions of the\n document are deleted.

    " } }, "Name": { @@ -4782,10 +4782,10 @@ "smithy.api#required": {} } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "VersionName": { + "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    The version of the document that you want to delete. If not provided, all versions of the\n document are deleted.

    " + "smithy.api#documentation": "

    The version name of the document that you want to delete. If not provided, all versions of\n the document are deleted.

    " } } } @@ -4820,36 +4820,36 @@ } ], "traits": { - "smithy.api#documentation": "

    Delete a custom inventory type, or the data associated with a custom Inventory type.\n Deleting a custom inventory type is also referred to as deleting a custom inventory\n schema.

    " + "smithy.api#documentation": "

    Delete a custom inventory type or the data associated with a custom Inventory type. Deleting\n a custom inventory type is also referred to as deleting a custom inventory schema.

    " } }, "com.amazonaws.ssm#DeleteInventoryRequest": { "type": "structure", "members": { - "TypeName": { - "target": "com.amazonaws.ssm#InventoryItemTypeName", - "traits": { - "smithy.api#documentation": "

    The name of the custom inventory type for which you want to delete either all previously\n collected data, or the inventory type itself.

    ", - "smithy.api#required": {} - } - }, "SchemaDeleteOption": { "target": "com.amazonaws.ssm#InventorySchemaDeleteOption", "traits": { "smithy.api#documentation": "

    Use the SchemaDeleteOption to delete a custom inventory type (schema). If you\n don't choose this option, the system only deletes existing inventory data associated with the\n custom inventory type. Choose one of the following options:

    \n

    DisableSchema: If you choose this option, the system ignores all inventory data for the\n specified version, and any earlier versions. To enable this schema again, you must call the\n PutInventory action for a version greater than the disabled version.

    \n

    DeleteSchema: This option deletes the specified custom type from the Inventory service. You\n can recreate the schema later, if you want.

    " } }, + "ClientToken": { + "target": "com.amazonaws.ssm#UUID", + "traits": { + "smithy.api#documentation": "

    User-provided idempotency token.

    ", + "smithy.api#idempotencyToken": {} + } + }, "DryRun": { "target": "com.amazonaws.ssm#DryRun", "traits": { "smithy.api#documentation": "

    Use this option to view a summary of the deletion request without deleting any data or the\n data type. This option is useful when you only want to understand what will be deleted. Once you\n validate that the data to be deleted is what you intend to delete, you can run the same command\n without specifying the DryRun option.

    " } }, - "ClientToken": { - "target": "com.amazonaws.ssm#ClientToken", + "TypeName": { + "target": "com.amazonaws.ssm#InventoryItemTypeName", "traits": { - "smithy.api#documentation": "

    User-provided idempotency token.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    The name of the custom inventory type for which you want to delete either all previously\n collected data or the inventory type itself.

    ", + "smithy.api#required": {} } } } @@ -4858,22 +4858,22 @@ "type": "structure", "members": { "DeletionId": { - "target": "com.amazonaws.ssm#InventoryDeletionId", + "target": "com.amazonaws.ssm#UUID", "traits": { "smithy.api#documentation": "

    Every DeleteInventory action is assigned a unique ID. This option returns a\n unique ID. You can use this ID to query the status of a delete operation. This option is useful\n for ensuring that a delete operation has completed before you begin other actions.

    " } }, - "DeletionSummary": { - "target": "com.amazonaws.ssm#InventoryDeletionSummary", - "traits": { - "smithy.api#documentation": "

    A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the AWS Systems Manager User Guide.

    " - } - }, "TypeName": { "target": "com.amazonaws.ssm#InventoryItemTypeName", "traits": { "smithy.api#documentation": "

    The name of the inventory data type specified in the request.

    " } + }, + "DeletionSummary": { + "target": "com.amazonaws.ssm#InventoryDeletionSummary", + "traits": { + "smithy.api#documentation": "

    A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the AWS Systems Manager User Guide.

    " + } } } }, @@ -4985,16 +4985,16 @@ "com.amazonaws.ssm#DeleteParametersResult": { "type": "structure", "members": { - "DeletedParameters": { + "InvalidParameters": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "

    The names of the deleted parameters.

    " + "smithy.api#documentation": "

    The names of parameters that weren't deleted because the parameters are not valid.

    " } }, - "InvalidParameters": { + "DeletedParameters": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "

    The names of parameters that weren't deleted because the parameters are not valid.

    " + "smithy.api#documentation": "

    The names of the deleted parameters.

    " } } } @@ -5068,18 +5068,18 @@ "com.amazonaws.ssm#DeleteResourceDataSyncRequest": { "type": "structure", "members": { - "SyncType": { - "target": "com.amazonaws.ssm#ResourceDataSyncType", - "traits": { - "smithy.api#documentation": "

    Specify the type of resource data sync to delete.

    " - } - }, "SyncName": { "target": "com.amazonaws.ssm#ResourceDataSyncName", "traits": { "smithy.api#documentation": "

    The name of the configuration to delete.

    ", "smithy.api#required": {} } + }, + "SyncType": { + "target": "com.amazonaws.ssm#ResourceDataSyncType", + "traits": { + "smithy.api#documentation": "

    Specify the type of resource data sync to delete.

    " + } } } }, @@ -5208,13 +5208,6 @@ "com.amazonaws.ssm#DeregisterTargetFromMaintenanceWindowRequest": { "type": "structure", "members": { - "WindowTargetId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", - "traits": { - "smithy.api#documentation": "

    The ID of the target definition to remove.

    ", - "smithy.api#required": {} - } - }, "Safe": { "target": "com.amazonaws.ssm#Boolean", "traits": { @@ -5222,6 +5215,13 @@ "smithy.api#documentation": "

    The system checks if the target is being referenced by a task. If the target is being\n referenced, the system returns an error and does not deregister the target from the maintenance\n window.

    " } }, + "WindowTargetId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", + "traits": { + "smithy.api#documentation": "

    The ID of the target definition to remove.

    ", + "smithy.api#required": {} + } + }, "WindowId": { "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { @@ -5234,17 +5234,17 @@ "com.amazonaws.ssm#DeregisterTargetFromMaintenanceWindowResult": { "type": "structure", "members": { - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", - "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window the target was removed from.

    " - } - }, "WindowTargetId": { "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", "traits": { "smithy.api#documentation": "

    The ID of the removed target definition.

    " } + }, + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", + "traits": { + "smithy.api#documentation": "

    The ID of the maintenance window the target was removed from.

    " + } } } }, @@ -5381,12 +5381,6 @@ "com.amazonaws.ssm#DescribeActivationsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ssm#DescribeActivationsFilterList", - "traits": { - "smithy.api#documentation": "

    A filter to view information about your activations.

    " - } - }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { @@ -5399,6 +5393,12 @@ "traits": { "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " } + }, + "Filters": { + "target": "com.amazonaws.ssm#DescribeActivationsFilterList", + "traits": { + "smithy.api#documentation": "

    A filter to view information about your activations.

    " + } } } }, @@ -5471,7 +5471,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Use this API action to view information about a specific execution of a specific\n association.

    " + "smithy.api#documentation": "

    Use this API action to view information about a specific execution of a specific\n association.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssociationExecutionTargets", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeAssociationExecutionTargetsRequest": { @@ -5490,11 +5496,10 @@ "smithy.api#documentation": "

    Filters for the request. You can specify the following filters and values.

    \n

    Status (EQUAL)

    \n

    ResourceId (EQUAL)

    \n

    ResourceType (EQUAL)

    " } }, - "ExecutionId": { - "target": "com.amazonaws.ssm#AssociationExecutionId", + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", "traits": { - "smithy.api#documentation": "

    The execution ID for which you want to view details.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " } }, "AssociationId": { @@ -5504,10 +5509,11 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", + "ExecutionId": { + "target": "com.amazonaws.ssm#AssociationExecutionId", "traits": { - "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " + "smithy.api#documentation": "

    The execution ID for which you want to view details.

    ", + "smithy.api#required": {} } } } @@ -5515,17 +5521,17 @@ "com.amazonaws.ssm#DescribeAssociationExecutionTargetsResult": { "type": "structure", "members": { - "AssociationExecutionTargets": { - "target": "com.amazonaws.ssm#AssociationExecutionTargetsList", - "traits": { - "smithy.api#documentation": "

    Information about the execution.

    " - } - }, "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.

    " } + }, + "AssociationExecutionTargets": { + "target": "com.amazonaws.ssm#AssociationExecutionTargetsList", + "traits": { + "smithy.api#documentation": "

    Information about the execution.

    " + } } } }, @@ -5549,12 +5555,24 @@ } ], "traits": { - "smithy.api#documentation": "

    Use this API action to view all executions for a specific association ID.

    " + "smithy.api#documentation": "

    Use this API action to view all executions for a specific association ID.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssociationExecutions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeAssociationExecutionsRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ssm#AssociationExecutionFilterList", + "traits": { + "smithy.api#documentation": "

    Filters for the request. You can specify the following filters and values.

    \n

    ExecutionId (EQUAL)

    \n

    Status (EQUAL)

    \n

    CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

    " + } + }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { @@ -5562,10 +5580,10 @@ "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.

    " } }, - "Filters": { - "target": "com.amazonaws.ssm#AssociationExecutionFilterList", + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", "traits": { - "smithy.api#documentation": "

    Filters for the request. You can specify the following filters and values.

    \n

    ExecutionId (EQUAL)

    \n

    Status (EQUAL)

    \n

    CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

    " + "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " } }, "AssociationId": { @@ -5574,12 +5592,6 @@ "smithy.api#documentation": "

    The association ID for which you want to view execution history details.

    ", "smithy.api#required": {} } - }, - "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.

    " - } } } }, @@ -5609,18 +5621,18 @@ "smithy.api#documentation": "

    The association ID for which you want information.

    " } }, - "AssociationVersion": { - "target": "com.amazonaws.ssm#AssociationVersion", - "traits": { - "smithy.api#documentation": "

    Specify the association version to retrieve. To view the latest version, either specify\n $LATEST for this parameter, or omit this parameter. To view a list of all\n associations for an instance, use ListAssociations. To get a list of versions\n for a specific association, use ListAssociationVersions.

    " - } - }, "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { "smithy.api#documentation": "

    The name of the Systems Manager document.

    " } }, + "AssociationVersion": { + "target": "com.amazonaws.ssm#AssociationVersion", + "traits": { + "smithy.api#documentation": "

    Specify the association version to retrieve. To view the latest version, either specify\n $LATEST for this parameter, or omit this parameter. To view a list of all\n associations for an instance, use ListAssociations. To get a list of versions\n for a specific association, use ListAssociationVersions.

    " + } + }, "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { @@ -5663,12 +5675,25 @@ } ], "traits": { - "smithy.api#documentation": "

    Provides details about all active and terminated Automation executions.

    " + "smithy.api#documentation": "

    Provides details about all active and terminated Automation executions.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AutomationExecutionMetadataList", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeAutomationExecutionsRequest": { "type": "structure", "members": { + "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.

    " + } + }, "Filters": { "target": "com.amazonaws.ssm#AutomationExecutionFilterList", "traits": { @@ -5680,13 +5705,6 @@ "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.

    " - } } } }, @@ -5733,19 +5751,18 @@ } ], "traits": { - "smithy.api#documentation": "

    Information about all active and terminated step executions in an Automation\n workflow.

    " + "smithy.api#documentation": "

    Information about all active and terminated step executions in an Automation\n workflow.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StepExecutions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeAutomationStepExecutionsRequest": { "type": "structure", "members": { - "AutomationExecutionId": { - "target": "com.amazonaws.ssm#AutomationExecutionId", - "traits": { - "smithy.api#documentation": "

    The Automation execution ID for which you want step execution descriptions.

    ", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { @@ -5753,16 +5770,17 @@ "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", + "AutomationExecutionId": { + "target": "com.amazonaws.ssm#AutomationExecutionId", "traits": { - "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " + "smithy.api#documentation": "

    The Automation execution ID for which you want step execution descriptions.

    ", + "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.ssm#StepExecutionFilterList", + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", "traits": { - "smithy.api#documentation": "

    One or more filters to limit the number of step executions returned by the request.

    " + "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " } }, "ReverseOrder": { @@ -5771,6 +5789,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "

    A boolean that indicates whether to list step executions in reverse order by start time. The\n default value is false.

    " } + }, + "Filters": { + "target": "com.amazonaws.ssm#StepExecutionFilterList", + "traits": { + "smithy.api#documentation": "

    One or more filters to limit the number of step executions returned by the request.

    " + } } } }, @@ -5805,16 +5829,22 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists all patches eligible to be included in a patch baseline.

    " + "smithy.api#documentation": "

    Lists all patches eligible to be included in a patch baseline.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Patches", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeAvailablePatchesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", + "Filters": { + "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", "traits": { - "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " + "smithy.api#documentation": "

    Filters used to scope down the returned patches.

    " } }, "MaxResults": { @@ -5824,10 +5854,10 @@ "smithy.api#documentation": "

    The maximum number of patches to return (per page).

    " } }, - "Filters": { - "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", "traits": { - "smithy.api#documentation": "

    Filters used to scope down the returned patches.

    " + "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " } } } @@ -5835,17 +5865,17 @@ "com.amazonaws.ssm#DescribeAvailablePatchesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "Patches": { "target": "com.amazonaws.ssm#PatchList", "traits": { "smithy.api#documentation": "

    An array of patches. Each entry in the array is a patch structure.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, @@ -5934,12 +5964,6 @@ "com.amazonaws.ssm#DescribeDocumentRequest": { "type": "structure", "members": { - "VersionName": { - "target": "com.amazonaws.ssm#DocumentVersionName", - "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n cannot be changed.

    " - } - }, "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { @@ -5947,6 +5971,12 @@ "smithy.api#required": {} } }, + "VersionName": { + "target": "com.amazonaws.ssm#DocumentVersionName", + "traits": { + "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n cannot be changed.

    " + } + }, "DocumentVersion": { "target": "com.amazonaws.ssm#DocumentVersion", "traits": { @@ -5986,19 +6016,18 @@ } ], "traits": { - "smithy.api#documentation": "

    All associations for the instance(s).

    " + "smithy.api#documentation": "

    All associations for the instance(s).

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Associations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeEffectiveInstanceAssociationsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.ssm#EffectiveInstanceAssociationMaxResults", - "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.

    " - } - }, "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { @@ -6011,23 +6040,30 @@ "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#EffectiveInstanceAssociationMaxResults", + "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#DescribeEffectiveInstanceAssociationsResult": { "type": "structure", "members": { - "Associations": { - "target": "com.amazonaws.ssm#InstanceAssociationList", - "traits": { - "smithy.api#documentation": "

    The associations for the requested instance.

    " - } - }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " } + }, + "Associations": { + "target": "com.amazonaws.ssm#InstanceAssociationList", + "traits": { + "smithy.api#documentation": "

    The associations for the requested instance.

    " + } } } }, @@ -6054,7 +6090,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the current effective patches (the patch and the approval state) for the specified\n patch baseline. Note that this API applies only to Windows patch baselines.

    " + "smithy.api#documentation": "

    Retrieves the current effective patches (the patch and the approval state) for the specified\n patch baseline. Note that this API applies only to Windows patch baselines.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EffectivePatches", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeEffectivePatchesForPatchBaselineRequest": { @@ -6067,35 +6109,35 @@ "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#PatchBaselineMaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

    The maximum number of patches to return (per page).

    " } + }, + "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.)

    " + } } } }, "com.amazonaws.ssm#DescribeEffectivePatchesForPatchBaselineResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "EffectivePatches": { "target": "com.amazonaws.ssm#EffectivePatchList", "traits": { "smithy.api#documentation": "

    An array of patches and patch status.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, @@ -6119,12 +6161,24 @@ } ], "traits": { - "smithy.api#documentation": "

    The status of the associations for the instance(s).

    " + "smithy.api#documentation": "

    The status of the associations for the instance(s).

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceAssociationStatusInfos", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeInstanceAssociationsStatusRequest": { "type": "structure", "members": { + "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.)

    " + } + }, "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { @@ -6132,12 +6186,6 @@ "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": { @@ -6214,18 +6262,18 @@ "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of instances. You can\n filter based on tags applied to EC2 instances. Use this Filters data type instead of\n InstanceInformationFilterList, which is deprecated.

    " } }, - "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#MaxResultsEC2Compatible", "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": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " + } } } }, @@ -6263,7 +6311,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the high-level patch state of one or more instances.

    " + "smithy.api#documentation": "

    Retrieves the high-level patch state of one or more instances.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstancePatchStates", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeInstancePatchStatesForPatchGroup": { @@ -6286,7 +6340,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the high-level patch state for the instances in the specified patch group.

    " + "smithy.api#documentation": "

    Retrieves the high-level patch state for the instances in the specified patch group.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstancePatchStates", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeInstancePatchStatesForPatchGroupRequest": { @@ -6299,12 +6359,6 @@ "smithy.api#required": {} } }, - "Filters": { - "target": "com.amazonaws.ssm#InstancePatchStateFilterList", - "traits": { - "smithy.api#documentation": "

    Each entry in the array is a structure containing:

    \n

    Key (string between 1 and 200 characters)

    \n

    Values (array containing a single string)

    \n

    Type (string \"Equal\", \"NotEqual\", \"LessThan\", \"GreaterThan\")

    " - } - }, "MaxResults": { "target": "com.amazonaws.ssm#PatchComplianceMaxResults", "traits": { @@ -6312,6 +6366,12 @@ "smithy.api#documentation": "

    The maximum number of patches to return (per page).

    " } }, + "Filters": { + "target": "com.amazonaws.ssm#InstancePatchStateFilterList", + "traits": { + "smithy.api#documentation": "

    Each entry in the array is a structure containing:

    \n

    Key (string between 1 and 200 characters)

    \n

    Values (array containing a single string)

    \n

    Type (string \"Equal\", \"NotEqual\", \"LessThan\", \"GreaterThan\")

    " + } + }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { @@ -6323,29 +6383,23 @@ "com.amazonaws.ssm#DescribeInstancePatchStatesForPatchGroupResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "InstancePatchStates": { "target": "com.amazonaws.ssm#InstancePatchStatesList", "traits": { "smithy.api#documentation": "

    The high-level patch state for the requested instances.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, "com.amazonaws.ssm#DescribeInstancePatchStatesRequest": { "type": "structure", "members": { - "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.)

    " - } - }, "InstanceIds": { "target": "com.amazonaws.ssm#InstanceIdList", "traits": { @@ -6353,6 +6407,12 @@ "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#PatchComplianceMaxResults", "traits": { @@ -6365,17 +6425,17 @@ "com.amazonaws.ssm#DescribeInstancePatchStatesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "InstancePatchStates": { "target": "com.amazonaws.ssm#InstancePatchStateList", "traits": { "smithy.api#documentation": "

    The high-level patch state for the requested instances.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, @@ -6402,19 +6462,18 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves information about the patches on the specified instance and their state relative\n to the patch baseline being used for the instance.

    " + "smithy.api#documentation": "

    Retrieves information about the patches on the specified instance and their state relative\n to the patch baseline being used for the instance.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Patches", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeInstancePatchesRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", - "traits": { - "smithy.api#documentation": "

    The ID of the instance whose patch state information should be retrieved.

    ", - "smithy.api#required": {} - } - }, "MaxResults": { "target": "com.amazonaws.ssm#PatchComplianceMaxResults", "traits": { @@ -6422,34 +6481,41 @@ "smithy.api#documentation": "

    The maximum number of patches to return (per page).

    " } }, - "Filters": { - "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", - "traits": { - "smithy.api#documentation": "

    An array of structures. Each entry in the array is a structure containing a Key, Value\n combination. Valid values for Key are Classification | KBId |\n Severity | State.

    " - } - }, "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.)

    " } + }, + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", + "traits": { + "smithy.api#documentation": "

    The ID of the instance whose patch state information should be retrieved.

    ", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", + "traits": { + "smithy.api#documentation": "

    An array of structures. Each entry in the array is a structure containing a Key, Value\n combination. Valid values for Key are Classification | KBId |\n Severity | State.

    " + } } } }, "com.amazonaws.ssm#DescribeInstancePatchesResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "Patches": { "target": "com.amazonaws.ssm#PatchComplianceDataList", "traits": { "smithy.api#documentation": "

    Each entry in the array is a structure containing:

    \n

    Title (string)

    \n

    KBId (string)

    \n

    Classification (string)

    \n

    Severity (string)

    \n

    State (string, such as \"INSTALLED\" or \"FAILED\")

    \n

    InstalledTime (DateTime)

    \n

    InstalledBy (string)

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, @@ -6473,24 +6539,30 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a specific delete inventory operation.

    " + "smithy.api#documentation": "

    Describes a specific delete inventory operation.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InventoryDeletions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeInventoryDeletionsRequest": { "type": "structure", "members": { - "DeletionId": { - "target": "com.amazonaws.ssm#InventoryDeletionId", - "traits": { - "smithy.api#documentation": "

    Specify the delete inventory ID for which you want information. This ID was returned by the\n DeleteInventory action.

    " - } - }, "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.

    " } }, + "DeletionId": { + "target": "com.amazonaws.ssm#UUID", + "traits": { + "smithy.api#documentation": "

    Specify the delete inventory ID for which you want information. This ID was returned by the\n DeleteInventory action.

    " + } + }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { @@ -6534,12 +6606,31 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the individual task executions (one per target) for a particular task run as part\n of a maintenance window execution.

    " + "smithy.api#documentation": "

    Retrieves the individual task executions (one per target) for a particular task run as part\n of a maintenance window execution.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "WindowExecutionTaskInvocationIdentities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowExecutionTaskInvocationsRequest": { "type": "structure", "members": { + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "traits": { + "smithy.api#documentation": "

    The ID of the maintenance window execution the task is part of.

    ", + "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#MaintenanceWindowMaxResults", "traits": { @@ -6547,31 +6638,18 @@ "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.

    " } }, + "Filters": { + "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", + "traits": { + "smithy.api#documentation": "

    Optional filters used to scope down the returned task invocations. The supported filter key\n is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT,\n CANCELLING, and CANCELLED.

    " + } + }, "TaskId": { "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", "traits": { "smithy.api#documentation": "

    The ID of the specific task in the maintenance window task that should be retrieved.

    ", "smithy.api#required": {} } - }, - "Filters": { - "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", - "traits": { - "smithy.api#documentation": "

    Optional filters used to scope down the returned task invocations. The supported filter key\n is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT,\n CANCELLING, and CANCELLED.

    " - } - }, - "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.)

    " - } - }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", - "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window execution the task is part of.

    ", - "smithy.api#required": {} - } } } }, @@ -6609,24 +6687,31 @@ } ], "traits": { - "smithy.api#documentation": "

    For a given maintenance window execution, lists the tasks that were run.

    " + "smithy.api#documentation": "

    For a given maintenance window execution, lists the tasks that were run.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "WindowExecutionTaskIdentities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowExecutionTasksRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", - "traits": { - "smithy.api#documentation": "

    Optional filters used to scope down the returned tasks. The supported filter key is STATUS\n with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and\n CANCELLED.

    " - } - }, "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.)

    " } }, + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "traits": { + "smithy.api#documentation": "

    The ID of the maintenance window execution whose task executions should be retrieved.

    ", + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { @@ -6634,11 +6719,10 @@ "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.

    " } }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "Filters": { + "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window execution whose task executions should be retrieved.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Optional filters used to scope down the returned tasks. The supported filter key is STATUS\n with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and\n CANCELLED.

    " } } } @@ -6646,17 +6730,17 @@ "com.amazonaws.ssm#DescribeMaintenanceWindowExecutionTasksResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "WindowExecutionTaskIdentities": { "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskIdentityList", "traits": { "smithy.api#documentation": "

    Information about the task executions.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, @@ -6674,19 +6758,18 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the executions of a maintenance window. This includes information about when the\n maintenance window was scheduled to be active, and information about tasks registered and run\n with the maintenance window.

    " + "smithy.api#documentation": "

    Lists the executions of a maintenance window. This includes information about when the\n maintenance window was scheduled to be active, and information about tasks registered and run\n with the maintenance window.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "WindowExecutions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowExecutionsRequest": { "type": "structure", "members": { - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", - "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window whose executions should be retrieved.

    ", - "smithy.api#required": {} - } - }, "Filters": { "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", "traits": { @@ -6705,6 +6788,13 @@ "traits": { "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " } + }, + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", + "traits": { + "smithy.api#documentation": "

    The ID of the maintenance window whose executions should be retrieved.

    ", + "smithy.api#required": {} + } } } }, @@ -6742,7 +6832,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves information about upcoming executions of a maintenance window.

    " + "smithy.api#documentation": "

    Retrieves information about upcoming executions of a maintenance window.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledWindowExecutions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowScheduleRequest": { @@ -6754,6 +6850,19 @@ "smithy.api#documentation": "

    Filters used to limit the range of results. For example, you can limit maintenance window\n executions to only those scheduled before or after a certain date and time.

    " } }, + "MaxResults": { + "target": "com.amazonaws.ssm#MaintenanceWindowSearchMaxResults", + "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": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " + } + }, "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { @@ -6771,36 +6880,23 @@ "traits": { "smithy.api#documentation": "

    The ID of the maintenance window to retrieve information about.

    " } - }, - "MaxResults": { - "target": "com.amazonaws.ssm#MaintenanceWindowSearchMaxResults", - "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": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " - } } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowScheduleResult": { "type": "structure", "members": { - "ScheduledWindowExecutions": { - "target": "com.amazonaws.ssm#ScheduledWindowExecutionList", - "traits": { - "smithy.api#documentation": "

    Information about maintenance window executions scheduled for the specified time\n range.

    " - } - }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { "smithy.api#documentation": "

    The token for the next set of items to return. (You use this token in the next call.)

    " } + }, + "ScheduledWindowExecutions": { + "target": "com.amazonaws.ssm#ScheduledWindowExecutionList", + "traits": { + "smithy.api#documentation": "

    Information about maintenance window executions scheduled for the specified time\n range.

    " + } } } }, @@ -6821,7 +6917,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the targets registered with the maintenance window.

    " + "smithy.api#documentation": "

    Lists the targets registered with the maintenance window.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Targets", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowTargetsRequest": { @@ -6839,36 +6941,36 @@ "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#MaintenanceWindowMaxResults", - "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.

    " - } - }, "WindowId": { "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { "smithy.api#documentation": "

    The ID of the maintenance window whose targets should be retrieved.

    ", "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", + "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#DescribeMaintenanceWindowTargetsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "Targets": { "target": "com.amazonaws.ssm#MaintenanceWindowTargetList", "traits": { "smithy.api#documentation": "

    Information about the targets in the maintenance window.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, @@ -6889,24 +6991,31 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the tasks in a maintenance window.

    " + "smithy.api#documentation": "

    Lists the tasks in a maintenance window.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tasks", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowTasksRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", - "traits": { - "smithy.api#documentation": "

    Optional filters used to narrow down the scope of the returned tasks. The supported filter\n keys are WindowTaskId, TaskArn, Priority, and TaskType.

    " - } - }, "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.)

    " } }, + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", + "traits": { + "smithy.api#documentation": "

    The ID of the maintenance window whose tasks should be retrieved.

    ", + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.ssm#MaintenanceWindowMaxResults", "traits": { @@ -6914,11 +7023,10 @@ "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.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "Filters": { + "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window whose tasks should be retrieved.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Optional filters used to narrow down the scope of the returned tasks. The supported filter\n keys are WindowTaskId, TaskArn, Priority, and TaskType.

    " } } } @@ -6926,17 +7034,17 @@ "com.amazonaws.ssm#DescribeMaintenanceWindowTasksResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", - "traits": { - "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " - } - }, "Tasks": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskList", "traits": { "smithy.api#documentation": "

    Information about the tasks in the maintenance window.

    " } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " + } } } }, @@ -6954,7 +7062,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the maintenance windows in an AWS account.

    " + "smithy.api#documentation": "

    Retrieves the maintenance windows in an AWS account.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "WindowIdentities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowsForTarget": { @@ -6971,7 +7085,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves information about the maintenance window targets or tasks that an instance is\n associated with.

    " + "smithy.api#documentation": "

    Retrieves information about the maintenance window targets or tasks that an instance is\n associated with.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "WindowIdentities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeMaintenanceWindowsForTargetRequest": { @@ -6984,11 +7104,11 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.ssm#MaintenanceWindowSearchMaxResults", + "ResourceType": { + "target": "com.amazonaws.ssm#MaintenanceWindowResourceType", "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 type of resource you want to retrieve information about. For example, \"INSTANCE\".

    ", + "smithy.api#required": {} } }, "NextToken": { @@ -6997,11 +7117,11 @@ "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " } }, - "ResourceType": { - "target": "com.amazonaws.ssm#MaintenanceWindowResourceType", + "MaxResults": { + "target": "com.amazonaws.ssm#MaintenanceWindowSearchMaxResults", "traits": { - "smithy.api#documentation": "

    The type of resource you want to retrieve information about. For example, \"INSTANCE\".

    ", - "smithy.api#required": {} + "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.

    " } } } @@ -7026,6 +7146,12 @@ "com.amazonaws.ssm#DescribeMaintenanceWindowsRequest": { "type": "structure", "members": { + "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.)

    " + } + }, "Filters": { "target": "com.amazonaws.ssm#MaintenanceWindowFilterList", "traits": { @@ -7038,12 +7164,6 @@ "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": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " - } } } }, @@ -7078,7 +7198,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Query a set of OpsItems. You must have permission in AWS Identity and Access Management\n (IAM) to query a list of OpsItems. For more information, see Getting started with\n OpsCenter in the AWS Systems Manager User Guide.

    \n

    Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate\n operational issues impacting the performance and health of their AWS resources. For more\n information, see AWS Systems Manager OpsCenter in the\n AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    Query a set of OpsItems. You must have permission in AWS Identity and Access Management\n (IAM) to query a list of OpsItems. For more information, see Getting started with\n OpsCenter in the AWS Systems Manager User Guide.

    \n

    Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate\n operational issues impacting the performance and health of their AWS resources. For more\n information, see AWS Systems Manager OpsCenter in the\n AWS Systems Manager User Guide.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OpsItemSummaries", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeOpsItemsRequest": { @@ -7090,34 +7216,34 @@ "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#String", - "traits": { - "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " - } - }, "OpsItemFilters": { "target": "com.amazonaws.ssm#OpsItemFilters", "traits": { "smithy.api#documentation": "

    One or more filters to limit the response.

    \n
      \n
    • \n

      Key: CreatedTime

      \n

      Operations: GreaterThan, LessThan

      \n
      • \n
    • \n

      Key: LastModifiedBy

      \n

      Operations: Contains, Equals

      \n
      • \n
    • \n

      Key: LastModifiedTime

      \n

      Operations: GreaterThan, LessThan

      \n
      • \n
    • \n

      Key: Priority

      \n

      Operations: Equals

      \n
      • \n
    • \n

      Key: Source

      \n

      Operations: Contains, Equals

      \n
      • \n
    • \n

      Key: Status

      \n

      Operations: Equals

      \n
      • \n
    • \n

      Key: Title

      \n

      Operations: Contains

      \n
      • \n
    • \n

      Key: OperationalData*

      \n

      Operations: Equals

      \n
      • \n
    • \n

      Key: OperationalDataKey

      \n

      Operations: Equals

      \n
      • \n
    • \n

      Key: OperationalDataValue

      \n

      Operations: Equals, Contains

      \n
      • \n
    • \n

      Key: OpsItemId

      \n

      Operations: Equals

      \n
      • \n
    • \n

      Key: ResourceId

      \n

      Operations: Contains

      \n
      • \n
    • \n

      Key: AutomationId

      \n

      Operations: Equals

      \n
      • \n
    \n

    *If you filter the response by using the OperationalData operator, specify a key-value pair\n by using the following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}

    " } + }, + "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.

    " + } } } }, "com.amazonaws.ssm#DescribeOpsItemsResponse": { "type": "structure", "members": { - "OpsItemSummaries": { - "target": "com.amazonaws.ssm#OpsItemSummaries", - "traits": { - "smithy.api#documentation": "

    A list of OpsItems.

    " - } - }, "NextToken": { "target": "com.amazonaws.ssm#String", "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.

    " } + }, + "OpsItemSummaries": { + "target": "com.amazonaws.ssm#OpsItemSummaries", + "traits": { + "smithy.api#documentation": "

    A list of OpsItems.

    " + } } } }, @@ -7164,12 +7290,6 @@ "smithy.api#documentation": "

    This data type is deprecated. Instead, use ParameterFilters.

    " } }, - "ParameterFilters": { - "target": "com.amazonaws.ssm#ParameterStringFilterList", - "traits": { - "smithy.api#documentation": "

    Filters to limit the request results.

    " - } - }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { @@ -7182,6 +7302,12 @@ "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.

    " } + }, + "ParameterFilters": { + "target": "com.amazonaws.ssm#ParameterStringFilterList", + "traits": { + "smithy.api#documentation": "

    Filters to limit the request results.

    " + } } } }, @@ -7216,7 +7342,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the patch baselines in your AWS account.

    " + "smithy.api#documentation": "

    Lists the patch baselines in your AWS account.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "BaselineIdentities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribePatchBaselinesRequest": { @@ -7229,17 +7361,17 @@ "smithy.api#documentation": "

    The maximum number of patch baselines to return (per page).

    " } }, - "Filters": { - "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", - "traits": { - "smithy.api#documentation": "

    Each element in the array is a structure containing:

    \n

    Key: (string, \"NAME_PREFIX\" or \"OWNER\")

    \n

    Value: (array of strings, exactly 1 entry, between 1 and 255 characters)

    " - } - }, "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.)

    " } + }, + "Filters": { + "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", + "traits": { + "smithy.api#documentation": "

    Each element in the array is a structure containing:

    \n

    Key: (string, \"NAME_PREFIX\" or \"OWNER\")

    \n

    Value: (array of strings, exactly 1 entry, between 1 and 255 characters)

    " + } } } }, @@ -7295,30 +7427,29 @@ "com.amazonaws.ssm#DescribePatchGroupStateResult": { "type": "structure", "members": { - "InstancesWithUnreportedNotApplicablePatches": { + "InstancesWithFailedPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The number of instances with NotApplicable patches beyond the supported limit,\n which are not reported by name to Systems Manager Inventory.

    " + "smithy.api#documentation": "

    The number of instances with patches from the patch baseline that failed to install.

    " } }, - "InstancesWithFailedPatches": { + "InstancesWithUnreportedNotApplicablePatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

    The number of instances with patches from the patch baseline that failed to install.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The number of instances with NotApplicable patches beyond the supported limit,\n which are not reported by name to Systems Manager Inventory.

    " } }, - "InstancesWithInstalledPatches": { + "Instances": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

    The number of instances with installed patches.

    " + "smithy.api#documentation": "

    The number of instances in the patch group.

    " } }, - "InstancesWithInstalledPendingRebootPatches": { - "target": "com.amazonaws.ssm#InstancesCount", + "InstancesWithMissingPatches": { + "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The number of instances with patches installed by Patch Manager that have not been rebooted\n after the patch installation. The status of these instances is NON_COMPLIANT.

    " + "smithy.api#documentation": "

    The number of instances with missing patches from the patch baseline.

    " } }, "InstancesWithInstalledRejectedPatches": { @@ -7334,22 +7465,23 @@ "smithy.api#documentation": "

    The number of instances with patches that aren't applicable.

    " } }, - "InstancesWithInstalledOtherPatches": { - "target": "com.amazonaws.ssm#Integer", + "InstancesWithInstalledPendingRebootPatches": { + "target": "com.amazonaws.ssm#InstancesCount", "traits": { - "smithy.api#documentation": "

    The number of instances with patches installed that aren't defined in the patch\n baseline.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The number of instances with patches installed by Patch Manager that have not been rebooted\n after the patch installation. The status of these instances is NON_COMPLIANT.

    " } }, - "InstancesWithMissingPatches": { + "InstancesWithInstalledPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

    The number of instances with missing patches from the patch baseline.

    " + "smithy.api#documentation": "

    The number of instances with installed patches.

    " } }, - "Instances": { + "InstancesWithInstalledOtherPatches": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

    The number of instances in the patch group.

    " + "smithy.api#documentation": "

    The number of instances with patches installed that aren't defined in the patch\n baseline.

    " } } } @@ -7368,12 +7500,24 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists all patch groups that have been registered with patch baselines.

    " + "smithy.api#documentation": "

    Lists all patch groups that have been registered with patch baselines.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Mappings", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribePatchGroupsRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", + "traits": { + "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    \n

    For DescribePatchGroups,valid filter keys include the following:

    \n
      \n
    • \n

      \n NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.

      \n
      • \n
    • \n

      \n OPERATING_SYSTEM: The supported operating system type to return results for.\n For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

      \n

      Examples:

      \n
        \n
      • \n

        \n --filters Key=NAME_PREFIX,Values=MyPatchGroup*\n

        \n
        • \n
      • \n

        \n --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2\n

        \n
        • \n
      \n
      • \n
    " + } + }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { @@ -7386,12 +7530,6 @@ "smithy.api#box": {}, "smithy.api#documentation": "

    The maximum number of patch groups to return (per page).

    " } - }, - "Filters": { - "target": "com.amazonaws.ssm#PatchOrchestratorFilterList", - "traits": { - "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    \n

    For DescribePatchGroups,valid filter keys include the following:

    \n
      \n
    • \n

      \n NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.

      \n
      • \n
    • \n

      \n OPERATING_SYSTEM: The supported operating system type to return results for.\n For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

      \n

      Examples:

      \n
        \n
      • \n

        \n --filters Key=NAME_PREFIX,Values=MyPatchGroup*\n

        \n
        • \n
      • \n

        \n --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2\n

        \n
        • \n
      \n
      • \n
    " - } } } }, @@ -7426,19 +7564,18 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the properties of available patches organized by product, product family,\n classification, severity, and other properties of available patches. You can use the reported\n properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

    \n

    The following section lists the properties that can be used in filters for each major\n operating system type:

    \n
    \n
    WINDOWS
    \n
    \n

    Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY

    \n
    \n
    AMAZON_LINUX
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    AMAZON_LINUX_2
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    UBUNTU
    \n
    \n

    Valid properties: PRODUCT, PRIORITY

    \n
    \n
    REDHAT_ENTERPRISE_LINUX
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    SUSE
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    CENTOS
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    " + "smithy.api#documentation": "

    Lists the properties of available patches organized by product, product family,\n classification, severity, and other properties of available patches. You can use the reported\n properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

    \n

    The following section lists the properties that can be used in filters for each major\n operating system type:

    \n
    \n
    AMAZON_LINUX
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    AMAZON_LINUX_2
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    CENTOS
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    DEBIAN
    \n
    \n

    Valid properties: PRODUCT, PRIORITY

    \n
    \n
    ORACLE_LINUX
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    REDHAT_ENTERPRISE_LINUX
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    SUSE
    \n
    \n

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    \n
    \n
    UBUNTU
    \n
    \n

    Valid properties: PRODUCT, PRIORITY

    \n
    \n
    WINDOWS
    \n
    \n

    Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY

    \n
    \n
    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Properties", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribePatchPropertiesRequest": { "type": "structure", "members": { - "Property": { - "target": "com.amazonaws.ssm#PatchProperty", - "traits": { - "smithy.api#documentation": "

    The patch property for which you want to view patch details.

    ", - "smithy.api#required": {} - } - }, "OperatingSystem": { "target": "com.amazonaws.ssm#OperatingSystem", "traits": { @@ -7446,12 +7583,6 @@ "smithy.api#required": {} } }, - "PatchSet": { - "target": "com.amazonaws.ssm#PatchSet", - "traits": { - "smithy.api#documentation": "

    Indicates whether to list patches for the Windows operating system or for Microsoft\n applications. Not applicable for Linux operating systems.

    " - } - }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { @@ -7464,6 +7595,19 @@ "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.

    " } + }, + "Property": { + "target": "com.amazonaws.ssm#PatchProperty", + "traits": { + "smithy.api#documentation": "

    The patch property for which you want to view patch details.

    ", + "smithy.api#required": {} + } + }, + "PatchSet": { + "target": "com.amazonaws.ssm#PatchSet", + "traits": { + "smithy.api#documentation": "

    Indicates whether to list patches for the Windows operating system or for Microsoft\n applications. Not applicable for Linux operating systems.

    " + } } } }, @@ -7504,7 +7648,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves a list of all active sessions (both connected and disconnected) or terminated\n sessions from the past 30 days.

    " + "smithy.api#documentation": "

    Retrieves a list of all active sessions (both connected and disconnected) or terminated\n sessions from the past 30 days.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Sessions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#DescribeSessionsRequest": { @@ -7541,17 +7691,17 @@ "com.amazonaws.ssm#DescribeSessionsResponse": { "type": "structure", "members": { - "Sessions": { - "target": "com.amazonaws.ssm#SessionList", - "traits": { - "smithy.api#documentation": "

    A list of sessions meeting the request parameters.

    " - } - }, "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.)

    " } + }, + "Sessions": { + "target": "com.amazonaws.ssm#SessionList", + "traits": { + "smithy.api#documentation": "

    A list of sessions meeting the request parameters.

    " + } } } }, @@ -7587,10 +7737,10 @@ "com.amazonaws.ssm#DocumentDefaultVersionDescription": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ssm#DocumentName", + "DefaultVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The name of the document.

    " + "smithy.api#documentation": "

    The default version of the document.

    " } }, "DefaultVersionName": { @@ -7599,10 +7749,10 @@ "smithy.api#documentation": "

    The default version of the artifact associated with the document.

    " } }, - "DefaultVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "Name": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    The default version of the document.

    " + "smithy.api#documentation": "

    The name of the document.

    " } } }, @@ -7613,28 +7763,28 @@ "com.amazonaws.ssm#DocumentDescription": { "type": "structure", "members": { - "SchemaVersion": { - "target": "com.amazonaws.ssm#DocumentSchemaVersion", + "Tags": { + "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

    The schema version.

    " + "smithy.api#documentation": "

    The tags, or metadata, that have been applied to the document.

    " } }, - "Owner": { - "target": "com.amazonaws.ssm#DocumentOwner", + "PlatformTypes": { + "target": "com.amazonaws.ssm#PlatformTypeList", "traits": { - "smithy.api#documentation": "

    The AWS user account that created the document.

    " + "smithy.api#documentation": "

    The list of OS platforms compatible with this Systems Manager document.

    " } }, - "AttachmentsInformation": { - "target": "com.amazonaws.ssm#AttachmentInformationList", + "TargetType": { + "target": "com.amazonaws.ssm#TargetType", "traits": { - "smithy.api#documentation": "

    Details about the document attachments, including names, locations, sizes, and so on.

    " + "smithy.api#documentation": "

    The target type which defines the kinds of resources the document can run on. For example,\n /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types\n reference in the AWS CloudFormation User Guide.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.ssm#DateTime", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The date when the document was created.

    " + "smithy.api#documentation": "

    The document version.

    " } }, "DefaultVersion": { @@ -7643,58 +7793,70 @@ "smithy.api#documentation": "

    The default version.

    " } }, + "Status": { + "target": "com.amazonaws.ssm#DocumentStatus", + "traits": { + "smithy.api#documentation": "

    The status of the Systems Manager document.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    The date when the document was created.

    " + } + }, "Requires": { "target": "com.amazonaws.ssm#DocumentRequiresList", "traits": { "smithy.api#documentation": "

    A list of SSM documents required by a document. For example, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document.

    " } }, - "PlatformTypes": { - "target": "com.amazonaws.ssm#PlatformTypeList", + "DocumentFormat": { + "target": "com.amazonaws.ssm#DocumentFormat", "traits": { - "smithy.api#documentation": "

    The list of OS platforms compatible with this Systems Manager document.

    " + "smithy.api#documentation": "

    The document format, either JSON or YAML.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#DescriptionInDocument", + "Owner": { + "target": "com.amazonaws.ssm#DocumentOwner", "traits": { - "smithy.api#documentation": "

    A description of the document.

    " + "smithy.api#documentation": "

    The AWS user account that created the document.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#DocumentStatus", + "AttachmentsInformation": { + "target": "com.amazonaws.ssm#AttachmentInformationList", "traits": { - "smithy.api#documentation": "

    The status of the Systems Manager document.

    " + "smithy.api#documentation": "

    Details about the document attachments, including names, locations, sizes, and so on.

    " } }, - "VersionName": { - "target": "com.amazonaws.ssm#DocumentVersionName", + "SchemaVersion": { + "target": "com.amazonaws.ssm#DocumentSchemaVersion", "traits": { - "smithy.api#documentation": "

    The version of the artifact associated with the document.

    " + "smithy.api#documentation": "

    The schema version.

    " } }, - "TargetType": { - "target": "com.amazonaws.ssm#TargetType", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    The target type which defines the kinds of resources the document can run on. For example,\n /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types\n reference in the AWS CloudFormation User Guide.

    " + "smithy.api#documentation": "

    The name of the Systems Manager document.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "Description": { + "target": "com.amazonaws.ssm#DescriptionInDocument", "traits": { - "smithy.api#documentation": "

    The document version.

    " + "smithy.api#documentation": "

    A description of the document.

    " } }, - "DocumentFormat": { - "target": "com.amazonaws.ssm#DocumentFormat", + "Sha1": { + "target": "com.amazonaws.ssm#DocumentSha1", "traits": { - "smithy.api#documentation": "

    The document format, either JSON or YAML.

    " + "smithy.api#documentation": "

    The SHA1 hash of the document, which you can use for verification.

    " } }, - "Tags": { - "target": "com.amazonaws.ssm#TagList", + "VersionName": { + "target": "com.amazonaws.ssm#DocumentVersionName", "traits": { - "smithy.api#documentation": "

    The tags, or metadata, that have been applied to the document.

    " + "smithy.api#documentation": "

    The version of the artifact associated with the document.

    " } }, "HashType": { @@ -7703,10 +7865,10 @@ "smithy.api#documentation": "

    The hash type of the document. Valid values include Sha256 or\n Sha1.

    \n \n

    Sha1 hashes have been deprecated.

    \n     " } }, - "Hash": { - "target": "com.amazonaws.ssm#DocumentHash", + "DocumentType": { + "target": "com.amazonaws.ssm#DocumentType", "traits": { - "smithy.api#documentation": "

    The Sha256 or Sha1 hash created by the system when the document was created.

    \n \n

    Sha1 hashes have been deprecated.

    \n     " + "smithy.api#documentation": "

    The type of document.

    " } }, "StatusInformation": { @@ -7715,10 +7877,10 @@ "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.\"

    " } }, - "Sha1": { - "target": "com.amazonaws.ssm#DocumentSha1", + "Hash": { + "target": "com.amazonaws.ssm#DocumentHash", "traits": { - "smithy.api#documentation": "

    The SHA1 hash of the document, which you can use for verification.

    " + "smithy.api#documentation": "

    The Sha256 or Sha1 hash created by the system when the document was created.

    \n \n

    Sha1 hashes have been deprecated.

    \n     " } }, "LatestVersion": { @@ -7732,18 +7894,6 @@ "traits": { "smithy.api#documentation": "

    A description of the parameters for a document.

    " } - }, - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", - "traits": { - "smithy.api#documentation": "

    The name of the Systems Manager document.

    " - } - }, - "DocumentType": { - "target": "com.amazonaws.ssm#DocumentType", - "traits": { - "smithy.api#documentation": "

    The type of document.

    " - } } }, "traits": { @@ -7753,20 +7903,20 @@ "com.amazonaws.ssm#DocumentFilter": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.ssm#DocumentFilterKey", - "traits": { - "smithy.api#documentation": "

    The name of the filter.

    ", - "smithy.api#required": {} - } - }, "value": { "target": "com.amazonaws.ssm#DocumentFilterValue", "traits": { "smithy.api#documentation": "

    The value of the filter.

    ", "smithy.api#required": {} } - } + }, + "key": { + "target": "com.amazonaws.ssm#DocumentFilterKey", + "traits": { + "smithy.api#documentation": "

    The name of the filter.

    ", + "smithy.api#required": {} + } + } }, "traits": { "smithy.api#documentation": "

    This data type is deprecated. Instead, use DocumentKeyValuesFilter.

    " @@ -7863,16 +8013,22 @@ "com.amazonaws.ssm#DocumentIdentifier": { "type": "structure", "members": { - "Owner": { - "target": "com.amazonaws.ssm#DocumentOwner", + "PlatformTypes": { + "target": "com.amazonaws.ssm#PlatformTypeList", "traits": { - "smithy.api#documentation": "

    The AWS user account that created the document.

    " + "smithy.api#documentation": "

    The operating system platform.

    " } }, - "DocumentFormat": { - "target": "com.amazonaws.ssm#DocumentFormat", + "Requires": { + "target": "com.amazonaws.ssm#DocumentRequiresList", "traits": { - "smithy.api#documentation": "

    The document format, either JSON or YAML.

    " + "smithy.api#documentation": "

    A list of SSM documents required by a document. For example, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document.

    " + } + }, + "VersionName": { + "target": "com.amazonaws.ssm#DocumentVersionName", + "traits": { + "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n cannot be changed.

    " } }, "SchemaVersion": { @@ -7881,10 +8037,10 @@ "smithy.api#documentation": "

    The schema version.

    " } }, - "Requires": { - "target": "com.amazonaws.ssm#DocumentRequiresList", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    A list of SSM documents required by a document. For example, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document.

    " + "smithy.api#documentation": "

    The name of the Systems Manager document.

    " } }, "TargetType": { @@ -7893,28 +8049,16 @@ "smithy.api#documentation": "

    The target type which defines the kinds of resources the document can run on. For example,\n /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types\n reference in the AWS CloudFormation User Guide.

    " } }, - "DocumentType": { - "target": "com.amazonaws.ssm#DocumentType", - "traits": { - "smithy.api#documentation": "

    The document type.

    " - } - }, - "VersionName": { - "target": "com.amazonaws.ssm#DocumentVersionName", - "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n cannot be changed.

    " - } - }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "Owner": { + "target": "com.amazonaws.ssm#DocumentOwner", "traits": { - "smithy.api#documentation": "

    The document version.

    " + "smithy.api#documentation": "

    The AWS user account that created the document.

    " } }, - "PlatformTypes": { - "target": "com.amazonaws.ssm#PlatformTypeList", + "DocumentFormat": { + "target": "com.amazonaws.ssm#DocumentFormat", "traits": { - "smithy.api#documentation": "

    The operating system platform.

    " + "smithy.api#documentation": "

    The document format, either JSON or YAML.

    " } }, "Tags": { @@ -7923,10 +8067,16 @@ "smithy.api#documentation": "

    The tags, or metadata, that have been applied to the document.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", + "DocumentType": { + "target": "com.amazonaws.ssm#DocumentType", "traits": { - "smithy.api#documentation": "

    The name of the Systems Manager document.

    " + "smithy.api#documentation": "

    The document type.

    " + } + }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

    The document version.

    " } } }, @@ -7946,21 +8096,21 @@ "com.amazonaws.ssm#DocumentKeyValuesFilter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.ssm#DocumentKeyValuesFilterValues", - "traits": { - "smithy.api#documentation": "

    The value for the filter key.

    " - } - }, "Key": { "target": "com.amazonaws.ssm#DocumentKeyValuesFilterKey", "traits": { "smithy.api#documentation": "

    The name of the filter key.

    " } + }, + "Values": { + "target": "com.amazonaws.ssm#DocumentKeyValuesFilterValues", + "traits": { + "smithy.api#documentation": "

    The value for the filter key.

    " + } } }, "traits": { - "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of documents.

    \n

    For keys, you can specify one or more tags that have been applied to a document.

    \n

    Other valid values include Owner, Name,\n PlatformTypes, DocumentType, and TargetType.

    \n

    Note that only one Owner can be specified in a request. For example:\n Key=Owner,Values=Self.

    \n

    If you use Name as a key, you can use a name prefix to return a list of documents. For\n example, in the AWS CLI, to return a list of all documents that begin with Te, run\n the following command:

    \n

    \n aws ssm list-documents --filters Key=Name,Values=Te\n

    \n

    If you specify more than two keys, only documents that are identified by all the tags are\n returned in the results. If you specify more than two values for a key, documents that are\n identified by any of the values are returned in the results.

    \n

    To specify a custom key and value pair, use the format\n Key=tag:tagName,Values=valueName.

    \n

    For example, if you created a Key called region and are using the AWS CLI to call the\n list-documents command:

    \n

    \n aws ssm list-documents --filters Key=tag:region,Values=east,west\n Key=Owner,Values=Self\n

    " + "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of documents.

    \n

    For keys, you can specify one or more tags that have been applied to a document.

    \n

    You can also use AWS-provided keys, some of which have specific allowed values. These keys\n and their associated values are as follows:

    \n
    \n
    DocumentType
    \n
    \n
      \n
    • \n

      ApplicationConfiguration

      \n
      • \n
    • \n

      ApplicationConfigurationSchema

      \n
      • \n
    • \n

      Automation

      \n
      • \n
    • \n

      ChangeCalendar

      \n
      • \n
    • \n

      Command

      \n
      • \n
    • \n

      DeploymentStrategy

      \n
      • \n
    • \n

      Package

      \n
      • \n
    • \n

      Policy

      \n
      • \n
    • \n

      Session

      \n
      • \n
    \n
    \n
    Owner
    \n
    \n

    Note that only one Owner can be specified in a request. For example:\n Key=Owner,Values=Self.

    \n
      \n
    • \n

      Amazon

      \n
      • \n
    • \n

      Private

      \n
      • \n
    • \n

      Public

      \n
      • \n
    • \n

      Self

      \n
      • \n
    • \n

      ThirdParty

      \n
      • \n
    \n
    \n
    PlatformTypes
    \n
    \n
      \n
    • \n

      Linux

      \n
      • \n
    • \n

      Windows

      \n
      • \n
    \n
    \n
    \n

    \n Name is another AWS-provided key. If you use Name as a key, you\n can use a name prefix to return a list of documents. For example, in the AWS CLI, to return a\n list of all documents that begin with Te, run the following command:

    \n

    \n aws ssm list-documents --filters Key=Name,Values=Te\n

    \n

    You can also use the TargetType AWS-provided key. For a list of valid resource\n type values that can be used with this key, see AWS resource and property types\n reference in the AWS CloudFormation User Guide.

    \n

    If you specify more than two keys, only documents that are identified by all the tags are\n returned in the results. If you specify more than two values for a key, documents that are\n identified by any of the values are returned in the results.

    \n

    To specify a custom key and value pair, use the format\n Key=tag:tagName,Values=valueName.

    \n

    For example, if you created a key called region and are using the AWS CLI to call the\n list-documents command:

    \n

    \n aws ssm list-documents --filters Key=tag:region,Values=east,west\n Key=Owner,Values=Self\n

    " } }, "com.amazonaws.ssm#DocumentKeyValuesFilterKey": { @@ -8023,22 +8173,16 @@ "com.amazonaws.ssm#DocumentParameter": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ssm#DocumentParameterDescrption", - "traits": { - "smithy.api#documentation": "

    A description of what the parameter does, how to use it, the default value, and whether or\n not the parameter is optional.

    " - } - }, "Name": { "target": "com.amazonaws.ssm#DocumentParameterName", "traits": { "smithy.api#documentation": "

    The name of the parameter.

    " } }, - "Type": { - "target": "com.amazonaws.ssm#DocumentParameterType", + "Description": { + "target": "com.amazonaws.ssm#DocumentParameterDescrption", "traits": { - "smithy.api#documentation": "

    The type of parameter. The type can be either String or StringList.

    " + "smithy.api#documentation": "

    A description of what the parameter does, how to use it, the default value, and whether or\n not the parameter is optional.

    " } }, "DefaultValue": { @@ -8046,6 +8190,12 @@ "traits": { "smithy.api#documentation": "

    If specified, the default values for the parameters. Parameters without a default value are\n required. Parameters with a default value are optional.

    " } + }, + "Type": { + "target": "com.amazonaws.ssm#DocumentParameterType", + "traits": { + "smithy.api#documentation": "

    The type of parameter. The type can be either String or StringList.

    " + } } }, "traits": { @@ -8230,22 +8380,22 @@ "com.amazonaws.ssm#DocumentVersionInfo": { "type": "structure", "members": { - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", - "traits": { - "smithy.api#documentation": "

    The document version.

    " - } - }, "Name": { "target": "com.amazonaws.ssm#DocumentName", "traits": { "smithy.api#documentation": "

    The document name.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.ssm#DateTime", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The date the document was created.

    " + "smithy.api#documentation": "

    The document version.

    " + } + }, + "IsDefaultVersion": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#documentation": "

    An identifier for the default version of the document.

    " } }, "DocumentFormat": { @@ -8254,6 +8404,12 @@ "smithy.api#documentation": "

    The document format, either JSON or YAML.

    " } }, + "CreatedDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    The date the document was created.

    " + } + }, "Status": { "target": "com.amazonaws.ssm#DocumentStatus", "traits": { @@ -8271,12 +8427,6 @@ "traits": { "smithy.api#documentation": "

    The version of the artifact associated with the document. For example, \"Release 12, Update\n 6\". This value is unique across all versions of a document, and cannot be changed.

    " } - }, - "IsDefaultVersion": { - "target": "com.amazonaws.ssm#Boolean", - "traits": { - "smithy.api#documentation": "

    An identifier for the default version of the document.

    " - } } }, "traits": { @@ -8433,18 +8583,18 @@ "com.amazonaws.ssm#FailedCreateAssociation": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ssm#BatchErrorMessage", - "traits": { - "smithy.api#documentation": "

    A description of the failure.

    " - } - }, "Entry": { "target": "com.amazonaws.ssm#CreateAssociationBatchRequestEntry", "traits": { "smithy.api#documentation": "

    The association.

    " } }, + "Message": { + "target": "com.amazonaws.ssm#BatchErrorMessage", + "traits": { + "smithy.api#documentation": "

    A description of the failure.

    " + } + }, "Fault": { "target": "com.amazonaws.ssm#Fault", "traits": { @@ -8474,16 +8624,16 @@ "smithy.api#documentation": "

    Detailed information about the Automation step failure.

    " } }, - "FailureType": { + "FailureStage": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The type of Automation failure. Failure types include the following: Action, Permission,\n Throttling, Verification, Internal.

    " + "smithy.api#documentation": "

    The stage of the Automation execution when the failure occurred. The stages include the\n following: InputValidation, PreVerification, Invocation, PostVerification.

    " } }, - "FailureStage": { + "FailureType": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The stage of the Automation execution when the failure occurred. The stages include the\n following: InputValidation, PreVerification, Invocation, PostVerification.

    " + "smithy.api#documentation": "

    The type of Automation failure. Failure types include the following: Action, Permission,\n Throttling, Verification, Internal.

    " } } }, @@ -8585,7 +8735,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you\n specify a time, GetCalendarState returns the state of the calendar at a specific\n time, and returns the next time that the Change Calendar state will transition. If you do not\n specify a time, GetCalendarState assumes the current time. Change Calendar entries\n have two possible states: OPEN or CLOSED. For more information about\n Systems Manager Change Calendar, see AWS Systems Manager Change\n Calendar in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you\n specify a time, GetCalendarState returns the state of the calendar at a specific\n time, and returns the next time that the Change Calendar state will transition. If you do not\n specify a time, GetCalendarState assumes the current time. Change Calendar entries\n have two possible states: OPEN or CLOSED.

    \n

    If you specify more than one calendar in a request, the command returns the status of\n OPEN only if all calendars in the request are open. If one or more calendars in the\n request are closed, the status returned is CLOSED.

    \n

    For more information about Systems Manager Change Calendar, see AWS Systems Manager Change\n Calendar in the AWS Systems Manager User Guide.

    " } }, "com.amazonaws.ssm#GetCalendarStateRequest": { @@ -8609,18 +8759,18 @@ "com.amazonaws.ssm#GetCalendarStateResponse": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ssm#CalendarState", - "traits": { - "smithy.api#documentation": "

    The state of the calendar. An OPEN calendar indicates that actions are allowed\n to proceed, and a CLOSED calendar indicates that actions are not allowed to\n proceed.

    " - } - }, "AtTime": { "target": "com.amazonaws.ssm#ISO8601String", "traits": { "smithy.api#documentation": "

    The time, as an ISO 8601 string,\n that you specified in your command. If you did not specify a time, GetCalendarState\n uses the current time.

    " } }, + "State": { + "target": "com.amazonaws.ssm#CalendarState", + "traits": { + "smithy.api#documentation": "

    The state of the calendar. An OPEN calendar indicates that actions are allowed\n to proceed, and a CLOSED calendar indicates that actions are not allowed to\n proceed.

    " + } + }, "NextTransitionTime": { "target": "com.amazonaws.ssm#ISO8601String", "traits": { @@ -8686,100 +8836,100 @@ "com.amazonaws.ssm#GetCommandInvocationResult": { "type": "structure", "members": { - "ExecutionEndDateTime": { - "target": "com.amazonaws.ssm#StringDateTime", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The date and time the plugin was finished running. Date and time are written in ISO 8601\n format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI\n command uses the InvokedAfter filter.

    \n

    \n aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z\n

    \n

    If the plugin has not started to run, the string is empty.

    " + "smithy.api#documentation": "

    The ID of the managed instance targeted by the command. A managed instance can be an EC2\n instance or an instance in your hybrid environment that is configured for Systems Manager.

    " } }, - "CommandId": { - "target": "com.amazonaws.ssm#CommandId", + "StandardOutputContent": { + "target": "com.amazonaws.ssm#StandardOutputContent", "traits": { - "smithy.api#documentation": "

    The parent command ID of the invocation plugin.

    " + "smithy.api#documentation": "

    The first 24,000 characters written by the plugin to stdout. If the command has not finished\n running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

    " } }, - "StandardOutputUrl": { - "target": "com.amazonaws.ssm#Url", + "StandardErrorContent": { + "target": "com.amazonaws.ssm#StandardErrorContent", "traits": { - "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stdout in Amazon S3. If an S3 bucket was\n not specified, then this string is empty.

    " + "smithy.api#documentation": "

    The first 8,000 characters written by the plugin to stderr. If the command has not finished\n running, then this string is empty.

    " } }, - "StandardErrorUrl": { - "target": "com.amazonaws.ssm#Url", + "Status": { + "target": "com.amazonaws.ssm#CommandInvocationStatus", "traits": { - "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stderr. If the command has not\n finished running, then this string is empty.

    " + "smithy.api#documentation": "

    The status of this invocation plugin. This status can be different than\n StatusDetails.

    " } }, - "DocumentName": { - "target": "com.amazonaws.ssm#DocumentName", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The name of the document that was run. For example, AWS-RunShellScript.

    " + "smithy.api#documentation": "

    The SSM document version used in the request.

    " } }, - "ResponseCode": { - "target": "com.amazonaws.ssm#ResponseCode", + "ExecutionStartDateTime": { + "target": "com.amazonaws.ssm#StringDateTime", "traits": { - "smithy.api#documentation": "

    The error level response code for the plugin script. If the response code is -1, then the\n command has not started running on the instance, or it was not received by the instance.

    " + "smithy.api#documentation": "

    The date and time the plugin started running. Date and time are written in ISO 8601 format.\n For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses\n the InvokedBefore filter.

    \n

    \n aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z\n

    \n

    If the plugin has not started to run, the string is empty.

    " } }, - "PluginName": { - "target": "com.amazonaws.ssm#CommandPluginName", + "ExecutionElapsedTime": { + "target": "com.amazonaws.ssm#StringDateTime", "traits": { - "smithy.api#documentation": "

    The name of the plugin for which you want detailed results. For example, aws:RunShellScript\n is a plugin.

    " + "smithy.api#documentation": "

    Duration since ExecutionStartDateTime.

    " } }, - "StatusDetails": { - "target": "com.amazonaws.ssm#StatusDetails", + "Comment": { + "target": "com.amazonaws.ssm#Comment", "traits": { - "smithy.api#documentation": "

    A detailed status of the command execution for an invocation. StatusDetails includes more\n information than Status because it includes states resulting from error and concurrency control\n parameters. StatusDetails can show different results than Status. For more information about\n these statuses, see Understanding command\n statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the\n following values:

    \n\n
      \n
    • \n

      Pending: The command has not been sent to the instance.

      \n
      • \n
    • \n

      In Progress: The command has been sent to the instance but has not reached a terminal\n state.

      \n
      • \n
    • \n

      Delayed: The system attempted to send the command to the target, but the target was not\n available. The instance might not be available because of network issues, because the instance\n was stopped, or for similar reasons. The system will try to send the command again.

      \n
      • \n
    • \n

      Success: The command or plugin ran successfully. This is a terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The command was not delivered to the instance before the delivery\n timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit,\n but they do contribute to whether the parent command status is Success or Incomplete. This is a\n terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: The command started to run on the instance, but the execution was not\n complete before the timeout expired. Execution timeouts count against the MaxErrors limit of\n the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The command wasn't run successfully on the instance. For a plugin, this indicates\n that the result code was not zero. For a command invocation, this indicates that the result\n code for one or more plugins was not zero. Invocation failures count against the MaxErrors\n limit of the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Undeliverable: The command can't be delivered to the instance. The instance might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.

      \n
      • \n
    • \n

      Terminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.

      \n
      • \n
    " + "smithy.api#documentation": "

    The comment text for the command.

    " } }, - "ExecutionStartDateTime": { - "target": "com.amazonaws.ssm#StringDateTime", + "StatusDetails": { + "target": "com.amazonaws.ssm#StatusDetails", "traits": { - "smithy.api#documentation": "

    The date and time the plugin started running. Date and time are written in ISO 8601 format.\n For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses\n the InvokedBefore filter.

    \n

    \n aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z\n

    \n

    If the plugin has not started to run, the string is empty.

    " + "smithy.api#documentation": "

    A detailed status of the command execution for an invocation. StatusDetails includes more\n information than Status because it includes states resulting from error and concurrency control\n parameters. StatusDetails can show different results than Status. For more information about\n these statuses, see Understanding command\n statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the\n following values:

    \n\n
      \n
    • \n

      Pending: The command has not been sent to the instance.

      \n
      • \n
    • \n

      In Progress: The command has been sent to the instance but has not reached a terminal\n state.

      \n
      • \n
    • \n

      Delayed: The system attempted to send the command to the target, but the target was not\n available. The instance might not be available because of network issues, because the instance\n was stopped, or for similar reasons. The system will try to send the command again.

      \n
      • \n
    • \n

      Success: The command or plugin ran successfully. This is a terminal state.

      \n
      • \n
    • \n

      Delivery Timed Out: The command was not delivered to the instance before the delivery\n timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit,\n but they do contribute to whether the parent command status is Success or Incomplete. This is a\n terminal state.

      \n
      • \n
    • \n

      Execution Timed Out: The command started to run on the instance, but the execution was not\n complete before the timeout expired. Execution timeouts count against the MaxErrors limit of\n the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Failed: The command wasn't run successfully on the instance. For a plugin, this indicates\n that the result code was not zero. For a command invocation, this indicates that the result\n code for one or more plugins was not zero. Invocation failures count against the MaxErrors\n limit of the parent command. This is a terminal state.

      \n
      • \n
    • \n

      Canceled: The command was terminated before it was completed. This is a terminal\n state.

      \n
      • \n
    • \n

      Undeliverable: The command can't be delivered to the instance. The instance might not\n exist or might not be responding. Undeliverable invocations don't count against the parent\n command's MaxErrors limit and don't contribute to whether the parent command status is Success\n or Incomplete. This is a terminal state.

      \n
      • \n
    • \n

      Terminated: The parent command exceeded its MaxErrors limit and subsequent command\n invocations were canceled by the system. This is a terminal state.

      \n
      • \n
    " } }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "PluginName": { + "target": "com.amazonaws.ssm#CommandPluginName", "traits": { - "smithy.api#documentation": "

    The ID of the managed instance targeted by the command. A managed instance can be an EC2\n instance or an instance in your hybrid environment that is configured for Systems Manager.

    " + "smithy.api#documentation": "

    The name of the plugin for which you want detailed results. For example, aws:RunShellScript\n is a plugin.

    " } }, - "StandardOutputContent": { - "target": "com.amazonaws.ssm#StandardOutputContent", + "ResponseCode": { + "target": "com.amazonaws.ssm#ResponseCode", "traits": { - "smithy.api#documentation": "

    The first 24,000 characters written by the plugin to stdout. If the command has not finished\n running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

    " + "smithy.api#documentation": "

    The error level response code for the plugin script. If the response code is -1, then the\n command has not started running on the instance, or it was not received by the instance.

    " } }, - "Comment": { - "target": "com.amazonaws.ssm#Comment", + "ExecutionEndDateTime": { + "target": "com.amazonaws.ssm#StringDateTime", "traits": { - "smithy.api#documentation": "

    The comment text for the command.

    " + "smithy.api#documentation": "

    The date and time the plugin was finished running. Date and time are written in ISO 8601\n format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI\n command uses the InvokedAfter filter.

    \n

    \n aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z\n

    \n

    If the plugin has not started to run, the string is empty.

    " } }, - "ExecutionElapsedTime": { - "target": "com.amazonaws.ssm#StringDateTime", + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    Duration since ExecutionStartDateTime.

    " + "smithy.api#documentation": "

    The name of the document that was run. For example, AWS-RunShellScript.

    " } }, - "StandardErrorContent": { - "target": "com.amazonaws.ssm#StandardErrorContent", + "StandardErrorUrl": { + "target": "com.amazonaws.ssm#Url", "traits": { - "smithy.api#documentation": "

    The first 8,000 characters written by the plugin to stderr. If the command has not finished\n running, then this string is empty.

    " + "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stderr. If the command has not\n finished running, then this string is empty.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "CommandId": { + "target": "com.amazonaws.ssm#CommandId", "traits": { - "smithy.api#documentation": "

    The SSM document version used in the request.

    " + "smithy.api#documentation": "

    The parent command ID of the invocation plugin.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#CommandInvocationStatus", + "StandardOutputUrl": { + "target": "com.amazonaws.ssm#Url", "traits": { - "smithy.api#documentation": "

    The status of this invocation plugin. This status can be different than\n StatusDetails.

    " + "smithy.api#documentation": "

    The URL for the complete text written by the plugin to stdout in Amazon S3. If an S3 bucket was\n not specified, then this string is empty.

    " } }, "CloudWatchOutputConfig": { @@ -8867,17 +9017,17 @@ "com.amazonaws.ssm#GetDefaultPatchBaselineResult": { "type": "structure", "members": { - "OperatingSystem": { - "target": "com.amazonaws.ssm#OperatingSystem", - "traits": { - "smithy.api#documentation": "

    The operating system for the returned patch baseline.

    " - } - }, "BaselineId": { "target": "com.amazonaws.ssm#BaselineId", "traits": { "smithy.api#documentation": "

    The ID of the default patch baseline.

    " } + }, + "OperatingSystem": { + "target": "com.amazonaws.ssm#OperatingSystem", + "traits": { + "smithy.api#documentation": "

    The operating system for the returned patch baseline.

    " + } } } }, @@ -8926,12 +9076,6 @@ "com.amazonaws.ssm#GetDeployablePatchSnapshotForInstanceResult": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.ssm#SnapshotId", - "traits": { - "smithy.api#documentation": "

    The user-defined snapshot ID.

    " - } - }, "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { @@ -8949,6 +9093,12 @@ "traits": { "smithy.api#documentation": "

    A pre-signed Amazon S3 URL that can be used to download the patch snapshot.

    " } + }, + "SnapshotId": { + "target": "com.amazonaws.ssm#SnapshotId", + "traits": { + "smithy.api#documentation": "

    The user-defined snapshot ID.

    " + } } } }, @@ -8990,28 +9140,28 @@ "smithy.api#documentation": "

    The document version for which you want information.

    " } }, + "VersionName": { + "target": "com.amazonaws.ssm#DocumentVersionName", + "traits": { + "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document and can't\n be changed.

    " + } + }, "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { "smithy.api#documentation": "

    The name of the Systems Manager document.

    ", "smithy.api#required": {} } - }, - "VersionName": { - "target": "com.amazonaws.ssm#DocumentVersionName", - "traits": { - "smithy.api#documentation": "

    An optional field specifying the version of the artifact associated with the document. For\n example, \"Release 12, Update 6\". This value is unique across all versions of a document and can't\n be changed.

    " - } } } }, "com.amazonaws.ssm#GetDocumentResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", + "AttachmentsContent": { + "target": "com.amazonaws.ssm#AttachmentContentList", "traits": { - "smithy.api#documentation": "

    The name of the Systems Manager document.

    " + "smithy.api#documentation": "

    A description of the document attachments, including names, locations, sizes, and so\n on.

    " } }, "DocumentVersion": { @@ -9026,46 +9176,46 @@ "smithy.api#documentation": "

    The document type.

    " } }, - "Content": { - "target": "com.amazonaws.ssm#DocumentContent", + "DocumentFormat": { + "target": "com.amazonaws.ssm#DocumentFormat", "traits": { - "smithy.api#documentation": "

    The contents of the Systems Manager document.

    " + "smithy.api#documentation": "

    The document format, either JSON or YAML.

    " } }, - "Requires": { - "target": "com.amazonaws.ssm#DocumentRequiresList", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    A list of SSM documents required by a document. For example, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document.

    " + "smithy.api#documentation": "

    The name of the Systems Manager document.

    " } }, - "AttachmentsContent": { - "target": "com.amazonaws.ssm#AttachmentContentList", + "StatusInformation": { + "target": "com.amazonaws.ssm#DocumentStatusInformation", "traits": { - "smithy.api#documentation": "

    A description of the document attachments, including names, locations, sizes, and so\n on.

    " + "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.\"

    " } }, - "VersionName": { - "target": "com.amazonaws.ssm#DocumentVersionName", + "Status": { + "target": "com.amazonaws.ssm#DocumentStatus", "traits": { - "smithy.api#documentation": "

    The version of the artifact associated with the document. For example, \"Release 12, Update\n 6\". This value is unique across all versions of a document, and cannot be changed.

    " + "smithy.api#documentation": "

    The status of the Systems Manager document, such as Creating, Active,\n Updating, Failed, and Deleting.

    " } }, - "StatusInformation": { - "target": "com.amazonaws.ssm#DocumentStatusInformation", + "VersionName": { + "target": "com.amazonaws.ssm#DocumentVersionName", "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.\"

    " + "smithy.api#documentation": "

    The version of the artifact associated with the document. For example, \"Release 12, Update\n 6\". This value is unique across all versions of a document, and cannot be changed.

    " } }, - "DocumentFormat": { - "target": "com.amazonaws.ssm#DocumentFormat", + "Requires": { + "target": "com.amazonaws.ssm#DocumentRequiresList", "traits": { - "smithy.api#documentation": "

    The document format, either JSON or YAML.

    " + "smithy.api#documentation": "

    A list of SSM documents required by a document. For example, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#DocumentStatus", + "Content": { + "target": "com.amazonaws.ssm#DocumentContent", "traits": { - "smithy.api#documentation": "

    The status of the Systems Manager document, such as Creating, Active,\n Updating, Failed, and Deleting.

    " + "smithy.api#documentation": "

    The contents of the Systems Manager document.

    " } } } @@ -9102,7 +9252,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Query inventory information.

    " + "smithy.api#documentation": "

    Query inventory information.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#GetInventoryRequest": { @@ -9114,12 +9270,6 @@ "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    " } }, - "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.)

    " - } - }, "Aggregators": { "target": "com.amazonaws.ssm#InventoryAggregatorList", "traits": { @@ -9133,6 +9283,12 @@ "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": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " + } + }, "ResultAttributes": { "target": "com.amazonaws.ssm#ResultAttributeList", "traits": { @@ -9178,7 +9334,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Return a list of inventory type names for the account, or return a list of attribute names\n for a specific Inventory item type.

    " + "smithy.api#documentation": "

    Return a list of inventory type names for the account, or return a list of attribute names\n for a specific Inventory item type.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Schemas", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#GetInventorySchemaMaxResults": { @@ -9193,10 +9355,11 @@ "com.amazonaws.ssm#GetInventorySchemaRequest": { "type": "structure", "members": { - "TypeName": { - "target": "com.amazonaws.ssm#InventoryItemTypeNameFilter", + "MaxResults": { + "target": "com.amazonaws.ssm#GetInventorySchemaMaxResults", "traits": { - "smithy.api#documentation": "

    The type of inventory item to return.

    " + "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.

    " } }, "SubType": { @@ -9206,13 +9369,6 @@ "smithy.api#documentation": "

    Returns the sub-type schema for a specified inventory type.

    " } }, - "MaxResults": { - "target": "com.amazonaws.ssm#GetInventorySchemaMaxResults", - "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": { @@ -9224,6 +9380,12 @@ "traits": { "smithy.api#documentation": "

    Returns inventory schemas that support aggregation. For example, this call returns the\n AWS:InstanceInformation type, because it supports aggregation based on the\n PlatformName, PlatformType, and PlatformVersion\n attributes.

    " } + }, + "TypeName": { + "target": "com.amazonaws.ssm#InventoryItemTypeNameFilter", + "traits": { + "smithy.api#documentation": "

    The type of inventory item to return.

    " + } } } }, @@ -9299,16 +9461,10 @@ "com.amazonaws.ssm#GetMaintenanceWindowExecutionResult": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.ssm#DateTime", - "traits": { - "smithy.api#documentation": "

    The time the maintenance window started running.

    " - } - }, - "StatusDetails": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", + "TaskIds": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskIdList", "traits": { - "smithy.api#documentation": "

    The details explaining the Status. Only available for certain status values.

    " + "smithy.api#documentation": "

    The ID of the task executions from the maintenance window execution.

    " } }, "WindowExecutionId": { @@ -9317,16 +9473,16 @@ "smithy.api#documentation": "

    The ID of the maintenance window execution.

    " } }, - "TaskIds": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskIdList", + "EndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The ID of the task executions from the maintenance window execution.

    " + "smithy.api#documentation": "

    The time the maintenance window finished running.

    " } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The time the maintenance window finished running.

    " + "smithy.api#documentation": "

    The time the maintenance window started running.

    " } }, "Status": { @@ -9334,6 +9490,12 @@ "traits": { "smithy.api#documentation": "

    The status of the maintenance window execution.

    " } + }, + "StatusDetails": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", + "traits": { + "smithy.api#documentation": "

    The details explaining the Status. Only available for certain status values.

    " + } } } }, @@ -9380,17 +9542,17 @@ "com.amazonaws.ssm#GetMaintenanceWindowExecutionTaskInvocationRequest": { "type": "structure", "members": { - "InvocationId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationId", + "TaskId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", "traits": { - "smithy.api#documentation": "

    The invocation ID to retrieve.

    ", + "smithy.api#documentation": "

    The ID of the specific task in the maintenance window task that should be retrieved.

    ", "smithy.api#required": {} } }, - "TaskId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", + "InvocationId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationId", "traits": { - "smithy.api#documentation": "

    The ID of the specific task in the maintenance window task that should be retrieved.

    ", + "smithy.api#documentation": "

    The invocation ID to retrieve.

    ", "smithy.api#required": {} } }, @@ -9406,10 +9568,10 @@ "com.amazonaws.ssm#GetMaintenanceWindowExecutionTaskInvocationResult": { "type": "structure", "members": { - "TaskExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", + "EndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The task execution ID.

    " + "smithy.api#documentation": "

    The time that the task finished running on the target.

    " } }, "OwnerInformation": { @@ -9418,40 +9580,40 @@ "smithy.api#documentation": "

    User-provided value to be included in any CloudWatch events raised while running tasks for\n these targets in this maintenance window.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatus", + "TaskExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", "traits": { - "smithy.api#documentation": "

    The task status for an invocation.

    " + "smithy.api#documentation": "

    The task execution ID.

    " } }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "WindowTargetId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskTargetId", "traits": { - "smithy.api#documentation": "

    The maintenance window execution ID.

    " + "smithy.api#documentation": "

    The maintenance window target ID.

    " } }, - "EndTime": { - "target": "com.amazonaws.ssm#DateTime", + "StatusDetails": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", "traits": { - "smithy.api#documentation": "

    The time that the task finished running on the target.

    " + "smithy.api#documentation": "

    The details explaining the status. Details are only available for certain status\n values.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationParameters", + "InvocationId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationId", "traits": { - "smithy.api#documentation": "

    The parameters used at the time that the task ran.

    " + "smithy.api#documentation": "

    The invocation ID.

    " } }, - "StartTime": { - "target": "com.amazonaws.ssm#DateTime", + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", "traits": { - "smithy.api#documentation": "

    The time that the task started running on the target.

    " + "smithy.api#documentation": "

    The maintenance window execution ID.

    " } }, - "StatusDetails": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", + "ExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskExecutionId", "traits": { - "smithy.api#documentation": "

    The details explaining the status. Details are only available for certain status\n values.

    " + "smithy.api#documentation": "

    The execution ID.

    " } }, "TaskType": { @@ -9460,22 +9622,22 @@ "smithy.api#documentation": "

    Retrieves the task type for a maintenance window. Task types include the following: LAMBDA,\n STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.

    " } }, - "InvocationId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationId", + "StartTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The invocation ID.

    " + "smithy.api#documentation": "

    The time that the task started running on the target.

    " } }, - "WindowTargetId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskTargetId", + "Status": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatus", "traits": { - "smithy.api#documentation": "

    The maintenance window target ID.

    " + "smithy.api#documentation": "

    The task status for an invocation.

    " } }, - "ExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskExecutionId", + "Parameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationParameters", "traits": { - "smithy.api#documentation": "

    The execution ID.

    " + "smithy.api#documentation": "

    The parameters used at the time that the task ran.

    " } } } @@ -9483,17 +9645,17 @@ "com.amazonaws.ssm#GetMaintenanceWindowExecutionTaskRequest": { "type": "structure", "members": { - "TaskId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", "traits": { - "smithy.api#documentation": "

    The ID of the specific task execution in the maintenance window task that should be\n retrieved.

    ", + "smithy.api#documentation": "

    The ID of the maintenance window execution that includes the task.

    ", "smithy.api#required": {} } }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "TaskId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window execution that includes the task.

    ", + "smithy.api#documentation": "

    The ID of the specific task execution in the maintenance window task that should be\n retrieved.

    ", "smithy.api#required": {} } } @@ -9502,22 +9664,22 @@ "com.amazonaws.ssm#GetMaintenanceWindowExecutionTaskResult": { "type": "structure", "members": { - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "TaskExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", "traits": { - "smithy.api#documentation": "

    The defined maximum number of task executions that could be run in parallel.

    " + "smithy.api#documentation": "

    The ID of the specific task execution in the maintenance window task that was\n retrieved.

    " } }, - "StartTime": { - "target": "com.amazonaws.ssm#DateTime", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    The time the task execution started.

    " + "smithy.api#documentation": "

    The defined maximum number of task execution errors allowed before scheduling of the task\n execution would have been stopped.

    " } }, - "StatusDetails": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", "traits": { - "smithy.api#documentation": "

    The details explaining the Status. Only available for certain status values.

    " + "smithy.api#documentation": "

    The ID of the maintenance window execution that includes the task.

    " } }, "ServiceRole": { @@ -9526,22 +9688,22 @@ "smithy.api#documentation": "

    The role that was assumed when running the task.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", - "traits": { - "smithy.api#documentation": "

    The defined maximum number of task execution errors allowed before scheduling of the task\n execution would have been stopped.

    " - } - }, "Type": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", "traits": { "smithy.api#documentation": "

    The type of task that was run.

    " } }, - "TaskExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", + "TaskParameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskParametersList", "traits": { - "smithy.api#documentation": "

    The ID of the specific task execution in the maintenance window task that was\n retrieved.

    " + "smithy.api#documentation": "

    The parameters passed to the task when it was run.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     \n

    The map has the following format:

    \n

    Key: string, between 1 and 255 characters

    \n

    Value: an array of strings, each string is between 1 and 255 characters

    " + } + }, + "Priority": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", + "traits": { + "smithy.api#documentation": "

    The priority of the task.

    " } }, "Status": { @@ -9550,34 +9712,34 @@ "smithy.api#documentation": "

    The status of the task.

    " } }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "StatusDetails": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window execution that includes the task.

    " + "smithy.api#documentation": "

    The details explaining the Status. Only available for certain status values.

    " } }, - "EndTime": { - "target": "com.amazonaws.ssm#DateTime", + "TaskArn": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", "traits": { - "smithy.api#documentation": "

    The time the task execution completed.

    " + "smithy.api#documentation": "

    The ARN of the task that ran.

    " } }, - "Priority": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", + "StartTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The priority of the task.

    " + "smithy.api#documentation": "

    The time the task execution started.

    " } }, - "TaskParameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskParametersList", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The parameters passed to the task when it was run.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     \n

    The map has the following format:

    \n

    Key: string, between 1 and 255 characters

    \n

    Value: an array of strings, each string is between 1 and 255 characters

    " + "smithy.api#documentation": "

    The defined maximum number of task executions that could be run in parallel.

    " } }, - "TaskArn": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", + "EndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The ARN of the task that ran.

    " + "smithy.api#documentation": "

    The time the task execution completed.

    " } } } @@ -9597,41 +9759,46 @@ "com.amazonaws.ssm#GetMaintenanceWindowResult": { "type": "structure", "members": { - "EndDate": { + "Cutoff": { + "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", + "traits": { + "smithy.api#documentation": "

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new\n tasks for execution.

    " + } + }, + "StartDate": { "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become inactive. The maintenance window will not run after this specified time.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become active. The maintenance window will not run before this specified time.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.ssm#DateTime", + "NextExecutionTime": { + "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The date the maintenance window was created.

    " + "smithy.api#documentation": "

    The next time the maintenance window will actually run, taking into account any specified\n times for the maintenance window to become active or inactive.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "Schedule": { + "target": "com.amazonaws.ssm#MaintenanceWindowSchedule", "traits": { - "smithy.api#documentation": "

    The ID of the created maintenance window.

    " + "smithy.api#documentation": "

    The schedule of the maintenance window in the form of a cron or rate expression.

    " } }, - "ModifiedDate": { - "target": "com.amazonaws.ssm#DateTime", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#documentation": "

    The date the maintenance window was last modified.

    " + "smithy.api#documentation": "

    The ID of the created maintenance window.

    " } }, - "ScheduleOffset": { - "target": "com.amazonaws.ssm#MaintenanceWindowOffset", + "AllowUnassociatedTargets": { + "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The number of days to wait to run a maintenance window after the scheduled CRON expression\n date and time.

    " + "smithy.api#documentation": "

    Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.

    " } }, - "NextExecutionTime": { - "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", + "Duration": { + "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", "traits": { - "smithy.api#documentation": "

    The next time the maintenance window will actually run, taking into account any specified\n times for the maintenance window to become active or inactive.

    " + "smithy.api#documentation": "

    The duration of the maintenance window in hours.

    " } }, "Name": { @@ -9640,40 +9807,29 @@ "smithy.api#documentation": "

    The name of the maintenance window.

    " } }, - "StartDate": { - "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", - "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become active. The maintenance window will not run before this specified time.

    " - } - }, - "Duration": { - "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", - "traits": { - "smithy.api#documentation": "

    The duration of the maintenance window in hours.

    " - } - }, - "Enabled": { - "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", + "ModifiedDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    Indicates whether the maintenance window is enabled.

    " + "smithy.api#documentation": "

    The date the maintenance window was last modified.

    " } }, - "Cutoff": { - "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", + "ScheduleTimezone": { + "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", "traits": { - "smithy.api#documentation": "

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new\n tasks for execution.

    " + "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.

    " } }, - "Schedule": { - "target": "com.amazonaws.ssm#MaintenanceWindowSchedule", + "EndDate": { + "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become inactive. The maintenance window will not run after this specified time.

    " } }, - "AllowUnassociatedTargets": { - "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", + "ScheduleOffset": { + "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { - "smithy.api#documentation": "

    Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The number of days to wait to run a maintenance window after the scheduled CRON expression\n date and time.

    " } }, "Description": { @@ -9682,10 +9838,16 @@ "smithy.api#documentation": "

    The description of the maintenance window.

    " } }, - "ScheduleTimezone": { - "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", + "Enabled": { + "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", "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": "

    Indicates whether the maintenance window is enabled.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    The date the maintenance window was created.

    " } } } @@ -9732,28 +9894,28 @@ "com.amazonaws.ssm#GetMaintenanceWindowTaskResult": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", + "TaskInvocationParameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters", "traits": { - "smithy.api#documentation": "

    The retrieved task name.

    " + "smithy.api#documentation": "

    The parameters to pass to the task when it runs.

    " } }, - "TaskArn": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", + "WindowTaskId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", "traits": { - "smithy.api#documentation": "

    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types,\n the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN.\n For STEP_FUNCTIONS tasks, the value is the state machine ARN.

    " + "smithy.api#documentation": "

    The retrieved maintenance window task ID.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The maximum number of errors allowed before the task stops being scheduled.

    " + "smithy.api#documentation": "

    The targets where the task should run.

    " } }, - "LoggingInfo": { - "target": "com.amazonaws.ssm#LoggingInfo", + "TaskType": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", "traits": { - "smithy.api#documentation": "

    The location in Amazon S3 where the task results are logged.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " + "smithy.api#documentation": "

    The type of task to run.

    " } }, "WindowId": { @@ -9762,40 +9924,40 @@ "smithy.api#documentation": "

    The retrieved maintenance window ID.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", - "traits": { - "smithy.api#documentation": "

    The targets where the task should run.

    " - } - }, "ServiceRoleArn": { "target": "com.amazonaws.ssm#ServiceRole", "traits": { "smithy.api#documentation": "

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for\n maintenance window Run Command tasks.

    " } }, + "TaskParameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskParameters", + "traits": { + "smithy.api#documentation": "

    The parameters to pass to the task when it runs.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     " + } + }, "Priority": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", "traits": { "smithy.api#documentation": "

    The priority of the task when it runs. The lower the number, the higher the priority. Tasks\n that have the same priority are scheduled in parallel.

    " } }, - "TaskType": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    The type of task to run.

    " + "smithy.api#documentation": "

    The maximum number of errors allowed before the task stops being scheduled.

    " } }, - "TaskParameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskParameters", + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { - "smithy.api#documentation": "

    The parameters to pass to the task when it runs.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     " + "smithy.api#documentation": "

    The retrieved task name.

    " } }, - "TaskInvocationParameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters", + "TaskArn": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", "traits": { - "smithy.api#documentation": "

    The parameters to pass to the task when it runs.

    " + "smithy.api#documentation": "

    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types,\n the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN.\n For STEP_FUNCTIONS tasks, the value is the state machine ARN.

    " } }, "Description": { @@ -9804,17 +9966,17 @@ "smithy.api#documentation": "

    The retrieved task description.

    " } }, - "WindowTaskId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", - "traits": { - "smithy.api#documentation": "

    The retrieved maintenance window task ID.

    " - } - }, "MaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { "smithy.api#documentation": "

    The maximum number of targets allowed to run this task in parallel.

    " } + }, + "LoggingInfo": { + "target": "com.amazonaws.ssm#LoggingInfo", + "traits": { + "smithy.api#documentation": "

    The location in Amazon S3 where the task results are logged.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " + } } } }, @@ -9890,19 +10052,18 @@ } ], "traits": { - "smithy.api#documentation": "

    View a summary of OpsItems based on specified filters and aggregators.

    " + "smithy.api#documentation": "

    View a summary of OpsItems based on specified filters and aggregators.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Entities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#GetOpsSummaryRequest": { "type": "structure", "members": { - "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.

    " - } - }, "Aggregators": { "target": "com.amazonaws.ssm#OpsAggregatorList", "traits": { @@ -9921,10 +10082,11 @@ "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " } }, - "SyncName": { - "target": "com.amazonaws.ssm#ResourceDataSyncName", + "MaxResults": { + "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#documentation": "

    Specify the name of a resource data sync to get.

    " + "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.

    " } }, "ResultAttributes": { @@ -9932,6 +10094,12 @@ "traits": { "smithy.api#documentation": "

    The OpsItem data type to return.

    " } + }, + "SyncName": { + "target": "com.amazonaws.ssm#ResourceDataSyncName", + "traits": { + "smithy.api#documentation": "

    Specify the name of a resource data sync to get.

    " + } } } }, @@ -10001,7 +10169,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Query a list of all parameters used by the AWS account.

    ", + "smithy.api#documentation": "

    Retrieves the history of all changes to a parameter.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -10012,10 +10180,17 @@ "com.amazonaws.ssm#GetParameterHistoryRequest": { "type": "structure", "members": { + "WithDecryption": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    Return decrypted values for secure string parameters. This flag is ignored for String and\n StringList parameter types.

    " + } + }, "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The name of a parameter you want to query.

    ", + "smithy.api#documentation": "

    The name of the parameter for which you want to review history.

    ", "smithy.api#required": {} } }, @@ -10025,13 +10200,6 @@ "smithy.api#documentation": "

    The token for the next set of items to return. (You received this token from a previous\n call.)

    " } }, - "WithDecryption": { - "target": "com.amazonaws.ssm#Boolean", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Return decrypted values for secure string parameters. This flag is ignored for String and\n StringList parameter types.

    " - } - }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { @@ -10061,25 +10229,25 @@ "com.amazonaws.ssm#GetParameterRequest": { "type": "structure", "members": { - "WithDecryption": { - "target": "com.amazonaws.ssm#Boolean", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Return decrypted values for secure string parameters. This flag is ignored for String and\n StringList parameter types.

    " - } - }, "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { "smithy.api#documentation": "

    The name of the parameter you want to query.

    ", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.ssm#GetParameterResult": { - "type": "structure", - "members": { + }, + "WithDecryption": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    Return decrypted values for secure string parameters. This flag is ignored for String and\n StringList parameter types.

    " + } + } + } + }, + "com.amazonaws.ssm#GetParameterResult": { + "type": "structure", + "members": { "Parameter": { "target": "com.amazonaws.ssm#Parameter", "traits": { @@ -10157,44 +10325,44 @@ "com.amazonaws.ssm#GetParametersByPathRequest": { "type": "structure", "members": { - "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.

    " - } - }, - "Recursive": { + "WithDecryption": { "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    Retrieve all parameters within a hierarchy.

    \n \n

    If a user has access to a path, then the user can access all levels of that path. For\n example, if a user has permission to access path /a, then the user can also access\n /a/b. Even if a user has explicitly been denied access in IAM for parameter\n /a/b, they can still call the GetParametersByPath API action recursively for\n /a and view /a/b.

    \n     " + "smithy.api#documentation": "

    Retrieve all parameters in a hierarchy with their value decrypted.

    " } }, - "Path": { - "target": "com.amazonaws.ssm#PSParameterName", + "MaxResults": { + "target": "com.amazonaws.ssm#GetParametersByPathMaxResults", "traits": { - "smithy.api#documentation": "

    The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the\n parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of\n a hierarchy: /Finance/Prod/IAD/WinServ2016/license33\n

    ", - "smithy.api#required": {} + "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.

    " } }, "ParameterFilters": { "target": "com.amazonaws.ssm#ParameterStringFilterList", "traits": { - "smithy.api#documentation": "

    Filters to limit the request results.

    " + "smithy.api#documentation": "

    Filters to limit the request results.

    \n \n

    For GetParametersByPath, the following filter Key names are\n supported: Type, KeyId, Label, and\n DataType.

    \n

    The following Key values are not supported for\n GetParametersByPath: tag, Name, Path, and\n Tier.

    \n     " } }, - "MaxResults": { - "target": "com.amazonaws.ssm#GetParametersByPathMaxResults", + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", "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": "

    A token to start the list. Use this token to get the next set of results.

    " } }, - "WithDecryption": { + "Path": { + "target": "com.amazonaws.ssm#PSParameterName", + "traits": { + "smithy.api#documentation": "

    The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the\n parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of\n a hierarchy: /Finance/Prod/IAD/WinServ2016/license33\n

    ", + "smithy.api#required": {} + } + }, + "Recursive": { "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    Retrieve all parameters in a hierarchy with their value decrypted.

    " + "smithy.api#documentation": "

    Retrieve all parameters within a hierarchy.

    \n \n

    If a user has access to a path, then the user can access all levels of that path. For\n example, if a user has permission to access path /a, then the user can also access\n /a/b. Even if a user has explicitly been denied access in IAM for parameter\n /a/b, they can still call the GetParametersByPath API action recursively for\n /a and view /a/b.

    \n     " } } } @@ -10202,17 +10370,17 @@ "com.amazonaws.ssm#GetParametersByPathResult": { "type": "structure", "members": { - "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.

    " - } - }, "Parameters": { "target": "com.amazonaws.ssm#ParameterList", "traits": { "smithy.api#documentation": "

    A list of parameters found in the specified hierarchy.

    " } + }, + "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.

    " + } } } }, @@ -10295,18 +10463,18 @@ "com.amazonaws.ssm#GetPatchBaselineForPatchGroupRequest": { "type": "structure", "members": { + "OperatingSystem": { + "target": "com.amazonaws.ssm#OperatingSystem", + "traits": { + "smithy.api#documentation": "

    Returns he operating system rule specified for patch groups using the patch baseline.

    " + } + }, "PatchGroup": { "target": "com.amazonaws.ssm#PatchGroup", "traits": { "smithy.api#documentation": "

    The name of the patch group whose patch baseline should be retrieved.

    ", "smithy.api#required": {} } - }, - "OperatingSystem": { - "target": "com.amazonaws.ssm#OperatingSystem", - "traits": { - "smithy.api#documentation": "

    Returns he operating system rule specified for patch groups using the patch baseline.

    " - } } } }, @@ -10348,40 +10516,28 @@ "com.amazonaws.ssm#GetPatchBaselineResult": { "type": "structure", "members": { - "GlobalFilters": { - "target": "com.amazonaws.ssm#PatchFilterGroup", - "traits": { - "smithy.api#documentation": "

    A set of global filters used to exclude patches from the baseline.

    " - } - }, - "ApprovedPatchesComplianceLevel": { - "target": "com.amazonaws.ssm#PatchComplianceLevel", - "traits": { - "smithy.api#documentation": "

    Returns the specified compliance severity level for approved patches in the patch\n baseline.

    " - } - }, - "ModifiedDate": { - "target": "com.amazonaws.ssm#DateTime", + "RejectedPatches": { + "target": "com.amazonaws.ssm#PatchIdList", "traits": { - "smithy.api#documentation": "

    The date the patch baseline was last modified.

    " + "smithy.api#documentation": "

    A list of explicitly rejected patches for the baseline.

    " } }, - "PatchGroups": { - "target": "com.amazonaws.ssm#PatchGroupList", + "Sources": { + "target": "com.amazonaws.ssm#PatchSourceList", "traits": { - "smithy.api#documentation": "

    Patch groups included in the patch baseline.

    " + "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " } }, - "ApprovedPatches": { - "target": "com.amazonaws.ssm#PatchIdList", + "Description": { + "target": "com.amazonaws.ssm#BaselineDescription", "traits": { - "smithy.api#documentation": "

    A list of explicitly approved patches for the baseline.

    " + "smithy.api#documentation": "

    A description of the patch baseline.

    " } }, - "RejectedPatchesAction": { - "target": "com.amazonaws.ssm#PatchAction", + "ApprovedPatchesComplianceLevel": { + "target": "com.amazonaws.ssm#PatchComplianceLevel", "traits": { - "smithy.api#documentation": "

    The action specified to take on patches included in the RejectedPatches list. A patch can be\n allowed only if it is a dependency of another package, or blocked entirely along with packages\n that include it as a dependency.

    " + "smithy.api#documentation": "

    Returns the specified compliance severity level for approved patches in the patch\n baseline.

    " } }, "ApprovalRules": { @@ -10390,16 +10546,16 @@ "smithy.api#documentation": "

    A set of rules used to include patches in the baseline.

    " } }, - "Sources": { - "target": "com.amazonaws.ssm#PatchSourceList", + "ModifiedDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " + "smithy.api#documentation": "

    The date the patch baseline was last modified.

    " } }, - "RejectedPatches": { + "ApprovedPatches": { "target": "com.amazonaws.ssm#PatchIdList", "traits": { - "smithy.api#documentation": "

    A list of explicitly rejected patches for the baseline.

    " + "smithy.api#documentation": "

    A list of explicitly approved patches for the baseline.

    " } }, "Name": { @@ -10408,16 +10564,29 @@ "smithy.api#documentation": "

    The name of the patch baseline.

    " } }, - "OperatingSystem": { - "target": "com.amazonaws.ssm#OperatingSystem", + "GlobalFilters": { + "target": "com.amazonaws.ssm#PatchFilterGroup", "traits": { - "smithy.api#documentation": "

    Returns the operating system specified for the patch baseline.

    " + "smithy.api#documentation": "

    A set of global filters used to exclude patches from the baseline.

    " } }, - "BaselineId": { - "target": "com.amazonaws.ssm#BaselineId", + "RejectedPatchesAction": { + "target": "com.amazonaws.ssm#PatchAction", "traits": { - "smithy.api#documentation": "

    The ID of the retrieved patch baseline.

    " + "smithy.api#documentation": "

    The action specified to take on patches included in the RejectedPatches list. A patch can be\n allowed only if it is a dependency of another package, or blocked entirely along with packages\n that include it as a dependency.

    " + } + }, + "PatchGroups": { + "target": "com.amazonaws.ssm#PatchGroupList", + "traits": { + "smithy.api#documentation": "

    Patch groups included in the patch baseline.

    " + } + }, + "ApprovedPatchesEnableNonSecurity": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is 'false'. Applies to Linux instances only.

    " } }, "CreatedDate": { @@ -10426,17 +10595,16 @@ "smithy.api#documentation": "

    The date the patch baseline was created.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#BaselineDescription", + "BaselineId": { + "target": "com.amazonaws.ssm#BaselineId", "traits": { - "smithy.api#documentation": "

    A description of the patch baseline.

    " + "smithy.api#documentation": "

    The ID of the retrieved patch baseline.

    " } }, - "ApprovedPatchesEnableNonSecurity": { - "target": "com.amazonaws.ssm#Boolean", + "OperatingSystem": { + "target": "com.amazonaws.ssm#OperatingSystem", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is 'false'. Applies to Linux instances only.

    " + "smithy.api#documentation": "

    Returns the operating system specified for the patch baseline.

    " } } } @@ -10588,17 +10756,17 @@ "com.amazonaws.ssm#InstanceAggregatedAssociationOverview": { "type": "structure", "members": { - "InstanceAssociationStatusAggregatedCount": { - "target": "com.amazonaws.ssm#InstanceAssociationStatusAggregatedCount", - "traits": { - "smithy.api#documentation": "

    The number of associations for the instance(s).

    " - } - }, "DetailedStatus": { "target": "com.amazonaws.ssm#StatusName", "traits": { "smithy.api#documentation": "

    Detailed status information about the aggregated associations.

    " } + }, + "InstanceAssociationStatusAggregatedCount": { + "target": "com.amazonaws.ssm#InstanceAssociationStatusAggregatedCount", + "traits": { + "smithy.api#documentation": "

    The number of associations for the instance(s).

    " + } } }, "traits": { @@ -10614,18 +10782,18 @@ "smithy.api#documentation": "

    The instance ID.

    " } }, - "AssociationId": { - "target": "com.amazonaws.ssm#AssociationId", - "traits": { - "smithy.api#documentation": "

    The association ID.

    " - } - }, "Content": { "target": "com.amazonaws.ssm#DocumentContent", "traits": { "smithy.api#documentation": "

    The content of the association document for the instance(s).

    " } }, + "AssociationId": { + "target": "com.amazonaws.ssm#AssociationId", + "traits": { + "smithy.api#documentation": "

    The association ID.

    " + } + }, "AssociationVersion": { "target": "com.amazonaws.ssm#AssociationVersion", "traits": { @@ -10692,22 +10860,10 @@ "com.amazonaws.ssm#InstanceAssociationStatusInfo": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", - "traits": { - "smithy.api#documentation": "

    The instance ID where the association was created.

    " - } - }, - "OutputUrl": { - "target": "com.amazonaws.ssm#InstanceAssociationOutputUrl", - "traits": { - "smithy.api#documentation": "

    A URL for an S3 bucket where you want to store the results of this request.

    " - } - }, - "AssociationName": { - "target": "com.amazonaws.ssm#AssociationName", + "ExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The name of the association applied to the instance.

    " + "smithy.api#documentation": "

    The date the instance association ran.

    " } }, "DetailedStatus": { @@ -10716,22 +10872,16 @@ "smithy.api#documentation": "

    Detailed status information about the instance association.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", - "traits": { - "smithy.api#documentation": "

    The name of the association.

    " - } - }, - "AssociationVersion": { - "target": "com.amazonaws.ssm#AssociationVersion", + "ExecutionSummary": { + "target": "com.amazonaws.ssm#InstanceAssociationExecutionSummary", "traits": { - "smithy.api#documentation": "

    The version of the association applied to the instance.

    " + "smithy.api#documentation": "

    Summary information about association execution.

    " } }, - "ExecutionDate": { - "target": "com.amazonaws.ssm#DateTime", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    The date the instance association ran.

    " + "smithy.api#documentation": "

    The name of the association.

    " } }, "AssociationId": { @@ -10740,28 +10890,46 @@ "smithy.api#documentation": "

    The association ID.

    " } }, + "OutputUrl": { + "target": "com.amazonaws.ssm#InstanceAssociationOutputUrl", + "traits": { + "smithy.api#documentation": "

    A URL for an S3 bucket where you want to store the results of this request.

    " + } + }, "Status": { "target": "com.amazonaws.ssm#StatusName", "traits": { "smithy.api#documentation": "

    Status information about the instance association.

    " } }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

    The association document versions.

    " + } + }, "ErrorCode": { "target": "com.amazonaws.ssm#AgentErrorCode", "traits": { "smithy.api#documentation": "

    An error code returned by the request to create the association.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "AssociationName": { + "target": "com.amazonaws.ssm#AssociationName", "traits": { - "smithy.api#documentation": "

    The association document versions.

    " + "smithy.api#documentation": "

    The name of the association applied to the instance.

    " } }, - "ExecutionSummary": { - "target": "com.amazonaws.ssm#InstanceAssociationExecutionSummary", + "AssociationVersion": { + "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "

    Summary information about association execution.

    " + "smithy.api#documentation": "

    The version of the association applied to the instance.

    " + } + }, + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", + "traits": { + "smithy.api#documentation": "

    The instance ID where the association was created.

    " } } }, @@ -10799,65 +10967,64 @@ "com.amazonaws.ssm#InstanceInformation": { "type": "structure", "members": { - "LastAssociationExecutionDate": { - "target": "com.amazonaws.ssm#DateTime", + "Name": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The date the association was last run.

    " + "smithy.api#documentation": "

    The name assigned to an on-premises server or virtual machine (VM) when it is activated as a\n Systems Manager managed instance. The name is specified as the DefaultInstanceName property\n using the CreateActivation command. It is applied to the managed instance by\n specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as\n explained in Install SSM Agent for a\n hybrid environment (Linux) and Install SSM Agent for a hybrid environment\n (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2\n DescribeInstances action. For information, see DescribeInstances in the\n Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

    " } }, - "IamRole": { - "target": "com.amazonaws.ssm#IamRole", + "ResourceType": { + "target": "com.amazonaws.ssm#ResourceType", "traits": { - "smithy.api#documentation": "

    The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager\n managed instance. This call does not return the IAM role for EC2 instances. To retrieve the IAM\n role for an EC2 instance, use the Amazon EC2 DescribeInstances action. For information,\n see DescribeInstances in the\n Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

    " + "smithy.api#documentation": "

    The type of instance. Instances are either EC2 instances or managed instances.

    " } }, - "ActivationId": { - "target": "com.amazonaws.ssm#ActivationId", + "AssociationStatus": { + "target": "com.amazonaws.ssm#StatusName", "traits": { - "smithy.api#documentation": "

    The activation ID created by Systems Manager when the server or VM was registered.

    " + "smithy.api#documentation": "

    The status of the association.

    " } }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "AssociationOverview": { + "target": "com.amazonaws.ssm#InstanceAggregatedAssociationOverview", "traits": { - "smithy.api#documentation": "

    The instance ID.

    " + "smithy.api#documentation": "

    Information about the association.

    " } }, - "AgentVersion": { - "target": "com.amazonaws.ssm#Version", + "RegistrationDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The version of SSM Agent running on your Linux instance.

    " + "smithy.api#documentation": "

    The date the server or VM was registered with AWS as a managed instance.

    " } }, - "IsLatestVersion": { - "target": "com.amazonaws.ssm#Boolean", + "PingStatus": { + "target": "com.amazonaws.ssm#PingStatus", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance.\n This field does not indicate whether or not the latest version is installed on Windows managed\n instances, because some older versions of Windows Server use the EC2Config service to process SSM\n requests.

    " + "smithy.api#documentation": "

    Connection status of SSM Agent.

    \n \n

    The status Inactive has been deprecated and is no longer in use.

    \n     " } }, - "PlatformType": { - "target": "com.amazonaws.ssm#PlatformType", + "PlatformVersion": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The operating system platform type.

    " + "smithy.api#documentation": "

    The version of the OS platform running on your instance.

    " } }, - "AssociationStatus": { - "target": "com.amazonaws.ssm#StatusName", + "AgentVersion": { + "target": "com.amazonaws.ssm#Version", "traits": { - "smithy.api#documentation": "

    The status of the association.

    " + "smithy.api#documentation": "

    The version of SSM Agent running on your Linux instance.

    " } }, - "IPAddress": { - "target": "com.amazonaws.ssm#IPAddress", + "LastSuccessfulAssociationExecutionDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The IP address of the managed instance.

    " + "smithy.api#documentation": "

    The last date the association was successfully run.

    " } }, - "PingStatus": { - "target": "com.amazonaws.ssm#PingStatus", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    Connection status of SSM Agent.

    " + "smithy.api#documentation": "

    The instance ID.

    " } }, "ComputerName": { @@ -10866,34 +11033,41 @@ "smithy.api#documentation": "

    The fully qualified host name of the managed instance.

    " } }, - "RegistrationDate": { + "IamRole": { + "target": "com.amazonaws.ssm#IamRole", + "traits": { + "smithy.api#documentation": "

    The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager\n managed instance. This call does not return the IAM role for EC2 instances. To retrieve the IAM\n role for an EC2 instance, use the Amazon EC2 DescribeInstances action. For information,\n see DescribeInstances in the\n Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

    " + } + }, + "LastAssociationExecutionDate": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The date the server or VM was registered with AWS as a managed instance.

    " + "smithy.api#documentation": "

    The date the association was last run.

    " } }, - "ResourceType": { - "target": "com.amazonaws.ssm#ResourceType", + "ActivationId": { + "target": "com.amazonaws.ssm#ActivationId", "traits": { - "smithy.api#documentation": "

    The type of instance. Instances are either EC2 instances or managed instances.

    " + "smithy.api#documentation": "

    The activation ID created by Systems Manager when the server or VM was registered.

    " } }, - "LastSuccessfulAssociationExecutionDate": { - "target": "com.amazonaws.ssm#DateTime", + "PlatformType": { + "target": "com.amazonaws.ssm#PlatformType", "traits": { - "smithy.api#documentation": "

    The last date the association was successfully run.

    " + "smithy.api#documentation": "

    The operating system platform type.

    " } }, - "AssociationOverview": { - "target": "com.amazonaws.ssm#InstanceAggregatedAssociationOverview", + "IPAddress": { + "target": "com.amazonaws.ssm#IPAddress", "traits": { - "smithy.api#documentation": "

    Information about the association.

    " + "smithy.api#documentation": "

    The IP address of the managed instance.

    " } }, - "PlatformVersion": { - "target": "com.amazonaws.ssm#String", + "IsLatestVersion": { + "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#documentation": "

    The version of the OS platform running on your instance.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance.\n This field does not indicate whether or not the latest version is installed on Windows managed\n instances, because some older versions of Windows Server use the EC2Config service to process SSM\n requests.

    " } }, "PlatformName": { @@ -10907,12 +11081,6 @@ "traits": { "smithy.api#documentation": "

    The date and time when agent last pinged Systems Manager service.

    " } - }, - "Name": { - "target": "com.amazonaws.ssm#String", - "traits": { - "smithy.api#documentation": "

    The name assigned to an on-premises server or virtual machine (VM) when it is activated as a\n Systems Manager managed instance. The name is specified as the DefaultInstanceName property\n using the CreateActivation command. It is applied to the managed instance by\n specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as\n explained in Install SSM Agent for a\n hybrid environment (Linux) and Install SSM Agent for a hybrid environment\n (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2\n DescribeInstances action. For information, see DescribeInstances in the\n Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

    " - } } }, "traits": { @@ -10922,17 +11090,17 @@ "com.amazonaws.ssm#InstanceInformationFilter": { "type": "structure", "members": { - "valueSet": { - "target": "com.amazonaws.ssm#InstanceInformationFilterValueSet", + "key": { + "target": "com.amazonaws.ssm#InstanceInformationFilterKey", "traits": { - "smithy.api#documentation": "

    The filter values.

    ", + "smithy.api#documentation": "

    The name of the filter.

    ", "smithy.api#required": {} } }, - "key": { - "target": "com.amazonaws.ssm#InstanceInformationFilterKey", + "valueSet": { + "target": "com.amazonaws.ssm#InstanceInformationFilterValueSet", "traits": { - "smithy.api#documentation": "

    The name of the filter.

    ", + "smithy.api#documentation": "

    The filter values.

    ", "smithy.api#required": {} } } @@ -11073,49 +11241,42 @@ "com.amazonaws.ssm#InstancePatchState": { "type": "structure", "members": { - "MissingCount": { - "target": "com.amazonaws.ssm#PatchMissingCount", - "traits": { - "smithy.api#documentation": "

    The number of patches from the patch baseline that are applicable for the instance but\n aren't currently installed.

    " - } - }, - "InstallOverrideList": { - "target": "com.amazonaws.ssm#InstallOverrideList", + "OperationStartTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch\n installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM\n document AWS-RunPatchBaseline, overrides the patches specified by the default patch\n baseline.

    \n

    For more information about the InstallOverrideList parameter, see About the\n SSM document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    The time the most recent patching operation was started on the instance.

    ", + "smithy.api#required": {} } }, - "BaselineId": { - "target": "com.amazonaws.ssm#BaselineId", + "RebootOption": { + "target": "com.amazonaws.ssm#RebootOption", "traits": { - "smithy.api#documentation": "

    The ID of the patch baseline used to patch the instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates the reboot option specified in the patch baseline.

    \n \n

    Reboot options apply to Install operations only. Reboots are not attempted for\n Patch Manager Scan operations.

    \n     \n
      \n
    • \n

      \n RebootIfNeeded: Patch Manager tries to reboot the\n instance if it installed any patches, or if any patches are detected with a status of\n InstalledPendingReboot.

      \n
      • \n
    • \n

      \n NoReboot: Patch Manager attempts to install missing\n packages without trying to reboot the system. Patches installed with this option are assigned a\n status of InstalledPendingReboot. These patches might not be in effect until a\n reboot is performed.

      \n
      • \n
    " } }, - "OperationEndTime": { - "target": "com.amazonaws.ssm#DateTime", + "NotApplicableCount": { + "target": "com.amazonaws.ssm#PatchNotApplicableCount", "traits": { - "smithy.api#documentation": "

    The time the most recent patching operation completed on the instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of patches from the patch baseline that aren't applicable for the instance and\n therefore aren't installed on the instance. This number may be truncated if the list of patch\n names is very large. The number of patches beyond this limit are reported in\n UnreportedNotApplicableCount.

    " } }, - "LastNoRebootInstallOperationTime": { - "target": "com.amazonaws.ssm#DateTime", + "MissingCount": { + "target": "com.amazonaws.ssm#PatchMissingCount", "traits": { - "smithy.api#documentation": "

    The time of the last attempt to patch the instance with NoReboot specified as\n the reboot option.

    " + "smithy.api#documentation": "

    The number of patches from the patch baseline that are applicable for the instance but\n aren't currently installed.

    " } }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "SnapshotId": { + "target": "com.amazonaws.ssm#SnapshotId", "traits": { - "smithy.api#documentation": "

    The ID of the managed instance the high-level patch compliance information was collected\n for.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ID of the patch baseline snapshot used during the patching operation when this\n compliance data was collected.

    " } }, - "InstalledOtherCount": { - "target": "com.amazonaws.ssm#PatchInstalledOtherCount", + "InstalledPendingRebootCount": { + "target": "com.amazonaws.ssm#PatchInstalledPendingRebootCount", "traits": { - "smithy.api#documentation": "

    The number of patches not specified in the patch baseline that are installed on the\n instance.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The number of patches installed by Patch Manager since the last time the instance was\n rebooted.

    " } }, "OwnerInformation": { @@ -11124,57 +11285,50 @@ "smithy.api#documentation": "

    Placeholder information. This field will always be empty in the current release of the\n service.

    " } }, - "Operation": { - "target": "com.amazonaws.ssm#PatchOperationType", - "traits": { - "smithy.api#documentation": "

    The type of patching operation that was performed: SCAN (assess patch compliance state) or\n INSTALL (install missing patches).

    ", - "smithy.api#required": {} - } - }, - "InstalledPendingRebootCount": { - "target": "com.amazonaws.ssm#PatchInstalledPendingRebootCount", + "InstalledOtherCount": { + "target": "com.amazonaws.ssm#PatchInstalledOtherCount", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The number of patches installed by Patch Manager since the last time the instance was\n rebooted.

    " + "smithy.api#documentation": "

    The number of patches not specified in the patch baseline that are installed on the\n instance.

    " } }, - "RebootOption": { - "target": "com.amazonaws.ssm#RebootOption", + "OperationEndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    Indicates the reboot option specified in the patch baseline.

    \n \n

    Reboot options apply to Install operations only. Reboots are not attempted for\n Patch Manager Scan operations.

    \n     \n
      \n
    • \n

      \n RebootIfNeeded: Patch Manager tries to reboot the\n instance if it installed any patches, or if any patches are detected with a status of\n InstalledPendingReboot.

      \n
      • \n
    • \n

      \n NoReboot: Patch Manager attempts to install missing\n packages without trying to reboot the system. Patches installed with this option are assigned a\n status of InstalledPendingReboot. These patches might not be in effect until a\n reboot is performed.

      \n
      • \n
    " + "smithy.api#documentation": "

    The time the most recent patching operation completed on the instance.

    ", + "smithy.api#required": {} } }, - "SnapshotId": { - "target": "com.amazonaws.ssm#SnapshotId", + "InstallOverrideList": { + "target": "com.amazonaws.ssm#InstallOverrideList", "traits": { - "smithy.api#documentation": "

    The ID of the patch baseline snapshot used during the patching operation when this\n compliance data was collected.

    " + "smithy.api#documentation": "

    An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch\n installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM\n document AWS-RunPatchBaseline, overrides the patches specified by the default patch\n baseline.

    \n

    For more information about the InstallOverrideList parameter, see About the\n SSM document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

    " } }, - "PatchGroup": { - "target": "com.amazonaws.ssm#PatchGroup", + "Operation": { + "target": "com.amazonaws.ssm#PatchOperationType", "traits": { - "smithy.api#documentation": "

    The name of the patch group the managed instance belongs to.

    ", + "smithy.api#documentation": "

    The type of patching operation that was performed: SCAN (assess patch\n compliance state) or INSTALL (install missing patches).

    ", "smithy.api#required": {} } }, - "InstalledRejectedCount": { - "target": "com.amazonaws.ssm#PatchInstalledRejectedCount", + "UnreportedNotApplicableCount": { + "target": "com.amazonaws.ssm#PatchUnreportedNotApplicableCount", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    The number of instances with patches installed that are specified in a RejectedPatches list.\n Patches with a status of InstalledRejected were typically installed before\n they were added to a RejectedPatches list.

    \n \n

    If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of\n InstalledRejectedCount will always be 0 (zero).

    \n     " + "smithy.api#documentation": "

    The number of patches beyond the supported limit of NotApplicableCount that are\n not reported by name to Systems Manager Inventory.

    " } }, - "NotApplicableCount": { - "target": "com.amazonaws.ssm#PatchNotApplicableCount", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The number of patches from the patch baseline that aren't applicable for the instance and\n therefore aren't installed on the instance. This number may be truncated if the list of patch\n names is very large. The number of patches beyond this limit are reported in\n UnreportedNotApplicableCount.

    " + "smithy.api#documentation": "

    The ID of the managed instance the high-level patch compliance information was collected\n for.

    ", + "smithy.api#required": {} } }, - "OperationStartTime": { + "LastNoRebootInstallOperationTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The time the most recent patching operation was started on the instance.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The time of the last attempt to patch the instance with NoReboot specified as\n the reboot option.

    " } }, "FailedCount": { @@ -11183,18 +11337,32 @@ "smithy.api#documentation": "

    The number of patches from the patch baseline that were attempted to be installed during the\n last patching operation, but failed to install.

    " } }, - "UnreportedNotApplicableCount": { - "target": "com.amazonaws.ssm#PatchUnreportedNotApplicableCount", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The number of patches beyond the supported limit of NotApplicableCount that are\n not reported by name to Systems Manager Inventory.

    " - } - }, "InstalledCount": { "target": "com.amazonaws.ssm#PatchInstalledCount", "traits": { "smithy.api#documentation": "

    The number of patches from the patch baseline that are installed on the instance.

    " } + }, + "BaselineId": { + "target": "com.amazonaws.ssm#BaselineId", + "traits": { + "smithy.api#documentation": "

    The ID of the patch baseline used to patch the instance.

    ", + "smithy.api#required": {} + } + }, + "PatchGroup": { + "target": "com.amazonaws.ssm#PatchGroup", + "traits": { + "smithy.api#documentation": "

    The name of the patch group the managed instance belongs to.

    ", + "smithy.api#required": {} + } + }, + "InstalledRejectedCount": { + "target": "com.amazonaws.ssm#PatchInstalledRejectedCount", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The number of patches installed on an instance that are specified in a\n RejectedPatches list. Patches with a status of\n InstalledRejected were typically installed before they were added to a\n RejectedPatches list.

    \n \n

    If ALLOW_AS_DEPENDENCY is the specified option for\n RejectedPatchesAction, the value of InstalledRejectedCount will\n always be 0 (zero).

    \n     " + } } }, "traits": { @@ -11204,10 +11372,10 @@ "com.amazonaws.ssm#InstancePatchStateFilter": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.ssm#InstancePatchStateFilterKey", + "Values": { + "target": "com.amazonaws.ssm#InstancePatchStateFilterValues", "traits": { - "smithy.api#documentation": "

    The key for the filter. Supported values are FailedCount, InstalledCount,\n InstalledOtherCount, MissingCount and NotApplicableCount.

    ", + "smithy.api#documentation": "

    The value for the filter, must be an integer greater than or equal to 0.

    ", "smithy.api#required": {} } }, @@ -11218,16 +11386,16 @@ "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.ssm#InstancePatchStateFilterValues", + "Key": { + "target": "com.amazonaws.ssm#InstancePatchStateFilterKey", "traits": { - "smithy.api#documentation": "

    The value for the filter, must be an integer greater than or equal to 0.

    ", + "smithy.api#documentation": "

    The key for the filter. Supported values are FailedCount, InstalledCount,\n InstalledOtherCount, MissingCount and NotApplicableCount.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the\n information returned by the API.

    " + "smithy.api#documentation": "

    Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to\n scope down the information returned by the API.

    " } }, "com.amazonaws.ssm#InstancePatchStateFilterKey": { @@ -11664,11 +11832,11 @@ "com.amazonaws.ssm#InvalidItemContentException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ssm#String" - }, "TypeName": { "target": "com.amazonaws.ssm#InventoryItemTypeName" + }, + "Message": { + "target": "com.amazonaws.ssm#String" } }, "traits": { @@ -11949,9 +12117,6 @@ ] } }, - "com.amazonaws.ssm#InventoryDeletionId": { - "type": "string" - }, "com.amazonaws.ssm#InventoryDeletionLastStatusMessage": { "type": "string" }, @@ -11979,40 +12144,40 @@ "com.amazonaws.ssm#InventoryDeletionStatusItem": { "type": "structure", "members": { - "LastStatusMessage": { - "target": "com.amazonaws.ssm#InventoryDeletionLastStatusMessage", + "LastStatus": { + "target": "com.amazonaws.ssm#InventoryDeletionStatus", "traits": { - "smithy.api#documentation": "

    Information about the status.

    " + "smithy.api#documentation": "

    The status of the operation. Possible values are InProgress and Complete.

    " } }, - "DeletionId": { - "target": "com.amazonaws.ssm#InventoryDeletionId", + "LastStatusUpdateTime": { + "target": "com.amazonaws.ssm#InventoryDeletionLastStatusUpdateTime", "traits": { - "smithy.api#documentation": "

    The deletion ID returned by the DeleteInventory action.

    " + "smithy.api#documentation": "

    The UTC timestamp of when the last status report.

    " } }, - "TypeName": { - "target": "com.amazonaws.ssm#InventoryItemTypeName", + "DeletionStartTime": { + "target": "com.amazonaws.ssm#InventoryDeletionStartTime", "traits": { - "smithy.api#documentation": "

    The name of the inventory data type.

    " + "smithy.api#documentation": "

    The UTC timestamp when the delete operation started.

    " } }, - "LastStatus": { - "target": "com.amazonaws.ssm#InventoryDeletionStatus", + "DeletionId": { + "target": "com.amazonaws.ssm#UUID", "traits": { - "smithy.api#documentation": "

    The status of the operation. Possible values are InProgress and Complete.

    " + "smithy.api#documentation": "

    The deletion ID returned by the DeleteInventory action.

    " } }, - "DeletionStartTime": { - "target": "com.amazonaws.ssm#InventoryDeletionStartTime", + "TypeName": { + "target": "com.amazonaws.ssm#InventoryItemTypeName", "traits": { - "smithy.api#documentation": "

    The UTC timestamp when the delete operation started.

    " + "smithy.api#documentation": "

    The name of the inventory data type.

    " } }, - "LastStatusUpdateTime": { - "target": "com.amazonaws.ssm#InventoryDeletionLastStatusUpdateTime", + "LastStatusMessage": { + "target": "com.amazonaws.ssm#InventoryDeletionLastStatusMessage", "traits": { - "smithy.api#documentation": "

    The UTC timestamp of when the last status report.

    " + "smithy.api#documentation": "

    Information about the status.

    " } }, "DeletionSummary": { @@ -12099,17 +12264,17 @@ "smithy.api#documentation": "

    The type of filter.

    \n \n

    The Exists filter must be used with aggregators. For more information, see\n Aggregating inventory\n data in the AWS Systems Manager User Guide.

    \n     " } }, - "Key": { - "target": "com.amazonaws.ssm#InventoryFilterKey", + "Values": { + "target": "com.amazonaws.ssm#InventoryFilterValueList", "traits": { - "smithy.api#documentation": "

    The name of the filter key.

    ", + "smithy.api#documentation": "

    Inventory filter values. Example: inventory filter where instance IDs are specified as\n values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal\n

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.ssm#InventoryFilterValueList", + "Key": { + "target": "com.amazonaws.ssm#InventoryFilterKey", "traits": { - "smithy.api#documentation": "

    Inventory filter values. Example: inventory filter where instance IDs are specified as\n values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal\n

    ", + "smithy.api#documentation": "

    The name of the filter key.

    ", "smithy.api#required": {} } } @@ -12209,11 +12374,10 @@ "com.amazonaws.ssm#InventoryItem": { "type": "structure", "members": { - "SchemaVersion": { - "target": "com.amazonaws.ssm#InventoryItemSchemaVersion", + "Context": { + "target": "com.amazonaws.ssm#InventoryItemContentContext", "traits": { - "smithy.api#documentation": "

    The schema version for the inventory item.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A map of associated properties for a specified inventory type. For example, with this\n attribute, you can specify the ExecutionId, ExecutionType,\n ComplianceType properties of the AWS:ComplianceItem type.

    " } }, "CaptureTime": { @@ -12223,30 +12387,31 @@ "smithy.api#required": {} } }, - "TypeName": { - "target": "com.amazonaws.ssm#InventoryItemTypeName", - "traits": { - "smithy.api#documentation": "

    The name of the inventory type. Default inventory item type names start with AWS. Custom\n inventory type names will start with Custom. Default inventory item types include the following:\n AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and\n AWS:WindowsUpdate.

    ", - "smithy.api#required": {} - } - }, - "Context": { - "target": "com.amazonaws.ssm#InventoryItemContentContext", - "traits": { - "smithy.api#documentation": "

    A map of associated properties for a specified inventory type. For example, with this\n attribute, you can specify the ExecutionId, ExecutionType,\n ComplianceType properties of the AWS:ComplianceItem type.

    " - } - }, "Content": { "target": "com.amazonaws.ssm#InventoryItemEntryList", "traits": { "smithy.api#documentation": "

    The inventory data of the inventory type.

    " } }, + "SchemaVersion": { + "target": "com.amazonaws.ssm#InventoryItemSchemaVersion", + "traits": { + "smithy.api#documentation": "

    The schema version for the inventory item.

    ", + "smithy.api#required": {} + } + }, "ContentHash": { "target": "com.amazonaws.ssm#InventoryItemContentHash", "traits": { "smithy.api#documentation": "

    MD5 hash of the inventory item type contents. The content hash is used to determine whether\n to update inventory information. The PutInventory API does not update the inventory item type\n contents if the MD5 hash has not changed since last update.

    " } + }, + "TypeName": { + "target": "com.amazonaws.ssm#InventoryItemTypeName", + "traits": { + "smithy.api#documentation": "

    The name of the inventory type. Default inventory item type names start with AWS. Custom\n inventory type names will start with Custom. Default inventory item types include the following:\n AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and\n AWS:WindowsUpdate.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -12256,17 +12421,17 @@ "com.amazonaws.ssm#InventoryItemAttribute": { "type": "structure", "members": { - "DataType": { - "target": "com.amazonaws.ssm#InventoryAttributeDataType", + "Name": { + "target": "com.amazonaws.ssm#InventoryItemAttributeName", "traits": { - "smithy.api#documentation": "

    The data type of the inventory item attribute.

    ", + "smithy.api#documentation": "

    Name of the inventory item attribute.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.ssm#InventoryItemAttributeName", + "DataType": { + "target": "com.amazonaws.ssm#InventoryAttributeDataType", "traits": { - "smithy.api#documentation": "

    Name of the inventory item attribute.

    ", + "smithy.api#documentation": "

    The data type of the inventory item attribute.

    ", "smithy.api#required": {} } } @@ -12368,18 +12533,6 @@ "com.amazonaws.ssm#InventoryItemSchema": { "type": "structure", "members": { - "DisplayName": { - "target": "com.amazonaws.ssm#InventoryTypeDisplayName", - "traits": { - "smithy.api#documentation": "

    The alias name of the inventory type. The alias name is used for display purposes.

    " - } - }, - "Version": { - "target": "com.amazonaws.ssm#InventoryItemSchemaVersion", - "traits": { - "smithy.api#documentation": "

    The schema version for the inventory item.

    " - } - }, "Attributes": { "target": "com.amazonaws.ssm#InventoryItemAttributeList", "traits": { @@ -12393,6 +12546,18 @@ "smithy.api#documentation": "

    The name of the inventory type. Default inventory item type names start with AWS. Custom\n inventory type names will start with Custom. Default inventory item types include the following:\n AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and\n AWS:WindowsUpdate.

    ", "smithy.api#required": {} } + }, + "Version": { + "target": "com.amazonaws.ssm#InventoryItemSchemaVersion", + "traits": { + "smithy.api#documentation": "

    The schema version for the inventory item.

    " + } + }, + "DisplayName": { + "target": "com.amazonaws.ssm#InventoryTypeDisplayName", + "traits": { + "smithy.api#documentation": "

    The alias name of the inventory type. The alias name is used for display purposes.

    " + } } }, "traits": { @@ -12464,17 +12629,17 @@ "com.amazonaws.ssm#InventoryResultEntity": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.ssm#InventoryResultEntityId", - "traits": { - "smithy.api#documentation": "

    ID of the inventory result entity. For example, for managed instance inventory the result\n will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.\n

    " - } - }, "Data": { "target": "com.amazonaws.ssm#InventoryResultItemMap", "traits": { "smithy.api#documentation": "

    The data section in the inventory result entity JSON.

    " } + }, + "Id": { + "target": "com.amazonaws.ssm#InventoryResultEntityId", + "traits": { + "smithy.api#documentation": "

    ID of the inventory result entity. For example, for managed instance inventory the result\n will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.\n

    " + } } }, "traits": { @@ -12496,17 +12661,23 @@ "com.amazonaws.ssm#InventoryResultItem": { "type": "structure", "members": { + "SchemaVersion": { + "target": "com.amazonaws.ssm#InventoryItemSchemaVersion", + "traits": { + "smithy.api#documentation": "

    The schema version for the inventory result item/

    ", + "smithy.api#required": {} + } + }, "CaptureTime": { "target": "com.amazonaws.ssm#InventoryItemCaptureTime", "traits": { "smithy.api#documentation": "

    The time inventory item data was captured.

    " } }, - "TypeName": { - "target": "com.amazonaws.ssm#InventoryItemTypeName", + "ContentHash": { + "target": "com.amazonaws.ssm#InventoryItemContentHash", "traits": { - "smithy.api#documentation": "

    The name of the inventory result item type.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    MD5 hash of the inventory item type contents. The content hash is used to determine whether\n to update inventory information. The PutInventory API does not update the inventory item type\n contents if the MD5 hash has not changed since last update.

    " } }, "Content": { @@ -12516,18 +12687,12 @@ "smithy.api#required": {} } }, - "SchemaVersion": { - "target": "com.amazonaws.ssm#InventoryItemSchemaVersion", + "TypeName": { + "target": "com.amazonaws.ssm#InventoryItemTypeName", "traits": { - "smithy.api#documentation": "

    The schema version for the inventory result item/

    ", + "smithy.api#documentation": "

    The name of the inventory result item type.

    ", "smithy.api#required": {} } - }, - "ContentHash": { - "target": "com.amazonaws.ssm#InventoryItemContentHash", - "traits": { - "smithy.api#documentation": "

    MD5 hash of the inventory item type contents. The content hash is used to determine whether\n to update inventory information. The PutInventory API does not update the inventory item type\n contents if the MD5 hash has not changed since last update.

    " - } } }, "traits": { @@ -12587,11 +12752,11 @@ "com.amazonaws.ssm#ItemContentMismatchException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.ssm#String" - }, "TypeName": { "target": "com.amazonaws.ssm#InventoryItemTypeName" + }, + "Message": { + "target": "com.amazonaws.ssm#String" } }, "traits": { @@ -12678,17 +12843,17 @@ "com.amazonaws.ssm#LabelParameterVersionResult": { "type": "structure", "members": { - "ParameterVersion": { - "target": "com.amazonaws.ssm#PSParameterVersion", - "traits": { - "smithy.api#documentation": "

    The version of the parameter that has been labeled.

    " - } - }, "InvalidLabels": { "target": "com.amazonaws.ssm#ParameterLabelList", "traits": { "smithy.api#documentation": "

    The label does not meet the requirements. For information about parameter label\n requirements, see Labeling parameters\n in the AWS Systems Manager User Guide.

    " } + }, + "ParameterVersion": { + "target": "com.amazonaws.ssm#PSParameterVersion", + "traits": { + "smithy.api#documentation": "

    The version of the parameter that has been labeled.

    " + } } } }, @@ -12740,17 +12905,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves all versions of an association for a specific association ID.

    " + "smithy.api#documentation": "

    Retrieves all versions of an association for a specific association ID.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssociationVersions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#ListAssociationVersionsRequest": { "type": "structure", "members": { - "AssociationId": { - "target": "com.amazonaws.ssm#AssociationId", + "MaxResults": { + "target": "com.amazonaws.ssm#MaxResults", "traits": { - "smithy.api#documentation": "

    The association ID for which you want to view all versions.

    ", - "smithy.api#required": {} + "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": { @@ -12759,11 +12930,11 @@ "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " } }, - "MaxResults": { - "target": "com.amazonaws.ssm#MaxResults", + "AssociationId": { + "target": "com.amazonaws.ssm#AssociationId", "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 association ID for which you want to view all versions.

    ", + "smithy.api#required": {} } } } @@ -12771,17 +12942,17 @@ "com.amazonaws.ssm#ListAssociationVersionsResult": { "type": "structure", "members": { - "AssociationVersions": { - "target": "com.amazonaws.ssm#AssociationVersionList", - "traits": { - "smithy.api#documentation": "

    Information about all versions of the association for the specified association ID.

    " - } - }, "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.

    " } + }, + "AssociationVersions": { + "target": "com.amazonaws.ssm#AssociationVersionList", + "traits": { + "smithy.api#documentation": "

    Information about all versions of the association for the specified association ID.

    " + } } } }, @@ -12814,18 +12985,18 @@ "com.amazonaws.ssm#ListAssociationsRequest": { "type": "structure", "members": { - "AssociationFilterList": { - "target": "com.amazonaws.ssm#AssociationFilterList", - "traits": { - "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    " - } - }, "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.)

    " } }, + "AssociationFilterList": { + "target": "com.amazonaws.ssm#AssociationFilterList", + "traits": { + "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    " + } + }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { @@ -12896,17 +13067,22 @@ "smithy.api#documentation": "

    (Optional) If set this returns the response of the command executions and any command\n output. By default this is set to False.

    " } }, + "Filters": { + "target": "com.amazonaws.ssm#CommandFilterList", + "traits": { + "smithy.api#documentation": "

    (Optional) One or more filters. Use a filter to return a more specific list of\n results.

    " + } + }, "CommandId": { "target": "com.amazonaws.ssm#CommandId", "traits": { "smithy.api#documentation": "

    (Optional) The invocations for a specific command ID.

    " } }, - "MaxResults": { - "target": "com.amazonaws.ssm#CommandMaxResults", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    (Optional) The maximum number of items to return for this call. The call also returns a\n token that you can specify in a subsequent call to get the next set of results.

    " + "smithy.api#documentation": "

    (Optional) The command execution details for a specific instance ID.

    " } }, "NextToken": { @@ -12915,16 +13091,11 @@ "smithy.api#documentation": "

    (Optional) The token for the next set of items to return. (You received this token from a\n previous call.)

    " } }, - "Filters": { - "target": "com.amazonaws.ssm#CommandFilterList", - "traits": { - "smithy.api#documentation": "

    (Optional) One or more filters. Use a filter to return a more specific list of\n results.

    " - } - }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "MaxResults": { + "target": "com.amazonaws.ssm#CommandMaxResults", "traits": { - "smithy.api#documentation": "

    (Optional) The command execution details for a specific instance ID.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    (Optional) The maximum number of items to return for this call. The call also returns a\n token that you can specify in a subsequent call to get the next set of results.

    " } } } @@ -12984,6 +13155,12 @@ "com.amazonaws.ssm#ListCommandsRequest": { "type": "structure", "members": { + "CommandId": { + "target": "com.amazonaws.ssm#CommandId", + "traits": { + "smithy.api#documentation": "

    (Optional) If provided, lists only the specified command.

    " + } + }, "MaxResults": { "target": "com.amazonaws.ssm#CommandMaxResults", "traits": { @@ -12997,10 +13174,10 @@ "smithy.api#documentation": "

    (Optional) Lists commands issued against this instance ID.

    \n \n

    You can't specify an instance ID in the same command that you specify Status =\n Pending. This is because the command has not reached the instance yet.

    \n     " } }, - "CommandId": { - "target": "com.amazonaws.ssm#CommandId", + "Filters": { + "target": "com.amazonaws.ssm#CommandFilterList", "traits": { - "smithy.api#documentation": "

    (Optional) If provided, lists only the specified command.

    " + "smithy.api#documentation": "

    (Optional) One or more filters. Use a filter to return a more specific list of results.\n

    " } }, "NextToken": { @@ -13008,12 +13185,6 @@ "traits": { "smithy.api#documentation": "

    (Optional) The token for the next set of items to return. (You received this token from a\n previous call.)

    " } - }, - "Filters": { - "target": "com.amazonaws.ssm#CommandFilterList", - "traits": { - "smithy.api#documentation": "

    (Optional) One or more filters. Use a filter to return a more specific list of results.\n

    " - } } } }, @@ -13060,19 +13231,18 @@ } ], "traits": { - "smithy.api#documentation": "

    For a specified resource ID, this API action returns a list of compliance statuses for\n different resource types. Currently, you can only specify one resource ID per call. List results\n depend on the criteria specified in the filter.

    " + "smithy.api#documentation": "

    For a specified resource ID, this API action returns a list of compliance statuses for\n different resource types. Currently, you can only specify one resource ID per call. List results\n depend on the criteria specified in the filter.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ComplianceItems", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#ListComplianceItemsRequest": { "type": "structure", "members": { - "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.

    " - } - }, "ResourceIds": { "target": "com.amazonaws.ssm#ComplianceResourceIdList", "traits": { @@ -13085,6 +13255,13 @@ "smithy.api#documentation": "

    A token to start the list. Use this token to get the next set of results.

    " } }, + "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.

    " + } + }, "ResourceTypes": { "target": "com.amazonaws.ssm#ComplianceResourceTypeList", "traits": { @@ -13102,17 +13279,17 @@ "com.amazonaws.ssm#ListComplianceItemsResult": { "type": "structure", "members": { - "ComplianceItems": { - "target": "com.amazonaws.ssm#ComplianceItemList", - "traits": { - "smithy.api#documentation": "

    A list of compliance information for the specified resource ID.

    " - } - }, "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.

    " } + }, + "ComplianceItems": { + "target": "com.amazonaws.ssm#ComplianceItemList", + "traits": { + "smithy.api#documentation": "

    A list of compliance information for the specified resource ID.

    " + } } } }, @@ -13136,7 +13313,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a summary count of compliant and non-compliant resources for a compliance type. For\n example, this call can return State Manager associations, patches, or custom compliance types\n according to the filter criteria that you specify.

    " + "smithy.api#documentation": "

    Returns a summary count of compliant and non-compliant resources for a compliance type. For\n example, this call can return State Manager associations, patches, or custom compliance types\n according to the filter criteria that you specify.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ComplianceSummaryItems", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#ListComplianceSummariesRequest": { @@ -13149,34 +13332,34 @@ "smithy.api#documentation": "

    The maximum number of items to return for this call. Currently, you can specify null or 50.\n The call also returns a token that you can specify in a subsequent call to get the next set of\n 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.

    " - } - }, "Filters": { "target": "com.amazonaws.ssm#ComplianceStringFilterList", "traits": { "smithy.api#documentation": "

    One or more compliance or inventory filters. Use a filter to return a more specific list of\n 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#ListComplianceSummariesResult": { "type": "structure", "members": { - "ComplianceSummaryItems": { - "target": "com.amazonaws.ssm#ComplianceSummaryItemList", - "traits": { - "smithy.api#documentation": "

    A list of compliant and non-compliant summary counts based on compliance types. For example,\n this call returns State Manager associations, patches, or custom compliance types according to\n the filter criteria that you specified.

    " - } - }, "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.

    " } + }, + "ComplianceSummaryItems": { + "target": "com.amazonaws.ssm#ComplianceSummaryItemList", + "traits": { + "smithy.api#documentation": "

    A list of compliant and non-compliant summary counts based on compliance types. For example,\n this call returns State Manager associations, patches, or custom compliance types according to\n the filter criteria that you specified.

    " + } } } }, @@ -13200,19 +13383,18 @@ } ], "traits": { - "smithy.api#documentation": "

    List all versions for a document.

    " + "smithy.api#documentation": "

    List all versions for a document.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DocumentVersions", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#ListDocumentVersionsRequest": { "type": "structure", "members": { - "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.

    " - } - }, "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { @@ -13225,6 +13407,13 @@ "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.

    " + } } } }, @@ -13277,12 +13466,6 @@ "com.amazonaws.ssm#ListDocumentsRequest": { "type": "structure", "members": { - "DocumentFilterList": { - "target": "com.amazonaws.ssm#DocumentFilterList", - "traits": { - "smithy.api#documentation": "

    This data type is deprecated. Instead, use Filters.

    " - } - }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { @@ -13301,23 +13484,29 @@ "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.

    " } + }, + "DocumentFilterList": { + "target": "com.amazonaws.ssm#DocumentFilterList", + "traits": { + "smithy.api#documentation": "

    This data type is deprecated. Instead, use Filters.

    " + } } } }, "com.amazonaws.ssm#ListDocumentsResult": { "type": "structure", "members": { - "DocumentIdentifiers": { - "target": "com.amazonaws.ssm#DocumentIdentifierList", - "traits": { - "smithy.api#documentation": "

    The names of the Systems Manager documents.

    " - } - }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " } + }, + "DocumentIdentifiers": { + "target": "com.amazonaws.ssm#DocumentIdentifierList", + "traits": { + "smithy.api#documentation": "

    The names of the Systems Manager documents.

    " + } } } }, @@ -13353,16 +13542,23 @@ "com.amazonaws.ssm#ListInventoryEntriesRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ssm#InventoryFilterList", + "traits": { + "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    " + } + }, "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.)

    " } }, - "Filters": { - "target": "com.amazonaws.ssm#InventoryFilterList", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    " + "smithy.api#documentation": "

    The instance ID for which you want inventory information.

    ", + "smithy.api#required": {} } }, "MaxResults": { @@ -13378,29 +13574,28 @@ "smithy.api#documentation": "

    The type of inventory item for which you want information.

    ", "smithy.api#required": {} } - }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", - "traits": { - "smithy.api#documentation": "

    The instance ID for which you want inventory information.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.ssm#ListInventoryEntriesResult": { "type": "structure", "members": { + "Entries": { + "target": "com.amazonaws.ssm#InventoryItemEntryList", + "traits": { + "smithy.api#documentation": "

    A list of inventory items on the instance(s).

    " + } + }, "NextToken": { "target": "com.amazonaws.ssm#NextToken", "traits": { "smithy.api#documentation": "

    The token to use when requesting the next set of items. If there are no additional items to\n return, the string is empty.

    " } }, - "Entries": { - "target": "com.amazonaws.ssm#InventoryItemEntryList", + "CaptureTime": { + "target": "com.amazonaws.ssm#InventoryItemCaptureTime", "traits": { - "smithy.api#documentation": "

    A list of inventory items on the instance(s).

    " + "smithy.api#documentation": "

    The time that inventory information was collected for the instance(s).

    " } }, "SchemaVersion": { @@ -13415,12 +13610,6 @@ "smithy.api#documentation": "

    The type of inventory item returned by the request.

    " } }, - "CaptureTime": { - "target": "com.amazonaws.ssm#InventoryItemCaptureTime", - "traits": { - "smithy.api#documentation": "

    The time that inventory information was collected for the instance(s).

    " - } - }, "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { @@ -13449,24 +13638,30 @@ } ], "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": "

    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": { - "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.

    " - } - }, "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.

    " } }, + "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.

    " + } + }, "MaxResults": { "target": "com.amazonaws.ssm#MaxResults", "traits": { @@ -13513,7 +13708,13 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists your resource data sync configurations. Includes information about the last time a\n sync attempted to start, the last sync status, and the last time a sync successfully\n completed.

    \n

    The number of sync configurations might be too large to return using a single call to\n ListResourceDataSync. You can limit the number of sync configurations returned by\n using the MaxResults parameter. To determine whether there are more sync\n configurations to list, check the value of NextToken in the output. If there are\n more sync configurations to list, you can request them by specifying the NextToken\n returned in the call to the parameter of a subsequent call.

    " + "smithy.api#documentation": "

    Lists your resource data sync configurations. Includes information about the last time a\n sync attempted to start, the last sync status, and the last time a sync successfully\n completed.

    \n

    The number of sync configurations might be too large to return using a single call to\n ListResourceDataSync. You can limit the number of sync configurations returned by\n using the MaxResults parameter. To determine whether there are more sync\n configurations to list, check the value of NextToken in the output. If there are\n more sync configurations to list, you can request them by specifying the NextToken\n returned in the call to the parameter of a subsequent call.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ResourceDataSyncItems", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ssm#ListResourceDataSyncRequest": { @@ -13529,7 +13730,7 @@ "SyncType": { "target": "com.amazonaws.ssm#ResourceDataSyncType", "traits": { - "smithy.api#documentation": "

    View a list of resource data syncs according to the sync type. Specify\n SyncToDestination to view resource data syncs that synchronize data to an Amazon S3\n buckets. Specify SyncFromSource to view resource data syncs from AWS Organizations or from\n multiple AWS Regions.

    " + "smithy.api#documentation": "

    View a list of resource data syncs according to the sync type. Specify\n SyncToDestination to view resource data syncs that synchronize data to an Amazon S3\n bucket. Specify SyncFromSource to view resource data syncs from AWS Organizations or from\n multiple AWS Regions.

    " } }, "NextToken": { @@ -13543,17 +13744,17 @@ "com.amazonaws.ssm#ListResourceDataSyncResult": { "type": "structure", "members": { - "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.

    " - } - }, "ResourceDataSyncItems": { "target": "com.amazonaws.ssm#ResourceDataSyncItemList", "traits": { "smithy.api#documentation": "

    A list of your current Resource Data Sync configurations and their statuses.

    " } + }, + "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.

    " + } } } }, @@ -13583,17 +13784,17 @@ "com.amazonaws.ssm#ListTagsForResourceRequest": { "type": "structure", "members": { - "ResourceType": { - "target": "com.amazonaws.ssm#ResourceTypeForTagging", + "ResourceId": { + "target": "com.amazonaws.ssm#ResourceId", "traits": { - "smithy.api#documentation": "

    Returns a list of tags for a specific resource type.

    ", + "smithy.api#documentation": "

    The resource ID for which you want to see a list of tags.

    ", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.ssm#ResourceId", + "ResourceType": { + "target": "com.amazonaws.ssm#ResourceTypeForTagging", "traits": { - "smithy.api#documentation": "

    The resource ID for which you want to see a list of tags.

    ", + "smithy.api#documentation": "

    Returns a list of tags for a specific resource type.

    ", "smithy.api#required": {} } } @@ -13647,17 +13848,17 @@ "com.amazonaws.ssm#MaintenanceWindowAutomationParameters": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.ssm#AutomationParameterMap", - "traits": { - "smithy.api#documentation": "

    The parameters for the AUTOMATION task.

    \n\n

    For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n

    For AUTOMATION task types,\n Systems Manager ignores any values specified for these parameters.

    \n     " - } - }, "DocumentVersion": { "target": "com.amazonaws.ssm#DocumentVersion", "traits": { "smithy.api#documentation": "

    The version of an Automation document to use during task execution.

    " } + }, + "Parameters": { + "target": "com.amazonaws.ssm#AutomationParameterMap", + "traits": { + "smithy.api#documentation": "

    The parameters for the AUTOMATION task.

    \n\n

    For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n

    For AUTOMATION task types,\n Systems Manager ignores any values specified for these parameters.

    \n     " + } } }, "traits": { @@ -13698,16 +13899,16 @@ "com.amazonaws.ssm#MaintenanceWindowExecution": { "type": "structure", "members": { - "StatusDetails": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", + "StartTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The details explaining the Status. Only available for certain status values.

    " + "smithy.api#documentation": "

    The time the execution started.

    " } }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "EndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window execution.

    " + "smithy.api#documentation": "

    The time the execution finished.

    " } }, "Status": { @@ -13716,22 +13917,22 @@ "smithy.api#documentation": "

    The status of the execution.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "StatusDetails": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window.

    " + "smithy.api#documentation": "

    The details explaining the Status. Only available for certain status values.

    " } }, - "EndTime": { - "target": "com.amazonaws.ssm#DateTime", + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", "traits": { - "smithy.api#documentation": "

    The time the execution finished.

    " + "smithy.api#documentation": "

    The ID of the maintenance window execution.

    " } }, - "StartTime": { - "target": "com.amazonaws.ssm#DateTime", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#documentation": "

    The time the execution started.

    " + "smithy.api#documentation": "

    The ID of the maintenance window.

    " } } }, @@ -13825,6 +14026,12 @@ "com.amazonaws.ssm#MaintenanceWindowExecutionTaskIdentity": { "type": "structure", "members": { + "Status": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatus", + "traits": { + "smithy.api#documentation": "

    The status of the task execution.

    " + } + }, "TaskArn": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", "traits": { @@ -13837,28 +14044,22 @@ "smithy.api#documentation": "

    The ID of the specific task execution in the maintenance window execution.

    " } }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", - "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window execution that ran the task.

    " - } - }, - "StatusDetails": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", + "EndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The details explaining the status of the task execution. Only available for certain status\n values.

    " + "smithy.api#documentation": "

    The time the task execution finished.

    " } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The time the task execution finished.

    " + "smithy.api#documentation": "

    The time the task execution started.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatus", + "StatusDetails": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatusDetails", "traits": { - "smithy.api#documentation": "

    The status of the task execution.

    " + "smithy.api#documentation": "

    The details explaining the status of the task execution. Only available for certain status\n values.

    " } }, "TaskType": { @@ -13867,10 +14068,10 @@ "smithy.api#documentation": "

    The type of task that ran.

    " } }, - "StartTime": { - "target": "com.amazonaws.ssm#DateTime", + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", "traits": { - "smithy.api#documentation": "

    The time the task execution started.

    " + "smithy.api#documentation": "

    The ID of the maintenance window execution that ran the task.

    " } } }, @@ -13897,40 +14098,40 @@ "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationIdentity": { "type": "structure", "members": { - "Parameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationParameters", + "Status": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatus", "traits": { - "smithy.api#documentation": "

    The parameters that were provided for the invocation when it was run.

    " + "smithy.api#documentation": "

    The status of the task invocation.

    " } }, - "TaskExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", + "Parameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationParameters", "traits": { - "smithy.api#documentation": "

    The ID of the specific task execution in the maintenance window execution.

    " + "smithy.api#documentation": "

    The parameters that were provided for the invocation when it was run.

    " } }, - "ExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskExecutionId", + "OwnerInformation": { + "target": "com.amazonaws.ssm#OwnerInformation", "traits": { - "smithy.api#documentation": "

    The ID of the action performed in the service that actually handled the task invocation. If\n the task type is RUN_COMMAND, this value is the command ID.

    " + "smithy.api#documentation": "

    User-provided value that was specified when the target was registered with the maintenance\n window. This was also included in any CloudWatch events raised during the task invocation.

    " } }, - "WindowTargetId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskTargetId", + "TaskExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskId", "traits": { - "smithy.api#documentation": "

    The ID of the target definition in this maintenance window the invocation was performed\n for.

    " + "smithy.api#documentation": "

    The ID of the specific task execution in the maintenance window execution.

    " } }, - "InvocationId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationId", + "EndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The ID of the task invocation.

    " + "smithy.api#documentation": "

    The time the invocation finished.

    " } }, - "WindowExecutionId": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", + "StartTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window execution that ran the task.

    " + "smithy.api#documentation": "

    The time the invocation started.

    " } }, "StatusDetails": { @@ -13939,34 +14140,34 @@ "smithy.api#documentation": "

    The details explaining the status of the task invocation. Only available for certain Status\n values.

    " } }, - "OwnerInformation": { - "target": "com.amazonaws.ssm#OwnerInformation", + "TaskType": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", "traits": { - "smithy.api#documentation": "

    User-provided value that was specified when the target was registered with the maintenance\n window. This was also included in any CloudWatch events raised during the task invocation.

    " + "smithy.api#documentation": "

    The task type.

    " } }, - "EndTime": { - "target": "com.amazonaws.ssm#DateTime", + "ExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskExecutionId", "traits": { - "smithy.api#documentation": "

    The time the invocation finished.

    " + "smithy.api#documentation": "

    The ID of the action performed in the service that actually handled the task invocation. If\n the task type is RUN_COMMAND, this value is the command ID.

    " } }, - "StartTime": { - "target": "com.amazonaws.ssm#DateTime", + "WindowTargetId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskTargetId", "traits": { - "smithy.api#documentation": "

    The time the invocation started.

    " + "smithy.api#documentation": "

    The ID of the target definition in this maintenance window the invocation was performed\n for.

    " } }, - "TaskType": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", + "InvocationId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionTaskInvocationId", "traits": { - "smithy.api#documentation": "

    The task type.

    " + "smithy.api#documentation": "

    The ID of the task invocation.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#MaintenanceWindowExecutionStatus", + "WindowExecutionId": { + "target": "com.amazonaws.ssm#MaintenanceWindowExecutionId", "traits": { - "smithy.api#documentation": "

    The status of the task invocation.

    " + "smithy.api#documentation": "

    The ID of the maintenance window execution that ran the task.

    " } } }, @@ -13989,17 +14190,17 @@ "com.amazonaws.ssm#MaintenanceWindowFilter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.ssm#MaintenanceWindowFilterValues", - "traits": { - "smithy.api#documentation": "

    The filter values.

    " - } - }, "Key": { "target": "com.amazonaws.ssm#MaintenanceWindowFilterKey", "traits": { "smithy.api#documentation": "

    The name of the filter.

    " } + }, + "Values": { + "target": "com.amazonaws.ssm#MaintenanceWindowFilterValues", + "traits": { + "smithy.api#documentation": "

    The filter values.

    " + } } }, "traits": { @@ -14061,28 +14262,40 @@ "smithy.api#documentation": "

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new\n tasks for execution.

    " } }, - "EndDate": { + "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.

    " + } + }, + "StartDate": { "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become inactive.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become active.

    " } }, - "ScheduleTimezone": { - "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", + "Description": { + "target": "com.amazonaws.ssm#MaintenanceWindowDescription", "traits": { - "smithy.api#documentation": "

    The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format.

    " + "smithy.api#documentation": "

    A description of the maintenance window.

    " } }, - "NextExecutionTime": { + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", + "traits": { + "smithy.api#documentation": "

    The name of the maintenance window.

    " + } + }, + "EndDate": { "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The next time the maintenance window will actually run, taking into account any specified\n times for the maintenance window to become active or inactive.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become inactive.

    " } }, - "Schedule": { - "target": "com.amazonaws.ssm#MaintenanceWindowSchedule", + "NextExecutionTime": { + "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + "smithy.api#documentation": "

    The next time the maintenance window will actually run, taking into account any specified\n times for the maintenance window to become active or inactive.

    " } }, "Enabled": { @@ -14091,12 +14304,6 @@ "smithy.api#documentation": "

    Indicates whether the maintenance window is enabled.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#MaintenanceWindowDescription", - "traits": { - "smithy.api#documentation": "

    A description of the maintenance window.

    " - } - }, "ScheduleOffset": { "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { @@ -14110,23 +14317,17 @@ "smithy.api#documentation": "

    The ID of the maintenance window.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", - "traits": { - "smithy.api#documentation": "

    The name of the maintenance window.

    " - } - }, - "StartDate": { - "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", - "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become active.

    " - } - }, "Duration": { "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", "traits": { "smithy.api#documentation": "

    The duration of the maintenance window in hours.

    " } + }, + "Schedule": { + "target": "com.amazonaws.ssm#MaintenanceWindowSchedule", + "traits": { + "smithy.api#documentation": "

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + } } }, "traits": { @@ -14177,17 +14378,17 @@ "smithy.api#documentation": "

    Pass client-specific information to the Lambda function that you are invoking. You can then\n process the client information in your Lambda function as you choose through the context\n variable.

    " } }, - "Payload": { - "target": "com.amazonaws.ssm#MaintenanceWindowLambdaPayload", - "traits": { - "smithy.api#documentation": "

    JSON to provide to your Lambda function as input.

    " - } - }, "Qualifier": { "target": "com.amazonaws.ssm#MaintenanceWindowLambdaQualifier", "traits": { "smithy.api#documentation": "

    (Optional) Specify a Lambda function version or alias name. If you specify a function\n version, the action uses the qualified function ARN to invoke a specific Lambda function. If you\n specify an alias name, the action uses the alias ARN to invoke the Lambda function version to\n which the alias points.

    " } + }, + "Payload": { + "target": "com.amazonaws.ssm#MaintenanceWindowLambdaPayload", + "traits": { + "smithy.api#documentation": "

    JSON to provide to your Lambda function as input.

    " + } } }, "traits": { @@ -14265,6 +14466,12 @@ "smithy.api#documentation": "

    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

    " } }, + "NotificationConfig": { + "target": "com.amazonaws.ssm#NotificationConfig", + "traits": { + "smithy.api#documentation": "

    Configurations for sending notifications about command status changes on a per-instance\n basis.

    " + } + }, "ServiceRoleArn": { "target": "com.amazonaws.ssm#ServiceRole", "traits": { @@ -14277,6 +14484,12 @@ "smithy.api#documentation": "

    The name of the S3 bucket.

    " } }, + "Comment": { + "target": "com.amazonaws.ssm#Comment", + "traits": { + "smithy.api#documentation": "

    Information about the commands to run.

    " + } + }, "TimeoutSeconds": { "target": "com.amazonaws.ssm#TimeoutSeconds", "traits": { @@ -14293,16 +14506,10 @@ "smithy.api#documentation": "

    The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes\n have been deprecated.

    " } }, - "Comment": { - "target": "com.amazonaws.ssm#Comment", - "traits": { - "smithy.api#documentation": "

    Information about the commands to run.

    " - } - }, - "NotificationConfig": { - "target": "com.amazonaws.ssm#NotificationConfig", + "OutputS3KeyPrefix": { + "target": "com.amazonaws.ssm#S3KeyPrefix", "traits": { - "smithy.api#documentation": "

    Configurations for sending notifications about command status changes on a per-instance\n basis.

    " + "smithy.api#documentation": "

    The S3 bucket subfolder.

    " } }, "DocumentVersion": { @@ -14316,12 +14523,6 @@ "traits": { "smithy.api#documentation": "

    The parameters for the RUN_COMMAND task execution.

    " } - }, - "OutputS3KeyPrefix": { - "target": "com.amazonaws.ssm#S3KeyPrefix", - "traits": { - "smithy.api#documentation": "

    The S3 bucket subfolder.

    " - } } }, "traits": { @@ -14390,22 +14591,22 @@ "com.amazonaws.ssm#MaintenanceWindowTarget": { "type": "structure", "members": { - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { - "smithy.api#documentation": "

    The targets, either instances or tags.

    \n

    Specify instances using the following format:

    \n

    \n Key=instanceids,Values=,\n

    \n

    Tags are specified using the following format:

    \n

    \n Key=,Values=.

    " + "smithy.api#documentation": "

    The name for the maintenance window target.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "WindowTargetId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window to register the target with.

    " + "smithy.api#documentation": "

    The ID of the target.

    " } }, - "ResourceType": { - "target": "com.amazonaws.ssm#MaintenanceWindowResourceType", + "OwnerInformation": { + "target": "com.amazonaws.ssm#OwnerInformation", "traits": { - "smithy.api#documentation": "

    The type of target that is being registered with the maintenance window.

    " + "smithy.api#documentation": "

    A user-provided value that will be included in any CloudWatch events that are raised while\n running tasks for these targets in this maintenance window.

    " } }, "Description": { @@ -14414,22 +14615,22 @@ "smithy.api#documentation": "

    A description for the target.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The name for the maintenance window target.

    " + "smithy.api#documentation": "

    The targets, either instances or tags.

    \n

    Specify instances using the following format:

    \n

    \n Key=instanceids,Values=,\n

    \n

    Tags are specified using the following format:

    \n

    \n Key=,Values=.

    " } }, - "WindowTargetId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#documentation": "

    The ID of the target.

    " + "smithy.api#documentation": "

    The ID of the maintenance window to register the target with.

    " } }, - "OwnerInformation": { - "target": "com.amazonaws.ssm#OwnerInformation", + "ResourceType": { + "target": "com.amazonaws.ssm#MaintenanceWindowResourceType", "traits": { - "smithy.api#documentation": "

    A user-provided value that will be included in any CloudWatch events that are raised while\n running tasks for these targets in this maintenance window.

    " + "smithy.api#documentation": "

    The type of target that is being registered with the maintenance window.

    " } } }, @@ -14456,6 +14657,36 @@ "com.amazonaws.ssm#MaintenanceWindowTask": { "type": "structure", "members": { + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", + "traits": { + "smithy.api#documentation": "

    The ID of the maintenance window where the task is registered.

    " + } + }, + "WindowTaskId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", + "traits": { + "smithy.api#documentation": "

    The task ID.

    " + } + }, + "Type": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", + "traits": { + "smithy.api#documentation": "

    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or\n STEP_FUNCTIONS.

    " + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", + "traits": { + "smithy.api#documentation": "

    The maximum number of targets this task can be run for, in parallel.

    " + } + }, + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", + "traits": { + "smithy.api#documentation": "

    The maximum number of errors allowed before this task stops being scheduled.

    " + } + }, "Description": { "target": "com.amazonaws.ssm#MaintenanceWindowDescription", "traits": { @@ -14468,10 +14699,10 @@ "smithy.api#documentation": "

    Information about an S3 bucket to write task-level logs to.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "ServiceRoleArn": { + "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "

    The maximum number of errors allowed before this task stops being scheduled.

    " + "smithy.api#documentation": "

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for\n maintenance window Run Command tasks.

    " } }, "TaskArn": { @@ -14480,58 +14711,28 @@ "smithy.api#documentation": "

    The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types,\n TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name\n or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

    " } }, + "Priority": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", + "traits": { + "smithy.api#documentation": "

    The priority of the task in the maintenance window. The lower the number, the higher the\n priority. Tasks that have the same priority are scheduled in parallel.

    " + } + }, "Name": { "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { "smithy.api#documentation": "

    The task name.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", - "traits": { - "smithy.api#documentation": "

    The maximum number of targets this task can be run for, in parallel.

    " - } - }, - "WindowTaskId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", - "traits": { - "smithy.api#documentation": "

    The task ID.

    " - } - }, - "Type": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", - "traits": { - "smithy.api#documentation": "

    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or\n STEP_FUNCTIONS.

    " - } - }, - "Priority": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", - "traits": { - "smithy.api#documentation": "

    The priority of the task in the maintenance window. The lower the number, the higher the\n priority. Tasks that have the same priority are scheduled in parallel.

    " - } - }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", - "traits": { - "smithy.api#documentation": "

    The targets (either instances or tags). Instances are specified using\n Key=instanceids,Values=,. Tags are specified using\n Key=,Values=.

    " - } - }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", - "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window where the task is registered.

    " - } - }, "TaskParameters": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskParameters", "traits": { "smithy.api#documentation": "

    The parameters that should be passed to the task when it is run.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     " } }, - "ServiceRoleArn": { - "target": "com.amazonaws.ssm#ServiceRole", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for\n maintenance window Run Command tasks.

    " + "smithy.api#documentation": "

    The targets (either instances or tags). Instances are specified using\n Key=instanceids,Values=,. Tags are specified using\n Key=,Values=.

    " } } }, @@ -14561,6 +14762,12 @@ "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters": { "type": "structure", "members": { + "Lambda": { + "target": "com.amazonaws.ssm#MaintenanceWindowLambdaParameters", + "traits": { + "smithy.api#documentation": "

    The parameters for a LAMBDA task type.

    " + } + }, "Automation": { "target": "com.amazonaws.ssm#MaintenanceWindowAutomationParameters", "traits": { @@ -14578,12 +14785,6 @@ "traits": { "smithy.api#documentation": "

    The parameters for a STEP_FUNCTIONS task type.

    " } - }, - "Lambda": { - "target": "com.amazonaws.ssm#MaintenanceWindowLambdaParameters", - "traits": { - "smithy.api#documentation": "

    The parameters for a LAMBDA task type.

    " - } } }, "traits": { @@ -14873,6 +15074,12 @@ "com.amazonaws.ssm#NotificationConfig": { "type": "structure", "members": { + "NotificationEvents": { + "target": "com.amazonaws.ssm#NotificationEventList", + "traits": { + "smithy.api#documentation": "

    The different events for which you can receive notifications. These events include the\n following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about\n these events, see Monitoring Systems\n Manager status changes using Amazon SNS notifications in the\n AWS Systems Manager User Guide.

    " + } + }, "NotificationArn": { "target": "com.amazonaws.ssm#NotificationArn", "traits": { @@ -14884,12 +15091,6 @@ "traits": { "smithy.api#documentation": "

    Command: Receive notification when the status of a command changes. Invocation: For commands\n sent to multiple instances, receive notification on a per-instance basis when the status of a\n command changes.

    " } - }, - "NotificationEvents": { - "target": "com.amazonaws.ssm#NotificationEventList", - "traits": { - "smithy.api#documentation": "

    The different events for which you can receive notifications. These events include the\n following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about\n these events, see Monitoring Systems\n Manager status changes using Amazon SNS notifications in the\n AWS Systems Manager User Guide.

    " - } } }, "traits": { @@ -15000,10 +15201,10 @@ "smithy.api#documentation": "

    The data type name to use for viewing counts of OpsItems.

    " } }, - "Values": { - "target": "com.amazonaws.ssm#OpsAggregatorValueMap", + "AttributeName": { + "target": "com.amazonaws.ssm#OpsDataAttributeName", "traits": { - "smithy.api#documentation": "

    The aggregator value.

    " + "smithy.api#documentation": "

    The name of an OpsItem attribute on which to limit the count of OpsItems.

    " } }, "AggregatorType": { @@ -15018,10 +15219,10 @@ "smithy.api#documentation": "

    A nested aggregator for viewing counts of OpsItems.

    " } }, - "AttributeName": { - "target": "com.amazonaws.ssm#OpsDataAttributeName", + "Values": { + "target": "com.amazonaws.ssm#OpsAggregatorValueMap", "traits": { - "smithy.api#documentation": "

    The name of an OpsItem attribute on which to limit the count of OpsItems.

    " + "smithy.api#documentation": "

    The aggregator value.

    " } }, "Filters": { @@ -15094,7 +15295,13 @@ } }, "com.amazonaws.ssm#OpsDataAttributeName": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } }, "com.amazonaws.ssm#OpsDataTypeName": { "type": "string", @@ -15206,6 +15413,13 @@ "com.amazonaws.ssm#OpsFilter": { "type": "structure", "members": { + "Values": { + "target": "com.amazonaws.ssm#OpsFilterValueList", + "traits": { + "smithy.api#documentation": "

    The filter value.

    ", + "smithy.api#required": {} + } + }, "Type": { "target": "com.amazonaws.ssm#OpsFilterOperatorType", "traits": { @@ -15218,13 +15432,6 @@ "smithy.api#documentation": "

    The name of the filter.

    ", "smithy.api#required": {} } - }, - "Values": { - "target": "com.amazonaws.ssm#OpsFilterValueList", - "traits": { - "smithy.api#documentation": "

    The filter value.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -15287,7 +15494,13 @@ } }, "com.amazonaws.ssm#OpsFilterValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, "com.amazonaws.ssm#OpsFilterValueList": { "type": "list", @@ -15307,28 +15520,22 @@ "com.amazonaws.ssm#OpsItem": { "type": "structure", "members": { - "RelatedOpsItems": { - "target": "com.amazonaws.ssm#RelatedOpsItems", - "traits": { - "smithy.api#documentation": "

    One or more OpsItems that share something in common with the current OpsItem. For example,\n related OpsItems can include OpsItems with similar error messages, impacted resources, or\n statuses for the impacted resource.

    " - } - }, - "Notifications": { - "target": "com.amazonaws.ssm#OpsItemNotifications", + "Severity": { + "target": "com.amazonaws.ssm#OpsItemSeverity", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this\n OpsItem is edited or changed.

    " + "smithy.api#documentation": "

    The severity of the OpsItem. Severity options range from 1 to 4.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.ssm#DateTime", + "Source": { + "target": "com.amazonaws.ssm#OpsItemSource", "traits": { - "smithy.api#documentation": "

    The date and time the OpsItem was last updated.

    " + "smithy.api#documentation": "

    The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of\n source.

    " } }, - "LastModifiedBy": { - "target": "com.amazonaws.ssm#String", + "Priority": { + "target": "com.amazonaws.ssm#OpsItemPriority", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS account that last updated the OpsItem.

    " + "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " } }, "Status": { @@ -15337,10 +15544,10 @@ "smithy.api#documentation": "

    The OpsItem status. Status can be Open, In Progress, or\n Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.ssm#DateTime", + "OperationalData": { + "target": "com.amazonaws.ssm#OpsItemOperationalData", "traits": { - "smithy.api#documentation": "

    The date and time the OpsItem was created.

    " + "smithy.api#documentation": "

    Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

    \n \n

    Operational data keys can't begin with the following: amazon, aws,\n amzn, ssm, /amazon, /aws, /amzn, /ssm.

    \n     \n

    You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API action) can view and search on the\n specified data. Operational data that is not searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API action).

    \n\n

    Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see\n Creating OpsItems manually in the AWS Systems Manager User Guide.

    " } }, "Version": { @@ -15349,10 +15556,10 @@ "smithy.api#documentation": "

    The version of this OpsItem. Each time the OpsItem is edited the version number increments\n by one.

    " } }, - "Priority": { - "target": "com.amazonaws.ssm#OpsItemPriority", + "LastModifiedBy": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + "smithy.api#documentation": "

    The ARN of the AWS account that last updated the OpsItem.

    " } }, "Title": { @@ -15361,34 +15568,28 @@ "smithy.api#documentation": "

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " } }, - "Source": { - "target": "com.amazonaws.ssm#OpsItemSource", - "traits": { - "smithy.api#documentation": "

    The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of\n source.

    " - } - }, - "Severity": { - "target": "com.amazonaws.ssm#OpsItemSeverity", + "CreatedTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The severity of the OpsItem. Severity options range from 1 to 4.

    " + "smithy.api#documentation": "

    The date and time the OpsItem was created.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.ssm#String", + "RelatedOpsItems": { + "target": "com.amazonaws.ssm#RelatedOpsItems", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS account that created the OpsItem.

    " + "smithy.api#documentation": "

    One or more OpsItems that share something in common with the current OpsItem. For example,\n related OpsItems can include OpsItems with similar error messages, impacted resources, or\n statuses for the impacted resource.

    " } }, - "OperationalData": { - "target": "com.amazonaws.ssm#OpsItemOperationalData", + "Notifications": { + "target": "com.amazonaws.ssm#OpsItemNotifications", "traits": { - "smithy.api#documentation": "

    Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

    \n \n

    Operational data keys can't begin with the following: amazon, aws,\n amzn, ssm, /amazon, /aws, /amzn, /ssm.

    \n     \n

    You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API action) can view and search on the\n specified data. Operational data that is not searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API action).

    \n\n

    Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see\n Creating OpsItems manually in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this\n OpsItem is edited or changed.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#OpsItemDescription", + "LastModifiedTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The OpsItem description.

    " + "smithy.api#documentation": "

    The date and time the OpsItem was last updated.

    " } }, "OpsItemId": { @@ -15397,11 +15598,23 @@ "smithy.api#documentation": "

    The ID of the OpsItem.

    " } }, + "Description": { + "target": "com.amazonaws.ssm#OpsItemDescription", + "traits": { + "smithy.api#documentation": "

    The OpsItem description.

    " + } + }, "Category": { "target": "com.amazonaws.ssm#OpsItemCategory", "traits": { "smithy.api#documentation": "

    An OpsItem category. Category options include: Availability, Cost, Performance, Recovery,\n Security.

    " } + }, + "CreatedBy": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

    The ARN of the AWS account that created the OpsItem.

    " + } } }, "traits": { @@ -15459,17 +15672,17 @@ "com.amazonaws.ssm#OpsItemDataValue": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.ssm#OpsItemDataValueString", - "traits": { - "smithy.api#documentation": "

    The value of the OperationalData key.

    " - } - }, "Type": { "target": "com.amazonaws.ssm#OpsItemDataType", "traits": { "smithy.api#documentation": "

    The type of key-value pair. Valid types include SearchableString and\n String.

    " } + }, + "Value": { + "target": "com.amazonaws.ssm#OpsItemDataValueString", + "traits": { + "smithy.api#documentation": "

    The value of the OperationalData key.

    " + } } }, "traits": { @@ -15491,6 +15704,13 @@ "com.amazonaws.ssm#OpsItemFilter": { "type": "structure", "members": { + "Operator": { + "target": "com.amazonaws.ssm#OpsItemFilterOperator", + "traits": { + "smithy.api#documentation": "

    The operator used by the filter call.

    ", + "smithy.api#required": {} + } + }, "Key": { "target": "com.amazonaws.ssm#OpsItemFilterKey", "traits": { @@ -15504,13 +15724,6 @@ "smithy.api#documentation": "

    The filter value.

    ", "smithy.api#required": {} } - }, - "Operator": { - "target": "com.amazonaws.ssm#OpsItemFilterOperator", - "traits": { - "smithy.api#documentation": "

    The operator used by the filter call.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -15631,11 +15844,11 @@ "com.amazonaws.ssm#OpsItemInvalidParameterException": { "type": "structure", "members": { - "ParameterNames": { - "target": "com.amazonaws.ssm#OpsItemParameterNamesList" - }, "Message": { "target": "com.amazonaws.ssm#String" + }, + "ParameterNames": { + "target": "com.amazonaws.ssm#OpsItemParameterNamesList" } }, "traits": { @@ -15646,17 +15859,17 @@ "com.amazonaws.ssm#OpsItemLimitExceededException": { "type": "structure", "members": { + "LimitType": { + "target": "com.amazonaws.ssm#String" + }, "Limit": { "target": "com.amazonaws.ssm#Integer" }, - "ResourceTypes": { - "target": "com.amazonaws.ssm#OpsItemParameterNamesList" - }, "Message": { "target": "com.amazonaws.ssm#String" }, - "LimitType": { - "target": "com.amazonaws.ssm#String" + "ResourceTypes": { + "target": "com.amazonaws.ssm#OpsItemParameterNamesList" } }, "traits": { @@ -15783,10 +15996,10 @@ "com.amazonaws.ssm#OpsItemSummary": { "type": "structure", "members": { - "Title": { - "target": "com.amazonaws.ssm#OpsItemTitle", + "OperationalData": { + "target": "com.amazonaws.ssm#OpsItemOperationalData", "traits": { - "smithy.api#documentation": "

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " + "smithy.api#documentation": "

    Operational data is custom data that provides useful reference details about the OpsItem.\n

    " } }, "LastModifiedTime": { @@ -15795,16 +16008,10 @@ "smithy.api#documentation": "

    The date and time the OpsItem was last updated.

    " } }, - "OperationalData": { - "target": "com.amazonaws.ssm#OpsItemOperationalData", - "traits": { - "smithy.api#documentation": "

    Operational data is custom data that provides useful reference details about the OpsItem.\n

    " - } - }, - "Source": { - "target": "com.amazonaws.ssm#OpsItemSource", + "Title": { + "target": "com.amazonaws.ssm#OpsItemTitle", "traits": { - "smithy.api#documentation": "

    The impacted AWS resource.

    " + "smithy.api#documentation": "

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " } }, "Severity": { @@ -15813,10 +16020,10 @@ "smithy.api#documentation": "

    A list of OpsItems by severity.

    " } }, - "OpsItemId": { - "target": "com.amazonaws.ssm#OpsItemId", + "Priority": { + "target": "com.amazonaws.ssm#OpsItemPriority", "traits": { - "smithy.api#documentation": "

    The ID of the OpsItem.

    " + "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " } }, "Status": { @@ -15825,10 +16032,16 @@ "smithy.api#documentation": "

    The OpsItem status. Status can be Open, In Progress, or\n Resolved.

    " } }, - "Priority": { - "target": "com.amazonaws.ssm#OpsItemPriority", + "OpsItemId": { + "target": "com.amazonaws.ssm#OpsItemId", "traits": { - "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + "smithy.api#documentation": "

    The ID of the OpsItem.

    " + } + }, + "CreatedTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time the OpsItem was created.

    " } }, "Category": { @@ -15837,22 +16050,22 @@ "smithy.api#documentation": "

    A list of OpsItems by category.

    " } }, - "LastModifiedBy": { + "CreatedBy": { "target": "com.amazonaws.ssm#String", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

    " } }, - "CreatedTime": { - "target": "com.amazonaws.ssm#DateTime", + "LastModifiedBy": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The date and time the OpsItem was created.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

    " } }, - "CreatedBy": { - "target": "com.amazonaws.ssm#String", + "Source": { + "target": "com.amazonaws.ssm#OpsItemSource", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

    " + "smithy.api#documentation": "

    The impacted AWS resource.

    " } } }, @@ -15967,16 +16180,22 @@ "com.amazonaws.ssm#Parameter": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.ssm#PSParameterValue", + "Type": { + "target": "com.amazonaws.ssm#ParameterType", "traits": { - "smithy.api#documentation": "

    The parameter value.

    " + "smithy.api#documentation": "

    The type of parameter. Valid values include the following: String,\n StringList, and SecureString.

    " } }, - "Version": { - "target": "com.amazonaws.ssm#PSParameterVersion", + "Name": { + "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The parameter version.

    " + "smithy.api#documentation": "

    The name of the parameter.

    " + } + }, + "Value": { + "target": "com.amazonaws.ssm#PSParameterValue", + "traits": { + "smithy.api#documentation": "

    The parameter value.

    " } }, "LastModifiedDate": { @@ -15985,16 +16204,16 @@ "smithy.api#documentation": "

    Date the parameter was last changed or updated and the parameter version was created.

    " } }, - "ARN": { - "target": "com.amazonaws.ssm#String", + "Version": { + "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the parameter.

    " + "smithy.api#documentation": "

    The parameter version.

    " } }, - "Type": { - "target": "com.amazonaws.ssm#ParameterType", + "ARN": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The type of parameter. Valid values include the following: String,\n StringList, and SecureString.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the parameter.

    " } }, "Selector": { @@ -16014,12 +16233,6 @@ "traits": { "smithy.api#documentation": "

    The data type of the parameter, such as text or aws:ec2:image. The\n default is text.

    " } - }, - "Name": { - "target": "com.amazonaws.ssm#PSParameterName", - "traits": { - "smithy.api#documentation": "

    The name of the parameter.

    " - } } }, "traits": { @@ -16059,22 +16272,10 @@ "com.amazonaws.ssm#ParameterHistory": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ssm#ParameterDescription", - "traits": { - "smithy.api#documentation": "

    Information about the parameter.

    " - } - }, - "Tier": { - "target": "com.amazonaws.ssm#ParameterTier", - "traits": { - "smithy.api#documentation": "

    The parameter tier.

    " - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.ssm#DateTime", + "KeyId": { + "target": "com.amazonaws.ssm#ParameterKeyId", "traits": { - "smithy.api#documentation": "

    Date the parameter was last changed or updated.

    " + "smithy.api#documentation": "

    The ID of the query key used for this parameter.

    " } }, "Name": { @@ -16083,28 +16284,40 @@ "smithy.api#documentation": "

    The name of the parameter.

    " } }, + "Value": { + "target": "com.amazonaws.ssm#PSParameterValue", + "traits": { + "smithy.api#documentation": "

    The parameter value.

    " + } + }, "Labels": { "target": "com.amazonaws.ssm#ParameterLabelList", "traits": { "smithy.api#documentation": "

    Labels assigned to the parameter version.

    " } }, - "KeyId": { - "target": "com.amazonaws.ssm#ParameterKeyId", + "Description": { + "target": "com.amazonaws.ssm#ParameterDescription", "traits": { - "smithy.api#documentation": "

    The ID of the query key used for this parameter.

    " + "smithy.api#documentation": "

    Information about the parameter.

    " } }, - "Value": { - "target": "com.amazonaws.ssm#PSParameterValue", + "Policies": { + "target": "com.amazonaws.ssm#ParameterPolicyList", "traits": { - "smithy.api#documentation": "

    The parameter value.

    " + "smithy.api#documentation": "

    Information about the policies assigned to a parameter.

    \n

    \n Assigning parameter\n policies in the AWS Systems Manager User Guide.

    " } }, - "DataType": { - "target": "com.amazonaws.ssm#ParameterDataType", + "Tier": { + "target": "com.amazonaws.ssm#ParameterTier", "traits": { - "smithy.api#documentation": "

    The data type of the parameter, such as text or aws:ec2:image. The\n default is text.

    " + "smithy.api#documentation": "

    The parameter tier.

    " + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    Date the parameter was last changed or updated.

    " } }, "LastModifiedUser": { @@ -16113,28 +16326,28 @@ "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

    " } }, - "Version": { - "target": "com.amazonaws.ssm#PSParameterVersion", + "Type": { + "target": "com.amazonaws.ssm#ParameterType", "traits": { - "smithy.api#documentation": "

    The parameter version.

    " + "smithy.api#documentation": "

    The type of parameter used.

    " } }, - "AllowedPattern": { - "target": "com.amazonaws.ssm#AllowedPattern", + "DataType": { + "target": "com.amazonaws.ssm#ParameterDataType", "traits": { - "smithy.api#documentation": "

    Parameter names can include the following letters and symbols.

    \n

    a-zA-Z0-9_.-

    " + "smithy.api#documentation": "

    The data type of the parameter, such as text or aws:ec2:image. The\n default is text.

    " } }, - "Policies": { - "target": "com.amazonaws.ssm#ParameterPolicyList", + "AllowedPattern": { + "target": "com.amazonaws.ssm#AllowedPattern", "traits": { - "smithy.api#documentation": "

    Information about the policies assigned to a parameter.

    \n

    \n Assigning parameter\n policies in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    Parameter names can include the following letters and symbols.

    \n

    a-zA-Z0-9_.-

    " } }, - "Type": { - "target": "com.amazonaws.ssm#ParameterType", + "Version": { + "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { - "smithy.api#documentation": "

    The type of parameter used.

    " + "smithy.api#documentation": "

    The parameter version.

    " } } }, @@ -16238,22 +16451,16 @@ "com.amazonaws.ssm#ParameterMetadata": { "type": "structure", "members": { - "Policies": { - "target": "com.amazonaws.ssm#ParameterPolicyList", - "traits": { - "smithy.api#documentation": "

    A list of policies associated with a parameter.

    " - } - }, "Description": { "target": "com.amazonaws.ssm#ParameterDescription", "traits": { "smithy.api#documentation": "

    Description of the parameter actions.

    " } }, - "AllowedPattern": { - "target": "com.amazonaws.ssm#AllowedPattern", + "Policies": { + "target": "com.amazonaws.ssm#ParameterPolicyList", "traits": { - "smithy.api#documentation": "

    A parameter name can include only the following letters and symbols.

    \n

    a-zA-Z0-9_.-

    " + "smithy.api#documentation": "

    A list of policies associated with a parameter.

    " } }, "Type": { @@ -16262,16 +16469,16 @@ "smithy.api#documentation": "

    The type of parameter. Valid parameter types include the following: String,\n StringList, and SecureString.

    " } }, - "DataType": { - "target": "com.amazonaws.ssm#ParameterDataType", + "Version": { + "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { - "smithy.api#documentation": "

    The data type of the parameter, such as text or aws:ec2:image. The\n default is text.

    " + "smithy.api#documentation": "

    The parameter version.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#PSParameterName", + "AllowedPattern": { + "target": "com.amazonaws.ssm#AllowedPattern", "traits": { - "smithy.api#documentation": "

    The parameter name.

    " + "smithy.api#documentation": "

    A parameter name can include only the following letters and symbols.

    \n

    a-zA-Z0-9_.-

    " } }, "LastModifiedUser": { @@ -16280,16 +16487,16 @@ "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

    " } }, - "Tier": { - "target": "com.amazonaws.ssm#ParameterTier", + "DataType": { + "target": "com.amazonaws.ssm#ParameterDataType", "traits": { - "smithy.api#documentation": "

    The parameter tier.

    " + "smithy.api#documentation": "

    The data type of the parameter, such as text or aws:ec2:image. The\n default is text.

    " } }, - "Version": { - "target": "com.amazonaws.ssm#PSParameterVersion", + "Name": { + "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    The parameter version.

    " + "smithy.api#documentation": "

    The parameter name.

    " } }, "KeyId": { @@ -16298,6 +16505,12 @@ "smithy.api#documentation": "

    The ID of the query key used for this parameter.

    " } }, + "Tier": { + "target": "com.amazonaws.ssm#ParameterTier", + "traits": { + "smithy.api#documentation": "

    The parameter tier.

    " + } + }, "LastModifiedDate": { "target": "com.amazonaws.ssm#DateTime", "traits": { @@ -16375,28 +16588,28 @@ "com.amazonaws.ssm#ParameterStringFilter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.ssm#ParameterStringFilterValueList", - "traits": { - "smithy.api#documentation": "

    The value you want to search for.

    " - } - }, "Key": { "target": "com.amazonaws.ssm#ParameterStringFilterKey", "traits": { - "smithy.api#documentation": "

    The name of the filter.

    ", + "smithy.api#documentation": "

    The name of the filter.

    \n \n

    The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API actions. However,\n not all of the pattern values listed for Key can be used with both actions.

    \n

    For DescribeActions, all of the listed patterns are valid, with the exception\n of Label.

    \n

    For GetParametersByPath, the following patterns listed for Key\n are not valid: tag, Name, Path, and\n Tier.

    \n

    For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for\n Systems Manager parameters in the AWS Systems Manager User Guide.

    \n     ", "smithy.api#required": {} } }, "Option": { "target": "com.amazonaws.ssm#ParameterStringQueryOption", "traits": { - "smithy.api#documentation": "

    For all filters used with DescribeParameters, valid options include\n Equals and BeginsWith. The Name filter additionally\n supports the Contains option. (Exception: For filters using the key\n Path, valid options include Recursive and\n OneLevel.)

    \n

    For filters used with GetParametersByPath, valid options include\n Equals and BeginsWith. (Exception: For filters using the key\n Label, the only valid option is Equals.)

    " + "smithy.api#documentation": "

    For all filters used with DescribeParameters, valid options include\n Equals and BeginsWith. The Name filter additionally\n supports the Contains option. (Exception: For filters using the key\n Path, valid options include Recursive and\n OneLevel.)

    \n

    For filters used with GetParametersByPath, valid options include\n Equals and BeginsWith. (Exception: For filters using\n Label as the Key name, the only valid option is Equals.)

    " + } + }, + "Values": { + "target": "com.amazonaws.ssm#ParameterStringFilterValueList", + "traits": { + "smithy.api#documentation": "

    The value you want to search for.

    " } } }, "traits": { - "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    \n \n

    The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API actions. However,\n not all of the pattern values listed for Key can be used with both actions.

    \n

    For DescribeActions, all of the listed patterns are valid, with the exception\n of Label.

    \n

    For GetParametersByPath, the following patterns listed for Key\n are not valid: Name, Path, and Tier.

    \n

    For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for\n Systems Manager parameters in the AWS Systems Manager User Guide.

    \n     " + "smithy.api#documentation": "

    One or more filters. Use a filter to return a more specific list of results.

    " } }, "com.amazonaws.ssm#ParameterStringFilterKey": { @@ -16596,108 +16809,180 @@ "com.amazonaws.ssm#Patch": { "type": "structure", "members": { - "ContentUrl": { - "target": "com.amazonaws.ssm#PatchContentUrl", + "Release": { + "target": "com.amazonaws.ssm#PatchRelease", "traits": { - "smithy.api#documentation": "

    The URL where more information can be obtained about the patch.

    " + "smithy.api#documentation": "

    The particular release of a patch. For example,\n in pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1.\n Applies to Linux-based instances only.

    " } }, - "ProductFamily": { - "target": "com.amazonaws.ssm#PatchProductFamily", + "Version": { + "target": "com.amazonaws.ssm#PatchVersion", "traits": { - "smithy.api#documentation": "

    The product family the patch is applicable for (for example, Windows).

    " + "smithy.api#documentation": "

    The version number of the patch. For example, in\n example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by\n -1. Applies to Linux-based instances only.

    " } }, - "MsrcNumber": { - "target": "com.amazonaws.ssm#PatchMsrcNumber", + "Language": { + "target": "com.amazonaws.ssm#PatchLanguage", "traits": { - "smithy.api#documentation": "

    The ID of the MSRC bulletin the patch is related to.

    " + "smithy.api#documentation": "

    The language of the patch if it's language-specific.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#PatchDescription", + "Repository": { + "target": "com.amazonaws.ssm#PatchRepository", "traits": { - "smithy.api#documentation": "

    The description of the patch.

    " + "smithy.api#documentation": "

    The source patch repository for the operating\n system and version, such as trusty-security for Ubuntu Server 14.04 LTE and\n focal-security for Ubuntu Server 20.04 LTE. Applies to Linux-based instances\n only.

    " } }, - "Vendor": { - "target": "com.amazonaws.ssm#PatchVendor", + "Arch": { + "target": "com.amazonaws.ssm#PatchArch", "traits": { - "smithy.api#documentation": "

    The name of the vendor providing the patch.

    " + "smithy.api#documentation": "

    The architecture of the patch. For example, in\n example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by\n x86_64. Applies to Linux-based instances only.

    " } }, - "ReleaseDate": { - "target": "com.amazonaws.ssm#DateTime", + "MsrcSeverity": { + "target": "com.amazonaws.ssm#PatchMsrcSeverity", "traits": { - "smithy.api#documentation": "

    The date the patch was released.

    " + "smithy.api#documentation": "

    The severity of the patch, such as Critical, Important, or\n Moderate. Applies to Windows patches only.

    " + } + }, + "Severity": { + "target": "com.amazonaws.ssm#PatchSeverity", + "traits": { + "smithy.api#documentation": "

    The severity level of the patch. For example,\n CRITICAL or MODERATE.

    " } }, "KbNumber": { "target": "com.amazonaws.ssm#PatchKbNumber", "traits": { - "smithy.api#documentation": "

    The Microsoft Knowledge Base ID of the patch.

    " + "smithy.api#documentation": "

    The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.

    " } }, "Product": { "target": "com.amazonaws.ssm#PatchProduct", "traits": { - "smithy.api#documentation": "

    The specific product the patch is applicable for (for example, WindowsServer2016).

    " + "smithy.api#documentation": "

    The specific product the patch is applicable for. For example,\n WindowsServer2016 or AmazonLinux2018.03.

    " } }, - "Id": { - "target": "com.amazonaws.ssm#PatchId", + "CVEIds": { + "target": "com.amazonaws.ssm#PatchCVEIdList", "traits": { - "smithy.api#documentation": "

    The ID of the patch (this is different than the Microsoft Knowledge Base ID).

    " + "smithy.api#documentation": "

    The Common Vulnerabilities and Exposures (CVE) ID\n of the patch. For example, CVE-1999-0067. Applies to Linux-based instances\n only.

    " } }, "Classification": { "target": "com.amazonaws.ssm#PatchClassification", "traits": { - "smithy.api#documentation": "

    The classification of the patch (for example, SecurityUpdates, Updates,\n CriticalUpdates).

    " + "smithy.api#documentation": "

    The classification of the patch. For example, SecurityUpdates,\n Updates, or CriticalUpdates.

    " } }, - "Title": { - "target": "com.amazonaws.ssm#PatchTitle", + "Id": { + "target": "com.amazonaws.ssm#PatchId", "traits": { - "smithy.api#documentation": "

    The title of the patch.

    " + "smithy.api#documentation": "

    The ID of the patch. Applies to Windows patches only.

    \n \n

    This ID is not the same as the Microsoft Knowledge Base ID.

    \n     " } }, - "MsrcSeverity": { - "target": "com.amazonaws.ssm#PatchMsrcSeverity", + "AdvisoryIds": { + "target": "com.amazonaws.ssm#PatchAdvisoryIdList", "traits": { - "smithy.api#documentation": "

    The severity of the patch (for example Critical, Important, Moderate).

    " + "smithy.api#documentation": "

    The Advisory ID of the patch. For example,\n RHSA-2020:3779. Applies to Linux-based instances only.

    " } }, - "Language": { - "target": "com.amazonaws.ssm#PatchLanguage", + "Description": { + "target": "com.amazonaws.ssm#PatchDescription", "traits": { - "smithy.api#documentation": "

    The language of the patch if it's language-specific.

    " + "smithy.api#documentation": "

    The description of the patch.

    " } - } - }, - "traits": { - "smithy.api#documentation": "

    Represents metadata about a patch.

    " - } - }, - "com.amazonaws.ssm#PatchAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALLOW_AS_DEPENDENCY", - "name": "AllowAsDependency" - }, - { - "value": "BLOCK", - "name": "Block" + }, + "MsrcNumber": { + "target": "com.amazonaws.ssm#PatchMsrcNumber", + "traits": { + "smithy.api#documentation": "

    The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to.\n For example, MS14-045. Applies to Windows patches only.

    " } - ] - } - }, - "com.amazonaws.ssm#PatchBaselineIdentity": { - "type": "structure", - "members": { - "BaselineName": { + }, + "ContentUrl": { + "target": "com.amazonaws.ssm#PatchContentUrl", + "traits": { + "smithy.api#documentation": "

    The URL where more information can be obtained about the patch.

    " + } + }, + "ProductFamily": { + "target": "com.amazonaws.ssm#PatchProductFamily", + "traits": { + "smithy.api#documentation": "

    The product family the patch is applicable for. For example, Windows or\n Amazon Linux 2.

    " + } + }, + "ReleaseDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    The date the patch was released.

    " + } + }, + "BugzillaIds": { + "target": "com.amazonaws.ssm#PatchBugzillaIdList", + "traits": { + "smithy.api#documentation": "

    The Bugzilla ID of the patch. For example,\n 1600646. Applies to Linux-based instances only.

    " + } + }, + "Title": { + "target": "com.amazonaws.ssm#PatchTitle", + "traits": { + "smithy.api#documentation": "

    The title of the patch.

    " + } + }, + "Name": { + "target": "com.amazonaws.ssm#PatchName", + "traits": { + "smithy.api#documentation": "

    The name of the patch. Applies to Linux-based\n instances only.

    " + } + }, + "Epoch": { + "target": "com.amazonaws.ssm#PatchEpoch", + "traits": { + "smithy.api#documentation": "

    The epoch of the patch. For example in\n pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is\n 20180914-2. Applies to Linux-based instances only.

    " + } + }, + "Vendor": { + "target": "com.amazonaws.ssm#PatchVendor", + "traits": { + "smithy.api#documentation": "

    The name of the vendor providing the patch.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents metadata about a patch.

    " + } + }, + "com.amazonaws.ssm#PatchAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW_AS_DEPENDENCY", + "name": "AllowAsDependency" + }, + { + "value": "BLOCK", + "name": "Block" + } + ] + } + }, + "com.amazonaws.ssm#PatchAdvisoryId": { + "type": "string" + }, + "com.amazonaws.ssm#PatchAdvisoryIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#PatchAdvisoryId" + } + }, + "com.amazonaws.ssm#PatchArch": { + "type": "string" + }, + "com.amazonaws.ssm#PatchBaselineIdentity": { + "type": "structure", + "members": { + "BaselineName": { "target": "com.amazonaws.ssm#BaselineName", "traits": { "smithy.api#documentation": "

    The name of the patch baseline.

    " @@ -16709,10 +16994,10 @@ "smithy.api#documentation": "

    Whether this is the default baseline. Note that Systems Manager supports creating multiple default\n patch baselines. For example, you can create a default patch baseline for each operating\n system.

    " } }, - "BaselineDescription": { - "target": "com.amazonaws.ssm#BaselineDescription", + "OperatingSystem": { + "target": "com.amazonaws.ssm#OperatingSystem", "traits": { - "smithy.api#documentation": "

    The description of the patch baseline.

    " + "smithy.api#documentation": "

    Defines the operating system the patch baseline applies to. The Default value is WINDOWS.\n

    " } }, "BaselineId": { @@ -16721,10 +17006,10 @@ "smithy.api#documentation": "

    The ID of the patch baseline.

    " } }, - "OperatingSystem": { - "target": "com.amazonaws.ssm#OperatingSystem", + "BaselineDescription": { + "target": "com.amazonaws.ssm#BaselineDescription", "traits": { - "smithy.api#documentation": "

    Defines the operating system the patch baseline applies to. The Default value is WINDOWS.\n

    " + "smithy.api#documentation": "

    The description of the patch baseline.

    " } } }, @@ -16747,6 +17032,24 @@ } } }, + "com.amazonaws.ssm#PatchBugzillaId": { + "type": "string" + }, + "com.amazonaws.ssm#PatchBugzillaIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#PatchBugzillaId" + } + }, + "com.amazonaws.ssm#PatchCVEId": { + "type": "string" + }, + "com.amazonaws.ssm#PatchCVEIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#PatchCVEId" + } + }, "com.amazonaws.ssm#PatchClassification": { "type": "string" }, @@ -16760,38 +17063,38 @@ "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.ssm#PatchComplianceDataState", + "Severity": { + "target": "com.amazonaws.ssm#PatchSeverity", "traits": { - "smithy.api#documentation": "

    The state of the patch on the instance, such as INSTALLED or FAILED.

    \n

    For descriptions of each patch state, see About patch compliance in the AWS Systems Manager User Guide.

    ", + "smithy.api#documentation": "

    The severity of the patch (for example, Critical, Important, Moderate).

    ", "smithy.api#required": {} } }, - "InstalledTime": { - "target": "com.amazonaws.ssm#DateTime", + "KBId": { + "target": "com.amazonaws.ssm#PatchKbNumber", "traits": { - "smithy.api#documentation": "

    The date/time the patch was installed on the instance. Note that not all operating systems\n provide this level of information.

    ", + "smithy.api#documentation": "

    The operating system-specific ID of the patch.

    ", "smithy.api#required": {} } }, - "Classification": { - "target": "com.amazonaws.ssm#PatchClassification", + "InstalledTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The classification of the patch (for example, SecurityUpdates, Updates,\n CriticalUpdates).

    ", + "smithy.api#documentation": "

    The date/time the patch was installed on the instance. Note that not all operating systems\n provide this level of information.

    ", "smithy.api#required": {} } }, - "KBId": { - "target": "com.amazonaws.ssm#PatchKbNumber", + "State": { + "target": "com.amazonaws.ssm#PatchComplianceDataState", "traits": { - "smithy.api#documentation": "

    The operating system-specific ID of the patch.

    ", + "smithy.api#documentation": "

    The state of the patch on the instance, such as INSTALLED or FAILED.

    \n

    For descriptions of each patch state, see About patch compliance in the AWS Systems Manager User Guide.

    ", "smithy.api#required": {} } }, - "Severity": { - "target": "com.amazonaws.ssm#PatchSeverity", + "Classification": { + "target": "com.amazonaws.ssm#PatchClassification", "traits": { - "smithy.api#documentation": "

    The severity of the patch (for example, Critical, Important, Moderate).

    ", + "smithy.api#documentation": "

    The classification of the patch (for example, SecurityUpdates, Updates,\n CriticalUpdates).

    ", "smithy.api#required": {} } } @@ -16910,23 +17213,26 @@ "com.amazonaws.ssm#PatchDescription": { "type": "string" }, + "com.amazonaws.ssm#PatchEpoch": { + "type": "integer" + }, "com.amazonaws.ssm#PatchFailedCount": { "type": "integer" }, "com.amazonaws.ssm#PatchFilter": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.ssm#PatchFilterKey", + "Values": { + "target": "com.amazonaws.ssm#PatchFilterValueList", "traits": { - "smithy.api#documentation": "

    The key for the filter.

    \n

    Run the DescribePatchProperties command to view lists of valid keys for\n each operating system type.

    ", + "smithy.api#documentation": "

    The value for the filter key.

    \n

    Run the DescribePatchProperties command to view lists of valid values for\n each key based on operating system type.

    ", "smithy.api#required": {} } }, - "Values": { - "target": "com.amazonaws.ssm#PatchFilterValueList", + "Key": { + "target": "com.amazonaws.ssm#PatchFilterKey", "traits": { - "smithy.api#documentation": "

    The value for the filter key.

    \n

    Run the DescribePatchProperties command to view lists of valid values for\n each key based on operating system type.

    ", + "smithy.api#documentation": "

    The key for the filter.

    \n

    Run the DescribePatchProperties command to view lists of valid keys for\n each operating system type.

    ", "smithy.api#required": {} } } @@ -16954,6 +17260,18 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "ARCH", + "name": "Arch" + }, + { + "value": "ADVISORY_ID", + "name": "AdvisoryId" + }, + { + "value": "BUGZILLA_ID", + "name": "BugzillaId" + }, { "value": "PATCH_SET", "name": "PatchSet" @@ -16970,10 +17288,22 @@ "value": "CLASSIFICATION", "name": "Classification" }, + { + "value": "CVE_ID", + "name": "CVEId" + }, + { + "value": "EPOCH", + "name": "Epoch" + }, { "value": "MSRC_SEVERITY", "name": "MsrcSeverity" }, + { + "value": "NAME", + "name": "Name" + }, { "value": "PATCH_ID", "name": "PatchId" @@ -16986,9 +17316,25 @@ "value": "PRIORITY", "name": "Priority" }, + { + "value": "REPOSITORY", + "name": "Repository" + }, + { + "value": "RELEASE", + "name": "Release" + }, { "value": "SEVERITY", "name": "Severity" + }, + { + "value": "SECURITY", + "name": "Security" + }, + { + "value": "VERSION", + "name": "Version" } ] } @@ -17122,6 +17468,9 @@ "com.amazonaws.ssm#PatchMsrcSeverity": { "type": "string" }, + "com.amazonaws.ssm#PatchName": { + "type": "string" + }, "com.amazonaws.ssm#PatchNotApplicableCount": { "type": "integer" }, @@ -17248,9 +17597,21 @@ "target": "com.amazonaws.ssm#AttributeValue" } }, + "com.amazonaws.ssm#PatchRelease": { + "type": "string" + }, + "com.amazonaws.ssm#PatchRepository": { + "type": "string" + }, "com.amazonaws.ssm#PatchRule": { "type": "structure", "members": { + "ApproveUntilDate": { + "target": "com.amazonaws.ssm#PatchStringDateTime", + "traits": { + "smithy.api#documentation": "

    The cutoff date for auto approval of released patches. Any patches released on or before\n this date are installed automatically. Not supported on Ubuntu Server.

    \n

    Enter dates in the format YYYY-MM-DD. For example,\n 2020-12-31.

    " + } + }, "EnableNonSecurity": { "target": "com.amazonaws.ssm#Boolean", "traits": { @@ -17272,12 +17633,6 @@ "smithy.api#documentation": "

    The number of days after the release date of each patch matched by the rule that the patch\n is marked as approved in the patch baseline. For example, a value of 7 means that\n patches are approved seven days after they are released. Not supported on Ubuntu Server.

    " } }, - "ApproveUntilDate": { - "target": "com.amazonaws.ssm#PatchStringDateTime", - "traits": { - "smithy.api#documentation": "

    The cutoff date for auto approval of released patches. Any patches released on or before\n this date are installed automatically. Not supported on Ubuntu Server.

    \n

    Enter dates in the format YYYY-MM-DD. For example,\n 2020-12-31.

    " - } - }, "ComplianceLevel": { "target": "com.amazonaws.ssm#PatchComplianceLevel", "traits": { @@ -17344,17 +17699,17 @@ "smithy.api#required": {} } }, - "Products": { - "target": "com.amazonaws.ssm#PatchSourceProductList", + "Configuration": { + "target": "com.amazonaws.ssm#PatchSourceConfiguration", "traits": { - "smithy.api#documentation": "

    The specific operating system versions a patch repository applies to, such as \"Ubuntu16.04\",\n \"AmazonLinux2016.09\", \"RedhatEnterpriseLinux7.2\" or \"Suse12.7\". For lists of supported product\n values, see PatchFilter.

    ", + "smithy.api#documentation": "

    The value of the yum repo configuration. For example:

    \n

    \n [main]\n

    \n

    \n cachedir=/var/cache/yum/$basesearch$releasever\n

    \n

    \n keepcache=0\n

    \n

    \n debuglevel=2\n

    ", "smithy.api#required": {} } }, - "Configuration": { - "target": "com.amazonaws.ssm#PatchSourceConfiguration", + "Products": { + "target": "com.amazonaws.ssm#PatchSourceProductList", "traits": { - "smithy.api#documentation": "

    The value of the yum repo configuration. For example:

    \n

    \n [main]\n

    \n

    \n cachedir=/var/cache/yum/$basesearch$releasever\n

    \n

    \n keepcache=0\n

    \n

    \n debuglevel=2\n

    ", + "smithy.api#documentation": "

    The specific operating system versions a patch repository applies to, such as \"Ubuntu16.04\",\n \"AmazonLinux2016.09\", \"RedhatEnterpriseLinux7.2\" or \"Suse12.7\". For lists of supported product\n values, see PatchFilter.

    ", "smithy.api#required": {} } } @@ -17415,10 +17770,10 @@ "com.amazonaws.ssm#PatchStatus": { "type": "structure", "members": { - "DeploymentStatus": { - "target": "com.amazonaws.ssm#PatchDeploymentStatus", + "ComplianceLevel": { + "target": "com.amazonaws.ssm#PatchComplianceLevel", "traits": { - "smithy.api#documentation": "

    The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED,\n EXPLICIT_REJECTED).

    " + "smithy.api#documentation": "

    The compliance severity level for a patch.

    " } }, "ApprovalDate": { @@ -17427,10 +17782,10 @@ "smithy.api#documentation": "

    The date the patch was approved (or will be approved if the status is\n PENDING_APPROVAL).

    " } }, - "ComplianceLevel": { - "target": "com.amazonaws.ssm#PatchComplianceLevel", + "DeploymentStatus": { + "target": "com.amazonaws.ssm#PatchDeploymentStatus", "traits": { - "smithy.api#documentation": "

    The compliance severity level for a patch.

    " + "smithy.api#documentation": "

    The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED,\n EXPLICIT_REJECTED).

    " } } }, @@ -17456,6 +17811,9 @@ "com.amazonaws.ssm#PatchVendor": { "type": "string" }, + "com.amazonaws.ssm#PatchVersion": { + "type": "string" + }, "com.amazonaws.ssm#PingStatus": { "type": "string", "traits": { @@ -17529,10 +17887,10 @@ "smithy.api#documentation": "

    The total number of steps that failed to run in all specified AWS Regions and accounts for\n the current Automation execution.

    " } }, - "TotalSteps": { + "TimedOutSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

    The total number of steps run in all specified AWS Regions and accounts for the current\n Automation execution.

    " + "smithy.api#documentation": "

    The total number of steps that timed out in all specified AWS Regions and accounts for the\n current Automation execution.

    " } }, "CancelledSteps": { @@ -17541,10 +17899,10 @@ "smithy.api#documentation": "

    The total number of steps that the system cancelled in all specified AWS Regions and\n accounts for the current Automation execution.

    " } }, - "TimedOutSteps": { + "TotalSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

    The total number of steps that timed out in all specified AWS Regions and accounts for the\n current Automation execution.

    " + "smithy.api#documentation": "

    The total number of steps run in all specified AWS Regions and accounts for the current\n Automation execution.

    " } } }, @@ -17597,12 +17955,6 @@ "smithy.api#required": {} } }, - "ItemContentHash": { - "target": "com.amazonaws.ssm#ComplianceItemContentHash", - "traits": { - "smithy.api#documentation": "

    MD5 or SHA-256 content hash. The content hash is used to determine if existing information\n should be overwritten or ignored. If the content hashes match, the request to put compliance\n information is ignored.

    " - } - }, "ExecutionSummary": { "target": "com.amazonaws.ssm#ComplianceExecutionSummary", "traits": { @@ -17610,6 +17962,13 @@ "smithy.api#required": {} } }, + "ComplianceType": { + "target": "com.amazonaws.ssm#ComplianceTypeName", + "traits": { + "smithy.api#documentation": "

    Specify the compliance type. For example, specify Association (for a State Manager\n association), Patch, or Custom:string.

    ", + "smithy.api#required": {} + } + }, "UploadType": { "target": "com.amazonaws.ssm#ComplianceUploadType", "traits": { @@ -17623,19 +17982,18 @@ "smithy.api#required": {} } }, - "ComplianceType": { - "target": "com.amazonaws.ssm#ComplianceTypeName", - "traits": { - "smithy.api#documentation": "

    Specify the compliance type. For example, specify Association (for a State Manager\n association), Patch, or Custom:string.

    ", - "smithy.api#required": {} - } - }, "ResourceType": { "target": "com.amazonaws.ssm#ComplianceResourceType", "traits": { "smithy.api#documentation": "

    Specify the type of resource. ManagedInstance is currently the only supported\n resource type.

    ", "smithy.api#required": {} } + }, + "ItemContentHash": { + "target": "com.amazonaws.ssm#ComplianceItemContentHash", + "traits": { + "smithy.api#documentation": "

    MD5 or SHA-256 content hash. The content hash is used to determine if existing information\n should be overwritten or ignored. If the content hashes match, the request to put compliance\n information is ignored.

    " + } } } }, @@ -17699,17 +18057,17 @@ "com.amazonaws.ssm#PutInventoryRequest": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.ssm#InventoryItemList", + "InstanceId": { + "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

    The inventory items that you want to add or update on instances.

    ", + "smithy.api#documentation": "

    An instance ID where you want to add or update inventory items.

    ", "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.ssm#InstanceId", + "Items": { + "target": "com.amazonaws.ssm#InventoryItemList", "traits": { - "smithy.api#documentation": "

    An instance ID where you want to add or update inventory items.

    ", + "smithy.api#documentation": "

    The inventory items that you want to add or update on instances.

    ", "smithy.api#required": {} } } @@ -17788,16 +18146,10 @@ "com.amazonaws.ssm#PutParameterRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.ssm#ParameterType", + "Description": { + "target": "com.amazonaws.ssm#ParameterDescription", "traits": { - "smithy.api#documentation": "

    The type of parameter that you want to add to the system.

    \n \n

    \n SecureString is not currently supported for AWS CloudFormation templates or\n in the China Regions.

    \n     \n

    Items in a StringList must be separated by a comma (,). You can't\n use other punctuation or special character to escape items in the list. If you have a parameter\n value that requires a comma, then use the String data type.

    \n \n

    Specifying a parameter type is not required when updating a parameter. You must specify a\n parameter type when creating a parameter.

    \n     " - } - }, - "Tags": { - "target": "com.amazonaws.ssm#TagList", - "traits": { - "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag a\n Systems Manager parameter to identify the type of resource to which it applies, the environment, or the\n type of configuration data referenced by the parameter. In this case, you could specify the\n following key name/value pairs:

    \n\n
      \n
    • \n

      \n Key=Resource,Value=S3bucket\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    • \n

      \n Key=ParameterType,Value=LicenseKey\n

      \n
      • \n
    \n \n

    To add tags to an existing Systems Manager parameter, use the AddTagsToResource\n action.

    \n     " + "smithy.api#documentation": "

    Information about the parameter that you want to add to the system. Optional but\n recommended.

    \n \n

    Do not enter personally identifiable information in this field.

    \n     " } }, "Policies": { @@ -17806,6 +18158,12 @@ "smithy.api#documentation": "

    One or more policies to apply to a parameter. This action takes a JSON array. Parameter\n Store supports the following policy types:

    \n\n

    Expiration: This policy deletes the parameter after it expires. When you create the policy,\n you specify the expiration date. You can update the expiration date and time by updating the\n policy. Updating the parameter does not affect the expiration date and time.\n When the expiration time is reached, Parameter Store deletes the parameter.

    \n

    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that\n notifies you about the expiration. By using this policy, you can receive notification before or\n after the expiration time is reached, in units of days or hours.

    \n

    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been\n modified for a specified period of time. This policy type is useful when, for example, a secret\n needs to be changed within a period of time, but it has not been changed.

    \n\n

    All existing policies are preserved until you send new policies or an empty policy. For more\n information about parameter policies, see Assigning parameter\n policies.

    " } }, + "AllowedPattern": { + "target": "com.amazonaws.ssm#AllowedPattern", + "traits": { + "smithy.api#documentation": "

    A regular expression used to validate the parameter value. For example, for String types\n with values restricted to numbers, you can specify the following: AllowedPattern=^\\d+$

    " + } + }, "Overwrite": { "target": "com.amazonaws.ssm#Boolean", "traits": { @@ -17813,17 +18171,10 @@ "smithy.api#documentation": "

    Overwrite an existing parameter. If not specified, will default to \"false\".

    " } }, - "AllowedPattern": { - "target": "com.amazonaws.ssm#AllowedPattern", - "traits": { - "smithy.api#documentation": "

    A regular expression used to validate the parameter value. For example, for String types\n with values restricted to numbers, you can specify the following: AllowedPattern=^\\d+$

    " - } - }, - "Value": { - "target": "com.amazonaws.ssm#PSParameterValue", + "Tier": { + "target": "com.amazonaws.ssm#ParameterTier", "traits": { - "smithy.api#documentation": "

    The parameter value that you want to add to the system. Standard parameters have a value\n limit of 4 KB. Advanced parameters have a value limit of 8 KB.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The parameter tier to assign to a parameter.

    \n

    Parameter Store offers a standard tier and an advanced tier for parameters. Standard\n parameters have a content size limit of 4 KB and can't be configured to use parameter policies.\n You can create a maximum of 10,000 standard parameters for each Region in an AWS account.\n Standard parameters are offered at no additional cost.

    \n

    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter\n policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS\n account. Advanced parameters incur a charge. For more information, see Standard and\n advanced parameter tiers in the AWS Systems Manager User Guide.

    \n

    You can change a standard parameter to an advanced parameter any time. But you can't revert\n an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard\n parameter would result in data loss because the system would truncate the size of the parameter\n from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly,\n advanced parameters use a different form of encryption than standard parameters.

    \n

    If you no longer need an advanced parameter, or if you no longer want to incur charges for\n an advanced parameter, you must delete it and recreate it as a new standard parameter.

    \n

    \n Using the Default Tier Configuration\n

    \n

    In PutParameter requests, you can specify the tier to create the parameter in.\n Whenever you specify a tier in the request, Parameter Store creates or updates the parameter\n according to that request. However, if you do not specify a tier in a request, Parameter Store\n assigns the tier based on the current Parameter Store default tier configuration.

    \n

    The default tier when you begin using Parameter Store is the standard-parameter tier. If you\n use the advanced-parameter tier, you can specify one of the following as the default:

    \n
      \n
    • \n

      \n Advanced: With this option, Parameter Store evaluates all\n requests as advanced parameters.

      \n
      • \n
    • \n

      \n Intelligent-Tiering: With this option, Parameter Store\n evaluates each request to determine if the parameter is standard or advanced.

      \n

      If the request doesn't include any options that require an advanced parameter, the\n parameter is created in the standard-parameter tier. If one or more options requiring an\n advanced parameter are included in the request, Parameter Store create a parameter in the\n advanced-parameter tier.

      \n

      This approach helps control your parameter-related costs by always creating standard\n parameters unless an advanced parameter is necessary.

      \n
      • \n
    \n

    Options that require an advanced parameter include the following:

    \n
      \n
    • \n

      The content size of the parameter is more than 4 KB.

      \n
      • \n
    • \n

      The parameter uses a parameter policy.

      \n
      • \n
    • \n

      More than 10,000 parameters already exist in your AWS account in the current\n Region.

      \n
      • \n
    \n

    For more information about configuring the default tier option, see Specifying a\n default parameter tier in the AWS Systems Manager User Guide.

    " } }, "KeyId": { @@ -17838,23 +18189,30 @@ "smithy.api#documentation": "

    The data type for a String parameter. Supported data types include plain text\n and Amazon Machine Image IDs.

    \n

    \n The following data type values are supported.\n

    \n
      \n
    • \n

      \n text\n

      \n
      • \n
    • \n

      \n aws:ec2:image\n

      \n
      • \n
    \n

    When you create a String parameter and specify aws:ec2:image,\n Systems Manager validates the parameter value is in the required format, such as\n ami-12345abcdeEXAMPLE, and that the specified AMI is available in your AWS account.\n For more information, see Native\n parameter support for Amazon Machine Image IDs in the\n AWS Systems Manager User Guide.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#PSParameterName", + "Value": { + "target": "com.amazonaws.ssm#PSParameterValue", "traits": { - "smithy.api#documentation": "

    The fully qualified name of the parameter that you want to add to the system. The fully\n qualified name includes the complete hierarchy of the parameter path and name. For parameters in\n a hierarchy, you must include a leading forward slash character (/) when you create or reference\n a parameter. For example: /Dev/DBServer/MySQL/db-string13\n

    \n

    Naming Constraints:

    \n
      \n
    • \n

      Parameter names are case sensitive.

      \n
      • \n
    • \n

      A parameter name must be unique within an AWS Region

      \n
      • \n
    • \n

      A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).

      \n
      • \n
    • \n

      Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-/\n

      \n
      • \n
    • \n

      A parameter name can't include spaces.

      \n
      • \n
    • \n

      Parameter hierarchies are limited to a maximum depth of fifteen levels.

      \n
      • \n
    \n

    For additional information about valid values for parameter names, see About requirements\n and constraints for parameter names in the AWS Systems Manager User Guide.

    \n \n

    The maximum length constraint listed below includes capacity for additional system\n attributes that are not part of the name. The maximum length for a parameter name, including the\n full length of the parameter ARN, is 1011 characters. For example, the length of the following\n parameter name is 65 characters, not 20 characters:

    \n

    \n arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName\n

    \n     ", + "smithy.api#documentation": "

    The parameter value that you want to add to the system. Standard parameters have a value\n limit of 4 KB. Advanced parameters have a value limit of 8 KB.

    \n \n

    Parameters can't be referenced or nested in the values of other parameters. You can't\n include {{}} or {{ssm:parameter-name}} in a\n parameter value.

    \n     ", "smithy.api#required": {} } }, - "Tier": { - "target": "com.amazonaws.ssm#ParameterTier", + "Type": { + "target": "com.amazonaws.ssm#ParameterType", "traits": { - "smithy.api#documentation": "

    The parameter tier to assign to a parameter.

    \n

    Parameter Store offers a standard tier and an advanced tier for parameters. Standard\n parameters have a content size limit of 4 KB and can't be configured to use parameter policies.\n You can create a maximum of 10,000 standard parameters for each Region in an AWS account.\n Standard parameters are offered at no additional cost.

    \n

    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter\n policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS\n account. Advanced parameters incur a charge. For more information, see Standard and\n advanced parameter tiers in the AWS Systems Manager User Guide.

    \n

    You can change a standard parameter to an advanced parameter any time. But you can't revert\n an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard\n parameter would result in data loss because the system would truncate the size of the parameter\n from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly,\n advanced parameters use a different form of encryption than standard parameters.

    \n

    If you no longer need an advanced parameter, or if you no longer want to incur charges for\n an advanced parameter, you must delete it and recreate it as a new standard parameter.

    \n

    \n Using the Default Tier Configuration\n

    \n

    In PutParameter requests, you can specify the tier to create the parameter in.\n Whenever you specify a tier in the request, Parameter Store creates or updates the parameter\n according to that request. However, if you do not specify a tier in a request, Parameter Store\n assigns the tier based on the current Parameter Store default tier configuration.

    \n

    The default tier when you begin using Parameter Store is the standard-parameter tier. If you\n use the advanced-parameter tier, you can specify one of the following as the default:

    \n
      \n
    • \n

      \n Advanced: With this option, Parameter Store evaluates all\n requests as advanced parameters.

      \n
      • \n
    • \n

      \n Intelligent-Tiering: With this option, Parameter Store\n evaluates each request to determine if the parameter is standard or advanced.

      \n

      If the request doesn't include any options that require an advanced parameter, the\n parameter is created in the standard-parameter tier. If one or more options requiring an\n advanced parameter are included in the request, Parameter Store create a parameter in the\n advanced-parameter tier.

      \n

      This approach helps control your parameter-related costs by always creating standard\n parameters unless an advanced parameter is necessary.

      \n
      • \n
    \n

    Options that require an advanced parameter include the following:

    \n
      \n
    • \n

      The content size of the parameter is more than 4 KB.

      \n
      • \n
    • \n

      The parameter uses a parameter policy.

      \n
      • \n
    • \n

      More than 10,000 parameters already exist in your AWS account in the current\n Region.

      \n
      • \n
    \n

    For more information about configuring the default tier option, see Specifying a\n default parameter tier in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    The type of parameter that you want to add to the system.

    \n \n

    \n SecureString is not currently supported for AWS CloudFormation templates or\n in the China Regions.

    \n     \n

    Items in a StringList must be separated by a comma (,). You can't\n use other punctuation or special character to escape items in the list. If you have a parameter\n value that requires a comma, then use the String data type.

    \n \n

    Specifying a parameter type is not required when updating a parameter. You must specify a\n parameter type when creating a parameter.

    \n     " } }, - "Description": { - "target": "com.amazonaws.ssm#ParameterDescription", + "Name": { + "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

    Information about the parameter that you want to add to the system. Optional but\n recommended.

    \n \n

    Do not enter personally identifiable information in this field.

    \n     " + "smithy.api#documentation": "

    The fully qualified name of the parameter that you want to add to the system. The fully\n qualified name includes the complete hierarchy of the parameter path and name. For parameters in\n a hierarchy, you must include a leading forward slash character (/) when you create or reference\n a parameter. For example: /Dev/DBServer/MySQL/db-string13\n

    \n

    Naming Constraints:

    \n
      \n
    • \n

      Parameter names are case sensitive.

      \n
      • \n
    • \n

      A parameter name must be unique within an AWS Region

      \n
      • \n
    • \n

      A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).

      \n
      • \n
    • \n

      Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-/\n

      \n
      • \n
    • \n

      A parameter name can't include spaces.

      \n
      • \n
    • \n

      Parameter hierarchies are limited to a maximum depth of fifteen levels.

      \n
      • \n
    \n

    For additional information about valid values for parameter names, see About requirements\n and constraints for parameter names in the AWS Systems Manager User Guide.

    \n \n

    The maximum length constraint listed below includes capacity for additional system\n attributes that are not part of the name. The maximum length for a parameter name, including the\n full length of the parameter ARN, is 1011 characters. For example, the length of the following\n parameter name is 65 characters, not 20 characters:

    \n

    \n arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName\n

    \n     ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssm#TagList", + "traits": { + "smithy.api#documentation": "

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in\n different ways, such as by purpose, owner, or environment. For example, you might want to tag a\n Systems Manager parameter to identify the type of resource to which it applies, the environment, or the\n type of configuration data referenced by the parameter. In this case, you could specify the\n following key name/value pairs:

    \n\n
      \n
    • \n

      \n Key=Resource,Value=S3bucket\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    • \n

      \n Key=ParameterType,Value=LicenseKey\n

      \n
      • \n
    \n \n

    To add tags to an existing Systems Manager parameter, use the AddTagsToResource\n action.

    \n     " } } } @@ -17862,17 +18220,17 @@ "com.amazonaws.ssm#PutParameterResult": { "type": "structure", "members": { - "Tier": { - "target": "com.amazonaws.ssm#ParameterTier", - "traits": { - "smithy.api#documentation": "

    The tier assigned to the parameter.

    " - } - }, "Version": { "target": "com.amazonaws.ssm#PSParameterVersion", "traits": { "smithy.api#documentation": "

    The new version number of a parameter. If you edit a parameter value, Parameter Store\n automatically creates a new version and assigns this new version a unique ID. You can reference a\n parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you\n don't specify a specific version, the system returns the latest parameter value when a parameter\n is called.

    " } + }, + "Tier": { + "target": "com.amazonaws.ssm#ParameterTier", + "traits": { + "smithy.api#documentation": "

    The tier assigned to the parameter.

    " + } } } }, @@ -17984,17 +18342,17 @@ "com.amazonaws.ssm#RegisterPatchBaselineForPatchGroupRequest": { "type": "structure", "members": { - "PatchGroup": { - "target": "com.amazonaws.ssm#PatchGroup", + "BaselineId": { + "target": "com.amazonaws.ssm#BaselineId", "traits": { - "smithy.api#documentation": "

    The name of the patch group that should be registered with the patch baseline.

    ", + "smithy.api#documentation": "

    The ID of the patch baseline to register the patch group with.

    ", "smithy.api#required": {} } }, - "BaselineId": { - "target": "com.amazonaws.ssm#BaselineId", + "PatchGroup": { + "target": "com.amazonaws.ssm#PatchGroup", "traits": { - "smithy.api#documentation": "

    The ID of the patch baseline to register the patch group with.

    ", + "smithy.api#documentation": "

    The name of the patch group that should be registered with the patch baseline.

    ", "smithy.api#required": {} } } @@ -18053,10 +18411,17 @@ "smithy.api#required": {} } }, - "OwnerInformation": { - "target": "com.amazonaws.ssm#OwnerInformation", + "ClientToken": { + "target": "com.amazonaws.ssm#ClientToken", "traits": { - "smithy.api#documentation": "

    User-provided value that will be included in any CloudWatch events raised while running\n tasks for these targets in this maintenance window.

    " + "smithy.api#documentation": "

    User-provided idempotency token.

    ", + "smithy.api#idempotencyToken": {} + } + }, + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", + "traits": { + "smithy.api#documentation": "

    An optional name for the target.

    " } }, "Description": { @@ -18079,17 +18444,10 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", - "traits": { - "smithy.api#documentation": "

    An optional name for the target.

    " - } - }, - "ClientToken": { - "target": "com.amazonaws.ssm#ClientToken", + "OwnerInformation": { + "target": "com.amazonaws.ssm#OwnerInformation", "traits": { - "smithy.api#documentation": "

    User-provided idempotency token.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    User-provided value that will be included in any CloudWatch events raised while running\n tasks for these targets in this maintenance window.

    " } } } @@ -18137,29 +18495,23 @@ "com.amazonaws.ssm#RegisterTaskWithMaintenanceWindowRequest": { "type": "structure", "members": { - "LoggingInfo": { - "target": "com.amazonaws.ssm#LoggingInfo", - "traits": { - "smithy.api#documentation": "

    A structure containing information about an S3 bucket to write instance-level logs to.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " - } - }, - "ClientToken": { - "target": "com.amazonaws.ssm#ClientToken", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    User-provided idempotency token.

    ", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

    The maximum number of targets this task can be run for in parallel.

    ", + "smithy.api#required": {} } }, - "ServiceRoleArn": { - "target": "com.amazonaws.ssm#ServiceRole", + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { - "smithy.api#documentation": "

    The ARN of the IAM service role for Systems Manager to assume when running a \n maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's \n service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run \n RegisterTaskWithMaintenanceWindow.

    \n

    For more information, see the following topics in the in the AWS Systems Manager User Guide:

    \n " + "smithy.api#documentation": "

    An optional name for the task.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "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#documentation": "

    The maximum number of errors allowed before this task stops being scheduled.

    ", "smithy.api#required": {} } }, @@ -18169,44 +18521,50 @@ "smithy.api#documentation": "

    An optional description for the task.

    " } }, - "TaskArn": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", + "ServiceRoleArn": { + "target": "com.amazonaws.ssm#ServiceRole", "traits": { - "smithy.api#documentation": "

    The ARN of the task to run.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ARN of the IAM service role for Systems Manager to assume when running a \n maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's \n service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run \n RegisterTaskWithMaintenanceWindow.

    \n

    For more information, see the following topics in the in the AWS Systems Manager User Guide:

    \n " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "ClientToken": { + "target": "com.amazonaws.ssm#ClientToken", "traits": { - "smithy.api#documentation": "

    The maximum number of errors allowed before this task stops being scheduled.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    User-provided idempotency token.

    ", + "smithy.api#idempotencyToken": {} } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "LoggingInfo": { + "target": "com.amazonaws.ssm#LoggingInfo", "traits": { - "smithy.api#documentation": "

    The maximum number of targets this task can be run for in parallel.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A structure containing information about an S3 bucket to write instance-level logs to.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "TaskArn": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window the task should be added to.

    ", + "smithy.api#documentation": "

    The ARN of the task to run.

    ", "smithy.api#required": {} } }, + "Priority": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The priority of the task in the maintenance window, the lower the number the higher the\n priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the\n same priority scheduled in parallel.

    " + } + }, "TaskInvocationParameters": { "target": "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters", "traits": { "smithy.api#documentation": "

    The parameters that the task should use during execution. Populate only the fields that\n match the task type. All other fields should be empty.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", + "TaskType": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", "traits": { - "smithy.api#documentation": "

    An optional name for the task.

    " + "smithy.api#documentation": "

    The type of task being registered.

    ", + "smithy.api#required": {} } }, "TaskParameters": { @@ -18215,17 +18573,17 @@ "smithy.api#documentation": "

    The parameters that should be passed to the task when it is run.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     " } }, - "Priority": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The priority of the task in the maintenance window, the lower the number the higher the\n priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the\n same priority scheduled in parallel.

    " + "smithy.api#documentation": "

    The ID of the maintenance window the task should be added to.

    ", + "smithy.api#required": {} } }, - "TaskType": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskType", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The type of task being registered.

    ", + "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": {} } } @@ -18313,17 +18671,17 @@ "com.amazonaws.ssm#RemoveTagsFromResourceRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.ssm#ResourceId", + "TagKeys": { + "target": "com.amazonaws.ssm#KeyList", "traits": { - "smithy.api#documentation": "

    The ID of the resource from which you want to remove tags. For example:

    \n

    ManagedInstance: mi-012345abcde

    \n

    MaintenanceWindow: mw-012345abcde

    \n

    PatchBaseline: pb-012345abcde

    \n

    For the Document and Parameter values, use the name of the resource.

    \n \n

    The ManagedInstance type for this API action is only for on-premises managed instances.\n Specify the name of the managed instance in the following format: mi-ID_number. For example,\n mi-1a2b3c4d5e6f.

    \n     ", + "smithy.api#documentation": "

    Tag keys that you want to remove from the specified resource.

    ", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.ssm#KeyList", + "ResourceId": { + "target": "com.amazonaws.ssm#ResourceId", "traits": { - "smithy.api#documentation": "

    Tag keys that you want to remove from the specified resource.

    ", + "smithy.api#documentation": "

    The ID of the resource from which you want to remove tags. For example:

    \n

    ManagedInstance: mi-012345abcde

    \n

    MaintenanceWindow: mw-012345abcde

    \n

    PatchBaseline: pb-012345abcde

    \n

    For the Document and Parameter values, use the name of the resource.

    \n \n

    The ManagedInstance type for this API action is only for on-premises managed instances.\n Specify the name of the managed instance in the following format: mi-ID_number. For example,\n mi-1a2b3c4d5e6f.

    \n     ", "smithy.api#required": {} } }, @@ -18421,6 +18779,12 @@ "smithy.api#documentation": "

    The resource ID.

    " } }, + "ExecutionSummary": { + "target": "com.amazonaws.ssm#ComplianceExecutionSummary", + "traits": { + "smithy.api#documentation": "

    Information about the execution.

    " + } + }, "NonCompliantSummary": { "target": "com.amazonaws.ssm#NonCompliantSummary", "traits": { @@ -18433,16 +18797,10 @@ "smithy.api#documentation": "

    The compliance status for the resource.

    " } }, - "OverallSeverity": { - "target": "com.amazonaws.ssm#ComplianceSeverity", - "traits": { - "smithy.api#documentation": "

    The highest severity item found for the resource. The resource is compliant for this\n item.

    " - } - }, - "ExecutionSummary": { - "target": "com.amazonaws.ssm#ComplianceExecutionSummary", + "ComplianceType": { + "target": "com.amazonaws.ssm#ComplianceTypeName", "traits": { - "smithy.api#documentation": "

    Information about the execution.

    " + "smithy.api#documentation": "

    The compliance type.

    " } }, "ResourceType": { @@ -18457,10 +18815,10 @@ "smithy.api#documentation": "

    A list of items that are compliant for the resource.

    " } }, - "ComplianceType": { - "target": "com.amazonaws.ssm#ComplianceTypeName", + "OverallSeverity": { + "target": "com.amazonaws.ssm#ComplianceSeverity", "traits": { - "smithy.api#documentation": "

    The compliance type.

    " + "smithy.api#documentation": "

    The highest severity item found for the resource. The resource is compliant for this\n item.

    " } } }, @@ -18594,28 +18952,34 @@ "com.amazonaws.ssm#ResourceDataSyncItem": { "type": "structure", "members": { - "LastSuccessfulSyncTime": { - "target": "com.amazonaws.ssm#LastSuccessfulResourceDataSyncTime", + "LastSyncStatusMessage": { + "target": "com.amazonaws.ssm#LastResourceDataSyncMessage", "traits": { - "smithy.api#documentation": "

    The last time the sync operations returned a status of SUCCESSFUL (UTC).

    " + "smithy.api#documentation": "

    The status message details reported by the last sync.

    " } }, - "SyncName": { - "target": "com.amazonaws.ssm#ResourceDataSyncName", + "SyncSource": { + "target": "com.amazonaws.ssm#ResourceDataSyncSourceWithState", "traits": { - "smithy.api#documentation": "

    The name of the Resource Data Sync.

    " + "smithy.api#documentation": "

    Information about the source where the data was synchronized.

    " } }, - "LastSyncTime": { - "target": "com.amazonaws.ssm#LastResourceDataSyncTime", + "S3Destination": { + "target": "com.amazonaws.ssm#ResourceDataSyncS3Destination", "traits": { - "smithy.api#documentation": "

    The last time the configuration attempted to sync (UTC).

    " + "smithy.api#documentation": "

    Configuration information for the target S3 bucket.

    " } }, - "SyncCreatedTime": { - "target": "com.amazonaws.ssm#ResourceDataSyncCreatedTime", + "SyncLastModifiedTime": { + "target": "com.amazonaws.ssm#ResourceDataSyncLastModifiedTime", "traits": { - "smithy.api#documentation": "

    The date and time the configuration was created (UTC).

    " + "smithy.api#documentation": "

    The date and time the resource data sync was changed.

    " + } + }, + "LastStatus": { + "target": "com.amazonaws.ssm#LastResourceDataSyncStatus", + "traits": { + "smithy.api#documentation": "

    The status reported by the last sync.

    " } }, "SyncType": { @@ -18624,34 +18988,28 @@ "smithy.api#documentation": "

    The type of resource data sync. If SyncType is SyncToDestination,\n then the resource data sync synchronizes data to an S3 bucket. If the SyncType is\n SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from\n multiple AWS Regions.

    " } }, - "SyncLastModifiedTime": { - "target": "com.amazonaws.ssm#ResourceDataSyncLastModifiedTime", + "SyncCreatedTime": { + "target": "com.amazonaws.ssm#ResourceDataSyncCreatedTime", "traits": { - "smithy.api#documentation": "

    The date and time the resource data sync was changed.

    " + "smithy.api#documentation": "

    The date and time the configuration was created (UTC).

    " } }, - "S3Destination": { - "target": "com.amazonaws.ssm#ResourceDataSyncS3Destination", - "traits": { - "smithy.api#documentation": "

    Configuration information for the target S3 bucket.

    " - } - }, - "SyncSource": { - "target": "com.amazonaws.ssm#ResourceDataSyncSourceWithState", + "LastSyncTime": { + "target": "com.amazonaws.ssm#LastResourceDataSyncTime", "traits": { - "smithy.api#documentation": "

    Information about the source where the data was synchronized.

    " + "smithy.api#documentation": "

    The last time the configuration attempted to sync (UTC).

    " } }, - "LastSyncStatusMessage": { - "target": "com.amazonaws.ssm#LastResourceDataSyncMessage", + "SyncName": { + "target": "com.amazonaws.ssm#ResourceDataSyncName", "traits": { - "smithy.api#documentation": "

    The status message details reported by the last sync.

    " + "smithy.api#documentation": "

    The name of the Resource Data Sync.

    " } }, - "LastStatus": { - "target": "com.amazonaws.ssm#LastResourceDataSyncStatus", + "LastSuccessfulSyncTime": { + "target": "com.amazonaws.ssm#LastSuccessfulResourceDataSyncTime", "traits": { - "smithy.api#documentation": "

    The status reported by the last sync.

    " + "smithy.api#documentation": "

    The last time the sync operations returned a status of SUCCESSFUL (UTC).

    " } } }, @@ -18680,14 +19038,14 @@ "com.amazonaws.ssm#ResourceDataSyncNotFoundException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.ssm#String" + }, "SyncType": { "target": "com.amazonaws.ssm#ResourceDataSyncType" }, "SyncName": { "target": "com.amazonaws.ssm#ResourceDataSyncName" - }, - "Message": { - "target": "com.amazonaws.ssm#String" } }, "traits": { @@ -18758,11 +19116,10 @@ "smithy.api#documentation": "

    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as\n the destination S3 bucket.

    " } }, - "BucketName": { - "target": "com.amazonaws.ssm#ResourceDataSyncS3BucketName", + "DestinationDataSharing": { + "target": "com.amazonaws.ssm#ResourceDataSyncDestinationDataSharing", "traits": { - "smithy.api#documentation": "

    The name of the S3 bucket where the aggregated data is stored.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Enables destination data sharing. By default, this field is null.

    " } }, "SyncFormat": { @@ -18772,10 +19129,11 @@ "smithy.api#required": {} } }, - "DestinationDataSharing": { - "target": "com.amazonaws.ssm#ResourceDataSyncDestinationDataSharing", + "BucketName": { + "target": "com.amazonaws.ssm#ResourceDataSyncS3BucketName", "traits": { - "smithy.api#documentation": "

    Enables destination data sharing. By default, this field is null.

    " + "smithy.api#documentation": "

    The name of the S3 bucket where the aggregated data is stored.

    ", + "smithy.api#required": {} } }, "Prefix": { @@ -18828,6 +19186,12 @@ "com.amazonaws.ssm#ResourceDataSyncSource": { "type": "structure", "members": { + "AwsOrganizationsSource": { + "target": "com.amazonaws.ssm#ResourceDataSyncAwsOrganizationsSource", + "traits": { + "smithy.api#documentation": "

    Information about the AwsOrganizationsSource resource data sync source. A sync source of\n this type can synchronize data from AWS Organizations.

    " + } + }, "SourceRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncSourceRegionList", "traits": { @@ -18841,12 +19205,6 @@ "smithy.api#documentation": "

    Whether to automatically synchronize and aggregate data from new AWS Regions when those\n Regions come online.

    " } }, - "AwsOrganizationsSource": { - "target": "com.amazonaws.ssm#ResourceDataSyncAwsOrganizationsSource", - "traits": { - "smithy.api#documentation": "

    Information about the AwsOrganizationsSource resource data sync source. A sync source of\n this type can synchronize data from AWS Organizations.

    " - } - }, "SourceType": { "target": "com.amazonaws.ssm#ResourceDataSyncSourceType", "traits": { @@ -18892,29 +19250,29 @@ "smithy.api#documentation": "

    The type of data source for the resource data sync. SourceType is either\n AwsOrganizations (if an organization is present in AWS Organizations) or\n singleAccountMultiRegions.

    " } }, - "AwsOrganizationsSource": { - "target": "com.amazonaws.ssm#ResourceDataSyncAwsOrganizationsSource", - "traits": { - "smithy.api#documentation": "

    The field name in SyncSource for the\n ResourceDataSyncAwsOrganizationsSource type.

    " - } - }, - "IncludeFutureRegions": { - "target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions", - "traits": { - "smithy.api#documentation": "

    Whether to automatically synchronize and aggregate data from new AWS Regions when those\n Regions come online.

    " - } - }, "SourceRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncSourceRegionList", "traits": { "smithy.api#documentation": "

    The SyncSource AWS Regions included in the resource data sync.

    " } }, + "AwsOrganizationsSource": { + "target": "com.amazonaws.ssm#ResourceDataSyncAwsOrganizationsSource", + "traits": { + "smithy.api#documentation": "

    The field name in SyncSource for the\n ResourceDataSyncAwsOrganizationsSource type.

    " + } + }, "State": { "target": "com.amazonaws.ssm#ResourceDataSyncState", "traits": { "smithy.api#documentation": "

    The data type name for including resource data sync state. There are four sync\n states:

    \n\n

    \n OrganizationNotExists: Your organization doesn't exist.

    \n

    \n NoPermissions: The system can't locate the service-linked role. This role is\n automatically created when a user creates a resource data sync in Explorer.

    \n

    \n InvalidOrganizationalUnit: You specified or selected an invalid unit in the\n resource data sync configuration.

    \n

    \n TrustedAccessDisabled: You disabled Systems Manager access in the organization in\n AWS Organizations.

    " } + }, + "IncludeFutureRegions": { + "target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions", + "traits": { + "smithy.api#documentation": "

    Whether to automatically synchronize and aggregate data from new AWS Regions when those\n Regions come online.

    " + } } }, "traits": { @@ -19084,6 +19442,12 @@ "com.amazonaws.ssm#ResumeSessionResponse": { "type": "structure", "members": { + "TokenValue": { + "target": "com.amazonaws.ssm#TokenValue", + "traits": { + "smithy.api#documentation": "

    An encrypted token value containing session and caller information. Used to authenticate the\n connection to the instance.

    " + } + }, "SessionId": { "target": "com.amazonaws.ssm#SessionId", "traits": { @@ -19095,12 +19459,6 @@ "traits": { "smithy.api#documentation": "

    A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

    \n

    \n region represents the Region identifier for an\n\t\t\t\t\t\tAWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n AWS General Reference.

    \n

    \n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.

    " } - }, - "TokenValue": { - "target": "com.amazonaws.ssm#TokenValue", - "traits": { - "smithy.api#documentation": "

    An encrypted token value containing session and caller information. Used to authenticate the\n connection to the instance.

    " - } } } }, @@ -19131,17 +19489,17 @@ "smithy.api#documentation": "

    The S3 bucket subfolder.

    " } }, - "OutputS3BucketName": { - "target": "com.amazonaws.ssm#S3BucketName", - "traits": { - "smithy.api#documentation": "

    The name of the S3 bucket.

    " - } - }, "OutputS3Region": { "target": "com.amazonaws.ssm#S3Region", "traits": { "smithy.api#documentation": "

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.

    " } + }, + "OutputS3BucketName": { + "target": "com.amazonaws.ssm#S3BucketName", + "traits": { + "smithy.api#documentation": "

    The name of the S3 bucket.

    " + } } }, "traits": { @@ -19241,6 +19599,13 @@ "com.amazonaws.ssm#SendAutomationSignalRequest": { "type": "structure", "members": { + "SignalType": { + "target": "com.amazonaws.ssm#SignalType", + "traits": { + "smithy.api#documentation": "

    The type of signal to send to an Automation execution.

    ", + "smithy.api#required": {} + } + }, "AutomationExecutionId": { "target": "com.amazonaws.ssm#AutomationExecutionId", "traits": { @@ -19253,13 +19618,6 @@ "traits": { "smithy.api#documentation": "

    The data sent with the signal. The data schema depends on the type of signal used in the\n request.

    \n

    For Approve and Reject signal types, the payload is an optional\n comment that you can send with the signal type. For example:

    \n

    \n Comment=\"Looks good\"\n

    \n

    For StartStep and Resume signal types, you must send the name of\n the Automation step to start or resume as the payload. For example:

    \n

    \n StepName=\"step1\"\n

    \n

    For the StopStep signal type, you must send the step execution ID as the\n payload. For example:

    \n

    \n StepExecutionId=\"97fff367-fc5a-4299-aed8-0123456789ab\"\n

    " } - }, - "SignalType": { - "target": "com.amazonaws.ssm#SignalType", - "traits": { - "smithy.api#documentation": "

    The type of signal to send to an Automation execution.

    ", - "smithy.api#required": {} - } } } }, @@ -19317,40 +19675,35 @@ "com.amazonaws.ssm#SendCommandRequest": { "type": "structure", "members": { - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", - "traits": { - "smithy.api#documentation": "

    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a\n specific version number. If you run commands by using the AWS CLI, then you must escape the first\n two options by using a backslash. If you specify a version number, then you don't need to use the\n backslash. For example:

    \n

    --document-version \"\\$DEFAULT\"

    \n

    --document-version \"\\$LATEST\"

    \n

    --document-version \"3\"

    " - } - }, - "NotificationConfig": { - "target": "com.amazonaws.ssm#NotificationConfig", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    Configurations for sending notifications.

    " + "smithy.api#documentation": "

    (Optional) The maximum number of instances that are allowed to run the command at the same\n time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50.\n For more information about how to use MaxConcurrency, see Using\n concurrency controls in the AWS Systems Manager User Guide.

    " } }, - "OutputS3Region": { - "target": "com.amazonaws.ssm#S3Region", + "InstanceIds": { + "target": "com.amazonaws.ssm#InstanceIdList", "traits": { - "smithy.api#documentation": "

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.

    " + "smithy.api#documentation": "

    The IDs of the instances where the command should run. Specifying instance IDs is most\n useful when you are targeting a limited number of instances, though you can specify up to 50\n IDs.

    \n

    To target a larger number of instances, or if you prefer not to list individual instance\n IDs, we recommend using the Targets option instead. Using Targets,\n which accepts tag key-value pairs to identify the instances to send commands to, you can a send\n command to tens, hundreds, or thousands of instances at once.

    \n

    For more information about how to use targets, see Using targets and rate\n controls to send commands to a fleet in the\n AWS Systems Manager User Guide.

    " } }, - "DocumentHash": { - "target": "com.amazonaws.ssm#DocumentHash", + "Parameters": { + "target": "com.amazonaws.ssm#Parameters", "traits": { - "smithy.api#documentation": "

    The Sha256 or Sha1 hash created by the system when the document was created.

    \n \n

    Sha1 hashes have been deprecated.

    \n     " + "smithy.api#documentation": "

    The required and optional parameters specified in the document being run.

    " } }, - "OutputS3KeyPrefix": { - "target": "com.amazonaws.ssm#S3KeyPrefix", + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    The directory structure within the S3 bucket where the responses should be stored.

    " + "smithy.api#documentation": "

    Required. The name of the Systems Manager document to run. This can be a public document or a custom\n document.

    ", + "smithy.api#required": {} } }, - "Comment": { - "target": "com.amazonaws.ssm#Comment", + "OutputS3BucketName": { + "target": "com.amazonaws.ssm#S3BucketName", "traits": { - "smithy.api#documentation": "

    User-specified information about the command, such as a brief description of what the\n command should do.

    " + "smithy.api#documentation": "

    The name of the S3 bucket where command execution responses should be stored.

    " } }, "MaxErrors": { @@ -19359,54 +19712,46 @@ "smithy.api#documentation": "

    The maximum number of errors allowed without the command failing. When the command fails one\n more time beyond the value of MaxErrors, the systems stops sending the command to additional\n targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For\n more information about how to use MaxErrors, see Using\n error controls in the AWS Systems Manager User Guide.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#Parameters", - "traits": { - "smithy.api#documentation": "

    The required and optional parameters specified in the document being run.

    " - } - }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "Comment": { + "target": "com.amazonaws.ssm#Comment", "traits": { - "smithy.api#documentation": "

    (Optional) The maximum number of instances that are allowed to run the command at the same\n time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50.\n For more information about how to use MaxConcurrency, see Using\n concurrency controls in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    User-specified information about the command, such as a brief description of what the\n command should do.

    " } }, - "InstanceIds": { - "target": "com.amazonaws.ssm#InstanceIdList", + "OutputS3Region": { + "target": "com.amazonaws.ssm#S3Region", "traits": { - "smithy.api#documentation": "

    The IDs of the instances where the command should run. Specifying instance IDs is most\n useful when you are targeting a limited number of instances, though you can specify up to 50\n IDs.

    \n

    To target a larger number of instances, or if you prefer not to list individual instance\n IDs, we recommend using the Targets option instead. Using Targets,\n which accepts tag key-value pairs to identify the instances to send commands to, you can a send\n command to tens, hundreds, or thousands of instances at once.

    \n

    For more information about how to use targets, see Using targets and rate\n controls to send commands to a fleet in the\n AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.

    " } }, - "DocumentName": { - "target": "com.amazonaws.ssm#DocumentARN", + "CloudWatchOutputConfig": { + "target": "com.amazonaws.ssm#CloudWatchOutputConfig", "traits": { - "smithy.api#documentation": "

    Required. The name of the Systems Manager document to run. This can be a public document or a custom\n document.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

    " } }, - "OutputS3BucketName": { - "target": "com.amazonaws.ssm#S3BucketName", + "DocumentHash": { + "target": "com.amazonaws.ssm#DocumentHash", "traits": { - "smithy.api#documentation": "

    The name of the S3 bucket where command execution responses should be stored.

    " + "smithy.api#documentation": "

    The Sha256 or Sha1 hash created by the system when the document was created.

    \n \n

    Sha1 hashes have been deprecated.

    \n     " } }, - "TimeoutSeconds": { - "target": "com.amazonaws.ssm#TimeoutSeconds", + "NotificationConfig": { + "target": "com.amazonaws.ssm#NotificationConfig", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    If this time is reached and the command has not already started running, it will not\n run.

    " + "smithy.api#documentation": "

    Configurations for sending notifications.

    " } }, - "DocumentHashType": { - "target": "com.amazonaws.ssm#DocumentHashType", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    Sha256 or Sha1.

    \n \n

    Sha1 hashes have been deprecated.

    \n     " + "smithy.api#documentation": "

    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a\n specific version number. If you run commands by using the AWS CLI, then you must escape the first\n two options by using a backslash. If you specify a version number, then you don't need to use the\n backslash. For example:

    \n

    --document-version \"\\$DEFAULT\"

    \n

    --document-version \"\\$LATEST\"

    \n

    --document-version \"3\"

    " } }, - "CloudWatchOutputConfig": { - "target": "com.amazonaws.ssm#CloudWatchOutputConfig", + "OutputS3KeyPrefix": { + "target": "com.amazonaws.ssm#S3KeyPrefix", "traits": { - "smithy.api#documentation": "

    Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

    " + "smithy.api#documentation": "

    The directory structure within the S3 bucket where the responses should be stored.

    " } }, "ServiceRoleArn": { @@ -19420,6 +19765,19 @@ "traits": { "smithy.api#documentation": "

    An array of search criteria that targets instances using a Key,Value\n combination that you specify. Specifying targets is most useful when you want to send a command\n to a large number of instances at once. Using Targets, which accepts tag key-value\n pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances\n at once.

    \n

    To send a command to a smaller number of instances, you can use the InstanceIds\n option instead.

    \n

    For more information about how to use targets, see Sending commands to a\n fleet in the AWS Systems Manager User Guide.

    " } + }, + "TimeoutSeconds": { + "target": "com.amazonaws.ssm#TimeoutSeconds", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    If this time is reached and the command has not already started running, it will not\n run.

    " + } + }, + "DocumentHashType": { + "target": "com.amazonaws.ssm#DocumentHashType", + "traits": { + "smithy.api#documentation": "

    Sha256 or Sha1.

    \n \n

    Sha1 hashes have been deprecated.

    \n     " + } } } }, @@ -19440,16 +19798,22 @@ "com.amazonaws.ssm#ServiceSetting": { "type": "structure", "members": { - "SettingId": { - "target": "com.amazonaws.ssm#ServiceSettingId", + "Status": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The ID of the service setting.

    " + "smithy.api#documentation": "

    The status of the service setting. The value can be Default, Customized or\n PendingUpdate.

    \n
      \n
    • \n

      Default: The current setting uses a default value provisioned by the AWS service\n team.

      \n
      • \n
    • \n

      Customized: The current setting use a custom value specified by the customer.

      \n
      • \n
    • \n

      PendingUpdate: The current setting uses a default or custom value, but a setting change\n request is pending approval.

      \n
      • \n
    " } }, - "LastModifiedUser": { + "LastModifiedDate": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

    The last time the service setting was modified.

    " + } + }, + "ARN": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The ARN of the last modified user. This field is populated only if the setting value was\n overwritten.

    " + "smithy.api#documentation": "

    The ARN of the service setting.

    " } }, "SettingValue": { @@ -19458,22 +19822,16 @@ "smithy.api#documentation": "

    The value of the service setting.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#String", - "traits": { - "smithy.api#documentation": "

    The status of the service setting. The value can be Default, Customized or\n PendingUpdate.

    \n
      \n
    • \n

      Default: The current setting uses a default value provisioned by the AWS service\n team.

      \n
      • \n
    • \n

      Customized: The current setting use a custom value specified by the customer.

      \n
      • \n
    • \n

      PendingUpdate: The current setting uses a default or custom value, but a setting change\n request is pending approval.

      \n
      • \n
    " - } - }, - "ARN": { + "LastModifiedUser": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The ARN of the service setting.

    " + "smithy.api#documentation": "

    The ARN of the last modified user. This field is populated only if the setting value was\n overwritten.

    " } }, - "LastModifiedDate": { - "target": "com.amazonaws.ssm#DateTime", + "SettingId": { + "target": "com.amazonaws.ssm#ServiceSettingId", "traits": { - "smithy.api#documentation": "

    The last time the service setting was modified.

    " + "smithy.api#documentation": "

    The ID of the service setting.

    " } } }, @@ -19514,10 +19872,10 @@ "com.amazonaws.ssm#Session": { "type": "structure", "members": { - "EndDate": { - "target": "com.amazonaws.ssm#DateTime", + "Owner": { + "target": "com.amazonaws.ssm#SessionOwner", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, when the session was terminated.

    " + "smithy.api#documentation": "

    The ID of the AWS user account that started the session.

    " } }, "SessionId": { @@ -19526,22 +19884,22 @@ "smithy.api#documentation": "

    The ID of the session.

    " } }, - "StartDate": { + "EndDate": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, when the session began.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, when the session was terminated.

    " } }, - "OutputUrl": { - "target": "com.amazonaws.ssm#SessionManagerOutputUrl", + "Status": { + "target": "com.amazonaws.ssm#SessionStatus", "traits": { - "smithy.api#documentation": "

    Reserved for future use.

    " + "smithy.api#documentation": "

    The status of the session. For example, \"Connected\" or \"Terminated\".

    " } }, - "DocumentName": { - "target": "com.amazonaws.ssm#DocumentName", + "StartDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The name of the Session Manager SSM document used to define the parameters and plugin settings for the\n session. For example, SSM-SessionManagerRunShell.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, when the session began.

    " } }, "Target": { @@ -19556,16 +19914,16 @@ "smithy.api#documentation": "

    Reserved for future use.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#SessionStatus", + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    The status of the session. For example, \"Connected\" or \"Terminated\".

    " + "smithy.api#documentation": "

    The name of the Session Manager SSM document used to define the parameters and plugin settings for the\n session. For example, SSM-SessionManagerRunShell.

    " } }, - "Owner": { - "target": "com.amazonaws.ssm#SessionOwner", + "OutputUrl": { + "target": "com.amazonaws.ssm#SessionManagerOutputUrl", "traits": { - "smithy.api#documentation": "

    The ID of the AWS user account that started the session.

    " + "smithy.api#documentation": "

    Reserved for future use.

    " } } }, @@ -19679,14 +20037,14 @@ "com.amazonaws.ssm#SessionManagerOutputUrl": { "type": "structure", "members": { - "CloudWatchOutputUrl": { - "target": "com.amazonaws.ssm#SessionManagerCloudWatchOutputUrl", + "S3OutputUrl": { + "target": "com.amazonaws.ssm#SessionManagerS3OutputUrl", "traits": { "smithy.api#documentation": "

    Reserved for future use.

    " } }, - "S3OutputUrl": { - "target": "com.amazonaws.ssm#SessionManagerS3OutputUrl", + "CloudWatchOutputUrl": { + "target": "com.amazonaws.ssm#SessionManagerCloudWatchOutputUrl", "traits": { "smithy.api#documentation": "

    Reserved for future use.

    " } @@ -19814,40 +20172,40 @@ "com.amazonaws.ssm#SeveritySummary": { "type": "structure", "members": { - "LowCount": { + "UnspecifiedCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { - "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of low. Low\n severity is determined by the organization that published the compliance items.

    " + "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of unspecified.\n Unspecified severity is determined by the organization that published the compliance\n items.

    " } }, - "MediumCount": { + "InformationalCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { - "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of medium.\n Medium severity is determined by the organization that published the compliance items.

    " + "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of\n informational. Informational severity is determined by the organization that published the\n compliance items.

    " } }, - "HighCount": { + "CriticalCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { - "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of high. High\n severity is determined by the organization that published the compliance items.

    " + "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of critical.\n Critical severity is determined by the organization that published the compliance items.

    " } }, - "CriticalCount": { + "HighCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { - "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of critical.\n Critical severity is determined by the organization that published the compliance items.

    " + "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of high. High\n severity is determined by the organization that published the compliance items.

    " } }, - "InformationalCount": { + "MediumCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { - "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of\n informational. Informational severity is determined by the organization that published the\n compliance items.

    " + "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of medium.\n Medium severity is determined by the organization that published the compliance items.

    " } }, - "UnspecifiedCount": { + "LowCount": { "target": "com.amazonaws.ssm#ComplianceSummaryCount", "traits": { - "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of unspecified.\n Unspecified severity is determined by the organization that published the compliance\n items.

    " + "smithy.api#documentation": "

    The total number of resources or compliance items that have a severity level of low. Low\n severity is determined by the organization that published the compliance items.

    " } } }, @@ -19998,10 +20356,22 @@ "com.amazonaws.ssm#StartAutomationExecutionRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.ssm#TagList", + "Parameters": { + "target": "com.amazonaws.ssm#AutomationParameterMap", "traits": { - "smithy.api#documentation": "

    Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an automation. Tags enable you to categorize a resource in different ways, such as by purpose,\n owner, or environment. For example, you might want to tag an automation to identify an\n environment or operating system. In this case, you could specify the following key name/value\n pairs:

    \n
      \n
    • \n

      \n Key=environment,Value=test\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    \n \n

    To add tags to an existing patch baseline, use the AddTagsToResource\n action.

    \n     " + "smithy.api#documentation": "

    A key-value map of execution parameters, which match the declared parameters in the\n Automation document.

    " + } + }, + "TargetParameterName": { + "target": "com.amazonaws.ssm#AutomationParameterKey", + "traits": { + "smithy.api#documentation": "

    The name of the parameter used as the target resource for the rate-controlled execution.\n Required if you specify targets.

    " + } + }, + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", + "traits": { + "smithy.api#documentation": "

    The number of errors that are allowed before the system stops running the automation on\n additional targets. You can specify either an absolute number of errors, for example 10, or a\n percentage of the target set, for example 10%. If you specify 3, for example, the system stops\n running the automation when the fourth error is received. If you specify 0, then the system stops\n running the automation on additional targets after the first error result is returned. If you run\n an automation on 50 resources and set max-errors to 10%, then the system stops running the\n automation on additional targets when the sixth error is received.

    \n

    Executions that are already running an automation when max-errors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one\n at a time.

    " } }, "DocumentName": { @@ -20011,10 +20381,10 @@ "smithy.api#required": {} } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "ClientToken": { + "target": "com.amazonaws.ssm#IdempotencyToken", "traits": { - "smithy.api#documentation": "

    The number of errors that are allowed before the system stops running the automation on\n additional targets. You can specify either an absolute number of errors, for example 10, or a\n percentage of the target set, for example 10%. If you specify 3, for example, the system stops\n running the automation when the fourth error is received. If you specify 0, then the system stops\n running the automation on additional targets after the first error result is returned. If you run\n an automation on 50 resources and set max-errors to 10%, then the system stops running the\n automation on additional targets when the sixth error is received.

    \n

    Executions that are already running an automation when max-errors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one\n at a time.

    " + "smithy.api#documentation": "

    User-provided idempotency token. The token must be unique, is case insensitive, enforces the\n UUID format, and can't be reused.

    " } }, "TargetLocations": { @@ -20023,16 +20393,10 @@ "smithy.api#documentation": "

    A location is a combination of AWS Regions and/or AWS accounts where you want to run the\n Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For\n more information, see Running Automation workflows in multiple AWS Regions and accounts in the\n AWS Systems Manager User Guide.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", - "traits": { - "smithy.api#documentation": "

    A key-value mapping to target resources. Required if you specify TargetParameterName.

    " - } - }, - "ClientToken": { - "target": "com.amazonaws.ssm#IdempotencyToken", + "Tags": { + "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

    User-provided idempotency token. The token must be unique, is case insensitive, enforces the\n UUID format, and can't be reused.

    " + "smithy.api#documentation": "

    Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an automation. Tags enable you to categorize a resource in different ways, such as by purpose,\n owner, or environment. For example, you might want to tag an automation to identify an\n environment or operating system. In this case, you could specify the following key name/value\n pairs:

    \n
      \n
    • \n

      \n Key=environment,Value=test\n

      \n
      • \n
    • \n

      \n Key=OS,Value=Windows\n

      \n
      • \n
    \n \n

    To add tags to an existing patch baseline, use the AddTagsToResource\n action.

    \n     " } }, "TargetMaps": { @@ -20041,16 +20405,10 @@ "smithy.api#documentation": "

    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n cannot be specified together.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", - "traits": { - "smithy.api#documentation": "

    The version of the Automation document to use for this execution.

    " - } - }, - "Mode": { - "target": "com.amazonaws.ssm#ExecutionMode", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The execution mode of the automation. Valid modes include the following: Auto and\n Interactive. The default mode is Auto.

    " + "smithy.api#documentation": "

    A key-value mapping to target resources. Required if you specify TargetParameterName.

    " } }, "MaxConcurrency": { @@ -20059,16 +20417,16 @@ "smithy.api#documentation": "

    The maximum number of targets allowed to run this task in parallel. You can specify a\n number, such as 10, or a percentage, such as 10%. The default value is 10.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#AutomationParameterMap", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    A key-value map of execution parameters, which match the declared parameters in the\n Automation document.

    " + "smithy.api#documentation": "

    The version of the Automation document to use for this execution.

    " } }, - "TargetParameterName": { - "target": "com.amazonaws.ssm#AutomationParameterKey", + "Mode": { + "target": "com.amazonaws.ssm#ExecutionMode", "traits": { - "smithy.api#documentation": "

    The name of the parameter used as the target resource for the rate-controlled execution.\n Required if you specify targets.

    " + "smithy.api#documentation": "

    The execution mode of the automation. Valid modes include the following: Auto and\n Interactive. The default mode is Auto.

    " } } } @@ -20134,10 +20492,10 @@ "com.amazonaws.ssm#StartSessionResponse": { "type": "structure", "members": { - "TokenValue": { - "target": "com.amazonaws.ssm#TokenValue", + "SessionId": { + "target": "com.amazonaws.ssm#SessionId", "traits": { - "smithy.api#documentation": "

    An encrypted token value containing session and caller information. Used to authenticate the\n connection to the instance.

    " + "smithy.api#documentation": "

    The ID of the session.

    " } }, "StreamUrl": { @@ -20146,10 +20504,10 @@ "smithy.api#documentation": "

    A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)\n

    \n

    \n region represents the Region identifier for an\n\t\t\t\t\t\tAWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n AWS General Reference.

    \n

    \n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.

    " } }, - "SessionId": { - "target": "com.amazonaws.ssm#SessionId", + "TokenValue": { + "target": "com.amazonaws.ssm#TokenValue", "traits": { - "smithy.api#documentation": "

    The ID of the session.

    " + "smithy.api#documentation": "

    An encrypted token value containing session and caller information. Used to authenticate the\n connection to the instance.

    " } } } @@ -20195,48 +20553,47 @@ "com.amazonaws.ssm#StepExecution": { "type": "structure", "members": { - "StepStatus": { - "target": "com.amazonaws.ssm#AutomationExecutionStatus", + "IsEnd": { + "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#documentation": "

    The execution status for this step.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The flag which can be used to end automation no matter whether the step succeeds or\n fails.

    " } }, - "OverriddenParameters": { - "target": "com.amazonaws.ssm#AutomationParameterMap", + "OnFailure": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    A user-specified list of parameters to override when running a step.

    " + "smithy.api#documentation": "

    The action to take if the step fails. The default value is Abort.

    " } }, - "Outputs": { - "target": "com.amazonaws.ssm#AutomationParameterMap", + "FailureMessage": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    Returned values from the execution of the step.

    " + "smithy.api#documentation": "

    If a step failed, this message explains why the execution failed.

    " } }, - "MaxAttempts": { - "target": "com.amazonaws.ssm#Integer", + "TargetLocation": { + "target": "com.amazonaws.ssm#TargetLocation", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The maximum number of tries to run the action of the step. The default value is 1.

    " + "smithy.api#documentation": "

    The combination of AWS Regions and accounts targeted by the current Automation\n execution.

    " } }, - "StepExecutionId": { - "target": "com.amazonaws.ssm#String", + "Inputs": { + "target": "com.amazonaws.ssm#NormalStringMap", "traits": { - "smithy.api#documentation": "

    The unique ID of a step execution.

    " + "smithy.api#documentation": "

    Fully-resolved values passed into the step before execution.

    " } }, - "FailureDetails": { - "target": "com.amazonaws.ssm#FailureDetails", + "StepName": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    Information about the Automation failure.

    " + "smithy.api#documentation": "

    The name of this execution step.

    " } }, - "IsCritical": { - "target": "com.amazonaws.ssm#Boolean", + "ExecutionEndTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The flag which can be used to help decide whether the failure of current step leads to the\n Automation failure.

    " + "smithy.api#documentation": "

    If a step has finished execution, this contains the time the execution ended. If the step\n has not yet concluded, this field is not populated.

    " } }, "TimeoutSeconds": { @@ -20246,77 +20603,84 @@ "smithy.api#documentation": "

    The timeout seconds of the step.

    " } }, + "FailureDetails": { + "target": "com.amazonaws.ssm#FailureDetails", + "traits": { + "smithy.api#documentation": "

    Information about the Automation failure.

    " + } + }, "Action": { "target": "com.amazonaws.ssm#AutomationActionName", "traits": { "smithy.api#documentation": "

    The action this step performs. The action determines the behavior of the step.

    " } }, - "ValidNextSteps": { - "target": "com.amazonaws.ssm#ValidNextStepList", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    Strategies used when step fails, we support Continue and Abort. Abort will fail the\n automation when the step fails. Continue will ignore the failure of current step and allow\n automation to run the next step. With conditional branching, we add step:stepName to support the\n automation to go to another specific step.

    " + "smithy.api#documentation": "

    The targets for the step execution.

    " } }, - "ExecutionStartTime": { - "target": "com.amazonaws.ssm#DateTime", + "OverriddenParameters": { + "target": "com.amazonaws.ssm#AutomationParameterMap", "traits": { - "smithy.api#documentation": "

    If a step has begun execution, this contains the time the step started. If the step is in\n Pending status, this field is not populated.

    " + "smithy.api#documentation": "

    A user-specified list of parameters to override when running a step.

    " } }, - "FailureMessage": { - "target": "com.amazonaws.ssm#String", + "Outputs": { + "target": "com.amazonaws.ssm#AutomationParameterMap", "traits": { - "smithy.api#documentation": "

    If a step failed, this message explains why the execution failed.

    " + "smithy.api#documentation": "

    Returned values from the execution of the step.

    " } }, - "StepName": { - "target": "com.amazonaws.ssm#String", + "ExecutionStartTime": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The name of this execution step.

    " + "smithy.api#documentation": "

    If a step has begun execution, this contains the time the step started. If the step is in\n Pending status, this field is not populated.

    " } }, - "IsEnd": { + "IsCritical": { "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    The flag which can be used to end automation no matter whether the step succeeds or\n fails.

    " + "smithy.api#documentation": "

    The flag which can be used to help decide whether the failure of current step leads to the\n Automation failure.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "ValidNextSteps": { + "target": "com.amazonaws.ssm#ValidNextStepList", "traits": { - "smithy.api#documentation": "

    The targets for the step execution.

    " + "smithy.api#documentation": "

    Strategies used when step fails, we support Continue and Abort. Abort will fail the\n automation when the step fails. Continue will ignore the failure of current step and allow\n automation to run the next step. With conditional branching, we add step:stepName to support the\n automation to go to another specific step.

    " } }, - "Inputs": { - "target": "com.amazonaws.ssm#NormalStringMap", + "MaxAttempts": { + "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

    Fully-resolved values passed into the step before execution.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of tries to run the action of the step. The default value is 1.

    " } }, - "NextStep": { - "target": "com.amazonaws.ssm#String", + "StepStatus": { + "target": "com.amazonaws.ssm#AutomationExecutionStatus", "traits": { - "smithy.api#documentation": "

    The next step after the step succeeds.

    " + "smithy.api#documentation": "

    The execution status for this step.

    " } }, - "OnFailure": { + "Response": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    The action to take if the step fails. The default value is Abort.

    " + "smithy.api#documentation": "

    A message associated with the response code for an execution.

    " } }, - "ExecutionEndTime": { - "target": "com.amazonaws.ssm#DateTime", + "NextStep": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    If a step has finished execution, this contains the time the execution ended. If the step\n has not yet concluded, this field is not populated.

    " + "smithy.api#documentation": "

    The next step after the step succeeds.

    " } }, - "Response": { + "StepExecutionId": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

    A message associated with the response code for an execution.

    " + "smithy.api#documentation": "

    The unique ID of a step execution.

    " } }, "ResponseCode": { @@ -20324,12 +20688,6 @@ "traits": { "smithy.api#documentation": "

    The response code returned by the execution of the step.

    " } - }, - "TargetLocation": { - "target": "com.amazonaws.ssm#TargetLocation", - "traits": { - "smithy.api#documentation": "

    The combination of AWS Regions and accounts targeted by the current Automation\n execution.

    " - } } }, "traits": { @@ -20575,20 +20933,20 @@ "com.amazonaws.ssm#Target": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.ssm#TargetKey", - "traits": { - "smithy.api#documentation": "

    User-defined criteria for sending commands that target instances that meet the\n criteria.

    " - } - }, "Values": { "target": "com.amazonaws.ssm#TargetValues", "traits": { "smithy.api#documentation": "

    User-defined criteria that maps to Key. For example, if you specified\n tag:ServerRole, you could specify value:WebServer to run a command on\n instances that include EC2 tags of ServerRole,WebServer.

    " } - } - }, - "traits": { + }, + "Key": { + "target": "com.amazonaws.ssm#TargetKey", + "traits": { + "smithy.api#documentation": "

    User-defined criteria for sending commands that target instances that meet the\n criteria.

    " + } + } + }, + "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
    • \n

      \n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n \n

      \n
      • \n
    • \n

      \n Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2\n \n

      \n
      • \n
    • \n

      \n Key=tag-key,Values=my-tag-key-1,my-tag-key-2\n \n

      \n
      • \n
    • \n

      \n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=resource-group-name\n \n

      \n
      • \n
    • \n

      \n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2\n \n

      \n
      • \n
    • \n

      \n Automation targets only:\n Key=ResourceGroup;Values=resource-group-name\n \n

      \n
      • \n
    \n

    For example:

    \n
      \n
    • \n

      \n Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE\n

      \n
      • \n
    • \n

      \n Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3\n

      \n
      • \n
    • \n

      \n Key=tag-key,Values=Name,Instance-Type,CostCenter\n

      \n
      • \n
    • \n

      \n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=ProductionResourceGroup\n

      \n

      This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

      \n
      • \n
    • \n

      \n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n \n

      \n

      This example demonstrates how to target only EC2 instances and VPCs in your maintenance\n window.

      \n
      • \n
    • \n

      \n Automation targets only:\n Key=ResourceGroup,Values=MyResourceGroup\n

      \n
      • \n
    • \n

      \n State Manager association targets only:\n Key=InstanceIds,Values=*\n \n

      \n

      This example demonstrates how to target all managed instances in the AWS Region where the\n association was created.

      \n
      • \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.

    " } }, @@ -20620,10 +20978,10 @@ "com.amazonaws.ssm#TargetLocation": { "type": "structure", "members": { - "ExecutionRoleName": { - "target": "com.amazonaws.ssm#ExecutionRoleName", + "TargetLocationMaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The Automation execution role used by the currently running Automation.

    " + "smithy.api#documentation": "

    The maximum number of AWS accounts and AWS regions allowed to run the Automation\n concurrently

    " } }, "Regions": { @@ -20632,22 +20990,22 @@ "smithy.api#documentation": "

    The AWS Regions targeted by the current Automation execution.

    " } }, - "TargetLocationMaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "Accounts": { + "target": "com.amazonaws.ssm#Accounts", "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 AWS accounts targeted by the current Automation execution.

    " } }, - "TargetLocationMaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "TargetLocationMaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "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 errors allowed before the system stops queueing additional Automation\n executions for the currently running Automation.

    " } }, - "Accounts": { - "target": "com.amazonaws.ssm#Accounts", + "ExecutionRoleName": { + "target": "com.amazonaws.ssm#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

    The AWS accounts targeted by the current Automation execution.

    " + "smithy.api#documentation": "

    The Automation execution role used by the currently running Automation.

    " } } }, @@ -20732,7 +21090,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The specified target instance for the session is not fully configured for use with Session Manager.\n For more information, see Getting started with\n Session Manager in the AWS Systems Manager User Guide.

    ", + "smithy.api#documentation": "

    The specified target instance for the session is not fully configured for use with Session Manager.\n For more information, see Getting started with\n Session Manager in the AWS Systems Manager User Guide. This error is also returned if you\n attempt to start a session on an instance that is located in a different account or Region

    ", "smithy.api#error": "client" } }, @@ -20875,6 +21233,12 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#UUID": { + "type": "string", + "traits": { + "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.ssm#UnsupportedCalendarException": { "type": "structure", "members": { @@ -20934,7 +21298,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The operating systems you specified is not supported, or the operation is not supported for\n the operating system. Valid operating systems include: Windows, AmazonLinux,\n RedhatEnterpriseLinux, and Ubuntu.

    ", + "smithy.api#documentation": "

    The operating systems you specified is not supported, or the operation is not supported for\n the operating system.

    ", "smithy.api#error": "client" } }, @@ -21015,35 +21379,34 @@ "com.amazonaws.ssm#UpdateAssociationRequest": { "type": "structure", "members": { - "AssociationId": { - "target": "com.amazonaws.ssm#AssociationId", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    The ID of the association you want to update.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " } }, - "AutomationTargetParameterName": { - "target": "com.amazonaws.ssm#AutomationTargetParameterName", + "Parameters": { + "target": "com.amazonaws.ssm#Parameters", "traits": { - "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " + "smithy.api#documentation": "

    The parameters you want to update for the association. If you create a parameter using\n Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "ScheduleExpression": { + "target": "com.amazonaws.ssm#ScheduleExpression", "traits": { - "smithy.api#documentation": "

    The targets of the association.

    " + "smithy.api#documentation": "

    The cron expression used to schedule the association that you want to update.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "Name": { + "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

    The document version you want update for the association.

    " + "smithy.api#documentation": "

    The name of the SSM document that contains the configuration information for the instance.\n You can specify Command or Automation documents.

    \n

    You can specify AWS-predefined documents, documents you created, or a document that is\n shared with you from another account.

    \n

    For SSM documents that are shared with you from other AWS accounts, you must specify the\n complete SSM document ARN, in the following format:

    \n

    \n arn:aws:ssm:region:account-id:document/document-name\n \n

    \n

    For example:

    \n

    \n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

    \n

    For AWS-predefined documents and SSM documents you created in your account, you only need to\n specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.

    " } }, - "AssociationVersion": { - "target": "com.amazonaws.ssm#AssociationVersion", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    This parameter is provided for concurrency control purposes. You must specify the latest\n association version in the service. If you want to ensure that this request succeeds, either\n specify $LATEST, or omit this parameter.

    " + "smithy.api#documentation": "

    The targets of the association.

    " } }, "ComplianceSeverity": { @@ -21052,40 +21415,35 @@ "smithy.api#documentation": "

    The severity level to assign to the association.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#DocumentARN", - "traits": { - "smithy.api#documentation": "

    The name of the SSM document that contains the configuration information for the instance.\n You can specify Command or Automation documents.

    \n

    You can specify AWS-predefined documents, documents you created, or a document that is\n shared with you from another account.

    \n

    For SSM documents that are shared with you from other AWS accounts, you must specify the\n complete SSM document ARN, in the following format:

    \n

    \n arn:aws:ssm:region:account-id:document/document-name\n \n

    \n

    For example:

    \n

    \n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

    \n

    For AWS-predefined documents and SSM documents you created in your account, you only need to\n specify the document name. For example, AWS-ApplyPatchBaseline or\n My-Document.

    " - } - }, - "ScheduleExpression": { - "target": "com.amazonaws.ssm#ScheduleExpression", + "AssociationVersion": { + "target": "com.amazonaws.ssm#AssociationVersion", "traits": { - "smithy.api#documentation": "

    The cron expression used to schedule the association that you want to update.

    " + "smithy.api#documentation": "

    This parameter is provided for concurrency control purposes. You must specify the latest\n association version in the service. If you want to ensure that this request succeeds, either\n specify $LATEST, or omit this parameter.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

    The number of errors that are allowed before the system stops sending requests to run the\n association on additional targets. You can specify either an absolute number of errors, for\n example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,\n the system stops sending requests when the fourth error is received. If you specify 0, then the\n system stops sending requests after the first error is returned. If you run an association on 50\n instances and set MaxError to 10%, then the system stops sending the request when the sixth error\n is received.

    \n

    Executions that are already running an association when MaxErrors is reached are allowed to\n complete, but some of these executions may fail as well. If you need to ensure that there won't\n be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one\n at a time.

    " + "smithy.api#documentation": "

    The document version you want update for the association.

    " } }, - "ApplyOnlyAtCronInterval": { - "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", + "AssociationId": { + "target": "com.amazonaws.ssm#AssociationId", "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.

    \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.

    " + "smithy.api#documentation": "

    The ID of the association you want to update.

    ", + "smithy.api#required": {} } }, - "AssociationName": { - "target": "com.amazonaws.ssm#AssociationName", + "AutomationTargetParameterName": { + "target": "com.amazonaws.ssm#AutomationTargetParameterName", "traits": { - "smithy.api#documentation": "

    The name of the association that you want to update.

    " + "smithy.api#documentation": "

    Specify the target for the association. This target is required for associations that use an\n Automation document and target resources by using rate controls.

    " } }, - "Parameters": { - "target": "com.amazonaws.ssm#Parameters", + "SyncCompliance": { + "target": "com.amazonaws.ssm#AssociationSyncCompliance", "traits": { - "smithy.api#documentation": "

    The parameters you want to update for the association. If you create a parameter using\n Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

    " + "smithy.api#documentation": "

    The mode for generating association compliance. You can specify AUTO or\n MANUAL. In AUTO mode, the system uses the status of the association\n execution to determine the compliance status. If the association execution runs successfully,\n then the association is COMPLIANT. If the association execution doesn't run\n successfully, the association is NON-COMPLIANT.

    \n

    In MANUAL mode, you must specify the AssociationId as a parameter\n for the PutComplianceItems API action. In this case, compliance data is not\n managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

    \n

    By default, all associations use AUTO mode.

    " } }, "OutputLocation": { @@ -21094,16 +21452,22 @@ "smithy.api#documentation": "

    An S3 bucket where you want to store the results of this request.

    " } }, + "ApplyOnlyAtCronInterval": { + "target": "com.amazonaws.ssm#ApplyOnlyAtCronInterval", + "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.

    \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.

    " + } + }, "MaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { "smithy.api#documentation": "

    The maximum number of targets allowed to run the association at the same time. You can\n specify a number, for example 10, or a percentage of the target set, for example 10%. The default\n value is 100%, which means all targets run the association at the same time.

    \n

    If a new instance starts and attempts to run an association while Systems Manager is running\n MaxConcurrency associations, the association is allowed to run. During the next association\n interval, the new instance will process its association within the limit specified for\n MaxConcurrency.

    " } }, - "SyncCompliance": { - "target": "com.amazonaws.ssm#AssociationSyncCompliance", + "AssociationName": { + "target": "com.amazonaws.ssm#AssociationName", "traits": { - "smithy.api#documentation": "

    The mode for generating association compliance. You can specify AUTO or\n MANUAL. In AUTO mode, the system uses the status of the association\n execution to determine the compliance status. If the association execution runs successfully,\n then the association is COMPLIANT. If the association execution doesn't run\n successfully, the association is NON-COMPLIANT.

    \n

    In MANUAL mode, you must specify the AssociationId as a parameter\n for the PutComplianceItems API action. In this case, compliance data is not\n managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

    \n

    By default, all associations use AUTO mode.

    " + "smithy.api#documentation": "

    The name of the association that you want to update.

    " } } } @@ -21261,17 +21625,17 @@ "com.amazonaws.ssm#UpdateDocumentDefaultVersionRequest": { "type": "structure", "members": { - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersionNumber", + "Name": { + "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

    The version of a custom document that you want to set as the default version.

    ", + "smithy.api#documentation": "

    The name of a custom document that you want to set as the default version.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.ssm#DocumentName", + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersionNumber", "traits": { - "smithy.api#documentation": "

    The name of a custom document that you want to set as the default version.

    ", + "smithy.api#documentation": "

    The version of a custom document that you want to set as the default version.

    ", "smithy.api#required": {} } } @@ -21291,13 +21655,6 @@ "com.amazonaws.ssm#UpdateDocumentRequest": { "type": "structure", "members": { - "Content": { - "target": "com.amazonaws.ssm#DocumentContent", - "traits": { - "smithy.api#documentation": "

    A valid JSON or YAML string.

    ", - "smithy.api#required": {} - } - }, "TargetType": { "target": "com.amazonaws.ssm#TargetType", "traits": { @@ -21310,12 +21667,6 @@ "smithy.api#documentation": "

    An optional field specifying the version of the artifact you are updating with the document.\n For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and\n cannot be changed.

    " } }, - "Attachments": { - "target": "com.amazonaws.ssm#AttachmentsSourceList", - "traits": { - "smithy.api#documentation": "

    A list of key and value pairs that describe attachments to a version of a document.

    " - } - }, "Name": { "target": "com.amazonaws.ssm#DocumentName", "traits": { @@ -21323,16 +21674,29 @@ "smithy.api#required": {} } }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

    (Required) The latest version of the document that you want to update. The latest document\n version can be specified using the $LATEST variable or by the version number. Updating a previous\n version of a document is not supported.

    " + } + }, + "Attachments": { + "target": "com.amazonaws.ssm#AttachmentsSourceList", + "traits": { + "smithy.api#documentation": "

    A list of key and value pairs that describe attachments to a version of a document.

    " + } + }, "DocumentFormat": { "target": "com.amazonaws.ssm#DocumentFormat", "traits": { "smithy.api#documentation": "

    Specify the document format for the new document version. Systems Manager supports JSON and YAML\n documents. JSON is the default format.

    " } }, - "DocumentVersion": { - "target": "com.amazonaws.ssm#DocumentVersion", + "Content": { + "target": "com.amazonaws.ssm#DocumentContent", "traits": { - "smithy.api#documentation": "

    (Required) The latest version of the document that you want to update. The latest document\n version can be specified using the $LATEST variable or by the version number. Updating a previous\n version of a document is not supported.

    " + "smithy.api#documentation": "

    A valid JSON or YAML string.

    ", + "smithy.api#required": {} } } } @@ -21371,43 +21735,43 @@ "com.amazonaws.ssm#UpdateMaintenanceWindowRequest": { "type": "structure", "members": { - "Schedule": { - "target": "com.amazonaws.ssm#MaintenanceWindowSchedule", + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { - "smithy.api#documentation": "

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + "smithy.api#documentation": "

    The name of the maintenance window.

    " } }, - "Duration": { - "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", + "EndDate": { + "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The duration of the maintenance window in hours.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become inactive. EndDate allows you to set a date and time in the future when the maintenance\n window will no longer run.

    " } }, - "Enabled": { - "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", + "ScheduleTimezone": { + "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Whether the maintenance window is enabled.

    " + "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.

    " } }, - "AllowUnassociatedTargets": { - "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", + "Replace": { + "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.

    " + "smithy.api#documentation": "

    If True, then all fields that are required by the CreateMaintenanceWindow action are also\n required for this API request. Optional fields that are not specified are set to null.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#MaintenanceWindowDescription", + "ScheduleOffset": { + "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { - "smithy.api#documentation": "

    An optional description for the update request.

    " + "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.

    " } }, - "ScheduleTimezone": { - "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "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 ID of the maintenance window to update.

    ", + "smithy.api#required": {} } }, "Cutoff": { @@ -21417,43 +21781,43 @@ "smithy.api#documentation": "

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new\n tasks for execution.

    " } }, - "Replace": { - "target": "com.amazonaws.ssm#Boolean", + "Enabled": { + "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

    If True, then all fields that are required by the CreateMaintenanceWindow action are also\n required for this API request. Optional fields that are not specified are set to null.

    " + "smithy.api#documentation": "

    Whether the maintenance window is enabled.

    " } }, - "ScheduleOffset": { - "target": "com.amazonaws.ssm#MaintenanceWindowOffset", + "Schedule": { + "target": "com.amazonaws.ssm#MaintenanceWindowSchedule", "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 schedule of the maintenance window in the form of a cron or rate expression.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", + "Duration": { + "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", "traits": { - "smithy.api#documentation": "

    The name of the maintenance window.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The duration of the maintenance window in hours.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "StartDate": { + "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window to update.

    ", - "smithy.api#required": {} + "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.

    " } }, - "EndDate": { - "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", + "Description": { + "target": "com.amazonaws.ssm#MaintenanceWindowDescription", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to\n become inactive. EndDate allows you to set a date and time in the future when the maintenance\n window will no longer run.

    " + "smithy.api#documentation": "

    An optional description for the update request.

    " } }, - "StartDate": { - "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", + "AllowUnassociatedTargets": { + "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", "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#box": {}, + "smithy.api#documentation": "

    Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.

    " } } } @@ -21461,28 +21825,34 @@ "com.amazonaws.ssm#UpdateMaintenanceWindowResult": { "type": "structure", "members": { - "ScheduleTimezone": { - "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", + "Description": { + "target": "com.amazonaws.ssm#MaintenanceWindowDescription", "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": "

    An optional description of the update.

    " } }, - "StartDate": { - "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become active. The maintenance window will not run before this specified time.

    " + "smithy.api#documentation": "

    The ID of the created maintenance window.

    " } }, - "Duration": { - "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", - "traits": { - "smithy.api#documentation": "

    The duration of the maintenance window in hours.

    " + "AllowUnassociatedTargets": { + "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", + "traits": { + "smithy.api#documentation": "

    Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", + "Enabled": { + "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", "traits": { - "smithy.api#documentation": "

    The name of the maintenance window.

    " + "smithy.api#documentation": "

    Whether the maintenance window is enabled.

    " + } + }, + "Cutoff": { + "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", + "traits": { + "smithy.api#documentation": "

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new\n tasks for execution.

    " } }, "Schedule": { @@ -21497,41 +21867,35 @@ "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become inactive. The maintenance window will not run after this specified time.

    " } }, - "Enabled": { - "target": "com.amazonaws.ssm#MaintenanceWindowEnabled", - "traits": { - "smithy.api#documentation": "

    Whether the maintenance window is enabled.

    " - } - }, - "Cutoff": { - "target": "com.amazonaws.ssm#MaintenanceWindowCutoff", + "Duration": { + "target": "com.amazonaws.ssm#MaintenanceWindowDurationHours", "traits": { - "smithy.api#documentation": "

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new\n tasks for execution.

    " + "smithy.api#documentation": "

    The duration of the maintenance window in hours.

    " } }, - "AllowUnassociatedTargets": { - "target": "com.amazonaws.ssm#MaintenanceWindowAllowUnassociatedTargets", + "ScheduleOffset": { + "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { - "smithy.api#documentation": "

    Whether targets must be registered with the maintenance window before tasks can be defined\n for those targets.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The number of days to wait to run a maintenance window after the scheduled CRON expression\n date and time.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "ScheduleTimezone": { + "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", "traits": { - "smithy.api#documentation": "

    The ID of the created maintenance window.

    " + "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.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#MaintenanceWindowDescription", + "StartDate": { + "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

    An optional description of the update.

    " + "smithy.api#documentation": "

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled\n to become active. The maintenance window will not run before this specified time.

    " } }, - "ScheduleOffset": { - "target": "com.amazonaws.ssm#MaintenanceWindowOffset", + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The number of days to wait to run a maintenance window after the scheduled CRON expression\n date and time.

    " + "smithy.api#documentation": "

    The name of the maintenance window.

    " } } } @@ -21559,10 +21923,11 @@ "com.amazonaws.ssm#UpdateMaintenanceWindowTargetRequest": { "type": "structure", "members": { - "OwnerInformation": { - "target": "com.amazonaws.ssm#OwnerInformation", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#documentation": "

    User-provided value that will be included in any CloudWatch events raised while running\n tasks for these targets in this maintenance window.

    " + "smithy.api#documentation": "

    The maintenance window ID with which to modify the target.

    ", + "smithy.api#required": {} } }, "Description": { @@ -21584,10 +21949,10 @@ "smithy.api#documentation": "

    If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action\n are also required for this API request. Optional fields that are not specified are set to\n null.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "WindowTargetId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", "traits": { - "smithy.api#documentation": "

    The maintenance window ID with which to modify the target.

    ", + "smithy.api#documentation": "

    The target ID to modify.

    ", "smithy.api#required": {} } }, @@ -21597,11 +21962,10 @@ "smithy.api#documentation": "

    A name for the update.

    " } }, - "WindowTargetId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", + "OwnerInformation": { + "target": "com.amazonaws.ssm#OwnerInformation", "traits": { - "smithy.api#documentation": "

    The target ID to modify.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    User-provided value that will be included in any CloudWatch events raised while running\n tasks for these targets in this maintenance window.

    " } } } @@ -21609,10 +21973,10 @@ "com.amazonaws.ssm#UpdateMaintenanceWindowTargetResult": { "type": "structure", "members": { - "OwnerInformation": { - "target": "com.amazonaws.ssm#OwnerInformation", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#documentation": "

    The updated owner.

    " + "smithy.api#documentation": "

    The maintenance window ID specified in the update request.

    " } }, "Description": { @@ -21621,28 +21985,28 @@ "smithy.api#documentation": "

    The updated description.

    " } }, - "WindowTargetId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The target ID specified in the update request.

    " + "smithy.api#documentation": "

    The updated targets.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", + "OwnerInformation": { + "target": "com.amazonaws.ssm#OwnerInformation", "traits": { - "smithy.api#documentation": "

    The updated name.

    " + "smithy.api#documentation": "

    The updated owner.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { - "smithy.api#documentation": "

    The updated targets.

    " + "smithy.api#documentation": "

    The updated name.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "WindowTargetId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTargetId", "traits": { - "smithy.api#documentation": "

    The maintenance window ID specified in the update request.

    " + "smithy.api#documentation": "

    The target ID specified in the update request.

    " } } } @@ -21664,41 +22028,30 @@ } ], "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
    • \n

      TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to\n AWS-RunShellScript.

      \n
      • \n
    • \n

      ServiceRoleArn

      \n
      • \n
    • \n

      TaskInvocationParameters

      \n
      • \n
    • \n

      Priority

      \n
      • \n
    • \n

      MaxConcurrency

      \n
      • \n
    • \n

      MaxErrors

      \n
      • \n
    \n

    If a parameter is null, then the corresponding field is not modified. Also, if you set\n Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional\n fields that aren't specified are set to null.

    " + "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

      TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to\n AWS-RunShellScript.

      \n
      • \n
    • \n

      ServiceRoleArn

      \n
      • \n
    • \n

      TaskInvocationParameters

      \n
      • \n
    • \n

      Priority

      \n
      • \n
    • \n

      MaxConcurrency

      \n
      • \n
    • \n

      MaxErrors

      \n
      • \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": { "type": "structure", "members": { - "Replace": { - "target": "com.amazonaws.ssm#Boolean", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action\n are also required for this API request. Optional fields that are not specified are set to\n null.

    " - } - }, - "LoggingInfo": { - "target": "com.amazonaws.ssm#LoggingInfo", - "traits": { - "smithy.api#documentation": "

    The new logging location in Amazon S3 to specify.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " - } - }, - "Description": { - "target": "com.amazonaws.ssm#MaintenanceWindowDescription", + "WindowTaskId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", "traits": { - "smithy.api#documentation": "

    The new task description to specify.

    " + "smithy.api#documentation": "

    The task ID to modify.

    ", + "smithy.api#required": {} } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "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 maintenance window ID that contains the task to modify.

    ", + "smithy.api#required": {} } }, - "TaskArn": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The task ARN to modify.

    " + "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.

    " } }, "Name": { @@ -21707,30 +22060,41 @@ "smithy.api#documentation": "

    The new task name to specify.

    " } }, + "TaskParameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskParameters", + "traits": { + "smithy.api#documentation": "

    The parameters to modify.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     \n

    The map has the following format:

    \n

    Key: string, between 1 and 255 characters

    \n

    Value: an array of strings, each string is between 1 and 255 characters

    " + } + }, "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.

    " } }, - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "TaskInvocationParameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters", "traits": { - "smithy.api#documentation": "

    The maintenance window ID that contains the task to modify.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The parameters that the task should use during execution. Populate only the fields that\n match the task type. All other fields should be empty.

    \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     " } }, - "Priority": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", + "Description": { + "target": "com.amazonaws.ssm#MaintenanceWindowDescription", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    The new task priority to specify. The lower the number, the higher the priority. Tasks that\n have the same priority are scheduled in parallel.

    " + "smithy.api#documentation": "

    The new task description to specify.

    " } }, - "TaskParameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskParameters", + "LoggingInfo": { + "target": "com.amazonaws.ssm#LoggingInfo", "traits": { - "smithy.api#documentation": "

    The parameters to modify.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     \n

    The map has the following format:

    \n

    Key: string, between 1 and 255 characters

    \n

    Value: an array of strings, each string is between 1 and 255 characters

    " + "smithy.api#documentation": "

    The new logging location in Amazon S3 to specify.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " + } + }, + "Replace": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action\n are also required for this API request. Optional fields that are not specified are set to\n null.

    " } }, "ServiceRoleArn": { @@ -21739,23 +22103,23 @@ "smithy.api#documentation": "

    The ARN of the IAM service role for Systems Manager to assume when running a \n maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's \n service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run \n RegisterTaskWithMaintenanceWindow.

    \n

    For more information, see the following topics in the in the AWS Systems Manager User Guide:

    \n " } }, - "WindowTaskId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", + "TaskArn": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", "traits": { - "smithy.api#documentation": "

    The task ID to modify.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The task ARN to modify.

    " } }, - "TaskInvocationParameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters", + "Priority": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskPriority", "traits": { - "smithy.api#documentation": "

    The parameters that the task should use during execution. Populate only the fields that\n match the task type. All other fields should be empty.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    The new task priority to specify. The lower the number, the higher the priority. Tasks that\n have the same priority are scheduled in parallel.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "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 MaxErrors value to specify. MaxErrors is the maximum\n number of errors that are allowed before the task stops being scheduled.

    " } } } @@ -21763,22 +22127,22 @@ "com.amazonaws.ssm#UpdateMaintenanceWindowTaskResult": { "type": "structure", "members": { - "WindowId": { - "target": "com.amazonaws.ssm#MaintenanceWindowId", + "Targets": { + "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

    The ID of the maintenance window that was updated.

    " + "smithy.api#documentation": "

    The updated target values.

    " } }, - "Name": { - "target": "com.amazonaws.ssm#MaintenanceWindowName", + "LoggingInfo": { + "target": "com.amazonaws.ssm#LoggingInfo", "traits": { - "smithy.api#documentation": "

    The updated task name.

    " + "smithy.api#documentation": "

    The updated logging information in Amazon S3.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " } }, - "TaskInvocationParameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters", + "TaskArn": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", "traits": { - "smithy.api#documentation": "

    The updated parameter values.

    " + "smithy.api#documentation": "

    The updated task ARN value.

    " } }, "Priority": { @@ -21787,16 +22151,16 @@ "smithy.api#documentation": "

    The updated priority value.

    " } }, - "TaskParameters": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskParameters", + "TaskInvocationParameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskInvocationParameters", "traits": { - "smithy.api#documentation": "

    The updated parameter values.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     " + "smithy.api#documentation": "

    The updated parameter values.

    " } }, - "Targets": { - "target": "com.amazonaws.ssm#Targets", + "WindowId": { + "target": "com.amazonaws.ssm#MaintenanceWindowId", "traits": { - "smithy.api#documentation": "

    The updated target values.

    " + "smithy.api#documentation": "

    The ID of the maintenance window that was updated.

    " } }, "ServiceRoleArn": { @@ -21805,40 +22169,40 @@ "smithy.api#documentation": "

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for\n maintenance window Run Command tasks.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#MaintenanceWindowDescription", + "TaskParameters": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskParameters", "traits": { - "smithy.api#documentation": "

    The updated task description.

    " + "smithy.api#documentation": "

    The updated parameter values.

    \n \n

    \n TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,\n instead use the Parameters option in the TaskInvocationParameters structure. For information\n about how Systems Manager handles these options for the supported maintenance window task\n types, see MaintenanceWindowTaskInvocationParameters.

    \n     " } }, - "LoggingInfo": { - "target": "com.amazonaws.ssm#LoggingInfo", + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

    The updated logging information in Amazon S3.

    \n \n

    \n LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the\n OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.\n For information about how Systems Manager handles these options for the supported maintenance\n window task types, see MaintenanceWindowTaskInvocationParameters.

    \n     " + "smithy.api#documentation": "

    The updated MaxConcurrency value.

    " } }, - "MaxErrors": { - "target": "com.amazonaws.ssm#MaxErrors", + "WindowTaskId": { + "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", "traits": { - "smithy.api#documentation": "

    The updated MaxErrors value.

    " + "smithy.api#documentation": "

    The task ID of the maintenance window that was updated.

    " } }, - "TaskArn": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskArn", + "Name": { + "target": "com.amazonaws.ssm#MaintenanceWindowName", "traits": { - "smithy.api#documentation": "

    The updated task ARN value.

    " + "smithy.api#documentation": "

    The updated task name.

    " } }, - "MaxConcurrency": { - "target": "com.amazonaws.ssm#MaxConcurrency", + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

    The updated MaxConcurrency value.

    " + "smithy.api#documentation": "

    The updated MaxErrors value.

    " } }, - "WindowTaskId": { - "target": "com.amazonaws.ssm#MaintenanceWindowTaskId", + "Description": { + "target": "com.amazonaws.ssm#MaintenanceWindowDescription", "traits": { - "smithy.api#documentation": "

    The task ID of the maintenance window that was updated.

    " + "smithy.api#documentation": "

    The updated task description.

    " } } } @@ -21918,18 +22282,6 @@ "com.amazonaws.ssm#UpdateOpsItemRequest": { "type": "structure", "members": { - "OperationalDataToDelete": { - "target": "com.amazonaws.ssm#OpsItemOpsDataKeysList", - "traits": { - "smithy.api#documentation": "

    Keys that you want to remove from the OperationalData map.

    " - } - }, - "Description": { - "target": "com.amazonaws.ssm#OpsItemDescription", - "traits": { - "smithy.api#documentation": "

    Update the information about the OpsItem. Provide enough information so that users reading\n this OpsItem for the first time understand the issue.

    " - } - }, "OpsItemId": { "target": "com.amazonaws.ssm#OpsItemId", "traits": { @@ -21943,6 +22295,18 @@ "smithy.api#documentation": "

    Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem\n object.

    \n

    Operational data is custom data that provides useful reference details about the OpsItem.\n For example, you can specify log files, error strings, license keys, troubleshooting tips, or\n other relevant data. You enter operational data as key-value pairs. The key has a maximum length\n of 128 characters. The value has a maximum size of 20 KB.

    \n\n \n

    Operational data keys can't begin with the following: amazon, aws,\n amzn, ssm, /amazon, /aws, /amzn, /ssm.

    \n     \n\n

    You can choose to make the data searchable by other users in the account or you can restrict\n search access. Searchable data means that all users with access to the OpsItem Overview page (as\n provided by the DescribeOpsItems API action) can view and search on the\n specified data. Operational data that is not searchable is only viewable by users who have access\n to the OpsItem (as provided by the GetOpsItem API action).

    \n\n

    Use the /aws/resources key in OperationalData to specify a related resource in\n the request. Use the /aws/automations key in OperationalData to associate an\n Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see\n Creating OpsItems manually in the AWS Systems Manager User Guide.

    " } }, + "Notifications": { + "target": "com.amazonaws.ssm#OpsItemNotifications", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this\n OpsItem is edited or changed.

    " + } + }, + "Priority": { + "target": "com.amazonaws.ssm#OpsItemPriority", + "traits": { + "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + } + }, "Category": { "target": "com.amazonaws.ssm#OpsItemCategory", "traits": { @@ -21955,34 +22319,34 @@ "smithy.api#documentation": "

    One or more OpsItems that share something in common with the current OpsItems. For example,\n related OpsItems can include OpsItems with similar error messages, impacted resources, or\n statuses for the impacted resource.

    " } }, - "Notifications": { - "target": "com.amazonaws.ssm#OpsItemNotifications", + "Status": { + "target": "com.amazonaws.ssm#OpsItemStatus", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this\n OpsItem is edited or changed.

    " + "smithy.api#documentation": "

    The OpsItem status. Status can be Open, In Progress, or\n Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

    " } }, - "Title": { - "target": "com.amazonaws.ssm#OpsItemTitle", + "Severity": { + "target": "com.amazonaws.ssm#OpsItemSeverity", "traits": { - "smithy.api#documentation": "

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " + "smithy.api#documentation": "

    Specify a new severity for an OpsItem.

    " } }, - "Status": { - "target": "com.amazonaws.ssm#OpsItemStatus", + "Description": { + "target": "com.amazonaws.ssm#OpsItemDescription", "traits": { - "smithy.api#documentation": "

    The OpsItem status. Status can be Open, In Progress, or\n Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    Update the information about the OpsItem. Provide enough information so that users reading\n this OpsItem for the first time understand the issue.

    " } }, - "Priority": { - "target": "com.amazonaws.ssm#OpsItemPriority", + "OperationalDataToDelete": { + "target": "com.amazonaws.ssm#OpsItemOpsDataKeysList", "traits": { - "smithy.api#documentation": "

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + "smithy.api#documentation": "

    Keys that you want to remove from the OperationalData map.

    " } }, - "Severity": { - "target": "com.amazonaws.ssm#OpsItemSeverity", + "Title": { + "target": "com.amazonaws.ssm#OpsItemTitle", "traits": { - "smithy.api#documentation": "

    Specify a new severity for an OpsItem.

    " + "smithy.api#documentation": "

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " } } } @@ -22014,16 +22378,17 @@ "com.amazonaws.ssm#UpdatePatchBaselineRequest": { "type": "structure", "members": { - "RejectedPatches": { - "target": "com.amazonaws.ssm#PatchIdList", + "BaselineId": { + "target": "com.amazonaws.ssm#BaselineId", "traits": { - "smithy.api#documentation": "

    A list of explicitly rejected patches for the baseline.

    \n

    For information about accepted formats for lists of approved patches and rejected patches,\n see About\n package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

    " + "smithy.api#documentation": "

    The ID of the patch baseline to update.

    ", + "smithy.api#required": {} } }, - "GlobalFilters": { - "target": "com.amazonaws.ssm#PatchFilterGroup", + "RejectedPatchesAction": { + "target": "com.amazonaws.ssm#PatchAction", "traits": { - "smithy.api#documentation": "

    A set of global filters used to include patches in the baseline.

    " + "smithy.api#documentation": "

    The action for Patch Manager to take on patches included in the RejectedPackages\n list.

    \n
      \n
    • \n

      \n ALLOW_AS_DEPENDENCY: A package in the Rejected patches\n list is installed only if it is a dependency of another package. It is considered compliant\n with the patch baseline, and its status is reported as InstalledOther.\n This is the default action if no option is specified.

      \n
      • \n
    • \n

      \n BLOCK: Packages in the RejectedPatches list, and packages\n that include them as dependencies, are not installed under any circumstances. If a package was\n installed before it was added to the Rejected patches list, it is considered non-compliant with\n the patch baseline, and its status is reported as\n InstalledRejected.

      \n
      • \n
    " } }, "ApprovedPatches": { @@ -22032,29 +22397,29 @@ "smithy.api#documentation": "

    A list of explicitly approved patches for the baseline.

    \n

    For information about accepted formats for lists of approved patches and rejected patches,\n see About\n package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

    " } }, - "Sources": { - "target": "com.amazonaws.ssm#PatchSourceList", + "Replace": { + "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    If True, then all fields that are required by the CreatePatchBaseline action are also\n required for this API request. Optional fields that are not specified are set to null.

    " } }, - "RejectedPatchesAction": { - "target": "com.amazonaws.ssm#PatchAction", + "RejectedPatches": { + "target": "com.amazonaws.ssm#PatchIdList", "traits": { - "smithy.api#documentation": "

    The action for Patch Manager to take on patches included in the RejectedPackages\n list.

    \n
      \n
    • \n

      \n ALLOW_AS_DEPENDENCY: A package in the Rejected patches\n list is installed only if it is a dependency of another package. It is considered compliant\n with the patch baseline, and its status is reported as InstalledOther.\n This is the default action if no option is specified.

      \n
      • \n
    • \n

      \n BLOCK: Packages in the RejectedPatches list, and packages\n that include them as dependencies, are not installed under any circumstances. If a package was\n installed before it was added to the Rejected patches list, it is considered non-compliant with\n the patch baseline, and its status is reported as\n InstalledRejected.

      \n
      • \n
    " + "smithy.api#documentation": "

    A list of explicitly rejected patches for the baseline.

    \n

    For information about accepted formats for lists of approved patches and rejected patches,\n see About\n package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

    " } }, - "Description": { - "target": "com.amazonaws.ssm#BaselineDescription", + "ApprovalRules": { + "target": "com.amazonaws.ssm#PatchRuleGroup", "traits": { - "smithy.api#documentation": "

    A description of the patch baseline.

    " + "smithy.api#documentation": "

    A set of rules used to include patches in the baseline.

    " } }, - "Replace": { - "target": "com.amazonaws.ssm#Boolean", + "GlobalFilters": { + "target": "com.amazonaws.ssm#PatchFilterGroup", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    If True, then all fields that are required by the CreatePatchBaseline action are also\n required for this API request. Optional fields that are not specified are set to null.

    " + "smithy.api#documentation": "

    A set of global filters used to include patches in the baseline.

    " } }, "ApprovedPatchesComplianceLevel": { @@ -22063,24 +22428,23 @@ "smithy.api#documentation": "

    Assigns a new compliance severity level to an existing patch baseline.

    " } }, - "ApprovedPatchesEnableNonSecurity": { - "target": "com.amazonaws.ssm#Boolean", + "Sources": { + "target": "com.amazonaws.ssm#PatchSourceList", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is 'false'. Applies to Linux instances only.

    " + "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " } }, - "ApprovalRules": { - "target": "com.amazonaws.ssm#PatchRuleGroup", + "Description": { + "target": "com.amazonaws.ssm#BaselineDescription", "traits": { - "smithy.api#documentation": "

    A set of rules used to include patches in the baseline.

    " + "smithy.api#documentation": "

    A description of the patch baseline.

    " } }, - "BaselineId": { - "target": "com.amazonaws.ssm#BaselineId", + "ApprovedPatchesEnableNonSecurity": { + "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#documentation": "

    The ID of the patch baseline to update.

    ", - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "

    Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is 'false'. Applies to Linux instances only.

    " } }, "Name": { @@ -22094,23 +22458,16 @@ "com.amazonaws.ssm#UpdatePatchBaselineResult": { "type": "structure", "members": { - "ApprovedPatchesEnableNonSecurity": { - "target": "com.amazonaws.ssm#Boolean", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

    Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is 'false'. Applies to Linux instances only.

    " - } - }, - "ModifiedDate": { + "CreatedDate": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    The date when the patch baseline was last modified.

    " + "smithy.api#documentation": "

    The date when the patch baseline was created.

    " } }, - "RejectedPatches": { - "target": "com.amazonaws.ssm#PatchIdList", + "ApprovedPatchesComplianceLevel": { + "target": "com.amazonaws.ssm#PatchComplianceLevel", "traits": { - "smithy.api#documentation": "

    A list of explicitly rejected patches for the baseline.

    " + "smithy.api#documentation": "

    The compliance severity level assigned to the patch baseline after the update\n completed.

    " } }, "ApprovedPatches": { @@ -22119,28 +22476,34 @@ "smithy.api#documentation": "

    A list of explicitly approved patches for the baseline.

    " } }, + "RejectedPatchesAction": { + "target": "com.amazonaws.ssm#PatchAction", + "traits": { + "smithy.api#documentation": "

    The action specified to take on patches included in the RejectedPatches list. A patch can be\n allowed only if it is a dependency of another package, or blocked entirely along with packages\n that include it as a dependency.

    " + } + }, "ApprovalRules": { "target": "com.amazonaws.ssm#PatchRuleGroup", "traits": { "smithy.api#documentation": "

    A set of rules used to include patches in the baseline.

    " } }, - "Sources": { - "target": "com.amazonaws.ssm#PatchSourceList", + "ModifiedDate": { + "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " + "smithy.api#documentation": "

    The date when the patch baseline was last modified.

    " } }, - "RejectedPatchesAction": { - "target": "com.amazonaws.ssm#PatchAction", + "Sources": { + "target": "com.amazonaws.ssm#PatchSourceList", "traits": { - "smithy.api#documentation": "

    The action specified to take on patches included in the RejectedPatches list. A patch can be\n allowed only if it is a dependency of another package, or blocked entirely along with packages\n that include it as a dependency.

    " + "smithy.api#documentation": "

    Information about the patches to use to update the instances, including target operating\n systems and source repositories. Applies to Linux instances only.

    " } }, - "ApprovedPatchesComplianceLevel": { - "target": "com.amazonaws.ssm#PatchComplianceLevel", + "RejectedPatches": { + "target": "com.amazonaws.ssm#PatchIdList", "traits": { - "smithy.api#documentation": "

    The compliance severity level assigned to the patch baseline after the update\n completed.

    " + "smithy.api#documentation": "

    A list of explicitly rejected patches for the baseline.

    " } }, "Name": { @@ -22149,16 +22512,17 @@ "smithy.api#documentation": "

    The name of the patch baseline.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.ssm#DateTime", + "ApprovedPatchesEnableNonSecurity": { + "target": "com.amazonaws.ssm#Boolean", "traits": { - "smithy.api#documentation": "

    The date when the patch baseline was created.

    " + "smithy.api#box": {}, + "smithy.api#documentation": "

    Indicates whether the list of approved patches includes non-security updates that should be\n applied to the instances. The default value is 'false'. Applies to Linux instances only.

    " } }, - "GlobalFilters": { - "target": "com.amazonaws.ssm#PatchFilterGroup", + "OperatingSystem": { + "target": "com.amazonaws.ssm#OperatingSystem", "traits": { - "smithy.api#documentation": "

    A set of global filters used to exclude patches from the baseline.

    " + "smithy.api#documentation": "

    The operating system rule used by the updated patch baseline.

    " } }, "BaselineId": { @@ -22167,17 +22531,17 @@ "smithy.api#documentation": "

    The ID of the deleted patch baseline.

    " } }, - "OperatingSystem": { - "target": "com.amazonaws.ssm#OperatingSystem", - "traits": { - "smithy.api#documentation": "

    The operating system rule used by the updated patch baseline.

    " - } - }, "Description": { "target": "com.amazonaws.ssm#BaselineDescription", "traits": { "smithy.api#documentation": "

    A description of the Patch Baseline.

    " } + }, + "GlobalFilters": { + "target": "com.amazonaws.ssm#PatchFilterGroup", + "traits": { + "smithy.api#documentation": "

    A set of global filters used to exclude patches from the baseline.

    " + } } } }, @@ -22210,17 +22574,17 @@ "com.amazonaws.ssm#UpdateResourceDataSyncRequest": { "type": "structure", "members": { - "SyncSource": { - "target": "com.amazonaws.ssm#ResourceDataSyncSource", + "SyncType": { + "target": "com.amazonaws.ssm#ResourceDataSyncType", "traits": { - "smithy.api#documentation": "

    Specify information about the data sources to synchronize.

    ", + "smithy.api#documentation": "

    The type of resource data sync. The supported SyncType is\n SyncFromSource.

    ", "smithy.api#required": {} } }, - "SyncType": { - "target": "com.amazonaws.ssm#ResourceDataSyncType", + "SyncSource": { + "target": "com.amazonaws.ssm#ResourceDataSyncSource", "traits": { - "smithy.api#documentation": "

    The type of resource data sync. The supported SyncType is\n SyncFromSource.

    ", + "smithy.api#documentation": "

    Specify information about the data sources to synchronize.

    ", "smithy.api#required": {} } }, @@ -22263,17 +22627,17 @@ "com.amazonaws.ssm#UpdateServiceSettingRequest": { "type": "structure", "members": { - "SettingId": { - "target": "com.amazonaws.ssm#ServiceSettingId", + "SettingValue": { + "target": "com.amazonaws.ssm#ServiceSettingValue", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the service setting to reset. For example,\n arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.\n The setting ID can be one of the following.

    \n
      \n
    • \n

      \n /ssm/parameter-store/default-parameter-tier\n

      \n
      • \n
    • \n

      \n /ssm/parameter-store/high-throughput-enabled\n

      \n
      • \n
    • \n

      \n /ssm/managed-instance/activation-tier\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The new value to specify for the service setting. For the\n /ssm/parameter-store/default-parameter-tier setting ID, the setting value can be\n one of the following.

    \n
      \n
    • \n

      Standard

      \n
      • \n
    • \n

      Advanced

      \n
      • \n
    • \n

      Intelligent-Tiering

      \n
      • \n
    \n

    For the /ssm/parameter-store/high-throughput-enabled, and\n /ssm/managed-instance/activation-tier setting IDs, the setting value can be true or\n false.

    ", "smithy.api#required": {} } }, - "SettingValue": { - "target": "com.amazonaws.ssm#ServiceSettingValue", + "SettingId": { + "target": "com.amazonaws.ssm#ServiceSettingId", "traits": { - "smithy.api#documentation": "

    The new value to specify for the service setting. For the\n /ssm/parameter-store/default-parameter-tier setting ID, the setting value can be\n one of the following.

    \n
      \n
    • \n

      Standard

      \n
      • \n
    • \n

      Advanced

      \n
      • \n
    • \n

      Intelligent-Tiering

      \n
      • \n
    \n

    For the /ssm/parameter-store/high-throughput-enabled, and\n /ssm/managed-instance/activation-tier setting IDs, the setting value can be true or\n false.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the service setting to reset. For example,\n arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.\n The setting ID can be one of the following.

    \n
      \n
    • \n

      \n /ssm/parameter-store/default-parameter-tier\n

      \n
      • \n
    • \n

      \n /ssm/parameter-store/high-throughput-enabled\n

      \n
      • \n
    • \n

      \n /ssm/managed-instance/activation-tier\n

      \n
      • \n
    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/sso-admin.2020-07-20.json b/codegen/sdk-codegen/aws-models/sso-admin.2020-07-20.json new file mode 100644 index 000000000000..a5e209c3f09d --- /dev/null +++ b/codegen/sdk-codegen/aws-models/sso-admin.2020-07-20.json @@ -0,0 +1,2839 @@ +{ + "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.ssoadmin#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#AccessDeniedExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    You do not have sufficient access to perform this action.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.ssoadmin#AccessDeniedExceptionMessage": { + "type": "string" + }, + "com.amazonaws.ssoadmin#AccountAssignment": { + "type": "structure", + "members": { + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set. For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be created.

    " + } + }, + "AccountId": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account.

    " + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "

    An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The assignment that indicates a principal's limited access to a specified AWS account\n with a specified permission set.

    \n \n

    The term principal here refers to a user or group that is defined in AWS SSO.

    \n     " + } + }, + "com.amazonaws.ssoadmin#AccountAssignmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#AccountAssignment" + } + }, + "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus": { + "type": "structure", + "members": { + "FailureReason": { + "target": "com.amazonaws.ssoadmin#Reason", + "traits": { + "smithy.api#documentation": "

    The message that contains an error or exception in case of an operation failure.

    " + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be created.

    " + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set. For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "

    The date that the permission set was created.

    " + } + }, + "TargetType": { + "target": "com.amazonaws.ssoadmin#TargetType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be created.

    " + } + }, + "TargetId": { + "target": "com.amazonaws.ssoadmin#TargetId", + "traits": { + "smithy.api#documentation": "

    TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    " + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "

    An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

    " + } + }, + "Status": { + "target": "com.amazonaws.ssoadmin#StatusValues", + "traits": { + "smithy.api#documentation": "

    The status of the permission set provisioning process.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "

    The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The status of the creation or deletion operation of an assignment that a principal needs\n to access an account.

    " + } + }, + "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusMetadata" + } + }, + "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusMetadata": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ssoadmin#StatusValues", + "traits": { + "smithy.api#documentation": "

    The status of the permission set provisioning process.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "

    The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "

    The date that the permission set was created.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about the AccountAssignment creation\n request.

    " + } + }, + "com.amazonaws.ssoadmin#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\d{12}" + } + }, + "com.amazonaws.ssoadmin#AccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#AccountId" + } + }, + "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Attaches an IAM managed policy ARN to a permission set.

    \n \n

    If the permission set is already referenced by one or more account assignments, you will need to call \n ProvisionPermissionSet\n after this action to apply the corresponding IAM policy updates to all assigned accounts.

    \n     " + } + }, + "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSetRequest": { + "type": "structure", + "members": { + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the PermissionSet that the managed policy should be attached\n to.

    ", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "ManagedPolicyArn": { + "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", + "traits": { + "smithy.api#documentation": "

    The IAM managed policy ARN to be attached to a permission set.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#AttachedManagedPolicy": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssoadmin#Name", + "traits": { + "smithy.api#documentation": "

    The name of the IAM managed policy.

    " + } + }, + "Arn": { + "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the IAM managed policy. For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A structure that stores the details of the IAM managed policy.

    " + } + }, + "com.amazonaws.ssoadmin#AttachedManagedPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#AttachedManagedPolicy" + } + }, + "com.amazonaws.ssoadmin#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#ConflictExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.ssoadmin#ConflictExceptionMessage": { + "type": "string" + }, + "com.amazonaws.ssoadmin#CreateAccountAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#CreateAccountAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#CreateAccountAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Assigns access to a principal for a specified AWS account using a specified permission\n set.

    \n \n

    The term principal here refers to a user or group that is defined in AWS SSO.

    \n     \n \n

    As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy attached to the SSO-created IAM role. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you will need to call \n ProvisionPermissionSet\n to make these updates.

    \n     " + } + }, + "com.amazonaws.ssoadmin#CreateAccountAssignmentRequest": { + "type": "structure", + "members": { + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set that the admin wants to grant the principal access to.

    ", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "TargetId": { + "target": "com.amazonaws.ssoadmin#TargetId", + "traits": { + "smithy.api#documentation": "

    TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    ", + "smithy.api#required": {} + } + }, + "TargetType": { + "target": "com.amazonaws.ssoadmin#TargetType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be created.

    ", + "smithy.api#required": {} + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be created.

    ", + "smithy.api#required": {} + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "

    An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#CreateAccountAssignmentResponse": { + "type": "structure", + "members": { + "AccountAssignmentCreationStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", + "traits": { + "smithy.api#documentation": "

    The status object for the account assignment creation operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#CreatePermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#CreatePermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#CreatePermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a permission set within a specified SSO instance.

    \n \n

    To grant users and groups access to AWS account resources, use \n CreateAccountAssignment\n .

    \n     " + } + }, + "com.amazonaws.ssoadmin#CreatePermissionSetRequest": { + "type": "structure", + "members": { + "RelayState": { + "target": "com.amazonaws.ssoadmin#RelayState", + "traits": { + "smithy.api#documentation": "

    Used to redirect users within the application during the federation authentication\n process.

    " + } + }, + "Description": { + "target": "com.amazonaws.ssoadmin#PermissionSetDescription", + "traits": { + "smithy.api#documentation": "

    The description of the PermissionSet.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "SessionDuration": { + "target": "com.amazonaws.ssoadmin#Duration", + "traits": { + "smithy.api#documentation": "

    The length of time that the application user sessions are valid in the ISO-8601\n standard.

    " + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#PermissionSetName", + "traits": { + "smithy.api#documentation": "

    The name of the PermissionSet.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssoadmin#TagList", + "traits": { + "smithy.api#documentation": "

    The tags to attach to the new PermissionSet.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#CreatePermissionSetResponse": { + "type": "structure", + "members": { + "PermissionSet": { + "target": "com.amazonaws.ssoadmin#PermissionSet", + "traits": { + "smithy.api#documentation": "

    Defines the level of access on an AWS account.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#Date": { + "type": "timestamp" + }, + "com.amazonaws.ssoadmin#DeleteAccountAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DeleteAccountAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DeleteAccountAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a principal's access from a specified AWS account using a specified permission\n set.

    " + } + }, + "com.amazonaws.ssoadmin#DeleteAccountAssignmentRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "TargetId": { + "target": "com.amazonaws.ssoadmin#TargetId", + "traits": { + "smithy.api#documentation": "

    TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    ", + "smithy.api#required": {} + } + }, + "TargetType": { + "target": "com.amazonaws.ssoadmin#TargetType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be deleted.

    ", + "smithy.api#required": {} + } + }, + "PrincipalId": { + "target": "com.amazonaws.ssoadmin#PrincipalId", + "traits": { + "smithy.api#documentation": "

    An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set that will be used to remove access.

    ", + "smithy.api#required": {} + } + }, + "PrincipalType": { + "target": "com.amazonaws.ssoadmin#PrincipalType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be deleted.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DeleteAccountAssignmentResponse": { + "type": "structure", + "members": { + "AccountAssignmentDeletionStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", + "traits": { + "smithy.api#documentation": "

    The status object for the account assignment deletion operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the inline policy from a specified permission set.

    " + } + }, + "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set that will be used to remove access.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#DeletePermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DeletePermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DeletePermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the specified permission set.

    " + } + }, + "com.amazonaws.ssoadmin#DeletePermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set that should be deleted.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DeletePermissionSetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the status of the assignment creation request.

    " + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "AccountAssignmentCreationRequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "

    The identifier that is used to track the request operation progress.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatusResponse": { + "type": "structure", + "members": { + "AccountAssignmentCreationStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", + "traits": { + "smithy.api#documentation": "

    The status object for the account assignment creation operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the status of the assignment deletion request.

    " + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "AccountAssignmentDeletionRequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "

    The identifier that is used to track the request operation progress.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatusResponse": { + "type": "structure", + "members": { + "AccountAssignmentDeletionStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatus", + "traits": { + "smithy.api#documentation": "

    The status object for the account assignment deletion operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gets the details of the permission set.

    " + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the status for the given permission set provisioning request.

    " + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "ProvisionPermissionSetRequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "

    The identifier that is provided by the ProvisionPermissionSet call to\n retrieve the current status of the provisioning workflow.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatusResponse": { + "type": "structure", + "members": { + "PermissionSetProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#PermissionSetProvisioningStatus", + "traits": { + "smithy.api#documentation": "

    The status object for the permission set provisioning operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DescribePermissionSetResponse": { + "type": "structure", + "members": { + "PermissionSet": { + "target": "com.amazonaws.ssoadmin#PermissionSet", + "traits": { + "smithy.api#documentation": "

    Describes the level of access on an AWS account.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Detaches the attached IAM managed policy ARN from the specified permission set.

    " + } + }, + "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest": { + "type": "structure", + "members": { + "ManagedPolicyArn": { + "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", + "traits": { + "smithy.api#documentation": "

    The IAM managed policy ARN to be attached to a permission set.

    ", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the PermissionSet from which the policy should be detached.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#Duration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$" + } + }, + "com.amazonaws.ssoadmin#GeneralArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 2048 + }, + "smithy.api#pattern": "arn:aws:sso:([a-zA-Z0-9-]+)?:(\\d{12})?:[a-zA-Z0-9-]+/[a-zA-Z0-9-/.]+" + } + }, + "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Obtains the inline policy assigned to the permission set.

    " + } + }, + "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSetResponse": { + "type": "structure", + "members": { + "InlinePolicy": { + "target": "com.amazonaws.ssoadmin#PermissionSetPolicyDocument", + "traits": { + "smithy.api#documentation": "

    The IAM inline policy that is attached to the permission set.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*" + } + }, + "com.amazonaws.ssoadmin#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "arn:aws:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}" + } + }, + "com.amazonaws.ssoadmin#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#InstanceMetadata" + } + }, + "com.amazonaws.ssoadmin#InstanceMetadata": { + "type": "structure", + "members": { + "IdentityStoreId": { + "target": "com.amazonaws.ssoadmin#Id", + "traits": { + "smithy.api#documentation": "

    The identifier of the identity store that is connected to the SSO instance.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about the SSO instance.

    " + } + }, + "com.amazonaws.ssoadmin#InternalFailureMessage": { + "type": "string" + }, + "com.amazonaws.ssoadmin#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#InternalFailureMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The request processing has failed because of an unknown error, exception, or failure with\n an internal server.

    ", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the status of the AWS account assignment creation requests for a specified SSO\n instance.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AccountAssignmentsCreationStatus", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the assignment.

    " + } + }, + "Filter": { + "target": "com.amazonaws.ssoadmin#OperationStatusFilter", + "traits": { + "smithy.api#documentation": "

    Filters results based on the passed attribute value.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatusResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "AccountAssignmentsCreationStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusList", + "traits": { + "smithy.api#documentation": "

    The status object for the account assignment creation operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the status of the AWS account assignment deletion requests for a specified SSO\n instance.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AccountAssignmentsDeletionStatus", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "Filter": { + "target": "com.amazonaws.ssoadmin#OperationStatusFilter", + "traits": { + "smithy.api#documentation": "

    Filters results based on the passed attribute value.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the assignment.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatusResponse": { + "type": "structure", + "members": { + "AccountAssignmentsDeletionStatus": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusList", + "traits": { + "smithy.api#documentation": "

    The status object for the account assignment deletion operation.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the assignee of the specified AWS account with the specified permission\n set.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AccountAssignments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set from which to list assignments.

    ", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.ssoadmin#TargetId", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account from which to list the assignments.

    ", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the assignment.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#ListAccountAssignmentsResponse": { + "type": "structure", + "members": { + "AccountAssignments": { + "target": "com.amazonaws.ssoadmin#AccountAssignmentList", + "traits": { + "smithy.api#documentation": "

    The list of assignments that match the input AWS account and permission set.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists all the AWS accounts where the specified permission set is provisioned.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AccountIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the PermissionSet from which the associated AWS accounts\n will be listed.

    ", + "smithy.api#required": {} + } + }, + "ProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#ProvisioningStatus", + "traits": { + "smithy.api#documentation": "

    The permission set provisioning status for an AWS account.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the PermissionSet.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSetResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "AccountIds": { + "target": "com.amazonaws.ssoadmin#AccountList", + "traits": { + "smithy.api#documentation": "

    The list of AWS AccountIds.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListInstancesRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the SSO instances that the caller has access to.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Instances", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListInstancesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the instance.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListInstancesResponse": { + "type": "structure", + "members": { + "Instances": { + "target": "com.amazonaws.ssoadmin#InstanceList", + "traits": { + "smithy.api#documentation": "

    Lists the SSO instances that the caller has access to.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListManagedPoliciesInPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListManagedPoliciesInPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListManagedPoliciesInPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the IAM managed policy that is attached to a specified permission set.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AttachedManagedPolicies", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListManagedPoliciesInPermissionSetRequest": { + "type": "structure", + "members": { + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the PermissionSet whose managed policies will be listed.

    ", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the PermissionSet.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListManagedPoliciesInPermissionSetResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "AttachedManagedPolicies": { + "target": "com.amazonaws.ssoadmin#AttachedManagedPolicyList", + "traits": { + "smithy.api#documentation": "

    The array of the AttachedManagedPolicy data type object.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetProvisioningStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListPermissionSetProvisioningStatusRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListPermissionSetProvisioningStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the status of the permission set provisioning requests for a specified SSO\n instance.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PermissionSetsProvisioningStatus", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetProvisioningStatusRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the assignment.

    " + } + }, + "Filter": { + "target": "com.amazonaws.ssoadmin#OperationStatusFilter", + "traits": { + "smithy.api#documentation": "

    Filters results based on the passed attribute value.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetProvisioningStatusResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "PermissionSetsProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#PermissionSetProvisioningStatusList", + "traits": { + "smithy.api#documentation": "

    The status object for the permission set provisioning operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListPermissionSetsRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListPermissionSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the PermissionSets in an SSO instance.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PermissionSets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetsProvisionedToAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListPermissionSetsProvisionedToAccountRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListPermissionSetsProvisionedToAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists all the permission sets that are provisioned to a specified AWS account.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PermissionSets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetsProvisionedToAccountRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the assignment.

    " + } + }, + "AccountId": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account from which to list the assignments.

    ", + "smithy.api#required": {} + } + }, + "ProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#ProvisioningStatus", + "traits": { + "smithy.api#documentation": "

    The status object for the permission set provisioning operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetsProvisionedToAccountResponse": { + "type": "structure", + "members": { + "PermissionSets": { + "target": "com.amazonaws.ssoadmin#PermissionSetList", + "traits": { + "smithy.api#documentation": "

    Defines the level of access that an AWS account has.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetsRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.ssoadmin#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to display for the assignment.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListPermissionSetsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "PermissionSets": { + "target": "com.amazonaws.ssoadmin#PermissionSetList", + "traits": { + "smithy.api#documentation": "

    Defines the level of access on an AWS account.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the tags that are attached to a specified resource.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags" + } + } + }, + "com.amazonaws.ssoadmin#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "ResourceArn": { + "target": "com.amazonaws.ssoadmin#GeneralArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the resource with the tags to be listed.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssoadmin#Token", + "traits": { + "smithy.api#documentation": "

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    " + } + }, + "Tags": { + "target": "com.amazonaws.ssoadmin#TagList", + "traits": { + "smithy.api#documentation": "

    A set of key-value pairs that are used to manage the resource.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ManagedPolicyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.ssoadmin#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ssoadmin#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ssoadmin#OperationStatusFilter": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ssoadmin#StatusValues", + "traits": { + "smithy.api#documentation": "

    Filters the list operations result based on the status attribute.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Filters he operation status list based on the passed attribute value.

    " + } + }, + "com.amazonaws.ssoadmin#PermissionSet": { + "type": "structure", + "members": { + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "

    The date that the permission set was created.

    " + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set. For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + } + }, + "Name": { + "target": "com.amazonaws.ssoadmin#PermissionSetName", + "traits": { + "smithy.api#documentation": "

    The name of the permission set.

    " + } + }, + "SessionDuration": { + "target": "com.amazonaws.ssoadmin#Duration", + "traits": { + "smithy.api#documentation": "

    The length of time that the application user sessions are valid for in the ISO-8601\n standard.

    " + } + }, + "Description": { + "target": "com.amazonaws.ssoadmin#PermissionSetDescription", + "traits": { + "smithy.api#documentation": "

    The description of the PermissionSet.

    " + } + }, + "RelayState": { + "target": "com.amazonaws.ssoadmin#RelayState", + "traits": { + "smithy.api#documentation": "

    Used to redirect users within the application during the federation authentication\n process.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An entity that contains IAM policies.

    " + } + }, + "com.amazonaws.ssoadmin#PermissionSetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "arn:aws:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}" + } + }, + "com.amazonaws.ssoadmin#PermissionSetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 700 + }, + "smithy.api#pattern": "[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" + } + }, + "com.amazonaws.ssoadmin#PermissionSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn" + } + }, + "com.amazonaws.ssoadmin#PermissionSetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "[\\w+=,.@-]+" + } + }, + "com.amazonaws.ssoadmin#PermissionSetPolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + }, + "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssoadmin#PermissionSetProvisioningStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.ssoadmin#StatusValues", + "traits": { + "smithy.api#documentation": "

    The status of the permission set provisioning process.

    " + } + }, + "AccountId": { + "target": "com.amazonaws.ssoadmin#AccountId", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account from which to list the assignments.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "

    The date that the permission set was created.

    " + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + } + }, + "RequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "

    The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.ssoadmin#Reason", + "traits": { + "smithy.api#documentation": "

    The message that contains an error or exception in case of an operation failure.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A structure that is used to provide the status of the provisioning operation for a\n specified permission set.

    " + } + }, + "com.amazonaws.ssoadmin#PermissionSetProvisioningStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#PermissionSetProvisioningStatusMetadata" + } + }, + "com.amazonaws.ssoadmin#PermissionSetProvisioningStatusMetadata": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.ssoadmin#UUId", + "traits": { + "smithy.api#documentation": "

    The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

    " + } + }, + "Status": { + "target": "com.amazonaws.ssoadmin#StatusValues", + "traits": { + "smithy.api#documentation": "

    The status of the permission set provisioning process.

    " + } + }, + "CreatedDate": { + "target": "com.amazonaws.ssoadmin#Date", + "traits": { + "smithy.api#documentation": "

    The date that the permission set was created.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Provides information about the permission set provisioning status.

    " + } + }, + "com.amazonaws.ssoadmin#PrincipalId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 47 + }, + "smithy.api#pattern": "^([0-9a-f]{10}-|)[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.ssoadmin#PrincipalType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USER", + "name": "USER" + }, + { + "value": "GROUP", + "name": "GROUP" + } + ] + } + }, + "com.amazonaws.ssoadmin#ProvisionPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#ProvisionPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#ProvisionPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    The process by which a specified permission set is provisioned to the specified target.

    " + } + }, + "com.amazonaws.ssoadmin#ProvisionPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set.

    ", + "smithy.api#required": {} + } + }, + "TargetType": { + "target": "com.amazonaws.ssoadmin#ProvisionTargetType", + "traits": { + "smithy.api#documentation": "

    The entity type for which the assignment will be created.

    ", + "smithy.api#required": {} + } + }, + "TargetId": { + "target": "com.amazonaws.ssoadmin#TargetId", + "traits": { + "smithy.api#documentation": "

    TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ProvisionPermissionSetResponse": { + "type": "structure", + "members": { + "PermissionSetProvisioningStatus": { + "target": "com.amazonaws.ssoadmin#PermissionSetProvisioningStatus", + "traits": { + "smithy.api#documentation": "

    The status object for the permission set provisioning operation.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#ProvisionTargetType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_ACCOUNT", + "name": "AWS_ACCOUNT" + }, + { + "value": "ALL_PROVISIONED_ACCOUNTS", + "name": "ALL_PROVISIONED_ACCOUNTS" + } + ] + } + }, + "com.amazonaws.ssoadmin#ProvisioningStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LATEST_PERMISSION_SET_PROVISIONED", + "name": "LATEST_PERMISSION_SET_PROVISIONED" + }, + { + "value": "LATEST_PERMISSION_SET_NOT_PROVISIONED", + "name": "LATEST_PERMISSION_SET_NOT_PROVISIONED" + } + ] + } + }, + "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Attaches an IAM inline policy to a permission set.

    \n \n

    If the permission set is already referenced by one or more account assignments, you will need to call \n ProvisionPermissionSet\n after this action to apply the corresponding IAM policy updates to all assigned accounts.

    \n     " + } + }, + "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSetRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "InlinePolicy": { + "target": "com.amazonaws.ssoadmin#PermissionSetPolicyDocument", + "traits": { + "smithy.api#documentation": "

    The IAM inline policy to attach to a PermissionSet.

    ", + "smithy.api#required": {} + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#Reason": { + "type": "string", + "traits": { + "smithy.api#pattern": "[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" + } + }, + "com.amazonaws.ssoadmin#RelayState": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 240 + }, + "smithy.api#pattern": "[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+" + } + }, + "com.amazonaws.ssoadmin#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    Indicates that a requested resource is not found.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ssoadmin#ResourceNotFoundMessage": { + "type": "string" + }, + "com.amazonaws.ssoadmin#SWBExternalService": { + "type": "service", + "version": "2020-07-20", + "operations": [ + { + "target": "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#CreateAccountAssignment" + }, + { + "target": "com.amazonaws.ssoadmin#CreatePermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#DeleteAccountAssignment" + }, + { + "target": "com.amazonaws.ssoadmin#DeleteInlinePolicyFromPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#DeletePermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentCreationStatus" + }, + { + "target": "com.amazonaws.ssoadmin#DescribeAccountAssignmentDeletionStatus" + }, + { + "target": "com.amazonaws.ssoadmin#DescribePermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#DescribePermissionSetProvisioningStatus" + }, + { + "target": "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatus" + }, + { + "target": "com.amazonaws.ssoadmin#ListAccountAssignmentDeletionStatus" + }, + { + "target": "com.amazonaws.ssoadmin#ListAccountAssignments" + }, + { + "target": "com.amazonaws.ssoadmin#ListAccountsForProvisionedPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#ListInstances" + }, + { + "target": "com.amazonaws.ssoadmin#ListManagedPoliciesInPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#ListPermissionSetProvisioningStatus" + }, + { + "target": "com.amazonaws.ssoadmin#ListPermissionSets" + }, + { + "target": "com.amazonaws.ssoadmin#ListPermissionSetsProvisionedToAccount" + }, + { + "target": "com.amazonaws.ssoadmin#ListTagsForResource" + }, + { + "target": "com.amazonaws.ssoadmin#ProvisionPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSet" + }, + { + "target": "com.amazonaws.ssoadmin#TagResource" + }, + { + "target": "com.amazonaws.ssoadmin#UntagResource" + }, + { + "target": "com.amazonaws.ssoadmin#UpdatePermissionSet" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SSO Admin", + "arnNamespace": "sso", + "cloudFormationName": "SSOAdmin", + "cloudTrailEventSource": "service.sso.amazon.com" + }, + "aws.auth#sigv4": { + "name": "sso" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#title": "AWS Single Sign-On Admin" + } + }, + "com.amazonaws.ssoadmin#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    Indicates that the principal has crossed the permitted number of resources that can be created.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.ssoadmin#ServiceQuotaExceededMessage": { + "type": "string" + }, + "com.amazonaws.ssoadmin#StatusValues": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + } + ] + } + }, + "com.amazonaws.ssoadmin#Tag": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.ssoadmin#TagValue", + "traits": { + "smithy.api#documentation": "

    The value of the tag.

    " + } + }, + "Key": { + "target": "com.amazonaws.ssoadmin#TagKey", + "traits": { + "smithy.api#documentation": "

    The key for the tag.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles\n that AWS SSO creates in AWS accounts.

    " + } + }, + "com.amazonaws.ssoadmin#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.ssoadmin#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ssoadmin#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssoadmin#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ssoadmin#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Associates a set of tags with a specified resource.

    " + } + }, + "com.amazonaws.ssoadmin#TagResourceRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.ssoadmin#GeneralArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the resource with the tags to be listed.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssoadmin#TagList", + "traits": { + "smithy.api#documentation": "

    A set of key-value pairs that are used to manage the resource.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.ssoadmin#TargetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\d{12}" + } + }, + "com.amazonaws.ssoadmin#TargetType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_ACCOUNT", + "name": "AWS_ACCOUNT" + } + ] + } + }, + "com.amazonaws.ssoadmin#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#ThrottlingExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    Indicates that the principal has crossed the throttling limits of the API operations.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.ssoadmin#ThrottlingExceptionMessage": { + "type": "string" + }, + "com.amazonaws.ssoadmin#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[-a-zA-Z0-9+=/]*" + } + }, + "com.amazonaws.ssoadmin#UUId": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b" + } + }, + "com.amazonaws.ssoadmin#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Disassociates a set of tags from a specified resource.

    " + } + }, + "com.amazonaws.ssoadmin#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.ssoadmin#GeneralArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the resource with the tags to be listed.

    ", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.ssoadmin#TagKeyList", + "traits": { + "smithy.api#documentation": "

    The keys of tags that are attached to the resource.

    ", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssoadmin#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#UpdatePermissionSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#UpdatePermissionSetRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#UpdatePermissionSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Updates an existing permission set.

    " + } + }, + "com.amazonaws.ssoadmin#UpdatePermissionSetRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.ssoadmin#PermissionSetDescription", + "traits": { + "smithy.api#documentation": "

    The description of the PermissionSet.

    " + } + }, + "PermissionSetArn": { + "target": "com.amazonaws.ssoadmin#PermissionSetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the permission set.

    ", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.ssoadmin#InstanceArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the SSO instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and AWS Service Namespaces in the AWS General Reference.

    ", + "smithy.api#required": {} + } + }, + "RelayState": { + "target": "com.amazonaws.ssoadmin#RelayState", + "traits": { + "smithy.api#documentation": "

    Used to redirect users within the application during the federation authentication\n process.

    " + } + }, + "SessionDuration": { + "target": "com.amazonaws.ssoadmin#Duration", + "traits": { + "smithy.api#documentation": "

    The length of time that the application user sessions are valid for in the ISO-8601\n standard.

    " + } + } + } + }, + "com.amazonaws.ssoadmin#UpdatePermissionSetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssoadmin#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssoadmin#ValidationExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The request failed because it contains a syntax error.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.ssoadmin#ValidationExceptionMessage": { + "type": "string" + } + } +} diff --git a/codegen/sdk-codegen/aws-models/sso-oidc.2019-06-10.json b/codegen/sdk-codegen/aws-models/sso-oidc.2019-06-10.json index 8054e46d2892..7f0a11f33af7 100644 --- a/codegen/sdk-codegen/aws-models/sso-oidc.2019-06-10.json +++ b/codegen/sdk-codegen/aws-models/sso-oidc.2019-06-10.json @@ -48,13 +48,12 @@ "sdkId": "SSO OIDC", "arnNamespace": "awsssooidc", "cloudFormationName": "SSOOIDC", - "cloudTrailEventSource": "oidc.sso.amazonaws.com" + "cloudTrailEventSource": "ssooidc.amazonaws.com" }, "aws.auth#sigv4": { "name": "awsssooidc" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

    AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client\n (such as AWS CLI or a native application) to register with AWS SSO. The service also\n enables the client to fetch the user’s access token upon successful authentication and\n authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of\n the device authorization grant standard (https://tools.ietf.org/html/rfc8628).

    \n \n

    For general information about AWS SSO, see What is AWS\n Single Sign-On? in the AWS SSO User Guide.

    \n \n

    This API reference guide describes the AWS SSO OIDC operations that you can call\n programatically and includes detailed information on data types and errors.

    \n \n \n

    AWS provides SDKs that consist of libraries and sample code for various programming\n languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a\n convenient way to create programmatic access to AWS SSO and other AWS services. For more\n information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

    \n     ", "smithy.api#title": "AWS SSO OIDC" } }, @@ -69,7 +68,6 @@ } }, "traits": { - "smithy.api#documentation": "

    You do not have sufficient access to perform this action.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -91,7 +89,6 @@ } }, "traits": { - "smithy.api#documentation": "

    Indicates that a request to authorize a client with an access user session token is pending.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -152,68 +149,49 @@ } ], "traits": { - "smithy.api#auth": [], - "smithy.api#documentation": "

    Creates and returns an access token for the authorized client. The access token issued\n will be used to fetch short-term credentials for the assigned roles in the AWS\n account.

    ", "smithy.api#http": { "method": "POST", "uri": "/token", "code": 200 - }, - "smithy.api#optionalAuth": {} + } } }, "com.amazonaws.ssooidc#CreateTokenRequest": { "type": "structure", "members": { - "scope": { - "target": "com.amazonaws.ssooidc#Scopes", - "traits": { - "smithy.api#documentation": "

    The list of scopes that is defined by the client. Upon authorization, this list is used to\n restrict permissions when granting an access token.

    " - } + "code": { + "target": "com.amazonaws.ssooidc#AuthCode" }, - "clientId": { - "target": "com.amazonaws.ssooidc#ClientId", - "traits": { - "smithy.api#documentation": "

    The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

    ", - "smithy.api#required": {} - } + "refreshToken": { + "target": "com.amazonaws.ssooidc#RefreshToken" + }, + "scope": { + "target": "com.amazonaws.ssooidc#Scopes" }, "redirectUri": { - "target": "com.amazonaws.ssooidc#URI", - "traits": { - "smithy.api#documentation": "

    The location of the application that will receive the authorization code. Users authorize\n the service to send the request to this location.

    " - } + "target": "com.amazonaws.ssooidc#URI" }, "grantType": { "target": "com.amazonaws.ssooidc#GrantType", "traits": { - "smithy.api#documentation": "

    Supports grant types for authorization code, refresh token, and device code request.

    ", "smithy.api#required": {} } }, - "refreshToken": { - "target": "com.amazonaws.ssooidc#RefreshToken", - "traits": { - "smithy.api#documentation": "

    The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

    " - } - }, "deviceCode": { "target": "com.amazonaws.ssooidc#DeviceCode", "traits": { - "smithy.api#documentation": "

    Used only when calling this API for the device code grant type. This short-term code is\n used to identify this authentication attempt. This should come from an in-memory reference to\n the result of the StartDeviceAuthorization API.

    ", "smithy.api#required": {} } }, - "code": { - "target": "com.amazonaws.ssooidc#AuthCode", + "clientId": { + "target": "com.amazonaws.ssooidc#ClientId", "traits": { - "smithy.api#documentation": "

    The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

    " + "smithy.api#required": {} } }, "clientSecret": { "target": "com.amazonaws.ssooidc#ClientSecret", "traits": { - "smithy.api#documentation": "

    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

    ", "smithy.api#required": {} } } @@ -222,35 +200,20 @@ "com.amazonaws.ssooidc#CreateTokenResponse": { "type": "structure", "members": { + "accessToken": { + "target": "com.amazonaws.ssooidc#AccessToken" + }, "expiresIn": { - "target": "com.amazonaws.ssooidc#ExpirationInSeconds", - "traits": { - "smithy.api#documentation": "

    Indicates the time in seconds when an access token will expire.

    " - } + "target": "com.amazonaws.ssooidc#ExpirationInSeconds" }, "refreshToken": { - "target": "com.amazonaws.ssooidc#RefreshToken", - "traits": { - "smithy.api#documentation": "

    A token that, if present, can be used to refresh a previously issued access token that\n might have expired.

    " - } + "target": "com.amazonaws.ssooidc#RefreshToken" }, - "accessToken": { - "target": "com.amazonaws.ssooidc#AccessToken", - "traits": { - "smithy.api#documentation": "

    An opaque token to access AWS SSO resources assigned to a user.

    " - } + "tokenType": { + "target": "com.amazonaws.ssooidc#TokenType" }, "idToken": { - "target": "com.amazonaws.ssooidc#IdToken", - "traits": { - "smithy.api#documentation": "

    The identifier of the user that associated with the access token, if present.

    " - } - }, - "tokenType": { - "target": "com.amazonaws.ssooidc#TokenType", - "traits": { - "smithy.api#documentation": "

    Used to notify the client that the returned token is an access token. The supported type\n is BearerToken.

    " - } + "target": "com.amazonaws.ssooidc#IdToken" } } }, @@ -269,15 +232,14 @@ "com.amazonaws.ssooidc#ExpiredTokenException": { "type": "structure", "members": { - "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" - }, "error": { "target": "com.amazonaws.ssooidc#Error" + }, + "error_description": { + "target": "com.amazonaws.ssooidc#ErrorDescription" } }, "traits": { - "smithy.api#documentation": "

    Indicates that the token issued by the service is expired and is no longer valid.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -299,7 +261,6 @@ } }, "traits": { - "smithy.api#documentation": "

    Indicates that an error from the service occurred while trying to process a request.

    ", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -318,7 +279,6 @@ } }, "traits": { - "smithy.api#documentation": "

    Indicates that the clientId or clientSecret in the request is\n invalid. For example, this can occur when a client sends an incorrect clientId or\n an expired clientSecret.

    ", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -326,15 +286,14 @@ "com.amazonaws.ssooidc#InvalidClientMetadataException": { "type": "structure", "members": { - "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" - }, "error": { "target": "com.amazonaws.ssooidc#Error" + }, + "error_description": { + "target": "com.amazonaws.ssooidc#ErrorDescription" } }, "traits": { - "smithy.api#documentation": "

    Indicates that the client information sent in the request during registration is invalid.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -350,7 +309,6 @@ } }, "traits": { - "smithy.api#documentation": "

    Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -358,15 +316,14 @@ "com.amazonaws.ssooidc#InvalidRequestException": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.ssooidc#Error" - }, "error_description": { "target": "com.amazonaws.ssooidc#ErrorDescription" + }, + "error": { + "target": "com.amazonaws.ssooidc#Error" } }, "traits": { - "smithy.api#documentation": "

    Indicates that something is wrong with the input to the request. For example, a required\n parameter might be missing or out of range.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -382,7 +339,6 @@ } }, "traits": { - "smithy.api#documentation": "

    Indicates that the scope provided in the request is invalid.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -416,79 +372,53 @@ } ], "traits": { - "smithy.api#auth": [], - "smithy.api#documentation": "

    Registers a client with AWS SSO. This allows clients to initiate device authorization.\n The output should be persisted for reuse through many authentication requests.

    ", "smithy.api#http": { "method": "POST", "uri": "/client/register", "code": 200 - }, - "smithy.api#optionalAuth": {} + } } }, "com.amazonaws.ssooidc#RegisterClientRequest": { "type": "structure", "members": { + "scopes": { + "target": "com.amazonaws.ssooidc#Scopes" + }, "clientType": { "target": "com.amazonaws.ssooidc#ClientType", "traits": { - "smithy.api#documentation": "

    The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

    ", "smithy.api#required": {} } }, "clientName": { "target": "com.amazonaws.ssooidc#ClientName", "traits": { - "smithy.api#documentation": "

    The friendly name of the client.

    ", "smithy.api#required": {} } - }, - "scopes": { - "target": "com.amazonaws.ssooidc#Scopes", - "traits": { - "smithy.api#documentation": "

    The list of scopes that are defined by the client. Upon authorization, this list is used\n to restrict permissions when granting an access token.

    " - } } } }, "com.amazonaws.ssooidc#RegisterClientResponse": { "type": "structure", "members": { - "authorizationEndpoint": { - "target": "com.amazonaws.ssooidc#URI", - "traits": { - "smithy.api#documentation": "

    The endpoint where the client can request authorization.

    " - } - }, "clientSecret": { - "target": "com.amazonaws.ssooidc#ClientSecret", - "traits": { - "smithy.api#documentation": "

    A secret string generated for the client. The client will use this string to get\n authenticated by the service in subsequent calls.

    " - } + "target": "com.amazonaws.ssooidc#ClientSecret" }, - "tokenEndpoint": { - "target": "com.amazonaws.ssooidc#URI", - "traits": { - "smithy.api#documentation": "

    The endpoint where the client can get an access token.

    " - } + "authorizationEndpoint": { + "target": "com.amazonaws.ssooidc#URI" }, "clientId": { - "target": "com.amazonaws.ssooidc#ClientId", - "traits": { - "smithy.api#documentation": "

    The unique identifier string for each client. This client uses this identifier to get\n authenticated by the service in subsequent calls.

    " - } + "target": "com.amazonaws.ssooidc#ClientId" }, - "clientSecretExpiresAt": { - "target": "com.amazonaws.ssooidc#LongTimeStampType", - "traits": { - "smithy.api#documentation": "

    Indicates the time at which the clientId and clientSecret will become invalid.

    " - } + "tokenEndpoint": { + "target": "com.amazonaws.ssooidc#URI" }, "clientIdIssuedAt": { - "target": "com.amazonaws.ssooidc#LongTimeStampType", - "traits": { - "smithy.api#documentation": "

    Indicates the time at which the clientId and clientSecret were issued.

    " - } + "target": "com.amazonaws.ssooidc#LongTimeStampType" + }, + "clientSecretExpiresAt": { + "target": "com.amazonaws.ssooidc#LongTimeStampType" } } }, @@ -504,15 +434,14 @@ "com.amazonaws.ssooidc#SlowDownException": { "type": "structure", "members": { - "error_description": { - "target": "com.amazonaws.ssooidc#ErrorDescription" - }, "error": { "target": "com.amazonaws.ssooidc#Error" + }, + "error_description": { + "target": "com.amazonaws.ssooidc#ErrorDescription" } }, "traits": { - "smithy.api#documentation": "

    Indicates that the client is making the request too frequently and is more than the service can handle.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -543,14 +472,11 @@ } ], "traits": { - "smithy.api#auth": [], - "smithy.api#documentation": "

    Initiates device authorization by requesting a pair of verification codes from the authorization service.

    ", "smithy.api#http": { "method": "POST", "uri": "/device_authorization", "code": 200 - }, - "smithy.api#optionalAuth": {} + } } }, "com.amazonaws.ssooidc#StartDeviceAuthorizationRequest": { @@ -559,21 +485,18 @@ "clientSecret": { "target": "com.amazonaws.ssooidc#ClientSecret", "traits": { - "smithy.api#documentation": "

    A secret string that is generated for the client. This value should come from the\n persisted result of the RegisterClient API operation.

    ", "smithy.api#required": {} } }, - "startUrl": { - "target": "com.amazonaws.ssooidc#URI", + "clientId": { + "target": "com.amazonaws.ssooidc#ClientId", "traits": { - "smithy.api#documentation": "

    The URL for the AWS SSO user portal. For more information, see Using\n the User Portal in the AWS Single Sign-On User Guide.

    ", "smithy.api#required": {} } }, - "clientId": { - "target": "com.amazonaws.ssooidc#ClientId", + "startUrl": { + "target": "com.amazonaws.ssooidc#URI", "traits": { - "smithy.api#documentation": "

    The unique identifier string for the client that is registered with AWS SSO. This value\n should come from the persisted result of the RegisterClient API\n operation.

    ", "smithy.api#required": {} } } @@ -582,41 +505,23 @@ "com.amazonaws.ssooidc#StartDeviceAuthorizationResponse": { "type": "structure", "members": { - "verificationUri": { - "target": "com.amazonaws.ssooidc#URI", - "traits": { - "smithy.api#documentation": "

    The URI of the verification page that takes the userCode to authorize the device.

    " - } + "expiresIn": { + "target": "com.amazonaws.ssooidc#ExpirationInSeconds" }, - "userCode": { - "target": "com.amazonaws.ssooidc#UserCode", - "traits": { - "smithy.api#documentation": "

    A one-time user verification code. This is needed to authorize an in-use device.

    " - } + "verificationUri": { + "target": "com.amazonaws.ssooidc#URI" }, "interval": { - "target": "com.amazonaws.ssooidc#IntervalInSeconds", - "traits": { - "smithy.api#documentation": "

    Indicates the number of seconds the client must wait between attempts when polling for a session.

    " - } - }, - "expiresIn": { - "target": "com.amazonaws.ssooidc#ExpirationInSeconds", - "traits": { - "smithy.api#documentation": "

    Indicates the number of seconds in which the verification code will become invalid.

    " - } + "target": "com.amazonaws.ssooidc#IntervalInSeconds" }, "verificationUriComplete": { - "target": "com.amazonaws.ssooidc#URI", - "traits": { - "smithy.api#documentation": "

    An alternate URL that the client can use to automatically launch a browser. This process\n skips the manual step in which the user visits the verification page and enters their\n code.

    " - } + "target": "com.amazonaws.ssooidc#URI" }, "deviceCode": { - "target": "com.amazonaws.ssooidc#DeviceCode", - "traits": { - "smithy.api#documentation": "

    The short-lived code that is used by the device when polling for a session token.

    " - } + "target": "com.amazonaws.ssooidc#DeviceCode" + }, + "userCode": { + "target": "com.amazonaws.ssooidc#UserCode" } } }, @@ -629,15 +534,14 @@ "com.amazonaws.ssooidc#UnauthorizedClientException": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.ssooidc#Error" - }, "error_description": { "target": "com.amazonaws.ssooidc#ErrorDescription" + }, + "error": { + "target": "com.amazonaws.ssooidc#Error" } }, "traits": { - "smithy.api#documentation": "

    Indicates that the client is not currently authorized to make the request. This can happen\n when a clientId is not issued for a public client.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -653,7 +557,6 @@ } }, "traits": { - "smithy.api#documentation": "

    Indicates that the grant type in the request is not supported by the service.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/sso.2019-06-10.json b/codegen/sdk-codegen/aws-models/sso.2019-06-10.json index 33b543c122e8..c0a8af53e84e 100644 --- a/codegen/sdk-codegen/aws-models/sso.2019-06-10.json +++ b/codegen/sdk-codegen/aws-models/sso.2019-06-10.json @@ -44,10 +44,10 @@ "com.amazonaws.sso#AccountInfo": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.sso#AccountIdType", + "accountName": { + "target": "com.amazonaws.sso#AccountNameType", "traits": { - "smithy.api#documentation": "

    The identifier of the AWS account that is assigned to the user.

    " + "smithy.api#documentation": "

    The display name of the AWS account that is assigned to the user.

    " } }, "emailAddress": { @@ -56,10 +56,10 @@ "smithy.api#documentation": "

    The email address of the AWS account that is assigned to the user.

    " } }, - "accountName": { - "target": "com.amazonaws.sso#AccountNameType", + "accountId": { + "target": "com.amazonaws.sso#AccountIdType", "traits": { - "smithy.api#documentation": "

    The display name of the AWS account that is assigned to the user.

    " + "smithy.api#documentation": "

    The identifier of the AWS account that is assigned to the user.

    " } } }, @@ -127,11 +127,11 @@ "com.amazonaws.sso#GetRoleCredentialsRequest": { "type": "structure", "members": { - "accountId": { - "target": "com.amazonaws.sso#AccountIdType", + "roleName": { + "target": "com.amazonaws.sso#RoleNameType", "traits": { - "smithy.api#documentation": "

    The identifier for the AWS account that is assigned to the user.

    ", - "smithy.api#httpQuery": "account_id", + "smithy.api#documentation": "

    The friendly name of the role that is assigned to the user.

    ", + "smithy.api#httpQuery": "role_name", "smithy.api#required": {} } }, @@ -143,11 +143,11 @@ "smithy.api#required": {} } }, - "roleName": { - "target": "com.amazonaws.sso#RoleNameType", + "accountId": { + "target": "com.amazonaws.sso#AccountIdType", "traits": { - "smithy.api#documentation": "

    The friendly name of the role that is assigned to the user.

    ", - "smithy.api#httpQuery": "role_name", + "smithy.api#documentation": "

    The identifier for the AWS account that is assigned to the user.

    ", + "smithy.api#httpQuery": "account_id", "smithy.api#required": {} } } @@ -218,13 +218,6 @@ "com.amazonaws.sso#ListAccountRolesRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.sso#NextTokenType", - "traits": { - "smithy.api#documentation": "

    The page token from the previous response output when you request subsequent pages.

    ", - "smithy.api#httpQuery": "next_token" - } - }, "accessToken": { "target": "com.amazonaws.sso#AccessTokenType", "traits": { @@ -233,6 +226,13 @@ "smithy.api#required": {} } }, + "maxResults": { + "target": "com.amazonaws.sso#MaxResultType", + "traits": { + "smithy.api#documentation": "

    The number of items that clients can request per page.

    ", + "smithy.api#httpQuery": "max_result" + } + }, "accountId": { "target": "com.amazonaws.sso#AccountIdType", "traits": { @@ -241,11 +241,11 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.sso#MaxResultType", + "nextToken": { + "target": "com.amazonaws.sso#NextTokenType", "traits": { - "smithy.api#documentation": "

    The number of items that clients can request per page.

    ", - "smithy.api#httpQuery": "max_result" + "smithy.api#documentation": "

    The page token from the previous response output when you request subsequent pages.

    ", + "smithy.api#httpQuery": "next_token" } } } @@ -253,17 +253,17 @@ "com.amazonaws.sso#ListAccountRolesResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.sso#NextTokenType", - "traits": { - "smithy.api#documentation": "

    The page token client that is used to retrieve the list of accounts.

    " - } - }, "roleList": { "target": "com.amazonaws.sso#RoleListType", "traits": { "smithy.api#documentation": "

    A paginated response with the list of roles and the next token if more results are available.

    " } + }, + "nextToken": { + "target": "com.amazonaws.sso#NextTokenType", + "traits": { + "smithy.api#documentation": "

    The page token client that is used to retrieve the list of accounts.

    " + } } } }, @@ -418,18 +418,6 @@ "com.amazonaws.sso#RoleCredentials": { "type": "structure", "members": { - "secretAccessKey": { - "target": "com.amazonaws.sso#SecretAccessKeyType", - "traits": { - "smithy.api#documentation": "

    The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

    " - } - }, - "accessKeyId": { - "target": "com.amazonaws.sso#AccessKeyType", - "traits": { - "smithy.api#documentation": "

    The identifier used for the temporary security credentials. For more information, see\n Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

    " - } - }, "expiration": { "target": "com.amazonaws.sso#ExpirationTimestampType", "traits": { @@ -441,6 +429,18 @@ "traits": { "smithy.api#documentation": "

    The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

    " } + }, + "accessKeyId": { + "target": "com.amazonaws.sso#AccessKeyType", + "traits": { + "smithy.api#documentation": "

    The identifier used for the temporary security credentials. For more information, see\n Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

    " + } + }, + "secretAccessKey": { + "target": "com.amazonaws.sso#SecretAccessKeyType", + "traits": { + "smithy.api#documentation": "

    The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the\n AWS IAM User Guide.

    " + } } }, "traits": { @@ -450,17 +450,17 @@ "com.amazonaws.sso#RoleInfo": { "type": "structure", "members": { - "roleName": { - "target": "com.amazonaws.sso#RoleNameType", - "traits": { - "smithy.api#documentation": "

    The friendly name of the role that is assigned to the user.

    " - } - }, "accountId": { "target": "com.amazonaws.sso#AccountIdType", "traits": { "smithy.api#documentation": "

    The identifier of the AWS account assigned to the user.

    " } + }, + "roleName": { + "target": "com.amazonaws.sso#RoleNameType", + "traits": { + "smithy.api#documentation": "

    The friendly name of the role that is assigned to the user.

    " + } } }, "traits": { @@ -498,7 +498,7 @@ "sdkId": "SSO", "arnNamespace": "awsssoportal", "cloudFormationName": "SSO", - "cloudTrailEventSource": "portal.switchboard.amazonaws.com" + "cloudTrailEventSource": "sso.amazonaws.com" }, "aws.auth#sigv4": { "name": "awsssoportal" diff --git a/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json b/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json index fa8045030053..87c23acda16e 100644 --- a/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json +++ b/codegen/sdk-codegen/aws-models/storage-gateway.2013-06-30.json @@ -52,30 +52,36 @@ "com.amazonaws.storagegateway#ActivateGatewayInput": { "type": "structure", "members": { - "GatewayType": { - "target": "com.amazonaws.storagegateway#GatewayType", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.

    \n\n

    Valid Values: STORED | CACHED | VTL |\n FILE_S3\n

    " + "smithy.api#documentation": "

    A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers that can be\n represented in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.

    \n     " } }, - "GatewayRegion": { - "target": "com.amazonaws.storagegateway#RegionId", + "GatewayName": { + "target": "com.amazonaws.storagegateway#GatewayName", "traits": { - "smithy.api#documentation": "

    A value that indicates the AWS Region where you want to store your data. The gateway AWS\n Region specified must be the same AWS Region as the AWS Region in your Host\n header in the request. For more information about available AWS Regions and endpoints for\n AWS Storage Gateway, see AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.

    \n\n

    Valid Values: See AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.\n \n

    ", + "smithy.api#documentation": "

    The name you configured for your gateway.

    ", + "smithy.api#required": {} + } + }, + "ActivationKey": { + "target": "com.amazonaws.storagegateway#ActivationKey", + "traits": { + "smithy.api#documentation": "

    Your gateway activation key. You can obtain the activation key by sending an HTTP GET\n request with redirects enabled to the gateway IP address (port 80). The redirect URL\n returned in the response provides you the activation key for your gateway in the query\n string parameter activationKey. It may also include other activation-related\n parameters, however, these are merely defaults -- the arguments you pass to the\n ActivateGateway API call determine the actual configuration of your\n gateway.

    \n\n \n\n

    For more information, see Getting activation\n key in the AWS Storage Gateway User Guide.

    ", "smithy.api#required": {} } }, "MediumChangerType": { "target": "com.amazonaws.storagegateway#MediumChangerType", "traits": { - "smithy.api#documentation": "

    The value that indicates the type of medium changer to use for tape gateway. This field\n is optional.

    \n\n

    Valid Values: STK-L700 | AWS-Gateway-VTL\n

    " + "smithy.api#documentation": "

    The value that indicates the type of medium changer to use for tape gateway. This field\n is optional.

    \n\n

    Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402\n

    " } }, - "ActivationKey": { - "target": "com.amazonaws.storagegateway#ActivationKey", + "GatewayType": { + "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "

    Your gateway activation key. You can obtain the activation key by sending an HTTP GET\n request with redirects enabled to the gateway IP address (port 80). The redirect URL\n returned in the response provides you the activation key for your gateway in the query\n string parameter activationKey. It may also include other activation-related\n parameters, however, these are merely defaults -- the arguments you pass to the\n ActivateGateway API call determine the actual configuration of your\n gateway.

    \n\n \n\n

    For more information, see Getting activation\n key in the AWS Storage Gateway User Guide.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.

    \n\n

    Valid Values: STORED | CACHED | VTL |\n FILE_S3\n

    " } }, "TapeDriveType": { @@ -91,18 +97,12 @@ "smithy.api#required": {} } }, - "GatewayName": { - "target": "com.amazonaws.storagegateway#GatewayName", + "GatewayRegion": { + "target": "com.amazonaws.storagegateway#RegionId", "traits": { - "smithy.api#documentation": "

    The name you configured for your gateway.

    ", + "smithy.api#documentation": "

    A value that indicates the AWS Region where you want to store your data. The gateway AWS\n Region specified must be the same AWS Region as the AWS Region in your Host\n header in the request. For more information about available AWS Regions and endpoints for\n AWS Storage Gateway, see AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.

    \n\n

    Valid Values: See AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.\n \n

    ", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers that can be\n represented in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.

    \n     " - } } }, "traits": { @@ -226,17 +226,17 @@ "com.amazonaws.storagegateway#AddTagsToResourceInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "ResourceARN": { + "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { - "smithy.api#documentation": "

    The key-value pair that represents the tag you want to add to the resource. The value\n can be an empty string.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

    ", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.storagegateway#ResourceARN", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

    ", + "smithy.api#documentation": "

    The key-value pair that represents the tag you want to add to the resource. The value\n can be an empty string.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     ", "smithy.api#required": {} } } @@ -328,16 +328,16 @@ "com.amazonaws.storagegateway#AddWorkingStorageInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "DiskIds": { + "target": "com.amazonaws.storagegateway#DiskIds", "traits": { + "smithy.api#documentation": "

    An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.

    ", "smithy.api#required": {} } }, - "DiskIds": { - "target": "com.amazonaws.storagegateway#DiskIds", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.

    ", "smithy.api#required": {} } } @@ -387,6 +387,12 @@ "smithy.api#required": {} } }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "

    Set\n permissions to bypass governance retention. If the lock type of the archived tape is\n Governance, the tape's archived age is not older than\n RetentionLockInDays, and the user does not already have\n BypassGovernanceRetention, setting this to TRUE enables the user to bypass\n the retention lock. This parameter is set to true by default for calls from the\n console.

    \n \n

    Valid values: TRUE | FALSE\n

    " + } + }, "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { @@ -430,19 +436,19 @@ "com.amazonaws.storagegateway#AttachVolumeInput": { "type": "structure", "members": { - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

    ", - "smithy.api#required": {} - } - }, "TargetName": { "target": "com.amazonaws.storagegateway#TargetName", "traits": { "smithy.api#documentation": "

    The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.

    \n\n

    If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.

    " } }, + "NetworkInterfaceId": { + "target": "com.amazonaws.storagegateway#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4\n addresses are accepted. Use DescribeGatewayInformation to get a list of\n the network interfaces available on a gateway.

    \n\n

    Valid Values: A valid IP address.

    ", + "smithy.api#required": {} + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { @@ -456,10 +462,10 @@ "smithy.api#documentation": "

    The unique device ID or other distinguishing data that identifies the local disk used to\n create the volume. This value is only required when you are attaching a stored\n volume.

    " } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.storagegateway#NetworkInterfaceId", + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { - "smithy.api#documentation": "

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4\n addresses are accepted. Use DescribeGatewayInformation to get a list of\n the network interfaces available on a gateway.

    \n\n

    Valid Values: A valid IP address.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

    ", "smithy.api#required": {} } } @@ -471,17 +477,17 @@ "com.amazonaws.storagegateway#AttachVolumeOutput": { "type": "structure", "members": { - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume that was attached to the gateway.

    " - } - }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for\n the initiator that was used to connect to the target.

    " } + }, + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume that was attached to the gateway.

    " + } } }, "traits": { @@ -533,6 +539,19 @@ "com.amazonaws.storagegateway#AutomaticTapeCreationRule": { "type": "structure", "members": { + "TapeBarcodePrefix": { + "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", + "traits": { + "smithy.api#documentation": "

    A prefix that you append to the barcode of the virtual tape that you are creating. This\n prefix makes the barcode unique.

    \n\n \n

    The prefix must be 1-4 characters in length and must be one of the uppercase letters\n from A to Z.

    \n     ", + "smithy.api#required": {} + } + }, + "Worm": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "

    Set to true to indicate that tapes are to be archived as \n write-once-read-many (WORM). Set to false when WORM is not enabled \n for tapes.

    " + } + }, "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { @@ -550,20 +569,13 @@ "MinimumNumTapes": { "target": "com.amazonaws.storagegateway#MinimumNumTapes", "traits": { - "smithy.api#documentation": "

    The minimum number of available virtual tapes that the gateway maintains at all times.\n If the number of tapes on the gateway goes below this value, the gateway creates as many\n new tapes as are needed to have MinimumNumTapes on the gateway.

    ", - "smithy.api#required": {} - } - }, - "TapeBarcodePrefix": { - "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", - "traits": { - "smithy.api#documentation": "

    A prefix that you append to the barcode of the virtual tape that you are creating. This\n prefix makes the barcode unique.

    \n\n \n

    The prefix must be 1-4 characters in length and must be one of the uppercase letters\n from A to Z.

    \n     ", + "smithy.api#documentation": "

    The minimum number of available virtual tapes that the gateway maintains at all times.\n If the number of tapes on the gateway goes below this value, the gateway creates as many\n new tapes as are needed to have MinimumNumTapes on the gateway. For more\n information about automatic tape creation, see Creating Tapes Automatically.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    An automatic tape creation policy consists of automatic tape creation rules where each\n rule defines when and how to create new tapes.

    " + "smithy.api#documentation": "

    An automatic tape creation policy consists of automatic tape creation rules where each\n rule defines when and how to create new tapes. For more information about automatic tape\n creation, see Creating Tapes Automatically.

    " } }, "com.amazonaws.storagegateway#AutomaticTapeCreationRules": { @@ -653,55 +665,34 @@ "com.amazonaws.storagegateway#CachediSCSIVolume": { "type": "structure", "members": { - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" - }, - "VolumeId": { - "target": "com.amazonaws.storagegateway#VolumeId", - "traits": { - "smithy.api#documentation": "

    The unique identifier of the volume, e.g. vol-AE4B946D.

    " - } - }, - "VolumeSizeInBytes": { - "target": "com.amazonaws.storagegateway#long", - "traits": { - "smithy.api#documentation": "

    The size, in bytes, of the volume capacity.

    " - } - }, - "VolumeType": { - "target": "com.amazonaws.storagegateway#VolumeType", - "traits": { - "smithy.api#documentation": "

    One of the VolumeType enumeration values that describes the type of the volume.

    " - } - }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the storage volume.

    " } }, - "SourceSnapshotId": { - "target": "com.amazonaws.storagegateway#SnapshotId", + "VolumeType": { + "target": "com.amazonaws.storagegateway#VolumeType", "traits": { - "smithy.api#documentation": "

    If the cached volume was created from a snapshot, this field contains the snapshot ID\n used, e.g. snap-78e22663. Otherwise, this field is not included.

    " + "smithy.api#documentation": "

    One of the VolumeType enumeration values that describes the type of the volume.

    " } }, - "VolumeAttachmentStatus": { - "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", + "TargetName": { + "target": "com.amazonaws.storagegateway#TargetName", "traits": { - "smithy.api#documentation": "

    A value that indicates whether a storage volume is attached to or detached from a\n gateway. For more information, see Moving\n your volumes to a different gateway.

    " + "smithy.api#documentation": "

    The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.

    \n\n

    If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.

    " } }, - "VolumeStatus": { - "target": "com.amazonaws.storagegateway#VolumeStatus", + "VolumeId": { + "target": "com.amazonaws.storagegateway#VolumeId", "traits": { - "smithy.api#documentation": "

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + "smithy.api#documentation": "

    The unique identifier of the volume, e.g., vol-AE4B946D.

    " } }, - "TargetName": { - "target": "com.amazonaws.storagegateway#TargetName", + "VolumeProgress": { + "target": "com.amazonaws.storagegateway#DoubleObject", "traits": { - "smithy.api#documentation": "

    The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.

    \n\n

    If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.

    " + "smithy.api#documentation": "

    Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the cached volume is not restoring or bootstrapping.

    " } }, "VolumeiSCSIAttributes": { @@ -710,16 +701,22 @@ "smithy.api#documentation": "

    An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.

    " } }, - "VolumeProgress": { - "target": "com.amazonaws.storagegateway#DoubleObject", + "CreatedDate": { + "target": "com.amazonaws.storagegateway#CreatedDate", "traits": { - "smithy.api#documentation": "

    Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the cached volume is not restoring or bootstrapping.

    " + "smithy.api#documentation": "

    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this\n timestamp.

    " } }, - "CreatedDate": { - "target": "com.amazonaws.storagegateway#CreatedDate", + "VolumeAttachmentStatus": { + "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", + "traits": { + "smithy.api#documentation": "

    A value that indicates whether a storage volume is attached to or detached from a\n gateway. For more information, see Moving\n your volumes to a different gateway.

    " + } + }, + "SourceSnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { - "smithy.api#documentation": "

    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this\n time stamp.

    " + "smithy.api#documentation": "

    If the cached volume was created from a snapshot, this field contains the snapshot ID\n used, e.g., snap-78e22663. Otherwise, this field is not included.

    " } }, "VolumeUsedInBytes": { @@ -727,6 +724,21 @@ "traits": { "smithy.api#documentation": "

    The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.

    \n\n \n

    This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

    \n     " } + }, + "VolumeSizeInBytes": { + "target": "com.amazonaws.storagegateway#long", + "traits": { + "smithy.api#documentation": "

    The size, in bytes, of the volume capacity.

    " + } + }, + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey" + }, + "VolumeStatus": { + "target": "com.amazonaws.storagegateway#VolumeStatus", + "traits": { + "smithy.api#documentation": "

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + } } }, "traits": { @@ -762,16 +774,16 @@ "com.amazonaws.storagegateway#CancelArchivalInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving\n for.

    ", "smithy.api#required": {} } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving\n for.

    ", "smithy.api#required": {} } } @@ -817,16 +829,16 @@ "com.amazonaws.storagegateway#CancelRetrievalInput": { "type": "structure", "members": { - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval\n for.

    ", "smithy.api#required": {} } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval\n for.

    ", "smithy.api#required": {} } } @@ -871,16 +883,16 @@ "com.amazonaws.storagegateway#ChapInfo": { "type": "structure", "members": { - "TargetARN": { - "target": "com.amazonaws.storagegateway#TargetARN", + "SecretToAuthenticateInitiator": { + "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume.

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + "smithy.api#documentation": "

    The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.

    " } }, - "SecretToAuthenticateInitiator": { + "SecretToAuthenticateTarget": { "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { - "smithy.api#documentation": "

    The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.

    " + "smithy.api#documentation": "

    The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g., Windows client).

    " } }, "InitiatorName": { @@ -889,10 +901,10 @@ "smithy.api#documentation": "

    The iSCSI initiator that connects to the target.

    " } }, - "SecretToAuthenticateTarget": { - "target": "com.amazonaws.storagegateway#ChapSecret", + "TargetARN": { + "target": "com.amazonaws.storagegateway#TargetARN", "traits": { - "smithy.api#documentation": "

    The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g. Windows client).

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume.

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " } } }, @@ -951,6 +963,31 @@ "com.amazonaws.storagegateway#CreateCachediSCSIVolumeInput": { "type": "structure", "members": { + "SnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", + "traits": { + "smithy.api#documentation": "

    The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.

    " + } + }, + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#required": {} + } + }, + "VolumeSizeInBytes": { + "target": "com.amazonaws.storagegateway#long", + "traits": { + "smithy.api#documentation": "

    The size of the volume in bytes.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "

    A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers that you can\n represent in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.

    \n     " + } + }, "SourceVolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { @@ -971,11 +1008,10 @@ "smithy.api#required": {} } }, - "VolumeSizeInBytes": { - "target": "com.amazonaws.storagegateway#long", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The size of the volume in bytes.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, "KMSKey": { @@ -984,53 +1020,29 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " } }, - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean", - "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " - } - }, - "TargetName": { - "target": "com.amazonaws.storagegateway#TargetName", + "TargetName": { + "target": "com.amazonaws.storagegateway#TargetName", "traits": { "smithy.api#documentation": "

    The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.

    \n\n

    If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.

    ", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers that you can\n represent in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.

    \n     " - } - }, - "SnapshotId": { - "target": "com.amazonaws.storagegateway#SnapshotId", - "traits": { - "smithy.api#documentation": "

    The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.

    " - } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", - "traits": { - "smithy.api#required": {} - } } } }, "com.amazonaws.storagegateway#CreateCachediSCSIVolumeOutput": { "type": "structure", "members": { - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the configured volume.

    " - } - }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that\n initiators can use to connect to the target.

    " } + }, + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the configured volume.

    " + } } } }, @@ -1057,23 +1069,34 @@ "com.amazonaws.storagegateway#CreateNFSFileShareInput": { "type": "structure", "members": { - "DefaultStorageClass": { - "target": "com.amazonaws.storagegateway#StorageClass", + "GuessMIMETypeEnabled": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " + "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " } }, - "KMSEncrypted": { + "ReadOnly": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " } }, - "Role": { - "target": "com.amazonaws.storagegateway#Role", + "ObjectACL": { + "target": "com.amazonaws.storagegateway#ObjectACL", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes\n when it accesses the underlying storage.

    ", - "smithy.api#required": {} + "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.

    " + } + }, + "FileShareName": { + "target": "com.amazonaws.storagegateway#FileShareName", + "traits": { + "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " + } + }, + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", + "traits": { + "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " } }, "ClientList": { @@ -1082,16 +1105,29 @@ "smithy.api#documentation": "

    The list of clients that are allowed to access the file gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.

    " } }, + "Role": { + "target": "com.amazonaws.storagegateway#Role", + "traits": { + "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes\n when it accesses the underlying storage.

    ", + "smithy.api#required": {} + } + }, "KMSKey": { "target": "com.amazonaws.storagegateway#KMSKey", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " } }, - "ReadOnly": { + "Squash": { + "target": "com.amazonaws.storagegateway#Squash", + "traits": { + "smithy.api#documentation": "

    A value that maps a user to anonymous user.

    \n\n

    Valid values are the following:

    \n\n
      \n
    • \n

      \n RootSquash: Only root is mapped to anonymous user.

      \n
      • \n
    • \n

      \n NoSquash: No one is mapped to anonymous user.

      \n
      • \n
    • \n

      \n AllSquash: Everyone is mapped to anonymous user.

      \n
      • \n
    " + } + }, + "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, "GatewayARN": { @@ -1101,18 +1137,6 @@ "smithy.api#required": {} } }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", - "traits": { - "smithy.api#documentation": "

    Refresh cache information.

    " - } - }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " - } - }, "NFSFileShareDefaults": { "target": "com.amazonaws.storagegateway#NFSFileShareDefaults", "traits": { @@ -1125,6 +1149,12 @@ "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " } }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + } + }, "ClientToken": { "target": "com.amazonaws.storagegateway#ClientToken", "traits": { @@ -1139,28 +1169,10 @@ "smithy.api#required": {} } }, - "Squash": { - "target": "com.amazonaws.storagegateway#Squash", - "traits": { - "smithy.api#documentation": "

    A value that maps a user to anonymous user.

    \n\n

    Valid values are the following:

    \n\n
      \n
    • \n

      \n RootSquash: Only root is mapped to anonymous user.

      \n
      • \n
    • \n

      \n NoSquash: No one is mapped to anonymous user.

      \n
      • \n
    • \n

      \n AllSquash: Everyone is mapped to anonymous user.

      \n
      • \n
    " - } - }, - "GuessMIMETypeEnabled": { - "target": "com.amazonaws.storagegateway#Boolean", - "traits": { - "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " - } - }, - "FileShareName": { - "target": "com.amazonaws.storagegateway#FileShareName", - "traits": { - "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " - } - }, - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL", + "CacheAttributes": { + "target": "com.amazonaws.storagegateway#CacheAttributes", "traits": { - "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#documentation": "

    Refresh cache information.

    " } } }, @@ -1199,61 +1211,58 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage\n Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage.\n Storage Gateway expose file shares using an SMB interface. This operation is only supported\n for file gateways.

    \n\n \n

    File gateways require AWS Security Token Service (AWS STS) to be activated to enable\n you to create a file share. Make sure that AWS STS is activated in the AWS Region you\n are creating your file gateway in. If AWS STS is not activated in this AWS Region,\n activate it. For information about how to activate AWS STS, see Activating and\n deactivating AWS STS in an AWS Region in the AWS Identity and\n Access Management User Guide.

    \n\n

    File gateways don't support creating hard or symbolic links on a file\n share.

    \n     " + "smithy.api#documentation": "

    Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage\n Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage.\n Storage Gateway exposes file shares using an SMB interface. This operation is only\n supported for file gateways.

    \n\n \n

    File gateways require AWS Security Token Service (AWS STS) to be activated to enable\n you to create a file share. Make sure that AWS STS is activated in the AWS Region you\n are creating your file gateway in. If AWS STS is not activated in this AWS Region,\n activate it. For information about how to activate AWS STS, see Activating and\n deactivating AWS STS in an AWS Region in the AWS Identity and\n Access Management User Guide.

    \n\n

    File gateways don't support creating hard or symbolic links on a file\n share.

    \n     " } }, "com.amazonaws.storagegateway#CreateSMBFileShareInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "InvalidUserList": { + "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    The ARN of the file gateway on which you want to create a file share.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean", + "ObjectACL": { + "target": "com.amazonaws.storagegateway#ObjectACL", "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + "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.

    " } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "ValidUserList": { + "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats\n include: DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

    Refresh cache information.

    " + "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " } }, - "Role": { - "target": "com.amazonaws.storagegateway#Role", + "ReadOnly": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes\n when it accesses the underlying storage.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " } }, - "SMBACLEnabled": { + "GuessMIMETypeEnabled": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.

    \n\n \n\n

    For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " } }, - "AdminUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", + "FileShareName": { + "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that will be granted administrator\n privileges on the file share. These users can do all file operations as the super-user.\n Acceptable formats include: DOMAIN\\User1, user1,\n @group1, and @DOMAIN\\group1.

    \n\n \n

    Use this option very carefully, because any user in this list can do anything they\n like on the file share, regardless of file permissions.

    \n     " + "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " } }, - "LocationARN": { - "target": "com.amazonaws.storagegateway#LocationARN", + "Authentication": { + "target": "com.amazonaws.storagegateway#Authentication", "traits": { - "smithy.api#documentation": "

    The ARN of the backend storage used for storing file data. A prefix name can be added to\n the S3 bucket name. It must end with a \"/\".

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The authentication method that users use to access the file share. The default is\n ActiveDirectory.

    \n\n

    Valid Values: ActiveDirectory | GuestAccess\n

    " } }, "KMSKey": { @@ -1262,22 +1271,23 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " } }, - "ValidUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", + "SMBACLEnabled": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats\n include: DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " + "smithy.api#documentation": "

    Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.

    \n\n \n\n

    For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.

    \n\n

    Valid Values: true | false\n

    " } }, - "CaseSensitivity": { - "target": "com.amazonaws.storagegateway#CaseSensitivity", + "LocationARN": { + "target": "com.amazonaws.storagegateway#LocationARN", "traits": { - "smithy.api#documentation": "

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.

    " + "smithy.api#documentation": "

    The ARN of the backend storage used for storing file data. A prefix name can be added to\n the S3 bucket name. It must end with a \"/\".

    ", + "smithy.api#required": {} } }, - "ReadOnly": { - "target": "com.amazonaws.storagegateway#Boolean", + "AdminUserList": { + "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that will be granted administrator\n privileges on the file share. These users can do all file operations as the super-user.\n Acceptable formats include: DOMAIN\\User1, user1,\n @group1, and @DOMAIN\\group1.

    \n\n \n

    Use this option very carefully, because any user in this list can do anything they\n like on the file share, regardless of file permissions.

    \n     " } }, "AuditDestinationARN": { @@ -1286,53 +1296,55 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the storage used for the audit logs.

    " } }, - "Authentication": { - "target": "com.amazonaws.storagegateway#Authentication", + "CaseSensitivity": { + "target": "com.amazonaws.storagegateway#CaseSensitivity", "traits": { - "smithy.api#documentation": "

    The authentication method that users use to access the file share. The default is\n ActiveDirectory.

    \n\n

    Valid Values: ActiveDirectory | GuestAccess\n

    " + "smithy.api#documentation": "

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.

    " } }, - "ClientToken": { - "target": "com.amazonaws.storagegateway#ClientToken", + "RequesterPays": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A unique string value that you supply that is used by file gateway to ensure idempotent\n file share creation.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " } }, - "GuessMIMETypeEnabled": { + "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, - "InvalidUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", + "ClientToken": { + "target": "com.amazonaws.storagegateway#ClientToken", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " + "smithy.api#documentation": "

    A unique string value that you supply that is used by file gateway to ensure idempotent\n file share creation.

    ", + "smithy.api#required": {} } }, - "FileShareName": { - "target": "com.amazonaws.storagegateway#FileShareName", + "Role": { + "target": "com.amazonaws.storagegateway#Role", "traits": { - "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " + "smithy.api#documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes\n when it accesses the underlying storage.

    ", + "smithy.api#required": {} } }, - "RequesterPays": { - "target": "com.amazonaws.storagegateway#Boolean", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    The ARN of the file gateway on which you want to create a file share.

    ", + "smithy.api#required": {} } }, - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "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#documentation": "

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " } }, - "DefaultStorageClass": { - "target": "com.amazonaws.storagegateway#StorageClass", + "CacheAttributes": { + "target": "com.amazonaws.storagegateway#CacheAttributes", "traits": { - "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " + "smithy.api#documentation": "

    Refresh cache information.

    " } } }, @@ -1374,7 +1386,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Initiates a snapshot of a volume.

    \n\n

    AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data\n to Amazon Simple Storage (Amazon S3) for durable off-site recovery, as well as import the\n data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2).\n You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API\n enables you to take ad-hoc snapshot. For more information, see Editing a\n snapshot schedule.

    \n\n

    In the CreateSnapshot request you identify the volume by providing its Amazon Resource\n Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway\n takes the snapshot of specified volume, the snapshot and description appears in the AWS\n Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You\n can use this snapshot ID to check the snapshot progress or later use it when you want to\n create a volume from a snapshot. This operation is only supported in stored and cached\n volume gateway type.

    \n\n \n

    To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n see DescribeSnapshots\n or DeleteSnapshot in the Amazon Elastic Compute Cloud API\n Reference.

    \n     \n\n \n

    Volume and snapshot IDs are changing to a longer length ID format. For more\n information, see the important note on the Welcome page.

    \n     " + "smithy.api#documentation": "

    Initiates a snapshot of a volume.

    \n\n

    AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data\n to Amazon Simple Storage (Amazon S3) for durable off-site recovery, as well as import the\n data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2).\n You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API\n enables you to take an ad hoc snapshot. For more information, see Editing a\n snapshot schedule.

    \n\n

    In the CreateSnapshot request, you identify the volume by providing its\n Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS\n Storage Gateway takes the snapshot of specified volume, the snapshot and description\n appears in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a\n snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it\n when you want to create a volume from a snapshot. This operation is only supported in\n stored and cached volume gateway type.

    \n\n \n

    To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n see DescribeSnapshots\n or DeleteSnapshot in the Amazon Elastic Compute Cloud API\n Reference.

    \n     \n\n \n

    Volume and snapshot IDs are changing to a longer length ID format. For more\n information, see the important note on the Welcome page.

    \n     " } }, "com.amazonaws.storagegateway#CreateSnapshotFromVolumeRecoveryPoint": { @@ -1409,17 +1421,17 @@ "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " } }, - "SnapshotDescription": { - "target": "com.amazonaws.storagegateway#SnapshotDescription", + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { - "smithy.api#documentation": "

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and\n in the AWS Storage Gateway snapshot Details pane,\n Description field.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.

    ", "smithy.api#required": {} } }, - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", + "SnapshotDescription": { + "target": "com.amazonaws.storagegateway#SnapshotDescription", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.

    ", + "smithy.api#documentation": "

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and\n in the AWS Storage Gateway snapshot Details pane,\n Description field.

    ", "smithy.api#required": {} } } @@ -1434,23 +1446,29 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.

    " } }, - "SnapshotId": { - "target": "com.amazonaws.storagegateway#SnapshotId", - "traits": { - "smithy.api#documentation": "

    The ID of the snapshot.

    " - } - }, "VolumeRecoveryPointTime": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "

    The time the volume was created from the recovery point.

    " } + }, + "SnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", + "traits": { + "smithy.api#documentation": "

    The ID of the snapshot.

    " + } } } }, "com.amazonaws.storagegateway#CreateSnapshotInput": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + } + }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { @@ -1464,12 +1482,6 @@ "smithy.api#documentation": "

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and\n in the AWS Storage Gateway snapshot Details pane,\n Description field.

    ", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " - } } }, "traits": { @@ -1479,17 +1491,17 @@ "com.amazonaws.storagegateway#CreateSnapshotOutput": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.storagegateway#SnapshotId", - "traits": { - "smithy.api#documentation": "

    The snapshot ID that is used to refer to the snapshot in future operations such as\n describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or\n creating a volume from a snapshot (CreateStorediSCSIVolume).

    " - } - }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

    " } + }, + "SnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", + "traits": { + "smithy.api#documentation": "

    The snapshot ID that is used to refer to the snapshot in future operations such as\n describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or\n creating a volume from a snapshot (CreateStorediSCSIVolume).

    " + } } }, "traits": { @@ -1513,23 +1525,23 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a volume on a specified gateway. This operation is only supported in the stored\n volume gateway type.

    \n\n

    The size of the volume to create is inferred from the disk size. You can choose to\n preserve existing data on the disk, create volume from an existing snapshot, or create an\n empty volume. If you choose to create an empty gateway volume, then any existing data on\n the disk is erased.

    \n\n

    In the request you must specify the gateway and the disk information on which you are\n creating the volume. In response, the gateway creates the volume and returns volume\n information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target\n ARN that initiators can use to connect to the volume target.

    " + "smithy.api#documentation": "

    Creates a volume on a specified gateway. This operation is only supported in the stored\n volume gateway type.

    \n\n

    The size of the volume to create is inferred from the disk size. You can choose to\n preserve existing data on the disk, create volume from an existing snapshot, or create an\n empty volume. If you choose to create an empty gateway volume, then any existing data on\n the disk is erased.

    \n\n

    In the request, you must specify the gateway and the disk information on which you are\n creating the volume. In response, the gateway creates the volume and returns volume\n information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target\n ARN that initiators can use to connect to the volume target.

    " } }, "com.amazonaws.storagegateway#CreateStorediSCSIVolumeInput": { "type": "structure", "members": { - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean", + "DiskId": { + "target": "com.amazonaws.storagegateway#DiskId", "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    The unique identifier for the gateway local disk that is configured as a stored volume.\n Use ListLocalDisks to\n list disk IDs for a gateway.

    ", + "smithy.api#required": {} } }, - "TargetName": { - "target": "com.amazonaws.storagegateway#TargetName", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.

    \n\n

    If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " } }, "KMSKey": { @@ -1538,42 +1550,42 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "SnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

    The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.

    " } }, - "DiskId": { - "target": "com.amazonaws.storagegateway#DiskId", + "TargetName": { + "target": "com.amazonaws.storagegateway#TargetName", "traits": { - "smithy.api#documentation": "

    The unique identifier for the gateway local disk that is configured as a stored volume.\n Use ListLocalDisks to\n list disk IDs for a gateway.

    ", + "smithy.api#documentation": "

    The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.

    \n\n

    If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.storagegateway#NetworkInterfaceId", + "PreserveExistingData": { + "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4\n addresses are accepted. Use DescribeGatewayInformation to get a list of\n the network interfaces available on a gateway.

    \n\n

    Valid Values: A valid IP address.

    ", + "smithy.api#documentation": "

    Set to true true if you want to preserve the data on the local disk.\n Otherwise, set to false to create an empty volume.

    \n\n

    Valid Values: true | false\n

    ", "smithy.api#required": {} } }, - "SnapshotId": { - "target": "com.amazonaws.storagegateway#SnapshotId", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.

    " + "smithy.api#required": {} } }, - "PreserveExistingData": { - "target": "com.amazonaws.storagegateway#Boolean2", + "NetworkInterfaceId": { + "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "

    Set to true true if you want to preserve the data on the local disk.\n Otherwise, set to false to create an empty volume.

    \n\n

    Valid Values: true | false\n

    ", + "smithy.api#documentation": "

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4\n addresses are accepted. Use DescribeGatewayInformation to get a list of\n the network interfaces available on a gateway.

    \n\n

    Valid Values: A valid IP address.

    ", "smithy.api#required": {} } } @@ -1585,18 +1597,18 @@ "com.amazonaws.storagegateway#CreateStorediSCSIVolumeOutput": { "type": "structure", "members": { - "VolumeSizeInBytes": { - "target": "com.amazonaws.storagegateway#long", - "traits": { - "smithy.api#documentation": "

    The size of the volume in bytes.

    " - } - }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that\n initiators can use to connect to the target.

    " } }, + "VolumeSizeInBytes": { + "target": "com.amazonaws.storagegateway#long", + "traits": { + "smithy.api#documentation": "

    The size of the volume in bytes.

    " + } + }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { @@ -1608,13 +1620,13 @@ "smithy.api#documentation": "

    A JSON object containing the following fields:

    " } }, - "com.amazonaws.storagegateway#CreateTapeWithBarcode": { + "com.amazonaws.storagegateway#CreateTapePool": { "type": "operation", "input": { - "target": "com.amazonaws.storagegateway#CreateTapeWithBarcodeInput" + "target": "com.amazonaws.storagegateway#CreateTapePoolInput" }, "output": { - "target": "com.amazonaws.storagegateway#CreateTapeWithBarcodeOutput" + "target": "com.amazonaws.storagegateway#CreateTapePoolOutput" }, "errors": [ { @@ -1625,31 +1637,80 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a virtual tape by using your own barcode. You write data to the virtual tape and\n then archive the tape. A barcode is unique and can not be reused if it has already been\n used on a tape. This applies to barcodes used on deleted tapes. This operation is only\n supported in the tape gateway type.

    \n\n \n

    Cache storage must be allocated to the gateway before you can create a virtual tape.\n Use the AddCache operation to add cache storage to a gateway.

    \n     " + "smithy.api#documentation": "

    Creates a new custom tape pool.\n You can use custom tape pool to enable tape retention lock on tapes that are \n archived in the custom pool.

    " } }, - "com.amazonaws.storagegateway#CreateTapeWithBarcodeInput": { + "com.amazonaws.storagegateway#CreateTapePoolInput": { "type": "structure", "members": { - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean", + "RetentionLockType": { + "target": "com.amazonaws.storagegateway#RetentionLockType", "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    Tape retention lock can be configured in two modes. When configured in governance \n mode, AWS accounts with specific IAM permissions are authorized to remove the tape retention lock\n from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot\n be removed by any user, including the root AWS account.

    " } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey", + "RetentionLockTimeInDays": { + "target": "com.amazonaws.storagegateway#RetentionLockTimeInDays", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " + "smithy.api#documentation": "

    Tape retention lock time is set in days. Tape retention lock can be enabled for up \n to 100 years (36,500 days).

    " } }, - "TapeBarcode": { - "target": "com.amazonaws.storagegateway#TapeBarcode", + "StorageClass": { + "target": "com.amazonaws.storagegateway#TapeStorageClass", "traits": { - "smithy.api#documentation": "

    The barcode that you want to assign to the tape.

    \n\n \n

    Barcodes cannot be reused. This includes barcodes used for tapes that have been\n deleted.

    \n     ", + "smithy.api#documentation": "

    The storage class that is associated with the new custom pool. When you \n use your backup application to eject the tape, the tape is archived directly into\n the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    ", "smithy.api#required": {} } }, + "PoolName": { + "target": "com.amazonaws.storagegateway#PoolName", + "traits": { + "smithy.api#documentation": "

    The name of the new custom tape pool.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value\n pair.

    \n \n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + } + } + } + }, + "com.amazonaws.storagegateway#CreateTapePoolOutput": { + "type": "structure", + "members": { + "PoolARN": { + "target": "com.amazonaws.storagegateway#PoolARN", + "traits": { + "smithy.api#documentation": "

    The unique Amazon Resource Name (ARN) that represents the custom\n tape pool. Use the ListTapePools operation to return a list of\n tape pools for your account and AWS Region.

    " + } + } + } + }, + "com.amazonaws.storagegateway#CreateTapeWithBarcode": { + "type": "operation", + "input": { + "target": "com.amazonaws.storagegateway#CreateTapeWithBarcodeInput" + }, + "output": { + "target": "com.amazonaws.storagegateway#CreateTapeWithBarcodeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.storagegateway#InternalServerError" + }, + { + "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a virtual tape by using your own barcode. You write data to the virtual tape and\n then archive the tape. A barcode is unique and cannot be reused if it has already been used\n on a tape. This applies to barcodes used on deleted tapes. This operation is only supported\n in the tape gateway type.

    \n\n \n

    Cache storage must be allocated to the gateway before you can create a virtual tape.\n Use the AddCache operation to add cache storage to a gateway.

    \n     " + } + }, + "com.amazonaws.storagegateway#CreateTapeWithBarcodeInput": { + "type": "structure", + "members": { "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { @@ -1663,6 +1724,12 @@ "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each\n tag is a key-value pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { @@ -1670,10 +1737,29 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "Worm": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "

    Set to TRUE if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.

    " + } + }, + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " + } + }, + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", + "traits": { + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + } + }, + "TapeBarcode": { + "target": "com.amazonaws.storagegateway#TapeBarcode", "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each\n tag is a key-value pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + "smithy.api#documentation": "

    The barcode that you want to assign to the tape.

    \n\n \n

    Barcodes cannot be reused. This includes barcodes used for tapes that have been\n deleted.

    \n     ", + "smithy.api#required": {} } } }, @@ -1718,63 +1804,69 @@ "com.amazonaws.storagegateway#CreateTapesInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "NumTapesToCreate": { + "target": "com.amazonaws.storagegateway#NumTapesToCreate", "traits": { - "smithy.api#documentation": "

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tapes with. Use the ListGateways operation to return a list of\n gateways for your account and AWS Region.

    ", + "smithy.api#documentation": "

    The number of virtual tapes that you want to create.

    ", "smithy.api#required": {} } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey", + "TapeSizeInBytes": { + "target": "com.amazonaws.storagegateway#TapeSize", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " + "smithy.api#documentation": "

    The size, in bytes, of the virtual tapes that you want to create.

    \n\n \n

    The size must be aligned by gigabyte (1024*1024*1024 bytes).

    \n     ", + "smithy.api#required": {} } }, - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    \n\n

    Valid Values: GLACIER | DEEP_ARCHIVE\n

    " + "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " } }, - "TapeBarcodePrefix": { - "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    A prefix that you append to the barcode of the virtual tape you are creating. This\n prefix makes the barcode unique.

    \n\n \n

    The prefix must be 1 to 4 characters in length and must be one of the uppercase\n letters from A to Z.

    \n     ", + "smithy.api#documentation": "

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tapes with. Use the ListGateways operation to return a list of\n gateways for your account and AWS Region.

    ", "smithy.api#required": {} } }, - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean", + "ClientToken": { + "target": "com.amazonaws.storagegateway#ClientToken", "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    A unique identifier that you use to retry a request. If you retry a request, use the\n same ClientToken you specified in the initial request.

    \n\n \n

    Using the same ClientToken prevents creating the tape multiple\n times.

    \n     ", + "smithy.api#required": {} } }, - "NumTapesToCreate": { - "target": "com.amazonaws.storagegateway#NumTapesToCreate", + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey", "traits": { - "smithy.api#documentation": "

    The number of virtual tapes that you want to create.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " } }, - "TapeSizeInBytes": { - "target": "com.amazonaws.storagegateway#TapeSize", + "TapeBarcodePrefix": { + "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", "traits": { - "smithy.api#documentation": "

    The size, in bytes, of the virtual tapes that you want to create.

    \n\n \n

    The size must be aligned by gigabyte (1024*1024*1024 bytes).

    \n     ", + "smithy.api#documentation": "

    A prefix that you append to the barcode of the virtual tape you are creating. This\n prefix makes the barcode unique.

    \n\n \n

    The prefix must be 1 to 4 characters in length and must be one of the uppercase\n letters from A to Z.

    \n     ", "smithy.api#required": {} } }, - "ClientToken": { - "target": "com.amazonaws.storagegateway#ClientToken", + "Worm": { + "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "

    A unique identifier that you use to retry a request. If you retry a request, use the\n same ClientToken you specified in the initial request.

    \n\n \n

    Using the same ClientToken prevents creating the tape multiple\n times.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Set to TRUE if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.

    " } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "PoolId": { + "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + "smithy.api#documentation": "

    The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    \n\n

    Valid Values: GLACIER | DEEP_ARCHIVE\n

    " + } + }, + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", + "traits": { + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } } }, @@ -1881,16 +1973,16 @@ "com.amazonaws.storagegateway#DeleteBandwidthRateLimitInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "BandwidthType": { + "target": "com.amazonaws.storagegateway#BandwidthType", "traits": { + "smithy.api#documentation": "

    One of the BandwidthType values that indicates the gateway bandwidth rate limit to\n delete.

    \n\n

    Valid Values: UPLOAD | DOWNLOAD | ALL\n

    ", "smithy.api#required": {} } }, - "BandwidthType": { - "target": "com.amazonaws.storagegateway#BandwidthType", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    One of the BandwidthType values that indicates the gateway bandwidth rate limit to\n delete.

    \n\n

    Valid Values: Upload | Download | All\n

    ", "smithy.api#required": {} } } @@ -2089,7 +2181,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a snapshot of a volume.

    \n\n

    You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API\n action enables you to delete a snapshot schedule for a volume. For more information, see\n Backing up your volumes. In the DeleteSnapshotSchedule request,\n you identify the volume by providing its Amazon Resource Name (ARN). This operation is only\n supported in stored and cached volume gateway types.

    \n\n \n\n

    To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to DescribeSnapshots\n in the Amazon Elastic Compute Cloud API Reference.

    \n     " + "smithy.api#documentation": "

    Deletes a snapshot of a volume.

    \n\n

    You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API\n action enables you to delete a snapshot schedule for a volume. For more information, see\n Backing up your volumes. In the DeleteSnapshotSchedule request,\n you identify the volume by providing its Amazon Resource Name (ARN). This operation is only\n supported in stored and cached volume gateway types.

    \n\n \n\n

    To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to DescribeSnapshots\n in the Amazon Elastic Compute Cloud API Reference.

    \n     " } }, "com.amazonaws.storagegateway#DeleteSnapshotScheduleInput": { @@ -2164,6 +2256,12 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf\n (VTS).

    ", "smithy.api#required": {} } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "

    Set to TRUE to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance can be deleted. Archived tapes with tape retention lock set to \n compliance can't be deleted.

    " + } } }, "traits": { @@ -2194,6 +2292,12 @@ "smithy.api#required": {} } }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "

    Set to TRUE to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance can be deleted. Archived tapes with tape retention lock set to \n compliance can't be deleted.

    " + } + }, "TapeARN": { "target": "com.amazonaws.storagegateway#TapeARN", "traits": { @@ -2220,6 +2324,49 @@ "smithy.api#documentation": "

    DeleteTapeOutput

    " } }, + "com.amazonaws.storagegateway#DeleteTapePool": { + "type": "operation", + "input": { + "target": "com.amazonaws.storagegateway#DeleteTapePoolInput" + }, + "output": { + "target": "com.amazonaws.storagegateway#DeleteTapePoolOutput" + }, + "errors": [ + { + "target": "com.amazonaws.storagegateway#InternalServerError" + }, + { + "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

    Delete a custom tape pool. A custom tape pool can only be deleted if \n there are no tapes in the pool and if there are no automatic tape creation \n policies that reference the custom tape pool.

    " + } + }, + "com.amazonaws.storagegateway#DeleteTapePoolInput": { + "type": "structure", + "members": { + "PoolARN": { + "target": "com.amazonaws.storagegateway#PoolARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom tape pool to delete.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.storagegateway#DeleteTapePoolOutput": { + "type": "structure", + "members": { + "PoolARN": { + "target": "com.amazonaws.storagegateway#PoolARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom tape pool being deleted.

    " + } + } + } + }, "com.amazonaws.storagegateway#DeleteVolume": { "type": "operation", "input": { @@ -2269,6 +2416,15 @@ "smithy.api#documentation": "

    A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was\n deleted.

    " } }, + "com.amazonaws.storagegateway#DeprecationDate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.storagegateway#DescribeAvailabilityMonitorTest": { "type": "operation", "input": { @@ -2337,7 +2493,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns the bandwidth rate limits of a gateway. By default, these limits are not set,\n which means no bandwidth rate limiting is in effect. This operation is supported for the\n stored volume, cached volume and tape gateway types.

    \n\n

    This operation only returns a value for a bandwidth rate limit only if the limit is set.\n If no limits are set for the gateway, then this operation returns only the gateway ARN in\n the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN)\n of the gateway in your request.

    " + "smithy.api#documentation": "

    Returns the bandwidth rate limits of a gateway. By default, these limits are not set,\n which means no bandwidth rate limiting is in effect. This operation is supported for the\n stored volume, cached volume, and tape gateway types.

    \n\n

    This operation only returns a value for a bandwidth rate limit only if the limit is set.\n If no limits are set for the gateway, then this operation returns only the gateway ARN in\n the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN)\n of the gateway in your request.

    " } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimitInput": { @@ -2357,6 +2513,12 @@ "com.amazonaws.storagegateway#DescribeBandwidthRateLimitOutput": { "type": "structure", "members": { + "AverageDownloadRateLimitInBitsPerSec": { + "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", + "traits": { + "smithy.api#documentation": "

    The average download bandwidth rate limit in bits per second. This field does not appear\n in the response if the download rate limit is not set.

    " + } + }, "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { @@ -2365,12 +2527,6 @@ }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" - }, - "AverageDownloadRateLimitInBitsPerSec": { - "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", - "traits": { - "smithy.api#documentation": "

    The average download bandwidth rate limit in bits per second. This field does not appear\n in the response if the download rate limit is not set.

    " - } } }, "traits": { @@ -2411,22 +2567,19 @@ "com.amazonaws.storagegateway#DescribeCacheOutput": { "type": "structure", "members": { - "CacheUsedPercentage": { - "target": "com.amazonaws.storagegateway#double", + "DiskIds": { + "target": "com.amazonaws.storagegateway#DiskIds", "traits": { - "smithy.api#documentation": "

    Percent use of the gateway's cache storage. This metric applies only to the\n gateway-cached volume setup. The sample is taken at the end of the reporting period.

    " + "smithy.api#documentation": "

    An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.

    " } }, - "CacheHitPercentage": { - "target": "com.amazonaws.storagegateway#double", - "traits": { - "smithy.api#documentation": "

    Percent of application read operations from the file shares that are served from cache.\n The sample is taken at the end of the reporting period.

    " - } + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" }, - "DiskIds": { - "target": "com.amazonaws.storagegateway#DiskIds", + "CacheAllocatedInBytes": { + "target": "com.amazonaws.storagegateway#long", "traits": { - "smithy.api#documentation": "

    An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.

    " + "smithy.api#documentation": "

    The amount of cache in bytes allocated to a gateway.

    " } }, "CacheMissPercentage": { @@ -2435,8 +2588,11 @@ "smithy.api#documentation": "

    Percent of application read operations from the file shares that are not served from\n cache. The sample is taken at the end of the reporting period.

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "CacheUsedPercentage": { + "target": "com.amazonaws.storagegateway#double", + "traits": { + "smithy.api#documentation": "

    Percent use of the gateway's cache storage. This metric applies only to the\n gateway-cached volume setup. The sample is taken at the end of the reporting period.

    " + } }, "CacheDirtyPercentage": { "target": "com.amazonaws.storagegateway#double", @@ -2444,10 +2600,10 @@ "smithy.api#documentation": "

    The file share's contribution to the overall percentage of the gateway's cache\n that has not been persisted to AWS. The sample is taken at the end of the reporting\n period.

    " } }, - "CacheAllocatedInBytes": { - "target": "com.amazonaws.storagegateway#long", + "CacheHitPercentage": { + "target": "com.amazonaws.storagegateway#double", "traits": { - "smithy.api#documentation": "

    The amount of cache in bytes allocated to a gateway.

    " + "smithy.api#documentation": "

    Percent of application read operations from the file shares that are served from cache.\n The sample is taken at the end of the reporting period.

    " } } } @@ -2584,16 +2740,19 @@ "com.amazonaws.storagegateway#DescribeGatewayInformationOutput": { "type": "structure", "members": { - "GatewayName": { - "target": "com.amazonaws.storagegateway#string", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "GatewayState": { + "target": "com.amazonaws.storagegateway#GatewayState", "traits": { - "smithy.api#documentation": "

    The name you configured for your gateway.

    " + "smithy.api#documentation": "

    A value that indicates the operating state of the gateway.

    " } }, - "GatewayNetworkInterfaces": { - "target": "com.amazonaws.storagegateway#GatewayNetworkInterfaces", + "GatewayTimezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", "traits": { - "smithy.api#documentation": "

    A NetworkInterface array that contains descriptions of the gateway\n network interfaces.

    " + "smithy.api#documentation": "

    A value that indicates the time zone configured for the gateway.

    " } }, "NextUpdateAvailabilityDate": { @@ -2602,79 +2761,88 @@ "smithy.api#documentation": "

    The date on which an update to the gateway is available. This date is in the time zone\n of the gateway. If the gateway is not available for an update this field is not returned in\n the response.

    " } }, - "Ec2InstanceRegion": { - "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", - "traits": { - "smithy.api#documentation": "

    The AWS Region where the Amazon EC2 instance is located.

    " - } - }, "LastSoftwareUpdate": { "target": "com.amazonaws.storagegateway#LastSoftwareUpdate", "traits": { "smithy.api#documentation": "

    The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response.

    " } }, - "CloudWatchLogGroupARN": { - "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", + "DeprecationDate": { + "target": "com.amazonaws.storagegateway#DeprecationDate", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Log Group that is used to\n monitor events in the gateway.

    " + "smithy.api#documentation": "

    Date after which this gateway will not receive software updates for new features \n and bug fixes.

    " } }, - "GatewayId": { - "target": "com.amazonaws.storagegateway#GatewayId", + "EndpointType": { + "target": "com.amazonaws.storagegateway#EndpointType", "traits": { - "smithy.api#documentation": "

    The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.

    " + "smithy.api#documentation": "

    The type of endpoint for your gateway.

    \n\n

    Valid Values: STANDARD | FIPS\n

    " } }, - "GatewayType": { - "target": "com.amazonaws.storagegateway#GatewayType", + "GatewayName": { + "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "

    The type of the gateway.

    " + "smithy.api#documentation": "

    The name you configured for your gateway.

    " } }, - "HostEnvironment": { - "target": "com.amazonaws.storagegateway#HostEnvironment", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    The type of hypervisor environment used by the host.

    " + "smithy.api#documentation": "

    A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each\n tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all\n tags using the ListTagsForResource API operation.

    " } }, - "VPCEndpoint": { - "target": "com.amazonaws.storagegateway#string", + "Ec2InstanceId": { + "target": "com.amazonaws.storagegateway#Ec2InstanceId", "traits": { - "smithy.api#documentation": "

    The configuration settings for the virtual private cloud (VPC) endpoint for your\n gateway.

    " + "smithy.api#documentation": "

    The ID of the Amazon EC2 instance that was used to launch the gateway.

    " } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "SoftwareUpdatesEndDate": { + "target": "com.amazonaws.storagegateway#SoftwareUpdatesEndDate", "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each\n tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all\n tags using the ListTagsForResource API operation.

    " + "smithy.api#documentation": "

    Date after which this gateway will not receive software updates for new features.

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "GatewayNetworkInterfaces": { + "target": "com.amazonaws.storagegateway#GatewayNetworkInterfaces", + "traits": { + "smithy.api#documentation": "

    A NetworkInterface array that contains descriptions of the gateway\n network interfaces.

    " + } }, - "GatewayTimezone": { - "target": "com.amazonaws.storagegateway#GatewayTimezone", + "CloudWatchLogGroupARN": { + "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", "traits": { - "smithy.api#documentation": "

    A value that indicates the time zone configured for the gateway.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway.

    " } }, - "GatewayState": { - "target": "com.amazonaws.storagegateway#GatewayState", + "GatewayType": { + "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "

    A value that indicates the operating state of the gateway.

    " + "smithy.api#documentation": "

    The type of the gateway.

    " } }, - "EndpointType": { - "target": "com.amazonaws.storagegateway#EndpointType", + "Ec2InstanceRegion": { + "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", "traits": { - "smithy.api#documentation": "

    The type of endpoint for your gateway.

    \n\n

    Valid Values: STANDARD | FIPS\n

    " + "smithy.api#documentation": "

    The AWS Region where the Amazon EC2 instance is located.

    " + } + }, + "VPCEndpoint": { + "target": "com.amazonaws.storagegateway#string", + "traits": { + "smithy.api#documentation": "

    The configuration settings for the virtual private cloud (VPC) endpoint for your\n gateway.

    " + } + }, + "GatewayId": { + "target": "com.amazonaws.storagegateway#GatewayId", + "traits": { + "smithy.api#documentation": "

    The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.

    " } }, - "Ec2InstanceId": { - "target": "com.amazonaws.storagegateway#Ec2InstanceId", + "HostEnvironment": { + "target": "com.amazonaws.storagegateway#HostEnvironment", "traits": { - "smithy.api#documentation": "

    The ID of the Amazon EC2 instance that was used to launch the gateway.

    " + "smithy.api#documentation": "

    The type of hypervisor environment used by the host.

    " } } }, @@ -2719,38 +2887,38 @@ "com.amazonaws.storagegateway#DescribeMaintenanceStartTimeOutput": { "type": "structure", "members": { - "DayOfWeek": { - "target": "com.amazonaws.storagegateway#DayOfWeek", + "DayOfMonth": { + "target": "com.amazonaws.storagegateway#DayOfMonth", "traits": { - "smithy.api#documentation": "

    An ordinal number between 0 and 6 that represents the day of the week, where 0\n represents Sunday and 6 represents Saturday. The day of week is in the time zone of the\n gateway.

    " + "smithy.api#documentation": "

    The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.

    " } }, - "Timezone": { - "target": "com.amazonaws.storagegateway#GatewayTimezone", + "DayOfWeek": { + "target": "com.amazonaws.storagegateway#DayOfWeek", "traits": { - "smithy.api#documentation": "

    A value that indicates the time zone that is set for the gateway. The start time and day\n of week specified should be in the time zone of the gateway.

    " + "smithy.api#documentation": "

    An ordinal number between 0 and 6 that represents the day of the week, where 0\n represents Sunday and 6 represents Saturday. The day of week is in the time zone of the\n gateway.

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" - }, "HourOfDay": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { "smithy.api#documentation": "

    The hour component of the maintenance start time represented as hh,\n where hh is the hour (0 to 23). The hour of the day is in the time\n zone of the gateway.

    " } }, - "DayOfMonth": { - "target": "com.amazonaws.storagegateway#DayOfMonth", - "traits": { - "smithy.api#documentation": "

    The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.

    " - } - }, "MinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { "smithy.api#documentation": "

    The minute component of the maintenance start time represented as\n mm, where mm is the minute (0 to 59). The\n minute of the hour is in the time zone of the gateway.

    " } + }, + "Timezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", + "traits": { + "smithy.api#documentation": "

    A value that indicates the time zone that is set for the gateway. The start time and day\n of week specified should be in the time zone of the gateway.

    " + } + }, + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -2889,10 +3057,10 @@ "com.amazonaws.storagegateway#DescribeSMBSettingsOutput": { "type": "structure", "members": { - "ActiveDirectoryStatus": { - "target": "com.amazonaws.storagegateway#ActiveDirectoryStatus", + "DomainName": { + "target": "com.amazonaws.storagegateway#DomainName", "traits": { - "smithy.api#documentation": "

    Indicates the status of a gateway that is a member of the Active Directory\n domain.

    \n\n
      \n
    • \n

      \n ACCESS_DENIED: Indicates that the JoinDomain operation\n failed due to an authentication error.

      \n
      • \n
    • \n

      \n DETACHED: Indicates that gateway is not joined to a domain.

      \n
      • \n
    • \n

      \n JOINED: Indicates that the gateway has successfully joined a\n domain.

      \n
      • \n
    • \n

      \n JOINING: Indicates that a JoinDomain operation is in\n progress.

      \n
      • \n
    • \n

      \n NETWORK_ERROR: Indicates that JoinDomain operation\n failed due to a network or connectivity error.

      \n
      • \n
    • \n

      \n TIMEOUT: Indicates that the JoinDomain operation failed\n because the operation didn't complete within the allotted time.

      \n
      • \n
    • \n

      \n UNKNOWN_ERROR: Indicates that the JoinDomain operation\n failed due to another type of error.

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the domain that the gateway is joined to.

    " } }, "SMBGuestPasswordSet": { @@ -2901,20 +3069,20 @@ "smithy.api#documentation": "

    This value is true if a password for the guest user smbguest\n is set, otherwise false.

    \n\n

    Valid Values: true | false\n

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" - }, "SMBSecurityStrategy": { "target": "com.amazonaws.storagegateway#SMBSecurityStrategy", "traits": { "smithy.api#documentation": "

    The type of security strategy that was specified for file gateway.

    \n\n
      \n
    • \n

      \n ClientSpecified: If you use this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment.

      \n
      • \n
    • \n

      \n MandatorySigning: If you use this option, file gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works\n with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

      \n
      • \n
    • \n

      \n MandatoryEncryption: If you use this option, file gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is highly\n recommended for environments that handle sensitive data. This option works with SMB\n clients on Microsoft Windows 8, Windows Server 2012 or newer.

      \n
      • \n
    " } }, - "DomainName": { - "target": "com.amazonaws.storagegateway#DomainName", + "ActiveDirectoryStatus": { + "target": "com.amazonaws.storagegateway#ActiveDirectoryStatus", "traits": { - "smithy.api#documentation": "

    The name of the domain that the gateway is joined to.

    " + "smithy.api#documentation": "

    Indicates the status of a gateway that is a member of the Active Directory\n domain.

    \n\n
      \n
    • \n

      \n ACCESS_DENIED: Indicates that the JoinDomain operation\n failed due to an authentication error.

      \n
      • \n
    • \n

      \n DETACHED: Indicates that gateway is not joined to a domain.

      \n
      • \n
    • \n

      \n JOINED: Indicates that the gateway has successfully joined a\n domain.

      \n
      • \n
    • \n

      \n JOINING: Indicates that a JoinDomain operation is in\n progress.

      \n
      • \n
    • \n

      \n NETWORK_ERROR: Indicates that JoinDomain operation\n failed due to a network or connectivity error.

      \n
      • \n
    • \n

      \n TIMEOUT: Indicates that the JoinDomain operation failed\n because the operation didn't complete within the allotted time.

      \n
      • \n
    • \n

      \n UNKNOWN_ERROR: Indicates that the JoinDomain operation\n failed due to another type of error.

      \n
      • \n
    " } + }, + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" } } }, @@ -2956,18 +3124,6 @@ "com.amazonaws.storagegateway#DescribeSnapshotScheduleOutput": { "type": "structure", "members": { - "Timezone": { - "target": "com.amazonaws.storagegateway#GatewayTimezone", - "traits": { - "smithy.api#documentation": "

    A value that indicates the time zone of the gateway.

    " - } - }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.

    " - } - }, "Description": { "target": "com.amazonaws.storagegateway#Description", "traits": { @@ -2980,16 +3136,28 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume that was specified in the request.

    " } }, + "RecurrenceInHours": { + "target": "com.amazonaws.storagegateway#RecurrenceInHours", + "traits": { + "smithy.api#documentation": "

    The number of hours between snapshots.

    " + } + }, "StartAt": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { "smithy.api#documentation": "

    The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.

    " } }, - "RecurrenceInHours": { - "target": "com.amazonaws.storagegateway#RecurrenceInHours", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    The number of hours between snapshots.

    " + "smithy.api#documentation": "

    A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.

    " + } + }, + "Timezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", + "traits": { + "smithy.api#documentation": "

    A value that indicates the time zone of the gateway.

    " } } } @@ -3069,6 +3237,12 @@ "com.amazonaws.storagegateway#DescribeTapeArchivesInput": { "type": "structure", "members": { + "TapeARNs": { + "target": "com.amazonaws.storagegateway#TapeARNs", + "traits": { + "smithy.api#documentation": "

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual\n tapes you want to describe.

    " + } + }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { @@ -3080,12 +3254,6 @@ "traits": { "smithy.api#documentation": "

    An opaque string that indicates the position at which to begin describing virtual\n tapes.

    " } - }, - "TapeARNs": { - "target": "com.amazonaws.storagegateway#TapeARNs", - "traits": { - "smithy.api#documentation": "

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual\n tapes you want to describe.

    " - } } }, "traits": { @@ -3095,17 +3263,17 @@ "com.amazonaws.storagegateway#DescribeTapeArchivesOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    An opaque string that indicates the position at which the virtual tapes that were\n fetched for description ended. Use this marker in your next request to fetch the next set\n of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to\n describe, this field does not appear in the response.

    " - } - }, "TapeArchives": { "target": "com.amazonaws.storagegateway#TapeArchives", "traits": { "smithy.api#documentation": "

    An array of virtual tape objects in the virtual tape shelf (VTS). The description\n includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned\n includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the\n tapes, progress of the description, and tape barcode.

    " } + }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    An opaque string that indicates the position at which the virtual tapes that were\n fetched for description ended. Use this marker in your next request to fetch the next set\n of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to\n describe, this field does not appear in the response.

    " + } } }, "traits": { @@ -3141,10 +3309,10 @@ "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsInput": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.storagegateway#PositiveIntObject", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    Specifies that the number of virtual tape recovery points that are described be limited\n to the specified number.

    " + "smithy.api#required": {} } }, "Marker": { @@ -3153,10 +3321,10 @@ "smithy.api#documentation": "

    An opaque string that indicates the position at which to begin describing the virtual\n tape recovery points.

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies that the number of virtual tape recovery points that are described be limited\n to the specified number.

    " } } }, @@ -3167,12 +3335,6 @@ "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    An opaque string that indicates the position at which the virtual tape recovery points\n that were listed for description ended.

    \n\n

    Use this marker in your next request to list the next set of virtual tape recovery\n points in the list. If there are no more recovery points to describe, this field does not\n appear in the response.

    " - } - }, "TapeRecoveryPointInfos": { "target": "com.amazonaws.storagegateway#TapeRecoveryPointInfos", "traits": { @@ -3181,6 +3343,12 @@ }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    An opaque string that indicates the position at which the virtual tape recovery points\n that were listed for description ended.

    \n\n

    Use this marker in your next request to list the next set of virtual tape recovery\n points in the list. If there are no more recovery points to describe, this field does not\n appear in the response.

    " + } } }, "traits": { @@ -3216,18 +3384,6 @@ "com.amazonaws.storagegateway#DescribeTapesInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    A marker value, obtained in a previous call to DescribeTapes. This marker\n indicates which page of results to retrieve.

    \n\n

    If not specified, the first page of results is retrieved.

    " - } - }, - "Limit": { - "target": "com.amazonaws.storagegateway#PositiveIntObject", - "traits": { - "smithy.api#documentation": "

    Specifies that the number of virtual tapes described be limited to the specified\n number.

    \n\n \n

    Amazon Web Services may impose its own limit, if this field is not set.

    \n     " - } - }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { @@ -3239,6 +3395,18 @@ "traits": { "smithy.api#documentation": "

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual\n tapes you want to describe. If this parameter is not specified, Tape gateway returns a\n description of all virtual tapes associated with the specified gateway.

    " } + }, + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", + "traits": { + "smithy.api#documentation": "

    Specifies that the number of virtual tapes described be limited to the specified\n number.

    \n\n \n

    Amazon Web Services may impose its own limit, if this field is not set.

    \n     " + } + }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    A marker value, obtained in a previous call to DescribeTapes. This marker\n indicates which page of results to retrieve.

    \n\n

    If not specified, the first page of results is retrieved.

    " + } } }, "traits": { @@ -3248,17 +3416,17 @@ "com.amazonaws.storagegateway#DescribeTapesOutput": { "type": "structure", "members": { - "Tapes": { - "target": "com.amazonaws.storagegateway#Tapes", - "traits": { - "smithy.api#documentation": "

    An array of virtual tape descriptions.

    " - } - }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "

    An opaque string which can be used as part of a subsequent DescribeTapes call to\n retrieve the next page of results.

    \n\n

    If a response does not contain a marker, then there are no more results to be\n retrieved.

    " } + }, + "Tapes": { + "target": "com.amazonaws.storagegateway#Tapes", + "traits": { + "smithy.api#documentation": "

    An array of virtual tape descriptions.

    " + } } }, "traits": { @@ -3299,18 +3467,18 @@ "com.amazonaws.storagegateway#DescribeUploadBufferOutput": { "type": "structure", "members": { - "DiskIds": { - "target": "com.amazonaws.storagegateway#DiskIds", - "traits": { - "smithy.api#documentation": "

    An array of the gateway's local disk IDs that are configured as working storage.\n Each local disk ID is specified as a string (minimum length of 1 and maximum length of\n 300). If no local disks are configured as working storage, then the DiskIds array is\n empty.

    " - } - }, "UploadBufferUsedInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#documentation": "

    The total number of bytes being used in the gateway's upload buffer.

    " } }, + "DiskIds": { + "target": "com.amazonaws.storagegateway#DiskIds", + "traits": { + "smithy.api#documentation": "

    An array of the gateway's local disk IDs that are configured as working storage.\n Each local disk ID is specified as a string (minimum length of 1 and maximum length of\n 300). If no local disks are configured as working storage, then the DiskIds array is\n empty.

    " + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, @@ -3351,16 +3519,10 @@ "com.amazonaws.storagegateway#DescribeVTLDevicesInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    An opaque string that indicates the position at which to begin describing the VTL\n devices.

    " - } - }, - "Limit": { - "target": "com.amazonaws.storagegateway#PositiveIntObject", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    Specifies that the number of VTL devices described be limited to the specified\n number.

    " + "smithy.api#required": {} } }, "VTLDeviceARNs": { @@ -3369,10 +3531,16 @@ "smithy.api#documentation": "

    An array of strings, where each string represents the Amazon Resource Name (ARN) of a\n VTL device.

    \n\n \n

    All of the specified VTL devices must be from the same gateway. If no VTL devices are\n specified, the result will contain all devices on the specified gateway.

    \n     " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

    An opaque string that indicates the position at which to begin describing the VTL\n devices.

    " + } + }, + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", + "traits": { + "smithy.api#documentation": "

    Specifies that the number of VTL devices described be limited to the specified\n number.

    " } } }, @@ -3383,12 +3551,6 @@ "com.amazonaws.storagegateway#DescribeVTLDevicesOutput": { "type": "structure", "members": { - "VTLDevices": { - "target": "com.amazonaws.storagegateway#VTLDevices", - "traits": { - "smithy.api#documentation": "

    An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL\n devices.

    " - } - }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { @@ -3397,6 +3559,12 @@ }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "VTLDevices": { + "target": "com.amazonaws.storagegateway#VTLDevices", + "traits": { + "smithy.api#documentation": "

    An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL\n devices.

    " + } } }, "traits": { @@ -3440,11 +3608,8 @@ "com.amazonaws.storagegateway#DescribeWorkingStorageOutput": { "type": "structure", "members": { - "WorkingStorageAllocatedInBytes": { - "target": "com.amazonaws.storagegateway#long", - "traits": { - "smithy.api#documentation": "

    The total working storage in bytes allocated for the gateway. If no working storage is\n configured for the gateway, this field returns 0.

    " - } + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" }, "DiskIds": { "target": "com.amazonaws.storagegateway#DiskIds", @@ -3452,14 +3617,17 @@ "smithy.api#documentation": "

    An array of the gateway's local disk IDs that are configured as working storage.\n Each local disk ID is specified as a string (minimum length of 1 and maximum length of\n 300). If no local disks are configured as working storage, then the DiskIds array is\n empty.

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" - }, "WorkingStorageUsedInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#documentation": "

    The total working storage in bytes in use by the gateway. If no working storage is\n configured for the gateway, this field returns 0.

    " } + }, + "WorkingStorageAllocatedInBytes": { + "target": "com.amazonaws.storagegateway#long", + "traits": { + "smithy.api#documentation": "

    The total working storage in bytes allocated for the gateway. If no working storage is\n configured for the gateway, this field returns 0.

    " + } } }, "traits": { @@ -3498,18 +3666,18 @@ "com.amazonaws.storagegateway#DetachVolumeInput": { "type": "structure", "members": { + "ForceDetach": { + "target": "com.amazonaws.storagegateway#Boolean", + "traits": { + "smithy.api#documentation": "

    Set to true to forcibly remove the iSCSI connection of the target volume\n and detach the volume. The default is false. If this value is set to\n false, you must manually disconnect the iSCSI connection from the target\n volume.

    \n\n

    Valid Values: true | false\n

    " + } + }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume to detach from the gateway.

    ", "smithy.api#required": {} } - }, - "ForceDetach": { - "target": "com.amazonaws.storagegateway#Boolean", - "traits": { - "smithy.api#documentation": "

    Set to true to forcibly remove the iSCSI connection of the target volume\n and detach the volume. The default is false. If this value is set to\n false, you must manually disconnect the iSCSI connection from the target\n volume.

    \n\n

    Valid Values: true | false\n

    " - } } }, "traits": { @@ -3542,6 +3710,12 @@ "com.amazonaws.storagegateway#DeviceiSCSIAttributes": { "type": "structure", "members": { + "NetworkInterfacePort": { + "target": "com.amazonaws.storagegateway#integer", + "traits": { + "smithy.api#documentation": "

    The port used to communicate with iSCSI VTL device targets.

    " + } + }, "ChapEnabled": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { @@ -3557,13 +3731,7 @@ "NetworkInterfaceId": { "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "

    The network interface identifier of the VTL device.

    " - } - }, - "NetworkInterfacePort": { - "target": "com.amazonaws.storagegateway#integer", - "traits": { - "smithy.api#documentation": "

    The port used to communicate with iSCSI VTL device targets.

    " + "smithy.api#documentation": "

    The network interface identifier of the VTL device.

    " } } }, @@ -3622,21 +3790,12 @@ "com.amazonaws.storagegateway#Disk": { "type": "structure", "members": { - "DiskNode": { - "target": "com.amazonaws.storagegateway#string", - "traits": { - "smithy.api#documentation": "

    The device node of a local disk as assigned by the virtualization environment.

    " - } - }, - "DiskPath": { + "DiskAllocationResource": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "

    The path of a local disk in the gateway virtual machine (VM).

    " + "smithy.api#documentation": "

    The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in\n the response if the local disk is not defined as an iSCSI target. The format of this field\n is targetIqn::LUNNumber::region-volumeId.

    " } }, - "DiskAttributeList": { - "target": "com.amazonaws.storagegateway#DiskAttributeList" - }, "DiskAllocationType": { "target": "com.amazonaws.storagegateway#DiskAllocationType" }, @@ -3646,22 +3805,31 @@ "smithy.api#documentation": "

    The unique device ID or other distinguishing data that identifies a local disk.

    " } }, + "DiskSizeInBytes": { + "target": "com.amazonaws.storagegateway#long", + "traits": { + "smithy.api#documentation": "

    The local disk size in bytes.

    " + } + }, "DiskStatus": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "

    A value that represents the status of a local disk.

    " } }, - "DiskAllocationResource": { + "DiskPath": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "

    The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in\n the response if the local disk is not defined as an iSCSI target. The format of this field\n is targetIqn::LUNNumber::region-volumeId.

    " + "smithy.api#documentation": "

    The path of a local disk in the gateway virtual machine (VM).

    " } }, - "DiskSizeInBytes": { - "target": "com.amazonaws.storagegateway#long", + "DiskAttributeList": { + "target": "com.amazonaws.storagegateway#DiskAttributeList" + }, + "DiskNode": { + "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "

    The local disk size in bytes.

    " + "smithy.api#documentation": "

    The device node of a local disk as assigned by the virtualization environment.

    " } } }, @@ -4015,20 +4183,20 @@ "com.amazonaws.storagegateway#FileShareInfo": { "type": "structure", "members": { - "FileShareType": { - "target": "com.amazonaws.storagegateway#FileShareType" - }, "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" }, "FileShareStatus": { "target": "com.amazonaws.storagegateway#FileShareStatus" }, + "FileShareId": { + "target": "com.amazonaws.storagegateway#FileShareId" + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, - "FileShareId": { - "target": "com.amazonaws.storagegateway#FileShareId" + "FileShareType": { + "target": "com.amazonaws.storagegateway#FileShareType" } }, "traits": { @@ -4138,10 +4306,22 @@ "com.amazonaws.storagegateway#GatewayInfo": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "GatewayType": { + "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and AWS Region.

    " + "smithy.api#documentation": "

    The type of the gateway.

    " + } + }, + "GatewayOperationalState": { + "target": "com.amazonaws.storagegateway#GatewayOperationalState", + "traits": { + "smithy.api#documentation": "

    The state of the gateway.

    \n\n

    Valid Values: DISABLED | ACTIVE\n

    " + } + }, + "Ec2InstanceRegion": { + "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", + "traits": { + "smithy.api#documentation": "

    The AWS Region where the Amazon EC2 instance is located.

    " } }, "Ec2InstanceId": { @@ -4162,22 +4342,10 @@ "smithy.api#documentation": "

    The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.

    " } }, - "Ec2InstanceRegion": { - "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", - "traits": { - "smithy.api#documentation": "

    The AWS Region where the Amazon EC2 instance is located.

    " - } - }, - "GatewayOperationalState": { - "target": "com.amazonaws.storagegateway#GatewayOperationalState", - "traits": { - "smithy.api#documentation": "

    The state of the gateway.

    \n\n

    Valid Values: DISABLED | ACTIVE\n

    " - } - }, - "GatewayType": { - "target": "com.amazonaws.storagegateway#GatewayType", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    The type of the gateway.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and AWS Region.

    " } } }, @@ -4338,17 +4506,17 @@ "com.amazonaws.storagegateway#InvalidGatewayRequestException": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.storagegateway#StorageGatewayError", - "traits": { - "smithy.api#documentation": "

    A StorageGatewayError that provides more detail about the cause of the\n error.

    " - } - }, "message": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "

    A human-readable message describing the error that occurred.

    " } + }, + "error": { + "target": "com.amazonaws.storagegateway#StorageGatewayError", + "traits": { + "smithy.api#documentation": "

    A StorageGatewayError that provides more detail about the cause of the\n error.

    " + } } }, "traits": { @@ -4390,13 +4558,6 @@ "com.amazonaws.storagegateway#JoinDomainInput": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.storagegateway#DomainUserName", - "traits": { - "smithy.api#documentation": "

    Sets the user name of user who has permission to add the gateway to the Active Directory\n domain. The domain user account should be enabled to join computers to the domain. For\n example, you can use the domain administrator account or an account with delegated\n permissions to join computers to the domain.

    ", - "smithy.api#required": {} - } - }, "DomainName": { "target": "com.amazonaws.storagegateway#DomainName", "traits": { @@ -4410,10 +4571,10 @@ "smithy.api#documentation": "

    List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need\n to specify the port number include it after the colon (“:”). For example,\n mydc.mydomain.com:389.

    " } }, - "Password": { - "target": "com.amazonaws.storagegateway#DomainUserPassword", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    Sets the password of the user who has permission to add the gateway to the Active\n Directory domain.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and AWS Region.

    ", "smithy.api#required": {} } }, @@ -4429,10 +4590,17 @@ "smithy.api#documentation": "

    Specifies the time in seconds, in which the JoinDomain operation must\n complete. The default is 20 seconds.

    " } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "UserName": { + "target": "com.amazonaws.storagegateway#DomainUserName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and AWS Region.

    ", + "smithy.api#documentation": "

    Sets the user name of user who has permission to add the gateway to the Active Directory\n domain. The domain user account should be enabled to join computers to the domain. For\n example, you can use the domain administrator account or an account with delegated\n permissions to join computers to the domain.

    ", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.storagegateway#DomainUserPassword", + "traits": { + "smithy.api#documentation": "

    Sets the password of the user who has permission to add the gateway to the Active\n Directory domain.

    ", "smithy.api#required": {} } } @@ -4444,17 +4612,17 @@ "com.amazonaws.storagegateway#JoinDomainOutput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", - "traits": { - "smithy.api#documentation": "

    The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

    " - } - }, "ActiveDirectoryStatus": { "target": "com.amazonaws.storagegateway#ActiveDirectoryStatus", "traits": { "smithy.api#documentation": "

    Indicates the status of the gateway as a member of the Active Directory domain.

    \n\n
      \n
    • \n

      \n ACCESS_DENIED: Indicates that the JoinDomain operation\n failed due to an authentication error.

      \n
      • \n
    • \n

      \n DETACHED: Indicates that gateway is not joined to a domain.

      \n
      • \n
    • \n

      \n JOINED: Indicates that the gateway has successfully joined a\n domain.

      \n
      • \n
    • \n

      \n JOINING: Indicates that a JoinDomain operation is in\n progress.

      \n
      • \n
    • \n

      \n NETWORK_ERROR: Indicates that JoinDomain operation\n failed due to a network or connectivity error.

      \n
      • \n
    • \n

      \n TIMEOUT: Indicates that the JoinDomain operation failed\n because the operation didn't complete within the allotted time.

      \n
      • \n
    • \n

      \n UNKNOWN_ERROR: Indicates that the JoinDomain operation\n failed due to another type of error.

      \n
      • \n
    " } + }, + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#documentation": "

    The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

    " + } } }, "traits": { @@ -4549,6 +4717,12 @@ "com.amazonaws.storagegateway#ListFileSharesInput": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    Opaque pagination token returned from a previous ListFileShares operation. If present,\n Marker specifies where to continue the list from after a previous call to\n ListFileShares. Optional.

    " + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { @@ -4560,12 +4734,6 @@ "traits": { "smithy.api#documentation": "

    The maximum number of file shares to return in the response. The value must be an\n integer with a value greater than zero. Optional.

    " } - }, - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    Opaque pagination token returned from a previous ListFileShares operation. If present,\n Marker specifies where to continue the list from after a previous call to\n ListFileShares. Optional.

    " - } } }, "traits": { @@ -4575,18 +4743,18 @@ "com.amazonaws.storagegateway#ListFileSharesOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    If the request includes Marker, the response returns that value in this\n field.

    " - } - }, "FileShareInfoList": { "target": "com.amazonaws.storagegateway#FileShareInfoList", "traits": { "smithy.api#documentation": "

    An array of information about the file gateway's file shares.

    " } }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    If the request includes Marker, the response returns that value in this\n field.

    " + } + }, "NextMarker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { @@ -4738,12 +4906,6 @@ "com.amazonaws.storagegateway#ListTagsForResourceInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    An opaque string that indicates the position at which to begin returning the list of\n tags.

    " - } - }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { @@ -4756,6 +4918,12 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

    ", "smithy.api#required": {} } + }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    An opaque string that indicates the position at which to begin returning the list of\n tags.

    " + } } }, "traits": { @@ -4765,10 +4933,16 @@ "com.amazonaws.storagegateway#ListTagsForResourceOutput": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    An opaque string that indicates the position at which to stop returning the list of\n tags.

    " + } + }, "ResourceARN": { "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { - "smithy.api#documentation": "

    he Amazon Resource Name (ARN) of the resource for which you want to list tags.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

    " } }, "Tags": { @@ -4776,16 +4950,70 @@ "traits": { "smithy.api#documentation": "

    An array that contains the tags for the specified resource.

    " } + } + }, + "traits": { + "smithy.api#documentation": "

    ListTagsForResourceOutput

    " + } + }, + "com.amazonaws.storagegateway#ListTapePools": { + "type": "operation", + "input": { + "target": "com.amazonaws.storagegateway#ListTapePoolsInput" + }, + "output": { + "target": "com.amazonaws.storagegateway#ListTapePoolsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.storagegateway#InternalServerError" + }, + { + "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists custom tape pools. You specify custom tape pools to list by specifying\n one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a\n custom tape pool ARN, the operation lists all custom tape pools.

    \n \n

    This operation supports pagination. You can optionally specify the \n Limit parameter in the body to limit the number of tape pools in the \n response. If the number of tape pools returned in the response is truncated, the \n response includes a Marker element that you can use in your subsequent \n request to retrieve the next set of tape pools.

    " + } + }, + "com.amazonaws.storagegateway#ListTapePoolsInput": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", + "traits": { + "smithy.api#documentation": "

    An optional number limit for the tape pools in the list returned by this call.

    " + } }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { - "smithy.api#documentation": "

    An opaque string that indicates the position at which to stop returning the list of\n tags.

    " + "smithy.api#documentation": "

    A string that indicates the position at which to begin the returned list of tape pools.

    " + } + }, + "PoolARNs": { + "target": "com.amazonaws.storagegateway#PoolARNs", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of each of the custom tape pools you want to list.\n If you don't specify a custom tape pool ARN, the response lists all custom tape pools.\n

    " + } + } + } + }, + "com.amazonaws.storagegateway#ListTapePoolsOutput": { + "type": "structure", + "members": { + "PoolInfos": { + "target": "com.amazonaws.storagegateway#PoolInfos", + "traits": { + "smithy.api#documentation": "

    An array of PoolInfo objects, where each object describes a single custom\n tape pool. If there are no custom tape pools, the PoolInfos is an empty array.

    " + } + }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    A string that indicates the position at which to begin the returned list of tape pools.\n Use the marker in your next request to continue pagination of tape pools. If there are no \n more tape pools to list, this element does not appear in the response body.

    " } } - }, - "traits": { - "smithy.api#documentation": "

    ListTagsForResourceOutput

    " } }, "com.amazonaws.storagegateway#ListTapes": { @@ -4817,6 +5045,12 @@ "com.amazonaws.storagegateway#ListTapesInput": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    A string that indicates the position at which to begin the returned list of\n tapes.

    " + } + }, "TapeARNs": { "target": "com.amazonaws.storagegateway#TapeARNs" }, @@ -4825,12 +5059,6 @@ "traits": { "smithy.api#documentation": "

    An optional number limit for the tapes in the list returned by this call.

    " } - }, - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "

    A string that indicates the position at which to begin the returned list of\n tapes.

    " - } } }, "traits": { @@ -4840,14 +5068,14 @@ "com.amazonaws.storagegateway#ListTapesOutput": { "type": "structure", "members": { - "TapeInfos": { - "target": "com.amazonaws.storagegateway#TapeInfos" - }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "

    A string that indicates the position at which to begin returning the next list of tapes.\n Use the marker in your next request to continue pagination of tapes. If there are no more\n tapes to list, this element does not appear in the response body.

    " } + }, + "TapeInfos": { + "target": "com.amazonaws.storagegateway#TapeInfos" } }, "traits": { @@ -4937,14 +5165,14 @@ "com.amazonaws.storagegateway#ListVolumeRecoveryPointsOutput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" - }, "VolumeRecoveryPointInfos": { "target": "com.amazonaws.storagegateway#VolumeRecoveryPointInfos", "traits": { "smithy.api#documentation": "

    An array of VolumeRecoveryPointInfo objects.

    " } + }, + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" } } }, @@ -5000,19 +5228,19 @@ "com.amazonaws.storagegateway#ListVolumesOutput": { "type": "structure", "members": { + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "

    Use the marker in your next request to continue pagination of iSCSI volumes. If there\n are no more volumes to list, this field does not appear in the response body.

    " + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, "VolumeInfos": { - "target": "com.amazonaws.storagegateway#VolumeInfos", - "traits": { - "smithy.api#documentation": "

    An array of VolumeInfo objects, where each object describes an iSCSI\n volume. If no volumes are defined for the gateway, then VolumeInfos is an\n empty array \"[]\".

    " - } - }, - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", + "target": "com.amazonaws.storagegateway#VolumeInfos", "traits": { - "smithy.api#documentation": "

    Use the marker in your next request to continue pagination of iSCSI volumes. If there\n are no more volumes to list, this field does not appear in the response body.

    " + "smithy.api#documentation": "

    An array of VolumeInfo objects, where each object describes an iSCSI\n volume. If no volumes are defined for the gateway, then VolumeInfos is an\n empty array \"[]\".

    " } } }, @@ -5082,18 +5310,6 @@ "com.amazonaws.storagegateway#NFSFileShareDefaults": { "type": "structure", "members": { - "OwnerId": { - "target": "com.amazonaws.storagegateway#PermissionId", - "traits": { - "smithy.api#documentation": "

    The default owner ID for files in the file share (unless the files have another owner ID\n specified). The default value is nfsnobody.

    " - } - }, - "GroupId": { - "target": "com.amazonaws.storagegateway#PermissionId", - "traits": { - "smithy.api#documentation": "

    The default group ID for the file share (unless the files have another group ID\n specified). The default value is nfsnobody.

    " - } - }, "DirectoryMode": { "target": "com.amazonaws.storagegateway#PermissionMode", "traits": { @@ -5105,6 +5321,18 @@ "traits": { "smithy.api#documentation": "

    The Unix file mode in the form \"nnnn\". For example, 0666 represents the\n default file mode inside the file share. The default value is 0666.

    " } + }, + "OwnerId": { + "target": "com.amazonaws.storagegateway#PermissionId", + "traits": { + "smithy.api#documentation": "

    The default owner ID for files in the file share (unless the files have another owner ID\n specified). The default value is nfsnobody.

    " + } + }, + "GroupId": { + "target": "com.amazonaws.storagegateway#PermissionId", + "traits": { + "smithy.api#documentation": "

    The default group ID for the file share (unless the files have another group ID\n specified). The default value is nfsnobody.

    " + } } }, "traits": { @@ -5114,23 +5342,35 @@ "com.amazonaws.storagegateway#NFSFileShareInfo": { "type": "structure", "members": { - "DefaultStorageClass": { - "target": "com.amazonaws.storagegateway#StorageClass", + "Path": { + "target": "com.amazonaws.storagegateway#Path" + }, + "GuessMIMETypeEnabled": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " + "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " } }, - "FileShareStatus": { - "target": "com.amazonaws.storagegateway#FileShareStatus" + "ReadOnly": { + "target": "com.amazonaws.storagegateway#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " + } }, - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean2", + "ObjectACL": { + "target": "com.amazonaws.storagegateway#ObjectACL" + }, + "FileShareName": { + "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", + "traits": { + "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " + } }, "ClientList": { "target": "com.amazonaws.storagegateway#FileShareClientList" @@ -5138,65 +5378,53 @@ "Role": { "target": "com.amazonaws.storagegateway#Role" }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey" }, - "Path": { - "target": "com.amazonaws.storagegateway#Path" + "Squash": { + "target": "com.amazonaws.storagegateway#Squash" }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "

    Refresh cache information.

    " + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.

    " - } + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" }, "NFSFileShareDefaults": { "target": "com.amazonaws.storagegateway#NFSFileShareDefaults" }, - "ReadOnly": { - "target": "com.amazonaws.storagegateway#Boolean", - "traits": { - "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " - } - }, "FileShareId": { "target": "com.amazonaws.storagegateway#FileShareId" }, - "FileShareARN": { - "target": "com.amazonaws.storagegateway#FileShareARN" - }, "RequesterPays": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " } }, + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN" + }, + "FileShareStatus": { + "target": "com.amazonaws.storagegateway#FileShareStatus" + }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN" }, - "Squash": { - "target": "com.amazonaws.storagegateway#Squash" - }, - "GuessMIMETypeEnabled": { - "target": "com.amazonaws.storagegateway#Boolean", + "CacheAttributes": { + "target": "com.amazonaws.storagegateway#CacheAttributes", "traits": { - "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    Refresh cache information.

    " } }, - "FileShareName": { - "target": "com.amazonaws.storagegateway#FileShareName", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " + "smithy.api#documentation": "

    A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.

    " } - }, - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL" } }, "traits": { @@ -5218,16 +5446,16 @@ "smithy.api#documentation": "

    The Internet Protocol version 6 (IPv6) address of the interface. Currently not\n supported.

    " } }, - "Ipv4Address": { + "MacAddress": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "

    The Internet Protocol version 4 (IPv4) address of the interface.

    " + "smithy.api#documentation": "

    The Media Access Control (MAC) address of the interface.

    \n\n \n

    This is currently unsupported and will not be returned in output.

    \n     " } }, - "MacAddress": { + "Ipv4Address": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "

    The Media Access Control (MAC) address of the interface.

    \n\n \n

    This is currently unsupported and will not be returned in output.

    \n     " + "smithy.api#documentation": "

    The Internet Protocol version 4 (IPv4) address of the interface.

    " } } }, @@ -5294,11 +5522,11 @@ "com.amazonaws.storagegateway#NotifyWhenUploadedOutput": { "type": "structure", "members": { - "FileShareARN": { - "target": "com.amazonaws.storagegateway#FileShareARN" - }, "NotificationId": { "target": "com.amazonaws.storagegateway#NotificationId" + }, + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN" } } }, @@ -5376,6 +5604,21 @@ "smithy.api#pattern": "^[0-7]{4}$" } }, + "com.amazonaws.storagegateway#PoolARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 50, + "max": 500 + } + } + }, + "com.amazonaws.storagegateway#PoolARNs": { + "type": "list", + "member": { + "target": "com.amazonaws.storagegateway#PoolARN" + } + }, "com.amazonaws.storagegateway#PoolId": { "type": "string", "traits": { @@ -5385,6 +5628,79 @@ } } }, + "com.amazonaws.storagegateway#PoolInfo": { + "type": "structure", + "members": { + "StorageClass": { + "target": "com.amazonaws.storagegateway#TapeStorageClass", + "traits": { + "smithy.api#documentation": "

    The storage class that is associated with the custom pool. When you use your backup \n application to eject the tape, the tape is archived directly into the storage class \n (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    " + } + }, + "RetentionLockType": { + "target": "com.amazonaws.storagegateway#RetentionLockType", + "traits": { + "smithy.api#documentation": "

    Tape retention lock type, which can be configured in two modes. When configured in \n governance mode, AWS accounts with specific IAM permissions are authorized to remove the \n tape retention lock from archived virtual tapes. When configured in compliance mode, the \n tape retention lock cannot be removed by any user, including the root AWS account.

    " + } + }, + "PoolARN": { + "target": "com.amazonaws.storagegateway#PoolARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools\n operation to return a list of custom tape pools for your account and AWS Region.

    " + } + }, + "PoolName": { + "target": "com.amazonaws.storagegateway#PoolName", + "traits": { + "smithy.api#documentation": "

    The name of the custom tape pool. PoolName can use all ASCII characters,\n except '/' and '\\'.

    " + } + }, + "RetentionLockTimeInDays": { + "target": "com.amazonaws.storagegateway#RetentionLockTimeInDays", + "traits": { + "smithy.api#documentation": "

    Tape retention lock time is set in days. Tape retention lock can be enabled for up \n to 100 years (36,500 days).

    " + } + }, + "PoolStatus": { + "target": "com.amazonaws.storagegateway#PoolStatus", + "traits": { + "smithy.api#documentation": "

    Status of the custom tape pool. Pool can be ACTIVE or DELETED.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a custom tape pool.

    " + } + }, + "com.amazonaws.storagegateway#PoolInfos": { + "type": "list", + "member": { + "target": "com.amazonaws.storagegateway#PoolInfo" + } + }, + "com.amazonaws.storagegateway#PoolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$" + } + }, + "com.amazonaws.storagegateway#PoolStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE" + }, + { + "value": "DELETED" + } + ] + } + }, "com.amazonaws.storagegateway#PositiveIntObject": { "type": "integer", "traits": { @@ -5427,13 +5743,6 @@ "com.amazonaws.storagegateway#RefreshCacheInput": { "type": "structure", "members": { - "FileShareARN": { - "target": "com.amazonaws.storagegateway#FileShareARN", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the file share you want to refresh.

    ", - "smithy.api#required": {} - } - }, "FolderList": { "target": "com.amazonaws.storagegateway#FolderList", "traits": { @@ -5445,6 +5754,13 @@ "traits": { "smithy.api#documentation": "

    A value that specifies whether to recursively refresh folders in the cache. The refresh\n includes folders that were in the cache the last time the gateway listed the folder's\n contents. If this value set to true, each folder that is listed in\n FolderList is recursively updated. Otherwise, subfolders listed in\n FolderList are not refreshed. Only objects that are in folders listed\n directly under FolderList are found and used for the update. The default is\n true.

    \n\n

    Valid Values: true | false\n

    " } + }, + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the file share you want to refresh.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -5497,17 +5813,17 @@ "com.amazonaws.storagegateway#RemoveTagsFromResourceInput": { "type": "structure", "members": { - "ResourceARN": { - "target": "com.amazonaws.storagegateway#ResourceARN", + "TagKeys": { + "target": "com.amazonaws.storagegateway#TagKeys", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource you want to remove the tags from.

    ", + "smithy.api#documentation": "

    The keys of the tags you want to remove from the specified resource. A tag is composed\n of a key-value pair.

    ", "smithy.api#required": {} } }, - "TagKeys": { - "target": "com.amazonaws.storagegateway#TagKeys", + "ResourceARN": { + "target": "com.amazonaws.storagegateway#ResourceARN", "traits": { - "smithy.api#documentation": "

    The keys of the tags you want to remove from the specified resource. A tag is composed\n of a key-value pair.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource you want to remove the tags from.

    ", "smithy.api#required": {} } } @@ -5578,6 +5894,32 @@ } } }, + "com.amazonaws.storagegateway#RetentionLockTimeInDays": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 36500 + } + } + }, + "com.amazonaws.storagegateway#RetentionLockType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPLIANCE" + }, + { + "value": "GOVERNANCE" + }, + { + "value": "NONE" + } + ] + } + }, "com.amazonaws.storagegateway#RetrieveTapeArchive": { "type": "operation", "input": { @@ -5657,16 +5999,16 @@ "com.amazonaws.storagegateway#RetrieveTapeRecoveryPointInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the\n recovery point.

    ", "smithy.api#required": {} } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the\n recovery point.

    ", "smithy.api#required": {} } } @@ -5703,55 +6045,31 @@ "com.amazonaws.storagegateway#SMBFileShareInfo": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.

    " - } - }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", - "traits": { - "smithy.api#documentation": "

    Refresh cache information.

    " - } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "FileShareStatus": { + "target": "com.amazonaws.storagegateway#FileShareStatus" }, - "SMBACLEnabled": { - "target": "com.amazonaws.storagegateway#Boolean", + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

    If this value is set to true, it indicates that access control list (ACL)\n is enabled on the SMB file share. If it is set to false, it indicates that\n file and directory permissions are mapped to the POSIX permission.

    \n\n \n\n

    For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.

    " + "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " } }, - "AdminUserList": { + "ValidUserList": { "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, - "Role": { - "target": "com.amazonaws.storagegateway#Role" - }, - "LocationARN": { - "target": "com.amazonaws.storagegateway#LocationARN" - }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" - }, - "FileShareARN": { - "target": "com.amazonaws.storagegateway#FileShareARN" - }, "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, - "RequesterPays": { - "target": "com.amazonaws.storagegateway#Boolean", + "AuditDestinationARN": { + "target": "com.amazonaws.storagegateway#AuditDestinationARN", "traits": { - "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the storage used for the audit logs.

    " } }, "FileShareName": { @@ -5760,64 +6078,88 @@ "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " } }, - "DefaultStorageClass": { - "target": "com.amazonaws.storagegateway#StorageClass", + "Authentication": { + "target": "com.amazonaws.storagegateway#Authentication" + }, + "GuessMIMETypeEnabled": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " + "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " } }, - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL" + "Role": { + "target": "com.amazonaws.storagegateway#Role" }, - "Path": { - "target": "com.amazonaws.storagegateway#Path", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "

    The file share path used by the SMB client to identify the mount point.

    " + "smithy.api#documentation": "

    A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource API operation.

    " } }, - "GuessMIMETypeEnabled": { + "ReadOnly": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " } }, - "InvalidUserList": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "AdminUserList": { "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, - "FileShareStatus": { - "target": "com.amazonaws.storagegateway#FileShareStatus" - }, - "Authentication": { - "target": "com.amazonaws.storagegateway#Authentication" + "LocationARN": { + "target": "com.amazonaws.storagegateway#LocationARN" }, - "ValidUserList": { + "InvalidUserList": { "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, - "ReadOnly": { - "target": "com.amazonaws.storagegateway#Boolean", + "CacheAttributes": { + "target": "com.amazonaws.storagegateway#CacheAttributes", "traits": { - "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    Refresh cache information.

    " } }, - "AuditDestinationARN": { - "target": "com.amazonaws.storagegateway#AuditDestinationARN", + "CaseSensitivity": { + "target": "com.amazonaws.storagegateway#CaseSensitivity", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the storage used for the audit logs.

    " + "smithy.api#documentation": "

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.

    " } }, "FileShareId": { "target": "com.amazonaws.storagegateway#FileShareId" }, - "CaseSensitivity": { - "target": "com.amazonaws.storagegateway#CaseSensitivity", + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN" + }, + "RequesterPays": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.

    " + "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " + } + }, + "ObjectACL": { + "target": "com.amazonaws.storagegateway#ObjectACL" + }, + "Path": { + "target": "com.amazonaws.storagegateway#Path", + "traits": { + "smithy.api#documentation": "

    The file share path used by the SMB client to identify the mount point.

    " + } + }, + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey" + }, + "SMBACLEnabled": { + "target": "com.amazonaws.storagegateway#Boolean", + "traits": { + "smithy.api#documentation": "

    If this value is set to true, it indicates that access control list (ACL)\n is enabled on the SMB file share. If it is set to false, it indicates that\n file and directory permissions are mapped to the POSIX permission.

    \n\n \n\n

    For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.

    " } } }, @@ -5952,17 +6294,17 @@ "com.amazonaws.storagegateway#SetSMBGuestPasswordInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "Password": { + "target": "com.amazonaws.storagegateway#SMBGuestPassword", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated\n with.

    ", + "smithy.api#documentation": "

    The password that you want to set for your SMB server.

    ", "smithy.api#required": {} } }, - "Password": { - "target": "com.amazonaws.storagegateway#SMBGuestPassword", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "

    The password that you want to set for your SMB server.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated\n with.

    ", "smithy.api#required": {} } } @@ -6039,6 +6381,15 @@ "smithy.api#pattern": "\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z" } }, + "com.amazonaws.storagegateway#SoftwareUpdatesEndDate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.storagegateway#Squash": { "type": "string", "traits": { @@ -6146,17 +6497,17 @@ "com.amazonaws.storagegateway#StorageGatewayError": { "type": "structure", "members": { - "errorDetails": { - "target": "com.amazonaws.storagegateway#errorDetails", - "traits": { - "smithy.api#documentation": "

    Human-readable text that provides detail about the error that occurred.

    " - } - }, "errorCode": { "target": "com.amazonaws.storagegateway#ErrorCode", "traits": { "smithy.api#documentation": "

    Additional information about the error.

    " } + }, + "errorDetails": { + "target": "com.amazonaws.storagegateway#errorDetails", + "traits": { + "smithy.api#documentation": "

    Human-readable text that provides detail about the error that occurred.

    " + } } }, "traits": { @@ -6212,6 +6563,9 @@ { "target": "com.amazonaws.storagegateway#CreateStorediSCSIVolume" }, + { + "target": "com.amazonaws.storagegateway#CreateTapePool" + }, { "target": "com.amazonaws.storagegateway#CreateTapes" }, @@ -6242,6 +6596,9 @@ { "target": "com.amazonaws.storagegateway#DeleteTapeArchive" }, + { + "target": "com.amazonaws.storagegateway#DeleteTapePool" + }, { "target": "com.amazonaws.storagegateway#DeleteVolume" }, @@ -6323,6 +6680,9 @@ { "target": "com.amazonaws.storagegateway#ListTagsForResource" }, + { + "target": "com.amazonaws.storagegateway#ListTapePools" + }, { "target": "com.amazonaws.storagegateway#ListTapes" }, @@ -6407,13 +6767,13 @@ "sdkId": "Storage Gateway", "arnNamespace": "storagegateway", "cloudFormationName": "StorageGateway", - "cloudTrailEventSource": "v20130630.storagegateway.amazonaws.com" + "cloudTrailEventSource": "storagegateway.amazonaws.com" }, "aws.auth#sigv4": { "name": "storagegateway" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Storage Gateway Service\n\n

    AWS Storage Gateway is the service that connects an on-premises software appliance with\n cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the AWS storage infrastructure. The\n service enables you to securely upload data to the AWS Cloud for cost effective backup and\n rapid disaster recovery.

    \n\n

    Use the following links to get started using the AWS Storage Gateway Service\n API Reference:

    \n\n
      \n
    • \n

      \n AWS Storage Gateway required request headers: Describes the required\n headers that you must send with every POST request to AWS Storage Gateway.

      \n
      • \n
    • \n

      \n Signing requests: AWS Storage Gateway requires that you authenticate\n every request you send; this topic describes how sign such a request.

      \n
      • \n
    • \n

      \n Error responses: Provides reference information about AWS Storage Gateway\n errors.

      \n
      • \n
    • \n

      \n Operations in AWS\n Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway\n operations, their request parameters, response elements, possible errors, and\n examples of requests and responses.

      \n
      • \n
    • \n

      \n AWS Storage Gateway\n endpoints and quotas: Provides a list of each AWS Region and the endpoints\n available for use with AWS Storage Gateway.

      \n
      • \n
    \n\n \n

    AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your\n resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the\n ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with\n the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the\n EC2 API might not behave as expected.

    \n     \n\n \n

    IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes\n are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.

    \n\n

    For example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:

    \n\n

    \n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

    \n\n

    A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.

    \n\n

    For more information, see Announcement:\n Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in\n 2016.

    \n     ", + "smithy.api#documentation": "AWS Storage Gateway Service\n\n

    AWS Storage Gateway is the service that connects an on-premises software appliance with\n cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the AWS storage infrastructure. The\n service enables you to securely upload data to the AWS Cloud for cost effective backup and\n rapid disaster recovery.

    \n\n

    Use the following links to get started using the AWS Storage Gateway Service\n API Reference:

    \n\n
      \n
    • \n

      \n AWS Storage Gateway required request headers: Describes the required\n headers that you must send with every POST request to AWS Storage Gateway.

      \n
      • \n
    • \n

      \n Signing requests: AWS Storage Gateway requires that you authenticate\n every request you send; this topic describes how sign such a request.

      \n
      • \n
    • \n

      \n Error responses: Provides reference information about AWS Storage Gateway\n errors.

      \n
      • \n
    • \n

      \n Operations in AWS\n Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway\n operations, their request parameters, response elements, possible errors, and\n examples of requests and responses.

      \n
      • \n
    • \n

      \n AWS Storage Gateway\n endpoints and quotas: Provides a list of each AWS Region and the endpoints\n available for use with AWS Storage Gateway.

      \n
      • \n
    \n\n \n

    AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your\n resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the\n ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with\n the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the\n EC2 API might not behave as expected.

    \n     \n\n \n

    IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes\n are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.

    \n\n

    For example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:

    \n\n

    \n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

    \n\n

    A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.

    \n\n

    For more information, see Announcement:\n Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in\n 2016.

    \n     ", "smithy.api#title": "AWS Storage Gateway", "smithy.api#xmlNamespace": { "uri": "http://storagegateway.amazonaws.com/doc/2013-06-30" @@ -6423,31 +6783,28 @@ "com.amazonaws.storagegateway#StorediSCSIVolume": { "type": "structure", "members": { - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", + "CreatedDate": { + "target": "com.amazonaws.storagegateway#CreatedDate", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the storage volume.

    " + "smithy.api#documentation": "

    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this\n timestamp.

    " } }, - "VolumeId": { - "target": "com.amazonaws.storagegateway#VolumeId", + "VolumeDiskId": { + "target": "com.amazonaws.storagegateway#DiskId", "traits": { - "smithy.api#documentation": "

    The unique identifier of the volume, e.g. vol-AE4B946D.

    " + "smithy.api#documentation": "

    The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

    " } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" - }, "TargetName": { "target": "com.amazonaws.storagegateway#TargetName", "traits": { "smithy.api#documentation": "

    The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.\n The target name must be unique across all volumes on a gateway.

    \n\n

    If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.

    " } }, - "VolumeType": { - "target": "com.amazonaws.storagegateway#VolumeType", + "VolumeStatus": { + "target": "com.amazonaws.storagegateway#VolumeStatus", "traits": { - "smithy.api#documentation": "

    One of the VolumeType enumeration values describing the type of the volume.

    " + "smithy.api#documentation": "

    One of the VolumeStatus values that indicates the state of the storage volume.

    " } }, "VolumeProgress": { @@ -6456,16 +6813,19 @@ "smithy.api#documentation": "

    Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the stored volume is not restoring or bootstrapping.

    " } }, - "VolumeiSCSIAttributes": { - "target": "com.amazonaws.storagegateway#VolumeiSCSIAttributes", + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey" + }, + "VolumeUsedInBytes": { + "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", "traits": { - "smithy.api#documentation": "

    An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.

    " + "smithy.api#documentation": "

    The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.

    \n\n \n

    This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

    \n     " } }, - "VolumeAttachmentStatus": { - "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", + "VolumeiSCSIAttributes": { + "target": "com.amazonaws.storagegateway#VolumeiSCSIAttributes", "traits": { - "smithy.api#documentation": "

    A value that indicates whether a storage volume is attached to, detached from, or is in\n the process of detaching from a gateway. For more information, see Moving\n your volumes to a different gateway.

    " + "smithy.api#documentation": "

    An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.

    " } }, "PreservedExistingData": { @@ -6474,40 +6834,40 @@ "smithy.api#documentation": "

    Indicates if when the stored volume was created, existing data on the underlying local\n disk was preserved.

    \n\n

    Valid Values: true | false\n

    " } }, - "CreatedDate": { - "target": "com.amazonaws.storagegateway#CreatedDate", + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { - "smithy.api#documentation": "

    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this\n time stamp.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the storage volume.

    " } }, - "VolumeSizeInBytes": { - "target": "com.amazonaws.storagegateway#long", + "VolumeType": { + "target": "com.amazonaws.storagegateway#VolumeType", "traits": { - "smithy.api#documentation": "

    The size of the volume in bytes.

    " + "smithy.api#documentation": "

    One of the VolumeType enumeration values describing the type of the volume.

    " } }, - "SourceSnapshotId": { - "target": "com.amazonaws.storagegateway#SnapshotId", + "VolumeId": { + "target": "com.amazonaws.storagegateway#VolumeId", "traits": { - "smithy.api#documentation": "

    If the stored volume was created from a snapshot, this field contains the snapshot ID\n used, e.g. snap-78e22663. Otherwise, this field is not included.

    " + "smithy.api#documentation": "

    The unique identifier of the volume, e.g., vol-AE4B946D.

    " } }, - "VolumeDiskId": { - "target": "com.amazonaws.storagegateway#DiskId", + "VolumeAttachmentStatus": { + "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", "traits": { - "smithy.api#documentation": "

    The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

    " + "smithy.api#documentation": "

    A value that indicates whether a storage volume is attached to, detached from, or is in\n the process of detaching from a gateway. For more information, see Moving\n your volumes to a different gateway.

    " } }, - "VolumeUsedInBytes": { - "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", + "SourceSnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { - "smithy.api#documentation": "

    The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.

    \n\n \n

    This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

    \n     " + "smithy.api#documentation": "

    If the stored volume was created from a snapshot, this field contains the snapshot ID\n used, e.g. snap-78e22663. Otherwise, this field is not included.

    " } }, - "VolumeStatus": { - "target": "com.amazonaws.storagegateway#VolumeStatus", + "VolumeSizeInBytes": { + "target": "com.amazonaws.storagegateway#long", "traits": { - "smithy.api#documentation": "

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + "smithy.api#documentation": "

    The size of the volume in bytes.

    " } } }, @@ -6524,17 +6884,17 @@ "com.amazonaws.storagegateway#Tag": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.storagegateway#TagKey", + "Value": { + "target": "com.amazonaws.storagegateway#TagValue", "traits": { - "smithy.api#documentation": "

    Tag key. The key can't start with aws:.

    ", + "smithy.api#documentation": "

    Value of the tag key.

    ", "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.storagegateway#TagValue", + "Key": { + "target": "com.amazonaws.storagegateway#TagKey", "traits": { - "smithy.api#documentation": "

    Value of the tag key.

    ", + "smithy.api#documentation": "

    Tag key. The key can't start with aws:.

    ", "smithy.api#required": {} } } @@ -6577,22 +6937,22 @@ "com.amazonaws.storagegateway#Tape": { "type": "structure", "members": { - "TapeBarcode": { - "target": "com.amazonaws.storagegateway#TapeBarcode", + "TapeCreatedDate": { + "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "

    The barcode that identifies a specific virtual tape.

    " + "smithy.api#documentation": "

    The date the virtual tape was created.

    " } }, - "TapeUsedInBytes": { - "target": "com.amazonaws.storagegateway#TapeUsage", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { - "smithy.api#documentation": "

    The size, in bytes, of data stored on the virtual tape.

    \n\n \n

    This value is not available for tapes created prior to May 13, 2015.

    \n     " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape.

    " } }, - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", + "PoolEntryDate": { + "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "

    The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    \n\n

    Valid Values: GLACIER | DEEP_ARCHIVE\n

    " + "smithy.api#documentation": "

    The date that the tape enters a custom tape pool.

    " } }, "Progress": { @@ -6601,19 +6961,22 @@ "smithy.api#documentation": "

    For archiving virtual tapes, indicates how much data remains to be uploaded before\n archiving is complete.

    \n\n

    Range: 0 (not started) to 100 (complete).

    " } }, - "VTLDevice": { - "target": "com.amazonaws.storagegateway#VTLDeviceARN", + "Worm": { + "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "

    The virtual tape library (VTL) device that the virtual tape is associated with.

    " + "smithy.api#documentation": "

    If the tape is archived as write-once-read-many (WORM), this value is true.

    " } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" - }, - "TapeCreatedDate": { + "RetentionStartDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "

    The date the virtual tape was created.

    " + "smithy.api#documentation": "

    The date that the tape is first archived with tape retention lock enabled.

    " + } + }, + "PoolId": { + "target": "com.amazonaws.storagegateway#PoolId", + "traits": { + "smithy.api#documentation": "

    The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    \n\n

    Valid Values: GLACIER | DEEP_ARCHIVE\n

    " } }, "TapeSizeInBytes": { @@ -6622,16 +6985,31 @@ "smithy.api#documentation": "

    The size, in bytes, of the virtual tape capacity.

    " } }, + "TapeBarcode": { + "target": "com.amazonaws.storagegateway#TapeBarcode", + "traits": { + "smithy.api#documentation": "

    The barcode that identifies a specific virtual tape.

    " + } + }, "TapeStatus": { "target": "com.amazonaws.storagegateway#TapeStatus", "traits": { "smithy.api#documentation": "

    The current state of the virtual tape.

    " } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey" + }, + "TapeUsedInBytes": { + "target": "com.amazonaws.storagegateway#TapeUsage", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape.

    " + "smithy.api#documentation": "

    The size, in bytes, of data stored on the virtual tape.

    \n\n \n

    This value is not available for tapes created prior to May 13, 2015.

    \n     " + } + }, + "VTLDevice": { + "target": "com.amazonaws.storagegateway#VTLDeviceARN", + "traits": { + "smithy.api#documentation": "

    The virtual tape library (VTL) device that the virtual tape is associated with.

    " } } }, @@ -6661,28 +7039,31 @@ "com.amazonaws.storagegateway#TapeArchive": { "type": "structure", "members": { - "RetrievedTo": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being\n retrieved to.

    \n\n

    The virtual tape is retrieved from the virtual tape shelf (VTS).

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an archived virtual tape.

    " } }, - "CompletionTime": { + "TapeCreatedDate": { "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "

    The time that the archiving of the virtual tape was completed.

    \n\n

    The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'\n format.

    " + "smithy.api#documentation": "

    The date the virtual tape was created.

    " } }, - "TapeUsedInBytes": { - "target": "com.amazonaws.storagegateway#TapeUsage", + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey" + }, + "CompletionTime": { + "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "

    The size, in bytes, of data stored on the virtual tape.

    \n\n \n

    This value is not available for tapes created prior to May 13, 2015.

    \n     " + "smithy.api#documentation": "

    The time that the archiving of the virtual tape was completed.

    \n\n

    The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'\n format.

    " } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "TapeBarcode": { + "target": "com.amazonaws.storagegateway#TapeBarcode", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an archived virtual tape.

    " + "smithy.api#documentation": "

    The barcode that identifies the archived virtual tape.

    " } }, "TapeStatus": { @@ -6697,26 +7078,41 @@ "smithy.api#documentation": "

    The ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.

    \n\n

    Valid Values: GLACIER | DEEP_ARCHIVE\n

    " } }, - "TapeCreatedDate": { - "target": "com.amazonaws.storagegateway#Time", - "traits": { - "smithy.api#documentation": "

    The date the virtual tape was created.

    " - } - }, "TapeSizeInBytes": { "target": "com.amazonaws.storagegateway#TapeSize", "traits": { "smithy.api#documentation": "

    The size, in bytes, of the archived virtual tape.

    " } }, - "TapeBarcode": { - "target": "com.amazonaws.storagegateway#TapeBarcode", + "TapeUsedInBytes": { + "target": "com.amazonaws.storagegateway#TapeUsage", "traits": { - "smithy.api#documentation": "

    The barcode that identifies the archived virtual tape.

    " + "smithy.api#documentation": "

    The size, in bytes, of data stored on the virtual tape.

    \n\n \n

    This value is not available for tapes created prior to May 13, 2015.

    \n     " } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" + "Worm": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "

    Set to true if the archived tape is stored as write-once-read-many (WORM).

    " + } + }, + "RetrievedTo": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being\n retrieved to.

    \n\n

    The virtual tape is retrieved from the virtual tape shelf (VTS).

    " + } + }, + "RetentionStartDate": { + "target": "com.amazonaws.storagegateway#Time", + "traits": { + "smithy.api#documentation": "

    If the archived tape is subject to tape retention lock, the date that the archived tape \n started being retained.

    " + } + }, + "PoolEntryDate": { + "target": "com.amazonaws.storagegateway#Time", + "traits": { + "smithy.api#documentation": "

    The time that the tape entered the custom tape pool.

    \n \n

    The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    " + } } }, "traits": { @@ -6764,16 +7160,22 @@ "com.amazonaws.storagegateway#TapeInfo": { "type": "structure", "members": { - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "PoolId": { + "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a virtual tape.

    " + "smithy.api#documentation": "

    The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    \n\n

    Valid Values: GLACIER | DEEP_ARCHIVE\n

    " } }, - "TapeStatus": { - "target": "com.amazonaws.storagegateway#TapeStatus", + "RetentionStartDate": { + "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "

    The status of the tape.

    " + "smithy.api#documentation": "

    The date that the tape became subject to tape retention lock.

    " + } + }, + "PoolEntryDate": { + "target": "com.amazonaws.storagegateway#Time", + "traits": { + "smithy.api#documentation": "

    The date that the tape entered the custom tape pool with tape retention lock enabled.

    " } }, "TapeBarcode": { @@ -6788,16 +7190,22 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and AWS Region.

    " } }, - "TapeSizeInBytes": { - "target": "com.amazonaws.storagegateway#TapeSize", + "TapeStatus": { + "target": "com.amazonaws.storagegateway#TapeStatus", "traits": { - "smithy.api#documentation": "

    The size, in bytes, of a virtual tape.

    " + "smithy.api#documentation": "

    The status of the tape.

    " } }, - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { - "smithy.api#documentation": "

    The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    \n\n

    Valid Values: GLACIER | DEEP_ARCHIVE\n

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a virtual tape.

    " + } + }, + "TapeSizeInBytes": { + "target": "com.amazonaws.storagegateway#TapeSize", + "traits": { + "smithy.api#documentation": "

    The size, in bytes, of a virtual tape.

    " } } }, @@ -6817,10 +7225,10 @@ "com.amazonaws.storagegateway#TapeRecoveryPointInfo": { "type": "structure", "members": { - "TapeRecoveryPointTime": { - "target": "com.amazonaws.storagegateway#Time", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { - "smithy.api#documentation": "

    The time when the point-in-time view of the virtual tape was replicated for later\n recovery.

    \n\n

    The default time stamp format of the tape recovery point time is in the ISO8601 extended\n YYYY-MM-DD'T'HH:MM:SS'Z' format.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape.

    " } }, "TapeStatus": { @@ -6835,10 +7243,10 @@ "smithy.api#documentation": "

    The size, in bytes, of the virtual tapes to recover.

    " } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "TapeRecoveryPointTime": { + "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the virtual tape.

    " + "smithy.api#documentation": "

    The time when the point-in-time view of the virtual tape was replicated for later\n recovery.

    \n\n

    The default timestamp format of the tape recovery point time is in the ISO8601 extended\n YYYY-MM-DD'T'HH:MM:SS'Z' format.

    " } } }, @@ -6864,6 +7272,19 @@ "com.amazonaws.storagegateway#TapeStatus": { "type": "string" }, + "com.amazonaws.storagegateway#TapeStorageClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEEP_ARCHIVE" + }, + { + "value": "GLACIER" + } + ] + } + }, "com.amazonaws.storagegateway#TapeUsage": { "type": "long", "traits": { @@ -6977,6 +7398,12 @@ "com.amazonaws.storagegateway#UpdateBandwidthRateLimitInput": { "type": "structure", "members": { + "AverageDownloadRateLimitInBitsPerSec": { + "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", + "traits": { + "smithy.api#documentation": "

    The average download bandwidth rate limit in bits per second.

    " + } + }, "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { @@ -6988,12 +7415,6 @@ "traits": { "smithy.api#required": {} } - }, - "AverageDownloadRateLimitInBitsPerSec": { - "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", - "traits": { - "smithy.api#documentation": "

    The average download bandwidth rate limit in bits per second.

    " - } } }, "traits": { @@ -7034,19 +7455,13 @@ "com.amazonaws.storagegateway#UpdateChapCredentialsInput": { "type": "structure", "members": { - "SecretToAuthenticateInitiator": { - "target": "com.amazonaws.storagegateway#ChapSecret", + "TargetARN": { + "target": "com.amazonaws.storagegateway#TargetARN", "traits": { - "smithy.api#documentation": "

    The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.

    \n\n \n

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    \n     ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified\n VolumeARN.

    ", "smithy.api#required": {} } }, - "SecretToAuthenticateTarget": { - "target": "com.amazonaws.storagegateway#ChapSecret", - "traits": { - "smithy.api#documentation": "

    The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g. Windows client).

    \n\n

    Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

    \n\n \n

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    \n     " - } - }, "InitiatorName": { "target": "com.amazonaws.storagegateway#IqnName", "traits": { @@ -7054,10 +7469,16 @@ "smithy.api#required": {} } }, - "TargetARN": { - "target": "com.amazonaws.storagegateway#TargetARN", + "SecretToAuthenticateTarget": { + "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified\n VolumeARN.

    ", + "smithy.api#documentation": "

    The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g. Windows client).

    \n\n

    Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

    \n\n \n

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    \n     " + } + }, + "SecretToAuthenticateInitiator": { + "target": "com.amazonaws.storagegateway#ChapSecret", + "traits": { + "smithy.api#documentation": "

    The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.

    \n\n \n

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    \n     ", "smithy.api#required": {} } } @@ -7103,19 +7524,25 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates a gateway's metadata, which includes the gateway's name and time zone.\n To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in\n your request.

    \n\n \n

    For Gateways activated after September 2, 2015, the gateway's ARN contains the\n gateway ID rather than the gateway name. However, changing the name of the gateway has\n no effect on the gateway's ARN.

    \n     " + "smithy.api#documentation": "

    Updates a gateway's metadata, which includes the gateway's name and time zone.\n To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in\n your request.

    \n\n \n

    For gateways activated after September 2, 2015, the gateway's ARN contains the\n gateway ID rather than the gateway name. However, changing the name of the gateway has\n no effect on the gateway's ARN.

    \n     " } }, "com.amazonaws.storagegateway#UpdateGatewayInformationInput": { "type": "structure", "members": { + "GatewayTimezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", + "traits": { + "smithy.api#documentation": "

    A value that indicates the time zone of the gateway.

    " + } + }, "GatewayName": { "target": "com.amazonaws.storagegateway#GatewayName" }, "CloudWatchLogGroupARN": { "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use\n to monitor and log events in the gateway.

    \n\n

    For more information, see What is Amazon CloudWatch\n logs?.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use\n to monitor and log events in the gateway.

    \n\n

    For more information, see What is Amazon CloudWatch\n Logs?\n

    " } }, "GatewayARN": { @@ -7123,26 +7550,20 @@ "traits": { "smithy.api#required": {} } - }, - "GatewayTimezone": { - "target": "com.amazonaws.storagegateway#GatewayTimezone", - "traits": { - "smithy.api#documentation": "

    A value that indicates the time zone of the gateway.

    " - } } } }, "com.amazonaws.storagegateway#UpdateGatewayInformationOutput": { "type": "structure", "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, "GatewayName": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "

    The name you configured for your gateway.

    " } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -7217,6 +7638,12 @@ "com.amazonaws.storagegateway#UpdateMaintenanceStartTimeInput": { "type": "structure", "members": { + "DayOfMonth": { + "target": "com.amazonaws.storagegateway#DayOfMonth", + "traits": { + "smithy.api#documentation": "

    The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.

    " + } + }, "MinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { @@ -7224,6 +7651,12 @@ "smithy.api#required": {} } }, + "DayOfWeek": { + "target": "com.amazonaws.storagegateway#DayOfWeek", + "traits": { + "smithy.api#documentation": "

    The day of the week component of the maintenance start time week represented as an\n ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.

    " + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { @@ -7236,18 +7669,6 @@ "smithy.api#documentation": "

    The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.

    ", "smithy.api#required": {} } - }, - "DayOfWeek": { - "target": "com.amazonaws.storagegateway#DayOfWeek", - "traits": { - "smithy.api#documentation": "

    The day of the week component of the maintenance start time week represented as an\n ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.

    " - } - }, - "DayOfMonth": { - "target": "com.amazonaws.storagegateway#DayOfMonth", - "traits": { - "smithy.api#documentation": "

    The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.

    " - } } }, "traits": { @@ -7288,34 +7709,17 @@ "com.amazonaws.storagegateway#UpdateNFSFileShareInput": { "type": "structure", "members": { - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL", - "traits": { - "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.

    " - } - }, - "FileShareName": { - "target": "com.amazonaws.storagegateway#FileShareName", + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { - "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the file share to be updated.

    ", + "smithy.api#required": {} } }, - "GuessMIMETypeEnabled": { + "RequesterPays": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " - } - }, - "ClientList": { - "target": "com.amazonaws.storagegateway#FileShareClientList", - "traits": { - "smithy.api#documentation": "

    The list of clients that are allowed to access the file gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.

    " - } - }, - "NFSFileShareDefaults": { - "target": "com.amazonaws.storagegateway#NFSFileShareDefaults", - "traits": { - "smithy.api#documentation": "

    The default values for the file share. Optional.

    " + "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " } }, "ReadOnly": { @@ -7324,16 +7728,16 @@ "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set the write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " } }, - "RequesterPays": { - "target": "com.amazonaws.storagegateway#Boolean", + "ObjectACL": { + "target": "com.amazonaws.storagegateway#ObjectACL", "traits": { - "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " + "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.

    " } }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", + "Squash": { + "target": "com.amazonaws.storagegateway#Squash", "traits": { - "smithy.api#documentation": "

    Refresh cache information.

    " + "smithy.api#documentation": "

    The user mapped to anonymous user.

    \n\n

    Valid values are the following:

    \n\n
      \n
    • \n

      \n RootSquash: Only root is mapped to anonymous user.

      \n
      • \n
    • \n

      \n NoSquash: No one is mapped to anonymous user.

      \n
      • \n
    • \n

      \n AllSquash: Everyone is mapped to anonymous user.

      \n
      • \n
    " } }, "KMSKey": { @@ -7342,11 +7746,10 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " } }, - "FileShareARN": { - "target": "com.amazonaws.storagegateway#FileShareARN", + "ClientList": { + "target": "com.amazonaws.storagegateway#FileShareClientList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the file share to be updated.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The list of clients that are allowed to access the file gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.

    " } }, "KMSEncrypted": { @@ -7355,10 +7758,16 @@ "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, - "Squash": { - "target": "com.amazonaws.storagegateway#Squash", + "NFSFileShareDefaults": { + "target": "com.amazonaws.storagegateway#NFSFileShareDefaults", "traits": { - "smithy.api#documentation": "

    The user mapped to anonymous user.

    \n\n

    Valid values are the following:

    \n\n
      \n
    • \n

      \n RootSquash: Only root is mapped to anonymous user.

      \n
      • \n
    • \n

      \n NoSquash: No one is mapped to anonymous user.

      \n
      • \n
    • \n

      \n AllSquash: Everyone is mapped to anonymous user.

      \n
      • \n
    " + "smithy.api#documentation": "

    The default values for the file share. Optional.

    " + } + }, + "FileShareName": { + "target": "com.amazonaws.storagegateway#FileShareName", + "traits": { + "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " } }, "DefaultStorageClass": { @@ -7366,6 +7775,18 @@ "traits": { "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " } + }, + "CacheAttributes": { + "target": "com.amazonaws.storagegateway#CacheAttributes", + "traits": { + "smithy.api#documentation": "

    Refresh cache information.

    " + } + }, + "GuessMIMETypeEnabled": { + "target": "com.amazonaws.storagegateway#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " + } } }, "traits": { @@ -7409,46 +7830,52 @@ "com.amazonaws.storagegateway#UpdateSMBFileShareInput": { "type": "structure", "members": { - "DefaultStorageClass": { - "target": "com.amazonaws.storagegateway#StorageClass", + "GuessMIMETypeEnabled": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " + "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " } }, - "ValidUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", + "ReadOnly": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " + "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " } }, - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean", + "ObjectACL": { + "target": "com.amazonaws.storagegateway#ObjectACL", "traits": { - "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " + "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.

    " } }, - "InvalidUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", + "FileShareName": { + "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " + "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey", + "CaseSensitivity": { + "target": "com.amazonaws.storagegateway#CaseSensitivity", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " + "smithy.api#documentation": "

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.

    " } }, - "ReadOnly": { + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", + "traits": { + "smithy.api#documentation": "

    The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.

    \n\n

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

    " + } + }, + "SMBACLEnabled": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    A value that sets the write status of a file share. Set this value to true\n to set write status to read-only, otherwise set to false.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.

    \n\n \n\n

    For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.

    \n\n

    Valid Values: true | false\n

    " } }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", + "KMSKey": { + "target": "com.amazonaws.storagegateway#KMSKey", "traits": { - "smithy.api#documentation": "

    Refresh cache information.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.

    " } }, "AuditDestinationARN": { @@ -7457,17 +7884,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the storage used for the audit logs.

    " } }, - "CaseSensitivity": { - "target": "com.amazonaws.storagegateway#CaseSensitivity", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.

    " + "smithy.api#documentation": "

    Set to true to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false to use a key managed by Amazon S3. Optional.

    \n\n

    Valid Values: true | false\n

    " } }, - "FileShareARN": { - "target": "com.amazonaws.storagegateway#FileShareARN", + "ValidUserList": { + "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SMB file share that you want to update.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, "RequesterPays": { @@ -7476,34 +7902,29 @@ "smithy.api#documentation": "

    A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.

    \n\n \n

    \n RequesterPays is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.

    \n     \n\n

    Valid Values: true | false\n

    " } }, - "AdminUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", - "traits": { - "smithy.api#documentation": "

    A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " - } - }, - "SMBACLEnabled": { - "target": "com.amazonaws.storagegateway#Boolean", + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { - "smithy.api#documentation": "

    Set this value to true to enable access control list (ACL) on the SMB file\n share. Set it to false to map file and directory permissions to the POSIX\n permissions.

    \n\n \n\n

    For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SMB file share that you want to update.

    ", + "smithy.api#required": {} } }, - "GuessMIMETypeEnabled": { - "target": "com.amazonaws.storagegateway#Boolean", + "InvalidUserList": { + "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "

    A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true to enable MIME type guessing, otherwise set\n to false. The default value is true.

    \n\n

    Valid Values: true | false\n

    " + "smithy.api#documentation": "

    A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL", + "AdminUserList": { + "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "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#documentation": "

    A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1, user1, @group1, and\n @DOMAIN\\group1. Can only be set if Authentication is set to\n ActiveDirectory.

    " } }, - "FileShareName": { - "target": "com.amazonaws.storagegateway#FileShareName", + "CacheAttributes": { + "target": "com.amazonaws.storagegateway#CacheAttributes", "traits": { - "smithy.api#documentation": "

    The name of the file share. Optional.

    \n\n \n

    \n FileShareName must be set if an S3 prefix name is set in\n LocationARN.

    \n     " + "smithy.api#documentation": "

    Refresh cache information.

    " } } }, @@ -7594,6 +8015,18 @@ "com.amazonaws.storagegateway#UpdateSnapshotScheduleInput": { "type": "structure", "members": { + "Description": { + "target": "com.amazonaws.storagegateway#Description", + "traits": { + "smithy.api#documentation": "

    Optional description of the snapshot that overwrites the existing description.

    " + } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " + } + }, "RecurrenceInHours": { "target": "com.amazonaws.storagegateway#RecurrenceInHours", "traits": { @@ -7614,18 +8047,6 @@ "smithy.api#documentation": "

    The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.

    ", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.

    \n\n \n

    Valid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.

    \n     " - } - }, - "Description": { - "target": "com.amazonaws.storagegateway#Description", - "traits": { - "smithy.api#documentation": "

    Optional description of the snapshot that overwrites the existing description.

    " - } } }, "traits": { @@ -7669,17 +8090,17 @@ "com.amazonaws.storagegateway#UpdateVTLDeviceTypeInput": { "type": "structure", "members": { - "VTLDeviceARN": { - "target": "com.amazonaws.storagegateway#VTLDeviceARN", + "DeviceType": { + "target": "com.amazonaws.storagegateway#DeviceType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the medium changer you want to select.

    ", + "smithy.api#documentation": "

    The type of medium changer you want to select.

    \n\n

    Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402\n

    ", "smithy.api#required": {} } }, - "DeviceType": { - "target": "com.amazonaws.storagegateway#DeviceType", + "VTLDeviceARN": { + "target": "com.amazonaws.storagegateway#VTLDeviceARN", "traits": { - "smithy.api#documentation": "

    The type of medium changer you want to select.

    \n\n

    Valid Values: STK-L700 | AWS-Gateway-VTL\n

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the medium changer you want to select.

    ", "smithy.api#required": {} } } @@ -7702,24 +8123,12 @@ "com.amazonaws.storagegateway#VTLDevice": { "type": "structure", "members": { - "VTLDeviceProductIdentifier": { - "target": "com.amazonaws.storagegateway#VTLDeviceProductIdentifier", - "traits": { - "smithy.api#documentation": "

    Specifies the model number of device that the VTL device emulates.

    " - } - }, "VTLDeviceVendor": { "target": "com.amazonaws.storagegateway#VTLDeviceVendor", "traits": { "smithy.api#documentation": "

    Specifies the vendor of the device that the VTL device object emulates.

    " } }, - "VTLDeviceType": { - "target": "com.amazonaws.storagegateway#VTLDeviceType", - "traits": { - "smithy.api#documentation": "

    Specifies the type of device that the VTL device emulates.

    " - } - }, "DeviceiSCSIAttributes": { "target": "com.amazonaws.storagegateway#DeviceiSCSIAttributes", "traits": { @@ -7731,6 +8140,18 @@ "traits": { "smithy.api#documentation": "

    Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media\n changer).

    " } + }, + "VTLDeviceType": { + "target": "com.amazonaws.storagegateway#VTLDeviceType", + "traits": { + "smithy.api#documentation": "

    Specifies the type of device that the VTL device emulates.

    " + } + }, + "VTLDeviceProductIdentifier": { + "target": "com.amazonaws.storagegateway#VTLDeviceProductIdentifier", + "traits": { + "smithy.api#documentation": "

    Specifies the model number of device that the VTL device emulates.

    " + } } }, "traits": { @@ -7803,13 +8224,16 @@ "com.amazonaws.storagegateway#VolumeInfo": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "VolumeAttachmentStatus": { + "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", + "traits": { + "smithy.api#documentation": "

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + } }, - "VolumeId": { - "target": "com.amazonaws.storagegateway#VolumeId", + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { - "smithy.api#documentation": "

    The unique identifier assigned to the volume. This ID becomes part of the volume Amazon\n Resource Name (ARN), which you use as input for other operations.

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the storage volume. For example, the following is a\n valid ARN:

    \n\n

    \n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB\n

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " } }, "VolumeType": { @@ -7818,28 +8242,25 @@ "smithy.api#documentation": "

    One of the VolumeType enumeration values describing the type of the volume.

    " } }, - "GatewayId": { - "target": "com.amazonaws.storagegateway#GatewayId", - "traits": { - "smithy.api#documentation": "

    The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " - } - }, "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { "smithy.api#documentation": "

    The size of the volume in bytes.

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " } }, - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "VolumeId": { + "target": "com.amazonaws.storagegateway#VolumeId", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the storage volume. For example, the following is a\n valid ARN:

    \n\n

    \n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB\n

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + "smithy.api#documentation": "

    The unique identifier assigned to the volume. This ID becomes part of the volume Amazon\n Resource Name (ARN), which you use as input for other operations.

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " } }, - "VolumeAttachmentStatus": { - "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", + "GatewayId": { + "target": "com.amazonaws.storagegateway#GatewayId", "traits": { - "smithy.api#documentation": "

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + "smithy.api#documentation": "

    The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.

    \n\n

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " } } }, @@ -7856,16 +8277,10 @@ "com.amazonaws.storagegateway#VolumeRecoveryPointInfo": { "type": "structure", "members": { - "VolumeSizeInBytes": { + "VolumeUsageInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { - "smithy.api#documentation": "

    The size of the volume in bytes.

    " - } - }, - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume target.

    " + "smithy.api#documentation": "

    The size of the data stored on the volume in bytes.

    \n\n \n

    This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

    \n     " } }, "VolumeRecoveryPointTime": { @@ -7874,10 +8289,16 @@ "smithy.api#documentation": "

    The time the recovery point was taken.

    " } }, - "VolumeUsageInBytes": { + "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { - "smithy.api#documentation": "

    The size of the data stored on the volume in bytes.

    \n\n \n

    This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

    \n     " + "smithy.api#documentation": "

    The size of the volume in bytes.

    " + } + }, + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume target.

    " } } }, @@ -7918,34 +8339,34 @@ "com.amazonaws.storagegateway#VolumeiSCSIAttributes": { "type": "structure", "members": { - "LunNumber": { - "target": "com.amazonaws.storagegateway#PositiveIntObject", - "traits": { - "smithy.api#documentation": "

    The logical disk number.

    " - } - }, - "NetworkInterfacePort": { - "target": "com.amazonaws.storagegateway#integer", - "traits": { - "smithy.api#documentation": "

    The port used to communicate with iSCSI targets.

    " - } - }, "ChapEnabled": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { "smithy.api#documentation": "

    Indicates whether mutual CHAP is enabled for the iSCSI target.

    " } }, + "NetworkInterfaceId": { + "target": "com.amazonaws.storagegateway#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

    The network interface identifier.

    " + } + }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the volume target.

    " } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.storagegateway#NetworkInterfaceId", + "LunNumber": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { - "smithy.api#documentation": "

    The network interface identifier.

    " + "smithy.api#documentation": "

    The logical disk number.

    " + } + }, + "NetworkInterfacePort": { + "target": "com.amazonaws.storagegateway#integer", + "traits": { + "smithy.api#documentation": "

    The port used to communicate with iSCSI targets.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/sts.2011-06-15.json b/codegen/sdk-codegen/aws-models/sts.2011-06-15.json index 4a1cdf7baa28..a8ac5f2a78b6 100644 --- a/codegen/sdk-codegen/aws-models/sts.2011-06-15.json +++ b/codegen/sdk-codegen/aws-models/sts.2011-06-15.json @@ -69,7 +69,7 @@ "name": "sts" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "AWS Security Token Service\n

    The AWS Security Token Service (STS) is a web service that enables you to request\n temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or\n for users that you authenticate (federated users). This guide provides descriptions of the STS\n API. For more detailed information about using this service, go to Temporary Security Credentials.

    \n \n \n

    For information about setting up signatures and authorization through the API, go to\n Signing\n AWS API Requests in the AWS General Reference. For general\n information about the Query API, go to Making Query Requests in\n Using IAM. For information about using security tokens with other AWS\n products, go to AWS Services That\n Work with IAM in the IAM User Guide.

    \n

    If you're new to AWS and need additional technical information about a specific AWS\n product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

    \n\n

    \n Endpoints\n

    \n

    By default, AWS Security Token Service (STS) is available as a global service, and all AWS\n STS requests go to a single endpoint at https://sts.amazonaws.com. Global\n requests map to the US East (N. Virginia) region. AWS recommends using Regional AWS STS\n endpoints instead of the global endpoint to reduce latency, build in redundancy, and increase\n session token validity. For more information, see Managing AWS STS in an\n AWS Region in the IAM User Guide.

    \n

    Most AWS Regions are enabled for operations in all AWS services by default. Those Regions\n are automatically activated for use with AWS STS. Some Regions, such as Asia Pacific (Hong\n Kong), must be manually enabled. To learn more about enabling and disabling AWS Regions, see\n Managing AWS\n Regions in the AWS General Reference. When you enable these AWS\n Regions, they are automatically activated for use with AWS STS. You cannot activate the STS\n endpoint for a Region that is disabled. Tokens that are valid in all AWS Regions are longer\n than tokens that are valid in Regions that are enabled by default. Changing this setting might\n affect existing systems where you temporarily store tokens. For more information, see Managing Global Endpoint Session Tokens in the IAM User\n Guide.

    \n

    After you activate a Region for use with AWS STS, you can direct AWS STS API calls to that\n Region. AWS STS recommends that you provide both the Region and endpoint when you make calls\n to a Regional endpoint. You can provide the Region alone for manually enabled Regions, such as\n Asia Pacific (Hong Kong). In this case, the calls are directed to the STS Regional endpoint.\n However, if you provide the Region alone for Regions enabled by default, the calls are\n directed to the global endpoint of https://sts.amazonaws.com.

    \n

    To view the list of AWS STS endpoints and whether they are active by default, see Writing Code to Use AWS STS Regions in the IAM User\n Guide.

    \n\n

    \n Recording API requests\n

    \n

    STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS\n account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine what requests were successfully made to STS, who made the\n request, when it was made, and so on.

    \n

    If you activate AWS STS endpoints in Regions other than the default global endpoint, then\n you must also turn on CloudTrail logging in those Regions. This is necessary to record any AWS\n STS API calls that are made in those Regions. For more information, see Turning On\n CloudTrail in Additional Regions in the AWS CloudTrail User\n Guide.

    \n

    AWS Security Token Service (STS) is a global service with a single endpoint at\n https://sts.amazonaws.com. Calls to this endpoint are logged as calls to a\n global service. However, because this endpoint is physically located in the US East (N.\n Virginia) Region, your logs list us-east-1 as the event Region. CloudTrail does\n not write these logs to the US East (Ohio) Region unless you choose to include global service\n logs in that Region. CloudTrail writes calls to all Regional endpoints to their respective\n Regions. For example, calls to sts.us-east-2.amazonaws.com are published to the US East (Ohio)\n Region and calls to sts.eu-central-1.amazonaws.com are published to the EU (Frankfurt)\n Region.

    \n

    To learn more about CloudTrail, including how to turn it on and find your log files, see\n the AWS CloudTrail User\n Guide.

    ", + "smithy.api#documentation": "AWS Security Token Service\n

    AWS Security Token Service (STS) enables you to request temporary, limited-privilege \n credentials for AWS Identity and Access Management (IAM) users or for users that you \n authenticate (federated users). This guide provides descriptions of the STS API. For \n more information about using this service, see Temporary Security Credentials.

    ", "smithy.api#title": "AWS Security Token Service", "smithy.api#xmlNamespace": { "uri": "https://sts.amazonaws.com/doc/2011-06-15/" @@ -85,6 +85,9 @@ "target": "com.amazonaws.sts#AssumeRoleResponse" }, "errors": [ + { + "target": "com.amazonaws.sts#ExpiredTokenException" + }, { "target": "com.amazonaws.sts#MalformedPolicyDocumentException" }, @@ -102,28 +105,10 @@ "com.amazonaws.sts#AssumeRoleRequest": { "type": "structure", "members": { - "ExternalId": { - "target": "com.amazonaws.sts#externalIdType", - "traits": { - "smithy.api#documentation": "

    A unique identifier that might be required when you assume a role in another account. If\n the administrator of the account to which the role belongs provided you with an external\n ID, then provide that value in the ExternalId parameter. This value can be any\n string, such as a passphrase or account number. A cross-account role is usually set up to\n trust everyone in an account. Therefore, the administrator of the trusting account might\n send an external ID to the administrator of the trusted account. That way, only someone\n with the ID can assume the role, rather than everyone in the account. For more information\n about the external ID, see How to Use an External ID\n When Granting Access to Your AWS Resources to a Third Party in the\n IAM User Guide.

    \n

    The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-

    " - } - }, - "SerialNumber": { - "target": "com.amazonaws.sts#serialNumberType", - "traits": { - "smithy.api#documentation": "

    The identification number of the MFA device that is associated with the user who is\n making the AssumeRole call. Specify this value if the trust policy of the role\n being assumed includes a condition that requires MFA authentication. The value is either\n the serial number for a hardware device (such as GAHT12345678) or an Amazon\n Resource Name (ARN) for a virtual device (such as\n arn:aws:iam::123456789012:mfa/user).

    \n

    The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-

    " - } - }, - "PolicyArns": { - "target": "com.amazonaws.sts#policyDescriptorListType", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.

    \n

    This parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plain text that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS\n Service Namespaces in the AWS General Reference.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    " - } - }, - "TransitiveTagKeys": { - "target": "com.amazonaws.sts#tagKeyListType", + "DurationSeconds": { + "target": "com.amazonaws.sts#roleDurationSecondsType", "traits": { - "smithy.api#documentation": "

    A list of keys for session tags that you want to set as transitive. If you set a tag key\n as transitive, the corresponding key and value passes to subsequent sessions in a role\n chain. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

    \n

    This parameter is optional. When you set session tags as transitive, the session policy\n and session tags packed binary limit is not affected.

    \n

    If you choose not to specify a transitive tag key, then no tags are passed from this\n session to any subsequent sessions.

    " + "smithy.api#documentation": "

    The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) up to the maximum session duration setting for the role. This setting can have a\n value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.

    \n

    By default, the value is set to 3600 seconds.

    \n \n

    The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the AWS Management Console in the\n IAM User Guide.

    \n     " } }, "RoleSessionName": { @@ -139,16 +124,23 @@ "smithy.api#documentation": "

    The value provided by the MFA device, if the trust policy of the role being assumed\n requires MFA (that is, if the policy includes a condition that tests for MFA). If the role\n being assumed requires MFA and if the TokenCode value is missing or expired,\n the AssumeRole call returns an \"access denied\" error.

    \n

    The format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.

    " } }, - "Policy": { - "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "PolicyArns": { + "target": "com.amazonaws.sts#policyDescriptorListType", "traits": { - "smithy.api#documentation": "

    An IAM policy in JSON format that you want to use as an inline session policy.

    \n

    This parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    \n

    The plain text that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     " + "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.

    \n

    This parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plain text that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS\n Service Namespaces in the AWS General Reference.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    " } }, - "DurationSeconds": { - "target": "com.amazonaws.sts#roleDurationSecondsType", + "RoleArn": { + "target": "com.amazonaws.sts#arnType", "traits": { - "smithy.api#documentation": "

    The duration, in seconds, of the role session. The value can range from 900 seconds (15\n minutes) up to the maximum session duration setting for the role. This setting can have a\n value from 1 hour to 12 hours. If you specify a value higher than this setting, the\n operation fails. For example, if you specify a session duration of 12 hours, but your\n administrator set the maximum session duration to 6 hours, your operation fails. To learn\n how to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide.

    \n

    By default, the value is set to 3600 seconds.

    \n \n

    The DurationSeconds parameter is separate from the duration of a console\n session that you might request using the returned credentials. The request to the\n federation endpoint for a console sign-in token takes a SessionDuration\n parameter that specifies the maximum length of the console session. For more\n information, see Creating a URL\n that Enables Federated Users to Access the AWS Management Console in the\n IAM User Guide.

    \n     " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the role to assume.

    ", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "traits": { + "smithy.api#documentation": "

    An IAM policy in JSON format that you want to use as an inline session policy.

    \n

    This parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    \n

    The plain text that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     " } }, "Tags": { @@ -157,11 +149,22 @@ "smithy.api#documentation": "

    A list of session tags that you want to pass. Each session tag consists of a key name\n and an associated value. For more information about session tags, see Tagging AWS STS\n Sessions in the IAM User Guide.

    \n

    This parameter is optional. You can pass up to 50 session tags. The plain text session\n tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    You can pass a session tag with the same key as a tag that is already attached to the\n role. When you do, session tags override a role tag with the same key.

    \n

    Tag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.

    \n

    Additionally, if you used temporary credentials to perform this operation, the new\n session inherits any transitive session tags from the calling session. If you pass a\n session tag with the same key as an inherited tag, the operation fails. To view the\n inherited tags for a session, see the AWS CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the\n IAM User Guide.

    " } }, - "RoleArn": { - "target": "com.amazonaws.sts#arnType", + "ExternalId": { + "target": "com.amazonaws.sts#externalIdType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the role to assume.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A unique identifier that might be required when you assume a role in another account. If\n the administrator of the account to which the role belongs provided you with an external\n ID, then provide that value in the ExternalId parameter. This value can be any\n string, such as a passphrase or account number. A cross-account role is usually set up to\n trust everyone in an account. Therefore, the administrator of the trusting account might\n send an external ID to the administrator of the trusted account. That way, only someone\n with the ID can assume the role, rather than everyone in the account. For more information\n about the external ID, see How to Use an External ID\n When Granting Access to Your AWS Resources to a Third Party in the\n IAM User Guide.

    \n

    The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-

    " + } + }, + "TransitiveTagKeys": { + "target": "com.amazonaws.sts#tagKeyListType", + "traits": { + "smithy.api#documentation": "

    A list of keys for session tags that you want to set as transitive. If you set a tag key\n as transitive, the corresponding key and value passes to subsequent sessions in a role\n chain. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

    \n

    This parameter is optional. When you set session tags as transitive, the session policy\n and session tags packed binary limit is not affected.

    \n

    If you choose not to specify a transitive tag key, then no tags are passed from this\n session to any subsequent sessions.

    " + } + }, + "SerialNumber": { + "target": "com.amazonaws.sts#serialNumberType", + "traits": { + "smithy.api#documentation": "

    The identification number of the MFA device that is associated with the user who is\n making the AssumeRole call. Specify this value if the trust policy of the role\n being assumed includes a condition that requires MFA authentication. The value is either\n the serial number for a hardware device (such as GAHT12345678) or an Amazon\n Resource Name (ARN) for a virtual device (such as\n arn:aws:iam::123456789012:mfa/user).

    \n

    The regex used to validate this parameter is a string of characters \n consisting of upper- and lower-case alphanumeric characters with no spaces. You can \n also include underscores or any of the following characters: =,.@-

    " } } } @@ -175,17 +178,17 @@ "smithy.api#documentation": "

    The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.

    \n \n

    The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

    \n     " } }, - "AssumedRoleUser": { - "target": "com.amazonaws.sts#AssumedRoleUser", - "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.

    " - } - }, "PackedPolicySize": { "target": "com.amazonaws.sts#nonNegativeIntegerType", "traits": { "smithy.api#documentation": "

    A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.

    " } + }, + "AssumedRoleUser": { + "target": "com.amazonaws.sts#AssumedRoleUser", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.

    " + } } }, "traits": { @@ -227,10 +230,16 @@ "com.amazonaws.sts#AssumeRoleWithSAMLRequest": { "type": "structure", "members": { - "PrincipalArn": { + "Policy": { + "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "traits": { + "smithy.api#documentation": "

    An IAM policy in JSON format that you want to use as an inline session policy.

    \n

    This parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    \n

    The plain text that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

    \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     " + } + }, + "RoleArn": { "target": "com.amazonaws.sts#arnType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the\n IdP.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the role that the caller is assuming.

    ", "smithy.api#required": {} } }, @@ -240,16 +249,10 @@ "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.

    \n

    This parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plain text that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS\n Service Namespaces in the AWS General Reference.

    \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    " } }, - "Policy": { - "target": "com.amazonaws.sts#sessionPolicyDocumentType", - "traits": { - "smithy.api#documentation": "

    An IAM policy in JSON format that you want to use as an inline session policy.

    \n

    This parameter is optional. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    \n

    The plain text that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

    \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     " - } - }, - "RoleArn": { + "PrincipalArn": { "target": "com.amazonaws.sts#arnType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the role that the caller is assuming.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the\n IdP.

    ", "smithy.api#required": {} } }, @@ -271,16 +274,22 @@ "com.amazonaws.sts#AssumeRoleWithSAMLResponse": { "type": "structure", "members": { - "Audience": { - "target": "com.amazonaws.sts#Audience", + "AssumedRoleUser": { + "target": "com.amazonaws.sts#AssumedRoleUser", "traits": { - "smithy.api#documentation": "

    The value of the Recipient attribute of the\n SubjectConfirmationData element of the SAML assertion.

    " + "smithy.api#documentation": "

    The identifiers for the temporary security credentials that the operation\n returns.

    " } }, - "PackedPolicySize": { - "target": "com.amazonaws.sts#nonNegativeIntegerType", + "Credentials": { + "target": "com.amazonaws.sts#Credentials", "traits": { - "smithy.api#documentation": "

    A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.

    " + "smithy.api#documentation": "

    The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.

    \n \n

    The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

    \n     " + } + }, + "Subject": { + "target": "com.amazonaws.sts#Subject", + "traits": { + "smithy.api#documentation": "

    The value of the NameID element in the Subject element of the\n SAML assertion.

    " } }, "SubjectType": { @@ -289,10 +298,10 @@ "smithy.api#documentation": "

    The format of the name ID, as defined by the Format attribute in the\n NameID element of the SAML assertion. Typical examples of the format are\n transient or persistent.

    \n

    If the format includes the prefix\n urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For\n example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as\n transient. If the format includes any other prefix, the format is returned\n with no modifications.

    " } }, - "AssumedRoleUser": { - "target": "com.amazonaws.sts#AssumedRoleUser", + "NameQualifier": { + "target": "com.amazonaws.sts#NameQualifier", "traits": { - "smithy.api#documentation": "

    The identifiers for the temporary security credentials that the operation\n returns.

    " + "smithy.api#documentation": "

    A hash value based on the concatenation of the Issuer response value, the\n AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in\n IAM. The combination of NameQualifier and Subject can be used\n to uniquely identify a federated user.

    \n

    The following pseudocode shows how the hash value is calculated:

    \n

    \n BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )\n

    " } }, "Issuer": { @@ -301,22 +310,16 @@ "smithy.api#documentation": "

    The value of the Issuer element of the SAML assertion.

    " } }, - "NameQualifier": { - "target": "com.amazonaws.sts#NameQualifier", - "traits": { - "smithy.api#documentation": "

    A hash value based on the concatenation of the Issuer response value, the\n AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in\n IAM. The combination of NameQualifier and Subject can be used\n to uniquely identify a federated user.

    \n

    The following pseudocode shows how the hash value is calculated:

    \n

    \n BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )\n

    " - } - }, - "Credentials": { - "target": "com.amazonaws.sts#Credentials", + "Audience": { + "target": "com.amazonaws.sts#Audience", "traits": { - "smithy.api#documentation": "

    The temporary security credentials, which include an access key ID, a secret access key,\n and a security (or session) token.

    \n \n

    The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

    \n     " + "smithy.api#documentation": "

    The value of the Recipient attribute of the\n SubjectConfirmationData element of the SAML assertion.

    " } }, - "Subject": { - "target": "com.amazonaws.sts#Subject", + "PackedPolicySize": { + "target": "com.amazonaws.sts#nonNegativeIntegerType", "traits": { - "smithy.api#documentation": "

    The value of the NameID element in the Subject element of the\n SAML assertion.

    " + "smithy.api#documentation": "

    A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.

    " } } }, @@ -356,19 +359,25 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include Amazon Cognito,\n Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity\n provider.

    \n \n

    For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.

    \n

    To learn more about Amazon Cognito, see Amazon Cognito Overview in\n AWS SDK for Android Developer Guide and Amazon Cognito Overview in the\n AWS SDK for iOS Developer Guide.

    \n     \n

    Calling AssumeRoleWithWebIdentity does not require the use of AWS\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term AWS\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term AWS credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n AWS STS API operations in the IAM User Guide.

    \n

    The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to AWS service API operations.

    \n

    \n Session Duration\n

    \n

    By default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.

    \n

    \n Permissions\n

    \n

    The temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any AWS service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.

    \n

    (Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plain text that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    \n

    \n Tags\n

    \n

    (Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

    \n

    You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, the session tag overrides the role tag with the same key.

    \n

    An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

    \n

    You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

    \n

    \n Identities\n

    \n

    Before your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.

    \n \n

    Calling AssumeRoleWithWebIdentity can result in an entry in your\n AWS CloudTrail logs. The entry includes the Subject of\n the provided Web Identity Token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.

    \n     \n

    For more information about how to use web identity federation and the\n AssumeRoleWithWebIdentity API, see the following resources:

    \n " + "smithy.api#documentation": "

    Returns a set of temporary security credentials for users who have been authenticated in\n a mobile or web application with a web identity provider. Example providers include Amazon Cognito,\n Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity\n provider.

    \n \n

    For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the\n AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely\n identify a user. You can also supply the user with a consistent identity throughout the\n lifetime of an application.

    \n

    To learn more about Amazon Cognito, see Amazon Cognito Overview in\n AWS SDK for Android Developer Guide and Amazon Cognito Overview in the\n AWS SDK for iOS Developer Guide.

    \n     \n

    Calling AssumeRoleWithWebIdentity does not require the use of AWS\n security credentials. Therefore, you can distribute an application (for example, on mobile\n devices) that requests temporary security credentials without including long-term AWS\n credentials in the application. You also don't need to deploy server-based proxy services\n that use long-term AWS credentials. Instead, the identity of the caller is validated by\n using a token from the web identity provider. For a comparison of\n AssumeRoleWithWebIdentity with the other API operations that produce\n temporary credentials, see Requesting Temporary Security\n Credentials and Comparing the\n AWS STS API operations in the IAM User Guide.

    \n

    The temporary security credentials returned by this API consist of an access key ID, a\n secret access key, and a security token. Applications can use these temporary security\n credentials to sign calls to AWS service API operations.

    \n

    \n Session Duration\n

    \n

    By default, the temporary security credentials created by\n AssumeRoleWithWebIdentity last for one hour. However, you can use the\n optional DurationSeconds parameter to specify the duration of your session.\n You can provide a value from 900 seconds (15 minutes) up to the maximum session duration\n setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how\n to view the maximum value for your role, see View the\n Maximum Session Duration Setting for a Role in the\n IAM User Guide. The maximum session duration limit applies when\n you use the AssumeRole* API operations or the assume-role* CLI\n commands. However the limit does not apply when you use those operations to create a\n console URL. For more information, see Using IAM Roles in the\n IAM User Guide.

    \n

    \n Permissions\n

    \n

    The temporary security credentials created by AssumeRoleWithWebIdentity can\n be used to make API calls to any AWS service with the following exception: you cannot\n call the STS GetFederationToken or GetSessionToken API\n operations.

    \n

    (Optional) You can pass inline or managed session policies to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plain text that you use for both inline and managed session policies can't exceed 2,048\n characters. Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    \n

    \n Tags\n

    \n

    (Optional) You can configure your IdP to pass attributes into your web identity token as\n session tags. Each session tag consists of a key name and an associated value. For more\n information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

    \n

    You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128\n characters and the values can’t exceed 256 characters. For these and additional limits, see\n IAM\n and STS Character Limits in the IAM User Guide.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    You can pass a session tag with the same key as a tag that is attached to the role. When\n you do, the session tag overrides the role tag with the same key.

    \n

    An administrator must grant you the permissions necessary to pass session tags. The\n administrator can also create granular permissions to allow you to pass only specific\n session tags. For more information, see Tutorial: Using Tags\n for Attribute-Based Access Control in the\n IAM User Guide.

    \n

    You can set the session tags as transitive. Transitive tags persist during role\n chaining. For more information, see Chaining Roles\n with Session Tags in the IAM User Guide.

    \n

    \n Identities\n

    \n

    Before your application can call AssumeRoleWithWebIdentity, you must have\n an identity token from a supported identity provider and create a role that the application\n can assume. The role that your application assumes must trust the identity provider that is\n associated with the identity token. In other words, the identity provider must be specified\n in the role's trust policy.

    \n \n

    Calling AssumeRoleWithWebIdentity can result in an entry in your\n AWS CloudTrail logs. The entry includes the Subject of\n the provided Web Identity Token. We recommend that you avoid using any personally\n identifiable information (PII) in this field. For example, you could instead use a GUID\n or a pairwise identifier, as suggested\n in the OIDC specification.

    \n     \n

    For more information about how to use web identity federation and the\n AssumeRoleWithWebIdentity API, see the following resources:

    \n " } }, "com.amazonaws.sts#AssumeRoleWithWebIdentityRequest": { "type": "structure", "members": { - "RoleArn": { - "target": "com.amazonaws.sts#arnType", + "WebIdentityToken": { + "target": "com.amazonaws.sts#clientTokenType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the role that the caller is assuming.

    ", + "smithy.api#documentation": "

    The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n provider. Your application must get this token by authenticating the user who is using your\n application with a web identity provider before the application makes an\n AssumeRoleWithWebIdentity call.

    ", "smithy.api#required": {} } }, + "ProviderId": { + "target": "com.amazonaws.sts#urlType", + "traits": { + "smithy.api#documentation": "

    The fully qualified host component of the domain name of the identity provider.

    \n

    Specify this value only for OAuth 2.0 access tokens. Currently\n www.amazon.com and graph.facebook.com are the only supported\n identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port\n numbers.

    \n

    Do not specify this value for OpenID Connect ID tokens.

    " + } + }, "Policy": { "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { @@ -382,6 +391,13 @@ "smithy.api#required": {} } }, + "RoleArn": { + "target": "com.amazonaws.sts#arnType", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the role that the caller is assuming.

    ", + "smithy.api#required": {} + } + }, "DurationSeconds": { "target": "com.amazonaws.sts#roleDurationSecondsType", "traits": { @@ -393,19 +409,6 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as\n managed session policies. The policies must exist in the same account as the role.

    \n

    This parameter is optional. You can provide up to 10 managed policy ARNs. However, the\n plain text that you use for both inline and managed session policies can't exceed 2,048\n characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS\n Service Namespaces in the AWS General Reference.

    \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    Passing policies to this operation returns new \n temporary credentials. The resulting session's permissions are the intersection of the \n role's identity-based policy and the session policies. You can use the role's temporary \n credentials in subsequent AWS API calls to access resources in the account that owns \n the role. You cannot use session policies to grant more permissions than those allowed \n by the identity-based policy of the role that is being assumed. For more information, see\n Session\n Policies in the IAM User Guide.

    " } - }, - "WebIdentityToken": { - "target": "com.amazonaws.sts#clientTokenType", - "traits": { - "smithy.api#documentation": "

    The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n provider. Your application must get this token by authenticating the user who is using your\n application with a web identity provider before the application makes an\n AssumeRoleWithWebIdentity call.

    ", - "smithy.api#required": {} - } - }, - "ProviderId": { - "target": "com.amazonaws.sts#urlType", - "traits": { - "smithy.api#documentation": "

    The fully qualified host component of the domain name of the identity provider.

    \n

    Specify this value only for OAuth 2.0 access tokens. Currently\n www.amazon.com and graph.facebook.com are the only supported\n identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port\n numbers.

    \n

    Do not specify this value for OpenID Connect ID tokens.

    " - } } } }, @@ -418,22 +421,22 @@ "smithy.api#documentation": "

    A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.

    " } }, - "Audience": { - "target": "com.amazonaws.sts#Audience", - "traits": { - "smithy.api#documentation": "

    The intended audience (also known as client ID) of the web identity token. This is\n traditionally the client identifier issued to the application that requested the web\n identity token.

    " - } - }, "Provider": { "target": "com.amazonaws.sts#Issuer", "traits": { "smithy.api#documentation": "

    The issuing authority of the web identity token presented. For OpenID Connect ID\n tokens, this contains the value of the iss field. For OAuth 2.0 access tokens,\n this contains the value of the ProviderId parameter that was passed in the\n AssumeRoleWithWebIdentity request.

    " } }, - "AssumedRoleUser": { - "target": "com.amazonaws.sts#AssumedRoleUser", + "Audience": { + "target": "com.amazonaws.sts#Audience", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.

    " + "smithy.api#documentation": "

    The intended audience (also known as client ID) of the web identity token. This is\n traditionally the client identifier issued to the application that requested the web\n identity token.

    " + } + }, + "SubjectFromWebIdentityToken": { + "target": "com.amazonaws.sts#webIdentitySubjectType", + "traits": { + "smithy.api#documentation": "

    The unique user identifier that is returned by the identity provider. This identifier is\n associated with the WebIdentityToken that was submitted with the\n AssumeRoleWithWebIdentity call. The identifier is typically unique to the\n user and the application that acquired the WebIdentityToken (pairwise\n identifier). For OpenID Connect ID tokens, this field contains the value returned by the\n identity provider as the token's sub (Subject) claim.

    " } }, "Credentials": { @@ -442,10 +445,10 @@ "smithy.api#documentation": "

    The temporary security credentials, which include an access key ID, a secret access key,\n and a security token.

    \n \n

    The size of the security token that STS API operations return is not fixed. We\n strongly recommend that you make no assumptions about the maximum size.

    \n     " } }, - "SubjectFromWebIdentityToken": { - "target": "com.amazonaws.sts#webIdentitySubjectType", + "AssumedRoleUser": { + "target": "com.amazonaws.sts#AssumedRoleUser", "traits": { - "smithy.api#documentation": "

    The unique user identifier that is returned by the identity provider. This identifier is\n associated with the WebIdentityToken that was submitted with the\n AssumeRoleWithWebIdentity call. The identifier is typically unique to the\n user and the application that acquired the WebIdentityToken (pairwise\n identifier). For OpenID Connect ID tokens, this field contains the value returned by the\n identity provider as the token's sub (Subject) claim.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you\n can use to refer to the resulting temporary security credentials. For example, you can\n reference these credentials as a principal in a resource-based policy by using the ARN or\n assumed role ID. The ARN and ID include the RoleSessionName that you specified\n when you called AssumeRole.

    " } } }, @@ -481,6 +484,13 @@ "com.amazonaws.sts#Credentials": { "type": "structure", "members": { + "Expiration": { + "target": "com.amazonaws.sts#dateType", + "traits": { + "smithy.api#documentation": "

    The date on which the current credentials expire.

    ", + "smithy.api#required": {} + } + }, "AccessKeyId": { "target": "com.amazonaws.sts#accessKeyIdType", "traits": { @@ -501,13 +511,6 @@ "smithy.api#documentation": "

    The secret access key that can be used to sign requests.

    ", "smithy.api#required": {} } - }, - "Expiration": { - "target": "com.amazonaws.sts#dateType", - "traits": { - "smithy.api#documentation": "

    The date on which the current credentials expire.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -573,17 +576,17 @@ "com.amazonaws.sts#FederatedUser": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.sts#arnType", + "FederatedUserId": { + "target": "com.amazonaws.sts#federatedIdType", "traits": { - "smithy.api#documentation": "

    The ARN that specifies the federated user that is associated with the credentials. For\n more information about ARNs and how to use them in policies, see IAM\n Identifiers in the IAM User Guide.

    ", + "smithy.api#documentation": "

    The string that identifies the federated user associated with the credentials, similar\n to the unique ID of an IAM user.

    ", "smithy.api#required": {} } }, - "FederatedUserId": { - "target": "com.amazonaws.sts#federatedIdType", + "Arn": { + "target": "com.amazonaws.sts#arnType", "traits": { - "smithy.api#documentation": "

    The string that identifies the federated user associated with the credentials, similar\n to the unique ID of an IAM user.

    ", + "smithy.api#documentation": "

    The ARN that specifies the federated user that is associated with the credentials. For\n more information about ARNs and how to use them in policies, see IAM\n Identifiers in the IAM User Guide.

    ", "smithy.api#required": {} } } @@ -652,17 +655,17 @@ "smithy.api#documentation": "

    The AWS ARN associated with the calling entity.

    " } }, - "Account": { - "target": "com.amazonaws.sts#accountType", - "traits": { - "smithy.api#documentation": "

    The AWS account ID number of the account that owns or contains the calling\n entity.

    " - } - }, "UserId": { "target": "com.amazonaws.sts#userIdType", "traits": { "smithy.api#documentation": "

    The unique identifier of the calling entity. The exact value depends on the type of\n entity that is making the call. The values returned are those listed in the aws:userid column in the Principal\n table found on the Policy Variables reference\n page in the IAM User Guide.

    " } + }, + "Account": { + "target": "com.amazonaws.sts#accountType", + "traits": { + "smithy.api#documentation": "

    The AWS account ID number of the account that owns or contains the calling\n entity.

    " + } } }, "traits": { @@ -695,10 +698,16 @@ "com.amazonaws.sts#GetFederationTokenRequest": { "type": "structure", "members": { - "DurationSeconds": { - "target": "com.amazonaws.sts#durationSecondsType", + "Policy": { + "target": "com.amazonaws.sts#sessionPolicyDocumentType", "traits": { - "smithy.api#documentation": "

    The duration, in seconds, that the session should last. Acceptable durations for\n federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with\n 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user\n credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified\n duration is longer than one hour, the session obtained by using root user credentials\n defaults to one hour.

    " + "smithy.api#documentation": "

    An IAM policy in JSON format that you want to use as an inline session policy.

    \n

    You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session\n policies.

    \n

    This parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.

    \n

    When you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you a way to further\n restrict the permissions for a federated user. You cannot use session policies to grant\n more permissions than those that are defined in the permissions policy of the IAM user.\n For more information, see Session Policies in\n the IAM User Guide.

    \n

    The resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.

    \n

    The plain text that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

    \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     " + } + }, + "Tags": { + "target": "com.amazonaws.sts#tagListType", + "traits": { + "smithy.api#documentation": "

    A list of session tags. Each session tag consists of a key name and an associated value.\n For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

    \n

    This parameter is optional. You can pass up to 50 session tags. The plain text session\n tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    You can pass a session tag with the same key as a tag that is already attached to the\n user you are federating. When you do, session tags override a user tag with the same key.

    \n

    Tag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.

    " } }, "Name": { @@ -714,16 +723,10 @@ "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a\n managed session policy. The policies must exist in the same account as the IAM user that\n is requesting federated access.

    \n

    You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session policies.\n The plain text that you use for both inline and managed session policies can't exceed 2,048\n characters. You can provide up to 10 managed policy ARNs. For more information about ARNs,\n see Amazon\n Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    \n

    This parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.

    \n

    When you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you a way to further\n restrict the permissions for a federated user. You cannot use session policies to grant\n more permissions than those that are defined in the permissions policy of the IAM user.\n For more information, see Session Policies in\n the IAM User Guide.

    \n

    The resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.

    \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     " } }, - "Tags": { - "target": "com.amazonaws.sts#tagListType", - "traits": { - "smithy.api#documentation": "

    A list of session tags. Each session tag consists of a key name and an associated value.\n For more information about session tags, see Passing Session Tags in STS in the\n IAM User Guide.

    \n

    This parameter is optional. You can pass up to 50 session tags. The plain text session\n tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these\n and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

    \n \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     \n \n

    You can pass a session tag with the same key as a tag that is already attached to the\n user you are federating. When you do, session tags override a user tag with the same key.

    \n

    Tag key–value pairs are not case sensitive, but case is preserved. This means that you\n cannot have separate Department and department tag keys. Assume\n that the role has the Department=Marketing tag and you pass the\n department=engineering session tag. Department\n and department are not saved as separate tags, and the session tag passed in\n the request takes precedence over the role tag.

    " - } - }, - "Policy": { - "target": "com.amazonaws.sts#sessionPolicyDocumentType", + "DurationSeconds": { + "target": "com.amazonaws.sts#durationSecondsType", "traits": { - "smithy.api#documentation": "

    An IAM policy in JSON format that you want to use as an inline session policy.

    \n

    You must pass an inline or managed session policy to\n this operation. You can pass a single JSON policy document to use as an inline session\n policy. You can also specify up to 10 managed policies to use as managed session\n policies.

    \n

    This parameter is optional. However, if you do not pass any session policies, then the\n resulting federated user session has no permissions.

    \n

    When you pass session policies, the session permissions are the intersection of the\n IAM user policies and the session policies that you pass. This gives you a way to further\n restrict the permissions for a federated user. You cannot use session policies to grant\n more permissions than those that are defined in the permissions policy of the IAM user.\n For more information, see Session Policies in\n the IAM User Guide.

    \n

    The resulting credentials can be used to access a resource that has a resource-based\n policy. If that policy specifically references the federated user session in the\n Principal element of the policy, the session has the permissions allowed by\n the policy. These permissions are granted in addition to the permissions that are granted\n by the session policies.

    \n

    The plain text that you use for both inline and managed session policies can't exceed\n 2,048 characters. The JSON policy characters can be any ASCII character from the space\n character to the end of the valid character list (\\u0020 through \\u00FF). It can also\n include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D)\n characters.

    \n \n

    An AWS conversion compresses the passed session policies and session tags into a\n packed binary format that has a separate limit. Your request can fail for this limit\n even if your plain text meets the other requirements. The PackedPolicySize\n response element indicates by percentage how close the policies and tags for your\n request are to the upper size limit.\n

    \n     " + "smithy.api#documentation": "

    The duration, in seconds, that the session should last. Acceptable durations for\n federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with\n 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user\n credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified\n duration is longer than one hour, the session obtained by using root user credentials\n defaults to one hour.

    " } } } @@ -731,12 +734,6 @@ "com.amazonaws.sts#GetFederationTokenResponse": { "type": "structure", "members": { - "FederatedUser": { - "target": "com.amazonaws.sts#FederatedUser", - "traits": { - "smithy.api#documentation": "

    Identifiers for the federated user associated with the credentials (such as\n arn:aws:sts::123456789012:federated-user/Bob or\n 123456789012:Bob). You can use the federated user's ARN in your\n resource-based policies, such as an Amazon S3 bucket policy.

    " - } - }, "Credentials": { "target": "com.amazonaws.sts#Credentials", "traits": { @@ -748,6 +745,12 @@ "traits": { "smithy.api#documentation": "

    A percentage value that indicates the packed size of the session policies and session \n tags combined passed in the request. The request fails if the packed size is greater than 100 percent, \n which means the policies and tags exceeded the allowed space.

    " } + }, + "FederatedUser": { + "target": "com.amazonaws.sts#FederatedUser", + "traits": { + "smithy.api#documentation": "

    Identifiers for the federated user associated with the credentials (such as\n arn:aws:sts::123456789012:federated-user/Bob or\n 123456789012:Bob). You can use the federated user's ARN in your\n resource-based policies, such as an Amazon S3 bucket policy.

    " + } } }, "traits": { @@ -774,10 +777,10 @@ "com.amazonaws.sts#GetSessionTokenRequest": { "type": "structure", "members": { - "TokenCode": { - "target": "com.amazonaws.sts#tokenCodeType", + "SerialNumber": { + "target": "com.amazonaws.sts#serialNumberType", "traits": { - "smithy.api#documentation": "

    The value provided by the MFA device, if MFA is required. If any policy requires the\n IAM user to submit an MFA code, specify this value. If MFA authentication is required,\n the user must provide a code when requesting a set of temporary security credentials. A\n user who fails to provide the code receives an \"access denied\" response when requesting\n resources that require MFA authentication.

    \n

    The format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.

    " + "smithy.api#documentation": "

    The identification number of the MFA device that is associated with the IAM user who\n is making the GetSessionToken call. Specify this value if the IAM user has a\n policy that requires MFA authentication. The value is either the serial number for a\n hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a\n virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the\n device for an IAM user by going to the AWS Management Console and viewing the user's security\n credentials.

    \n

    The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-

    " } }, "DurationSeconds": { @@ -786,10 +789,10 @@ "smithy.api#documentation": "

    The duration, in seconds, that the credentials should remain valid. Acceptable durations\n for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours),\n with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are\n restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one\n hour, the session for AWS account owners defaults to one hour.

    " } }, - "SerialNumber": { - "target": "com.amazonaws.sts#serialNumberType", + "TokenCode": { + "target": "com.amazonaws.sts#tokenCodeType", "traits": { - "smithy.api#documentation": "

    The identification number of the MFA device that is associated with the IAM user who\n is making the GetSessionToken call. Specify this value if the IAM user has a\n policy that requires MFA authentication. The value is either the serial number for a\n hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a\n virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the\n device for an IAM user by going to the AWS Management Console and viewing the user's security\n credentials.

    \n

    The regex used to validate this parameter is a string of \n characters consisting of upper- and lower-case alphanumeric characters with no spaces. \n You can also include underscores or any of the following characters: =,.@:/-

    " + "smithy.api#documentation": "

    The value provided by the MFA device, if MFA is required. If any policy requires the\n IAM user to submit an MFA code, specify this value. If MFA authentication is required,\n the user must provide a code when requesting a set of temporary security credentials. A\n user who fails to provide the code receives an \"access denied\" response when requesting\n resources that require MFA authentication.

    \n

    The format for this parameter, as described by its regex pattern, is a sequence of six\n numeric digits.

    " } } } @@ -925,8 +928,7 @@ "smithy.api#length": { "min": 4, "max": 100000 - }, - "smithy.api#sensitive": {} + } } }, "com.amazonaws.sts#Subject": { @@ -938,17 +940,17 @@ "com.amazonaws.sts#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.sts#tagValueType", + "Key": { + "target": "com.amazonaws.sts#tagKeyType", "traits": { - "smithy.api#documentation": "

    The value for a session tag.

    \n

    You can pass up to 50 session tags. The plain text session tag values can’t exceed 256\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

    ", + "smithy.api#documentation": "

    The key for a session tag.

    \n

    You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

    ", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.sts#tagKeyType", + "Value": { + "target": "com.amazonaws.sts#tagValueType", "traits": { - "smithy.api#documentation": "

    The key for a session tag.

    \n

    You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

    ", + "smithy.api#documentation": "

    The value for a session tag.

    \n

    You can pass up to 50 session tags. The plain text session tag values can’t exceed 256\n characters. For these and additional limits, see IAM\n and STS Character Limits in the IAM User Guide.

    ", "smithy.api#required": {} } } @@ -999,8 +1001,7 @@ "smithy.api#length": { "min": 4, "max": 2048 - }, - "smithy.api#sensitive": {} + } } }, "com.amazonaws.sts#dateType": { diff --git a/codegen/sdk-codegen/aws-models/support.2013-04-15.json b/codegen/sdk-codegen/aws-models/support.2013-04-15.json index 1ee0ff24cfb5..376715aa253e 100644 --- a/codegen/sdk-codegen/aws-models/support.2013-04-15.json +++ b/codegen/sdk-codegen/aws-models/support.2013-04-15.json @@ -81,7 +81,7 @@ "sdkId": "Support", "arnNamespace": "support", "cloudFormationName": "Support", - "cloudTrailEventSource": "v20121215.awssupportapi.amazonaws.com" + "cloudTrailEventSource": "support.amazonaws.com" }, "aws.auth#sigv4": { "name": "support" @@ -126,18 +126,18 @@ "com.amazonaws.support#AddAttachmentsToSetRequest": { "type": "structure", "members": { + "attachmentSetId": { + "target": "com.amazonaws.support#AttachmentSetId", + "traits": { + "smithy.api#documentation": "

    The ID of the attachment set. If an attachmentSetId is not specified, a\n new attachment set is created, and the ID of the set is returned in the response. If an\n attachmentSetId is specified, the attachments are added to the\n specified set, if it exists.

    " + } + }, "attachments": { "target": "com.amazonaws.support#Attachments", "traits": { "smithy.api#documentation": "

    One or more attachments to add to the set. You can add up to three attachments per\n set. The size limit is 5 MB per attachment.

    \n

    In the Attachment object, use the data parameter to specify\n the contents of the attachment file. In the previous request syntax, the value for\n data appear as blob, which is represented as a\n base64-encoded string. The value for fileName is the name of the\n attachment, such as troubleshoot-screenshot.png.

    ", "smithy.api#required": {} } - }, - "attachmentSetId": { - "target": "com.amazonaws.support#AttachmentSetId", - "traits": { - "smithy.api#documentation": "

    The ID of the attachment set. If an attachmentSetId is not specified, a\n new attachment set is created, and the ID of the set is returned in the response. If an\n attachmentSetId is specified, the attachments are added to the\n specified set, if it exists.

    " - } } } }, @@ -190,12 +190,6 @@ "com.amazonaws.support#AddCommunicationToCaseRequest": { "type": "structure", "members": { - "ccEmailAddresses": { - "target": "com.amazonaws.support#CcEmailAddressList", - "traits": { - "smithy.api#documentation": "

    The email addresses in the CC line of an email to be added to the support case.

    " - } - }, "attachmentSetId": { "target": "com.amazonaws.support#AttachmentSetId", "traits": { @@ -209,6 +203,12 @@ "smithy.api#required": {} } }, + "ccEmailAddresses": { + "target": "com.amazonaws.support#CcEmailAddressList", + "traits": { + "smithy.api#documentation": "

    The email addresses in the CC line of an email to be added to the support case.

    " + } + }, "caseId": { "target": "com.amazonaws.support#CaseId", "traits": { @@ -257,17 +257,17 @@ "com.amazonaws.support#AttachmentDetails": { "type": "structure", "members": { - "fileName": { - "target": "com.amazonaws.support#FileName", - "traits": { - "smithy.api#documentation": "

    The file name of the attachment.

    " - } - }, "attachmentId": { "target": "com.amazonaws.support#AttachmentId", "traits": { "smithy.api#documentation": "

    The ID of the attachment.

    " } + }, + "fileName": { + "target": "com.amazonaws.support#FileName", + "traits": { + "smithy.api#documentation": "

    The file name of the attachment.

    " + } } }, "traits": { @@ -391,34 +391,22 @@ "com.amazonaws.support#CaseDetails": { "type": "structure", "members": { - "ccEmailAddresses": { - "target": "com.amazonaws.support#CcEmailAddressList", - "traits": { - "smithy.api#documentation": "

    The email addresses that receive copies of communication about the case.

    " - } - }, - "status": { - "target": "com.amazonaws.support#Status", - "traits": { - "smithy.api#documentation": "

    The status of the case.

    \n

    Valid values:

    \n
      \n
    • \n

      \n opened\n

      \n
      • \n
    • \n

      \n pending-customer-action\n

      \n
      • \n
    • \n

      \n reopened\n

      \n
      • \n
    • \n

      \n resolved\n

      \n
      • \n
    • \n

      \n unassigned\n

      \n
      • \n
    • \n

      \n work-in-progress\n

      \n
      • \n
    " - } - }, "serviceCode": { "target": "com.amazonaws.support#ServiceCode", "traits": { "smithy.api#documentation": "

    The code for the AWS service. You can get a list of codes and the corresponding\n service names by calling DescribeServices.

    " } }, - "categoryCode": { - "target": "com.amazonaws.support#CategoryCode", + "displayId": { + "target": "com.amazonaws.support#DisplayId", "traits": { - "smithy.api#documentation": "

    The category of problem for the AWS Support case.

    " + "smithy.api#documentation": "

    The ID displayed for the case in the AWS Support Center. This is a numeric\n string.

    " } }, - "timeCreated": { - "target": "com.amazonaws.support#TimeCreated", + "categoryCode": { + "target": "com.amazonaws.support#CategoryCode", "traits": { - "smithy.api#documentation": "

    The time that the case was created in the AWS Support Center.

    " + "smithy.api#documentation": "

    The category of problem for the AWS Support case.

    " } }, "severityCode": { @@ -427,10 +415,10 @@ "smithy.api#documentation": "

    The code for the severity level returned by the call to DescribeSeverityLevels.

    " } }, - "language": { - "target": "com.amazonaws.support#Language", + "timeCreated": { + "target": "com.amazonaws.support#TimeCreated", "traits": { - "smithy.api#documentation": "

    The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.

    " + "smithy.api#documentation": "

    The time that the case was created in the AWS Support Center.

    " } }, "caseId": { @@ -439,16 +427,16 @@ "smithy.api#documentation": "

    The AWS Support case ID requested or returned in the call. The case ID is an\n alphanumeric string formatted as shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47\n

    " } }, - "submittedBy": { - "target": "com.amazonaws.support#SubmittedBy", + "ccEmailAddresses": { + "target": "com.amazonaws.support#CcEmailAddressList", "traits": { - "smithy.api#documentation": "

    The email address of the account that submitted the case.

    " + "smithy.api#documentation": "

    The email addresses that receive copies of communication about the case.

    " } }, - "recentCommunications": { - "target": "com.amazonaws.support#RecentCaseCommunications", + "language": { + "target": "com.amazonaws.support#Language", "traits": { - "smithy.api#documentation": "

    The five most recent communications between you and AWS Support Center, including the\n IDs of any attachments to the communications. Also includes a nextToken\n that you can use to retrieve earlier communications.

    " + "smithy.api#documentation": "

    The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.

    " } }, "subject": { @@ -457,10 +445,22 @@ "smithy.api#documentation": "

    The subject line for the case in the AWS Support Center.

    " } }, - "displayId": { - "target": "com.amazonaws.support#DisplayId", + "submittedBy": { + "target": "com.amazonaws.support#SubmittedBy", "traits": { - "smithy.api#documentation": "

    The ID displayed for the case in the AWS Support Center. This is a numeric\n string.

    " + "smithy.api#documentation": "

    The email address of the account that submitted the case.

    " + } + }, + "status": { + "target": "com.amazonaws.support#Status", + "traits": { + "smithy.api#documentation": "

    The status of the case.

    \n

    Valid values:

    \n
      \n
    • \n

      \n opened\n

      \n
      • \n
    • \n

      \n pending-customer-action\n

      \n
      • \n
    • \n

      \n reopened\n

      \n
      • \n
    • \n

      \n resolved\n

      \n
      • \n
    • \n

      \n unassigned\n

      \n
      • \n
    • \n

      \n work-in-progress\n

      \n
      • \n
    " + } + }, + "recentCommunications": { + "target": "com.amazonaws.support#RecentCaseCommunications", + "traits": { + "smithy.api#documentation": "

    The five most recent communications between you and AWS Support Center, including the\n IDs of any attachments to the communications. Also includes a nextToken\n that you can use to retrieve earlier communications.

    " } } }, @@ -510,17 +510,17 @@ "com.amazonaws.support#Category": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.support#CategoryName", - "traits": { - "smithy.api#documentation": "

    The category name for the support case.

    " - } - }, "code": { "target": "com.amazonaws.support#CategoryCode", "traits": { "smithy.api#documentation": "

    The category code for the support case.

    " } + }, + "name": { + "target": "com.amazonaws.support#CategoryName", + "traits": { + "smithy.api#documentation": "

    The category name for the support case.

    " + } } }, "traits": { @@ -557,18 +557,6 @@ "smithy.api#documentation": "

    Information about the attachments to the case communication.

    " } }, - "timeCreated": { - "target": "com.amazonaws.support#TimeCreated", - "traits": { - "smithy.api#documentation": "

    The time the communication was created.

    " - } - }, - "body": { - "target": "com.amazonaws.support#CommunicationBody", - "traits": { - "smithy.api#documentation": "

    The text of the communication between the customer and AWS Support.

    " - } - }, "submittedBy": { "target": "com.amazonaws.support#SubmittedBy", "traits": { @@ -580,6 +568,18 @@ "traits": { "smithy.api#documentation": "

    The AWS Support case ID requested or returned in the call. The case ID is an\n alphanumeric string formatted as shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47\n

    " } + }, + "timeCreated": { + "target": "com.amazonaws.support#TimeCreated", + "traits": { + "smithy.api#documentation": "

    The time the communication was created.

    " + } + }, + "body": { + "target": "com.amazonaws.support#CommunicationBody", + "traits": { + "smithy.api#documentation": "

    The text of the communication between the customer and AWS Support.

    " + } } }, "traits": { @@ -624,36 +624,12 @@ "com.amazonaws.support#CreateCaseRequest": { "type": "structure", "members": { - "severityCode": { - "target": "com.amazonaws.support#SeverityCode", - "traits": { - "smithy.api#documentation": "

    A value that indicates the urgency of the case. This value determines the response\n time according to your service level agreement with AWS Support. You can use the DescribeSeverityLevels operation to get the possible values for\n severityCode.

    \n

    For more information, see SeverityLevel and Choosing a\n Severity in the AWS Support User Guide.

    \n \n

    The availability of severity levels depends on the support plan for the AWS\n account.

    \n     " - } - }, - "categoryCode": { - "target": "com.amazonaws.support#CategoryCode", - "traits": { - "smithy.api#documentation": "

    The category of problem for the AWS Support case. You also use the DescribeServices operation to get the category code for a service. Each\n AWS service defines its own set of category codes.

    " - } - }, - "serviceCode": { - "target": "com.amazonaws.support#ServiceCode", - "traits": { - "smithy.api#documentation": "

    The code for the AWS service. You can use the DescribeServices\n operation to get the possible serviceCode values.

    " - } - }, "issueType": { "target": "com.amazonaws.support#IssueType", "traits": { "smithy.api#documentation": "

    The type of issue for the case. You can specify customer-service or\n technical. If you don't specify a value, the default is\n technical.

    " } }, - "ccEmailAddresses": { - "target": "com.amazonaws.support#CcEmailAddressList", - "traits": { - "smithy.api#documentation": "

    A list of email addresses that AWS Support copies on case correspondence. AWS Support\n identifies the account that creates the case when you specify your AWS credentials in an\n HTTP POST method or use the AWS SDKs.\n

    " - } - }, "subject": { "target": "com.amazonaws.support#Subject", "traits": { @@ -679,6 +655,30 @@ "traits": { "smithy.api#documentation": "

    The ID of a set of one or more attachments for the case. Create the set by using the\n AddAttachmentsToSet operation.

    " } + }, + "ccEmailAddresses": { + "target": "com.amazonaws.support#CcEmailAddressList", + "traits": { + "smithy.api#documentation": "

    A list of email addresses that AWS Support copies on case correspondence. AWS Support\n identifies the account that creates the case when you specify your AWS credentials in an\n HTTP POST method or use the AWS SDKs.\n

    " + } + }, + "serviceCode": { + "target": "com.amazonaws.support#ServiceCode", + "traits": { + "smithy.api#documentation": "

    The code for the AWS service. You can use the DescribeServices\n operation to get the possible serviceCode values.

    " + } + }, + "severityCode": { + "target": "com.amazonaws.support#SeverityCode", + "traits": { + "smithy.api#documentation": "

    A value that indicates the urgency of the case. This value determines the response\n time according to your service level agreement with AWS Support. You can use the DescribeSeverityLevels operation to get the possible values for\n severityCode.

    \n

    For more information, see SeverityLevel and Choosing a\n Severity in the AWS Support User Guide.

    \n \n

    The availability of severity levels depends on the support plan for the AWS\n account.

    \n     " + } + }, + "categoryCode": { + "target": "com.amazonaws.support#CategoryCode", + "traits": { + "smithy.api#documentation": "

    The category of problem for the AWS Support case. You also use the DescribeServices operation to get the category code for a service. Each\n AWS service defines its own set of category codes.

    " + } } } }, @@ -780,34 +780,34 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of cases that you specify by passing one or more case IDs. You can use\n the afterTime and beforeTime parameters to filter the cases by\n date. You can set values for the includeResolvedCases and\n includeCommunications parameters to specify how much information to\n return.

    \n

    The response returns the following in JSON format:

    \n
      \n
    • \n

      One or more CaseDetails data types.

      \n
      • \n
    • \n

      One or more nextToken values, which specify where to paginate the\n returned records represented by the CaseDetails objects.

      \n
      • \n
    \n

    Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request might return an error.

    \n \n
      \n
    • \n

      You must have a Business or Enterprise support plan to use the AWS Support\n API.

      \n
      • \n
    • \n

      If you call the AWS Support API from an account that does not have a\n Business or Enterprise support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

      \n
      • \n
    \n     " + "smithy.api#documentation": "

    Returns a list of cases that you specify by passing one or more case IDs. You can use\n the afterTime and beforeTime parameters to filter the cases by\n date. You can set values for the includeResolvedCases and\n includeCommunications parameters to specify how much information to\n return.

    \n

    The response returns the following in JSON format:

    \n
      \n
    • \n

      One or more CaseDetails data types.

      \n
      • \n
    • \n

      One or more nextToken values, which specify where to paginate the\n returned records represented by the CaseDetails objects.

      \n
      • \n
    \n

    Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request might return an error.

    \n \n
      \n
    • \n

      You must have a Business or Enterprise support plan to use the AWS Support\n API.

      \n
      • \n
    • \n

      If you call the AWS Support API from an account that does not have a\n Business or Enterprise support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

      \n
      • \n
    \n     ", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "cases", + "pageSize": "maxResults" + } } }, "com.amazonaws.support#DescribeCasesRequest": { "type": "structure", "members": { - "includeResolvedCases": { - "target": "com.amazonaws.support#IncludeResolvedCases", - "traits": { - "smithy.api#documentation": "

    Specifies whether to include resolved support cases in the DescribeCases\n response. By default, resolved cases aren't included.

    " - } - }, - "caseIdList": { - "target": "com.amazonaws.support#CaseIdList", - "traits": { - "smithy.api#documentation": "

    A list of ID numbers of the support cases you want returned. The maximum number of\n cases is 100.

    " - } - }, "nextToken": { "target": "com.amazonaws.support#NextToken", "traits": { "smithy.api#documentation": "

    A resumption point for pagination.

    " } }, - "maxResults": { - "target": "com.amazonaws.support#MaxResults", + "displayId": { + "target": "com.amazonaws.support#DisplayId", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return before paginating.

    " + "smithy.api#documentation": "

    The ID displayed for a case in the AWS Support Center user interface.

    " + } + }, + "includeCommunications": { + "target": "com.amazonaws.support#IncludeCommunications", + "traits": { + "smithy.api#documentation": "

    Specifies whether to include communications in the DescribeCases\n response. By default, communications are incuded.

    " } }, "beforeTime": { @@ -816,16 +816,22 @@ "smithy.api#documentation": "

    The end date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.

    " } }, - "displayId": { - "target": "com.amazonaws.support#DisplayId", + "caseIdList": { + "target": "com.amazonaws.support#CaseIdList", "traits": { - "smithy.api#documentation": "

    The ID displayed for a case in the AWS Support Center user interface.

    " + "smithy.api#documentation": "

    A list of ID numbers of the support cases you want returned. The maximum number of\n cases is 100.

    " } }, - "includeCommunications": { - "target": "com.amazonaws.support#IncludeCommunications", + "includeResolvedCases": { + "target": "com.amazonaws.support#IncludeResolvedCases", "traits": { - "smithy.api#documentation": "

    Specifies whether to include communications in the DescribeCases\n response. By default, communications are incuded.

    " + "smithy.api#documentation": "

    Specifies whether to include resolved support cases in the DescribeCases\n response. By default, resolved cases aren't included.

    " + } + }, + "maxResults": { + "target": "com.amazonaws.support#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return before paginating.

    " } }, "afterTime": { @@ -845,17 +851,17 @@ "com.amazonaws.support#DescribeCasesResponse": { "type": "structure", "members": { - "cases": { - "target": "com.amazonaws.support#CaseList", - "traits": { - "smithy.api#documentation": "

    The details for the cases that match the request.

    " - } - }, "nextToken": { "target": "com.amazonaws.support#NextToken", "traits": { "smithy.api#documentation": "

    A resumption point for pagination.

    " } + }, + "cases": { + "target": "com.amazonaws.support#CaseList", + "traits": { + "smithy.api#documentation": "

    The details for the cases that match the request.

    " + } } }, "traits": { @@ -879,12 +885,24 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns communications and attachments for one or more support cases. Use the\n afterTime and beforeTime parameters to filter by date. You\n can use the caseId parameter to restrict the results to a specific\n case.

    \n

    Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request for data might cause an error.

    \n

    You can use the maxResults and nextToken parameters to\n control the pagination of the results. Set maxResults to the number of\n cases that you want to display on each page, and use nextToken to specify\n the resumption of pagination.

    \n \n
      \n
    • \n

      You must have a Business or Enterprise support plan to use the AWS Support\n API.

      \n
      • \n
    • \n

      If you call the AWS Support API from an account that does not have a\n Business or Enterprise support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

      \n
      • \n
    \n     " + "smithy.api#documentation": "

    Returns communications and attachments for one or more support cases. Use the\n afterTime and beforeTime parameters to filter by date. You\n can use the caseId parameter to restrict the results to a specific\n case.

    \n

    Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request for data might cause an error.

    \n

    You can use the maxResults and nextToken parameters to\n control the pagination of the results. Set maxResults to the number of\n cases that you want to display on each page, and use nextToken to specify\n the resumption of pagination.

    \n \n
      \n
    • \n

      You must have a Business or Enterprise support plan to use the AWS Support\n API.

      \n
      • \n
    • \n

      If you call the AWS Support API from an account that does not have a\n Business or Enterprise support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

      \n
      • \n
    \n     ", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "communications", + "pageSize": "maxResults" + } } }, "com.amazonaws.support#DescribeCommunicationsRequest": { "type": "structure", "members": { + "maxResults": { + "target": "com.amazonaws.support#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return before paginating.

    " + } + }, "caseId": { "target": "com.amazonaws.support#CaseId", "traits": { @@ -892,29 +910,23 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.support#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return before paginating.

    " - } - }, "afterTime": { "target": "com.amazonaws.support#AfterTime", "traits": { "smithy.api#documentation": "

    The start date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.

    " } }, - "beforeTime": { - "target": "com.amazonaws.support#BeforeTime", - "traits": { - "smithy.api#documentation": "

    The end date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.

    " - } - }, "nextToken": { "target": "com.amazonaws.support#NextToken", "traits": { "smithy.api#documentation": "

    A resumption point for pagination.

    " } + }, + "beforeTime": { + "target": "com.amazonaws.support#BeforeTime", + "traits": { + "smithy.api#documentation": "

    The end date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.

    " + } } } }, @@ -1092,17 +1104,17 @@ "com.amazonaws.support#DescribeTrustedAdvisorCheckResultRequest": { "type": "structure", "members": { - "checkId": { + "language": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.

    " } }, - "language": { + "checkId": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.

    " + "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", + "smithy.api#required": {} } } }, @@ -1397,6 +1409,12 @@ "com.amazonaws.support#Service": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.support#ServiceName", + "traits": { + "smithy.api#documentation": "

    The friendly name for an AWS service. The code element contains the\n corresponding code.

    " + } + }, "categories": { "target": "com.amazonaws.support#CategoryList", "traits": { @@ -1408,12 +1426,6 @@ "traits": { "smithy.api#documentation": "

    The code for an AWS service returned by the DescribeServices\n response. The name element contains the corresponding friendly name.

    " } - }, - "name": { - "target": "com.amazonaws.support#ServiceName", - "traits": { - "smithy.api#documentation": "

    The friendly name for an AWS service. The code element contains the\n corresponding code.

    " - } } }, "traits": { @@ -1520,31 +1532,31 @@ "com.amazonaws.support#TrustedAdvisorCheckDescription": { "type": "structure", "members": { - "name": { + "category": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The display name for the Trusted Advisor check.

    ", + "smithy.api#documentation": "

    The category of the Trusted Advisor check.

    ", "smithy.api#required": {} } }, - "description": { + "id": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The description of the Trusted Advisor check, which includes the alert criteria and\n recommended operations (contains HTML markup).

    ", + "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", "smithy.api#required": {} } }, - "category": { + "name": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The category of the Trusted Advisor check.

    ", + "smithy.api#documentation": "

    The display name for the Trusted Advisor check.

    ", "smithy.api#required": {} } }, - "id": { + "description": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", + "smithy.api#documentation": "

    The description of the Trusted Advisor check, which includes the alert criteria and\n recommended operations (contains HTML markup).

    ", "smithy.api#required": {} } }, @@ -1576,17 +1588,17 @@ "smithy.api#required": {} } }, - "status": { + "checkId": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The status of the Trusted Advisor check for which a refresh has been requested:\n

    \n
      \n
    • \n

      \n none: The check is not refreshed or the non-success status\n exceeds the timeout

      \n
      • \n
    • \n

      \n enqueued: The check refresh requests has entered the refresh\n queue

      \n
      • \n
    • \n

      \n processing: The check refresh request is picked up by the rule\n processing engine

      \n
      • \n
    • \n

      \n success: The check is successfully refreshed

      \n
      • \n
    • \n

      \n abandoned: The check refresh has failed

      \n
      • \n
    ", + "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", "smithy.api#required": {} } }, - "checkId": { + "status": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", + "smithy.api#documentation": "

    The status of the Trusted Advisor check for which a refresh has been requested:\n

    \n
      \n
    • \n

      \n none: The check is not refreshed or the non-success status\n exceeds the timeout

      \n
      • \n
    • \n

      \n enqueued: The check refresh requests has entered the refresh\n queue

      \n
      • \n
    • \n

      \n processing: The check refresh request is picked up by the rule\n processing engine

      \n
      • \n
    • \n

      \n success: The check is successfully refreshed

      \n
      • \n
    • \n

      \n abandoned: The check refresh has failed

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -1604,10 +1616,10 @@ "com.amazonaws.support#TrustedAdvisorCheckResult": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.support#String", + "flaggedResources": { + "target": "com.amazonaws.support#TrustedAdvisorResourceDetailList", "traits": { - "smithy.api#documentation": "

    The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or\n \"not_available\".

    ", + "smithy.api#documentation": "

    The details about each resource listed in the check result.

    ", "smithy.api#required": {} } }, @@ -1617,31 +1629,31 @@ "smithy.api#required": {} } }, - "timestamp": { - "target": "com.amazonaws.support#String", + "categorySpecificSummary": { + "target": "com.amazonaws.support#TrustedAdvisorCategorySpecificSummary", "traits": { - "smithy.api#documentation": "

    The time of the last refresh of the check.

    ", + "smithy.api#documentation": "

    Summary information that relates to the category of the check. Cost Optimizing is the\n only category that is currently supported.

    ", "smithy.api#required": {} } }, - "flaggedResources": { - "target": "com.amazonaws.support#TrustedAdvisorResourceDetailList", + "timestamp": { + "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The details about each resource listed in the check result.

    ", + "smithy.api#documentation": "

    The time of the last refresh of the check.

    ", "smithy.api#required": {} } }, - "categorySpecificSummary": { - "target": "com.amazonaws.support#TrustedAdvisorCategorySpecificSummary", + "checkId": { + "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    Summary information that relates to the category of the check. Cost Optimizing is the\n only category that is currently supported.

    ", + "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", "smithy.api#required": {} } }, - "checkId": { + "status": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", + "smithy.api#documentation": "

    The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or\n \"not_available\".

    ", "smithy.api#required": {} } } @@ -1653,37 +1665,37 @@ "com.amazonaws.support#TrustedAdvisorCheckSummary": { "type": "structure", "members": { - "checkId": { - "target": "com.amazonaws.support#String", + "categorySpecificSummary": { + "target": "com.amazonaws.support#TrustedAdvisorCategorySpecificSummary", "traits": { - "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", + "smithy.api#documentation": "

    Summary information that relates to the category of the check. Cost Optimizing is the\n only category that is currently supported.

    ", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.support#String", + "resourcesSummary": { + "target": "com.amazonaws.support#TrustedAdvisorResourcesSummary", "traits": { - "smithy.api#documentation": "

    The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or\n \"not_available\".

    ", "smithy.api#required": {} } }, - "resourcesSummary": { - "target": "com.amazonaws.support#TrustedAdvisorResourcesSummary", + "timestamp": { + "target": "com.amazonaws.support#String", "traits": { + "smithy.api#documentation": "

    The time of the last refresh of the check.

    ", "smithy.api#required": {} } }, - "categorySpecificSummary": { - "target": "com.amazonaws.support#TrustedAdvisorCategorySpecificSummary", + "checkId": { + "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    Summary information that relates to the category of the check. Cost Optimizing is the\n only category that is currently supported.

    ", + "smithy.api#documentation": "

    The unique identifier for the Trusted Advisor check.

    ", "smithy.api#required": {} } }, - "timestamp": { + "status": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The time of the last refresh of the check.

    ", + "smithy.api#documentation": "

    The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or\n \"not_available\".

    ", "smithy.api#required": {} } }, @@ -1707,17 +1719,17 @@ "com.amazonaws.support#TrustedAdvisorCostOptimizingSummary": { "type": "structure", "members": { - "estimatedMonthlySavings": { + "estimatedPercentMonthlySavings": { "target": "com.amazonaws.support#Double", "traits": { - "smithy.api#documentation": "

    The estimated monthly savings that might be realized if the recommended operations are\n taken.

    ", + "smithy.api#documentation": "

    The estimated percentage of savings that might be realized if the recommended\n operations are taken.

    ", "smithy.api#required": {} } }, - "estimatedPercentMonthlySavings": { + "estimatedMonthlySavings": { "target": "com.amazonaws.support#Double", "traits": { - "smithy.api#documentation": "

    The estimated percentage of savings that might be realized if the recommended\n operations are taken.

    ", + "smithy.api#documentation": "

    The estimated monthly savings that might be realized if the recommended operations are\n taken.

    ", "smithy.api#required": {} } } @@ -1729,16 +1741,17 @@ "com.amazonaws.support#TrustedAdvisorResourceDetail": { "type": "structure", "members": { - "region": { + "resourceId": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The AWS region in which the identified resource is located.

    " + "smithy.api#documentation": "

    The unique identifier for the identified resource.

    ", + "smithy.api#required": {} } }, - "resourceId": { - "target": "com.amazonaws.support#String", + "metadata": { + "target": "com.amazonaws.support#StringList", "traits": { - "smithy.api#documentation": "

    The unique identifier for the identified resource.

    ", + "smithy.api#documentation": "

    Additional information about the identified resource. The exact metadata and its order\n can be obtained by inspecting the TrustedAdvisorCheckDescription\n object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel\n download, even in those cases where the UI shows just summary data.

    ", "smithy.api#required": {} } }, @@ -1748,17 +1761,16 @@ "smithy.api#documentation": "

    Specifies whether the AWS resource was ignored by Trusted Advisor because it was\n marked as suppressed by the user.

    " } }, - "status": { + "region": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    The status code for the resource identified in the Trusted Advisor check.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The AWS region in which the identified resource is located.

    " } }, - "metadata": { - "target": "com.amazonaws.support#StringList", + "status": { + "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

    Additional information about the identified resource. The exact metadata and its order\n can be obtained by inspecting the TrustedAdvisorCheckDescription\n object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel\n download, even in those cases where the UI shows just summary data.

    ", + "smithy.api#documentation": "

    The status code for the resource identified in the Trusted Advisor check.

    ", "smithy.api#required": {} } } @@ -1783,17 +1795,17 @@ "smithy.api#required": {} } }, - "resourcesProcessed": { + "resourcesIgnored": { "target": "com.amazonaws.support#Long", "traits": { - "smithy.api#documentation": "

    The number of AWS resources that were analyzed by the Trusted Advisor check.

    ", + "smithy.api#documentation": "

    The number of AWS resources ignored by Trusted Advisor because information was\n unavailable.

    ", "smithy.api#required": {} } }, - "resourcesIgnored": { + "resourcesProcessed": { "target": "com.amazonaws.support#Long", "traits": { - "smithy.api#documentation": "

    The number of AWS resources ignored by Trusted Advisor because information was\n unavailable.

    ", + "smithy.api#documentation": "

    The number of AWS resources that were analyzed by the Trusted Advisor check.

    ", "smithy.api#required": {} } }, 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 d6f56d2928a1..a479147d66e2 100644 --- a/codegen/sdk-codegen/aws-models/swf.2012-01-25.json +++ b/codegen/sdk-codegen/aws-models/swf.2012-01-25.json @@ -41,30 +41,23 @@ "com.amazonaws.swf#ActivityTask": { "type": "structure", "members": { - "activityId": { - "target": "com.amazonaws.swf#ActivityId", - "traits": { - "smithy.api#documentation": "

    The unique ID of the task.

    ", - "smithy.api#required": {} - } - }, "input": { "target": "com.amazonaws.swf#Data", "traits": { "smithy.api#documentation": "

    The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

    " } }, - "workflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "activityId": { + "target": "com.amazonaws.swf#ActivityId", "traits": { - "smithy.api#documentation": "

    The workflow execution that started this activity task.

    ", + "smithy.api#documentation": "

    The unique ID of the task.

    ", "smithy.api#required": {} } }, - "startedEventId": { - "target": "com.amazonaws.swf#EventId", + "taskToken": { + "target": "com.amazonaws.swf#TaskToken", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded in the history.

    ", + "smithy.api#documentation": "

    The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

    ", "smithy.api#required": {} } }, @@ -75,10 +68,17 @@ "smithy.api#required": {} } }, - "taskToken": { - "target": "com.amazonaws.swf#TaskToken", + "workflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", "traits": { - "smithy.api#documentation": "

    The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

    ", + "smithy.api#documentation": "

    The workflow execution that started this activity task.

    ", + "smithy.api#required": {} + } + }, + "startedEventId": { + "target": "com.amazonaws.swf#EventId", + "traits": { + "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded in the history.

    ", "smithy.api#required": {} } } @@ -112,17 +112,18 @@ "com.amazonaws.swf#ActivityTaskCanceledEventAttributes": { "type": "structure", "members": { - "scheduledEventId": { + "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", "smithy.api#required": {} } }, - "latestCancelRequestedEventId": { + "scheduledEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + "smithy.api#documentation": "

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", + "smithy.api#required": {} } }, "details": { @@ -131,11 +132,10 @@ "smithy.api#documentation": "

    Details of the cancellation.

    " } }, - "startedEventId": { + "latestCancelRequestedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " } } }, @@ -146,10 +146,10 @@ "com.amazonaws.swf#ActivityTaskCompletedEventAttributes": { "type": "structure", "members": { - "scheduledEventId": { + "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", "smithy.api#required": {} } }, @@ -159,10 +159,10 @@ "smithy.api#documentation": "

    The results of the activity task.

    " } }, - "startedEventId": { + "scheduledEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", + "smithy.api#documentation": "

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", "smithy.api#required": {} } } @@ -174,10 +174,16 @@ "com.amazonaws.swf#ActivityTaskFailedEventAttributes": { "type": "structure", "members": { - "startedEventId": { + "details": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The details of the failure.

    " + } + }, + "scheduledEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", + "smithy.api#documentation": "

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", "smithy.api#required": {} } }, @@ -187,18 +193,12 @@ "smithy.api#documentation": "

    The reason provided for the failure.

    " } }, - "scheduledEventId": { + "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", "smithy.api#required": {} } - }, - "details": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    The details of the failure.

    " - } } }, "traits": { @@ -208,37 +208,35 @@ "com.amazonaws.swf#ActivityTaskScheduledEventAttributes": { "type": "structure", "members": { - "taskPriority": { - "target": "com.amazonaws.swf#TaskPriority", + "taskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    \n The priority to assign to the scheduled activity task. If set, this overrides any default\n priority value that was assigned when the activity type was registered.

    \n

    Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + "smithy.api#documentation": "

    The task list in which the activity task has been scheduled.

    ", + "smithy.api#required": {} } }, - "control": { - "target": "com.amazonaws.swf#Data", + "scheduleToStartTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

    " + "smithy.api#documentation": "

    The maximum amount of time the activity task can wait to be assigned to a worker.

    " } }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", + "heartbeatTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The task list in which the activity task has been scheduled.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The maximum time before which the worker processing this task must report progress by calling\n RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If\n the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

    " } }, - "activityType": { - "target": "com.amazonaws.swf#ActivityType", + "scheduleToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The type of the activity task.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The maximum amount of time for this activity task.

    " } }, - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", + "taskPriority": { + "target": "com.amazonaws.swf#TaskPriority", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    \n The priority to assign to the scheduled activity task. If set, this overrides any default\n priority value that was assigned when the activity type was registered.

    \n

    Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " } }, "startToCloseTimeout": { @@ -260,22 +258,24 @@ "smithy.api#required": {} } }, - "heartbeatTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "activityType": { + "target": "com.amazonaws.swf#ActivityType", "traits": { - "smithy.api#documentation": "

    The maximum time before which the worker processing this task must report progress by calling\n RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If\n the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

    " + "smithy.api#documentation": "

    The type of the activity task.

    ", + "smithy.api#required": {} } }, - "scheduleToStartTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The maximum amount of time the activity task can wait to be assigned to a worker.

    " + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    ", + "smithy.api#required": {} } }, - "scheduleToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "control": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The maximum amount of time for this activity task.

    " + "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

    " } } }, @@ -322,13 +322,19 @@ "com.amazonaws.swf#ActivityTaskTimedOutEventAttributes": { "type": "structure", "members": { - "startedEventId": { - "target": "com.amazonaws.swf#EventId", + "timeoutType": { + "target": "com.amazonaws.swf#ActivityTaskTimeoutType", "traits": { - "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", + "smithy.api#documentation": "

    The type of the timeout that caused this event.

    ", "smithy.api#required": {} } }, + "details": { + "target": "com.amazonaws.swf#LimitedData", + "traits": { + "smithy.api#documentation": "

    Contains the content of the details parameter for the last call made by the activity to\n RecordActivityTaskHeartbeat.

    " + } + }, "scheduledEventId": { "target": "com.amazonaws.swf#EventId", "traits": { @@ -336,16 +342,10 @@ "smithy.api#required": {} } }, - "details": { - "target": "com.amazonaws.swf#LimitedData", - "traits": { - "smithy.api#documentation": "

    Contains the content of the details parameter for the last call made by the activity to\n RecordActivityTaskHeartbeat.

    " - } - }, - "timeoutType": { - "target": "com.amazonaws.swf#ActivityTaskTimeoutType", + "startedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The type of the timeout that caused this event.

    ", + "smithy.api#documentation": "

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", "smithy.api#required": {} } } @@ -404,10 +404,16 @@ "smithy.api#documentation": "

    \n The default maximum time, in seconds, before which a worker processing a task must report\n progress by calling RecordActivityTaskHeartbeat.

    \n

    You can specify this value only when registering an activity type. The registered default value can be\n overridden when you schedule a task through the ScheduleActivityTask \n Decision. If the activity\n worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an\n UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid;\n the activity worker should clean up the activity task.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, - "defaultTaskStartToCloseTimeout": { + "defaultTaskPriority": { + "target": "com.amazonaws.swf#TaskPriority", + "traits": { + "smithy.api#documentation": "

    \n The default task priority for tasks of this activity type, specified at registration. If not\n set, then 0 is used as the default priority. This default can be overridden when scheduling an activity\n task.

    \n

    Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + } + }, + "defaultTaskScheduleToCloseTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    \n The default maximum duration for tasks of an activity type specified when registering the activity\n type. You can override this default when scheduling a task through the ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    \n The default maximum duration, specified when registering the activity type, for tasks of this activity\n type. You can override this default when scheduling a task through the ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, "defaultTaskList": { @@ -422,16 +428,10 @@ "smithy.api#documentation": "

    \n The default maximum duration, specified when registering the activity type, that a task of an\n activity type can wait before being assigned to a worker. You can override this default when scheduling a task\n through the ScheduleActivityTask \n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, - "defaultTaskScheduleToCloseTimeout": { + "defaultTaskStartToCloseTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    \n The default maximum duration, specified when registering the activity type, for tasks of this activity\n type. You can override this default when scheduling a task through the ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " - } - }, - "defaultTaskPriority": { - "target": "com.amazonaws.swf#TaskPriority", - "traits": { - "smithy.api#documentation": "

    \n The default task priority for tasks of this activity type, specified at registration. If not\n set, then 0 is used as the default priority. This default can be overridden when scheduling an activity\n task.

    \n

    Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + "smithy.api#documentation": "

    \n The default maximum duration for tasks of an activity type specified when registering the activity\n type. You can override this default when scheduling a task through the ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } } }, @@ -442,17 +442,17 @@ "com.amazonaws.swf#ActivityTypeDetail": { "type": "structure", "members": { - "typeInfo": { - "target": "com.amazonaws.swf#ActivityTypeInfo", + "configuration": { + "target": "com.amazonaws.swf#ActivityTypeConfiguration", "traits": { - "smithy.api#documentation": "

    General information about the activity type.

    \n

    The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

    \n
      \n
    • \n

      \n REGISTERED – The type is registered and available. Workers supporting this\n type should be running.\n

      \n
      • \n
    • \n

      \n DEPRECATED – The type was deprecated using DeprecateActivityType, but is\n still in use. You should keep workers supporting this type running.\n You cannot create new tasks of this type.\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The configuration settings registered with the activity type.

    ", "smithy.api#required": {} } }, - "configuration": { - "target": "com.amazonaws.swf#ActivityTypeConfiguration", + "typeInfo": { + "target": "com.amazonaws.swf#ActivityTypeInfo", "traits": { - "smithy.api#documentation": "

    The configuration settings registered with the activity type.

    ", + "smithy.api#documentation": "

    General information about the activity type.

    \n

    The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

    \n
      \n
    • \n

      \n REGISTERED – The type is registered and available. Workers supporting this\n type should be running.\n

      \n
      • \n
    • \n

      \n DEPRECATED – The type was deprecated using DeprecateActivityType, but is\n still in use. You should keep workers supporting this type running.\n You cannot create new tasks of this type.\n

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -470,17 +470,18 @@ "smithy.api#documentation": "

    The description of the activity type provided in RegisterActivityType.

    " } }, - "status": { - "target": "com.amazonaws.swf#RegistrationStatus", + "creationDate": { + "target": "com.amazonaws.swf#Timestamp", "traits": { - "smithy.api#documentation": "

    The current status of the activity type.

    ", + "smithy.api#documentation": "

    The date and time this activity type was created through RegisterActivityType.

    ", "smithy.api#required": {} } }, - "deprecationDate": { - "target": "com.amazonaws.swf#Timestamp", + "status": { + "target": "com.amazonaws.swf#RegistrationStatus", "traits": { - "smithy.api#documentation": "

    If DEPRECATED, the date and time DeprecateActivityType was called.

    " + "smithy.api#documentation": "

    The current status of the activity type.

    ", + "smithy.api#required": {} } }, "activityType": { @@ -490,11 +491,10 @@ "smithy.api#required": {} } }, - "creationDate": { + "deprecationDate": { "target": "com.amazonaws.swf#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time this activity type was created through RegisterActivityType.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If DEPRECATED, the date and time DeprecateActivityType was called.

    " } } }, @@ -569,10 +569,10 @@ "com.amazonaws.swf#CancelTimerFailedEventAttributes": { "type": "structure", "members": { - "cause": { - "target": "com.amazonaws.swf#CancelTimerFailedCause", + "timerId": { + "target": "com.amazonaws.swf#TimerId", "traits": { - "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", + "smithy.api#documentation": "

    The timerId provided in the CancelTimer decision that failed.

    ", "smithy.api#required": {} } }, @@ -583,10 +583,10 @@ "smithy.api#required": {} } }, - "timerId": { - "target": "com.amazonaws.swf#TimerId", + "cause": { + "target": "com.amazonaws.swf#CancelTimerFailedCause", "traits": { - "smithy.api#documentation": "

    The timerId provided in the CancelTimer decision that failed.

    ", + "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", "smithy.api#required": {} } } @@ -682,23 +682,16 @@ "smithy.api#required": {} } }, - "initiatedEventId": { - "target": "com.amazonaws.swf#EventId", - "traits": { - "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", - "smithy.api#required": {} - } - }, "details": { "target": "com.amazonaws.swf#Data", "traits": { "smithy.api#documentation": "

    Details of the cancellation (if provided).

    " } }, - "workflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "initiatedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The child workflow execution that was canceled.

    ", + "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, @@ -708,6 +701,13 @@ "smithy.api#documentation": "

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was\n started. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } + }, + "workflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", + "traits": { + "smithy.api#documentation": "

    The child workflow execution that was canceled.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -717,13 +717,6 @@ "com.amazonaws.swf#ChildWorkflowExecutionCompletedEventAttributes": { "type": "structure", "members": { - "startedEventId": { - "target": "com.amazonaws.swf#EventId", - "traits": { - "smithy.api#documentation": "

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was\n started. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", - "smithy.api#required": {} - } - }, "workflowType": { "target": "com.amazonaws.swf#WorkflowType", "traits": { @@ -731,10 +724,10 @@ "smithy.api#required": {} } }, - "workflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "startedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The child workflow execution that was completed.

    ", + "smithy.api#documentation": "

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was\n started. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, @@ -745,6 +738,13 @@ "smithy.api#required": {} } }, + "workflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", + "traits": { + "smithy.api#documentation": "

    The child workflow execution that was completed.

    ", + "smithy.api#required": {} + } + }, "result": { "target": "com.amazonaws.swf#Data", "traits": { @@ -766,17 +766,17 @@ "smithy.api#required": {} } }, - "workflowType": { - "target": "com.amazonaws.swf#WorkflowType", + "initiatedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The type of the child workflow execution.

    ", + "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "initiatedEventId": { - "target": "com.amazonaws.swf#EventId", + "workflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", "traits": { - "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The child workflow execution that failed.

    ", "smithy.api#required": {} } }, @@ -786,17 +786,17 @@ "smithy.api#documentation": "

    The reason for the failure (if provided).

    " } }, - "details": { - "target": "com.amazonaws.swf#Data", + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", "traits": { - "smithy.api#documentation": "

    The details of the failure (if provided).

    " + "smithy.api#documentation": "

    The type of the child workflow execution.

    ", + "smithy.api#required": {} } }, - "workflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "details": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The child workflow execution that failed.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The details of the failure (if provided).

    " } } }, @@ -807,13 +807,6 @@ "com.amazonaws.swf#ChildWorkflowExecutionStartedEventAttributes": { "type": "structure", "members": { - "workflowType": { - "target": "com.amazonaws.swf#WorkflowType", - "traits": { - "smithy.api#documentation": "

    The type of the child workflow execution.

    ", - "smithy.api#required": {} - } - }, "workflowExecution": { "target": "com.amazonaws.swf#WorkflowExecution", "traits": { @@ -827,6 +820,13 @@ "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } + }, + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", + "traits": { + "smithy.api#documentation": "

    The type of the child workflow execution.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -843,10 +843,10 @@ "smithy.api#required": {} } }, - "initiatedEventId": { + "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was\n started. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, @@ -857,10 +857,10 @@ "smithy.api#required": {} } }, - "startedEventId": { + "initiatedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was\n started. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } } @@ -872,6 +872,13 @@ "com.amazonaws.swf#ChildWorkflowExecutionTimedOutEventAttributes": { "type": "structure", "members": { + "timeoutType": { + "target": "com.amazonaws.swf#WorkflowExecutionTimeoutType", + "traits": { + "smithy.api#documentation": "

    The type of the timeout that caused the child workflow execution to time out.

    ", + "smithy.api#required": {} + } + }, "initiatedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { @@ -879,10 +886,10 @@ "smithy.api#required": {} } }, - "timeoutType": { - "target": "com.amazonaws.swf#WorkflowExecutionTimeoutType", + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", "traits": { - "smithy.api#documentation": "

    The type of the timeout that caused the child workflow execution to time out.

    ", + "smithy.api#documentation": "

    The type of the child workflow execution.

    ", "smithy.api#required": {} } }, @@ -899,13 +906,6 @@ "smithy.api#documentation": "

    The child workflow execution that timed out.

    ", "smithy.api#required": {} } - }, - "workflowType": { - "target": "com.amazonaws.swf#WorkflowType", - "traits": { - "smithy.api#documentation": "

    The type of the child workflow execution.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -1004,10 +1004,10 @@ "com.amazonaws.swf#ContinueAsNewWorkflowExecutionDecisionAttributes": { "type": "structure", "members": { - "tagList": { - "target": "com.amazonaws.swf#TagList", + "lambdaRole": { + "target": "com.amazonaws.swf#Arn", "traits": { - "smithy.api#documentation": "

    The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can\n list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or\n ListClosedWorkflowExecutions and specifying a TagFilter.

    " + "smithy.api#documentation": "

    The IAM role to attach to the new (continued) execution.

    " } }, "input": { @@ -1016,16 +1016,10 @@ "smithy.api#documentation": "

    The input provided to the new workflow execution.

    " } }, - "lambdaRole": { - "target": "com.amazonaws.swf#Arn", - "traits": { - "smithy.api#documentation": "

    The IAM role to attach to the new (continued) execution.

    " - } - }, - "executionStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "childPolicy": { + "target": "com.amazonaws.swf#ChildPolicy", "traits": { - "smithy.api#documentation": "

    If set, specifies the total duration for this workflow execution. This overrides the\n defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

    \n     " + "smithy.api#documentation": "

    If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy\n overrides the default child policy specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    \n \n

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    \n     " } }, "workflowTypeVersion": { @@ -1040,22 +1034,28 @@ "smithy.api#documentation": "

    \n The task priority that, if set, specifies the priority for the decision tasks for this workflow\n execution. This overrides the defaultTaskPriority specified when registering the workflow type.\n Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " } }, + "taskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", + "traits": { + "smithy.api#documentation": "

    Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the\n defaultTaskStartToCloseTimout specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    \n     " + } + }, "taskList": { "target": "com.amazonaws.swf#TaskList", "traits": { "smithy.api#documentation": "

    The task list to use for the decisions of the new (continued) workflow\n execution.

    " } }, - "taskStartToCloseTimeout": { + "executionStartToCloseTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the\n defaultTaskStartToCloseTimout specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    \n     " + "smithy.api#documentation": "

    If set, specifies the total duration for this workflow execution. This overrides the\n defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

    \n     " } }, - "childPolicy": { - "target": "com.amazonaws.swf#ChildPolicy", + "tagList": { + "target": "com.amazonaws.swf#TagList", "traits": { - "smithy.api#documentation": "

    If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy\n overrides the default child policy specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    \n \n

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    \n     " + "smithy.api#documentation": "

    The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can\n list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or\n ListClosedWorkflowExecutions and specifying a TagFilter.

    " } } }, @@ -1156,41 +1156,41 @@ "smithy.api#documentation": "

    If specified, only workflow executions that meet the start time criteria of the filter\n are counted.

    \n \n

    \n startTimeFilter and closeTimeFilter are mutually exclusive. You\n must specify one of these in a request but not both.

    \n     " } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", - "traits": { - "smithy.api#documentation": "

    The name of the domain containing the workflow executions to count.

    ", - "smithy.api#required": {} - } - }, "executionFilter": { "target": "com.amazonaws.swf#WorkflowExecutionFilter", "traits": { "smithy.api#documentation": "

    If specified, only workflow executions matching the WorkflowId in the\n filter are counted.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " } }, - "typeFilter": { - "target": "com.amazonaws.swf#WorkflowTypeFilter", - "traits": { - "smithy.api#documentation": "

    If specified, indicates the type of the workflow executions to be counted.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " - } - }, "closeTimeFilter": { "target": "com.amazonaws.swf#ExecutionTimeFilter", "traits": { "smithy.api#documentation": "

    If specified, only workflow executions that meet the close time criteria of the filter\n are counted.

    \n \n

    \n startTimeFilter and closeTimeFilter are mutually exclusive. You\n must specify one of these in a request but not both.

    \n     " } }, + "closeStatusFilter": { + "target": "com.amazonaws.swf#CloseStatusFilter", + "traits": { + "smithy.api#documentation": "

    If specified, only workflow executions that match this close status are counted. This\n filter has an affect only if executionStatus is specified as\n CLOSED.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " + } + }, "tagFilter": { "target": "com.amazonaws.swf#TagFilter", "traits": { "smithy.api#documentation": "

    If specified, only executions that have a tag that matches the filter are\n counted.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " } }, - "closeStatusFilter": { - "target": "com.amazonaws.swf#CloseStatusFilter", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    If specified, only workflow executions that match this close status are counted. This\n filter has an affect only if executionStatus is specified as\n CLOSED.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " + "smithy.api#documentation": "

    The name of the domain containing the workflow executions to count.

    ", + "smithy.api#required": {} + } + }, + "typeFilter": { + "target": "com.amazonaws.swf#WorkflowTypeFilter", + "traits": { + "smithy.api#documentation": "

    If specified, indicates the type of the workflow executions to be counted.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " } } } @@ -1218,6 +1218,12 @@ "com.amazonaws.swf#CountOpenWorkflowExecutionsInput": { "type": "structure", "members": { + "typeFilter": { + "target": "com.amazonaws.swf#WorkflowTypeFilter", + "traits": { + "smithy.api#documentation": "

    Specifies the type of the workflow executions to be counted.

    \n \n

    \n executionFilter, typeFilter and tagFilter are\n mutually exclusive. You can specify at most one of these in a request.

    \n     " + } + }, "executionFilter": { "target": "com.amazonaws.swf#WorkflowExecutionFilter", "traits": { @@ -1243,12 +1249,6 @@ "traits": { "smithy.api#documentation": "

    If specified, only executions that have a tag that matches the filter are\n counted.

    \n \n

    \n executionFilter, typeFilter and tagFilter are\n mutually exclusive. You can specify at most one of these in a request.

    \n     " } - }, - "typeFilter": { - "target": "com.amazonaws.swf#WorkflowTypeFilter", - "traits": { - "smithy.api#documentation": "

    Specifies the type of the workflow executions to be counted.

    \n \n

    \n executionFilter, typeFilter and tagFilter are\n mutually exclusive. You can specify at most one of these in a request.

    \n     " - } } } }, @@ -1275,17 +1275,17 @@ "com.amazonaws.swf#CountPendingActivityTasksInput": { "type": "structure", "members": { - "taskList": { - "target": "com.amazonaws.swf#TaskList", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The name of the task list.

    ", + "smithy.api#documentation": "

    The name of the domain that contains the task list.

    ", "smithy.api#required": {} } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", + "taskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    The name of the domain that contains the task list.

    ", + "smithy.api#documentation": "

    The name of the task list.

    ", "smithy.api#required": {} } } @@ -1342,35 +1342,35 @@ "com.amazonaws.swf#Decision": { "type": "structure", "members": { - "failWorkflowExecutionDecisionAttributes": { - "target": "com.amazonaws.swf#FailWorkflowExecutionDecisionAttributes", + "completeWorkflowExecutionDecisionAttributes": { + "target": "com.amazonaws.swf#CompleteWorkflowExecutionDecisionAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.

    " + "smithy.api#documentation": "

    Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.

    " } }, - "decisionType": { - "target": "com.amazonaws.swf#DecisionType", + "requestCancelExternalWorkflowExecutionDecisionAttributes": { + "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionDecisionAttributes", "traits": { - "smithy.api#documentation": "

    Specifies the type of the decision.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Provides the details of the RequestCancelExternalWorkflowExecution decision.\n It isn't set for other decision types.

    " } }, - "signalExternalWorkflowExecutionDecisionAttributes": { - "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionDecisionAttributes", + "startTimerDecisionAttributes": { + "target": "com.amazonaws.swf#StartTimerDecisionAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.

    " + "smithy.api#documentation": "

    Provides the details of the StartTimer decision. It isn't set for other decision types.

    " } }, - "cancelWorkflowExecutionDecisionAttributes": { - "target": "com.amazonaws.swf#CancelWorkflowExecutionDecisionAttributes", + "signalExternalWorkflowExecutionDecisionAttributes": { + "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionDecisionAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.

    " + "smithy.api#documentation": "

    Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.

    " } }, - "startChildWorkflowExecutionDecisionAttributes": { - "target": "com.amazonaws.swf#StartChildWorkflowExecutionDecisionAttributes", + "decisionType": { + "target": "com.amazonaws.swf#DecisionType", "traits": { - "smithy.api#documentation": "

    Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.

    " + "smithy.api#documentation": "

    Specifies the type of the decision.

    ", + "smithy.api#required": {} } }, "cancelTimerDecisionAttributes": { @@ -1385,10 +1385,10 @@ "smithy.api#documentation": "

    Provides the details of the ScheduleLambdaFunction decision. It isn't set\n for other decision types.

    " } }, - "continueAsNewWorkflowExecutionDecisionAttributes": { - "target": "com.amazonaws.swf#ContinueAsNewWorkflowExecutionDecisionAttributes", + "startChildWorkflowExecutionDecisionAttributes": { + "target": "com.amazonaws.swf#StartChildWorkflowExecutionDecisionAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.

    " + "smithy.api#documentation": "

    Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.

    " } }, "scheduleActivityTaskDecisionAttributes": { @@ -1403,16 +1403,10 @@ "smithy.api#documentation": "

    Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.

    " } }, - "completeWorkflowExecutionDecisionAttributes": { - "target": "com.amazonaws.swf#CompleteWorkflowExecutionDecisionAttributes", - "traits": { - "smithy.api#documentation": "

    Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.

    " - } - }, - "requestCancelExternalWorkflowExecutionDecisionAttributes": { - "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionDecisionAttributes", + "cancelWorkflowExecutionDecisionAttributes": { + "target": "com.amazonaws.swf#CancelWorkflowExecutionDecisionAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the RequestCancelExternalWorkflowExecution decision.\n It isn't set for other decision types.

    " + "smithy.api#documentation": "

    Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.

    " } }, "recordMarkerDecisionAttributes": { @@ -1421,10 +1415,16 @@ "smithy.api#documentation": "

    Provides the details of the RecordMarker decision. It isn't set for other decision types.

    " } }, - "startTimerDecisionAttributes": { - "target": "com.amazonaws.swf#StartTimerDecisionAttributes", + "failWorkflowExecutionDecisionAttributes": { + "target": "com.amazonaws.swf#FailWorkflowExecutionDecisionAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the StartTimer decision. It isn't set for other decision types.

    " + "smithy.api#documentation": "

    Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.

    " + } + }, + "continueAsNewWorkflowExecutionDecisionAttributes": { + "target": "com.amazonaws.swf#ContinueAsNewWorkflowExecutionDecisionAttributes", + "traits": { + "smithy.api#documentation": "

    Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.

    " } } }, @@ -1447,13 +1447,6 @@ "smithy.api#documentation": "

    The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

    " } }, - "workflowType": { - "target": "com.amazonaws.swf#WorkflowType", - "traits": { - "smithy.api#documentation": "

    The type of the workflow execution for which this decision task was created.

    ", - "smithy.api#required": {} - } - }, "taskToken": { "target": "com.amazonaws.swf#TaskToken", "traits": { @@ -1461,11 +1454,10 @@ "smithy.api#required": {} } }, - "events": { - "target": "com.amazonaws.swf#HistoryEventList", + "nextPageToken": { + "target": "com.amazonaws.swf#PageToken", "traits": { - "smithy.api#documentation": "

    A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If a NextPageToken was returned by a previous call, there are more\n results available. To retrieve the next page of results, make the call again using the returned token in\n nextPageToken. Keep all other arguments unchanged.

    \n

    The configured maximumPageSize determines how many results can be returned in a single call.

    " } }, "workflowExecution": { @@ -1475,6 +1467,13 @@ "smithy.api#required": {} } }, + "events": { + "target": "com.amazonaws.swf#HistoryEventList", + "traits": { + "smithy.api#documentation": "

    A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

    ", + "smithy.api#required": {} + } + }, "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { @@ -1482,10 +1481,11 @@ "smithy.api#required": {} } }, - "nextPageToken": { - "target": "com.amazonaws.swf#PageToken", + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", "traits": { - "smithy.api#documentation": "

    If a NextPageToken was returned by a previous call, there are more\n results available. To retrieve the next page of results, make the call again using the returned token in\n nextPageToken. Keep all other arguments unchanged.

    \n

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + "smithy.api#documentation": "

    The type of the workflow execution for which this decision task was created.

    ", + "smithy.api#required": {} } } }, @@ -1496,17 +1496,17 @@ "com.amazonaws.swf#DecisionTaskCompletedEventAttributes": { "type": "structure", "members": { - "startedEventId": { + "scheduledEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "scheduledEventId": { + "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, @@ -1530,18 +1530,18 @@ "smithy.api#documentation": "

    \n A task priority that, if set, specifies the priority for this decision task.\n Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " } }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", - "traits": { - "smithy.api#documentation": "

    The name of the task list in which the decision task was scheduled.

    ", - "smithy.api#required": {} - } - }, "startToCloseTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { "smithy.api#documentation": "

    The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } + }, + "taskList": { + "target": "com.amazonaws.swf#TaskList", + "traits": { + "smithy.api#documentation": "

    The name of the task list in which the decision task was scheduled.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -1579,17 +1579,17 @@ "smithy.api#required": {} } }, - "scheduledEventId": { + "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the DecisionTaskStarted event recorded when this decision task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", "smithy.api#required": {} } }, - "startedEventId": { + "scheduledEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskStarted event recorded when this decision task was started. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", + "smithy.api#documentation": "

    The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } } @@ -1689,17 +1689,17 @@ "com.amazonaws.swf#DeprecateActivityTypeInput": { "type": "structure", "members": { - "activityType": { - "target": "com.amazonaws.swf#ActivityType", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The activity type to deprecate.

    ", + "smithy.api#documentation": "

    The name of the domain in which the activity type is registered.

    ", "smithy.api#required": {} } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", + "activityType": { + "target": "com.amazonaws.swf#ActivityType", "traits": { - "smithy.api#documentation": "

    The name of the domain in which the activity type is registered.

    ", + "smithy.api#documentation": "

    The activity type to deprecate.

    ", "smithy.api#required": {} } } @@ -1799,17 +1799,17 @@ "com.amazonaws.swf#DescribeActivityTypeInput": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.swf#DomainName", + "activityType": { + "target": "com.amazonaws.swf#ActivityType", "traits": { - "smithy.api#documentation": "

    The name of the domain in which the activity type is registered.

    ", + "smithy.api#documentation": "

    The activity type to get information about. Activity types are identified by the\n name and version that were supplied when the activity was\n registered.

    ", "smithy.api#required": {} } }, - "activityType": { - "target": "com.amazonaws.swf#ActivityType", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The activity type to get information about. Activity types are identified by the\n name and version that were supplied when the activity was\n registered.

    ", + "smithy.api#documentation": "

    The name of the domain in which the activity type is registered.

    ", "smithy.api#required": {} } } @@ -1909,17 +1909,17 @@ "com.amazonaws.swf#DescribeWorkflowTypeInput": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.swf#DomainName", + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", "traits": { - "smithy.api#documentation": "

    The name of the domain in which this workflow type is registered.

    ", + "smithy.api#documentation": "

    The workflow type to describe.

    ", "smithy.api#required": {} } }, - "workflowType": { - "target": "com.amazonaws.swf#WorkflowType", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The workflow type to describe.

    ", + "smithy.api#documentation": "

    The name of the domain in which this workflow type is registered.

    ", "smithy.api#required": {} } } @@ -2011,10 +2011,11 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.swf#Description", + "name": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The description of the domain provided through RegisterDomain.

    " + "smithy.api#documentation": "

    The name of the domain. This name is unique within the account.

    ", + "smithy.api#required": {} } }, "arn": { @@ -2023,11 +2024,10 @@ "smithy.api#documentation": "

    The ARN of the domain.

    " } }, - "name": { - "target": "com.amazonaws.swf#DomainName", + "description": { + "target": "com.amazonaws.swf#Description", "traits": { - "smithy.api#documentation": "

    The name of the domain. This name is unique within the account.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The description of the domain provided through RegisterDomain.

    " } } }, @@ -2332,17 +2332,17 @@ "com.amazonaws.swf#ExternalWorkflowExecutionSignaledEventAttributes": { "type": "structure", "members": { - "workflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "initiatedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The external workflow execution that the signal was delivered to.

    ", + "smithy.api#documentation": "

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "initiatedEventId": { - "target": "com.amazonaws.swf#EventId", + "workflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", "traits": { - "smithy.api#documentation": "

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The external workflow execution that the signal was delivered to.

    ", "smithy.api#required": {} } } @@ -2354,17 +2354,17 @@ "com.amazonaws.swf#FailWorkflowExecutionDecisionAttributes": { "type": "structure", "members": { - "details": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    \n Details of the failure.

    " - } - }, "reason": { "target": "com.amazonaws.swf#FailureReason", "traits": { "smithy.api#documentation": "

    A descriptive reason for the failure that may help in diagnostics.

    " } + }, + "details": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    \n Details of the failure.

    " + } } }, "traits": { @@ -2471,19 +2471,6 @@ "com.amazonaws.swf#GetWorkflowExecutionHistoryInput": { "type": "structure", "members": { - "reverseOrder": { - "target": "com.amazonaws.swf#ReverseOrder", - "traits": { - "smithy.api#documentation": "

    When set to true, returns the events in reverse order. By default the\n results are returned in ascending order of the eventTimeStamp of the\n events.

    " - } - }, - "domain": { - "target": "com.amazonaws.swf#DomainName", - "traits": { - "smithy.api#documentation": "

    The name of the domain containing the workflow execution.

    ", - "smithy.api#required": {} - } - }, "nextPageToken": { "target": "com.amazonaws.swf#PageToken", "traits": { @@ -2497,6 +2484,19 @@ "smithy.api#required": {} } }, + "domain": { + "target": "com.amazonaws.swf#DomainName", + "traits": { + "smithy.api#documentation": "

    The name of the domain containing the workflow execution.

    ", + "smithy.api#required": {} + } + }, + "reverseOrder": { + "target": "com.amazonaws.swf#ReverseOrder", + "traits": { + "smithy.api#documentation": "

    When set to true, returns the events in reverse order. By default the\n results are returned in ascending order of the eventTimeStamp of the\n events.

    " + } + }, "maximumPageSize": { "target": "com.amazonaws.swf#PageSize", "traits": { @@ -2529,349 +2529,349 @@ "com.amazonaws.swf#HistoryEvent": { "type": "structure", "members": { - "childWorkflowExecutionTimedOutEventAttributes": { - "target": "com.amazonaws.swf#ChildWorkflowExecutionTimedOutEventAttributes", + "lambdaFunctionScheduledEventAttributes": { + "target": "com.amazonaws.swf#LambdaFunctionScheduledEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    Provides the details of the LambdaFunctionScheduled event. It isn't set\n for other event types.

    " } }, - "workflowExecutionStartedEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionStartedEventAttributes", + "workflowExecutionCancelRequestedEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionCancelRequestedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionCancelRequested then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "externalWorkflowExecutionSignaledEventAttributes": { - "target": "com.amazonaws.swf#ExternalWorkflowExecutionSignaledEventAttributes", + "markerRecordedEventAttributes": { + "target": "com.amazonaws.swf#MarkerRecordedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type MarkerRecorded then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " } }, - "cancelTimerFailedEventAttributes": { - "target": "com.amazonaws.swf#CancelTimerFailedEventAttributes", + "childWorkflowExecutionStartedEventAttributes": { + "target": "com.amazonaws.swf#ChildWorkflowExecutionStartedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type CancelTimerFailed then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "continueAsNewWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#ContinueAsNewWorkflowExecutionFailedEventAttributes", + "startTimerFailedEventAttributes": { + "target": "com.amazonaws.swf#StartTimerFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type StartTimerFailed then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " } }, - "activityTaskCanceledEventAttributes": { - "target": "com.amazonaws.swf#ActivityTaskCanceledEventAttributes", + "activityTaskStartedEventAttributes": { + "target": "com.amazonaws.swf#ActivityTaskStartedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ActivityTaskCanceled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ActivityTaskStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "lambdaFunctionStartedEventAttributes": { - "target": "com.amazonaws.swf#LambdaFunctionStartedEventAttributes", + "completeWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#CompleteWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the LambdaFunctionStarted event. It isn't set for\n other event types.

    " + "smithy.api#documentation": "

    If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "childWorkflowExecutionCanceledEventAttributes": { - "target": "com.amazonaws.swf#ChildWorkflowExecutionCanceledEventAttributes", + "eventTimestamp": { + "target": "com.amazonaws.swf#Timestamp", "traits": { - "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    The date and time when the event occurred.

    ", + "smithy.api#required": {} } }, - "requestCancelExternalWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionFailedEventAttributes", + "timerStartedEventAttributes": { + "target": "com.amazonaws.swf#TimerStartedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type TimerStarted then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " } }, - "workflowExecutionContinuedAsNewEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionContinuedAsNewEventAttributes", + "failWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#FailWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "childWorkflowExecutionCompletedEventAttributes": { - "target": "com.amazonaws.swf#ChildWorkflowExecutionCompletedEventAttributes", + "cancelTimerFailedEventAttributes": { + "target": "com.amazonaws.swf#CancelTimerFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type CancelTimerFailed then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " } }, - "startLambdaFunctionFailedEventAttributes": { - "target": "com.amazonaws.swf#StartLambdaFunctionFailedEventAttributes", + "workflowExecutionStartedEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionStartedEventAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the StartLambdaFunctionFailed event. It isn't set\n for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "timerStartedEventAttributes": { - "target": "com.amazonaws.swf#TimerStartedEventAttributes", + "eventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    If the event is of type TimerStarted then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

    ", + "smithy.api#required": {} } }, - "childWorkflowExecutionStartedEventAttributes": { - "target": "com.amazonaws.swf#ChildWorkflowExecutionStartedEventAttributes", + "startLambdaFunctionFailedEventAttributes": { + "target": "com.amazonaws.swf#StartLambdaFunctionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    Provides the details of the StartLambdaFunctionFailed event. It isn't set\n for other event types.

    " } }, - "requestCancelExternalWorkflowExecutionInitiatedEventAttributes": { - "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionInitiatedEventAttributes", + "lambdaFunctionStartedEventAttributes": { + "target": "com.amazonaws.swf#LambdaFunctionStartedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    Provides the details of the LambdaFunctionStarted event. It isn't set for\n other event types.

    " } }, - "workflowExecutionCancelRequestedEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionCancelRequestedEventAttributes", + "scheduleActivityTaskFailedEventAttributes": { + "target": "com.amazonaws.swf#ScheduleActivityTaskFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionCancelRequested then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "lambdaFunctionCompletedEventAttributes": { - "target": "com.amazonaws.swf#LambdaFunctionCompletedEventAttributes", + "startChildWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#StartChildWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the LambdaFunctionCompleted event. It isn't set\n for other event types.

    " + "smithy.api#documentation": "

    If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "eventId": { - "target": "com.amazonaws.swf#EventId", + "activityTaskCanceledEventAttributes": { + "target": "com.amazonaws.swf#ActivityTaskCanceledEventAttributes", "traits": { - "smithy.api#documentation": "

    The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the event is of type ActivityTaskCanceled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "signalExternalWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionFailedEventAttributes", + "activityTaskCompletedEventAttributes": { + "target": "com.amazonaws.swf#ActivityTaskCompletedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ActivityTaskCompleted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "completeWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#CompleteWorkflowExecutionFailedEventAttributes", + "childWorkflowExecutionTimedOutEventAttributes": { + "target": "com.amazonaws.swf#ChildWorkflowExecutionTimedOutEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "lambdaFunctionTimedOutEventAttributes": { - "target": "com.amazonaws.swf#LambdaFunctionTimedOutEventAttributes", + "activityTaskCancelRequestedEventAttributes": { + "target": "com.amazonaws.swf#ActivityTaskCancelRequestedEventAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the LambdaFunctionTimedOut event. It isn't set for\n other event types.

    " + "smithy.api#documentation": "

    If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "lambdaFunctionScheduledEventAttributes": { - "target": "com.amazonaws.swf#LambdaFunctionScheduledEventAttributes", + "activityTaskScheduledEventAttributes": { + "target": "com.amazonaws.swf#ActivityTaskScheduledEventAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the LambdaFunctionScheduled event. It isn't set\n for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ActivityTaskScheduled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "activityTaskFailedEventAttributes": { - "target": "com.amazonaws.swf#ActivityTaskFailedEventAttributes", + "externalWorkflowExecutionSignaledEventAttributes": { + "target": "com.amazonaws.swf#ExternalWorkflowExecutionSignaledEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ActivityTaskFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "decisionTaskStartedEventAttributes": { - "target": "com.amazonaws.swf#DecisionTaskStartedEventAttributes", + "workflowExecutionCompletedEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionCompletedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type DecisionTaskStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "decisionTaskCompletedEventAttributes": { - "target": "com.amazonaws.swf#DecisionTaskCompletedEventAttributes", + "activityTaskTimedOutEventAttributes": { + "target": "com.amazonaws.swf#ActivityTaskTimedOutEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type DecisionTaskCompleted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ActivityTaskTimedOut then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "recordMarkerFailedEventAttributes": { - "target": "com.amazonaws.swf#RecordMarkerFailedEventAttributes", + "workflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type DecisionTaskFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "workflowExecutionTimedOutEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionTimedOutEventAttributes", + "childWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#ChildWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "decisionTaskScheduledEventAttributes": { - "target": "com.amazonaws.swf#DecisionTaskScheduledEventAttributes", + "externalWorkflowExecutionCancelRequestedEventAttributes": { + "target": "com.amazonaws.swf#ExternalWorkflowExecutionCancelRequestedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type DecisionTaskScheduled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " } }, - "decisionTaskTimedOutEventAttributes": { - "target": "com.amazonaws.swf#DecisionTaskTimedOutEventAttributes", + "signalExternalWorkflowExecutionInitiatedEventAttributes": { + "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionInitiatedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type DecisionTaskTimedOut then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " } }, - "scheduleLambdaFunctionFailedEventAttributes": { - "target": "com.amazonaws.swf#ScheduleLambdaFunctionFailedEventAttributes", + "startChildWorkflowExecutionInitiatedEventAttributes": { + "target": "com.amazonaws.swf#StartChildWorkflowExecutionInitiatedEventAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the ScheduleLambdaFunctionFailed event. It isn't\n set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "startTimerFailedEventAttributes": { - "target": "com.amazonaws.swf#StartTimerFailedEventAttributes", + "workflowExecutionTerminatedEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionTerminatedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type StartTimerFailed then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "workflowExecutionSignaledEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionSignaledEventAttributes", + "lambdaFunctionCompletedEventAttributes": { + "target": "com.amazonaws.swf#LambdaFunctionCompletedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    Provides the details of the LambdaFunctionCompleted event. It isn't set\n for other event types.

    " } }, - "timerCanceledEventAttributes": { - "target": "com.amazonaws.swf#TimerCanceledEventAttributes", + "requestCancelExternalWorkflowExecutionInitiatedEventAttributes": { + "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionInitiatedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type TimerCanceled then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " } }, - "requestCancelActivityTaskFailedEventAttributes": { - "target": "com.amazonaws.swf#RequestCancelActivityTaskFailedEventAttributes", + "signalExternalWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type RequestCancelActivityTaskFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "workflowExecutionCanceledEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionCanceledEventAttributes", + "recordMarkerFailedEventAttributes": { + "target": "com.amazonaws.swf#RecordMarkerFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type DecisionTaskFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "scheduleActivityTaskFailedEventAttributes": { - "target": "com.amazonaws.swf#ScheduleActivityTaskFailedEventAttributes", + "eventType": { + "target": "com.amazonaws.swf#EventType", "traits": { - "smithy.api#documentation": "

    If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    The type of the history event.

    ", + "smithy.api#required": {} } }, - "activityTaskCancelRequestedEventAttributes": { - "target": "com.amazonaws.swf#ActivityTaskCancelRequestedEventAttributes", + "lambdaFunctionFailedEventAttributes": { + "target": "com.amazonaws.swf#LambdaFunctionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    Provides the details of the LambdaFunctionFailed event. It isn't set for\n other event types.

    " } }, - "timerFiredEventAttributes": { - "target": "com.amazonaws.swf#TimerFiredEventAttributes", + "workflowExecutionContinuedAsNewEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionContinuedAsNewEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type TimerFired then this member is set and provides detailed information about\n the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "childWorkflowExecutionTerminatedEventAttributes": { - "target": "com.amazonaws.swf#ChildWorkflowExecutionTerminatedEventAttributes", + "cancelWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#CancelWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "startChildWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#StartChildWorkflowExecutionFailedEventAttributes", + "childWorkflowExecutionCanceledEventAttributes": { + "target": "com.amazonaws.swf#ChildWorkflowExecutionCanceledEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "eventType": { - "target": "com.amazonaws.swf#EventType", + "childWorkflowExecutionCompletedEventAttributes": { + "target": "com.amazonaws.swf#ChildWorkflowExecutionCompletedEventAttributes", "traits": { - "smithy.api#documentation": "

    The type of the history event.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "lambdaFunctionFailedEventAttributes": { - "target": "com.amazonaws.swf#LambdaFunctionFailedEventAttributes", + "timerFiredEventAttributes": { + "target": "com.amazonaws.swf#TimerFiredEventAttributes", "traits": { - "smithy.api#documentation": "

    Provides the details of the LambdaFunctionFailed event. It isn't set for\n other event types.

    " + "smithy.api#documentation": "

    If the event is of type TimerFired then this member is set and provides detailed information about\n the event. It isn't set for other event types.

    " } }, - "cancelWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#CancelWorkflowExecutionFailedEventAttributes", + "continueAsNewWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#ContinueAsNewWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "workflowExecutionTerminatedEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionTerminatedEventAttributes", + "childWorkflowExecutionTerminatedEventAttributes": { + "target": "com.amazonaws.swf#ChildWorkflowExecutionTerminatedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "markerRecordedEventAttributes": { - "target": "com.amazonaws.swf#MarkerRecordedEventAttributes", + "requestCancelExternalWorkflowExecutionFailedEventAttributes": { + "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type MarkerRecorded then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " } }, - "startChildWorkflowExecutionInitiatedEventAttributes": { - "target": "com.amazonaws.swf#StartChildWorkflowExecutionInitiatedEventAttributes", + "decisionTaskTimedOutEventAttributes": { + "target": "com.amazonaws.swf#DecisionTaskTimedOutEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type DecisionTaskTimedOut then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "activityTaskStartedEventAttributes": { - "target": "com.amazonaws.swf#ActivityTaskStartedEventAttributes", + "decisionTaskScheduledEventAttributes": { + "target": "com.amazonaws.swf#DecisionTaskScheduledEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ActivityTaskStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type DecisionTaskScheduled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "failWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#FailWorkflowExecutionFailedEventAttributes", + "decisionTaskCompletedEventAttributes": { + "target": "com.amazonaws.swf#DecisionTaskCompletedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type DecisionTaskCompleted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "eventTimestamp": { - "target": "com.amazonaws.swf#Timestamp", + "workflowExecutionCanceledEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionCanceledEventAttributes", "traits": { - "smithy.api#documentation": "

    The date and time when the event occurred.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "externalWorkflowExecutionCancelRequestedEventAttributes": { - "target": "com.amazonaws.swf#ExternalWorkflowExecutionCancelRequestedEventAttributes", + "activityTaskFailedEventAttributes": { + "target": "com.amazonaws.swf#ActivityTaskFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type ActivityTaskFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "activityTaskScheduledEventAttributes": { - "target": "com.amazonaws.swf#ActivityTaskScheduledEventAttributes", + "timerCanceledEventAttributes": { + "target": "com.amazonaws.swf#TimerCanceledEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ActivityTaskScheduled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type TimerCanceled then this member is set and provides detailed information\n about the event. It isn't set for other event types.

    " } }, - "signalExternalWorkflowExecutionInitiatedEventAttributes": { - "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionInitiatedEventAttributes", + "decisionTaskStartedEventAttributes": { + "target": "com.amazonaws.swf#DecisionTaskStartedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and\n provides detailed information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type DecisionTaskStarted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "activityTaskCompletedEventAttributes": { - "target": "com.amazonaws.swf#ActivityTaskCompletedEventAttributes", + "lambdaFunctionTimedOutEventAttributes": { + "target": "com.amazonaws.swf#LambdaFunctionTimedOutEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ActivityTaskCompleted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    Provides the details of the LambdaFunctionTimedOut event. It isn't set for\n other event types.

    " } }, - "workflowExecutionCompletedEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionCompletedEventAttributes", + "workflowExecutionSignaledEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionSignaledEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } }, - "workflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#WorkflowExecutionFailedEventAttributes", + "scheduleLambdaFunctionFailedEventAttributes": { + "target": "com.amazonaws.swf#ScheduleLambdaFunctionFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type WorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    Provides the details of the ScheduleLambdaFunctionFailed event. It isn't\n set for other event types.

    " } }, - "childWorkflowExecutionFailedEventAttributes": { - "target": "com.amazonaws.swf#ChildWorkflowExecutionFailedEventAttributes", + "requestCancelActivityTaskFailedEventAttributes": { + "target": "com.amazonaws.swf#RequestCancelActivityTaskFailedEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type RequestCancelActivityTaskFailed then this member is set and provides\n detailed information about the event. It isn't set for other event types.

    " } }, - "activityTaskTimedOutEventAttributes": { - "target": "com.amazonaws.swf#ActivityTaskTimedOutEventAttributes", + "workflowExecutionTimedOutEventAttributes": { + "target": "com.amazonaws.swf#WorkflowExecutionTimedOutEventAttributes", "traits": { - "smithy.api#documentation": "

    If the event is of type ActivityTaskTimedOut then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " + "smithy.api#documentation": "

    If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed\n information about the event. It isn't set for other event types.

    " } } }, @@ -2897,6 +2897,13 @@ "com.amazonaws.swf#LambdaFunctionCompletedEventAttributes": { "type": "structure", "members": { + "scheduledEventId": { + "target": "com.amazonaws.swf#EventId", + "traits": { + "smithy.api#documentation": "

    The ID of the LambdaFunctionScheduled event that was recorded when this\n Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    ", + "smithy.api#required": {} + } + }, "startedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { @@ -2909,13 +2916,6 @@ "traits": { "smithy.api#documentation": "

    The results of the Lambda task.

    " } - }, - "scheduledEventId": { - "target": "com.amazonaws.swf#EventId", - "traits": { - "smithy.api#documentation": "

    The ID of the LambdaFunctionScheduled event that was recorded when this\n Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -2938,18 +2938,18 @@ "smithy.api#required": {} } }, - "reason": { - "target": "com.amazonaws.swf#FailureReason", - "traits": { - "smithy.api#documentation": "

    The reason provided for the failure.

    " - } - }, "scheduledEventId": { "target": "com.amazonaws.swf#EventId", "traits": { "smithy.api#documentation": "

    The ID of the LambdaFunctionScheduled event that was recorded when this\n activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    ", "smithy.api#required": {} } + }, + "reason": { + "target": "com.amazonaws.swf#FailureReason", + "traits": { + "smithy.api#documentation": "

    The reason provided for the failure.

    " + } } }, "traits": { @@ -2965,6 +2965,20 @@ "smithy.api#documentation": "

    The maximum amount of time a worker can take to process the Lambda task.

    " } }, + "id": { + "target": "com.amazonaws.swf#FunctionId", + "traits": { + "smithy.api#documentation": "

    The unique ID of the Lambda task.

    ", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.swf#FunctionName", + "traits": { + "smithy.api#documentation": "

    The name of the Lambda function.

    ", + "smithy.api#required": {} + } + }, "input": { "target": "com.amazonaws.swf#FunctionInput", "traits": { @@ -2983,20 +2997,6 @@ "smithy.api#documentation": "

    The ID of the LambdaFunctionCompleted event corresponding to the decision\n that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    ", "smithy.api#required": {} } - }, - "id": { - "target": "com.amazonaws.swf#FunctionId", - "traits": { - "smithy.api#documentation": "

    The unique ID of the Lambda task.

    ", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.swf#FunctionName", - "traits": { - "smithy.api#documentation": "

    The name of the Lambda function.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -3115,10 +3115,11 @@ "smithy.api#documentation": "

    If specified, only lists the activity types that have this name.

    " } }, - "nextPageToken": { - "target": "com.amazonaws.swf#PageToken", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".

    \n \n

    The configured maximumPageSize determines how many results can be returned\n in a single call.

    " + "smithy.api#documentation": "

    The name of the domain in which the activity types have been registered.

    ", + "smithy.api#required": {} } }, "registrationStatus": { @@ -3128,10 +3129,10 @@ "smithy.api#required": {} } }, - "reverseOrder": { - "target": "com.amazonaws.swf#ReverseOrder", + "nextPageToken": { + "target": "com.amazonaws.swf#PageToken", "traits": { - "smithy.api#documentation": "

    When set to true, returns the results in reverse order. By default, the\n results are returned in ascending alphabetical order by name of the activity\n types.

    " + "smithy.api#documentation": "

    If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".

    \n \n

    The configured maximumPageSize determines how many results can be returned\n in a single call.

    " } }, "maximumPageSize": { @@ -3140,11 +3141,10 @@ "smithy.api#documentation": "

    The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.

    " } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", + "reverseOrder": { + "target": "com.amazonaws.swf#ReverseOrder", "traits": { - "smithy.api#documentation": "

    The name of the domain in which the activity types have been registered.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    When set to true, returns the results in reverse order. By default, the\n results are returned in ascending alphabetical order by name of the activity\n types.

    " } } } @@ -3190,10 +3190,10 @@ "smithy.api#documentation": "

    If specified, the workflow executions are included in the returned results based on\n whether their close times are within the range specified by this filter. Also, if this\n parameter is specified, the returned results are ordered by their close times.

    \n \n

    \n startTimeFilter and closeTimeFilter are mutually exclusive. You\n must specify one of these in a request but not both.

    \n     " } }, - "maximumPageSize": { - "target": "com.amazonaws.swf#PageSize", + "closeStatusFilter": { + "target": "com.amazonaws.swf#CloseStatusFilter", "traits": { - "smithy.api#documentation": "

    The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.

    " + "smithy.api#documentation": "

    If specified, only workflow executions that match this close\n status are listed. For example, if TERMINATED is specified, then only TERMINATED\n workflow executions are listed.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " } }, "tagFilter": { @@ -3202,22 +3202,17 @@ "smithy.api#documentation": "

    If specified, only executions that have the matching tag are listed.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " } }, - "closeStatusFilter": { - "target": "com.amazonaws.swf#CloseStatusFilter", - "traits": { - "smithy.api#documentation": "

    If specified, only workflow executions that match this close\n status are listed. For example, if TERMINATED is specified, then only TERMINATED\n workflow executions are listed.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " - } - }, - "reverseOrder": { - "target": "com.amazonaws.swf#ReverseOrder", + "maximumPageSize": { + "target": "com.amazonaws.swf#PageSize", "traits": { - "smithy.api#documentation": "

    When set to true, returns the results in reverse order. By default the\n results are returned in descending order of the start or the close time of the\n executions.

    " + "smithy.api#documentation": "

    The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.

    " } }, - "startTimeFilter": { - "target": "com.amazonaws.swf#ExecutionTimeFilter", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    If specified, the workflow executions are included in the returned results based on\n whether their start times are within the range specified by this filter. Also, if this\n parameter is specified, the returned results are ordered by their start times.

    \n \n

    \n startTimeFilter and closeTimeFilter are mutually exclusive. You\n must specify one of these in a request but not both.

    \n     " + "smithy.api#documentation": "

    The name of the domain that contains the workflow executions to list.

    ", + "smithy.api#required": {} } }, "executionFilter": { @@ -3226,18 +3221,23 @@ "smithy.api#documentation": "

    If specified, only workflow executions matching the workflow ID specified in the filter\n are returned.

    \n \n

    \n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a\n request.

    \n     " } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", - "traits": { - "smithy.api#documentation": "

    The name of the domain that contains the workflow executions to list.

    ", - "smithy.api#required": {} - } - }, "nextPageToken": { "target": "com.amazonaws.swf#PageToken", "traits": { "smithy.api#documentation": "

    If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".

    \n \n

    The configured maximumPageSize determines how many results can be returned\n in a single call.

    " } + }, + "reverseOrder": { + "target": "com.amazonaws.swf#ReverseOrder", + "traits": { + "smithy.api#documentation": "

    When set to true, returns the results in reverse order. By default the\n results are returned in descending order of the start or the close time of the\n executions.

    " + } + }, + "startTimeFilter": { + "target": "com.amazonaws.swf#ExecutionTimeFilter", + "traits": { + "smithy.api#documentation": "

    If specified, the workflow executions are included in the returned results based on\n whether their start times are within the range specified by this filter. Also, if this\n parameter is specified, the returned results are ordered by their start times.

    \n \n

    \n startTimeFilter and closeTimeFilter are mutually exclusive. You\n must specify one of these in a request but not both.

    \n     " + } } } }, @@ -3267,13 +3267,6 @@ "com.amazonaws.swf#ListDomainsInput": { "type": "structure", "members": { - "registrationStatus": { - "target": "com.amazonaws.swf#RegistrationStatus", - "traits": { - "smithy.api#documentation": "

    Specifies the registration status of the domains to list.

    ", - "smithy.api#required": {} - } - }, "maximumPageSize": { "target": "com.amazonaws.swf#PageSize", "traits": { @@ -3291,6 +3284,13 @@ "traits": { "smithy.api#documentation": "

    When set to true, returns the results in reverse order. By default, the\n results are returned in ascending alphabetical order by name of the\n domains.

    " } + }, + "registrationStatus": { + "target": "com.amazonaws.swf#RegistrationStatus", + "traits": { + "smithy.api#documentation": "

    Specifies the registration status of the domains to list.

    ", + "smithy.api#required": {} + } } } }, @@ -3323,6 +3323,12 @@ "com.amazonaws.swf#ListOpenWorkflowExecutionsInput": { "type": "structure", "members": { + "reverseOrder": { + "target": "com.amazonaws.swf#ReverseOrder", + "traits": { + "smithy.api#documentation": "

    When set to true, returns the results in reverse order. By default the\n results are returned in descending order of the start time of the executions.

    " + } + }, "domain": { "target": "com.amazonaws.swf#DomainName", "traits": { @@ -3330,18 +3336,18 @@ "smithy.api#required": {} } }, - "reverseOrder": { - "target": "com.amazonaws.swf#ReverseOrder", - "traits": { - "smithy.api#documentation": "

    When set to true, returns the results in reverse order. By default the\n results are returned in descending order of the start time of the executions.

    " - } - }, "tagFilter": { "target": "com.amazonaws.swf#TagFilter", "traits": { "smithy.api#documentation": "

    If specified, only executions that have the matching tag are listed.

    \n \n

    \n executionFilter, typeFilter and tagFilter are\n mutually exclusive. You can specify at most one of these in a request.

    \n     " } }, + "maximumPageSize": { + "target": "com.amazonaws.swf#PageSize", + "traits": { + "smithy.api#documentation": "

    The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.

    " + } + }, "startTimeFilter": { "target": "com.amazonaws.swf#ExecutionTimeFilter", "traits": { @@ -3366,12 +3372,6 @@ "traits": { "smithy.api#documentation": "

    If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".

    \n \n

    The configured maximumPageSize determines how many results can be returned\n in a single call.

    " } - }, - "maximumPageSize": { - "target": "com.amazonaws.swf#PageSize", - "traits": { - "smithy.api#documentation": "

    The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.

    " - } } } }, @@ -3450,20 +3450,6 @@ "com.amazonaws.swf#ListWorkflowTypesInput": { "type": "structure", "members": { - "registrationStatus": { - "target": "com.amazonaws.swf#RegistrationStatus", - "traits": { - "smithy.api#documentation": "

    Specifies the registration status of the workflow types to list.

    ", - "smithy.api#required": {} - } - }, - "domain": { - "target": "com.amazonaws.swf#DomainName", - "traits": { - "smithy.api#documentation": "

    The name of the domain in which the workflow types have been registered.

    ", - "smithy.api#required": {} - } - }, "reverseOrder": { "target": "com.amazonaws.swf#ReverseOrder", "traits": { @@ -3476,6 +3462,20 @@ "smithy.api#documentation": "

    If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".

    \n \n

    The configured maximumPageSize determines how many results can be returned\n in a single call.

    " } }, + "domain": { + "target": "com.amazonaws.swf#DomainName", + "traits": { + "smithy.api#documentation": "

    The name of the domain in which the workflow types have been registered.

    ", + "smithy.api#required": {} + } + }, + "registrationStatus": { + "target": "com.amazonaws.swf#RegistrationStatus", + "traits": { + "smithy.api#documentation": "

    Specifies the registration status of the workflow types to list.

    ", + "smithy.api#required": {} + } + }, "maximumPageSize": { "target": "com.amazonaws.swf#PageSize", "traits": { @@ -3581,18 +3581,18 @@ "com.amazonaws.swf#PendingTaskCount": { "type": "structure", "members": { - "truncated": { - "target": "com.amazonaws.swf#Truncated", - "traits": { - "smithy.api#documentation": "

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    " - } - }, "count": { "target": "com.amazonaws.swf#Count", "traits": { "smithy.api#documentation": "

    The number of tasks in the task list.

    ", "smithy.api#required": {} } + }, + "truncated": { + "target": "com.amazonaws.swf#Truncated", + "traits": { + "smithy.api#documentation": "

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    " + } } }, "traits": { @@ -3632,18 +3632,18 @@ "smithy.api#required": {} } }, + "identity": { + "target": "com.amazonaws.swf#Identity", + "traits": { + "smithy.api#documentation": "

    Identity of the worker making the request, recorded in the\n ActivityTaskStarted event in the workflow history. This enables diagnostic\n tracing when problems arise. The form of this identity is user defined.

    " + } + }, "taskList": { "target": "com.amazonaws.swf#TaskList", "traits": { "smithy.api#documentation": "

    Specifies the task list to poll for activity tasks.

    \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", "smithy.api#required": {} } - }, - "identity": { - "target": "com.amazonaws.swf#Identity", - "traits": { - "smithy.api#documentation": "

    Identity of the worker making the request, recorded in the\n ActivityTaskStarted event in the workflow history. This enables diagnostic\n tracing when problems arise. The form of this identity is user defined.

    " - } } } }, @@ -3691,31 +3691,31 @@ "smithy.api#documentation": "

    Identity of the decider making the request, which is recorded in the\n DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when\n problems arise. The form of this identity is user defined.

    " } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", + "taskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    The name of the domain containing the task lists to poll.

    ", + "smithy.api#documentation": "

    Specifies the task list to poll for decision tasks.

    \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", "smithy.api#required": {} } }, - "nextPageToken": { - "target": "com.amazonaws.swf#PageToken", - "traits": { - "smithy.api#documentation": "

    If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".

    \n \n

    The configured maximumPageSize determines how many results can be returned\n in a single call.

    \n \n

    The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve\n the next page of history records. Calling PollForDecisionTask with a\n nextPageToken doesn't return a new decision task.

    \n     " - } - }, "maximumPageSize": { "target": "com.amazonaws.swf#PageSize", "traits": { "smithy.api#documentation": "

    The maximum number of results that are returned per call.\n Use nextPageToken to obtain further pages of results.

    \n

    This\n is an upper limit only; the actual number of results returned per call may be fewer than the\n specified maximum.

    " } }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    Specifies the task list to poll for decision tasks.

    \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", + "smithy.api#documentation": "

    The name of the domain containing the task lists to poll.

    ", "smithy.api#required": {} } + }, + "nextPageToken": { + "target": "com.amazonaws.swf#PageToken", + "traits": { + "smithy.api#documentation": "

    If NextPageToken is returned there are more results\n available. The value of NextPageToken is a unique pagination token for each page. Make the call again using \n the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires \n after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has \n exceeded its maximum lifetime\".

    \n \n

    The configured maximumPageSize determines how many results can be returned\n in a single call.

    \n \n

    The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve\n the next page of history records. Calling PollForDecisionTask with a\n nextPageToken doesn't return a new decision task.

    \n     " + } } } }, @@ -3742,36 +3742,36 @@ "com.amazonaws.swf#RecordActivityTaskHeartbeatInput": { "type": "structure", "members": { + "details": { + "target": "com.amazonaws.swf#LimitedData", + "traits": { + "smithy.api#documentation": "

    If specified, contains details about the progress of the task.

    " + } + }, "taskToken": { "target": "com.amazonaws.swf#TaskToken", "traits": { "smithy.api#documentation": "

    The taskToken of the ActivityTask.

    \n \n

    \n taskToken is generated by the service and should be treated as an opaque value.\n If the task is passed to another process, its taskToken must also be passed.\n This enables it to provide its progress and respond with results.

    \n     ", "smithy.api#required": {} } - }, - "details": { - "target": "com.amazonaws.swf#LimitedData", - "traits": { - "smithy.api#documentation": "

    If specified, contains details about the progress of the task.

    " - } } } }, "com.amazonaws.swf#RecordMarkerDecisionAttributes": { "type": "structure", "members": { + "details": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    \n The details of the marker.

    " + } + }, "markerName": { "target": "com.amazonaws.swf#MarkerName", "traits": { "smithy.api#documentation": "

    \n The name of the marker.

    ", "smithy.api#required": {} } - }, - "details": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    \n The details of the marker.

    " - } } }, "traits": { @@ -3798,17 +3798,17 @@ "smithy.api#required": {} } }, - "markerName": { - "target": "com.amazonaws.swf#MarkerName", + "cause": { + "target": "com.amazonaws.swf#RecordMarkerFailedCause", "traits": { - "smithy.api#documentation": "

    The marker's name.

    ", + "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", "smithy.api#required": {} } }, - "cause": { - "target": "com.amazonaws.swf#RecordMarkerFailedCause", + "markerName": { + "target": "com.amazonaws.swf#MarkerName", "traits": { - "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", + "smithy.api#documentation": "

    The marker's name.

    ", "smithy.api#required": {} } } @@ -3843,40 +3843,41 @@ "com.amazonaws.swf#RegisterActivityTypeInput": { "type": "structure", "members": { - "defaultTaskPriority": { - "target": "com.amazonaws.swf#TaskPriority", - "traits": { - "smithy.api#documentation": "

    The default task priority to assign to the activity type. If not assigned, then\n 0 is used. Valid values are integers that range from Java's\n Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).\n Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task\n Priority in the in the\n Amazon SWF Developer Guide..

    " - } - }, "description": { "target": "com.amazonaws.swf#Description", "traits": { "smithy.api#documentation": "

    A textual description of the activity type.

    " } }, - "defaultTaskScheduleToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "name": { + "target": "com.amazonaws.swf#Name", "traits": { - "smithy.api#documentation": "

    If set, specifies the default maximum duration for a task of this activity type. This\n default can be overridden when scheduling an activity task using the\n ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    The name of the activity type within the domain.

    \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", + "smithy.api#required": {} } }, - "defaultTaskList": { - "target": "com.amazonaws.swf#TaskList", + "defaultTaskPriority": { + "target": "com.amazonaws.swf#TaskPriority", "traits": { - "smithy.api#documentation": "

    If set, specifies the default task list to use for scheduling tasks of this activity\n type. This default task list is used if a task list isn't provided when a task is scheduled\n through the ScheduleActivityTask\n Decision.

    " + "smithy.api#documentation": "

    The default task priority to assign to the activity type. If not assigned, then\n 0 is used. Valid values are integers that range from Java's\n Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).\n Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task\n Priority in the in the\n Amazon SWF Developer Guide..

    " } }, - "defaultTaskStartToCloseTimeout": { + "defaultTaskScheduleToCloseTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    If set, specifies the default maximum duration that a worker can take to process tasks\n of this activity type. This default can be overridden when scheduling an activity task using\n the ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    If set, specifies the default maximum duration for a task of this activity type. This\n default can be overridden when scheduling an activity task using the\n ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    " } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", + "defaultTaskHeartbeatTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The name of the domain in which this activity is to be registered.

    ", + "smithy.api#documentation": "

    If set, specifies the default maximum time before which a worker processing a task of\n this type must report progress by calling RecordActivityTaskHeartbeat. If\n the timeout is exceeded, the activity task is automatically timed out. This default can be\n overridden when scheduling an activity task using the ScheduleActivityTask\n Decision. If the activity worker subsequently attempts to record a heartbeat\n or returns a result, the activity worker receives an UnknownResource fault. In\n this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should\n clean up the activity task.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    " + } + }, + "version": { + "target": "com.amazonaws.swf#Version", + "traits": { + "smithy.api#documentation": "

    The version of the activity type.

    \n \n

    The activity type consists of the name and version, the combination of which must be\n unique within the domain.

    \n     \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", "smithy.api#required": {} } }, @@ -3886,24 +3887,23 @@ "smithy.api#documentation": "

    If set, specifies the default maximum duration that a task of this activity type can\n wait before being assigned to a worker. This default can be overridden when scheduling an\n activity task using the ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    " } }, - "defaultTaskHeartbeatTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "defaultTaskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    If set, specifies the default maximum time before which a worker processing a task of\n this type must report progress by calling RecordActivityTaskHeartbeat. If\n the timeout is exceeded, the activity task is automatically timed out. This default can be\n overridden when scheduling an activity task using the ScheduleActivityTask\n Decision. If the activity worker subsequently attempts to record a heartbeat\n or returns a result, the activity worker receives an UnknownResource fault. In\n this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should\n clean up the activity task.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    If set, specifies the default task list to use for scheduling tasks of this activity\n type. This default task list is used if a task list isn't provided when a task is scheduled\n through the ScheduleActivityTask\n Decision.

    " } }, - "version": { - "target": "com.amazonaws.swf#Version", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The version of the activity type.

    \n \n

    The activity type consists of the name and version, the combination of which must be\n unique within the domain.

    \n     \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", + "smithy.api#documentation": "

    The name of the domain in which this activity is to be registered.

    ", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.swf#Name", + "defaultTaskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The name of the activity type within the domain.

    \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If set, specifies the default maximum duration that a worker can take to process tasks\n of this activity type. This default can be overridden when scheduling an activity task using\n the ScheduleActivityTask\n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    " } } } @@ -3934,29 +3934,29 @@ "com.amazonaws.swf#RegisterDomainInput": { "type": "structure", "members": { - "workflowExecutionRetentionPeriodInDays": { - "target": "com.amazonaws.swf#DurationInDays", - "traits": { - "smithy.api#documentation": "

    The duration (in days) that records and histories of workflow executions on the domain\n should be kept by the service. After the retention period, the workflow execution isn't\n available in the results of visibility calls.

    \n

    If you pass the value NONE or 0 (zero), then the workflow\n execution history isn't retained. As soon as the workflow execution completes, the execution\n record and its history are deleted.

    \n

    The maximum workflow execution retention period is 90 days. For more information about\n Amazon SWF service limits, see: Amazon SWF Service Limits in the\n Amazon SWF Developer Guide.

    ", - "smithy.api#required": {} - } - }, "tags": { "target": "com.amazonaws.swf#ResourceTagList", "traits": { "smithy.api#documentation": "

    Tags to be added when registering a domain.

    \n

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    " } }, + "name": { + "target": "com.amazonaws.swf#DomainName", + "traits": { + "smithy.api#documentation": "

    Name of the domain to register. The name must be unique in the region that the domain\n is registered in.

    \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", + "smithy.api#required": {} + } + }, "description": { "target": "com.amazonaws.swf#Description", "traits": { "smithy.api#documentation": "

    A text description of the domain.

    " } }, - "name": { - "target": "com.amazonaws.swf#DomainName", + "workflowExecutionRetentionPeriodInDays": { + "target": "com.amazonaws.swf#DurationInDays", "traits": { - "smithy.api#documentation": "

    Name of the domain to register. The name must be unique in the region that the domain\n is registered in.

    \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", + "smithy.api#documentation": "

    The duration (in days) that records and histories of workflow executions on the domain\n should be kept by the service. After the retention period, the workflow execution isn't\n available in the results of visibility calls.

    \n

    If you pass the value NONE or 0 (zero), then the workflow\n execution history isn't retained. As soon as the workflow execution completes, the execution\n record and its history are deleted.

    \n

    The maximum workflow execution retention period is 90 days. For more information about\n Amazon SWF service limits, see: Amazon SWF Service Limits in the\n Amazon SWF Developer Guide.

    ", "smithy.api#required": {} } } @@ -3994,6 +3994,12 @@ "smithy.api#documentation": "

    The default IAM role attached to this workflow type.

    \n \n

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you\n don't specify an IAM role when you start this workflow type, the default Lambda role is\n attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the\n Amazon SWF Developer Guide.

    \n     " } }, + "defaultExecutionStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", + "traits": { + "smithy.api#documentation": "

    If set, specifies the default maximum duration for executions of this workflow type.\n You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution\n Decision.

    \n\n

    The duration is specified in seconds; an integer greater than or equal to 0. Unlike\n some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for\n defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time\n that a workflow execution can run. Exceeding this limit always causes the workflow execution\n to time out.

    " + } + }, "defaultTaskStartToCloseTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { @@ -4007,10 +4013,11 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.swf#Description", + "version": { + "target": "com.amazonaws.swf#Version", "traits": { - "smithy.api#documentation": "

    Textual description of the workflow type.

    " + "smithy.api#documentation": "

    The version of the workflow type.

    \n \n

    The workflow type consists of the name and version, the combination of which must be\n unique within the domain. To get a list of all currently registered workflow types, use the\n ListWorkflowTypes action.

    \n     \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", + "smithy.api#required": {} } }, "defaultChildPolicy": { @@ -4019,17 +4026,16 @@ "smithy.api#documentation": "

    If set, specifies the default policy to use for the child workflow executions when a\n workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This\n default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution\n Decision.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its\n history. It is up to the decider to take appropriate actions when it receives an execution\n history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to\n run.

      \n
      • \n
    " } }, - "defaultExecutionStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "defaultTaskPriority": { + "target": "com.amazonaws.swf#TaskPriority", "traits": { - "smithy.api#documentation": "

    If set, specifies the default maximum duration for executions of this workflow type.\n You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution\n Decision.

    \n\n

    The duration is specified in seconds; an integer greater than or equal to 0. Unlike\n some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for\n defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time\n that a workflow execution can run. Exceeding this limit always causes the workflow execution\n to time out.

    " + "smithy.api#documentation": "

    The default task priority to assign to the workflow type. If not assigned, then\n 0 is used. Valid values are integers that range from Java's\n Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).\n Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task\n Priority in the Amazon SWF Developer Guide.

    " } }, - "version": { - "target": "com.amazonaws.swf#Version", + "defaultTaskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    The version of the workflow type.

    \n \n

    The workflow type consists of the name and version, the combination of which must be\n unique within the domain. To get a list of all currently registered workflow types, use the\n ListWorkflowTypes action.

    \n     \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If set, specifies the default task list to use for scheduling decision tasks for\n executions of this workflow type. This default is used only if a task list isn't provided when\n starting the execution through the StartWorkflowExecution Action or\n StartChildWorkflowExecution\n Decision.

    " } }, "domain": { @@ -4039,16 +4045,10 @@ "smithy.api#required": {} } }, - "defaultTaskList": { - "target": "com.amazonaws.swf#TaskList", - "traits": { - "smithy.api#documentation": "

    If set, specifies the default task list to use for scheduling decision tasks for\n executions of this workflow type. This default is used only if a task list isn't provided when\n starting the execution through the StartWorkflowExecution Action or\n StartChildWorkflowExecution\n Decision.

    " - } - }, - "defaultTaskPriority": { - "target": "com.amazonaws.swf#TaskPriority", + "description": { + "target": "com.amazonaws.swf#Description", "traits": { - "smithy.api#documentation": "

    The default task priority to assign to the workflow type. If not assigned, then\n 0 is used. Valid values are integers that range from Java's\n Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).\n Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task\n Priority in the Amazon SWF Developer Guide.

    " + "smithy.api#documentation": "

    Textual description of the workflow type.

    " } } } @@ -4104,17 +4104,17 @@ "smithy.api#required": {} } }, - "cause": { - "target": "com.amazonaws.swf#RequestCancelActivityTaskFailedCause", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", + "cause": { + "target": "com.amazonaws.swf#RequestCancelActivityTaskFailedCause", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", "smithy.api#required": {} } } @@ -4133,17 +4133,17 @@ "smithy.api#required": {} } }, - "control": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    The data attached to the event that can be used by the decider in subsequent workflow tasks.

    " - } - }, "runId": { "target": "com.amazonaws.swf#WorkflowRunIdOptional", "traits": { "smithy.api#documentation": "

    The runId of the external workflow execution to cancel.

    " } + }, + "control": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The data attached to the event that can be used by the decider in subsequent workflow tasks.

    " + } } }, "traits": { @@ -4169,30 +4169,31 @@ "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionFailedEventAttributes": { "type": "structure", "members": { - "initiatedEventId": { - "target": "com.amazonaws.swf#EventId", + "cause": { + "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionFailedCause", "traits": { - "smithy.api#documentation": "

    The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", + "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", "smithy.api#required": {} } }, - "runId": { - "target": "com.amazonaws.swf#WorkflowRunIdOptional", + "initiatedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The runId of the external workflow execution.

    " + "smithy.api#documentation": "

    The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This\n information can be useful for diagnosing problems by tracing back the chain of events leading up to this\n event.

    ", + "smithy.api#required": {} } }, - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The workflowId of the external workflow to which the cancel request was to be delivered.

    ", + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The workflowId of the external workflow to which the cancel request was to be delivered.

    ", "smithy.api#required": {} } }, @@ -4202,11 +4203,10 @@ "smithy.api#documentation": "

    The data attached to the event that the decider can use in subsequent workflow tasks.\n This data isn't sent to the workflow execution.

    " } }, - "cause": { - "target": "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionFailedCause", + "runId": { + "target": "com.amazonaws.swf#WorkflowRunIdOptional", "traits": { - "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The runId of the external workflow execution.

    " } } }, @@ -4217,10 +4217,11 @@ "com.amazonaws.swf#RequestCancelExternalWorkflowExecutionInitiatedEventAttributes": { "type": "structure", "members": { - "runId": { - "target": "com.amazonaws.swf#WorkflowRunIdOptional", + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "

    The runId of the external workflow execution to be canceled.

    " + "smithy.api#documentation": "

    The workflowId of the external workflow execution to be canceled.

    ", + "smithy.api#required": {} } }, "control": { @@ -4229,11 +4230,10 @@ "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent workflow tasks.

    " } }, - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", + "runId": { + "target": "com.amazonaws.swf#WorkflowRunIdOptional", "traits": { - "smithy.api#documentation": "

    The workflowId of the external workflow execution to be canceled.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The runId of the external workflow execution to be canceled.

    " } }, "decisionTaskCompletedEventId": { @@ -4268,11 +4268,10 @@ "com.amazonaws.swf#RequestCancelWorkflowExecutionInput": { "type": "structure", "members": { - "domain": { - "target": "com.amazonaws.swf#DomainName", + "runId": { + "target": "com.amazonaws.swf#WorkflowRunIdOptional", "traits": { - "smithy.api#documentation": "

    The name of the domain containing the workflow execution to cancel.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The runId of the workflow execution to cancel.

    " } }, "workflowId": { @@ -4282,10 +4281,11 @@ "smithy.api#required": {} } }, - "runId": { - "target": "com.amazonaws.swf#WorkflowRunIdOptional", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The runId of the workflow execution to cancel.

    " + "smithy.api#documentation": "

    The name of the domain containing the workflow execution to cancel.

    ", + "smithy.api#required": {} } } } @@ -4293,18 +4293,18 @@ "com.amazonaws.swf#ResourceTag": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.swf#ResourceTagValue", - "traits": { - "smithy.api#documentation": "

    The value of a tag.

    " - } - }, "key": { "target": "com.amazonaws.swf#ResourceTagKey", "traits": { "smithy.api#documentation": "

    The key of a tag.

    ", "smithy.api#required": {} } + }, + "value": { + "target": "com.amazonaws.swf#ResourceTagValue", + "traits": { + "smithy.api#documentation": "

    The value of a tag.

    " + } } }, "traits": { @@ -4361,18 +4361,18 @@ "com.amazonaws.swf#RespondActivityTaskCanceledInput": { "type": "structure", "members": { + "details": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    Information about the cancellation.

    " + } + }, "taskToken": { "target": "com.amazonaws.swf#TaskToken", "traits": { "smithy.api#documentation": "

    The taskToken of the ActivityTask.

    \n \n

    \n taskToken is generated by the service and should be treated as an opaque value.\n If the task is passed to another process, its taskToken must also be passed.\n This enables it to provide its progress and respond with results.

    \n     ", "smithy.api#required": {} } - }, - "details": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    Information about the cancellation.

    " - } } } }, @@ -4523,34 +4523,29 @@ "smithy.api#required": {} } }, - "heartbeatTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "control": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    If set, specifies the maximum time before which a worker processing a task of this type must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed\n out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This\n overrides the default heartbeat timeout specified when registering the activity type using\n RegisterActivityType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

    " } }, - "scheduleToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "input": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The maximum duration for this activity task.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.

    \n     " + "smithy.api#documentation": "

    The input provided to the activity task.

    " } }, - "taskPriority": { - "target": "com.amazonaws.swf#TaskPriority", + "activityId": { + "target": "com.amazonaws.swf#ActivityId", "traits": { - "smithy.api#documentation": "

    \n If set, specifies the priority with which the activity task is to be assigned to a worker. This\n overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType.\n Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + "smithy.api#documentation": "

    \n The activityId of the activity task.

    \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    ", + "smithy.api#required": {} } }, - "startToCloseTimeout": { + "scheduleToCloseTimeout": { "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    If set, specifies the maximum duration a worker may take to process this activity task. This overrides the\n default start-to-close timeout specified when registering the activity type using RegisterActivityType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.

    \n     " - } - }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", - "traits": { - "smithy.api#documentation": "

    If set, specifies the name of the task list in which to schedule the activity task. If not specified, the\n defaultTaskList registered with the activity type is used.

    \n \n

    A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

    \n     \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " + "smithy.api#documentation": "

    The maximum duration for this activity task.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.

    \n     " } }, "scheduleToStartTimeout": { @@ -4559,23 +4554,28 @@ "smithy.api#documentation": "

    \n If set, specifies the maximum duration the activity task can wait to be assigned to a worker.\n This overrides the default schedule-to-start timeout specified when registering the activity type using\n RegisterActivityType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.

    \n     " } }, - "input": { - "target": "com.amazonaws.swf#Data", + "taskPriority": { + "target": "com.amazonaws.swf#TaskPriority", "traits": { - "smithy.api#documentation": "

    The input provided to the activity task.

    " + "smithy.api#documentation": "

    \n If set, specifies the priority with which the activity task is to be assigned to a worker. This\n overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType.\n Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " } }, - "activityId": { - "target": "com.amazonaws.swf#ActivityId", + "startToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    \n The activityId of the activity task.

    \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If set, specifies the maximum duration a worker may take to process this activity task. This overrides the\n default start-to-close timeout specified when registering the activity type using RegisterActivityType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.

    \n     " } }, - "control": { - "target": "com.amazonaws.swf#Data", + "heartbeatTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

    " + "smithy.api#documentation": "

    If set, specifies the maximum time before which a worker processing a task of this type must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed\n out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This\n overrides the default heartbeat timeout specified when registering the activity type using\n RegisterActivityType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + } + }, + "taskList": { + "target": "com.amazonaws.swf#TaskList", + "traits": { + "smithy.api#documentation": "

    If set, specifies the name of the task list in which to schedule the activity task. If not specified, the\n defaultTaskList registered with the activity type is used.

    \n \n

    A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

    \n     \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " } } }, @@ -4633,6 +4633,13 @@ "smithy.api#required": {} } }, + "activityId": { + "target": "com.amazonaws.swf#ActivityId", + "traits": { + "smithy.api#documentation": "

    The activityId provided in the ScheduleActivityTask decision that failed.

    ", + "smithy.api#required": {} + } + }, "decisionTaskCompletedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { @@ -4646,13 +4653,6 @@ "smithy.api#documentation": "

    The activity type provided in the ScheduleActivityTask decision that failed.

    ", "smithy.api#required": {} } - }, - "activityId": { - "target": "com.amazonaws.swf#ActivityId", - "traits": { - "smithy.api#documentation": "

    The activityId provided in the ScheduleActivityTask decision that failed.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -4662,16 +4662,17 @@ "com.amazonaws.swf#ScheduleLambdaFunctionDecisionAttributes": { "type": "structure", "members": { - "input": { - "target": "com.amazonaws.swf#FunctionInput", + "name": { + "target": "com.amazonaws.swf#FunctionName", "traits": { - "smithy.api#documentation": "

    The optional input data to be supplied to the Lambda function.

    " + "smithy.api#documentation": "

    The name, or ARN, of the Lambda function to schedule.

    ", + "smithy.api#required": {} } }, - "control": { - "target": "com.amazonaws.swf#Data", + "startToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The data attached to the event that the decider can use in subsequent workflow tasks.\n This data isn't sent to the Lambda task.

    " + "smithy.api#documentation": "

    The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.

    " } }, "id": { @@ -4681,17 +4682,16 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.swf#FunctionName", + "control": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The name, or ARN, of the Lambda function to schedule.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The data attached to the event that the decider can use in subsequent workflow tasks.\n This data isn't sent to the Lambda task.

    " } }, - "startToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "input": { + "target": "com.amazonaws.swf#FunctionInput", "traits": { - "smithy.api#documentation": "

    The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.

    " + "smithy.api#documentation": "

    The optional input data to be supplied to the Lambda function.

    " } } }, @@ -4721,10 +4721,10 @@ "com.amazonaws.swf#ScheduleLambdaFunctionFailedEventAttributes": { "type": "structure", "members": { - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", + "name": { + "target": "com.amazonaws.swf#FunctionName", "traits": { - "smithy.api#documentation": "

    The ID of the LambdaFunctionCompleted event corresponding to the decision\n that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    ", + "smithy.api#documentation": "

    The name of the Lambda function.

    ", "smithy.api#required": {} } }, @@ -4735,17 +4735,17 @@ "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.swf#FunctionId", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID provided in the ScheduleLambdaFunction decision that failed.\n

    ", + "smithy.api#documentation": "

    The ID of the LambdaFunctionCompleted event corresponding to the decision\n that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    ", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.swf#FunctionName", + "id": { + "target": "com.amazonaws.swf#FunctionId", "traits": { - "smithy.api#documentation": "

    The name of the Lambda function.

    ", + "smithy.api#documentation": "

    The ID provided in the ScheduleLambdaFunction decision that failed.\n

    ", "smithy.api#required": {} } } @@ -4757,6 +4757,12 @@ "com.amazonaws.swf#SignalExternalWorkflowExecutionDecisionAttributes": { "type": "structure", "members": { + "runId": { + "target": "com.amazonaws.swf#WorkflowRunIdOptional", + "traits": { + "smithy.api#documentation": "

    The runId of the workflow execution to be signaled.

    " + } + }, "workflowId": { "target": "com.amazonaws.swf#WorkflowId", "traits": { @@ -4764,12 +4770,6 @@ "smithy.api#required": {} } }, - "runId": { - "target": "com.amazonaws.swf#WorkflowRunIdOptional", - "traits": { - "smithy.api#documentation": "

    The runId of the workflow execution to be signaled.

    " - } - }, "control": { "target": "com.amazonaws.swf#Data", "traits": { @@ -4813,23 +4813,25 @@ "com.amazonaws.swf#SignalExternalWorkflowExecutionFailedEventAttributes": { "type": "structure", "members": { - "control": { - "target": "com.amazonaws.swf#Data", + "cause": { + "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionFailedCause", "traits": { - "smithy.api#documentation": "

    The data attached to the event that the decider can use in subsequent workflow tasks.\n This data isn't sent to the workflow execution.

    " + "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", + "smithy.api#required": {} } }, - "decisionTaskCompletedEventId": { + "initiatedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "runId": { - "target": "com.amazonaws.swf#WorkflowRunIdOptional", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The runId of the external workflow execution that the signal was being delivered to.

    " + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#required": {} } }, "workflowId": { @@ -4839,18 +4841,16 @@ "smithy.api#required": {} } }, - "cause": { - "target": "com.amazonaws.swf#SignalExternalWorkflowExecutionFailedCause", + "control": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed\n because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows\n in the Amazon SWF Developer Guide.

    \n     ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The data attached to the event that the decider can use in subsequent workflow tasks.\n This data isn't sent to the workflow execution.

    " } }, - "initiatedEventId": { - "target": "com.amazonaws.swf#EventId", + "runId": { + "target": "com.amazonaws.swf#WorkflowRunIdOptional", "traits": { - "smithy.api#documentation": "

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The runId of the external workflow execution that the signal was being delivered to.

    " } } }, @@ -4867,16 +4867,18 @@ "smithy.api#documentation": "

    The runId of the external workflow execution to send the signal to.

    " } }, - "control": { - "target": "com.amazonaws.swf#Data", + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent decision tasks.

    " + "smithy.api#documentation": "

    The workflowId of the external workflow execution.

    ", + "smithy.api#required": {} } }, - "input": { - "target": "com.amazonaws.swf#Data", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The input provided to the signal.

    " + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#required": {} } }, "signalName": { @@ -4886,18 +4888,16 @@ "smithy.api#required": {} } }, - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", + "control": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The workflowId of the external workflow execution.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent decision tasks.

    " } }, - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", + "input": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The input provided to the signal.

    " } } }, @@ -4931,16 +4931,9 @@ "smithy.api#documentation": "

    Records a WorkflowExecutionSignaled event in the workflow execution\n history and creates a decision task for the workflow execution identified by the given domain,\n workflowId and runId. The event is recorded with the specified user defined signalName and\n input (if provided).

    \n\n \n

    If a runId isn't specified, then the WorkflowExecutionSignaled event is\n recorded in the history of the current open workflow with the matching workflowId in the\n domain.

    \n     \n\n \n

    If the specified workflow execution isn't open, this method fails with\n UnknownResource.

    \n     \n\n

    \n Access Control\n

    \n

    You can use IAM policies to control this action's access to Amazon SWF resources as\n follows:

    \n
      \n
    • \n

      Use a Resource element with the domain name to limit the action to\n only specified domains.

      \n
      • \n
    • \n

      Use an Action element to allow or deny permission to call this\n action.

      \n
      • \n
    • \n

      You cannot use an IAM policy to constrain this action's parameters.

      \n
      • \n
    \n

    If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.

    " } }, - "com.amazonaws.swf#SignalWorkflowExecutionInput": { - "type": "structure", - "members": { - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", - "traits": { - "smithy.api#documentation": "

    The workflowId of the workflow execution to signal.

    ", - "smithy.api#required": {} - } - }, + "com.amazonaws.swf#SignalWorkflowExecutionInput": { + "type": "structure", + "members": { "domain": { "target": "com.amazonaws.swf#DomainName", "traits": { @@ -4955,16 +4948,23 @@ "smithy.api#required": {} } }, + "runId": { + "target": "com.amazonaws.swf#WorkflowRunIdOptional", + "traits": { + "smithy.api#documentation": "

    The runId of the workflow execution to signal.

    " + } + }, "input": { "target": "com.amazonaws.swf#Data", "traits": { "smithy.api#documentation": "

    Data to attach to the WorkflowExecutionSignaled event in the target\n workflow execution's history.

    " } }, - "runId": { - "target": "com.amazonaws.swf#WorkflowRunIdOptional", + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "

    The runId of the workflow execution to signal.

    " + "smithy.api#documentation": "

    The workflowId of the workflow execution to signal.

    ", + "smithy.api#required": {} } } } @@ -5090,7 +5090,7 @@ "sdkId": "SWF", "arnNamespace": "swf", "cloudFormationName": "SWF", - "cloudTrailEventSource": "model.service.swf.amazonaws.com" + "cloudTrailEventSource": "swf.amazonaws.com" }, "aws.auth#sigv4": { "name": "swf" @@ -5106,10 +5106,16 @@ "com.amazonaws.swf#StartChildWorkflowExecutionDecisionAttributes": { "type": "structure", "members": { - "taskStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "taskPriority": { + "target": "com.amazonaws.swf#TaskPriority", "traits": { - "smithy.api#documentation": "

    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the\n defaultTaskStartToCloseTimout specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    \n     " + "smithy.api#documentation": "

    \n A task priority that, if set, specifies the priority for a decision task of this workflow\n execution. This overrides the defaultTaskPriority specified when registering the workflow type.\n Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + } + }, + "taskList": { + "target": "com.amazonaws.swf#TaskList", + "traits": { + "smithy.api#documentation": "

    The name of the task list to be used for decision tasks of the child workflow execution.

    \n \n

    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

    \n     \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " } }, "workflowType": { @@ -5125,29 +5131,28 @@ "smithy.api#documentation": "

    The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

    " } }, - "taskPriority": { - "target": "com.amazonaws.swf#TaskPriority", + "taskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    \n A task priority that, if set, specifies the priority for a decision task of this workflow\n execution. This overrides the defaultTaskPriority specified when registering the workflow type.\n Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + "smithy.api#documentation": "

    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the\n defaultTaskStartToCloseTimout specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    \n     " } }, - "executionStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "childPolicy": { + "target": "com.amazonaws.swf#ChildPolicy", "traits": { - "smithy.api#documentation": "

    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

    \n     " + "smithy.api#documentation": "

    \n If set, specifies the policy to use for the child workflow executions if the workflow execution\n being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an\n expired timeout. This policy overrides the default child policy specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    \n \n

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    \n     " } }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", + "tagList": { + "target": "com.amazonaws.swf#TagList", "traits": { - "smithy.api#documentation": "

    The name of the task list to be used for decision tasks of the child workflow execution.

    \n \n

    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

    \n     \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " + "smithy.api#documentation": "

    The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can\n list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or\n ListClosedWorkflowExecutions and specifying a TagFilter.

    " } }, - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", + "input": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    \n The workflowId of the workflow execution.

    \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The input to be provided to the workflow execution.

    " } }, "lambdaRole": { @@ -5156,22 +5161,17 @@ "smithy.api#documentation": "

    The IAM role attached to the child workflow execution.

    " } }, - "input": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    The input to be provided to the workflow execution.

    " - } - }, - "tagList": { - "target": "com.amazonaws.swf#TagList", + "executionStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can\n list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or\n ListClosedWorkflowExecutions and specifying a TagFilter.

    " + "smithy.api#documentation": "

    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    \n \n

    An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

    \n     " } }, - "childPolicy": { - "target": "com.amazonaws.swf#ChildPolicy", + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "

    \n If set, specifies the policy to use for the child workflow executions if the workflow execution\n being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an\n expired timeout. This policy overrides the default child policy specified when registering the workflow type using\n RegisterWorkflowType.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    \n \n

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    \n     " + "smithy.api#documentation": "

    \n The workflowId of the workflow execution.

    \n

    The specified string must not start or end with whitespace. It must not contain a :\n (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    ", + "smithy.api#required": {} } } }, @@ -5222,20 +5222,6 @@ "com.amazonaws.swf#StartChildWorkflowExecutionFailedEventAttributes": { "type": "structure", "members": { - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", - "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution \n Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.

    ", - "smithy.api#required": {} - } - }, - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", - "traits": { - "smithy.api#documentation": "

    The workflowId of the child workflow execution.

    ", - "smithy.api#required": {} - } - }, "cause": { "target": "com.amazonaws.swf#StartChildWorkflowExecutionFailedCause", "traits": { @@ -5250,16 +5236,30 @@ "smithy.api#required": {} } }, + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", + "traits": { + "smithy.api#documentation": "

    The workflow type provided in the StartChildWorkflowExecution \n Decision that failed.

    ", + "smithy.api#required": {} + } + }, "control": { "target": "com.amazonaws.swf#Data", "traits": { "smithy.api#documentation": "

    The data attached to the event that the decider can use in subsequent workflow tasks.\n This data isn't sent to the child workflow execution.

    " } }, - "workflowType": { - "target": "com.amazonaws.swf#WorkflowType", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The workflow type provided in the StartChildWorkflowExecution \n Decision that failed.

    ", + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution \n Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.

    ", + "smithy.api#required": {} + } + }, + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", + "traits": { + "smithy.api#documentation": "

    The workflowId of the child workflow execution.

    ", "smithy.api#required": {} } } @@ -5271,12 +5271,6 @@ "com.amazonaws.swf#StartChildWorkflowExecutionInitiatedEventAttributes": { "type": "structure", "members": { - "tagList": { - "target": "com.amazonaws.swf#TagList", - "traits": { - "smithy.api#documentation": "

    The list of tags to associated with the child workflow execution.

    " - } - }, "input": { "target": "com.amazonaws.swf#Data", "traits": { @@ -5289,23 +5283,10 @@ "smithy.api#documentation": "

    The IAM role to attach to the child workflow execution.

    " } }, - "executionStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", - "traits": { - "smithy.api#documentation": "

    The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " - } - }, - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", - "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n StartChildWorkflowExecution \n Decision to request this child workflow execution. This\n information can be useful for diagnosing problems by tracing back the cause of events.

    ", - "smithy.api#required": {} - } - }, - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", + "childPolicy": { + "target": "com.amazonaws.swf#ChildPolicy", "traits": { - "smithy.api#documentation": "

    The workflowId of the child workflow execution.

    ", + "smithy.api#documentation": "

    The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the\n TerminateWorkflowExecution action or due to an expired timeout.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -5315,10 +5296,10 @@ "smithy.api#documentation": "

    \n The priority assigned for the decision tasks for this workflow execution.\n Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " } }, - "control": { - "target": "com.amazonaws.swf#Data", + "taskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

    " + "smithy.api#documentation": "

    The maximum duration allowed for the decision tasks for this workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, "taskList": { @@ -5328,6 +5309,12 @@ "smithy.api#required": {} } }, + "control": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

    " + } + }, "workflowType": { "target": "com.amazonaws.swf#WorkflowType", "traits": { @@ -5335,18 +5322,31 @@ "smithy.api#required": {} } }, - "taskStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The maximum duration allowed for the decision tasks for this workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n StartChildWorkflowExecution \n Decision to request this child workflow execution. This\n information can be useful for diagnosing problems by tracing back the cause of events.

    ", + "smithy.api#required": {} } }, - "childPolicy": { - "target": "com.amazonaws.swf#ChildPolicy", + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "

    The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the\n TerminateWorkflowExecution action or due to an expired timeout.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The workflowId of the child workflow execution.

    ", "smithy.api#required": {} } + }, + "executionStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", + "traits": { + "smithy.api#documentation": "

    The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + } + }, + "tagList": { + "target": "com.amazonaws.swf#TagList", + "traits": { + "smithy.api#documentation": "

    The list of tags to associated with the child workflow execution.

    " + } } }, "traits": { @@ -5372,17 +5372,17 @@ "smithy.api#documentation": "

    The ID of the ActivityTaskScheduled event that was recorded when this\n activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " } }, - "message": { - "target": "com.amazonaws.swf#CauseMessage", - "traits": { - "smithy.api#documentation": "

    A description that can help diagnose the cause of the fault.

    " - } - }, "cause": { "target": "com.amazonaws.swf#StartLambdaFunctionFailedCause", "traits": { "smithy.api#documentation": "

    The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    \n \n

    If cause is set to OPERATION_NOT_PERMITTED, the decision\n failed because the IAM role attached to the execution lacked sufficient permissions. For\n details and example IAM policies, see Lambda Tasks in the\n Amazon SWF Developer Guide.

    \n     " } + }, + "message": { + "target": "com.amazonaws.swf#CauseMessage", + "traits": { + "smithy.api#documentation": "

    A description that can help diagnose the cause of the fault.

    " + } } }, "traits": { @@ -5399,18 +5399,18 @@ "smithy.api#required": {} } }, + "control": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The data attached to the event that can be used by the decider in subsequent workflow tasks.

    " + } + }, "startToFireTimeout": { "target": "com.amazonaws.swf#DurationInSeconds", "traits": { "smithy.api#documentation": "

    \n The duration to wait before firing the timer.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0.

    ", "smithy.api#required": {} } - }, - "control": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    The data attached to the event that can be used by the decider in subsequent workflow tasks.

    " - } } }, "traits": { @@ -5439,17 +5439,17 @@ "com.amazonaws.swf#StartTimerFailedEventAttributes": { "type": "structure", "members": { - "timerId": { - "target": "com.amazonaws.swf#TimerId", + "decisionTaskCompletedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The timerId provided in the StartTimer decision that failed.

    ", + "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "decisionTaskCompletedEventId": { - "target": "com.amazonaws.swf#EventId", + "timerId": { + "target": "com.amazonaws.swf#TimerId", "traits": { - "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The timerId provided in the StartTimer decision that failed.

    ", "smithy.api#required": {} } }, @@ -5500,6 +5500,12 @@ "com.amazonaws.swf#StartWorkflowExecutionInput": { "type": "structure", "members": { + "input": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The input for the workflow execution. This is a free form string which should be\n meaningful to the workflow you are starting. This input is made available to the\n new workflow execution in the WorkflowExecutionStarted history event.

    " + } + }, "lambdaRole": { "target": "com.amazonaws.swf#Arn", "traits": { @@ -5518,17 +5524,10 @@ "smithy.api#documentation": "

    The total duration for this workflow execution. This overrides the\n defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    \n\n

    The duration is specified in seconds; an integer greater than or equal to\n 0. Exceeding this limit causes the workflow execution to time out. Unlike some\n of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this\n timeout; there is a one-year max limit on the time that a workflow execution can\n run.

    \n\n \n

    An execution start-to-close timeout must be specified either through this parameter\n or as a default when the workflow type is registered. If neither this parameter nor a\n default execution start-to-close timeout is specified, a fault is returned.

    \n     " } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", - "traits": { - "smithy.api#documentation": "

    The name of the domain in which the workflow execution is created.

    ", - "smithy.api#required": {} - } - }, - "input": { - "target": "com.amazonaws.swf#Data", + "taskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    The input for the workflow execution. This is a free form string which should be\n meaningful to the workflow you are starting. This input is made available to the\n new workflow execution in the WorkflowExecutionStarted history event.

    " + "smithy.api#documentation": "

    The task list to use for the decision tasks generated for this workflow execution. This\n overrides the defaultTaskList specified when registering the workflow\n type.

    \n \n

    A task list for this workflow execution must be specified either as a default for the\n workflow type or through this parameter. If neither this parameter is set nor a default task\n list was specified at registration time then a fault is returned.

    \n     \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    " } }, "workflowId": { @@ -5538,6 +5537,12 @@ "smithy.api#required": {} } }, + "taskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", + "traits": { + "smithy.api#documentation": "

    Specifies the maximum duration of decision tasks for this workflow execution. This\n parameter overrides the defaultTaskStartToCloseTimout specified when registering\n the workflow type using RegisterWorkflowType.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    \n \n

    A task start-to-close timeout for this workflow execution must be specified either as\n a default for the workflow type or through this parameter. If neither this parameter is set\n nor a default task start-to-close timeout was specified at registration time then a fault is\n returned.

    \n     " + } + }, "workflowType": { "target": "com.amazonaws.swf#WorkflowType", "traits": { @@ -5545,28 +5550,23 @@ "smithy.api#required": {} } }, - "childPolicy": { - "target": "com.amazonaws.swf#ChildPolicy", - "traits": { - "smithy.api#documentation": "

    If set, specifies the policy to use for the child workflow executions of this workflow\n execution if it is terminated, by calling the TerminateWorkflowExecution\n action explicitly or due to an expired timeout. This policy overrides the default child policy\n specified when registering the workflow type using RegisterWorkflowType.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its\n history. It is up to the decider to take appropriate actions when it receives an execution\n history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to\n run.

      \n
      • \n
    \n \n

    A child policy for this workflow execution must be specified either as a default for\n the workflow type or through this parameter. If neither this parameter is set nor a default\n child policy was specified at registration time then a fault is returned.

    \n     " - } - }, - "taskStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", - "traits": { - "smithy.api#documentation": "

    Specifies the maximum duration of decision tasks for this workflow execution. This\n parameter overrides the defaultTaskStartToCloseTimout specified when registering\n the workflow type using RegisterWorkflowType.

    \n

    The duration is specified in seconds, an integer greater than or equal to\n 0. You can use NONE to specify unlimited duration.

    \n \n

    A task start-to-close timeout for this workflow execution must be specified either as\n a default for the workflow type or through this parameter. If neither this parameter is set\n nor a default task start-to-close timeout was specified at registration time then a fault is\n returned.

    \n     " - } - }, "taskPriority": { "target": "com.amazonaws.swf#TaskPriority", "traits": { "smithy.api#documentation": "

    The task priority to use for this workflow execution. This overrides any default\n priority that was assigned when the workflow type was registered. If not set, then the default\n task priority for the workflow type is used. Valid values are integers that range from Java's\n Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).\n Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task\n Priority in the Amazon SWF Developer Guide.

    " } }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The task list to use for the decision tasks generated for this workflow execution. This\n overrides the defaultTaskList specified when registering the workflow\n type.

    \n \n

    A task list for this workflow execution must be specified either as a default for the\n workflow type or through this parameter. If neither this parameter is set nor a default task\n list was specified at registration time then a fault is returned.

    \n     \n \n

    The specified string must not start or end with whitespace. It must not contain a\n : (colon), / (slash), | (vertical bar), or any\n control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must\n not be the literal string arn.

    " + "smithy.api#documentation": "

    The name of the domain in which the workflow execution is created.

    ", + "smithy.api#required": {} + } + }, + "childPolicy": { + "target": "com.amazonaws.swf#ChildPolicy", + "traits": { + "smithy.api#documentation": "

    If set, specifies the policy to use for the child workflow executions of this workflow\n execution if it is terminated, by calling the TerminateWorkflowExecution\n action explicitly or due to an expired timeout. This policy overrides the default child policy\n specified when registering the workflow type using RegisterWorkflowType.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its\n history. It is up to the decider to take appropriate actions when it receives an execution\n history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to\n run.

      \n
      • \n
    \n \n

    A child policy for this workflow execution must be specified either as a default for\n the workflow type or through this parameter. If neither this parameter is set nor a default\n child policy was specified at registration time then a fault is returned.

    \n     " } } } @@ -5633,17 +5633,17 @@ "com.amazonaws.swf#TagResourceInput": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.swf#Arn", + "tags": { + "target": "com.amazonaws.swf#ResourceTagList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    ", + "smithy.api#documentation": "

    The list of tags to add to a domain.

    \n

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    ", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.swf#ResourceTagList", + "resourceArn": { + "target": "com.amazonaws.swf#Arn", "traits": { - "smithy.api#documentation": "

    The list of tags to add to a domain.

    \n

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    ", "smithy.api#required": {} } } @@ -5711,17 +5711,23 @@ "smithy.api#documentation": "

    A descriptive reason for terminating the workflow execution.

    " } }, - "details": { - "target": "com.amazonaws.swf#Data", + "workflowId": { + "target": "com.amazonaws.swf#WorkflowId", "traits": { - "smithy.api#documentation": "

    Details for terminating the workflow execution.

    " + "smithy.api#documentation": "

    The workflowId of the workflow execution to terminate.

    ", + "smithy.api#required": {} } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", + "runId": { + "target": "com.amazonaws.swf#WorkflowRunIdOptional", "traits": { - "smithy.api#documentation": "

    The domain of the workflow execution to terminate.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The runId of the workflow execution to terminate.

    " + } + }, + "details": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    Details for terminating the workflow execution.

    " } }, "childPolicy": { @@ -5730,28 +5736,22 @@ "smithy.api#documentation": "

    If set, specifies the policy to use for the child workflow executions of the workflow\n execution being terminated. This policy overrides the child policy specified for the workflow\n execution at registration time or when starting the execution.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its\n history. It is up to the decider to take appropriate actions when it receives an execution\n history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to\n run.

      \n
      • \n
    \n \n

    A child policy for this workflow execution must be specified either as a default for\n the workflow type or through this parameter. If neither this parameter is set nor a default\n child policy was specified at registration time then a fault is returned.

    \n     " } }, - "workflowId": { - "target": "com.amazonaws.swf#WorkflowId", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The workflowId of the workflow execution to terminate.

    ", + "smithy.api#documentation": "

    The domain of the workflow execution to terminate.

    ", "smithy.api#required": {} } - }, - "runId": { - "target": "com.amazonaws.swf#WorkflowRunIdOptional", - "traits": { - "smithy.api#documentation": "

    The runId of the workflow execution to terminate.

    " - } } } }, "com.amazonaws.swf#TimerCanceledEventAttributes": { "type": "structure", "members": { - "startedEventId": { - "target": "com.amazonaws.swf#EventId", + "timerId": { + "target": "com.amazonaws.swf#TimerId", "traits": { - "smithy.api#documentation": "

    The ID of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The unique ID of the timer that was canceled.

    ", "smithy.api#required": {} } }, @@ -5762,10 +5762,10 @@ "smithy.api#required": {} } }, - "timerId": { - "target": "com.amazonaws.swf#TimerId", + "startedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The unique ID of the timer that was canceled.

    ", + "smithy.api#documentation": "

    The ID of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } } @@ -5777,17 +5777,17 @@ "com.amazonaws.swf#TimerFiredEventAttributes": { "type": "structure", "members": { - "timerId": { - "target": "com.amazonaws.swf#TimerId", + "startedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The unique ID of the timer that fired.

    ", + "smithy.api#documentation": "

    The ID of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } }, - "startedEventId": { - "target": "com.amazonaws.swf#EventId", + "timerId": { + "target": "com.amazonaws.swf#TimerId", "traits": { - "smithy.api#documentation": "

    The ID of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", + "smithy.api#documentation": "

    The unique ID of the timer that fired.

    ", "smithy.api#required": {} } } @@ -5808,12 +5808,6 @@ "com.amazonaws.swf#TimerStartedEventAttributes": { "type": "structure", "members": { - "control": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent workflow tasks.

    " - } - }, "timerId": { "target": "com.amazonaws.swf#TimerId", "traits": { @@ -5821,6 +5815,13 @@ "smithy.api#required": {} } }, + "startToFireTimeout": { + "target": "com.amazonaws.swf#DurationInSeconds", + "traits": { + "smithy.api#documentation": "

    The duration of time after which the timer fires.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0.

    ", + "smithy.api#required": {} + } + }, "decisionTaskCompletedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { @@ -5828,11 +5829,10 @@ "smithy.api#required": {} } }, - "startToFireTimeout": { - "target": "com.amazonaws.swf#DurationInSeconds", + "control": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The duration of time after which the timer fires.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Data attached to the event that can be used by the decider in subsequent workflow tasks.

    " } } }, @@ -5912,17 +5912,17 @@ "com.amazonaws.swf#UndeprecateActivityTypeInput": { "type": "structure", "members": { - "activityType": { - "target": "com.amazonaws.swf#ActivityType", + "domain": { + "target": "com.amazonaws.swf#DomainName", "traits": { - "smithy.api#documentation": "

    The activity type to undeprecate.

    ", + "smithy.api#documentation": "

    The name of the domain of the deprecated activity type.

    ", "smithy.api#required": {} } }, - "domain": { - "target": "com.amazonaws.swf#DomainName", + "activityType": { + "target": "com.amazonaws.swf#ActivityType", "traits": { - "smithy.api#documentation": "

    The name of the domain of the deprecated activity type.

    ", + "smithy.api#documentation": "

    The activity type to undeprecate.

    ", "smithy.api#required": {} } } @@ -6037,17 +6037,17 @@ "com.amazonaws.swf#UntagResourceInput": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.swf#Arn", + "tagKeys": { + "target": "com.amazonaws.swf#ResourceTagKeyList", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    ", + "smithy.api#documentation": "

    The list of tags to remove from the Amazon SWF domain.

    ", "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.swf#ResourceTagKeyList", + "resourceArn": { + "target": "com.amazonaws.swf#Arn", "traits": { - "smithy.api#documentation": "

    The list of tags to remove from the Amazon SWF domain.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    ", "smithy.api#required": {} } } @@ -6127,17 +6127,17 @@ "smithy.api#documentation": "

    The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event\n with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    " } }, - "externalWorkflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", - "traits": { - "smithy.api#documentation": "

    The external workflow execution for which the cancellation was requested.

    " - } - }, "cause": { "target": "com.amazonaws.swf#WorkflowExecutionCancelRequestedCause", "traits": { "smithy.api#documentation": "

    If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

    " } + }, + "externalWorkflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", + "traits": { + "smithy.api#documentation": "

    The external workflow execution for which the cancellation was requested.

    " + } } }, "traits": { @@ -6168,18 +6168,18 @@ "com.amazonaws.swf#WorkflowExecutionCompletedEventAttributes": { "type": "structure", "members": { + "result": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The result produced by the workflow execution upon successful completion.

    " + } + }, "decisionTaskCompletedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { "smithy.api#documentation": "

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the\n CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    ", "smithy.api#required": {} } - }, - "result": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    The result produced by the workflow execution upon successful completion.

    " - } } }, "traits": { @@ -6196,10 +6196,17 @@ "smithy.api#required": {} } }, - "lambdaRole": { - "target": "com.amazonaws.swf#Arn", + "executionStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSeconds", "traits": { - "smithy.api#documentation": "

    The IAM role attached to the child workflow execution.

    " + "smithy.api#documentation": "

    The total duration for this workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    ", + "smithy.api#required": {} + } + }, + "taskPriority": { + "target": "com.amazonaws.swf#TaskPriority", + "traits": { + "smithy.api#documentation": "

    The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " } }, "taskStartToCloseTimeout": { @@ -6209,10 +6216,10 @@ "smithy.api#required": {} } }, - "taskPriority": { - "target": "com.amazonaws.swf#TaskPriority", + "lambdaRole": { + "target": "com.amazonaws.swf#Arn", "traits": { - "smithy.api#documentation": "

    The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + "smithy.api#documentation": "

    The IAM role attached to the child workflow execution.

    " } }, "taskList": { @@ -6221,13 +6228,6 @@ "smithy.api#documentation": "

    The task list used for the decision tasks generated for this workflow execution.

    ", "smithy.api#required": {} } - }, - "executionStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSeconds", - "traits": { - "smithy.api#documentation": "

    The total duration for this workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -6237,13 +6237,6 @@ "com.amazonaws.swf#WorkflowExecutionContinuedAsNewEventAttributes": { "type": "structure", "members": { - "childPolicy": { - "target": "com.amazonaws.swf#ChildPolicy", - "traits": { - "smithy.api#documentation": "

    The policy to use for the child workflow executions of the new execution if it is terminated by calling the\n TerminateWorkflowExecution action explicitly or due to an expired timeout.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    ", - "smithy.api#required": {} - } - }, "workflowType": { "target": "com.amazonaws.swf#WorkflowType", "traits": { @@ -6251,18 +6244,6 @@ "smithy.api#required": {} } }, - "taskStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", - "traits": { - "smithy.api#documentation": "

    The maximum duration of decision tasks for the new workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " - } - }, - "taskPriority": { - "target": "com.amazonaws.swf#TaskPriority", - "traits": { - "smithy.api#documentation": "

    The priority of the task to use for the decisions of the new (continued) workflow\n execution.

    " - } - }, "decisionTaskCompletedEventId": { "target": "com.amazonaws.swf#EventId", "traits": { @@ -6270,16 +6251,16 @@ "smithy.api#required": {} } }, - "input": { - "target": "com.amazonaws.swf#Data", + "taskPriority": { + "target": "com.amazonaws.swf#TaskPriority", "traits": { - "smithy.api#documentation": "

    The input provided to the new workflow execution.

    " + "smithy.api#documentation": "

    The priority of the task to use for the decisions of the new (continued) workflow\n execution.

    " } }, - "lambdaRole": { - "target": "com.amazonaws.swf#Arn", + "taskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The IAM role to attach to the new (continued) workflow execution.

    " + "smithy.api#documentation": "

    The maximum duration of decision tasks for the new workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, "executionStartToCloseTimeout": { @@ -6288,17 +6269,17 @@ "smithy.api#documentation": "

    The total duration allowed for the new workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, - "newExecutionRunId": { - "target": "com.amazonaws.swf#WorkflowRunId", + "taskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    The runId of the new workflow execution.

    ", + "smithy.api#documentation": "

    The task list to use for the decisions of the new (continued) workflow\n execution.

    ", "smithy.api#required": {} } }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", + "newExecutionRunId": { + "target": "com.amazonaws.swf#WorkflowRunId", "traits": { - "smithy.api#documentation": "

    The task list to use for the decisions of the new (continued) workflow\n execution.

    ", + "smithy.api#documentation": "

    The runId of the new workflow execution.

    ", "smithy.api#required": {} } }, @@ -6307,6 +6288,25 @@ "traits": { "smithy.api#documentation": "

    The list of tags associated with the new workflow execution.

    " } + }, + "lambdaRole": { + "target": "com.amazonaws.swf#Arn", + "traits": { + "smithy.api#documentation": "

    The IAM role to attach to the new (continued) workflow execution.

    " + } + }, + "input": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The input provided to the new workflow execution.

    " + } + }, + "childPolicy": { + "target": "com.amazonaws.swf#ChildPolicy", + "traits": { + "smithy.api#documentation": "

    The policy to use for the child workflow executions of the new execution if it is terminated by calling the\n TerminateWorkflowExecution action explicitly or due to an expired timeout.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    ", + "smithy.api#required": {} + } } }, "traits": { @@ -6316,18 +6316,18 @@ "com.amazonaws.swf#WorkflowExecutionCount": { "type": "structure", "members": { - "truncated": { - "target": "com.amazonaws.swf#Truncated", - "traits": { - "smithy.api#documentation": "

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    " - } - }, "count": { "target": "com.amazonaws.swf#Count", "traits": { "smithy.api#documentation": "

    The number of workflow executions.

    ", "smithy.api#required": {} } + }, + "truncated": { + "target": "com.amazonaws.swf#Truncated", + "traits": { + "smithy.api#documentation": "

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    " + } } }, "traits": { @@ -6337,26 +6337,25 @@ "com.amazonaws.swf#WorkflowExecutionDetail": { "type": "structure", "members": { - "executionConfiguration": { - "target": "com.amazonaws.swf#WorkflowExecutionConfiguration", - "traits": { - "smithy.api#documentation": "

    The configuration settings for this workflow execution including timeout values, tasklist etc.

    ", - "smithy.api#required": {} - } - }, "latestActivityTaskTimestamp": { "target": "com.amazonaws.swf#Timestamp", "traits": { "smithy.api#documentation": "

    The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

    " } }, - "executionInfo": { - "target": "com.amazonaws.swf#WorkflowExecutionInfo", + "executionConfiguration": { + "target": "com.amazonaws.swf#WorkflowExecutionConfiguration", "traits": { - "smithy.api#documentation": "

    Information about the workflow execution.

    ", + "smithy.api#documentation": "

    The configuration settings for this workflow execution including timeout values, tasklist etc.

    ", "smithy.api#required": {} } }, + "latestExecutionContext": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The latest executionContext provided by the decider for this workflow execution. A decider can provide an\n executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

    " + } + }, "openCounts": { "target": "com.amazonaws.swf#WorkflowExecutionOpenCounts", "traits": { @@ -6364,10 +6363,11 @@ "smithy.api#required": {} } }, - "latestExecutionContext": { - "target": "com.amazonaws.swf#Data", + "executionInfo": { + "target": "com.amazonaws.swf#WorkflowExecutionInfo", "traits": { - "smithy.api#documentation": "

    The latest executionContext provided by the decider for this workflow execution. A decider can provide an\n executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

    " + "smithy.api#documentation": "

    Information about the workflow execution.

    ", + "smithy.api#required": {} } } }, @@ -6420,62 +6420,62 @@ "com.amazonaws.swf#WorkflowExecutionInfo": { "type": "structure", "members": { - "closeStatus": { - "target": "com.amazonaws.swf#CloseStatus", - "traits": { - "smithy.api#documentation": "

    If the execution status is closed then this specifies how the execution was closed:

    \n
      \n
    • \n

      \n COMPLETED – the execution was successfully completed.

      \n
      • \n
    • \n

      \n CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean\n up before the execution is closed.

      \n
      • \n
    • \n

      \n TERMINATED – the execution was force terminated.

      \n
      • \n
    • \n

      \n FAILED – the execution failed to complete.

      \n
      • \n
    • \n

      \n TIMED_OUT – the execution did not complete in the alloted time and was automatically timed\n out.

      \n
      • \n
    • \n

      \n CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was\n completed and a new execution was started to carry on the workflow.

      \n
      • \n
    " - } - }, "parent": { "target": "com.amazonaws.swf#WorkflowExecution", "traits": { "smithy.api#documentation": "

    If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

    " } }, - "executionStatus": { - "target": "com.amazonaws.swf#ExecutionStatus", + "tagList": { + "target": "com.amazonaws.swf#TagList", "traits": { - "smithy.api#documentation": "

    The current status of the execution.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

    " } }, - "workflowType": { - "target": "com.amazonaws.swf#WorkflowType", + "execution": { + "target": "com.amazonaws.swf#WorkflowExecution", "traits": { - "smithy.api#documentation": "

    The type of the workflow execution.

    ", + "smithy.api#documentation": "

    The workflow execution this information is about.

    ", "smithy.api#required": {} } }, - "cancelRequested": { - "target": "com.amazonaws.swf#Canceled", + "closeStatus": { + "target": "com.amazonaws.swf#CloseStatus", "traits": { - "smithy.api#documentation": "

    Set to true if a cancellation is requested for this workflow execution.

    " + "smithy.api#documentation": "

    If the execution status is closed then this specifies how the execution was closed:

    \n
      \n
    • \n

      \n COMPLETED – the execution was successfully completed.

      \n
      • \n
    • \n

      \n CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean\n up before the execution is closed.

      \n
      • \n
    • \n

      \n TERMINATED – the execution was force terminated.

      \n
      • \n
    • \n

      \n FAILED – the execution failed to complete.

      \n
      • \n
    • \n

      \n TIMED_OUT – the execution did not complete in the alloted time and was automatically timed\n out.

      \n
      • \n
    • \n

      \n CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was\n completed and a new execution was started to carry on the workflow.

      \n
      • \n
    " } }, - "startTimestamp": { + "closeTimestamp": { "target": "com.amazonaws.swf#Timestamp", "traits": { - "smithy.api#documentation": "

    The time when the execution was started.

    ", + "smithy.api#documentation": "

    The time when the workflow execution was closed. Set only if the execution status is CLOSED.

    " + } + }, + "executionStatus": { + "target": "com.amazonaws.swf#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

    The current status of the execution.

    ", "smithy.api#required": {} } }, - "execution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "startTimestamp": { + "target": "com.amazonaws.swf#Timestamp", "traits": { - "smithy.api#documentation": "

    The workflow execution this information is about.

    ", + "smithy.api#documentation": "

    The time when the execution was started.

    ", "smithy.api#required": {} } }, - "tagList": { - "target": "com.amazonaws.swf#TagList", + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", "traits": { - "smithy.api#documentation": "

    The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

    " + "smithy.api#documentation": "

    The type of the workflow execution.

    ", + "smithy.api#required": {} } }, - "closeTimestamp": { - "target": "com.amazonaws.swf#Timestamp", + "cancelRequested": { + "target": "com.amazonaws.swf#Canceled", "traits": { - "smithy.api#documentation": "

    The time when the workflow execution was closed. Set only if the execution status is CLOSED.

    " + "smithy.api#documentation": "

    Set to true if a cancellation is requested for this workflow execution.

    " } } }, @@ -6492,18 +6492,18 @@ "com.amazonaws.swf#WorkflowExecutionInfos": { "type": "structure", "members": { + "nextPageToken": { + "target": "com.amazonaws.swf#PageToken", + "traits": { + "smithy.api#documentation": "

    If a NextPageToken was returned by a previous call, there are more\n results available. To retrieve the next page of results, make the call again using the returned token in\n nextPageToken. Keep all other arguments unchanged.

    \n

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + } + }, "executionInfos": { "target": "com.amazonaws.swf#WorkflowExecutionInfoList", "traits": { "smithy.api#documentation": "

    The list of workflow information structures.

    ", "smithy.api#required": {} } - }, - "nextPageToken": { - "target": "com.amazonaws.swf#PageToken", - "traits": { - "smithy.api#documentation": "

    If a NextPageToken was returned by a previous call, there are more\n results available. To retrieve the next page of results, make the call again using the returned token in\n nextPageToken. Keep all other arguments unchanged.

    \n

    The configured maximumPageSize determines how many results can be returned in a single call.

    " - } } }, "traits": { @@ -6520,10 +6520,10 @@ "smithy.api#required": {} } }, - "openActivityTasks": { + "openChildWorkflowExecutions": { "target": "com.amazonaws.swf#Count", "traits": { - "smithy.api#documentation": "

    The count of activity tasks whose status is OPEN.

    ", + "smithy.api#documentation": "

    The count of child workflow executions whose status is OPEN.

    ", "smithy.api#required": {} } }, @@ -6540,10 +6540,10 @@ "smithy.api#required": {} } }, - "openChildWorkflowExecutions": { + "openActivityTasks": { "target": "com.amazonaws.swf#Count", "traits": { - "smithy.api#documentation": "

    The count of child workflow executions whose status is OPEN.

    ", + "smithy.api#documentation": "

    The count of activity tasks whose status is OPEN.

    ", "smithy.api#required": {} } } @@ -6555,16 +6555,16 @@ "com.amazonaws.swf#WorkflowExecutionSignaledEventAttributes": { "type": "structure", "members": { - "externalInitiatedEventId": { - "target": "com.amazonaws.swf#EventId", + "input": { + "target": "com.amazonaws.swf#Data", "traits": { - "smithy.api#documentation": "

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can\n be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event. This field is set only if\n the signal was initiated by another workflow execution.

    " + "smithy.api#documentation": "

    The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.

    " } }, - "externalWorkflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "externalInitiatedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

    " + "smithy.api#documentation": "

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can\n be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event. This field is set only if\n the signal was initiated by another workflow execution.

    " } }, "signalName": { @@ -6574,10 +6574,10 @@ "smithy.api#required": {} } }, - "input": { - "target": "com.amazonaws.swf#Data", + "externalWorkflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", "traits": { - "smithy.api#documentation": "

    The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.

    " + "smithy.api#documentation": "

    The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

    " } } }, @@ -6588,6 +6588,18 @@ "com.amazonaws.swf#WorkflowExecutionStartedEventAttributes": { "type": "structure", "members": { + "input": { + "target": "com.amazonaws.swf#Data", + "traits": { + "smithy.api#documentation": "

    The input provided to the workflow execution.

    " + } + }, + "tagList": { + "target": "com.amazonaws.swf#TagList", + "traits": { + "smithy.api#documentation": "

    The list of tags associated with this workflow execution. An execution can have up to 5 tags.

    " + } + }, "lambdaRole": { "target": "com.amazonaws.swf#Arn", "traits": { @@ -6600,17 +6612,10 @@ "smithy.api#documentation": "

    If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it\n contains the runId of the previous workflow execution that was closed and continued as this\n execution.

    " } }, - "input": { - "target": "com.amazonaws.swf#Data", - "traits": { - "smithy.api#documentation": "

    The input provided to the workflow execution.

    " - } - }, - "childPolicy": { - "target": "com.amazonaws.swf#ChildPolicy", + "executionStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The policy to use for the child workflow executions if this workflow execution is terminated, by calling the\n TerminateWorkflowExecution action explicitly or due to an expired timeout.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The maximum duration for this workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, "taskPriority": { @@ -6619,22 +6624,22 @@ "smithy.api#documentation": "

    The priority of the decision tasks in the workflow execution.

    " } }, - "taskStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "parentInitiatedEventId": { + "target": "com.amazonaws.swf#EventId", "traits": { - "smithy.api#documentation": "

    The maximum duration of decision tasks for this workflow type.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this workflow execution. The source event with\n this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    " } }, - "parentWorkflowExecution": { - "target": "com.amazonaws.swf#WorkflowExecution", + "taskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", "traits": { - "smithy.api#documentation": "

    The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

    " + "smithy.api#documentation": "

    The maximum duration of decision tasks for this workflow type.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, - "taskList": { - "target": "com.amazonaws.swf#TaskList", + "childPolicy": { + "target": "com.amazonaws.swf#ChildPolicy", "traits": { - "smithy.api#documentation": "

    The name of the task list for scheduling the decision tasks for this workflow execution.

    ", + "smithy.api#documentation": "

    The policy to use for the child workflow executions if this workflow execution is terminated, by calling the\n TerminateWorkflowExecution action explicitly or due to an expired timeout.

    \n

    The supported child policies are:

    \n
      \n
    • \n

      \n TERMINATE – The child executions are terminated.

      \n
      • \n
    • \n

      \n REQUEST_CANCEL – A request to cancel is attempted for each child\n execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider\n to take appropriate actions when it receives an execution history with this event.

      \n
      • \n
    • \n

      \n ABANDON – No action is taken. The child executions continue to run.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -6645,22 +6650,17 @@ "smithy.api#required": {} } }, - "executionStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", - "traits": { - "smithy.api#documentation": "

    The maximum duration for this workflow execution.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " - } - }, - "parentInitiatedEventId": { - "target": "com.amazonaws.swf#EventId", + "taskList": { + "target": "com.amazonaws.swf#TaskList", "traits": { - "smithy.api#documentation": "

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution \n Decision to start this workflow execution. The source event with\n this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.

    " + "smithy.api#documentation": "

    The name of the task list for scheduling the decision tasks for this workflow execution.

    ", + "smithy.api#required": {} } }, - "tagList": { - "target": "com.amazonaws.swf#TagList", + "parentWorkflowExecution": { + "target": "com.amazonaws.swf#WorkflowExecution", "traits": { - "smithy.api#documentation": "

    The list of tags associated with this workflow execution. An execution can have up to 5 tags.

    " + "smithy.api#documentation": "

    The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

    " } } }, @@ -6694,12 +6694,6 @@ "smithy.api#required": {} } }, - "cause": { - "target": "com.amazonaws.swf#WorkflowExecutionTerminatedCause", - "traits": { - "smithy.api#documentation": "

    If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

    " - } - }, "reason": { "target": "com.amazonaws.swf#TerminateReason", "traits": { @@ -6711,6 +6705,12 @@ "traits": { "smithy.api#documentation": "

    The details provided for the termination.

    " } + }, + "cause": { + "target": "com.amazonaws.swf#WorkflowExecutionTerminatedCause", + "traits": { + "smithy.api#documentation": "

    If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

    " + } } }, "traits": { @@ -6779,17 +6779,17 @@ "com.amazonaws.swf#WorkflowType": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.swf#Version", + "name": { + "target": "com.amazonaws.swf#Name", "traits": { - "smithy.api#documentation": "

    \n The version of the workflow type.

    \n \n

    The combination of workflow type name and version must be unique with in a domain.

    \n     ", + "smithy.api#documentation": "

    \n The name of the workflow type.

    \n \n

    The combination of workflow type name and version must be unique with in a domain.

    \n     ", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.swf#Name", + "version": { + "target": "com.amazonaws.swf#Version", "traits": { - "smithy.api#documentation": "

    \n The name of the workflow type.

    \n \n

    The combination of workflow type name and version must be unique with in a domain.

    \n     ", + "smithy.api#documentation": "

    \n The version of the workflow type.

    \n \n

    The combination of workflow type name and version must be unique with in a domain.

    \n     ", "smithy.api#required": {} } } @@ -6801,10 +6801,10 @@ "com.amazonaws.swf#WorkflowTypeConfiguration": { "type": "structure", "members": { - "defaultTaskStartToCloseTimeout": { - "target": "com.amazonaws.swf#DurationInSecondsOptional", + "defaultLambdaRole": { + "target": "com.amazonaws.swf#Arn", "traits": { - "smithy.api#documentation": "

    \n The default maximum duration, specified when registering the workflow type, that a decision task\n for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close\n in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports\n a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using\n the StartWorkflowExecution action or the StartChildWorkflowExecution \n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + "smithy.api#documentation": "

    The default IAM role attached to this workflow type.

    \n \n

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you\n don't specify an IAM role when starting this workflow type, the default Lambda role is\n attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the\n Amazon SWF Developer Guide.

    \n     " } }, "defaultExecutionStartToCloseTimeout": { @@ -6813,10 +6813,16 @@ "smithy.api#documentation": "

    \n The default maximum duration, specified when registering the workflow type, for executions of\n this workflow type. This default can be overridden when starting a workflow execution using the\n StartWorkflowExecution action or the StartChildWorkflowExecution \n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, - "defaultLambdaRole": { - "target": "com.amazonaws.swf#Arn", + "defaultTaskPriority": { + "target": "com.amazonaws.swf#TaskPriority", "traits": { - "smithy.api#documentation": "

    The default IAM role attached to this workflow type.

    \n \n

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you\n don't specify an IAM role when starting this workflow type, the default Lambda role is\n attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the\n Amazon SWF Developer Guide.

    \n     " + "smithy.api#documentation": "

    \n The default task priority, specified when registering the workflow type, for all decision tasks\n of this workflow type. This default can be overridden when starting a workflow execution using the\n StartWorkflowExecution action or the StartChildWorkflowExecution decision.

    \n

    Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + } + }, + "defaultTaskStartToCloseTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", + "traits": { + "smithy.api#documentation": "

    \n The default maximum duration, specified when registering the workflow type, that a decision task\n for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close\n in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports\n a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using\n the StartWorkflowExecution action or the StartChildWorkflowExecution \n Decision.

    \n

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " } }, "defaultChildPolicy": { @@ -6830,12 +6836,6 @@ "traits": { "smithy.api#documentation": "

    \n The default task list, specified when registering the workflow type, for decisions tasks\n scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution\n using the StartWorkflowExecution action or the StartChildWorkflowExecution\n Decision.

    " } - }, - "defaultTaskPriority": { - "target": "com.amazonaws.swf#TaskPriority", - "traits": { - "smithy.api#documentation": "

    \n The default task priority, specified when registering the workflow type, for all decision tasks\n of this workflow type. This default can be overridden when starting a workflow execution using the\n StartWorkflowExecution action or the StartChildWorkflowExecution decision.

    \n

    Valid values are integers that range from Java's Integer.MIN_VALUE\n (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    \n

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " - } } }, "traits": { @@ -6867,18 +6867,18 @@ "com.amazonaws.swf#WorkflowTypeFilter": { "type": "structure", "members": { - "version": { - "target": "com.amazonaws.swf#VersionOptional", - "traits": { - "smithy.api#documentation": "

    Version of the workflow type.

    " - } - }, "name": { "target": "com.amazonaws.swf#Name", "traits": { "smithy.api#documentation": "

    \n Name of the workflow type.

    ", "smithy.api#required": {} } + }, + "version": { + "target": "com.amazonaws.swf#VersionOptional", + "traits": { + "smithy.api#documentation": "

    Version of the workflow type.

    " + } } }, "traits": { @@ -6888,6 +6888,13 @@ "com.amazonaws.swf#WorkflowTypeInfo": { "type": "structure", "members": { + "status": { + "target": "com.amazonaws.swf#RegistrationStatus", + "traits": { + "smithy.api#documentation": "

    The current status of the workflow type.

    ", + "smithy.api#required": {} + } + }, "workflowType": { "target": "com.amazonaws.swf#WorkflowType", "traits": { @@ -6895,10 +6902,10 @@ "smithy.api#required": {} } }, - "deprecationDate": { - "target": "com.amazonaws.swf#Timestamp", + "description": { + "target": "com.amazonaws.swf#Description", "traits": { - "smithy.api#documentation": "

    If the type is in deprecated state, then it is set to the date when the type was deprecated.

    " + "smithy.api#documentation": "

    The description of the type registered through RegisterWorkflowType.

    " } }, "creationDate": { @@ -6908,17 +6915,10 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.swf#Description", - "traits": { - "smithy.api#documentation": "

    The description of the type registered through RegisterWorkflowType.

    " - } - }, - "status": { - "target": "com.amazonaws.swf#RegistrationStatus", + "deprecationDate": { + "target": "com.amazonaws.swf#Timestamp", "traits": { - "smithy.api#documentation": "

    The current status of the workflow type.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the type is in deprecated state, then it is set to the date when the type was deprecated.

    " } } }, @@ -6935,18 +6935,18 @@ "com.amazonaws.swf#WorkflowTypeInfos": { "type": "structure", "members": { + "nextPageToken": { + "target": "com.amazonaws.swf#PageToken", + "traits": { + "smithy.api#documentation": "

    If a NextPageToken was returned by a previous call, there are more\n results available. To retrieve the next page of results, make the call again using the returned token in\n nextPageToken. Keep all other arguments unchanged.

    \n

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + } + }, "typeInfos": { "target": "com.amazonaws.swf#WorkflowTypeInfoList", "traits": { "smithy.api#documentation": "

    The list of workflow type information.

    ", "smithy.api#required": {} } - }, - "nextPageToken": { - "target": "com.amazonaws.swf#PageToken", - "traits": { - "smithy.api#documentation": "

    If a NextPageToken was returned by a previous call, there are more\n results available. To retrieve the next page of results, make the call again using the returned token in\n nextPageToken. Keep all other arguments unchanged.

    \n

    The configured maximumPageSize determines how many results can be returned in a single call.

    " - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/synthetics.2017-10-11.json b/codegen/sdk-codegen/aws-models/synthetics.2017-10-11.json index 3c934909c867..c6a203ae830e 100644 --- a/codegen/sdk-codegen/aws-models/synthetics.2017-10-11.json +++ b/codegen/sdk-codegen/aws-models/synthetics.2017-10-11.json @@ -29,12 +29,6 @@ ] }, "shapes": { - "com.amazonaws.synthetics#Arn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" - } - }, "com.amazonaws.synthetics#Blob": { "type": "blob", "traits": { @@ -59,31 +53,37 @@ "com.amazonaws.synthetics#Canary": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.synthetics#UUID", + "ExecutionRoleArn": { + "target": "com.amazonaws.synthetics#RoleArn", "traits": { - "smithy.api#documentation": "

    The unique ID of this canary.

    " + "smithy.api#documentation": "

    The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust\n policy.

    " } }, - "EngineArn": { - "target": "com.amazonaws.synthetics#Arn", + "Code": { + "target": "com.amazonaws.synthetics#CanaryCodeOutput" + }, + "Timeline": { + "target": "com.amazonaws.synthetics#CanaryTimeline", "traits": { - "smithy.api#documentation": "

    The ARN of the Lambda function that is used as your canary's engine. For more information \n about Lambda ARN format, see Resources and Conditions for Lambda Actions.

    " + "smithy.api#documentation": "

    A structure that contains information about when the canary was created, modified, and\n most recently run.

    " } }, - "VpcConfig": { - "target": "com.amazonaws.synthetics#VpcConfigOutput" + "Schedule": { + "target": "com.amazonaws.synthetics#CanaryScheduleOutput", + "traits": { + "smithy.api#documentation": "

    A structure that contains information about how often the canary is to run, and when\n these runs are to stop.

    " + } }, - "SuccessRetentionPeriodInDays": { + "FailureRetentionPeriodInDays": { "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "

    The number of days to retain data about successful runs of this canary.

    " + "smithy.api#documentation": "

    The number of days to retain data about failed runs of this canary.

    " } }, - "RuntimeVersion": { + "ArtifactS3Location": { "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "

    Specifies the runtime version to use for the canary. Currently, the only valid \n value is syn-1.0. For more information about\n runtime versions, see \n Canary Runtime Versions.

    " + "smithy.api#documentation": "

    The location in Amazon S3 where Synthetics stores artifacts from the runs of this\n canary. Artifacts include the log file, screenshots, and HAR files.

    " } }, "Tags": { @@ -92,66 +92,70 @@ "smithy.api#documentation": "

    The list of key-value pairs that are associated with the canary.

    " } }, - "FailureRetentionPeriodInDays": { - "target": "com.amazonaws.synthetics#MaxSize1024", - "traits": { - "smithy.api#documentation": "

    The number of days to retain data about failed runs of this canary.

    " - } - }, "Status": { "target": "com.amazonaws.synthetics#CanaryStatus", "traits": { "smithy.api#documentation": "

    A structure that contains information about the canary's status.

    " } }, - "ArtifactS3Location": { - "target": "com.amazonaws.synthetics#String", + "Id": { + "target": "com.amazonaws.synthetics#UUID", "traits": { - "smithy.api#documentation": "

    The location in Amazon S3 where Synthetics stores artifacts from the runs of this\n canary. Artifacts include the log file, screenshots, and HAR files.

    " + "smithy.api#documentation": "

    The unique ID of this canary.

    " } }, - "ExecutionRoleArn": { - "target": "com.amazonaws.synthetics#Arn", + "EngineArn": { + "target": "com.amazonaws.synthetics#FunctionArn", "traits": { - "smithy.api#documentation": "

    The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust\n policy.

    " + "smithy.api#documentation": "

    The ARN of the Lambda function that is used as your canary's engine. For more information \n about Lambda ARN format, see Resources and Conditions for Lambda Actions.

    " } }, - "Code": { - "target": "com.amazonaws.synthetics#CanaryCodeOutput" - }, - "Name": { - "target": "com.amazonaws.synthetics#CanaryName", + "SuccessRetentionPeriodInDays": { + "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "

    The name of the canary.

    " + "smithy.api#documentation": "

    The number of days to retain data about successful runs of this canary.

    " } }, - "Schedule": { - "target": "com.amazonaws.synthetics#CanaryScheduleOutput", - "traits": { - "smithy.api#documentation": "

    A structure that contains information about how often the canary is to run, and when\n these runs are to stop.

    " - } + "VpcConfig": { + "target": "com.amazonaws.synthetics#VpcConfigOutput" }, - "Timeline": { - "target": "com.amazonaws.synthetics#CanaryTimeline", + "RuntimeVersion": { + "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "

    A structure that contains information about when the canary was created, modified, and\n most recently run.

    " + "smithy.api#documentation": "

    Specifies the runtime version to use for the canary. Currently, the only valid \n values are syn-nodejs-2.0, syn-nodejs-2.0-beta, and \n syn-1.0. For more information about\n runtime versions, see \n Canary Runtime Versions.

    " } }, "RunConfig": { "target": "com.amazonaws.synthetics#CanaryRunConfigOutput" + }, + "Name": { + "target": "com.amazonaws.synthetics#CanaryName", + "traits": { + "smithy.api#documentation": "

    The name of the canary.

    " + } } }, "traits": { "smithy.api#documentation": "

    This structure contains all information about one canary in your account.

    " } }, + "com.amazonaws.synthetics#CanaryArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]{1,21}" + } + }, "com.amazonaws.synthetics#CanaryCodeInput": { "type": "structure", "members": { - "S3Version": { - "target": "com.amazonaws.synthetics#String", + "ZipFile": { + "target": "com.amazonaws.synthetics#Blob", "traits": { - "smithy.api#documentation": "

    The S3 version ID of your script.

    " + "smithy.api#documentation": "

    If you input your canary script directly into the canary instead of referring to an S3\n location, the value of this parameter is the .zip file that contains the script. It can be\n up to 5 MB.

    " } }, "Handler": { @@ -173,10 +177,10 @@ "smithy.api#documentation": "

    If your canary script is located in S3, specify the full bucket name here. The bucket\n must already exist. Specify the full bucket name, including s3:// as the \n start of the bucket name.

    " } }, - "ZipFile": { - "target": "com.amazonaws.synthetics#Blob", + "S3Version": { + "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "

    If you input your canary script directly into the canary instead of referring to an S3\n location, the value of this parameter is the .zip file that contains the script. It can be\n up to 5 MB.

    " + "smithy.api#documentation": "

    The S3 version ID of your script.

    " } } }, @@ -243,10 +247,10 @@ "smithy.api#documentation": "

    The name of the canary.

    " } }, - "ArtifactS3Location": { - "target": "com.amazonaws.synthetics#String", + "Id": { + "target": "com.amazonaws.synthetics#UUID", "traits": { - "smithy.api#documentation": "

    The location where the canary stored artifacts from the run. Artifacts include \n the log file, screenshots, and HAR files.

    " + "smithy.api#documentation": "

    A unique ID that identifies this canary run.

    " } }, "Timeline": { @@ -255,6 +259,12 @@ "smithy.api#documentation": "

    A structure that contains the start and end times of this run.

    " } }, + "ArtifactS3Location": { + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "

    The location where the canary stored artifacts from the run. Artifacts include \n the log file, screenshots, and HAR files.

    " + } + }, "Status": { "target": "com.amazonaws.synthetics#CanaryRunStatus", "traits": { @@ -272,14 +282,19 @@ "MemoryInMB": { "target": "com.amazonaws.synthetics#MaxSize3008", "traits": { - "smithy.api#documentation": "

    The maximum amount of memory available to the canary while it is running, in MB. The value\n you specify must be a multiple of 64.

    " + "smithy.api#documentation": "

    The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

    " } }, "TimeoutInSeconds": { "target": "com.amazonaws.synthetics#MaxFifteenMinutesInSeconds", "traits": { - "smithy.api#documentation": "

    How long the canary is allowed to run before it must stop. If you omit this field, the\n frequency of the canary is used as this value, up to a maximum of 14 minutes.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    How long the canary is allowed to run before it must stop. You can't set this time to be longer\n than the frequency of the runs of this canary.

    \n

    If you omit this field, the\n frequency of the canary is used as this value, up to a maximum of 14 minutes.

    " + } + }, + "ActiveTracing": { + "target": "com.amazonaws.synthetics#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing \n enables\n this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does \n not hit an endpoint that has X-ray tracing enabled. Using X-Ray tracing incurs charges.\n For more information, see \n Canaries and X-Ray tracing.

    \n

    You can enable active tracing only for canaries that use version syn-nodejs-2.0 \n or later for their canary runtime.

    " } } }, @@ -296,15 +311,21 @@ "smithy.api#documentation": "

    How long the canary is allowed to run before it must stop.

    " } }, + "ActiveTracing": { + "target": "com.amazonaws.synthetics#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    Displays whether this canary run used active AWS X-Ray tracing.

    " + } + }, "MemoryInMB": { "target": "com.amazonaws.synthetics#MaxSize3008", "traits": { - "smithy.api#documentation": "

    The maximum amount of memory available to the canary while it is running, in MB. The value\n you must be a multiple of 64.

    " + "smithy.api#documentation": "

    The maximum amount of memory available to the canary while it is running, in MB. This value\n must be a multiple of 64.

    " } } }, "traits": { - "smithy.api#documentation": "

    A structure that contains information for a canary run.

    " + "smithy.api#documentation": "

    A structure that contains information about a canary run.

    " } }, "com.amazonaws.synthetics#CanaryRunState": { @@ -344,10 +365,10 @@ "com.amazonaws.synthetics#CanaryRunStatus": { "type": "structure", "members": { - "StateReasonCode": { - "target": "com.amazonaws.synthetics#CanaryRunStateReasonCode", + "State": { + "target": "com.amazonaws.synthetics#CanaryRunState", "traits": { - "smithy.api#documentation": "

    If this value is CANARY_FAILURE, an exception occurred in the \n canary code. If this value is EXECUTION_FAILURE, an exception occurred in \n CloudWatch Synthetics.

    " + "smithy.api#documentation": "

    The current state of the run.

    " } }, "StateReason": { @@ -356,10 +377,10 @@ "smithy.api#documentation": "

    If run of the canary failed, this field contains the reason for the error.

    " } }, - "State": { - "target": "com.amazonaws.synthetics#CanaryRunState", + "StateReasonCode": { + "target": "com.amazonaws.synthetics#CanaryRunStateReasonCode", "traits": { - "smithy.api#documentation": "

    The current state of the run.

    " + "smithy.api#documentation": "

    If this value is CANARY_FAILURE, an exception occurred in the \n canary code. If this value is EXECUTION_FAILURE, an exception occurred in \n CloudWatch Synthetics.

    " } } }, @@ -417,17 +438,17 @@ "com.amazonaws.synthetics#CanaryScheduleOutput": { "type": "structure", "members": { - "Expression": { - "target": "com.amazonaws.synthetics#String", - "traits": { - "smithy.api#documentation": "

    A rate expression that defines how often the canary is to run. The syntax is\n rate(number unit). unit\n can be minute, minutes, or hour.

    \n

    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every \n 10 minutes, and rate(1 hour) runs it once every hour.

    \n

    Specifying rate(0 minute) or rate(0 hour) is a special value \n that causes the \n canary to run only once when it is started.

    " - } - }, "DurationInSeconds": { "target": "com.amazonaws.synthetics#MaxOneYearInSeconds", "traits": { "smithy.api#documentation": "

    How long, in seconds, for the canary to continue making regular runs after it \n was created. The runs are performed according to the schedule in the \n Expression value.

    " } + }, + "Expression": { + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "

    A rate expression that defines how often the canary is to run. The syntax is\n rate(number unit). unit\n can be minute, minutes, or hour.

    \n

    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every \n 10 minutes, and rate(1 hour) runs it once every hour.

    \n

    Specifying rate(0 minute) or rate(0 hour) is a special value \n that causes the \n canary to run only once when it is started.

    " + } } }, "traits": { @@ -491,12 +512,6 @@ "com.amazonaws.synthetics#CanaryStatus": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.synthetics#CanaryState", - "traits": { - "smithy.api#documentation": "

    The current state of the canary.

    " - } - }, "StateReason": { "target": "com.amazonaws.synthetics#String", "traits": { @@ -508,6 +523,12 @@ "traits": { "smithy.api#documentation": "

    If the canary cannot run or has failed, this field displays the reason.

    " } + }, + "State": { + "target": "com.amazonaws.synthetics#CanaryState", + "traits": { + "smithy.api#documentation": "

    The current state of the canary.

    " + } } }, "traits": { @@ -517,16 +538,16 @@ "com.amazonaws.synthetics#CanaryTimeline": { "type": "structure", "members": { - "LastStarted": { + "Created": { "target": "com.amazonaws.synthetics#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time that the canary's most recent run started.

    " + "smithy.api#documentation": "

    The date and time the canary was created.

    " } }, - "Created": { + "LastStarted": { "target": "com.amazonaws.synthetics#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time the canary was created.

    " + "smithy.api#documentation": "

    The date and time that the canary's most recent run started.

    " } }, "LastModified": { @@ -587,75 +608,75 @@ "com.amazonaws.synthetics#CreateCanaryRequest": { "type": "structure", "members": { - "VpcConfig": { - "target": "com.amazonaws.synthetics#VpcConfigInput", + "ExecutionRoleArn": { + "target": "com.amazonaws.synthetics#RoleArn", "traits": { - "smithy.api#documentation": "

    If this canary is to test an endpoint in a VPC, this structure contains\n information about the subnet and security groups of the VPC endpoint. \n For more information, see \n Running a Canary in a VPC.

    " + "smithy.api#documentation": "

    The ARN of the IAM role to be used to run the canary. This role must already exist, \n and must include lambda.amazonaws.com as a principal in the trust\n policy. The role must also have the following permissions:

    \n
      \n
    • \n

      \n s3:PutObject\n

      \n
      • \n
    • \n

      \n s3:GetBucketLocation\n

      \n
      • \n
    • \n

      \n s3:ListAllMyBuckets\n

      \n
      • \n
    • \n

      \n cloudwatch:PutMetricData\n

      \n
      • \n
    • \n

      \n logs:CreateLogGroup\n

      \n
      • \n
    • \n

      \n logs:CreateLogStream\n

      \n
      • \n
    • \n

      \n logs:PutLogEvents\n

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "ArtifactS3Location": { - "target": "com.amazonaws.synthetics#String", + "Code": { + "target": "com.amazonaws.synthetics#CanaryCodeInput", "traits": { - "smithy.api#documentation": "

    The location in Amazon S3 where Synthetics stores artifacts from the test runs of this\n canary. Artifacts include the log file, screenshots, and HAR files.

    ", + "smithy.api#documentation": "

    A structure that includes the entry point from which the canary should start\n running your script. If the script is stored in \n an S3 bucket, the bucket name, key, and version are also included.\n

    ", "smithy.api#required": {} } }, - "SuccessRetentionPeriodInDays": { + "FailureRetentionPeriodInDays": { "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "

    The number of days to retain data about successful runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.

    " - } - }, - "RunConfig": { - "target": "com.amazonaws.synthetics#CanaryRunConfigInput", - "traits": { - "smithy.api#documentation": "

    A structure that contains the configuration for individual canary runs, \n such as timeout value.

    " + "smithy.api#documentation": "

    The number of days to retain data about failed runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.

    " } }, - "FailureRetentionPeriodInDays": { - "target": "com.amazonaws.synthetics#MaxSize1024", + "Tags": { + "target": "com.amazonaws.synthetics#TagMap", "traits": { - "smithy.api#documentation": "

    The number of days to retain data about failed runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.

    " + "smithy.api#documentation": "

    A list of key-value pairs to associate with the canary. \n You can associate as many as 50 tags with a canary.

    \n

    Tags can help you organize and categorize your\n resources. You can also use them to scope user permissions, by \n granting a user permission to access or change only the resources that have\n certain tag values.

    " } }, - "Schedule": { - "target": "com.amazonaws.synthetics#CanaryScheduleInput", + "Name": { + "target": "com.amazonaws.synthetics#CanaryName", "traits": { - "smithy.api#documentation": "

    A structure that contains information about how often the canary is to run and when\n these test runs are to stop.

    ", + "smithy.api#documentation": "

    The name for this canary. Be sure to give it a descriptive name \n that distinguishes it from other canaries in your account.

    \n

    Do not include secrets or proprietary information in your canary names. The canary name\n makes up part of the canary ARN, and the ARN is included in outbound calls over the\n internet. For more information, see Security\n Considerations for Synthetics Canaries.

    ", "smithy.api#required": {} } }, - "RuntimeVersion": { + "ArtifactS3Location": { "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "

    Specifies the runtime version to use for the canary. Currently, the only valid \n value is syn-1.0. For more information about\n runtime versions, see \n Canary Runtime Versions.

    ", + "smithy.api#documentation": "

    The location in Amazon S3 where Synthetics stores artifacts from the test runs of this\n canary. Artifacts include the log file, screenshots, and HAR files.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.synthetics#CanaryName", + "SuccessRetentionPeriodInDays": { + "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "

    The name for this canary. Be sure to give it a descriptive name \n that distinguishes it from other canaries in your account.

    \n

    Do not include secrets or proprietary information in your canary names. The canary name\n makes up part of the canary ARN, and the ARN is included in outbound calls over the\n internet. For more information, see Security\n Considerations for Synthetics Canaries.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The number of days to retain data about successful runs of this canary. If you omit \n this field, the default of 31 days is used. The valid range is 1 to 455 days.

    " } }, - "Tags": { - "target": "com.amazonaws.synthetics#TagMap", + "RunConfig": { + "target": "com.amazonaws.synthetics#CanaryRunConfigInput", "traits": { - "smithy.api#documentation": "

    A list of key-value pairs to associate with the canary. \n You can associate as many as 50 tags with a canary.

    \n

    Tags can help you organize and categorize your\n resources. You can also use them to scope user permissions, by \n granting a user permission to access or change only the resources that have\n certain tag values.

    " + "smithy.api#documentation": "

    A structure that contains the configuration for individual canary runs, \n such as timeout value.

    " } }, - "ExecutionRoleArn": { - "target": "com.amazonaws.synthetics#Arn", + "Schedule": { + "target": "com.amazonaws.synthetics#CanaryScheduleInput", "traits": { - "smithy.api#documentation": "

    The ARN of the IAM role to be used to run the canary. This role must already exist, \n and must include lambda.amazonaws.com as a principal in the trust\n policy. The role must also have the following permissions:

    \n
      \n
    • \n

      \n s3:PutObject\n

      \n
      • \n
    • \n

      \n s3:GetBucketLocation\n

      \n
      • \n
    • \n

      \n s3:ListAllMyBuckets\n

      \n
      • \n
    • \n

      \n cloudwatch:PutMetricData\n

      \n
      • \n
    • \n

      \n logs:CreateLogGroup\n

      \n
      • \n
    • \n

      \n logs:CreateLogStream\n

      \n
      • \n
    • \n

      \n logs:CreateLogStream\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    A structure that contains information about how often the canary is to run and when\n these test runs are to stop.

    ", "smithy.api#required": {} } }, - "Code": { - "target": "com.amazonaws.synthetics#CanaryCodeInput", + "VpcConfig": { + "target": "com.amazonaws.synthetics#VpcConfigInput", "traits": { - "smithy.api#documentation": "

    A structure that includes the entry point from which the canary should start\n running your script. If the script is stored in \n an S3 bucket, the bucket name, key, and version are also included.\n

    ", + "smithy.api#documentation": "

    If this canary is to test an endpoint in a VPC, this structure contains\n information about the subnet and security groups of the VPC endpoint. \n For more information, see \n Running a Canary in a VPC.

    " + } + }, + "RuntimeVersion": { + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "

    Specifies the runtime version to use for the canary. Currently, the only valid \n values are syn-nodejs-2.0, syn-nodejs-2.0-beta, and \n syn-1.0. For more information about\n runtime versions, see \n Canary Runtime Versions.

    ", "smithy.api#required": {} } } @@ -783,34 +804,34 @@ "com.amazonaws.synthetics#DescribeCanariesLastRunRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.synthetics#Token", - "traits": { - "smithy.api#documentation": "

    A token that indicates that there is more data\n available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next \n set of results.

    " - } - }, "MaxResults": { "target": "com.amazonaws.synthetics#MaxSize100", "traits": { "smithy.api#documentation": "

    Specify this parameter to limit how many runs are returned each time you use\n the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.

    " } + }, + "NextToken": { + "target": "com.amazonaws.synthetics#Token", + "traits": { + "smithy.api#documentation": "

    A token that indicates that there is more data\n available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next \n set of results.

    " + } } } }, "com.amazonaws.synthetics#DescribeCanariesLastRunResponse": { "type": "structure", "members": { - "CanariesLastRun": { - "target": "com.amazonaws.synthetics#CanariesLastRun", - "traits": { - "smithy.api#documentation": "

    An array that contains the information from the most recent run of each\n canary.

    " - } - }, "NextToken": { "target": "com.amazonaws.synthetics#Token", "traits": { "smithy.api#documentation": "

    A token that indicates that there is more data\n available. You can use this token in a subsequent DescribeCanariesLastRun operation to retrieve the next \n set of results.

    " } + }, + "CanariesLastRun": { + "target": "com.amazonaws.synthetics#CanariesLastRun", + "traits": { + "smithy.api#documentation": "

    An array that contains the information from the most recent run of each\n canary.

    " + } } } }, @@ -881,17 +902,17 @@ "com.amazonaws.synthetics#DescribeRuntimeVersionsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.synthetics#Token", - "traits": { - "smithy.api#documentation": "

    A token that indicates that there is more data\n available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next \n set of results.

    " - } - }, "MaxResults": { "target": "com.amazonaws.synthetics#MaxSize100", "traits": { "smithy.api#documentation": "

    Specify this parameter to limit how many runs are returned each time you use\n the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used.

    " } + }, + "NextToken": { + "target": "com.amazonaws.synthetics#Token", + "traits": { + "smithy.api#documentation": "

    A token that indicates that there is more data\n available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next \n set of results.

    " + } } } }, @@ -915,6 +936,16 @@ "com.amazonaws.synthetics#ErrorMessage": { "type": "string" }, + "com.amazonaws.synthetics#FunctionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + } + }, "com.amazonaws.synthetics#GetCanary": { "type": "operation", "input": { @@ -1084,7 +1115,7 @@ "type": "structure", "members": { "ResourceArn": { - "target": "com.amazonaws.synthetics#Arn", + "target": "com.amazonaws.synthetics#CanaryArn", "traits": { "smithy.api#documentation": "

    The ARN of the canary that you want to view tags for.

    \n

    The ARN format of a canary is\n arn:aws:synthetics:Region:account-id:canary:canary-name\n .

    ", "smithy.api#httpLabel": {}, @@ -1119,8 +1150,8 @@ "traits": { "smithy.api#box": {}, "smithy.api#range": { - "min": 60, - "max": 900 + "min": 3, + "max": 840 } } }, @@ -1164,6 +1195,12 @@ } } }, + "com.amazonaws.synthetics#NullableBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.synthetics#ResourceNotFoundException": { "type": "structure", "members": { @@ -1177,31 +1214,41 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.synthetics#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + } + }, "com.amazonaws.synthetics#RuntimeVersion": { "type": "structure", "members": { - "VersionName": { - "target": "com.amazonaws.synthetics#String", + "ReleaseDate": { + "target": "com.amazonaws.synthetics#Timestamp", "traits": { - "smithy.api#documentation": "

    The name of the runtime version. Currently, the only valid \n value is syn-1.0.

    \n

    Specifies the runtime version to use for the canary. Currently, the only valid \n value is syn-1.0.

    " + "smithy.api#documentation": "

    The date that the runtime version was released.

    " } }, - "ReleaseDate": { + "DeprecationDate": { "target": "com.amazonaws.synthetics#Timestamp", "traits": { - "smithy.api#documentation": "

    The date that the runtime version was released.

    " + "smithy.api#documentation": "

    If this runtime version is deprecated, this value is the date of deprecation.

    " } }, - "Description": { + "VersionName": { "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "

    A description of the runtime version, created by Amazon.

    " + "smithy.api#documentation": "

    The name of the runtime version. Currently, the only valid \n values are syn-nodejs-2.0, syn-nodejs-2.0-beta, and \n syn-1.0.

    " } }, - "DeprecationDate": { - "target": "com.amazonaws.synthetics#Timestamp", + "Description": { + "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "

    If this runtime version is deprecated, this value is the date of deprecation.

    " + "smithy.api#documentation": "

    A description of the runtime version, created by Amazon.

    " } } }, @@ -1485,7 +1532,7 @@ } }, "ResourceArn": { - "target": "com.amazonaws.synthetics#Arn", + "target": "com.amazonaws.synthetics#CanaryArn", "traits": { "smithy.api#documentation": "

    The ARN of the canary that you're adding tags to.

    \n

    The ARN format of a canary is\n arn:aws:synthetics:Region:account-id:canary:canary-name\n .

    ", "smithy.api#httpLabel": {}, @@ -1513,7 +1560,10 @@ "com.amazonaws.synthetics#Token": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9=/+_.-]{4,252}$" + "smithy.api#length": { + "min": 4, + "max": 252 + } } }, "com.amazonaws.synthetics#UUID": { @@ -1553,14 +1603,6 @@ "com.amazonaws.synthetics#UntagResourceRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.synthetics#Arn", - "traits": { - "smithy.api#documentation": "

    The ARN of the canary that you're removing tags from.

    \n

    The ARN format of a canary is\n arn:aws:synthetics:Region:account-id:canary:canary-name\n .

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "TagKeys": { "target": "com.amazonaws.synthetics#TagKeyList", "traits": { @@ -1568,6 +1610,14 @@ "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } + }, + "ResourceArn": { + "target": "com.amazonaws.synthetics#CanaryArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the canary that you're removing tags from.

    \n

    The ARN format of a canary is\n arn:aws:synthetics:Region:account-id:canary:canary-name\n .

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, @@ -1609,24 +1659,28 @@ "com.amazonaws.synthetics#UpdateCanaryRequest": { "type": "structure", "members": { - "SuccessRetentionPeriodInDays": { + "VpcConfig": { + "target": "com.amazonaws.synthetics#VpcConfigInput", + "traits": { + "smithy.api#documentation": "

    If this canary is to test an endpoint in a VPC, this structure contains\n information about the subnet and security groups of the VPC endpoint. \n For more information, see \n Running a Canary in a VPC.

    " + } + }, + "FailureRetentionPeriodInDays": { "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "

    The number of days to retain data about successful runs of this canary.

    " + "smithy.api#documentation": "

    The number of days to retain data about failed runs of this canary.

    " } }, - "Code": { - "target": "com.amazonaws.synthetics#CanaryCodeInput", + "ExecutionRoleArn": { + "target": "com.amazonaws.synthetics#RoleArn", "traits": { - "smithy.api#documentation": "

    A structure that includes the entry point from which the canary should start\n running your script. If the script is stored in \n an S3 bucket, the bucket name, key, and version are also included.\n

    " + "smithy.api#documentation": "

    The ARN of the IAM role to be used to run the canary. This role must already exist, \n and must include lambda.amazonaws.com as a principal in the trust\n policy. The role must also have the following permissions:

    \n
      \n
    • \n

      \n s3:PutObject\n

      \n
      • \n
    • \n

      \n s3:GetBucketLocation\n

      \n
      • \n
    • \n

      \n s3:ListAllMyBuckets\n

      \n
      • \n
    • \n

      \n cloudwatch:PutMetricData\n

      \n
      • \n
    • \n

      \n logs:CreateLogGroup\n

      \n
      • \n
    • \n

      \n logs:CreateLogStream\n

      \n
      • \n
    • \n

      \n logs:CreateLogStream\n

      \n
      • \n
    " } }, - "Name": { - "target": "com.amazonaws.synthetics#CanaryName", + "Code": { + "target": "com.amazonaws.synthetics#CanaryCodeInput", "traits": { - "smithy.api#documentation": "

    The name of the canary that you want to update. To find the names of your \n canaries, use DescribeCanaries.

    \n

    You cannot change the name of a canary that has already been created.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    A structure that includes the entry point from which the canary should start\n running your script. If the script is stored in \n an S3 bucket, the bucket name, key, and version are also included.\n

    " } }, "RunConfig": { @@ -1635,34 +1689,30 @@ "smithy.api#documentation": "

    A structure that contains the timeout value that is used for each individual run of the \n canary.

    " } }, - "FailureRetentionPeriodInDays": { - "target": "com.amazonaws.synthetics#MaxSize1024", + "Schedule": { + "target": "com.amazonaws.synthetics#CanaryScheduleInput", "traits": { - "smithy.api#documentation": "

    The number of days to retain data about failed runs of this canary.

    " + "smithy.api#documentation": "

    A structure that contains information about how often the canary is to run, and when\n these runs are to stop.

    " } }, - "ExecutionRoleArn": { - "target": "com.amazonaws.synthetics#Arn", + "Name": { + "target": "com.amazonaws.synthetics#CanaryName", "traits": { - "smithy.api#documentation": "

    The ARN of the IAM role to be used to run the canary. This role must already exist, \n and must include lambda.amazonaws.com as a principal in the trust\n policy. The role must also have the following permissions:

    \n
      \n
    • \n

      \n s3:PutObject\n

      \n
      • \n
    • \n

      \n s3:GetBucketLocation\n

      \n
      • \n
    • \n

      \n s3:ListAllMyBuckets\n

      \n
      • \n
    • \n

      \n cloudwatch:PutMetricData\n

      \n
      • \n
    • \n

      \n logs:CreateLogGroup\n

      \n
      • \n
    • \n

      \n logs:CreateLogStream\n

      \n
      • \n
    • \n

      \n logs:CreateLogStream\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The name of the canary that you want to update. To find the names of your \n canaries, use DescribeCanaries.

    \n

    You cannot change the name of a canary that has already been created.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "RuntimeVersion": { "target": "com.amazonaws.synthetics#String", "traits": { - "smithy.api#documentation": "

    Specifies the runtime version to use for the canary. Currently, the only valid \n value is syn-1.0. For more information about\n runtime versions, see \n Canary Runtime Versions.

    " - } - }, - "Schedule": { - "target": "com.amazonaws.synthetics#CanaryScheduleInput", - "traits": { - "smithy.api#documentation": "

    A structure that contains information about how often the canary is to run, and when\n these runs are to stop.

    " + "smithy.api#documentation": "

    Specifies the runtime version to use for the canary. Currently, the only valid \n values are syn-nodejs-2.0, syn-nodejs-2.0-beta, and syn-1.0. \n For more information about\n runtime versions, see \n Canary Runtime Versions.

    " } }, - "VpcConfig": { - "target": "com.amazonaws.synthetics#VpcConfigInput", + "SuccessRetentionPeriodInDays": { + "target": "com.amazonaws.synthetics#MaxSize1024", "traits": { - "smithy.api#documentation": "

    If this canary is to test an endpoint in a VPC, this structure contains\n information about the subnet and security groups of the VPC endpoint. \n For more information, see \n Running a Canary in a VPC.

    " + "smithy.api#documentation": "

    The number of days to retain data about successful runs of this canary.

    " } } } @@ -1687,17 +1737,17 @@ "com.amazonaws.synthetics#VpcConfigInput": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.synthetics#SubnetIds", - "traits": { - "smithy.api#documentation": "

    The IDs of the subnets where this canary is to run.

    " - } - }, "SecurityGroupIds": { "target": "com.amazonaws.synthetics#SecurityGroupIds", "traits": { "smithy.api#documentation": "

    The IDs of the security groups for this canary.

    " } + }, + "SubnetIds": { + "target": "com.amazonaws.synthetics#SubnetIds", + "traits": { + "smithy.api#documentation": "

    The IDs of the subnets where this canary is to run.

    " + } } }, "traits": { @@ -1707,12 +1757,6 @@ "com.amazonaws.synthetics#VpcConfigOutput": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.synthetics#SubnetIds", - "traits": { - "smithy.api#documentation": "

    The IDs of the subnets where this canary is to run.

    " - } - }, "SecurityGroupIds": { "target": "com.amazonaws.synthetics#SecurityGroupIds", "traits": { @@ -1724,6 +1768,12 @@ "traits": { "smithy.api#documentation": "

    The IDs of the VPC where this canary is to run.

    " } + }, + "SubnetIds": { + "target": "com.amazonaws.synthetics#SubnetIds", + "traits": { + "smithy.api#documentation": "

    The IDs of the subnets where this canary is to run.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/textract.2018-06-27.json b/codegen/sdk-codegen/aws-models/textract.2018-06-27.json index 56f987b46077..4882e38b636f 100644 --- a/codegen/sdk-codegen/aws-models/textract.2018-06-27.json +++ b/codegen/sdk-codegen/aws-models/textract.2018-06-27.json @@ -40,7 +40,7 @@ } }, "traits": { - "smithy.api#documentation": "

    You aren't authorized to perform the action.

    ", + "smithy.api#documentation": "

    You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) \n of an authorized user or IAM role to perform the operation.

    ", "smithy.api#error": "client" } }, @@ -116,6 +116,12 @@ "com.amazonaws.textract#AnalyzeDocumentResponse": { "type": "structure", "members": { + "AnalyzeDocumentModelVersion": { + "target": "com.amazonaws.textract#String", + "traits": { + "smithy.api#documentation": "

    The version of the model used to analyze the document.

    " + } + }, "Blocks": { "target": "com.amazonaws.textract#BlockList", "traits": { @@ -128,12 +134,6 @@ "smithy.api#documentation": "

    Shows the results of the human in the loop evaluation.

    " } }, - "AnalyzeDocumentModelVersion": { - "target": "com.amazonaws.textract#String", - "traits": { - "smithy.api#documentation": "

    The version of the model used to analyze the document.

    " - } - }, "DocumentMetadata": { "target": "com.amazonaws.textract#DocumentMetadata", "traits": { @@ -153,41 +153,53 @@ } }, "traits": { - "smithy.api#documentation": "

    Amazon Textract isn't able to read the document.

    ", + "smithy.api#documentation": "

    Amazon Textract isn't able to read the document. For more information on the document\n limits in Amazon Textract, see limits.

    ", "smithy.api#error": "client" } }, "com.amazonaws.textract#Block": { "type": "structure", "members": { + "EntityTypes": { + "target": "com.amazonaws.textract#EntityTypes", + "traits": { + "smithy.api#documentation": "

    The type of entity. The following can be returned:

    \n
      \n
    • \n

      \n KEY - An identifier for a field on the document.

      \n
      • \n
    • \n

      \n VALUE - The field text.

      \n
      • \n
    \n

    \n EntityTypes isn't returned by DetectDocumentText and\n GetDocumentTextDetection.

    " + } + }, + "RowIndex": { + "target": "com.amazonaws.textract#UInteger", + "traits": { + "smithy.api#documentation": "

    The row in which a table cell is located. The first row position is 1.\n RowIndex isn't returned by DetectDocumentText and\n GetDocumentTextDetection.

    " + } + }, "Text": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "

    The word or line of text that's recognized by Amazon Textract.

    " } }, - "RowIndex": { + "RowSpan": { "target": "com.amazonaws.textract#UInteger", "traits": { - "smithy.api#documentation": "

    The row in which a table cell is located. The first row position is 1.\n RowIndex isn't returned by DetectDocumentText and\n GetDocumentTextDetection.

    " + "smithy.api#documentation": "

    The number of rows that a table cell spans. Currently this value is always 1, even\n if the number of rows spanned is greater than 1. RowSpan isn't returned by\n DetectDocumentText and GetDocumentTextDetection.

    " } }, - "Confidence": { - "target": "com.amazonaws.textract#Percent", + "BlockType": { + "target": "com.amazonaws.textract#BlockType", "traits": { - "smithy.api#documentation": "

    The confidence score that Amazon Textract has in the accuracy of the recognized text and\n the accuracy of the geometry points around the recognized text.

    " + "smithy.api#documentation": "

    The type of text item that's recognized. In operations for text detection, the following\n types are returned:

    \n
      \n
    • \n

      \n PAGE - Contains a list of the LINE Block objects\n that are detected on a document page.

      \n
      • \n
    • \n

      \n WORD - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.

      \n
      • \n
    • \n

      \n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.

      \n
      • \n
    \n

    In text analysis operations, the following types are returned:

    \n
      \n
    • \n

      \n PAGE - Contains a list of child Block objects\n that are detected on a document page.

      \n
      • \n
    • \n

      \n KEY_VALUE_SET - Stores the KEY and VALUE Block\n objects for linked text that's detected on a document page. Use the\n EntityType field to determine if a KEY_VALUE_SET object is a KEY\n Block object or a VALUE Block object.

      \n
      • \n
    • \n

      \n WORD - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.

      \n
      • \n
    • \n

      \n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.

      \n
      • \n
    • \n

      \n TABLE - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each.

      \n
      • \n
    • \n

      \n CELL - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.

      \n
      • \n
    • \n

      \n SELECTION_ELEMENT - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of SelectionStatus to determine the status of the selection\n element.

      \n
      • \n
    " } }, - "EntityTypes": { - "target": "com.amazonaws.textract#EntityTypes", + "Id": { + "target": "com.amazonaws.textract#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The type of entity. The following can be returned:

    \n
      \n
    • \n

      \n KEY - An identifier for a field on the document.

      \n
      • \n
    • \n

      \n VALUE - The field text.

      \n
      • \n
    \n

    \n EntityTypes isn't returned by DetectDocumentText and\n GetDocumentTextDetection.

    " + "smithy.api#documentation": "

    The identifier for the recognized text. The identifier is only unique for a single\n operation.

    " } }, - "ColumnIndex": { - "target": "com.amazonaws.textract#UInteger", + "Geometry": { + "target": "com.amazonaws.textract#Geometry", "traits": { - "smithy.api#documentation": "

    The column in which a table cell appears. The first column position is 1.\n ColumnIndex isn't returned by DetectDocumentText and\n GetDocumentTextDetection.

    " + "smithy.api#documentation": "

    The location of the recognized text on the image. It includes an axis-aligned, coarse\n bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial\n information.

    " } }, "SelectionStatus": { @@ -196,22 +208,16 @@ "smithy.api#documentation": "

    The selection status of a selection element, such as an option button or check box.

    " } }, - "Relationships": { - "target": "com.amazonaws.textract#RelationshipList", - "traits": { - "smithy.api#documentation": "

    A list of child blocks of the current block. For example, a LINE object has child blocks\n for each WORD block that's part of the line of text. There aren't Relationship objects in\n the list for relationships that don't exist, such as when the current block has no child\n blocks. The list size can be the following:

    \n
      \n
    • \n

      0 - The block has no child blocks.

      \n
      • \n
    • \n

      1 - The block has child blocks.

      \n
      • \n
    " - } - }, "ColumnSpan": { "target": "com.amazonaws.textract#UInteger", "traits": { "smithy.api#documentation": "

    The number of columns that a table cell spans. Currently this value is always 1, even\n if the number of columns spanned is greater than 1. ColumnSpan isn't returned by\n DetectDocumentText and GetDocumentTextDetection.

    " } }, - "Geometry": { - "target": "com.amazonaws.textract#Geometry", + "Relationships": { + "target": "com.amazonaws.textract#RelationshipList", "traits": { - "smithy.api#documentation": "

    The location of the recognized text on the image. It includes an axis-aligned, coarse\n bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial\n information.

    " + "smithy.api#documentation": "

    A list of child blocks of the current block. For example, a LINE object has child blocks\n for each WORD block that's part of the line of text. There aren't Relationship objects in\n the list for relationships that don't exist, such as when the current block has no child\n blocks. The list size can be the following:

    \n
      \n
    • \n

      0 - The block has no child blocks.

      \n
      • \n
    • \n

      1 - The block has child blocks.

      \n
      • \n
    " } }, "Page": { @@ -220,22 +226,16 @@ "smithy.api#documentation": "

    The page on which a block was detected. Page is returned by asynchronous\n operations. Page values greater than 1 are only returned for multipage documents that are\n in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is\n considered to be a single-page document. The value of Page is always 1.\n Synchronous operations don't return Page because every input document is\n considered to be a single-page document.

    " } }, - "RowSpan": { - "target": "com.amazonaws.textract#UInteger", - "traits": { - "smithy.api#documentation": "

    The number of rows that a table cell spans. Currently this value is always 1, even\n if the number of rows spanned is greater than 1. RowSpan isn't returned by\n DetectDocumentText and GetDocumentTextDetection.

    " - } - }, - "BlockType": { - "target": "com.amazonaws.textract#BlockType", + "Confidence": { + "target": "com.amazonaws.textract#Percent", "traits": { - "smithy.api#documentation": "

    The type of text item that's recognized. In operations for text detection, the following\n types are returned:

    \n
      \n
    • \n

      \n PAGE - Contains a list of the LINE Block objects\n that are detected on a document page.

      \n
      • \n
    • \n

      \n WORD - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.

      \n
      • \n
    • \n

      \n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.

      \n
      • \n
    \n

    In text analysis operations, the following types are returned:

    \n
      \n
    • \n

      \n PAGE - Contains a list of child Block objects\n that are detected on a document page.

      \n
      • \n
    • \n

      \n KEY_VALUE_SET - Stores the KEY and VALUE Block\n objects for linked text that's detected on a document page. Use the\n EntityType field to determine if a KEY_VALUE_SET object is a KEY\n Block object or a VALUE Block object.

      \n
      • \n
    • \n

      \n WORD - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.

      \n
      • \n
    • \n

      \n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.

      \n
      • \n
    • \n

      \n TABLE - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each.

      \n
      • \n
    • \n

      \n CELL - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.

      \n
      • \n
    • \n

      \n SELECTION_ELEMENT - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of SelectionStatus to determine the status of the selection\n element.

      \n
      • \n
    " + "smithy.api#documentation": "

    The confidence score that Amazon Textract has in the accuracy of the recognized text and\n the accuracy of the geometry points around the recognized text.

    " } }, - "Id": { - "target": "com.amazonaws.textract#NonEmptyString", + "ColumnIndex": { + "target": "com.amazonaws.textract#UInteger", "traits": { - "smithy.api#documentation": "

    The identifier for the recognized text. The identifier is only unique for a single\n operation.

    " + "smithy.api#documentation": "

    The column in which a table cell appears. The first column position is 1.\n ColumnIndex isn't returned by DetectDocumentText and\n GetDocumentTextDetection.

    " } } }, @@ -299,16 +299,16 @@ "smithy.api#documentation": "

    The left coordinate of the bounding box as a ratio of overall document page\n width.

    " } }, - "Width": { + "Height": { "target": "com.amazonaws.textract#Float", "traits": { - "smithy.api#documentation": "

    The width of the bounding box as a ratio of the overall document page\n width.

    " + "smithy.api#documentation": "

    The height of the bounding box as a ratio of the overall document page\n height.

    " } }, - "Height": { + "Width": { "target": "com.amazonaws.textract#Float", "traits": { - "smithy.api#documentation": "

    The height of the bounding box as a ratio of the overall document page\n height.

    " + "smithy.api#documentation": "

    The width of the bounding box as a ratio of the overall document page\n width.

    " } } }, @@ -409,18 +409,18 @@ "com.amazonaws.textract#DetectDocumentTextResponse": { "type": "structure", "members": { - "DetectDocumentTextModelVersion": { - "target": "com.amazonaws.textract#String", - "traits": { - "smithy.api#documentation": "

    " - } - }, "DocumentMetadata": { "target": "com.amazonaws.textract#DocumentMetadata", "traits": { "smithy.api#documentation": "

    Metadata about the document. It contains the number of pages that are detected in the\n document.

    " } }, + "DetectDocumentTextModelVersion": { + "target": "com.amazonaws.textract#String", + "traits": { + "smithy.api#documentation": "

    " + } + }, "Blocks": { "target": "com.amazonaws.textract#BlockList", "traits": { @@ -480,10 +480,10 @@ "com.amazonaws.textract#DocumentTooLargeException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.textract#String" }, - "Message": { + "Code": { "target": "com.amazonaws.textract#String" } }, @@ -552,17 +552,17 @@ "com.amazonaws.textract#Geometry": { "type": "structure", "members": { - "Polygon": { - "target": "com.amazonaws.textract#Polygon", - "traits": { - "smithy.api#documentation": "

    Within the bounding box, a fine-grained polygon around the recognized item.

    " - } - }, "BoundingBox": { "target": "com.amazonaws.textract#BoundingBox", "traits": { "smithy.api#documentation": "

    An axis-aligned coarse representation of the location of the recognized item on the\n document page.

    " } + }, + "Polygon": { + "target": "com.amazonaws.textract#Polygon", + "traits": { + "smithy.api#documentation": "

    Within the bounding box, a fine-grained polygon around the recognized item.

    " + } } }, "traits": { @@ -590,6 +590,9 @@ { "target": "com.amazonaws.textract#InvalidParameterException" }, + { + "target": "com.amazonaws.textract#InvalidS3ObjectException" + }, { "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" }, @@ -604,11 +607,10 @@ "com.amazonaws.textract#GetDocumentAnalysisRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.textract#JobId", + "NextToken": { + "target": "com.amazonaws.textract#PaginationToken", "traits": { - "smithy.api#documentation": "

    A unique identifier for the text-detection job. The JobId is returned from\n StartDocumentAnalysis. A JobId value is only valid for 7 days.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of blocks.

    " } }, "MaxResults": { @@ -617,10 +619,11 @@ "smithy.api#documentation": "

    The maximum number of results to return per paginated call. The largest value that you\n can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results\n is returned. The default value is 1,000.

    " } }, - "NextToken": { - "target": "com.amazonaws.textract#PaginationToken", + "JobId": { + "target": "com.amazonaws.textract#JobId", "traits": { - "smithy.api#documentation": "

    If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of blocks.

    " + "smithy.api#documentation": "

    A unique identifier for the text-detection job. The JobId is returned from\n StartDocumentAnalysis. A JobId value is only valid for 7 days.

    ", + "smithy.api#required": {} } } } @@ -655,7 +658,7 @@ "StatusMessage": { "target": "com.amazonaws.textract#StatusMessage", "traits": { - "smithy.api#documentation": "

    The current status of an asynchronous document-analysis operation.

    " + "smithy.api#documentation": "

    Returns if the detection job could not be completed. Contains explanation for what error occured.

    " } }, "NextToken": { @@ -693,6 +696,9 @@ { "target": "com.amazonaws.textract#InvalidParameterException" }, + { + "target": "com.amazonaws.textract#InvalidS3ObjectException" + }, { "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" }, @@ -731,28 +737,28 @@ "com.amazonaws.textract#GetDocumentTextDetectionResponse": { "type": "structure", "members": { - "Warnings": { - "target": "com.amazonaws.textract#Warnings", - "traits": { - "smithy.api#documentation": "

    A list of warnings that occurred during the text-detection operation for the\n document.

    " - } - }, "DetectDocumentTextModelVersion": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "

    " } }, - "StatusMessage": { - "target": "com.amazonaws.textract#StatusMessage", + "DocumentMetadata": { + "target": "com.amazonaws.textract#DocumentMetadata", "traits": { - "smithy.api#documentation": "

    The current status of an asynchronous text-detection operation for the document.

    " + "smithy.api#documentation": "

    Information about a document that Amazon Textract processed. DocumentMetadata is\n returned in every page of paginated responses from an Amazon Textract video operation.

    " } }, - "JobStatus": { - "target": "com.amazonaws.textract#JobStatus", + "Warnings": { + "target": "com.amazonaws.textract#Warnings", "traits": { - "smithy.api#documentation": "

    The current status of the text detection job.

    " + "smithy.api#documentation": "

    A list of warnings that occurred during the text-detection operation for the\n document.

    " + } + }, + "StatusMessage": { + "target": "com.amazonaws.textract#StatusMessage", + "traits": { + "smithy.api#documentation": "

    Returns if the detection job could not be completed. Contains explanation for what error occured.

    " } }, "NextToken": { @@ -761,16 +767,16 @@ "smithy.api#documentation": "

    If the response is truncated, Amazon Textract returns this token. You can use this token in\n the subsequent request to retrieve the next set of text-detection results.

    " } }, - "Blocks": { - "target": "com.amazonaws.textract#BlockList", + "JobStatus": { + "target": "com.amazonaws.textract#JobStatus", "traits": { - "smithy.api#documentation": "

    The results of the text-detection operation.

    " + "smithy.api#documentation": "

    The current status of the text detection job.

    " } }, - "DocumentMetadata": { - "target": "com.amazonaws.textract#DocumentMetadata", + "Blocks": { + "target": "com.amazonaws.textract#BlockList", "traits": { - "smithy.api#documentation": "

    Information about a document that Amazon Textract processed. DocumentMetadata is\n returned in every page of paginated responses from an Amazon Textract video operation.

    " + "smithy.api#documentation": "

    The results of the text-detection operation.

    " } } } @@ -883,16 +889,25 @@ "target": "com.amazonaws.textract#String" }, "ResourceType": { - "target": "com.amazonaws.textract#String" + "target": "com.amazonaws.textract#String", + "traits": { + "smithy.api#documentation": "

    The resource type.

    " + } }, "Message": { "target": "com.amazonaws.textract#String" }, - "QuotaCode": { - "target": "com.amazonaws.textract#String" - }, "ServiceCode": { - "target": "com.amazonaws.textract#String" + "target": "com.amazonaws.textract#String", + "traits": { + "smithy.api#documentation": "

    The service code.

    " + } + }, + "QuotaCode": { + "target": "com.amazonaws.textract#String", + "traits": { + "smithy.api#documentation": "

    The quota code.

    " + } } }, "traits": { @@ -979,15 +994,15 @@ "com.amazonaws.textract#InvalidS3ObjectException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.textract#String" }, - "Message": { + "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { - "smithy.api#documentation": "

    Amazon Textract is unable to access the S3 object that's specified in the request.

    ", + "smithy.api#documentation": "

    Amazon Textract is unable to access the S3 object that's specified in the request.\n for more information, Configure Access to Amazon S3\n For troubleshooting information, see Troubleshooting Amazon S3\n

    ", "smithy.api#error": "client" } }, @@ -1086,6 +1101,27 @@ "smithy.api#documentation": "

    The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of\n an asynchronous document operation, such as StartDocumentTextDetection.

    " } }, + "com.amazonaws.textract#OutputConfig": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.textract#S3Bucket", + "traits": { + "smithy.api#documentation": "

    The name of the bucket your output will go to.

    ", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.textract#S3ObjectName", + "traits": { + "smithy.api#documentation": "

    The prefix of the object key that the output will be saved to. When \n not enabled, the prefix will be “textract_output\".

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Sets whether or not your output will go to a user created bucket. \n Used to set the name of the bucket, and the prefix on the output \n file.

    " + } + }, "com.amazonaws.textract#Pages": { "type": "list", "member": { @@ -1115,16 +1151,16 @@ "com.amazonaws.textract#Point": { "type": "structure", "members": { - "X": { + "Y": { "target": "com.amazonaws.textract#Float", "traits": { - "smithy.api#documentation": "

    The value of the X coordinate for a point on a Polygon.

    " + "smithy.api#documentation": "

    The value of the Y coordinate for a point on a Polygon.

    " } }, - "Y": { + "X": { "target": "com.amazonaws.textract#Float", "traits": { - "smithy.api#documentation": "

    The value of the Y coordinate for a point on a Polygon.

    " + "smithy.api#documentation": "

    The value of the X coordinate for a point on a Polygon.

    " } } }, @@ -1159,7 +1195,7 @@ "Type": { "target": "com.amazonaws.textract#RelationshipType", "traits": { - "smithy.api#documentation": "

    The type of relationship that the blocks in the IDs array have with the current block.\n The relationship can be VALUE or CHILD. A relationship of type \n VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. \n A relationship of type CHILD is a list of IDs that identify WORD blocks.

    " + "smithy.api#documentation": "

    The type of relationship that the blocks in the IDs array have with the current block.\n The relationship can be VALUE or CHILD. A relationship of type \n VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. \n A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines\n Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.

    " } }, "Ids": { @@ -1190,6 +1226,10 @@ { "value": "CHILD", "name": "CHILD" + }, + { + "value": "COMPLEX_FEATURES", + "name": "COMPLEX_FEATURES" } ] } @@ -1335,12 +1375,6 @@ "com.amazonaws.textract#StartDocumentAnalysisRequest": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.textract#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

    The idempotent token that you use to identify the start request. If you use the same\n token with multiple StartDocumentAnalysis requests, the same\n JobId is returned. Use ClientRequestToken to prevent the same\n job from being accidentally started more than once. For more information, see\n Calling Amazon Textract Asynchronous Operations.

    " - } - }, "NotificationChannel": { "target": "com.amazonaws.textract#NotificationChannel", "traits": { @@ -1354,10 +1388,10 @@ "smithy.api#required": {} } }, - "JobTag": { - "target": "com.amazonaws.textract#JobTag", + "ClientRequestToken": { + "target": "com.amazonaws.textract#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    An identifier that you specify that's included in the completion notification published\n to the Amazon SNS topic. For example, you can use JobTag to identify the type of\n document that the completion notification corresponds to (such as a tax form or a\n receipt).

    " + "smithy.api#documentation": "

    The idempotent token that you use to identify the start request. If you use the same\n token with multiple StartDocumentAnalysis requests, the same\n JobId is returned. Use ClientRequestToken to prevent the same\n job from being accidentally started more than once. For more information, see\n Calling Amazon Textract Asynchronous Operations.

    " } }, "FeatureTypes": { @@ -1366,6 +1400,18 @@ "smithy.api#documentation": "

    A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected\n form data. To perform both types of analysis, add TABLES\n and FORMS to FeatureTypes. All lines and words detected in the document are\n included in the response (including text that isn't related to the value of\n FeatureTypes).

    ", "smithy.api#required": {} } + }, + "OutputConfig": { + "target": "com.amazonaws.textract#OutputConfig", + "traits": { + "smithy.api#documentation": "

    Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save\n the results internally to be accessed by the GetDocumentAnalysis operation.

    " + } + }, + "JobTag": { + "target": "com.amazonaws.textract#JobTag", + "traits": { + "smithy.api#documentation": "

    An identifier that you specify that's included in the completion notification published\n to the Amazon SNS topic. For example, you can use JobTag to identify the type of\n document that the completion notification corresponds to (such as a tax form or a\n receipt).

    " + } } } }, @@ -1430,13 +1476,6 @@ "com.amazonaws.textract#StartDocumentTextDetectionRequest": { "type": "structure", "members": { - "DocumentLocation": { - "target": "com.amazonaws.textract#DocumentLocation", - "traits": { - "smithy.api#documentation": "

    The location of the document to be processed.

    ", - "smithy.api#required": {} - } - }, "JobTag": { "target": "com.amazonaws.textract#JobTag", "traits": { @@ -1449,11 +1488,24 @@ "smithy.api#documentation": "

    The idempotent token that's used to identify the start request. If you use the same\n token with multiple StartDocumentTextDetection requests, the same\n JobId is returned. Use ClientRequestToken to prevent the same\n job from being accidentally started more than once. For more information, see\n Calling Amazon Textract Asynchronous Operations.

    " } }, + "OutputConfig": { + "target": "com.amazonaws.textract#OutputConfig", + "traits": { + "smithy.api#documentation": "

    Sets if the output will go to a customer defined bucket. By default Amazon Textract will\n save the results internally to be accessed with the GetDocumentTextDetection operation.

    " + } + }, "NotificationChannel": { "target": "com.amazonaws.textract#NotificationChannel", "traits": { "smithy.api#documentation": "

    The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the\n operation to.

    " } + }, + "DocumentLocation": { + "target": "com.amazonaws.textract#DocumentLocation", + "traits": { + "smithy.api#documentation": "

    The location of the document to be processed.

    ", + "smithy.api#required": {} + } } } }, @@ -1525,10 +1577,10 @@ "com.amazonaws.textract#ThrottlingException": { "type": "structure", "members": { - "Code": { + "Message": { "target": "com.amazonaws.textract#String" }, - "Message": { + "Code": { "target": "com.amazonaws.textract#String" } }, @@ -1564,17 +1616,17 @@ "com.amazonaws.textract#Warning": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.textract#ErrorCode", - "traits": { - "smithy.api#documentation": "

    The error code for the warning.

    " - } - }, "Pages": { "target": "com.amazonaws.textract#Pages", "traits": { "smithy.api#documentation": "

    A list of the pages that the warning applies to.

    " } + }, + "ErrorCode": { + "target": "com.amazonaws.textract#ErrorCode", + "traits": { + "smithy.api#documentation": "

    The error code for the warning.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json b/codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json new file mode 100644 index 000000000000..186c1f618bce --- /dev/null +++ b/codegen/sdk-codegen/aws-models/timestream-query.2018-11-01.json @@ -0,0 +1,651 @@ +{ + "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.timestreamquery#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ServiceErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    \n You are not authorized to perform this action.\n

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.timestreamquery#CancelQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#CancelQueryRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#CancelQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    \n Cancels a query that has been issued. Cancellation is guaranteed only if the query has not \n completed execution before the cancellation request was issued. Because cancellation is an idempotent operation, \n subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled.\n

    ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.timestreamquery#CancelQueryRequest": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.timestreamquery#QueryId", + "traits": { + "smithy.api#documentation": "

    \n The id of the query that needs to be cancelled. QueryID is returned as part of QueryResult.\n

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamquery#CancelQueryResponse": { + "type": "structure", + "members": { + "CancellationMessage": { + "target": "com.amazonaws.timestreamquery#String", + "traits": { + "smithy.api#documentation": "

    \n A CancellationMessage is returned when a CancelQuery request for the query specified by QueryId has already been issued. \n

    " + } + } + } + }, + "com.amazonaws.timestreamquery#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.timestreamquery#ColumnInfo": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.timestreamquery#String", + "traits": { + "smithy.api#documentation": "

    \n The name of the result set column. The name of the result set is available for columns of all data types except for arrays.\n

    " + } + }, + "Type": { + "target": "com.amazonaws.timestreamquery#Type", + "traits": { + "smithy.api#documentation": "

    \n The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, strings, doubles, booleans, and others. Complex data types are types such as arrays, rows, and others.\n

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    \n Contains the meta data for query results such as the column names, data types, and other attributes.\n

    " + } + }, + "com.amazonaws.timestreamquery#ColumnInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#ColumnInfo" + } + }, + "com.amazonaws.timestreamquery#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    \n Unable to poll results for a cancelled query.\n

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.timestreamquery#Datum": { + "type": "structure", + "members": { + "TimeSeriesValue": { + "target": "com.amazonaws.timestreamquery#TimeSeriesDataPointList", + "traits": { + "smithy.api#documentation": "

    \n Indicates if the data point is of timeseries data type.\n

    " + } + }, + "NullValue": { + "target": "com.amazonaws.timestreamquery#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    \n Indicates if the data point is null.\n

    " + } + }, + "RowValue": { + "target": "com.amazonaws.timestreamquery#Row", + "traits": { + "smithy.api#documentation": "

    \n Indicates if the data point is a row.\n

    " + } + }, + "ScalarValue": { + "target": "com.amazonaws.timestreamquery#ScalarValue", + "traits": { + "smithy.api#documentation": "

    \n Indicates if the data point is a scalar value such as integer, string, double, or boolean.\n

    " + } + }, + "ArrayValue": { + "target": "com.amazonaws.timestreamquery#DatumList", + "traits": { + "smithy.api#documentation": "

    \n Indicates if the data point is an array.\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    \n Datum represents a single data point in a query result.\n

    " + } + }, + "com.amazonaws.timestreamquery#DatumList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#Datum" + } + }, + "com.amazonaws.timestreamquery#DescribeEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#DescribeEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#DescribeEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.\n This API is available through both Write and Query.

    \n

    Because Timestream’s SDKs are designed to transparently work with the service’s architecture, \n including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:

    \n
      \n
    • \n

      Your application uses a programming language that does not yet have SDK support

      \n
      • \n
    • \n

      You require better control over the client-side implementation

      \n
      • \n
    \n

    For detailed information on how to use DescribeEndpoints, \n see The Endpoint Discovery Pattern and REST APIs.

    " + } + }, + "com.amazonaws.timestreamquery#DescribeEndpointsRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.timestreamquery#DescribeEndpointsResponse": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.timestreamquery#Endpoints", + "traits": { + "smithy.api#documentation": "

    An Endpoints object is returned when a DescribeEndpoints request is made.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamquery#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.timestreamquery#String", + "traits": { + "smithy.api#documentation": "

    An endpoint address.

    ", + "smithy.api#required": {} + } + }, + "CachePeriodInMinutes": { + "target": "com.amazonaws.timestreamquery#Long", + "traits": { + "smithy.api#documentation": "

    The TTL for the endpoint, in minutes.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.

    " + } + }, + "com.amazonaws.timestreamquery#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#Endpoint" + } + }, + "com.amazonaws.timestreamquery#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.timestreamquery#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    \n Timestream was unable to fully process this request because of an internal server error.\n

    ", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.timestreamquery#InvalidEndpointException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The requested endpoint was invalid.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 421 + } + }, + "com.amazonaws.timestreamquery#Long": { + "type": "long" + }, + "com.amazonaws.timestreamquery#MaxQueryResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.timestreamquery#NullableBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.timestreamquery#Query": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamquery#QueryRequest" + }, + "output": { + "target": "com.amazonaws.timestreamquery#QueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamquery#ConflictException" + }, + { + "target": "com.amazonaws.timestreamquery#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamquery#QueryExecutionException" + }, + { + "target": "com.amazonaws.timestreamquery#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamquery#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    \n Query is a synchronous operation that enables you to execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide.\n

    ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Rows", + "pageSize": "MaxRows" + } + } + }, + "com.amazonaws.timestreamquery#QueryExecutionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    \n Timestream was unable to run the query successfully.\n

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.timestreamquery#QueryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[a-zA-Z0-9]+" + } + }, + "com.amazonaws.timestreamquery#QueryRequest": { + "type": "structure", + "members": { + "QueryString": { + "target": "com.amazonaws.timestreamquery#QueryString", + "traits": { + "smithy.api#documentation": "

    \n The query to be executed by Timestream.\n

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.timestreamquery#String", + "traits": { + "smithy.api#documentation": "

    \n A pagination token passed to get a set of results.\n

    " + } + }, + "MaxRows": { + "target": "com.amazonaws.timestreamquery#MaxQueryResults", + "traits": { + "smithy.api#documentation": "

    \n The total number of rows to return in the output. If the total number of rows available\n is more than the value specified, a NextToken is provided in the command's output.\n To resume pagination, provide the NextToken value in the starting-token argument of a \n subsequent command.\n

    " + } + }, + "ClientToken": { + "target": "com.amazonaws.timestreamquery#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

    \n Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request.\n Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls \n have the same effect as one single call.\n

    \n\n

    Your query request will fail in the following cases:

    \n
      \n
    • \n

      \n If you submit a request with the same client token outside the 5-minute idepotency window.\n

      \n
      • \n
    • \n

      \n If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window. \n

      \n
      • \n
    \n\n

    \n After 4 hours, any request with the same client token is treated as a new request.\n

    ", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.timestreamquery#QueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.timestreamquery#QueryId", + "traits": { + "smithy.api#documentation": "

    \n A unique ID for the given query.\n

    ", + "smithy.api#required": {} + } + }, + "Rows": { + "target": "com.amazonaws.timestreamquery#RowList", + "traits": { + "smithy.api#documentation": "

    \n The result set rows returned by the query.\n

    ", + "smithy.api#required": {} + } + }, + "ColumnInfo": { + "target": "com.amazonaws.timestreamquery#ColumnInfoList", + "traits": { + "smithy.api#documentation": "

    \n The column data types of the returned result set.\n

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.timestreamquery#String", + "traits": { + "smithy.api#documentation": "

    \n A pagination token that can be used again on a Query call to get the next set of results. \n

    " + } + } + } + }, + "com.amazonaws.timestreamquery#QueryString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.timestreamquery#Row": { + "type": "structure", + "members": { + "Data": { + "target": "com.amazonaws.timestreamquery#DatumList", + "traits": { + "smithy.api#documentation": "

    List of data points in a single row of the result set.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents a single row in the query results.

    " + } + }, + "com.amazonaws.timestreamquery#RowList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#Row" + } + }, + "com.amazonaws.timestreamquery#ScalarType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARCHAR", + "name": "VARCHAR" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "BIGINT", + "name": "BIGINT" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "TIMESTAMP", + "name": "TIMESTAMP" + }, + { + "value": "DATE", + "name": "DATE" + }, + { + "value": "TIME", + "name": "TIME" + }, + { + "value": "INTERVAL_DAY_TO_SECOND", + "name": "INTERVAL_DAY_TO_SECOND" + }, + { + "value": "INTERVAL_YEAR_TO_MONTH", + "name": "INTERVAL_YEAR_TO_MONTH" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "INTEGER", + "name": "INTEGER" + } + ] + } + }, + "com.amazonaws.timestreamquery#ScalarValue": { + "type": "string" + }, + "com.amazonaws.timestreamquery#ServiceErrorMessage": { + "type": "string" + }, + "com.amazonaws.timestreamquery#String": { + "type": "string" + }, + "com.amazonaws.timestreamquery#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The request was denied due to request throttling.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.timestreamquery#TimeSeriesDataPoint": { + "type": "structure", + "members": { + "Time": { + "target": "com.amazonaws.timestreamquery#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp when the measure value was collected.

    ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.timestreamquery#Datum", + "traits": { + "smithy.api#documentation": "

    The measure value for the data point.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The timeseries datatype represents the values of a measure over time. A time series is an array of rows of timestamps and measure values, with rows sorted in ascending order of time. A TimeSeriesDataPoint is a single data point in the timeseries. It represents a tuple of (time, measure value) in a timeseries.

    " + } + }, + "com.amazonaws.timestreamquery#TimeSeriesDataPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamquery#TimeSeriesDataPoint" + } + }, + "com.amazonaws.timestreamquery#Timestamp": { + "type": "string" + }, + "com.amazonaws.timestreamquery#Timestream_20181101": { + "type": "service", + "version": "2018-11-01", + "operations": [ + { + "target": "com.amazonaws.timestreamquery#CancelQuery" + }, + { + "target": "com.amazonaws.timestreamquery#DescribeEndpoints" + }, + { + "target": "com.amazonaws.timestreamquery#Query" + } + ], + "traits": { + "aws.api#clientEndpointDiscovery": { + "operation": "com.amazonaws.timestreamquery#DescribeEndpoints", + "error": "com.amazonaws.timestreamquery#InvalidEndpointException" + }, + "aws.api#service": { + "sdkId": "Timestream Query", + "arnNamespace": "timestream", + "cloudFormationName": "TimestreamQuery", + "cloudTrailEventSource": "query.v20181101.timestream.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "timestream" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

    \n \n

    ", + "smithy.api#title": "Amazon Timestream Query" + } + }, + "com.amazonaws.timestreamquery#Type": { + "type": "structure", + "members": { + "RowColumnInfo": { + "target": "com.amazonaws.timestreamquery#ColumnInfoList", + "traits": { + "smithy.api#documentation": "

    Indicates if the column is a row.

    " + } + }, + "TimeSeriesMeasureValueColumnInfo": { + "target": "com.amazonaws.timestreamquery#ColumnInfo", + "traits": { + "smithy.api#documentation": "

    Indicates if the column is a timeseries data type.

    " + } + }, + "ScalarType": { + "target": "com.amazonaws.timestreamquery#ScalarType", + "traits": { + "smithy.api#documentation": "

    Indicates if the column is of type string, integer, boolean, double, timestamp, date, time.

    " + } + }, + "ArrayColumnInfo": { + "target": "com.amazonaws.timestreamquery#ColumnInfo", + "traits": { + "smithy.api#documentation": "

    Indicates if the column is an array.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains the data type of a column in a query result set. The data type can be scalar or complex. The supported scalar data types are integers, boolean, string, double, timestamp, date, time, and intervals. The supported complex data types are arrays, rows, and timeseries.

    " + } + }, + "com.amazonaws.timestreamquery#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamquery#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    \n Invalid or malformed request.\n

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/timestream-write.2018-11-01.json b/codegen/sdk-codegen/aws-models/timestream-write.2018-11-01.json new file mode 100644 index 000000000000..be1c55f4db2d --- /dev/null +++ b/codegen/sdk-codegen/aws-models/timestream-write.2018-11-01.json @@ -0,0 +1,1652 @@ +{ + "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.timestreamwrite#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    You are not authorized to perform this action.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.timestreamwrite#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.timestreamwrite#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Timestream was unable to process this request because it contains resource that already exists.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.timestreamwrite#CreateDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#CreateDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#CreateDatabaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#ConflictException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.\n Refer to AWS managed KMS keys for more info. \n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.\n

    " + } + }, + "com.amazonaws.timestreamwrite#CreateDatabaseRequest": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.timestreamwrite#TagList", + "traits": { + "smithy.api#documentation": "

    \n A list of key-value pairs to label the table. \n

    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.timestreamwrite#StringValue2048", + "traits": { + "smithy.api#documentation": "

    The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream\n managed KMS key located in your account. Refer to AWS managed KMS keys for more info.

    " + } + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#CreateDatabaseResponse": { + "type": "structure", + "members": { + "Database": { + "target": "com.amazonaws.timestreamwrite#Database", + "traits": { + "smithy.api#documentation": "

    The newly created Timestream database.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#CreateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#CreateTableRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#CreateTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#ConflictException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    The CreateTable operation adds a new table to an existing database in your account. In an AWS account,\n table names must be at least unique within each Region if they are in the same database. \n You may have identical table names in the same Region if the tables are in seperate databases.\n While creating the table, you must specify the table name, database name,\n and the retention properties.\n Service quotas apply. For more information, see Access Management\n in the Timestream Developer Guide.\n

    " + } + }, + "com.amazonaws.timestreamwrite#CreateTableRequest": { + "type": "structure", + "members": { + "RetentionProperties": { + "target": "com.amazonaws.timestreamwrite#RetentionProperties", + "traits": { + "smithy.api#documentation": "

    The duration for which your time series data must be stored in the memory store and the magnetic store.

    " + } + }, + "Tags": { + "target": "com.amazonaws.timestreamwrite#TagList", + "traits": { + "smithy.api#documentation": "

    \n A list of key-value pairs to label the table. \n

    " + } + }, + "TableName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream table.

    ", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#CreateTableResponse": { + "type": "structure", + "members": { + "Table": { + "target": "com.amazonaws.timestreamwrite#Table", + "traits": { + "smithy.api#documentation": "

    The newly created Timestream table.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#Database": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    " + } + }, + "TableCount": { + "target": "com.amazonaws.timestreamwrite#Long", + "traits": { + "smithy.api#documentation": "

    The total number of tables found within a Timestream database.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.timestreamwrite#Date", + "traits": { + "smithy.api#documentation": "

    The time when the database was created, calculated from the Unix epoch time.

    " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.timestreamwrite#StringValue2048", + "traits": { + "smithy.api#documentation": "

    The identifier of the KMS key used to encrypt the data stored in the database.

    " + } + }, + "Arn": { + "target": "com.amazonaws.timestreamwrite#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name that uniquely identifies this database.

    " + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.timestreamwrite#Date", + "traits": { + "smithy.api#documentation": "

    \n The last time that this database was updated.\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A top level container for a table. Databases and tables are the\n fundamental management concepts in Amazon Timestream. All tables in a \n database are encrypted with the same KMS key.

    " + } + }, + "com.amazonaws.timestreamwrite#DatabaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#Database" + } + }, + "com.amazonaws.timestreamwrite#Date": { + "type": "timestamp" + }, + "com.amazonaws.timestreamwrite#DeleteDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#DeleteDatabaseRequest" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    Deletes a given Timestream database. This is an irreversible operation.\n After a database is deleted, the time series data from its tables cannot be recovered.\n

    \n \n

    All tables in the database must be deleted first, or a ValidationException error will be thrown.\n

    " + } + }, + "com.amazonaws.timestreamwrite#DeleteDatabaseRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database to be deleted.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#DeleteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#DeleteTableRequest" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    Deletes a given Timestream table. This is an irreversible operation.\n After a Timestream database table is deleted, the time series data stored in \n the table cannot be recovered.\n

    " + } + }, + "com.amazonaws.timestreamwrite#DeleteTableRequest": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream table to be deleted.

    ", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the database where the Timestream database is to be deleted.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#DescribeDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#DescribeDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#DescribeDatabaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    Returns information about the database, including the database name, time that the database was created, \n and the total number of tables found within the database.\n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

    " + } + }, + "com.amazonaws.timestreamwrite#DescribeDatabaseRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#DescribeDatabaseResponse": { + "type": "structure", + "members": { + "Database": { + "target": "com.amazonaws.timestreamwrite#Database", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream table.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#DescribeEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#DescribeEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#DescribeEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

    \n

    Because Timestream’s SDKs are designed to transparently work with the service’s architecture, \n including the management and mapping of the service endpoints,\n it is not recommended that you use this API unless:

    \n
      \n
    • \n

      Your application uses a programming language that does not yet have SDK support

      \n
      • \n
    • \n

      You require better control over the client-side implementation

      \n
      • \n
    \n

    For detailed information on how to use DescribeEndpoints, \n see The Endpoint Discovery Pattern and REST APIs.

    " + } + }, + "com.amazonaws.timestreamwrite#DescribeEndpointsRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.timestreamwrite#DescribeEndpointsResponse": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.timestreamwrite#Endpoints", + "traits": { + "smithy.api#documentation": "

    An Endpoints object is returned when a DescribeEndpoints request is made.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#DescribeTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#DescribeTableRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#DescribeTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    Returns information about the table, including the table name, database name, \n retention duration of the memory store and the magnetic store.\n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.\n

    " + } + }, + "com.amazonaws.timestreamwrite#DescribeTableRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    ", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream table.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#DescribeTableResponse": { + "type": "structure", + "members": { + "Table": { + "target": "com.amazonaws.timestreamwrite#Table", + "traits": { + "smithy.api#documentation": "

    The Timestream table.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#Dimension": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.timestreamwrite#StringValue2048", + "traits": { + "smithy.api#documentation": "

    The value of the dimension.

    ", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.timestreamwrite#StringValue256", + "traits": { + "smithy.api#documentation": "

    \n Dimension represents the meta data attributes of the time series. \n For example, the name and availability zone of an EC2 instance or \n the name of the manufacturer of a wind turbine are dimensions.\n Dimension names can only contain alphanumeric characters and underscores. Dimension names cannot end with an underscore.\n

    ", + "smithy.api#required": {} + } + }, + "DimensionValueType": { + "target": "com.amazonaws.timestreamwrite#DimensionValueType", + "traits": { + "smithy.api#documentation": "

    The data type of the dimension for the time series data point.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Dimension represents the meta data attributes of the time series. For example, the name and availability zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.

    " + } + }, + "com.amazonaws.timestreamwrite#DimensionValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARCHAR", + "name": "VARCHAR" + } + ] + } + }, + "com.amazonaws.timestreamwrite#Dimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#Dimension" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.timestreamwrite#Endpoint": { + "type": "structure", + "members": { + "CachePeriodInMinutes": { + "target": "com.amazonaws.timestreamwrite#Long", + "traits": { + "smithy.api#documentation": "

    The TTL for the endpoint, in minutes.

    ", + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.timestreamwrite#String", + "traits": { + "smithy.api#documentation": "

    An endpoint address.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.

    " + } + }, + "com.amazonaws.timestreamwrite#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#Endpoint" + } + }, + "com.amazonaws.timestreamwrite#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.timestreamwrite#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Timestream was unable to fully process this request because of an internal server error.

    ", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.timestreamwrite#InvalidEndpointException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The requested endpoint was invalid.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 421 + } + }, + "com.amazonaws.timestreamwrite#ListDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#ListDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#ListDatabasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    Returns a list of your Timestream databases. \n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.\n

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.timestreamwrite#ListDatabasesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.timestreamwrite#String", + "traits": { + "smithy.api#documentation": "

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.timestreamwrite#PaginationLimit", + "traits": { + "smithy.api#documentation": "

    The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#ListDatabasesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.timestreamwrite#String", + "traits": { + "smithy.api#documentation": "

    The pagination token. This parameter is returned when the response is truncated.

    " + } + }, + "Databases": { + "target": "com.amazonaws.timestreamwrite#DatabaseList", + "traits": { + "smithy.api#documentation": "

    A list of database names.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#ListTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#ListTablesRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#ListTablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    A list of tables, along with the name, status and retention properties of each table.\n

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.timestreamwrite#ListTablesRequest": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.timestreamwrite#PaginationLimit", + "traits": { + "smithy.api#documentation": "

    The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.timestreamwrite#String", + "traits": { + "smithy.api#documentation": "

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#ListTablesResponse": { + "type": "structure", + "members": { + "Tables": { + "target": "com.amazonaws.timestreamwrite#TableList", + "traits": { + "smithy.api#documentation": "

    A list of tables.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.timestreamwrite#String", + "traits": { + "smithy.api#documentation": "

    A token to specify where to start paginating. This is the NextToken from a previously truncated response.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    \nList all tags on a Timestream resource. \n

    " + } + }, + "com.amazonaws.timestreamwrite#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.timestreamwrite#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    \nThe Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).\n

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.timestreamwrite#TagList", + "traits": { + "smithy.api#documentation": "

    \nThe tags currently associated with the Timestream resource.\n

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#Long": { + "type": "long" + }, + "com.amazonaws.timestreamwrite#MagneticStoreRetentionPeriodInDays": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 73000 + } + } + }, + "com.amazonaws.timestreamwrite#MeasureValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "BIGINT", + "name": "BIGINT" + }, + { + "value": "VARCHAR", + "name": "VARCHAR" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + } + ] + } + }, + "com.amazonaws.timestreamwrite#MemoryStoreRetentionPeriodInHours": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 8766 + } + } + }, + "com.amazonaws.timestreamwrite#PaginationLimit": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.timestreamwrite#Record": { + "type": "structure", + "members": { + "TimeUnit": { + "target": "com.amazonaws.timestreamwrite#TimeUnit", + "traits": { + "smithy.api#documentation": "

    \nThe granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.\n

    " + } + }, + "MeasureValueType": { + "target": "com.amazonaws.timestreamwrite#MeasureValueType", + "traits": { + "smithy.api#documentation": "

    \nContains the data type of the measure value for the time series data point.\n

    " + } + }, + "Time": { + "target": "com.amazonaws.timestreamwrite#StringValue256", + "traits": { + "smithy.api#documentation": "

    \nContains the time at which the measure value for the data point was collected.\n

    " + } + }, + "MeasureName": { + "target": "com.amazonaws.timestreamwrite#StringValue256", + "traits": { + "smithy.api#documentation": "

    Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures.

    " + } + }, + "Dimensions": { + "target": "com.amazonaws.timestreamwrite#Dimensions", + "traits": { + "smithy.api#documentation": "

    Contains the list of dimensions for time series data points.

    " + } + }, + "MeasureValue": { + "target": "com.amazonaws.timestreamwrite#StringValue2048", + "traits": { + "smithy.api#documentation": "

    \nContains the measure value for the time series data point. \n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Record represents a time series data point being written into \n Timestream. Each record contains an array of dimensions. Dimensions \n represent the meta data attributes of a time series data point such as\n the instance name or availability zone of an EC2 instance. A record also \n contains the measure name which is the name of the measure being collected \n for example the CPU utilization of an EC2 instance. A record also contains \n the measure value and the value type which is the data type of the measure value.\n In addition, the record contains the timestamp when the measure was collected that \n the timestamp unit which represents the granularity of the timestamp.\n

    " + } + }, + "com.amazonaws.timestreamwrite#RecordIndex": { + "type": "integer" + }, + "com.amazonaws.timestreamwrite#Records": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#Record" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.timestreamwrite#RejectedRecord": { + "type": "structure", + "members": { + "RecordIndex": { + "target": "com.amazonaws.timestreamwrite#RecordIndex", + "traits": { + "smithy.api#documentation": "

    \nThe index of the record in the input request for WriteRecords. Indexes begin with 0. \n

    " + } + }, + "Reason": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    \n The reason why a record was not successfully inserted into Timestream. Possible causes of failure include:\n

    \n
      \n
    • \n

      \n Records with duplicate data where there are multiple records with the same dimensions,\n timestamps, and measure names but different measure values.\n

      \n
      • \n
    • \n

      \n Records with timestamps that lie outside the retention duration of the memory store\n

      \n
      • \n
    • \n

      \n Records with dimensions or measures that exceed the Timestream defined limits.\n

      \n
      • \n
    \n

    \n For more information, see Access Management in the Timestream Developer Guide.\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    \nRecords that were not successfully inserted into Timestream due to data validation issues\nthat must be resolved prior to reinserting time series data into the system.\n

    " + } + }, + "com.amazonaws.timestreamwrite#RejectedRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#RejectedRecord" + } + }, + "com.amazonaws.timestreamwrite#RejectedRecordsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage" + }, + "RejectedRecords": { + "target": "com.amazonaws.timestreamwrite#RejectedRecords" + } + }, + "traits": { + "smithy.api#documentation": "

    \n WriteRecords would throw this exception in the following cases:\n

    \n
      \n
    • \n

      \n Records with duplicate data where there are multiple records with the same dimensions,\n timestamps, and measure names but different measure values.\n

      \n
      • \n
    • \n

      \n Records with timestamps that lie outside the retention duration of the memory store\n

      \n
      • \n
    • \n

      \n Records with dimensions or measures that exceed the Timestream defined limits.\n

      \n
      • \n
    \n

    \n For more information, see Access Management in the Timestream Developer Guide.\n

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 419 + } + }, + "com.amazonaws.timestreamwrite#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + } + }, + "com.amazonaws.timestreamwrite#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.timestreamwrite#RetentionProperties": { + "type": "structure", + "members": { + "MagneticStoreRetentionPeriodInDays": { + "target": "com.amazonaws.timestreamwrite#MagneticStoreRetentionPeriodInDays", + "traits": { + "smithy.api#documentation": "

    The duration for which data must be stored in the magnetic store.

    ", + "smithy.api#required": {} + } + }, + "MemoryStoreRetentionPeriodInHours": { + "target": "com.amazonaws.timestreamwrite#MemoryStoreRetentionPeriodInHours", + "traits": { + "smithy.api#documentation": "

    The duration for which data must be stored in the memory store.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Retention properties contain the duration for which your time series data must be stored in the magnetic store and the memory store.\n

    " + } + }, + "com.amazonaws.timestreamwrite#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    Instance quota of resource exceeded for this account.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.timestreamwrite#String": { + "type": "string" + }, + "com.amazonaws.timestreamwrite#StringValue2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.timestreamwrite#StringValue256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.timestreamwrite#Table": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.timestreamwrite#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name that uniquely identifies this table.

    " + } + }, + "RetentionProperties": { + "target": "com.amazonaws.timestreamwrite#RetentionProperties", + "traits": { + "smithy.api#documentation": "

    The retention duration for the memory store and magnetic store.

    " + } + }, + "TableStatus": { + "target": "com.amazonaws.timestreamwrite#TableStatus", + "traits": { + "smithy.api#documentation": "

    The current state of the table:

    \n
      \n
    • \n

      \n DELETING - The table is being deleted.

      \n
      • \n
    • \n

      \n ACTIVE - The table is ready for use.

      \n
      • \n
    " + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.timestreamwrite#Date", + "traits": { + "smithy.api#documentation": "

    The time when the Timestream table was last updated.

    " + } + }, + "TableName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream table.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.timestreamwrite#Date", + "traits": { + "smithy.api#documentation": "

    The time when the Timestream table was created.

    " + } + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database that contains this table.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Table represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a table.\n

    " + } + }, + "com.amazonaws.timestreamwrite#TableList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#Table" + } + }, + "com.amazonaws.timestreamwrite#TableStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.timestreamwrite#Tag": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.timestreamwrite#TagValue", + "traits": { + "smithy.api#documentation": "

    \nThe value of the tag. Tag values are case-sensitive and can be null.\n

    ", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.timestreamwrite#TagKey", + "traits": { + "smithy.api#documentation": "

    \nThe key of the tag. Tag keys are case sensitive. \n

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    \nA tag is a label that you assign to a Timestream database and/or table. Each tag consists \nof a key and an optional value, both of which you define. Tags enable you to \ncategorize databases and/or tables, for example, by purpose, owner, or environment.\n

    " + } + }, + "com.amazonaws.timestreamwrite#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.timestreamwrite#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.timestreamwrite#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.timestreamwrite#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    \n Associate a set of tags with a Timestream resource. You can then activate\n these user-defined tags so that they appear on the Billing and Cost\n Management console for cost allocation tracking.\n

    " + } + }, + "com.amazonaws.timestreamwrite#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.timestreamwrite#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    \n Identifies the Timestream resource to which tags should be added. This value is an\n Amazon Resource Name (ARN).\n

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.timestreamwrite#TagList", + "traits": { + "smithy.api#documentation": "

    \nThe tags to be assigned to the Timestream resource.\n

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.timestreamwrite#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.timestreamwrite#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Too many requests were made by a user exceeding service quotas. The request was throttled.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.timestreamwrite#TimeUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MILLISECONDS", + "name": "MILLISECONDS" + }, + { + "value": "SECONDS", + "name": "SECONDS" + }, + { + "value": "MICROSECONDS", + "name": "MICROSECONDS" + }, + { + "value": "NANOSECONDS", + "name": "NANOSECONDS" + } + ] + } + }, + "com.amazonaws.timestreamwrite#Timestream_20181101": { + "type": "service", + "version": "2018-11-01", + "operations": [ + { + "target": "com.amazonaws.timestreamwrite#CreateDatabase" + }, + { + "target": "com.amazonaws.timestreamwrite#CreateTable" + }, + { + "target": "com.amazonaws.timestreamwrite#DeleteDatabase" + }, + { + "target": "com.amazonaws.timestreamwrite#DeleteTable" + }, + { + "target": "com.amazonaws.timestreamwrite#DescribeDatabase" + }, + { + "target": "com.amazonaws.timestreamwrite#DescribeEndpoints" + }, + { + "target": "com.amazonaws.timestreamwrite#DescribeTable" + }, + { + "target": "com.amazonaws.timestreamwrite#ListDatabases" + }, + { + "target": "com.amazonaws.timestreamwrite#ListTables" + }, + { + "target": "com.amazonaws.timestreamwrite#ListTagsForResource" + }, + { + "target": "com.amazonaws.timestreamwrite#TagResource" + }, + { + "target": "com.amazonaws.timestreamwrite#UntagResource" + }, + { + "target": "com.amazonaws.timestreamwrite#UpdateDatabase" + }, + { + "target": "com.amazonaws.timestreamwrite#UpdateTable" + }, + { + "target": "com.amazonaws.timestreamwrite#WriteRecords" + } + ], + "traits": { + "aws.api#clientEndpointDiscovery": { + "operation": "com.amazonaws.timestreamwrite#DescribeEndpoints", + "error": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + "aws.api#service": { + "sdkId": "Timestream Write", + "arnNamespace": "timestream", + "cloudFormationName": "TimestreamWrite", + "cloudTrailEventSource": "v20181101.timestream.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "timestream" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

    Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications. Timestream is built from the ground up to effectively ingest, process, and store time series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.

    ", + "smithy.api#title": "Amazon Timestream Write" + } + }, + "com.amazonaws.timestreamwrite#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    \n Removes the association of tags from a Timestream resource. \n

    " + } + }, + "com.amazonaws.timestreamwrite#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.timestreamwrite#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    \n The Timestream resource that the tags will be removed from. This value\n is an Amazon Resource Name (ARN).\n

    ", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.timestreamwrite#TagKeyList", + "traits": { + "smithy.api#documentation": "

    \n A list of tags keys. Existing tags of the resource whose keys are members of this\n list will be removed from the Timestream resource.\n

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.timestreamwrite#UpdateDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#UpdateDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#UpdateDatabaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    \n Modifies the KMS key for an existing database. While updating the database, \n you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId).\n If there are any concurrent UpdateDatabase requests, first writer wins.\n

    " + } + }, + "com.amazonaws.timestreamwrite#UpdateDatabaseRequest": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.timestreamwrite#StringValue2048", + "traits": { + "smithy.api#documentation": "

    \n The identifier of the new KMS key (KmsKeyId) to be used to encrypt the data stored in the database.\n If the KmsKeyId currently registered with the database is the same as the KmsKeyId in the \n request, there will not be any update. \n

    \n

    You can specify the KmsKeyId using any of the following:

    \n
      \n
    • \n

      Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Key ARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

      \n
      • \n
    • \n

      Alias name: alias/ExampleAlias\n

      \n
      • \n
    • \n

      Alias ARN: arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias\n

      \n
      • \n
    ", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    \n The name of the database.\n

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#UpdateDatabaseResponse": { + "type": "structure", + "members": { + "Database": { + "target": "com.amazonaws.timestreamwrite#Database" + } + } + }, + "com.amazonaws.timestreamwrite#UpdateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#UpdateTableRequest" + }, + "output": { + "target": "com.amazonaws.timestreamwrite#UpdateTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    Modifies the retention duration of the memory store and magnetic store for your Timestream table. \n Note that the change in retention duration takes effect immediately. \n For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, \n the memory store will be capable of holding 24 hours of data, but will\n be populated with 24 hours of data 22 hours after this change was made.\n Timestream does not retrieve data from the magnetic store to populate the memory store.

    \n

    Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

    " + } + }, + "com.amazonaws.timestreamwrite#UpdateTableRequest": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timesream table.

    ", + "smithy.api#required": {} + } + }, + "RetentionProperties": { + "target": "com.amazonaws.timestreamwrite#RetentionProperties", + "traits": { + "smithy.api#documentation": "

    The retention duration of the memory store and the magnetic store.

    ", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.timestreamwrite#UpdateTableResponse": { + "type": "structure", + "members": { + "Table": { + "target": "com.amazonaws.timestreamwrite#Table", + "traits": { + "smithy.api#documentation": "

    The updated Timestream table.

    " + } + } + } + }, + "com.amazonaws.timestreamwrite#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.timestreamwrite#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Invalid or malformed request.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.timestreamwrite#WriteRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreamwrite#WriteRecordsRequest" + }, + "errors": [ + { + "target": "com.amazonaws.timestreamwrite#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreamwrite#InternalServerException" + }, + { + "target": "com.amazonaws.timestreamwrite#InvalidEndpointException" + }, + { + "target": "com.amazonaws.timestreamwrite#RejectedRecordsException" + }, + { + "target": "com.amazonaws.timestreamwrite#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreamwrite#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreamwrite#ValidationException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": true + }, + "smithy.api#documentation": "

    The WriteRecords operation enables you to write your time series \n data into Timestream. You can specify a single data point or a batch \n of data points to be inserted into the system. Timestream offers you \n with a flexible schema that auto detects the column names and data types \n for your Timestream tables based on the dimension names and data types of\n the data points you specify when invoking writes into the database. \n Timestream support eventual consistency read semantics. This means that \n when you query data immediately after writing a batch of data into Timestream, \n the query results might not reflect the results of a recently completed write \n operation. The results may also include some stale data. If you repeat the \n query request after a short time, the results should return the latest data.\n Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.\n

    " + } + }, + "com.amazonaws.timestreamwrite#WriteRecordsRequest": { + "type": "structure", + "members": { + "CommonAttributes": { + "target": "com.amazonaws.timestreamwrite#Record", + "traits": { + "smithy.api#documentation": "

    A record containing the common measure and dimension attributes \n shared across all the records in the request. The measure and dimension \n attributes specified in here will be merged with the measure and dimension\n attributes in the records object when the data is written into Timestream.\n

    " + } + }, + "TableName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timesream table.

    ", + "smithy.api#required": {} + } + }, + "Records": { + "target": "com.amazonaws.timestreamwrite#Records", + "traits": { + "smithy.api#documentation": "

    An array of records containing the unique dimension and measure \n attributes for each time series data point.\n

    ", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.timestreamwrite#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the Timestream database.

    ", + "smithy.api#required": {} + } + } + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/transcribe-streaming.2017-10-26.json b/codegen/sdk-codegen/aws-models/transcribe-streaming.2017-10-26.json index 3bc98f8472c1..4991bf991c5a 100644 --- a/codegen/sdk-codegen/aws-models/transcribe-streaming.2017-10-26.json +++ b/codegen/sdk-codegen/aws-models/transcribe-streaming.2017-10-26.json @@ -136,6 +136,12 @@ "com.amazonaws.transcribestreaming#Item": { "type": "structure", "members": { + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "

    The offset from the beginning of the audio stream to the beginning of the audio that\n resulted in the item.

    " + } + }, "Type": { "target": "com.amazonaws.transcribestreaming#ItemType", "traits": { @@ -148,22 +154,22 @@ "smithy.api#documentation": "

    The offset from the beginning of the audio stream to the end of the audio that resulted in\n the item.

    " } }, - "Content": { - "target": "com.amazonaws.transcribestreaming#String", + "VocabularyFilterMatch": { + "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

    The word or punctuation that was recognized in the input audio.

    " + "smithy.api#documentation": "

    Indicates whether a word in the item matches a word in the vocabulary filter you've chosen\n for your real-time stream. If true then a word in the item matches your\n vocabulary filter.

    " } }, - "StartTime": { - "target": "com.amazonaws.transcribestreaming#Double", + "Speaker": { + "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "

    The offset from the beginning of the audio stream to the beginning of the audio that\n resulted in the item.

    " + "smithy.api#documentation": "

    If speaker identification is enabled, shows the speakers identified in the real-time stream.

    " } }, - "VocabularyFilterMatch": { - "target": "com.amazonaws.transcribestreaming#Boolean", + "Content": { + "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "

    Indicates whether a word in the item matches a word in the vocabulary filter you've chosen\n for your real-time stream. If true then a word in the item matches your\n vocabulary filter.

    " + "smithy.api#documentation": "

    The word or punctuation that was recognized in the input audio.

    " } } }, @@ -257,28 +263,31 @@ } } }, + "com.amazonaws.transcribestreaming#NumberOfChannels": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 2 + } + } + }, "com.amazonaws.transcribestreaming#RequestId": { "type": "string" }, "com.amazonaws.transcribestreaming#Result": { "type": "structure", "members": { - "IsPartial": { - "target": "com.amazonaws.transcribestreaming#Boolean", - "traits": { - "smithy.api#documentation": "

    Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments.

    \n

    The IsPartial field is true to indicate that Amazon Transcribe has\n additional transcription data to send, false to indicate that this is the last\n transcription result for the segment.

    " - } - }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "

    The offset in seconds from the beginning of the audio stream to the end of the\n result.

    " + "smithy.api#documentation": "

    The offset in seconds from the beginning of the audio stream to the beginning of the\n result.

    " } }, - "StartTime": { - "target": "com.amazonaws.transcribestreaming#Double", + "IsPartial": { + "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

    The offset in seconds from the beginning of the audio stream to the beginning of the\n result.

    " + "smithy.api#documentation": "

    Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments.

    \n

    The IsPartial field is true to indicate that Amazon Transcribe has\n additional transcription data to send, false to indicate that this is the last\n transcription result for the segment.

    " } }, "Alternatives": { @@ -287,11 +296,23 @@ "smithy.api#documentation": "

    A list of possible transcriptions for the audio. Each alternative typically contains one\n item that contains the result of the transcription.

    " } }, + "ChannelId": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "

    When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

    \n

    You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

    " + } + }, "ResultId": { "target": "com.amazonaws.transcribestreaming#String", "traits": { "smithy.api#documentation": "

    A unique identifier for the result.

    " } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "

    The offset in seconds from the beginning of the audio stream to the end of the\n result.

    " + } } }, "traits": { @@ -320,6 +341,10 @@ "com.amazonaws.transcribestreaming#SessionId": { "type": "string", "traits": { + "smithy.api#length": { + "min": 36, + "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}" } }, @@ -363,41 +388,32 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary filter you've created that is unique to your AWS accountf.\n Provide the name in this field to successfully use it in a stream.

    ", + "smithy.api#documentation": "

    The name of the vocabulary filter you've created that is unique to your AWS account.\n Provide the name in this field to successfully use it in a stream.

    ", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" } }, - "MediaEncoding": { - "target": "com.amazonaws.transcribestreaming#MediaEncoding", + "ShowSpeakerLabel": { + "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

    The encoding used for the input audio.

    ", - "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding", - "smithy.api#required": {} + "smithy.api#documentation": "

    When true, enables speaker identification in your real-time stream.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" } }, - "LanguageCode": { - "target": "com.amazonaws.transcribestreaming#LanguageCode", + "EnableChannelIdentification": { + "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates the source language used in the input audio stream.

    ", - "smithy.api#httpHeader": "x-amzn-transcribe-language-code", - "smithy.api#required": {} + "smithy.api#documentation": "

    When true, instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

    \n

    Amazon Transcribe also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.

    \n

    You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, - "AudioStream": { - "target": "com.amazonaws.transcribestreaming#AudioStream", + "MediaEncoding": { + "target": "com.amazonaws.transcribestreaming#MediaEncoding", "traits": { - "smithy.api#documentation": "

    PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data\n frame.

    ", - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

    The encoding used for the input audio. pcm is the only valid value.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding", "smithy.api#required": {} } }, - "SessionId": { - "target": "com.amazonaws.transcribestreaming#SessionId", - "traits": { - "smithy.api#documentation": "

    A identifier for the transcription session. Use this parameter when you want to retry a\n session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in\n the response.

    ", - "smithy.api#httpHeader": "x-amzn-transcribe-session-id" - } - }, "VocabularyName": { "target": "com.amazonaws.transcribestreaming#VocabularyName", "traits": { @@ -412,6 +428,13 @@ "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-method" } }, + "NumberOfChannels": { + "target": "com.amazonaws.transcribestreaming#NumberOfChannels", + "traits": { + "smithy.api#documentation": "

    The number of channels that are in your audio stream.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" + } + }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { @@ -419,6 +442,29 @@ "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", "smithy.api#required": {} } + }, + "SessionId": { + "target": "com.amazonaws.transcribestreaming#SessionId", + "traits": { + "smithy.api#documentation": "

    A identifier for the transcription session. Use this parameter when you want to retry a\n session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in\n the response.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-session-id" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "

    Indicates the source language used in the input audio stream.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code", + "smithy.api#required": {} + } + }, + "AudioStream": { + "target": "com.amazonaws.transcribestreaming#AudioStream", + "traits": { + "smithy.api#documentation": "

    PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data\n frame.

    ", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } } }, @@ -432,6 +478,13 @@ "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" } }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "

    The language code for the input audio stream.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code" + } + }, "MediaEncoding": { "target": "com.amazonaws.transcribestreaming#MediaEncoding", "traits": { @@ -453,18 +506,18 @@ "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-method" } }, - "LanguageCode": { - "target": "com.amazonaws.transcribestreaming#LanguageCode", + "TranscriptResultStream": { + "target": "com.amazonaws.transcribestreaming#TranscriptResultStream", "traits": { - "smithy.api#documentation": "

    The language code for the input audio stream.

    ", - "smithy.api#httpHeader": "x-amzn-transcribe-language-code" + "smithy.api#documentation": "

    Represents the stream of transcription events from Amazon Transcribe to your application.

    ", + "smithy.api#httpPayload": {} } }, - "RequestId": { - "target": "com.amazonaws.transcribestreaming#RequestId", + "SessionId": { + "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "

    An identifier for the streaming transcription.

    ", - "smithy.api#httpHeader": "x-amzn-request-id" + "smithy.api#documentation": "

    An identifier for a specific transcription session.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, "MediaSampleRateHertz": { @@ -474,18 +527,32 @@ "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" } }, - "SessionId": { - "target": "com.amazonaws.transcribestreaming#SessionId", + "NumberOfChannels": { + "target": "com.amazonaws.transcribestreaming#NumberOfChannels", "traits": { - "smithy.api#documentation": "

    An identifier for a specific transcription session.

    ", - "smithy.api#httpHeader": "x-amzn-transcribe-session-id" + "smithy.api#documentation": "

    The number of channels identified in the stream.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" } }, - "TranscriptResultStream": { - "target": "com.amazonaws.transcribestreaming#TranscriptResultStream", + "EnableChannelIdentification": { + "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "

    Represents the stream of transcription events from Amazon Transcribe to your application.

    ", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "

    Shows whether channel identification has been enabled in the stream.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" + } + }, + "ShowSpeakerLabel": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "

    Shows whether speaker identification was enabled in the stream.

    ", + "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" + } + }, + "RequestId": { + "target": "com.amazonaws.transcribestreaming#RequestId", + "traits": { + "smithy.api#documentation": "

    An identifier for the streaming transcription.

    ", + "smithy.api#httpHeader": "x-amzn-request-id" } } } @@ -553,6 +620,18 @@ "smithy.api#documentation": "

    A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio\n stream, or it can be the entire transcription of that portion of the audio stream.\n

    " } }, + "LimitExceededException": { + "target": "com.amazonaws.transcribestreaming#LimitExceededException", + "traits": { + "smithy.api#documentation": "

    Your client has exceeded one of the Amazon Transcribe limits, typically the limit on audio length.\n Break your audio stream into smaller chunks and try your request again.

    " + } + }, + "ConflictException": { + "target": "com.amazonaws.transcribestreaming#ConflictException", + "traits": { + "smithy.api#documentation": "

    A new stream started with the same session ID. The current stream has been\n terminated.

    " + } + }, "BadRequestException": { "target": "com.amazonaws.transcribestreaming#BadRequestException", "traits": { @@ -565,23 +644,11 @@ "smithy.api#documentation": "

    A problem occurred while processing the audio. Amazon Transcribe terminated processing.

    " } }, - "ConflictException": { - "target": "com.amazonaws.transcribestreaming#ConflictException", - "traits": { - "smithy.api#documentation": "

    A new stream started with the same session ID. The current stream has been\n terminated.

    " - } - }, "ServiceUnavailableException": { "target": "com.amazonaws.transcribestreaming#ServiceUnavailableException", "traits": { "smithy.api#documentation": "

    Service is currently unavailable. Try your request later.

    " } - }, - "LimitExceededException": { - "target": "com.amazonaws.transcribestreaming#LimitExceededException", - "traits": { - "smithy.api#documentation": "

    Your client has exceeded one of the Amazon Transcribe limits, typically the limit on audio length.\n Break your audio stream into smaller chunks and try your request again.

    " - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json b/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json index d160b849633a..950f3890de65 100644 --- a/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json +++ b/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json @@ -37,17 +37,43 @@ } }, "traits": { - "smithy.api#documentation": "

    Your request didn't pass one or more validation tests. For example, if the\n transcription you're trying to delete doesn't exist or if it is in a non-terminal state\n (for example, it's \"in progress\"). See the exception Message field for more\n information.

    ", + "smithy.api#documentation": "

    Your request didn't pass one or more validation tests. For example, if the entity that\n you're trying to delete doesn't exist or if it is in a non-terminal state (for example,\n it's \"in progress\"). See the exception Message field for more\n information.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, + "com.amazonaws.transcribe#BaseModelName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NarrowBand", + "name": "NARROW_BAND" + }, + { + "value": "WideBand", + "name": "WIDE_BAND" + } + ] + } + }, "com.amazonaws.transcribe#Boolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, + "com.amazonaws.transcribe#CLMLanguageCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "en-US", + "name": "EN_US" + } + ] + } + }, "com.amazonaws.transcribe#ConflictException": { "type": "structure", "members": { @@ -56,7 +82,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The resource name already exists.

    ", + "smithy.api#documentation": "

    There is already a resource with that name.

    ", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -64,17 +90,17 @@ "com.amazonaws.transcribe#ContentRedaction": { "type": "structure", "members": { - "RedactionOutput": { - "target": "com.amazonaws.transcribe#RedactionOutput", + "RedactionType": { + "target": "com.amazonaws.transcribe#RedactionType", "traits": { - "smithy.api#documentation": "

    The output transcript file stored in either the default S3 bucket or in a bucket you\n specify.

    \n

    When you choose redacted Amazon Transcribe outputs only the redacted\n transcript.

    \n

    When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted\n and unredacted transcripts.

    ", + "smithy.api#documentation": "

    Request parameter that defines the entities to be redacted. The only accepted value is\n PII.

    ", "smithy.api#required": {} } }, - "RedactionType": { - "target": "com.amazonaws.transcribe#RedactionType", + "RedactionOutput": { + "target": "com.amazonaws.transcribe#RedactionOutput", "traits": { - "smithy.api#documentation": "

    Request parameter that defines the entities to be redacted. The only accepted value is\n PII.

    ", + "smithy.api#documentation": "

    The output transcript file stored in either the default S3 bucket or in a bucket you\n specify.

    \n

    When you choose redacted Amazon Transcribe outputs only the redacted\n transcript.

    \n

    When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted\n and unredacted transcripts.

    ", "smithy.api#required": {} } } @@ -83,6 +109,106 @@ "smithy.api#documentation": "

    Settings for content redaction within a transcription job.

    " } }, + "com.amazonaws.transcribe#CreateLanguageModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#CreateLanguageModelRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#CreateLanguageModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your\n input files. The time it takes to create your model depends on the size of your training\n data.

    ", + "smithy.api#http": { + "method": "PUT", + "uri": "/languagemodels/{ModelName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#CreateLanguageModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.transcribe#ModelName", + "traits": { + "smithy.api#documentation": "

    The name you choose for your custom language model when you create it.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#CLMLanguageCode", + "traits": { + "smithy.api#documentation": "

    The language of the input text you're using to train your custom language\n model.

    ", + "smithy.api#required": {} + } + }, + "BaseModelName": { + "target": "com.amazonaws.transcribe#BaseModelName", + "traits": { + "smithy.api#documentation": "

    The Amazon Transcribe standard language model, or base model used to create your custom language\n model.

    \n

    If you want to use your custom language model to transcribe audio with a sample rate\n of 16 kHz or greater, choose Wideband.

    \n

    If you want to use your custom language model to transcribe audio with a sample rate\n that is less than 16 kHz, choose Narrowband.

    ", + "smithy.api#required": {} + } + }, + "InputDataConfig": { + "target": "com.amazonaws.transcribe#InputDataConfig", + "traits": { + "smithy.api#documentation": "

    Contains the data access role and the Amazon S3 prefixes to read the required input files\n to create a custom language model.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#CreateLanguageModelResponse": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.transcribe#InputDataConfig", + "traits": { + "smithy.api#documentation": "

    The data access role and Amazon S3 prefixes you've chosen to create your custom language\n model.

    " + } + }, + "ModelStatus": { + "target": "com.amazonaws.transcribe#ModelStatus", + "traits": { + "smithy.api#documentation": "

    The status of the custom language model. When the status is COMPLETED the\n model is ready to use.

    " + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#CLMLanguageCode", + "traits": { + "smithy.api#documentation": "

    The language code of the text you've used to create a custom language model.

    " + } + }, + "BaseModelName": { + "target": "com.amazonaws.transcribe#BaseModelName", + "traits": { + "smithy.api#documentation": "

    The Amazon Transcribe standard language model, or base model you've used to create a custom\n language model.

    " + } + }, + "ModelName": { + "target": "com.amazonaws.transcribe#ModelName", + "traits": { + "smithy.api#documentation": "

    The name you've chosen for your custom language model.

    " + } + } + } + }, "com.amazonaws.transcribe#CreateMedicalVocabulary": { "type": "operation", "input": { @@ -106,7 +232,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your\n audio file.

    ", + "smithy.api#documentation": "

    Creates a new custom vocabulary that you can use to\n change\n how Amazon Transcribe Medical transcribes your audio file.

    ", "smithy.api#http": { "method": "PUT", "uri": "/medicalvocabularies/{VocabularyName}", @@ -117,25 +243,25 @@ "com.amazonaws.transcribe#CreateMedicalVocabularyRequest": { "type": "structure", "members": { - "VocabularyFileUri": { - "target": "com.amazonaws.transcribe#Uri", + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The Amazon S3 location of the text file you use to define your custom vocabulary. The URI\n must be in the same AWS region as the API endpoint you're calling. Enter information\n about your VocabularyFileUri in the following format:

    \n

    \n \n https://s3..amazonaws.com///\n \n

    \n

    This is an example of a vocabulary file uri location in Amazon S3:

    \n

    \n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

    \n

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    \n

    For more information about custom vocabularies, see Medical Custom Vocabularies.

    ", + "smithy.api#documentation": "

    The name of the custom vocabulary. This case-sensitive name must be unique within an\n AWS account. If you try to create a vocabulary with the same name as a previous\n vocabulary, you get a ConflictException error.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The language code used for the entries within your custom vocabulary. The language\n code of your custom vocabulary must match the language code of your transcription job.\n US English (en-US) is the only language code available for Amazon Transcribe Medical.

    ", + "smithy.api#documentation": "

    The language code for the language used for the entries in your custom vocabulary. The\n language code of your custom vocabulary must match the language code of your\n transcription job. US English (en-US) is the only language code available for\n Amazon Transcribe Medical.

    ", "smithy.api#required": {} } }, - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", + "VocabularyFileUri": { + "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The name of the custom vocabulary. This case-sensitive name must be unique within an\n AWS account. If you try to create a vocabulary with the same name as a previous\n vocabulary you will receive a ConflictException error.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The location in Amazon S3 of the text file you use to define your custom vocabulary. The\n URI must be in the same AWS Region as the\n resource\n that you're calling. Enter information about your\n VocabularyFileUri in the following format:

    \n

    \n \n https://s3..amazonaws.com///\n \n

    \n

    The following is an example URI for a vocabulary file that is stored in Amazon S3:

    \n

    \n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

    \n

    For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    \n

    For more information about custom vocabularies, see Medical Custom Vocabularies.

    ", "smithy.api#required": {} } } @@ -144,16 +270,16 @@ "com.amazonaws.transcribe#CreateMedicalVocabularyResponse": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "VocabularyState": { + "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

    The language code you chose to describe the entries in your custom vocabulary. US\n English (en-US) is the only valid language code for Amazon Transcribe Medical.

    " + "smithy.api#documentation": "

    The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is\n READY, you can use the vocabulary in a\n StartMedicalTranscriptionJob request.

    " } }, - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", + "LastModifiedTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary. The name must be unique within an AWS account. It is also\n case-sensitive.

    " + "smithy.api#documentation": "

    The date and time that you created the vocabulary.

    " } }, "FailureReason": { @@ -162,16 +288,16 @@ "smithy.api#documentation": "

    If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.transcribe#DateTime", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The date and time you created the vocabulary.

    " + "smithy.api#documentation": "

    The language code for the entries in your custom vocabulary. US English (en-US) is the\n only valid language code for Amazon Transcribe Medical.

    " } }, - "VocabularyState": { - "target": "com.amazonaws.transcribe#VocabularyState", + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is\n READY you can use the vocabulary in a\n StartMedicalTranscriptionJob request.

    " + "smithy.api#documentation": "

    The name of the vocabulary. The name must be unique within an AWS account and is case\n sensitive.

    " } } } @@ -241,6 +367,14 @@ "com.amazonaws.transcribe#CreateVocabularyFilterRequest": { "type": "structure", "members": { + "VocabularyFilterName": { + "target": "com.amazonaws.transcribe#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "

    The vocabulary filter name. The name must be unique within the account that contains\n it. If you try to create a vocabulary filter with the same name as another vocabulary\n filter, you get a ConflictException error.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { @@ -259,14 +393,6 @@ "traits": { "smithy.api#documentation": "

    The words to use in the vocabulary filter. Only use characters from the character set\n defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

    \n

    If you provide a list of words in the Words parameter, you can't use the\n VocabularyFilterFileUri parameter.

    " } - }, - "VocabularyFilterName": { - "target": "com.amazonaws.transcribe#VocabularyFilterName", - "traits": { - "smithy.api#documentation": "

    The vocabulary filter name. The name must be unique within the account that contains\n it.If you try to create a vocabulary filter with the same name as a previous vocabulary\n filter you will receive a ConflictException error.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -279,29 +405,27 @@ "smithy.api#documentation": "

    The name of the vocabulary filter.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.transcribe#DateTime", - "traits": { - "smithy.api#documentation": "

    The date and time that the vocabulary filter was modified.

    " - } - }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { "smithy.api#documentation": "

    The language code of the words in the collection.

    " } + }, + "LastModifiedTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The date and time that the vocabulary filter was modified.

    " + } } } }, "com.amazonaws.transcribe#CreateVocabularyRequest": { "type": "structure", "members": { - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", + "VocabularyFileUri": { + "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary. The name must be unique within an AWS account. The name is\n case-sensitive. If you try to create a vocabulary with the same name as a previous\n vocabulary you will receive a ConflictException error.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

    \n \n \n \n

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    \n

    For more information about custom vocabularies, see Custom Vocabularies.

    " } }, "LanguageCode": { @@ -317,10 +441,12 @@ "smithy.api#documentation": "

    An array of strings that contains the vocabulary entries.

    " } }, - "VocabularyFileUri": { - "target": "com.amazonaws.transcribe#Uri", + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

    \n \n \n \n

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    \n

    For more information about custom vocabularies, see Custom Vocabularies.

    " + "smithy.api#documentation": "

    The name of the vocabulary. The name must be unique within an AWS account. The name is\n case sensitive. If you try to create a vocabulary with the same name as a previous\n vocabulary you will receive a ConflictException error.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -328,6 +454,18 @@ "com.amazonaws.transcribe#CreateVocabularyResponse": { "type": "structure", "members": { + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", + "traits": { + "smithy.api#documentation": "

    The language code of the vocabulary entries.

    " + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", + "traits": { + "smithy.api#documentation": "

    The name of the vocabulary.

    " + } + }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { @@ -345,30 +483,60 @@ "traits": { "smithy.api#documentation": "

    If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

    " } - }, - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", - "traits": { - "smithy.api#documentation": "

    The language code of the vocabulary entries.

    " - } - }, - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", - "traits": { - "smithy.api#documentation": "

    The name of the vocabulary.

    " - } } } }, "com.amazonaws.transcribe#DataAccessRoleArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws:iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1023}$" + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$" } }, "com.amazonaws.transcribe#DateTime": { "type": "timestamp" }, + "com.amazonaws.transcribe#DeleteLanguageModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#DeleteLanguageModelRequest" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a custom language model using its name.

    ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/languagemodels/{ModelName}", + "code": 204 + } + } + }, + "com.amazonaws.transcribe#DeleteLanguageModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.transcribe#ModelName", + "traits": { + "smithy.api#documentation": "

    The name of the model you're choosing to delete.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.transcribe#DeleteMedicalTranscriptionJob": { "type": "operation", "input": { @@ -441,7 +609,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary you are choosing to delete.

    ", + "smithy.api#documentation": "

    The name of the vocabulary that you want to delete.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -568,16 +736,13 @@ } } }, - "com.amazonaws.transcribe#FailureReason": { - "type": "string" - }, - "com.amazonaws.transcribe#GetMedicalTranscriptionJob": { + "com.amazonaws.transcribe#DescribeLanguageModel": { "type": "operation", "input": { - "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJobRequest" + "target": "com.amazonaws.transcribe#DescribeLanguageModelRequest" }, "output": { - "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJobResponse" + "target": "com.amazonaws.transcribe#DescribeLanguageModelResponse" }, "errors": [ { @@ -594,45 +759,48 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the\n job, check the TranscriptionJobStatus field. If the status is\n COMPLETED, the job is finished. You find the results of the completed\n job in the TranscriptFileUri field.

    ", + "smithy.api#documentation": "

    Gets information about a single custom language model. Use this information to see\n details about the language model in your AWS account. You can also see whether the base\n language model used to create your custom language model has been updated. If Amazon Transcribe has\n updated the base model, you can create a new custom language model using the updated\n base model. If the language model wasn't created, you can use this operation to\n understand why Amazon Transcribe couldn't create it.

    ", "smithy.api#http": { "method": "GET", - "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", + "uri": "/languagemodels/{ModelName}", "code": 200 } } }, - "com.amazonaws.transcribe#GetMedicalTranscriptionJobRequest": { + "com.amazonaws.transcribe#DescribeLanguageModelRequest": { "type": "structure", "members": { - "MedicalTranscriptionJobName": { - "target": "com.amazonaws.transcribe#TranscriptionJobName", + "ModelName": { + "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

    The name of the medical transcription job.

    ", + "smithy.api#documentation": "

    The name of the custom language model you submit to get more information.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.transcribe#GetMedicalTranscriptionJobResponse": { + "com.amazonaws.transcribe#DescribeLanguageModelResponse": { "type": "structure", "members": { - "MedicalTranscriptionJob": { - "target": "com.amazonaws.transcribe#MedicalTranscriptionJob", + "LanguageModel": { + "target": "com.amazonaws.transcribe#LanguageModel", "traits": { - "smithy.api#documentation": "

    An object that contains the results of the medical transcription job.

    " + "smithy.api#documentation": "

    The name of the custom language model you requested more information about.

    " } } } }, - "com.amazonaws.transcribe#GetMedicalVocabulary": { + "com.amazonaws.transcribe#FailureReason": { + "type": "string" + }, + "com.amazonaws.transcribe#GetMedicalTranscriptionJob": { "type": "operation", "input": { - "target": "com.amazonaws.transcribe#GetMedicalVocabularyRequest" + "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJobRequest" }, "output": { - "target": "com.amazonaws.transcribe#GetMedicalVocabularyResponse" + "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJobResponse" }, "errors": [ { @@ -649,52 +817,107 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieve information about a medical vocabulary.

    ", + "smithy.api#documentation": "

    Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the\n job, check the TranscriptionJobStatus field. If the status is\n COMPLETED, the job is finished. You find the results of the completed\n job in the TranscriptFileUri field.

    ", "smithy.api#http": { "method": "GET", - "uri": "/medicalvocabularies/{VocabularyName}", + "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", "code": 200 } } }, - "com.amazonaws.transcribe#GetMedicalVocabularyRequest": { + "com.amazonaws.transcribe#GetMedicalTranscriptionJobRequest": { "type": "structure", "members": { - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", - "traits": { - "smithy.api#documentation": "

    The name of the vocabulary you are trying to get information about. The value you\n enter for this request is case-sensitive.

    ", + "MedicalTranscriptionJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    The name of the medical transcription job.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.transcribe#GetMedicalVocabularyResponse": { + "com.amazonaws.transcribe#GetMedicalTranscriptionJobResponse": { "type": "structure", "members": { - "DownloadUri": { - "target": "com.amazonaws.transcribe#Uri", + "MedicalTranscriptionJob": { + "target": "com.amazonaws.transcribe#MedicalTranscriptionJob", "traits": { - "smithy.api#documentation": "

    The Amazon S3 location where the vocabulary is stored. Use this URI to get the contents of\n the vocabulary. You can download your vocabulary from the URI for a limited time.

    " + "smithy.api#documentation": "

    An object that contains the results of the medical transcription job.

    " } + } + } + }, + "com.amazonaws.transcribe#GetMedicalVocabulary": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#GetMedicalVocabularyRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#GetMedicalVocabularyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" }, - "VocabularyState": { - "target": "com.amazonaws.transcribe#VocabularyState", + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves information about a medical vocabulary.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/medicalvocabularies/{VocabularyName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#GetMedicalVocabularyRequest": { + "type": "structure", + "members": { + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The processing state of the vocabulary.

    " + "smithy.api#documentation": "

    The name of the vocabulary that you want information about. The value is case\n sensitive.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#GetMedicalVocabularyResponse": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", + "traits": { + "smithy.api#documentation": "

    The valid language code for your vocabulary entries.

    " } }, "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The valid name that Amazon Transcribe Medical returns.

    " + "smithy.api#documentation": "

    The name of the vocabulary returned by Amazon Transcribe Medical.

    " + } + }, + "VocabularyState": { + "target": "com.amazonaws.transcribe#VocabularyState", + "traits": { + "smithy.api#documentation": "

    The\n processing state of the vocabulary. If the VocabularyState is\n READY then you can use it in the\n StartMedicalTranscriptionJob operation.

    " } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The date and time the vocabulary was last modified with a text file different from\n what was previously used.

    " + "smithy.api#documentation": "

    The date and time that the vocabulary was last modified with a text file different\n from the one that was previously used.

    " } }, "FailureReason": { @@ -703,10 +926,10 @@ "smithy.api#documentation": "

    If the VocabularyState is FAILED, this field contains\n information about why the job failed.

    " } }, - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "DownloadUri": { + "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The valid language code returned for your vocabulary entries.

    " + "smithy.api#documentation": "

    The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents\n of the vocabulary. You can download your vocabulary from the\n URI\n for a limited time.

    " } } } @@ -844,10 +1067,10 @@ "com.amazonaws.transcribe#GetVocabularyFilterResponse": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "LastModifiedTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The language code of the words in the vocabulary filter.

    " + "smithy.api#documentation": "

    The date and time that the contents of the vocabulary filter were updated.

    " } }, "VocabularyFilterName": { @@ -856,10 +1079,10 @@ "smithy.api#documentation": "

    The name of the vocabulary filter.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.transcribe#DateTime", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The date and time that the contents of the vocabulary filter were updated.

    " + "smithy.api#documentation": "

    The language code of the words in the vocabulary filter.

    " } }, "DownloadUri": { @@ -876,7 +1099,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary to return information about. The name is\n case-sensitive.

    ", + "smithy.api#documentation": "

    The name of the vocabulary to return information about. The name is case\n sensitive.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -886,28 +1109,34 @@ "com.amazonaws.transcribe#GetVocabularyResponse": { "type": "structure", "members": { - "LastModifiedTime": { - "target": "com.amazonaws.transcribe#DateTime", - "traits": { - "smithy.api#documentation": "

    The date and time that the vocabulary was last modified.

    " - } - }, "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { "smithy.api#documentation": "

    The S3 location where the vocabulary is stored. Use this URI to get the contents of\n the vocabulary. The URI is available for a limited time.

    " } }, + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", + "traits": { + "smithy.api#documentation": "

    The name of the vocabulary to return.

    " + } + }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { "smithy.api#documentation": "

    The processing state of the vocabulary.

    " } }, - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", + "LastModifiedTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary to return.

    " + "smithy.api#documentation": "

    The date and time that the vocabulary was last modified.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

    If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

    " } }, "LanguageCode": { @@ -915,13 +1144,41 @@ "traits": { "smithy.api#documentation": "

    The language code of the vocabulary entries.

    " } + } + } + }, + "com.amazonaws.transcribe#IdentifiedLanguageScore": { + "type": "float", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.transcribe#InputDataConfig": { + "type": "structure", + "members": { + "TuningDataS3Uri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 prefix you specify to access the plain text files that you use to tune your\n custom language model.

    " + } }, - "FailureReason": { - "target": "com.amazonaws.transcribe#FailureReason", + "DataAccessRoleArn": { + "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

    If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given\n Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data.

    ", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 prefix you specify to access the plain text files that you use to train your\n custom language model.

    ", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

    The object that contains the Amazon S3 object location and access role required to train\n and tune your custom language model.

    " } }, "com.amazonaws.transcribe#InternalFailureException": { @@ -972,143 +1229,319 @@ "traits": { "smithy.api#enum": [ { - "value": "en-US", - "name": "EN_US" + "value": "af-ZA", + "name": "AF_ZA" }, { - "value": "es-US", - "name": "ES_US" + "value": "ar-AE", + "name": "AR_AE" }, { - "value": "en-AU", - "name": "EN_AU" + "value": "ar-SA", + "name": "AR_SA" }, { - "value": "fr-CA", - "name": "FR_CA" + "value": "cy-GB", + "name": "CY_GB" }, { - "value": "en-GB", - "name": "EN_GB" + "value": "da-DK", + "name": "DA_DK" + }, + { + "value": "de-CH", + "name": "DE_CH" }, { "value": "de-DE", "name": "DE_DE" }, { - "value": "pt-BR", - "name": "PT_BR" + "value": "en-AB", + "name": "EN_AB" }, { - "value": "fr-FR", - "name": "FR_FR" + "value": "en-AU", + "name": "EN_AU" }, { - "value": "it-IT", - "name": "IT_IT" + "value": "en-GB", + "name": "EN_GB" }, { - "value": "ko-KR", - "name": "KO_KR" + "value": "en-IE", + "name": "EN_IE" + }, + { + "value": "en-IN", + "name": "EN_IN" + }, + { + "value": "en-US", + "name": "EN_US" + }, + { + "value": "en-WL", + "name": "EN_WL" }, { "value": "es-ES", "name": "ES_ES" }, { - "value": "en-IN", - "name": "EN_IN" + "value": "es-US", + "name": "ES_US" }, { - "value": "hi-IN", - "name": "HI_IN" + "value": "fa-IR", + "name": "FA_IR" }, { - "value": "ar-SA", - "name": "AR_SA" + "value": "fr-CA", + "name": "FR_CA" }, { - "value": "ru-RU", - "name": "RU_RU" + "value": "fr-FR", + "name": "FR_FR" }, { - "value": "zh-CN", - "name": "ZH_CN" + "value": "ga-IE", + "name": "GA_IE" }, { - "value": "nl-NL", - "name": "NL_NL" + "value": "gd-GB", + "name": "GD_GB" }, { - "value": "id-ID", - "name": "ID_ID" + "value": "he-IL", + "name": "HE_IL" }, { - "value": "ta-IN", - "name": "TA_IN" + "value": "hi-IN", + "name": "HI_IN" }, { - "value": "fa-IR", - "name": "FA_IR" + "value": "id-ID", + "name": "ID_ID" }, { - "value": "en-IE", - "name": "EN_IE" + "value": "it-IT", + "name": "IT_IT" }, { - "value": "en-AB", - "name": "EN_AB" + "value": "ja-JP", + "name": "JA_JP" }, { - "value": "en-WL", - "name": "EN_WL" + "value": "ko-KR", + "name": "KO_KR" }, { - "value": "pt-PT", - "name": "PT_PT" + "value": "ms-MY", + "name": "MS_MY" }, { - "value": "te-IN", - "name": "TE_IN" + "value": "nl-NL", + "name": "NL_NL" }, { - "value": "tr-TR", - "name": "TR_TR" + "value": "pt-BR", + "name": "PT_BR" }, { - "value": "de-CH", - "name": "DE_CH" + "value": "pt-PT", + "name": "PT_PT" }, { - "value": "he-IL", - "name": "HE_IL" + "value": "ru-RU", + "name": "RU_RU" }, { - "value": "ms-MY", - "name": "MS_MY" + "value": "ta-IN", + "name": "TA_IN" }, { - "value": "ja-JP", - "name": "JA_JP" + "value": "te-IN", + "name": "TE_IN" }, { - "value": "ar-AE", - "name": "AR_AE" + "value": "tr-TR", + "name": "TR_TR" + }, + { + "value": "zh-CN", + "name": "ZH_CN" + } + ] + } + }, + "com.amazonaws.transcribe#LanguageModel": { + "type": "structure", + "members": { + "UpgradeAvailability": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether the base model used for the custom language model is up to date. If this field\n is true then you are running the most up-to-date version of the base model\n in your custom language model.

    " + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#CLMLanguageCode", + "traits": { + "smithy.api#documentation": "

    The language code you used to create your custom language model.

    " + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

    The reason why the custom language model couldn't be created.

    " + } + }, + "BaseModelName": { + "target": "com.amazonaws.transcribe#BaseModelName", + "traits": { + "smithy.api#documentation": "

    The Amazon Transcribe standard language model, or base model used to create the custom language\n model.

    " + } + }, + "ModelStatus": { + "target": "com.amazonaws.transcribe#ModelStatus", + "traits": { + "smithy.api#documentation": "

    The creation status of a custom language model. When the status is\n COMPLETED the model is ready for use.

    " + } + }, + "InputDataConfig": { + "target": "com.amazonaws.transcribe#InputDataConfig", + "traits": { + "smithy.api#documentation": "

    The data access role and Amazon S3 prefixes for the input files used to train the custom\n language model.

    " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The most recent time the custom language model was modified.

    " + } + }, + "CreateTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    The time the custom language model was created.

    " + } + }, + "ModelName": { + "target": "com.amazonaws.transcribe#ModelName", + "traits": { + "smithy.api#documentation": "

    The name of the custom language model.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The structure used to describe a custom language model.

    " + } + }, + "com.amazonaws.transcribe#LanguageOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#LanguageCode" + }, + "traits": { + "smithy.api#length": { + "min": 2 + } + } + }, + "com.amazonaws.transcribe#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transcribe#String" + } + }, + "traits": { + "smithy.api#documentation": "

    Either you have sent too many requests or your input file is too long. Wait before you\n resend your request, or use a smaller file and resend the request.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.transcribe#ListLanguageModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#ListLanguageModelsRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#ListLanguageModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

    Provides more information about the custom language models you've created. You can use\n the information in this list to find a specific custom language model. You can then use\n the operation to get more information about\n it.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/languagemodels", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transcribe#ListLanguageModelsRequest": { + "type": "structure", + "members": { + "NameContains": { + "target": "com.amazonaws.transcribe#ModelName", + "traits": { + "smithy.api#documentation": "

    When specified, the custom language model names returned contain the substring you've\n specified.

    ", + "smithy.api#httpQuery": "NameContains" } - ] + }, + "StatusEquals": { + "target": "com.amazonaws.transcribe#ModelStatus", + "traits": { + "smithy.api#documentation": "

    When specified, returns only custom language models with the specified status.\n Language models are ordered by creation date, with the newest models first. If you don't\n specify a status, Amazon Transcribe returns all custom language models ordered by date.

    ", + "smithy.api#httpQuery": " StatusEquals" + } + }, + "MaxResults": { + "target": "com.amazonaws.transcribe#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of language models to return in the response. If there are fewer\n results in the list, the response contains only the actual results.

    ", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    When included, fetches the next set of jobs if the result of the previous request was\n truncated.

    ", + "smithy.api#httpQuery": "NextToken" + } + } } }, - "com.amazonaws.transcribe#LimitExceededException": { + "com.amazonaws.transcribe#ListLanguageModelsResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.transcribe#String" + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    The operation returns a page of jobs at a\n time. The maximum size of the list is set by the MaxResults parameter. If there are more\n language models in the list than the page size, Amazon Transcribe returns the NextPage\n token. Include the token in the next request to the operation to return the next page of language\n models.

    " + } + }, + "Models": { + "target": "com.amazonaws.transcribe#Models", + "traits": { + "smithy.api#documentation": "

    A list of objects containing information about custom language models.

    " + } } - }, - "traits": { - "smithy.api#documentation": "

    Either you have sent too many requests or your input file is too long. Wait before you\n resend your request, or use a smaller file and resend the request.

    ", - "smithy.api#error": "client", - "smithy.api#httpError": 429 } }, "com.amazonaws.transcribe#ListMedicalTranscriptionJobs": { @@ -1147,6 +1580,13 @@ "com.amazonaws.transcribe#ListMedicalTranscriptionJobsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    If you a receive a truncated result in the previous request of\n ListMedicalTranscriptionJobs, include NextToken to fetch\n the next set of jobs.

    ", + "smithy.api#httpQuery": "NextToken" + } + }, "JobNameContains": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { @@ -1161,13 +1601,6 @@ "smithy.api#httpQuery": "Status" } }, - "NextToken": { - "target": "com.amazonaws.transcribe#NextToken", - "traits": { - "smithy.api#documentation": "

    If you a receive a truncated result in the previous request of\n ListMedicalTranscriptionJobs, include NextToken to fetch\n the next set of jobs.

    ", - "smithy.api#httpQuery": "NextToken" - } - }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { @@ -1180,18 +1613,18 @@ "com.amazonaws.transcribe#ListMedicalTranscriptionJobsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.transcribe#NextToken", - "traits": { - "smithy.api#documentation": "

    The ListMedicalTranscriptionJobs operation returns a page of jobs at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the\n NextPage token. Include the token in the next request to the\n ListMedicalTranscriptionJobs operation to return in the next page of\n jobs.

    " - } - }, "MedicalTranscriptionJobSummaries": { "target": "com.amazonaws.transcribe#MedicalTranscriptionJobSummaries", "traits": { "smithy.api#documentation": "

    A list of objects containing summary information for a transcription job.

    " } }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    The ListMedicalTranscriptionJobs operation returns a page of jobs at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the\n NextPage token. Include the token in the next request to the\n ListMedicalTranscriptionJobs operation to return in the next page of\n jobs.

    " + } + }, "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { @@ -1220,7 +1653,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of vocabularies that match the specified criteria. You get the entire\n list of vocabularies if you don't enter a value in any of the request parameters.

    ", + "smithy.api#documentation": "

    Returns a list of vocabularies that match the specified criteria. If you don't enter a\n value in any of the request parameters, returns the entire list of vocabularies.

    ", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies", @@ -1236,55 +1669,55 @@ "com.amazonaws.transcribe#ListMedicalVocabulariesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.transcribe#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of vocabularies to return in the response.

    ", - "smithy.api#httpQuery": "MaxResults" - } - }, - "StateEquals": { - "target": "com.amazonaws.transcribe#VocabularyState", - "traits": { - "smithy.api#documentation": "

    When specified, only returns vocabularies with the VocabularyState equal\n to the specified vocabulary state.

    ", - "smithy.api#httpQuery": "StateEquals" - } - }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    Returns vocabularies in the list whose name contains the specified string. The search\n is case-insensitive, ListMedicalVocabularies returns both \"vocabularyname\"\n and \"VocabularyName\" in the response list.

    ", + "smithy.api#documentation": "

    Returns vocabularies whose names contain the specified string. The search is not case\n sensitive. ListMedicalVocabularies returns both\n \"vocabularyname\" and \"VocabularyName\".

    ", "smithy.api#httpQuery": "NameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

    If the result of your previous request to ListMedicalVocabularies was\n truncated, include the NextToken to fetch the next set of jobs.

    ", + "smithy.api#documentation": "

    If the result of your previous request to ListMedicalVocabularies was\n truncated, include the NextToken to fetch the next set of\n vocabularies.

    ", "smithy.api#httpQuery": "NextToken" } + }, + "StateEquals": { + "target": "com.amazonaws.transcribe#VocabularyState", + "traits": { + "smithy.api#documentation": "

    When specified, returns only vocabularies\n with\n the VocabularyState equal to the specified vocabulary state. Use this field\n to see which vocabularies are ready for your medical transcription\n jobs.

    ", + "smithy.api#httpQuery": "StateEquals" + } + }, + "MaxResults": { + "target": "com.amazonaws.transcribe#MaxResults", + "traits": { + "smithy.api#documentation": "

    The\n maximum number of vocabularies to return in the response.

    ", + "smithy.api#httpQuery": "MaxResults" + } } } }, "com.amazonaws.transcribe#ListMedicalVocabulariesResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.transcribe#VocabularyState", - "traits": { - "smithy.api#documentation": "

    The requested vocabulary state.

    " - } - }, "Vocabularies": { "target": "com.amazonaws.transcribe#Vocabularies", "traits": { - "smithy.api#documentation": "

    A list of objects that describe the vocabularies that match the search criteria in the\n request.

    " + "smithy.api#documentation": "

    A list of objects that describe the vocabularies that match your search\n criteria.

    " } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

    The ListMedicalVocabularies operation returns a page of vocabularies at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n there are more jobs in the list than the page size, Amazon Transcribe Medical returns the\n NextPage token. Include the token in the next request to the\n ListMedicalVocabularies operation to return the next page of\n jobs.

    " + "smithy.api#documentation": "

    The ListMedicalVocabularies operation returns a page of vocabularies at a\n time. You set the maximum number of vocabularies to return on a page with the\n MaxResults parameter. If there are more jobs in the list will fit on a\n page, Amazon Transcribe Medical returns the NextPage token. To return the next page of\n vocabularies, include the token in the next request to the\n ListMedicalVocabularies operation .

    " + } + }, + "Status": { + "target": "com.amazonaws.transcribe#VocabularyState", + "traits": { + "smithy.api#documentation": "

    The requested vocabulary state.

    " } } } @@ -1325,13 +1758,6 @@ "com.amazonaws.transcribe#ListTranscriptionJobsRequest": { "type": "structure", "members": { - "JobNameContains": { - "target": "com.amazonaws.transcribe#TranscriptionJobName", - "traits": { - "smithy.api#documentation": "

    When specified, the jobs returned in the list are limited to jobs whose name contains\n the specified string.

    ", - "smithy.api#httpQuery": "JobNameContains" - } - }, "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { @@ -1339,6 +1765,13 @@ "smithy.api#httpQuery": "Status" } }, + "JobNameContains": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    When specified, the jobs returned in the list are limited to jobs whose name contains\n the specified string.

    ", + "smithy.api#httpQuery": "JobNameContains" + } + }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { @@ -1358,10 +1791,10 @@ "com.amazonaws.transcribe#ListTranscriptionJobsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.transcribe#NextToken", + "TranscriptionJobSummaries": { + "target": "com.amazonaws.transcribe#TranscriptionJobSummaries", "traits": { - "smithy.api#documentation": "

    The ListTranscriptionJobs operation returns a page of jobs at a time. The\n maximum size of the page is set by the MaxResults parameter. If there are\n more jobs in the list than the page size, Amazon Transcribe returns the NextPage token.\n Include the token in the next request to the ListTranscriptionJobs\n operation to return in the next page of jobs.

    " + "smithy.api#documentation": "

    A list of objects containing summary information for a transcription job.

    " } }, "Status": { @@ -1370,10 +1803,10 @@ "smithy.api#documentation": "

    The requested status of the jobs returned.

    " } }, - "TranscriptionJobSummaries": { - "target": "com.amazonaws.transcribe#TranscriptionJobSummaries", + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

    A list of objects containing summary information for a transcription job.

    " + "smithy.api#documentation": "

    The ListTranscriptionJobs operation returns a page of jobs at a time. The\n maximum size of the page is set by the MaxResults parameter. If there are\n more jobs in the list than the page size, Amazon Transcribe returns the NextPage token.\n Include the token in the next request to the ListTranscriptionJobs\n operation to return in the next page of jobs.

    " } } } @@ -1414,13 +1847,6 @@ "com.amazonaws.transcribe#ListVocabulariesRequest": { "type": "structure", "members": { - "StateEquals": { - "target": "com.amazonaws.transcribe#VocabularyState", - "traits": { - "smithy.api#documentation": "

    When specified, only returns vocabularies with the VocabularyState field\n equal to the specified state.

    ", - "smithy.api#httpQuery": "StateEquals" - } - }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { @@ -1428,6 +1854,13 @@ "smithy.api#httpQuery": "NextToken" } }, + "NameContains": { + "target": "com.amazonaws.transcribe#VocabularyName", + "traits": { + "smithy.api#documentation": "

    When specified, the vocabularies returned in the list are limited to vocabularies\n whose name contains the specified string. The search is not case sensitive,\n ListVocabularies returns both \"vocabularyname\" and \"VocabularyName\" in\n the response list.

    ", + "smithy.api#httpQuery": "NameContains" + } + }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { @@ -1435,11 +1868,11 @@ "smithy.api#httpQuery": "MaxResults" } }, - "NameContains": { - "target": "com.amazonaws.transcribe#VocabularyName", + "StateEquals": { + "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

    When specified, the vocabularies returned in the list are limited to vocabularies\n whose name contains the specified string. The search is case-insensitive,\n ListVocabularies returns both \"vocabularyname\" and \"VocabularyName\" in\n the response list.

    ", - "smithy.api#httpQuery": "NameContains" + "smithy.api#documentation": "

    When specified, only returns vocabularies with the VocabularyState field\n equal to the specified state.

    ", + "smithy.api#httpQuery": "StateEquals" } } } @@ -1447,16 +1880,16 @@ "com.amazonaws.transcribe#ListVocabulariesResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.transcribe#VocabularyState", + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

    The requested vocabulary state.

    " + "smithy.api#documentation": "

    The ListVocabularies operation returns a page of vocabularies at a time.\n The maximum size of the page is set in the MaxResults parameter. If there\n are more jobs in the list than will fit on the page, Amazon Transcribe returns the\n NextPage token. To return in the next page of jobs, include the token\n in the next request to the ListVocabularies operation.

    " } }, - "NextToken": { - "target": "com.amazonaws.transcribe#NextToken", + "Status": { + "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

    The ListVocabularies operation returns a page of vocabularies at a time.\n The maximum size of the page is set by the MaxResults parameter. If there\n are more jobs in the list than the page size, Amazon Transcribe returns the NextPage\n token. Include the token in the next request to the ListVocabularies\n operation to return in the next page of jobs.

    " + "smithy.api#documentation": "

    The requested vocabulary state.

    " } }, "Vocabularies": { @@ -1503,13 +1936,6 @@ "com.amazonaws.transcribe#ListVocabularyFiltersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.transcribe#NextToken", - "traits": { - "smithy.api#documentation": "

    If the result of the previous request to ListVocabularyFilters was\n truncated, include the NextToken to fetch the next set of\n collections.

    ", - "smithy.api#httpQuery": "NextToken" - } - }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { @@ -1523,23 +1949,30 @@ "smithy.api#documentation": "

    The maximum number of filters to return in the response. If there are fewer results in\n the list, this response contains only the actual results.

    ", "smithy.api#httpQuery": "MaxResults" } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    If the result of the previous request to ListVocabularyFilters was\n truncated, include the NextToken to fetch the next set of\n collections.

    ", + "smithy.api#httpQuery": "NextToken" + } } } }, "com.amazonaws.transcribe#ListVocabularyFiltersResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.transcribe#NextToken", - "traits": { - "smithy.api#documentation": "

    The ListVocabularyFilters operation returns a page of collections at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n there are more jobs in the list than the page size, Amazon Transcribe returns the\n NextPage token. Include the token in the next request to the\n ListVocabularyFilters operation to return in the next page of\n jobs.

    " - } - }, "VocabularyFilters": { "target": "com.amazonaws.transcribe#VocabularyFilters", "traits": { "smithy.api#documentation": "

    The list of vocabulary filters. It contains at most MaxResults number of\n filters. If there are more filters, call the ListVocabularyFilters\n operation again with the NextToken parameter in the request set to the\n value of the NextToken field in the response.

    " } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

    The ListVocabularyFilters operation returns a page of collections at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n there are more jobs in the list than the page size, Amazon Transcribe returns the\n NextPage token. Include the token in the next request to the\n ListVocabularyFilters operation to return in the next page of\n jobs.

    " + } } } }, @@ -1606,6 +2039,18 @@ { "value": "flac", "name": "FLAC" + }, + { + "value": "ogg", + "name": "OGG" + }, + { + "value": "amr", + "name": "AMR" + }, + { + "value": "webm", + "name": "WEBM" } ] } @@ -1637,10 +2082,10 @@ "com.amazonaws.transcribe#MedicalTranscriptionJob": { "type": "structure", "members": { - "FailureReason": { - "target": "com.amazonaws.transcribe#FailureReason", + "TranscriptionJobStatus": { + "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

    If the TranscriptionJobStatus field is FAILED, this field\n contains information about why the job failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format- The media format specified in the\n MediaFormat field of the request isn't valid. See the\n description of the MediaFormat field for a list of valid\n values.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format- The media format of the audio file doesn't match the format\n specified in the MediaFormat field in the request. Check the media\n format of your media file and make sure the two values match.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file- The sample rate specified in\n the MediaSampleRateHertz of the request isn't valid. The sample\n rate must be between 8000 and 48000 Hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample rate-\n The sample rate in the audio file doesn't match the sample rate specified in the\n MediaSampleRateHertz field in the request. Check the sample\n rate of your media file and make sure that the two values match.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large- The size of your audio\n file is larger than what Amazon Transcribe Medical can process. For more information, see Guidlines and\n Quotas in the Amazon Transcribe Medical Guide\n

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large- Your\n audio contains more channels than Amazon Transcribe Medical is configured to process. To request\n additional channels, see Amazon Transcribe Medical Endpoints and\n Quotas in the Amazon Web Services General\n Reference\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The completion status of a medical transcription job.

    " } }, "Type": { @@ -1649,78 +2094,78 @@ "smithy.api#documentation": "

    The type of speech in the transcription job. CONVERSATION is generally\n used for patient-physician dialogues. DICTATION is the setting for\n physicians speaking their notes after seeing a patient. For more information, see how-it-works-med\n

    " } }, - "CreationTime": { - "target": "com.amazonaws.transcribe#DateTime", + "Settings": { + "target": "com.amazonaws.transcribe#MedicalTranscriptionSetting", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job was created.

    " + "smithy.api#documentation": "

    Object that contains object.

    " } }, - "MedicalTranscriptionJobName": { - "target": "com.amazonaws.transcribe#TranscriptionJobName", + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

    The name for a given medical transcription job.

    " + "smithy.api#documentation": "

    The sample rate, in Hertz, of the source audio containing medical information.

    \n

    If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample\n rate.

    " } }, - "Media": { - "target": "com.amazonaws.transcribe#Media" - }, - "Transcript": { - "target": "com.amazonaws.transcribe#MedicalTranscript", + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    An object that contains the MedicalTranscript. The\n MedicalTranscript contains the TranscriptFileUri.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job started processing.

    " } }, - "Specialty": { - "target": "com.amazonaws.transcribe#Specialty", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The medical specialty of any clinicians providing a dictation or having a\n conversation. PRIMARYCARE is the only available setting for this object.\n This specialty enables you to generate transcriptions for the following medical\n fields:

    \n
      \n
    • \n

      Family Medicine

      \n
      • \n
    " + "smithy.api#documentation": "

    The language code for the language spoken in the source audio file. US English (en-US)\n is the only supported language for medical transcriptions. Any other value you enter for\n language code results in a BadRequestException error.

    " } }, - "TranscriptionJobStatus": { - "target": "com.amazonaws.transcribe#TranscriptionJobStatus", + "MedicalTranscriptionJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

    The completion status of a medical transcription job.

    " + "smithy.api#documentation": "

    The name for a given medical transcription job.

    " } }, - "CompletionTime": { - "target": "com.amazonaws.transcribe#DateTime", + "Transcript": { + "target": "com.amazonaws.transcribe#MedicalTranscript", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " + "smithy.api#documentation": "

    An object that contains the MedicalTranscript. The\n MedicalTranscript contains the TranscriptFileUri.

    " } }, - "Settings": { - "target": "com.amazonaws.transcribe#MedicalTranscriptionSetting", + "MediaFormat": { + "target": "com.amazonaws.transcribe#MediaFormat", "traits": { - "smithy.api#documentation": "

    Object that contains \n object.

    " + "smithy.api#documentation": "

    The format of the input media file.

    " } }, - "StartTime": { + "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job started processing.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job was created.

    " } }, - "MediaSampleRateHertz": { - "target": "com.amazonaws.transcribe#MediaSampleRateHertz", + "Media": { + "target": "com.amazonaws.transcribe#Media" + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

    The sample rate, in Hertz, of the source audio containing medical information.

    \n

    If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample\n rate.

    " + "smithy.api#documentation": "

    If the TranscriptionJobStatus field is FAILED, this field\n contains information about why the job failed.

    \n

    The FailureReason field contains one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format- The media format specified in the\n MediaFormat field of the request isn't valid. See the\n description of the MediaFormat field for a list of valid\n values.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format- The media format of the audio file doesn't match the format\n specified in the MediaFormat field in the request. Check the media\n format of your media file and make sure the two values match.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file- The sample rate specified in\n the MediaSampleRateHertz of the request isn't valid. The sample\n rate must be between 8000 and 48000 Hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample rate-\n The sample rate in the audio file doesn't match the sample rate specified in the\n MediaSampleRateHertz field in the request. Check the sample\n rate of your media file and make sure that the two values match.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large- The size of your audio\n file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and\n Quotas in the Amazon Transcribe Medical Guide\n

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large- Your\n audio contains more channels than Amazon Transcribe Medical is configured to process. To request\n additional channels, see Amazon Transcribe Medical Endpoints and\n Quotas in the Amazon Web Services General\n Reference\n

      \n
      • \n
    " } }, - "MediaFormat": { - "target": "com.amazonaws.transcribe#MediaFormat", + "Specialty": { + "target": "com.amazonaws.transcribe#Specialty", "traits": { - "smithy.api#documentation": "

    The format of the input media file.

    " + "smithy.api#documentation": "

    The medical specialty of any clinicians providing a dictation or having a\n conversation. PRIMARYCARE is the only available setting for this object.\n This specialty enables you to generate transcriptions for the following medical\n fields:

    \n
      \n
    • \n

      Family Medicine

      \n
      • \n
    " } }, - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The language code for the language spoken in the source audio file. US English (en-US)\n is the only supported language for medical transcriptions. Any other value you enter for\n language code results in a BadRequestException error.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " } } }, "traits": { - "smithy.api#documentation": "

    The data structure that containts the information for a medical transcription\n job.

    " + "smithy.api#documentation": "

    The data structure that contains the information for a medical transcription\n job.

    " } }, "com.amazonaws.transcribe#MedicalTranscriptionJobSummaries": { @@ -1732,58 +2177,52 @@ "com.amazonaws.transcribe#MedicalTranscriptionJobSummary": { "type": "structure", "members": { - "FailureReason": { - "target": "com.amazonaws.transcribe#FailureReason", - "traits": { - "smithy.api#documentation": "

    If the TranscriptionJobStatus field is FAILED, a description\n of the error.

    " - } - }, - "OutputLocationType": { - "target": "com.amazonaws.transcribe#OutputLocationType", + "MedicalTranscriptionJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

    Indicates the location of the transcription job's output.

    \n

    The CUSTOMER_BUCKET is the S3 location provided in the\n OutputBucketName field when the

    " + "smithy.api#documentation": "

    The name of a medical transcription job.

    " } }, - "Type": { - "target": "com.amazonaws.transcribe#Type", + "TranscriptionJobStatus": { + "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

    The speech of the clinician in the input audio.

    " + "smithy.api#documentation": "

    The status of the medical transcription job.

    " } }, - "CompletionTime": { + "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job began processing.

    " } }, - "StartTime": { - "target": "com.amazonaws.transcribe#DateTime", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job began processing.

    " + "smithy.api#documentation": "

    The language of the transcript in the source audio file.

    " } }, - "TranscriptionJobStatus": { - "target": "com.amazonaws.transcribe#TranscriptionJobStatus", + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

    The status of the medical transcription job.

    " + "smithy.api#documentation": "

    If the TranscriptionJobStatus field is FAILED, a description\n of the error.

    " } }, - "MedicalTranscriptionJobName": { - "target": "com.amazonaws.transcribe#TranscriptionJobName", + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The name of a medical transcription job.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " } }, - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "OutputLocationType": { + "target": "com.amazonaws.transcribe#OutputLocationType", "traits": { - "smithy.api#documentation": "

    The language of the transcript in the source audio file.

    " + "smithy.api#documentation": "

    Indicates the location of the transcription job's output.

    \n

    The CUSTOMER_BUCKET is the S3 location provided in the\n OutputBucketName field when the

    " } }, - "CreationTime": { - "target": "com.amazonaws.transcribe#DateTime", + "Type": { + "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the medical transcription job was created.

    " + "smithy.api#documentation": "

    The speech of the clinician in the input audio.

    " } }, "Specialty": { @@ -1791,6 +2230,12 @@ "traits": { "smithy.api#documentation": "

    The medical specialty of the transcription job. Primary care is the only\n valid value.

    " } + }, + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

    A timestamp that shows when the medical transcription job was created.

    " + } } }, "traits": { @@ -1800,28 +2245,22 @@ "com.amazonaws.transcribe#MedicalTranscriptionSetting": { "type": "structure", "members": { - "ShowSpeakerLabels": { + "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    Determines whether the transcription job uses speaker recognition to identify\n different speakers in the input audio. Speaker recongition labels individual speakers in\n the audio file. If you set the ShowSpeakerLabels field to true, you must\n also set the maximum number of speaker labels in the MaxSpeakerLabels\n field.

    \n

    You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

    " - } - }, - "MaxSpeakerLabels": { - "target": "com.amazonaws.transcribe#MaxSpeakers", - "traits": { - "smithy.api#documentation": "

    The maximum number of speakers to identify in the input audio. If there are more\n speakers in the audio than this number, multiple speakers are identified as a single\n speaker. If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

    " + "smithy.api#documentation": "

    Determines whether alternative transcripts are generated along with the transcript\n that has the highest confidence. If you set ShowAlternatives field to true,\n you must also set the maximum number of alternatives to return in the\n MaxAlternatives field.

    " } }, - "ShowAlternatives": { + "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    Determines whether alternative transcripts are generated along with the transcript\n that has the highest confidence. If you set ShowAlternatives field to true,\n you must also set the maximum number of alternatives to return in the\n MaxAlternatives field.

    " + "smithy.api#documentation": "

    Determines whether the transcription job uses speaker recognition to identify\n different speakers in the input audio. Speaker recognition labels individual speakers in\n the audio file. If you set the ShowSpeakerLabels field to true, you must\n also set the maximum number of speaker labels in the MaxSpeakerLabels\n field.

    \n

    You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

    " } }, - "MaxAlternatives": { - "target": "com.amazonaws.transcribe#MaxAlternatives", + "MaxSpeakerLabels": { + "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

    The maximum number of alternatives that you tell the service to return. If you specify\n the MaxAlternatives field, you must set the ShowAlternatives\n field to true.

    " + "smithy.api#documentation": "

    The maximum number of speakers to identify in the input audio. If there are more\n speakers in the audio than this number, multiple speakers are identified as a single\n speaker. If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

    " } }, "VocabularyName": { @@ -1835,12 +2274,67 @@ "traits": { "smithy.api#documentation": "

    Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the\n transcription output of each channel into a single transcription.

    \n

    Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel,\n including the start time and end time of the item and alternative transcriptions of\n item. The alternative transcriptions also come with confidence scores provided by\n Amazon Transcribe Medical.

    \n

    You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException\n

    " } + }, + "MaxAlternatives": { + "target": "com.amazonaws.transcribe#MaxAlternatives", + "traits": { + "smithy.api#documentation": "

    The maximum number of alternatives that you tell the service to return. If you specify\n the MaxAlternatives field, you must set the ShowAlternatives\n field to true.

    " + } } }, "traits": { "smithy.api#documentation": "

    Optional settings for the StartMedicalTranscriptionJob\n operation.

    " } }, + "com.amazonaws.transcribe#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+" + } + }, + "com.amazonaws.transcribe#ModelSettings": { + "type": "structure", + "members": { + "LanguageModelName": { + "target": "com.amazonaws.transcribe#ModelName", + "traits": { + "smithy.api#documentation": "

    The name of your custom language model.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The object used to call your custom language model to your transcription job.

    " + } + }, + "com.amazonaws.transcribe#ModelStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.transcribe#Models": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#LanguageModel" + } + }, "com.amazonaws.transcribe#NextToken": { "type": "string", "traits": { @@ -1874,6 +2368,16 @@ "smithy.api#pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" } }, + "com.amazonaws.transcribe#OutputKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "[a-zA-Z0-9-_.!*'()/]{1,1024}$" + } + }, "com.amazonaws.transcribe#OutputLocationType": { "type": "string", "traits": { @@ -1934,22 +2438,16 @@ "com.amazonaws.transcribe#Settings": { "type": "structure", "members": { - "ChannelIdentification": { + "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    Instructs Amazon Transcribe to process each audio channel separately and then merge the\n transcription output of each channel into a single transcription.

    \n

    Amazon Transcribe also produces a transcription of each item detected on an audio channel,\n including the start time and end time of the item and alternative transcriptions of the\n item including the confidence that Amazon Transcribe has in the transcription.

    \n

    You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

    " - } - }, - "VocabularyFilterName": { - "target": "com.amazonaws.transcribe#VocabularyFilterName", - "traits": { - "smithy.api#documentation": "

    The name of the vocabulary filter to use when transcribing the audio. The filter that\n you specify must have the same language code as the transcription job.

    " + "smithy.api#documentation": "

    Determines whether the transcription job uses speaker recognition to identify\n different speakers in the input audio. Speaker recognition labels individual speakers in\n the audio file. If you set the ShowSpeakerLabels field to true, you must\n also set the maximum number of speaker labels MaxSpeakerLabels\n field.

    \n

    You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

    " } }, - "MaxAlternatives": { - "target": "com.amazonaws.transcribe#MaxAlternatives", + "MaxSpeakerLabels": { + "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

    The number of alternative transcriptions that the service should return. If you\n specify the MaxAlternatives field, you must set the\n ShowAlternatives field to true.

    " + "smithy.api#documentation": "

    The maximum number of speakers to identify in the input audio. If there are more\n speakers in the audio than this number, multiple speakers are identified as a single\n speaker. If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

    " } }, "ShowAlternatives": { @@ -1958,16 +2456,16 @@ "smithy.api#documentation": "

    Determines whether the transcription contains alternative transcriptions. If you set\n the ShowAlternatives field to true, you must also set the maximum number of\n alternatives to return in the MaxAlternatives field.

    " } }, - "ShowSpeakerLabels": { - "target": "com.amazonaws.transcribe#Boolean", + "MaxAlternatives": { + "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "

    Determines whether the transcription job uses speaker recognition to identify\n different speakers in the input audio. Speaker recognition labels individual speakers in\n the audio file. If you set the ShowSpeakerLabels field to true, you must\n also set the maximum number of speaker labels MaxSpeakerLabels\n field.

    \n

    You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

    " + "smithy.api#documentation": "

    The number of alternative transcriptions that the service should return. If you\n specify the MaxAlternatives field, you must set the\n ShowAlternatives field to true.

    " } }, - "MaxSpeakerLabels": { - "target": "com.amazonaws.transcribe#MaxSpeakers", + "VocabularyFilterMethod": { + "target": "com.amazonaws.transcribe#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

    The maximum number of speakers to identify in the input audio. If there are more\n speakers in the audio than this number, multiple speakers are identified as a single\n speaker. If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

    " + "smithy.api#documentation": "

    Set to mask to remove filtered text from the transcript and replace it\n with three asterisks (\"***\") as placeholder text. Set to remove to remove\n filtered text from the transcript without using placeholder text.

    " } }, "VocabularyName": { @@ -1976,10 +2474,16 @@ "smithy.api#documentation": "

    The name of a vocabulary to use when processing the transcription job.

    " } }, - "VocabularyFilterMethod": { - "target": "com.amazonaws.transcribe#VocabularyFilterMethod", + "VocabularyFilterName": { + "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

    Set to mask to remove filtered text from the transcript and replace it\n with three asterisks (\"***\") as placeholder text. Set to remove to remove\n filtered text from the transcript without using placeholder text.

    " + "smithy.api#documentation": "

    The name of the vocabulary filter to use when transcribing the audio. The filter that\n you specify must have the same language code as the transcription job.

    " + } + }, + "ChannelIdentification": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

    Instructs Amazon Transcribe to process each audio channel separately and then merge the\n transcription output of each channel into a single transcription.

    \n

    Amazon Transcribe also produces a transcription of each item detected on an audio channel,\n including the start time and end time of the item and alternative transcriptions of the\n item including the confidence that Amazon Transcribe has in the transcription.

    \n

    You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

    " } } }, @@ -2021,7 +2525,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Start a batch job to transcribe medical speech to text.

    ", + "smithy.api#documentation": "

    Starts a batch job to transcribe medical speech to text.

    ", "smithy.api#http": { "method": "PUT", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -2032,19 +2536,10 @@ "com.amazonaws.transcribe#StartMedicalTranscriptionJobRequest": { "type": "structure", "members": { - "Specialty": { - "target": "com.amazonaws.transcribe#Specialty", - "traits": { - "smithy.api#documentation": "

    The medical specialty of any clinician speaking in the input media.

    ", - "smithy.api#required": {} - } - }, - "MedicalTranscriptionJobName": { - "target": "com.amazonaws.transcribe#TranscriptionJobName", + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

    The name of the medical transcription job. You can't use the strings \".\" or \"..\" by\n themselves as the job name. The name must also be unique within an AWS account. If you\n try to create a medical transcription job with the same name as a previous medical\n transcription job you will receive a ConflictException error.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The sample rate, in Hertz, of the audio track in the input media file.

    \n

    If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine\n the sample rate.

    " } }, "OutputBucketName": { @@ -2061,29 +2556,44 @@ "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.transcribe#Type", + "MediaFormat": { + "target": "com.amazonaws.transcribe#MediaFormat", "traits": { - "smithy.api#documentation": "

    The type of speech in the input audio. CONVERSATION refers to\n conversations between two or more speakers, e.g., a conversations between doctors and\n patients. DICTATION refers to single-speaker dictated speech, e.g., for\n clinical notes.

    ", + "smithy.api#documentation": "

    The audio format of the input media file.

    " + } + }, + "MedicalTranscriptionJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    The name of the medical transcription job. You can't use the strings \".\"\n or \"..\" by themselves as the job name. The name must also be unique within\n an AWS account. If you try to create a medical transcription job with the same name as a\n previous medical transcription job, you get a ConflictException\n error.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MediaFormat": { - "target": "com.amazonaws.transcribe#MediaFormat", + "OutputEncryptionKMSKeyId": { + "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

    The audio format of the input media file.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to\n encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the\n specified KMS key.

    \n

    You use either of the following to identify a KMS key in the current account:

    \n
      \n
    • \n

      KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      KMS Key Alias: \"alias/ExampleAlias\"

      \n
      • \n
    \n

    You can use either of the following to identify a KMS key in the current account or\n another account:

    \n
      \n
    • \n

      Amazon Resource Name (ARN) of a KMS key in the current account or another\n account: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

      \n
      • \n
    \n

    If you don't specify an encryption key, the output of the medical transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

    " } }, - "Settings": { - "target": "com.amazonaws.transcribe#MedicalTranscriptionSetting", + "OutputKey": { + "target": "com.amazonaws.transcribe#OutputKey", "traits": { - "smithy.api#documentation": "

    Optional settings for the medical transcription job.

    " + "smithy.api#documentation": "

    You can specify a location in an Amazon S3 bucket to store the output of your medical\n transcription job.

    \n

    If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job\n in the Amazon S3 bucket you specified. By default, the object key is\n \"your-transcription-job-name.json\".

    \n

    You can use output keys to specify the Amazon S3 prefix and file name of the transcription\n output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key\n would lead to the output being stored as\n \"folder1/folder2/your-transcription-job-name.json\". If you specify\n \"my-other-job-name.json\" as the output key, the object key is changed to\n \"my-other-job-name.json\". You can use an output key to change both the prefix and the\n file name, for example \"folder/my-other-job-name.json\".

    \n

    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

    " } }, - "MediaSampleRateHertz": { - "target": "com.amazonaws.transcribe#MediaSampleRateHertz", + "Specialty": { + "target": "com.amazonaws.transcribe#Specialty", "traits": { - "smithy.api#documentation": "

    The sample rate, in Hertz, of the audio track in the input media file.

    \n

    If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine\n the sample rate.

    " + "smithy.api#documentation": "

    The medical specialty of any clinician speaking in the input media.

    ", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.transcribe#Type", + "traits": { + "smithy.api#documentation": "

    The type of speech in the input audio. CONVERSATION refers to\n conversations between two or more speakers, e.g., a conversations between doctors and\n patients. DICTATION refers to single-speaker dictated speech, e.g., for\n clinical notes.

    ", + "smithy.api#required": {} } }, "Media": { @@ -2092,10 +2602,10 @@ "smithy.api#required": {} } }, - "OutputEncryptionKMSKeyId": { - "target": "com.amazonaws.transcribe#KMSKeyId", + "Settings": { + "target": "com.amazonaws.transcribe#MedicalTranscriptionSetting", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to\n encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the\n specified KMS key.

    \n

    You use either of the following to identify a KMS key in the current account:

    \n
      \n
    • \n

      KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      KMS Key Alias: \"alias/ExampleAlias\"

      \n
      • \n
    \n

    You can use either of the following to identify a KMS key in the current account or\n another account:

    \n
      \n
    • \n

      Amazon Resource Name (ARN) of a KMS key in the current account or another\n account: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

      \n
      • \n
    \n

    If you don't specify an encryption key, the output of the medical transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

    " + "smithy.api#documentation": "

    Optional settings for the medical transcription job.

    " } } } @@ -2145,16 +2655,28 @@ "com.amazonaws.transcribe#StartTranscriptionJobRequest": { "type": "structure", "members": { - "JobExecutionSettings": { - "target": "com.amazonaws.transcribe#JobExecutionSettings", + "OutputEncryptionKMSKeyId": { + "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

    Provides information about how a transcription job is executed. Use this field to\n indicate that the job can be queued for deferred execution if the concurrency limit is\n reached and there are no slots available to immediately run the job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to\n encrypt the output of the transcription job. The user calling the\n StartTranscriptionJob operation must have permission to use the\n specified KMS key.

    \n

    You can use either of the following to identify a KMS key in the current\n account:

    \n
      \n
    • \n

      KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      KMS Key Alias: \"alias/ExampleAlias\"

      \n
      • \n
    \n

    You can use either of the following to identify a KMS key in the current account or\n another account:

    \n
      \n
    • \n

      Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

      \n
      • \n
    \n

    If you don't specify an encryption key, the output of the transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

    " } }, - "Settings": { - "target": "com.amazonaws.transcribe#Settings", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    A Settings object that provides optional settings for a transcription\n job.

    " + "smithy.api#documentation": "

    The language code for the language used in the input media file.

    " + } + }, + "ModelSettings": { + "target": "com.amazonaws.transcribe#ModelSettings", + "traits": { + "smithy.api#documentation": "

    Choose the custom language model you use for your transcription job in this\n parameter.

    " + } + }, + "JobExecutionSettings": { + "target": "com.amazonaws.transcribe#JobExecutionSettings", + "traits": { + "smithy.api#documentation": "

    Provides information about how a transcription job is executed. Use this field to\n indicate that the job can be queued for deferred execution if the concurrency limit is\n reached and there are no slots available to immediately run the job.

    " } }, "MediaSampleRateHertz": { @@ -2169,23 +2691,10 @@ "smithy.api#documentation": "

    The location where the transcription is stored.

    \n

    If you set the OutputBucketName, Amazon Transcribe puts the transcript in the\n specified S3 bucket. When you call the GetTranscriptionJob operation,\n the operation returns this location in the TranscriptFileUri field. If you\n enable content redaction, the redacted transcript appears in\n RedactedTranscriptFileUri. If you enable content redaction and choose\n to output an unredacted transcript, that transcript's location still appears in the\n TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe\n to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

    \n

    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your\n transcription using the OutputEncryptionKMSKeyId parameter. If you don't\n specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of\n transcripts that are placed in your S3 bucket.

    \n

    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL,\n a shareable URL that provides secure access to your transcription, and returns it in the\n TranscriptFileUri field. Use this URL to download the\n transcription.

    " } }, - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", - "traits": { - "smithy.api#documentation": "

    The language code for the language used in the input media file.

    ", - "smithy.api#required": {} - } - }, - "MediaFormat": { - "target": "com.amazonaws.transcribe#MediaFormat", - "traits": { - "smithy.api#documentation": "

    The format of the input media file.

    " - } - }, - "OutputEncryptionKMSKeyId": { - "target": "com.amazonaws.transcribe#KMSKeyId", + "IdentifyLanguage": { + "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to\n encrypt the output of the transcription job. The user calling the\n StartTranscriptionJob operation must have permission to use the\n specified KMS key.

    \n

    You can use either of the following to identify a KMS key in the current\n account:

    \n
      \n
    • \n

      KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      KMS Key Alias: \"alias/ExampleAlias\"

      \n
      • \n
    \n

    You can use either of the following to identify a KMS key in the current account or\n another account:

    \n
      \n
    • \n

      Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

      \n
      • \n
    • \n

      ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

      \n
      • \n
    \n

    If you don't specify an encryption key, the output of the transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

    \n

    If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

    " + "smithy.api#documentation": "

    Set this field to true to enable automatic language identification.\n Automatic language identification is disabled by default. You receive a\n BadRequestException error if you enter a value for a\n LanguageCode.

    " } }, "ContentRedaction": { @@ -2201,13 +2710,37 @@ "smithy.api#required": {} } }, + "LanguageOptions": { + "target": "com.amazonaws.transcribe#LanguageOptions", + "traits": { + "smithy.api#documentation": "

    An object containing a list of languages that might be present in your collection of\n audio files. Automatic language identification chooses a language that best matches the\n source audio from that list.

    " + } + }, + "MediaFormat": { + "target": "com.amazonaws.transcribe#MediaFormat", + "traits": { + "smithy.api#documentation": "

    The format of the input media file.

    " + } + }, "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

    The name of the job. Note that you can't use the strings \".\" or \"..\" by themselves as\n the job name. The name must also be unique within an AWS account. If you try to create a\n transcription job with the same name as a previous transcription job you will receive a\n ConflictException error.

    ", + "smithy.api#documentation": "

    The name of the job. You can't use the strings \".\" or \"..\"\n by themselves as the job name. The name must also be unique within an AWS account. If\n you try to create a transcription job with the same name as a previous transcription\n job, you get a ConflictException error.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "OutputKey": { + "target": "com.amazonaws.transcribe#OutputKey", + "traits": { + "smithy.api#documentation": "

    You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

    \n

    If you don't specify an output key, Amazon Transcribe stores the output of your transcription job\n in the Amazon S3 bucket you specified. By default, the object key is\n \"your-transcription-job-name.json\".

    \n

    You can use output keys to specify the Amazon S3 prefix and file name of the transcription\n output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key\n would lead to the output being stored as\n \"folder1/folder2/your-transcription-job-name.json\". If you specify\n \"my-other-job-name.json\" as the output key, the object key is changed to\n \"my-other-job-name.json\". You can use an output key to change both the prefix and the\n file name, for example \"folder/my-other-job-name.json\".

    \n

    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

    " + } + }, + "Settings": { + "target": "com.amazonaws.transcribe#Settings", + "traits": { + "smithy.api#documentation": "

    A Settings object that provides optional settings for a transcription\n job.

    " + } } } }, @@ -2229,6 +2762,9 @@ "type": "service", "version": "2017-10-26", "operations": [ + { + "target": "com.amazonaws.transcribe#CreateLanguageModel" + }, { "target": "com.amazonaws.transcribe#CreateMedicalVocabulary" }, @@ -2238,6 +2774,9 @@ { "target": "com.amazonaws.transcribe#CreateVocabularyFilter" }, + { + "target": "com.amazonaws.transcribe#DeleteLanguageModel" + }, { "target": "com.amazonaws.transcribe#DeleteMedicalTranscriptionJob" }, @@ -2253,6 +2792,9 @@ { "target": "com.amazonaws.transcribe#DeleteVocabularyFilter" }, + { + "target": "com.amazonaws.transcribe#DescribeLanguageModel" + }, { "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJob" }, @@ -2268,6 +2810,9 @@ { "target": "com.amazonaws.transcribe#GetVocabularyFilter" }, + { + "target": "com.amazonaws.transcribe#ListLanguageModels" + }, { "target": "com.amazonaws.transcribe#ListMedicalTranscriptionJobs" }, @@ -2317,16 +2862,16 @@ "com.amazonaws.transcribe#Transcript": { "type": "structure", "members": { - "TranscriptFileUri": { + "RedactedTranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The S3 object location of the the transcript.

    \n

    Use this URI to access the transcript. If you specified an S3 bucket in the\n OutputBucketName field when you created the job, this is the URI of\n that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that\n provides secure access to that location.

    " + "smithy.api#documentation": "

    The S3 object location of the redacted transcript.

    \n

    Use this URI to access the redacted transcript. If you specified an S3 bucket in the\n OutputBucketName field when you created the job, this is the URI of\n that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that\n provides secure access to that location.

    " } }, - "RedactedTranscriptFileUri": { + "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

    The S3 object location of the redacted transcript.

    \n\n

    Use this URI to access the redacated transcript. If you specified an S3 bucket in the\n OutputBucketName field when you created the job, this is the URI of\n that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that\n provides secure access to that location.

    " + "smithy.api#documentation": "

    The S3 object location of the transcript.

    \n

    Use this URI to access the transcript. If you specified an S3 bucket in the\n OutputBucketName field when you created the job, this is the URI of\n that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that\n provides secure access to that location.

    " } } }, @@ -2337,16 +2882,22 @@ "com.amazonaws.transcribe#TranscriptionJob": { "type": "structure", "members": { - "CompletionTime": { - "target": "com.amazonaws.transcribe#DateTime", + "MediaFormat": { + "target": "com.amazonaws.transcribe#MediaFormat", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " + "smithy.api#documentation": "

    The format of the input media file.

    " } }, - "TranscriptionJobStatus": { - "target": "com.amazonaws.transcribe#TranscriptionJobStatus", + "IdentifiedLanguageScore": { + "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

    The status of the transcription job.

    " + "smithy.api#documentation": "

    A value between zero and one that Amazon Transcribe assigned to the language that it identified in\n the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the\n language it identified.

    " + } + }, + "Transcript": { + "target": "com.amazonaws.transcribe#Transcript", + "traits": { + "smithy.api#documentation": "

    An object that describes the output of the transcription job.

    " } }, "Settings": { @@ -2355,46 +2906,64 @@ "smithy.api#documentation": "

    Optional settings for the transcription job. Use these settings to turn on speaker\n recognition, to set the maximum number of speakers that should be identified and to\n specify a custom vocabulary to use when processing the transcription job.

    " } }, - "TranscriptionJobName": { - "target": "com.amazonaws.transcribe#TranscriptionJobName", + "LanguageOptions": { + "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

    The name of the transcription job.

    " + "smithy.api#documentation": "

    An object that shows the optional array of languages inputted for transcription jobs\n with automatic language identification enabled.

    " } }, - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "Media": { + "target": "com.amazonaws.transcribe#Media", "traits": { - "smithy.api#documentation": "

    The language code for the input speech.

    " + "smithy.api#documentation": "

    An object that describes the input media for the transcription job.

    " } }, - "MediaSampleRateHertz": { - "target": "com.amazonaws.transcribe#MediaSampleRateHertz", + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

    The sample rate, in Hertz, of the audio track in the input media file.

    " + "smithy.api#documentation": "

    If the TranscriptionJobStatus field is FAILED, this field\n contains information about why the job failed.

    \n

    The FailureReason field can contain one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format - The media format specified in the\n MediaFormat field of the request isn't valid. See the\n description of the MediaFormat field for a list of valid\n values.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format - The media format of the audio file doesn't match the format\n specified in the MediaFormat field in the request. Check the media\n format of your media file and make sure that the two values match.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file - The sample rate specified in\n the MediaSampleRateHertz of the request isn't valid. The sample\n rate must be between 8000 and 48000 Hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample rate\n - The sample rate in the audio file doesn't match the sample rate specified in\n the MediaSampleRateHertz field in the request. Check the sample\n rate of your media file and make sure that the two values match.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large - The size of your audio\n file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large - Your\n audio contains more channels than Amazon Transcribe is configured to process. To request\n additional channels, see Amazon Transcribe Limits in the Amazon Web Services\n General Reference.

      \n
      • \n
    " } }, - "StartTime": { + "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    A timestamp that shows with the job was started processing.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " } }, - "MediaFormat": { - "target": "com.amazonaws.transcribe#MediaFormat", + "JobExecutionSettings": { + "target": "com.amazonaws.transcribe#JobExecutionSettings", "traits": { - "smithy.api#documentation": "

    The format of the input media file.

    " + "smithy.api#documentation": "

    Provides information about how a transcription job is executed.

    " } }, - "Transcript": { - "target": "com.amazonaws.transcribe#Transcript", + "ModelSettings": { + "target": "com.amazonaws.transcribe#ModelSettings", "traits": { - "smithy.api#documentation": "

    An object that describes the output of the transcription job.

    " + "smithy.api#documentation": "

    An object containing the details of your custom language model.

    " } }, - "Media": { - "target": "com.amazonaws.transcribe#Media", + "TranscriptionJobStatus": { + "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

    An object that describes the input media for the transcription job.

    " + "smithy.api#documentation": "

    The status of the transcription job.

    " + } + }, + "ContentRedaction": { + "target": "com.amazonaws.transcribe#ContentRedaction", + "traits": { + "smithy.api#documentation": "

    An object that describes content redaction settings for the transcription job.

    " + } + }, + "TranscriptionJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

    The name of the transcription job.

    " + } + }, + "IdentifyLanguage": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

    A value that shows if automatic language identification was enabled for a\n transcription job.

    " } }, "CreationTime": { @@ -2403,22 +2972,22 @@ "smithy.api#documentation": "

    A timestamp that shows when the job was created.

    " } }, - "ContentRedaction": { - "target": "com.amazonaws.transcribe#ContentRedaction", + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    An object that describes content redaction settings for the transcription job.

    " + "smithy.api#documentation": "

    A timestamp that shows with the job was started processing.

    " } }, - "FailureReason": { - "target": "com.amazonaws.transcribe#FailureReason", + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

    If the TranscriptionJobStatus field is FAILED, this field\n contains information about why the job failed.

    \n

    The FailureReason field can contain one of the following values:

    \n
      \n
    • \n

      \n Unsupported media format - The media format specified in the\n MediaFormat field of the request isn't valid. See the\n description of the MediaFormat field for a list of valid\n values.

      \n
      • \n
    • \n

      \n The media format provided does not match the detected media\n format - The media format of the audio file doesn't match the format\n specified in the MediaFormat field in the request. Check the media\n format of your media file and make sure that the two values match.

      \n
      • \n
    • \n

      \n Invalid sample rate for audio file - The sample rate specified in\n the MediaSampleRateHertz of the request isn't valid. The sample\n rate must be between 8000 and 48000 Hertz.

      \n
      • \n
    • \n

      \n The sample rate provided does not match the detected sample rate\n - The sample rate in the audio file doesn't match the sample rate specified in\n the MediaSampleRateHertz field in the request. Check the sample\n rate of your media file and make sure that the two values match.

      \n
      • \n
    • \n

      \n Invalid file size: file size too large - The size of your audio\n file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

      \n
      • \n
    • \n

      \n Invalid number of channels: number of channels too large - Your\n audio contains more channels than Amazon Transcribe is configured to process. To request\n additional channels, see Amazon Transcribe Limits in the Amazon Web Services\n General Reference.

      \n
      • \n
    " + "smithy.api#documentation": "

    The sample rate, in Hertz, of the audio track in the input media file.

    " } }, - "JobExecutionSettings": { - "target": "com.amazonaws.transcribe#JobExecutionSettings", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    Provides information about how a transcription job is executed.

    " + "smithy.api#documentation": "

    The language code for the input speech.

    " } } }, @@ -2468,10 +3037,10 @@ "com.amazonaws.transcribe#TranscriptionJobSummary": { "type": "structure", "members": { - "CreationTime": { + "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job was created.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " } }, "StartTime": { @@ -2480,22 +3049,37 @@ "smithy.api#documentation": "

    A timestamp that shows when the job started processing.

    " } }, + "ModelSettings": { + "target": "com.amazonaws.transcribe#ModelSettings" + }, + "IdentifyLanguage": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

    Whether automatic language identification was enabled for a transcription job.

    " + } + }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { "smithy.api#documentation": "

    If the TranscriptionJobStatus field is FAILED, a description\n of the error.

    " } }, - "ContentRedaction": { - "target": "com.amazonaws.transcribe#ContentRedaction", + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The content redaction settings of the transcription job.

    " + "smithy.api#documentation": "

    A timestamp that shows when the job was created.

    " } }, - "TranscriptionJobStatus": { - "target": "com.amazonaws.transcribe#TranscriptionJobStatus", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The status of the transcription job. When the status is COMPLETED, use\n the GetTranscriptionJob operation to get the results of the\n transcription.

    " + "smithy.api#documentation": "

    The language code for the input speech.

    " + } + }, + "IdentifiedLanguageScore": { + "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", + "traits": { + "smithy.api#documentation": "

    A value between zero and one that Amazon Transcribe assigned to the language it identified in the\n source audio. A higher score indicates that Amazon Transcribe is more confident in the language it\n identified.

    " } }, "TranscriptionJobName": { @@ -2504,10 +3088,10 @@ "smithy.api#documentation": "

    The name of the transcription job.

    " } }, - "CompletionTime": { - "target": "com.amazonaws.transcribe#DateTime", + "ContentRedaction": { + "target": "com.amazonaws.transcribe#ContentRedaction", "traits": { - "smithy.api#documentation": "

    A timestamp that shows when the job was completed.

    " + "smithy.api#documentation": "

    The content redaction settings of the transcription job.

    " } }, "OutputLocationType": { @@ -2516,10 +3100,10 @@ "smithy.api#documentation": "

    Indicates the location of the output of the transcription job.

    \n

    If the value is CUSTOMER_BUCKET then the location is the S3 bucket\n specified in the outputBucketName field when the transcription job was\n started with the StartTranscriptionJob operation.

    \n

    If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can\n be retrieved using the URI in the GetTranscriptionJob response's\n TranscriptFileUri field.

    " } }, - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "TranscriptionJobStatus": { + "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

    The language code for the input speech.

    " + "smithy.api#documentation": "

    The status of the transcription job. When the status is COMPLETED, use\n the GetTranscriptionJob operation to get the results of the\n transcription.

    " } } }, @@ -2568,7 +3152,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an existing vocabulary with new values in a different text file. The\n UpdateMedicalVocabulary operation overwrites all of the existing\n information with the values that you provide in the request.

    ", + "smithy.api#documentation": "

    Updates a vocabulary with new values that you provide in a different text file from\n the one you used to create the vocabulary. The UpdateMedicalVocabulary\n operation overwrites all of the existing information with the values that you provide in\n the request.

    ", "smithy.api#http": { "method": "PATCH", "uri": "/medicalvocabularies/{VocabularyName}", @@ -2579,23 +3163,23 @@ "com.amazonaws.transcribe#UpdateMedicalVocabularyRequest": { "type": "structure", "members": { - "VocabularyFileUri": { - "target": "com.amazonaws.transcribe#Uri", - "traits": { - "smithy.api#documentation": "

    The Amazon S3 location of the text file containing the definition of the custom vocabulary.\n The URI must be in the same AWS region as the API endpoint you are calling. You can see\n the fields you need to enter for you Amazon S3 location in the example URI here:

    \n

    \n \n https://s3..amazonaws.com///\n \n

    \n

    For example:

    \n

    \n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

    \n

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    \n

    For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

    " - } - }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The language code of the entries in the updated vocabulary. US English (en-US) is the\n only valid language code in Amazon Transcribe Medical.

    ", + "smithy.api#documentation": "

    The language code of the language used for the entries in the updated vocabulary. US\n English (en-US) is the only valid language code in Amazon Transcribe Medical.

    ", "smithy.api#required": {} } }, + "VocabularyFileUri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

    The location in Amazon S3 of the text file that contains\n the\n you use for your custom vocabulary. The URI must be in the same AWS\n Region as the resource that you are calling. The following is the format for a\n URI:

    \n

    \n \n https://s3..amazonaws.com///\n \n

    \n

    For example:

    \n

    \n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

    \n

    For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    \n

    For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

    " + } + }, "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary to update. The name is case-sensitive. If you try to update\n a vocabulary with the same name as a previous vocabulary you will receive a\n ConflictException error.

    ", + "smithy.api#documentation": "

    The name of the vocabulary to update. The name is case sensitive. If you try to update\n a vocabulary with the same name\n as\n a vocabulary you've already made, you get a\n ConflictException error.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2605,28 +3189,28 @@ "com.amazonaws.transcribe#UpdateMedicalVocabularyResponse": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "LastModifiedTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The language code for the text file used to update the custom vocabulary. US English\n (en-US) is the only language supported in Amazon Transcribe Medical.

    " + "smithy.api#documentation": "

    The date and time that the vocabulary was updated.

    " } }, - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", + "VocabularyState": { + "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

    The name of the updated vocabulary.

    " + "smithy.api#documentation": "

    The processing state of the update to the vocabulary. When the\n VocabularyState field is READY, the vocabulary is ready to\n be used in a StartMedicalTranscriptionJob request.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.transcribe#DateTime", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The date and time the vocabulary was updated.

    " + "smithy.api#documentation": "

    The language code for the language of the text file used to update the custom\n vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.

    " } }, - "VocabularyState": { - "target": "com.amazonaws.transcribe#VocabularyState", + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    The processing state of the update to the vocabulary. When the\n VocabularyState field is READY the vocabulary is ready to\n be used in a StartMedicalTranscriptionJob request.

    " + "smithy.api#documentation": "

    The name of the updated vocabulary.

    " } } } @@ -2702,40 +3286,40 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary filter to update. If you try to update a vocabulary filter\n with the same name as a previous vocabulary filter you will receive a\n ConflictException error.

    ", + "smithy.api#documentation": "

    The name of the vocabulary filter to update. If you try to update a vocabulary filter\n with the same name as another vocabulary filter, you get a\n ConflictException error.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "VocabularyFilterFileUri": { - "target": "com.amazonaws.transcribe#Uri", - "traits": { - "smithy.api#documentation": "

    The Amazon S3 location of a text file used as input to create the vocabulary filter.\n Only use characters from the character set defined for custom vocabularies. For a list\n of character sets, see Character Sets for Custom\n Vocabularies.

    \n

    The specified file must be less than 50 KB of UTF-8 characters.

    \n

    If you provide the location of a list of words in the\n VocabularyFilterFileUri parameter, you can't use the Words\n parameter.

    " - } - }, "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { "smithy.api#documentation": "

    The words to use in the vocabulary filter. Only use characters from the character set\n defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

    \n

    If you provide a list of words in the Words parameter, you can't use the\n VocabularyFilterFileUri parameter.

    " } + }, + "VocabularyFilterFileUri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

    The Amazon S3 location of a text file used as input to create the vocabulary filter.\n Only use characters from the character set defined for custom vocabularies. For a list\n of character sets, see Character Sets for Custom\n Vocabularies.

    \n

    The specified file must be less than 50 KB of UTF-8 characters.

    \n

    If you provide the location of a list of words in the\n VocabularyFilterFileUri parameter, you can't use the Words\n parameter.

    " + } } } }, "com.amazonaws.transcribe#UpdateVocabularyFilterResponse": { "type": "structure", "members": { - "VocabularyFilterName": { - "target": "com.amazonaws.transcribe#VocabularyFilterName", - "traits": { - "smithy.api#documentation": "

    The name of the updated vocabulary filter.

    " - } - }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { "smithy.api#documentation": "

    The date and time that the vocabulary filter was updated.

    " } }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribe#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "

    The name of the updated vocabulary filter.

    " + } + }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { @@ -2747,10 +3331,12 @@ "com.amazonaws.transcribe#UpdateVocabularyRequest": { "type": "structure", "members": { - "Phrases": { - "target": "com.amazonaws.transcribe#Phrases", + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

    An array of strings containing the vocabulary entries.

    " + "smithy.api#documentation": "

    The name of the vocabulary to update. The name is case sensitive. If you try to update\n a vocabulary with the same name as a previous vocabulary you will receive a\n ConflictException error.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "LanguageCode": { @@ -2760,12 +3346,10 @@ "smithy.api#required": {} } }, - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", + "Phrases": { + "target": "com.amazonaws.transcribe#Phrases", "traits": { - "smithy.api#documentation": "

    The name of the vocabulary to update. The name is case-sensitive. If you try to update\n a vocabulary with the same name as a previous vocabulary you will receive a\n ConflictException error.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of strings containing the vocabulary entries.

    " } }, "VocabularyFileUri": { @@ -2779,10 +3363,10 @@ "com.amazonaws.transcribe#UpdateVocabularyResponse": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.transcribe#LanguageCode", + "LastModifiedTime": { + "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

    The language code of the vocabulary entries.

    " + "smithy.api#documentation": "

    The date and time that the vocabulary was updated.

    " } }, "VocabularyState": { @@ -2791,10 +3375,10 @@ "smithy.api#documentation": "

    The processing state of the vocabulary. When the VocabularyState field\n contains READY the vocabulary is ready to be used in a\n StartTranscriptionJob request.

    " } }, - "LastModifiedTime": { - "target": "com.amazonaws.transcribe#DateTime", + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

    The date and time that the vocabulary was updated.

    " + "smithy.api#documentation": "

    The language code of the vocabulary entries.

    " } }, "VocabularyName": { @@ -2881,12 +3465,6 @@ "com.amazonaws.transcribe#VocabularyInfo": { "type": "structure", "members": { - "VocabularyName": { - "target": "com.amazonaws.transcribe#VocabularyName", - "traits": { - "smithy.api#documentation": "

    The name of the vocabulary.

    " - } - }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { @@ -2904,6 +3482,12 @@ "traits": { "smithy.api#documentation": "

    The date and time that the vocabulary was last modified.

    " } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", + "traits": { + "smithy.api#documentation": "

    The name of the vocabulary.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json index 20edc685633b..3e2a5479bfb8 100644 --- a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json +++ b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json @@ -121,52 +121,52 @@ "com.amazonaws.transfer#CreateServerRequest": { "type": "structure", "members": { - "EndpointDetails": { - "target": "com.amazonaws.transfer#EndpointDetails", + "HostKey": { + "target": "com.amazonaws.transfer#HostKey", "traits": { - "smithy.api#documentation": "

    The virtual private cloud (VPC) endpoint settings that are configured for your file\n transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it\n accessible only to resources within your VPC, or you can attach Elastic IPs and make it\n accessible to clients over the internet. Your VPC's default security groups are\n automatically assigned to your endpoint.

    " + "smithy.api#documentation": "

    The RSA private key as generated by the ssh-keygen -N \"\" -m PEM -f\n my-new-server-key command.

    \n\n \n

    If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.

    \n     \n\n \n\n

    For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer\n Family User Guide.

    " } }, - "Certificate": { - "target": "com.amazonaws.transfer#Certificate", + "Protocols": { + "target": "com.amazonaws.transfer#Protocols", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

    \n\n

    To request a new public certificate, see Request a public certificate\n in the AWS Certificate Manager User Guide.

    \n\n

    To import an existing certificate into ACM, see Importing certificates into ACM\n in the AWS Certificate Manager User Guide.

    \n\n

    To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the AWS Certificate Manager User\n Guide.

    \n\n

    Certificates with the following cryptographic algorithms and key sizes are\n supported:

    \n\n
      \n
    • \n

      2048-bit RSA (RSA_2048)

      \n
      • \n
    • \n

      4096-bit RSA (RSA_4096)

      \n
      • \n
    • \n

      Elliptic Prime Curve 256 bit (EC_prime256v1)

      \n
      • \n
    • \n

      Elliptic Prime Curve 384 bit (EC_secp384r1)

      \n
      • \n
    • \n

      Elliptic Prime Curve 521 bit (EC_secp521r1)

      \n
      • \n
    \n\n \n

    The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.

    \n     " + "smithy.api#documentation": "

    Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

    \n\n
      \n
    • \n

      \n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH

      \n
      • \n
    • \n

      \n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption

      \n
      • \n
    • \n

      \n FTP (File Transfer Protocol): Unencrypted file transfer

      \n
      • \n
    \n\n \n

    If you select FTPS, you must choose a certificate stored in AWS Certificate\n Manager (ACM) which will be used to identify your server when clients connect to it over\n FTPS.

    \n\n

    If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be API_GATEWAY.

    \n\n

    If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

    \n\n

    If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

    \n     " } }, - "Tags": { - "target": "com.amazonaws.transfer#Tags", + "LoggingRole": { + "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

    Key-value pairs that can be used to group and search for file transfer protocol-enabled\n servers.

    " + "smithy.api#documentation": "

    Allows the service to write your users' activity to your Amazon CloudWatch logs for\n monitoring and auditing purposes.

    " } }, - "IdentityProviderType": { - "target": "com.amazonaws.transfer#IdentityProviderType", + "Tags": { + "target": "com.amazonaws.transfer#Tags", "traits": { - "smithy.api#documentation": "

    Specifies the mode of authentication for a file transfer protocol-enabled server. The\n default value is SERVICE_MANAGED, which allows you to store and access user\n credentials within the AWS Transfer Family service. Use the API_GATEWAY value to\n integrate with an identity provider of your choosing. The API_GATEWAY setting\n requires you to provide an API Gateway endpoint URL to call for authentication using the\n IdentityProviderDetails parameter.

    " + "smithy.api#documentation": "

    Key-value pairs that can be used to group and search for servers.

    " } }, - "HostKey": { - "target": "com.amazonaws.transfer#HostKey", + "Certificate": { + "target": "com.amazonaws.transfer#Certificate", "traits": { - "smithy.api#documentation": "

    The RSA private key as generated by the ssh-keygen -N \"\" -m PEM -f\n my-new-server-key command.

    \n\n \n

    If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.

    \n     \n\n \n\n

    For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer\n Family User Guide.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

    \n\n

    To request a new public certificate, see Request a public certificate\n in the AWS Certificate Manager User Guide.

    \n\n

    To import an existing certificate into ACM, see Importing certificates into ACM\n in the AWS Certificate Manager User Guide.

    \n\n

    To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the AWS Certificate Manager User\n Guide.

    \n\n

    Certificates with the following cryptographic algorithms and key sizes are\n supported:

    \n\n
      \n
    • \n

      2048-bit RSA (RSA_2048)

      \n
      • \n
    • \n

      4096-bit RSA (RSA_4096)

      \n
      • \n
    • \n

      Elliptic Prime Curve 256 bit (EC_prime256v1)

      \n
      • \n
    • \n

      Elliptic Prime Curve 384 bit (EC_secp384r1)

      \n
      • \n
    • \n

      Elliptic Prime Curve 521 bit (EC_secp521r1)

      \n
      • \n
    \n\n \n

    The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.

    \n     " } }, - "Protocols": { - "target": "com.amazonaws.transfer#Protocols", + "IdentityProviderType": { + "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

    Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

    \n\n
      \n
    • \n

      \n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH

      \n
      • \n
    • \n

      \n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption

      \n
      • \n
    • \n

      \n FTP (File Transfer Protocol): Unencrypted file transfer

      \n
      • \n
    \n\n \n

    If you select FTPS, you must choose a certificate stored in AWS Certificate\n Manager (ACM) which will be used to identify your server when clients connect to it over\n FTPS.

    \n\n

    If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be API_GATEWAY.

    \n\n

    If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

    \n\n

    If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

    \n     " + "smithy.api#documentation": "

    Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an\n identity provider of your choosing. The API_GATEWAY setting requires you to\n provide an API Gateway endpoint URL to call for authentication using the\n IdentityProviderDetails parameter.

    " } }, - "EndpointType": { - "target": "com.amazonaws.transfer#EndpointType", + "EndpointDetails": { + "target": "com.amazonaws.transfer#EndpointDetails", "traits": { - "smithy.api#documentation": "

    The type of VPC endpoint that you want your file transfer protocol-enabled server to\n connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC\n endpoint, you can restrict access to your server and resources only within your VPC.

    \n\n \n

    It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

    \n     " + "smithy.api#documentation": "

    The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make it accessible only to resources\n within your VPC, or you can attach Elastic IPs and make it accessible to clients over the\n internet. Your VPC's default security groups are automatically assigned to your\n endpoint.

    " } }, - "LoggingRole": { - "target": "com.amazonaws.transfer#Role", + "SecurityPolicyName": { + "target": "com.amazonaws.transfer#SecurityPolicyName", "traits": { - "smithy.api#documentation": "

    Allows the service to write your users' activity to your Amazon CloudWatch logs for\n monitoring and auditing purposes.

    " + "smithy.api#documentation": "

    Specifies the name of the security policy that is attached to the server.

    " } }, "IdentityProviderDetails": { @@ -174,6 +174,12 @@ "traits": { "smithy.api#documentation": "

    Required when IdentityProviderType is set to API_GATEWAY.\n Accepts an array containing all of the information required to call a customer-supplied\n authentication API, including the API Gateway URL. Not required when\n IdentityProviderType is set to SERVICE_MANAGED.

    " } + }, + "EndpointType": { + "target": "com.amazonaws.transfer#EndpointType", + "traits": { + "smithy.api#documentation": "

    The type of VPC endpoint that you want your server to connect to. You can choose to\n connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access\n to your server and resources only within your VPC.

    \n\n \n

    It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

    \n     " + } } } }, @@ -183,7 +189,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    The service-assigned ID of the file transfer protocol-enabled server that is\n created.

    ", + "smithy.api#documentation": "

    The service-assigned ID of the server that is created.

    ", "smithy.api#required": {} } } @@ -221,61 +227,61 @@ "com.amazonaws.transfer#CreateUserRequest": { "type": "structure", "members": { - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "SshPublicKeyBody": { + "target": "com.amazonaws.transfer#SshPublicKeyBody", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server instance.\n This is the specific server that you added your user to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.

    " } }, - "UserName": { - "target": "com.amazonaws.transfer#UserName", + "HomeDirectory": { + "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

    A unique string that identifies a user and is associated with a file transfer\n protocol-enabled server as specified by the ServerId. This user name must be a\n minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z,\n A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The landing directory (folder) for a user when they log in to the server using the\n client.

    \n\n

    An example is\n \n your-Amazon-S3-bucket-name>/home/username\n .

    " } }, - "Tags": { - "target": "com.amazonaws.transfer#Tags", + "HomeDirectoryMappings": { + "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

    Key-value pairs that can be used to group and search for users. Tags are metadata attached\n to users for any purpose.

    " + "smithy.api#documentation": "

    Logical directory mappings that specify what Amazon S3 paths and keys should be visible to\n your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your IAM role\n provides access to paths in Target. The following is an example.

    \n\n

    \n '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'\n

    \n\n

    In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set Entry\n to '/' and set Target to the HomeDirectory parameter value.

    \n\n \n

    If the target of a logical directory entry does not exist in Amazon S3, the entry will\n be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api call instead of\n s3 so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a '/' for it to be considered a\n folder.

    \n     " } }, - "Role": { - "target": "com.amazonaws.transfer#Role", + "HomeDirectoryType": { + "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

    The IAM role that controls your users' access to your Amazon S3 bucket. The policies\n attached to this role will determine the level of access you want to provide your users when\n transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also\n contain a trust relationship that allows the file transfer protocol-enabled server to access\n your resources when servicing your users' transfer requests.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The type of landing directory (folder) you want your users' home directory to be when\n they log into the server. If you set it to PATH, the user will see the absolute\n Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it\n LOGICAL, you will need to provide mappings in the\n HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your\n users.

    " } }, - "Policy": { - "target": "com.amazonaws.transfer#Policy", + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A scope-down policy for your user so you can use the same IAM role across multiple users.\n This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you\n can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    \n\n \n

    For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.

    \n\n \n\n

    For an example of a scope-down policy, see Creating a scope-down\n policy.

    \n\n \n\n

    For more information, see AssumeRole in the AWS\n Security Token Service API Reference.

    \n     " + "smithy.api#documentation": "

    A system-assigned unique identifier for a server instance. This is the specific server\n that you added your user to.

    ", + "smithy.api#required": {} } }, - "SshPublicKeyBody": { - "target": "com.amazonaws.transfer#SshPublicKeyBody", + "UserName": { + "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    The public portion of the Secure Shell (SSH) key used to authenticate the user to the file\n transfer protocol-enabled server.

    " + "smithy.api#documentation": "

    A unique string that identifies a user and is associated with a as specified by the\n ServerId. This user name must be a minimum of 3 and a maximum of 100 characters\n long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen\n '-', period '.', and at sign '@'. The user name can't start\n with a hyphen, period, or at sign.

    ", + "smithy.api#required": {} } }, - "HomeDirectoryMappings": { - "target": "com.amazonaws.transfer#HomeDirectoryMappings", + "Policy": { + "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

    Logical directory mappings that specify what Amazon S3 paths and keys should be visible to\n your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your IAM role\n provides access to paths in Target. The following is an example.

    \n\n

    \n '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'\n

    \n\n

    In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set Entry\n to '/' and set Target to the HomeDirectory parameter value.

    \n\n \n

    If the target of a logical directory entry does not exist in Amazon S3, the entry will\n be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api call instead of\n s3 so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a '/' for it to be considered a folder.

    \n     " + "smithy.api#documentation": "

    A scope-down policy for your user so you can use the same IAM role across multiple users.\n This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you\n can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    \n\n \n

    For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.

    \n\n \n\n

    For an example of a scope-down policy, see Creating a scope-down\n policy.

    \n\n \n\n

    For more information, see AssumeRole in the AWS\n Security Token Service API Reference.

    \n     " } }, - "HomeDirectory": { - "target": "com.amazonaws.transfer#HomeDirectory", + "Role": { + "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

    The landing directory (folder) for a user when they log in to the file transfer\n protocol-enabled server using the client.

    \n\n

    An example is\n \n your-Amazon-S3-bucket-name>/home/username\n .

    " + "smithy.api#documentation": "

    The IAM role that controls your users' access to your Amazon S3 bucket. The policies\n attached to this role will determine the level of access you want to provide your users when\n transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also\n contain a trust relationship that allows the server to access your resources when servicing\n your users' transfer requests.

    ", + "smithy.api#required": {} } }, - "HomeDirectoryType": { - "target": "com.amazonaws.transfer#HomeDirectoryType", + "Tags": { + "target": "com.amazonaws.transfer#Tags", "traits": { - "smithy.api#documentation": "

    The type of landing directory (folder) you want your users' home directory to be when\n they log into the file transfer protocol-enabled server. If you set it to PATH,\n the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol\n clients. If you set it LOGICAL, you will need to provide mappings in the\n HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your\n users.

    " + "smithy.api#documentation": "

    Key-value pairs that can be used to group and search for users. Tags are metadata attached\n to users for any purpose.

    " } } } @@ -286,14 +292,14 @@ "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    A unique string that identifies a user account associated with a file transfer\n protocol-enabled server.

    ", + "smithy.api#documentation": "

    A unique string that identifies a user account associated with a server.

    ", "smithy.api#required": {} } }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    The ID of the file transfer protocol-enabled server that the user is attached to.

    ", + "smithy.api#documentation": "

    The ID of the server that the user is attached to.

    ", "smithy.api#required": {} } } @@ -334,7 +340,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A unique system-assigned identifier for a file transfer protocol-enabled server\n instance.

    ", + "smithy.api#documentation": "

    A unique system-assigned identifier for a server instance.

    ", "smithy.api#required": {} } } @@ -369,17 +375,17 @@ "com.amazonaws.transfer#DeleteSshPublicKeyRequest": { "type": "structure", "members": { - "SshPublicKeyId": { - "target": "com.amazonaws.transfer#SshPublicKeyId", + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A unique identifier used to reference your user's specific SSH key.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server instance\n that has the user assigned to it.

    ", "smithy.api#required": {} } }, - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "SshPublicKeyId": { + "target": "com.amazonaws.transfer#SshPublicKeyId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server instance\n that has the user assigned to it.

    ", + "smithy.api#documentation": "

    A unique identifier used to reference your user's specific SSH key.

    ", "smithy.api#required": {} } }, @@ -421,14 +427,64 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server instance\n that has the user assigned to it.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server instance that has the user assigned to\n it.

    ", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    A unique string that identifies a user that is being deleted from a file transfer\n protocol-enabled server.

    ", + "smithy.api#documentation": "

    A unique string that identifies a user that is being deleted from a server.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeSecurityPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#DescribeSecurityPolicyRequest" + }, + "output": { + "target": "com.amazonaws.transfer#DescribeSecurityPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the security policy that is attached to your file transfer protocol-enabled\n server. The response contains a description of the security policy's properties. For more\n information about security policies, see Working with security\n policies.

    " + } + }, + "com.amazonaws.transfer#DescribeSecurityPolicyRequest": { + "type": "structure", + "members": { + "SecurityPolicyName": { + "target": "com.amazonaws.transfer#SecurityPolicyName", + "traits": { + "smithy.api#documentation": "

    Specifies the name of the security policy that is attached to the server.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transfer#DescribeSecurityPolicyResponse": { + "type": "structure", + "members": { + "SecurityPolicy": { + "target": "com.amazonaws.transfer#DescribedSecurityPolicy", + "traits": { + "smithy.api#documentation": "

    An array containing the properties of the security policy.

    ", "smithy.api#required": {} } } @@ -466,7 +522,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server.

    ", "smithy.api#required": {} } } @@ -478,7 +534,7 @@ "Server": { "target": "com.amazonaws.transfer#DescribedServer", "traits": { - "smithy.api#documentation": "

    An array containing the properties of a file transfer protocol-enabled server with the\n ServerID you specified.

    ", + "smithy.api#documentation": "

    An array containing the properties of a server with the ServerID you\n specified.

    ", "smithy.api#required": {} } } @@ -516,14 +572,14 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server that has\n this user assigned.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server that has this user assigned.

    ", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    The name of the user assigned to one or more file transfer protocol-enabled servers. User\n names are part of the sign-in credentials to use the AWS Transfer Family service and perform\n file transfer tasks.

    ", + "smithy.api#documentation": "

    The name of the user assigned to one or more servers. User names are part of the sign-in\n credentials to use the AWS Transfer Family service and perform file transfer tasks.

    ", "smithy.api#required": {} } } @@ -532,66 +588,105 @@ "com.amazonaws.transfer#DescribeUserResponse": { "type": "structure", "members": { - "User": { - "target": "com.amazonaws.transfer#DescribedUser", + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    An array containing the properties of the user account for the ServerID value\n that you specified.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server that has this user assigned.

    ", "smithy.api#required": {} } }, - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "User": { + "target": "com.amazonaws.transfer#DescribedUser", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server that has\n this user assigned.

    ", + "smithy.api#documentation": "

    An array containing the properties of the user account for the ServerID value\n that you specified.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.transfer#DescribedServer": { + "com.amazonaws.transfer#DescribedSecurityPolicy": { "type": "structure", "members": { - "EndpointType": { - "target": "com.amazonaws.transfer#EndpointType", + "Fips": { + "target": "com.amazonaws.transfer#Fips", "traits": { - "smithy.api#documentation": "

    Defines the type of endpoint that your file transfer protocol-enabled server is connected\n to. If your server is connected to a VPC endpoint, your server isn't accessible over the\n public internet.

    " + "smithy.api#documentation": "

    Specifies whether this policy enables Federal Information Processing Standards\n (FIPS).

    " } }, - "Arn": { - "target": "com.amazonaws.transfer#Arn", + "SecurityPolicyName": { + "target": "com.amazonaws.transfer#SecurityPolicyName", "traits": { - "smithy.api#documentation": "

    Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled\n server to be described.

    ", + "smithy.api#documentation": "

    Specifies the name of the security policy that is attached to the server.

    ", "smithy.api#required": {} } }, - "IdentityProviderDetails": { - "target": "com.amazonaws.transfer#IdentityProviderDetails", + "TlsCiphers": { + "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

    Specifies information to call a customer-supplied authentication API. This field is not\n populated when the IdentityProviderType of a file transfer protocol-enabled\n server is SERVICE_MANAGED.

    " + "smithy.api#documentation": "

    Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the\n security policy that is attached to the server.

    " } }, - "LoggingRole": { - "target": "com.amazonaws.transfer#Role", + "SshMacs": { + "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

    Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer\n protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set,\n user activity can be viewed in your CloudWatch logs.

    " + "smithy.api#documentation": "

    Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the\n security policy that is attached to the server.

    " } }, - "Tags": { - "target": "com.amazonaws.transfer#Tags", + "SshCiphers": { + "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

    Specifies the key-value pairs that you can use to search for and group file transfer\n protocol-enabled servers that were assigned to the server that was described.

    " + "smithy.api#documentation": "

    Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security\n policy that is attached to the server.

    " } }, - "UserCount": { - "target": "com.amazonaws.transfer#UserCount", + "SshKexs": { + "target": "com.amazonaws.transfer#SecurityPolicyOptions", "traits": { - "smithy.api#documentation": "

    Specifies the number of users that are assigned to a file transfer protocol-enabled server\n you specified with the ServerId.

    " + "smithy.api#documentation": "

    Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy\n that is attached to the server.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the properties of a security policy that was specified. For more information\n about security policies, see Working with security\n policies.

    " + } + }, + "com.amazonaws.transfer#DescribedServer": { + "type": "structure", + "members": { + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", + "traits": { + "smithy.api#documentation": "

    Specifies the unique system-assigned identifier for a server that you instantiate.

    " + } + }, + "EndpointType": { + "target": "com.amazonaws.transfer#EndpointType", + "traits": { + "smithy.api#documentation": "

    Defines the type of endpoint that your server is connected to. If your server is connected\n to a VPC endpoint, your server isn't accessible over the public internet.

    " + } + }, + "SecurityPolicyName": { + "target": "com.amazonaws.transfer#SecurityPolicyName", + "traits": { + "smithy.api#documentation": "

    Specifies the name of the security policy that is attached to the server.

    " + } + }, + "State": { + "target": "com.amazonaws.transfer#State", + "traits": { + "smithy.api#documentation": "

    Specifies the condition of a server for the server that was described. A value of\n ONLINE indicates that the server can accept jobs and transfer files. A\n State value of OFFLINE means that the server cannot perform file\n transfer operations.

    \n\n

    The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.

    " + } + }, + "Arn": { + "target": "com.amazonaws.transfer#Arn", + "traits": { + "smithy.api#documentation": "

    Specifies the unique Amazon Resource Name (ARN) of the server.

    ", + "smithy.api#required": {} } }, "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

    Specifies the mode of authentication method enabled for this service. A value of\n SERVICE_MANAGED means that you are using this file transfer protocol-enabled\n server to store and access user credentials within the service. A value of\n API_GATEWAY indicates that you have integrated an API Gateway endpoint that\n will be invoked for authenticating your user into the service.

    " + "smithy.api#documentation": "

    Specifies the mode of authentication method enabled for this service. A value of\n SERVICE_MANAGED means that you are using this server to store and access user\n credentials within the service. A value of API_GATEWAY indicates that you have\n integrated an API Gateway endpoint that will be invoked for authenticating your user into the\n service.

    " } }, "Certificate": { @@ -600,16 +695,28 @@ "smithy.api#documentation": "

    Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when\n Protocols is set to FTPS.

    " } }, - "EndpointDetails": { - "target": "com.amazonaws.transfer#EndpointDetails", + "Tags": { + "target": "com.amazonaws.transfer#Tags", "traits": { - "smithy.api#documentation": "

    Specifies the virtual private cloud (VPC) endpoint settings that you configured for your\n file transfer protocol-enabled server.

    " + "smithy.api#documentation": "

    Specifies the key-value pairs that you can use to search for and group servers that were\n assigned to the server that was described.

    " } }, - "State": { - "target": "com.amazonaws.transfer#State", + "LoggingRole": { + "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

    Specifies the condition of a file transfer protocol-enabled server for the server that was\n described. A value of ONLINE indicates that the server can accept jobs and\n transfer files. A State value of OFFLINE means that the server\n cannot perform file transfer operations.

    \n\n

    The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.

    " + "smithy.api#documentation": "

    Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in\n your CloudWatch logs.

    " + } + }, + "Protocols": { + "target": "com.amazonaws.transfer#Protocols", + "traits": { + "smithy.api#documentation": "

    Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

    \n\n
      \n
    • \n

      \n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH

      \n
      • \n
    • \n

      \n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption

      \n
      • \n
    • \n

      \n FTP (File Transfer Protocol): Unencrypted file transfer

      \n
      • \n
    " + } + }, + "UserCount": { + "target": "com.amazonaws.transfer#UserCount", + "traits": { + "smithy.api#documentation": "

    Specifies the number of users that are assigned to a server you specified with the\n ServerId.

    " } }, "HostKeyFingerprint": { @@ -618,111 +725,117 @@ "smithy.api#documentation": "

    Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value\n is equivalent to the output of the ssh-keygen -l -f my-new-server-key\n command.

    " } }, - "Protocols": { - "target": "com.amazonaws.transfer#Protocols", + "IdentityProviderDetails": { + "target": "com.amazonaws.transfer#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "

    Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

    \n\n
      \n
    • \n

      \n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH

      \n
      • \n
    • \n

      \n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption

      \n
      • \n
    • \n

      \n FTP (File Transfer Protocol): Unencrypted file transfer

      \n
      • \n
    " + "smithy.api#documentation": "

    Specifies information to call a customer-supplied authentication API. This field is not\n populated when the IdentityProviderType of a server is\n SERVICE_MANAGED.

    " } }, - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "EndpointDetails": { + "target": "com.amazonaws.transfer#EndpointDetails", "traits": { - "smithy.api#documentation": "

    Specifies the unique system-assigned identifier for a file transfer protocol-enabled\n server that you instantiate.

    " + "smithy.api#documentation": "

    Specifies the virtual private cloud (VPC) endpoint settings that you configured for your\n server.

    " } } }, "traits": { - "smithy.api#documentation": "

    Describes the properties of a file transfer protocol-enabled server that was specified.\n Information returned includes the following: the server Amazon Resource Name (ARN), the\n certificate ARN (if the FTPS protocol was selected), the endpoint type and details, the\n authentication configuration and type, the logging role, the file transfer protocol or\n protocols, the server ID and state, and assigned tags or metadata.

    " + "smithy.api#documentation": "

    Describes the properties of a file transfer protocol-enabled server that was\n specified.

    " } }, "com.amazonaws.transfer#DescribedUser": { "type": "structure", "members": { - "HomeDirectoryMappings": { - "target": "com.amazonaws.transfer#HomeDirectoryMappings", + "SshPublicKeys": { + "target": "com.amazonaws.transfer#SshPublicKeys", "traits": { - "smithy.api#documentation": "

    Specifies the logical directory mappings that specify what Amazon S3 paths and keys should\n be visible to your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your AWS Identity\n and Access Management (IAM) role provides access to paths in Target.

    \n\n

    In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set Entry\n to '/' and set Target to the HomeDirectory parameter value.

    " + "smithy.api#documentation": "

    Specifies the public key portion of the Secure Shell (SSH) keys stored for the described\n user.

    " } }, - "HomeDirectoryType": { - "target": "com.amazonaws.transfer#HomeDirectoryType", + "HomeDirectory": { + "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

    Specifies the type of landing directory (folder) you mapped for your users to see when\n they log into the file transfer protocol-enabled server. If you set it to PATH,\n the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol\n clients. If you set it LOGICAL, you will need to provide mappings in the\n HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your\n users.

    " + "smithy.api#documentation": "

    Specifies the landing directory (or folder), which is the location that files are written\n to or read from in an Amazon S3 bucket, for the described user. An example is\n \n your-Amazon-S3-bucket-name>/home/username\n .

    " } }, - "Policy": { - "target": "com.amazonaws.transfer#Policy", + "Tags": { + "target": "com.amazonaws.transfer#Tags", "traits": { - "smithy.api#documentation": "

    Specifies the name of the policy in use for the described user.

    " + "smithy.api#documentation": "

    Specifies the key-value pairs for the user requested. Tag can be used to search for and\n group users for a variety of purposes.

    " } }, - "SshPublicKeys": { - "target": "com.amazonaws.transfer#SshPublicKeys", + "HomeDirectoryType": { + "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

    Specifies the public key portion of the Secure Shell (SSH) keys stored for the described\n user.

    " + "smithy.api#documentation": "

    Specifies the type of landing directory (folder) you mapped for your users to see when\n they log into the file transfer protocol-enabled server. If you set it to PATH,\n the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol\n clients. If you set it LOGICAL, you will need to provide mappings in the\n HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your\n users.

    " } }, - "HomeDirectory": { - "target": "com.amazonaws.transfer#HomeDirectory", + "Policy": { + "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

    Specifies the landing directory (or folder), which is the location that files are written\n to or read from in an Amazon S3 bucket, for the described user. An example is\n \n your-Amazon-S3-bucket-name>/home/username\n .

    " + "smithy.api#documentation": "

    Specifies the name of the policy in use for the described user.

    " } }, - "UserName": { - "target": "com.amazonaws.transfer#UserName", + "Arn": { + "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

    Specifies the name of the user that was requested to be described. User names are used for\n authentication purposes. This is the string that will be used by your user when they log in to\n your file transfer protocol-enabled server.

    " + "smithy.api#documentation": "

    Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be\n described.

    ", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.transfer#Tags", + "HomeDirectoryMappings": { + "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

    Specifies the key-value pairs for the user requested. Tag can be used to search for and\n group users for a variety of purposes.

    " + "smithy.api#documentation": "

    Specifies the logical directory mappings that specify what Amazon S3 paths and keys should\n be visible to your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your AWS Identity\n and Access Management (IAM) role provides access to paths in Target.

    \n\n

    In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set Entry\n to '/' and set Target to the HomeDirectory parameter value.

    " } }, "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

    Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The\n policies attached to this role will determine the level of access you want to provide your\n users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role\n should also contain a trust relationship that allows a file transfer protocol-enabled server\n to access your resources when servicing your users' transfer requests.

    " + "smithy.api#documentation": "

    Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The\n policies attached to this role will determine the level of access you want to provide your\n users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role\n should also contain a trust relationship that allows a server to access your resources when\n servicing your users' transfer requests.

    " } }, - "Arn": { - "target": "com.amazonaws.transfer#Arn", + "UserName": { + "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be\n described.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the name of the user that was requested to be described. User names are used for\n authentication purposes. This is the string that will be used by your user when they log in to\n your server.

    " } } }, "traits": { - "smithy.api#documentation": "

    Returns properties of the user that you want to describe.

    " + "smithy.api#documentation": "

    Describes the properties of a user that was specified.

    " } }, "com.amazonaws.transfer#EndpointDetails": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.transfer#SubnetIds", + "AddressAllocationIds": { + "target": "com.amazonaws.transfer#AddressAllocationIds", "traits": { - "smithy.api#documentation": "

    A list of subnet IDs that are required to host your file transfer protocol-enabled server\n endpoint in your VPC.

    \n\n \n

    This property can only be used when EndpointType is set to\n VPC.

    \n     " + "smithy.api#documentation": "

    A list of address allocation IDs that are required to attach an Elastic IP address to your\n server's endpoint.

    \n\n \n\n

    This property can only be set when EndpointType is set to VPC\n and it is only valid in the UpdateServer API.

    \n     " } }, "VpcEndpointId": { "target": "com.amazonaws.transfer#VpcEndpointId", "traits": { - "smithy.api#documentation": "

    The ID of the VPC endpoint.

    \n\n \n

    This property can only be used when EndpointType is set to\n VPC_ENDPOINT.

    \n     " + "smithy.api#documentation": "

    The ID of the VPC endpoint.

    \n\n \n

    This property can only be set when EndpointType is set to\n VPC_ENDPOINT.

    \n     " } }, - "AddressAllocationIds": { - "target": "com.amazonaws.transfer#AddressAllocationIds", + "VpcId": { + "target": "com.amazonaws.transfer#VpcId", "traits": { - "smithy.api#documentation": "

    A list of address allocation IDs that are required to attach an Elastic IP address to your\n file transfer protocol-enabled server's endpoint. This is only valid in the\n UpdateServer API.

    \n\n \n

    This property can only be use when EndpointType is set to\n VPC.

    \n     " + "smithy.api#documentation": "

    The VPC ID of the VPC in which a server's endpoint will be hosted.

    \n\n \n

    This property can only be set when EndpointType is set to\n VPC.

    \n     " } }, - "VpcId": { - "target": "com.amazonaws.transfer#VpcId", + "SecurityGroupIds": { + "target": "com.amazonaws.transfer#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

    The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint\n will be hosted.

    \n\n \n

    This property can only be used when EndpointType is set to\n VPC.

    \n     " + "smithy.api#documentation": "

    A list of security groups IDs that are available to attach to your server's\n endpoint.

    \n\n \n

    This property can only be set when EndpointType is set to\n VPC.

    \n\n

    You can only edit the SecurityGroupIds property in the\n UpdateServer API and only if you are changing the EndpointType\n from PUBLIC or VPC_ENDPOINT to VPC.

    \n     " + } + }, + "SubnetIds": { + "target": "com.amazonaws.transfer#SubnetIds", + "traits": { + "smithy.api#documentation": "

    A list of subnet IDs that are required to host your server endpoint in your VPC.

    \n\n \n

    This property can only be set when EndpointType is set to\n VPC.

    \n     " } } }, @@ -749,6 +862,12 @@ ] } }, + "com.amazonaws.transfer#Fips": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.transfer#HomeDirectory": { "type": "string", "traits": { @@ -762,23 +881,23 @@ "com.amazonaws.transfer#HomeDirectoryMapEntry": { "type": "structure", "members": { - "Target": { - "target": "com.amazonaws.transfer#MapTarget", + "Entry": { + "target": "com.amazonaws.transfer#MapEntry", "traits": { - "smithy.api#documentation": "

    Represents the map target that is used in a HomeDirectorymapEntry.

    ", + "smithy.api#documentation": "

    Represents an entry and a target for HomeDirectoryMappings.

    ", "smithy.api#required": {} } }, - "Entry": { - "target": "com.amazonaws.transfer#MapEntry", + "Target": { + "target": "com.amazonaws.transfer#MapTarget", "traits": { - "smithy.api#documentation": "

    Represents an entry and a target for HomeDirectoryMappings.

    ", + "smithy.api#documentation": "

    Represents the map target that is used in a HomeDirectorymapEntry.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Represents an object that contains entries and a targets for\n HomeDirectoryMappings.

    " + "smithy.api#documentation": "

    Represents an object that contains entries and targets for\n HomeDirectoryMappings.

    " } }, "com.amazonaws.transfer#HomeDirectoryMappings": { @@ -892,24 +1011,24 @@ "com.amazonaws.transfer#ImportSshPublicKeyRequest": { "type": "structure", "members": { - "SshPublicKeyBody": { - "target": "com.amazonaws.transfer#SshPublicKeyBody", - "traits": { - "smithy.api#documentation": "

    The public key portion of an SSH key pair.

    ", - "smithy.api#required": {} - } - }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server.

    ", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    The name of the user account that is assigned to one or more file transfer\n protocol-enabled servers.

    ", + "smithy.api#documentation": "

    The name of the user account that is assigned to one or more servers.

    ", + "smithy.api#required": {} + } + }, + "SshPublicKeyBody": { + "target": "com.amazonaws.transfer#SshPublicKeyBody", + "traits": { + "smithy.api#documentation": "

    The public key portion of an SSH key pair.

    ", "smithy.api#required": {} } } @@ -918,17 +1037,10 @@ "com.amazonaws.transfer#ImportSshPublicKeyResponse": { "type": "structure", "members": { - "SshPublicKeyId": { - "target": "com.amazonaws.transfer#SshPublicKeyId", - "traits": { - "smithy.api#documentation": "

    The name given to a public key by the system that was imported.

    ", - "smithy.api#required": {} - } - }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server.

    ", "smithy.api#required": {} } }, @@ -938,10 +1050,17 @@ "smithy.api#documentation": "

    A user name assigned to the ServerID value that you specified.

    ", "smithy.api#required": {} } + }, + "SshPublicKeyId": { + "target": "com.amazonaws.transfer#SshPublicKeyId", + "traits": { + "smithy.api#documentation": "

    The name given to a public key by the system that was imported.

    ", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "

    Identifies the user, the file transfer protocol-enabled server they belong to, and the\n identifier of the SSH public key associated with that user. A user can have more than one key\n on each server that they are associated with.

    " + "smithy.api#documentation": "

    Identifies the user, the server they belong to, and the identifier of the SSH public key\n associated with that user. A user can have more than one key on each server that they are\n associated with.

    " } }, "com.amazonaws.transfer#InternalServiceError": { @@ -992,6 +1111,72 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.transfer#ListSecurityPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#ListSecurityPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.transfer#ListSecurityPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the security policies that are attached to your file transfer protocol-enabled\n servers.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transfer#ListSecurityPoliciesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "

    When additional results are obtained from the ListSecurityPolicies command, a\n NextToken parameter is returned in the output. You can then pass the\n NextToken parameter in a subsequent command to continue listing additional\n security policies.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.transfer#MaxResults", + "traits": { + "smithy.api#documentation": "

    Specifies the number of security policies to return as a response to the\n ListSecurityPolicies query.

    " + } + } + } + }, + "com.amazonaws.transfer#ListSecurityPoliciesResponse": { + "type": "structure", + "members": { + "SecurityPolicyNames": { + "target": "com.amazonaws.transfer#SecurityPolicyNames", + "traits": { + "smithy.api#documentation": "

    An array of security policies that were listed.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "

    When you can get additional results from the ListSecurityPolicies operation,\n a NextToken parameter is returned in the output. In a following command, you can\n pass in the NextToken parameter to continue listing security policies.

    " + } + } + } + }, "com.amazonaws.transfer#ListServers": { "type": "operation", "input": { @@ -1026,16 +1211,16 @@ "com.amazonaws.transfer#ListServersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.transfer#NextToken", + "MaxResults": { + "target": "com.amazonaws.transfer#MaxResults", "traits": { - "smithy.api#documentation": "

    When additional results are obtained from theListServers command, a\n NextToken parameter is returned in the output. You can then pass the\n NextToken parameter in a subsequent command to continue listing additional file\n transfer protocol-enabled servers.

    " + "smithy.api#documentation": "

    Specifies the number of servers to return as a response to the ListServers\n query.

    " } }, - "MaxResults": { - "target": "com.amazonaws.transfer#MaxResults", + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

    Specifies the number of file transfer protocol-enabled servers to return as a response to\n the ListServers query.

    " + "smithy.api#documentation": "

    When additional results are obtained from the ListServers command, a\n NextToken parameter is returned in the output. You can then pass the\n NextToken parameter in a subsequent command to continue listing additional\n servers.

    " } } } @@ -1046,14 +1231,14 @@ "Servers": { "target": "com.amazonaws.transfer#ListedServers", "traits": { - "smithy.api#documentation": "

    An array of file transfer protocol-enabled servers that were listed.

    ", + "smithy.api#documentation": "

    An array of servers that were listed.

    ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

    When you can get additional results from the ListServers operation, a\n NextToken parameter is returned in the output. In a following command, you can\n pass in the NextToken parameter to continue listing additional file transfer\n protocol-enabled servers.

    " + "smithy.api#documentation": "

    When you can get additional results from the ListServers operation, a\n NextToken parameter is returned in the output. In a following command, you can\n pass in the NextToken parameter to continue listing additional servers.

    " } } } @@ -1092,12 +1277,6 @@ "com.amazonaws.transfer#ListTagsForResourceRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.transfer#MaxResults", - "traits": { - "smithy.api#documentation": "

    Specifies the number of tags to return as a response to the\n ListTagsForResource request.

    " - } - }, "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { @@ -1110,16 +1289,22 @@ "traits": { "smithy.api#documentation": "

    When you request additional results from the ListTagsForResource operation, a\n NextToken parameter is returned in the input. You can then pass in a subsequent\n command to the NextToken parameter to continue listing additional tags.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.transfer#MaxResults", + "traits": { + "smithy.api#documentation": "

    Specifies the number of tags to return as a response to the\n ListTagsForResource request.

    " + } } } }, "com.amazonaws.transfer#ListTagsForResourceResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.transfer#NextToken", + "Arn": { + "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

    When you can get additional results from the ListTagsForResource call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n tags.

    " + "smithy.api#documentation": "

    The ARN you specified to list the tags of.

    " } }, "Tags": { @@ -1128,10 +1313,10 @@ "smithy.api#documentation": "

    Key-value pairs that are assigned to a resource, usually for the purpose of grouping and\n searching for items. Tags are metadata that you define.

    " } }, - "Arn": { - "target": "com.amazonaws.transfer#Arn", + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", "traits": { - "smithy.api#documentation": "

    The ARN you specified to list the tags of.

    " + "smithy.api#documentation": "

    When you can get additional results from the ListTagsForResource call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n tags.

    " } } } @@ -1173,6 +1358,13 @@ "com.amazonaws.transfer#ListUsersRequest": { "type": "structure", "members": { + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", + "traits": { + "smithy.api#documentation": "

    A system-assigned unique identifier for a server that has users assigned to it.

    ", + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.transfer#MaxResults", "traits": { @@ -1184,30 +1376,16 @@ "traits": { "smithy.api#documentation": "

    When you can get additional results from the ListUsers call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n users.

    " } - }, - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", - "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server that has\n users assigned to it.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.transfer#ListUsersResponse": { - "type": "structure", - "members": { - "Users": { - "target": "com.amazonaws.transfer#ListedUsers", - "traits": { - "smithy.api#documentation": "

    Returns the user accounts and their properties for the ServerId value that\n you specify.

    ", - "smithy.api#required": {} - } - }, + "type": "structure", + "members": { "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server that the\n users are assigned to.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server that the users are assigned to.

    ", "smithy.api#required": {} } }, @@ -1216,53 +1394,60 @@ "traits": { "smithy.api#documentation": "

    When you can get additional results from the ListUsers call, a\n NextToken parameter is returned in the output. You can then pass in a\n subsequent command to the NextToken parameter to continue listing additional\n users.

    " } + }, + "Users": { + "target": "com.amazonaws.transfer#ListedUsers", + "traits": { + "smithy.api#documentation": "

    Returns the user accounts and their properties for the ServerId value that\n you specify.

    ", + "smithy.api#required": {} + } } } }, "com.amazonaws.transfer#ListedServer": { "type": "structure", "members": { - "UserCount": { - "target": "com.amazonaws.transfer#UserCount", + "Arn": { + "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

    Specifies the number of users that are assigned to a file transfer protocol-enabled server\n you specified with the ServerId.

    " + "smithy.api#documentation": "

    Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

    ", + "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.transfer#State", "traits": { - "smithy.api#documentation": "

    Specifies the condition of a file transfer protocol-enabled server for the server that was\n described. A value of ONLINE indicates that the server can accept jobs and\n transfer files. A State value of OFFLINE means that the server\n cannot perform file transfer operations.

    \n\n

    The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.

    " + "smithy.api#documentation": "

    Specifies the condition of a server for the server that was described. A value of\n ONLINE indicates that the server can accept jobs and transfer files. A\n State value of OFFLINE means that the server cannot perform file\n transfer operations.

    \n\n

    The states of STARTING and STOPPING indicate that the server is\n in an intermediate state, either not fully able to respond, or not fully offline. The values\n of START_FAILED or STOP_FAILED can indicate an error\n condition.

    " } }, "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

    Specifies the type of VPC endpoint that your file transfer protocol-enabled server is\n connected to. If your server is connected to a VPC endpoint, your server isn't accessible\n over the public internet.

    " + "smithy.api#documentation": "

    Specifies the type of VPC endpoint that your server is connected to. If your server is\n connected to a VPC endpoint, your server isn't accessible over the public\n internet.

    " } }, - "LoggingRole": { - "target": "com.amazonaws.transfer#Role", + "IdentityProviderType": { + "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

    Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer\n protocol-enabled server to turn on Amazon CloudWatch logging.

    " + "smithy.api#documentation": "

    Specifies the authentication method used to validate a user for a server that was\n specified. This can include Secure Shell (SSH), user name and password combinations, or your\n own custom authentication method. Valid values include SERVICE_MANAGED or\n API_GATEWAY.

    " } }, - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "UserCount": { + "target": "com.amazonaws.transfer#UserCount", "traits": { - "smithy.api#documentation": "

    Specifies the unique system assigned identifier for a file transfer protocol-enabled\n servers that were listed.

    " + "smithy.api#documentation": "

    Specifies the number of users that are assigned to a server you specified with the\n ServerId.

    " } }, - "IdentityProviderType": { - "target": "com.amazonaws.transfer#IdentityProviderType", + "LoggingRole": { + "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

    Specifies the authentication method used to validate a user for a file transfer\n protocol-enabled server that was specified. This can include Secure Shell (SSH), user name and\n password combinations, or your own custom authentication method. Valid values include\n SERVICE_MANAGED or API_GATEWAY.

    " + "smithy.api#documentation": "

    Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging.

    " } }, - "Arn": { - "target": "com.amazonaws.transfer#Arn", + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled\n server to be listed.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the unique system assigned identifier for the servers that were listed.

    " } } }, @@ -1279,10 +1464,16 @@ "com.amazonaws.transfer#ListedUser": { "type": "structure", "members": { - "HomeDirectoryType": { - "target": "com.amazonaws.transfer#HomeDirectoryType", + "SshPublicKeyCount": { + "target": "com.amazonaws.transfer#SshPublicKeyCount", "traits": { - "smithy.api#documentation": "

    Specifies the type of landing directory (folder) you mapped for your users' home\n directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket\n paths as is in their file transfer protocol clients. If you set it LOGICAL, you\n will need to provide mappings in the HomeDirectoryMappings for how you want to\n make Amazon S3 paths visible to your users.

    " + "smithy.api#documentation": "

    Specifies the number of SSH public keys stored for the user you specified.

    " + } + }, + "HomeDirectory": { + "target": "com.amazonaws.transfer#HomeDirectory", + "traits": { + "smithy.api#documentation": "

    Specifies the location that files are written to or read from an Amazon S3 bucket for the\n user you specify by their ARN.

    " } }, "UserName": { @@ -1297,12 +1488,6 @@ "smithy.api#documentation": "

    Specifies the role that is in use by this user. A role is an AWS\n Identity and Access Management (IAM) entity that, in this case, allows a file transfer\n protocol-enabled server to act on a user's behalf. It allows the server to inherit the\n trust relationship that enables that user to perform file operations to their Amazon S3\n bucket.

    " } }, - "SshPublicKeyCount": { - "target": "com.amazonaws.transfer#SshPublicKeyCount", - "traits": { - "smithy.api#documentation": "

    Specifies the number of SSH public keys stored for the user you specified.

    " - } - }, "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { @@ -1310,10 +1495,10 @@ "smithy.api#required": {} } }, - "HomeDirectory": { - "target": "com.amazonaws.transfer#HomeDirectory", + "HomeDirectoryType": { + "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

    Specifies the location that files are written to or read from an Amazon S3 bucket for the\n user you specify by their ARN.

    " + "smithy.api#documentation": "

    Specifies the type of landing directory (folder) you mapped for your users' home\n directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket\n paths as is in their file transfer protocol clients. If you set it LOGICAL, you\n will need to provide mappings in the HomeDirectoryMappings for how you want to\n make Amazon S3 paths visible to your users.

    " } } }, @@ -1431,14 +1616,14 @@ "smithy.api#required": {} } }, - "ResourceType": { - "target": "com.amazonaws.transfer#ResourceType", + "Message": { + "target": "com.amazonaws.transfer#Message", "traits": { "smithy.api#required": {} } }, - "Message": { - "target": "com.amazonaws.transfer#Message", + "ResourceType": { + "target": "com.amazonaws.transfer#ResourceType", "traits": { "smithy.api#required": {} } @@ -1453,12 +1638,6 @@ "com.amazonaws.transfer#ResourceNotFoundException": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.transfer#Message", - "traits": { - "smithy.api#required": {} - } - }, "Resource": { "target": "com.amazonaws.transfer#Resource", "traits": { @@ -1470,6 +1649,12 @@ "traits": { "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.transfer#Message", + "traits": { + "smithy.api#required": {} + } } }, "traits": { @@ -1497,6 +1682,53 @@ "smithy.api#pattern": "arn:.*role/.*" } }, + "com.amazonaws.transfer#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 20 + }, + "smithy.api#pattern": "^sg-[0-9a-f]{8,17}$" + } + }, + "com.amazonaws.transfer#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#SecurityGroupId" + } + }, + "com.amazonaws.transfer#SecurityPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "TransferSecurityPolicy-.+" + } + }, + "com.amazonaws.transfer#SecurityPolicyNames": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#SecurityPolicyName" + } + }, + "com.amazonaws.transfer#SecurityPolicyOption": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.transfer#SecurityPolicyOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#SecurityPolicyOption" + } + }, "com.amazonaws.transfer#ServerId": { "type": "string", "traits": { @@ -1536,13 +1768,6 @@ "com.amazonaws.transfer#SshPublicKey": { "type": "structure", "members": { - "SshPublicKeyId": { - "target": "com.amazonaws.transfer#SshPublicKeyId", - "traits": { - "smithy.api#documentation": "

    Specifies the SshPublicKeyId parameter contains the identifier of the public\n key.

    ", - "smithy.api#required": {} - } - }, "DateImported": { "target": "com.amazonaws.transfer#DateImported", "traits": { @@ -1556,6 +1781,13 @@ "smithy.api#documentation": "

    Specifies the content of the SSH public key as specified by the\n PublicKeyId.

    ", "smithy.api#required": {} } + }, + "SshPublicKeyId": { + "target": "com.amazonaws.transfer#SshPublicKeyId", + "traits": { + "smithy.api#documentation": "

    Specifies the SshPublicKeyId parameter contains the identifier of the public\n key.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -1632,7 +1864,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server that you\n start.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server that you start.

    ", "smithy.api#required": {} } } @@ -1696,7 +1928,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Changes the state of a file transfer protocol-enabled server from ONLINE to\n OFFLINE. An OFFLINE server cannot accept and process file transfer\n jobs. Information tied to your server, such as server and user properties, are not affected by\n stopping your server. Stopping the server will not reduce or impact your file transfer\n protocol endpoint billing.

    \n\n

    The state of STOPPING indicates that the server is in an intermediate state,\n either not fully able to respond, or not fully offline. The values of STOP_FAILED\n can indicate an error condition.

    \n\n

    No response is returned from this call.

    " + "smithy.api#documentation": "

    Changes the state of a file transfer protocol-enabled server from ONLINE to\n OFFLINE. An OFFLINE server cannot accept and process file transfer\n jobs. Information tied to your server, such as server and user properties, are not affected by\n stopping your server.

    \n\n \n

    Stopping the server will not reduce or impact your file transfer protocol endpoint\n billing; you must delete the server to stop being billed.

    \n     \n\n

    The state of STOPPING indicates that the server is in an intermediate state,\n either not fully able to respond, or not fully offline. The values of STOP_FAILED\n can indicate an error condition.

    \n\n

    No response is returned from this call.

    " } }, "com.amazonaws.transfer#StopServerRequest": { @@ -1705,7 +1937,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server that you\n stopped.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server that you stopped.

    ", "smithy.api#required": {} } } @@ -1789,17 +2021,17 @@ "com.amazonaws.transfer#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.transfer#Tags", + "Arn": { + "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

    Key-value pairs assigned to ARNs that you can use to group and search for resources by\n type. You can attach this metadata to user accounts for any purpose.

    ", + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or\n role.

    ", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.transfer#Arn", + "Tags": { + "target": "com.amazonaws.transfer#Tags", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or\n role.

    ", + "smithy.api#documentation": "

    Key-value pairs assigned to ARNs that you can use to group and search for resources by\n type. You can attach this metadata to user accounts for any purpose.

    ", "smithy.api#required": {} } } @@ -1855,28 +2087,16 @@ "com.amazonaws.transfer#TestIdentityProviderRequest": { "type": "structure", "members": { - "UserPassword": { - "target": "com.amazonaws.transfer#UserPassword", - "traits": { - "smithy.api#documentation": "

    The password of the user account to be tested.

    " - } - }, "SourceIp": { "target": "com.amazonaws.transfer#SourceIp", "traits": { "smithy.api#documentation": "

    The source IP address of the user account to be tested.

    " } }, - "ServerProtocol": { - "target": "com.amazonaws.transfer#Protocol", - "traits": { - "smithy.api#documentation": "

    The type of file transfer protocol to be tested.

    \n\n

    The available protocols are:

    \n\n
      \n
    • \n

      Secure Shell (SSH) File Transfer Protocol (SFTP)

      \n
      • \n
    • \n

      File Transfer Protocol Secure (FTPS)

      \n
      • \n
    • \n

      File Transfer Protocol (FTP)

      \n
      • \n
    " - } - }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned identifier for a specific file transfer protocol-enabled server. That\n server's user authentication method is tested with a user name and password.

    ", + "smithy.api#documentation": "

    A system-assigned identifier for a specific server. That server's user authentication\n method is tested with a user name and password.

    ", "smithy.api#required": {} } }, @@ -1886,24 +2106,24 @@ "smithy.api#documentation": "

    The name of the user account to be tested.

    ", "smithy.api#required": {} } + }, + "ServerProtocol": { + "target": "com.amazonaws.transfer#Protocol", + "traits": { + "smithy.api#documentation": "

    The type of file transfer protocol to be tested.

    \n\n

    The available protocols are:

    \n\n
      \n
    • \n

      Secure Shell (SSH) File Transfer Protocol (SFTP)

      \n
      • \n
    • \n

      File Transfer Protocol Secure (FTPS)

      \n
      • \n
    • \n

      File Transfer Protocol (FTP)

      \n
      • \n
    " + } + }, + "UserPassword": { + "target": "com.amazonaws.transfer#UserPassword", + "traits": { + "smithy.api#documentation": "

    The password of the user account to be tested.

    " + } } } }, "com.amazonaws.transfer#TestIdentityProviderResponse": { "type": "structure", "members": { - "Response": { - "target": "com.amazonaws.transfer#Response", - "traits": { - "smithy.api#documentation": "

    The response that is returned from your API Gateway.

    " - } - }, - "Message": { - "target": "com.amazonaws.transfer#Message", - "traits": { - "smithy.api#documentation": "

    A message that indicates whether the test was successful or not.

    " - } - }, "StatusCode": { "target": "com.amazonaws.transfer#StatusCode", "traits": { @@ -1911,12 +2131,24 @@ "smithy.api#required": {} } }, + "Response": { + "target": "com.amazonaws.transfer#Response", + "traits": { + "smithy.api#documentation": "

    The response that is returned from your API Gateway.

    " + } + }, "Url": { "target": "com.amazonaws.transfer#Url", "traits": { "smithy.api#documentation": "

    The endpoint of the service used to authenticate a user.

    ", "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.transfer#Message", + "traits": { + "smithy.api#documentation": "

    A message that indicates whether the test was successful or not.

    " + } } } }, @@ -1955,6 +2187,9 @@ { "target": "com.amazonaws.transfer#DeleteUser" }, + { + "target": "com.amazonaws.transfer#DescribeSecurityPolicy" + }, { "target": "com.amazonaws.transfer#DescribeServer" }, @@ -1964,6 +2199,9 @@ { "target": "com.amazonaws.transfer#ImportSshPublicKey" }, + { + "target": "com.amazonaws.transfer#ListSecurityPolicies" + }, { "target": "com.amazonaws.transfer#ListServers" }, @@ -2006,7 +2244,7 @@ "name": "transfer" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

    AWS Transfer Family is a fully managed service that enables the transfer of files over the\n the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell\n (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service\n (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer\n Family by integrating with existing authentication systems, and providing DNS routing with\n Amazon Route 53 so nothing changes for your customers and partners, or their applications.\n With your data in Amazon S3, you can use it with AWS services for processing, analytics,\n machine learning, and archiving. Getting started with AWS Transfer Family is easy since there\n is no infrastructure to buy and set up.

    ", + "smithy.api#documentation": "

    AWS Transfer Family is a fully managed service that enables the transfer of files over the\n File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH)\n File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon\n S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by\n integrating with existing authentication systems, and providing DNS routing with Amazon Route\n 53 so nothing changes for your customers and partners, or their applications. With your data\n in Amazon S3, you can use it with AWS services for processing, analytics, machine learning,\n and archiving. Getting started with AWS Transfer Family is easy since there is no\n infrastructure to buy and set up.

    ", "smithy.api#title": "AWS Transfer Family" } }, @@ -2093,47 +2331,53 @@ "com.amazonaws.transfer#UpdateServerRequest": { "type": "structure", "members": { - "EndpointDetails": { - "target": "com.amazonaws.transfer#EndpointDetails", + "LoggingRole": { + "target": "com.amazonaws.transfer#NullableRole", "traits": { - "smithy.api#documentation": "

    The virtual private cloud (VPC) endpoint settings that are configured for your file\n transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server\n to resources only within your VPC. To control incoming internet traffic, you will need to\n associate one or more Elastic IP addresses with your server's endpoint.

    " + "smithy.api#documentation": "

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to\n be logged in Amazon CloudWatch, turning logging on or off.

    " } }, - "EndpointType": { - "target": "com.amazonaws.transfer#EndpointType", + "ServerId": { + "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    The type of endpoint that you want your file transfer protocol-enabled server to connect\n to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint,\n you can restrict access to your server and resources only within your VPC.

    \n\n \n

    It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

    \n     " + "smithy.api#documentation": "

    A system-assigned unique identifier for a server instance that the user account is\n assigned to.

    ", + "smithy.api#required": {} } }, - "IdentityProviderDetails": { - "target": "com.amazonaws.transfer#IdentityProviderDetails", + "HostKey": { + "target": "com.amazonaws.transfer#HostKey", "traits": { - "smithy.api#documentation": "

    An array containing all of the information required to call a customer's\n authentication API method.

    " + "smithy.api#documentation": "

    The RSA private key as generated by ssh-keygen -N \"\" -m PEM -f\n my-new-server-key.

    \n\n \n

    If you aren't planning to migrate existing users from an existing server to a new\n server, don't update the host key. Accidentally changing a server's host key can\n be disruptive.

    \n     \n\n \n\n

    For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer\n Family User Guide.

    " } }, - "ServerId": { - "target": "com.amazonaws.transfer#ServerId", + "Protocols": { + "target": "com.amazonaws.transfer#Protocols", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server instance\n that the user account is assigned to.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

    \n\n
      \n
    • \n

      Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

      \n
      • \n
    • \n

      File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

      \n
      • \n
    • \n

      File Transfer Protocol (FTP): Unencrypted file transfer

      \n
      • \n
    \n\n \n

    If you select FTPS, you must choose a certificate stored in AWS Certificate\n Manager (ACM) which will be used to identify your server when clients connect to it over\n FTPS.

    \n\n

    If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be API_GATEWAY.

    \n\n

    If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

    \n\n

    If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

    \n     " } }, - "LoggingRole": { - "target": "com.amazonaws.transfer#NullableRole", + "IdentityProviderDetails": { + "target": "com.amazonaws.transfer#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to\n be logged in Amazon CloudWatch, turning logging on or off.

    " + "smithy.api#documentation": "

    An array containing all of the information required to call a customer's\n authentication API method.

    " } }, - "HostKey": { - "target": "com.amazonaws.transfer#HostKey", + "SecurityPolicyName": { + "target": "com.amazonaws.transfer#SecurityPolicyName", "traits": { - "smithy.api#documentation": "

    The RSA private key as generated by ssh-keygen -N \"\" -m PEM -f\n my-new-server-key.

    \n\n \n

    If you aren't planning to migrate existing users from an existing file transfer\n protocol-enabled server to a new server, don't update the host key. Accidentally\n changing a server's host key can be disruptive.

    \n     \n\n \n\n

    For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer\n Family User Guide.

    " + "smithy.api#documentation": "

    Specifies the name of the security policy that is attached to the server.

    " } }, - "Protocols": { - "target": "com.amazonaws.transfer#Protocols", + "EndpointType": { + "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

    Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

    \n\n
      \n
    • \n

      Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

      \n
      • \n
    • \n

      File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

      \n
      • \n
    • \n

      File Transfer Protocol (FTP): Unencrypted file transfer

      \n
      • \n
    \n\n \n

    If you select FTPS, you must choose a certificate stored in AWS Certificate\n Manager (ACM) which will be used to identify your server when clients connect to it over\n FTPS.

    \n\n

    If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be API_GATEWAY.

    \n\n

    If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

    \n\n

    If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

    \n     " + "smithy.api#documentation": "

    The type of endpoint that you want your server to connect to. You can choose to connect to\n the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your\n server and resources only within your VPC.

    \n\n \n

    It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

    \n     " + } + }, + "EndpointDetails": { + "target": "com.amazonaws.transfer#EndpointDetails", + "traits": { + "smithy.api#documentation": "

    The virtual private cloud (VPC) endpoint settings that are configured for your server.\n With a VPC endpoint, you can restrict access to your server to resources only within your VPC.\n To control incoming internet traffic, you will need to associate one or more Elastic IP\n addresses with your server's endpoint.

    " } }, "Certificate": { @@ -2150,7 +2394,7 @@ "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server that the\n user account is assigned to.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server that the user account is assigned\n to.

    ", "smithy.api#required": {} } } @@ -2188,48 +2432,48 @@ "com.amazonaws.transfer#UpdateUserRequest": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.transfer#Policy", + "HomeDirectoryType": { + "target": "com.amazonaws.transfer#HomeDirectoryType", "traits": { - "smithy.api#documentation": "

    Allows you to supply a scope-down policy for your user so you can use the same IAM role\n across multiple users. The policy scopes down user access to portions of your Amazon S3\n bucket. Variables you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    \n \n

    For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.

    \n\n \n\n

    For an example of a scope-down policy, see Creating a scope-down\n policy.

    \n\n \n\n

    For more information, see AssumeRole in the AWS\n Security Token Service API Reference.

    \n     " + "smithy.api#documentation": "

    The type of landing directory (folder) you want your users' home directory to be when\n they log into the server. If you set it to PATH, the user will see the absolute\n Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it\n LOGICAL, you will need to provide mappings in the\n HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your\n users.

    " + } + }, + "HomeDirectoryMappings": { + "target": "com.amazonaws.transfer#HomeDirectoryMappings", + "traits": { + "smithy.api#documentation": "

    Logical directory mappings that specify what Amazon S3 paths and keys should be visible to\n your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your IAM role\n provides access to paths in Target. The following is an example.

    \n\n

    \n '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'\n

    \n\n

    In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set Entry\n to '/' and set Target to the HomeDirectory parameter value.

    \n\n \n

    If the target of a logical directory entry does not exist in Amazon S3, the entry will\n be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api call instead of\n s3 so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

    \n     " + } + }, + "HomeDirectory": { + "target": "com.amazonaws.transfer#HomeDirectory", + "traits": { + "smithy.api#documentation": "

    Specifies the landing directory (folder) for a user when they log in to the server using\n their file transfer protocol client.

    \n\n

    An example is your-Amazon-S3-bucket-name>/home/username.

    " } }, "Role": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

    The IAM role that controls your users' access to your Amazon S3 bucket. The policies\n attached to this role will determine the level of access you want to provide your users when\n transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also\n contain a trust relationship that allows the file transfer protocol-enabled server to access\n your resources when servicing your users' transfer requests.

    " + "smithy.api#documentation": "

    The IAM role that controls your users' access to your Amazon S3 bucket. The policies\n attached to this role will determine the level of access you want to provide your users when\n transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also\n contain a trust relationship that allows the server to access your resources when servicing\n your users' transfer requests.

    " } }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server instance\n that the user account is assigned to.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server instance that the user account is\n assigned to.

    ", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    A unique string that identifies a user and is associated with a file transfer\n protocol-enabled server as specified by the ServerId. This is the string that\n will be used by your user when they log in to your server. This user name is a minimum of 3\n and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9,\n underscore, and hyphen. The user name can't start with a hyphen.

    ", + "smithy.api#documentation": "

    A unique string that identifies a user and is associated with a server as specified by the\n ServerId. This user name must be a minimum of 3 and a maximum of 100 characters\n long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen\n '-', period '.', and at sign '@'. The user name can't start\n with a hyphen, period, or at sign.

    ", "smithy.api#required": {} } }, - "HomeDirectoryMappings": { - "target": "com.amazonaws.transfer#HomeDirectoryMappings", - "traits": { - "smithy.api#documentation": "

    Logical directory mappings that specify what Amazon S3 paths and keys should be visible to\n your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your IAM role\n provides access to paths in Target. The following is an example.

    \n\n

    \n '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'\n

    \n\n

    In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set Entry\n to '/' and set Target to the HomeDirectory parameter value.

    \n\n \n

    If the target of a logical directory entry does not exist in Amazon S3, the entry will\n be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api call instead of\n s3 so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

    \n     " - } - }, - "HomeDirectory": { - "target": "com.amazonaws.transfer#HomeDirectory", - "traits": { - "smithy.api#documentation": "

    Specifies the landing directory (folder) for a user when they log in to the file transfer\n protocol-enabled server using their file transfer protocol client.

    \n\n

    An example is your-Amazon-S3-bucket-name>/home/username.

    " - } - }, - "HomeDirectoryType": { - "target": "com.amazonaws.transfer#HomeDirectoryType", + "Policy": { + "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

    The type of landing directory (folder) you want your users' home directory to be when\n they log into the file transfer protocol-enabled server. If you set it to PATH,\n the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol\n clients. If you set it LOGICAL, you will need to provide mappings in the\n HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your\n users.

    " + "smithy.api#documentation": "

    Allows you to supply a scope-down policy for your user so you can use the same IAM role\n across multiple users. The policy scopes down user access to portions of your Amazon S3\n bucket. Variables you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    \n \n

    For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.

    \n\n \n\n

    For an example of a scope-down policy, see Creating a scope-down\n policy.

    \n\n \n\n

    For more information, see AssumeRole in the AWS\n Security Token Service API Reference.

    \n     " } } } @@ -2240,20 +2484,20 @@ "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

    The unique identifier for a user that is assigned to a file transfer protocol-enabled\n server instance that was specified in the request.

    ", + "smithy.api#documentation": "

    The unique identifier for a user that is assigned to a server instance that was specified\n in the request.

    ", "smithy.api#required": {} } }, "ServerId": { "target": "com.amazonaws.transfer#ServerId", "traits": { - "smithy.api#documentation": "

    A system-assigned unique identifier for a file transfer protocol-enabled server instance\n that the user account is assigned to.

    ", + "smithy.api#documentation": "

    A system-assigned unique identifier for a server instance that the user account is\n assigned to.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    \n UpdateUserResponse returns the user name and file transfer protocol-enabled\n server identifier for the request to update a user's properties.

    " + "smithy.api#documentation": "

    \n UpdateUserResponse returns the user name and identifier for the request to\n update a user's properties.

    " } }, "com.amazonaws.transfer#Url": { @@ -2276,9 +2520,9 @@ "traits": { "smithy.api#length": { "min": 3, - "max": 32 + "max": 100 }, - "smithy.api#pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,31}$" + "smithy.api#pattern": "^[\\w][\\w@.-]{2,99}$" } }, "com.amazonaws.transfer#UserPassword": { diff --git a/codegen/sdk-codegen/aws-models/translate.2017-07-01.json b/codegen/sdk-codegen/aws-models/translate.2017-07-01.json index afde12eaa361..d24aa5012d7a 100644 --- a/codegen/sdk-codegen/aws-models/translate.2017-07-01.json +++ b/codegen/sdk-codegen/aws-models/translate.2017-07-01.json @@ -79,17 +79,17 @@ "com.amazonaws.translate#AppliedTerminology": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.translate#ResourceName", - "traits": { - "smithy.api#documentation": "

    The name of the custom terminology applied to the input text by Amazon Translate for the translated\n text response.

    " - } - }, "Terms": { "target": "com.amazonaws.translate#TermList", "traits": { "smithy.api#documentation": "

    The specific terms of the custom terminology applied to the input text by Amazon Translate for the\n translated text response. A maximum of 250 terms will be returned, and the specific terms\n applied will be the first 250 terms in the source text.

    " } + }, + "Name": { + "target": "com.amazonaws.translate#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the custom terminology applied to the input text by Amazon Translate for the translated\n text response.

    " + } } }, "traits": { @@ -141,6 +141,9 @@ { "target": "com.amazonaws.translate#InternalServerException" }, + { + "target": "com.amazonaws.translate#InvalidParameterValueException" + }, { "target": "com.amazonaws.translate#ResourceNotFoundException" }, @@ -223,14 +226,14 @@ "com.amazonaws.translate#DetectedLanguageLowConfidenceException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.translate#String" + }, "DetectedLanguageCode": { "target": "com.amazonaws.translate#LanguageCodeString", "traits": { "smithy.api#documentation": "

    The language code of the auto-detected language from Amazon Comprehend.

    " } - }, - "Message": { - "target": "com.amazonaws.translate#String" } }, "traits": { @@ -311,17 +314,17 @@ "com.amazonaws.translate#GetTerminologyRequest": { "type": "structure", "members": { - "TerminologyDataFormat": { - "target": "com.amazonaws.translate#TerminologyDataFormat", + "Name": { + "target": "com.amazonaws.translate#ResourceName", "traits": { - "smithy.api#documentation": "

    The data format of the custom terminology being retrieved, either CSV or TMX.

    ", + "smithy.api#documentation": "

    The name of the custom terminology being retrieved.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.translate#ResourceName", + "TerminologyDataFormat": { + "target": "com.amazonaws.translate#TerminologyDataFormat", "traits": { - "smithy.api#documentation": "

    The name of the custom terminology being retrieved.

    ", + "smithy.api#documentation": "

    The data format of the custom terminology being retrieved, either CSV or TMX.

    ", "smithy.api#required": {} } } @@ -383,13 +386,6 @@ "com.amazonaws.translate#ImportTerminologyRequest": { "type": "structure", "members": { - "TerminologyData": { - "target": "com.amazonaws.translate#TerminologyData", - "traits": { - "smithy.api#documentation": "

    The terminology data for the custom terminology being imported.

    ", - "smithy.api#required": {} - } - }, "Description": { "target": "com.amazonaws.translate#Description", "traits": { @@ -403,6 +399,13 @@ "smithy.api#required": {} } }, + "TerminologyData": { + "target": "com.amazonaws.translate#TerminologyData", + "traits": { + "smithy.api#documentation": "

    The terminology data for the custom terminology being imported.

    ", + "smithy.api#required": {} + } + }, "EncryptionKey": { "target": "com.amazonaws.translate#EncryptionKey", "traits": { @@ -432,17 +435,17 @@ "com.amazonaws.translate#InputDataConfig": { "type": "structure", "members": { - "S3Uri": { - "target": "com.amazonaws.translate#S3Uri", + "ContentType": { + "target": "com.amazonaws.translate#ContentType", "traits": { - "smithy.api#documentation": "

    The URI of the AWS S3 folder that contains the input file. The folder must be in the\n same Region as the API endpoint you are calling.

    ", + "smithy.api#documentation": "

    Describes the format of the data that you submit to Amazon Translate as input. You can\n specify one of the following multipurpose internet mail extension (MIME) types:

    \n
      \n
    • \n

      \n text/html: The input data consists of one or more HTML files. Amazon\n Translate translates only the text that resides in the html element in each\n file.

      \n
      • \n
    • \n

      \n text/plain: The input data consists of one or more unformatted text\n files. Amazon Translate translates every character in this type of input.

      \n
      • \n
    • \n

      \n application/vnd.openxmlformats-officedocument.wordprocessingml.document:\n The input data consists of one or more Word documents (.docx).

      \n
      • \n
    • \n

      \n application/vnd.openxmlformats-officedocument.presentationml.presentation:\n The input data consists of one or more PowerPoint Presentation files (.pptx).

      \n
      • \n
    • \n

      \n application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The\n input data consists of one or more Excel Workbook files (.xlsx).

      \n
      • \n
    \n \n

    If you structure your input data as HTML, ensure that you set this parameter to\n text/html. By doing so, you cut costs by limiting the translation to the\n contents of the html element in each file. Otherwise, if you set this parameter\n to text/plain, your costs will cover the translation of every character.

    \n     ", "smithy.api#required": {} } }, - "ContentType": { - "target": "com.amazonaws.translate#ContentType", + "S3Uri": { + "target": "com.amazonaws.translate#S3Uri", "traits": { - "smithy.api#documentation": "

    The multipurpose internet mail extension (MIME) type of the input files. Valid values are\n text/plain for plaintext files and text/html for HTML\n files.

    ", + "smithy.api#documentation": "

    The URI of the AWS S3 folder that contains the input file. The folder must be in the\n same Region as the API endpoint you are calling.

    ", "smithy.api#required": {} } } @@ -512,16 +515,16 @@ "com.amazonaws.translate#JobDetails": { "type": "structure", "members": { - "InputDocumentsCount": { + "DocumentsWithErrorsCount": { "target": "com.amazonaws.translate#Integer", "traits": { - "smithy.api#documentation": "

    The number of documents used as input in a translation job.

    " + "smithy.api#documentation": "

    The number of documents that could not be processed during a translation job.

    " } }, - "DocumentsWithErrorsCount": { + "InputDocumentsCount": { "target": "com.amazonaws.translate#Integer", "traits": { - "smithy.api#documentation": "

    The number of documents that could not be processed during a translation job.

    " + "smithy.api#documentation": "

    The number of documents used as input in a translation job.

    " } }, "TranslatedDocumentsCount": { @@ -649,34 +652,34 @@ "com.amazonaws.translate#ListTerminologiesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.translate#MaxResultsInteger", - "traits": { - "smithy.api#documentation": "

    The maximum number of custom terminologies returned per list request.

    " - } - }, "NextToken": { "target": "com.amazonaws.translate#NextToken", "traits": { "smithy.api#documentation": "

    If the result of the request to ListTerminologies was truncated, include the NextToken to\n fetch the next group of custom terminologies.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.translate#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

    The maximum number of custom terminologies returned per list request.

    " + } } } }, "com.amazonaws.translate#ListTerminologiesResponse": { "type": "structure", "members": { - "TerminologyPropertiesList": { - "target": "com.amazonaws.translate#TerminologyPropertiesList", - "traits": { - "smithy.api#documentation": "

    The properties list of the custom terminologies returned on the list request.

    " - } - }, "NextToken": { "target": "com.amazonaws.translate#NextToken", "traits": { "smithy.api#documentation": "

    If the response to the ListTerminologies was truncated, the NextToken fetches the next\n group of custom terminologies.

    " } + }, + "TerminologyPropertiesList": { + "target": "com.amazonaws.translate#TerminologyPropertiesList", + "traits": { + "smithy.api#documentation": "

    The properties list of the custom terminologies returned on the list request.

    " + } } } }, @@ -720,17 +723,17 @@ "smithy.api#documentation": "

    The token to request the next page of results.

    " } }, - "MaxResults": { - "target": "com.amazonaws.translate#MaxResultsInteger", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in each page. The default value is 100.

    " - } - }, "Filter": { "target": "com.amazonaws.translate#TextTranslationJobFilter", "traits": { "smithy.api#documentation": "

    The parameters that specify which batch translation jobs to retrieve. Filters include job\n name, job status, and submission time. You can only set one filter at a time.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.translate#MaxResultsInteger", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return in each page. The default value is 100.

    " + } } } }, @@ -881,12 +884,10 @@ "com.amazonaws.translate#StartTextTranslationJobRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.translate#ClientTokenString", + "JobName": { + "target": "com.amazonaws.translate#JobName", "traits": { - "smithy.api#documentation": "

    The client token of the EC2 instance calling the request. This token is auto-generated\n when using the Amazon Translate SDK. Otherwise, use the DescribeInstances EC2 operation to retreive an instance's client token. For more\n information, see Client\n Tokens in the EC2 User Guide.

    ", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the batch translation job to be performed.

    " } }, "DataAccessRoleArn": { @@ -896,30 +897,32 @@ "smithy.api#required": {} } }, - "InputDataConfig": { - "target": "com.amazonaws.translate#InputDataConfig", + "OutputDataConfig": { + "target": "com.amazonaws.translate#OutputDataConfig", "traits": { - "smithy.api#documentation": "

    Specifies the format and S3 location of the input documents for the translation\n job.

    ", + "smithy.api#documentation": "

    Specifies the S3 folder to which your job output will be saved.\n

    ", "smithy.api#required": {} } }, - "OutputDataConfig": { - "target": "com.amazonaws.translate#OutputDataConfig", + "InputDataConfig": { + "target": "com.amazonaws.translate#InputDataConfig", "traits": { - "smithy.api#documentation": "

    Specifies the S3 folder to which your job output will be saved.\n

    ", + "smithy.api#documentation": "

    Specifies the format and S3 location of the input documents for the translation\n job.

    ", "smithy.api#required": {} } }, - "JobName": { - "target": "com.amazonaws.translate#JobName", + "ClientToken": { + "target": "com.amazonaws.translate#ClientTokenString", "traits": { - "smithy.api#documentation": "

    The name of the batch translation job to be performed.

    " + "smithy.api#documentation": "

    A unique identifier for the request. This token is auto-generated when using the Amazon Translate\n SDK.

    ", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} } }, - "SourceLanguageCode": { - "target": "com.amazonaws.translate#LanguageCodeString", + "TargetLanguageCodes": { + "target": "com.amazonaws.translate#TargetLanguageCodeStringList", "traits": { - "smithy.api#documentation": "

    The language code of the input language. For a list of language codes, see what-is-languages.

    \n

    Amazon Translate does not automatically detect a source language during batch translation\n jobs.

    ", + "smithy.api#documentation": "

    The language code of the output language.

    ", "smithy.api#required": {} } }, @@ -929,10 +932,10 @@ "smithy.api#documentation": "

    The name of the terminology to use in the batch translation job. For a list of available\n terminologies, use the ListTerminologies operation.

    " } }, - "TargetLanguageCodes": { - "target": "com.amazonaws.translate#TargetLanguageCodeStringList", + "SourceLanguageCode": { + "target": "com.amazonaws.translate#LanguageCodeString", "traits": { - "smithy.api#documentation": "

    The language code of the output language.

    ", + "smithy.api#documentation": "

    The language code of the input language. For a list of language codes, see what-is-languages.

    \n

    Amazon Translate does not automatically detect a source language during batch translation\n jobs.

    ", "smithy.api#required": {} } } @@ -950,7 +953,7 @@ "JobStatus": { "target": "com.amazonaws.translate#JobStatus", "traits": { - "smithy.api#documentation": "

    The status of the job. Possible values include:

    \n
      \n
    • \n

      \n SUBMITTED - The job has been received and is queued for\n processing.

      \n
      • \n
    • \n

      \n IN_PROGRESS - Amazon Translate is processing the job.

      \n
      • \n
    • \n

      \n COMPLETED - The job was successfully completed and the output is\n available.

      \n
      • \n
    • \n

      \n COMPLETED_WITH_ERRORS - The job was completed with errors. The errors can\n be analyzed in the job's output.

      \n
      • \n
    • \n

      \n FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.

      \n
      • \n
    • \n

      \n STOP_REQUESTED - The user who started the job has requested that it be\n stopped.

      \n
      • \n
    • \n

      \n STOPPED - The job has been stopped.

      \n
      • \n
    " + "smithy.api#documentation": "

    The status of the job. Possible values include:

    \n
      \n
    • \n

      \n SUBMITTED - The job has been received and is queued for\n processing.

      \n
      • \n
    • \n

      \n IN_PROGRESS - Amazon Translate is processing the job.

      \n
      • \n
    • \n

      \n COMPLETED - The job was successfully completed and the output is\n available.

      \n
      • \n
    • \n

      \n COMPLETED_WITH_ERROR - The job was completed with errors. The errors can\n be analyzed in the job's output.

      \n
      • \n
    • \n

      \n FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.

      \n
      • \n
    • \n

      \n STOP_REQUESTED - The user who started the job has requested that it be\n stopped.

      \n
      • \n
    • \n

      \n STOPPED - The job has been stopped.

      \n
      • \n
    " } } } @@ -1032,16 +1035,16 @@ "com.amazonaws.translate#Term": { "type": "structure", "members": { - "TargetText": { + "SourceText": { "target": "com.amazonaws.translate#String", "traits": { - "smithy.api#documentation": "

    The target text of the term being translated by the custom terminology.

    " + "smithy.api#documentation": "

    The source text of the term being translated by the custom terminology.

    " } }, - "SourceText": { + "TargetText": { "target": "com.amazonaws.translate#String", "traits": { - "smithy.api#documentation": "

    The source text of the term being translated by the custom terminology.

    " + "smithy.api#documentation": "

    The target text of the term being translated by the custom terminology.

    " } } }, @@ -1058,7 +1061,10 @@ "com.amazonaws.translate#TerminologyArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:translate:[a-zA-Z0-9-]+:[0-9]{12}:terminology/.+?/.+?$" + "smithy.api#length": { + "min": 1, + "max": 512 + } } }, "com.amazonaws.translate#TerminologyData": { @@ -1133,28 +1139,28 @@ "com.amazonaws.translate#TerminologyProperties": { "type": "structure", "members": { - "SizeBytes": { - "target": "com.amazonaws.translate#Integer", + "Name": { + "target": "com.amazonaws.translate#ResourceName", "traits": { - "smithy.api#documentation": "

    The size of the file used when importing a custom terminology.

    " + "smithy.api#documentation": "

    The name of the custom terminology.

    " } }, - "Description": { - "target": "com.amazonaws.translate#Description", + "EncryptionKey": { + "target": "com.amazonaws.translate#EncryptionKey", "traits": { - "smithy.api#documentation": "

    The description of the custom terminology properties.

    " + "smithy.api#documentation": "

    The encryption key for the custom terminology.

    " } }, - "Name": { - "target": "com.amazonaws.translate#ResourceName", + "SizeBytes": { + "target": "com.amazonaws.translate#Integer", "traits": { - "smithy.api#documentation": "

    The name of the custom terminology.

    " + "smithy.api#documentation": "

    The size of the file used when importing a custom terminology.

    " } }, - "SourceLanguageCode": { - "target": "com.amazonaws.translate#LanguageCodeString", + "TargetLanguageCodes": { + "target": "com.amazonaws.translate#LanguageCodeStringList", "traits": { - "smithy.api#documentation": "

    The language code for the source text of the translation request for which the custom\n terminology is being used.

    " + "smithy.api#documentation": "

    The language codes for the target languages available with the custom terminology file.\n All possible target languages are returned in array.

    " } }, "Arn": { @@ -1163,16 +1169,16 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom terminology.

    " } }, - "TargetLanguageCodes": { - "target": "com.amazonaws.translate#LanguageCodeStringList", + "SourceLanguageCode": { + "target": "com.amazonaws.translate#LanguageCodeString", "traits": { - "smithy.api#documentation": "

    The language codes for the target languages available with the custom terminology file.\n All possible target languages are returned in array.

    " + "smithy.api#documentation": "

    The language code for the source text of the translation request for which the custom\n terminology is being used.

    " } }, - "EncryptionKey": { - "target": "com.amazonaws.translate#EncryptionKey", + "CreatedAt": { + "target": "com.amazonaws.translate#Timestamp", "traits": { - "smithy.api#documentation": "

    The encryption key for the custom terminology.

    " + "smithy.api#documentation": "

    The time at which the custom terminology was created, based on the timestamp.

    " } }, "TermCount": { @@ -1181,10 +1187,10 @@ "smithy.api#documentation": "

    The number of terms included in the custom terminology.

    " } }, - "CreatedAt": { - "target": "com.amazonaws.translate#Timestamp", + "Description": { + "target": "com.amazonaws.translate#Description", "traits": { - "smithy.api#documentation": "

    The time at which the custom terminology was created, based on the timestamp.

    " + "smithy.api#documentation": "

    The description of the custom terminology properties.

    " } }, "LastUpdatedAt": { @@ -1220,22 +1226,16 @@ "com.amazonaws.translate#TextTranslationJobFilter": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.translate#JobName", - "traits": { - "smithy.api#documentation": "

    Filters the list of jobs by name.

    " - } - }, - "SubmittedAfterTime": { + "SubmittedBeforeTime": { "target": "com.amazonaws.translate#Timestamp", "traits": { - "smithy.api#documentation": "

    Filters the list of jobs based on the time that the job was submitted for processing and\n returns only the jobs submitted after the specified time. Jobs are returned in descending\n order, newest to oldest.

    " + "smithy.api#documentation": "

    Filters the list of jobs based on the time that the job was submitted for processing and\n returns only the jobs submitted before the specified time. Jobs are returned in ascending\n order, oldest to newest.

    " } }, - "SubmittedBeforeTime": { - "target": "com.amazonaws.translate#Timestamp", + "JobName": { + "target": "com.amazonaws.translate#JobName", "traits": { - "smithy.api#documentation": "

    Filters the list of jobs based on the time that the job was submitted for processing and\n returns only the jobs submitted before the specified time. Jobs are returned in ascending\n order, oldest to newest.

    " + "smithy.api#documentation": "

    Filters the list of jobs by name.

    " } }, "JobStatus": { @@ -1243,6 +1243,12 @@ "traits": { "smithy.api#documentation": "

    Filters the list of jobs based by job status.

    " } + }, + "SubmittedAfterTime": { + "target": "com.amazonaws.translate#Timestamp", + "traits": { + "smithy.api#documentation": "

    Filters the list of jobs based on the time that the job was submitted for processing and\n returns only the jobs submitted after the specified time. Jobs are returned in descending\n order, newest to oldest.

    " + } } }, "traits": { @@ -1252,46 +1258,46 @@ "com.amazonaws.translate#TextTranslationJobProperties": { "type": "structure", "members": { - "JobName": { - "target": "com.amazonaws.translate#JobName", + "JobStatus": { + "target": "com.amazonaws.translate#JobStatus", "traits": { - "smithy.api#documentation": "

    The user-defined name of the translation job.

    " + "smithy.api#documentation": "

    The status of the translation job.

    " } }, - "TerminologyNames": { - "target": "com.amazonaws.translate#ResourceNameList", + "JobId": { + "target": "com.amazonaws.translate#JobId", "traits": { - "smithy.api#documentation": "

    A list containing the names of the terminologies applied to a translation job. Only one\n terminology can be applied per StartTextTranslationJob request at this\n time.

    " + "smithy.api#documentation": "

    The ID of the translation job.

    " } }, - "TargetLanguageCodes": { - "target": "com.amazonaws.translate#TargetLanguageCodeStringList", + "JobName": { + "target": "com.amazonaws.translate#JobName", "traits": { - "smithy.api#documentation": "

    The language code of the language of the target text. The language must be a language\n supported by Amazon Translate.

    " + "smithy.api#documentation": "

    The user-defined name of the translation job.

    " } }, - "Message": { - "target": "com.amazonaws.translate#UnboundedLengthString", + "TerminologyNames": { + "target": "com.amazonaws.translate#ResourceNameList", "traits": { - "smithy.api#documentation": "

    An explanation of any errors that may have occured during the translation job.

    " + "smithy.api#documentation": "

    A list containing the names of the terminologies applied to a translation job. Only one\n terminology can be applied per StartTextTranslationJob request at this\n time.

    " } }, - "JobStatus": { - "target": "com.amazonaws.translate#JobStatus", + "DataAccessRoleArn": { + "target": "com.amazonaws.translate#IamRoleArn", "traits": { - "smithy.api#documentation": "

    The status of the translation job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role\n that granted Amazon Translate read access to the job's input data.

    " } }, - "EndTime": { - "target": "com.amazonaws.translate#Timestamp", + "SourceLanguageCode": { + "target": "com.amazonaws.translate#LanguageCodeString", "traits": { - "smithy.api#documentation": "

    The time at which the translation job ended.

    " + "smithy.api#documentation": "

    The language code of the language of the source text. The language must be a language\n supported by Amazon Translate.

    " } }, - "SubmittedTime": { - "target": "com.amazonaws.translate#Timestamp", + "Message": { + "target": "com.amazonaws.translate#UnboundedLengthString", "traits": { - "smithy.api#documentation": "

    The time at which the translation job was submitted.

    " + "smithy.api#documentation": "

    An explanation of any errors that may have occured during the translation job.

    " } }, "OutputDataConfig": { @@ -1300,34 +1306,34 @@ "smithy.api#documentation": "

    The output configuration properties that were specified when the job was requested.

    " } }, - "InputDataConfig": { - "target": "com.amazonaws.translate#InputDataConfig", - "traits": { - "smithy.api#documentation": "

    The input configuration properties that were specified when the job was requested.

    " - } - }, "JobDetails": { "target": "com.amazonaws.translate#JobDetails", "traits": { "smithy.api#documentation": "

    The number of documents successfully and unsuccessfully processed during the translation\n job.

    " } }, - "SourceLanguageCode": { - "target": "com.amazonaws.translate#LanguageCodeString", + "TargetLanguageCodes": { + "target": "com.amazonaws.translate#TargetLanguageCodeStringList", "traits": { - "smithy.api#documentation": "

    The language code of the language of the source text. The language must be a language\n supported by Amazon Translate.

    " + "smithy.api#documentation": "

    The language code of the language of the target text. The language must be a language\n supported by Amazon Translate.

    " } }, - "JobId": { - "target": "com.amazonaws.translate#JobId", + "InputDataConfig": { + "target": "com.amazonaws.translate#InputDataConfig", "traits": { - "smithy.api#documentation": "

    The ID of the translation job.

    " + "smithy.api#documentation": "

    The input configuration properties that were specified when the job was requested.

    " } }, - "DataAccessRoleArn": { - "target": "com.amazonaws.translate#IamRoleArn", + "EndTime": { + "target": "com.amazonaws.translate#Timestamp", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role\n that granted Amazon Translate read access to the job's input data.

    " + "smithy.api#documentation": "

    The time at which the translation job ended.

    " + } + }, + "SubmittedTime": { + "target": "com.amazonaws.translate#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time at which the translation job was submitted.

    " } } }, @@ -1398,13 +1404,6 @@ "com.amazonaws.translate#TranslateTextRequest": { "type": "structure", "members": { - "SourceLanguageCode": { - "target": "com.amazonaws.translate#LanguageCodeString", - "traits": { - "smithy.api#documentation": "

    The language code for the language of the source text. The language must be a language\n supported by Amazon Translate. For a list of language codes, see what-is-languages.

    \n

    To have Amazon Translate determine the source language of your text, you can specify\n auto in the SourceLanguageCode field. If you specify\n auto, Amazon Translate will call Amazon\n Comprehend to determine the source language.

    ", - "smithy.api#required": {} - } - }, "Text": { "target": "com.amazonaws.translate#BoundedLengthString", "traits": { @@ -1412,6 +1411,12 @@ "smithy.api#required": {} } }, + "TerminologyNames": { + "target": "com.amazonaws.translate#ResourceNameList", + "traits": { + "smithy.api#documentation": "

    The name of the terminology list file to be used in the TranslateText request. You can use\n 1 terminology list at most in a TranslateText request. Terminology lists can\n contain a maximum of 256 terms.

    " + } + }, "TargetLanguageCode": { "target": "com.amazonaws.translate#LanguageCodeString", "traits": { @@ -1419,10 +1424,11 @@ "smithy.api#required": {} } }, - "TerminologyNames": { - "target": "com.amazonaws.translate#ResourceNameList", + "SourceLanguageCode": { + "target": "com.amazonaws.translate#LanguageCodeString", "traits": { - "smithy.api#documentation": "

    The name of the terminology list file to be used in the TranslateText request. You can use\n 1 terminology list at most in a TranslateText request. Terminology lists can\n contain a maximum of 256 terms.

    " + "smithy.api#documentation": "

    The language code for the language of the source text. The language must be a language\n supported by Amazon Translate. For a list of language codes, see what-is-languages.

    \n

    To have Amazon Translate determine the source language of your text, you can specify\n auto in the SourceLanguageCode field. If you specify\n auto, Amazon Translate will call Amazon\n Comprehend to determine the source language.

    ", + "smithy.api#required": {} } } } @@ -1430,17 +1436,17 @@ "com.amazonaws.translate#TranslateTextResponse": { "type": "structure", "members": { - "SourceLanguageCode": { + "TargetLanguageCode": { "target": "com.amazonaws.translate#LanguageCodeString", "traits": { - "smithy.api#documentation": "

    The language code for the language of the source text.

    ", + "smithy.api#documentation": "

    The language code for the language of the target text.

    ", "smithy.api#required": {} } }, - "TargetLanguageCode": { + "SourceLanguageCode": { "target": "com.amazonaws.translate#LanguageCodeString", "traits": { - "smithy.api#documentation": "

    The language code for the language of the target text.

    ", + "smithy.api#documentation": "

    The language code for the language of the source text.

    ", "smithy.api#required": {} } }, @@ -1465,15 +1471,15 @@ "com.amazonaws.translate#UnsupportedLanguagePairException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.translate#String" + }, "SourceLanguageCode": { "target": "com.amazonaws.translate#LanguageCodeString", "traits": { "smithy.api#documentation": "

    The language code for the language of the input text.

    " } }, - "Message": { - "target": "com.amazonaws.translate#String" - }, "TargetLanguageCode": { "target": "com.amazonaws.translate#LanguageCodeString", "traits": { diff --git a/codegen/sdk-codegen/aws-models/waf-regional.2016-11-28.json b/codegen/sdk-codegen/aws-models/waf-regional.2016-11-28.json index 78e0857f2fd1..d1310c869e24 100644 --- a/codegen/sdk-codegen/aws-models/waf-regional.2016-11-28.json +++ b/codegen/sdk-codegen/aws-models/waf-regional.2016-11-28.json @@ -282,7 +282,7 @@ "sdkId": "WAF Regional", "arnNamespace": "waf-regional", "cloudFormationName": "WAFRegional", - "cloudTrailEventSource": "v20161128.regional.gokucustomerapiservice.amazonaws.com" + "cloudTrailEventSource": "wafregional.amazonaws.com" }, "aws.auth#sigv4": { "name": "waf-regional" @@ -307,10 +307,11 @@ "smithy.api#documentation": "

    Use the OverrideAction to test your RuleGroup.

    \n

    Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

    \n\t

    \n ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " } }, - "ExcludedRules": { - "target": "com.amazonaws.wafregional#ExcludedRules", + "RuleId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

    \n

    Sometimes it is necessary to troubleshoot rule groups that are blocking traffic\n unexpectedly (false positives). One troubleshooting technique is to identify the specific\n rule within the rule group that is blocking the legitimate traffic and then disable\n (exclude) that particular rule. You can exclude rules from both your own rule groups and\n AWS Marketplace rule groups that have been associated with a web ACL.

    \n

    Specifying ExcludedRules does not remove those rules from the rule group.\n Rather, it changes the action for the rules to COUNT. Therefore, requests that\n match an ExcludedRule are counted but not blocked. The RuleGroup\n owner will receive COUNT metrics for each ExcludedRule.

    \n

    If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

    \n
      \n
    1. \n

      Use the AWS WAF logs to identify the IDs of the rules that you want to exclude.\n For more information about the logs, see Logging Web ACL Traffic\n Information.

      \n
      2. \n
    2. \n

      Submit an UpdateWebACL request that has two actions:

      \n
        \n
      • \n

        The first action\n deletes\n the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action\n should be DELETE and Updates:ActivatedRule:RuleId\n should be the rule group that contains the rules that you want to\n exclude.

        \n
        • \n
      • \n

        The second action\n inserts\n the same rule group back in, but specifying the rules to exclude. That is, the\n second Updates:Action should be INSERT,\n Updates:ActivatedRule:RuleId should be the rule group that you\n just removed, and ExcludedRules should contain the rules that you\n want to exclude.

        \n
        • \n
      \n \n
      3. \n
    " + "smithy.api#documentation": "

    The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete a \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", + "smithy.api#required": {} } }, "Type": { @@ -332,11 +333,10 @@ "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ExcludedRules": { + "target": "com.amazonaws.wafregional#ExcludedRules", "traits": { - "smithy.api#documentation": "

    The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete a \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

    \n

    Sometimes it is necessary to troubleshoot rule groups that are blocking traffic\n unexpectedly (false positives). One troubleshooting technique is to identify the specific\n rule within the rule group that is blocking the legitimate traffic and then disable\n (exclude) that particular rule. You can exclude rules from both your own rule groups and\n AWS Marketplace rule groups that have been associated with a web ACL.

    \n

    Specifying ExcludedRules does not remove those rules from the rule group.\n Rather, it changes the action for the rules to COUNT. Therefore, requests that\n match an ExcludedRule are counted but not blocked. The RuleGroup\n owner will receive COUNT metrics for each ExcludedRule.

    \n

    If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

    \n
      \n
    1. \n

      Use the AWS WAF logs to identify the IDs of the rules that you want to exclude.\n For more information about the logs, see Logging Web ACL Traffic\n Information.

      \n
      2. \n
    2. \n

      Submit an UpdateWebACL request that has two actions:

      \n
        \n
      • \n

        The first action\n deletes\n the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action\n should be DELETE and Updates:ActivatedRule:RuleId\n should be the rule group that contains the rules that you want to\n exclude.

        \n
        • \n
      • \n

        The second action\n inserts\n the same rule group back in, but specifying the rules to exclude. That is, the\n second Updates:Action should be INSERT,\n Updates:ActivatedRule:RuleId should be the rule group that you\n just removed, and ExcludedRules should contain the rules that you\n want to exclude.

        \n
        • \n
      \n \n
      3. \n
    " } } }, @@ -439,17 +439,17 @@ "com.amazonaws.wafregional#ByteMatchSetSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "ByteMatchSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    ", + "smithy.api#documentation": "

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet,\n\t\t\tupdate a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

    \n\t\t

    \n ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    ", "smithy.api#required": {} } }, - "ByteMatchSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet,\n\t\t\tupdate a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

    \n\t\t

    \n ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    ", + "smithy.api#documentation": "

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    ", "smithy.api#required": {} } } @@ -461,17 +461,17 @@ "com.amazonaws.wafregional#ByteMatchSetUpdate": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.wafregional#ChangeAction", + "ByteMatchTuple": { + "target": "com.amazonaws.wafregional#ByteMatchTuple", "traits": { - "smithy.api#documentation": "

    Specifies whether to insert or delete a ByteMatchTuple.

    ", + "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for.\n\t\t\tIf you specify DELETE for the value of Action, the ByteMatchTuple values must \n\t\t\texactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    ", "smithy.api#required": {} } }, - "ByteMatchTuple": { - "target": "com.amazonaws.wafregional#ByteMatchTuple", + "Action": { + "target": "com.amazonaws.wafregional#ChangeAction", "traits": { - "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for.\n\t\t\tIf you specify DELETE for the value of Action, the ByteMatchTuple values must \n\t\t\texactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    ", + "smithy.api#documentation": "

    Specifies whether to insert or delete a ByteMatchTuple.

    ", "smithy.api#required": {} } } @@ -497,17 +497,17 @@ "com.amazonaws.wafregional#ByteMatchTuple": { "type": "structure", "members": { - "TextTransformation": { - "target": "com.amazonaws.wafregional#TextTransformation", + "PositionalConstraint": { + "target": "com.amazonaws.wafregional#PositionalConstraint", "traits": { - "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \n\t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", + "smithy.api#documentation": "

    Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

    \n\t\t

    \n CONTAINS\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, but the location doesn't matter.

    \t\t\n\t\t

    \n CONTAINS_WORD\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, and \n\t\t\tTargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n\t\t\tTargetString must be a word, which means one of the following:

    \n\t\t\t
      \n
    • \n

      \n TargetString exactly matches the value of the specified part of the web request, such as the value of a \n\t\t\t\t\theader.

      \n
      • \n
    • \n

      \n TargetString is at the beginning of the specified part of the web request and is followed by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, BadBot;.

      \n
      • \n
    • \n

      \n TargetString is at the end of the specified part of the web request and is preceded by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, ;BadBot.

      \n
      • \n
    • \n

      \n TargetString is in the middle of the specified part of the web request and is preceded and followed \n\t\t\t\t\tby characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

      \n
      • \n
    \n\t\t

    \n EXACTLY\n

    \n\t\t

    The value of the specified part of the web request must exactly match the value of TargetString.

    \n\t\t

    \n STARTS_WITH\n

    \n\t\t

    The value of TargetString must appear at the beginning of the specified part of the web request.

    \t\t\n\t\t

    \n ENDS_WITH\n

    \n\t\t

    The value of TargetString must appear at the end of the specified part of the web request.

    ", "smithy.api#required": {} } }, - "TargetString": { - "target": "com.amazonaws.wafregional#ByteMatchTargetString", + "TextTransformation": { + "target": "com.amazonaws.wafregional#TextTransformation", "traits": { - "smithy.api#documentation": "

    The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you \n\t\t\tspecified in FieldToMatch. The maximum length of the value is 50 bytes.

    \n\t\t

    Valid values depend on the values that you specified for FieldToMatch:

    \t\t\n\t\t
      \n
    • \n

      \n HEADER: The value that you want AWS WAF to search for in the request header that you specified in \n\t\t\t\tFieldToMatch, for example, the value of the User-Agent or Referer header.

      \n
      • \n
    • \n

      \n METHOD: The HTTP method, which indicates the type of operation specified in the request. \n\t\t\t\tCloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, \n\t\t\t\tPATCH, POST, and PUT.

      \n
      • \n
    • \n

      \n QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part \n\t\t\t\tof a URL that appears after a ? character.

      \n
      • \n
    • \n

      \n URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, \n\t\t\t\tfor example, /images/daily-ad.jpg.

      \n
      • \n
    • \n

      \n BODY: The part of a request that contains any additional data that you want to send to your web server \n\t\t\t\tas the HTTP request body, such as data from a form. The request body immediately follows the request headers. \n\t\t\t\tNote that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. \n\t\t\t\tTo allow or block requests based on the length of the body, you can create a size constraint set. \n\t\t\t\tFor more information, see CreateSizeConstraintSet.

      \n
      • \n
    • \n\t\t

      \n\t\t SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

      \n\t\t
      • \n
    • \n\t\t

      \n ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of\n inspecting a single parameter, AWS WAF inspects all parameters within the query\n string for the value or regex pattern that you specify in\n TargetString.

      \n\t\t
      • \n
    \n\t\t\n\t\t

    If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    \n\t\t

    \n If you're using the AWS WAF API\n

    \n\t\t

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    \n\t\t

    For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n TargetString.

    \n\t\t

    \n If you're using the AWS CLI or one of the AWS SDKs\n

    \n\t\t

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    ", + "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \n\t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", "smithy.api#required": {} } }, @@ -518,10 +518,10 @@ "smithy.api#required": {} } }, - "PositionalConstraint": { - "target": "com.amazonaws.wafregional#PositionalConstraint", + "TargetString": { + "target": "com.amazonaws.wafregional#ByteMatchTargetString", "traits": { - "smithy.api#documentation": "

    Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

    \n\t\t

    \n CONTAINS\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, but the location doesn't matter.

    \t\t\n\t\t

    \n CONTAINS_WORD\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, and \n\t\t\tTargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n\t\t\tTargetString must be a word, which means one of the following:

    \n\t\t\t
      \n
    • \n

      \n TargetString exactly matches the value of the specified part of the web request, such as the value of a \n\t\t\t\t\theader.

      \n
      • \n
    • \n

      \n TargetString is at the beginning of the specified part of the web request and is followed by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, BadBot;.

      \n
      • \n
    • \n

      \n TargetString is at the end of the specified part of the web request and is preceded by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, ;BadBot.

      \n
      • \n
    • \n

      \n TargetString is in the middle of the specified part of the web request and is preceded and followed \n\t\t\t\t\tby characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

      \n
      • \n
    \n\t\t

    \n EXACTLY\n

    \n\t\t

    The value of the specified part of the web request must exactly match the value of TargetString.

    \n\t\t

    \n STARTS_WITH\n

    \n\t\t

    The value of TargetString must appear at the beginning of the specified part of the web request.

    \t\t\n\t\t

    \n ENDS_WITH\n

    \n\t\t

    The value of TargetString must appear at the end of the specified part of the web request.

    ", + "smithy.api#documentation": "

    The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you \n\t\t\tspecified in FieldToMatch. The maximum length of the value is 50 bytes.

    \n\t\t

    Valid values depend on the values that you specified for FieldToMatch:

    \t\t\n\t\t
      \n
    • \n

      \n HEADER: The value that you want AWS WAF to search for in the request header that you specified in \n\t\t\t\tFieldToMatch, for example, the value of the User-Agent or Referer header.

      \n
      • \n
    • \n

      \n METHOD: The HTTP method, which indicates the type of operation specified in the request. \n\t\t\t\tCloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, \n\t\t\t\tPATCH, POST, and PUT.

      \n
      • \n
    • \n

      \n QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part \n\t\t\t\tof a URL that appears after a ? character.

      \n
      • \n
    • \n

      \n URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, \n\t\t\t\tfor example, /images/daily-ad.jpg.

      \n
      • \n
    • \n

      \n BODY: The part of a request that contains any additional data that you want to send to your web server \n\t\t\t\tas the HTTP request body, such as data from a form. The request body immediately follows the request headers. \n\t\t\t\tNote that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. \n\t\t\t\tTo allow or block requests based on the length of the body, you can create a size constraint set. \n\t\t\t\tFor more information, see CreateSizeConstraintSet.

      \n
      • \n
    • \n\t\t

      \n\t\t SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

      \n\t\t
      • \n
    • \n\t\t

      \n ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of\n inspecting a single parameter, AWS WAF inspects all parameters within the query\n string for the value or regex pattern that you specify in\n TargetString.

      \n\t\t
      • \n
    \n\t\t\n\t\t

    If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    \n\t\t

    \n If you're using the AWS WAF API\n

    \n\t\t

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    \n\t\t

    For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n TargetString.

    \n\t\t

    \n If you're using the AWS CLI or one of the AWS SDKs\n

    \n\t\t

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    ", "smithy.api#required": {} } } @@ -668,17 +668,17 @@ "com.amazonaws.wafregional#CreateByteMatchSetResponse": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " - } - }, "ByteMatchSet": { "target": "com.amazonaws.wafregional#ByteMatchSet", "traits": { "smithy.api#documentation": "

    A ByteMatchSet that contains no ByteMatchTuple objects.

    " } + }, + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", + "traits": { + "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " + } } } }, @@ -859,23 +859,17 @@ "com.amazonaws.wafregional#CreateRateBasedRuleRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "RateKey": { + "target": "com.amazonaws.wafregional#RateKey", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RateBasedRule. You can't\n change the name of a RateBasedRule after you create it.

    ", + "smithy.api#documentation": "

    The field that AWS WAF uses to determine if requests are likely arriving from a single\n source and thus subject to rate monitoring. The only valid value for RateKey\n is IP. IP indicates that requests that arrive from the same IP\n address are subject to the RateLimit that is specified in\n the RateBasedRule.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.wafregional#TagList", - "traits": { - "smithy.api#documentation": "

    " - } - }, - "MetricName": { - "target": "com.amazonaws.wafregional#MetricName", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this RateBasedRule.\n The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n RateBasedRule.

    ", + "smithy.api#documentation": "

    The ChangeToken that you used to submit the\n CreateRateBasedRule request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.

    ", "smithy.api#required": {} } }, @@ -886,36 +880,42 @@ "smithy.api#required": {} } }, - "RateKey": { - "target": "com.amazonaws.wafregional#RateKey", + "MetricName": { + "target": "com.amazonaws.wafregional#MetricName", "traits": { - "smithy.api#documentation": "

    The field that AWS WAF uses to determine if requests are likely arriving from a single\n source and thus subject to rate monitoring. The only valid value for RateKey\n is IP. IP indicates that requests that arrive from the same IP\n address are subject to the RateLimit that is specified in\n the RateBasedRule.

    ", + "smithy.api#documentation": "

    A friendly name or description for the metrics for this RateBasedRule.\n The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n RateBasedRule.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the\n CreateRateBasedRule request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RateBasedRule. You can't\n change the name of a RateBasedRule after you create it.

    ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.wafregional#TagList", + "traits": { + "smithy.api#documentation": "

    " + } } } }, "com.amazonaws.wafregional#CreateRateBasedRuleResponse": { "type": "structure", "members": { - "Rule": { - "target": "com.amazonaws.wafregional#RateBasedRule", - "traits": { - "smithy.api#documentation": "

    The RateBasedRule\n that is returned in the CreateRateBasedRule response.

    " - } - }, "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "

    The ChangeToken that you used to submit the\n CreateRateBasedRule request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.

    " } + }, + "Rule": { + "target": "com.amazonaws.wafregional#RateBasedRule", + "traits": { + "smithy.api#documentation": "

    The RateBasedRule\n that is returned in the CreateRateBasedRule response.

    " + } } } }, @@ -948,17 +948,17 @@ "com.amazonaws.wafregional#CreateRegexMatchSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -967,17 +967,17 @@ "com.amazonaws.wafregional#CreateRegexMatchSetResponse": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " - } - }, "RegexMatchSet": { "target": "com.amazonaws.wafregional#RegexMatchSet", "traits": { "smithy.api#documentation": "

    A RegexMatchSet that contains no RegexMatchTuple objects.

    " } + }, + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", + "traits": { + "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " + } } } }, @@ -1010,17 +1010,17 @@ "com.amazonaws.wafregional#CreateRegexPatternSetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a \n\t\t\tRegexPatternSet.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a \n\t\t\tRegexPatternSet.

    ", "smithy.api#required": {} } } @@ -1029,17 +1029,17 @@ "com.amazonaws.wafregional#CreateRegexPatternSetResponse": { "type": "structure", "members": { - "RegexPatternSet": { - "target": "com.amazonaws.wafregional#RegexPatternSet", - "traits": { - "smithy.api#documentation": "

    A RegexPatternSet that contains no objects.

    " - } - }, "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " } + }, + "RegexPatternSet": { + "target": "com.amazonaws.wafregional#RegexPatternSet", + "traits": { + "smithy.api#documentation": "

    A RegexPatternSet that contains no objects.

    " + } } } }, @@ -1119,12 +1119,6 @@ "com.amazonaws.wafregional#CreateRuleGroupRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.wafregional#TagList", - "traits": { - "smithy.api#documentation": "

    " - } - }, "MetricName": { "target": "com.amazonaws.wafregional#MetricName", "traits": { @@ -1132,6 +1126,12 @@ "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.wafregional#TagList", + "traits": { + "smithy.api#documentation": "

    " + } + }, "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { @@ -1175,6 +1175,13 @@ "smithy.api#required": {} } }, + "MetricName": { + "target": "com.amazonaws.wafregional#MetricName", + "traits": { + "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n Rule.

    ", + "smithy.api#required": {} + } + }, "Tags": { "target": "com.amazonaws.wafregional#TagList", "traits": { @@ -1187,30 +1194,23 @@ "smithy.api#documentation": "

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    ", "smithy.api#required": {} } - }, - "MetricName": { - "target": "com.amazonaws.wafregional#MetricName", - "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n Rule.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.wafregional#CreateRuleResponse": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRule request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " - } - }, "Rule": { "target": "com.amazonaws.wafregional#Rule", "traits": { "smithy.api#documentation": "

    The Rule returned in the CreateRule response.

    " } + }, + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", + "traits": { + "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRule request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " + } } } }, @@ -1317,17 +1317,17 @@ "com.amazonaws.wafregional#CreateSqlInjectionMatchSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name \n\t\t\tafter you create the SqlInjectionMatchSet.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name \n\t\t\tafter you create the SqlInjectionMatchSet.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -1474,17 +1474,10 @@ "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.wafregional#MetricName", + "DefaultAction": { + "target": "com.amazonaws.wafregional#WafAction", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the\n WebACL.

    ", + "smithy.api#documentation": "

    The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule \n\t\t\tobjects that are associated with the WebACL.

    ", "smithy.api#required": {} } }, @@ -1494,10 +1487,17 @@ "smithy.api#documentation": "

    " } }, - "DefaultAction": { - "target": "com.amazonaws.wafregional#WafAction", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule \n\t\t\tobjects that are associated with the WebACL.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.wafregional#MetricName", + "traits": { + "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the\n WebACL.

    ", "smithy.api#required": {} } } @@ -1691,17 +1691,17 @@ "com.amazonaws.wafregional#DeleteGeoMatchSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "GeoMatchSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", "smithy.api#required": {} } }, - "GeoMatchSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -1899,17 +1899,17 @@ "com.amazonaws.wafregional#DeleteRateBasedRuleRequest": { "type": "structure", "members": { - "RuleId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RuleId of the RateBasedRule that you want to\n delete. RuleId is returned by CreateRateBasedRule and by\n ListRateBasedRules.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "RuleId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RuleId of the RateBasedRule that you want to\n delete. RuleId is returned by CreateRateBasedRule and by\n ListRateBasedRules.

    ", "smithy.api#required": {} } } @@ -1961,17 +1961,17 @@ "com.amazonaws.wafregional#DeleteRegexMatchSetRequest": { "type": "structure", "members": { - "RegexMatchSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "RegexMatchSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", "smithy.api#required": {} } } @@ -2023,17 +2023,17 @@ "com.amazonaws.wafregional#DeleteRegexPatternSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "RegexPatternSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by \n\t\t\tListRegexPatternSets.

    ", "smithy.api#required": {} } }, - "RegexPatternSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by \n\t\t\tListRegexPatternSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -2159,17 +2159,17 @@ "com.amazonaws.wafregional#DeleteRuleRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "RuleId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by \n\t\t\tListRules.

    ", "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by \n\t\t\tListRules.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -2221,17 +2221,17 @@ "com.amazonaws.wafregional#DeleteSizeConstraintSetRequest": { "type": "structure", "members": { - "SizeConstraintSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId \n\t\t\tis returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "SizeConstraintSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId \n\t\t\tis returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", "smithy.api#required": {} } } @@ -3640,17 +3640,17 @@ "com.amazonaws.wafregional#GeoMatchSetUpdate": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.wafregional#ChangeAction", + "GeoMatchConstraint": { + "target": "com.amazonaws.wafregional#GeoMatchConstraint", "traits": { - "smithy.api#documentation": "

    Specifies whether to insert or delete a country with UpdateGeoMatchSet.

    ", + "smithy.api#documentation": "

    The country from which web requests originate that you want AWS WAF to search for.

    ", "smithy.api#required": {} } }, - "GeoMatchConstraint": { - "target": "com.amazonaws.wafregional#GeoMatchConstraint", + "Action": { + "target": "com.amazonaws.wafregional#ChangeAction", "traits": { - "smithy.api#documentation": "

    The country from which web requests originate that you want AWS WAF to search for.

    ", + "smithy.api#documentation": "

    Specifies whether to insert or delete a country with UpdateGeoMatchSet.

    ", "smithy.api#required": {} } } @@ -4021,35 +4021,35 @@ "com.amazonaws.wafregional#GetRateBasedRuleManagedKeysRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    A null value and not currently used. Do not include this in your request.

    " - } - }, "RuleId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "

    The RuleId of the RateBasedRule for which you want to\n get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    ", "smithy.api#required": {} } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    A null value and not currently used. Do not include this in your request.

    " + } } } }, "com.amazonaws.wafregional#GetRateBasedRuleManagedKeysResponse": { "type": "structure", "members": { - "ManagedKeys": { - "target": "com.amazonaws.wafregional#ManagedKeys", - "traits": { - "smithy.api#documentation": "

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    A null value and not currently used.

    " } + }, + "ManagedKeys": { + "target": "com.amazonaws.wafregional#ManagedKeys", + "traits": { + "smithy.api#documentation": "

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

    " + } } } }, @@ -4289,13 +4289,6 @@ "com.amazonaws.wafregional#GetSampledRequestsRequest": { "type": "structure", "members": { - "TimeWindow": { - "target": "com.amazonaws.wafregional#TimeWindow", - "traits": { - "smithy.api#documentation": "

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special \n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", - "smithy.api#required": {} - } - }, "WebAclId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { @@ -4316,6 +4309,13 @@ "smithy.api#documentation": "

    The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received\n\t\t\tduring the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests \n\t\t\treturns information about all of them.

    ", "smithy.api#required": {} } + }, + "TimeWindow": { + "target": "com.amazonaws.wafregional#TimeWindow", + "traits": { + "smithy.api#documentation": "

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special \n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", + "smithy.api#required": {} + } } } }, @@ -4328,17 +4328,17 @@ "smithy.api#documentation": "

    Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, \n\t\t\tif your AWS resource received more than 5,000 requests during the time range that you specified in the request, \n\t\t\tGetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

    " } }, - "SampledRequests": { - "target": "com.amazonaws.wafregional#SampledHTTPRequests", - "traits": { - "smithy.api#documentation": "

    A complex type that contains detailed information about each of the requests in the sample.

    " - } - }, "PopulationSize": { "target": "com.amazonaws.wafregional#PopulationSize", "traits": { "smithy.api#documentation": "

    The total number of requests from which GetSampledRequests got a sample of MaxItems requests. \n\t\t\tIf PopulationSize is less than MaxItems, the sample includes every request that your AWS resource \n\t\t\treceived during the specified time range.

    " } + }, + "SampledRequests": { + "target": "com.amazonaws.wafregional#SampledHTTPRequests", + "traits": { + "smithy.api#documentation": "

    A complex type that contains detailed information about each of the requests in the sample.

    " + } } } }, @@ -4634,18 +4634,18 @@ "smithy.api#documentation": "

    A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

    " } }, - "Method": { - "target": "com.amazonaws.wafregional#HTTPMethod", - "traits": { - "smithy.api#documentation": "

    The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, \n\t\t\tGET, HEAD, OPTIONS, PATCH, POST, and PUT.

    " - } - }, "HTTPVersion": { "target": "com.amazonaws.wafregional#HTTPVersion", "traits": { "smithy.api#documentation": "

    The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    " } }, + "Method": { + "target": "com.amazonaws.wafregional#HTTPMethod", + "traits": { + "smithy.api#documentation": "

    The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, \n\t\t\tGET, HEAD, OPTIONS, PATCH, POST, and PUT.

    " + } + }, "ClientIP": { "target": "com.amazonaws.wafregional#IPString", "traits": { @@ -4762,17 +4762,17 @@ "com.amazonaws.wafregional#IPSetSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "IPSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    ", + "smithy.api#documentation": "

    The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed \n\t\t\tinformation about an IPSet.

    ", "smithy.api#required": {} } }, - "IPSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed \n\t\t\tinformation about an IPSet.

    ", + "smithy.api#documentation": "

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    ", "smithy.api#required": {} } } @@ -4849,10 +4849,10 @@ "com.amazonaws.wafregional#ListActivatedRulesInRuleGroupRequest": { "type": "structure", "members": { - "RuleGroupId": { - "target": "com.amazonaws.wafregional#ResourceId", + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", "traits": { - "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    " + "smithy.api#documentation": "

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. \n For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker \n from the previous response to get information about another batch of ActivatedRules.

    " } }, "Limit": { @@ -4861,10 +4861,10 @@ "smithy.api#documentation": "

    Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a \n NextMarker value that you can use to get another batch of ActivatedRules.

    " } }, - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", + "RuleGroupId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. \n For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker \n from the previous response to get information about another batch of ActivatedRules.

    " + "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    " } } } @@ -4909,34 +4909,34 @@ "com.amazonaws.wafregional#ListByteMatchSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. \n\t\t\tFor the second and subsequent ListByteMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of ByteMatchSets.

    " - } - }, "Limit": { "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tByteMatchSets objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of ByteMatchSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. \n\t\t\tFor the second and subsequent ListByteMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of ByteMatchSets.

    " + } } } }, "com.amazonaws.wafregional#ListByteMatchSetsResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more ByteMatchSet objects, submit another \n\t\t\tListByteMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " - } - }, "ByteMatchSets": { "target": "com.amazonaws.wafregional#ByteMatchSetSummaries", "traits": { "smithy.api#documentation": "

    An array of ByteMatchSetSummary objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more ByteMatchSet objects, submit another \n\t\t\tListByteMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " + } } } }, @@ -4963,17 +4963,17 @@ "com.amazonaws.wafregional#ListGeoMatchSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. \n\t\t\tFor the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of GeoMatchSet objects.

    " - } - }, "Limit": { "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tGeoMatchSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of GeoMatchSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. \n\t\t\tFor the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of GeoMatchSet objects.

    " + } } } }, @@ -5017,17 +5017,17 @@ "com.amazonaws.wafregional#ListIPSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    AWS WAF returns a NextMarker value in the response that allows you to\n list another group of IPSets. For the second and subsequent\n ListIPSets requests, specify the value of NextMarker from the\n previous response to get information about another batch of IPSets.

    " - } - }, "Limit": { "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tIPSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of IPSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    AWS WAF returns a NextMarker value in the response that allows you to\n list another group of IPSets. For the second and subsequent\n ListIPSets requests, specify the value of NextMarker from the\n previous response to get information about another batch of IPSets.

    " + } } } }, @@ -5091,17 +5091,17 @@ "com.amazonaws.wafregional#ListLoggingConfigurationsResponse": { "type": "structure", "members": { - "LoggingConfigurations": { - "target": "com.amazonaws.wafregional#LoggingConfigurations", - "traits": { - "smithy.api#documentation": "

    An array of LoggingConfiguration objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " } + }, + "LoggingConfigurations": { + "target": "com.amazonaws.wafregional#LoggingConfigurations", + "traits": { + "smithy.api#documentation": "

    An array of LoggingConfiguration objects.

    " + } } } }, @@ -5145,17 +5145,17 @@ "com.amazonaws.wafregional#ListRateBasedRulesResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you have more Rules than the number that you specified for\n Limit in the request, the response includes a NextMarker\n value. To list more Rules, submit another ListRateBasedRules\n request, and specify the NextMarker value from the response in the\n NextMarker value in the next request.

    " - } - }, "Rules": { "target": "com.amazonaws.wafregional#RuleSummaries", "traits": { "smithy.api#documentation": "

    An array of RuleSummary objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you have more Rules than the number that you specified for\n Limit in the request, the response includes a NextMarker\n value. To list more Rules, submit another ListRateBasedRules\n request, and specify the NextMarker value from the response in the\n NextMarker value in the next request.

    " + } } } }, @@ -5199,17 +5199,17 @@ "com.amazonaws.wafregional#ListRegexMatchSetsResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more RegexMatchSet objects, submit another \n\t\t\tListRegexMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " - } - }, "RegexMatchSets": { "target": "com.amazonaws.wafregional#RegexMatchSetSummaries", "traits": { "smithy.api#documentation": "

    An array of RegexMatchSetSummary objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more RegexMatchSet objects, submit another \n\t\t\tListRegexMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " + } } } }, @@ -5236,17 +5236,17 @@ "com.amazonaws.wafregional#ListRegexPatternSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. \n\t\t\tFor the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of RegexPatternSet objects.

    " - } - }, "Limit": { "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tRegexPatternSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of RegexPatternSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. \n\t\t\tFor the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of RegexPatternSet objects.

    " + } } } }, @@ -5296,18 +5296,18 @@ "com.amazonaws.wafregional#ListResourcesForWebACLRequest": { "type": "structure", "members": { + "ResourceType": { + "target": "com.amazonaws.wafregional#ResourceType", + "traits": { + "smithy.api#documentation": "

    The type of resource to list, either an application load balancer or Amazon API Gateway.

    " + } + }, "WebACLId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "

    The unique identifier (ID) of the web ACL for which to list the associated resources.

    ", "smithy.api#required": {} } - }, - "ResourceType": { - "target": "com.amazonaws.wafregional#ResourceType", - "traits": { - "smithy.api#documentation": "

    The type of resource to list, either an application load balancer or Amazon API Gateway.

    " - } } } }, @@ -5342,17 +5342,17 @@ "com.amazonaws.wafregional#ListRuleGroupsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. \n For the second and subsequent ListRuleGroups requests, specify the value of NextMarker \n from the previous response to get information about another batch of RuleGroups.

    " - } - }, "Limit": { "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. \n For the second and subsequent ListRuleGroups requests, specify the value of NextMarker \n from the previous response to get information about another batch of RuleGroups.

    " + } } } }, @@ -5413,17 +5413,17 @@ "com.amazonaws.wafregional#ListRulesResponse": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.wafregional#RuleSummaries", - "traits": { - "smithy.api#documentation": "

    An array of RuleSummary objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more Rules than the number that you specified for Limit in the request, \t\t\tthe response includes a NextMarker value. To list more Rules, submit another \n\t\t\tListRules request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " } + }, + "Rules": { + "target": "com.amazonaws.wafregional#RuleSummaries", + "traits": { + "smithy.api#documentation": "

    An array of RuleSummary objects.

    " + } } } }, @@ -5524,17 +5524,17 @@ "com.amazonaws.wafregional#ListSqlInjectionMatchSetsResponse": { "type": "structure", "members": { - "SqlInjectionMatchSets": { - "target": "com.amazonaws.wafregional#SqlInjectionMatchSetSummaries", - "traits": { - "smithy.api#documentation": "

    An array of SqlInjectionMatchSetSummary objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another \n\t\t\tListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " } + }, + "SqlInjectionMatchSets": { + "target": "com.amazonaws.wafregional#SqlInjectionMatchSetSummaries", + "traits": { + "smithy.api#documentation": "

    An array of SqlInjectionMatchSetSummary objects.

    " + } } }, "traits": { @@ -5564,17 +5564,17 @@ "com.amazonaws.wafregional#ListSubscribedRuleGroupsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.wafregional#PaginationLimit", - "traits": { - "smithy.api#documentation": "

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more \n\t\t\tobjects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. \n\t\t\tFor the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of subscribed rule groups.

    " } + }, + "Limit": { + "target": "com.amazonaws.wafregional#PaginationLimit", + "traits": { + "smithy.api#documentation": "

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more \n\t\t\tobjects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of objects.

    " + } } } }, @@ -5630,8 +5630,8 @@ "com.amazonaws.wafregional#ListTagsForResourceRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", + "Limit": { + "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "

    " } @@ -5643,8 +5643,8 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.wafregional#PaginationLimit", + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    " } @@ -5654,14 +5654,14 @@ "com.amazonaws.wafregional#ListTagsForResourceResponse": { "type": "structure", "members": { - "TagInfoForResource": { - "target": "com.amazonaws.wafregional#TagInfoForResource", + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    " } }, - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", + "TagInfoForResource": { + "target": "com.amazonaws.wafregional#TagInfoForResource", "traits": { "smithy.api#documentation": "

    " } @@ -5708,17 +5708,17 @@ "com.amazonaws.wafregional#ListWebACLsResponse": { "type": "structure", "members": { - "WebACLs": { - "target": "com.amazonaws.wafregional#WebACLSummaries", - "traits": { - "smithy.api#documentation": "

    An array of WebACLSummary objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafregional#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more WebACL objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more WebACL objects, submit another \n\t\t\tListWebACLs request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " } + }, + "WebACLs": { + "target": "com.amazonaws.wafregional#WebACLSummaries", + "traits": { + "smithy.api#documentation": "

    An array of WebACLSummary objects.

    " + } } } }, @@ -5745,17 +5745,17 @@ "com.amazonaws.wafregional#ListXssMatchSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafregional#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more XssMatchSet objects than the value of \n\t\t\tLimit, AWS WAF returns a NextMarker value in the response that allows you to list another group of \n\t\t\tXssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the \n\t\t\tvalue of NextMarker from the previous response to get information about another batch of XssMatchSets.

    " - } - }, "Limit": { "target": "com.amazonaws.wafregional#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tXssMatchSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of Rules.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafregional#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more XssMatchSet objects than the value of \n\t\t\tLimit, AWS WAF returns a NextMarker value in the response that allows you to list another group of \n\t\t\tXssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the \n\t\t\tvalue of NextMarker from the previous response to get information about another batch of XssMatchSets.

    " + } } }, "traits": { @@ -6105,6 +6105,13 @@ "com.amazonaws.wafregional#Predicate": { "type": "structure", "members": { + "DataId": { + "target": "com.amazonaws.wafregional#ResourceId", + "traits": { + "smithy.api#documentation": "

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. \n\t\t\tThe ID is returned by the corresponding Create or List command.

    ", + "smithy.api#required": {} + } + }, "Type": { "target": "com.amazonaws.wafregional#PredicateType", "traits": { @@ -6118,13 +6125,6 @@ "smithy.api#documentation": "

    Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the \n\t\t specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n\t\t\tFor example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

    \n\t\t

    Set Negated to True if you want AWS WAF to allow or block a request based on the negation \n\t\t of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n\t\t\tFor example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on \n\t\t\tall IP addresses except \n 192.0.2.44.

    ", "smithy.api#required": {} } - }, - "DataId": { - "target": "com.amazonaws.wafregional#ResourceId", - "traits": { - "smithy.api#documentation": "

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. \n\t\t\tThe ID is returned by the corresponding Create or List command.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -6250,17 +6250,17 @@ "com.amazonaws.wafregional#PutPermissionPolicyRequest": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.wafregional#PolicyString", + "ResourceArn": { + "target": "com.amazonaws.wafregional#ResourceArn", "traits": { - "smithy.api#documentation": "

    The policy to attach to the specified RuleGroup.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    ", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.wafregional#ResourceArn", + "Policy": { + "target": "com.amazonaws.wafregional#PolicyString", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    ", + "smithy.api#documentation": "

    The policy to attach to the specified RuleGroup.

    ", "smithy.api#required": {} } } @@ -6293,11 +6293,10 @@ "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a RateBasedRule. You use RuleId to\n get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a\n WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name or description for a RateBasedRule. You can't change the\n name of a RateBasedRule after you create it.

    " } }, "RateKey": { @@ -6307,10 +6306,11 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "RuleId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description for a RateBasedRule. You can't change the\n name of a RateBasedRule after you create it.

    " + "smithy.api#documentation": "

    A unique identifier for a RateBasedRule. You use RuleId to\n get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a\n WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    ", + "smithy.api#required": {} } } }, @@ -6347,12 +6347,6 @@ "com.amazonaws.wafregional#RegexMatchSet": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", - "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    " - } - }, "RegexMatchSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { @@ -6364,6 +6358,12 @@ "traits": { "smithy.api#documentation": "

    Contains an array of RegexMatchTuple objects. Each RegexMatchTuple \n\t\t\t\tobject contains:

    \n\t\t
      \n
    • \n

      The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

      \n
      • \n
    • \n

      The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

      \n
      • \n
    • \n

      Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

      \n\t\t\t
      • \n
    " } + }, + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", + "traits": { + "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    " + } } }, "traits": { @@ -6401,17 +6401,17 @@ "com.amazonaws.wafregional#RegexMatchSetUpdate": { "type": "structure", "members": { - "RegexMatchTuple": { - "target": "com.amazonaws.wafregional#RegexMatchTuple", + "Action": { + "target": "com.amazonaws.wafregional#ChangeAction", "traits": { - "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for.\n If you specify DELETE for the value of Action, the RegexMatchTuple values must \n exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

    ", + "smithy.api#documentation": "

    Specifies whether to insert or delete a RegexMatchTuple.

    ", "smithy.api#required": {} } }, - "Action": { - "target": "com.amazonaws.wafregional#ChangeAction", + "RegexMatchTuple": { + "target": "com.amazonaws.wafregional#RegexMatchTuple", "traits": { - "smithy.api#documentation": "

    Specifies whether to insert or delete a RegexMatchTuple.

    ", + "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for.\n If you specify DELETE for the value of Action, the RegexMatchTuple values must \n exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

    ", "smithy.api#required": {} } } @@ -6441,17 +6441,17 @@ "smithy.api#required": {} } }, - "RegexPatternSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "FieldToMatch": { + "target": "com.amazonaws.wafregional#FieldToMatch", "traits": { - "smithy.api#documentation": "

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a \n\t\t\tRegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), \n\t\t\tinsert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and \n\t\t\tdelete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

    \n\t\t

    \n\t\t RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", + "smithy.api#documentation": "

    Specifies where in a web request to look for the RegexPatternSet.

    ", "smithy.api#required": {} } }, - "FieldToMatch": { - "target": "com.amazonaws.wafregional#FieldToMatch", + "RegexPatternSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    Specifies where in a web request to look for the RegexPatternSet.

    ", + "smithy.api#documentation": "

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a \n\t\t\tRegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), \n\t\t\tinsert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and \n\t\t\tdelete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

    \n\t\t

    \n\t\t RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", "smithy.api#required": {} } } @@ -6469,6 +6469,13 @@ "com.amazonaws.wafregional#RegexPatternSet": { "type": "structure", "members": { + "RegexPatternSetId": { + "target": "com.amazonaws.wafregional#ResourceId", + "traits": { + "smithy.api#documentation": "

    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet,\n update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    \n

    \n RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", + "smithy.api#required": {} + } + }, "RegexPatternStrings": { "target": "com.amazonaws.wafregional#RegexPatternStrings", "traits": { @@ -6481,13 +6488,6 @@ "traits": { "smithy.api#documentation": "

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " } - }, - "RegexPatternSetId": { - "target": "com.amazonaws.wafregional#ResourceId", - "traits": { - "smithy.api#documentation": "

    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet,\n update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    \n

    \n RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -6631,11 +6631,10 @@ "com.amazonaws.wafregional#Rule": { "type": "structure", "members": { - "Predicates": { - "target": "com.amazonaws.wafregional#Predicates", + "MetricName": { + "target": "com.amazonaws.wafregional#MetricName", "traits": { - "smithy.api#documentation": "

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or \n\t\t\tSqlInjectionMatchSet object that you want to include in a Rule.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the Rule.

    " } }, "RuleId": { @@ -6651,10 +6650,11 @@ "smithy.api#documentation": "

    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

    " } }, - "MetricName": { - "target": "com.amazonaws.wafregional#MetricName", + "Predicates": { + "target": "com.amazonaws.wafregional#Predicates", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the Rule.

    " + "smithy.api#documentation": "

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or \n\t\t\tSqlInjectionMatchSet object that you want to include in a Rule.

    ", + "smithy.api#required": {} } } }, @@ -6698,17 +6698,17 @@ "com.amazonaws.wafregional#RuleGroupSummary": { "type": "structure", "members": { - "RuleGroupId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), \n update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete \n one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    \n

    \n RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "RuleGroupId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), \n update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete \n one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    \n

    \n RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    ", "smithy.api#required": {} } } @@ -6765,17 +6765,17 @@ "com.amazonaws.wafregional#RuleSummary": { "type": "structure", "members": { - "RuleId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", + "smithy.api#documentation": "

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "RuleId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", "smithy.api#required": {} } } @@ -6787,17 +6787,17 @@ "com.amazonaws.wafregional#RuleUpdate": { "type": "structure", "members": { - "Predicate": { - "target": "com.amazonaws.wafregional#Predicate", + "Action": { + "target": "com.amazonaws.wafregional#ChangeAction", "traits": { - "smithy.api#documentation": "

    The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    ", + "smithy.api#documentation": "

    Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a \n\t\t\tPredicate from a Rule.

    ", "smithy.api#required": {} } }, - "Action": { - "target": "com.amazonaws.wafregional#ChangeAction", + "Predicate": { + "target": "com.amazonaws.wafregional#Predicate", "traits": { - "smithy.api#documentation": "

    Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a \n\t\t\tPredicate from a Rule.

    ", + "smithy.api#documentation": "

    The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    ", "smithy.api#required": {} } } @@ -6841,19 +6841,6 @@ "com.amazonaws.wafregional#SampledHTTPRequest": { "type": "structure", "members": { - "Request": { - "target": "com.amazonaws.wafregional#HTTPRequest", - "traits": { - "smithy.api#documentation": "

    A complex type that contains detailed information about the request.

    ", - "smithy.api#required": {} - } - }, - "Timestamp": { - "target": "com.amazonaws.wafregional#Timestamp", - "traits": { - "smithy.api#documentation": "

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " - } - }, "Action": { "target": "com.amazonaws.wafregional#Action", "traits": { @@ -6872,6 +6859,19 @@ "traits": { "smithy.api#documentation": "

    This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

    " } + }, + "Timestamp": { + "target": "com.amazonaws.wafregional#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " + } + }, + "Request": { + "target": "com.amazonaws.wafregional#HTTPRequest", + "traits": { + "smithy.api#documentation": "

    A complex type that contains detailed information about the request.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -6939,18 +6939,18 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", - "traits": { - "smithy.api#documentation": "

    The name, if any, of the SizeConstraintSet.

    " - } - }, "SizeConstraintSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { "smithy.api#documentation": "

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a \n\t\t\tSizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet \n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).

    \n\t\t

    \n SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name, if any, of the SizeConstraintSet.

    " + } } }, "traits": { @@ -6966,17 +6966,17 @@ "com.amazonaws.wafregional#SizeConstraintSetSummary": { "type": "structure", "members": { - "SizeConstraintSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a \n\t\t\tSizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet \n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).

    \n\t\t

    \n SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", + "smithy.api#documentation": "

    The name of the SizeConstraintSet, if any.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "SizeConstraintSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The name of the SizeConstraintSet, if any.

    ", + "smithy.api#documentation": "

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a \n\t\t\tSizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet \n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).

    \n\t\t

    \n SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", "smithy.api#required": {} } } @@ -7027,10 +7027,11 @@ "com.amazonaws.wafregional#SqlInjectionMatchSet": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "SqlInjectionMatchSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The name, if any, of the SqlInjectionMatchSet.

    " + "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", + "smithy.api#required": {} } }, "SqlInjectionMatchTuples": { @@ -7040,11 +7041,10 @@ "smithy.api#required": {} } }, - "SqlInjectionMatchSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name, if any, of the SqlInjectionMatchSet.

    " } } }, @@ -7061,17 +7061,17 @@ "com.amazonaws.wafregional#SqlInjectionMatchSetSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafregional#ResourceName", + "SqlInjectionMatchSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The name of the SqlInjectionMatchSet, if any, specified by Id.

    ", + "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", "smithy.api#required": {} } }, - "SqlInjectionMatchSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Name": { + "target": "com.amazonaws.wafregional#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", + "smithy.api#documentation": "

    The name of the SqlInjectionMatchSet, if any, specified by Id.

    ", "smithy.api#required": {} } } @@ -7083,17 +7083,17 @@ "com.amazonaws.wafregional#SqlInjectionMatchSetUpdate": { "type": "structure", "members": { - "SqlInjectionMatchTuple": { - "target": "com.amazonaws.wafregional#SqlInjectionMatchTuple", + "Action": { + "target": "com.amazonaws.wafregional#ChangeAction", "traits": { - "smithy.api#documentation": "

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    ", + "smithy.api#documentation": "

    Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. \n\t\t\tUse DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

    ", "smithy.api#required": {} } }, - "Action": { - "target": "com.amazonaws.wafregional#ChangeAction", + "SqlInjectionMatchTuple": { + "target": "com.amazonaws.wafregional#SqlInjectionMatchTuple", "traits": { - "smithy.api#documentation": "

    Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. \n\t\t\tUse DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

    ", + "smithy.api#documentation": "

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    ", "smithy.api#required": {} } } @@ -7157,17 +7157,17 @@ "smithy.api#required": {} } }, - "MetricName": { - "target": "com.amazonaws.wafregional#MetricName", + "RuleGroupId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    ", + "smithy.api#documentation": "

    A unique identifier for a RuleGroup.

    ", "smithy.api#required": {} } }, - "RuleGroupId": { - "target": "com.amazonaws.wafregional#ResourceId", + "MetricName": { + "target": "com.amazonaws.wafregional#MetricName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a RuleGroup.

    ", + "smithy.api#documentation": "

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    ", "smithy.api#required": {} } } @@ -7352,17 +7352,17 @@ "com.amazonaws.wafregional#TimeWindow": { "type": "structure", "members": { - "StartTime": { + "EndTime": { "target": "com.amazonaws.wafregional#Timestamp", "traits": { - "smithy.api#documentation": "

    The beginning of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", + "smithy.api#documentation": "

    The end of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", "smithy.api#required": {} } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.wafregional#Timestamp", "traits": { - "smithy.api#documentation": "

    The end of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", + "smithy.api#documentation": "

    The beginning of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", "smithy.api#required": {} } } @@ -7412,15 +7412,15 @@ "com.amazonaws.wafregional#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.wafregional#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.wafregional#ResourceArn", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.wafregional#ResourceArn", + "TagKeys": { + "target": "com.amazonaws.wafregional#TagKeyList", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} @@ -7473,13 +7473,6 @@ "com.amazonaws.wafregional#UpdateByteMatchSetRequest": { "type": "structure", "members": { - "Updates": { - "target": "com.amazonaws.wafregional#ByteMatchSetUpdates", - "traits": { - "smithy.api#documentation": "

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n ByteMatchSetUpdate: Contains Action and ByteMatchTuple\n

      \n
      • \n
    • \n

      \n ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, \n\t\t\t\tand TextTransformation\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", - "smithy.api#required": {} - } - }, "ChangeToken": { "target": "com.amazonaws.wafregional#ChangeToken", "traits": { @@ -7493,6 +7486,13 @@ "smithy.api#documentation": "

    The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by \n\t\t\tListByteMatchSets.

    ", "smithy.api#required": {} } + }, + "Updates": { + "target": "com.amazonaws.wafregional#ByteMatchSetUpdates", + "traits": { + "smithy.api#documentation": "

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n ByteMatchSetUpdate: Contains Action and ByteMatchTuple\n

      \n
      • \n
    • \n

      \n ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, \n\t\t\t\tand TextTransformation\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", + "smithy.api#required": {} + } } } }, @@ -7551,6 +7551,13 @@ "com.amazonaws.wafregional#UpdateGeoMatchSetRequest": { "type": "structure", "members": { + "GeoMatchSetId": { + "target": "com.amazonaws.wafregional#ResourceId", + "traits": { + "smithy.api#documentation": "

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", + "smithy.api#required": {} + } + }, "Updates": { "target": "com.amazonaws.wafregional#GeoMatchSetUpdates", "traits": { @@ -7564,13 +7571,6 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } - }, - "GeoMatchSetId": { - "target": "com.amazonaws.wafregional#ResourceId", - "traits": { - "smithy.api#documentation": "

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", - "smithy.api#required": {} - } } } }, @@ -7629,17 +7629,17 @@ "com.amazonaws.wafregional#UpdateIPSetRequest": { "type": "structure", "members": { - "IPSetId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Updates": { + "target": "com.amazonaws.wafregional#IPSetUpdates", "traits": { - "smithy.api#documentation": "

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by \n\t\t\tListIPSets.

    ", + "smithy.api#documentation": "

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t \n\t

    You can insert a maximum of 1000 addresses in a single request.

    ", "smithy.api#required": {} } }, - "Updates": { - "target": "com.amazonaws.wafregional#IPSetUpdates", + "IPSetId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t \n\t

    You can insert a maximum of 1000 addresses in a single request.

    ", + "smithy.api#documentation": "

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by \n\t\t\tListIPSets.

    ", "smithy.api#required": {} } }, @@ -7707,10 +7707,10 @@ "com.amazonaws.wafregional#UpdateRateBasedRuleRequest": { "type": "structure", "members": { - "RateLimit": { - "target": "com.amazonaws.wafregional#RateLimit", + "Updates": { + "target": "com.amazonaws.wafregional#RuleUpdates", "traits": { - "smithy.api#documentation": "

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a\n five-minute period. If the number of requests exceeds the RateLimit and the other\n predicates specified in the rule are also met,\n AWS WAF triggers the action that is specified for this rule.

    ", + "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete\n from a RateBasedRule.

    ", "smithy.api#required": {} } }, @@ -7728,10 +7728,10 @@ "smithy.api#required": {} } }, - "Updates": { - "target": "com.amazonaws.wafregional#RuleUpdates", + "RateLimit": { + "target": "com.amazonaws.wafregional#RateLimit", "traits": { - "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete\n from a RateBasedRule.

    ", + "smithy.api#documentation": "

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a\n five-minute period. If the number of requests exceeds the RateLimit and the other\n predicates specified in the rule are also met,\n AWS WAF triggers the action that is specified for this rule.

    ", "smithy.api#required": {} } } @@ -7789,13 +7789,6 @@ "com.amazonaws.wafregional#UpdateRegexMatchSetRequest": { "type": "structure", "members": { - "RegexMatchSetId": { - "target": "com.amazonaws.wafregional#ResourceId", - "traits": { - "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", - "smithy.api#required": {} - } - }, "Updates": { "target": "com.amazonaws.wafregional#RegexMatchSetUpdates", "traits": { @@ -7809,6 +7802,13 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } + }, + "RegexMatchSetId": { + "target": "com.amazonaws.wafregional#ResourceId", + "traits": { + "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", + "smithy.api#required": {} + } } } }, @@ -7864,13 +7864,6 @@ "com.amazonaws.wafregional#UpdateRegexPatternSetRequest": { "type": "structure", "members": { - "Updates": { - "target": "com.amazonaws.wafregional#RegexPatternSetUpdates", - "traits": { - "smithy.api#documentation": "

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    ", - "smithy.api#required": {} - } - }, "RegexPatternSetId": { "target": "com.amazonaws.wafregional#ResourceId", "traits": { @@ -7884,6 +7877,13 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } + }, + "Updates": { + "target": "com.amazonaws.wafregional#RegexPatternSetUpdates", + "traits": { + "smithy.api#documentation": "

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    ", + "smithy.api#required": {} + } } } }, @@ -7984,17 +7984,17 @@ "smithy.api#required": {} } }, - "RuleGroupId": { - "target": "com.amazonaws.wafregional#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by \n ListRuleGroups.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "RuleGroupId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by \n ListRuleGroups.

    ", "smithy.api#required": {} } } @@ -8014,10 +8014,10 @@ "com.amazonaws.wafregional#UpdateRuleRequest": { "type": "structure", "members": { - "Updates": { - "target": "com.amazonaws.wafregional#RuleUpdates", + "RuleId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete from a \n\t\t\tRule. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n RuleUpdate: Contains Action and Predicate\n

      \n
      • \n
    • \n

      \n Predicate: Contains DataId, Negated, and Type\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The RuleId of the Rule that you want to update. RuleId is returned by \n\t\t\tCreateRule and by ListRules.

    ", "smithy.api#required": {} } }, @@ -8028,10 +8028,10 @@ "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.wafregional#ResourceId", + "Updates": { + "target": "com.amazonaws.wafregional#RuleUpdates", "traits": { - "smithy.api#documentation": "

    The RuleId of the Rule that you want to update. RuleId is returned by \n\t\t\tCreateRule and by ListRules.

    ", + "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete from a \n\t\t\tRule. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n RuleUpdate: Contains Action and Predicate\n

      \n
      • \n
    • \n

      \n Predicate: Contains DataId, Negated, and Type\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -8174,17 +8174,17 @@ "smithy.api#required": {} } }, - "Updates": { - "target": "com.amazonaws.wafregional#SqlInjectionMatchSetUpdates", + "ChangeToken": { + "target": "com.amazonaws.wafregional#ChangeToken", "traits": { - "smithy.api#documentation": "

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a \n\t\t\tSqlInjectionMatchSet. For more information, see the applicable data types:

    \n\t\t ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.wafregional#ChangeToken", + "Updates": { + "target": "com.amazonaws.wafregional#SqlInjectionMatchSetUpdates", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a \n\t\t\tSqlInjectionMatchSet. For more information, see the applicable data types:

    \n\t\t ", "smithy.api#required": {} } } @@ -8254,23 +8254,17 @@ "com.amazonaws.wafregional#UpdateWebACLRequest": { "type": "structure", "members": { - "WebACLId": { - "target": "com.amazonaws.wafregional#ResourceId", - "traits": { - "smithy.api#documentation": "

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by \n\t\t\tListWebACLs.

    ", - "smithy.api#required": {} - } - }, "DefaultAction": { "target": "com.amazonaws.wafregional#WafAction", "traits": { "smithy.api#documentation": "

    A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default\n action if a request doesn't match the criteria in any of the rules in a web ACL.

    " } }, - "Updates": { - "target": "com.amazonaws.wafregional#WebACLUpdates", + "WebACLId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of updates to make to the WebACL.

    \t\t\n\t\t

    An array of WebACLUpdate objects that you want to insert into or delete from a \n\t\t\tWebACL. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n WebACLUpdate: Contains Action and ActivatedRule\n

      \n
      • \n
    • \n

      \n ActivatedRule: Contains Action,\n OverrideAction, Priority, RuleId, and\n Type. ActivatedRule|OverrideAction applies only when\n updating or adding a RuleGroup to a WebACL. In this\n case,\n you do not use ActivatedRule|Action. For all other update requests,\n ActivatedRule|Action is used instead of\n ActivatedRule|OverrideAction.

      \n
      • \n
    • \n

      \n WafAction: Contains Type\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by \n\t\t\tListWebACLs.

    ", + "smithy.api#required": {} } }, "ChangeToken": { @@ -8279,6 +8273,12 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } + }, + "Updates": { + "target": "com.amazonaws.wafregional#WebACLUpdates", + "traits": { + "smithy.api#documentation": "

    An array of updates to make to the WebACL.

    \t\t\n\t\t

    An array of WebACLUpdate objects that you want to insert into or delete from a \n\t\t\tWebACL. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n WebACLUpdate: Contains Action and ActivatedRule\n

      \n
      • \n
    • \n

      \n ActivatedRule: Contains Action,\n OverrideAction, Priority, RuleId, and\n Type. ActivatedRule|OverrideAction applies only when\n updating or adding a RuleGroup to a WebACL. In this\n case,\n you do not use ActivatedRule|Action. For all other update requests,\n ActivatedRule|Action is used instead of\n ActivatedRule|OverrideAction.

      \n
      • \n
    • \n

      \n WafAction: Contains Type\n

      \n
      • \n
    " + } } } }, @@ -8454,11 +8454,11 @@ "parameter": { "target": "com.amazonaws.wafregional#ParameterExceptionParameter" }, - "field": { - "target": "com.amazonaws.wafregional#ParameterExceptionField" - }, "reason": { "target": "com.amazonaws.wafregional#ParameterExceptionReason" + }, + "field": { + "target": "com.amazonaws.wafregional#ParameterExceptionField" } }, "traits": { @@ -8714,37 +8714,37 @@ "smithy.api#documentation": "

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    " } }, - "Rules": { - "target": "com.amazonaws.wafregional#ActivatedRules", + "WebACLId": { + "target": "com.amazonaws.wafregional#ResourceId", "traits": { - "smithy.api#documentation": "

    An array that contains the action for each Rule in a WebACL, the priority of the Rule, \n\t\t\tand the ID of the Rule.

    ", + "smithy.api#documentation": "

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL \n\t\t\t(see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF \n\t\t\t(see DeleteWebACL).

    \n\t\t

    \n WebACLId is returned by CreateWebACL and by ListWebACLs.

    ", "smithy.api#required": {} } }, - "WebACLArn": { - "target": "com.amazonaws.wafregional#ResourceArn", + "DefaultAction": { + "target": "com.amazonaws.wafregional#WafAction", "traits": { - "smithy.api#documentation": "

    Tha Amazon Resource Name (ARN) of the web ACL.

    " + "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the \n\t\t\tWafAction object.

    ", + "smithy.api#required": {} } }, - "MetricName": { - "target": "com.amazonaws.wafregional#MetricName", + "WebACLArn": { + "target": "com.amazonaws.wafregional#ResourceArn", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " + "smithy.api#documentation": "

    Tha Amazon Resource Name (ARN) of the web ACL.

    " } }, - "DefaultAction": { - "target": "com.amazonaws.wafregional#WafAction", + "Rules": { + "target": "com.amazonaws.wafregional#ActivatedRules", "traits": { - "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the \n\t\t\tWafAction object.

    ", + "smithy.api#documentation": "

    An array that contains the action for each Rule in a WebACL, the priority of the Rule, \n\t\t\tand the ID of the Rule.

    ", "smithy.api#required": {} } }, - "WebACLId": { - "target": "com.amazonaws.wafregional#ResourceId", + "MetricName": { + "target": "com.amazonaws.wafregional#MetricName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL \n\t\t\t(see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF \n\t\t\t(see DeleteWebACL).

    \n\t\t

    \n WebACLId is returned by CreateWebACL and by ListWebACLs.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " } } }, @@ -8811,13 +8811,6 @@ "com.amazonaws.wafregional#XssMatchSet": { "type": "structure", "members": { - "XssMatchTuples": { - "target": "com.amazonaws.wafregional#XssMatchTuples", - "traits": { - "smithy.api#documentation": "

    Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    ", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.wafregional#ResourceName", "traits": { @@ -8830,6 +8823,13 @@ "smithy.api#documentation": "

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an \n\t\t\tXssMatchSet (see GetXssMatchSet), update an XssMatchSet \n\t\t\t(see UpdateXssMatchSet), insert an XssMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF \n\t\t\t(see DeleteXssMatchSet).

    \n\t\t

    \n XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    ", "smithy.api#required": {} } + }, + "XssMatchTuples": { + "target": "com.amazonaws.wafregional#XssMatchTuples", + "traits": { + "smithy.api#documentation": "

    Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -8900,17 +8900,17 @@ "com.amazonaws.wafregional#XssMatchTuple": { "type": "structure", "members": { - "FieldToMatch": { - "target": "com.amazonaws.wafregional#FieldToMatch", + "TextTransformation": { + "target": "com.amazonaws.wafregional#TextTransformation", "traits": { - "smithy.api#documentation": "

    Specifies where in a web request to look for cross-site scripting attacks.

    ", + "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \t\n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", "smithy.api#required": {} } }, - "TextTransformation": { - "target": "com.amazonaws.wafregional#TextTransformation", + "FieldToMatch": { + "target": "com.amazonaws.wafregional#FieldToMatch", "traits": { - "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \t\n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", + "smithy.api#documentation": "

    Specifies where in a web request to look for cross-site scripting attacks.

    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/waf.2015-08-24.json b/codegen/sdk-codegen/aws-models/waf.2015-08-24.json index 0ea2fc13da03..d56ef2de9468 100644 --- a/codegen/sdk-codegen/aws-models/waf.2015-08-24.json +++ b/codegen/sdk-codegen/aws-models/waf.2015-08-24.json @@ -270,7 +270,7 @@ "sdkId": "WAF", "arnNamespace": "waf", "cloudFormationName": "WAF", - "cloudTrailEventSource": "v20150409.gokucustomerapiservice.amazonaws.com" + "cloudTrailEventSource": "waf.amazonaws.com" }, "aws.auth#sigv4": { "name": "waf" @@ -295,10 +295,11 @@ "smithy.api#documentation": "

    Use the OverrideAction to test your RuleGroup.

    \n

    Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

    \n\t

    \n ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " } }, - "ExcludedRules": { - "target": "com.amazonaws.waf#ExcludedRules", + "RuleId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

    \n

    Sometimes it is necessary to troubleshoot rule groups that are blocking traffic\n unexpectedly (false positives). One troubleshooting technique is to identify the specific\n rule within the rule group that is blocking the legitimate traffic and then disable\n (exclude) that particular rule. You can exclude rules from both your own rule groups and\n AWS Marketplace rule groups that have been associated with a web ACL.

    \n

    Specifying ExcludedRules does not remove those rules from the rule group.\n Rather, it changes the action for the rules to COUNT. Therefore, requests that\n match an ExcludedRule are counted but not blocked. The RuleGroup\n owner will receive COUNT metrics for each ExcludedRule.

    \n

    If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

    \n
      \n
    1. \n

      Use the AWS WAF logs to identify the IDs of the rules that you want to exclude.\n For more information about the logs, see Logging Web ACL Traffic\n Information.

      \n
      2. \n
    2. \n

      Submit an UpdateWebACL request that has two actions:

      \n
        \n
      • \n

        The first action\n deletes\n the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action\n should be DELETE and Updates:ActivatedRule:RuleId\n should be the rule group that contains the rules that you want to\n exclude.

        \n
        • \n
      • \n

        The second action\n inserts\n the same rule group back in, but specifying the rules to exclude. That is, the\n second Updates:Action should be INSERT,\n Updates:ActivatedRule:RuleId should be the rule group that you\n just removed, and ExcludedRules should contain the rules that you\n want to exclude.

        \n
        • \n
      \n \n
      3. \n
    " + "smithy.api#documentation": "

    The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete a \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", + "smithy.api#required": {} } }, "Type": { @@ -320,11 +321,10 @@ "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.waf#ResourceId", + "ExcludedRules": { + "target": "com.amazonaws.waf#ExcludedRules", "traits": { - "smithy.api#documentation": "

    The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete a \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

    \n

    Sometimes it is necessary to troubleshoot rule groups that are blocking traffic\n unexpectedly (false positives). One troubleshooting technique is to identify the specific\n rule within the rule group that is blocking the legitimate traffic and then disable\n (exclude) that particular rule. You can exclude rules from both your own rule groups and\n AWS Marketplace rule groups that have been associated with a web ACL.

    \n

    Specifying ExcludedRules does not remove those rules from the rule group.\n Rather, it changes the action for the rules to COUNT. Therefore, requests that\n match an ExcludedRule are counted but not blocked. The RuleGroup\n owner will receive COUNT metrics for each ExcludedRule.

    \n

    If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

    \n
      \n
    1. \n

      Use the AWS WAF logs to identify the IDs of the rules that you want to exclude.\n For more information about the logs, see Logging Web ACL Traffic\n Information.

      \n
      2. \n
    2. \n

      Submit an UpdateWebACL request that has two actions:

      \n
        \n
      • \n

        The first action\n deletes\n the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action\n should be DELETE and Updates:ActivatedRule:RuleId\n should be the rule group that contains the rules that you want to\n exclude.

        \n
        • \n
      • \n

        The second action\n inserts\n the same rule group back in, but specifying the rules to exclude. That is, the\n second Updates:Action should be INSERT,\n Updates:ActivatedRule:RuleId should be the rule group that you\n just removed, and ExcludedRules should contain the rules that you\n want to exclude.

        \n
        • \n
      \n \n
      3. \n
    " } } }, @@ -375,17 +375,17 @@ "com.amazonaws.waf#ByteMatchSetSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "ByteMatchSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    ", + "smithy.api#documentation": "

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet,\n\t\t\tupdate a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

    \n\t\t

    \n ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    ", "smithy.api#required": {} } }, - "ByteMatchSetId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet,\n\t\t\tupdate a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

    \n\t\t

    \n ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    ", + "smithy.api#documentation": "

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    ", "smithy.api#required": {} } } @@ -397,17 +397,17 @@ "com.amazonaws.waf#ByteMatchSetUpdate": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.waf#ChangeAction", + "ByteMatchTuple": { + "target": "com.amazonaws.waf#ByteMatchTuple", "traits": { - "smithy.api#documentation": "

    Specifies whether to insert or delete a ByteMatchTuple.

    ", + "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for.\n\t\t\tIf you specify DELETE for the value of Action, the ByteMatchTuple values must \n\t\t\texactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    ", "smithy.api#required": {} } }, - "ByteMatchTuple": { - "target": "com.amazonaws.waf#ByteMatchTuple", + "Action": { + "target": "com.amazonaws.waf#ChangeAction", "traits": { - "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for.\n\t\t\tIf you specify DELETE for the value of Action, the ByteMatchTuple values must \n\t\t\texactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    ", + "smithy.api#documentation": "

    Specifies whether to insert or delete a ByteMatchTuple.

    ", "smithy.api#required": {} } } @@ -433,17 +433,17 @@ "com.amazonaws.waf#ByteMatchTuple": { "type": "structure", "members": { - "TextTransformation": { - "target": "com.amazonaws.waf#TextTransformation", + "PositionalConstraint": { + "target": "com.amazonaws.waf#PositionalConstraint", "traits": { - "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \n\t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", + "smithy.api#documentation": "

    Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

    \n\t\t

    \n CONTAINS\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, but the location doesn't matter.

    \t\t\n\t\t

    \n CONTAINS_WORD\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, and \n\t\t\tTargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n\t\t\tTargetString must be a word, which means one of the following:

    \n\t\t\t
      \n
    • \n

      \n TargetString exactly matches the value of the specified part of the web request, such as the value of a \n\t\t\t\t\theader.

      \n
      • \n
    • \n

      \n TargetString is at the beginning of the specified part of the web request and is followed by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, BadBot;.

      \n
      • \n
    • \n

      \n TargetString is at the end of the specified part of the web request and is preceded by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, ;BadBot.

      \n
      • \n
    • \n

      \n TargetString is in the middle of the specified part of the web request and is preceded and followed \n\t\t\t\t\tby characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

      \n
      • \n
    \n\t\t

    \n EXACTLY\n

    \n\t\t

    The value of the specified part of the web request must exactly match the value of TargetString.

    \n\t\t

    \n STARTS_WITH\n

    \n\t\t

    The value of TargetString must appear at the beginning of the specified part of the web request.

    \t\t\n\t\t

    \n ENDS_WITH\n

    \n\t\t

    The value of TargetString must appear at the end of the specified part of the web request.

    ", "smithy.api#required": {} } }, - "TargetString": { - "target": "com.amazonaws.waf#ByteMatchTargetString", + "TextTransformation": { + "target": "com.amazonaws.waf#TextTransformation", "traits": { - "smithy.api#documentation": "

    The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you \n\t\t\tspecified in FieldToMatch. The maximum length of the value is 50 bytes.

    \n\t\t

    Valid values depend on the values that you specified for FieldToMatch:

    \t\t\n\t\t
      \n
    • \n

      \n HEADER: The value that you want AWS WAF to search for in the request header that you specified in \n\t\t\t\tFieldToMatch, for example, the value of the User-Agent or Referer header.

      \n
      • \n
    • \n

      \n METHOD: The HTTP method, which indicates the type of operation specified in the request. \n\t\t\t\tCloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, \n\t\t\t\tPATCH, POST, and PUT.

      \n
      • \n
    • \n

      \n QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part \n\t\t\t\tof a URL that appears after a ? character.

      \n
      • \n
    • \n

      \n URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, \n\t\t\t\tfor example, /images/daily-ad.jpg.

      \n
      • \n
    • \n

      \n BODY: The part of a request that contains any additional data that you want to send to your web server \n\t\t\t\tas the HTTP request body, such as data from a form. The request body immediately follows the request headers. \n\t\t\t\tNote that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. \n\t\t\t\tTo allow or block requests based on the length of the body, you can create a size constraint set. \n\t\t\t\tFor more information, see CreateSizeConstraintSet.

      \n
      • \n
    • \n\t\t

      \n\t\t SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

      \n\t\t
      • \n
    • \n\t\t

      \n ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of\n inspecting a single parameter, AWS WAF inspects all parameters within the query\n string for the value or regex pattern that you specify in\n TargetString.

      \n\t\t
      • \n
    \n\t\t\n\t\t

    If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    \n\t\t

    \n If you're using the AWS WAF API\n

    \n\t\t

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    \n\t\t

    For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n TargetString.

    \n\t\t

    \n If you're using the AWS CLI or one of the AWS SDKs\n

    \n\t\t

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    ", + "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \n\t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", "smithy.api#required": {} } }, @@ -454,10 +454,10 @@ "smithy.api#required": {} } }, - "PositionalConstraint": { - "target": "com.amazonaws.waf#PositionalConstraint", + "TargetString": { + "target": "com.amazonaws.waf#ByteMatchTargetString", "traits": { - "smithy.api#documentation": "

    Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

    \n\t\t

    \n CONTAINS\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, but the location doesn't matter.

    \t\t\n\t\t

    \n CONTAINS_WORD\n

    \n\t\t

    The specified part of the web request must include the value of TargetString, and \n\t\t\tTargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n\t\t\tTargetString must be a word, which means one of the following:

    \n\t\t\t
      \n
    • \n

      \n TargetString exactly matches the value of the specified part of the web request, such as the value of a \n\t\t\t\t\theader.

      \n
      • \n
    • \n

      \n TargetString is at the beginning of the specified part of the web request and is followed by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, BadBot;.

      \n
      • \n
    • \n

      \n TargetString is at the end of the specified part of the web request and is preceded by a character \n\t\t\t\t\tother than an alphanumeric character or underscore (_), for example, ;BadBot.

      \n
      • \n
    • \n

      \n TargetString is in the middle of the specified part of the web request and is preceded and followed \n\t\t\t\t\tby characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

      \n
      • \n
    \n\t\t

    \n EXACTLY\n

    \n\t\t

    The value of the specified part of the web request must exactly match the value of TargetString.

    \n\t\t

    \n STARTS_WITH\n

    \n\t\t

    The value of TargetString must appear at the beginning of the specified part of the web request.

    \t\t\n\t\t

    \n ENDS_WITH\n

    \n\t\t

    The value of TargetString must appear at the end of the specified part of the web request.

    ", + "smithy.api#documentation": "

    The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you \n\t\t\tspecified in FieldToMatch. The maximum length of the value is 50 bytes.

    \n\t\t

    Valid values depend on the values that you specified for FieldToMatch:

    \t\t\n\t\t
      \n
    • \n

      \n HEADER: The value that you want AWS WAF to search for in the request header that you specified in \n\t\t\t\tFieldToMatch, for example, the value of the User-Agent or Referer header.

      \n
      • \n
    • \n

      \n METHOD: The HTTP method, which indicates the type of operation specified in the request. \n\t\t\t\tCloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, \n\t\t\t\tPATCH, POST, and PUT.

      \n
      • \n
    • \n

      \n QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part \n\t\t\t\tof a URL that appears after a ? character.

      \n
      • \n
    • \n

      \n URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, \n\t\t\t\tfor example, /images/daily-ad.jpg.

      \n
      • \n
    • \n

      \n BODY: The part of a request that contains any additional data that you want to send to your web server \n\t\t\t\tas the HTTP request body, such as data from a form. The request body immediately follows the request headers. \n\t\t\t\tNote that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. \n\t\t\t\tTo allow or block requests based on the length of the body, you can create a size constraint set. \n\t\t\t\tFor more information, see CreateSizeConstraintSet.

      \n
      • \n
    • \n\t\t

      \n\t\t SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

      \n\t\t
      • \n
    • \n\t\t

      \n ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of\n inspecting a single parameter, AWS WAF inspects all parameters within the query\n string for the value or regex pattern that you specify in\n TargetString.

      \n\t\t
      • \n
    \n\t\t\n\t\t

    If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    \n\t\t

    \n If you're using the AWS WAF API\n

    \n\t\t

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    \n\t\t

    For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n TargetString.

    \n\t\t

    \n If you're using the AWS CLI or one of the AWS SDKs\n

    \n\t\t

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    ", "smithy.api#required": {} } } @@ -604,17 +604,17 @@ "com.amazonaws.waf#CreateByteMatchSetResponse": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " - } - }, "ByteMatchSet": { "target": "com.amazonaws.waf#ByteMatchSet", "traits": { "smithy.api#documentation": "

    A ByteMatchSet that contains no ByteMatchTuple objects.

    " } + }, + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", + "traits": { + "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " + } } } }, @@ -795,23 +795,17 @@ "com.amazonaws.waf#CreateRateBasedRuleRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "RateKey": { + "target": "com.amazonaws.waf#RateKey", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RateBasedRule. You can't\n change the name of a RateBasedRule after you create it.

    ", + "smithy.api#documentation": "

    The field that AWS WAF uses to determine if requests are likely arriving from a single\n source and thus subject to rate monitoring. The only valid value for RateKey\n is IP. IP indicates that requests that arrive from the same IP\n address are subject to the RateLimit that is specified in\n the RateBasedRule.

    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.waf#TagList", - "traits": { - "smithy.api#documentation": "

    " - } - }, - "MetricName": { - "target": "com.amazonaws.waf#MetricName", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this RateBasedRule.\n The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n RateBasedRule.

    ", + "smithy.api#documentation": "

    The ChangeToken that you used to submit the\n CreateRateBasedRule request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.

    ", "smithy.api#required": {} } }, @@ -822,36 +816,42 @@ "smithy.api#required": {} } }, - "RateKey": { - "target": "com.amazonaws.waf#RateKey", + "MetricName": { + "target": "com.amazonaws.waf#MetricName", "traits": { - "smithy.api#documentation": "

    The field that AWS WAF uses to determine if requests are likely arriving from a single\n source and thus subject to rate monitoring. The only valid value for RateKey\n is IP. IP indicates that requests that arrive from the same IP\n address are subject to the RateLimit that is specified in\n the RateBasedRule.

    ", + "smithy.api#documentation": "

    A friendly name or description for the metrics for this RateBasedRule.\n The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n RateBasedRule.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the\n CreateRateBasedRule request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RateBasedRule. You can't\n change the name of a RateBasedRule after you create it.

    ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.waf#TagList", + "traits": { + "smithy.api#documentation": "

    " + } } } }, "com.amazonaws.waf#CreateRateBasedRuleResponse": { "type": "structure", "members": { - "Rule": { - "target": "com.amazonaws.waf#RateBasedRule", - "traits": { - "smithy.api#documentation": "

    The RateBasedRule\n that is returned in the CreateRateBasedRule response.

    " - } - }, "ChangeToken": { "target": "com.amazonaws.waf#ChangeToken", "traits": { "smithy.api#documentation": "

    The ChangeToken that you used to submit the\n CreateRateBasedRule request. You can also use this value to query the\n status of the request. For more information, see GetChangeTokenStatus.

    " } + }, + "Rule": { + "target": "com.amazonaws.waf#RateBasedRule", + "traits": { + "smithy.api#documentation": "

    The RateBasedRule\n that is returned in the CreateRateBasedRule response.

    " + } } } }, @@ -884,17 +884,17 @@ "com.amazonaws.waf#CreateRegexMatchSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -903,17 +903,17 @@ "com.amazonaws.waf#CreateRegexMatchSetResponse": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " - } - }, "RegexMatchSet": { "target": "com.amazonaws.waf#RegexMatchSet", "traits": { "smithy.api#documentation": "

    A RegexMatchSet that contains no RegexMatchTuple objects.

    " } + }, + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", + "traits": { + "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " + } } } }, @@ -946,17 +946,17 @@ "com.amazonaws.waf#CreateRegexPatternSetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a \n\t\t\tRegexPatternSet.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a \n\t\t\tRegexPatternSet.

    ", "smithy.api#required": {} } } @@ -965,17 +965,17 @@ "com.amazonaws.waf#CreateRegexPatternSetResponse": { "type": "structure", "members": { - "RegexPatternSet": { - "target": "com.amazonaws.waf#RegexPatternSet", - "traits": { - "smithy.api#documentation": "

    A RegexPatternSet that contains no objects.

    " - } - }, "ChangeToken": { "target": "com.amazonaws.waf#ChangeToken", "traits": { "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " } + }, + "RegexPatternSet": { + "target": "com.amazonaws.waf#RegexPatternSet", + "traits": { + "smithy.api#documentation": "

    A RegexPatternSet that contains no objects.

    " + } } } }, @@ -1055,12 +1055,6 @@ "com.amazonaws.waf#CreateRuleGroupRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.waf#TagList", - "traits": { - "smithy.api#documentation": "

    " - } - }, "MetricName": { "target": "com.amazonaws.waf#MetricName", "traits": { @@ -1068,6 +1062,12 @@ "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.waf#TagList", + "traits": { + "smithy.api#documentation": "

    " + } + }, "Name": { "target": "com.amazonaws.waf#ResourceName", "traits": { @@ -1111,6 +1111,13 @@ "smithy.api#required": {} } }, + "MetricName": { + "target": "com.amazonaws.waf#MetricName", + "traits": { + "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n Rule.

    ", + "smithy.api#required": {} + } + }, "Tags": { "target": "com.amazonaws.waf#TagList", "traits": { @@ -1123,30 +1130,23 @@ "smithy.api#documentation": "

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    ", "smithy.api#required": {} } - }, - "MetricName": { - "target": "com.amazonaws.waf#MetricName", - "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the\n Rule.

    ", - "smithy.api#required": {} - } } } }, "com.amazonaws.waf#CreateRuleResponse": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRule request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " - } - }, "Rule": { "target": "com.amazonaws.waf#Rule", "traits": { "smithy.api#documentation": "

    The Rule returned in the CreateRule response.

    " } + }, + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", + "traits": { + "smithy.api#documentation": "

    The ChangeToken that you used to submit the CreateRule request. You can also use this value \n\t\t\tto query the status of the request. For more information, see GetChangeTokenStatus.

    " + } } } }, @@ -1253,17 +1253,17 @@ "com.amazonaws.waf#CreateSqlInjectionMatchSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name \n\t\t\tafter you create the SqlInjectionMatchSet.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name \n\t\t\tafter you create the SqlInjectionMatchSet.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -1410,17 +1410,10 @@ "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", - "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.waf#MetricName", + "DefaultAction": { + "target": "com.amazonaws.waf#WafAction", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the\n WebACL.

    ", + "smithy.api#documentation": "

    The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule \n\t\t\tobjects that are associated with the WebACL.

    ", "smithy.api#required": {} } }, @@ -1430,10 +1423,17 @@ "smithy.api#documentation": "

    " } }, - "DefaultAction": { - "target": "com.amazonaws.waf#WafAction", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule \n\t\t\tobjects that are associated with the WebACL.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.waf#MetricName", + "traits": { + "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n\t whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the\n WebACL.

    ", "smithy.api#required": {} } } @@ -1627,17 +1627,17 @@ "com.amazonaws.waf#DeleteGeoMatchSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "GeoMatchSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", "smithy.api#required": {} } }, - "GeoMatchSetId": { - "target": "com.amazonaws.waf#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -1835,17 +1835,17 @@ "com.amazonaws.waf#DeleteRateBasedRuleRequest": { "type": "structure", "members": { - "RuleId": { - "target": "com.amazonaws.waf#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RuleId of the RateBasedRule that you want to\n delete. RuleId is returned by CreateRateBasedRule and by\n ListRateBasedRules.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "RuleId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RuleId of the RateBasedRule that you want to\n delete. RuleId is returned by CreateRateBasedRule and by\n ListRateBasedRules.

    ", "smithy.api#required": {} } } @@ -1897,17 +1897,17 @@ "com.amazonaws.waf#DeleteRegexMatchSetRequest": { "type": "structure", "members": { - "RegexMatchSetId": { - "target": "com.amazonaws.waf#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "RegexMatchSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", "smithy.api#required": {} } } @@ -1959,17 +1959,17 @@ "com.amazonaws.waf#DeleteRegexPatternSetRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "RegexPatternSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by \n\t\t\tListRegexPatternSets.

    ", "smithy.api#required": {} } }, - "RegexPatternSetId": { - "target": "com.amazonaws.waf#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by \n\t\t\tListRegexPatternSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -2095,17 +2095,17 @@ "com.amazonaws.waf#DeleteRuleRequest": { "type": "structure", "members": { - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "RuleId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by \n\t\t\tListRules.

    ", "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.waf#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by \n\t\t\tListRules.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } } @@ -2157,17 +2157,17 @@ "com.amazonaws.waf#DeleteSizeConstraintSetRequest": { "type": "structure", "members": { - "SizeConstraintSetId": { - "target": "com.amazonaws.waf#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId \n\t\t\tis returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "SizeConstraintSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId \n\t\t\tis returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", "smithy.api#required": {} } } @@ -3534,17 +3534,17 @@ "com.amazonaws.waf#GeoMatchSetUpdate": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.waf#ChangeAction", + "GeoMatchConstraint": { + "target": "com.amazonaws.waf#GeoMatchConstraint", "traits": { - "smithy.api#documentation": "

    Specifies whether to insert or delete a country with UpdateGeoMatchSet.

    ", + "smithy.api#documentation": "

    The country from which web requests originate that you want AWS WAF to search for.

    ", "smithy.api#required": {} } }, - "GeoMatchConstraint": { - "target": "com.amazonaws.waf#GeoMatchConstraint", + "Action": { + "target": "com.amazonaws.waf#ChangeAction", "traits": { - "smithy.api#documentation": "

    The country from which web requests originate that you want AWS WAF to search for.

    ", + "smithy.api#documentation": "

    Specifies whether to insert or delete a country with UpdateGeoMatchSet.

    ", "smithy.api#required": {} } } @@ -3915,35 +3915,35 @@ "com.amazonaws.waf#GetRateBasedRuleManagedKeysRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    A null value and not currently used. Do not include this in your request.

    " - } - }, "RuleId": { "target": "com.amazonaws.waf#ResourceId", "traits": { "smithy.api#documentation": "

    The RuleId of the RateBasedRule for which you want to\n get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    ", "smithy.api#required": {} } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    A null value and not currently used. Do not include this in your request.

    " + } } } }, "com.amazonaws.waf#GetRateBasedRuleManagedKeysResponse": { "type": "structure", "members": { - "ManagedKeys": { - "target": "com.amazonaws.waf#ManagedKeys", - "traits": { - "smithy.api#documentation": "

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

    " - } - }, "NextMarker": { "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    A null value and not currently used.

    " } + }, + "ManagedKeys": { + "target": "com.amazonaws.waf#ManagedKeys", + "traits": { + "smithy.api#documentation": "

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

    " + } } } }, @@ -4183,13 +4183,6 @@ "com.amazonaws.waf#GetSampledRequestsRequest": { "type": "structure", "members": { - "TimeWindow": { - "target": "com.amazonaws.waf#TimeWindow", - "traits": { - "smithy.api#documentation": "

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special \n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", - "smithy.api#required": {} - } - }, "WebAclId": { "target": "com.amazonaws.waf#ResourceId", "traits": { @@ -4210,6 +4203,13 @@ "smithy.api#documentation": "

    The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received\n\t\t\tduring the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests \n\t\t\treturns information about all of them.

    ", "smithy.api#required": {} } + }, + "TimeWindow": { + "target": "com.amazonaws.waf#TimeWindow", + "traits": { + "smithy.api#documentation": "

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special \n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", + "smithy.api#required": {} + } } } }, @@ -4222,17 +4222,17 @@ "smithy.api#documentation": "

    Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, \n\t\t\tif your AWS resource received more than 5,000 requests during the time range that you specified in the request, \n\t\t\tGetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

    " } }, - "SampledRequests": { - "target": "com.amazonaws.waf#SampledHTTPRequests", - "traits": { - "smithy.api#documentation": "

    A complex type that contains detailed information about each of the requests in the sample.

    " - } - }, "PopulationSize": { "target": "com.amazonaws.waf#PopulationSize", "traits": { "smithy.api#documentation": "

    The total number of requests from which GetSampledRequests got a sample of MaxItems requests. \n\t\t\tIf PopulationSize is less than MaxItems, the sample includes every request that your AWS resource \n\t\t\treceived during the specified time range.

    " } + }, + "SampledRequests": { + "target": "com.amazonaws.waf#SampledHTTPRequests", + "traits": { + "smithy.api#documentation": "

    A complex type that contains detailed information about each of the requests in the sample.

    " + } } } }, @@ -4476,18 +4476,18 @@ "smithy.api#documentation": "

    A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

    " } }, - "Method": { - "target": "com.amazonaws.waf#HTTPMethod", - "traits": { - "smithy.api#documentation": "

    The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, \n\t\t\tGET, HEAD, OPTIONS, PATCH, POST, and PUT.

    " - } - }, "HTTPVersion": { "target": "com.amazonaws.waf#HTTPVersion", "traits": { "smithy.api#documentation": "

    The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    " } }, + "Method": { + "target": "com.amazonaws.waf#HTTPMethod", + "traits": { + "smithy.api#documentation": "

    The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, \n\t\t\tGET, HEAD, OPTIONS, PATCH, POST, and PUT.

    " + } + }, "ClientIP": { "target": "com.amazonaws.waf#IPString", "traits": { @@ -4604,17 +4604,17 @@ "com.amazonaws.waf#IPSetSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "IPSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    ", + "smithy.api#documentation": "

    The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed \n\t\t\tinformation about an IPSet.

    ", "smithy.api#required": {} } }, - "IPSetId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed \n\t\t\tinformation about an IPSet.

    ", + "smithy.api#documentation": "

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    ", "smithy.api#required": {} } } @@ -4691,10 +4691,10 @@ "com.amazonaws.waf#ListActivatedRulesInRuleGroupRequest": { "type": "structure", "members": { - "RuleGroupId": { - "target": "com.amazonaws.waf#ResourceId", + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", "traits": { - "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    " + "smithy.api#documentation": "

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. \n For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker \n from the previous response to get information about another batch of ActivatedRules.

    " } }, "Limit": { @@ -4703,10 +4703,10 @@ "smithy.api#documentation": "

    Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a \n NextMarker value that you can use to get another batch of ActivatedRules.

    " } }, - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", + "RuleGroupId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. \n For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker \n from the previous response to get information about another batch of ActivatedRules.

    " + "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    " } } } @@ -4751,34 +4751,34 @@ "com.amazonaws.waf#ListByteMatchSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. \n\t\t\tFor the second and subsequent ListByteMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of ByteMatchSets.

    " - } - }, "Limit": { "target": "com.amazonaws.waf#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tByteMatchSets objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of ByteMatchSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. \n\t\t\tFor the second and subsequent ListByteMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of ByteMatchSets.

    " + } } } }, "com.amazonaws.waf#ListByteMatchSetsResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more ByteMatchSet objects, submit another \n\t\t\tListByteMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " - } - }, "ByteMatchSets": { "target": "com.amazonaws.waf#ByteMatchSetSummaries", "traits": { "smithy.api#documentation": "

    An array of ByteMatchSetSummary objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more ByteMatchSet objects, submit another \n\t\t\tListByteMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " + } } } }, @@ -4805,17 +4805,17 @@ "com.amazonaws.waf#ListGeoMatchSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. \n\t\t\tFor the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of GeoMatchSet objects.

    " - } - }, "Limit": { "target": "com.amazonaws.waf#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tGeoMatchSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of GeoMatchSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. \n\t\t\tFor the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of GeoMatchSet objects.

    " + } } } }, @@ -4859,17 +4859,17 @@ "com.amazonaws.waf#ListIPSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    AWS WAF returns a NextMarker value in the response that allows you to\n list another group of IPSets. For the second and subsequent\n ListIPSets requests, specify the value of NextMarker from the\n previous response to get information about another batch of IPSets.

    " - } - }, "Limit": { "target": "com.amazonaws.waf#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tIPSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of IPSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    AWS WAF returns a NextMarker value in the response that allows you to\n list another group of IPSets. For the second and subsequent\n ListIPSets requests, specify the value of NextMarker from the\n previous response to get information about another batch of IPSets.

    " + } } } }, @@ -4933,17 +4933,17 @@ "com.amazonaws.waf#ListLoggingConfigurationsResponse": { "type": "structure", "members": { - "LoggingConfigurations": { - "target": "com.amazonaws.waf#LoggingConfigurations", - "traits": { - "smithy.api#documentation": "

    An array of LoggingConfiguration objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " } + }, + "LoggingConfigurations": { + "target": "com.amazonaws.waf#LoggingConfigurations", + "traits": { + "smithy.api#documentation": "

    An array of LoggingConfiguration objects.

    " + } } } }, @@ -4987,17 +4987,17 @@ "com.amazonaws.waf#ListRateBasedRulesResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you have more Rules than the number that you specified for\n Limit in the request, the response includes a NextMarker\n value. To list more Rules, submit another ListRateBasedRules\n request, and specify the NextMarker value from the response in the\n NextMarker value in the next request.

    " - } - }, "Rules": { "target": "com.amazonaws.waf#RuleSummaries", "traits": { "smithy.api#documentation": "

    An array of RuleSummary objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you have more Rules than the number that you specified for\n Limit in the request, the response includes a NextMarker\n value. To list more Rules, submit another ListRateBasedRules\n request, and specify the NextMarker value from the response in the\n NextMarker value in the next request.

    " + } } } }, @@ -5041,17 +5041,17 @@ "com.amazonaws.waf#ListRegexMatchSetsResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more RegexMatchSet objects, submit another \n\t\t\tListRegexMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " - } - }, "RegexMatchSets": { "target": "com.amazonaws.waf#RegexMatchSetSummaries", "traits": { "smithy.api#documentation": "

    An array of RegexMatchSetSummary objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more RegexMatchSet objects, submit another \n\t\t\tListRegexMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " + } } } }, @@ -5078,17 +5078,17 @@ "com.amazonaws.waf#ListRegexPatternSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. \n\t\t\tFor the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of RegexPatternSet objects.

    " - } - }, "Limit": { "target": "com.amazonaws.waf#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tRegexPatternSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of RegexPatternSet objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. \n\t\t\tFor the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of RegexPatternSet objects.

    " + } } } }, @@ -5129,17 +5129,17 @@ "com.amazonaws.waf#ListRuleGroupsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. \n For the second and subsequent ListRuleGroups requests, specify the value of NextMarker \n from the previous response to get information about another batch of RuleGroups.

    " - } - }, "Limit": { "target": "com.amazonaws.waf#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, \n AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. \n For the second and subsequent ListRuleGroups requests, specify the value of NextMarker \n from the previous response to get information about another batch of RuleGroups.

    " + } } } }, @@ -5200,17 +5200,17 @@ "com.amazonaws.waf#ListRulesResponse": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.waf#RuleSummaries", - "traits": { - "smithy.api#documentation": "

    An array of RuleSummary objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more Rules than the number that you specified for Limit in the request, \t\t\tthe response includes a NextMarker value. To list more Rules, submit another \n\t\t\tListRules request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " } + }, + "Rules": { + "target": "com.amazonaws.waf#RuleSummaries", + "traits": { + "smithy.api#documentation": "

    An array of RuleSummary objects.

    " + } } } }, @@ -5311,17 +5311,17 @@ "com.amazonaws.waf#ListSqlInjectionMatchSetsResponse": { "type": "structure", "members": { - "SqlInjectionMatchSets": { - "target": "com.amazonaws.waf#SqlInjectionMatchSetSummaries", - "traits": { - "smithy.api#documentation": "

    An array of SqlInjectionMatchSetSummary objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another \n\t\t\tListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " } + }, + "SqlInjectionMatchSets": { + "target": "com.amazonaws.waf#SqlInjectionMatchSetSummaries", + "traits": { + "smithy.api#documentation": "

    An array of SqlInjectionMatchSetSummary objects.

    " + } } }, "traits": { @@ -5351,17 +5351,17 @@ "com.amazonaws.waf#ListSubscribedRuleGroupsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.waf#PaginationLimit", - "traits": { - "smithy.api#documentation": "

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more \n\t\t\tobjects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, \n\t\t\tAWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. \n\t\t\tFor the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker \n\t\t\tfrom the previous response to get information about another batch of subscribed rule groups.

    " } + }, + "Limit": { + "target": "com.amazonaws.waf#PaginationLimit", + "traits": { + "smithy.api#documentation": "

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more \n\t\t\tobjects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of objects.

    " + } } } }, @@ -5417,8 +5417,8 @@ "com.amazonaws.waf#ListTagsForResourceRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", + "Limit": { + "target": "com.amazonaws.waf#PaginationLimit", "traits": { "smithy.api#documentation": "

    " } @@ -5430,8 +5430,8 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.waf#PaginationLimit", + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    " } @@ -5441,14 +5441,14 @@ "com.amazonaws.waf#ListTagsForResourceResponse": { "type": "structure", "members": { - "TagInfoForResource": { - "target": "com.amazonaws.waf#TagInfoForResource", + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    " } }, - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", + "TagInfoForResource": { + "target": "com.amazonaws.waf#TagInfoForResource", "traits": { "smithy.api#documentation": "

    " } @@ -5495,17 +5495,17 @@ "com.amazonaws.waf#ListWebACLsResponse": { "type": "structure", "members": { - "WebACLs": { - "target": "com.amazonaws.waf#WebACLSummaries", - "traits": { - "smithy.api#documentation": "

    An array of WebACLSummary objects.

    " - } - }, "NextMarker": { "target": "com.amazonaws.waf#NextMarker", "traits": { "smithy.api#documentation": "

    If you have more WebACL objects than the number that you specified for Limit in the request, \n\t\t\tthe response includes a NextMarker value. To list more WebACL objects, submit another \n\t\t\tListWebACLs request, and specify the NextMarker value from the response in the \n\t\t\tNextMarker value in the next request.

    " } + }, + "WebACLs": { + "target": "com.amazonaws.waf#WebACLSummaries", + "traits": { + "smithy.api#documentation": "

    An array of WebACLSummary objects.

    " + } } } }, @@ -5532,17 +5532,17 @@ "com.amazonaws.waf#ListXssMatchSetsRequest": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.waf#NextMarker", - "traits": { - "smithy.api#documentation": "

    If you specify a value for Limit and you have more XssMatchSet objects than the value of \n\t\t\tLimit, AWS WAF returns a NextMarker value in the response that allows you to list another group of \n\t\t\tXssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the \n\t\t\tvalue of NextMarker from the previous response to get information about another batch of XssMatchSets.

    " - } - }, "Limit": { "target": "com.amazonaws.waf#PaginationLimit", "traits": { "smithy.api#documentation": "

    Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more \n\t\t\tXssMatchSet objects than the number you specify for Limit, the response includes a \n\t\t\tNextMarker value that you can use to get another batch of Rules.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.waf#NextMarker", + "traits": { + "smithy.api#documentation": "

    If you specify a value for Limit and you have more XssMatchSet objects than the value of \n\t\t\tLimit, AWS WAF returns a NextMarker value in the response that allows you to list another group of \n\t\t\tXssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the \n\t\t\tvalue of NextMarker from the previous response to get information about another batch of XssMatchSets.

    " + } } }, "traits": { @@ -5892,6 +5892,13 @@ "com.amazonaws.waf#Predicate": { "type": "structure", "members": { + "DataId": { + "target": "com.amazonaws.waf#ResourceId", + "traits": { + "smithy.api#documentation": "

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. \n\t\t\tThe ID is returned by the corresponding Create or List command.

    ", + "smithy.api#required": {} + } + }, "Type": { "target": "com.amazonaws.waf#PredicateType", "traits": { @@ -5905,13 +5912,6 @@ "smithy.api#documentation": "

    Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the \n\t\t specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n\t\t\tFor example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

    \n\t\t

    Set Negated to True if you want AWS WAF to allow or block a request based on the negation \n\t\t of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n\t\t\tFor example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on \n\t\t\tall IP addresses except \n 192.0.2.44.

    ", "smithy.api#required": {} } - }, - "DataId": { - "target": "com.amazonaws.waf#ResourceId", - "traits": { - "smithy.api#documentation": "

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. \n\t\t\tThe ID is returned by the corresponding Create or List command.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -6037,17 +6037,17 @@ "com.amazonaws.waf#PutPermissionPolicyRequest": { "type": "structure", "members": { - "Policy": { - "target": "com.amazonaws.waf#PolicyString", + "ResourceArn": { + "target": "com.amazonaws.waf#ResourceArn", "traits": { - "smithy.api#documentation": "

    The policy to attach to the specified RuleGroup.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    ", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.waf#ResourceArn", + "Policy": { + "target": "com.amazonaws.waf#PolicyString", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    ", + "smithy.api#documentation": "

    The policy to attach to the specified RuleGroup.

    ", "smithy.api#required": {} } } @@ -6080,11 +6080,10 @@ "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a RateBasedRule. You use RuleId to\n get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a\n WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name or description for a RateBasedRule. You can't change the\n name of a RateBasedRule after you create it.

    " } }, "RateKey": { @@ -6094,10 +6093,11 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "RuleId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description for a RateBasedRule. You can't change the\n name of a RateBasedRule after you create it.

    " + "smithy.api#documentation": "

    A unique identifier for a RateBasedRule. You use RuleId to\n get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a\n WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    ", + "smithy.api#required": {} } } }, @@ -6134,12 +6134,6 @@ "com.amazonaws.waf#RegexMatchSet": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.waf#ResourceName", - "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    " - } - }, "RegexMatchSetId": { "target": "com.amazonaws.waf#ResourceId", "traits": { @@ -6151,6 +6145,12 @@ "traits": { "smithy.api#documentation": "

    Contains an array of RegexMatchTuple objects. Each RegexMatchTuple \n\t\t\t\tobject contains:

    \n\t\t
      \n
    • \n

      The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

      \n
      • \n
    • \n

      The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

      \n
      • \n
    • \n

      Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

      \n\t\t\t
      • \n
    " } + }, + "Name": { + "target": "com.amazonaws.waf#ResourceName", + "traits": { + "smithy.api#documentation": "

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a \n\t\t\tRegexMatchSet.

    " + } } }, "traits": { @@ -6188,17 +6188,17 @@ "com.amazonaws.waf#RegexMatchSetUpdate": { "type": "structure", "members": { - "RegexMatchTuple": { - "target": "com.amazonaws.waf#RegexMatchTuple", + "Action": { + "target": "com.amazonaws.waf#ChangeAction", "traits": { - "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for.\n If you specify DELETE for the value of Action, the RegexMatchTuple values must \n exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

    ", + "smithy.api#documentation": "

    Specifies whether to insert or delete a RegexMatchTuple.

    ", "smithy.api#required": {} } }, - "Action": { - "target": "com.amazonaws.waf#ChangeAction", + "RegexMatchTuple": { + "target": "com.amazonaws.waf#RegexMatchTuple", "traits": { - "smithy.api#documentation": "

    Specifies whether to insert or delete a RegexMatchTuple.

    ", + "smithy.api#documentation": "

    Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for.\n If you specify DELETE for the value of Action, the RegexMatchTuple values must \n exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

    ", "smithy.api#required": {} } } @@ -6228,17 +6228,17 @@ "smithy.api#required": {} } }, - "RegexPatternSetId": { - "target": "com.amazonaws.waf#ResourceId", + "FieldToMatch": { + "target": "com.amazonaws.waf#FieldToMatch", "traits": { - "smithy.api#documentation": "

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a \n\t\t\tRegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), \n\t\t\tinsert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and \n\t\t\tdelete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

    \n\t\t

    \n\t\t RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", + "smithy.api#documentation": "

    Specifies where in a web request to look for the RegexPatternSet.

    ", "smithy.api#required": {} } }, - "FieldToMatch": { - "target": "com.amazonaws.waf#FieldToMatch", + "RegexPatternSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    Specifies where in a web request to look for the RegexPatternSet.

    ", + "smithy.api#documentation": "

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a \n\t\t\tRegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), \n\t\t\tinsert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and \n\t\t\tdelete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

    \n\t\t

    \n\t\t RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", "smithy.api#required": {} } } @@ -6256,6 +6256,13 @@ "com.amazonaws.waf#RegexPatternSet": { "type": "structure", "members": { + "RegexPatternSetId": { + "target": "com.amazonaws.waf#ResourceId", + "traits": { + "smithy.api#documentation": "

    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet,\n update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    \n

    \n RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", + "smithy.api#required": {} + } + }, "RegexPatternStrings": { "target": "com.amazonaws.waf#RegexPatternStrings", "traits": { @@ -6268,13 +6275,6 @@ "traits": { "smithy.api#documentation": "

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " } - }, - "RegexPatternSetId": { - "target": "com.amazonaws.waf#ResourceId", - "traits": { - "smithy.api#documentation": "

    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet,\n update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    \n

    \n RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -6397,11 +6397,10 @@ "com.amazonaws.waf#Rule": { "type": "structure", "members": { - "Predicates": { - "target": "com.amazonaws.waf#Predicates", + "MetricName": { + "target": "com.amazonaws.waf#MetricName", "traits": { - "smithy.api#documentation": "

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or \n\t\t\tSqlInjectionMatchSet object that you want to include in a Rule.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the Rule.

    " } }, "RuleId": { @@ -6417,10 +6416,11 @@ "smithy.api#documentation": "

    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

    " } }, - "MetricName": { - "target": "com.amazonaws.waf#MetricName", + "Predicates": { + "target": "com.amazonaws.waf#Predicates", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the Rule.

    " + "smithy.api#documentation": "

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or \n\t\t\tSqlInjectionMatchSet object that you want to include in a Rule.

    ", + "smithy.api#required": {} } } }, @@ -6464,17 +6464,17 @@ "com.amazonaws.waf#RuleGroupSummary": { "type": "structure", "members": { - "RuleGroupId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), \n update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete \n one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    \n

    \n RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    ", + "smithy.api#documentation": "

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "RuleGroupId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), \n update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete \n one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    \n

    \n RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    ", "smithy.api#required": {} } } @@ -6531,17 +6531,17 @@ "com.amazonaws.waf#RuleSummary": { "type": "structure", "members": { - "RuleId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", + "smithy.api#documentation": "

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "RuleId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), \n\t\t\tupdate a Rule (see UpdateRule), insert a Rule into a WebACL or delete \n\t\t\tone from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    \n\t\t

    \n RuleId is returned by CreateRule and by ListRules.

    ", "smithy.api#required": {} } } @@ -6553,17 +6553,17 @@ "com.amazonaws.waf#RuleUpdate": { "type": "structure", "members": { - "Predicate": { - "target": "com.amazonaws.waf#Predicate", + "Action": { + "target": "com.amazonaws.waf#ChangeAction", "traits": { - "smithy.api#documentation": "

    The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    ", + "smithy.api#documentation": "

    Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a \n\t\t\tPredicate from a Rule.

    ", "smithy.api#required": {} } }, - "Action": { - "target": "com.amazonaws.waf#ChangeAction", + "Predicate": { + "target": "com.amazonaws.waf#Predicate", "traits": { - "smithy.api#documentation": "

    Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a \n\t\t\tPredicate from a Rule.

    ", + "smithy.api#documentation": "

    The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    ", "smithy.api#required": {} } } @@ -6607,19 +6607,6 @@ "com.amazonaws.waf#SampledHTTPRequest": { "type": "structure", "members": { - "Request": { - "target": "com.amazonaws.waf#HTTPRequest", - "traits": { - "smithy.api#documentation": "

    A complex type that contains detailed information about the request.

    ", - "smithy.api#required": {} - } - }, - "Timestamp": { - "target": "com.amazonaws.waf#Timestamp", - "traits": { - "smithy.api#documentation": "

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " - } - }, "Action": { "target": "com.amazonaws.waf#Action", "traits": { @@ -6638,6 +6625,19 @@ "traits": { "smithy.api#documentation": "

    This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

    " } + }, + "Timestamp": { + "target": "com.amazonaws.waf#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " + } + }, + "Request": { + "target": "com.amazonaws.waf#HTTPRequest", + "traits": { + "smithy.api#documentation": "

    A complex type that contains detailed information about the request.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -6705,18 +6705,18 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.waf#ResourceName", - "traits": { - "smithy.api#documentation": "

    The name, if any, of the SizeConstraintSet.

    " - } - }, "SizeConstraintSetId": { "target": "com.amazonaws.waf#ResourceId", "traits": { "smithy.api#documentation": "

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a \n\t\t\tSizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet \n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).

    \n\t\t

    \n SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.waf#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name, if any, of the SizeConstraintSet.

    " + } } }, "traits": { @@ -6732,17 +6732,17 @@ "com.amazonaws.waf#SizeConstraintSetSummary": { "type": "structure", "members": { - "SizeConstraintSetId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a \n\t\t\tSizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet \n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).

    \n\t\t

    \n SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", + "smithy.api#documentation": "

    The name of the SizeConstraintSet, if any.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "SizeConstraintSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The name of the SizeConstraintSet, if any.

    ", + "smithy.api#documentation": "

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a \n\t\t\tSizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet \n\t\t\t(see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF \n\t\t\t(see DeleteSizeConstraintSet).

    \n\t\t

    \n SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    ", "smithy.api#required": {} } } @@ -6793,10 +6793,11 @@ "com.amazonaws.waf#SqlInjectionMatchSet": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "SqlInjectionMatchSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The name, if any, of the SqlInjectionMatchSet.

    " + "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", + "smithy.api#required": {} } }, "SqlInjectionMatchTuples": { @@ -6806,11 +6807,10 @@ "smithy.api#required": {} } }, - "SqlInjectionMatchSetId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name, if any, of the SqlInjectionMatchSet.

    " } } }, @@ -6827,17 +6827,17 @@ "com.amazonaws.waf#SqlInjectionMatchSetSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.waf#ResourceName", + "SqlInjectionMatchSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The name of the SqlInjectionMatchSet, if any, specified by Id.

    ", + "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", "smithy.api#required": {} } }, - "SqlInjectionMatchSetId": { - "target": "com.amazonaws.waf#ResourceId", + "Name": { + "target": "com.amazonaws.waf#ResourceName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a \n\t\t\tSqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet \n\t\t\t(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF \n\t\t\t(see DeleteSqlInjectionMatchSet).

    \n\t\t

    \n SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    ", + "smithy.api#documentation": "

    The name of the SqlInjectionMatchSet, if any, specified by Id.

    ", "smithy.api#required": {} } } @@ -6849,17 +6849,17 @@ "com.amazonaws.waf#SqlInjectionMatchSetUpdate": { "type": "structure", "members": { - "SqlInjectionMatchTuple": { - "target": "com.amazonaws.waf#SqlInjectionMatchTuple", + "Action": { + "target": "com.amazonaws.waf#ChangeAction", "traits": { - "smithy.api#documentation": "

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    ", + "smithy.api#documentation": "

    Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. \n\t\t\tUse DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

    ", "smithy.api#required": {} } }, - "Action": { - "target": "com.amazonaws.waf#ChangeAction", + "SqlInjectionMatchTuple": { + "target": "com.amazonaws.waf#SqlInjectionMatchTuple", "traits": { - "smithy.api#documentation": "

    Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. \n\t\t\tUse DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

    ", + "smithy.api#documentation": "

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    ", "smithy.api#required": {} } } @@ -6923,17 +6923,17 @@ "smithy.api#required": {} } }, - "MetricName": { - "target": "com.amazonaws.waf#MetricName", + "RuleGroupId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    ", + "smithy.api#documentation": "

    A unique identifier for a RuleGroup.

    ", "smithy.api#required": {} } }, - "RuleGroupId": { - "target": "com.amazonaws.waf#ResourceId", + "MetricName": { + "target": "com.amazonaws.waf#MetricName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a RuleGroup.

    ", + "smithy.api#documentation": "

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    ", "smithy.api#required": {} } } @@ -7118,17 +7118,17 @@ "com.amazonaws.waf#TimeWindow": { "type": "structure", "members": { - "StartTime": { + "EndTime": { "target": "com.amazonaws.waf#Timestamp", "traits": { - "smithy.api#documentation": "

    The beginning of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", + "smithy.api#documentation": "

    The end of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", "smithy.api#required": {} } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.waf#Timestamp", "traits": { - "smithy.api#documentation": "

    The end of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", + "smithy.api#documentation": "

    The beginning of the time range from which you want GetSampledRequests to return a sample of the \n requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. \n UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". \n You can specify any time range in the previous three hours.

    ", "smithy.api#required": {} } } @@ -7178,15 +7178,15 @@ "com.amazonaws.waf#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.waf#TagKeyList", + "ResourceARN": { + "target": "com.amazonaws.waf#ResourceArn", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.waf#ResourceArn", + "TagKeys": { + "target": "com.amazonaws.waf#TagKeyList", "traits": { "smithy.api#documentation": "

    ", "smithy.api#required": {} @@ -7239,13 +7239,6 @@ "com.amazonaws.waf#UpdateByteMatchSetRequest": { "type": "structure", "members": { - "Updates": { - "target": "com.amazonaws.waf#ByteMatchSetUpdates", - "traits": { - "smithy.api#documentation": "

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n ByteMatchSetUpdate: Contains Action and ByteMatchTuple\n

      \n
      • \n
    • \n

      \n ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, \n\t\t\t\tand TextTransformation\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", - "smithy.api#required": {} - } - }, "ChangeToken": { "target": "com.amazonaws.waf#ChangeToken", "traits": { @@ -7259,6 +7252,13 @@ "smithy.api#documentation": "

    The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by \n\t\t\tListByteMatchSets.

    ", "smithy.api#required": {} } + }, + "Updates": { + "target": "com.amazonaws.waf#ByteMatchSetUpdates", + "traits": { + "smithy.api#documentation": "

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n ByteMatchSetUpdate: Contains Action and ByteMatchTuple\n

      \n
      • \n
    • \n

      \n ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, \n\t\t\t\tand TextTransformation\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", + "smithy.api#required": {} + } } } }, @@ -7317,6 +7317,13 @@ "com.amazonaws.waf#UpdateGeoMatchSetRequest": { "type": "structure", "members": { + "GeoMatchSetId": { + "target": "com.amazonaws.waf#ResourceId", + "traits": { + "smithy.api#documentation": "

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", + "smithy.api#required": {} + } + }, "Updates": { "target": "com.amazonaws.waf#GeoMatchSetUpdates", "traits": { @@ -7330,13 +7337,6 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } - }, - "GeoMatchSetId": { - "target": "com.amazonaws.waf#ResourceId", - "traits": { - "smithy.api#documentation": "

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by \n\t\t\tListGeoMatchSets.

    ", - "smithy.api#required": {} - } } } }, @@ -7395,17 +7395,17 @@ "com.amazonaws.waf#UpdateIPSetRequest": { "type": "structure", "members": { - "IPSetId": { - "target": "com.amazonaws.waf#ResourceId", + "Updates": { + "target": "com.amazonaws.waf#IPSetUpdates", "traits": { - "smithy.api#documentation": "

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by \n\t\t\tListIPSets.

    ", + "smithy.api#documentation": "

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t \n\t

    You can insert a maximum of 1000 addresses in a single request.

    ", "smithy.api#required": {} } }, - "Updates": { - "target": "com.amazonaws.waf#IPSetUpdates", + "IPSetId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. \n\t\t\tFor more information, see the applicable data types:

    \n\t\t \n\t

    You can insert a maximum of 1000 addresses in a single request.

    ", + "smithy.api#documentation": "

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by \n\t\t\tListIPSets.

    ", "smithy.api#required": {} } }, @@ -7473,10 +7473,10 @@ "com.amazonaws.waf#UpdateRateBasedRuleRequest": { "type": "structure", "members": { - "RateLimit": { - "target": "com.amazonaws.waf#RateLimit", + "Updates": { + "target": "com.amazonaws.waf#RuleUpdates", "traits": { - "smithy.api#documentation": "

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a\n five-minute period. If the number of requests exceeds the RateLimit and the other\n predicates specified in the rule are also met,\n AWS WAF triggers the action that is specified for this rule.

    ", + "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete\n from a RateBasedRule.

    ", "smithy.api#required": {} } }, @@ -7494,10 +7494,10 @@ "smithy.api#required": {} } }, - "Updates": { - "target": "com.amazonaws.waf#RuleUpdates", + "RateLimit": { + "target": "com.amazonaws.waf#RateLimit", "traits": { - "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete\n from a RateBasedRule.

    ", + "smithy.api#documentation": "

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a\n five-minute period. If the number of requests exceeds the RateLimit and the other\n predicates specified in the rule are also met,\n AWS WAF triggers the action that is specified for this rule.

    ", "smithy.api#required": {} } } @@ -7555,13 +7555,6 @@ "com.amazonaws.waf#UpdateRegexMatchSetRequest": { "type": "structure", "members": { - "RegexMatchSetId": { - "target": "com.amazonaws.waf#ResourceId", - "traits": { - "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", - "smithy.api#required": {} - } - }, "Updates": { "target": "com.amazonaws.waf#RegexMatchSetUpdates", "traits": { @@ -7575,6 +7568,13 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } + }, + "RegexMatchSetId": { + "target": "com.amazonaws.waf#ResourceId", + "traits": { + "smithy.api#documentation": "

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by \n\t\t\tListRegexMatchSets.

    ", + "smithy.api#required": {} + } } } }, @@ -7630,13 +7630,6 @@ "com.amazonaws.waf#UpdateRegexPatternSetRequest": { "type": "structure", "members": { - "Updates": { - "target": "com.amazonaws.waf#RegexPatternSetUpdates", - "traits": { - "smithy.api#documentation": "

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    ", - "smithy.api#required": {} - } - }, "RegexPatternSetId": { "target": "com.amazonaws.waf#ResourceId", "traits": { @@ -7650,6 +7643,13 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } + }, + "Updates": { + "target": "com.amazonaws.waf#RegexPatternSetUpdates", + "traits": { + "smithy.api#documentation": "

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    ", + "smithy.api#required": {} + } } } }, @@ -7750,17 +7750,17 @@ "smithy.api#required": {} } }, - "RuleGroupId": { - "target": "com.amazonaws.waf#ResourceId", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by \n ListRuleGroups.

    ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "RuleGroupId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by \n ListRuleGroups.

    ", "smithy.api#required": {} } } @@ -7780,10 +7780,10 @@ "com.amazonaws.waf#UpdateRuleRequest": { "type": "structure", "members": { - "Updates": { - "target": "com.amazonaws.waf#RuleUpdates", + "RuleId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete from a \n\t\t\tRule. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n RuleUpdate: Contains Action and Predicate\n

      \n
      • \n
    • \n

      \n Predicate: Contains DataId, Negated, and Type\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The RuleId of the Rule that you want to update. RuleId is returned by \n\t\t\tCreateRule and by ListRules.

    ", "smithy.api#required": {} } }, @@ -7794,10 +7794,10 @@ "smithy.api#required": {} } }, - "RuleId": { - "target": "com.amazonaws.waf#ResourceId", + "Updates": { + "target": "com.amazonaws.waf#RuleUpdates", "traits": { - "smithy.api#documentation": "

    The RuleId of the Rule that you want to update. RuleId is returned by \n\t\t\tCreateRule and by ListRules.

    ", + "smithy.api#documentation": "

    An array of RuleUpdate objects that you want to insert into or delete from a \n\t\t\tRule. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n RuleUpdate: Contains Action and Predicate\n

      \n
      • \n
    • \n

      \n Predicate: Contains DataId, Negated, and Type\n

      \n
      • \n
    • \n

      \n FieldToMatch: Contains Data and Type\n

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -7940,17 +7940,17 @@ "smithy.api#required": {} } }, - "Updates": { - "target": "com.amazonaws.waf#SqlInjectionMatchSetUpdates", + "ChangeToken": { + "target": "com.amazonaws.waf#ChangeToken", "traits": { - "smithy.api#documentation": "

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a \n\t\t\tSqlInjectionMatchSet. For more information, see the applicable data types:

    \n\t\t ", + "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } }, - "ChangeToken": { - "target": "com.amazonaws.waf#ChangeToken", + "Updates": { + "target": "com.amazonaws.waf#SqlInjectionMatchSetUpdates", "traits": { - "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", + "smithy.api#documentation": "

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a \n\t\t\tSqlInjectionMatchSet. For more information, see the applicable data types:

    \n\t\t ", "smithy.api#required": {} } } @@ -8020,23 +8020,17 @@ "com.amazonaws.waf#UpdateWebACLRequest": { "type": "structure", "members": { - "WebACLId": { - "target": "com.amazonaws.waf#ResourceId", - "traits": { - "smithy.api#documentation": "

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by \n\t\t\tListWebACLs.

    ", - "smithy.api#required": {} - } - }, "DefaultAction": { "target": "com.amazonaws.waf#WafAction", "traits": { "smithy.api#documentation": "

    A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default\n action if a request doesn't match the criteria in any of the rules in a web ACL.

    " } }, - "Updates": { - "target": "com.amazonaws.waf#WebACLUpdates", + "WebACLId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    An array of updates to make to the WebACL.

    \t\t\n\t\t

    An array of WebACLUpdate objects that you want to insert into or delete from a \n\t\t\tWebACL. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n WebACLUpdate: Contains Action and ActivatedRule\n

      \n
      • \n
    • \n

      \n ActivatedRule: Contains Action,\n OverrideAction, Priority, RuleId, and\n Type. ActivatedRule|OverrideAction applies only when\n updating or adding a RuleGroup to a WebACL. In this\n case,\n you do not use ActivatedRule|Action. For all other update requests,\n ActivatedRule|Action is used instead of\n ActivatedRule|OverrideAction.

      \n
      • \n
    • \n

      \n WafAction: Contains Type\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by \n\t\t\tListWebACLs.

    ", + "smithy.api#required": {} } }, "ChangeToken": { @@ -8045,6 +8039,12 @@ "smithy.api#documentation": "

    The value returned by the most recent call to GetChangeToken.

    ", "smithy.api#required": {} } + }, + "Updates": { + "target": "com.amazonaws.waf#WebACLUpdates", + "traits": { + "smithy.api#documentation": "

    An array of updates to make to the WebACL.

    \t\t\n\t\t

    An array of WebACLUpdate objects that you want to insert into or delete from a \n\t\t\tWebACL. For more information, see the applicable data types:

    \n\t\t
      \n
    • \n

      \n WebACLUpdate: Contains Action and ActivatedRule\n

      \n
      • \n
    • \n

      \n ActivatedRule: Contains Action,\n OverrideAction, Priority, RuleId, and\n Type. ActivatedRule|OverrideAction applies only when\n updating or adding a RuleGroup to a WebACL. In this\n case,\n you do not use ActivatedRule|Action. For all other update requests,\n ActivatedRule|Action is used instead of\n ActivatedRule|OverrideAction.

      \n
      • \n
    • \n

      \n WafAction: Contains Type\n

      \n
      • \n
    " + } } } }, @@ -8220,11 +8220,11 @@ "parameter": { "target": "com.amazonaws.waf#ParameterExceptionParameter" }, - "field": { - "target": "com.amazonaws.waf#ParameterExceptionField" - }, "reason": { "target": "com.amazonaws.waf#ParameterExceptionReason" + }, + "field": { + "target": "com.amazonaws.waf#ParameterExceptionField" } }, "traits": { @@ -8468,37 +8468,37 @@ "smithy.api#documentation": "

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    " } }, - "Rules": { - "target": "com.amazonaws.waf#ActivatedRules", + "WebACLId": { + "target": "com.amazonaws.waf#ResourceId", "traits": { - "smithy.api#documentation": "

    An array that contains the action for each Rule in a WebACL, the priority of the Rule, \n\t\t\tand the ID of the Rule.

    ", + "smithy.api#documentation": "

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL \n\t\t\t(see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF \n\t\t\t(see DeleteWebACL).

    \n\t\t

    \n WebACLId is returned by CreateWebACL and by ListWebACLs.

    ", "smithy.api#required": {} } }, - "WebACLArn": { - "target": "com.amazonaws.waf#ResourceArn", + "DefaultAction": { + "target": "com.amazonaws.waf#WafAction", "traits": { - "smithy.api#documentation": "

    Tha Amazon Resource Name (ARN) of the web ACL.

    " + "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the \n\t\t\tWafAction object.

    ", + "smithy.api#required": {} } }, - "MetricName": { - "target": "com.amazonaws.waf#MetricName", + "WebACLArn": { + "target": "com.amazonaws.waf#ResourceArn", "traits": { - "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " + "smithy.api#documentation": "

    Tha Amazon Resource Name (ARN) of the web ACL.

    " } }, - "DefaultAction": { - "target": "com.amazonaws.waf#WafAction", + "Rules": { + "target": "com.amazonaws.waf#ActivatedRules", "traits": { - "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the \n\t\t\tWafAction object.

    ", + "smithy.api#documentation": "

    An array that contains the action for each Rule in a WebACL, the priority of the Rule, \n\t\t\tand the ID of the Rule.

    ", "smithy.api#required": {} } }, - "WebACLId": { - "target": "com.amazonaws.waf#ResourceId", + "MetricName": { + "target": "com.amazonaws.waf#MetricName", "traits": { - "smithy.api#documentation": "

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL \n\t\t\t(see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF \n\t\t\t(see DeleteWebACL).

    \n\t\t

    \n WebACLId is returned by CreateWebACL and by ListWebACLs.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain\n whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " } } }, @@ -8565,13 +8565,6 @@ "com.amazonaws.waf#XssMatchSet": { "type": "structure", "members": { - "XssMatchTuples": { - "target": "com.amazonaws.waf#XssMatchTuples", - "traits": { - "smithy.api#documentation": "

    Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    ", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.waf#ResourceName", "traits": { @@ -8584,6 +8577,13 @@ "smithy.api#documentation": "

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an \n\t\t\tXssMatchSet (see GetXssMatchSet), update an XssMatchSet \n\t\t\t(see UpdateXssMatchSet), insert an XssMatchSet into a Rule or \n\t\t\tdelete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF \n\t\t\t(see DeleteXssMatchSet).

    \n\t\t

    \n XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    ", "smithy.api#required": {} } + }, + "XssMatchTuples": { + "target": "com.amazonaws.waf#XssMatchTuples", + "traits": { + "smithy.api#documentation": "

    Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -8654,17 +8654,17 @@ "com.amazonaws.waf#XssMatchTuple": { "type": "structure", "members": { - "FieldToMatch": { - "target": "com.amazonaws.waf#FieldToMatch", + "TextTransformation": { + "target": "com.amazonaws.waf#TextTransformation", "traits": { - "smithy.api#documentation": "

    Specifies where in a web request to look for cross-site scripting attacks.

    ", + "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \t\n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", "smithy.api#required": {} } }, - "TextTransformation": { - "target": "com.amazonaws.waf#TextTransformation", + "FieldToMatch": { + "target": "com.amazonaws.waf#FieldToMatch", "traits": { - "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. \n\t\t\tIf you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match.

    \t\n

    You can only specify a single type of TextTransformation.

    \t\t\t\n\t\t

    \n CMD_LINE\n

    \n\t\t

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n\t\t
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \t\t\n\t\t

    \n COMPRESS_WHITE_SPACE\n

    \n\t\t

    Use this option to replace the following characters with a space character (decimal 32):

    \n\t\t
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n\t\t

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n\t\t

    \n HTML_ENTITY_DECODE\n

    \n\t\t

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n\t\t\tthe following operations:

    \n\t\t
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n\t\t\t\tcharacters

      \n
      • \n
    \t\t\n\t\t

    \n LOWERCASE\n

    \n\t\t

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n\t\t

    \n URL_DECODE\n

    \n\t\t

    Use this option to decode a URL-encoded value.

    \t\t\n\t\t

    \n NONE\n

    \n\t\t

    Specify NONE if you don't want to perform any text transformations.

    ", + "smithy.api#documentation": "

    Specifies where in a web request to look for cross-site scripting attacks.

    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json b/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json index 1f677f696913..d9f0f157d276 100644 --- a/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json +++ b/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json @@ -165,7 +165,7 @@ "name": "wafv2" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "\n

    This is the latest version of the AWS WAF API, released in\n November, 2019. The names of the entities that you use to access this API, like\n endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\",\n to distinguish from the prior version. We recommend migrating your resources to this\n version, because it has a number of significant improvements.

    \n

    If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access\n any AWS WAF resources that you created before. You can access your old rules, web ACLs,\n and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic\n APIs have retained the prior names, endpoints, and namespaces.

    \n

    For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF\n Developer Guide.

    \n     \n

    AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n that are forwarded to Amazon CloudFront, an Amazon API Gateway API, or an Application Load\n Balancer. AWS WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, API Gateway, CloudFront, or the Application Load Balancer responds to requests\n either with the requested content or with an HTTP 403 status code (Forbidden). You also can\n configure CloudFront to return a custom error page when a request is blocked.

    \n

    This API guide is for developers who need detailed information about AWS WAF API\n actions, data types, and errors. For detailed information about AWS WAF features and an\n overview of how to use AWS WAF, see the AWS WAF Developer Guide.

    \n

    You can make calls using the endpoints listed in AWS Service Endpoints for AWS WAF.

    \n
      \n
    • \n

      For regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

      \n
      • \n
    • \n

      For AWS CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.

      \n
      • \n
    \n

    Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see AWS SDKs.

    \n

    We currently provide two versions of the AWS WAF API: this API and the prior versions,\n the classic AWS WAF APIs. This new API provides the same functionality as the older\n versions, with the following major improvements:

    \n
      \n
    • \n

      You use one API for both global and regional applications. Where you need to\n distinguish the scope, you specify a Scope parameter and set it to\n CLOUDFRONT or REGIONAL.

      \n
      • \n
    • \n

      You can define a Web ACL or rule group with a single call, and update it with a\n single call. You define all rule specifications in JSON format, and pass them to your\n rule group or Web ACL calls.

      \n
      • \n
    • \n

      The limits AWS WAF places on the use of rules more closely reflects the cost of\n running each type of rule. Rule groups include capacity settings, so you know the\n maximum cost of a rule group when you use it.

      \n
      • \n
    ", + "smithy.api#documentation": "\n

    This is the latest version of the AWS WAF API, released in\n November, 2019. The names of the entities that you use to access this API, like\n endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\",\n to distinguish from the prior version. We recommend migrating your resources to this\n version, because it has a number of significant improvements.

    \n

    If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access\n any AWS WAF resources that you created before. You can access your old rules, web ACLs,\n and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic\n APIs have retained the prior names, endpoints, and namespaces.

    \n

    For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF\n Developer Guide.

    \n     \n

    AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load\n Balancer, or an AWS AppSync GraphQL API. AWS WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the API Gateway REST API, CloudFront distribution, the Application Load Balancer, \n or the AWS AppSync GraphQL API responds to requests\n either with the requested content or with an HTTP 403 status code (Forbidden). You also can\n configure CloudFront to return a custom error page when a request is blocked.

    \n

    This API guide is for developers who need detailed information about AWS WAF API\n actions, data types, and errors. For detailed information about AWS WAF features and an\n overview of how to use AWS WAF, see the AWS WAF Developer Guide.

    \n

    You can make calls using the endpoints listed in AWS Service Endpoints for AWS WAF.

    \n
      \n
    • \n

      For regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      \n
      • \n
    • \n

      For AWS CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.

      \n
      • \n
    \n

    Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see AWS SDKs.

    \n

    We currently provide two versions of the AWS WAF API: this API and the prior versions,\n the classic AWS WAF APIs. This new API provides the same functionality as the older\n versions, with the following major improvements:

    \n
      \n
    • \n

      You use one API for both global and regional applications. Where you need to\n distinguish the scope, you specify a Scope parameter and set it to\n CLOUDFRONT or REGIONAL.

      \n
      • \n
    • \n

      You can define a Web ACL or rule group with a single call, and update it with a\n single call. You define all rule specifications in JSON format, and pass them to your\n rule group or Web ACL calls.

      \n
      • \n
    • \n

      The limits AWS WAF places on the use of rules more closely reflects the cost of\n running each type of rule. Rule groups include capacity settings, so you know the\n maximum cost of a rule group when you use it.

      \n
      • \n
    ", "smithy.api#title": "AWS WAFV2", "smithy.api#xmlNamespace": { "uri": "http://waf.amazonaws.com/doc/2019-07-29/" @@ -230,7 +230,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see UpdateDistribution.

    " + "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see UpdateDistribution.

    " } }, "com.amazonaws.wafv2#AssociateWebACLRequest": { @@ -246,7 +246,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

    \n \n

    The ARN must be in one of the following formats:

    \n
      \n
    • \n

      For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

      \n
      • \n
    • \n

      For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

    \n \n

    The ARN must be in one of the following formats:

    \n
      \n
    • \n

      For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

      \n
      • \n
    • \n

      For an API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

      \n
      • \n
    • \n

      For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -283,6 +283,13 @@ "smithy.api#required": {} } }, + "SearchString": { + "target": "com.amazonaws.wafv2#SearchString", + "traits": { + "smithy.api#documentation": "

    A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.

    \n

    Valid values depend on the component that you specify for inspection in FieldToMatch:

    \t\t\n
      \n
    • \n

      \n Method: The HTTP method that you want AWS WAF to search for. This indicates the type of operation specified in the request.

      \n
      • \n
    • \n

      \n UriPath: The value that you want AWS WAF to search for in the URI path,\n for example, /images/daily-ad.jpg.

      \n
      • \n
    \n \n

    If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    \n

    \n If you're using the AWS WAF API\n

    \n

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    \n

    For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n SearchString.

    \n

    \n If you're using the AWS CLI or one of the AWS SDKs\n

    \n

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    ", + "smithy.api#required": {} + } + }, "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { @@ -296,13 +303,6 @@ "smithy.api#documentation": "

    The area within the portion of a web request that you want AWS WAF to search for SearchString. Valid values include the following:

    \n

    \n CONTAINS\n

    \n

    The specified part of the web request must include the value of SearchString, but the location doesn't matter.

    \t\t\n

    \n CONTAINS_WORD\n

    \n

    The specified part of the web request must include the value of SearchString, and \n SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n SearchString must be a word, which means that both of the following are true:

    \n
      \n
    • \n

      \n SearchString is at the beginning of the specified part of the web request or is \n preceded by a character other than an alphanumeric character or underscore (_). \n Examples include the value of a header and ;BadBot.

      \n
      • \n
    • \n

      \n SearchString is at the end of the specified part of the web request or is \n followed by a character other than an alphanumeric character or underscore (_), for example,\n BadBot; and -BadBot;.

      \n
      • \n
    \n

    \n EXACTLY\n

    \n

    The value of the specified part of the web request must exactly match the value of SearchString.

    \n

    \n STARTS_WITH\n

    \n

    The value of SearchString must appear at the beginning of the specified part of the web request.

    \t\t\n

    \n ENDS_WITH\n

    \n

    The value of SearchString must appear at the end of the specified part of the web request.

    ", "smithy.api#required": {} } - }, - "SearchString": { - "target": "com.amazonaws.wafv2#SearchString", - "traits": { - "smithy.api#documentation": "

    A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.

    \n

    Valid values depend on the component that you specify for inspection in FieldToMatch:

    \t\t\n
      \n
    • \n

      \n Method: The HTTP method that you want AWS WAF to search for. This indicates the type of operation specified in the request.

      \n
      • \n
    • \n

      \n UriPath: The value that you want AWS WAF to search for in the URI path,\n for example, /images/daily-ad.jpg.

      \n
      • \n
    \n \n

    If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    \n

    \n If you're using the AWS WAF API\n

    \n

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    \n

    For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n SearchString.

    \n

    \n If you're using the AWS CLI or one of the AWS SDKs\n

    \n

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -355,17 +355,17 @@ "com.amazonaws.wafv2#CheckCapacityRequest": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.wafv2#Rules", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    An array of Rule that you're configuring to use in a rule group or web ACL.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Rules": { + "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    An array of Rule that you're configuring to use in a rule group or web ACL.

    ", "smithy.api#required": {} } } @@ -1486,18 +1486,17 @@ "com.amazonaws.wafv2#CreateIPSetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", "traits": { - "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    ", + "smithy.api#documentation": "

    Specify IPV4 or IPV6.

    ", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " } }, "Addresses": { @@ -1507,22 +1506,23 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    An array of key:value pairs to associate with the resource.

    " + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "Tags": { + "target": "com.amazonaws.wafv2#TagList", "traits": { - "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " + "smithy.api#documentation": "

    An array of key:value pairs to associate with the resource.

    " } }, - "IPAddressVersion": { - "target": "com.amazonaws.wafv2#IPAddressVersion", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    Specify IPV4 or IPV6.

    ", + "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    ", "smithy.api#required": {} } } @@ -1580,19 +1580,13 @@ "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

    An array of key:value pairs to associate with the resource.

    " - } - }, "RegularExpressionList": { "target": "com.amazonaws.wafv2#RegularExpressionList", "traits": { @@ -1600,18 +1594,24 @@ "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", - "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", - "smithy.api#required": {} - } - }, "Description": { "target": "com.amazonaws.wafv2#EntityDescription", "traits": { "smithy.api#documentation": "

    A description of the set that helps with identification. You cannot change the description of a set after you create it.

    " } + }, + "Tags": { + "target": "com.amazonaws.wafv2#TagList", + "traits": { + "smithy.api#documentation": "

    An array of key:value pairs to associate with the resource.

    " + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    ", + "smithy.api#required": {} + } } } }, @@ -1679,27 +1679,21 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.wafv2#TagList", - "traits": { - "smithy.api#documentation": "

    An array of key:value pairs to associate with the resource.

    " - } - }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    " + "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", + "smithy.api#required": {} } }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", + "Tags": { + "target": "com.amazonaws.wafv2#TagList", "traits": { - "smithy.api#documentation": "

    The web ACL capacity units (WCUs) required for this rule group.

    \n

    When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

    \n

    AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    An array of key:value pairs to associate with the resource.

    " } }, "VisibilityConfig": { @@ -1709,18 +1703,24 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", - "smithy.api#required": {} - } - }, "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    " + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#documentation": "

    The web ACL capacity units (WCUs) required for this rule group.

    \n

    When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

    \n

    AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

    ", + "smithy.api#required": {} + } } } }, @@ -1782,19 +1782,12 @@ } ], "traits": { - "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Creates a WebACL per the specifications provided.

    \n

    A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.

    " + "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Creates a WebACL per the specifications provided.

    \n

    A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

    " } }, "com.amazonaws.wafv2#CreateWebACLRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", - "smithy.api#required": {} - } - }, "VisibilityConfig": { "target": "com.amazonaws.wafv2#VisibilityConfig", "traits": { @@ -1802,17 +1795,23 @@ "smithy.api#required": {} } }, - "DefaultAction": { - "target": "com.amazonaws.wafv2#DefaultAction", + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match.

    ", + "smithy.api#documentation": "

    A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

    " + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "Rules": { + "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

    A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

    " + "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " } }, "Tags": { @@ -1824,14 +1823,15 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", "traits": { - "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " + "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match.

    ", + "smithy.api#required": {} } } } @@ -1967,17 +1967,17 @@ "com.amazonaws.wafv2#DeleteIPSetRequest": { "type": "structure", "members": { - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", + "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -1988,10 +1988,10 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", "smithy.api#required": {} } } @@ -2126,31 +2126,31 @@ "com.amazonaws.wafv2#DeleteRegexPatternSetRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    ", + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", "smithy.api#required": {} } }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    ", "smithy.api#required": {} } } @@ -2208,10 +2208,17 @@ "smithy.api#required": {} } }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#required": {} + } + }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -2221,13 +2228,6 @@ "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", "smithy.api#required": {} } - }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", - "traits": { - "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", - "smithy.api#required": {} - } } } }, @@ -2283,6 +2283,13 @@ "smithy.api#required": {} } }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", + "smithy.api#required": {} + } + }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { @@ -2293,14 +2300,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -2342,17 +2342,10 @@ "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

    ", - "smithy.api#required": {} - } - }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -2362,6 +2355,13 @@ "smithy.api#documentation": "

    The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

    ", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

    ", + "smithy.api#required": {} + } } } }, @@ -2405,7 +2405,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

    " + "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

    " } }, "com.amazonaws.wafv2#DisassociateWebACLRequest": { @@ -2414,7 +2414,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

    \n \n

    The ARN must be in one of the following formats:

    \n
      \n
    • \n

      For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

      \n
      • \n
    • \n

      For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

      \n
      • \n
    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

    \n \n

    The ARN must be in one of the following formats:

    \n
      \n
    • \n

      For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

      \n
      • \n
    • \n

      For an API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

      \n
      • \n
    • \n

      For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -2505,22 +2505,16 @@ "smithy.api#documentation": "

    Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any \n additional data that you want to send to your web server as the HTTP request body, such as data from a form.

    \n

    Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

    " } }, - "AllQueryArguments": { - "target": "com.amazonaws.wafv2#AllQueryArguments", - "traits": { - "smithy.api#documentation": "

    Inspect all query arguments.

    " - } - }, - "Method": { - "target": "com.amazonaws.wafv2#Method", + "SingleQueryArgument": { + "target": "com.amazonaws.wafv2#SingleQueryArgument", "traits": { - "smithy.api#documentation": "

    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

    " + "smithy.api#documentation": "

    Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

    \n

    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

    " } }, - "UriPath": { - "target": "com.amazonaws.wafv2#UriPath", + "AllQueryArguments": { + "target": "com.amazonaws.wafv2#AllQueryArguments", "traits": { - "smithy.api#documentation": "

    Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

    " + "smithy.api#documentation": "

    Inspect all query arguments.

    " } }, "QueryString": { @@ -2535,10 +2529,16 @@ "smithy.api#documentation": "

    Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

    " } }, - "SingleQueryArgument": { - "target": "com.amazonaws.wafv2#SingleQueryArgument", + "Method": { + "target": "com.amazonaws.wafv2#Method", "traits": { - "smithy.api#documentation": "

    Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

    \n

    This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

    " + "smithy.api#documentation": "

    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

    " + } + }, + "UriPath": { + "target": "com.amazonaws.wafv2#UriPath", + "traits": { + "smithy.api#documentation": "

    Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

    " } } }, @@ -2559,24 +2559,23 @@ "com.amazonaws.wafv2#FirewallManagerRuleGroup": { "type": "structure", "members": { - "Priority": { - "target": "com.amazonaws.wafv2#RulePriority", + "FirewallManagerStatement": { + "target": "com.amazonaws.wafv2#FirewallManagerStatement", "traits": { - "smithy.api#documentation": "

    If you define more than one rule group in the first or last Firewall Manager rule groups,\n AWS WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. \n The priorities don't need to be consecutive, but they must all be different.

    ", + "smithy.api#documentation": "

    The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

    ", "smithy.api#required": {} } }, - "FirewallManagerStatement": { - "target": "com.amazonaws.wafv2#FirewallManagerStatement", + "Priority": { + "target": "com.amazonaws.wafv2#RulePriority", "traits": { - "smithy.api#documentation": "

    The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

    ", + "smithy.api#documentation": "

    If you define more than one rule group in the first or last Firewall Manager rule groups,\n AWS WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. \n The priorities don't need to be consecutive, but they must all be different.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "OverrideAction": { + "target": "com.amazonaws.wafv2#OverrideAction", "traits": { - "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", "smithy.api#required": {} } }, @@ -2586,9 +2585,10 @@ "smithy.api#required": {} } }, - "OverrideAction": { - "target": "com.amazonaws.wafv2#OverrideAction", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { + "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", "smithy.api#required": {} } } @@ -2620,17 +2620,17 @@ "com.amazonaws.wafv2#ForwardedIPConfig": { "type": "structure", "members": { - "HeaderName": { - "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "FallbackBehavior": { + "target": "com.amazonaws.wafv2#FallbackBehavior", "traits": { - "smithy.api#documentation": "

    The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     ", + "smithy.api#documentation": "

    The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     \n \n

    You can specify the following fallback behaviors:

    \n
      \n
    • \n

      MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.

      \n
      • \n
    • \n

      NO_MATCH - Treat the web request as not matching the rule statement.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "FallbackBehavior": { - "target": "com.amazonaws.wafv2#FallbackBehavior", + "HeaderName": { + "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", "traits": { - "smithy.api#documentation": "

    The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     \n \n

    You can specify the following fallback behaviors:

    \n
      \n
    • \n

      MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.

      \n
      • \n
    • \n

      NO_MATCH - Treat the web request as not matching the rule statement.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     ", "smithy.api#required": {} } } @@ -2724,17 +2724,17 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    ", "smithy.api#required": {} } } @@ -2881,17 +2881,17 @@ "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { "type": "structure", "members": { - "RuleName": { - "target": "com.amazonaws.wafv2#EntityName", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The name of the rate-based rule to get the keys for.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "WebACLName": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", "smithy.api#required": {} } }, @@ -2902,10 +2902,10 @@ "smithy.api#required": {} } }, - "WebACLName": { + "RuleName": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", + "smithy.api#documentation": "

    The name of the rate-based rule to get the keys for.

    ", "smithy.api#required": {} } } @@ -2960,21 +2960,21 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    ", + "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    ", "smithy.api#required": {} } } @@ -3026,24 +3026,24 @@ "com.amazonaws.wafv2#GetRuleGroupRequest": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } } @@ -3099,10 +3099,10 @@ "smithy.api#required": {} } }, - "TimeWindow": { - "target": "com.amazonaws.wafv2#TimeWindow", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -3120,10 +3120,10 @@ "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "TimeWindow": { + "target": "com.amazonaws.wafv2#TimeWindow", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", "smithy.api#required": {} } } @@ -3138,17 +3138,17 @@ "smithy.api#documentation": "

    Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. \n However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, \n GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

    " } }, - "PopulationSize": { - "target": "com.amazonaws.wafv2#PopulationSize", - "traits": { - "smithy.api#documentation": "

    The total number of requests from which GetSampledRequests got a sample of MaxItems requests. \n If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource \n received during the specified time range.

    " - } - }, "SampledRequests": { "target": "com.amazonaws.wafv2#SampledHTTPRequests", "traits": { "smithy.api#documentation": "

    A complex type that contains detailed information about each of the requests in the sample.

    " } + }, + "PopulationSize": { + "target": "com.amazonaws.wafv2#PopulationSize", + "traits": { + "smithy.api#documentation": "

    The total number of requests from which GetSampledRequests got a sample of MaxItems requests. \n If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource \n received during the specified time range.

    " + } } } }, @@ -3243,7 +3243,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -3259,17 +3259,17 @@ "com.amazonaws.wafv2#GetWebACLResponse": { "type": "structure", "members": { - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " - } - }, "WebACL": { "target": "com.amazonaws.wafv2#WebACL", "traits": { "smithy.api#documentation": "

    The Web ACL specification. You can modify the settings in this Web ACL and use it to update this Web ACL or create a new one.

    " } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " + } } } }, @@ -3305,22 +3305,22 @@ "com.amazonaws.wafv2#HTTPRequest": { "type": "structure", "members": { - "Method": { - "target": "com.amazonaws.wafv2#HTTPMethod", + "URI": { + "target": "com.amazonaws.wafv2#URIString", "traits": { - "smithy.api#documentation": "

    The HTTP method specified in the sampled web request.

    " + "smithy.api#documentation": "

    The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

    " } }, - "Country": { - "target": "com.amazonaws.wafv2#Country", + "Method": { + "target": "com.amazonaws.wafv2#HTTPMethod", "traits": { - "smithy.api#documentation": "

    The two-letter country code for the country that the request originated from. For a current list of country codes, \n see the Wikipedia entry ISO 3166-1 alpha-2.

    " + "smithy.api#documentation": "

    The HTTP method specified in the sampled web request.

    " } }, - "Headers": { - "target": "com.amazonaws.wafv2#HTTPHeaders", + "HTTPVersion": { + "target": "com.amazonaws.wafv2#HTTPVersion", "traits": { - "smithy.api#documentation": "

    A complex type that contains the name and value for each header in the sampled web request.

    " + "smithy.api#documentation": "

    The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    " } }, "ClientIP": { @@ -3329,16 +3329,16 @@ "smithy.api#documentation": "

    The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, \n this is the value of one of the following fields in CloudFront access logs:

    \n
      \n
    • \n

      \n c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

      \n
      • \n
    • \n

      \n x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

      \n
      • \n
    " } }, - "HTTPVersion": { - "target": "com.amazonaws.wafv2#HTTPVersion", + "Headers": { + "target": "com.amazonaws.wafv2#HTTPHeaders", "traits": { - "smithy.api#documentation": "

    The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    " + "smithy.api#documentation": "

    A complex type that contains the name and value for each header in the sampled web request.

    " } }, - "URI": { - "target": "com.amazonaws.wafv2#URIString", + "Country": { + "target": "com.amazonaws.wafv2#Country", "traits": { - "smithy.api#documentation": "

    The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

    " + "smithy.api#documentation": "

    The two-letter country code for the country that the request originated from. For a current list of country codes, \n see the Wikipedia entry ISO 3166-1 alpha-2.

    " } } }, @@ -3389,13 +3389,6 @@ "com.amazonaws.wafv2#IPSet": { "type": "structure", "members": { - "IPAddressVersion": { - "target": "com.amazonaws.wafv2#IPAddressVersion", - "traits": { - "smithy.api#documentation": "

    Specify IPV4 or IPV6.

    ", - "smithy.api#required": {} - } - }, "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { @@ -3403,16 +3396,10 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "IPAddressVersion": { + "target": "com.amazonaws.wafv2#IPAddressVersion", "traits": { - "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    ", + "smithy.api#documentation": "

    Specify IPV4 or IPV6.

    ", "smithy.api#required": {} } }, @@ -3429,6 +3416,19 @@ "smithy.api#documentation": "

    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

    \n

    Examples:

    \n
      \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

      \n
      • \n
    \n

    For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

    ", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " + } } }, "traits": { @@ -3438,17 +3438,17 @@ "com.amazonaws.wafv2#IPSetForwardedIPConfig": { "type": "structure", "members": { - "HeaderName": { - "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", + "FallbackBehavior": { + "target": "com.amazonaws.wafv2#FallbackBehavior", "traits": { - "smithy.api#documentation": "

    The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     ", + "smithy.api#documentation": "

    The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     \n \n

    You can specify the following fallback behaviors:

    \n
      \n
    • \n

      MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.

      \n
      • \n
    • \n

      NO_MATCH - Treat the web request as not matching the rule statement.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "FallbackBehavior": { - "target": "com.amazonaws.wafv2#FallbackBehavior", + "HeaderName": { + "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", "traits": { - "smithy.api#documentation": "

    The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     \n \n

    You can specify the following fallback behaviors:

    \n
      \n
    • \n

      MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.

      \n
      • \n
    • \n

      NO_MATCH - Treat the web request as not matching the rule statement.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

    \n \n \n

    If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

    \n     ", "smithy.api#required": {} } }, @@ -3494,34 +3494,34 @@ "com.amazonaws.wafv2#IPSetSummary": { "type": "structure", "members": { - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    " } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " + "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    " + "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " } }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    " + "smithy.api#documentation": "

    The name of the IP set. You cannot change the name of an IPSet after you create it.

    " } } }, @@ -3561,7 +3561,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -3582,17 +3582,17 @@ "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsResponse": { "type": "structure", "members": { - "ManagedRuleGroups": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupSummaries", - "traits": { - "smithy.api#documentation": "

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } + }, + "ManagedRuleGroups": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupSummaries", + "traits": { + "smithy.api#documentation": "

    " + } } } }, @@ -3622,10 +3622,11 @@ "com.amazonaws.wafv2#ListIPSetsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#required": {} } }, "NextMarker": { @@ -3634,11 +3635,10 @@ "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " } } } @@ -3646,17 +3646,17 @@ "com.amazonaws.wafv2#ListIPSetsResponse": { "type": "structure", "members": { - "IPSets": { - "target": "com.amazonaws.wafv2#IPSetSummaries", - "traits": { - "smithy.api#documentation": "

    Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } + }, + "IPSets": { + "target": "com.amazonaws.wafv2#IPSetSummaries", + "traits": { + "smithy.api#documentation": "

    Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

    " + } } } }, @@ -3686,10 +3686,10 @@ "com.amazonaws.wafv2#ListLoggingConfigurationsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    " } }, "NextMarker": { @@ -3698,10 +3698,10 @@ "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    " + "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " } } } @@ -3709,17 +3709,17 @@ "com.amazonaws.wafv2#ListLoggingConfigurationsResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " - } - }, "LoggingConfigurations": { "target": "com.amazonaws.wafv2#LoggingConfigurations", "traits": { "smithy.api#documentation": "

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " + } } } }, @@ -3758,11 +3758,10 @@ "com.amazonaws.wafv2#ListRegexPatternSetsRequest": { "type": "structure", "members": { - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } }, "Limit": { @@ -3771,10 +3770,11 @@ "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#required": {} } } } @@ -3835,7 +3835,7 @@ "ResourceType": { "target": "com.amazonaws.wafv2#ResourceType", "traits": { - "smithy.api#documentation": "

    Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    " + "smithy.api#documentation": "

    Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    " } } } @@ -3880,38 +3880,38 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " - } - }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " + } } } }, "com.amazonaws.wafv2#ListRuleGroupsResponse": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " - } - }, "RuleGroups": { "target": "com.amazonaws.wafv2#RuleGroupSummaries", "traits": { "smithy.api#documentation": "

    " } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " + } } } }, @@ -3956,35 +3956,35 @@ "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " } }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " + } + }, "ResourceARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", "smithy.api#required": {} } - }, - "NextMarker": { - "target": "com.amazonaws.wafv2#NextMarker", - "traits": { - "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " - } } } }, "com.amazonaws.wafv2#ListTagsForResourceResponse": { "type": "structure", "members": { - "TagInfoForResource": { - "target": "com.amazonaws.wafv2#TagInfoForResource", - "traits": { - "smithy.api#documentation": "

    The collection of tagging definitions for the resource.

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } + }, + "TagInfoForResource": { + "target": "com.amazonaws.wafv2#TagInfoForResource", + "traits": { + "smithy.api#documentation": "

    The collection of tagging definitions for the resource.

    " + } } } }, @@ -4014,10 +4014,11 @@ "com.amazonaws.wafv2#ListWebACLsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.wafv2#PaginationLimit", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#required": {} } }, "NextMarker": { @@ -4026,11 +4027,10 @@ "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

    " } } } @@ -4038,17 +4038,17 @@ "com.amazonaws.wafv2#ListWebACLsResponse": { "type": "structure", "members": { - "WebACLs": { - "target": "com.amazonaws.wafv2#WebACLSummaries", - "traits": { - "smithy.api#documentation": "

    " - } - }, "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { "smithy.api#documentation": "

    When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    " } + }, + "WebACLs": { + "target": "com.amazonaws.wafv2#WebACLSummaries", + "traits": { + "smithy.api#documentation": "

    " + } } } }, @@ -4077,6 +4077,12 @@ "com.amazonaws.wafv2#LoggingConfiguration": { "type": "structure", "members": { + "RedactedFields": { + "target": "com.amazonaws.wafv2#RedactedFields", + "traits": { + "smithy.api#documentation": "

    The parts of the request that you want to keep out of the logs. For\n example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

    \n \n

    You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.

    \n     " + } + }, "LogDestinationConfigs": { "target": "com.amazonaws.wafv2#LogDestinationConfigs", "traits": { @@ -4084,10 +4090,10 @@ "smithy.api#required": {} } }, - "RedactedFields": { - "target": "com.amazonaws.wafv2#RedactedFields", + "ManagedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

    The parts of the request that you want to keep out of the logs. For\n example, if you redact the cookie field, the cookie field in the firehose will be\n xxx.

    " + "smithy.api#documentation": "

    Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only \n Firewall Manager can modify or delete the configuration.

    " } }, "ResourceArn": { @@ -4453,8 +4459,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1 - } + "min": 1, + "max": 395000 + }, + "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.wafv2#PopulationSize": { @@ -4705,16 +4713,10 @@ "com.amazonaws.wafv2#RegexPatternSet": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    " - } - }, - "RegularExpressionList": { - "target": "com.amazonaws.wafv2#RegularExpressionList", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The regular expression patterns in the set.

    " + "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " } }, "Description": { @@ -4723,10 +4725,10 @@ "smithy.api#documentation": "

    A description of the set that helps with identification. You cannot change the description of a set after you create it.

    " } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", "traits": { - "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " + "smithy.api#documentation": "

    The regular expression patterns in the set.

    " } }, "ARN": { @@ -4734,6 +4736,12 @@ "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    " } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the set. You cannot change the name after you create the set.

    " + } } }, "traits": { @@ -4750,17 +4758,17 @@ "smithy.api#required": {} } }, - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

    ", + "smithy.api#documentation": "

    The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

    ", "smithy.api#required": {} } }, - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

    The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

    ", + "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

    ", "smithy.api#required": {} } } @@ -4784,6 +4792,12 @@ "smithy.api#documentation": "

    The name of the data type instance. You cannot change the name after you create the instance.

    " } }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " + } + }, "ARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { @@ -4801,12 +4815,6 @@ "traits": { "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " } - }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " - } } }, "traits": { @@ -4856,6 +4864,10 @@ { "value": "API_GATEWAY", "name": "API_GATEWAY" + }, + { + "value": "APPSYNC", + "name": "APPSYNC" } ] } @@ -4876,19 +4888,6 @@ "smithy.api#documentation": "

    The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

    \n

    This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

    \n

    You must specify either this Action setting or the rule OverrideAction setting, but not both:

    \n
      \n
    • \n

      If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

      \n
      • \n
    • \n

      If the rule statement references a rule group, use the override action setting and not this action setting.

      \n
      • \n
    " } }, - "OverrideAction": { - "target": "com.amazonaws.wafv2#OverrideAction", - "traits": { - "smithy.api#documentation": "

    The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, \n like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

    \n

    Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

    \n

    In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

    \n
      \n
    • \n

      If the rule statement references a rule group, use this override action setting and not the action setting.

      \n
      • \n
    • \n

      If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

      \n
      • \n
    " - } - }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the rule. You can't change the name of a Rule after you create it.

    ", - "smithy.api#required": {} - } - }, "Statement": { "target": "com.amazonaws.wafv2#Statement", "traits": { @@ -4896,12 +4895,25 @@ "smithy.api#required": {} } }, + "OverrideAction": { + "target": "com.amazonaws.wafv2#OverrideAction", + "traits": { + "smithy.api#documentation": "

    The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, \n like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

    \n

    Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

    \n

    In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

    \n
      \n
    • \n

      If the rule statement references a rule group, use this override action setting and not the action setting.

      \n
      • \n
    • \n

      If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

      \n
      • \n
    " + } + }, "VisibilityConfig": { "target": "com.amazonaws.wafv2#VisibilityConfig", "traits": { "smithy.api#documentation": "

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    ", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the rule. You can't change the name of a Rule after you create it.

    ", + "smithy.api#required": {} + } } }, "traits": { @@ -4937,10 +4949,17 @@ "com.amazonaws.wafv2#RuleGroup": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", "traits": { - "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#documentation": "

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    ", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#documentation": "

    The web ACL capacity units (WCUs) required for this rule group.

    \n

    When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

    \n

    AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

    ", "smithy.api#required": {} } }, @@ -4951,10 +4970,10 @@ "smithy.api#required": {} } }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    ", + "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", "smithy.api#required": {} } }, @@ -4964,10 +4983,10 @@ "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", "smithy.api#required": {} } }, @@ -4976,13 +4995,6 @@ "traits": { "smithy.api#documentation": "

    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    " } - }, - "Capacity": { - "target": "com.amazonaws.wafv2#CapacityUnit", - "traits": { - "smithy.api#documentation": "

    The web ACL capacity units (WCUs) required for this rule group.

    \n

    When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

    \n

    AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -4992,18 +5004,18 @@ "com.amazonaws.wafv2#RuleGroupReferenceStatement": { "type": "structure", "members": { + "ExcludedRules": { + "target": "com.amazonaws.wafv2#ExcludedRules", + "traits": { + "smithy.api#documentation": "

    The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

    " + } + }, "ARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    ", "smithy.api#required": {} } - }, - "ExcludedRules": { - "target": "com.amazonaws.wafv2#ExcludedRules", - "traits": { - "smithy.api#documentation": "

    The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

    " - } } }, "traits": { @@ -5019,22 +5031,22 @@ "com.amazonaws.wafv2#RuleGroupSummary": { "type": "structure", "members": { - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", - "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " - } - }, "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    " + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " } }, "Name": { @@ -5043,10 +5055,10 @@ "smithy.api#documentation": "

    The name of the data type instance. You cannot change the name after you create the instance.

    " } }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    " + "smithy.api#documentation": "

    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    " } } }, @@ -5071,14 +5083,14 @@ "com.amazonaws.wafv2#RuleSummary": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.wafv2#RuleAction" - }, "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { "smithy.api#documentation": "

    The name of the rule.

    " } + }, + "Action": { + "target": "com.amazonaws.wafv2#RuleAction" } }, "traits": { @@ -5102,11 +5114,16 @@ "com.amazonaws.wafv2#SampledHTTPRequest": { "type": "structure", "members": { - "Request": { - "target": "com.amazonaws.wafv2#HTTPRequest", + "Timestamp": { + "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

    A complex type that contains detailed information about the request.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " + } + }, + "RuleNameWithinRuleGroup": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

    The name of the Rule that the request matched. For managed rule groups, the format for this name is ##. For your own rule\n groups, the format for this name is #. If the rule is not in a rule group, this field is absent.

    " } }, "Action": { @@ -5122,16 +5139,11 @@ "smithy.api#required": {} } }, - "RuleNameWithinRuleGroup": { - "target": "com.amazonaws.wafv2#EntityName", - "traits": { - "smithy.api#documentation": "

    The name of the Rule that the request matched. For managed rule groups, the format for this name is ##. For your own rule\n groups, the format for this name is \n #. If the rule is not in a rule group, the format is .

    " - } - }, - "Timestamp": { - "target": "com.amazonaws.wafv2#Timestamp", + "Request": { + "target": "com.amazonaws.wafv2#HTTPRequest", "traits": { - "smithy.api#documentation": "

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " + "smithy.api#documentation": "

    A complex type that contains detailed information about the request.

    ", + "smithy.api#required": {} } } }, @@ -5269,16 +5281,22 @@ "smithy.api#documentation": "

    A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

    \n

    You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

    " } }, + "ByteMatchStatement": { + "target": "com.amazonaws.wafv2#ByteMatchStatement", + "traits": { + "smithy.api#documentation": "

    A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.

    " + } + }, "RuleGroupReferenceStatement": { "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", "traits": { "smithy.api#documentation": "

    A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

    \n

    You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

    " } }, - "ByteMatchStatement": { - "target": "com.amazonaws.wafv2#ByteMatchStatement", + "RegexPatternSetReferenceStatement": { + "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", "traits": { - "smithy.api#documentation": "

    A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.

    " + "smithy.api#documentation": "

    A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

    \n

    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

    " } }, "AndStatement": { @@ -5287,10 +5305,10 @@ "smithy.api#documentation": "

    A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

    " } }, - "RateBasedStatement": { - "target": "com.amazonaws.wafv2#RateBasedStatement", + "OrStatement": { + "target": "com.amazonaws.wafv2#OrStatement", "traits": { - "smithy.api#documentation": "

    A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

    \n

    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

    \n

    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

    \n
      \n
    • \n

      An IP match statement with an IP set that specified the address 192.0.2.44.

      \n
      • \n
    • \n

      A string match statement that searches in the User-Agent header for the string BadBot.

      \n
      • \n
    \n

    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

    \n

    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

    " + "smithy.api#documentation": "

    A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

    " } }, "NotStatement": { @@ -5299,16 +5317,22 @@ "smithy.api#documentation": "

    A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

    " } }, + "RateBasedStatement": { + "target": "com.amazonaws.wafv2#RateBasedStatement", + "traits": { + "smithy.api#documentation": "

    A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

    \n

    When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

    \n

    You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

    \n
      \n
    • \n

      An IP match statement with an IP set that specified the address 192.0.2.44.

      \n
      • \n
    • \n

      A string match statement that searches in the User-Agent header for the string BadBot.

      \n
      • \n
    \n

    In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

    \n

    You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

    " + } + }, "GeoMatchStatement": { "target": "com.amazonaws.wafv2#GeoMatchStatement", "traits": { "smithy.api#documentation": "

    A rule statement used to identify web requests based on country of origin.

    " } }, - "OrStatement": { - "target": "com.amazonaws.wafv2#OrStatement", + "SizeConstraintStatement": { + "target": "com.amazonaws.wafv2#SizeConstraintStatement", "traits": { - "smithy.api#documentation": "

    A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

    " + "smithy.api#documentation": "

    A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

    \n

    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

    \n

    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

    " } }, "SqliMatchStatement": { @@ -5317,12 +5341,6 @@ "smithy.api#documentation": "

    Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

    " } }, - "RegexPatternSetReferenceStatement": { - "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", - "traits": { - "smithy.api#documentation": "

    A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

    \n

    Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

    " - } - }, "IPSetReferenceStatement": { "target": "com.amazonaws.wafv2#IPSetReferenceStatement", "traits": { @@ -5334,12 +5352,6 @@ "traits": { "smithy.api#documentation": "

    A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. \n XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious \n client-site scripts into other legitimate web browsers. \n The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations \n to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

    " } - }, - "SizeConstraintStatement": { - "target": "com.amazonaws.wafv2#SizeConstraintStatement", - "traits": { - "smithy.api#documentation": "

    A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

    \n

    If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

    \n

    If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

    " - } } }, "traits": { @@ -5355,17 +5367,17 @@ "com.amazonaws.wafv2#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.wafv2#TagValue", + "Key": { + "target": "com.amazonaws.wafv2#TagKey", "traits": { - "smithy.api#documentation": "

    Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

    ", + "smithy.api#documentation": "

    Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.

    ", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.wafv2#TagKey", + "Value": { + "target": "com.amazonaws.wafv2#TagValue", "traits": { - "smithy.api#documentation": "

    Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.

    ", + "smithy.api#documentation": "

    Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

    ", "smithy.api#required": {} } } @@ -5401,7 +5413,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.wafv2#TagKeyList": { @@ -5491,23 +5503,23 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": ".*" + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.wafv2#TextTransformation": { "type": "structure", "members": { - "Priority": { - "target": "com.amazonaws.wafv2#TextTransformationPriority", + "Type": { + "target": "com.amazonaws.wafv2#TextTransformationType", "traits": { - "smithy.api#documentation": "

    Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all\n transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

    ", + "smithy.api#documentation": "

    You can specify the following transformation types:

    \n

    \n CMD_LINE\n

    \n

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \n \n

    \n COMPRESS_WHITE_SPACE\n

    \n

    Use this option to replace the following characters with a space character (decimal 32):

    \n
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n

    \n HTML_ENTITY_DECODE\n

    \n

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n the following operations:

    \n
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n characters

      \n
      • \n
    \t\t\n

    \n LOWERCASE\n

    \n

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n

    \n URL_DECODE\n

    \n

    Use this option to decode a URL-encoded value.

    \t\t\n

    \n NONE\n

    \n

    Specify NONE if you don't want any text transformations.

    ", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.wafv2#TextTransformationType", + "Priority": { + "target": "com.amazonaws.wafv2#TextTransformationPriority", "traits": { - "smithy.api#documentation": "

    You can specify the following transformation types:

    \n

    \n CMD_LINE\n

    \n

    When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

    \n
      \n
    • \n

      Delete the following characters: \\ \" ' ^

      \n
      • \n
    • \n

      Delete spaces before the following characters: / (

      \n
      • \n
    • \n

      Replace the following characters with a space: , ;

      \n
      • \n
    • \n

      Replace multiple spaces with one space

      \n
      • \n
    • \n

      Convert uppercase letters (A-Z) to lowercase (a-z)

      \n
      • \n
    \n \n

    \n COMPRESS_WHITE_SPACE\n

    \n

    Use this option to replace the following characters with a space character (decimal 32):

    \n
      \n
    • \n

      \\f, formfeed, decimal 12

      \n
      • \n
    • \n

      \\t, tab, decimal 9

      \n
      • \n
    • \n

      \\n, newline, decimal 10

      \n
      • \n
    • \n

      \\r, carriage return, decimal 13

      \n
      • \n
    • \n

      \\v, vertical tab, decimal 11

      \n
      • \n
    • \n

      non-breaking space, decimal 160

      \n
      • \n
    \n

    \n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    \t\t\n

    \n HTML_ENTITY_DECODE\n

    \n

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n the following operations:

    \n
      \n
    • \n

      Replaces (ampersand)quot; with \"\n

      \n
      • \n
    • \n

      Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

      \n
      • \n
    • \n

      Replaces (ampersand)lt; with a \"less than\" symbol

      \n
      • \n
    • \n

      Replaces (ampersand)gt; with >\n

      \n
      • \n
    • \n

      Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

      \n
      • \n
    • \n

      Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n characters

      \n
      • \n
    \t\t\n

    \n LOWERCASE\n

    \n

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    \t\t\n

    \n URL_DECODE\n

    \n

    Use this option to decode a URL-encoded value.

    \t\t\n

    \n NONE\n

    \n

    Specify NONE if you don't want any text transformations.

    ", + "smithy.api#documentation": "

    Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all\n transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

    ", "smithy.api#required": {} } } @@ -5569,17 +5581,17 @@ "com.amazonaws.wafv2#TimeWindow": { "type": "structure", "members": { - "StartTime": { + "EndTime": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your \n AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", + "smithy.api#documentation": "

    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your \n AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", "smithy.api#required": {} } }, - "EndTime": { + "StartTime": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your \n AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", + "smithy.api#documentation": "

    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your \n AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    ", "smithy.api#required": {} } } @@ -5687,10 +5699,11 @@ "com.amazonaws.wafv2#UpdateIPSetRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "Addresses": { + "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " + "smithy.api#documentation": "

    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

    \n

    Examples:

    \n
      \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

      \n
      • \n
    \n

    For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

    ", + "smithy.api#required": {} } }, "Id": { @@ -5700,24 +5713,23 @@ "smithy.api#required": {} } }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    " } }, - "Addresses": { - "target": "com.amazonaws.wafv2#IPAddresses", + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

    \n

    Examples:

    \n
      \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

      \n
      • \n
    • \n

      To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

      \n
      • \n
    \n

    For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

    ", + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -5779,19 +5791,6 @@ "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", - "traits": { - "smithy.api#documentation": "

    A description of the set that helps with identification. You cannot change the description of a set after you create it.

    " - } - }, - "RegularExpressionList": { - "target": "com.amazonaws.wafv2#RegularExpressionList", - "traits": { - "smithy.api#documentation": "

    ", - "smithy.api#required": {} - } - }, "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { @@ -5806,17 +5805,30 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "RegularExpressionList": { + "target": "com.amazonaws.wafv2#RegularExpressionList", + "traits": { + "smithy.api#documentation": "

    ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

    A description of the set that helps with identification. You cannot change the description of a set after you create it.

    " + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", "smithy.api#required": {} } } @@ -5877,19 +5889,19 @@ "com.amazonaws.wafv2#UpdateRuleGroupRequest": { "type": "structure", "members": { - "Rules": { - "target": "com.amazonaws.wafv2#Rules", - "traits": { - "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " - } - }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    " + } + }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { @@ -5897,10 +5909,10 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", "smithy.api#required": {} } }, @@ -5911,17 +5923,17 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Rules": { + "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " } }, - "Description": { - "target": "com.amazonaws.wafv2#EntityDescription", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    " + "smithy.api#documentation": "

    The name of the rule group. You cannot change the name of a rule group after you create it.

    ", + "smithy.api#required": {} } } } @@ -5978,30 +5990,30 @@ } ], "traits": { - "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Updates the specified WebACL.

    \n

    A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.

    " + "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    Updates the specified WebACL.

    \n

    A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

    " } }, "com.amazonaws.wafv2#UpdateWebACLRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", "smithy.api#required": {} } }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    ", + "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.wafv2#Scope", + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", "traits": { - "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    ", "smithy.api#required": {} } }, @@ -6012,10 +6024,11 @@ "smithy.api#required": {} } }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " + "smithy.api#documentation": "

    The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#required": {} } }, "Description": { @@ -6024,18 +6037,17 @@ "smithy.api#documentation": "

    A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

    " } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Scope": { + "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

    The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    ", + "smithy.api#documentation": "

    Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

    \n

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    \n
      \n
    • \n

      CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      \n
      • \n
    • \n

      API and SDKs - For all calls, use the Region endpoint us-east-1.

      \n
      • \n
    ", "smithy.api#required": {} } }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", + "Rules": { + "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " } } } @@ -6088,7 +6100,7 @@ "MetricName": { "target": "com.amazonaws.wafv2#MetricName", "traits": { - "smithy.api#documentation": "

    A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain\n whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\" You can't change a MetricName after you create a VisibilityConfig.

    ", + "smithy.api#documentation": "

    A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain\n whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\"

    ", "smithy.api#required": {} } } @@ -6148,9 +6160,6 @@ "com.amazonaws.wafv2#WAFInvalidParameterException": { "type": "structure", "members": { - "Reason": { - "target": "com.amazonaws.wafv2#ErrorReason" - }, "message": { "target": "com.amazonaws.wafv2#ErrorMessage" }, @@ -6159,6 +6168,9 @@ }, "Parameter": { "target": "com.amazonaws.wafv2#ParameterExceptionParameter" + }, + "Reason": { + "target": "com.amazonaws.wafv2#ErrorReason" } }, "traits": { @@ -6289,37 +6301,29 @@ "com.amazonaws.wafv2#WebACL": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", + "smithy.api#documentation": "

    A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

    ", "smithy.api#required": {} } }, - "PostProcessFirewallManagerRuleGroups": { - "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", - "traits": { - "smithy.api#documentation": "

    The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized before these.

    \n

    In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

    " - } - }, - "DefaultAction": { - "target": "com.amazonaws.wafv2#DefaultAction", + "Capacity": { + "target": "com.amazonaws.wafv2#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The web ACL capacity units (WCUs) currently being used by this web ACL.

    \n

    AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

    " } }, - "VisibilityConfig": { - "target": "com.amazonaws.wafv2#VisibilityConfig", + "Rules": { + "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

    ", + "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    ", "smithy.api#required": {} } }, @@ -6329,16 +6333,18 @@ "smithy.api#documentation": "

    A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

    " } }, - "Capacity": { - "target": "com.amazonaws.wafv2#ConsumedCapacity", + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

    The web ACL capacity units (WCUs) currently being used by this web ACL.

    \n

    AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

    ", + "smithy.api#required": {} } }, - "PreProcessFirewallManagerRuleGroups": { - "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", + "VisibilityConfig": { + "target": "com.amazonaws.wafv2#VisibilityConfig", "traits": { - "smithy.api#documentation": "

    The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized after these.

    \n

    In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

    " + "smithy.api#documentation": "

    Defines and enables Amazon CloudWatch metrics and web request sample collection.

    ", + "smithy.api#required": {} } }, "ManagedByFirewallManager": { @@ -6347,22 +6353,28 @@ "smithy.api#documentation": "

    Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

    " } }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", + "DefaultAction": { + "target": "com.amazonaws.wafv2#DefaultAction", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

    ", + "smithy.api#documentation": "

    The action to perform if none of the Rules contained in the WebACL match.

    ", "smithy.api#required": {} } }, - "Rules": { - "target": "com.amazonaws.wafv2#Rules", + "PostProcessFirewallManagerRuleGroups": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", "traits": { - "smithy.api#documentation": "

    The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

    " + "smithy.api#documentation": "

    The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized before these.

    \n

    In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

    " + } + }, + "PreProcessFirewallManagerRuleGroups": { + "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", + "traits": { + "smithy.api#documentation": "

    The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized after these.

    \n

    In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

    " } } }, "traits": { - "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.

    " + "smithy.api#documentation": "\n

    This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

    \n     \n

    A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

    " } }, "com.amazonaws.wafv2#WebACLSummaries": { @@ -6374,16 +6386,16 @@ "com.amazonaws.wafv2#WebACLSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.wafv2#EntityName", + "Id": { + "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    " + "smithy.api#documentation": "

    The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " } }, - "LockToken": { - "target": "com.amazonaws.wafv2#LockToken", + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    " } }, "Description": { @@ -6392,16 +6404,16 @@ "smithy.api#documentation": "

    A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

    " } }, - "ARN": { - "target": "com.amazonaws.wafv2#ResourceArn", + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the entity.

    " + "smithy.api#documentation": "

    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    " } }, - "Id": { - "target": "com.amazonaws.wafv2#EntityId", + "Name": { + "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

    The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    " + "smithy.api#documentation": "

    The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    " } } }, @@ -6412,17 +6424,17 @@ "com.amazonaws.wafv2#XssMatchStatement": { "type": "structure", "members": { - "TextTransformations": { - "target": "com.amazonaws.wafv2#TextTransformations", + "FieldToMatch": { + "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

    ", + "smithy.api#documentation": "

    The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

    ", "smithy.api#required": {} } }, - "FieldToMatch": { - "target": "com.amazonaws.wafv2#FieldToMatch", + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

    The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

    ", + "smithy.api#documentation": "

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

    ", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/workdocs.2016-05-01.json b/codegen/sdk-codegen/aws-models/workdocs.2016-05-01.json index 64811f2c0522..e5a971ff80b7 100644 --- a/codegen/sdk-codegen/aws-models/workdocs.2016-05-01.json +++ b/codegen/sdk-codegen/aws-models/workdocs.2016-05-01.json @@ -162,7 +162,7 @@ "sdkId": "WorkDocs", "arnNamespace": "workdocs", "cloudFormationName": "WorkDocs", - "cloudTrailEventSource": "gorillaboy.aws.amazon.com" + "cloudTrailEventSource": "workdocs.amazonaws.com" }, "aws.auth#sigv4": { "name": "workdocs" @@ -212,18 +212,18 @@ "com.amazonaws.workdocs#AbortDocumentVersionUploadRequest": { "type": "structure", "members": { - "DocumentId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "VersionId": { + "target": "com.amazonaws.workdocs#DocumentVersionIdType", "traits": { - "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#documentation": "

    The ID of the version.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "VersionId": { - "target": "com.amazonaws.workdocs#DocumentVersionIdType", + "DocumentId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The ID of the version.

    ", + "smithy.api#documentation": "

    The ID of the document.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -274,13 +274,6 @@ "com.amazonaws.workdocs#ActivateUserRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } - }, "UserId": { "target": "com.amazonaws.workdocs#IdType", "traits": { @@ -288,6 +281,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } } } }, @@ -305,10 +305,10 @@ "com.amazonaws.workdocs#Activity": { "type": "structure", "members": { - "IsIndirectActivity": { - "target": "com.amazonaws.workdocs#BooleanType", + "TimeStamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    Indicates whether an activity is indirect or direct. An indirect activity results\n from a direct activity performed on a parent resource. For example, sharing a parent\n folder (the direct activity) shares all of the subfolders and documents within the\n parent folder (the indirect activity).

    " + "smithy.api#documentation": "

    The timestamp when the action was performed.

    " } }, "Participants": { @@ -317,46 +317,46 @@ "smithy.api#documentation": "

    The list of users or groups impacted by this action. This is an optional field and\n is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED,\n DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

    " } }, - "OrganizationId": { - "target": "com.amazonaws.workdocs#IdType", - "traits": { - "smithy.api#documentation": "

    The ID of the organization.

    " - } - }, "Initiator": { "target": "com.amazonaws.workdocs#UserMetadata", "traits": { "smithy.api#documentation": "

    The user who performed the action.

    " } }, - "CommentMetadata": { - "target": "com.amazonaws.workdocs#CommentMetadata", + "OriginalParent": { + "target": "com.amazonaws.workdocs#ResourceMetadata", "traits": { - "smithy.api#documentation": "

    Metadata of the commenting activity. This is an optional field and is filled for\n commenting activities.

    " + "smithy.api#documentation": "

    The original parent of the resource. This is an optional field and is filled for\n move activities.

    " } }, - "Type": { - "target": "com.amazonaws.workdocs#ActivityType", + "IsIndirectActivity": { + "target": "com.amazonaws.workdocs#BooleanType", "traits": { - "smithy.api#documentation": "

    The activity type.

    " + "smithy.api#documentation": "

    Indicates whether an activity is indirect or direct. An indirect activity results\n from a direct activity performed on a parent resource. For example, sharing a parent\n folder (the direct activity) shares all of the subfolders and documents within the\n parent folder (the indirect activity).

    " } }, - "OriginalParent": { + "CommentMetadata": { + "target": "com.amazonaws.workdocs#CommentMetadata", + "traits": { + "smithy.api#documentation": "

    Metadata of the commenting activity. This is an optional field and is filled for\n commenting activities.

    " + } + }, + "ResourceMetadata": { "target": "com.amazonaws.workdocs#ResourceMetadata", "traits": { - "smithy.api#documentation": "

    The original parent of the resource. This is an optional field and is filled for\n move activities.

    " + "smithy.api#documentation": "

    The metadata of the resource involved in the user action.

    " } }, - "TimeStamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "OrganizationId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The timestamp when the action was performed.

    " + "smithy.api#documentation": "

    The ID of the organization.

    " } }, - "ResourceMetadata": { - "target": "com.amazonaws.workdocs#ResourceMetadata", + "Type": { + "target": "com.amazonaws.workdocs#ActivityType", "traits": { - "smithy.api#documentation": "

    The metadata of the resource involved in the user action.

    " + "smithy.api#documentation": "

    The activity type.

    " } } }, @@ -553,11 +553,11 @@ "smithy.api#documentation": "

    The notification options.

    " } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "Principals": { + "target": "com.amazonaws.workdocs#SharePrincipalList", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The users, groups, or organization being granted permission.

    ", + "smithy.api#required": {} } }, "ResourceId": { @@ -568,11 +568,11 @@ "smithy.api#required": {} } }, - "Principals": { - "target": "com.amazonaws.workdocs#SharePrincipalList", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The users, groups, or organization being granted permission.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } } } @@ -619,17 +619,16 @@ "com.amazonaws.workdocs#Comment": { "type": "structure", "members": { - "CommentId": { - "target": "com.amazonaws.workdocs#CommentIdType", + "Visibility": { + "target": "com.amazonaws.workdocs#CommentVisibilityType", "traits": { - "smithy.api#documentation": "

    The ID of the comment.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The visibility of the comment. Options are either PRIVATE, where the comment is\n visible only to the comment author and document owner and co-owners, or PUBLIC, where\n the comment is visible to document owners, co-owners, and contributors.

    " } }, - "ParentId": { - "target": "com.amazonaws.workdocs#CommentIdType", + "Contributor": { + "target": "com.amazonaws.workdocs#User", "traits": { - "smithy.api#documentation": "

    The ID of the parent comment.

    " + "smithy.api#documentation": "

    The details of the user who made the comment.

    " } }, "RecipientId": { @@ -638,28 +637,29 @@ "smithy.api#documentation": "

    If the comment is a reply to another user's comment, this field contains the user\n ID of the user being replied to.

    " } }, - "CreatedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "CommentId": { + "target": "com.amazonaws.workdocs#CommentIdType", "traits": { - "smithy.api#documentation": "

    The time that the comment was created.

    " + "smithy.api#documentation": "

    The ID of the comment.

    ", + "smithy.api#required": {} } }, - "Contributor": { - "target": "com.amazonaws.workdocs#User", + "CreatedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The details of the user who made the comment.

    " + "smithy.api#documentation": "

    The time that the comment was created.

    " } }, - "Visibility": { - "target": "com.amazonaws.workdocs#CommentVisibilityType", + "ParentId": { + "target": "com.amazonaws.workdocs#CommentIdType", "traits": { - "smithy.api#documentation": "

    The visibility of the comment. Options are either PRIVATE, where the comment is\n visible only to the comment author and document owner and co-owners, or PUBLIC, where\n the comment is visible to document owners, co-owners, and contributors.

    " + "smithy.api#documentation": "

    The ID of the parent comment.

    " } }, - "Status": { - "target": "com.amazonaws.workdocs#CommentStatusType", + "Text": { + "target": "com.amazonaws.workdocs#CommentTextType", "traits": { - "smithy.api#documentation": "

    The status of the comment.

    " + "smithy.api#documentation": "

    The text of the comment.

    " } }, "ThreadId": { @@ -668,10 +668,10 @@ "smithy.api#documentation": "

    The ID of the root comment in the thread.

    " } }, - "Text": { - "target": "com.amazonaws.workdocs#CommentTextType", + "Status": { + "target": "com.amazonaws.workdocs#CommentStatusType", "traits": { - "smithy.api#documentation": "

    The text of the comment.

    " + "smithy.api#documentation": "

    The status of the comment.

    " } } }, @@ -698,12 +698,6 @@ "com.amazonaws.workdocs#CommentMetadata": { "type": "structure", "members": { - "CreatedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", - "traits": { - "smithy.api#documentation": "

    The timestamp that the comment was created.

    " - } - }, "CommentId": { "target": "com.amazonaws.workdocs#CommentIdType", "traits": { @@ -727,6 +721,12 @@ "traits": { "smithy.api#documentation": "

    The ID of the user being replied to.

    " } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", + "traits": { + "smithy.api#documentation": "

    The timestamp that the comment was created.

    " + } } }, "traits": { @@ -849,12 +849,6 @@ "com.amazonaws.workdocs#CreateCommentRequest": { "type": "structure", "members": { - "NotifyCollaborators": { - "target": "com.amazonaws.workdocs#BooleanType", - "traits": { - "smithy.api#documentation": "

    Set this parameter to TRUE to send an email out to the document collaborators after\n the comment is created.

    " - } - }, "ParentId": { "target": "com.amazonaws.workdocs#CommentIdType", "traits": { @@ -867,17 +861,16 @@ "smithy.api#documentation": "

    The visibility of the comment. Options are either PRIVATE, where the comment is\n visible only to the comment author and document owner and co-owners, or PUBLIC, where\n the comment is visible to document owners, co-owners, and contributors.

    " } }, - "ThreadId": { - "target": "com.amazonaws.workdocs#CommentIdType", + "NotifyCollaborators": { + "target": "com.amazonaws.workdocs#BooleanType", "traits": { - "smithy.api#documentation": "

    The ID of the root comment in the thread.

    " + "smithy.api#documentation": "

    Set this parameter to TRUE to send an email out to the document collaborators after\n the comment is created.

    " } }, - "VersionId": { - "target": "com.amazonaws.workdocs#DocumentVersionIdType", + "Text": { + "target": "com.amazonaws.workdocs#CommentTextType", "traits": { - "smithy.api#documentation": "

    The ID of the document version.

    ", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

    The text of the comment.

    ", "smithy.api#required": {} } }, @@ -888,20 +881,27 @@ "smithy.api#httpHeader": "Authentication" } }, - "Text": { - "target": "com.amazonaws.workdocs#CommentTextType", + "DocumentId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The text of the comment.

    ", + "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DocumentId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "VersionId": { + "target": "com.amazonaws.workdocs#DocumentVersionIdType", "traits": { - "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#documentation": "

    The ID of the document version.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "ThreadId": { + "target": "com.amazonaws.workdocs#CommentIdType", + "traits": { + "smithy.api#documentation": "

    The ID of the root comment in the thread.

    " + } } } }, @@ -959,18 +959,19 @@ "com.amazonaws.workdocs#CreateCustomMetadataRequest": { "type": "structure", "members": { - "CustomMetadata": { - "target": "com.amazonaws.workdocs#CustomMetadataMap", + "ResourceId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    Custom metadata in the form of name-value pairs.

    ", + "smithy.api#documentation": "

    The ID of the resource.

    ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "CustomMetadata": { + "target": "com.amazonaws.workdocs#CustomMetadataMap", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    Custom metadata in the form of name-value pairs.

    ", + "smithy.api#required": {} } }, "VersionId": { @@ -980,12 +981,11 @@ "smithy.api#httpQuery": "versionid" } }, - "ResourceId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The ID of the resource.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } } } @@ -1043,11 +1043,11 @@ "com.amazonaws.workdocs#CreateFolderRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "ParentFolderId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The ID of the parent folder.

    ", + "smithy.api#required": {} } }, "Name": { @@ -1056,11 +1056,11 @@ "smithy.api#documentation": "

    The name of the new folder.

    " } }, - "ParentFolderId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The ID of the parent folder.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } } } @@ -1116,13 +1116,6 @@ "com.amazonaws.workdocs#CreateLabelsRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } - }, "Labels": { "target": "com.amazonaws.workdocs#SharedLabels", "traits": { @@ -1137,6 +1130,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } } } }, @@ -1175,13 +1175,6 @@ "com.amazonaws.workdocs#CreateNotificationSubscriptionRequest": { "type": "structure", "members": { - "SubscriptionType": { - "target": "com.amazonaws.workdocs#SubscriptionType", - "traits": { - "smithy.api#documentation": "

    The notification type.

    ", - "smithy.api#required": {} - } - }, "Protocol": { "target": "com.amazonaws.workdocs#SubscriptionProtocolType", "traits": { @@ -1189,10 +1182,10 @@ "smithy.api#required": {} } }, - "Endpoint": { - "target": "com.amazonaws.workdocs#SubscriptionEndPointType", + "SubscriptionType": { + "target": "com.amazonaws.workdocs#SubscriptionType", "traits": { - "smithy.api#documentation": "

    The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint\n is a URL that begins with https.

    ", + "smithy.api#documentation": "

    The notification type.

    ", "smithy.api#required": {} } }, @@ -1203,6 +1196,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Endpoint": { + "target": "com.amazonaws.workdocs#SubscriptionEndPointType", + "traits": { + "smithy.api#documentation": "

    The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint\n is a URL that begins with https.

    ", + "smithy.api#required": {} + } } } }, @@ -1254,24 +1254,23 @@ "com.amazonaws.workdocs#CreateUserRequest": { "type": "structure", "members": { - "GivenName": { - "target": "com.amazonaws.workdocs#UserAttributeValueType", + "TimeZoneId": { + "target": "com.amazonaws.workdocs#TimeZoneIdType", "traits": { - "smithy.api#documentation": "

    The given name of the user.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The time zone ID of the user.

    " } }, - "Surname": { - "target": "com.amazonaws.workdocs#UserAttributeValueType", + "StorageRule": { + "target": "com.amazonaws.workdocs#StorageRuleType", "traits": { - "smithy.api#documentation": "

    The surname of the user.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The amount of storage for the user.

    " } }, - "OrganizationId": { - "target": "com.amazonaws.workdocs#IdType", + "GivenName": { + "target": "com.amazonaws.workdocs#UserAttributeValueType", "traits": { - "smithy.api#documentation": "

    The ID of the organization.

    " + "smithy.api#documentation": "

    The given name of the user.

    ", + "smithy.api#required": {} } }, "Username": { @@ -1281,23 +1280,18 @@ "smithy.api#required": {} } }, - "TimeZoneId": { - "target": "com.amazonaws.workdocs#TimeZoneIdType", - "traits": { - "smithy.api#documentation": "

    The time zone ID of the user.

    " - } - }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "Surname": { + "target": "com.amazonaws.workdocs#UserAttributeValueType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The surname of the user.

    ", + "smithy.api#required": {} } }, - "StorageRule": { - "target": "com.amazonaws.workdocs#StorageRuleType", + "Password": { + "target": "com.amazonaws.workdocs#PasswordType", "traits": { - "smithy.api#documentation": "

    The amount of storage for the user.

    " + "smithy.api#documentation": "

    The password of the user.

    ", + "smithy.api#required": {} } }, "EmailAddress": { @@ -1306,11 +1300,17 @@ "smithy.api#documentation": "

    The email address of the user.

    " } }, - "Password": { - "target": "com.amazonaws.workdocs#PasswordType", + "OrganizationId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The password of the user.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ID of the organization.

    " + } + }, + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } } } @@ -1420,6 +1420,13 @@ "com.amazonaws.workdocs#DeactivateUserRequest": { "type": "structure", "members": { + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "UserId": { "target": "com.amazonaws.workdocs#IdType", "traits": { @@ -1427,24 +1434,17 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } } } }, "com.amazonaws.workdocs#DeactivatingLastSystemUserException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.workdocs#ExceptionCodeType" - }, "Message": { "target": "com.amazonaws.workdocs#ErrorMessageType" + }, + "Code": { + "target": "com.amazonaws.workdocs#ExceptionCodeType" } }, "traits": { @@ -1493,10 +1493,17 @@ "com.amazonaws.workdocs#DeleteCommentRequest": { "type": "structure", "members": { - "CommentId": { - "target": "com.amazonaws.workdocs#CommentIdType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The ID of the comment.

    ", + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, + "DocumentId": { + "target": "com.amazonaws.workdocs#ResourceIdType", + "traits": { + "smithy.api#documentation": "

    The ID of the document.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1509,20 +1516,13 @@ "smithy.api#required": {} } }, - "DocumentId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "CommentId": { + "target": "com.amazonaws.workdocs#CommentIdType", "traits": { - "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#documentation": "

    The ID of the comment.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } } } }, @@ -1566,6 +1566,13 @@ "com.amazonaws.workdocs#DeleteCustomMetadataRequest": { "type": "structure", "members": { + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "DeleteAll": { "target": "com.amazonaws.workdocs#BooleanType", "traits": { @@ -1573,11 +1580,11 @@ "smithy.api#httpQuery": "deleteAll" } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "VersionId": { + "target": "com.amazonaws.workdocs#DocumentVersionIdType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The ID of the version, if the custom metadata is being deleted from a document\n version.

    ", + "smithy.api#httpQuery": "versionId" } }, "ResourceId": { @@ -1588,13 +1595,6 @@ "smithy.api#required": {} } }, - "VersionId": { - "target": "com.amazonaws.workdocs#DocumentVersionIdType", - "traits": { - "smithy.api#documentation": "

    The ID of the version, if the custom metadata is being deleted from a document\n version.

    ", - "smithy.api#httpQuery": "versionId" - } - }, "Keys": { "target": "com.amazonaws.workdocs#CustomMetadataKeyList", "traits": { @@ -1651,6 +1651,13 @@ "com.amazonaws.workdocs#DeleteDocumentRequest": { "type": "structure", "members": { + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "DocumentId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -1658,13 +1665,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } } } }, @@ -1748,6 +1748,13 @@ "com.amazonaws.workdocs#DeleteFolderContentsRequest": { "type": "structure", "members": { + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "FolderId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -1755,19 +1762,19 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } } } }, "com.amazonaws.workdocs#DeleteFolderRequest": { "type": "structure", "members": { + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "FolderId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -1775,13 +1782,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } } } }, @@ -1822,11 +1822,12 @@ "com.amazonaws.workdocs#DeleteLabelsRequest": { "type": "structure", "members": { - "DeleteAll": { - "target": "com.amazonaws.workdocs#BooleanType", + "ResourceId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    Flag to request removal of all labels from the specified resource.

    ", - "smithy.api#httpQuery": "deleteAll" + "smithy.api#documentation": "

    The ID of the resource.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "AuthenticationToken": { @@ -1836,12 +1837,11 @@ "smithy.api#httpHeader": "Authentication" } }, - "ResourceId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "DeleteAll": { + "target": "com.amazonaws.workdocs#BooleanType", "traits": { - "smithy.api#documentation": "

    The ID of the resource.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Flag to request removal of all labels from the specified resource.

    ", + "smithy.api#httpQuery": "deleteAll" } }, "Labels": { @@ -1888,18 +1888,18 @@ "com.amazonaws.workdocs#DeleteNotificationSubscriptionRequest": { "type": "structure", "members": { - "SubscriptionId": { + "OrganizationId": { "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The ID of the subscription.

    ", + "smithy.api#documentation": "

    The ID of the organization.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "OrganizationId": { + "SubscriptionId": { "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The ID of the organization.

    ", + "smithy.api#documentation": "

    The ID of the subscription.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1940,6 +1940,13 @@ "com.amazonaws.workdocs#DeleteUserRequest": { "type": "structure", "members": { + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Do not set this field when using\n administrative API actions, as in accessing the API using AWS credentials.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "UserId": { "target": "com.amazonaws.workdocs#IdType", "traits": { @@ -1947,13 +1954,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Do not set this field when using\n administrative API actions, as in accessing the API using AWS credentials.

    ", - "smithy.api#httpHeader": "Authentication" - } } } }, @@ -1994,18 +1994,11 @@ "com.amazonaws.workdocs#DescribeActivitiesRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } - }, - "ActivityTypes": { - "target": "com.amazonaws.workdocs#ActivityNamesFilterType", + "StartTime": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    Specifies which activity types to include in the response. If this field is left\n empty, all activity types are returned.

    ", - "smithy.api#httpQuery": "activityTypes" + "smithy.api#documentation": "

    The timestamp that determines the starting time of the activities. The response\n includes the activities performed after the specified timestamp.

    ", + "smithy.api#httpQuery": "startTime" } }, "OrganizationId": { @@ -2029,11 +2022,18 @@ "smithy.api#httpQuery": "includeIndirectActivities" } }, - "Limit": { - "target": "com.amazonaws.workdocs#LimitType", + "UserId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    ", - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

    The ID of the user who performed the action. The response includes activities\n pertaining to this user. This is an optional parameter and is only applicable for\n administrative API (SigV4) requests.

    ", + "smithy.api#httpQuery": "userId" + } + }, + "ActivityTypes": { + "target": "com.amazonaws.workdocs#ActivityNamesFilterType", + "traits": { + "smithy.api#documentation": "

    Specifies which activity types to include in the response. If this field is left\n empty, all activity types are returned.

    ", + "smithy.api#httpQuery": "activityTypes" } }, "EndTime": { @@ -2043,18 +2043,11 @@ "smithy.api#httpQuery": "endTime" } }, - "UserId": { - "target": "com.amazonaws.workdocs#IdType", - "traits": { - "smithy.api#documentation": "

    The ID of the user who performed the action. The response includes activities\n pertaining to this user. This is an optional parameter and is only applicable for\n administrative API (SigV4) requests.

    ", - "smithy.api#httpQuery": "userId" - } - }, - "StartTime": { - "target": "com.amazonaws.workdocs#TimestampType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The timestamp that determines the starting time of the activities. The response\n includes the activities performed after the specified timestamp.

    ", - "smithy.api#httpQuery": "startTime" + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } }, "ResourceId": { @@ -2063,11 +2056,18 @@ "smithy.api#documentation": "

    The document or folder ID for which to describe activity types.

    ", "smithy.api#httpQuery": "resourceId" } - } - } - }, - "com.amazonaws.workdocs#DescribeActivitiesResponse": { - "type": "structure", + }, + "Limit": { + "target": "com.amazonaws.workdocs#LimitType", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    ", + "smithy.api#httpQuery": "limit" + } + } + } + }, + "com.amazonaws.workdocs#DescribeActivitiesResponse": { + "type": "structure", "members": { "UserActivities": { "target": "com.amazonaws.workdocs#UserActivities", @@ -2123,11 +2123,12 @@ "com.amazonaws.workdocs#DescribeCommentsRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.workdocs#LimitType", + "DocumentId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    ", - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "AuthenticationToken": { @@ -2137,14 +2138,6 @@ "smithy.api#httpHeader": "Authentication" } }, - "DocumentId": { - "target": "com.amazonaws.workdocs#ResourceIdType", - "traits": { - "smithy.api#documentation": "

    The ID of the document.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "VersionId": { "target": "com.amazonaws.workdocs#DocumentVersionIdType", "traits": { @@ -2153,6 +2146,13 @@ "smithy.api#required": {} } }, + "Limit": { + "target": "com.amazonaws.workdocs#LimitType", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    ", + "smithy.api#httpQuery": "limit" + } + }, "Marker": { "target": "com.amazonaws.workdocs#MarkerType", "traits": { @@ -2228,26 +2228,11 @@ "com.amazonaws.workdocs#DescribeDocumentVersionsRequest": { "type": "structure", "members": { - "Include": { - "target": "com.amazonaws.workdocs#FieldNamesType", - "traits": { - "smithy.api#documentation": "

    A comma-separated list of values. Specify \"INITIALIZED\" to include incomplete\n versions.

    ", - "smithy.api#httpQuery": "include" - } - }, - "DocumentId": { - "target": "com.amazonaws.workdocs#ResourceIdType", - "traits": { - "smithy.api#documentation": "

    The ID of the document.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call.)

    ", - "smithy.api#httpQuery": "marker" + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } }, "Limit": { @@ -2264,11 +2249,26 @@ "smithy.api#httpQuery": "fields" } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call.)

    ", + "smithy.api#httpQuery": "marker" + } + }, + "Include": { + "target": "com.amazonaws.workdocs#FieldNamesType", + "traits": { + "smithy.api#documentation": "

    A comma-separated list of values. Specify \"INITIALIZED\" to include incomplete\n versions.

    ", + "smithy.api#httpQuery": "include" + } + }, + "DocumentId": { + "target": "com.amazonaws.workdocs#ResourceIdType", + "traits": { + "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -2276,17 +2276,17 @@ "com.amazonaws.workdocs#DescribeDocumentVersionsResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", - "traits": { - "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no\n additional results, the string is empty.

    " - } - }, "DocumentVersions": { "target": "com.amazonaws.workdocs#DocumentVersionMetadataList", "traits": { "smithy.api#documentation": "

    The document versions.

    " } + }, + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", + "traits": { + "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no\n additional results, the string is empty.

    " + } } } }, @@ -2335,26 +2335,25 @@ "com.amazonaws.workdocs#DescribeFolderContentsRequest": { "type": "structure", "members": { - "FolderId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The ID of the folder.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } }, - "Sort": { - "target": "com.amazonaws.workdocs#ResourceSortType", + "Order": { + "target": "com.amazonaws.workdocs#OrderType", "traits": { - "smithy.api#documentation": "

    The sorting criteria.

    ", - "smithy.api#httpQuery": "sort" + "smithy.api#documentation": "

    The order for the contents of the folder.

    ", + "smithy.api#httpQuery": "order" } }, - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", + "Type": { + "target": "com.amazonaws.workdocs#FolderContentType", "traits": { - "smithy.api#documentation": "

    The marker for the next set of results. This marker was received from a previous\n call.

    ", - "smithy.api#httpQuery": "marker" + "smithy.api#documentation": "

    The type of items.

    ", + "smithy.api#httpQuery": "type" } }, "Include": { @@ -2364,32 +2363,33 @@ "smithy.api#httpQuery": "include" } }, - "Limit": { - "target": "com.amazonaws.workdocs#LimitType", + "Sort": { + "target": "com.amazonaws.workdocs#ResourceSortType", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    ", - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

    The sorting criteria.

    ", + "smithy.api#httpQuery": "sort" } }, - "Order": { - "target": "com.amazonaws.workdocs#OrderType", + "FolderId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The order for the contents of the folder.

    ", - "smithy.api#httpQuery": "order" + "smithy.api#documentation": "

    The ID of the folder.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The marker for the next set of results. This marker was received from a previous\n call.

    ", + "smithy.api#httpQuery": "marker" } }, - "Type": { - "target": "com.amazonaws.workdocs#FolderContentType", + "Limit": { + "target": "com.amazonaws.workdocs#LimitType", "traits": { - "smithy.api#documentation": "

    The type of items.

    ", - "smithy.api#httpQuery": "type" + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    ", + "smithy.api#httpQuery": "limit" } } } @@ -2403,17 +2403,17 @@ "smithy.api#documentation": "

    The subfolders in the specified folder.

    " } }, - "Documents": { - "target": "com.amazonaws.workdocs#DocumentMetadataList", - "traits": { - "smithy.api#documentation": "

    The documents in the specified folder.

    " - } - }, "Marker": { "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no\n additional results, the string is empty.

    " } + }, + "Documents": { + "target": "com.amazonaws.workdocs#DocumentMetadataList", + "traits": { + "smithy.api#documentation": "

    The documents in the specified folder.

    " + } } } }, @@ -2451,12 +2451,11 @@ "com.amazonaws.workdocs#DescribeGroupsRequest": { "type": "structure", "members": { - "SearchQuery": { - "target": "com.amazonaws.workdocs#SearchQueryType", + "OrganizationId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    A query to describe groups by group name.

    ", - "smithy.api#httpQuery": "searchQuery", - "smithy.api#required": {} + "smithy.api#documentation": "

    The ID of the organization.

    ", + "smithy.api#httpQuery": "organizationId" } }, "Limit": { @@ -2466,13 +2465,6 @@ "smithy.api#httpQuery": "limit" } }, - "OrganizationId": { - "target": "com.amazonaws.workdocs#IdType", - "traits": { - "smithy.api#documentation": "

    The ID of the organization.

    ", - "smithy.api#httpQuery": "organizationId" - } - }, "Marker": { "target": "com.amazonaws.workdocs#MarkerType", "traits": { @@ -2480,6 +2472,14 @@ "smithy.api#httpQuery": "marker" } }, + "SearchQuery": { + "target": "com.amazonaws.workdocs#SearchQueryType", + "traits": { + "smithy.api#documentation": "

    A query to describe groups by group name.

    ", + "smithy.api#httpQuery": "searchQuery", + "smithy.api#required": {} + } + }, "AuthenticationToken": { "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { @@ -2492,17 +2492,17 @@ "com.amazonaws.workdocs#DescribeGroupsResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.workdocs#MarkerType", - "traits": { - "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no additional\n results, the string is empty.

    " - } - }, "Groups": { "target": "com.amazonaws.workdocs#GroupMetadataList", "traits": { "smithy.api#documentation": "

    The list of groups.

    " } + }, + "Marker": { + "target": "com.amazonaws.workdocs#MarkerType", + "traits": { + "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no additional\n results, the string is empty.

    " + } } } }, @@ -2537,13 +2537,6 @@ "com.amazonaws.workdocs#DescribeNotificationSubscriptionsRequest": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", - "traits": { - "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call.)

    ", - "smithy.api#httpQuery": "marker" - } - }, "OrganizationId": { "target": "com.amazonaws.workdocs#IdType", "traits": { @@ -2552,6 +2545,13 @@ "smithy.api#required": {} } }, + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", + "traits": { + "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call.)

    ", + "smithy.api#httpQuery": "marker" + } + }, "Limit": { "target": "com.amazonaws.workdocs#LimitType", "traits": { @@ -2564,17 +2564,17 @@ "com.amazonaws.workdocs#DescribeNotificationSubscriptionsResponse": { "type": "structure", "members": { - "Subscriptions": { - "target": "com.amazonaws.workdocs#SubscriptionList", - "traits": { - "smithy.api#documentation": "

    The subscriptions.

    " - } - }, "Marker": { "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no\n additional results, the string is empty.

    " } + }, + "Subscriptions": { + "target": "com.amazonaws.workdocs#SubscriptionList", + "traits": { + "smithy.api#documentation": "

    The subscriptions.

    " + } } } }, @@ -2612,11 +2612,18 @@ "com.amazonaws.workdocs#DescribeResourcePermissionsRequest": { "type": "structure", "members": { - "PrincipalId": { - "target": "com.amazonaws.workdocs#IdType", + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { - "smithy.api#documentation": "

    The ID of the principal to filter permissions by.

    ", - "smithy.api#httpQuery": "principalId" + "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call)

    ", + "smithy.api#httpQuery": "marker" + } + }, + "Limit": { + "target": "com.amazonaws.workdocs#LimitType", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return with this call.

    ", + "smithy.api#httpQuery": "limit" } }, "ResourceId": { @@ -2627,26 +2634,19 @@ "smithy.api#required": {} } }, + "PrincipalId": { + "target": "com.amazonaws.workdocs#IdType", + "traits": { + "smithy.api#documentation": "

    The ID of the principal to filter permissions by.

    ", + "smithy.api#httpQuery": "principalId" + } + }, "AuthenticationToken": { "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", "smithy.api#httpHeader": "Authentication" } - }, - "Limit": { - "target": "com.amazonaws.workdocs#LimitType", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return with this call.

    ", - "smithy.api#httpQuery": "limit" - } - }, - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", - "traits": { - "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call)

    ", - "smithy.api#httpQuery": "marker" - } } } }, @@ -2704,13 +2704,6 @@ "com.amazonaws.workdocs#DescribeRootFoldersRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.workdocs#LimitType", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    ", - "smithy.api#httpQuery": "limit" - } - }, "AuthenticationToken": { "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { @@ -2719,6 +2712,13 @@ "smithy.api#required": {} } }, + "Limit": { + "target": "com.amazonaws.workdocs#LimitType", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    ", + "smithy.api#httpQuery": "limit" + } + }, "Marker": { "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { @@ -2731,17 +2731,17 @@ "com.amazonaws.workdocs#DescribeRootFoldersResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", - "traits": { - "smithy.api#documentation": "

    The marker for the next set of results.

    " - } - }, "Folders": { "target": "com.amazonaws.workdocs#FolderMetadataList", "traits": { "smithy.api#documentation": "

    The user's special folders.

    " } + }, + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", + "traits": { + "smithy.api#documentation": "

    The marker for the next set of results.

    " + } } } }, @@ -2794,25 +2794,25 @@ "com.amazonaws.workdocs#DescribeUsersRequest": { "type": "structure", "members": { - "Fields": { - "target": "com.amazonaws.workdocs#FieldNamesType", + "Include": { + "target": "com.amazonaws.workdocs#UserFilterType", "traits": { - "smithy.api#documentation": "

    A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the user\n storage quota and utilization information.

    ", - "smithy.api#httpQuery": "fields" + "smithy.api#documentation": "

    The state of the users. Specify \"ALL\" to include inactive users.

    ", + "smithy.api#httpQuery": "include" } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "UserIds": { + "target": "com.amazonaws.workdocs#UserIdsType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The IDs of the users.

    ", + "smithy.api#httpQuery": "userIds" } }, - "Order": { - "target": "com.amazonaws.workdocs#OrderType", + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { - "smithy.api#documentation": "

    The order for the results.

    ", - "smithy.api#httpQuery": "order" + "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call.)

    ", + "smithy.api#httpQuery": "marker" } }, "Limit": { @@ -2822,32 +2822,32 @@ "smithy.api#httpQuery": "limit" } }, - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", + "Order": { + "target": "com.amazonaws.workdocs#OrderType", "traits": { - "smithy.api#documentation": "

    The marker for the next set of results. (You received this marker from a previous\n call.)

    ", - "smithy.api#httpQuery": "marker" + "smithy.api#documentation": "

    The order for the results.

    ", + "smithy.api#httpQuery": "order" } }, - "Include": { - "target": "com.amazonaws.workdocs#UserFilterType", + "Fields": { + "target": "com.amazonaws.workdocs#FieldNamesType", "traits": { - "smithy.api#documentation": "

    The state of the users. Specify \"ALL\" to include inactive users.

    ", - "smithy.api#httpQuery": "include" + "smithy.api#documentation": "

    A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the user\n storage quota and utilization information.

    ", + "smithy.api#httpQuery": "fields" } }, - "Sort": { - "target": "com.amazonaws.workdocs#UserSortType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The sorting criteria.

    ", - "smithy.api#httpQuery": "sort" + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } }, - "UserIds": { - "target": "com.amazonaws.workdocs#UserIdsType", + "OrganizationId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The IDs of the users.

    ", - "smithy.api#httpQuery": "userIds" + "smithy.api#documentation": "

    The ID of the organization.

    ", + "smithy.api#httpQuery": "organizationId" } }, "Query": { @@ -2857,11 +2857,11 @@ "smithy.api#httpQuery": "query" } }, - "OrganizationId": { - "target": "com.amazonaws.workdocs#IdType", + "Sort": { + "target": "com.amazonaws.workdocs#UserSortType", "traits": { - "smithy.api#documentation": "

    The ID of the organization.

    ", - "smithy.api#httpQuery": "organizationId" + "smithy.api#documentation": "

    The sorting criteria.

    ", + "smithy.api#httpQuery": "sort" } } } @@ -2915,28 +2915,22 @@ "com.amazonaws.workdocs#DocumentMetadata": { "type": "structure", "members": { - "Id": { + "ParentFolderId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The ID of the document.

    " - } - }, - "CreatedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", - "traits": { - "smithy.api#documentation": "

    The time when the document was created.

    " + "smithy.api#documentation": "

    The ID of the parent folder.

    " } }, - "ModifiedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "LatestVersionMetadata": { + "target": "com.amazonaws.workdocs#DocumentVersionMetadata", "traits": { - "smithy.api#documentation": "

    The time when the document was updated.

    " + "smithy.api#documentation": "

    The latest version of the document.

    " } }, - "CreatorId": { - "target": "com.amazonaws.workdocs#IdType", + "Id": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The ID of the creator.

    " + "smithy.api#documentation": "

    The ID of the document.

    " } }, "ResourceState": { @@ -2945,22 +2939,28 @@ "smithy.api#documentation": "

    The resource state.

    " } }, - "ParentFolderId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "Labels": { + "target": "com.amazonaws.workdocs#SharedLabels", + "traits": { + "smithy.api#documentation": "

    List of labels on the document.

    " + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The ID of the parent folder.

    " + "smithy.api#documentation": "

    The time when the document was created.

    " } }, - "Labels": { - "target": "com.amazonaws.workdocs#SharedLabels", + "ModifiedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    List of labels on the document.

    " + "smithy.api#documentation": "

    The time when the document was updated.

    " } }, - "LatestVersionMetadata": { - "target": "com.amazonaws.workdocs#DocumentVersionMetadata", + "CreatorId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The latest version of the document.

    " + "smithy.api#documentation": "

    The ID of the creator.

    " } } }, @@ -3054,22 +3054,22 @@ "com.amazonaws.workdocs#DocumentVersionMetadata": { "type": "structure", "members": { - "Source": { - "target": "com.amazonaws.workdocs#DocumentSourceUrlMap", + "ContentModifiedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The source of the document.

    " + "smithy.api#documentation": "

    The timestamp when the content of the document was modified.

    " } }, - "ContentCreatedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "Thumbnail": { + "target": "com.amazonaws.workdocs#DocumentThumbnailUrlMap", "traits": { - "smithy.api#documentation": "

    The timestamp when the content of the document was originally created.

    " + "smithy.api#documentation": "

    The thumbnail of the document.

    " } }, - "Id": { - "target": "com.amazonaws.workdocs#DocumentVersionIdType", + "CreatorId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The ID of the version.

    " + "smithy.api#documentation": "

    The ID of the creator.

    " } }, "CreatedTimestamp": { @@ -3078,58 +3078,58 @@ "smithy.api#documentation": "

    The timestamp when the document was first uploaded.

    " } }, - "Size": { - "target": "com.amazonaws.workdocs#SizeType", + "ContentCreatedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The size of the document, in bytes.

    " + "smithy.api#documentation": "

    The timestamp when the content of the document was originally created.

    " } }, - "Signature": { - "target": "com.amazonaws.workdocs#HashType", + "Size": { + "target": "com.amazonaws.workdocs#SizeType", "traits": { - "smithy.api#documentation": "

    The signature of the document.

    " + "smithy.api#documentation": "

    The size of the document, in bytes.

    " } }, - "Name": { - "target": "com.amazonaws.workdocs#ResourceNameType", + "Id": { + "target": "com.amazonaws.workdocs#DocumentVersionIdType", "traits": { - "smithy.api#documentation": "

    The name of the version.

    " + "smithy.api#documentation": "

    The ID of the version.

    " } }, - "Thumbnail": { - "target": "com.amazonaws.workdocs#DocumentThumbnailUrlMap", + "ContentType": { + "target": "com.amazonaws.workdocs#DocumentContentType", "traits": { - "smithy.api#documentation": "

    The thumbnail of the document.

    " + "smithy.api#documentation": "

    The content type of the document.

    " } }, - "ContentModifiedTimestamp": { + "ModifiedTimestamp": { "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The timestamp when the content of the document was modified.

    " + "smithy.api#documentation": "

    The timestamp when the document was last uploaded.

    " } }, - "Status": { - "target": "com.amazonaws.workdocs#DocumentStatusType", + "Source": { + "target": "com.amazonaws.workdocs#DocumentSourceUrlMap", "traits": { - "smithy.api#documentation": "

    The status of the document.

    " + "smithy.api#documentation": "

    The source of the document.

    " } }, - "ModifiedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "Name": { + "target": "com.amazonaws.workdocs#ResourceNameType", "traits": { - "smithy.api#documentation": "

    The timestamp when the document was last uploaded.

    " + "smithy.api#documentation": "

    The name of the version.

    " } }, - "CreatorId": { - "target": "com.amazonaws.workdocs#IdType", + "Signature": { + "target": "com.amazonaws.workdocs#HashType", "traits": { - "smithy.api#documentation": "

    The ID of the creator.

    " + "smithy.api#documentation": "

    The signature of the document.

    " } }, - "ContentType": { - "target": "com.amazonaws.workdocs#DocumentContentType", + "Status": { + "target": "com.amazonaws.workdocs#DocumentStatusType", "traits": { - "smithy.api#documentation": "

    The content type of the document.

    " + "smithy.api#documentation": "

    The status of the document.

    " } } }, @@ -3263,16 +3263,10 @@ "com.amazonaws.workdocs#FolderMetadata": { "type": "structure", "members": { - "ModifiedTimestamp": { + "CreatedTimestamp": { "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The time when the folder was updated.

    " - } - }, - "Labels": { - "target": "com.amazonaws.workdocs#SharedLabels", - "traits": { - "smithy.api#documentation": "

    List of labels on the folder.

    " + "smithy.api#documentation": "

    The time when the folder was created.

    " } }, "Signature": { @@ -3287,22 +3281,22 @@ "smithy.api#documentation": "

    The ID of the creator.

    " } }, - "ParentFolderId": { + "Id": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The ID of the parent folder.

    " + "smithy.api#documentation": "

    The ID of the folder.

    " } }, - "Name": { - "target": "com.amazonaws.workdocs#ResourceNameType", + "ResourceState": { + "target": "com.amazonaws.workdocs#ResourceStateType", "traits": { - "smithy.api#documentation": "

    The name of the folder.

    " + "smithy.api#documentation": "

    The resource state of the folder.

    " } }, - "Id": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "ModifiedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The ID of the folder.

    " + "smithy.api#documentation": "

    The time when the folder was updated.

    " } }, "LatestVersionSize": { @@ -3317,16 +3311,22 @@ "smithy.api#documentation": "

    The size of the folder metadata.

    " } }, - "ResourceState": { - "target": "com.amazonaws.workdocs#ResourceStateType", + "Labels": { + "target": "com.amazonaws.workdocs#SharedLabels", "traits": { - "smithy.api#documentation": "

    The resource state of the folder.

    " + "smithy.api#documentation": "

    List of labels on the folder.

    " } }, - "CreatedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "Name": { + "target": "com.amazonaws.workdocs#ResourceNameType", "traits": { - "smithy.api#documentation": "

    The time when the folder was created.

    " + "smithy.api#documentation": "

    The name of the folder.

    " + } + }, + "ParentFolderId": { + "target": "com.amazonaws.workdocs#ResourceIdType", + "traits": { + "smithy.api#documentation": "

    The ID of the parent folder.

    " } } }, @@ -3475,12 +3475,11 @@ "com.amazonaws.workdocs#GetDocumentPathRequest": { "type": "structure", "members": { - "DocumentId": { - "target": "com.amazonaws.workdocs#IdType", + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { - "smithy.api#documentation": "

    The ID of the document.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    This value is not supported.

    ", + "smithy.api#httpQuery": "marker" } }, "Limit": { @@ -3490,18 +3489,12 @@ "smithy.api#httpQuery": "limit" } }, - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", - "traits": { - "smithy.api#documentation": "

    This value is not supported.

    ", - "smithy.api#httpQuery": "marker" - } - }, - "Fields": { - "target": "com.amazonaws.workdocs#FieldNamesType", + "DocumentId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    A comma-separated list of values. Specify NAME to include the names of\n the parent folders.

    ", - "smithy.api#httpQuery": "fields" + "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "AuthenticationToken": { @@ -3510,6 +3503,13 @@ "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", "smithy.api#httpHeader": "Authentication" } + }, + "Fields": { + "target": "com.amazonaws.workdocs#FieldNamesType", + "traits": { + "smithy.api#documentation": "

    A comma-separated list of values. Specify NAME to include the names of\n the parent folders.

    ", + "smithy.api#httpQuery": "fields" + } } } }, @@ -3527,13 +3527,6 @@ "com.amazonaws.workdocs#GetDocumentRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } - }, "DocumentId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -3542,6 +3535,13 @@ "smithy.api#required": {} } }, + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "IncludeCustomMetadata": { "target": "com.amazonaws.workdocs#BooleanType", "traits": { @@ -3618,12 +3618,11 @@ "smithy.api#httpQuery": "includeCustomMetadata" } }, - "VersionId": { - "target": "com.amazonaws.workdocs#DocumentVersionIdType", + "Fields": { + "target": "com.amazonaws.workdocs#FieldNamesType", "traits": { - "smithy.api#documentation": "

    The version ID of the document.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    A comma-separated list of values. Specify \"SOURCE\" to include a URL for the source\n document.

    ", + "smithy.api#httpQuery": "fields" } }, "AuthenticationToken": { @@ -3641,11 +3640,12 @@ "smithy.api#required": {} } }, - "Fields": { - "target": "com.amazonaws.workdocs#FieldNamesType", + "VersionId": { + "target": "com.amazonaws.workdocs#DocumentVersionIdType", "traits": { - "smithy.api#documentation": "

    A comma-separated list of values. Specify \"SOURCE\" to include a URL for the source\n document.

    ", - "smithy.api#httpQuery": "fields" + "smithy.api#documentation": "

    The version ID of the document.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -3653,17 +3653,17 @@ "com.amazonaws.workdocs#GetDocumentVersionResponse": { "type": "structure", "members": { - "Metadata": { - "target": "com.amazonaws.workdocs#DocumentVersionMetadata", - "traits": { - "smithy.api#documentation": "

    The version metadata.

    " - } - }, "CustomMetadata": { "target": "com.amazonaws.workdocs#CustomMetadataMap", "traits": { "smithy.api#documentation": "

    The custom metadata on the document version.

    " } + }, + "Metadata": { + "target": "com.amazonaws.workdocs#DocumentVersionMetadata", + "traits": { + "smithy.api#documentation": "

    The version metadata.

    " + } } } }, @@ -3744,11 +3744,12 @@ "com.amazonaws.workdocs#GetFolderPathRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "FolderId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The ID of the folder.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Fields": { @@ -3765,12 +3766,11 @@ "smithy.api#httpQuery": "marker" } }, - "FolderId": { - "target": "com.amazonaws.workdocs#IdType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The ID of the folder.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } }, "Limit": { @@ -3796,6 +3796,13 @@ "com.amazonaws.workdocs#GetFolderRequest": { "type": "structure", "members": { + "IncludeCustomMetadata": { + "target": "com.amazonaws.workdocs#BooleanType", + "traits": { + "smithy.api#documentation": "

    Set to TRUE to include custom metadata in the response.

    ", + "smithy.api#httpQuery": "includeCustomMetadata" + } + }, "FolderId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -3804,13 +3811,6 @@ "smithy.api#required": {} } }, - "IncludeCustomMetadata": { - "target": "com.amazonaws.workdocs#BooleanType", - "traits": { - "smithy.api#documentation": "

    Set to TRUE to include custom metadata in the response.

    ", - "smithy.api#httpQuery": "includeCustomMetadata" - } - }, "AuthenticationToken": { "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { @@ -3823,17 +3823,17 @@ "com.amazonaws.workdocs#GetFolderResponse": { "type": "structure", "members": { - "CustomMetadata": { - "target": "com.amazonaws.workdocs#CustomMetadataMap", - "traits": { - "smithy.api#documentation": "

    The custom metadata on the folder.

    " - } - }, "Metadata": { "target": "com.amazonaws.workdocs#FolderMetadata", "traits": { "smithy.api#documentation": "

    The metadata of the folder.

    " } + }, + "CustomMetadata": { + "target": "com.amazonaws.workdocs#CustomMetadataMap", + "traits": { + "smithy.api#documentation": "

    The custom metadata on the folder.

    " + } } } }, @@ -3874,6 +3874,20 @@ "com.amazonaws.workdocs#GetResourcesRequest": { "type": "structure", "members": { + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, + "Limit": { + "target": "com.amazonaws.workdocs#LimitType", + "traits": { + "smithy.api#documentation": "

    The maximum number of resources to return.

    ", + "smithy.api#httpQuery": "limit" + } + }, "CollectionType": { "target": "com.amazonaws.workdocs#ResourceCollectionType", "traits": { @@ -3881,13 +3895,6 @@ "smithy.api#httpQuery": "collectionType" } }, - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", - "traits": { - "smithy.api#documentation": "

    The marker for the next set of results. This marker was received from a previous call.

    ", - "smithy.api#httpQuery": "marker" - } - }, "UserId": { "target": "com.amazonaws.workdocs#IdType", "traits": { @@ -3895,18 +3902,11 @@ "smithy.api#httpQuery": "userId" } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } - }, - "Limit": { - "target": "com.amazonaws.workdocs#LimitType", + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", "traits": { - "smithy.api#documentation": "

    The maximum number of resources to return.

    ", - "smithy.api#httpQuery": "limit" + "smithy.api#documentation": "

    The marker for the next set of results. This marker was received from a previous call.

    ", + "smithy.api#httpQuery": "marker" } } } @@ -3914,12 +3914,6 @@ "com.amazonaws.workdocs#GetResourcesResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.workdocs#PageMarkerType", - "traits": { - "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " - } - }, "Documents": { "target": "com.amazonaws.workdocs#DocumentMetadataList", "traits": { @@ -3931,23 +3925,29 @@ "traits": { "smithy.api#documentation": "

    The folders in the specified folder.

    " } + }, + "Marker": { + "target": "com.amazonaws.workdocs#PageMarkerType", + "traits": { + "smithy.api#documentation": "

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } } } }, "com.amazonaws.workdocs#GroupMetadata": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.workdocs#GroupNameType", - "traits": { - "smithy.api#documentation": "

    The name of the group.

    " - } - }, "Id": { "target": "com.amazonaws.workdocs#IdType", "traits": { "smithy.api#documentation": "

    The ID of the user group.

    " } + }, + "Name": { + "target": "com.amazonaws.workdocs#GroupNameType", + "traits": { + "smithy.api#documentation": "

    The name of the group.

    " + } } }, "traits": { @@ -4070,18 +4070,6 @@ "com.amazonaws.workdocs#InitiateDocumentVersionUploadRequest": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.workdocs#DocumentContentType", - "traits": { - "smithy.api#documentation": "

    The content type of the document.

    " - } - }, - "Id": { - "target": "com.amazonaws.workdocs#ResourceIdType", - "traits": { - "smithy.api#documentation": "

    The ID of the document.

    " - } - }, "ParentFolderId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -4089,17 +4077,16 @@ "smithy.api#required": {} } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "Id": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The ID of the document.

    " } }, - "ContentModifiedTimestamp": { + "ContentCreatedTimestamp": { "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The timestamp when the content of the document was modified.

    " + "smithy.api#documentation": "

    The timestamp when the content of the document was originally created.

    " } }, "Name": { @@ -4108,16 +4095,29 @@ "smithy.api#documentation": "

    The name of the document.

    " } }, + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } + }, "DocumentSizeInBytes": { "target": "com.amazonaws.workdocs#SizeType", "traits": { "smithy.api#documentation": "

    The size of the document, in bytes.

    " } }, - "ContentCreatedTimestamp": { + "ContentModifiedTimestamp": { "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The timestamp when the content of the document was originally created.

    " + "smithy.api#documentation": "

    The timestamp when the content of the document was modified.

    " + } + }, + "ContentType": { + "target": "com.amazonaws.workdocs#DocumentContentType", + "traits": { + "smithy.api#documentation": "

    The content type of the document.

    " } } } @@ -4288,17 +4288,17 @@ "com.amazonaws.workdocs#NotificationOptions": { "type": "structure", "members": { - "EmailMessage": { - "target": "com.amazonaws.workdocs#MessageType", - "traits": { - "smithy.api#documentation": "

    Text value to be included in the email body.

    " - } - }, "SendEmail": { "target": "com.amazonaws.workdocs#BooleanType", "traits": { "smithy.api#documentation": "

    Boolean value to indicate an email notification should be sent to the\n receipients.

    " } + }, + "EmailMessage": { + "target": "com.amazonaws.workdocs#MessageType", + "traits": { + "smithy.api#documentation": "

    Text value to be included in the email body.

    " + } } }, "traits": { @@ -4338,17 +4338,17 @@ "com.amazonaws.workdocs#Participants": { "type": "structure", "members": { - "Users": { - "target": "com.amazonaws.workdocs#UserMetadataList", - "traits": { - "smithy.api#documentation": "

    The list of users.

    " - } - }, "Groups": { "target": "com.amazonaws.workdocs#GroupMetadataList", "traits": { "smithy.api#documentation": "

    The list of user groups.

    " } + }, + "Users": { + "target": "com.amazonaws.workdocs#UserMetadataList", + "traits": { + "smithy.api#documentation": "

    The list of users.

    " + } } }, "traits": { @@ -4413,18 +4413,18 @@ "com.amazonaws.workdocs#Principal": { "type": "structure", "members": { - "Roles": { - "target": "com.amazonaws.workdocs#PermissionInfoList", - "traits": { - "smithy.api#documentation": "

    The permission information for the resource.

    " - } - }, "Id": { "target": "com.amazonaws.workdocs#IdType", "traits": { "smithy.api#documentation": "

    The ID of the resource.

    " } }, + "Roles": { + "target": "com.amazonaws.workdocs#PermissionInfoList", + "traits": { + "smithy.api#documentation": "

    The permission information for the resource.

    " + } + }, "Type": { "target": "com.amazonaws.workdocs#PrincipalType", "traits": { @@ -4513,13 +4513,6 @@ "com.amazonaws.workdocs#RemoveAllResourcePermissionsRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", - "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" - } - }, "ResourceId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -4527,6 +4520,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "traits": { + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" + } } } }, @@ -4561,13 +4561,6 @@ "com.amazonaws.workdocs#RemoveResourcePermissionRequest": { "type": "structure", "members": { - "PrincipalType": { - "target": "com.amazonaws.workdocs#PrincipalType", - "traits": { - "smithy.api#documentation": "

    The principal type of the resource.

    ", - "smithy.api#httpQuery": "type" - } - }, "AuthenticationToken": { "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { @@ -4575,6 +4568,13 @@ "smithy.api#httpHeader": "Authentication" } }, + "PrincipalType": { + "target": "com.amazonaws.workdocs#PrincipalType", + "traits": { + "smithy.api#documentation": "

    The principal type of the resource.

    ", + "smithy.api#httpQuery": "type" + } + }, "PrincipalId": { "target": "com.amazonaws.workdocs#IdType", "traits": { @@ -4643,16 +4643,16 @@ "com.amazonaws.workdocs#ResourceMetadata": { "type": "structure", "members": { - "VersionId": { - "target": "com.amazonaws.workdocs#DocumentVersionIdType", + "Name": { + "target": "com.amazonaws.workdocs#ResourceNameType", "traits": { - "smithy.api#documentation": "

    The version ID of the resource. This is an optional field and is filled for action\n on document version.

    " + "smithy.api#documentation": "

    The name of the resource.

    " } }, - "Type": { - "target": "com.amazonaws.workdocs#ResourceType", + "OriginalName": { + "target": "com.amazonaws.workdocs#ResourceNameType", "traits": { - "smithy.api#documentation": "

    The type of resource.

    " + "smithy.api#documentation": "

    The original name of the resource before a rename operation.

    " } }, "Owner": { @@ -4661,28 +4661,28 @@ "smithy.api#documentation": "

    The owner of the resource.

    " } }, - "OriginalName": { - "target": "com.amazonaws.workdocs#ResourceNameType", + "VersionId": { + "target": "com.amazonaws.workdocs#DocumentVersionIdType", "traits": { - "smithy.api#documentation": "

    The original name of the resource before a rename operation.

    " + "smithy.api#documentation": "

    The version ID of the resource. This is an optional field and is filled for action\n on document version.

    " } }, - "Name": { - "target": "com.amazonaws.workdocs#ResourceNameType", + "ParentId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The name of the resource.

    " + "smithy.api#documentation": "

    The parent ID of the resource before a rename operation.

    " } }, - "Id": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "Type": { + "target": "com.amazonaws.workdocs#ResourceType", "traits": { - "smithy.api#documentation": "

    The ID of the resource.

    " + "smithy.api#documentation": "

    The type of resource.

    " } }, - "ParentId": { + "Id": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The parent ID of the resource before a rename operation.

    " + "smithy.api#documentation": "

    The ID of the resource.

    " } } }, @@ -4717,17 +4717,17 @@ "com.amazonaws.workdocs#ResourcePathComponent": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.workdocs#IdType", - "traits": { - "smithy.api#documentation": "

    The ID of the resource path.

    " - } - }, "Name": { "target": "com.amazonaws.workdocs#ResourceNameType", "traits": { "smithy.api#documentation": "

    The name of the resource path.

    " } + }, + "Id": { + "target": "com.amazonaws.workdocs#IdType", + "traits": { + "smithy.api#documentation": "

    The ID of the resource path.

    " + } } }, "traits": { @@ -4858,17 +4858,17 @@ "com.amazonaws.workdocs#SharePrincipal": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.workdocs#IdType", + "Role": { + "target": "com.amazonaws.workdocs#RoleType", "traits": { - "smithy.api#documentation": "

    The ID of the recipient.

    ", + "smithy.api#documentation": "

    The role of the recipient.

    ", "smithy.api#required": {} } }, - "Role": { - "target": "com.amazonaws.workdocs#RoleType", + "Id": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The role of the recipient.

    ", + "smithy.api#documentation": "

    The ID of the recipient.

    ", "smithy.api#required": {} } }, @@ -4893,34 +4893,34 @@ "com.amazonaws.workdocs#ShareResult": { "type": "structure", "members": { - "InviteePrincipalId": { - "target": "com.amazonaws.workdocs#IdType", - "traits": { - "smithy.api#documentation": "

    The ID of the invited user.

    " - } - }, - "StatusMessage": { - "target": "com.amazonaws.workdocs#MessageType", - "traits": { - "smithy.api#documentation": "

    The status message.

    " - } - }, "Role": { "target": "com.amazonaws.workdocs#RoleType", "traits": { "smithy.api#documentation": "

    The role.

    " } }, + "ShareId": { + "target": "com.amazonaws.workdocs#ResourceIdType", + "traits": { + "smithy.api#documentation": "

    The ID of the resource that was shared.

    " + } + }, "Status": { "target": "com.amazonaws.workdocs#ShareStatusType", "traits": { "smithy.api#documentation": "

    The status.

    " } }, - "ShareId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "StatusMessage": { + "target": "com.amazonaws.workdocs#MessageType", "traits": { - "smithy.api#documentation": "

    The ID of the resource that was shared.

    " + "smithy.api#documentation": "

    The status message.

    " + } + }, + "InviteePrincipalId": { + "target": "com.amazonaws.workdocs#IdType", + "traits": { + "smithy.api#documentation": "

    The ID of the invited user.

    " } }, "PrincipalId": { @@ -5021,17 +5021,17 @@ "com.amazonaws.workdocs#StorageRuleType": { "type": "structure", "members": { - "StorageAllocatedInBytes": { - "target": "com.amazonaws.workdocs#PositiveSizeType", - "traits": { - "smithy.api#documentation": "

    The amount of storage allocated, in bytes.

    " - } - }, "StorageType": { "target": "com.amazonaws.workdocs#StorageType", "traits": { "smithy.api#documentation": "

    The type of storage.

    " } + }, + "StorageAllocatedInBytes": { + "target": "com.amazonaws.workdocs#PositiveSizeType", + "traits": { + "smithy.api#documentation": "

    The amount of storage allocated, in bytes.

    " + } } }, "traits": { @@ -5056,12 +5056,6 @@ "com.amazonaws.workdocs#Subscription": { "type": "structure", "members": { - "SubscriptionId": { - "target": "com.amazonaws.workdocs#IdType", - "traits": { - "smithy.api#documentation": "

    The ID of the subscription.

    " - } - }, "Protocol": { "target": "com.amazonaws.workdocs#SubscriptionProtocolType", "traits": { @@ -5073,6 +5067,12 @@ "traits": { "smithy.api#documentation": "

    The endpoint of the subscription.

    " } + }, + "SubscriptionId": { + "target": "com.amazonaws.workdocs#IdType", + "traits": { + "smithy.api#documentation": "

    The ID of the subscription.

    " + } } }, "traits": { @@ -5163,11 +5163,11 @@ "com.amazonaws.workdocs#UnauthorizedOperationException": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.workdocs#ExceptionCodeType" - }, "Message": { "target": "com.amazonaws.workdocs#ErrorMessageType" + }, + "Code": { + "target": "com.amazonaws.workdocs#ExceptionCodeType" } }, "traits": { @@ -5238,18 +5238,17 @@ "com.amazonaws.workdocs#UpdateDocumentRequest": { "type": "structure", "members": { - "DocumentId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The ID of the document.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } }, - "ResourceState": { - "target": "com.amazonaws.workdocs#ResourceStateType", + "Name": { + "target": "com.amazonaws.workdocs#ResourceNameType", "traits": { - "smithy.api#documentation": "

    The resource state of the document. Only ACTIVE and RECYCLED are\n supported.

    " + "smithy.api#documentation": "

    The name of the document.

    " } }, "ParentFolderId": { @@ -5258,17 +5257,18 @@ "smithy.api#documentation": "

    The ID of the parent folder.

    " } }, - "Name": { - "target": "com.amazonaws.workdocs#ResourceNameType", + "DocumentId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The name of the document.

    " + "smithy.api#documentation": "

    The ID of the document.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "ResourceState": { + "target": "com.amazonaws.workdocs#ResourceStateType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The resource state of the document. Only ACTIVE and RECYCLED are\n supported.

    " } } } @@ -5316,11 +5316,10 @@ "com.amazonaws.workdocs#UpdateDocumentVersionRequest": { "type": "structure", "members": { - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "VersionStatus": { + "target": "com.amazonaws.workdocs#DocumentVersionStatus", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The status of the version.

    " } }, "DocumentId": { @@ -5339,10 +5338,11 @@ "smithy.api#required": {} } }, - "VersionStatus": { - "target": "com.amazonaws.workdocs#DocumentVersionStatus", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The status of the version.

    " + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } } } @@ -5396,6 +5396,18 @@ "com.amazonaws.workdocs#UpdateFolderRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.workdocs#ResourceNameType", + "traits": { + "smithy.api#documentation": "

    The name of the folder.

    " + } + }, + "ParentFolderId": { + "target": "com.amazonaws.workdocs#ResourceIdType", + "traits": { + "smithy.api#documentation": "

    The ID of the parent folder.

    " + } + }, "AuthenticationToken": { "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { @@ -5409,18 +5421,6 @@ "smithy.api#documentation": "

    The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from\n the API.

    " } }, - "Name": { - "target": "com.amazonaws.workdocs#ResourceNameType", - "traits": { - "smithy.api#documentation": "

    The name of the folder.

    " - } - }, - "ParentFolderId": { - "target": "com.amazonaws.workdocs#ResourceIdType", - "traits": { - "smithy.api#documentation": "

    The ID of the parent folder.

    " - } - }, "FolderId": { "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { @@ -5477,10 +5477,10 @@ "com.amazonaws.workdocs#UpdateUserRequest": { "type": "structure", "members": { - "TimeZoneId": { - "target": "com.amazonaws.workdocs#TimeZoneIdType", + "StorageRule": { + "target": "com.amazonaws.workdocs#StorageRuleType", "traits": { - "smithy.api#documentation": "

    The time zone ID of the user.

    " + "smithy.api#documentation": "

    The amount of storage for the user.

    " } }, "GivenName": { @@ -5489,49 +5489,49 @@ "smithy.api#documentation": "

    The given name of the user.

    " } }, - "UserId": { - "target": "com.amazonaws.workdocs#IdType", + "GrantPoweruserPrivileges": { + "target": "com.amazonaws.workdocs#BooleanEnumType", "traits": { - "smithy.api#documentation": "

    The ID of the user.

    ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

    Boolean value to determine whether the user is granted Poweruser privileges.

    " } }, - "Locale": { - "target": "com.amazonaws.workdocs#LocaleType", + "AuthenticationToken": { + "target": "com.amazonaws.workdocs#AuthenticationHeaderType", "traits": { - "smithy.api#documentation": "

    The locale of the user.

    " + "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", + "smithy.api#httpHeader": "Authentication" } }, - "StorageRule": { - "target": "com.amazonaws.workdocs#StorageRuleType", + "Surname": { + "target": "com.amazonaws.workdocs#UserAttributeValueType", "traits": { - "smithy.api#documentation": "

    The amount of storage for the user.

    " + "smithy.api#documentation": "

    The surname of the user.

    " } }, - "GrantPoweruserPrivileges": { - "target": "com.amazonaws.workdocs#BooleanEnumType", + "Type": { + "target": "com.amazonaws.workdocs#UserType", "traits": { - "smithy.api#documentation": "

    Boolean value to determine whether the user is granted Poweruser privileges.

    " + "smithy.api#documentation": "

    The type of the user.

    " } }, - "Surname": { - "target": "com.amazonaws.workdocs#UserAttributeValueType", + "Locale": { + "target": "com.amazonaws.workdocs#LocaleType", "traits": { - "smithy.api#documentation": "

    The surname of the user.

    " + "smithy.api#documentation": "

    The locale of the user.

    " } }, - "AuthenticationToken": { - "target": "com.amazonaws.workdocs#AuthenticationHeaderType", + "TimeZoneId": { + "target": "com.amazonaws.workdocs#TimeZoneIdType", "traits": { - "smithy.api#documentation": "

    Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

    ", - "smithy.api#httpHeader": "Authentication" + "smithy.api#documentation": "

    The time zone ID of the user.

    " } }, - "Type": { - "target": "com.amazonaws.workdocs#UserType", + "UserId": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The type of the user.

    " + "smithy.api#documentation": "

    The ID of the user.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } @@ -5580,28 +5580,28 @@ "com.amazonaws.workdocs#User": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.workdocs#UserStatusType", + "Surname": { + "target": "com.amazonaws.workdocs#UserAttributeValueType", "traits": { - "smithy.api#documentation": "

    The status of the user.

    " + "smithy.api#documentation": "

    The surname of the user.

    " } }, - "GivenName": { - "target": "com.amazonaws.workdocs#UserAttributeValueType", + "ModifiedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The given name of the user.

    " + "smithy.api#documentation": "

    The time when the user was modified.

    " } }, - "OrganizationId": { - "target": "com.amazonaws.workdocs#IdType", + "Username": { + "target": "com.amazonaws.workdocs#UsernameType", "traits": { - "smithy.api#documentation": "

    The ID of the organization.

    " + "smithy.api#documentation": "

    The login name of the user.

    " } }, - "EmailAddress": { - "target": "com.amazonaws.workdocs#EmailAddressType", + "Id": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The email address of the user.

    " + "smithy.api#documentation": "

    The ID of the user.

    " } }, "RootFolderId": { @@ -5610,64 +5610,64 @@ "smithy.api#documentation": "

    The ID of the root folder.

    " } }, - "RecycleBinFolderId": { - "target": "com.amazonaws.workdocs#ResourceIdType", + "Locale": { + "target": "com.amazonaws.workdocs#LocaleType", "traits": { - "smithy.api#documentation": "

    The ID of the recycle bin folder.

    " + "smithy.api#documentation": "

    The locale of the user.

    " } }, - "CreatedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "TimeZoneId": { + "target": "com.amazonaws.workdocs#TimeZoneIdType", "traits": { - "smithy.api#documentation": "

    The time when the user was created.

    " + "smithy.api#documentation": "

    The time zone ID of the user.

    " } }, - "Locale": { - "target": "com.amazonaws.workdocs#LocaleType", + "CreatedTimestamp": { + "target": "com.amazonaws.workdocs#TimestampType", "traits": { - "smithy.api#documentation": "

    The locale of the user.

    " + "smithy.api#documentation": "

    The time when the user was created.

    " } }, - "Id": { + "OrganizationId": { "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The ID of the user.

    " + "smithy.api#documentation": "

    The ID of the organization.

    " } }, - "Storage": { - "target": "com.amazonaws.workdocs#UserStorageMetadata", + "GivenName": { + "target": "com.amazonaws.workdocs#UserAttributeValueType", "traits": { - "smithy.api#documentation": "

    The storage for the user.

    " + "smithy.api#documentation": "

    The given name of the user.

    " } }, - "Type": { - "target": "com.amazonaws.workdocs#UserType", + "EmailAddress": { + "target": "com.amazonaws.workdocs#EmailAddressType", "traits": { - "smithy.api#documentation": "

    The type of user.

    " + "smithy.api#documentation": "

    The email address of the user.

    " } }, - "Surname": { - "target": "com.amazonaws.workdocs#UserAttributeValueType", + "RecycleBinFolderId": { + "target": "com.amazonaws.workdocs#ResourceIdType", "traits": { - "smithy.api#documentation": "

    The surname of the user.

    " + "smithy.api#documentation": "

    The ID of the recycle bin folder.

    " } }, - "Username": { - "target": "com.amazonaws.workdocs#UsernameType", + "Type": { + "target": "com.amazonaws.workdocs#UserType", "traits": { - "smithy.api#documentation": "

    The login name of the user.

    " + "smithy.api#documentation": "

    The type of user.

    " } }, - "TimeZoneId": { - "target": "com.amazonaws.workdocs#TimeZoneIdType", + "Status": { + "target": "com.amazonaws.workdocs#UserStatusType", "traits": { - "smithy.api#documentation": "

    The time zone ID of the user.

    " + "smithy.api#documentation": "

    The status of the user.

    " } }, - "ModifiedTimestamp": { - "target": "com.amazonaws.workdocs#TimestampType", + "Storage": { + "target": "com.amazonaws.workdocs#UserStorageMetadata", "traits": { - "smithy.api#documentation": "

    The time when the user was modified.

    " + "smithy.api#documentation": "

    The storage for the user.

    " } } }, @@ -5718,16 +5718,16 @@ "com.amazonaws.workdocs#UserMetadata": { "type": "structure", "members": { - "Surname": { + "GivenName": { "target": "com.amazonaws.workdocs#UserAttributeValueType", "traits": { - "smithy.api#documentation": "

    The surname of the user.

    " + "smithy.api#documentation": "

    The given name of the user before a rename operation.

    " } }, - "EmailAddress": { - "target": "com.amazonaws.workdocs#EmailAddressType", + "Surname": { + "target": "com.amazonaws.workdocs#UserAttributeValueType", "traits": { - "smithy.api#documentation": "

    The email address of the user.

    " + "smithy.api#documentation": "

    The surname of the user.

    " } }, "Username": { @@ -5736,16 +5736,16 @@ "smithy.api#documentation": "

    The name of the user.

    " } }, - "Id": { - "target": "com.amazonaws.workdocs#IdType", + "EmailAddress": { + "target": "com.amazonaws.workdocs#EmailAddressType", "traits": { - "smithy.api#documentation": "

    The ID of the user.

    " + "smithy.api#documentation": "

    The email address of the user.

    " } }, - "GivenName": { - "target": "com.amazonaws.workdocs#UserAttributeValueType", + "Id": { + "target": "com.amazonaws.workdocs#IdType", "traits": { - "smithy.api#documentation": "

    The given name of the user before a rename operation.

    " + "smithy.api#documentation": "

    The ID of the user.

    " } } }, @@ -5808,17 +5808,17 @@ "com.amazonaws.workdocs#UserStorageMetadata": { "type": "structure", "members": { - "StorageUtilizedInBytes": { - "target": "com.amazonaws.workdocs#SizeType", - "traits": { - "smithy.api#documentation": "

    The amount of storage used, in bytes.

    " - } - }, "StorageRule": { "target": "com.amazonaws.workdocs#StorageRuleType", "traits": { "smithy.api#documentation": "

    The storage for a user.

    " } + }, + "StorageUtilizedInBytes": { + "target": "com.amazonaws.workdocs#SizeType", + "traits": { + "smithy.api#documentation": "

    The amount of storage used, in bytes.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/worklink.2018-09-25.json b/codegen/sdk-codegen/aws-models/worklink.2018-09-25.json index a54fb7385441..e0c34db6b8e8 100644 --- a/codegen/sdk-codegen/aws-models/worklink.2018-09-25.json +++ b/codegen/sdk-codegen/aws-models/worklink.2018-09-25.json @@ -346,6 +346,12 @@ "com.amazonaws.worklink#CreateFleetRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.worklink#TagMap", + "traits": { + "smithy.api#documentation": "

    The tags to add to the resource. A tag is a key-value pair.

    " + } + }, "FleetName": { "target": "com.amazonaws.worklink#FleetName", "traits": { @@ -353,12 +359,6 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.worklink#TagMap", - "traits": { - "smithy.api#documentation": "

    The tags to add to the resource. A tag is a key-value pair.

    " - } - }, "DisplayName": { "target": "com.amazonaws.worklink#DisplayName", "traits": { @@ -657,17 +657,17 @@ "com.amazonaws.worklink#DescribeDeviceRequest": { "type": "structure", "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", + "DeviceId": { + "target": "com.amazonaws.worklink#Id", "traits": { - "smithy.api#documentation": "

    The ARN of the fleet.

    ", + "smithy.api#documentation": "

    A unique identifier for a registered user's device.

    ", "smithy.api#required": {} } }, - "DeviceId": { - "target": "com.amazonaws.worklink#Id", + "FleetArn": { + "target": "com.amazonaws.worklink#FleetArn", "traits": { - "smithy.api#documentation": "

    A unique identifier for a registered user's device.

    ", + "smithy.api#documentation": "

    The ARN of the fleet.

    ", "smithy.api#required": {} } } @@ -676,10 +676,10 @@ "com.amazonaws.worklink#DescribeDeviceResponse": { "type": "structure", "members": { - "PatchLevel": { - "target": "com.amazonaws.worklink#DevicePatchLevel", + "OperatingSystemVersion": { + "target": "com.amazonaws.worklink#DeviceOperatingSystemVersion", "traits": { - "smithy.api#documentation": "

    The operating system patch level of the device.

    " + "smithy.api#documentation": "

    The operating system version of the device.

    " } }, "Username": { @@ -688,12 +688,6 @@ "smithy.api#documentation": "

    The user name associated with the device.

    " } }, - "OperatingSystem": { - "target": "com.amazonaws.worklink#DeviceOperatingSystemName", - "traits": { - "smithy.api#documentation": "

    The operating system of the device.

    " - } - }, "Status": { "target": "com.amazonaws.worklink#DeviceStatus", "traits": { @@ -706,16 +700,16 @@ "smithy.api#documentation": "

    The date that the device first signed in to Amazon WorkLink.

    " } }, - "LastAccessedTime": { - "target": "com.amazonaws.worklink#DateTime", + "PatchLevel": { + "target": "com.amazonaws.worklink#DevicePatchLevel", "traits": { - "smithy.api#documentation": "

    The date that the device last accessed Amazon WorkLink.

    " + "smithy.api#documentation": "

    The operating system patch level of the device.

    " } }, - "Model": { - "target": "com.amazonaws.worklink#DeviceModel", + "LastAccessedTime": { + "target": "com.amazonaws.worklink#DateTime", "traits": { - "smithy.api#documentation": "

    The model of the device.

    " + "smithy.api#documentation": "

    The date that the device last accessed Amazon WorkLink.

    " } }, "Manufacturer": { @@ -724,10 +718,16 @@ "smithy.api#documentation": "

    The manufacturer of the device.

    " } }, - "OperatingSystemVersion": { - "target": "com.amazonaws.worklink#DeviceOperatingSystemVersion", + "OperatingSystem": { + "target": "com.amazonaws.worklink#DeviceOperatingSystemName", "traits": { - "smithy.api#documentation": "

    The operating system version of the device.

    " + "smithy.api#documentation": "

    The operating system of the device.

    " + } + }, + "Model": { + "target": "com.amazonaws.worklink#DeviceModel", + "traits": { + "smithy.api#documentation": "

    The model of the device.

    " } } } @@ -788,22 +788,16 @@ "com.amazonaws.worklink#DescribeDomainResponse": { "type": "structure", "members": { - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

    The name to display.

    " - } - }, "DomainName": { "target": "com.amazonaws.worklink#DomainName", "traits": { "smithy.api#documentation": "

    The name of the domain.

    " } }, - "DomainStatus": { - "target": "com.amazonaws.worklink#DomainStatus", + "DisplayName": { + "target": "com.amazonaws.worklink#DisplayName", "traits": { - "smithy.api#documentation": "

    The current state for the domain.

    " + "smithy.api#documentation": "

    The name to display.

    " } }, "CreatedTime": { @@ -817,6 +811,12 @@ "traits": { "smithy.api#documentation": "

    The ARN of an issued ACM certificate that is valid for the domain being associated.

    " } + }, + "DomainStatus": { + "target": "com.amazonaws.worklink#DomainStatus", + "traits": { + "smithy.api#documentation": "

    The current state for the domain.

    " + } } } }, @@ -869,10 +869,10 @@ "com.amazonaws.worklink#DescribeFleetMetadataResponse": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", + "FleetStatus": { + "target": "com.amazonaws.worklink#FleetStatus", "traits": { - "smithy.api#documentation": "

    The time that the fleet was created.

    " + "smithy.api#documentation": "

    The current state of the fleet.

    " } }, "FleetName": { @@ -881,16 +881,10 @@ "smithy.api#documentation": "

    The name of the fleet.

    " } }, - "FleetStatus": { - "target": "com.amazonaws.worklink#FleetStatus", - "traits": { - "smithy.api#documentation": "

    The current state of the fleet.

    " - } - }, - "LastUpdatedTime": { + "CreatedTime": { "target": "com.amazonaws.worklink#DateTime", "traits": { - "smithy.api#documentation": "

    The time that the fleet was last updated.

    " + "smithy.api#documentation": "

    The time that the fleet was created.

    " } }, "OptimizeForEndUserLocation": { @@ -905,6 +899,12 @@ "smithy.api#documentation": "

    The name to display.

    " } }, + "LastUpdatedTime": { + "target": "com.amazonaws.worklink#DateTime", + "traits": { + "smithy.api#documentation": "

    The time that the fleet was last updated.

    " + } + }, "Tags": { "target": "com.amazonaws.worklink#TagMap", "traits": { @@ -974,17 +974,17 @@ "smithy.api#documentation": "

    The SAML metadata document uploaded to the user’s identity provider.

    " } }, - "IdentityProviderType": { - "target": "com.amazonaws.worklink#IdentityProviderType", - "traits": { - "smithy.api#documentation": "

    The type of identity provider.

    " - } - }, "IdentityProviderSamlMetadata": { "target": "com.amazonaws.worklink#SamlMetadata", "traits": { "smithy.api#documentation": "

    The SAML metadata document provided by the user’s identity provider.

    " } + }, + "IdentityProviderType": { + "target": "com.amazonaws.worklink#IdentityProviderType", + "traits": { + "smithy.api#documentation": "

    The type of identity provider.

    " + } } } }, @@ -1044,12 +1044,6 @@ "com.amazonaws.worklink#DescribeWebsiteCertificateAuthorityResponse": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

    The time that the certificate authority was added.

    " - } - }, "Certificate": { "target": "com.amazonaws.worklink#Certificate", "traits": { @@ -1061,6 +1055,12 @@ "traits": { "smithy.api#documentation": "

    The certificate name to display.

    " } + }, + "CreatedTime": { + "target": "com.amazonaws.worklink#DateTime", + "traits": { + "smithy.api#documentation": "

    The time that the certificate authority was added.

    " + } } } }, @@ -1479,18 +1479,6 @@ "com.amazonaws.worklink#FleetSummary": { "type": "structure", "members": { - "LastUpdatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

    The time when the fleet was last updated.

    " - } - }, - "CompanyCode": { - "target": "com.amazonaws.worklink#CompanyCode", - "traits": { - "smithy.api#documentation": "

    The identifier used by users to sign into the Amazon WorkLink app.

    " - } - }, "DisplayName": { "target": "com.amazonaws.worklink#DisplayName", "traits": { @@ -1503,16 +1491,22 @@ "smithy.api#documentation": "

    The name of the fleet.

    " } }, + "FleetStatus": { + "target": "com.amazonaws.worklink#FleetStatus", + "traits": { + "smithy.api#documentation": "

    The status of the fleet.

    " + } + }, "CreatedTime": { "target": "com.amazonaws.worklink#DateTime", "traits": { "smithy.api#documentation": "

    The time when the fleet was created.

    " } }, - "FleetStatus": { - "target": "com.amazonaws.worklink#FleetStatus", + "FleetArn": { + "target": "com.amazonaws.worklink#FleetArn", "traits": { - "smithy.api#documentation": "

    The status of the fleet.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " } }, "Tags": { @@ -1521,10 +1515,16 @@ "smithy.api#documentation": "

    The tags attached to the resource. A tag is a key-value pair.

    " } }, - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", + "CompanyCode": { + "target": "com.amazonaws.worklink#CompanyCode", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the fleet.

    " + "smithy.api#documentation": "

    The identifier used by users to sign into the Amazon WorkLink app.

    " + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.worklink#DateTime", + "traits": { + "smithy.api#documentation": "

    The time when the fleet was last updated.

    " } } }, @@ -1626,18 +1626,18 @@ "com.amazonaws.worklink#ListDevicesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " - } - }, "NextToken": { "target": "com.amazonaws.worklink#NextToken", "traits": { "smithy.api#documentation": "

    The pagination token used to retrieve the next page of results for this operation. If\n this value is null, it retrieves the first page.

    " } }, + "MaxResults": { + "target": "com.amazonaws.worklink#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " + } + }, "FleetArn": { "target": "com.amazonaws.worklink#FleetArn", "traits": { @@ -1712,18 +1712,18 @@ "smithy.api#documentation": "

    The pagination token used to retrieve the next page of results for this operation. If\n this value is null, it retrieves the first page.

    " } }, - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " - } - }, "FleetArn": { "target": "com.amazonaws.worklink#FleetArn", "traits": { "smithy.api#documentation": "

    The ARN of the fleet.

    ", "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.worklink#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " + } } } }, @@ -1783,34 +1783,34 @@ "com.amazonaws.worklink#ListFleetsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " - } - }, "NextToken": { "target": "com.amazonaws.worklink#NextToken", "traits": { "smithy.api#documentation": "

    The pagination token used to retrieve the next page of results for this operation. If\n this value is null, it retrieves the first page.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.worklink#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " + } } } }, "com.amazonaws.worklink#ListFleetsResponse": { "type": "structure", "members": { - "FleetSummaryList": { - "target": "com.amazonaws.worklink#FleetSummaryList", - "traits": { - "smithy.api#documentation": "

    The summary list of the fleets.

    " - } - }, "NextToken": { "target": "com.amazonaws.worklink#NextToken", "traits": { "smithy.api#documentation": "

    The pagination token used to retrieve the next page of results for this operation. If\n there are no more pages, this value is null.

    " } + }, + "FleetSummaryList": { + "target": "com.amazonaws.worklink#FleetSummaryList", + "traits": { + "smithy.api#documentation": "

    The summary list of the fleets.

    " + } } } }, @@ -1909,17 +1909,17 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " - } - }, "NextToken": { "target": "com.amazonaws.worklink#NextToken", "traits": { "smithy.api#documentation": "

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.worklink#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to be included in the next page.

    " + } } } }, @@ -2240,17 +2240,17 @@ "com.amazonaws.worklink#SignOutUserRequest": { "type": "structure", "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", + "Username": { + "target": "com.amazonaws.worklink#Username", "traits": { - "smithy.api#documentation": "

    The ARN of the fleet.

    ", + "smithy.api#documentation": "

    The name of the user.

    ", "smithy.api#required": {} } }, - "Username": { - "target": "com.amazonaws.worklink#Username", + "FleetArn": { + "target": "com.amazonaws.worklink#FleetArn", "traits": { - "smithy.api#documentation": "

    The name of the user.

    ", + "smithy.api#documentation": "

    The ARN of the fleet.

    ", "smithy.api#required": {} } } @@ -2530,13 +2530,6 @@ "com.amazonaws.worklink#UpdateCompanyNetworkConfigurationRequest": { "type": "structure", "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

    The ARN of the fleet.

    ", - "smithy.api#required": {} - } - }, "VpcId": { "target": "com.amazonaws.worklink#VpcId", "traits": { @@ -2557,6 +2550,13 @@ "smithy.api#documentation": "

    The security groups associated with access to the provided subnets.

    ", "smithy.api#required": {} } + }, + "FleetArn": { + "target": "com.amazonaws.worklink#FleetArn", + "traits": { + "smithy.api#documentation": "

    The ARN of the fleet.

    ", + "smithy.api#required": {} + } } } }, @@ -2601,18 +2601,18 @@ "com.amazonaws.worklink#UpdateDevicePolicyConfigurationRequest": { "type": "structure", "members": { + "DeviceCaCertificate": { + "target": "com.amazonaws.worklink#CertificateChain", + "traits": { + "smithy.api#documentation": "

    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

    " + } + }, "FleetArn": { "target": "com.amazonaws.worklink#FleetArn", "traits": { "smithy.api#documentation": "

    The ARN of the fleet.

    ", "smithy.api#required": {} } - }, - "DeviceCaCertificate": { - "target": "com.amazonaws.worklink#CertificateChain", - "traits": { - "smithy.api#documentation": "

    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

    " - } } } }, @@ -2657,17 +2657,17 @@ "com.amazonaws.worklink#UpdateDomainMetadataRequest": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", + "FleetArn": { + "target": "com.amazonaws.worklink#FleetArn", "traits": { - "smithy.api#documentation": "

    The name of the domain.

    ", + "smithy.api#documentation": "

    The ARN of the fleet.

    ", "smithy.api#required": {} } }, - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", + "DomainName": { + "target": "com.amazonaws.worklink#DomainName", "traits": { - "smithy.api#documentation": "

    The ARN of the fleet.

    ", + "smithy.api#documentation": "

    The name of the domain.

    ", "smithy.api#required": {} } }, @@ -2720,6 +2720,12 @@ "com.amazonaws.worklink#UpdateFleetMetadataRequest": { "type": "structure", "members": { + "OptimizeForEndUserLocation": { + "target": "com.amazonaws.worklink#Boolean", + "traits": { + "smithy.api#documentation": "

    The option to optimize for better performance by routing traffic through the closest\n AWS Region to users, which may be outside of your home Region.

    " + } + }, "DisplayName": { "target": "com.amazonaws.worklink#DisplayName", "traits": { @@ -2732,12 +2738,6 @@ "smithy.api#documentation": "

    The ARN of the fleet.

    ", "smithy.api#required": {} } - }, - "OptimizeForEndUserLocation": { - "target": "com.amazonaws.worklink#Boolean", - "traits": { - "smithy.api#documentation": "

    The option to optimize for better performance by routing traffic through the closest\n AWS Region to users, which may be outside of your home Region.

    " - } } } }, @@ -2826,18 +2826,18 @@ "com.amazonaws.worklink#WebsiteAuthorizationProviderSummary": { "type": "structure", "members": { - "AuthorizationProviderId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

    A unique identifier for the authorization provider.

    " - } - }, "DomainName": { "target": "com.amazonaws.worklink#DomainName", "traits": { "smithy.api#documentation": "

    The domain name of the authorization provider. This applies only to SAML-based\n authorization providers.

    " } }, + "AuthorizationProviderId": { + "target": "com.amazonaws.worklink#Id", + "traits": { + "smithy.api#documentation": "

    A unique identifier for the authorization provider.

    " + } + }, "CreatedTime": { "target": "com.amazonaws.worklink#DateTime", "traits": { @@ -2865,12 +2865,6 @@ "com.amazonaws.worklink#WebsiteCaSummary": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

    The time when the CA was added.

    " - } - }, "WebsiteCaId": { "target": "com.amazonaws.worklink#Id", "traits": { @@ -2882,6 +2876,12 @@ "traits": { "smithy.api#documentation": "

    The name to display.

    " } + }, + "CreatedTime": { + "target": "com.amazonaws.worklink#DateTime", + "traits": { + "smithy.api#documentation": "

    The time when the CA was added.

    " + } } }, "traits": { @@ -3003,7 +3003,7 @@ "sdkId": "WorkLink", "arnNamespace": "worklink", "cloudFormationName": "WorkLink", - "cloudTrailEventSource": "awsargoncontrolplane.amazonaws.com" + "cloudTrailEventSource": "worklink.amazonaws.com" }, "aws.auth#sigv4": { "name": "worklink" 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 68949e3bb53d..4b3b747627a7 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": { + "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.

    " + } + }, + "Description": { + "target": "com.amazonaws.workmail#AccessControlRuleDescription", + "traits": { + "smithy.api#documentation": "

    The rule description.

    " + } + }, + "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.

    " + } + }, + "IpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

    IPv4 CIDR ranges to include in the rule.

    " + } + }, + "Effect": { + "target": "com.amazonaws.workmail#AccessControlRuleEffect", + "traits": { + "smithy.api#documentation": "

    The rule effect.

    " + } + }, + "DateCreated": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date that the rule was created.

    " + } + }, + "NotIpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

    IPv4 CIDR ranges to exclude from the rule.

    " + } + }, + "NotUserIds": { + "target": "com.amazonaws.workmail#UserIdList", + "traits": { + "smithy.api#documentation": "

    User IDs to exclude from the rule.

    " + } + }, + "DateModified": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date that the rule was modified.

    " + } + }, + "UserIds": { + "target": "com.amazonaws.workmail#UserIdList", + "traits": { + "smithy.api#documentation": "

    User IDs to include in the rule.

    " + } + }, + "Name": { + "target": "com.amazonaws.workmail#AccessControlRuleName", + "traits": { + "smithy.api#documentation": "

    The rule name.

    " + } + } + }, + "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": { @@ -144,17 +308,17 @@ "smithy.api#required": {} } }, - "GroupId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The group to which the member (user or group) is associated.

    ", + "smithy.api#documentation": "

    The organization under which the group exists.

    ", "smithy.api#required": {} } }, - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "GroupId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

    The organization under which the group exists.

    ", + "smithy.api#documentation": "

    The group to which the member (user or group) is associated.

    ", "smithy.api#required": {} } } @@ -167,22 +331,22 @@ "com.amazonaws.workmail#BookingOptions": { "type": "structure", "members": { - "AutoDeclineRecurringRequests": { + "AutoDeclineConflictingRequests": { "target": "com.amazonaws.workmail#Boolean", "traits": { - "smithy.api#documentation": "

    The resource's ability to automatically decline any recurring requests.

    " + "smithy.api#documentation": "

    The resource's ability to automatically decline any conflicting requests.

    " } }, - "AutoAcceptRequests": { + "AutoDeclineRecurringRequests": { "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 decline any recurring requests.

    " } }, - "AutoDeclineConflictingRequests": { + "AutoAcceptRequests": { "target": "com.amazonaws.workmail#Boolean", "traits": { - "smithy.api#documentation": "

    The resource's ability to automatically decline any conflicting requests.

    " + "smithy.api#documentation": "

    The resource's ability to automatically reply to requests. If disabled, delegates\n must be associated to the resource.

    " } } }, @@ -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": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The organization ID.

    ", + "smithy.api#required": {} + } + }, + "JobId": { + "target": "com.amazonaws.workmail#MailboxExportJobId", + "traits": { + "smithy.api#documentation": "

    The job 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" }, @@ -242,17 +467,17 @@ "smithy.api#required": {} } }, - "EntityId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "Alias": { + "target": "com.amazonaws.workmail#EmailAddress", "traits": { - "smithy.api#documentation": "

    The member (user or group) to which this alias is added.

    ", + "smithy.api#documentation": "

    The alias to add to the member set.

    ", "smithy.api#required": {} } }, - "Alias": { - "target": "com.amazonaws.workmail#EmailAddress", + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

    The alias to add to the member set.

    ", + "smithy.api#documentation": "

    The member (user or group) to which this alias is added.

    ", "smithy.api#required": {} } } @@ -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,17 +556,17 @@ } } }, - "com.amazonaws.workmail#CreateResource": { + "com.amazonaws.workmail#CreateOrganization": { "type": "operation", "input": { - "target": "com.amazonaws.workmail#CreateResourceRequest" + "target": "com.amazonaws.workmail#CreateOrganizationRequest" }, "output": { - "target": "com.amazonaws.workmail#CreateResourceResponse" + "target": "com.amazonaws.workmail#CreateOrganizationResponse" }, "errors": [ { - "target": "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException" + "target": "com.amazonaws.workmail#DirectoryInUseException" }, { "target": "com.amazonaws.workmail#DirectoryUnavailableException" @@ -350,67 +575,78 @@ "target": "com.amazonaws.workmail#InvalidParameterException" }, { - "target": "com.amazonaws.workmail#NameAvailabilityException" - }, - { - "target": "com.amazonaws.workmail#OrganizationNotFoundException" - }, - { - "target": "com.amazonaws.workmail#OrganizationStateException" + "target": "com.amazonaws.workmail#LimitExceededException" }, { - "target": "com.amazonaws.workmail#ReservedNameException" + "target": "com.amazonaws.workmail#NameAvailabilityException" } ], "traits": { - "smithy.api#documentation": "

    Creates a new Amazon WorkMail resource.

    ", + "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#CreateResourceRequest": { + "com.amazonaws.workmail#CreateOrganizationRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.workmail#ResourceType", + "Alias": { + "target": "com.amazonaws.workmail#OrganizationName", "traits": { - "smithy.api#documentation": "

    The type of the new resource. The available types are equipment and\n room.

    ", + "smithy.api#documentation": "

    The organization alias.

    ", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.workmail#ResourceName", + "KmsKeyArn": { + "target": "com.amazonaws.workmail#KmsKeyArn", "traits": { - "smithy.api#documentation": "

    The name of the new resource.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a customer managed master key from AWS\n KMS.

    " } }, - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "DirectoryId": { + "target": "com.amazonaws.workmail#DirectoryId", "traits": { - "smithy.api#documentation": "

    The identifier associated with the organization for which the resource is\n created.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The AWS Directory Service directory ID.

    " + } + }, + "Domains": { + "target": "com.amazonaws.workmail#Domains", + "traits": { + "smithy.api#documentation": "

    The email domains to associate with the organization.

    " + } + }, + "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.

    " + } + }, + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "

    The idempotency token associated with the request.

    ", + "smithy.api#idempotencyToken": {} } } } }, - "com.amazonaws.workmail#CreateResourceResponse": { + "com.amazonaws.workmail#CreateOrganizationResponse": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.workmail#ResourceId", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The identifier of the new resource.

    " + "smithy.api#documentation": "

    The organization ID.

    " } } } }, - "com.amazonaws.workmail#CreateUser": { + "com.amazonaws.workmail#CreateResource": { "type": "operation", "input": { - "target": "com.amazonaws.workmail#CreateUserRequest" + "target": "com.amazonaws.workmail#CreateResourceRequest" }, "output": { - "target": "com.amazonaws.workmail#CreateUserResponse" + "target": "com.amazonaws.workmail#CreateResourceResponse" }, "errors": [ { @@ -422,9 +658,6 @@ { "target": "com.amazonaws.workmail#InvalidParameterException" }, - { - "target": "com.amazonaws.workmail#InvalidPasswordException" - }, { "target": "com.amazonaws.workmail#NameAvailabilityException" }, @@ -436,30 +669,106 @@ }, { "target": "com.amazonaws.workmail#ReservedNameException" - }, - { - "target": "com.amazonaws.workmail#UnsupportedOperationException" } ], "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 new Amazon WorkMail resource.

    ", "smithy.api#idempotent": {} } }, - "com.amazonaws.workmail#CreateUserRequest": { + "com.amazonaws.workmail#CreateResourceRequest": { "type": "structure", "members": { - "Password": { - "target": "com.amazonaws.workmail#Password", + "Type": { + "target": "com.amazonaws.workmail#ResourceType", "traits": { - "smithy.api#documentation": "

    The password for the new user.

    ", + "smithy.api#documentation": "

    The type of the new resource. The available types are equipment and\n room.

    ", "smithy.api#required": {} } }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The identifier associated with the organization for which the resource is\n created.

    ", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.workmail#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the new resource.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#CreateResourceResponse": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workmail#ResourceId", + "traits": { + "smithy.api#documentation": "

    The identifier of the new resource.

    " + } + } + } + }, + "com.amazonaws.workmail#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.workmail#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException" + }, + { + "target": "com.amazonaws.workmail#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#InvalidPasswordException" + }, + { + "target": "com.amazonaws.workmail#NameAvailabilityException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#ReservedNameException" + }, + { + "target": "com.amazonaws.workmail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

    ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#CreateUserRequest": { + "type": "structure", + "members": { "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. Simple AD or AD Connector user names have a maximum length\n of 20. All others have a maximum length of 64.

    ", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.workmail#Password", + "traits": { + "smithy.api#documentation": "

    The password for the new user.

    ", "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": { + "Name": { + "target": "com.amazonaws.workmail#AccessControlRuleName", + "traits": { + "smithy.api#documentation": "

    The name of the access control rule.

    ", + "smithy.api#required": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The identifier for the organization.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DeleteAccessControlRuleResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#DeleteAlias": { "type": "operation", "input": { @@ -545,6 +897,13 @@ "com.amazonaws.workmail#DeleteAliasRequest": { "type": "structure", "members": { + "Alias": { + "target": "com.amazonaws.workmail#EmailAddress", + "traits": { + "smithy.api#documentation": "

    The aliases to be removed from the user's set of aliases. Duplicate entries in the\n list are collapsed into single entries (the list is transformed into a set).

    ", + "smithy.api#required": {} + } + }, "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { @@ -558,13 +917,6 @@ "smithy.api#documentation": "

    The identifier for the member (user or group) from which to have the aliases\n removed.

    ", "smithy.api#required": {} } - }, - "Alias": { - "target": "com.amazonaws.workmail#EmailAddress", - "traits": { - "smithy.api#documentation": "

    The aliases to be removed from the user's set of aliases. Duplicate entries in the\n list are collapsed into single entries (the list is transformed into a set).

    ", - "smithy.api#required": {} - } } } }, @@ -667,7 +1019,14 @@ "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": {} + } + }, + "GranteeId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the member (user or group) for which to delete granted\n permissions.

    ", "smithy.api#required": {} } }, @@ -677,19 +1036,79 @@ "smithy.api#documentation": "

    The identifier of the organization under which the member (user or group)\n exists.

    ", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.workmail#DeleteMailboxPermissionsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workmail#DeleteOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DeleteOrganizationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DeleteOrganizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" }, - "GranteeId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + { + "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": { + "DeleteDirectory": { + "target": "com.amazonaws.workmail#Boolean", "traits": { - "smithy.api#documentation": "

    The identifier of the member (user or group) for which to delete granted\n permissions.

    ", + "smithy.api#documentation": "

    If true, deletes the AWS Directory Service directory associated with the organization.

    ", + "smithy.api#required": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The organization ID.

    ", "smithy.api#required": {} } + }, + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "

    The idempotency token associated with the request.

    ", + "smithy.api#idempotencyToken": {} + } } } }, - "com.amazonaws.workmail#DeleteMailboxPermissionsResponse": { + "com.amazonaws.workmail#DeleteOrganizationResponse": { "type": "structure", - "members": {} + "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", @@ -721,23 +1140,70 @@ "com.amazonaws.workmail#DeleteResourceRequest": { "type": "structure", "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The identifier associated with the organization from which the resource is\n deleted.

    ", + "smithy.api#required": {} + } + }, "ResourceId": { "target": "com.amazonaws.workmail#ResourceId", "traits": { "smithy.api#documentation": "

    The identifier of the resource to be deleted.

    ", "smithy.api#required": {} } + } + } + }, + "com.amazonaws.workmail#DeleteResourceResponse": { + "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": { + "Id": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

    The retention policy ID.

    ", + "smithy.api#required": {} + } }, "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The identifier associated with the organization from which the resource is\n deleted.

    ", + "smithy.api#documentation": "

    The organization ID.

    ", "smithy.api#required": {} } } } }, - "com.amazonaws.workmail#DeleteResourceResponse": { + "com.amazonaws.workmail#DeleteRetentionPolicyResponse": { "type": "structure", "members": {} }, @@ -773,24 +1239,24 @@ } ], "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": {} } }, "com.amazonaws.workmail#DeleteUserRequest": { "type": "structure", "members": { - "UserId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The identifier of the user to be deleted.

    ", + "smithy.api#documentation": "

    The organization that contains the user to be deleted.

    ", "smithy.api#required": {} } }, - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "UserId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

    The organization that contains the user to be deleted.

    ", + "smithy.api#documentation": "

    The identifier of the user to be deleted.

    ", "smithy.api#required": {} } } @@ -826,24 +1292,24 @@ } ], "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": {} } }, "com.amazonaws.workmail#DeregisterFromWorkMailRequest": { "type": "structure", "members": { - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

    The identifier for the organization under which the Amazon WorkMail entity\n exists.

    ", + "smithy.api#documentation": "

    The identifier for the member (user or group) to be updated.

    ", "smithy.api#required": {} } }, - "EntityId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The identifier for the member (user or group) to be updated.

    ", + "smithy.api#documentation": "

    The identifier for the organization under which the Amazon WorkMail entity exists.

    ", "smithy.api#required": {} } } @@ -908,10 +1374,10 @@ "smithy.api#documentation": "

    The identifier of the described group.

    " } }, - "DisabledDate": { + "EnabledDate": { "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time when a user was deregistered from WorkMail, in UNIX epoch time\n format.

    " + "smithy.api#documentation": "

    The date and time when a user was registered to WorkMail, in UNIX epoch time\n format.

    " } }, "Name": { @@ -920,10 +1386,10 @@ "smithy.api#documentation": "

    The name of the described group.

    " } }, - "EnabledDate": { + "DisabledDate": { "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

    The date and time when a user was registered to WorkMail, in UNIX epoch time\n format.

    " + "smithy.api#documentation": "

    The date and time when a user was deregistered from WorkMail, in UNIX epoch time\n format.

    " } }, "Email": { @@ -935,7 +1401,130 @@ "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).

    " + } + } + } + }, + "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": { + "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.

    " + } + }, + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the user or resource associated with the mailbox.

    " + } + }, + "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.

    " + } + }, + "EndTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The mailbox export job end timestamp.

    " + } + }, + "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.

    " + } + }, + "EstimatedProgress": { + "target": "com.amazonaws.workmail#Percentage", + "traits": { + "smithy.api#documentation": "

    The estimated progress of the mailbox export job, in percentage points.

    " + } + }, + "S3BucketName": { + "target": "com.amazonaws.workmail#S3BucketName", + "traits": { + "smithy.api#documentation": "

    The name of the S3 bucket.

    " + } + }, + "State": { + "target": "com.amazonaws.workmail#MailboxExportJobState", + "traits": { + "smithy.api#documentation": "

    The state of the mailbox export job.

    " + } + }, + "S3Prefix": { + "target": "com.amazonaws.workmail#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

    The S3 bucket prefix.

    " + } + }, + "StartTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The mailbox export job start timestamp.

    " + } + }, + "ErrorInfo": { + "target": "com.amazonaws.workmail#MailboxExportErrorInfo", + "traits": { + "smithy.api#documentation": "

    Error information for failed mailbox export jobs.

    " } } } @@ -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": {} } }, @@ -979,37 +1568,37 @@ "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.

    " } }, - "ErrorMessage": { - "target": "com.amazonaws.workmail#String", + "ARN": { + "target": "com.amazonaws.workmail#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    (Optional) The error message indicating if unexpected behavior was encountered with\n regards to the organization.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the organization.

    " } }, - "DefaultMailDomain": { + "ErrorMessage": { "target": "com.amazonaws.workmail#String", "traits": { - "smithy.api#documentation": "

    The default mail domain associated with the organization.

    " + "smithy.api#documentation": "

    (Optional) The error message indicating if unexpected behavior was encountered with\n regards to the organization.

    " } }, - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "DirectoryType": { + "target": "com.amazonaws.workmail#String", "traits": { - "smithy.api#documentation": "

    The identifier of an organization.

    " + "smithy.api#documentation": "

    The type of directory associated with the WorkMail organization.

    " } }, - "CompletedDate": { - "target": "com.amazonaws.workmail#Timestamp", + "State": { + "target": "com.amazonaws.workmail#String", "traits": { - "smithy.api#documentation": "

    The date at which the organization became usable in the WorkMail context, in UNIX epoch\n time format.

    " + "smithy.api#documentation": "

    The state of an organization.

    " } }, - "DirectoryType": { - "target": "com.amazonaws.workmail#String", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The type of directory associated with the WorkMail organization.

    " + "smithy.api#documentation": "

    The identifier of an organization.

    " } }, "Alias": { @@ -1018,10 +1607,16 @@ "smithy.api#documentation": "

    The alias for an organization.

    " } }, - "State": { + "CompletedDate": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date at which the organization became usable in the WorkMail context, in UNIX epoch\n time format.

    " + } + }, + "DefaultMailDomain": { "target": "com.amazonaws.workmail#String", "traits": { - "smithy.api#documentation": "

    The state of an organization.

    " + "smithy.api#documentation": "

    The default mail domain associated with the organization.

    " } } } @@ -1075,22 +1670,22 @@ "com.amazonaws.workmail#DescribeResourceResponse": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.workmail#ResourceType", + "DisabledDate": { + "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

    The type of the described resource.

    " + "smithy.api#documentation": "

    The date and time when a resource was disabled from WorkMail, in UNIX epoch time\n format.

    " } }, - "Name": { - "target": "com.amazonaws.workmail#ResourceName", + "Type": { + "target": "com.amazonaws.workmail#ResourceType", "traits": { - "smithy.api#documentation": "

    The name of the described resource.

    " + "smithy.api#documentation": "

    The type of the described resource.

    " } }, - "DisabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + "State": { + "target": "com.amazonaws.workmail#EntityState", "traits": { - "smithy.api#documentation": "

    The date and time when a resource was disabled from WorkMail, in UNIX epoch time\n format.

    " + "smithy.api#documentation": "

    The state of the resource: enabled (registered to Amazon WorkMail), disabled (deregistered\n or never registered to WorkMail), or deleted.

    " } }, "ResourceId": { @@ -1099,16 +1694,10 @@ "smithy.api#documentation": "

    The identifier of the described resource.

    " } }, - "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).

    " - } - }, - "BookingOptions": { - "target": "com.amazonaws.workmail#BookingOptions", + "Email": { + "target": "com.amazonaws.workmail#EmailAddress", "traits": { - "smithy.api#documentation": "

    The booking options for the described resource.

    " + "smithy.api#documentation": "

    The email of the described resource.

    " } }, "EnabledDate": { @@ -1117,10 +1706,16 @@ "smithy.api#documentation": "

    The date and time when a resource was enabled for WorkMail, in UNIX epoch time\n format.

    " } }, - "Email": { - "target": "com.amazonaws.workmail#EmailAddress", + "BookingOptions": { + "target": "com.amazonaws.workmail#BookingOptions", "traits": { - "smithy.api#documentation": "

    The email of the described resource.

    " + "smithy.api#documentation": "

    The booking options for the described resource.

    " + } + }, + "Name": { + "target": "com.amazonaws.workmail#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the described resource.

    " } } } @@ -1177,37 +1772,43 @@ "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.

    " } }, - "EnabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + "Name": { + "target": "com.amazonaws.workmail#UserName", "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 name for the user.

    " } }, - "Email": { - "target": "com.amazonaws.workmail#EmailAddress", + "EnabledDate": { + "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

    The email of the user.

    " + "smithy.api#documentation": "

    The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch\n time format.

    " } }, "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.

    " } }, "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).

    " } }, - "Name": { - "target": "com.amazonaws.workmail#UserName", + "Email": { + "target": "com.amazonaws.workmail#EmailAddress", "traits": { - "smithy.api#documentation": "

    The name for the user.

    " + "smithy.api#documentation": "

    The email of the user.

    " + } + }, + "DisplayName": { + "target": "com.amazonaws.workmail#String", + "traits": { + "smithy.api#documentation": "

    The display name of the user.

    " } }, "UserId": { @@ -1215,13 +1816,39 @@ "traits": { "smithy.api#documentation": "

    The identifier for the described user.

    " } + } + } + }, + "com.amazonaws.workmail#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 }, - "DisplayName": { - "target": "com.amazonaws.workmail#String", - "traits": { - "smithy.api#documentation": "

    The display name of the user.

    " - } + "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": { @@ -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" } }, @@ -1281,24 +1908,24 @@ "com.amazonaws.workmail#DisassociateDelegateFromResourceRequest": { "type": "structure", "members": { - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "ResourceId": { + "target": "com.amazonaws.workmail#ResourceId", "traits": { - "smithy.api#documentation": "

    The identifier for the organization under which the resource exists.

    ", + "smithy.api#documentation": "

    The identifier of the resource from which delegates' set members are removed.\n

    ", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.workmail#ResourceId", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The identifier of the resource from which delegates' set members are removed.

    ", + "smithy.api#documentation": "

    The identifier for the organization under which the resource exists.

    ", "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": { + "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.

    " + } + }, + "DomainName": { + "target": "com.amazonaws.workmail#DomainName", + "traits": { + "smithy.api#documentation": "

    The fully qualified domain name.

    " + } + } + }, + "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,14 +2123,219 @@ "smithy.api#error": "client" } }, - "com.amazonaws.workmail#GetMailboxDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.workmail#GetMailboxDetailsRequest" - }, - "output": { - "target": "com.amazonaws.workmail#GetMailboxDetailsResponse" - }, + "com.amazonaws.workmail#FolderConfiguration": { + "type": "structure", + "members": { + "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": {} + } + }, + "Period": { + "target": "com.amazonaws.workmail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

    The period of time at which the folder configuration action is applied.

    " + } + }, + "Name": { + "target": "com.amazonaws.workmail#FolderName", + "traits": { + "smithy.api#documentation": "

    The folder name.

    ", + "smithy.api#required": {} + } + } + }, + "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": { + "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": {} + } + }, + "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": {} + } + }, + "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": { + "FolderConfigurations": { + "target": "com.amazonaws.workmail#FolderConfigurations", + "traits": { + "smithy.api#documentation": "

    The retention policy folder configurations.

    " + } + }, + "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.

    " + } + }, + "Id": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

    The retention policy ID.

    " + } + } + } + }, + "com.amazonaws.workmail#GetMailboxDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#GetMailboxDetailsRequest" + }, + "output": { + "target": "com.amazonaws.workmail#GetMailboxDetailsResponse" + }, "errors": [ { "target": "com.amazonaws.workmail#EntityNotFoundException" @@ -1517,22 +2391,16 @@ "com.amazonaws.workmail#Group": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.workmail#EntityState", - "traits": { - "smithy.api#documentation": "

    The state of the group, which can be ENABLED, DISABLED, or DELETED.

    " - } - }, - "Email": { - "target": "com.amazonaws.workmail#EmailAddress", + "DisabledDate": { + "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

    The email of the group.

    " + "smithy.api#documentation": "

    The date indicating when the group was disabled from Amazon WorkMail use.

    " } }, - "Id": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "Name": { + "target": "com.amazonaws.workmail#GroupName", "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    " + "smithy.api#documentation": "

    The name of the group.

    " } }, "EnabledDate": { @@ -1541,16 +2409,22 @@ "smithy.api#documentation": "

    The date indicating when the group was enabled for Amazon WorkMail use.

    " } }, - "Name": { - "target": "com.amazonaws.workmail#GroupName", + "Id": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

    The name of the group.

    " + "smithy.api#documentation": "

    The identifier of the group.

    " } }, - "DisabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + "Email": { + "target": "com.amazonaws.workmail#EmailAddress", "traits": { - "smithy.api#documentation": "

    The date indicating when the group was disabled from Amazon WorkMail use.

    " + "smithy.api#documentation": "

    The email of the group.

    " + } + }, + "State": { + "target": "com.amazonaws.workmail#EntityState", + "traits": { + "smithy.api#documentation": "

    The state of the group, which can be ENABLED, DISABLED, or DELETED.

    " } } }, @@ -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", @@ -1734,7 +2731,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": {} } }, @@ -1745,34 +2742,34 @@ "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.workmail#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " - } - }, "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\n contain any tokens.

    " } + }, + "MaxResults": { + "target": "com.amazonaws.workmail#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " + } } } }, "com.amazonaws.workmail#ListGroupMembersResponse": { "type": "structure", "members": { - "Members": { - "target": "com.amazonaws.workmail#Members", - "traits": { - "smithy.api#documentation": "

    The members associated to the group.

    " - } - }, "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\n contain any tokens.

    " } + }, + "Members": { + "target": "com.amazonaws.workmail#Members", + "traits": { + "smithy.api#documentation": "

    The members associated to the group.

    " + } } } }, @@ -1817,18 +2814,18 @@ "smithy.api#documentation": "

    The token to use to retrieve the next page of results. The first call does not\n contain any tokens.

    " } }, - "MaxResults": { - "target": "com.amazonaws.workmail#MaxResults", - "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " - } - }, "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { "smithy.api#documentation": "

    The identifier for the organization under which the groups exist.

    ", "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.workmail#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " + } } } }, @@ -1849,6 +2846,76 @@ } } }, + "com.amazonaws.workmail#ListMailboxExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#ListMailboxExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.workmail#ListMailboxExportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "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", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.workmail#ListMailboxExportJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", + "traits": { + "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.

    " + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The organization ID.

    ", + "smithy.api#required": {} + } + } + } + }, + "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": { @@ -1891,17 +2958,10 @@ "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": { @@ -1909,23 +2969,30 @@ "traits": { "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " } + }, + "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": {} + } } } }, "com.amazonaws.workmail#ListMailboxPermissionsResponse": { "type": "structure", "members": { - "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.

    " - } - }, "Permissions": { "target": "com.amazonaws.workmail#Permissions", "traits": { "smithy.api#documentation": "

    One page of the user, group, or resource mailbox permissions.

    " } + }, + "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\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", @@ -1981,7 +3048,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.

    " } } } @@ -2030,13 +3097,6 @@ "smithy.api#documentation": "

    The number of maximum results in a page.

    " } }, - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", - "traits": { - "smithy.api#documentation": "

    The identifier for the organization that contains the resource for which delegates\n are listed.

    ", - "smithy.api#required": {} - } - }, "ResourceId": { "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { @@ -2047,7 +3107,14 @@ "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.

    " + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The identifier for the organization that contains the resource for which delegates\n are listed.

    ", + "smithy.api#required": {} } } } @@ -2055,17 +3122,17 @@ "com.amazonaws.workmail#ListResourceDelegatesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.workmail#NextToken", - "traits": { - "smithy.api#documentation": "

    The token used to paginate through the delegates associated with a resource. While\n results are still available, it has an associated value. When the last page is reached, the\n token is empty.

    " - } - }, "Delegates": { "target": "com.amazonaws.workmail#ResourceDelegates", "traits": { "smithy.api#documentation": "

    One page of the resource's delegates.

    " } + }, + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", + "traits": { + "smithy.api#documentation": "

    The token used to paginate through the delegates associated with a resource. While\n results are still available, it has an associated value. When the last page is reached, the\n token is empty.

    " + } } } }, @@ -2101,10 +3168,11 @@ "com.amazonaws.workmail#ListResourcesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.workmail#MaxResults", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " + "smithy.api#documentation": "

    The identifier for the organization under which the resources exist.

    ", + "smithy.api#required": {} } }, "NextToken": { @@ -2113,11 +3181,10 @@ "smithy.api#documentation": "

    The token to use to retrieve the next page of results. The first call does not\n contain any tokens.

    " } }, - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "MaxResults": { + "target": "com.amazonaws.workmail#MaxResults", "traits": { - "smithy.api#documentation": "

    The identifier for the organization under which the resources exist.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " } } } @@ -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": { @@ -2171,10 +3278,17 @@ "com.amazonaws.workmail#ListUsersRequest": { "type": "structure", "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The identifier for the organization under which the users exist.

    ", + "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": { @@ -2182,13 +3296,6 @@ "traits": { "smithy.api#documentation": "

    The maximum number of results to return in a single call.

    " } - }, - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", - "traits": { - "smithy.api#documentation": "

    The identifier for the organization under which the users exist.

    ", - "smithy.api#required": {} - } } } }, @@ -2198,7 +3305,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.

    " } }, "Users": { @@ -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": { + "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.

    " + } + }, + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the user or resource associated with the mailbox.

    " + } + }, + "EndTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The mailbox export job end timestamp.

    " + } + }, + "Description": { + "target": "com.amazonaws.workmail#Description", + "traits": { + "smithy.api#documentation": "

    The mailbox export job description.

    " + } + }, + "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.

    " + } + }, + "S3BucketName": { + "target": "com.amazonaws.workmail#S3BucketName", + "traits": { + "smithy.api#documentation": "

    The name of the S3 bucket.

    " + } + }, + "EstimatedProgress": { + "target": "com.amazonaws.workmail#Percentage", + "traits": { + "smithy.api#documentation": "

    The estimated progress of the mailbox export job, in percentage points.

    " + } + }, + "JobId": { + "target": "com.amazonaws.workmail#MailboxExportJobId", + "traits": { + "smithy.api#documentation": "

    The identifier of the mailbox export job.

    " + } + } + }, + "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": { @@ -2269,24 +3481,12 @@ "smithy.api#documentation": "

    The state of the member, which can be ENABLED, DISABLED, or DELETED.

    " } }, - "Id": { - "target": "com.amazonaws.workmail#String", - "traits": { - "smithy.api#documentation": "

    The identifier of the member.

    " - } - }, "Name": { "target": "com.amazonaws.workmail#String", "traits": { "smithy.api#documentation": "

    The name of the member.

    " } }, - "EnabledDate": { - "target": "com.amazonaws.workmail#Timestamp", - "traits": { - "smithy.api#documentation": "

    The date indicating when the member was enabled for Amazon WorkMail\n use.

    " - } - }, "Type": { "target": "com.amazonaws.workmail#MemberType", "traits": { @@ -2296,7 +3496,19 @@ "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.

    " + } + }, + "EnabledDate": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date indicating when the member was enabled for Amazon WorkMail use.

    " + } + }, + "Id": { + "target": "com.amazonaws.workmail#String", + "traits": { + "smithy.api#documentation": "

    The identifier of the member.

    " } } }, @@ -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" } }, @@ -2395,16 +3612,16 @@ "com.amazonaws.workmail#OrganizationSummary": { "type": "structure", "members": { - "ErrorMessage": { + "State": { "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 state associated with the organization.

    " } }, - "State": { - "target": "com.amazonaws.workmail#String", + "DefaultMailDomain": { + "target": "com.amazonaws.workmail#DomainName", "traits": { - "smithy.api#documentation": "

    The state associated with the organization.

    " + "smithy.api#documentation": "

    The default email domain associated with the organization.

    " } }, "Alias": { @@ -2413,6 +3630,12 @@ "smithy.api#documentation": "

    The alias 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.

    " + } + }, "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { @@ -2435,13 +3658,29 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.workmail#Percentage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.workmail#Permission": { "type": "structure", "members": { + "GranteeId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the user, group, or resource to which the permissions are\n granted.

    ", + "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 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": {} } }, @@ -2451,13 +3690,6 @@ "smithy.api#documentation": "

    The type of user, group, or resource referred to in GranteeId.

    ", "smithy.api#required": {} } - }, - "GranteeId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", - "traits": { - "smithy.api#documentation": "

    The identifier of the user, group, or resource to which the permissions are\n granted.

    ", - "smithy.api#required": {} - } } }, "traits": { @@ -2495,6 +3727,119 @@ "target": "com.amazonaws.workmail#Permission" } }, + "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#PutAccessControlRuleRequest" + }, + "output": { + "target": "com.amazonaws.workmail#PutAccessControlRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#LimitExceededException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "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#PutAccessControlRuleRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.workmail#AccessControlRuleDescription", + "traits": { + "smithy.api#documentation": "

    The rule description.

    ", + "smithy.api#required": {} + } + }, + "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.

    " + } + }, + "NotIpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

    IPv4 CIDR ranges to exclude from the rule.

    " + } + }, + "Name": { + "target": "com.amazonaws.workmail#AccessControlRuleName", + "traits": { + "smithy.api#documentation": "

    The rule name.

    ", + "smithy.api#required": {} + } + }, + "Effect": { + "target": "com.amazonaws.workmail#AccessControlRuleEffect", + "traits": { + "smithy.api#documentation": "

    The rule effect.

    ", + "smithy.api#required": {} + } + }, + "IpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

    IPv4 CIDR ranges to include in the rule.

    " + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The identifier of the organization.

    ", + "smithy.api#required": {} + } + }, + "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.

    " + } + }, + "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.

    " + } + } + } + }, + "com.amazonaws.workmail#PutAccessControlRuleResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#PutMailboxPermissions": { "type": "operation", "input": { @@ -2545,7 +3890,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": {} } }, @@ -2562,6 +3907,75 @@ "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": { + "Name": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

    The retention policy name.

    ", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

    The retention policy ID.

    " + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

    The organization ID.

    ", + "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": { @@ -2606,13 +4020,20 @@ } ], "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": "

    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": {} } }, "com.amazonaws.workmail#RegisterToWorkMailRequest": { "type": "structure", "members": { + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier for the user, group, or resource to be updated.

    ", + "smithy.api#required": {} + } + }, "Email": { "target": "com.amazonaws.workmail#EmailAddress", "traits": { @@ -2626,13 +4047,6 @@ "smithy.api#documentation": "

    The identifier for 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 for the user, group, or resource to be updated.

    ", - "smithy.api#required": {} - } } } }, @@ -2697,17 +4111,17 @@ "com.amazonaws.workmail#ResetPasswordRequest": { "type": "structure", "members": { - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "UserId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", "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 of the user for whom the password is reset.

    ", "smithy.api#required": {} } }, - "UserId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The identifier of the user for whom the password is reset.

    ", + "smithy.api#documentation": "

    The identifier of the organization that contains the user for which the password is\n reset.

    ", "smithy.api#required": {} } }, @@ -2730,94 +4144,391 @@ "EnabledDate": { "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

    The date indicating when the resource was enabled for Amazon WorkMail use.

    " + "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.

    " + } + }, + "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.

    " + } + }, + "Name": { + "target": "com.amazonaws.workmail#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the resource.

    " + } + }, + "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.

    " + } + } + }, + "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#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[a-zA-Z0-9_-]+" + } + }, + "com.amazonaws.workmail#StartMailboxExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#StartMailboxExportJobRequest" + }, + "output": { + "target": "com.amazonaws.workmail#StartMailboxExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#LimitExceededException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "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#StartMailboxExportJobRequest": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the user or resource associated with the mailbox.

    ", + "smithy.api#required": {} } }, - "Email": { - "target": "com.amazonaws.workmail#EmailAddress", + "Description": { + "target": "com.amazonaws.workmail#Description", "traits": { - "smithy.api#documentation": "

    The email of the resource.

    " + "smithy.api#documentation": "

    The mailbox export job description.

    " } }, - "Type": { - "target": "com.amazonaws.workmail#ResourceType", + "RoleArn": { + "target": "com.amazonaws.workmail#RoleArn", "traits": { - "smithy.api#documentation": "

    The type of the resource: equipment or room.

    " + "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": {} } }, - "DisabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", "traits": { - "smithy.api#documentation": "

    The date indicating when the resource was disabled from Amazon WorkMail\n use.

    " + "smithy.api#documentation": "

    The idempotency token for the client request.

    ", + "smithy.api#idempotencyToken": {}, + "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": {} } }, - "Id": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "S3Prefix": { + "target": "com.amazonaws.workmail#S3ObjectKey", "traits": { - "smithy.api#documentation": "

    The identifier of the resource.

    " + "smithy.api#documentation": "

    The S3 bucket prefix.

    ", + "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.workmail#EntityState", + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

    The state of the resource, which can be ENABLED, DISABLED, or DELETED.

    " + "smithy.api#documentation": "

    The identifier associated with the organization.

    ", + "smithy.api#required": {} + } + }, + "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.

    ", + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

    The representation of a resource.

    " } }, - "com.amazonaws.workmail#ResourceDelegates": { - "type": "list", - "member": { - "target": "com.amazonaws.workmail#Delegate" + "com.amazonaws.workmail#StartMailboxExportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.workmail#MailboxExportJobId", + "traits": { + "smithy.api#documentation": "

    The job ID.

    " + } + } } }, - "com.amazonaws.workmail#ResourceId": { + "com.amazonaws.workmail#String": { "type": "string", "traits": { - "smithy.api#pattern": "^r-[0-9a-f]{32}$" + "smithy.api#length": { + "min": 0, + "max": 256 + } } }, - "com.amazonaws.workmail#ResourceName": { + "com.amazonaws.workmail#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.workmail#TagKey", + "traits": { + "smithy.api#documentation": "

    The key of the tag.

    ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.workmail#TagValue", + "traits": { + "smithy.api#documentation": "

    The value of the tag.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a tag applied to a resource.

    " + } + }, + "com.amazonaws.workmail#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 20 - }, - "smithy.api#pattern": "[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9]{2,})?" + "max": 128 + } } }, - "com.amazonaws.workmail#ResourceType": { - "type": "string", + "com.amazonaws.workmail#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#TagKey" + }, "traits": { - "smithy.api#enum": [ - { - "value": "ROOM", - "name": "ROOM" - }, - { - "value": "EQUIPMENT", - "name": "EQUIPMENT" - } - ] + "smithy.api#length": { + "min": 0, + "max": 50 + } } }, - "com.amazonaws.workmail#Resources": { + "com.amazonaws.workmail#TagList": { "type": "list", "member": { - "target": "com.amazonaws.workmail#Resource" + "target": "com.amazonaws.workmail#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } } }, - "com.amazonaws.workmail#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#documentation": "

    Applies the specified tags to the specified Amazon WorkMail organization\n resource.

    " + } + }, + "com.amazonaws.workmail#TagResourceRequest": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.workmail#TagList", + "traits": { + "smithy.api#documentation": "

    The tag key-value pairs.

    ", + "smithy.api#required": {} + } + }, + "ResourceARN": { + "target": "com.amazonaws.workmail#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    The resource ARN.

    ", + "smithy.api#required": {} + } + } + } + }, + "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": {} } }, @@ -2884,7 +4648,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": {} } }, @@ -3027,6 +4791,12 @@ "com.amazonaws.workmail#UpdateResourceRequest": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.workmail#ResourceName", + "traits": { + "smithy.api#documentation": "

    The name of the resource to be updated.

    " + } + }, "ResourceId": { "target": "com.amazonaws.workmail#ResourceId", "traits": { @@ -3034,24 +4804,18 @@ "smithy.api#required": {} } }, + "BookingOptions": { + "target": "com.amazonaws.workmail#BookingOptions", + "traits": { + "smithy.api#documentation": "

    The resource's booking options to be updated.

    " + } + }, "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { "smithy.api#documentation": "

    The identifier associated with the organization for which the resource is\n updated.

    ", "smithy.api#required": {} } - }, - "Name": { - "target": "com.amazonaws.workmail#ResourceName", - "traits": { - "smithy.api#documentation": "

    The name of the resource to be updated.

    " - } - }, - "BookingOptions": { - "target": "com.amazonaws.workmail#BookingOptions", - "traits": { - "smithy.api#documentation": "

    The resource's booking options to be updated.

    " - } } } }, @@ -3068,22 +4832,22 @@ "smithy.api#documentation": "

    The display name of the user.

    " } }, - "State": { - "target": "com.amazonaws.workmail#EntityState", - "traits": { - "smithy.api#documentation": "

    The state of the user, which can be ENABLED, DISABLED, or DELETED.

    " - } - }, "Name": { "target": "com.amazonaws.workmail#UserName", "traits": { "smithy.api#documentation": "

    The name of the user.

    " } }, - "UserRole": { - "target": "com.amazonaws.workmail#UserRole", + "DisabledDate": { + "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

    The role of the user.

    " + "smithy.api#documentation": "

    The date indicating when the user was disabled from Amazon WorkMail use.

    " + } + }, + "EnabledDate": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date indicating when the user was enabled for Amazon WorkMail use.

    " } }, "Id": { @@ -3098,16 +4862,16 @@ "smithy.api#documentation": "

    The email of the user.

    " } }, - "EnabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + "State": { + "target": "com.amazonaws.workmail#EntityState", "traits": { - "smithy.api#documentation": "

    The date indicating when the user was enabled for Amazon WorkMail use.

    " + "smithy.api#documentation": "

    The state of the user, which can be ENABLED, DISABLED, or DELETED.

    " } }, - "DisabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + "UserRole": { + "target": "com.amazonaws.workmail#UserRole", "traits": { - "smithy.api#documentation": "

    The date indicating when the user was disabled from Amazon WorkMail use.

    " + "smithy.api#documentation": "

    The role of the user.

    " } } }, @@ -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" }, @@ -3268,13 +5092,13 @@ "sdkId": "WorkMail", "arnNamespace": "workmail", "cloudFormationName": "WorkMail", - "cloudTrailEventSource": "service.workmail.amazonaws.com" + "cloudTrailEventSource": "workmail.amazonaws.com" }, "aws.auth#sigv4": { "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

      Listing and describing organizations

      \n
      • \n
    \n
      \n
    • \n

      Managing users

      \n
      • \n
    \n
      \n
    • \n

      Managing groups

      \n
      • \n
    \n
      \n
    • \n

      Managing resources

      \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

      Listing and describing organizations

      \n
      • \n
    \n
      \n
    • \n

      Managing users

      \n
      • \n
    \n
      \n
    • \n

      Managing groups

      \n
      • \n
    \n
      \n
    • \n

      Managing resources

      \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" } } diff --git a/codegen/sdk-codegen/aws-models/workmailmessageflow.2019-05-01.json b/codegen/sdk-codegen/aws-models/workmailmessageflow.2019-05-01.json index b15d60aa24f6..42a87f97d479 100644 --- a/codegen/sdk-codegen/aws-models/workmailmessageflow.2019-05-01.json +++ b/codegen/sdk-codegen/aws-models/workmailmessageflow.2019-05-01.json @@ -90,7 +90,7 @@ "sdkId": "WorkMailMessageFlow", "arnNamespace": "workmailmessageflow", "cloudFormationName": "WorkMailMessageFlow", - "cloudTrailEventSource": "service.workmailmessageflow.amazonaws.com" + "cloudTrailEventSource": "workmailmessageflow.amazonaws.com" }, "aws.auth#sigv4": { "name": "workmailmessageflow" diff --git a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json index f0cfcb516b60..6d9e11cffe63 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json +++ b/codegen/sdk-codegen/aws-models/workspaces.2015-04-08.json @@ -65,22 +65,10 @@ "com.amazonaws.workspaces#AccountModification": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", - "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned if the configuration of BYOL cannot be\n modified.

    " - } - }, - "ModificationState": { - "target": "com.amazonaws.workspaces#DedicatedTenancyModificationStateEnum", - "traits": { - "smithy.api#documentation": "

    The state of the modification to the configuration of BYOL.

    " - } - }, - "DedicatedTenancyManagementCidrRange": { - "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "DedicatedTenancySupport": { + "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", "traits": { - "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, for the management network\n interface used for the account.

    " + "smithy.api#documentation": "

    The status of BYOL (whether BYOL is being enabled or disabled).

    " } }, "ErrorCode": { @@ -95,10 +83,22 @@ "smithy.api#documentation": "

    The timestamp when the modification of the BYOL configuration was started.

    " } }, - "DedicatedTenancySupport": { - "target": "com.amazonaws.workspaces#DedicatedTenancySupportResultEnum", + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", "traits": { - "smithy.api#documentation": "

    The status of BYOL (whether BYOL is being enabled or disabled).

    " + "smithy.api#documentation": "

    The text of the error message that is returned if the configuration of BYOL cannot be\n modified.

    " + } + }, + "DedicatedTenancyManagementCidrRange": { + "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", + "traits": { + "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, for the management network\n interface used for the account.

    " + } + }, + "ModificationState": { + "target": "com.amazonaws.workspaces#DedicatedTenancyModificationStateEnum", + "traits": { + "smithy.api#documentation": "

    The state of the modification to the configuration of BYOL.

    " } } }, @@ -115,6 +115,95 @@ "com.amazonaws.workspaces#Alias": { "type": "string" }, + "com.amazonaws.workspaces#Application": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Microsoft_Office_2016", + "name": "Microsoft_Office_2016" + }, + { + "value": "Microsoft_Office_2019", + "name": "Microsoft_Office_2019" + } + ] + } + }, + "com.amazonaws.workspaces#ApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#Application" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.workspaces#AssociateConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#AssociateConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#AssociateConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Associates the specified connection alias with the specified directory to enable cross-Region redirection. \n For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n

    Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

    \n     " + } + }, + "com.amazonaws.workspaces#AssociateConnectionAliasRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    ", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory to associate the connection alias with.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#AssociateConnectionAliasResult": { + "type": "structure", + "members": { + "ConnectionIdentifier": { + "target": "com.amazonaws.workspaces#ConnectionIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when \n you're configuring your DNS routing policies.

    " + } + } + } + }, "com.amazonaws.workspaces#AssociateIpGroups": { "type": "operation", "input": { @@ -150,17 +239,17 @@ "com.amazonaws.workspaces#AssociateIpGroupsRequest": { "type": "structure", "members": { - "GroupIds": { - "target": "com.amazonaws.workspaces#IpGroupIdList", + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", "traits": { - "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", + "smithy.api#documentation": "

    The identifier of the directory.

    ", "smithy.api#required": {} } }, - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", + "GroupIds": { + "target": "com.amazonaws.workspaces#IpGroupIdList", "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", "smithy.api#required": {} } } @@ -170,6 +259,33 @@ "type": "structure", "members": {} }, + "com.amazonaws.workspaces#AssociationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_ASSOCIATED", + "name": "NOT_ASSOCIATED" + }, + { + "value": "ASSOCIATED_WITH_OWNER_ACCOUNT", + "name": "ASSOCIATED_WITH_OWNER_ACCOUNT" + }, + { + "value": "ASSOCIATED_WITH_SHARED_ACCOUNT", + "name": "ASSOCIATED_WITH_SHARED_ACCOUNT" + }, + { + "value": "PENDING_ASSOCIATION", + "name": "PENDING_ASSOCIATION" + }, + { + "value": "PENDING_DISASSOCIATION", + "name": "PENDING_DISASSOCIATION" + } + ] + } + }, "com.amazonaws.workspaces#AuthorizeIpRules": { "type": "operation", "input": { @@ -202,17 +318,17 @@ "com.amazonaws.workspaces#AuthorizeIpRulesRequest": { "type": "structure", "members": { - "UserRules": { - "target": "com.amazonaws.workspaces#IpRuleList", + "GroupId": { + "target": "com.amazonaws.workspaces#IpGroupId", "traits": { - "smithy.api#documentation": "

    The rules to add to the group.

    ", + "smithy.api#documentation": "

    The identifier of the group.

    ", "smithy.api#required": {} } }, - "GroupId": { - "target": "com.amazonaws.workspaces#IpGroupId", + "UserRules": { + "target": "com.amazonaws.workspaces#IpRuleList", "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    ", + "smithy.api#documentation": "

    The rules to add to the group.

    ", "smithy.api#required": {} } } @@ -353,6 +469,185 @@ "com.amazonaws.workspaces#ComputerName": { "type": "string" }, + "com.amazonaws.workspaces#ConnectionAlias": { + "type": "structure", + "members": { + "Associations": { + "target": "com.amazonaws.workspaces#ConnectionAliasAssociationList", + "traits": { + "smithy.api#documentation": "

    The association status of the connection alias.

    " + } + }, + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    " + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account that owns the connection alias.

    " + } + }, + "ConnectionString": { + "target": "com.amazonaws.workspaces#ConnectionString", + "traits": { + "smithy.api#documentation": "

    The connection string specified for the connection alias. The connection string must be in the form of \n a fully qualified domain name (FQDN), such as www.example.com.

    " + } + }, + "State": { + "target": "com.amazonaws.workspaces#ConnectionAliasState", + "traits": { + "smithy.api#documentation": "

    The current state of the connection alias.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, \n see \n Cross-Region Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#ConnectionAliasAssociation": { + "type": "structure", + "members": { + "AssociationStatus": { + "target": "com.amazonaws.workspaces#AssociationStatus", + "traits": { + "smithy.api#documentation": "

    The association status of the connection alias.

    " + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory associated with a connection alias.

    " + } + }, + "AssociatedAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account that associated the connection alias with a directory.

    " + } + }, + "ConnectionIdentifier": { + "target": "com.amazonaws.workspaces#ConnectionIdentifier", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when \n you're configuring your DNS routing policies.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a connection alias association that is used for cross-Region redirection. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#ConnectionAliasAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAliasAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 13, + "max": 68 + }, + "smithy.api#pattern": "^wsca-[0-9a-z]{8,63}$" + } + }, + "com.amazonaws.workspaces#ConnectionAliasIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAliasId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAlias" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasPermission": { + "type": "structure", + "members": { + "SharedAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", + "traits": { + "smithy.api#documentation": "

    The identifier of the AWS account that the connection alias is shared with.

    ", + "smithy.api#required": {} + } + }, + "AllowAssociation": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether the specified AWS account is allowed to associate the connection alias with a directory.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. \n For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#ConnectionAliasPermissions": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#ConnectionAliasPermission" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#ConnectionAliasState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.workspaces#ConnectionIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, "com.amazonaws.workspaces#ConnectionState": { "type": "string", "traits": { @@ -372,6 +667,16 @@ ] } }, + "com.amazonaws.workspaces#ConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[.0-9a-zA-Z\\-]{1,255}$" + } + }, "com.amazonaws.workspaces#CopyWorkspaceImage": { "type": "operation", "input": { @@ -400,58 +705,119 @@ "target": "com.amazonaws.workspaces#ResourceNotFoundException" }, { - "target": "com.amazonaws.workspaces#ResourceUnavailableException" + "target": "com.amazonaws.workspaces#ResourceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

    Copies the specified image from the specified Region to the current Region. \n For more information about copying images, see \n \n Copy a Custom WorkSpaces Image.

    \n \n \n

    Before copying a shared image, be sure to verify that it has been shared from the\n correct AWS account. To determine if an image has been shared and to see the AWS \n account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

    \n     " + } + }, + "com.amazonaws.workspaces#CopyWorkspaceImageRequest": { + "type": "structure", + "members": { + "SourceRegion": { + "target": "com.amazonaws.workspaces#Region", + "traits": { + "smithy.api#documentation": "

    The identifier of the source Region.

    ", + "smithy.api#required": {} + } + }, + "SourceImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the source image.

    ", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "

    The name of the image.

    ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags for the image.

    " + } + }, + "Description": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "

    A description of the image.

    " + } + } + } + }, + "com.amazonaws.workspaces#CopyWorkspaceImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    " + } + } + } + }, + "com.amazonaws.workspaces#CreateConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#CreateConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#CreateConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" } ], "traits": { - "smithy.api#documentation": "

    Copies the specified image from the specified Region to the current Region.

    " + "smithy.api#documentation": "

    Creates the specified connection alias for use with cross-Region redirection. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    " } }, - "com.amazonaws.workspaces#CopyWorkspaceImageRequest": { + "com.amazonaws.workspaces#CreateConnectionAliasRequest": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.workspaces#WorkspaceImageName", - "traits": { - "smithy.api#documentation": "

    The name of the image.

    ", - "smithy.api#required": {} - } - }, - "SourceImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", + "ConnectionString": { + "target": "com.amazonaws.workspaces#ConnectionString", "traits": { - "smithy.api#documentation": "

    The identifier of the source image.

    ", + "smithy.api#documentation": "

    A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

    \n \n \n

    After you create a connection string, it is always associated to your AWS account. You cannot recreate the same \n connection string with a different account, even if you delete all instances of it from the original account. The \n connection string is globally reserved for your account.

    \n     ", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.workspaces#TagList", "traits": { - "smithy.api#documentation": "

    The tags for the image.

    " - } - }, - "SourceRegion": { - "target": "com.amazonaws.workspaces#Region", - "traits": { - "smithy.api#documentation": "

    The identifier of the source Region.

    ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.workspaces#WorkspaceImageDescription", - "traits": { - "smithy.api#documentation": "

    A description of the image.

    " + "smithy.api#documentation": "

    The tags to associate with the connection alias.

    " } } } }, - "com.amazonaws.workspaces#CopyWorkspaceImageResult": { + "com.amazonaws.workspaces#CreateConnectionAliasResult": { "type": "structure", "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    " + "smithy.api#documentation": "

    The identifier of the connection alias.

    " } } } @@ -488,6 +854,18 @@ "com.amazonaws.workspaces#CreateIpGroupRequest": { "type": "structure", "members": { + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + } + }, + "GroupDesc": { + "target": "com.amazonaws.workspaces#IpGroupDesc", + "traits": { + "smithy.api#documentation": "

    The description of the group.

    " + } + }, "UserRules": { "target": "com.amazonaws.workspaces#IpRuleList", "traits": { @@ -500,18 +878,6 @@ "smithy.api#documentation": "

    The name of the group.

    ", "smithy.api#required": {} } - }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " - } - }, - "GroupDesc": { - "target": "com.amazonaws.workspaces#IpGroupDesc", - "traits": { - "smithy.api#documentation": "

    The description of the group.

    " - } } } }, @@ -555,14 +921,14 @@ "Tags": { "target": "com.amazonaws.workspaces#TagList", "traits": { - "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to add new tags\n to a set of existing tags, you must submit all of the existing tags along with the new ones.

    ", + "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    ", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.workspaces#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, and IP access control groups.

    ", + "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection aliases.

    ", "smithy.api#required": {} } } @@ -684,16 +1050,16 @@ "com.amazonaws.workspaces#DefaultWorkspaceCreationProperties": { "type": "structure", "members": { - "CustomSecurityGroupId": { - "target": "com.amazonaws.workspaces#SecurityGroupId", + "UserEnabledAsLocalAdministrator": { + "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    The identifier of the default security group to apply to WorkSpaces when they are created. \n For more information, see \n \n Security Groups for Your WorkSpaces.

    " + "smithy.api#documentation": "

    Specifies whether WorkSpace users are local administrators on their WorkSpaces.

    " } }, - "EnableInternetAccess": { - "target": "com.amazonaws.workspaces#BooleanObject", + "DefaultOu": { + "target": "com.amazonaws.workspaces#DefaultOu", "traits": { - "smithy.api#documentation": "

    Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. \n If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an \n internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address \n Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public \n subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting \n applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, \n see \n Configure a VPC for Amazon WorkSpaces.

    " + "smithy.api#documentation": "

    The organizational unit (OU) in the directory for the WorkSpace machine accounts.

    " } }, "EnableWorkDocs": { @@ -702,22 +1068,22 @@ "smithy.api#documentation": "

    Specifies whether the directory is enabled for Amazon WorkDocs.

    " } }, - "DefaultOu": { - "target": "com.amazonaws.workspaces#DefaultOu", + "EnableInternetAccess": { + "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    The organizational unit (OU) in the directory for the WorkSpace machine accounts.

    " + "smithy.api#documentation": "

    Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. \n If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an \n internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address \n Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public \n subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting \n applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, \n see \n Configure a VPC for Amazon WorkSpaces.

    " } }, - "EnableMaintenanceMode": { - "target": "com.amazonaws.workspaces#BooleanObject", + "CustomSecurityGroupId": { + "target": "com.amazonaws.workspaces#SecurityGroupId", "traits": { - "smithy.api#documentation": "

    Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see\n WorkSpace\n Maintenance.

    " + "smithy.api#documentation": "

    The identifier of the default security group to apply to WorkSpaces when they are created. \n For more information, see \n \n Security Groups for Your WorkSpaces.

    " } }, - "UserEnabledAsLocalAdministrator": { + "EnableMaintenanceMode": { "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    Specifies whether WorkSpace users are local administrators on their WorkSpaces.

    " + "smithy.api#documentation": "

    Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see\n WorkSpace\n Maintenance.

    " } } }, @@ -725,6 +1091,54 @@ "smithy.api#documentation": "

    Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

    " } }, + "com.amazonaws.workspaces#DeleteConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DeleteConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DeleteConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes the specified connection alias. For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n

    \n If you will no longer be using a fully qualified domain name (FQDN) as the registration code \n for your WorkSpaces users, you must take certain precautions to prevent potential security issues. \n For more information, see \n \n Security Considerations if You Stop Using Cross-Region Redirection.

    \n     \n \n \n

    To delete a connection alias that has been shared, the shared account must first disassociate the connection alias \n from any directories it has been associated with. Then you must unshare the connection alias from the account it has \n been shared with. You can delete a connection alias only after it is no longer shared with any accounts or \n associated with any directories.

    \n     " + } + }, + "com.amazonaws.workspaces#DeleteConnectionAliasRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias to delete.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DeleteConnectionAliasResult": { + "type": "structure", + "members": {} + }, "com.amazonaws.workspaces#DeleteIpGroup": { "type": "operation", "input": { @@ -800,7 +1214,7 @@ "ResourceId": { "target": "com.amazonaws.workspaces#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, and IP access control groups.

    ", + "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection aliases.

    ", "smithy.api#required": {} } } @@ -942,17 +1356,17 @@ "com.amazonaws.workspaces#DescribeAccountModificationsResult": { "type": "structure", "members": { - "AccountModifications": { - "target": "com.amazonaws.workspaces#AccountModificationList", - "traits": { - "smithy.api#documentation": "

    The list of modifications to the configuration of BYOL.

    " - } - }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { "smithy.api#documentation": "

    The token to use to retrieve the next set of results, or null if no more results are\n available.

    " } + }, + "AccountModifications": { + "target": "com.amazonaws.workspaces#AccountModificationList", + "traits": { + "smithy.api#documentation": "

    The list of modifications to the configuration of BYOL.

    " + } } } }, @@ -1023,6 +1437,148 @@ } } }, + "com.amazonaws.workspaces#DescribeConnectionAliasPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the permissions that the owner of a connection alias has granted to another AWS account for \n the specified connection alias. For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated, provide this token to receive the \n next set of results.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return.

    " + } + }, + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasPermissionsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + }, + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias.

    " + } + }, + "ConnectionAliasPermissions": { + "target": "com.amazonaws.workspaces#ConnectionAliasPermissions", + "traits": { + "smithy.api#documentation": "

    The permissions associated with a connection alias.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + } + ], + "traits": { + "smithy.api#documentation": "

    Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    " + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasesRequest": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of connection aliases to return.

    " + } + }, + "ResourceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

    The identifier of the directory associated with the connection alias.

    " + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated, provide this token to receive the \n next set of results.

    " + } + }, + "AliasIds": { + "target": "com.amazonaws.workspaces#ConnectionAliasIdList", + "traits": { + "smithy.api#documentation": "

    The identifiers of the connection aliases to describe.

    " + } + } + } + }, + "com.amazonaws.workspaces#DescribeConnectionAliasesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + }, + "ConnectionAliases": { + "target": "com.amazonaws.workspaces#ConnectionAliasList", + "traits": { + "smithy.api#documentation": "

    Information about the specified connection aliases.

    " + } + } + } + }, "com.amazonaws.workspaces#DescribeIpGroups": { "type": "operation", "input": { @@ -1046,22 +1602,22 @@ "com.amazonaws.workspaces#DescribeIpGroupsRequest": { "type": "structure", "members": { - "GroupIds": { - "target": "com.amazonaws.workspaces#IpGroupIdList", + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", "traits": { - "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    " + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " } }, - "MaxResults": { - "target": "com.amazonaws.workspaces#Limit", + "GroupIds": { + "target": "com.amazonaws.workspaces#IpGroupIdList", "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " + "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    " } }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + "smithy.api#documentation": "

    The maximum number of items to return.

    " } } } @@ -1106,7 +1662,7 @@ "ResourceId": { "target": "com.amazonaws.workspaces#NonEmptyString", "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, and IP access control groups.

    ", + "smithy.api#documentation": "

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces,\n registered directories, images, custom bundles, IP access control groups, and connection aliases.

    ", "smithy.api#required": {} } } @@ -1210,18 +1766,18 @@ "com.amazonaws.workspaces#DescribeWorkspaceDirectoriesRequest": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of directories to return.

    " - } - }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " } }, + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of directories to return.

    " + } + }, "DirectoryIds": { "target": "com.amazonaws.workspaces#DirectoryIdList", "traits": { @@ -1273,18 +1829,18 @@ "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated, \n provide this token to receive the next set of results.

    " } }, + "MaxResults": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + }, "ImageId": { "target": "com.amazonaws.workspaces#WorkspaceImageId", "traits": { @@ -1297,18 +1853,18 @@ "com.amazonaws.workspaces#DescribeWorkspaceImagePermissionsResult": { "type": "structure", "members": { - "ImagePermissions": { - "target": "com.amazonaws.workspaces#ImagePermissions", - "traits": { - "smithy.api#documentation": "

    The identifiers of the AWS accounts that the image has been shared with.

    " - } - }, "ImageId": { "target": "com.amazonaws.workspaces#WorkspaceImageId", "traits": { "smithy.api#documentation": "

    The identifier of the image.

    " } }, + "ImagePermissions": { + "target": "com.amazonaws.workspaces#ImagePermissions", + "traits": { + "smithy.api#documentation": "

    The identifiers of the AWS accounts that the image has been shared with.

    " + } + }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { @@ -1337,6 +1893,12 @@ "com.amazonaws.workspaces#DescribeWorkspaceImagesRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } + }, "ImageIds": { "target": "com.amazonaws.workspaces#WorkspaceImageIdList", "traits": { @@ -1349,12 +1911,6 @@ "smithy.api#documentation": "

    The maximum number of items to return.

    " } }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - }, "ImageType": { "target": "com.amazonaws.workspaces#ImageType", "traits": { @@ -1418,16 +1974,16 @@ "com.amazonaws.workspaces#DescribeWorkspaceSnapshotsResult": { "type": "structure", "members": { - "RebuildSnapshots": { + "RestoreSnapshots": { "target": "com.amazonaws.workspaces#SnapshotList", "traits": { - "smithy.api#documentation": "

    Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include\n the user volume.

    " + "smithy.api#documentation": "

    Information about the snapshots that can be used to restore a WorkSpace. These snapshots\n include both the root volume and the user volume.

    " } }, - "RestoreSnapshots": { + "RebuildSnapshots": { "target": "com.amazonaws.workspaces#SnapshotList", "traits": { - "smithy.api#documentation": "

    Information about the snapshots that can be used to restore a WorkSpace. These snapshots\n include both the root volume and the user volume.

    " + "smithy.api#documentation": "

    Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include\n the user volume.

    " } } } @@ -1495,27 +2051,27 @@ "com.amazonaws.workspaces#DescribeWorkspacesConnectionStatusResult": { "type": "structure", "members": { - "WorkspacesConnectionStatus": { - "target": "com.amazonaws.workspaces#WorkspaceConnectionStatusList", - "traits": { - "smithy.api#documentation": "

    Information about the connection status of the WorkSpace.

    " - } - }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { "smithy.api#documentation": "

    The token to use to retrieve the next set of results, or null if no more results are\n available.

    " } + }, + "WorkspacesConnectionStatus": { + "target": "com.amazonaws.workspaces#WorkspaceConnectionStatusList", + "traits": { + "smithy.api#documentation": "

    Information about the connection status of the WorkSpace.

    " + } } } }, "com.amazonaws.workspaces#DescribeWorkspacesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + "smithy.api#documentation": "

    The identifier of the bundle. All WorkSpaces that are created from this bundle are\n retrieved. You cannot combine this parameter with any other filter.

    " } }, "UserName": { @@ -1524,46 +2080,46 @@ "smithy.api#documentation": "

    The name of the directory user. You must specify this parameter with\n DirectoryId.

    " } }, - "Limit": { - "target": "com.amazonaws.workspaces#Limit", - "traits": { - "smithy.api#documentation": "

    The maximum number of items to return.

    " - } - }, - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", - "traits": { - "smithy.api#documentation": "

    The identifier of the bundle. All WorkSpaces that are created from this bundle are\n retrieved. You cannot combine this parameter with any other filter.

    " - } - }, "DirectoryId": { "target": "com.amazonaws.workspaces#DirectoryId", "traits": { "smithy.api#documentation": "

    The identifier of the directory. In addition, you can optionally specify a specific\n directory user (see UserName). You cannot combine this parameter with any\n other filter.

    " } }, + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "

    The maximum number of items to return.

    " + } + }, "WorkspaceIds": { "target": "com.amazonaws.workspaces#WorkspaceIdList", "traits": { "smithy.api#documentation": "

    The identifiers of the WorkSpaces. You cannot combine this parameter with any other\n filter.

    \n

    Because the CreateWorkspaces operation is asynchronous, the identifier\n it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    " } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } } } }, "com.amazonaws.workspaces#DescribeWorkspacesResult": { "type": "structure", "members": { - "Workspaces": { - "target": "com.amazonaws.workspaces#WorkspaceList", - "traits": { - "smithy.api#documentation": "

    Information about the WorkSpaces.

    \n

    Because CreateWorkspaces is an asynchronous operation, some of the\n returned information could be incomplete.

    " - } - }, "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { "smithy.api#documentation": "

    The token to use to retrieve the next set of results, or null if no more results are\n available.

    " } + }, + "Workspaces": { + "target": "com.amazonaws.workspaces#WorkspaceList", + "traits": { + "smithy.api#documentation": "

    Information about the WorkSpaces.

    \n

    Because CreateWorkspaces is an asynchronous operation, some of the\n returned information could be incomplete.

    " + } } } }, @@ -1601,6 +2157,51 @@ "com.amazonaws.workspaces#DirectoryName": { "type": "string" }, + "com.amazonaws.workspaces#DisassociateConnectionAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DisassociateConnectionAliasRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DisassociateConnectionAliasResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region \n redirection between two directories in different AWS Regions. For more information, see \n \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n

    Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

    \n     " + } + }, + "com.amazonaws.workspaces#DisassociateConnectionAliasRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias to disassociate.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#DisassociateConnectionAliasResult": { + "type": "structure", + "members": {} + }, "com.amazonaws.workspaces#DisassociateIpGroups": { "type": "operation", "input": { @@ -1630,17 +2231,17 @@ "com.amazonaws.workspaces#DisassociateIpGroupsRequest": { "type": "structure", "members": { - "GroupIds": { - "target": "com.amazonaws.workspaces#IpGroupIdList", + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", "traits": { - "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", + "smithy.api#documentation": "

    The identifier of the directory.

    ", "smithy.api#required": {} } }, - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", + "GroupIds": { + "target": "com.amazonaws.workspaces#IpGroupIdList", "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#documentation": "

    The identifiers of one or more IP access control groups.

    ", "smithy.api#required": {} } } @@ -1671,10 +2272,10 @@ "com.amazonaws.workspaces#FailedCreateWorkspaceRequest": { "type": "structure", "members": { - "WorkspaceRequest": { - "target": "com.amazonaws.workspaces#WorkspaceRequest", + "ErrorCode": { + "target": "com.amazonaws.workspaces#ErrorType", "traits": { - "smithy.api#documentation": "

    Information about the WorkSpace.

    " + "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " } }, "ErrorMessage": { @@ -1683,10 +2284,10 @@ "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n created.

    " } }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#ErrorType", + "WorkspaceRequest": { + "target": "com.amazonaws.workspaces#WorkspaceRequest", "traits": { - "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " + "smithy.api#documentation": "

    Information about the WorkSpace.

    " } } }, @@ -1733,10 +2334,10 @@ "com.amazonaws.workspaces#FailedWorkspaceChangeRequest": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n rebooted.

    " + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " } }, "ErrorCode": { @@ -1745,10 +2346,10 @@ "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be rebooted.

    " } }, - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " + "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n rebooted.

    " } } }, @@ -1767,7 +2368,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Describes the AWS accounts that have been granted permission to use a shared image.

    " + "smithy.api#documentation": "

    Describes the AWS accounts that have been granted permission to use a shared image. For more \n information about sharing images, see \n \n Share or Unshare a Custom WorkSpaces Image.

    " } }, "com.amazonaws.workspaces#ImagePermissions": { @@ -1820,19 +2421,25 @@ } ], "traits": { - "smithy.api#documentation": "

    Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into\n Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS\n account, and you must own the image.

    " + "smithy.api#documentation": "

    Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon\n WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS\n account, and you must own the image. For more information about creating BYOL images, see\n \n Bring Your Own Windows Desktop Licenses.

    " } }, "com.amazonaws.workspaces#ImportWorkspaceImageRequest": { "type": "structure", "members": { - "Ec2ImageId": { - "target": "com.amazonaws.workspaces#Ec2ImageId", + "ImageName": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", "traits": { - "smithy.api#documentation": "

    The identifier of the EC2 image.

    ", + "smithy.api#documentation": "

    The name of the WorkSpace image.

    ", "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + } + }, "ImageDescription": { "target": "com.amazonaws.workspaces#WorkspaceImageDescription", "traits": { @@ -1840,23 +2447,23 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", + "Ec2ImageId": { + "target": "com.amazonaws.workspaces#Ec2ImageId", "traits": { - "smithy.api#documentation": "

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + "smithy.api#documentation": "

    The identifier of the EC2 image.

    ", + "smithy.api#required": {} } }, - "IngestionProcess": { - "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", + "Applications": { + "target": "com.amazonaws.workspaces#ApplicationList", "traits": { - "smithy.api#documentation": "

    The ingestion process to be used when importing the image.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 \n BYOL images. For more information about subscribing to Office for BYOL images, see \n \n Bring Your Own Windows Desktop Licenses.

    \n \n \n

    Although this parameter is an array, only one item is allowed at this time.

    \n     " } }, - "ImageName": { - "target": "com.amazonaws.workspaces#WorkspaceImageName", + "IngestionProcess": { + "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", "traits": { - "smithy.api#documentation": "

    The name of the WorkSpace image.

    ", + "smithy.api#documentation": "

    The ingestion process to be used when importing the image. For non-GPU-enabled bundles \n (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR.

    ", "smithy.api#required": {} } } @@ -1986,7 +2593,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use\n for the network management interface when you enable Bring Your Own License (BYOL).

    \n

    The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " + "smithy.api#documentation": "

    Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use\n for the network management interface when you enable Bring Your Own License (BYOL).

    \n \n

    This operation can be run only by AWS accounts that are enabled for BYOL. If your account \n isn't enabled for BYOL, you'll receive an AccessDeniedException error.

    \n \n

    The management network interface is connected to a secure Amazon WorkSpaces management\n network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces\n clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " } }, "com.amazonaws.workspaces#ListAvailableManagementCidrRangesRequest": { @@ -1999,17 +2606,17 @@ "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.workspaces#PaginationToken", - "traits": { - "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " - } - }, "MaxResults": { "target": "com.amazonaws.workspaces#ManagementCidrRangeMaxResults", "traits": { "smithy.api#documentation": "

    The maximum number of items to return.

    " } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "

    If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

    " + } } } }, @@ -2100,16 +2707,16 @@ "com.amazonaws.workspaces#MigrateWorkspaceResult": { "type": "structure", "members": { - "TargetWorkspaceId": { + "SourceWorkspaceId": { "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "

    The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, \n the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.

    " + "smithy.api#documentation": "

    The original identifier of the WorkSpace that is being migrated.

    " } }, - "SourceWorkspaceId": { + "TargetWorkspaceId": { "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "

    The original identifier of the WorkSpace that is being migrated.

    " + "smithy.api#documentation": "

    The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, \n the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.

    " } } } @@ -2136,17 +2743,17 @@ "com.amazonaws.workspaces#ModificationState": { "type": "structure", "members": { - "Resource": { - "target": "com.amazonaws.workspaces#ModificationResourceEnum", - "traits": { - "smithy.api#documentation": "

    The resource.

    " - } - }, "State": { "target": "com.amazonaws.workspaces#ModificationStateEnum", "traits": { "smithy.api#documentation": "

    The modification state.

    " } + }, + "Resource": { + "target": "com.amazonaws.workspaces#ModificationResourceEnum", + "traits": { + "smithy.api#documentation": "

    The resource.

    " + } } }, "traits": { @@ -2206,17 +2813,17 @@ "com.amazonaws.workspaces#ModifyAccountRequest": { "type": "structure", "members": { - "DedicatedTenancySupport": { - "target": "com.amazonaws.workspaces#DedicatedTenancySupportEnum", - "traits": { - "smithy.api#documentation": "

    The status of BYOL.

    " - } - }, "DedicatedTenancyManagementCidrRange": { "target": "com.amazonaws.workspaces#DedicatedTenancyManagementCidrRange", "traits": { "smithy.api#documentation": "

    The IP address range, specified as an IPv4 CIDR block, for the management network\n interface. Specify an IP address range that is compatible with your network and in CIDR\n notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be\n /16 (for example, 203.0.113.25/16). It must also be specified as available by the\n ListAvailableManagementCidrRanges operation.

    " } + }, + "DedicatedTenancySupport": { + "target": "com.amazonaws.workspaces#DedicatedTenancySupportEnum", + "traits": { + "smithy.api#documentation": "

    The status of BYOL.

    " + } } } }, @@ -2339,17 +2946,17 @@ "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesRequest": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.workspaces#DirectoryId", + "WorkspaceAccessProperties": { + "target": "com.amazonaws.workspaces#WorkspaceAccessProperties", "traits": { - "smithy.api#documentation": "

    The identifier of the directory.

    ", + "smithy.api#documentation": "

    The device types and operating systems to enable or disable for access.

    ", "smithy.api#required": {} } }, - "WorkspaceAccessProperties": { - "target": "com.amazonaws.workspaces#WorkspaceAccessProperties", + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", "traits": { - "smithy.api#documentation": "

    The device types and operating systems to enable or disable for access.

    ", + "smithy.api#documentation": "

    The identifier of the directory.

    ", "smithy.api#required": {} } } @@ -2374,6 +2981,9 @@ { "target": "com.amazonaws.workspaces#InvalidParameterValuesException" }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, { "target": "com.amazonaws.workspaces#ResourceNotFoundException" } @@ -2489,17 +3099,17 @@ "com.amazonaws.workspaces#ModifyWorkspaceStateRequest": { "type": "structure", "members": { - "WorkspaceState": { - "target": "com.amazonaws.workspaces#TargetWorkspaceState", + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "

    The WorkSpace state.

    ", + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", "smithy.api#required": {} } }, - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", + "WorkspaceState": { + "target": "com.amazonaws.workspaces#TargetWorkspaceState", "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    ", + "smithy.api#documentation": "

    The WorkSpace state.

    ", "smithy.api#required": {} } } @@ -2575,7 +3185,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 63 + "max": 2048 } } }, @@ -2769,16 +3379,11 @@ "com.amazonaws.workspaces#RegisterWorkspaceDirectoryRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.workspaces#TagList", - "traits": { - "smithy.api#documentation": "

    The tags associated with the directory.

    " - } - }, - "Tenancy": { - "target": "com.amazonaws.workspaces#Tenancy", + "EnableWorkDocs": { + "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own\n License (BYOL) images, this value must be set to DEDICATED and your AWS account must be \n enabled for BYOL. If your account has not been enabled for BYOL, you will receive an \n InvalidParameterValuesException error. For more information about BYOL images, see\n Bring Your Own Windows Desktop Images.

    " + "smithy.api#documentation": "

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and \n WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set \n EnableWorkDocs to disabled, and try again.

    ", + "smithy.api#required": {} } }, "DirectoryId": { @@ -2788,11 +3393,16 @@ "smithy.api#required": {} } }, - "EnableWorkDocs": { + "EnableSelfService": { "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and \n WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set \n EnableWorkDocs to disabled, and try again.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates whether self-service capabilities are enabled or disabled.

    " + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

    The tags associated with the directory.

    " } }, "SubnetIds": { @@ -2801,10 +3411,10 @@ "smithy.api#documentation": "

    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets \n are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these \n conditions are not met, you will receive an OperationNotSupportedException error.

    " } }, - "EnableSelfService": { - "target": "com.amazonaws.workspaces#BooleanObject", + "Tenancy": { + "target": "com.amazonaws.workspaces#Tenancy", "traits": { - "smithy.api#documentation": "

    Indicates whether self-service capabilities are enabled or disabled.

    " + "smithy.api#documentation": "

    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own\n License (BYOL) images, this value must be set to DEDICATED and your AWS account must be \n enabled for BYOL. If your account has not been enabled for BYOL, you will receive an \n InvalidParameterValuesException error. For more information about BYOL images, see\n Bring Your Own Windows Desktop Images.

    " } } } @@ -3069,10 +3679,10 @@ "com.amazonaws.workspaces#SelfservicePermissions": { "type": "structure", "members": { - "SwitchRunningMode": { + "IncreaseVolumeSize": { "target": "com.amazonaws.workspaces#ReconnectEnum", "traits": { - "smithy.api#documentation": "

    Specifies whether users can switch the running mode of their WorkSpace.

    " + "smithy.api#documentation": "

    Specifies whether users can increase the volume size of the drives on their\n WorkSpace.

    " } }, "RebuildWorkspace": { @@ -3087,16 +3697,16 @@ "smithy.api#documentation": "

    Specifies whether users can change the compute type (bundle) for their WorkSpace.

    " } }, - "RestartWorkspace": { + "SwitchRunningMode": { "target": "com.amazonaws.workspaces#ReconnectEnum", "traits": { - "smithy.api#documentation": "

    Specifies whether users can restart their WorkSpace.

    " + "smithy.api#documentation": "

    Specifies whether users can switch the running mode of their WorkSpace.

    " } }, - "IncreaseVolumeSize": { + "RestartWorkspace": { "target": "com.amazonaws.workspaces#ReconnectEnum", "traits": { - "smithy.api#documentation": "

    Specifies whether users can increase the volume size of the drives on their\n WorkSpace.

    " + "smithy.api#documentation": "

    Specifies whether users can restart their WorkSpace.

    " } } }, @@ -3271,18 +3881,18 @@ "com.amazonaws.workspaces#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.workspaces#TagValue", - "traits": { - "smithy.api#documentation": "

    The value of the tag.

    " - } - }, "Key": { "target": "com.amazonaws.workspaces#TagKey", "traits": { "smithy.api#documentation": "

    The key of the tag.

    ", "smithy.api#required": {} } + }, + "Value": { + "target": "com.amazonaws.workspaces#TagValue", + "traits": { + "smithy.api#documentation": "

    The value of the tag.

    " + } } }, "traits": { @@ -3385,7 +3995,7 @@ "target": "com.amazonaws.workspaces#TerminateWorkspacesResult" }, "traits": { - "smithy.api#documentation": "

    Terminates the specified WorkSpaces.

    \n

    Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is\n destroyed. If you need to archive any user data, contact Amazon Web Services before\n terminating the WorkSpace.

    \n

    You can terminate a WorkSpace that is in any state except SUSPENDED.

    \n

    This operation is asynchronous and returns before the WorkSpaces have been completely\n terminated.

    " + "smithy.api#documentation": "

    Terminates the specified WorkSpaces.

    \n \n \n

    Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is\n destroyed. If you need to archive any user data, contact AWS Support before\n terminating the WorkSpace.

    \n     \n\n

    You can terminate a WorkSpace that is in any state except SUSPENDED.

    \n

    This operation is asynchronous and returns before the WorkSpaces have been completely\n terminated. After a WorkSpace is terminated, the TERMINATED state is returned \n only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely \n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using \n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has \n been successfully terminated.

    " } }, "com.amazonaws.workspaces#TerminateWorkspacesRequest": { @@ -3438,6 +4048,64 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workspaces#UpdateConnectionAliasPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermissionRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermissionResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAssociatedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Shares or unshares a connection alias with one account by specifying whether that account has permission to \n associate the connection alias with a directory. If the association permission is granted, the connection alias \n is shared with that account. If the association permission is revoked, the connection alias is unshared with the \n account. For more information, see \n Cross-Region Redirection for Amazon WorkSpaces.

    \n \n \n
      \n
    • \n

      Before performing this operation, call \n DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

      \n
      • \n
    • \n

      To delete a connection alias that has been shared, the shared account must first disassociate the \n connection alias from any directories it has been associated with. Then you must unshare the connection \n alias from the account it has been shared with. You can delete a connection alias only after it is no \n longer shared with any accounts or associated with any directories.

      \n
      • \n
    \n     " + } + }, + "com.amazonaws.workspaces#UpdateConnectionAliasPermissionRequest": { + "type": "structure", + "members": { + "AliasId": { + "target": "com.amazonaws.workspaces#ConnectionAliasId", + "traits": { + "smithy.api#documentation": "

    The identifier of the connection alias that you want to update permissions for.

    ", + "smithy.api#required": {} + } + }, + "ConnectionAliasPermission": { + "target": "com.amazonaws.workspaces#ConnectionAliasPermission", + "traits": { + "smithy.api#documentation": "

    Indicates whether to share or unshare the connection alias with the specified AWS account.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workspaces#UpdateConnectionAliasPermissionResult": { + "type": "structure", + "members": {} + }, "com.amazonaws.workspaces#UpdateRulesOfIpGroup": { "type": "operation", "input": { @@ -3516,7 +4184,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Shares or unshares an image with one account by specifying whether that account has permission to copy \n the image. If the copy image permission is granted, the image is shared with that account. If the copy image \n permission is revoked, the image is unshared with the account.

    \n \n \n
      \n
    • \n

      To delete an image that has been shared, you must unshare the image before you delete it.

      \n
      • \n
    • \n

      Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at \n this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in \n the AWS GovCloud (US-West) Region, contact AWS Support.

      \n
      • \n
    \n     " + "smithy.api#documentation": "

    Shares or unshares an image with one account by specifying whether that account has permission to copy \n the image. If the copy image permission is granted, the image is shared with that account. If the copy image \n permission is revoked, the image is unshared with the account. For more information about sharing images, see \n \n Share or Unshare a Custom WorkSpaces Image.

    \n \n \n
      \n
    • \n

      To delete an image that has been shared, you must unshare the image before you delete it.

      \n
      • \n
    • \n

      Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at \n this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in \n the AWS GovCloud (US-West) Region, contact AWS Support.

      \n
      • \n
    \n     " } }, "com.amazonaws.workspaces#UpdateWorkspaceImagePermissionRequest": { @@ -3532,7 +4200,7 @@ "SharedAccountId": { "target": "com.amazonaws.workspaces#AwsAccount", "traits": { - "smithy.api#documentation": "

    The identifier of the AWS account to share or unshare the image with.

    ", + "smithy.api#documentation": "

    The identifier of the AWS account to share or unshare the image with.

    \n \n \n

    Before sharing the image, confirm that you are sharing to the correct AWS account ID.

    \n     ", "smithy.api#required": {} } }, @@ -3584,34 +4252,34 @@ "com.amazonaws.workspaces#Workspace": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.workspaces#UserName", + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", "traits": { - "smithy.api#documentation": "

    The user for the WorkSpace.

    " + "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n created.

    " } }, - "SubnetId": { - "target": "com.amazonaws.workspaces#SubnetId", + "UserVolumeEncryptionEnabled": { + "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    The identifier of the subnet for the WorkSpace.

    " + "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " } }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#WorkspaceErrorCode", + "State": { + "target": "com.amazonaws.workspaces#WorkspaceState", "traits": { - "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " + "smithy.api#documentation": "

    The operational state of the WorkSpace.

    \n \n \n

    After a WorkSpace is terminated, the TERMINATED state is returned \n only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely \n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using \n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has \n been successfully terminated.

    \n     " } }, - "UserVolumeEncryptionEnabled": { - "target": "com.amazonaws.workspaces#BooleanObject", + "WorkspaceProperties": { + "target": "com.amazonaws.workspaces#WorkspaceProperties", "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " + "smithy.api#documentation": "

    The properties of the WorkSpace.

    " } }, - "ModificationStates": { - "target": "com.amazonaws.workspaces#ModificationStateList", + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", "traits": { - "smithy.api#documentation": "

    The modification states of the WorkSpace.

    " + "smithy.api#documentation": "

    The identifier of the bundle used to create the WorkSpace.

    " } }, "VolumeEncryptionKey": { @@ -3620,58 +4288,58 @@ "smithy.api#documentation": "

    The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. \n Amazon WorkSpaces does not support asymmetric CMKs.

    " } }, - "State": { - "target": "com.amazonaws.workspaces#WorkspaceState", + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", "traits": { - "smithy.api#documentation": "

    The operational state of the WorkSpace.

    " + "smithy.api#documentation": "

    The identifier of the AWS Directory Service directory for the WorkSpace.

    " } }, - "WorkspaceProperties": { - "target": "com.amazonaws.workspaces#WorkspaceProperties", + "ModificationStates": { + "target": "com.amazonaws.workspaces#ModificationStateList", "traits": { - "smithy.api#documentation": "

    The properties of the WorkSpace.

    " + "smithy.api#documentation": "

    The modification states of the WorkSpace.

    " } }, - "IpAddress": { - "target": "com.amazonaws.workspaces#IpAddress", + "SubnetId": { + "target": "com.amazonaws.workspaces#SubnetId", "traits": { - "smithy.api#documentation": "

    The IP address of the WorkSpace.

    " + "smithy.api#documentation": "

    The identifier of the subnet for the WorkSpace.

    " } }, - "RootVolumeEncryptionEnabled": { - "target": "com.amazonaws.workspaces#BooleanObject", + "ErrorCode": { + "target": "com.amazonaws.workspaces#WorkspaceErrorCode", "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " + "smithy.api#documentation": "

    The error code that is returned if the WorkSpace cannot be created.

    " } }, - "ErrorMessage": { - "target": "com.amazonaws.workspaces#Description", + "IpAddress": { + "target": "com.amazonaws.workspaces#IpAddress", "traits": { - "smithy.api#documentation": "

    The text of the error message that is returned if the WorkSpace cannot be\n created.

    " + "smithy.api#documentation": "

    The IP address of the WorkSpace.

    " } }, - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", + "ComputerName": { + "target": "com.amazonaws.workspaces#ComputerName", "traits": { - "smithy.api#documentation": "

    The identifier of the bundle used to create the WorkSpace.

    " + "smithy.api#documentation": "

    The name of the WorkSpace, as seen by the operating system. The format of this name varies. \n For more information, see \n Launch a WorkSpace.

    " } }, - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", + "UserName": { + "target": "com.amazonaws.workspaces#UserName", "traits": { - "smithy.api#documentation": "

    The identifier of the AWS Directory Service directory for the WorkSpace.

    " + "smithy.api#documentation": "

    The user for the WorkSpace.

    " } }, - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", + "RootVolumeEncryptionEnabled": { + "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " + "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " } }, - "ComputerName": { - "target": "com.amazonaws.workspaces#ComputerName", + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "

    The name of the WorkSpace, as seen by the operating system.

    " + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " } } }, @@ -3682,28 +4350,34 @@ "com.amazonaws.workspaces#WorkspaceAccessProperties": { "type": "structure", "members": { + "DeviceTypeWindows": { + "target": "com.amazonaws.workspaces#AccessPropertyValue", + "traits": { + "smithy.api#documentation": "

    Indicates whether users can use Windows clients to access their WorkSpaces. To restrict\n WorkSpaces access to trusted devices (also known as managed devices) with valid\n certificates, specify a value of TRUST. For more information, see Restrict\n WorkSpaces Access to Trusted Devices.

    " + } + }, "DeviceTypeZeroClient": { "target": "com.amazonaws.workspaces#AccessPropertyValue", "traits": { "smithy.api#documentation": "

    Indicates whether users can use zero client devices to access their WorkSpaces.

    " } }, - "DeviceTypeIos": { + "DeviceTypeChromeOs": { "target": "com.amazonaws.workspaces#AccessPropertyValue", "traits": { - "smithy.api#documentation": "

    Indicates whether users can use iOS devices to access their WorkSpaces.

    " + "smithy.api#documentation": "

    Indicates whether users can use Chromebooks to access their WorkSpaces.

    " } }, - "DeviceTypeAndroid": { + "DeviceTypeIos": { "target": "com.amazonaws.workspaces#AccessPropertyValue", "traits": { - "smithy.api#documentation": "

    Indicates whether users can use Android devices to access their WorkSpaces.

    " + "smithy.api#documentation": "

    Indicates whether users can use iOS devices to access their WorkSpaces.

    " } }, - "DeviceTypeChromeOs": { + "DeviceTypeAndroid": { "target": "com.amazonaws.workspaces#AccessPropertyValue", "traits": { - "smithy.api#documentation": "

    Indicates whether users can use Chromebooks to access their WorkSpaces.

    " + "smithy.api#documentation": "

    Indicates whether users can use Android devices to access their WorkSpaces.

    " } }, "DeviceTypeWeb": { @@ -3717,12 +4391,6 @@ "traits": { "smithy.api#documentation": "

    Indicates whether users can use macOS clients to access their WorkSpaces. To restrict\n WorkSpaces access to trusted devices (also known as managed devices) with valid\n certificates, specify a value of TRUST. For more information, see Restrict\n WorkSpaces Access to Trusted Devices.

    " } - }, - "DeviceTypeWindows": { - "target": "com.amazonaws.workspaces#AccessPropertyValue", - "traits": { - "smithy.api#documentation": "

    Indicates whether users can use Windows clients to access their WorkSpaces. To restrict\n WorkSpaces access to trusted devices (also known as managed devices) with valid\n certificates, specify a value of TRUST. For more information, see Restrict\n WorkSpaces Access to Trusted Devices.

    " - } } }, "traits": { @@ -3732,10 +4400,10 @@ "com.amazonaws.workspaces#WorkspaceBundle": { "type": "structure", "members": { - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", + "RootStorage": { + "target": "com.amazonaws.workspaces#RootStorage", "traits": { - "smithy.api#documentation": "

    The image identifier of the bundle.

    " + "smithy.api#documentation": "

    The size of the root volume.

    " } }, "Owner": { @@ -3744,10 +4412,10 @@ "smithy.api#documentation": "

    The owner of the bundle. This is the account identifier of the owner, or\n AMAZON if the bundle is provided by AWS.

    " } }, - "Description": { - "target": "com.amazonaws.workspaces#Description", + "UserStorage": { + "target": "com.amazonaws.workspaces#UserStorage", "traits": { - "smithy.api#documentation": "

    A description.

    " + "smithy.api#documentation": "

    The size of the user storage.

    " } }, "ComputeType": { @@ -3756,10 +4424,16 @@ "smithy.api#documentation": "

    The compute type. For more information, see Amazon WorkSpaces Bundles.

    " } }, - "UserStorage": { - "target": "com.amazonaws.workspaces#UserStorage", + "Description": { + "target": "com.amazonaws.workspaces#Description", "traits": { - "smithy.api#documentation": "

    The size of the user storage.

    " + "smithy.api#documentation": "

    A description.

    " + } + }, + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The image identifier of the bundle.

    " } }, "BundleId": { @@ -3768,22 +4442,16 @@ "smithy.api#documentation": "

    The bundle identifier.

    " } }, - "LastUpdatedTime": { - "target": "com.amazonaws.workspaces#Timestamp", - "traits": { - "smithy.api#documentation": "

    The last time that the bundle was updated.

    " - } - }, "Name": { "target": "com.amazonaws.workspaces#NonEmptyString", "traits": { "smithy.api#documentation": "

    The name of the bundle.

    " } }, - "RootStorage": { - "target": "com.amazonaws.workspaces#RootStorage", + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", "traits": { - "smithy.api#documentation": "

    The size of the root volume.

    " + "smithy.api#documentation": "

    The last time that the bundle was updated.

    " } } }, @@ -3794,22 +4462,16 @@ "com.amazonaws.workspaces#WorkspaceConnectionStatus": { "type": "structure", "members": { - "WorkspaceId": { - "target": "com.amazonaws.workspaces#WorkspaceId", - "traits": { - "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " - } - }, "ConnectionState": { "target": "com.amazonaws.workspaces#ConnectionState", "traits": { "smithy.api#documentation": "

    The connection state of the WorkSpace. The connection state is unknown if the WorkSpace\n is stopped.

    " } }, - "LastKnownUserConnectionTimestamp": { - "target": "com.amazonaws.workspaces#Timestamp", + "WorkspaceId": { + "target": "com.amazonaws.workspaces#WorkspaceId", "traits": { - "smithy.api#documentation": "

    The timestamp of the last known user connection.

    " + "smithy.api#documentation": "

    The identifier of the WorkSpace.

    " } }, "ConnectionStateCheckTimestamp": { @@ -3817,6 +4479,12 @@ "traits": { "smithy.api#documentation": "

    The timestamp of the connection status check.

    " } + }, + "LastKnownUserConnectionTimestamp": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

    The timestamp of the last known user connection.

    " + } } }, "traits": { @@ -3832,6 +4500,18 @@ "com.amazonaws.workspaces#WorkspaceCreationProperties": { "type": "structure", "members": { + "UserEnabledAsLocalAdministrator": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether users are local administrators of their WorkSpaces.

    " + } + }, + "EnableMaintenanceMode": { + "target": "com.amazonaws.workspaces#BooleanObject", + "traits": { + "smithy.api#documentation": "

    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information,\n see WorkSpace\n Maintenance.

    " + } + }, "CustomSecurityGroupId": { "target": "com.amazonaws.workspaces#SecurityGroupId", "traits": { @@ -3844,22 +4524,16 @@ "smithy.api#documentation": "

    Indicates whether internet access is enabled for your WorkSpaces.

    " } }, - "EnableMaintenanceMode": { - "target": "com.amazonaws.workspaces#BooleanObject", - "traits": { - "smithy.api#documentation": "

    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information,\n see WorkSpace\n Maintenance.

    " - } - }, - "UserEnabledAsLocalAdministrator": { + "EnableWorkDocs": { "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    Indicates whether users are local administrators of their WorkSpaces.

    " + "smithy.api#documentation": "

    Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

    \n \n \n

    If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the \n directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless \n you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, \n see Disabling Users in the \n Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see \n Deleting a Site in the \n Amazon WorkDocs Administration Guide.

    \n \n

    If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any \n new WorkSpaces that are launched in the directory will have WorkDocs enabled.

    \n     " } }, "DefaultOu": { "target": "com.amazonaws.workspaces#DefaultOu", "traits": { - "smithy.api#documentation": "

    The default organizational unit (OU) for your WorkSpace directories.

    " + "smithy.api#documentation": "

    The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight \n Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form \n \"OU=value,DC=value,DC=value\", \n where value is any string of characters, and the number of domain components (DCs) is \n two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

    \n \n \n
      \n
    • \n

      To avoid errors, certain characters in the distinguished name must be escaped. For more information, \n see \n Distinguished Names in the Microsoft documentation.

      \n
      • \n
    • \n

      The API doesn't validate whether the OU exists.

      \n
      • \n
    \n     " } } }, @@ -3870,16 +4544,10 @@ "com.amazonaws.workspaces#WorkspaceDirectory": { "type": "structure", "members": { - "DirectoryName": { - "target": "com.amazonaws.workspaces#DirectoryName", - "traits": { - "smithy.api#documentation": "

    The name of the directory.

    " - } - }, - "CustomerUserName": { - "target": "com.amazonaws.workspaces#UserName", + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", "traits": { - "smithy.api#documentation": "

    The user name for the service account.

    " + "smithy.api#documentation": "

    The directory identifier.

    " } }, "IamRoleId": { @@ -3888,16 +4556,16 @@ "smithy.api#documentation": "

    The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make\n calls to other services, such as Amazon EC2, on your behalf.

    " } }, - "Tenancy": { - "target": "com.amazonaws.workspaces#Tenancy", + "State": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryState", "traits": { - "smithy.api#documentation": "

    Specifies whether the directory is dedicated or shared. To use Bring Your Own License\n (BYOL), this value must be set to DEDICATED. For more information, see Bring\n Your Own Windows Desktop Images.

    " + "smithy.api#documentation": "

    The state of the directory's registration with Amazon WorkSpaces. After a directory is \n deregistered, the DEREGISTERED state is returned very briefly before the directory \n metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, \n check for the directory ID by using \n \n DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been \n successfully deregistered.

    " } }, - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", + "DirectoryName": { + "target": "com.amazonaws.workspaces#DirectoryName", "traits": { - "smithy.api#documentation": "

    The directory identifier.

    " + "smithy.api#documentation": "

    The name of the directory.

    " } }, "WorkspaceAccessProperties": { @@ -3906,10 +4574,10 @@ "smithy.api#documentation": "

    The devices and operating systems that users can use to access WorkSpaces.

    " } }, - "SelfservicePermissions": { - "target": "com.amazonaws.workspaces#SelfservicePermissions", + "DnsIpAddresses": { + "target": "com.amazonaws.workspaces#DnsIpAddresses", "traits": { - "smithy.api#documentation": "

    The default self-service permissions for WorkSpaces in the directory.

    " + "smithy.api#documentation": "

    The IP addresses of the DNS servers for the directory.

    " } }, "RegistrationCode": { @@ -3918,22 +4586,16 @@ "smithy.api#documentation": "

    The registration code for the directory. This is the code that users enter in their\n Amazon WorkSpaces client application to connect to the directory.

    " } }, - "DnsIpAddresses": { - "target": "com.amazonaws.workspaces#DnsIpAddresses", - "traits": { - "smithy.api#documentation": "

    The IP addresses of the DNS servers for the directory.

    " - } - }, "WorkspaceSecurityGroupId": { "target": "com.amazonaws.workspaces#SecurityGroupId", "traits": { "smithy.api#documentation": "

    The identifier of the security group that is assigned to new WorkSpaces.

    " } }, - "DirectoryType": { - "target": "com.amazonaws.workspaces#WorkspaceDirectoryType", + "Tenancy": { + "target": "com.amazonaws.workspaces#Tenancy", "traits": { - "smithy.api#documentation": "

    The directory type.

    " + "smithy.api#documentation": "

    Specifies whether the directory is dedicated or shared. To use Bring Your Own License\n (BYOL), this value must be set to DEDICATED. For more information, see Bring\n Your Own Windows Desktop Images.

    " } }, "WorkspaceCreationProperties": { @@ -3942,10 +4604,22 @@ "smithy.api#documentation": "

    The default creation properties for all WorkSpaces in the directory.

    " } }, - "State": { - "target": "com.amazonaws.workspaces#WorkspaceDirectoryState", + "DirectoryType": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryType", + "traits": { + "smithy.api#documentation": "

    The directory type.

    " + } + }, + "SubnetIds": { + "target": "com.amazonaws.workspaces#SubnetIds", + "traits": { + "smithy.api#documentation": "

    The identifiers of the subnets used with the directory.

    " + } + }, + "CustomerUserName": { + "target": "com.amazonaws.workspaces#UserName", "traits": { - "smithy.api#documentation": "

    The state of the directory's registration with Amazon WorkSpaces.

    " + "smithy.api#documentation": "

    The user name for the service account.

    " } }, "ipGroupIds": { @@ -3960,10 +4634,10 @@ "smithy.api#documentation": "

    The directory alias.

    " } }, - "SubnetIds": { - "target": "com.amazonaws.workspaces#SubnetIds", + "SelfservicePermissions": { + "target": "com.amazonaws.workspaces#SelfservicePermissions", "traits": { - "smithy.api#documentation": "

    The identifiers of the subnets used with the directory.

    " + "smithy.api#documentation": "

    The default self-service permissions for WorkSpaces in the directory.

    " } } }, @@ -4037,34 +4711,22 @@ "com.amazonaws.workspaces#WorkspaceImage": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.workspaces#WorkspaceImageName", - "traits": { - "smithy.api#documentation": "

    The name of the image.

    " - } - }, - "ErrorCode": { - "target": "com.amazonaws.workspaces#WorkspaceImageErrorCode", - "traits": { - "smithy.api#documentation": "

    The error code that is returned for the image.

    " - } - }, - "ImageId": { - "target": "com.amazonaws.workspaces#WorkspaceImageId", + "OperatingSystem": { + "target": "com.amazonaws.workspaces#OperatingSystem", "traits": { - "smithy.api#documentation": "

    The identifier of the image.

    " + "smithy.api#documentation": "

    The operating system that the image is running.

    " } }, - "RequiredTenancy": { - "target": "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy", + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", "traits": { - "smithy.api#documentation": "

    Specifies whether the image is running on dedicated hardware. When Bring Your Own\n License (BYOL) is enabled, this value is set to DEDICATED. For more\n information, see Bring Your Own Windows\n Desktop Images.

    " + "smithy.api#documentation": "

    The date when the image was created. If the image has been shared, the AWS account \n that the image has been shared with sees the original creation date of the image.

    " } }, - "State": { - "target": "com.amazonaws.workspaces#WorkspaceImageState", + "OwnerAccountId": { + "target": "com.amazonaws.workspaces#AwsAccount", "traits": { - "smithy.api#documentation": "

    The status of the image.

    " + "smithy.api#documentation": "

    The identifier of the AWS account that owns the image.

    " } }, "Description": { @@ -4073,22 +4735,22 @@ "smithy.api#documentation": "

    The description of the image.

    " } }, - "OwnerAccountId": { - "target": "com.amazonaws.workspaces#AwsAccount", + "RequiredTenancy": { + "target": "com.amazonaws.workspaces#WorkspaceImageRequiredTenancy", "traits": { - "smithy.api#documentation": "

    The identifier of the AWS account that owns the image.

    " + "smithy.api#documentation": "

    Specifies whether the image is running on dedicated hardware. When Bring Your Own\n License (BYOL) is enabled, this value is set to DEDICATED. For more\n information, see Bring Your Own Windows\n Desktop Images.

    " } }, - "OperatingSystem": { - "target": "com.amazonaws.workspaces#OperatingSystem", + "Name": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", "traits": { - "smithy.api#documentation": "

    The operating system that the image is running.

    " + "smithy.api#documentation": "

    The name of the image.

    " } }, - "Created": { - "target": "com.amazonaws.workspaces#Timestamp", + "State": { + "target": "com.amazonaws.workspaces#WorkspaceImageState", "traits": { - "smithy.api#documentation": "

    The date when the image was created. If the image has been shared, the AWS account \n that the image has been shared with sees the original creation date of the image.

    " + "smithy.api#documentation": "

    The status of the image.

    " } }, "ErrorMessage": { @@ -4096,6 +4758,18 @@ "traits": { "smithy.api#documentation": "

    The text of the error message that is returned for the image.

    " } + }, + "ErrorCode": { + "target": "com.amazonaws.workspaces#WorkspaceImageErrorCode", + "traits": { + "smithy.api#documentation": "

    The error code that is returned for the image.

    " + } + }, + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

    The identifier of the image.

    " + } } }, "traits": { @@ -4217,6 +4891,12 @@ "smithy.api#documentation": "

    The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

    " } }, + "ComputeTypeName": { + "target": "com.amazonaws.workspaces#Compute", + "traits": { + "smithy.api#documentation": "

    The compute type. For more information, see Amazon WorkSpaces\n Bundles.

    " + } + }, "UserVolumeSizeGib": { "target": "com.amazonaws.workspaces#UserVolumeSizeGib", "traits": { @@ -4229,12 +4909,6 @@ "smithy.api#documentation": "

    The size of the root volume. For important information about how to modify the size of the root and user volumes, see \n Modify a WorkSpace.

    " } }, - "ComputeTypeName": { - "target": "com.amazonaws.workspaces#Compute", - "traits": { - "smithy.api#documentation": "

    The compute type. For more information, see Amazon WorkSpaces\n Bundles.

    " - } - }, "RunningMode": { "target": "com.amazonaws.workspaces#RunningMode", "traits": { @@ -4249,23 +4923,16 @@ "com.amazonaws.workspaces#WorkspaceRequest": { "type": "structure", "members": { - "VolumeEncryptionKey": { - "target": "com.amazonaws.workspaces#VolumeEncryptionKey", - "traits": { - "smithy.api#documentation": "

    The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. \n Amazon WorkSpaces does not support asymmetric CMKs.

    " - } - }, - "RootVolumeEncryptionEnabled": { - "target": "com.amazonaws.workspaces#BooleanObject", + "WorkspaceProperties": { + "target": "com.amazonaws.workspaces#WorkspaceProperties", "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " + "smithy.api#documentation": "

    The WorkSpace properties.

    " } }, - "UserName": { - "target": "com.amazonaws.workspaces#UserName", + "Tags": { + "target": "com.amazonaws.workspaces#TagList", "traits": { - "smithy.api#documentation": "

    The user name of the user for the WorkSpace. This user name must exist in the AWS\n Directory Service directory for the WorkSpace.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The tags for the WorkSpace.

    " } }, "BundleId": { @@ -4275,22 +4942,23 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.workspaces#TagList", + "UserName": { + "target": "com.amazonaws.workspaces#UserName", "traits": { - "smithy.api#documentation": "

    The tags for the WorkSpace.

    " + "smithy.api#documentation": "

    The user name of the user for the WorkSpace. This user name must exist in the AWS\n Directory Service directory for the WorkSpace.

    ", + "smithy.api#required": {} } }, - "WorkspaceProperties": { - "target": "com.amazonaws.workspaces#WorkspaceProperties", + "UserVolumeEncryptionEnabled": { + "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    The WorkSpace properties.

    " + "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " } }, - "UserVolumeEncryptionEnabled": { + "RootVolumeEncryptionEnabled": { "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "

    Indicates whether the data stored on the user volume is encrypted.

    " + "smithy.api#documentation": "

    Indicates whether the data stored on the root volume is encrypted.

    " } }, "DirectoryId": { @@ -4299,6 +4967,12 @@ "smithy.api#documentation": "

    The identifier of the AWS Directory Service directory for the WorkSpace. You can use\n DescribeWorkspaceDirectories to list the available directories.

    ", "smithy.api#required": {} } + }, + "VolumeEncryptionKey": { + "target": "com.amazonaws.workspaces#VolumeEncryptionKey", + "traits": { + "smithy.api#documentation": "

    The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. \n Amazon WorkSpaces does not support asymmetric CMKs.

    " + } } }, "traits": { @@ -4407,12 +5081,6 @@ "com.amazonaws.workspaces#WorkspacesIpGroup": { "type": "structure", "members": { - "groupId": { - "target": "com.amazonaws.workspaces#IpGroupId", - "traits": { - "smithy.api#documentation": "

    The identifier of the group.

    " - } - }, "userRules": { "target": "com.amazonaws.workspaces#IpRuleList", "traits": { @@ -4430,6 +5098,12 @@ "traits": { "smithy.api#documentation": "

    The description of the group.

    " } + }, + "groupId": { + "target": "com.amazonaws.workspaces#IpGroupId", + "traits": { + "smithy.api#documentation": "

    The identifier of the group.

    " + } } }, "traits": { @@ -4446,6 +5120,9 @@ "type": "service", "version": "2015-04-08", "operations": [ + { + "target": "com.amazonaws.workspaces#AssociateConnectionAlias" + }, { "target": "com.amazonaws.workspaces#AssociateIpGroups" }, @@ -4455,6 +5132,9 @@ { "target": "com.amazonaws.workspaces#CopyWorkspaceImage" }, + { + "target": "com.amazonaws.workspaces#CreateConnectionAlias" + }, { "target": "com.amazonaws.workspaces#CreateIpGroup" }, @@ -4464,6 +5144,9 @@ { "target": "com.amazonaws.workspaces#CreateWorkspaces" }, + { + "target": "com.amazonaws.workspaces#DeleteConnectionAlias" + }, { "target": "com.amazonaws.workspaces#DeleteIpGroup" }, @@ -4485,6 +5168,12 @@ { "target": "com.amazonaws.workspaces#DescribeClientProperties" }, + { + "target": "com.amazonaws.workspaces#DescribeConnectionAliases" + }, + { + "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissions" + }, { "target": "com.amazonaws.workspaces#DescribeIpGroups" }, @@ -4512,6 +5201,9 @@ { "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshots" }, + { + "target": "com.amazonaws.workspaces#DisassociateConnectionAlias" + }, { "target": "com.amazonaws.workspaces#DisassociateIpGroups" }, @@ -4569,6 +5261,9 @@ { "target": "com.amazonaws.workspaces#TerminateWorkspaces" }, + { + "target": "com.amazonaws.workspaces#UpdateConnectionAliasPermission" + }, { "target": "com.amazonaws.workspaces#UpdateRulesOfIpGroup" }, diff --git a/codegen/sdk-codegen/aws-models/xray.2016-04-12.json b/codegen/sdk-codegen/aws-models/xray.2016-04-12.json index 0af3a0a4e4d4..42dd2e7402c6 100644 --- a/codegen/sdk-codegen/aws-models/xray.2016-04-12.json +++ b/codegen/sdk-codegen/aws-models/xray.2016-04-12.json @@ -78,6 +78,9 @@ { "target": "com.amazonaws.xray#GetTraceSummaries" }, + { + "target": "com.amazonaws.xray#ListTagsForResource" + }, { "target": "com.amazonaws.xray#PutEncryptionConfig" }, @@ -87,6 +90,12 @@ { "target": "com.amazonaws.xray#PutTraceSegments" }, + { + "target": "com.amazonaws.xray#TagResource" + }, + { + "target": "com.amazonaws.xray#UntagResource" + }, { "target": "com.amazonaws.xray#UpdateGroup" }, @@ -99,7 +108,7 @@ "sdkId": "XRay", "arnNamespace": "xray", "cloudFormationName": "XRay", - "cloudTrailEventSource": "tracing.amazonaws.com" + "cloudTrailEventSource": "xray.amazonaws.com" }, "aws.auth#sigv4": { "name": "xray" @@ -112,12 +121,6 @@ "com.amazonaws.xray#Alias": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.xray#String", - "traits": { - "smithy.api#documentation": "

    The canonical name of the alias.

    " - } - }, "Type": { "target": "com.amazonaws.xray#String", "traits": { @@ -129,6 +132,12 @@ "traits": { "smithy.api#documentation": "

    A list of names for the alias, including the canonical name.

    " } + }, + "Name": { + "target": "com.amazonaws.xray#String", + "traits": { + "smithy.api#documentation": "

    The canonical name of the alias.

    " + } } }, "traits": { @@ -147,18 +156,21 @@ "target": "com.amazonaws.xray#String" } }, + "com.amazonaws.xray#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, "com.amazonaws.xray#AnnotationKey": { "type": "string" }, "com.amazonaws.xray#AnnotationValue": { "type": "structure", "members": { - "NumberValue": { - "target": "com.amazonaws.xray#NullableDouble", - "traits": { - "smithy.api#documentation": "

    Value for a Number annotation.

    " - } - }, "BooleanValue": { "target": "com.amazonaws.xray#NullableBoolean", "traits": { @@ -170,10 +182,16 @@ "traits": { "smithy.api#documentation": "

    Value for a String annotation.

    " } + }, + "NumberValue": { + "target": "com.amazonaws.xray#NullableDouble", + "traits": { + "smithy.api#documentation": "

    Value for a Number annotation.

    " + } } }, "traits": { - "smithy.api#documentation": "

    Value of a segment annotation. Has one of three value types: Number, Boolean or\n String.

    " + "smithy.api#documentation": "

    Value of a segment annotation. Has one of three value types: Number, Boolean, or String.

    " } }, "com.amazonaws.xray#Annotations": { @@ -224,12 +242,12 @@ "Name": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The name of a corresponding availability zone.

    " + "smithy.api#documentation": "

    The name of a corresponding Availability Zone.

    " } } }, "traits": { - "smithy.api#documentation": "

    A list of availability zones corresponding to the segments in a trace.

    " + "smithy.api#documentation": "

    A list of Availability Zones corresponding to the segments in a trace.

    " } }, "com.amazonaws.xray#BackendConnectionErrors": { @@ -241,31 +259,31 @@ "smithy.api#documentation": "

    " } }, - "ConnectionRefusedCount": { + "HTTPCode4XXCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " } }, - "HTTPCode4XXCount": { + "ConnectionRefusedCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " } }, - "UnknownHostCount": { + "TimeoutCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " } }, - "OtherCount": { + "UnknownHostCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " } }, - "TimeoutCount": { + "OtherCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " @@ -402,6 +420,18 @@ "smithy.api#required": {} } }, + "Tags": { + "target": "com.amazonaws.xray#TagList", + "traits": { + "smithy.api#documentation": "

    A map that contains one or more tag keys and tag values to attach to an X-Ray group.\n For more information about ways to use tags, see Tagging AWS\n resources in the AWS General Reference.

    \n

    The following restrictions apply to tags:

    \n
      \n
    • \n

      Maximum number of user-applied tags per resource: 50

      \n
      • \n
    • \n

      Maximum tag key length: 128 Unicode characters

      \n
      • \n
    • \n

      Maximum tag value length: 256 Unicode characters

      \n
      • \n
    • \n

      Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :\n / = + - and @

      \n
      • \n
    • \n

      Tag keys and values are case sensitive.

      \n
      • \n
    • \n

      Don't use aws: as a prefix for keys; it's reserved for AWS\n use.

      \n
      • \n
    " + } + }, + "InsightsConfiguration": { + "target": "com.amazonaws.xray#InsightsConfiguration", + "traits": { + "smithy.api#documentation": "

    The structure containing configurations related to insights.

    \n
      \n
    • \n

      The InsightsEnabled boolean can be set to true to enable insights for the\n new group or false to disable insights for the new group.

      \n
      • \n
    • \n

      The NotifcationsEnabled boolean can be set to true to enable insights\n notifications for the new group. Notifications may only be enabled on a group\n with InsightsEnabled set to true.

      \n
      • \n
    " + } + }, "FilterExpression": { "target": "com.amazonaws.xray#FilterExpression", "traits": { @@ -416,7 +446,7 @@ "Group": { "target": "com.amazonaws.xray#Group", "traits": { - "smithy.api#documentation": "

    The group that was created. Contains the name of the group that was created, the\n ARN of the group that was generated based on the group name, and the filter expression\n that was assigned to the group.

    " + "smithy.api#documentation": "

    The group that was created. Contains the name of the group that was created, the Amazon Resource Name\n (ARN) of the group that was generated based on the group name, the filter expression, and the insight\n configuration that was assigned to the group.

    " } } } @@ -458,6 +488,12 @@ "smithy.api#documentation": "

    The rule definition.

    ", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.xray#TagList", + "traits": { + "smithy.api#documentation": "

    A map that contains one or more tag keys and tag values to attach to an X-Ray sampling\n rule. For more information about ways to use tags, see Tagging AWS\n resources in the AWS General Reference.

    \n

    The following restrictions apply to tags:

    \n
      \n
    • \n

      Maximum number of user-applied tags per resource: 50

      \n
      • \n
    • \n

      Maximum tag key length: 128 Unicode characters

      \n
      • \n
    • \n

      Maximum tag value length: 256 Unicode characters

      \n
      • \n
    • \n

      Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :\n / = + - and @

      \n
      • \n
    • \n

      Tag keys and values are case sensitive.

      \n
      • \n
    • \n

      Don't use aws: as a prefix for keys; it's reserved for AWS\n use.

      \n
      • \n
    " + } } } }, @@ -586,16 +622,10 @@ "com.amazonaws.xray#Edge": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.xray#Timestamp", - "traits": { - "smithy.api#documentation": "

    The end time of the last segment on the edge.

    " - } - }, - "Aliases": { - "target": "com.amazonaws.xray#AliasList", + "ResponseTimeHistogram": { + "target": "com.amazonaws.xray#Histogram", "traits": { - "smithy.api#documentation": "

    Aliases for the edge.

    " + "smithy.api#documentation": "

    A histogram that maps the spread of client response times on an edge.

    " } }, "StartTime": { @@ -616,10 +646,16 @@ "smithy.api#documentation": "

    Response statistics for segments on the edge.

    " } }, - "ResponseTimeHistogram": { - "target": "com.amazonaws.xray#Histogram", + "EndTime": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    A histogram that maps the spread of client response times on an edge.

    " + "smithy.api#documentation": "

    The end time of the last segment on the edge.

    " + } + }, + "Aliases": { + "target": "com.amazonaws.xray#AliasList", + "traits": { + "smithy.api#documentation": "

    Aliases for the edge.

    " } } }, @@ -642,10 +678,10 @@ "smithy.api#documentation": "

    The number of requests that completed with a 2xx Success status code.

    " } }, - "FaultStatistics": { - "target": "com.amazonaws.xray#FaultStatistics", + "ErrorStatistics": { + "target": "com.amazonaws.xray#ErrorStatistics", "traits": { - "smithy.api#documentation": "

    Information about requests that failed with a 5xx Server Error status code.

    " + "smithy.api#documentation": "

    Information about requests that failed with a 4xx Client Error status code.

    " } }, "TotalResponseTime": { @@ -660,10 +696,10 @@ "smithy.api#documentation": "

    The total number of completed requests.

    " } }, - "ErrorStatistics": { - "target": "com.amazonaws.xray#ErrorStatistics", + "FaultStatistics": { + "target": "com.amazonaws.xray#FaultStatistics", "traits": { - "smithy.api#documentation": "

    Information about requests that failed with a 4xx Client Error status code.

    " + "smithy.api#documentation": "

    Information about requests that failed with a 5xx Server Error status code.

    " } } }, @@ -680,17 +716,17 @@ "smithy.api#documentation": "

    The ID of the customer master key (CMK) used for encryption, if applicable.

    " } }, - "Status": { - "target": "com.amazonaws.xray#EncryptionStatus", - "traits": { - "smithy.api#documentation": "

    The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

    " - } - }, "Type": { "target": "com.amazonaws.xray#EncryptionType", "traits": { "smithy.api#documentation": "

    The type of encryption. Set to KMS for encryption with CMKs. Set to NONE for\n default encryption.

    " } + }, + "Status": { + "target": "com.amazonaws.xray#EncryptionStatus", + "traits": { + "smithy.api#documentation": "

    The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

    " + } } }, "traits": { @@ -777,17 +813,17 @@ "smithy.api#documentation": "

    The types and messages of the exceptions.

    " } }, - "Remote": { - "target": "com.amazonaws.xray#NullableBoolean", - "traits": { - "smithy.api#documentation": "

    A flag that denotes a remote subsegment.

    " - } - }, "Name": { "target": "com.amazonaws.xray#String", "traits": { "smithy.api#documentation": "

    The name of the entity.

    " } + }, + "Remote": { + "target": "com.amazonaws.xray#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    A flag that denotes a remote subsegment.

    " + } } }, "traits": { @@ -803,40 +839,40 @@ "com.amazonaws.xray#ErrorRootCauseService": { "type": "structure", "members": { - "Name": { + "AccountId": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The service name.

    " + "smithy.api#documentation": "

    The account ID associated to the service.

    " } }, - "Inferred": { - "target": "com.amazonaws.xray#NullableBoolean", + "EntityPath": { + "target": "com.amazonaws.xray#ErrorRootCauseEntityPath", "traits": { - "smithy.api#documentation": "

    A Boolean value indicating if the service is inferred from the trace.

    " + "smithy.api#documentation": "

    The path of root cause entities found on the service.

    " } }, - "Names": { - "target": "com.amazonaws.xray#ServiceNames", + "Name": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    A collection of associated service names.

    " + "smithy.api#documentation": "

    The service name.

    " } }, - "AccountId": { + "Type": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The account ID associated to the service.

    " + "smithy.api#documentation": "

    The type associated to the service.

    " } }, - "EntityPath": { - "target": "com.amazonaws.xray#ErrorRootCauseEntityPath", + "Names": { + "target": "com.amazonaws.xray#ServiceNames", "traits": { - "smithy.api#documentation": "

    The path of root cause entities found on the service.

    " + "smithy.api#documentation": "

    A collection of associated service names.

    " } }, - "Type": { - "target": "com.amazonaws.xray#String", + "Inferred": { + "target": "com.amazonaws.xray#NullableBoolean", "traits": { - "smithy.api#documentation": "

    The type associated to the service.

    " + "smithy.api#documentation": "

    A Boolean value indicating if the service is inferred from the trace.

    " } } }, @@ -865,16 +901,16 @@ "smithy.api#documentation": "

    The total number of requests that failed with a 4xx Client Error status code.

    " } }, - "OtherCount": { + "ThrottleCount": { "target": "com.amazonaws.xray#NullableLong", "traits": { - "smithy.api#documentation": "

    The number of requests that failed with untracked 4xx Client Error status\n codes.

    " + "smithy.api#documentation": "

    The number of requests that failed with a 419 throttling status code.

    " } }, - "ThrottleCount": { + "OtherCount": { "target": "com.amazonaws.xray#NullableLong", "traits": { - "smithy.api#documentation": "

    The number of requests that failed with a 419 throttling status code.

    " + "smithy.api#documentation": "

    The number of requests that failed with untracked 4xx Client Error status\n codes.

    " } } }, @@ -885,17 +921,17 @@ "com.amazonaws.xray#FaultRootCause": { "type": "structure", "members": { - "Services": { - "target": "com.amazonaws.xray#FaultRootCauseServices", - "traits": { - "smithy.api#documentation": "

    A list of corresponding services. A service identifies a segment and it contains a\n name, account ID, type, and inferred flag.

    " - } - }, "ClientImpacting": { "target": "com.amazonaws.xray#NullableBoolean", "traits": { "smithy.api#documentation": "

    A flag that denotes that the root cause impacts the trace client.

    " } + }, + "Services": { + "target": "com.amazonaws.xray#FaultRootCauseServices", + "traits": { + "smithy.api#documentation": "

    A list of corresponding services. A service identifies a segment and it contains a\n name, account ID, type, and inferred flag.

    " + } } }, "traits": { @@ -937,16 +973,16 @@ "com.amazonaws.xray#FaultRootCauseService": { "type": "structure", "members": { - "Inferred": { - "target": "com.amazonaws.xray#NullableBoolean", + "Name": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    A Boolean value indicating if the service is inferred from the trace.

    " + "smithy.api#documentation": "

    The service name.

    " } }, - "AccountId": { + "Type": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The account ID associated to the service.

    " + "smithy.api#documentation": "

    The type associated to the service.

    " } }, "Names": { @@ -955,10 +991,16 @@ "smithy.api#documentation": "

    A collection of associated service names.

    " } }, - "Name": { + "Inferred": { + "target": "com.amazonaws.xray#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    A Boolean value indicating if the service is inferred from the trace.

    " + } + }, + "AccountId": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The service name.

    " + "smithy.api#documentation": "

    The account ID associated to the service.

    " } }, "EntityPath": { @@ -966,12 +1008,6 @@ "traits": { "smithy.api#documentation": "

    The path of root cause entities found on the service.

    " } - }, - "Type": { - "target": "com.amazonaws.xray#String", - "traits": { - "smithy.api#documentation": "

    The type associated to the service.

    " - } } }, "traits": { @@ -993,16 +1029,16 @@ "com.amazonaws.xray#FaultStatistics": { "type": "structure", "members": { - "TotalCount": { + "OtherCount": { "target": "com.amazonaws.xray#NullableLong", "traits": { - "smithy.api#documentation": "

    The total number of requests that failed with a 5xx Server Error status code.

    " + "smithy.api#documentation": "

    The number of requests that failed with untracked 5xx Server Error status\n codes.

    " } }, - "OtherCount": { + "TotalCount": { "target": "com.amazonaws.xray#NullableLong", "traits": { - "smithy.api#documentation": "

    The number of requests that failed with untracked 5xx Server Error status\n codes.

    " + "smithy.api#documentation": "

    The total number of requests that failed with a 5xx Server Error status code.

    " } } }, @@ -1090,17 +1126,17 @@ "com.amazonaws.xray#GetGroupRequest": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.xray#GroupName", - "traits": { - "smithy.api#documentation": "

    The case-sensitive name of the group.

    " - } - }, "GroupARN": { "target": "com.amazonaws.xray#GroupARN", "traits": { "smithy.api#documentation": "

    The ARN of the group that was generated on creation.

    " } + }, + "GroupName": { + "target": "com.amazonaws.xray#GroupName", + "traits": { + "smithy.api#documentation": "

    The case-sensitive name of the group.

    " + } } } }, @@ -1110,7 +1146,7 @@ "Group": { "target": "com.amazonaws.xray#Group", "traits": { - "smithy.api#documentation": "

    The group that was requested. Contains the name of the group, the ARN of the group,\n and the filter expression that assigned to the group.

    " + "smithy.api#documentation": "

    The group that was requested. Contains the name of the group, the ARN of the group,\n the filter expression, and the insight configuration assigned to the group.

    " } } } @@ -1168,17 +1204,17 @@ "com.amazonaws.xray#GetGroupsResult": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.xray#GroupSummaryList", - "traits": { - "smithy.api#documentation": "

    The collection of all active groups.

    " - } - }, "NextToken": { "target": "com.amazonaws.xray#String", "traits": { "smithy.api#documentation": "

    Pagination token.

    " } + }, + "Groups": { + "target": "com.amazonaws.xray#GroupSummaryList", + "traits": { + "smithy.api#documentation": "

    The collection of all active groups.

    " + } } } }, @@ -1284,17 +1320,17 @@ "com.amazonaws.xray#GetSamplingStatisticSummariesResult": { "type": "structure", "members": { - "SamplingStatisticSummaries": { - "target": "com.amazonaws.xray#SamplingStatisticSummaryList", - "traits": { - "smithy.api#documentation": "

    Information about the number of requests instrumented for each sampling\n rule.

    " - } - }, "NextToken": { "target": "com.amazonaws.xray#String", "traits": { "smithy.api#documentation": "

    Pagination token.

    " } + }, + "SamplingStatisticSummaries": { + "target": "com.amazonaws.xray#SamplingStatisticSummaryList", + "traits": { + "smithy.api#documentation": "

    Information about the number of requests instrumented for each sampling\n rule.

    " + } } } }, @@ -1344,17 +1380,17 @@ "smithy.api#documentation": "

    The last time a user changed the sampling rule configuration. If\n the sampling rule configuration changed since the service last retrieved it, the service\n should call GetSamplingRules to get the latest version.

    " } }, - "UnprocessedStatistics": { - "target": "com.amazonaws.xray#UnprocessedStatisticsList", - "traits": { - "smithy.api#documentation": "

    Information about SamplingStatisticsDocument that X-Ray could not\n process.

    " - } - }, "SamplingTargetDocuments": { "target": "com.amazonaws.xray#SamplingTargetDocumentList", "traits": { "smithy.api#documentation": "

    Updated rules that the service should use to sample requests.

    " } + }, + "UnprocessedStatistics": { + "target": "com.amazonaws.xray#UnprocessedStatisticsList", + "traits": { + "smithy.api#documentation": "

    Information about SamplingStatisticsDocument that X-Ray could not\n process.

    " + } } } }, @@ -1394,7 +1430,7 @@ "GroupName": { "target": "com.amazonaws.xray#GroupName", "traits": { - "smithy.api#documentation": "

    The name of a group to generate a graph based on.

    " + "smithy.api#documentation": "

    The name of a group based on which you want to generate a graph.

    " } }, "EndTime": { @@ -1404,19 +1440,19 @@ "smithy.api#required": {} } }, - "GroupARN": { - "target": "com.amazonaws.xray#GroupARN", - "traits": { - "smithy.api#documentation": "

    The ARN of a group to generate a graph based on.

    " - } - }, "NextToken": { "target": "com.amazonaws.xray#String", "traits": { "smithy.api#documentation": "

    Pagination token.

    " } }, - "StartTime": { + "GroupARN": { + "target": "com.amazonaws.xray#GroupARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.

    " + } + }, + "StartTime": { "target": "com.amazonaws.xray#Timestamp", "traits": { "smithy.api#documentation": "

    The start of the time frame for which to generate a graph.

    ", @@ -1440,10 +1476,10 @@ "smithy.api#documentation": "

    Pagination token.

    " } }, - "EndTime": { - "target": "com.amazonaws.xray#Timestamp", + "Services": { + "target": "com.amazonaws.xray#ServiceList", "traits": { - "smithy.api#documentation": "

    The end of the time frame for which the graph was generated.

    " + "smithy.api#documentation": "

    The services that have processed a traced request during the specified time\n frame.

    " } }, "StartTime": { @@ -1452,10 +1488,10 @@ "smithy.api#documentation": "

    The start of the time frame for which the graph was generated.

    " } }, - "Services": { - "target": "com.amazonaws.xray#ServiceList", + "EndTime": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    The services that have processed a traced request during the specified time\n frame.

    " + "smithy.api#documentation": "

    The end of the time frame for which the graph was generated.

    " } } } @@ -1493,48 +1529,48 @@ "com.amazonaws.xray#GetTimeSeriesServiceStatisticsRequest": { "type": "structure", "members": { + "EntitySelectorExpression": { + "target": "com.amazonaws.xray#EntitySelectorExpression", + "traits": { + "smithy.api#documentation": "

    A filter expression defining entities that will be aggregated for statistics.\n Supports ID, service, and edge functions. If no selector expression is specified, edge\n statistics are returned.

    " + } + }, "GroupName": { "target": "com.amazonaws.xray#GroupName", "traits": { "smithy.api#documentation": "

    The case-sensitive name of the group for which to pull statistics from.

    " } }, - "NextToken": { - "target": "com.amazonaws.xray#String", + "EndTime": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    Pagination token.

    " + "smithy.api#documentation": "

    The end of the time frame for which to aggregate statistics.

    ", + "smithy.api#required": {} } }, - "Period": { - "target": "com.amazonaws.xray#NullableInteger", + "StartTime": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    Aggregation period in seconds.

    " + "smithy.api#documentation": "

    The start of the time frame for which to aggregate statistics.

    ", + "smithy.api#required": {} } }, "GroupARN": { "target": "com.amazonaws.xray#GroupARN", "traits": { - "smithy.api#documentation": "

    The ARN of the group for which to pull statistics from.

    " - } - }, - "StartTime": { - "target": "com.amazonaws.xray#Timestamp", - "traits": { - "smithy.api#documentation": "

    The start of the time frame for which to aggregate statistics.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the group for which to pull statistics from.

    " } }, - "EndTime": { - "target": "com.amazonaws.xray#Timestamp", + "NextToken": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The end of the time frame for which to aggregate statistics.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Pagination token.

    " } }, - "EntitySelectorExpression": { - "target": "com.amazonaws.xray#EntitySelectorExpression", + "Period": { + "target": "com.amazonaws.xray#NullableInteger", "traits": { - "smithy.api#documentation": "

    A filter expression defining entities that will be aggregated for statistics.\n Supports ID, service, and edge functions. If no selector expression is specified, edge\n statistics are returned.

    " + "smithy.api#documentation": "

    Aggregation period in seconds.

    " } } } @@ -1542,10 +1578,10 @@ "com.amazonaws.xray#GetTimeSeriesServiceStatisticsResult": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.xray#String", + "ContainsOldGroupVersions": { + "target": "com.amazonaws.xray#Boolean", "traits": { - "smithy.api#documentation": "

    Pagination token.

    " + "smithy.api#documentation": "

    A flag indicating whether or not a group's filter expression has been consistent, or if a returned\n aggregation might show statistics from an older version of the group's filter expression.

    " } }, "TimeSeriesServiceStatistics": { @@ -1554,10 +1590,10 @@ "smithy.api#documentation": "

    The collection of statistics.

    " } }, - "ContainsOldGroupVersions": { - "target": "com.amazonaws.xray#Boolean", + "NextToken": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    A flag indicating whether or not a group's filter expression has been consistent,\n or if a returned aggregation may show statistics from an older version of the group's\n filter expression.

    " + "smithy.api#documentation": "

    Pagination token.

    " } } } @@ -1667,22 +1703,29 @@ "smithy.api#required": {} } }, + "SamplingStrategy": { + "target": "com.amazonaws.xray#SamplingStrategy", + "traits": { + "smithy.api#documentation": "

    A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and\n Value.

    " + } + }, "Sampling": { "target": "com.amazonaws.xray#NullableBoolean", "traits": { "smithy.api#documentation": "

    Set to true to get summaries for only a subset of available\n traces.

    " } }, - "SamplingStrategy": { - "target": "com.amazonaws.xray#SamplingStrategy", + "StartTime": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    A paramater to indicate whether to enable sampling on trace summaries. Input\n parameters are Name and Value.

    " + "smithy.api#documentation": "

    The start of the time frame for which to retrieve traces.

    ", + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.xray#String", + "TimeRangeType": { + "target": "com.amazonaws.xray#TimeRangeType", "traits": { - "smithy.api#documentation": "

    Specify the pagination token returned by a previous request to retrieve the next page\n of results.

    " + "smithy.api#documentation": "

    A parameter to indicate whether to query trace summaries by TraceId or Event time.

    " } }, "FilterExpression": { @@ -1691,17 +1734,10 @@ "smithy.api#documentation": "

    Specify a filter expression to retrieve trace summaries for services or requests that\n meet certain requirements.

    " } }, - "TimeRangeType": { - "target": "com.amazonaws.xray#TimeRangeType", - "traits": { - "smithy.api#documentation": "

    A parameter to indicate whether to query trace summaries by TraceId or Event time.

    " - } - }, - "StartTime": { - "target": "com.amazonaws.xray#Timestamp", + "NextToken": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The start of the time frame for which to retrieve traces.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Specify the pagination token returned by a previous request to retrieve the next page\n of results.

    " } } } @@ -1721,39 +1757,45 @@ "smithy.api#documentation": "

    The start time of this page of results.

    " } }, - "NextToken": { - "target": "com.amazonaws.xray#String", - "traits": { - "smithy.api#documentation": "

    If the requested time frame contained more than one page of results, you can use this\n token to retrieve the next page. The first page contains the most most recent results, closest\n to the end of the time frame.

    " - } - }, "TracesProcessedCount": { "target": "com.amazonaws.xray#NullableLong", "traits": { "smithy.api#documentation": "

    The total number of traces processed, including traces that did not match the specified\n filter expression.

    " } + }, + "NextToken": { + "target": "com.amazonaws.xray#String", + "traits": { + "smithy.api#documentation": "

    If the requested time frame contained more than one page of results, you can use this token to retrieve the\n next page. The first page contains the most recent results, closest to the end of the time frame.

    " + } } } }, "com.amazonaws.xray#Group": { "type": "structure", "members": { - "GroupARN": { + "InsightsConfiguration": { + "target": "com.amazonaws.xray#InsightsConfiguration", + "traits": { + "smithy.api#documentation": "

    The structure containing configurations related to insights.

    \n
      \n
    • \n

      The InsightsEnabled boolean can be set to true to enable insights for the\n group or false to disable insights for the group.

      \n
      • \n
    • \n

      The NotifcationsEnabled boolean can be set to true to enable insights\n notifications through Amazon EventBridge for the group.

      \n
      • \n
    " + } + }, + "FilterExpression": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The ARN of the group generated based on the GroupName.

    " + "smithy.api#documentation": "

    The filter expression defining the parameters to include traces.

    " } }, - "GroupName": { + "GroupARN": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The unique case-sensitive name of the group.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the group generated based on the GroupName.

    " } }, - "FilterExpression": { + "GroupName": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The filter expression defining the parameters to include traces.

    " + "smithy.api#documentation": "

    The unique case-sensitive name of the group.

    " } } }, @@ -1782,16 +1824,22 @@ "com.amazonaws.xray#GroupSummary": { "type": "structure", "members": { + "GroupARN": { + "target": "com.amazonaws.xray#String", + "traits": { + "smithy.api#documentation": "

    The ARN of the group generated based on the GroupName.

    " + } + }, "FilterExpression": { "target": "com.amazonaws.xray#String", "traits": { "smithy.api#documentation": "

    The filter expression defining the parameters to include traces.

    " } }, - "GroupARN": { - "target": "com.amazonaws.xray#String", + "InsightsConfiguration": { + "target": "com.amazonaws.xray#InsightsConfiguration", "traits": { - "smithy.api#documentation": "

    The ARN of the group generated based on the GroupName.

    " + "smithy.api#documentation": "

    The structure containing configurations related to insights.

    \n
      \n
    • \n

      The InsightsEnabled boolean can be set to true to enable insights for the\n group or false to disable insights for the group.

      \n
      • \n
    • \n

      The NotificationsEnabled boolean can be set to true to enable insights notifications.\n Notifications can only be enabled on a group with InsightsEnabled set to true.

      \n
      • \n
    " } }, "GroupName": { @@ -1829,17 +1877,17 @@ "com.amazonaws.xray#HistogramEntry": { "type": "structure", "members": { - "Count": { - "target": "com.amazonaws.xray#Integer", - "traits": { - "smithy.api#documentation": "

    The prevalence of the entry.

    " - } - }, "Value": { "target": "com.amazonaws.xray#Double", "traits": { "smithy.api#documentation": "

    The value of the entry.

    " } + }, + "Count": { + "target": "com.amazonaws.xray#Integer", + "traits": { + "smithy.api#documentation": "

    The prevalence of the entry.

    " + } } }, "traits": { @@ -1873,10 +1921,16 @@ "smithy.api#documentation": "

    The request URL.

    " } }, - "HttpMethod": { + "HttpStatus": { + "target": "com.amazonaws.xray#NullableInteger", + "traits": { + "smithy.api#documentation": "

    The response status.

    " + } + }, + "UserAgent": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The request method.

    " + "smithy.api#documentation": "

    The request's user agent string.

    " } }, "ClientIp": { @@ -1885,21 +1939,35 @@ "smithy.api#documentation": "

    The IP address of the requestor.

    " } }, - "UserAgent": { + "HttpMethod": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The request's user agent string.

    " + "smithy.api#documentation": "

    The request method.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an HTTP request.

    " + } + }, + "com.amazonaws.xray#InsightsConfiguration": { + "type": "structure", + "members": { + "NotificationsEnabled": { + "target": "com.amazonaws.xray#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be\n enabled on a group with InsightsEnabled set to true.

    " } }, - "HttpStatus": { - "target": "com.amazonaws.xray#NullableInteger", + "InsightsEnabled": { + "target": "com.amazonaws.xray#NullableBoolean", "traits": { - "smithy.api#documentation": "

    The response status.

    " + "smithy.api#documentation": "

    Set the InsightsEnabled value to true to enable insights or false to disable\n insights.

    " } } }, "traits": { - "smithy.api#documentation": "

    Information about an HTTP request.

    " + "smithy.api#documentation": "

    The structure containing configurations related to insights.

    " } }, "com.amazonaws.xray#InstanceIdDetail": { @@ -1931,6 +1999,69 @@ "smithy.api#error": "client" } }, + "com.amazonaws.xray#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.xray#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.xray#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.xray#InvalidRequestException" + }, + { + "target": "com.amazonaws.xray#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.xray#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

    Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTagsForResource", + "code": 200 + } + } + }, + "com.amazonaws.xray#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.xray#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

    ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.xray#String", + "traits": { + "smithy.api#documentation": "

    A pagination token. If multiple pages of results are returned, use the NextToken value returned with \n the current page of results as the value of this parameter to get the next page of results.

    " + } + } + } + }, + "com.amazonaws.xray#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.xray#String", + "traits": { + "smithy.api#documentation": "

    A pagination token. If multiple pages of results are returned, use the NextToken value returned with \n the current page of results to get the next page of results.

    " + } + }, + "Tags": { + "target": "com.amazonaws.xray#TagList", + "traits": { + "smithy.api#documentation": "

    A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.

    " + } + } + } + }, "com.amazonaws.xray#NullableBoolean": { "type": "boolean", "traits": { @@ -1992,18 +2123,18 @@ "com.amazonaws.xray#PutEncryptionConfigRequest": { "type": "structure", "members": { - "KeyId": { - "target": "com.amazonaws.xray#EncryptionKeyId", - "traits": { - "smithy.api#documentation": "

    An AWS KMS customer master key (CMK) in one of the following formats:

    \n
      \n
    • \n

      \n Alias - The name of the key. For example,\n alias/MyKey.

      \n
      • \n
    • \n

      \n Key ID - The KMS key ID of the key. For example,\n ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

      \n
      • \n
    • \n

      \n ARN - The full Amazon Resource Name of the key ID or alias.\n For example,\n arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.\n Use this format to specify a key in a different account.

      \n
      • \n
    \n

    Omit this key if you set Type to NONE.

    " - } - }, "Type": { "target": "com.amazonaws.xray#EncryptionType", "traits": { "smithy.api#documentation": "

    The type of encryption. Set to KMS to use your own key for encryption. Set\n to NONE for default encryption.

    ", "smithy.api#required": {} } + }, + "KeyId": { + "target": "com.amazonaws.xray#EncryptionKeyId", + "traits": { + "smithy.api#documentation": "

    An AWS KMS customer master key (CMK) in one of the following formats:

    \n
      \n
    • \n

      \n Alias - The name of the key. For example,\n alias/MyKey.

      \n
      • \n
    • \n

      \n Key ID - The KMS key ID of the key. For example,\n ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.

      \n
      • \n
    • \n

      \n ARN - The full Amazon Resource Name of the key ID or alias.\n For example,\n arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.\n Use this format to specify a key in a different account.

      \n
      • \n
    \n

    Omit this key if you set Type to NONE.

    " + } } } }, @@ -2053,20 +2184,20 @@ "smithy.api#required": {} } }, - "EC2InstanceId": { - "target": "com.amazonaws.xray#EC2InstanceId", + "ResourceARN": { + "target": "com.amazonaws.xray#ResourceARN", "traits": { "smithy.api#documentation": "

    " } }, - "Hostname": { - "target": "com.amazonaws.xray#Hostname", + "EC2InstanceId": { + "target": "com.amazonaws.xray#EC2InstanceId", "traits": { "smithy.api#documentation": "

    " } }, - "ResourceARN": { - "target": "com.amazonaws.xray#ResourceARN", + "Hostname": { + "target": "com.amazonaws.xray#Hostname", "traits": { "smithy.api#documentation": "

    " } @@ -2094,7 +2225,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and\n sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a\n completed segment, an in-progress segment, or an array of subsegments.

    \n

    Segments must include the following fields. For the full segment document schema, see\n AWS X-Ray\n Segment Documents in the AWS X-Ray Developer Guide.

    \n

    \n Required Segment Document Fields\n

    \n
      \n
    • \n

      \n name - The name of the service that handled the request.

      \n
      • \n
    • \n

      \n id - A 64-bit identifier for the segment, unique among segments in the\n same trace, in 16 hexadecimal digits.

      \n
      • \n
    • \n

      \n trace_id - A unique identifier that connects all segments and\n subsegments originating from a single client request.

      \n
      • \n
    • \n

      \n start_time - Time the segment or subsegment was created, in floating\n point seconds in epoch time, accurate to milliseconds. For example,\n 1480615200.010 or 1.480615200010E9.

      \n
      • \n
    • \n

      \n end_time - Time the segment or subsegment was closed. For example,\n 1480615200.090 or 1.480615200090E9. Specify either an\n end_time or in_progress.

      \n
      • \n
    • \n

      \n in_progress - Set to true instead of specifying an\n end_time to record that a segment has been started, but is not complete.\n Send an in progress segment when your application receives a request that will take a long\n time to serve, to trace the fact that the request was received. When the response is sent,\n send the complete segment to overwrite the in-progress segment.

      \n
      • \n
    \n

    A trace_id consists of three numbers separated by hyphens. For example,\n 1-58406520-a006649127e371903a2de979. This includes:

    \n

    \n Trace ID Format\n

    \n
      \n
    • \n

      The version number, i.e. 1.

      \n
      • \n
    • \n

      The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For\n example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds,\n or 58406520 in hexadecimal.

      \n
      • \n
    • \n

      A 96-bit identifier for the trace, globally unique, in 24 hexadecimal\n digits.

      \n
      • \n
    ", + "smithy.api#documentation": "

    Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in\n batches. A segment document can be a completed segment, an in-progress segment, or an array of\n subsegments.

    \n

    Segments must include the following fields. For the full segment document schema, see\n AWS X-Ray\n Segment Documents in the AWS X-Ray Developer Guide.

    \n

    \n Required segment document fields\n

    \n
      \n
    • \n

      \n name - The name of the service that handled the request.

      \n
      • \n
    • \n

      \n id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16\n hexadecimal digits.

      \n
      • \n
    • \n

      \n trace_id - A unique identifier that connects all segments and subsegments originating from\n a single client request.

      \n
      • \n
    • \n

      \n start_time - Time the segment or subsegment was created, in floating point seconds in\n epoch time, accurate to milliseconds. For example, 1480615200.010 or\n 1.480615200010E9.

      \n
      • \n
    • \n

      \n end_time - Time the segment or subsegment was closed. For example,\n 1480615200.090 or 1.480615200090E9. Specify either an end_time or\n in_progress.

      \n
      • \n
    • \n

      \n in_progress - Set to true instead of specifying an end_time to\n record that a segment has been started, but is not complete. Send an in-progress segment when your application\n receives a request that will take a long time to serve, to trace that the request was received. When the\n response is sent, send the complete segment to overwrite the in-progress segment.

      \n
      • \n
    \n

    A trace_id consists of three numbers separated by hyphens. For example,\n 1-58406520-a006649127e371903a2de979. This includes:

    \n

    \n Trace ID Format\n

    \n
      \n
    • \n

      The version number, for instance, 1.

      \n
      • \n
    • \n

      The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For\n example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds,\n or 58406520 in hexadecimal.

      \n
      • \n
    • \n

      A 96-bit identifier for the trace, globally unique, in 24 hexadecimal\n digits.

      \n
      • \n
    ", "smithy.api#http": { "method": "POST", "uri": "/TraceSegments", @@ -2164,20 +2295,36 @@ "smithy.api#documentation": "

    A list of resources ARNs corresponding to the segments in a trace.

    " } }, - "com.amazonaws.xray#ResponseTimeRootCause": { + "com.amazonaws.xray#ResourceNotFoundException": { "type": "structure", "members": { - "Services": { - "target": "com.amazonaws.xray#ResponseTimeRootCauseServices", - "traits": { - "smithy.api#documentation": "

    A list of corresponding services. A service identifies a segment and contains a name,\n account ID, type, and inferred flag.

    " - } + "Message": { + "target": "com.amazonaws.xray#ErrorMessage" }, - "ClientImpacting": { - "target": "com.amazonaws.xray#NullableBoolean", - "traits": { + "ResourceName": { + "target": "com.amazonaws.xray#AmazonResourceName" + } + }, + "traits": { + "smithy.api#documentation": "

    The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is\n correct.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.xray#ResponseTimeRootCause": { + "type": "structure", + "members": { + "ClientImpacting": { + "target": "com.amazonaws.xray#NullableBoolean", + "traits": { "smithy.api#documentation": "

    A flag that denotes that the root cause impacts the trace client.

    " } + }, + "Services": { + "target": "com.amazonaws.xray#ResponseTimeRootCauseServices", + "traits": { + "smithy.api#documentation": "

    A list of corresponding services. A service identifies a segment and contains a name,\n account ID, type, and inferred flag.

    " + } } }, "traits": { @@ -2187,12 +2334,6 @@ "com.amazonaws.xray#ResponseTimeRootCauseEntity": { "type": "structure", "members": { - "Coverage": { - "target": "com.amazonaws.xray#NullableDouble", - "traits": { - "smithy.api#documentation": "

    The types and messages of the exceptions.

    " - } - }, "Name": { "target": "com.amazonaws.xray#String", "traits": { @@ -2204,6 +2345,12 @@ "traits": { "smithy.api#documentation": "

    A flag that denotes a remote subsegment.

    " } + }, + "Coverage": { + "target": "com.amazonaws.xray#NullableDouble", + "traits": { + "smithy.api#documentation": "

    The type and messages of the exceptions.

    " + } } }, "traits": { @@ -2219,10 +2366,22 @@ "com.amazonaws.xray#ResponseTimeRootCauseService": { "type": "structure", "members": { - "Name": { + "EntityPath": { + "target": "com.amazonaws.xray#ResponseTimeRootCauseEntityPath", + "traits": { + "smithy.api#documentation": "

    The path of root cause entities found on the service.

    " + } + }, + "Inferred": { + "target": "com.amazonaws.xray#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    A Boolean value indicating if the service is inferred from the trace.

    " + } + }, + "AccountId": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The service name.

    " + "smithy.api#documentation": "

    The account ID associated to the service.

    " } }, "Type": { @@ -2237,22 +2396,10 @@ "smithy.api#documentation": "

    A collection of associated service names.

    " } }, - "AccountId": { + "Name": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The account ID associated to the service.

    " - } - }, - "Inferred": { - "target": "com.amazonaws.xray#NullableBoolean", - "traits": { - "smithy.api#documentation": "

    A Boolean value indicating if the service is inferred from the trace.

    " - } - }, - "EntityPath": { - "target": "com.amazonaws.xray#ResponseTimeRootCauseEntityPath", - "traits": { - "smithy.api#documentation": "

    The path of root cause entities found on the service.

    " + "smithy.api#documentation": "

    The service name.

    " } } }, @@ -2275,16 +2422,16 @@ "com.amazonaws.xray#RootCauseException": { "type": "structure", "members": { - "Message": { + "Name": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The message of the exception.

    " + "smithy.api#documentation": "

    The name of the exception.

    " } }, - "Name": { + "Message": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The name of the exception.

    " + "smithy.api#documentation": "

    The message of the exception.

    " } } }, @@ -2330,51 +2477,57 @@ "com.amazonaws.xray#SamplingRule": { "type": "structure", "members": { - "FixedRate": { - "target": "com.amazonaws.xray#FixedRate", + "Priority": { + "target": "com.amazonaws.xray#Priority", "traits": { - "smithy.api#documentation": "

    The percentage of matching requests to instrument, after the reservoir is\n exhausted.

    ", + "smithy.api#documentation": "

    The priority of the sampling rule.

    ", "smithy.api#required": {} } }, - "ServiceType": { - "target": "com.amazonaws.xray#ServiceType", + "URLPath": { + "target": "com.amazonaws.xray#URLPath", "traits": { - "smithy.api#documentation": "

    Matches the origin that the service uses to identify its type in segments.

    ", + "smithy.api#documentation": "

    Matches the path from a request URL.

    ", "smithy.api#required": {} } }, - "Attributes": { - "target": "com.amazonaws.xray#AttributeMap", + "Host": { + "target": "com.amazonaws.xray#Host", "traits": { - "smithy.api#documentation": "

    Matches attributes derived from the request.

    " + "smithy.api#documentation": "

    Matches the hostname from a request URL.

    ", + "smithy.api#required": {} } }, - "Version": { - "target": "com.amazonaws.xray#Version", + "ServiceName": { + "target": "com.amazonaws.xray#ServiceName", "traits": { - "smithy.api#documentation": "

    The version of the sampling rule format (1).

    ", + "smithy.api#documentation": "

    Matches the name that the service uses to identify itself in segments.

    ", "smithy.api#required": {} } }, - "HTTPMethod": { - "target": "com.amazonaws.xray#HTTPMethod", + "Attributes": { + "target": "com.amazonaws.xray#AttributeMap", "traits": { - "smithy.api#documentation": "

    Matches the HTTP method of a request.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Matches attributes derived from the request.

    " } }, - "ServiceName": { - "target": "com.amazonaws.xray#ServiceName", + "FixedRate": { + "target": "com.amazonaws.xray#FixedRate", "traits": { - "smithy.api#documentation": "

    Matches the name that the service uses to identify itself in segments.

    ", + "smithy.api#documentation": "

    The percentage of matching requests to instrument, after the reservoir is\n exhausted.

    ", "smithy.api#required": {} } }, - "ReservoirSize": { - "target": "com.amazonaws.xray#ReservoirSize", + "RuleName": { + "target": "com.amazonaws.xray#RuleName", "traits": { - "smithy.api#documentation": "

    A fixed number of matching requests to instrument per second, prior to applying the\n fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    ", + "smithy.api#documentation": "

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + } + }, + "ResourceARN": { + "target": "com.amazonaws.xray#ResourceARN", + "traits": { + "smithy.api#documentation": "

    Matches the ARN of the AWS resource on which the service runs.

    ", "smithy.api#required": {} } }, @@ -2384,39 +2537,33 @@ "smithy.api#documentation": "

    The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

    " } }, - "Host": { - "target": "com.amazonaws.xray#Host", + "Version": { + "target": "com.amazonaws.xray#Version", "traits": { - "smithy.api#documentation": "

    Matches the hostname from a request URL.

    ", + "smithy.api#documentation": "

    The version of the sampling rule format (1).

    ", "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.xray#ResourceARN", + "ReservoirSize": { + "target": "com.amazonaws.xray#ReservoirSize", "traits": { - "smithy.api#documentation": "

    Matches the ARN of the AWS resource on which the service runs.

    ", + "smithy.api#documentation": "

    A fixed number of matching requests to instrument per second, prior to applying the\n fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    ", "smithy.api#required": {} } }, - "Priority": { - "target": "com.amazonaws.xray#Priority", + "ServiceType": { + "target": "com.amazonaws.xray#ServiceType", "traits": { - "smithy.api#documentation": "

    The priority of the sampling rule.

    ", + "smithy.api#documentation": "

    Matches the origin that the service uses to identify its type in segments.

    ", "smithy.api#required": {} } }, - "URLPath": { - "target": "com.amazonaws.xray#URLPath", + "HTTPMethod": { + "target": "com.amazonaws.xray#HTTPMethod", "traits": { - "smithy.api#documentation": "

    Matches the path from a request URL.

    ", + "smithy.api#documentation": "

    Matches the HTTP method of a request.

    ", "smithy.api#required": {} } - }, - "RuleName": { - "target": "com.amazonaws.xray#RuleName", - "traits": { - "smithy.api#documentation": "

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    " - } } }, "traits": { @@ -2432,16 +2579,16 @@ "smithy.api#documentation": "

    The sampling rule.

    " } }, - "CreatedAt": { + "ModifiedAt": { "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    When the rule was created.

    " + "smithy.api#documentation": "

    When the rule was last modified.

    " } }, - "ModifiedAt": { + "CreatedAt": { "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    When the rule was last modified.

    " + "smithy.api#documentation": "

    When the rule was created.

    " } } }, @@ -2458,52 +2605,46 @@ "com.amazonaws.xray#SamplingRuleUpdate": { "type": "structure", "members": { - "ReservoirSize": { - "target": "com.amazonaws.xray#NullableInteger", - "traits": { - "smithy.api#documentation": "

    A fixed number of matching requests to instrument per second, prior to applying the\n fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    " - } - }, "ServiceName": { "target": "com.amazonaws.xray#ServiceName", "traits": { "smithy.api#documentation": "

    Matches the name that the service uses to identify itself in segments.

    " } }, - "Attributes": { - "target": "com.amazonaws.xray#AttributeMap", - "traits": { - "smithy.api#documentation": "

    Matches attributes derived from the request.

    " - } - }, "RuleARN": { "target": "com.amazonaws.xray#String", "traits": { "smithy.api#documentation": "

    The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

    " } }, - "ServiceType": { - "target": "com.amazonaws.xray#ServiceType", + "Attributes": { + "target": "com.amazonaws.xray#AttributeMap", "traits": { - "smithy.api#documentation": "

    Matches the origin that the service uses to identify its type in segments.

    " + "smithy.api#documentation": "

    Matches attributes derived from the request.

    " } }, - "Host": { - "target": "com.amazonaws.xray#Host", + "ReservoirSize": { + "target": "com.amazonaws.xray#NullableInteger", "traits": { - "smithy.api#documentation": "

    Matches the hostname from a request URL.

    " + "smithy.api#documentation": "

    A fixed number of matching requests to instrument per second, prior to applying the\n fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    " } }, - "Priority": { - "target": "com.amazonaws.xray#NullableInteger", + "RuleName": { + "target": "com.amazonaws.xray#RuleName", "traits": { - "smithy.api#documentation": "

    The priority of the sampling rule.

    " + "smithy.api#documentation": "

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    " } }, - "ResourceARN": { - "target": "com.amazonaws.xray#ResourceARN", + "HTTPMethod": { + "target": "com.amazonaws.xray#HTTPMethod", "traits": { - "smithy.api#documentation": "

    Matches the ARN of the AWS resource on which the service runs.

    " + "smithy.api#documentation": "

    Matches the HTTP method of a request.

    " + } + }, + "FixedRate": { + "target": "com.amazonaws.xray#NullableDouble", + "traits": { + "smithy.api#documentation": "

    The percentage of matching requests to instrument, after the reservoir is\n exhausted.

    " } }, "URLPath": { @@ -2512,22 +2653,28 @@ "smithy.api#documentation": "

    Matches the path from a request URL.

    " } }, - "RuleName": { - "target": "com.amazonaws.xray#RuleName", + "ResourceARN": { + "target": "com.amazonaws.xray#ResourceARN", "traits": { - "smithy.api#documentation": "

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + "smithy.api#documentation": "

    Matches the ARN of the AWS resource on which the service runs.

    " } }, - "FixedRate": { - "target": "com.amazonaws.xray#NullableDouble", + "Priority": { + "target": "com.amazonaws.xray#NullableInteger", "traits": { - "smithy.api#documentation": "

    The percentage of matching requests to instrument, after the reservoir is\n exhausted.

    " + "smithy.api#documentation": "

    The priority of the sampling rule.

    " } }, - "HTTPMethod": { - "target": "com.amazonaws.xray#HTTPMethod", + "Host": { + "target": "com.amazonaws.xray#Host", "traits": { - "smithy.api#documentation": "

    Matches the HTTP method of a request.

    " + "smithy.api#documentation": "

    Matches the hostname from a request URL.

    " + } + }, + "ServiceType": { + "target": "com.amazonaws.xray#ServiceType", + "traits": { + "smithy.api#documentation": "

    Matches the origin that the service uses to identify its type in segments.

    " } } }, @@ -2550,10 +2697,10 @@ "smithy.api#documentation": "

    The number of requests recorded.

    " } }, - "Timestamp": { - "target": "com.amazonaws.xray#Timestamp", + "RequestCount": { + "target": "com.amazonaws.xray#Integer", "traits": { - "smithy.api#documentation": "

    The start time of the reporting window.

    " + "smithy.api#documentation": "

    The number of requests that matched the rule.

    " } }, "BorrowCount": { @@ -2562,15 +2709,15 @@ "smithy.api#documentation": "

    The number of requests recorded with borrowed reservoir quota.

    " } }, - "RequestCount": { - "target": "com.amazonaws.xray#Integer", + "Timestamp": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    The number of requests that matched the rule.

    " + "smithy.api#documentation": "

    The start time of the reporting window.

    " } } }, "traits": { - "smithy.api#documentation": "

    Aggregated request sampling data for a sampling rule across all services for a 10\n second window.

    " + "smithy.api#documentation": "

    Aggregated request sampling data for a sampling rule across all services for a 10-second window.

    " } }, "com.amazonaws.xray#SamplingStatisticSummaryList": { @@ -2582,13 +2729,6 @@ "com.amazonaws.xray#SamplingStatisticsDocument": { "type": "structure", "members": { - "SampledCount": { - "target": "com.amazonaws.xray#SampledCount", - "traits": { - "smithy.api#documentation": "

    The number of requests recorded.

    ", - "smithy.api#required": {} - } - }, "RequestCount": { "target": "com.amazonaws.xray#RequestCount", "traits": { @@ -2596,17 +2736,18 @@ "smithy.api#required": {} } }, - "RuleName": { - "target": "com.amazonaws.xray#RuleName", + "ClientID": { + "target": "com.amazonaws.xray#ClientID", "traits": { - "smithy.api#documentation": "

    The name of the sampling rule.

    ", + "smithy.api#documentation": "

    A unique identifier for the service in hexadecimal.

    ", "smithy.api#required": {} } }, - "BorrowCount": { - "target": "com.amazonaws.xray#BorrowCount", + "SampledCount": { + "target": "com.amazonaws.xray#SampledCount", "traits": { - "smithy.api#documentation": "

    The number of requests recorded with borrowed reservoir quota.

    " + "smithy.api#documentation": "

    The number of requests recorded.

    ", + "smithy.api#required": {} } }, "Timestamp": { @@ -2616,10 +2757,16 @@ "smithy.api#required": {} } }, - "ClientID": { - "target": "com.amazonaws.xray#ClientID", + "BorrowCount": { + "target": "com.amazonaws.xray#BorrowCount", "traits": { - "smithy.api#documentation": "

    A unique identifier for the service in hexadecimal.

    ", + "smithy.api#documentation": "

    The number of requests recorded with borrowed reservoir quota.

    " + } + }, + "RuleName": { + "target": "com.amazonaws.xray#RuleName", + "traits": { + "smithy.api#documentation": "

    The name of the sampling rule.

    ", "smithy.api#required": {} } } @@ -2678,39 +2825,39 @@ "com.amazonaws.xray#SamplingTargetDocument": { "type": "structure", "members": { - "RuleName": { - "target": "com.amazonaws.xray#String", + "ReservoirQuota": { + "target": "com.amazonaws.xray#NullableInteger", "traits": { - "smithy.api#documentation": "

    The name of the sampling rule.

    " + "smithy.api#documentation": "

    The number of requests per second that X-Ray allocated for this service.

    " } }, - "ReservoirQuotaTTL": { - "target": "com.amazonaws.xray#Timestamp", + "Interval": { + "target": "com.amazonaws.xray#NullableInteger", "traits": { - "smithy.api#documentation": "

    When the reservoir quota expires.

    " + "smithy.api#documentation": "

    The number of seconds for the service to wait before getting sampling targets\n again.

    " } }, - "FixedRate": { - "target": "com.amazonaws.xray#Double", + "RuleName": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The percentage of matching requests to instrument, after the reservoir is\n exhausted.

    " + "smithy.api#documentation": "

    The name of the sampling rule.

    " } }, - "Interval": { - "target": "com.amazonaws.xray#NullableInteger", + "FixedRate": { + "target": "com.amazonaws.xray#Double", "traits": { - "smithy.api#documentation": "

    The number of seconds for the service to wait before getting sampling targets\n again.

    " + "smithy.api#documentation": "

    The percentage of matching requests to instrument, after the reservoir is\n exhausted.

    " } }, - "ReservoirQuota": { - "target": "com.amazonaws.xray#NullableInteger", + "ReservoirQuotaTTL": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    The number of requests per second that X-Ray allocated this service.

    " + "smithy.api#documentation": "

    When the reservoir quota expires.

    " } } }, "traits": { - "smithy.api#documentation": "

    Temporary changes to a sampling rule configuration. To meet the global sampling target\n for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling\n results of all services that called GetSamplingTargets.

    " + "smithy.api#documentation": "

    Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray\n calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

    " } }, "com.amazonaws.xray#SamplingTargetDocumentList": { @@ -2759,52 +2906,46 @@ "com.amazonaws.xray#Service": { "type": "structure", "members": { - "SummaryStatistics": { - "target": "com.amazonaws.xray#ServiceStatistics", - "traits": { - "smithy.api#documentation": "

    Aggregated statistics for the service.

    " - } - }, - "State": { + "AccountId": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The service's state.

    " + "smithy.api#documentation": "

    Identifier of the AWS account in which the service runs.

    " } }, - "StartTime": { + "EndTime": { "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    The start time of the first segment that the service generated.

    " + "smithy.api#documentation": "

    The end time of the last segment that the service generated.

    " } }, - "ResponseTimeHistogram": { - "target": "com.amazonaws.xray#Histogram", + "Edges": { + "target": "com.amazonaws.xray#EdgeList", "traits": { - "smithy.api#documentation": "

    A histogram that maps the spread of service response times.

    " + "smithy.api#documentation": "

    Connections to downstream services.

    " } }, - "AccountId": { + "Type": { "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    Identifier of the AWS account in which the service runs.

    " + "smithy.api#documentation": "

    The type of service.

    \n
      \n
    • \n

      AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for an\n application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the\n application used.

      \n
      • \n
    • \n

      AWS Service - The type of an AWS service. For example, AWS::DynamoDB\n for downstream calls to Amazon DynamoDB that didn't target a specific table.

      \n
      • \n
    • \n

      \n client - Represents the clients that sent requests to a root\n service.

      \n
      • \n
    • \n

      \n remote - A downstream service of indeterminate type.

      \n
      • \n
    " } }, - "Name": { - "target": "com.amazonaws.xray#String", + "ReferenceId": { + "target": "com.amazonaws.xray#NullableInteger", "traits": { - "smithy.api#documentation": "

    The canonical name of the service.

    " + "smithy.api#documentation": "

    Identifier for the service. Unique within the service map.

    " } }, - "EndTime": { - "target": "com.amazonaws.xray#Timestamp", + "State": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    The end time of the last segment that the service generated.

    " + "smithy.api#documentation": "

    The service's state.

    " } }, - "Edges": { - "target": "com.amazonaws.xray#EdgeList", + "StartTime": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    Connections to downstream services.

    " + "smithy.api#documentation": "

    The start time of the first segment that the service generated.

    " } }, "DurationHistogram": { @@ -2813,16 +2954,10 @@ "smithy.api#documentation": "

    A histogram that maps the spread of service durations.

    " } }, - "ReferenceId": { - "target": "com.amazonaws.xray#NullableInteger", - "traits": { - "smithy.api#documentation": "

    Identifier for the service. Unique within the service map.

    " - } - }, - "Root": { - "target": "com.amazonaws.xray#NullableBoolean", + "Name": { + "target": "com.amazonaws.xray#String", "traits": { - "smithy.api#documentation": "

    Indicates that the service was the first service to process a request.

    " + "smithy.api#documentation": "

    The canonical name of the service.

    " } }, "Names": { @@ -2831,15 +2966,27 @@ "smithy.api#documentation": "

    A list of names for the service, including the canonical name.

    " } }, - "Type": { - "target": "com.amazonaws.xray#String", + "ResponseTimeHistogram": { + "target": "com.amazonaws.xray#Histogram", "traits": { - "smithy.api#documentation": "

    The type of service.

    \n
      \n
    • \n

      AWS Resource - The type of an AWS resource. For example,\n AWS::EC2::Instance for a application running on Amazon EC2 or\n AWS::DynamoDB::Table for an Amazon DynamoDB table that the application\n used.

      \n
      • \n
    • \n

      AWS Service - The type of an AWS service. For example, AWS::DynamoDB\n for downstream calls to Amazon DynamoDB that didn't target a specific table.

      \n
      • \n
    • \n

      \n client - Represents the clients that sent requests to a root\n service.

      \n
      • \n
    • \n

      \n remote - A downstream service of indeterminate type.

      \n
      • \n
    " + "smithy.api#documentation": "

    A histogram that maps the spread of service response times.

    " + } + }, + "Root": { + "target": "com.amazonaws.xray#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    Indicates that the service was the first service to process a request.

    " + } + }, + "SummaryStatistics": { + "target": "com.amazonaws.xray#ServiceStatistics", + "traits": { + "smithy.api#documentation": "

    Aggregated statistics for the service.

    " } } }, "traits": { - "smithy.api#documentation": "

    Information about an application that processed requests, users that made requests, or\n downstream services, resources and applications that an application used.

    " + "smithy.api#documentation": "

    Information about an application that processed requests, users that made requests, or downstream services,\n resources, and applications that an application used.

    " } }, "com.amazonaws.xray#ServiceId": { @@ -2857,14 +3004,14 @@ "smithy.api#documentation": "

    " } }, - "Name": { - "target": "com.amazonaws.xray#String", + "Names": { + "target": "com.amazonaws.xray#ServiceNames", "traits": { "smithy.api#documentation": "

    " } }, - "Names": { - "target": "com.amazonaws.xray#ServiceNames", + "Name": { + "target": "com.amazonaws.xray#String", "traits": { "smithy.api#documentation": "

    " } @@ -2910,6 +3057,18 @@ "smithy.api#documentation": "

    The aggregate response time of completed requests.

    " } }, + "FaultStatistics": { + "target": "com.amazonaws.xray#FaultStatistics", + "traits": { + "smithy.api#documentation": "

    Information about requests that failed with a 5xx Server Error status code.

    " + } + }, + "OkCount": { + "target": "com.amazonaws.xray#NullableLong", + "traits": { + "smithy.api#documentation": "

    The number of requests that completed with a 2xx Success status code.

    " + } + }, "TotalCount": { "target": "com.amazonaws.xray#NullableLong", "traits": { @@ -2921,36 +3080,142 @@ "traits": { "smithy.api#documentation": "

    Information about requests that failed with a 4xx Client Error status code.

    " } + } + }, + "traits": { + "smithy.api#documentation": "

    Response statistics for a service.

    " + } + }, + "com.amazonaws.xray#ServiceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.xray#String": { + "type": "string" + }, + "com.amazonaws.xray#Tag": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.xray#TagValue", + "traits": { + "smithy.api#documentation": "

    An optional tag value, such as Production or test-only. The value can be \n a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following \n special characters: + - = . _ : /\n

    ", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.xray#TagKey", + "traits": { + "smithy.api#documentation": "

    A tag key, such as Stage or Name. A tag key cannot be empty. The \n key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, \n or the following special characters: + - = . _ : /\n

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    A map that contains tag keys and tag values to attach to an AWS X-Ray group or sampling\n rule. For more information about ways to use tags, see Tagging AWS resources\n in the AWS General Reference.

    \n

    The following restrictions apply to tags:

    \n
      \n
    • \n

      Maximum number of user-applied tags per resource: 50

      \n
      • \n
    • \n

      Tag keys and values are case sensitive.

      \n
      • \n
    • \n

      Don't use aws: as a prefix for keys; it's reserved for AWS use. You\n cannot edit or delete system tags.

      \n
      • \n
    " + } + }, + "com.amazonaws.xray#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.xray#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.xray#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.xray#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.xray#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.xray#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.xray#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.xray#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.xray#InvalidRequestException" + }, + { + "target": "com.amazonaws.xray#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.xray#ThrottledException" }, - "OkCount": { - "target": "com.amazonaws.xray#NullableLong", + { + "target": "com.amazonaws.xray#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

    Applies tags to an existing AWS X-Ray group or sampling rule.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/TagResource", + "code": 200 + } + } + }, + "com.amazonaws.xray#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.xray#AmazonResourceName", "traits": { - "smithy.api#documentation": "

    The number of requests that completed with a 2xx Success status code.

    " + "smithy.api#documentation": "

    The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

    ", + "smithy.api#required": {} } }, - "FaultStatistics": { - "target": "com.amazonaws.xray#FaultStatistics", + "Tags": { + "target": "com.amazonaws.xray#TagList", "traits": { - "smithy.api#documentation": "

    Information about requests that failed with a 5xx Server Error status code.

    " + "smithy.api#documentation": "

    A map that contains one or more tag keys and tag values to attach to an X-Ray group or\n sampling rule. For more information about ways to use tags, see Tagging AWS resources\n in the AWS General Reference.

    \n

    The following restrictions apply to tags:

    \n
      \n
    • \n

      Maximum number of user-applied tags per resource: 50

      \n
      • \n
    • \n

      Maximum tag key length: 128 Unicode characters

      \n
      • \n
    • \n

      Maximum tag value length: 256 Unicode characters

      \n
      • \n
    • \n

      Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :\n / = + - and @

      \n
      • \n
    • \n

      Tag keys and values are case sensitive.

      \n
      • \n
    • \n

      Don't use aws: as a prefix for keys; it's reserved for AWS use. You\n cannot edit or delete system tags.

      \n
      • \n
    ", + "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

    Response statistics for a service.

    " } }, - "com.amazonaws.xray#ServiceType": { + "com.amazonaws.xray#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.xray#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 64 + "max": 256 } } }, - "com.amazonaws.xray#String": { - "type": "string" - }, "com.amazonaws.xray#TelemetryRecord": { "type": "structure", "members": { @@ -2961,31 +3226,31 @@ "smithy.api#required": {} } }, - "SegmentsReceivedCount": { + "SegmentsRejectedCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " } }, - "SegmentsSentCount": { - "target": "com.amazonaws.xray#NullableInteger", + "BackendConnectionErrors": { + "target": "com.amazonaws.xray#BackendConnectionErrors", "traits": { "smithy.api#documentation": "

    " } }, - "SegmentsRejectedCount": { + "SegmentsSpilloverCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " } }, - "BackendConnectionErrors": { - "target": "com.amazonaws.xray#BackendConnectionErrors", + "SegmentsReceivedCount": { + "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " } }, - "SegmentsSpilloverCount": { + "SegmentsSentCount": { "target": "com.amazonaws.xray#NullableInteger", "traits": { "smithy.api#documentation": "

    " @@ -3036,12 +3301,6 @@ "ServiceSummaryStatistics": { "target": "com.amazonaws.xray#ServiceStatistics" }, - "Timestamp": { - "target": "com.amazonaws.xray#Timestamp", - "traits": { - "smithy.api#documentation": "

    Timestamp of the window for which statistics are aggregated.

    " - } - }, "EdgeSummaryStatistics": { "target": "com.amazonaws.xray#EdgeStatistics" }, @@ -3050,6 +3309,12 @@ "traits": { "smithy.api#documentation": "

    The response time histogram for the selected entities.

    " } + }, + "Timestamp": { + "target": "com.amazonaws.xray#Timestamp", + "traits": { + "smithy.api#documentation": "

    Timestamp of the window for which statistics are aggregated.

    " + } } }, "traits": { @@ -3065,6 +3330,22 @@ "com.amazonaws.xray#Timestamp": { "type": "timestamp" }, + "com.amazonaws.xray#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.xray#ErrorMessage" + }, + "ResourceName": { + "target": "com.amazonaws.xray#AmazonResourceName" + } + }, + "traits": { + "smithy.api#documentation": "

    You have exceeded the maximum number of tags you can apply to this resource.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.xray#Trace": { "type": "structure", "members": { @@ -3074,6 +3355,12 @@ "smithy.api#documentation": "

    The unique identifier for the request that generated the trace's segments and\n subsegments.

    " } }, + "LimitExceeded": { + "target": "com.amazonaws.xray#NullableBoolean", + "traits": { + "smithy.api#documentation": "

    LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For\n more information about quotas, see AWS X-Ray endpoints and quotas.

    " + } + }, "Segments": { "target": "com.amazonaws.xray#SegmentList", "traits": { @@ -3142,34 +3429,34 @@ "com.amazonaws.xray#TraceSummary": { "type": "structure", "members": { - "EntryPoint": { - "target": "com.amazonaws.xray#ServiceId", + "IsPartial": { + "target": "com.amazonaws.xray#NullableBoolean", "traits": { - "smithy.api#documentation": "

    The root of a trace.

    " + "smithy.api#documentation": "

    One or more of the segment documents is in progress.

    " } }, - "FaultRootCauses": { - "target": "com.amazonaws.xray#FaultRootCauses", + "HasThrottle": { + "target": "com.amazonaws.xray#NullableBoolean", "traits": { - "smithy.api#documentation": "

    A collection of FaultRootCause structures corresponding to the the trace\n segments.

    " + "smithy.api#documentation": "

    One or more of the segment documents has a 429 throttling error.

    " } }, - "Http": { - "target": "com.amazonaws.xray#Http", + "Id": { + "target": "com.amazonaws.xray#TraceId", "traits": { - "smithy.api#documentation": "

    Information about the HTTP request served by the trace.

    " + "smithy.api#documentation": "

    The unique identifier for the request that generated the trace's segments and\n subsegments.

    " } }, - "AvailabilityZones": { - "target": "com.amazonaws.xray#TraceAvailabilityZones", + "ServiceIds": { + "target": "com.amazonaws.xray#ServiceIds", "traits": { - "smithy.api#documentation": "

    A list of availability zones for any zone corresponding to the trace\n segments.

    " + "smithy.api#documentation": "

    Service IDs from the trace's segment documents.

    " } }, - "InstanceIds": { - "target": "com.amazonaws.xray#TraceInstanceIds", + "HasFault": { + "target": "com.amazonaws.xray#NullableBoolean", "traits": { - "smithy.api#documentation": "

    A list of EC2 instance IDs for any instance corresponding to the trace\n segments.

    " + "smithy.api#documentation": "

    The root segment document has a 500 series error.

    " } }, "HasError": { @@ -3178,34 +3465,28 @@ "smithy.api#documentation": "

    The root segment document has a 400 series error.

    " } }, - "MatchedEventTime": { - "target": "com.amazonaws.xray#Timestamp", - "traits": { - "smithy.api#documentation": "

    The matched time stamp of a defined event.

    " - } - }, - "Id": { - "target": "com.amazonaws.xray#TraceId", + "InstanceIds": { + "target": "com.amazonaws.xray#TraceInstanceIds", "traits": { - "smithy.api#documentation": "

    The unique identifier for the request that generated the trace's segments and\n subsegments.

    " + "smithy.api#documentation": "

    A list of EC2 instance IDs for any instance corresponding to the trace\n segments.

    " } }, - "ResourceARNs": { - "target": "com.amazonaws.xray#TraceResourceARNs", + "ResponseTime": { + "target": "com.amazonaws.xray#NullableDouble", "traits": { - "smithy.api#documentation": "

    A list of resource ARNs for any resource corresponding to the trace segments.

    " + "smithy.api#documentation": "

    The length of time in seconds between the start and end times of the root segment. If\n the service performs work asynchronously, the response time measures the time before the\n response is sent to the user, while the duration measures the amount of time before the last\n traced activity completes.

    " } }, - "HasFault": { - "target": "com.amazonaws.xray#NullableBoolean", + "FaultRootCauses": { + "target": "com.amazonaws.xray#FaultRootCauses", "traits": { - "smithy.api#documentation": "

    The root segment document has a 500 series error.

    " + "smithy.api#documentation": "

    A collection of FaultRootCause structures corresponding to the trace segments.

    " } }, - "Annotations": { - "target": "com.amazonaws.xray#Annotations", + "EntryPoint": { + "target": "com.amazonaws.xray#ServiceId", "traits": { - "smithy.api#documentation": "

    Annotations from the trace's segment documents.

    " + "smithy.api#documentation": "

    The root of a trace.

    " } }, "ErrorRootCauses": { @@ -3214,52 +3495,58 @@ "smithy.api#documentation": "

    A collection of ErrorRootCause structures corresponding to the trace\n segments.

    " } }, - "IsPartial": { - "target": "com.amazonaws.xray#NullableBoolean", + "Revision": { + "target": "com.amazonaws.xray#Integer", "traits": { - "smithy.api#documentation": "

    One or more of the segment documents is in progress.

    " + "smithy.api#documentation": "

    The revision number of a trace.

    " } }, - "Duration": { - "target": "com.amazonaws.xray#NullableDouble", + "ResponseTimeRootCauses": { + "target": "com.amazonaws.xray#ResponseTimeRootCauses", "traits": { - "smithy.api#documentation": "

    The length of time in seconds between the start time of the root segment and the end\n time of the last segment that completed.

    " + "smithy.api#documentation": "

    A collection of ResponseTimeRootCause structures corresponding to the trace\n segments.

    " } }, - "ResponseTime": { - "target": "com.amazonaws.xray#NullableDouble", + "ResourceARNs": { + "target": "com.amazonaws.xray#TraceResourceARNs", "traits": { - "smithy.api#documentation": "

    The length of time in seconds between the start and end times of the root segment. If\n the service performs work asynchronously, the response time measures the time before the\n response is sent to the user, while the duration measures the amount of time before the last\n traced activity completes.

    " + "smithy.api#documentation": "

    A list of resource ARNs for any resource corresponding to the trace segments.

    " } }, - "ServiceIds": { - "target": "com.amazonaws.xray#ServiceIds", + "Http": { + "target": "com.amazonaws.xray#Http", "traits": { - "smithy.api#documentation": "

    Service IDs from the trace's segment documents.

    " + "smithy.api#documentation": "

    Information about the HTTP request served by the trace.

    " } }, - "ResponseTimeRootCauses": { - "target": "com.amazonaws.xray#ResponseTimeRootCauses", + "Annotations": { + "target": "com.amazonaws.xray#Annotations", "traits": { - "smithy.api#documentation": "

    A collection of ResponseTimeRootCause structures corresponding to the trace\n segments.

    " + "smithy.api#documentation": "

    Annotations from the trace's segment documents.

    " } }, - "Revision": { - "target": "com.amazonaws.xray#Integer", + "Users": { + "target": "com.amazonaws.xray#TraceUsers", "traits": { - "smithy.api#documentation": "

    The revision number of a trace.

    " + "smithy.api#documentation": "

    Users from the trace's segment documents.

    " } }, - "HasThrottle": { - "target": "com.amazonaws.xray#NullableBoolean", + "AvailabilityZones": { + "target": "com.amazonaws.xray#TraceAvailabilityZones", "traits": { - "smithy.api#documentation": "

    One or more of the segment documents has a 429 throttling error.

    " + "smithy.api#documentation": "

    A list of Availability Zones for any zone corresponding to the trace segments.

    " } }, - "Users": { - "target": "com.amazonaws.xray#TraceUsers", + "MatchedEventTime": { + "target": "com.amazonaws.xray#Timestamp", "traits": { - "smithy.api#documentation": "

    Users from the trace's segment documents.

    " + "smithy.api#documentation": "

    The matched time stamp of a defined event.

    " + } + }, + "Duration": { + "target": "com.amazonaws.xray#NullableDouble", + "traits": { + "smithy.api#documentation": "

    The length of time in seconds between the start time of the root segment and the end\n time of the last segment that completed.

    " } } }, @@ -3276,17 +3563,17 @@ "com.amazonaws.xray#TraceUser": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.xray#String", - "traits": { - "smithy.api#documentation": "

    The user's name.

    " - } - }, "ServiceIds": { "target": "com.amazonaws.xray#ServiceIds", "traits": { "smithy.api#documentation": "

    Services that the user's request hit.

    " } + }, + "UserName": { + "target": "com.amazonaws.xray#String", + "traits": { + "smithy.api#documentation": "

    The user's name.

    " + } } }, "traits": { @@ -3378,6 +3665,57 @@ "target": "com.amazonaws.xray#UnprocessedTraceSegment" } }, + "com.amazonaws.xray#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.xray#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.xray#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.xray#InvalidRequestException" + }, + { + "target": "com.amazonaws.xray#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.xray#ThrottledException" + } + ], + "traits": { + "smithy.api#documentation": "

    Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system\n tags (those with an aws: prefix).

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/UntagResource", + "code": 200 + } + } + }, + "com.amazonaws.xray#UntagResourceRequest": { + "type": "structure", + "members": { + "TagKeys": { + "target": "com.amazonaws.xray#TagKeyList", + "traits": { + "smithy.api#documentation": "

    Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.

    ", + "smithy.api#required": {} + } + }, + "ResourceARN": { + "target": "com.amazonaws.xray#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.xray#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.xray#UpdateGroup": { "type": "operation", "input": { @@ -3406,16 +3744,22 @@ "com.amazonaws.xray#UpdateGroupRequest": { "type": "structure", "members": { + "FilterExpression": { + "target": "com.amazonaws.xray#FilterExpression", + "traits": { + "smithy.api#documentation": "

    The updated filter expression defining criteria by which to group traces.

    " + } + }, "GroupName": { "target": "com.amazonaws.xray#GroupName", "traits": { "smithy.api#documentation": "

    The case-sensitive name of the group.

    " } }, - "FilterExpression": { - "target": "com.amazonaws.xray#FilterExpression", + "InsightsConfiguration": { + "target": "com.amazonaws.xray#InsightsConfiguration", "traits": { - "smithy.api#documentation": "

    The updated filter expression defining criteria by which to group traces.

    " + "smithy.api#documentation": "

    The structure containing configurations related to insights.

    \n
      \n
    • \n

      The InsightsEnabled boolean can be set to true to enable insights for the\n group or false to disable insights for the group.

      \n
      • \n
    • \n

      The NotifcationsEnabled boolean can be set to true to enable insights notifications for the group.\n Notifications can only be enabled on a group with InsightsEnabled set to true.

      \n
      • \n
    " } }, "GroupARN": { @@ -3432,7 +3776,7 @@ "Group": { "target": "com.amazonaws.xray#Group", "traits": { - "smithy.api#documentation": "

    The group that was updated. Contains the name of the group that was updated, the\n ARN of the group that was updated, and the updated filter expression assigned to the\n group.

    " + "smithy.api#documentation": "

    The group that was updated. Contains the name of the group that was updated, the\n ARN of the group that was updated, the updated filter expression, and the updated insight\n configuration assigned to the group.

    " } } } @@ -3488,17 +3832,17 @@ "com.amazonaws.xray#ValueWithServiceIds": { "type": "structure", "members": { - "ServiceIds": { - "target": "com.amazonaws.xray#ServiceIds", - "traits": { - "smithy.api#documentation": "

    Services to which the annotation applies.

    " - } - }, "AnnotationValue": { "target": "com.amazonaws.xray#AnnotationValue", "traits": { "smithy.api#documentation": "

    Values of the annotation.

    " } + }, + "ServiceIds": { + "target": "com.amazonaws.xray#ServiceIds", + "traits": { + "smithy.api#documentation": "

    Services to which the annotation applies.

    " + } } }, "traits": {